diff --git a/docs/tools/sdk/go/Reference/Beta/Index.md b/docs/tools/sdk/go/Reference/Beta/Index.md new file mode 100644 index 000000000..3da38a2d2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Index.md @@ -0,0 +1,22 @@ +--- +id: beta +title: Beta +pagination_label: Beta +sidebar_label: Beta +sidebar_position: 2 +sidebar_class_name: beta +keywords: ['beta', 'Golang'] +description: Golang SDK reference Beta. +slug: /tools/go/reference/beta +tags: ['beta'] +--- + + +Welcome to the Golang SDK documentation for the Identity Security Cloud (ISC) Beta API. This reference guide provides an overview of both methods and models, which will help you understand how to interact with the API effectively. + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AccessModelMetadataAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AccessModelMetadataAPI.md new file mode 100644 index 000000000..17bfbc6b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AccessModelMetadataAPI.md @@ -0,0 +1,296 @@ +--- +id: beta-access-model-metadata +title: AccessModelMetadata +pagination_label: AccessModelMetadata +sidebar_label: AccessModelMetadata +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessModelMetadata', 'BetaAccessModelMetadata'] +slug: /tools/sdk/go/beta/methods/access-model-metadata +tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'BetaAccessModelMetadata'] +--- + +# AccessModelMetadataAPI + Use this API to create and manage metadata attributes for your Access Model. +Access Model Metadata allows you to add contextual information to your ISC Access Model items using pre-defined metadata for risk, regulations, privacy levels, etc., or by creating your own metadata attributes to reflect the unique needs of your organization. This release of the API includes support for entitlement metadata. Support for role and access profile metadata will be introduced in a subsequent release. + +Common usages for Access Model metadata include: + +- Organizing and categorizing access items to make it easier for your users to search for and find the access rights they want to request, certify, or manage. + +- Providing richer information about access that is being acted on to allow stakeholders to make better decisions when approving, certifying, or managing access rights. + +- Identifying access that may requires additional approval requirements or be subject to more frequent review. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-access-model-metadata-attribute**](#get-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes/{key}` | Get Access Model Metadata Attribute +[**get-access-model-metadata-attribute-value**](#get-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values/{value}` | Get Access Model Metadata Value +[**list-access-model-metadata-attribute**](#list-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes` | List Access Model Metadata Attributes +[**list-access-model-metadata-attribute-value**](#list-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values + + +## get-access-model-metadata-attribute +Get Access Model Metadata Attribute +Get single Access Model Metadata Attribute + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-model-metadata-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**key** | **string** | Technical name of the Attribute. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessModelMetadataAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AttributeDTO**](../models/attribute-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessModelMetadataAPI.GetAccessModelMetadataAttribute(context.Background(), key).Execute() + //resp, r, err := apiClient.Beta.AccessModelMetadataAPI.GetAccessModelMetadataAttribute(context.Background(), key).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.GetAccessModelMetadataAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessModelMetadataAttribute`: AttributeDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.GetAccessModelMetadataAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-model-metadata-attribute-value +Get Access Model Metadata Value +Get single Access Model Metadata Attribute Value + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-model-metadata-attribute-value) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**key** | **string** | Technical name of the Attribute. | +**value** | **string** | Technical name of the Attribute value. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessModelMetadataAttributeValueRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**AttributeValueDTO**](../models/attribute-value-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + value := `public` // string | Technical name of the Attribute value. # string | Technical name of the Attribute value. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue(context.Background(), key, value).Execute() + //resp, r, err := apiClient.Beta.AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue(context.Background(), key, value).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessModelMetadataAttributeValue`: AttributeValueDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-model-metadata-attribute +List Access Model Metadata Attributes +Get a list of Access Model Metadata Attributes + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-model-metadata-attribute) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessModelMetadataAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* | + +### Return type + +[**[]AttributeDTO**](../models/attribute-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `name eq "Privacy"` // 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessModelMetadataAPI.ListAccessModelMetadataAttribute(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccessModelMetadataAPI.ListAccessModelMetadataAttribute(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.ListAccessModelMetadataAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessModelMetadataAttribute`: []AttributeDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.ListAccessModelMetadataAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-model-metadata-attribute-value +List Access Model Metadata Values +Get a list of Access Model Metadata Attribute Values + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-model-metadata-attribute-value) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**key** | **string** | Technical name of the Attribute. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessModelMetadataAttributeValueRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]AttributeValueDTO**](../models/attribute-value-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue(context.Background(), key).Execute() + //resp, r, err := apiClient.Beta.AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue(context.Background(), key).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessModelMetadataAttributeValue`: []AttributeValueDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AccessProfilesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AccessProfilesAPI.md new file mode 100644 index 000000000..974423a04 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AccessProfilesAPI.md @@ -0,0 +1,732 @@ +--- +id: beta-access-profiles +title: AccessProfiles +pagination_label: AccessProfiles +sidebar_label: AccessProfiles +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfiles', 'BetaAccessProfiles'] +slug: /tools/sdk/go/beta/methods/access-profiles +tags: ['SDK', 'Software Development Kit', 'AccessProfiles', 'BetaAccessProfiles'] +--- + +# AccessProfilesAPI + Use this API to implement and customize access profile functionality. +With this functionality in place, administrators can create access profiles and configure them for use throughout Identity Security Cloud, enabling users to get the access they need quickly and securely. + +Access profiles group entitlements, which represent access rights on sources. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +Identity Security Cloud uses access profiles in many features, including the following: + +- Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles. + +- Certifications: You can approve or revoke access profiles in certification campaigns, just like entitlements. + +- Access Requests: You can assign access profiles to applications, and when a user requests access to the app associated with an access profile and someone approves the request, access is granted to both the application and its associated access profile. + +- Roles: You can group one or more access profiles into a role to quickly assign access items based on an identity's role. + +In Identity Security Cloud, administrators can use the Access drop-down menu and select Access Profiles to view, configure, and delete existing access profiles, as well as create new ones. +Administrators can enable and disable an access profile, and they can also make the following configurations: + +- Manage Entitlements: Manage the profile's access by adding and removing entitlements. + +- Access Requests: Configure access profiles to be requestable and establish an approval process for any requests that the access profile be granted or revoked. +Do not configure an access profile to be requestable without first establishing a secure access request approval process for the access profile. + +- Multiple Account Options: Define the logic Identity Security Cloud uses to provision access to an identity with multiple accounts on the source. + +Refer to [Managing Access Profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) for more information about access profiles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-access-profile**](#create-access-profile) | **Post** `/access-profiles` | Create Access Profile +[**delete-access-profile**](#delete-access-profile) | **Delete** `/access-profiles/{id}` | Delete the specified Access Profile +[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-delete` | Delete Access Profile(s) +[**get-access-profile**](#get-access-profile) | **Get** `/access-profiles/{id}` | Get an Access Profile +[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **Get** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements +[**list-access-profiles**](#list-access-profiles) | **Get** `/access-profiles` | List Access Profiles +[**patch-access-profile**](#patch-access-profile) | **Patch** `/access-profiles/{id}` | Patch a specified Access Profile +[**update-access-profiles-in-bulk**](#update-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field. + + +## create-access-profile +Create Access Profile +Create an access profile. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-profile) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAccessProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessProfile** | [**AccessProfile**](../models/access-profile) | | + +### Return type + +[**AccessProfile**](../models/access-profile) + +### 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() { + accessprofile := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + }`) // AccessProfile | + + + var accessProfile beta.AccessProfile + if err := json.Unmarshal(accessprofile, &accessProfile); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessProfilesAPI.CreateAccessProfile(context.Background()).AccessProfile(accessProfile).Execute() + //resp, r, err := apiClient.Beta.AccessProfilesAPI.CreateAccessProfile(context.Background()).AccessProfile(accessProfile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.CreateAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.CreateAccessProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-access-profile +Delete the specified Access Profile +This API deletes an existing Access Profile. + +The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. + +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a SOURCE_SUBADMIN token must be able to administer the Source associated with the Access Profile. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-access-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Access Profile to delete | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccessProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Access Profile to delete # string | ID of the Access Profile to delete + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.AccessProfilesAPI.DeleteAccessProfile(context.Background(), id).Execute() + //r, err := apiClient.Beta.AccessProfilesAPI.DeleteAccessProfile(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.DeleteAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-access-profiles-in-bulk +Delete Access Profile(s) +This endpoint initiates a bulk deletion of one or more access profiles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 access profiles per request. +By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-access-profiles-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccessProfilesInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessProfileBulkDeleteRequest** | [**AccessProfileBulkDeleteRequest**](../models/access-profile-bulk-delete-request) | | + +### Return type + +[**AccessProfileBulkDeleteResponse**](../models/access-profile-bulk-delete-response) + +### 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() { + accessprofilebulkdeleterequest := []byte(`{ + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + }`) // AccessProfileBulkDeleteRequest | + + + var accessProfileBulkDeleteRequest beta.AccessProfileBulkDeleteRequest + if err := json.Unmarshal(accessprofilebulkdeleterequest, &accessProfileBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessProfilesAPI.DeleteAccessProfilesInBulk(context.Background()).AccessProfileBulkDeleteRequest(accessProfileBulkDeleteRequest).Execute() + //resp, r, err := apiClient.Beta.AccessProfilesAPI.DeleteAccessProfilesInBulk(context.Background()).AccessProfileBulkDeleteRequest(accessProfileBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.DeleteAccessProfilesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccessProfilesInBulk`: AccessProfileBulkDeleteResponse + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.DeleteAccessProfilesInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-profile +Get an Access Profile +This API returns an Access Profile by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Access Profile | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Access Profile # string | ID of the Access Profile + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessProfilesAPI.GetAccessProfile(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AccessProfilesAPI.GetAccessProfile(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.GetAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.GetAccessProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-profile-entitlements +List Access Profile's Entitlements +Use this API to get a list of an access profile's entitlements. +A user with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-profile-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the access profile containing the entitlements. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessProfileEntitlementsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. | + **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, attribute, value, created, modified** | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the access profile containing the entitlements. # string | ID of the access profile containing the entitlements. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessProfilesAPI.GetAccessProfileEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AccessProfilesAPI.GetAccessProfileEntitlements(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.GetAccessProfileEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessProfileEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.GetAccessProfileEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-profiles +List Access Profiles +Get a list of access profiles. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessProfilesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **forSubadmin** | **string** | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. | + **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, created, modified** | + **forSegmentIds** | **string** | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. | + **includeUnsegmented** | **bool** | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. | [default to true] + +### Return type + +[**[]AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + forSubadmin := `8c190e6787aa4ed9a90bd9d5344523fb` // string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) # string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "SailPoint Support"` // 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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessProfilesAPI.ListAccessProfiles(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccessProfilesAPI.ListAccessProfiles(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.ListAccessProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessProfiles`: []AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.ListAccessProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-access-profile +Patch a specified Access Profile +This API updates an existing Access Profile. The following fields are patchable: +**name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. +> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-access-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Access Profile to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAccessProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `2c91808a7813090a017814121919ecca` // string | ID of the Access Profile to patch # string | ID of the Access Profile to patch + jsonpatchoperation := []byte(`[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]`) // []JsonPatchOperation | + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessProfilesAPI.PatchAccessProfile(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.AccessProfilesAPI.PatchAccessProfile(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.PatchAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.PatchAccessProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-access-profiles-in-bulk +Update Access Profile(s) requestable field. +This API initiates a bulk update of field requestable for one or more Access Profiles. + +> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** + list of the response.Requestable field of these Access Profiles marked as **true** or **false**. + +> If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. +A SOURCE_SUBADMIN user may only use this API to update Access Profiles which are associated with Sources they are able to administer. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-access-profiles-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateAccessProfilesInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessProfileBulkUpdateRequestInner** | [**[]AccessProfileBulkUpdateRequestInner**](../models/access-profile-bulk-update-request-inner) | | + +### Return type + +[**[]AccessProfileUpdateItem**](../models/access-profile-update-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() { + accessprofilebulkupdaterequestinner := []byte(`[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]`) // []AccessProfileBulkUpdateRequestInner | + + + var accessProfileBulkUpdateRequestInner beta.[]AccessProfileBulkUpdateRequestInner + if err := json.Unmarshal(accessprofilebulkupdaterequestinner, &accessProfileBulkUpdateRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessProfilesAPI.UpdateAccessProfilesInBulk(context.Background()).AccessProfileBulkUpdateRequestInner(accessProfileBulkUpdateRequestInner).Execute() + //resp, r, err := apiClient.Beta.AccessProfilesAPI.UpdateAccessProfilesInBulk(context.Background()).AccessProfileBulkUpdateRequestInner(accessProfileBulkUpdateRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.UpdateAccessProfilesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAccessProfilesInBulk`: []AccessProfileUpdateItem + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.UpdateAccessProfilesInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestApprovalsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestApprovalsAPI.md new file mode 100644 index 000000000..d6e50a537 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestApprovalsAPI.md @@ -0,0 +1,491 @@ +--- +id: beta-access-request-approvals +title: AccessRequestApprovals +pagination_label: AccessRequestApprovals +sidebar_label: AccessRequestApprovals +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestApprovals', 'BetaAccessRequestApprovals'] +slug: /tools/sdk/go/beta/methods/access-request-approvals +tags: ['SDK', 'Software Development Kit', 'AccessRequestApprovals', 'BetaAccessRequestApprovals'] +--- + +# AccessRequestApprovalsAPI + Use this API to implement and customize access request approval functionality. +With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. +This enables more qualified users to review access requests and the others to spend their time on other tasks. + +In Identity Security Cloud, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. +For applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. +For roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. +If the administrator designates a governance group as the required approver, any governance group member can approve the requests. + +When a user submits an access request, Identity Security Cloud sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration. + +In Approvals in Identity Security Cloud, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. +If the required approver approves the request and is the only reviewer required, Identity Security Cloud grants or revokes access, based on the request. +If multiple reviewers are required, Identity Security Cloud sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. +The required approver can then view any completed access requests under the Reviewed tab. + +Refer to [Access Requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for more information about access request approvals. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-access-request**](#approve-access-request) | **Post** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval +[**forward-access-request**](#forward-access-request) | **Post** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval +[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **Get** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number +[**list-completed-approvals**](#list-completed-approvals) | **Get** `/access-request-approvals/completed` | Completed Access Request Approvals List +[**list-pending-approvals**](#list-pending-approvals) | **Get** `/access-request-approvals/pending` | Pending Access Request Approvals List +[**reject-access-request**](#reject-access-request) | **Post** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval + + +## approve-access-request +Approve Access Request Approval +Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/approve-access-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**approvalId** | **string** | Approval ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiApproveAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **commentDto** | [**CommentDto**](../models/comment-dto) | Reviewer's comment. | + +### Return type + +**map[string]interface{}** + +### 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() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + commentdto := []byte(`{ + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + }`) // CommentDto | Reviewer's comment. + + + var commentDto beta.CommentDto + if err := json.Unmarshal(commentdto, &commentDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.ApproveAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + //resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.ApproveAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ApproveAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ApproveAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## forward-access-request +Forward Access Request Approval +Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/forward-access-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**approvalId** | **string** | Approval ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiForwardAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **forwardApprovalDto** | [**ForwardApprovalDto**](../models/forward-approval-dto) | Information about the forwarded approval. | + +### Return type + +**map[string]interface{}** + +### 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() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + forwardapprovaldto := []byte(`{ + "newOwnerId" : "newOwnerId", + "comment" : "comment" + }`) // ForwardApprovalDto | Information about the forwarded approval. + + + var forwardApprovalDto beta.ForwardApprovalDto + if err := json.Unmarshal(forwardapprovaldto, &forwardApprovalDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.ForwardAccessRequest(context.Background(), approvalId).ForwardApprovalDto(forwardApprovalDto).Execute() + //resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.ForwardAccessRequest(context.Background(), approvalId).ForwardApprovalDto(forwardApprovalDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ForwardAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ForwardAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ForwardAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-approval-summary +Get Access Requests Approvals Number +Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-approval-summary) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestApprovalSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. | + **fromDate** | **string** | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. | + +### Return type + +[**ApprovalSummary**](../models/approval-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + fromDate := `from-date=2020-03-19T19:59:11Z` // string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) # string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary(context.Background()).OwnerId(ownerId).FromDate(fromDate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestApprovalSummary`: ApprovalSummary + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-completed-approvals +Completed Access Request Approvals List +This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-completed-approvals) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCompletedApprovalsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* | + **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: **created, modified** | + +### Return type + +[**[]CompletedApproval**](../models/completed-approval) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `ownerId_example` // string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `filters_example` // 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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + sorters := `sorters_example` // 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: **created, modified** (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: **created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.ListCompletedApprovals(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.ListCompletedApprovals(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListCompletedApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCompletedApprovals`: []CompletedApproval + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListCompletedApprovals`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-pending-approvals +Pending Access Request Approvals List +This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-pending-approvals) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPendingApprovalsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* | + **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: **created, modified** | + +### Return type + +[**[]PendingApproval**](../models/pending-approval) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `ownerId_example` // string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `filters_example` // 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) + sorters := `sorters_example` // 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: **created, modified** (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: **created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.ListPendingApprovals(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.ListPendingApprovals(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListPendingApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPendingApprovals`: []PendingApproval + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListPendingApprovals`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reject-access-request +Reject Access Request Approval +Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/reject-access-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**approvalId** | **string** | Approval ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRejectAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **commentDto** | [**CommentDto**](../models/comment-dto) | Reviewer's comment. | + +### Return type + +**map[string]interface{}** + +### 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() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + commentdto := []byte(`{ + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + }`) // CommentDto | Reviewer's comment. + + + var commentDto beta.CommentDto + if err := json.Unmarshal(commentdto, &commentDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.RejectAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + //resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.RejectAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.RejectAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.RejectAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestIdentityMetricsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestIdentityMetricsAPI.md new file mode 100644 index 000000000..c69a5943f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestIdentityMetricsAPI.md @@ -0,0 +1,96 @@ +--- +id: beta-access-request-identity-metrics +title: AccessRequestIdentityMetrics +pagination_label: AccessRequestIdentityMetrics +sidebar_label: AccessRequestIdentityMetrics +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestIdentityMetrics', 'BetaAccessRequestIdentityMetrics'] +slug: /tools/sdk/go/beta/methods/access-request-identity-metrics +tags: ['SDK', 'Software Development Kit', 'AccessRequestIdentityMetrics', 'BetaAccessRequestIdentityMetrics'] +--- + +# AccessRequestIdentityMetricsAPI + Use this API to implement access request identity metrics functionality. +With this functionality in place, access request reviewers can see relevant details about the requested access item and associated source activity. +This allows reviewers to see how many of the identities who share a manager with the access requester have this same type of access and how many of them have had activity in the related source. +This additional context about whether the access has been granted before and how often it has been used can help those approving access requests make more informed decisions. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-access-request-identity-metrics**](#get-access-request-identity-metrics) | **Get** `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` | Return access request identity metrics + + +## get-access-request-identity-metrics +Return access request identity metrics +Use this API to return information access metrics. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-identity-metrics) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | Manager's identity ID. | +**requestedObjectId** | **string** | Requested access item's ID. | +**type_** | **string** | Requested access item's type. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestIdentityMetricsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `7025c863-c270-4ba6-beea-edf3cb091573` // string | Manager's identity ID. # string | Manager's identity ID. + requestedObjectId := `2db501be-f0fb-4cc5-a695-334133c52891` // string | Requested access item's ID. # string | Requested access item's ID. + type_ := `ENTITLEMENT` // string | Requested access item's type. # string | Requested access item's type. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics(context.Background(), identityId, requestedObjectId, type_).Execute() + //resp, r, err := apiClient.Beta.AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics(context.Background(), identityId, requestedObjectId, type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestIdentityMetrics`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestsAPI.md new file mode 100644 index 000000000..032aff9a8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AccessRequestsAPI.md @@ -0,0 +1,718 @@ +--- +id: beta-access-requests +title: AccessRequests +pagination_label: AccessRequests +sidebar_label: AccessRequests +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequests', 'BetaAccessRequests'] +slug: /tools/sdk/go/beta/methods/access-requests +tags: ['SDK', 'Software Development Kit', 'AccessRequests', 'BetaAccessRequests'] +--- + +# AccessRequestsAPI + Use this API to implement and customize access request functionality. +With this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked. +This allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools. + +Identity Security Cloud's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them. + +In the Request Center in Identity Security Cloud, users can view available applications, roles, and entitlements and request access to them. +If the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them. + +Users can use My Requests to track and/or cancel the requests. + +In My Team on the Identity Security Cloud Home, managers can submit requests to revoke their team members' access. +They can use the My Requests tab under Request Center to track and/or cancel the requests. + +Refer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-access-request**](#cancel-access-request) | **Post** `/access-requests/cancel` | Cancel Access Request +[**close-access-request**](#close-access-request) | **Post** `/access-requests/close` | Close Access Request +[**create-access-request**](#create-access-request) | **Post** `/access-requests` | Submit Access Request +[**get-access-request-config**](#get-access-request-config) | **Get** `/access-request-config` | Get Access Request Configuration +[**list-access-request-status**](#list-access-request-status) | **Get** `/access-request-status` | Access Request Status +[**set-access-request-config**](#set-access-request-config) | **Put** `/access-request-config` | Update Access Request Configuration + + +## cancel-access-request +Cancel Access Request +This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. +In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/cancel-access-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCancelAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cancelAccessRequest** | [**CancelAccessRequest**](../models/cancel-access-request) | | + +### Return type + +**map[string]interface{}** + +### 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() { + cancelaccessrequest := []byte(`{ + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + }`) // CancelAccessRequest | + + + var cancelAccessRequest beta.CancelAccessRequest + if err := json.Unmarshal(cancelaccessrequest, &cancelAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestsAPI.CancelAccessRequest(context.Background()).CancelAccessRequest(cancelAccessRequest).Execute() + //resp, r, err := apiClient.Beta.AccessRequestsAPI.CancelAccessRequest(context.Background()).CancelAccessRequest(cancelAccessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CancelAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CancelAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CancelAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## close-access-request +Close Access Request +This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). + +To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers. + +To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). + +Input the IDs from either source. + +To track the status of endpoint requests, navigate to Search and use this query: name:"Close Identity Requests". Search will include "Close Identity Requests Started" audits when requests are initiated and "Close Identity Requests Completed" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. + +This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/) for each access request that is closed. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/close-access-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCloseAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **closeAccessRequest** | [**CloseAccessRequest**](../models/close-access-request) | | + +### Return type + +**map[string]interface{}** + +### 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() { + closeaccessrequest := []byte(`{ + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + }`) // CloseAccessRequest | + + + var closeAccessRequest beta.CloseAccessRequest + if err := json.Unmarshal(closeaccessrequest, &closeAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestsAPI.CloseAccessRequest(context.Background()).CloseAccessRequest(closeAccessRequest).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `CloseAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CloseAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-access-request +Submit Access Request +Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. + +Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request +has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn't return an error +if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. + +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. + +There are two types of access request: + +__GRANT_ACCESS__ +* Can be requested for multiple identities in a single request. +* 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. +* 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. +* 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. +* 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. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessRequest** | [**AccessRequest**](../models/access-request) | | + +### Return type + +[**AccessRequestResponse**](../models/access-request-response) + +### 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() { + accessrequest := []byte(`{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } ] + }`) // AccessRequest | + + + var accessRequest beta.AccessRequest + if err := json.Unmarshal(accessrequest, &accessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestsAPI.CreateAccessRequest(context.Background()).AccessRequest(accessRequest).Execute() + //resp, r, err := apiClient.Beta.AccessRequestsAPI.CreateAccessRequest(context.Background()).AccessRequest(accessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CreateAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessRequest`: AccessRequestResponse + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CreateAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-config +Get Access Request Configuration +This endpoint returns the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestConfigRequest struct via the builder pattern + + +### Return type + +[**AccessRequestConfig**](../models/access-request-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestsAPI.GetAccessRequestConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccessRequestsAPI.GetAccessRequestConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.GetAccessRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestConfig`: AccessRequestConfig + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.GetAccessRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-request-status +Access Request Status +Use this API to return a list of access request statuses based on the specified query parameters. +If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. +Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-request-status) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessRequestStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **requestedBy** | **string** | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **regardingIdentity** | **string** | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. | + **assignedTo** | **string** | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. | + **count** | **bool** | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. | [default to false] + **limit** | **int32** | Max number of results to return. | [default to 250] + **offset** | **int32** | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. | + **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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* | + **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: **created, modified, accountActivityItemId, name** | + **requestState** | **string** | Filter the results by the state of the request. The only valid value is *EXECUTING*. | + +### Return type + +[**[]RequestedItemStatus**](../models/requested-item-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + assignedTo := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + count := false // bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + limit := 100 // int32 | Max number of results to return. (optional) (default to 250) # int32 | Max number of results to return. (optional) (default to 250) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + filters := `accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"` // 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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + sorters := `created` // 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: **created, modified, accountActivityItemId, name** (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: **created, modified, accountActivityItemId, name** (optional) + requestState := `request-state=EXECUTING` // string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestsAPI.ListAccessRequestStatus(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccessRequestsAPI.ListAccessRequestStatus(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).AssignedTo(assignedTo).Count(count).Limit(limit).Offset(offset).Filters(filters).Sorters(sorters).RequestState(requestState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.ListAccessRequestStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessRequestStatus`: []RequestedItemStatus + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.ListAccessRequestStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-access-request-config +Update Access Request Configuration +This endpoint replaces the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-access-request-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetAccessRequestConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessRequestConfig** | [**AccessRequestConfig**](../models/access-request-config) | | + +### Return type + +[**AccessRequestConfig**](../models/access-request-config) + +### 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() { + accessrequestconfig := []byte(`{ + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + }`) // AccessRequestConfig | + + + var accessRequestConfig beta.AccessRequestConfig + if err := json.Unmarshal(accessrequestconfig, &accessRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestsAPI.SetAccessRequestConfig(context.Background()).AccessRequestConfig(accessRequestConfig).Execute() + //resp, r, err := apiClient.Beta.AccessRequestsAPI.SetAccessRequestConfig(context.Background()).AccessRequestConfig(accessRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.SetAccessRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetAccessRequestConfig`: AccessRequestConfig + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.SetAccessRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AccountActivitiesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AccountActivitiesAPI.md new file mode 100644 index 000000000..94be1bd13 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AccountActivitiesAPI.md @@ -0,0 +1,198 @@ +--- +id: beta-account-activities +title: AccountActivities +pagination_label: AccountActivities +sidebar_label: AccountActivities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivities', 'BetaAccountActivities'] +slug: /tools/sdk/go/beta/methods/account-activities +tags: ['SDK', 'Software Development Kit', 'AccountActivities', 'BetaAccountActivities'] +--- + +# AccountActivitiesAPI + Use this API to implement account activity tracking functionality. +With this functionality in place, users can track source account activity in Identity Security Cloud, which greatly improves traceability in the system. + +An account activity refers to a log of each action performed on a source account. This is useful for auditing the changes that occur on an account throughout its life. +In Identity Security Cloud's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. + +Account activity includes most actions Identity Security Cloud completes on source accounts. Users can search in Identity Security Cloud for the following account action types: + +- Access Request: These include any access requests the source account is involved in. + +- Account Attribute Updates: These include updates to a single attribute on an account on a source. + +- Account State Update: These include locking or unlocking actions on an account on a source. + +- Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification. + +- Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. +Identity Security Cloud replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. + +- Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. +When you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays. +Account Activity does not include attribute updates that occur as a result of aggregation. + +- Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. +These also include refreshes that occur whenever Identity Security Cloud assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. + +- Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. + +- Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state. + +- Password Change: These include password changes on sources. + +Refer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-account-activity**](#get-account-activity) | **Get** `/account-activities/{id}` | Get Account Activity +[**list-account-activities**](#list-account-activities) | **Get** `/account-activities` | List Account Activities + + +## get-account-activity +Get Account Activity +This gets a single account activity by its id. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-account-activity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account activity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountActivityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CancelableAccountActivity**](../models/cancelable-account-activity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account activity id # string | The account activity id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountActivitiesAPI.GetAccountActivity(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AccountActivitiesAPI.GetAccountActivity(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountActivitiesAPI.GetAccountActivity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccountActivity`: CancelableAccountActivity + fmt.Fprintf(os.Stdout, "Response from `AccountActivitiesAPI.GetAccountActivity`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-account-activities +List Account Activities +This gets a collection of account activities that satisfy the given query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-account-activities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccountActivitiesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **requestedBy** | **string** | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **regardingIdentity** | **string** | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. | + **type_** | **string** | The type of account activity. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* | + **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: **type, created, modified** | + +### Return type + +[**[]CancelableAccountActivity**](../models/cancelable-account-activity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `requestedFor_example` // string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `requestedBy_example` // string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `regardingIdentity_example` // string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + type_ := `type__example` // string | The type of account activity. (optional) # string | The type of account activity. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `filters_example` // 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: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (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: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + sorters := `sorters_example` // 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: **type, created, modified** (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: **type, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountActivitiesAPI.ListAccountActivities(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccountActivitiesAPI.ListAccountActivities(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).Type_(type_).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountActivitiesAPI.ListAccountActivities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccountActivities`: []CancelableAccountActivity + fmt.Fprintf(os.Stdout, "Response from `AccountActivitiesAPI.ListAccountActivities`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AccountAggregationsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AccountAggregationsAPI.md new file mode 100644 index 000000000..3b5c5b0db --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AccountAggregationsAPI.md @@ -0,0 +1,104 @@ +--- +id: beta-account-aggregations +title: AccountAggregations +pagination_label: AccountAggregations +sidebar_label: AccountAggregations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAggregations', 'BetaAccountAggregations'] +slug: /tools/sdk/go/beta/methods/account-aggregations +tags: ['SDK', 'Software Development Kit', 'AccountAggregations', 'BetaAccountAggregations'] +--- + +# AccountAggregationsAPI + Use this API to implement account aggregation progress tracking functionality. +With this functionality in place, administrators can view in-progress account aggregations, their statuses, and their relevant details. + +An account aggregation refers to the process Identity Security Cloud uses to gather and load account data from a source into Identity Security Cloud. + +Whenever Identity Security Cloud is in the process of aggregating a source, it adds an entry to the Aggregation Activity Log, along with its relevant details. +To view aggregation activity, administrators can select the Connections drop-down menu, select Sources, and select the relevant source, select its Import Data tab, and select Account Aggregation. +In Account Aggregation, administrators can view the account aggregations' statuses and details in the Account Activity Log. + +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about account aggregations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-account-aggregation-status**](#get-account-aggregation-status) | **Get** `/account-aggregations/{id}/status` | In-progress Account Aggregation status + + +## get-account-aggregation-status +In-progress Account Aggregation status +This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. + +Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. + +Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. + +*Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* + +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-account-aggregation-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account aggregation id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountAggregationStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccountAggregationStatus**](../models/account-aggregation-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808477a6b0c60177a81146b8110b` // string | The account aggregation id # string | The account aggregation id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountAggregationsAPI.GetAccountAggregationStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `GetAccountAggregationStatus`: AccountAggregationStatus + fmt.Fprintf(os.Stdout, "Response from `AccountAggregationsAPI.GetAccountAggregationStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AccountUsagesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AccountUsagesAPI.md new file mode 100644 index 000000000..cac19952d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AccountUsagesAPI.md @@ -0,0 +1,97 @@ +--- +id: beta-account-usages +title: AccountUsages +pagination_label: AccountUsages +sidebar_label: AccountUsages +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUsages', 'BetaAccountUsages'] +slug: /tools/sdk/go/beta/methods/account-usages +tags: ['SDK', 'Software Development Kit', 'AccountUsages', 'BetaAccountUsages'] +--- + +# AccountUsagesAPI + Use this API to implement account usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used. +This allows organizations to get the information they need to start optimizing and securing source account usage. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-usages-by-account-id**](#get-usages-by-account-id) | **Get** `/account-usages/{accountId}/summaries` | Returns account usage insights + + +## get-usages-by-account-id +Returns account usage insights +This API returns a summary of account usage insights for past 12 months. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-usages-by-account-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**accountId** | **string** | ID of IDN account | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetUsagesByAccountIdRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **date** | + +### Return type + +[**[]AccountUsage**](../models/account-usage) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accountId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of IDN account # string | ID of IDN account + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `-date` // 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: **date** (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: **date** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountUsagesAPI.GetUsagesByAccountId(context.Background(), accountId).Execute() + //resp, r, err := apiClient.Beta.AccountUsagesAPI.GetUsagesByAccountId(context.Background(), accountId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountUsagesAPI.GetUsagesByAccountId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUsagesByAccountId`: []AccountUsage + fmt.Fprintf(os.Stdout, "Response from `AccountUsagesAPI.GetUsagesByAccountId`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AccountsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AccountsAPI.md new file mode 100644 index 000000000..a19d19c2b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AccountsAPI.md @@ -0,0 +1,1298 @@ +--- +id: beta-accounts +title: Accounts +pagination_label: Accounts +sidebar_label: Accounts +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Accounts', 'BetaAccounts'] +slug: /tools/sdk/go/beta/methods/accounts +tags: ['SDK', 'Software Development Kit', 'Accounts', 'BetaAccounts'] +--- + +# AccountsAPI + Use this API to implement and customize account functionality. +With this functionality in place, administrators can manage users' access across sources in Identity Security Cloud. + +In Identity Security Cloud, an account refers to a user's account on a supported source. +This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. Identity Security Cloud loads accounts through the creation of sources in Identity Security Cloud. + +Administrators can correlate users' identities with the users' accounts on the different sources they use. +This allows Identity Security Cloud to govern the access of identities and all their correlated accounts securely and cohesively. + +To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. + +To view and edit source account statuses for an identity in Identity Security Cloud, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. +Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. + +Accounts can have the following statuses: + +- Enabled: The account is enabled. The user can access it. + +- Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in Identity Security Cloud. This can occur when an administrator disables the account or when the user's lifecycle state changes. + +- Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times. + +- Pending: The account is currently updating. This status typically lasts seconds. + +Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed. + +Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-account**](#create-account) | **Post** `/accounts` | Create Account +[**delete-account**](#delete-account) | **Delete** `/accounts/{id}` | Delete Account +[**delete-account-async**](#delete-account-async) | **Post** `/accounts/{id}/remove` | Remove Account +[**disable-account**](#disable-account) | **Post** `/accounts/{id}/disable` | Disable Account +[**disable-account-for-identity**](#disable-account-for-identity) | **Post** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity +[**disable-accounts-for-identities**](#disable-accounts-for-identities) | **Post** `/identities-accounts/disable` | Disable IDN Accounts for Identities +[**enable-account**](#enable-account) | **Post** `/accounts/{id}/enable` | Enable Account +[**enable-account-for-identity**](#enable-account-for-identity) | **Post** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity +[**enable-accounts-for-identities**](#enable-accounts-for-identities) | **Post** `/identities-accounts/enable` | Enable IDN Accounts for Identities +[**get-account**](#get-account) | **Get** `/accounts/{id}` | Account Details +[**get-account-entitlements**](#get-account-entitlements) | **Get** `/accounts/{id}/entitlements` | Account Entitlements +[**list-accounts**](#list-accounts) | **Get** `/accounts` | Accounts List +[**put-account**](#put-account) | **Put** `/accounts/{id}` | Update Account +[**submit-reload-account**](#submit-reload-account) | **Post** `/accounts/{id}/reload` | Reload Account +[**unlock-account**](#unlock-account) | **Post** `/accounts/{id}/unlock` | Unlock Account +[**update-account**](#update-account) | **Patch** `/accounts/{id}` | Update Account + + +## create-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Create Account +Submits an account creation task - the API then returns the task ID. + +The `sourceId` where this account will be created must be included in the `attributes` object. + +This endpoint creates an account on the source record in your ISC tenant. +This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. + +However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. +The endpoint doesn't actually provision the account on the target source, which means that if the account doesn't also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. + +By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-account) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountAttributesCreate** | [**AccountAttributesCreate**](../models/account-attributes-create) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### 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() { + accountattributescreate := []byte(`{ + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }`) // AccountAttributesCreate | + + + var accountAttributesCreate beta.AccountAttributesCreate + if err := json.Unmarshal(accountattributescreate, &accountAttributesCreate); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.CreateAccount(context.Background()).AccountAttributesCreate(accountAttributesCreate).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.CreateAccount(context.Background()).AccountAttributesCreate(accountAttributesCreate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.CreateAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.CreateAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Delete Account +Use this API to delete an account. +This endpoint submits an account delete task and returns the task ID. +This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +>**NOTE:** You can only delete accounts from sources of the "DelimitedFile" type.** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.DeleteAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.DeleteAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DeleteAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DeleteAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-account-async +Remove Account +Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. + +This endpoint is good for: +* Removing accounts that no longer exist on the source. +* Removing accounts that won't be aggregated following updates to the source configuration. +* Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-account-async) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccountAsyncRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**TaskResultDto**](../models/task-result-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c350d6aa4f104c61b062cb632421ad10` // string | The account id # string | The account id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.DeleteAccountAsync(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `DeleteAccountAsync`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DeleteAccountAsync`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## disable-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Disable Account +This API submits a task to disable the account and returns the task ID. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/disable-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDisableAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **accountToggleRequest** | [**AccountToggleRequest**](../models/account-toggle-request) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + accounttogglerequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }`) // AccountToggleRequest | + + + var accountToggleRequest beta.AccountToggleRequest + if err := json.Unmarshal(accounttogglerequest, &accountToggleRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.DisableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.DisableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DisableAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DisableAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## disable-account-for-identity +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Disable IDN Account for Identity +This API submits a task to disable IDN account for a single identity. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/disable-account-for-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDisableAccountForIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808384203c2d018437e631158309` // string | The identity id. # string | The identity id. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.DisableAccountForIdentity(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `DisableAccountForIdentity`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccountForIdentity`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## disable-accounts-for-identities +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Disable IDN Accounts for Identities +This API submits tasks to disable IDN account for each identity provided in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/disable-accounts-for-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDisableAccountsForIdentitiesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identitiesAccountsBulkRequest** | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | | + +### Return type + +[**[]BulkIdentitiesAccountsResponse**](../models/bulk-identities-accounts-response) + +### 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() { + identitiesaccountsbulkrequest := []byte(`{ + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + }`) // IdentitiesAccountsBulkRequest | + + + var identitiesAccountsBulkRequest beta.IdentitiesAccountsBulkRequest + if err := json.Unmarshal(identitiesaccountsbulkrequest, &identitiesAccountsBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.DisableAccountsForIdentities(context.Background()).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `DisableAccountsForIdentities`: []BulkIdentitiesAccountsResponse + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccountsForIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## enable-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Enable Account +This API submits a task to enable account and returns the task ID. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/enable-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiEnableAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **accountToggleRequest** | [**AccountToggleRequest**](../models/account-toggle-request) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + accounttogglerequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }`) // AccountToggleRequest | + + + var accountToggleRequest beta.AccountToggleRequest + if err := json.Unmarshal(accounttogglerequest, &accountToggleRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.EnableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.EnableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.EnableAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `EnableAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## enable-account-for-identity +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Enable IDN Account for Identity +This API submits a task to enable IDN account for a single identity. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/enable-account-for-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiEnableAccountForIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808384203c2d018437e631158309` // string | The identity id. # string | The identity id. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.EnableAccountForIdentity(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `EnableAccountForIdentity`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccountForIdentity`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## enable-accounts-for-identities +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Enable IDN Accounts for Identities +This API submits tasks to enable IDN account for each identity provided in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/enable-accounts-for-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiEnableAccountsForIdentitiesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identitiesAccountsBulkRequest** | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | | + +### Return type + +[**[]BulkIdentitiesAccountsResponse**](../models/bulk-identities-accounts-response) + +### 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() { + identitiesaccountsbulkrequest := []byte(`{ + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + }`) // IdentitiesAccountsBulkRequest | + + + var identitiesAccountsBulkRequest beta.IdentitiesAccountsBulkRequest + if err := json.Unmarshal(identitiesaccountsbulkrequest, &identitiesAccountsBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.EnableAccountsForIdentities(context.Background()).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `EnableAccountsForIdentities`: []BulkIdentitiesAccountsResponse + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccountsForIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Account Details +Use this API to return the details for a single account by its ID. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Account**](../models/account) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.GetAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.GetAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.GetAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccount`: Account + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.GetAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-account-entitlements +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Account Entitlements +This API returns entitlements of the account. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-account-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountEntitlementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.GetAccountEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.GetAccountEntitlements(context.Background(), id).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.GetAccountEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccountEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.GetAccountEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-accounts +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Accounts List +List accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-accounts) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccountsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **detailLevel** | **string** | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* | + **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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** | + +### Return type + +[**[]Account**](../models/account) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + detailLevel := `FULL` // string | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) # string | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `identityId eq "2c9180858082150f0180893dbaf44201"` // 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (optional) + sorters := `id,name` // 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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.ListAccounts(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.ListAccounts(context.Background()).DetailLevel(detailLevel).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.ListAccounts``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccounts`: []Account + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.ListAccounts`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Update Account +Use this API to update an account with a PUT request. + +This endpoint submits an account update task and returns the task ID. + +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +>**Note: You can only use this PUT endpoint to update accounts from flat file sources.** + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **accountAttributes** | [**AccountAttributes**](../models/account-attributes) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### 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 := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + accountattributes := []byte(`{ + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }`) // AccountAttributes | + + + var accountAttributes beta.AccountAttributes + if err := json.Unmarshal(accountattributes, &accountAttributes); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.PutAccount(context.Background(), id).AccountAttributes(accountAttributes).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.PutAccount(context.Background(), id).AccountAttributes(accountAttributes).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.PutAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.PutAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-reload-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Reload Account +This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-reload-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitReloadAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.SubmitReloadAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.SubmitReloadAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.SubmitReloadAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitReloadAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.SubmitReloadAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## unlock-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Unlock Account +This API submits a task to unlock an account and returns the task ID. +To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/unlock-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUnlockAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **accountUnlockRequest** | [**AccountUnlockRequest**](../models/account-unlock-request) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The account ID. # string | The account ID. + accountunlockrequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + }`) // AccountUnlockRequest | + + + var accountUnlockRequest beta.AccountUnlockRequest + if err := json.Unmarshal(accountunlockrequest, &accountUnlockRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.UnlockAccount(context.Background(), id).AccountUnlockRequest(accountUnlockRequest).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.UnlockAccount(context.Background(), id).AccountUnlockRequest(accountUnlockRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.UnlockAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UnlockAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.UnlockAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-account +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Update Account +Use this API to update account details. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields. +To reassign an account from one identity to another, replace the current `identityId` with a new value. +If the account you're assigning was provisioned by Identity Security Cloud (ISC), it's possible for ISC to create a new account +for the previous identity as soon as the account is moved. If the account you're assigning is authoritative, +this causes the previous identity to become uncorrelated and can even result in its deletion. +All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. + +>**Note:** The `attributes` field can only be modified for flat file accounts. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **requestBody** | **[]map[string]interface{}** | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + requestbody := []byte(`{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}`) // []map[string]interface{} | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var requestBody beta.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.UpdateAccount(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.UpdateAccount(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.UpdateAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAccount`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.UpdateAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/ApplicationDiscoveryAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/ApplicationDiscoveryAPI.md new file mode 100644 index 000000000..25bae8f2f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/ApplicationDiscoveryAPI.md @@ -0,0 +1,350 @@ +--- +id: beta-application-discovery +title: ApplicationDiscovery +pagination_label: ApplicationDiscovery +sidebar_label: ApplicationDiscovery +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApplicationDiscovery', 'BetaApplicationDiscovery'] +slug: /tools/sdk/go/beta/methods/application-discovery +tags: ['SDK', 'Software Development Kit', 'ApplicationDiscovery', 'BetaApplicationDiscovery'] +--- + +# ApplicationDiscoveryAPI + Use this API to implement application discovery functionality. +With this functionality in place, you can discover applications within your Okta connector and receive connector recommendations by manually uploading application names. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-discovered-application-by-id**](#get-discovered-application-by-id) | **Get** `/discovered-applications/{id}` | Get Discovered Application by ID +[**get-discovered-applications**](#get-discovered-applications) | **Get** `/discovered-applications` | Retrieve discovered applications for tenant +[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **Get** `/manual-discover-applications-template` | Download CSV Template for Discovery +[**patch-discovered-application-by-id**](#patch-discovered-application-by-id) | **Patch** `/discovered-applications/{id}` | Patch Discovered Application by ID +[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **Post** `/manual-discover-applications` | Upload CSV to Discover Applications + + +## get-discovered-application-by-id +Get Discovered Application by ID +Get the discovered application, along with with its associated sources, based on the provided ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-discovered-application-by-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Discovered application's ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDiscoveredApplicationByIDRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `123e4567-e89b-12d3-a456-426655440000` // string | Discovered application's ID. # string | Discovered application's ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.ApplicationDiscoveryAPI.GetDiscoveredApplicationByID(context.Background(), id).Execute() + //r, err := apiClient.Beta.ApplicationDiscoveryAPI.GetDiscoveredApplicationByID(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetDiscoveredApplicationByID``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-discovered-applications +Retrieve discovered applications for tenant +Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-discovered-applications) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDiscoveredApplicationsRequest struct via the builder pattern + + +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] + **detail** | **string** | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. | + **filter** | **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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* | + **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, description, discoveredAt, discoverySource** | + +### Return type + +[**[]GetDiscoveredApplications200ResponseInner**](../models/get-discovered-applications200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + filter := `name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")` // 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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + sorters := `name` // 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, description, discoveredAt, discoverySource** (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, description, discoveredAt, discoverySource** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ApplicationDiscoveryAPI.GetDiscoveredApplications(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ApplicationDiscoveryAPI.GetDiscoveredApplications(context.Background()).Limit(limit).Offset(offset).Detail(detail).Filter(filter).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetDiscoveredApplications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDiscoveredApplications`: []GetDiscoveredApplications200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `ApplicationDiscoveryAPI.GetDiscoveredApplications`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-manual-discover-applications-csv-template +Download CSV Template for Discovery +Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. + +The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-manual-discover-applications-csv-template) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManualDiscoverApplicationsCsvTemplateRequest struct via the builder pattern + + +### Return type + +[**ManualDiscoverApplicationsTemplate**](../models/manual-discover-applications-template) + +### 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() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManualDiscoverApplicationsCsvTemplate`: ManualDiscoverApplicationsTemplate + fmt.Fprintf(os.Stdout, "Response from `ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-discovered-application-by-id +Patch Discovered Application by ID +Update an existing discovered application by using a limited version of the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +You can patch these fields: - **associatedSources** - **dismissed** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-discovered-application-by-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Discovered application's ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchDiscoveredApplicationByIDRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperations** | [**[]JsonPatchOperations**](../models/json-patch-operations) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `123e4567-e89b-12d3-a456-426655440000` // string | Discovered application's ID. # string | Discovered application's ID. + jsonpatchoperations := []byte(`[{op=replace, path=/dismissed, value=true}]`) // []JsonPatchOperations | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.ApplicationDiscoveryAPI.PatchDiscoveredApplicationByID(context.Background(), id).Execute() + //r, err := apiClient.Beta.ApplicationDiscoveryAPI.PatchDiscoveredApplicationByID(context.Background(), id).JsonPatchOperations(jsonPatchOperations).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.PatchDiscoveredApplicationByID``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## send-manual-discover-applications-csv-template +Upload CSV to Discover Applications +Upload a CSV file with application data for manual correlation to specific ISC connectors. +If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-manual-discover-applications-csv-template) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendManualDiscoverApplicationsCsvTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file** | ***os.File** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | + +### Return type + + (empty response body) + +### 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() { + file := BINARY_DATA_HERE // *os.File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # *os.File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate(context.Background()).File(file).Execute() + //r, err := apiClient.Beta.ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate(context.Background()).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/ApprovalsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/ApprovalsAPI.md new file mode 100644 index 000000000..f88691beb --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/ApprovalsAPI.md @@ -0,0 +1,157 @@ +--- +id: beta-approvals +title: Approvals +pagination_label: Approvals +sidebar_label: Approvals +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Approvals', 'BetaApprovals'] +slug: /tools/sdk/go/beta/methods/approvals +tags: ['SDK', 'Software Development Kit', 'Approvals', 'BetaApprovals'] +--- + +# ApprovalsAPI + Use this API to implement approval functionality. With this functionality in place, you can get generic approvals and modify them. + +The main advantages this API has vs [Access Request Approvals](https://developer.sailpoint.com/docs/api/beta/access-request-approvals) are that you can use it to get generic approvals individually or in batches and make changes to those approvals. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-approval**](#get-approval) | **Get** `/generic-approvals/{id}` | Get Approval +[**get-approvals**](#get-approvals) | **Get** `/generic-approvals` | Get Approvals + + +## get-approval +Get Approval +Get a single approval for a given approval ID. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and doesn't include access-request-approvals. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-approval) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the approval that to be returned. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetApprovalRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Approval**](../models/approval) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `38453251-6be2-5f8f-df93-5ce19e295837` // string | ID of the approval that to be returned. # string | ID of the approval that to be returned. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ApprovalsAPI.GetApproval(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.ApprovalsAPI.GetApproval(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApprovalsAPI.GetApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetApproval`: Approval + fmt.Fprintf(os.Stdout, "Response from `ApprovalsAPI.GetApproval`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-approvals +Get Approvals +Get a list of approvals, which can be filtered by requester ID, status, or reference type. You can use the "Mine" query parameter to return all approvals for the current approver. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and does not include access-request-approvals. +Absence of all query parameters will will default to mine=true. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-approvals) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetApprovalsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mine** | **bool** | Returns the list of approvals for the current caller. | + **requesterId** | **string** | Returns the list of approvals for a given requester ID. | + **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: **status**: *eq* **referenceType**: *eq* | + +### Return type + +[**[]Approval**](../models/approval) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + mine := true // bool | Returns the list of approvals for the current caller. (optional) # bool | Returns the list of approvals for the current caller. (optional) + requesterId := `17e633e7d57e481569df76323169deb6a` // string | Returns the list of approvals for a given requester ID. (optional) # string | Returns the list of approvals for a given requester ID. (optional) + filters := `filters=status eq PENDING` // 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: **status**: *eq* **referenceType**: *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: **status**: *eq* **referenceType**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ApprovalsAPI.GetApprovals(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ApprovalsAPI.GetApprovals(context.Background()).Mine(mine).RequesterId(requesterId).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApprovalsAPI.GetApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetApprovals`: []Approval + fmt.Fprintf(os.Stdout, "Response from `ApprovalsAPI.GetApprovals`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AppsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AppsAPI.md new file mode 100644 index 000000000..18021abde --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AppsAPI.md @@ -0,0 +1,1025 @@ +--- +id: beta-apps +title: Apps +pagination_label: Apps +sidebar_label: Apps +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Apps', 'BetaApps'] +slug: /tools/sdk/go/beta/methods/apps +tags: ['SDK', 'Software Development Kit', 'Apps', 'BetaApps'] +--- + +# AppsAPI + Use this API to implement source application functionality. +With this functionality in place, you can create, customize, and manage applications within sources. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-source-app**](#create-source-app) | **Post** `/source-apps` | Create source app +[**delete-access-profiles-from-source-app-by-bulk**](#delete-access-profiles-from-source-app-by-bulk) | **Post** `/source-apps/{id}/access-profiles/bulk-remove` | Bulk remove access profiles from the specified source app +[**delete-source-app**](#delete-source-app) | **Delete** `/source-apps/{id}` | Delete source app by ID +[**get-source-app**](#get-source-app) | **Get** `/source-apps/{id}` | Get source app by ID +[**list-access-profiles-for-source-app**](#list-access-profiles-for-source-app) | **Get** `/source-apps/{id}/access-profiles` | List access profiles for the specified source app +[**list-all-source-app**](#list-all-source-app) | **Get** `/source-apps/all` | List all source apps +[**list-all-user-apps**](#list-all-user-apps) | **Get** `/user-apps/all` | List all user apps +[**list-assigned-source-app**](#list-assigned-source-app) | **Get** `/source-apps/assigned` | List assigned source apps +[**list-available-accounts-for-user-app**](#list-available-accounts-for-user-app) | **Get** `/user-apps/{id}/available-accounts` | List available accounts for user app +[**list-available-source-apps**](#list-available-source-apps) | **Get** `/source-apps` | List available source apps +[**list-owned-user-apps**](#list-owned-user-apps) | **Get** `/user-apps` | List owned user apps +[**patch-source-app**](#patch-source-app) | **Patch** `/source-apps/{id}` | Patch source app by ID +[**patch-user-app**](#patch-user-app) | **Patch** `/user-apps/{id}` | Patch user app by ID +[**update-source-apps-in-bulk**](#update-source-apps-in-bulk) | **Post** `/source-apps/bulk-update` | Bulk update source apps + + +## create-source-app +Create source app +This endpoint creates a source app using the given source app payload + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-source-app) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sourceAppCreateDto** | [**SourceAppCreateDto**](../models/source-app-create-dto) | | + +### Return type + +[**SourceApp**](../models/source-app) + +### 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() { + sourceappcreatedto := []byte(`{ + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true + }`) // SourceAppCreateDto | + + + var sourceAppCreateDto beta.SourceAppCreateDto + if err := json.Unmarshal(sourceappcreatedto, &sourceAppCreateDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.CreateSourceApp(context.Background()).SourceAppCreateDto(sourceAppCreateDto).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.CreateSourceApp(context.Background()).SourceAppCreateDto(sourceAppCreateDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.CreateSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.CreateSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-access-profiles-from-source-app-by-bulk +Bulk remove access profiles from the specified source app +This API returns the final list of access profiles for the specified source app after removing + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-access-profiles-from-source-app-by-bulk) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the source app | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccessProfilesFromSourceAppByBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **requestBody** | **[]string** | | + **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] + +### Return type + +[**[]AccessProfileDetails**](../models/access-profile-details) + +### 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 := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + requestbody := []byte(``) // []string | + 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) + + + var requestBody beta.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.DeleteAccessProfilesFromSourceAppByBulk(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.DeleteAccessProfilesFromSourceAppByBulk(context.Background(), id).RequestBody(requestBody).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.DeleteAccessProfilesFromSourceAppByBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccessProfilesFromSourceAppByBulk`: []AccessProfileDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.DeleteAccessProfilesFromSourceAppByBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-source-app +Delete source app by ID +Use this API to delete a specific source app + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-source-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | source app ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | source app ID. # string | source app ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.DeleteSourceApp(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.DeleteSourceApp(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.DeleteSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.DeleteSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-app +Get source app by ID +This API returns a source app by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the source app | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.GetSourceApp(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.GetSourceApp(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.GetSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.GetSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-profiles-for-source-app +List access profiles for the specified source app +This API returns the list of access profiles for the specified source app + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-profiles-for-source-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the source app | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessProfilesForSourceAppRequest struct via the builder pattern + + +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] + **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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* | + +### Return type + +[**[]AccessProfileDetails**](../models/access-profile-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + 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) + filters := `name eq "developer access profile"` // 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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.ListAccessProfilesForSourceApp(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.ListAccessProfilesForSourceApp(context.Background(), id).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAccessProfilesForSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessProfilesForSourceApp`: []AccessProfileDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAccessProfilesForSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-all-source-app +List all source apps +This API returns the list of all source apps for the org. + +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-all-source-app) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAllSourceAppRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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] + **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: **id, name, created, modified, owner.id, accountSource.id** | + **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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* | + +### Return type + +[**[]SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, owner.id, accountSource.id** (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: **id, name, created, modified, owner.id, accountSource.id** (optional) + filters := `enabled eq true` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.ListAllSourceApp(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.ListAllSourceApp(context.Background()).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAllSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAllSourceApp`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAllSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-all-user-apps +List all user apps +This API returns the list of all user apps with specified filters. +This API must be used with **filters** query parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-all-user-apps) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAllUserAppsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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 + +[**[]UserApp**](../models/user-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `name eq "user app name"` // 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.AppsAPI.ListAllUserApps(context.Background()).Filters(filters).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.ListAllUserApps(context.Background()).Filters(filters).Limit(limit).Count(count).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAllUserApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAllUserApps`: []UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAllUserApps`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-assigned-source-app +List assigned source apps +This API returns the list of source apps assigned for logged in user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-assigned-source-app) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAssignedSourceAppRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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] + **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: **id, name, created, modified, accountSource.id** | + **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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* | + +### Return type + +[**[]SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, accountSource.id** (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: **id, name, created, modified, accountSource.id** (optional) + filters := `name eq "source app name"` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.ListAssignedSourceApp(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.ListAssignedSourceApp(context.Background()).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAssignedSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAssignedSourceApp`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAssignedSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-available-accounts-for-user-app +List available accounts for user app +This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-available-accounts-for-user-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the user app | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAvailableAccountsForUserAppRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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 + +[**[]AppAccountDetails**](../models/app-account-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the user app # string | ID of the user app + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.AppsAPI.ListAvailableAccountsForUserApp(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.ListAvailableAccountsForUserApp(context.Background(), id).Limit(limit).Count(count).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAvailableAccountsForUserApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAvailableAccountsForUserApp`: []AppAccountDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAvailableAccountsForUserApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-available-source-apps +List available source apps +This API returns the list of source apps available for access request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-available-source-apps) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAvailableSourceAppsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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] + **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: **id, name, created, modified, owner.id, accountSource.id** | + **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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* | + +### Return type + +[**[]SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, owner.id, accountSource.id** (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: **id, name, created, modified, owner.id, accountSource.id** (optional) + filters := `name eq "source app name"` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.ListAvailableSourceApps(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.ListAvailableSourceApps(context.Background()).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAvailableSourceApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAvailableSourceApps`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAvailableSourceApps`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-owned-user-apps +List owned user apps +This API returns the list of user apps assigned to logged in user + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-owned-user-apps) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOwnedUserAppsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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] + **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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* | + +### Return type + +[**[]UserApp**](../models/user-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + filters := `name eq "user app name"` // 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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.ListOwnedUserApps(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.ListOwnedUserApps(context.Background()).Limit(limit).Count(count).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListOwnedUserApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOwnedUserApps`: []UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListOwnedUserApps`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-source-app +Patch source app by ID +This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. +Name, description and owner can't be empty or null. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-source-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the source app to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**SourceAppPatchDto**](../models/source-app-patch-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app to patch # string | ID of the source app to patch + jsonpatchoperation := []byte(`[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]`) // []JsonPatchOperation | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.PatchSourceApp(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.PatchSourceApp(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.PatchSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSourceApp`: SourceAppPatchDto + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.PatchSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-user-app +Patch user app by ID +This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **account** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-user-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the user app to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchUserAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**UserApp**](../models/user-app) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the user app to patch # string | ID of the user app to patch + jsonpatchoperation := []byte(``) // []JsonPatchOperation | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.PatchUserApp(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.PatchUserApp(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.PatchUserApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchUserApp`: UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.PatchUserApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-source-apps-in-bulk +Bulk update source apps +This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. +The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. +Name, description and owner can't be empty or null. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-source-apps-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSourceAppsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sourceAppBulkUpdateRequest** | [**SourceAppBulkUpdateRequest**](../models/source-app-bulk-update-request) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceappbulkupdaterequest := []byte(`{ + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] + }`) // SourceAppBulkUpdateRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.AppsAPI.UpdateSourceAppsInBulk(context.Background()).Execute() + //r, err := apiClient.Beta.AppsAPI.UpdateSourceAppsInBulk(context.Background()).SourceAppBulkUpdateRequest(sourceAppBulkUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.UpdateSourceAppsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/AuthProfileAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/AuthProfileAPI.md new file mode 100644 index 000000000..3fdd97559 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/AuthProfileAPI.md @@ -0,0 +1,226 @@ +--- +id: beta-auth-profile +title: AuthProfile +pagination_label: AuthProfile +sidebar_label: AuthProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuthProfile', 'BetaAuthProfile'] +slug: /tools/sdk/go/beta/methods/auth-profile +tags: ['SDK', 'Software Development Kit', 'AuthProfile', 'BetaAuthProfile'] +--- + +# AuthProfileAPI + Use this API to implement Auth Profile functionality. +With this functionality in place, users can read authentication profiles and make changes to them. + +An authentication profile represents an identity profile's authentication configuration. +When the identity profile is created, its authentication profile is also created. +An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-profile-config**](#get-profile-config) | **Get** `/auth-profiles/{id}` | Get Auth Profile. +[**get-profile-config-list**](#get-profile-config-list) | **Get** `/auth-profiles` | Get list of Auth Profiles. +[**patch-profile-config**](#patch-profile-config) | **Patch** `/auth-profiles/{id}` | Patch a specified Auth Profile + + +## get-profile-config +Get Auth Profile. +This API returns auth profile information. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-profile-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Auth Profile to get. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProfileConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AuthProfile**](../models/auth-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Auth Profile to get. # string | ID of the Auth Profile to get. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AuthProfileAPI.GetProfileConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AuthProfileAPI.GetProfileConfig(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.GetProfileConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProfileConfig`: AuthProfile + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.GetProfileConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-profile-config-list +Get list of Auth Profiles. +This API returns a list of auth profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-profile-config-list) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProfileConfigListRequest struct via the builder pattern + + +### Return type + +[**[]AuthProfileSummary**](../models/auth-profile-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AuthProfileAPI.GetProfileConfigList(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AuthProfileAPI.GetProfileConfigList(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.GetProfileConfigList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProfileConfigList`: []AuthProfileSummary + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.GetProfileConfigList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-profile-config +Patch a specified Auth Profile +This API updates an existing Auth Profile. The following fields are patchable: +**offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-profile-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Auth Profile to patch. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchProfileConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**AuthProfile**](../models/auth-profile) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `2c91808a7813090a017814121919ecca` // string | ID of the Auth Profile to patch. # string | ID of the Auth Profile to patch. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AuthProfileAPI.PatchProfileConfig(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.AuthProfileAPI.PatchProfileConfig(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.PatchProfileConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchProfileConfig`: AuthProfile + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.PatchProfileConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/CertificationCampaignsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/CertificationCampaignsAPI.md new file mode 100644 index 000000000..c854afc7d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/CertificationCampaignsAPI.md @@ -0,0 +1,2016 @@ +--- +id: beta-certification-campaigns +title: CertificationCampaigns +pagination_label: CertificationCampaigns +sidebar_label: CertificationCampaigns +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationCampaigns', 'BetaCertificationCampaigns'] +slug: /tools/sdk/go/beta/methods/certification-campaigns +tags: ['SDK', 'Software Development Kit', 'CertificationCampaigns', 'BetaCertificationCampaigns'] +--- + +# CertificationCampaignsAPI + Use this API to implement certification campaign functionality. +With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use. +Certification campaigns provide Identity Security Cloud users with an interactive review process they can use to identify and verify access to systems. +Campaigns help organizations reduce risk of inappropriate access and satisfy audit requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers. +Once this campaign has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Identity Security Cloud provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns: + +You can create these types of campaigns without using any search queries in Identity Security Cloud: + +- ManagerCampaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access is certified by their managers. +You only need to provide a name and description to create one. + +- Source Owner Campaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners. +You only need to provide a name and description to create one. +You can specify the sources whose owners you want involved or just run it across all sources. + +For more information about these campaign types, refer to [Starting a Manager or Source Owner Campaign](https://documentation.sailpoint.com/saas/help/certs/starting_campaign.html). + +One useful way to create certification campaigns in Identity Security Cloud is to use a specific search and then run a campaign on the results returned by that search. +This allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns. +For example, you can search for all identities who are managed by "Amanda.Ross" and also have the access to the "Accounting" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified. + +You can use Identity Security Cloud search queries to create these types of campaigns: + +- Identities: Use this campaign type to review and revoke access items for specific identities. +You can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign. + +- Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them. +You can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign. + +- Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria. +You can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign. + +- Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in Identity Security Cloud. +You can use this campaign type to view all the uncorrelated accounts for a source and certify them. + +For more information about search-based campaigns, refer to [Starting a Campaign from Search](https://documentation.sailpoint.com/saas/help/certs/starting_search_campaign.html). + +Once you have generated your campaign, it becomes available for preview. +An administrator can review the campaign and make changes, or if it's ready and accurate, activate it. + +Once the campaign is active, organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed). + +When a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review. +Reviewers can then make decisions to grant or revoke access, as well as reassign the certification to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must "Sign Off" to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. +In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +The end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision. + +For more information about certifications and certification campaigns, refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html). + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**complete-campaign**](#complete-campaign) | **Post** `/campaigns/{id}/complete` | Complete a Campaign +[**create-campaign**](#create-campaign) | **Post** `/campaigns` | Create Campaign +[**create-campaign-template**](#create-campaign-template) | **Post** `/campaign-templates` | Create a Campaign Template +[**delete-campaign-template**](#delete-campaign-template) | **Delete** `/campaign-templates/{id}` | Delete a Campaign Template +[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **Delete** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule +[**delete-campaigns**](#delete-campaigns) | **Post** `/campaigns/delete` | Delete Campaigns +[**get-active-campaigns**](#get-active-campaigns) | **Get** `/campaigns` | List Campaigns +[**get-campaign**](#get-campaign) | **Get** `/campaigns/{id}` | Get Campaign +[**get-campaign-reports**](#get-campaign-reports) | **Get** `/campaigns/{id}/reports` | Get Campaign Reports +[**get-campaign-reports-config**](#get-campaign-reports-config) | **Get** `/campaigns/reports-configuration` | Get Campaign Reports Configuration +[**get-campaign-template**](#get-campaign-template) | **Get** `/campaign-templates/{id}` | Get a Campaign Template +[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **Get** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule +[**get-campaign-templates**](#get-campaign-templates) | **Get** `/campaign-templates` | List Campaign Templates +[**move**](#move) | **Post** `/campaigns/{id}/reassign` | Reassign Certifications +[**patch-campaign-template**](#patch-campaign-template) | **Patch** `/campaign-templates/{id}` | Update a Campaign Template +[**set-campaign-reports-config**](#set-campaign-reports-config) | **Put** `/campaigns/reports-configuration` | Set Campaign Reports Configuration +[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **Put** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule +[**start-campaign**](#start-campaign) | **Post** `/campaigns/{id}/activate` | Activate a Campaign +[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **Post** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan +[**start-campaign-report**](#start-campaign-report) | **Post** `/campaigns/{id}/run-report/{type}` | Run Campaign Report +[**start-generate-campaign-template**](#start-generate-campaign-template) | **Post** `/campaign-templates/{id}/generate` | Generate a Campaign from Template +[**update-campaign**](#update-campaign) | **Patch** `/campaigns/{id}` | Update a Campaign + + +## complete-campaign +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Complete a Campaign +:::caution + +This endpoint will run successfully for any campaigns that are **past due**. + +This endpoint will return a content error if the campaign is **not past due**. + +::: + +Use this API to complete a certification campaign. This functionality is provided to admins so that they +can complete a certification even if all items have not been completed. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/complete-campaign). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/complete-campaign) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Campaign ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompleteCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **completeCampaignOptions** | [**CompleteCampaignOptions**](../models/complete-campaign-options) | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Campaign ID. # string | Campaign ID. + completecampaignoptions := []byte(`{ + "autoCompleteAction" : "REVOKE" + }`) // CompleteCampaignOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.CompleteCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.CompleteCampaign(context.Background(), id).CompleteCampaignOptions(completeCampaignOptions).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CompleteCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompleteCampaign`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CompleteCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-campaign +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Create Campaign +Use this API to create a certification campaign with the information provided in the request body. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-campaign) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaign** | [**Campaign**](../models/campaign) | | + +### Return type + +[**Campaign**](../models/campaign) + +### 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() { + campaign := []byte(`{ + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }`) // Campaign | + + + var campaign beta.Campaign + if err := json.Unmarshal(campaign, &campaign); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.CreateCampaign(context.Background()).Campaign(campaign).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.CreateCampaign(context.Background()).Campaign(campaign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CreateCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaign`: Campaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CreateCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-campaign-template +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Create a Campaign Template +Use this API to create a campaign template based on campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign-template). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-campaign-template) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaignTemplate** | [**CampaignTemplate**](../models/campaign-template) | | + +### Return type + +[**CampaignTemplate**](../models/campaign-template) + +### 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() { + campaigntemplate := []byte(`{ + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + }`) // CampaignTemplate | + + + var campaignTemplate beta.CampaignTemplate + if err := json.Unmarshal(campaigntemplate, &campaignTemplate); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.CreateCampaignTemplate(context.Background()).CampaignTemplate(campaignTemplate).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.CreateCampaignTemplate(context.Background()).CampaignTemplate(campaignTemplate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CreateCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CreateCampaignTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-campaign-template +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Delete a Campaign Template +Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-campaign-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template being deleted. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template being deleted. # string | ID of the campaign template being deleted. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.CertificationCampaignsAPI.DeleteCampaignTemplate(context.Background(), id).Execute() + //r, err := apiClient.Beta.CertificationCampaignsAPI.DeleteCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-campaign-template-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Delete Campaign Template Schedule +Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-campaign-template-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template whose schedule is being deleted. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCampaignTemplateScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template whose schedule is being deleted. # string | ID of the campaign template whose schedule is being deleted. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.CertificationCampaignsAPI.DeleteCampaignTemplateSchedule(context.Background(), id).Execute() + //r, err := apiClient.Beta.CertificationCampaignsAPI.DeleteCampaignTemplateSchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-campaigns +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Delete Campaigns +Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaigns). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-campaigns) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCampaignsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **deleteCampaignsRequest** | [**DeleteCampaignsRequest**](../models/delete-campaigns-request) | IDs of the campaigns to delete. | + +### Return type + +**map[string]interface{}** + +### 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() { + deletecampaignsrequest := []byte(`{ + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + }`) // DeleteCampaignsRequest | IDs of the campaigns to delete. + + + var deleteCampaignsRequest beta.DeleteCampaignsRequest + if err := json.Unmarshal(deletecampaignsrequest, &deleteCampaignsRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).DeleteCampaignsRequest(deleteCampaignsRequest).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).DeleteCampaignsRequest(deleteCampaignsRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaigns``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteCampaigns`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.DeleteCampaigns`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-active-campaigns +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +List Campaigns +Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns). + +A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-active-campaigns) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetActiveCampaignsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **detail** | **string** | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **status**: *eq, in* | + **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, created** | + +### Return type + +[**[]GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Manager Campaign"` // 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* **status**: *eq, in* (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* **status**: *eq, in* (optional) + sorters := `name` // 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, created** (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, created** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetActiveCampaigns(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetActiveCampaigns(context.Background()).Detail(detail).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetActiveCampaigns``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetActiveCampaigns`: []GetActiveCampaigns200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetActiveCampaigns`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get Campaign +Use this API to get information for an existing certification campaign by the campaign's ID. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign to be retrieved. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Slimcampaign**](../models/slimcampaign) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign to be retrieved. # string | ID of the campaign to be retrieved. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaign(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaign`: Slimcampaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-reports +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get Campaign Reports +Use this API to fetch all reports for a certification campaign by campaign ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports). + +A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-reports) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign whose reports are being fetched. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignReportsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]CampaignReport**](../models/campaign-report) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign whose reports are being fetched. # string | ID of the campaign whose reports are being fetched. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignReports(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignReports(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignReports``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignReports`: []CampaignReport + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignReports`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-reports-config +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get Campaign Reports Configuration +Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-reports-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignReportsConfigRequest struct via the builder pattern + + +### Return type + +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignReportsConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignReportsConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignReportsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignReportsConfig`: CampaignReportsConfig + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignReportsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-template +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get a Campaign Template +Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Requested campaign template's ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CampaignTemplate**](../models/campaign-template) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Requested campaign template's ID. # string | Requested campaign template's ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-template-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get Campaign Template Schedule +Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-template-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template whose schedule is being fetched. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignTemplateScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Schedule**](../models/schedule) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template whose schedule is being fetched. # string | ID of the campaign template whose schedule is being fetched. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignTemplateSchedule(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignTemplateSchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplateSchedule`: Schedule + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplateSchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-templates +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +List Campaign Templates +Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/list-campaign-templates). + +The endpoint returns all campaign templates matching the query parameters. + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-templates) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignTemplatesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, created, modified** | + **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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* | + +### Return type + +[**[]CampaignTemplate**](../models/campaign-template) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name` // 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, created, modified** (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, created, modified** (optional) + filters := `name eq "manager template"` // 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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignTemplates(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignTemplates(context.Background()).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplates`: []CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplates`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## move +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Reassign Certifications +This API reassigns the specified certifications from one identity to another. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/move). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/move) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The certification campaign ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiMoveRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **adminReviewReassign** | [**AdminReviewReassign**](../models/admin-review-reassign) | | + +### Return type + +[**CertificationTask**](../models/certification-task) + +### 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The certification campaign ID # string | The certification campaign ID + adminreviewreassign := []byte(`{ + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + }`) // AdminReviewReassign | + + + var adminReviewReassign beta.AdminReviewReassign + if err := json.Unmarshal(adminreviewreassign, &adminReviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.Move(context.Background(), id).AdminReviewReassign(adminReviewReassign).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.Move(context.Background(), id).AdminReviewReassign(adminReviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.Move``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `Move`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.Move`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-campaign-template +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Update a Campaign Template +Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-campaign-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template being modified. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) | + +### Return type + +[**CampaignTemplate**](../models/campaign-template) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template being modified. # string | ID of the campaign template being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/campaign/filter/id, value=ff80818155fe8c080155fe8d925b0316}]`) // []JsonPatchOperation | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.PatchCampaignTemplate(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.PatchCampaignTemplate(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.PatchCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.PatchCampaignTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-campaign-reports-config +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Set Campaign Reports Configuration +Use this API to overwrite the configuration for campaign reports. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-campaign-reports-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetCampaignReportsConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaignReportsConfig** | [**CampaignReportsConfig**](../models/campaign-reports-config) | Campaign report configuration. | + +### Return type + +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### 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() { + campaignreportsconfig := []byte(`{ + "identityAttributeColumns" : [ "firstname", "lastname" ] + }`) // CampaignReportsConfig | Campaign report configuration. + + + var campaignReportsConfig beta.CampaignReportsConfig + if err := json.Unmarshal(campaignreportsconfig, &campaignReportsConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.SetCampaignReportsConfig(context.Background()).CampaignReportsConfig(campaignReportsConfig).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.SetCampaignReportsConfig(context.Background()).CampaignReportsConfig(campaignReportsConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.SetCampaignReportsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetCampaignReportsConfig`: CampaignReportsConfig + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.SetCampaignReportsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-campaign-template-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Set Campaign Template Schedule +Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. +Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-campaign-template-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template being scheduled. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetCampaignTemplateScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schedule** | [**Schedule**](../models/schedule) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template being scheduled. # string | ID of the campaign template being scheduled. + schedule := []byte(`{ + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + }`) // Schedule | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.CertificationCampaignsAPI.SetCampaignTemplateSchedule(context.Background(), id).Execute() + //r, err := apiClient.Beta.CertificationCampaignsAPI.SetCampaignTemplateSchedule(context.Background(), id).Schedule(schedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.SetCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## start-campaign +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Activate a Campaign +Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-campaign) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Campaign ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **activateCampaignOptions** | [**ActivateCampaignOptions**](../models/activate-campaign-options) | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Campaign ID. # string | Campaign ID. + activatecampaignoptions := []byte(`{ + "timeZone" : "-05:00" + }`) // ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.StartCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.StartCampaign(context.Background(), id).ActivateCampaignOptions(activateCampaignOptions).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaign`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-campaign-remediation-scan +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Run Campaign Remediation Scan +Use this API to run a remediation scan task for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan). + +A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-campaign-remediation-scan) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign the remediation scan is being run for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartCampaignRemediationScanRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign the remediation scan is being run for. # string | ID of the campaign the remediation scan is being run for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.StartCampaignRemediationScan(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.StartCampaignRemediationScan(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaignRemediationScan``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaignRemediationScan`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaignRemediationScan`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-campaign-report +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Run Campaign Report +Use this API to run a report for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-report). + +A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-campaign-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign the report is being run for. | +**type_** | [**ReportType**](../models/) | Type of report to run. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartCampaignReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign the report is being run for. # string | ID of the campaign the report is being run for. + type_ := // ReportType | Type of report to run. # ReportType | Type of report to run. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.StartCampaignReport(context.Background(), id, type_).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.StartCampaignReport(context.Background(), id, type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaignReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaignReport`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaignReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-generate-campaign-template +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Generate a Campaign from Template +Use this API to generate a new certification campaign from a campaign template. + +The campaign object contained in the template has special formatting applied to its name and description +fields that determine the generated campaign's name/description. Placeholders in those fields are +formatted with the current date and time upon generation. + +Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For +example, "%Y" inserts the current year, and a campaign template named "Campaign for %y" generates a +campaign called "Campaign for 2020" (assuming the year at generation time is 2020). + +Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). + +Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-generate-campaign-template). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-generate-campaign-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template to use for generation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartGenerateCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CampaignReference**](../models/campaign-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template to use for generation. # string | ID of the campaign template to use for generation. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.StartGenerateCampaignTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.StartGenerateCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartGenerateCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartGenerateCampaignTemplate`: CampaignReference + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartGenerateCampaignTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-campaign +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Update a Campaign +Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/update-campaign). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-campaign) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign being modified. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **requestBody** | **[]map[string]interface{}** | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline | + +### Return type + +[**Slimcampaign**](../models/slimcampaign) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign being modified. # string | ID of the campaign being modified. + requestbody := []byte(`[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]`) // []map[string]interface{} | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + + + var requestBody beta.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.UpdateCampaign(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.UpdateCampaign(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.UpdateCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCampaign`: Slimcampaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.UpdateCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/CertificationsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/CertificationsAPI.md new file mode 100644 index 000000000..6fb5c2e02 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/CertificationsAPI.md @@ -0,0 +1,493 @@ +--- +id: beta-certifications +title: Certifications +pagination_label: Certifications +sidebar_label: Certifications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Certifications', 'BetaCertifications'] +slug: /tools/sdk/go/beta/methods/certifications +tags: ['SDK', 'Software Development Kit', 'Certifications', 'BetaCertifications'] +--- + +# CertificationsAPI + Use this API to implement certification functionality. +This API provides specific functionality that improves an organization's ability to manage its certification process. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +This API enables administrators and reviewers to get useful information about certifications at a high level, such as the reviewers involved, and at a more granular level, such as the permissions affected by changes to entitlements within those certifications. +It also provides the useful ability to reassign identities and items within certifications to other reviewers, rather than [reassigning the entire certifications themselves](https://developer.sailpoint.com/idn/api/beta/submit-reassign-certs-async/). + +Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **Get** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item +[**get-identity-certification-pending-tasks**](#get-identity-certification-pending-tasks) | **Get** `/certifications/{id}/tasks-pending` | Pending Certification Tasks +[**get-identity-certification-task-status**](#get-identity-certification-task-status) | **Get** `/certifications/{id}/tasks/{taskId}` | Certification Task Status +[**list-certification-reviewers**](#list-certification-reviewers) | **Get** `/certifications/{id}/reviewers` | List of Reviewers for certification +[**list-certifications**](#list-certifications) | **Get** `/certifications` | Certifications by IDs +[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **Post** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously + + +## get-identity-certification-item-permissions +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Permissions for Entitlement Certification Item +This API returns the permissions associated with an entitlement certification item based on the certification item's ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-item-permissions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**certificationId** | **string** | The certification ID | +**itemId** | **string** | The certification item ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityCertificationItemPermissionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **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: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]PermissionDto**](../models/permission-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + certificationId := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification ID + itemId := `2c91808671bcbab40171bd945d961227` // string | The certification item ID # string | The certification item ID + filters := `target eq "SYS.OBJAUTH2"` // 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: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (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: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationsAPI.GetIdentityCertificationItemPermissions(context.Background(), certificationId, itemId).Execute() + //resp, r, err := apiClient.Beta.CertificationsAPI.GetIdentityCertificationItemPermissions(context.Background(), certificationId, itemId).Filters(filters).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertificationItemPermissions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertificationItemPermissions`: []PermissionDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertificationItemPermissions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-certification-pending-tasks +Pending Certification Tasks +This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-pending-tasks) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityCertificationPendingTasksRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]IdentityCertificationTask**](../models/identity-certification-task) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `id_example` // string | The identity campaign certification ID # string | The identity campaign certification ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationsAPI.GetIdentityCertificationPendingTasks(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationsAPI.GetIdentityCertificationPendingTasks(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertificationPendingTasks``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertificationPendingTasks`: []IdentityCertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertificationPendingTasks`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-certification-task-status +Certification Task Status +This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-task-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | +**taskId** | **string** | The certification task ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityCertificationTaskStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**IdentityCertificationTask**](../models/identity-certification-task) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `id_example` // string | The identity campaign certification ID # string | The identity campaign certification ID + taskId := `taskId_example` // string | The certification task ID # string | The certification task ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationsAPI.GetIdentityCertificationTaskStatus(context.Background(), id, taskId).Execute() + //resp, r, err := apiClient.Beta.CertificationsAPI.GetIdentityCertificationTaskStatus(context.Background(), id, taskId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertificationTaskStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertificationTaskStatus`: IdentityCertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertificationTaskStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-certification-reviewers +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +List of Reviewers for certification +This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-certification-reviewers) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCertificationReviewersRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **email**: *eq, sw* | + **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, email** | + +### Return type + +[**[]IdentityReferenceWithNameAndEmail**](../models/identity-reference-with-name-and-email) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Bob"` // 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* **email**: *eq, sw* (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* **email**: *eq, sw* (optional) + sorters := `name` // 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, email** (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, email** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationsAPI.ListCertificationReviewers(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationsAPI.ListCertificationReviewers(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListCertificationReviewers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCertificationReviewers`: []IdentityReferenceWithNameAndEmail + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListCertificationReviewers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-certifications +Certifications by IDs +This API returns a list of certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-certifications) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCertificationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **reviewerIdentitiy** | **string** | The ID of reviewer identity. *me* indicates the current user. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* | + **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, due, signed** | + +### Return type + +[**[]CertificationDto**](../models/certification-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reviewerIdentitiy := `reviewerIdentitiy_example` // string | The ID of reviewer identity. *me* indicates the current user. (optional) # string | The ID of reviewer identity. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `filters_example` // 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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (optional) + sorters := `sorters_example` // 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, due, signed** (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, due, signed** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationsAPI.ListCertifications(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CertificationsAPI.ListCertifications(context.Background()).ReviewerIdentitiy(reviewerIdentitiy).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListCertifications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCertifications`: []CertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListCertifications`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-reassign-certs-async +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Reassign Certifications Asynchronously +This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-reassign-certs-async) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitReassignCertsAsyncRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **reviewReassign** | [**ReviewReassign**](../models/review-reassign) | | + +### Return type + +[**IdentityCertificationTask**](../models/identity-certification-task) + +### 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + reviewreassign := []byte(`{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + }`) // ReviewReassign | + + + var reviewReassign beta.ReviewReassign + if err := json.Unmarshal(reviewreassign, &reviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationsAPI.SubmitReassignCertsAsync(context.Background(), id).ReviewReassign(reviewReassign).Execute() + //resp, r, err := apiClient.Beta.CertificationsAPI.SubmitReassignCertsAsync(context.Background(), id).ReviewReassign(reviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.SubmitReassignCertsAsync``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitReassignCertsAsync`: IdentityCertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.SubmitReassignCertsAsync`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/ConnectorRuleManagementAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/ConnectorRuleManagementAPI.md new file mode 100644 index 000000000..849a770de --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/ConnectorRuleManagementAPI.md @@ -0,0 +1,482 @@ +--- +id: beta-connector-rule-management +title: ConnectorRuleManagement +pagination_label: ConnectorRuleManagement +sidebar_label: ConnectorRuleManagement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleManagement', 'BetaConnectorRuleManagement'] +slug: /tools/sdk/go/beta/methods/connector-rule-management +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleManagement', 'BetaConnectorRuleManagement'] +--- + +# ConnectorRuleManagementAPI + Use this API to implement connector rule management functionality. +With this functionality in place, administrators can implement connector-executed rules in a programmatic, scalable way. + +In Identity Security Cloud (ISC), [rules](https://developer.sailpoint.com/docs/extensibility/rules) serve as a flexible configuration framework you can leverage to perform complex or advanced configurations. +[Connector-executed rules](https://developer.sailpoint.com/docs/extensibility/rules/connector-rules) are rules that are executed in the ISC virtual appliance (VA), usually extensions of the [connector](https://documentation.sailpoint.com/connectors/isc/landingpages/help/landingpages/isc_landing.html) itself, the bridge between the data source and ISC. +This API allows administrators to view existing connector-executed rules, make changes to them, delete them, and create new ones from the available types. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-connector-rule**](#create-connector-rule) | **Post** `/connector-rules` | Create Connector Rule +[**delete-connector-rule**](#delete-connector-rule) | **Delete** `/connector-rules/{id}` | Delete a Connector-Rule +[**get-connector-rule**](#get-connector-rule) | **Get** `/connector-rules/{id}` | Connector-Rule by ID +[**get-connector-rule-list**](#get-connector-rule-list) | **Get** `/connector-rules` | List Connector Rules +[**update-connector-rule**](#update-connector-rule) | **Put** `/connector-rules/{id}` | Update a Connector Rule +[**validate-connector-rule**](#validate-connector-rule) | **Post** `/connector-rules/validate` | Validate Connector Rule + + +## create-connector-rule +Create Connector Rule +Creates a new connector rule. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-connector-rule) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateConnectorRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **connectorRuleCreateRequest** | [**ConnectorRuleCreateRequest**](../models/connector-rule-create-request) | The connector rule to create | + +### Return type + +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### 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() { + connectorrulecreaterequest := []byte(`{ + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "type" : "BuildMap" + }`) // ConnectorRuleCreateRequest | The connector rule to create + + + var connectorRuleCreateRequest beta.ConnectorRuleCreateRequest + if err := json.Unmarshal(connectorrulecreaterequest, &connectorRuleCreateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.CreateConnectorRule(context.Background()).ConnectorRuleCreateRequest(connectorRuleCreateRequest).Execute() + //resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.CreateConnectorRule(context.Background()).ConnectorRuleCreateRequest(connectorRuleCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.CreateConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.CreateConnectorRule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-connector-rule +Delete a Connector-Rule +Deletes the connector rule specified by the given ID. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-connector-rule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the connector rule to delete | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteConnectorRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to delete # string | ID of the connector rule to delete + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.ConnectorRuleManagementAPI.DeleteConnectorRule(context.Background(), id).Execute() + //r, err := apiClient.Beta.ConnectorRuleManagementAPI.DeleteConnectorRule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.DeleteConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-connector-rule +Connector-Rule by ID +Returns the connector rule specified by ID. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-connector-rule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the connector rule to retrieve | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to retrieve # string | ID of the connector rule to retrieve + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.GetConnectorRule(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.GetConnectorRule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.GetConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.GetConnectorRule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-rule-list +List Connector Rules +Returns the list of connector rules. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-connector-rule-list) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorRuleListRequest struct via the builder pattern + + +### Return type + +[**[]ConnectorRuleResponse**](../models/connector-rule-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.GetConnectorRuleList(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.GetConnectorRuleList(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.GetConnectorRuleList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorRuleList`: []ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.GetConnectorRuleList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-connector-rule +Update a Connector Rule +Updates an existing connector rule with the one provided in the request body. Note that the fields 'id', 'name', and 'type' are immutable. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-connector-rule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the connector rule to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateConnectorRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **connectorRuleUpdateRequest** | [**ConnectorRuleUpdateRequest**](../models/connector-rule-update-request) | The connector rule with updated data | + +### Return type + +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to update # string | ID of the connector rule to update + connectorruleupdaterequest := []byte(`{ + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", + "type" : "BuildMap" + }`) // ConnectorRuleUpdateRequest | The connector rule with updated data (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.UpdateConnectorRule(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.UpdateConnectorRule(context.Background(), id).ConnectorRuleUpdateRequest(connectorRuleUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.UpdateConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.UpdateConnectorRule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## validate-connector-rule +Validate Connector Rule +Returns a list of issues within the code to fix, if any. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/validate-connector-rule) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiValidateConnectorRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sourceCode** | [**SourceCode**](../models/source-code) | The code to validate | + +### Return type + +[**ConnectorRuleValidationResponse**](../models/connector-rule-validation-response) + +### 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() { + sourcecode := []byte(`{ + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }`) // SourceCode | The code to validate + + + var sourceCode beta.SourceCode + if err := json.Unmarshal(sourcecode, &sourceCode); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.ValidateConnectorRule(context.Background()).SourceCode(sourceCode).Execute() + //resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.ValidateConnectorRule(context.Background()).SourceCode(sourceCode).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.ValidateConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ValidateConnectorRule`: ConnectorRuleValidationResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.ValidateConnectorRule`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/ConnectorsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/ConnectorsAPI.md new file mode 100644 index 000000000..c11d604af --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/ConnectorsAPI.md @@ -0,0 +1,104 @@ +--- +id: beta-connectors +title: Connectors +pagination_label: Connectors +sidebar_label: Connectors +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Connectors', 'BetaConnectors'] +slug: /tools/sdk/go/beta/methods/connectors +tags: ['SDK', 'Software Development Kit', 'Connectors', 'BetaConnectors'] +--- + +# ConnectorsAPI + Use this API to implement connector functionality. +With this functionality in place, administrators can view available connectors. + +Connectors are the bridges Identity Security Cloud uses to communicate with and aggregate data from sources. +For example, if it is necessary to set up a connection between Identity Security Cloud and the Active Directory source, a connector can bridge the two and enable Identity Security Cloud to synchronize data between the systems. +This ensures account entitlements and states are correct throughout the organization. + +In Identity Security Cloud, administrators can use the Connections drop-down menu and select Sources to view the available source connectors. + +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in Identity Security Cloud. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources. + +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about using connectors in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-connector-list**](#get-connector-list) | **Get** `/connectors` | Get Connector List + + +## get-connector-list +Get Connector List +Fetches list of connectors that have 'RELEASED' status using filtering and pagination. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-connector-list) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **locale** | **string** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | + +### Return type + +[**[]V3ConnectorDto**](../models/v3-connector-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `directConnect eq "true"` // 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: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* (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: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ConnectorsAPI.GetConnectorList(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ConnectorsAPI.GetConnectorList(context.Background()).Filters(filters).Limit(limit).Offset(offset).Count(count).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorList`: []V3ConnectorDto + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorList`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/CustomFormsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/CustomFormsAPI.md new file mode 100644 index 000000000..c5b7ef858 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/CustomFormsAPI.md @@ -0,0 +1,1554 @@ +--- +id: beta-custom-forms +title: CustomForms +pagination_label: CustomForms +sidebar_label: CustomForms +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CustomForms', 'BetaCustomForms'] +slug: /tools/sdk/go/beta/methods/custom-forms +tags: ['SDK', 'Software Development Kit', 'CustomForms', 'BetaCustomForms'] +--- + +# CustomFormsAPI + Use this API to build and manage custom forms. +With this functionality in place, administrators can create and view form definitions and form instances. + +Forms are composed of sections and fields. Sections split the form into logical groups of fields and fields are the data collection points within the form. Configure conditions to modify elements of the form as the responder provides input. Create form inputs to pass information from a calling feature, like a workflow, to your form. + +Forms can be used within workflows as an action or as a trigger. The Form Action allows you to assign a form as a step in a running workflow, suspending the workflow until the form is submitted or times out, and the workflow resumes. The Form Submitted Trigger initiates a workflow when a form is submitted. The trigger can be configured to initiate on submission of a full form, a form element with any value, or a form element with a particular value. + +Refer to [Forms](https://documentation.sailpoint.com/saas/help/forms/index.html) for more information about using forms in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-form-definition**](#create-form-definition) | **Post** `/form-definitions` | Creates a form definition. +[**create-form-definition-by-template**](#create-form-definition-by-template) | **Post** `/form-definitions/template` | Create a form definition by template. +[**create-form-definition-dynamic-schema**](#create-form-definition-dynamic-schema) | **Post** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically. +[**create-form-definition-file-request**](#create-form-definition-file-request) | **Post** `/form-definitions/{formDefinitionID}/upload` | Upload new form definition file. +[**create-form-instance**](#create-form-instance) | **Post** `/form-instances` | Creates a form instance. +[**delete-form-definition**](#delete-form-definition) | **Delete** `/form-definitions/{formDefinitionID}` | Deletes a form definition. +[**export-form-definitions-by-tenant**](#export-form-definitions-by-tenant) | **Get** `/form-definitions/export` | List form definitions by tenant. +[**get-file-from-s3**](#get-file-from-s3) | **Get** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileId. +[**get-form-definition-by-key**](#get-form-definition-by-key) | **Get** `/form-definitions/{formDefinitionID}` | Return a form definition. +[**get-form-instance-by-key**](#get-form-instance-by-key) | **Get** `/form-instances/{formInstanceID}` | Returns a form instance. +[**get-form-instance-file**](#get-form-instance-file) | **Get** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileId. +[**import-form-definitions**](#import-form-definitions) | **Post** `/form-definitions/import` | Import form definitions from export. +[**patch-form-definition**](#patch-form-definition) | **Patch** `/form-definitions/{formDefinitionID}` | Patch a form definition. +[**patch-form-instance**](#patch-form-instance) | **Patch** `/form-instances/{formInstanceID}` | Patch a form instance. +[**search-form-definitions-by-tenant**](#search-form-definitions-by-tenant) | **Get** `/form-definitions` | Export form definitions by tenant. +[**search-form-element-data-by-element-id**](#search-form-element-data-by-element-id) | **Get** `/form-instances/{formInstanceID}/data-source/{formElementID}` | Retrieves dynamic data by element. +[**search-form-instances-by-tenant**](#search-form-instances-by-tenant) | **Get** `/form-instances` | List form instances by tenant. +[**search-pre-defined-select-options**](#search-pre-defined-select-options) | **Get** `/form-definitions/predefined-select-options` | List predefined select options. +[**show-preview-data-source**](#show-preview-data-source) | **Post** `/form-definitions/{formDefinitionID}/data-source` | Preview form definition data source. + + +## create-form-definition +Creates a form definition. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateFormDefinitionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createFormDefinitionRequest** | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | Body is the request payload to create form definition request | + +### Return type + +[**FormDefinitionResponse**](../models/form-definition-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createformdefinitionrequest := []byte(`{ + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + }`) // CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormDefinition(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormDefinition(context.Background()).CreateFormDefinitionRequest(createFormDefinitionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinition`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinition`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-form-definition-by-template +Create a form definition by template. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition-by-template) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateFormDefinitionByTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createFormDefinitionRequest** | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | Body is the request payload to create form definition request | + +### Return type + +[**FormDefinitionResponse**](../models/form-definition-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createformdefinitionrequest := []byte(`{ + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + }`) // CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormDefinitionByTemplate(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormDefinitionByTemplate(context.Background()).CreateFormDefinitionRequest(createFormDefinitionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinitionByTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinitionByTemplate`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinitionByTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-form-definition-dynamic-schema +Generate JSON Schema dynamically. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition-dynamic-schema) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateFormDefinitionDynamicSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**FormDefinitionDynamicSchemaRequest**](../models/form-definition-dynamic-schema-request) | Body is the request payload to create a form definition dynamic schema | + +### Return type + +[**FormDefinitionDynamicSchemaResponse**](../models/form-definition-dynamic-schema-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + body := []byte(`{ + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 + }`) // FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormDefinitionDynamicSchema(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormDefinitionDynamicSchema(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinitionDynamicSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinitionDynamicSchema`: FormDefinitionDynamicSchemaResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinitionDynamicSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-form-definition-file-request +Upload new form definition file. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition-file-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | FormDefinitionID String specifying FormDefinitionID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateFormDefinitionFileRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | File specifying the multipart | + +### Return type + +[**FormDefinitionFileUploadResponse**](../models/form-definition-file-upload-response) + +### 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() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | FormDefinitionID String specifying FormDefinitionID # string | FormDefinitionID String specifying FormDefinitionID + file := BINARY_DATA_HERE // *os.File | File specifying the multipart # *os.File | File specifying the multipart + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormDefinitionFileRequest(context.Background(), formDefinitionID).File(file).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormDefinitionFileRequest(context.Background(), formDefinitionID).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinitionFileRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinitionFileRequest`: FormDefinitionFileUploadResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinitionFileRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-form-instance +Creates a form instance. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-instance) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateFormInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateFormInstanceRequest**](../models/create-form-instance-request) | Body is the request payload to create a form instance | + +### Return type + +[**FormInstanceResponse**](../models/form-instance-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + body := []byte(`{ + "formInput" : { + "input1" : "Sales" + }, + "standAloneForm" : false, + "createdBy" : { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "WORKFLOW_EXECUTION" + }, + "recipients" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + } ], + "expire" : "2023-08-12T20:14:57.74486Z", + "formDefinitionId" : "00000000-0000-0000-0000-000000000000", + "state" : "ASSIGNED", + "ttl" : 1571827560 + }`) // CreateFormInstanceRequest | Body is the request payload to create a form instance (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormInstance(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormInstance(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormInstance`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormInstance`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-form-definition +Deletes a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-form-definition) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | Form definition ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteFormDefinitionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.DeleteFormDefinition(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.DeleteFormDefinition(context.Background(), formDefinitionID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.DeleteFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteFormDefinition`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.DeleteFormDefinition`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## export-form-definitions-by-tenant +List form definitions by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-form-definitions-by-tenant) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportFormDefinitionsByTenantRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int64** | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. | [default to 0] + **limit** | **int64** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [default to 250] + **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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* | + **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, description, created, modified** | [default to "name"] + +### Return type + +[**[]ExportFormDefinitionsByTenant200ResponseInner**](../models/export-form-definitions-by-tenant200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + offset := 0 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `name sw "my form"` // 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + sorters := `name` // 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, description, created, modified** (optional) (default to "name") # 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, description, created, modified** (optional) (default to "name") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.ExportFormDefinitionsByTenant(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.ExportFormDefinitionsByTenant(context.Background()).Offset(offset).Limit(limit).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ExportFormDefinitionsByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportFormDefinitionsByTenant`: []ExportFormDefinitionsByTenant200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ExportFormDefinitionsByTenant`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-file-from-s3 +Download definition file by fileId. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-file-from-s3) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | FormDefinitionID Form definition ID | +**fileID** | **string** | FileID String specifying the hashed name of the uploaded file we are retrieving. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetFileFromS3Request struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, image/jpeg, image/png, application/octet-stream + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | FormDefinitionID Form definition ID # string | FormDefinitionID Form definition ID + fileID := `00000031N0J7R2B57M8YG73J7M.png` // string | FileID String specifying the hashed name of the uploaded file we are retrieving. # string | FileID String specifying the hashed name of the uploaded file we are retrieving. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.GetFileFromS3(context.Background(), formDefinitionID, fileID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.GetFileFromS3(context.Background(), formDefinitionID, fileID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFileFromS3``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFileFromS3`: *os.File + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFileFromS3`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-form-definition-by-key +Return a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-form-definition-by-key) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | Form definition ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetFormDefinitionByKeyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**FormDefinitionResponse**](../models/form-definition-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.GetFormDefinitionByKey(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.GetFormDefinitionByKey(context.Background(), formDefinitionID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormDefinitionByKey``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormDefinitionByKey`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormDefinitionByKey`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-form-instance-by-key +Returns a form instance. +Parameter `{formInstanceID}` should match a form instance ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-form-instance-by-key) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formInstanceID** | **string** | Form instance ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetFormInstanceByKeyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**FormInstanceResponse**](../models/form-instance-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.GetFormInstanceByKey(context.Background(), formInstanceID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.GetFormInstanceByKey(context.Background(), formInstanceID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormInstanceByKey``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormInstanceByKey`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormInstanceByKey`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-form-instance-file +Download instance file by fileId. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-form-instance-file) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formInstanceID** | **string** | FormInstanceID Form instance ID | +**fileID** | **string** | FileID String specifying the hashed name of the uploaded file we are retrieving. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetFormInstanceFileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, image/jpeg, image/png, application/octet-stream + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | FormInstanceID Form instance ID # string | FormInstanceID Form instance ID + fileID := `00000031N0J7R2B57M8YG73J7M.png` // string | FileID String specifying the hashed name of the uploaded file we are retrieving. # string | FileID String specifying the hashed name of the uploaded file we are retrieving. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.GetFormInstanceFile(context.Background(), formInstanceID, fileID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.GetFormInstanceFile(context.Background(), formInstanceID, fileID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormInstanceFile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormInstanceFile`: *os.File + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormInstanceFile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-form-definitions +Import form definitions from export. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-form-definitions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportFormDefinitionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**[]ImportFormDefinitionsRequestInner**](../models/import-form-definitions-request-inner) | Body is the request payload to import form definitions | + +### Return type + +[**ImportFormDefinitions202Response**](../models/import-form-definitions202-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + body := []byte(`[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]`) // []ImportFormDefinitionsRequestInner | Body is the request payload to import form definitions (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.ImportFormDefinitions(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.ImportFormDefinitions(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ImportFormDefinitions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportFormDefinitions`: ImportFormDefinitions202Response + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ImportFormDefinitions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-form-definition +Patch a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-form-definition) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | Form definition ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchFormDefinitionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | **[]map[string]map[string]interface{}** | Body is the request payload to patch a form definition, check: https://jsonpatch.com | + +### Return type + +[**FormDefinitionResponse**](../models/form-definition-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + body := []byte(`[{op=replace, path=/description, value=test-description}]`) // []map[string]map[string]interface{} | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.PatchFormDefinition(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.PatchFormDefinition(context.Background(), formDefinitionID).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.PatchFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchFormDefinition`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.PatchFormDefinition`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-form-instance +Patch a form instance. +Parameter `{formInstanceID}` should match a form instance ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-form-instance) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formInstanceID** | **string** | Form instance ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchFormInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | **[]map[string]map[string]interface{}** | Body is the request payload to patch a form instance, check: https://jsonpatch.com | + +### Return type + +[**FormInstanceResponse**](../models/form-instance-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + body := []byte(`[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]`) // []map[string]map[string]interface{} | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.PatchFormInstance(context.Background(), formInstanceID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.PatchFormInstance(context.Background(), formInstanceID).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.PatchFormInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchFormInstance`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.PatchFormInstance`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-form-definitions-by-tenant +Export form definitions by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/search-form-definitions-by-tenant) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchFormDefinitionsByTenantRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int64** | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. | [default to 0] + **limit** | **int64** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [default to 250] + **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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* | + **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, description, created, modified** | [default to "name"] + +### Return type + +[**ListFormDefinitionsByTenantResponse**](../models/list-form-definitions-by-tenant-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + offset := 250 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `name sw "my form"` // 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + sorters := `name` // 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, description, created, modified** (optional) (default to "name") # 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, description, created, modified** (optional) (default to "name") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.SearchFormDefinitionsByTenant(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.SearchFormDefinitionsByTenant(context.Background()).Offset(offset).Limit(limit).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormDefinitionsByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormDefinitionsByTenant`: ListFormDefinitionsByTenantResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormDefinitionsByTenant`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-form-element-data-by-element-id +Retrieves dynamic data by element. +Parameter `{formInstanceID}` should match a form instance ID. +Parameter `{formElementID}` should match a form element ID at the data source configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/search-form-element-data-by-element-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formInstanceID** | **string** | Form instance ID | +**formElementID** | **string** | Form element ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchFormElementDataByElementIDRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **limit** | **int64** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [default to 250] + **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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` | + **query** | **string** | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. | + +### Return type + +[**ListFormElementDataByElementIDResponse**](../models/list-form-element-data-by-element-id-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + formElementID := `1` // string | Form element ID # string | Form element ID + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `value eq "ID01"` // 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) + query := `support` // string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.SearchFormElementDataByElementID(context.Background(), formInstanceID, formElementID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.SearchFormElementDataByElementID(context.Background(), formInstanceID, formElementID).Limit(limit).Filters(filters).Query(query).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormElementDataByElementID``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormElementDataByElementID`: ListFormElementDataByElementIDResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormElementDataByElementID`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-form-instances-by-tenant +List form instances by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/search-form-instances-by-tenant) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchFormInstancesByTenantRequest struct via the builder pattern + + +### Return type + +[**[]FormInstanceResponse**](../models/form-instance-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.SearchFormInstancesByTenant(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.SearchFormInstancesByTenant(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormInstancesByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormInstancesByTenant`: []FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormInstancesByTenant`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-pre-defined-select-options +List predefined select options. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/search-pre-defined-select-options) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchPreDefinedSelectOptionsRequest struct via the builder pattern + + +### Return type + +[**ListPredefinedSelectOptionsResponse**](../models/list-predefined-select-options-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.SearchPreDefinedSelectOptions(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.SearchPreDefinedSelectOptions(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchPreDefinedSelectOptions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchPreDefinedSelectOptions`: ListPredefinedSelectOptionsResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchPreDefinedSelectOptions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## show-preview-data-source +Preview form definition data source. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/show-preview-data-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | Form definition ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiShowPreviewDataSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int64** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [default to 10] + **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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` | + **query** | **string** | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. | + **formElementPreviewRequest** | [**FormElementPreviewRequest**](../models/form-element-preview-request) | Body is the request payload to create a form definition dynamic schema | + +### Return type + +[**PreviewDataSourceResponse**](../models/preview-data-source-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + limit := 10 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) + filters := `value eq "ID01"` // 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) + query := `ac` // string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) + formelementpreviewrequest := []byte(`{ + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } + }`) // FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.ShowPreviewDataSource(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.ShowPreviewDataSource(context.Background(), formDefinitionID).Limit(limit).Filters(filters).Query(query).FormElementPreviewRequest(formElementPreviewRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ShowPreviewDataSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ShowPreviewDataSource`: PreviewDataSourceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ShowPreviewDataSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/CustomPasswordInstructionsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/CustomPasswordInstructionsAPI.md new file mode 100644 index 000000000..0d78cf6d4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/CustomPasswordInstructionsAPI.md @@ -0,0 +1,239 @@ +--- +id: beta-custom-password-instructions +title: CustomPasswordInstructions +pagination_label: CustomPasswordInstructions +sidebar_label: CustomPasswordInstructions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CustomPasswordInstructions', 'BetaCustomPasswordInstructions'] +slug: /tools/sdk/go/beta/methods/custom-password-instructions +tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstructions', 'BetaCustomPasswordInstructions'] +--- + +# CustomPasswordInstructionsAPI + Use this API to implement custom password instruction functionality. +With this functionality in place, administrators can create custom password instructions to help users reset their passwords, change them, unlock their accounts, or recover their usernames. +This allows administrators to emphasize password policies or provide organization-specific instructions. + +Administrators must first use [Update Password Org Config](https://developer.sailpoint.com/docs/api/beta/put-password-org-config/) to set `customInstructionsEnabled` to `true`. + +Once they have enabled custom instructions, they can use [Create Custom Password Instructions](https://developer.sailpoint.com/docs/api/beta/create-custom-password-instructions/) to create custom page content for the specific pageId they select. + +For example, an administrator can use the pageId forget-username:user-email to set the custom text for the case when users forget their usernames and must enter their emails. + +Refer to [Creating Custom Instruction Text](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html#creating-custom-instruction-text) for more information about creating custom password instructions. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-custom-password-instructions**](#create-custom-password-instructions) | **Post** `/custom-password-instructions` | Create Custom Password Instructions +[**delete-custom-password-instructions**](#delete-custom-password-instructions) | **Delete** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID +[**get-custom-password-instructions**](#get-custom-password-instructions) | **Get** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID + + +## create-custom-password-instructions +Create Custom Password Instructions +This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-custom-password-instructions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCustomPasswordInstructionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **customPasswordInstruction** | [**CustomPasswordInstruction**](../models/custom-password-instruction) | | + +### Return type + +[**CustomPasswordInstruction**](../models/custom-password-instruction) + +### 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() { + custompasswordinstruction := []byte(`{ + "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", + "pageId" : "change-password:enter-password", + "locale" : "en" + }`) // CustomPasswordInstruction | + + + var customPasswordInstruction beta.CustomPasswordInstruction + if err := json.Unmarshal(custompasswordinstruction, &customPasswordInstruction); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions(context.Background()).CustomPasswordInstruction(customPasswordInstruction).Execute() + //resp, r, err := apiClient.Beta.CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions(context.Background()).CustomPasswordInstruction(customPasswordInstruction).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCustomPasswordInstructions`: CustomPasswordInstruction + fmt.Fprintf(os.Stdout, "Response from `CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-custom-password-instructions +Delete Custom Password Instructions by page ID +This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-custom-password-instructions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**pageId** | **string** | The page ID of custom password instructions to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCustomPasswordInstructionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **locale** | **string** | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + pageId := `mfa:select` // string | The page ID of custom password instructions to delete. # string | The page ID of custom password instructions to delete. + locale := `locale_example` // string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions(context.Background(), pageId).Execute() + //r, err := apiClient.Beta.CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions(context.Background(), pageId).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-custom-password-instructions +Get Custom Password Instructions by Page ID +This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-custom-password-instructions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**pageId** | **string** | The page ID of custom password instructions to query. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCustomPasswordInstructionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **locale** | **string** | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". | + +### Return type + +[**CustomPasswordInstruction**](../models/custom-password-instruction) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + pageId := `mfa:select` // string | The page ID of custom password instructions to query. # string | The page ID of custom password instructions to query. + locale := `locale_example` // string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomPasswordInstructionsAPI.GetCustomPasswordInstructions(context.Background(), pageId).Execute() + //resp, r, err := apiClient.Beta.CustomPasswordInstructionsAPI.GetCustomPasswordInstructions(context.Background(), pageId).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.GetCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCustomPasswordInstructions`: CustomPasswordInstruction + fmt.Fprintf(os.Stdout, "Response from `CustomPasswordInstructionsAPI.GetCustomPasswordInstructions`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/EntitlementsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/EntitlementsAPI.md new file mode 100644 index 000000000..b3489dd77 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/EntitlementsAPI.md @@ -0,0 +1,980 @@ +--- +id: beta-entitlements +title: Entitlements +pagination_label: Entitlements +sidebar_label: Entitlements +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Entitlements', 'BetaEntitlements'] +slug: /tools/sdk/go/beta/methods/entitlements +tags: ['SDK', 'Software Development Kit', 'Entitlements', 'BetaEntitlements'] +--- + +# EntitlementsAPI + Use this API to implement and customize entitlement functionality. +With this functionality in place, administrators can view entitlements and configure them for use throughout Identity Security Cloud in certifications, access profiles, and roles. +Administrators in Identity Security Cloud can then grant users access to the entitlements or configure them so users themselves can request access to the entitlements whenever they need them. +With a good approval process, this entitlement functionality allows users to gain the specific access they need on sources quickly and securely. + +Entitlements represent access rights on sources. +Entitlements are the most granular form of access in Identity Security Cloud. +Entitlements are often grouped into access profiles, and access profiles themselves are often grouped into roles, the broadest form of access in Identity Security Cloud. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Administrators often use roles and access profiles within those roles to manage access so that users can gain access more quickly, but the hierarchy of access all starts with entitlements. + +Anywhere entitlements appear, you can select them to find more information about the following: + +- Cloud Access Details: These provide details about the cloud access entitlements on cloud-enabled sources. + +- Permissions: Permissions represent individual units of read/write/admin access to a system. + +- Relationships: These list each entitlement's parent and child relationships. + +- Type: This is the entitlement's type. Some sources support multiple types, each with a different attribute schema. + +Identity Security Cloud uses entitlements in many features, including the following: + +- Certifications: Entitlements can be revoked from an identity that no longer needs them. + +- Roles: Roles can group access profiles which themselves group entitlements. You can grant and revoke access on a broad level with roles. Role membership criteria can grant roles to identities based on whether they have certain entitlements or attributes. + +- Access Profiles: Access profiles group entitlements. +They are the most important units of access in Identity Security Cloud. +Identity Security Cloud uses them in provisioning, certifications, and access requests, and administrators can configure them to grant very broad or very granular access. + +You cannot delete entitlements directly from Identity Security Cloud. +Entitlements are deleted based on their inclusion in aggregations. + +Refer to [Deleting Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html#deleting-entitlements) more information about deleting entitlements. + +Refer to [Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html) for more information about entitlements. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-access-model-metadata-for-entitlement**](#create-access-model-metadata-for-entitlement) | **Post** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add metadata to an entitlement. +[**delete-access-model-metadata-from-entitlement**](#delete-access-model-metadata-from-entitlement) | **Delete** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove metadata from an entitlement. +[**get-entitlement**](#get-entitlement) | **Get** `/entitlements/{id}` | Get an entitlement +[**get-entitlement-request-config**](#get-entitlement-request-config) | **Get** `/entitlements/{id}/entitlement-request-config` | Get Entitlement Request Config +[**import-entitlements-by-source**](#import-entitlements-by-source) | **Post** `/entitlements/aggregate/sources/{id}` | Aggregate Entitlements +[**list-entitlement-children**](#list-entitlement-children) | **Get** `/entitlements/{id}/children` | List of entitlements children +[**list-entitlement-parents**](#list-entitlement-parents) | **Get** `/entitlements/{id}/parents` | List of entitlements parents +[**list-entitlements**](#list-entitlements) | **Get** `/entitlements` | Gets a list of entitlements. +[**patch-entitlement**](#patch-entitlement) | **Patch** `/entitlements/{id}` | Patch an entitlement +[**put-entitlement-request-config**](#put-entitlement-request-config) | **Put** `/entitlements/{id}/entitlement-request-config` | Replace Entitlement Request Config +[**reset-source-entitlements**](#reset-source-entitlements) | **Post** `/entitlements/reset/sources/{sourceId}` | Reset Source Entitlements +[**update-entitlements-in-bulk**](#update-entitlements-in-bulk) | **Post** `/entitlements/bulk-update` | Bulk update an entitlement list + + +## create-access-model-metadata-for-entitlement +Add metadata to an entitlement. +Add single Access Model Metadata to an entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-model-metadata-for-entitlement) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The entitlement id. | +**attributeKey** | **string** | Technical name of the Attribute. | +**attributeValue** | **string** | Technical name of the Attribute Value. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAccessModelMetadataForEntitlementRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | The entitlement id. # string | The entitlement id. + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.CreateAccessModelMetadataForEntitlement(context.Background(), id, attributeKey, attributeValue).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.CreateAccessModelMetadataForEntitlement(context.Background(), id, attributeKey, attributeValue).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.CreateAccessModelMetadataForEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessModelMetadataForEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.CreateAccessModelMetadataForEntitlement`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-access-model-metadata-from-entitlement +Remove metadata from an entitlement. +Remove single Access Model Metadata from an entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-access-model-metadata-from-entitlement) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The entitlement id. | +**attributeKey** | **string** | Technical name of the Attribute. | +**attributeValue** | **string** | Technical name of the Attribute Value. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccessModelMetadataFromEntitlementRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | The entitlement id. # string | The entitlement id. + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement(context.Background(), id, attributeKey, attributeValue).Execute() + //r, err := apiClient.Beta.EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement(context.Background(), id, attributeKey, attributeValue).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-entitlement +Get an entitlement +This API returns an entitlement by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The entitlement ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808874ff91550175097daaec161c` // string | The entitlement ID # string | The entitlement ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.GetEntitlement(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.GetEntitlement(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.GetEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.GetEntitlement`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlement-request-config +Get Entitlement Request Config +This API returns the entitlement request config for a specified entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement-request-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Entitlement Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementRequestConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**EntitlementRequestConfig**](../models/entitlement-request-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808874ff91550175097daaec161c` // string | Entitlement Id # string | Entitlement Id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.GetEntitlementRequestConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.GetEntitlementRequestConfig(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.GetEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementRequestConfig`: EntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.GetEntitlementRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-entitlements-by-source +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Aggregate Entitlements +Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). + +If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. + +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`. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-entitlements-by-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportEntitlementsBySourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **csvFile** | ***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() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source Id # string | Source Id + csvFile := 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.Beta.EntitlementsAPI.ImportEntitlementsBySource(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.ImportEntitlementsBySource(context.Background(), id).CsvFile(csvFile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ImportEntitlementsBySource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportEntitlementsBySource`: LoadEntitlementTask + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ImportEntitlementsBySource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-entitlement-children +List of entitlements children +This API returns a list of all child entitlements of a given entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-entitlement-children) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Entitlement Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListEntitlementChildrenRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **id, name, created, modified, type, attribute, value, source.id** | + **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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808874ff91550175097daaec161c` // string | Entitlement Id # string | Entitlement 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id** (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: **id, name, created, modified, type, attribute, value, source.id** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.ListEntitlementChildren(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.ListEntitlementChildren(context.Background(), id).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlementChildren``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlementChildren`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlementChildren`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-entitlement-parents +List of entitlements parents +This API returns a list of all parent entitlements of a given entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-entitlement-parents) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Entitlement Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListEntitlementParentsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **id, name, created, modified, type, attribute, value, source.id** | + **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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | Entitlement Id # string | Entitlement 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id** (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: **id, name, created, modified, type, attribute, value, source.id** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.ListEntitlementParents(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.ListEntitlementParents(context.Background(), id).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlementParents``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlementParents`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlementParents`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-entitlements +Gets a list of entitlements. +This API returns a list of entitlements. + +This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). + +Any authenticated token can call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-entitlements) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListEntitlementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountId** | **string** | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. | + **segmentedForIdentity** | **string** | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. | + **forSegmentIds** | **string** | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). | + **includeUnsegmented** | **bool** | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. | [default to true] + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **id, name, created, modified, type, attribute, value, source.id, requestable** | + **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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accountId := `ef38f94347e94562b5bb8424a56397d8` // string | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional) # string | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional) + segmentedForIdentity := `me` // string | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) # string | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) + forSegmentIds := `041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649` // string | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) # string | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) + includeUnsegmented := true // bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to true) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id, requestable** (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: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.ListEntitlements(context.Background()).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.ListEntitlements(context.Background()).AccountId(accountId).SegmentedForIdentity(segmentedForIdentity).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-entitlement +Patch an entitlement +This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** + +When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. + +A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-entitlement) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the entitlement to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchEntitlementRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the entitlement to patch # string | ID of the entitlement to patch + jsonpatchoperation := []byte(`[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]`) // []JsonPatchOperation | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.PatchEntitlement(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.PatchEntitlement(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.PatchEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.PatchEntitlement`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-entitlement-request-config +Replace Entitlement Request Config +This API replaces the entitlement request config for a specified entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-entitlement-request-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Entitlement ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutEntitlementRequestConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **entitlementRequestConfig** | [**EntitlementRequestConfig**](../models/entitlement-request-config) | | + +### Return type + +[**EntitlementRequestConfig**](../models/entitlement-request-config) + +### 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 := `2c91808a7813090a017814121e121518` // string | Entitlement ID # string | Entitlement ID + entitlementrequestconfig := []byte(`{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }`) // EntitlementRequestConfig | + + + var entitlementRequestConfig beta.EntitlementRequestConfig + if err := json.Unmarshal(entitlementrequestconfig, &entitlementRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.PutEntitlementRequestConfig(context.Background(), id).EntitlementRequestConfig(entitlementRequestConfig).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.PutEntitlementRequestConfig(context.Background(), id).EntitlementRequestConfig(entitlementRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.PutEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutEntitlementRequestConfig`: EntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.PutEntitlementRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reset-source-entitlements +Reset Source Entitlements +Remove all entitlements from a specific source. +To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/reset-source-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | ID of source for the entitlement reset | + +### Other Parameters + +Other parameters are passed through a pointer to a apiResetSourceEntitlementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c91808a7813090a017814121919ecca` // string | ID of source for the entitlement reset # string | ID of source for the entitlement reset + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.ResetSourceEntitlements(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.ResetSourceEntitlements(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ResetSourceEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ResetSourceEntitlements`: EntitlementSourceResetBaseReferenceDto + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ResetSourceEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-entitlements-in-bulk +Bulk update an entitlement list +This API applies an update to every entitlement of the list. + + +The number of entitlements to update is limited to 50 items maximum. + + +The JsonPatch update follows the [JSON +Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations : +`**{ "op": "replace", "path": "/privileged", "value": boolean }** **{ "op": +"replace", "path": "/requestable","value": boolean }**` + + +A token with ORG_ADMIN or API authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-entitlements-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateEntitlementsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entitlementBulkUpdateRequest** | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | | + +### Return type + + (empty response body) + +### 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() { + entitlementbulkupdaterequest := []byte(`{ + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] + }`) // EntitlementBulkUpdateRequest | + + + var entitlementBulkUpdateRequest beta.EntitlementBulkUpdateRequest + if err := json.Unmarshal(entitlementbulkupdaterequest, &entitlementBulkUpdateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.EntitlementsAPI.UpdateEntitlementsInBulk(context.Background()).EntitlementBulkUpdateRequest(entitlementBulkUpdateRequest).Execute() + //r, err := apiClient.Beta.EntitlementsAPI.UpdateEntitlementsInBulk(context.Background()).EntitlementBulkUpdateRequest(entitlementBulkUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.UpdateEntitlementsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/GovernanceGroupsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/GovernanceGroupsAPI.md new file mode 100644 index 000000000..d5a903924 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/GovernanceGroupsAPI.md @@ -0,0 +1,776 @@ +--- +id: beta-governance-groups +title: GovernanceGroups +pagination_label: GovernanceGroups +sidebar_label: GovernanceGroups +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GovernanceGroups', 'BetaGovernanceGroups'] +slug: /tools/sdk/go/beta/methods/governance-groups +tags: ['SDK', 'Software Development Kit', 'GovernanceGroups', 'BetaGovernanceGroups'] +--- + +# GovernanceGroupsAPI + Use this API to implement and customize Governance Group functionality. With this functionality in place, administrators can create Governance Groups and configure them for use throughout Identity Security Cloud. + +A governance group is a group of users that can make governance decisions about access. If your organization has the Access Request or Certifications service, you can configure governance groups to review access requests or certifications. A governance group can determine whether specific access is appropriate for a user. + +Refer to [Creating and Managing Governance Groups](https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html) for more information about how to build Governance Groups in the visual builder in the Identity Security Cloud UI. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-workgroup**](#create-workgroup) | **Post** `/workgroups` | Create a new Governance Group. +[**delete-workgroup**](#delete-workgroup) | **Delete** `/workgroups/{id}` | Delete a Governance Group +[**delete-workgroup-members**](#delete-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from Governance Group +[**delete-workgroups-in-bulk**](#delete-workgroups-in-bulk) | **Post** `/workgroups/bulk-delete` | Delete Governance Group(s) +[**get-workgroup**](#get-workgroup) | **Get** `/workgroups/{id}` | Get Governance Group by Id +[**list-connections**](#list-connections) | **Get** `/workgroups/{workgroupId}/connections` | List connections for Governance Group +[**list-workgroup-members**](#list-workgroup-members) | **Get** `/workgroups/{workgroupId}/members` | List Governance Group Members +[**list-workgroups**](#list-workgroups) | **Get** `/workgroups` | List Governance Groups +[**patch-workgroup**](#patch-workgroup) | **Patch** `/workgroups/{id}` | Patch a Governance Group +[**update-workgroup-members**](#update-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group + + +## create-workgroup +Create a new Governance Group. +This API creates a new Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-workgroup) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateWorkgroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workgroupDto** | [**WorkgroupDto**](../models/workgroup-dto) | | + +### Return type + +[**WorkgroupDto**](../models/workgroup-dto) + +### 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() { + workgroupdto := []byte(`{ + "owner" : { + "emailAddress" : "support@sailpoint.com", + "displayName" : "Support", + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "connectionCount" : 1641498673000, + "created" : "2022-01-06T19:51:13Z", + "memberCount" : 1641498673000, + "name" : "DB Access Governance Group", + "description" : "Description of the Governance Group", + "modified" : "2022-01-06T19:51:13Z", + "id" : "2c91808568c529c60168cca6f90c1313" + }`) // WorkgroupDto | + + + var workgroupDto beta.WorkgroupDto + if err := json.Unmarshal(workgroupdto, &workgroupDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.CreateWorkgroup(context.Background()).WorkgroupDto(workgroupDto).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.CreateWorkgroup(context.Background()).WorkgroupDto(workgroupDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.CreateWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.CreateWorkgroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-workgroup +Delete a Governance Group +This API deletes a Governance Group by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workgroup) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Governance Group | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteWorkgroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.GovernanceGroupsAPI.DeleteWorkgroup(context.Background(), id).Execute() + //r, err := apiClient.Beta.GovernanceGroupsAPI.DeleteWorkgroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-workgroup-members +Remove members from Governance Group +This API removes one or more members from a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. + +> **Following field of Identity is an optional field in the request.** + +> **name** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workgroup-members) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**workgroupId** | **string** | ID of the Governance Group. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteWorkgroupMembersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **bulkWorkgroupMembersRequestInner** | [**[]BulkWorkgroupMembersRequestInner**](../models/bulk-workgroup-members-request-inner) | List of identities to be removed from a Governance Group members list. | + +### Return type + +[**[]WorkgroupMemberDeleteItem**](../models/workgroup-member-delete-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() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + bulkworkgroupmembersrequestinner := []byte(``) // []BulkWorkgroupMembersRequestInner | List of identities to be removed from a Governance Group members list. + + + var bulkWorkgroupMembersRequestInner beta.[]BulkWorkgroupMembersRequestInner + if err := json.Unmarshal(bulkworkgroupmembersrequestinner, &bulkWorkgroupMembersRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.DeleteWorkgroupMembers(context.Background(), workgroupId).BulkWorkgroupMembersRequestInner(bulkWorkgroupMembersRequestInner).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.DeleteWorkgroupMembers(context.Background(), workgroupId).BulkWorkgroupMembersRequestInner(bulkWorkgroupMembersRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteWorkgroupMembers`: []WorkgroupMemberDeleteItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.DeleteWorkgroupMembers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-workgroups-in-bulk +Delete Governance Group(s) + +This API initiates a bulk deletion of one or more Governance Groups. + +> If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. + +> If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. + +> If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. + +> If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. + +> **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workgroups-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteWorkgroupsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workgroupBulkDeleteRequest** | [**WorkgroupBulkDeleteRequest**](../models/workgroup-bulk-delete-request) | | + +### Return type + +[**[]WorkgroupDeleteItem**](../models/workgroup-delete-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() { + workgroupbulkdeleterequest := []byte(`{ + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + }`) // WorkgroupBulkDeleteRequest | + + + var workgroupBulkDeleteRequest beta.WorkgroupBulkDeleteRequest + if err := json.Unmarshal(workgroupbulkdeleterequest, &workgroupBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.DeleteWorkgroupsInBulk(context.Background()).WorkgroupBulkDeleteRequest(workgroupBulkDeleteRequest).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.DeleteWorkgroupsInBulk(context.Background()).WorkgroupBulkDeleteRequest(workgroupBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroupsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteWorkgroupsInBulk`: []WorkgroupDeleteItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.DeleteWorkgroupsInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-workgroup +Get Governance Group by Id +This API returns a Governance Groups by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workgroup) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Governance Group | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkgroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**WorkgroupDto**](../models/workgroup-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.GetWorkgroup(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.GetWorkgroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.GetWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.GetWorkgroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-connections +List connections for Governance Group +This API returns list of connections associated with a Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-connections) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**workgroupId** | **string** | ID of the Governance Group. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListConnectionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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] + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, created, modified** | + +### Return type + +[**[]WorkgroupConnectionDto**](../models/workgroup-connection-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.ListConnections(context.Background(), workgroupId).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.ListConnections(context.Background(), workgroupId).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListConnections``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListConnections`: []WorkgroupConnectionDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListConnections`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workgroup-members +List Governance Group Members +This API returns list of members associated with a Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workgroup-members) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**workgroupId** | **string** | ID of the Governance Group. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkgroupMembersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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] + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, created, modified** | + +### Return type + +[**[]ListWorkgroupMembers200ResponseInner**](../models/list-workgroup-members200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.ListWorkgroupMembers(context.Background(), workgroupId).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.ListWorkgroupMembers(context.Background(), workgroupId).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkgroupMembers`: []ListWorkgroupMembers200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListWorkgroupMembers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workgroups +List Governance Groups +This API returns list of Governance Groups + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workgroups) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkgroupsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* | + **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, created, modified, id, description** | + +### Return type + +[**[]WorkgroupDto**](../models/workgroup-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw "Test"` // 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, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (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, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) + sorters := `name,-modified` // 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, created, modified, id, description** (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, created, modified, id, description** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.ListWorkgroups(context.Background()).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.ListWorkgroups(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListWorkgroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkgroups`: []WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListWorkgroups`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-workgroup +Patch a Governance Group +This API updates an existing governance group by ID. +The following fields and objects are patchable: + * name + * description + * owner + +A token with API or ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-workgroup) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Governance Group | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchWorkgroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**WorkgroupDto**](../models/workgroup-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Governance Group new description.}]`) // []JsonPatchOperation | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.PatchWorkgroup(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.PatchWorkgroup(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.PatchWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.PatchWorkgroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-workgroup-members +Add members to Governance Group +This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. + +> **Following field of Identity is an optional field in the request.** + +> **name** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-workgroup-members) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**workgroupId** | **string** | ID of the Governance Group. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateWorkgroupMembersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **bulkWorkgroupMembersRequestInner** | [**[]BulkWorkgroupMembersRequestInner**](../models/bulk-workgroup-members-request-inner) | List of identities to be added to a Governance Group members list. | + +### Return type + +[**[]WorkgroupMemberAddItem**](../models/workgroup-member-add-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() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + bulkworkgroupmembersrequestinner := []byte(``) // []BulkWorkgroupMembersRequestInner | List of identities to be added to a Governance Group members list. + + + var bulkWorkgroupMembersRequestInner beta.[]BulkWorkgroupMembersRequestInner + if err := json.Unmarshal(bulkworkgroupmembersrequestinner, &bulkWorkgroupMembersRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.UpdateWorkgroupMembers(context.Background(), workgroupId).BulkWorkgroupMembersRequestInner(bulkWorkgroupMembersRequestInner).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.UpdateWorkgroupMembers(context.Background(), workgroupId).BulkWorkgroupMembersRequestInner(bulkWorkgroupMembersRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.UpdateWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateWorkgroupMembers`: []WorkgroupMemberAddItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.UpdateWorkgroupMembers`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IAIAccessRequestRecommendationsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IAIAccessRequestRecommendationsAPI.md new file mode 100644 index 000000000..96aba0734 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IAIAccessRequestRecommendationsAPI.md @@ -0,0 +1,601 @@ +--- +id: beta-iai-access-request-recommendations +title: IAIAccessRequestRecommendations +pagination_label: IAIAccessRequestRecommendations +sidebar_label: IAIAccessRequestRecommendations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAIAccessRequestRecommendations', 'BetaIAIAccessRequestRecommendations'] +slug: /tools/sdk/go/beta/methods/iai-access-request-recommendations +tags: ['SDK', 'Software Development Kit', 'IAIAccessRequestRecommendations', 'BetaIAIAccessRequestRecommendations'] +--- + +# IAIAccessRequestRecommendationsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add-access-request-recommendations-ignored-item**](#add-access-request-recommendations-ignored-item) | **Post** `/ai-access-request-recommendations/ignored-items` | Ignore Access Request Recommendation +[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **Post** `/ai-access-request-recommendations/requested-items` | Accept Access Request Recommendation +[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **Post** `/ai-access-request-recommendations/viewed-items` | Mark Viewed Access Request Recommendations +[**add-access-request-recommendations-viewed-items**](#add-access-request-recommendations-viewed-items) | **Post** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk Mark Viewed Access Request Recommendations +[**get-access-request-recommendations**](#get-access-request-recommendations) | **Get** `/ai-access-request-recommendations` | Identity Access Request Recommendations +[**get-access-request-recommendations-ignored-items**](#get-access-request-recommendations-ignored-items) | **Get** `/ai-access-request-recommendations/ignored-items` | List Ignored Access Request Recommendations +[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **Get** `/ai-access-request-recommendations/requested-items` | List Accepted Access Request Recommendations +[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **Get** `/ai-access-request-recommendations/viewed-items` | List Viewed Access Request Recommendations + + +## add-access-request-recommendations-ignored-item +Ignore Access Request Recommendation +This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-ignored-item) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddAccessRequestRecommendationsIgnoredItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessRequestRecommendationActionItemDto** | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | The recommended access item to ignore for an identity. | + +### Return type + +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### 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() { + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity. + + + var accessRequestRecommendationActionItemDto beta.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem(context.Background()).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem(context.Background()).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsIgnoredItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## add-access-request-recommendations-requested-item +Accept Access Request Recommendation +This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-requested-item) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddAccessRequestRecommendationsRequestedItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessRequestRecommendationActionItemDto** | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | The recommended access item that was requested for an identity. | + +### Return type + +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### 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() { + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity. + + + var accessRequestRecommendationActionItemDto beta.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem(context.Background()).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem(context.Background()).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsRequestedItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## add-access-request-recommendations-viewed-item +Mark Viewed Access Request Recommendations +This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-viewed-item) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddAccessRequestRecommendationsViewedItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessRequestRecommendationActionItemDto** | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | The recommended access that was viewed for an identity. | + +### Return type + +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### 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() { + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity. + + + var accessRequestRecommendationActionItemDto beta.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem(context.Background()).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem(context.Background()).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsViewedItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## add-access-request-recommendations-viewed-items +Bulk Mark Viewed Access Request Recommendations +This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-viewed-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddAccessRequestRecommendationsViewedItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessRequestRecommendationActionItemDto** | [**[]AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | The recommended access items that were viewed for an identity. | + +### Return type + +[**[]AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### 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() { + accessrequestrecommendationactionitemdto := []byte(``) // []AccessRequestRecommendationActionItemDto | The recommended access items that were viewed for an identity. + + + var accessRequestRecommendationActionItemDto beta.[]AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems(context.Background()).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems(context.Background()).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsViewedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-recommendations +Identity Access Request Recommendations +This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestRecommendationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityId** | **string** | Get access request recommendations for an identityId. *me* indicates the current user. | [default to "me"] + **limit** | **int32** | Max number of results to return. | [default to 15] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **includeTranslationMessages** | **bool** | If *true* it will populate a list of translation messages in the response. | [default to false] + **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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* | + **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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. | + +### Return type + +[**[]AccessRequestRecommendationItemDetail**](../models/access-request-recommendation-item-detail) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `2c91808570313110017040b06f344ec9` // string | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") # string | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") + limit := 15 // int32 | Max number of results to return. (optional) (default to 15) # int32 | Max number of results to return. (optional) (default to 15) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + includeTranslationMessages := false // bool | If *true* it will populate a list of translation messages in the response. (optional) (default to false) # bool | If *true* it will populate a list of translation messages in the response. (optional) (default to false) + filters := `access.name co "admin"` // 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) + sorters := `access.name` // 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations(context.Background()).IdentityId(identityId).Limit(limit).Offset(offset).Count(count).IncludeTranslationMessages(includeTranslationMessages).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendations`: []AccessRequestRecommendationItemDetail + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-recommendations-ignored-items +List Ignored Access Request Recommendations +This API returns the list of ignored access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-ignored-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestRecommendationsIgnoredItemsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* | + **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: **access.id, access.type, identityId, timestamp** | + +### Return type + +[**[]AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `identityId eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsIgnoredItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-recommendations-requested-items +List Accepted Access Request Recommendations +This API returns a list of requested access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-requested-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestRecommendationsRequestedItemsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* | + **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: **access.id, access.type, identityId, timestamp** | + +### Return type + +[**[]AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsRequestedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-recommendations-viewed-items +List Viewed Access Request Recommendations +This API returns the list of viewed access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-viewed-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestRecommendationsViewedItemsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* | + **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: **access.id, access.type, identityId, timestamp** | + +### Return type + +[**[]AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsViewedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IAICommonAccessAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IAICommonAccessAPI.md new file mode 100644 index 000000000..be6602397 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IAICommonAccessAPI.md @@ -0,0 +1,238 @@ +--- +id: beta-iai-common-access +title: IAICommonAccess +pagination_label: IAICommonAccess +sidebar_label: IAICommonAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAICommonAccess', 'BetaIAICommonAccess'] +slug: /tools/sdk/go/beta/methods/iai-common-access +tags: ['SDK', 'Software Development Kit', 'IAICommonAccess', 'BetaIAICommonAccess'] +--- + +# IAICommonAccessAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-common-access**](#create-common-access) | **Post** `/common-access` | Create common access items +[**get-common-access**](#get-common-access) | **Get** `/common-access` | Get a paginated list of common access +[**update-common-access-status-in-bulk**](#update-common-access-status-in-bulk) | **Post** `/common-access/update-status` | Bulk update common access status + + +## create-common-access +Create common access items +This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-common-access) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCommonAccessRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **commonAccessItemRequest** | [**CommonAccessItemRequest**](../models/common-access-item-request) | | + +### Return type + +[**CommonAccessItemResponse**](../models/common-access-item-response) + +### 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() { + commonaccessitemrequest := []byte(`{ + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" + }`) // CommonAccessItemRequest | + + + var commonAccessItemRequest beta.CommonAccessItemRequest + if err := json.Unmarshal(commonaccessitemrequest, &commonAccessItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAICommonAccessAPI.CreateCommonAccess(context.Background()).CommonAccessItemRequest(commonAccessItemRequest).Execute() + //resp, r, err := apiClient.Beta.IAICommonAccessAPI.CreateCommonAccess(context.Background()).CommonAccessItemRequest(commonAccessItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.CreateCommonAccess``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCommonAccess`: CommonAccessItemResponse + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.CreateCommonAccess`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-common-access +Get a paginated list of common access +This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-common-access) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCommonAccessRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, 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: **access.name, status** By default the common access items are sorted by name, ascending. | + +### Return type + +[**[]CommonAccessResponse**](../models/common-access-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.type eq "ROLE"` // 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) + sorters := `access.name` // 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: **access.name, status** By default the common access items are sorted by name, ascending. (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: **access.name, status** By default the common access items are sorted by name, ascending. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAICommonAccessAPI.GetCommonAccess(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAICommonAccessAPI.GetCommonAccess(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.GetCommonAccess``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCommonAccess`: []CommonAccessResponse + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.GetCommonAccess`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-common-access-status-in-bulk +Bulk update common access status +This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-common-access-status-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateCommonAccessStatusInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **commonAccessIDStatus** | [**[]CommonAccessIDStatus**](../models/common-access-id-status) | Confirm or deny in bulk the common access ids that are (or aren't) common access | + +### Return type + +**map[string]interface{}** + +### 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() { + commonaccessidstatus := []byte(``) // []CommonAccessIDStatus | Confirm or deny in bulk the common access ids that are (or aren't) common access + + + var commonAccessIDStatus beta.[]CommonAccessIDStatus + if err := json.Unmarshal(commonaccessidstatus, &commonAccessIDStatus); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAICommonAccessAPI.UpdateCommonAccessStatusInBulk(context.Background()).CommonAccessIDStatus(commonAccessIDStatus).Execute() + //resp, r, err := apiClient.Beta.IAICommonAccessAPI.UpdateCommonAccessStatusInBulk(context.Background()).CommonAccessIDStatus(commonAccessIDStatus).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.UpdateCommonAccessStatusInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCommonAccessStatusInBulk`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.UpdateCommonAccessStatusInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IAIMessageCatalogsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IAIMessageCatalogsAPI.md new file mode 100644 index 000000000..0d6330e0c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IAIMessageCatalogsAPI.md @@ -0,0 +1,86 @@ +--- +id: beta-iai-message-catalogs +title: IAIMessageCatalogs +pagination_label: IAIMessageCatalogs +sidebar_label: IAIMessageCatalogs +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAIMessageCatalogs', 'BetaIAIMessageCatalogs'] +slug: /tools/sdk/go/beta/methods/iai-message-catalogs +tags: ['SDK', 'Software Development Kit', 'IAIMessageCatalogs', 'BetaIAIMessageCatalogs'] +--- + +# IAIMessageCatalogsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-message-catalogs**](#get-message-catalogs) | **Get** `/translation-catalogs/{catalog-id}` | Get Message catalogs + + +## get-message-catalogs +Get Message catalogs +The getMessageCatalogs API returns message catalog based on the language headers in the requested object. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-message-catalogs) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**catalogId** | **string** | The ID of the message catalog. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMessageCatalogsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]MessageCatalogDto**](../models/message-catalog-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + catalogId := `recommender` // string | The ID of the message catalog. # string | The ID of the message catalog. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIMessageCatalogsAPI.GetMessageCatalogs(context.Background(), catalogId).Execute() + //resp, r, err := apiClient.Beta.IAIMessageCatalogsAPI.GetMessageCatalogs(context.Background(), catalogId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIMessageCatalogsAPI.GetMessageCatalogs``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMessageCatalogs`: []MessageCatalogDto + fmt.Fprintf(os.Stdout, "Response from `IAIMessageCatalogsAPI.GetMessageCatalogs`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IAIOutliersAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IAIOutliersAPI.md new file mode 100644 index 000000000..92d1bf5c7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IAIOutliersAPI.md @@ -0,0 +1,659 @@ +--- +id: beta-iai-outliers +title: IAIOutliers +pagination_label: IAIOutliers +sidebar_label: IAIOutliers +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAIOutliers', 'BetaIAIOutliers'] +slug: /tools/sdk/go/beta/methods/iai-outliers +tags: ['SDK', 'Software Development Kit', 'IAIOutliers', 'BetaIAIOutliers'] +--- + +# IAIOutliersAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**export-outliers-zip**](#export-outliers-zip) | **Get** `/outliers/export` | IAI Identity Outliers Export +[**get-identity-outlier-snapshots**](#get-identity-outlier-snapshots) | **Get** `/outlier-summaries` | IAI Identity Outliers Summary +[**get-identity-outliers**](#get-identity-outliers) | **Get** `/outliers` | IAI Get Identity Outliers +[**get-latest-identity-outlier-snapshots**](#get-latest-identity-outlier-snapshots) | **Get** `/outlier-summaries/latest` | IAI Identity Outliers Latest Summary +[**get-outlier-contributing-feature-summary**](#get-outlier-contributing-feature-summary) | **Get** `/outlier-feature-summaries/{outlierFeatureId}` | Get identity outlier contibuting feature summary +[**get-peer-group-outliers-contributing-features**](#get-peer-group-outliers-contributing-features) | **Get** `/outliers/{outlierId}/contributing-features` | Get identity outlier's contibuting features +[**ignore-identity-outliers**](#ignore-identity-outliers) | **Post** `/outliers/ignore` | IAI Identity Outliers Ignore +[**list-outliers-contributing-feature-access-items**](#list-outliers-contributing-feature-access-items) | **Get** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature +[**un-ignore-identity-outliers**](#un-ignore-identity-outliers) | **Post** `/outliers/unignore` | IAI Identity Outliers Unignore + + +## export-outliers-zip +IAI Identity Outliers Export +This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. + +Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-outliers-zip) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportOutliersZipRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type_** | **string** | Type of the identity outliers snapshot to filter on | + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIOutliersAPI.ExportOutliersZip(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIOutliersAPI.ExportOutliersZip(context.Background()).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.ExportOutliersZip``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportOutliersZip`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.ExportOutliersZip`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-outlier-snapshots +IAI Identity Outliers Summary +This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-outlier-snapshots) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityOutlierSnapshotsRequest struct via the builder pattern + + +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] + **type_** | **string** | Type of the identity outliers snapshot to filter on | + **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: **snapshotDate**: *ge, le* | + **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: **snapshotDate** | + +### Return type + +[**[]OutlierSummary**](../models/outlier-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + filters := `snapshotDate ge "2022-02-07T20:13:29.356648026Z"` // 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: **snapshotDate**: *ge, le* (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: **snapshotDate**: *ge, le* (optional) + sorters := `snapshotDate` // 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: **snapshotDate** (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: **snapshotDate** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIOutliersAPI.GetIdentityOutlierSnapshots(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIOutliersAPI.GetIdentityOutlierSnapshots(context.Background()).Limit(limit).Offset(offset).Type_(type_).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetIdentityOutlierSnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityOutlierSnapshots`: []OutlierSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetIdentityOutlierSnapshots`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-outliers +IAI Get Identity Outliers +This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-outliers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityOutliersRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **type_** | **string** | Type of the identity outliers snapshot to filter on | + **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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* | + **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: **firstDetectionDate, attributes, score** | + +### Return type + +[**[]Outlier**](../models/outlier) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + filters := `attributes.displayName sw "John" and certStatus 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) + sorters := `attributes.displayName,firstDetectionDate,-score` // 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: **firstDetectionDate, attributes, score** (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: **firstDetectionDate, attributes, score** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIOutliersAPI.GetIdentityOutliers(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIOutliersAPI.GetIdentityOutliers(context.Background()).Limit(limit).Offset(offset).Count(count).Type_(type_).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityOutliers`: []Outlier + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetIdentityOutliers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-latest-identity-outlier-snapshots +IAI Identity Outliers Latest Summary +This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-latest-identity-outlier-snapshots) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLatestIdentityOutlierSnapshotsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type_** | **string** | Type of the identity outliers snapshot to filter on | + +### Return type + +[**[]LatestOutlierSummary**](../models/latest-outlier-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIOutliersAPI.GetLatestIdentityOutlierSnapshots(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIOutliersAPI.GetLatestIdentityOutlierSnapshots(context.Background()).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetLatestIdentityOutlierSnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLatestIdentityOutlierSnapshots`: []LatestOutlierSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetLatestIdentityOutlierSnapshots`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-outlier-contributing-feature-summary +Get identity outlier contibuting feature summary +This API returns a summary of a contributing feature for an identity outlier. + +The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-outlier-contributing-feature-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**outlierFeatureId** | **string** | Contributing feature id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOutlierContributingFeatureSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**OutlierFeatureSummary**](../models/outlier-feature-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + outlierFeatureId := `04654b66-7561-4090-94f9-abee0722a1af` // string | Contributing feature id # string | Contributing feature id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIOutliersAPI.GetOutlierContributingFeatureSummary(context.Background(), outlierFeatureId).Execute() + //resp, r, err := apiClient.Beta.IAIOutliersAPI.GetOutlierContributingFeatureSummary(context.Background(), outlierFeatureId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetOutlierContributingFeatureSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOutlierContributingFeatureSummary`: OutlierFeatureSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetOutlierContributingFeatureSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-peer-group-outliers-contributing-features +Get identity outlier's contibuting features +This API returns a list of contributing feature objects for a single outlier. + +The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-peer-group-outliers-contributing-features) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**outlierId** | **string** | The outlier id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPeerGroupOutliersContributingFeaturesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **includeTranslationMessages** | **string** | Whether or not to include translation messages object in returned response | + **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: **importance** | + +### Return type + +[**[]OutlierContributingFeature**](../models/outlier-contributing-feature) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + outlierId := `2c918085842e69ae018432d22ccb212f` // string | The outlier id # string | The outlier 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + includeTranslationMessages := `include-translation-messages=` // string | Whether or not to include translation messages object in returned response (optional) # string | Whether or not to include translation messages object in returned response (optional) + sorters := `importance` // 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: **importance** (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: **importance** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures(context.Background(), outlierId).Execute() + //resp, r, err := apiClient.Beta.IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures(context.Background(), outlierId).Limit(limit).Offset(offset).Count(count).IncludeTranslationMessages(includeTranslationMessages).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPeerGroupOutliersContributingFeatures`: []OutlierContributingFeature + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## ignore-identity-outliers +IAI Identity Outliers Ignore +This API receives a list of identity IDs in the request, changes the outliers to be ignored. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/ignore-identity-outliers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiIgnoreIdentityOutliersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestBody** | **[]string** | | + +### Return type + + (empty response body) + +### 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() { + requestbody := []byte(``) // []string | + + + var requestBody beta.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.IAIOutliersAPI.IgnoreIdentityOutliers(context.Background()).RequestBody(requestBody).Execute() + //r, err := apiClient.Beta.IAIOutliersAPI.IgnoreIdentityOutliers(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.IgnoreIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## list-outliers-contributing-feature-access-items +Gets a list of access items associated with each identity outlier contributing feature +This API returns a list of the enriched access items associated with each feature filtered by the access item type. + +The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-outliers-contributing-feature-access-items) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**outlierId** | **string** | The outlier id | +**contributingFeatureName** | **string** | The name of contributing feature | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOutliersContributingFeatureAccessItemsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **accessType** | **string** | The type of access item for the identity outlier contributing feature. If not provided, it returns all. | + **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: **displayName** | + +### Return type + +[**[]OutliersContributingFeatureAccessItems**](../models/outliers-contributing-feature-access-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + outlierId := `2c918085842e69ae018432d22ccb212f` // string | The outlier id # string | The outlier id + contributingFeatureName := `entitlement_count` // string | The name of contributing feature # string | The name of contributing feature + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + accessType := `ENTITLEMENT` // string | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) # string | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) + sorters := `displayName` // 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: **displayName** (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: **displayName** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIOutliersAPI.ListOutliersContributingFeatureAccessItems(context.Background(), outlierId, contributingFeatureName).Execute() + //resp, r, err := apiClient.Beta.IAIOutliersAPI.ListOutliersContributingFeatureAccessItems(context.Background(), outlierId, contributingFeatureName).Limit(limit).Offset(offset).Count(count).AccessType(accessType).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.ListOutliersContributingFeatureAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOutliersContributingFeatureAccessItems`: []OutliersContributingFeatureAccessItems + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.ListOutliersContributingFeatureAccessItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## un-ignore-identity-outliers +IAI Identity Outliers Unignore +This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/un-ignore-identity-outliers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUnIgnoreIdentityOutliersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestBody** | **[]string** | | + +### Return type + + (empty response body) + +### 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() { + requestbody := []byte(``) // []string | + + + var requestBody beta.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.IAIOutliersAPI.UnIgnoreIdentityOutliers(context.Background()).RequestBody(requestBody).Execute() + //r, err := apiClient.Beta.IAIOutliersAPI.UnIgnoreIdentityOutliers(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.UnIgnoreIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IAIPeerGroupStrategiesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IAIPeerGroupStrategiesAPI.md new file mode 100644 index 000000000..26ad4e35b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IAIPeerGroupStrategiesAPI.md @@ -0,0 +1,95 @@ +--- +id: beta-iai-peer-group-strategies +title: IAIPeerGroupStrategies +pagination_label: IAIPeerGroupStrategies +sidebar_label: IAIPeerGroupStrategies +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAIPeerGroupStrategies', 'BetaIAIPeerGroupStrategies'] +slug: /tools/sdk/go/beta/methods/iai-peer-group-strategies +tags: ['SDK', 'Software Development Kit', 'IAIPeerGroupStrategies', 'BetaIAIPeerGroupStrategies'] +--- + +# IAIPeerGroupStrategiesAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-peer-group-outliers**](#get-peer-group-outliers) | **Get** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List + + +## get-peer-group-outliers +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Identity Outliers List +-- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-peer-group-outliers) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**strategy** | **string** | The strategy used to create peer groups. Currently, 'entitlement' is supported. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPeerGroupOutliersRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]PeerGroupMember**](../models/peer-group-member) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + strategy := `entitlement` // string | The strategy used to create peer groups. Currently, 'entitlement' is supported. # string | The strategy used to create peer groups. Currently, 'entitlement' is supported. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers(context.Background(), strategy).Execute() + //resp, r, err := apiClient.Beta.IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers(context.Background(), strategy).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPeerGroupOutliers`: []PeerGroupMember + fmt.Fprintf(os.Stdout, "Response from `IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IAIRecommendationsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IAIRecommendationsAPI.md new file mode 100644 index 000000000..749db3f71 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IAIRecommendationsAPI.md @@ -0,0 +1,238 @@ +--- +id: beta-iai-recommendations +title: IAIRecommendations +pagination_label: IAIRecommendations +sidebar_label: IAIRecommendations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAIRecommendations', 'BetaIAIRecommendations'] +slug: /tools/sdk/go/beta/methods/iai-recommendations +tags: ['SDK', 'Software Development Kit', 'IAIRecommendations', 'BetaIAIRecommendations'] +--- + +# IAIRecommendationsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-recommendations**](#get-recommendations) | **Post** `/recommendations/request` | Returns Recommendation Based on Object +[**get-recommendations-config**](#get-recommendations-config) | **Get** `/recommendations/config` | Get certification recommendation config values +[**update-recommendations-config**](#update-recommendations-config) | **Put** `/recommendations/config` | Update certification recommendation config values + + +## get-recommendations +Returns Recommendation Based on Object +The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-recommendations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRecommendationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **recommendationRequestDto** | [**RecommendationRequestDto**](../models/recommendation-request-dto) | | + +### Return type + +[**RecommendationResponseDto**](../models/recommendation-response-dto) + +### 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() { + recommendationrequestdto := []byte(`{ + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true + }`) // RecommendationRequestDto | + + + var recommendationRequestDto beta.RecommendationRequestDto + if err := json.Unmarshal(recommendationrequestdto, &recommendationRequestDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRecommendationsAPI.GetRecommendations(context.Background()).RecommendationRequestDto(recommendationRequestDto).Execute() + //resp, r, err := apiClient.Beta.IAIRecommendationsAPI.GetRecommendations(context.Background()).RecommendationRequestDto(recommendationRequestDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.GetRecommendations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRecommendations`: RecommendationResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.GetRecommendations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-recommendations-config +Get certification recommendation config values +Retrieves configuration attributes used by certification recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-recommendations-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRecommendationsConfigRequest struct via the builder pattern + + +### Return type + +[**RecommendationConfigDto**](../models/recommendation-config-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRecommendationsAPI.GetRecommendationsConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIRecommendationsAPI.GetRecommendationsConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.GetRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRecommendationsConfig`: RecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.GetRecommendationsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-recommendations-config +Update certification recommendation config values +Updates configuration attributes used by certification recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-recommendations-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateRecommendationsConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **recommendationConfigDto** | [**RecommendationConfigDto**](../models/recommendation-config-dto) | | + +### Return type + +[**RecommendationConfigDto**](../models/recommendation-config-dto) + +### 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() { + recommendationconfigdto := []byte(`{ + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + }`) // RecommendationConfigDto | + + + var recommendationConfigDto beta.RecommendationConfigDto + if err := json.Unmarshal(recommendationconfigdto, &recommendationConfigDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRecommendationsAPI.UpdateRecommendationsConfig(context.Background()).RecommendationConfigDto(recommendationConfigDto).Execute() + //resp, r, err := apiClient.Beta.IAIRecommendationsAPI.UpdateRecommendationsConfig(context.Background()).RecommendationConfigDto(recommendationConfigDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.UpdateRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRecommendationsConfig`: RecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.UpdateRecommendationsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IAIRoleMiningAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IAIRoleMiningAPI.md new file mode 100644 index 000000000..57705a2b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IAIRoleMiningAPI.md @@ -0,0 +1,1932 @@ +--- +id: beta-iai-role-mining +title: IAIRoleMining +pagination_label: IAIRoleMining +sidebar_label: IAIRoleMining +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAIRoleMining', 'BetaIAIRoleMining'] +slug: /tools/sdk/go/beta/methods/iai-role-mining +tags: ['SDK', 'Software Development Kit', 'IAIRoleMining', 'BetaIAIRoleMining'] +--- + +# IAIRoleMiningAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-potential-role-provision-request**](#create-potential-role-provision-request) | **Post** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision` | Create request to provision a potential role into an actual role. +[**create-role-mining-sessions**](#create-role-mining-sessions) | **Post** `/role-mining-sessions` | Create a role mining session +[**download-role-mining-potential-role-zip**](#download-role-mining-potential-role-zip) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` | Export (download) details for a potential role in a role mining session +[**export-role-mining-potential-role**](#export-role-mining-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export` | Export (download) details for a potential role in a role mining session +[**export-role-mining-potential-role-async**](#export-role-mining-potential-role-async) | **Post** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` | Asynchronously export details for a potential role in a role mining session and upload to S3 +[**export-role-mining-potential-role-status**](#export-role-mining-potential-role-status) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` | Retrieve status of a potential role export job +[**get-all-potential-role-summaries**](#get-all-potential-role-summaries) | **Get** `/role-mining-potential-roles` | Retrieves all potential role summaries +[**get-entitlement-distribution-potential-role**](#get-entitlement-distribution-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` | Retrieves entitlement popularity distribution for a potential role in a role mining session +[**get-entitlements-potential-role**](#get-entitlements-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities` | Retrieves entitlements for a potential role in a role mining session +[**get-excluded-entitlements-potential-role**](#get-excluded-entitlements-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements` | Retrieves excluded entitlements for a potential role in a role mining session +[**get-identities-potential-role**](#get-identities-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities` | Retrieves identities for a potential role in a role mining session +[**get-potential-role**](#get-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` | Retrieve potential role in session +[**get-potential-role-applications**](#get-potential-role-applications) | **Get** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications` | Retrieves the applications of a potential role for a role mining session +[**get-potential-role-entitlements**](#get-potential-role-entitlements) | **Get** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements` | Retrieves the entitlements of a potential role for a role mining session +[**get-potential-role-source-identity-usage**](#get-potential-role-source-identity-usage) | **Get** `/role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage` | Retrieves potential role source usage +[**get-potential-role-summaries**](#get-potential-role-summaries) | **Get** `/role-mining-sessions/{sessionId}/potential-role-summaries` | Retrieve session's potential role summaries +[**get-role-mining-potential-role**](#get-role-mining-potential-role) | **Get** `/role-mining-potential-roles/{potentialRoleId}` | Retrieves a specific potential role +[**get-role-mining-session**](#get-role-mining-session) | **Get** `/role-mining-sessions/{sessionId}` | Get a role mining session +[**get-role-mining-session-status**](#get-role-mining-session-status) | **Get** `/role-mining-sessions/{sessionId}/status` | Get role mining session status state +[**get-role-mining-sessions**](#get-role-mining-sessions) | **Get** `/role-mining-sessions` | Retrieves all role mining sessions +[**get-saved-potential-roles**](#get-saved-potential-roles) | **Get** `/role-mining-potential-roles/saved` | Retrieves all saved potential roles +[**patch-potential-role**](#patch-potential-role) | **Patch** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` | Update a potential role in session +[**patch-role-mining-potential-role**](#patch-role-mining-potential-role) | **Patch** `/role-mining-potential-roles/{potentialRoleId}` | Update a potential role +[**patch-role-mining-session**](#patch-role-mining-session) | **Patch** `/role-mining-sessions/{sessionId}` | Patch a role mining session +[**update-entitlements-potential-role**](#update-entitlements-potential-role) | **Post** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` | Edit entitlements for a potential role to exclude some entitlements + + +## create-potential-role-provision-request +Create request to provision a potential role into an actual role. +This method starts a job to provision a potential role + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-potential-role-provision-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePotentialRoleProvisionRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **minEntitlementPopularity** | **int32** | Minimum popularity required for an entitlement to be included in the provisioned role. | [default to 0] + **includeCommonAccess** | **bool** | Boolean determining whether common access entitlements will be included in the provisioned role. | [default to true] + **roleMiningPotentialRoleProvisionRequest** | [**RoleMiningPotentialRoleProvisionRequest**](../models/role-mining-potential-role-provision-request) | Required information to create a new role | + +### Return type + +[**RoleMiningPotentialRoleSummary**](../models/role-mining-potential-role-summary) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + minEntitlementPopularity := 56 // int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) # int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to true) # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to true) + roleminingpotentialroleprovisionrequest := []byte(`{ + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false + }`) // RoleMiningPotentialRoleProvisionRequest | Required information to create a new role (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest(context.Background(), sessionId, potentialRoleId).MinEntitlementPopularity(minEntitlementPopularity).IncludeCommonAccess(includeCommonAccess).RoleMiningPotentialRoleProvisionRequest(roleMiningPotentialRoleProvisionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePotentialRoleProvisionRequest`: RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-role-mining-sessions +Create a role mining session +This submits a create role mining session request to the role mining application. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-role-mining-sessions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateRoleMiningSessionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **roleMiningSessionDto** | [**RoleMiningSessionDto**](../models/role-mining-session-dto) | Role mining session parameters | + +### Return type + +[**RoleMiningSessionResponse**](../models/role-mining-session-response) + +### 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() { + roleminingsessiondto := []byte(`{ + "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", + "prescribedPruneThreshold" : 10, + "pruneThreshold" : 50, + "saved" : true, + "potentialRolesReadyCount" : 0, + "scope" : { + "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], + "attributeFilterCriteria" : { + "displayName" : { + "untranslated" : "Location: Miami" + }, + "ariaLabel" : { + "untranslated" : "Location: Miami" + }, + "data" : { + "displayName" : { + "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" + }, + "name" : "location", + "operator" : "EQUALS", + "values" : [ "Miami" ] + } + }, + "criteria" : "source.name:DataScienceDataset" + }, + "potentialRoleCount" : 0, + "name" : "Saved RM Session - 07/10", + "minNumIdentitiesInPotentialRole" : 20, + "identityCount" : 0, + "type" : "SPECIALIZED" + }`) // RoleMiningSessionDto | Role mining session parameters + + + var roleMiningSessionDto beta.RoleMiningSessionDto + if err := json.Unmarshal(roleminingsessiondto, &roleMiningSessionDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.CreateRoleMiningSessions(context.Background()).RoleMiningSessionDto(roleMiningSessionDto).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.CreateRoleMiningSessions(context.Background()).RoleMiningSessionDto(roleMiningSessionDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.CreateRoleMiningSessions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRoleMiningSessions`: RoleMiningSessionResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.CreateRoleMiningSessions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## download-role-mining-potential-role-zip +Export (download) details for a potential role in a role mining session +This endpoint downloads a completed export of information for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/download-role-mining-potential-role-zip) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | +**exportId** | **string** | The id of a previously run export job for this potential role | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDownloadRoleMiningPotentialRoleZipRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + exportId := `4940ffd4-836f-48a3-b2b0-6d498c3fdf40` // string | The id of a previously run export job for this potential role # string | The id of a previously run export job for this potential role + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip(context.Background(), sessionId, potentialRoleId, exportId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip(context.Background(), sessionId, potentialRoleId, exportId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DownloadRoleMiningPotentialRoleZip`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## export-role-mining-potential-role +Export (download) details for a potential role in a role mining session +This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-role-mining-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportRoleMiningPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.ExportRoleMiningPotentialRole(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.ExportRoleMiningPotentialRole(context.Background(), sessionId, potentialRoleId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRole`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## export-role-mining-potential-role-async +Asynchronously export details for a potential role in a role mining session and upload to S3 +This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-role-mining-potential-role-async) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportRoleMiningPotentialRoleAsyncRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **roleMiningPotentialRoleExportRequest** | [**RoleMiningPotentialRoleExportRequest**](../models/role-mining-potential-role-export-request) | | + +### Return type + +[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + roleminingpotentialroleexportrequest := []byte(`{ + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true + }`) // RoleMiningPotentialRoleExportRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync(context.Background(), sessionId, potentialRoleId).RoleMiningPotentialRoleExportRequest(roleMiningPotentialRoleExportRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRoleAsync`: RoleMiningPotentialRoleExportResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## export-role-mining-potential-role-status +Retrieve status of a potential role export job +This endpoint retrieves information about the current status of a potential role export. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-role-mining-potential-role-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | +**exportId** | **string** | The id of a previously run export job for this potential role | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportRoleMiningPotentialRoleStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + exportId := `4940ffd4-836f-48a3-b2b0-6d498c3fdf40` // string | The id of a previously run export job for this potential role # string | The id of a previously run export job for this potential role + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus(context.Background(), sessionId, potentialRoleId, exportId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus(context.Background(), sessionId, potentialRoleId, exportId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRoleStatus`: RoleMiningPotentialRoleExportResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-all-potential-role-summaries +Retrieves all potential role summaries +Returns all potential role summaries that match the query parameters + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-all-potential-role-summaries) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAllPotentialRoleSummariesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **createdDate, identityCount, entitlementCount, freshness, quality** | + **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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningPotentialRoleSummary**](../models/role-mining-potential-role-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sorters := `createdDate` // 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: **createdDate, identityCount, entitlementCount, freshness, quality** (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: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) + filters := `(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))` // 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetAllPotentialRoleSummaries(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetAllPotentialRoleSummaries(context.Background()).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetAllPotentialRoleSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAllPotentialRoleSummaries`: []RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetAllPotentialRoleSummaries`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlement-distribution-potential-role +Retrieves entitlement popularity distribution for a potential role in a role mining session +This method returns entitlement popularity distribution for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement-distribution-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementDistributionPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCommonAccess** | **bool** | Boolean determining whether common access entitlements will be included or not | + +### Return type + +**map[string]int32** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included or not (optional) # bool | Boolean determining whether common access entitlements will be included or not (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole(context.Background(), sessionId, potentialRoleId).IncludeCommonAccess(includeCommonAccess).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementDistributionPotentialRole`: map[string]int32 + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlements-potential-role +Retrieves entitlements for a potential role in a role mining session +This method returns entitlements for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlements-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementsPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **includeCommonAccess** | **bool** | Boolean determining whether common access entitlements will be included or not | [default to true] + **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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. | + **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: **applicationName**: *sw* **entitlementRef.name**: *sw* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningEntitlement**](../models/role-mining-entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included or not (optional) (default to true) # bool | Boolean determining whether common access entitlements will be included or not (optional) (default to true) + sorters := `popularity` // 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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) + filters := `applicationName sw "AD"` // 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).IncludeCommonAccess(includeCommonAccess).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementsPotentialRole`: []RoleMiningEntitlement + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetEntitlementsPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-excluded-entitlements-potential-role +Retrieves excluded entitlements for a potential role in a role mining session +This method returns excluded entitlements for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-excluded-entitlements-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetExcludedEntitlementsPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **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: **popularity** | + **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: **applicationName**: *sw* **entitlementRef.name**: *sw* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningEntitlement**](../models/role-mining-entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + sorters := `populariity` // 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: **popularity** (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: **popularity** (optional) + filters := `applicationName sw "AD"` // 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetExcludedEntitlementsPotentialRole`: []RoleMiningEntitlement + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identities-potential-role +Retrieves identities for a potential role in a role mining session +This method returns identities for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identities-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentitiesPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **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** | + **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: **name**: *sw* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningIdentity**](../models/role-mining-identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + sorters := `name` // 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** (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** (optional) + filters := `filters_example` // 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: **name**: *sw* (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: **name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetIdentitiesPotentialRole(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetIdentitiesPotentialRole(context.Background(), sessionId, potentialRoleId).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetIdentitiesPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitiesPotentialRole`: []RoleMiningIdentity + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetIdentitiesPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-potential-role +Retrieve potential role in session +This method returns a specific potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRole(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRole(context.Background(), sessionId, potentialRoleId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-potential-role-applications +Retrieves the applications of a potential role for a role mining session +This method returns the applications of a potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role-applications) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPotentialRoleApplicationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **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: **applicationName**: *sw* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningPotentialRoleApplication**](../models/role-mining-potential-role-application) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `62f28d91-7d9f-4d17-be15-666d5b41d77f` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + filters := `applicationName sw "test"` // 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: **applicationName**: *sw* (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: **applicationName**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRoleApplications(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRoleApplications(context.Background(), sessionId, potentialRoleId).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleApplications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleApplications`: []RoleMiningPotentialRoleApplication + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleApplications`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-potential-role-entitlements +Retrieves the entitlements of a potential role for a role mining session +This method returns the entitlements of a potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPotentialRoleEntitlementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **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: **entitlementRef.name**: *sw* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningPotentialRoleEntitlements**](../models/role-mining-potential-role-entitlements) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `62f28d91-7d9f-4d17-be15-666d5b41d77f` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + filters := `entitlementRef.name sw "test"` // 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: **entitlementRef.name**: *sw* (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: **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRoleEntitlements(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRoleEntitlements(context.Background(), sessionId, potentialRoleId).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleEntitlements`: []RoleMiningPotentialRoleEntitlements + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-potential-role-source-identity-usage +Retrieves potential role source usage +This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role-source-identity-usage) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**potentialRoleId** | **string** | A potential role id | +**sourceId** | **string** | A source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPotentialRoleSourceIdentityUsageRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **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 is supported for the following fields: **displayName, email, usageCount** | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningPotentialRoleSourceUsage**](../models/role-mining-potential-role-source-usage) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + potentialRoleId := `e0cc5d7d-bf7f-4f81-b2af-8885b09d9923` // string | A potential role id # string | A potential role id + sourceId := `2c9180877620c1460176267f336a106f` // string | A source id # string | A source id + sorters := `-usageCount` // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (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 is supported for the following fields: **displayName, email, usageCount** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage(context.Background(), potentialRoleId, sourceId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage(context.Background(), potentialRoleId, sourceId).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleSourceIdentityUsage`: []RoleMiningPotentialRoleSourceUsage + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-potential-role-summaries +Retrieve session's potential role summaries +This method returns the potential role summaries for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role-summaries) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPotentialRoleSummariesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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: **createdDate** | + **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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningPotentialRoleSummary**](../models/role-mining-potential-role-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + sorters := `createdDate` // 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: **createdDate** (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: **createdDate** (optional) + filters := `(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))` // 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRoleSummaries(context.Background(), sessionId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRoleSummaries(context.Background(), sessionId).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleSummaries`: []RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleSummaries`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-mining-potential-role +Retrieves a specific potential role +This method returns a specific potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-mining-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**potentialRoleId** | **string** | A potential role id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleMiningPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id # string | A potential role id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetRoleMiningPotentialRole(context.Background(), potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetRoleMiningPotentialRole(context.Background(), potentialRoleId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-mining-session +Get a role mining session +The method retrieves a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-mining-session) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id to be retrieved. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleMiningSessionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**RoleMiningSessionResponse**](../models/role-mining-session-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id to be retrieved. # string | The role mining session id to be retrieved. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetRoleMiningSession(context.Background(), sessionId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetRoleMiningSession(context.Background(), sessionId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSession``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSession`: RoleMiningSessionResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSession`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-mining-session-status +Get role mining session status state +This method returns a role mining session status for a customer. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-mining-session-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleMiningSessionStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**RoleMiningSessionStatus**](../models/role-mining-session-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetRoleMiningSessionStatus(context.Background(), sessionId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetRoleMiningSessionStatus(context.Background(), sessionId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSessionStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSessionStatus`: RoleMiningSessionStatus + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSessionStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-mining-sessions +Retrieves all role mining sessions +Returns all role mining sessions that match the query parameters + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-mining-sessions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleMiningSessionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **saved**: *eq* **name**: *eq, sw* | + **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: **createdBy, createdDate** | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningSessionResponse**](../models/role-mining-session-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `saved eq "true" and name sw "RM Session"` // 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: **saved**: *eq* **name**: *eq, sw* (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: **saved**: *eq* **name**: *eq, sw* (optional) + sorters := `createdBy,createdDate` // 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: **createdBy, createdDate** (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: **createdBy, createdDate** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetRoleMiningSessions(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetRoleMiningSessions(context.Background()).Filters(filters).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSessions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSessions`: []RoleMiningSessionResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSessions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-saved-potential-roles +Retrieves all saved potential roles +This method returns all saved potential roles (draft roles). + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-saved-potential-roles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSavedPotentialRolesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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 is supported for the following fields: **modified** | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningSessionDraftRoleDto**](../models/role-mining-session-draft-role-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sorters := `modified` // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (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 is supported for the following fields: **modified** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetSavedPotentialRoles(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetSavedPotentialRoles(context.Background()).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetSavedPotentialRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSavedPotentialRoles`: []RoleMiningSessionDraftRoleDto + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetSavedPotentialRoles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-potential-role +Update a potential role in session +This method updates an existing potential role using the role mining session id and the potential role summary id. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | The potential role summary id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **patchPotentialRoleRequestInner** | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json-patch+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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The potential role summary id # string | The potential role summary id + patchpotentialrolerequestinner := []byte(`[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]`) // []PatchPotentialRoleRequestInner | + + + var patchPotentialRoleRequestInner beta.[]PatchPotentialRoleRequestInner + if err := json.Unmarshal(patchpotentialrolerequestinner, &patchPotentialRoleRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.PatchPotentialRole(context.Background(), sessionId, potentialRoleId).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.PatchPotentialRole(context.Background(), sessionId, potentialRoleId).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPotentialRole`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-role-mining-potential-role +Update a potential role +This method updates an existing potential role. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-role-mining-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**potentialRoleId** | **string** | The potential role summary id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchRoleMiningPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **patchPotentialRoleRequestInner** | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json-patch+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() { + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The potential role summary id # string | The potential role summary id + patchpotentialrolerequestinner := []byte(`[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]`) // []PatchPotentialRoleRequestInner | + + + var patchPotentialRoleRequestInner beta.[]PatchPotentialRoleRequestInner + if err := json.Unmarshal(patchpotentialrolerequestinner, &patchPotentialRoleRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.PatchRoleMiningPotentialRole(context.Background(), potentialRoleId).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.PatchRoleMiningPotentialRole(context.Background(), potentialRoleId).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchRoleMiningPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchRoleMiningPotentialRole`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchRoleMiningPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-role-mining-session +Patch a role mining session +The method updates an existing role mining session using PATCH. Supports op in {"replace"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-role-mining-session) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id to be patched | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchRoleMiningSessionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json-patch+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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id to be patched # string | The role mining session id to be patched + jsonpatchoperation := []byte(`[{op=replace, path=/pruneThreshold, value=83}, {op=replace, path=/minNumIdentitiesInPotentialRole, value=10}, {op=replace, path=/saved, value=false}, {op=replace, path=/name, value=RM Session - 07/10/22}, {op=add, path=/name, value=RM Session - 07/10/22}]`) // []JsonPatchOperation | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.PatchRoleMiningSession(context.Background(), sessionId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.PatchRoleMiningSession(context.Background(), sessionId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchRoleMiningSession``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchRoleMiningSession`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchRoleMiningSession`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-entitlements-potential-role +Edit entitlements for a potential role to exclude some entitlements +This endpoint adds or removes entitlements from an exclusion list for a potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-entitlements-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateEntitlementsPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **roleMiningPotentialRoleEditEntitlements** | [**RoleMiningPotentialRoleEditEntitlements**](../models/role-mining-potential-role-edit-entitlements) | Role mining session parameters | + +### Return type + +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + roleminingpotentialroleeditentitlements := []byte(`{ + "ids" : [ "entId1", "entId2" ], + "exclude" : true + }`) // RoleMiningPotentialRoleEditEntitlements | Role mining session parameters + + + var roleMiningPotentialRoleEditEntitlements beta.RoleMiningPotentialRoleEditEntitlements + if err := json.Unmarshal(roleminingpotentialroleeditentitlements, &roleMiningPotentialRoleEditEntitlements); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.UpdateEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).RoleMiningPotentialRoleEditEntitlements(roleMiningPotentialRoleEditEntitlements).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.UpdateEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).RoleMiningPotentialRoleEditEntitlements(roleMiningPotentialRoleEditEntitlements).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.UpdateEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateEntitlementsPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.UpdateEntitlementsPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IconsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IconsAPI.md new file mode 100644 index 000000000..3f712264a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IconsAPI.md @@ -0,0 +1,161 @@ +--- +id: beta-icons +title: Icons +pagination_label: Icons +sidebar_label: Icons +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Icons', 'BetaIcons'] +slug: /tools/sdk/go/beta/methods/icons +tags: ['SDK', 'Software Development Kit', 'Icons', 'BetaIcons'] +--- + +# IconsAPI + Use this API to implement functionality related to object icons (application icons for example). +With this functionality in place, administrators can set or remove an icon for specific object type for use throughout Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-icon**](#delete-icon) | **Delete** `/icons/{objectType}/{objectId}` | Delete an icon +[**set-icon**](#set-icon) | **Put** `/icons/{objectType}/{objectId}` | Update an icon + + +## delete-icon +Delete an icon +This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-icon) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**objectType** | **string** | Object type | +**objectId** | **string** | Object id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIconRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + objectType := `application` // string | Object type # string | Object type + objectId := `a291e870-48c3-4953-b656-fb5ce2a93169` // string | Object id. # string | Object id. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.IconsAPI.DeleteIcon(context.Background(), objectType, objectId).Execute() + //r, err := apiClient.Beta.IconsAPI.DeleteIcon(context.Background(), objectType, objectId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IconsAPI.DeleteIcon``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## set-icon +Update an icon +This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-icon) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**objectType** | **string** | Object type | +**objectId** | **string** | Object id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetIconRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **image** | ***os.File** | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] | + +### Return type + +[**SetIcon200Response**](../models/set-icon200-response) + +### 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() { + objectType := `application` // string | Object type # string | Object type + objectId := `a291e870-48c3-4953-b656-fb5ce2a93169` // string | Object id. # string | Object id. + image := BINARY_DATA_HERE // *os.File | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] # *os.File | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IconsAPI.SetIcon(context.Background(), objectType, objectId).Image(image).Execute() + //resp, r, err := apiClient.Beta.IconsAPI.SetIcon(context.Background(), objectType, objectId).Image(image).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IconsAPI.SetIcon``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetIcon`: SetIcon200Response + fmt.Fprintf(os.Stdout, "Response from `IconsAPI.SetIcon`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IdentitiesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IdentitiesAPI.md new file mode 100644 index 000000000..84dd152cd --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IdentitiesAPI.md @@ -0,0 +1,816 @@ +--- +id: beta-identities +title: Identities +pagination_label: Identities +sidebar_label: Identities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Identities', 'BetaIdentities'] +slug: /tools/sdk/go/beta/methods/identities +tags: ['SDK', 'Software Development Kit', 'Identities', 'BetaIdentities'] +--- + +# IdentitiesAPI + Use this API to implement identity functionality. +With this functionality in place, administrators can synchronize an identity's attributes with its various source attributes. + +Identity Security Cloud uses identities as users' authoritative accounts. Identities can own other accounts, entitlements, and attributes. + +An identity has a variety of attributes, such as an account name, an email address, a job title, and more. +These identity attributes can be correlated with different attributes on different sources. +For example, the identity John.Smith can own an account in the GitHub source with the account name John-Smith-Org, and Identity Security Cloud knows they are the same person with the same access and attributes. + +In Identity Security Cloud, administrators often set up these synchronizations to get triggered automatically with a change or to run on a schedule. +To manually synchronize attributes for an identity, administrators can use the Identities drop-down menu and select Identity List to view the list of identities. +They can then select the identity they want to manually synchronize and use the hamburger menu to select 'Synchronize Attributes.' +Doing so immediately begins the attribute synchronization and analyzes all accounts for the selected identity. + +Refer to [Synchronizing Attributes](https://documentation.sailpoint.com/saas/help/provisioning/attr_sync.html) for more information about synchronizing attributes. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-identity**](#delete-identity) | **Delete** `/identities/{id}` | Delete identity +[**get-identity**](#get-identity) | **Get** `/identities/{id}` | Identity Details +[**get-identity-ownership-details**](#get-identity-ownership-details) | **Get** `/identities/{identityId}/ownership` | Get ownership details +[**get-role-assignment**](#get-role-assignment) | **Get** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details +[**get-role-assignments**](#get-role-assignments) | **Get** `/identities/{identityId}/role-assignments` | List role assignments +[**list-identities**](#list-identities) | **Get** `/identities` | List Identities +[**reset-identity**](#reset-identity) | **Post** `/identities/{identityId}/reset` | Reset an identity +[**send-identity-verification-account-token**](#send-identity-verification-account-token) | **Post** `/identities/{id}/verification/account/send` | Send password reset email +[**start-identities-invite**](#start-identities-invite) | **Post** `/identities/invite` | Invite identities to register +[**start-identity-processing**](#start-identity-processing) | **Post** `/identities/process` | Process a list of identityIds +[**synchronize-attributes-for-identity**](#synchronize-attributes-for-identity) | **Post** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity. + + +## delete-identity +Delete identity +The API returns successful response if the requested identity was deleted. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Identity Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity Id # string | Identity Id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.IdentitiesAPI.DeleteIdentity(context.Background(), id).Execute() + //r, err := apiClient.Beta.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) + } +} +``` + +[[Back to top]](#) + +## get-identity +Identity Details +This API returns a single identity using the Identity ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Identity Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Identity**](../models/identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity Id # string | Identity Id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentitiesAPI.GetIdentity(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `GetIdentity`: Identity + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetIdentity`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-ownership-details +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. +For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity's owned objects. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-ownership-details) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | Identity ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityOwnershipDetailsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityOwnershipAssociationDetails**](../models/identity-ownership-association-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `ff8081814d2a8036014d701f3fbf53fa` // string | Identity ID. # string | Identity ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentitiesAPI.GetIdentityOwnershipDetails(context.Background(), identityId).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `GetIdentityOwnershipDetails`: IdentityOwnershipAssociationDetails + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetIdentityOwnershipDetails`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-assignment +Role assignment details + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-assignment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | Identity Id | +**assignmentId** | **string** | Assignment Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleAssignmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**RoleAssignmentDto**](../models/role-assignment-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity Id # string | Identity Id + assignmentId := `1cbb0705b38c4226b1334eadd8874086` // string | Assignment Id # string | Assignment Id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentitiesAPI.GetRoleAssignment(context.Background(), identityId, assignmentId).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `GetRoleAssignment`: RoleAssignmentDto + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetRoleAssignment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-assignments +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-assignments) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | Identity Id to get the role assignments for | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleAssignmentsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **roleId** | **string** | Role Id to filter the role assignments with | + **roleName** | **string** | Role name to filter the role assignments with | + +### Return type + +[**[]GetRoleAssignments200ResponseInner**](../models/get-role-assignments200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity Id to get the role assignments for # string | Identity Id to get the role assignments for + 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) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentitiesAPI.GetRoleAssignments(context.Background(), identityId).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `GetRoleAssignments`: []GetRoleAssignments200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetRoleAssignments`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identities +List Identities +This API returns a list of identities. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentitiesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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"] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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 + +[**[]Identity**](../models/identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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") + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.IdentitiesAPI.ListIdentities(context.Background()).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `ListIdentities`: []Identity + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.ListIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reset-identity +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. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/reset-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | Identity Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiResetIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity Id # string | Identity Id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.IdentitiesAPI.ResetIdentity(context.Background(), identityId).Execute() + //r, err := apiClient.Beta.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) + } +} +``` + +[[Back to top]](#) + +## send-identity-verification-account-token +Send password reset email +This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-identity-verification-account-token) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Identity ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendIdentityVerificationAccountTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **sendAccountVerificationRequest** | [**SendAccountVerificationRequest**](../models/send-account-verification-request) | | + +### Return type + + (empty response body) + +### 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 := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + sendaccountverificationrequest := []byte(`{ + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" + }`) // SendAccountVerificationRequest | + + + var sendAccountVerificationRequest beta.SendAccountVerificationRequest + if err := json.Unmarshal(sendaccountverificationrequest, &sendAccountVerificationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.IdentitiesAPI.SendIdentityVerificationAccountToken(context.Background(), id).SendAccountVerificationRequest(sendAccountVerificationRequest).Execute() + //r, err := apiClient.Beta.IdentitiesAPI.SendIdentityVerificationAccountToken(context.Background(), id).SendAccountVerificationRequest(sendAccountVerificationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.SendIdentityVerificationAccountToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## start-identities-invite +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. + +This task will send an invitation email only for unregistered identities. + +The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-identities-invite) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartIdentitiesInviteRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **inviteIdentitiesRequest** | [**InviteIdentitiesRequest**](../models/invite-identities-request) | | + +### Return type + +[**TaskStatus**](../models/task-status) + +### 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() { + inviteidentitiesrequest := []byte(`{ + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false + }`) // InviteIdentitiesRequest | + + + var inviteIdentitiesRequest beta.InviteIdentitiesRequest + if err := json.Unmarshal(inviteidentitiesrequest, &inviteIdentitiesRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentitiesAPI.StartIdentitiesInvite(context.Background()).InviteIdentitiesRequest(inviteIdentitiesRequest).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `StartIdentitiesInvite`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.StartIdentitiesInvite`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-identity-processing +Process a list of identityIds +This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. + +This endpoint will perform the following tasks: +1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change). +2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. +3. Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health). +4. Recalculate manager relationships. +5. Potentially clean-up identity processing errors, assuming the error has been resolved. + +A token with ORG_ADMIN or HELPDESK authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-identity-processing) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartIdentityProcessingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **processIdentitiesRequest** | [**ProcessIdentitiesRequest**](../models/process-identities-request) | | + +### Return type + +[**TaskResultResponse**](../models/task-result-response) + +### 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() { + processidentitiesrequest := []byte(`{ + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + }`) // ProcessIdentitiesRequest | + + + var processIdentitiesRequest beta.ProcessIdentitiesRequest + if err := json.Unmarshal(processidentitiesrequest, &processIdentitiesRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentitiesAPI.StartIdentityProcessing(context.Background()).ProcessIdentitiesRequest(processIdentitiesRequest).Execute() + //resp, r, err := apiClient.Beta.IdentitiesAPI.StartIdentityProcessing(context.Background()).ProcessIdentitiesRequest(processIdentitiesRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.StartIdentityProcessing``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartIdentityProcessing`: TaskResultResponse + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.StartIdentityProcessing`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## synchronize-attributes-for-identity +Attribute synchronization for single identity. +This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/synchronize-attributes-for-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | The Identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSynchronizeAttributesForIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentitySyncJob**](../models/identity-sync-job) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `identityId_example` // string | The Identity id # string | The Identity id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentitiesAPI.SynchronizeAttributesForIdentity(context.Background(), identityId).Execute() + //resp, r, err := apiClient.Beta.IdentitiesAPI.SynchronizeAttributesForIdentity(context.Background(), identityId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.SynchronizeAttributesForIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SynchronizeAttributesForIdentity`: IdentitySyncJob + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.SynchronizeAttributesForIdentity`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IdentityAttributesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IdentityAttributesAPI.md new file mode 100644 index 000000000..e00e1958a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IdentityAttributesAPI.md @@ -0,0 +1,475 @@ +--- +id: beta-identity-attributes +title: IdentityAttributes +pagination_label: IdentityAttributes +sidebar_label: IdentityAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributes', 'BetaIdentityAttributes'] +slug: /tools/sdk/go/beta/methods/identity-attributes +tags: ['SDK', 'Software Development Kit', 'IdentityAttributes', 'BetaIdentityAttributes'] +--- + +# IdentityAttributesAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-identity-attribute**](#create-identity-attribute) | **Post** `/identity-attributes` | Create Identity Attribute +[**delete-identity-attribute**](#delete-identity-attribute) | **Delete** `/identity-attributes/{name}` | Delete Identity Attribute +[**delete-identity-attributes-in-bulk**](#delete-identity-attributes-in-bulk) | **Delete** `/identity-attributes/bulk-delete` | Bulk delete Identity Attributes +[**get-identity-attribute**](#get-identity-attribute) | **Get** `/identity-attributes/{name}` | Get Identity Attribute +[**list-identity-attributes**](#list-identity-attributes) | **Get** `/identity-attributes` | List Identity Attributes +[**put-identity-attribute**](#put-identity-attribute) | **Put** `/identity-attributes/{name}` | Update Identity Attribute + + +## create-identity-attribute +Create Identity Attribute +Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-identity-attribute) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateIdentityAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityAttribute** | [**IdentityAttribute**](../models/identity-attribute) | | + +### Return type + +[**IdentityAttribute**](../models/identity-attribute) + +### 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() { + identityattribute := []byte(`{ + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + }`) // IdentityAttribute | + + + var identityAttribute beta.IdentityAttribute + if err := json.Unmarshal(identityattribute, &identityAttribute); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityAttributesAPI.CreateIdentityAttribute(context.Background()).IdentityAttribute(identityAttribute).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `CreateIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.CreateIdentityAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-identity-attribute +Delete Identity Attribute +This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The attribute's technical name. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `displayName` // string | The attribute's technical name. # string | The attribute's technical name. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.IdentityAttributesAPI.DeleteIdentityAttribute(context.Background(), name).Execute() + //r, err := apiClient.Beta.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) + } +} +``` + +[[Back to top]](#) + +## delete-identity-attributes-in-bulk +Bulk delete Identity Attributes +Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-attributes-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityAttributesInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityAttributeNames** | [**IdentityAttributeNames**](../models/identity-attribute-names) | | + +### Return type + + (empty response body) + +### 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() { + identityattributenames := []byte(`{ + "ids" : [ "name", "displayName" ] + }`) // IdentityAttributeNames | + + + var identityAttributeNames beta.IdentityAttributeNames + if err := json.Unmarshal(identityattributenames, &identityAttributeNames); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.IdentityAttributesAPI.DeleteIdentityAttributesInBulk(context.Background()).IdentityAttributeNames(identityAttributeNames).Execute() + //r, err := apiClient.Beta.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) + } +} +``` + +[[Back to top]](#) + +## get-identity-attribute +Get Identity Attribute +This gets an identity attribute for a given technical name. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The attribute's technical name. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityAttribute**](../models/identity-attribute) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `displayName` // string | The attribute's technical name. # string | The attribute's technical name. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityAttributesAPI.GetIdentityAttribute(context.Background(), name).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `GetIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.GetIdentityAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-attributes +List Identity Attributes +Use this API to get a collection of identity attributes. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-attributes) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]IdentityAttribute**](../models/identity-attribute) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityAttributesAPI.ListIdentityAttributes(context.Background()).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `ListIdentityAttributes`: []IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.ListIdentityAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-identity-attribute +Update Identity Attribute +This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-identity-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The attribute's technical name. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutIdentityAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **identityAttribute** | [**IdentityAttribute**](../models/identity-attribute) | | + +### Return type + +[**IdentityAttribute**](../models/identity-attribute) + +### 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() { + name := `displayName` // string | The attribute's technical name. # string | The attribute's technical name. + identityattribute := []byte(`{ + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + }`) // IdentityAttribute | + + + var identityAttribute beta.IdentityAttribute + if err := json.Unmarshal(identityattribute, &identityAttribute); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityAttributesAPI.PutIdentityAttribute(context.Background(), name).IdentityAttribute(identityAttribute).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `PutIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.PutIdentityAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IdentityHistoryAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IdentityHistoryAPI.md new file mode 100644 index 000000000..c809dc485 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IdentityHistoryAPI.md @@ -0,0 +1,843 @@ +--- +id: beta-identity-history +title: IdentityHistory +pagination_label: IdentityHistory +sidebar_label: IdentityHistory +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityHistory', 'BetaIdentityHistory'] +slug: /tools/sdk/go/beta/methods/identity-history +tags: ['SDK', 'Software Development Kit', 'IdentityHistory', 'BetaIdentityHistory'] +--- + +# IdentityHistoryAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**compare-identity-snapshots**](#compare-identity-snapshots) | **Get** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots +[**compare-identity-snapshots-access-type**](#compare-identity-snapshots-access-type) | **Get** `/historical-identities/{id}/compare/{accessType}` | Gets a list of differences of specific accessType for the given identity between 2 snapshots +[**get-historical-identity**](#get-historical-identity) | **Get** `/historical-identities/{id}` | Get latest snapshot of identity +[**get-historical-identity-events**](#get-historical-identity-events) | **Get** `/historical-identities/{id}/events` | Lists all events for the given identity +[**get-identity-snapshot**](#get-identity-snapshot) | **Get** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date +[**get-identity-snapshot-summary**](#get-identity-snapshot-summary) | **Get** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity +[**get-identity-start-date**](#get-identity-start-date) | **Get** `/historical-identities/{id}/start-date` | Gets the start date of the identity +[**list-historical-identities**](#list-historical-identities) | **Get** `/historical-identities` | Lists all the identities +[**list-identity-access-items**](#list-identity-access-items) | **Get** `/historical-identities/{id}/access-items` | List Access Items by Identity +[**list-identity-snapshot-access-items**](#list-identity-snapshot-access-items) | **Get** `/historical-identities/{id}/snapshots/{date}/access-items` | Get Identity Access Items Snapshot +[**list-identity-snapshots**](#list-identity-snapshots) | **Get** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity + + +## compare-identity-snapshots +Gets a difference of count for each access item types for the given identity between 2 snapshots +This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/compare-identity-snapshots) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompareIdentitySnapshotsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **snapshot1** | **string** | The snapshot 1 of identity | + **snapshot2** | **string** | The snapshot 2 of identity | + **accessItemTypes** | **[]string** | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]IdentityCompareResponse**](../models/identity-compare-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + snapshot1 := `2007-03-01T13:00:00Z` // string | The snapshot 1 of identity (optional) # string | The snapshot 1 of identity (optional) + snapshot2 := `2008-03-01T13:00:00Z` // string | The snapshot 2 of identity (optional) # string | The snapshot 2 of identity (optional) + accessitemtypes := []byte(``) // []string | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.CompareIdentitySnapshots(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.CompareIdentitySnapshots(context.Background(), id).Snapshot1(snapshot1).Snapshot2(snapshot2).AccessItemTypes(accessItemTypes).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.CompareIdentitySnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompareIdentitySnapshots`: []IdentityCompareResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.CompareIdentitySnapshots`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## compare-identity-snapshots-access-type +Gets a list of differences of specific accessType for the given identity between 2 snapshots +This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/compare-identity-snapshots-access-type) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | +**accessType** | **string** | The specific type which needs to be compared | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompareIdentitySnapshotsAccessTypeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **accessAssociated** | **bool** | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed | + **snapshot1** | **string** | The snapshot 1 of identity | + **snapshot2** | **string** | The snapshot 2 of identity | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]AccessItemDiff**](../models/access-item-diff) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + accessType := `role` // string | The specific type which needs to be compared # string | The specific type which needs to be compared + accessAssociated := 2007-03-01T13:00:00Z // bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) # bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) + snapshot1 := `2008-03-01T13:00:00Z` // string | The snapshot 1 of identity (optional) # string | The snapshot 1 of identity (optional) + snapshot2 := `2009-03-01T13:00:00Z` // string | The snapshot 2 of identity (optional) # string | The snapshot 2 of identity (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.CompareIdentitySnapshotsAccessType(context.Background(), id, accessType).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.CompareIdentitySnapshotsAccessType(context.Background(), id, accessType).AccessAssociated(accessAssociated).Snapshot1(snapshot1).Snapshot2(snapshot2).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.CompareIdentitySnapshotsAccessType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompareIdentitySnapshotsAccessType`: []AccessItemDiff + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.CompareIdentitySnapshotsAccessType`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-historical-identity +Get latest snapshot of identity +This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-historical-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetHistoricalIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityHistoryResponse**](../models/identity-history-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetHistoricalIdentity(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetHistoricalIdentity(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetHistoricalIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetHistoricalIdentity`: IdentityHistoryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetHistoricalIdentity`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-historical-identity-events +Lists all events for the given identity +This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-historical-identity-events) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetHistoricalIdentityEventsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **from** | **string** | The optional instant until which access events are returned | + **eventTypes** | **[]string** | An optional list of event types to return. If null or empty, all events are returned | + **accessItemTypes** | **[]string** | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]GetHistoricalIdentityEvents200ResponseInner**](../models/get-historical-identity-events200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + from := `2024-03-01T13:00:00Z` // string | The optional instant until which access events are returned (optional) # string | The optional instant until which access events are returned (optional) + eventtypes := []byte(`[AccessAddedEvent, AccessRemovedEvent]`) // []string | An optional list of event types to return. If null or empty, all events are returned (optional) + accessitemtypes := []byte(`[entitlement, account]`) // []string | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetHistoricalIdentityEvents(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetHistoricalIdentityEvents(context.Background(), id).From(from).EventTypes(eventTypes).AccessItemTypes(accessItemTypes).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetHistoricalIdentityEvents``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetHistoricalIdentityEvents`: []GetHistoricalIdentityEvents200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetHistoricalIdentityEvents`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-snapshot +Gets an identity snapshot at a given date +This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-snapshot) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | +**date** | **string** | The specified date | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentitySnapshotRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**IdentityHistoryResponse**](../models/identity-history-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + date := `2007-03-01T13:00:00Z` // string | The specified date # string | The specified date + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetIdentitySnapshot(context.Background(), id, date).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetIdentitySnapshot(context.Background(), id, date).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentitySnapshot``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySnapshot`: IdentityHistoryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentitySnapshot`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-snapshot-summary +Gets the summary for the event count for a specific identity +This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-snapshot-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentitySnapshotSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **before** | **string** | The date before which snapshot summary is required | + **interval** | **string** | The interval indicating day or month. Defaults to month if not specified | + **timeZone** | **string** | The time zone. Defaults to UTC if not provided | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]MetricResponse**](../models/metric-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + before := `2007-03-01T13:00:00Z` // string | The date before which snapshot summary is required (optional) # string | The date before which snapshot summary is required (optional) + interval := `interval_example` // string | The interval indicating day or month. Defaults to month if not specified (optional) # string | The interval indicating day or month. Defaults to month if not specified (optional) + timeZone := `UTC` // string | The time zone. Defaults to UTC if not provided (optional) # string | The time zone. Defaults to UTC if not provided (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetIdentitySnapshotSummary(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetIdentitySnapshotSummary(context.Background(), id).Before(before).Interval(interval).TimeZone(timeZone).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentitySnapshotSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySnapshotSummary`: []MetricResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentitySnapshotSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-start-date +Gets the start date of the identity +This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-start-date) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityStartDateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetIdentityStartDate(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetIdentityStartDate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentityStartDate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityStartDate`: string + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentityStartDate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-historical-identities +Lists all the identities +This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-historical-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListHistoricalIdentitiesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **startsWithQuery** | **string** | This param is used for starts-with search for first, last and display name of the identity | + **isDeleted** | **bool** | Indicates if we want to only list down deleted identities or not. | + **isActive** | **bool** | Indicates if we want to only list active or inactive identities. | + **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 + +[**[]IdentityListItem**](../models/identity-list-item) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + startsWithQuery := `Ada` // string | This param is used for starts-with search for first, last and display name of the identity (optional) # string | This param is used for starts-with search for first, last and display name of the identity (optional) + isDeleted := true // bool | Indicates if we want to only list down deleted identities or not. (optional) # bool | Indicates if we want to only list down deleted identities or not. (optional) + isActive := true // bool | Indicates if we want to only list active or inactive identities. (optional) # bool | Indicates if we want to only list active or inactive identities. (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) + 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.IdentityHistoryAPI.ListHistoricalIdentities(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.ListHistoricalIdentities(context.Background()).StartsWithQuery(startsWithQuery).IsDeleted(isDeleted).IsActive(isActive).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListHistoricalIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListHistoricalIdentities`: []IdentityListItem + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListHistoricalIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-access-items +List Access Items by Identity +This method retrieves a list of access item for the identity filtered by the access item type + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-access-items) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityAccessItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **type_** | **string** | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** | + **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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** | + **query** | **string** | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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 + +[**[]ListIdentityAccessItems200ResponseInner**](../models/list-identity-access-items200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + type_ := `account` // string | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) # string | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) + filters := `source eq "DataScienceDataset"` // 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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (optional) + sorters := `name` // 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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) + query := `Dr. Arden` // string | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (optional) # string | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.IdentityHistoryAPI.ListIdentityAccessItems(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.ListIdentityAccessItems(context.Background(), id).Type_(type_).Filters(filters).Sorters(sorters).Query(query).Limit(limit).Count(count).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentityAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityAccessItems`: []ListIdentityAccessItems200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentityAccessItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-snapshot-access-items +Get Identity Access Items Snapshot +Use this API to get a list of identity access items at a specified date, filtered by item type. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-snapshot-access-items) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Identity ID. | +**date** | **string** | Specified date. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentitySnapshotAccessItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **type_** | **string** | Access item type. | + +### Return type + +[**[]ListIdentityAccessItems200ResponseInner**](../models/list-identity-access-items200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | Identity ID. # string | Identity ID. + date := `2007-03-01T13:00:00Z` // string | Specified date. # string | Specified date. + type_ := `account` // string | Access item type. (optional) # string | Access item type. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.ListIdentitySnapshotAccessItems(context.Background(), id, date).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.ListIdentitySnapshotAccessItems(context.Background(), id, date).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentitySnapshotAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentitySnapshotAccessItems`: []ListIdentityAccessItems200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentitySnapshotAccessItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-snapshots +Lists all the snapshots for the identity +This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-snapshots) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentitySnapshotsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **start** | **string** | The specified start date | + **interval** | **string** | The interval indicating the range in day or month for the specified interval-name | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]IdentitySnapshotSummaryResponse**](../models/identity-snapshot-summary-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + start := `2007-03-01T13:00:00Z` // string | The specified start date (optional) # string | The specified start date (optional) + interval := `interval_example` // string | The interval indicating the range in day or month for the specified interval-name (optional) # string | The interval indicating the range in day or month for the specified interval-name (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.ListIdentitySnapshots(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.ListIdentitySnapshots(context.Background(), id).Start(start).Interval(interval).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentitySnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentitySnapshots`: []IdentitySnapshotSummaryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentitySnapshots`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/IdentityProfilesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/IdentityProfilesAPI.md new file mode 100644 index 000000000..9c93daac7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/IdentityProfilesAPI.md @@ -0,0 +1,892 @@ +--- +id: beta-identity-profiles +title: IdentityProfiles +pagination_label: IdentityProfiles +sidebar_label: IdentityProfiles +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfiles', 'BetaIdentityProfiles'] +slug: /tools/sdk/go/beta/methods/identity-profiles +tags: ['SDK', 'Software Development Kit', 'IdentityProfiles', 'BetaIdentityProfiles'] +--- + +# IdentityProfilesAPI + Use this API to implement and customize identity profile functionality. +With this functionality in place, administrators can manage identity profiles and configure them for use by identities throughout Identity Security Cloud. + +Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. +This allows administrators to save time by applying identity profiles to any number of similar identities rather than configuring each one individually. + +In Identity Security Cloud, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. +This list shows some details about each identity profile, along with its status. They can select an identity profile to view and modify its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. +Administrators can also use this page to create new identity profiles or delete existing ones. + +Refer to [Creating Identity Profiles](https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html) for more information about identity profiles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-identity-profile**](#create-identity-profile) | **Post** `/identity-profiles` | Create Identity Profile +[**delete-identity-profile**](#delete-identity-profile) | **Delete** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile +[**delete-identity-profiles**](#delete-identity-profiles) | **Post** `/identity-profiles/bulk-delete` | Delete Identity Profiles +[**export-identity-profiles**](#export-identity-profiles) | **Get** `/identity-profiles/export` | Export Identity Profiles +[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **Get** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Default identity attribute config +[**get-identity-profile**](#get-identity-profile) | **Get** `/identity-profiles/{identity-profile-id}` | Get Identity Profile +[**import-identity-profiles**](#import-identity-profiles) | **Post** `/identity-profiles/import` | Import Identity Profiles +[**list-identity-profiles**](#list-identity-profiles) | **Get** `/identity-profiles` | List Identity Profiles +[**show-generate-identity-preview**](#show-generate-identity-preview) | **Post** `/identity-profiles/identity-preview` | Generate Identity Profile Preview +[**sync-identity-profile**](#sync-identity-profile) | **Post** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile +[**update-identity-profile**](#update-identity-profile) | **Patch** `/identity-profiles/{identity-profile-id}` | Update Identity Profile + + +## create-identity-profile +Create Identity Profile +Create an identity profile. +A token with ORG_ADMIN authority is required to call this API to create an Identity Profile. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-identity-profile) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityProfile** | [**IdentityProfile**](../models/identity-profile) | | + +### Return type + +[**IdentityProfile**](../models/identity-profile) + +### 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() { + identityprofile := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2023-01-03T21:16:22.432Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "id" : "id12345" + }`) // IdentityProfile | + + + var identityProfile beta.IdentityProfile + if err := json.Unmarshal(identityprofile, &identityProfile); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.CreateIdentityProfile(context.Background()).IdentityProfile(identityProfile).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.CreateIdentityProfile(context.Background()).IdentityProfile(identityProfile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.CreateIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.CreateIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-identity-profile +Delete Identity Profile +Delete an identity profile by ID. +On success, this endpoint will return a reference to the bulk delete task result. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**TaskResultSimplified**](../models/task-result-simplified) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.DeleteIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.DeleteIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.DeleteIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteIdentityProfile`: TaskResultSimplified + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.DeleteIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-identity-profiles +Delete Identity Profiles +This deletes multiple Identity Profiles via a list of supplied IDs. + +On success, this endpoint will return a reference to the bulk delete task result. + +A token with ORG_ADMIN authority is required to call this API. + +The following rights are required to access this endpoint: idn:identity-profile:delete + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityProfilesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestBody** | **[]string** | Identity Profile bulk delete request body. | + +### Return type + +[**TaskResultSimplified**](../models/task-result-simplified) + +### 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() { + requestbody := []byte(``) // []string | Identity Profile bulk delete request body. + + + var requestBody beta.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.DeleteIdentityProfiles(context.Background()).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.DeleteIdentityProfiles(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.DeleteIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteIdentityProfiles`: TaskResultSimplified + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.DeleteIdentityProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## export-identity-profiles +Export Identity Profiles +This exports existing identity profiles in the format specified by the sp-config service. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-identity-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportIdentityProfilesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ne* **name**: *eq, ne* **priority**: *eq, ne* | + **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: **id, name, priority** | + +### Return type + +[**[]IdentityProfileExportedObject**](../models/identity-profile-exported-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq 8c190e6787aa4ed9a90bd9d5344523fb` // 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, ne* **name**: *eq, ne* **priority**: *eq, ne* (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, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + sorters := `name,-priority` // 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: **id, name, priority** (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: **id, name, priority** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.ExportIdentityProfiles(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.ExportIdentityProfiles(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ExportIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportIdentityProfiles`: []IdentityProfileExportedObject + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ExportIdentityProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-default-identity-attribute-config +Default identity attribute config +This returns the default identity attribute config +A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-default-identity-attribute-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | The Identity Profile ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDefaultIdentityAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityAttributeConfig**](../models/identity-attribute-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | The Identity Profile ID # string | The Identity Profile ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.GetDefaultIdentityAttributeConfig(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.GetDefaultIdentityAttributeConfig(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GetDefaultIdentityAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDefaultIdentityAttributeConfig`: IdentityAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GetDefaultIdentityAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-profile +Get Identity Profile +Get a single identity profile by ID. +A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityProfile**](../models/identity-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.GetIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.GetIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GetIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GetIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-identity-profiles +Import Identity Profiles +This imports previously exported identity profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-identity-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportIdentityProfilesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityProfileExportedObject** | [**[]IdentityProfileExportedObject**](../models/identity-profile-exported-object) | Previously exported Identity Profiles. | + +### Return type + +[**ObjectImportResult**](../models/object-import-result) + +### 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() { + identityprofileexportedobject := []byte(``) // []IdentityProfileExportedObject | Previously exported Identity Profiles. + + + var identityProfileExportedObject beta.[]IdentityProfileExportedObject + if err := json.Unmarshal(identityprofileexportedobject, &identityProfileExportedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.ImportIdentityProfiles(context.Background()).IdentityProfileExportedObject(identityProfileExportedObject).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.ImportIdentityProfiles(context.Background()).IdentityProfileExportedObject(identityProfileExportedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ImportIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportIdentityProfiles`: ObjectImportResult + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ImportIdentityProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-profiles +List Identity Profiles +Get a list of identity profiles, based on the specified query parameters. +A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityProfilesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* | + **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: **id, name, priority, created, modified, owner.id, owner.name** | + +### Return type + +[**[]IdentityProfile**](../models/identity-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq 8c190e6787aa4ed9a90bd9d5344523fb` // 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) + sorters := `name,-priority` // 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: **id, name, priority, created, modified, owner.id, owner.name** (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: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.ListIdentityProfiles(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.ListIdentityProfiles(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ListIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityProfiles`: []IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ListIdentityProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## show-generate-identity-preview +Generate Identity Profile Preview +Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. +This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. +A token with ORG_ADMIN authority is required to call this API to generate an identity preview. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/show-generate-identity-preview) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiShowGenerateIdentityPreviewRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityPreviewRequest** | [**IdentityPreviewRequest**](../models/identity-preview-request) | Identity Preview request body. | + +### Return type + +[**IdentityPreviewResponse**](../models/identity-preview-response) + +### 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() { + identitypreviewrequest := []byte(`{ + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + }`) // IdentityPreviewRequest | Identity Preview request body. + + + var identityPreviewRequest beta.IdentityPreviewRequest + if err := json.Unmarshal(identitypreviewrequest, &identityPreviewRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.ShowGenerateIdentityPreview(context.Background()).IdentityPreviewRequest(identityPreviewRequest).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.ShowGenerateIdentityPreview(context.Background()).IdentityPreviewRequest(identityPreviewRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ShowGenerateIdentityPreview``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ShowGenerateIdentityPreview`: IdentityPreviewResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ShowGenerateIdentityPreview`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## sync-identity-profile +Process identities under profile +Process identities under the profile +This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. +This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. +This operation will perform the following activities on all identities under the identity profile. +1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/sync-identity-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | The Identity Profile ID to be processed | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSyncIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | The Identity Profile ID to be processed # string | The Identity Profile ID to be processed + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.SyncIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.SyncIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.SyncIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SyncIdentityProfile`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.SyncIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-identity-profile +Update Identity Profile +Update the specified identity profile with this PATCH request. +A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. +These fields cannot be updated: +* id +* created +* modified +* identityCount +* identityRefreshRequired +* Authoritative Source and Identity Attribute Configuration cannot be modified at once. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-identity-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +[**IdentityProfile**](../models/identity-profile) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + jsonpatchoperation := []byte(`[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]`) // []JsonPatchOperation | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.UpdateIdentityProfile(context.Background(), identityProfileId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.UpdateIdentityProfile(context.Background(), identityProfileId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.UpdateIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.UpdateIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/Index.md b/docs/tools/sdk/go/Reference/Beta/Methods/Index.md new file mode 100644 index 000000000..2798dd52b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/Index.md @@ -0,0 +1,29 @@ +--- +id: methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_class_name: methods +keywords: ['go', 'Golang', 'sdk', 'methods'] +slug: /tools/sdk/go/beta/methods +tags: ['SDK', 'Software Development Kit', 'beta', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the Python SDK for **Beta** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/LaunchersAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/LaunchersAPI.md new file mode 100644 index 000000000..8d06ddcd2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/LaunchersAPI.md @@ -0,0 +1,452 @@ +--- +id: beta-launchers +title: Launchers +pagination_label: Launchers +sidebar_label: Launchers +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Launchers', 'BetaLaunchers'] +slug: /tools/sdk/go/beta/methods/launchers +tags: ['SDK', 'Software Development Kit', 'Launchers', 'BetaLaunchers'] +--- + +# LaunchersAPI + Use this API to manage Launchers. + +Launchers are objects that allow users to launch various tasks from ISC such as Privileged Workflows. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-launcher**](#create-launcher) | **Post** `/launchers` | Create launcher +[**delete-launcher**](#delete-launcher) | **Delete** `/launchers/{launcherID}` | Delete Launcher +[**get-launcher**](#get-launcher) | **Get** `/launchers/{launcherID}` | Get Launcher by ID +[**get-launchers**](#get-launchers) | **Get** `/launchers` | List all Launchers for tenant +[**put-launcher**](#put-launcher) | **Put** `/launchers/{launcherID}` | Replace Launcher +[**start-launcher**](#start-launcher) | **Post** `/beta/launchers/{launcherID}/launch` | Launch a Launcher + + +## create-launcher +Create launcher +Create a Launcher with given information + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-launcher) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateLauncherRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **launcherRequest** | [**LauncherRequest**](../models/launcher-request) | Payload to create a Launcher | + +### Return type + +[**Launcher**](../models/launcher) + +### 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() { + launcherrequest := []byte(`{ + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + }`) // LauncherRequest | Payload to create a Launcher + + + var launcherRequest beta.LauncherRequest + if err := json.Unmarshal(launcherrequest, &launcherRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.LaunchersAPI.CreateLauncher(context.Background()).LauncherRequest(launcherRequest).Execute() + //resp, r, err := apiClient.Beta.LaunchersAPI.CreateLauncher(context.Background()).LauncherRequest(launcherRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LaunchersAPI.CreateLauncher``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateLauncher`: Launcher + fmt.Fprintf(os.Stdout, "Response from `LaunchersAPI.CreateLauncher`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-launcher +Delete Launcher +Delete the given Launcher ID + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-launcher) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**launcherID** | **string** | ID of the Launcher to be deleted | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteLauncherRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + launcherID := `e3012408-8b61-4564-ad41-c5ec131c325b` // string | ID of the Launcher to be deleted # string | ID of the Launcher to be deleted + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.LaunchersAPI.DeleteLauncher(context.Background(), launcherID).Execute() + //r, err := apiClient.Beta.LaunchersAPI.DeleteLauncher(context.Background(), launcherID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LaunchersAPI.DeleteLauncher``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-launcher +Get Launcher by ID +Get details for the given Launcher ID + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-launcher) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**launcherID** | **string** | ID of the Launcher to be retrieved | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLauncherRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Launcher**](../models/launcher) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + launcherID := `e3012408-8b61-4564-ad41-c5ec131c325b` // string | ID of the Launcher to be retrieved # string | ID of the Launcher to be retrieved + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.LaunchersAPI.GetLauncher(context.Background(), launcherID).Execute() + //resp, r, err := apiClient.Beta.LaunchersAPI.GetLauncher(context.Background(), launcherID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LaunchersAPI.GetLauncher``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLauncher`: Launcher + fmt.Fprintf(os.Stdout, "Response from `LaunchersAPI.GetLauncher`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-launchers +List all Launchers for tenant +Return a list of Launchers for the authenticated tenant + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-launchers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLaunchersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **description**: *sw* **disabled**: *eq* **name**: *sw* | + **next** | **string** | Pagination marker | + **limit** | **int32** | Number of Launchers to return | [default to 10] + +### Return type + +[**GetLaunchers200Response**](../models/get-launchers200-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `disabled eq "true"` // 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: **description**: *sw* **disabled**: *eq* **name**: *sw* (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: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) + next := `eyJuZXh0IjoxMjN9Cg==` // string | Pagination marker (optional) # string | Pagination marker (optional) + limit := 42 // int32 | Number of Launchers to return (optional) (default to 10) # int32 | Number of Launchers to return (optional) (default to 10) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.LaunchersAPI.GetLaunchers(context.Background()).Execute() + //resp, r, err := apiClient.Beta.LaunchersAPI.GetLaunchers(context.Background()).Filters(filters).Next(next).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LaunchersAPI.GetLaunchers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLaunchers`: GetLaunchers200Response + fmt.Fprintf(os.Stdout, "Response from `LaunchersAPI.GetLaunchers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-launcher +Replace Launcher +Replace the given Launcher ID with given payload + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-launcher) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**launcherID** | **string** | ID of the Launcher to be replaced | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutLauncherRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **launcherRequest** | [**LauncherRequest**](../models/launcher-request) | Payload to replace Launcher | + +### Return type + +[**Launcher**](../models/launcher) + +### 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() { + launcherID := `e3012408-8b61-4564-ad41-c5ec131c325b` // string | ID of the Launcher to be replaced # string | ID of the Launcher to be replaced + launcherrequest := []byte(`{ + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + }`) // LauncherRequest | Payload to replace Launcher + + + var launcherRequest beta.LauncherRequest + if err := json.Unmarshal(launcherrequest, &launcherRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.LaunchersAPI.PutLauncher(context.Background(), launcherID).LauncherRequest(launcherRequest).Execute() + //resp, r, err := apiClient.Beta.LaunchersAPI.PutLauncher(context.Background(), launcherID).LauncherRequest(launcherRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LaunchersAPI.PutLauncher``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutLauncher`: Launcher + fmt.Fprintf(os.Stdout, "Response from `LaunchersAPI.PutLauncher`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-launcher +Launch a Launcher +Launch the given Launcher ID + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-launcher) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**launcherID** | **string** | ID of the Launcher to be launched | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartLauncherRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**StartLauncher200Response**](../models/start-launcher200-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + launcherID := `e3012408-8b61-4564-ad41-c5ec131c325b` // string | ID of the Launcher to be launched # string | ID of the Launcher to be launched + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.LaunchersAPI.StartLauncher(context.Background(), launcherID).Execute() + //resp, r, err := apiClient.Beta.LaunchersAPI.StartLauncher(context.Background(), launcherID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LaunchersAPI.StartLauncher``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartLauncher`: StartLauncher200Response + fmt.Fprintf(os.Stdout, "Response from `LaunchersAPI.StartLauncher`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/LifecycleStatesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/LifecycleStatesAPI.md new file mode 100644 index 000000000..864a69fc6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/LifecycleStatesAPI.md @@ -0,0 +1,209 @@ +--- +id: beta-lifecycle-states +title: LifecycleStates +pagination_label: LifecycleStates +sidebar_label: LifecycleStates +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LifecycleStates', 'BetaLifecycleStates'] +slug: /tools/sdk/go/beta/methods/lifecycle-states +tags: ['SDK', 'Software Development Kit', 'LifecycleStates', 'BetaLifecycleStates'] +--- + +# LifecycleStatesAPI + Use this API to implement and customize lifecycle state functionality. +With this functionality in place, administrators can view and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have. + +A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with Identity Security Cloud: 'Active' and 'Inactive.' +When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. +The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. +This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. + +Administrators must define the criteria for being in each lifecycle state, and they must define how Identity Security Cloud manages users' access to apps and sources for each lifecycle state. + +In Identity Security Cloud, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to select the lifecycle state they want to modify. + +In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: + +- Enable/disable the lifecycle state for the identity profile. + +- Enable/disable source accounts for the identity profile's lifecycle state. + +- Add existing access profiles to grant to the identity profiles in that lifecycle state. + +- Create a new access profile to grant to the identity profile in that lifecycle state. + +Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. +To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. +For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states. + +During scheduled refreshes, Identity Security Cloud evaluates lifecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. +If the identities are missing access, Identity Security Cloud provisions that access. + +Administrators can also use the 'Provisioning' tab to configure email notifications for Identity Security Cloud to send whenever an identity with that identity profile has a lifecycle state change. +Refer to [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so. + +An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' +Refer to [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. + +Refer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-lifecycle-states**](#get-lifecycle-states) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State +[**update-lifecycle-states**](#update-lifecycle-states) | **Patch** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State + + +## get-lifecycle-states +Get Lifecycle State +Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. + +A token with ORG_ADMIN or API authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-lifecycle-states) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity Profile ID. | +**lifecycleStateId** | **string** | Lifecycle State ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLifecycleStatesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**LifecycleState**](../models/lifecycle-state) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.LifecycleStatesAPI.GetLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).Execute() + //resp, r, err := apiClient.Beta.LifecycleStatesAPI.GetLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.GetLifecycleStates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLifecycleStates`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.GetLifecycleStates`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-lifecycle-states +Update Lifecycle State +Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +A token with ORG_ADMIN or API authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-lifecycle-states) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity Profile ID. | +**lifecycleStateId** | **string** | Lifecycle State ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateLifecycleStatesRequest struct via the builder pattern + + +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 | + +### Return type + +[**LifecycleState**](../models/lifecycle-state) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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() { + 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 + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.LifecycleStatesAPI.UpdateLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.LifecycleStatesAPI.UpdateLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.UpdateLifecycleStates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateLifecycleStates`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.UpdateLifecycleStates`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/MFAConfigurationAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/MFAConfigurationAPI.md new file mode 100644 index 000000000..ee8ac4964 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/MFAConfigurationAPI.md @@ -0,0 +1,555 @@ +--- +id: beta-mfa-configuration +title: MFAConfiguration +pagination_label: MFAConfiguration +sidebar_label: MFAConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MFAConfiguration', 'BetaMFAConfiguration'] +slug: /tools/sdk/go/beta/methods/mfa-configuration +tags: ['SDK', 'Software Development Kit', 'MFAConfiguration', 'BetaMFAConfiguration'] +--- + +# MFAConfigurationAPI + Configure and test multifactor authentication (MFA) methods +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-mfa-config**](#delete-mfa-config) | **Delete** `/mfa/{method}/delete` | Delete MFA method configuration +[**get-mfa-duo-config**](#get-mfa-duo-config) | **Get** `/mfa/duo-web/config` | Configuration of Duo MFA method +[**get-mfa-kba-config**](#get-mfa-kba-config) | **Get** `/mfa/kba/config` | Configuration of KBA MFA method +[**get-mfa-okta-config**](#get-mfa-okta-config) | **Get** `/mfa/okta-verify/config` | Configuration of Okta MFA method +[**set-mfa-duo-config**](#set-mfa-duo-config) | **Put** `/mfa/duo-web/config` | Set Duo MFA configuration +[**set-mfakba-config**](#set-mfakba-config) | **Post** `/mfa/kba/config/answers` | Set MFA KBA configuration +[**set-mfa-okta-config**](#set-mfa-okta-config) | **Put** `/mfa/okta-verify/config` | Set Okta MFA configuration +[**test-mfa-config**](#test-mfa-config) | **Get** `/mfa/{method}/test` | MFA method's test configuration + + +## delete-mfa-config +Delete MFA method configuration +This API removes the configuration for the specified MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-mfa-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**method** | **string** | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteMFAConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**MfaOktaConfig**](../models/mfa-okta-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + method := `okta-verify` // string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAConfigurationAPI.DeleteMFAConfig(context.Background(), method).Execute() + //resp, r, err := apiClient.Beta.MFAConfigurationAPI.DeleteMFAConfig(context.Background(), method).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.DeleteMFAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteMFAConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.DeleteMFAConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-mfa-duo-config +Configuration of Duo MFA method +This API returns the configuration of an Duo MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-duo-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMFADuoConfigRequest struct via the builder pattern + + +### Return type + +[**MfaDuoConfig**](../models/mfa-duo-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAConfigurationAPI.GetMFADuoConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.MFAConfigurationAPI.GetMFADuoConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFADuoConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFADuoConfig`: MfaDuoConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFADuoConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-mfa-kba-config +Configuration of KBA MFA method +This API returns the KBA configuration for MFA. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-kba-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMFAKbaConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allLanguages** | **bool** | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false | + +### Return type + +[**[]KbaQuestion**](../models/kba-question) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + allLanguages := allLanguages=true // bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAConfigurationAPI.GetMFAKbaConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.MFAConfigurationAPI.GetMFAKbaConfig(context.Background()).AllLanguages(allLanguages).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFAKbaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFAKbaConfig`: []KbaQuestion + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFAKbaConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-mfa-okta-config +Configuration of Okta MFA method +This API returns the configuration of an Okta MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-okta-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMFAOktaConfigRequest struct via the builder pattern + + +### Return type + +[**MfaOktaConfig**](../models/mfa-okta-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAConfigurationAPI.GetMFAOktaConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.MFAConfigurationAPI.GetMFAOktaConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFAOktaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFAOktaConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFAOktaConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-mfa-duo-config +Set Duo MFA configuration +This API sets the configuration of an Duo MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-mfa-duo-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetMFADuoConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mfaDuoConfig** | [**MfaDuoConfig**](../models/mfa-duo-config) | | + +### Return type + +[**MfaDuoConfig**](../models/mfa-duo-config) + +### 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() { + mfaduoconfig := []byte(`{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }`) // MfaDuoConfig | + + + var mfaDuoConfig beta.MfaDuoConfig + if err := json.Unmarshal(mfaduoconfig, &mfaDuoConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAConfigurationAPI.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute() + //resp, r, err := apiClient.Beta.MFAConfigurationAPI.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFADuoConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFADuoConfig`: MfaDuoConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFADuoConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-mfakba-config +Set MFA KBA configuration +This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-mfakba-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetMFAKBAConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **kbaAnswerRequestItem** | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | | + +### Return type + +[**[]KbaAnswerResponseItem**](../models/kba-answer-response-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() { + kbaanswerrequestitem := []byte(`[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]`) // []KbaAnswerRequestItem | + + + var kbaAnswerRequestItem beta.[]KbaAnswerRequestItem + if err := json.Unmarshal(kbaanswerrequestitem, &kbaAnswerRequestItem); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAConfigurationAPI.SetMFAKBAConfig(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + //resp, r, err := apiClient.Beta.MFAConfigurationAPI.SetMFAKBAConfig(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFAKBAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFAKBAConfig`: []KbaAnswerResponseItem + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFAKBAConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-mfa-okta-config +Set Okta MFA configuration +This API sets the configuration of an Okta MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-mfa-okta-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetMFAOktaConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mfaOktaConfig** | [**MfaOktaConfig**](../models/mfa-okta-config) | | + +### Return type + +[**MfaOktaConfig**](../models/mfa-okta-config) + +### 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() { + mfaoktaconfig := []byte(`{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }`) // MfaOktaConfig | + + + var mfaOktaConfig beta.MfaOktaConfig + if err := json.Unmarshal(mfaoktaconfig, &mfaOktaConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAConfigurationAPI.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute() + //resp, r, err := apiClient.Beta.MFAConfigurationAPI.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFAOktaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFAOktaConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFAOktaConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-mfa-config +MFA method's test configuration +This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-mfa-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**method** | **string** | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestMFAConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**MfaConfigTestResponse**](../models/mfa-config-test-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + method := `okta-verify` // string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAConfigurationAPI.TestMFAConfig(context.Background(), method).Execute() + //resp, r, err := apiClient.Beta.MFAConfigurationAPI.TestMFAConfig(context.Background(), method).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.TestMFAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestMFAConfig`: MfaConfigTestResponse + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.TestMFAConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/MFAControllerAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/MFAControllerAPI.md new file mode 100644 index 000000000..27b48f28b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/MFAControllerAPI.md @@ -0,0 +1,453 @@ +--- +id: beta-mfa-controller +title: MFAController +pagination_label: MFAController +sidebar_label: MFAController +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MFAController', 'BetaMFAController'] +slug: /tools/sdk/go/beta/methods/mfa-controller +tags: ['SDK', 'Software Development Kit', 'MFAController', 'BetaMFAController'] +--- + +# MFAControllerAPI + This API used for multifactor authentication functionality belong to gov-multi-auth service. This controller allow you to verify authentication by specified method +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-send-token**](#create-send-token) | **Post** `/mfa/token/send` | Create and send user token +[**ping-verification-status**](#ping-verification-status) | **Post** `/mfa/{method}/poll` | Polling MFA method by VerificationPollRequest +[**send-duo-verify-request**](#send-duo-verify-request) | **Post** `/mfa/duo-web/verify` | Verifying authentication via Duo method +[**send-kba-answers**](#send-kba-answers) | **Post** `/mfa/kba/authenticate` | Authenticate KBA provided MFA method +[**send-okta-verify-request**](#send-okta-verify-request) | **Post** `/mfa/okta-verify/verify` | Verifying authentication via Okta method +[**send-token-auth-request**](#send-token-auth-request) | **Post** `/mfa/token/authenticate` | Authenticate Token provided MFA method + + +## create-send-token +Create and send user token +This API send token request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-send-token) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSendTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sendTokenRequest** | [**SendTokenRequest**](../models/send-token-request) | | + +### Return type + +[**SendTokenResponse**](../models/send-token-response) + +### 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() { + sendtokenrequest := []byte(`{ + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + }`) // SendTokenRequest | + + + var sendTokenRequest beta.SendTokenRequest + if err := json.Unmarshal(sendtokenrequest, &sendTokenRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAControllerAPI.CreateSendToken(context.Background()).SendTokenRequest(sendTokenRequest).Execute() + //resp, r, err := apiClient.Beta.MFAControllerAPI.CreateSendToken(context.Background()).SendTokenRequest(sendTokenRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.CreateSendToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSendToken`: SendTokenResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.CreateSendToken`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## ping-verification-status +Polling MFA method by VerificationPollRequest +This API poll the VerificationPollRequest for the specified MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/ping-verification-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**method** | **string** | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPingVerificationStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **verificationPollRequest** | [**VerificationPollRequest**](../models/verification-poll-request) | | + +### Return type + +[**VerificationResponse**](../models/verification-response) + +### 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() { + method := `okta-verify` // string | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' # string | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + verificationpollrequest := []byte(`{ + "requestId" : "089899f13a8f4da7824996191587bab9" + }`) // VerificationPollRequest | + + + var verificationPollRequest beta.VerificationPollRequest + if err := json.Unmarshal(verificationpollrequest, &verificationPollRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAControllerAPI.PingVerificationStatus(context.Background(), method).VerificationPollRequest(verificationPollRequest).Execute() + //resp, r, err := apiClient.Beta.MFAControllerAPI.PingVerificationStatus(context.Background(), method).VerificationPollRequest(verificationPollRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.PingVerificationStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PingVerificationStatus`: VerificationResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.PingVerificationStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## send-duo-verify-request +Verifying authentication via Duo method +This API Authenticates the user via Duo-Web MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-duo-verify-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendDuoVerifyRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **duoVerificationRequest** | [**DuoVerificationRequest**](../models/duo-verification-request) | | + +### Return type + +[**VerificationResponse**](../models/verification-response) + +### 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() { + duoverificationrequest := []byte(`{ + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + }`) // DuoVerificationRequest | + + + var duoVerificationRequest beta.DuoVerificationRequest + if err := json.Unmarshal(duoverificationrequest, &duoVerificationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAControllerAPI.SendDuoVerifyRequest(context.Background()).DuoVerificationRequest(duoVerificationRequest).Execute() + //resp, r, err := apiClient.Beta.MFAControllerAPI.SendDuoVerifyRequest(context.Background()).DuoVerificationRequest(duoVerificationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.SendDuoVerifyRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendDuoVerifyRequest`: VerificationResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.SendDuoVerifyRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## send-kba-answers +Authenticate KBA provided MFA method +This API Authenticate user in KBA MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-kba-answers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendKbaAnswersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **kbaAnswerRequestItem** | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | | + +### Return type + +[**KbaAuthResponse**](../models/kba-auth-response) + +### 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() { + kbaanswerrequestitem := []byte(`[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]`) // []KbaAnswerRequestItem | + + + var kbaAnswerRequestItem beta.[]KbaAnswerRequestItem + if err := json.Unmarshal(kbaanswerrequestitem, &kbaAnswerRequestItem); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAControllerAPI.SendKbaAnswers(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + //resp, r, err := apiClient.Beta.MFAControllerAPI.SendKbaAnswers(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.SendKbaAnswers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendKbaAnswers`: KbaAuthResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.SendKbaAnswers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## send-okta-verify-request +Verifying authentication via Okta method +This API Authenticates the user via Okta-Verify MFA method. Request requires a header called 'slpt-forwarding', and it must contain a remote IP Address of caller. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-okta-verify-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendOktaVerifyRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **oktaVerificationRequest** | [**OktaVerificationRequest**](../models/okta-verification-request) | | + +### Return type + +[**VerificationResponse**](../models/verification-response) + +### 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() { + oktaverificationrequest := []byte(`{ + "userId" : "example@mail.com" + }`) // OktaVerificationRequest | + + + var oktaVerificationRequest beta.OktaVerificationRequest + if err := json.Unmarshal(oktaverificationrequest, &oktaVerificationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAControllerAPI.SendOktaVerifyRequest(context.Background()).OktaVerificationRequest(oktaVerificationRequest).Execute() + //resp, r, err := apiClient.Beta.MFAControllerAPI.SendOktaVerifyRequest(context.Background()).OktaVerificationRequest(oktaVerificationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.SendOktaVerifyRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendOktaVerifyRequest`: VerificationResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.SendOktaVerifyRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## send-token-auth-request +Authenticate Token provided MFA method +This API Authenticate user in Token MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-token-auth-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendTokenAuthRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tokenAuthRequest** | [**TokenAuthRequest**](../models/token-auth-request) | | + +### Return type + +[**TokenAuthResponse**](../models/token-auth-response) + +### 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() { + tokenauthrequest := []byte(`{ + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + }`) // TokenAuthRequest | + + + var tokenAuthRequest beta.TokenAuthRequest + if err := json.Unmarshal(tokenauthrequest, &tokenAuthRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAControllerAPI.SendTokenAuthRequest(context.Background()).TokenAuthRequest(tokenAuthRequest).Execute() + //resp, r, err := apiClient.Beta.MFAControllerAPI.SendTokenAuthRequest(context.Background()).TokenAuthRequest(tokenAuthRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.SendTokenAuthRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendTokenAuthRequest`: TokenAuthResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.SendTokenAuthRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/ManagedClientsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/ManagedClientsAPI.md new file mode 100644 index 000000000..8a49702cd --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/ManagedClientsAPI.md @@ -0,0 +1,197 @@ +--- +id: beta-managed-clients +title: ManagedClients +pagination_label: ManagedClients +sidebar_label: ManagedClients +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClients', 'BetaManagedClients'] +slug: /tools/sdk/go/beta/methods/managed-clients +tags: ['SDK', 'Software Development Kit', 'ManagedClients', 'BetaManagedClients'] +--- + +# ManagedClientsAPI + Use this API to implement managed client functionality. +With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-managed-client-status**](#get-managed-client-status) | **Get** `/managed-clients/{id}/status` | Specified Managed Client Status. +[**update-managed-client-status**](#update-managed-client-status) | **Post** `/managed-clients/{id}/status` | Handle status request from client + + +## get-managed-client-status +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Specified Managed Client Status. +Retrieve Managed Client Status by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-client-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Managed Client Status to get | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClientStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **type_** | [**ManagedClientType**](../models/managed-client-type) | Type of the Managed Client Status to get | + +### Return type + +[**ManagedClientStatus**](../models/managed-client-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `aClientId` // string | ID of the Managed Client Status to get # string | ID of the Managed Client Status to get + type_ := // ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ManagedClientsAPI.GetManagedClientStatus(context.Background(), id).Type_(type_).Execute() + //resp, r, err := apiClient.Beta.ManagedClientsAPI.GetManagedClientStatus(context.Background(), id).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClientStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClientStatus`: ManagedClientStatus + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClientStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-managed-client-status +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Handle status request from client +Update a status detail passed in from the client + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-managed-client-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Managed Client Status to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateManagedClientStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **managedClientStatus** | [**ManagedClientStatus**](../models/managed-client-status) | | + +### Return type + +[**ManagedClientStatusAggResponse**](../models/managed-client-status-agg-response) + +### 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 := `aClientId` // string | ID of the Managed Client Status to update # string | ID of the Managed Client Status to update + managedclientstatus := []byte(`{ + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + }`) // ManagedClientStatus | + + + var managedClientStatus beta.ManagedClientStatus + if err := json.Unmarshal(managedclientstatus, &managedClientStatus); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ManagedClientsAPI.UpdateManagedClientStatus(context.Background(), id).ManagedClientStatus(managedClientStatus).Execute() + //resp, r, err := apiClient.Beta.ManagedClientsAPI.UpdateManagedClientStatus(context.Background(), id).ManagedClientStatus(managedClientStatus).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.UpdateManagedClientStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedClientStatus`: ManagedClientStatusAggResponse + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.UpdateManagedClientStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/ManagedClustersAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/ManagedClustersAPI.md new file mode 100644 index 000000000..c91442198 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/ManagedClustersAPI.md @@ -0,0 +1,311 @@ +--- +id: beta-managed-clusters +title: ManagedClusters +pagination_label: ManagedClusters +sidebar_label: ManagedClusters +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusters', 'BetaManagedClusters'] +slug: /tools/sdk/go/beta/methods/managed-clusters +tags: ['SDK', 'Software Development Kit', 'ManagedClusters', 'BetaManagedClusters'] +--- + +# ManagedClustersAPI + Use this API to implement managed cluster functionality. +With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-client-log-configuration**](#get-client-log-configuration) | **Get** `/managed-clusters/{id}/log-config` | Get managed cluster's log configuration +[**get-managed-cluster**](#get-managed-cluster) | **Get** `/managed-clusters/{id}` | Get a specified ManagedCluster. +[**get-managed-clusters**](#get-managed-clusters) | **Get** `/managed-clusters` | Retrieve all Managed Clusters. +[**put-client-log-configuration**](#put-client-log-configuration) | **Put** `/managed-clusters/{id}/log-config` | Update managed cluster's log configuration + + +## get-client-log-configuration +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get managed cluster's log configuration +Get managed cluster's log configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-client-log-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of ManagedCluster to get log configuration for | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetClientLogConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ClientLogConfiguration**](../models/client-log-configuration) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `aClusterId` // string | ID of ManagedCluster to get log configuration for # string | ID of ManagedCluster to get log configuration for + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ManagedClustersAPI.GetClientLogConfiguration(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.ManagedClustersAPI.GetClientLogConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetClientLogConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetClientLogConfiguration`: ClientLogConfiguration + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetClientLogConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-managed-cluster +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get a specified ManagedCluster. +Retrieve a ManagedCluster by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-cluster) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the ManagedCluster to get | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ManagedCluster**](../models/managed-cluster) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `aClusterId` // string | ID of the ManagedCluster to get # string | ID of the ManagedCluster to get + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ManagedClustersAPI.GetManagedCluster(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.ManagedClustersAPI.GetManagedCluster(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetManagedCluster`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-managed-clusters +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Retrieve all Managed Clusters. +Retrieve all Managed Clusters for the current Org, based on request context. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-clusters) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClustersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **operational**: *eq* | + +### Return type + +[**[]ManagedCluster**](../models/managed-cluster) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `operational eq operation` // 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: **operational**: *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: **operational**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ManagedClustersAPI.GetManagedClusters(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ManagedClustersAPI.GetManagedClusters(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetManagedClusters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClusters`: []ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetManagedClusters`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-client-log-configuration +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Update managed cluster's log configuration +Update managed cluster's log configuration + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-client-log-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of ManagedCluster to update log configuration for | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutClientLogConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **clientLogConfiguration** | [**ClientLogConfiguration**](../models/client-log-configuration) | ClientLogConfiguration for given ManagedCluster | + +### Return type + +[**ClientLogConfiguration**](../models/client-log-configuration) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `aClusterId` // string | ID of ManagedCluster to update log configuration for # string | ID of ManagedCluster to update log configuration for + clientlogconfiguration := []byte(`{ + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + }`) // ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ManagedClustersAPI.PutClientLogConfiguration(context.Background(), id).ClientLogConfiguration(clientLogConfiguration).Execute() + //resp, r, err := apiClient.Beta.ManagedClustersAPI.PutClientLogConfiguration(context.Background(), id).ClientLogConfiguration(clientLogConfiguration).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.PutClientLogConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutClientLogConfiguration`: ClientLogConfiguration + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.PutClientLogConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/MultiHostIntegrationAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/MultiHostIntegrationAPI.md new file mode 100644 index 000000000..e47e43593 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/MultiHostIntegrationAPI.md @@ -0,0 +1,964 @@ +--- +id: beta-multi-host-integration +title: MultiHostIntegration +pagination_label: MultiHostIntegration +sidebar_label: MultiHostIntegration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegration', 'BetaMultiHostIntegration'] +slug: /tools/sdk/go/beta/methods/multi-host-integration +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegration', 'BetaMultiHostIntegration'] +--- + +# MultiHostIntegrationAPI + Use this API to build a Multi-Host Integration. +Multi-Host Integration will help customers to configure and manage similar type of target system in Identity Security Cloud. +In Identity Security Cloud, administrators can create a Multi-Host Integration by going to Admin > Connections > Multi-Host Sources and selecting 'Create.' + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-multi-host-integration**](#create-multi-host-integration) | **Post** `/multihosts` | Create Multi-Host Integration +[**create-sources-within-multi-host**](#create-sources-within-multi-host) | **Post** `/multihosts/{multihostId}` | Create Sources Within Multi-Host Integration +[**delete-multi-host**](#delete-multi-host) | **Delete** `/multihosts/{multihostId}` | Delete Multi-Host Integration +[**get-acct-aggregation-groups**](#get-acct-aggregation-groups) | **Get** `/multihosts/{multihostId}/acctAggregationGroups` | Get Account Aggregation Groups Within Multi-Host Integration ID +[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **Get** `/multihosts/{multiHostId}/entitlementAggregationGroups` | Get Entitlement Aggregation Groups Within Multi-Host Integration ID +[**get-multi-host-integrations**](#get-multi-host-integrations) | **Get** `/multihosts/{multihostId}` | Get Multi-Host Integration By ID +[**get-multi-host-integrations-list**](#get-multi-host-integrations-list) | **Get** `/multihosts` | List All Existing Multi-Host Integrations +[**get-multi-host-source-creation-errors**](#get-multi-host-source-creation-errors) | **Get** `/multihosts/{multiHostId}/sources/errors` | List Multi-Host Source Creation Errors +[**get-multihost-integration-types**](#get-multihost-integration-types) | **Get** `/multihosts/types` | List Multi-Host Integration Types +[**get-sources-within-multi-host**](#get-sources-within-multi-host) | **Get** `/multihosts/{multihostId}/sources` | List Sources Within Multi-Host Integration +[**test-connection-multi-host-sources**](#test-connection-multi-host-sources) | **Post** `/multihosts/{multihostId}/sources/testConnection` | Test Configuration For Multi-Host Integration +[**test-source-connection-multihost**](#test-source-connection-multihost) | **Get** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source +[**update-multi-host-sources**](#update-multi-host-sources) | **Patch** `/multihosts/{multihostId}` | Update Multi-Host Integration + + +## create-multi-host-integration +Create Multi-Host Integration +This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-multi-host-integration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateMultiHostIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **multiHostIntegrationsCreate** | [**MultiHostIntegrationsCreate**](../models/multi-host-integrations-create) | The specifics of the Multi-Host Integration to create | + +### Return type + +[**MultiHostIntegrations**](../models/multi-host-integrations) + +### 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() { + multihostintegrationscreate := []byte(`{ + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + }`) // MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create + + + var multiHostIntegrationsCreate beta.MultiHostIntegrationsCreate + if err := json.Unmarshal(multihostintegrationscreate, &multiHostIntegrationsCreate); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.CreateMultiHostIntegration(context.Background()).MultiHostIntegrationsCreate(multiHostIntegrationsCreate).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.CreateMultiHostIntegration(context.Background()).MultiHostIntegrationsCreate(multiHostIntegrationsCreate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.CreateMultiHostIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateMultiHostIntegration`: MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.CreateMultiHostIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-sources-within-multi-host +Create Sources Within Multi-Host Integration +This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-sources-within-multi-host) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSourcesWithinMultiHostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **multiHostIntegrationsCreateSources** | [**[]MultiHostIntegrationsCreateSources**](../models/multi-host-integrations-create-sources) | The specifics of the sources to create within Multi-Host Integration. | + +### Return type + + (empty response body) + +### 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() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration. # string | ID of the Multi-Host Integration. + multihostintegrationscreatesources := []byte(``) // []MultiHostIntegrationsCreateSources | The specifics of the sources to create within Multi-Host Integration. + + + var multiHostIntegrationsCreateSources beta.[]MultiHostIntegrationsCreateSources + if err := json.Unmarshal(multihostintegrationscreatesources, &multiHostIntegrationsCreateSources); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.MultiHostIntegrationAPI.CreateSourcesWithinMultiHost(context.Background(), multihostId).MultiHostIntegrationsCreateSources(multiHostIntegrationsCreateSources).Execute() + //r, err := apiClient.Beta.MultiHostIntegrationAPI.CreateSourcesWithinMultiHost(context.Background(), multihostId).MultiHostIntegrationsCreateSources(multiHostIntegrationsCreateSources).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.CreateSourcesWithinMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-multi-host +Delete Multi-Host Integration +Delete an existing Multi-Host Integration by ID. + +A token with Org Admin or Multi Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-multi-host) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of Multi-Host Integration to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteMultiHostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of Multi-Host Integration to delete. # string | ID of Multi-Host Integration to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.MultiHostIntegrationAPI.DeleteMultiHost(context.Background(), multihostId).Execute() + //r, err := apiClient.Beta.MultiHostIntegrationAPI.DeleteMultiHost(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.DeleteMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-acct-aggregation-groups +Get Account Aggregation Groups Within Multi-Host Integration ID +This API will return array of account aggregation groups within provided Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-acct-aggregation-groups) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAcctAggregationGroupsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**MultiHostIntegrationsAggScheduleUpdate**](../models/multi-host-integrations-agg-schedule-update) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetAcctAggregationGroups(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetAcctAggregationGroups(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetAcctAggregationGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAcctAggregationGroups`: MultiHostIntegrationsAggScheduleUpdate + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetAcctAggregationGroups`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlement-aggregation-groups +Get Entitlement Aggregation Groups Within Multi-Host Integration ID +This API will return array of aggregation groups within provided Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement-aggregation-groups) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multiHostId** | **string** | ID of the Multi-Host Integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementAggregationGroupsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**MultiHostIntegrationsAggScheduleUpdate**](../models/multi-host-integrations-agg-schedule-update) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multiHostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetEntitlementAggregationGroups(context.Background(), multiHostId).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetEntitlementAggregationGroups(context.Background(), multiHostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetEntitlementAggregationGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementAggregationGroups`: MultiHostIntegrationsAggScheduleUpdate + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetEntitlementAggregationGroups`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-multi-host-integrations +Get Multi-Host Integration By ID +Get an existing Multi-Host Integration. + +A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-multi-host-integrations) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMultiHostIntegrationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**MultiHostIntegrations**](../models/multi-host-integrations) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration. # string | ID of the Multi-Host Integration. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetMultiHostIntegrations(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetMultiHostIntegrations(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostIntegrations`: MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostIntegrations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-multi-host-integrations-list +List All Existing Multi-Host Integrations +Get a list of Multi-Host Integrations. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-multi-host-integrations-list) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMultiHostIntegrationsListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **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** | + **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: **type**: *in* **forSubAdminId**: *in* | + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **forSubadmin** | **string** | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. | + +### Return type + +[**[]MultiHostIntegrations**](../models/multi-host-integrations) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `id eq 2c91808b6ef1d43e016efba0ce470904` // 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: **type**: *in* **forSubAdminId**: *in* (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: **type**: *in* **forSubAdminId**: *in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetMultiHostIntegrationsList(context.Background()).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetMultiHostIntegrationsList(context.Background()).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).ForSubadmin(forSubadmin).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostIntegrationsList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostIntegrationsList`: []MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostIntegrationsList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-multi-host-source-creation-errors +List Multi-Host Source Creation Errors +Get a list of sources creation errors within Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-multi-host-source-creation-errors) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multiHostId** | **string** | ID of the Multi-Host Integration | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMultiHostSourceCreationErrorsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]SourceCreationErrors**](../models/source-creation-errors) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multiHostId := `004091cb79b04636b88662afa50a4440` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors(context.Background(), multiHostId).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors(context.Background(), multiHostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostSourceCreationErrors`: []SourceCreationErrors + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-multihost-integration-types +List Multi-Host Integration Types +This API endpoint returns the current list of supported Multi-Host Integration types. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-multihost-integration-types) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMultihostIntegrationTypesRequest struct via the builder pattern + + +### Return type + +[**[]MultiHostIntegrationTemplateType**](../models/multi-host-integration-template-type) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetMultihostIntegrationTypes(context.Background()).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetMultihostIntegrationTypes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultihostIntegrationTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultihostIntegrationTypes`: []MultiHostIntegrationTemplateType + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultihostIntegrationTypes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sources-within-multi-host +List Sources Within Multi-Host Integration +Get a list of sources within Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sources-within-multi-host) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourcesWithinMultiHostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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] + **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] + **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** | + **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**: *in* | + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]MultiHostSources**](../models/multi-host-sources) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `id eq 2c91808b6ef1d43e016efba0ce470904` // 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**: *in* (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**: *in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetSourcesWithinMultiHost(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetSourcesWithinMultiHost(context.Background(), multihostId).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetSourcesWithinMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourcesWithinMultiHost`: []MultiHostSources + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetSourcesWithinMultiHost`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-connection-multi-host-sources +Test Configuration For Multi-Host Integration +This endpoint performs a more detailed validation of the Multi-Host Integration's configuration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-connection-multi-host-sources) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestConnectionMultiHostSourcesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `2c91808568c529c60168cca6f90c1324` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.MultiHostIntegrationAPI.TestConnectionMultiHostSources(context.Background(), multihostId).Execute() + //r, err := apiClient.Beta.MultiHostIntegrationAPI.TestConnectionMultiHostSources(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.TestConnectionMultiHostSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## test-source-connection-multihost +Test Configuration For Multi-Host Integration's Single Source +This endpoint performs a more detailed validation of the source's configuration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-source-connection-multihost) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration | +**sourceId** | **string** | ID of the source within the Multi-Host Integration | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestSourceConnectionMultihostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**TestSourceConnectionMultihost200Response**](../models/test-source-connection-multihost200-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + sourceId := `2c91808568c529f60168cca6f90c1324` // string | ID of the source within the Multi-Host Integration # string | ID of the source within the Multi-Host Integration + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.TestSourceConnectionMultihost(context.Background(), multihostId, sourceId).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.TestSourceConnectionMultihost(context.Background(), multihostId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.TestSourceConnectionMultihost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConnectionMultihost`: TestSourceConnectionMultihost200Response + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.TestSourceConnectionMultihost`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-multi-host-sources +Update Multi-Host Integration +Update existing sources within Multi-Host Integration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-multi-host-sources) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateMultiHostSourcesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **updateMultiHostSourcesRequestInner** | [**[]UpdateMultiHostSourcesRequestInner**](../models/update-multi-host-sources-request-inner) | This endpoint allows you to update a Multi-Host Integration. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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() { + multihostId := `anId` // string | ID of the Multi-Host Integration to update. # string | ID of the Multi-Host Integration to update. + updatemultihostsourcesrequestinner := []byte(`[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]`) // []UpdateMultiHostSourcesRequestInner | This endpoint allows you to update a Multi-Host Integration. + + + var updateMultiHostSourcesRequestInner beta.[]UpdateMultiHostSourcesRequestInner + if err := json.Unmarshal(updatemultihostsourcesrequestinner, &updateMultiHostSourcesRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.MultiHostIntegrationAPI.UpdateMultiHostSources(context.Background(), multihostId).UpdateMultiHostSourcesRequestInner(updateMultiHostSourcesRequestInner).Execute() + //r, err := apiClient.Beta.MultiHostIntegrationAPI.UpdateMultiHostSources(context.Background(), multihostId).UpdateMultiHostSourcesRequestInner(updateMultiHostSourcesRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.UpdateMultiHostSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/NonEmployeeLifecycleManagementAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/NonEmployeeLifecycleManagementAPI.md new file mode 100644 index 000000000..e023da367 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/NonEmployeeLifecycleManagementAPI.md @@ -0,0 +1,2368 @@ +--- +id: beta-non-employee-lifecycle-management +title: NonEmployeeLifecycleManagement +pagination_label: NonEmployeeLifecycleManagement +sidebar_label: NonEmployeeLifecycleManagement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeLifecycleManagement', 'BetaNonEmployeeLifecycleManagement'] +slug: /tools/sdk/go/beta/methods/non-employee-lifecycle-management +tags: ['SDK', 'Software Development Kit', 'NonEmployeeLifecycleManagement', 'BetaNonEmployeeLifecycleManagement'] +--- + +# NonEmployeeLifecycleManagementAPI + Use this API to implement non-employee lifecycle management functionality. +With this functionality in place, administrators can create non-employee records and configure them for use in their organizations. +This allows organizations to provide secure access to non-employees and control that access. + +The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. +Organizations can track non-employees' access and activity in Identity Security Cloud by creating and maintaining non-employee sources. +Organizations can have a maximum of 50 non-employee sources. + +By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following: + +- SailPoint is not responsible for storing sensitive data. +You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in Identity Security Cloud. + +- You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts. + +To manage non-employees in Identity Security Cloud, administrators must create a non-employee source and add accounts to the source. + +To create a non-employee source in Identity Security Cloud, administrators must use the Admin panel to go to Connections > Sources. +They must then specify 'Non-Employee' in the 'Source Type' field. +Refer to [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources. + +To add accounts to a non-employee source in Identity Security Cloud, administrators can select the non-employee source and add the accounts. +They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. + +Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. +To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. +Refer to [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources. + +Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. + +Refer to [Managing Non-Employee Sources and Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html) for more information about non-employee lifecycle management. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-non-employee-request**](#approve-non-employee-request) | **Post** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request +[**create-non-employee-record**](#create-non-employee-record) | **Post** `/non-employee-records` | Create Non-Employee Record +[**create-non-employee-request**](#create-non-employee-request) | **Post** `/non-employee-requests` | Create Non-Employee Request +[**create-non-employee-source**](#create-non-employee-source) | **Post** `/non-employee-sources` | Create Non-Employee Source +[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **Post** `/non-employee-sources/{sourceId}/schema-attributes` | Create Non-Employee Source Schema Attribute +[**delete-non-employee-record**](#delete-non-employee-record) | **Delete** `/non-employee-records/{id}` | Delete Non-Employee Record +[**delete-non-employee-record-in-bulk**](#delete-non-employee-record-in-bulk) | **Post** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records +[**delete-non-employee-request**](#delete-non-employee-request) | **Delete** `/non-employee-requests/{id}` | Delete Non-Employee Request +[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete Non-Employee Source's Schema Attribute +[**delete-non-employee-source**](#delete-non-employee-source) | **Delete** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source +[**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-bulk-upload-status**](#get-non-employee-bulk-upload-status) | **Get** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Bulk upload status on source +[**get-non-employee-record**](#get-non-employee-record) | **Get** `/non-employee-records/{id}` | Get a Non-Employee Record +[**get-non-employee-request**](#get-non-employee-request) | **Get** `/non-employee-requests/{id}` | Get a Non-Employee Request +[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **Get** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests +[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **Get** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source +[**get-non-employee-source**](#get-non-employee-source) | **Get** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source +[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **Get** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source +[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **Post** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records +[**list-non-employee-approval**](#list-non-employee-approval) | **Get** `/non-employee-approvals` | Get List of Non-Employee Approval Requests +[**list-non-employee-records**](#list-non-employee-records) | **Get** `/non-employee-records` | List Non-Employee Records +[**list-non-employee-requests**](#list-non-employee-requests) | **Get** `/non-employee-requests` | List Non-Employee Requests +[**list-non-employee-sources**](#list-non-employee-sources) | **Get** `/non-employee-sources` | List Non-Employee Sources +[**patch-non-employee-record**](#patch-non-employee-record) | **Patch** `/non-employee-records/{id}` | Patch Non-Employee Record +[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **Patch** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch Non-Employee Source's Schema Attribute +[**patch-non-employee-source**](#patch-non-employee-source) | **Patch** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source +[**reject-non-employee-request**](#reject-non-employee-request) | **Post** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request +[**update-non-employee-record**](#update-non-employee-record) | **Put** `/non-employee-records/{id}` | Update Non-Employee Record + + +## approve-non-employee-request +Approve a Non-Employee Request +Approves a non-employee approval request and notifies the next approver. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/approve-non-employee-request) + +### 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 apiApproveNonEmployeeRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **nonEmployeeApprovalDecision** | [**NonEmployeeApprovalDecision**](../models/non-employee-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) + nonemployeeapprovaldecision := []byte(`{ + "comment" : "comment" + }`) // NonEmployeeApprovalDecision | + + + var nonEmployeeApprovalDecision beta.NonEmployeeApprovalDecision + if err := json.Unmarshal(nonemployeeapprovaldecision, &nonEmployeeApprovalDecision); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest(context.Background(), id).NonEmployeeApprovalDecision(nonEmployeeApprovalDecision).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest(context.Background(), id).NonEmployeeApprovalDecision(nonEmployeeApprovalDecision).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveNonEmployeeRequest`: NonEmployeeApprovalItem + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-non-employee-record +Create Non-Employee Record +This request will create a non-employee record. +Request will require the following security scope: +'idn:nesr:create' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-record) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nonEmployeeRequestBody** | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | Non-Employee record creation request body. | + +### Return type + +[**NonEmployeeRecord**](../models/non-employee-record) + +### 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() { + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-Employee record creation request body. + + + var nonEmployeeRequestBody beta.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-non-employee-request +Create Non-Employee Request +This request will create a non-employee request and notify the approver + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNonEmployeeRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nonEmployeeRequestBody** | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | Non-Employee creation request body | + +### Return type + +[**NonEmployeeRequest**](../models/non-employee-request) + +### 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() { + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-Employee creation request body + + + var nonEmployeeRequestBody beta.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeRequest`: NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-non-employee-source +Create Non-Employee Source +Create a non-employee source. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-source) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNonEmployeeSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nonEmployeeSourceRequestBody** | [**NonEmployeeSourceRequestBody**](../models/non-employee-source-request-body) | Non-Employee source creation request body. | + +### Return type + +[**NonEmployeeSourceWithCloudExternalId**](../models/non-employee-source-with-cloud-external-id) + +### 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() { + nonemployeesourcerequestbody := []byte(`{ + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + }`) // NonEmployeeSourceRequestBody | Non-Employee source creation request body. + + + var nonEmployeeSourceRequestBody beta.NonEmployeeSourceRequestBody + if err := json.Unmarshal(nonemployeesourcerequestbody, &nonEmployeeSourceRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource(context.Background()).NonEmployeeSourceRequestBody(nonEmployeeSourceRequestBody).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource(context.Background()).NonEmployeeSourceRequestBody(nonEmployeeSourceRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeSource`: NonEmployeeSourceWithCloudExternalId + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-non-employee-source-schema-attributes +Create Non-Employee Source Schema Attribute +This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-source-schema-attributes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNonEmployeeSourceSchemaAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **nonEmployeeSchemaAttributeBody** | [**NonEmployeeSchemaAttributeBody**](../models/non-employee-schema-attribute-body) | | + +### Return type + +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### 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() { + sourceId := `2c91808b6ef1d43e016efba0ce470904` // string | The Source id # string | The Source id + nonemployeeschemaattributebody := []byte(`{ + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + }`) // NonEmployeeSchemaAttributeBody | + + + var nonEmployeeSchemaAttributeBody beta.NonEmployeeSchemaAttributeBody + if err := json.Unmarshal(nonemployeeschemaattributebody, &nonEmployeeSchemaAttributeBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).NonEmployeeSchemaAttributeBody(nonEmployeeSchemaAttributeBody).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).NonEmployeeSchemaAttributeBody(nonEmployeeSchemaAttributeBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeSourceSchemaAttributes`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-non-employee-record +Delete Non-Employee Record +This request will delete a non-employee record. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-record) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-Employee record id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808b6ef1d43e016efba0ce470904` // string | Non-Employee record id (UUID) # string | Non-Employee record id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord(context.Background(), id).Execute() + //r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-record-in-bulk +Delete Multiple Non-Employee Records +This request will delete multiple non-employee records based on the non-employee ids provided. +Request will require the following scope: +'idn:nesr:delete' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-record-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeRecordInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **deleteNonEmployeeRecordInBulkRequest** | [**DeleteNonEmployeeRecordInBulkRequest**](../models/delete-non-employee-record-in-bulk-request) | Non-Employee bulk delete request body. | + +### Return type + + (empty response body) + +### 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() { + deletenonemployeerecordinbulkrequest := []byte(``) // DeleteNonEmployeeRecordInBulkRequest | Non-Employee bulk delete request body. + + + var deleteNonEmployeeRecordInBulkRequest beta.DeleteNonEmployeeRecordInBulkRequest + if err := json.Unmarshal(deletenonemployeerecordinbulkrequest, &deleteNonEmployeeRecordInBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordInBulk(context.Background()).DeleteNonEmployeeRecordInBulkRequest(deleteNonEmployeeRecordInBulkRequest).Execute() + //r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordInBulk(context.Background()).DeleteNonEmployeeRecordInBulkRequest(deleteNonEmployeeRecordInBulkRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-request +Delete Non-Employee Request +This request will delete a non-employee request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-Employee request id in the UUID format | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808b6ef1d43e016efba0ce470904` // string | Non-Employee request id in the UUID format # string | Non-Employee request id in the UUID format + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest(context.Background(), id).Execute() + //r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-schema-attribute +Delete Non-Employee Source's Schema Attribute +This end-point deletes a specific schema attribute for a non-employee source. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-schema-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**attributeId** | **string** | The Schema Attribute Id (UUID) | +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeSchemaAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + attributeId := `2c91808b6ef1d43e016efba0ce470904` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `2c91808b6ef1d43e016efba0ce470904` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + //r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-source +Delete Non-Employee Source +This request will delete a non-employee source. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-source) + +### 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 apiDeleteNonEmployeeSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c91808b6ef1d43e016efba0ce470904` // string | Source Id # string | Source Id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource(context.Background(), sourceId).Execute() + //r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-source-schema-attributes +Delete all custom schema attributes +This end-point deletes all custom schema attributes for a non-employee source. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-source-schema-attributes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeSourceSchemaAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c91808b6ef1d43e016efba0ce470904` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + //r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[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 +Approves a non-employee approval request and notifies the next approver. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-approval) + +### 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 apiGetNonEmployeeApprovalRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeDetail** | **string** | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* | + +### Return type + +[**NonEmployeeApprovalItemDetail**](../models/non-employee-approval-item-detail) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ac10d20a-841e-1e7d-8184-32d2e22c0179` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + includeDetail := `include-detail=false` // string | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # string | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval(context.Background(), id).IncludeDetail(includeDetail).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeApproval`: NonEmployeeApprovalItemDetail + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-approval-summary +Get Summary of Non-Employee Approval Requests +This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. 2. The current user is an approver, in which case "me" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-approval-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**requestedFor** | **string** | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeApprovalSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeApprovalSummary**](../models/non-employee-approval-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `ac10d20a-841e-1e7d-8184-32d2e22c0179` // string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary(context.Background(), requestedFor).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary(context.Background(), requestedFor).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeApprovalSummary`: NonEmployeeApprovalSummary + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-bulk-upload-status +Bulk upload status on source +The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-bulk-upload-status) + +### 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 apiGetNonEmployeeBulkUploadStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeBulkUploadStatus**](../models/non-employee-bulk-upload-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: 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) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeBulkUploadStatus`: NonEmployeeBulkUploadStatus + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-record +Get a Non-Employee Record +This gets a non-employee record. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-record) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-Employee record id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808b6ef1d43e016efba0ce470904` // string | Non-Employee record id (UUID) # string | Non-Employee record id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-request +Get a Non-Employee Request +This gets a non-employee request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-Employee request id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeRequest**](../models/non-employee-request) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808b6ef1d43e016efba0ce470904` // string | Non-Employee request id (UUID) # string | Non-Employee request id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRequest`: NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-request-summary +Get Summary of Non-Employee Requests +This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. 2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-request-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**requestedFor** | **string** | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeRequestSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeRequestSummary**](../models/non-employee-request-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `ac10d20a-841e-1e7d-8184-32d2e22c0179` // string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary(context.Background(), requestedFor).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary(context.Background(), requestedFor).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRequestSummary`: NonEmployeeRequestSummary + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-schema-attribute +Get Schema Attribute Non-Employee Source +This API gets a schema attribute by Id for the specified Non-Employee SourceId. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-schema-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**attributeId** | **string** | The Schema Attribute Id (UUID) | +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeSchemaAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + attributeId := `2c918085842e69ae018432d22ccb212f` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `2c918085842e69ae018432d22ccb212f` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeSchemaAttribute`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-source +Get a Non-Employee Source +This gets a non-employee source. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-source) + +### 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 apiGetNonEmployeeSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeSource**](../models/non-employee-source) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c91808b7c28b350017c2a2ec5790aa1` // string | Source Id # string | Source Id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeSource`: NonEmployeeSource + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-source-schema-attributes +List Schema Attributes Non-Employee Source +This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-source-schema-attributes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeSourceSchemaAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c918085842e69ae018432d22ccb212f` // string | The Source id # string | The Source id + + + + 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() + 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) + } + // response from `GetNonEmployeeSourceSchemaAttributes`: []NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-non-employee-records-in-bulk +Imports, or Updates, Non-Employee Records +This post will import, or update, Non-Employee records found in the CSV. +Request will need the following security scope: +'idn:nesr:create' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-non-employee-records-in-bulk) + +### 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 apiImportNonEmployeeRecordsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **data** | ***os.File** | | + +### Return type + +[**NonEmployeeBulkUploadJob**](../models/non-employee-bulk-upload-job) + +### 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() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id (UUID) # string | Source Id (UUID) + data := BINARY_DATA_HERE // *os.File | # *os.File | + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk(context.Background(), id).Data(data).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk(context.Background(), id).Data(data).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportNonEmployeeRecordsInBulk`: NonEmployeeBulkUploadJob + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-non-employee-approval +Get List of Non-Employee Approval Requests +This gets a list of non-employee approval requests. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-approval) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNonEmployeeApprovalRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | The identity for whom the request was made. *me* indicates the current user. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **approvalStatus**: *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: **created, modified** | + +### Return type + +[**[]NonEmployeeApprovalItem**](../models/non-employee-approval-item) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `ac10d20a-841e-1e7d-8184-32d2e22c0179` // string | The identity for whom the request was made. *me* indicates the current user. (optional) # string | The identity for whom the request was made. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `approvalStatus eq "PENDING"` // 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: **approvalStatus**: *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: **approvalStatus**: *eq* (optional) + sorters := `created` // 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: **created, modified** (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: **created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ListNonEmployeeApproval(context.Background()).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ListNonEmployeeApproval(context.Background()).RequestedFor(requestedFor).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeApproval`: []NonEmployeeApprovalItem + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeApproval`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-non-employee-records +List Non-Employee Records +This gets a list of non-employee records. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-records) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNonEmployeeRecordsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** | + **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: **sourceId**: *eq* | + +### Return type + +[**[]NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `accountName,sourceId` // 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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + filters := `sourceId eq "2c91808568c529c60168cca6f90c1313"` // 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: **sourceId**: *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: **sourceId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords(context.Background()).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords(context.Background()).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeRecords`: []NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-non-employee-requests +List Non-Employee Requests +This gets a list of non-employee requests. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-requests) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNonEmployeeRequestsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | The identity for whom the request was made. *me* indicates the current user. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** | + **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: **sourceId**: *eq* | + +### Return type + +[**[]NonEmployeeRequest**](../models/non-employee-request) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `me` // string | The identity for whom the request was made. *me* indicates the current user. # string | The identity for whom the request was made. *me* indicates the current user. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `approvalStatus,firstName` // 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + filters := `sourceId eq "2c91808568c529c60168cca6f90c1313"` // 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: **sourceId**: *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: **sourceId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests(context.Background()).RequestedFor(requestedFor).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests(context.Background()).RequestedFor(requestedFor).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeRequests`: []NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-non-employee-sources +List Non-Employee Sources +Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: + 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. + 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-sources) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNonEmployeeSourcesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **requestedFor** | **string** | Identity the request was made for. Use 'me' to indicate the current user. | + **nonEmployeeCount** | **bool** | Flag that determines whether the API will return a non-employee count associated with the source. | [default to false] + **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, created, sourceId** | + +### Return type + +[**[]NonEmployeeSourceWithNECount**](../models/non-employee-source-with-ne-count) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + requestedFor := `me` // string | Identity the request was made for. Use 'me' to indicate the current user. (optional) # string | Identity the request was made for. Use 'me' to indicate the current user. (optional) + nonEmployeeCount := false // bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) + sorters := `name,created` // 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, created, sourceId** (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, created, sourceId** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources(context.Background()).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources(context.Background()).Limit(limit).Offset(offset).Count(count).RequestedFor(requestedFor).NonEmployeeCount(nonEmployeeCount).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeSources`: []NonEmployeeSourceWithNECount + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-non-employee-record +Patch Non-Employee Record +This request will patch a non-employee record. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-non-employee-record) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-employee record id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. | + +### Return type + +[**NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 record id (UUID) # string | Non-employee record id (UUID) + jsonpatchoperation := []byte(`[{op=replace, path=/endDate, value={2019-08-23T18:40:35.772Z=null}}]`) // []JsonPatchOperation | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-non-employee-schema-attribute +Patch Non-Employee Source's Schema Attribute +This end-point patches a specific schema attribute for a non-employee SourceId. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-non-employee-schema-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**attributeId** | **string** | The Schema Attribute Id (UUID) | +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchNonEmployeeSchemaAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. | + +### Return type + +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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() { + attributeId := `2c91808b6ef1d43e016efba0ce470904` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `2c91808b6ef1d43e016efba0ce470904` // string | The Source id # string | The Source id + jsonpatchoperation := []byte(`[{op=replace, path=/label, value={new attribute label=null}}]`) // []JsonPatchOperation | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeSchemaAttribute`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-non-employee-source +Patch a Non-Employee Source +patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-non-employee-source) + +### 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 apiPatchNonEmployeeSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +[**NonEmployeeSource**](../models/non-employee-source) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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() { + sourceId := `2c91808b6ef1d43e016efba0ce470904` // string | Source Id # string | Source Id + jsonpatchoperation := []byte(`[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}]`) // []JsonPatchOperation | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource(context.Background(), sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource(context.Background(), sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeSource`: NonEmployeeSource + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource`: %v\n", resp) +} +``` + +[[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 +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) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-employee record id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **nonEmployeeRequestBody** | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. | + +### Return type + +[**NonEmployeeRecord**](../models/non-employee-record) + +### 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 record id (UUID) # string | Non-employee record id (UUID) + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + + var nonEmployeeRequestBody beta.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + 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() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord``: %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) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/NotificationsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/NotificationsAPI.md new file mode 100644 index 000000000..e82a466c8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/NotificationsAPI.md @@ -0,0 +1,1050 @@ +--- +id: beta-notifications +title: Notifications +pagination_label: Notifications +sidebar_label: Notifications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Notifications', 'BetaNotifications'] +slug: /tools/sdk/go/beta/methods/notifications +tags: ['SDK', 'Software Development Kit', 'Notifications', 'BetaNotifications'] +--- + +# NotificationsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-domain-dkim**](#create-domain-dkim) | **Post** `/verified-domains` | Verify domain address via DKIM +[**create-notification-template**](#create-notification-template) | **Post** `/notification-templates` | Create Notification Template +[**create-verified-from-address**](#create-verified-from-address) | **Post** `/verified-from-addresses` | Create Verified From Address +[**delete-notification-templates-in-bulk**](#delete-notification-templates-in-bulk) | **Post** `/notification-templates/bulk-delete` | Bulk Delete Notification Templates +[**delete-verified-from-address**](#delete-verified-from-address) | **Delete** `/verified-from-addresses/{id}` | Delete Verified From Address +[**get-dkim-attributes**](#get-dkim-attributes) | **Get** `/verified-domains` | Get DKIM Attributes +[**get-mail-from-attributes**](#get-mail-from-attributes) | **Get** `/mail-from-attributes/{identityId}` | Get MAIL FROM Attributes +[**get-notification-template**](#get-notification-template) | **Get** `/notification-templates/{id}` | Get Notification Template By Id +[**get-notifications-template-context**](#get-notifications-template-context) | **Get** `/notification-template-context` | Get Notification Template Context +[**list-from-addresses**](#list-from-addresses) | **Get** `/verified-from-addresses` | List From Addresses +[**list-notification-preferences**](#list-notification-preferences) | **Get** `/notification-preferences/{key}` | List Notification Preferences for tenant. +[**list-notification-template-defaults**](#list-notification-template-defaults) | **Get** `/notification-template-defaults` | List Notification Template Defaults +[**list-notification-templates**](#list-notification-templates) | **Get** `/notification-templates` | List Notification Templates +[**put-mail-from-attributes**](#put-mail-from-attributes) | **Put** `/mail-from-attributes` | Change MAIL FROM domain +[**send-test-notification**](#send-test-notification) | **Post** `/send-test-notification` | Send Test Notification + + +## create-domain-dkim +Verify domain address via DKIM +Create a domain to be verified via DKIM (DomainKeys Identified Mail) + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-domain-dkim) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateDomainDkimRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **domainAddress** | [**DomainAddress**](../models/domain-address) | | + +### Return type + +[**DomainStatusDto**](../models/domain-status-dto) + +### 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() { + domainaddress := []byte(`{ + "domain" : "sailpoint.com" + }`) // DomainAddress | + + + var domainAddress beta.DomainAddress + if err := json.Unmarshal(domainaddress, &domainAddress); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.CreateDomainDkim(context.Background()).DomainAddress(domainAddress).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.CreateDomainDkim(context.Background()).DomainAddress(domainAddress).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateDomainDkim``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDomainDkim`: DomainStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateDomainDkim`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-notification-template +Create Notification Template +This creates a template for your site. + +You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-notification-template) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNotificationTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **templateDto** | [**TemplateDto**](../models/template-dto) | | + +### Return type + +[**TemplateDto**](../models/template-dto) + +### 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() { + templatedto := []byte(`{ + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" + }`) // TemplateDto | + + + var templateDto beta.TemplateDto + if err := json.Unmarshal(templatedto, &templateDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.CreateNotificationTemplate(context.Background()).TemplateDto(templateDto).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.CreateNotificationTemplate(context.Background()).TemplateDto(templateDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateNotificationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNotificationTemplate`: TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateNotificationTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-verified-from-address +Create Verified From Address +Create a new sender email address and initiate verification process. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-verified-from-address) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateVerifiedFromAddressRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **emailStatusDto** | [**EmailStatusDto**](../models/email-status-dto) | | + +### Return type + +[**EmailStatusDto**](../models/email-status-dto) + +### 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() { + emailstatusdto := []byte(`{ + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + }`) // EmailStatusDto | + + + var emailStatusDto beta.EmailStatusDto + if err := json.Unmarshal(emailstatusdto, &emailStatusDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.CreateVerifiedFromAddress(context.Background()).EmailStatusDto(emailStatusDto).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.CreateVerifiedFromAddress(context.Background()).EmailStatusDto(emailStatusDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateVerifiedFromAddress``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateVerifiedFromAddress`: EmailStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateVerifiedFromAddress`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-notification-templates-in-bulk +Bulk Delete Notification Templates +This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-notification-templates-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNotificationTemplatesInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **templateBulkDeleteDto** | [**[]TemplateBulkDeleteDto**](../models/template-bulk-delete-dto) | | + +### Return type + + (empty response body) + +### 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() { + templatebulkdeletedto := []byte(``) // []TemplateBulkDeleteDto | + + + var templateBulkDeleteDto beta.[]TemplateBulkDeleteDto + if err := json.Unmarshal(templatebulkdeletedto, &templateBulkDeleteDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NotificationsAPI.DeleteNotificationTemplatesInBulk(context.Background()).TemplateBulkDeleteDto(templateBulkDeleteDto).Execute() + //r, err := apiClient.Beta.NotificationsAPI.DeleteNotificationTemplatesInBulk(context.Background()).TemplateBulkDeleteDto(templateBulkDeleteDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.DeleteNotificationTemplatesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-verified-from-address +Delete Verified From Address +Delete a verified sender email address + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-verified-from-address) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteVerifiedFromAddressRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `id_example` // string | # string | + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NotificationsAPI.DeleteVerifiedFromAddress(context.Background(), id).Execute() + //r, err := apiClient.Beta.NotificationsAPI.DeleteVerifiedFromAddress(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.DeleteVerifiedFromAddress``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-dkim-attributes +Get DKIM Attributes +Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-dkim-attributes) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDkimAttributesRequest struct via the builder pattern + + +### Return type + +[**[]DkimAttributes**](../models/dkim-attributes) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.GetDkimAttributes(context.Background()).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.GetDkimAttributes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetDkimAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDkimAttributes`: []DkimAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetDkimAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-mail-from-attributes +Get MAIL FROM Attributes +Retrieve MAIL FROM attributes for a given AWS SES identity. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mail-from-attributes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMailFromAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**MailFromAttributes**](../models/mail-from-attributes) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `bobsmith@sailpoint.com` // string | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # string | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.GetMailFromAttributes(context.Background(), identityId).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.GetMailFromAttributes(context.Background(), identityId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetMailFromAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMailFromAttributes`: MailFromAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetMailFromAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-notification-template +Get Notification Template By Id +This gets a template that you have modified for your site by Id. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-notification-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the Notification Template | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNotificationTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]TemplateDto**](../models/template-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Notification Template # string | Id of the Notification Template + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.GetNotificationTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.GetNotificationTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetNotificationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNotificationTemplate`: []TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetNotificationTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-notifications-template-context +Get Notification Template Context +The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes + that will be available per tenant (organization). + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-notifications-template-context) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNotificationsTemplateContextRequest struct via the builder pattern + + +### Return type + +[**NotificationTemplateContext**](../models/notification-template-context) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.GetNotificationsTemplateContext(context.Background()).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.GetNotificationsTemplateContext(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetNotificationsTemplateContext``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNotificationsTemplateContext`: NotificationTemplateContext + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetNotificationsTemplateContext`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-from-addresses +List From Addresses +Retrieve a list of sender email addresses and their verification statuses + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-from-addresses) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListFromAddressesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **email**: *eq, ge, le, sw* | + **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: **email** | + +### Return type + +[**[]EmailStatusDto**](../models/email-status-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `email eq "john.doe@company.com"` // 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: **email**: *eq, ge, le, sw* (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: **email**: *eq, ge, le, sw* (optional) + sorters := `email` // 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: **email** (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: **email** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.ListFromAddresses(context.Background()).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.ListFromAddresses(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListFromAddresses``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListFromAddresses`: []EmailStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListFromAddresses`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-notification-preferences +List Notification Preferences for tenant. +Returns a list of notification preferences for tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-preferences) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**key** | **string** | The notification key. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNotificationPreferencesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]PreferencesDto**](../models/preferences-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + key := `cloud_manual_work_item_summary` // string | The notification key. # string | The notification key. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.ListNotificationPreferences(context.Background(), key).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.ListNotificationPreferences(context.Background(), key).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationPreferences``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationPreferences`: []PreferencesDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationPreferences`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-notification-template-defaults +List Notification Template Defaults +This lists the default templates used for notifications, such as emails from IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-template-defaults) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNotificationTemplateDefaultsRequest struct via the builder pattern + + +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] + **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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* | + +### Return type + +[**[]TemplateDtoDefault**](../models/template-dto-default) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + filters := `key eq "cloud_manual_work_item_summary"` // 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.ListNotificationTemplateDefaults(context.Background()).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.ListNotificationTemplateDefaults(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationTemplateDefaults``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationTemplateDefaults`: []TemplateDtoDefault + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationTemplateDefaults`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-notification-templates +List Notification Templates +This lists the templates that you have modified for your site. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-templates) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNotificationTemplatesRequest struct via the builder pattern + + +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] + **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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* | + +### Return type + +[**[]TemplateDto**](../models/template-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + filters := `medium eq "EMAIL"` // 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.ListNotificationTemplates(context.Background()).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.ListNotificationTemplates(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationTemplates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationTemplates`: []TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationTemplates`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-mail-from-attributes +Change MAIL FROM domain +Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-mail-from-attributes) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutMailFromAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mailFromAttributesDto** | [**MailFromAttributesDto**](../models/mail-from-attributes-dto) | | + +### Return type + +[**MailFromAttributes**](../models/mail-from-attributes) + +### 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() { + mailfromattributesdto := []byte(`{ + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + }`) // MailFromAttributesDto | + + + var mailFromAttributesDto beta.MailFromAttributesDto + if err := json.Unmarshal(mailfromattributesdto, &mailFromAttributesDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.PutMailFromAttributes(context.Background()).MailFromAttributesDto(mailFromAttributesDto).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.PutMailFromAttributes(context.Background()).MailFromAttributesDto(mailFromAttributesDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.PutMailFromAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutMailFromAttributes`: MailFromAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.PutMailFromAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## send-test-notification +Send Test Notification +Send a Test Notification + +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-test-notification) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendTestNotificationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sendTestNotificationRequestDto** | [**SendTestNotificationRequestDto**](../models/send-test-notification-request-dto) | | + +### Return type + + (empty response body) + +### 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() { + sendtestnotificationrequestdto := []byte(`{ + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + }`) // SendTestNotificationRequestDto | + + + var sendTestNotificationRequestDto beta.SendTestNotificationRequestDto + if err := json.Unmarshal(sendtestnotificationrequestdto, &sendTestNotificationRequestDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NotificationsAPI.SendTestNotification(context.Background()).SendTestNotificationRequestDto(sendTestNotificationRequestDto).Execute() + //r, err := apiClient.Beta.NotificationsAPI.SendTestNotification(context.Background()).SendTestNotificationRequestDto(sendTestNotificationRequestDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.SendTestNotification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/OAuthClientsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/OAuthClientsAPI.md new file mode 100644 index 000000000..047823a58 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/OAuthClientsAPI.md @@ -0,0 +1,379 @@ +--- +id: beta-o-auth-clients +title: OAuthClients +pagination_label: OAuthClients +sidebar_label: OAuthClients +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OAuthClients', 'BetaOAuthClients'] +slug: /tools/sdk/go/beta/methods/o-auth-clients +tags: ['SDK', 'Software Development Kit', 'OAuthClients', 'BetaOAuthClients'] +--- + +# OAuthClientsAPI + Use this API to implement OAuth client functionality. +With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the Identity Security Cloud REST API. +Refer to [Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information about OAuth and how it works with the Identity Security Cloud REST API. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-oauth-client**](#create-oauth-client) | **Post** `/oauth-clients` | Create OAuth Client +[**delete-oauth-client**](#delete-oauth-client) | **Delete** `/oauth-clients/{id}` | Delete OAuth Client +[**get-oauth-client**](#get-oauth-client) | **Get** `/oauth-clients/{id}` | Get OAuth Client +[**list-oauth-clients**](#list-oauth-clients) | **Get** `/oauth-clients` | List OAuth Clients +[**patch-oauth-client**](#patch-oauth-client) | **Patch** `/oauth-clients/{id}` | Patch OAuth Client + + +## create-oauth-client +Create OAuth Client +This creates an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-oauth-client) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateOauthClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createOAuthClientRequest** | [**CreateOAuthClientRequest**](../models/create-o-auth-client-request) | | + +### Return type + +[**CreateOAuthClientResponse**](../models/create-o-auth-client-response) + +### 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() { + createoauthclientrequest := []byte(`{ + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345", "http://localhost:67890" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + }`) // CreateOAuthClientRequest | + + + var createOAuthClientRequest beta.CreateOAuthClientRequest + if err := json.Unmarshal(createoauthclientrequest, &createOAuthClientRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.OAuthClientsAPI.CreateOauthClient(context.Background()).CreateOAuthClientRequest(createOAuthClientRequest).Execute() + //resp, r, err := apiClient.Beta.OAuthClientsAPI.CreateOauthClient(context.Background()).CreateOAuthClientRequest(createOAuthClientRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.CreateOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateOauthClient`: CreateOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.CreateOauthClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-oauth-client +Delete OAuth Client +This deletes an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-oauth-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The OAuth client id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteOauthClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.OAuthClientsAPI.DeleteOauthClient(context.Background(), id).Execute() + //r, err := apiClient.Beta.OAuthClientsAPI.DeleteOauthClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.DeleteOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-oauth-client +Get OAuth Client +This gets details of an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-oauth-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The OAuth client id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOauthClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.OAuthClientsAPI.GetOauthClient(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.OAuthClientsAPI.GetOauthClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.GetOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOauthClient`: GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.GetOauthClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-oauth-clients +List OAuth Clients +This gets a list of OAuth clients. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-oauth-clients) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOauthClientsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **lastUsed**: *le, isnull* | + +### Return type + +[**[]GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `lastUsed le 2023-02-05T10:59:27.214Z` // 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.OAuthClientsAPI.ListOauthClients(context.Background()).Execute() + //resp, r, err := apiClient.Beta.OAuthClientsAPI.ListOauthClients(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.ListOauthClients``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOauthClients`: []GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.ListOauthClients`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-oauth-client +Patch OAuth Client +This performs a targeted update to the field(s) of an OAuth client. +Request will require a security scope of +- sp:oauth-client:manage + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-oauth-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The OAuth client id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchOauthClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported | + +### Return type + +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + jsonpatchoperation := []byte(`[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}]`) // []JsonPatchOperation | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.OAuthClientsAPI.PatchOauthClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.OAuthClientsAPI.PatchOauthClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.PatchOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchOauthClient`: GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.PatchOauthClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/OrgConfigAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/OrgConfigAPI.md new file mode 100644 index 000000000..2394bc7ca --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/OrgConfigAPI.md @@ -0,0 +1,206 @@ +--- +id: beta-org-config +title: OrgConfig +pagination_label: OrgConfig +sidebar_label: OrgConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OrgConfig', 'BetaOrgConfig'] +slug: /tools/sdk/go/beta/methods/org-config +tags: ['SDK', 'Software Development Kit', 'OrgConfig', 'BetaOrgConfig'] +--- + +# OrgConfigAPI + Use this API to implement organization configuration functionality. +Administrators can use this functionality to manage organization settings, such as time zones. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-org-config**](#get-org-config) | **Get** `/org-config` | Get Org configuration settings +[**get-valid-time-zones**](#get-valid-time-zones) | **Get** `/org-config/valid-time-zones` | Get list of time zones +[**patch-org-config**](#patch-org-config) | **Patch** `/org-config` | Patch an Org configuration property + + +## get-org-config +Get Org configuration settings +Get org configuration with only external (org admin) accessible properties for the current org. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-org-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOrgConfigRequest struct via the builder pattern + + +### Return type + +[**OrgConfig**](../models/org-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.OrgConfigAPI.GetOrgConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.OrgConfigAPI.GetOrgConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.GetOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOrgConfig`: OrgConfig + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.GetOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-valid-time-zones +Get list of time zones +Get a list of valid time zones that can be set in org configurations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-valid-time-zones) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetValidTimeZonesRequest struct via the builder pattern + + +### Return type + +**[]string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.OrgConfigAPI.GetValidTimeZones(context.Background()).Execute() + //resp, r, err := apiClient.Beta.OrgConfigAPI.GetValidTimeZones(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.GetValidTimeZones``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetValidTimeZones`: []string + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.GetValidTimeZones`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-org-config +Patch an Org configuration property +Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-org-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchOrgConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +[**OrgConfig**](../models/org-config) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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() { + jsonpatchoperation := []byte(`[{op=replace, path=/timeZone, value=America/Toronto}]`) // []JsonPatchOperation | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.OrgConfigAPI.PatchOrgConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.OrgConfigAPI.PatchOrgConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.PatchOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchOrgConfig`: OrgConfig + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.PatchOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/PasswordConfigurationAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordConfigurationAPI.md new file mode 100644 index 000000000..c954c91ab --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordConfigurationAPI.md @@ -0,0 +1,235 @@ +--- +id: beta-password-configuration +title: PasswordConfiguration +pagination_label: PasswordConfiguration +sidebar_label: PasswordConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordConfiguration', 'BetaPasswordConfiguration'] +slug: /tools/sdk/go/beta/methods/password-configuration +tags: ['SDK', 'Software Development Kit', 'PasswordConfiguration', 'BetaPasswordConfiguration'] +--- + +# PasswordConfigurationAPI + Use this API to implement organization password configuration functionality. +With this functionality in place, organization administrators can create organization-specific password configurations. + +These configurations include details like custom password instructions, as well as digit token length and duration. + +Refer to [Configuring User Authentication for Password Resets](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html) for more information about organization password configuration functionality. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-org-config**](#create-password-org-config) | **Post** `/password-org-config` | Create Password Org Config +[**get-password-org-config**](#get-password-org-config) | **Get** `/password-org-config` | Get Password Org Config +[**put-password-org-config**](#put-password-org-config) | **Put** `/password-org-config` | Update Password Org Config + + +## create-password-org-config +Create Password Org Config +This API creates the password org config. Unspecified fields will use default value. +To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-password-org-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePasswordOrgConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordOrgConfig** | [**PasswordOrgConfig**](../models/password-org-config) | | + +### Return type + +[**PasswordOrgConfig**](../models/password-org-config) + +### 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() { + passwordorgconfig := []byte(`{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }`) // PasswordOrgConfig | + + + var passwordOrgConfig beta.PasswordOrgConfig + if err := json.Unmarshal(passwordorgconfig, &passwordOrgConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordConfigurationAPI.CreatePasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + //resp, r, err := apiClient.Beta.PasswordConfigurationAPI.CreatePasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.CreatePasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.CreatePasswordOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-password-org-config +Get Password Org Config +This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-password-org-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordOrgConfigRequest struct via the builder pattern + + +### Return type + +[**PasswordOrgConfig**](../models/password-org-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordConfigurationAPI.GetPasswordOrgConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.PasswordConfigurationAPI.GetPasswordOrgConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.GetPasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.GetPasswordOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-password-org-config +Update Password Org Config +This API updates the password org config for specified fields. Other fields will keep original value. +You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-password-org-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutPasswordOrgConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordOrgConfig** | [**PasswordOrgConfig**](../models/password-org-config) | | + +### Return type + +[**PasswordOrgConfig**](../models/password-org-config) + +### 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() { + passwordorgconfig := []byte(`{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }`) // PasswordOrgConfig | + + + var passwordOrgConfig beta.PasswordOrgConfig + if err := json.Unmarshal(passwordorgconfig, &passwordOrgConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordConfigurationAPI.PutPasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + //resp, r, err := apiClient.Beta.PasswordConfigurationAPI.PutPasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.PutPasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutPasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.PutPasswordOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/PasswordDictionaryAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordDictionaryAPI.md new file mode 100644 index 000000000..1fcba3450 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordDictionaryAPI.md @@ -0,0 +1,241 @@ +--- +id: beta-password-dictionary +title: PasswordDictionary +pagination_label: PasswordDictionary +sidebar_label: PasswordDictionary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordDictionary', 'BetaPasswordDictionary'] +slug: /tools/sdk/go/beta/methods/password-dictionary +tags: ['SDK', 'Software Development Kit', 'PasswordDictionary', 'BetaPasswordDictionary'] +--- + +# PasswordDictionaryAPI + Use this API to implement password dictionary functionality. +With this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords. + +A password dictionary is a list of words or characters that users are prevented from including in their passwords. +This can help protect users from themselves and force them to create passwords that are not easy to break. + +A password dictionary must meet the following requirements to for the API to handle them correctly: + +- It must be in .txt format. + +- All characters must be UTF-8 characters. + +- Each line must contain a single word or character with no spaces or whitespace characters. + +- It must contain at least one line other than the locale string. + +- Each line must not exceed 128 characters. + +- The file must not exceed 2500 lines. + +Administrators should also consider the following when they create their dictionaries: + +- Lines starting with a # represent comments. + +- All words in the password dictionary are case-insensitive. +For example, adding the word "password" to the dictionary also disallows the following: PASSWORD, Password, and PassWord. + +- The dictionary uses substring matching. +For example, adding the word "spring" to the dictionary also disallows the following: Spring124, 345SprinG, and 8spring. +Users can then select 'Change Password' to update their passwords. + +Administrators must do the following to create a password dictionary: + +- Create the text file that will contain the prohibited password values. + +- If the dictionary is not in English, they must add a locale string to the top line: locale:`languageCode`_`countryCode` + +The languageCode value refers to the language's 2-letter ISO 639-1 code. +The countryCode value refers to the country's 2-letter ISO 3166-1 code. + +Refer to this list https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html to see all the available ISO 639-1 language codes and ISO 3166-1 country codes. + +- Upload the .txt file to Identity Security Cloud with [Update Password Dictionary](https://developer.sailpoint.com/docs/api/beta/put-password-dictionary). Uploading a new file always overwrites the previous dictionary file. + +Administrators can then specify which password policies check new passwords against the password dictionary by doing the following: In the Admin panel, they can use the Password Mgmt dropdown menu to select Policies, select the policy, and select the 'Prevent use of words in this site's password dictionary' checkbox beside it. + +Refer to [Configuring Advanced Password Management Options](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html) for more information about password dictionaries. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-password-dictionary**](#get-password-dictionary) | **Get** `/password-dictionary` | Get Password Dictionary +[**put-password-dictionary**](#put-password-dictionary) | **Put** `/password-dictionary` | Update Password Dictionary + + +## get-password-dictionary +Get Password Dictionary +This gets password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-password-dictionary) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordDictionaryRequest struct via the builder pattern + + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordDictionaryAPI.GetPasswordDictionary(context.Background()).Execute() + //resp, r, err := apiClient.Beta.PasswordDictionaryAPI.GetPasswordDictionary(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordDictionaryAPI.GetPasswordDictionary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordDictionary`: string + fmt.Fprintf(os.Stdout, "Response from `PasswordDictionaryAPI.GetPasswordDictionary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-password-dictionary +Update Password Dictionary +This updates password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-password-dictionary) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutPasswordDictionaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file** | ***os.File** | | + +### Return type + + (empty response body) + +### 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() { + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.PasswordDictionaryAPI.PutPasswordDictionary(context.Background()).Execute() + //r, err := apiClient.Beta.PasswordDictionaryAPI.PutPasswordDictionary(context.Background()).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordDictionaryAPI.PutPasswordDictionary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/PasswordManagementAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordManagementAPI.md new file mode 100644 index 000000000..3cfa2fd4b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordManagementAPI.md @@ -0,0 +1,381 @@ +--- +id: beta-password-management +title: PasswordManagement +pagination_label: PasswordManagement +sidebar_label: PasswordManagement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordManagement', 'BetaPasswordManagement'] +slug: /tools/sdk/go/beta/methods/password-management +tags: ['SDK', 'Software Development Kit', 'PasswordManagement', 'BetaPasswordManagement'] +--- + +# PasswordManagementAPI + Use this API to implement password management functionality. +With this functionality in place, users can manage their identity passwords for all their applications. + +In Identity Security Cloud, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. +Password Manager lists the user's identity's applications, possibly grouped to share passwords. +Users can then select 'Change Password' to update their passwords. + +Grouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. +Password Manager may list the applications and sources in the following groups: + +- Password Group: This refers to a group of applications that share a password. +For example, a user can use the same password for Google Drive, Google Mail, and YouTube. +Updating the password for the password group updates the password for all its included applications. + +- Multi-Application Source: This refers to a source with multiple applications that share a password. +For example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. +Updating the password for the multi-application source updates the password for all its included applications. + +- Applications: These are applications that do not share passwords with other applications. + +An organization may require some authentication for users to update their passwords. +Users may be required to answer security questions or use a third-party authenticator before they can confirm their updates. + +Refer to [Managing Passwords](https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html) for more information about password management. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-digit-token**](#create-digit-token) | **Post** `/generate-password-reset-token/digit` | Generate a digit token +[**get-identity-password-change-status**](#get-identity-password-change-status) | **Get** `/password-change-status/{id}` | Get Password Change Request Status +[**query-password-info**](#query-password-info) | **Post** `/query-password-info` | Query Password Info +[**set-identity-password**](#set-identity-password) | **Post** `/set-password` | Set Identity's Password + + +## create-digit-token +Generate a digit token +This API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create". + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-digit-token) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateDigitTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordDigitTokenReset** | [**PasswordDigitTokenReset**](../models/password-digit-token-reset) | | + +### Return type + +[**PasswordDigitToken**](../models/password-digit-token) + +### 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() { + passworddigittokenreset := []byte(`{ + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + }`) // PasswordDigitTokenReset | + + + var passwordDigitTokenReset beta.PasswordDigitTokenReset + if err := json.Unmarshal(passworddigittokenreset, &passwordDigitTokenReset); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordManagementAPI.CreateDigitToken(context.Background()).PasswordDigitTokenReset(passwordDigitTokenReset).Execute() + //resp, r, err := apiClient.Beta.PasswordManagementAPI.CreateDigitToken(context.Background()).PasswordDigitTokenReset(passwordDigitTokenReset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.CreateDigitToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDigitToken`: PasswordDigitToken + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.CreateDigitToken`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-password-change-status +Get Password Change Request Status +This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-password-change-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityPasswordChangeStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**PasswordStatus**](../models/password-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `id_example` // string | # string | + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordManagementAPI.GetIdentityPasswordChangeStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.PasswordManagementAPI.GetIdentityPasswordChangeStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.GetIdentityPasswordChangeStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityPasswordChangeStatus`: PasswordStatus + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.GetIdentityPasswordChangeStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## query-password-info +Query Password Info +This API is used to query password related information. + +A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) +is required to call this API. "API authority" refers to a token that only has the "client_credentials" +grant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) +or a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) +grant type will **NOT** work on this endpoint, and a `403 Forbidden` response +will be returned. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/query-password-info) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiQueryPasswordInfoRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordInfoQueryDTO** | [**PasswordInfoQueryDTO**](../models/password-info-query-dto) | | + +### Return type + +[**PasswordInfo**](../models/password-info) + +### 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() { + passwordinfoquerydto := []byte(`{ + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + }`) // PasswordInfoQueryDTO | + + + var passwordInfoQueryDTO beta.PasswordInfoQueryDTO + if err := json.Unmarshal(passwordinfoquerydto, &passwordInfoQueryDTO); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordManagementAPI.QueryPasswordInfo(context.Background()).PasswordInfoQueryDTO(passwordInfoQueryDTO).Execute() + //resp, r, err := apiClient.Beta.PasswordManagementAPI.QueryPasswordInfo(context.Background()).PasswordInfoQueryDTO(passwordInfoQueryDTO).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.QueryPasswordInfo``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `QueryPasswordInfo`: PasswordInfo + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.QueryPasswordInfo`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-identity-password +Set Identity's Password +This API is used to set a password for an identity. + +An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). + +A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity's password or the password of any of the identity's accounts. +"API authority" refers to a token that only has the "client_credentials" grant type. + +>**Note: If you want to set an identity's source account password, you must enable `PASSWORD` as one of the source's features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** + +You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). +To do so, follow these steps: + +1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. + +2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. + +3. Use [Set Identity's Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: + +```java +import javax.crypto.Cipher; +import java.security.KeyFactory; +import java.security.PublicKey; +import java.security.spec.X509EncodedKeySpec; +import java util.Base64; + +String encrypt(String publicKey, String toEncrypt) throws Exception { + byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); + byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes("UTF-8")); + return Base64.getEncoder().encodeToString(encryptedBytes); +} + +private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { + PublicKey key = KeyFactory.getInstance("RSA").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); + String transformation = "RSA/ECB/PKCS1Padding"; + Cipher cipher = Cipher.getInstance(transformation); + cipher.init(1, key); + return cipher.doFinal(toEncryptBytes); +} +``` + +In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. + +You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-identity-password) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetIdentityPasswordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordChangeRequest** | [**PasswordChangeRequest**](../models/password-change-request) | | + +### Return type + +[**PasswordChangeResponse**](../models/password-change-response) + +### 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() { + passwordchangerequest := []byte(`{ + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + }`) // PasswordChangeRequest | + + + var passwordChangeRequest beta.PasswordChangeRequest + if err := json.Unmarshal(passwordchangerequest, &passwordChangeRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordManagementAPI.SetIdentityPassword(context.Background()).PasswordChangeRequest(passwordChangeRequest).Execute() + //resp, r, err := apiClient.Beta.PasswordManagementAPI.SetIdentityPassword(context.Background()).PasswordChangeRequest(passwordChangeRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.SetIdentityPassword``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetIdentityPassword`: PasswordChangeResponse + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.SetIdentityPassword`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/PasswordPoliciesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordPoliciesAPI.md new file mode 100644 index 000000000..f5d40c08d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordPoliciesAPI.md @@ -0,0 +1,436 @@ +--- +id: beta-password-policies +title: PasswordPolicies +pagination_label: PasswordPolicies +sidebar_label: PasswordPolicies +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordPolicies', 'BetaPasswordPolicies'] +slug: /tools/sdk/go/beta/methods/password-policies +tags: ['SDK', 'Software Development Kit', 'PasswordPolicies', 'BetaPasswordPolicies'] +--- + +# PasswordPoliciesAPI + Use these APIs to implement password policies functionality. +These APIs allow you to define the policy parameters for choosing passwords. + +IdentityNow comes with a default policy that you can modify to define the password requirements your users must meet to log in to IdentityNow, such as requiring a minimum password length, including special characters, and disallowing certain patterns. +If you have licensed Password Management, you can create additional password policies beyond the default one to manage passwords for supported sources in your org. + +In the Identity Security Cloud Admin panel, administrators can use the Password Mgmt dropdown menu to select Sync Groups. + +Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/pwd_policies/pwd_policies.html) for more information about password policies. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-policy**](#create-password-policy) | **Post** `/password-policies` | Create Password Policy +[**delete-password-policy**](#delete-password-policy) | **Delete** `/password-policies/{id}` | Delete Password Policy by ID +[**get-password-policy-by-id**](#get-password-policy-by-id) | **Get** `/password-policies/{id}` | Get Password Policy by ID +[**list-password-policies**](#list-password-policies) | **Get** `/password-policies` | List Password Policies +[**set-password-policy**](#set-password-policy) | **Put** `/password-policies/{id}` | Update Password Policy by ID + + +## create-password-policy +Create Password Policy +This API creates the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-password-policy) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePasswordPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordPolicyV3Dto** | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | | + +### Return type + +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### 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() { + passwordpolicyv3dto := []byte(`{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }`) // PasswordPolicyV3Dto | + + + var passwordPolicyV3Dto beta.PasswordPolicyV3Dto + if err := json.Unmarshal(passwordpolicyv3dto, &passwordPolicyV3Dto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordPoliciesAPI.CreatePasswordPolicy(context.Background()).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + //resp, r, err := apiClient.Beta.PasswordPoliciesAPI.CreatePasswordPolicy(context.Background()).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.CreatePasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordPolicy`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.CreatePasswordPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-password-policy +Delete Password Policy by ID +This API deletes the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-password-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password policy to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePasswordPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ff808081838d9e9d01838da6a03e0002` // string | The ID of password policy to delete. # string | The ID of password policy to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.PasswordPoliciesAPI.DeletePasswordPolicy(context.Background(), id).Execute() + //r, err := apiClient.Beta.PasswordPoliciesAPI.DeletePasswordPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.DeletePasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-password-policy-by-id +Get Password Policy by ID +This API returns the password policy for the specified ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-password-policy-by-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password policy to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordPolicyByIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ff808081838d9e9d01838da6a03e0005` // string | The ID of password policy to retrieve. # string | The ID of password policy to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordPoliciesAPI.GetPasswordPolicyById(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.PasswordPoliciesAPI.GetPasswordPolicyById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.GetPasswordPolicyById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordPolicyById`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.GetPasswordPolicyById`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-password-policies +List Password Policies +This gets list of all Password Policies. +Requires role of ORG_ADMIN + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-password-policies) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPasswordPoliciesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordPoliciesAPI.ListPasswordPolicies(context.Background()).Execute() + //resp, r, err := apiClient.Beta.PasswordPoliciesAPI.ListPasswordPolicies(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.ListPasswordPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPasswordPolicies`: []PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.ListPasswordPolicies`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-password-policy +Update Password Policy by ID +This API updates the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-password-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password policy to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetPasswordPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **passwordPolicyV3Dto** | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | | + +### Return type + +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### 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 := `ff808081838d9e9d01838da6a03e0007` // string | The ID of password policy to update. # string | The ID of password policy to update. + passwordpolicyv3dto := []byte(`{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }`) // PasswordPolicyV3Dto | + + + var passwordPolicyV3Dto beta.PasswordPolicyV3Dto + if err := json.Unmarshal(passwordpolicyv3dto, &passwordPolicyV3Dto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordPoliciesAPI.SetPasswordPolicy(context.Background(), id).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + //resp, r, err := apiClient.Beta.PasswordPoliciesAPI.SetPasswordPolicy(context.Background(), id).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.SetPasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetPasswordPolicy`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.SetPasswordPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/PasswordSyncGroupsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordSyncGroupsAPI.md new file mode 100644 index 000000000..1ec323067 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/PasswordSyncGroupsAPI.md @@ -0,0 +1,408 @@ +--- +id: beta-password-sync-groups +title: PasswordSyncGroups +pagination_label: PasswordSyncGroups +sidebar_label: PasswordSyncGroups +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordSyncGroups', 'BetaPasswordSyncGroups'] +slug: /tools/sdk/go/beta/methods/password-sync-groups +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroups', 'BetaPasswordSyncGroups'] +--- + +# PasswordSyncGroupsAPI + Use this API to implement password sync group functionality. +With this functionality in place, administrators can group sources into password sync groups so that all their applications share the same password. +This allows users to update the password for all the applications in a sync group if they want, rather than updating each password individually. + +A password sync group is a group of applications that shares a password. +Administrators create these groups by grouping the applications' sources. +For example, an administrator can group the ActiveDirectory, GitHub, and G Suite sources together so that all those sources' applications can also be grouped to share a password. +A user can then update his or her password for ActiveDirectory, GitHub, Gmail, Google Drive, and Google Calendar all at once, rather then updating each one individually. + +The following are required for administrators to create a password sync group in Identity Security Cloud: + +- At least two direct connect sources connected to Identity Security Cloud and configured for Password Management. + +- Each authentication source in a sync group must have at least one application. Refer to [Adding and Resetting Application Passwords](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html#adding-and-resetting-application-passwords) for more information about adding applications to sources. + +- At least one password policy. Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/policies.html) for more information about password policies. + +In the Admin panel in Identity Security Cloud, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +To create a sync group, administrators must provide a name, choose a password policy to be enforced across the sources in the sync group, and select the sources to include in the sync group. + +Administrators can also delete sync groups in Identity Security Cloud, but they should know the following before they do: + +- Passwords related to the associated sources will become independent, so changing one will not change the others anymore. + +- Passwords for the sources' connected applications will also become independent. + +- Password policies assigned to the sync group are then assigned directly to the associated sources. +To change the password policy for a source, administrators must edit it directly. + +Once the password sync group has been created, users can update the password for the group in Password Manager. + +Refer to [Managing Password Sync Groups](https://documentation.sailpoint.com/saas/help/pwd/sync_grps.html) for more information about password sync groups. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-sync-group**](#create-password-sync-group) | **Post** `/password-sync-groups` | Create Password Sync Group +[**delete-password-sync-group**](#delete-password-sync-group) | **Delete** `/password-sync-groups/{id}` | Delete Password Sync Group by ID +[**get-password-sync-group**](#get-password-sync-group) | **Get** `/password-sync-groups/{id}` | Get Password Sync Group by ID +[**get-password-sync-groups**](#get-password-sync-groups) | **Get** `/password-sync-groups` | Get Password Sync Group List +[**update-password-sync-group**](#update-password-sync-group) | **Put** `/password-sync-groups/{id}` | Update Password Sync Group by ID + + +## create-password-sync-group +Create Password Sync Group +This API creates a password sync group based on the specifications provided. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-password-sync-group) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePasswordSyncGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordSyncGroup** | [**PasswordSyncGroup**](../models/password-sync-group) | | + +### Return type + +[**PasswordSyncGroup**](../models/password-sync-group) + +### 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() { + passwordsyncgroup := []byte(`{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }`) // PasswordSyncGroup | + + + var passwordSyncGroup beta.PasswordSyncGroup + if err := json.Unmarshal(passwordsyncgroup, &passwordSyncGroup); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordSyncGroupsAPI.CreatePasswordSyncGroup(context.Background()).PasswordSyncGroup(passwordSyncGroup).Execute() + //resp, r, err := apiClient.Beta.PasswordSyncGroupsAPI.CreatePasswordSyncGroup(context.Background()).PasswordSyncGroup(passwordSyncGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.CreatePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.CreatePasswordSyncGroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-password-sync-group +Delete Password Sync Group by ID +This API deletes the specified password sync group. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-password-sync-group) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password sync group to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePasswordSyncGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to delete. # string | The ID of password sync group to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.PasswordSyncGroupsAPI.DeletePasswordSyncGroup(context.Background(), id).Execute() + //r, err := apiClient.Beta.PasswordSyncGroupsAPI.DeletePasswordSyncGroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.DeletePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-password-sync-group +Get Password Sync Group by ID +This API returns the sync group for the specified ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-password-sync-group) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password sync group to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordSyncGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**PasswordSyncGroup**](../models/password-sync-group) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to retrieve. # string | The ID of password sync group to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordSyncGroupsAPI.GetPasswordSyncGroup(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.PasswordSyncGroupsAPI.GetPasswordSyncGroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.GetPasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.GetPasswordSyncGroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-password-sync-groups +Get Password Sync Group List +This API returns a list of password sync groups. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-password-sync-groups) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordSyncGroupsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]PasswordSyncGroup**](../models/password-sync-group) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordSyncGroupsAPI.GetPasswordSyncGroups(context.Background()).Execute() + //resp, r, err := apiClient.Beta.PasswordSyncGroupsAPI.GetPasswordSyncGroups(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.GetPasswordSyncGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordSyncGroups`: []PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.GetPasswordSyncGroups`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-password-sync-group +Update Password Sync Group by ID +This API updates the specified password sync group. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-password-sync-group) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password sync group to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdatePasswordSyncGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **passwordSyncGroup** | [**PasswordSyncGroup**](../models/password-sync-group) | | + +### Return type + +[**PasswordSyncGroup**](../models/password-sync-group) + +### 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 := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to update. # string | The ID of password sync group to update. + passwordsyncgroup := []byte(`{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }`) // PasswordSyncGroup | + + + var passwordSyncGroup beta.PasswordSyncGroup + if err := json.Unmarshal(passwordsyncgroup, &passwordSyncGroup); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordSyncGroupsAPI.UpdatePasswordSyncGroup(context.Background(), id).PasswordSyncGroup(passwordSyncGroup).Execute() + //resp, r, err := apiClient.Beta.PasswordSyncGroupsAPI.UpdatePasswordSyncGroup(context.Background(), id).PasswordSyncGroup(passwordSyncGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.UpdatePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.UpdatePasswordSyncGroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/PersonalAccessTokensAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/PersonalAccessTokensAPI.md new file mode 100644 index 000000000..7e8e6c7b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/PersonalAccessTokensAPI.md @@ -0,0 +1,308 @@ +--- +id: beta-personal-access-tokens +title: PersonalAccessTokens +pagination_label: PersonalAccessTokens +sidebar_label: PersonalAccessTokens +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PersonalAccessTokens', 'BetaPersonalAccessTokens'] +slug: /tools/sdk/go/beta/methods/personal-access-tokens +tags: ['SDK', 'Software Development Kit', 'PersonalAccessTokens', 'BetaPersonalAccessTokens'] +--- + +# PersonalAccessTokensAPI + Use this API to implement personal access token (PAT) functionality. +With this functionality in place, users can use PATs as an alternative to passwords for authentication in Identity Security Cloud. + +PATs embed user information into the client ID and secret. +This replaces the API clients' need to store and provide a username and password to establish a connection, improving Identity Security Cloud organizations' integration security. + +In Identity Security Cloud, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens. +They must then provide a description about the token's purpose. +They can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID. + +Refer to [Managing Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/generate_tokens.html) for more information about PATs. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-personal-access-token**](#create-personal-access-token) | **Post** `/personal-access-tokens` | Create Personal Access Token +[**delete-personal-access-token**](#delete-personal-access-token) | **Delete** `/personal-access-tokens/{id}` | Delete Personal Access Token +[**list-personal-access-tokens**](#list-personal-access-tokens) | **Get** `/personal-access-tokens` | List Personal Access Tokens +[**patch-personal-access-token**](#patch-personal-access-token) | **Patch** `/personal-access-tokens/{id}` | Patch Personal Access Token + + +## create-personal-access-token +Create Personal Access Token +This creates a personal access token. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-personal-access-token) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePersonalAccessTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createPersonalAccessTokenRequest** | [**CreatePersonalAccessTokenRequest**](../models/create-personal-access-token-request) | Name and scope of personal access token. | + +### Return type + +[**CreatePersonalAccessTokenResponse**](../models/create-personal-access-token-response) + +### 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() { + createpersonalaccesstokenrequest := []byte(`{ + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + }`) // CreatePersonalAccessTokenRequest | Name and scope of personal access token. + + + var createPersonalAccessTokenRequest beta.CreatePersonalAccessTokenRequest + if err := json.Unmarshal(createpersonalaccesstokenrequest, &createPersonalAccessTokenRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PersonalAccessTokensAPI.CreatePersonalAccessToken(context.Background()).CreatePersonalAccessTokenRequest(createPersonalAccessTokenRequest).Execute() + //resp, r, err := apiClient.Beta.PersonalAccessTokensAPI.CreatePersonalAccessToken(context.Background()).CreatePersonalAccessTokenRequest(createPersonalAccessTokenRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.CreatePersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePersonalAccessToken`: CreatePersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.CreatePersonalAccessToken`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-personal-access-token +Delete Personal Access Token +This deletes a personal access token. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-personal-access-token) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The personal access token id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePersonalAccessTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The personal access token id # string | The personal access token id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.PersonalAccessTokensAPI.DeletePersonalAccessToken(context.Background(), id).Execute() + //r, err := apiClient.Beta.PersonalAccessTokensAPI.DeletePersonalAccessToken(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.DeletePersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## list-personal-access-tokens +List Personal Access Tokens +This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-personal-access-tokens) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPersonalAccessTokensRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' | + **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: **lastUsed**: *le, isnull* | + +### Return type + +[**[]GetPersonalAccessTokenResponse**](../models/get-personal-access-token-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c9180867b50d088017b554662fb281e` // string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) # string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + filters := `lastUsed le 2023-02-05T10:59:27.214Z` // 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PersonalAccessTokensAPI.ListPersonalAccessTokens(context.Background()).Execute() + //resp, r, err := apiClient.Beta.PersonalAccessTokensAPI.ListPersonalAccessTokens(context.Background()).OwnerId(ownerId).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.ListPersonalAccessTokens``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPersonalAccessTokens`: []GetPersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.ListPersonalAccessTokens`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-personal-access-token +Patch Personal Access Token +This performs a targeted update to the field(s) of a Personal Access Token. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-personal-access-token) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Personal Access Token id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchPersonalAccessTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope | + +### Return type + +[**GetPersonalAccessTokenResponse**](../models/get-personal-access-token-response) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `ef38f94347e94562b5bb8424a56397d8` // string | The Personal Access Token id # string | The Personal Access Token id + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}]`) // []JsonPatchOperation | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PersonalAccessTokensAPI.PatchPersonalAccessToken(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.PersonalAccessTokensAPI.PatchPersonalAccessToken(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.PatchPersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPersonalAccessToken`: GetPersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.PatchPersonalAccessToken`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/PublicIdentitiesConfigAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/PublicIdentitiesConfigAPI.md new file mode 100644 index 000000000..14186a1c2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/PublicIdentitiesConfigAPI.md @@ -0,0 +1,176 @@ +--- +id: beta-public-identities-config +title: PublicIdentitiesConfig +pagination_label: PublicIdentitiesConfig +sidebar_label: PublicIdentitiesConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentitiesConfig', 'BetaPublicIdentitiesConfig'] +slug: /tools/sdk/go/beta/methods/public-identities-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentitiesConfig', 'BetaPublicIdentitiesConfig'] +--- + +# PublicIdentitiesConfigAPI + Use this API to implement public identity configuration functionality. +With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. +This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +By default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. +However, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc. +Administrators can use this API to make those necessary identity attributes public to non-administrators. + +For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. +If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/docs/api/beta/update-public-identity-config/) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-public-identity-config**](#get-public-identity-config) | **Get** `/public-identities-config` | Get Public Identity Config +[**update-public-identity-config**](#update-public-identity-config) | **Put** `/public-identities-config` | Update Public Identity Config + + +## get-public-identity-config +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get Public Identity Config +This gets details of public identity config. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-public-identity-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPublicIdentityConfigRequest struct via the builder pattern + + +### Return type + +[**PublicIdentityConfig**](../models/public-identity-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PublicIdentitiesConfigAPI.GetPublicIdentityConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.PublicIdentitiesConfigAPI.GetPublicIdentityConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesConfigAPI.GetPublicIdentityConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPublicIdentityConfig`: PublicIdentityConfig + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesConfigAPI.GetPublicIdentityConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-public-identity-config +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Update Public Identity Config +This updates the details of public identity config. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-public-identity-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdatePublicIdentityConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **publicIdentityConfig** | [**PublicIdentityConfig**](../models/public-identity-config) | | + +### Return type + +[**PublicIdentityConfig**](../models/public-identity-config) + +### 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() { + publicidentityconfig := []byte(`{ + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }`) // PublicIdentityConfig | + + + var publicIdentityConfig beta.PublicIdentityConfig + if err := json.Unmarshal(publicidentityconfig, &publicIdentityConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig(context.Background()).PublicIdentityConfig(publicIdentityConfig).Execute() + //resp, r, err := apiClient.Beta.PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig(context.Background()).PublicIdentityConfig(publicIdentityConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePublicIdentityConfig`: PublicIdentityConfig + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/RequestableObjectsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/RequestableObjectsAPI.md new file mode 100644 index 000000000..a9e1ae963 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/RequestableObjectsAPI.md @@ -0,0 +1,102 @@ +--- +id: beta-requestable-objects +title: RequestableObjects +pagination_label: RequestableObjects +sidebar_label: RequestableObjects +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObjects', 'BetaRequestableObjects'] +slug: /tools/sdk/go/beta/methods/requestable-objects +tags: ['SDK', 'Software Development Kit', 'RequestableObjects', 'BetaRequestableObjects'] +--- + +# RequestableObjectsAPI + Use this API to implement requestable object functionality. +With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/docs/api/beta/access-requests/), along with their statuses. +This can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**list-requestable-objects**](#list-requestable-objects) | **Get** `/requestable-objects` | Requestable Objects List + + +## list-requestable-objects +Requestable Objects List +Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. +Any authenticated token can call this endpoint to see their requestable access items. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-requestable-objects) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListRequestableObjectsRequest struct via the builder pattern + + +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. | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, in, sw* | + **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** | + +### Return type + +[**[]RequestableObject**](../models/requestable-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw "bob"` // 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, in, sw* (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, in, sw* (optional) + sorters := `name` // 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** (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** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RequestableObjectsAPI.ListRequestableObjects(context.Background()).Execute() + //resp, r, err := apiClient.Beta.RequestableObjectsAPI.ListRequestableObjects(context.Background()).IdentityId(identityId).Types(types).Term(term).Statuses(statuses).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RequestableObjectsAPI.ListRequestableObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListRequestableObjects`: []RequestableObject + fmt.Fprintf(os.Stdout, "Response from `RequestableObjectsAPI.ListRequestableObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/RoleInsightsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/RoleInsightsAPI.md new file mode 100644 index 000000000..25d4ebfe0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/RoleInsightsAPI.md @@ -0,0 +1,639 @@ +--- +id: beta-role-insights +title: RoleInsights +pagination_label: RoleInsights +sidebar_label: RoleInsights +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsights', 'BetaRoleInsights'] +slug: /tools/sdk/go/beta/methods/role-insights +tags: ['SDK', 'Software Development Kit', 'RoleInsights', 'BetaRoleInsights'] +--- + +# RoleInsightsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-role-insight-requests**](#create-role-insight-requests) | **Post** `/role-insights/requests` | Generate insights for roles +[**download-role-insights-entitlements-changes**](#download-role-insights-entitlements-changes) | **Get** `/role-insights/{insightId}/entitlement-changes/download` | Download entitlement insights for a role +[**get-entitlement-changes-identities**](#get-entitlement-changes-identities) | **Get** `/role-insights/{insightId}/entitlement-changes/{entitlementId}/identities` | Get identities for a suggested entitlement (for a role) +[**get-role-insight**](#get-role-insight) | **Get** `/role-insights/{insightId}` | Get a single role insight +[**get-role-insights**](#get-role-insights) | **Get** `/role-insights` | Get role insights +[**get-role-insights-current-entitlements**](#get-role-insights-current-entitlements) | **Get** `/role-insights/{insightId}/current-entitlements` | Get current entitlement for a role +[**get-role-insights-entitlements-changes**](#get-role-insights-entitlements-changes) | **Get** `/role-insights/{insightId}/entitlement-changes` | Get entitlement insights for a role +[**get-role-insights-requests**](#get-role-insights-requests) | **Get** `/role-insights/requests/{id}` | Returns metadata from prior request. +[**get-role-insights-summary**](#get-role-insights-summary) | **Get** `/role-insights/summary` | Get role insights summary information + + +## create-role-insight-requests +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Generate insights for roles +Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-role-insight-requests) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateRoleInsightRequestsRequest struct via the builder pattern + + +### Return type + +[**RoleInsightsResponse**](../models/role-insights-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.CreateRoleInsightRequests(context.Background()).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.CreateRoleInsightRequests(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.CreateRoleInsightRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRoleInsightRequests`: RoleInsightsResponse + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.CreateRoleInsightRequests`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## download-role-insights-entitlements-changes +Download entitlement insights for a role +This endpoint returns the entitlement insights for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/download-role-insights-entitlements-changes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**insightId** | **string** | The role insight id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDownloadRoleInsightsEntitlementsChangesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. | + **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: **name**: *sw* **description**: *sw* | + +### Return type + +**string** + +### 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() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight id + sorters := `identitiesWithAccess` // 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + filters := `name sw "r"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges(context.Background(), insightId).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges(context.Background(), insightId).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DownloadRoleInsightsEntitlementsChanges`: string + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlement-changes-identities +Get identities for a suggested entitlement (for a role) +Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement-changes-identities) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**insightId** | **string** | The role insight id | +**entitlementId** | **string** | The entitlement id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementChangesIdentitiesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **hasEntitlement** | **bool** | Identity has this entitlement or not | [default to false] + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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** | + **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: **name**: *sw* | + +### Return type + +[**[]RoleInsightsIdentities**](../models/role-insights-identities) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight id + entitlementId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The entitlement id # string | The entitlement id + hasEntitlement := true // bool | Identity has this entitlement or not (optional) (default to false) # bool | Identity has this entitlement or not (optional) (default to false) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name` // 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** (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** (optional) + filters := `name sw "Jan"` // 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: **name**: *sw* (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: **name**: *sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.GetEntitlementChangesIdentities(context.Background(), insightId, entitlementId).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.GetEntitlementChangesIdentities(context.Background(), insightId, entitlementId).HasEntitlement(hasEntitlement).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetEntitlementChangesIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementChangesIdentities`: []RoleInsightsIdentities + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetEntitlementChangesIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insight +Get a single role insight +This endpoint gets role insights information for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insight) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**insightId** | **string** | The role insight id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**RoleInsight**](../models/role-insight) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsight(context.Background(), insightId).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsight(context.Background(), insightId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsight``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsight`: RoleInsight + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsight`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insights +Get role insights +This method returns detailed role insights for each role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** | + **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: **name**: *sw* **ownerName**: *sw* **description**: *sw* | + +### Return type + +[**[]RoleInsight**](../models/role-insight) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `numberOfUpdates` // 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + filters := `name sw "John"` // 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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsights(context.Background()).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsights(context.Background()).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsights``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsights`: []RoleInsight + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsights`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insights-current-entitlements +Get current entitlement for a role +This endpoint gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights-current-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**insightId** | **string** | The role insight id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightsCurrentEntitlementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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: **name**: *sw* **description**: *sw* | + +### Return type + +[**[]RoleInsightsEntitlement**](../models/role-insights-entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight id + filters := `name sw "r"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsightsCurrentEntitlements(context.Background(), insightId).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsightsCurrentEntitlements(context.Background(), insightId).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsCurrentEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsCurrentEntitlements`: []RoleInsightsEntitlement + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsCurrentEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insights-entitlements-changes +Get entitlement insights for a role +This endpoint returns entitlement insights for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights-entitlements-changes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**insightId** | **string** | The role insight id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightsEntitlementsChangesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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: **identitiesWithAccess, name** | + **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: **name**: *sw* **description**: *sw* | + +### Return type + +[**[]RoleInsightsEntitlementChanges**](../models/role-insights-entitlement-changes) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight id + sorters := `sorters_example` // 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: **identitiesWithAccess, name** (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: **identitiesWithAccess, name** (optional) + filters := `name sw "Admin"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsightsEntitlementsChanges(context.Background(), insightId).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsightsEntitlementsChanges(context.Background(), insightId).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsEntitlementsChanges``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsEntitlementsChanges`: []RoleInsightsEntitlementChanges + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsEntitlementsChanges`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insights-requests +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Returns metadata from prior request. +This endpoint returns details of a prior role insights request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights-requests) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The role insights request id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightsRequestsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**RoleInsightsResponse**](../models/role-insights-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insights request id # string | The role insights request id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsightsRequests(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsightsRequests(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsRequests`: RoleInsightsResponse + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsRequests`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insights-summary +Get role insights summary information +This method returns high level summary information for role insights for a customer. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights-summary) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightsSummaryRequest struct via the builder pattern + + +### Return type + +[**RoleInsightsSummary**](../models/role-insights-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsightsSummary(context.Background()).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsightsSummary(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsSummary`: RoleInsightsSummary + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/RolesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/RolesAPI.md new file mode 100644 index 000000000..e932eff3d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/RolesAPI.md @@ -0,0 +1,826 @@ +--- +id: beta-roles +title: Roles +pagination_label: Roles +sidebar_label: Roles +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Roles', 'BetaRoles'] +slug: /tools/sdk/go/beta/methods/roles +tags: ['SDK', 'Software Development Kit', 'Roles', 'BetaRoles'] +--- + +# RolesAPI + Use this API to implement and customize role functionality. +With this functionality in place, administrators can create roles and configure them for use throughout Identity Security Cloud. +Identity Security Cloud can use established criteria to automatically assign the roles to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. + +Entitlements represent the most granular level of access in Identity Security Cloud. +Access profiles represent the next level and often group entitlements. +Roles represent the broadest level of access and often group access profiles. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Roles often represent positions within organizations. +For example, an organization's accountant can access all the tools the organization's accountants need with the 'Accountant' role. +If the accountant switches to engineering, a qualified member of the organization can quickly revoke the accountant's 'Accountant' access and grant access to the 'Engineer' role instead, granting access to all the tools the organization's engineers need. + +In Identity Security Cloud, adminstrators can use the Access drop-down menu and select Roles to view, configure, and delete existing roles, as well as create new ones. +Administrators can enable and disable the role, and they can also make the following configurations: + +- Manage Access: Manage the role's access by adding or removing access profiles. + +- Define Assignment: Define the criteria Identity Security Cloud uses to assign the role to identities. +Use the first option, 'Standard Criteria,' to provide specific criteria for assignment like specific account attributes, entitlements, or identity attributes. +Use the second, 'Identity List,' to specify the identities for assignment. + +- Access Requests: Configure roles to be requestable and establish an approval process for any requests that the role be granted or revoked. +Do not configure a role to be requestable without establishing a secure access request approval process for that role first. + +Refer to [Working with Roles](https://documentation.sailpoint.com/saas/help/access/roles.html) for more information about roles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-role**](#create-role) | **Post** `/roles` | Create a Role +[**delete-bulk-roles**](#delete-bulk-roles) | **Post** `/roles/bulk-delete` | Delete Role(s) +[**delete-role**](#delete-role) | **Delete** `/roles/{id}` | Delete a Role +[**get-role**](#get-role) | **Get** `/roles/{id}` | Get a Role +[**get-role-assigned-identities**](#get-role-assigned-identities) | **Get** `/roles/{id}/assigned-identities` | Identities assigned a Role +[**get-role-entitlements**](#get-role-entitlements) | **Get** `/roles/{id}/entitlements` | List Role's Entitlements +[**list-roles**](#list-roles) | **Get** `/roles` | List Roles +[**patch-role**](#patch-role) | **Patch** `/roles/{id}` | Patch a specified Role + + +## create-role +Create a Role +This API creates a role. + +You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. + +In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-role) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **role** | [**Role**](../models/role) | | + +### Return type + +[**Role**](../models/role) + +### 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() { + role := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + }`) // Role | + + + var role beta.Role + if err := json.Unmarshal(role, &role); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RolesAPI.CreateRole(context.Background()).Role(role).Execute() + //resp, r, err := apiClient.Beta.RolesAPI.CreateRole(context.Background()).Role(role).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.CreateRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.CreateRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-bulk-roles +Delete Role(s) +This endpoint initiates a bulk deletion of one or more roles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 roles per request. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-bulk-roles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteBulkRolesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **roleBulkDeleteRequest** | [**RoleBulkDeleteRequest**](../models/role-bulk-delete-request) | | + +### Return type + +[**TaskResultDto**](../models/task-result-dto) + +### 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() { + rolebulkdeleterequest := []byte(`{ + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + }`) // RoleBulkDeleteRequest | + + + var roleBulkDeleteRequest beta.RoleBulkDeleteRequest + if err := json.Unmarshal(rolebulkdeleterequest, &roleBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RolesAPI.DeleteBulkRoles(context.Background()).RoleBulkDeleteRequest(roleBulkDeleteRequest).Execute() + //resp, r, err := apiClient.Beta.RolesAPI.DeleteBulkRoles(context.Background()).RoleBulkDeleteRequest(roleBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteBulkRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteBulkRoles`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.DeleteBulkRoles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-role +Delete a Role +This API deletes a Role by its ID. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Role | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role # string | ID of the Role + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.RolesAPI.DeleteRole(context.Background(), id).Execute() + //r, err := apiClient.Beta.RolesAPI.DeleteRole(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-role +Get a Role +This API returns a Role by its ID. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Role | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role # string | ID of the Role + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RolesAPI.GetRole(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.RolesAPI.GetRole(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-assigned-identities +Identities assigned a Role + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-assigned-identities) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Role for which the assigned Identities are to be listed | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleAssignedIdentitiesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* | + **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: **id, name, aliasName, email** | + +### Return type + +[**[]RoleIdentity**](../models/role-identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role for which the assigned Identities are to be listed # string | ID of the Role for which the assigned Identities are to be listed + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw Joe` // 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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + sorters := `aliasName,name` // 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: **id, name, aliasName, email** (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: **id, name, aliasName, email** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RolesAPI.GetRoleAssignedIdentities(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.RolesAPI.GetRoleAssignedIdentities(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRoleAssignedIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleAssignedIdentities`: []RoleIdentity + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRoleAssignedIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-entitlements +List Role's Entitlements +Get a list of entitlements associated with a specified role. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Containing role's ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleEntitlementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* | + **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, attribute, value, created, modified** | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | Containing role's ID. # string | Containing role's ID. + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RolesAPI.GetRoleEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.RolesAPI.GetRoleEntitlements(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRoleEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRoleEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-roles +List Roles +This API returns a list of Roles. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-roles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListRolesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **forSubadmin** | **string** | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. | + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *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, created, modified** | + **forSegmentIds** | **string** | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. | + **includeUnsegmented** | **bool** | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. | [default to true] + +### Return type + +[**[]Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `requestable 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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RolesAPI.ListRoles(context.Background()).Execute() + //resp, r, err := apiClient.Beta.RolesAPI.ListRoles(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.ListRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListRoles`: []Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.ListRoles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-role +Patch a specified Role +This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: + +* name +* description +* enabled +* owner +* accessProfiles +* entitlements +* membership +* requestable +* accessRequestConfig +* revokeRequestConfig +* segments +* accessModelMetadata +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Role to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `2c91808a7813090a017814121e121518` // string | ID of the Role to patch # string | ID of the Role to patch + jsonpatchoperation := []byte(`[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]`) // []JsonPatchOperation | + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RolesAPI.PatchRole(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.RolesAPI.PatchRole(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.PatchRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.PatchRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SIMIntegrationsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SIMIntegrationsAPI.md new file mode 100644 index 000000000..460f928d6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SIMIntegrationsAPI.md @@ -0,0 +1,544 @@ +--- +id: beta-sim-integrations +title: SIMIntegrations +pagination_label: SIMIntegrations +sidebar_label: SIMIntegrations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SIMIntegrations', 'BetaSIMIntegrations'] +slug: /tools/sdk/go/beta/methods/sim-integrations +tags: ['SDK', 'Software Development Kit', 'SIMIntegrations', 'BetaSIMIntegrations'] +--- + +# SIMIntegrationsAPI + Use this API to administer IdentityNow's Service Integration Module, or SIM integration with ServiceNow, so that it converts IdentityNow provisioning actions into tickets in ServiceNow. + +ServiceNow is a software platform that supports IT service management and automates common business processes for requesting and fulfilling service requests across a business enterprise. + +You must have an IdentityNow ServiceNow ServiceDesk license to use this integration. Contact your Customer Success Manager for more information. + +Service Desk integration for IdentityNow and in deprecation - not available for new implementation, as of July 21st, 2021. As per SailPoint’s [support policy](https://community.sailpoint.com/t5/Connector-Directory/SailPoint-Support-Policy-for-Connectivity/ta-p/79422), all existing SailPoint IdentityNow customers using this legacy integration will be supported until July 2022. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-sim-integration**](#create-sim-integration) | **Post** `/sim-integrations` | Create new SIM integration +[**delete-sim-integration**](#delete-sim-integration) | **Delete** `/sim-integrations/{id}` | Delete a SIM integration +[**get-sim-integration**](#get-sim-integration) | **Get** `/sim-integrations/{id}` | Get a SIM integration details. +[**get-sim-integrations**](#get-sim-integrations) | **Get** `/sim-integrations` | List the existing SIM integrations. +[**patch-before-provisioning-rule**](#patch-before-provisioning-rule) | **Patch** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a SIM beforeProvisioningRule attribute. +[**patch-sim-attributes**](#patch-sim-attributes) | **Patch** `/sim-integrations/{id}` | Patch a SIM attribute. +[**put-sim-integration**](#put-sim-integration) | **Put** `/sim-integrations/{id}` | Update an existing SIM integration + + +## create-sim-integration +Create new SIM integration +Create a new SIM Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-sim-integration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSIMIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **simIntegrationDetails** | [**SimIntegrationDetails**](../models/sim-integration-details) | DTO containing the details of the SIM integration | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### 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() { + simintegrationdetails := []byte(`{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }`) // SimIntegrationDetails | DTO containing the details of the SIM integration + + + var simIntegrationDetails beta.SimIntegrationDetails + if err := json.Unmarshal(simintegrationdetails, &simIntegrationDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SIMIntegrationsAPI.CreateSIMIntegration(context.Background()).SimIntegrationDetails(simIntegrationDetails).Execute() + //resp, r, err := apiClient.Beta.SIMIntegrationsAPI.CreateSIMIntegration(context.Background()).SimIntegrationDetails(simIntegrationDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.CreateSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.CreateSIMIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-sim-integration +Delete a SIM integration +Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-sim-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the integration to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSIMIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `12345` // string | The id of the integration to delete. # string | The id of the integration to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SIMIntegrationsAPI.DeleteSIMIntegration(context.Background(), id).Execute() + //r, err := apiClient.Beta.SIMIntegrationsAPI.DeleteSIMIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.DeleteSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-sim-integration +Get a SIM integration details. +Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sim-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the integration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSIMIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `12345` // string | The id of the integration. # string | The id of the integration. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SIMIntegrationsAPI.GetSIMIntegration(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SIMIntegrationsAPI.GetSIMIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.GetSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.GetSIMIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sim-integrations +List the existing SIM integrations. +List the existing SIM integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sim-integrations) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSIMIntegrationsRequest struct via the builder pattern + + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SIMIntegrationsAPI.GetSIMIntegrations(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SIMIntegrationsAPI.GetSIMIntegrations(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.GetSIMIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSIMIntegrations`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.GetSIMIntegrations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-before-provisioning-rule +Patch a SIM beforeProvisioningRule attribute. +Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-before-provisioning-rule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | SIM integration id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchBeforeProvisioningRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatch** | [**JsonPatch**](../models/json-patch) | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `12345` // string | SIM integration id # string | SIM integration id + jsonpatch := []byte(`"[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]"`) // JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + + + var jsonPatch beta.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SIMIntegrationsAPI.PatchBeforeProvisioningRule(context.Background(), id).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.Beta.SIMIntegrationsAPI.PatchBeforeProvisioningRule(context.Background(), id).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PatchBeforeProvisioningRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchBeforeProvisioningRule`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PatchBeforeProvisioningRule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-sim-attributes +Patch a SIM attribute. +Patch a SIM attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-sim-attributes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | SIM integration id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSIMAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatch** | [**JsonPatch**](../models/json-patch) | The JsonPatch object that describes the changes of SIM | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `12345` // string | SIM integration id # string | SIM integration id + jsonpatch := []byte(`"[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]"`) // JsonPatch | The JsonPatch object that describes the changes of SIM + + + var jsonPatch beta.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SIMIntegrationsAPI.PatchSIMAttributes(context.Background(), id).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.Beta.SIMIntegrationsAPI.PatchSIMAttributes(context.Background(), id).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PatchSIMAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSIMAttributes`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PatchSIMAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-sim-integration +Update an existing SIM integration +Update an existing SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-sim-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the integration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSIMIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **simIntegrationDetails** | [**SimIntegrationDetails**](../models/sim-integration-details) | The full DTO of the integration containing the updated model | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### 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 := `12345` // string | The id of the integration. # string | The id of the integration. + simintegrationdetails := []byte(`{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }`) // SimIntegrationDetails | The full DTO of the integration containing the updated model + + + var simIntegrationDetails beta.SimIntegrationDetails + if err := json.Unmarshal(simintegrationdetails, &simIntegrationDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SIMIntegrationsAPI.PutSIMIntegration(context.Background(), id).SimIntegrationDetails(simIntegrationDetails).Execute() + //resp, r, err := apiClient.Beta.SIMIntegrationsAPI.PutSIMIntegration(context.Background(), id).SimIntegrationDetails(simIntegrationDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PutSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PutSIMIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SODPoliciesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SODPoliciesAPI.md new file mode 100644 index 000000000..2f94c6efa --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SODPoliciesAPI.md @@ -0,0 +1,1397 @@ +--- +id: beta-sod-policies +title: SODPolicies +pagination_label: SODPolicies +sidebar_label: SODPolicies +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SODPolicies', 'BetaSODPolicies'] +slug: /tools/sdk/go/beta/methods/sod-policies +tags: ['SDK', 'Software Development Kit', 'SODPolicies', 'BetaSODPolicies'] +--- + +# SODPoliciesAPI + Use this API to implement and manage "separation of duties" (SOD) policies. +With SOD policy functionality in place, administrators can organize the access in their tenants to prevent individuals from gaining conflicting or excessive access. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +To create SOD policies in Identity Security Cloud, administrators use 'Search' and then access 'Policies'. +To create a policy, they must configure two lists of access items. Each access item can only be added to one of the two lists. +They can search for the entitlements they want to add to these access lists. + +>Note: You can have a maximum of 500 policies of any type (including general policies) in your organization. In each access-based SOD policy, you can have a maximum of 50 entitlements in each access list. + +Once a SOD policy is in place, if an identity has access items on both lists, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +To create a subscription to a SOD policy in Identity Security Cloud, administrators use 'Search' and then access 'Layers'. +They can create a subscription to the policy and schedule it to run at a regular interval. + +Refer to [Managing Policies](https://documentation.sailpoint.com/saas/help/sod/manage-policies.html) for more information about SOD policies. + +Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-sod-policy**](#create-sod-policy) | **Post** `/sod-policies` | Create SOD policy +[**delete-sod-policy**](#delete-sod-policy) | **Delete** `/sod-policies/{id}` | Delete SOD policy by ID +[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **Delete** `/sod-policies/{id}/schedule` | Delete SOD policy schedule +[**get-custom-violation-report**](#get-custom-violation-report) | **Get** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report +[**get-default-violation-report**](#get-default-violation-report) | **Get** `/sod-violation-report/{reportResultId}/download` | Download violation report +[**get-sod-all-report-run-status**](#get-sod-all-report-run-status) | **Get** `/sod-violation-report` | Get multi-report run task status +[**get-sod-policy**](#get-sod-policy) | **Get** `/sod-policies/{id}` | Get SOD policy by ID +[**get-sod-policy-schedule**](#get-sod-policy-schedule) | **Get** `/sod-policies/{id}/schedule` | Get SOD policy schedule +[**get-sod-violation-report-run-status**](#get-sod-violation-report-run-status) | **Get** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status +[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **Get** `/sod-policies/{id}/violation-report` | Get SOD violation report status +[**list-sod-policies**](#list-sod-policies) | **Get** `/sod-policies` | List SOD policies +[**patch-sod-policy**](#patch-sod-policy) | **Patch** `/sod-policies/{id}` | Patch a SOD policy +[**put-policy-schedule**](#put-policy-schedule) | **Put** `/sod-policies/{id}/schedule` | Update SOD Policy schedule +[**put-sod-policy**](#put-sod-policy) | **Put** `/sod-policies/{id}` | Update SOD policy by ID +[**start-sod-all-policies-for-org**](#start-sod-all-policies-for-org) | **Post** `/sod-violation-report/run` | Runs all policies for org +[**start-sod-policy**](#start-sod-policy) | **Post** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report + + +## create-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Create SOD policy +This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-sod-policy) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sodPolicy** | [**SodPolicy**](../models/sod-policy) | | + +### Return type + +[**SodPolicy**](../models/sod-policy) + +### 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() { + sodpolicy := []byte(`{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }`) // SodPolicy | + + + var sodPolicy beta.SodPolicy + if err := json.Unmarshal(sodpolicy, &sodPolicy); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.CreateSodPolicy(context.Background()).SodPolicy(sodPolicy).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.CreateSodPolicy(context.Background()).SodPolicy(sodPolicy).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.CreateSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.CreateSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Delete SOD policy by ID +This deletes a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD Policy to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **logical** | **bool** | Indicates whether this is a soft delete (logical true) or a hard delete. | [default to true] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the SOD Policy to delete. # string | The ID of the SOD Policy to delete. + logical := true // bool | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to true) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SODPoliciesAPI.DeleteSodPolicy(context.Background(), id).Execute() + //r, err := apiClient.Beta.SODPoliciesAPI.DeleteSodPolicy(context.Background(), id).Logical(logical).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.DeleteSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-sod-policy-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Delete SOD policy schedule +This deletes schedule for a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-sod-policy-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy the schedule must be deleted for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSodPolicyScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the SOD policy the schedule must be deleted for. # string | The ID of the SOD policy the schedule must be deleted for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SODPoliciesAPI.DeleteSodPolicySchedule(context.Background(), id).Execute() + //r, err := apiClient.Beta.SODPoliciesAPI.DeleteSodPolicySchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.DeleteSodPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-custom-violation-report +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Download custom violation report +This allows to download a specified named violation report for a given report reference. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-custom-violation-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**reportResultId** | **string** | The ID of the report reference to download. | +**fileName** | **string** | Custom Name for the file. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCustomViolationReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reportResultId := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the report reference to download. # string | The ID of the report reference to download. + fileName := `custom-name` // string | Custom Name for the file. # string | Custom Name for the file. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.GetCustomViolationReport(context.Background(), reportResultId, fileName).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.GetCustomViolationReport(context.Background(), reportResultId, fileName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetCustomViolationReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCustomViolationReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetCustomViolationReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-default-violation-report +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Download violation report +This allows to download a violation report for a given report reference. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-default-violation-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**reportResultId** | **string** | The ID of the report reference to download. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDefaultViolationReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reportResultId := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the report reference to download. # string | The ID of the report reference to download. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.GetDefaultViolationReport(context.Background(), reportResultId).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.GetDefaultViolationReport(context.Background(), reportResultId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetDefaultViolationReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDefaultViolationReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetDefaultViolationReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-all-report-run-status +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get multi-report run task status +This endpoint gets the status for a violation report for all policy run. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-all-report-run-status) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodAllReportRunStatusRequest struct via the builder pattern + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodAllReportRunStatus(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodAllReportRunStatus(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodAllReportRunStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodAllReportRunStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodAllReportRunStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get SOD policy by ID +This gets specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the object reference to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to retrieve. # string | The ID of the object reference to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-policy-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get SOD policy schedule +This endpoint gets a specified SOD policy's schedule. +Requires the role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-policy-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the object reference to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodPolicyScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to retrieve. # string | The ID of the object reference to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodPolicySchedule(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodPolicySchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodPolicySchedule`: SodPolicySchedule + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodPolicySchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-violation-report-run-status +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get violation report run status +This gets the status for a violation report run task that has already been invoked. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-violation-report-run-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**reportResultId** | **string** | The ID of the report reference to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodViolationReportRunStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reportResultId := `2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | The ID of the report reference to retrieve. # string | The ID of the report reference to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodViolationReportRunStatus(context.Background(), reportResultId).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodViolationReportRunStatus(context.Background(), reportResultId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodViolationReportRunStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodViolationReportRunStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodViolationReportRunStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-violation-report-status +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get SOD violation report status +This gets the status for a violation report run task that has already been invoked. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-violation-report-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the object reference to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodViolationReportStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to retrieve. # string | The ID of the object reference to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodViolationReportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodViolationReportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodViolationReportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodViolationReportStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodViolationReportStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-sod-policies +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +List SOD policies +This gets list of all SOD policies. +Requires role of ORG_ADMIN + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-sod-policies) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSodPoliciesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, in* **state**: *eq, in* | + **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: **id, name, created, modified, description** | + +### Return type + +[**[]SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "bc693f07e7b645539626c25954c58554"` // 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, in* **state**: *eq, in* (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, in* **state**: *eq, in* (optional) + sorters := `id,name` // 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: **id, name, created, modified, description** (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: **id, name, created, modified, description** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.ListSodPolicies(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.ListSodPolicies(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.ListSodPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSodPolicies`: []SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.ListSodPolicies`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Patch a SOD policy +Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Requires role of ORG_ADMIN. +This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy being modified. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **requestBody** | **[]map[string]interface{}** | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria | + +### Return type + +[**SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `2c9180835d191a86015d28455b4a2329` // string | The ID of the SOD policy being modified. # string | The ID of the SOD policy being modified. + requestbody := []byte(`[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]`) // []map[string]interface{} | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + + + var requestBody beta.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.PatchSodPolicy(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.PatchSodPolicy(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PatchSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PatchSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-policy-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Update SOD Policy schedule +This updates schedule for a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-policy-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy to update its schedule. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutPolicyScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **sodPolicySchedule** | [**SodPolicySchedule**](../models/sod-policy-schedule) | | + +### Return type + +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the SOD policy to update its schedule. # string | The ID of the SOD policy to update its schedule. + sodpolicyschedule := []byte(`{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }`) // SodPolicySchedule | + + + var sodPolicySchedule beta.SodPolicySchedule + if err := json.Unmarshal(sodpolicyschedule, &sodPolicySchedule); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.PutPolicySchedule(context.Background(), id).SodPolicySchedule(sodPolicySchedule).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.PutPolicySchedule(context.Background(), id).SodPolicySchedule(sodPolicySchedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PutPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutPolicySchedule`: SodPolicySchedule + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PutPolicySchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Update SOD policy by ID +This updates a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **sodPolicy** | [**SodPolicy**](../models/sod-policy) | | + +### Return type + +[**SodPolicy**](../models/sod-policy) + +### 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the SOD policy to update. # string | The ID of the SOD policy to update. + sodpolicy := []byte(`{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }`) // SodPolicy | + + + var sodPolicy beta.SodPolicy + if err := json.Unmarshal(sodpolicy, &sodPolicy); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.PutSodPolicy(context.Background(), id).SodPolicy(sodPolicy).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.PutSodPolicy(context.Background(), id).SodPolicy(sodPolicy).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PutSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PutSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-sod-all-policies-for-org +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Runs all policies for org +Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-sod-all-policies-for-org) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartSodAllPoliciesForOrgRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **multiPolicyRequest** | [**MultiPolicyRequest**](../models/multi-policy-request) | | + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multipolicyrequest := []byte(`{ + "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] + }`) // MultiPolicyRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.StartSodAllPoliciesForOrg(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.StartSodAllPoliciesForOrg(context.Background()).MultiPolicyRequest(multiPolicyRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartSodAllPoliciesForOrg``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartSodAllPoliciesForOrg`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartSodAllPoliciesForOrg`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Runs SOD policy violation report +This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The SOD policy ID to run. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The SOD policy ID to run. # string | The SOD policy ID to run. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.StartSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.StartSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartSodPolicy`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SODViolationsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SODViolationsAPI.md new file mode 100644 index 000000000..576fde715 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SODViolationsAPI.md @@ -0,0 +1,122 @@ +--- +id: beta-sod-violations +title: SODViolations +pagination_label: SODViolations +sidebar_label: SODViolations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SODViolations', 'BetaSODViolations'] +slug: /tools/sdk/go/beta/methods/sod-violations +tags: ['SDK', 'Software Development Kit', 'SODViolations', 'BetaSODViolations'] +--- + +# SODViolationsAPI + Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations. +With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +Once a SOD policy is in place, if an identity has conflicting access items, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. +This second option is a good way to prevent SOD violations from triggering at all. + +Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**start-predict-sod-violations**](#start-predict-sod-violations) | **Post** `/sod-violations/predict` | Predict SOD violations for identity. + + +## start-predict-sod-violations +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Predict SOD violations for identity. +This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + +A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-predict-sod-violations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartPredictSodViolationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityWithNewAccess** | [**IdentityWithNewAccess**](../models/identity-with-new-access) | | + +### Return type + +[**ViolationPrediction**](../models/violation-prediction) + +### 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() { + identitywithnewaccess := []byte(`{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }`) // IdentityWithNewAccess | + + + var identityWithNewAccess beta.IdentityWithNewAccess + if err := json.Unmarshal(identitywithnewaccess, &identityWithNewAccess); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODViolationsAPI.StartPredictSodViolations(context.Background()).IdentityWithNewAccess(identityWithNewAccess).Execute() + //resp, r, err := apiClient.Beta.SODViolationsAPI.StartPredictSodViolations(context.Background()).IdentityWithNewAccess(identityWithNewAccess).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODViolationsAPI.StartPredictSodViolations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartPredictSodViolations`: ViolationPrediction + fmt.Fprintf(os.Stdout, "Response from `SODViolationsAPI.StartPredictSodViolations`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SPConfigAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SPConfigAPI.md new file mode 100644 index 000000000..2c1dcc103 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SPConfigAPI.md @@ -0,0 +1,501 @@ +--- +id: beta-sp-config +title: SPConfig +pagination_label: SPConfig +sidebar_label: SPConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SPConfig', 'BetaSPConfig'] +slug: /tools/sdk/go/beta/methods/sp-config +tags: ['SDK', 'Software Development Kit', 'SPConfig', 'BetaSPConfig'] +--- + +# SPConfigAPI + Import and export configuration for some objects between tenants. +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**export-sp-config**](#export-sp-config) | **Post** `/sp-config/export` | Initiates configuration objects export job +[**get-sp-config-export**](#get-sp-config-export) | **Get** `/sp-config/export/{id}/download` | Download export job result. +[**get-sp-config-export-status**](#get-sp-config-export-status) | **Get** `/sp-config/export/{id}` | Get export job status +[**get-sp-config-import**](#get-sp-config-import) | **Get** `/sp-config/import/{id}/download` | Download import job result +[**get-sp-config-import-status**](#get-sp-config-import-status) | **Get** `/sp-config/import/{id}` | Get import job status +[**import-sp-config**](#import-sp-config) | **Post** `/sp-config/import` | Initiates configuration objects import job +[**list-sp-config-objects**](#list-sp-config-objects) | **Get** `/sp-config/config-objects` | List Config Objects + + +## export-sp-config +Initiates configuration objects export job +This post will export objects from the tenant to a JSON configuration file. +For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). + +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-sp-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportSpConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **exportPayload** | [**ExportPayload**](../models/export-payload) | Export options control what will be included in the export. | + +### Return type + +[**SpConfigExportJob**](../models/sp-config-export-job) + +### 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() { + exportpayload := []byte(`{ + "description" : "Export Job 1 Test" + }`) // ExportPayload | Export options control what will be included in the export. + + + var exportPayload beta.ExportPayload + if err := json.Unmarshal(exportpayload, &exportPayload); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SPConfigAPI.ExportSpConfig(context.Background()).ExportPayload(exportPayload).Execute() + //resp, r, err := apiClient.Beta.SPConfigAPI.ExportSpConfig(context.Background()).ExportPayload(exportPayload).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ExportSpConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportSpConfig`: SpConfigExportJob + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ExportSpConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sp-config-export +Download export job result. +This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. +The request will need one of the following security scopes: +- sp:config:read - sp:config:manage + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sp-config-export) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the export job whose results will be downloaded. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSpConfigExportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SpConfigExportResults**](../models/sp-config-export-results) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the export job whose results will be downloaded. # string | The ID of the export job whose results will be downloaded. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SPConfigAPI.GetSpConfigExport(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SPConfigAPI.GetSpConfigExport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigExport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigExport`: SpConfigExportResults + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigExport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sp-config-export-status +Get export job status +This gets the status of the export job identified by the `id` parameter. +The request will need one of the following security scopes: +- sp:config:read - sp:config:manage + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sp-config-export-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the export job whose status will be returned. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSpConfigExportStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SpConfigExportJobStatus**](../models/sp-config-export-job-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the export job whose status will be returned. # string | The ID of the export job whose status will be returned. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SPConfigAPI.GetSpConfigExportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SPConfigAPI.GetSpConfigExportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigExportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigExportStatus`: SpConfigExportJobStatus + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigExportStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sp-config-import +Download import job result +This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. +The request will need the following security scope: +- sp:config:manage + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sp-config-import) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the import job whose results will be downloaded. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSpConfigImportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SpConfigImportResults**](../models/sp-config-import-results) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the import job whose results will be downloaded. # string | The ID of the import job whose results will be downloaded. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SPConfigAPI.GetSpConfigImport(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SPConfigAPI.GetSpConfigImport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigImport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigImport`: SpConfigImportResults + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigImport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sp-config-import-status +Get import job status +This gets the status of the import job identified by the `id` parameter. +For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sp-config-import-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the import job whose status will be returned. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSpConfigImportStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SpConfigImportJobStatus**](../models/sp-config-import-job-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the import job whose status will be returned. # string | The ID of the import job whose status will be returned. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SPConfigAPI.GetSpConfigImportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SPConfigAPI.GetSpConfigImportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigImportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigImportStatus`: SpConfigImportJobStatus + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigImportStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-sp-config +Initiates configuration objects import job +This post will import objects from a JSON configuration file into a tenant. +By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. +The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. +The backup can be skipped by setting "excludeBackup" to true in the import options. +If a backup is performed, the id of the backup will be provided in the ImportResult as the "exportJobId". This can be downloaded +using the `/sp-config/export/{exportJobId}/download` endpoint. + +You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. + +For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-sp-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportSpConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **data** | ***os.File** | JSON file containing the objects to be imported. | + **preview** | **bool** | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. | [default to false] + **options** | [**ImportOptions**](../models/import-options) | | + +### Return type + +[**SpConfigJob**](../models/sp-config-job) + +### 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() { + data := BINARY_DATA_HERE // *os.File | JSON file containing the objects to be imported. # *os.File | JSON file containing the objects to be imported. + preview := true // bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to false) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to false) + options := []byte(``) // ImportOptions | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SPConfigAPI.ImportSpConfig(context.Background()).Data(data).Execute() + //resp, r, err := apiClient.Beta.SPConfigAPI.ImportSpConfig(context.Background()).Data(data).Preview(preview).Options(options).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ImportSpConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportSpConfig`: SpConfigJob + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ImportSpConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-sp-config-objects +List Config Objects +Get a list of object configurations that the tenant export/import service knows. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-sp-config-objects) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSpConfigObjectsRequest struct via the builder pattern + + +### Return type + +[**[]SpConfigObject**](../models/sp-config-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SPConfigAPI.ListSpConfigObjects(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SPConfigAPI.ListSpConfigObjects(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ListSpConfigObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSpConfigObjects`: []SpConfigObject + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ListSpConfigObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SearchAttributeConfigurationAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SearchAttributeConfigurationAPI.md new file mode 100644 index 000000000..e2f0fb62f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SearchAttributeConfigurationAPI.md @@ -0,0 +1,389 @@ +--- +id: beta-search-attribute-configuration +title: SearchAttributeConfiguration +pagination_label: SearchAttributeConfiguration +sidebar_label: SearchAttributeConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchAttributeConfiguration', 'BetaSearchAttributeConfiguration'] +slug: /tools/sdk/go/beta/methods/search-attribute-configuration +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfiguration', 'BetaSearchAttributeConfiguration'] +--- + +# SearchAttributeConfigurationAPI + Use this API to implement search attribute configuration functionality, along with [Search](https://developer.sailpoint.com/docs/api/v3/search). +With this functionality in place, administrators can create custom search attributes that and run extended searches based on those attributes to further narrow down their searches and get the information and insights they want. + +Identity Security Cloud (ISC) enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using ISC's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about ISC's search and its different possibilities. + +With Search Attribute Configuration, administrators can create, manage, and run searches based on the attributes they want to search. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-search-attribute-config**](#create-search-attribute-config) | **Post** `/accounts/search-attribute-config` | Create Extended Search Attributes +[**delete-search-attribute-config**](#delete-search-attribute-config) | **Delete** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute +[**get-search-attribute-config**](#get-search-attribute-config) | **Get** `/accounts/search-attribute-config` | List Extended Search Attributes +[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **Get** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute +[**patch-search-attribute-config**](#patch-search-attribute-config) | **Patch** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute + + +## create-search-attribute-config +Create Extended Search Attributes +Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. +>**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-search-attribute-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **searchAttributeConfig** | [**SearchAttributeConfig**](../models/search-attribute-config) | | + +### Return type + +**map[string]interface{}** + +### 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() { + searchattributeconfig := []byte(`{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }`) // SearchAttributeConfig | + + + var searchAttributeConfig beta.SearchAttributeConfig + if err := json.Unmarshal(searchattributeconfig, &searchAttributeConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SearchAttributeConfigurationAPI.CreateSearchAttributeConfig(context.Background()).SearchAttributeConfig(searchAttributeConfig).Execute() + //resp, r, err := apiClient.Beta.SearchAttributeConfigurationAPI.CreateSearchAttributeConfig(context.Background()).SearchAttributeConfig(searchAttributeConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.CreateSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSearchAttributeConfig`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.CreateSearchAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-search-attribute-config +Delete Extended Search Attribute +Delete an extended attribute configuration by name. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-search-attribute-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | Name of the extended search attribute configuration to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `newMailAttribute` // string | Name of the extended search attribute configuration to delete. # string | Name of the extended search attribute configuration to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig(context.Background(), name).Execute() + //r, err := apiClient.Beta.SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-search-attribute-config +List Extended Search Attributes +Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-search-attribute-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSearchAttributeConfigRequest struct via the builder pattern + + +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 + +[**[]SearchAttributeConfig**](../models/search-attribute-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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.SearchAttributeConfigurationAPI.GetSearchAttributeConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SearchAttributeConfigurationAPI.GetSearchAttributeConfig(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.GetSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSearchAttributeConfig`: []SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.GetSearchAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-single-search-attribute-config +Get Extended Search Attribute +Get an extended attribute configuration by name. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-single-search-attribute-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | Name of the extended search attribute configuration to get. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSingleSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]SearchAttributeConfig**](../models/search-attribute-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `newMailAttribute` // string | Name of the extended search attribute configuration to get. # string | Name of the extended search attribute configuration to get. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig(context.Background(), name).Execute() + //resp, r, err := apiClient.Beta.SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSingleSearchAttributeConfig`: []SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-search-attribute-config +Update Extended Search Attribute +Update an existing search attribute configuration. +You can patch these fields: +* name * displayName * applicationAttributes + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-search-attribute-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | Name of the extended search attribute configuration to patch. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**SearchAttributeConfig**](../models/search-attribute-config) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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() { + name := `promotedMailAttribute` // string | Name of the extended search attribute configuration to patch. # string | Name of the extended search attribute configuration to patch. + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]`) // []JsonPatchOperation | + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SearchAttributeConfigurationAPI.PatchSearchAttributeConfig(context.Background(), name).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.SearchAttributeConfigurationAPI.PatchSearchAttributeConfig(context.Background(), name).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.PatchSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSearchAttributeConfig`: SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.PatchSearchAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SegmentsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SegmentsAPI.md new file mode 100644 index 000000000..43a1eea30 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SegmentsAPI.md @@ -0,0 +1,410 @@ +--- +id: beta-segments +title: Segments +pagination_label: Segments +sidebar_label: Segments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Segments', 'BetaSegments'] +slug: /tools/sdk/go/beta/methods/segments +tags: ['SDK', 'Software Development Kit', 'Segments', 'BetaSegments'] +--- + +# SegmentsAPI + Use this API to implement and customize access request segment functionality. +With this functionality in place, administrators can create and manage access request segments. +Segments provide organizations with a way to make the access their users have even more granular - this can simply the access request process for the organization's users and improves security by reducing the risk of overprovisoning access. + +Segments represent sets of identities, all grouped by specified identity attributes, who are only able to see and access the access items associated with their segments. +For example, administrators could group all their organization's London office employees into one segment, "London Office Employees," by their shared location. +The administrators could then define the access items the London employees would need, and the identities in the "London Office Employees" would then only be able to see and access those items. + +In Identity Security Cloud, administrators can use the 'Access' drop-down menu and select 'Segments' to reach the 'Access Requests Segments' page. +This page lists all the existing access request segments, along with their statuses, enabled or disabled. +Administrators can use this page to create, edit, enable, disable, and delete segments. +To create a segment, an administrator must provide a name, define the identities grouped in the segment, and define the items the identities in the segment can access. +These items can be access profiles, roles, or entitlements. + +When administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items. + +Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-segment**](#create-segment) | **Post** `/segments` | Create Segment +[**delete-segment**](#delete-segment) | **Delete** `/segments/{id}` | Delete Segment by ID +[**get-segment**](#get-segment) | **Get** `/segments/{id}` | Get Segment by ID +[**list-segments**](#list-segments) | **Get** `/segments` | List Segments +[**patch-segment**](#patch-segment) | **Patch** `/segments/{id}` | Update Segment + + +## create-segment +Create Segment +This API creates a segment. +>**Note:** Segment definitions may take time to propagate to all identities. +A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-segment) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **segment** | [**Segment**](../models/segment) | | + +### Return type + +[**Segment**](../models/segment) + +### 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() { + segment := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }`) // Segment | + + + var segment beta.Segment + if err := json.Unmarshal(segment, &segment); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SegmentsAPI.CreateSegment(context.Background()).Segment(segment).Execute() + //resp, r, err := apiClient.Beta.SegmentsAPI.CreateSegment(context.Background()).Segment(segment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.CreateSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.CreateSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-segment +Delete Segment by ID +This API deletes the segment specified by the given ID. +>**Note:** Segment deletion may take some time to go into effect. +A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to delete. # string | The segment ID to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SegmentsAPI.DeleteSegment(context.Background(), id).Execute() + //r, err := apiClient.Beta.SegmentsAPI.DeleteSegment(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.DeleteSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-segment +Get Segment by ID +This API returns the segment specified by the given ID. +A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Segment**](../models/segment) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to retrieve. # string | The segment ID to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SegmentsAPI.GetSegment(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SegmentsAPI.GetSegment(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.GetSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.GetSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-segments +List Segments +This API returns a list of all segments. +A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-segments) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSegmentsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]Segment**](../models/segment) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SegmentsAPI.ListSegments(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SegmentsAPI.ListSegments(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.ListSegments``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSegments`: []Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.ListSegments`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-segment +Update Segment +Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +>**Note:** Changes to a segment may take some time to propagate to all identities. +A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to modify. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **requestBody** | **[]map[string]interface{}** | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active | + +### Return type + +[**Segment**](../models/segment) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to modify. # string | The segment ID to modify. + requestbody := []byte(`[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]`) // []map[string]interface{} | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + + + var requestBody beta.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SegmentsAPI.PatchSegment(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.Beta.SegmentsAPI.PatchSegment(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.PatchSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.PatchSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/ServiceDeskIntegrationAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/ServiceDeskIntegrationAPI.md new file mode 100644 index 000000000..8bbed10d7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/ServiceDeskIntegrationAPI.md @@ -0,0 +1,780 @@ +--- +id: beta-service-desk-integration +title: ServiceDeskIntegration +pagination_label: ServiceDeskIntegration +sidebar_label: ServiceDeskIntegration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskIntegration', 'BetaServiceDeskIntegration'] +slug: /tools/sdk/go/beta/methods/service-desk-integration +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegration', 'BetaServiceDeskIntegration'] +--- + +# ServiceDeskIntegrationAPI + Use this API to build an integration between Identity Security Cloud and a service desk ITSM (IT service management) solution. +Once an administrator builds this integration between Identity Security Cloud and a service desk, users can use Identity Security Cloud to raise and track tickets that are synchronized between Identity Security Cloud and the service desk. + +In Identity Security Cloud, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.' + +To create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. +Refer to [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in Identity Security Cloud. + +Administrators can create various service desk integrations, all with their own nuances. +The following service desk integrations are available: + +- [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud_sd/introduction.html) + +- [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server_sd/introduction.html) + +- [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html) + +- [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html) + +- [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) + +- [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html) + +- [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html) + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-service-desk-integration**](#create-service-desk-integration) | **Post** `/service-desk-integrations` | Create new Service Desk integration +[**delete-service-desk-integration**](#delete-service-desk-integration) | **Delete** `/service-desk-integrations/{id}` | Delete a Service Desk integration +[**get-service-desk-integration**](#get-service-desk-integration) | **Get** `/service-desk-integrations/{id}` | Get a Service Desk integration +[**get-service-desk-integration-list**](#get-service-desk-integration-list) | **Get** `/service-desk-integrations` | List existing Service Desk integrations +[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **Get** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName +[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **Get** `/service-desk-integrations/types` | List Service Desk integration types +[**get-status-check-details**](#get-status-check-details) | **Get** `/service-desk-integrations/status-check-configuration` | Get the time check configuration +[**patch-service-desk-integration**](#patch-service-desk-integration) | **Patch** `/service-desk-integrations/{id}` | Patch a Service Desk Integration +[**put-service-desk-integration**](#put-service-desk-integration) | **Put** `/service-desk-integrations/{id}` | Update a Service Desk integration +[**update-status-check-details**](#update-status-check-details) | **Put** `/service-desk-integrations/status-check-configuration` | Update the time check configuration + + +## create-service-desk-integration +Create new Service Desk integration +Create a new Service Desk integration. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-service-desk-integration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **serviceDeskIntegrationDto** | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | The specifics of a new integration to create | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### 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() { + servicedeskintegrationdto := []byte(`{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + }`) // ServiceDeskIntegrationDto | The specifics of a new integration to create + + + var serviceDeskIntegrationDto beta.ServiceDeskIntegrationDto + if err := json.Unmarshal(servicedeskintegrationdto, &serviceDeskIntegrationDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.CreateServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.CreateServiceDeskIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-service-desk-integration +Delete a Service Desk integration +Delete an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-service-desk-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of Service Desk integration to delete | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `anId` // string | ID of Service Desk integration to delete # string | ID of Service Desk integration to delete + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration(context.Background(), id).Execute() + //r, err := apiClient.Beta.ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-service-desk-integration +Get a Service Desk integration +Get an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Service Desk integration to get | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `anId` // string | ID of the Service Desk integration to get # string | ID of the Service Desk integration to get + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetServiceDeskIntegration(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetServiceDeskIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-service-desk-integration-list +List existing Service Desk integrations +Get a list of Service Desk integration objects. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-list) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **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** | + **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* **type**: *eq, in* **cluster**: *eq, in* | + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `id eq 2c91808b6ef1d43e016efba0ce470904` // 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* **type**: *eq, in* **cluster**: *eq, in* (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* **type**: *eq, in* **cluster**: *eq, in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationList(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationList(context.Background()).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationList`: []ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-service-desk-integration-template +Service Desk integration template by scriptName +This API endpoint returns an existing Service Desk integration template by scriptName. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the Service Desk integration template to get | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ServiceDeskIntegrationTemplateDto**](../models/service-desk-integration-template-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the Service Desk integration template to get # string | The scriptName value of the Service Desk integration template to get + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationTemplate`: ServiceDeskIntegrationTemplateDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-service-desk-integration-types +List Service Desk integration types +This API endpoint returns the current list of supported Service Desk integration types. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-types) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationTypesRequest struct via the builder pattern + + +### Return type + +[**[]ServiceDeskIntegrationTemplateType**](../models/service-desk-integration-template-type) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationTypes`: []ServiceDeskIntegrationTemplateType + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-status-check-details +Get the time check configuration +Get the time check configuration of queued SDIM tickets. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-status-check-details) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetStatusCheckDetailsRequest struct via the builder pattern + + +### Return type + +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetStatusCheckDetails(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetStatusCheckDetails(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetStatusCheckDetails``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetStatusCheckDetails`: QueuedCheckConfigDetails + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetStatusCheckDetails`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-service-desk-integration +Patch a Service Desk Integration +Update an existing Service Desk integration by ID with a PATCH request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-service-desk-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Service Desk integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `anId` // string | ID of the Service Desk integration to update # string | ID of the Service Desk integration to update + jsonpatchoperation := []byte(``) // []JsonPatchOperation | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.PatchServiceDeskIntegration(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.PatchServiceDeskIntegration(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.PatchServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.PatchServiceDeskIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-service-desk-integration +Update a Service Desk integration +Update an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-service-desk-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Service Desk integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **serviceDeskIntegrationDto** | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | The specifics of the integration to update | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### 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 := `anId` // string | ID of the Service Desk integration to update # string | ID of the Service Desk integration to update + servicedeskintegrationdto := []byte(`{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + }`) // ServiceDeskIntegrationDto | The specifics of the integration to update + + + var serviceDeskIntegrationDto beta.ServiceDeskIntegrationDto + if err := json.Unmarshal(servicedeskintegrationdto, &serviceDeskIntegrationDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.PutServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.PutServiceDeskIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-status-check-details +Update the time check configuration +Update the time check configuration of queued SDIM tickets. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-status-check-details) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateStatusCheckDetailsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **queuedCheckConfigDetails** | [**QueuedCheckConfigDetails**](../models/queued-check-config-details) | The modified time check configuration | + +### Return type + +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### 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() { + queuedcheckconfigdetails := []byte(`{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + }`) // QueuedCheckConfigDetails | The modified time check configuration + + + var queuedCheckConfigDetails beta.QueuedCheckConfigDetails + if err := json.Unmarshal(queuedcheckconfigdetails, &queuedCheckConfigDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.UpdateStatusCheckDetails``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateStatusCheckDetails`: QueuedCheckConfigDetails + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.UpdateStatusCheckDetails`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SourceUsagesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SourceUsagesAPI.md new file mode 100644 index 000000000..6ccbe0a1a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SourceUsagesAPI.md @@ -0,0 +1,164 @@ +--- +id: beta-source-usages +title: SourceUsages +pagination_label: SourceUsages +sidebar_label: SourceUsages +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUsages', 'BetaSourceUsages'] +slug: /tools/sdk/go/beta/methods/source-usages +tags: ['SDK', 'Software Development Kit', 'SourceUsages', 'BetaSourceUsages'] +--- + +# SourceUsagesAPI + Use this API to implement source usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used. +This allows organizations to get the information they need to start optimizing and securing source usage. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-status-by-source-id**](#get-status-by-source-id) | **Get** `/source-usages/{sourceId}/status` | Finds status of source usage +[**get-usages-by-source-id**](#get-usages-by-source-id) | **Get** `/source-usages/{sourceId}/summaries` | Returns source usage insights + + +## get-status-by-source-id +Finds status of source usage +This API returns the status of the source usage insights setup by IDN source ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-status-by-source-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | ID of IDN source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetStatusBySourceIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SourceUsageStatus**](../models/source-usage-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | ID of IDN source # string | ID of IDN source + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourceUsagesAPI.GetStatusBySourceId(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourceUsagesAPI.GetStatusBySourceId(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourceUsagesAPI.GetStatusBySourceId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetStatusBySourceId`: SourceUsageStatus + fmt.Fprintf(os.Stdout, "Response from `SourceUsagesAPI.GetStatusBySourceId`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-usages-by-source-id +Returns source usage insights +This API returns a summary of source usage insights for past 12 months. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-usages-by-source-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | ID of IDN source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetUsagesBySourceIdRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **date** | + +### Return type + +[**[]SourceUsage**](../models/source-usage) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | ID of IDN source # string | ID of IDN source + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `-date` // 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: **date** (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: **date** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourceUsagesAPI.GetUsagesBySourceId(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourceUsagesAPI.GetUsagesBySourceId(context.Background(), sourceId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourceUsagesAPI.GetUsagesBySourceId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUsagesBySourceId`: []SourceUsage + fmt.Fprintf(os.Stdout, "Response from `SourceUsagesAPI.GetUsagesBySourceId`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SourcesAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SourcesAPI.md new file mode 100644 index 000000000..c96918ee3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SourcesAPI.md @@ -0,0 +1,3601 @@ +--- +id: beta-sources +title: Sources +pagination_label: Sources +sidebar_label: Sources +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Sources', 'BetaSources'] +slug: /tools/sdk/go/beta/methods/sources +tags: ['SDK', 'Software Development Kit', 'Sources', 'BetaSources'] +--- + +# SourcesAPI + Use this API to implement and customize source functionality. +With source functionality in place, organizations can use Identity Security Cloud to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way. + +[Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) refer to the Identity Security Cloud representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example. +Organizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records. +Connecting these sources to Identity Security Cloud makes it possible to manage user access across them all. +Then, if a new hire starts at an organization, Identity Security Cloud can grant the new hire access to all the sources they need. +If an employee moves to a new department and needs access to new sources but no longer needs access to others, Identity Security Cloud can grant the necessary access and revoke the unnecessary access for all the employee's various sources. +If an employee leaves the company, Identity Security Cloud can revoke access to all the employee's various source accounts immediately. +These are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure. + +In Identity Security Cloud, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so. +They can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups. +Admins go to Connections > Sources to see a list of the existing source representations in their organizations. +They can create new sources or select existing ones. + +To create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type. +Refer to [Configuring a Source](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source) for more information about the source configuration process. + +Identity Security Cloud connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in. +Different sources use different connectors to share data with Identity Security Cloud, and each connector's setup process is specific to that connector. +SailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors. +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about these SailPoint supported connectors. +Refer to the following links for more information about two useful connectors: + +- [JDBC Connector](https://documentation.sailpoint.com/connectors/jdbc/help/integrating_jdbc/introduction.html): This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity). + +- [Web Services Connector](https://documentation.sailpoint.com/connectors/webservices/help/integrating_webservices/introduction.html): This connector can directly connect to databases that support Web Services. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources. + +When admins select existing sources, they can view the following information about the source: + +- Associated connections (any associated identity profiles, apps, or references to the source in a transform). + +- Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources. + +- Associated entitlements (sets of access rights on sources). + +- Associated access profiles (groupings of entitlements). + +The user account data and the entitlements update with each data aggregation from the source. +Organizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their Identity Security Cloud tenants so an access change on a source is detected quickly in Identity Security Cloud. +Admins can view a history of these aggregations, and they can also run manual imports. +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about manual and scheduled aggregations. + +Admins can also make changes to determine which user account data Identity Security Cloud collects from the source and how it correlates that account data with identity data. +To define which account attributes the source shares with Identity Security Cloud, admins can edit the account schema on the source. +Refer to [Managing Source Account Schemas](https://documentation.sailpoint.com/saas/help/accounts/schema.html) for more information about source account schemas and how to edit them. +To define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source. +Refer to [Assigning Source Accounts to Identities](https://documentation.sailpoint.com/saas/help/accounts/correlation.html) for more information about this correlation process between source accounts and identities. + +Admins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform. +Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources. + +Well organized, mapped out connections between sources and Identity Security Cloud are essential to achieving comprehensive identity access governance across all the source systems organizations need. +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-provisioning-policy**](#create-provisioning-policy) | **Post** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy +[**create-source**](#create-source) | **Post** `/sources` | Creates a source in IdentityNow. +[**create-source-schema**](#create-source-schema) | **Post** `/sources/{sourceId}/schemas` | Create Schema on Source +[**delete**](#delete) | **Delete** `/sources/{id}` | Delete Source by ID +[**delete-accounts-async**](#delete-accounts-async) | **Post** `/sources/{sourceId}/remove-accounts` | Remove All Accounts in a Source +[**delete-native-change-detection-config**](#delete-native-change-detection-config) | **Delete** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration +[**delete-provisioning-policy**](#delete-provisioning-policy) | **Delete** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType +[**delete-source-schema**](#delete-source-schema) | **Delete** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID +[**get-correlation-config**](#get-correlation-config) | **Get** `/sources/{sourceId}/correlation-config` | Get Source Correlation Configuration +[**get-native-change-detection-config**](#get-native-change-detection-config) | **Get** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration +[**get-provisioning-policy**](#get-provisioning-policy) | **Get** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType +[**get-source**](#get-source) | **Get** `/sources/{id}` | Get Source by ID +[**get-source-accounts-schema**](#get-source-accounts-schema) | **Get** `/sources/{sourceId}/schemas/accounts` | Downloads source accounts schema template +[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **Get** `/sources/{id}/attribute-sync-config` | Attribute Sync Config +[**get-source-config**](#get-source-config) | **Get** `/sources/{id}/connectors/source-config` | Gets source config with language translations +[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **Get** `/sources/{sourceId}/entitlement-request-config` | Get Source Entitlement Request Configuration +[**get-source-entitlements-schema**](#get-source-entitlements-schema) | **Get** `/sources/{sourceId}/schemas/entitlements` | Downloads source entitlements schema template +[**get-source-schema**](#get-source-schema) | **Get** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID +[**get-source-schemas**](#get-source-schemas) | **Get** `/sources/{sourceId}/schemas` | List Schemas on Source +[**import-accounts**](#import-accounts) | **Post** `/sources/{sourceId}/load-accounts` | Account Aggregation +[**import-entitlements**](#import-entitlements) | **Post** `/sources/{sourceId}/load-entitlements` | Entitlement Aggregation +[**import-source-accounts-schema**](#import-source-accounts-schema) | **Post** `/sources/{sourceId}/schemas/accounts` | Uploads source accounts schema template +[**import-source-connector-file**](#import-source-connector-file) | **Post** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source +[**import-source-entitlements-schema**](#import-source-entitlements-schema) | **Post** `/sources/{sourceId}/schemas/entitlements` | Uploads source entitlements schema template +[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **Post** `/sources/{sourceId}/load-uncorrelated-accounts` | Process Uncorrelated Accounts +[**list-provisioning-policies**](#list-provisioning-policies) | **Get** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies +[**list-sources**](#list-sources) | **Get** `/sources` | Lists all sources in IdentityNow. +[**peek-resource-objects**](#peek-resource-objects) | **Post** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects +[**ping-cluster**](#ping-cluster) | **Post** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector +[**put-correlation-config**](#put-correlation-config) | **Put** `/sources/{sourceId}/correlation-config` | Update Source Correlation Configuration +[**put-native-change-detection-config**](#put-native-change-detection-config) | **Put** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration +[**put-provisioning-policy**](#put-provisioning-policy) | **Put** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType +[**put-source**](#put-source) | **Put** `/sources/{id}` | Update Source (Full) +[**put-source-attr-sync-config**](#put-source-attr-sync-config) | **Put** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config +[**put-source-schema**](#put-source-schema) | **Put** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) +[**sync-attributes-for-source**](#sync-attributes-for-source) | **Post** `/sources/{sourceId}/synchronize-attributes` | Synchronize single source attributes. +[**test-source-configuration**](#test-source-configuration) | **Post** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector +[**test-source-connection**](#test-source-connection) | **Post** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector. +[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **Post** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies +[**update-provisioning-policy**](#update-provisioning-policy) | **Patch** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy +[**update-source**](#update-source) | **Patch** `/sources/{id}` | Update Source (Partial) +[**update-source-entitlement-request-config**](#update-source-entitlement-request-config) | **Put** `/sources/{sourceId}/entitlement-request-config` | Update Source Entitlement Request Configuration +[**update-source-schema**](#update-source-schema) | **Patch** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) + + +## create-provisioning-policy +Create Provisioning Policy +This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **provisioningPolicyDto** | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | | + +### Return type + +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id # string | The Source id + provisioningpolicydto := []byte(`{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }`) // ProvisioningPolicyDto | + + + var provisioningPolicyDto beta.ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.CreateProvisioningPolicy(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.CreateProvisioningPolicy(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateProvisioningPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-source +Creates a source in IdentityNow. +This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-source) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **source** | [**Source**](../models/source) | | + **provisionAsCsv** | **bool** | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. | + +### Return type + +[**Source**](../models/source) + +### 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() { + source := []byte(`{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }`) // Source | + provisionAsCsv := false // bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + + var source beta.Source + if err := json.Unmarshal(source, &source); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.CreateSource(context.Background()).Source(source).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.CreateSource(context.Background()).Source(source).ProvisionAsCsv(provisionAsCsv).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-source-schema +Create Schema on Source +Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-source-schema) + +### 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 apiCreateSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schema** | [**Schema**](../models/schema) | | + +### Return type + +[**Schema**](../models/schema) + +### 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + schema := []byte(`{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + }`) // Schema | + + + var schema beta.Schema + if err := json.Unmarshal(schema, &schema); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.CreateSourceSchema(context.Background(), sourceId).Schema(schema).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.CreateSourceSchema(context.Background(), sourceId).Schema(schema).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSourceSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete +Delete Source by ID +Use this API to delete a specific source in Identity Security Cloud (ISC). +The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Delete202Response**](../models/delete202-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.Delete(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.Delete(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.Delete``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `Delete`: Delete202Response + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.Delete`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-accounts-async +Remove All Accounts in a Source +Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. + +This endpoint is good for: +* Removing accounts that no longer exist on the source. +* Removing accounts that won't be aggregated following updates to the source configuration. +* Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-accounts-async) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccountsAsyncRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**TaskResultDto**](../models/task-result-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `ebbf35756e1140699ce52b233121384a` // string | The source id # string | The source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.DeleteAccountsAsync(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.DeleteAccountsAsync(context.Background(), sourceId).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) + } + // response from `DeleteAccountsAsync`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.DeleteAccountsAsync`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-native-change-detection-config +Delete Native Change Detection Configuration +Deletes the native change detection configuration for the source specified by the given ID. +A token with API, or ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-native-change-detection-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNativeChangeDetectionConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SourcesAPI.DeleteNativeChangeDetectionConfig(context.Background(), sourceId).Execute() + //r, err := apiClient.Beta.SourcesAPI.DeleteNativeChangeDetectionConfig(context.Background(), sourceId).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) + } +} +``` + +[[Back to top]](#) + +## delete-provisioning-policy +Delete Provisioning Policy by UsageType +Deletes the provisioning policy with the specified usage on an application. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source ID. | +**usageType** | [**UsageType**](../models/) | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SourcesAPI.DeleteProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + //r, err := apiClient.Beta.SourcesAPI.DeleteProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-source-schema +Delete Source Schema by ID + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-source-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source ID. | +**schemaId** | **string** | The Schema ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema ID. # string | The Schema ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SourcesAPI.DeleteSourceSchema(context.Background(), sourceId, schemaId).Execute() + //r, err := apiClient.Beta.SourcesAPI.DeleteSourceSchema(context.Background(), sourceId, schemaId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-correlation-config +Get Source Correlation Configuration +This API returns the existing correlation configuration for a source specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-correlation-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCorrelationConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CorrelationConfig**](../models/correlation-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetCorrelationConfig(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetCorrelationConfig(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCorrelationConfig`: CorrelationConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetCorrelationConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-native-change-detection-config +Native Change Detection Configuration +This API returns the existing native change detection configuration for a source specified by the given ID. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-native-change-detection-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNativeChangeDetectionConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NativeChangeDetectionConfig**](../models/native-change-detection-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetNativeChangeDetectionConfig(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetNativeChangeDetectionConfig(context.Background(), sourceId).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) + } + // response from `GetNativeChangeDetectionConfig`: NativeChangeDetectionConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetNativeChangeDetectionConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-provisioning-policy +Get Provisioning Policy by UsageType +This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source ID. | +**usageType** | [**UsageType**](../models/) | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetProvisioningPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source +Get Source by ID +Use this API to get a source by a specified ID in Identity Security Cloud (ISC). +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetSource(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetSource(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-accounts-schema +Downloads source accounts schema template + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-accounts-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceAccountsSchemaRequest 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() { + sourceId := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SourcesAPI.GetSourceAccountsSchema(context.Background(), sourceId).Execute() + //r, err := apiClient.Beta.SourcesAPI.GetSourceAccountsSchema(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceAccountsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-source-attr-sync-config +Attribute Sync Config +This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. +A token with ORG_ADMIN or HELPDESK authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-attr-sync-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceAttrSyncConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AttrSyncSourceConfig**](../models/attr-sync-source-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetSourceAttrSyncConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetSourceAttrSyncConfig(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceAttrSyncConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceAttrSyncConfig`: AttrSyncSourceConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceAttrSyncConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-config +Gets source config with language translations +Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **locale** | **string** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | + +### Return type + +[**ConnectorDetail**](../models/connector-detail) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `id_example` // string | The Source id # string | The Source id + locale := `locale_example` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetSourceConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetSourceConfig(context.Background(), id).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceConfig`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-entitlement-request-config +Get Source Entitlement Request Configuration +This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. + +Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. +- During access request, this source-level entitlement request configuration overrides the global organization-level configuration. +- However, the entitlement-level configuration (if defined) overrides this source-level configuration. + +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/beta/get-source-entitlement-request-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceEntitlementRequestConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetSourceEntitlementRequestConfig(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetSourceEntitlementRequestConfig(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceEntitlementRequestConfig`: SourceEntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceEntitlementRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-entitlements-schema +Downloads source entitlements schema template + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-entitlements-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceEntitlementsSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schemaName** | **string** | Name of entitlement schema | + +### 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() { + sourceId := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + schemaName := `?schemaName=group` // string | Name of entitlement schema (optional) # string | Name of entitlement schema (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SourcesAPI.GetSourceEntitlementsSchema(context.Background(), sourceId).Execute() + //r, err := apiClient.Beta.SourcesAPI.GetSourceEntitlementsSchema(context.Background(), sourceId).SchemaName(schemaName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceEntitlementsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-source-schema +Get Source Schema by ID +Get the Source Schema by ID in IdentityNow. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source ID. | +**schemaId** | **string** | The Schema ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema ID. # string | The Schema ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetSourceSchema(context.Background(), sourceId, schemaId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetSourceSchema(context.Background(), sourceId, schemaId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-schemas +List Schemas on Source +Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-schemas) + +### 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 apiGetSourceSchemasRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeTypes** | **string** | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. | + **includeNames** | **string** | A comma-separated list of schema names to filter result. | + +### Return type + +[**[]Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + includeTypes := `group` // string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) # string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + includeNames := `account` // string | A comma-separated list of schema names to filter result. (optional) # string | A comma-separated list of schema names to filter result. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).IncludeTypes(includeTypes).IncludeNames(includeNames).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchemas``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchemas`: []Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchemas`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-accounts +Account Aggregation +Starts an account aggregation on the specified source. +If the target source is a delimited file source, then the CSV file needs to be included in the request body. +You will also need to set the Content-Type header to `multipart/form-data`. +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/beta/import-accounts) + +### 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 apiImportAccountsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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. | + +### Return type + +[**LoadAccountsTask**](../models/load-accounts-task) + +### HTTP request headers + +- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded +- **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 + 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) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.ImportAccounts(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.ImportAccounts(context.Background(), sourceId).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) + } + // response from `ImportAccounts`: LoadAccountsTask + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportAccounts`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-entitlements +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/beta/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 +------------- | ------------- | ------------- | ------------- + + **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 + 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.Beta.SourcesAPI.ImportEntitlements(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.ImportEntitlements(context.Background(), sourceId).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-source-accounts-schema +Uploads source accounts schema template +This API uploads a source schema template file to configure a source's account attributes. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-source-accounts-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportSourceAccountsSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | | + +### Return type + +[**Schema**](../models/schema) + +### 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.ImportSourceAccountsSchema(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.ImportSourceAccountsSchema(context.Background(), sourceId).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportSourceAccountsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportSourceAccountsSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportSourceAccountsSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-source-connector-file +Upload connector file to source +This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-source-connector-file) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportSourceConnectorFileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | | + +### Return type + +[**Source**](../models/source) + +### 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.ImportSourceConnectorFile(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.ImportSourceConnectorFile(context.Background(), sourceId).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportSourceConnectorFile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportSourceConnectorFile`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportSourceConnectorFile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-source-entitlements-schema +Uploads source entitlements schema template +This API uploads a source schema template file to configure a source's entitlement attributes. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-source-entitlements-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportSourceEntitlementsSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schemaName** | **string** | Name of entitlement schema | + **file** | ***os.File** | | + +### Return type + +[**Schema**](../models/schema) + +### 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + schemaName := `?schemaName=group` // string | Name of entitlement schema (optional) # string | Name of entitlement schema (optional) + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.ImportSourceEntitlementsSchema(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.ImportSourceEntitlementsSchema(context.Background(), sourceId).SchemaName(schemaName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportSourceEntitlementsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportSourceEntitlementsSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportSourceEntitlementsSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-uncorrelated-accounts +Process Uncorrelated Accounts +File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` + +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-uncorrelated-accounts) + +### 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 apiImportUncorrelatedAccountsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | | + +### Return type + +[**LoadUncorrelatedAccountsTask**](../models/load-uncorrelated-accounts-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 := `75dbec1ebe154d5785da27b95e1dd5d7` // string | Source Id # string | Source Id + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.ImportUncorrelatedAccounts(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.ImportUncorrelatedAccounts(context.Background(), sourceId).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) + } + // response from `ImportUncorrelatedAccounts`: LoadUncorrelatedAccountsTask + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportUncorrelatedAccounts`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-provisioning-policies +Lists ProvisioningPolicies +This end-point lists all the ProvisioningPolicies in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-provisioning-policies) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListProvisioningPoliciesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.ListProvisioningPolicies(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.ListProvisioningPolicies(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ListProvisioningPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListProvisioningPolicies`: []ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ListProvisioningPolicies`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-sources +Lists all sources in IdentityNow. +This end-point lists all the sources in IdentityNow. + +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-sources) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSourcesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq* **modified**: *eq* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* | + **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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** | + **forSubadmin** | **string** | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. | + **includeIDNSource** | **bool** | Include the IdentityNow source in the response. | [default to false] + +### Return type + +[**[]Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Employees"` // 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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq* **modified**: *eq* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq* **modified**: *eq* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + sorters := `name` // 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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + forSubadmin := `name` // string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) # string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + includeIDNSource := true // bool | Include the IdentityNow source in the response. (optional) (default to false) # bool | Include the IdentityNow source in the response. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.ListSources(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.ListSources(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSubadmin(forSubadmin).IncludeIDNSource(includeIDNSource).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ListSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSources`: []Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ListSources`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## peek-resource-objects +Peek source connector's resource objects +Retrieves a sample of data returned from account and group aggregation requests. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/peek-resource-objects) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The ID of the Source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPeekResourceObjectsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **resourceObjectsRequest** | [**ResourceObjectsRequest**](../models/resource-objects-request) | | + +### Return type + +[**ResourceObjectsResponse**](../models/resource-objects-response) + +### 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() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + resourceobjectsrequest := []byte(`{ + "maxCount" : 100, + "objectType" : "group" + }`) // ResourceObjectsRequest | + + + var resourceObjectsRequest beta.ResourceObjectsRequest + if err := json.Unmarshal(resourceobjectsrequest, &resourceObjectsRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.PeekResourceObjects(context.Background(), sourceId).ResourceObjectsRequest(resourceObjectsRequest).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.PeekResourceObjects(context.Background(), sourceId).ResourceObjectsRequest(resourceObjectsRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PeekResourceObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PeekResourceObjects`: ResourceObjectsResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PeekResourceObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## ping-cluster +Ping cluster for source connector +This endpoint validates that the cluster being used by the source is reachable from IdentityNow. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/ping-cluster) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The ID of the Source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPingClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**StatusResponse**](../models/status-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.PingCluster(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.PingCluster(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PingCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PingCluster`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PingCluster`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-correlation-config +Update Source Correlation Configuration +Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-correlation-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutCorrelationConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **correlationConfig** | [**CorrelationConfig**](../models/correlation-config) | | + +### Return type + +[**CorrelationConfig**](../models/correlation-config) + +### 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + correlationconfig := []byte(`{ + "attributeAssignments" : [ { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + }, { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + } ], + "name" : "Source [source] Account Correlation", + "id" : "2c9180835d191a86015d28455b4a2329" + }`) // CorrelationConfig | + + + var correlationConfig beta.CorrelationConfig + if err := json.Unmarshal(correlationconfig, &correlationConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.PutCorrelationConfig(context.Background(), sourceId).CorrelationConfig(correlationConfig).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.PutCorrelationConfig(context.Background(), sourceId).CorrelationConfig(correlationConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutCorrelationConfig`: CorrelationConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutCorrelationConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-native-change-detection-config +Update Native Change Detection Configuration +Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. + +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-native-change-detection-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutNativeChangeDetectionConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **nativeChangeDetectionConfig** | [**NativeChangeDetectionConfig**](../models/native-change-detection-config) | | + +### Return type + +[**NativeChangeDetectionConfig**](../models/native-change-detection-config) + +### 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + nativechangedetectionconfig := []byte(`{ + "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], + "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true + }`) // NativeChangeDetectionConfig | + + + var nativeChangeDetectionConfig beta.NativeChangeDetectionConfig + if err := json.Unmarshal(nativechangedetectionconfig, &nativeChangeDetectionConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.PutNativeChangeDetectionConfig(context.Background(), sourceId).NativeChangeDetectionConfig(nativeChangeDetectionConfig).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.PutNativeChangeDetectionConfig(context.Background(), sourceId).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) + } + // response from `PutNativeChangeDetectionConfig`: NativeChangeDetectionConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutNativeChangeDetectionConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-provisioning-policy +Update Provisioning Policy by UsageType +This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source ID. | +**usageType** | [**UsageType**](../models/) | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **provisioningPolicyDto** | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | | + +### Return type + +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + provisioningpolicydto := []byte(`{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }`) // ProvisioningPolicyDto | + + + var provisioningPolicyDto beta.ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.PutProvisioningPolicy(context.Background(), sourceId, usageType).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.PutProvisioningPolicy(context.Background(), sourceId, usageType).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutProvisioningPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-source +Update Source (Full) +Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. + +These fields are immutable, so they cannot be changed: + +* id +* type +* authoritative +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + +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/beta/put-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **source** | [**Source**](../models/source) | | + +### Return type + +[**Source**](../models/source) + +### 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 := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + source := []byte(`{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }`) // Source | + + + var source beta.Source + if err := json.Unmarshal(source, &source); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.PutSource(context.Background(), id).Source(source).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.PutSource(context.Background(), id).Source(source).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-source-attr-sync-config +Update Attribute Sync Config +Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error. + +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-source-attr-sync-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSourceAttrSyncConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **attrSyncSourceConfig** | [**AttrSyncSourceConfig**](../models/attr-sync-source-config) | | + +### Return type + +[**AttrSyncSourceConfig**](../models/attr-sync-source-config) + +### 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 := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + attrsyncsourceconfig := []byte(`{ + "attributes" : [ { + "name" : "email", + "displayName" : "Email", + "enabled" : true, + "target" : "mail" + }, { + "name" : "firstname", + "displayName" : "First Name", + "enabled" : false, + "target" : "givenName" + } ], + "source" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + } + }`) // AttrSyncSourceConfig | + + + var attrSyncSourceConfig beta.AttrSyncSourceConfig + if err := json.Unmarshal(attrsyncsourceconfig, &attrSyncSourceConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.PutSourceAttrSyncConfig(context.Background(), id).AttrSyncSourceConfig(attrSyncSourceConfig).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.PutSourceAttrSyncConfig(context.Background(), id).AttrSyncSourceConfig(attrSyncSourceConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSourceAttrSyncConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSourceAttrSyncConfig`: AttrSyncSourceConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSourceAttrSyncConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-source-schema +Update Source Schema (Full) +This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. +* id +* name +* created +* modified +Any attempt to modify these fields will result in an error response with a status code of 400. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-source-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source ID. | +**schemaId** | **string** | The Schema ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **schema** | [**Schema**](../models/schema) | | + +### Return type + +[**Schema**](../models/schema) + +### 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema ID. # string | The Schema ID. + schema := []byte(`{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + }`) // Schema | + + + var schema beta.Schema + if err := json.Unmarshal(schema, &schema); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.PutSourceSchema(context.Background(), sourceId, schemaId).Schema(schema).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.PutSourceSchema(context.Background(), sourceId, schemaId).Schema(schema).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSourceSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## sync-attributes-for-source +Synchronize single source attributes. +This end-point performs attribute synchronization for a selected source. +A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/sync-attributes-for-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSyncAttributesForSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SourceSyncJob**](../models/source-sync-job) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `sourceId_example` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.SyncAttributesForSource(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.SyncAttributesForSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.SyncAttributesForSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SyncAttributesForSource`: SourceSyncJob + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.SyncAttributesForSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-source-configuration +Test configuration for source connector +This endpoint performs a more detailed validation of the source's configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-source-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The ID of the Source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestSourceConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**StatusResponse**](../models/status-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.TestSourceConfiguration(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.TestSourceConfiguration(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.TestSourceConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConfiguration`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.TestSourceConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-source-connection +Check connection for source connector. +This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-source-connection) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The ID of the Source. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestSourceConnectionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**StatusResponse**](../models/status-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source. # string | The ID of the Source. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.TestSourceConnection(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.TestSourceConnection(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.TestSourceConnection``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConnection`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.TestSourceConnection`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-provisioning-policies-in-bulk +Bulk Update Provisioning Policies +This end-point updates a list of provisioning policies on the specified source in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-provisioning-policies-in-bulk) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateProvisioningPoliciesInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **provisioningPolicyDto** | [**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) | | + +### Return type + +[**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + provisioningpolicydto := []byte(``) // []ProvisioningPolicyDto | + + + var provisioningPolicyDto beta.[]ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.UpdateProvisioningPoliciesInBulk(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.UpdateProvisioningPoliciesInBulk(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateProvisioningPoliciesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateProvisioningPoliciesInBulk`: []ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateProvisioningPoliciesInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-provisioning-policy +Partial update of Provisioning Policy +This API selectively updates an existing Provisioning Policy using a JSONPatch payload. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**usageType** | [**UsageType**](../models/) | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | The JSONPatch payload used to update the schema. | + +### Return type + +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + jsonpatchoperation := []byte(`[{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schema. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.UpdateProvisioningPolicy(context.Background(), sourceId, usageType).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.UpdateProvisioningPolicy(context.Background(), sourceId, usageType).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateProvisioningPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-source +Update Source (Partial) +Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the +[JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +These fields are immutable, so they cannot be changed: +* id +* type +* authoritative +* created +* modified +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). | + +### Return type + +[**Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=new description}]`) // []JsonPatchOperation | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.UpdateSource(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.UpdateSource(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-source-entitlement-request-config +Update Source Entitlement Request Configuration +This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. + +Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. +- During access request, this source-level entitlement request configuration overrides the global organization-level configuration. +- However, the entitlement-level configuration (if defined) overrides this source-level configuration. + +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/beta/update-source-entitlement-request-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSourceEntitlementRequestConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **sourceEntitlementRequestConfig** | [**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) | | + +### Return type + +[**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) + +### 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() { + sourceId := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + sourceentitlementrequestconfig := []byte(`{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }`) // SourceEntitlementRequestConfig | + + + var sourceEntitlementRequestConfig beta.SourceEntitlementRequestConfig + if err := json.Unmarshal(sourceentitlementrequestconfig, &sourceEntitlementRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.UpdateSourceEntitlementRequestConfig(context.Background(), sourceId).SourceEntitlementRequestConfig(sourceEntitlementRequestConfig).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.UpdateSourceEntitlementRequestConfig(context.Background(), sourceId).SourceEntitlementRequestConfig(sourceEntitlementRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceEntitlementRequestConfig`: SourceEntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceEntitlementRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-source-schema +Update Source Schema (Partial) +Use this API to selectively update an existing Schema using a JSONPatch payload. + +The following schema fields are immutable and cannot be updated: + +- id +- name +- created +- modified + + +To switch an account attribute to a group entitlement, you need to have the following in place: + +- `isEntitlement: true` +- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/beta/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: +```json +{ + "name": "groups", + "type": "STRING", + "schema": { + "type": "CONNECTOR_SCHEMA", + "id": "2c9180887671ff8c01767b4671fc7d60", + "name": "group" + }, + "description": "The groups, roles etc. that reference account group objects", + "isMulti": true, + "isEntitlement": true, + "isGroup": true +} +``` + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-source-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**schemaId** | **string** | The Schema id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | The JSONPatch payload used to update the schema. | + +### Return type + +[**Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + jsonpatchoperation := []byte(`[{op=replace, path=/displayAttribute, value={new-display-attribute=null}}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schema. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.UpdateSourceSchema(context.Background(), sourceId, schemaId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.UpdateSourceSchema(context.Background(), sourceId, schemaId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SuggestedEntitlementDescriptionAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SuggestedEntitlementDescriptionAPI.md new file mode 100644 index 000000000..9873c1ffa --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SuggestedEntitlementDescriptionAPI.md @@ -0,0 +1,532 @@ +--- +id: beta-suggested-entitlement-description +title: SuggestedEntitlementDescription +pagination_label: SuggestedEntitlementDescription +sidebar_label: SuggestedEntitlementDescription +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SuggestedEntitlementDescription', 'BetaSuggestedEntitlementDescription'] +slug: /tools/sdk/go/beta/methods/suggested-entitlement-description +tags: ['SDK', 'Software Development Kit', 'SuggestedEntitlementDescription', 'BetaSuggestedEntitlementDescription'] +--- + +# SuggestedEntitlementDescriptionAPI + Use this API to implement Suggested Entitlement Description (SED) functionality. +SED functionality leverages the power of LLM to generate suggested entitlement descriptions. +Refer to [GenAI Entitlement Descriptions](https://documentation.sailpoint.com/saas/help/access/entitlements.html#genai-entitlement-descriptions) to learn more about SED in Identity Security Cloud (ISC). + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-sed-batch-stats**](#get-sed-batch-stats) | **Get** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit Sed Batch Stats Request +[**get-sed-batches**](#get-sed-batches) | **Get** `/suggested-entitlement-description-batches` | List Sed Batch Request +[**list-seds**](#list-seds) | **Get** `/suggested-entitlement-descriptions` | List Suggested Entitlement Descriptions +[**patch-sed**](#patch-sed) | **Patch** `/suggested-entitlement-descriptions` | Patch Suggested Entitlement Description +[**submit-sed-approval**](#submit-sed-approval) | **Post** `/suggested-entitlement-description-approvals` | Submit Bulk Approval Request +[**submit-sed-assignment**](#submit-sed-assignment) | **Post** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request +[**submit-sed-batch-request**](#submit-sed-batch-request) | **Post** `/suggested-entitlement-description-batches` | Submit Sed Batch Request + + +## get-sed-batch-stats +Submit Sed Batch Stats Request +Submit Sed Batch Stats Request. + +Submits batchId in the path param `(e.g. {batchId}/stats)`. +API responses with stats of the batchId. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sed-batch-stats) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**batchId** | **string** | Batch Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSedBatchStatsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SedBatchStats**](../models/sed-batch-stats) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + batchId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | Batch Id # string | Batch Id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.GetSedBatchStats(context.Background(), batchId).Execute() + //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.GetSedBatchStats(context.Background(), batchId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatchStats``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSedBatchStats`: SedBatchStats + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatchStats`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sed-batches +List Sed Batch Request +List Sed Batches. +API responses with Sed Batch Status + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sed-batches) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSedBatchesRequest struct via the builder pattern + + +### Return type + +[**SedBatchStatus**](../models/sed-batch-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatches``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSedBatches`: SedBatchStatus + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatches`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-seds +List Suggested Entitlement Descriptions +List of Suggested Entitlement Descriptions (SED) + +SED field descriptions: + +**batchId**: the ID of the batch of entitlements that are submitted for description generation + +**displayName**: the display name of the entitlement that we are generating a description for + +**sourceName**: the name of the source associated with the entitlement that we are generating the description for + +**sourceId**: the ID of the source associated with the entitlement that we are generating the description for + +**status**: the status of the suggested entitlement description, valid status options: "requested", "suggested", "not_suggested", "failed", "assigned", "approved", "denied" + +**fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-seds) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSedsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int64** | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | + **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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* | + **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: **displayName, sourceName, status** | + **count** | **bool** | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. | + **countOnly** | **bool** | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. | + **requestedByAnyone** | **bool** | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested | + **showPendingStatusOnly** | **bool** | Will limit records to items that are in \"suggested\" or \"approved\" status | + +### Return type + +[**[]Sed**](../models/sed) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + limit := limit=25 // int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) # int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) + filters := `displayName co "Read and Write"` // 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) + sorters := `sorters=displayName` // 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: **displayName, sourceName, status** (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: **displayName, sourceName, status** (optional) + count := count=true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) + countOnly := count-only=true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) + requestedByAnyone := requested-by-anyone=true // bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) + showPendingStatusOnly := show-pending-status-only=true // bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.ListSeds(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.ListSeds(context.Background()).Limit(limit).Filters(filters).Sorters(sorters).Count(count).CountOnly(countOnly).RequestedByAnyone(requestedByAnyone).ShowPendingStatusOnly(showPendingStatusOnly).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.ListSeds``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSeds`: []Sed + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.ListSeds`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-sed +Patch Suggested Entitlement Description +Patch Suggested Entitlement Description + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-sed) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | id is sed id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSedRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **sedPatch** | [**[]SedPatch**](../models/sed-patch) | Sed Patch Request | + +### Return type + +[**Sed**](../models/sed) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `ebab396f-0af1-4050-89b7-dafc63ec70e7` // string | id is sed id # string | id is sed id + sedpatch := []byte(``) // []SedPatch | Sed Patch Request + + + var sedPatch beta.[]SedPatch + if err := json.Unmarshal(sedpatch, &sedPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.PatchSed(context.Background(), id).SedPatch(sedPatch).Execute() + //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.PatchSed(context.Background(), id).SedPatch(sedPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.PatchSed``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSed`: Sed + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.PatchSed`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-sed-approval +Submit Bulk Approval Request +Submit Bulk Approval Request for SED. +Request body takes list of SED Ids. API responses with list of SED Approval Status + +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-sed-approval) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitSedApprovalRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sedApproval** | [**[]SedApproval**](../models/sed-approval) | Sed Approval | + +### Return type + +[**[]SedApprovalStatus**](../models/sed-approval-status) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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() { + sedapproval := []byte(``) // []SedApproval | Sed Approval + + + var sedApproval beta.[]SedApproval + if err := json.Unmarshal(sedapproval, &sedApproval); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.SubmitSedApproval(context.Background()).SedApproval(sedApproval).Execute() + //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.SubmitSedApproval(context.Background()).SedApproval(sedApproval).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedApproval`: []SedApprovalStatus + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedApproval`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-sed-assignment +Submit Sed Assignment Request +Submit Assignment Request. +Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together + +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-sed-assignment) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitSedAssignmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sedAssignment** | [**SedAssignment**](../models/sed-assignment) | Sed Assignment Request | + +### Return type + +[**SedAssignmentResponse**](../models/sed-assignment-response) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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() { + sedassignment := []byte(`{ + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] + }`) // SedAssignment | Sed Assignment Request + + + var sedAssignment beta.SedAssignment + if err := json.Unmarshal(sedassignment, &sedAssignment); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.SubmitSedAssignment(context.Background()).SedAssignment(sedAssignment).Execute() + //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.SubmitSedAssignment(context.Background()).SedAssignment(sedAssignment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedAssignment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedAssignment`: SedAssignmentResponse + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedAssignment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-sed-batch-request +Submit Sed Batch Request +Submit Sed Batch Request. +Request body has one of the following: + - a list of entitlement Ids + - a list of SED Ids +that user wants to have description generated by LLM. API responses with batchId that groups Ids together + +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-sed-batch-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitSedBatchRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sedBatchRequest** | [**SedBatchRequest**](../models/sed-batch-request) | Sed Batch Request | + +### Return type + +[**SedBatchResponse**](../models/sed-batch-response) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sedbatchrequest := []byte(`{ + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + }`) // SedBatchRequest | Sed Batch Request (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest(context.Background()).SedBatchRequest(sedBatchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedBatchRequest`: SedBatchResponse + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/TaggedObjectsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/TaggedObjectsAPI.md new file mode 100644 index 000000000..c9e1e96ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/TaggedObjectsAPI.md @@ -0,0 +1,683 @@ +--- +id: beta-tagged-objects +title: TaggedObjects +pagination_label: TaggedObjects +sidebar_label: TaggedObjects +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaggedObjects', 'BetaTaggedObjects'] +slug: /tools/sdk/go/beta/methods/tagged-objects +tags: ['SDK', 'Software Development Kit', 'TaggedObjects', 'BetaTaggedObjects'] +--- + +# TaggedObjectsAPI + Use this API to implement object tagging functionality. +With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches Identity Security Cloud. + +In Identity Security Cloud, users can search their tenants for information and add tags objects they find. +Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future. + +For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. +Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. +The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. +When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag. + +With the API, you can tag even more different object types than you can in Identity Security Cloud (access profiles, entitlements, identities, and roles). +You can use the API to tag all these objects: + +- Access profiles + +- Applications + +- Certification campaigns + +- Entitlements + +- Identities + +- Roles + +- SOD (separation of duties) policies + +- Sources + +You can also use the API to directly find, create, and manage tagged objects without using search queries. + +There are limits to tags: + +- You can have up to 500 different tags in your tenant. + +- You can apply up to 30 tags to one object. + +- You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant. + +Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by Identity Security Cloud. + +These are the types of information often expressed in tags: + +- Affected departments + +- Compliance and regulatory categories + +- Remediation urgency levels + +- Risk levels + +Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-tagged-object**](#delete-tagged-object) | **Delete** `/tagged-objects/{type}/{id}` | Delete Object Tags +[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **Post** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects +[**get-tagged-object**](#get-tagged-object) | **Get** `/tagged-objects/{type}/{id}` | Get Tagged Object +[**list-tagged-objects**](#list-tagged-objects) | **Get** `/tagged-objects` | List Tagged Objects +[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **Get** `/tagged-objects/{type}` | List Tagged Objects by Type +[**put-tagged-object**](#put-tagged-object) | **Put** `/tagged-objects/{type}/{id}` | Update Tagged Object +[**set-tag-to-object**](#set-tag-to-object) | **Post** `/tagged-objects` | Add Tag to Object +[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **Post** `/tagged-objects/bulk-add` | Tag Multiple Objects + + +## delete-tagged-object +Delete Object Tags +Delete all tags from a tagged object. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-tagged-object) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**type_** | **string** | The type of object to delete tags from. | +**id** | **string** | The ID of the object to delete tags from. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteTaggedObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `ROLE` // string | The type of object to delete tags from. # string | The type of object to delete tags from. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object to delete tags from. # string | The ID of the object to delete tags from. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.TaggedObjectsAPI.DeleteTaggedObject(context.Background(), type_, id).Execute() + //r, err := apiClient.Beta.TaggedObjectsAPI.DeleteTaggedObject(context.Background(), type_, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.DeleteTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-tags-to-many-object +Remove Tags from Multiple Objects +This API removes tags from multiple objects. + +A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-tags-to-many-object) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteTagsToManyObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulkTaggedObject** | [**BulkTaggedObject**](../models/bulk-tagged-object) | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. | + +### Return type + + (empty response body) + +### 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() { + bulktaggedobject := []byte(`{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + + var bulkTaggedObject beta.BulkTaggedObject + if err := json.Unmarshal(bulktaggedobject, &bulkTaggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.TaggedObjectsAPI.DeleteTagsToManyObject(context.Background()).BulkTaggedObject(bulkTaggedObject).Execute() + //r, err := apiClient.Beta.TaggedObjectsAPI.DeleteTagsToManyObject(context.Background()).BulkTaggedObject(bulkTaggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.DeleteTagsToManyObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-tagged-object +Get Tagged Object +This gets a tagged object for the specified type. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tagged-object) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**type_** | **string** | The type of tagged object to retrieve. | +**id** | **string** | The ID of the object reference to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTaggedObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**TaggedObject**](../models/tagged-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `ROLE` // string | The type of tagged object to retrieve. # string | The type of tagged object to retrieve. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to retrieve. # string | The ID of the object reference to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaggedObjectsAPI.GetTaggedObject(context.Background(), type_, id).Execute() + //resp, r, err := apiClient.Beta.TaggedObjectsAPI.GetTaggedObject(context.Background(), type_, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.GetTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaggedObject`: TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.GetTaggedObject`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-tagged-objects +List Tagged Objects +This API returns a list of all tagged objects. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-tagged-objects) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTaggedObjectsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* | + +### Return type + +[**[]TaggedObject**](../models/tagged-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `tagName eq "BU_FINANCE"` // 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaggedObjectsAPI.ListTaggedObjects(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TaggedObjectsAPI.ListTaggedObjects(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.ListTaggedObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTaggedObjects`: []TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.ListTaggedObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-tagged-objects-by-type +List Tagged Objects by Type +This API returns a list of all tagged objects by type. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-tagged-objects-by-type) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**type_** | **string** | The type of tagged object to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTaggedObjectsByTypeRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **objectRef.id**: *eq* **objectRef.type**: *eq* | + +### Return type + +[**[]TaggedObject**](../models/tagged-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `ROLE` // string | The type of tagged object to retrieve. # string | The type of tagged object to retrieve. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `objectRef.id eq "2c91808568c529c60168cca6f90c1313"` // 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: **objectRef.id**: *eq* **objectRef.type**: *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: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaggedObjectsAPI.ListTaggedObjectsByType(context.Background(), type_).Execute() + //resp, r, err := apiClient.Beta.TaggedObjectsAPI.ListTaggedObjectsByType(context.Background(), type_).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.ListTaggedObjectsByType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTaggedObjectsByType`: []TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.ListTaggedObjectsByType`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-tagged-object +Update Tagged Object +This updates a tagged object for the specified type. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-tagged-object) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**type_** | **string** | The type of tagged object to update. | +**id** | **string** | The ID of the object reference to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutTaggedObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **taggedObject** | [**TaggedObject**](../models/tagged-object) | | + +### Return type + +[**TaggedObject**](../models/tagged-object) + +### 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() { + type_ := `ROLE` // string | The type of tagged object to update. # string | The type of tagged object to update. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to update. # string | The ID of the object reference to update. + taggedobject := []byte(`{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // TaggedObject | + + + var taggedObject beta.TaggedObject + if err := json.Unmarshal(taggedobject, &taggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaggedObjectsAPI.PutTaggedObject(context.Background(), type_, id).TaggedObject(taggedObject).Execute() + //resp, r, err := apiClient.Beta.TaggedObjectsAPI.PutTaggedObject(context.Background(), type_, id).TaggedObject(taggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.PutTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutTaggedObject`: TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.PutTaggedObject`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-tag-to-object +Add Tag to Object +This adds a tag to an object. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-tag-to-object) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetTagToObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **taggedObject** | [**TaggedObject**](../models/tagged-object) | | + +### Return type + + (empty response body) + +### 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() { + taggedobject := []byte(`{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // TaggedObject | + + + var taggedObject beta.TaggedObject + if err := json.Unmarshal(taggedobject, &taggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.TaggedObjectsAPI.SetTagToObject(context.Background()).TaggedObject(taggedObject).Execute() + //r, err := apiClient.Beta.TaggedObjectsAPI.SetTagToObject(context.Background()).TaggedObject(taggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.SetTagToObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## set-tags-to-many-objects +Tag Multiple Objects +This API adds tags to multiple objects. + +A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-tags-to-many-objects) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetTagsToManyObjectsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulkTaggedObject** | [**BulkTaggedObject**](../models/bulk-tagged-object) | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. | + +### Return type + +[**BulkTaggedObject**](../models/bulk-tagged-object) + +### 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() { + bulktaggedobject := []byte(`{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + + var bulkTaggedObject beta.BulkTaggedObject + if err := json.Unmarshal(bulktaggedobject, &bulkTaggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaggedObjectsAPI.SetTagsToManyObjects(context.Background()).BulkTaggedObject(bulkTaggedObject).Execute() + //resp, r, err := apiClient.Beta.TaggedObjectsAPI.SetTagsToManyObjects(context.Background()).BulkTaggedObject(bulkTaggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.SetTagsToManyObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetTagsToManyObjects`: BulkTaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.SetTagsToManyObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/TagsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/TagsAPI.md new file mode 100644 index 000000000..81aec5c11 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/TagsAPI.md @@ -0,0 +1,314 @@ +--- +id: beta-tags +title: Tags +pagination_label: Tags +sidebar_label: Tags +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Tags', 'BetaTags'] +slug: /tools/sdk/go/beta/methods/tags +tags: ['SDK', 'Software Development Kit', 'Tags', 'BetaTags'] +--- + +# TagsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-tag**](#create-tag) | **Post** `/tags` | Create Tag +[**delete-tag-by-id**](#delete-tag-by-id) | **Delete** `/tags/{id}` | Delete Tag +[**get-tag-by-id**](#get-tag-by-id) | **Get** `/tags/{id}` | Get Tag By Id +[**list-tags**](#list-tags) | **Get** `/tags` | List Tags + + +## create-tag +Create Tag +This API creates new tag. + +A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-tag) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateTagRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tag** | [**Tag**](../models/tag) | | + +### Return type + +[**Tag**](../models/tag) + +### 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() { + tag := []byte(`{ + "created" : "2022-05-04T14:48:49Z", + "tagCategoryRefs" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "name" : "PCI", + "modified" : "2022-07-14T16:31:11Z", + "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" + }`) // Tag | + + + var tag beta.Tag + if err := json.Unmarshal(tag, &tag); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TagsAPI.CreateTag(context.Background()).Tag(tag).Execute() + //resp, r, err := apiClient.Beta.TagsAPI.CreateTag(context.Background()).Tag(tag).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TagsAPI.CreateTag``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateTag`: Tag + fmt.Fprintf(os.Stdout, "Response from `TagsAPI.CreateTag`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-tag-by-id +Delete Tag +This API deletes a tag by specified id. + +A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-tag-by-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the object reference to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteTagByIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `329d96cf-3bdb-40a9-988a-b5037ab89022` // string | The ID of the object reference to delete. # string | The ID of the object reference to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.TagsAPI.DeleteTagById(context.Background(), id).Execute() + //r, err := apiClient.Beta.TagsAPI.DeleteTagById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TagsAPI.DeleteTagById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-tag-by-id +Get Tag By Id +Returns a tag by its id. + +A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tag-by-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the object reference to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTagByIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Tag**](../models/tag) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `329d96cf-3bdb-40a9-988a-b5037ab89022` // string | The ID of the object reference to retrieve. # string | The ID of the object reference to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TagsAPI.GetTagById(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.TagsAPI.GetTagById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TagsAPI.GetTagById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTagById`: Tag + fmt.Fprintf(os.Stdout, "Response from `TagsAPI.GetTagById`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-tags +List Tags +This API returns a list of tags. + +A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-tags) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTagsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, in, sw* | + **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: **id, name, created, modified** | + +### Return type + +[**[]Tag**](../models/tag) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db"` // 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, in, sw* (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, in, sw* (optional) + sorters := `name,-modified` // 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: **id, name, created, modified** (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: **id, name, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TagsAPI.ListTags(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TagsAPI.ListTags(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TagsAPI.ListTags``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTags`: []Tag + fmt.Fprintf(os.Stdout, "Response from `TagsAPI.ListTags`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/TaskManagementAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/TaskManagementAPI.md new file mode 100644 index 000000000..c0bac1273 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/TaskManagementAPI.md @@ -0,0 +1,365 @@ +--- +id: beta-task-management +title: TaskManagement +pagination_label: TaskManagement +sidebar_label: TaskManagement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskManagement', 'BetaTaskManagement'] +slug: /tools/sdk/go/beta/methods/task-management +tags: ['SDK', 'Software Development Kit', 'TaskManagement', 'BetaTaskManagement'] +--- + +# TaskManagementAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-pending-task-headers**](#get-pending-task-headers) | **Head** `/task-status/pending-tasks` | Retrieve Pending Task List Headers +[**get-pending-tasks**](#get-pending-tasks) | **Get** `/task-status/pending-tasks` | Retrieve Pending Task Status List +[**get-task-status**](#get-task-status) | **Get** `/task-status/{id}` | Get Task Status by ID +[**get-task-status-list**](#get-task-status-list) | **Get** `/task-status` | Retrieve Task Status List +[**update-task-status**](#update-task-status) | **Patch** `/task-status/{id}` | Update Task Status by ID + + +## get-pending-task-headers +Retrieve Pending Task List Headers +Responds with headers only for list of task statuses for pending tasks. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-pending-task-headers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPendingTaskHeadersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.TaskManagementAPI.GetPendingTaskHeaders(context.Background()).Execute() + //r, err := apiClient.Beta.TaskManagementAPI.GetPendingTaskHeaders(context.Background()).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetPendingTaskHeaders``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-pending-tasks +Retrieve Pending Task Status List +Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPendingTasksRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]TaskStatus**](../models/task-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaskManagementAPI.GetPendingTasks(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TaskManagementAPI.GetPendingTasks(context.Background()).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetPendingTasks``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPendingTasks`: []TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetPendingTasks`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-task-status +Get Task Status by ID +Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-task-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Task ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTaskStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**TaskStatus**](../models/task-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `00eebcf881994e419d72e757fd30dc0e` // string | Task ID. # string | Task ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaskManagementAPI.GetTaskStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.TaskManagementAPI.GetTaskStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetTaskStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaskStatus`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetTaskStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-task-status-list +Retrieve Task Status List +Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) endpoint. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-task-status-list) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTaskStatusListRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* | + **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: **created** | + +### Return type + +[**[]TaskStatus**](../models/task-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `completionStatus eq "Success"` // 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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) + sorters := `-created` // 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: **created** (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: **created** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaskManagementAPI.GetTaskStatusList(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TaskManagementAPI.GetTaskStatusList(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetTaskStatusList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaskStatusList`: []TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetTaskStatusList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-task-status +Update Task Status by ID +Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-task-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Task ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateTaskStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | The JSONPatch payload used to update the object. | + +### Return type + +[**TaskStatus**](../models/task-status) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `00eebcf881994e419d72e757fd30dc0e` // string | Task ID. # string | Task ID. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | The JSONPatch payload used to update the object. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaskManagementAPI.UpdateTaskStatus(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.TaskManagementAPI.UpdateTaskStatus(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.UpdateTaskStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateTaskStatus`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.UpdateTaskStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/TenantAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/TenantAPI.md new file mode 100644 index 000000000..707a20daa --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/TenantAPI.md @@ -0,0 +1,77 @@ +--- +id: beta-tenant +title: Tenant +pagination_label: Tenant +sidebar_label: Tenant +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Tenant', 'BetaTenant'] +slug: /tools/sdk/go/beta/methods/tenant +tags: ['SDK', 'Software Development Kit', 'Tenant', 'BetaTenant'] +--- + +# TenantAPI + API for reading tenant details. +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-tenant**](#get-tenant) | **Get** `/tenant` | Get Tenant Information. + + +## get-tenant +Get Tenant Information. +This rest endpoint can be used to retrieve tenant details. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tenant) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTenantRequest struct via the builder pattern + + +### Return type + +[**Tenant**](../models/tenant) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TenantAPI.GetTenant(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TenantAPI.GetTenant(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TenantAPI.GetTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenant`: Tenant + fmt.Fprintf(os.Stdout, "Response from `TenantAPI.GetTenant`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/TransformsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/TransformsAPI.md new file mode 100644 index 000000000..c417257d6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/TransformsAPI.md @@ -0,0 +1,377 @@ +--- +id: beta-transforms +title: Transforms +pagination_label: Transforms +sidebar_label: Transforms +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Transforms', 'BetaTransforms'] +slug: /tools/sdk/go/beta/methods/transforms +tags: ['SDK', 'Software Development Kit', 'Transforms', 'BetaTransforms'] +--- + +# TransformsAPI + The purpose of this API is to expose functionality for the manipulation of Transform objects. +Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having +to write code. + +Refer to [Transforms](https://developer.sailpoint.com/docs/extensibility/transforms/) for more information about transforms. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-transform**](#create-transform) | **Post** `/transforms` | Create transform +[**delete-transform**](#delete-transform) | **Delete** `/transforms/{id}` | Delete a transform +[**get-transform**](#get-transform) | **Get** `/transforms/{id}` | Transform by ID +[**list-transforms**](#list-transforms) | **Get** `/transforms` | List transforms +[**update-transform**](#update-transform) | **Put** `/transforms/{id}` | Update a transform + + +## create-transform +Create transform +Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-transform) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateTransformRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transform** | [**Transform**](../models/transform) | The transform to be created. | + +### Return type + +[**TransformRead**](../models/transform-read) + +### 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() { + transform := []byte(`{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }`) // Transform | The transform to be created. + + + var transform beta.Transform + if err := json.Unmarshal(transform, &transform); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TransformsAPI.CreateTransform(context.Background()).Transform(transform).Execute() + //resp, r, err := apiClient.Beta.TransformsAPI.CreateTransform(context.Background()).Transform(transform).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.CreateTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.CreateTransform`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-transform +Delete a transform +Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. +A token with transform delete authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-transform) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the transform to delete | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteTransformRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to delete # string | ID of the transform to delete + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.TransformsAPI.DeleteTransform(context.Background(), id).Execute() + //r, err := apiClient.Beta.TransformsAPI.DeleteTransform(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.DeleteTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-transform +Transform by ID +This API returns the transform specified by the given ID. +A token with transform read authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-transform) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the transform to retrieve | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTransformRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**TransformRead**](../models/transform-read) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to retrieve # string | ID of the transform to retrieve + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TransformsAPI.GetTransform(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.TransformsAPI.GetTransform(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.GetTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.GetTransform`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-transforms +List transforms +Gets a list of all saved transform objects. +A token with transforms-list read authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-transforms) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTransformsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **name** | **string** | Name of the transform to retrieve from the list. | + **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: **internal**: *eq* **name**: *eq, sw* | + +### Return type + +[**[]TransformRead**](../models/transform-read) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + name := `ExampleTransformName123` // string | Name of the transform to retrieve from the list. (optional) # string | Name of the transform to retrieve from the list. (optional) + filters := `name eq "Uppercase"` // 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: **internal**: *eq* **name**: *eq, sw* (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: **internal**: *eq* **name**: *eq, sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TransformsAPI.ListTransforms(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TransformsAPI.ListTransforms(context.Background()).Offset(offset).Limit(limit).Count(count).Name(name).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.ListTransforms``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTransforms`: []TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.ListTransforms`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-transform +Update a transform +Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. +A token with transform write authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-transform) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the transform to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateTransformRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **transform** | [**Transform**](../models/transform) | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. | + +### Return type + +[**TransformRead**](../models/transform-read) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to update # string | ID of the transform to update + transform := []byte(`{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }`) // Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TransformsAPI.UpdateTransform(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.TransformsAPI.UpdateTransform(context.Background(), id).Transform(transform).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.UpdateTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.UpdateTransform`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/TriggersAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/TriggersAPI.md new file mode 100644 index 000000000..688adde50 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/TriggersAPI.md @@ -0,0 +1,851 @@ +--- +id: beta-triggers +title: Triggers +pagination_label: Triggers +sidebar_label: Triggers +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Triggers', 'BetaTriggers'] +slug: /tools/sdk/go/beta/methods/triggers +tags: ['SDK', 'Software Development Kit', 'Triggers', 'BetaTriggers'] +--- + +# TriggersAPI + Event Triggers provide real-time updates to changes in Identity Security Cloud so you can take action as soon as an event occurs, rather than poll an API endpoint for updates. Identity Security Cloud provides a user interface within the admin console to create and manage trigger subscriptions. These endpoints allow for programatically creating and managing trigger subscriptions. + +There are two types of event triggers: + * `FIRE_AND_FORGET`: This trigger type will send a payload to each subscriber without needing a response. Each trigger of this type has a limit of **50 subscriptions**. + * `REQUEST_RESPONSE`: This trigger type will send a payload to a subscriber and expect a response back. Each trigger of this type may only have **one subscription**. + +## Available Event Triggers +Production ready event triggers that are available in all tenants. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Access Request Dynamic Approval](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-dynamic-approval/) | idn:access-request-dynamic-approver | REQUEST_RESPONSE |After an access request is submitted. Expects the subscriber to respond with the ID of an identity or workgroup to add to the approval workflow. | +| [Access Request Decision](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-decision/) | idn:access-request-post-approval | FIRE_AND_FORGET | After an access request is approved. | +| [Access Request Submitted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-submitted/) | idn:access-request-pre-approval | REQUEST_RESPONSE | After an access request is submitted. Expects the subscriber to respond with an approval decision. | +| [Account Aggregation Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:account-aggregation-completed | FIRE_AND_FORGET | After an account aggregation completed, terminated, failed. | +| Account Attributes Changed | idn:account-attributes-changed | FIRE_AND_FORGET | After an account aggregation, and one or more account attributes have changed. | +| Account Correlated | idn:account-correlated | FIRE_AND_FORGET | After an account is added to an identity. | +| Accounts Collected for Aggregation | idn:aggregation-accounts-collected | FIRE_AND_FORGET | New, changed, and deleted accounts have been gathered during an aggregation and are being processed. | +| Account Uncorrelated | idn:account-uncorrelated | FIRE_AND_FORGET | After an account is removed from an identity. | +| Campaign Activated | idn:campaign-activated | FIRE_AND_FORGET | After a campaign is activated. | +| Campaign Ended | idn:campaign-ended | FIRE_AND_FORGET | After a campaign ends. | +| Campaign Generated | idn:campaign-generated | FIRE_AND_FORGET | After a campaign finishes generating. | +| Certification Signed Off | idn:certification-signed-off | FIRE_AND_FORGET | After a certification is signed off by its reviewer. | +| [Identity Attributes Changed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:identity-attributes-changed | FIRE_AND_FORGET | After One or more identity attributes changed. | +| [Identity Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-created/) | idn:identity-created | FIRE_AND_FORGET | After an identity is created. | +| [Provisioning Action Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) | idn:post-provisioning | FIRE_AND_FORGET | After a provisioning action completed on a source. | +| [Scheduled Search](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/scheduled-search/) | idn:saved-search-complete | FIRE_AND_FORGET | After a scheduled search completed. | +| [Source Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-created/) | idn:source-created | FIRE_AND_FORGET | After a source is created. | +| [Source Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-deleted/) | idn:source-deleted | FIRE_AND_FORGET | After a source is deleted. | +| [Source Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-updated/) | idn:source-updated | FIRE_AND_FORGET | After configuration changes have been made to a source. | +| [VA Cluster Status Change](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/va-cluster-status-change/) | idn:va-cluster-status-change | FIRE_AND_FORGET | After the status of a VA cluster has changed. | + +## Early Access Event Triggers +Triggers that are in-development and not ready for production use. Please contact support to enable these triggers in your tenant. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Identity Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-deleted/) | idn:identity-deleted | FIRE_AND_FORGET | After an identity is deleted. | +| [Source Account Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-created/) | idn:source-account-created | FIRE_AND_FORGET | After a source account is created. | +| [Source Account Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-deleted/) | idn:source-account-deleted | FIRE_AND_FORGET | After a source account is deleted. | +| [Source Account Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-updated/) | idn:source-account-updated | FIRE_AND_FORGET | After a source account is changed. | + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**complete-trigger-invocation**](#complete-trigger-invocation) | **Post** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation +[**create-subscription**](#create-subscription) | **Post** `/trigger-subscriptions` | Create a Subscription +[**delete-subscription**](#delete-subscription) | **Delete** `/trigger-subscriptions/{id}` | Delete a Subscription +[**list-subscriptions**](#list-subscriptions) | **Get** `/trigger-subscriptions` | List Subscriptions +[**list-trigger-invocation-status**](#list-trigger-invocation-status) | **Get** `/trigger-invocations/status` | List Latest Invocation Statuses +[**list-triggers**](#list-triggers) | **Get** `/triggers` | List Triggers +[**patch-subscription**](#patch-subscription) | **Patch** `/trigger-subscriptions/{id}` | Patch a Subscription +[**start-test-trigger-invocation**](#start-test-trigger-invocation) | **Post** `/trigger-invocations/test` | Start a Test Invocation +[**test-subscription-filter**](#test-subscription-filter) | **Post** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter +[**update-subscription**](#update-subscription) | **Put** `/trigger-subscriptions/{id}` | Update a Subscription + + +## complete-trigger-invocation +Complete Trigger Invocation +Completes an invocation to a REQUEST_RESPONSE type trigger. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/complete-trigger-invocation) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the invocation to complete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompleteTriggerInvocationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **completeInvocation** | [**CompleteInvocation**](../models/complete-invocation) | | + +### Return type + + (empty response body) + +### 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 := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | The ID of the invocation to complete. # string | The ID of the invocation to complete. + completeinvocation := []byte(`{ + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + }`) // CompleteInvocation | + + + var completeInvocation beta.CompleteInvocation + if err := json.Unmarshal(completeinvocation, &completeInvocation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.TriggersAPI.CompleteTriggerInvocation(context.Background(), id).CompleteInvocation(completeInvocation).Execute() + //r, err := apiClient.Beta.TriggersAPI.CompleteTriggerInvocation(context.Background(), id).CompleteInvocation(completeInvocation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.CompleteTriggerInvocation``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## create-subscription +Create a Subscription +This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: +* HTTP subscriptions require httpConfig +* EventBridge subscriptions require eventBridgeConfig + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-subscription) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSubscriptionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **subscriptionPostRequest** | [**SubscriptionPostRequest**](../models/subscription-post-request) | | + +### Return type + +[**Subscription**](../models/subscription) + +### 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() { + subscriptionpostrequest := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "triggerId" : "idn:access-requested", + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + }`) // SubscriptionPostRequest | + + + var subscriptionPostRequest beta.SubscriptionPostRequest + if err := json.Unmarshal(subscriptionpostrequest, &subscriptionPostRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TriggersAPI.CreateSubscription(context.Background()).SubscriptionPostRequest(subscriptionPostRequest).Execute() + //resp, r, err := apiClient.Beta.TriggersAPI.CreateSubscription(context.Background()).SubscriptionPostRequest(subscriptionPostRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.CreateSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.CreateSubscription`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-subscription +Delete a Subscription +Deletes an existing subscription to a trigger. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-subscription) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Subscription ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSubscriptionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | Subscription ID # string | Subscription ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.TriggersAPI.DeleteSubscription(context.Background(), id).Execute() + //r, err := apiClient.Beta.TriggersAPI.DeleteSubscription(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.DeleteSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## list-subscriptions +List Subscriptions +Gets a list of all trigger subscriptions. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-subscriptions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSubscriptionsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **triggerId**: *eq* **type**: *eq, le* | + **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: **triggerId, triggerName** | + +### Return type + +[**[]Subscription**](../models/subscription) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"` // 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* **triggerId**: *eq* **type**: *eq, le* (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* **triggerId**: *eq* **type**: *eq, le* (optional) + sorters := `triggerName` // 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: **triggerId, triggerName** (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: **triggerId, triggerName** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TriggersAPI.ListSubscriptions(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TriggersAPI.ListSubscriptions(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListSubscriptions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSubscriptions`: []Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListSubscriptions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-trigger-invocation-status +List Latest Invocation Statuses +Gets a list of latest invocation statuses. +Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. +This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-trigger-invocation-status) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTriggerInvocationStatusRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **triggerId**: *eq* **subscriptionId**: *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: **triggerId, subscriptionName, created, completed** | + +### Return type + +[**[]InvocationStatus**](../models/invocation-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `triggerId eq "idn:access-request-dynamic-approver"` // 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: **triggerId**: *eq* **subscriptionId**: *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: **triggerId**: *eq* **subscriptionId**: *eq* (optional) + sorters := `created` // 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: **triggerId, subscriptionName, created, completed** (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: **triggerId, subscriptionName, created, completed** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TriggersAPI.ListTriggerInvocationStatus(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TriggersAPI.ListTriggerInvocationStatus(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListTriggerInvocationStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTriggerInvocationStatus`: []InvocationStatus + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListTriggerInvocationStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-triggers +List Triggers +Gets a list of triggers that are available in the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-triggers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTriggersRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ge, le* | + **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: **id, name** | + +### Return type + +[**[]Trigger**](../models/trigger) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "idn:access-request-post-approval"` // 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, ge, le* (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, ge, le* (optional) + sorters := `name` // 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: **id, name** (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: **id, name** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TriggersAPI.ListTriggers(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TriggersAPI.ListTriggers(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListTriggers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTriggers`: []Trigger + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListTriggers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-subscription +Patch a Subscription +This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: + +**name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-subscription) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Subscription to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSubscriptionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **subscriptionPatchRequestInner** | [**[]SubscriptionPatchRequestInner**](../models/subscription-patch-request-inner) | | + +### Return type + +[**Subscription**](../models/subscription) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | ID of the Subscription to patch # string | ID of the Subscription to patch + subscriptionpatchrequestinner := []byte(``) // []SubscriptionPatchRequestInner | + + + var subscriptionPatchRequestInner beta.[]SubscriptionPatchRequestInner + if err := json.Unmarshal(subscriptionpatchrequestinner, &subscriptionPatchRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TriggersAPI.PatchSubscription(context.Background(), id).SubscriptionPatchRequestInner(subscriptionPatchRequestInner).Execute() + //resp, r, err := apiClient.Beta.TriggersAPI.PatchSubscription(context.Background(), id).SubscriptionPatchRequestInner(subscriptionPatchRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.PatchSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.PatchSubscription`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-test-trigger-invocation +Start a Test Invocation +Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-test-trigger-invocation) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartTestTriggerInvocationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **testInvocation** | [**TestInvocation**](../models/test-invocation) | | + +### Return type + +[**[]Invocation**](../models/invocation) + +### 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() { + testinvocation := []byte(`{ + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } + }`) // TestInvocation | + + + var testInvocation beta.TestInvocation + if err := json.Unmarshal(testinvocation, &testInvocation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TriggersAPI.StartTestTriggerInvocation(context.Background()).TestInvocation(testInvocation).Execute() + //resp, r, err := apiClient.Beta.TriggersAPI.StartTestTriggerInvocation(context.Background()).TestInvocation(testInvocation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.StartTestTriggerInvocation``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartTestTriggerInvocation`: []Invocation + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.StartTestTriggerInvocation`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-subscription-filter +Validate a Subscription Filter +Validates a JSONPath filter expression against a provided mock input. +Request requires a security scope of: + +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-subscription-filter) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestSubscriptionFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **validateFilterInputDto** | [**ValidateFilterInputDto**](../models/validate-filter-input-dto) | | + +### Return type + +[**ValidateFilterOutputDto**](../models/validate-filter-output-dto) + +### 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() { + validatefilterinputdto := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + }`) // ValidateFilterInputDto | + + + var validateFilterInputDto beta.ValidateFilterInputDto + if err := json.Unmarshal(validatefilterinputdto, &validateFilterInputDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TriggersAPI.TestSubscriptionFilter(context.Background()).ValidateFilterInputDto(validateFilterInputDto).Execute() + //resp, r, err := apiClient.Beta.TriggersAPI.TestSubscriptionFilter(context.Background()).ValidateFilterInputDto(validateFilterInputDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.TestSubscriptionFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSubscriptionFilter`: ValidateFilterOutputDto + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.TestSubscriptionFilter`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-subscription +Update a Subscription +This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing + Subscription is completely replaced. The following fields are immutable: + + + * id + + * triggerId + + + Attempts to modify these fields result in 400. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-subscription) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Subscription ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSubscriptionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **subscriptionPutRequest** | [**SubscriptionPutRequest**](../models/subscription-put-request) | | + +### Return type + +[**Subscription**](../models/subscription) + +### 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 := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | Subscription ID # string | Subscription ID + subscriptionputrequest := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + }`) // SubscriptionPutRequest | + + + var subscriptionPutRequest beta.SubscriptionPutRequest + if err := json.Unmarshal(subscriptionputrequest, &subscriptionPutRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TriggersAPI.UpdateSubscription(context.Background(), id).SubscriptionPutRequest(subscriptionPutRequest).Execute() + //resp, r, err := apiClient.Beta.TriggersAPI.UpdateSubscription(context.Background(), id).SubscriptionPutRequest(subscriptionPutRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.UpdateSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.UpdateSubscription`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/UIMetadataAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/UIMetadataAPI.md new file mode 100644 index 000000000..2468bfb7f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/UIMetadataAPI.md @@ -0,0 +1,153 @@ +--- +id: beta-ui-metadata +title: UIMetadata +pagination_label: UIMetadata +sidebar_label: UIMetadata +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UIMetadata', 'BetaUIMetadata'] +slug: /tools/sdk/go/beta/methods/ui-metadata +tags: ['SDK', 'Software Development Kit', 'UIMetadata', 'BetaUIMetadata'] +--- + +# UIMetadataAPI + API for managing UI Metadata. Use this API to manage metadata about your User Interface. +For example you can set the iFrameWhitelist parameter to permit another domain to encapsulate IDN within an iframe or set the usernameEmptyText to change the placeholder text for Username on your tenant's login screen. +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-tenant-ui-metadata**](#get-tenant-ui-metadata) | **Get** `/ui-metadata/tenant` | Get a tenant UI metadata +[**set-tenant-ui-metadata**](#set-tenant-ui-metadata) | **Put** `/ui-metadata/tenant` | Update tenant UI metadata + + +## get-tenant-ui-metadata +Get a tenant UI metadata +This API endpoint retrieves UI metadata configured for your tenant. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tenant-ui-metadata) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTenantUiMetadataRequest struct via the builder pattern + + +### Return type + +[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.UIMetadataAPI.GetTenantUiMetadata(context.Background()).Execute() + //resp, r, err := apiClient.Beta.UIMetadataAPI.GetTenantUiMetadata(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `UIMetadataAPI.GetTenantUiMetadata``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenantUiMetadata`: TenantUiMetadataItemResponse + fmt.Fprintf(os.Stdout, "Response from `UIMetadataAPI.GetTenantUiMetadata`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-tenant-ui-metadata +Update tenant UI metadata +This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. +A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-tenant-ui-metadata) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetTenantUiMetadataRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenantUiMetadataItemUpdateRequest** | [**TenantUiMetadataItemUpdateRequest**](../models/tenant-ui-metadata-item-update-request) | | + +### Return type + +[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response) + +### 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() { + tenantuimetadataitemupdaterequest := []byte(`{ + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" + }`) // TenantUiMetadataItemUpdateRequest | + + + var tenantUiMetadataItemUpdateRequest beta.TenantUiMetadataItemUpdateRequest + if err := json.Unmarshal(tenantuimetadataitemupdaterequest, &tenantUiMetadataItemUpdateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.UIMetadataAPI.SetTenantUiMetadata(context.Background()).TenantUiMetadataItemUpdateRequest(tenantUiMetadataItemUpdateRequest).Execute() + //resp, r, err := apiClient.Beta.UIMetadataAPI.SetTenantUiMetadata(context.Background()).TenantUiMetadataItemUpdateRequest(tenantUiMetadataItemUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `UIMetadataAPI.SetTenantUiMetadata``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetTenantUiMetadata`: TenantUiMetadataItemResponse + fmt.Fprintf(os.Stdout, "Response from `UIMetadataAPI.SetTenantUiMetadata`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/VendorConnectorMappingsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/VendorConnectorMappingsAPI.md new file mode 100644 index 000000000..9bd6988e5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/VendorConnectorMappingsAPI.md @@ -0,0 +1,266 @@ +--- +id: beta-vendor-connector-mappings +title: VendorConnectorMappings +pagination_label: VendorConnectorMappings +sidebar_label: VendorConnectorMappings +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappings', 'BetaVendorConnectorMappings'] +slug: /tools/sdk/go/beta/methods/vendor-connector-mappings +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappings', 'BetaVendorConnectorMappings'] +--- + +# VendorConnectorMappingsAPI + Vendors use ISC connectors to connect their source data to ISC, but the data in their source and the data in ISC may be stored in different formats. +Connector mappings allow vendors to match their data on both sides of the connection. +The vendors can then track and manage access across their sources from ISC. +This API allows you to create and manage these vendor connector mappings. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **Post** `/vendor-connector-mappings` | Create Vendor Connector Mapping +[**delete-vendor-connector-mapping**](#delete-vendor-connector-mapping) | **Delete** `/vendor-connector-mappings` | Delete Vendor Connector Mapping +[**get-vendor-connector-mappings**](#get-vendor-connector-mappings) | **Get** `/vendor-connector-mappings` | List Vendor Connector Mappings + + +## create-vendor-connector-mapping +Create Vendor Connector Mapping +Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-vendor-connector-mapping) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateVendorConnectorMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vendorConnectorMapping** | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | | + +### Return type + +[**VendorConnectorMapping**](../models/vendor-connector-mapping) + +### 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() { + vendorconnectormapping := []byte(`{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }`) // VendorConnectorMapping | + + + var vendorConnectorMapping beta.VendorConnectorMapping + if err := json.Unmarshal(vendorconnectormapping, &vendorConnectorMapping); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.VendorConnectorMappingsAPI.CreateVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + //resp, r, err := apiClient.Beta.VendorConnectorMappingsAPI.CreateVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.CreateVendorConnectorMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateVendorConnectorMapping`: VendorConnectorMapping + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.CreateVendorConnectorMapping`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-vendor-connector-mapping +Delete Vendor Connector Mapping +Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-vendor-connector-mapping) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteVendorConnectorMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vendorConnectorMapping** | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | | + +### Return type + +[**DeleteVendorConnectorMapping200Response**](../models/delete-vendor-connector-mapping200-response) + +### 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() { + vendorconnectormapping := []byte(`{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }`) // VendorConnectorMapping | + + + var vendorConnectorMapping beta.VendorConnectorMapping + if err := json.Unmarshal(vendorconnectormapping, &vendorConnectorMapping); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.VendorConnectorMappingsAPI.DeleteVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + //resp, r, err := apiClient.Beta.VendorConnectorMappingsAPI.DeleteVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.DeleteVendorConnectorMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteVendorConnectorMapping`: DeleteVendorConnectorMapping200Response + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.DeleteVendorConnectorMapping`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-vendor-connector-mappings +List Vendor Connector Mappings +Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. + + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-vendor-connector-mappings) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetVendorConnectorMappingsRequest struct via the builder pattern + + +### Return type + +[**[]VendorConnectorMapping**](../models/vendor-connector-mapping) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.VendorConnectorMappingsAPI.GetVendorConnectorMappings(context.Background()).Execute() + //resp, r, err := apiClient.Beta.VendorConnectorMappingsAPI.GetVendorConnectorMappings(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.GetVendorConnectorMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetVendorConnectorMappings`: []VendorConnectorMapping + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.GetVendorConnectorMappings`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/WorkItemsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/WorkItemsAPI.md new file mode 100644 index 000000000..5028e557b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/WorkItemsAPI.md @@ -0,0 +1,967 @@ +--- +id: beta-work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItems', 'BetaWorkItems'] +slug: /tools/sdk/go/beta/methods/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'BetaWorkItems'] +--- + +# WorkItemsAPI + Use this API to implement work item functionality. +With this functionality in place, users can manage their work items (tasks). + +Work items refer to the tasks users see in Identity Security Cloud's Task Manager. +They can see the pending work items they need to complete, as well as the work items they have already completed. +Task Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. +For example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. +Once the user completes the work item, the work item will be listed with his or her other completed work items. + +To complete work items, users can use their dashboards and select the 'My Tasks' widget. +The widget will list any work items they need to complete, and they can select the work item from the list to review its details. +When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. + +Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-approval-item**](#approve-approval-item) | **Post** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item +[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **Post** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items +[**complete-work-item**](#complete-work-item) | **Post** `/work-items/{id}` | Complete a Work Item +[**get-completed-work-items**](#get-completed-work-items) | **Get** `/work-items/completed` | Completed Work Items +[**get-count-completed-work-items**](#get-count-completed-work-items) | **Get** `/work-items/completed/count` | Count Completed Work Items +[**get-count-work-items**](#get-count-work-items) | **Get** `/work-items/count` | Count Work Items +[**get-work-item**](#get-work-item) | **Get** `/work-items/{id}` | Get a Work Item +[**get-work-items-summary**](#get-work-items-summary) | **Get** `/work-items/summary` | Work Items Summary +[**list-work-items**](#list-work-items) | **Get** `/work-items` | List Work Items +[**reject-approval-item**](#reject-approval-item) | **Post** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item +[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **Post** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items +[**submit-account-selection**](#submit-account-selection) | **Post** `/work-items/{id}/submit-account-selection` | Submit Account Selections +[**submit-forward-work-item**](#submit-forward-work-item) | **Post** `/work-items/{id}/forward` | Forward a Work Item + + +## approve-approval-item +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Approve an Approval Item +This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/approve-approval-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | +**approvalItemId** | **string** | The ID of the approval item. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiApproveApprovalItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveApprovalItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## approve-approval-items-in-bulk +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Bulk approve Approval Items +This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/approve-approval-items-in-bulk) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiApproveApprovalItemsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.ApproveApprovalItemsInBulk(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.ApproveApprovalItemsInBulk(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItemsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveApprovalItemsInBulk`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItemsInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## complete-work-item +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Complete a Work Item +This API completes a work item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/complete-work-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompleteWorkItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | **string** | Body is the request payload to create form definition request | + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + body := `body_example` // string | Body is the request payload to create form definition request (optional) # string | Body is the request payload to create form definition request (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.CompleteWorkItem(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.CompleteWorkItem(context.Background(), id).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.CompleteWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompleteWorkItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.CompleteWorkItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-completed-work-items +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Completed Work Items +This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-completed-work-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCompletedWorkItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c91808571bcfcf80171c23e4b4221fc` // string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.GetCompletedWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.GetCompletedWorkItems(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCompletedWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCompletedWorkItems`: []WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCompletedWorkItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-count-completed-work-items +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Count Completed Work Items +This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-count-completed-work-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCountCompletedWorkItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | ID of the work item owner. | + **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 + +[**[]WorkItemsCount**](../models/work-items-count) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (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) + 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.WorkItemsAPI.GetCountCompletedWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.GetCountCompletedWorkItems(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCountCompletedWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCountCompletedWorkItems`: []WorkItemsCount + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCountCompletedWorkItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-count-work-items +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Count Work Items +This gets a count of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-count-work-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCountWorkItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | ID of the work item owner. | + +### Return type + +[**WorkItemsCount**](../models/work-items-count) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.GetCountWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.GetCountWorkItems(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCountWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCountWorkItems`: WorkItemsCount + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCountWorkItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-work-item +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get a Work Item +This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-work-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the work item. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **ownerId** | **string** | ID of the work item owner. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the work item. # string | ID of the work item. + ownerId := `2c9180835d191a86015d28455b4a2329` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.GetWorkItem(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.GetWorkItem(context.Background(), id).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkItem`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetWorkItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-work-items-summary +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Work Items Summary +This gets a summary of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-work-items-summary) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkItemsSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | ID of the work item owner. | + +### Return type + +[**WorkItemsSummary**](../models/work-items-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.GetWorkItemsSummary(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.GetWorkItemsSummary(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetWorkItemsSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkItemsSummary`: WorkItemsSummary + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetWorkItemsSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-work-items +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +List Work Items +This gets a collection of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-work-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkItemsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **ownerId** | **string** | ID of the work item owner. | + +### Return type + +[**[]WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + ownerId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.ListWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.ListWorkItems(context.Background()).Limit(limit).Offset(offset).Count(count).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ListWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkItems`: []WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ListWorkItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reject-approval-item +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Reject an Approval Item +This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/reject-approval-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | +**approvalItemId** | **string** | The ID of the approval item. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRejectApprovalItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.RejectApprovalItem(context.Background(), id, approvalItemId).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.RejectApprovalItem(context.Background(), id, approvalItemId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.RejectApprovalItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectApprovalItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.RejectApprovalItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reject-approval-items-in-bulk +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Bulk reject Approval Items +This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/reject-approval-items-in-bulk) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRejectApprovalItemsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.RejectApprovalItemsInBulk(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.RejectApprovalItemsInBulk(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.RejectApprovalItemsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectApprovalItemsInBulk`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.RejectApprovalItemsInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-account-selection +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Submit Account Selections +This API submits account selections. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-account-selection) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitAccountSelectionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **requestBody** | **map[string]interface{}** | Account Selection Data map, keyed on fieldName | + +### Return type + +[**WorkItems**](../models/work-items) + +### 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + requestBody := {fieldName=fieldValue} // map[string]interface{} | Account Selection Data map, keyed on fieldName # map[string]interface{} | Account Selection Data map, keyed on fieldName + + + var requestBody beta.RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.SubmitAccountSelection(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.SubmitAccountSelection(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.SubmitAccountSelection``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitAccountSelection`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.SubmitAccountSelection`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-forward-work-item +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Forward a Work Item +This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-forward-work-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitForwardWorkItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **workItemForward** | [**WorkItemForward**](../models/work-item-forward) | | + +### Return type + + (empty response body) + +### 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + workitemforward := []byte(`{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + }`) // WorkItemForward | + + + var workItemForward beta.WorkItemForward + if err := json.Unmarshal(workitemforward, &workItemForward); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.WorkItemsAPI.SubmitForwardWorkItem(context.Background(), id).WorkItemForward(workItemForward).Execute() + //r, err := apiClient.Beta.WorkItemsAPI.SubmitForwardWorkItem(context.Background(), id).WorkItemForward(workItemForward).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.SubmitForwardWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/WorkReassignmentAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/WorkReassignmentAPI.md new file mode 100644 index 000000000..2f93bae0c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/WorkReassignmentAPI.md @@ -0,0 +1,646 @@ +--- +id: beta-work-reassignment +title: WorkReassignment +pagination_label: WorkReassignment +sidebar_label: WorkReassignment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkReassignment', 'BetaWorkReassignment'] +slug: /tools/sdk/go/beta/methods/work-reassignment +tags: ['SDK', 'Software Development Kit', 'WorkReassignment', 'BetaWorkReassignment'] +--- + +# WorkReassignmentAPI + Use this API to implement work reassignment functionality. + +Work Reassignment allows access request reviews, certifications, and manual provisioning tasks assigned to a user to be reassigned to a different user. This is primarily used for: + +- Temporarily redirecting work for users who are out of office, such as on vacation or sick leave +- Permanently redirecting work for users who should not be assigned these tasks at all, such as senior executives or service identities + +Users can define reassignments for themselves, managers can add them for their team members, and administrators can configure them on any user’s behalf. Work assigned during the specified reassignment timeframes will be automatically reassigned to the designated user as it is created. + +Refer to [Work Reassignment](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html) for more information about this topic. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-reassignment-configuration**](#create-reassignment-configuration) | **Post** `/reassignment-configurations` | Create a Reassignment Configuration +[**delete-reassignment-configuration**](#delete-reassignment-configuration) | **Delete** `/reassignment-configurations/{identityId}/{configType}` | Delete Reassignment Configuration +[**get-evaluate-reassignment-configuration**](#get-evaluate-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate Reassignment Configuration +[**get-reassignment-config-types**](#get-reassignment-config-types) | **Get** `/reassignment-configurations/types` | List Reassignment Config Types +[**get-reassignment-configuration**](#get-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}` | Get Reassignment Configuration +[**get-tenant-config-configuration**](#get-tenant-config-configuration) | **Get** `/reassignment-configurations/tenant-config` | Get Tenant-wide Reassignment Configuration settings +[**list-reassignment-configurations**](#list-reassignment-configurations) | **Get** `/reassignment-configurations` | List Reassignment Configurations +[**put-reassignment-config**](#put-reassignment-config) | **Put** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration +[**put-tenant-configuration**](#put-tenant-configuration) | **Put** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings + + +## create-reassignment-configuration +Create a Reassignment Configuration +Creates a new Reassignment Configuration for the specified identity. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-reassignment-configuration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateReassignmentConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **configurationItemRequest** | [**ConfigurationItemRequest**](../models/configuration-item-request) | | + +### Return type + +[**ConfigurationItemResponse**](../models/configuration-item-response) + +### 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() { + configurationitemrequest := []byte(`{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }`) // ConfigurationItemRequest | + + + var configurationItemRequest beta.ConfigurationItemRequest + if err := json.Unmarshal(configurationitemrequest, &configurationItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkReassignmentAPI.CreateReassignmentConfiguration(context.Background()).ConfigurationItemRequest(configurationItemRequest).Execute() + //resp, r, err := apiClient.Beta.WorkReassignmentAPI.CreateReassignmentConfiguration(context.Background()).ConfigurationItemRequest(configurationItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.CreateReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateReassignmentConfiguration`: ConfigurationItemResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.CreateReassignmentConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-reassignment-configuration +Delete Reassignment Configuration +Deletes a single reassignment configuration for the specified identity + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-reassignment-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | unique identity id | +**configType** | [**ConfigTypeEnum**](../models/) | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteReassignmentConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique identity id + configType := // ConfigTypeEnum | # ConfigTypeEnum | + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.WorkReassignmentAPI.DeleteReassignmentConfiguration(context.Background(), identityId, configType).Execute() + //r, err := apiClient.Beta.WorkReassignmentAPI.DeleteReassignmentConfiguration(context.Background(), identityId, configType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.DeleteReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-evaluate-reassignment-configuration +Evaluate Reassignment Configuration +Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-evaluate-reassignment-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | unique identity id | +**configType** | [**ConfigTypeEnum**](../models/) | Reassignment work type | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEvaluateReassignmentConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **exclusionFilters** | **[]string** | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments | + +### Return type + +[**[]EvaluateResponse**](../models/evaluate-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique identity id + configType := accessRequests // ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type + exclusionfilters := []byte(`SELF_REVIEW_DELEGATION`) // []string | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkReassignmentAPI.GetEvaluateReassignmentConfiguration(context.Background(), identityId, configType).Execute() + //resp, r, err := apiClient.Beta.WorkReassignmentAPI.GetEvaluateReassignmentConfiguration(context.Background(), identityId, configType).ExclusionFilters(exclusionFilters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetEvaluateReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEvaluateReassignmentConfiguration`: []EvaluateResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetEvaluateReassignmentConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-reassignment-config-types +List Reassignment Config Types +Gets a collection of types which are available in the Reassignment Configuration UI. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-reassignment-config-types) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetReassignmentConfigTypesRequest struct via the builder pattern + + +### Return type + +[**[]ConfigType**](../models/config-type) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkReassignmentAPI.GetReassignmentConfigTypes(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkReassignmentAPI.GetReassignmentConfigTypes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetReassignmentConfigTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReassignmentConfigTypes`: []ConfigType + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetReassignmentConfigTypes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-reassignment-configuration +Get Reassignment Configuration +Gets the Reassignment Configuration for an identity. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-reassignment-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | unique identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetReassignmentConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ConfigurationResponse**](../models/configuration-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `2c91808781a71ddb0181b9090b5c504f` // string | unique identity id # string | unique identity id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkReassignmentAPI.GetReassignmentConfiguration(context.Background(), identityId).Execute() + //resp, r, err := apiClient.Beta.WorkReassignmentAPI.GetReassignmentConfiguration(context.Background(), identityId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReassignmentConfiguration`: ConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetReassignmentConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-tenant-config-configuration +Get Tenant-wide Reassignment Configuration settings +Gets the global Reassignment Configuration settings for the requestor's tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tenant-config-configuration) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTenantConfigConfigurationRequest struct via the builder pattern + + +### Return type + +[**TenantConfigurationResponse**](../models/tenant-configuration-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkReassignmentAPI.GetTenantConfigConfiguration(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkReassignmentAPI.GetTenantConfigConfiguration(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetTenantConfigConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenantConfigConfiguration`: TenantConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetTenantConfigConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-reassignment-configurations +List Reassignment Configurations +Gets all Reassignment configuration for the current org. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-reassignment-configurations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListReassignmentConfigurationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int32** | Max number of results to return. | [default to 20] + **offset** | **int32** | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. | + +### Return type + +[**[]ConfigurationResponse**](../models/configuration-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + limit := 20 // int32 | Max number of results to return. (optional) (default to 20) # int32 | Max number of results to return. (optional) (default to 20) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkReassignmentAPI.ListReassignmentConfigurations(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkReassignmentAPI.ListReassignmentConfigurations(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.ListReassignmentConfigurations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListReassignmentConfigurations`: []ConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.ListReassignmentConfigurations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-reassignment-config +Update Reassignment Configuration +Replaces existing Reassignment configuration for an identity with the newly provided configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-reassignment-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | unique identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutReassignmentConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **configurationItemRequest** | [**ConfigurationItemRequest**](../models/configuration-item-request) | | + +### Return type + +[**ConfigurationItemResponse**](../models/configuration-item-response) + +### 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() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique identity id + configurationitemrequest := []byte(`{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }`) // ConfigurationItemRequest | + + + var configurationItemRequest beta.ConfigurationItemRequest + if err := json.Unmarshal(configurationitemrequest, &configurationItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkReassignmentAPI.PutReassignmentConfig(context.Background(), identityId).ConfigurationItemRequest(configurationItemRequest).Execute() + //resp, r, err := apiClient.Beta.WorkReassignmentAPI.PutReassignmentConfig(context.Background(), identityId).ConfigurationItemRequest(configurationItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.PutReassignmentConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutReassignmentConfig`: ConfigurationItemResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.PutReassignmentConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-tenant-configuration +Update Tenant-wide Reassignment Configuration settings +Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-tenant-configuration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutTenantConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tenantConfigurationRequest** | [**TenantConfigurationRequest**](../models/tenant-configuration-request) | | + +### Return type + +[**TenantConfigurationResponse**](../models/tenant-configuration-response) + +### 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() { + tenantconfigurationrequest := []byte(`{ + "configDetails" : { + "disabled" : true + } + }`) // TenantConfigurationRequest | + + + var tenantConfigurationRequest beta.TenantConfigurationRequest + if err := json.Unmarshal(tenantconfigurationrequest, &tenantConfigurationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkReassignmentAPI.PutTenantConfiguration(context.Background()).TenantConfigurationRequest(tenantConfigurationRequest).Execute() + //resp, r, err := apiClient.Beta.WorkReassignmentAPI.PutTenantConfiguration(context.Background()).TenantConfigurationRequest(tenantConfigurationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.PutTenantConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutTenantConfiguration`: TenantConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.PutTenantConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/WorkflowsAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/WorkflowsAPI.md new file mode 100644 index 000000000..ecc2efc70 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Methods/WorkflowsAPI.md @@ -0,0 +1,1298 @@ +--- +id: beta-workflows +title: Workflows +pagination_label: Workflows +sidebar_label: Workflows +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Workflows', 'BetaWorkflows'] +slug: /tools/sdk/go/beta/methods/workflows +tags: ['SDK', 'Software Development Kit', 'Workflows', 'BetaWorkflows'] +--- + +# WorkflowsAPI + Workflows allow administrators to create custom automation scripts directly within Identity Security Cloud. These automation scripts respond to [event triggers](https://developer.sailpoint.com/docs/extensibility/event-triggers/#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the Identity Security Cloud UI. Workflows can be configured via a graphical user interface within Identity Security Cloud, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST. + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-workflow-execution**](#cancel-workflow-execution) | **Post** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID +[**create-workflow**](#create-workflow) | **Post** `/workflows` | Create Workflow +[**delete-workflow**](#delete-workflow) | **Delete** `/workflows/{id}` | Delete Workflow By Id +[**get-workflow**](#get-workflow) | **Get** `/workflows/{id}` | Get Workflow By Id +[**get-workflow-execution**](#get-workflow-execution) | **Get** `/workflow-executions/{id}` | Get Workflow Execution +[**get-workflow-execution-history**](#get-workflow-execution-history) | **Get** `/workflow-executions/{id}/history` | Get Workflow Execution History +[**get-workflow-executions**](#get-workflow-executions) | **Get** `/workflows/{id}/executions` | List Workflow Executions +[**list-complete-workflow-library**](#list-complete-workflow-library) | **Get** `/workflow-library` | List Complete Workflow Library +[**list-workflow-library-actions**](#list-workflow-library-actions) | **Get** `/workflow-library/actions` | List Workflow Library Actions +[**list-workflow-library-operators**](#list-workflow-library-operators) | **Get** `/workflow-library/operators` | List Workflow Library Operators +[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **Get** `/workflow-library/triggers` | List Workflow Library Triggers +[**list-workflows**](#list-workflows) | **Get** `/workflows` | List Workflows +[**patch-workflow**](#patch-workflow) | **Patch** `/workflows/{id}` | Patch Workflow +[**post-external-execute-workflow**](#post-external-execute-workflow) | **Post** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger +[**post-workflow-external-trigger**](#post-workflow-external-trigger) | **Post** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client +[**put-workflow**](#put-workflow) | **Put** `/workflows/{id}` | Update Workflow +[**test-external-execute-workflow**](#test-external-execute-workflow) | **Post** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger +[**test-workflow**](#test-workflow) | **Post** `/workflows/{id}/test` | Test Workflow By Id + + +## cancel-workflow-execution +Cancel Workflow Execution by ID +Use this API to cancel a running workflow execution. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/cancel-workflow-execution) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The workflow execution ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCancelWorkflowExecutionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | The workflow execution ID # string | The workflow execution ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.WorkflowsAPI.CancelWorkflowExecution(context.Background(), id).Execute() + //r, err := apiClient.Beta.WorkflowsAPI.CancelWorkflowExecution(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CancelWorkflowExecution``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## create-workflow +Create Workflow +Create a new workflow with the desired trigger and steps specified in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-workflow) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createWorkflowRequest** | [**CreateWorkflowRequest**](../models/create-workflow-request) | | + +### Return type + +[**Workflow**](../models/workflow) + +### 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() { + createworkflowrequest := []byte(`{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}`) // CreateWorkflowRequest | + + + var createWorkflowRequest beta.CreateWorkflowRequest + if err := json.Unmarshal(createworkflowrequest, &createWorkflowRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.CreateWorkflow(context.Background()).CreateWorkflowRequest(createWorkflowRequest).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.CreateWorkflow(context.Background()).CreateWorkflowRequest(createWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-workflow +Delete Workflow By Id +Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the Workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.WorkflowsAPI.DeleteWorkflow(context.Background(), id).Execute() + //r, err := apiClient.Beta.WorkflowsAPI.DeleteWorkflow(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.DeleteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-workflow +Get Workflow By Id +Get a single workflow by id. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **workflowMetrics** | **bool** | disable workflow metrics | [default to true] + +### Return type + +[**Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + workflowMetrics := false // bool | disable workflow metrics (optional) (default to true) # bool | disable workflow metrics (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.GetWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.GetWorkflow(context.Background(), id).WorkflowMetrics(workflowMetrics).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-workflow-execution +Get Workflow Execution +Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-execution) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Workflow execution ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkflowExecutionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Workflow execution ID. # string | Workflow execution ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.GetWorkflowExecution(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.GetWorkflowExecution(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecution``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecution`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecution`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-workflow-execution-history +Get Workflow Execution History +Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-execution-history) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow execution | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkflowExecutionHistoryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]WorkflowExecutionEvent**](../models/workflow-execution-event) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow execution # string | Id of the workflow execution + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.GetWorkflowExecutionHistory(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.GetWorkflowExecutionHistory(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutionHistory``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecutionHistory`: []WorkflowExecutionEvent + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutionHistory`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-workflow-executions +List Workflow Executions +Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: +1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. +2. Get your workflow ID from the response. +3. You can then do either of the following: + + - Filter to find relevant workflow executions. + For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq "Failed"` + + - Paginate through results with the `offset` parameter. + For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. + Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-executions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Workflow ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkflowExecutionsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* | + +### Return type + +[**[]WorkflowExecution**](../models/workflow-execution) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Workflow ID. # string | Workflow 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `status eq "Failed"` // 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: **startTime**: *eq, lt, le, gt, ge* **status**: *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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.GetWorkflowExecutions(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.GetWorkflowExecutions(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecutions`: []WorkflowExecution + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-complete-workflow-library +List Complete Workflow Library +This lists all triggers, actions, and operators in the library + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-complete-workflow-library) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCompleteWorkflowLibraryRequest struct via the builder pattern + + +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 + +[**[]ListCompleteWorkflowLibrary200ResponseInner**](../models/list-complete-workflow-library200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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.WorkflowsAPI.ListCompleteWorkflowLibrary(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.ListCompleteWorkflowLibrary(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListCompleteWorkflowLibrary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCompleteWorkflowLibrary`: []ListCompleteWorkflowLibrary200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListCompleteWorkflowLibrary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workflow-library-actions +List Workflow Library Actions +This lists the workflow actions available to you. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflow-library-actions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkflowLibraryActionsRequest struct via the builder pattern + + +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] + **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* | + +### Return type + +[**[]WorkflowLibraryAction**](../models/workflow-library-action) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + filters := `id eq "sp:create-campaign"` // 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* (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* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.ListWorkflowLibraryActions(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.ListWorkflowLibraryActions(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryActions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryActions`: []WorkflowLibraryAction + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryActions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workflow-library-operators +List Workflow Library Operators +This lists the workflow operators available to you + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflow-library-operators) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkflowLibraryOperatorsRequest struct via the builder pattern + + +### Return type + +[**[]WorkflowLibraryOperator**](../models/workflow-library-operator) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.ListWorkflowLibraryOperators(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.ListWorkflowLibraryOperators(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryOperators``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryOperators`: []WorkflowLibraryOperator + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryOperators`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workflow-library-triggers +List Workflow Library Triggers +This lists the workflow triggers available to you + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflow-library-triggers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkflowLibraryTriggersRequest struct via the builder pattern + + +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] + **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* | + +### Return type + +[**[]WorkflowLibraryTrigger**](../models/workflow-library-trigger) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + filters := `id eq "idn:identity-attributes-changed"` // 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* (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* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.ListWorkflowLibraryTriggers(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.ListWorkflowLibraryTriggers(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryTriggers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryTriggers`: []WorkflowLibraryTrigger + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryTriggers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workflows +List Workflows +List all workflows in the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflows) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkflowsRequest struct via the builder pattern + + +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] + **triggerId** | **string** | Trigger ID | + **connectorInstanceId** | **string** | Connector Instance ID | + +### Return type + +[**[]Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + triggerId := `idn:identity-created` // string | Trigger ID (optional) # string | Trigger ID (optional) + connectorInstanceId := `28541fec-bb81-4ad4-88ef-0f7d213adcad` // string | Connector Instance ID (optional) # string | Connector Instance ID (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.ListWorkflows(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.ListWorkflows(context.Background()).Limit(limit).Offset(offset).TriggerId(triggerId).ConnectorInstanceId(connectorInstanceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflows``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflows`: []Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflows`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-workflow +Patch Workflow +Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the Workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: application/json-patch+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 := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]`) // []JsonPatchOperation | + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.PatchWorkflow(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.PatchWorkflow(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PatchWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PatchWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## post-external-execute-workflow +Execute Workflow via External Trigger +This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/post-external-execute-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPostExternalExecuteWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **postExternalExecuteWorkflowRequest** | [**PostExternalExecuteWorkflowRequest**](../models/post-external-execute-workflow-request) | | + +### Return type + +[**PostExternalExecuteWorkflow200Response**](../models/post-external-execute-workflow200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + postexternalexecuteworkflowrequest := []byte(``) // PostExternalExecuteWorkflowRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.PostExternalExecuteWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.PostExternalExecuteWorkflow(context.Background(), id).PostExternalExecuteWorkflowRequest(postExternalExecuteWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PostExternalExecuteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PostExternalExecuteWorkflow`: PostExternalExecuteWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PostExternalExecuteWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## post-workflow-external-trigger +Generate External Trigger OAuth Client +Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/post-workflow-external-trigger) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPostWorkflowExternalTriggerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**WorkflowOAuthClient**](../models/workflow-o-auth-client) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.PostWorkflowExternalTrigger(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.PostWorkflowExternalTrigger(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PostWorkflowExternalTrigger``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PostWorkflowExternalTrigger`: WorkflowOAuthClient + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PostWorkflowExternalTrigger`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-workflow +Update Workflow +Perform a full update of a workflow. The updated workflow object is returned in the response. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the Workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **workflowBody** | [**WorkflowBody**](../models/workflow-body) | | + +### Return type + +[**Workflow**](../models/workflow) + +### 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 := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + workflowbody := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : "{}", + "type" : "EVENT" + }, + "enabled" : false + }`) // WorkflowBody | + + + var workflowBody beta.WorkflowBody + if err := json.Unmarshal(workflowbody, &workflowBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.PutWorkflow(context.Background(), id).WorkflowBody(workflowBody).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.PutWorkflow(context.Background(), id).WorkflowBody(workflowBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PutWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PutWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-external-execute-workflow +Test Workflow via External Trigger +Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-external-execute-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestExternalExecuteWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **testExternalExecuteWorkflowRequest** | [**TestExternalExecuteWorkflowRequest**](../models/test-external-execute-workflow-request) | | + +### Return type + +[**TestExternalExecuteWorkflow200Response**](../models/test-external-execute-workflow200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + testexternalexecuteworkflowrequest := []byte(``) // TestExternalExecuteWorkflowRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.TestExternalExecuteWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.TestExternalExecuteWorkflow(context.Background(), id).TestExternalExecuteWorkflowRequest(testExternalExecuteWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.TestExternalExecuteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestExternalExecuteWorkflow`: TestExternalExecuteWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.TestExternalExecuteWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-workflow +Test Workflow By Id +Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. +This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. +**This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** + +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **testWorkflowRequest** | [**TestWorkflowRequest**](../models/test-workflow-request) | | + +### Return type + +[**TestWorkflow200Response**](../models/test-workflow200-response) + +### 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 := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + testworkflowrequest := []byte(`{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}`) // TestWorkflowRequest | + + + var testWorkflowRequest beta.TestWorkflowRequest + if err := json.Unmarshal(testworkflowrequest, &testWorkflowRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.TestWorkflow(context.Background(), id).TestWorkflowRequest(testWorkflowRequest).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.TestWorkflow(context.Background(), id).TestWorkflowRequest(testWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.TestWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestWorkflow`: TestWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.TestWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessConstraint.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessConstraint.md new file mode 100644 index 000000000..ce1fa0ed7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessConstraint.md @@ -0,0 +1,106 @@ +--- +id: beta-access-constraint +title: AccessConstraint +pagination_label: AccessConstraint +sidebar_label: AccessConstraint +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessConstraint', 'BetaAccessConstraint'] +slug: /tools/sdk/go/beta/models/access-constraint +tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'BetaAccessConstraint'] +--- + +# AccessConstraint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of Access | +**Ids** | Pointer to **[]string** | Must be set only if operator is SELECTED. | [optional] +**Operator** | **string** | Used to determine whether the scope of the campaign should be reduced for selected ids or all. | + +## Methods + +### NewAccessConstraint + +`func NewAccessConstraint(type_ string, operator string, ) *AccessConstraint` + +NewAccessConstraint instantiates a new AccessConstraint 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 + +### NewAccessConstraintWithDefaults + +`func NewAccessConstraintWithDefaults() *AccessConstraint` + +NewAccessConstraintWithDefaults instantiates a new AccessConstraint 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 + +### GetType + +`func (o *AccessConstraint) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessConstraint) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessConstraint) SetType(v string)` + +SetType sets Type field to given value. + + +### GetIds + +`func (o *AccessConstraint) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *AccessConstraint) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *AccessConstraint) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *AccessConstraint) HasIds() bool` + +HasIds returns a boolean if a field has been set. + +### GetOperator + +`func (o *AccessConstraint) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *AccessConstraint) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *AccessConstraint) SetOperator(v string)` + +SetOperator sets Operator field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessCriteria.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessCriteria.md new file mode 100644 index 000000000..5e75cce05 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: beta-access-criteria +title: AccessCriteria +pagination_label: AccessCriteria +sidebar_label: AccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessCriteria', 'BetaAccessCriteria'] +slug: /tools/sdk/go/beta/models/access-criteria +tags: ['SDK', 'Software Development Kit', 'AccessCriteria', 'BetaAccessCriteria'] +--- + +# AccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Business name for the access construct list | [optional] +**CriteriaList** | Pointer to [**[]AccessCriteriaCriteriaListInner**](access-criteria-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional] + +## Methods + +### NewAccessCriteria + +`func NewAccessCriteria() *AccessCriteria` + +NewAccessCriteria instantiates a new AccessCriteria 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 + +### NewAccessCriteriaWithDefaults + +`func NewAccessCriteriaWithDefaults() *AccessCriteria` + +NewAccessCriteriaWithDefaults instantiates a new AccessCriteria 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 + +### GetName + +`func (o *AccessCriteria) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessCriteria) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessCriteria) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessCriteria) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCriteriaList + +`func (o *AccessCriteria) GetCriteriaList() []AccessCriteriaCriteriaListInner` + +GetCriteriaList returns the CriteriaList field if non-nil, zero value otherwise. + +### GetCriteriaListOk + +`func (o *AccessCriteria) GetCriteriaListOk() (*[]AccessCriteriaCriteriaListInner, bool)` + +GetCriteriaListOk returns a tuple with the CriteriaList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteriaList + +`func (o *AccessCriteria) SetCriteriaList(v []AccessCriteriaCriteriaListInner)` + +SetCriteriaList sets CriteriaList field to given value. + +### HasCriteriaList + +`func (o *AccessCriteria) HasCriteriaList() bool` + +HasCriteriaList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessCriteriaCriteriaListInner.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessCriteriaCriteriaListInner.md new file mode 100644 index 000000000..e0cd73697 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessCriteriaCriteriaListInner.md @@ -0,0 +1,116 @@ +--- +id: beta-access-criteria-criteria-list-inner +title: AccessCriteriaCriteriaListInner +pagination_label: AccessCriteriaCriteriaListInner +sidebar_label: AccessCriteriaCriteriaListInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessCriteriaCriteriaListInner', 'BetaAccessCriteriaCriteriaListInner'] +slug: /tools/sdk/go/beta/models/access-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'BetaAccessCriteriaCriteriaListInner'] +--- + +# AccessCriteriaCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies to | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies to | [optional] + +## Methods + +### NewAccessCriteriaCriteriaListInner + +`func NewAccessCriteriaCriteriaListInner() *AccessCriteriaCriteriaListInner` + +NewAccessCriteriaCriteriaListInner instantiates a new AccessCriteriaCriteriaListInner 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 + +### NewAccessCriteriaCriteriaListInnerWithDefaults + +`func NewAccessCriteriaCriteriaListInnerWithDefaults() *AccessCriteriaCriteriaListInner` + +NewAccessCriteriaCriteriaListInnerWithDefaults instantiates a new AccessCriteriaCriteriaListInner 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 + +### GetType + +`func (o *AccessCriteriaCriteriaListInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessCriteriaCriteriaListInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessCriteriaCriteriaListInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessCriteriaCriteriaListInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessCriteriaCriteriaListInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessCriteriaCriteriaListInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessCriteriaCriteriaListInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessCriteriaCriteriaListInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessCriteriaCriteriaListInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessCriteriaCriteriaListInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessCriteriaCriteriaListInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessCriteriaCriteriaListInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemAccessProfileResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemAccessProfileResponse.md new file mode 100644 index 000000000..f890664bb --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemAccessProfileResponse.md @@ -0,0 +1,340 @@ +--- +id: beta-access-item-access-profile-response +title: AccessItemAccessProfileResponse +pagination_label: AccessItemAccessProfileResponse +sidebar_label: AccessItemAccessProfileResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemAccessProfileResponse', 'BetaAccessItemAccessProfileResponse'] +slug: /tools/sdk/go/beta/models/access-item-access-profile-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'BetaAccessItemAccessProfileResponse'] +--- + +# AccessItemAccessProfileResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. accessProfile in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**Name** | Pointer to **string** | the access profile name | [optional] +**SourceName** | Pointer to **string** | the name of the source | [optional] +**SourceId** | Pointer to **string** | the id of the source | [optional] +**Description** | Pointer to **string** | the description for the access profile | [optional] +**DisplayName** | Pointer to **string** | the display name of the identity | [optional] +**EntitlementCount** | Pointer to **string** | the number of entitlements the access profile will create | [optional] +**AppDisplayName** | Pointer to **string** | the name of | [optional] +**RemoveDate** | Pointer to **string** | the date the access profile is no longer assigned to the specified identity | [optional] +**Standalone** | **bool** | indicates whether the access profile is standalone | +**Revocable** | **bool** | indicates whether the access profile is | + +## Methods + +### NewAccessItemAccessProfileResponse + +`func NewAccessItemAccessProfileResponse(standalone bool, revocable bool, ) *AccessItemAccessProfileResponse` + +NewAccessItemAccessProfileResponse instantiates a new AccessItemAccessProfileResponse 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 + +### NewAccessItemAccessProfileResponseWithDefaults + +`func NewAccessItemAccessProfileResponseWithDefaults() *AccessItemAccessProfileResponse` + +NewAccessItemAccessProfileResponseWithDefaults instantiates a new AccessItemAccessProfileResponse 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 + +### GetAccessType + +`func (o *AccessItemAccessProfileResponse) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemAccessProfileResponse) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemAccessProfileResponse) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemAccessProfileResponse) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemAccessProfileResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemAccessProfileResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemAccessProfileResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemAccessProfileResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemAccessProfileResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemAccessProfileResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemAccessProfileResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemAccessProfileResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemAccessProfileResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemAccessProfileResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemAccessProfileResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemAccessProfileResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessItemAccessProfileResponse) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessItemAccessProfileResponse) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessItemAccessProfileResponse) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessItemAccessProfileResponse) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessItemAccessProfileResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessItemAccessProfileResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessItemAccessProfileResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessItemAccessProfileResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemAccessProfileResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemAccessProfileResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemAccessProfileResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemAccessProfileResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccessItemAccessProfileResponse) GetEntitlementCount() string` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccessItemAccessProfileResponse) GetEntitlementCountOk() (*string, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccessItemAccessProfileResponse) SetEntitlementCount(v string)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccessItemAccessProfileResponse) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetAppDisplayName + +`func (o *AccessItemAccessProfileResponse) GetAppDisplayName() string` + +GetAppDisplayName returns the AppDisplayName field if non-nil, zero value otherwise. + +### GetAppDisplayNameOk + +`func (o *AccessItemAccessProfileResponse) GetAppDisplayNameOk() (*string, bool)` + +GetAppDisplayNameOk returns a tuple with the AppDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppDisplayName + +`func (o *AccessItemAccessProfileResponse) SetAppDisplayName(v string)` + +SetAppDisplayName sets AppDisplayName field to given value. + +### HasAppDisplayName + +`func (o *AccessItemAccessProfileResponse) HasAppDisplayName() bool` + +HasAppDisplayName returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *AccessItemAccessProfileResponse) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccessItemAccessProfileResponse) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccessItemAccessProfileResponse) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccessItemAccessProfileResponse) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetStandalone + +`func (o *AccessItemAccessProfileResponse) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *AccessItemAccessProfileResponse) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *AccessItemAccessProfileResponse) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + + +### GetRevocable + +`func (o *AccessItemAccessProfileResponse) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *AccessItemAccessProfileResponse) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *AccessItemAccessProfileResponse) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemAccountResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemAccountResponse.md new file mode 100644 index 000000000..738d8ab22 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemAccountResponse.md @@ -0,0 +1,220 @@ +--- +id: beta-access-item-account-response +title: AccessItemAccountResponse +pagination_label: AccessItemAccountResponse +sidebar_label: AccessItemAccountResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemAccountResponse', 'BetaAccessItemAccountResponse'] +slug: /tools/sdk/go/beta/models/access-item-account-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAccountResponse', 'BetaAccessItemAccountResponse'] +--- + +# AccessItemAccountResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. account in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**NativeIdentity** | Pointer to **string** | the native identifier used to uniquely identify an acccount | [optional] +**SourceName** | Pointer to **string** | the name of the source | [optional] +**SourceId** | Pointer to **string** | the id of the source | [optional] +**EntitlementCount** | Pointer to **string** | the number of entitlements the account will create | [optional] +**DisplayName** | Pointer to **string** | the display name of the identity | [optional] + +## Methods + +### NewAccessItemAccountResponse + +`func NewAccessItemAccountResponse() *AccessItemAccountResponse` + +NewAccessItemAccountResponse instantiates a new AccessItemAccountResponse 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 + +### NewAccessItemAccountResponseWithDefaults + +`func NewAccessItemAccountResponseWithDefaults() *AccessItemAccountResponse` + +NewAccessItemAccountResponseWithDefaults instantiates a new AccessItemAccountResponse 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 + +### GetAccessType + +`func (o *AccessItemAccountResponse) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemAccountResponse) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemAccountResponse) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemAccountResponse) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemAccountResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemAccountResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemAccountResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemAccountResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *AccessItemAccountResponse) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccessItemAccountResponse) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccessItemAccountResponse) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccessItemAccountResponse) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemAccountResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemAccountResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemAccountResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemAccountResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessItemAccountResponse) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessItemAccountResponse) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessItemAccountResponse) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessItemAccountResponse) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccessItemAccountResponse) GetEntitlementCount() string` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccessItemAccountResponse) GetEntitlementCountOk() (*string, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccessItemAccountResponse) SetEntitlementCount(v string)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccessItemAccountResponse) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemAccountResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemAccountResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemAccountResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemAccountResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemAppResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemAppResponse.md new file mode 100644 index 000000000..dfa0cea47 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemAppResponse.md @@ -0,0 +1,168 @@ +--- +id: beta-access-item-app-response +title: AccessItemAppResponse +pagination_label: AccessItemAppResponse +sidebar_label: AccessItemAppResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemAppResponse', 'BetaAccessItemAppResponse'] +slug: /tools/sdk/go/beta/models/access-item-app-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAppResponse', 'BetaAccessItemAppResponse'] +--- + +# AccessItemAppResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. entitlement in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**DisplayName** | Pointer to **string** | the access item display name | [optional] +**SourceName** | Pointer to **string** | the associated source name if it exists | [optional] +**AppRoleId** | Pointer to **string** | the app role id | [optional] + +## Methods + +### NewAccessItemAppResponse + +`func NewAccessItemAppResponse() *AccessItemAppResponse` + +NewAccessItemAppResponse instantiates a new AccessItemAppResponse 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 + +### NewAccessItemAppResponseWithDefaults + +`func NewAccessItemAppResponseWithDefaults() *AccessItemAppResponse` + +NewAccessItemAppResponseWithDefaults instantiates a new AccessItemAppResponse 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 + +### GetAccessType + +`func (o *AccessItemAppResponse) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemAppResponse) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemAppResponse) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemAppResponse) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemAppResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemAppResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemAppResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemAppResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemAppResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemAppResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemAppResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemAppResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemAppResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemAppResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemAppResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemAppResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetAppRoleId + +`func (o *AccessItemAppResponse) GetAppRoleId() string` + +GetAppRoleId returns the AppRoleId field if non-nil, zero value otherwise. + +### GetAppRoleIdOk + +`func (o *AccessItemAppResponse) GetAppRoleIdOk() (*string, bool)` + +GetAppRoleIdOk returns a tuple with the AppRoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppRoleId + +`func (o *AccessItemAppResponse) SetAppRoleId(v string)` + +SetAppRoleId sets AppRoleId field to given value. + +### HasAppRoleId + +`func (o *AccessItemAppResponse) HasAppRoleId() bool` + +HasAppRoleId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemApproverDto.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemApproverDto.md new file mode 100644 index 000000000..906de1e0d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemApproverDto.md @@ -0,0 +1,116 @@ +--- +id: beta-access-item-approver-dto +title: AccessItemApproverDto +pagination_label: AccessItemApproverDto +sidebar_label: AccessItemApproverDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemApproverDto', 'BetaAccessItemApproverDto'] +slug: /tools/sdk/go/beta/models/access-item-approver-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemApproverDto', 'BetaAccessItemApproverDto'] +--- + +# AccessItemApproverDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of the identity who approved the access item request. | [optional] +**Id** | Pointer to **string** | ID of the identity who approved the access item request. | [optional] +**Name** | Pointer to **string** | Name of the identity who approved the access item request. | [optional] + +## Methods + +### NewAccessItemApproverDto + +`func NewAccessItemApproverDto() *AccessItemApproverDto` + +NewAccessItemApproverDto instantiates a new AccessItemApproverDto 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 + +### NewAccessItemApproverDtoWithDefaults + +`func NewAccessItemApproverDtoWithDefaults() *AccessItemApproverDto` + +NewAccessItemApproverDtoWithDefaults instantiates a new AccessItemApproverDto 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 + +### GetType + +`func (o *AccessItemApproverDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemApproverDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemApproverDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemApproverDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemApproverDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemApproverDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemApproverDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemApproverDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemApproverDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemApproverDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemApproverDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemApproverDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemAssociated.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemAssociated.md new file mode 100644 index 000000000..1cdafe84e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemAssociated.md @@ -0,0 +1,168 @@ +--- +id: beta-access-item-associated +title: AccessItemAssociated +pagination_label: AccessItemAssociated +sidebar_label: AccessItemAssociated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemAssociated', 'BetaAccessItemAssociated'] +slug: /tools/sdk/go/beta/models/access-item-associated +tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'BetaAccessItemAssociated'] +--- + +# AccessItemAssociated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] +**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] + +## Methods + +### NewAccessItemAssociated + +`func NewAccessItemAssociated() *AccessItemAssociated` + +NewAccessItemAssociated instantiates a new AccessItemAssociated 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 + +### NewAccessItemAssociatedWithDefaults + +`func NewAccessItemAssociatedWithDefaults() *AccessItemAssociated` + +NewAccessItemAssociatedWithDefaults instantiates a new AccessItemAssociated 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 + +### GetAccessItem + +`func (o *AccessItemAssociated) GetAccessItem() AccessItemAssociatedAccessItem` + +GetAccessItem returns the AccessItem field if non-nil, zero value otherwise. + +### GetAccessItemOk + +`func (o *AccessItemAssociated) GetAccessItemOk() (*AccessItemAssociatedAccessItem, bool)` + +GetAccessItemOk returns a tuple with the AccessItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItem + +`func (o *AccessItemAssociated) SetAccessItem(v AccessItemAssociatedAccessItem)` + +SetAccessItem sets AccessItem field to given value. + +### HasAccessItem + +`func (o *AccessItemAssociated) HasAccessItem() bool` + +HasAccessItem returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *AccessItemAssociated) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessItemAssociated) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessItemAssociated) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccessItemAssociated) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEventType + +`func (o *AccessItemAssociated) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AccessItemAssociated) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AccessItemAssociated) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AccessItemAssociated) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDt + +`func (o *AccessItemAssociated) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *AccessItemAssociated) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *AccessItemAssociated) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *AccessItemAssociated) HasDt() bool` + +HasDt returns a boolean if a field has been set. + +### GetGovernanceEvent + +`func (o *AccessItemAssociated) GetGovernanceEvent() CorrelatedGovernanceEvent` + +GetGovernanceEvent returns the GovernanceEvent field if non-nil, zero value otherwise. + +### GetGovernanceEventOk + +`func (o *AccessItemAssociated) GetGovernanceEventOk() (*CorrelatedGovernanceEvent, bool)` + +GetGovernanceEventOk returns a tuple with the GovernanceEvent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceEvent + +`func (o *AccessItemAssociated) SetGovernanceEvent(v CorrelatedGovernanceEvent)` + +SetGovernanceEvent sets GovernanceEvent field to given value. + +### HasGovernanceEvent + +`func (o *AccessItemAssociated) HasGovernanceEvent() bool` + +HasGovernanceEvent returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemAssociatedAccessItem.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemAssociatedAccessItem.md new file mode 100644 index 000000000..163dabb7d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemAssociatedAccessItem.md @@ -0,0 +1,512 @@ +--- +id: beta-access-item-associated-access-item +title: AccessItemAssociatedAccessItem +pagination_label: AccessItemAssociatedAccessItem +sidebar_label: AccessItemAssociatedAccessItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemAssociatedAccessItem', 'BetaAccessItemAssociatedAccessItem'] +slug: /tools/sdk/go/beta/models/access-item-associated-access-item +tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'BetaAccessItemAssociatedAccessItem'] +--- + +# AccessItemAssociatedAccessItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. role in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**Name** | Pointer to **string** | the access profile name | [optional] +**SourceName** | Pointer to **string** | the associated source name if it exists | [optional] +**SourceId** | Pointer to **string** | the id of the source | [optional] +**Description** | Pointer to **string** | the description for the role | [optional] +**DisplayName** | Pointer to **string** | the role display name | [optional] +**EntitlementCount** | Pointer to **string** | the number of entitlements the account will create | [optional] +**AppDisplayName** | Pointer to **string** | the name of | [optional] +**RemoveDate** | Pointer to **string** | the date the role is no longer assigned to the specified identity | [optional] +**Standalone** | **bool** | indicates whether the entitlement is standalone | +**Revocable** | **bool** | indicates whether the role is revocable | +**NativeIdentity** | Pointer to **string** | the native identifier used to uniquely identify an acccount | [optional] +**AppRoleId** | Pointer to **string** | the app role id | [optional] +**Attribute** | Pointer to **string** | the entitlement attribute | [optional] +**Value** | Pointer to **string** | the associated value | [optional] +**EntitlementType** | Pointer to **string** | the type of entitlement | [optional] +**Privileged** | **bool** | indicates whether the entitlement is privileged | +**CloudGoverned** | **bool** | indicates whether the entitlement is cloud governed | + +## Methods + +### NewAccessItemAssociatedAccessItem + +`func NewAccessItemAssociatedAccessItem(standalone bool, revocable bool, privileged bool, cloudGoverned bool, ) *AccessItemAssociatedAccessItem` + +NewAccessItemAssociatedAccessItem instantiates a new AccessItemAssociatedAccessItem 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 + +### NewAccessItemAssociatedAccessItemWithDefaults + +`func NewAccessItemAssociatedAccessItemWithDefaults() *AccessItemAssociatedAccessItem` + +NewAccessItemAssociatedAccessItemWithDefaults instantiates a new AccessItemAssociatedAccessItem 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 + +### GetAccessType + +`func (o *AccessItemAssociatedAccessItem) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemAssociatedAccessItem) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemAssociatedAccessItem) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemAssociatedAccessItem) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemAssociatedAccessItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemAssociatedAccessItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemAssociatedAccessItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemAssociatedAccessItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemAssociatedAccessItem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemAssociatedAccessItem) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemAssociatedAccessItem) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemAssociatedAccessItem) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemAssociatedAccessItem) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemAssociatedAccessItem) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemAssociatedAccessItem) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemAssociatedAccessItem) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessItemAssociatedAccessItem) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessItemAssociatedAccessItem) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessItemAssociatedAccessItem) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessItemAssociatedAccessItem) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessItemAssociatedAccessItem) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessItemAssociatedAccessItem) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessItemAssociatedAccessItem) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessItemAssociatedAccessItem) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemAssociatedAccessItem) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemAssociatedAccessItem) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemAssociatedAccessItem) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemAssociatedAccessItem) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccessItemAssociatedAccessItem) GetEntitlementCount() string` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccessItemAssociatedAccessItem) GetEntitlementCountOk() (*string, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccessItemAssociatedAccessItem) SetEntitlementCount(v string)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccessItemAssociatedAccessItem) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetAppDisplayName + +`func (o *AccessItemAssociatedAccessItem) GetAppDisplayName() string` + +GetAppDisplayName returns the AppDisplayName field if non-nil, zero value otherwise. + +### GetAppDisplayNameOk + +`func (o *AccessItemAssociatedAccessItem) GetAppDisplayNameOk() (*string, bool)` + +GetAppDisplayNameOk returns a tuple with the AppDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppDisplayName + +`func (o *AccessItemAssociatedAccessItem) SetAppDisplayName(v string)` + +SetAppDisplayName sets AppDisplayName field to given value. + +### HasAppDisplayName + +`func (o *AccessItemAssociatedAccessItem) HasAppDisplayName() bool` + +HasAppDisplayName returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *AccessItemAssociatedAccessItem) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccessItemAssociatedAccessItem) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccessItemAssociatedAccessItem) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccessItemAssociatedAccessItem) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetStandalone + +`func (o *AccessItemAssociatedAccessItem) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *AccessItemAssociatedAccessItem) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *AccessItemAssociatedAccessItem) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + + +### GetRevocable + +`func (o *AccessItemAssociatedAccessItem) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *AccessItemAssociatedAccessItem) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *AccessItemAssociatedAccessItem) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + + +### GetNativeIdentity + +`func (o *AccessItemAssociatedAccessItem) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccessItemAssociatedAccessItem) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccessItemAssociatedAccessItem) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccessItemAssociatedAccessItem) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetAppRoleId + +`func (o *AccessItemAssociatedAccessItem) GetAppRoleId() string` + +GetAppRoleId returns the AppRoleId field if non-nil, zero value otherwise. + +### GetAppRoleIdOk + +`func (o *AccessItemAssociatedAccessItem) GetAppRoleIdOk() (*string, bool)` + +GetAppRoleIdOk returns a tuple with the AppRoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppRoleId + +`func (o *AccessItemAssociatedAccessItem) SetAppRoleId(v string)` + +SetAppRoleId sets AppRoleId field to given value. + +### HasAppRoleId + +`func (o *AccessItemAssociatedAccessItem) HasAppRoleId() bool` + +HasAppRoleId returns a boolean if a field has been set. + +### GetAttribute + +`func (o *AccessItemAssociatedAccessItem) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *AccessItemAssociatedAccessItem) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *AccessItemAssociatedAccessItem) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *AccessItemAssociatedAccessItem) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *AccessItemAssociatedAccessItem) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AccessItemAssociatedAccessItem) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AccessItemAssociatedAccessItem) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AccessItemAssociatedAccessItem) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetEntitlementType + +`func (o *AccessItemAssociatedAccessItem) GetEntitlementType() string` + +GetEntitlementType returns the EntitlementType field if non-nil, zero value otherwise. + +### GetEntitlementTypeOk + +`func (o *AccessItemAssociatedAccessItem) GetEntitlementTypeOk() (*string, bool)` + +GetEntitlementTypeOk returns a tuple with the EntitlementType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementType + +`func (o *AccessItemAssociatedAccessItem) SetEntitlementType(v string)` + +SetEntitlementType sets EntitlementType field to given value. + +### HasEntitlementType + +`func (o *AccessItemAssociatedAccessItem) HasEntitlementType() bool` + +HasEntitlementType returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *AccessItemAssociatedAccessItem) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *AccessItemAssociatedAccessItem) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *AccessItemAssociatedAccessItem) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + + +### GetCloudGoverned + +`func (o *AccessItemAssociatedAccessItem) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *AccessItemAssociatedAccessItem) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *AccessItemAssociatedAccessItem) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemDiff.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemDiff.md new file mode 100644 index 000000000..152bc92e9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemDiff.md @@ -0,0 +1,142 @@ +--- +id: beta-access-item-diff +title: AccessItemDiff +pagination_label: AccessItemDiff +sidebar_label: AccessItemDiff +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemDiff', 'BetaAccessItemDiff'] +slug: /tools/sdk/go/beta/models/access-item-diff +tags: ['SDK', 'Software Development Kit', 'AccessItemDiff', 'BetaAccessItemDiff'] +--- + +# AccessItemDiff + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the id of the access item | [optional] +**EventType** | Pointer to **string** | | [optional] +**DisplayName** | Pointer to **string** | the display name of the access item | [optional] +**SourceName** | Pointer to **string** | the source name of the access item | [optional] + +## Methods + +### NewAccessItemDiff + +`func NewAccessItemDiff() *AccessItemDiff` + +NewAccessItemDiff instantiates a new AccessItemDiff 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 + +### NewAccessItemDiffWithDefaults + +`func NewAccessItemDiffWithDefaults() *AccessItemDiff` + +NewAccessItemDiffWithDefaults instantiates a new AccessItemDiff 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 + +### GetId + +`func (o *AccessItemDiff) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemDiff) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemDiff) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemDiff) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetEventType + +`func (o *AccessItemDiff) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AccessItemDiff) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AccessItemDiff) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AccessItemDiff) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemDiff) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemDiff) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemDiff) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemDiff) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemDiff) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemDiff) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemDiff) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemDiff) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemEntitlementResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemEntitlementResponse.md new file mode 100644 index 000000000..17de2d518 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemEntitlementResponse.md @@ -0,0 +1,335 @@ +--- +id: beta-access-item-entitlement-response +title: AccessItemEntitlementResponse +pagination_label: AccessItemEntitlementResponse +sidebar_label: AccessItemEntitlementResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemEntitlementResponse', 'BetaAccessItemEntitlementResponse'] +slug: /tools/sdk/go/beta/models/access-item-entitlement-response +tags: ['SDK', 'Software Development Kit', 'AccessItemEntitlementResponse', 'BetaAccessItemEntitlementResponse'] +--- + +# AccessItemEntitlementResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. entitlement in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**Attribute** | Pointer to **string** | the entitlement attribute | [optional] +**Value** | Pointer to **string** | the associated value | [optional] +**EntitlementType** | Pointer to **string** | the type of entitlement | [optional] +**SourceName** | Pointer to **string** | the name of the source | [optional] +**SourceId** | Pointer to **string** | the id of the source | [optional] +**Description** | Pointer to **string** | the description for the entitlment | [optional] +**DisplayName** | Pointer to **string** | the display name of the identity | [optional] +**Standalone** | **bool** | indicates whether the entitlement is standalone | +**Privileged** | **bool** | indicates whether the entitlement is privileged | +**CloudGoverned** | **bool** | indicates whether the entitlement is cloud governed | + +## Methods + +### NewAccessItemEntitlementResponse + +`func NewAccessItemEntitlementResponse(standalone bool, privileged bool, cloudGoverned bool, ) *AccessItemEntitlementResponse` + +NewAccessItemEntitlementResponse instantiates a new AccessItemEntitlementResponse 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 + +### NewAccessItemEntitlementResponseWithDefaults + +`func NewAccessItemEntitlementResponseWithDefaults() *AccessItemEntitlementResponse` + +NewAccessItemEntitlementResponseWithDefaults instantiates a new AccessItemEntitlementResponse 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 + +### GetAccessType + +`func (o *AccessItemEntitlementResponse) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemEntitlementResponse) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemEntitlementResponse) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemEntitlementResponse) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemEntitlementResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemEntitlementResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemEntitlementResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemEntitlementResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAttribute + +`func (o *AccessItemEntitlementResponse) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *AccessItemEntitlementResponse) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *AccessItemEntitlementResponse) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *AccessItemEntitlementResponse) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *AccessItemEntitlementResponse) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AccessItemEntitlementResponse) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AccessItemEntitlementResponse) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AccessItemEntitlementResponse) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetEntitlementType + +`func (o *AccessItemEntitlementResponse) GetEntitlementType() string` + +GetEntitlementType returns the EntitlementType field if non-nil, zero value otherwise. + +### GetEntitlementTypeOk + +`func (o *AccessItemEntitlementResponse) GetEntitlementTypeOk() (*string, bool)` + +GetEntitlementTypeOk returns a tuple with the EntitlementType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementType + +`func (o *AccessItemEntitlementResponse) SetEntitlementType(v string)` + +SetEntitlementType sets EntitlementType field to given value. + +### HasEntitlementType + +`func (o *AccessItemEntitlementResponse) HasEntitlementType() bool` + +HasEntitlementType returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemEntitlementResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemEntitlementResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemEntitlementResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemEntitlementResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessItemEntitlementResponse) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessItemEntitlementResponse) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessItemEntitlementResponse) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessItemEntitlementResponse) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessItemEntitlementResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessItemEntitlementResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessItemEntitlementResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessItemEntitlementResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemEntitlementResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemEntitlementResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemEntitlementResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemEntitlementResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetStandalone + +`func (o *AccessItemEntitlementResponse) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *AccessItemEntitlementResponse) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *AccessItemEntitlementResponse) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + + +### GetPrivileged + +`func (o *AccessItemEntitlementResponse) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *AccessItemEntitlementResponse) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *AccessItemEntitlementResponse) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + + +### GetCloudGoverned + +`func (o *AccessItemEntitlementResponse) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *AccessItemEntitlementResponse) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *AccessItemEntitlementResponse) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemOwnerDto.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemOwnerDto.md new file mode 100644 index 000000000..7b4b8e543 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemOwnerDto.md @@ -0,0 +1,116 @@ +--- +id: beta-access-item-owner-dto +title: AccessItemOwnerDto +pagination_label: AccessItemOwnerDto +sidebar_label: AccessItemOwnerDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemOwnerDto', 'BetaAccessItemOwnerDto'] +slug: /tools/sdk/go/beta/models/access-item-owner-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemOwnerDto', 'BetaAccessItemOwnerDto'] +--- + +# AccessItemOwnerDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Access item owner's DTO type. | [optional] +**Id** | Pointer to **string** | Access item owner's identity ID. | [optional] +**Name** | Pointer to **string** | Access item owner's human-readable display name. | [optional] + +## Methods + +### NewAccessItemOwnerDto + +`func NewAccessItemOwnerDto() *AccessItemOwnerDto` + +NewAccessItemOwnerDto instantiates a new AccessItemOwnerDto 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 + +### NewAccessItemOwnerDtoWithDefaults + +`func NewAccessItemOwnerDtoWithDefaults() *AccessItemOwnerDto` + +NewAccessItemOwnerDtoWithDefaults instantiates a new AccessItemOwnerDto 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 + +### GetType + +`func (o *AccessItemOwnerDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemOwnerDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemOwnerDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemOwnerDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemOwnerDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemOwnerDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemOwnerDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemOwnerDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemOwnerDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemOwnerDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemOwnerDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemOwnerDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRef.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRef.md new file mode 100644 index 000000000..0abfe2497 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRef.md @@ -0,0 +1,90 @@ +--- +id: beta-access-item-ref +title: AccessItemRef +pagination_label: AccessItemRef +sidebar_label: AccessItemRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRef', 'BetaAccessItemRef'] +slug: /tools/sdk/go/beta/models/access-item-ref +tags: ['SDK', 'Software Development Kit', 'AccessItemRef', 'BetaAccessItemRef'] +--- + +# AccessItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the access item to retrieve the recommendation for. | [optional] +**Type** | Pointer to **string** | Access item's type. | [optional] + +## Methods + +### NewAccessItemRef + +`func NewAccessItemRef() *AccessItemRef` + +NewAccessItemRef instantiates a new AccessItemRef 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 + +### NewAccessItemRefWithDefaults + +`func NewAccessItemRefWithDefaults() *AccessItemRef` + +NewAccessItemRefWithDefaults instantiates a new AccessItemRef 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 + +### GetId + +`func (o *AccessItemRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessItemRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRef) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRemoved.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRemoved.md new file mode 100644 index 000000000..9e014fdbf --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRemoved.md @@ -0,0 +1,168 @@ +--- +id: beta-access-item-removed +title: AccessItemRemoved +pagination_label: AccessItemRemoved +sidebar_label: AccessItemRemoved +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRemoved', 'BetaAccessItemRemoved'] +slug: /tools/sdk/go/beta/models/access-item-removed +tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'BetaAccessItemRemoved'] +--- + +# AccessItemRemoved + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] +**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] + +## Methods + +### NewAccessItemRemoved + +`func NewAccessItemRemoved() *AccessItemRemoved` + +NewAccessItemRemoved instantiates a new AccessItemRemoved 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 + +### NewAccessItemRemovedWithDefaults + +`func NewAccessItemRemovedWithDefaults() *AccessItemRemoved` + +NewAccessItemRemovedWithDefaults instantiates a new AccessItemRemoved 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 + +### GetAccessItem + +`func (o *AccessItemRemoved) GetAccessItem() AccessItemAssociatedAccessItem` + +GetAccessItem returns the AccessItem field if non-nil, zero value otherwise. + +### GetAccessItemOk + +`func (o *AccessItemRemoved) GetAccessItemOk() (*AccessItemAssociatedAccessItem, bool)` + +GetAccessItemOk returns a tuple with the AccessItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItem + +`func (o *AccessItemRemoved) SetAccessItem(v AccessItemAssociatedAccessItem)` + +SetAccessItem sets AccessItem field to given value. + +### HasAccessItem + +`func (o *AccessItemRemoved) HasAccessItem() bool` + +HasAccessItem returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *AccessItemRemoved) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessItemRemoved) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessItemRemoved) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccessItemRemoved) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEventType + +`func (o *AccessItemRemoved) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AccessItemRemoved) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AccessItemRemoved) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AccessItemRemoved) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDt + +`func (o *AccessItemRemoved) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *AccessItemRemoved) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *AccessItemRemoved) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *AccessItemRemoved) HasDt() bool` + +HasDt returns a boolean if a field has been set. + +### GetGovernanceEvent + +`func (o *AccessItemRemoved) GetGovernanceEvent() CorrelatedGovernanceEvent` + +GetGovernanceEvent returns the GovernanceEvent field if non-nil, zero value otherwise. + +### GetGovernanceEventOk + +`func (o *AccessItemRemoved) GetGovernanceEventOk() (*CorrelatedGovernanceEvent, bool)` + +GetGovernanceEventOk returns a tuple with the GovernanceEvent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceEvent + +`func (o *AccessItemRemoved) SetGovernanceEvent(v CorrelatedGovernanceEvent)` + +SetGovernanceEvent sets GovernanceEvent field to given value. + +### HasGovernanceEvent + +`func (o *AccessItemRemoved) HasGovernanceEvent() bool` + +HasGovernanceEvent returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRequestedForDto.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRequestedForDto.md new file mode 100644 index 000000000..74d8afd69 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRequestedForDto.md @@ -0,0 +1,116 @@ +--- +id: beta-access-item-requested-for-dto +title: AccessItemRequestedForDto +pagination_label: AccessItemRequestedForDto +sidebar_label: AccessItemRequestedForDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRequestedForDto', 'BetaAccessItemRequestedForDto'] +slug: /tools/sdk/go/beta/models/access-item-requested-for-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedForDto', 'BetaAccessItemRequestedForDto'] +--- + +# AccessItemRequestedForDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity the access item is requested for. | [optional] +**Id** | Pointer to **string** | ID of identity the access item is requested for. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity the access item is requested for. | [optional] + +## Methods + +### NewAccessItemRequestedForDto + +`func NewAccessItemRequestedForDto() *AccessItemRequestedForDto` + +NewAccessItemRequestedForDto instantiates a new AccessItemRequestedForDto 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 + +### NewAccessItemRequestedForDtoWithDefaults + +`func NewAccessItemRequestedForDtoWithDefaults() *AccessItemRequestedForDto` + +NewAccessItemRequestedForDtoWithDefaults instantiates a new AccessItemRequestedForDto 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 + +### GetType + +`func (o *AccessItemRequestedForDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRequestedForDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRequestedForDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRequestedForDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRequestedForDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRequestedForDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRequestedForDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRequestedForDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemRequestedForDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemRequestedForDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemRequestedForDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemRequestedForDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRequestedForDto1.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRequestedForDto1.md new file mode 100644 index 000000000..fb6d34a04 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRequestedForDto1.md @@ -0,0 +1,116 @@ +--- +id: beta-access-item-requested-for-dto1 +title: AccessItemRequestedForDto1 +pagination_label: AccessItemRequestedForDto1 +sidebar_label: AccessItemRequestedForDto1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRequestedForDto1', 'BetaAccessItemRequestedForDto1'] +slug: /tools/sdk/go/beta/models/access-item-requested-for-dto1 +tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedForDto1', 'BetaAccessItemRequestedForDto1'] +--- + +# AccessItemRequestedForDto1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of the identity whom the access item is requested for. | [optional] +**Id** | Pointer to **string** | ID of the identity whom the access item is requested for. | [optional] +**Name** | Pointer to **string** | Name of the identity whom the access item is requested for. | [optional] + +## Methods + +### NewAccessItemRequestedForDto1 + +`func NewAccessItemRequestedForDto1() *AccessItemRequestedForDto1` + +NewAccessItemRequestedForDto1 instantiates a new AccessItemRequestedForDto1 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 + +### NewAccessItemRequestedForDto1WithDefaults + +`func NewAccessItemRequestedForDto1WithDefaults() *AccessItemRequestedForDto1` + +NewAccessItemRequestedForDto1WithDefaults instantiates a new AccessItemRequestedForDto1 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 + +### GetType + +`func (o *AccessItemRequestedForDto1) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRequestedForDto1) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRequestedForDto1) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRequestedForDto1) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRequestedForDto1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRequestedForDto1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRequestedForDto1) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRequestedForDto1) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemRequestedForDto1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemRequestedForDto1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemRequestedForDto1) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemRequestedForDto1) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRequester.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRequester.md new file mode 100644 index 000000000..143e6c24c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRequester.md @@ -0,0 +1,116 @@ +--- +id: beta-access-item-requester +title: AccessItemRequester +pagination_label: AccessItemRequester +sidebar_label: AccessItemRequester +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRequester', 'BetaAccessItemRequester'] +slug: /tools/sdk/go/beta/models/access-item-requester +tags: ['SDK', 'Software Development Kit', 'AccessItemRequester', 'BetaAccessItemRequester'] +--- + +# AccessItemRequester + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Access item requester's DTO type. | [optional] +**Id** | Pointer to **string** | Access item requester's identity ID. | [optional] +**Name** | Pointer to **string** | Access item owner's human-readable display name. | [optional] + +## Methods + +### NewAccessItemRequester + +`func NewAccessItemRequester() *AccessItemRequester` + +NewAccessItemRequester instantiates a new AccessItemRequester 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 + +### NewAccessItemRequesterWithDefaults + +`func NewAccessItemRequesterWithDefaults() *AccessItemRequester` + +NewAccessItemRequesterWithDefaults instantiates a new AccessItemRequester 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 + +### GetType + +`func (o *AccessItemRequester) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRequester) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRequester) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRequester) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRequester) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRequester) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRequester) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRequester) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemRequester) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemRequester) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemRequester) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemRequester) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRequesterDto.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRequesterDto.md new file mode 100644 index 000000000..4f34be900 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRequesterDto.md @@ -0,0 +1,116 @@ +--- +id: beta-access-item-requester-dto +title: AccessItemRequesterDto +pagination_label: AccessItemRequesterDto +sidebar_label: AccessItemRequesterDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRequesterDto', 'BetaAccessItemRequesterDto'] +slug: /tools/sdk/go/beta/models/access-item-requester-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemRequesterDto', 'BetaAccessItemRequesterDto'] +--- + +# AccessItemRequesterDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Access item requester's DTO type. | [optional] +**Id** | Pointer to **string** | Access item requester's identity ID. | [optional] +**Name** | Pointer to **string** | Access item owner's human-readable display name. | [optional] + +## Methods + +### NewAccessItemRequesterDto + +`func NewAccessItemRequesterDto() *AccessItemRequesterDto` + +NewAccessItemRequesterDto instantiates a new AccessItemRequesterDto 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 + +### NewAccessItemRequesterDtoWithDefaults + +`func NewAccessItemRequesterDtoWithDefaults() *AccessItemRequesterDto` + +NewAccessItemRequesterDtoWithDefaults instantiates a new AccessItemRequesterDto 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 + +### GetType + +`func (o *AccessItemRequesterDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRequesterDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRequesterDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRequesterDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRequesterDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRequesterDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRequesterDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRequesterDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemRequesterDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemRequesterDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemRequesterDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemRequesterDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRequesterDto1.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRequesterDto1.md new file mode 100644 index 000000000..cf7891a33 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRequesterDto1.md @@ -0,0 +1,116 @@ +--- +id: beta-access-item-requester-dto1 +title: AccessItemRequesterDto1 +pagination_label: AccessItemRequesterDto1 +sidebar_label: AccessItemRequesterDto1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRequesterDto1', 'BetaAccessItemRequesterDto1'] +slug: /tools/sdk/go/beta/models/access-item-requester-dto1 +tags: ['SDK', 'Software Development Kit', 'AccessItemRequesterDto1', 'BetaAccessItemRequesterDto1'] +--- + +# AccessItemRequesterDto1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Access item requester's DTO type. | [optional] +**Id** | Pointer to **string** | Access item requester's identity ID. | [optional] +**Name** | Pointer to **string** | Access item requester's name. | [optional] + +## Methods + +### NewAccessItemRequesterDto1 + +`func NewAccessItemRequesterDto1() *AccessItemRequesterDto1` + +NewAccessItemRequesterDto1 instantiates a new AccessItemRequesterDto1 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 + +### NewAccessItemRequesterDto1WithDefaults + +`func NewAccessItemRequesterDto1WithDefaults() *AccessItemRequesterDto1` + +NewAccessItemRequesterDto1WithDefaults instantiates a new AccessItemRequesterDto1 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 + +### GetType + +`func (o *AccessItemRequesterDto1) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRequesterDto1) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRequesterDto1) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRequesterDto1) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRequesterDto1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRequesterDto1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRequesterDto1) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRequesterDto1) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemRequesterDto1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemRequesterDto1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemRequesterDto1) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemRequesterDto1) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemReviewedBy.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemReviewedBy.md new file mode 100644 index 000000000..730736e5b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemReviewedBy.md @@ -0,0 +1,116 @@ +--- +id: beta-access-item-reviewed-by +title: AccessItemReviewedBy +pagination_label: AccessItemReviewedBy +sidebar_label: AccessItemReviewedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemReviewedBy', 'BetaAccessItemReviewedBy'] +slug: /tools/sdk/go/beta/models/access-item-reviewed-by +tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy', 'BetaAccessItemReviewedBy'] +--- + +# AccessItemReviewedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity who reviewed the access item request. | [optional] +**Id** | Pointer to **string** | ID of identity who reviewed the access item request. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity who reviewed the access item request. | [optional] + +## Methods + +### NewAccessItemReviewedBy + +`func NewAccessItemReviewedBy() *AccessItemReviewedBy` + +NewAccessItemReviewedBy instantiates a new AccessItemReviewedBy 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 + +### NewAccessItemReviewedByWithDefaults + +`func NewAccessItemReviewedByWithDefaults() *AccessItemReviewedBy` + +NewAccessItemReviewedByWithDefaults instantiates a new AccessItemReviewedBy 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 + +### GetType + +`func (o *AccessItemReviewedBy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemReviewedBy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemReviewedBy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemReviewedBy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemReviewedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemReviewedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemReviewedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemReviewedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemReviewedBy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemReviewedBy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemReviewedBy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemReviewedBy) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRoleResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRoleResponse.md new file mode 100644 index 000000000..c418aa07c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessItemRoleResponse.md @@ -0,0 +1,215 @@ +--- +id: beta-access-item-role-response +title: AccessItemRoleResponse +pagination_label: AccessItemRoleResponse +sidebar_label: AccessItemRoleResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRoleResponse', 'BetaAccessItemRoleResponse'] +slug: /tools/sdk/go/beta/models/access-item-role-response +tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'BetaAccessItemRoleResponse'] +--- + +# AccessItemRoleResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. role in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**DisplayName** | Pointer to **string** | the role display name | [optional] +**Description** | Pointer to **string** | the description for the role | [optional] +**SourceName** | Pointer to **string** | the associated source name if it exists | [optional] +**RemoveDate** | Pointer to **string** | the date the role is no longer assigned to the specified identity | [optional] +**Revocable** | **bool** | indicates whether the role is revocable | + +## Methods + +### NewAccessItemRoleResponse + +`func NewAccessItemRoleResponse(revocable bool, ) *AccessItemRoleResponse` + +NewAccessItemRoleResponse instantiates a new AccessItemRoleResponse 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 + +### NewAccessItemRoleResponseWithDefaults + +`func NewAccessItemRoleResponseWithDefaults() *AccessItemRoleResponse` + +NewAccessItemRoleResponseWithDefaults instantiates a new AccessItemRoleResponse 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 + +### GetAccessType + +`func (o *AccessItemRoleResponse) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemRoleResponse) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemRoleResponse) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemRoleResponse) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRoleResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRoleResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRoleResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRoleResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemRoleResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemRoleResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemRoleResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemRoleResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessItemRoleResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessItemRoleResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessItemRoleResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessItemRoleResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemRoleResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemRoleResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemRoleResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemRoleResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *AccessItemRoleResponse) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccessItemRoleResponse) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccessItemRoleResponse) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccessItemRoleResponse) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetRevocable + +`func (o *AccessItemRoleResponse) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *AccessItemRoleResponse) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *AccessItemRoleResponse) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessProfile.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfile.md new file mode 100644 index 000000000..a3b21b051 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfile.md @@ -0,0 +1,447 @@ +--- +id: beta-access-profile +title: AccessProfile +pagination_label: AccessProfile +sidebar_label: AccessProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfile', 'BetaAccessProfile'] +slug: /tools/sdk/go/beta/models/access-profile +tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'BetaAccessProfile'] +--- + +# AccessProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Access profile ID. | [optional] [readonly] +**Name** | **string** | Access profile name. | +**Description** | Pointer to **NullableString** | Access profile description. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time when the access profile was created. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Date and time when the access profile was last modified. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to false] +**Owner** | [**OwnerReference**](owner-reference) | | +**Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | +**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**Requestable** | Pointer to **bool** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to true] +**AccessRequestConfig** | Pointer to [**NullableRequestability**](requestability) | | [optional] +**RevocationRequestConfig** | Pointer to [**NullableRevocability**](revocability) | | [optional] +**Segments** | Pointer to **[]string** | List of segment IDs, if any, that the access profile is assigned to. | [optional] +**ProvisioningCriteria** | Pointer to [**NullableProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] + +## Methods + +### NewAccessProfile + +`func NewAccessProfile(name string, owner OwnerReference, source AccessProfileSourceRef, ) *AccessProfile` + +NewAccessProfile instantiates a new AccessProfile 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 + +### NewAccessProfileWithDefaults + +`func NewAccessProfileWithDefaults() *AccessProfile` + +NewAccessProfileWithDefaults instantiates a new AccessProfile 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 + +### GetId + +`func (o *AccessProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfile) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *AccessProfile) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfile) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfile) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfile) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessProfile) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessProfile) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCreated + +`func (o *AccessProfile) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccessProfile) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccessProfile) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccessProfile) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *AccessProfile) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccessProfile) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccessProfile) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccessProfile) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetEnabled + +`func (o *AccessProfile) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AccessProfile) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AccessProfile) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *AccessProfile) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetOwner + +`func (o *AccessProfile) GetOwner() OwnerReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *AccessProfile) GetOwnerOk() (*OwnerReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *AccessProfile) SetOwner(v OwnerReference)` + +SetOwner sets Owner field to given value. + + +### GetSource + +`func (o *AccessProfile) GetSource() AccessProfileSourceRef` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccessProfile) GetSourceOk() (*AccessProfileSourceRef, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccessProfile) SetSource(v AccessProfileSourceRef)` + +SetSource sets Source field to given value. + + +### GetEntitlements + +`func (o *AccessProfile) GetEntitlements() []EntitlementRef` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *AccessProfile) GetEntitlementsOk() (*[]EntitlementRef, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *AccessProfile) SetEntitlements(v []EntitlementRef)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *AccessProfile) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### SetEntitlementsNil + +`func (o *AccessProfile) SetEntitlementsNil(b bool)` + + SetEntitlementsNil sets the value for Entitlements to be an explicit nil + +### UnsetEntitlements +`func (o *AccessProfile) UnsetEntitlements()` + +UnsetEntitlements ensures that no value is present for Entitlements, not even an explicit nil +### GetRequestable + +`func (o *AccessProfile) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *AccessProfile) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *AccessProfile) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *AccessProfile) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetAccessRequestConfig + +`func (o *AccessProfile) GetAccessRequestConfig() Requestability` + +GetAccessRequestConfig returns the AccessRequestConfig field if non-nil, zero value otherwise. + +### GetAccessRequestConfigOk + +`func (o *AccessProfile) GetAccessRequestConfigOk() (*Requestability, bool)` + +GetAccessRequestConfigOk returns a tuple with the AccessRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestConfig + +`func (o *AccessProfile) SetAccessRequestConfig(v Requestability)` + +SetAccessRequestConfig sets AccessRequestConfig field to given value. + +### HasAccessRequestConfig + +`func (o *AccessProfile) HasAccessRequestConfig() bool` + +HasAccessRequestConfig returns a boolean if a field has been set. + +### SetAccessRequestConfigNil + +`func (o *AccessProfile) SetAccessRequestConfigNil(b bool)` + + SetAccessRequestConfigNil sets the value for AccessRequestConfig to be an explicit nil + +### UnsetAccessRequestConfig +`func (o *AccessProfile) UnsetAccessRequestConfig()` + +UnsetAccessRequestConfig ensures that no value is present for AccessRequestConfig, not even an explicit nil +### GetRevocationRequestConfig + +`func (o *AccessProfile) GetRevocationRequestConfig() Revocability` + +GetRevocationRequestConfig returns the RevocationRequestConfig field if non-nil, zero value otherwise. + +### GetRevocationRequestConfigOk + +`func (o *AccessProfile) GetRevocationRequestConfigOk() (*Revocability, bool)` + +GetRevocationRequestConfigOk returns a tuple with the RevocationRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocationRequestConfig + +`func (o *AccessProfile) SetRevocationRequestConfig(v Revocability)` + +SetRevocationRequestConfig sets RevocationRequestConfig field to given value. + +### HasRevocationRequestConfig + +`func (o *AccessProfile) HasRevocationRequestConfig() bool` + +HasRevocationRequestConfig returns a boolean if a field has been set. + +### SetRevocationRequestConfigNil + +`func (o *AccessProfile) SetRevocationRequestConfigNil(b bool)` + + SetRevocationRequestConfigNil sets the value for RevocationRequestConfig to be an explicit nil + +### UnsetRevocationRequestConfig +`func (o *AccessProfile) UnsetRevocationRequestConfig()` + +UnsetRevocationRequestConfig ensures that no value is present for RevocationRequestConfig, not even an explicit nil +### GetSegments + +`func (o *AccessProfile) GetSegments() []string` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *AccessProfile) GetSegmentsOk() (*[]string, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *AccessProfile) SetSegments(v []string)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *AccessProfile) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### SetSegmentsNil + +`func (o *AccessProfile) SetSegmentsNil(b bool)` + + SetSegmentsNil sets the value for Segments to be an explicit nil + +### UnsetSegments +`func (o *AccessProfile) UnsetSegments()` + +UnsetSegments ensures that no value is present for Segments, not even an explicit nil +### GetProvisioningCriteria + +`func (o *AccessProfile) GetProvisioningCriteria() ProvisioningCriteriaLevel1` + +GetProvisioningCriteria returns the ProvisioningCriteria field if non-nil, zero value otherwise. + +### GetProvisioningCriteriaOk + +`func (o *AccessProfile) GetProvisioningCriteriaOk() (*ProvisioningCriteriaLevel1, bool)` + +GetProvisioningCriteriaOk returns a tuple with the ProvisioningCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningCriteria + +`func (o *AccessProfile) SetProvisioningCriteria(v ProvisioningCriteriaLevel1)` + +SetProvisioningCriteria sets ProvisioningCriteria field to given value. + +### HasProvisioningCriteria + +`func (o *AccessProfile) HasProvisioningCriteria() bool` + +HasProvisioningCriteria returns a boolean if a field has been set. + +### SetProvisioningCriteriaNil + +`func (o *AccessProfile) SetProvisioningCriteriaNil(b bool)` + + SetProvisioningCriteriaNil sets the value for ProvisioningCriteria to be an explicit nil + +### UnsetProvisioningCriteria +`func (o *AccessProfile) UnsetProvisioningCriteria()` + +UnsetProvisioningCriteria ensures that no value is present for ProvisioningCriteria, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileApprovalScheme.md new file mode 100644 index 000000000..6f8389c82 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileApprovalScheme.md @@ -0,0 +1,100 @@ +--- +id: beta-access-profile-approval-scheme +title: AccessProfileApprovalScheme +pagination_label: AccessProfileApprovalScheme +sidebar_label: AccessProfileApprovalScheme +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileApprovalScheme', 'BetaAccessProfileApprovalScheme'] +slug: /tools/sdk/go/beta/models/access-profile-approval-scheme +tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'BetaAccessProfileApprovalScheme'] +--- + +# AccessProfileApprovalScheme + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApproverType** | Pointer to **string** | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | Pointer to **NullableString** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] + +## Methods + +### NewAccessProfileApprovalScheme + +`func NewAccessProfileApprovalScheme() *AccessProfileApprovalScheme` + +NewAccessProfileApprovalScheme instantiates a new AccessProfileApprovalScheme 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 + +### NewAccessProfileApprovalSchemeWithDefaults + +`func NewAccessProfileApprovalSchemeWithDefaults() *AccessProfileApprovalScheme` + +NewAccessProfileApprovalSchemeWithDefaults instantiates a new AccessProfileApprovalScheme 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 + +### GetApproverType + +`func (o *AccessProfileApprovalScheme) GetApproverType() string` + +GetApproverType returns the ApproverType field if non-nil, zero value otherwise. + +### GetApproverTypeOk + +`func (o *AccessProfileApprovalScheme) GetApproverTypeOk() (*string, bool)` + +GetApproverTypeOk returns a tuple with the ApproverType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverType + +`func (o *AccessProfileApprovalScheme) SetApproverType(v string)` + +SetApproverType sets ApproverType field to given value. + +### HasApproverType + +`func (o *AccessProfileApprovalScheme) HasApproverType() bool` + +HasApproverType returns a boolean if a field has been set. + +### GetApproverId + +`func (o *AccessProfileApprovalScheme) GetApproverId() string` + +GetApproverId returns the ApproverId field if non-nil, zero value otherwise. + +### GetApproverIdOk + +`func (o *AccessProfileApprovalScheme) GetApproverIdOk() (*string, bool)` + +GetApproverIdOk returns a tuple with the ApproverId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverId + +`func (o *AccessProfileApprovalScheme) SetApproverId(v string)` + +SetApproverId sets ApproverId field to given value. + +### HasApproverId + +`func (o *AccessProfileApprovalScheme) HasApproverId() bool` + +HasApproverId returns a boolean if a field has been set. + +### SetApproverIdNil + +`func (o *AccessProfileApprovalScheme) SetApproverIdNil(b bool)` + + SetApproverIdNil sets the value for ApproverId to be an explicit nil + +### UnsetApproverId +`func (o *AccessProfileApprovalScheme) UnsetApproverId()` + +UnsetApproverId ensures that no value is present for ApproverId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileBulkDeleteRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileBulkDeleteRequest.md new file mode 100644 index 000000000..0bab42454 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileBulkDeleteRequest.md @@ -0,0 +1,90 @@ +--- +id: beta-access-profile-bulk-delete-request +title: AccessProfileBulkDeleteRequest +pagination_label: AccessProfileBulkDeleteRequest +sidebar_label: AccessProfileBulkDeleteRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileBulkDeleteRequest', 'BetaAccessProfileBulkDeleteRequest'] +slug: /tools/sdk/go/beta/models/access-profile-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest', 'BetaAccessProfileBulkDeleteRequest'] +--- + +# AccessProfileBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessProfileIds** | Pointer to **[]string** | List of IDs of Access Profiles to be deleted. | [optional] +**BestEffortOnly** | Pointer to **bool** | If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. | [optional] + +## Methods + +### NewAccessProfileBulkDeleteRequest + +`func NewAccessProfileBulkDeleteRequest() *AccessProfileBulkDeleteRequest` + +NewAccessProfileBulkDeleteRequest instantiates a new AccessProfileBulkDeleteRequest 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 + +### NewAccessProfileBulkDeleteRequestWithDefaults + +`func NewAccessProfileBulkDeleteRequestWithDefaults() *AccessProfileBulkDeleteRequest` + +NewAccessProfileBulkDeleteRequestWithDefaults instantiates a new AccessProfileBulkDeleteRequest 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 + +### GetAccessProfileIds + +`func (o *AccessProfileBulkDeleteRequest) GetAccessProfileIds() []string` + +GetAccessProfileIds returns the AccessProfileIds field if non-nil, zero value otherwise. + +### GetAccessProfileIdsOk + +`func (o *AccessProfileBulkDeleteRequest) GetAccessProfileIdsOk() (*[]string, bool)` + +GetAccessProfileIdsOk returns a tuple with the AccessProfileIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileIds + +`func (o *AccessProfileBulkDeleteRequest) SetAccessProfileIds(v []string)` + +SetAccessProfileIds sets AccessProfileIds field to given value. + +### HasAccessProfileIds + +`func (o *AccessProfileBulkDeleteRequest) HasAccessProfileIds() bool` + +HasAccessProfileIds returns a boolean if a field has been set. + +### GetBestEffortOnly + +`func (o *AccessProfileBulkDeleteRequest) GetBestEffortOnly() bool` + +GetBestEffortOnly returns the BestEffortOnly field if non-nil, zero value otherwise. + +### GetBestEffortOnlyOk + +`func (o *AccessProfileBulkDeleteRequest) GetBestEffortOnlyOk() (*bool, bool)` + +GetBestEffortOnlyOk returns a tuple with the BestEffortOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBestEffortOnly + +`func (o *AccessProfileBulkDeleteRequest) SetBestEffortOnly(v bool)` + +SetBestEffortOnly sets BestEffortOnly field to given value. + +### HasBestEffortOnly + +`func (o *AccessProfileBulkDeleteRequest) HasBestEffortOnly() bool` + +HasBestEffortOnly returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileBulkDeleteResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileBulkDeleteResponse.md new file mode 100644 index 000000000..08f0570ea --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileBulkDeleteResponse.md @@ -0,0 +1,116 @@ +--- +id: beta-access-profile-bulk-delete-response +title: AccessProfileBulkDeleteResponse +pagination_label: AccessProfileBulkDeleteResponse +sidebar_label: AccessProfileBulkDeleteResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileBulkDeleteResponse', 'BetaAccessProfileBulkDeleteResponse'] +slug: /tools/sdk/go/beta/models/access-profile-bulk-delete-response +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse', 'BetaAccessProfileBulkDeleteResponse'] +--- + +# AccessProfileBulkDeleteResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TaskId** | Pointer to **string** | ID of the task which is executing the bulk deletion. This can be passed to the **_/task-status** API to track status. | [optional] +**Pending** | Pointer to **[]string** | List of IDs of Access Profiles which are pending deletion. | [optional] +**InUse** | Pointer to [**[]AccessProfileUsage**](access-profile-usage) | List of usages of Access Profiles targeted for deletion. | [optional] + +## Methods + +### NewAccessProfileBulkDeleteResponse + +`func NewAccessProfileBulkDeleteResponse() *AccessProfileBulkDeleteResponse` + +NewAccessProfileBulkDeleteResponse instantiates a new AccessProfileBulkDeleteResponse 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 + +### NewAccessProfileBulkDeleteResponseWithDefaults + +`func NewAccessProfileBulkDeleteResponseWithDefaults() *AccessProfileBulkDeleteResponse` + +NewAccessProfileBulkDeleteResponseWithDefaults instantiates a new AccessProfileBulkDeleteResponse 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 + +### GetTaskId + +`func (o *AccessProfileBulkDeleteResponse) GetTaskId() string` + +GetTaskId returns the TaskId field if non-nil, zero value otherwise. + +### GetTaskIdOk + +`func (o *AccessProfileBulkDeleteResponse) GetTaskIdOk() (*string, bool)` + +GetTaskIdOk returns a tuple with the TaskId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskId + +`func (o *AccessProfileBulkDeleteResponse) SetTaskId(v string)` + +SetTaskId sets TaskId field to given value. + +### HasTaskId + +`func (o *AccessProfileBulkDeleteResponse) HasTaskId() bool` + +HasTaskId returns a boolean if a field has been set. + +### GetPending + +`func (o *AccessProfileBulkDeleteResponse) GetPending() []string` + +GetPending returns the Pending field if non-nil, zero value otherwise. + +### GetPendingOk + +`func (o *AccessProfileBulkDeleteResponse) GetPendingOk() (*[]string, bool)` + +GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPending + +`func (o *AccessProfileBulkDeleteResponse) SetPending(v []string)` + +SetPending sets Pending field to given value. + +### HasPending + +`func (o *AccessProfileBulkDeleteResponse) HasPending() bool` + +HasPending returns a boolean if a field has been set. + +### GetInUse + +`func (o *AccessProfileBulkDeleteResponse) GetInUse() []AccessProfileUsage` + +GetInUse returns the InUse field if non-nil, zero value otherwise. + +### GetInUseOk + +`func (o *AccessProfileBulkDeleteResponse) GetInUseOk() (*[]AccessProfileUsage, bool)` + +GetInUseOk returns a tuple with the InUse field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInUse + +`func (o *AccessProfileBulkDeleteResponse) SetInUse(v []AccessProfileUsage)` + +SetInUse sets InUse field to given value. + +### HasInUse + +`func (o *AccessProfileBulkDeleteResponse) HasInUse() bool` + +HasInUse returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileBulkUpdateRequestInner.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileBulkUpdateRequestInner.md new file mode 100644 index 000000000..7512efe9e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileBulkUpdateRequestInner.md @@ -0,0 +1,90 @@ +--- +id: beta-access-profile-bulk-update-request-inner +title: AccessProfileBulkUpdateRequestInner +pagination_label: AccessProfileBulkUpdateRequestInner +sidebar_label: AccessProfileBulkUpdateRequestInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileBulkUpdateRequestInner', 'BetaAccessProfileBulkUpdateRequestInner'] +slug: /tools/sdk/go/beta/models/access-profile-bulk-update-request-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkUpdateRequestInner', 'BetaAccessProfileBulkUpdateRequestInner'] +--- + +# AccessProfileBulkUpdateRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Access Profile ID. | [optional] +**Requestable** | Pointer to **bool** | Access Profile is requestable or not. | [optional] + +## Methods + +### NewAccessProfileBulkUpdateRequestInner + +`func NewAccessProfileBulkUpdateRequestInner() *AccessProfileBulkUpdateRequestInner` + +NewAccessProfileBulkUpdateRequestInner instantiates a new AccessProfileBulkUpdateRequestInner 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 + +### NewAccessProfileBulkUpdateRequestInnerWithDefaults + +`func NewAccessProfileBulkUpdateRequestInnerWithDefaults() *AccessProfileBulkUpdateRequestInner` + +NewAccessProfileBulkUpdateRequestInnerWithDefaults instantiates a new AccessProfileBulkUpdateRequestInner 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 + +### GetId + +`func (o *AccessProfileBulkUpdateRequestInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileBulkUpdateRequestInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileBulkUpdateRequestInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileBulkUpdateRequestInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRequestable + +`func (o *AccessProfileBulkUpdateRequestInner) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *AccessProfileBulkUpdateRequestInner) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *AccessProfileBulkUpdateRequestInner) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *AccessProfileBulkUpdateRequestInner) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileDetails.md new file mode 100644 index 000000000..59e728737 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileDetails.md @@ -0,0 +1,676 @@ +--- +id: beta-access-profile-details +title: AccessProfileDetails +pagination_label: AccessProfileDetails +sidebar_label: AccessProfileDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileDetails', 'BetaAccessProfileDetails'] +slug: /tools/sdk/go/beta/models/access-profile-details +tags: ['SDK', 'Software Development Kit', 'AccessProfileDetails', 'BetaAccessProfileDetails'] +--- + +# AccessProfileDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the Access Profile | [optional] +**Name** | Pointer to **string** | Name of the Access Profile | [optional] +**Description** | Pointer to **NullableString** | Information about the Access Profile | [optional] +**Created** | Pointer to **SailPointTime** | Date the Access Profile was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date the Access Profile was last modified. | [optional] +**Disabled** | Pointer to **bool** | Whether the Access Profile is enabled. | [optional] [default to true] +**Requestable** | Pointer to **bool** | Whether the Access Profile is requestable via access request. | [optional] [default to false] +**Protected** | Pointer to **bool** | Whether the Access Profile is protected. | [optional] [default to false] +**OwnerId** | Pointer to **string** | The owner ID of the Access Profile | [optional] +**SourceId** | Pointer to **NullableInt64** | The source ID of the Access Profile | [optional] +**SourceName** | Pointer to **string** | The source name of the Access Profile | [optional] +**AppId** | Pointer to **NullableInt64** | The source app ID of the Access Profile | [optional] +**AppName** | Pointer to **NullableString** | The source app name of the Access Profile | [optional] +**ApplicationId** | Pointer to **string** | The id of the application | [optional] +**Type** | Pointer to **string** | The type of the access profile | [optional] +**Entitlements** | Pointer to **[]string** | List of IDs of entitlements | [optional] +**EntitlementCount** | Pointer to **int32** | The number of entitlements in the access profile | [optional] +**Segments** | Pointer to **[]string** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**ApprovalSchemes** | Pointer to **string** | Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional] +**RevokeRequestApprovalSchemes** | Pointer to **string** | Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional] +**RequestCommentsRequired** | Pointer to **bool** | Whether the access profile require request comment for access request. | [optional] [default to false] +**DeniedCommentsRequired** | Pointer to **bool** | Whether denied comment is required when access request is denied. | [optional] [default to false] +**AccountSelector** | Pointer to [**AccessProfileDetailsAccountSelector**](access-profile-details-account-selector) | | [optional] + +## Methods + +### NewAccessProfileDetails + +`func NewAccessProfileDetails() *AccessProfileDetails` + +NewAccessProfileDetails instantiates a new AccessProfileDetails 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 + +### NewAccessProfileDetailsWithDefaults + +`func NewAccessProfileDetailsWithDefaults() *AccessProfileDetails` + +NewAccessProfileDetailsWithDefaults instantiates a new AccessProfileDetails 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 + +### GetId + +`func (o *AccessProfileDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessProfileDetails) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileDetails) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileDetails) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileDetails) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessProfileDetails) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessProfileDetails) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCreated + +`func (o *AccessProfileDetails) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccessProfileDetails) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccessProfileDetails) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccessProfileDetails) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *AccessProfileDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccessProfileDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccessProfileDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccessProfileDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDisabled + +`func (o *AccessProfileDetails) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *AccessProfileDetails) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *AccessProfileDetails) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *AccessProfileDetails) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetRequestable + +`func (o *AccessProfileDetails) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *AccessProfileDetails) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *AccessProfileDetails) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *AccessProfileDetails) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetProtected + +`func (o *AccessProfileDetails) GetProtected() bool` + +GetProtected returns the Protected field if non-nil, zero value otherwise. + +### GetProtectedOk + +`func (o *AccessProfileDetails) GetProtectedOk() (*bool, bool)` + +GetProtectedOk returns a tuple with the Protected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProtected + +`func (o *AccessProfileDetails) SetProtected(v bool)` + +SetProtected sets Protected field to given value. + +### HasProtected + +`func (o *AccessProfileDetails) HasProtected() bool` + +HasProtected returns a boolean if a field has been set. + +### GetOwnerId + +`func (o *AccessProfileDetails) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *AccessProfileDetails) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *AccessProfileDetails) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *AccessProfileDetails) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessProfileDetails) GetSourceId() int64` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessProfileDetails) GetSourceIdOk() (*int64, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessProfileDetails) SetSourceId(v int64)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessProfileDetails) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### SetSourceIdNil + +`func (o *AccessProfileDetails) SetSourceIdNil(b bool)` + + SetSourceIdNil sets the value for SourceId to be an explicit nil + +### UnsetSourceId +`func (o *AccessProfileDetails) UnsetSourceId()` + +UnsetSourceId ensures that no value is present for SourceId, not even an explicit nil +### GetSourceName + +`func (o *AccessProfileDetails) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessProfileDetails) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessProfileDetails) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessProfileDetails) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetAppId + +`func (o *AccessProfileDetails) GetAppId() int64` + +GetAppId returns the AppId field if non-nil, zero value otherwise. + +### GetAppIdOk + +`func (o *AccessProfileDetails) GetAppIdOk() (*int64, bool)` + +GetAppIdOk returns a tuple with the AppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppId + +`func (o *AccessProfileDetails) SetAppId(v int64)` + +SetAppId sets AppId field to given value. + +### HasAppId + +`func (o *AccessProfileDetails) HasAppId() bool` + +HasAppId returns a boolean if a field has been set. + +### SetAppIdNil + +`func (o *AccessProfileDetails) SetAppIdNil(b bool)` + + SetAppIdNil sets the value for AppId to be an explicit nil + +### UnsetAppId +`func (o *AccessProfileDetails) UnsetAppId()` + +UnsetAppId ensures that no value is present for AppId, not even an explicit nil +### GetAppName + +`func (o *AccessProfileDetails) GetAppName() string` + +GetAppName returns the AppName field if non-nil, zero value otherwise. + +### GetAppNameOk + +`func (o *AccessProfileDetails) GetAppNameOk() (*string, bool)` + +GetAppNameOk returns a tuple with the AppName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppName + +`func (o *AccessProfileDetails) SetAppName(v string)` + +SetAppName sets AppName field to given value. + +### HasAppName + +`func (o *AccessProfileDetails) HasAppName() bool` + +HasAppName returns a boolean if a field has been set. + +### SetAppNameNil + +`func (o *AccessProfileDetails) SetAppNameNil(b bool)` + + SetAppNameNil sets the value for AppName to be an explicit nil + +### UnsetAppName +`func (o *AccessProfileDetails) UnsetAppName()` + +UnsetAppName ensures that no value is present for AppName, not even an explicit nil +### GetApplicationId + +`func (o *AccessProfileDetails) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *AccessProfileDetails) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *AccessProfileDetails) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *AccessProfileDetails) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessProfileDetails) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileDetails) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileDetails) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileDetails) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetEntitlements + +`func (o *AccessProfileDetails) GetEntitlements() []string` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *AccessProfileDetails) GetEntitlementsOk() (*[]string, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *AccessProfileDetails) SetEntitlements(v []string)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *AccessProfileDetails) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccessProfileDetails) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccessProfileDetails) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccessProfileDetails) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccessProfileDetails) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetSegments + +`func (o *AccessProfileDetails) GetSegments() []string` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *AccessProfileDetails) GetSegmentsOk() (*[]string, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *AccessProfileDetails) SetSegments(v []string)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *AccessProfileDetails) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### GetApprovalSchemes + +`func (o *AccessProfileDetails) GetApprovalSchemes() string` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *AccessProfileDetails) GetApprovalSchemesOk() (*string, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *AccessProfileDetails) SetApprovalSchemes(v string)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *AccessProfileDetails) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + +### GetRevokeRequestApprovalSchemes + +`func (o *AccessProfileDetails) GetRevokeRequestApprovalSchemes() string` + +GetRevokeRequestApprovalSchemes returns the RevokeRequestApprovalSchemes field if non-nil, zero value otherwise. + +### GetRevokeRequestApprovalSchemesOk + +`func (o *AccessProfileDetails) GetRevokeRequestApprovalSchemesOk() (*string, bool)` + +GetRevokeRequestApprovalSchemesOk returns a tuple with the RevokeRequestApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevokeRequestApprovalSchemes + +`func (o *AccessProfileDetails) SetRevokeRequestApprovalSchemes(v string)` + +SetRevokeRequestApprovalSchemes sets RevokeRequestApprovalSchemes field to given value. + +### HasRevokeRequestApprovalSchemes + +`func (o *AccessProfileDetails) HasRevokeRequestApprovalSchemes() bool` + +HasRevokeRequestApprovalSchemes returns a boolean if a field has been set. + +### GetRequestCommentsRequired + +`func (o *AccessProfileDetails) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *AccessProfileDetails) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *AccessProfileDetails) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *AccessProfileDetails) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + +### GetDeniedCommentsRequired + +`func (o *AccessProfileDetails) GetDeniedCommentsRequired() bool` + +GetDeniedCommentsRequired returns the DeniedCommentsRequired field if non-nil, zero value otherwise. + +### GetDeniedCommentsRequiredOk + +`func (o *AccessProfileDetails) GetDeniedCommentsRequiredOk() (*bool, bool)` + +GetDeniedCommentsRequiredOk returns a tuple with the DeniedCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeniedCommentsRequired + +`func (o *AccessProfileDetails) SetDeniedCommentsRequired(v bool)` + +SetDeniedCommentsRequired sets DeniedCommentsRequired field to given value. + +### HasDeniedCommentsRequired + +`func (o *AccessProfileDetails) HasDeniedCommentsRequired() bool` + +HasDeniedCommentsRequired returns a boolean if a field has been set. + +### GetAccountSelector + +`func (o *AccessProfileDetails) GetAccountSelector() AccessProfileDetailsAccountSelector` + +GetAccountSelector returns the AccountSelector field if non-nil, zero value otherwise. + +### GetAccountSelectorOk + +`func (o *AccessProfileDetails) GetAccountSelectorOk() (*AccessProfileDetailsAccountSelector, bool)` + +GetAccountSelectorOk returns a tuple with the AccountSelector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSelector + +`func (o *AccessProfileDetails) SetAccountSelector(v AccessProfileDetailsAccountSelector)` + +SetAccountSelector sets AccountSelector field to given value. + +### HasAccountSelector + +`func (o *AccessProfileDetails) HasAccountSelector() bool` + +HasAccountSelector returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileDetailsAccountSelector.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileDetailsAccountSelector.md new file mode 100644 index 000000000..af11f68dd --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileDetailsAccountSelector.md @@ -0,0 +1,74 @@ +--- +id: beta-access-profile-details-account-selector +title: AccessProfileDetailsAccountSelector +pagination_label: AccessProfileDetailsAccountSelector +sidebar_label: AccessProfileDetailsAccountSelector +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileDetailsAccountSelector', 'BetaAccessProfileDetailsAccountSelector'] +slug: /tools/sdk/go/beta/models/access-profile-details-account-selector +tags: ['SDK', 'Software Development Kit', 'AccessProfileDetailsAccountSelector', 'BetaAccessProfileDetailsAccountSelector'] +--- + +# AccessProfileDetailsAccountSelector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Selectors** | Pointer to [**[]Selector**](selector) | | [optional] + +## Methods + +### NewAccessProfileDetailsAccountSelector + +`func NewAccessProfileDetailsAccountSelector() *AccessProfileDetailsAccountSelector` + +NewAccessProfileDetailsAccountSelector instantiates a new AccessProfileDetailsAccountSelector 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 + +### NewAccessProfileDetailsAccountSelectorWithDefaults + +`func NewAccessProfileDetailsAccountSelectorWithDefaults() *AccessProfileDetailsAccountSelector` + +NewAccessProfileDetailsAccountSelectorWithDefaults instantiates a new AccessProfileDetailsAccountSelector 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 + +### GetSelectors + +`func (o *AccessProfileDetailsAccountSelector) GetSelectors() []Selector` + +GetSelectors returns the Selectors field if non-nil, zero value otherwise. + +### GetSelectorsOk + +`func (o *AccessProfileDetailsAccountSelector) GetSelectorsOk() (*[]Selector, bool)` + +GetSelectorsOk returns a tuple with the Selectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectors + +`func (o *AccessProfileDetailsAccountSelector) SetSelectors(v []Selector)` + +SetSelectors sets Selectors field to given value. + +### HasSelectors + +`func (o *AccessProfileDetailsAccountSelector) HasSelectors() bool` + +HasSelectors returns a boolean if a field has been set. + +### SetSelectorsNil + +`func (o *AccessProfileDetailsAccountSelector) SetSelectorsNil(b bool)` + + SetSelectorsNil sets the value for Selectors to be an explicit nil + +### UnsetSelectors +`func (o *AccessProfileDetailsAccountSelector) UnsetSelectors()` + +UnsetSelectors ensures that no value is present for Selectors, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileRef.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileRef.md new file mode 100644 index 000000000..491618ae2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileRef.md @@ -0,0 +1,116 @@ +--- +id: beta-access-profile-ref +title: AccessProfileRef +pagination_label: AccessProfileRef +sidebar_label: AccessProfileRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileRef', 'BetaAccessProfileRef'] +slug: /tools/sdk/go/beta/models/access-profile-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'BetaAccessProfileRef'] +--- + +# AccessProfileRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the Access Profile | [optional] +**Type** | Pointer to **string** | Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result. | [optional] +**Name** | Pointer to **string** | Human-readable display name of the Access Profile. This field is ignored on input. | [optional] + +## Methods + +### NewAccessProfileRef + +`func NewAccessProfileRef() *AccessProfileRef` + +NewAccessProfileRef instantiates a new AccessProfileRef 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 + +### NewAccessProfileRefWithDefaults + +`func NewAccessProfileRefWithDefaults() *AccessProfileRef` + +NewAccessProfileRefWithDefaults instantiates a new AccessProfileRef 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 + +### GetId + +`func (o *AccessProfileRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessProfileRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileSourceRef.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileSourceRef.md new file mode 100644 index 000000000..301922f09 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileSourceRef.md @@ -0,0 +1,116 @@ +--- +id: beta-access-profile-source-ref +title: AccessProfileSourceRef +pagination_label: AccessProfileSourceRef +sidebar_label: AccessProfileSourceRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileSourceRef', 'BetaAccessProfileSourceRef'] +slug: /tools/sdk/go/beta/models/access-profile-source-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'BetaAccessProfileSourceRef'] +--- + +# AccessProfileSourceRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the source the access profile is associated with. | [optional] +**Type** | Pointer to **string** | Source's DTO type. | [optional] +**Name** | Pointer to **string** | Source name. | [optional] + +## Methods + +### NewAccessProfileSourceRef + +`func NewAccessProfileSourceRef() *AccessProfileSourceRef` + +NewAccessProfileSourceRef instantiates a new AccessProfileSourceRef 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 + +### NewAccessProfileSourceRefWithDefaults + +`func NewAccessProfileSourceRefWithDefaults() *AccessProfileSourceRef` + +NewAccessProfileSourceRefWithDefaults instantiates a new AccessProfileSourceRef 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 + +### GetId + +`func (o *AccessProfileSourceRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileSourceRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileSourceRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileSourceRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessProfileSourceRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileSourceRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileSourceRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileSourceRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileSourceRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileSourceRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileSourceRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileSourceRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileUpdateItem.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileUpdateItem.md new file mode 100644 index 000000000..37b172bba --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileUpdateItem.md @@ -0,0 +1,127 @@ +--- +id: beta-access-profile-update-item +title: AccessProfileUpdateItem +pagination_label: AccessProfileUpdateItem +sidebar_label: AccessProfileUpdateItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileUpdateItem', 'BetaAccessProfileUpdateItem'] +slug: /tools/sdk/go/beta/models/access-profile-update-item +tags: ['SDK', 'Software Development Kit', 'AccessProfileUpdateItem', 'BetaAccessProfileUpdateItem'] +--- + +# AccessProfileUpdateItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Identifier of Access Profile in bulk update request. | +**Requestable** | **bool** | Access Profile requestable or not. | +**Status** | **string** | The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. | +**Description** | Pointer to **string** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Methods + +### NewAccessProfileUpdateItem + +`func NewAccessProfileUpdateItem(id string, requestable bool, status string, ) *AccessProfileUpdateItem` + +NewAccessProfileUpdateItem instantiates a new AccessProfileUpdateItem 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 + +### NewAccessProfileUpdateItemWithDefaults + +`func NewAccessProfileUpdateItemWithDefaults() *AccessProfileUpdateItem` + +NewAccessProfileUpdateItemWithDefaults instantiates a new AccessProfileUpdateItem 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 + +### GetId + +`func (o *AccessProfileUpdateItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileUpdateItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileUpdateItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetRequestable + +`func (o *AccessProfileUpdateItem) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *AccessProfileUpdateItem) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *AccessProfileUpdateItem) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + + +### GetStatus + +`func (o *AccessProfileUpdateItem) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccessProfileUpdateItem) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccessProfileUpdateItem) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetDescription + +`func (o *AccessProfileUpdateItem) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileUpdateItem) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileUpdateItem) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileUpdateItem) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileUsage.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileUsage.md new file mode 100644 index 000000000..c5ef95b42 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileUsage.md @@ -0,0 +1,90 @@ +--- +id: beta-access-profile-usage +title: AccessProfileUsage +pagination_label: AccessProfileUsage +sidebar_label: AccessProfileUsage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileUsage', 'BetaAccessProfileUsage'] +slug: /tools/sdk/go/beta/models/access-profile-usage +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'BetaAccessProfileUsage'] +--- + +# AccessProfileUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessProfileId** | Pointer to **string** | ID of the Access Profile that is in use | [optional] +**UsedBy** | Pointer to [**[]AccessProfileUsageUsedByInner**](access-profile-usage-used-by-inner) | List of references to objects which are using the indicated Access Profile | [optional] + +## Methods + +### NewAccessProfileUsage + +`func NewAccessProfileUsage() *AccessProfileUsage` + +NewAccessProfileUsage instantiates a new AccessProfileUsage 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 + +### NewAccessProfileUsageWithDefaults + +`func NewAccessProfileUsageWithDefaults() *AccessProfileUsage` + +NewAccessProfileUsageWithDefaults instantiates a new AccessProfileUsage 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 + +### GetAccessProfileId + +`func (o *AccessProfileUsage) GetAccessProfileId() string` + +GetAccessProfileId returns the AccessProfileId field if non-nil, zero value otherwise. + +### GetAccessProfileIdOk + +`func (o *AccessProfileUsage) GetAccessProfileIdOk() (*string, bool)` + +GetAccessProfileIdOk returns a tuple with the AccessProfileId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileId + +`func (o *AccessProfileUsage) SetAccessProfileId(v string)` + +SetAccessProfileId sets AccessProfileId field to given value. + +### HasAccessProfileId + +`func (o *AccessProfileUsage) HasAccessProfileId() bool` + +HasAccessProfileId returns a boolean if a field has been set. + +### GetUsedBy + +`func (o *AccessProfileUsage) GetUsedBy() []AccessProfileUsageUsedByInner` + +GetUsedBy returns the UsedBy field if non-nil, zero value otherwise. + +### GetUsedByOk + +`func (o *AccessProfileUsage) GetUsedByOk() (*[]AccessProfileUsageUsedByInner, bool)` + +GetUsedByOk returns a tuple with the UsedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsedBy + +`func (o *AccessProfileUsage) SetUsedBy(v []AccessProfileUsageUsedByInner)` + +SetUsedBy sets UsedBy field to given value. + +### HasUsedBy + +`func (o *AccessProfileUsage) HasUsedBy() bool` + +HasUsedBy returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileUsageUsedByInner.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileUsageUsedByInner.md new file mode 100644 index 000000000..55638bcc4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessProfileUsageUsedByInner.md @@ -0,0 +1,116 @@ +--- +id: beta-access-profile-usage-used-by-inner +title: AccessProfileUsageUsedByInner +pagination_label: AccessProfileUsageUsedByInner +sidebar_label: AccessProfileUsageUsedByInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileUsageUsedByInner', 'BetaAccessProfileUsageUsedByInner'] +slug: /tools/sdk/go/beta/models/access-profile-usage-used-by-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner', 'BetaAccessProfileUsageUsedByInner'] +--- + +# AccessProfileUsageUsedByInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of role using the access profile. | [optional] +**Id** | Pointer to **string** | ID of role using the access profile. | [optional] +**Name** | Pointer to **string** | Display name of role using the access profile. | [optional] + +## Methods + +### NewAccessProfileUsageUsedByInner + +`func NewAccessProfileUsageUsedByInner() *AccessProfileUsageUsedByInner` + +NewAccessProfileUsageUsedByInner instantiates a new AccessProfileUsageUsedByInner 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 + +### NewAccessProfileUsageUsedByInnerWithDefaults + +`func NewAccessProfileUsageUsedByInnerWithDefaults() *AccessProfileUsageUsedByInner` + +NewAccessProfileUsageUsedByInnerWithDefaults instantiates a new AccessProfileUsageUsedByInner 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 + +### GetType + +`func (o *AccessProfileUsageUsedByInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileUsageUsedByInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileUsageUsedByInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileUsageUsedByInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessProfileUsageUsedByInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileUsageUsedByInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileUsageUsedByInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileUsageUsedByInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileUsageUsedByInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileUsageUsedByInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileUsageUsedByInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileUsageUsedByInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRecommendationMessage.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRecommendationMessage.md new file mode 100644 index 000000000..6814a906a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRecommendationMessage.md @@ -0,0 +1,64 @@ +--- +id: beta-access-recommendation-message +title: AccessRecommendationMessage +pagination_label: AccessRecommendationMessage +sidebar_label: AccessRecommendationMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRecommendationMessage', 'BetaAccessRecommendationMessage'] +slug: /tools/sdk/go/beta/models/access-recommendation-message +tags: ['SDK', 'Software Development Kit', 'AccessRecommendationMessage', 'BetaAccessRecommendationMessage'] +--- + +# AccessRecommendationMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Interpretation** | Pointer to **string** | Information about why the access item was recommended. | [optional] + +## Methods + +### NewAccessRecommendationMessage + +`func NewAccessRecommendationMessage() *AccessRecommendationMessage` + +NewAccessRecommendationMessage instantiates a new AccessRecommendationMessage 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 + +### NewAccessRecommendationMessageWithDefaults + +`func NewAccessRecommendationMessageWithDefaults() *AccessRecommendationMessage` + +NewAccessRecommendationMessageWithDefaults instantiates a new AccessRecommendationMessage 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 + +### GetInterpretation + +`func (o *AccessRecommendationMessage) GetInterpretation() string` + +GetInterpretation returns the Interpretation field if non-nil, zero value otherwise. + +### GetInterpretationOk + +`func (o *AccessRecommendationMessage) GetInterpretationOk() (*string, bool)` + +GetInterpretationOk returns a tuple with the Interpretation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterpretation + +`func (o *AccessRecommendationMessage) SetInterpretation(v string)` + +SetInterpretation sets Interpretation field to given value. + +### HasInterpretation + +`func (o *AccessRecommendationMessage) HasInterpretation() bool` + +HasInterpretation returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequest.md new file mode 100644 index 000000000..1c1d003e0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequest.md @@ -0,0 +1,178 @@ +--- +id: beta-access-request +title: AccessRequest +pagination_label: AccessRequest +sidebar_label: AccessRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequest', 'BetaAccessRequest'] +slug: /tools/sdk/go/beta/models/access-request +tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'BetaAccessRequest'] +--- + +# AccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedFor** | **[]string** | A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. | +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**RequestedForWithRequestedItems** | Pointer to [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] + +## Methods + +### NewAccessRequest + +`func NewAccessRequest(requestedFor []string, requestedItems []AccessRequestItem, ) *AccessRequest` + +NewAccessRequest instantiates a new AccessRequest 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 + +### NewAccessRequestWithDefaults + +`func NewAccessRequestWithDefaults() *AccessRequest` + +NewAccessRequestWithDefaults instantiates a new AccessRequest 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 + +### GetRequestedFor + +`func (o *AccessRequest) GetRequestedFor() []string` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequest) GetRequestedForOk() (*[]string, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequest) SetRequestedFor(v []string)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestType + +`func (o *AccessRequest) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *AccessRequest) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *AccessRequest) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *AccessRequest) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *AccessRequest) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *AccessRequest) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetRequestedItems + +`func (o *AccessRequest) GetRequestedItems() []AccessRequestItem` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *AccessRequest) GetRequestedItemsOk() (*[]AccessRequestItem, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *AccessRequest) SetRequestedItems(v []AccessRequestItem)` + +SetRequestedItems sets RequestedItems field to given value. + + +### GetClientMetadata + +`func (o *AccessRequest) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccessRequest) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccessRequest) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccessRequest) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRequestedForWithRequestedItems + +`func (o *AccessRequest) GetRequestedForWithRequestedItems() []RequestedForDtoRef` + +GetRequestedForWithRequestedItems returns the RequestedForWithRequestedItems field if non-nil, zero value otherwise. + +### GetRequestedForWithRequestedItemsOk + +`func (o *AccessRequest) GetRequestedForWithRequestedItemsOk() (*[]RequestedForDtoRef, bool)` + +GetRequestedForWithRequestedItemsOk returns a tuple with the RequestedForWithRequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedForWithRequestedItems + +`func (o *AccessRequest) SetRequestedForWithRequestedItems(v []RequestedForDtoRef)` + +SetRequestedForWithRequestedItems sets RequestedForWithRequestedItems field to given value. + +### HasRequestedForWithRequestedItems + +`func (o *AccessRequest) HasRequestedForWithRequestedItems() bool` + +HasRequestedForWithRequestedItems returns a boolean if a field has been set. + +### SetRequestedForWithRequestedItemsNil + +`func (o *AccessRequest) SetRequestedForWithRequestedItemsNil(b bool)` + + SetRequestedForWithRequestedItemsNil sets the value for RequestedForWithRequestedItems to be an explicit nil + +### UnsetRequestedForWithRequestedItems +`func (o *AccessRequest) UnsetRequestedForWithRequestedItems()` + +UnsetRequestedForWithRequestedItems ensures that no value is present for RequestedForWithRequestedItems, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestConfig.md new file mode 100644 index 000000000..1a44a1f24 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestConfig.md @@ -0,0 +1,194 @@ +--- +id: beta-access-request-config +title: AccessRequestConfig +pagination_label: AccessRequestConfig +sidebar_label: AccessRequestConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestConfig', 'BetaAccessRequestConfig'] +slug: /tools/sdk/go/beta/models/access-request-config +tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig', 'BetaAccessRequestConfig'] +--- + +# AccessRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalsMustBeExternal** | Pointer to **bool** | If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin. | [optional] [default to false] +**AutoApprovalEnabled** | Pointer to **bool** | If this is true and the requester and reviewer are the same, the request is automatically approved. | [optional] [default to false] +**ReauthorizationEnabled** | Pointer to **bool** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to false] +**RequestOnBehalfOfConfig** | Pointer to [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional] +**ApprovalReminderAndEscalationConfig** | Pointer to [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional] +**EntitlementRequestConfig** | Pointer to [**EntitlementRequestConfig1**](entitlement-request-config1) | | [optional] + +## Methods + +### NewAccessRequestConfig + +`func NewAccessRequestConfig() *AccessRequestConfig` + +NewAccessRequestConfig instantiates a new AccessRequestConfig 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 + +### NewAccessRequestConfigWithDefaults + +`func NewAccessRequestConfigWithDefaults() *AccessRequestConfig` + +NewAccessRequestConfigWithDefaults instantiates a new AccessRequestConfig 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 + +### GetApprovalsMustBeExternal + +`func (o *AccessRequestConfig) GetApprovalsMustBeExternal() bool` + +GetApprovalsMustBeExternal returns the ApprovalsMustBeExternal field if non-nil, zero value otherwise. + +### GetApprovalsMustBeExternalOk + +`func (o *AccessRequestConfig) GetApprovalsMustBeExternalOk() (*bool, bool)` + +GetApprovalsMustBeExternalOk returns a tuple with the ApprovalsMustBeExternal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalsMustBeExternal + +`func (o *AccessRequestConfig) SetApprovalsMustBeExternal(v bool)` + +SetApprovalsMustBeExternal sets ApprovalsMustBeExternal field to given value. + +### HasApprovalsMustBeExternal + +`func (o *AccessRequestConfig) HasApprovalsMustBeExternal() bool` + +HasApprovalsMustBeExternal returns a boolean if a field has been set. + +### GetAutoApprovalEnabled + +`func (o *AccessRequestConfig) GetAutoApprovalEnabled() bool` + +GetAutoApprovalEnabled returns the AutoApprovalEnabled field if non-nil, zero value otherwise. + +### GetAutoApprovalEnabledOk + +`func (o *AccessRequestConfig) GetAutoApprovalEnabledOk() (*bool, bool)` + +GetAutoApprovalEnabledOk returns a tuple with the AutoApprovalEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoApprovalEnabled + +`func (o *AccessRequestConfig) SetAutoApprovalEnabled(v bool)` + +SetAutoApprovalEnabled sets AutoApprovalEnabled field to given value. + +### HasAutoApprovalEnabled + +`func (o *AccessRequestConfig) HasAutoApprovalEnabled() bool` + +HasAutoApprovalEnabled returns a boolean if a field has been set. + +### GetReauthorizationEnabled + +`func (o *AccessRequestConfig) GetReauthorizationEnabled() bool` + +GetReauthorizationEnabled returns the ReauthorizationEnabled field if non-nil, zero value otherwise. + +### GetReauthorizationEnabledOk + +`func (o *AccessRequestConfig) GetReauthorizationEnabledOk() (*bool, bool)` + +GetReauthorizationEnabledOk returns a tuple with the ReauthorizationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReauthorizationEnabled + +`func (o *AccessRequestConfig) SetReauthorizationEnabled(v bool)` + +SetReauthorizationEnabled sets ReauthorizationEnabled field to given value. + +### HasReauthorizationEnabled + +`func (o *AccessRequestConfig) HasReauthorizationEnabled() bool` + +HasReauthorizationEnabled returns a boolean if a field has been set. + +### GetRequestOnBehalfOfConfig + +`func (o *AccessRequestConfig) GetRequestOnBehalfOfConfig() RequestOnBehalfOfConfig` + +GetRequestOnBehalfOfConfig returns the RequestOnBehalfOfConfig field if non-nil, zero value otherwise. + +### GetRequestOnBehalfOfConfigOk + +`func (o *AccessRequestConfig) GetRequestOnBehalfOfConfigOk() (*RequestOnBehalfOfConfig, bool)` + +GetRequestOnBehalfOfConfigOk returns a tuple with the RequestOnBehalfOfConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestOnBehalfOfConfig + +`func (o *AccessRequestConfig) SetRequestOnBehalfOfConfig(v RequestOnBehalfOfConfig)` + +SetRequestOnBehalfOfConfig sets RequestOnBehalfOfConfig field to given value. + +### HasRequestOnBehalfOfConfig + +`func (o *AccessRequestConfig) HasRequestOnBehalfOfConfig() bool` + +HasRequestOnBehalfOfConfig returns a boolean if a field has been set. + +### GetApprovalReminderAndEscalationConfig + +`func (o *AccessRequestConfig) GetApprovalReminderAndEscalationConfig() ApprovalReminderAndEscalationConfig` + +GetApprovalReminderAndEscalationConfig returns the ApprovalReminderAndEscalationConfig field if non-nil, zero value otherwise. + +### GetApprovalReminderAndEscalationConfigOk + +`func (o *AccessRequestConfig) GetApprovalReminderAndEscalationConfigOk() (*ApprovalReminderAndEscalationConfig, bool)` + +GetApprovalReminderAndEscalationConfigOk returns a tuple with the ApprovalReminderAndEscalationConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalReminderAndEscalationConfig + +`func (o *AccessRequestConfig) SetApprovalReminderAndEscalationConfig(v ApprovalReminderAndEscalationConfig)` + +SetApprovalReminderAndEscalationConfig sets ApprovalReminderAndEscalationConfig field to given value. + +### HasApprovalReminderAndEscalationConfig + +`func (o *AccessRequestConfig) HasApprovalReminderAndEscalationConfig() bool` + +HasApprovalReminderAndEscalationConfig returns a boolean if a field has been set. + +### GetEntitlementRequestConfig + +`func (o *AccessRequestConfig) GetEntitlementRequestConfig() EntitlementRequestConfig1` + +GetEntitlementRequestConfig returns the EntitlementRequestConfig field if non-nil, zero value otherwise. + +### GetEntitlementRequestConfigOk + +`func (o *AccessRequestConfig) GetEntitlementRequestConfigOk() (*EntitlementRequestConfig1, bool)` + +GetEntitlementRequestConfigOk returns a tuple with the EntitlementRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementRequestConfig + +`func (o *AccessRequestConfig) SetEntitlementRequestConfig(v EntitlementRequestConfig1)` + +SetEntitlementRequestConfig sets EntitlementRequestConfig field to given value. + +### HasEntitlementRequestConfig + +`func (o *AccessRequestConfig) HasEntitlementRequestConfig() bool` + +HasEntitlementRequestConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestContext.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestContext.md new file mode 100644 index 000000000..1d93d03ad --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestContext.md @@ -0,0 +1,64 @@ +--- +id: beta-access-request-context +title: AccessRequestContext +pagination_label: AccessRequestContext +sidebar_label: AccessRequestContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestContext', 'BetaAccessRequestContext'] +slug: /tools/sdk/go/beta/models/access-request-context +tags: ['SDK', 'Software Development Kit', 'AccessRequestContext', 'BetaAccessRequestContext'] +--- + +# AccessRequestContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContextAttributes** | Pointer to [**[]ContextAttributeDto**](context-attribute-dto) | | [optional] + +## Methods + +### NewAccessRequestContext + +`func NewAccessRequestContext() *AccessRequestContext` + +NewAccessRequestContext instantiates a new AccessRequestContext 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 + +### NewAccessRequestContextWithDefaults + +`func NewAccessRequestContextWithDefaults() *AccessRequestContext` + +NewAccessRequestContextWithDefaults instantiates a new AccessRequestContext 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 + +### GetContextAttributes + +`func (o *AccessRequestContext) GetContextAttributes() []ContextAttributeDto` + +GetContextAttributes returns the ContextAttributes field if non-nil, zero value otherwise. + +### GetContextAttributesOk + +`func (o *AccessRequestContext) GetContextAttributesOk() (*[]ContextAttributeDto, bool)` + +GetContextAttributesOk returns a tuple with the ContextAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContextAttributes + +`func (o *AccessRequestContext) SetContextAttributes(v []ContextAttributeDto)` + +SetContextAttributes sets ContextAttributes field to given value. + +### HasContextAttributes + +`func (o *AccessRequestContext) HasContextAttributes() bool` + +HasContextAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestDynamicApprover.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestDynamicApprover.md new file mode 100644 index 000000000..af8b4d105 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestDynamicApprover.md @@ -0,0 +1,122 @@ +--- +id: beta-access-request-dynamic-approver +title: AccessRequestDynamicApprover +pagination_label: AccessRequestDynamicApprover +sidebar_label: AccessRequestDynamicApprover +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestDynamicApprover', 'BetaAccessRequestDynamicApprover'] +slug: /tools/sdk/go/beta/models/access-request-dynamic-approver +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover', 'BetaAccessRequestDynamicApprover'] +--- + +# AccessRequestDynamicApprover + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **string** | Unique ID of the access request object. You can use this ID with the [Access Request Status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the request's status. | +**RequestedFor** | [**[]AccessItemRequestedForDto1**](access-item-requested-for-dto1) | Identities access was requested for. | +**RequestedItems** | [**[]AccessRequestDynamicApproverRequestedItemsInner**](access-request-dynamic-approver-requested-items-inner) | Requested access items. | +**RequestedBy** | [**AccessItemRequesterDto1**](access-item-requester-dto1) | | + +## Methods + +### NewAccessRequestDynamicApprover + +`func NewAccessRequestDynamicApprover(accessRequestId string, requestedFor []AccessItemRequestedForDto1, requestedItems []AccessRequestDynamicApproverRequestedItemsInner, requestedBy AccessItemRequesterDto1, ) *AccessRequestDynamicApprover` + +NewAccessRequestDynamicApprover instantiates a new AccessRequestDynamicApprover 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 + +### NewAccessRequestDynamicApproverWithDefaults + +`func NewAccessRequestDynamicApproverWithDefaults() *AccessRequestDynamicApprover` + +NewAccessRequestDynamicApproverWithDefaults instantiates a new AccessRequestDynamicApprover 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 + +### GetAccessRequestId + +`func (o *AccessRequestDynamicApprover) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *AccessRequestDynamicApprover) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *AccessRequestDynamicApprover) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + + +### GetRequestedFor + +`func (o *AccessRequestDynamicApprover) GetRequestedFor() []AccessItemRequestedForDto1` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequestDynamicApprover) GetRequestedForOk() (*[]AccessItemRequestedForDto1, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequestDynamicApprover) SetRequestedFor(v []AccessItemRequestedForDto1)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestedItems + +`func (o *AccessRequestDynamicApprover) GetRequestedItems() []AccessRequestDynamicApproverRequestedItemsInner` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *AccessRequestDynamicApprover) GetRequestedItemsOk() (*[]AccessRequestDynamicApproverRequestedItemsInner, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *AccessRequestDynamicApprover) SetRequestedItems(v []AccessRequestDynamicApproverRequestedItemsInner)` + +SetRequestedItems sets RequestedItems field to given value. + + +### GetRequestedBy + +`func (o *AccessRequestDynamicApprover) GetRequestedBy() AccessItemRequesterDto1` + +GetRequestedBy returns the RequestedBy field if non-nil, zero value otherwise. + +### GetRequestedByOk + +`func (o *AccessRequestDynamicApprover) GetRequestedByOk() (*AccessItemRequesterDto1, bool)` + +GetRequestedByOk returns a tuple with the RequestedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedBy + +`func (o *AccessRequestDynamicApprover) SetRequestedBy(v AccessItemRequesterDto1)` + +SetRequestedBy sets RequestedBy field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestDynamicApprover1.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestDynamicApprover1.md new file mode 100644 index 000000000..8cf4452a7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestDynamicApprover1.md @@ -0,0 +1,101 @@ +--- +id: beta-access-request-dynamic-approver1 +title: AccessRequestDynamicApprover1 +pagination_label: AccessRequestDynamicApprover1 +sidebar_label: AccessRequestDynamicApprover1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestDynamicApprover1', 'BetaAccessRequestDynamicApprover1'] +slug: /tools/sdk/go/beta/models/access-request-dynamic-approver1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover1', 'BetaAccessRequestDynamicApprover1'] +--- + +# AccessRequestDynamicApprover1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the identity to add to the approver list for the access request. | +**Name** | **string** | The name of the identity to add to the approver list for the access request. | +**Type** | **map[string]interface{}** | The type of object being referenced. | + +## Methods + +### NewAccessRequestDynamicApprover1 + +`func NewAccessRequestDynamicApprover1(id string, name string, type_ map[string]interface{}, ) *AccessRequestDynamicApprover1` + +NewAccessRequestDynamicApprover1 instantiates a new AccessRequestDynamicApprover1 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 + +### NewAccessRequestDynamicApprover1WithDefaults + +`func NewAccessRequestDynamicApprover1WithDefaults() *AccessRequestDynamicApprover1` + +NewAccessRequestDynamicApprover1WithDefaults instantiates a new AccessRequestDynamicApprover1 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 + +### GetId + +`func (o *AccessRequestDynamicApprover1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestDynamicApprover1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestDynamicApprover1) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessRequestDynamicApprover1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestDynamicApprover1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestDynamicApprover1) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *AccessRequestDynamicApprover1) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestDynamicApprover1) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestDynamicApprover1) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestDynamicApproverRequestedItemsInner.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestDynamicApproverRequestedItemsInner.md new file mode 100644 index 000000000..b3dadd23c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestDynamicApproverRequestedItemsInner.md @@ -0,0 +1,194 @@ +--- +id: beta-access-request-dynamic-approver-requested-items-inner +title: AccessRequestDynamicApproverRequestedItemsInner +pagination_label: AccessRequestDynamicApproverRequestedItemsInner +sidebar_label: AccessRequestDynamicApproverRequestedItemsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestDynamicApproverRequestedItemsInner', 'BetaAccessRequestDynamicApproverRequestedItemsInner'] +slug: /tools/sdk/go/beta/models/access-request-dynamic-approver-requested-items-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApproverRequestedItemsInner', 'BetaAccessRequestDynamicApproverRequestedItemsInner'] +--- + +# AccessRequestDynamicApproverRequestedItemsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Access item's unique identifier. | +**Name** | **string** | Access item's name. | +**Description** | Pointer to **NullableString** | Access item's extended description. | [optional] +**Type** | **map[string]interface{}** | Type of access item being requested. | +**Operation** | **map[string]interface{}** | Action to perform on the requested access item. | +**Comment** | Pointer to **NullableString** | Comment from the requester about why the access is necessary. | [optional] + +## Methods + +### NewAccessRequestDynamicApproverRequestedItemsInner + +`func NewAccessRequestDynamicApproverRequestedItemsInner(id string, name string, type_ map[string]interface{}, operation map[string]interface{}, ) *AccessRequestDynamicApproverRequestedItemsInner` + +NewAccessRequestDynamicApproverRequestedItemsInner instantiates a new AccessRequestDynamicApproverRequestedItemsInner 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 + +### NewAccessRequestDynamicApproverRequestedItemsInnerWithDefaults + +`func NewAccessRequestDynamicApproverRequestedItemsInnerWithDefaults() *AccessRequestDynamicApproverRequestedItemsInner` + +NewAccessRequestDynamicApproverRequestedItemsInnerWithDefaults instantiates a new AccessRequestDynamicApproverRequestedItemsInner 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 + +### GetId + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessRequestDynamicApproverRequestedItemsInner) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetOperation + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetOperation() map[string]interface{}` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetOperationOk() (*map[string]interface{}, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetOperation(v map[string]interface{})` + +SetOperation sets Operation field to given value. + + +### GetComment + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *AccessRequestDynamicApproverRequestedItemsInner) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestItem.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestItem.md new file mode 100644 index 000000000..87c089333 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestItem.md @@ -0,0 +1,230 @@ +--- +id: beta-access-request-item +title: AccessRequestItem +pagination_label: AccessRequestItem +sidebar_label: AccessRequestItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestItem', 'BetaAccessRequestItem'] +slug: /tools/sdk/go/beta/models/access-request-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'BetaAccessRequestItem'] +--- + +# AccessRequestItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of the item being requested. | +**Id** | **string** | ID of Role, Access Profile or Entitlement being requested. | +**Comment** | Pointer to **string** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | Pointer to **SailPointTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | Pointer to **NullableString** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | Pointer to **NullableString** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] + +## Methods + +### NewAccessRequestItem + +`func NewAccessRequestItem(type_ string, id string, ) *AccessRequestItem` + +NewAccessRequestItem instantiates a new AccessRequestItem 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 + +### NewAccessRequestItemWithDefaults + +`func NewAccessRequestItemWithDefaults() *AccessRequestItem` + +NewAccessRequestItemWithDefaults instantiates a new AccessRequestItem 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 + +### GetType + +`func (o *AccessRequestItem) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestItem) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestItem) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccessRequestItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetComment + +`func (o *AccessRequestItem) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestItem) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestItem) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *AccessRequestItem) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *AccessRequestItem) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccessRequestItem) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccessRequestItem) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccessRequestItem) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *AccessRequestItem) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccessRequestItem) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccessRequestItem) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccessRequestItem) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetAssignmentId + +`func (o *AccessRequestItem) GetAssignmentId() string` + +GetAssignmentId returns the AssignmentId field if non-nil, zero value otherwise. + +### GetAssignmentIdOk + +`func (o *AccessRequestItem) GetAssignmentIdOk() (*string, bool)` + +GetAssignmentIdOk returns a tuple with the AssignmentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentId + +`func (o *AccessRequestItem) SetAssignmentId(v string)` + +SetAssignmentId sets AssignmentId field to given value. + +### HasAssignmentId + +`func (o *AccessRequestItem) HasAssignmentId() bool` + +HasAssignmentId returns a boolean if a field has been set. + +### SetAssignmentIdNil + +`func (o *AccessRequestItem) SetAssignmentIdNil(b bool)` + + SetAssignmentIdNil sets the value for AssignmentId to be an explicit nil + +### UnsetAssignmentId +`func (o *AccessRequestItem) UnsetAssignmentId()` + +UnsetAssignmentId ensures that no value is present for AssignmentId, not even an explicit nil +### GetNativeIdentity + +`func (o *AccessRequestItem) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccessRequestItem) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccessRequestItem) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccessRequestItem) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### SetNativeIdentityNil + +`func (o *AccessRequestItem) SetNativeIdentityNil(b bool)` + + SetNativeIdentityNil sets the value for NativeIdentity to be an explicit nil + +### UnsetNativeIdentity +`func (o *AccessRequestItem) UnsetNativeIdentity()` + +UnsetNativeIdentity ensures that no value is present for NativeIdentity, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestItemResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestItemResponse.md new file mode 100644 index 000000000..a45d204e2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestItemResponse.md @@ -0,0 +1,246 @@ +--- +id: beta-access-request-item-response +title: AccessRequestItemResponse +pagination_label: AccessRequestItemResponse +sidebar_label: AccessRequestItemResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestItemResponse', 'BetaAccessRequestItemResponse'] +slug: /tools/sdk/go/beta/models/access-request-item-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestItemResponse', 'BetaAccessRequestItemResponse'] +--- + +# AccessRequestItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to **string** | the access request item operation | [optional] +**AccessItemType** | Pointer to **string** | the access item type | [optional] +**Name** | Pointer to **string** | the name of access request item | [optional] +**Decision** | Pointer to **string** | the final decision for the access request | [optional] +**Description** | Pointer to **string** | the description of access request item | [optional] +**SourceId** | Pointer to **string** | the source id | [optional] +**SourceName** | Pointer to **string** | the source Name | [optional] +**ApprovalInfos** | Pointer to [**[]ApprovalInfoResponse**](approval-info-response) | | [optional] + +## Methods + +### NewAccessRequestItemResponse + +`func NewAccessRequestItemResponse() *AccessRequestItemResponse` + +NewAccessRequestItemResponse instantiates a new AccessRequestItemResponse 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 + +### NewAccessRequestItemResponseWithDefaults + +`func NewAccessRequestItemResponseWithDefaults() *AccessRequestItemResponse` + +NewAccessRequestItemResponseWithDefaults instantiates a new AccessRequestItemResponse 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 + +### GetOperation + +`func (o *AccessRequestItemResponse) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *AccessRequestItemResponse) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *AccessRequestItemResponse) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *AccessRequestItemResponse) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetAccessItemType + +`func (o *AccessRequestItemResponse) GetAccessItemType() string` + +GetAccessItemType returns the AccessItemType field if non-nil, zero value otherwise. + +### GetAccessItemTypeOk + +`func (o *AccessRequestItemResponse) GetAccessItemTypeOk() (*string, bool)` + +GetAccessItemTypeOk returns a tuple with the AccessItemType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItemType + +`func (o *AccessRequestItemResponse) SetAccessItemType(v string)` + +SetAccessItemType sets AccessItemType field to given value. + +### HasAccessItemType + +`func (o *AccessRequestItemResponse) HasAccessItemType() bool` + +HasAccessItemType returns a boolean if a field has been set. + +### GetName + +`func (o *AccessRequestItemResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestItemResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestItemResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessRequestItemResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDecision + +`func (o *AccessRequestItemResponse) GetDecision() string` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *AccessRequestItemResponse) GetDecisionOk() (*string, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *AccessRequestItemResponse) SetDecision(v string)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *AccessRequestItemResponse) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessRequestItemResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestItemResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestItemResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestItemResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessRequestItemResponse) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessRequestItemResponse) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessRequestItemResponse) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessRequestItemResponse) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessRequestItemResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessRequestItemResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessRequestItemResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessRequestItemResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetApprovalInfos + +`func (o *AccessRequestItemResponse) GetApprovalInfos() []ApprovalInfoResponse` + +GetApprovalInfos returns the ApprovalInfos field if non-nil, zero value otherwise. + +### GetApprovalInfosOk + +`func (o *AccessRequestItemResponse) GetApprovalInfosOk() (*[]ApprovalInfoResponse, bool)` + +GetApprovalInfosOk returns a tuple with the ApprovalInfos field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalInfos + +`func (o *AccessRequestItemResponse) SetApprovalInfos(v []ApprovalInfoResponse)` + +SetApprovalInfos sets ApprovalInfos field to given value. + +### HasApprovalInfos + +`func (o *AccessRequestItemResponse) HasApprovalInfos() bool` + +HasApprovalInfos returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPhases.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPhases.md new file mode 100644 index 000000000..8bdf5a2d9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPhases.md @@ -0,0 +1,224 @@ +--- +id: beta-access-request-phases +title: AccessRequestPhases +pagination_label: AccessRequestPhases +sidebar_label: AccessRequestPhases +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPhases', 'BetaAccessRequestPhases'] +slug: /tools/sdk/go/beta/models/access-request-phases +tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'BetaAccessRequestPhases'] +--- + +# AccessRequestPhases + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Started** | Pointer to **SailPointTime** | The time that this phase started. | [optional] +**Finished** | Pointer to **NullableTime** | The time that this phase finished. | [optional] +**Name** | Pointer to **string** | The name of this phase. | [optional] +**State** | Pointer to **string** | The state of this phase. | [optional] +**Result** | Pointer to **NullableString** | The state of this phase. | [optional] +**PhaseReference** | Pointer to **NullableString** | A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. | [optional] + +## Methods + +### NewAccessRequestPhases + +`func NewAccessRequestPhases() *AccessRequestPhases` + +NewAccessRequestPhases instantiates a new AccessRequestPhases 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 + +### NewAccessRequestPhasesWithDefaults + +`func NewAccessRequestPhasesWithDefaults() *AccessRequestPhases` + +NewAccessRequestPhasesWithDefaults instantiates a new AccessRequestPhases 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 + +### GetStarted + +`func (o *AccessRequestPhases) GetStarted() SailPointTime` + +GetStarted returns the Started field if non-nil, zero value otherwise. + +### GetStartedOk + +`func (o *AccessRequestPhases) GetStartedOk() (*SailPointTime, bool)` + +GetStartedOk returns a tuple with the Started field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStarted + +`func (o *AccessRequestPhases) SetStarted(v SailPointTime)` + +SetStarted sets Started field to given value. + +### HasStarted + +`func (o *AccessRequestPhases) HasStarted() bool` + +HasStarted returns a boolean if a field has been set. + +### GetFinished + +`func (o *AccessRequestPhases) GetFinished() SailPointTime` + +GetFinished returns the Finished field if non-nil, zero value otherwise. + +### GetFinishedOk + +`func (o *AccessRequestPhases) GetFinishedOk() (*SailPointTime, bool)` + +GetFinishedOk returns a tuple with the Finished field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFinished + +`func (o *AccessRequestPhases) SetFinished(v SailPointTime)` + +SetFinished sets Finished field to given value. + +### HasFinished + +`func (o *AccessRequestPhases) HasFinished() bool` + +HasFinished returns a boolean if a field has been set. + +### SetFinishedNil + +`func (o *AccessRequestPhases) SetFinishedNil(b bool)` + + SetFinishedNil sets the value for Finished to be an explicit nil + +### UnsetFinished +`func (o *AccessRequestPhases) UnsetFinished()` + +UnsetFinished ensures that no value is present for Finished, not even an explicit nil +### GetName + +`func (o *AccessRequestPhases) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestPhases) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestPhases) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessRequestPhases) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetState + +`func (o *AccessRequestPhases) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *AccessRequestPhases) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *AccessRequestPhases) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *AccessRequestPhases) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetResult + +`func (o *AccessRequestPhases) GetResult() string` + +GetResult returns the Result field if non-nil, zero value otherwise. + +### GetResultOk + +`func (o *AccessRequestPhases) GetResultOk() (*string, bool)` + +GetResultOk returns a tuple with the Result field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResult + +`func (o *AccessRequestPhases) SetResult(v string)` + +SetResult sets Result field to given value. + +### HasResult + +`func (o *AccessRequestPhases) HasResult() bool` + +HasResult returns a boolean if a field has been set. + +### SetResultNil + +`func (o *AccessRequestPhases) SetResultNil(b bool)` + + SetResultNil sets the value for Result to be an explicit nil + +### UnsetResult +`func (o *AccessRequestPhases) UnsetResult()` + +UnsetResult ensures that no value is present for Result, not even an explicit nil +### GetPhaseReference + +`func (o *AccessRequestPhases) GetPhaseReference() string` + +GetPhaseReference returns the PhaseReference field if non-nil, zero value otherwise. + +### GetPhaseReferenceOk + +`func (o *AccessRequestPhases) GetPhaseReferenceOk() (*string, bool)` + +GetPhaseReferenceOk returns a tuple with the PhaseReference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhaseReference + +`func (o *AccessRequestPhases) SetPhaseReference(v string)` + +SetPhaseReference sets PhaseReference field to given value. + +### HasPhaseReference + +`func (o *AccessRequestPhases) HasPhaseReference() bool` + +HasPhaseReference returns a boolean if a field has been set. + +### SetPhaseReferenceNil + +`func (o *AccessRequestPhases) SetPhaseReferenceNil(b bool)` + + SetPhaseReferenceNil sets the value for PhaseReference to be an explicit nil + +### UnsetPhaseReference +`func (o *AccessRequestPhases) UnsetPhaseReference()` + +UnsetPhaseReference ensures that no value is present for PhaseReference, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPostApproval.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPostApproval.md new file mode 100644 index 000000000..93d27a337 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPostApproval.md @@ -0,0 +1,122 @@ +--- +id: beta-access-request-post-approval +title: AccessRequestPostApproval +pagination_label: AccessRequestPostApproval +sidebar_label: AccessRequestPostApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPostApproval', 'BetaAccessRequestPostApproval'] +slug: /tools/sdk/go/beta/models/access-request-post-approval +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApproval', 'BetaAccessRequestPostApproval'] +--- + +# AccessRequestPostApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **string** | Access request's unique ID. | +**RequestedFor** | [**[]AccessItemRequestedForDto1**](access-item-requested-for-dto1) | Identities whom access was requested for. | +**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details about the outcome of each requested access item. | +**RequestedBy** | [**AccessItemRequesterDto1**](access-item-requester-dto1) | | + +## Methods + +### NewAccessRequestPostApproval + +`func NewAccessRequestPostApproval(accessRequestId string, requestedFor []AccessItemRequestedForDto1, requestedItemsStatus []AccessRequestPostApprovalRequestedItemsStatusInner, requestedBy AccessItemRequesterDto1, ) *AccessRequestPostApproval` + +NewAccessRequestPostApproval instantiates a new AccessRequestPostApproval 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 + +### NewAccessRequestPostApprovalWithDefaults + +`func NewAccessRequestPostApprovalWithDefaults() *AccessRequestPostApproval` + +NewAccessRequestPostApprovalWithDefaults instantiates a new AccessRequestPostApproval 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 + +### GetAccessRequestId + +`func (o *AccessRequestPostApproval) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *AccessRequestPostApproval) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *AccessRequestPostApproval) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + + +### GetRequestedFor + +`func (o *AccessRequestPostApproval) GetRequestedFor() []AccessItemRequestedForDto1` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequestPostApproval) GetRequestedForOk() (*[]AccessItemRequestedForDto1, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequestPostApproval) SetRequestedFor(v []AccessItemRequestedForDto1)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestedItemsStatus + +`func (o *AccessRequestPostApproval) GetRequestedItemsStatus() []AccessRequestPostApprovalRequestedItemsStatusInner` + +GetRequestedItemsStatus returns the RequestedItemsStatus field if non-nil, zero value otherwise. + +### GetRequestedItemsStatusOk + +`func (o *AccessRequestPostApproval) GetRequestedItemsStatusOk() (*[]AccessRequestPostApprovalRequestedItemsStatusInner, bool)` + +GetRequestedItemsStatusOk returns a tuple with the RequestedItemsStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItemsStatus + +`func (o *AccessRequestPostApproval) SetRequestedItemsStatus(v []AccessRequestPostApprovalRequestedItemsStatusInner)` + +SetRequestedItemsStatus sets RequestedItemsStatus field to given value. + + +### GetRequestedBy + +`func (o *AccessRequestPostApproval) GetRequestedBy() AccessItemRequesterDto1` + +GetRequestedBy returns the RequestedBy field if non-nil, zero value otherwise. + +### GetRequestedByOk + +`func (o *AccessRequestPostApproval) GetRequestedByOk() (*AccessItemRequesterDto1, bool)` + +GetRequestedByOk returns a tuple with the RequestedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedBy + +`func (o *AccessRequestPostApproval) SetRequestedBy(v AccessItemRequesterDto1)` + +SetRequestedBy sets RequestedBy field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md new file mode 100644 index 000000000..0c946693d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md @@ -0,0 +1,251 @@ +--- +id: beta-access-request-post-approval-requested-items-status-inner +title: AccessRequestPostApprovalRequestedItemsStatusInner +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInner +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInner'] +slug: /tools/sdk/go/beta/models/access-request-post-approval-requested-items-status-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInner'] +--- + +# AccessRequestPostApprovalRequestedItemsStatusInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Access item's unique ID. | +**Name** | **string** | Access item's name. | +**Description** | Pointer to **NullableString** | Access item's description. | [optional] +**Type** | **map[string]interface{}** | Access item's type. | +**Operation** | **map[string]interface{}** | Action to perform on the requested access item. | +**Comment** | Pointer to **NullableString** | Comment from the identity requesting access. | [optional] +**ClientMetadata** | Pointer to **map[string]interface{}** | Additional customer defined metadata about the access item. | [optional] +**ApprovalInfo** | [**[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner**](access-request-post-approval-requested-items-status-inner-approval-info-inner) | List of approvers for the access request. | + +## Methods + +### NewAccessRequestPostApprovalRequestedItemsStatusInner + +`func NewAccessRequestPostApprovalRequestedItemsStatusInner(id string, name string, type_ map[string]interface{}, operation map[string]interface{}, approvalInfo []AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner, ) *AccessRequestPostApprovalRequestedItemsStatusInner` + +NewAccessRequestPostApprovalRequestedItemsStatusInner instantiates a new AccessRequestPostApprovalRequestedItemsStatusInner 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 + +### NewAccessRequestPostApprovalRequestedItemsStatusInnerWithDefaults + +`func NewAccessRequestPostApprovalRequestedItemsStatusInnerWithDefaults() *AccessRequestPostApprovalRequestedItemsStatusInner` + +NewAccessRequestPostApprovalRequestedItemsStatusInnerWithDefaults instantiates a new AccessRequestPostApprovalRequestedItemsStatusInner 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 + +### GetId + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetOperation + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetOperation() map[string]interface{}` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetOperationOk() (*map[string]interface{}, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetOperation(v map[string]interface{})` + +SetOperation sets Operation field to given value. + + +### GetComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetClientMetadata + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetClientMetadata() map[string]interface{}` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetClientMetadataOk() (*map[string]interface{}, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetClientMetadata(v map[string]interface{})` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetApprovalInfo + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetApprovalInfo() []AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner` + +GetApprovalInfo returns the ApprovalInfo field if non-nil, zero value otherwise. + +### GetApprovalInfoOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetApprovalInfoOk() (*[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner, bool)` + +GetApprovalInfoOk returns a tuple with the ApprovalInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalInfo + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetApprovalInfo(v []AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner)` + +SetApprovalInfo sets ApprovalInfo field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md new file mode 100644 index 000000000..ceffc7e9b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md @@ -0,0 +1,137 @@ +--- +id: beta-access-request-post-approval-requested-items-status-inner-approval-info-inner +title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner'] +slug: /tools/sdk/go/beta/models/access-request-post-approval-requested-items-status-inner-approval-info-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner'] +--- + +# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalComment** | Pointer to **NullableString** | Approver's comment. | [optional] +**ApprovalDecision** | **map[string]interface{}** | Approver's final decision. | +**ApproverName** | **string** | Approver's name. | +**Approver** | [**AccessItemApproverDto**](access-item-approver-dto) | Approver's identity. | + +## Methods + +### NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner + +`func NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner(approvalDecision map[string]interface{}, approverName string, approver AccessItemApproverDto, ) *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner` + +NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner instantiates a new AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner 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 + +### NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerWithDefaults + +`func NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerWithDefaults() *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner` + +NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerWithDefaults instantiates a new AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner 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 + +### GetApprovalComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApprovalComment() string` + +GetApprovalComment returns the ApprovalComment field if non-nil, zero value otherwise. + +### GetApprovalCommentOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApprovalCommentOk() (*string, bool)` + +GetApprovalCommentOk returns a tuple with the ApprovalComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) SetApprovalComment(v string)` + +SetApprovalComment sets ApprovalComment field to given value. + +### HasApprovalComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) HasApprovalComment() bool` + +HasApprovalComment returns a boolean if a field has been set. + +### SetApprovalCommentNil + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) SetApprovalCommentNil(b bool)` + + SetApprovalCommentNil sets the value for ApprovalComment to be an explicit nil + +### UnsetApprovalComment +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) UnsetApprovalComment()` + +UnsetApprovalComment ensures that no value is present for ApprovalComment, not even an explicit nil +### GetApprovalDecision + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApprovalDecision() map[string]interface{}` + +GetApprovalDecision returns the ApprovalDecision field if non-nil, zero value otherwise. + +### GetApprovalDecisionOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApprovalDecisionOk() (*map[string]interface{}, bool)` + +GetApprovalDecisionOk returns a tuple with the ApprovalDecision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalDecision + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) SetApprovalDecision(v map[string]interface{})` + +SetApprovalDecision sets ApprovalDecision field to given value. + + +### GetApproverName + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApproverName() string` + +GetApproverName returns the ApproverName field if non-nil, zero value otherwise. + +### GetApproverNameOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApproverNameOk() (*string, bool)` + +GetApproverNameOk returns a tuple with the ApproverName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverName + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) SetApproverName(v string)` + +SetApproverName sets ApproverName field to given value. + + +### GetApprover + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApprover() AccessItemApproverDto` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApproverOk() (*AccessItemApproverDto, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) SetApprover(v AccessItemApproverDto)` + +SetApprover sets Approver field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPreApproval.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPreApproval.md new file mode 100644 index 000000000..d10a6a5db --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPreApproval.md @@ -0,0 +1,122 @@ +--- +id: beta-access-request-pre-approval +title: AccessRequestPreApproval +pagination_label: AccessRequestPreApproval +sidebar_label: AccessRequestPreApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPreApproval', 'BetaAccessRequestPreApproval'] +slug: /tools/sdk/go/beta/models/access-request-pre-approval +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval', 'BetaAccessRequestPreApproval'] +--- + +# AccessRequestPreApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **string** | Access request's unique ID. | +**RequestedFor** | [**[]AccessItemRequestedForDto1**](access-item-requested-for-dto1) | Identities whom access was requested for. | +**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details about each requested access item. | +**RequestedBy** | [**AccessItemRequesterDto1**](access-item-requester-dto1) | | + +## Methods + +### NewAccessRequestPreApproval + +`func NewAccessRequestPreApproval(accessRequestId string, requestedFor []AccessItemRequestedForDto1, requestedItems []AccessRequestPreApprovalRequestedItemsInner, requestedBy AccessItemRequesterDto1, ) *AccessRequestPreApproval` + +NewAccessRequestPreApproval instantiates a new AccessRequestPreApproval 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 + +### NewAccessRequestPreApprovalWithDefaults + +`func NewAccessRequestPreApprovalWithDefaults() *AccessRequestPreApproval` + +NewAccessRequestPreApprovalWithDefaults instantiates a new AccessRequestPreApproval 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 + +### GetAccessRequestId + +`func (o *AccessRequestPreApproval) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *AccessRequestPreApproval) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *AccessRequestPreApproval) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + + +### GetRequestedFor + +`func (o *AccessRequestPreApproval) GetRequestedFor() []AccessItemRequestedForDto1` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequestPreApproval) GetRequestedForOk() (*[]AccessItemRequestedForDto1, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequestPreApproval) SetRequestedFor(v []AccessItemRequestedForDto1)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestedItems + +`func (o *AccessRequestPreApproval) GetRequestedItems() []AccessRequestPreApprovalRequestedItemsInner` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *AccessRequestPreApproval) GetRequestedItemsOk() (*[]AccessRequestPreApprovalRequestedItemsInner, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *AccessRequestPreApproval) SetRequestedItems(v []AccessRequestPreApprovalRequestedItemsInner)` + +SetRequestedItems sets RequestedItems field to given value. + + +### GetRequestedBy + +`func (o *AccessRequestPreApproval) GetRequestedBy() AccessItemRequesterDto1` + +GetRequestedBy returns the RequestedBy field if non-nil, zero value otherwise. + +### GetRequestedByOk + +`func (o *AccessRequestPreApproval) GetRequestedByOk() (*AccessItemRequesterDto1, bool)` + +GetRequestedByOk returns a tuple with the RequestedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedBy + +`func (o *AccessRequestPreApproval) SetRequestedBy(v AccessItemRequesterDto1)` + +SetRequestedBy sets RequestedBy field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPreApproval1.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPreApproval1.md new file mode 100644 index 000000000..417e53265 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPreApproval1.md @@ -0,0 +1,101 @@ +--- +id: beta-access-request-pre-approval1 +title: AccessRequestPreApproval1 +pagination_label: AccessRequestPreApproval1 +sidebar_label: AccessRequestPreApproval1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPreApproval1', 'BetaAccessRequestPreApproval1'] +slug: /tools/sdk/go/beta/models/access-request-pre-approval1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval1', 'BetaAccessRequestPreApproval1'] +--- + +# AccessRequestPreApproval1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | **bool** | Whether or not to approve the access request. | +**Comment** | **string** | A comment about the decision to approve or deny the request. | +**Approver** | **string** | The name of the entity that approved or denied the request. | + +## Methods + +### NewAccessRequestPreApproval1 + +`func NewAccessRequestPreApproval1(approved bool, comment string, approver string, ) *AccessRequestPreApproval1` + +NewAccessRequestPreApproval1 instantiates a new AccessRequestPreApproval1 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 + +### NewAccessRequestPreApproval1WithDefaults + +`func NewAccessRequestPreApproval1WithDefaults() *AccessRequestPreApproval1` + +NewAccessRequestPreApproval1WithDefaults instantiates a new AccessRequestPreApproval1 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 + +### GetApproved + +`func (o *AccessRequestPreApproval1) GetApproved() bool` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *AccessRequestPreApproval1) GetApprovedOk() (*bool, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *AccessRequestPreApproval1) SetApproved(v bool)` + +SetApproved sets Approved field to given value. + + +### GetComment + +`func (o *AccessRequestPreApproval1) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestPreApproval1) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestPreApproval1) SetComment(v string)` + +SetComment sets Comment field to given value. + + +### GetApprover + +`func (o *AccessRequestPreApproval1) GetApprover() string` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *AccessRequestPreApproval1) GetApproverOk() (*string, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *AccessRequestPreApproval1) SetApprover(v string)` + +SetApprover sets Approver field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPreApprovalRequestedItemsInner.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPreApprovalRequestedItemsInner.md new file mode 100644 index 000000000..b01b46bd6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestPreApprovalRequestedItemsInner.md @@ -0,0 +1,194 @@ +--- +id: beta-access-request-pre-approval-requested-items-inner +title: AccessRequestPreApprovalRequestedItemsInner +pagination_label: AccessRequestPreApprovalRequestedItemsInner +sidebar_label: AccessRequestPreApprovalRequestedItemsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPreApprovalRequestedItemsInner', 'BetaAccessRequestPreApprovalRequestedItemsInner'] +slug: /tools/sdk/go/beta/models/access-request-pre-approval-requested-items-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApprovalRequestedItemsInner', 'BetaAccessRequestPreApprovalRequestedItemsInner'] +--- + +# AccessRequestPreApprovalRequestedItemsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Access item's unique ID. | +**Name** | **string** | Access item's name. | +**Description** | Pointer to **NullableString** | Access item's description. | [optional] +**Type** | **map[string]interface{}** | Access item's type. | +**Operation** | **map[string]interface{}** | Action to perform on the access item. | +**Comment** | Pointer to **NullableString** | Comment from the identity requesting access. | [optional] + +## Methods + +### NewAccessRequestPreApprovalRequestedItemsInner + +`func NewAccessRequestPreApprovalRequestedItemsInner(id string, name string, type_ map[string]interface{}, operation map[string]interface{}, ) *AccessRequestPreApprovalRequestedItemsInner` + +NewAccessRequestPreApprovalRequestedItemsInner instantiates a new AccessRequestPreApprovalRequestedItemsInner 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 + +### NewAccessRequestPreApprovalRequestedItemsInnerWithDefaults + +`func NewAccessRequestPreApprovalRequestedItemsInnerWithDefaults() *AccessRequestPreApprovalRequestedItemsInner` + +NewAccessRequestPreApprovalRequestedItemsInnerWithDefaults instantiates a new AccessRequestPreApprovalRequestedItemsInner 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 + +### GetId + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestPreApprovalRequestedItemsInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessRequestPreApprovalRequestedItemsInner) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetOperation + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetOperation() map[string]interface{}` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetOperationOk() (*map[string]interface{}, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetOperation(v map[string]interface{})` + +SetOperation sets Operation field to given value. + + +### GetComment + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *AccessRequestPreApprovalRequestedItemsInner) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *AccessRequestPreApprovalRequestedItemsInner) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationActionItemDto.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationActionItemDto.md new file mode 100644 index 000000000..a2ffbd78d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationActionItemDto.md @@ -0,0 +1,80 @@ +--- +id: beta-access-request-recommendation-action-item-dto +title: AccessRequestRecommendationActionItemDto +pagination_label: AccessRequestRecommendationActionItemDto +sidebar_label: AccessRequestRecommendationActionItemDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationActionItemDto', 'BetaAccessRequestRecommendationActionItemDto'] +slug: /tools/sdk/go/beta/models/access-request-recommendation-action-item-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemDto', 'BetaAccessRequestRecommendationActionItemDto'] +--- + +# AccessRequestRecommendationActionItemDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **string** | The identity ID taking the action. | +**Access** | [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | + +## Methods + +### NewAccessRequestRecommendationActionItemDto + +`func NewAccessRequestRecommendationActionItemDto(identityId string, access AccessRequestRecommendationItem, ) *AccessRequestRecommendationActionItemDto` + +NewAccessRequestRecommendationActionItemDto instantiates a new AccessRequestRecommendationActionItemDto 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 + +### NewAccessRequestRecommendationActionItemDtoWithDefaults + +`func NewAccessRequestRecommendationActionItemDtoWithDefaults() *AccessRequestRecommendationActionItemDto` + +NewAccessRequestRecommendationActionItemDtoWithDefaults instantiates a new AccessRequestRecommendationActionItemDto 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 + +### GetIdentityId + +`func (o *AccessRequestRecommendationActionItemDto) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessRequestRecommendationActionItemDto) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessRequestRecommendationActionItemDto) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetAccess + +`func (o *AccessRequestRecommendationActionItemDto) GetAccess() AccessRequestRecommendationItem` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *AccessRequestRecommendationActionItemDto) GetAccessOk() (*AccessRequestRecommendationItem, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *AccessRequestRecommendationActionItemDto) SetAccess(v AccessRequestRecommendationItem)` + +SetAccess sets Access field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationActionItemResponseDto.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationActionItemResponseDto.md new file mode 100644 index 000000000..38ca43551 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationActionItemResponseDto.md @@ -0,0 +1,116 @@ +--- +id: beta-access-request-recommendation-action-item-response-dto +title: AccessRequestRecommendationActionItemResponseDto +pagination_label: AccessRequestRecommendationActionItemResponseDto +sidebar_label: AccessRequestRecommendationActionItemResponseDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationActionItemResponseDto', 'BetaAccessRequestRecommendationActionItemResponseDto'] +slug: /tools/sdk/go/beta/models/access-request-recommendation-action-item-response-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemResponseDto', 'BetaAccessRequestRecommendationActionItemResponseDto'] +--- + +# AccessRequestRecommendationActionItemResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | The identity ID taking the action. | [optional] +**Access** | Pointer to [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [optional] +**Timestamp** | Pointer to **SailPointTime** | | [optional] + +## Methods + +### NewAccessRequestRecommendationActionItemResponseDto + +`func NewAccessRequestRecommendationActionItemResponseDto() *AccessRequestRecommendationActionItemResponseDto` + +NewAccessRequestRecommendationActionItemResponseDto instantiates a new AccessRequestRecommendationActionItemResponseDto 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 + +### NewAccessRequestRecommendationActionItemResponseDtoWithDefaults + +`func NewAccessRequestRecommendationActionItemResponseDtoWithDefaults() *AccessRequestRecommendationActionItemResponseDto` + +NewAccessRequestRecommendationActionItemResponseDtoWithDefaults instantiates a new AccessRequestRecommendationActionItemResponseDto 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 + +### GetIdentityId + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessRequestRecommendationActionItemResponseDto) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccessRequestRecommendationActionItemResponseDto) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetAccess + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetAccess() AccessRequestRecommendationItem` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetAccessOk() (*AccessRequestRecommendationItem, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *AccessRequestRecommendationActionItemResponseDto) SetAccess(v AccessRequestRecommendationItem)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *AccessRequestRecommendationActionItemResponseDto) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetTimestamp + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *AccessRequestRecommendationActionItemResponseDto) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *AccessRequestRecommendationActionItemResponseDto) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationItem.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationItem.md new file mode 100644 index 000000000..307d48f4a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationItem.md @@ -0,0 +1,90 @@ +--- +id: beta-access-request-recommendation-item +title: AccessRequestRecommendationItem +pagination_label: AccessRequestRecommendationItem +sidebar_label: AccessRequestRecommendationItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationItem', 'BetaAccessRequestRecommendationItem'] +slug: /tools/sdk/go/beta/models/access-request-recommendation-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItem', 'BetaAccessRequestRecommendationItem'] +--- + +# AccessRequestRecommendationItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of access item being recommended. | [optional] +**Type** | Pointer to [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional] + +## Methods + +### NewAccessRequestRecommendationItem + +`func NewAccessRequestRecommendationItem() *AccessRequestRecommendationItem` + +NewAccessRequestRecommendationItem instantiates a new AccessRequestRecommendationItem 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 + +### NewAccessRequestRecommendationItemWithDefaults + +`func NewAccessRequestRecommendationItemWithDefaults() *AccessRequestRecommendationItem` + +NewAccessRequestRecommendationItemWithDefaults instantiates a new AccessRequestRecommendationItem 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 + +### GetId + +`func (o *AccessRequestRecommendationItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestRecommendationItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestRecommendationItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessRequestRecommendationItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessRequestRecommendationItem) GetType() AccessRequestRecommendationItemType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestRecommendationItem) GetTypeOk() (*AccessRequestRecommendationItemType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestRecommendationItem) SetType(v AccessRequestRecommendationItemType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessRequestRecommendationItem) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationItemDetail.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationItemDetail.md new file mode 100644 index 000000000..9b9c0224f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationItemDetail.md @@ -0,0 +1,220 @@ +--- +id: beta-access-request-recommendation-item-detail +title: AccessRequestRecommendationItemDetail +pagination_label: AccessRequestRecommendationItemDetail +sidebar_label: AccessRequestRecommendationItemDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationItemDetail', 'BetaAccessRequestRecommendationItemDetail'] +slug: /tools/sdk/go/beta/models/access-request-recommendation-item-detail +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetail', 'BetaAccessRequestRecommendationItemDetail'] +--- + +# AccessRequestRecommendationItemDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | Identity ID for the recommendation | [optional] +**Access** | Pointer to [**AccessRequestRecommendationItemDetailAccess**](access-request-recommendation-item-detail-access) | | [optional] +**Ignored** | Pointer to **bool** | Whether or not the identity has already chosen to ignore this recommendation. | [optional] +**Requested** | Pointer to **bool** | Whether or not the identity has already chosen to request this recommendation. | [optional] +**Viewed** | Pointer to **bool** | Whether or not the identity reportedly viewed this recommendation. | [optional] +**Messages** | Pointer to [**[]AccessRecommendationMessage**](access-recommendation-message) | | [optional] +**TranslationMessages** | Pointer to [**[]TranslationMessage**](translation-message) | The list of translation messages | [optional] + +## Methods + +### NewAccessRequestRecommendationItemDetail + +`func NewAccessRequestRecommendationItemDetail() *AccessRequestRecommendationItemDetail` + +NewAccessRequestRecommendationItemDetail instantiates a new AccessRequestRecommendationItemDetail 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 + +### NewAccessRequestRecommendationItemDetailWithDefaults + +`func NewAccessRequestRecommendationItemDetailWithDefaults() *AccessRequestRecommendationItemDetail` + +NewAccessRequestRecommendationItemDetailWithDefaults instantiates a new AccessRequestRecommendationItemDetail 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 + +### GetIdentityId + +`func (o *AccessRequestRecommendationItemDetail) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessRequestRecommendationItemDetail) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessRequestRecommendationItemDetail) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccessRequestRecommendationItemDetail) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetAccess + +`func (o *AccessRequestRecommendationItemDetail) GetAccess() AccessRequestRecommendationItemDetailAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *AccessRequestRecommendationItemDetail) GetAccessOk() (*AccessRequestRecommendationItemDetailAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *AccessRequestRecommendationItemDetail) SetAccess(v AccessRequestRecommendationItemDetailAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *AccessRequestRecommendationItemDetail) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetIgnored + +`func (o *AccessRequestRecommendationItemDetail) GetIgnored() bool` + +GetIgnored returns the Ignored field if non-nil, zero value otherwise. + +### GetIgnoredOk + +`func (o *AccessRequestRecommendationItemDetail) GetIgnoredOk() (*bool, bool)` + +GetIgnoredOk returns a tuple with the Ignored field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIgnored + +`func (o *AccessRequestRecommendationItemDetail) SetIgnored(v bool)` + +SetIgnored sets Ignored field to given value. + +### HasIgnored + +`func (o *AccessRequestRecommendationItemDetail) HasIgnored() bool` + +HasIgnored returns a boolean if a field has been set. + +### GetRequested + +`func (o *AccessRequestRecommendationItemDetail) GetRequested() bool` + +GetRequested returns the Requested field if non-nil, zero value otherwise. + +### GetRequestedOk + +`func (o *AccessRequestRecommendationItemDetail) GetRequestedOk() (*bool, bool)` + +GetRequestedOk returns a tuple with the Requested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequested + +`func (o *AccessRequestRecommendationItemDetail) SetRequested(v bool)` + +SetRequested sets Requested field to given value. + +### HasRequested + +`func (o *AccessRequestRecommendationItemDetail) HasRequested() bool` + +HasRequested returns a boolean if a field has been set. + +### GetViewed + +`func (o *AccessRequestRecommendationItemDetail) GetViewed() bool` + +GetViewed returns the Viewed field if non-nil, zero value otherwise. + +### GetViewedOk + +`func (o *AccessRequestRecommendationItemDetail) GetViewedOk() (*bool, bool)` + +GetViewedOk returns a tuple with the Viewed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViewed + +`func (o *AccessRequestRecommendationItemDetail) SetViewed(v bool)` + +SetViewed sets Viewed field to given value. + +### HasViewed + +`func (o *AccessRequestRecommendationItemDetail) HasViewed() bool` + +HasViewed returns a boolean if a field has been set. + +### GetMessages + +`func (o *AccessRequestRecommendationItemDetail) GetMessages() []AccessRecommendationMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *AccessRequestRecommendationItemDetail) GetMessagesOk() (*[]AccessRecommendationMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *AccessRequestRecommendationItemDetail) SetMessages(v []AccessRecommendationMessage)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *AccessRequestRecommendationItemDetail) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetTranslationMessages + +`func (o *AccessRequestRecommendationItemDetail) GetTranslationMessages() []TranslationMessage` + +GetTranslationMessages returns the TranslationMessages field if non-nil, zero value otherwise. + +### GetTranslationMessagesOk + +`func (o *AccessRequestRecommendationItemDetail) GetTranslationMessagesOk() (*[]TranslationMessage, bool)` + +GetTranslationMessagesOk returns a tuple with the TranslationMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslationMessages + +`func (o *AccessRequestRecommendationItemDetail) SetTranslationMessages(v []TranslationMessage)` + +SetTranslationMessages sets TranslationMessages field to given value. + +### HasTranslationMessages + +`func (o *AccessRequestRecommendationItemDetail) HasTranslationMessages() bool` + +HasTranslationMessages returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationItemDetailAccess.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationItemDetailAccess.md new file mode 100644 index 000000000..70790383a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationItemDetailAccess.md @@ -0,0 +1,142 @@ +--- +id: beta-access-request-recommendation-item-detail-access +title: AccessRequestRecommendationItemDetailAccess +pagination_label: AccessRequestRecommendationItemDetailAccess +sidebar_label: AccessRequestRecommendationItemDetailAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationItemDetailAccess', 'BetaAccessRequestRecommendationItemDetailAccess'] +slug: /tools/sdk/go/beta/models/access-request-recommendation-item-detail-access +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetailAccess', 'BetaAccessRequestRecommendationItemDetailAccess'] +--- + +# AccessRequestRecommendationItemDetailAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of access item being recommended. | [optional] +**Type** | Pointer to [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional] +**Name** | Pointer to **string** | Name of the access item | [optional] +**Description** | Pointer to **string** | Description of the access item | [optional] + +## Methods + +### NewAccessRequestRecommendationItemDetailAccess + +`func NewAccessRequestRecommendationItemDetailAccess() *AccessRequestRecommendationItemDetailAccess` + +NewAccessRequestRecommendationItemDetailAccess instantiates a new AccessRequestRecommendationItemDetailAccess 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 + +### NewAccessRequestRecommendationItemDetailAccessWithDefaults + +`func NewAccessRequestRecommendationItemDetailAccessWithDefaults() *AccessRequestRecommendationItemDetailAccess` + +NewAccessRequestRecommendationItemDetailAccessWithDefaults instantiates a new AccessRequestRecommendationItemDetailAccess 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 + +### GetId + +`func (o *AccessRequestRecommendationItemDetailAccess) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestRecommendationItemDetailAccess) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestRecommendationItemDetailAccess) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessRequestRecommendationItemDetailAccess) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessRequestRecommendationItemDetailAccess) GetType() AccessRequestRecommendationItemType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestRecommendationItemDetailAccess) GetTypeOk() (*AccessRequestRecommendationItemType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestRecommendationItemDetailAccess) SetType(v AccessRequestRecommendationItemType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessRequestRecommendationItemDetailAccess) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccessRequestRecommendationItemDetailAccess) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestRecommendationItemDetailAccess) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestRecommendationItemDetailAccess) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessRequestRecommendationItemDetailAccess) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessRequestRecommendationItemDetailAccess) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestRecommendationItemDetailAccess) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestRecommendationItemDetailAccess) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestRecommendationItemDetailAccess) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationItemType.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationItemType.md new file mode 100644 index 000000000..138e3c15d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestRecommendationItemType.md @@ -0,0 +1,21 @@ +--- +id: beta-access-request-recommendation-item-type +title: AccessRequestRecommendationItemType +pagination_label: AccessRequestRecommendationItemType +sidebar_label: AccessRequestRecommendationItemType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationItemType', 'BetaAccessRequestRecommendationItemType'] +slug: /tools/sdk/go/beta/models/access-request-recommendation-item-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemType', 'BetaAccessRequestRecommendationItemType'] +--- + +# AccessRequestRecommendationItemType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestResponse.md new file mode 100644 index 000000000..521f8033c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestResponse.md @@ -0,0 +1,90 @@ +--- +id: beta-access-request-response +title: AccessRequestResponse +pagination_label: AccessRequestResponse +sidebar_label: AccessRequestResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestResponse', 'BetaAccessRequestResponse'] +slug: /tools/sdk/go/beta/models/access-request-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'BetaAccessRequestResponse'] +--- + +# AccessRequestResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewRequests** | Pointer to [**[]AccessRequestTracking**](access-request-tracking) | A list of new access request tracking data mapped to the values requested. | [optional] +**ExistingRequests** | Pointer to [**[]AccessRequestTracking**](access-request-tracking) | A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. | [optional] + +## Methods + +### NewAccessRequestResponse + +`func NewAccessRequestResponse() *AccessRequestResponse` + +NewAccessRequestResponse instantiates a new AccessRequestResponse 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 + +### NewAccessRequestResponseWithDefaults + +`func NewAccessRequestResponseWithDefaults() *AccessRequestResponse` + +NewAccessRequestResponseWithDefaults instantiates a new AccessRequestResponse 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 + +### GetNewRequests + +`func (o *AccessRequestResponse) GetNewRequests() []AccessRequestTracking` + +GetNewRequests returns the NewRequests field if non-nil, zero value otherwise. + +### GetNewRequestsOk + +`func (o *AccessRequestResponse) GetNewRequestsOk() (*[]AccessRequestTracking, bool)` + +GetNewRequestsOk returns a tuple with the NewRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewRequests + +`func (o *AccessRequestResponse) SetNewRequests(v []AccessRequestTracking)` + +SetNewRequests sets NewRequests field to given value. + +### HasNewRequests + +`func (o *AccessRequestResponse) HasNewRequests() bool` + +HasNewRequests returns a boolean if a field has been set. + +### GetExistingRequests + +`func (o *AccessRequestResponse) GetExistingRequests() []AccessRequestTracking` + +GetExistingRequests returns the ExistingRequests field if non-nil, zero value otherwise. + +### GetExistingRequestsOk + +`func (o *AccessRequestResponse) GetExistingRequestsOk() (*[]AccessRequestTracking, bool)` + +GetExistingRequestsOk returns a tuple with the ExistingRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExistingRequests + +`func (o *AccessRequestResponse) SetExistingRequests(v []AccessRequestTracking)` + +SetExistingRequests sets ExistingRequests field to given value. + +### HasExistingRequests + +`func (o *AccessRequestResponse) HasExistingRequests() bool` + +HasExistingRequests returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestResponse1.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestResponse1.md new file mode 100644 index 000000000..9a3be1832 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestResponse1.md @@ -0,0 +1,116 @@ +--- +id: beta-access-request-response1 +title: AccessRequestResponse1 +pagination_label: AccessRequestResponse1 +sidebar_label: AccessRequestResponse1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestResponse1', 'BetaAccessRequestResponse1'] +slug: /tools/sdk/go/beta/models/access-request-response1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse1', 'BetaAccessRequestResponse1'] +--- + +# AccessRequestResponse1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequesterId** | Pointer to **string** | the requester Id | [optional] +**RequesterName** | Pointer to **string** | the requesterName | [optional] +**Items** | Pointer to [**[]AccessRequestItemResponse**](access-request-item-response) | | [optional] + +## Methods + +### NewAccessRequestResponse1 + +`func NewAccessRequestResponse1() *AccessRequestResponse1` + +NewAccessRequestResponse1 instantiates a new AccessRequestResponse1 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 + +### NewAccessRequestResponse1WithDefaults + +`func NewAccessRequestResponse1WithDefaults() *AccessRequestResponse1` + +NewAccessRequestResponse1WithDefaults instantiates a new AccessRequestResponse1 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 + +### GetRequesterId + +`func (o *AccessRequestResponse1) GetRequesterId() string` + +GetRequesterId returns the RequesterId field if non-nil, zero value otherwise. + +### GetRequesterIdOk + +`func (o *AccessRequestResponse1) GetRequesterIdOk() (*string, bool)` + +GetRequesterIdOk returns a tuple with the RequesterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterId + +`func (o *AccessRequestResponse1) SetRequesterId(v string)` + +SetRequesterId sets RequesterId field to given value. + +### HasRequesterId + +`func (o *AccessRequestResponse1) HasRequesterId() bool` + +HasRequesterId returns a boolean if a field has been set. + +### GetRequesterName + +`func (o *AccessRequestResponse1) GetRequesterName() string` + +GetRequesterName returns the RequesterName field if non-nil, zero value otherwise. + +### GetRequesterNameOk + +`func (o *AccessRequestResponse1) GetRequesterNameOk() (*string, bool)` + +GetRequesterNameOk returns a tuple with the RequesterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterName + +`func (o *AccessRequestResponse1) SetRequesterName(v string)` + +SetRequesterName sets RequesterName field to given value. + +### HasRequesterName + +`func (o *AccessRequestResponse1) HasRequesterName() bool` + +HasRequesterName returns a boolean if a field has been set. + +### GetItems + +`func (o *AccessRequestResponse1) GetItems() []AccessRequestItemResponse` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *AccessRequestResponse1) GetItemsOk() (*[]AccessRequestItemResponse, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *AccessRequestResponse1) SetItems(v []AccessRequestItemResponse)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *AccessRequestResponse1) HasItems() bool` + +HasItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestTracking.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestTracking.md new file mode 100644 index 000000000..7c456517e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestTracking.md @@ -0,0 +1,142 @@ +--- +id: beta-access-request-tracking +title: AccessRequestTracking +pagination_label: AccessRequestTracking +sidebar_label: AccessRequestTracking +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestTracking', 'BetaAccessRequestTracking'] +slug: /tools/sdk/go/beta/models/access-request-tracking +tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'BetaAccessRequestTracking'] +--- + +# AccessRequestTracking + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedFor** | Pointer to **string** | The identity id in which the access request is for. | [optional] +**RequestedItemsDetails** | Pointer to [**[]RequestedItemDetails**](requested-item-details) | The details of the item requested. | [optional] +**AttributesHash** | Pointer to **int32** | a hash representation of the access requested, useful for longer term tracking client side. | [optional] +**AccessRequestIds** | Pointer to **[]string** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [optional] + +## Methods + +### NewAccessRequestTracking + +`func NewAccessRequestTracking() *AccessRequestTracking` + +NewAccessRequestTracking instantiates a new AccessRequestTracking 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 + +### NewAccessRequestTrackingWithDefaults + +`func NewAccessRequestTrackingWithDefaults() *AccessRequestTracking` + +NewAccessRequestTrackingWithDefaults instantiates a new AccessRequestTracking 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 + +### GetRequestedFor + +`func (o *AccessRequestTracking) GetRequestedFor() string` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequestTracking) GetRequestedForOk() (*string, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequestTracking) SetRequestedFor(v string)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *AccessRequestTracking) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetRequestedItemsDetails + +`func (o *AccessRequestTracking) GetRequestedItemsDetails() []RequestedItemDetails` + +GetRequestedItemsDetails returns the RequestedItemsDetails field if non-nil, zero value otherwise. + +### GetRequestedItemsDetailsOk + +`func (o *AccessRequestTracking) GetRequestedItemsDetailsOk() (*[]RequestedItemDetails, bool)` + +GetRequestedItemsDetailsOk returns a tuple with the RequestedItemsDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItemsDetails + +`func (o *AccessRequestTracking) SetRequestedItemsDetails(v []RequestedItemDetails)` + +SetRequestedItemsDetails sets RequestedItemsDetails field to given value. + +### HasRequestedItemsDetails + +`func (o *AccessRequestTracking) HasRequestedItemsDetails() bool` + +HasRequestedItemsDetails returns a boolean if a field has been set. + +### GetAttributesHash + +`func (o *AccessRequestTracking) GetAttributesHash() int32` + +GetAttributesHash returns the AttributesHash field if non-nil, zero value otherwise. + +### GetAttributesHashOk + +`func (o *AccessRequestTracking) GetAttributesHashOk() (*int32, bool)` + +GetAttributesHashOk returns a tuple with the AttributesHash field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributesHash + +`func (o *AccessRequestTracking) SetAttributesHash(v int32)` + +SetAttributesHash sets AttributesHash field to given value. + +### HasAttributesHash + +`func (o *AccessRequestTracking) HasAttributesHash() bool` + +HasAttributesHash returns a boolean if a field has been set. + +### GetAccessRequestIds + +`func (o *AccessRequestTracking) GetAccessRequestIds() []string` + +GetAccessRequestIds returns the AccessRequestIds field if non-nil, zero value otherwise. + +### GetAccessRequestIdsOk + +`func (o *AccessRequestTracking) GetAccessRequestIdsOk() (*[]string, bool)` + +GetAccessRequestIdsOk returns a tuple with the AccessRequestIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestIds + +`func (o *AccessRequestTracking) SetAccessRequestIds(v []string)` + +SetAccessRequestIds sets AccessRequestIds field to given value. + +### HasAccessRequestIds + +`func (o *AccessRequestTracking) HasAccessRequestIds() bool` + +HasAccessRequestIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestType.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestType.md new file mode 100644 index 000000000..3e1b96d4d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequestType.md @@ -0,0 +1,21 @@ +--- +id: beta-access-request-type +title: AccessRequestType +pagination_label: AccessRequestType +sidebar_label: AccessRequestType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestType', 'BetaAccessRequestType'] +slug: /tools/sdk/go/beta/models/access-request-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestType', 'BetaAccessRequestType'] +--- + +# AccessRequestType + +## Enum + + +* `GRANT_ACCESS` (value: `"GRANT_ACCESS"`) + +* `REVOKE_ACCESS` (value: `"REVOKE_ACCESS"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessRequested.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequested.md new file mode 100644 index 000000000..76662d5dd --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessRequested.md @@ -0,0 +1,142 @@ +--- +id: beta-access-requested +title: AccessRequested +pagination_label: AccessRequested +sidebar_label: AccessRequested +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequested', 'BetaAccessRequested'] +slug: /tools/sdk/go/beta/models/access-requested +tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'BetaAccessRequested'] +--- + +# AccessRequested + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequest** | Pointer to [**AccessRequestResponse1**](access-request-response1) | | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] + +## Methods + +### NewAccessRequested + +`func NewAccessRequested() *AccessRequested` + +NewAccessRequested instantiates a new AccessRequested 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 + +### NewAccessRequestedWithDefaults + +`func NewAccessRequestedWithDefaults() *AccessRequested` + +NewAccessRequestedWithDefaults instantiates a new AccessRequested 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 + +### GetAccessRequest + +`func (o *AccessRequested) GetAccessRequest() AccessRequestResponse1` + +GetAccessRequest returns the AccessRequest field if non-nil, zero value otherwise. + +### GetAccessRequestOk + +`func (o *AccessRequested) GetAccessRequestOk() (*AccessRequestResponse1, bool)` + +GetAccessRequestOk returns a tuple with the AccessRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequest + +`func (o *AccessRequested) SetAccessRequest(v AccessRequestResponse1)` + +SetAccessRequest sets AccessRequest field to given value. + +### HasAccessRequest + +`func (o *AccessRequested) HasAccessRequest() bool` + +HasAccessRequest returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *AccessRequested) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessRequested) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessRequested) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccessRequested) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEventType + +`func (o *AccessRequested) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AccessRequested) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AccessRequested) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AccessRequested) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDt + +`func (o *AccessRequested) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *AccessRequested) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *AccessRequested) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *AccessRequested) HasDt() bool` + +HasDt returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccessType.md b/docs/tools/sdk/go/Reference/Beta/Models/AccessType.md new file mode 100644 index 000000000..288204869 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccessType.md @@ -0,0 +1,21 @@ +--- +id: beta-access-type +title: AccessType +pagination_label: AccessType +sidebar_label: AccessType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessType', 'BetaAccessType'] +slug: /tools/sdk/go/beta/models/access-type +tags: ['SDK', 'Software Development Kit', 'AccessType', 'BetaAccessType'] +--- + +# AccessType + +## Enum + + +* `ONLINE` (value: `"ONLINE"`) + +* `OFFLINE` (value: `"OFFLINE"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Account.md b/docs/tools/sdk/go/Reference/Beta/Models/Account.md new file mode 100644 index 000000000..056f5c4c9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Account.md @@ -0,0 +1,816 @@ +--- +id: beta-account +title: Account +pagination_label: Account +sidebar_label: Account +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Account', 'BetaAccount'] +slug: /tools/sdk/go/beta/models/account +tags: ['SDK', 'Software Development Kit', 'Account', 'BetaAccount'] +--- + +# Account + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**SourceId** | **string** | The unique ID of the source this account belongs to | +**SourceName** | **NullableString** | The display name of the source this account belongs to | +**IdentityId** | Pointer to **string** | The unique ID of the identity this account is correlated to | [optional] +**CloudLifecycleState** | Pointer to **NullableString** | The lifecycle state of the identity this account is correlated to | [optional] +**IdentityState** | Pointer to **NullableString** | The identity state of the identity this account is correlated to | [optional] +**ConnectionType** | Pointer to **NullableString** | The connection type of the source this account is from | [optional] +**IsMachine** | Pointer to **bool** | Indicates if the account is of machine type | [optional] [default to false] +**Recommendation** | Pointer to [**NullableRecommendation**](recommendation) | | [optional] +**Attributes** | **map[string]interface{}** | The account attributes that are aggregated | +**Authoritative** | **bool** | Indicates if this account is from an authoritative source | +**Description** | Pointer to **NullableString** | A description of the account | [optional] +**Disabled** | **bool** | Indicates if the account is currently disabled | +**Locked** | **bool** | Indicates if the account is currently locked | +**NativeIdentity** | **string** | The unique ID of the account generated by the source system | +**SystemAccount** | **bool** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | +**Uncorrelated** | **bool** | Indicates if this account is not correlated to an identity | +**Uuid** | Pointer to **NullableString** | The unique ID of the account as determined by the account schema | [optional] +**ManuallyCorrelated** | **bool** | Indicates if the account has been manually correlated to an identity | +**HasEntitlements** | **bool** | Indicates if the account has entitlements | +**Identity** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] +**SourceOwner** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] +**Features** | Pointer to **NullableString** | A string list containing the owning source's features | [optional] +**Origin** | Pointer to **NullableString** | The origin of the account either aggregated or provisioned | [optional] +**OwnerIdentity** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] + +## Methods + +### NewAccount + +`func NewAccount(name NullableString, sourceId string, sourceName NullableString, attributes map[string]interface{}, authoritative bool, disabled bool, locked bool, nativeIdentity string, systemAccount bool, uncorrelated bool, manuallyCorrelated bool, hasEntitlements bool, ) *Account` + +NewAccount instantiates a new Account 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 + +### NewAccountWithDefaults + +`func NewAccountWithDefaults() *Account` + +NewAccountWithDefaults instantiates a new Account 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 + +### GetId + +`func (o *Account) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Account) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Account) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Account) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Account) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Account) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Account) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *Account) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *Account) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *Account) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Account) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Account) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Account) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Account) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Account) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Account) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Account) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetSourceId + +`func (o *Account) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *Account) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *Account) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetSourceName + +`func (o *Account) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *Account) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *Account) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### SetSourceNameNil + +`func (o *Account) SetSourceNameNil(b bool)` + + SetSourceNameNil sets the value for SourceName to be an explicit nil + +### UnsetSourceName +`func (o *Account) UnsetSourceName()` + +UnsetSourceName ensures that no value is present for SourceName, not even an explicit nil +### GetIdentityId + +`func (o *Account) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *Account) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *Account) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *Account) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetCloudLifecycleState + +`func (o *Account) GetCloudLifecycleState() string` + +GetCloudLifecycleState returns the CloudLifecycleState field if non-nil, zero value otherwise. + +### GetCloudLifecycleStateOk + +`func (o *Account) GetCloudLifecycleStateOk() (*string, bool)` + +GetCloudLifecycleStateOk returns a tuple with the CloudLifecycleState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudLifecycleState + +`func (o *Account) SetCloudLifecycleState(v string)` + +SetCloudLifecycleState sets CloudLifecycleState field to given value. + +### HasCloudLifecycleState + +`func (o *Account) HasCloudLifecycleState() bool` + +HasCloudLifecycleState returns a boolean if a field has been set. + +### SetCloudLifecycleStateNil + +`func (o *Account) SetCloudLifecycleStateNil(b bool)` + + SetCloudLifecycleStateNil sets the value for CloudLifecycleState to be an explicit nil + +### UnsetCloudLifecycleState +`func (o *Account) UnsetCloudLifecycleState()` + +UnsetCloudLifecycleState ensures that no value is present for CloudLifecycleState, not even an explicit nil +### GetIdentityState + +`func (o *Account) GetIdentityState() string` + +GetIdentityState returns the IdentityState field if non-nil, zero value otherwise. + +### GetIdentityStateOk + +`func (o *Account) GetIdentityStateOk() (*string, bool)` + +GetIdentityStateOk returns a tuple with the IdentityState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityState + +`func (o *Account) SetIdentityState(v string)` + +SetIdentityState sets IdentityState field to given value. + +### HasIdentityState + +`func (o *Account) HasIdentityState() bool` + +HasIdentityState returns a boolean if a field has been set. + +### SetIdentityStateNil + +`func (o *Account) SetIdentityStateNil(b bool)` + + SetIdentityStateNil sets the value for IdentityState to be an explicit nil + +### UnsetIdentityState +`func (o *Account) UnsetIdentityState()` + +UnsetIdentityState ensures that no value is present for IdentityState, not even an explicit nil +### GetConnectionType + +`func (o *Account) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *Account) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *Account) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *Account) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + +### SetConnectionTypeNil + +`func (o *Account) SetConnectionTypeNil(b bool)` + + SetConnectionTypeNil sets the value for ConnectionType to be an explicit nil + +### UnsetConnectionType +`func (o *Account) UnsetConnectionType()` + +UnsetConnectionType ensures that no value is present for ConnectionType, not even an explicit nil +### GetIsMachine + +`func (o *Account) GetIsMachine() bool` + +GetIsMachine returns the IsMachine field if non-nil, zero value otherwise. + +### GetIsMachineOk + +`func (o *Account) GetIsMachineOk() (*bool, bool)` + +GetIsMachineOk returns a tuple with the IsMachine field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsMachine + +`func (o *Account) SetIsMachine(v bool)` + +SetIsMachine sets IsMachine field to given value. + +### HasIsMachine + +`func (o *Account) HasIsMachine() bool` + +HasIsMachine returns a boolean if a field has been set. + +### GetRecommendation + +`func (o *Account) GetRecommendation() Recommendation` + +GetRecommendation returns the Recommendation field if non-nil, zero value otherwise. + +### GetRecommendationOk + +`func (o *Account) GetRecommendationOk() (*Recommendation, bool)` + +GetRecommendationOk returns a tuple with the Recommendation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendation + +`func (o *Account) SetRecommendation(v Recommendation)` + +SetRecommendation sets Recommendation field to given value. + +### HasRecommendation + +`func (o *Account) HasRecommendation() bool` + +HasRecommendation returns a boolean if a field has been set. + +### SetRecommendationNil + +`func (o *Account) SetRecommendationNil(b bool)` + + SetRecommendationNil sets the value for Recommendation to be an explicit nil + +### UnsetRecommendation +`func (o *Account) UnsetRecommendation()` + +UnsetRecommendation ensures that no value is present for Recommendation, not even an explicit nil +### GetAttributes + +`func (o *Account) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Account) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Account) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *Account) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *Account) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetAuthoritative + +`func (o *Account) GetAuthoritative() bool` + +GetAuthoritative returns the Authoritative field if non-nil, zero value otherwise. + +### GetAuthoritativeOk + +`func (o *Account) GetAuthoritativeOk() (*bool, bool)` + +GetAuthoritativeOk returns a tuple with the Authoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritative + +`func (o *Account) SetAuthoritative(v bool)` + +SetAuthoritative sets Authoritative field to given value. + + +### GetDescription + +`func (o *Account) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Account) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Account) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Account) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Account) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Account) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetDisabled + +`func (o *Account) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *Account) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *Account) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + + +### GetLocked + +`func (o *Account) GetLocked() bool` + +GetLocked returns the Locked field if non-nil, zero value otherwise. + +### GetLockedOk + +`func (o *Account) GetLockedOk() (*bool, bool)` + +GetLockedOk returns a tuple with the Locked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocked + +`func (o *Account) SetLocked(v bool)` + +SetLocked sets Locked field to given value. + + +### GetNativeIdentity + +`func (o *Account) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *Account) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *Account) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + + +### GetSystemAccount + +`func (o *Account) GetSystemAccount() bool` + +GetSystemAccount returns the SystemAccount field if non-nil, zero value otherwise. + +### GetSystemAccountOk + +`func (o *Account) GetSystemAccountOk() (*bool, bool)` + +GetSystemAccountOk returns a tuple with the SystemAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSystemAccount + +`func (o *Account) SetSystemAccount(v bool)` + +SetSystemAccount sets SystemAccount field to given value. + + +### GetUncorrelated + +`func (o *Account) GetUncorrelated() bool` + +GetUncorrelated returns the Uncorrelated field if non-nil, zero value otherwise. + +### GetUncorrelatedOk + +`func (o *Account) GetUncorrelatedOk() (*bool, bool)` + +GetUncorrelatedOk returns a tuple with the Uncorrelated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUncorrelated + +`func (o *Account) SetUncorrelated(v bool)` + +SetUncorrelated sets Uncorrelated field to given value. + + +### GetUuid + +`func (o *Account) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *Account) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *Account) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *Account) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *Account) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *Account) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetManuallyCorrelated + +`func (o *Account) GetManuallyCorrelated() bool` + +GetManuallyCorrelated returns the ManuallyCorrelated field if non-nil, zero value otherwise. + +### GetManuallyCorrelatedOk + +`func (o *Account) GetManuallyCorrelatedOk() (*bool, bool)` + +GetManuallyCorrelatedOk returns a tuple with the ManuallyCorrelated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyCorrelated + +`func (o *Account) SetManuallyCorrelated(v bool)` + +SetManuallyCorrelated sets ManuallyCorrelated field to given value. + + +### GetHasEntitlements + +`func (o *Account) GetHasEntitlements() bool` + +GetHasEntitlements returns the HasEntitlements field if non-nil, zero value otherwise. + +### GetHasEntitlementsOk + +`func (o *Account) GetHasEntitlementsOk() (*bool, bool)` + +GetHasEntitlementsOk returns a tuple with the HasEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasEntitlements + +`func (o *Account) SetHasEntitlements(v bool)` + +SetHasEntitlements sets HasEntitlements field to given value. + + +### GetIdentity + +`func (o *Account) GetIdentity() BaseReferenceDto` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *Account) GetIdentityOk() (*BaseReferenceDto, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *Account) SetIdentity(v BaseReferenceDto)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *Account) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetSourceOwner + +`func (o *Account) GetSourceOwner() BaseReferenceDto` + +GetSourceOwner returns the SourceOwner field if non-nil, zero value otherwise. + +### GetSourceOwnerOk + +`func (o *Account) GetSourceOwnerOk() (*BaseReferenceDto, bool)` + +GetSourceOwnerOk returns a tuple with the SourceOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceOwner + +`func (o *Account) SetSourceOwner(v BaseReferenceDto)` + +SetSourceOwner sets SourceOwner field to given value. + +### HasSourceOwner + +`func (o *Account) HasSourceOwner() bool` + +HasSourceOwner returns a boolean if a field has been set. + +### GetFeatures + +`func (o *Account) GetFeatures() string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *Account) GetFeaturesOk() (*string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *Account) SetFeatures(v string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *Account) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### SetFeaturesNil + +`func (o *Account) SetFeaturesNil(b bool)` + + SetFeaturesNil sets the value for Features to be an explicit nil + +### UnsetFeatures +`func (o *Account) UnsetFeatures()` + +UnsetFeatures ensures that no value is present for Features, not even an explicit nil +### GetOrigin + +`func (o *Account) GetOrigin() string` + +GetOrigin returns the Origin field if non-nil, zero value otherwise. + +### GetOriginOk + +`func (o *Account) GetOriginOk() (*string, bool)` + +GetOriginOk returns a tuple with the Origin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrigin + +`func (o *Account) SetOrigin(v string)` + +SetOrigin sets Origin field to given value. + +### HasOrigin + +`func (o *Account) HasOrigin() bool` + +HasOrigin returns a boolean if a field has been set. + +### SetOriginNil + +`func (o *Account) SetOriginNil(b bool)` + + SetOriginNil sets the value for Origin to be an explicit nil + +### UnsetOrigin +`func (o *Account) UnsetOrigin()` + +UnsetOrigin ensures that no value is present for Origin, not even an explicit nil +### GetOwnerIdentity + +`func (o *Account) GetOwnerIdentity() BaseReferenceDto` + +GetOwnerIdentity returns the OwnerIdentity field if non-nil, zero value otherwise. + +### GetOwnerIdentityOk + +`func (o *Account) GetOwnerIdentityOk() (*BaseReferenceDto, bool)` + +GetOwnerIdentityOk returns a tuple with the OwnerIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerIdentity + +`func (o *Account) SetOwnerIdentity(v BaseReferenceDto)` + +SetOwnerIdentity sets OwnerIdentity field to given value. + +### HasOwnerIdentity + +`func (o *Account) HasOwnerIdentity() bool` + +HasOwnerIdentity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountAction.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountAction.md new file mode 100644 index 000000000..609379825 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountAction.md @@ -0,0 +1,90 @@ +--- +id: beta-account-action +title: AccountAction +pagination_label: AccountAction +sidebar_label: AccountAction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAction', 'BetaAccountAction'] +slug: /tools/sdk/go/beta/models/account-action +tags: ['SDK', 'Software Development Kit', 'AccountAction', 'BetaAccountAction'] +--- + +# AccountAction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Action** | Pointer to **string** | Describes if action will be enabled or disabled | [optional] +**SourceIds** | Pointer to **[]string** | List of source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features. | [optional] + +## Methods + +### NewAccountAction + +`func NewAccountAction() *AccountAction` + +NewAccountAction instantiates a new AccountAction 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 + +### NewAccountActionWithDefaults + +`func NewAccountActionWithDefaults() *AccountAction` + +NewAccountActionWithDefaults instantiates a new AccountAction 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 + +### GetAction + +`func (o *AccountAction) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *AccountAction) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *AccountAction) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *AccountAction) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetSourceIds + +`func (o *AccountAction) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *AccountAction) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *AccountAction) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *AccountAction) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountActivityApprovalStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountActivityApprovalStatus.md new file mode 100644 index 000000000..029d7d541 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountActivityApprovalStatus.md @@ -0,0 +1,29 @@ +--- +id: beta-account-activity-approval-status +title: AccountActivityApprovalStatus +pagination_label: AccountActivityApprovalStatus +sidebar_label: AccountActivityApprovalStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivityApprovalStatus', 'BetaAccountActivityApprovalStatus'] +slug: /tools/sdk/go/beta/models/account-activity-approval-status +tags: ['SDK', 'Software Development Kit', 'AccountActivityApprovalStatus', 'BetaAccountActivityApprovalStatus'] +--- + +# AccountActivityApprovalStatus + +## Enum + + +* `FINISHED` (value: `"FINISHED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `RETURNED` (value: `"RETURNED"`) + +* `EXPIRED` (value: `"EXPIRED"`) + +* `PENDING` (value: `"PENDING"`) + +* `CANCELED` (value: `"CANCELED"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountActivityItem.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountActivityItem.md new file mode 100644 index 000000000..7ed3bac56 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountActivityItem.md @@ -0,0 +1,564 @@ +--- +id: beta-account-activity-item +title: AccountActivityItem +pagination_label: AccountActivityItem +sidebar_label: AccountActivityItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivityItem', 'BetaAccountActivityItem'] +slug: /tools/sdk/go/beta/models/account-activity-item +tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'BetaAccountActivityItem'] +--- + +# AccountActivityItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Item id | [optional] +**Name** | Pointer to **string** | Human-readable display name of item | [optional] +**Requested** | Pointer to **SailPointTime** | Date and time item was requested | [optional] +**ApprovalStatus** | Pointer to [**NullableAccountActivityApprovalStatus**](account-activity-approval-status) | | [optional] +**ProvisioningStatus** | Pointer to [**ProvisioningState**](provisioning-state) | | [optional] +**RequesterComment** | Pointer to [**NullableComment**](comment) | | [optional] +**ReviewerIdentitySummary** | Pointer to [**NullableIdentitySummary**](identity-summary) | | [optional] +**ReviewerComment** | Pointer to [**NullableComment**](comment) | | [optional] +**Operation** | Pointer to [**NullableAccountActivityItemOperation**](account-activity-item-operation) | | [optional] +**Attribute** | Pointer to **NullableString** | Attribute to which account activity applies | [optional] +**Value** | Pointer to **NullableString** | Value of attribute | [optional] +**NativeIdentity** | Pointer to **NullableString** | Native identity in the target system to which the account activity applies | [optional] +**SourceId** | Pointer to **string** | Id of Source to which account activity applies | [optional] +**AccountRequestInfo** | Pointer to [**NullableAccountRequestInfo**](account-request-info) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional] +**RemoveDate** | Pointer to **NullableTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] + +## Methods + +### NewAccountActivityItem + +`func NewAccountActivityItem() *AccountActivityItem` + +NewAccountActivityItem instantiates a new AccountActivityItem 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 + +### NewAccountActivityItemWithDefaults + +`func NewAccountActivityItemWithDefaults() *AccountActivityItem` + +NewAccountActivityItemWithDefaults instantiates a new AccountActivityItem 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 + +### GetId + +`func (o *AccountActivityItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountActivityItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountActivityItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountActivityItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccountActivityItem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountActivityItem) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountActivityItem) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountActivityItem) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetRequested + +`func (o *AccountActivityItem) GetRequested() SailPointTime` + +GetRequested returns the Requested field if non-nil, zero value otherwise. + +### GetRequestedOk + +`func (o *AccountActivityItem) GetRequestedOk() (*SailPointTime, bool)` + +GetRequestedOk returns a tuple with the Requested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequested + +`func (o *AccountActivityItem) SetRequested(v SailPointTime)` + +SetRequested sets Requested field to given value. + +### HasRequested + +`func (o *AccountActivityItem) HasRequested() bool` + +HasRequested returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *AccountActivityItem) GetApprovalStatus() AccountActivityApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *AccountActivityItem) GetApprovalStatusOk() (*AccountActivityApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *AccountActivityItem) SetApprovalStatus(v AccountActivityApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *AccountActivityItem) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### SetApprovalStatusNil + +`func (o *AccountActivityItem) SetApprovalStatusNil(b bool)` + + SetApprovalStatusNil sets the value for ApprovalStatus to be an explicit nil + +### UnsetApprovalStatus +`func (o *AccountActivityItem) UnsetApprovalStatus()` + +UnsetApprovalStatus ensures that no value is present for ApprovalStatus, not even an explicit nil +### GetProvisioningStatus + +`func (o *AccountActivityItem) GetProvisioningStatus() ProvisioningState` + +GetProvisioningStatus returns the ProvisioningStatus field if non-nil, zero value otherwise. + +### GetProvisioningStatusOk + +`func (o *AccountActivityItem) GetProvisioningStatusOk() (*ProvisioningState, bool)` + +GetProvisioningStatusOk returns a tuple with the ProvisioningStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningStatus + +`func (o *AccountActivityItem) SetProvisioningStatus(v ProvisioningState)` + +SetProvisioningStatus sets ProvisioningStatus field to given value. + +### HasProvisioningStatus + +`func (o *AccountActivityItem) HasProvisioningStatus() bool` + +HasProvisioningStatus returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *AccountActivityItem) GetRequesterComment() Comment` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *AccountActivityItem) GetRequesterCommentOk() (*Comment, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *AccountActivityItem) SetRequesterComment(v Comment)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *AccountActivityItem) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### SetRequesterCommentNil + +`func (o *AccountActivityItem) SetRequesterCommentNil(b bool)` + + SetRequesterCommentNil sets the value for RequesterComment to be an explicit nil + +### UnsetRequesterComment +`func (o *AccountActivityItem) UnsetRequesterComment()` + +UnsetRequesterComment ensures that no value is present for RequesterComment, not even an explicit nil +### GetReviewerIdentitySummary + +`func (o *AccountActivityItem) GetReviewerIdentitySummary() IdentitySummary` + +GetReviewerIdentitySummary returns the ReviewerIdentitySummary field if non-nil, zero value otherwise. + +### GetReviewerIdentitySummaryOk + +`func (o *AccountActivityItem) GetReviewerIdentitySummaryOk() (*IdentitySummary, bool)` + +GetReviewerIdentitySummaryOk returns a tuple with the ReviewerIdentitySummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerIdentitySummary + +`func (o *AccountActivityItem) SetReviewerIdentitySummary(v IdentitySummary)` + +SetReviewerIdentitySummary sets ReviewerIdentitySummary field to given value. + +### HasReviewerIdentitySummary + +`func (o *AccountActivityItem) HasReviewerIdentitySummary() bool` + +HasReviewerIdentitySummary returns a boolean if a field has been set. + +### SetReviewerIdentitySummaryNil + +`func (o *AccountActivityItem) SetReviewerIdentitySummaryNil(b bool)` + + SetReviewerIdentitySummaryNil sets the value for ReviewerIdentitySummary to be an explicit nil + +### UnsetReviewerIdentitySummary +`func (o *AccountActivityItem) UnsetReviewerIdentitySummary()` + +UnsetReviewerIdentitySummary ensures that no value is present for ReviewerIdentitySummary, not even an explicit nil +### GetReviewerComment + +`func (o *AccountActivityItem) GetReviewerComment() Comment` + +GetReviewerComment returns the ReviewerComment field if non-nil, zero value otherwise. + +### GetReviewerCommentOk + +`func (o *AccountActivityItem) GetReviewerCommentOk() (*Comment, bool)` + +GetReviewerCommentOk returns a tuple with the ReviewerComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerComment + +`func (o *AccountActivityItem) SetReviewerComment(v Comment)` + +SetReviewerComment sets ReviewerComment field to given value. + +### HasReviewerComment + +`func (o *AccountActivityItem) HasReviewerComment() bool` + +HasReviewerComment returns a boolean if a field has been set. + +### SetReviewerCommentNil + +`func (o *AccountActivityItem) SetReviewerCommentNil(b bool)` + + SetReviewerCommentNil sets the value for ReviewerComment to be an explicit nil + +### UnsetReviewerComment +`func (o *AccountActivityItem) UnsetReviewerComment()` + +UnsetReviewerComment ensures that no value is present for ReviewerComment, not even an explicit nil +### GetOperation + +`func (o *AccountActivityItem) GetOperation() AccountActivityItemOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *AccountActivityItem) GetOperationOk() (*AccountActivityItemOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *AccountActivityItem) SetOperation(v AccountActivityItemOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *AccountActivityItem) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### SetOperationNil + +`func (o *AccountActivityItem) SetOperationNil(b bool)` + + SetOperationNil sets the value for Operation to be an explicit nil + +### UnsetOperation +`func (o *AccountActivityItem) UnsetOperation()` + +UnsetOperation ensures that no value is present for Operation, not even an explicit nil +### GetAttribute + +`func (o *AccountActivityItem) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *AccountActivityItem) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *AccountActivityItem) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *AccountActivityItem) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *AccountActivityItem) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *AccountActivityItem) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *AccountActivityItem) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AccountActivityItem) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AccountActivityItem) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AccountActivityItem) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *AccountActivityItem) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *AccountActivityItem) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetNativeIdentity + +`func (o *AccountActivityItem) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountActivityItem) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountActivityItem) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccountActivityItem) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### SetNativeIdentityNil + +`func (o *AccountActivityItem) SetNativeIdentityNil(b bool)` + + SetNativeIdentityNil sets the value for NativeIdentity to be an explicit nil + +### UnsetNativeIdentity +`func (o *AccountActivityItem) UnsetNativeIdentity()` + +UnsetNativeIdentity ensures that no value is present for NativeIdentity, not even an explicit nil +### GetSourceId + +`func (o *AccountActivityItem) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccountActivityItem) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccountActivityItem) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccountActivityItem) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetAccountRequestInfo + +`func (o *AccountActivityItem) GetAccountRequestInfo() AccountRequestInfo` + +GetAccountRequestInfo returns the AccountRequestInfo field if non-nil, zero value otherwise. + +### GetAccountRequestInfoOk + +`func (o *AccountActivityItem) GetAccountRequestInfoOk() (*AccountRequestInfo, bool)` + +GetAccountRequestInfoOk returns a tuple with the AccountRequestInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountRequestInfo + +`func (o *AccountActivityItem) SetAccountRequestInfo(v AccountRequestInfo)` + +SetAccountRequestInfo sets AccountRequestInfo field to given value. + +### HasAccountRequestInfo + +`func (o *AccountActivityItem) HasAccountRequestInfo() bool` + +HasAccountRequestInfo returns a boolean if a field has been set. + +### SetAccountRequestInfoNil + +`func (o *AccountActivityItem) SetAccountRequestInfoNil(b bool)` + + SetAccountRequestInfoNil sets the value for AccountRequestInfo to be an explicit nil + +### UnsetAccountRequestInfo +`func (o *AccountActivityItem) UnsetAccountRequestInfo()` + +UnsetAccountRequestInfo ensures that no value is present for AccountRequestInfo, not even an explicit nil +### GetClientMetadata + +`func (o *AccountActivityItem) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccountActivityItem) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccountActivityItem) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccountActivityItem) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *AccountActivityItem) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *AccountActivityItem) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetRemoveDate + +`func (o *AccountActivityItem) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccountActivityItem) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccountActivityItem) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccountActivityItem) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *AccountActivityItem) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *AccountActivityItem) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountActivityItemOperation.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountActivityItemOperation.md new file mode 100644 index 000000000..416b56b58 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountActivityItemOperation.md @@ -0,0 +1,37 @@ +--- +id: beta-account-activity-item-operation +title: AccountActivityItemOperation +pagination_label: AccountActivityItemOperation +sidebar_label: AccountActivityItemOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivityItemOperation', 'BetaAccountActivityItemOperation'] +slug: /tools/sdk/go/beta/models/account-activity-item-operation +tags: ['SDK', 'Software Development Kit', 'AccountActivityItemOperation', 'BetaAccountActivityItemOperation'] +--- + +# AccountActivityItemOperation + +## Enum + + +* `ADD` (value: `"ADD"`) + +* `CREATE` (value: `"CREATE"`) + +* `MODIFY` (value: `"MODIFY"`) + +* `DELETE` (value: `"DELETE"`) + +* `DISABLE` (value: `"DISABLE"`) + +* `ENABLE` (value: `"ENABLE"`) + +* `UNLOCK` (value: `"UNLOCK"`) + +* `LOCK` (value: `"LOCK"`) + +* `REMOVE` (value: `"REMOVE"`) + +* `SET` (value: `"SET"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountAggregation.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountAggregation.md new file mode 100644 index 000000000..5c26d5b5f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountAggregation.md @@ -0,0 +1,142 @@ +--- +id: beta-account-aggregation +title: AccountAggregation +pagination_label: AccountAggregation +sidebar_label: AccountAggregation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAggregation', 'BetaAccountAggregation'] +slug: /tools/sdk/go/beta/models/account-aggregation +tags: ['SDK', 'Software Development Kit', 'AccountAggregation', 'BetaAccountAggregation'] +--- + +# AccountAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **SailPointTime** | When the aggregation started. | [optional] +**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] + +## Methods + +### NewAccountAggregation + +`func NewAccountAggregation() *AccountAggregation` + +NewAccountAggregation instantiates a new AccountAggregation 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 + +### NewAccountAggregationWithDefaults + +`func NewAccountAggregationWithDefaults() *AccountAggregation` + +NewAccountAggregationWithDefaults instantiates a new AccountAggregation 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 + +### GetStart + +`func (o *AccountAggregation) GetStart() SailPointTime` + +GetStart returns the Start field if non-nil, zero value otherwise. + +### GetStartOk + +`func (o *AccountAggregation) GetStartOk() (*SailPointTime, bool)` + +GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStart + +`func (o *AccountAggregation) SetStart(v SailPointTime)` + +SetStart sets Start field to given value. + +### HasStart + +`func (o *AccountAggregation) HasStart() bool` + +HasStart returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccountAggregation) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountAggregation) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountAggregation) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccountAggregation) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetTotalAccounts + +`func (o *AccountAggregation) GetTotalAccounts() int32` + +GetTotalAccounts returns the TotalAccounts field if non-nil, zero value otherwise. + +### GetTotalAccountsOk + +`func (o *AccountAggregation) GetTotalAccountsOk() (*int32, bool)` + +GetTotalAccountsOk returns a tuple with the TotalAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalAccounts + +`func (o *AccountAggregation) SetTotalAccounts(v int32)` + +SetTotalAccounts sets TotalAccounts field to given value. + +### HasTotalAccounts + +`func (o *AccountAggregation) HasTotalAccounts() bool` + +HasTotalAccounts returns a boolean if a field has been set. + +### GetProcessedAccounts + +`func (o *AccountAggregation) GetProcessedAccounts() int32` + +GetProcessedAccounts returns the ProcessedAccounts field if non-nil, zero value otherwise. + +### GetProcessedAccountsOk + +`func (o *AccountAggregation) GetProcessedAccountsOk() (*int32, bool)` + +GetProcessedAccountsOk returns a tuple with the ProcessedAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessedAccounts + +`func (o *AccountAggregation) SetProcessedAccounts(v int32)` + +SetProcessedAccounts sets ProcessedAccounts field to given value. + +### HasProcessedAccounts + +`func (o *AccountAggregation) HasProcessedAccounts() bool` + +HasProcessedAccounts returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountAggregationCompleted.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountAggregationCompleted.md new file mode 100644 index 000000000..5b77f3741 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountAggregationCompleted.md @@ -0,0 +1,205 @@ +--- +id: beta-account-aggregation-completed +title: AccountAggregationCompleted +pagination_label: AccountAggregationCompleted +sidebar_label: AccountAggregationCompleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAggregationCompleted', 'BetaAccountAggregationCompleted'] +slug: /tools/sdk/go/beta/models/account-aggregation-completed +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompleted', 'BetaAccountAggregationCompleted'] +--- + +# AccountAggregationCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**AccountAggregationCompletedSource**](account-aggregation-completed-source) | | +**Status** | **map[string]interface{}** | Aggregation's overall status. | +**Started** | **SailPointTime** | Date and time when the account aggregation started. | +**Completed** | **SailPointTime** | Date and time when the account aggregation finished. | +**Errors** | **[]string** | List of errors that occurred during the aggregation. | +**Warnings** | **[]string** | List of warnings that occurred during the aggregation. | +**Stats** | [**AccountAggregationCompletedStats**](account-aggregation-completed-stats) | | + +## Methods + +### NewAccountAggregationCompleted + +`func NewAccountAggregationCompleted(source AccountAggregationCompletedSource, status map[string]interface{}, started SailPointTime, completed SailPointTime, errors []string, warnings []string, stats AccountAggregationCompletedStats, ) *AccountAggregationCompleted` + +NewAccountAggregationCompleted instantiates a new AccountAggregationCompleted 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 + +### NewAccountAggregationCompletedWithDefaults + +`func NewAccountAggregationCompletedWithDefaults() *AccountAggregationCompleted` + +NewAccountAggregationCompletedWithDefaults instantiates a new AccountAggregationCompleted 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 + +### GetSource + +`func (o *AccountAggregationCompleted) GetSource() AccountAggregationCompletedSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountAggregationCompleted) GetSourceOk() (*AccountAggregationCompletedSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountAggregationCompleted) SetSource(v AccountAggregationCompletedSource)` + +SetSource sets Source field to given value. + + +### GetStatus + +`func (o *AccountAggregationCompleted) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountAggregationCompleted) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountAggregationCompleted) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + +### GetStarted + +`func (o *AccountAggregationCompleted) GetStarted() SailPointTime` + +GetStarted returns the Started field if non-nil, zero value otherwise. + +### GetStartedOk + +`func (o *AccountAggregationCompleted) GetStartedOk() (*SailPointTime, bool)` + +GetStartedOk returns a tuple with the Started field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStarted + +`func (o *AccountAggregationCompleted) SetStarted(v SailPointTime)` + +SetStarted sets Started field to given value. + + +### GetCompleted + +`func (o *AccountAggregationCompleted) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *AccountAggregationCompleted) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *AccountAggregationCompleted) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + + +### GetErrors + +`func (o *AccountAggregationCompleted) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountAggregationCompleted) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountAggregationCompleted) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + + +### SetErrorsNil + +`func (o *AccountAggregationCompleted) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *AccountAggregationCompleted) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *AccountAggregationCompleted) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *AccountAggregationCompleted) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *AccountAggregationCompleted) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + + +### SetWarningsNil + +`func (o *AccountAggregationCompleted) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *AccountAggregationCompleted) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetStats + +`func (o *AccountAggregationCompleted) GetStats() AccountAggregationCompletedStats` + +GetStats returns the Stats field if non-nil, zero value otherwise. + +### GetStatsOk + +`func (o *AccountAggregationCompleted) GetStatsOk() (*AccountAggregationCompletedStats, bool)` + +GetStatsOk returns a tuple with the Stats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStats + +`func (o *AccountAggregationCompleted) SetStats(v AccountAggregationCompletedStats)` + +SetStats sets Stats field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountAggregationCompletedSource.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountAggregationCompletedSource.md new file mode 100644 index 000000000..1c8506929 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountAggregationCompletedSource.md @@ -0,0 +1,101 @@ +--- +id: beta-account-aggregation-completed-source +title: AccountAggregationCompletedSource +pagination_label: AccountAggregationCompletedSource +sidebar_label: AccountAggregationCompletedSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAggregationCompletedSource', 'BetaAccountAggregationCompletedSource'] +slug: /tools/sdk/go/beta/models/account-aggregation-completed-source +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedSource', 'BetaAccountAggregationCompletedSource'] +--- + +# AccountAggregationCompletedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Source's DTO type. | +**Id** | **string** | Source's unique ID. | +**Name** | **string** | Source's name. | + +## Methods + +### NewAccountAggregationCompletedSource + +`func NewAccountAggregationCompletedSource(type_ string, id string, name string, ) *AccountAggregationCompletedSource` + +NewAccountAggregationCompletedSource instantiates a new AccountAggregationCompletedSource 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 + +### NewAccountAggregationCompletedSourceWithDefaults + +`func NewAccountAggregationCompletedSourceWithDefaults() *AccountAggregationCompletedSource` + +NewAccountAggregationCompletedSourceWithDefaults instantiates a new AccountAggregationCompletedSource 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 + +### GetType + +`func (o *AccountAggregationCompletedSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAggregationCompletedSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAggregationCompletedSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountAggregationCompletedSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAggregationCompletedSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAggregationCompletedSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountAggregationCompletedSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAggregationCompletedSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAggregationCompletedSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountAggregationCompletedStats.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountAggregationCompletedStats.md new file mode 100644 index 000000000..603767832 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountAggregationCompletedStats.md @@ -0,0 +1,143 @@ +--- +id: beta-account-aggregation-completed-stats +title: AccountAggregationCompletedStats +pagination_label: AccountAggregationCompletedStats +sidebar_label: AccountAggregationCompletedStats +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAggregationCompletedStats', 'BetaAccountAggregationCompletedStats'] +slug: /tools/sdk/go/beta/models/account-aggregation-completed-stats +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedStats', 'BetaAccountAggregationCompletedStats'] +--- + +# AccountAggregationCompletedStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scanned** | **int32** | Number of accounts scanned/iterated over. | +**Unchanged** | **int32** | Number of accounts that existed before but had no changes. | +**Changed** | **int32** | Number of accounts that existed before but had changes. | +**Added** | **int32** | Number of accounts that are new and didn't previously exist. | +**Removed** | **int32** | Number accounts that existed before but were removed and no longer exist. | + +## Methods + +### NewAccountAggregationCompletedStats + +`func NewAccountAggregationCompletedStats(scanned int32, unchanged int32, changed int32, added int32, removed int32, ) *AccountAggregationCompletedStats` + +NewAccountAggregationCompletedStats instantiates a new AccountAggregationCompletedStats 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 + +### NewAccountAggregationCompletedStatsWithDefaults + +`func NewAccountAggregationCompletedStatsWithDefaults() *AccountAggregationCompletedStats` + +NewAccountAggregationCompletedStatsWithDefaults instantiates a new AccountAggregationCompletedStats 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 + +### GetScanned + +`func (o *AccountAggregationCompletedStats) GetScanned() int32` + +GetScanned returns the Scanned field if non-nil, zero value otherwise. + +### GetScannedOk + +`func (o *AccountAggregationCompletedStats) GetScannedOk() (*int32, bool)` + +GetScannedOk returns a tuple with the Scanned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScanned + +`func (o *AccountAggregationCompletedStats) SetScanned(v int32)` + +SetScanned sets Scanned field to given value. + + +### GetUnchanged + +`func (o *AccountAggregationCompletedStats) GetUnchanged() int32` + +GetUnchanged returns the Unchanged field if non-nil, zero value otherwise. + +### GetUnchangedOk + +`func (o *AccountAggregationCompletedStats) GetUnchangedOk() (*int32, bool)` + +GetUnchangedOk returns a tuple with the Unchanged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnchanged + +`func (o *AccountAggregationCompletedStats) SetUnchanged(v int32)` + +SetUnchanged sets Unchanged field to given value. + + +### GetChanged + +`func (o *AccountAggregationCompletedStats) GetChanged() int32` + +GetChanged returns the Changed field if non-nil, zero value otherwise. + +### GetChangedOk + +`func (o *AccountAggregationCompletedStats) GetChangedOk() (*int32, bool)` + +GetChangedOk returns a tuple with the Changed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanged + +`func (o *AccountAggregationCompletedStats) SetChanged(v int32)` + +SetChanged sets Changed field to given value. + + +### GetAdded + +`func (o *AccountAggregationCompletedStats) GetAdded() int32` + +GetAdded returns the Added field if non-nil, zero value otherwise. + +### GetAddedOk + +`func (o *AccountAggregationCompletedStats) GetAddedOk() (*int32, bool)` + +GetAddedOk returns a tuple with the Added field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAdded + +`func (o *AccountAggregationCompletedStats) SetAdded(v int32)` + +SetAdded sets Added field to given value. + + +### GetRemoved + +`func (o *AccountAggregationCompletedStats) GetRemoved() int32` + +GetRemoved returns the Removed field if non-nil, zero value otherwise. + +### GetRemovedOk + +`func (o *AccountAggregationCompletedStats) GetRemovedOk() (*int32, bool)` + +GetRemovedOk returns a tuple with the Removed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoved + +`func (o *AccountAggregationCompletedStats) SetRemoved(v int32)` + +SetRemoved sets Removed field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountAggregationStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountAggregationStatus.md new file mode 100644 index 000000000..7611876a5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountAggregationStatus.md @@ -0,0 +1,142 @@ +--- +id: beta-account-aggregation-status +title: AccountAggregationStatus +pagination_label: AccountAggregationStatus +sidebar_label: AccountAggregationStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAggregationStatus', 'BetaAccountAggregationStatus'] +slug: /tools/sdk/go/beta/models/account-aggregation-status +tags: ['SDK', 'Software Development Kit', 'AccountAggregationStatus', 'BetaAccountAggregationStatus'] +--- + +# AccountAggregationStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **SailPointTime** | When the aggregation started. | [optional] +**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] + +## Methods + +### NewAccountAggregationStatus + +`func NewAccountAggregationStatus() *AccountAggregationStatus` + +NewAccountAggregationStatus instantiates a new AccountAggregationStatus 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 + +### NewAccountAggregationStatusWithDefaults + +`func NewAccountAggregationStatusWithDefaults() *AccountAggregationStatus` + +NewAccountAggregationStatusWithDefaults instantiates a new AccountAggregationStatus 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 + +### GetStart + +`func (o *AccountAggregationStatus) GetStart() SailPointTime` + +GetStart returns the Start field if non-nil, zero value otherwise. + +### GetStartOk + +`func (o *AccountAggregationStatus) GetStartOk() (*SailPointTime, bool)` + +GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStart + +`func (o *AccountAggregationStatus) SetStart(v SailPointTime)` + +SetStart sets Start field to given value. + +### HasStart + +`func (o *AccountAggregationStatus) HasStart() bool` + +HasStart returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccountAggregationStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountAggregationStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountAggregationStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccountAggregationStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetTotalAccounts + +`func (o *AccountAggregationStatus) GetTotalAccounts() int32` + +GetTotalAccounts returns the TotalAccounts field if non-nil, zero value otherwise. + +### GetTotalAccountsOk + +`func (o *AccountAggregationStatus) GetTotalAccountsOk() (*int32, bool)` + +GetTotalAccountsOk returns a tuple with the TotalAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalAccounts + +`func (o *AccountAggregationStatus) SetTotalAccounts(v int32)` + +SetTotalAccounts sets TotalAccounts field to given value. + +### HasTotalAccounts + +`func (o *AccountAggregationStatus) HasTotalAccounts() bool` + +HasTotalAccounts returns a boolean if a field has been set. + +### GetProcessedAccounts + +`func (o *AccountAggregationStatus) GetProcessedAccounts() int32` + +GetProcessedAccounts returns the ProcessedAccounts field if non-nil, zero value otherwise. + +### GetProcessedAccountsOk + +`func (o *AccountAggregationStatus) GetProcessedAccountsOk() (*int32, bool)` + +GetProcessedAccountsOk returns a tuple with the ProcessedAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessedAccounts + +`func (o *AccountAggregationStatus) SetProcessedAccounts(v int32)` + +SetProcessedAccounts sets ProcessedAccounts field to given value. + +### HasProcessedAccounts + +`func (o *AccountAggregationStatus) HasProcessedAccounts() bool` + +HasProcessedAccounts returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributes.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributes.md new file mode 100644 index 000000000..387545d3e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributes.md @@ -0,0 +1,59 @@ +--- +id: beta-account-attributes +title: AccountAttributes +pagination_label: AccountAttributes +sidebar_label: AccountAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributes', 'BetaAccountAttributes'] +slug: /tools/sdk/go/beta/models/account-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributes', 'BetaAccountAttributes'] +--- + +# AccountAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | **map[string]interface{}** | The schema attribute values for the account | + +## Methods + +### NewAccountAttributes + +`func NewAccountAttributes(attributes map[string]interface{}, ) *AccountAttributes` + +NewAccountAttributes instantiates a new AccountAttributes 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 + +### NewAccountAttributesWithDefaults + +`func NewAccountAttributesWithDefaults() *AccountAttributes` + +NewAccountAttributesWithDefaults instantiates a new AccountAttributes 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 + +### GetAttributes + +`func (o *AccountAttributes) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AccountAttributes) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AccountAttributes) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChanged.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChanged.md new file mode 100644 index 000000000..07e35ee34 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChanged.md @@ -0,0 +1,122 @@ +--- +id: beta-account-attributes-changed +title: AccountAttributesChanged +pagination_label: AccountAttributesChanged +sidebar_label: AccountAttributesChanged +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChanged', 'BetaAccountAttributesChanged'] +slug: /tools/sdk/go/beta/models/account-attributes-changed +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChanged', 'BetaAccountAttributesChanged'] +--- + +# AccountAttributesChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**AccountAttributesChangedIdentity**](account-attributes-changed-identity) | | +**Source** | [**AccountAttributesChangedSource**](account-attributes-changed-source) | | +**Account** | [**AccountAttributesChangedAccount**](account-attributes-changed-account) | | +**Changes** | [**[]AccountAttributesChangedChangesInner**](account-attributes-changed-changes-inner) | A list of attributes that changed. | + +## Methods + +### NewAccountAttributesChanged + +`func NewAccountAttributesChanged(identity AccountAttributesChangedIdentity, source AccountAttributesChangedSource, account AccountAttributesChangedAccount, changes []AccountAttributesChangedChangesInner, ) *AccountAttributesChanged` + +NewAccountAttributesChanged instantiates a new AccountAttributesChanged 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 + +### NewAccountAttributesChangedWithDefaults + +`func NewAccountAttributesChangedWithDefaults() *AccountAttributesChanged` + +NewAccountAttributesChangedWithDefaults instantiates a new AccountAttributesChanged 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 + +### GetIdentity + +`func (o *AccountAttributesChanged) GetIdentity() AccountAttributesChangedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *AccountAttributesChanged) GetIdentityOk() (*AccountAttributesChangedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *AccountAttributesChanged) SetIdentity(v AccountAttributesChangedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetSource + +`func (o *AccountAttributesChanged) GetSource() AccountAttributesChangedSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountAttributesChanged) GetSourceOk() (*AccountAttributesChangedSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountAttributesChanged) SetSource(v AccountAttributesChangedSource)` + +SetSource sets Source field to given value. + + +### GetAccount + +`func (o *AccountAttributesChanged) GetAccount() AccountAttributesChangedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *AccountAttributesChanged) GetAccountOk() (*AccountAttributesChangedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *AccountAttributesChanged) SetAccount(v AccountAttributesChangedAccount)` + +SetAccount sets Account field to given value. + + +### GetChanges + +`func (o *AccountAttributesChanged) GetChanges() []AccountAttributesChangedChangesInner` + +GetChanges returns the Changes field if non-nil, zero value otherwise. + +### GetChangesOk + +`func (o *AccountAttributesChanged) GetChangesOk() (*[]AccountAttributesChangedChangesInner, bool)` + +GetChangesOk returns a tuple with the Changes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanges + +`func (o *AccountAttributesChanged) SetChanges(v []AccountAttributesChangedChangesInner)` + +SetChanges sets Changes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedAccount.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedAccount.md new file mode 100644 index 000000000..6db6ce3c8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedAccount.md @@ -0,0 +1,153 @@ +--- +id: beta-account-attributes-changed-account +title: AccountAttributesChangedAccount +pagination_label: AccountAttributesChangedAccount +sidebar_label: AccountAttributesChangedAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedAccount', 'BetaAccountAttributesChangedAccount'] +slug: /tools/sdk/go/beta/models/account-attributes-changed-account +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedAccount', 'BetaAccountAttributesChangedAccount'] +--- + +# AccountAttributesChangedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | SailPoint generated unique identifier. | +**Uuid** | **NullableString** | The source's unique identifier for the account. UUID is generated by the source system. | +**Name** | **string** | Name of the account. | +**NativeIdentity** | **string** | Unique ID of the account on the source. | +**Type** | **map[string]interface{}** | The type of the account | + +## Methods + +### NewAccountAttributesChangedAccount + +`func NewAccountAttributesChangedAccount(id string, uuid NullableString, name string, nativeIdentity string, type_ map[string]interface{}, ) *AccountAttributesChangedAccount` + +NewAccountAttributesChangedAccount instantiates a new AccountAttributesChangedAccount 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 + +### NewAccountAttributesChangedAccountWithDefaults + +`func NewAccountAttributesChangedAccountWithDefaults() *AccountAttributesChangedAccount` + +NewAccountAttributesChangedAccountWithDefaults instantiates a new AccountAttributesChangedAccount 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 + +### GetId + +`func (o *AccountAttributesChangedAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAttributesChangedAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAttributesChangedAccount) SetId(v string)` + +SetId sets Id field to given value. + + +### GetUuid + +`func (o *AccountAttributesChangedAccount) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *AccountAttributesChangedAccount) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *AccountAttributesChangedAccount) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + + +### SetUuidNil + +`func (o *AccountAttributesChangedAccount) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *AccountAttributesChangedAccount) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetName + +`func (o *AccountAttributesChangedAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAttributesChangedAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAttributesChangedAccount) SetName(v string)` + +SetName sets Name field to given value. + + +### GetNativeIdentity + +`func (o *AccountAttributesChangedAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountAttributesChangedAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountAttributesChangedAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + + +### GetType + +`func (o *AccountAttributesChangedAccount) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAttributesChangedAccount) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAttributesChangedAccount) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedChangesInner.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedChangesInner.md new file mode 100644 index 000000000..a7160a3a2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedChangesInner.md @@ -0,0 +1,121 @@ +--- +id: beta-account-attributes-changed-changes-inner +title: AccountAttributesChangedChangesInner +pagination_label: AccountAttributesChangedChangesInner +sidebar_label: AccountAttributesChangedChangesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedChangesInner', 'BetaAccountAttributesChangedChangesInner'] +slug: /tools/sdk/go/beta/models/account-attributes-changed-changes-inner +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInner', 'BetaAccountAttributesChangedChangesInner'] +--- + +# AccountAttributesChangedChangesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | **string** | The name of the attribute. | +**OldValue** | [**NullableAccountAttributesChangedChangesInnerOldValue**](account-attributes-changed-changes-inner-old-value) | | +**NewValue** | [**NullableAccountAttributesChangedChangesInnerNewValue**](account-attributes-changed-changes-inner-new-value) | | + +## Methods + +### NewAccountAttributesChangedChangesInner + +`func NewAccountAttributesChangedChangesInner(attribute string, oldValue NullableAccountAttributesChangedChangesInnerOldValue, newValue NullableAccountAttributesChangedChangesInnerNewValue, ) *AccountAttributesChangedChangesInner` + +NewAccountAttributesChangedChangesInner instantiates a new AccountAttributesChangedChangesInner 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 + +### NewAccountAttributesChangedChangesInnerWithDefaults + +`func NewAccountAttributesChangedChangesInnerWithDefaults() *AccountAttributesChangedChangesInner` + +NewAccountAttributesChangedChangesInnerWithDefaults instantiates a new AccountAttributesChangedChangesInner 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 + +### GetAttribute + +`func (o *AccountAttributesChangedChangesInner) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *AccountAttributesChangedChangesInner) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *AccountAttributesChangedChangesInner) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + + +### GetOldValue + +`func (o *AccountAttributesChangedChangesInner) GetOldValue() AccountAttributesChangedChangesInnerOldValue` + +GetOldValue returns the OldValue field if non-nil, zero value otherwise. + +### GetOldValueOk + +`func (o *AccountAttributesChangedChangesInner) GetOldValueOk() (*AccountAttributesChangedChangesInnerOldValue, bool)` + +GetOldValueOk returns a tuple with the OldValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOldValue + +`func (o *AccountAttributesChangedChangesInner) SetOldValue(v AccountAttributesChangedChangesInnerOldValue)` + +SetOldValue sets OldValue field to given value. + + +### SetOldValueNil + +`func (o *AccountAttributesChangedChangesInner) SetOldValueNil(b bool)` + + SetOldValueNil sets the value for OldValue to be an explicit nil + +### UnsetOldValue +`func (o *AccountAttributesChangedChangesInner) UnsetOldValue()` + +UnsetOldValue ensures that no value is present for OldValue, not even an explicit nil +### GetNewValue + +`func (o *AccountAttributesChangedChangesInner) GetNewValue() AccountAttributesChangedChangesInnerNewValue` + +GetNewValue returns the NewValue field if non-nil, zero value otherwise. + +### GetNewValueOk + +`func (o *AccountAttributesChangedChangesInner) GetNewValueOk() (*AccountAttributesChangedChangesInnerNewValue, bool)` + +GetNewValueOk returns a tuple with the NewValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewValue + +`func (o *AccountAttributesChangedChangesInner) SetNewValue(v AccountAttributesChangedChangesInnerNewValue)` + +SetNewValue sets NewValue field to given value. + + +### SetNewValueNil + +`func (o *AccountAttributesChangedChangesInner) SetNewValueNil(b bool)` + + SetNewValueNil sets the value for NewValue to be an explicit nil + +### UnsetNewValue +`func (o *AccountAttributesChangedChangesInner) UnsetNewValue()` + +UnsetNewValue ensures that no value is present for NewValue, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedChangesInnerNewValue.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedChangesInnerNewValue.md new file mode 100644 index 000000000..533078115 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedChangesInnerNewValue.md @@ -0,0 +1,38 @@ +--- +id: beta-account-attributes-changed-changes-inner-new-value +title: AccountAttributesChangedChangesInnerNewValue +pagination_label: AccountAttributesChangedChangesInnerNewValue +sidebar_label: AccountAttributesChangedChangesInnerNewValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedChangesInnerNewValue', 'BetaAccountAttributesChangedChangesInnerNewValue'] +slug: /tools/sdk/go/beta/models/account-attributes-changed-changes-inner-new-value +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerNewValue', 'BetaAccountAttributesChangedChangesInnerNewValue'] +--- + +# AccountAttributesChangedChangesInnerNewValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewAccountAttributesChangedChangesInnerNewValue + +`func NewAccountAttributesChangedChangesInnerNewValue() *AccountAttributesChangedChangesInnerNewValue` + +NewAccountAttributesChangedChangesInnerNewValue instantiates a new AccountAttributesChangedChangesInnerNewValue 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 + +### NewAccountAttributesChangedChangesInnerNewValueWithDefaults + +`func NewAccountAttributesChangedChangesInnerNewValueWithDefaults() *AccountAttributesChangedChangesInnerNewValue` + +NewAccountAttributesChangedChangesInnerNewValueWithDefaults instantiates a new AccountAttributesChangedChangesInnerNewValue 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 + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedChangesInnerOldValue.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedChangesInnerOldValue.md new file mode 100644 index 000000000..a2ac78f5c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedChangesInnerOldValue.md @@ -0,0 +1,38 @@ +--- +id: beta-account-attributes-changed-changes-inner-old-value +title: AccountAttributesChangedChangesInnerOldValue +pagination_label: AccountAttributesChangedChangesInnerOldValue +sidebar_label: AccountAttributesChangedChangesInnerOldValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedChangesInnerOldValue', 'BetaAccountAttributesChangedChangesInnerOldValue'] +slug: /tools/sdk/go/beta/models/account-attributes-changed-changes-inner-old-value +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerOldValue', 'BetaAccountAttributesChangedChangesInnerOldValue'] +--- + +# AccountAttributesChangedChangesInnerOldValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewAccountAttributesChangedChangesInnerOldValue + +`func NewAccountAttributesChangedChangesInnerOldValue() *AccountAttributesChangedChangesInnerOldValue` + +NewAccountAttributesChangedChangesInnerOldValue instantiates a new AccountAttributesChangedChangesInnerOldValue 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 + +### NewAccountAttributesChangedChangesInnerOldValueWithDefaults + +`func NewAccountAttributesChangedChangesInnerOldValueWithDefaults() *AccountAttributesChangedChangesInnerOldValue` + +NewAccountAttributesChangedChangesInnerOldValueWithDefaults instantiates a new AccountAttributesChangedChangesInnerOldValue 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 + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedIdentity.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedIdentity.md new file mode 100644 index 000000000..7feb5ac39 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedIdentity.md @@ -0,0 +1,101 @@ +--- +id: beta-account-attributes-changed-identity +title: AccountAttributesChangedIdentity +pagination_label: AccountAttributesChangedIdentity +sidebar_label: AccountAttributesChangedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedIdentity', 'BetaAccountAttributesChangedIdentity'] +slug: /tools/sdk/go/beta/models/account-attributes-changed-identity +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedIdentity', 'BetaAccountAttributesChangedIdentity'] +--- + +# AccountAttributesChangedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of the identity whose account attributes were updated. | +**Id** | **string** | ID of the identity whose account attributes were updated. | +**Name** | **string** | Display name of the identity whose account attributes were updated. | + +## Methods + +### NewAccountAttributesChangedIdentity + +`func NewAccountAttributesChangedIdentity(type_ string, id string, name string, ) *AccountAttributesChangedIdentity` + +NewAccountAttributesChangedIdentity instantiates a new AccountAttributesChangedIdentity 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 + +### NewAccountAttributesChangedIdentityWithDefaults + +`func NewAccountAttributesChangedIdentityWithDefaults() *AccountAttributesChangedIdentity` + +NewAccountAttributesChangedIdentityWithDefaults instantiates a new AccountAttributesChangedIdentity 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 + +### GetType + +`func (o *AccountAttributesChangedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAttributesChangedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAttributesChangedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountAttributesChangedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAttributesChangedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAttributesChangedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountAttributesChangedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAttributesChangedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAttributesChangedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedSource.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedSource.md new file mode 100644 index 000000000..7f56092bb --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesChangedSource.md @@ -0,0 +1,101 @@ +--- +id: beta-account-attributes-changed-source +title: AccountAttributesChangedSource +pagination_label: AccountAttributesChangedSource +sidebar_label: AccountAttributesChangedSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedSource', 'BetaAccountAttributesChangedSource'] +slug: /tools/sdk/go/beta/models/account-attributes-changed-source +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedSource', 'BetaAccountAttributesChangedSource'] +--- + +# AccountAttributesChangedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the object to which this reference applies | +**Type** | **string** | The type of object that is referenced | +**Name** | **string** | Human-readable display name of the object to which this reference applies | + +## Methods + +### NewAccountAttributesChangedSource + +`func NewAccountAttributesChangedSource(id string, type_ string, name string, ) *AccountAttributesChangedSource` + +NewAccountAttributesChangedSource instantiates a new AccountAttributesChangedSource 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 + +### NewAccountAttributesChangedSourceWithDefaults + +`func NewAccountAttributesChangedSourceWithDefaults() *AccountAttributesChangedSource` + +NewAccountAttributesChangedSourceWithDefaults instantiates a new AccountAttributesChangedSource 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 + +### GetId + +`func (o *AccountAttributesChangedSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAttributesChangedSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAttributesChangedSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *AccountAttributesChangedSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAttributesChangedSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAttributesChangedSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetName + +`func (o *AccountAttributesChangedSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAttributesChangedSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAttributesChangedSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesCreate.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesCreate.md new file mode 100644 index 000000000..43acb52ff --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesCreate.md @@ -0,0 +1,59 @@ +--- +id: beta-account-attributes-create +title: AccountAttributesCreate +pagination_label: AccountAttributesCreate +sidebar_label: AccountAttributesCreate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesCreate', 'BetaAccountAttributesCreate'] +slug: /tools/sdk/go/beta/models/account-attributes-create +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate', 'BetaAccountAttributesCreate'] +--- + +# AccountAttributesCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | + +## Methods + +### NewAccountAttributesCreate + +`func NewAccountAttributesCreate(attributes AccountAttributesCreateAttributes, ) *AccountAttributesCreate` + +NewAccountAttributesCreate instantiates a new AccountAttributesCreate 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 + +### NewAccountAttributesCreateWithDefaults + +`func NewAccountAttributesCreateWithDefaults() *AccountAttributesCreate` + +NewAccountAttributesCreateWithDefaults instantiates a new AccountAttributesCreate 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 + +### GetAttributes + +`func (o *AccountAttributesCreate) GetAttributes() AccountAttributesCreateAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AccountAttributesCreate) GetAttributesOk() (*AccountAttributesCreateAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AccountAttributesCreate) SetAttributes(v AccountAttributesCreateAttributes)` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesCreateAttributes.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesCreateAttributes.md new file mode 100644 index 000000000..a3a43c428 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountAttributesCreateAttributes.md @@ -0,0 +1,59 @@ +--- +id: beta-account-attributes-create-attributes +title: AccountAttributesCreateAttributes +pagination_label: AccountAttributesCreateAttributes +sidebar_label: AccountAttributesCreateAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesCreateAttributes', 'BetaAccountAttributesCreateAttributes'] +slug: /tools/sdk/go/beta/models/account-attributes-create-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreateAttributes', 'BetaAccountAttributesCreateAttributes'] +--- + +# AccountAttributesCreateAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | **string** | Target source to create an account | + +## Methods + +### NewAccountAttributesCreateAttributes + +`func NewAccountAttributesCreateAttributes(sourceId string, ) *AccountAttributesCreateAttributes` + +NewAccountAttributesCreateAttributes instantiates a new AccountAttributesCreateAttributes 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 + +### NewAccountAttributesCreateAttributesWithDefaults + +`func NewAccountAttributesCreateAttributesWithDefaults() *AccountAttributesCreateAttributes` + +NewAccountAttributesCreateAttributesWithDefaults instantiates a new AccountAttributesCreateAttributes 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 + +### GetSourceId + +`func (o *AccountAttributesCreateAttributes) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccountAttributesCreateAttributes) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccountAttributesCreateAttributes) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountCorrelated.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountCorrelated.md new file mode 100644 index 000000000..668f5b9bb --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountCorrelated.md @@ -0,0 +1,148 @@ +--- +id: beta-account-correlated +title: AccountCorrelated +pagination_label: AccountCorrelated +sidebar_label: AccountCorrelated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountCorrelated', 'BetaAccountCorrelated'] +slug: /tools/sdk/go/beta/models/account-correlated +tags: ['SDK', 'Software Development Kit', 'AccountCorrelated', 'BetaAccountCorrelated'] +--- + +# AccountCorrelated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**AccountCorrelatedIdentity**](account-correlated-identity) | | +**Source** | [**AccountCorrelatedSource**](account-correlated-source) | | +**Account** | [**AccountCorrelatedAccount**](account-correlated-account) | | +**Attributes** | **map[string]interface{}** | The attributes associated with the account. Attributes are unique per source. | +**EntitlementCount** | Pointer to **int32** | The number of entitlements associated with this account. | [optional] + +## Methods + +### NewAccountCorrelated + +`func NewAccountCorrelated(identity AccountCorrelatedIdentity, source AccountCorrelatedSource, account AccountCorrelatedAccount, attributes map[string]interface{}, ) *AccountCorrelated` + +NewAccountCorrelated instantiates a new AccountCorrelated 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 + +### NewAccountCorrelatedWithDefaults + +`func NewAccountCorrelatedWithDefaults() *AccountCorrelated` + +NewAccountCorrelatedWithDefaults instantiates a new AccountCorrelated 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 + +### GetIdentity + +`func (o *AccountCorrelated) GetIdentity() AccountCorrelatedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *AccountCorrelated) GetIdentityOk() (*AccountCorrelatedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *AccountCorrelated) SetIdentity(v AccountCorrelatedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetSource + +`func (o *AccountCorrelated) GetSource() AccountCorrelatedSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountCorrelated) GetSourceOk() (*AccountCorrelatedSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountCorrelated) SetSource(v AccountCorrelatedSource)` + +SetSource sets Source field to given value. + + +### GetAccount + +`func (o *AccountCorrelated) GetAccount() AccountCorrelatedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *AccountCorrelated) GetAccountOk() (*AccountCorrelatedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *AccountCorrelated) SetAccount(v AccountCorrelatedAccount)` + +SetAccount sets Account field to given value. + + +### GetAttributes + +`func (o *AccountCorrelated) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AccountCorrelated) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AccountCorrelated) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetEntitlementCount + +`func (o *AccountCorrelated) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccountCorrelated) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccountCorrelated) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccountCorrelated) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountCorrelatedAccount.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountCorrelatedAccount.md new file mode 100644 index 000000000..3ca1dd791 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountCorrelatedAccount.md @@ -0,0 +1,158 @@ +--- +id: beta-account-correlated-account +title: AccountCorrelatedAccount +pagination_label: AccountCorrelatedAccount +sidebar_label: AccountCorrelatedAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountCorrelatedAccount', 'BetaAccountCorrelatedAccount'] +slug: /tools/sdk/go/beta/models/account-correlated-account +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedAccount', 'BetaAccountCorrelatedAccount'] +--- + +# AccountCorrelatedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The correlated account's DTO type. | +**Id** | **string** | The correlated account's ID. | +**Name** | **string** | The correlated account's display name. | +**NativeIdentity** | **string** | Unique ID of the account on the source. | +**Uuid** | Pointer to **NullableString** | The source's unique identifier for the account. UUID is generated by the source system. | [optional] + +## Methods + +### NewAccountCorrelatedAccount + +`func NewAccountCorrelatedAccount(type_ string, id string, name string, nativeIdentity string, ) *AccountCorrelatedAccount` + +NewAccountCorrelatedAccount instantiates a new AccountCorrelatedAccount 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 + +### NewAccountCorrelatedAccountWithDefaults + +`func NewAccountCorrelatedAccountWithDefaults() *AccountCorrelatedAccount` + +NewAccountCorrelatedAccountWithDefaults instantiates a new AccountCorrelatedAccount 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 + +### GetType + +`func (o *AccountCorrelatedAccount) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountCorrelatedAccount) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountCorrelatedAccount) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountCorrelatedAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountCorrelatedAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountCorrelatedAccount) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountCorrelatedAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountCorrelatedAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountCorrelatedAccount) SetName(v string)` + +SetName sets Name field to given value. + + +### GetNativeIdentity + +`func (o *AccountCorrelatedAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountCorrelatedAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountCorrelatedAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + + +### GetUuid + +`func (o *AccountCorrelatedAccount) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *AccountCorrelatedAccount) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *AccountCorrelatedAccount) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *AccountCorrelatedAccount) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *AccountCorrelatedAccount) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *AccountCorrelatedAccount) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountCorrelatedIdentity.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountCorrelatedIdentity.md new file mode 100644 index 000000000..56bfde2a2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountCorrelatedIdentity.md @@ -0,0 +1,101 @@ +--- +id: beta-account-correlated-identity +title: AccountCorrelatedIdentity +pagination_label: AccountCorrelatedIdentity +sidebar_label: AccountCorrelatedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountCorrelatedIdentity', 'BetaAccountCorrelatedIdentity'] +slug: /tools/sdk/go/beta/models/account-correlated-identity +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedIdentity', 'BetaAccountCorrelatedIdentity'] +--- + +# AccountCorrelatedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of the identity the account is correlated with. | +**Id** | **string** | ID of the identity the account is correlated with. | +**Name** | **string** | Display name of the identity the account is correlated with. | + +## Methods + +### NewAccountCorrelatedIdentity + +`func NewAccountCorrelatedIdentity(type_ string, id string, name string, ) *AccountCorrelatedIdentity` + +NewAccountCorrelatedIdentity instantiates a new AccountCorrelatedIdentity 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 + +### NewAccountCorrelatedIdentityWithDefaults + +`func NewAccountCorrelatedIdentityWithDefaults() *AccountCorrelatedIdentity` + +NewAccountCorrelatedIdentityWithDefaults instantiates a new AccountCorrelatedIdentity 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 + +### GetType + +`func (o *AccountCorrelatedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountCorrelatedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountCorrelatedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountCorrelatedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountCorrelatedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountCorrelatedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountCorrelatedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountCorrelatedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountCorrelatedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountCorrelatedSource.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountCorrelatedSource.md new file mode 100644 index 000000000..f825111f9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountCorrelatedSource.md @@ -0,0 +1,101 @@ +--- +id: beta-account-correlated-source +title: AccountCorrelatedSource +pagination_label: AccountCorrelatedSource +sidebar_label: AccountCorrelatedSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountCorrelatedSource', 'BetaAccountCorrelatedSource'] +slug: /tools/sdk/go/beta/models/account-correlated-source +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedSource', 'BetaAccountCorrelatedSource'] +--- + +# AccountCorrelatedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The DTO type of the source the accounts are being correlated from. | +**Id** | **string** | The ID of the source the accounts are being correlated from. | +**Name** | **string** | Display name of the source the accounts are being correlated from. | + +## Methods + +### NewAccountCorrelatedSource + +`func NewAccountCorrelatedSource(type_ string, id string, name string, ) *AccountCorrelatedSource` + +NewAccountCorrelatedSource instantiates a new AccountCorrelatedSource 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 + +### NewAccountCorrelatedSourceWithDefaults + +`func NewAccountCorrelatedSourceWithDefaults() *AccountCorrelatedSource` + +NewAccountCorrelatedSourceWithDefaults instantiates a new AccountCorrelatedSource 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 + +### GetType + +`func (o *AccountCorrelatedSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountCorrelatedSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountCorrelatedSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountCorrelatedSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountCorrelatedSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountCorrelatedSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountCorrelatedSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountCorrelatedSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountCorrelatedSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountInfoDto.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountInfoDto.md new file mode 100644 index 000000000..16c2c7e39 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountInfoDto.md @@ -0,0 +1,116 @@ +--- +id: beta-account-info-dto +title: AccountInfoDto +pagination_label: AccountInfoDto +sidebar_label: AccountInfoDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountInfoDto', 'BetaAccountInfoDto'] +slug: /tools/sdk/go/beta/models/account-info-dto +tags: ['SDK', 'Software Development Kit', 'AccountInfoDto', 'BetaAccountInfoDto'] +--- + +# AccountInfoDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NativeIdentity** | Pointer to **string** | The unique ID of the account generated by the source system | [optional] +**DisplayName** | Pointer to **string** | Display name for this account | [optional] +**Uuid** | Pointer to **string** | UUID associated with this account | [optional] + +## Methods + +### NewAccountInfoDto + +`func NewAccountInfoDto() *AccountInfoDto` + +NewAccountInfoDto instantiates a new AccountInfoDto 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 + +### NewAccountInfoDtoWithDefaults + +`func NewAccountInfoDtoWithDefaults() *AccountInfoDto` + +NewAccountInfoDtoWithDefaults instantiates a new AccountInfoDto 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 + +### GetNativeIdentity + +`func (o *AccountInfoDto) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountInfoDto) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountInfoDto) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccountInfoDto) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccountInfoDto) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccountInfoDto) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccountInfoDto) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccountInfoDto) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetUuid + +`func (o *AccountInfoDto) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *AccountInfoDto) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *AccountInfoDto) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *AccountInfoDto) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountItemRef.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountItemRef.md new file mode 100644 index 000000000..35da5ce6e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountItemRef.md @@ -0,0 +1,100 @@ +--- +id: beta-account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountItemRef', 'BetaAccountItemRef'] +slug: /tools/sdk/go/beta/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'BetaAccountItemRef'] +--- + +# AccountItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountUuid** | Pointer to **NullableString** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | Pointer to **string** | The 'distinguishedName' attribute for the account | [optional] + +## Methods + +### NewAccountItemRef + +`func NewAccountItemRef() *AccountItemRef` + +NewAccountItemRef instantiates a new AccountItemRef 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 + +### NewAccountItemRefWithDefaults + +`func NewAccountItemRefWithDefaults() *AccountItemRef` + +NewAccountItemRefWithDefaults instantiates a new AccountItemRef 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 + +### GetAccountUuid + +`func (o *AccountItemRef) GetAccountUuid() string` + +GetAccountUuid returns the AccountUuid field if non-nil, zero value otherwise. + +### GetAccountUuidOk + +`func (o *AccountItemRef) GetAccountUuidOk() (*string, bool)` + +GetAccountUuidOk returns a tuple with the AccountUuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountUuid + +`func (o *AccountItemRef) SetAccountUuid(v string)` + +SetAccountUuid sets AccountUuid field to given value. + +### HasAccountUuid + +`func (o *AccountItemRef) HasAccountUuid() bool` + +HasAccountUuid returns a boolean if a field has been set. + +### SetAccountUuidNil + +`func (o *AccountItemRef) SetAccountUuidNil(b bool)` + + SetAccountUuidNil sets the value for AccountUuid to be an explicit nil + +### UnsetAccountUuid +`func (o *AccountItemRef) UnsetAccountUuid()` + +UnsetAccountUuid ensures that no value is present for AccountUuid, not even an explicit nil +### GetNativeIdentity + +`func (o *AccountItemRef) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountItemRef) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountItemRef) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccountItemRef) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountRequestInfo.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountRequestInfo.md new file mode 100644 index 000000000..e9cd20bce --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountRequestInfo.md @@ -0,0 +1,116 @@ +--- +id: beta-account-request-info +title: AccountRequestInfo +pagination_label: AccountRequestInfo +sidebar_label: AccountRequestInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountRequestInfo', 'BetaAccountRequestInfo'] +slug: /tools/sdk/go/beta/models/account-request-info +tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'BetaAccountRequestInfo'] +--- + +# AccountRequestInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedObjectId** | Pointer to **string** | Id of requested object | [optional] +**RequestedObjectName** | Pointer to **string** | Human-readable name of requested object | [optional] +**RequestedObjectType** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional] + +## Methods + +### NewAccountRequestInfo + +`func NewAccountRequestInfo() *AccountRequestInfo` + +NewAccountRequestInfo instantiates a new AccountRequestInfo 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 + +### NewAccountRequestInfoWithDefaults + +`func NewAccountRequestInfoWithDefaults() *AccountRequestInfo` + +NewAccountRequestInfoWithDefaults instantiates a new AccountRequestInfo 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 + +### GetRequestedObjectId + +`func (o *AccountRequestInfo) GetRequestedObjectId() string` + +GetRequestedObjectId returns the RequestedObjectId field if non-nil, zero value otherwise. + +### GetRequestedObjectIdOk + +`func (o *AccountRequestInfo) GetRequestedObjectIdOk() (*string, bool)` + +GetRequestedObjectIdOk returns a tuple with the RequestedObjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObjectId + +`func (o *AccountRequestInfo) SetRequestedObjectId(v string)` + +SetRequestedObjectId sets RequestedObjectId field to given value. + +### HasRequestedObjectId + +`func (o *AccountRequestInfo) HasRequestedObjectId() bool` + +HasRequestedObjectId returns a boolean if a field has been set. + +### GetRequestedObjectName + +`func (o *AccountRequestInfo) GetRequestedObjectName() string` + +GetRequestedObjectName returns the RequestedObjectName field if non-nil, zero value otherwise. + +### GetRequestedObjectNameOk + +`func (o *AccountRequestInfo) GetRequestedObjectNameOk() (*string, bool)` + +GetRequestedObjectNameOk returns a tuple with the RequestedObjectName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObjectName + +`func (o *AccountRequestInfo) SetRequestedObjectName(v string)` + +SetRequestedObjectName sets RequestedObjectName field to given value. + +### HasRequestedObjectName + +`func (o *AccountRequestInfo) HasRequestedObjectName() bool` + +HasRequestedObjectName returns a boolean if a field has been set. + +### GetRequestedObjectType + +`func (o *AccountRequestInfo) GetRequestedObjectType() RequestableObjectType` + +GetRequestedObjectType returns the RequestedObjectType field if non-nil, zero value otherwise. + +### GetRequestedObjectTypeOk + +`func (o *AccountRequestInfo) GetRequestedObjectTypeOk() (*RequestableObjectType, bool)` + +GetRequestedObjectTypeOk returns a tuple with the RequestedObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObjectType + +`func (o *AccountRequestInfo) SetRequestedObjectType(v RequestableObjectType)` + +SetRequestedObjectType sets RequestedObjectType field to given value. + +### HasRequestedObjectType + +`func (o *AccountRequestInfo) HasRequestedObjectType() bool` + +HasRequestedObjectType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountStatusChanged.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountStatusChanged.md new file mode 100644 index 000000000..0a436706d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountStatusChanged.md @@ -0,0 +1,168 @@ +--- +id: beta-account-status-changed +title: AccountStatusChanged +pagination_label: AccountStatusChanged +sidebar_label: AccountStatusChanged +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountStatusChanged', 'BetaAccountStatusChanged'] +slug: /tools/sdk/go/beta/models/account-status-changed +tags: ['SDK', 'Software Development Kit', 'AccountStatusChanged', 'BetaAccountStatusChanged'] +--- + +# AccountStatusChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EventType** | Pointer to **string** | the event type | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] +**Account** | Pointer to [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] +**StatusChange** | Pointer to [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional] + +## Methods + +### NewAccountStatusChanged + +`func NewAccountStatusChanged() *AccountStatusChanged` + +NewAccountStatusChanged instantiates a new AccountStatusChanged 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 + +### NewAccountStatusChangedWithDefaults + +`func NewAccountStatusChangedWithDefaults() *AccountStatusChanged` + +NewAccountStatusChangedWithDefaults instantiates a new AccountStatusChanged 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 + +### GetEventType + +`func (o *AccountStatusChanged) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AccountStatusChanged) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AccountStatusChanged) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AccountStatusChanged) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *AccountStatusChanged) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccountStatusChanged) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccountStatusChanged) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccountStatusChanged) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetDt + +`func (o *AccountStatusChanged) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *AccountStatusChanged) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *AccountStatusChanged) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *AccountStatusChanged) HasDt() bool` + +HasDt returns a boolean if a field has been set. + +### GetAccount + +`func (o *AccountStatusChanged) GetAccount() AccountStatusChangedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *AccountStatusChanged) GetAccountOk() (*AccountStatusChangedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *AccountStatusChanged) SetAccount(v AccountStatusChangedAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *AccountStatusChanged) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### GetStatusChange + +`func (o *AccountStatusChanged) GetStatusChange() AccountStatusChangedStatusChange` + +GetStatusChange returns the StatusChange field if non-nil, zero value otherwise. + +### GetStatusChangeOk + +`func (o *AccountStatusChanged) GetStatusChangeOk() (*AccountStatusChangedStatusChange, bool)` + +GetStatusChangeOk returns a tuple with the StatusChange field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusChange + +`func (o *AccountStatusChanged) SetStatusChange(v AccountStatusChangedStatusChange)` + +SetStatusChange sets StatusChange field to given value. + +### HasStatusChange + +`func (o *AccountStatusChanged) HasStatusChange() bool` + +HasStatusChange returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountStatusChangedAccount.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountStatusChangedAccount.md new file mode 100644 index 000000000..25ac3d8b8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountStatusChangedAccount.md @@ -0,0 +1,220 @@ +--- +id: beta-account-status-changed-account +title: AccountStatusChangedAccount +pagination_label: AccountStatusChangedAccount +sidebar_label: AccountStatusChangedAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountStatusChangedAccount', 'BetaAccountStatusChangedAccount'] +slug: /tools/sdk/go/beta/models/account-status-changed-account +tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedAccount', 'BetaAccountStatusChangedAccount'] +--- + +# AccountStatusChangedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the ID of the account in the database | [optional] +**NativeIdentity** | Pointer to **string** | the native identifier of the account | [optional] +**DisplayName** | Pointer to **string** | the display name of the account | [optional] +**SourceId** | Pointer to **string** | the ID of the source for this account | [optional] +**SourceName** | Pointer to **string** | the name of the source for this account | [optional] +**EntitlementCount** | Pointer to **int32** | the number of entitlements on this account | [optional] +**AccessType** | Pointer to **string** | this value is always \"account\" | [optional] + +## Methods + +### NewAccountStatusChangedAccount + +`func NewAccountStatusChangedAccount() *AccountStatusChangedAccount` + +NewAccountStatusChangedAccount instantiates a new AccountStatusChangedAccount 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 + +### NewAccountStatusChangedAccountWithDefaults + +`func NewAccountStatusChangedAccountWithDefaults() *AccountStatusChangedAccount` + +NewAccountStatusChangedAccountWithDefaults instantiates a new AccountStatusChangedAccount 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 + +### GetId + +`func (o *AccountStatusChangedAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountStatusChangedAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountStatusChangedAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountStatusChangedAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *AccountStatusChangedAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountStatusChangedAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountStatusChangedAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccountStatusChangedAccount) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccountStatusChangedAccount) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccountStatusChangedAccount) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccountStatusChangedAccount) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccountStatusChangedAccount) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccountStatusChangedAccount) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccountStatusChangedAccount) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccountStatusChangedAccount) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccountStatusChangedAccount) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccountStatusChangedAccount) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccountStatusChangedAccount) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccountStatusChangedAccount) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccountStatusChangedAccount) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccountStatusChangedAccount) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccountStatusChangedAccount) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccountStatusChangedAccount) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccountStatusChangedAccount) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetAccessType + +`func (o *AccountStatusChangedAccount) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccountStatusChangedAccount) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccountStatusChangedAccount) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccountStatusChangedAccount) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountStatusChangedStatusChange.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountStatusChangedStatusChange.md new file mode 100644 index 000000000..aa5e98ef5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountStatusChangedStatusChange.md @@ -0,0 +1,90 @@ +--- +id: beta-account-status-changed-status-change +title: AccountStatusChangedStatusChange +pagination_label: AccountStatusChangedStatusChange +sidebar_label: AccountStatusChangedStatusChange +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountStatusChangedStatusChange', 'BetaAccountStatusChangedStatusChange'] +slug: /tools/sdk/go/beta/models/account-status-changed-status-change +tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedStatusChange', 'BetaAccountStatusChangedStatusChange'] +--- + +# AccountStatusChangedStatusChange + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PreviousStatus** | Pointer to **string** | the previous status of the account | [optional] +**NewStatus** | Pointer to **string** | the new status of the account | [optional] + +## Methods + +### NewAccountStatusChangedStatusChange + +`func NewAccountStatusChangedStatusChange() *AccountStatusChangedStatusChange` + +NewAccountStatusChangedStatusChange instantiates a new AccountStatusChangedStatusChange 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 + +### NewAccountStatusChangedStatusChangeWithDefaults + +`func NewAccountStatusChangedStatusChangeWithDefaults() *AccountStatusChangedStatusChange` + +NewAccountStatusChangedStatusChangeWithDefaults instantiates a new AccountStatusChangedStatusChange 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 + +### GetPreviousStatus + +`func (o *AccountStatusChangedStatusChange) GetPreviousStatus() string` + +GetPreviousStatus returns the PreviousStatus field if non-nil, zero value otherwise. + +### GetPreviousStatusOk + +`func (o *AccountStatusChangedStatusChange) GetPreviousStatusOk() (*string, bool)` + +GetPreviousStatusOk returns a tuple with the PreviousStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousStatus + +`func (o *AccountStatusChangedStatusChange) SetPreviousStatus(v string)` + +SetPreviousStatus sets PreviousStatus field to given value. + +### HasPreviousStatus + +`func (o *AccountStatusChangedStatusChange) HasPreviousStatus() bool` + +HasPreviousStatus returns a boolean if a field has been set. + +### GetNewStatus + +`func (o *AccountStatusChangedStatusChange) GetNewStatus() string` + +GetNewStatus returns the NewStatus field if non-nil, zero value otherwise. + +### GetNewStatusOk + +`func (o *AccountStatusChangedStatusChange) GetNewStatusOk() (*string, bool)` + +GetNewStatusOk returns a tuple with the NewStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewStatus + +`func (o *AccountStatusChangedStatusChange) SetNewStatus(v string)` + +SetNewStatus sets NewStatus field to given value. + +### HasNewStatus + +`func (o *AccountStatusChangedStatusChange) HasNewStatus() bool` + +HasNewStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountToggleRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountToggleRequest.md new file mode 100644 index 000000000..5790cc770 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountToggleRequest.md @@ -0,0 +1,90 @@ +--- +id: beta-account-toggle-request +title: AccountToggleRequest +pagination_label: AccountToggleRequest +sidebar_label: AccountToggleRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountToggleRequest', 'BetaAccountToggleRequest'] +slug: /tools/sdk/go/beta/models/account-toggle-request +tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'BetaAccountToggleRequest'] +--- + +# AccountToggleRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExternalVerificationId** | Pointer to **string** | If set, an external process validates that the user wants to proceed with this request. | [optional] +**ForceProvisioning** | Pointer to **bool** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional] + +## Methods + +### NewAccountToggleRequest + +`func NewAccountToggleRequest() *AccountToggleRequest` + +NewAccountToggleRequest instantiates a new AccountToggleRequest 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 + +### NewAccountToggleRequestWithDefaults + +`func NewAccountToggleRequestWithDefaults() *AccountToggleRequest` + +NewAccountToggleRequestWithDefaults instantiates a new AccountToggleRequest 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 + +### GetExternalVerificationId + +`func (o *AccountToggleRequest) GetExternalVerificationId() string` + +GetExternalVerificationId returns the ExternalVerificationId field if non-nil, zero value otherwise. + +### GetExternalVerificationIdOk + +`func (o *AccountToggleRequest) GetExternalVerificationIdOk() (*string, bool)` + +GetExternalVerificationIdOk returns a tuple with the ExternalVerificationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExternalVerificationId + +`func (o *AccountToggleRequest) SetExternalVerificationId(v string)` + +SetExternalVerificationId sets ExternalVerificationId field to given value. + +### HasExternalVerificationId + +`func (o *AccountToggleRequest) HasExternalVerificationId() bool` + +HasExternalVerificationId returns a boolean if a field has been set. + +### GetForceProvisioning + +`func (o *AccountToggleRequest) GetForceProvisioning() bool` + +GetForceProvisioning returns the ForceProvisioning field if non-nil, zero value otherwise. + +### GetForceProvisioningOk + +`func (o *AccountToggleRequest) GetForceProvisioningOk() (*bool, bool)` + +GetForceProvisioningOk returns a tuple with the ForceProvisioning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForceProvisioning + +`func (o *AccountToggleRequest) SetForceProvisioning(v bool)` + +SetForceProvisioning sets ForceProvisioning field to given value. + +### HasForceProvisioning + +`func (o *AccountToggleRequest) HasForceProvisioning() bool` + +HasForceProvisioning returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountUncorrelated.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountUncorrelated.md new file mode 100644 index 000000000..98d355f0b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountUncorrelated.md @@ -0,0 +1,127 @@ +--- +id: beta-account-uncorrelated +title: AccountUncorrelated +pagination_label: AccountUncorrelated +sidebar_label: AccountUncorrelated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUncorrelated', 'BetaAccountUncorrelated'] +slug: /tools/sdk/go/beta/models/account-uncorrelated +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelated', 'BetaAccountUncorrelated'] +--- + +# AccountUncorrelated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**AccountUncorrelatedIdentity**](account-uncorrelated-identity) | | +**Source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | +**Account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | +**EntitlementCount** | Pointer to **int32** | The number of entitlements associated with this account. | [optional] + +## Methods + +### NewAccountUncorrelated + +`func NewAccountUncorrelated(identity AccountUncorrelatedIdentity, source AccountUncorrelatedSource, account AccountUncorrelatedAccount, ) *AccountUncorrelated` + +NewAccountUncorrelated instantiates a new AccountUncorrelated 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 + +### NewAccountUncorrelatedWithDefaults + +`func NewAccountUncorrelatedWithDefaults() *AccountUncorrelated` + +NewAccountUncorrelatedWithDefaults instantiates a new AccountUncorrelated 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 + +### GetIdentity + +`func (o *AccountUncorrelated) GetIdentity() AccountUncorrelatedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *AccountUncorrelated) GetIdentityOk() (*AccountUncorrelatedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *AccountUncorrelated) SetIdentity(v AccountUncorrelatedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetSource + +`func (o *AccountUncorrelated) GetSource() AccountUncorrelatedSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountUncorrelated) GetSourceOk() (*AccountUncorrelatedSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountUncorrelated) SetSource(v AccountUncorrelatedSource)` + +SetSource sets Source field to given value. + + +### GetAccount + +`func (o *AccountUncorrelated) GetAccount() AccountUncorrelatedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *AccountUncorrelated) GetAccountOk() (*AccountUncorrelatedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *AccountUncorrelated) SetAccount(v AccountUncorrelatedAccount)` + +SetAccount sets Account field to given value. + + +### GetEntitlementCount + +`func (o *AccountUncorrelated) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccountUncorrelated) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccountUncorrelated) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccountUncorrelated) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountUncorrelatedAccount.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountUncorrelatedAccount.md new file mode 100644 index 000000000..8110ec494 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountUncorrelatedAccount.md @@ -0,0 +1,158 @@ +--- +id: beta-account-uncorrelated-account +title: AccountUncorrelatedAccount +pagination_label: AccountUncorrelatedAccount +sidebar_label: AccountUncorrelatedAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUncorrelatedAccount', 'BetaAccountUncorrelatedAccount'] +slug: /tools/sdk/go/beta/models/account-uncorrelated-account +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedAccount', 'BetaAccountUncorrelatedAccount'] +--- + +# AccountUncorrelatedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **map[string]interface{}** | Uncorrelated account's DTO type. | +**Id** | **string** | Uncorrelated account's ID. | +**Name** | **string** | Uncorrelated account's display name. | +**NativeIdentity** | **string** | Unique ID of the account on the source. | +**Uuid** | Pointer to **NullableString** | The source's unique identifier for the account. UUID is generated by the source system. | [optional] + +## Methods + +### NewAccountUncorrelatedAccount + +`func NewAccountUncorrelatedAccount(type_ map[string]interface{}, id string, name string, nativeIdentity string, ) *AccountUncorrelatedAccount` + +NewAccountUncorrelatedAccount instantiates a new AccountUncorrelatedAccount 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 + +### NewAccountUncorrelatedAccountWithDefaults + +`func NewAccountUncorrelatedAccountWithDefaults() *AccountUncorrelatedAccount` + +NewAccountUncorrelatedAccountWithDefaults instantiates a new AccountUncorrelatedAccount 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 + +### GetType + +`func (o *AccountUncorrelatedAccount) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountUncorrelatedAccount) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountUncorrelatedAccount) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountUncorrelatedAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountUncorrelatedAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountUncorrelatedAccount) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountUncorrelatedAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountUncorrelatedAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountUncorrelatedAccount) SetName(v string)` + +SetName sets Name field to given value. + + +### GetNativeIdentity + +`func (o *AccountUncorrelatedAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountUncorrelatedAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountUncorrelatedAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + + +### GetUuid + +`func (o *AccountUncorrelatedAccount) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *AccountUncorrelatedAccount) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *AccountUncorrelatedAccount) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *AccountUncorrelatedAccount) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *AccountUncorrelatedAccount) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *AccountUncorrelatedAccount) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountUncorrelatedIdentity.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountUncorrelatedIdentity.md new file mode 100644 index 000000000..781299e13 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountUncorrelatedIdentity.md @@ -0,0 +1,101 @@ +--- +id: beta-account-uncorrelated-identity +title: AccountUncorrelatedIdentity +pagination_label: AccountUncorrelatedIdentity +sidebar_label: AccountUncorrelatedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUncorrelatedIdentity', 'BetaAccountUncorrelatedIdentity'] +slug: /tools/sdk/go/beta/models/account-uncorrelated-identity +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedIdentity', 'BetaAccountUncorrelatedIdentity'] +--- + +# AccountUncorrelatedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of the identity the account is uncorrelated with. | +**Id** | **string** | ID of the identity the account is uncorrelated with. | +**Name** | **string** | Display name of the identity the account is uncorrelated with. | + +## Methods + +### NewAccountUncorrelatedIdentity + +`func NewAccountUncorrelatedIdentity(type_ string, id string, name string, ) *AccountUncorrelatedIdentity` + +NewAccountUncorrelatedIdentity instantiates a new AccountUncorrelatedIdentity 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 + +### NewAccountUncorrelatedIdentityWithDefaults + +`func NewAccountUncorrelatedIdentityWithDefaults() *AccountUncorrelatedIdentity` + +NewAccountUncorrelatedIdentityWithDefaults instantiates a new AccountUncorrelatedIdentity 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 + +### GetType + +`func (o *AccountUncorrelatedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountUncorrelatedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountUncorrelatedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountUncorrelatedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountUncorrelatedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountUncorrelatedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountUncorrelatedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountUncorrelatedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountUncorrelatedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountUncorrelatedSource.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountUncorrelatedSource.md new file mode 100644 index 000000000..f1fa3d165 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountUncorrelatedSource.md @@ -0,0 +1,101 @@ +--- +id: beta-account-uncorrelated-source +title: AccountUncorrelatedSource +pagination_label: AccountUncorrelatedSource +sidebar_label: AccountUncorrelatedSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUncorrelatedSource', 'BetaAccountUncorrelatedSource'] +slug: /tools/sdk/go/beta/models/account-uncorrelated-source +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedSource', 'BetaAccountUncorrelatedSource'] +--- + +# AccountUncorrelatedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The DTO type of the source the accounts are uncorrelated from. | +**Id** | **string** | The ID of the source the accounts are uncorrelated from. | +**Name** | **string** | Display name of the source the accounts are uncorrelated from. | + +## Methods + +### NewAccountUncorrelatedSource + +`func NewAccountUncorrelatedSource(type_ string, id string, name string, ) *AccountUncorrelatedSource` + +NewAccountUncorrelatedSource instantiates a new AccountUncorrelatedSource 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 + +### NewAccountUncorrelatedSourceWithDefaults + +`func NewAccountUncorrelatedSourceWithDefaults() *AccountUncorrelatedSource` + +NewAccountUncorrelatedSourceWithDefaults instantiates a new AccountUncorrelatedSource 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 + +### GetType + +`func (o *AccountUncorrelatedSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountUncorrelatedSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountUncorrelatedSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountUncorrelatedSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountUncorrelatedSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountUncorrelatedSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountUncorrelatedSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountUncorrelatedSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountUncorrelatedSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountUnlockRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountUnlockRequest.md new file mode 100644 index 000000000..739d7d13d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountUnlockRequest.md @@ -0,0 +1,116 @@ +--- +id: beta-account-unlock-request +title: AccountUnlockRequest +pagination_label: AccountUnlockRequest +sidebar_label: AccountUnlockRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUnlockRequest', 'BetaAccountUnlockRequest'] +slug: /tools/sdk/go/beta/models/account-unlock-request +tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'BetaAccountUnlockRequest'] +--- + +# AccountUnlockRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExternalVerificationId** | Pointer to **string** | If set, an external process validates that the user wants to proceed with this request. | [optional] +**UnlockIDNAccount** | Pointer to **bool** | If set, the IDN account is unlocked after the workflow completes. | [optional] +**ForceProvisioning** | Pointer to **bool** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional] + +## Methods + +### NewAccountUnlockRequest + +`func NewAccountUnlockRequest() *AccountUnlockRequest` + +NewAccountUnlockRequest instantiates a new AccountUnlockRequest 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 + +### NewAccountUnlockRequestWithDefaults + +`func NewAccountUnlockRequestWithDefaults() *AccountUnlockRequest` + +NewAccountUnlockRequestWithDefaults instantiates a new AccountUnlockRequest 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 + +### GetExternalVerificationId + +`func (o *AccountUnlockRequest) GetExternalVerificationId() string` + +GetExternalVerificationId returns the ExternalVerificationId field if non-nil, zero value otherwise. + +### GetExternalVerificationIdOk + +`func (o *AccountUnlockRequest) GetExternalVerificationIdOk() (*string, bool)` + +GetExternalVerificationIdOk returns a tuple with the ExternalVerificationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExternalVerificationId + +`func (o *AccountUnlockRequest) SetExternalVerificationId(v string)` + +SetExternalVerificationId sets ExternalVerificationId field to given value. + +### HasExternalVerificationId + +`func (o *AccountUnlockRequest) HasExternalVerificationId() bool` + +HasExternalVerificationId returns a boolean if a field has been set. + +### GetUnlockIDNAccount + +`func (o *AccountUnlockRequest) GetUnlockIDNAccount() bool` + +GetUnlockIDNAccount returns the UnlockIDNAccount field if non-nil, zero value otherwise. + +### GetUnlockIDNAccountOk + +`func (o *AccountUnlockRequest) GetUnlockIDNAccountOk() (*bool, bool)` + +GetUnlockIDNAccountOk returns a tuple with the UnlockIDNAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnlockIDNAccount + +`func (o *AccountUnlockRequest) SetUnlockIDNAccount(v bool)` + +SetUnlockIDNAccount sets UnlockIDNAccount field to given value. + +### HasUnlockIDNAccount + +`func (o *AccountUnlockRequest) HasUnlockIDNAccount() bool` + +HasUnlockIDNAccount returns a boolean if a field has been set. + +### GetForceProvisioning + +`func (o *AccountUnlockRequest) GetForceProvisioning() bool` + +GetForceProvisioning returns the ForceProvisioning field if non-nil, zero value otherwise. + +### GetForceProvisioningOk + +`func (o *AccountUnlockRequest) GetForceProvisioningOk() (*bool, bool)` + +GetForceProvisioningOk returns a tuple with the ForceProvisioning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForceProvisioning + +`func (o *AccountUnlockRequest) SetForceProvisioning(v bool)` + +SetForceProvisioning sets ForceProvisioning field to given value. + +### HasForceProvisioning + +`func (o *AccountUnlockRequest) HasForceProvisioning() bool` + +HasForceProvisioning returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountUsage.md new file mode 100644 index 000000000..9d57d3b66 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountUsage.md @@ -0,0 +1,90 @@ +--- +id: beta-account-usage +title: AccountUsage +pagination_label: AccountUsage +sidebar_label: AccountUsage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUsage', 'BetaAccountUsage'] +slug: /tools/sdk/go/beta/models/account-usage +tags: ['SDK', 'Software Development Kit', 'AccountUsage', 'BetaAccountUsage'] +--- + +# AccountUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **string** | The first day of the month for which activity is aggregated. | [optional] +**Count** | Pointer to **int64** | The number of days within the month that the account was active in a source. | [optional] + +## Methods + +### NewAccountUsage + +`func NewAccountUsage() *AccountUsage` + +NewAccountUsage instantiates a new AccountUsage 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 + +### NewAccountUsageWithDefaults + +`func NewAccountUsageWithDefaults() *AccountUsage` + +NewAccountUsageWithDefaults instantiates a new AccountUsage 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 + +### GetDate + +`func (o *AccountUsage) GetDate() string` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *AccountUsage) GetDateOk() (*string, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *AccountUsage) SetDate(v string)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *AccountUsage) HasDate() bool` + +HasDate returns a boolean if a field has been set. + +### GetCount + +`func (o *AccountUsage) GetCount() int64` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *AccountUsage) GetCountOk() (*int64, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *AccountUsage) SetCount(v int64)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *AccountUsage) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountsAsyncResult.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountsAsyncResult.md new file mode 100644 index 000000000..3d22d20e3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountsAsyncResult.md @@ -0,0 +1,59 @@ +--- +id: beta-accounts-async-result +title: AccountsAsyncResult +pagination_label: AccountsAsyncResult +sidebar_label: AccountsAsyncResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsAsyncResult', 'BetaAccountsAsyncResult'] +slug: /tools/sdk/go/beta/models/accounts-async-result +tags: ['SDK', 'Software Development Kit', 'AccountsAsyncResult', 'BetaAccountsAsyncResult'] +--- + +# AccountsAsyncResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | id of the task | + +## Methods + +### NewAccountsAsyncResult + +`func NewAccountsAsyncResult(id string, ) *AccountsAsyncResult` + +NewAccountsAsyncResult instantiates a new AccountsAsyncResult 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 + +### NewAccountsAsyncResultWithDefaults + +`func NewAccountsAsyncResultWithDefaults() *AccountsAsyncResult` + +NewAccountsAsyncResultWithDefaults instantiates a new AccountsAsyncResult 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 + +### GetId + +`func (o *AccountsAsyncResult) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountsAsyncResult) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountsAsyncResult) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountsCollectedForAggregation.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountsCollectedForAggregation.md new file mode 100644 index 000000000..2e22c0557 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountsCollectedForAggregation.md @@ -0,0 +1,205 @@ +--- +id: beta-accounts-collected-for-aggregation +title: AccountsCollectedForAggregation +pagination_label: AccountsCollectedForAggregation +sidebar_label: AccountsCollectedForAggregation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsCollectedForAggregation', 'BetaAccountsCollectedForAggregation'] +slug: /tools/sdk/go/beta/models/accounts-collected-for-aggregation +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregation', 'BetaAccountsCollectedForAggregation'] +--- + +# AccountsCollectedForAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**AccountsCollectedForAggregationSource**](accounts-collected-for-aggregation-source) | | +**Status** | **map[string]interface{}** | The overall status of the collection. | +**Started** | **SailPointTime** | The date and time when the account collection started. | +**Completed** | **SailPointTime** | The date and time when the account collection finished. | +**Errors** | **[]string** | A list of errors that occurred during the collection. | +**Warnings** | **[]string** | A list of warnings that occurred during the collection. | +**Stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | + +## Methods + +### NewAccountsCollectedForAggregation + +`func NewAccountsCollectedForAggregation(source AccountsCollectedForAggregationSource, status map[string]interface{}, started SailPointTime, completed SailPointTime, errors []string, warnings []string, stats AccountsCollectedForAggregationStats, ) *AccountsCollectedForAggregation` + +NewAccountsCollectedForAggregation instantiates a new AccountsCollectedForAggregation 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 + +### NewAccountsCollectedForAggregationWithDefaults + +`func NewAccountsCollectedForAggregationWithDefaults() *AccountsCollectedForAggregation` + +NewAccountsCollectedForAggregationWithDefaults instantiates a new AccountsCollectedForAggregation 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 + +### GetSource + +`func (o *AccountsCollectedForAggregation) GetSource() AccountsCollectedForAggregationSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountsCollectedForAggregation) GetSourceOk() (*AccountsCollectedForAggregationSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountsCollectedForAggregation) SetSource(v AccountsCollectedForAggregationSource)` + +SetSource sets Source field to given value. + + +### GetStatus + +`func (o *AccountsCollectedForAggregation) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountsCollectedForAggregation) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountsCollectedForAggregation) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + +### GetStarted + +`func (o *AccountsCollectedForAggregation) GetStarted() SailPointTime` + +GetStarted returns the Started field if non-nil, zero value otherwise. + +### GetStartedOk + +`func (o *AccountsCollectedForAggregation) GetStartedOk() (*SailPointTime, bool)` + +GetStartedOk returns a tuple with the Started field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStarted + +`func (o *AccountsCollectedForAggregation) SetStarted(v SailPointTime)` + +SetStarted sets Started field to given value. + + +### GetCompleted + +`func (o *AccountsCollectedForAggregation) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *AccountsCollectedForAggregation) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *AccountsCollectedForAggregation) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + + +### GetErrors + +`func (o *AccountsCollectedForAggregation) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountsCollectedForAggregation) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountsCollectedForAggregation) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + + +### SetErrorsNil + +`func (o *AccountsCollectedForAggregation) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *AccountsCollectedForAggregation) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *AccountsCollectedForAggregation) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *AccountsCollectedForAggregation) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *AccountsCollectedForAggregation) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + + +### SetWarningsNil + +`func (o *AccountsCollectedForAggregation) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *AccountsCollectedForAggregation) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetStats + +`func (o *AccountsCollectedForAggregation) GetStats() AccountsCollectedForAggregationStats` + +GetStats returns the Stats field if non-nil, zero value otherwise. + +### GetStatsOk + +`func (o *AccountsCollectedForAggregation) GetStatsOk() (*AccountsCollectedForAggregationStats, bool)` + +GetStatsOk returns a tuple with the Stats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStats + +`func (o *AccountsCollectedForAggregation) SetStats(v AccountsCollectedForAggregationStats)` + +SetStats sets Stats field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountsCollectedForAggregationSource.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountsCollectedForAggregationSource.md new file mode 100644 index 000000000..5e7540175 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountsCollectedForAggregationSource.md @@ -0,0 +1,101 @@ +--- +id: beta-accounts-collected-for-aggregation-source +title: AccountsCollectedForAggregationSource +pagination_label: AccountsCollectedForAggregationSource +sidebar_label: AccountsCollectedForAggregationSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsCollectedForAggregationSource', 'BetaAccountsCollectedForAggregationSource'] +slug: /tools/sdk/go/beta/models/accounts-collected-for-aggregation-source +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationSource', 'BetaAccountsCollectedForAggregationSource'] +--- + +# AccountsCollectedForAggregationSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the object to which this reference applies | +**Type** | **string** | The type of object that is referenced | +**Name** | **string** | Human-readable display name of the object to which this reference applies | + +## Methods + +### NewAccountsCollectedForAggregationSource + +`func NewAccountsCollectedForAggregationSource(id string, type_ string, name string, ) *AccountsCollectedForAggregationSource` + +NewAccountsCollectedForAggregationSource instantiates a new AccountsCollectedForAggregationSource 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 + +### NewAccountsCollectedForAggregationSourceWithDefaults + +`func NewAccountsCollectedForAggregationSourceWithDefaults() *AccountsCollectedForAggregationSource` + +NewAccountsCollectedForAggregationSourceWithDefaults instantiates a new AccountsCollectedForAggregationSource 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 + +### GetId + +`func (o *AccountsCollectedForAggregationSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountsCollectedForAggregationSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountsCollectedForAggregationSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *AccountsCollectedForAggregationSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountsCollectedForAggregationSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountsCollectedForAggregationSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetName + +`func (o *AccountsCollectedForAggregationSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountsCollectedForAggregationSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountsCollectedForAggregationSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AccountsCollectedForAggregationStats.md b/docs/tools/sdk/go/Reference/Beta/Models/AccountsCollectedForAggregationStats.md new file mode 100644 index 000000000..dfefe5582 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AccountsCollectedForAggregationStats.md @@ -0,0 +1,143 @@ +--- +id: beta-accounts-collected-for-aggregation-stats +title: AccountsCollectedForAggregationStats +pagination_label: AccountsCollectedForAggregationStats +sidebar_label: AccountsCollectedForAggregationStats +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsCollectedForAggregationStats', 'BetaAccountsCollectedForAggregationStats'] +slug: /tools/sdk/go/beta/models/accounts-collected-for-aggregation-stats +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationStats', 'BetaAccountsCollectedForAggregationStats'] +--- + +# AccountsCollectedForAggregationStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scanned** | **int32** | The number of accounts which were scanned / iterated over. | +**Unchanged** | **int32** | The number of accounts which existed before, but had no changes. | +**Changed** | **int32** | The number of accounts which existed before, but had changes. | +**Added** | **int32** | The number of accounts which are new - have not existed before. | +**Removed** | **int32** | The number accounts which existed before, but no longer exist (thus getting removed). | + +## Methods + +### NewAccountsCollectedForAggregationStats + +`func NewAccountsCollectedForAggregationStats(scanned int32, unchanged int32, changed int32, added int32, removed int32, ) *AccountsCollectedForAggregationStats` + +NewAccountsCollectedForAggregationStats instantiates a new AccountsCollectedForAggregationStats 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 + +### NewAccountsCollectedForAggregationStatsWithDefaults + +`func NewAccountsCollectedForAggregationStatsWithDefaults() *AccountsCollectedForAggregationStats` + +NewAccountsCollectedForAggregationStatsWithDefaults instantiates a new AccountsCollectedForAggregationStats 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 + +### GetScanned + +`func (o *AccountsCollectedForAggregationStats) GetScanned() int32` + +GetScanned returns the Scanned field if non-nil, zero value otherwise. + +### GetScannedOk + +`func (o *AccountsCollectedForAggregationStats) GetScannedOk() (*int32, bool)` + +GetScannedOk returns a tuple with the Scanned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScanned + +`func (o *AccountsCollectedForAggregationStats) SetScanned(v int32)` + +SetScanned sets Scanned field to given value. + + +### GetUnchanged + +`func (o *AccountsCollectedForAggregationStats) GetUnchanged() int32` + +GetUnchanged returns the Unchanged field if non-nil, zero value otherwise. + +### GetUnchangedOk + +`func (o *AccountsCollectedForAggregationStats) GetUnchangedOk() (*int32, bool)` + +GetUnchangedOk returns a tuple with the Unchanged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnchanged + +`func (o *AccountsCollectedForAggregationStats) SetUnchanged(v int32)` + +SetUnchanged sets Unchanged field to given value. + + +### GetChanged + +`func (o *AccountsCollectedForAggregationStats) GetChanged() int32` + +GetChanged returns the Changed field if non-nil, zero value otherwise. + +### GetChangedOk + +`func (o *AccountsCollectedForAggregationStats) GetChangedOk() (*int32, bool)` + +GetChangedOk returns a tuple with the Changed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanged + +`func (o *AccountsCollectedForAggregationStats) SetChanged(v int32)` + +SetChanged sets Changed field to given value. + + +### GetAdded + +`func (o *AccountsCollectedForAggregationStats) GetAdded() int32` + +GetAdded returns the Added field if non-nil, zero value otherwise. + +### GetAddedOk + +`func (o *AccountsCollectedForAggregationStats) GetAddedOk() (*int32, bool)` + +GetAddedOk returns a tuple with the Added field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAdded + +`func (o *AccountsCollectedForAggregationStats) SetAdded(v int32)` + +SetAdded sets Added field to given value. + + +### GetRemoved + +`func (o *AccountsCollectedForAggregationStats) GetRemoved() int32` + +GetRemoved returns the Removed field if non-nil, zero value otherwise. + +### GetRemovedOk + +`func (o *AccountsCollectedForAggregationStats) GetRemovedOk() (*int32, bool)` + +GetRemovedOk returns a tuple with the Removed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoved + +`func (o *AccountsCollectedForAggregationStats) SetRemoved(v int32)` + +SetRemoved sets Removed field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ActivateCampaignOptions.md b/docs/tools/sdk/go/Reference/Beta/Models/ActivateCampaignOptions.md new file mode 100644 index 000000000..a191766f3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ActivateCampaignOptions.md @@ -0,0 +1,64 @@ +--- +id: beta-activate-campaign-options +title: ActivateCampaignOptions +pagination_label: ActivateCampaignOptions +sidebar_label: ActivateCampaignOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ActivateCampaignOptions', 'BetaActivateCampaignOptions'] +slug: /tools/sdk/go/beta/models/activate-campaign-options +tags: ['SDK', 'Software Development Kit', 'ActivateCampaignOptions', 'BetaActivateCampaignOptions'] +--- + +# ActivateCampaignOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TimeZone** | Pointer to **string** | The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. | [optional] [default to "Z"] + +## Methods + +### NewActivateCampaignOptions + +`func NewActivateCampaignOptions() *ActivateCampaignOptions` + +NewActivateCampaignOptions instantiates a new ActivateCampaignOptions 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 + +### NewActivateCampaignOptionsWithDefaults + +`func NewActivateCampaignOptionsWithDefaults() *ActivateCampaignOptions` + +NewActivateCampaignOptionsWithDefaults instantiates a new ActivateCampaignOptions 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 + +### GetTimeZone + +`func (o *ActivateCampaignOptions) GetTimeZone() string` + +GetTimeZone returns the TimeZone field if non-nil, zero value otherwise. + +### GetTimeZoneOk + +`func (o *ActivateCampaignOptions) GetTimeZoneOk() (*string, bool)` + +GetTimeZoneOk returns a tuple with the TimeZone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZone + +`func (o *ActivateCampaignOptions) SetTimeZone(v string)` + +SetTimeZone sets TimeZone field to given value. + +### HasTimeZone + +`func (o *ActivateCampaignOptions) HasTimeZone() bool` + +HasTimeZone returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AdminReviewReassign.md b/docs/tools/sdk/go/Reference/Beta/Models/AdminReviewReassign.md new file mode 100644 index 000000000..7b8756c74 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AdminReviewReassign.md @@ -0,0 +1,116 @@ +--- +id: beta-admin-review-reassign +title: AdminReviewReassign +pagination_label: AdminReviewReassign +sidebar_label: AdminReviewReassign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AdminReviewReassign', 'BetaAdminReviewReassign'] +slug: /tools/sdk/go/beta/models/admin-review-reassign +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassign', 'BetaAdminReviewReassign'] +--- + +# AdminReviewReassign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CertificationIds** | Pointer to **[]string** | List of certification IDs to reassign | [optional] +**ReassignTo** | Pointer to [**AdminReviewReassignReassignTo**](admin-review-reassign-reassign-to) | | [optional] +**Reason** | Pointer to **string** | Comment to explain why the certification was reassigned | [optional] + +## Methods + +### NewAdminReviewReassign + +`func NewAdminReviewReassign() *AdminReviewReassign` + +NewAdminReviewReassign instantiates a new AdminReviewReassign 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 + +### NewAdminReviewReassignWithDefaults + +`func NewAdminReviewReassignWithDefaults() *AdminReviewReassign` + +NewAdminReviewReassignWithDefaults instantiates a new AdminReviewReassign 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 + +### GetCertificationIds + +`func (o *AdminReviewReassign) GetCertificationIds() []string` + +GetCertificationIds returns the CertificationIds field if non-nil, zero value otherwise. + +### GetCertificationIdsOk + +`func (o *AdminReviewReassign) GetCertificationIdsOk() (*[]string, bool)` + +GetCertificationIdsOk returns a tuple with the CertificationIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationIds + +`func (o *AdminReviewReassign) SetCertificationIds(v []string)` + +SetCertificationIds sets CertificationIds field to given value. + +### HasCertificationIds + +`func (o *AdminReviewReassign) HasCertificationIds() bool` + +HasCertificationIds returns a boolean if a field has been set. + +### GetReassignTo + +`func (o *AdminReviewReassign) GetReassignTo() AdminReviewReassignReassignTo` + +GetReassignTo returns the ReassignTo field if non-nil, zero value otherwise. + +### GetReassignToOk + +`func (o *AdminReviewReassign) GetReassignToOk() (*AdminReviewReassignReassignTo, bool)` + +GetReassignToOk returns a tuple with the ReassignTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignTo + +`func (o *AdminReviewReassign) SetReassignTo(v AdminReviewReassignReassignTo)` + +SetReassignTo sets ReassignTo field to given value. + +### HasReassignTo + +`func (o *AdminReviewReassign) HasReassignTo() bool` + +HasReassignTo returns a boolean if a field has been set. + +### GetReason + +`func (o *AdminReviewReassign) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *AdminReviewReassign) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *AdminReviewReassign) SetReason(v string)` + +SetReason sets Reason field to given value. + +### HasReason + +`func (o *AdminReviewReassign) HasReason() bool` + +HasReason returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AdminReviewReassignReassignTo.md b/docs/tools/sdk/go/Reference/Beta/Models/AdminReviewReassignReassignTo.md new file mode 100644 index 000000000..4adfd5ed2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AdminReviewReassignReassignTo.md @@ -0,0 +1,90 @@ +--- +id: beta-admin-review-reassign-reassign-to +title: AdminReviewReassignReassignTo +pagination_label: AdminReviewReassignReassignTo +sidebar_label: AdminReviewReassignReassignTo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AdminReviewReassignReassignTo', 'BetaAdminReviewReassignReassignTo'] +slug: /tools/sdk/go/beta/models/admin-review-reassign-reassign-to +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassignReassignTo', 'BetaAdminReviewReassignReassignTo'] +--- + +# AdminReviewReassignReassignTo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity ID to which the review is being assigned. | [optional] +**Type** | Pointer to **string** | The type of the ID provided. | [optional] + +## Methods + +### NewAdminReviewReassignReassignTo + +`func NewAdminReviewReassignReassignTo() *AdminReviewReassignReassignTo` + +NewAdminReviewReassignReassignTo instantiates a new AdminReviewReassignReassignTo 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 + +### NewAdminReviewReassignReassignToWithDefaults + +`func NewAdminReviewReassignReassignToWithDefaults() *AdminReviewReassignReassignTo` + +NewAdminReviewReassignReassignToWithDefaults instantiates a new AdminReviewReassignReassignTo 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 + +### GetId + +`func (o *AdminReviewReassignReassignTo) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AdminReviewReassignReassignTo) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AdminReviewReassignReassignTo) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AdminReviewReassignReassignTo) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AdminReviewReassignReassignTo) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AdminReviewReassignReassignTo) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AdminReviewReassignReassignTo) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AdminReviewReassignReassignTo) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AppAccountDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/AppAccountDetails.md new file mode 100644 index 000000000..3cbe08187 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AppAccountDetails.md @@ -0,0 +1,116 @@ +--- +id: beta-app-account-details +title: AppAccountDetails +pagination_label: AppAccountDetails +sidebar_label: AppAccountDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AppAccountDetails', 'BetaAppAccountDetails'] +slug: /tools/sdk/go/beta/models/app-account-details +tags: ['SDK', 'Software Development Kit', 'AppAccountDetails', 'BetaAppAccountDetails'] +--- + +# AppAccountDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AppId** | Pointer to **string** | The source app ID | [optional] +**AppDisplayName** | Pointer to **string** | The source app display name | [optional] +**SourceAccount** | Pointer to [**AppAccountDetailsSourceAccount**](app-account-details-source-account) | | [optional] + +## Methods + +### NewAppAccountDetails + +`func NewAppAccountDetails() *AppAccountDetails` + +NewAppAccountDetails instantiates a new AppAccountDetails 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 + +### NewAppAccountDetailsWithDefaults + +`func NewAppAccountDetailsWithDefaults() *AppAccountDetails` + +NewAppAccountDetailsWithDefaults instantiates a new AppAccountDetails 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 + +### GetAppId + +`func (o *AppAccountDetails) GetAppId() string` + +GetAppId returns the AppId field if non-nil, zero value otherwise. + +### GetAppIdOk + +`func (o *AppAccountDetails) GetAppIdOk() (*string, bool)` + +GetAppIdOk returns a tuple with the AppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppId + +`func (o *AppAccountDetails) SetAppId(v string)` + +SetAppId sets AppId field to given value. + +### HasAppId + +`func (o *AppAccountDetails) HasAppId() bool` + +HasAppId returns a boolean if a field has been set. + +### GetAppDisplayName + +`func (o *AppAccountDetails) GetAppDisplayName() string` + +GetAppDisplayName returns the AppDisplayName field if non-nil, zero value otherwise. + +### GetAppDisplayNameOk + +`func (o *AppAccountDetails) GetAppDisplayNameOk() (*string, bool)` + +GetAppDisplayNameOk returns a tuple with the AppDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppDisplayName + +`func (o *AppAccountDetails) SetAppDisplayName(v string)` + +SetAppDisplayName sets AppDisplayName field to given value. + +### HasAppDisplayName + +`func (o *AppAccountDetails) HasAppDisplayName() bool` + +HasAppDisplayName returns a boolean if a field has been set. + +### GetSourceAccount + +`func (o *AppAccountDetails) GetSourceAccount() AppAccountDetailsSourceAccount` + +GetSourceAccount returns the SourceAccount field if non-nil, zero value otherwise. + +### GetSourceAccountOk + +`func (o *AppAccountDetails) GetSourceAccountOk() (*AppAccountDetailsSourceAccount, bool)` + +GetSourceAccountOk returns a tuple with the SourceAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceAccount + +`func (o *AppAccountDetails) SetSourceAccount(v AppAccountDetailsSourceAccount)` + +SetSourceAccount sets SourceAccount field to given value. + +### HasSourceAccount + +`func (o *AppAccountDetails) HasSourceAccount() bool` + +HasSourceAccount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AppAccountDetailsSourceAccount.md b/docs/tools/sdk/go/Reference/Beta/Models/AppAccountDetailsSourceAccount.md new file mode 100644 index 000000000..446837941 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AppAccountDetailsSourceAccount.md @@ -0,0 +1,168 @@ +--- +id: beta-app-account-details-source-account +title: AppAccountDetailsSourceAccount +pagination_label: AppAccountDetailsSourceAccount +sidebar_label: AppAccountDetailsSourceAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AppAccountDetailsSourceAccount', 'BetaAppAccountDetailsSourceAccount'] +slug: /tools/sdk/go/beta/models/app-account-details-source-account +tags: ['SDK', 'Software Development Kit', 'AppAccountDetailsSourceAccount', 'BetaAppAccountDetailsSourceAccount'] +--- + +# AppAccountDetailsSourceAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The account ID | [optional] +**NativeIdentity** | Pointer to **string** | The native identity of account | [optional] +**DisplayName** | Pointer to **string** | The display name of account | [optional] +**SourceId** | Pointer to **string** | The source ID of account | [optional] +**SourceDisplayName** | Pointer to **string** | The source name of account | [optional] + +## Methods + +### NewAppAccountDetailsSourceAccount + +`func NewAppAccountDetailsSourceAccount() *AppAccountDetailsSourceAccount` + +NewAppAccountDetailsSourceAccount instantiates a new AppAccountDetailsSourceAccount 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 + +### NewAppAccountDetailsSourceAccountWithDefaults + +`func NewAppAccountDetailsSourceAccountWithDefaults() *AppAccountDetailsSourceAccount` + +NewAppAccountDetailsSourceAccountWithDefaults instantiates a new AppAccountDetailsSourceAccount 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 + +### GetId + +`func (o *AppAccountDetailsSourceAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AppAccountDetailsSourceAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AppAccountDetailsSourceAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AppAccountDetailsSourceAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *AppAccountDetailsSourceAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AppAccountDetailsSourceAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AppAccountDetailsSourceAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AppAccountDetailsSourceAccount) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AppAccountDetailsSourceAccount) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AppAccountDetailsSourceAccount) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AppAccountDetailsSourceAccount) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AppAccountDetailsSourceAccount) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AppAccountDetailsSourceAccount) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AppAccountDetailsSourceAccount) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AppAccountDetailsSourceAccount) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AppAccountDetailsSourceAccount) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceDisplayName + +`func (o *AppAccountDetailsSourceAccount) GetSourceDisplayName() string` + +GetSourceDisplayName returns the SourceDisplayName field if non-nil, zero value otherwise. + +### GetSourceDisplayNameOk + +`func (o *AppAccountDetailsSourceAccount) GetSourceDisplayNameOk() (*string, bool)` + +GetSourceDisplayNameOk returns a tuple with the SourceDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceDisplayName + +`func (o *AppAccountDetailsSourceAccount) SetSourceDisplayName(v string)` + +SetSourceDisplayName sets SourceDisplayName field to given value. + +### HasSourceDisplayName + +`func (o *AppAccountDetailsSourceAccount) HasSourceDisplayName() bool` + +HasSourceDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Approval.md b/docs/tools/sdk/go/Reference/Beta/Models/Approval.md new file mode 100644 index 000000000..70a783ab7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Approval.md @@ -0,0 +1,480 @@ +--- +id: beta-approval +title: Approval +pagination_label: Approval +sidebar_label: Approval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Approval', 'BetaApproval'] +slug: /tools/sdk/go/beta/models/approval +tags: ['SDK', 'Software Development Kit', 'Approval', 'BetaApproval'] +--- + +# Approval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalId** | Pointer to **string** | The Approval ID | [optional] +**Approvers** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Object representation of an approver of an approval | [optional] +**CreatedDate** | Pointer to **string** | Date the approval was created | [optional] +**Type** | Pointer to **string** | Type of approval | [optional] +**Name** | Pointer to [**[]ApprovalName**](approval-name) | The name of the approval for a given locale | [optional] +**BatchRequest** | Pointer to [**ApprovalBatch**](approval-batch) | The name of the approval for a given locale | [optional] +**Description** | Pointer to [**[]ApprovalDescription**](approval-description) | The description of the approval for a given locale | [optional] +**Priority** | Pointer to **string** | The priority of the approval | [optional] +**Requester** | Pointer to [**ApprovalIdentity**](approval-identity) | Object representation of the requester of the approval | [optional] +**Comments** | Pointer to [**[]ApprovalComment**](approval-comment) | Object representation of a comment on the approval | [optional] +**ApprovedBy** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have approved the approval | [optional] +**RejectedBy** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have rejected the approval | [optional] +**CompletedDate** | Pointer to **string** | Date the approval was completed | [optional] +**ApprovalCriteria** | Pointer to **string** | Criteria that needs to be met for an approval to be marked as approved | [optional] +**Status** | Pointer to **string** | The current status of the approval | [optional] +**AdditionalAttributes** | Pointer to **string** | Json string representing additional attributes known about the object to be approved. | [optional] +**ReferenceData** | Pointer to [**[]ApprovalReference**](approval-reference) | Reference data related to the approval | [optional] + +## Methods + +### NewApproval + +`func NewApproval() *Approval` + +NewApproval instantiates a new Approval 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 + +### NewApprovalWithDefaults + +`func NewApprovalWithDefaults() *Approval` + +NewApprovalWithDefaults instantiates a new Approval 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 + +### GetApprovalId + +`func (o *Approval) GetApprovalId() string` + +GetApprovalId returns the ApprovalId field if non-nil, zero value otherwise. + +### GetApprovalIdOk + +`func (o *Approval) GetApprovalIdOk() (*string, bool)` + +GetApprovalIdOk returns a tuple with the ApprovalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalId + +`func (o *Approval) SetApprovalId(v string)` + +SetApprovalId sets ApprovalId field to given value. + +### HasApprovalId + +`func (o *Approval) HasApprovalId() bool` + +HasApprovalId returns a boolean if a field has been set. + +### GetApprovers + +`func (o *Approval) GetApprovers() []ApprovalIdentity` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *Approval) GetApproversOk() (*[]ApprovalIdentity, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *Approval) SetApprovers(v []ApprovalIdentity)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *Approval) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *Approval) GetCreatedDate() string` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *Approval) GetCreatedDateOk() (*string, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *Approval) SetCreatedDate(v string)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *Approval) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetType + +`func (o *Approval) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Approval) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Approval) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Approval) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *Approval) GetName() []ApprovalName` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Approval) GetNameOk() (*[]ApprovalName, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Approval) SetName(v []ApprovalName)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Approval) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetBatchRequest + +`func (o *Approval) GetBatchRequest() ApprovalBatch` + +GetBatchRequest returns the BatchRequest field if non-nil, zero value otherwise. + +### GetBatchRequestOk + +`func (o *Approval) GetBatchRequestOk() (*ApprovalBatch, bool)` + +GetBatchRequestOk returns a tuple with the BatchRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchRequest + +`func (o *Approval) SetBatchRequest(v ApprovalBatch)` + +SetBatchRequest sets BatchRequest field to given value. + +### HasBatchRequest + +`func (o *Approval) HasBatchRequest() bool` + +HasBatchRequest returns a boolean if a field has been set. + +### GetDescription + +`func (o *Approval) GetDescription() []ApprovalDescription` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Approval) GetDescriptionOk() (*[]ApprovalDescription, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Approval) SetDescription(v []ApprovalDescription)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Approval) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetPriority + +`func (o *Approval) GetPriority() string` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *Approval) GetPriorityOk() (*string, 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 *Approval) SetPriority(v string)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *Approval) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetRequester + +`func (o *Approval) GetRequester() ApprovalIdentity` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *Approval) GetRequesterOk() (*ApprovalIdentity, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *Approval) SetRequester(v ApprovalIdentity)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *Approval) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetComments + +`func (o *Approval) GetComments() []ApprovalComment` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *Approval) GetCommentsOk() (*[]ApprovalComment, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *Approval) SetComments(v []ApprovalComment)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *Approval) HasComments() bool` + +HasComments returns a boolean if a field has been set. + +### GetApprovedBy + +`func (o *Approval) GetApprovedBy() []ApprovalIdentity` + +GetApprovedBy returns the ApprovedBy field if non-nil, zero value otherwise. + +### GetApprovedByOk + +`func (o *Approval) GetApprovedByOk() (*[]ApprovalIdentity, bool)` + +GetApprovedByOk returns a tuple with the ApprovedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovedBy + +`func (o *Approval) SetApprovedBy(v []ApprovalIdentity)` + +SetApprovedBy sets ApprovedBy field to given value. + +### HasApprovedBy + +`func (o *Approval) HasApprovedBy() bool` + +HasApprovedBy returns a boolean if a field has been set. + +### GetRejectedBy + +`func (o *Approval) GetRejectedBy() []ApprovalIdentity` + +GetRejectedBy returns the RejectedBy field if non-nil, zero value otherwise. + +### GetRejectedByOk + +`func (o *Approval) GetRejectedByOk() (*[]ApprovalIdentity, bool)` + +GetRejectedByOk returns a tuple with the RejectedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRejectedBy + +`func (o *Approval) SetRejectedBy(v []ApprovalIdentity)` + +SetRejectedBy sets RejectedBy field to given value. + +### HasRejectedBy + +`func (o *Approval) HasRejectedBy() bool` + +HasRejectedBy returns a boolean if a field has been set. + +### GetCompletedDate + +`func (o *Approval) GetCompletedDate() string` + +GetCompletedDate returns the CompletedDate field if non-nil, zero value otherwise. + +### GetCompletedDateOk + +`func (o *Approval) GetCompletedDateOk() (*string, bool)` + +GetCompletedDateOk returns a tuple with the CompletedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedDate + +`func (o *Approval) SetCompletedDate(v string)` + +SetCompletedDate sets CompletedDate field to given value. + +### HasCompletedDate + +`func (o *Approval) HasCompletedDate() bool` + +HasCompletedDate returns a boolean if a field has been set. + +### GetApprovalCriteria + +`func (o *Approval) GetApprovalCriteria() string` + +GetApprovalCriteria returns the ApprovalCriteria field if non-nil, zero value otherwise. + +### GetApprovalCriteriaOk + +`func (o *Approval) GetApprovalCriteriaOk() (*string, bool)` + +GetApprovalCriteriaOk returns a tuple with the ApprovalCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalCriteria + +`func (o *Approval) SetApprovalCriteria(v string)` + +SetApprovalCriteria sets ApprovalCriteria field to given value. + +### HasApprovalCriteria + +`func (o *Approval) HasApprovalCriteria() bool` + +HasApprovalCriteria returns a boolean if a field has been set. + +### GetStatus + +`func (o *Approval) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Approval) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Approval) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Approval) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetAdditionalAttributes + +`func (o *Approval) GetAdditionalAttributes() string` + +GetAdditionalAttributes returns the AdditionalAttributes field if non-nil, zero value otherwise. + +### GetAdditionalAttributesOk + +`func (o *Approval) GetAdditionalAttributesOk() (*string, bool)` + +GetAdditionalAttributesOk returns a tuple with the AdditionalAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAdditionalAttributes + +`func (o *Approval) SetAdditionalAttributes(v string)` + +SetAdditionalAttributes sets AdditionalAttributes field to given value. + +### HasAdditionalAttributes + +`func (o *Approval) HasAdditionalAttributes() bool` + +HasAdditionalAttributes returns a boolean if a field has been set. + +### GetReferenceData + +`func (o *Approval) GetReferenceData() []ApprovalReference` + +GetReferenceData returns the ReferenceData field if non-nil, zero value otherwise. + +### GetReferenceDataOk + +`func (o *Approval) GetReferenceDataOk() (*[]ApprovalReference, bool)` + +GetReferenceDataOk returns a tuple with the ReferenceData field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReferenceData + +`func (o *Approval) SetReferenceData(v []ApprovalReference)` + +SetReferenceData sets ReferenceData field to given value. + +### HasReferenceData + +`func (o *Approval) HasReferenceData() bool` + +HasReferenceData returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalBatch.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalBatch.md new file mode 100644 index 000000000..b87382d80 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalBatch.md @@ -0,0 +1,90 @@ +--- +id: beta-approval-batch +title: ApprovalBatch +pagination_label: ApprovalBatch +sidebar_label: ApprovalBatch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalBatch', 'BetaApprovalBatch'] +slug: /tools/sdk/go/beta/models/approval-batch +tags: ['SDK', 'Software Development Kit', 'ApprovalBatch', 'BetaApprovalBatch'] +--- + +# ApprovalBatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **string** | ID of the batch | [optional] +**BatchSize** | Pointer to **int64** | How many approvals are going to be in this batch. Defaults to 1 if not provided. | [optional] + +## Methods + +### NewApprovalBatch + +`func NewApprovalBatch() *ApprovalBatch` + +NewApprovalBatch instantiates a new ApprovalBatch 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 + +### NewApprovalBatchWithDefaults + +`func NewApprovalBatchWithDefaults() *ApprovalBatch` + +NewApprovalBatchWithDefaults instantiates a new ApprovalBatch 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 + +### GetBatchId + +`func (o *ApprovalBatch) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *ApprovalBatch) GetBatchIdOk() (*string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchId + +`func (o *ApprovalBatch) SetBatchId(v string)` + +SetBatchId sets BatchId field to given value. + +### HasBatchId + +`func (o *ApprovalBatch) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### GetBatchSize + +`func (o *ApprovalBatch) GetBatchSize() int64` + +GetBatchSize returns the BatchSize field if non-nil, zero value otherwise. + +### GetBatchSizeOk + +`func (o *ApprovalBatch) GetBatchSizeOk() (*int64, bool)` + +GetBatchSizeOk returns a tuple with the BatchSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchSize + +`func (o *ApprovalBatch) SetBatchSize(v int64)` + +SetBatchSize sets BatchSize field to given value. + +### HasBatchSize + +`func (o *ApprovalBatch) HasBatchSize() bool` + +HasBatchSize returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalComment.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalComment.md new file mode 100644 index 000000000..731e7fb09 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalComment.md @@ -0,0 +1,116 @@ +--- +id: beta-approval-comment +title: ApprovalComment +pagination_label: ApprovalComment +sidebar_label: ApprovalComment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalComment', 'BetaApprovalComment'] +slug: /tools/sdk/go/beta/models/approval-comment +tags: ['SDK', 'Software Development Kit', 'ApprovalComment', 'BetaApprovalComment'] +--- + +# ApprovalComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Author** | Pointer to [**ApprovalIdentity**](approval-identity) | | [optional] +**Comment** | Pointer to **string** | Comment to be left on an approval | [optional] +**CreatedDate** | Pointer to **string** | Date the comment was created | [optional] + +## Methods + +### NewApprovalComment + +`func NewApprovalComment() *ApprovalComment` + +NewApprovalComment instantiates a new ApprovalComment 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 + +### NewApprovalCommentWithDefaults + +`func NewApprovalCommentWithDefaults() *ApprovalComment` + +NewApprovalCommentWithDefaults instantiates a new ApprovalComment 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 + +### GetAuthor + +`func (o *ApprovalComment) GetAuthor() ApprovalIdentity` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *ApprovalComment) GetAuthorOk() (*ApprovalIdentity, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *ApprovalComment) SetAuthor(v ApprovalIdentity)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *ApprovalComment) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + +### GetComment + +`func (o *ApprovalComment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ApprovalComment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ApprovalComment) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ApprovalComment) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *ApprovalComment) GetCreatedDate() string` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *ApprovalComment) GetCreatedDateOk() (*string, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *ApprovalComment) SetCreatedDate(v string)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *ApprovalComment) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalDescription.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalDescription.md new file mode 100644 index 000000000..ca86877a5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalDescription.md @@ -0,0 +1,90 @@ +--- +id: beta-approval-description +title: ApprovalDescription +pagination_label: ApprovalDescription +sidebar_label: ApprovalDescription +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalDescription', 'BetaApprovalDescription'] +slug: /tools/sdk/go/beta/models/approval-description +tags: ['SDK', 'Software Development Kit', 'ApprovalDescription', 'BetaApprovalDescription'] +--- + +# ApprovalDescription + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | The description of what the approval is asking for | [optional] +**Locale** | Pointer to **string** | What locale the description of the approval is using | [optional] + +## Methods + +### NewApprovalDescription + +`func NewApprovalDescription() *ApprovalDescription` + +NewApprovalDescription instantiates a new ApprovalDescription 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 + +### NewApprovalDescriptionWithDefaults + +`func NewApprovalDescriptionWithDefaults() *ApprovalDescription` + +NewApprovalDescriptionWithDefaults instantiates a new ApprovalDescription 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 + +### GetValue + +`func (o *ApprovalDescription) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ApprovalDescription) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ApprovalDescription) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ApprovalDescription) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetLocale + +`func (o *ApprovalDescription) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *ApprovalDescription) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *ApprovalDescription) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *ApprovalDescription) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalForwardHistory.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalForwardHistory.md new file mode 100644 index 000000000..0ccdff7e1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalForwardHistory.md @@ -0,0 +1,214 @@ +--- +id: beta-approval-forward-history +title: ApprovalForwardHistory +pagination_label: ApprovalForwardHistory +sidebar_label: ApprovalForwardHistory +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalForwardHistory', 'BetaApprovalForwardHistory'] +slug: /tools/sdk/go/beta/models/approval-forward-history +tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory', 'BetaApprovalForwardHistory'] +--- + +# ApprovalForwardHistory + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OldApproverName** | Pointer to **string** | Display name of approver from whom the approval was forwarded. | [optional] +**NewApproverName** | Pointer to **string** | Display name of approver to whom the approval was forwarded. | [optional] +**Comment** | Pointer to **NullableString** | Comment made while forwarding. | [optional] +**Modified** | Pointer to **SailPointTime** | Time at which approval was forwarded. | [optional] +**ForwarderName** | Pointer to **NullableString** | Display name of forwarder who forwarded the approval. | [optional] +**ReassignmentType** | Pointer to [**ReassignmentType**](reassignment-type) | | [optional] + +## Methods + +### NewApprovalForwardHistory + +`func NewApprovalForwardHistory() *ApprovalForwardHistory` + +NewApprovalForwardHistory instantiates a new ApprovalForwardHistory 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 + +### NewApprovalForwardHistoryWithDefaults + +`func NewApprovalForwardHistoryWithDefaults() *ApprovalForwardHistory` + +NewApprovalForwardHistoryWithDefaults instantiates a new ApprovalForwardHistory 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 + +### GetOldApproverName + +`func (o *ApprovalForwardHistory) GetOldApproverName() string` + +GetOldApproverName returns the OldApproverName field if non-nil, zero value otherwise. + +### GetOldApproverNameOk + +`func (o *ApprovalForwardHistory) GetOldApproverNameOk() (*string, bool)` + +GetOldApproverNameOk returns a tuple with the OldApproverName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOldApproverName + +`func (o *ApprovalForwardHistory) SetOldApproverName(v string)` + +SetOldApproverName sets OldApproverName field to given value. + +### HasOldApproverName + +`func (o *ApprovalForwardHistory) HasOldApproverName() bool` + +HasOldApproverName returns a boolean if a field has been set. + +### GetNewApproverName + +`func (o *ApprovalForwardHistory) GetNewApproverName() string` + +GetNewApproverName returns the NewApproverName field if non-nil, zero value otherwise. + +### GetNewApproverNameOk + +`func (o *ApprovalForwardHistory) GetNewApproverNameOk() (*string, bool)` + +GetNewApproverNameOk returns a tuple with the NewApproverName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewApproverName + +`func (o *ApprovalForwardHistory) SetNewApproverName(v string)` + +SetNewApproverName sets NewApproverName field to given value. + +### HasNewApproverName + +`func (o *ApprovalForwardHistory) HasNewApproverName() bool` + +HasNewApproverName returns a boolean if a field has been set. + +### GetComment + +`func (o *ApprovalForwardHistory) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ApprovalForwardHistory) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ApprovalForwardHistory) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ApprovalForwardHistory) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *ApprovalForwardHistory) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *ApprovalForwardHistory) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetModified + +`func (o *ApprovalForwardHistory) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ApprovalForwardHistory) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ApprovalForwardHistory) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ApprovalForwardHistory) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetForwarderName + +`func (o *ApprovalForwardHistory) GetForwarderName() string` + +GetForwarderName returns the ForwarderName field if non-nil, zero value otherwise. + +### GetForwarderNameOk + +`func (o *ApprovalForwardHistory) GetForwarderNameOk() (*string, bool)` + +GetForwarderNameOk returns a tuple with the ForwarderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwarderName + +`func (o *ApprovalForwardHistory) SetForwarderName(v string)` + +SetForwarderName sets ForwarderName field to given value. + +### HasForwarderName + +`func (o *ApprovalForwardHistory) HasForwarderName() bool` + +HasForwarderName returns a boolean if a field has been set. + +### SetForwarderNameNil + +`func (o *ApprovalForwardHistory) SetForwarderNameNil(b bool)` + + SetForwarderNameNil sets the value for ForwarderName to be an explicit nil + +### UnsetForwarderName +`func (o *ApprovalForwardHistory) UnsetForwarderName()` + +UnsetForwarderName ensures that no value is present for ForwarderName, not even an explicit nil +### GetReassignmentType + +`func (o *ApprovalForwardHistory) GetReassignmentType() ReassignmentType` + +GetReassignmentType returns the ReassignmentType field if non-nil, zero value otherwise. + +### GetReassignmentTypeOk + +`func (o *ApprovalForwardHistory) GetReassignmentTypeOk() (*ReassignmentType, bool)` + +GetReassignmentTypeOk returns a tuple with the ReassignmentType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignmentType + +`func (o *ApprovalForwardHistory) SetReassignmentType(v ReassignmentType)` + +SetReassignmentType sets ReassignmentType field to given value. + +### HasReassignmentType + +`func (o *ApprovalForwardHistory) HasReassignmentType() bool` + +HasReassignmentType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalIdentity.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalIdentity.md new file mode 100644 index 000000000..31e3413fa --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalIdentity.md @@ -0,0 +1,116 @@ +--- +id: beta-approval-identity +title: ApprovalIdentity +pagination_label: ApprovalIdentity +sidebar_label: ApprovalIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalIdentity', 'BetaApprovalIdentity'] +slug: /tools/sdk/go/beta/models/approval-identity +tags: ['SDK', 'Software Development Kit', 'ApprovalIdentity', 'BetaApprovalIdentity'] +--- + +# ApprovalIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity ID | [optional] +**Type** | Pointer to **string** | Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc | [optional] +**Name** | Pointer to **string** | Name of the identity | [optional] + +## Methods + +### NewApprovalIdentity + +`func NewApprovalIdentity() *ApprovalIdentity` + +NewApprovalIdentity instantiates a new ApprovalIdentity 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 + +### NewApprovalIdentityWithDefaults + +`func NewApprovalIdentityWithDefaults() *ApprovalIdentity` + +NewApprovalIdentityWithDefaults instantiates a new ApprovalIdentity 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 + +### GetId + +`func (o *ApprovalIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *ApprovalIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ApprovalIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ApprovalIdentity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ApprovalIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalInfoResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalInfoResponse.md new file mode 100644 index 000000000..b46cd4e6d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalInfoResponse.md @@ -0,0 +1,116 @@ +--- +id: beta-approval-info-response +title: ApprovalInfoResponse +pagination_label: ApprovalInfoResponse +sidebar_label: ApprovalInfoResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalInfoResponse', 'BetaApprovalInfoResponse'] +slug: /tools/sdk/go/beta/models/approval-info-response +tags: ['SDK', 'Software Development Kit', 'ApprovalInfoResponse', 'BetaApprovalInfoResponse'] +--- + +# ApprovalInfoResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the id of approver | [optional] +**Name** | Pointer to **string** | the name of approver | [optional] +**Status** | Pointer to **string** | the status of the approval request | [optional] + +## Methods + +### NewApprovalInfoResponse + +`func NewApprovalInfoResponse() *ApprovalInfoResponse` + +NewApprovalInfoResponse instantiates a new ApprovalInfoResponse 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 + +### NewApprovalInfoResponseWithDefaults + +`func NewApprovalInfoResponseWithDefaults() *ApprovalInfoResponse` + +NewApprovalInfoResponseWithDefaults instantiates a new ApprovalInfoResponse 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 + +### GetId + +`func (o *ApprovalInfoResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalInfoResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalInfoResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalInfoResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalInfoResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalInfoResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalInfoResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalInfoResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *ApprovalInfoResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ApprovalInfoResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ApprovalInfoResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ApprovalInfoResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalItemDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalItemDetails.md new file mode 100644 index 000000000..9b3b9d680 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalItemDetails.md @@ -0,0 +1,260 @@ +--- +id: beta-approval-item-details +title: ApprovalItemDetails +pagination_label: ApprovalItemDetails +sidebar_label: ApprovalItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalItemDetails', 'BetaApprovalItemDetails'] +slug: /tools/sdk/go/beta/models/approval-item-details +tags: ['SDK', 'Software Development Kit', 'ApprovalItemDetails', 'BetaApprovalItemDetails'] +--- + +# ApprovalItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The approval item's ID | [optional] +**Account** | Pointer to **NullableString** | The account referenced by the approval item | [optional] +**Application** | Pointer to **string** | The name of the application/source | [optional] +**Name** | Pointer to **NullableString** | The attribute's name | [optional] +**Operation** | Pointer to **string** | The attribute's operation | [optional] +**Value** | Pointer to **NullableString** | The attribute's value | [optional] +**State** | Pointer to [**NullableWorkItemState**](work-item-state) | | [optional] + +## Methods + +### NewApprovalItemDetails + +`func NewApprovalItemDetails() *ApprovalItemDetails` + +NewApprovalItemDetails instantiates a new ApprovalItemDetails 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 + +### NewApprovalItemDetailsWithDefaults + +`func NewApprovalItemDetailsWithDefaults() *ApprovalItemDetails` + +NewApprovalItemDetailsWithDefaults instantiates a new ApprovalItemDetails 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 + +### GetId + +`func (o *ApprovalItemDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalItemDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalItemDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalItemDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccount + +`func (o *ApprovalItemDetails) GetAccount() string` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *ApprovalItemDetails) GetAccountOk() (*string, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *ApprovalItemDetails) SetAccount(v string)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *ApprovalItemDetails) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### SetAccountNil + +`func (o *ApprovalItemDetails) SetAccountNil(b bool)` + + SetAccountNil sets the value for Account to be an explicit nil + +### UnsetAccount +`func (o *ApprovalItemDetails) UnsetAccount()` + +UnsetAccount ensures that no value is present for Account, not even an explicit nil +### GetApplication + +`func (o *ApprovalItemDetails) GetApplication() string` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *ApprovalItemDetails) GetApplicationOk() (*string, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *ApprovalItemDetails) SetApplication(v string)` + +SetApplication sets Application field to given value. + +### HasApplication + +`func (o *ApprovalItemDetails) HasApplication() bool` + +HasApplication returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalItemDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalItemDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalItemDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalItemDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ApprovalItemDetails) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ApprovalItemDetails) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetOperation + +`func (o *ApprovalItemDetails) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ApprovalItemDetails) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ApprovalItemDetails) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ApprovalItemDetails) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetValue + +`func (o *ApprovalItemDetails) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ApprovalItemDetails) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ApprovalItemDetails) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ApprovalItemDetails) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ApprovalItemDetails) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ApprovalItemDetails) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetState + +`func (o *ApprovalItemDetails) GetState() WorkItemState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ApprovalItemDetails) GetStateOk() (*WorkItemState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ApprovalItemDetails) SetState(v WorkItemState)` + +SetState sets State field to given value. + +### HasState + +`func (o *ApprovalItemDetails) HasState() bool` + +HasState returns a boolean if a field has been set. + +### SetStateNil + +`func (o *ApprovalItemDetails) SetStateNil(b bool)` + + SetStateNil sets the value for State to be an explicit nil + +### UnsetState +`func (o *ApprovalItemDetails) UnsetState()` + +UnsetState ensures that no value is present for State, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalItems.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalItems.md new file mode 100644 index 000000000..007ab0eca --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalItems.md @@ -0,0 +1,260 @@ +--- +id: beta-approval-items +title: ApprovalItems +pagination_label: ApprovalItems +sidebar_label: ApprovalItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalItems', 'BetaApprovalItems'] +slug: /tools/sdk/go/beta/models/approval-items +tags: ['SDK', 'Software Development Kit', 'ApprovalItems', 'BetaApprovalItems'] +--- + +# ApprovalItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The approval item's ID | [optional] +**Account** | Pointer to **NullableString** | The account referenced by the approval item | [optional] +**Application** | Pointer to **string** | The name of the application/source | [optional] +**Name** | Pointer to **NullableString** | The attribute's name | [optional] +**Operation** | Pointer to **string** | The attribute's operation | [optional] +**Value** | Pointer to **NullableString** | The attribute's value | [optional] +**State** | Pointer to [**NullableWorkItemState**](work-item-state) | | [optional] + +## Methods + +### NewApprovalItems + +`func NewApprovalItems() *ApprovalItems` + +NewApprovalItems instantiates a new ApprovalItems 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 + +### NewApprovalItemsWithDefaults + +`func NewApprovalItemsWithDefaults() *ApprovalItems` + +NewApprovalItemsWithDefaults instantiates a new ApprovalItems 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 + +### GetId + +`func (o *ApprovalItems) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalItems) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalItems) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalItems) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccount + +`func (o *ApprovalItems) GetAccount() string` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *ApprovalItems) GetAccountOk() (*string, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *ApprovalItems) SetAccount(v string)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *ApprovalItems) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### SetAccountNil + +`func (o *ApprovalItems) SetAccountNil(b bool)` + + SetAccountNil sets the value for Account to be an explicit nil + +### UnsetAccount +`func (o *ApprovalItems) UnsetAccount()` + +UnsetAccount ensures that no value is present for Account, not even an explicit nil +### GetApplication + +`func (o *ApprovalItems) GetApplication() string` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *ApprovalItems) GetApplicationOk() (*string, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *ApprovalItems) SetApplication(v string)` + +SetApplication sets Application field to given value. + +### HasApplication + +`func (o *ApprovalItems) HasApplication() bool` + +HasApplication returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalItems) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalItems) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalItems) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalItems) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ApprovalItems) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ApprovalItems) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetOperation + +`func (o *ApprovalItems) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ApprovalItems) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ApprovalItems) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ApprovalItems) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetValue + +`func (o *ApprovalItems) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ApprovalItems) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ApprovalItems) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ApprovalItems) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ApprovalItems) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ApprovalItems) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetState + +`func (o *ApprovalItems) GetState() WorkItemState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ApprovalItems) GetStateOk() (*WorkItemState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ApprovalItems) SetState(v WorkItemState)` + +SetState sets State field to given value. + +### HasState + +`func (o *ApprovalItems) HasState() bool` + +HasState returns a boolean if a field has been set. + +### SetStateNil + +`func (o *ApprovalItems) SetStateNil(b bool)` + + SetStateNil sets the value for State to be an explicit nil + +### UnsetState +`func (o *ApprovalItems) UnsetState()` + +UnsetState ensures that no value is present for State, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalName.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalName.md new file mode 100644 index 000000000..7f119ee8e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalName.md @@ -0,0 +1,90 @@ +--- +id: beta-approval-name +title: ApprovalName +pagination_label: ApprovalName +sidebar_label: ApprovalName +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalName', 'BetaApprovalName'] +slug: /tools/sdk/go/beta/models/approval-name +tags: ['SDK', 'Software Development Kit', 'ApprovalName', 'BetaApprovalName'] +--- + +# ApprovalName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | Name of the approval | [optional] +**Locale** | Pointer to **string** | What locale the name of the approval is using | [optional] + +## Methods + +### NewApprovalName + +`func NewApprovalName() *ApprovalName` + +NewApprovalName instantiates a new ApprovalName 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 + +### NewApprovalNameWithDefaults + +`func NewApprovalNameWithDefaults() *ApprovalName` + +NewApprovalNameWithDefaults instantiates a new ApprovalName 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 + +### GetValue + +`func (o *ApprovalName) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ApprovalName) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ApprovalName) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ApprovalName) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetLocale + +`func (o *ApprovalName) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *ApprovalName) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *ApprovalName) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *ApprovalName) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalReference.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalReference.md new file mode 100644 index 000000000..f12bb31c7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalReference.md @@ -0,0 +1,90 @@ +--- +id: beta-approval-reference +title: ApprovalReference +pagination_label: ApprovalReference +sidebar_label: ApprovalReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalReference', 'BetaApprovalReference'] +slug: /tools/sdk/go/beta/models/approval-reference +tags: ['SDK', 'Software Development Kit', 'ApprovalReference', 'BetaApprovalReference'] +--- + +# ApprovalReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the reference object | [optional] +**Type** | Pointer to **string** | What reference object does this ID correspond to | [optional] + +## Methods + +### NewApprovalReference + +`func NewApprovalReference() *ApprovalReference` + +NewApprovalReference instantiates a new ApprovalReference 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 + +### NewApprovalReferenceWithDefaults + +`func NewApprovalReferenceWithDefaults() *ApprovalReference` + +NewApprovalReferenceWithDefaults instantiates a new ApprovalReference 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 + +### GetId + +`func (o *ApprovalReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *ApprovalReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ApprovalReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ApprovalReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ApprovalReference) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalReminderAndEscalationConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalReminderAndEscalationConfig.md new file mode 100644 index 000000000..126ec7e84 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalReminderAndEscalationConfig.md @@ -0,0 +1,182 @@ +--- +id: beta-approval-reminder-and-escalation-config +title: ApprovalReminderAndEscalationConfig +pagination_label: ApprovalReminderAndEscalationConfig +sidebar_label: ApprovalReminderAndEscalationConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalReminderAndEscalationConfig', 'BetaApprovalReminderAndEscalationConfig'] +slug: /tools/sdk/go/beta/models/approval-reminder-and-escalation-config +tags: ['SDK', 'Software Development Kit', 'ApprovalReminderAndEscalationConfig', 'BetaApprovalReminderAndEscalationConfig'] +--- + +# ApprovalReminderAndEscalationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DaysUntilEscalation** | Pointer to **NullableInt32** | Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. | [optional] +**DaysBetweenReminders** | Pointer to **NullableInt32** | Number of days to wait between reminder notifications. | [optional] +**MaxReminders** | Pointer to **NullableInt32** | Maximum number of reminder notification to send to the reviewer before approval escalation. | [optional] +**FallbackApproverRef** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] + +## Methods + +### NewApprovalReminderAndEscalationConfig + +`func NewApprovalReminderAndEscalationConfig() *ApprovalReminderAndEscalationConfig` + +NewApprovalReminderAndEscalationConfig instantiates a new ApprovalReminderAndEscalationConfig 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 + +### NewApprovalReminderAndEscalationConfigWithDefaults + +`func NewApprovalReminderAndEscalationConfigWithDefaults() *ApprovalReminderAndEscalationConfig` + +NewApprovalReminderAndEscalationConfigWithDefaults instantiates a new ApprovalReminderAndEscalationConfig 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 + +### GetDaysUntilEscalation + +`func (o *ApprovalReminderAndEscalationConfig) GetDaysUntilEscalation() int32` + +GetDaysUntilEscalation returns the DaysUntilEscalation field if non-nil, zero value otherwise. + +### GetDaysUntilEscalationOk + +`func (o *ApprovalReminderAndEscalationConfig) GetDaysUntilEscalationOk() (*int32, bool)` + +GetDaysUntilEscalationOk returns a tuple with the DaysUntilEscalation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDaysUntilEscalation + +`func (o *ApprovalReminderAndEscalationConfig) SetDaysUntilEscalation(v int32)` + +SetDaysUntilEscalation sets DaysUntilEscalation field to given value. + +### HasDaysUntilEscalation + +`func (o *ApprovalReminderAndEscalationConfig) HasDaysUntilEscalation() bool` + +HasDaysUntilEscalation returns a boolean if a field has been set. + +### SetDaysUntilEscalationNil + +`func (o *ApprovalReminderAndEscalationConfig) SetDaysUntilEscalationNil(b bool)` + + SetDaysUntilEscalationNil sets the value for DaysUntilEscalation to be an explicit nil + +### UnsetDaysUntilEscalation +`func (o *ApprovalReminderAndEscalationConfig) UnsetDaysUntilEscalation()` + +UnsetDaysUntilEscalation ensures that no value is present for DaysUntilEscalation, not even an explicit nil +### GetDaysBetweenReminders + +`func (o *ApprovalReminderAndEscalationConfig) GetDaysBetweenReminders() int32` + +GetDaysBetweenReminders returns the DaysBetweenReminders field if non-nil, zero value otherwise. + +### GetDaysBetweenRemindersOk + +`func (o *ApprovalReminderAndEscalationConfig) GetDaysBetweenRemindersOk() (*int32, bool)` + +GetDaysBetweenRemindersOk returns a tuple with the DaysBetweenReminders field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDaysBetweenReminders + +`func (o *ApprovalReminderAndEscalationConfig) SetDaysBetweenReminders(v int32)` + +SetDaysBetweenReminders sets DaysBetweenReminders field to given value. + +### HasDaysBetweenReminders + +`func (o *ApprovalReminderAndEscalationConfig) HasDaysBetweenReminders() bool` + +HasDaysBetweenReminders returns a boolean if a field has been set. + +### SetDaysBetweenRemindersNil + +`func (o *ApprovalReminderAndEscalationConfig) SetDaysBetweenRemindersNil(b bool)` + + SetDaysBetweenRemindersNil sets the value for DaysBetweenReminders to be an explicit nil + +### UnsetDaysBetweenReminders +`func (o *ApprovalReminderAndEscalationConfig) UnsetDaysBetweenReminders()` + +UnsetDaysBetweenReminders ensures that no value is present for DaysBetweenReminders, not even an explicit nil +### GetMaxReminders + +`func (o *ApprovalReminderAndEscalationConfig) GetMaxReminders() int32` + +GetMaxReminders returns the MaxReminders field if non-nil, zero value otherwise. + +### GetMaxRemindersOk + +`func (o *ApprovalReminderAndEscalationConfig) GetMaxRemindersOk() (*int32, bool)` + +GetMaxRemindersOk returns a tuple with the MaxReminders field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxReminders + +`func (o *ApprovalReminderAndEscalationConfig) SetMaxReminders(v int32)` + +SetMaxReminders sets MaxReminders field to given value. + +### HasMaxReminders + +`func (o *ApprovalReminderAndEscalationConfig) HasMaxReminders() bool` + +HasMaxReminders returns a boolean if a field has been set. + +### SetMaxRemindersNil + +`func (o *ApprovalReminderAndEscalationConfig) SetMaxRemindersNil(b bool)` + + SetMaxRemindersNil sets the value for MaxReminders to be an explicit nil + +### UnsetMaxReminders +`func (o *ApprovalReminderAndEscalationConfig) UnsetMaxReminders()` + +UnsetMaxReminders ensures that no value is present for MaxReminders, not even an explicit nil +### GetFallbackApproverRef + +`func (o *ApprovalReminderAndEscalationConfig) GetFallbackApproverRef() IdentityReferenceWithNameAndEmail` + +GetFallbackApproverRef returns the FallbackApproverRef field if non-nil, zero value otherwise. + +### GetFallbackApproverRefOk + +`func (o *ApprovalReminderAndEscalationConfig) GetFallbackApproverRefOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetFallbackApproverRefOk returns a tuple with the FallbackApproverRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFallbackApproverRef + +`func (o *ApprovalReminderAndEscalationConfig) SetFallbackApproverRef(v IdentityReferenceWithNameAndEmail)` + +SetFallbackApproverRef sets FallbackApproverRef field to given value. + +### HasFallbackApproverRef + +`func (o *ApprovalReminderAndEscalationConfig) HasFallbackApproverRef() bool` + +HasFallbackApproverRef returns a boolean if a field has been set. + +### SetFallbackApproverRefNil + +`func (o *ApprovalReminderAndEscalationConfig) SetFallbackApproverRefNil(b bool)` + + SetFallbackApproverRefNil sets the value for FallbackApproverRef to be an explicit nil + +### UnsetFallbackApproverRef +`func (o *ApprovalReminderAndEscalationConfig) UnsetFallbackApproverRef()` + +UnsetFallbackApproverRef ensures that no value is present for FallbackApproverRef, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalScheme.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalScheme.md new file mode 100644 index 000000000..1a2e24dcc --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalScheme.md @@ -0,0 +1,31 @@ +--- +id: beta-approval-scheme +title: ApprovalScheme +pagination_label: ApprovalScheme +sidebar_label: ApprovalScheme +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalScheme', 'BetaApprovalScheme'] +slug: /tools/sdk/go/beta/models/approval-scheme +tags: ['SDK', 'Software Development Kit', 'ApprovalScheme', 'BetaApprovalScheme'] +--- + +# ApprovalScheme + +## Enum + + +* `APP_OWNER` (value: `"APP_OWNER"`) + +* `SOURCE_OWNER` (value: `"SOURCE_OWNER"`) + +* `MANAGER` (value: `"MANAGER"`) + +* `ROLE_OWNER` (value: `"ROLE_OWNER"`) + +* `ACCESS_PROFILE_OWNER` (value: `"ACCESS_PROFILE_OWNER"`) + +* `ENTITLEMENT_OWNER` (value: `"ENTITLEMENT_OWNER"`) + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalSchemeForRole.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalSchemeForRole.md new file mode 100644 index 000000000..6e73ab237 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalSchemeForRole.md @@ -0,0 +1,100 @@ +--- +id: beta-approval-scheme-for-role +title: ApprovalSchemeForRole +pagination_label: ApprovalSchemeForRole +sidebar_label: ApprovalSchemeForRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalSchemeForRole', 'BetaApprovalSchemeForRole'] +slug: /tools/sdk/go/beta/models/approval-scheme-for-role +tags: ['SDK', 'Software Development Kit', 'ApprovalSchemeForRole', 'BetaApprovalSchemeForRole'] +--- + +# ApprovalSchemeForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApproverType** | Pointer to **string** | Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | Pointer to **NullableString** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] + +## Methods + +### NewApprovalSchemeForRole + +`func NewApprovalSchemeForRole() *ApprovalSchemeForRole` + +NewApprovalSchemeForRole instantiates a new ApprovalSchemeForRole 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 + +### NewApprovalSchemeForRoleWithDefaults + +`func NewApprovalSchemeForRoleWithDefaults() *ApprovalSchemeForRole` + +NewApprovalSchemeForRoleWithDefaults instantiates a new ApprovalSchemeForRole 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 + +### GetApproverType + +`func (o *ApprovalSchemeForRole) GetApproverType() string` + +GetApproverType returns the ApproverType field if non-nil, zero value otherwise. + +### GetApproverTypeOk + +`func (o *ApprovalSchemeForRole) GetApproverTypeOk() (*string, bool)` + +GetApproverTypeOk returns a tuple with the ApproverType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverType + +`func (o *ApprovalSchemeForRole) SetApproverType(v string)` + +SetApproverType sets ApproverType field to given value. + +### HasApproverType + +`func (o *ApprovalSchemeForRole) HasApproverType() bool` + +HasApproverType returns a boolean if a field has been set. + +### GetApproverId + +`func (o *ApprovalSchemeForRole) GetApproverId() string` + +GetApproverId returns the ApproverId field if non-nil, zero value otherwise. + +### GetApproverIdOk + +`func (o *ApprovalSchemeForRole) GetApproverIdOk() (*string, bool)` + +GetApproverIdOk returns a tuple with the ApproverId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverId + +`func (o *ApprovalSchemeForRole) SetApproverId(v string)` + +SetApproverId sets ApproverId field to given value. + +### HasApproverId + +`func (o *ApprovalSchemeForRole) HasApproverId() bool` + +HasApproverId returns a boolean if a field has been set. + +### SetApproverIdNil + +`func (o *ApprovalSchemeForRole) SetApproverIdNil(b bool)` + + SetApproverIdNil sets the value for ApproverId to be an explicit nil + +### UnsetApproverId +`func (o *ApprovalSchemeForRole) UnsetApproverId()` + +UnsetApproverId ensures that no value is present for ApproverId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalStatus.md new file mode 100644 index 000000000..906678ede --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalStatus.md @@ -0,0 +1,27 @@ +--- +id: beta-approval-status +title: ApprovalStatus +pagination_label: ApprovalStatus +sidebar_label: ApprovalStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalStatus', 'BetaApprovalStatus'] +slug: /tools/sdk/go/beta/models/approval-status +tags: ['SDK', 'Software Development Kit', 'ApprovalStatus', 'BetaApprovalStatus'] +--- + +# ApprovalStatus + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `PENDING` (value: `"PENDING"`) + +* `NOT_READY` (value: `"NOT_READY"`) + +* `CANCELLED` (value: `"CANCELLED"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalStatusDto.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalStatusDto.md new file mode 100644 index 000000000..f247215bc --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalStatusDto.md @@ -0,0 +1,348 @@ +--- +id: beta-approval-status-dto +title: ApprovalStatusDto +pagination_label: ApprovalStatusDto +sidebar_label: ApprovalStatusDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalStatusDto', 'BetaApprovalStatusDto'] +slug: /tools/sdk/go/beta/models/approval-status-dto +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto', 'BetaApprovalStatusDto'] +--- + +# ApprovalStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalId** | Pointer to **NullableString** | Unique identifier for the approval. | [optional] +**Forwarded** | Pointer to **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to false] +**OriginalOwner** | Pointer to [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional] +**CurrentOwner** | Pointer to [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional] +**Modified** | Pointer to **NullableTime** | Time at which item was modified. | [optional] +**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**Scheme** | Pointer to [**ApprovalScheme**](approval-scheme) | | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | If the request failed, includes any error messages that were generated. | [optional] +**Comment** | Pointer to **NullableString** | Comment, if any, provided by the approver. | [optional] +**RemoveDate** | Pointer to **NullableTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] + +## Methods + +### NewApprovalStatusDto + +`func NewApprovalStatusDto() *ApprovalStatusDto` + +NewApprovalStatusDto instantiates a new ApprovalStatusDto 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 + +### NewApprovalStatusDtoWithDefaults + +`func NewApprovalStatusDtoWithDefaults() *ApprovalStatusDto` + +NewApprovalStatusDtoWithDefaults instantiates a new ApprovalStatusDto 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 + +### GetApprovalId + +`func (o *ApprovalStatusDto) GetApprovalId() string` + +GetApprovalId returns the ApprovalId field if non-nil, zero value otherwise. + +### GetApprovalIdOk + +`func (o *ApprovalStatusDto) GetApprovalIdOk() (*string, bool)` + +GetApprovalIdOk returns a tuple with the ApprovalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalId + +`func (o *ApprovalStatusDto) SetApprovalId(v string)` + +SetApprovalId sets ApprovalId field to given value. + +### HasApprovalId + +`func (o *ApprovalStatusDto) HasApprovalId() bool` + +HasApprovalId returns a boolean if a field has been set. + +### SetApprovalIdNil + +`func (o *ApprovalStatusDto) SetApprovalIdNil(b bool)` + + SetApprovalIdNil sets the value for ApprovalId to be an explicit nil + +### UnsetApprovalId +`func (o *ApprovalStatusDto) UnsetApprovalId()` + +UnsetApprovalId ensures that no value is present for ApprovalId, not even an explicit nil +### GetForwarded + +`func (o *ApprovalStatusDto) GetForwarded() bool` + +GetForwarded returns the Forwarded field if non-nil, zero value otherwise. + +### GetForwardedOk + +`func (o *ApprovalStatusDto) GetForwardedOk() (*bool, bool)` + +GetForwardedOk returns a tuple with the Forwarded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwarded + +`func (o *ApprovalStatusDto) SetForwarded(v bool)` + +SetForwarded sets Forwarded field to given value. + +### HasForwarded + +`func (o *ApprovalStatusDto) HasForwarded() bool` + +HasForwarded returns a boolean if a field has been set. + +### GetOriginalOwner + +`func (o *ApprovalStatusDto) GetOriginalOwner() ApprovalStatusDtoOriginalOwner` + +GetOriginalOwner returns the OriginalOwner field if non-nil, zero value otherwise. + +### GetOriginalOwnerOk + +`func (o *ApprovalStatusDto) GetOriginalOwnerOk() (*ApprovalStatusDtoOriginalOwner, bool)` + +GetOriginalOwnerOk returns a tuple with the OriginalOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalOwner + +`func (o *ApprovalStatusDto) SetOriginalOwner(v ApprovalStatusDtoOriginalOwner)` + +SetOriginalOwner sets OriginalOwner field to given value. + +### HasOriginalOwner + +`func (o *ApprovalStatusDto) HasOriginalOwner() bool` + +HasOriginalOwner returns a boolean if a field has been set. + +### GetCurrentOwner + +`func (o *ApprovalStatusDto) GetCurrentOwner() ApprovalStatusDtoCurrentOwner` + +GetCurrentOwner returns the CurrentOwner field if non-nil, zero value otherwise. + +### GetCurrentOwnerOk + +`func (o *ApprovalStatusDto) GetCurrentOwnerOk() (*ApprovalStatusDtoCurrentOwner, bool)` + +GetCurrentOwnerOk returns a tuple with the CurrentOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentOwner + +`func (o *ApprovalStatusDto) SetCurrentOwner(v ApprovalStatusDtoCurrentOwner)` + +SetCurrentOwner sets CurrentOwner field to given value. + +### HasCurrentOwner + +`func (o *ApprovalStatusDto) HasCurrentOwner() bool` + +HasCurrentOwner returns a boolean if a field has been set. + +### GetModified + +`func (o *ApprovalStatusDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ApprovalStatusDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ApprovalStatusDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ApprovalStatusDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *ApprovalStatusDto) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *ApprovalStatusDto) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetStatus + +`func (o *ApprovalStatusDto) GetStatus() ManualWorkItemState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ApprovalStatusDto) GetStatusOk() (*ManualWorkItemState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ApprovalStatusDto) SetStatus(v ManualWorkItemState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ApprovalStatusDto) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetScheme + +`func (o *ApprovalStatusDto) GetScheme() ApprovalScheme` + +GetScheme returns the Scheme field if non-nil, zero value otherwise. + +### GetSchemeOk + +`func (o *ApprovalStatusDto) GetSchemeOk() (*ApprovalScheme, bool)` + +GetSchemeOk returns a tuple with the Scheme field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheme + +`func (o *ApprovalStatusDto) SetScheme(v ApprovalScheme)` + +SetScheme sets Scheme field to given value. + +### HasScheme + +`func (o *ApprovalStatusDto) HasScheme() bool` + +HasScheme returns a boolean if a field has been set. + +### GetErrorMessages + +`func (o *ApprovalStatusDto) GetErrorMessages() []ErrorMessageDto` + +GetErrorMessages returns the ErrorMessages field if non-nil, zero value otherwise. + +### GetErrorMessagesOk + +`func (o *ApprovalStatusDto) GetErrorMessagesOk() (*[]ErrorMessageDto, bool)` + +GetErrorMessagesOk returns a tuple with the ErrorMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessages + +`func (o *ApprovalStatusDto) SetErrorMessages(v []ErrorMessageDto)` + +SetErrorMessages sets ErrorMessages field to given value. + +### HasErrorMessages + +`func (o *ApprovalStatusDto) HasErrorMessages() bool` + +HasErrorMessages returns a boolean if a field has been set. + +### SetErrorMessagesNil + +`func (o *ApprovalStatusDto) SetErrorMessagesNil(b bool)` + + SetErrorMessagesNil sets the value for ErrorMessages to be an explicit nil + +### UnsetErrorMessages +`func (o *ApprovalStatusDto) UnsetErrorMessages()` + +UnsetErrorMessages ensures that no value is present for ErrorMessages, not even an explicit nil +### GetComment + +`func (o *ApprovalStatusDto) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ApprovalStatusDto) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ApprovalStatusDto) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ApprovalStatusDto) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *ApprovalStatusDto) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *ApprovalStatusDto) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetRemoveDate + +`func (o *ApprovalStatusDto) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *ApprovalStatusDto) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *ApprovalStatusDto) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *ApprovalStatusDto) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *ApprovalStatusDto) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *ApprovalStatusDto) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalStatusDtoCurrentOwner.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalStatusDtoCurrentOwner.md new file mode 100644 index 000000000..8036bbc2e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalStatusDtoCurrentOwner.md @@ -0,0 +1,116 @@ +--- +id: beta-approval-status-dto-current-owner +title: ApprovalStatusDtoCurrentOwner +pagination_label: ApprovalStatusDtoCurrentOwner +sidebar_label: ApprovalStatusDtoCurrentOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalStatusDtoCurrentOwner', 'BetaApprovalStatusDtoCurrentOwner'] +slug: /tools/sdk/go/beta/models/approval-status-dto-current-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoCurrentOwner', 'BetaApprovalStatusDtoCurrentOwner'] +--- + +# ApprovalStatusDtoCurrentOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity who reviewed the access item request. | [optional] +**Id** | Pointer to **string** | ID of identity who reviewed the access item request. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity who reviewed the access item request. | [optional] + +## Methods + +### NewApprovalStatusDtoCurrentOwner + +`func NewApprovalStatusDtoCurrentOwner() *ApprovalStatusDtoCurrentOwner` + +NewApprovalStatusDtoCurrentOwner instantiates a new ApprovalStatusDtoCurrentOwner 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 + +### NewApprovalStatusDtoCurrentOwnerWithDefaults + +`func NewApprovalStatusDtoCurrentOwnerWithDefaults() *ApprovalStatusDtoCurrentOwner` + +NewApprovalStatusDtoCurrentOwnerWithDefaults instantiates a new ApprovalStatusDtoCurrentOwner 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 + +### GetType + +`func (o *ApprovalStatusDtoCurrentOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ApprovalStatusDtoCurrentOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ApprovalStatusDtoCurrentOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ApprovalStatusDtoCurrentOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ApprovalStatusDtoCurrentOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalStatusDtoCurrentOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalStatusDtoCurrentOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalStatusDtoCurrentOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalStatusDtoCurrentOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalStatusDtoCurrentOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalStatusDtoCurrentOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalStatusDtoCurrentOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalStatusDtoOriginalOwner.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalStatusDtoOriginalOwner.md new file mode 100644 index 000000000..80681ea01 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalStatusDtoOriginalOwner.md @@ -0,0 +1,116 @@ +--- +id: beta-approval-status-dto-original-owner +title: ApprovalStatusDtoOriginalOwner +pagination_label: ApprovalStatusDtoOriginalOwner +sidebar_label: ApprovalStatusDtoOriginalOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalStatusDtoOriginalOwner', 'BetaApprovalStatusDtoOriginalOwner'] +slug: /tools/sdk/go/beta/models/approval-status-dto-original-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoOriginalOwner', 'BetaApprovalStatusDtoOriginalOwner'] +--- + +# ApprovalStatusDtoOriginalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of original approval owner's identity. | [optional] +**Id** | Pointer to **string** | ID of original approval owner's identity. | [optional] +**Name** | Pointer to **string** | Display name of original approval owner. | [optional] + +## Methods + +### NewApprovalStatusDtoOriginalOwner + +`func NewApprovalStatusDtoOriginalOwner() *ApprovalStatusDtoOriginalOwner` + +NewApprovalStatusDtoOriginalOwner instantiates a new ApprovalStatusDtoOriginalOwner 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 + +### NewApprovalStatusDtoOriginalOwnerWithDefaults + +`func NewApprovalStatusDtoOriginalOwnerWithDefaults() *ApprovalStatusDtoOriginalOwner` + +NewApprovalStatusDtoOriginalOwnerWithDefaults instantiates a new ApprovalStatusDtoOriginalOwner 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 + +### GetType + +`func (o *ApprovalStatusDtoOriginalOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ApprovalStatusDtoOriginalOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ApprovalStatusDtoOriginalOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ApprovalStatusDtoOriginalOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ApprovalStatusDtoOriginalOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalStatusDtoOriginalOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalStatusDtoOriginalOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalStatusDtoOriginalOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalStatusDtoOriginalOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalStatusDtoOriginalOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalStatusDtoOriginalOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalStatusDtoOriginalOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ApprovalSummary.md b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalSummary.md new file mode 100644 index 000000000..78d3db884 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ApprovalSummary.md @@ -0,0 +1,116 @@ +--- +id: beta-approval-summary +title: ApprovalSummary +pagination_label: ApprovalSummary +sidebar_label: ApprovalSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalSummary', 'BetaApprovalSummary'] +slug: /tools/sdk/go/beta/models/approval-summary +tags: ['SDK', 'Software Development Kit', 'ApprovalSummary', 'BetaApprovalSummary'] +--- + +# ApprovalSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Pending** | Pointer to **int32** | The number of pending access requests approvals. | [optional] +**Approved** | Pointer to **int32** | The number of approved access requests approvals. | [optional] +**Rejected** | Pointer to **int32** | The number of rejected access requests approvals. | [optional] + +## Methods + +### NewApprovalSummary + +`func NewApprovalSummary() *ApprovalSummary` + +NewApprovalSummary instantiates a new ApprovalSummary 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 + +### NewApprovalSummaryWithDefaults + +`func NewApprovalSummaryWithDefaults() *ApprovalSummary` + +NewApprovalSummaryWithDefaults instantiates a new ApprovalSummary 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 + +### GetPending + +`func (o *ApprovalSummary) GetPending() int32` + +GetPending returns the Pending field if non-nil, zero value otherwise. + +### GetPendingOk + +`func (o *ApprovalSummary) GetPendingOk() (*int32, bool)` + +GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPending + +`func (o *ApprovalSummary) SetPending(v int32)` + +SetPending sets Pending field to given value. + +### HasPending + +`func (o *ApprovalSummary) HasPending() bool` + +HasPending returns a boolean if a field has been set. + +### GetApproved + +`func (o *ApprovalSummary) GetApproved() int32` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *ApprovalSummary) GetApprovedOk() (*int32, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *ApprovalSummary) SetApproved(v int32)` + +SetApproved sets Approved field to given value. + +### HasApproved + +`func (o *ApprovalSummary) HasApproved() bool` + +HasApproved returns a boolean if a field has been set. + +### GetRejected + +`func (o *ApprovalSummary) GetRejected() int32` + +GetRejected returns the Rejected field if non-nil, zero value otherwise. + +### GetRejectedOk + +`func (o *ApprovalSummary) GetRejectedOk() (*int32, bool)` + +GetRejectedOk returns a tuple with the Rejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRejected + +`func (o *ApprovalSummary) SetRejected(v int32)` + +SetRejected sets Rejected field to given value. + +### HasRejected + +`func (o *ApprovalSummary) HasRejected() bool` + +HasRejected returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Argument.md b/docs/tools/sdk/go/Reference/Beta/Models/Argument.md new file mode 100644 index 000000000..6acbd39a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Argument.md @@ -0,0 +1,121 @@ +--- +id: beta-argument +title: Argument +pagination_label: Argument +sidebar_label: Argument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Argument', 'BetaArgument'] +slug: /tools/sdk/go/beta/models/argument +tags: ['SDK', 'Software Development Kit', 'Argument', 'BetaArgument'] +--- + +# Argument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | the name of the argument | +**Description** | Pointer to **string** | the description of the argument | [optional] +**Type** | Pointer to **NullableString** | the programmatic type of the argument | [optional] + +## Methods + +### NewArgument + +`func NewArgument(name string, ) *Argument` + +NewArgument instantiates a new Argument 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 + +### NewArgumentWithDefaults + +`func NewArgumentWithDefaults() *Argument` + +NewArgumentWithDefaults instantiates a new Argument 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 + +### GetName + +`func (o *Argument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Argument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Argument) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Argument) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Argument) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Argument) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Argument) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetType + +`func (o *Argument) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Argument) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Argument) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Argument) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *Argument) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *Argument) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ArrayInner.md b/docs/tools/sdk/go/Reference/Beta/Models/ArrayInner.md new file mode 100644 index 000000000..93f2a228f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ArrayInner.md @@ -0,0 +1,38 @@ +--- +id: beta-array-inner +title: ArrayInner +pagination_label: ArrayInner +sidebar_label: ArrayInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ArrayInner', 'BetaArrayInner'] +slug: /tools/sdk/go/beta/models/array-inner +tags: ['SDK', 'Software Development Kit', 'ArrayInner', 'BetaArrayInner'] +--- + +# ArrayInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewArrayInner + +`func NewArrayInner() *ArrayInner` + +NewArrayInner instantiates a new ArrayInner 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 + +### NewArrayInnerWithDefaults + +`func NewArrayInnerWithDefaults() *ArrayInner` + +NewArrayInnerWithDefaults instantiates a new ArrayInner 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 + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ArrayInner1.md b/docs/tools/sdk/go/Reference/Beta/Models/ArrayInner1.md new file mode 100644 index 000000000..c26878de0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ArrayInner1.md @@ -0,0 +1,38 @@ +--- +id: beta-array-inner1 +title: ArrayInner1 +pagination_label: ArrayInner1 +sidebar_label: ArrayInner1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ArrayInner1', 'BetaArrayInner1'] +slug: /tools/sdk/go/beta/models/array-inner1 +tags: ['SDK', 'Software Development Kit', 'ArrayInner1', 'BetaArrayInner1'] +--- + +# ArrayInner1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewArrayInner1 + +`func NewArrayInner1() *ArrayInner1` + +NewArrayInner1 instantiates a new ArrayInner1 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 + +### NewArrayInner1WithDefaults + +`func NewArrayInner1WithDefaults() *ArrayInner1` + +NewArrayInner1WithDefaults instantiates a new ArrayInner1 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 + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AssignmentContextDto.md b/docs/tools/sdk/go/Reference/Beta/Models/AssignmentContextDto.md new file mode 100644 index 000000000..9428d3444 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AssignmentContextDto.md @@ -0,0 +1,116 @@ +--- +id: beta-assignment-context-dto +title: AssignmentContextDto +pagination_label: AssignmentContextDto +sidebar_label: AssignmentContextDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AssignmentContextDto', 'BetaAssignmentContextDto'] +slug: /tools/sdk/go/beta/models/assignment-context-dto +tags: ['SDK', 'Software Development Kit', 'AssignmentContextDto', 'BetaAssignmentContextDto'] +--- + +# AssignmentContextDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Requested** | Pointer to [**AccessRequestContext**](access-request-context) | | [optional] +**Matched** | Pointer to [**[]RoleMatchDto**](role-match-dto) | | [optional] +**ComputedDate** | Pointer to **string** | Date that the assignment will was evaluated | [optional] + +## Methods + +### NewAssignmentContextDto + +`func NewAssignmentContextDto() *AssignmentContextDto` + +NewAssignmentContextDto instantiates a new AssignmentContextDto 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 + +### NewAssignmentContextDtoWithDefaults + +`func NewAssignmentContextDtoWithDefaults() *AssignmentContextDto` + +NewAssignmentContextDtoWithDefaults instantiates a new AssignmentContextDto 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 + +### GetRequested + +`func (o *AssignmentContextDto) GetRequested() AccessRequestContext` + +GetRequested returns the Requested field if non-nil, zero value otherwise. + +### GetRequestedOk + +`func (o *AssignmentContextDto) GetRequestedOk() (*AccessRequestContext, bool)` + +GetRequestedOk returns a tuple with the Requested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequested + +`func (o *AssignmentContextDto) SetRequested(v AccessRequestContext)` + +SetRequested sets Requested field to given value. + +### HasRequested + +`func (o *AssignmentContextDto) HasRequested() bool` + +HasRequested returns a boolean if a field has been set. + +### GetMatched + +`func (o *AssignmentContextDto) GetMatched() []RoleMatchDto` + +GetMatched returns the Matched field if non-nil, zero value otherwise. + +### GetMatchedOk + +`func (o *AssignmentContextDto) GetMatchedOk() (*[]RoleMatchDto, bool)` + +GetMatchedOk returns a tuple with the Matched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatched + +`func (o *AssignmentContextDto) SetMatched(v []RoleMatchDto)` + +SetMatched sets Matched field to given value. + +### HasMatched + +`func (o *AssignmentContextDto) HasMatched() bool` + +HasMatched returns a boolean if a field has been set. + +### GetComputedDate + +`func (o *AssignmentContextDto) GetComputedDate() string` + +GetComputedDate returns the ComputedDate field if non-nil, zero value otherwise. + +### GetComputedDateOk + +`func (o *AssignmentContextDto) GetComputedDateOk() (*string, bool)` + +GetComputedDateOk returns a tuple with the ComputedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComputedDate + +`func (o *AssignmentContextDto) SetComputedDate(v string)` + +SetComputedDate sets ComputedDate field to given value. + +### HasComputedDate + +`func (o *AssignmentContextDto) HasComputedDate() bool` + +HasComputedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AttrSyncSource.md b/docs/tools/sdk/go/Reference/Beta/Models/AttrSyncSource.md new file mode 100644 index 000000000..b947e1c45 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AttrSyncSource.md @@ -0,0 +1,116 @@ +--- +id: beta-attr-sync-source +title: AttrSyncSource +pagination_label: AttrSyncSource +sidebar_label: AttrSyncSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttrSyncSource', 'BetaAttrSyncSource'] +slug: /tools/sdk/go/beta/models/attr-sync-source +tags: ['SDK', 'Software Development Kit', 'AttrSyncSource', 'BetaAttrSyncSource'] +--- + +# AttrSyncSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of target source for attribute synchronization. | [optional] +**Id** | Pointer to **string** | ID of target source for attribute synchronization. | [optional] +**Name** | Pointer to **string** | Human-readable name of target source for attribute synchronization. | [optional] + +## Methods + +### NewAttrSyncSource + +`func NewAttrSyncSource() *AttrSyncSource` + +NewAttrSyncSource instantiates a new AttrSyncSource 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 + +### NewAttrSyncSourceWithDefaults + +`func NewAttrSyncSourceWithDefaults() *AttrSyncSource` + +NewAttrSyncSourceWithDefaults instantiates a new AttrSyncSource 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 + +### GetType + +`func (o *AttrSyncSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttrSyncSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttrSyncSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttrSyncSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AttrSyncSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AttrSyncSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AttrSyncSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AttrSyncSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AttrSyncSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttrSyncSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttrSyncSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttrSyncSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AttrSyncSourceAttributeConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/AttrSyncSourceAttributeConfig.md new file mode 100644 index 000000000..2e4769287 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AttrSyncSourceAttributeConfig.md @@ -0,0 +1,122 @@ +--- +id: beta-attr-sync-source-attribute-config +title: AttrSyncSourceAttributeConfig +pagination_label: AttrSyncSourceAttributeConfig +sidebar_label: AttrSyncSourceAttributeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttrSyncSourceAttributeConfig', 'BetaAttrSyncSourceAttributeConfig'] +slug: /tools/sdk/go/beta/models/attr-sync-source-attribute-config +tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceAttributeConfig', 'BetaAttrSyncSourceAttributeConfig'] +--- + +# AttrSyncSourceAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Name of the identity attribute | +**DisplayName** | **string** | Display name of the identity attribute | +**Enabled** | **bool** | Determines whether or not the attribute is enabled for synchronization | +**Target** | **string** | Name of the source account attribute to which the identity attribute value will be synchronized if enabled | + +## Methods + +### NewAttrSyncSourceAttributeConfig + +`func NewAttrSyncSourceAttributeConfig(name string, displayName string, enabled bool, target string, ) *AttrSyncSourceAttributeConfig` + +NewAttrSyncSourceAttributeConfig instantiates a new AttrSyncSourceAttributeConfig 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 + +### NewAttrSyncSourceAttributeConfigWithDefaults + +`func NewAttrSyncSourceAttributeConfigWithDefaults() *AttrSyncSourceAttributeConfig` + +NewAttrSyncSourceAttributeConfigWithDefaults instantiates a new AttrSyncSourceAttributeConfig 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 + +### GetName + +`func (o *AttrSyncSourceAttributeConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttrSyncSourceAttributeConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttrSyncSourceAttributeConfig) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDisplayName + +`func (o *AttrSyncSourceAttributeConfig) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AttrSyncSourceAttributeConfig) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AttrSyncSourceAttributeConfig) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + + +### GetEnabled + +`func (o *AttrSyncSourceAttributeConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AttrSyncSourceAttributeConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AttrSyncSourceAttributeConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetTarget + +`func (o *AttrSyncSourceAttributeConfig) GetTarget() string` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *AttrSyncSourceAttributeConfig) GetTargetOk() (*string, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *AttrSyncSourceAttributeConfig) SetTarget(v string)` + +SetTarget sets Target field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AttrSyncSourceConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/AttrSyncSourceConfig.md new file mode 100644 index 000000000..5afaf2d2b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AttrSyncSourceConfig.md @@ -0,0 +1,80 @@ +--- +id: beta-attr-sync-source-config +title: AttrSyncSourceConfig +pagination_label: AttrSyncSourceConfig +sidebar_label: AttrSyncSourceConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttrSyncSourceConfig', 'BetaAttrSyncSourceConfig'] +slug: /tools/sdk/go/beta/models/attr-sync-source-config +tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceConfig', 'BetaAttrSyncSourceConfig'] +--- + +# AttrSyncSourceConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**AttrSyncSource**](attr-sync-source) | | +**Attributes** | [**[]AttrSyncSourceAttributeConfig**](attr-sync-source-attribute-config) | Attribute synchronization configuration for specific identity attributes in the context of a source | + +## Methods + +### NewAttrSyncSourceConfig + +`func NewAttrSyncSourceConfig(source AttrSyncSource, attributes []AttrSyncSourceAttributeConfig, ) *AttrSyncSourceConfig` + +NewAttrSyncSourceConfig instantiates a new AttrSyncSourceConfig 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 + +### NewAttrSyncSourceConfigWithDefaults + +`func NewAttrSyncSourceConfigWithDefaults() *AttrSyncSourceConfig` + +NewAttrSyncSourceConfigWithDefaults instantiates a new AttrSyncSourceConfig 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 + +### GetSource + +`func (o *AttrSyncSourceConfig) GetSource() AttrSyncSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AttrSyncSourceConfig) GetSourceOk() (*AttrSyncSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AttrSyncSourceConfig) SetSource(v AttrSyncSource)` + +SetSource sets Source field to given value. + + +### GetAttributes + +`func (o *AttrSyncSourceConfig) GetAttributes() []AttrSyncSourceAttributeConfig` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AttrSyncSourceConfig) GetAttributesOk() (*[]AttrSyncSourceAttributeConfig, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AttrSyncSourceConfig) SetAttributes(v []AttrSyncSourceAttributeConfig)` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AttributeChange.md b/docs/tools/sdk/go/Reference/Beta/Models/AttributeChange.md new file mode 100644 index 000000000..21aecef08 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AttributeChange.md @@ -0,0 +1,116 @@ +--- +id: beta-attribute-change +title: AttributeChange +pagination_label: AttributeChange +sidebar_label: AttributeChange +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeChange', 'BetaAttributeChange'] +slug: /tools/sdk/go/beta/models/attribute-change +tags: ['SDK', 'Software Development Kit', 'AttributeChange', 'BetaAttributeChange'] +--- + +# AttributeChange + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | the attribute name | [optional] +**PreviousValue** | Pointer to **string** | the old value of attribute | [optional] +**NewValue** | Pointer to **string** | the new value of attribute | [optional] + +## Methods + +### NewAttributeChange + +`func NewAttributeChange() *AttributeChange` + +NewAttributeChange instantiates a new AttributeChange 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 + +### NewAttributeChangeWithDefaults + +`func NewAttributeChangeWithDefaults() *AttributeChange` + +NewAttributeChangeWithDefaults instantiates a new AttributeChange 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 + +### GetName + +`func (o *AttributeChange) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeChange) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeChange) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeChange) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPreviousValue + +`func (o *AttributeChange) GetPreviousValue() string` + +GetPreviousValue returns the PreviousValue field if non-nil, zero value otherwise. + +### GetPreviousValueOk + +`func (o *AttributeChange) GetPreviousValueOk() (*string, bool)` + +GetPreviousValueOk returns a tuple with the PreviousValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousValue + +`func (o *AttributeChange) SetPreviousValue(v string)` + +SetPreviousValue sets PreviousValue field to given value. + +### HasPreviousValue + +`func (o *AttributeChange) HasPreviousValue() bool` + +HasPreviousValue returns a boolean if a field has been set. + +### GetNewValue + +`func (o *AttributeChange) GetNewValue() string` + +GetNewValue returns the NewValue field if non-nil, zero value otherwise. + +### GetNewValueOk + +`func (o *AttributeChange) GetNewValueOk() (*string, bool)` + +GetNewValueOk returns a tuple with the NewValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewValue + +`func (o *AttributeChange) SetNewValue(v string)` + +SetNewValue sets NewValue field to given value. + +### HasNewValue + +`func (o *AttributeChange) HasNewValue() bool` + +HasNewValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AttributeDTO.md b/docs/tools/sdk/go/Reference/Beta/Models/AttributeDTO.md new file mode 100644 index 000000000..cccd42c53 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AttributeDTO.md @@ -0,0 +1,266 @@ +--- +id: beta-attribute-dto +title: AttributeDTO +pagination_label: AttributeDTO +sidebar_label: AttributeDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDTO', 'BetaAttributeDTO'] +slug: /tools/sdk/go/beta/models/attribute-dto +tags: ['SDK', 'Software Development Kit', 'AttributeDTO', 'BetaAttributeDTO'] +--- + +# AttributeDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [optional] +**Name** | Pointer to **string** | The display name of the key. | [optional] +**Multiselect** | Pointer to **bool** | Indicates whether the attribute can have multiple values. | [optional] [default to false] +**Status** | Pointer to **string** | The status of the Attribute. | [optional] +**Type** | Pointer to **string** | The type of the Attribute. This can be either \"custom\" or \"governance\". | [optional] +**ObjectTypes** | Pointer to **[]string** | An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. | [optional] +**Description** | Pointer to **string** | The description of the Attribute. | [optional] +**Values** | Pointer to [**[]AttributeValueDTO**](attribute-value-dto) | | [optional] + +## Methods + +### NewAttributeDTO + +`func NewAttributeDTO() *AttributeDTO` + +NewAttributeDTO instantiates a new AttributeDTO 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 + +### NewAttributeDTOWithDefaults + +`func NewAttributeDTOWithDefaults() *AttributeDTO` + +NewAttributeDTOWithDefaults instantiates a new AttributeDTO 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 + +### GetKey + +`func (o *AttributeDTO) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *AttributeDTO) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *AttributeDTO) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *AttributeDTO) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *AttributeDTO) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeDTO) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeDTO) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeDTO) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetMultiselect + +`func (o *AttributeDTO) GetMultiselect() bool` + +GetMultiselect returns the Multiselect field if non-nil, zero value otherwise. + +### GetMultiselectOk + +`func (o *AttributeDTO) GetMultiselectOk() (*bool, bool)` + +GetMultiselectOk returns a tuple with the Multiselect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultiselect + +`func (o *AttributeDTO) SetMultiselect(v bool)` + +SetMultiselect sets Multiselect field to given value. + +### HasMultiselect + +`func (o *AttributeDTO) HasMultiselect() bool` + +HasMultiselect returns a boolean if a field has been set. + +### GetStatus + +`func (o *AttributeDTO) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AttributeDTO) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AttributeDTO) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AttributeDTO) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetType + +`func (o *AttributeDTO) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttributeDTO) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttributeDTO) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttributeDTO) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetObjectTypes + +`func (o *AttributeDTO) GetObjectTypes() []string` + +GetObjectTypes returns the ObjectTypes field if non-nil, zero value otherwise. + +### GetObjectTypesOk + +`func (o *AttributeDTO) GetObjectTypesOk() (*[]string, bool)` + +GetObjectTypesOk returns a tuple with the ObjectTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectTypes + +`func (o *AttributeDTO) SetObjectTypes(v []string)` + +SetObjectTypes sets ObjectTypes field to given value. + +### HasObjectTypes + +`func (o *AttributeDTO) HasObjectTypes() bool` + +HasObjectTypes returns a boolean if a field has been set. + +### SetObjectTypesNil + +`func (o *AttributeDTO) SetObjectTypesNil(b bool)` + + SetObjectTypesNil sets the value for ObjectTypes to be an explicit nil + +### UnsetObjectTypes +`func (o *AttributeDTO) UnsetObjectTypes()` + +UnsetObjectTypes ensures that no value is present for ObjectTypes, not even an explicit nil +### GetDescription + +`func (o *AttributeDTO) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AttributeDTO) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AttributeDTO) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AttributeDTO) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetValues + +`func (o *AttributeDTO) GetValues() []AttributeValueDTO` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *AttributeDTO) GetValuesOk() (*[]AttributeValueDTO, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *AttributeDTO) SetValues(v []AttributeValueDTO)` + +SetValues sets Values field to given value. + +### HasValues + +`func (o *AttributeDTO) HasValues() bool` + +HasValues returns a boolean if a field has been set. + +### SetValuesNil + +`func (o *AttributeDTO) SetValuesNil(b bool)` + + SetValuesNil sets the value for Values to be an explicit nil + +### UnsetValues +`func (o *AttributeDTO) UnsetValues()` + +UnsetValues ensures that no value is present for Values, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AttributeDTOList.md b/docs/tools/sdk/go/Reference/Beta/Models/AttributeDTOList.md new file mode 100644 index 000000000..29d414a86 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AttributeDTOList.md @@ -0,0 +1,74 @@ +--- +id: beta-attribute-dto-list +title: AttributeDTOList +pagination_label: AttributeDTOList +sidebar_label: AttributeDTOList +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDTOList', 'BetaAttributeDTOList'] +slug: /tools/sdk/go/beta/models/attribute-dto-list +tags: ['SDK', 'Software Development Kit', 'AttributeDTOList', 'BetaAttributeDTOList'] +--- + +# AttributeDTOList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]AttributeDTO**](attribute-dto) | | [optional] + +## Methods + +### NewAttributeDTOList + +`func NewAttributeDTOList() *AttributeDTOList` + +NewAttributeDTOList instantiates a new AttributeDTOList 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 + +### NewAttributeDTOListWithDefaults + +`func NewAttributeDTOListWithDefaults() *AttributeDTOList` + +NewAttributeDTOListWithDefaults instantiates a new AttributeDTOList 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 + +### GetAttributes + +`func (o *AttributeDTOList) GetAttributes() []AttributeDTO` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AttributeDTOList) GetAttributesOk() (*[]AttributeDTO, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AttributeDTOList) SetAttributes(v []AttributeDTO)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *AttributeDTOList) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *AttributeDTOList) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *AttributeDTOList) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AttributeDefinition.md b/docs/tools/sdk/go/Reference/Beta/Models/AttributeDefinition.md new file mode 100644 index 000000000..7a938cfc9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AttributeDefinition.md @@ -0,0 +1,230 @@ +--- +id: beta-attribute-definition +title: AttributeDefinition +pagination_label: AttributeDefinition +sidebar_label: AttributeDefinition +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDefinition', 'BetaAttributeDefinition'] +slug: /tools/sdk/go/beta/models/attribute-definition +tags: ['SDK', 'Software Development Kit', 'AttributeDefinition', 'BetaAttributeDefinition'] +--- + +# AttributeDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the attribute. | [optional] +**Type** | Pointer to [**AttributeDefinitionType**](attribute-definition-type) | | [optional] +**Schema** | Pointer to [**NullableAttributeDefinitionSchema**](attribute-definition-schema) | | [optional] +**Description** | Pointer to **string** | A human-readable description of the attribute. | [optional] +**IsMulti** | Pointer to **bool** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to false] +**IsEntitlement** | Pointer to **bool** | Flag indicating whether or not the attribute is an entitlement. | [optional] [default to false] +**IsGroup** | Pointer to **bool** | Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute. | [optional] [default to false] + +## Methods + +### NewAttributeDefinition + +`func NewAttributeDefinition() *AttributeDefinition` + +NewAttributeDefinition instantiates a new AttributeDefinition 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 + +### NewAttributeDefinitionWithDefaults + +`func NewAttributeDefinitionWithDefaults() *AttributeDefinition` + +NewAttributeDefinitionWithDefaults instantiates a new AttributeDefinition 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 + +### GetName + +`func (o *AttributeDefinition) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeDefinition) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeDefinition) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeDefinition) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *AttributeDefinition) GetType() AttributeDefinitionType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttributeDefinition) GetTypeOk() (*AttributeDefinitionType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttributeDefinition) SetType(v AttributeDefinitionType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttributeDefinition) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSchema + +`func (o *AttributeDefinition) GetSchema() AttributeDefinitionSchema` + +GetSchema returns the Schema field if non-nil, zero value otherwise. + +### GetSchemaOk + +`func (o *AttributeDefinition) GetSchemaOk() (*AttributeDefinitionSchema, bool)` + +GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchema + +`func (o *AttributeDefinition) SetSchema(v AttributeDefinitionSchema)` + +SetSchema sets Schema field to given value. + +### HasSchema + +`func (o *AttributeDefinition) HasSchema() bool` + +HasSchema returns a boolean if a field has been set. + +### SetSchemaNil + +`func (o *AttributeDefinition) SetSchemaNil(b bool)` + + SetSchemaNil sets the value for Schema to be an explicit nil + +### UnsetSchema +`func (o *AttributeDefinition) UnsetSchema()` + +UnsetSchema ensures that no value is present for Schema, not even an explicit nil +### GetDescription + +`func (o *AttributeDefinition) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AttributeDefinition) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AttributeDefinition) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AttributeDefinition) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIsMulti + +`func (o *AttributeDefinition) GetIsMulti() bool` + +GetIsMulti returns the IsMulti field if non-nil, zero value otherwise. + +### GetIsMultiOk + +`func (o *AttributeDefinition) GetIsMultiOk() (*bool, bool)` + +GetIsMultiOk returns a tuple with the IsMulti field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsMulti + +`func (o *AttributeDefinition) SetIsMulti(v bool)` + +SetIsMulti sets IsMulti field to given value. + +### HasIsMulti + +`func (o *AttributeDefinition) HasIsMulti() bool` + +HasIsMulti returns a boolean if a field has been set. + +### GetIsEntitlement + +`func (o *AttributeDefinition) GetIsEntitlement() bool` + +GetIsEntitlement returns the IsEntitlement field if non-nil, zero value otherwise. + +### GetIsEntitlementOk + +`func (o *AttributeDefinition) GetIsEntitlementOk() (*bool, bool)` + +GetIsEntitlementOk returns a tuple with the IsEntitlement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsEntitlement + +`func (o *AttributeDefinition) SetIsEntitlement(v bool)` + +SetIsEntitlement sets IsEntitlement field to given value. + +### HasIsEntitlement + +`func (o *AttributeDefinition) HasIsEntitlement() bool` + +HasIsEntitlement returns a boolean if a field has been set. + +### GetIsGroup + +`func (o *AttributeDefinition) GetIsGroup() bool` + +GetIsGroup returns the IsGroup field if non-nil, zero value otherwise. + +### GetIsGroupOk + +`func (o *AttributeDefinition) GetIsGroupOk() (*bool, bool)` + +GetIsGroupOk returns a tuple with the IsGroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGroup + +`func (o *AttributeDefinition) SetIsGroup(v bool)` + +SetIsGroup sets IsGroup field to given value. + +### HasIsGroup + +`func (o *AttributeDefinition) HasIsGroup() bool` + +HasIsGroup returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AttributeDefinitionSchema.md b/docs/tools/sdk/go/Reference/Beta/Models/AttributeDefinitionSchema.md new file mode 100644 index 000000000..fc29fdb89 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AttributeDefinitionSchema.md @@ -0,0 +1,116 @@ +--- +id: beta-attribute-definition-schema +title: AttributeDefinitionSchema +pagination_label: AttributeDefinitionSchema +sidebar_label: AttributeDefinitionSchema +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDefinitionSchema', 'BetaAttributeDefinitionSchema'] +slug: /tools/sdk/go/beta/models/attribute-definition-schema +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionSchema', 'BetaAttributeDefinitionSchema'] +--- + +# AttributeDefinitionSchema + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of object being referenced | [optional] +**Id** | Pointer to **string** | The object ID this reference applies to. | [optional] +**Name** | Pointer to **string** | The human-readable display name of the object. | [optional] + +## Methods + +### NewAttributeDefinitionSchema + +`func NewAttributeDefinitionSchema() *AttributeDefinitionSchema` + +NewAttributeDefinitionSchema instantiates a new AttributeDefinitionSchema 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 + +### NewAttributeDefinitionSchemaWithDefaults + +`func NewAttributeDefinitionSchemaWithDefaults() *AttributeDefinitionSchema` + +NewAttributeDefinitionSchemaWithDefaults instantiates a new AttributeDefinitionSchema 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 + +### GetType + +`func (o *AttributeDefinitionSchema) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttributeDefinitionSchema) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttributeDefinitionSchema) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttributeDefinitionSchema) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AttributeDefinitionSchema) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AttributeDefinitionSchema) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AttributeDefinitionSchema) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AttributeDefinitionSchema) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AttributeDefinitionSchema) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeDefinitionSchema) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeDefinitionSchema) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeDefinitionSchema) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AttributeDefinitionType.md b/docs/tools/sdk/go/Reference/Beta/Models/AttributeDefinitionType.md new file mode 100644 index 000000000..38f82563d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AttributeDefinitionType.md @@ -0,0 +1,27 @@ +--- +id: beta-attribute-definition-type +title: AttributeDefinitionType +pagination_label: AttributeDefinitionType +sidebar_label: AttributeDefinitionType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDefinitionType', 'BetaAttributeDefinitionType'] +slug: /tools/sdk/go/beta/models/attribute-definition-type +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'BetaAttributeDefinitionType'] +--- + +# AttributeDefinitionType + +## Enum + + +* `STRING` (value: `"STRING"`) + +* `LONG` (value: `"LONG"`) + +* `INT` (value: `"INT"`) + +* `BOOLEAN` (value: `"BOOLEAN"`) + +* `DATE` (value: `"DATE"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AttributeValueDTO.md b/docs/tools/sdk/go/Reference/Beta/Models/AttributeValueDTO.md new file mode 100644 index 000000000..3493f053b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AttributeValueDTO.md @@ -0,0 +1,116 @@ +--- +id: beta-attribute-value-dto +title: AttributeValueDTO +pagination_label: AttributeValueDTO +sidebar_label: AttributeValueDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeValueDTO', 'BetaAttributeValueDTO'] +slug: /tools/sdk/go/beta/models/attribute-value-dto +tags: ['SDK', 'Software Development Kit', 'AttributeValueDTO', 'BetaAttributeValueDTO'] +--- + +# AttributeValueDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [optional] +**Name** | Pointer to **string** | The display name of the Attribute value. | [optional] +**Status** | Pointer to **string** | The status of the Attribute value. | [optional] + +## Methods + +### NewAttributeValueDTO + +`func NewAttributeValueDTO() *AttributeValueDTO` + +NewAttributeValueDTO instantiates a new AttributeValueDTO 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 + +### NewAttributeValueDTOWithDefaults + +`func NewAttributeValueDTOWithDefaults() *AttributeValueDTO` + +NewAttributeValueDTOWithDefaults instantiates a new AttributeValueDTO 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 + +### GetValue + +`func (o *AttributeValueDTO) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AttributeValueDTO) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AttributeValueDTO) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AttributeValueDTO) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetName + +`func (o *AttributeValueDTO) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeValueDTO) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeValueDTO) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeValueDTO) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *AttributeValueDTO) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AttributeValueDTO) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AttributeValueDTO) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AttributeValueDTO) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AttributesChanged.md b/docs/tools/sdk/go/Reference/Beta/Models/AttributesChanged.md new file mode 100644 index 000000000..a9c11de9f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AttributesChanged.md @@ -0,0 +1,142 @@ +--- +id: beta-attributes-changed +title: AttributesChanged +pagination_label: AttributesChanged +sidebar_label: AttributesChanged +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributesChanged', 'BetaAttributesChanged'] +slug: /tools/sdk/go/beta/models/attributes-changed +tags: ['SDK', 'Software Development Kit', 'AttributesChanged', 'BetaAttributesChanged'] +--- + +# AttributesChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Changes** | Pointer to [**[]AttributeChange**](attribute-change) | | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] + +## Methods + +### NewAttributesChanged + +`func NewAttributesChanged() *AttributesChanged` + +NewAttributesChanged instantiates a new AttributesChanged 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 + +### NewAttributesChangedWithDefaults + +`func NewAttributesChangedWithDefaults() *AttributesChanged` + +NewAttributesChangedWithDefaults instantiates a new AttributesChanged 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 + +### GetChanges + +`func (o *AttributesChanged) GetChanges() []AttributeChange` + +GetChanges returns the Changes field if non-nil, zero value otherwise. + +### GetChangesOk + +`func (o *AttributesChanged) GetChangesOk() (*[]AttributeChange, bool)` + +GetChangesOk returns a tuple with the Changes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanges + +`func (o *AttributesChanged) SetChanges(v []AttributeChange)` + +SetChanges sets Changes field to given value. + +### HasChanges + +`func (o *AttributesChanged) HasChanges() bool` + +HasChanges returns a boolean if a field has been set. + +### GetEventType + +`func (o *AttributesChanged) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AttributesChanged) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AttributesChanged) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AttributesChanged) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *AttributesChanged) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AttributesChanged) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AttributesChanged) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AttributesChanged) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetDt + +`func (o *AttributesChanged) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *AttributesChanged) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *AttributesChanged) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *AttributesChanged) HasDt() bool` + +HasDt returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AuditDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/AuditDetails.md new file mode 100644 index 000000000..b39ef765e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AuditDetails.md @@ -0,0 +1,142 @@ +--- +id: beta-audit-details +title: AuditDetails +pagination_label: AuditDetails +sidebar_label: AuditDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuditDetails', 'BetaAuditDetails'] +slug: /tools/sdk/go/beta/models/audit-details +tags: ['SDK', 'Software Development Kit', 'AuditDetails', 'BetaAuditDetails'] +--- + +# AuditDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **SailPointTime** | Initial date and time when the record was created | [optional] +**CreatedBy** | Pointer to [**Identity1**](identity1) | | [optional] +**Modified** | Pointer to **SailPointTime** | Last modified date and time for the record | [optional] +**ModifiedBy** | Pointer to [**Identity1**](identity1) | | [optional] + +## Methods + +### NewAuditDetails + +`func NewAuditDetails() *AuditDetails` + +NewAuditDetails instantiates a new AuditDetails 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 + +### NewAuditDetailsWithDefaults + +`func NewAuditDetailsWithDefaults() *AuditDetails` + +NewAuditDetailsWithDefaults instantiates a new AuditDetails 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 + +### GetCreated + +`func (o *AuditDetails) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AuditDetails) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AuditDetails) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AuditDetails) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetCreatedBy + +`func (o *AuditDetails) GetCreatedBy() Identity1` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *AuditDetails) GetCreatedByOk() (*Identity1, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *AuditDetails) SetCreatedBy(v Identity1)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *AuditDetails) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetModified + +`func (o *AuditDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AuditDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AuditDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AuditDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetModifiedBy + +`func (o *AuditDetails) GetModifiedBy() Identity1` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *AuditDetails) GetModifiedByOk() (*Identity1, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedBy + +`func (o *AuditDetails) SetModifiedBy(v Identity1)` + +SetModifiedBy sets ModifiedBy field to given value. + +### HasModifiedBy + +`func (o *AuditDetails) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AuthProfile.md b/docs/tools/sdk/go/Reference/Beta/Models/AuthProfile.md new file mode 100644 index 000000000..8b4b1d882 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AuthProfile.md @@ -0,0 +1,220 @@ +--- +id: beta-auth-profile +title: AuthProfile +pagination_label: AuthProfile +sidebar_label: AuthProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuthProfile', 'BetaAuthProfile'] +slug: /tools/sdk/go/beta/models/auth-profile +tags: ['SDK', 'Software Development Kit', 'AuthProfile', 'BetaAuthProfile'] +--- + +# AuthProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Authentication Profile name. | [optional] +**OffNetwork** | Pointer to **bool** | Use it to block access from off network. | [optional] [default to false] +**UntrustedGeography** | Pointer to **bool** | Use it to block access from untrusted geoographies. | [optional] [default to false] +**ApplicationId** | Pointer to **string** | Application ID. | [optional] +**ApplicationName** | Pointer to **string** | Application name. | [optional] +**Type** | Pointer to **string** | Type of the Authentication Profile. | [optional] +**StrongAuthLogin** | Pointer to **bool** | Use it to enable strong authentication. | [optional] [default to false] + +## Methods + +### NewAuthProfile + +`func NewAuthProfile() *AuthProfile` + +NewAuthProfile instantiates a new AuthProfile 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 + +### NewAuthProfileWithDefaults + +`func NewAuthProfileWithDefaults() *AuthProfile` + +NewAuthProfileWithDefaults instantiates a new AuthProfile 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 + +### GetName + +`func (o *AuthProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AuthProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AuthProfile) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AuthProfile) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOffNetwork + +`func (o *AuthProfile) GetOffNetwork() bool` + +GetOffNetwork returns the OffNetwork field if non-nil, zero value otherwise. + +### GetOffNetworkOk + +`func (o *AuthProfile) GetOffNetworkOk() (*bool, bool)` + +GetOffNetworkOk returns a tuple with the OffNetwork field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOffNetwork + +`func (o *AuthProfile) SetOffNetwork(v bool)` + +SetOffNetwork sets OffNetwork field to given value. + +### HasOffNetwork + +`func (o *AuthProfile) HasOffNetwork() bool` + +HasOffNetwork returns a boolean if a field has been set. + +### GetUntrustedGeography + +`func (o *AuthProfile) GetUntrustedGeography() bool` + +GetUntrustedGeography returns the UntrustedGeography field if non-nil, zero value otherwise. + +### GetUntrustedGeographyOk + +`func (o *AuthProfile) GetUntrustedGeographyOk() (*bool, bool)` + +GetUntrustedGeographyOk returns a tuple with the UntrustedGeography field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUntrustedGeography + +`func (o *AuthProfile) SetUntrustedGeography(v bool)` + +SetUntrustedGeography sets UntrustedGeography field to given value. + +### HasUntrustedGeography + +`func (o *AuthProfile) HasUntrustedGeography() bool` + +HasUntrustedGeography returns a boolean if a field has been set. + +### GetApplicationId + +`func (o *AuthProfile) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *AuthProfile) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *AuthProfile) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *AuthProfile) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### GetApplicationName + +`func (o *AuthProfile) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *AuthProfile) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *AuthProfile) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *AuthProfile) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### GetType + +`func (o *AuthProfile) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AuthProfile) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AuthProfile) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AuthProfile) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetStrongAuthLogin + +`func (o *AuthProfile) GetStrongAuthLogin() bool` + +GetStrongAuthLogin returns the StrongAuthLogin field if non-nil, zero value otherwise. + +### GetStrongAuthLoginOk + +`func (o *AuthProfile) GetStrongAuthLoginOk() (*bool, bool)` + +GetStrongAuthLoginOk returns a tuple with the StrongAuthLogin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStrongAuthLogin + +`func (o *AuthProfile) SetStrongAuthLogin(v bool)` + +SetStrongAuthLogin sets StrongAuthLogin field to given value. + +### HasStrongAuthLogin + +`func (o *AuthProfile) HasStrongAuthLogin() bool` + +HasStrongAuthLogin returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/AuthProfileSummary.md b/docs/tools/sdk/go/Reference/Beta/Models/AuthProfileSummary.md new file mode 100644 index 000000000..d8953c896 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/AuthProfileSummary.md @@ -0,0 +1,90 @@ +--- +id: beta-auth-profile-summary +title: AuthProfileSummary +pagination_label: AuthProfileSummary +sidebar_label: AuthProfileSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuthProfileSummary', 'BetaAuthProfileSummary'] +slug: /tools/sdk/go/beta/models/auth-profile-summary +tags: ['SDK', 'Software Development Kit', 'AuthProfileSummary', 'BetaAuthProfileSummary'] +--- + +# AuthProfileSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Tenant** | Pointer to **string** | Tenant name. | [optional] +**Id** | Pointer to **string** | Identity ID. | [optional] + +## Methods + +### NewAuthProfileSummary + +`func NewAuthProfileSummary() *AuthProfileSummary` + +NewAuthProfileSummary instantiates a new AuthProfileSummary 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 + +### NewAuthProfileSummaryWithDefaults + +`func NewAuthProfileSummaryWithDefaults() *AuthProfileSummary` + +NewAuthProfileSummaryWithDefaults instantiates a new AuthProfileSummary 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 + +### GetTenant + +`func (o *AuthProfileSummary) GetTenant() string` + +GetTenant returns the Tenant field if non-nil, zero value otherwise. + +### GetTenantOk + +`func (o *AuthProfileSummary) GetTenantOk() (*string, bool)` + +GetTenantOk returns a tuple with the Tenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenant + +`func (o *AuthProfileSummary) SetTenant(v string)` + +SetTenant sets Tenant field to given value. + +### HasTenant + +`func (o *AuthProfileSummary) HasTenant() bool` + +HasTenant returns a boolean if a field has been set. + +### GetId + +`func (o *AuthProfileSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AuthProfileSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AuthProfileSummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AuthProfileSummary) HasId() bool` + +HasId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/BaseCommonDto.md b/docs/tools/sdk/go/Reference/Beta/Models/BaseCommonDto.md new file mode 100644 index 000000000..4123493ae --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/BaseCommonDto.md @@ -0,0 +1,147 @@ +--- +id: beta-base-common-dto +title: BaseCommonDto +pagination_label: BaseCommonDto +sidebar_label: BaseCommonDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseCommonDto', 'BetaBaseCommonDto'] +slug: /tools/sdk/go/beta/models/base-common-dto +tags: ['SDK', 'Software Development Kit', 'BaseCommonDto', 'BetaBaseCommonDto'] +--- + +# BaseCommonDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] + +## Methods + +### NewBaseCommonDto + +`func NewBaseCommonDto(name NullableString, ) *BaseCommonDto` + +NewBaseCommonDto instantiates a new BaseCommonDto 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 + +### NewBaseCommonDtoWithDefaults + +`func NewBaseCommonDtoWithDefaults() *BaseCommonDto` + +NewBaseCommonDtoWithDefaults instantiates a new BaseCommonDto 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 + +### GetId + +`func (o *BaseCommonDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseCommonDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseCommonDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseCommonDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseCommonDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseCommonDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseCommonDto) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *BaseCommonDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *BaseCommonDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *BaseCommonDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BaseCommonDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BaseCommonDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *BaseCommonDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *BaseCommonDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *BaseCommonDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *BaseCommonDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *BaseCommonDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/BaseCommonDto1.md b/docs/tools/sdk/go/Reference/Beta/Models/BaseCommonDto1.md new file mode 100644 index 000000000..b572a4d92 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/BaseCommonDto1.md @@ -0,0 +1,147 @@ +--- +id: beta-base-common-dto1 +title: BaseCommonDto1 +pagination_label: BaseCommonDto1 +sidebar_label: BaseCommonDto1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseCommonDto1', 'BetaBaseCommonDto1'] +slug: /tools/sdk/go/beta/models/base-common-dto1 +tags: ['SDK', 'Software Development Kit', 'BaseCommonDto1', 'BetaBaseCommonDto1'] +--- + +# BaseCommonDto1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] + +## Methods + +### NewBaseCommonDto1 + +`func NewBaseCommonDto1(name NullableString, ) *BaseCommonDto1` + +NewBaseCommonDto1 instantiates a new BaseCommonDto1 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 + +### NewBaseCommonDto1WithDefaults + +`func NewBaseCommonDto1WithDefaults() *BaseCommonDto1` + +NewBaseCommonDto1WithDefaults instantiates a new BaseCommonDto1 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 + +### GetId + +`func (o *BaseCommonDto1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseCommonDto1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseCommonDto1) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseCommonDto1) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseCommonDto1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseCommonDto1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseCommonDto1) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *BaseCommonDto1) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *BaseCommonDto1) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *BaseCommonDto1) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BaseCommonDto1) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BaseCommonDto1) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *BaseCommonDto1) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *BaseCommonDto1) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *BaseCommonDto1) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *BaseCommonDto1) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *BaseCommonDto1) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/BaseReferenceDto.md b/docs/tools/sdk/go/Reference/Beta/Models/BaseReferenceDto.md new file mode 100644 index 000000000..013eb26f5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/BaseReferenceDto.md @@ -0,0 +1,116 @@ +--- +id: beta-base-reference-dto +title: BaseReferenceDto +pagination_label: BaseReferenceDto +sidebar_label: BaseReferenceDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseReferenceDto', 'BetaBaseReferenceDto'] +slug: /tools/sdk/go/beta/models/base-reference-dto +tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto', 'BetaBaseReferenceDto'] +--- + +# BaseReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewBaseReferenceDto + +`func NewBaseReferenceDto() *BaseReferenceDto` + +NewBaseReferenceDto instantiates a new BaseReferenceDto 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 + +### NewBaseReferenceDtoWithDefaults + +`func NewBaseReferenceDtoWithDefaults() *BaseReferenceDto` + +NewBaseReferenceDtoWithDefaults instantiates a new BaseReferenceDto 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 + +### GetType + +`func (o *BaseReferenceDto) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BaseReferenceDto) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BaseReferenceDto) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BaseReferenceDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *BaseReferenceDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseReferenceDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseReferenceDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseReferenceDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseReferenceDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseReferenceDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseReferenceDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseReferenceDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/BaseReferenceDto1.md b/docs/tools/sdk/go/Reference/Beta/Models/BaseReferenceDto1.md new file mode 100644 index 000000000..690d57996 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/BaseReferenceDto1.md @@ -0,0 +1,90 @@ +--- +id: beta-base-reference-dto1 +title: BaseReferenceDto1 +pagination_label: BaseReferenceDto1 +sidebar_label: BaseReferenceDto1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseReferenceDto1', 'BetaBaseReferenceDto1'] +slug: /tools/sdk/go/beta/models/base-reference-dto1 +tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto1', 'BetaBaseReferenceDto1'] +--- + +# BaseReferenceDto1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the application ID | [optional] +**Name** | Pointer to **string** | the application name | [optional] + +## Methods + +### NewBaseReferenceDto1 + +`func NewBaseReferenceDto1() *BaseReferenceDto1` + +NewBaseReferenceDto1 instantiates a new BaseReferenceDto1 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 + +### NewBaseReferenceDto1WithDefaults + +`func NewBaseReferenceDto1WithDefaults() *BaseReferenceDto1` + +NewBaseReferenceDto1WithDefaults instantiates a new BaseReferenceDto1 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 + +### GetId + +`func (o *BaseReferenceDto1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseReferenceDto1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseReferenceDto1) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseReferenceDto1) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseReferenceDto1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseReferenceDto1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseReferenceDto1) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseReferenceDto1) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/BasicAuthConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/BasicAuthConfig.md new file mode 100644 index 000000000..f5aafc13a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/BasicAuthConfig.md @@ -0,0 +1,100 @@ +--- +id: beta-basic-auth-config +title: BasicAuthConfig +pagination_label: BasicAuthConfig +sidebar_label: BasicAuthConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BasicAuthConfig', 'BetaBasicAuthConfig'] +slug: /tools/sdk/go/beta/models/basic-auth-config +tags: ['SDK', 'Software Development Kit', 'BasicAuthConfig', 'BetaBasicAuthConfig'] +--- + +# BasicAuthConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserName** | Pointer to **string** | The username to authenticate. | [optional] +**Password** | Pointer to **NullableString** | The password to authenticate. On response, this field is set to null as to not return secrets. | [optional] + +## Methods + +### NewBasicAuthConfig + +`func NewBasicAuthConfig() *BasicAuthConfig` + +NewBasicAuthConfig instantiates a new BasicAuthConfig 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 + +### NewBasicAuthConfigWithDefaults + +`func NewBasicAuthConfigWithDefaults() *BasicAuthConfig` + +NewBasicAuthConfigWithDefaults instantiates a new BasicAuthConfig 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 + +### GetUserName + +`func (o *BasicAuthConfig) GetUserName() string` + +GetUserName returns the UserName field if non-nil, zero value otherwise. + +### GetUserNameOk + +`func (o *BasicAuthConfig) GetUserNameOk() (*string, bool)` + +GetUserNameOk returns a tuple with the UserName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserName + +`func (o *BasicAuthConfig) SetUserName(v string)` + +SetUserName sets UserName field to given value. + +### HasUserName + +`func (o *BasicAuthConfig) HasUserName() bool` + +HasUserName returns a boolean if a field has been set. + +### GetPassword + +`func (o *BasicAuthConfig) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *BasicAuthConfig) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *BasicAuthConfig) SetPassword(v string)` + +SetPassword sets Password field to given value. + +### HasPassword + +`func (o *BasicAuthConfig) HasPassword() bool` + +HasPassword returns a boolean if a field has been set. + +### SetPasswordNil + +`func (o *BasicAuthConfig) SetPasswordNil(b bool)` + + SetPasswordNil sets the value for Password to be an explicit nil + +### UnsetPassword +`func (o *BasicAuthConfig) UnsetPassword()` + +UnsetPassword ensures that no value is present for Password, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/BearerTokenAuthConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/BearerTokenAuthConfig.md new file mode 100644 index 000000000..902bede19 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/BearerTokenAuthConfig.md @@ -0,0 +1,74 @@ +--- +id: beta-bearer-token-auth-config +title: BearerTokenAuthConfig +pagination_label: BearerTokenAuthConfig +sidebar_label: BearerTokenAuthConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BearerTokenAuthConfig', 'BetaBearerTokenAuthConfig'] +slug: /tools/sdk/go/beta/models/bearer-token-auth-config +tags: ['SDK', 'Software Development Kit', 'BearerTokenAuthConfig', 'BetaBearerTokenAuthConfig'] +--- + +# BearerTokenAuthConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BearerToken** | Pointer to **NullableString** | Bearer token | [optional] + +## Methods + +### NewBearerTokenAuthConfig + +`func NewBearerTokenAuthConfig() *BearerTokenAuthConfig` + +NewBearerTokenAuthConfig instantiates a new BearerTokenAuthConfig 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 + +### NewBearerTokenAuthConfigWithDefaults + +`func NewBearerTokenAuthConfigWithDefaults() *BearerTokenAuthConfig` + +NewBearerTokenAuthConfigWithDefaults instantiates a new BearerTokenAuthConfig 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 + +### GetBearerToken + +`func (o *BearerTokenAuthConfig) GetBearerToken() string` + +GetBearerToken returns the BearerToken field if non-nil, zero value otherwise. + +### GetBearerTokenOk + +`func (o *BearerTokenAuthConfig) GetBearerTokenOk() (*string, bool)` + +GetBearerTokenOk returns a tuple with the BearerToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBearerToken + +`func (o *BearerTokenAuthConfig) SetBearerToken(v string)` + +SetBearerToken sets BearerToken field to given value. + +### HasBearerToken + +`func (o *BearerTokenAuthConfig) HasBearerToken() bool` + +HasBearerToken returns a boolean if a field has been set. + +### SetBearerTokenNil + +`func (o *BearerTokenAuthConfig) SetBearerTokenNil(b bool)` + + SetBearerTokenNil sets the value for BearerToken to be an explicit nil + +### UnsetBearerToken +`func (o *BearerTokenAuthConfig) UnsetBearerToken()` + +UnsetBearerToken ensures that no value is present for BearerToken, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/BeforeProvisioningRuleDto.md b/docs/tools/sdk/go/Reference/Beta/Models/BeforeProvisioningRuleDto.md new file mode 100644 index 000000000..cf0b6a073 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/BeforeProvisioningRuleDto.md @@ -0,0 +1,116 @@ +--- +id: beta-before-provisioning-rule-dto +title: BeforeProvisioningRuleDto +pagination_label: BeforeProvisioningRuleDto +sidebar_label: BeforeProvisioningRuleDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BeforeProvisioningRuleDto', 'BetaBeforeProvisioningRuleDto'] +slug: /tools/sdk/go/beta/models/before-provisioning-rule-dto +tags: ['SDK', 'Software Development Kit', 'BeforeProvisioningRuleDto', 'BetaBeforeProvisioningRuleDto'] +--- + +# BeforeProvisioningRuleDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Before Provisioning Rule DTO type. | [optional] +**Id** | Pointer to **string** | Before Provisioning Rule ID. | [optional] +**Name** | Pointer to **string** | Rule display name. | [optional] + +## Methods + +### NewBeforeProvisioningRuleDto + +`func NewBeforeProvisioningRuleDto() *BeforeProvisioningRuleDto` + +NewBeforeProvisioningRuleDto instantiates a new BeforeProvisioningRuleDto 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 + +### NewBeforeProvisioningRuleDtoWithDefaults + +`func NewBeforeProvisioningRuleDtoWithDefaults() *BeforeProvisioningRuleDto` + +NewBeforeProvisioningRuleDtoWithDefaults instantiates a new BeforeProvisioningRuleDto 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 + +### GetType + +`func (o *BeforeProvisioningRuleDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BeforeProvisioningRuleDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BeforeProvisioningRuleDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BeforeProvisioningRuleDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *BeforeProvisioningRuleDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BeforeProvisioningRuleDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BeforeProvisioningRuleDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BeforeProvisioningRuleDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BeforeProvisioningRuleDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BeforeProvisioningRuleDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BeforeProvisioningRuleDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BeforeProvisioningRuleDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/BulkIdentitiesAccountsResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/BulkIdentitiesAccountsResponse.md new file mode 100644 index 000000000..15d7a4af5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/BulkIdentitiesAccountsResponse.md @@ -0,0 +1,116 @@ +--- +id: beta-bulk-identities-accounts-response +title: BulkIdentitiesAccountsResponse +pagination_label: BulkIdentitiesAccountsResponse +sidebar_label: BulkIdentitiesAccountsResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkIdentitiesAccountsResponse', 'BetaBulkIdentitiesAccountsResponse'] +slug: /tools/sdk/go/beta/models/bulk-identities-accounts-response +tags: ['SDK', 'Software Development Kit', 'BulkIdentitiesAccountsResponse', 'BetaBulkIdentitiesAccountsResponse'] +--- + +# BulkIdentitiesAccountsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Identifier of bulk request item. | [optional] +**StatusCode** | Pointer to **int32** | Response status value. | [optional] +**Message** | Pointer to **string** | Status containing additional context information about failures. | [optional] + +## Methods + +### NewBulkIdentitiesAccountsResponse + +`func NewBulkIdentitiesAccountsResponse() *BulkIdentitiesAccountsResponse` + +NewBulkIdentitiesAccountsResponse instantiates a new BulkIdentitiesAccountsResponse 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 + +### NewBulkIdentitiesAccountsResponseWithDefaults + +`func NewBulkIdentitiesAccountsResponseWithDefaults() *BulkIdentitiesAccountsResponse` + +NewBulkIdentitiesAccountsResponseWithDefaults instantiates a new BulkIdentitiesAccountsResponse 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 + +### GetId + +`func (o *BulkIdentitiesAccountsResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BulkIdentitiesAccountsResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BulkIdentitiesAccountsResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BulkIdentitiesAccountsResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetStatusCode + +`func (o *BulkIdentitiesAccountsResponse) GetStatusCode() int32` + +GetStatusCode returns the StatusCode field if non-nil, zero value otherwise. + +### GetStatusCodeOk + +`func (o *BulkIdentitiesAccountsResponse) GetStatusCodeOk() (*int32, bool)` + +GetStatusCodeOk returns a tuple with the StatusCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusCode + +`func (o *BulkIdentitiesAccountsResponse) SetStatusCode(v int32)` + +SetStatusCode sets StatusCode field to given value. + +### HasStatusCode + +`func (o *BulkIdentitiesAccountsResponse) HasStatusCode() bool` + +HasStatusCode returns a boolean if a field has been set. + +### GetMessage + +`func (o *BulkIdentitiesAccountsResponse) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *BulkIdentitiesAccountsResponse) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *BulkIdentitiesAccountsResponse) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *BulkIdentitiesAccountsResponse) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/BulkTaggedObject.md b/docs/tools/sdk/go/Reference/Beta/Models/BulkTaggedObject.md new file mode 100644 index 000000000..6bb270f22 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/BulkTaggedObject.md @@ -0,0 +1,116 @@ +--- +id: beta-bulk-tagged-object +title: BulkTaggedObject +pagination_label: BulkTaggedObject +sidebar_label: BulkTaggedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkTaggedObject', 'BetaBulkTaggedObject'] +slug: /tools/sdk/go/beta/models/bulk-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkTaggedObject', 'BetaBulkTaggedObject'] +--- + +# BulkTaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]string** | Label to be applied to object. | [optional] +**Operation** | Pointer to **string** | If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. | [optional] [default to "APPEND"] + +## Methods + +### NewBulkTaggedObject + +`func NewBulkTaggedObject() *BulkTaggedObject` + +NewBulkTaggedObject instantiates a new BulkTaggedObject 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 + +### NewBulkTaggedObjectWithDefaults + +`func NewBulkTaggedObjectWithDefaults() *BulkTaggedObject` + +NewBulkTaggedObjectWithDefaults instantiates a new BulkTaggedObject 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 + +### GetObjectRefs + +`func (o *BulkTaggedObject) GetObjectRefs() []TaggedObjectDto` + +GetObjectRefs returns the ObjectRefs field if non-nil, zero value otherwise. + +### GetObjectRefsOk + +`func (o *BulkTaggedObject) GetObjectRefsOk() (*[]TaggedObjectDto, bool)` + +GetObjectRefsOk returns a tuple with the ObjectRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectRefs + +`func (o *BulkTaggedObject) SetObjectRefs(v []TaggedObjectDto)` + +SetObjectRefs sets ObjectRefs field to given value. + +### HasObjectRefs + +`func (o *BulkTaggedObject) HasObjectRefs() bool` + +HasObjectRefs returns a boolean if a field has been set. + +### GetTags + +`func (o *BulkTaggedObject) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *BulkTaggedObject) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *BulkTaggedObject) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *BulkTaggedObject) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetOperation + +`func (o *BulkTaggedObject) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *BulkTaggedObject) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *BulkTaggedObject) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *BulkTaggedObject) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/BulkWorkgroupMembersRequestInner.md b/docs/tools/sdk/go/Reference/Beta/Models/BulkWorkgroupMembersRequestInner.md new file mode 100644 index 000000000..64b3c51d0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/BulkWorkgroupMembersRequestInner.md @@ -0,0 +1,116 @@ +--- +id: beta-bulk-workgroup-members-request-inner +title: BulkWorkgroupMembersRequestInner +pagination_label: BulkWorkgroupMembersRequestInner +sidebar_label: BulkWorkgroupMembersRequestInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkWorkgroupMembersRequestInner', 'BetaBulkWorkgroupMembersRequestInner'] +slug: /tools/sdk/go/beta/models/bulk-workgroup-members-request-inner +tags: ['SDK', 'Software Development Kit', 'BulkWorkgroupMembersRequestInner', 'BetaBulkWorkgroupMembersRequestInner'] +--- + +# BulkWorkgroupMembersRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Identity's DTO type. | [optional] +**Id** | Pointer to **string** | Identity ID. | [optional] +**Name** | Pointer to **string** | Identity's display name. | [optional] + +## Methods + +### NewBulkWorkgroupMembersRequestInner + +`func NewBulkWorkgroupMembersRequestInner() *BulkWorkgroupMembersRequestInner` + +NewBulkWorkgroupMembersRequestInner instantiates a new BulkWorkgroupMembersRequestInner 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 + +### NewBulkWorkgroupMembersRequestInnerWithDefaults + +`func NewBulkWorkgroupMembersRequestInnerWithDefaults() *BulkWorkgroupMembersRequestInner` + +NewBulkWorkgroupMembersRequestInnerWithDefaults instantiates a new BulkWorkgroupMembersRequestInner 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 + +### GetType + +`func (o *BulkWorkgroupMembersRequestInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BulkWorkgroupMembersRequestInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BulkWorkgroupMembersRequestInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BulkWorkgroupMembersRequestInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *BulkWorkgroupMembersRequestInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BulkWorkgroupMembersRequestInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BulkWorkgroupMembersRequestInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BulkWorkgroupMembersRequestInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BulkWorkgroupMembersRequestInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BulkWorkgroupMembersRequestInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BulkWorkgroupMembersRequestInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BulkWorkgroupMembersRequestInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Campaign.md b/docs/tools/sdk/go/Reference/Beta/Models/Campaign.md new file mode 100644 index 000000000..131491050 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Campaign.md @@ -0,0 +1,621 @@ +--- +id: beta-campaign +title: Campaign +pagination_label: Campaign +sidebar_label: Campaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Campaign', 'BetaCampaign'] +slug: /tools/sdk/go/beta/models/campaign +tags: ['SDK', 'Software Development Kit', 'Campaign', 'BetaCampaign'] +--- + +# Campaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the campaign | [optional] [readonly] +**Name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Description** | **string** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Deadline** | Pointer to **SailPointTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **string** | The type of campaign. Could be extended in the future. | +**EmailNotificationEnabled** | Pointer to **bool** | Enables email notification for this campaign | [optional] [default to false] +**AutoRevokeAllowed** | Pointer to **bool** | Allows auto revoke for this campaign | [optional] [default to false] +**RecommendationsEnabled** | Pointer to **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to false] +**Status** | Pointer to **string** | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **SailPointTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Modified time of the campaign | [optional] [readonly] +**Filter** | Pointer to [**FullcampaignAllOfFilter**](fullcampaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **bool** | Determines if comments on sunset date changes are required. | [optional] [default to true] +**SourceOwnerCampaignInfo** | Pointer to [**FullcampaignAllOfSourceOwnerCampaignInfo**](fullcampaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**FullcampaignAllOfSearchCampaignInfo**](fullcampaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**FullcampaignAllOfRoleCompositionCampaignInfo**](fullcampaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**FullcampaignAllOfMachineAccountCampaignInfo**](fullcampaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]FullcampaignAllOfSourcesWithOrphanEntitlements**](fullcampaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Methods + +### NewCampaign + +`func NewCampaign(name string, description string, type_ string, ) *Campaign` + +NewCampaign instantiates a new Campaign 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 + +### NewCampaignWithDefaults + +`func NewCampaignWithDefaults() *Campaign` + +NewCampaignWithDefaults instantiates a new Campaign 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 + +### GetId + +`func (o *Campaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Campaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Campaign) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Campaign) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Campaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Campaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Campaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Campaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Campaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Campaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetDeadline + +`func (o *Campaign) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *Campaign) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *Campaign) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *Campaign) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### GetType + +`func (o *Campaign) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Campaign) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Campaign) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEmailNotificationEnabled + +`func (o *Campaign) GetEmailNotificationEnabled() bool` + +GetEmailNotificationEnabled returns the EmailNotificationEnabled field if non-nil, zero value otherwise. + +### GetEmailNotificationEnabledOk + +`func (o *Campaign) GetEmailNotificationEnabledOk() (*bool, bool)` + +GetEmailNotificationEnabledOk returns a tuple with the EmailNotificationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationEnabled + +`func (o *Campaign) SetEmailNotificationEnabled(v bool)` + +SetEmailNotificationEnabled sets EmailNotificationEnabled field to given value. + +### HasEmailNotificationEnabled + +`func (o *Campaign) HasEmailNotificationEnabled() bool` + +HasEmailNotificationEnabled returns a boolean if a field has been set. + +### GetAutoRevokeAllowed + +`func (o *Campaign) GetAutoRevokeAllowed() bool` + +GetAutoRevokeAllowed returns the AutoRevokeAllowed field if non-nil, zero value otherwise. + +### GetAutoRevokeAllowedOk + +`func (o *Campaign) GetAutoRevokeAllowedOk() (*bool, bool)` + +GetAutoRevokeAllowedOk returns a tuple with the AutoRevokeAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoRevokeAllowed + +`func (o *Campaign) SetAutoRevokeAllowed(v bool)` + +SetAutoRevokeAllowed sets AutoRevokeAllowed field to given value. + +### HasAutoRevokeAllowed + +`func (o *Campaign) HasAutoRevokeAllowed() bool` + +HasAutoRevokeAllowed returns a boolean if a field has been set. + +### GetRecommendationsEnabled + +`func (o *Campaign) GetRecommendationsEnabled() bool` + +GetRecommendationsEnabled returns the RecommendationsEnabled field if non-nil, zero value otherwise. + +### GetRecommendationsEnabledOk + +`func (o *Campaign) GetRecommendationsEnabledOk() (*bool, bool)` + +GetRecommendationsEnabledOk returns a tuple with the RecommendationsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendationsEnabled + +`func (o *Campaign) SetRecommendationsEnabled(v bool)` + +SetRecommendationsEnabled sets RecommendationsEnabled field to given value. + +### HasRecommendationsEnabled + +`func (o *Campaign) HasRecommendationsEnabled() bool` + +HasRecommendationsEnabled returns a boolean if a field has been set. + +### GetStatus + +`func (o *Campaign) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Campaign) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Campaign) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Campaign) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetCorrelatedStatus + +`func (o *Campaign) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *Campaign) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *Campaign) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + +### HasCorrelatedStatus + +`func (o *Campaign) HasCorrelatedStatus() bool` + +HasCorrelatedStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *Campaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Campaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Campaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Campaign) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetTotalCertifications + +`func (o *Campaign) GetTotalCertifications() int32` + +GetTotalCertifications returns the TotalCertifications field if non-nil, zero value otherwise. + +### GetTotalCertificationsOk + +`func (o *Campaign) GetTotalCertificationsOk() (*int32, bool)` + +GetTotalCertificationsOk returns a tuple with the TotalCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCertifications + +`func (o *Campaign) SetTotalCertifications(v int32)` + +SetTotalCertifications sets TotalCertifications field to given value. + +### HasTotalCertifications + +`func (o *Campaign) HasTotalCertifications() bool` + +HasTotalCertifications returns a boolean if a field has been set. + +### GetCompletedCertifications + +`func (o *Campaign) GetCompletedCertifications() int32` + +GetCompletedCertifications returns the CompletedCertifications field if non-nil, zero value otherwise. + +### GetCompletedCertificationsOk + +`func (o *Campaign) GetCompletedCertificationsOk() (*int32, bool)` + +GetCompletedCertificationsOk returns a tuple with the CompletedCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedCertifications + +`func (o *Campaign) SetCompletedCertifications(v int32)` + +SetCompletedCertifications sets CompletedCertifications field to given value. + +### HasCompletedCertifications + +`func (o *Campaign) HasCompletedCertifications() bool` + +HasCompletedCertifications returns a boolean if a field has been set. + +### GetAlerts + +`func (o *Campaign) GetAlerts() []CampaignAlert` + +GetAlerts returns the Alerts field if non-nil, zero value otherwise. + +### GetAlertsOk + +`func (o *Campaign) GetAlertsOk() (*[]CampaignAlert, bool)` + +GetAlertsOk returns a tuple with the Alerts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlerts + +`func (o *Campaign) SetAlerts(v []CampaignAlert)` + +SetAlerts sets Alerts field to given value. + +### HasAlerts + +`func (o *Campaign) HasAlerts() bool` + +HasAlerts returns a boolean if a field has been set. + +### GetModified + +`func (o *Campaign) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Campaign) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Campaign) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Campaign) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetFilter + +`func (o *Campaign) GetFilter() FullcampaignAllOfFilter` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *Campaign) GetFilterOk() (*FullcampaignAllOfFilter, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *Campaign) SetFilter(v FullcampaignAllOfFilter)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *Campaign) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### GetSunsetCommentsRequired + +`func (o *Campaign) GetSunsetCommentsRequired() bool` + +GetSunsetCommentsRequired returns the SunsetCommentsRequired field if non-nil, zero value otherwise. + +### GetSunsetCommentsRequiredOk + +`func (o *Campaign) GetSunsetCommentsRequiredOk() (*bool, bool)` + +GetSunsetCommentsRequiredOk returns a tuple with the SunsetCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSunsetCommentsRequired + +`func (o *Campaign) SetSunsetCommentsRequired(v bool)` + +SetSunsetCommentsRequired sets SunsetCommentsRequired field to given value. + +### HasSunsetCommentsRequired + +`func (o *Campaign) HasSunsetCommentsRequired() bool` + +HasSunsetCommentsRequired returns a boolean if a field has been set. + +### GetSourceOwnerCampaignInfo + +`func (o *Campaign) GetSourceOwnerCampaignInfo() FullcampaignAllOfSourceOwnerCampaignInfo` + +GetSourceOwnerCampaignInfo returns the SourceOwnerCampaignInfo field if non-nil, zero value otherwise. + +### GetSourceOwnerCampaignInfoOk + +`func (o *Campaign) GetSourceOwnerCampaignInfoOk() (*FullcampaignAllOfSourceOwnerCampaignInfo, bool)` + +GetSourceOwnerCampaignInfoOk returns a tuple with the SourceOwnerCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceOwnerCampaignInfo + +`func (o *Campaign) SetSourceOwnerCampaignInfo(v FullcampaignAllOfSourceOwnerCampaignInfo)` + +SetSourceOwnerCampaignInfo sets SourceOwnerCampaignInfo field to given value. + +### HasSourceOwnerCampaignInfo + +`func (o *Campaign) HasSourceOwnerCampaignInfo() bool` + +HasSourceOwnerCampaignInfo returns a boolean if a field has been set. + +### GetSearchCampaignInfo + +`func (o *Campaign) GetSearchCampaignInfo() FullcampaignAllOfSearchCampaignInfo` + +GetSearchCampaignInfo returns the SearchCampaignInfo field if non-nil, zero value otherwise. + +### GetSearchCampaignInfoOk + +`func (o *Campaign) GetSearchCampaignInfoOk() (*FullcampaignAllOfSearchCampaignInfo, bool)` + +GetSearchCampaignInfoOk returns a tuple with the SearchCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchCampaignInfo + +`func (o *Campaign) SetSearchCampaignInfo(v FullcampaignAllOfSearchCampaignInfo)` + +SetSearchCampaignInfo sets SearchCampaignInfo field to given value. + +### HasSearchCampaignInfo + +`func (o *Campaign) HasSearchCampaignInfo() bool` + +HasSearchCampaignInfo returns a boolean if a field has been set. + +### GetRoleCompositionCampaignInfo + +`func (o *Campaign) GetRoleCompositionCampaignInfo() FullcampaignAllOfRoleCompositionCampaignInfo` + +GetRoleCompositionCampaignInfo returns the RoleCompositionCampaignInfo field if non-nil, zero value otherwise. + +### GetRoleCompositionCampaignInfoOk + +`func (o *Campaign) GetRoleCompositionCampaignInfoOk() (*FullcampaignAllOfRoleCompositionCampaignInfo, bool)` + +GetRoleCompositionCampaignInfoOk returns a tuple with the RoleCompositionCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleCompositionCampaignInfo + +`func (o *Campaign) SetRoleCompositionCampaignInfo(v FullcampaignAllOfRoleCompositionCampaignInfo)` + +SetRoleCompositionCampaignInfo sets RoleCompositionCampaignInfo field to given value. + +### HasRoleCompositionCampaignInfo + +`func (o *Campaign) HasRoleCompositionCampaignInfo() bool` + +HasRoleCompositionCampaignInfo returns a boolean if a field has been set. + +### GetMachineAccountCampaignInfo + +`func (o *Campaign) GetMachineAccountCampaignInfo() FullcampaignAllOfMachineAccountCampaignInfo` + +GetMachineAccountCampaignInfo returns the MachineAccountCampaignInfo field if non-nil, zero value otherwise. + +### GetMachineAccountCampaignInfoOk + +`func (o *Campaign) GetMachineAccountCampaignInfoOk() (*FullcampaignAllOfMachineAccountCampaignInfo, bool)` + +GetMachineAccountCampaignInfoOk returns a tuple with the MachineAccountCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMachineAccountCampaignInfo + +`func (o *Campaign) SetMachineAccountCampaignInfo(v FullcampaignAllOfMachineAccountCampaignInfo)` + +SetMachineAccountCampaignInfo sets MachineAccountCampaignInfo field to given value. + +### HasMachineAccountCampaignInfo + +`func (o *Campaign) HasMachineAccountCampaignInfo() bool` + +HasMachineAccountCampaignInfo returns a boolean if a field has been set. + +### GetSourcesWithOrphanEntitlements + +`func (o *Campaign) GetSourcesWithOrphanEntitlements() []FullcampaignAllOfSourcesWithOrphanEntitlements` + +GetSourcesWithOrphanEntitlements returns the SourcesWithOrphanEntitlements field if non-nil, zero value otherwise. + +### GetSourcesWithOrphanEntitlementsOk + +`func (o *Campaign) GetSourcesWithOrphanEntitlementsOk() (*[]FullcampaignAllOfSourcesWithOrphanEntitlements, bool)` + +GetSourcesWithOrphanEntitlementsOk returns a tuple with the SourcesWithOrphanEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourcesWithOrphanEntitlements + +`func (o *Campaign) SetSourcesWithOrphanEntitlements(v []FullcampaignAllOfSourcesWithOrphanEntitlements)` + +SetSourcesWithOrphanEntitlements sets SourcesWithOrphanEntitlements field to given value. + +### HasSourcesWithOrphanEntitlements + +`func (o *Campaign) HasSourcesWithOrphanEntitlements() bool` + +HasSourcesWithOrphanEntitlements returns a boolean if a field has been set. + +### GetMandatoryCommentRequirement + +`func (o *Campaign) GetMandatoryCommentRequirement() string` + +GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise. + +### GetMandatoryCommentRequirementOk + +`func (o *Campaign) GetMandatoryCommentRequirementOk() (*string, bool)` + +GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMandatoryCommentRequirement + +`func (o *Campaign) SetMandatoryCommentRequirement(v string)` + +SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value. + +### HasMandatoryCommentRequirement + +`func (o *Campaign) HasMandatoryCommentRequirement() bool` + +HasMandatoryCommentRequirement returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CampaignActivated.md b/docs/tools/sdk/go/Reference/Beta/Models/CampaignActivated.md new file mode 100644 index 000000000..24c63b6d7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CampaignActivated.md @@ -0,0 +1,59 @@ +--- +id: beta-campaign-activated +title: CampaignActivated +pagination_label: CampaignActivated +sidebar_label: CampaignActivated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignActivated', 'BetaCampaignActivated'] +slug: /tools/sdk/go/beta/models/campaign-activated +tags: ['SDK', 'Software Development Kit', 'CampaignActivated', 'BetaCampaignActivated'] +--- + +# CampaignActivated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | [**CampaignActivatedCampaign**](campaign-activated-campaign) | | + +## Methods + +### NewCampaignActivated + +`func NewCampaignActivated(campaign CampaignActivatedCampaign, ) *CampaignActivated` + +NewCampaignActivated instantiates a new CampaignActivated 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 + +### NewCampaignActivatedWithDefaults + +`func NewCampaignActivatedWithDefaults() *CampaignActivated` + +NewCampaignActivatedWithDefaults instantiates a new CampaignActivated 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 + +### GetCampaign + +`func (o *CampaignActivated) GetCampaign() CampaignActivatedCampaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignActivated) GetCampaignOk() (*CampaignActivatedCampaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *CampaignActivated) SetCampaign(v CampaignActivatedCampaign)` + +SetCampaign sets Campaign field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CampaignActivatedCampaign.md b/docs/tools/sdk/go/Reference/Beta/Models/CampaignActivatedCampaign.md new file mode 100644 index 000000000..6776efefd --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CampaignActivatedCampaign.md @@ -0,0 +1,242 @@ +--- +id: beta-campaign-activated-campaign +title: CampaignActivatedCampaign +pagination_label: CampaignActivatedCampaign +sidebar_label: CampaignActivatedCampaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignActivatedCampaign', 'BetaCampaignActivatedCampaign'] +slug: /tools/sdk/go/beta/models/campaign-activated-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaign', 'BetaCampaignActivatedCampaign'] +--- + +# CampaignActivatedCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Campaign's unique ID. | +**Name** | **string** | Campaign's name. | +**Description** | **string** | Campaign's extended description. | +**Created** | **SailPointTime** | Date and time when the campaign was created. | +**Modified** | Pointer to **NullableTime** | Date and time when the campaign was last modified. | [optional] +**Deadline** | **SailPointTime** | Date and time when the campaign is due. | +**Type** | **map[string]interface{}** | Campaign's type. | +**CampaignOwner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | +**Status** | **map[string]interface{}** | Campaign's current status. | + +## Methods + +### NewCampaignActivatedCampaign + +`func NewCampaignActivatedCampaign(id string, name string, description string, created SailPointTime, deadline SailPointTime, type_ map[string]interface{}, campaignOwner CampaignActivatedCampaignCampaignOwner, status map[string]interface{}, ) *CampaignActivatedCampaign` + +NewCampaignActivatedCampaign instantiates a new CampaignActivatedCampaign 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 + +### NewCampaignActivatedCampaignWithDefaults + +`func NewCampaignActivatedCampaignWithDefaults() *CampaignActivatedCampaign` + +NewCampaignActivatedCampaignWithDefaults instantiates a new CampaignActivatedCampaign 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 + +### GetId + +`func (o *CampaignActivatedCampaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignActivatedCampaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignActivatedCampaign) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignActivatedCampaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignActivatedCampaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignActivatedCampaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CampaignActivatedCampaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignActivatedCampaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignActivatedCampaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetCreated + +`func (o *CampaignActivatedCampaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignActivatedCampaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CampaignActivatedCampaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CampaignActivatedCampaign) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CampaignActivatedCampaign) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CampaignActivatedCampaign) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CampaignActivatedCampaign) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CampaignActivatedCampaign) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CampaignActivatedCampaign) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDeadline + +`func (o *CampaignActivatedCampaign) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *CampaignActivatedCampaign) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *CampaignActivatedCampaign) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + + +### GetType + +`func (o *CampaignActivatedCampaign) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignActivatedCampaign) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignActivatedCampaign) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetCampaignOwner + +`func (o *CampaignActivatedCampaign) GetCampaignOwner() CampaignActivatedCampaignCampaignOwner` + +GetCampaignOwner returns the CampaignOwner field if non-nil, zero value otherwise. + +### GetCampaignOwnerOk + +`func (o *CampaignActivatedCampaign) GetCampaignOwnerOk() (*CampaignActivatedCampaignCampaignOwner, bool)` + +GetCampaignOwnerOk returns a tuple with the CampaignOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignOwner + +`func (o *CampaignActivatedCampaign) SetCampaignOwner(v CampaignActivatedCampaignCampaignOwner)` + +SetCampaignOwner sets CampaignOwner field to given value. + + +### GetStatus + +`func (o *CampaignActivatedCampaign) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CampaignActivatedCampaign) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CampaignActivatedCampaign) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CampaignActivatedCampaignCampaignOwner.md b/docs/tools/sdk/go/Reference/Beta/Models/CampaignActivatedCampaignCampaignOwner.md new file mode 100644 index 000000000..0a79bacfd --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CampaignActivatedCampaignCampaignOwner.md @@ -0,0 +1,101 @@ +--- +id: beta-campaign-activated-campaign-campaign-owner +title: CampaignActivatedCampaignCampaignOwner +pagination_label: CampaignActivatedCampaignCampaignOwner +sidebar_label: CampaignActivatedCampaignCampaignOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignActivatedCampaignCampaignOwner', 'BetaCampaignActivatedCampaignCampaignOwner'] +slug: /tools/sdk/go/beta/models/campaign-activated-campaign-campaign-owner +tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaignCampaignOwner', 'BetaCampaignActivatedCampaignCampaignOwner'] +--- + +# CampaignActivatedCampaignCampaignOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Identity's unique ID. | +**DisplayName** | **string** | Identity's name. | +**Email** | **string** | Identity's primary email address. | + +## Methods + +### NewCampaignActivatedCampaignCampaignOwner + +`func NewCampaignActivatedCampaignCampaignOwner(id string, displayName string, email string, ) *CampaignActivatedCampaignCampaignOwner` + +NewCampaignActivatedCampaignCampaignOwner instantiates a new CampaignActivatedCampaignCampaignOwner 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 + +### NewCampaignActivatedCampaignCampaignOwnerWithDefaults + +`func NewCampaignActivatedCampaignCampaignOwnerWithDefaults() *CampaignActivatedCampaignCampaignOwner` + +NewCampaignActivatedCampaignCampaignOwnerWithDefaults instantiates a new CampaignActivatedCampaignCampaignOwner 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 + +### GetId + +`func (o *CampaignActivatedCampaignCampaignOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignActivatedCampaignCampaignOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignActivatedCampaignCampaignOwner) SetId(v string)` + +SetId sets Id field to given value. + + +### GetDisplayName + +`func (o *CampaignActivatedCampaignCampaignOwner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *CampaignActivatedCampaignCampaignOwner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *CampaignActivatedCampaignCampaignOwner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + + +### GetEmail + +`func (o *CampaignActivatedCampaignCampaignOwner) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *CampaignActivatedCampaignCampaignOwner) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *CampaignActivatedCampaignCampaignOwner) SetEmail(v string)` + +SetEmail sets Email field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CampaignAlert.md b/docs/tools/sdk/go/Reference/Beta/Models/CampaignAlert.md new file mode 100644 index 000000000..99506bf0a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CampaignAlert.md @@ -0,0 +1,90 @@ +--- +id: beta-campaign-alert +title: CampaignAlert +pagination_label: CampaignAlert +sidebar_label: CampaignAlert +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAlert', 'BetaCampaignAlert'] +slug: /tools/sdk/go/beta/models/campaign-alert +tags: ['SDK', 'Software Development Kit', 'CampaignAlert', 'BetaCampaignAlert'] +--- + +# CampaignAlert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Level** | Pointer to **string** | Denotes the level of the message | [optional] +**Localizations** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] + +## Methods + +### NewCampaignAlert + +`func NewCampaignAlert() *CampaignAlert` + +NewCampaignAlert instantiates a new CampaignAlert 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 + +### NewCampaignAlertWithDefaults + +`func NewCampaignAlertWithDefaults() *CampaignAlert` + +NewCampaignAlertWithDefaults instantiates a new CampaignAlert 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 + +### GetLevel + +`func (o *CampaignAlert) GetLevel() string` + +GetLevel returns the Level field if non-nil, zero value otherwise. + +### GetLevelOk + +`func (o *CampaignAlert) GetLevelOk() (*string, bool)` + +GetLevelOk returns a tuple with the Level field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLevel + +`func (o *CampaignAlert) SetLevel(v string)` + +SetLevel sets Level field to given value. + +### HasLevel + +`func (o *CampaignAlert) HasLevel() bool` + +HasLevel returns a boolean if a field has been set. + +### GetLocalizations + +`func (o *CampaignAlert) GetLocalizations() []ErrorMessageDto` + +GetLocalizations returns the Localizations field if non-nil, zero value otherwise. + +### GetLocalizationsOk + +`func (o *CampaignAlert) GetLocalizationsOk() (*[]ErrorMessageDto, bool)` + +GetLocalizationsOk returns a tuple with the Localizations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizations + +`func (o *CampaignAlert) SetLocalizations(v []ErrorMessageDto)` + +SetLocalizations sets Localizations field to given value. + +### HasLocalizations + +`func (o *CampaignAlert) HasLocalizations() bool` + +HasLocalizations returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CampaignEnded.md b/docs/tools/sdk/go/Reference/Beta/Models/CampaignEnded.md new file mode 100644 index 000000000..cb3de8bb8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CampaignEnded.md @@ -0,0 +1,59 @@ +--- +id: beta-campaign-ended +title: CampaignEnded +pagination_label: CampaignEnded +sidebar_label: CampaignEnded +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignEnded', 'BetaCampaignEnded'] +slug: /tools/sdk/go/beta/models/campaign-ended +tags: ['SDK', 'Software Development Kit', 'CampaignEnded', 'BetaCampaignEnded'] +--- + +# CampaignEnded + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | [**CampaignEndedCampaign**](campaign-ended-campaign) | | + +## Methods + +### NewCampaignEnded + +`func NewCampaignEnded(campaign CampaignEndedCampaign, ) *CampaignEnded` + +NewCampaignEnded instantiates a new CampaignEnded 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 + +### NewCampaignEndedWithDefaults + +`func NewCampaignEndedWithDefaults() *CampaignEnded` + +NewCampaignEndedWithDefaults instantiates a new CampaignEnded 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 + +### GetCampaign + +`func (o *CampaignEnded) GetCampaign() CampaignEndedCampaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignEnded) GetCampaignOk() (*CampaignEndedCampaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *CampaignEnded) SetCampaign(v CampaignEndedCampaign)` + +SetCampaign sets Campaign field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CampaignEndedCampaign.md b/docs/tools/sdk/go/Reference/Beta/Models/CampaignEndedCampaign.md new file mode 100644 index 000000000..bf1146596 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CampaignEndedCampaign.md @@ -0,0 +1,242 @@ +--- +id: beta-campaign-ended-campaign +title: CampaignEndedCampaign +pagination_label: CampaignEndedCampaign +sidebar_label: CampaignEndedCampaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignEndedCampaign', 'BetaCampaignEndedCampaign'] +slug: /tools/sdk/go/beta/models/campaign-ended-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignEndedCampaign', 'BetaCampaignEndedCampaign'] +--- + +# CampaignEndedCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Campaign's unique ID for the campaign. | +**Name** | **string** | Campaign's unique ID. | +**Description** | **string** | Campaign's extended description. | +**Created** | **SailPointTime** | Date and time when the campaign was created. | +**Modified** | Pointer to **NullableTime** | Date and time when the campaign was last modified. | [optional] +**Deadline** | **SailPointTime** | Date and time when the campaign is due. | +**Type** | **map[string]interface{}** | Campaign's type. | +**CampaignOwner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | +**Status** | **map[string]interface{}** | Campaign's current status. | + +## Methods + +### NewCampaignEndedCampaign + +`func NewCampaignEndedCampaign(id string, name string, description string, created SailPointTime, deadline SailPointTime, type_ map[string]interface{}, campaignOwner CampaignActivatedCampaignCampaignOwner, status map[string]interface{}, ) *CampaignEndedCampaign` + +NewCampaignEndedCampaign instantiates a new CampaignEndedCampaign 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 + +### NewCampaignEndedCampaignWithDefaults + +`func NewCampaignEndedCampaignWithDefaults() *CampaignEndedCampaign` + +NewCampaignEndedCampaignWithDefaults instantiates a new CampaignEndedCampaign 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 + +### GetId + +`func (o *CampaignEndedCampaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignEndedCampaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignEndedCampaign) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignEndedCampaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignEndedCampaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignEndedCampaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CampaignEndedCampaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignEndedCampaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignEndedCampaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetCreated + +`func (o *CampaignEndedCampaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignEndedCampaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CampaignEndedCampaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CampaignEndedCampaign) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CampaignEndedCampaign) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CampaignEndedCampaign) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CampaignEndedCampaign) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CampaignEndedCampaign) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CampaignEndedCampaign) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDeadline + +`func (o *CampaignEndedCampaign) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *CampaignEndedCampaign) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *CampaignEndedCampaign) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + + +### GetType + +`func (o *CampaignEndedCampaign) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignEndedCampaign) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignEndedCampaign) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetCampaignOwner + +`func (o *CampaignEndedCampaign) GetCampaignOwner() CampaignActivatedCampaignCampaignOwner` + +GetCampaignOwner returns the CampaignOwner field if non-nil, zero value otherwise. + +### GetCampaignOwnerOk + +`func (o *CampaignEndedCampaign) GetCampaignOwnerOk() (*CampaignActivatedCampaignCampaignOwner, bool)` + +GetCampaignOwnerOk returns a tuple with the CampaignOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignOwner + +`func (o *CampaignEndedCampaign) SetCampaignOwner(v CampaignActivatedCampaignCampaignOwner)` + +SetCampaignOwner sets CampaignOwner field to given value. + + +### GetStatus + +`func (o *CampaignEndedCampaign) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CampaignEndedCampaign) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CampaignEndedCampaign) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CampaignGenerated.md b/docs/tools/sdk/go/Reference/Beta/Models/CampaignGenerated.md new file mode 100644 index 000000000..e61337933 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CampaignGenerated.md @@ -0,0 +1,59 @@ +--- +id: beta-campaign-generated +title: CampaignGenerated +pagination_label: CampaignGenerated +sidebar_label: CampaignGenerated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignGenerated', 'BetaCampaignGenerated'] +slug: /tools/sdk/go/beta/models/campaign-generated +tags: ['SDK', 'Software Development Kit', 'CampaignGenerated', 'BetaCampaignGenerated'] +--- + +# CampaignGenerated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | + +## Methods + +### NewCampaignGenerated + +`func NewCampaignGenerated(campaign CampaignGeneratedCampaign, ) *CampaignGenerated` + +NewCampaignGenerated instantiates a new CampaignGenerated 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 + +### NewCampaignGeneratedWithDefaults + +`func NewCampaignGeneratedWithDefaults() *CampaignGenerated` + +NewCampaignGeneratedWithDefaults instantiates a new CampaignGenerated 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 + +### GetCampaign + +`func (o *CampaignGenerated) GetCampaign() CampaignGeneratedCampaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignGenerated) GetCampaignOk() (*CampaignGeneratedCampaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *CampaignGenerated) SetCampaign(v CampaignGeneratedCampaign)` + +SetCampaign sets Campaign field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CampaignGeneratedCampaign.md b/docs/tools/sdk/go/Reference/Beta/Models/CampaignGeneratedCampaign.md new file mode 100644 index 000000000..f09381f0d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CampaignGeneratedCampaign.md @@ -0,0 +1,257 @@ +--- +id: beta-campaign-generated-campaign +title: CampaignGeneratedCampaign +pagination_label: CampaignGeneratedCampaign +sidebar_label: CampaignGeneratedCampaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignGeneratedCampaign', 'BetaCampaignGeneratedCampaign'] +slug: /tools/sdk/go/beta/models/campaign-generated-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaign', 'BetaCampaignGeneratedCampaign'] +--- + +# CampaignGeneratedCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Campaign's unique ID. | +**Name** | **string** | Campaign's name. | +**Description** | **string** | Campaign's extended description. | +**Created** | **SailPointTime** | Date and time when the campaign was created. | +**Modified** | Pointer to **NullableString** | Date and time when the campaign was last modified. | [optional] +**Deadline** | Pointer to **NullableString** | Date and time when the campaign must be finished. | [optional] +**Type** | **map[string]interface{}** | Campaign's type. | +**CampaignOwner** | [**CampaignGeneratedCampaignCampaignOwner**](campaign-generated-campaign-campaign-owner) | | +**Status** | **map[string]interface{}** | Campaign's current status. | + +## Methods + +### NewCampaignGeneratedCampaign + +`func NewCampaignGeneratedCampaign(id string, name string, description string, created SailPointTime, type_ map[string]interface{}, campaignOwner CampaignGeneratedCampaignCampaignOwner, status map[string]interface{}, ) *CampaignGeneratedCampaign` + +NewCampaignGeneratedCampaign instantiates a new CampaignGeneratedCampaign 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 + +### NewCampaignGeneratedCampaignWithDefaults + +`func NewCampaignGeneratedCampaignWithDefaults() *CampaignGeneratedCampaign` + +NewCampaignGeneratedCampaignWithDefaults instantiates a new CampaignGeneratedCampaign 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 + +### GetId + +`func (o *CampaignGeneratedCampaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignGeneratedCampaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignGeneratedCampaign) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignGeneratedCampaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignGeneratedCampaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignGeneratedCampaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CampaignGeneratedCampaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignGeneratedCampaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignGeneratedCampaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetCreated + +`func (o *CampaignGeneratedCampaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignGeneratedCampaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CampaignGeneratedCampaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CampaignGeneratedCampaign) GetModified() string` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CampaignGeneratedCampaign) GetModifiedOk() (*string, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CampaignGeneratedCampaign) SetModified(v string)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CampaignGeneratedCampaign) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CampaignGeneratedCampaign) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CampaignGeneratedCampaign) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDeadline + +`func (o *CampaignGeneratedCampaign) GetDeadline() string` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *CampaignGeneratedCampaign) GetDeadlineOk() (*string, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *CampaignGeneratedCampaign) SetDeadline(v string)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *CampaignGeneratedCampaign) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### SetDeadlineNil + +`func (o *CampaignGeneratedCampaign) SetDeadlineNil(b bool)` + + SetDeadlineNil sets the value for Deadline to be an explicit nil + +### UnsetDeadline +`func (o *CampaignGeneratedCampaign) UnsetDeadline()` + +UnsetDeadline ensures that no value is present for Deadline, not even an explicit nil +### GetType + +`func (o *CampaignGeneratedCampaign) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignGeneratedCampaign) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignGeneratedCampaign) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetCampaignOwner + +`func (o *CampaignGeneratedCampaign) GetCampaignOwner() CampaignGeneratedCampaignCampaignOwner` + +GetCampaignOwner returns the CampaignOwner field if non-nil, zero value otherwise. + +### GetCampaignOwnerOk + +`func (o *CampaignGeneratedCampaign) GetCampaignOwnerOk() (*CampaignGeneratedCampaignCampaignOwner, bool)` + +GetCampaignOwnerOk returns a tuple with the CampaignOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignOwner + +`func (o *CampaignGeneratedCampaign) SetCampaignOwner(v CampaignGeneratedCampaignCampaignOwner)` + +SetCampaignOwner sets CampaignOwner field to given value. + + +### GetStatus + +`func (o *CampaignGeneratedCampaign) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CampaignGeneratedCampaign) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CampaignGeneratedCampaign) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CampaignGeneratedCampaignCampaignOwner.md b/docs/tools/sdk/go/Reference/Beta/Models/CampaignGeneratedCampaignCampaignOwner.md new file mode 100644 index 000000000..90ac63838 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CampaignGeneratedCampaignCampaignOwner.md @@ -0,0 +1,101 @@ +--- +id: beta-campaign-generated-campaign-campaign-owner +title: CampaignGeneratedCampaignCampaignOwner +pagination_label: CampaignGeneratedCampaignCampaignOwner +sidebar_label: CampaignGeneratedCampaignCampaignOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignGeneratedCampaignCampaignOwner', 'BetaCampaignGeneratedCampaignCampaignOwner'] +slug: /tools/sdk/go/beta/models/campaign-generated-campaign-campaign-owner +tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaignCampaignOwner', 'BetaCampaignGeneratedCampaignCampaignOwner'] +--- + +# CampaignGeneratedCampaignCampaignOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Identity's unique ID. | +**DisplayName** | **string** | Identity's name. | +**Email** | **string** | Identity's primary email address. | + +## Methods + +### NewCampaignGeneratedCampaignCampaignOwner + +`func NewCampaignGeneratedCampaignCampaignOwner(id string, displayName string, email string, ) *CampaignGeneratedCampaignCampaignOwner` + +NewCampaignGeneratedCampaignCampaignOwner instantiates a new CampaignGeneratedCampaignCampaignOwner 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 + +### NewCampaignGeneratedCampaignCampaignOwnerWithDefaults + +`func NewCampaignGeneratedCampaignCampaignOwnerWithDefaults() *CampaignGeneratedCampaignCampaignOwner` + +NewCampaignGeneratedCampaignCampaignOwnerWithDefaults instantiates a new CampaignGeneratedCampaignCampaignOwner 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 + +### GetId + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignGeneratedCampaignCampaignOwner) SetId(v string)` + +SetId sets Id field to given value. + + +### GetDisplayName + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *CampaignGeneratedCampaignCampaignOwner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + + +### GetEmail + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *CampaignGeneratedCampaignCampaignOwner) SetEmail(v string)` + +SetEmail sets Email field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CampaignReference.md b/docs/tools/sdk/go/Reference/Beta/Models/CampaignReference.md new file mode 100644 index 000000000..18d5277f1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CampaignReference.md @@ -0,0 +1,195 @@ +--- +id: beta-campaign-reference +title: CampaignReference +pagination_label: CampaignReference +sidebar_label: CampaignReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignReference', 'BetaCampaignReference'] +slug: /tools/sdk/go/beta/models/campaign-reference +tags: ['SDK', 'Software Development Kit', 'CampaignReference', 'BetaCampaignReference'] +--- + +# CampaignReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the campaign. | +**Name** | **string** | The name of the campaign. | +**Type** | **string** | The type of object that is being referenced. | +**CampaignType** | **string** | The type of the campaign. | +**Description** | **NullableString** | The description of the campaign set by the admin who created it. | +**CorrelatedStatus** | **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | +**MandatoryCommentRequirement** | **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | + +## Methods + +### NewCampaignReference + +`func NewCampaignReference(id string, name string, type_ string, campaignType string, description NullableString, correlatedStatus string, mandatoryCommentRequirement string, ) *CampaignReference` + +NewCampaignReference instantiates a new CampaignReference 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 + +### NewCampaignReferenceWithDefaults + +`func NewCampaignReferenceWithDefaults() *CampaignReference` + +NewCampaignReferenceWithDefaults instantiates a new CampaignReference 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 + +### GetId + +`func (o *CampaignReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignReference) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignReference) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *CampaignReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignReference) SetType(v string)` + +SetType sets Type field to given value. + + +### GetCampaignType + +`func (o *CampaignReference) GetCampaignType() string` + +GetCampaignType returns the CampaignType field if non-nil, zero value otherwise. + +### GetCampaignTypeOk + +`func (o *CampaignReference) GetCampaignTypeOk() (*string, bool)` + +GetCampaignTypeOk returns a tuple with the CampaignType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignType + +`func (o *CampaignReference) SetCampaignType(v string)` + +SetCampaignType sets CampaignType field to given value. + + +### GetDescription + +`func (o *CampaignReference) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignReference) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignReference) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *CampaignReference) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CampaignReference) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCorrelatedStatus + +`func (o *CampaignReference) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *CampaignReference) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *CampaignReference) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + + +### GetMandatoryCommentRequirement + +`func (o *CampaignReference) GetMandatoryCommentRequirement() string` + +GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise. + +### GetMandatoryCommentRequirementOk + +`func (o *CampaignReference) GetMandatoryCommentRequirementOk() (*string, bool)` + +GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMandatoryCommentRequirement + +`func (o *CampaignReference) SetMandatoryCommentRequirement(v string)` + +SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CampaignReport.md b/docs/tools/sdk/go/Reference/Beta/Models/CampaignReport.md new file mode 100644 index 000000000..3e0bbd73d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CampaignReport.md @@ -0,0 +1,189 @@ +--- +id: beta-campaign-report +title: CampaignReport +pagination_label: CampaignReport +sidebar_label: CampaignReport +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignReport', 'BetaCampaignReport'] +slug: /tools/sdk/go/beta/models/campaign-report +tags: ['SDK', 'Software Development Kit', 'CampaignReport', 'BetaCampaignReport'] +--- + +# CampaignReport + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **string** | Human-readable name of the SOD policy violation report result. | [optional] +**Status** | Pointer to **string** | Status of a SOD policy violation report. | [optional] +**ReportType** | [**ReportType**](report-type) | | +**LastRunAt** | Pointer to **SailPointTime** | The most recent date and time this report was run | [optional] [readonly] + +## Methods + +### NewCampaignReport + +`func NewCampaignReport(reportType ReportType, ) *CampaignReport` + +NewCampaignReport instantiates a new CampaignReport 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 + +### NewCampaignReportWithDefaults + +`func NewCampaignReportWithDefaults() *CampaignReport` + +NewCampaignReportWithDefaults instantiates a new CampaignReport 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 + +### GetType + +`func (o *CampaignReport) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignReport) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignReport) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignReport) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CampaignReport) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignReport) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignReport) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignReport) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignReport) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignReport) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignReport) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignReport) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *CampaignReport) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CampaignReport) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CampaignReport) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CampaignReport) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetReportType + +`func (o *CampaignReport) GetReportType() ReportType` + +GetReportType returns the ReportType field if non-nil, zero value otherwise. + +### GetReportTypeOk + +`func (o *CampaignReport) GetReportTypeOk() (*ReportType, bool)` + +GetReportTypeOk returns a tuple with the ReportType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportType + +`func (o *CampaignReport) SetReportType(v ReportType)` + +SetReportType sets ReportType field to given value. + + +### GetLastRunAt + +`func (o *CampaignReport) GetLastRunAt() SailPointTime` + +GetLastRunAt returns the LastRunAt field if non-nil, zero value otherwise. + +### GetLastRunAtOk + +`func (o *CampaignReport) GetLastRunAtOk() (*SailPointTime, bool)` + +GetLastRunAtOk returns a tuple with the LastRunAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastRunAt + +`func (o *CampaignReport) SetLastRunAt(v SailPointTime)` + +SetLastRunAt sets LastRunAt field to given value. + +### HasLastRunAt + +`func (o *CampaignReport) HasLastRunAt() bool` + +HasLastRunAt returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CampaignReportsConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/CampaignReportsConfig.md new file mode 100644 index 000000000..11b80d78f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CampaignReportsConfig.md @@ -0,0 +1,74 @@ +--- +id: beta-campaign-reports-config +title: CampaignReportsConfig +pagination_label: CampaignReportsConfig +sidebar_label: CampaignReportsConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignReportsConfig', 'BetaCampaignReportsConfig'] +slug: /tools/sdk/go/beta/models/campaign-reports-config +tags: ['SDK', 'Software Development Kit', 'CampaignReportsConfig', 'BetaCampaignReportsConfig'] +--- + +# CampaignReportsConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttributeColumns** | Pointer to **[]string** | list of identity attribute columns | [optional] + +## Methods + +### NewCampaignReportsConfig + +`func NewCampaignReportsConfig() *CampaignReportsConfig` + +NewCampaignReportsConfig instantiates a new CampaignReportsConfig 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 + +### NewCampaignReportsConfigWithDefaults + +`func NewCampaignReportsConfigWithDefaults() *CampaignReportsConfig` + +NewCampaignReportsConfigWithDefaults instantiates a new CampaignReportsConfig 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 + +### GetIdentityAttributeColumns + +`func (o *CampaignReportsConfig) GetIdentityAttributeColumns() []string` + +GetIdentityAttributeColumns returns the IdentityAttributeColumns field if non-nil, zero value otherwise. + +### GetIdentityAttributeColumnsOk + +`func (o *CampaignReportsConfig) GetIdentityAttributeColumnsOk() (*[]string, bool)` + +GetIdentityAttributeColumnsOk returns a tuple with the IdentityAttributeColumns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeColumns + +`func (o *CampaignReportsConfig) SetIdentityAttributeColumns(v []string)` + +SetIdentityAttributeColumns sets IdentityAttributeColumns field to given value. + +### HasIdentityAttributeColumns + +`func (o *CampaignReportsConfig) HasIdentityAttributeColumns() bool` + +HasIdentityAttributeColumns returns a boolean if a field has been set. + +### SetIdentityAttributeColumnsNil + +`func (o *CampaignReportsConfig) SetIdentityAttributeColumnsNil(b bool)` + + SetIdentityAttributeColumnsNil sets the value for IdentityAttributeColumns to be an explicit nil + +### UnsetIdentityAttributeColumns +`func (o *CampaignReportsConfig) UnsetIdentityAttributeColumns()` + +UnsetIdentityAttributeColumns ensures that no value is present for IdentityAttributeColumns, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CampaignTemplate.md b/docs/tools/sdk/go/Reference/Beta/Models/CampaignTemplate.md new file mode 100644 index 000000000..25caf7152 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CampaignTemplate.md @@ -0,0 +1,257 @@ +--- +id: beta-campaign-template +title: CampaignTemplate +pagination_label: CampaignTemplate +sidebar_label: CampaignTemplate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignTemplate', 'BetaCampaignTemplate'] +slug: /tools/sdk/go/beta/models/campaign-template +tags: ['SDK', 'Software Development Kit', 'CampaignTemplate', 'BetaCampaignTemplate'] +--- + +# CampaignTemplate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the campaign template | [optional] +**Name** | **string** | This template's name. Has no bearing on generated campaigns' names. | +**Description** | **string** | This template's description. Has no bearing on generated campaigns' descriptions. | +**Created** | **SailPointTime** | Creation date of Campaign Template | [readonly] +**Modified** | **NullableTime** | Modification date of Campaign Template | [readonly] +**Scheduled** | Pointer to **bool** | Indicates if this campaign template has been scheduled. | [optional] [readonly] [default to false] +**OwnerRef** | Pointer to [**CampaignTemplateOwnerRef**](campaign-template-owner-ref) | | [optional] +**DeadlineDuration** | Pointer to **string** | The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days). | [optional] +**Campaign** | [**Campaign**](campaign) | | + +## Methods + +### NewCampaignTemplate + +`func NewCampaignTemplate(name string, description string, created SailPointTime, modified NullableTime, campaign Campaign, ) *CampaignTemplate` + +NewCampaignTemplate instantiates a new CampaignTemplate 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 + +### NewCampaignTemplateWithDefaults + +`func NewCampaignTemplateWithDefaults() *CampaignTemplate` + +NewCampaignTemplateWithDefaults instantiates a new CampaignTemplate 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 + +### GetId + +`func (o *CampaignTemplate) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignTemplate) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignTemplate) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignTemplate) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignTemplate) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignTemplate) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignTemplate) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CampaignTemplate) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignTemplate) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignTemplate) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetCreated + +`func (o *CampaignTemplate) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignTemplate) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CampaignTemplate) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CampaignTemplate) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CampaignTemplate) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CampaignTemplate) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### SetModifiedNil + +`func (o *CampaignTemplate) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CampaignTemplate) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetScheduled + +`func (o *CampaignTemplate) GetScheduled() bool` + +GetScheduled returns the Scheduled field if non-nil, zero value otherwise. + +### GetScheduledOk + +`func (o *CampaignTemplate) GetScheduledOk() (*bool, bool)` + +GetScheduledOk returns a tuple with the Scheduled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheduled + +`func (o *CampaignTemplate) SetScheduled(v bool)` + +SetScheduled sets Scheduled field to given value. + +### HasScheduled + +`func (o *CampaignTemplate) HasScheduled() bool` + +HasScheduled returns a boolean if a field has been set. + +### GetOwnerRef + +`func (o *CampaignTemplate) GetOwnerRef() CampaignTemplateOwnerRef` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *CampaignTemplate) GetOwnerRefOk() (*CampaignTemplateOwnerRef, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *CampaignTemplate) SetOwnerRef(v CampaignTemplateOwnerRef)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *CampaignTemplate) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### GetDeadlineDuration + +`func (o *CampaignTemplate) GetDeadlineDuration() string` + +GetDeadlineDuration returns the DeadlineDuration field if non-nil, zero value otherwise. + +### GetDeadlineDurationOk + +`func (o *CampaignTemplate) GetDeadlineDurationOk() (*string, bool)` + +GetDeadlineDurationOk returns a tuple with the DeadlineDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadlineDuration + +`func (o *CampaignTemplate) SetDeadlineDuration(v string)` + +SetDeadlineDuration sets DeadlineDuration field to given value. + +### HasDeadlineDuration + +`func (o *CampaignTemplate) HasDeadlineDuration() bool` + +HasDeadlineDuration returns a boolean if a field has been set. + +### GetCampaign + +`func (o *CampaignTemplate) GetCampaign() Campaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignTemplate) GetCampaignOk() (*Campaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *CampaignTemplate) SetCampaign(v Campaign)` + +SetCampaign sets Campaign field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CampaignTemplateOwnerRef.md b/docs/tools/sdk/go/Reference/Beta/Models/CampaignTemplateOwnerRef.md new file mode 100644 index 000000000..5e62ef7dc --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CampaignTemplateOwnerRef.md @@ -0,0 +1,142 @@ +--- +id: beta-campaign-template-owner-ref +title: CampaignTemplateOwnerRef +pagination_label: CampaignTemplateOwnerRef +sidebar_label: CampaignTemplateOwnerRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignTemplateOwnerRef', 'BetaCampaignTemplateOwnerRef'] +slug: /tools/sdk/go/beta/models/campaign-template-owner-ref +tags: ['SDK', 'Software Development Kit', 'CampaignTemplateOwnerRef', 'BetaCampaignTemplateOwnerRef'] +--- + +# CampaignTemplateOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the owner | [optional] +**Type** | Pointer to **string** | Type of the owner | [optional] +**Name** | Pointer to **string** | Name of the owner | [optional] +**Email** | Pointer to **string** | Email of the owner | [optional] + +## Methods + +### NewCampaignTemplateOwnerRef + +`func NewCampaignTemplateOwnerRef() *CampaignTemplateOwnerRef` + +NewCampaignTemplateOwnerRef instantiates a new CampaignTemplateOwnerRef 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 + +### NewCampaignTemplateOwnerRefWithDefaults + +`func NewCampaignTemplateOwnerRefWithDefaults() *CampaignTemplateOwnerRef` + +NewCampaignTemplateOwnerRefWithDefaults instantiates a new CampaignTemplateOwnerRef 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 + +### GetId + +`func (o *CampaignTemplateOwnerRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignTemplateOwnerRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignTemplateOwnerRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignTemplateOwnerRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CampaignTemplateOwnerRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignTemplateOwnerRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignTemplateOwnerRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignTemplateOwnerRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignTemplateOwnerRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignTemplateOwnerRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignTemplateOwnerRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignTemplateOwnerRef) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *CampaignTemplateOwnerRef) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *CampaignTemplateOwnerRef) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *CampaignTemplateOwnerRef) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *CampaignTemplateOwnerRef) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CancelAccessRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/CancelAccessRequest.md new file mode 100644 index 000000000..291ccf134 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CancelAccessRequest.md @@ -0,0 +1,80 @@ +--- +id: beta-cancel-access-request +title: CancelAccessRequest +pagination_label: CancelAccessRequest +sidebar_label: CancelAccessRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CancelAccessRequest', 'BetaCancelAccessRequest'] +slug: /tools/sdk/go/beta/models/cancel-access-request +tags: ['SDK', 'Software Development Kit', 'CancelAccessRequest', 'BetaCancelAccessRequest'] +--- + +# CancelAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountActivityId** | **string** | This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. | +**Comment** | **string** | Reason for cancelling the pending access request. | + +## Methods + +### NewCancelAccessRequest + +`func NewCancelAccessRequest(accountActivityId string, comment string, ) *CancelAccessRequest` + +NewCancelAccessRequest instantiates a new CancelAccessRequest 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 + +### NewCancelAccessRequestWithDefaults + +`func NewCancelAccessRequestWithDefaults() *CancelAccessRequest` + +NewCancelAccessRequestWithDefaults instantiates a new CancelAccessRequest 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 + +### GetAccountActivityId + +`func (o *CancelAccessRequest) GetAccountActivityId() string` + +GetAccountActivityId returns the AccountActivityId field if non-nil, zero value otherwise. + +### GetAccountActivityIdOk + +`func (o *CancelAccessRequest) GetAccountActivityIdOk() (*string, bool)` + +GetAccountActivityIdOk returns a tuple with the AccountActivityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActivityId + +`func (o *CancelAccessRequest) SetAccountActivityId(v string)` + +SetAccountActivityId sets AccountActivityId field to given value. + + +### GetComment + +`func (o *CancelAccessRequest) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CancelAccessRequest) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CancelAccessRequest) SetComment(v string)` + +SetComment sets Comment field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CancelableAccountActivity.md b/docs/tools/sdk/go/Reference/Beta/Models/CancelableAccountActivity.md new file mode 100644 index 000000000..74368f0ea --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CancelableAccountActivity.md @@ -0,0 +1,564 @@ +--- +id: beta-cancelable-account-activity +title: CancelableAccountActivity +pagination_label: CancelableAccountActivity +sidebar_label: CancelableAccountActivity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CancelableAccountActivity', 'BetaCancelableAccountActivity'] +slug: /tools/sdk/go/beta/models/cancelable-account-activity +tags: ['SDK', 'Software Development Kit', 'CancelableAccountActivity', 'BetaCancelableAccountActivity'] +--- + +# CancelableAccountActivity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the account activity itself | [optional] +**Name** | Pointer to **string** | | [optional] +**Created** | Pointer to **SailPointTime** | | [optional] +**Modified** | Pointer to **NullableTime** | | [optional] +**Completed** | Pointer to **NullableTime** | | [optional] +**CompletionStatus** | Pointer to [**NullableCompletionStatus**](completion-status) | | [optional] +**Type** | Pointer to **NullableString** | | [optional] +**RequesterIdentitySummary** | Pointer to [**NullableIdentitySummary**](identity-summary) | | [optional] +**TargetIdentitySummary** | Pointer to [**NullableIdentitySummary**](identity-summary) | | [optional] +**Errors** | Pointer to **[]string** | | [optional] +**Warnings** | Pointer to **[]string** | | [optional] +**Items** | Pointer to [**[]AccountActivityItem**](account-activity-item) | | [optional] +**ExecutionStatus** | Pointer to [**ExecutionStatus**](execution-status) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] +**Cancelable** | Pointer to **bool** | Whether the account activity can be canceled before completion | [optional] +**CancelComment** | Pointer to [**NullableComment**](comment) | | [optional] + +## Methods + +### NewCancelableAccountActivity + +`func NewCancelableAccountActivity() *CancelableAccountActivity` + +NewCancelableAccountActivity instantiates a new CancelableAccountActivity 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 + +### NewCancelableAccountActivityWithDefaults + +`func NewCancelableAccountActivityWithDefaults() *CancelableAccountActivity` + +NewCancelableAccountActivityWithDefaults instantiates a new CancelableAccountActivity 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 + +### GetId + +`func (o *CancelableAccountActivity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CancelableAccountActivity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CancelableAccountActivity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CancelableAccountActivity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CancelableAccountActivity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CancelableAccountActivity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CancelableAccountActivity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CancelableAccountActivity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *CancelableAccountActivity) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CancelableAccountActivity) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CancelableAccountActivity) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CancelableAccountActivity) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *CancelableAccountActivity) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CancelableAccountActivity) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CancelableAccountActivity) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CancelableAccountActivity) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CancelableAccountActivity) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CancelableAccountActivity) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetCompleted + +`func (o *CancelableAccountActivity) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *CancelableAccountActivity) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *CancelableAccountActivity) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *CancelableAccountActivity) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *CancelableAccountActivity) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *CancelableAccountActivity) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetCompletionStatus + +`func (o *CancelableAccountActivity) GetCompletionStatus() CompletionStatus` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *CancelableAccountActivity) GetCompletionStatusOk() (*CompletionStatus, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *CancelableAccountActivity) SetCompletionStatus(v CompletionStatus)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *CancelableAccountActivity) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + +### SetCompletionStatusNil + +`func (o *CancelableAccountActivity) SetCompletionStatusNil(b bool)` + + SetCompletionStatusNil sets the value for CompletionStatus to be an explicit nil + +### UnsetCompletionStatus +`func (o *CancelableAccountActivity) UnsetCompletionStatus()` + +UnsetCompletionStatus ensures that no value is present for CompletionStatus, not even an explicit nil +### GetType + +`func (o *CancelableAccountActivity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CancelableAccountActivity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CancelableAccountActivity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CancelableAccountActivity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *CancelableAccountActivity) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *CancelableAccountActivity) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetRequesterIdentitySummary + +`func (o *CancelableAccountActivity) GetRequesterIdentitySummary() IdentitySummary` + +GetRequesterIdentitySummary returns the RequesterIdentitySummary field if non-nil, zero value otherwise. + +### GetRequesterIdentitySummaryOk + +`func (o *CancelableAccountActivity) GetRequesterIdentitySummaryOk() (*IdentitySummary, bool)` + +GetRequesterIdentitySummaryOk returns a tuple with the RequesterIdentitySummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterIdentitySummary + +`func (o *CancelableAccountActivity) SetRequesterIdentitySummary(v IdentitySummary)` + +SetRequesterIdentitySummary sets RequesterIdentitySummary field to given value. + +### HasRequesterIdentitySummary + +`func (o *CancelableAccountActivity) HasRequesterIdentitySummary() bool` + +HasRequesterIdentitySummary returns a boolean if a field has been set. + +### SetRequesterIdentitySummaryNil + +`func (o *CancelableAccountActivity) SetRequesterIdentitySummaryNil(b bool)` + + SetRequesterIdentitySummaryNil sets the value for RequesterIdentitySummary to be an explicit nil + +### UnsetRequesterIdentitySummary +`func (o *CancelableAccountActivity) UnsetRequesterIdentitySummary()` + +UnsetRequesterIdentitySummary ensures that no value is present for RequesterIdentitySummary, not even an explicit nil +### GetTargetIdentitySummary + +`func (o *CancelableAccountActivity) GetTargetIdentitySummary() IdentitySummary` + +GetTargetIdentitySummary returns the TargetIdentitySummary field if non-nil, zero value otherwise. + +### GetTargetIdentitySummaryOk + +`func (o *CancelableAccountActivity) GetTargetIdentitySummaryOk() (*IdentitySummary, bool)` + +GetTargetIdentitySummaryOk returns a tuple with the TargetIdentitySummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetIdentitySummary + +`func (o *CancelableAccountActivity) SetTargetIdentitySummary(v IdentitySummary)` + +SetTargetIdentitySummary sets TargetIdentitySummary field to given value. + +### HasTargetIdentitySummary + +`func (o *CancelableAccountActivity) HasTargetIdentitySummary() bool` + +HasTargetIdentitySummary returns a boolean if a field has been set. + +### SetTargetIdentitySummaryNil + +`func (o *CancelableAccountActivity) SetTargetIdentitySummaryNil(b bool)` + + SetTargetIdentitySummaryNil sets the value for TargetIdentitySummary to be an explicit nil + +### UnsetTargetIdentitySummary +`func (o *CancelableAccountActivity) UnsetTargetIdentitySummary()` + +UnsetTargetIdentitySummary ensures that no value is present for TargetIdentitySummary, not even an explicit nil +### GetErrors + +`func (o *CancelableAccountActivity) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *CancelableAccountActivity) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *CancelableAccountActivity) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *CancelableAccountActivity) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### SetErrorsNil + +`func (o *CancelableAccountActivity) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *CancelableAccountActivity) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *CancelableAccountActivity) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *CancelableAccountActivity) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *CancelableAccountActivity) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *CancelableAccountActivity) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + +### SetWarningsNil + +`func (o *CancelableAccountActivity) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *CancelableAccountActivity) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetItems + +`func (o *CancelableAccountActivity) GetItems() []AccountActivityItem` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *CancelableAccountActivity) GetItemsOk() (*[]AccountActivityItem, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *CancelableAccountActivity) SetItems(v []AccountActivityItem)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *CancelableAccountActivity) HasItems() bool` + +HasItems returns a boolean if a field has been set. + +### SetItemsNil + +`func (o *CancelableAccountActivity) SetItemsNil(b bool)` + + SetItemsNil sets the value for Items to be an explicit nil + +### UnsetItems +`func (o *CancelableAccountActivity) UnsetItems()` + +UnsetItems ensures that no value is present for Items, not even an explicit nil +### GetExecutionStatus + +`func (o *CancelableAccountActivity) GetExecutionStatus() ExecutionStatus` + +GetExecutionStatus returns the ExecutionStatus field if non-nil, zero value otherwise. + +### GetExecutionStatusOk + +`func (o *CancelableAccountActivity) GetExecutionStatusOk() (*ExecutionStatus, bool)` + +GetExecutionStatusOk returns a tuple with the ExecutionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExecutionStatus + +`func (o *CancelableAccountActivity) SetExecutionStatus(v ExecutionStatus)` + +SetExecutionStatus sets ExecutionStatus field to given value. + +### HasExecutionStatus + +`func (o *CancelableAccountActivity) HasExecutionStatus() bool` + +HasExecutionStatus returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *CancelableAccountActivity) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *CancelableAccountActivity) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *CancelableAccountActivity) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *CancelableAccountActivity) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *CancelableAccountActivity) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *CancelableAccountActivity) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetCancelable + +`func (o *CancelableAccountActivity) GetCancelable() bool` + +GetCancelable returns the Cancelable field if non-nil, zero value otherwise. + +### GetCancelableOk + +`func (o *CancelableAccountActivity) GetCancelableOk() (*bool, bool)` + +GetCancelableOk returns a tuple with the Cancelable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCancelable + +`func (o *CancelableAccountActivity) SetCancelable(v bool)` + +SetCancelable sets Cancelable field to given value. + +### HasCancelable + +`func (o *CancelableAccountActivity) HasCancelable() bool` + +HasCancelable returns a boolean if a field has been set. + +### GetCancelComment + +`func (o *CancelableAccountActivity) GetCancelComment() Comment` + +GetCancelComment returns the CancelComment field if non-nil, zero value otherwise. + +### GetCancelCommentOk + +`func (o *CancelableAccountActivity) GetCancelCommentOk() (*Comment, bool)` + +GetCancelCommentOk returns a tuple with the CancelComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCancelComment + +`func (o *CancelableAccountActivity) SetCancelComment(v Comment)` + +SetCancelComment sets CancelComment field to given value. + +### HasCancelComment + +`func (o *CancelableAccountActivity) HasCancelComment() bool` + +HasCancelComment returns a boolean if a field has been set. + +### SetCancelCommentNil + +`func (o *CancelableAccountActivity) SetCancelCommentNil(b bool)` + + SetCancelCommentNil sets the value for CancelComment to be an explicit nil + +### UnsetCancelComment +`func (o *CancelableAccountActivity) UnsetCancelComment()` + +UnsetCancelComment ensures that no value is present for CancelComment, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CancelledRequestDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/CancelledRequestDetails.md new file mode 100644 index 000000000..5b291581d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CancelledRequestDetails.md @@ -0,0 +1,116 @@ +--- +id: beta-cancelled-request-details +title: CancelledRequestDetails +pagination_label: CancelledRequestDetails +sidebar_label: CancelledRequestDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CancelledRequestDetails', 'BetaCancelledRequestDetails'] +slug: /tools/sdk/go/beta/models/cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails', 'BetaCancelledRequestDetails'] +--- + +# CancelledRequestDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment made by the owner when cancelling the associated request. | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Modified** | Pointer to **SailPointTime** | Date comment was added by the owner when cancelling the associated request. | [optional] + +## Methods + +### NewCancelledRequestDetails + +`func NewCancelledRequestDetails() *CancelledRequestDetails` + +NewCancelledRequestDetails instantiates a new CancelledRequestDetails 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 + +### NewCancelledRequestDetailsWithDefaults + +`func NewCancelledRequestDetailsWithDefaults() *CancelledRequestDetails` + +NewCancelledRequestDetailsWithDefaults instantiates a new CancelledRequestDetails 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 + +### GetComment + +`func (o *CancelledRequestDetails) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CancelledRequestDetails) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CancelledRequestDetails) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CancelledRequestDetails) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetOwner + +`func (o *CancelledRequestDetails) GetOwner() OwnerDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CancelledRequestDetails) GetOwnerOk() (*OwnerDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CancelledRequestDetails) SetOwner(v OwnerDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *CancelledRequestDetails) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetModified + +`func (o *CancelledRequestDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CancelledRequestDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CancelledRequestDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CancelledRequestDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CertificationDto.md b/docs/tools/sdk/go/Reference/Beta/Models/CertificationDto.md new file mode 100644 index 000000000..094e70fad --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CertificationDto.md @@ -0,0 +1,331 @@ +--- +id: beta-certification-dto +title: CertificationDto +pagination_label: CertificationDto +sidebar_label: CertificationDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationDto', 'BetaCertificationDto'] +slug: /tools/sdk/go/beta/models/certification-dto +tags: ['SDK', 'Software Development Kit', 'CertificationDto', 'BetaCertificationDto'] +--- + +# CertificationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CampaignRef** | [**CampaignReference**](campaign-reference) | | +**Phase** | [**CertificationPhase**](certification-phase) | | +**Due** | **SailPointTime** | Date and time when the certification is due. | +**Signed** | **SailPointTime** | Date and time when the reviewer signed off on the certification. | +**Reviewer** | [**Reviewer**](reviewer) | | +**Reassignment** | Pointer to [**Reassignment**](reassignment) | | [optional] +**HasErrors** | **bool** | Indicates whether the certification has any errors. | +**ErrorMessage** | Pointer to **NullableString** | Message indicating what the error is. | [optional] +**Completed** | **bool** | Indicates whether all certification decisions have been made. | +**DecisionsMade** | **int32** | Number of approve/revoke/acknowledge decisions the reviewer has made. | +**DecisionsTotal** | **int32** | Total number of approve/revoke/acknowledge decisions for the certification. | +**EntitiesCompleted** | **int32** | Number of entities (identities, access profiles, roles, etc.) that are complete and all decisions have been made for. | +**EntitiesTotal** | **int32** | Total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | + +## Methods + +### NewCertificationDto + +`func NewCertificationDto(campaignRef CampaignReference, phase CertificationPhase, due SailPointTime, signed SailPointTime, reviewer Reviewer, hasErrors bool, completed bool, decisionsMade int32, decisionsTotal int32, entitiesCompleted int32, entitiesTotal int32, ) *CertificationDto` + +NewCertificationDto instantiates a new CertificationDto 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 + +### NewCertificationDtoWithDefaults + +`func NewCertificationDtoWithDefaults() *CertificationDto` + +NewCertificationDtoWithDefaults instantiates a new CertificationDto 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 + +### GetCampaignRef + +`func (o *CertificationDto) GetCampaignRef() CampaignReference` + +GetCampaignRef returns the CampaignRef field if non-nil, zero value otherwise. + +### GetCampaignRefOk + +`func (o *CertificationDto) GetCampaignRefOk() (*CampaignReference, bool)` + +GetCampaignRefOk returns a tuple with the CampaignRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignRef + +`func (o *CertificationDto) SetCampaignRef(v CampaignReference)` + +SetCampaignRef sets CampaignRef field to given value. + + +### GetPhase + +`func (o *CertificationDto) GetPhase() CertificationPhase` + +GetPhase returns the Phase field if non-nil, zero value otherwise. + +### GetPhaseOk + +`func (o *CertificationDto) GetPhaseOk() (*CertificationPhase, bool)` + +GetPhaseOk returns a tuple with the Phase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhase + +`func (o *CertificationDto) SetPhase(v CertificationPhase)` + +SetPhase sets Phase field to given value. + + +### GetDue + +`func (o *CertificationDto) GetDue() SailPointTime` + +GetDue returns the Due field if non-nil, zero value otherwise. + +### GetDueOk + +`func (o *CertificationDto) GetDueOk() (*SailPointTime, bool)` + +GetDueOk returns a tuple with the Due field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDue + +`func (o *CertificationDto) SetDue(v SailPointTime)` + +SetDue sets Due field to given value. + + +### GetSigned + +`func (o *CertificationDto) GetSigned() SailPointTime` + +GetSigned returns the Signed field if non-nil, zero value otherwise. + +### GetSignedOk + +`func (o *CertificationDto) GetSignedOk() (*SailPointTime, bool)` + +GetSignedOk returns a tuple with the Signed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigned + +`func (o *CertificationDto) SetSigned(v SailPointTime)` + +SetSigned sets Signed field to given value. + + +### GetReviewer + +`func (o *CertificationDto) GetReviewer() Reviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CertificationDto) GetReviewerOk() (*Reviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CertificationDto) SetReviewer(v Reviewer)` + +SetReviewer sets Reviewer field to given value. + + +### GetReassignment + +`func (o *CertificationDto) GetReassignment() Reassignment` + +GetReassignment returns the Reassignment field if non-nil, zero value otherwise. + +### GetReassignmentOk + +`func (o *CertificationDto) GetReassignmentOk() (*Reassignment, bool)` + +GetReassignmentOk returns a tuple with the Reassignment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignment + +`func (o *CertificationDto) SetReassignment(v Reassignment)` + +SetReassignment sets Reassignment field to given value. + +### HasReassignment + +`func (o *CertificationDto) HasReassignment() bool` + +HasReassignment returns a boolean if a field has been set. + +### GetHasErrors + +`func (o *CertificationDto) GetHasErrors() bool` + +GetHasErrors returns the HasErrors field if non-nil, zero value otherwise. + +### GetHasErrorsOk + +`func (o *CertificationDto) GetHasErrorsOk() (*bool, bool)` + +GetHasErrorsOk returns a tuple with the HasErrors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasErrors + +`func (o *CertificationDto) SetHasErrors(v bool)` + +SetHasErrors sets HasErrors field to given value. + + +### GetErrorMessage + +`func (o *CertificationDto) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *CertificationDto) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *CertificationDto) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *CertificationDto) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### SetErrorMessageNil + +`func (o *CertificationDto) SetErrorMessageNil(b bool)` + + SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil + +### UnsetErrorMessage +`func (o *CertificationDto) UnsetErrorMessage()` + +UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil +### GetCompleted + +`func (o *CertificationDto) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *CertificationDto) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *CertificationDto) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + + +### GetDecisionsMade + +`func (o *CertificationDto) GetDecisionsMade() int32` + +GetDecisionsMade returns the DecisionsMade field if non-nil, zero value otherwise. + +### GetDecisionsMadeOk + +`func (o *CertificationDto) GetDecisionsMadeOk() (*int32, bool)` + +GetDecisionsMadeOk returns a tuple with the DecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsMade + +`func (o *CertificationDto) SetDecisionsMade(v int32)` + +SetDecisionsMade sets DecisionsMade field to given value. + + +### GetDecisionsTotal + +`func (o *CertificationDto) GetDecisionsTotal() int32` + +GetDecisionsTotal returns the DecisionsTotal field if non-nil, zero value otherwise. + +### GetDecisionsTotalOk + +`func (o *CertificationDto) GetDecisionsTotalOk() (*int32, bool)` + +GetDecisionsTotalOk returns a tuple with the DecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsTotal + +`func (o *CertificationDto) SetDecisionsTotal(v int32)` + +SetDecisionsTotal sets DecisionsTotal field to given value. + + +### GetEntitiesCompleted + +`func (o *CertificationDto) GetEntitiesCompleted() int32` + +GetEntitiesCompleted returns the EntitiesCompleted field if non-nil, zero value otherwise. + +### GetEntitiesCompletedOk + +`func (o *CertificationDto) GetEntitiesCompletedOk() (*int32, bool)` + +GetEntitiesCompletedOk returns a tuple with the EntitiesCompleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitiesCompleted + +`func (o *CertificationDto) SetEntitiesCompleted(v int32)` + +SetEntitiesCompleted sets EntitiesCompleted field to given value. + + +### GetEntitiesTotal + +`func (o *CertificationDto) GetEntitiesTotal() int32` + +GetEntitiesTotal returns the EntitiesTotal field if non-nil, zero value otherwise. + +### GetEntitiesTotalOk + +`func (o *CertificationDto) GetEntitiesTotalOk() (*int32, bool)` + +GetEntitiesTotalOk returns a tuple with the EntitiesTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitiesTotal + +`func (o *CertificationDto) SetEntitiesTotal(v int32)` + +SetEntitiesTotal sets EntitiesTotal field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CertificationPhase.md b/docs/tools/sdk/go/Reference/Beta/Models/CertificationPhase.md new file mode 100644 index 000000000..64b9d2ca7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CertificationPhase.md @@ -0,0 +1,23 @@ +--- +id: beta-certification-phase +title: CertificationPhase +pagination_label: CertificationPhase +sidebar_label: CertificationPhase +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationPhase', 'BetaCertificationPhase'] +slug: /tools/sdk/go/beta/models/certification-phase +tags: ['SDK', 'Software Development Kit', 'CertificationPhase', 'BetaCertificationPhase'] +--- + +# CertificationPhase + +## Enum + + +* `STAGED` (value: `"STAGED"`) + +* `ACTIVE` (value: `"ACTIVE"`) + +* `SIGNED` (value: `"SIGNED"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CertificationReference.md b/docs/tools/sdk/go/Reference/Beta/Models/CertificationReference.md new file mode 100644 index 000000000..c1c2eb5ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CertificationReference.md @@ -0,0 +1,142 @@ +--- +id: beta-certification-reference +title: CertificationReference +pagination_label: CertificationReference +sidebar_label: CertificationReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationReference', 'BetaCertificationReference'] +slug: /tools/sdk/go/beta/models/certification-reference +tags: ['SDK', 'Software Development Kit', 'CertificationReference', 'BetaCertificationReference'] +--- + +# CertificationReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of certification for review. | [optional] +**Id** | Pointer to **string** | ID of certification for review. | [optional] +**Name** | Pointer to **string** | Display name of certification for review. | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] + +## Methods + +### NewCertificationReference + +`func NewCertificationReference() *CertificationReference` + +NewCertificationReference instantiates a new CertificationReference 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 + +### NewCertificationReferenceWithDefaults + +`func NewCertificationReferenceWithDefaults() *CertificationReference` + +NewCertificationReferenceWithDefaults instantiates a new CertificationReference 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 + +### GetType + +`func (o *CertificationReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CertificationReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CertificationReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CertificationReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CertificationReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertificationReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertificationReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CertificationReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CertificationReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CertificationReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CertificationReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CertificationReference) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetReviewer + +`func (o *CertificationReference) GetReviewer() Reviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CertificationReference) GetReviewerOk() (*Reviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CertificationReference) SetReviewer(v Reviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *CertificationReference) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CertificationReferenceDto.md b/docs/tools/sdk/go/Reference/Beta/Models/CertificationReferenceDto.md new file mode 100644 index 000000000..2f39062f9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CertificationReferenceDto.md @@ -0,0 +1,116 @@ +--- +id: beta-certification-reference-dto +title: CertificationReferenceDto +pagination_label: CertificationReferenceDto +sidebar_label: CertificationReferenceDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationReferenceDto', 'BetaCertificationReferenceDto'] +slug: /tools/sdk/go/beta/models/certification-reference-dto +tags: ['SDK', 'Software Development Kit', 'CertificationReferenceDto', 'BetaCertificationReferenceDto'] +--- + +# CertificationReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of certification for review. | [optional] +**Id** | Pointer to **string** | ID of certification for review. | [optional] +**Name** | Pointer to **string** | Display name of certification for review. | [optional] + +## Methods + +### NewCertificationReferenceDto + +`func NewCertificationReferenceDto() *CertificationReferenceDto` + +NewCertificationReferenceDto instantiates a new CertificationReferenceDto 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 + +### NewCertificationReferenceDtoWithDefaults + +`func NewCertificationReferenceDtoWithDefaults() *CertificationReferenceDto` + +NewCertificationReferenceDtoWithDefaults instantiates a new CertificationReferenceDto 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 + +### GetType + +`func (o *CertificationReferenceDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CertificationReferenceDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CertificationReferenceDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CertificationReferenceDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CertificationReferenceDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertificationReferenceDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertificationReferenceDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CertificationReferenceDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CertificationReferenceDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CertificationReferenceDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CertificationReferenceDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CertificationReferenceDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CertificationSignedOff.md b/docs/tools/sdk/go/Reference/Beta/Models/CertificationSignedOff.md new file mode 100644 index 000000000..8b05e7c92 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CertificationSignedOff.md @@ -0,0 +1,59 @@ +--- +id: beta-certification-signed-off +title: CertificationSignedOff +pagination_label: CertificationSignedOff +sidebar_label: CertificationSignedOff +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationSignedOff', 'BetaCertificationSignedOff'] +slug: /tools/sdk/go/beta/models/certification-signed-off +tags: ['SDK', 'Software Development Kit', 'CertificationSignedOff', 'BetaCertificationSignedOff'] +--- + +# CertificationSignedOff + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | + +## Methods + +### NewCertificationSignedOff + +`func NewCertificationSignedOff(certification CertificationSignedOffCertification, ) *CertificationSignedOff` + +NewCertificationSignedOff instantiates a new CertificationSignedOff 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 + +### NewCertificationSignedOffWithDefaults + +`func NewCertificationSignedOffWithDefaults() *CertificationSignedOff` + +NewCertificationSignedOffWithDefaults instantiates a new CertificationSignedOff 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 + +### GetCertification + +`func (o *CertificationSignedOff) GetCertification() CertificationSignedOffCertification` + +GetCertification returns the Certification field if non-nil, zero value otherwise. + +### GetCertificationOk + +`func (o *CertificationSignedOff) GetCertificationOk() (*CertificationSignedOffCertification, bool)` + +GetCertificationOk returns a tuple with the Certification field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertification + +`func (o *CertificationSignedOff) SetCertification(v CertificationSignedOffCertification)` + +SetCertification sets Certification field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CertificationSignedOffCertification.md b/docs/tools/sdk/go/Reference/Beta/Models/CertificationSignedOffCertification.md new file mode 100644 index 000000000..81ba91756 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CertificationSignedOffCertification.md @@ -0,0 +1,430 @@ +--- +id: beta-certification-signed-off-certification +title: CertificationSignedOffCertification +pagination_label: CertificationSignedOffCertification +sidebar_label: CertificationSignedOffCertification +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationSignedOffCertification', 'BetaCertificationSignedOffCertification'] +slug: /tools/sdk/go/beta/models/certification-signed-off-certification +tags: ['SDK', 'Software Development Kit', 'CertificationSignedOffCertification', 'BetaCertificationSignedOffCertification'] +--- + +# CertificationSignedOffCertification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Certification's unique ID. | +**Name** | **string** | Certification's name. | +**Created** | **SailPointTime** | Date and time when the certification was created. | +**Modified** | Pointer to **NullableTime** | Date and time when the certification was last modified. | [optional] +**CampaignRef** | [**CampaignReference**](campaign-reference) | | +**Phase** | [**CertificationPhase**](certification-phase) | | +**Due** | **SailPointTime** | Date and time when the certification is due. | +**Signed** | **SailPointTime** | Date and time when the reviewer signed off on the certification. | +**Reviewer** | [**Reviewer**](reviewer) | | +**Reassignment** | Pointer to [**Reassignment**](reassignment) | | [optional] +**HasErrors** | **bool** | Indicates whether the certification has any errors. | +**ErrorMessage** | Pointer to **NullableString** | Message indicating what the error is. | [optional] +**Completed** | **bool** | Indicates whether all certification decisions have been made. | +**DecisionsMade** | **int32** | Number of approve/revoke/acknowledge decisions the reviewer has made. | +**DecisionsTotal** | **int32** | Total number of approve/revoke/acknowledge decisions for the certification. | +**EntitiesCompleted** | **int32** | Number of entities (identities, access profiles, roles, etc.) that are complete and all decisions have been made for. | +**EntitiesTotal** | **int32** | Total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | + +## Methods + +### NewCertificationSignedOffCertification + +`func NewCertificationSignedOffCertification(id string, name string, created SailPointTime, campaignRef CampaignReference, phase CertificationPhase, due SailPointTime, signed SailPointTime, reviewer Reviewer, hasErrors bool, completed bool, decisionsMade int32, decisionsTotal int32, entitiesCompleted int32, entitiesTotal int32, ) *CertificationSignedOffCertification` + +NewCertificationSignedOffCertification instantiates a new CertificationSignedOffCertification 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 + +### NewCertificationSignedOffCertificationWithDefaults + +`func NewCertificationSignedOffCertificationWithDefaults() *CertificationSignedOffCertification` + +NewCertificationSignedOffCertificationWithDefaults instantiates a new CertificationSignedOffCertification 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 + +### GetId + +`func (o *CertificationSignedOffCertification) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertificationSignedOffCertification) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertificationSignedOffCertification) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CertificationSignedOffCertification) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CertificationSignedOffCertification) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CertificationSignedOffCertification) SetName(v string)` + +SetName sets Name field to given value. + + +### GetCreated + +`func (o *CertificationSignedOffCertification) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CertificationSignedOffCertification) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CertificationSignedOffCertification) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CertificationSignedOffCertification) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CertificationSignedOffCertification) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CertificationSignedOffCertification) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CertificationSignedOffCertification) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CertificationSignedOffCertification) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CertificationSignedOffCertification) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetCampaignRef + +`func (o *CertificationSignedOffCertification) GetCampaignRef() CampaignReference` + +GetCampaignRef returns the CampaignRef field if non-nil, zero value otherwise. + +### GetCampaignRefOk + +`func (o *CertificationSignedOffCertification) GetCampaignRefOk() (*CampaignReference, bool)` + +GetCampaignRefOk returns a tuple with the CampaignRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignRef + +`func (o *CertificationSignedOffCertification) SetCampaignRef(v CampaignReference)` + +SetCampaignRef sets CampaignRef field to given value. + + +### GetPhase + +`func (o *CertificationSignedOffCertification) GetPhase() CertificationPhase` + +GetPhase returns the Phase field if non-nil, zero value otherwise. + +### GetPhaseOk + +`func (o *CertificationSignedOffCertification) GetPhaseOk() (*CertificationPhase, bool)` + +GetPhaseOk returns a tuple with the Phase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhase + +`func (o *CertificationSignedOffCertification) SetPhase(v CertificationPhase)` + +SetPhase sets Phase field to given value. + + +### GetDue + +`func (o *CertificationSignedOffCertification) GetDue() SailPointTime` + +GetDue returns the Due field if non-nil, zero value otherwise. + +### GetDueOk + +`func (o *CertificationSignedOffCertification) GetDueOk() (*SailPointTime, bool)` + +GetDueOk returns a tuple with the Due field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDue + +`func (o *CertificationSignedOffCertification) SetDue(v SailPointTime)` + +SetDue sets Due field to given value. + + +### GetSigned + +`func (o *CertificationSignedOffCertification) GetSigned() SailPointTime` + +GetSigned returns the Signed field if non-nil, zero value otherwise. + +### GetSignedOk + +`func (o *CertificationSignedOffCertification) GetSignedOk() (*SailPointTime, bool)` + +GetSignedOk returns a tuple with the Signed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigned + +`func (o *CertificationSignedOffCertification) SetSigned(v SailPointTime)` + +SetSigned sets Signed field to given value. + + +### GetReviewer + +`func (o *CertificationSignedOffCertification) GetReviewer() Reviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CertificationSignedOffCertification) GetReviewerOk() (*Reviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CertificationSignedOffCertification) SetReviewer(v Reviewer)` + +SetReviewer sets Reviewer field to given value. + + +### GetReassignment + +`func (o *CertificationSignedOffCertification) GetReassignment() Reassignment` + +GetReassignment returns the Reassignment field if non-nil, zero value otherwise. + +### GetReassignmentOk + +`func (o *CertificationSignedOffCertification) GetReassignmentOk() (*Reassignment, bool)` + +GetReassignmentOk returns a tuple with the Reassignment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignment + +`func (o *CertificationSignedOffCertification) SetReassignment(v Reassignment)` + +SetReassignment sets Reassignment field to given value. + +### HasReassignment + +`func (o *CertificationSignedOffCertification) HasReassignment() bool` + +HasReassignment returns a boolean if a field has been set. + +### GetHasErrors + +`func (o *CertificationSignedOffCertification) GetHasErrors() bool` + +GetHasErrors returns the HasErrors field if non-nil, zero value otherwise. + +### GetHasErrorsOk + +`func (o *CertificationSignedOffCertification) GetHasErrorsOk() (*bool, bool)` + +GetHasErrorsOk returns a tuple with the HasErrors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasErrors + +`func (o *CertificationSignedOffCertification) SetHasErrors(v bool)` + +SetHasErrors sets HasErrors field to given value. + + +### GetErrorMessage + +`func (o *CertificationSignedOffCertification) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *CertificationSignedOffCertification) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *CertificationSignedOffCertification) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *CertificationSignedOffCertification) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### SetErrorMessageNil + +`func (o *CertificationSignedOffCertification) SetErrorMessageNil(b bool)` + + SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil + +### UnsetErrorMessage +`func (o *CertificationSignedOffCertification) UnsetErrorMessage()` + +UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil +### GetCompleted + +`func (o *CertificationSignedOffCertification) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *CertificationSignedOffCertification) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *CertificationSignedOffCertification) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + + +### GetDecisionsMade + +`func (o *CertificationSignedOffCertification) GetDecisionsMade() int32` + +GetDecisionsMade returns the DecisionsMade field if non-nil, zero value otherwise. + +### GetDecisionsMadeOk + +`func (o *CertificationSignedOffCertification) GetDecisionsMadeOk() (*int32, bool)` + +GetDecisionsMadeOk returns a tuple with the DecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsMade + +`func (o *CertificationSignedOffCertification) SetDecisionsMade(v int32)` + +SetDecisionsMade sets DecisionsMade field to given value. + + +### GetDecisionsTotal + +`func (o *CertificationSignedOffCertification) GetDecisionsTotal() int32` + +GetDecisionsTotal returns the DecisionsTotal field if non-nil, zero value otherwise. + +### GetDecisionsTotalOk + +`func (o *CertificationSignedOffCertification) GetDecisionsTotalOk() (*int32, bool)` + +GetDecisionsTotalOk returns a tuple with the DecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsTotal + +`func (o *CertificationSignedOffCertification) SetDecisionsTotal(v int32)` + +SetDecisionsTotal sets DecisionsTotal field to given value. + + +### GetEntitiesCompleted + +`func (o *CertificationSignedOffCertification) GetEntitiesCompleted() int32` + +GetEntitiesCompleted returns the EntitiesCompleted field if non-nil, zero value otherwise. + +### GetEntitiesCompletedOk + +`func (o *CertificationSignedOffCertification) GetEntitiesCompletedOk() (*int32, bool)` + +GetEntitiesCompletedOk returns a tuple with the EntitiesCompleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitiesCompleted + +`func (o *CertificationSignedOffCertification) SetEntitiesCompleted(v int32)` + +SetEntitiesCompleted sets EntitiesCompleted field to given value. + + +### GetEntitiesTotal + +`func (o *CertificationSignedOffCertification) GetEntitiesTotal() int32` + +GetEntitiesTotal returns the EntitiesTotal field if non-nil, zero value otherwise. + +### GetEntitiesTotalOk + +`func (o *CertificationSignedOffCertification) GetEntitiesTotalOk() (*int32, bool)` + +GetEntitiesTotalOk returns a tuple with the EntitiesTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitiesTotal + +`func (o *CertificationSignedOffCertification) SetEntitiesTotal(v int32)` + +SetEntitiesTotal sets EntitiesTotal field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CertificationTask.md b/docs/tools/sdk/go/Reference/Beta/Models/CertificationTask.md new file mode 100644 index 000000000..edbd27c2f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CertificationTask.md @@ -0,0 +1,220 @@ +--- +id: beta-certification-task +title: CertificationTask +pagination_label: CertificationTask +sidebar_label: CertificationTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationTask', 'BetaCertificationTask'] +slug: /tools/sdk/go/beta/models/certification-task +tags: ['SDK', 'Software Development Kit', 'CertificationTask', 'BetaCertificationTask'] +--- + +# CertificationTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the certification task. | [optional] +**Type** | Pointer to **string** | The type of the certification task. More values may be added in the future. | [optional] +**TargetType** | Pointer to **string** | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [optional] +**TargetId** | Pointer to **string** | The ID of the item being operated on by this task. | [optional] +**Status** | Pointer to **string** | The status of the task. | [optional] +**Errors** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] +**Created** | Pointer to **SailPointTime** | The date and time on which this task was created. | [optional] + +## Methods + +### NewCertificationTask + +`func NewCertificationTask() *CertificationTask` + +NewCertificationTask instantiates a new CertificationTask 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 + +### NewCertificationTaskWithDefaults + +`func NewCertificationTaskWithDefaults() *CertificationTask` + +NewCertificationTaskWithDefaults instantiates a new CertificationTask 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 + +### GetId + +`func (o *CertificationTask) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertificationTask) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertificationTask) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CertificationTask) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CertificationTask) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CertificationTask) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CertificationTask) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CertificationTask) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetTargetType + +`func (o *CertificationTask) GetTargetType() string` + +GetTargetType returns the TargetType field if non-nil, zero value otherwise. + +### GetTargetTypeOk + +`func (o *CertificationTask) GetTargetTypeOk() (*string, bool)` + +GetTargetTypeOk returns a tuple with the TargetType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetType + +`func (o *CertificationTask) SetTargetType(v string)` + +SetTargetType sets TargetType field to given value. + +### HasTargetType + +`func (o *CertificationTask) HasTargetType() bool` + +HasTargetType returns a boolean if a field has been set. + +### GetTargetId + +`func (o *CertificationTask) GetTargetId() string` + +GetTargetId returns the TargetId field if non-nil, zero value otherwise. + +### GetTargetIdOk + +`func (o *CertificationTask) GetTargetIdOk() (*string, bool)` + +GetTargetIdOk returns a tuple with the TargetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetId + +`func (o *CertificationTask) SetTargetId(v string)` + +SetTargetId sets TargetId field to given value. + +### HasTargetId + +`func (o *CertificationTask) HasTargetId() bool` + +HasTargetId returns a boolean if a field has been set. + +### GetStatus + +`func (o *CertificationTask) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CertificationTask) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CertificationTask) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CertificationTask) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetErrors + +`func (o *CertificationTask) GetErrors() []ErrorMessageDto` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *CertificationTask) GetErrorsOk() (*[]ErrorMessageDto, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *CertificationTask) SetErrors(v []ErrorMessageDto)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *CertificationTask) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### GetCreated + +`func (o *CertificationTask) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CertificationTask) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CertificationTask) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CertificationTask) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CertifierResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/CertifierResponse.md new file mode 100644 index 000000000..ff3af736b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CertifierResponse.md @@ -0,0 +1,90 @@ +--- +id: beta-certifier-response +title: CertifierResponse +pagination_label: CertifierResponse +sidebar_label: CertifierResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertifierResponse', 'BetaCertifierResponse'] +slug: /tools/sdk/go/beta/models/certifier-response +tags: ['SDK', 'Software Development Kit', 'CertifierResponse', 'BetaCertifierResponse'] +--- + +# CertifierResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the id of the certifier | [optional] +**DisplayName** | Pointer to **string** | the name of the certifier | [optional] + +## Methods + +### NewCertifierResponse + +`func NewCertifierResponse() *CertifierResponse` + +NewCertifierResponse instantiates a new CertifierResponse 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 + +### NewCertifierResponseWithDefaults + +`func NewCertifierResponseWithDefaults() *CertifierResponse` + +NewCertifierResponseWithDefaults instantiates a new CertifierResponse 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 + +### GetId + +`func (o *CertifierResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertifierResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertifierResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CertifierResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *CertifierResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *CertifierResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *CertifierResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *CertifierResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Children.md b/docs/tools/sdk/go/Reference/Beta/Models/Children.md new file mode 100644 index 000000000..ea17498c6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Children.md @@ -0,0 +1,162 @@ +--- +id: beta-children +title: Children +pagination_label: Children +sidebar_label: Children +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Children', 'BetaChildren'] +slug: /tools/sdk/go/beta/models/children +tags: ['SDK', 'Software Development Kit', 'Children', 'BetaChildren'] +--- + +# Children + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **string** | | [optional] +**Attribute** | Pointer to **string** | | [optional] +**Value** | Pointer to [**NullableValue**](value) | | [optional] +**Children** | Pointer to **NullableString** | | [optional] + +## Methods + +### NewChildren + +`func NewChildren() *Children` + +NewChildren instantiates a new Children 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 + +### NewChildrenWithDefaults + +`func NewChildrenWithDefaults() *Children` + +NewChildrenWithDefaults instantiates a new Children 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 + +### GetOperator + +`func (o *Children) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *Children) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *Children) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *Children) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetAttribute + +`func (o *Children) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *Children) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *Children) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *Children) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *Children) GetValue() Value` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Children) GetValueOk() (*Value, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Children) SetValue(v Value)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Children) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *Children) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *Children) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *Children) GetChildren() string` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *Children) GetChildrenOk() (*string, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *Children) SetChildren(v string)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *Children) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *Children) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *Children) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ClientLogConfiguration.md b/docs/tools/sdk/go/Reference/Beta/Models/ClientLogConfiguration.md new file mode 100644 index 000000000..242bf369a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ClientLogConfiguration.md @@ -0,0 +1,158 @@ +--- +id: beta-client-log-configuration +title: ClientLogConfiguration +pagination_label: ClientLogConfiguration +sidebar_label: ClientLogConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClientLogConfiguration', 'BetaClientLogConfiguration'] +slug: /tools/sdk/go/beta/models/client-log-configuration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfiguration', 'BetaClientLogConfiguration'] +--- + +# ClientLogConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **string** | Log configuration's client ID | [optional] +**DurationMinutes** | **int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults | +**Expiration** | Pointer to **SailPointTime** | Expiration date-time of the log configuration request | [optional] +**RootLevel** | [**StandardLevel**](standard-level) | | +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Methods + +### NewClientLogConfiguration + +`func NewClientLogConfiguration(durationMinutes int32, rootLevel StandardLevel, ) *ClientLogConfiguration` + +NewClientLogConfiguration instantiates a new ClientLogConfiguration 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 + +### NewClientLogConfigurationWithDefaults + +`func NewClientLogConfigurationWithDefaults() *ClientLogConfiguration` + +NewClientLogConfigurationWithDefaults instantiates a new ClientLogConfiguration 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 + +### GetClientId + +`func (o *ClientLogConfiguration) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ClientLogConfiguration) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ClientLogConfiguration) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + +### HasClientId + +`func (o *ClientLogConfiguration) HasClientId() bool` + +HasClientId returns a boolean if a field has been set. + +### GetDurationMinutes + +`func (o *ClientLogConfiguration) GetDurationMinutes() int32` + +GetDurationMinutes returns the DurationMinutes field if non-nil, zero value otherwise. + +### GetDurationMinutesOk + +`func (o *ClientLogConfiguration) GetDurationMinutesOk() (*int32, bool)` + +GetDurationMinutesOk returns a tuple with the DurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDurationMinutes + +`func (o *ClientLogConfiguration) SetDurationMinutes(v int32)` + +SetDurationMinutes sets DurationMinutes field to given value. + + +### GetExpiration + +`func (o *ClientLogConfiguration) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *ClientLogConfiguration) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *ClientLogConfiguration) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *ClientLogConfiguration) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + +### GetRootLevel + +`func (o *ClientLogConfiguration) GetRootLevel() StandardLevel` + +GetRootLevel returns the RootLevel field if non-nil, zero value otherwise. + +### GetRootLevelOk + +`func (o *ClientLogConfiguration) GetRootLevelOk() (*StandardLevel, bool)` + +GetRootLevelOk returns a tuple with the RootLevel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootLevel + +`func (o *ClientLogConfiguration) SetRootLevel(v StandardLevel)` + +SetRootLevel sets RootLevel field to given value. + + +### GetLogLevels + +`func (o *ClientLogConfiguration) GetLogLevels() map[string]StandardLevel` + +GetLogLevels returns the LogLevels field if non-nil, zero value otherwise. + +### GetLogLevelsOk + +`func (o *ClientLogConfiguration) GetLogLevelsOk() (*map[string]StandardLevel, bool)` + +GetLogLevelsOk returns a tuple with the LogLevels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogLevels + +`func (o *ClientLogConfiguration) SetLogLevels(v map[string]StandardLevel)` + +SetLogLevels sets LogLevels field to given value. + +### HasLogLevels + +`func (o *ClientLogConfiguration) HasLogLevels() bool` + +HasLogLevels returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ClientType.md b/docs/tools/sdk/go/Reference/Beta/Models/ClientType.md new file mode 100644 index 000000000..cb261135d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ClientType.md @@ -0,0 +1,21 @@ +--- +id: beta-client-type +title: ClientType +pagination_label: ClientType +sidebar_label: ClientType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClientType', 'BetaClientType'] +slug: /tools/sdk/go/beta/models/client-type +tags: ['SDK', 'Software Development Kit', 'ClientType', 'BetaClientType'] +--- + +# ClientType + +## Enum + + +* `CONFIDENTIAL` (value: `"CONFIDENTIAL"`) + +* `PUBLIC` (value: `"PUBLIC"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CloseAccessRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/CloseAccessRequest.md new file mode 100644 index 000000000..6508c8960 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CloseAccessRequest.md @@ -0,0 +1,137 @@ +--- +id: beta-close-access-request +title: CloseAccessRequest +pagination_label: CloseAccessRequest +sidebar_label: CloseAccessRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CloseAccessRequest', 'BetaCloseAccessRequest'] +slug: /tools/sdk/go/beta/models/close-access-request +tags: ['SDK', 'Software Development Kit', 'CloseAccessRequest', 'BetaCloseAccessRequest'] +--- + +# CloseAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestIds** | **[]string** | Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request. | +**Message** | Pointer to **string** | Reason for closing the access request. Displayed under Warnings in IdentityNow. | [optional] [default to "The IdentityNow Administrator manually closed this request."] +**ExecutionStatus** | Pointer to **string** | The request's provisioning status. Displayed as Stage in IdentityNow. | [optional] [default to "Terminated"] +**CompletionStatus** | Pointer to **string** | The request's overall status. Displayed as Status in IdentityNow. | [optional] [default to "Failure"] + +## Methods + +### NewCloseAccessRequest + +`func NewCloseAccessRequest(accessRequestIds []string, ) *CloseAccessRequest` + +NewCloseAccessRequest instantiates a new CloseAccessRequest 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 + +### NewCloseAccessRequestWithDefaults + +`func NewCloseAccessRequestWithDefaults() *CloseAccessRequest` + +NewCloseAccessRequestWithDefaults instantiates a new CloseAccessRequest 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 + +### GetAccessRequestIds + +`func (o *CloseAccessRequest) GetAccessRequestIds() []string` + +GetAccessRequestIds returns the AccessRequestIds field if non-nil, zero value otherwise. + +### GetAccessRequestIdsOk + +`func (o *CloseAccessRequest) GetAccessRequestIdsOk() (*[]string, bool)` + +GetAccessRequestIdsOk returns a tuple with the AccessRequestIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestIds + +`func (o *CloseAccessRequest) SetAccessRequestIds(v []string)` + +SetAccessRequestIds sets AccessRequestIds field to given value. + + +### GetMessage + +`func (o *CloseAccessRequest) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *CloseAccessRequest) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *CloseAccessRequest) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *CloseAccessRequest) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetExecutionStatus + +`func (o *CloseAccessRequest) GetExecutionStatus() string` + +GetExecutionStatus returns the ExecutionStatus field if non-nil, zero value otherwise. + +### GetExecutionStatusOk + +`func (o *CloseAccessRequest) GetExecutionStatusOk() (*string, bool)` + +GetExecutionStatusOk returns a tuple with the ExecutionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExecutionStatus + +`func (o *CloseAccessRequest) SetExecutionStatus(v string)` + +SetExecutionStatus sets ExecutionStatus field to given value. + +### HasExecutionStatus + +`func (o *CloseAccessRequest) HasExecutionStatus() bool` + +HasExecutionStatus returns a boolean if a field has been set. + +### GetCompletionStatus + +`func (o *CloseAccessRequest) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *CloseAccessRequest) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *CloseAccessRequest) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *CloseAccessRequest) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Comment.md b/docs/tools/sdk/go/Reference/Beta/Models/Comment.md new file mode 100644 index 000000000..e73014b77 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Comment.md @@ -0,0 +1,142 @@ +--- +id: beta-comment +title: Comment +pagination_label: Comment +sidebar_label: Comment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Comment', 'BetaComment'] +slug: /tools/sdk/go/beta/models/comment +tags: ['SDK', 'Software Development Kit', 'Comment', 'BetaComment'] +--- + +# Comment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommenterId** | Pointer to **string** | Id of the identity making the comment | [optional] +**CommenterName** | Pointer to **string** | Human-readable display name of the identity making the comment | [optional] +**Body** | Pointer to **string** | Content of the comment | [optional] +**Date** | Pointer to **SailPointTime** | Date and time comment was made | [optional] + +## Methods + +### NewComment + +`func NewComment() *Comment` + +NewComment instantiates a new Comment 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 + +### NewCommentWithDefaults + +`func NewCommentWithDefaults() *Comment` + +NewCommentWithDefaults instantiates a new Comment 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 + +### GetCommenterId + +`func (o *Comment) GetCommenterId() string` + +GetCommenterId returns the CommenterId field if non-nil, zero value otherwise. + +### GetCommenterIdOk + +`func (o *Comment) GetCommenterIdOk() (*string, bool)` + +GetCommenterIdOk returns a tuple with the CommenterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommenterId + +`func (o *Comment) SetCommenterId(v string)` + +SetCommenterId sets CommenterId field to given value. + +### HasCommenterId + +`func (o *Comment) HasCommenterId() bool` + +HasCommenterId returns a boolean if a field has been set. + +### GetCommenterName + +`func (o *Comment) GetCommenterName() string` + +GetCommenterName returns the CommenterName field if non-nil, zero value otherwise. + +### GetCommenterNameOk + +`func (o *Comment) GetCommenterNameOk() (*string, bool)` + +GetCommenterNameOk returns a tuple with the CommenterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommenterName + +`func (o *Comment) SetCommenterName(v string)` + +SetCommenterName sets CommenterName field to given value. + +### HasCommenterName + +`func (o *Comment) HasCommenterName() bool` + +HasCommenterName returns a boolean if a field has been set. + +### GetBody + +`func (o *Comment) GetBody() string` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *Comment) GetBodyOk() (*string, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBody + +`func (o *Comment) SetBody(v string)` + +SetBody sets Body field to given value. + +### HasBody + +`func (o *Comment) HasBody() bool` + +HasBody returns a boolean if a field has been set. + +### GetDate + +`func (o *Comment) GetDate() SailPointTime` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *Comment) GetDateOk() (*SailPointTime, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *Comment) SetDate(v SailPointTime)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *Comment) HasDate() bool` + +HasDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CommentDto.md b/docs/tools/sdk/go/Reference/Beta/Models/CommentDto.md new file mode 100644 index 000000000..1abb9b084 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CommentDto.md @@ -0,0 +1,126 @@ +--- +id: beta-comment-dto +title: CommentDto +pagination_label: CommentDto +sidebar_label: CommentDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommentDto', 'BetaCommentDto'] +slug: /tools/sdk/go/beta/models/comment-dto +tags: ['SDK', 'Software Development Kit', 'CommentDto', 'BetaCommentDto'] +--- + +# CommentDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **NullableString** | Comment content. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] +**Created** | Pointer to **SailPointTime** | Date and time comment was created. | [optional] + +## Methods + +### NewCommentDto + +`func NewCommentDto() *CommentDto` + +NewCommentDto instantiates a new CommentDto 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 + +### NewCommentDtoWithDefaults + +`func NewCommentDtoWithDefaults() *CommentDto` + +NewCommentDtoWithDefaults instantiates a new CommentDto 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 + +### GetComment + +`func (o *CommentDto) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CommentDto) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CommentDto) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CommentDto) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *CommentDto) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *CommentDto) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetAuthor + +`func (o *CommentDto) GetAuthor() CommentDtoAuthor` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *CommentDto) GetAuthorOk() (*CommentDtoAuthor, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *CommentDto) SetAuthor(v CommentDtoAuthor)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *CommentDto) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + +### GetCreated + +`func (o *CommentDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CommentDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CommentDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CommentDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CommentDto1.md b/docs/tools/sdk/go/Reference/Beta/Models/CommentDto1.md new file mode 100644 index 000000000..224a9a975 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CommentDto1.md @@ -0,0 +1,126 @@ +--- +id: beta-comment-dto1 +title: CommentDto1 +pagination_label: CommentDto1 +sidebar_label: CommentDto1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommentDto1', 'BetaCommentDto1'] +slug: /tools/sdk/go/beta/models/comment-dto1 +tags: ['SDK', 'Software Development Kit', 'CommentDto1', 'BetaCommentDto1'] +--- + +# CommentDto1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **NullableString** | Comment content. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDto1Author**](comment-dto1-author) | | [optional] + +## Methods + +### NewCommentDto1 + +`func NewCommentDto1() *CommentDto1` + +NewCommentDto1 instantiates a new CommentDto1 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 + +### NewCommentDto1WithDefaults + +`func NewCommentDto1WithDefaults() *CommentDto1` + +NewCommentDto1WithDefaults instantiates a new CommentDto1 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 + +### GetComment + +`func (o *CommentDto1) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CommentDto1) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CommentDto1) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CommentDto1) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *CommentDto1) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *CommentDto1) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetCreated + +`func (o *CommentDto1) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CommentDto1) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CommentDto1) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CommentDto1) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetAuthor + +`func (o *CommentDto1) GetAuthor() CommentDto1Author` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *CommentDto1) GetAuthorOk() (*CommentDto1Author, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *CommentDto1) SetAuthor(v CommentDto1Author)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *CommentDto1) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CommentDto1Author.md b/docs/tools/sdk/go/Reference/Beta/Models/CommentDto1Author.md new file mode 100644 index 000000000..2e3ee60ca --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CommentDto1Author.md @@ -0,0 +1,116 @@ +--- +id: beta-comment-dto1-author +title: CommentDto1Author +pagination_label: CommentDto1Author +sidebar_label: CommentDto1Author +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommentDto1Author', 'BetaCommentDto1Author'] +slug: /tools/sdk/go/beta/models/comment-dto1-author +tags: ['SDK', 'Software Development Kit', 'CommentDto1Author', 'BetaCommentDto1Author'] +--- + +# CommentDto1Author + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of object | [optional] +**Id** | Pointer to **string** | The unique ID of the object | [optional] +**Name** | Pointer to **string** | The display name of the object | [optional] + +## Methods + +### NewCommentDto1Author + +`func NewCommentDto1Author() *CommentDto1Author` + +NewCommentDto1Author instantiates a new CommentDto1Author 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 + +### NewCommentDto1AuthorWithDefaults + +`func NewCommentDto1AuthorWithDefaults() *CommentDto1Author` + +NewCommentDto1AuthorWithDefaults instantiates a new CommentDto1Author 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 + +### GetType + +`func (o *CommentDto1Author) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CommentDto1Author) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CommentDto1Author) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CommentDto1Author) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CommentDto1Author) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CommentDto1Author) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CommentDto1Author) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CommentDto1Author) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CommentDto1Author) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CommentDto1Author) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CommentDto1Author) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CommentDto1Author) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CommentDtoAuthor.md b/docs/tools/sdk/go/Reference/Beta/Models/CommentDtoAuthor.md new file mode 100644 index 000000000..be1c23b19 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CommentDtoAuthor.md @@ -0,0 +1,116 @@ +--- +id: beta-comment-dto-author +title: CommentDtoAuthor +pagination_label: CommentDtoAuthor +sidebar_label: CommentDtoAuthor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommentDtoAuthor', 'BetaCommentDtoAuthor'] +slug: /tools/sdk/go/beta/models/comment-dto-author +tags: ['SDK', 'Software Development Kit', 'CommentDtoAuthor', 'BetaCommentDtoAuthor'] +--- + +# CommentDtoAuthor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of the commenting identity. | [optional] +**Id** | Pointer to **string** | ID of the commenting identity. | [optional] +**Name** | Pointer to **string** | Display name of the commenting identity. | [optional] + +## Methods + +### NewCommentDtoAuthor + +`func NewCommentDtoAuthor() *CommentDtoAuthor` + +NewCommentDtoAuthor instantiates a new CommentDtoAuthor 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 + +### NewCommentDtoAuthorWithDefaults + +`func NewCommentDtoAuthorWithDefaults() *CommentDtoAuthor` + +NewCommentDtoAuthorWithDefaults instantiates a new CommentDtoAuthor 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 + +### GetType + +`func (o *CommentDtoAuthor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CommentDtoAuthor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CommentDtoAuthor) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CommentDtoAuthor) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CommentDtoAuthor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CommentDtoAuthor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CommentDtoAuthor) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CommentDtoAuthor) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CommentDtoAuthor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CommentDtoAuthor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CommentDtoAuthor) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CommentDtoAuthor) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessIDStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessIDStatus.md new file mode 100644 index 000000000..9cce57fa0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessIDStatus.md @@ -0,0 +1,90 @@ +--- +id: beta-common-access-id-status +title: CommonAccessIDStatus +pagination_label: CommonAccessIDStatus +sidebar_label: CommonAccessIDStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessIDStatus', 'BetaCommonAccessIDStatus'] +slug: /tools/sdk/go/beta/models/common-access-id-status +tags: ['SDK', 'Software Development Kit', 'CommonAccessIDStatus', 'BetaCommonAccessIDStatus'] +--- + +# CommonAccessIDStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConfirmedIds** | Pointer to **[]string** | List of confirmed common access ids. | [optional] +**DeniedIds** | Pointer to **[]string** | List of denied common access ids. | [optional] + +## Methods + +### NewCommonAccessIDStatus + +`func NewCommonAccessIDStatus() *CommonAccessIDStatus` + +NewCommonAccessIDStatus instantiates a new CommonAccessIDStatus 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 + +### NewCommonAccessIDStatusWithDefaults + +`func NewCommonAccessIDStatusWithDefaults() *CommonAccessIDStatus` + +NewCommonAccessIDStatusWithDefaults instantiates a new CommonAccessIDStatus 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 + +### GetConfirmedIds + +`func (o *CommonAccessIDStatus) GetConfirmedIds() []string` + +GetConfirmedIds returns the ConfirmedIds field if non-nil, zero value otherwise. + +### GetConfirmedIdsOk + +`func (o *CommonAccessIDStatus) GetConfirmedIdsOk() (*[]string, bool)` + +GetConfirmedIdsOk returns a tuple with the ConfirmedIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfirmedIds + +`func (o *CommonAccessIDStatus) SetConfirmedIds(v []string)` + +SetConfirmedIds sets ConfirmedIds field to given value. + +### HasConfirmedIds + +`func (o *CommonAccessIDStatus) HasConfirmedIds() bool` + +HasConfirmedIds returns a boolean if a field has been set. + +### GetDeniedIds + +`func (o *CommonAccessIDStatus) GetDeniedIds() []string` + +GetDeniedIds returns the DeniedIds field if non-nil, zero value otherwise. + +### GetDeniedIdsOk + +`func (o *CommonAccessIDStatus) GetDeniedIdsOk() (*[]string, bool)` + +GetDeniedIdsOk returns a tuple with the DeniedIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeniedIds + +`func (o *CommonAccessIDStatus) SetDeniedIds(v []string)` + +SetDeniedIds sets DeniedIds field to given value. + +### HasDeniedIds + +`func (o *CommonAccessIDStatus) HasDeniedIds() bool` + +HasDeniedIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessItemAccess.md b/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessItemAccess.md new file mode 100644 index 000000000..afa9f2ef4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessItemAccess.md @@ -0,0 +1,204 @@ +--- +id: beta-common-access-item-access +title: CommonAccessItemAccess +pagination_label: CommonAccessItemAccess +sidebar_label: CommonAccessItemAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessItemAccess', 'BetaCommonAccessItemAccess'] +slug: /tools/sdk/go/beta/models/common-access-item-access +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemAccess', 'BetaCommonAccessItemAccess'] +--- + +# CommonAccessItemAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Common access ID | [optional] +**Type** | Pointer to [**CommonAccessType**](common-access-type) | | [optional] +**Name** | Pointer to **string** | Common access name | [optional] +**Description** | Pointer to **NullableString** | Common access description | [optional] +**OwnerName** | Pointer to **string** | Common access owner name | [optional] +**OwnerId** | Pointer to **string** | Common access owner ID | [optional] + +## Methods + +### NewCommonAccessItemAccess + +`func NewCommonAccessItemAccess() *CommonAccessItemAccess` + +NewCommonAccessItemAccess instantiates a new CommonAccessItemAccess 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 + +### NewCommonAccessItemAccessWithDefaults + +`func NewCommonAccessItemAccessWithDefaults() *CommonAccessItemAccess` + +NewCommonAccessItemAccessWithDefaults instantiates a new CommonAccessItemAccess 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 + +### GetId + +`func (o *CommonAccessItemAccess) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CommonAccessItemAccess) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CommonAccessItemAccess) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CommonAccessItemAccess) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CommonAccessItemAccess) GetType() CommonAccessType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CommonAccessItemAccess) GetTypeOk() (*CommonAccessType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CommonAccessItemAccess) SetType(v CommonAccessType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CommonAccessItemAccess) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *CommonAccessItemAccess) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CommonAccessItemAccess) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CommonAccessItemAccess) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CommonAccessItemAccess) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *CommonAccessItemAccess) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CommonAccessItemAccess) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CommonAccessItemAccess) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CommonAccessItemAccess) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *CommonAccessItemAccess) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CommonAccessItemAccess) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwnerName + +`func (o *CommonAccessItemAccess) GetOwnerName() string` + +GetOwnerName returns the OwnerName field if non-nil, zero value otherwise. + +### GetOwnerNameOk + +`func (o *CommonAccessItemAccess) GetOwnerNameOk() (*string, bool)` + +GetOwnerNameOk returns a tuple with the OwnerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerName + +`func (o *CommonAccessItemAccess) SetOwnerName(v string)` + +SetOwnerName sets OwnerName field to given value. + +### HasOwnerName + +`func (o *CommonAccessItemAccess) HasOwnerName() bool` + +HasOwnerName returns a boolean if a field has been set. + +### GetOwnerId + +`func (o *CommonAccessItemAccess) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *CommonAccessItemAccess) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *CommonAccessItemAccess) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *CommonAccessItemAccess) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessItemRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessItemRequest.md new file mode 100644 index 000000000..77a81d69f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessItemRequest.md @@ -0,0 +1,90 @@ +--- +id: beta-common-access-item-request +title: CommonAccessItemRequest +pagination_label: CommonAccessItemRequest +sidebar_label: CommonAccessItemRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessItemRequest', 'BetaCommonAccessItemRequest'] +slug: /tools/sdk/go/beta/models/common-access-item-request +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemRequest', 'BetaCommonAccessItemRequest'] +--- + +# CommonAccessItemRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**Status** | Pointer to [**CommonAccessItemState**](common-access-item-state) | | [optional] + +## Methods + +### NewCommonAccessItemRequest + +`func NewCommonAccessItemRequest() *CommonAccessItemRequest` + +NewCommonAccessItemRequest instantiates a new CommonAccessItemRequest 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 + +### NewCommonAccessItemRequestWithDefaults + +`func NewCommonAccessItemRequestWithDefaults() *CommonAccessItemRequest` + +NewCommonAccessItemRequestWithDefaults instantiates a new CommonAccessItemRequest 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 + +### GetAccess + +`func (o *CommonAccessItemRequest) GetAccess() CommonAccessItemAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *CommonAccessItemRequest) GetAccessOk() (*CommonAccessItemAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *CommonAccessItemRequest) SetAccess(v CommonAccessItemAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *CommonAccessItemRequest) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetStatus + +`func (o *CommonAccessItemRequest) GetStatus() CommonAccessItemState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CommonAccessItemRequest) GetStatusOk() (*CommonAccessItemState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CommonAccessItemRequest) SetStatus(v CommonAccessItemState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CommonAccessItemRequest) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessItemResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessItemResponse.md new file mode 100644 index 000000000..bab6c6330 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessItemResponse.md @@ -0,0 +1,220 @@ +--- +id: beta-common-access-item-response +title: CommonAccessItemResponse +pagination_label: CommonAccessItemResponse +sidebar_label: CommonAccessItemResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessItemResponse', 'BetaCommonAccessItemResponse'] +slug: /tools/sdk/go/beta/models/common-access-item-response +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemResponse', 'BetaCommonAccessItemResponse'] +--- + +# CommonAccessItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Common Access Item ID | [optional] +**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**Status** | Pointer to [**CommonAccessItemState**](common-access-item-state) | | [optional] +**LastUpdated** | Pointer to **string** | | [optional] +**ReviewedByUser** | Pointer to **bool** | | [optional] +**LastReviewed** | Pointer to **string** | | [optional] +**CreatedByUser** | Pointer to **string** | | [optional] + +## Methods + +### NewCommonAccessItemResponse + +`func NewCommonAccessItemResponse() *CommonAccessItemResponse` + +NewCommonAccessItemResponse instantiates a new CommonAccessItemResponse 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 + +### NewCommonAccessItemResponseWithDefaults + +`func NewCommonAccessItemResponseWithDefaults() *CommonAccessItemResponse` + +NewCommonAccessItemResponseWithDefaults instantiates a new CommonAccessItemResponse 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 + +### GetId + +`func (o *CommonAccessItemResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CommonAccessItemResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CommonAccessItemResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CommonAccessItemResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccess + +`func (o *CommonAccessItemResponse) GetAccess() CommonAccessItemAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *CommonAccessItemResponse) GetAccessOk() (*CommonAccessItemAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *CommonAccessItemResponse) SetAccess(v CommonAccessItemAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *CommonAccessItemResponse) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetStatus + +`func (o *CommonAccessItemResponse) GetStatus() CommonAccessItemState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CommonAccessItemResponse) GetStatusOk() (*CommonAccessItemState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CommonAccessItemResponse) SetStatus(v CommonAccessItemState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CommonAccessItemResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetLastUpdated + +`func (o *CommonAccessItemResponse) GetLastUpdated() string` + +GetLastUpdated returns the LastUpdated field if non-nil, zero value otherwise. + +### GetLastUpdatedOk + +`func (o *CommonAccessItemResponse) GetLastUpdatedOk() (*string, bool)` + +GetLastUpdatedOk returns a tuple with the LastUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdated + +`func (o *CommonAccessItemResponse) SetLastUpdated(v string)` + +SetLastUpdated sets LastUpdated field to given value. + +### HasLastUpdated + +`func (o *CommonAccessItemResponse) HasLastUpdated() bool` + +HasLastUpdated returns a boolean if a field has been set. + +### GetReviewedByUser + +`func (o *CommonAccessItemResponse) GetReviewedByUser() bool` + +GetReviewedByUser returns the ReviewedByUser field if non-nil, zero value otherwise. + +### GetReviewedByUserOk + +`func (o *CommonAccessItemResponse) GetReviewedByUserOk() (*bool, bool)` + +GetReviewedByUserOk returns a tuple with the ReviewedByUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewedByUser + +`func (o *CommonAccessItemResponse) SetReviewedByUser(v bool)` + +SetReviewedByUser sets ReviewedByUser field to given value. + +### HasReviewedByUser + +`func (o *CommonAccessItemResponse) HasReviewedByUser() bool` + +HasReviewedByUser returns a boolean if a field has been set. + +### GetLastReviewed + +`func (o *CommonAccessItemResponse) GetLastReviewed() string` + +GetLastReviewed returns the LastReviewed field if non-nil, zero value otherwise. + +### GetLastReviewedOk + +`func (o *CommonAccessItemResponse) GetLastReviewedOk() (*string, bool)` + +GetLastReviewedOk returns a tuple with the LastReviewed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastReviewed + +`func (o *CommonAccessItemResponse) SetLastReviewed(v string)` + +SetLastReviewed sets LastReviewed field to given value. + +### HasLastReviewed + +`func (o *CommonAccessItemResponse) HasLastReviewed() bool` + +HasLastReviewed returns a boolean if a field has been set. + +### GetCreatedByUser + +`func (o *CommonAccessItemResponse) GetCreatedByUser() string` + +GetCreatedByUser returns the CreatedByUser field if non-nil, zero value otherwise. + +### GetCreatedByUserOk + +`func (o *CommonAccessItemResponse) GetCreatedByUserOk() (*string, bool)` + +GetCreatedByUserOk returns a tuple with the CreatedByUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedByUser + +`func (o *CommonAccessItemResponse) SetCreatedByUser(v string)` + +SetCreatedByUser sets CreatedByUser field to given value. + +### HasCreatedByUser + +`func (o *CommonAccessItemResponse) HasCreatedByUser() bool` + +HasCreatedByUser returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessItemState.md b/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessItemState.md new file mode 100644 index 000000000..0e1aec68a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessItemState.md @@ -0,0 +1,21 @@ +--- +id: beta-common-access-item-state +title: CommonAccessItemState +pagination_label: CommonAccessItemState +sidebar_label: CommonAccessItemState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessItemState', 'BetaCommonAccessItemState'] +slug: /tools/sdk/go/beta/models/common-access-item-state +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemState', 'BetaCommonAccessItemState'] +--- + +# CommonAccessItemState + +## Enum + + +* `CONFIRMED` (value: `"CONFIRMED"`) + +* `DENIED` (value: `"DENIED"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessResponse.md new file mode 100644 index 000000000..244b11ec6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessResponse.md @@ -0,0 +1,256 @@ +--- +id: beta-common-access-response +title: CommonAccessResponse +pagination_label: CommonAccessResponse +sidebar_label: CommonAccessResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessResponse', 'BetaCommonAccessResponse'] +slug: /tools/sdk/go/beta/models/common-access-response +tags: ['SDK', 'Software Development Kit', 'CommonAccessResponse', 'BetaCommonAccessResponse'] +--- + +# CommonAccessResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique ID of the common access item | [optional] +**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**Status** | Pointer to **string** | CONFIRMED or DENIED | [optional] +**CommonAccessType** | Pointer to **string** | | [optional] +**LastUpdated** | Pointer to **SailPointTime** | | [optional] [readonly] +**ReviewedByUser** | Pointer to **bool** | true if user has confirmed or denied status | [optional] +**LastReviewed** | Pointer to **NullableTime** | | [optional] [readonly] +**CreatedByUser** | Pointer to **bool** | | [optional] [default to false] + +## Methods + +### NewCommonAccessResponse + +`func NewCommonAccessResponse() *CommonAccessResponse` + +NewCommonAccessResponse instantiates a new CommonAccessResponse 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 + +### NewCommonAccessResponseWithDefaults + +`func NewCommonAccessResponseWithDefaults() *CommonAccessResponse` + +NewCommonAccessResponseWithDefaults instantiates a new CommonAccessResponse 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 + +### GetId + +`func (o *CommonAccessResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CommonAccessResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CommonAccessResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CommonAccessResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccess + +`func (o *CommonAccessResponse) GetAccess() CommonAccessItemAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *CommonAccessResponse) GetAccessOk() (*CommonAccessItemAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *CommonAccessResponse) SetAccess(v CommonAccessItemAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *CommonAccessResponse) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetStatus + +`func (o *CommonAccessResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CommonAccessResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CommonAccessResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CommonAccessResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetCommonAccessType + +`func (o *CommonAccessResponse) GetCommonAccessType() string` + +GetCommonAccessType returns the CommonAccessType field if non-nil, zero value otherwise. + +### GetCommonAccessTypeOk + +`func (o *CommonAccessResponse) GetCommonAccessTypeOk() (*string, bool)` + +GetCommonAccessTypeOk returns a tuple with the CommonAccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommonAccessType + +`func (o *CommonAccessResponse) SetCommonAccessType(v string)` + +SetCommonAccessType sets CommonAccessType field to given value. + +### HasCommonAccessType + +`func (o *CommonAccessResponse) HasCommonAccessType() bool` + +HasCommonAccessType returns a boolean if a field has been set. + +### GetLastUpdated + +`func (o *CommonAccessResponse) GetLastUpdated() SailPointTime` + +GetLastUpdated returns the LastUpdated field if non-nil, zero value otherwise. + +### GetLastUpdatedOk + +`func (o *CommonAccessResponse) GetLastUpdatedOk() (*SailPointTime, bool)` + +GetLastUpdatedOk returns a tuple with the LastUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdated + +`func (o *CommonAccessResponse) SetLastUpdated(v SailPointTime)` + +SetLastUpdated sets LastUpdated field to given value. + +### HasLastUpdated + +`func (o *CommonAccessResponse) HasLastUpdated() bool` + +HasLastUpdated returns a boolean if a field has been set. + +### GetReviewedByUser + +`func (o *CommonAccessResponse) GetReviewedByUser() bool` + +GetReviewedByUser returns the ReviewedByUser field if non-nil, zero value otherwise. + +### GetReviewedByUserOk + +`func (o *CommonAccessResponse) GetReviewedByUserOk() (*bool, bool)` + +GetReviewedByUserOk returns a tuple with the ReviewedByUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewedByUser + +`func (o *CommonAccessResponse) SetReviewedByUser(v bool)` + +SetReviewedByUser sets ReviewedByUser field to given value. + +### HasReviewedByUser + +`func (o *CommonAccessResponse) HasReviewedByUser() bool` + +HasReviewedByUser returns a boolean if a field has been set. + +### GetLastReviewed + +`func (o *CommonAccessResponse) GetLastReviewed() SailPointTime` + +GetLastReviewed returns the LastReviewed field if non-nil, zero value otherwise. + +### GetLastReviewedOk + +`func (o *CommonAccessResponse) GetLastReviewedOk() (*SailPointTime, bool)` + +GetLastReviewedOk returns a tuple with the LastReviewed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastReviewed + +`func (o *CommonAccessResponse) SetLastReviewed(v SailPointTime)` + +SetLastReviewed sets LastReviewed field to given value. + +### HasLastReviewed + +`func (o *CommonAccessResponse) HasLastReviewed() bool` + +HasLastReviewed returns a boolean if a field has been set. + +### SetLastReviewedNil + +`func (o *CommonAccessResponse) SetLastReviewedNil(b bool)` + + SetLastReviewedNil sets the value for LastReviewed to be an explicit nil + +### UnsetLastReviewed +`func (o *CommonAccessResponse) UnsetLastReviewed()` + +UnsetLastReviewed ensures that no value is present for LastReviewed, not even an explicit nil +### GetCreatedByUser + +`func (o *CommonAccessResponse) GetCreatedByUser() bool` + +GetCreatedByUser returns the CreatedByUser field if non-nil, zero value otherwise. + +### GetCreatedByUserOk + +`func (o *CommonAccessResponse) GetCreatedByUserOk() (*bool, bool)` + +GetCreatedByUserOk returns a tuple with the CreatedByUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedByUser + +`func (o *CommonAccessResponse) SetCreatedByUser(v bool)` + +SetCreatedByUser sets CreatedByUser field to given value. + +### HasCreatedByUser + +`func (o *CommonAccessResponse) HasCreatedByUser() bool` + +HasCreatedByUser returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessType.md b/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessType.md new file mode 100644 index 000000000..da46f57ec --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CommonAccessType.md @@ -0,0 +1,21 @@ +--- +id: beta-common-access-type +title: CommonAccessType +pagination_label: CommonAccessType +sidebar_label: CommonAccessType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessType', 'BetaCommonAccessType'] +slug: /tools/sdk/go/beta/models/common-access-type +tags: ['SDK', 'Software Development Kit', 'CommonAccessType', 'BetaCommonAccessType'] +--- + +# CommonAccessType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CompleteCampaignOptions.md b/docs/tools/sdk/go/Reference/Beta/Models/CompleteCampaignOptions.md new file mode 100644 index 000000000..0ccc21479 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CompleteCampaignOptions.md @@ -0,0 +1,64 @@ +--- +id: beta-complete-campaign-options +title: CompleteCampaignOptions +pagination_label: CompleteCampaignOptions +sidebar_label: CompleteCampaignOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompleteCampaignOptions', 'BetaCompleteCampaignOptions'] +slug: /tools/sdk/go/beta/models/complete-campaign-options +tags: ['SDK', 'Software Development Kit', 'CompleteCampaignOptions', 'BetaCompleteCampaignOptions'] +--- + +# CompleteCampaignOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AutoCompleteAction** | Pointer to **string** | Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. | [optional] [default to "APPROVE"] + +## Methods + +### NewCompleteCampaignOptions + +`func NewCompleteCampaignOptions() *CompleteCampaignOptions` + +NewCompleteCampaignOptions instantiates a new CompleteCampaignOptions 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 + +### NewCompleteCampaignOptionsWithDefaults + +`func NewCompleteCampaignOptionsWithDefaults() *CompleteCampaignOptions` + +NewCompleteCampaignOptionsWithDefaults instantiates a new CompleteCampaignOptions 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 + +### GetAutoCompleteAction + +`func (o *CompleteCampaignOptions) GetAutoCompleteAction() string` + +GetAutoCompleteAction returns the AutoCompleteAction field if non-nil, zero value otherwise. + +### GetAutoCompleteActionOk + +`func (o *CompleteCampaignOptions) GetAutoCompleteActionOk() (*string, bool)` + +GetAutoCompleteActionOk returns a tuple with the AutoCompleteAction field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoCompleteAction + +`func (o *CompleteCampaignOptions) SetAutoCompleteAction(v string)` + +SetAutoCompleteAction sets AutoCompleteAction field to given value. + +### HasAutoCompleteAction + +`func (o *CompleteCampaignOptions) HasAutoCompleteAction() bool` + +HasAutoCompleteAction returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CompleteInvocation.md b/docs/tools/sdk/go/Reference/Beta/Models/CompleteInvocation.md new file mode 100644 index 000000000..da539d107 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CompleteInvocation.md @@ -0,0 +1,106 @@ +--- +id: beta-complete-invocation +title: CompleteInvocation +pagination_label: CompleteInvocation +sidebar_label: CompleteInvocation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompleteInvocation', 'BetaCompleteInvocation'] +slug: /tools/sdk/go/beta/models/complete-invocation +tags: ['SDK', 'Software Development Kit', 'CompleteInvocation', 'BetaCompleteInvocation'] +--- + +# CompleteInvocation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Secret** | **string** | Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint. | +**Error** | Pointer to **string** | The error message to indicate a failed invocation or error if any. | [optional] +**Output** | **map[string]interface{}** | Trigger output to complete the invocation. Its schema is defined in the trigger definition. | + +## Methods + +### NewCompleteInvocation + +`func NewCompleteInvocation(secret string, output map[string]interface{}, ) *CompleteInvocation` + +NewCompleteInvocation instantiates a new CompleteInvocation 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 + +### NewCompleteInvocationWithDefaults + +`func NewCompleteInvocationWithDefaults() *CompleteInvocation` + +NewCompleteInvocationWithDefaults instantiates a new CompleteInvocation 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 + +### GetSecret + +`func (o *CompleteInvocation) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *CompleteInvocation) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *CompleteInvocation) SetSecret(v string)` + +SetSecret sets Secret field to given value. + + +### GetError + +`func (o *CompleteInvocation) GetError() string` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *CompleteInvocation) GetErrorOk() (*string, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *CompleteInvocation) SetError(v string)` + +SetError sets Error field to given value. + +### HasError + +`func (o *CompleteInvocation) HasError() bool` + +HasError returns a boolean if a field has been set. + +### GetOutput + +`func (o *CompleteInvocation) GetOutput() map[string]interface{}` + +GetOutput returns the Output field if non-nil, zero value otherwise. + +### GetOutputOk + +`func (o *CompleteInvocation) GetOutputOk() (*map[string]interface{}, bool)` + +GetOutputOk returns a tuple with the Output field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutput + +`func (o *CompleteInvocation) SetOutput(v map[string]interface{})` + +SetOutput sets Output field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CompleteInvocationInput.md b/docs/tools/sdk/go/Reference/Beta/Models/CompleteInvocationInput.md new file mode 100644 index 000000000..29543db57 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CompleteInvocationInput.md @@ -0,0 +1,110 @@ +--- +id: beta-complete-invocation-input +title: CompleteInvocationInput +pagination_label: CompleteInvocationInput +sidebar_label: CompleteInvocationInput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompleteInvocationInput', 'BetaCompleteInvocationInput'] +slug: /tools/sdk/go/beta/models/complete-invocation-input +tags: ['SDK', 'Software Development Kit', 'CompleteInvocationInput', 'BetaCompleteInvocationInput'] +--- + +# CompleteInvocationInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LocalizedError** | Pointer to [**NullableLocalizedMessage**](localized-message) | | [optional] +**Output** | Pointer to **map[string]interface{}** | Trigger output that completed the invocation. Its schema is defined in the trigger definition. | [optional] + +## Methods + +### NewCompleteInvocationInput + +`func NewCompleteInvocationInput() *CompleteInvocationInput` + +NewCompleteInvocationInput instantiates a new CompleteInvocationInput 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 + +### NewCompleteInvocationInputWithDefaults + +`func NewCompleteInvocationInputWithDefaults() *CompleteInvocationInput` + +NewCompleteInvocationInputWithDefaults instantiates a new CompleteInvocationInput 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 + +### GetLocalizedError + +`func (o *CompleteInvocationInput) GetLocalizedError() LocalizedMessage` + +GetLocalizedError returns the LocalizedError field if non-nil, zero value otherwise. + +### GetLocalizedErrorOk + +`func (o *CompleteInvocationInput) GetLocalizedErrorOk() (*LocalizedMessage, bool)` + +GetLocalizedErrorOk returns a tuple with the LocalizedError field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizedError + +`func (o *CompleteInvocationInput) SetLocalizedError(v LocalizedMessage)` + +SetLocalizedError sets LocalizedError field to given value. + +### HasLocalizedError + +`func (o *CompleteInvocationInput) HasLocalizedError() bool` + +HasLocalizedError returns a boolean if a field has been set. + +### SetLocalizedErrorNil + +`func (o *CompleteInvocationInput) SetLocalizedErrorNil(b bool)` + + SetLocalizedErrorNil sets the value for LocalizedError to be an explicit nil + +### UnsetLocalizedError +`func (o *CompleteInvocationInput) UnsetLocalizedError()` + +UnsetLocalizedError ensures that no value is present for LocalizedError, not even an explicit nil +### GetOutput + +`func (o *CompleteInvocationInput) GetOutput() map[string]interface{}` + +GetOutput returns the Output field if non-nil, zero value otherwise. + +### GetOutputOk + +`func (o *CompleteInvocationInput) GetOutputOk() (*map[string]interface{}, bool)` + +GetOutputOk returns a tuple with the Output field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutput + +`func (o *CompleteInvocationInput) SetOutput(v map[string]interface{})` + +SetOutput sets Output field to given value. + +### HasOutput + +`func (o *CompleteInvocationInput) HasOutput() bool` + +HasOutput returns a boolean if a field has been set. + +### SetOutputNil + +`func (o *CompleteInvocationInput) SetOutputNil(b bool)` + + SetOutputNil sets the value for Output to be an explicit nil + +### UnsetOutput +`func (o *CompleteInvocationInput) UnsetOutput()` + +UnsetOutput ensures that no value is present for Output, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CompletedApproval.md b/docs/tools/sdk/go/Reference/Beta/Models/CompletedApproval.md new file mode 100644 index 000000000..ba7233f8a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CompletedApproval.md @@ -0,0 +1,732 @@ +--- +id: beta-completed-approval +title: CompletedApproval +pagination_label: CompletedApproval +sidebar_label: CompletedApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApproval', 'BetaCompletedApproval'] +slug: /tools/sdk/go/beta/models/completed-approval +tags: ['SDK', 'Software Development Kit', 'CompletedApproval', 'BetaCompletedApproval'] +--- + +# CompletedApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The approval id. | [optional] +**Name** | Pointer to **string** | The name of the approval. | [optional] +**Created** | Pointer to **SailPointTime** | When the approval was created. | [optional] +**Modified** | Pointer to **SailPointTime** | When the approval was modified last time. | [optional] +**RequestCreated** | Pointer to **SailPointTime** | When the access-request was created. | [optional] +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**Requester** | Pointer to [**AccessItemRequesterDto**](access-item-requester-dto) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**ReviewedBy** | Pointer to [**CompletedApprovalReviewedBy**](completed-approval-reviewed-by) | | [optional] +**Owner** | Pointer to [**AccessItemOwnerDto**](access-item-owner-dto) | | [optional] +**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**RequesterComment** | Pointer to [**CommentDto1**](comment-dto1) | | [optional] +**ReviewerComment** | Pointer to [**NullableCommentDto**](comment-dto) | The approval's reviewer's comment. | [optional] +**PreviousReviewersComments** | Pointer to [**[]CommentDto1**](comment-dto1) | The history of the previous reviewers comments. | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**CommentRequiredWhenRejected** | Pointer to **bool** | When true the rejector has to provide comments when rejecting | [optional] [default to false] +**State** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] +**RemoveDate** | Pointer to **NullableTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**RemoveDateUpdateRequested** | Pointer to **bool** | If true, then the request was to change the remove date or sunset date. | [optional] [default to false] +**CurrentRemoveDate** | Pointer to **NullableTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**SodViolationContext** | Pointer to [**NullableSodViolationContextCheckCompleted1**](sod-violation-context-check-completed1) | | [optional] +**PreApprovalTriggerResult** | Pointer to [**NullableCompletedApprovalPreApprovalTriggerResult**](completed-approval-pre-approval-trigger-result) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs provided during the request. | [optional] +**RequestedAccounts** | Pointer to [**[]RequestedAccountRef**](requested-account-ref) | The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. | [optional] + +## Methods + +### NewCompletedApproval + +`func NewCompletedApproval() *CompletedApproval` + +NewCompletedApproval instantiates a new CompletedApproval 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 + +### NewCompletedApprovalWithDefaults + +`func NewCompletedApprovalWithDefaults() *CompletedApproval` + +NewCompletedApprovalWithDefaults instantiates a new CompletedApproval 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 + +### GetId + +`func (o *CompletedApproval) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CompletedApproval) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CompletedApproval) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CompletedApproval) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CompletedApproval) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CompletedApproval) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CompletedApproval) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CompletedApproval) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *CompletedApproval) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CompletedApproval) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CompletedApproval) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CompletedApproval) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *CompletedApproval) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CompletedApproval) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CompletedApproval) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CompletedApproval) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetRequestCreated + +`func (o *CompletedApproval) GetRequestCreated() SailPointTime` + +GetRequestCreated returns the RequestCreated field if non-nil, zero value otherwise. + +### GetRequestCreatedOk + +`func (o *CompletedApproval) GetRequestCreatedOk() (*SailPointTime, bool)` + +GetRequestCreatedOk returns a tuple with the RequestCreated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCreated + +`func (o *CompletedApproval) SetRequestCreated(v SailPointTime)` + +SetRequestCreated sets RequestCreated field to given value. + +### HasRequestCreated + +`func (o *CompletedApproval) HasRequestCreated() bool` + +HasRequestCreated returns a boolean if a field has been set. + +### GetRequestType + +`func (o *CompletedApproval) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *CompletedApproval) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *CompletedApproval) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *CompletedApproval) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *CompletedApproval) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *CompletedApproval) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetRequester + +`func (o *CompletedApproval) GetRequester() AccessItemRequesterDto` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *CompletedApproval) GetRequesterOk() (*AccessItemRequesterDto, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *CompletedApproval) SetRequester(v AccessItemRequesterDto)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *CompletedApproval) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRequestedFor + +`func (o *CompletedApproval) GetRequestedFor() RequestedItemStatusRequestedFor` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *CompletedApproval) GetRequestedForOk() (*RequestedItemStatusRequestedFor, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *CompletedApproval) SetRequestedFor(v RequestedItemStatusRequestedFor)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *CompletedApproval) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetReviewedBy + +`func (o *CompletedApproval) GetReviewedBy() CompletedApprovalReviewedBy` + +GetReviewedBy returns the ReviewedBy field if non-nil, zero value otherwise. + +### GetReviewedByOk + +`func (o *CompletedApproval) GetReviewedByOk() (*CompletedApprovalReviewedBy, bool)` + +GetReviewedByOk returns a tuple with the ReviewedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewedBy + +`func (o *CompletedApproval) SetReviewedBy(v CompletedApprovalReviewedBy)` + +SetReviewedBy sets ReviewedBy field to given value. + +### HasReviewedBy + +`func (o *CompletedApproval) HasReviewedBy() bool` + +HasReviewedBy returns a boolean if a field has been set. + +### GetOwner + +`func (o *CompletedApproval) GetOwner() AccessItemOwnerDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CompletedApproval) GetOwnerOk() (*AccessItemOwnerDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CompletedApproval) SetOwner(v AccessItemOwnerDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *CompletedApproval) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRequestedObject + +`func (o *CompletedApproval) GetRequestedObject() RequestableObjectReference` + +GetRequestedObject returns the RequestedObject field if non-nil, zero value otherwise. + +### GetRequestedObjectOk + +`func (o *CompletedApproval) GetRequestedObjectOk() (*RequestableObjectReference, bool)` + +GetRequestedObjectOk returns a tuple with the RequestedObject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObject + +`func (o *CompletedApproval) SetRequestedObject(v RequestableObjectReference)` + +SetRequestedObject sets RequestedObject field to given value. + +### HasRequestedObject + +`func (o *CompletedApproval) HasRequestedObject() bool` + +HasRequestedObject returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *CompletedApproval) GetRequesterComment() CommentDto1` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *CompletedApproval) GetRequesterCommentOk() (*CommentDto1, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *CompletedApproval) SetRequesterComment(v CommentDto1)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *CompletedApproval) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### GetReviewerComment + +`func (o *CompletedApproval) GetReviewerComment() CommentDto` + +GetReviewerComment returns the ReviewerComment field if non-nil, zero value otherwise. + +### GetReviewerCommentOk + +`func (o *CompletedApproval) GetReviewerCommentOk() (*CommentDto, bool)` + +GetReviewerCommentOk returns a tuple with the ReviewerComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerComment + +`func (o *CompletedApproval) SetReviewerComment(v CommentDto)` + +SetReviewerComment sets ReviewerComment field to given value. + +### HasReviewerComment + +`func (o *CompletedApproval) HasReviewerComment() bool` + +HasReviewerComment returns a boolean if a field has been set. + +### SetReviewerCommentNil + +`func (o *CompletedApproval) SetReviewerCommentNil(b bool)` + + SetReviewerCommentNil sets the value for ReviewerComment to be an explicit nil + +### UnsetReviewerComment +`func (o *CompletedApproval) UnsetReviewerComment()` + +UnsetReviewerComment ensures that no value is present for ReviewerComment, not even an explicit nil +### GetPreviousReviewersComments + +`func (o *CompletedApproval) GetPreviousReviewersComments() []CommentDto1` + +GetPreviousReviewersComments returns the PreviousReviewersComments field if non-nil, zero value otherwise. + +### GetPreviousReviewersCommentsOk + +`func (o *CompletedApproval) GetPreviousReviewersCommentsOk() (*[]CommentDto1, bool)` + +GetPreviousReviewersCommentsOk returns a tuple with the PreviousReviewersComments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousReviewersComments + +`func (o *CompletedApproval) SetPreviousReviewersComments(v []CommentDto1)` + +SetPreviousReviewersComments sets PreviousReviewersComments field to given value. + +### HasPreviousReviewersComments + +`func (o *CompletedApproval) HasPreviousReviewersComments() bool` + +HasPreviousReviewersComments returns a boolean if a field has been set. + +### GetForwardHistory + +`func (o *CompletedApproval) GetForwardHistory() []ApprovalForwardHistory` + +GetForwardHistory returns the ForwardHistory field if non-nil, zero value otherwise. + +### GetForwardHistoryOk + +`func (o *CompletedApproval) GetForwardHistoryOk() (*[]ApprovalForwardHistory, bool)` + +GetForwardHistoryOk returns a tuple with the ForwardHistory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwardHistory + +`func (o *CompletedApproval) SetForwardHistory(v []ApprovalForwardHistory)` + +SetForwardHistory sets ForwardHistory field to given value. + +### HasForwardHistory + +`func (o *CompletedApproval) HasForwardHistory() bool` + +HasForwardHistory returns a boolean if a field has been set. + +### GetCommentRequiredWhenRejected + +`func (o *CompletedApproval) GetCommentRequiredWhenRejected() bool` + +GetCommentRequiredWhenRejected returns the CommentRequiredWhenRejected field if non-nil, zero value otherwise. + +### GetCommentRequiredWhenRejectedOk + +`func (o *CompletedApproval) GetCommentRequiredWhenRejectedOk() (*bool, bool)` + +GetCommentRequiredWhenRejectedOk returns a tuple with the CommentRequiredWhenRejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentRequiredWhenRejected + +`func (o *CompletedApproval) SetCommentRequiredWhenRejected(v bool)` + +SetCommentRequiredWhenRejected sets CommentRequiredWhenRejected field to given value. + +### HasCommentRequiredWhenRejected + +`func (o *CompletedApproval) HasCommentRequiredWhenRejected() bool` + +HasCommentRequiredWhenRejected returns a boolean if a field has been set. + +### GetState + +`func (o *CompletedApproval) GetState() CompletedApprovalState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *CompletedApproval) GetStateOk() (*CompletedApprovalState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *CompletedApproval) SetState(v CompletedApprovalState)` + +SetState sets State field to given value. + +### HasState + +`func (o *CompletedApproval) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *CompletedApproval) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *CompletedApproval) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *CompletedApproval) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *CompletedApproval) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *CompletedApproval) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *CompletedApproval) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil +### GetRemoveDateUpdateRequested + +`func (o *CompletedApproval) GetRemoveDateUpdateRequested() bool` + +GetRemoveDateUpdateRequested returns the RemoveDateUpdateRequested field if non-nil, zero value otherwise. + +### GetRemoveDateUpdateRequestedOk + +`func (o *CompletedApproval) GetRemoveDateUpdateRequestedOk() (*bool, bool)` + +GetRemoveDateUpdateRequestedOk returns a tuple with the RemoveDateUpdateRequested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDateUpdateRequested + +`func (o *CompletedApproval) SetRemoveDateUpdateRequested(v bool)` + +SetRemoveDateUpdateRequested sets RemoveDateUpdateRequested field to given value. + +### HasRemoveDateUpdateRequested + +`func (o *CompletedApproval) HasRemoveDateUpdateRequested() bool` + +HasRemoveDateUpdateRequested returns a boolean if a field has been set. + +### GetCurrentRemoveDate + +`func (o *CompletedApproval) GetCurrentRemoveDate() SailPointTime` + +GetCurrentRemoveDate returns the CurrentRemoveDate field if non-nil, zero value otherwise. + +### GetCurrentRemoveDateOk + +`func (o *CompletedApproval) GetCurrentRemoveDateOk() (*SailPointTime, bool)` + +GetCurrentRemoveDateOk returns a tuple with the CurrentRemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentRemoveDate + +`func (o *CompletedApproval) SetCurrentRemoveDate(v SailPointTime)` + +SetCurrentRemoveDate sets CurrentRemoveDate field to given value. + +### HasCurrentRemoveDate + +`func (o *CompletedApproval) HasCurrentRemoveDate() bool` + +HasCurrentRemoveDate returns a boolean if a field has been set. + +### SetCurrentRemoveDateNil + +`func (o *CompletedApproval) SetCurrentRemoveDateNil(b bool)` + + SetCurrentRemoveDateNil sets the value for CurrentRemoveDate to be an explicit nil + +### UnsetCurrentRemoveDate +`func (o *CompletedApproval) UnsetCurrentRemoveDate()` + +UnsetCurrentRemoveDate ensures that no value is present for CurrentRemoveDate, not even an explicit nil +### GetSodViolationContext + +`func (o *CompletedApproval) GetSodViolationContext() SodViolationContextCheckCompleted1` + +GetSodViolationContext returns the SodViolationContext field if non-nil, zero value otherwise. + +### GetSodViolationContextOk + +`func (o *CompletedApproval) GetSodViolationContextOk() (*SodViolationContextCheckCompleted1, bool)` + +GetSodViolationContextOk returns a tuple with the SodViolationContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodViolationContext + +`func (o *CompletedApproval) SetSodViolationContext(v SodViolationContextCheckCompleted1)` + +SetSodViolationContext sets SodViolationContext field to given value. + +### HasSodViolationContext + +`func (o *CompletedApproval) HasSodViolationContext() bool` + +HasSodViolationContext returns a boolean if a field has been set. + +### SetSodViolationContextNil + +`func (o *CompletedApproval) SetSodViolationContextNil(b bool)` + + SetSodViolationContextNil sets the value for SodViolationContext to be an explicit nil + +### UnsetSodViolationContext +`func (o *CompletedApproval) UnsetSodViolationContext()` + +UnsetSodViolationContext ensures that no value is present for SodViolationContext, not even an explicit nil +### GetPreApprovalTriggerResult + +`func (o *CompletedApproval) GetPreApprovalTriggerResult() CompletedApprovalPreApprovalTriggerResult` + +GetPreApprovalTriggerResult returns the PreApprovalTriggerResult field if non-nil, zero value otherwise. + +### GetPreApprovalTriggerResultOk + +`func (o *CompletedApproval) GetPreApprovalTriggerResultOk() (*CompletedApprovalPreApprovalTriggerResult, bool)` + +GetPreApprovalTriggerResultOk returns a tuple with the PreApprovalTriggerResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreApprovalTriggerResult + +`func (o *CompletedApproval) SetPreApprovalTriggerResult(v CompletedApprovalPreApprovalTriggerResult)` + +SetPreApprovalTriggerResult sets PreApprovalTriggerResult field to given value. + +### HasPreApprovalTriggerResult + +`func (o *CompletedApproval) HasPreApprovalTriggerResult() bool` + +HasPreApprovalTriggerResult returns a boolean if a field has been set. + +### SetPreApprovalTriggerResultNil + +`func (o *CompletedApproval) SetPreApprovalTriggerResultNil(b bool)` + + SetPreApprovalTriggerResultNil sets the value for PreApprovalTriggerResult to be an explicit nil + +### UnsetPreApprovalTriggerResult +`func (o *CompletedApproval) UnsetPreApprovalTriggerResult()` + +UnsetPreApprovalTriggerResult ensures that no value is present for PreApprovalTriggerResult, not even an explicit nil +### GetClientMetadata + +`func (o *CompletedApproval) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *CompletedApproval) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *CompletedApproval) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *CompletedApproval) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRequestedAccounts + +`func (o *CompletedApproval) GetRequestedAccounts() []RequestedAccountRef` + +GetRequestedAccounts returns the RequestedAccounts field if non-nil, zero value otherwise. + +### GetRequestedAccountsOk + +`func (o *CompletedApproval) GetRequestedAccountsOk() (*[]RequestedAccountRef, bool)` + +GetRequestedAccountsOk returns a tuple with the RequestedAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedAccounts + +`func (o *CompletedApproval) SetRequestedAccounts(v []RequestedAccountRef)` + +SetRequestedAccounts sets RequestedAccounts field to given value. + +### HasRequestedAccounts + +`func (o *CompletedApproval) HasRequestedAccounts() bool` + +HasRequestedAccounts returns a boolean if a field has been set. + +### SetRequestedAccountsNil + +`func (o *CompletedApproval) SetRequestedAccountsNil(b bool)` + + SetRequestedAccountsNil sets the value for RequestedAccounts to be an explicit nil + +### UnsetRequestedAccounts +`func (o *CompletedApproval) UnsetRequestedAccounts()` + +UnsetRequestedAccounts ensures that no value is present for RequestedAccounts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CompletedApprovalPreApprovalTriggerResult.md b/docs/tools/sdk/go/Reference/Beta/Models/CompletedApprovalPreApprovalTriggerResult.md new file mode 100644 index 000000000..6e954fbd4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CompletedApprovalPreApprovalTriggerResult.md @@ -0,0 +1,142 @@ +--- +id: beta-completed-approval-pre-approval-trigger-result +title: CompletedApprovalPreApprovalTriggerResult +pagination_label: CompletedApprovalPreApprovalTriggerResult +sidebar_label: CompletedApprovalPreApprovalTriggerResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApprovalPreApprovalTriggerResult', 'BetaCompletedApprovalPreApprovalTriggerResult'] +slug: /tools/sdk/go/beta/models/completed-approval-pre-approval-trigger-result +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalPreApprovalTriggerResult', 'BetaCompletedApprovalPreApprovalTriggerResult'] +--- + +# CompletedApprovalPreApprovalTriggerResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | The comment from the trigger | [optional] +**Decision** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] +**Reviewer** | Pointer to **string** | The name of the approver | [optional] +**Date** | Pointer to **SailPointTime** | The date and time the trigger decided on the request | [optional] + +## Methods + +### NewCompletedApprovalPreApprovalTriggerResult + +`func NewCompletedApprovalPreApprovalTriggerResult() *CompletedApprovalPreApprovalTriggerResult` + +NewCompletedApprovalPreApprovalTriggerResult instantiates a new CompletedApprovalPreApprovalTriggerResult 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 + +### NewCompletedApprovalPreApprovalTriggerResultWithDefaults + +`func NewCompletedApprovalPreApprovalTriggerResultWithDefaults() *CompletedApprovalPreApprovalTriggerResult` + +NewCompletedApprovalPreApprovalTriggerResultWithDefaults instantiates a new CompletedApprovalPreApprovalTriggerResult 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 + +### GetComment + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CompletedApprovalPreApprovalTriggerResult) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CompletedApprovalPreApprovalTriggerResult) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetDecision + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetDecision() CompletedApprovalState` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetDecisionOk() (*CompletedApprovalState, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *CompletedApprovalPreApprovalTriggerResult) SetDecision(v CompletedApprovalState)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *CompletedApprovalPreApprovalTriggerResult) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + +### GetReviewer + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetReviewer() string` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetReviewerOk() (*string, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CompletedApprovalPreApprovalTriggerResult) SetReviewer(v string)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *CompletedApprovalPreApprovalTriggerResult) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetDate + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetDate() SailPointTime` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetDateOk() (*SailPointTime, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *CompletedApprovalPreApprovalTriggerResult) SetDate(v SailPointTime)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *CompletedApprovalPreApprovalTriggerResult) HasDate() bool` + +HasDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CompletedApprovalReviewedBy.md b/docs/tools/sdk/go/Reference/Beta/Models/CompletedApprovalReviewedBy.md new file mode 100644 index 000000000..3b83ce401 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CompletedApprovalReviewedBy.md @@ -0,0 +1,116 @@ +--- +id: beta-completed-approval-reviewed-by +title: CompletedApprovalReviewedBy +pagination_label: CompletedApprovalReviewedBy +sidebar_label: CompletedApprovalReviewedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApprovalReviewedBy', 'BetaCompletedApprovalReviewedBy'] +slug: /tools/sdk/go/beta/models/completed-approval-reviewed-by +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalReviewedBy', 'BetaCompletedApprovalReviewedBy'] +--- + +# CompletedApprovalReviewedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity who reviewed the access item request. | [optional] +**Id** | Pointer to **string** | ID of identity who reviewed the access item request. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity who reviewed the access item request. | [optional] + +## Methods + +### NewCompletedApprovalReviewedBy + +`func NewCompletedApprovalReviewedBy() *CompletedApprovalReviewedBy` + +NewCompletedApprovalReviewedBy instantiates a new CompletedApprovalReviewedBy 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 + +### NewCompletedApprovalReviewedByWithDefaults + +`func NewCompletedApprovalReviewedByWithDefaults() *CompletedApprovalReviewedBy` + +NewCompletedApprovalReviewedByWithDefaults instantiates a new CompletedApprovalReviewedBy 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 + +### GetType + +`func (o *CompletedApprovalReviewedBy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CompletedApprovalReviewedBy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CompletedApprovalReviewedBy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CompletedApprovalReviewedBy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CompletedApprovalReviewedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CompletedApprovalReviewedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CompletedApprovalReviewedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CompletedApprovalReviewedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CompletedApprovalReviewedBy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CompletedApprovalReviewedBy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CompletedApprovalReviewedBy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CompletedApprovalReviewedBy) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CompletedApprovalState.md b/docs/tools/sdk/go/Reference/Beta/Models/CompletedApprovalState.md new file mode 100644 index 000000000..b4fcf115a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CompletedApprovalState.md @@ -0,0 +1,21 @@ +--- +id: beta-completed-approval-state +title: CompletedApprovalState +pagination_label: CompletedApprovalState +sidebar_label: CompletedApprovalState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApprovalState', 'BetaCompletedApprovalState'] +slug: /tools/sdk/go/beta/models/completed-approval-state +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalState', 'BetaCompletedApprovalState'] +--- + +# CompletedApprovalState + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CompletionStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/CompletionStatus.md new file mode 100644 index 000000000..8cbf2021d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CompletionStatus.md @@ -0,0 +1,25 @@ +--- +id: beta-completion-status +title: CompletionStatus +pagination_label: CompletionStatus +sidebar_label: CompletionStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletionStatus', 'BetaCompletionStatus'] +slug: /tools/sdk/go/beta/models/completion-status +tags: ['SDK', 'Software Development Kit', 'CompletionStatus', 'BetaCompletionStatus'] +--- + +# CompletionStatus + +## Enum + + +* `SUCCESS` (value: `"SUCCESS"`) + +* `FAILURE` (value: `"FAILURE"`) + +* `INCOMPLETE` (value: `"INCOMPLETE"`) + +* `PENDING` (value: `"PENDING"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConditionEffect.md b/docs/tools/sdk/go/Reference/Beta/Models/ConditionEffect.md new file mode 100644 index 000000000..4c693c347 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConditionEffect.md @@ -0,0 +1,90 @@ +--- +id: beta-condition-effect +title: ConditionEffect +pagination_label: ConditionEffect +sidebar_label: ConditionEffect +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConditionEffect', 'BetaConditionEffect'] +slug: /tools/sdk/go/beta/models/condition-effect +tags: ['SDK', 'Software Development Kit', 'ConditionEffect', 'BetaConditionEffect'] +--- + +# ConditionEffect + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EffectType** | Pointer to **string** | Type of effect to perform when the conditions are evaluated for this logic block. HIDE ConditionEffectTypeHide Disables validations. SHOW ConditionEffectTypeShow Enables validations. DISABLE ConditionEffectTypeDisable Disables validations. ENABLE ConditionEffectTypeEnable Enables validations. REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. | [optional] +**Config** | Pointer to [**ConditionEffectConfig**](condition-effect-config) | | [optional] + +## Methods + +### NewConditionEffect + +`func NewConditionEffect() *ConditionEffect` + +NewConditionEffect instantiates a new ConditionEffect 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 + +### NewConditionEffectWithDefaults + +`func NewConditionEffectWithDefaults() *ConditionEffect` + +NewConditionEffectWithDefaults instantiates a new ConditionEffect 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 + +### GetEffectType + +`func (o *ConditionEffect) GetEffectType() string` + +GetEffectType returns the EffectType field if non-nil, zero value otherwise. + +### GetEffectTypeOk + +`func (o *ConditionEffect) GetEffectTypeOk() (*string, bool)` + +GetEffectTypeOk returns a tuple with the EffectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEffectType + +`func (o *ConditionEffect) SetEffectType(v string)` + +SetEffectType sets EffectType field to given value. + +### HasEffectType + +`func (o *ConditionEffect) HasEffectType() bool` + +HasEffectType returns a boolean if a field has been set. + +### GetConfig + +`func (o *ConditionEffect) GetConfig() ConditionEffectConfig` + +GetConfig returns the Config field if non-nil, zero value otherwise. + +### GetConfigOk + +`func (o *ConditionEffect) GetConfigOk() (*ConditionEffectConfig, bool)` + +GetConfigOk returns a tuple with the Config field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfig + +`func (o *ConditionEffect) SetConfig(v ConditionEffectConfig)` + +SetConfig sets Config field to given value. + +### HasConfig + +`func (o *ConditionEffect) HasConfig() bool` + +HasConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConditionEffectConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/ConditionEffectConfig.md new file mode 100644 index 000000000..41bf31e08 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConditionEffectConfig.md @@ -0,0 +1,90 @@ +--- +id: beta-condition-effect-config +title: ConditionEffectConfig +pagination_label: ConditionEffectConfig +sidebar_label: ConditionEffectConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConditionEffectConfig', 'BetaConditionEffectConfig'] +slug: /tools/sdk/go/beta/models/condition-effect-config +tags: ['SDK', 'Software Development Kit', 'ConditionEffectConfig', 'BetaConditionEffectConfig'] +--- + +# ConditionEffectConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DefaultValueLabel** | Pointer to **string** | Effect type's label. | [optional] +**Element** | Pointer to **string** | Element's identifier. | [optional] + +## Methods + +### NewConditionEffectConfig + +`func NewConditionEffectConfig() *ConditionEffectConfig` + +NewConditionEffectConfig instantiates a new ConditionEffectConfig 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 + +### NewConditionEffectConfigWithDefaults + +`func NewConditionEffectConfigWithDefaults() *ConditionEffectConfig` + +NewConditionEffectConfigWithDefaults instantiates a new ConditionEffectConfig 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 + +### GetDefaultValueLabel + +`func (o *ConditionEffectConfig) GetDefaultValueLabel() string` + +GetDefaultValueLabel returns the DefaultValueLabel field if non-nil, zero value otherwise. + +### GetDefaultValueLabelOk + +`func (o *ConditionEffectConfig) GetDefaultValueLabelOk() (*string, bool)` + +GetDefaultValueLabelOk returns a tuple with the DefaultValueLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultValueLabel + +`func (o *ConditionEffectConfig) SetDefaultValueLabel(v string)` + +SetDefaultValueLabel sets DefaultValueLabel field to given value. + +### HasDefaultValueLabel + +`func (o *ConditionEffectConfig) HasDefaultValueLabel() bool` + +HasDefaultValueLabel returns a boolean if a field has been set. + +### GetElement + +`func (o *ConditionEffectConfig) GetElement() string` + +GetElement returns the Element field if non-nil, zero value otherwise. + +### GetElementOk + +`func (o *ConditionEffectConfig) GetElementOk() (*string, bool)` + +GetElementOk returns a tuple with the Element field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElement + +`func (o *ConditionEffectConfig) SetElement(v string)` + +SetElement sets Element field to given value. + +### HasElement + +`func (o *ConditionEffectConfig) HasElement() bool` + +HasElement returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConditionRule.md b/docs/tools/sdk/go/Reference/Beta/Models/ConditionRule.md new file mode 100644 index 000000000..2d7cc7472 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConditionRule.md @@ -0,0 +1,168 @@ +--- +id: beta-condition-rule +title: ConditionRule +pagination_label: ConditionRule +sidebar_label: ConditionRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConditionRule', 'BetaConditionRule'] +slug: /tools/sdk/go/beta/models/condition-rule +tags: ['SDK', 'Software Development Kit', 'ConditionRule', 'BetaConditionRule'] +--- + +# ConditionRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceType** | Pointer to **string** | Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement | [optional] +**Source** | Pointer to **string** | Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, the source is the name of a technical key of an element to retrieve its value. | [optional] +**Operator** | Pointer to **string** | ConditionRuleComparisonOperatorType value. EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith | [optional] +**ValueType** | Pointer to **string** | ConditionRuleValueType type. STRING ConditionRuleValueTypeString This value is a static string. STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. INPUT ConditionRuleValueTypeInput This value is a reference to a form input. ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean | [optional] +**Value** | Pointer to **string** | Based on the ValueType. | [optional] + +## Methods + +### NewConditionRule + +`func NewConditionRule() *ConditionRule` + +NewConditionRule instantiates a new ConditionRule 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 + +### NewConditionRuleWithDefaults + +`func NewConditionRuleWithDefaults() *ConditionRule` + +NewConditionRuleWithDefaults instantiates a new ConditionRule 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 + +### GetSourceType + +`func (o *ConditionRule) GetSourceType() string` + +GetSourceType returns the SourceType field if non-nil, zero value otherwise. + +### GetSourceTypeOk + +`func (o *ConditionRule) GetSourceTypeOk() (*string, bool)` + +GetSourceTypeOk returns a tuple with the SourceType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceType + +`func (o *ConditionRule) SetSourceType(v string)` + +SetSourceType sets SourceType field to given value. + +### HasSourceType + +`func (o *ConditionRule) HasSourceType() bool` + +HasSourceType returns a boolean if a field has been set. + +### GetSource + +`func (o *ConditionRule) GetSource() string` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *ConditionRule) GetSourceOk() (*string, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *ConditionRule) SetSource(v string)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *ConditionRule) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetOperator + +`func (o *ConditionRule) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *ConditionRule) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *ConditionRule) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *ConditionRule) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetValueType + +`func (o *ConditionRule) GetValueType() string` + +GetValueType returns the ValueType field if non-nil, zero value otherwise. + +### GetValueTypeOk + +`func (o *ConditionRule) GetValueTypeOk() (*string, bool)` + +GetValueTypeOk returns a tuple with the ValueType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValueType + +`func (o *ConditionRule) SetValueType(v string)` + +SetValueType sets ValueType field to given value. + +### HasValueType + +`func (o *ConditionRule) HasValueType() bool` + +HasValueType returns a boolean if a field has been set. + +### GetValue + +`func (o *ConditionRule) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ConditionRule) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ConditionRule) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ConditionRule) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConfigObject.md b/docs/tools/sdk/go/Reference/Beta/Models/ConfigObject.md new file mode 100644 index 000000000..1b86b8557 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConfigObject.md @@ -0,0 +1,116 @@ +--- +id: beta-config-object +title: ConfigObject +pagination_label: ConfigObject +sidebar_label: ConfigObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigObject', 'BetaConfigObject'] +slug: /tools/sdk/go/beta/models/config-object +tags: ['SDK', 'Software Development Kit', 'ConfigObject', 'BetaConfigObject'] +--- + +# ConfigObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **int32** | Current version of configuration object. | [optional] +**Self** | Pointer to [**SelfImportExportDto**](self-import-export-dto) | | [optional] +**Object** | Pointer to **map[string]interface{}** | Object details. Format dependant on the object type. | [optional] + +## Methods + +### NewConfigObject + +`func NewConfigObject() *ConfigObject` + +NewConfigObject instantiates a new ConfigObject 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 + +### NewConfigObjectWithDefaults + +`func NewConfigObjectWithDefaults() *ConfigObject` + +NewConfigObjectWithDefaults instantiates a new ConfigObject 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 + +### GetVersion + +`func (o *ConfigObject) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ConfigObject) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ConfigObject) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *ConfigObject) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### GetSelf + +`func (o *ConfigObject) GetSelf() SelfImportExportDto` + +GetSelf returns the Self field if non-nil, zero value otherwise. + +### GetSelfOk + +`func (o *ConfigObject) GetSelfOk() (*SelfImportExportDto, bool)` + +GetSelfOk returns a tuple with the Self field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelf + +`func (o *ConfigObject) SetSelf(v SelfImportExportDto)` + +SetSelf sets Self field to given value. + +### HasSelf + +`func (o *ConfigObject) HasSelf() bool` + +HasSelf returns a boolean if a field has been set. + +### GetObject + +`func (o *ConfigObject) GetObject() map[string]interface{}` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *ConfigObject) GetObjectOk() (*map[string]interface{}, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *ConfigObject) SetObject(v map[string]interface{})` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *ConfigObject) HasObject() bool` + +HasObject returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConfigType.md b/docs/tools/sdk/go/Reference/Beta/Models/ConfigType.md new file mode 100644 index 000000000..390b18e80 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConfigType.md @@ -0,0 +1,168 @@ +--- +id: beta-config-type +title: ConfigType +pagination_label: ConfigType +sidebar_label: ConfigType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigType', 'BetaConfigType'] +slug: /tools/sdk/go/beta/models/config-type +tags: ['SDK', 'Software Development Kit', 'ConfigType', 'BetaConfigType'] +--- + +# ConfigType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Priority** | Pointer to **int32** | | [optional] +**InternalName** | Pointer to [**ConfigTypeEnumCamel**](config-type-enum-camel) | | [optional] +**InternalNameCamel** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] +**DisplayName** | Pointer to **string** | Human readable display name of the type to be shown on UI | [optional] +**Description** | Pointer to **string** | Description of the type of work to be reassigned, displayed by the UI. | [optional] + +## Methods + +### NewConfigType + +`func NewConfigType() *ConfigType` + +NewConfigType instantiates a new ConfigType 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 + +### NewConfigTypeWithDefaults + +`func NewConfigTypeWithDefaults() *ConfigType` + +NewConfigTypeWithDefaults instantiates a new ConfigType 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 + +### GetPriority + +`func (o *ConfigType) GetPriority() int32` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *ConfigType) 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 *ConfigType) SetPriority(v int32)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *ConfigType) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetInternalName + +`func (o *ConfigType) GetInternalName() ConfigTypeEnumCamel` + +GetInternalName returns the InternalName field if non-nil, zero value otherwise. + +### GetInternalNameOk + +`func (o *ConfigType) GetInternalNameOk() (*ConfigTypeEnumCamel, bool)` + +GetInternalNameOk returns a tuple with the InternalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternalName + +`func (o *ConfigType) SetInternalName(v ConfigTypeEnumCamel)` + +SetInternalName sets InternalName field to given value. + +### HasInternalName + +`func (o *ConfigType) HasInternalName() bool` + +HasInternalName returns a boolean if a field has been set. + +### GetInternalNameCamel + +`func (o *ConfigType) GetInternalNameCamel() ConfigTypeEnum` + +GetInternalNameCamel returns the InternalNameCamel field if non-nil, zero value otherwise. + +### GetInternalNameCamelOk + +`func (o *ConfigType) GetInternalNameCamelOk() (*ConfigTypeEnum, bool)` + +GetInternalNameCamelOk returns a tuple with the InternalNameCamel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternalNameCamel + +`func (o *ConfigType) SetInternalNameCamel(v ConfigTypeEnum)` + +SetInternalNameCamel sets InternalNameCamel field to given value. + +### HasInternalNameCamel + +`func (o *ConfigType) HasInternalNameCamel() bool` + +HasInternalNameCamel returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *ConfigType) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *ConfigType) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *ConfigType) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *ConfigType) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ConfigType) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ConfigType) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ConfigType) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ConfigType) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConfigTypeEnum.md b/docs/tools/sdk/go/Reference/Beta/Models/ConfigTypeEnum.md new file mode 100644 index 000000000..a4de10d44 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConfigTypeEnum.md @@ -0,0 +1,23 @@ +--- +id: beta-config-type-enum +title: ConfigTypeEnum +pagination_label: ConfigTypeEnum +sidebar_label: ConfigTypeEnum +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigTypeEnum', 'BetaConfigTypeEnum'] +slug: /tools/sdk/go/beta/models/config-type-enum +tags: ['SDK', 'Software Development Kit', 'ConfigTypeEnum', 'BetaConfigTypeEnum'] +--- + +# ConfigTypeEnum + +## Enum + + +* `ACCESS_REQUESTS` (value: `"ACCESS_REQUESTS"`) + +* `CERTIFICATIONS` (value: `"CERTIFICATIONS"`) + +* `MANUAL_TASKS` (value: `"MANUAL_TASKS"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConfigTypeEnumCamel.md b/docs/tools/sdk/go/Reference/Beta/Models/ConfigTypeEnumCamel.md new file mode 100644 index 000000000..d13730cf0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConfigTypeEnumCamel.md @@ -0,0 +1,23 @@ +--- +id: beta-config-type-enum-camel +title: ConfigTypeEnumCamel +pagination_label: ConfigTypeEnumCamel +sidebar_label: ConfigTypeEnumCamel +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigTypeEnumCamel', 'BetaConfigTypeEnumCamel'] +slug: /tools/sdk/go/beta/models/config-type-enum-camel +tags: ['SDK', 'Software Development Kit', 'ConfigTypeEnumCamel', 'BetaConfigTypeEnumCamel'] +--- + +# ConfigTypeEnumCamel + +## Enum + + +* `ACCESS_REQUESTS` (value: `"accessRequests"`) + +* `CERTIFICATIONS` (value: `"certifications"`) + +* `MANUAL_TASKS` (value: `"manualTasks"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConfigurationDetailsResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/ConfigurationDetailsResponse.md new file mode 100644 index 000000000..01424c8e8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConfigurationDetailsResponse.md @@ -0,0 +1,168 @@ +--- +id: beta-configuration-details-response +title: ConfigurationDetailsResponse +pagination_label: ConfigurationDetailsResponse +sidebar_label: ConfigurationDetailsResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigurationDetailsResponse', 'BetaConfigurationDetailsResponse'] +slug: /tools/sdk/go/beta/models/configuration-details-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationDetailsResponse', 'BetaConfigurationDetailsResponse'] +--- + +# ConfigurationDetailsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConfigType** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] +**TargetIdentity** | Pointer to [**Identity1**](identity1) | | [optional] +**StartDate** | Pointer to **SailPointTime** | The date from which to start reassigning work items | [optional] +**EndDate** | Pointer to **SailPointTime** | The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment. | [optional] +**AuditDetails** | Pointer to [**AuditDetails**](audit-details) | | [optional] + +## Methods + +### NewConfigurationDetailsResponse + +`func NewConfigurationDetailsResponse() *ConfigurationDetailsResponse` + +NewConfigurationDetailsResponse instantiates a new ConfigurationDetailsResponse 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 + +### NewConfigurationDetailsResponseWithDefaults + +`func NewConfigurationDetailsResponseWithDefaults() *ConfigurationDetailsResponse` + +NewConfigurationDetailsResponseWithDefaults instantiates a new ConfigurationDetailsResponse 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 + +### GetConfigType + +`func (o *ConfigurationDetailsResponse) GetConfigType() ConfigTypeEnum` + +GetConfigType returns the ConfigType field if non-nil, zero value otherwise. + +### GetConfigTypeOk + +`func (o *ConfigurationDetailsResponse) GetConfigTypeOk() (*ConfigTypeEnum, bool)` + +GetConfigTypeOk returns a tuple with the ConfigType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigType + +`func (o *ConfigurationDetailsResponse) SetConfigType(v ConfigTypeEnum)` + +SetConfigType sets ConfigType field to given value. + +### HasConfigType + +`func (o *ConfigurationDetailsResponse) HasConfigType() bool` + +HasConfigType returns a boolean if a field has been set. + +### GetTargetIdentity + +`func (o *ConfigurationDetailsResponse) GetTargetIdentity() Identity1` + +GetTargetIdentity returns the TargetIdentity field if non-nil, zero value otherwise. + +### GetTargetIdentityOk + +`func (o *ConfigurationDetailsResponse) GetTargetIdentityOk() (*Identity1, bool)` + +GetTargetIdentityOk returns a tuple with the TargetIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetIdentity + +`func (o *ConfigurationDetailsResponse) SetTargetIdentity(v Identity1)` + +SetTargetIdentity sets TargetIdentity field to given value. + +### HasTargetIdentity + +`func (o *ConfigurationDetailsResponse) HasTargetIdentity() bool` + +HasTargetIdentity returns a boolean if a field has been set. + +### GetStartDate + +`func (o *ConfigurationDetailsResponse) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *ConfigurationDetailsResponse) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *ConfigurationDetailsResponse) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *ConfigurationDetailsResponse) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *ConfigurationDetailsResponse) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *ConfigurationDetailsResponse) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *ConfigurationDetailsResponse) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *ConfigurationDetailsResponse) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetAuditDetails + +`func (o *ConfigurationDetailsResponse) GetAuditDetails() AuditDetails` + +GetAuditDetails returns the AuditDetails field if non-nil, zero value otherwise. + +### GetAuditDetailsOk + +`func (o *ConfigurationDetailsResponse) GetAuditDetailsOk() (*AuditDetails, bool)` + +GetAuditDetailsOk returns a tuple with the AuditDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuditDetails + +`func (o *ConfigurationDetailsResponse) SetAuditDetails(v AuditDetails)` + +SetAuditDetails sets AuditDetails field to given value. + +### HasAuditDetails + +`func (o *ConfigurationDetailsResponse) HasAuditDetails() bool` + +HasAuditDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConfigurationItemRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/ConfigurationItemRequest.md new file mode 100644 index 000000000..872b25569 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConfigurationItemRequest.md @@ -0,0 +1,178 @@ +--- +id: beta-configuration-item-request +title: ConfigurationItemRequest +pagination_label: ConfigurationItemRequest +sidebar_label: ConfigurationItemRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigurationItemRequest', 'BetaConfigurationItemRequest'] +slug: /tools/sdk/go/beta/models/configuration-item-request +tags: ['SDK', 'Software Development Kit', 'ConfigurationItemRequest', 'BetaConfigurationItemRequest'] +--- + +# ConfigurationItemRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReassignedFromId** | Pointer to **string** | The identity id to reassign an item from | [optional] +**ReassignedToId** | Pointer to **string** | The identity id to reassign an item to | [optional] +**ConfigType** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] +**StartDate** | Pointer to **SailPointTime** | The date from which to start reassigning work items | [optional] +**EndDate** | Pointer to **NullableTime** | The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment. | [optional] + +## Methods + +### NewConfigurationItemRequest + +`func NewConfigurationItemRequest() *ConfigurationItemRequest` + +NewConfigurationItemRequest instantiates a new ConfigurationItemRequest 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 + +### NewConfigurationItemRequestWithDefaults + +`func NewConfigurationItemRequestWithDefaults() *ConfigurationItemRequest` + +NewConfigurationItemRequestWithDefaults instantiates a new ConfigurationItemRequest 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 + +### GetReassignedFromId + +`func (o *ConfigurationItemRequest) GetReassignedFromId() string` + +GetReassignedFromId returns the ReassignedFromId field if non-nil, zero value otherwise. + +### GetReassignedFromIdOk + +`func (o *ConfigurationItemRequest) GetReassignedFromIdOk() (*string, bool)` + +GetReassignedFromIdOk returns a tuple with the ReassignedFromId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignedFromId + +`func (o *ConfigurationItemRequest) SetReassignedFromId(v string)` + +SetReassignedFromId sets ReassignedFromId field to given value. + +### HasReassignedFromId + +`func (o *ConfigurationItemRequest) HasReassignedFromId() bool` + +HasReassignedFromId returns a boolean if a field has been set. + +### GetReassignedToId + +`func (o *ConfigurationItemRequest) GetReassignedToId() string` + +GetReassignedToId returns the ReassignedToId field if non-nil, zero value otherwise. + +### GetReassignedToIdOk + +`func (o *ConfigurationItemRequest) GetReassignedToIdOk() (*string, bool)` + +GetReassignedToIdOk returns a tuple with the ReassignedToId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignedToId + +`func (o *ConfigurationItemRequest) SetReassignedToId(v string)` + +SetReassignedToId sets ReassignedToId field to given value. + +### HasReassignedToId + +`func (o *ConfigurationItemRequest) HasReassignedToId() bool` + +HasReassignedToId returns a boolean if a field has been set. + +### GetConfigType + +`func (o *ConfigurationItemRequest) GetConfigType() ConfigTypeEnum` + +GetConfigType returns the ConfigType field if non-nil, zero value otherwise. + +### GetConfigTypeOk + +`func (o *ConfigurationItemRequest) GetConfigTypeOk() (*ConfigTypeEnum, bool)` + +GetConfigTypeOk returns a tuple with the ConfigType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigType + +`func (o *ConfigurationItemRequest) SetConfigType(v ConfigTypeEnum)` + +SetConfigType sets ConfigType field to given value. + +### HasConfigType + +`func (o *ConfigurationItemRequest) HasConfigType() bool` + +HasConfigType returns a boolean if a field has been set. + +### GetStartDate + +`func (o *ConfigurationItemRequest) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *ConfigurationItemRequest) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *ConfigurationItemRequest) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *ConfigurationItemRequest) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *ConfigurationItemRequest) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *ConfigurationItemRequest) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *ConfigurationItemRequest) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *ConfigurationItemRequest) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### SetEndDateNil + +`func (o *ConfigurationItemRequest) SetEndDateNil(b bool)` + + SetEndDateNil sets the value for EndDate to be an explicit nil + +### UnsetEndDate +`func (o *ConfigurationItemRequest) UnsetEndDate()` + +UnsetEndDate ensures that no value is present for EndDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConfigurationItemResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/ConfigurationItemResponse.md new file mode 100644 index 000000000..bd6bd5696 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConfigurationItemResponse.md @@ -0,0 +1,90 @@ +--- +id: beta-configuration-item-response +title: ConfigurationItemResponse +pagination_label: ConfigurationItemResponse +sidebar_label: ConfigurationItemResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigurationItemResponse', 'BetaConfigurationItemResponse'] +slug: /tools/sdk/go/beta/models/configuration-item-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationItemResponse', 'BetaConfigurationItemResponse'] +--- + +# ConfigurationItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**Identity1**](identity1) | | [optional] +**ConfigDetails** | Pointer to [**[]ConfigurationDetailsResponse**](configuration-details-response) | Details of how work should be reassigned for an Identity | [optional] + +## Methods + +### NewConfigurationItemResponse + +`func NewConfigurationItemResponse() *ConfigurationItemResponse` + +NewConfigurationItemResponse instantiates a new ConfigurationItemResponse 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 + +### NewConfigurationItemResponseWithDefaults + +`func NewConfigurationItemResponseWithDefaults() *ConfigurationItemResponse` + +NewConfigurationItemResponseWithDefaults instantiates a new ConfigurationItemResponse 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 + +### GetIdentity + +`func (o *ConfigurationItemResponse) GetIdentity() Identity1` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *ConfigurationItemResponse) GetIdentityOk() (*Identity1, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *ConfigurationItemResponse) SetIdentity(v Identity1)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *ConfigurationItemResponse) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetConfigDetails + +`func (o *ConfigurationItemResponse) GetConfigDetails() []ConfigurationDetailsResponse` + +GetConfigDetails returns the ConfigDetails field if non-nil, zero value otherwise. + +### GetConfigDetailsOk + +`func (o *ConfigurationItemResponse) GetConfigDetailsOk() (*[]ConfigurationDetailsResponse, bool)` + +GetConfigDetailsOk returns a tuple with the ConfigDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigDetails + +`func (o *ConfigurationItemResponse) SetConfigDetails(v []ConfigurationDetailsResponse)` + +SetConfigDetails sets ConfigDetails field to given value. + +### HasConfigDetails + +`func (o *ConfigurationItemResponse) HasConfigDetails() bool` + +HasConfigDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConfigurationResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/ConfigurationResponse.md new file mode 100644 index 000000000..33692b400 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConfigurationResponse.md @@ -0,0 +1,90 @@ +--- +id: beta-configuration-response +title: ConfigurationResponse +pagination_label: ConfigurationResponse +sidebar_label: ConfigurationResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigurationResponse', 'BetaConfigurationResponse'] +slug: /tools/sdk/go/beta/models/configuration-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationResponse', 'BetaConfigurationResponse'] +--- + +# ConfigurationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**Identity1**](identity1) | | [optional] +**ConfigDetails** | Pointer to [**[]ConfigurationDetailsResponse**](configuration-details-response) | Details of how work should be reassigned for an Identity | [optional] + +## Methods + +### NewConfigurationResponse + +`func NewConfigurationResponse() *ConfigurationResponse` + +NewConfigurationResponse instantiates a new ConfigurationResponse 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 + +### NewConfigurationResponseWithDefaults + +`func NewConfigurationResponseWithDefaults() *ConfigurationResponse` + +NewConfigurationResponseWithDefaults instantiates a new ConfigurationResponse 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 + +### GetIdentity + +`func (o *ConfigurationResponse) GetIdentity() Identity1` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *ConfigurationResponse) GetIdentityOk() (*Identity1, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *ConfigurationResponse) SetIdentity(v Identity1)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *ConfigurationResponse) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetConfigDetails + +`func (o *ConfigurationResponse) GetConfigDetails() []ConfigurationDetailsResponse` + +GetConfigDetails returns the ConfigDetails field if non-nil, zero value otherwise. + +### GetConfigDetailsOk + +`func (o *ConfigurationResponse) GetConfigDetailsOk() (*[]ConfigurationDetailsResponse, bool)` + +GetConfigDetailsOk returns a tuple with the ConfigDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigDetails + +`func (o *ConfigurationResponse) SetConfigDetails(v []ConfigurationDetailsResponse)` + +SetConfigDetails sets ConfigDetails field to given value. + +### HasConfigDetails + +`func (o *ConfigurationResponse) HasConfigDetails() bool` + +HasConfigDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConflictingAccessCriteria.md b/docs/tools/sdk/go/Reference/Beta/Models/ConflictingAccessCriteria.md new file mode 100644 index 000000000..3006f5d33 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConflictingAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: beta-conflicting-access-criteria +title: ConflictingAccessCriteria +pagination_label: ConflictingAccessCriteria +sidebar_label: ConflictingAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConflictingAccessCriteria', 'BetaConflictingAccessCriteria'] +slug: /tools/sdk/go/beta/models/conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'ConflictingAccessCriteria', 'BetaConflictingAccessCriteria'] +--- + +# ConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] +**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] + +## Methods + +### NewConflictingAccessCriteria + +`func NewConflictingAccessCriteria() *ConflictingAccessCriteria` + +NewConflictingAccessCriteria instantiates a new ConflictingAccessCriteria 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 + +### NewConflictingAccessCriteriaWithDefaults + +`func NewConflictingAccessCriteriaWithDefaults() *ConflictingAccessCriteria` + +NewConflictingAccessCriteriaWithDefaults instantiates a new ConflictingAccessCriteria 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 + +### GetLeftCriteria + +`func (o *ConflictingAccessCriteria) GetLeftCriteria() AccessCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *ConflictingAccessCriteria) GetLeftCriteriaOk() (*AccessCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *ConflictingAccessCriteria) SetLeftCriteria(v AccessCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *ConflictingAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *ConflictingAccessCriteria) GetRightCriteria() AccessCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *ConflictingAccessCriteria) GetRightCriteriaOk() (*AccessCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *ConflictingAccessCriteria) SetRightCriteria(v AccessCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *ConflictingAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConnectedObject.md b/docs/tools/sdk/go/Reference/Beta/Models/ConnectedObject.md new file mode 100644 index 000000000..9dd56419d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConnectedObject.md @@ -0,0 +1,142 @@ +--- +id: beta-connected-object +title: ConnectedObject +pagination_label: ConnectedObject +sidebar_label: ConnectedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectedObject', 'BetaConnectedObject'] +slug: /tools/sdk/go/beta/models/connected-object +tags: ['SDK', 'Software Development Kit', 'ConnectedObject', 'BetaConnectedObject'] +--- + +# ConnectedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**ConnectedObjectType**](connected-object-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable name of Connected object | [optional] +**Description** | Pointer to **string** | Description of the Connected object. | [optional] + +## Methods + +### NewConnectedObject + +`func NewConnectedObject() *ConnectedObject` + +NewConnectedObject instantiates a new ConnectedObject 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 + +### NewConnectedObjectWithDefaults + +`func NewConnectedObjectWithDefaults() *ConnectedObject` + +NewConnectedObjectWithDefaults instantiates a new ConnectedObject 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 + +### GetType + +`func (o *ConnectedObject) GetType() ConnectedObjectType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ConnectedObject) GetTypeOk() (*ConnectedObjectType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ConnectedObject) SetType(v ConnectedObjectType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ConnectedObject) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ConnectedObject) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ConnectedObject) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ConnectedObject) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ConnectedObject) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ConnectedObject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectedObject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectedObject) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectedObject) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ConnectedObject) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ConnectedObject) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ConnectedObject) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ConnectedObject) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConnectedObjectType.md b/docs/tools/sdk/go/Reference/Beta/Models/ConnectedObjectType.md new file mode 100644 index 000000000..5933a687f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConnectedObjectType.md @@ -0,0 +1,25 @@ +--- +id: beta-connected-object-type +title: ConnectedObjectType +pagination_label: ConnectedObjectType +sidebar_label: ConnectedObjectType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectedObjectType', 'BetaConnectedObjectType'] +slug: /tools/sdk/go/beta/models/connected-object-type +tags: ['SDK', 'Software Development Kit', 'ConnectedObjectType', 'BetaConnectedObjectType'] +--- + +# ConnectedObjectType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + +* `SOD_POLICY` (value: `"SOD_POLICY"`) + +* `SOURCE` (value: `"SOURCE"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConnectorDetail.md b/docs/tools/sdk/go/Reference/Beta/Models/ConnectorDetail.md new file mode 100644 index 000000000..ccdab6f21 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConnectorDetail.md @@ -0,0 +1,220 @@ +--- +id: beta-connector-detail +title: ConnectorDetail +pagination_label: ConnectorDetail +sidebar_label: ConnectorDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorDetail', 'BetaConnectorDetail'] +slug: /tools/sdk/go/beta/models/connector-detail +tags: ['SDK', 'Software Development Kit', 'ConnectorDetail', 'BetaConnectorDetail'] +--- + +# ConnectorDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The connector name | [optional] +**SourceConfigXml** | Pointer to **string** | XML representation of the source config data | [optional] +**SourceConfig** | Pointer to **string** | JSON representation of the source config data | [optional] +**DirectConnect** | Pointer to **bool** | true if the source is a direct connect source | [optional] +**FileUpload** | Pointer to **bool** | Connector config's file upload attribute, false if not there | [optional] +**UploadedFiles** | Pointer to **string** | List of uploaded file strings for the connector | [optional] +**ConnectorMetadata** | Pointer to **map[string]interface{}** | Object containing metadata pertinent to the UI to be used | [optional] + +## Methods + +### NewConnectorDetail + +`func NewConnectorDetail() *ConnectorDetail` + +NewConnectorDetail instantiates a new ConnectorDetail 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 + +### NewConnectorDetailWithDefaults + +`func NewConnectorDetailWithDefaults() *ConnectorDetail` + +NewConnectorDetailWithDefaults instantiates a new ConnectorDetail 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 + +### GetName + +`func (o *ConnectorDetail) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorDetail) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorDetail) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectorDetail) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceConfigXml + +`func (o *ConnectorDetail) GetSourceConfigXml() string` + +GetSourceConfigXml returns the SourceConfigXml field if non-nil, zero value otherwise. + +### GetSourceConfigXmlOk + +`func (o *ConnectorDetail) GetSourceConfigXmlOk() (*string, bool)` + +GetSourceConfigXmlOk returns a tuple with the SourceConfigXml field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceConfigXml + +`func (o *ConnectorDetail) SetSourceConfigXml(v string)` + +SetSourceConfigXml sets SourceConfigXml field to given value. + +### HasSourceConfigXml + +`func (o *ConnectorDetail) HasSourceConfigXml() bool` + +HasSourceConfigXml returns a boolean if a field has been set. + +### GetSourceConfig + +`func (o *ConnectorDetail) GetSourceConfig() string` + +GetSourceConfig returns the SourceConfig field if non-nil, zero value otherwise. + +### GetSourceConfigOk + +`func (o *ConnectorDetail) GetSourceConfigOk() (*string, bool)` + +GetSourceConfigOk returns a tuple with the SourceConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceConfig + +`func (o *ConnectorDetail) SetSourceConfig(v string)` + +SetSourceConfig sets SourceConfig field to given value. + +### HasSourceConfig + +`func (o *ConnectorDetail) HasSourceConfig() bool` + +HasSourceConfig returns a boolean if a field has been set. + +### GetDirectConnect + +`func (o *ConnectorDetail) GetDirectConnect() bool` + +GetDirectConnect returns the DirectConnect field if non-nil, zero value otherwise. + +### GetDirectConnectOk + +`func (o *ConnectorDetail) GetDirectConnectOk() (*bool, bool)` + +GetDirectConnectOk returns a tuple with the DirectConnect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectConnect + +`func (o *ConnectorDetail) SetDirectConnect(v bool)` + +SetDirectConnect sets DirectConnect field to given value. + +### HasDirectConnect + +`func (o *ConnectorDetail) HasDirectConnect() bool` + +HasDirectConnect returns a boolean if a field has been set. + +### GetFileUpload + +`func (o *ConnectorDetail) GetFileUpload() bool` + +GetFileUpload returns the FileUpload field if non-nil, zero value otherwise. + +### GetFileUploadOk + +`func (o *ConnectorDetail) GetFileUploadOk() (*bool, bool)` + +GetFileUploadOk returns a tuple with the FileUpload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileUpload + +`func (o *ConnectorDetail) SetFileUpload(v bool)` + +SetFileUpload sets FileUpload field to given value. + +### HasFileUpload + +`func (o *ConnectorDetail) HasFileUpload() bool` + +HasFileUpload returns a boolean if a field has been set. + +### GetUploadedFiles + +`func (o *ConnectorDetail) GetUploadedFiles() string` + +GetUploadedFiles returns the UploadedFiles field if non-nil, zero value otherwise. + +### GetUploadedFilesOk + +`func (o *ConnectorDetail) GetUploadedFilesOk() (*string, bool)` + +GetUploadedFilesOk returns a tuple with the UploadedFiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUploadedFiles + +`func (o *ConnectorDetail) SetUploadedFiles(v string)` + +SetUploadedFiles sets UploadedFiles field to given value. + +### HasUploadedFiles + +`func (o *ConnectorDetail) HasUploadedFiles() bool` + +HasUploadedFiles returns a boolean if a field has been set. + +### GetConnectorMetadata + +`func (o *ConnectorDetail) GetConnectorMetadata() map[string]interface{}` + +GetConnectorMetadata returns the ConnectorMetadata field if non-nil, zero value otherwise. + +### GetConnectorMetadataOk + +`func (o *ConnectorDetail) GetConnectorMetadataOk() (*map[string]interface{}, bool)` + +GetConnectorMetadataOk returns a tuple with the ConnectorMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorMetadata + +`func (o *ConnectorDetail) SetConnectorMetadata(v map[string]interface{})` + +SetConnectorMetadata sets ConnectorMetadata field to given value. + +### HasConnectorMetadata + +`func (o *ConnectorDetail) HasConnectorMetadata() bool` + +HasConnectorMetadata returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleCreateRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleCreateRequest.md new file mode 100644 index 000000000..6f354056c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleCreateRequest.md @@ -0,0 +1,189 @@ +--- +id: beta-connector-rule-create-request +title: ConnectorRuleCreateRequest +pagination_label: ConnectorRuleCreateRequest +sidebar_label: ConnectorRuleCreateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleCreateRequest', 'BetaConnectorRuleCreateRequest'] +slug: /tools/sdk/go/beta/models/connector-rule-create-request +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleCreateRequest', 'BetaConnectorRuleCreateRequest'] +--- + +# ConnectorRuleCreateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | the name of the rule | +**Description** | Pointer to **string** | a description of the rule's purpose | [optional] +**Type** | **string** | the type of rule | +**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**SourceCode** | [**SourceCode**](source-code) | | +**Attributes** | Pointer to **map[string]interface{}** | a map of string to objects | [optional] + +## Methods + +### NewConnectorRuleCreateRequest + +`func NewConnectorRuleCreateRequest(name string, type_ string, sourceCode SourceCode, ) *ConnectorRuleCreateRequest` + +NewConnectorRuleCreateRequest instantiates a new ConnectorRuleCreateRequest 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 + +### NewConnectorRuleCreateRequestWithDefaults + +`func NewConnectorRuleCreateRequestWithDefaults() *ConnectorRuleCreateRequest` + +NewConnectorRuleCreateRequestWithDefaults instantiates a new ConnectorRuleCreateRequest 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 + +### GetName + +`func (o *ConnectorRuleCreateRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorRuleCreateRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorRuleCreateRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *ConnectorRuleCreateRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ConnectorRuleCreateRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ConnectorRuleCreateRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ConnectorRuleCreateRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetType + +`func (o *ConnectorRuleCreateRequest) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ConnectorRuleCreateRequest) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ConnectorRuleCreateRequest) SetType(v string)` + +SetType sets Type field to given value. + + +### GetSignature + +`func (o *ConnectorRuleCreateRequest) GetSignature() ConnectorRuleCreateRequestSignature` + +GetSignature returns the Signature field if non-nil, zero value otherwise. + +### GetSignatureOk + +`func (o *ConnectorRuleCreateRequest) GetSignatureOk() (*ConnectorRuleCreateRequestSignature, bool)` + +GetSignatureOk returns a tuple with the Signature field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignature + +`func (o *ConnectorRuleCreateRequest) SetSignature(v ConnectorRuleCreateRequestSignature)` + +SetSignature sets Signature field to given value. + +### HasSignature + +`func (o *ConnectorRuleCreateRequest) HasSignature() bool` + +HasSignature returns a boolean if a field has been set. + +### GetSourceCode + +`func (o *ConnectorRuleCreateRequest) GetSourceCode() SourceCode` + +GetSourceCode returns the SourceCode field if non-nil, zero value otherwise. + +### GetSourceCodeOk + +`func (o *ConnectorRuleCreateRequest) GetSourceCodeOk() (*SourceCode, bool)` + +GetSourceCodeOk returns a tuple with the SourceCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceCode + +`func (o *ConnectorRuleCreateRequest) SetSourceCode(v SourceCode)` + +SetSourceCode sets SourceCode field to given value. + + +### GetAttributes + +`func (o *ConnectorRuleCreateRequest) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ConnectorRuleCreateRequest) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ConnectorRuleCreateRequest) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ConnectorRuleCreateRequest) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *ConnectorRuleCreateRequest) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *ConnectorRuleCreateRequest) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleCreateRequestSignature.md b/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleCreateRequestSignature.md new file mode 100644 index 000000000..38a2cde43 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleCreateRequestSignature.md @@ -0,0 +1,95 @@ +--- +id: beta-connector-rule-create-request-signature +title: ConnectorRuleCreateRequestSignature +pagination_label: ConnectorRuleCreateRequestSignature +sidebar_label: ConnectorRuleCreateRequestSignature +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleCreateRequestSignature', 'BetaConnectorRuleCreateRequestSignature'] +slug: /tools/sdk/go/beta/models/connector-rule-create-request-signature +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleCreateRequestSignature', 'BetaConnectorRuleCreateRequestSignature'] +--- + +# ConnectorRuleCreateRequestSignature + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | [**[]Argument**](argument) | | +**Output** | Pointer to [**NullableArgument**](argument) | | [optional] + +## Methods + +### NewConnectorRuleCreateRequestSignature + +`func NewConnectorRuleCreateRequestSignature(input []Argument, ) *ConnectorRuleCreateRequestSignature` + +NewConnectorRuleCreateRequestSignature instantiates a new ConnectorRuleCreateRequestSignature 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 + +### NewConnectorRuleCreateRequestSignatureWithDefaults + +`func NewConnectorRuleCreateRequestSignatureWithDefaults() *ConnectorRuleCreateRequestSignature` + +NewConnectorRuleCreateRequestSignatureWithDefaults instantiates a new ConnectorRuleCreateRequestSignature 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 + +### GetInput + +`func (o *ConnectorRuleCreateRequestSignature) GetInput() []Argument` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *ConnectorRuleCreateRequestSignature) GetInputOk() (*[]Argument, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *ConnectorRuleCreateRequestSignature) SetInput(v []Argument)` + +SetInput sets Input field to given value. + + +### GetOutput + +`func (o *ConnectorRuleCreateRequestSignature) GetOutput() Argument` + +GetOutput returns the Output field if non-nil, zero value otherwise. + +### GetOutputOk + +`func (o *ConnectorRuleCreateRequestSignature) GetOutputOk() (*Argument, bool)` + +GetOutputOk returns a tuple with the Output field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutput + +`func (o *ConnectorRuleCreateRequestSignature) SetOutput(v Argument)` + +SetOutput sets Output field to given value. + +### HasOutput + +`func (o *ConnectorRuleCreateRequestSignature) HasOutput() bool` + +HasOutput returns a boolean if a field has been set. + +### SetOutputNil + +`func (o *ConnectorRuleCreateRequestSignature) SetOutputNil(b bool)` + + SetOutputNil sets the value for Output to be an explicit nil + +### UnsetOutput +`func (o *ConnectorRuleCreateRequestSignature) UnsetOutput()` + +UnsetOutput ensures that no value is present for Output, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleResponse.md new file mode 100644 index 000000000..f627ab214 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleResponse.md @@ -0,0 +1,267 @@ +--- +id: beta-connector-rule-response +title: ConnectorRuleResponse +pagination_label: ConnectorRuleResponse +sidebar_label: ConnectorRuleResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleResponse', 'BetaConnectorRuleResponse'] +slug: /tools/sdk/go/beta/models/connector-rule-response +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleResponse', 'BetaConnectorRuleResponse'] +--- + +# ConnectorRuleResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | the name of the rule | +**Description** | Pointer to **string** | a description of the rule's purpose | [optional] +**Type** | **string** | the type of rule | +**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**SourceCode** | [**SourceCode**](source-code) | | +**Attributes** | Pointer to **map[string]interface{}** | a map of string to objects | [optional] +**Id** | **string** | the ID of the rule | +**Created** | **string** | an ISO 8601 UTC timestamp when this rule was created | +**Modified** | Pointer to **NullableString** | an ISO 8601 UTC timestamp when this rule was last modified | [optional] + +## Methods + +### NewConnectorRuleResponse + +`func NewConnectorRuleResponse(name string, type_ string, sourceCode SourceCode, id string, created string, ) *ConnectorRuleResponse` + +NewConnectorRuleResponse instantiates a new ConnectorRuleResponse 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 + +### NewConnectorRuleResponseWithDefaults + +`func NewConnectorRuleResponseWithDefaults() *ConnectorRuleResponse` + +NewConnectorRuleResponseWithDefaults instantiates a new ConnectorRuleResponse 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 + +### GetName + +`func (o *ConnectorRuleResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorRuleResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorRuleResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *ConnectorRuleResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ConnectorRuleResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ConnectorRuleResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ConnectorRuleResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetType + +`func (o *ConnectorRuleResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ConnectorRuleResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ConnectorRuleResponse) SetType(v string)` + +SetType sets Type field to given value. + + +### GetSignature + +`func (o *ConnectorRuleResponse) GetSignature() ConnectorRuleCreateRequestSignature` + +GetSignature returns the Signature field if non-nil, zero value otherwise. + +### GetSignatureOk + +`func (o *ConnectorRuleResponse) GetSignatureOk() (*ConnectorRuleCreateRequestSignature, bool)` + +GetSignatureOk returns a tuple with the Signature field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignature + +`func (o *ConnectorRuleResponse) SetSignature(v ConnectorRuleCreateRequestSignature)` + +SetSignature sets Signature field to given value. + +### HasSignature + +`func (o *ConnectorRuleResponse) HasSignature() bool` + +HasSignature returns a boolean if a field has been set. + +### GetSourceCode + +`func (o *ConnectorRuleResponse) GetSourceCode() SourceCode` + +GetSourceCode returns the SourceCode field if non-nil, zero value otherwise. + +### GetSourceCodeOk + +`func (o *ConnectorRuleResponse) GetSourceCodeOk() (*SourceCode, bool)` + +GetSourceCodeOk returns a tuple with the SourceCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceCode + +`func (o *ConnectorRuleResponse) SetSourceCode(v SourceCode)` + +SetSourceCode sets SourceCode field to given value. + + +### GetAttributes + +`func (o *ConnectorRuleResponse) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ConnectorRuleResponse) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ConnectorRuleResponse) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ConnectorRuleResponse) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *ConnectorRuleResponse) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *ConnectorRuleResponse) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetId + +`func (o *ConnectorRuleResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ConnectorRuleResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ConnectorRuleResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetCreated + +`func (o *ConnectorRuleResponse) GetCreated() string` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ConnectorRuleResponse) GetCreatedOk() (*string, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ConnectorRuleResponse) SetCreated(v string)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *ConnectorRuleResponse) GetModified() string` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ConnectorRuleResponse) GetModifiedOk() (*string, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ConnectorRuleResponse) SetModified(v string)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ConnectorRuleResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *ConnectorRuleResponse) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *ConnectorRuleResponse) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleUpdateRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleUpdateRequest.md new file mode 100644 index 000000000..176be4492 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleUpdateRequest.md @@ -0,0 +1,210 @@ +--- +id: beta-connector-rule-update-request +title: ConnectorRuleUpdateRequest +pagination_label: ConnectorRuleUpdateRequest +sidebar_label: ConnectorRuleUpdateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleUpdateRequest', 'BetaConnectorRuleUpdateRequest'] +slug: /tools/sdk/go/beta/models/connector-rule-update-request +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleUpdateRequest', 'BetaConnectorRuleUpdateRequest'] +--- + +# ConnectorRuleUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | the name of the rule | +**Description** | Pointer to **string** | a description of the rule's purpose | [optional] +**Type** | **string** | the type of rule | +**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**SourceCode** | [**SourceCode**](source-code) | | +**Attributes** | Pointer to **map[string]interface{}** | a map of string to objects | [optional] +**Id** | **string** | the ID of the rule to update | + +## Methods + +### NewConnectorRuleUpdateRequest + +`func NewConnectorRuleUpdateRequest(name string, type_ string, sourceCode SourceCode, id string, ) *ConnectorRuleUpdateRequest` + +NewConnectorRuleUpdateRequest instantiates a new ConnectorRuleUpdateRequest 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 + +### NewConnectorRuleUpdateRequestWithDefaults + +`func NewConnectorRuleUpdateRequestWithDefaults() *ConnectorRuleUpdateRequest` + +NewConnectorRuleUpdateRequestWithDefaults instantiates a new ConnectorRuleUpdateRequest 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 + +### GetName + +`func (o *ConnectorRuleUpdateRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorRuleUpdateRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorRuleUpdateRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *ConnectorRuleUpdateRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ConnectorRuleUpdateRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ConnectorRuleUpdateRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ConnectorRuleUpdateRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetType + +`func (o *ConnectorRuleUpdateRequest) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ConnectorRuleUpdateRequest) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ConnectorRuleUpdateRequest) SetType(v string)` + +SetType sets Type field to given value. + + +### GetSignature + +`func (o *ConnectorRuleUpdateRequest) GetSignature() ConnectorRuleCreateRequestSignature` + +GetSignature returns the Signature field if non-nil, zero value otherwise. + +### GetSignatureOk + +`func (o *ConnectorRuleUpdateRequest) GetSignatureOk() (*ConnectorRuleCreateRequestSignature, bool)` + +GetSignatureOk returns a tuple with the Signature field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignature + +`func (o *ConnectorRuleUpdateRequest) SetSignature(v ConnectorRuleCreateRequestSignature)` + +SetSignature sets Signature field to given value. + +### HasSignature + +`func (o *ConnectorRuleUpdateRequest) HasSignature() bool` + +HasSignature returns a boolean if a field has been set. + +### GetSourceCode + +`func (o *ConnectorRuleUpdateRequest) GetSourceCode() SourceCode` + +GetSourceCode returns the SourceCode field if non-nil, zero value otherwise. + +### GetSourceCodeOk + +`func (o *ConnectorRuleUpdateRequest) GetSourceCodeOk() (*SourceCode, bool)` + +GetSourceCodeOk returns a tuple with the SourceCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceCode + +`func (o *ConnectorRuleUpdateRequest) SetSourceCode(v SourceCode)` + +SetSourceCode sets SourceCode field to given value. + + +### GetAttributes + +`func (o *ConnectorRuleUpdateRequest) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ConnectorRuleUpdateRequest) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ConnectorRuleUpdateRequest) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ConnectorRuleUpdateRequest) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *ConnectorRuleUpdateRequest) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *ConnectorRuleUpdateRequest) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetId + +`func (o *ConnectorRuleUpdateRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ConnectorRuleUpdateRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ConnectorRuleUpdateRequest) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleValidationResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleValidationResponse.md new file mode 100644 index 000000000..9d2eed1ef --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleValidationResponse.md @@ -0,0 +1,80 @@ +--- +id: beta-connector-rule-validation-response +title: ConnectorRuleValidationResponse +pagination_label: ConnectorRuleValidationResponse +sidebar_label: ConnectorRuleValidationResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleValidationResponse', 'BetaConnectorRuleValidationResponse'] +slug: /tools/sdk/go/beta/models/connector-rule-validation-response +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleValidationResponse', 'BetaConnectorRuleValidationResponse'] +--- + +# ConnectorRuleValidationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | **string** | | +**Details** | [**[]ConnectorRuleValidationResponseDetailsInner**](connector-rule-validation-response-details-inner) | | + +## Methods + +### NewConnectorRuleValidationResponse + +`func NewConnectorRuleValidationResponse(state string, details []ConnectorRuleValidationResponseDetailsInner, ) *ConnectorRuleValidationResponse` + +NewConnectorRuleValidationResponse instantiates a new ConnectorRuleValidationResponse 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 + +### NewConnectorRuleValidationResponseWithDefaults + +`func NewConnectorRuleValidationResponseWithDefaults() *ConnectorRuleValidationResponse` + +NewConnectorRuleValidationResponseWithDefaults instantiates a new ConnectorRuleValidationResponse 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 + +### GetState + +`func (o *ConnectorRuleValidationResponse) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ConnectorRuleValidationResponse) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ConnectorRuleValidationResponse) SetState(v string)` + +SetState sets State field to given value. + + +### GetDetails + +`func (o *ConnectorRuleValidationResponse) GetDetails() []ConnectorRuleValidationResponseDetailsInner` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *ConnectorRuleValidationResponse) GetDetailsOk() (*[]ConnectorRuleValidationResponseDetailsInner, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *ConnectorRuleValidationResponse) SetDetails(v []ConnectorRuleValidationResponseDetailsInner)` + +SetDetails sets Details field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleValidationResponseDetailsInner.md b/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleValidationResponseDetailsInner.md new file mode 100644 index 000000000..080d49b98 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ConnectorRuleValidationResponseDetailsInner.md @@ -0,0 +1,106 @@ +--- +id: beta-connector-rule-validation-response-details-inner +title: ConnectorRuleValidationResponseDetailsInner +pagination_label: ConnectorRuleValidationResponseDetailsInner +sidebar_label: ConnectorRuleValidationResponseDetailsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleValidationResponseDetailsInner', 'BetaConnectorRuleValidationResponseDetailsInner'] +slug: /tools/sdk/go/beta/models/connector-rule-validation-response-details-inner +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleValidationResponseDetailsInner', 'BetaConnectorRuleValidationResponseDetailsInner'] +--- + +# ConnectorRuleValidationResponseDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Line** | **int32** | The line number where the issue occurred | +**Column** | **int32** | the column number where the issue occurred | +**Messsage** | Pointer to **string** | a description of the issue in the code | [optional] + +## Methods + +### NewConnectorRuleValidationResponseDetailsInner + +`func NewConnectorRuleValidationResponseDetailsInner(line int32, column int32, ) *ConnectorRuleValidationResponseDetailsInner` + +NewConnectorRuleValidationResponseDetailsInner instantiates a new ConnectorRuleValidationResponseDetailsInner 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 + +### NewConnectorRuleValidationResponseDetailsInnerWithDefaults + +`func NewConnectorRuleValidationResponseDetailsInnerWithDefaults() *ConnectorRuleValidationResponseDetailsInner` + +NewConnectorRuleValidationResponseDetailsInnerWithDefaults instantiates a new ConnectorRuleValidationResponseDetailsInner 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 + +### GetLine + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetLine() int32` + +GetLine returns the Line field if non-nil, zero value otherwise. + +### GetLineOk + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetLineOk() (*int32, bool)` + +GetLineOk returns a tuple with the Line field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLine + +`func (o *ConnectorRuleValidationResponseDetailsInner) SetLine(v int32)` + +SetLine sets Line field to given value. + + +### GetColumn + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetColumn() int32` + +GetColumn returns the Column field if non-nil, zero value otherwise. + +### GetColumnOk + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetColumnOk() (*int32, bool)` + +GetColumnOk returns a tuple with the Column field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumn + +`func (o *ConnectorRuleValidationResponseDetailsInner) SetColumn(v int32)` + +SetColumn sets Column field to given value. + + +### GetMesssage + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetMesssage() string` + +GetMesssage returns the Messsage field if non-nil, zero value otherwise. + +### GetMesssageOk + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetMesssageOk() (*string, bool)` + +GetMesssageOk returns a tuple with the Messsage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMesssage + +`func (o *ConnectorRuleValidationResponseDetailsInner) SetMesssage(v string)` + +SetMesssage sets Messsage field to given value. + +### HasMesssage + +`func (o *ConnectorRuleValidationResponseDetailsInner) HasMesssage() bool` + +HasMesssage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ContextAttributeDto.md b/docs/tools/sdk/go/Reference/Beta/Models/ContextAttributeDto.md new file mode 100644 index 000000000..2b77151b1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ContextAttributeDto.md @@ -0,0 +1,116 @@ +--- +id: beta-context-attribute-dto +title: ContextAttributeDto +pagination_label: ContextAttributeDto +sidebar_label: ContextAttributeDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ContextAttributeDto', 'BetaContextAttributeDto'] +slug: /tools/sdk/go/beta/models/context-attribute-dto +tags: ['SDK', 'Software Development Kit', 'ContextAttributeDto', 'BetaContextAttributeDto'] +--- + +# ContextAttributeDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | Pointer to **string** | The name of the attribute | [optional] +**Value** | Pointer to [**ContextAttributeDtoValue**](context-attribute-dto-value) | | [optional] +**Derived** | Pointer to **bool** | True if the attribute was derived. | [optional] [default to false] + +## Methods + +### NewContextAttributeDto + +`func NewContextAttributeDto() *ContextAttributeDto` + +NewContextAttributeDto instantiates a new ContextAttributeDto 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 + +### NewContextAttributeDtoWithDefaults + +`func NewContextAttributeDtoWithDefaults() *ContextAttributeDto` + +NewContextAttributeDtoWithDefaults instantiates a new ContextAttributeDto 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 + +### GetAttribute + +`func (o *ContextAttributeDto) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ContextAttributeDto) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ContextAttributeDto) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ContextAttributeDto) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *ContextAttributeDto) GetValue() ContextAttributeDtoValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ContextAttributeDto) GetValueOk() (*ContextAttributeDtoValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ContextAttributeDto) SetValue(v ContextAttributeDtoValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ContextAttributeDto) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetDerived + +`func (o *ContextAttributeDto) GetDerived() bool` + +GetDerived returns the Derived field if non-nil, zero value otherwise. + +### GetDerivedOk + +`func (o *ContextAttributeDto) GetDerivedOk() (*bool, bool)` + +GetDerivedOk returns a tuple with the Derived field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDerived + +`func (o *ContextAttributeDto) SetDerived(v bool)` + +SetDerived sets Derived field to given value. + +### HasDerived + +`func (o *ContextAttributeDto) HasDerived() bool` + +HasDerived returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ContextAttributeDtoValue.md b/docs/tools/sdk/go/Reference/Beta/Models/ContextAttributeDtoValue.md new file mode 100644 index 000000000..4e5189da8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ContextAttributeDtoValue.md @@ -0,0 +1,38 @@ +--- +id: beta-context-attribute-dto-value +title: ContextAttributeDtoValue +pagination_label: ContextAttributeDtoValue +sidebar_label: ContextAttributeDtoValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ContextAttributeDtoValue', 'BetaContextAttributeDtoValue'] +slug: /tools/sdk/go/beta/models/context-attribute-dto-value +tags: ['SDK', 'Software Development Kit', 'ContextAttributeDtoValue', 'BetaContextAttributeDtoValue'] +--- + +# ContextAttributeDtoValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewContextAttributeDtoValue + +`func NewContextAttributeDtoValue() *ContextAttributeDtoValue` + +NewContextAttributeDtoValue instantiates a new ContextAttributeDtoValue 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 + +### NewContextAttributeDtoValueWithDefaults + +`func NewContextAttributeDtoValueWithDefaults() *ContextAttributeDtoValue` + +NewContextAttributeDtoValueWithDefaults instantiates a new ContextAttributeDtoValue 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 + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CorrelatedGovernanceEvent.md b/docs/tools/sdk/go/Reference/Beta/Models/CorrelatedGovernanceEvent.md new file mode 100644 index 000000000..8e43644e9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CorrelatedGovernanceEvent.md @@ -0,0 +1,220 @@ +--- +id: beta-correlated-governance-event +title: CorrelatedGovernanceEvent +pagination_label: CorrelatedGovernanceEvent +sidebar_label: CorrelatedGovernanceEvent +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CorrelatedGovernanceEvent', 'BetaCorrelatedGovernanceEvent'] +slug: /tools/sdk/go/beta/models/correlated-governance-event +tags: ['SDK', 'Software Development Kit', 'CorrelatedGovernanceEvent', 'BetaCorrelatedGovernanceEvent'] +--- + +# CorrelatedGovernanceEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the governance event, such as the certification name or access request ID. | [optional] +**Dt** | Pointer to **string** | The date that the certification or access request was completed. | [optional] +**Type** | Pointer to **string** | The type of governance event. | [optional] +**GovernanceId** | Pointer to **string** | The ID of the instance that caused the event - either the certification ID or access request ID. | [optional] +**Owners** | Pointer to [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers) | [optional] +**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers), this field should be preferred over owners | [optional] +**DecisionMaker** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] + +## Methods + +### NewCorrelatedGovernanceEvent + +`func NewCorrelatedGovernanceEvent() *CorrelatedGovernanceEvent` + +NewCorrelatedGovernanceEvent instantiates a new CorrelatedGovernanceEvent 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 + +### NewCorrelatedGovernanceEventWithDefaults + +`func NewCorrelatedGovernanceEventWithDefaults() *CorrelatedGovernanceEvent` + +NewCorrelatedGovernanceEventWithDefaults instantiates a new CorrelatedGovernanceEvent 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 + +### GetName + +`func (o *CorrelatedGovernanceEvent) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CorrelatedGovernanceEvent) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CorrelatedGovernanceEvent) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CorrelatedGovernanceEvent) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDt + +`func (o *CorrelatedGovernanceEvent) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *CorrelatedGovernanceEvent) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *CorrelatedGovernanceEvent) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *CorrelatedGovernanceEvent) HasDt() bool` + +HasDt returns a boolean if a field has been set. + +### GetType + +`func (o *CorrelatedGovernanceEvent) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CorrelatedGovernanceEvent) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CorrelatedGovernanceEvent) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CorrelatedGovernanceEvent) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetGovernanceId + +`func (o *CorrelatedGovernanceEvent) GetGovernanceId() string` + +GetGovernanceId returns the GovernanceId field if non-nil, zero value otherwise. + +### GetGovernanceIdOk + +`func (o *CorrelatedGovernanceEvent) GetGovernanceIdOk() (*string, bool)` + +GetGovernanceIdOk returns a tuple with the GovernanceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceId + +`func (o *CorrelatedGovernanceEvent) SetGovernanceId(v string)` + +SetGovernanceId sets GovernanceId field to given value. + +### HasGovernanceId + +`func (o *CorrelatedGovernanceEvent) HasGovernanceId() bool` + +HasGovernanceId returns a boolean if a field has been set. + +### GetOwners + +`func (o *CorrelatedGovernanceEvent) GetOwners() []CertifierResponse` + +GetOwners returns the Owners field if non-nil, zero value otherwise. + +### GetOwnersOk + +`func (o *CorrelatedGovernanceEvent) GetOwnersOk() (*[]CertifierResponse, bool)` + +GetOwnersOk returns a tuple with the Owners field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwners + +`func (o *CorrelatedGovernanceEvent) SetOwners(v []CertifierResponse)` + +SetOwners sets Owners field to given value. + +### HasOwners + +`func (o *CorrelatedGovernanceEvent) HasOwners() bool` + +HasOwners returns a boolean if a field has been set. + +### GetReviewers + +`func (o *CorrelatedGovernanceEvent) GetReviewers() []CertifierResponse` + +GetReviewers returns the Reviewers field if non-nil, zero value otherwise. + +### GetReviewersOk + +`func (o *CorrelatedGovernanceEvent) GetReviewersOk() (*[]CertifierResponse, bool)` + +GetReviewersOk returns a tuple with the Reviewers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewers + +`func (o *CorrelatedGovernanceEvent) SetReviewers(v []CertifierResponse)` + +SetReviewers sets Reviewers field to given value. + +### HasReviewers + +`func (o *CorrelatedGovernanceEvent) HasReviewers() bool` + +HasReviewers returns a boolean if a field has been set. + +### GetDecisionMaker + +`func (o *CorrelatedGovernanceEvent) GetDecisionMaker() CertifierResponse` + +GetDecisionMaker returns the DecisionMaker field if non-nil, zero value otherwise. + +### GetDecisionMakerOk + +`func (o *CorrelatedGovernanceEvent) GetDecisionMakerOk() (*CertifierResponse, bool)` + +GetDecisionMakerOk returns a tuple with the DecisionMaker field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionMaker + +`func (o *CorrelatedGovernanceEvent) SetDecisionMaker(v CertifierResponse)` + +SetDecisionMaker sets DecisionMaker field to given value. + +### HasDecisionMaker + +`func (o *CorrelatedGovernanceEvent) HasDecisionMaker() bool` + +HasDecisionMaker returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CorrelationConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/CorrelationConfig.md new file mode 100644 index 000000000..60a9a3454 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CorrelationConfig.md @@ -0,0 +1,116 @@ +--- +id: beta-correlation-config +title: CorrelationConfig +pagination_label: CorrelationConfig +sidebar_label: CorrelationConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CorrelationConfig', 'BetaCorrelationConfig'] +slug: /tools/sdk/go/beta/models/correlation-config +tags: ['SDK', 'Software Development Kit', 'CorrelationConfig', 'BetaCorrelationConfig'] +--- + +# CorrelationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the correlation configuration. | [optional] +**Name** | Pointer to **string** | The name of the correlation configuration. | [optional] +**AttributeAssignments** | Pointer to [**[]CorrelationConfigAttributeAssignmentsInner**](correlation-config-attribute-assignments-inner) | The list of attribute assignments of the correlation configuration. | [optional] + +## Methods + +### NewCorrelationConfig + +`func NewCorrelationConfig() *CorrelationConfig` + +NewCorrelationConfig instantiates a new CorrelationConfig 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 + +### NewCorrelationConfigWithDefaults + +`func NewCorrelationConfigWithDefaults() *CorrelationConfig` + +NewCorrelationConfigWithDefaults instantiates a new CorrelationConfig 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 + +### GetId + +`func (o *CorrelationConfig) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CorrelationConfig) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CorrelationConfig) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CorrelationConfig) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CorrelationConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CorrelationConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CorrelationConfig) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CorrelationConfig) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAttributeAssignments + +`func (o *CorrelationConfig) GetAttributeAssignments() []CorrelationConfigAttributeAssignmentsInner` + +GetAttributeAssignments returns the AttributeAssignments field if non-nil, zero value otherwise. + +### GetAttributeAssignmentsOk + +`func (o *CorrelationConfig) GetAttributeAssignmentsOk() (*[]CorrelationConfigAttributeAssignmentsInner, bool)` + +GetAttributeAssignmentsOk returns a tuple with the AttributeAssignments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeAssignments + +`func (o *CorrelationConfig) SetAttributeAssignments(v []CorrelationConfigAttributeAssignmentsInner)` + +SetAttributeAssignments sets AttributeAssignments field to given value. + +### HasAttributeAssignments + +`func (o *CorrelationConfig) HasAttributeAssignments() bool` + +HasAttributeAssignments returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CorrelationConfigAttributeAssignmentsInner.md b/docs/tools/sdk/go/Reference/Beta/Models/CorrelationConfigAttributeAssignmentsInner.md new file mode 100644 index 000000000..0d0ff4a77 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CorrelationConfigAttributeAssignmentsInner.md @@ -0,0 +1,220 @@ +--- +id: beta-correlation-config-attribute-assignments-inner +title: CorrelationConfigAttributeAssignmentsInner +pagination_label: CorrelationConfigAttributeAssignmentsInner +sidebar_label: CorrelationConfigAttributeAssignmentsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CorrelationConfigAttributeAssignmentsInner', 'BetaCorrelationConfigAttributeAssignmentsInner'] +slug: /tools/sdk/go/beta/models/correlation-config-attribute-assignments-inner +tags: ['SDK', 'Software Development Kit', 'CorrelationConfigAttributeAssignmentsInner', 'BetaCorrelationConfigAttributeAssignmentsInner'] +--- + +# CorrelationConfigAttributeAssignmentsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Property** | Pointer to **string** | The property of the attribute assignment. | [optional] +**Value** | Pointer to **string** | The value of the attribute assignment. | [optional] +**Operation** | Pointer to **string** | The operation of the attribute assignment. | [optional] +**Complex** | Pointer to **bool** | Whether or not the it's a complex attribute assignment. | [optional] [default to false] +**IgnoreCase** | Pointer to **bool** | Whether or not the attribute assignment should ignore case. | [optional] [default to false] +**MatchMode** | Pointer to **string** | The match mode of the attribute assignment. | [optional] +**FilterString** | Pointer to **string** | The filter string of the attribute assignment. | [optional] + +## Methods + +### NewCorrelationConfigAttributeAssignmentsInner + +`func NewCorrelationConfigAttributeAssignmentsInner() *CorrelationConfigAttributeAssignmentsInner` + +NewCorrelationConfigAttributeAssignmentsInner instantiates a new CorrelationConfigAttributeAssignmentsInner 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 + +### NewCorrelationConfigAttributeAssignmentsInnerWithDefaults + +`func NewCorrelationConfigAttributeAssignmentsInnerWithDefaults() *CorrelationConfigAttributeAssignmentsInner` + +NewCorrelationConfigAttributeAssignmentsInnerWithDefaults instantiates a new CorrelationConfigAttributeAssignmentsInner 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 + +### GetProperty + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetProperty() string` + +GetProperty returns the Property field if non-nil, zero value otherwise. + +### GetPropertyOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetPropertyOk() (*string, bool)` + +GetPropertyOk returns a tuple with the Property field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperty + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetProperty(v string)` + +SetProperty sets Property field to given value. + +### HasProperty + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasProperty() bool` + +HasProperty returns a boolean if a field has been set. + +### GetValue + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetOperation + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetComplex + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetComplex() bool` + +GetComplex returns the Complex field if non-nil, zero value otherwise. + +### GetComplexOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetComplexOk() (*bool, bool)` + +GetComplexOk returns a tuple with the Complex field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComplex + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetComplex(v bool)` + +SetComplex sets Complex field to given value. + +### HasComplex + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasComplex() bool` + +HasComplex returns a boolean if a field has been set. + +### GetIgnoreCase + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetIgnoreCase() bool` + +GetIgnoreCase returns the IgnoreCase field if non-nil, zero value otherwise. + +### GetIgnoreCaseOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetIgnoreCaseOk() (*bool, bool)` + +GetIgnoreCaseOk returns a tuple with the IgnoreCase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIgnoreCase + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetIgnoreCase(v bool)` + +SetIgnoreCase sets IgnoreCase field to given value. + +### HasIgnoreCase + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasIgnoreCase() bool` + +HasIgnoreCase returns a boolean if a field has been set. + +### GetMatchMode + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetMatchMode() string` + +GetMatchMode returns the MatchMode field if non-nil, zero value otherwise. + +### GetMatchModeOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetMatchModeOk() (*string, bool)` + +GetMatchModeOk returns a tuple with the MatchMode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchMode + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetMatchMode(v string)` + +SetMatchMode sets MatchMode field to given value. + +### HasMatchMode + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasMatchMode() bool` + +HasMatchMode returns a boolean if a field has been set. + +### GetFilterString + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetFilterString() string` + +GetFilterString returns the FilterString field if non-nil, zero value otherwise. + +### GetFilterStringOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetFilterStringOk() (*string, bool)` + +GetFilterStringOk returns a tuple with the FilterString field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilterString + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetFilterString(v string)` + +SetFilterString sets FilterString field to given value. + +### HasFilterString + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasFilterString() bool` + +HasFilterString returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CreateDomainDkim405Response.md b/docs/tools/sdk/go/Reference/Beta/Models/CreateDomainDkim405Response.md new file mode 100644 index 000000000..32cd4e50e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CreateDomainDkim405Response.md @@ -0,0 +1,116 @@ +--- +id: beta-create-domain-dkim405-response +title: CreateDomainDkim405Response +pagination_label: CreateDomainDkim405Response +sidebar_label: CreateDomainDkim405Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateDomainDkim405Response', 'BetaCreateDomainDkim405Response'] +slug: /tools/sdk/go/beta/models/create-domain-dkim405-response +tags: ['SDK', 'Software Development Kit', 'CreateDomainDkim405Response', 'BetaCreateDomainDkim405Response'] +--- + +# CreateDomainDkim405Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ErrorName** | Pointer to **map[string]interface{}** | A message describing the error | [optional] +**ErrorMessage** | Pointer to **map[string]interface{}** | Description of the error | [optional] +**TrackingId** | Pointer to **string** | Unique tracking id for the error. | [optional] + +## Methods + +### NewCreateDomainDkim405Response + +`func NewCreateDomainDkim405Response() *CreateDomainDkim405Response` + +NewCreateDomainDkim405Response instantiates a new CreateDomainDkim405Response 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 + +### NewCreateDomainDkim405ResponseWithDefaults + +`func NewCreateDomainDkim405ResponseWithDefaults() *CreateDomainDkim405Response` + +NewCreateDomainDkim405ResponseWithDefaults instantiates a new CreateDomainDkim405Response 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 + +### GetErrorName + +`func (o *CreateDomainDkim405Response) GetErrorName() map[string]interface{}` + +GetErrorName returns the ErrorName field if non-nil, zero value otherwise. + +### GetErrorNameOk + +`func (o *CreateDomainDkim405Response) GetErrorNameOk() (*map[string]interface{}, bool)` + +GetErrorNameOk returns a tuple with the ErrorName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorName + +`func (o *CreateDomainDkim405Response) SetErrorName(v map[string]interface{})` + +SetErrorName sets ErrorName field to given value. + +### HasErrorName + +`func (o *CreateDomainDkim405Response) HasErrorName() bool` + +HasErrorName returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *CreateDomainDkim405Response) GetErrorMessage() map[string]interface{}` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *CreateDomainDkim405Response) GetErrorMessageOk() (*map[string]interface{}, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *CreateDomainDkim405Response) SetErrorMessage(v map[string]interface{})` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *CreateDomainDkim405Response) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetTrackingId + +`func (o *CreateDomainDkim405Response) GetTrackingId() string` + +GetTrackingId returns the TrackingId field if non-nil, zero value otherwise. + +### GetTrackingIdOk + +`func (o *CreateDomainDkim405Response) GetTrackingIdOk() (*string, bool)` + +GetTrackingIdOk returns a tuple with the TrackingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingId + +`func (o *CreateDomainDkim405Response) SetTrackingId(v string)` + +SetTrackingId sets TrackingId field to given value. + +### HasTrackingId + +`func (o *CreateDomainDkim405Response) HasTrackingId() bool` + +HasTrackingId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CreateFormDefinitionFileRequestRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/CreateFormDefinitionFileRequestRequest.md new file mode 100644 index 000000000..9fcddcc64 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CreateFormDefinitionFileRequestRequest.md @@ -0,0 +1,59 @@ +--- +id: beta-create-form-definition-file-request-request +title: CreateFormDefinitionFileRequestRequest +pagination_label: CreateFormDefinitionFileRequestRequest +sidebar_label: CreateFormDefinitionFileRequestRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateFormDefinitionFileRequestRequest', 'BetaCreateFormDefinitionFileRequestRequest'] +slug: /tools/sdk/go/beta/models/create-form-definition-file-request-request +tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionFileRequestRequest', 'BetaCreateFormDefinitionFileRequestRequest'] +--- + +# CreateFormDefinitionFileRequestRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | ***os.File** | File specifying the multipart | + +## Methods + +### NewCreateFormDefinitionFileRequestRequest + +`func NewCreateFormDefinitionFileRequestRequest(file *os.File, ) *CreateFormDefinitionFileRequestRequest` + +NewCreateFormDefinitionFileRequestRequest instantiates a new CreateFormDefinitionFileRequestRequest 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 + +### NewCreateFormDefinitionFileRequestRequestWithDefaults + +`func NewCreateFormDefinitionFileRequestRequestWithDefaults() *CreateFormDefinitionFileRequestRequest` + +NewCreateFormDefinitionFileRequestRequestWithDefaults instantiates a new CreateFormDefinitionFileRequestRequest 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 + +### GetFile + +`func (o *CreateFormDefinitionFileRequestRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *CreateFormDefinitionFileRequestRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *CreateFormDefinitionFileRequestRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CreateFormDefinitionRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/CreateFormDefinitionRequest.md new file mode 100644 index 000000000..e1b553df9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CreateFormDefinitionRequest.md @@ -0,0 +1,210 @@ +--- +id: beta-create-form-definition-request +title: CreateFormDefinitionRequest +pagination_label: CreateFormDefinitionRequest +sidebar_label: CreateFormDefinitionRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateFormDefinitionRequest', 'BetaCreateFormDefinitionRequest'] +slug: /tools/sdk/go/beta/models/create-form-definition-request +tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionRequest', 'BetaCreateFormDefinitionRequest'] +--- + +# CreateFormDefinitionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Description is the form definition description | [optional] +**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**FormElements** | Pointer to [**[]FormElement**](form-element) | FormElements is a list of nested form elements | [optional] +**FormInput** | Pointer to [**[]FormDefinitionInput**](form-definition-input) | FormInput is a list of form inputs that are required when creating a form-instance object | [optional] +**Name** | **string** | Name is the form definition name | +**Owner** | [**FormOwner**](form-owner) | | +**UsedBy** | Pointer to [**[]FormUsedBy**](form-used-by) | UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used | [optional] + +## Methods + +### NewCreateFormDefinitionRequest + +`func NewCreateFormDefinitionRequest(name string, owner FormOwner, ) *CreateFormDefinitionRequest` + +NewCreateFormDefinitionRequest instantiates a new CreateFormDefinitionRequest 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 + +### NewCreateFormDefinitionRequestWithDefaults + +`func NewCreateFormDefinitionRequestWithDefaults() *CreateFormDefinitionRequest` + +NewCreateFormDefinitionRequestWithDefaults instantiates a new CreateFormDefinitionRequest 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 + +### GetDescription + +`func (o *CreateFormDefinitionRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateFormDefinitionRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateFormDefinitionRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CreateFormDefinitionRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetFormConditions + +`func (o *CreateFormDefinitionRequest) GetFormConditions() []FormCondition` + +GetFormConditions returns the FormConditions field if non-nil, zero value otherwise. + +### GetFormConditionsOk + +`func (o *CreateFormDefinitionRequest) GetFormConditionsOk() (*[]FormCondition, bool)` + +GetFormConditionsOk returns a tuple with the FormConditions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormConditions + +`func (o *CreateFormDefinitionRequest) SetFormConditions(v []FormCondition)` + +SetFormConditions sets FormConditions field to given value. + +### HasFormConditions + +`func (o *CreateFormDefinitionRequest) HasFormConditions() bool` + +HasFormConditions returns a boolean if a field has been set. + +### GetFormElements + +`func (o *CreateFormDefinitionRequest) GetFormElements() []FormElement` + +GetFormElements returns the FormElements field if non-nil, zero value otherwise. + +### GetFormElementsOk + +`func (o *CreateFormDefinitionRequest) GetFormElementsOk() (*[]FormElement, bool)` + +GetFormElementsOk returns a tuple with the FormElements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormElements + +`func (o *CreateFormDefinitionRequest) SetFormElements(v []FormElement)` + +SetFormElements sets FormElements field to given value. + +### HasFormElements + +`func (o *CreateFormDefinitionRequest) HasFormElements() bool` + +HasFormElements returns a boolean if a field has been set. + +### GetFormInput + +`func (o *CreateFormDefinitionRequest) GetFormInput() []FormDefinitionInput` + +GetFormInput returns the FormInput field if non-nil, zero value otherwise. + +### GetFormInputOk + +`func (o *CreateFormDefinitionRequest) GetFormInputOk() (*[]FormDefinitionInput, bool)` + +GetFormInputOk returns a tuple with the FormInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormInput + +`func (o *CreateFormDefinitionRequest) SetFormInput(v []FormDefinitionInput)` + +SetFormInput sets FormInput field to given value. + +### HasFormInput + +`func (o *CreateFormDefinitionRequest) HasFormInput() bool` + +HasFormInput returns a boolean if a field has been set. + +### GetName + +`func (o *CreateFormDefinitionRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateFormDefinitionRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateFormDefinitionRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetOwner + +`func (o *CreateFormDefinitionRequest) GetOwner() FormOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CreateFormDefinitionRequest) GetOwnerOk() (*FormOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CreateFormDefinitionRequest) SetOwner(v FormOwner)` + +SetOwner sets Owner field to given value. + + +### GetUsedBy + +`func (o *CreateFormDefinitionRequest) GetUsedBy() []FormUsedBy` + +GetUsedBy returns the UsedBy field if non-nil, zero value otherwise. + +### GetUsedByOk + +`func (o *CreateFormDefinitionRequest) GetUsedByOk() (*[]FormUsedBy, bool)` + +GetUsedByOk returns a tuple with the UsedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsedBy + +`func (o *CreateFormDefinitionRequest) SetUsedBy(v []FormUsedBy)` + +SetUsedBy sets UsedBy field to given value. + +### HasUsedBy + +`func (o *CreateFormDefinitionRequest) HasUsedBy() bool` + +HasUsedBy returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CreateFormInstanceRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/CreateFormInstanceRequest.md new file mode 100644 index 000000000..8bbb2cb65 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CreateFormInstanceRequest.md @@ -0,0 +1,226 @@ +--- +id: beta-create-form-instance-request +title: CreateFormInstanceRequest +pagination_label: CreateFormInstanceRequest +sidebar_label: CreateFormInstanceRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateFormInstanceRequest', 'BetaCreateFormInstanceRequest'] +slug: /tools/sdk/go/beta/models/create-form-instance-request +tags: ['SDK', 'Software Development Kit', 'CreateFormInstanceRequest', 'BetaCreateFormInstanceRequest'] +--- + +# CreateFormInstanceRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedBy** | [**FormInstanceCreatedBy**](form-instance-created-by) | | +**Expire** | **string** | Expire is required | +**FormDefinitionId** | **string** | FormDefinitionID is the id of the form definition that created this form | +**FormInput** | Pointer to **map[string]interface{}** | FormInput is an object of form input labels to value | [optional] +**Recipients** | [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients is required | +**StandAloneForm** | Pointer to **bool** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to false] +**State** | Pointer to **string** | State is required, if not present initial state is FormInstanceStateAssigned ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] +**Ttl** | Pointer to **int64** | TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html | [optional] + +## Methods + +### NewCreateFormInstanceRequest + +`func NewCreateFormInstanceRequest(createdBy FormInstanceCreatedBy, expire string, formDefinitionId string, recipients []FormInstanceRecipient, ) *CreateFormInstanceRequest` + +NewCreateFormInstanceRequest instantiates a new CreateFormInstanceRequest 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 + +### NewCreateFormInstanceRequestWithDefaults + +`func NewCreateFormInstanceRequestWithDefaults() *CreateFormInstanceRequest` + +NewCreateFormInstanceRequestWithDefaults instantiates a new CreateFormInstanceRequest 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 + +### GetCreatedBy + +`func (o *CreateFormInstanceRequest) GetCreatedBy() FormInstanceCreatedBy` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *CreateFormInstanceRequest) GetCreatedByOk() (*FormInstanceCreatedBy, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *CreateFormInstanceRequest) SetCreatedBy(v FormInstanceCreatedBy)` + +SetCreatedBy sets CreatedBy field to given value. + + +### GetExpire + +`func (o *CreateFormInstanceRequest) GetExpire() string` + +GetExpire returns the Expire field if non-nil, zero value otherwise. + +### GetExpireOk + +`func (o *CreateFormInstanceRequest) GetExpireOk() (*string, bool)` + +GetExpireOk returns a tuple with the Expire field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpire + +`func (o *CreateFormInstanceRequest) SetExpire(v string)` + +SetExpire sets Expire field to given value. + + +### GetFormDefinitionId + +`func (o *CreateFormInstanceRequest) GetFormDefinitionId() string` + +GetFormDefinitionId returns the FormDefinitionId field if non-nil, zero value otherwise. + +### GetFormDefinitionIdOk + +`func (o *CreateFormInstanceRequest) GetFormDefinitionIdOk() (*string, bool)` + +GetFormDefinitionIdOk returns a tuple with the FormDefinitionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormDefinitionId + +`func (o *CreateFormInstanceRequest) SetFormDefinitionId(v string)` + +SetFormDefinitionId sets FormDefinitionId field to given value. + + +### GetFormInput + +`func (o *CreateFormInstanceRequest) GetFormInput() map[string]interface{}` + +GetFormInput returns the FormInput field if non-nil, zero value otherwise. + +### GetFormInputOk + +`func (o *CreateFormInstanceRequest) GetFormInputOk() (*map[string]interface{}, bool)` + +GetFormInputOk returns a tuple with the FormInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormInput + +`func (o *CreateFormInstanceRequest) SetFormInput(v map[string]interface{})` + +SetFormInput sets FormInput field to given value. + +### HasFormInput + +`func (o *CreateFormInstanceRequest) HasFormInput() bool` + +HasFormInput returns a boolean if a field has been set. + +### GetRecipients + +`func (o *CreateFormInstanceRequest) GetRecipients() []FormInstanceRecipient` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *CreateFormInstanceRequest) GetRecipientsOk() (*[]FormInstanceRecipient, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *CreateFormInstanceRequest) SetRecipients(v []FormInstanceRecipient)` + +SetRecipients sets Recipients field to given value. + + +### GetStandAloneForm + +`func (o *CreateFormInstanceRequest) GetStandAloneForm() bool` + +GetStandAloneForm returns the StandAloneForm field if non-nil, zero value otherwise. + +### GetStandAloneFormOk + +`func (o *CreateFormInstanceRequest) GetStandAloneFormOk() (*bool, bool)` + +GetStandAloneFormOk returns a tuple with the StandAloneForm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandAloneForm + +`func (o *CreateFormInstanceRequest) SetStandAloneForm(v bool)` + +SetStandAloneForm sets StandAloneForm field to given value. + +### HasStandAloneForm + +`func (o *CreateFormInstanceRequest) HasStandAloneForm() bool` + +HasStandAloneForm returns a boolean if a field has been set. + +### GetState + +`func (o *CreateFormInstanceRequest) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *CreateFormInstanceRequest) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *CreateFormInstanceRequest) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *CreateFormInstanceRequest) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetTtl + +`func (o *CreateFormInstanceRequest) GetTtl() int64` + +GetTtl returns the Ttl field if non-nil, zero value otherwise. + +### GetTtlOk + +`func (o *CreateFormInstanceRequest) GetTtlOk() (*int64, bool)` + +GetTtlOk returns a tuple with the Ttl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTtl + +`func (o *CreateFormInstanceRequest) SetTtl(v int64)` + +SetTtl sets Ttl field to given value. + +### HasTtl + +`func (o *CreateFormInstanceRequest) HasTtl() bool` + +HasTtl returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CreateOAuthClientRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/CreateOAuthClientRequest.md new file mode 100644 index 000000000..41f49474a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CreateOAuthClientRequest.md @@ -0,0 +1,468 @@ +--- +id: beta-create-o-auth-client-request +title: CreateOAuthClientRequest +pagination_label: CreateOAuthClientRequest +sidebar_label: CreateOAuthClientRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateOAuthClientRequest', 'BetaCreateOAuthClientRequest'] +slug: /tools/sdk/go/beta/models/create-o-auth-client-request +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientRequest', 'BetaCreateOAuthClientRequest'] +--- + +# CreateOAuthClientRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BusinessName** | Pointer to **NullableString** | The name of the business the API Client should belong to | [optional] +**HomepageUrl** | Pointer to **NullableString** | The homepage URL associated with the owner of the API Client | [optional] +**Name** | **NullableString** | A human-readable name for the API Client | +**Description** | **NullableString** | A description of the API Client | +**AccessTokenValiditySeconds** | **int32** | The number of seconds an access token generated for this API Client is valid for | +**RefreshTokenValiditySeconds** | Pointer to **int32** | The number of seconds a refresh token generated for this API Client is valid for | [optional] +**RedirectUris** | Pointer to **[]string** | A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. | [optional] +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | +**AccessType** | [**AccessType**](access-type) | | +**Type** | Pointer to [**ClientType**](client-type) | | [optional] +**Internal** | Pointer to **bool** | An indicator of whether the API Client can be used for requests internal within the product. | [optional] +**Enabled** | **bool** | An indicator of whether the API Client is enabled for use | +**StrongAuthSupported** | Pointer to **bool** | An indicator of whether the API Client supports strong authentication | [optional] +**ClaimsSupported** | Pointer to **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [optional] +**Scope** | Pointer to **[]string** | Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it. | [optional] + +## Methods + +### NewCreateOAuthClientRequest + +`func NewCreateOAuthClientRequest(name NullableString, description NullableString, accessTokenValiditySeconds int32, grantTypes []GrantType, accessType AccessType, enabled bool, ) *CreateOAuthClientRequest` + +NewCreateOAuthClientRequest instantiates a new CreateOAuthClientRequest 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 + +### NewCreateOAuthClientRequestWithDefaults + +`func NewCreateOAuthClientRequestWithDefaults() *CreateOAuthClientRequest` + +NewCreateOAuthClientRequestWithDefaults instantiates a new CreateOAuthClientRequest 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 + +### GetBusinessName + +`func (o *CreateOAuthClientRequest) GetBusinessName() string` + +GetBusinessName returns the BusinessName field if non-nil, zero value otherwise. + +### GetBusinessNameOk + +`func (o *CreateOAuthClientRequest) GetBusinessNameOk() (*string, bool)` + +GetBusinessNameOk returns a tuple with the BusinessName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBusinessName + +`func (o *CreateOAuthClientRequest) SetBusinessName(v string)` + +SetBusinessName sets BusinessName field to given value. + +### HasBusinessName + +`func (o *CreateOAuthClientRequest) HasBusinessName() bool` + +HasBusinessName returns a boolean if a field has been set. + +### SetBusinessNameNil + +`func (o *CreateOAuthClientRequest) SetBusinessNameNil(b bool)` + + SetBusinessNameNil sets the value for BusinessName to be an explicit nil + +### UnsetBusinessName +`func (o *CreateOAuthClientRequest) UnsetBusinessName()` + +UnsetBusinessName ensures that no value is present for BusinessName, not even an explicit nil +### GetHomepageUrl + +`func (o *CreateOAuthClientRequest) GetHomepageUrl() string` + +GetHomepageUrl returns the HomepageUrl field if non-nil, zero value otherwise. + +### GetHomepageUrlOk + +`func (o *CreateOAuthClientRequest) GetHomepageUrlOk() (*string, bool)` + +GetHomepageUrlOk returns a tuple with the HomepageUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHomepageUrl + +`func (o *CreateOAuthClientRequest) SetHomepageUrl(v string)` + +SetHomepageUrl sets HomepageUrl field to given value. + +### HasHomepageUrl + +`func (o *CreateOAuthClientRequest) HasHomepageUrl() bool` + +HasHomepageUrl returns a boolean if a field has been set. + +### SetHomepageUrlNil + +`func (o *CreateOAuthClientRequest) SetHomepageUrlNil(b bool)` + + SetHomepageUrlNil sets the value for HomepageUrl to be an explicit nil + +### UnsetHomepageUrl +`func (o *CreateOAuthClientRequest) UnsetHomepageUrl()` + +UnsetHomepageUrl ensures that no value is present for HomepageUrl, not even an explicit nil +### GetName + +`func (o *CreateOAuthClientRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateOAuthClientRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateOAuthClientRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *CreateOAuthClientRequest) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *CreateOAuthClientRequest) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *CreateOAuthClientRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateOAuthClientRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateOAuthClientRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *CreateOAuthClientRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CreateOAuthClientRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAccessTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *CreateOAuthClientRequest) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + + +### GetRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) GetRefreshTokenValiditySeconds() int32` + +GetRefreshTokenValiditySeconds returns the RefreshTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetRefreshTokenValiditySecondsOk + +`func (o *CreateOAuthClientRequest) GetRefreshTokenValiditySecondsOk() (*int32, bool)` + +GetRefreshTokenValiditySecondsOk returns a tuple with the RefreshTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) SetRefreshTokenValiditySeconds(v int32)` + +SetRefreshTokenValiditySeconds sets RefreshTokenValiditySeconds field to given value. + +### HasRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) HasRefreshTokenValiditySeconds() bool` + +HasRefreshTokenValiditySeconds returns a boolean if a field has been set. + +### GetRedirectUris + +`func (o *CreateOAuthClientRequest) GetRedirectUris() []string` + +GetRedirectUris returns the RedirectUris field if non-nil, zero value otherwise. + +### GetRedirectUrisOk + +`func (o *CreateOAuthClientRequest) GetRedirectUrisOk() (*[]string, bool)` + +GetRedirectUrisOk returns a tuple with the RedirectUris field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedirectUris + +`func (o *CreateOAuthClientRequest) SetRedirectUris(v []string)` + +SetRedirectUris sets RedirectUris field to given value. + +### HasRedirectUris + +`func (o *CreateOAuthClientRequest) HasRedirectUris() bool` + +HasRedirectUris returns a boolean if a field has been set. + +### SetRedirectUrisNil + +`func (o *CreateOAuthClientRequest) SetRedirectUrisNil(b bool)` + + SetRedirectUrisNil sets the value for RedirectUris to be an explicit nil + +### UnsetRedirectUris +`func (o *CreateOAuthClientRequest) UnsetRedirectUris()` + +UnsetRedirectUris ensures that no value is present for RedirectUris, not even an explicit nil +### GetGrantTypes + +`func (o *CreateOAuthClientRequest) GetGrantTypes() []GrantType` + +GetGrantTypes returns the GrantTypes field if non-nil, zero value otherwise. + +### GetGrantTypesOk + +`func (o *CreateOAuthClientRequest) GetGrantTypesOk() (*[]GrantType, bool)` + +GetGrantTypesOk returns a tuple with the GrantTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantTypes + +`func (o *CreateOAuthClientRequest) SetGrantTypes(v []GrantType)` + +SetGrantTypes sets GrantTypes field to given value. + + +### SetGrantTypesNil + +`func (o *CreateOAuthClientRequest) SetGrantTypesNil(b bool)` + + SetGrantTypesNil sets the value for GrantTypes to be an explicit nil + +### UnsetGrantTypes +`func (o *CreateOAuthClientRequest) UnsetGrantTypes()` + +UnsetGrantTypes ensures that no value is present for GrantTypes, not even an explicit nil +### GetAccessType + +`func (o *CreateOAuthClientRequest) GetAccessType() AccessType` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *CreateOAuthClientRequest) GetAccessTypeOk() (*AccessType, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *CreateOAuthClientRequest) SetAccessType(v AccessType)` + +SetAccessType sets AccessType field to given value. + + +### GetType + +`func (o *CreateOAuthClientRequest) GetType() ClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CreateOAuthClientRequest) GetTypeOk() (*ClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CreateOAuthClientRequest) SetType(v ClientType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CreateOAuthClientRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetInternal + +`func (o *CreateOAuthClientRequest) GetInternal() bool` + +GetInternal returns the Internal field if non-nil, zero value otherwise. + +### GetInternalOk + +`func (o *CreateOAuthClientRequest) GetInternalOk() (*bool, bool)` + +GetInternalOk returns a tuple with the Internal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternal + +`func (o *CreateOAuthClientRequest) SetInternal(v bool)` + +SetInternal sets Internal field to given value. + +### HasInternal + +`func (o *CreateOAuthClientRequest) HasInternal() bool` + +HasInternal returns a boolean if a field has been set. + +### GetEnabled + +`func (o *CreateOAuthClientRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CreateOAuthClientRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *CreateOAuthClientRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetStrongAuthSupported + +`func (o *CreateOAuthClientRequest) GetStrongAuthSupported() bool` + +GetStrongAuthSupported returns the StrongAuthSupported field if non-nil, zero value otherwise. + +### GetStrongAuthSupportedOk + +`func (o *CreateOAuthClientRequest) GetStrongAuthSupportedOk() (*bool, bool)` + +GetStrongAuthSupportedOk returns a tuple with the StrongAuthSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStrongAuthSupported + +`func (o *CreateOAuthClientRequest) SetStrongAuthSupported(v bool)` + +SetStrongAuthSupported sets StrongAuthSupported field to given value. + +### HasStrongAuthSupported + +`func (o *CreateOAuthClientRequest) HasStrongAuthSupported() bool` + +HasStrongAuthSupported returns a boolean if a field has been set. + +### GetClaimsSupported + +`func (o *CreateOAuthClientRequest) GetClaimsSupported() bool` + +GetClaimsSupported returns the ClaimsSupported field if non-nil, zero value otherwise. + +### GetClaimsSupportedOk + +`func (o *CreateOAuthClientRequest) GetClaimsSupportedOk() (*bool, bool)` + +GetClaimsSupportedOk returns a tuple with the ClaimsSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClaimsSupported + +`func (o *CreateOAuthClientRequest) SetClaimsSupported(v bool)` + +SetClaimsSupported sets ClaimsSupported field to given value. + +### HasClaimsSupported + +`func (o *CreateOAuthClientRequest) HasClaimsSupported() bool` + +HasClaimsSupported returns a boolean if a field has been set. + +### GetScope + +`func (o *CreateOAuthClientRequest) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *CreateOAuthClientRequest) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *CreateOAuthClientRequest) SetScope(v []string)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *CreateOAuthClientRequest) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### SetScopeNil + +`func (o *CreateOAuthClientRequest) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *CreateOAuthClientRequest) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CreateOAuthClientResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/CreateOAuthClientResponse.md new file mode 100644 index 000000000..704c74398 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CreateOAuthClientResponse.md @@ -0,0 +1,447 @@ +--- +id: beta-create-o-auth-client-response +title: CreateOAuthClientResponse +pagination_label: CreateOAuthClientResponse +sidebar_label: CreateOAuthClientResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateOAuthClientResponse', 'BetaCreateOAuthClientResponse'] +slug: /tools/sdk/go/beta/models/create-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientResponse', 'BetaCreateOAuthClientResponse'] +--- + +# CreateOAuthClientResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the OAuth client | +**Secret** | **string** | Secret of the OAuth client (This field is only returned on the intial create call.) | +**BusinessName** | **string** | The name of the business the API Client should belong to | +**HomepageUrl** | **string** | The homepage URL associated with the owner of the API Client | +**Name** | **string** | A human-readable name for the API Client | +**Description** | **string** | A description of the API Client | +**AccessTokenValiditySeconds** | **int32** | The number of seconds an access token generated for this API Client is valid for | +**RefreshTokenValiditySeconds** | **int32** | The number of seconds a refresh token generated for this API Client is valid for | +**RedirectUris** | **[]string** | A list of the approved redirect URIs used with the authorization_code flow | +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | +**AccessType** | [**AccessType**](access-type) | | +**Type** | [**ClientType**](client-type) | | +**Internal** | **bool** | An indicator of whether the API Client can be used for requests internal to IDN | +**Enabled** | **bool** | An indicator of whether the API Client is enabled for use | +**StrongAuthSupported** | **bool** | An indicator of whether the API Client supports strong authentication | +**ClaimsSupported** | **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | +**Created** | **SailPointTime** | The date and time, down to the millisecond, when the API Client was created | +**Modified** | **SailPointTime** | The date and time, down to the millisecond, when the API Client was last updated | +**Scope** | **[]string** | Scopes of the API Client. | + +## Methods + +### NewCreateOAuthClientResponse + +`func NewCreateOAuthClientResponse(id string, secret string, businessName string, homepageUrl string, name string, description string, accessTokenValiditySeconds int32, refreshTokenValiditySeconds int32, redirectUris []string, grantTypes []GrantType, accessType AccessType, type_ ClientType, internal bool, enabled bool, strongAuthSupported bool, claimsSupported bool, created SailPointTime, modified SailPointTime, scope []string, ) *CreateOAuthClientResponse` + +NewCreateOAuthClientResponse instantiates a new CreateOAuthClientResponse 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 + +### NewCreateOAuthClientResponseWithDefaults + +`func NewCreateOAuthClientResponseWithDefaults() *CreateOAuthClientResponse` + +NewCreateOAuthClientResponseWithDefaults instantiates a new CreateOAuthClientResponse 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 + +### GetId + +`func (o *CreateOAuthClientResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CreateOAuthClientResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CreateOAuthClientResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetSecret + +`func (o *CreateOAuthClientResponse) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *CreateOAuthClientResponse) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *CreateOAuthClientResponse) SetSecret(v string)` + +SetSecret sets Secret field to given value. + + +### GetBusinessName + +`func (o *CreateOAuthClientResponse) GetBusinessName() string` + +GetBusinessName returns the BusinessName field if non-nil, zero value otherwise. + +### GetBusinessNameOk + +`func (o *CreateOAuthClientResponse) GetBusinessNameOk() (*string, bool)` + +GetBusinessNameOk returns a tuple with the BusinessName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBusinessName + +`func (o *CreateOAuthClientResponse) SetBusinessName(v string)` + +SetBusinessName sets BusinessName field to given value. + + +### GetHomepageUrl + +`func (o *CreateOAuthClientResponse) GetHomepageUrl() string` + +GetHomepageUrl returns the HomepageUrl field if non-nil, zero value otherwise. + +### GetHomepageUrlOk + +`func (o *CreateOAuthClientResponse) GetHomepageUrlOk() (*string, bool)` + +GetHomepageUrlOk returns a tuple with the HomepageUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHomepageUrl + +`func (o *CreateOAuthClientResponse) SetHomepageUrl(v string)` + +SetHomepageUrl sets HomepageUrl field to given value. + + +### GetName + +`func (o *CreateOAuthClientResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateOAuthClientResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateOAuthClientResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CreateOAuthClientResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateOAuthClientResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateOAuthClientResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetAccessTokenValiditySeconds + +`func (o *CreateOAuthClientResponse) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *CreateOAuthClientResponse) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *CreateOAuthClientResponse) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + + +### GetRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientResponse) GetRefreshTokenValiditySeconds() int32` + +GetRefreshTokenValiditySeconds returns the RefreshTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetRefreshTokenValiditySecondsOk + +`func (o *CreateOAuthClientResponse) GetRefreshTokenValiditySecondsOk() (*int32, bool)` + +GetRefreshTokenValiditySecondsOk returns a tuple with the RefreshTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientResponse) SetRefreshTokenValiditySeconds(v int32)` + +SetRefreshTokenValiditySeconds sets RefreshTokenValiditySeconds field to given value. + + +### GetRedirectUris + +`func (o *CreateOAuthClientResponse) GetRedirectUris() []string` + +GetRedirectUris returns the RedirectUris field if non-nil, zero value otherwise. + +### GetRedirectUrisOk + +`func (o *CreateOAuthClientResponse) GetRedirectUrisOk() (*[]string, bool)` + +GetRedirectUrisOk returns a tuple with the RedirectUris field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedirectUris + +`func (o *CreateOAuthClientResponse) SetRedirectUris(v []string)` + +SetRedirectUris sets RedirectUris field to given value. + + +### GetGrantTypes + +`func (o *CreateOAuthClientResponse) GetGrantTypes() []GrantType` + +GetGrantTypes returns the GrantTypes field if non-nil, zero value otherwise. + +### GetGrantTypesOk + +`func (o *CreateOAuthClientResponse) GetGrantTypesOk() (*[]GrantType, bool)` + +GetGrantTypesOk returns a tuple with the GrantTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantTypes + +`func (o *CreateOAuthClientResponse) SetGrantTypes(v []GrantType)` + +SetGrantTypes sets GrantTypes field to given value. + + +### GetAccessType + +`func (o *CreateOAuthClientResponse) GetAccessType() AccessType` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *CreateOAuthClientResponse) GetAccessTypeOk() (*AccessType, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *CreateOAuthClientResponse) SetAccessType(v AccessType)` + +SetAccessType sets AccessType field to given value. + + +### GetType + +`func (o *CreateOAuthClientResponse) GetType() ClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CreateOAuthClientResponse) GetTypeOk() (*ClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CreateOAuthClientResponse) SetType(v ClientType)` + +SetType sets Type field to given value. + + +### GetInternal + +`func (o *CreateOAuthClientResponse) GetInternal() bool` + +GetInternal returns the Internal field if non-nil, zero value otherwise. + +### GetInternalOk + +`func (o *CreateOAuthClientResponse) GetInternalOk() (*bool, bool)` + +GetInternalOk returns a tuple with the Internal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternal + +`func (o *CreateOAuthClientResponse) SetInternal(v bool)` + +SetInternal sets Internal field to given value. + + +### GetEnabled + +`func (o *CreateOAuthClientResponse) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CreateOAuthClientResponse) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *CreateOAuthClientResponse) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetStrongAuthSupported + +`func (o *CreateOAuthClientResponse) GetStrongAuthSupported() bool` + +GetStrongAuthSupported returns the StrongAuthSupported field if non-nil, zero value otherwise. + +### GetStrongAuthSupportedOk + +`func (o *CreateOAuthClientResponse) GetStrongAuthSupportedOk() (*bool, bool)` + +GetStrongAuthSupportedOk returns a tuple with the StrongAuthSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStrongAuthSupported + +`func (o *CreateOAuthClientResponse) SetStrongAuthSupported(v bool)` + +SetStrongAuthSupported sets StrongAuthSupported field to given value. + + +### GetClaimsSupported + +`func (o *CreateOAuthClientResponse) GetClaimsSupported() bool` + +GetClaimsSupported returns the ClaimsSupported field if non-nil, zero value otherwise. + +### GetClaimsSupportedOk + +`func (o *CreateOAuthClientResponse) GetClaimsSupportedOk() (*bool, bool)` + +GetClaimsSupportedOk returns a tuple with the ClaimsSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClaimsSupported + +`func (o *CreateOAuthClientResponse) SetClaimsSupported(v bool)` + +SetClaimsSupported sets ClaimsSupported field to given value. + + +### GetCreated + +`func (o *CreateOAuthClientResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CreateOAuthClientResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CreateOAuthClientResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CreateOAuthClientResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CreateOAuthClientResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CreateOAuthClientResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetScope + +`func (o *CreateOAuthClientResponse) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *CreateOAuthClientResponse) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *CreateOAuthClientResponse) SetScope(v []string)` + +SetScope sets Scope field to given value. + + +### SetScopeNil + +`func (o *CreateOAuthClientResponse) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *CreateOAuthClientResponse) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CreatePersonalAccessTokenRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/CreatePersonalAccessTokenRequest.md new file mode 100644 index 000000000..80f9ea1ff --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CreatePersonalAccessTokenRequest.md @@ -0,0 +1,121 @@ +--- +id: beta-create-personal-access-token-request +title: CreatePersonalAccessTokenRequest +pagination_label: CreatePersonalAccessTokenRequest +sidebar_label: CreatePersonalAccessTokenRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreatePersonalAccessTokenRequest', 'BetaCreatePersonalAccessTokenRequest'] +slug: /tools/sdk/go/beta/models/create-personal-access-token-request +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenRequest', 'BetaCreatePersonalAccessTokenRequest'] +--- + +# CreatePersonalAccessTokenRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | +**Scope** | Pointer to **[]string** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it. | [optional] +**AccessTokenValiditySeconds** | Pointer to **int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] + +## Methods + +### NewCreatePersonalAccessTokenRequest + +`func NewCreatePersonalAccessTokenRequest(name string, ) *CreatePersonalAccessTokenRequest` + +NewCreatePersonalAccessTokenRequest instantiates a new CreatePersonalAccessTokenRequest 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 + +### NewCreatePersonalAccessTokenRequestWithDefaults + +`func NewCreatePersonalAccessTokenRequestWithDefaults() *CreatePersonalAccessTokenRequest` + +NewCreatePersonalAccessTokenRequestWithDefaults instantiates a new CreatePersonalAccessTokenRequest 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 + +### GetName + +`func (o *CreatePersonalAccessTokenRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreatePersonalAccessTokenRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreatePersonalAccessTokenRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetScope + +`func (o *CreatePersonalAccessTokenRequest) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *CreatePersonalAccessTokenRequest) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *CreatePersonalAccessTokenRequest) SetScope(v []string)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *CreatePersonalAccessTokenRequest) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### SetScopeNil + +`func (o *CreatePersonalAccessTokenRequest) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *CreatePersonalAccessTokenRequest) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil +### GetAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenRequest) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *CreatePersonalAccessTokenRequest) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenRequest) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + +### HasAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenRequest) HasAccessTokenValiditySeconds() bool` + +HasAccessTokenValiditySeconds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CreatePersonalAccessTokenResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/CreatePersonalAccessTokenResponse.md new file mode 100644 index 000000000..6c2e2292d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CreatePersonalAccessTokenResponse.md @@ -0,0 +1,195 @@ +--- +id: beta-create-personal-access-token-response +title: CreatePersonalAccessTokenResponse +pagination_label: CreatePersonalAccessTokenResponse +sidebar_label: CreatePersonalAccessTokenResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreatePersonalAccessTokenResponse', 'BetaCreatePersonalAccessTokenResponse'] +slug: /tools/sdk/go/beta/models/create-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenResponse', 'BetaCreatePersonalAccessTokenResponse'] +--- + +# CreatePersonalAccessTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The ID of the personal access token (to be used as the username for Basic Auth). | +**Secret** | **string** | The secret of the personal access token (to be used as the password for Basic Auth). | +**Scope** | **[]string** | Scopes of the personal access token. | +**Name** | **string** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | +**Owner** | [**PatOwner**](pat-owner) | | +**Created** | **SailPointTime** | The date and time, down to the millisecond, when this personal access token was created. | +**AccessTokenValiditySeconds** | **int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | + +## Methods + +### NewCreatePersonalAccessTokenResponse + +`func NewCreatePersonalAccessTokenResponse(id string, secret string, scope []string, name string, owner PatOwner, created SailPointTime, accessTokenValiditySeconds int32, ) *CreatePersonalAccessTokenResponse` + +NewCreatePersonalAccessTokenResponse instantiates a new CreatePersonalAccessTokenResponse 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 + +### NewCreatePersonalAccessTokenResponseWithDefaults + +`func NewCreatePersonalAccessTokenResponseWithDefaults() *CreatePersonalAccessTokenResponse` + +NewCreatePersonalAccessTokenResponseWithDefaults instantiates a new CreatePersonalAccessTokenResponse 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 + +### GetId + +`func (o *CreatePersonalAccessTokenResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CreatePersonalAccessTokenResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CreatePersonalAccessTokenResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetSecret + +`func (o *CreatePersonalAccessTokenResponse) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *CreatePersonalAccessTokenResponse) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *CreatePersonalAccessTokenResponse) SetSecret(v string)` + +SetSecret sets Secret field to given value. + + +### GetScope + +`func (o *CreatePersonalAccessTokenResponse) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *CreatePersonalAccessTokenResponse) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *CreatePersonalAccessTokenResponse) SetScope(v []string)` + +SetScope sets Scope field to given value. + + +### SetScopeNil + +`func (o *CreatePersonalAccessTokenResponse) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *CreatePersonalAccessTokenResponse) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil +### GetName + +`func (o *CreatePersonalAccessTokenResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreatePersonalAccessTokenResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreatePersonalAccessTokenResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetOwner + +`func (o *CreatePersonalAccessTokenResponse) GetOwner() PatOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CreatePersonalAccessTokenResponse) GetOwnerOk() (*PatOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CreatePersonalAccessTokenResponse) SetOwner(v PatOwner)` + +SetOwner sets Owner field to given value. + + +### GetCreated + +`func (o *CreatePersonalAccessTokenResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CreatePersonalAccessTokenResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CreatePersonalAccessTokenResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenResponse) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *CreatePersonalAccessTokenResponse) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenResponse) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CreateWorkflowRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/CreateWorkflowRequest.md new file mode 100644 index 000000000..94cec1e2a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CreateWorkflowRequest.md @@ -0,0 +1,184 @@ +--- +id: beta-create-workflow-request +title: CreateWorkflowRequest +pagination_label: CreateWorkflowRequest +sidebar_label: CreateWorkflowRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateWorkflowRequest', 'BetaCreateWorkflowRequest'] +slug: /tools/sdk/go/beta/models/create-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateWorkflowRequest', 'BetaCreateWorkflowRequest'] +--- + +# CreateWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the workflow | +**Owner** | [**WorkflowBodyOwner**](workflow-body-owner) | | +**Description** | Pointer to **string** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **bool** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] + +## Methods + +### NewCreateWorkflowRequest + +`func NewCreateWorkflowRequest(name string, owner WorkflowBodyOwner, ) *CreateWorkflowRequest` + +NewCreateWorkflowRequest instantiates a new CreateWorkflowRequest 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 + +### NewCreateWorkflowRequestWithDefaults + +`func NewCreateWorkflowRequestWithDefaults() *CreateWorkflowRequest` + +NewCreateWorkflowRequestWithDefaults instantiates a new CreateWorkflowRequest 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 + +### GetName + +`func (o *CreateWorkflowRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateWorkflowRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateWorkflowRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetOwner + +`func (o *CreateWorkflowRequest) GetOwner() WorkflowBodyOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CreateWorkflowRequest) GetOwnerOk() (*WorkflowBodyOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CreateWorkflowRequest) SetOwner(v WorkflowBodyOwner)` + +SetOwner sets Owner field to given value. + + +### GetDescription + +`func (o *CreateWorkflowRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateWorkflowRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateWorkflowRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CreateWorkflowRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDefinition + +`func (o *CreateWorkflowRequest) GetDefinition() WorkflowDefinition` + +GetDefinition returns the Definition field if non-nil, zero value otherwise. + +### GetDefinitionOk + +`func (o *CreateWorkflowRequest) GetDefinitionOk() (*WorkflowDefinition, bool)` + +GetDefinitionOk returns a tuple with the Definition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefinition + +`func (o *CreateWorkflowRequest) SetDefinition(v WorkflowDefinition)` + +SetDefinition sets Definition field to given value. + +### HasDefinition + +`func (o *CreateWorkflowRequest) HasDefinition() bool` + +HasDefinition returns a boolean if a field has been set. + +### GetEnabled + +`func (o *CreateWorkflowRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CreateWorkflowRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *CreateWorkflowRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *CreateWorkflowRequest) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetTrigger + +`func (o *CreateWorkflowRequest) GetTrigger() WorkflowTrigger` + +GetTrigger returns the Trigger field if non-nil, zero value otherwise. + +### GetTriggerOk + +`func (o *CreateWorkflowRequest) GetTriggerOk() (*WorkflowTrigger, bool)` + +GetTriggerOk returns a tuple with the Trigger field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrigger + +`func (o *CreateWorkflowRequest) SetTrigger(v WorkflowTrigger)` + +SetTrigger sets Trigger field to given value. + +### HasTrigger + +`func (o *CreateWorkflowRequest) HasTrigger() bool` + +HasTrigger returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/CustomPasswordInstruction.md b/docs/tools/sdk/go/Reference/Beta/Models/CustomPasswordInstruction.md new file mode 100644 index 000000000..60d59d0f2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/CustomPasswordInstruction.md @@ -0,0 +1,116 @@ +--- +id: beta-custom-password-instruction +title: CustomPasswordInstruction +pagination_label: CustomPasswordInstruction +sidebar_label: CustomPasswordInstruction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CustomPasswordInstruction', 'BetaCustomPasswordInstruction'] +slug: /tools/sdk/go/beta/models/custom-password-instruction +tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstruction', 'BetaCustomPasswordInstruction'] +--- + +# CustomPasswordInstruction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PageId** | Pointer to **string** | The page ID that represents the page for forget user name, reset password and unlock account flow. | [optional] +**PageContent** | Pointer to **string** | The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like `...` clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: `link`. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target. | [optional] +**Locale** | Pointer to **string** | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". | [optional] + +## Methods + +### NewCustomPasswordInstruction + +`func NewCustomPasswordInstruction() *CustomPasswordInstruction` + +NewCustomPasswordInstruction instantiates a new CustomPasswordInstruction 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 + +### NewCustomPasswordInstructionWithDefaults + +`func NewCustomPasswordInstructionWithDefaults() *CustomPasswordInstruction` + +NewCustomPasswordInstructionWithDefaults instantiates a new CustomPasswordInstruction 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 + +### GetPageId + +`func (o *CustomPasswordInstruction) GetPageId() string` + +GetPageId returns the PageId field if non-nil, zero value otherwise. + +### GetPageIdOk + +`func (o *CustomPasswordInstruction) GetPageIdOk() (*string, bool)` + +GetPageIdOk returns a tuple with the PageId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPageId + +`func (o *CustomPasswordInstruction) SetPageId(v string)` + +SetPageId sets PageId field to given value. + +### HasPageId + +`func (o *CustomPasswordInstruction) HasPageId() bool` + +HasPageId returns a boolean if a field has been set. + +### GetPageContent + +`func (o *CustomPasswordInstruction) GetPageContent() string` + +GetPageContent returns the PageContent field if non-nil, zero value otherwise. + +### GetPageContentOk + +`func (o *CustomPasswordInstruction) GetPageContentOk() (*string, bool)` + +GetPageContentOk returns a tuple with the PageContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPageContent + +`func (o *CustomPasswordInstruction) SetPageContent(v string)` + +SetPageContent sets PageContent field to given value. + +### HasPageContent + +`func (o *CustomPasswordInstruction) HasPageContent() bool` + +HasPageContent returns a boolean if a field has been set. + +### GetLocale + +`func (o *CustomPasswordInstruction) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *CustomPasswordInstruction) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *CustomPasswordInstruction) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *CustomPasswordInstruction) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Delete202Response.md b/docs/tools/sdk/go/Reference/Beta/Models/Delete202Response.md new file mode 100644 index 000000000..b84396222 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Delete202Response.md @@ -0,0 +1,116 @@ +--- +id: beta-delete202-response +title: Delete202Response +pagination_label: Delete202Response +sidebar_label: Delete202Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Delete202Response', 'BetaDelete202Response'] +slug: /tools/sdk/go/beta/models/delete202-response +tags: ['SDK', 'Software Development Kit', 'Delete202Response', 'BetaDelete202Response'] +--- + +# Delete202Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Task result ID. | [optional] +**Name** | Pointer to **string** | Task result's human-readable display name (this should be null/empty). | [optional] + +## Methods + +### NewDelete202Response + +`func NewDelete202Response() *Delete202Response` + +NewDelete202Response instantiates a new Delete202Response 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 + +### NewDelete202ResponseWithDefaults + +`func NewDelete202ResponseWithDefaults() *Delete202Response` + +NewDelete202ResponseWithDefaults instantiates a new Delete202Response 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 + +### GetType + +`func (o *Delete202Response) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Delete202Response) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Delete202Response) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Delete202Response) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *Delete202Response) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Delete202Response) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Delete202Response) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Delete202Response) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Delete202Response) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Delete202Response) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Delete202Response) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Delete202Response) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/DeleteCampaignsRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/DeleteCampaignsRequest.md new file mode 100644 index 000000000..3ea5c7155 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/DeleteCampaignsRequest.md @@ -0,0 +1,64 @@ +--- +id: beta-delete-campaigns-request +title: DeleteCampaignsRequest +pagination_label: DeleteCampaignsRequest +sidebar_label: DeleteCampaignsRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DeleteCampaignsRequest', 'BetaDeleteCampaignsRequest'] +slug: /tools/sdk/go/beta/models/delete-campaigns-request +tags: ['SDK', 'Software Development Kit', 'DeleteCampaignsRequest', 'BetaDeleteCampaignsRequest'] +--- + +# DeleteCampaignsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]string** | The ids of the campaigns to delete | [optional] + +## Methods + +### NewDeleteCampaignsRequest + +`func NewDeleteCampaignsRequest() *DeleteCampaignsRequest` + +NewDeleteCampaignsRequest instantiates a new DeleteCampaignsRequest 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 + +### NewDeleteCampaignsRequestWithDefaults + +`func NewDeleteCampaignsRequestWithDefaults() *DeleteCampaignsRequest` + +NewDeleteCampaignsRequestWithDefaults instantiates a new DeleteCampaignsRequest 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 + +### GetIds + +`func (o *DeleteCampaignsRequest) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *DeleteCampaignsRequest) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *DeleteCampaignsRequest) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *DeleteCampaignsRequest) HasIds() bool` + +HasIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/DeleteNonEmployeeRecordInBulkRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/DeleteNonEmployeeRecordInBulkRequest.md new file mode 100644 index 000000000..6bfe5a2ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/DeleteNonEmployeeRecordInBulkRequest.md @@ -0,0 +1,59 @@ +--- +id: beta-delete-non-employee-record-in-bulk-request +title: DeleteNonEmployeeRecordInBulkRequest +pagination_label: DeleteNonEmployeeRecordInBulkRequest +sidebar_label: DeleteNonEmployeeRecordInBulkRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DeleteNonEmployeeRecordInBulkRequest', 'BetaDeleteNonEmployeeRecordInBulkRequest'] +slug: /tools/sdk/go/beta/models/delete-non-employee-record-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'DeleteNonEmployeeRecordInBulkRequest', 'BetaDeleteNonEmployeeRecordInBulkRequest'] +--- + +# DeleteNonEmployeeRecordInBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | **[]string** | List of non-employee ids. | + +## Methods + +### NewDeleteNonEmployeeRecordInBulkRequest + +`func NewDeleteNonEmployeeRecordInBulkRequest(ids []string, ) *DeleteNonEmployeeRecordInBulkRequest` + +NewDeleteNonEmployeeRecordInBulkRequest instantiates a new DeleteNonEmployeeRecordInBulkRequest 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 + +### NewDeleteNonEmployeeRecordInBulkRequestWithDefaults + +`func NewDeleteNonEmployeeRecordInBulkRequestWithDefaults() *DeleteNonEmployeeRecordInBulkRequest` + +NewDeleteNonEmployeeRecordInBulkRequestWithDefaults instantiates a new DeleteNonEmployeeRecordInBulkRequest 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 + +### GetIds + +`func (o *DeleteNonEmployeeRecordInBulkRequest) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *DeleteNonEmployeeRecordInBulkRequest) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *DeleteNonEmployeeRecordInBulkRequest) SetIds(v []string)` + +SetIds sets Ids field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/DeleteVendorConnectorMapping200Response.md b/docs/tools/sdk/go/Reference/Beta/Models/DeleteVendorConnectorMapping200Response.md new file mode 100644 index 000000000..c2b862264 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/DeleteVendorConnectorMapping200Response.md @@ -0,0 +1,64 @@ +--- +id: beta-delete-vendor-connector-mapping200-response +title: DeleteVendorConnectorMapping200Response +pagination_label: DeleteVendorConnectorMapping200Response +sidebar_label: DeleteVendorConnectorMapping200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DeleteVendorConnectorMapping200Response', 'BetaDeleteVendorConnectorMapping200Response'] +slug: /tools/sdk/go/beta/models/delete-vendor-connector-mapping200-response +tags: ['SDK', 'Software Development Kit', 'DeleteVendorConnectorMapping200Response', 'BetaDeleteVendorConnectorMapping200Response'] +--- + +# DeleteVendorConnectorMapping200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **int32** | The number of vendor connector mappings successfully deleted. | [optional] + +## Methods + +### NewDeleteVendorConnectorMapping200Response + +`func NewDeleteVendorConnectorMapping200Response() *DeleteVendorConnectorMapping200Response` + +NewDeleteVendorConnectorMapping200Response instantiates a new DeleteVendorConnectorMapping200Response 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 + +### NewDeleteVendorConnectorMapping200ResponseWithDefaults + +`func NewDeleteVendorConnectorMapping200ResponseWithDefaults() *DeleteVendorConnectorMapping200Response` + +NewDeleteVendorConnectorMapping200ResponseWithDefaults instantiates a new DeleteVendorConnectorMapping200Response 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 + +### GetCount + +`func (o *DeleteVendorConnectorMapping200Response) GetCount() int32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *DeleteVendorConnectorMapping200Response) GetCountOk() (*int32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *DeleteVendorConnectorMapping200Response) SetCount(v int32)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *DeleteVendorConnectorMapping200Response) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/DimensionRef.md b/docs/tools/sdk/go/Reference/Beta/Models/DimensionRef.md new file mode 100644 index 000000000..efb80ea22 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/DimensionRef.md @@ -0,0 +1,116 @@ +--- +id: beta-dimension-ref +title: DimensionRef +pagination_label: DimensionRef +sidebar_label: DimensionRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionRef', 'BetaDimensionRef'] +slug: /tools/sdk/go/beta/models/dimension-ref +tags: ['SDK', 'Software Development Kit', 'DimensionRef', 'BetaDimensionRef'] +--- + +# DimensionRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of the object to which this reference applies | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewDimensionRef + +`func NewDimensionRef() *DimensionRef` + +NewDimensionRef instantiates a new DimensionRef 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 + +### NewDimensionRefWithDefaults + +`func NewDimensionRefWithDefaults() *DimensionRef` + +NewDimensionRefWithDefaults instantiates a new DimensionRef 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 + +### GetType + +`func (o *DimensionRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DimensionRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DimensionRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DimensionRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *DimensionRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DimensionRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DimensionRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DimensionRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *DimensionRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DimensionRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DimensionRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DimensionRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/DkimAttributes.md b/docs/tools/sdk/go/Reference/Beta/Models/DkimAttributes.md new file mode 100644 index 000000000..044dd7d5c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/DkimAttributes.md @@ -0,0 +1,168 @@ +--- +id: beta-dkim-attributes +title: DkimAttributes +pagination_label: DkimAttributes +sidebar_label: DkimAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DkimAttributes', 'BetaDkimAttributes'] +slug: /tools/sdk/go/beta/models/dkim-attributes +tags: ['SDK', 'Software Development Kit', 'DkimAttributes', 'BetaDkimAttributes'] +--- + +# DkimAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | UUID associated with domain to be verified | [optional] +**Address** | Pointer to **string** | The identity or domain address | [optional] +**DkimEnabled** | Pointer to **bool** | Whether or not DKIM has been enabled for this domain / identity | [optional] [default to false] +**DkimTokens** | Pointer to **[]string** | The tokens to be added to a DNS for verification | [optional] +**DkimVerificationStatus** | Pointer to **string** | The current status if the domain /identity has been verified. Ie Success, Failed, Pending | [optional] + +## Methods + +### NewDkimAttributes + +`func NewDkimAttributes() *DkimAttributes` + +NewDkimAttributes instantiates a new DkimAttributes 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 + +### NewDkimAttributesWithDefaults + +`func NewDkimAttributesWithDefaults() *DkimAttributes` + +NewDkimAttributesWithDefaults instantiates a new DkimAttributes 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 + +### GetId + +`func (o *DkimAttributes) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DkimAttributes) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DkimAttributes) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DkimAttributes) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAddress + +`func (o *DkimAttributes) GetAddress() string` + +GetAddress returns the Address field if non-nil, zero value otherwise. + +### GetAddressOk + +`func (o *DkimAttributes) GetAddressOk() (*string, bool)` + +GetAddressOk returns a tuple with the Address field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAddress + +`func (o *DkimAttributes) SetAddress(v string)` + +SetAddress sets Address field to given value. + +### HasAddress + +`func (o *DkimAttributes) HasAddress() bool` + +HasAddress returns a boolean if a field has been set. + +### GetDkimEnabled + +`func (o *DkimAttributes) GetDkimEnabled() bool` + +GetDkimEnabled returns the DkimEnabled field if non-nil, zero value otherwise. + +### GetDkimEnabledOk + +`func (o *DkimAttributes) GetDkimEnabledOk() (*bool, bool)` + +GetDkimEnabledOk returns a tuple with the DkimEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimEnabled + +`func (o *DkimAttributes) SetDkimEnabled(v bool)` + +SetDkimEnabled sets DkimEnabled field to given value. + +### HasDkimEnabled + +`func (o *DkimAttributes) HasDkimEnabled() bool` + +HasDkimEnabled returns a boolean if a field has been set. + +### GetDkimTokens + +`func (o *DkimAttributes) GetDkimTokens() []string` + +GetDkimTokens returns the DkimTokens field if non-nil, zero value otherwise. + +### GetDkimTokensOk + +`func (o *DkimAttributes) GetDkimTokensOk() (*[]string, bool)` + +GetDkimTokensOk returns a tuple with the DkimTokens field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimTokens + +`func (o *DkimAttributes) SetDkimTokens(v []string)` + +SetDkimTokens sets DkimTokens field to given value. + +### HasDkimTokens + +`func (o *DkimAttributes) HasDkimTokens() bool` + +HasDkimTokens returns a boolean if a field has been set. + +### GetDkimVerificationStatus + +`func (o *DkimAttributes) GetDkimVerificationStatus() string` + +GetDkimVerificationStatus returns the DkimVerificationStatus field if non-nil, zero value otherwise. + +### GetDkimVerificationStatusOk + +`func (o *DkimAttributes) GetDkimVerificationStatusOk() (*string, bool)` + +GetDkimVerificationStatusOk returns a tuple with the DkimVerificationStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimVerificationStatus + +`func (o *DkimAttributes) SetDkimVerificationStatus(v string)` + +SetDkimVerificationStatus sets DkimVerificationStatus field to given value. + +### HasDkimVerificationStatus + +`func (o *DkimAttributes) HasDkimVerificationStatus() bool` + +HasDkimVerificationStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/DomainAddress.md b/docs/tools/sdk/go/Reference/Beta/Models/DomainAddress.md new file mode 100644 index 000000000..db08783af --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/DomainAddress.md @@ -0,0 +1,64 @@ +--- +id: beta-domain-address +title: DomainAddress +pagination_label: DomainAddress +sidebar_label: DomainAddress +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DomainAddress', 'BetaDomainAddress'] +slug: /tools/sdk/go/beta/models/domain-address +tags: ['SDK', 'Software Development Kit', 'DomainAddress', 'BetaDomainAddress'] +--- + +# DomainAddress + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Domain** | Pointer to **string** | A domain address | [optional] + +## Methods + +### NewDomainAddress + +`func NewDomainAddress() *DomainAddress` + +NewDomainAddress instantiates a new DomainAddress 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 + +### NewDomainAddressWithDefaults + +`func NewDomainAddressWithDefaults() *DomainAddress` + +NewDomainAddressWithDefaults instantiates a new DomainAddress 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 + +### GetDomain + +`func (o *DomainAddress) GetDomain() string` + +GetDomain returns the Domain field if non-nil, zero value otherwise. + +### GetDomainOk + +`func (o *DomainAddress) GetDomainOk() (*string, bool)` + +GetDomainOk returns a tuple with the Domain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDomain + +`func (o *DomainAddress) SetDomain(v string)` + +SetDomain sets Domain field to given value. + +### HasDomain + +`func (o *DomainAddress) HasDomain() bool` + +HasDomain returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/DomainStatusDto.md b/docs/tools/sdk/go/Reference/Beta/Models/DomainStatusDto.md new file mode 100644 index 000000000..930a13759 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/DomainStatusDto.md @@ -0,0 +1,168 @@ +--- +id: beta-domain-status-dto +title: DomainStatusDto +pagination_label: DomainStatusDto +sidebar_label: DomainStatusDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DomainStatusDto', 'BetaDomainStatusDto'] +slug: /tools/sdk/go/beta/models/domain-status-dto +tags: ['SDK', 'Software Development Kit', 'DomainStatusDto', 'BetaDomainStatusDto'] +--- + +# DomainStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | New UUID associated with domain to be verified | [optional] +**Domain** | Pointer to **string** | A domain address | [optional] +**DkimEnabled** | Pointer to **map[string]interface{}** | DKIM is enabled for this domain | [optional] [default to false] +**DkimTokens** | Pointer to **[]string** | DKIM tokens required for authentication | [optional] +**DkimVerificationStatus** | Pointer to **string** | Status of DKIM authentication | [optional] + +## Methods + +### NewDomainStatusDto + +`func NewDomainStatusDto() *DomainStatusDto` + +NewDomainStatusDto instantiates a new DomainStatusDto 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 + +### NewDomainStatusDtoWithDefaults + +`func NewDomainStatusDtoWithDefaults() *DomainStatusDto` + +NewDomainStatusDtoWithDefaults instantiates a new DomainStatusDto 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 + +### GetId + +`func (o *DomainStatusDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DomainStatusDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DomainStatusDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DomainStatusDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDomain + +`func (o *DomainStatusDto) GetDomain() string` + +GetDomain returns the Domain field if non-nil, zero value otherwise. + +### GetDomainOk + +`func (o *DomainStatusDto) GetDomainOk() (*string, bool)` + +GetDomainOk returns a tuple with the Domain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDomain + +`func (o *DomainStatusDto) SetDomain(v string)` + +SetDomain sets Domain field to given value. + +### HasDomain + +`func (o *DomainStatusDto) HasDomain() bool` + +HasDomain returns a boolean if a field has been set. + +### GetDkimEnabled + +`func (o *DomainStatusDto) GetDkimEnabled() map[string]interface{}` + +GetDkimEnabled returns the DkimEnabled field if non-nil, zero value otherwise. + +### GetDkimEnabledOk + +`func (o *DomainStatusDto) GetDkimEnabledOk() (*map[string]interface{}, bool)` + +GetDkimEnabledOk returns a tuple with the DkimEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimEnabled + +`func (o *DomainStatusDto) SetDkimEnabled(v map[string]interface{})` + +SetDkimEnabled sets DkimEnabled field to given value. + +### HasDkimEnabled + +`func (o *DomainStatusDto) HasDkimEnabled() bool` + +HasDkimEnabled returns a boolean if a field has been set. + +### GetDkimTokens + +`func (o *DomainStatusDto) GetDkimTokens() []string` + +GetDkimTokens returns the DkimTokens field if non-nil, zero value otherwise. + +### GetDkimTokensOk + +`func (o *DomainStatusDto) GetDkimTokensOk() (*[]string, bool)` + +GetDkimTokensOk returns a tuple with the DkimTokens field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimTokens + +`func (o *DomainStatusDto) SetDkimTokens(v []string)` + +SetDkimTokens sets DkimTokens field to given value. + +### HasDkimTokens + +`func (o *DomainStatusDto) HasDkimTokens() bool` + +HasDkimTokens returns a boolean if a field has been set. + +### GetDkimVerificationStatus + +`func (o *DomainStatusDto) GetDkimVerificationStatus() string` + +GetDkimVerificationStatus returns the DkimVerificationStatus field if non-nil, zero value otherwise. + +### GetDkimVerificationStatusOk + +`func (o *DomainStatusDto) GetDkimVerificationStatusOk() (*string, bool)` + +GetDkimVerificationStatusOk returns a tuple with the DkimVerificationStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimVerificationStatus + +`func (o *DomainStatusDto) SetDkimVerificationStatus(v string)` + +SetDkimVerificationStatus sets DkimVerificationStatus field to given value. + +### HasDkimVerificationStatus + +`func (o *DomainStatusDto) HasDkimVerificationStatus() bool` + +HasDkimVerificationStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/DtoType.md b/docs/tools/sdk/go/Reference/Beta/Models/DtoType.md new file mode 100644 index 000000000..2089f1883 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/DtoType.md @@ -0,0 +1,75 @@ +--- +id: beta-dto-type +title: DtoType +pagination_label: DtoType +sidebar_label: DtoType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DtoType', 'BetaDtoType'] +slug: /tools/sdk/go/beta/models/dto-type +tags: ['SDK', 'Software Development Kit', 'DtoType', 'BetaDtoType'] +--- + +# DtoType + +## Enum + + +* `ACCOUNT_CORRELATION_CONFIG` (value: `"ACCOUNT_CORRELATION_CONFIG"`) + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ACCESS_REQUEST_APPROVAL` (value: `"ACCESS_REQUEST_APPROVAL"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `APPLICATION` (value: `"APPLICATION"`) + +* `CAMPAIGN` (value: `"CAMPAIGN"`) + +* `CAMPAIGN_FILTER` (value: `"CAMPAIGN_FILTER"`) + +* `CERTIFICATION` (value: `"CERTIFICATION"`) + +* `CLUSTER` (value: `"CLUSTER"`) + +* `CONNECTOR_SCHEMA` (value: `"CONNECTOR_SCHEMA"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + +* `IDENTITY` (value: `"IDENTITY"`) + +* `IDENTITY_PROFILE` (value: `"IDENTITY_PROFILE"`) + +* `IDENTITY_REQUEST` (value: `"IDENTITY_REQUEST"`) + +* `MACHINE_IDENTITY` (value: `"MACHINE_IDENTITY"`) + +* `LIFECYCLE_STATE` (value: `"LIFECYCLE_STATE"`) + +* `PASSWORD_POLICY` (value: `"PASSWORD_POLICY"`) + +* `ROLE` (value: `"ROLE"`) + +* `RULE` (value: `"RULE"`) + +* `SOD_POLICY` (value: `"SOD_POLICY"`) + +* `SOURCE` (value: `"SOURCE"`) + +* `TAG` (value: `"TAG"`) + +* `TAG_CATEGORY` (value: `"TAG_CATEGORY"`) + +* `TASK_RESULT` (value: `"TASK_RESULT"`) + +* `REPORT_RESULT` (value: `"REPORT_RESULT"`) + +* `SOD_VIOLATION` (value: `"SOD_VIOLATION"`) + +* `ACCOUNT_ACTIVITY` (value: `"ACCOUNT_ACTIVITY"`) + +* `WORKGROUP` (value: `"WORKGROUP"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/DuoVerificationRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/DuoVerificationRequest.md new file mode 100644 index 000000000..7043e0580 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/DuoVerificationRequest.md @@ -0,0 +1,80 @@ +--- +id: beta-duo-verification-request +title: DuoVerificationRequest +pagination_label: DuoVerificationRequest +sidebar_label: DuoVerificationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DuoVerificationRequest', 'BetaDuoVerificationRequest'] +slug: /tools/sdk/go/beta/models/duo-verification-request +tags: ['SDK', 'Software Development Kit', 'DuoVerificationRequest', 'BetaDuoVerificationRequest'] +--- + +# DuoVerificationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **string** | User id for Verification request. | +**SignedResponse** | **string** | User id for Verification request. | + +## Methods + +### NewDuoVerificationRequest + +`func NewDuoVerificationRequest(userId string, signedResponse string, ) *DuoVerificationRequest` + +NewDuoVerificationRequest instantiates a new DuoVerificationRequest 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 + +### NewDuoVerificationRequestWithDefaults + +`func NewDuoVerificationRequestWithDefaults() *DuoVerificationRequest` + +NewDuoVerificationRequestWithDefaults instantiates a new DuoVerificationRequest 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 + +### GetUserId + +`func (o *DuoVerificationRequest) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *DuoVerificationRequest) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *DuoVerificationRequest) SetUserId(v string)` + +SetUserId sets UserId field to given value. + + +### GetSignedResponse + +`func (o *DuoVerificationRequest) GetSignedResponse() string` + +GetSignedResponse returns the SignedResponse field if non-nil, zero value otherwise. + +### GetSignedResponseOk + +`func (o *DuoVerificationRequest) GetSignedResponseOk() (*string, bool)` + +GetSignedResponseOk returns a tuple with the SignedResponse field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignedResponse + +`func (o *DuoVerificationRequest) SetSignedResponse(v string)` + +SetSignedResponse sets SignedResponse field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/EmailNotificationOption.md b/docs/tools/sdk/go/Reference/Beta/Models/EmailNotificationOption.md new file mode 100644 index 000000000..f9e8dc7d7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/EmailNotificationOption.md @@ -0,0 +1,142 @@ +--- +id: beta-email-notification-option +title: EmailNotificationOption +pagination_label: EmailNotificationOption +sidebar_label: EmailNotificationOption +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EmailNotificationOption', 'BetaEmailNotificationOption'] +slug: /tools/sdk/go/beta/models/email-notification-option +tags: ['SDK', 'Software Development Kit', 'EmailNotificationOption', 'BetaEmailNotificationOption'] +--- + +# EmailNotificationOption + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NotifyManagers** | Pointer to **bool** | If true, then the manager is notified of the lifecycle state change. | [optional] [default to false] +**NotifyAllAdmins** | Pointer to **bool** | If true, then all the admins are notified of the lifecycle state change. | [optional] [default to false] +**NotifySpecificUsers** | Pointer to **bool** | If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change. | [optional] [default to false] +**EmailAddressList** | Pointer to **[]string** | List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change. | [optional] + +## Methods + +### NewEmailNotificationOption + +`func NewEmailNotificationOption() *EmailNotificationOption` + +NewEmailNotificationOption instantiates a new EmailNotificationOption 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 + +### NewEmailNotificationOptionWithDefaults + +`func NewEmailNotificationOptionWithDefaults() *EmailNotificationOption` + +NewEmailNotificationOptionWithDefaults instantiates a new EmailNotificationOption 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 + +### GetNotifyManagers + +`func (o *EmailNotificationOption) GetNotifyManagers() bool` + +GetNotifyManagers returns the NotifyManagers field if non-nil, zero value otherwise. + +### GetNotifyManagersOk + +`func (o *EmailNotificationOption) GetNotifyManagersOk() (*bool, bool)` + +GetNotifyManagersOk returns a tuple with the NotifyManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifyManagers + +`func (o *EmailNotificationOption) SetNotifyManagers(v bool)` + +SetNotifyManagers sets NotifyManagers field to given value. + +### HasNotifyManagers + +`func (o *EmailNotificationOption) HasNotifyManagers() bool` + +HasNotifyManagers returns a boolean if a field has been set. + +### GetNotifyAllAdmins + +`func (o *EmailNotificationOption) GetNotifyAllAdmins() bool` + +GetNotifyAllAdmins returns the NotifyAllAdmins field if non-nil, zero value otherwise. + +### GetNotifyAllAdminsOk + +`func (o *EmailNotificationOption) GetNotifyAllAdminsOk() (*bool, bool)` + +GetNotifyAllAdminsOk returns a tuple with the NotifyAllAdmins field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifyAllAdmins + +`func (o *EmailNotificationOption) SetNotifyAllAdmins(v bool)` + +SetNotifyAllAdmins sets NotifyAllAdmins field to given value. + +### HasNotifyAllAdmins + +`func (o *EmailNotificationOption) HasNotifyAllAdmins() bool` + +HasNotifyAllAdmins returns a boolean if a field has been set. + +### GetNotifySpecificUsers + +`func (o *EmailNotificationOption) GetNotifySpecificUsers() bool` + +GetNotifySpecificUsers returns the NotifySpecificUsers field if non-nil, zero value otherwise. + +### GetNotifySpecificUsersOk + +`func (o *EmailNotificationOption) GetNotifySpecificUsersOk() (*bool, bool)` + +GetNotifySpecificUsersOk returns a tuple with the NotifySpecificUsers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifySpecificUsers + +`func (o *EmailNotificationOption) SetNotifySpecificUsers(v bool)` + +SetNotifySpecificUsers sets NotifySpecificUsers field to given value. + +### HasNotifySpecificUsers + +`func (o *EmailNotificationOption) HasNotifySpecificUsers() bool` + +HasNotifySpecificUsers returns a boolean if a field has been set. + +### GetEmailAddressList + +`func (o *EmailNotificationOption) GetEmailAddressList() []string` + +GetEmailAddressList returns the EmailAddressList field if non-nil, zero value otherwise. + +### GetEmailAddressListOk + +`func (o *EmailNotificationOption) GetEmailAddressListOk() (*[]string, bool)` + +GetEmailAddressListOk returns a tuple with the EmailAddressList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailAddressList + +`func (o *EmailNotificationOption) SetEmailAddressList(v []string)` + +SetEmailAddressList sets EmailAddressList field to given value. + +### HasEmailAddressList + +`func (o *EmailNotificationOption) HasEmailAddressList() bool` + +HasEmailAddressList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/EmailStatusDto.md b/docs/tools/sdk/go/Reference/Beta/Models/EmailStatusDto.md new file mode 100644 index 000000000..6d3d0be14 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/EmailStatusDto.md @@ -0,0 +1,152 @@ +--- +id: beta-email-status-dto +title: EmailStatusDto +pagination_label: EmailStatusDto +sidebar_label: EmailStatusDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EmailStatusDto', 'BetaEmailStatusDto'] +slug: /tools/sdk/go/beta/models/email-status-dto +tags: ['SDK', 'Software Development Kit', 'EmailStatusDto', 'BetaEmailStatusDto'] +--- + +# EmailStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | | [optional] +**Email** | Pointer to **string** | | [optional] +**IsVerifiedByDomain** | Pointer to **bool** | | [optional] +**VerificationStatus** | Pointer to **string** | | [optional] + +## Methods + +### NewEmailStatusDto + +`func NewEmailStatusDto() *EmailStatusDto` + +NewEmailStatusDto instantiates a new EmailStatusDto 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 + +### NewEmailStatusDtoWithDefaults + +`func NewEmailStatusDtoWithDefaults() *EmailStatusDto` + +NewEmailStatusDtoWithDefaults instantiates a new EmailStatusDto 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 + +### GetId + +`func (o *EmailStatusDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EmailStatusDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EmailStatusDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EmailStatusDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *EmailStatusDto) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *EmailStatusDto) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetEmail + +`func (o *EmailStatusDto) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *EmailStatusDto) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *EmailStatusDto) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *EmailStatusDto) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetIsVerifiedByDomain + +`func (o *EmailStatusDto) GetIsVerifiedByDomain() bool` + +GetIsVerifiedByDomain returns the IsVerifiedByDomain field if non-nil, zero value otherwise. + +### GetIsVerifiedByDomainOk + +`func (o *EmailStatusDto) GetIsVerifiedByDomainOk() (*bool, bool)` + +GetIsVerifiedByDomainOk returns a tuple with the IsVerifiedByDomain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsVerifiedByDomain + +`func (o *EmailStatusDto) SetIsVerifiedByDomain(v bool)` + +SetIsVerifiedByDomain sets IsVerifiedByDomain field to given value. + +### HasIsVerifiedByDomain + +`func (o *EmailStatusDto) HasIsVerifiedByDomain() bool` + +HasIsVerifiedByDomain returns a boolean if a field has been set. + +### GetVerificationStatus + +`func (o *EmailStatusDto) GetVerificationStatus() string` + +GetVerificationStatus returns the VerificationStatus field if non-nil, zero value otherwise. + +### GetVerificationStatusOk + +`func (o *EmailStatusDto) GetVerificationStatusOk() (*string, bool)` + +GetVerificationStatusOk returns a tuple with the VerificationStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVerificationStatus + +`func (o *EmailStatusDto) SetVerificationStatus(v string)` + +SetVerificationStatus sets VerificationStatus field to given value. + +### HasVerificationStatus + +`func (o *EmailStatusDto) HasVerificationStatus() bool` + +HasVerificationStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Entitlement.md b/docs/tools/sdk/go/Reference/Beta/Models/Entitlement.md new file mode 100644 index 000000000..483d08f12 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Entitlement.md @@ -0,0 +1,536 @@ +--- +id: beta-entitlement +title: Entitlement +pagination_label: Entitlement +sidebar_label: Entitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Entitlement', 'BetaEntitlement'] +slug: /tools/sdk/go/beta/models/entitlement +tags: ['SDK', 'Software Development Kit', 'Entitlement', 'BetaEntitlement'] +--- + +# Entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The entitlement id | [optional] +**Name** | Pointer to **string** | The entitlement name | [optional] +**Created** | Pointer to **SailPointTime** | Time when the entitlement was created | [optional] +**Modified** | Pointer to **SailPointTime** | Time when the entitlement was last modified | [optional] +**Attribute** | Pointer to **NullableString** | The entitlement attribute name | [optional] +**Value** | Pointer to **string** | The value of the entitlement | [optional] +**SourceSchemaObjectType** | Pointer to **string** | The object type of the entitlement from the source schema | [optional] +**Privileged** | Pointer to **bool** | True if the entitlement is privileged | [optional] [default to false] +**CloudGoverned** | Pointer to **bool** | True if the entitlement is cloud governed | [optional] [default to false] +**Description** | Pointer to **NullableString** | The description of the entitlement | [optional] +**Requestable** | Pointer to **bool** | True if the entitlement is requestable | [optional] [default to false] +**Attributes** | Pointer to **map[string]interface{}** | A map of free-form key-value pairs from the source system | [optional] +**Source** | Pointer to [**EntitlementSource**](entitlement-source) | | [optional] +**Owner** | Pointer to [**EntitlementOwner**](entitlement-owner) | | [optional] +**DirectPermissions** | Pointer to [**[]PermissionDto**](permission-dto) | | [optional] +**Segments** | Pointer to **[]string** | List of IDs of segments, if any, to which this Entitlement is assigned. | [optional] +**ManuallyUpdatedFields** | Pointer to [**EntitlementManuallyUpdatedFields**](entitlement-manually-updated-fields) | | [optional] +**AccessModelMetadata** | Pointer to [**EntitlementAccessModelMetadata**](entitlement-access-model-metadata) | | [optional] + +## Methods + +### NewEntitlement + +`func NewEntitlement() *Entitlement` + +NewEntitlement instantiates a new Entitlement 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 + +### NewEntitlementWithDefaults + +`func NewEntitlementWithDefaults() *Entitlement` + +NewEntitlementWithDefaults instantiates a new Entitlement 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 + +### GetId + +`func (o *Entitlement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Entitlement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Entitlement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Entitlement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Entitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Entitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Entitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Entitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *Entitlement) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Entitlement) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Entitlement) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Entitlement) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Entitlement) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Entitlement) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Entitlement) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Entitlement) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetAttribute + +`func (o *Entitlement) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *Entitlement) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *Entitlement) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *Entitlement) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *Entitlement) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *Entitlement) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *Entitlement) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Entitlement) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Entitlement) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Entitlement) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSourceSchemaObjectType + +`func (o *Entitlement) GetSourceSchemaObjectType() string` + +GetSourceSchemaObjectType returns the SourceSchemaObjectType field if non-nil, zero value otherwise. + +### GetSourceSchemaObjectTypeOk + +`func (o *Entitlement) GetSourceSchemaObjectTypeOk() (*string, bool)` + +GetSourceSchemaObjectTypeOk returns a tuple with the SourceSchemaObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceSchemaObjectType + +`func (o *Entitlement) SetSourceSchemaObjectType(v string)` + +SetSourceSchemaObjectType sets SourceSchemaObjectType field to given value. + +### HasSourceSchemaObjectType + +`func (o *Entitlement) HasSourceSchemaObjectType() bool` + +HasSourceSchemaObjectType returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *Entitlement) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *Entitlement) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *Entitlement) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *Entitlement) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetCloudGoverned + +`func (o *Entitlement) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *Entitlement) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *Entitlement) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + +### HasCloudGoverned + +`func (o *Entitlement) HasCloudGoverned() bool` + +HasCloudGoverned returns a boolean if a field has been set. + +### GetDescription + +`func (o *Entitlement) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Entitlement) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Entitlement) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Entitlement) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Entitlement) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Entitlement) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetRequestable + +`func (o *Entitlement) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *Entitlement) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *Entitlement) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *Entitlement) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Entitlement) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Entitlement) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Entitlement) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Entitlement) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetSource + +`func (o *Entitlement) GetSource() EntitlementSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *Entitlement) GetSourceOk() (*EntitlementSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *Entitlement) SetSource(v EntitlementSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *Entitlement) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetOwner + +`func (o *Entitlement) GetOwner() EntitlementOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Entitlement) GetOwnerOk() (*EntitlementOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Entitlement) SetOwner(v EntitlementOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *Entitlement) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDirectPermissions + +`func (o *Entitlement) GetDirectPermissions() []PermissionDto` + +GetDirectPermissions returns the DirectPermissions field if non-nil, zero value otherwise. + +### GetDirectPermissionsOk + +`func (o *Entitlement) GetDirectPermissionsOk() (*[]PermissionDto, bool)` + +GetDirectPermissionsOk returns a tuple with the DirectPermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectPermissions + +`func (o *Entitlement) SetDirectPermissions(v []PermissionDto)` + +SetDirectPermissions sets DirectPermissions field to given value. + +### HasDirectPermissions + +`func (o *Entitlement) HasDirectPermissions() bool` + +HasDirectPermissions returns a boolean if a field has been set. + +### GetSegments + +`func (o *Entitlement) GetSegments() []string` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *Entitlement) GetSegmentsOk() (*[]string, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *Entitlement) SetSegments(v []string)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *Entitlement) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### SetSegmentsNil + +`func (o *Entitlement) SetSegmentsNil(b bool)` + + SetSegmentsNil sets the value for Segments to be an explicit nil + +### UnsetSegments +`func (o *Entitlement) UnsetSegments()` + +UnsetSegments ensures that no value is present for Segments, not even an explicit nil +### GetManuallyUpdatedFields + +`func (o *Entitlement) GetManuallyUpdatedFields() EntitlementManuallyUpdatedFields` + +GetManuallyUpdatedFields returns the ManuallyUpdatedFields field if non-nil, zero value otherwise. + +### GetManuallyUpdatedFieldsOk + +`func (o *Entitlement) GetManuallyUpdatedFieldsOk() (*EntitlementManuallyUpdatedFields, bool)` + +GetManuallyUpdatedFieldsOk returns a tuple with the ManuallyUpdatedFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyUpdatedFields + +`func (o *Entitlement) SetManuallyUpdatedFields(v EntitlementManuallyUpdatedFields)` + +SetManuallyUpdatedFields sets ManuallyUpdatedFields field to given value. + +### HasManuallyUpdatedFields + +`func (o *Entitlement) HasManuallyUpdatedFields() bool` + +HasManuallyUpdatedFields returns a boolean if a field has been set. + +### GetAccessModelMetadata + +`func (o *Entitlement) GetAccessModelMetadata() EntitlementAccessModelMetadata` + +GetAccessModelMetadata returns the AccessModelMetadata field if non-nil, zero value otherwise. + +### GetAccessModelMetadataOk + +`func (o *Entitlement) GetAccessModelMetadataOk() (*EntitlementAccessModelMetadata, bool)` + +GetAccessModelMetadataOk returns a tuple with the AccessModelMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessModelMetadata + +`func (o *Entitlement) SetAccessModelMetadata(v EntitlementAccessModelMetadata)` + +SetAccessModelMetadata sets AccessModelMetadata field to given value. + +### HasAccessModelMetadata + +`func (o *Entitlement) HasAccessModelMetadata() bool` + +HasAccessModelMetadata returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/EntitlementAccessModelMetadata.md b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementAccessModelMetadata.md new file mode 100644 index 000000000..d43381acd --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementAccessModelMetadata.md @@ -0,0 +1,74 @@ +--- +id: beta-entitlement-access-model-metadata +title: EntitlementAccessModelMetadata +pagination_label: EntitlementAccessModelMetadata +sidebar_label: EntitlementAccessModelMetadata +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementAccessModelMetadata', 'BetaEntitlementAccessModelMetadata'] +slug: /tools/sdk/go/beta/models/entitlement-access-model-metadata +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadata', 'BetaEntitlementAccessModelMetadata'] +--- + +# EntitlementAccessModelMetadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]AttributeDTO**](attribute-dto) | | [optional] + +## Methods + +### NewEntitlementAccessModelMetadata + +`func NewEntitlementAccessModelMetadata() *EntitlementAccessModelMetadata` + +NewEntitlementAccessModelMetadata instantiates a new EntitlementAccessModelMetadata 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 + +### NewEntitlementAccessModelMetadataWithDefaults + +`func NewEntitlementAccessModelMetadataWithDefaults() *EntitlementAccessModelMetadata` + +NewEntitlementAccessModelMetadataWithDefaults instantiates a new EntitlementAccessModelMetadata 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 + +### GetAttributes + +`func (o *EntitlementAccessModelMetadata) GetAttributes() []AttributeDTO` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *EntitlementAccessModelMetadata) GetAttributesOk() (*[]AttributeDTO, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *EntitlementAccessModelMetadata) SetAttributes(v []AttributeDTO)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *EntitlementAccessModelMetadata) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *EntitlementAccessModelMetadata) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *EntitlementAccessModelMetadata) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/EntitlementAccessRequestConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementAccessRequestConfig.md new file mode 100644 index 000000000..49b3af0b5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementAccessRequestConfig.md @@ -0,0 +1,116 @@ +--- +id: beta-entitlement-access-request-config +title: EntitlementAccessRequestConfig +pagination_label: EntitlementAccessRequestConfig +sidebar_label: EntitlementAccessRequestConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementAccessRequestConfig', 'BetaEntitlementAccessRequestConfig'] +slug: /tools/sdk/go/beta/models/entitlement-access-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessRequestConfig', 'BetaEntitlementAccessRequestConfig'] +--- + +# EntitlementAccessRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalSchemes** | Pointer to [**[]EntitlementApprovalScheme**](entitlement-approval-scheme) | Ordered list of approval steps for the access request. Empty when no approval is required. | [optional] +**RequestCommentRequired** | Pointer to **bool** | If the requester must provide a comment during access request. | [optional] [default to false] +**DenialCommentRequired** | Pointer to **bool** | If the reviewer must provide a comment when denying the access request. | [optional] [default to false] + +## Methods + +### NewEntitlementAccessRequestConfig + +`func NewEntitlementAccessRequestConfig() *EntitlementAccessRequestConfig` + +NewEntitlementAccessRequestConfig instantiates a new EntitlementAccessRequestConfig 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 + +### NewEntitlementAccessRequestConfigWithDefaults + +`func NewEntitlementAccessRequestConfigWithDefaults() *EntitlementAccessRequestConfig` + +NewEntitlementAccessRequestConfigWithDefaults instantiates a new EntitlementAccessRequestConfig 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 + +### GetApprovalSchemes + +`func (o *EntitlementAccessRequestConfig) GetApprovalSchemes() []EntitlementApprovalScheme` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *EntitlementAccessRequestConfig) GetApprovalSchemesOk() (*[]EntitlementApprovalScheme, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *EntitlementAccessRequestConfig) SetApprovalSchemes(v []EntitlementApprovalScheme)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *EntitlementAccessRequestConfig) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + +### GetRequestCommentRequired + +`func (o *EntitlementAccessRequestConfig) GetRequestCommentRequired() bool` + +GetRequestCommentRequired returns the RequestCommentRequired field if non-nil, zero value otherwise. + +### GetRequestCommentRequiredOk + +`func (o *EntitlementAccessRequestConfig) GetRequestCommentRequiredOk() (*bool, bool)` + +GetRequestCommentRequiredOk returns a tuple with the RequestCommentRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentRequired + +`func (o *EntitlementAccessRequestConfig) SetRequestCommentRequired(v bool)` + +SetRequestCommentRequired sets RequestCommentRequired field to given value. + +### HasRequestCommentRequired + +`func (o *EntitlementAccessRequestConfig) HasRequestCommentRequired() bool` + +HasRequestCommentRequired returns a boolean if a field has been set. + +### GetDenialCommentRequired + +`func (o *EntitlementAccessRequestConfig) GetDenialCommentRequired() bool` + +GetDenialCommentRequired returns the DenialCommentRequired field if non-nil, zero value otherwise. + +### GetDenialCommentRequiredOk + +`func (o *EntitlementAccessRequestConfig) GetDenialCommentRequiredOk() (*bool, bool)` + +GetDenialCommentRequiredOk returns a tuple with the DenialCommentRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenialCommentRequired + +`func (o *EntitlementAccessRequestConfig) SetDenialCommentRequired(v bool)` + +SetDenialCommentRequired sets DenialCommentRequired field to given value. + +### HasDenialCommentRequired + +`func (o *EntitlementAccessRequestConfig) HasDenialCommentRequired() bool` + +HasDenialCommentRequired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/EntitlementApprovalScheme.md b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementApprovalScheme.md new file mode 100644 index 000000000..471b4ea41 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementApprovalScheme.md @@ -0,0 +1,100 @@ +--- +id: beta-entitlement-approval-scheme +title: EntitlementApprovalScheme +pagination_label: EntitlementApprovalScheme +sidebar_label: EntitlementApprovalScheme +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementApprovalScheme', 'BetaEntitlementApprovalScheme'] +slug: /tools/sdk/go/beta/models/entitlement-approval-scheme +tags: ['SDK', 'Software Development Kit', 'EntitlementApprovalScheme', 'BetaEntitlementApprovalScheme'] +--- + +# EntitlementApprovalScheme + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApproverType** | Pointer to **string** | Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | Pointer to **NullableString** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] + +## Methods + +### NewEntitlementApprovalScheme + +`func NewEntitlementApprovalScheme() *EntitlementApprovalScheme` + +NewEntitlementApprovalScheme instantiates a new EntitlementApprovalScheme 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 + +### NewEntitlementApprovalSchemeWithDefaults + +`func NewEntitlementApprovalSchemeWithDefaults() *EntitlementApprovalScheme` + +NewEntitlementApprovalSchemeWithDefaults instantiates a new EntitlementApprovalScheme 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 + +### GetApproverType + +`func (o *EntitlementApprovalScheme) GetApproverType() string` + +GetApproverType returns the ApproverType field if non-nil, zero value otherwise. + +### GetApproverTypeOk + +`func (o *EntitlementApprovalScheme) GetApproverTypeOk() (*string, bool)` + +GetApproverTypeOk returns a tuple with the ApproverType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverType + +`func (o *EntitlementApprovalScheme) SetApproverType(v string)` + +SetApproverType sets ApproverType field to given value. + +### HasApproverType + +`func (o *EntitlementApprovalScheme) HasApproverType() bool` + +HasApproverType returns a boolean if a field has been set. + +### GetApproverId + +`func (o *EntitlementApprovalScheme) GetApproverId() string` + +GetApproverId returns the ApproverId field if non-nil, zero value otherwise. + +### GetApproverIdOk + +`func (o *EntitlementApprovalScheme) GetApproverIdOk() (*string, bool)` + +GetApproverIdOk returns a tuple with the ApproverId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverId + +`func (o *EntitlementApprovalScheme) SetApproverId(v string)` + +SetApproverId sets ApproverId field to given value. + +### HasApproverId + +`func (o *EntitlementApprovalScheme) HasApproverId() bool` + +HasApproverId returns a boolean if a field has been set. + +### SetApproverIdNil + +`func (o *EntitlementApprovalScheme) SetApproverIdNil(b bool)` + + SetApproverIdNil sets the value for ApproverId to be an explicit nil + +### UnsetApproverId +`func (o *EntitlementApprovalScheme) UnsetApproverId()` + +UnsetApproverId ensures that no value is present for ApproverId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/EntitlementBulkUpdateRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementBulkUpdateRequest.md new file mode 100644 index 000000000..638bbdd08 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementBulkUpdateRequest.md @@ -0,0 +1,80 @@ +--- +id: beta-entitlement-bulk-update-request +title: EntitlementBulkUpdateRequest +pagination_label: EntitlementBulkUpdateRequest +sidebar_label: EntitlementBulkUpdateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementBulkUpdateRequest', 'BetaEntitlementBulkUpdateRequest'] +slug: /tools/sdk/go/beta/models/entitlement-bulk-update-request +tags: ['SDK', 'Software Development Kit', 'EntitlementBulkUpdateRequest', 'BetaEntitlementBulkUpdateRequest'] +--- + +# EntitlementBulkUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EntitlementIds** | **[]string** | List of entitlement ids to update | +**JsonPatch** | [**[]JsonPatchOperation**](json-patch-operation) | | + +## Methods + +### NewEntitlementBulkUpdateRequest + +`func NewEntitlementBulkUpdateRequest(entitlementIds []string, jsonPatch []JsonPatchOperation, ) *EntitlementBulkUpdateRequest` + +NewEntitlementBulkUpdateRequest instantiates a new EntitlementBulkUpdateRequest 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 + +### NewEntitlementBulkUpdateRequestWithDefaults + +`func NewEntitlementBulkUpdateRequestWithDefaults() *EntitlementBulkUpdateRequest` + +NewEntitlementBulkUpdateRequestWithDefaults instantiates a new EntitlementBulkUpdateRequest 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 + +### GetEntitlementIds + +`func (o *EntitlementBulkUpdateRequest) GetEntitlementIds() []string` + +GetEntitlementIds returns the EntitlementIds field if non-nil, zero value otherwise. + +### GetEntitlementIdsOk + +`func (o *EntitlementBulkUpdateRequest) GetEntitlementIdsOk() (*[]string, bool)` + +GetEntitlementIdsOk returns a tuple with the EntitlementIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementIds + +`func (o *EntitlementBulkUpdateRequest) SetEntitlementIds(v []string)` + +SetEntitlementIds sets EntitlementIds field to given value. + + +### GetJsonPatch + +`func (o *EntitlementBulkUpdateRequest) GetJsonPatch() []JsonPatchOperation` + +GetJsonPatch returns the JsonPatch field if non-nil, zero value otherwise. + +### GetJsonPatchOk + +`func (o *EntitlementBulkUpdateRequest) GetJsonPatchOk() (*[]JsonPatchOperation, bool)` + +GetJsonPatchOk returns a tuple with the JsonPatch field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJsonPatch + +`func (o *EntitlementBulkUpdateRequest) SetJsonPatch(v []JsonPatchOperation)` + +SetJsonPatch sets JsonPatch field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/EntitlementManuallyUpdatedFields.md b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementManuallyUpdatedFields.md new file mode 100644 index 000000000..2df9c0755 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementManuallyUpdatedFields.md @@ -0,0 +1,90 @@ +--- +id: beta-entitlement-manually-updated-fields +title: EntitlementManuallyUpdatedFields +pagination_label: EntitlementManuallyUpdatedFields +sidebar_label: EntitlementManuallyUpdatedFields +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementManuallyUpdatedFields', 'BetaEntitlementManuallyUpdatedFields'] +slug: /tools/sdk/go/beta/models/entitlement-manually-updated-fields +tags: ['SDK', 'Software Development Kit', 'EntitlementManuallyUpdatedFields', 'BetaEntitlementManuallyUpdatedFields'] +--- + +# EntitlementManuallyUpdatedFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DISPLAY_NAME** | Pointer to **bool** | True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property. | [optional] [default to false] +**DESCRIPTION** | Pointer to **bool** | True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property. | [optional] [default to false] + +## Methods + +### NewEntitlementManuallyUpdatedFields + +`func NewEntitlementManuallyUpdatedFields() *EntitlementManuallyUpdatedFields` + +NewEntitlementManuallyUpdatedFields instantiates a new EntitlementManuallyUpdatedFields 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 + +### NewEntitlementManuallyUpdatedFieldsWithDefaults + +`func NewEntitlementManuallyUpdatedFieldsWithDefaults() *EntitlementManuallyUpdatedFields` + +NewEntitlementManuallyUpdatedFieldsWithDefaults instantiates a new EntitlementManuallyUpdatedFields 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 + +### GetDISPLAY_NAME + +`func (o *EntitlementManuallyUpdatedFields) GetDISPLAY_NAME() bool` + +GetDISPLAY_NAME returns the DISPLAY_NAME field if non-nil, zero value otherwise. + +### GetDISPLAY_NAMEOk + +`func (o *EntitlementManuallyUpdatedFields) GetDISPLAY_NAMEOk() (*bool, bool)` + +GetDISPLAY_NAMEOk returns a tuple with the DISPLAY_NAME field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDISPLAY_NAME + +`func (o *EntitlementManuallyUpdatedFields) SetDISPLAY_NAME(v bool)` + +SetDISPLAY_NAME sets DISPLAY_NAME field to given value. + +### HasDISPLAY_NAME + +`func (o *EntitlementManuallyUpdatedFields) HasDISPLAY_NAME() bool` + +HasDISPLAY_NAME returns a boolean if a field has been set. + +### GetDESCRIPTION + +`func (o *EntitlementManuallyUpdatedFields) GetDESCRIPTION() bool` + +GetDESCRIPTION returns the DESCRIPTION field if non-nil, zero value otherwise. + +### GetDESCRIPTIONOk + +`func (o *EntitlementManuallyUpdatedFields) GetDESCRIPTIONOk() (*bool, bool)` + +GetDESCRIPTIONOk returns a tuple with the DESCRIPTION field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDESCRIPTION + +`func (o *EntitlementManuallyUpdatedFields) SetDESCRIPTION(v bool)` + +SetDESCRIPTION sets DESCRIPTION field to given value. + +### HasDESCRIPTION + +`func (o *EntitlementManuallyUpdatedFields) HasDESCRIPTION() bool` + +HasDESCRIPTION returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/EntitlementOwner.md b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementOwner.md new file mode 100644 index 000000000..cacf13a89 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementOwner.md @@ -0,0 +1,116 @@ +--- +id: beta-entitlement-owner +title: EntitlementOwner +pagination_label: EntitlementOwner +sidebar_label: EntitlementOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementOwner', 'BetaEntitlementOwner'] +slug: /tools/sdk/go/beta/models/entitlement-owner +tags: ['SDK', 'Software Development Kit', 'EntitlementOwner', 'BetaEntitlementOwner'] +--- + +# EntitlementOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The owner id for the entitlement | [optional] +**Name** | Pointer to **string** | The owner name for the entitlement | [optional] +**Type** | Pointer to **string** | The type of the owner. Initially only type IDENTITY is supported | [optional] + +## Methods + +### NewEntitlementOwner + +`func NewEntitlementOwner() *EntitlementOwner` + +NewEntitlementOwner instantiates a new EntitlementOwner 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 + +### NewEntitlementOwnerWithDefaults + +`func NewEntitlementOwnerWithDefaults() *EntitlementOwner` + +NewEntitlementOwnerWithDefaults instantiates a new EntitlementOwner 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 + +### GetId + +`func (o *EntitlementOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *EntitlementOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/EntitlementRef.md b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementRef.md new file mode 100644 index 000000000..552968e4a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementRef.md @@ -0,0 +1,126 @@ +--- +id: beta-entitlement-ref +title: EntitlementRef +pagination_label: EntitlementRef +sidebar_label: EntitlementRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementRef', 'BetaEntitlementRef'] +slug: /tools/sdk/go/beta/models/entitlement-ref +tags: ['SDK', 'Software Development Kit', 'EntitlementRef', 'BetaEntitlementRef'] +--- + +# EntitlementRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Entitlement's DTO type. | [optional] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **NullableString** | Entitlement's display name. | [optional] + +## Methods + +### NewEntitlementRef + +`func NewEntitlementRef() *EntitlementRef` + +NewEntitlementRef instantiates a new EntitlementRef 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 + +### NewEntitlementRefWithDefaults + +`func NewEntitlementRefWithDefaults() *EntitlementRef` + +NewEntitlementRefWithDefaults instantiates a new EntitlementRef 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 + +### GetType + +`func (o *EntitlementRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *EntitlementRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementRef) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *EntitlementRef) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *EntitlementRef) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/EntitlementRequestConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementRequestConfig.md new file mode 100644 index 000000000..7feb51e32 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementRequestConfig.md @@ -0,0 +1,64 @@ +--- +id: beta-entitlement-request-config +title: EntitlementRequestConfig +pagination_label: EntitlementRequestConfig +sidebar_label: EntitlementRequestConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementRequestConfig', 'BetaEntitlementRequestConfig'] +slug: /tools/sdk/go/beta/models/entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig', 'BetaEntitlementRequestConfig'] +--- + +# EntitlementRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestConfig** | Pointer to [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] + +## Methods + +### NewEntitlementRequestConfig + +`func NewEntitlementRequestConfig() *EntitlementRequestConfig` + +NewEntitlementRequestConfig instantiates a new EntitlementRequestConfig 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 + +### NewEntitlementRequestConfigWithDefaults + +`func NewEntitlementRequestConfigWithDefaults() *EntitlementRequestConfig` + +NewEntitlementRequestConfigWithDefaults instantiates a new EntitlementRequestConfig 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 + +### GetAccessRequestConfig + +`func (o *EntitlementRequestConfig) GetAccessRequestConfig() EntitlementAccessRequestConfig` + +GetAccessRequestConfig returns the AccessRequestConfig field if non-nil, zero value otherwise. + +### GetAccessRequestConfigOk + +`func (o *EntitlementRequestConfig) GetAccessRequestConfigOk() (*EntitlementAccessRequestConfig, bool)` + +GetAccessRequestConfigOk returns a tuple with the AccessRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestConfig + +`func (o *EntitlementRequestConfig) SetAccessRequestConfig(v EntitlementAccessRequestConfig)` + +SetAccessRequestConfig sets AccessRequestConfig field to given value. + +### HasAccessRequestConfig + +`func (o *EntitlementRequestConfig) HasAccessRequestConfig() bool` + +HasAccessRequestConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/EntitlementRequestConfig1.md b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementRequestConfig1.md new file mode 100644 index 000000000..c3f843d88 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementRequestConfig1.md @@ -0,0 +1,152 @@ +--- +id: beta-entitlement-request-config1 +title: EntitlementRequestConfig1 +pagination_label: EntitlementRequestConfig1 +sidebar_label: EntitlementRequestConfig1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementRequestConfig1', 'BetaEntitlementRequestConfig1'] +slug: /tools/sdk/go/beta/models/entitlement-request-config1 +tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig1', 'BetaEntitlementRequestConfig1'] +--- + +# EntitlementRequestConfig1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AllowEntitlementRequest** | Pointer to **bool** | If this is true, entitlement requests are allowed. | [optional] [default to false] +**RequestCommentsRequired** | Pointer to **bool** | If this is true, comments are required to submit entitlement requests. | [optional] [default to false] +**DeniedCommentsRequired** | Pointer to **bool** | If this is true, comments are required to reject entitlement requests. | [optional] [default to false] +**GrantRequestApprovalSchemes** | Pointer to **NullableString** | Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"`workgroup:{id}`\". You can use multiple governance groups (workgroups). | [optional] [default to "sourceOwner"] + +## Methods + +### NewEntitlementRequestConfig1 + +`func NewEntitlementRequestConfig1() *EntitlementRequestConfig1` + +NewEntitlementRequestConfig1 instantiates a new EntitlementRequestConfig1 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 + +### NewEntitlementRequestConfig1WithDefaults + +`func NewEntitlementRequestConfig1WithDefaults() *EntitlementRequestConfig1` + +NewEntitlementRequestConfig1WithDefaults instantiates a new EntitlementRequestConfig1 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 + +### GetAllowEntitlementRequest + +`func (o *EntitlementRequestConfig1) GetAllowEntitlementRequest() bool` + +GetAllowEntitlementRequest returns the AllowEntitlementRequest field if non-nil, zero value otherwise. + +### GetAllowEntitlementRequestOk + +`func (o *EntitlementRequestConfig1) GetAllowEntitlementRequestOk() (*bool, bool)` + +GetAllowEntitlementRequestOk returns a tuple with the AllowEntitlementRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllowEntitlementRequest + +`func (o *EntitlementRequestConfig1) SetAllowEntitlementRequest(v bool)` + +SetAllowEntitlementRequest sets AllowEntitlementRequest field to given value. + +### HasAllowEntitlementRequest + +`func (o *EntitlementRequestConfig1) HasAllowEntitlementRequest() bool` + +HasAllowEntitlementRequest returns a boolean if a field has been set. + +### GetRequestCommentsRequired + +`func (o *EntitlementRequestConfig1) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *EntitlementRequestConfig1) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *EntitlementRequestConfig1) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *EntitlementRequestConfig1) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + +### GetDeniedCommentsRequired + +`func (o *EntitlementRequestConfig1) GetDeniedCommentsRequired() bool` + +GetDeniedCommentsRequired returns the DeniedCommentsRequired field if non-nil, zero value otherwise. + +### GetDeniedCommentsRequiredOk + +`func (o *EntitlementRequestConfig1) GetDeniedCommentsRequiredOk() (*bool, bool)` + +GetDeniedCommentsRequiredOk returns a tuple with the DeniedCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeniedCommentsRequired + +`func (o *EntitlementRequestConfig1) SetDeniedCommentsRequired(v bool)` + +SetDeniedCommentsRequired sets DeniedCommentsRequired field to given value. + +### HasDeniedCommentsRequired + +`func (o *EntitlementRequestConfig1) HasDeniedCommentsRequired() bool` + +HasDeniedCommentsRequired returns a boolean if a field has been set. + +### GetGrantRequestApprovalSchemes + +`func (o *EntitlementRequestConfig1) GetGrantRequestApprovalSchemes() string` + +GetGrantRequestApprovalSchemes returns the GrantRequestApprovalSchemes field if non-nil, zero value otherwise. + +### GetGrantRequestApprovalSchemesOk + +`func (o *EntitlementRequestConfig1) GetGrantRequestApprovalSchemesOk() (*string, bool)` + +GetGrantRequestApprovalSchemesOk returns a tuple with the GrantRequestApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantRequestApprovalSchemes + +`func (o *EntitlementRequestConfig1) SetGrantRequestApprovalSchemes(v string)` + +SetGrantRequestApprovalSchemes sets GrantRequestApprovalSchemes field to given value. + +### HasGrantRequestApprovalSchemes + +`func (o *EntitlementRequestConfig1) HasGrantRequestApprovalSchemes() bool` + +HasGrantRequestApprovalSchemes returns a boolean if a field has been set. + +### SetGrantRequestApprovalSchemesNil + +`func (o *EntitlementRequestConfig1) SetGrantRequestApprovalSchemesNil(b bool)` + + SetGrantRequestApprovalSchemesNil sets the value for GrantRequestApprovalSchemes to be an explicit nil + +### UnsetGrantRequestApprovalSchemes +`func (o *EntitlementRequestConfig1) UnsetGrantRequestApprovalSchemes()` + +UnsetGrantRequestApprovalSchemes ensures that no value is present for GrantRequestApprovalSchemes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/EntitlementSource.md b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementSource.md new file mode 100644 index 000000000..027401264 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementSource.md @@ -0,0 +1,126 @@ +--- +id: beta-entitlement-source +title: EntitlementSource +pagination_label: EntitlementSource +sidebar_label: EntitlementSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementSource', 'BetaEntitlementSource'] +slug: /tools/sdk/go/beta/models/entitlement-source +tags: ['SDK', 'Software Development Kit', 'EntitlementSource', 'BetaEntitlementSource'] +--- + +# EntitlementSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The source ID | [optional] +**Type** | Pointer to **string** | The source type, will always be \"SOURCE\" | [optional] +**Name** | Pointer to **NullableString** | The source name | [optional] + +## Methods + +### NewEntitlementSource + +`func NewEntitlementSource() *EntitlementSource` + +NewEntitlementSource instantiates a new EntitlementSource 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 + +### NewEntitlementSourceWithDefaults + +`func NewEntitlementSourceWithDefaults() *EntitlementSource` + +NewEntitlementSourceWithDefaults instantiates a new EntitlementSource 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 + +### GetId + +`func (o *EntitlementSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *EntitlementSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementSource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *EntitlementSource) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *EntitlementSource) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/EntitlementSourceResetBaseReferenceDto.md b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementSourceResetBaseReferenceDto.md new file mode 100644 index 000000000..e6f73e85b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/EntitlementSourceResetBaseReferenceDto.md @@ -0,0 +1,116 @@ +--- +id: beta-entitlement-source-reset-base-reference-dto +title: EntitlementSourceResetBaseReferenceDto +pagination_label: EntitlementSourceResetBaseReferenceDto +sidebar_label: EntitlementSourceResetBaseReferenceDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementSourceResetBaseReferenceDto', 'BetaEntitlementSourceResetBaseReferenceDto'] +slug: /tools/sdk/go/beta/models/entitlement-source-reset-base-reference-dto +tags: ['SDK', 'Software Development Kit', 'EntitlementSourceResetBaseReferenceDto', 'BetaEntitlementSourceResetBaseReferenceDto'] +--- + +# EntitlementSourceResetBaseReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The DTO type | [optional] +**Id** | Pointer to **string** | The task ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewEntitlementSourceResetBaseReferenceDto + +`func NewEntitlementSourceResetBaseReferenceDto() *EntitlementSourceResetBaseReferenceDto` + +NewEntitlementSourceResetBaseReferenceDto instantiates a new EntitlementSourceResetBaseReferenceDto 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 + +### NewEntitlementSourceResetBaseReferenceDtoWithDefaults + +`func NewEntitlementSourceResetBaseReferenceDtoWithDefaults() *EntitlementSourceResetBaseReferenceDto` + +NewEntitlementSourceResetBaseReferenceDtoWithDefaults instantiates a new EntitlementSourceResetBaseReferenceDto 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 + +### GetType + +`func (o *EntitlementSourceResetBaseReferenceDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementSourceResetBaseReferenceDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementSourceResetBaseReferenceDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementSourceResetBaseReferenceDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *EntitlementSourceResetBaseReferenceDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementSourceResetBaseReferenceDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementSourceResetBaseReferenceDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementSourceResetBaseReferenceDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementSourceResetBaseReferenceDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementSourceResetBaseReferenceDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementSourceResetBaseReferenceDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementSourceResetBaseReferenceDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/EntityCreatedByDTO.md b/docs/tools/sdk/go/Reference/Beta/Models/EntityCreatedByDTO.md new file mode 100644 index 000000000..4752e4c93 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/EntityCreatedByDTO.md @@ -0,0 +1,90 @@ +--- +id: beta-entity-created-by-dto +title: EntityCreatedByDTO +pagination_label: EntityCreatedByDTO +sidebar_label: EntityCreatedByDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntityCreatedByDTO', 'BetaEntityCreatedByDTO'] +slug: /tools/sdk/go/beta/models/entity-created-by-dto +tags: ['SDK', 'Software Development Kit', 'EntityCreatedByDTO', 'BetaEntityCreatedByDTO'] +--- + +# EntityCreatedByDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the creator | [optional] +**DisplayName** | Pointer to **string** | The display name of the creator | [optional] + +## Methods + +### NewEntityCreatedByDTO + +`func NewEntityCreatedByDTO() *EntityCreatedByDTO` + +NewEntityCreatedByDTO instantiates a new EntityCreatedByDTO 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 + +### NewEntityCreatedByDTOWithDefaults + +`func NewEntityCreatedByDTOWithDefaults() *EntityCreatedByDTO` + +NewEntityCreatedByDTOWithDefaults instantiates a new EntityCreatedByDTO 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 + +### GetId + +`func (o *EntityCreatedByDTO) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntityCreatedByDTO) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntityCreatedByDTO) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntityCreatedByDTO) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *EntityCreatedByDTO) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *EntityCreatedByDTO) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *EntityCreatedByDTO) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *EntityCreatedByDTO) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Error.md b/docs/tools/sdk/go/Reference/Beta/Models/Error.md new file mode 100644 index 000000000..64c89ab71 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Error.md @@ -0,0 +1,116 @@ +--- +id: beta-error +title: Error +pagination_label: Error +sidebar_label: Error +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Error', 'BetaError'] +slug: /tools/sdk/go/beta/models/error +tags: ['SDK', 'Software Development Kit', 'Error', 'BetaError'] +--- + +# Error + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **string** | DetailCode is the text of the status code returned | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | | [optional] +**TrackingId** | Pointer to **string** | TrackingID is the request tracking unique identifier | [optional] + +## Methods + +### NewError + +`func NewError() *Error` + +NewError instantiates a new Error 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 + +### NewErrorWithDefaults + +`func NewErrorWithDefaults() *Error` + +NewErrorWithDefaults instantiates a new Error 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 + +### GetDetailCode + +`func (o *Error) GetDetailCode() string` + +GetDetailCode returns the DetailCode field if non-nil, zero value otherwise. + +### GetDetailCodeOk + +`func (o *Error) GetDetailCodeOk() (*string, bool)` + +GetDetailCodeOk returns a tuple with the DetailCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetailCode + +`func (o *Error) SetDetailCode(v string)` + +SetDetailCode sets DetailCode field to given value. + +### HasDetailCode + +`func (o *Error) HasDetailCode() bool` + +HasDetailCode returns a boolean if a field has been set. + +### GetMessages + +`func (o *Error) GetMessages() []ErrorMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *Error) GetMessagesOk() (*[]ErrorMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *Error) SetMessages(v []ErrorMessage)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *Error) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetTrackingId + +`func (o *Error) GetTrackingId() string` + +GetTrackingId returns the TrackingId field if non-nil, zero value otherwise. + +### GetTrackingIdOk + +`func (o *Error) GetTrackingIdOk() (*string, bool)` + +GetTrackingIdOk returns a tuple with the TrackingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingId + +`func (o *Error) SetTrackingId(v string)` + +SetTrackingId sets TrackingId field to given value. + +### HasTrackingId + +`func (o *Error) HasTrackingId() bool` + +HasTrackingId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ErrorMessage.md b/docs/tools/sdk/go/Reference/Beta/Models/ErrorMessage.md new file mode 100644 index 000000000..415819f6d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ErrorMessage.md @@ -0,0 +1,116 @@ +--- +id: beta-error-message +title: ErrorMessage +pagination_label: ErrorMessage +sidebar_label: ErrorMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ErrorMessage', 'BetaErrorMessage'] +slug: /tools/sdk/go/beta/models/error-message +tags: ['SDK', 'Software Development Kit', 'ErrorMessage', 'BetaErrorMessage'] +--- + +# ErrorMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | Pointer to **string** | Locale is the current Locale | [optional] +**LocaleOrigin** | Pointer to **string** | LocaleOrigin holds possible values of how the locale was selected | [optional] +**Text** | Pointer to **string** | Text is the actual text of the error message | [optional] + +## Methods + +### NewErrorMessage + +`func NewErrorMessage() *ErrorMessage` + +NewErrorMessage instantiates a new ErrorMessage 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 + +### NewErrorMessageWithDefaults + +`func NewErrorMessageWithDefaults() *ErrorMessage` + +NewErrorMessageWithDefaults instantiates a new ErrorMessage 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 + +### GetLocale + +`func (o *ErrorMessage) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *ErrorMessage) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *ErrorMessage) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *ErrorMessage) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + +### GetLocaleOrigin + +`func (o *ErrorMessage) GetLocaleOrigin() string` + +GetLocaleOrigin returns the LocaleOrigin field if non-nil, zero value otherwise. + +### GetLocaleOriginOk + +`func (o *ErrorMessage) GetLocaleOriginOk() (*string, bool)` + +GetLocaleOriginOk returns a tuple with the LocaleOrigin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocaleOrigin + +`func (o *ErrorMessage) SetLocaleOrigin(v string)` + +SetLocaleOrigin sets LocaleOrigin field to given value. + +### HasLocaleOrigin + +`func (o *ErrorMessage) HasLocaleOrigin() bool` + +HasLocaleOrigin returns a boolean if a field has been set. + +### GetText + +`func (o *ErrorMessage) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *ErrorMessage) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *ErrorMessage) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *ErrorMessage) HasText() bool` + +HasText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ErrorMessageDto.md b/docs/tools/sdk/go/Reference/Beta/Models/ErrorMessageDto.md new file mode 100644 index 000000000..f13ae78af --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ErrorMessageDto.md @@ -0,0 +1,136 @@ +--- +id: beta-error-message-dto +title: ErrorMessageDto +pagination_label: ErrorMessageDto +sidebar_label: ErrorMessageDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ErrorMessageDto', 'BetaErrorMessageDto'] +slug: /tools/sdk/go/beta/models/error-message-dto +tags: ['SDK', 'Software Development Kit', 'ErrorMessageDto', 'BetaErrorMessageDto'] +--- + +# ErrorMessageDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | Pointer to **NullableString** | The locale for the message text, a BCP 47 language tag. | [optional] +**LocaleOrigin** | Pointer to [**NullableLocaleOrigin**](locale-origin) | | [optional] +**Text** | Pointer to **string** | Actual text of the error message in the indicated locale. | [optional] + +## Methods + +### NewErrorMessageDto + +`func NewErrorMessageDto() *ErrorMessageDto` + +NewErrorMessageDto instantiates a new ErrorMessageDto 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 + +### NewErrorMessageDtoWithDefaults + +`func NewErrorMessageDtoWithDefaults() *ErrorMessageDto` + +NewErrorMessageDtoWithDefaults instantiates a new ErrorMessageDto 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 + +### GetLocale + +`func (o *ErrorMessageDto) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *ErrorMessageDto) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *ErrorMessageDto) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *ErrorMessageDto) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + +### SetLocaleNil + +`func (o *ErrorMessageDto) SetLocaleNil(b bool)` + + SetLocaleNil sets the value for Locale to be an explicit nil + +### UnsetLocale +`func (o *ErrorMessageDto) UnsetLocale()` + +UnsetLocale ensures that no value is present for Locale, not even an explicit nil +### GetLocaleOrigin + +`func (o *ErrorMessageDto) GetLocaleOrigin() LocaleOrigin` + +GetLocaleOrigin returns the LocaleOrigin field if non-nil, zero value otherwise. + +### GetLocaleOriginOk + +`func (o *ErrorMessageDto) GetLocaleOriginOk() (*LocaleOrigin, bool)` + +GetLocaleOriginOk returns a tuple with the LocaleOrigin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocaleOrigin + +`func (o *ErrorMessageDto) SetLocaleOrigin(v LocaleOrigin)` + +SetLocaleOrigin sets LocaleOrigin field to given value. + +### HasLocaleOrigin + +`func (o *ErrorMessageDto) HasLocaleOrigin() bool` + +HasLocaleOrigin returns a boolean if a field has been set. + +### SetLocaleOriginNil + +`func (o *ErrorMessageDto) SetLocaleOriginNil(b bool)` + + SetLocaleOriginNil sets the value for LocaleOrigin to be an explicit nil + +### UnsetLocaleOrigin +`func (o *ErrorMessageDto) UnsetLocaleOrigin()` + +UnsetLocaleOrigin ensures that no value is present for LocaleOrigin, not even an explicit nil +### GetText + +`func (o *ErrorMessageDto) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *ErrorMessageDto) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *ErrorMessageDto) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *ErrorMessageDto) HasText() bool` + +HasText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ErrorResponseDto.md b/docs/tools/sdk/go/Reference/Beta/Models/ErrorResponseDto.md new file mode 100644 index 000000000..ae5b028df --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ErrorResponseDto.md @@ -0,0 +1,142 @@ +--- +id: beta-error-response-dto +title: ErrorResponseDto +pagination_label: ErrorResponseDto +sidebar_label: ErrorResponseDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ErrorResponseDto', 'BetaErrorResponseDto'] +slug: /tools/sdk/go/beta/models/error-response-dto +tags: ['SDK', 'Software Development Kit', 'ErrorResponseDto', 'BetaErrorResponseDto'] +--- + +# ErrorResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **string** | Fine-grained error code providing more detail of the error. | [optional] +**TrackingId** | Pointer to **string** | Unique tracking id for the error. | [optional] +**Messages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Generic localized reason for error | [optional] +**Causes** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [optional] + +## Methods + +### NewErrorResponseDto + +`func NewErrorResponseDto() *ErrorResponseDto` + +NewErrorResponseDto instantiates a new ErrorResponseDto 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 + +### NewErrorResponseDtoWithDefaults + +`func NewErrorResponseDtoWithDefaults() *ErrorResponseDto` + +NewErrorResponseDtoWithDefaults instantiates a new ErrorResponseDto 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 + +### GetDetailCode + +`func (o *ErrorResponseDto) GetDetailCode() string` + +GetDetailCode returns the DetailCode field if non-nil, zero value otherwise. + +### GetDetailCodeOk + +`func (o *ErrorResponseDto) GetDetailCodeOk() (*string, bool)` + +GetDetailCodeOk returns a tuple with the DetailCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetailCode + +`func (o *ErrorResponseDto) SetDetailCode(v string)` + +SetDetailCode sets DetailCode field to given value. + +### HasDetailCode + +`func (o *ErrorResponseDto) HasDetailCode() bool` + +HasDetailCode returns a boolean if a field has been set. + +### GetTrackingId + +`func (o *ErrorResponseDto) GetTrackingId() string` + +GetTrackingId returns the TrackingId field if non-nil, zero value otherwise. + +### GetTrackingIdOk + +`func (o *ErrorResponseDto) GetTrackingIdOk() (*string, bool)` + +GetTrackingIdOk returns a tuple with the TrackingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingId + +`func (o *ErrorResponseDto) SetTrackingId(v string)` + +SetTrackingId sets TrackingId field to given value. + +### HasTrackingId + +`func (o *ErrorResponseDto) HasTrackingId() bool` + +HasTrackingId returns a boolean if a field has been set. + +### GetMessages + +`func (o *ErrorResponseDto) GetMessages() []ErrorMessageDto` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *ErrorResponseDto) GetMessagesOk() (*[]ErrorMessageDto, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *ErrorResponseDto) SetMessages(v []ErrorMessageDto)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *ErrorResponseDto) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetCauses + +`func (o *ErrorResponseDto) GetCauses() []ErrorMessageDto` + +GetCauses returns the Causes field if non-nil, zero value otherwise. + +### GetCausesOk + +`func (o *ErrorResponseDto) GetCausesOk() (*[]ErrorMessageDto, bool)` + +GetCausesOk returns a tuple with the Causes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCauses + +`func (o *ErrorResponseDto) SetCauses(v []ErrorMessageDto)` + +SetCauses sets Causes field to given value. + +### HasCauses + +`func (o *ErrorResponseDto) HasCauses() bool` + +HasCauses returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/EvaluateResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/EvaluateResponse.md new file mode 100644 index 000000000..c426865b8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/EvaluateResponse.md @@ -0,0 +1,90 @@ +--- +id: beta-evaluate-response +title: EvaluateResponse +pagination_label: EvaluateResponse +sidebar_label: EvaluateResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EvaluateResponse', 'BetaEvaluateResponse'] +slug: /tools/sdk/go/beta/models/evaluate-response +tags: ['SDK', 'Software Development Kit', 'EvaluateResponse', 'BetaEvaluateResponse'] +--- + +# EvaluateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReassignToId** | Pointer to **string** | The Identity ID which should be the recipient of any work items sent to a specific identity & work type | [optional] +**LookupTrail** | Pointer to [**[]LookupStep**](lookup-step) | List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration | [optional] + +## Methods + +### NewEvaluateResponse + +`func NewEvaluateResponse() *EvaluateResponse` + +NewEvaluateResponse instantiates a new EvaluateResponse 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 + +### NewEvaluateResponseWithDefaults + +`func NewEvaluateResponseWithDefaults() *EvaluateResponse` + +NewEvaluateResponseWithDefaults instantiates a new EvaluateResponse 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 + +### GetReassignToId + +`func (o *EvaluateResponse) GetReassignToId() string` + +GetReassignToId returns the ReassignToId field if non-nil, zero value otherwise. + +### GetReassignToIdOk + +`func (o *EvaluateResponse) GetReassignToIdOk() (*string, bool)` + +GetReassignToIdOk returns a tuple with the ReassignToId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignToId + +`func (o *EvaluateResponse) SetReassignToId(v string)` + +SetReassignToId sets ReassignToId field to given value. + +### HasReassignToId + +`func (o *EvaluateResponse) HasReassignToId() bool` + +HasReassignToId returns a boolean if a field has been set. + +### GetLookupTrail + +`func (o *EvaluateResponse) GetLookupTrail() []LookupStep` + +GetLookupTrail returns the LookupTrail field if non-nil, zero value otherwise. + +### GetLookupTrailOk + +`func (o *EvaluateResponse) GetLookupTrailOk() (*[]LookupStep, bool)` + +GetLookupTrailOk returns a tuple with the LookupTrail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLookupTrail + +`func (o *EvaluateResponse) SetLookupTrail(v []LookupStep)` + +SetLookupTrail sets LookupTrail field to given value. + +### HasLookupTrail + +`func (o *EvaluateResponse) HasLookupTrail() bool` + +HasLookupTrail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/EventBridgeConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/EventBridgeConfig.md new file mode 100644 index 000000000..cac6b0690 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/EventBridgeConfig.md @@ -0,0 +1,80 @@ +--- +id: beta-event-bridge-config +title: EventBridgeConfig +pagination_label: EventBridgeConfig +sidebar_label: EventBridgeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EventBridgeConfig', 'BetaEventBridgeConfig'] +slug: /tools/sdk/go/beta/models/event-bridge-config +tags: ['SDK', 'Software Development Kit', 'EventBridgeConfig', 'BetaEventBridgeConfig'] +--- + +# EventBridgeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AwsAccount** | **string** | AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource. | +**AwsRegion** | **string** | AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values. | + +## Methods + +### NewEventBridgeConfig + +`func NewEventBridgeConfig(awsAccount string, awsRegion string, ) *EventBridgeConfig` + +NewEventBridgeConfig instantiates a new EventBridgeConfig 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 + +### NewEventBridgeConfigWithDefaults + +`func NewEventBridgeConfigWithDefaults() *EventBridgeConfig` + +NewEventBridgeConfigWithDefaults instantiates a new EventBridgeConfig 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 + +### GetAwsAccount + +`func (o *EventBridgeConfig) GetAwsAccount() string` + +GetAwsAccount returns the AwsAccount field if non-nil, zero value otherwise. + +### GetAwsAccountOk + +`func (o *EventBridgeConfig) GetAwsAccountOk() (*string, bool)` + +GetAwsAccountOk returns a tuple with the AwsAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsAccount + +`func (o *EventBridgeConfig) SetAwsAccount(v string)` + +SetAwsAccount sets AwsAccount field to given value. + + +### GetAwsRegion + +`func (o *EventBridgeConfig) GetAwsRegion() string` + +GetAwsRegion returns the AwsRegion field if non-nil, zero value otherwise. + +### GetAwsRegionOk + +`func (o *EventBridgeConfig) GetAwsRegionOk() (*string, bool)` + +GetAwsRegionOk returns a tuple with the AwsRegion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsRegion + +`func (o *EventBridgeConfig) SetAwsRegion(v string)` + +SetAwsRegion sets AwsRegion field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ExceptionAccessCriteria.md b/docs/tools/sdk/go/Reference/Beta/Models/ExceptionAccessCriteria.md new file mode 100644 index 000000000..edb45c4c8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ExceptionAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: beta-exception-access-criteria +title: ExceptionAccessCriteria +pagination_label: ExceptionAccessCriteria +sidebar_label: ExceptionAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExceptionAccessCriteria', 'BetaExceptionAccessCriteria'] +slug: /tools/sdk/go/beta/models/exception-access-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionAccessCriteria', 'BetaExceptionAccessCriteria'] +--- + +# ExceptionAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] +**RightCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] + +## Methods + +### NewExceptionAccessCriteria + +`func NewExceptionAccessCriteria() *ExceptionAccessCriteria` + +NewExceptionAccessCriteria instantiates a new ExceptionAccessCriteria 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 + +### NewExceptionAccessCriteriaWithDefaults + +`func NewExceptionAccessCriteriaWithDefaults() *ExceptionAccessCriteria` + +NewExceptionAccessCriteriaWithDefaults instantiates a new ExceptionAccessCriteria 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 + +### GetLeftCriteria + +`func (o *ExceptionAccessCriteria) GetLeftCriteria() ExceptionCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *ExceptionAccessCriteria) GetLeftCriteriaOk() (*ExceptionCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *ExceptionAccessCriteria) SetLeftCriteria(v ExceptionCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *ExceptionAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *ExceptionAccessCriteria) GetRightCriteria() ExceptionCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *ExceptionAccessCriteria) GetRightCriteriaOk() (*ExceptionCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *ExceptionAccessCriteria) SetRightCriteria(v ExceptionCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *ExceptionAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ExceptionCriteria.md b/docs/tools/sdk/go/Reference/Beta/Models/ExceptionCriteria.md new file mode 100644 index 000000000..e93a955e9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ExceptionCriteria.md @@ -0,0 +1,64 @@ +--- +id: beta-exception-criteria +title: ExceptionCriteria +pagination_label: ExceptionCriteria +sidebar_label: ExceptionCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExceptionCriteria', 'BetaExceptionCriteria'] +slug: /tools/sdk/go/beta/models/exception-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteria', 'BetaExceptionCriteria'] +--- + +# ExceptionCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]ExceptionCriteriaCriteriaListInner**](exception-criteria-criteria-list-inner) | List of exception criteria. There is a min of 1 and max of 50 items in the list. | [optional] + +## Methods + +### NewExceptionCriteria + +`func NewExceptionCriteria() *ExceptionCriteria` + +NewExceptionCriteria instantiates a new ExceptionCriteria 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 + +### NewExceptionCriteriaWithDefaults + +`func NewExceptionCriteriaWithDefaults() *ExceptionCriteria` + +NewExceptionCriteriaWithDefaults instantiates a new ExceptionCriteria 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 + +### GetCriteriaList + +`func (o *ExceptionCriteria) GetCriteriaList() []ExceptionCriteriaCriteriaListInner` + +GetCriteriaList returns the CriteriaList field if non-nil, zero value otherwise. + +### GetCriteriaListOk + +`func (o *ExceptionCriteria) GetCriteriaListOk() (*[]ExceptionCriteriaCriteriaListInner, bool)` + +GetCriteriaListOk returns a tuple with the CriteriaList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteriaList + +`func (o *ExceptionCriteria) SetCriteriaList(v []ExceptionCriteriaCriteriaListInner)` + +SetCriteriaList sets CriteriaList field to given value. + +### HasCriteriaList + +`func (o *ExceptionCriteria) HasCriteriaList() bool` + +HasCriteriaList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ExceptionCriteriaAccess.md b/docs/tools/sdk/go/Reference/Beta/Models/ExceptionCriteriaAccess.md new file mode 100644 index 000000000..43be3a3c7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ExceptionCriteriaAccess.md @@ -0,0 +1,142 @@ +--- +id: beta-exception-criteria-access +title: ExceptionCriteriaAccess +pagination_label: ExceptionCriteriaAccess +sidebar_label: ExceptionCriteriaAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExceptionCriteriaAccess', 'BetaExceptionCriteriaAccess'] +slug: /tools/sdk/go/beta/models/exception-criteria-access +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaAccess', 'BetaExceptionCriteriaAccess'] +--- + +# ExceptionCriteriaAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] +**Existing** | Pointer to **bool** | Whether the subject identity already had that access or not | [optional] + +## Methods + +### NewExceptionCriteriaAccess + +`func NewExceptionCriteriaAccess() *ExceptionCriteriaAccess` + +NewExceptionCriteriaAccess instantiates a new ExceptionCriteriaAccess 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 + +### NewExceptionCriteriaAccessWithDefaults + +`func NewExceptionCriteriaAccessWithDefaults() *ExceptionCriteriaAccess` + +NewExceptionCriteriaAccessWithDefaults instantiates a new ExceptionCriteriaAccess 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 + +### GetType + +`func (o *ExceptionCriteriaAccess) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ExceptionCriteriaAccess) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ExceptionCriteriaAccess) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ExceptionCriteriaAccess) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ExceptionCriteriaAccess) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ExceptionCriteriaAccess) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ExceptionCriteriaAccess) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ExceptionCriteriaAccess) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ExceptionCriteriaAccess) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ExceptionCriteriaAccess) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ExceptionCriteriaAccess) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ExceptionCriteriaAccess) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetExisting + +`func (o *ExceptionCriteriaAccess) GetExisting() bool` + +GetExisting returns the Existing field if non-nil, zero value otherwise. + +### GetExistingOk + +`func (o *ExceptionCriteriaAccess) GetExistingOk() (*bool, bool)` + +GetExistingOk returns a tuple with the Existing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExisting + +`func (o *ExceptionCriteriaAccess) SetExisting(v bool)` + +SetExisting sets Existing field to given value. + +### HasExisting + +`func (o *ExceptionCriteriaAccess) HasExisting() bool` + +HasExisting returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ExceptionCriteriaCriteriaListInner.md b/docs/tools/sdk/go/Reference/Beta/Models/ExceptionCriteriaCriteriaListInner.md new file mode 100644 index 000000000..0c9775d08 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ExceptionCriteriaCriteriaListInner.md @@ -0,0 +1,142 @@ +--- +id: beta-exception-criteria-criteria-list-inner +title: ExceptionCriteriaCriteriaListInner +pagination_label: ExceptionCriteriaCriteriaListInner +sidebar_label: ExceptionCriteriaCriteriaListInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExceptionCriteriaCriteriaListInner', 'BetaExceptionCriteriaCriteriaListInner'] +slug: /tools/sdk/go/beta/models/exception-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaCriteriaListInner', 'BetaExceptionCriteriaCriteriaListInner'] +--- + +# ExceptionCriteriaCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **map[string]interface{}** | The type of object that is referenced | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] +**Existing** | Pointer to **bool** | Whether the subject identity already had that access or not | [optional] + +## Methods + +### NewExceptionCriteriaCriteriaListInner + +`func NewExceptionCriteriaCriteriaListInner() *ExceptionCriteriaCriteriaListInner` + +NewExceptionCriteriaCriteriaListInner instantiates a new ExceptionCriteriaCriteriaListInner 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 + +### NewExceptionCriteriaCriteriaListInnerWithDefaults + +`func NewExceptionCriteriaCriteriaListInnerWithDefaults() *ExceptionCriteriaCriteriaListInner` + +NewExceptionCriteriaCriteriaListInnerWithDefaults instantiates a new ExceptionCriteriaCriteriaListInner 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 + +### GetType + +`func (o *ExceptionCriteriaCriteriaListInner) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ExceptionCriteriaCriteriaListInner) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ExceptionCriteriaCriteriaListInner) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + +### HasType + +`func (o *ExceptionCriteriaCriteriaListInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ExceptionCriteriaCriteriaListInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ExceptionCriteriaCriteriaListInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ExceptionCriteriaCriteriaListInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ExceptionCriteriaCriteriaListInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ExceptionCriteriaCriteriaListInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ExceptionCriteriaCriteriaListInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ExceptionCriteriaCriteriaListInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ExceptionCriteriaCriteriaListInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetExisting + +`func (o *ExceptionCriteriaCriteriaListInner) GetExisting() bool` + +GetExisting returns the Existing field if non-nil, zero value otherwise. + +### GetExistingOk + +`func (o *ExceptionCriteriaCriteriaListInner) GetExistingOk() (*bool, bool)` + +GetExistingOk returns a tuple with the Existing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExisting + +`func (o *ExceptionCriteriaCriteriaListInner) SetExisting(v bool)` + +SetExisting sets Existing field to given value. + +### HasExisting + +`func (o *ExceptionCriteriaCriteriaListInner) HasExisting() bool` + +HasExisting returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ExecutionStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/ExecutionStatus.md new file mode 100644 index 000000000..90031f146 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ExecutionStatus.md @@ -0,0 +1,25 @@ +--- +id: beta-execution-status +title: ExecutionStatus +pagination_label: ExecutionStatus +sidebar_label: ExecutionStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExecutionStatus', 'BetaExecutionStatus'] +slug: /tools/sdk/go/beta/models/execution-status +tags: ['SDK', 'Software Development Kit', 'ExecutionStatus', 'BetaExecutionStatus'] +--- + +# ExecutionStatus + +## Enum + + +* `EXECUTING` (value: `"EXECUTING"`) + +* `VERIFYING` (value: `"VERIFYING"`) + +* `TERMINATED` (value: `"TERMINATED"`) + +* `COMPLETED` (value: `"COMPLETED"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ExportFormDefinitionsByTenant200ResponseInner.md b/docs/tools/sdk/go/Reference/Beta/Models/ExportFormDefinitionsByTenant200ResponseInner.md new file mode 100644 index 000000000..312794fe7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ExportFormDefinitionsByTenant200ResponseInner.md @@ -0,0 +1,116 @@ +--- +id: beta-export-form-definitions-by-tenant200-response-inner +title: ExportFormDefinitionsByTenant200ResponseInner +pagination_label: ExportFormDefinitionsByTenant200ResponseInner +sidebar_label: ExportFormDefinitionsByTenant200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExportFormDefinitionsByTenant200ResponseInner', 'BetaExportFormDefinitionsByTenant200ResponseInner'] +slug: /tools/sdk/go/beta/models/export-form-definitions-by-tenant200-response-inner +tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenant200ResponseInner', 'BetaExportFormDefinitionsByTenant200ResponseInner'] +--- + +# ExportFormDefinitionsByTenant200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Object** | Pointer to [**FormDefinitionResponse**](form-definition-response) | | [optional] +**Self** | Pointer to [**FormDefinitionSelfImportExportDto**](form-definition-self-import-export-dto) | | [optional] +**Version** | Pointer to **int32** | | [optional] + +## Methods + +### NewExportFormDefinitionsByTenant200ResponseInner + +`func NewExportFormDefinitionsByTenant200ResponseInner() *ExportFormDefinitionsByTenant200ResponseInner` + +NewExportFormDefinitionsByTenant200ResponseInner instantiates a new ExportFormDefinitionsByTenant200ResponseInner 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 + +### NewExportFormDefinitionsByTenant200ResponseInnerWithDefaults + +`func NewExportFormDefinitionsByTenant200ResponseInnerWithDefaults() *ExportFormDefinitionsByTenant200ResponseInner` + +NewExportFormDefinitionsByTenant200ResponseInnerWithDefaults instantiates a new ExportFormDefinitionsByTenant200ResponseInner 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 + +### GetObject + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetObject() FormDefinitionResponse` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetObjectOk() (*FormDefinitionResponse, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) SetObject(v FormDefinitionResponse)` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) HasObject() bool` + +HasObject returns a boolean if a field has been set. + +### GetSelf + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetSelf() FormDefinitionSelfImportExportDto` + +GetSelf returns the Self field if non-nil, zero value otherwise. + +### GetSelfOk + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetSelfOk() (*FormDefinitionSelfImportExportDto, bool)` + +GetSelfOk returns a tuple with the Self field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelf + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) SetSelf(v FormDefinitionSelfImportExportDto)` + +SetSelf sets Self field to given value. + +### HasSelf + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) HasSelf() bool` + +HasSelf returns a boolean if a field has been set. + +### GetVersion + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ExportOptions.md b/docs/tools/sdk/go/Reference/Beta/Models/ExportOptions.md new file mode 100644 index 000000000..8e32a91e4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ExportOptions.md @@ -0,0 +1,116 @@ +--- +id: beta-export-options +title: ExportOptions +pagination_label: ExportOptions +sidebar_label: ExportOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExportOptions', 'BetaExportOptions'] +slug: /tools/sdk/go/beta/models/export-options +tags: ['SDK', 'Software Development Kit', 'ExportOptions', 'BetaExportOptions'] +--- + +# ExportOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExcludeTypes** | Pointer to **[]string** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]string** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] + +## Methods + +### NewExportOptions + +`func NewExportOptions() *ExportOptions` + +NewExportOptions instantiates a new ExportOptions 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 + +### NewExportOptionsWithDefaults + +`func NewExportOptionsWithDefaults() *ExportOptions` + +NewExportOptionsWithDefaults instantiates a new ExportOptions 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 + +### GetExcludeTypes + +`func (o *ExportOptions) GetExcludeTypes() []string` + +GetExcludeTypes returns the ExcludeTypes field if non-nil, zero value otherwise. + +### GetExcludeTypesOk + +`func (o *ExportOptions) GetExcludeTypesOk() (*[]string, bool)` + +GetExcludeTypesOk returns a tuple with the ExcludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeTypes + +`func (o *ExportOptions) SetExcludeTypes(v []string)` + +SetExcludeTypes sets ExcludeTypes field to given value. + +### HasExcludeTypes + +`func (o *ExportOptions) HasExcludeTypes() bool` + +HasExcludeTypes returns a boolean if a field has been set. + +### GetIncludeTypes + +`func (o *ExportOptions) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *ExportOptions) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *ExportOptions) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *ExportOptions) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *ExportOptions) GetObjectOptions() map[string]ObjectExportImportOptions` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *ExportOptions) GetObjectOptionsOk() (*map[string]ObjectExportImportOptions, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *ExportOptions) SetObjectOptions(v map[string]ObjectExportImportOptions)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *ExportOptions) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ExportPayload.md b/docs/tools/sdk/go/Reference/Beta/Models/ExportPayload.md new file mode 100644 index 000000000..bd5e27812 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ExportPayload.md @@ -0,0 +1,142 @@ +--- +id: beta-export-payload +title: ExportPayload +pagination_label: ExportPayload +sidebar_label: ExportPayload +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExportPayload', 'BetaExportPayload'] +slug: /tools/sdk/go/beta/models/export-payload +tags: ['SDK', 'Software Development Kit', 'ExportPayload', 'BetaExportPayload'] +--- + +# ExportPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Optional user defined description/name for export job. | [optional] +**ExcludeTypes** | Pointer to **[]string** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]string** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] + +## Methods + +### NewExportPayload + +`func NewExportPayload() *ExportPayload` + +NewExportPayload instantiates a new ExportPayload 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 + +### NewExportPayloadWithDefaults + +`func NewExportPayloadWithDefaults() *ExportPayload` + +NewExportPayloadWithDefaults instantiates a new ExportPayload 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 + +### GetDescription + +`func (o *ExportPayload) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ExportPayload) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ExportPayload) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ExportPayload) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetExcludeTypes + +`func (o *ExportPayload) GetExcludeTypes() []string` + +GetExcludeTypes returns the ExcludeTypes field if non-nil, zero value otherwise. + +### GetExcludeTypesOk + +`func (o *ExportPayload) GetExcludeTypesOk() (*[]string, bool)` + +GetExcludeTypesOk returns a tuple with the ExcludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeTypes + +`func (o *ExportPayload) SetExcludeTypes(v []string)` + +SetExcludeTypes sets ExcludeTypes field to given value. + +### HasExcludeTypes + +`func (o *ExportPayload) HasExcludeTypes() bool` + +HasExcludeTypes returns a boolean if a field has been set. + +### GetIncludeTypes + +`func (o *ExportPayload) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *ExportPayload) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *ExportPayload) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *ExportPayload) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *ExportPayload) GetObjectOptions() map[string]ObjectExportImportOptions` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *ExportPayload) GetObjectOptionsOk() (*map[string]ObjectExportImportOptions, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *ExportPayload) SetObjectOptions(v map[string]ObjectExportImportOptions)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *ExportPayload) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Expression.md b/docs/tools/sdk/go/Reference/Beta/Models/Expression.md new file mode 100644 index 000000000..146119823 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Expression.md @@ -0,0 +1,172 @@ +--- +id: beta-expression +title: Expression +pagination_label: Expression +sidebar_label: Expression +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Expression', 'BetaExpression'] +slug: /tools/sdk/go/beta/models/expression +tags: ['SDK', 'Software Development Kit', 'Expression', 'BetaExpression'] +--- + +# Expression + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **string** | Operator for the expression | [optional] +**Attribute** | Pointer to **NullableString** | Name for the attribute | [optional] +**Value** | Pointer to [**NullableValue**](value) | | [optional] +**Children** | Pointer to [**[]Children**](children) | List of expressions | [optional] + +## Methods + +### NewExpression + +`func NewExpression() *Expression` + +NewExpression instantiates a new Expression 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 + +### NewExpressionWithDefaults + +`func NewExpressionWithDefaults() *Expression` + +NewExpressionWithDefaults instantiates a new Expression 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 + +### GetOperator + +`func (o *Expression) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *Expression) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *Expression) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *Expression) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetAttribute + +`func (o *Expression) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *Expression) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *Expression) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *Expression) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *Expression) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *Expression) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *Expression) GetValue() Value` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Expression) GetValueOk() (*Value, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Expression) SetValue(v Value)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Expression) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *Expression) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *Expression) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *Expression) GetChildren() []Children` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *Expression) GetChildrenOk() (*[]Children, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *Expression) SetChildren(v []Children)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *Expression) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *Expression) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *Expression) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FeatureValueDto.md b/docs/tools/sdk/go/Reference/Beta/Models/FeatureValueDto.md new file mode 100644 index 000000000..349e20faf --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FeatureValueDto.md @@ -0,0 +1,116 @@ +--- +id: beta-feature-value-dto +title: FeatureValueDto +pagination_label: FeatureValueDto +sidebar_label: FeatureValueDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FeatureValueDto', 'BetaFeatureValueDto'] +slug: /tools/sdk/go/beta/models/feature-value-dto +tags: ['SDK', 'Software Development Kit', 'FeatureValueDto', 'BetaFeatureValueDto'] +--- + +# FeatureValueDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Feature** | Pointer to **string** | The type of feature | [optional] +**Numerator** | Pointer to **int32** | The number of identities that have access to the feature | [optional] +**Denominator** | Pointer to **int32** | The number of identities with the corresponding feature | [optional] + +## Methods + +### NewFeatureValueDto + +`func NewFeatureValueDto() *FeatureValueDto` + +NewFeatureValueDto instantiates a new FeatureValueDto 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 + +### NewFeatureValueDtoWithDefaults + +`func NewFeatureValueDtoWithDefaults() *FeatureValueDto` + +NewFeatureValueDtoWithDefaults instantiates a new FeatureValueDto 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 + +### GetFeature + +`func (o *FeatureValueDto) GetFeature() string` + +GetFeature returns the Feature field if non-nil, zero value otherwise. + +### GetFeatureOk + +`func (o *FeatureValueDto) GetFeatureOk() (*string, bool)` + +GetFeatureOk returns a tuple with the Feature field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeature + +`func (o *FeatureValueDto) SetFeature(v string)` + +SetFeature sets Feature field to given value. + +### HasFeature + +`func (o *FeatureValueDto) HasFeature() bool` + +HasFeature returns a boolean if a field has been set. + +### GetNumerator + +`func (o *FeatureValueDto) GetNumerator() int32` + +GetNumerator returns the Numerator field if non-nil, zero value otherwise. + +### GetNumeratorOk + +`func (o *FeatureValueDto) GetNumeratorOk() (*int32, bool)` + +GetNumeratorOk returns a tuple with the Numerator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumerator + +`func (o *FeatureValueDto) SetNumerator(v int32)` + +SetNumerator sets Numerator field to given value. + +### HasNumerator + +`func (o *FeatureValueDto) HasNumerator() bool` + +HasNumerator returns a boolean if a field has been set. + +### GetDenominator + +`func (o *FeatureValueDto) GetDenominator() int32` + +GetDenominator returns the Denominator field if non-nil, zero value otherwise. + +### GetDenominatorOk + +`func (o *FeatureValueDto) GetDenominatorOk() (*int32, bool)` + +GetDenominatorOk returns a tuple with the Denominator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenominator + +`func (o *FeatureValueDto) SetDenominator(v int32)` + +SetDenominator sets Denominator field to given value. + +### HasDenominator + +`func (o *FeatureValueDto) HasDenominator() bool` + +HasDenominator returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Field.md b/docs/tools/sdk/go/Reference/Beta/Models/Field.md new file mode 100644 index 000000000..57e7b28b1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Field.md @@ -0,0 +1,194 @@ +--- +id: beta-field +title: Field +pagination_label: Field +sidebar_label: Field +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Field', 'BetaField'] +slug: /tools/sdk/go/beta/models/field +tags: ['SDK', 'Software Development Kit', 'Field', 'BetaField'] +--- + +# Field + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the FormItem | [optional] +**DisplayName** | Pointer to **string** | Display name of the field | [optional] +**DisplayType** | Pointer to **string** | Type of the field to display | [optional] +**Required** | Pointer to **bool** | True if the field is required | [optional] +**AllowedValuesList** | Pointer to **[]map[string]interface{}** | List of allowed values for the field | [optional] +**Value** | Pointer to **map[string]interface{}** | Value of the field | [optional] + +## Methods + +### NewField + +`func NewField() *Field` + +NewField instantiates a new Field 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 + +### NewFieldWithDefaults + +`func NewFieldWithDefaults() *Field` + +NewFieldWithDefaults instantiates a new Field 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 + +### GetName + +`func (o *Field) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Field) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Field) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Field) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *Field) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *Field) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *Field) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *Field) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDisplayType + +`func (o *Field) GetDisplayType() string` + +GetDisplayType returns the DisplayType field if non-nil, zero value otherwise. + +### GetDisplayTypeOk + +`func (o *Field) GetDisplayTypeOk() (*string, bool)` + +GetDisplayTypeOk returns a tuple with the DisplayType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayType + +`func (o *Field) SetDisplayType(v string)` + +SetDisplayType sets DisplayType field to given value. + +### HasDisplayType + +`func (o *Field) HasDisplayType() bool` + +HasDisplayType returns a boolean if a field has been set. + +### GetRequired + +`func (o *Field) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *Field) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *Field) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *Field) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + +### GetAllowedValuesList + +`func (o *Field) GetAllowedValuesList() []map[string]interface{}` + +GetAllowedValuesList returns the AllowedValuesList field if non-nil, zero value otherwise. + +### GetAllowedValuesListOk + +`func (o *Field) GetAllowedValuesListOk() (*[]map[string]interface{}, bool)` + +GetAllowedValuesListOk returns a tuple with the AllowedValuesList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllowedValuesList + +`func (o *Field) SetAllowedValuesList(v []map[string]interface{})` + +SetAllowedValuesList sets AllowedValuesList field to given value. + +### HasAllowedValuesList + +`func (o *Field) HasAllowedValuesList() bool` + +HasAllowedValuesList returns a boolean if a field has been set. + +### GetValue + +`func (o *Field) GetValue() map[string]interface{}` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Field) GetValueOk() (*map[string]interface{}, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Field) SetValue(v map[string]interface{})` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Field) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FieldDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/FieldDetails.md new file mode 100644 index 000000000..5230a030d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FieldDetails.md @@ -0,0 +1,194 @@ +--- +id: beta-field-details +title: FieldDetails +pagination_label: FieldDetails +sidebar_label: FieldDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FieldDetails', 'BetaFieldDetails'] +slug: /tools/sdk/go/beta/models/field-details +tags: ['SDK', 'Software Development Kit', 'FieldDetails', 'BetaFieldDetails'] +--- + +# FieldDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the FormItem | [optional] +**DisplayName** | Pointer to **string** | Display name of the field | [optional] +**DisplayType** | Pointer to **string** | Type of the field to display | [optional] +**Required** | Pointer to **bool** | True if the field is required | [optional] +**AllowedValuesList** | Pointer to **[]map[string]interface{}** | List of allowed values for the field | [optional] +**Value** | Pointer to **map[string]interface{}** | Value of the field | [optional] + +## Methods + +### NewFieldDetails + +`func NewFieldDetails() *FieldDetails` + +NewFieldDetails instantiates a new FieldDetails 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 + +### NewFieldDetailsWithDefaults + +`func NewFieldDetailsWithDefaults() *FieldDetails` + +NewFieldDetailsWithDefaults instantiates a new FieldDetails 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 + +### GetName + +`func (o *FieldDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FieldDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FieldDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FieldDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *FieldDetails) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *FieldDetails) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *FieldDetails) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *FieldDetails) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDisplayType + +`func (o *FieldDetails) GetDisplayType() string` + +GetDisplayType returns the DisplayType field if non-nil, zero value otherwise. + +### GetDisplayTypeOk + +`func (o *FieldDetails) GetDisplayTypeOk() (*string, bool)` + +GetDisplayTypeOk returns a tuple with the DisplayType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayType + +`func (o *FieldDetails) SetDisplayType(v string)` + +SetDisplayType sets DisplayType field to given value. + +### HasDisplayType + +`func (o *FieldDetails) HasDisplayType() bool` + +HasDisplayType returns a boolean if a field has been set. + +### GetRequired + +`func (o *FieldDetails) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *FieldDetails) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *FieldDetails) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *FieldDetails) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + +### GetAllowedValuesList + +`func (o *FieldDetails) GetAllowedValuesList() []map[string]interface{}` + +GetAllowedValuesList returns the AllowedValuesList field if non-nil, zero value otherwise. + +### GetAllowedValuesListOk + +`func (o *FieldDetails) GetAllowedValuesListOk() (*[]map[string]interface{}, bool)` + +GetAllowedValuesListOk returns a tuple with the AllowedValuesList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllowedValuesList + +`func (o *FieldDetails) SetAllowedValuesList(v []map[string]interface{})` + +SetAllowedValuesList sets AllowedValuesList field to given value. + +### HasAllowedValuesList + +`func (o *FieldDetails) HasAllowedValuesList() bool` + +HasAllowedValuesList returns a boolean if a field has been set. + +### GetValue + +`func (o *FieldDetails) GetValue() map[string]interface{}` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *FieldDetails) GetValueOk() (*map[string]interface{}, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *FieldDetails) SetValue(v map[string]interface{})` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *FieldDetails) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FieldDetailsDto.md b/docs/tools/sdk/go/Reference/Beta/Models/FieldDetailsDto.md new file mode 100644 index 000000000..28a903870 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FieldDetailsDto.md @@ -0,0 +1,194 @@ +--- +id: beta-field-details-dto +title: FieldDetailsDto +pagination_label: FieldDetailsDto +sidebar_label: FieldDetailsDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FieldDetailsDto', 'BetaFieldDetailsDto'] +slug: /tools/sdk/go/beta/models/field-details-dto +tags: ['SDK', 'Software Development Kit', 'FieldDetailsDto', 'BetaFieldDetailsDto'] +--- + +# FieldDetailsDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the attribute. | [optional] +**Transform** | Pointer to **map[string]interface{}** | The transform to apply to the field | [optional] [default to {}] +**Attributes** | Pointer to **map[string]interface{}** | Attributes required for the transform | [optional] +**IsRequired** | Pointer to **bool** | Flag indicating whether or not the attribute is required. | [optional] [readonly] [default to false] +**Type** | Pointer to **string** | The type of the attribute. | [optional] +**IsMultiValued** | Pointer to **bool** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to false] + +## Methods + +### NewFieldDetailsDto + +`func NewFieldDetailsDto() *FieldDetailsDto` + +NewFieldDetailsDto instantiates a new FieldDetailsDto 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 + +### NewFieldDetailsDtoWithDefaults + +`func NewFieldDetailsDtoWithDefaults() *FieldDetailsDto` + +NewFieldDetailsDtoWithDefaults instantiates a new FieldDetailsDto 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 + +### GetName + +`func (o *FieldDetailsDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FieldDetailsDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FieldDetailsDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FieldDetailsDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetTransform + +`func (o *FieldDetailsDto) GetTransform() map[string]interface{}` + +GetTransform returns the Transform field if non-nil, zero value otherwise. + +### GetTransformOk + +`func (o *FieldDetailsDto) GetTransformOk() (*map[string]interface{}, bool)` + +GetTransformOk returns a tuple with the Transform field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTransform + +`func (o *FieldDetailsDto) SetTransform(v map[string]interface{})` + +SetTransform sets Transform field to given value. + +### HasTransform + +`func (o *FieldDetailsDto) HasTransform() bool` + +HasTransform returns a boolean if a field has been set. + +### GetAttributes + +`func (o *FieldDetailsDto) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *FieldDetailsDto) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *FieldDetailsDto) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *FieldDetailsDto) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetIsRequired + +`func (o *FieldDetailsDto) GetIsRequired() bool` + +GetIsRequired returns the IsRequired field if non-nil, zero value otherwise. + +### GetIsRequiredOk + +`func (o *FieldDetailsDto) GetIsRequiredOk() (*bool, bool)` + +GetIsRequiredOk returns a tuple with the IsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsRequired + +`func (o *FieldDetailsDto) SetIsRequired(v bool)` + +SetIsRequired sets IsRequired field to given value. + +### HasIsRequired + +`func (o *FieldDetailsDto) HasIsRequired() bool` + +HasIsRequired returns a boolean if a field has been set. + +### GetType + +`func (o *FieldDetailsDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FieldDetailsDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FieldDetailsDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FieldDetailsDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetIsMultiValued + +`func (o *FieldDetailsDto) GetIsMultiValued() bool` + +GetIsMultiValued returns the IsMultiValued field if non-nil, zero value otherwise. + +### GetIsMultiValuedOk + +`func (o *FieldDetailsDto) GetIsMultiValuedOk() (*bool, bool)` + +GetIsMultiValuedOk returns a tuple with the IsMultiValued field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsMultiValued + +`func (o *FieldDetailsDto) SetIsMultiValued(v bool)` + +SetIsMultiValued sets IsMultiValued field to given value. + +### HasIsMultiValued + +`func (o *FieldDetailsDto) HasIsMultiValued() bool` + +HasIsMultiValued returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Form.md b/docs/tools/sdk/go/Reference/Beta/Models/Form.md new file mode 100644 index 000000000..86a06b251 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Form.md @@ -0,0 +1,214 @@ +--- +id: beta-form +title: Form +pagination_label: Form +sidebar_label: Form +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Form', 'BetaForm'] +slug: /tools/sdk/go/beta/models/form +tags: ['SDK', 'Software Development Kit', 'Form', 'BetaForm'] +--- + +# Form + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | ID of the form | [optional] +**Name** | Pointer to **NullableString** | Name of the form | [optional] +**Title** | Pointer to **string** | The form title | [optional] +**Subtitle** | Pointer to **string** | The form subtitle. | [optional] +**TargetUser** | Pointer to **string** | The name of the user that should be shown this form | [optional] +**Sections** | Pointer to [**[]SectionDetails**](section-details) | | [optional] + +## Methods + +### NewForm + +`func NewForm() *Form` + +NewForm instantiates a new Form 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 + +### NewFormWithDefaults + +`func NewFormWithDefaults() *Form` + +NewFormWithDefaults instantiates a new Form 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 + +### GetId + +`func (o *Form) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Form) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Form) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Form) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *Form) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *Form) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *Form) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Form) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Form) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Form) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *Form) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *Form) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetTitle + +`func (o *Form) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *Form) GetTitleOk() (*string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTitle + +`func (o *Form) SetTitle(v string)` + +SetTitle sets Title field to given value. + +### HasTitle + +`func (o *Form) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### GetSubtitle + +`func (o *Form) GetSubtitle() string` + +GetSubtitle returns the Subtitle field if non-nil, zero value otherwise. + +### GetSubtitleOk + +`func (o *Form) GetSubtitleOk() (*string, bool)` + +GetSubtitleOk returns a tuple with the Subtitle field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubtitle + +`func (o *Form) SetSubtitle(v string)` + +SetSubtitle sets Subtitle field to given value. + +### HasSubtitle + +`func (o *Form) HasSubtitle() bool` + +HasSubtitle returns a boolean if a field has been set. + +### GetTargetUser + +`func (o *Form) GetTargetUser() string` + +GetTargetUser returns the TargetUser field if non-nil, zero value otherwise. + +### GetTargetUserOk + +`func (o *Form) GetTargetUserOk() (*string, bool)` + +GetTargetUserOk returns a tuple with the TargetUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetUser + +`func (o *Form) SetTargetUser(v string)` + +SetTargetUser sets TargetUser field to given value. + +### HasTargetUser + +`func (o *Form) HasTargetUser() bool` + +HasTargetUser returns a boolean if a field has been set. + +### GetSections + +`func (o *Form) GetSections() []SectionDetails` + +GetSections returns the Sections field if non-nil, zero value otherwise. + +### GetSectionsOk + +`func (o *Form) GetSectionsOk() (*[]SectionDetails, bool)` + +GetSectionsOk returns a tuple with the Sections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSections + +`func (o *Form) SetSections(v []SectionDetails)` + +SetSections sets Sections field to given value. + +### HasSections + +`func (o *Form) HasSections() bool` + +HasSections returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormCondition.md b/docs/tools/sdk/go/Reference/Beta/Models/FormCondition.md new file mode 100644 index 000000000..9388e1d39 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormCondition.md @@ -0,0 +1,116 @@ +--- +id: beta-form-condition +title: FormCondition +pagination_label: FormCondition +sidebar_label: FormCondition +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormCondition', 'BetaFormCondition'] +slug: /tools/sdk/go/beta/models/form-condition +tags: ['SDK', 'Software Development Kit', 'FormCondition', 'BetaFormCondition'] +--- + +# FormCondition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RuleOperator** | Pointer to **string** | ConditionRuleLogicalOperatorType value. AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr | [optional] +**Rules** | Pointer to [**[]ConditionRule**](condition-rule) | List of rules. | [optional] +**Effects** | Pointer to [**[]ConditionEffect**](condition-effect) | List of effects. | [optional] + +## Methods + +### NewFormCondition + +`func NewFormCondition() *FormCondition` + +NewFormCondition instantiates a new FormCondition 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 + +### NewFormConditionWithDefaults + +`func NewFormConditionWithDefaults() *FormCondition` + +NewFormConditionWithDefaults instantiates a new FormCondition 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 + +### GetRuleOperator + +`func (o *FormCondition) GetRuleOperator() string` + +GetRuleOperator returns the RuleOperator field if non-nil, zero value otherwise. + +### GetRuleOperatorOk + +`func (o *FormCondition) GetRuleOperatorOk() (*string, bool)` + +GetRuleOperatorOk returns a tuple with the RuleOperator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRuleOperator + +`func (o *FormCondition) SetRuleOperator(v string)` + +SetRuleOperator sets RuleOperator field to given value. + +### HasRuleOperator + +`func (o *FormCondition) HasRuleOperator() bool` + +HasRuleOperator returns a boolean if a field has been set. + +### GetRules + +`func (o *FormCondition) GetRules() []ConditionRule` + +GetRules returns the Rules field if non-nil, zero value otherwise. + +### GetRulesOk + +`func (o *FormCondition) GetRulesOk() (*[]ConditionRule, bool)` + +GetRulesOk returns a tuple with the Rules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRules + +`func (o *FormCondition) SetRules(v []ConditionRule)` + +SetRules sets Rules field to given value. + +### HasRules + +`func (o *FormCondition) HasRules() bool` + +HasRules returns a boolean if a field has been set. + +### GetEffects + +`func (o *FormCondition) GetEffects() []ConditionEffect` + +GetEffects returns the Effects field if non-nil, zero value otherwise. + +### GetEffectsOk + +`func (o *FormCondition) GetEffectsOk() (*[]ConditionEffect, bool)` + +GetEffectsOk returns a tuple with the Effects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEffects + +`func (o *FormCondition) SetEffects(v []ConditionEffect)` + +SetEffects sets Effects field to given value. + +### HasEffects + +`func (o *FormCondition) HasEffects() bool` + +HasEffects returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionDynamicSchemaRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionDynamicSchemaRequest.md new file mode 100644 index 000000000..72a498c1e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionDynamicSchemaRequest.md @@ -0,0 +1,168 @@ +--- +id: beta-form-definition-dynamic-schema-request +title: FormDefinitionDynamicSchemaRequest +pagination_label: FormDefinitionDynamicSchemaRequest +sidebar_label: FormDefinitionDynamicSchemaRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionDynamicSchemaRequest', 'BetaFormDefinitionDynamicSchemaRequest'] +slug: /tools/sdk/go/beta/models/form-definition-dynamic-schema-request +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaRequest', 'BetaFormDefinitionDynamicSchemaRequest'] +--- + +# FormDefinitionDynamicSchemaRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**FormDefinitionDynamicSchemaRequestAttributes**](form-definition-dynamic-schema-request-attributes) | | [optional] +**Description** | Pointer to **string** | Description is the form definition dynamic schema description text | [optional] +**Id** | Pointer to **string** | ID is a unique identifier | [optional] +**Type** | Pointer to **string** | Type is the form definition dynamic schema type | [optional] +**VersionNumber** | Pointer to **int64** | VersionNumber is the form definition dynamic schema version number | [optional] + +## Methods + +### NewFormDefinitionDynamicSchemaRequest + +`func NewFormDefinitionDynamicSchemaRequest() *FormDefinitionDynamicSchemaRequest` + +NewFormDefinitionDynamicSchemaRequest instantiates a new FormDefinitionDynamicSchemaRequest 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 + +### NewFormDefinitionDynamicSchemaRequestWithDefaults + +`func NewFormDefinitionDynamicSchemaRequestWithDefaults() *FormDefinitionDynamicSchemaRequest` + +NewFormDefinitionDynamicSchemaRequestWithDefaults instantiates a new FormDefinitionDynamicSchemaRequest 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 + +### GetAttributes + +`func (o *FormDefinitionDynamicSchemaRequest) GetAttributes() FormDefinitionDynamicSchemaRequestAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *FormDefinitionDynamicSchemaRequest) GetAttributesOk() (*FormDefinitionDynamicSchemaRequestAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *FormDefinitionDynamicSchemaRequest) SetAttributes(v FormDefinitionDynamicSchemaRequestAttributes)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *FormDefinitionDynamicSchemaRequest) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetDescription + +`func (o *FormDefinitionDynamicSchemaRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *FormDefinitionDynamicSchemaRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *FormDefinitionDynamicSchemaRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *FormDefinitionDynamicSchemaRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetId + +`func (o *FormDefinitionDynamicSchemaRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormDefinitionDynamicSchemaRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormDefinitionDynamicSchemaRequest) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormDefinitionDynamicSchemaRequest) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *FormDefinitionDynamicSchemaRequest) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormDefinitionDynamicSchemaRequest) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormDefinitionDynamicSchemaRequest) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormDefinitionDynamicSchemaRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetVersionNumber + +`func (o *FormDefinitionDynamicSchemaRequest) GetVersionNumber() int64` + +GetVersionNumber returns the VersionNumber field if non-nil, zero value otherwise. + +### GetVersionNumberOk + +`func (o *FormDefinitionDynamicSchemaRequest) GetVersionNumberOk() (*int64, bool)` + +GetVersionNumberOk returns a tuple with the VersionNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionNumber + +`func (o *FormDefinitionDynamicSchemaRequest) SetVersionNumber(v int64)` + +SetVersionNumber sets VersionNumber field to given value. + +### HasVersionNumber + +`func (o *FormDefinitionDynamicSchemaRequest) HasVersionNumber() bool` + +HasVersionNumber returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionDynamicSchemaRequestAttributes.md b/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionDynamicSchemaRequestAttributes.md new file mode 100644 index 000000000..74b66a875 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionDynamicSchemaRequestAttributes.md @@ -0,0 +1,64 @@ +--- +id: beta-form-definition-dynamic-schema-request-attributes +title: FormDefinitionDynamicSchemaRequestAttributes +pagination_label: FormDefinitionDynamicSchemaRequestAttributes +sidebar_label: FormDefinitionDynamicSchemaRequestAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionDynamicSchemaRequestAttributes', 'BetaFormDefinitionDynamicSchemaRequestAttributes'] +slug: /tools/sdk/go/beta/models/form-definition-dynamic-schema-request-attributes +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaRequestAttributes', 'BetaFormDefinitionDynamicSchemaRequestAttributes'] +--- + +# FormDefinitionDynamicSchemaRequestAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FormDefinitionId** | Pointer to **string** | FormDefinitionID is a unique guid identifying this form definition | [optional] + +## Methods + +### NewFormDefinitionDynamicSchemaRequestAttributes + +`func NewFormDefinitionDynamicSchemaRequestAttributes() *FormDefinitionDynamicSchemaRequestAttributes` + +NewFormDefinitionDynamicSchemaRequestAttributes instantiates a new FormDefinitionDynamicSchemaRequestAttributes 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 + +### NewFormDefinitionDynamicSchemaRequestAttributesWithDefaults + +`func NewFormDefinitionDynamicSchemaRequestAttributesWithDefaults() *FormDefinitionDynamicSchemaRequestAttributes` + +NewFormDefinitionDynamicSchemaRequestAttributesWithDefaults instantiates a new FormDefinitionDynamicSchemaRequestAttributes 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 + +### GetFormDefinitionId + +`func (o *FormDefinitionDynamicSchemaRequestAttributes) GetFormDefinitionId() string` + +GetFormDefinitionId returns the FormDefinitionId field if non-nil, zero value otherwise. + +### GetFormDefinitionIdOk + +`func (o *FormDefinitionDynamicSchemaRequestAttributes) GetFormDefinitionIdOk() (*string, bool)` + +GetFormDefinitionIdOk returns a tuple with the FormDefinitionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormDefinitionId + +`func (o *FormDefinitionDynamicSchemaRequestAttributes) SetFormDefinitionId(v string)` + +SetFormDefinitionId sets FormDefinitionId field to given value. + +### HasFormDefinitionId + +`func (o *FormDefinitionDynamicSchemaRequestAttributes) HasFormDefinitionId() bool` + +HasFormDefinitionId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionDynamicSchemaResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionDynamicSchemaResponse.md new file mode 100644 index 000000000..e0a3d2884 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionDynamicSchemaResponse.md @@ -0,0 +1,64 @@ +--- +id: beta-form-definition-dynamic-schema-response +title: FormDefinitionDynamicSchemaResponse +pagination_label: FormDefinitionDynamicSchemaResponse +sidebar_label: FormDefinitionDynamicSchemaResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionDynamicSchemaResponse', 'BetaFormDefinitionDynamicSchemaResponse'] +slug: /tools/sdk/go/beta/models/form-definition-dynamic-schema-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaResponse', 'BetaFormDefinitionDynamicSchemaResponse'] +--- + +# FormDefinitionDynamicSchemaResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OutputSchema** | Pointer to **map[string]map[string]interface{}** | OutputSchema holds a JSON schema generated dynamically | [optional] + +## Methods + +### NewFormDefinitionDynamicSchemaResponse + +`func NewFormDefinitionDynamicSchemaResponse() *FormDefinitionDynamicSchemaResponse` + +NewFormDefinitionDynamicSchemaResponse instantiates a new FormDefinitionDynamicSchemaResponse 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 + +### NewFormDefinitionDynamicSchemaResponseWithDefaults + +`func NewFormDefinitionDynamicSchemaResponseWithDefaults() *FormDefinitionDynamicSchemaResponse` + +NewFormDefinitionDynamicSchemaResponseWithDefaults instantiates a new FormDefinitionDynamicSchemaResponse 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 + +### GetOutputSchema + +`func (o *FormDefinitionDynamicSchemaResponse) GetOutputSchema() map[string]map[string]interface{}` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *FormDefinitionDynamicSchemaResponse) GetOutputSchemaOk() (*map[string]map[string]interface{}, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *FormDefinitionDynamicSchemaResponse) SetOutputSchema(v map[string]map[string]interface{})` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *FormDefinitionDynamicSchemaResponse) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionFileUploadResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionFileUploadResponse.md new file mode 100644 index 000000000..6d53e51b7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionFileUploadResponse.md @@ -0,0 +1,116 @@ +--- +id: beta-form-definition-file-upload-response +title: FormDefinitionFileUploadResponse +pagination_label: FormDefinitionFileUploadResponse +sidebar_label: FormDefinitionFileUploadResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionFileUploadResponse', 'BetaFormDefinitionFileUploadResponse'] +slug: /tools/sdk/go/beta/models/form-definition-file-upload-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionFileUploadResponse', 'BetaFormDefinitionFileUploadResponse'] +--- + +# FormDefinitionFileUploadResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **string** | Created is the date the file was uploaded | [optional] +**FileId** | Pointer to **string** | fileId is a unique ULID that serves as an identifier for the form definition file | [optional] +**FormDefinitionId** | Pointer to **string** | FormDefinitionID is a unique guid identifying this form definition | [optional] + +## Methods + +### NewFormDefinitionFileUploadResponse + +`func NewFormDefinitionFileUploadResponse() *FormDefinitionFileUploadResponse` + +NewFormDefinitionFileUploadResponse instantiates a new FormDefinitionFileUploadResponse 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 + +### NewFormDefinitionFileUploadResponseWithDefaults + +`func NewFormDefinitionFileUploadResponseWithDefaults() *FormDefinitionFileUploadResponse` + +NewFormDefinitionFileUploadResponseWithDefaults instantiates a new FormDefinitionFileUploadResponse 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 + +### GetCreated + +`func (o *FormDefinitionFileUploadResponse) GetCreated() string` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *FormDefinitionFileUploadResponse) GetCreatedOk() (*string, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *FormDefinitionFileUploadResponse) SetCreated(v string)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *FormDefinitionFileUploadResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetFileId + +`func (o *FormDefinitionFileUploadResponse) GetFileId() string` + +GetFileId returns the FileId field if non-nil, zero value otherwise. + +### GetFileIdOk + +`func (o *FormDefinitionFileUploadResponse) GetFileIdOk() (*string, bool)` + +GetFileIdOk returns a tuple with the FileId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileId + +`func (o *FormDefinitionFileUploadResponse) SetFileId(v string)` + +SetFileId sets FileId field to given value. + +### HasFileId + +`func (o *FormDefinitionFileUploadResponse) HasFileId() bool` + +HasFileId returns a boolean if a field has been set. + +### GetFormDefinitionId + +`func (o *FormDefinitionFileUploadResponse) GetFormDefinitionId() string` + +GetFormDefinitionId returns the FormDefinitionId field if non-nil, zero value otherwise. + +### GetFormDefinitionIdOk + +`func (o *FormDefinitionFileUploadResponse) GetFormDefinitionIdOk() (*string, bool)` + +GetFormDefinitionIdOk returns a tuple with the FormDefinitionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormDefinitionId + +`func (o *FormDefinitionFileUploadResponse) SetFormDefinitionId(v string)` + +SetFormDefinitionId sets FormDefinitionId field to given value. + +### HasFormDefinitionId + +`func (o *FormDefinitionFileUploadResponse) HasFormDefinitionId() bool` + +HasFormDefinitionId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionInput.md b/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionInput.md new file mode 100644 index 000000000..19ea4a892 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionInput.md @@ -0,0 +1,142 @@ +--- +id: beta-form-definition-input +title: FormDefinitionInput +pagination_label: FormDefinitionInput +sidebar_label: FormDefinitionInput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionInput', 'BetaFormDefinitionInput'] +slug: /tools/sdk/go/beta/models/form-definition-input +tags: ['SDK', 'Software Development Kit', 'FormDefinitionInput', 'BetaFormDefinitionInput'] +--- + +# FormDefinitionInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the form input. | [optional] +**Type** | Pointer to **string** | FormDefinitionInputType value. STRING FormDefinitionInputTypeString | [optional] +**Label** | Pointer to **string** | Name for the form input. | [optional] +**Description** | Pointer to **string** | Form input's description. | [optional] + +## Methods + +### NewFormDefinitionInput + +`func NewFormDefinitionInput() *FormDefinitionInput` + +NewFormDefinitionInput instantiates a new FormDefinitionInput 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 + +### NewFormDefinitionInputWithDefaults + +`func NewFormDefinitionInputWithDefaults() *FormDefinitionInput` + +NewFormDefinitionInputWithDefaults instantiates a new FormDefinitionInput 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 + +### GetId + +`func (o *FormDefinitionInput) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormDefinitionInput) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormDefinitionInput) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormDefinitionInput) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *FormDefinitionInput) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormDefinitionInput) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormDefinitionInput) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormDefinitionInput) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetLabel + +`func (o *FormDefinitionInput) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *FormDefinitionInput) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *FormDefinitionInput) SetLabel(v string)` + +SetLabel sets Label field to given value. + +### HasLabel + +`func (o *FormDefinitionInput) HasLabel() bool` + +HasLabel returns a boolean if a field has been set. + +### GetDescription + +`func (o *FormDefinitionInput) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *FormDefinitionInput) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *FormDefinitionInput) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *FormDefinitionInput) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionResponse.md new file mode 100644 index 000000000..c8dda7565 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionResponse.md @@ -0,0 +1,298 @@ +--- +id: beta-form-definition-response +title: FormDefinitionResponse +pagination_label: FormDefinitionResponse +sidebar_label: FormDefinitionResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionResponse', 'BetaFormDefinitionResponse'] +slug: /tools/sdk/go/beta/models/form-definition-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionResponse', 'BetaFormDefinitionResponse'] +--- + +# FormDefinitionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique guid identifying the form definition. | [optional] +**Name** | Pointer to **string** | Name of the form definition. | [optional] +**Description** | Pointer to **string** | Form definition's description. | [optional] +**Owner** | Pointer to [**FormOwner**](form-owner) | | [optional] +**UsedBy** | Pointer to [**[]FormUsedBy**](form-used-by) | List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. | [optional] +**FormInput** | Pointer to [**[]FormDefinitionInput**](form-definition-input) | List of form inputs required to create a form-instance object. | [optional] +**FormElements** | Pointer to [**[]FormElement**](form-element) | List of nested form elements. | [optional] +**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | Conditional logic that can dynamically modify the form as the recipient is interacting with it. | [optional] +**Created** | Pointer to **SailPointTime** | Created is the date the form definition was created | [optional] +**Modified** | Pointer to **SailPointTime** | Modified is the last date the form definition was modified | [optional] + +## Methods + +### NewFormDefinitionResponse + +`func NewFormDefinitionResponse() *FormDefinitionResponse` + +NewFormDefinitionResponse instantiates a new FormDefinitionResponse 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 + +### NewFormDefinitionResponseWithDefaults + +`func NewFormDefinitionResponseWithDefaults() *FormDefinitionResponse` + +NewFormDefinitionResponseWithDefaults instantiates a new FormDefinitionResponse 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 + +### GetId + +`func (o *FormDefinitionResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormDefinitionResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormDefinitionResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormDefinitionResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FormDefinitionResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormDefinitionResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormDefinitionResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormDefinitionResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *FormDefinitionResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *FormDefinitionResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *FormDefinitionResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *FormDefinitionResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *FormDefinitionResponse) GetOwner() FormOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *FormDefinitionResponse) GetOwnerOk() (*FormOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *FormDefinitionResponse) SetOwner(v FormOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *FormDefinitionResponse) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetUsedBy + +`func (o *FormDefinitionResponse) GetUsedBy() []FormUsedBy` + +GetUsedBy returns the UsedBy field if non-nil, zero value otherwise. + +### GetUsedByOk + +`func (o *FormDefinitionResponse) GetUsedByOk() (*[]FormUsedBy, bool)` + +GetUsedByOk returns a tuple with the UsedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsedBy + +`func (o *FormDefinitionResponse) SetUsedBy(v []FormUsedBy)` + +SetUsedBy sets UsedBy field to given value. + +### HasUsedBy + +`func (o *FormDefinitionResponse) HasUsedBy() bool` + +HasUsedBy returns a boolean if a field has been set. + +### GetFormInput + +`func (o *FormDefinitionResponse) GetFormInput() []FormDefinitionInput` + +GetFormInput returns the FormInput field if non-nil, zero value otherwise. + +### GetFormInputOk + +`func (o *FormDefinitionResponse) GetFormInputOk() (*[]FormDefinitionInput, bool)` + +GetFormInputOk returns a tuple with the FormInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormInput + +`func (o *FormDefinitionResponse) SetFormInput(v []FormDefinitionInput)` + +SetFormInput sets FormInput field to given value. + +### HasFormInput + +`func (o *FormDefinitionResponse) HasFormInput() bool` + +HasFormInput returns a boolean if a field has been set. + +### GetFormElements + +`func (o *FormDefinitionResponse) GetFormElements() []FormElement` + +GetFormElements returns the FormElements field if non-nil, zero value otherwise. + +### GetFormElementsOk + +`func (o *FormDefinitionResponse) GetFormElementsOk() (*[]FormElement, bool)` + +GetFormElementsOk returns a tuple with the FormElements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormElements + +`func (o *FormDefinitionResponse) SetFormElements(v []FormElement)` + +SetFormElements sets FormElements field to given value. + +### HasFormElements + +`func (o *FormDefinitionResponse) HasFormElements() bool` + +HasFormElements returns a boolean if a field has been set. + +### GetFormConditions + +`func (o *FormDefinitionResponse) GetFormConditions() []FormCondition` + +GetFormConditions returns the FormConditions field if non-nil, zero value otherwise. + +### GetFormConditionsOk + +`func (o *FormDefinitionResponse) GetFormConditionsOk() (*[]FormCondition, bool)` + +GetFormConditionsOk returns a tuple with the FormConditions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormConditions + +`func (o *FormDefinitionResponse) SetFormConditions(v []FormCondition)` + +SetFormConditions sets FormConditions field to given value. + +### HasFormConditions + +`func (o *FormDefinitionResponse) HasFormConditions() bool` + +HasFormConditions returns a boolean if a field has been set. + +### GetCreated + +`func (o *FormDefinitionResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *FormDefinitionResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *FormDefinitionResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *FormDefinitionResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *FormDefinitionResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *FormDefinitionResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *FormDefinitionResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *FormDefinitionResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionSelfImportExportDto.md b/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionSelfImportExportDto.md new file mode 100644 index 000000000..63705cd62 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormDefinitionSelfImportExportDto.md @@ -0,0 +1,116 @@ +--- +id: beta-form-definition-self-import-export-dto +title: FormDefinitionSelfImportExportDto +pagination_label: FormDefinitionSelfImportExportDto +sidebar_label: FormDefinitionSelfImportExportDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionSelfImportExportDto', 'BetaFormDefinitionSelfImportExportDto'] +slug: /tools/sdk/go/beta/models/form-definition-self-import-export-dto +tags: ['SDK', 'Software Development Kit', 'FormDefinitionSelfImportExportDto', 'BetaFormDefinitionSelfImportExportDto'] +--- + +# FormDefinitionSelfImportExportDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Imported/exported object's DTO type. | [optional] +**Id** | Pointer to **string** | Imported/exported object's ID. | [optional] +**Name** | Pointer to **string** | Imported/exported object's display name. | [optional] + +## Methods + +### NewFormDefinitionSelfImportExportDto + +`func NewFormDefinitionSelfImportExportDto() *FormDefinitionSelfImportExportDto` + +NewFormDefinitionSelfImportExportDto instantiates a new FormDefinitionSelfImportExportDto 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 + +### NewFormDefinitionSelfImportExportDtoWithDefaults + +`func NewFormDefinitionSelfImportExportDtoWithDefaults() *FormDefinitionSelfImportExportDto` + +NewFormDefinitionSelfImportExportDtoWithDefaults instantiates a new FormDefinitionSelfImportExportDto 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 + +### GetType + +`func (o *FormDefinitionSelfImportExportDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormDefinitionSelfImportExportDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormDefinitionSelfImportExportDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormDefinitionSelfImportExportDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *FormDefinitionSelfImportExportDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormDefinitionSelfImportExportDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormDefinitionSelfImportExportDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormDefinitionSelfImportExportDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FormDefinitionSelfImportExportDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormDefinitionSelfImportExportDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormDefinitionSelfImportExportDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormDefinitionSelfImportExportDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/FormDetails.md new file mode 100644 index 000000000..559028371 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormDetails.md @@ -0,0 +1,214 @@ +--- +id: beta-form-details +title: FormDetails +pagination_label: FormDetails +sidebar_label: FormDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDetails', 'BetaFormDetails'] +slug: /tools/sdk/go/beta/models/form-details +tags: ['SDK', 'Software Development Kit', 'FormDetails', 'BetaFormDetails'] +--- + +# FormDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | ID of the form | [optional] +**Name** | Pointer to **NullableString** | Name of the form | [optional] +**Title** | Pointer to **string** | The form title | [optional] +**Subtitle** | Pointer to **string** | The form subtitle. | [optional] +**TargetUser** | Pointer to **string** | The name of the user that should be shown this form | [optional] +**Sections** | Pointer to [**[]SectionDetails**](section-details) | | [optional] + +## Methods + +### NewFormDetails + +`func NewFormDetails() *FormDetails` + +NewFormDetails instantiates a new FormDetails 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 + +### NewFormDetailsWithDefaults + +`func NewFormDetailsWithDefaults() *FormDetails` + +NewFormDetailsWithDefaults instantiates a new FormDetails 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 + +### GetId + +`func (o *FormDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *FormDetails) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *FormDetails) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *FormDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *FormDetails) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *FormDetails) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetTitle + +`func (o *FormDetails) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *FormDetails) GetTitleOk() (*string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTitle + +`func (o *FormDetails) SetTitle(v string)` + +SetTitle sets Title field to given value. + +### HasTitle + +`func (o *FormDetails) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### GetSubtitle + +`func (o *FormDetails) GetSubtitle() string` + +GetSubtitle returns the Subtitle field if non-nil, zero value otherwise. + +### GetSubtitleOk + +`func (o *FormDetails) GetSubtitleOk() (*string, bool)` + +GetSubtitleOk returns a tuple with the Subtitle field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubtitle + +`func (o *FormDetails) SetSubtitle(v string)` + +SetSubtitle sets Subtitle field to given value. + +### HasSubtitle + +`func (o *FormDetails) HasSubtitle() bool` + +HasSubtitle returns a boolean if a field has been set. + +### GetTargetUser + +`func (o *FormDetails) GetTargetUser() string` + +GetTargetUser returns the TargetUser field if non-nil, zero value otherwise. + +### GetTargetUserOk + +`func (o *FormDetails) GetTargetUserOk() (*string, bool)` + +GetTargetUserOk returns a tuple with the TargetUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetUser + +`func (o *FormDetails) SetTargetUser(v string)` + +SetTargetUser sets TargetUser field to given value. + +### HasTargetUser + +`func (o *FormDetails) HasTargetUser() bool` + +HasTargetUser returns a boolean if a field has been set. + +### GetSections + +`func (o *FormDetails) GetSections() []SectionDetails` + +GetSections returns the Sections field if non-nil, zero value otherwise. + +### GetSectionsOk + +`func (o *FormDetails) GetSectionsOk() (*[]SectionDetails, bool)` + +GetSectionsOk returns a tuple with the Sections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSections + +`func (o *FormDetails) SetSections(v []SectionDetails)` + +SetSections sets Sections field to given value. + +### HasSections + +`func (o *FormDetails) HasSections() bool` + +HasSections returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormElement.md b/docs/tools/sdk/go/Reference/Beta/Models/FormElement.md new file mode 100644 index 000000000..b3ffb5015 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormElement.md @@ -0,0 +1,178 @@ +--- +id: beta-form-element +title: FormElement +pagination_label: FormElement +sidebar_label: FormElement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElement', 'BetaFormElement'] +slug: /tools/sdk/go/beta/models/form-element +tags: ['SDK', 'Software Development Kit', 'FormElement', 'BetaFormElement'] +--- + +# FormElement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Form element identifier. | [optional] +**ElementType** | Pointer to **string** | FormElementType value. TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMN_SET FormElementTypeColumns IMAGE FormElementTypeImage DESCRIPTION FormElementTypeDescription | [optional] +**Config** | Pointer to **map[string]interface{}** | Config object. | [optional] +**Key** | Pointer to **string** | Technical key. | [optional] +**Validations** | Pointer to [**[]FormElementValidationsSet**](form-element-validations-set) | | [optional] + +## Methods + +### NewFormElement + +`func NewFormElement() *FormElement` + +NewFormElement instantiates a new FormElement 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 + +### NewFormElementWithDefaults + +`func NewFormElementWithDefaults() *FormElement` + +NewFormElementWithDefaults instantiates a new FormElement 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 + +### GetId + +`func (o *FormElement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormElement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormElement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormElement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetElementType + +`func (o *FormElement) GetElementType() string` + +GetElementType returns the ElementType field if non-nil, zero value otherwise. + +### GetElementTypeOk + +`func (o *FormElement) GetElementTypeOk() (*string, bool)` + +GetElementTypeOk returns a tuple with the ElementType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElementType + +`func (o *FormElement) SetElementType(v string)` + +SetElementType sets ElementType field to given value. + +### HasElementType + +`func (o *FormElement) HasElementType() bool` + +HasElementType returns a boolean if a field has been set. + +### GetConfig + +`func (o *FormElement) GetConfig() map[string]interface{}` + +GetConfig returns the Config field if non-nil, zero value otherwise. + +### GetConfigOk + +`func (o *FormElement) GetConfigOk() (*map[string]interface{}, bool)` + +GetConfigOk returns a tuple with the Config field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfig + +`func (o *FormElement) SetConfig(v map[string]interface{})` + +SetConfig sets Config field to given value. + +### HasConfig + +`func (o *FormElement) HasConfig() bool` + +HasConfig returns a boolean if a field has been set. + +### GetKey + +`func (o *FormElement) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *FormElement) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *FormElement) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *FormElement) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetValidations + +`func (o *FormElement) GetValidations() []FormElementValidationsSet` + +GetValidations returns the Validations field if non-nil, zero value otherwise. + +### GetValidationsOk + +`func (o *FormElement) GetValidationsOk() (*[]FormElementValidationsSet, bool)` + +GetValidationsOk returns a tuple with the Validations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValidations + +`func (o *FormElement) SetValidations(v []FormElementValidationsSet)` + +SetValidations sets Validations field to given value. + +### HasValidations + +`func (o *FormElement) HasValidations() bool` + +HasValidations returns a boolean if a field has been set. + +### SetValidationsNil + +`func (o *FormElement) SetValidationsNil(b bool)` + + SetValidationsNil sets the value for Validations to be an explicit nil + +### UnsetValidations +`func (o *FormElement) UnsetValidations()` + +UnsetValidations ensures that no value is present for Validations, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormElementDataSourceConfigOptions.md b/docs/tools/sdk/go/Reference/Beta/Models/FormElementDataSourceConfigOptions.md new file mode 100644 index 000000000..f2c58a952 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormElementDataSourceConfigOptions.md @@ -0,0 +1,116 @@ +--- +id: beta-form-element-data-source-config-options +title: FormElementDataSourceConfigOptions +pagination_label: FormElementDataSourceConfigOptions +sidebar_label: FormElementDataSourceConfigOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElementDataSourceConfigOptions', 'BetaFormElementDataSourceConfigOptions'] +slug: /tools/sdk/go/beta/models/form-element-data-source-config-options +tags: ['SDK', 'Software Development Kit', 'FormElementDataSourceConfigOptions', 'BetaFormElementDataSourceConfigOptions'] +--- + +# FormElementDataSourceConfigOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Label** | Pointer to **string** | Label is the main label to display to the user when selecting this option | [optional] +**SubLabel** | Pointer to **string** | SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option | [optional] +**Value** | Pointer to **string** | Value is the value to save as an entry when the user selects this option | [optional] + +## Methods + +### NewFormElementDataSourceConfigOptions + +`func NewFormElementDataSourceConfigOptions() *FormElementDataSourceConfigOptions` + +NewFormElementDataSourceConfigOptions instantiates a new FormElementDataSourceConfigOptions 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 + +### NewFormElementDataSourceConfigOptionsWithDefaults + +`func NewFormElementDataSourceConfigOptionsWithDefaults() *FormElementDataSourceConfigOptions` + +NewFormElementDataSourceConfigOptionsWithDefaults instantiates a new FormElementDataSourceConfigOptions 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 + +### GetLabel + +`func (o *FormElementDataSourceConfigOptions) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *FormElementDataSourceConfigOptions) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *FormElementDataSourceConfigOptions) SetLabel(v string)` + +SetLabel sets Label field to given value. + +### HasLabel + +`func (o *FormElementDataSourceConfigOptions) HasLabel() bool` + +HasLabel returns a boolean if a field has been set. + +### GetSubLabel + +`func (o *FormElementDataSourceConfigOptions) GetSubLabel() string` + +GetSubLabel returns the SubLabel field if non-nil, zero value otherwise. + +### GetSubLabelOk + +`func (o *FormElementDataSourceConfigOptions) GetSubLabelOk() (*string, bool)` + +GetSubLabelOk returns a tuple with the SubLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubLabel + +`func (o *FormElementDataSourceConfigOptions) SetSubLabel(v string)` + +SetSubLabel sets SubLabel field to given value. + +### HasSubLabel + +`func (o *FormElementDataSourceConfigOptions) HasSubLabel() bool` + +HasSubLabel returns a boolean if a field has been set. + +### GetValue + +`func (o *FormElementDataSourceConfigOptions) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *FormElementDataSourceConfigOptions) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *FormElementDataSourceConfigOptions) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *FormElementDataSourceConfigOptions) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormElementDynamicDataSource.md b/docs/tools/sdk/go/Reference/Beta/Models/FormElementDynamicDataSource.md new file mode 100644 index 000000000..18c2bb174 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormElementDynamicDataSource.md @@ -0,0 +1,90 @@ +--- +id: beta-form-element-dynamic-data-source +title: FormElementDynamicDataSource +pagination_label: FormElementDynamicDataSource +sidebar_label: FormElementDynamicDataSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElementDynamicDataSource', 'BetaFormElementDynamicDataSource'] +slug: /tools/sdk/go/beta/models/form-element-dynamic-data-source +tags: ['SDK', 'Software Development Kit', 'FormElementDynamicDataSource', 'BetaFormElementDynamicDataSource'] +--- + +# FormElementDynamicDataSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Config** | Pointer to [**FormElementDynamicDataSourceConfig**](form-element-dynamic-data-source-config) | | [optional] +**DataSourceType** | Pointer to **string** | DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch FORM_INPUT FormElementDataSourceTypeFormInput | [optional] + +## Methods + +### NewFormElementDynamicDataSource + +`func NewFormElementDynamicDataSource() *FormElementDynamicDataSource` + +NewFormElementDynamicDataSource instantiates a new FormElementDynamicDataSource 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 + +### NewFormElementDynamicDataSourceWithDefaults + +`func NewFormElementDynamicDataSourceWithDefaults() *FormElementDynamicDataSource` + +NewFormElementDynamicDataSourceWithDefaults instantiates a new FormElementDynamicDataSource 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 + +### GetConfig + +`func (o *FormElementDynamicDataSource) GetConfig() FormElementDynamicDataSourceConfig` + +GetConfig returns the Config field if non-nil, zero value otherwise. + +### GetConfigOk + +`func (o *FormElementDynamicDataSource) GetConfigOk() (*FormElementDynamicDataSourceConfig, bool)` + +GetConfigOk returns a tuple with the Config field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfig + +`func (o *FormElementDynamicDataSource) SetConfig(v FormElementDynamicDataSourceConfig)` + +SetConfig sets Config field to given value. + +### HasConfig + +`func (o *FormElementDynamicDataSource) HasConfig() bool` + +HasConfig returns a boolean if a field has been set. + +### GetDataSourceType + +`func (o *FormElementDynamicDataSource) GetDataSourceType() string` + +GetDataSourceType returns the DataSourceType field if non-nil, zero value otherwise. + +### GetDataSourceTypeOk + +`func (o *FormElementDynamicDataSource) GetDataSourceTypeOk() (*string, bool)` + +GetDataSourceTypeOk returns a tuple with the DataSourceType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataSourceType + +`func (o *FormElementDynamicDataSource) SetDataSourceType(v string)` + +SetDataSourceType sets DataSourceType field to given value. + +### HasDataSourceType + +`func (o *FormElementDynamicDataSource) HasDataSourceType() bool` + +HasDataSourceType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormElementDynamicDataSourceConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/FormElementDynamicDataSourceConfig.md new file mode 100644 index 000000000..cdcb83839 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormElementDynamicDataSourceConfig.md @@ -0,0 +1,142 @@ +--- +id: beta-form-element-dynamic-data-source-config +title: FormElementDynamicDataSourceConfig +pagination_label: FormElementDynamicDataSourceConfig +sidebar_label: FormElementDynamicDataSourceConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElementDynamicDataSourceConfig', 'BetaFormElementDynamicDataSourceConfig'] +slug: /tools/sdk/go/beta/models/form-element-dynamic-data-source-config +tags: ['SDK', 'Software Development Kit', 'FormElementDynamicDataSourceConfig', 'BetaFormElementDynamicDataSourceConfig'] +--- + +# FormElementDynamicDataSourceConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AggregationBucketField** | Pointer to **string** | AggregationBucketField is the aggregation bucket field name | [optional] +**Indices** | Pointer to **[]string** | Indices is a list of indices to use | [optional] +**ObjectType** | Pointer to **string** | ObjectType is a PreDefinedSelectOption value IDENTITY PreDefinedSelectOptionIdentity ACCESS_PROFILE PreDefinedSelectOptionAccessProfile SOURCES PreDefinedSelectOptionSources ROLE PreDefinedSelectOptionRole ENTITLEMENT PreDefinedSelectOptionEntitlement | [optional] +**Query** | Pointer to **string** | Query is a text | [optional] + +## Methods + +### NewFormElementDynamicDataSourceConfig + +`func NewFormElementDynamicDataSourceConfig() *FormElementDynamicDataSourceConfig` + +NewFormElementDynamicDataSourceConfig instantiates a new FormElementDynamicDataSourceConfig 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 + +### NewFormElementDynamicDataSourceConfigWithDefaults + +`func NewFormElementDynamicDataSourceConfigWithDefaults() *FormElementDynamicDataSourceConfig` + +NewFormElementDynamicDataSourceConfigWithDefaults instantiates a new FormElementDynamicDataSourceConfig 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 + +### GetAggregationBucketField + +`func (o *FormElementDynamicDataSourceConfig) GetAggregationBucketField() string` + +GetAggregationBucketField returns the AggregationBucketField field if non-nil, zero value otherwise. + +### GetAggregationBucketFieldOk + +`func (o *FormElementDynamicDataSourceConfig) GetAggregationBucketFieldOk() (*string, bool)` + +GetAggregationBucketFieldOk returns a tuple with the AggregationBucketField field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationBucketField + +`func (o *FormElementDynamicDataSourceConfig) SetAggregationBucketField(v string)` + +SetAggregationBucketField sets AggregationBucketField field to given value. + +### HasAggregationBucketField + +`func (o *FormElementDynamicDataSourceConfig) HasAggregationBucketField() bool` + +HasAggregationBucketField returns a boolean if a field has been set. + +### GetIndices + +`func (o *FormElementDynamicDataSourceConfig) GetIndices() []string` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *FormElementDynamicDataSourceConfig) GetIndicesOk() (*[]string, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *FormElementDynamicDataSourceConfig) SetIndices(v []string)` + +SetIndices sets Indices field to given value. + +### HasIndices + +`func (o *FormElementDynamicDataSourceConfig) HasIndices() bool` + +HasIndices returns a boolean if a field has been set. + +### GetObjectType + +`func (o *FormElementDynamicDataSourceConfig) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *FormElementDynamicDataSourceConfig) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *FormElementDynamicDataSourceConfig) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + +### HasObjectType + +`func (o *FormElementDynamicDataSourceConfig) HasObjectType() bool` + +HasObjectType returns a boolean if a field has been set. + +### GetQuery + +`func (o *FormElementDynamicDataSourceConfig) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *FormElementDynamicDataSourceConfig) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *FormElementDynamicDataSourceConfig) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *FormElementDynamicDataSourceConfig) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormElementPreviewRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/FormElementPreviewRequest.md new file mode 100644 index 000000000..84091e9e7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormElementPreviewRequest.md @@ -0,0 +1,64 @@ +--- +id: beta-form-element-preview-request +title: FormElementPreviewRequest +pagination_label: FormElementPreviewRequest +sidebar_label: FormElementPreviewRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElementPreviewRequest', 'BetaFormElementPreviewRequest'] +slug: /tools/sdk/go/beta/models/form-element-preview-request +tags: ['SDK', 'Software Development Kit', 'FormElementPreviewRequest', 'BetaFormElementPreviewRequest'] +--- + +# FormElementPreviewRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DataSource** | Pointer to [**FormElementDynamicDataSource**](form-element-dynamic-data-source) | | [optional] + +## Methods + +### NewFormElementPreviewRequest + +`func NewFormElementPreviewRequest() *FormElementPreviewRequest` + +NewFormElementPreviewRequest instantiates a new FormElementPreviewRequest 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 + +### NewFormElementPreviewRequestWithDefaults + +`func NewFormElementPreviewRequestWithDefaults() *FormElementPreviewRequest` + +NewFormElementPreviewRequestWithDefaults instantiates a new FormElementPreviewRequest 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 + +### GetDataSource + +`func (o *FormElementPreviewRequest) GetDataSource() FormElementDynamicDataSource` + +GetDataSource returns the DataSource field if non-nil, zero value otherwise. + +### GetDataSourceOk + +`func (o *FormElementPreviewRequest) GetDataSourceOk() (*FormElementDynamicDataSource, bool)` + +GetDataSourceOk returns a tuple with the DataSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataSource + +`func (o *FormElementPreviewRequest) SetDataSource(v FormElementDynamicDataSource)` + +SetDataSource sets DataSource field to given value. + +### HasDataSource + +`func (o *FormElementPreviewRequest) HasDataSource() bool` + +HasDataSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormElementValidationsSet.md b/docs/tools/sdk/go/Reference/Beta/Models/FormElementValidationsSet.md new file mode 100644 index 000000000..093ee1b09 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormElementValidationsSet.md @@ -0,0 +1,64 @@ +--- +id: beta-form-element-validations-set +title: FormElementValidationsSet +pagination_label: FormElementValidationsSet +sidebar_label: FormElementValidationsSet +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElementValidationsSet', 'BetaFormElementValidationsSet'] +slug: /tools/sdk/go/beta/models/form-element-validations-set +tags: ['SDK', 'Software Development Kit', 'FormElementValidationsSet', 'BetaFormElementValidationsSet'] +--- + +# FormElementValidationsSet + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ValidationType** | Pointer to **string** | The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. | [optional] + +## Methods + +### NewFormElementValidationsSet + +`func NewFormElementValidationsSet() *FormElementValidationsSet` + +NewFormElementValidationsSet instantiates a new FormElementValidationsSet 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 + +### NewFormElementValidationsSetWithDefaults + +`func NewFormElementValidationsSetWithDefaults() *FormElementValidationsSet` + +NewFormElementValidationsSetWithDefaults instantiates a new FormElementValidationsSet 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 + +### GetValidationType + +`func (o *FormElementValidationsSet) GetValidationType() string` + +GetValidationType returns the ValidationType field if non-nil, zero value otherwise. + +### GetValidationTypeOk + +`func (o *FormElementValidationsSet) GetValidationTypeOk() (*string, bool)` + +GetValidationTypeOk returns a tuple with the ValidationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValidationType + +`func (o *FormElementValidationsSet) SetValidationType(v string)` + +SetValidationType sets ValidationType field to given value. + +### HasValidationType + +`func (o *FormElementValidationsSet) HasValidationType() bool` + +HasValidationType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormError.md b/docs/tools/sdk/go/Reference/Beta/Models/FormError.md new file mode 100644 index 000000000..3ad88ba02 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormError.md @@ -0,0 +1,116 @@ +--- +id: beta-form-error +title: FormError +pagination_label: FormError +sidebar_label: FormError +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormError', 'BetaFormError'] +slug: /tools/sdk/go/beta/models/form-error +tags: ['SDK', 'Software Development Kit', 'FormError', 'BetaFormError'] +--- + +# FormError + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | Key is the technical key | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | Messages is a list of web.ErrorMessage items | [optional] +**Value** | Pointer to **map[string]interface{}** | Value is the value associated with a Key | [optional] + +## Methods + +### NewFormError + +`func NewFormError() *FormError` + +NewFormError instantiates a new FormError 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 + +### NewFormErrorWithDefaults + +`func NewFormErrorWithDefaults() *FormError` + +NewFormErrorWithDefaults instantiates a new FormError 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 + +### GetKey + +`func (o *FormError) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *FormError) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *FormError) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *FormError) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetMessages + +`func (o *FormError) GetMessages() []ErrorMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *FormError) GetMessagesOk() (*[]ErrorMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *FormError) SetMessages(v []ErrorMessage)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *FormError) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetValue + +`func (o *FormError) GetValue() map[string]interface{}` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *FormError) GetValueOk() (*map[string]interface{}, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *FormError) SetValue(v map[string]interface{})` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *FormError) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormInstanceCreatedBy.md b/docs/tools/sdk/go/Reference/Beta/Models/FormInstanceCreatedBy.md new file mode 100644 index 000000000..c20feacee --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormInstanceCreatedBy.md @@ -0,0 +1,90 @@ +--- +id: beta-form-instance-created-by +title: FormInstanceCreatedBy +pagination_label: FormInstanceCreatedBy +sidebar_label: FormInstanceCreatedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormInstanceCreatedBy', 'BetaFormInstanceCreatedBy'] +slug: /tools/sdk/go/beta/models/form-instance-created-by +tags: ['SDK', 'Software Development Kit', 'FormInstanceCreatedBy', 'BetaFormInstanceCreatedBy'] +--- + +# FormInstanceCreatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID is a unique identifier | [optional] +**Type** | Pointer to **string** | Type is a form instance created by type enum value WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution SOURCE FormInstanceCreatedByTypeSource | [optional] + +## Methods + +### NewFormInstanceCreatedBy + +`func NewFormInstanceCreatedBy() *FormInstanceCreatedBy` + +NewFormInstanceCreatedBy instantiates a new FormInstanceCreatedBy 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 + +### NewFormInstanceCreatedByWithDefaults + +`func NewFormInstanceCreatedByWithDefaults() *FormInstanceCreatedBy` + +NewFormInstanceCreatedByWithDefaults instantiates a new FormInstanceCreatedBy 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 + +### GetId + +`func (o *FormInstanceCreatedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormInstanceCreatedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormInstanceCreatedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormInstanceCreatedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *FormInstanceCreatedBy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormInstanceCreatedBy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormInstanceCreatedBy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormInstanceCreatedBy) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormInstanceRecipient.md b/docs/tools/sdk/go/Reference/Beta/Models/FormInstanceRecipient.md new file mode 100644 index 000000000..42c8ea55d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormInstanceRecipient.md @@ -0,0 +1,90 @@ +--- +id: beta-form-instance-recipient +title: FormInstanceRecipient +pagination_label: FormInstanceRecipient +sidebar_label: FormInstanceRecipient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormInstanceRecipient', 'BetaFormInstanceRecipient'] +slug: /tools/sdk/go/beta/models/form-instance-recipient +tags: ['SDK', 'Software Development Kit', 'FormInstanceRecipient', 'BetaFormInstanceRecipient'] +--- + +# FormInstanceRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID is a unique identifier | [optional] +**Type** | Pointer to **string** | Type is a FormInstanceRecipientType value IDENTITY FormInstanceRecipientIdentity | [optional] + +## Methods + +### NewFormInstanceRecipient + +`func NewFormInstanceRecipient() *FormInstanceRecipient` + +NewFormInstanceRecipient instantiates a new FormInstanceRecipient 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 + +### NewFormInstanceRecipientWithDefaults + +`func NewFormInstanceRecipientWithDefaults() *FormInstanceRecipient` + +NewFormInstanceRecipientWithDefaults instantiates a new FormInstanceRecipient 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 + +### GetId + +`func (o *FormInstanceRecipient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormInstanceRecipient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormInstanceRecipient) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormInstanceRecipient) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *FormInstanceRecipient) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormInstanceRecipient) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormInstanceRecipient) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormInstanceRecipient) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormInstanceResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/FormInstanceResponse.md new file mode 100644 index 000000000..081b29030 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormInstanceResponse.md @@ -0,0 +1,448 @@ +--- +id: beta-form-instance-response +title: FormInstanceResponse +pagination_label: FormInstanceResponse +sidebar_label: FormInstanceResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormInstanceResponse', 'BetaFormInstanceResponse'] +slug: /tools/sdk/go/beta/models/form-instance-response +tags: ['SDK', 'Software Development Kit', 'FormInstanceResponse', 'BetaFormInstanceResponse'] +--- + +# FormInstanceResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **SailPointTime** | Created is the date the form instance was assigned | [optional] +**CreatedBy** | Pointer to [**FormInstanceCreatedBy**](form-instance-created-by) | | [optional] +**Expire** | Pointer to **string** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [optional] +**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**FormData** | Pointer to **map[string]interface{}** | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] +**FormDefinitionId** | Pointer to **string** | FormDefinitionID is the id of the form definition that created this form | [optional] +**FormElements** | Pointer to [**[]FormElement**](form-element) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] +**FormErrors** | Pointer to [**[]FormError**](form-error) | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [optional] +**FormInput** | Pointer to **map[string]map[string]interface{}** | FormInput is an object of form input labels to value | [optional] +**Id** | Pointer to **string** | Unique guid identifying this form instance | [optional] +**Modified** | Pointer to **SailPointTime** | Modified is the last date the form instance was modified | [optional] +**Recipients** | Pointer to [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [optional] +**StandAloneForm** | Pointer to **bool** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to false] +**StandAloneFormUrl** | Pointer to **string** | StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI | [optional] +**State** | Pointer to **string** | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] + +## Methods + +### NewFormInstanceResponse + +`func NewFormInstanceResponse() *FormInstanceResponse` + +NewFormInstanceResponse instantiates a new FormInstanceResponse 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 + +### NewFormInstanceResponseWithDefaults + +`func NewFormInstanceResponseWithDefaults() *FormInstanceResponse` + +NewFormInstanceResponseWithDefaults instantiates a new FormInstanceResponse 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 + +### GetCreated + +`func (o *FormInstanceResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *FormInstanceResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *FormInstanceResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *FormInstanceResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetCreatedBy + +`func (o *FormInstanceResponse) GetCreatedBy() FormInstanceCreatedBy` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *FormInstanceResponse) GetCreatedByOk() (*FormInstanceCreatedBy, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *FormInstanceResponse) SetCreatedBy(v FormInstanceCreatedBy)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *FormInstanceResponse) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetExpire + +`func (o *FormInstanceResponse) GetExpire() string` + +GetExpire returns the Expire field if non-nil, zero value otherwise. + +### GetExpireOk + +`func (o *FormInstanceResponse) GetExpireOk() (*string, bool)` + +GetExpireOk returns a tuple with the Expire field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpire + +`func (o *FormInstanceResponse) SetExpire(v string)` + +SetExpire sets Expire field to given value. + +### HasExpire + +`func (o *FormInstanceResponse) HasExpire() bool` + +HasExpire returns a boolean if a field has been set. + +### GetFormConditions + +`func (o *FormInstanceResponse) GetFormConditions() []FormCondition` + +GetFormConditions returns the FormConditions field if non-nil, zero value otherwise. + +### GetFormConditionsOk + +`func (o *FormInstanceResponse) GetFormConditionsOk() (*[]FormCondition, bool)` + +GetFormConditionsOk returns a tuple with the FormConditions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormConditions + +`func (o *FormInstanceResponse) SetFormConditions(v []FormCondition)` + +SetFormConditions sets FormConditions field to given value. + +### HasFormConditions + +`func (o *FormInstanceResponse) HasFormConditions() bool` + +HasFormConditions returns a boolean if a field has been set. + +### GetFormData + +`func (o *FormInstanceResponse) GetFormData() map[string]interface{}` + +GetFormData returns the FormData field if non-nil, zero value otherwise. + +### GetFormDataOk + +`func (o *FormInstanceResponse) GetFormDataOk() (*map[string]interface{}, bool)` + +GetFormDataOk returns a tuple with the FormData field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormData + +`func (o *FormInstanceResponse) SetFormData(v map[string]interface{})` + +SetFormData sets FormData field to given value. + +### HasFormData + +`func (o *FormInstanceResponse) HasFormData() bool` + +HasFormData returns a boolean if a field has been set. + +### SetFormDataNil + +`func (o *FormInstanceResponse) SetFormDataNil(b bool)` + + SetFormDataNil sets the value for FormData to be an explicit nil + +### UnsetFormData +`func (o *FormInstanceResponse) UnsetFormData()` + +UnsetFormData ensures that no value is present for FormData, not even an explicit nil +### GetFormDefinitionId + +`func (o *FormInstanceResponse) GetFormDefinitionId() string` + +GetFormDefinitionId returns the FormDefinitionId field if non-nil, zero value otherwise. + +### GetFormDefinitionIdOk + +`func (o *FormInstanceResponse) GetFormDefinitionIdOk() (*string, bool)` + +GetFormDefinitionIdOk returns a tuple with the FormDefinitionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormDefinitionId + +`func (o *FormInstanceResponse) SetFormDefinitionId(v string)` + +SetFormDefinitionId sets FormDefinitionId field to given value. + +### HasFormDefinitionId + +`func (o *FormInstanceResponse) HasFormDefinitionId() bool` + +HasFormDefinitionId returns a boolean if a field has been set. + +### GetFormElements + +`func (o *FormInstanceResponse) GetFormElements() []FormElement` + +GetFormElements returns the FormElements field if non-nil, zero value otherwise. + +### GetFormElementsOk + +`func (o *FormInstanceResponse) GetFormElementsOk() (*[]FormElement, bool)` + +GetFormElementsOk returns a tuple with the FormElements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormElements + +`func (o *FormInstanceResponse) SetFormElements(v []FormElement)` + +SetFormElements sets FormElements field to given value. + +### HasFormElements + +`func (o *FormInstanceResponse) HasFormElements() bool` + +HasFormElements returns a boolean if a field has been set. + +### GetFormErrors + +`func (o *FormInstanceResponse) GetFormErrors() []FormError` + +GetFormErrors returns the FormErrors field if non-nil, zero value otherwise. + +### GetFormErrorsOk + +`func (o *FormInstanceResponse) GetFormErrorsOk() (*[]FormError, bool)` + +GetFormErrorsOk returns a tuple with the FormErrors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormErrors + +`func (o *FormInstanceResponse) SetFormErrors(v []FormError)` + +SetFormErrors sets FormErrors field to given value. + +### HasFormErrors + +`func (o *FormInstanceResponse) HasFormErrors() bool` + +HasFormErrors returns a boolean if a field has been set. + +### GetFormInput + +`func (o *FormInstanceResponse) GetFormInput() map[string]map[string]interface{}` + +GetFormInput returns the FormInput field if non-nil, zero value otherwise. + +### GetFormInputOk + +`func (o *FormInstanceResponse) GetFormInputOk() (*map[string]map[string]interface{}, bool)` + +GetFormInputOk returns a tuple with the FormInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormInput + +`func (o *FormInstanceResponse) SetFormInput(v map[string]map[string]interface{})` + +SetFormInput sets FormInput field to given value. + +### HasFormInput + +`func (o *FormInstanceResponse) HasFormInput() bool` + +HasFormInput returns a boolean if a field has been set. + +### SetFormInputNil + +`func (o *FormInstanceResponse) SetFormInputNil(b bool)` + + SetFormInputNil sets the value for FormInput to be an explicit nil + +### UnsetFormInput +`func (o *FormInstanceResponse) UnsetFormInput()` + +UnsetFormInput ensures that no value is present for FormInput, not even an explicit nil +### GetId + +`func (o *FormInstanceResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormInstanceResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormInstanceResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormInstanceResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetModified + +`func (o *FormInstanceResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *FormInstanceResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *FormInstanceResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *FormInstanceResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetRecipients + +`func (o *FormInstanceResponse) GetRecipients() []FormInstanceRecipient` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *FormInstanceResponse) GetRecipientsOk() (*[]FormInstanceRecipient, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *FormInstanceResponse) SetRecipients(v []FormInstanceRecipient)` + +SetRecipients sets Recipients field to given value. + +### HasRecipients + +`func (o *FormInstanceResponse) HasRecipients() bool` + +HasRecipients returns a boolean if a field has been set. + +### GetStandAloneForm + +`func (o *FormInstanceResponse) GetStandAloneForm() bool` + +GetStandAloneForm returns the StandAloneForm field if non-nil, zero value otherwise. + +### GetStandAloneFormOk + +`func (o *FormInstanceResponse) GetStandAloneFormOk() (*bool, bool)` + +GetStandAloneFormOk returns a tuple with the StandAloneForm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandAloneForm + +`func (o *FormInstanceResponse) SetStandAloneForm(v bool)` + +SetStandAloneForm sets StandAloneForm field to given value. + +### HasStandAloneForm + +`func (o *FormInstanceResponse) HasStandAloneForm() bool` + +HasStandAloneForm returns a boolean if a field has been set. + +### GetStandAloneFormUrl + +`func (o *FormInstanceResponse) GetStandAloneFormUrl() string` + +GetStandAloneFormUrl returns the StandAloneFormUrl field if non-nil, zero value otherwise. + +### GetStandAloneFormUrlOk + +`func (o *FormInstanceResponse) GetStandAloneFormUrlOk() (*string, bool)` + +GetStandAloneFormUrlOk returns a tuple with the StandAloneFormUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandAloneFormUrl + +`func (o *FormInstanceResponse) SetStandAloneFormUrl(v string)` + +SetStandAloneFormUrl sets StandAloneFormUrl field to given value. + +### HasStandAloneFormUrl + +`func (o *FormInstanceResponse) HasStandAloneFormUrl() bool` + +HasStandAloneFormUrl returns a boolean if a field has been set. + +### GetState + +`func (o *FormInstanceResponse) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *FormInstanceResponse) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *FormInstanceResponse) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *FormInstanceResponse) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormItem.md b/docs/tools/sdk/go/Reference/Beta/Models/FormItem.md new file mode 100644 index 000000000..788685bbb --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormItem.md @@ -0,0 +1,64 @@ +--- +id: beta-form-item +title: FormItem +pagination_label: FormItem +sidebar_label: FormItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormItem', 'BetaFormItem'] +slug: /tools/sdk/go/beta/models/form-item +tags: ['SDK', 'Software Development Kit', 'FormItem', 'BetaFormItem'] +--- + +# FormItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the FormItem | [optional] + +## Methods + +### NewFormItem + +`func NewFormItem() *FormItem` + +NewFormItem instantiates a new FormItem 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 + +### NewFormItemWithDefaults + +`func NewFormItemWithDefaults() *FormItem` + +NewFormItemWithDefaults instantiates a new FormItem 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 + +### GetName + +`func (o *FormItem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormItem) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormItem) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormItem) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormItemDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/FormItemDetails.md new file mode 100644 index 000000000..b2bf090d8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormItemDetails.md @@ -0,0 +1,64 @@ +--- +id: beta-form-item-details +title: FormItemDetails +pagination_label: FormItemDetails +sidebar_label: FormItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormItemDetails', 'BetaFormItemDetails'] +slug: /tools/sdk/go/beta/models/form-item-details +tags: ['SDK', 'Software Development Kit', 'FormItemDetails', 'BetaFormItemDetails'] +--- + +# FormItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the FormItem | [optional] + +## Methods + +### NewFormItemDetails + +`func NewFormItemDetails() *FormItemDetails` + +NewFormItemDetails instantiates a new FormItemDetails 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 + +### NewFormItemDetailsWithDefaults + +`func NewFormItemDetailsWithDefaults() *FormItemDetails` + +NewFormItemDetailsWithDefaults instantiates a new FormItemDetails 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 + +### GetName + +`func (o *FormItemDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormItemDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormItemDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormItemDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormOwner.md b/docs/tools/sdk/go/Reference/Beta/Models/FormOwner.md new file mode 100644 index 000000000..cb9e401ec --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormOwner.md @@ -0,0 +1,116 @@ +--- +id: beta-form-owner +title: FormOwner +pagination_label: FormOwner +sidebar_label: FormOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormOwner', 'BetaFormOwner'] +slug: /tools/sdk/go/beta/models/form-owner +tags: ['SDK', 'Software Development Kit', 'FormOwner', 'BetaFormOwner'] +--- + +# FormOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | FormOwnerType value. IDENTITY FormOwnerTypeIdentity | [optional] +**Id** | Pointer to **string** | Unique identifier of the form's owner. | [optional] +**Name** | Pointer to **string** | Name of the form's owner. | [optional] + +## Methods + +### NewFormOwner + +`func NewFormOwner() *FormOwner` + +NewFormOwner instantiates a new FormOwner 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 + +### NewFormOwnerWithDefaults + +`func NewFormOwnerWithDefaults() *FormOwner` + +NewFormOwnerWithDefaults instantiates a new FormOwner 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 + +### GetType + +`func (o *FormOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *FormOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FormOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FormUsedBy.md b/docs/tools/sdk/go/Reference/Beta/Models/FormUsedBy.md new file mode 100644 index 000000000..efc7b422e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FormUsedBy.md @@ -0,0 +1,116 @@ +--- +id: beta-form-used-by +title: FormUsedBy +pagination_label: FormUsedBy +sidebar_label: FormUsedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormUsedBy', 'BetaFormUsedBy'] +slug: /tools/sdk/go/beta/models/form-used-by +tags: ['SDK', 'Software Development Kit', 'FormUsedBy', 'BetaFormUsedBy'] +--- + +# FormUsedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | FormUsedByType value. WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource MySailPoint FormUsedByType | [optional] +**Id** | Pointer to **string** | Unique identifier of the system using the form. | [optional] +**Name** | Pointer to **string** | Name of the system using the form. | [optional] + +## Methods + +### NewFormUsedBy + +`func NewFormUsedBy() *FormUsedBy` + +NewFormUsedBy instantiates a new FormUsedBy 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 + +### NewFormUsedByWithDefaults + +`func NewFormUsedByWithDefaults() *FormUsedBy` + +NewFormUsedByWithDefaults instantiates a new FormUsedBy 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 + +### GetType + +`func (o *FormUsedBy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormUsedBy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormUsedBy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormUsedBy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *FormUsedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormUsedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormUsedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormUsedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FormUsedBy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormUsedBy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormUsedBy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormUsedBy) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ForwardApprovalDto.md b/docs/tools/sdk/go/Reference/Beta/Models/ForwardApprovalDto.md new file mode 100644 index 000000000..ece470ff5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ForwardApprovalDto.md @@ -0,0 +1,80 @@ +--- +id: beta-forward-approval-dto +title: ForwardApprovalDto +pagination_label: ForwardApprovalDto +sidebar_label: ForwardApprovalDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ForwardApprovalDto', 'BetaForwardApprovalDto'] +slug: /tools/sdk/go/beta/models/forward-approval-dto +tags: ['SDK', 'Software Development Kit', 'ForwardApprovalDto', 'BetaForwardApprovalDto'] +--- + +# ForwardApprovalDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewOwnerId** | **string** | The Id of the new owner | +**Comment** | **string** | The comment provided by the forwarder | + +## Methods + +### NewForwardApprovalDto + +`func NewForwardApprovalDto(newOwnerId string, comment string, ) *ForwardApprovalDto` + +NewForwardApprovalDto instantiates a new ForwardApprovalDto 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 + +### NewForwardApprovalDtoWithDefaults + +`func NewForwardApprovalDtoWithDefaults() *ForwardApprovalDto` + +NewForwardApprovalDtoWithDefaults instantiates a new ForwardApprovalDto 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 + +### GetNewOwnerId + +`func (o *ForwardApprovalDto) GetNewOwnerId() string` + +GetNewOwnerId returns the NewOwnerId field if non-nil, zero value otherwise. + +### GetNewOwnerIdOk + +`func (o *ForwardApprovalDto) GetNewOwnerIdOk() (*string, bool)` + +GetNewOwnerIdOk returns a tuple with the NewOwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewOwnerId + +`func (o *ForwardApprovalDto) SetNewOwnerId(v string)` + +SetNewOwnerId sets NewOwnerId field to given value. + + +### GetComment + +`func (o *ForwardApprovalDto) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ForwardApprovalDto) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ForwardApprovalDto) SetComment(v string)` + +SetComment sets Comment field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FullDiscoveredApplications.md b/docs/tools/sdk/go/Reference/Beta/Models/FullDiscoveredApplications.md new file mode 100644 index 000000000..d35487d96 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FullDiscoveredApplications.md @@ -0,0 +1,298 @@ +--- +id: beta-full-discovered-applications +title: FullDiscoveredApplications +pagination_label: FullDiscoveredApplications +sidebar_label: FullDiscoveredApplications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FullDiscoveredApplications', 'BetaFullDiscoveredApplications'] +slug: /tools/sdk/go/beta/models/full-discovered-applications +tags: ['SDK', 'Software Development Kit', 'FullDiscoveredApplications', 'BetaFullDiscoveredApplications'] +--- + +# FullDiscoveredApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **string** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **string** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **string** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **string** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]string** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **SailPointTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **string** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [optional] +**AssociatedSources** | Pointer to **[]string** | List of associated sources related to this discovered application. | [optional] + +## Methods + +### NewFullDiscoveredApplications + +`func NewFullDiscoveredApplications() *FullDiscoveredApplications` + +NewFullDiscoveredApplications instantiates a new FullDiscoveredApplications 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 + +### NewFullDiscoveredApplicationsWithDefaults + +`func NewFullDiscoveredApplicationsWithDefaults() *FullDiscoveredApplications` + +NewFullDiscoveredApplicationsWithDefaults instantiates a new FullDiscoveredApplications 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 + +### GetId + +`func (o *FullDiscoveredApplications) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FullDiscoveredApplications) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FullDiscoveredApplications) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FullDiscoveredApplications) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FullDiscoveredApplications) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FullDiscoveredApplications) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FullDiscoveredApplications) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FullDiscoveredApplications) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDiscoverySource + +`func (o *FullDiscoveredApplications) GetDiscoverySource() string` + +GetDiscoverySource returns the DiscoverySource field if non-nil, zero value otherwise. + +### GetDiscoverySourceOk + +`func (o *FullDiscoveredApplications) GetDiscoverySourceOk() (*string, bool)` + +GetDiscoverySourceOk returns a tuple with the DiscoverySource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoverySource + +`func (o *FullDiscoveredApplications) SetDiscoverySource(v string)` + +SetDiscoverySource sets DiscoverySource field to given value. + +### HasDiscoverySource + +`func (o *FullDiscoveredApplications) HasDiscoverySource() bool` + +HasDiscoverySource returns a boolean if a field has been set. + +### GetDiscoveredVendor + +`func (o *FullDiscoveredApplications) GetDiscoveredVendor() string` + +GetDiscoveredVendor returns the DiscoveredVendor field if non-nil, zero value otherwise. + +### GetDiscoveredVendorOk + +`func (o *FullDiscoveredApplications) GetDiscoveredVendorOk() (*string, bool)` + +GetDiscoveredVendorOk returns a tuple with the DiscoveredVendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredVendor + +`func (o *FullDiscoveredApplications) SetDiscoveredVendor(v string)` + +SetDiscoveredVendor sets DiscoveredVendor field to given value. + +### HasDiscoveredVendor + +`func (o *FullDiscoveredApplications) HasDiscoveredVendor() bool` + +HasDiscoveredVendor returns a boolean if a field has been set. + +### GetDescription + +`func (o *FullDiscoveredApplications) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *FullDiscoveredApplications) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *FullDiscoveredApplications) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *FullDiscoveredApplications) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetRecommendedConnectors + +`func (o *FullDiscoveredApplications) GetRecommendedConnectors() []string` + +GetRecommendedConnectors returns the RecommendedConnectors field if non-nil, zero value otherwise. + +### GetRecommendedConnectorsOk + +`func (o *FullDiscoveredApplications) GetRecommendedConnectorsOk() (*[]string, bool)` + +GetRecommendedConnectorsOk returns a tuple with the RecommendedConnectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendedConnectors + +`func (o *FullDiscoveredApplications) SetRecommendedConnectors(v []string)` + +SetRecommendedConnectors sets RecommendedConnectors field to given value. + +### HasRecommendedConnectors + +`func (o *FullDiscoveredApplications) HasRecommendedConnectors() bool` + +HasRecommendedConnectors returns a boolean if a field has been set. + +### GetDiscoveredAt + +`func (o *FullDiscoveredApplications) GetDiscoveredAt() SailPointTime` + +GetDiscoveredAt returns the DiscoveredAt field if non-nil, zero value otherwise. + +### GetDiscoveredAtOk + +`func (o *FullDiscoveredApplications) GetDiscoveredAtOk() (*SailPointTime, bool)` + +GetDiscoveredAtOk returns a tuple with the DiscoveredAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredAt + +`func (o *FullDiscoveredApplications) SetDiscoveredAt(v SailPointTime)` + +SetDiscoveredAt sets DiscoveredAt field to given value. + +### HasDiscoveredAt + +`func (o *FullDiscoveredApplications) HasDiscoveredAt() bool` + +HasDiscoveredAt returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *FullDiscoveredApplications) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *FullDiscoveredApplications) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *FullDiscoveredApplications) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *FullDiscoveredApplications) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetStatus + +`func (o *FullDiscoveredApplications) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *FullDiscoveredApplications) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *FullDiscoveredApplications) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *FullDiscoveredApplications) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetAssociatedSources + +`func (o *FullDiscoveredApplications) GetAssociatedSources() []string` + +GetAssociatedSources returns the AssociatedSources field if non-nil, zero value otherwise. + +### GetAssociatedSourcesOk + +`func (o *FullDiscoveredApplications) GetAssociatedSourcesOk() (*[]string, bool)` + +GetAssociatedSourcesOk returns a tuple with the AssociatedSources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociatedSources + +`func (o *FullDiscoveredApplications) SetAssociatedSources(v []string)` + +SetAssociatedSources sets AssociatedSources field to given value. + +### HasAssociatedSources + +`func (o *FullDiscoveredApplications) HasAssociatedSources() bool` + +HasAssociatedSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Fullcampaign.md b/docs/tools/sdk/go/Reference/Beta/Models/Fullcampaign.md new file mode 100644 index 000000000..83cd5b7af --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Fullcampaign.md @@ -0,0 +1,621 @@ +--- +id: beta-fullcampaign +title: Fullcampaign +pagination_label: Fullcampaign +sidebar_label: Fullcampaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Fullcampaign', 'BetaFullcampaign'] +slug: /tools/sdk/go/beta/models/fullcampaign +tags: ['SDK', 'Software Development Kit', 'Fullcampaign', 'BetaFullcampaign'] +--- + +# Fullcampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the campaign | [optional] [readonly] +**Name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Description** | **string** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Deadline** | Pointer to **SailPointTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **string** | The type of campaign. Could be extended in the future. | +**EmailNotificationEnabled** | Pointer to **bool** | Enables email notification for this campaign | [optional] [default to false] +**AutoRevokeAllowed** | Pointer to **bool** | Allows auto revoke for this campaign | [optional] [default to false] +**RecommendationsEnabled** | Pointer to **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to false] +**Status** | Pointer to **string** | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **SailPointTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Modified time of the campaign | [optional] [readonly] +**Filter** | Pointer to [**FullcampaignAllOfFilter**](fullcampaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **bool** | Determines if comments on sunset date changes are required. | [optional] [default to true] +**SourceOwnerCampaignInfo** | Pointer to [**FullcampaignAllOfSourceOwnerCampaignInfo**](fullcampaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**FullcampaignAllOfSearchCampaignInfo**](fullcampaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**FullcampaignAllOfRoleCompositionCampaignInfo**](fullcampaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**FullcampaignAllOfMachineAccountCampaignInfo**](fullcampaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]FullcampaignAllOfSourcesWithOrphanEntitlements**](fullcampaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Methods + +### NewFullcampaign + +`func NewFullcampaign(name string, description string, type_ string, ) *Fullcampaign` + +NewFullcampaign instantiates a new Fullcampaign 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 + +### NewFullcampaignWithDefaults + +`func NewFullcampaignWithDefaults() *Fullcampaign` + +NewFullcampaignWithDefaults instantiates a new Fullcampaign 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 + +### GetId + +`func (o *Fullcampaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Fullcampaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Fullcampaign) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Fullcampaign) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Fullcampaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Fullcampaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Fullcampaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Fullcampaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Fullcampaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Fullcampaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetDeadline + +`func (o *Fullcampaign) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *Fullcampaign) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *Fullcampaign) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *Fullcampaign) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### GetType + +`func (o *Fullcampaign) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Fullcampaign) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Fullcampaign) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEmailNotificationEnabled + +`func (o *Fullcampaign) GetEmailNotificationEnabled() bool` + +GetEmailNotificationEnabled returns the EmailNotificationEnabled field if non-nil, zero value otherwise. + +### GetEmailNotificationEnabledOk + +`func (o *Fullcampaign) GetEmailNotificationEnabledOk() (*bool, bool)` + +GetEmailNotificationEnabledOk returns a tuple with the EmailNotificationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationEnabled + +`func (o *Fullcampaign) SetEmailNotificationEnabled(v bool)` + +SetEmailNotificationEnabled sets EmailNotificationEnabled field to given value. + +### HasEmailNotificationEnabled + +`func (o *Fullcampaign) HasEmailNotificationEnabled() bool` + +HasEmailNotificationEnabled returns a boolean if a field has been set. + +### GetAutoRevokeAllowed + +`func (o *Fullcampaign) GetAutoRevokeAllowed() bool` + +GetAutoRevokeAllowed returns the AutoRevokeAllowed field if non-nil, zero value otherwise. + +### GetAutoRevokeAllowedOk + +`func (o *Fullcampaign) GetAutoRevokeAllowedOk() (*bool, bool)` + +GetAutoRevokeAllowedOk returns a tuple with the AutoRevokeAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoRevokeAllowed + +`func (o *Fullcampaign) SetAutoRevokeAllowed(v bool)` + +SetAutoRevokeAllowed sets AutoRevokeAllowed field to given value. + +### HasAutoRevokeAllowed + +`func (o *Fullcampaign) HasAutoRevokeAllowed() bool` + +HasAutoRevokeAllowed returns a boolean if a field has been set. + +### GetRecommendationsEnabled + +`func (o *Fullcampaign) GetRecommendationsEnabled() bool` + +GetRecommendationsEnabled returns the RecommendationsEnabled field if non-nil, zero value otherwise. + +### GetRecommendationsEnabledOk + +`func (o *Fullcampaign) GetRecommendationsEnabledOk() (*bool, bool)` + +GetRecommendationsEnabledOk returns a tuple with the RecommendationsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendationsEnabled + +`func (o *Fullcampaign) SetRecommendationsEnabled(v bool)` + +SetRecommendationsEnabled sets RecommendationsEnabled field to given value. + +### HasRecommendationsEnabled + +`func (o *Fullcampaign) HasRecommendationsEnabled() bool` + +HasRecommendationsEnabled returns a boolean if a field has been set. + +### GetStatus + +`func (o *Fullcampaign) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Fullcampaign) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Fullcampaign) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Fullcampaign) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetCorrelatedStatus + +`func (o *Fullcampaign) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *Fullcampaign) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *Fullcampaign) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + +### HasCorrelatedStatus + +`func (o *Fullcampaign) HasCorrelatedStatus() bool` + +HasCorrelatedStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *Fullcampaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Fullcampaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Fullcampaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Fullcampaign) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetTotalCertifications + +`func (o *Fullcampaign) GetTotalCertifications() int32` + +GetTotalCertifications returns the TotalCertifications field if non-nil, zero value otherwise. + +### GetTotalCertificationsOk + +`func (o *Fullcampaign) GetTotalCertificationsOk() (*int32, bool)` + +GetTotalCertificationsOk returns a tuple with the TotalCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCertifications + +`func (o *Fullcampaign) SetTotalCertifications(v int32)` + +SetTotalCertifications sets TotalCertifications field to given value. + +### HasTotalCertifications + +`func (o *Fullcampaign) HasTotalCertifications() bool` + +HasTotalCertifications returns a boolean if a field has been set. + +### GetCompletedCertifications + +`func (o *Fullcampaign) GetCompletedCertifications() int32` + +GetCompletedCertifications returns the CompletedCertifications field if non-nil, zero value otherwise. + +### GetCompletedCertificationsOk + +`func (o *Fullcampaign) GetCompletedCertificationsOk() (*int32, bool)` + +GetCompletedCertificationsOk returns a tuple with the CompletedCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedCertifications + +`func (o *Fullcampaign) SetCompletedCertifications(v int32)` + +SetCompletedCertifications sets CompletedCertifications field to given value. + +### HasCompletedCertifications + +`func (o *Fullcampaign) HasCompletedCertifications() bool` + +HasCompletedCertifications returns a boolean if a field has been set. + +### GetAlerts + +`func (o *Fullcampaign) GetAlerts() []CampaignAlert` + +GetAlerts returns the Alerts field if non-nil, zero value otherwise. + +### GetAlertsOk + +`func (o *Fullcampaign) GetAlertsOk() (*[]CampaignAlert, bool)` + +GetAlertsOk returns a tuple with the Alerts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlerts + +`func (o *Fullcampaign) SetAlerts(v []CampaignAlert)` + +SetAlerts sets Alerts field to given value. + +### HasAlerts + +`func (o *Fullcampaign) HasAlerts() bool` + +HasAlerts returns a boolean if a field has been set. + +### GetModified + +`func (o *Fullcampaign) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Fullcampaign) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Fullcampaign) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Fullcampaign) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetFilter + +`func (o *Fullcampaign) GetFilter() FullcampaignAllOfFilter` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *Fullcampaign) GetFilterOk() (*FullcampaignAllOfFilter, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *Fullcampaign) SetFilter(v FullcampaignAllOfFilter)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *Fullcampaign) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### GetSunsetCommentsRequired + +`func (o *Fullcampaign) GetSunsetCommentsRequired() bool` + +GetSunsetCommentsRequired returns the SunsetCommentsRequired field if non-nil, zero value otherwise. + +### GetSunsetCommentsRequiredOk + +`func (o *Fullcampaign) GetSunsetCommentsRequiredOk() (*bool, bool)` + +GetSunsetCommentsRequiredOk returns a tuple with the SunsetCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSunsetCommentsRequired + +`func (o *Fullcampaign) SetSunsetCommentsRequired(v bool)` + +SetSunsetCommentsRequired sets SunsetCommentsRequired field to given value. + +### HasSunsetCommentsRequired + +`func (o *Fullcampaign) HasSunsetCommentsRequired() bool` + +HasSunsetCommentsRequired returns a boolean if a field has been set. + +### GetSourceOwnerCampaignInfo + +`func (o *Fullcampaign) GetSourceOwnerCampaignInfo() FullcampaignAllOfSourceOwnerCampaignInfo` + +GetSourceOwnerCampaignInfo returns the SourceOwnerCampaignInfo field if non-nil, zero value otherwise. + +### GetSourceOwnerCampaignInfoOk + +`func (o *Fullcampaign) GetSourceOwnerCampaignInfoOk() (*FullcampaignAllOfSourceOwnerCampaignInfo, bool)` + +GetSourceOwnerCampaignInfoOk returns a tuple with the SourceOwnerCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceOwnerCampaignInfo + +`func (o *Fullcampaign) SetSourceOwnerCampaignInfo(v FullcampaignAllOfSourceOwnerCampaignInfo)` + +SetSourceOwnerCampaignInfo sets SourceOwnerCampaignInfo field to given value. + +### HasSourceOwnerCampaignInfo + +`func (o *Fullcampaign) HasSourceOwnerCampaignInfo() bool` + +HasSourceOwnerCampaignInfo returns a boolean if a field has been set. + +### GetSearchCampaignInfo + +`func (o *Fullcampaign) GetSearchCampaignInfo() FullcampaignAllOfSearchCampaignInfo` + +GetSearchCampaignInfo returns the SearchCampaignInfo field if non-nil, zero value otherwise. + +### GetSearchCampaignInfoOk + +`func (o *Fullcampaign) GetSearchCampaignInfoOk() (*FullcampaignAllOfSearchCampaignInfo, bool)` + +GetSearchCampaignInfoOk returns a tuple with the SearchCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchCampaignInfo + +`func (o *Fullcampaign) SetSearchCampaignInfo(v FullcampaignAllOfSearchCampaignInfo)` + +SetSearchCampaignInfo sets SearchCampaignInfo field to given value. + +### HasSearchCampaignInfo + +`func (o *Fullcampaign) HasSearchCampaignInfo() bool` + +HasSearchCampaignInfo returns a boolean if a field has been set. + +### GetRoleCompositionCampaignInfo + +`func (o *Fullcampaign) GetRoleCompositionCampaignInfo() FullcampaignAllOfRoleCompositionCampaignInfo` + +GetRoleCompositionCampaignInfo returns the RoleCompositionCampaignInfo field if non-nil, zero value otherwise. + +### GetRoleCompositionCampaignInfoOk + +`func (o *Fullcampaign) GetRoleCompositionCampaignInfoOk() (*FullcampaignAllOfRoleCompositionCampaignInfo, bool)` + +GetRoleCompositionCampaignInfoOk returns a tuple with the RoleCompositionCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleCompositionCampaignInfo + +`func (o *Fullcampaign) SetRoleCompositionCampaignInfo(v FullcampaignAllOfRoleCompositionCampaignInfo)` + +SetRoleCompositionCampaignInfo sets RoleCompositionCampaignInfo field to given value. + +### HasRoleCompositionCampaignInfo + +`func (o *Fullcampaign) HasRoleCompositionCampaignInfo() bool` + +HasRoleCompositionCampaignInfo returns a boolean if a field has been set. + +### GetMachineAccountCampaignInfo + +`func (o *Fullcampaign) GetMachineAccountCampaignInfo() FullcampaignAllOfMachineAccountCampaignInfo` + +GetMachineAccountCampaignInfo returns the MachineAccountCampaignInfo field if non-nil, zero value otherwise. + +### GetMachineAccountCampaignInfoOk + +`func (o *Fullcampaign) GetMachineAccountCampaignInfoOk() (*FullcampaignAllOfMachineAccountCampaignInfo, bool)` + +GetMachineAccountCampaignInfoOk returns a tuple with the MachineAccountCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMachineAccountCampaignInfo + +`func (o *Fullcampaign) SetMachineAccountCampaignInfo(v FullcampaignAllOfMachineAccountCampaignInfo)` + +SetMachineAccountCampaignInfo sets MachineAccountCampaignInfo field to given value. + +### HasMachineAccountCampaignInfo + +`func (o *Fullcampaign) HasMachineAccountCampaignInfo() bool` + +HasMachineAccountCampaignInfo returns a boolean if a field has been set. + +### GetSourcesWithOrphanEntitlements + +`func (o *Fullcampaign) GetSourcesWithOrphanEntitlements() []FullcampaignAllOfSourcesWithOrphanEntitlements` + +GetSourcesWithOrphanEntitlements returns the SourcesWithOrphanEntitlements field if non-nil, zero value otherwise. + +### GetSourcesWithOrphanEntitlementsOk + +`func (o *Fullcampaign) GetSourcesWithOrphanEntitlementsOk() (*[]FullcampaignAllOfSourcesWithOrphanEntitlements, bool)` + +GetSourcesWithOrphanEntitlementsOk returns a tuple with the SourcesWithOrphanEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourcesWithOrphanEntitlements + +`func (o *Fullcampaign) SetSourcesWithOrphanEntitlements(v []FullcampaignAllOfSourcesWithOrphanEntitlements)` + +SetSourcesWithOrphanEntitlements sets SourcesWithOrphanEntitlements field to given value. + +### HasSourcesWithOrphanEntitlements + +`func (o *Fullcampaign) HasSourcesWithOrphanEntitlements() bool` + +HasSourcesWithOrphanEntitlements returns a boolean if a field has been set. + +### GetMandatoryCommentRequirement + +`func (o *Fullcampaign) GetMandatoryCommentRequirement() string` + +GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise. + +### GetMandatoryCommentRequirementOk + +`func (o *Fullcampaign) GetMandatoryCommentRequirementOk() (*string, bool)` + +GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMandatoryCommentRequirement + +`func (o *Fullcampaign) SetMandatoryCommentRequirement(v string)` + +SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value. + +### HasMandatoryCommentRequirement + +`func (o *Fullcampaign) HasMandatoryCommentRequirement() bool` + +HasMandatoryCommentRequirement returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfFilter.md b/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfFilter.md new file mode 100644 index 000000000..f83e11cd2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfFilter.md @@ -0,0 +1,116 @@ +--- +id: beta-fullcampaign-all-of-filter +title: FullcampaignAllOfFilter +pagination_label: FullcampaignAllOfFilter +sidebar_label: FullcampaignAllOfFilter +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FullcampaignAllOfFilter', 'BetaFullcampaignAllOfFilter'] +slug: /tools/sdk/go/beta/models/fullcampaign-all-of-filter +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfFilter', 'BetaFullcampaignAllOfFilter'] +--- + +# FullcampaignAllOfFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of whatever type of filter is being used. | [optional] +**Type** | Pointer to **string** | Type of the filter | [optional] +**Name** | Pointer to **string** | Name of the filter | [optional] + +## Methods + +### NewFullcampaignAllOfFilter + +`func NewFullcampaignAllOfFilter() *FullcampaignAllOfFilter` + +NewFullcampaignAllOfFilter instantiates a new FullcampaignAllOfFilter 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 + +### NewFullcampaignAllOfFilterWithDefaults + +`func NewFullcampaignAllOfFilterWithDefaults() *FullcampaignAllOfFilter` + +NewFullcampaignAllOfFilterWithDefaults instantiates a new FullcampaignAllOfFilter 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 + +### GetId + +`func (o *FullcampaignAllOfFilter) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FullcampaignAllOfFilter) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FullcampaignAllOfFilter) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FullcampaignAllOfFilter) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *FullcampaignAllOfFilter) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FullcampaignAllOfFilter) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FullcampaignAllOfFilter) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FullcampaignAllOfFilter) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *FullcampaignAllOfFilter) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FullcampaignAllOfFilter) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FullcampaignAllOfFilter) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FullcampaignAllOfFilter) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfMachineAccountCampaignInfo.md b/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfMachineAccountCampaignInfo.md new file mode 100644 index 000000000..deb692ea0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfMachineAccountCampaignInfo.md @@ -0,0 +1,90 @@ +--- +id: beta-fullcampaign-all-of-machine-account-campaign-info +title: FullcampaignAllOfMachineAccountCampaignInfo +pagination_label: FullcampaignAllOfMachineAccountCampaignInfo +sidebar_label: FullcampaignAllOfMachineAccountCampaignInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FullcampaignAllOfMachineAccountCampaignInfo', 'BetaFullcampaignAllOfMachineAccountCampaignInfo'] +slug: /tools/sdk/go/beta/models/fullcampaign-all-of-machine-account-campaign-info +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfMachineAccountCampaignInfo', 'BetaFullcampaignAllOfMachineAccountCampaignInfo'] +--- + +# FullcampaignAllOfMachineAccountCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceIds** | Pointer to **[]string** | The list of sources to be included in the campaign. | [optional] +**ReviewerType** | Pointer to **string** | The reviewer's type. | [optional] + +## Methods + +### NewFullcampaignAllOfMachineAccountCampaignInfo + +`func NewFullcampaignAllOfMachineAccountCampaignInfo() *FullcampaignAllOfMachineAccountCampaignInfo` + +NewFullcampaignAllOfMachineAccountCampaignInfo instantiates a new FullcampaignAllOfMachineAccountCampaignInfo 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 + +### NewFullcampaignAllOfMachineAccountCampaignInfoWithDefaults + +`func NewFullcampaignAllOfMachineAccountCampaignInfoWithDefaults() *FullcampaignAllOfMachineAccountCampaignInfo` + +NewFullcampaignAllOfMachineAccountCampaignInfoWithDefaults instantiates a new FullcampaignAllOfMachineAccountCampaignInfo 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 + +### GetSourceIds + +`func (o *FullcampaignAllOfMachineAccountCampaignInfo) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *FullcampaignAllOfMachineAccountCampaignInfo) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *FullcampaignAllOfMachineAccountCampaignInfo) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *FullcampaignAllOfMachineAccountCampaignInfo) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + +### GetReviewerType + +`func (o *FullcampaignAllOfMachineAccountCampaignInfo) GetReviewerType() string` + +GetReviewerType returns the ReviewerType field if non-nil, zero value otherwise. + +### GetReviewerTypeOk + +`func (o *FullcampaignAllOfMachineAccountCampaignInfo) GetReviewerTypeOk() (*string, bool)` + +GetReviewerTypeOk returns a tuple with the ReviewerType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerType + +`func (o *FullcampaignAllOfMachineAccountCampaignInfo) SetReviewerType(v string)` + +SetReviewerType sets ReviewerType field to given value. + +### HasReviewerType + +`func (o *FullcampaignAllOfMachineAccountCampaignInfo) HasReviewerType() bool` + +HasReviewerType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfRoleCompositionCampaignInfo.md b/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfRoleCompositionCampaignInfo.md new file mode 100644 index 000000000..7f2006719 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfRoleCompositionCampaignInfo.md @@ -0,0 +1,163 @@ +--- +id: beta-fullcampaign-all-of-role-composition-campaign-info +title: FullcampaignAllOfRoleCompositionCampaignInfo +pagination_label: FullcampaignAllOfRoleCompositionCampaignInfo +sidebar_label: FullcampaignAllOfRoleCompositionCampaignInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FullcampaignAllOfRoleCompositionCampaignInfo', 'BetaFullcampaignAllOfRoleCompositionCampaignInfo'] +slug: /tools/sdk/go/beta/models/fullcampaign-all-of-role-composition-campaign-info +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfRoleCompositionCampaignInfo', 'BetaFullcampaignAllOfRoleCompositionCampaignInfo'] +--- + +# FullcampaignAllOfRoleCompositionCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Reviewer** | Pointer to [**FullcampaignAllOfSearchCampaignInfoReviewer**](fullcampaign-all-of-search-campaign-info-reviewer) | | [optional] +**RoleIds** | Pointer to **[]string** | Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] +**RemediatorRef** | [**FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef**](fullcampaign-all-of-role-composition-campaign-info-remediator-ref) | | +**Query** | Pointer to **string** | Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] +**Description** | Pointer to **string** | Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. | [optional] + +## Methods + +### NewFullcampaignAllOfRoleCompositionCampaignInfo + +`func NewFullcampaignAllOfRoleCompositionCampaignInfo(remediatorRef FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef, ) *FullcampaignAllOfRoleCompositionCampaignInfo` + +NewFullcampaignAllOfRoleCompositionCampaignInfo instantiates a new FullcampaignAllOfRoleCompositionCampaignInfo 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 + +### NewFullcampaignAllOfRoleCompositionCampaignInfoWithDefaults + +`func NewFullcampaignAllOfRoleCompositionCampaignInfoWithDefaults() *FullcampaignAllOfRoleCompositionCampaignInfo` + +NewFullcampaignAllOfRoleCompositionCampaignInfoWithDefaults instantiates a new FullcampaignAllOfRoleCompositionCampaignInfo 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 + +### GetReviewer + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) GetReviewer() FullcampaignAllOfSearchCampaignInfoReviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) GetReviewerOk() (*FullcampaignAllOfSearchCampaignInfoReviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) SetReviewer(v FullcampaignAllOfSearchCampaignInfoReviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetRoleIds + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) GetRoleIds() []string` + +GetRoleIds returns the RoleIds field if non-nil, zero value otherwise. + +### GetRoleIdsOk + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) GetRoleIdsOk() (*[]string, bool)` + +GetRoleIdsOk returns a tuple with the RoleIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleIds + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) SetRoleIds(v []string)` + +SetRoleIds sets RoleIds field to given value. + +### HasRoleIds + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) HasRoleIds() bool` + +HasRoleIds returns a boolean if a field has been set. + +### GetRemediatorRef + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) GetRemediatorRef() FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef` + +GetRemediatorRef returns the RemediatorRef field if non-nil, zero value otherwise. + +### GetRemediatorRefOk + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) GetRemediatorRefOk() (*FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef, bool)` + +GetRemediatorRefOk returns a tuple with the RemediatorRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemediatorRef + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) SetRemediatorRef(v FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef)` + +SetRemediatorRef sets RemediatorRef field to given value. + + +### GetQuery + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### GetDescription + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfo) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md b/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md new file mode 100644 index 000000000..068462ea7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md @@ -0,0 +1,106 @@ +--- +id: beta-fullcampaign-all-of-role-composition-campaign-info-remediator-ref +title: FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef +pagination_label: FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_label: FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'BetaFullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +slug: /tools/sdk/go/beta/models/fullcampaign-all-of-role-composition-campaign-info-remediator-ref +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'BetaFullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +--- + +# FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Legal Remediator Type | +**Id** | **string** | The ID of the remediator. | +**Name** | Pointer to **string** | The name of the remediator. | [optional] [readonly] + +## Methods + +### NewFullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +`func NewFullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef(type_ string, id string, ) *FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef` + +NewFullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef instantiates a new FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef 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 + +### NewFullcampaignAllOfRoleCompositionCampaignInfoRemediatorRefWithDefaults + +`func NewFullcampaignAllOfRoleCompositionCampaignInfoRemediatorRefWithDefaults() *FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef` + +NewFullcampaignAllOfRoleCompositionCampaignInfoRemediatorRefWithDefaults instantiates a new FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef 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 + +### GetType + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfSearchCampaignInfo.md b/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfSearchCampaignInfo.md new file mode 100644 index 000000000..730aef993 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfSearchCampaignInfo.md @@ -0,0 +1,189 @@ +--- +id: beta-fullcampaign-all-of-search-campaign-info +title: FullcampaignAllOfSearchCampaignInfo +pagination_label: FullcampaignAllOfSearchCampaignInfo +sidebar_label: FullcampaignAllOfSearchCampaignInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FullcampaignAllOfSearchCampaignInfo', 'BetaFullcampaignAllOfSearchCampaignInfo'] +slug: /tools/sdk/go/beta/models/fullcampaign-all-of-search-campaign-info +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfSearchCampaignInfo', 'BetaFullcampaignAllOfSearchCampaignInfo'] +--- + +# FullcampaignAllOfSearchCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of search campaign represented. | +**Description** | Pointer to **string** | Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. | [optional] +**Reviewer** | Pointer to [**FullcampaignAllOfSearchCampaignInfoReviewer**](fullcampaign-all-of-search-campaign-info-reviewer) | | [optional] +**Query** | Pointer to **string** | The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set. | [optional] +**IdentityIds** | Pointer to **[]string** | A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. | [optional] +**AccessConstraints** | Pointer to [**[]AccessConstraint**](access-constraint) | Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. | [optional] + +## Methods + +### NewFullcampaignAllOfSearchCampaignInfo + +`func NewFullcampaignAllOfSearchCampaignInfo(type_ string, ) *FullcampaignAllOfSearchCampaignInfo` + +NewFullcampaignAllOfSearchCampaignInfo instantiates a new FullcampaignAllOfSearchCampaignInfo 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 + +### NewFullcampaignAllOfSearchCampaignInfoWithDefaults + +`func NewFullcampaignAllOfSearchCampaignInfoWithDefaults() *FullcampaignAllOfSearchCampaignInfo` + +NewFullcampaignAllOfSearchCampaignInfoWithDefaults instantiates a new FullcampaignAllOfSearchCampaignInfo 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 + +### GetType + +`func (o *FullcampaignAllOfSearchCampaignInfo) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FullcampaignAllOfSearchCampaignInfo) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FullcampaignAllOfSearchCampaignInfo) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDescription + +`func (o *FullcampaignAllOfSearchCampaignInfo) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *FullcampaignAllOfSearchCampaignInfo) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *FullcampaignAllOfSearchCampaignInfo) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *FullcampaignAllOfSearchCampaignInfo) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetReviewer + +`func (o *FullcampaignAllOfSearchCampaignInfo) GetReviewer() FullcampaignAllOfSearchCampaignInfoReviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *FullcampaignAllOfSearchCampaignInfo) GetReviewerOk() (*FullcampaignAllOfSearchCampaignInfoReviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *FullcampaignAllOfSearchCampaignInfo) SetReviewer(v FullcampaignAllOfSearchCampaignInfoReviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *FullcampaignAllOfSearchCampaignInfo) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetQuery + +`func (o *FullcampaignAllOfSearchCampaignInfo) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *FullcampaignAllOfSearchCampaignInfo) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *FullcampaignAllOfSearchCampaignInfo) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *FullcampaignAllOfSearchCampaignInfo) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### GetIdentityIds + +`func (o *FullcampaignAllOfSearchCampaignInfo) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *FullcampaignAllOfSearchCampaignInfo) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *FullcampaignAllOfSearchCampaignInfo) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *FullcampaignAllOfSearchCampaignInfo) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + +### GetAccessConstraints + +`func (o *FullcampaignAllOfSearchCampaignInfo) GetAccessConstraints() []AccessConstraint` + +GetAccessConstraints returns the AccessConstraints field if non-nil, zero value otherwise. + +### GetAccessConstraintsOk + +`func (o *FullcampaignAllOfSearchCampaignInfo) GetAccessConstraintsOk() (*[]AccessConstraint, bool)` + +GetAccessConstraintsOk returns a tuple with the AccessConstraints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessConstraints + +`func (o *FullcampaignAllOfSearchCampaignInfo) SetAccessConstraints(v []AccessConstraint)` + +SetAccessConstraints sets AccessConstraints field to given value. + +### HasAccessConstraints + +`func (o *FullcampaignAllOfSearchCampaignInfo) HasAccessConstraints() bool` + +HasAccessConstraints returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfSearchCampaignInfoReviewer.md b/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfSearchCampaignInfoReviewer.md new file mode 100644 index 000000000..53f6cbdbe --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfSearchCampaignInfoReviewer.md @@ -0,0 +1,116 @@ +--- +id: beta-fullcampaign-all-of-search-campaign-info-reviewer +title: FullcampaignAllOfSearchCampaignInfoReviewer +pagination_label: FullcampaignAllOfSearchCampaignInfoReviewer +sidebar_label: FullcampaignAllOfSearchCampaignInfoReviewer +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FullcampaignAllOfSearchCampaignInfoReviewer', 'BetaFullcampaignAllOfSearchCampaignInfoReviewer'] +slug: /tools/sdk/go/beta/models/fullcampaign-all-of-search-campaign-info-reviewer +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfSearchCampaignInfoReviewer', 'BetaFullcampaignAllOfSearchCampaignInfoReviewer'] +--- + +# FullcampaignAllOfSearchCampaignInfoReviewer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The reviewer's DTO type. | [optional] +**Id** | Pointer to **string** | The reviewer's ID. | [optional] +**Name** | Pointer to **string** | The reviewer's name. | [optional] + +## Methods + +### NewFullcampaignAllOfSearchCampaignInfoReviewer + +`func NewFullcampaignAllOfSearchCampaignInfoReviewer() *FullcampaignAllOfSearchCampaignInfoReviewer` + +NewFullcampaignAllOfSearchCampaignInfoReviewer instantiates a new FullcampaignAllOfSearchCampaignInfoReviewer 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 + +### NewFullcampaignAllOfSearchCampaignInfoReviewerWithDefaults + +`func NewFullcampaignAllOfSearchCampaignInfoReviewerWithDefaults() *FullcampaignAllOfSearchCampaignInfoReviewer` + +NewFullcampaignAllOfSearchCampaignInfoReviewerWithDefaults instantiates a new FullcampaignAllOfSearchCampaignInfoReviewer 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 + +### GetType + +`func (o *FullcampaignAllOfSearchCampaignInfoReviewer) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FullcampaignAllOfSearchCampaignInfoReviewer) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FullcampaignAllOfSearchCampaignInfoReviewer) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FullcampaignAllOfSearchCampaignInfoReviewer) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *FullcampaignAllOfSearchCampaignInfoReviewer) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FullcampaignAllOfSearchCampaignInfoReviewer) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FullcampaignAllOfSearchCampaignInfoReviewer) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FullcampaignAllOfSearchCampaignInfoReviewer) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FullcampaignAllOfSearchCampaignInfoReviewer) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FullcampaignAllOfSearchCampaignInfoReviewer) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FullcampaignAllOfSearchCampaignInfoReviewer) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FullcampaignAllOfSearchCampaignInfoReviewer) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfSourceOwnerCampaignInfo.md b/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfSourceOwnerCampaignInfo.md new file mode 100644 index 000000000..820d89f5f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfSourceOwnerCampaignInfo.md @@ -0,0 +1,64 @@ +--- +id: beta-fullcampaign-all-of-source-owner-campaign-info +title: FullcampaignAllOfSourceOwnerCampaignInfo +pagination_label: FullcampaignAllOfSourceOwnerCampaignInfo +sidebar_label: FullcampaignAllOfSourceOwnerCampaignInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FullcampaignAllOfSourceOwnerCampaignInfo', 'BetaFullcampaignAllOfSourceOwnerCampaignInfo'] +slug: /tools/sdk/go/beta/models/fullcampaign-all-of-source-owner-campaign-info +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfSourceOwnerCampaignInfo', 'BetaFullcampaignAllOfSourceOwnerCampaignInfo'] +--- + +# FullcampaignAllOfSourceOwnerCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceIds** | Pointer to **[]string** | The list of sources to be included in the campaign. | [optional] + +## Methods + +### NewFullcampaignAllOfSourceOwnerCampaignInfo + +`func NewFullcampaignAllOfSourceOwnerCampaignInfo() *FullcampaignAllOfSourceOwnerCampaignInfo` + +NewFullcampaignAllOfSourceOwnerCampaignInfo instantiates a new FullcampaignAllOfSourceOwnerCampaignInfo 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 + +### NewFullcampaignAllOfSourceOwnerCampaignInfoWithDefaults + +`func NewFullcampaignAllOfSourceOwnerCampaignInfoWithDefaults() *FullcampaignAllOfSourceOwnerCampaignInfo` + +NewFullcampaignAllOfSourceOwnerCampaignInfoWithDefaults instantiates a new FullcampaignAllOfSourceOwnerCampaignInfo 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 + +### GetSourceIds + +`func (o *FullcampaignAllOfSourceOwnerCampaignInfo) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *FullcampaignAllOfSourceOwnerCampaignInfo) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *FullcampaignAllOfSourceOwnerCampaignInfo) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *FullcampaignAllOfSourceOwnerCampaignInfo) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfSourcesWithOrphanEntitlements.md b/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfSourcesWithOrphanEntitlements.md new file mode 100644 index 000000000..10d79d123 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/FullcampaignAllOfSourcesWithOrphanEntitlements.md @@ -0,0 +1,116 @@ +--- +id: beta-fullcampaign-all-of-sources-with-orphan-entitlements +title: FullcampaignAllOfSourcesWithOrphanEntitlements +pagination_label: FullcampaignAllOfSourcesWithOrphanEntitlements +sidebar_label: FullcampaignAllOfSourcesWithOrphanEntitlements +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FullcampaignAllOfSourcesWithOrphanEntitlements', 'BetaFullcampaignAllOfSourcesWithOrphanEntitlements'] +slug: /tools/sdk/go/beta/models/fullcampaign-all-of-sources-with-orphan-entitlements +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfSourcesWithOrphanEntitlements', 'BetaFullcampaignAllOfSourcesWithOrphanEntitlements'] +--- + +# FullcampaignAllOfSourcesWithOrphanEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the source | [optional] +**Type** | Pointer to **string** | Type | [optional] +**Name** | Pointer to **string** | Name of the source | [optional] + +## Methods + +### NewFullcampaignAllOfSourcesWithOrphanEntitlements + +`func NewFullcampaignAllOfSourcesWithOrphanEntitlements() *FullcampaignAllOfSourcesWithOrphanEntitlements` + +NewFullcampaignAllOfSourcesWithOrphanEntitlements instantiates a new FullcampaignAllOfSourcesWithOrphanEntitlements 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 + +### NewFullcampaignAllOfSourcesWithOrphanEntitlementsWithDefaults + +`func NewFullcampaignAllOfSourcesWithOrphanEntitlementsWithDefaults() *FullcampaignAllOfSourcesWithOrphanEntitlements` + +NewFullcampaignAllOfSourcesWithOrphanEntitlementsWithDefaults instantiates a new FullcampaignAllOfSourcesWithOrphanEntitlements 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 + +### GetId + +`func (o *FullcampaignAllOfSourcesWithOrphanEntitlements) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FullcampaignAllOfSourcesWithOrphanEntitlements) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FullcampaignAllOfSourcesWithOrphanEntitlements) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FullcampaignAllOfSourcesWithOrphanEntitlements) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *FullcampaignAllOfSourcesWithOrphanEntitlements) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FullcampaignAllOfSourcesWithOrphanEntitlements) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FullcampaignAllOfSourcesWithOrphanEntitlements) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FullcampaignAllOfSourcesWithOrphanEntitlements) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *FullcampaignAllOfSourcesWithOrphanEntitlements) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FullcampaignAllOfSourcesWithOrphanEntitlements) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FullcampaignAllOfSourcesWithOrphanEntitlements) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FullcampaignAllOfSourcesWithOrphanEntitlements) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md b/docs/tools/sdk/go/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md new file mode 100644 index 000000000..2dd411e2c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md @@ -0,0 +1,621 @@ +--- +id: beta-get-active-campaigns200-response-inner +title: GetActiveCampaigns200ResponseInner +pagination_label: GetActiveCampaigns200ResponseInner +sidebar_label: GetActiveCampaigns200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetActiveCampaigns200ResponseInner', 'BetaGetActiveCampaigns200ResponseInner'] +slug: /tools/sdk/go/beta/models/get-active-campaigns200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetActiveCampaigns200ResponseInner', 'BetaGetActiveCampaigns200ResponseInner'] +--- + +# GetActiveCampaigns200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the campaign | [optional] [readonly] +**Name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Description** | **string** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Deadline** | Pointer to **SailPointTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **string** | The type of campaign. Could be extended in the future. | +**EmailNotificationEnabled** | Pointer to **bool** | Enables email notification for this campaign | [optional] [default to false] +**AutoRevokeAllowed** | Pointer to **bool** | Allows auto revoke for this campaign | [optional] [default to false] +**RecommendationsEnabled** | Pointer to **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to false] +**Status** | Pointer to **string** | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **SailPointTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Modified time of the campaign | [optional] [readonly] +**Filter** | Pointer to [**FullcampaignAllOfFilter**](fullcampaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **bool** | Determines if comments on sunset date changes are required. | [optional] [default to true] +**SourceOwnerCampaignInfo** | Pointer to [**FullcampaignAllOfSourceOwnerCampaignInfo**](fullcampaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**FullcampaignAllOfSearchCampaignInfo**](fullcampaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**FullcampaignAllOfRoleCompositionCampaignInfo**](fullcampaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**FullcampaignAllOfMachineAccountCampaignInfo**](fullcampaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]FullcampaignAllOfSourcesWithOrphanEntitlements**](fullcampaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Methods + +### NewGetActiveCampaigns200ResponseInner + +`func NewGetActiveCampaigns200ResponseInner(name string, description string, type_ string, ) *GetActiveCampaigns200ResponseInner` + +NewGetActiveCampaigns200ResponseInner instantiates a new GetActiveCampaigns200ResponseInner 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 + +### NewGetActiveCampaigns200ResponseInnerWithDefaults + +`func NewGetActiveCampaigns200ResponseInnerWithDefaults() *GetActiveCampaigns200ResponseInner` + +NewGetActiveCampaigns200ResponseInnerWithDefaults instantiates a new GetActiveCampaigns200ResponseInner 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 + +### GetId + +`func (o *GetActiveCampaigns200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetActiveCampaigns200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetActiveCampaigns200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetActiveCampaigns200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *GetActiveCampaigns200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetActiveCampaigns200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetActiveCampaigns200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *GetActiveCampaigns200ResponseInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *GetActiveCampaigns200ResponseInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *GetActiveCampaigns200ResponseInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetDeadline + +`func (o *GetActiveCampaigns200ResponseInner) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *GetActiveCampaigns200ResponseInner) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *GetActiveCampaigns200ResponseInner) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *GetActiveCampaigns200ResponseInner) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### GetType + +`func (o *GetActiveCampaigns200ResponseInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *GetActiveCampaigns200ResponseInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *GetActiveCampaigns200ResponseInner) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEmailNotificationEnabled + +`func (o *GetActiveCampaigns200ResponseInner) GetEmailNotificationEnabled() bool` + +GetEmailNotificationEnabled returns the EmailNotificationEnabled field if non-nil, zero value otherwise. + +### GetEmailNotificationEnabledOk + +`func (o *GetActiveCampaigns200ResponseInner) GetEmailNotificationEnabledOk() (*bool, bool)` + +GetEmailNotificationEnabledOk returns a tuple with the EmailNotificationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationEnabled + +`func (o *GetActiveCampaigns200ResponseInner) SetEmailNotificationEnabled(v bool)` + +SetEmailNotificationEnabled sets EmailNotificationEnabled field to given value. + +### HasEmailNotificationEnabled + +`func (o *GetActiveCampaigns200ResponseInner) HasEmailNotificationEnabled() bool` + +HasEmailNotificationEnabled returns a boolean if a field has been set. + +### GetAutoRevokeAllowed + +`func (o *GetActiveCampaigns200ResponseInner) GetAutoRevokeAllowed() bool` + +GetAutoRevokeAllowed returns the AutoRevokeAllowed field if non-nil, zero value otherwise. + +### GetAutoRevokeAllowedOk + +`func (o *GetActiveCampaigns200ResponseInner) GetAutoRevokeAllowedOk() (*bool, bool)` + +GetAutoRevokeAllowedOk returns a tuple with the AutoRevokeAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoRevokeAllowed + +`func (o *GetActiveCampaigns200ResponseInner) SetAutoRevokeAllowed(v bool)` + +SetAutoRevokeAllowed sets AutoRevokeAllowed field to given value. + +### HasAutoRevokeAllowed + +`func (o *GetActiveCampaigns200ResponseInner) HasAutoRevokeAllowed() bool` + +HasAutoRevokeAllowed returns a boolean if a field has been set. + +### GetRecommendationsEnabled + +`func (o *GetActiveCampaigns200ResponseInner) GetRecommendationsEnabled() bool` + +GetRecommendationsEnabled returns the RecommendationsEnabled field if non-nil, zero value otherwise. + +### GetRecommendationsEnabledOk + +`func (o *GetActiveCampaigns200ResponseInner) GetRecommendationsEnabledOk() (*bool, bool)` + +GetRecommendationsEnabledOk returns a tuple with the RecommendationsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendationsEnabled + +`func (o *GetActiveCampaigns200ResponseInner) SetRecommendationsEnabled(v bool)` + +SetRecommendationsEnabled sets RecommendationsEnabled field to given value. + +### HasRecommendationsEnabled + +`func (o *GetActiveCampaigns200ResponseInner) HasRecommendationsEnabled() bool` + +HasRecommendationsEnabled returns a boolean if a field has been set. + +### GetStatus + +`func (o *GetActiveCampaigns200ResponseInner) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GetActiveCampaigns200ResponseInner) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GetActiveCampaigns200ResponseInner) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GetActiveCampaigns200ResponseInner) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetCorrelatedStatus + +`func (o *GetActiveCampaigns200ResponseInner) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *GetActiveCampaigns200ResponseInner) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *GetActiveCampaigns200ResponseInner) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + +### HasCorrelatedStatus + +`func (o *GetActiveCampaigns200ResponseInner) HasCorrelatedStatus() bool` + +HasCorrelatedStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *GetActiveCampaigns200ResponseInner) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GetActiveCampaigns200ResponseInner) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *GetActiveCampaigns200ResponseInner) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *GetActiveCampaigns200ResponseInner) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetTotalCertifications + +`func (o *GetActiveCampaigns200ResponseInner) GetTotalCertifications() int32` + +GetTotalCertifications returns the TotalCertifications field if non-nil, zero value otherwise. + +### GetTotalCertificationsOk + +`func (o *GetActiveCampaigns200ResponseInner) GetTotalCertificationsOk() (*int32, bool)` + +GetTotalCertificationsOk returns a tuple with the TotalCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCertifications + +`func (o *GetActiveCampaigns200ResponseInner) SetTotalCertifications(v int32)` + +SetTotalCertifications sets TotalCertifications field to given value. + +### HasTotalCertifications + +`func (o *GetActiveCampaigns200ResponseInner) HasTotalCertifications() bool` + +HasTotalCertifications returns a boolean if a field has been set. + +### GetCompletedCertifications + +`func (o *GetActiveCampaigns200ResponseInner) GetCompletedCertifications() int32` + +GetCompletedCertifications returns the CompletedCertifications field if non-nil, zero value otherwise. + +### GetCompletedCertificationsOk + +`func (o *GetActiveCampaigns200ResponseInner) GetCompletedCertificationsOk() (*int32, bool)` + +GetCompletedCertificationsOk returns a tuple with the CompletedCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedCertifications + +`func (o *GetActiveCampaigns200ResponseInner) SetCompletedCertifications(v int32)` + +SetCompletedCertifications sets CompletedCertifications field to given value. + +### HasCompletedCertifications + +`func (o *GetActiveCampaigns200ResponseInner) HasCompletedCertifications() bool` + +HasCompletedCertifications returns a boolean if a field has been set. + +### GetAlerts + +`func (o *GetActiveCampaigns200ResponseInner) GetAlerts() []CampaignAlert` + +GetAlerts returns the Alerts field if non-nil, zero value otherwise. + +### GetAlertsOk + +`func (o *GetActiveCampaigns200ResponseInner) GetAlertsOk() (*[]CampaignAlert, bool)` + +GetAlertsOk returns a tuple with the Alerts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlerts + +`func (o *GetActiveCampaigns200ResponseInner) SetAlerts(v []CampaignAlert)` + +SetAlerts sets Alerts field to given value. + +### HasAlerts + +`func (o *GetActiveCampaigns200ResponseInner) HasAlerts() bool` + +HasAlerts returns a boolean if a field has been set. + +### GetModified + +`func (o *GetActiveCampaigns200ResponseInner) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *GetActiveCampaigns200ResponseInner) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *GetActiveCampaigns200ResponseInner) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *GetActiveCampaigns200ResponseInner) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetFilter + +`func (o *GetActiveCampaigns200ResponseInner) GetFilter() FullcampaignAllOfFilter` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *GetActiveCampaigns200ResponseInner) GetFilterOk() (*FullcampaignAllOfFilter, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *GetActiveCampaigns200ResponseInner) SetFilter(v FullcampaignAllOfFilter)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *GetActiveCampaigns200ResponseInner) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### GetSunsetCommentsRequired + +`func (o *GetActiveCampaigns200ResponseInner) GetSunsetCommentsRequired() bool` + +GetSunsetCommentsRequired returns the SunsetCommentsRequired field if non-nil, zero value otherwise. + +### GetSunsetCommentsRequiredOk + +`func (o *GetActiveCampaigns200ResponseInner) GetSunsetCommentsRequiredOk() (*bool, bool)` + +GetSunsetCommentsRequiredOk returns a tuple with the SunsetCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSunsetCommentsRequired + +`func (o *GetActiveCampaigns200ResponseInner) SetSunsetCommentsRequired(v bool)` + +SetSunsetCommentsRequired sets SunsetCommentsRequired field to given value. + +### HasSunsetCommentsRequired + +`func (o *GetActiveCampaigns200ResponseInner) HasSunsetCommentsRequired() bool` + +HasSunsetCommentsRequired returns a boolean if a field has been set. + +### GetSourceOwnerCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) GetSourceOwnerCampaignInfo() FullcampaignAllOfSourceOwnerCampaignInfo` + +GetSourceOwnerCampaignInfo returns the SourceOwnerCampaignInfo field if non-nil, zero value otherwise. + +### GetSourceOwnerCampaignInfoOk + +`func (o *GetActiveCampaigns200ResponseInner) GetSourceOwnerCampaignInfoOk() (*FullcampaignAllOfSourceOwnerCampaignInfo, bool)` + +GetSourceOwnerCampaignInfoOk returns a tuple with the SourceOwnerCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceOwnerCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) SetSourceOwnerCampaignInfo(v FullcampaignAllOfSourceOwnerCampaignInfo)` + +SetSourceOwnerCampaignInfo sets SourceOwnerCampaignInfo field to given value. + +### HasSourceOwnerCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) HasSourceOwnerCampaignInfo() bool` + +HasSourceOwnerCampaignInfo returns a boolean if a field has been set. + +### GetSearchCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) GetSearchCampaignInfo() FullcampaignAllOfSearchCampaignInfo` + +GetSearchCampaignInfo returns the SearchCampaignInfo field if non-nil, zero value otherwise. + +### GetSearchCampaignInfoOk + +`func (o *GetActiveCampaigns200ResponseInner) GetSearchCampaignInfoOk() (*FullcampaignAllOfSearchCampaignInfo, bool)` + +GetSearchCampaignInfoOk returns a tuple with the SearchCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) SetSearchCampaignInfo(v FullcampaignAllOfSearchCampaignInfo)` + +SetSearchCampaignInfo sets SearchCampaignInfo field to given value. + +### HasSearchCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) HasSearchCampaignInfo() bool` + +HasSearchCampaignInfo returns a boolean if a field has been set. + +### GetRoleCompositionCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) GetRoleCompositionCampaignInfo() FullcampaignAllOfRoleCompositionCampaignInfo` + +GetRoleCompositionCampaignInfo returns the RoleCompositionCampaignInfo field if non-nil, zero value otherwise. + +### GetRoleCompositionCampaignInfoOk + +`func (o *GetActiveCampaigns200ResponseInner) GetRoleCompositionCampaignInfoOk() (*FullcampaignAllOfRoleCompositionCampaignInfo, bool)` + +GetRoleCompositionCampaignInfoOk returns a tuple with the RoleCompositionCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleCompositionCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) SetRoleCompositionCampaignInfo(v FullcampaignAllOfRoleCompositionCampaignInfo)` + +SetRoleCompositionCampaignInfo sets RoleCompositionCampaignInfo field to given value. + +### HasRoleCompositionCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) HasRoleCompositionCampaignInfo() bool` + +HasRoleCompositionCampaignInfo returns a boolean if a field has been set. + +### GetMachineAccountCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) GetMachineAccountCampaignInfo() FullcampaignAllOfMachineAccountCampaignInfo` + +GetMachineAccountCampaignInfo returns the MachineAccountCampaignInfo field if non-nil, zero value otherwise. + +### GetMachineAccountCampaignInfoOk + +`func (o *GetActiveCampaigns200ResponseInner) GetMachineAccountCampaignInfoOk() (*FullcampaignAllOfMachineAccountCampaignInfo, bool)` + +GetMachineAccountCampaignInfoOk returns a tuple with the MachineAccountCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMachineAccountCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) SetMachineAccountCampaignInfo(v FullcampaignAllOfMachineAccountCampaignInfo)` + +SetMachineAccountCampaignInfo sets MachineAccountCampaignInfo field to given value. + +### HasMachineAccountCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) HasMachineAccountCampaignInfo() bool` + +HasMachineAccountCampaignInfo returns a boolean if a field has been set. + +### GetSourcesWithOrphanEntitlements + +`func (o *GetActiveCampaigns200ResponseInner) GetSourcesWithOrphanEntitlements() []FullcampaignAllOfSourcesWithOrphanEntitlements` + +GetSourcesWithOrphanEntitlements returns the SourcesWithOrphanEntitlements field if non-nil, zero value otherwise. + +### GetSourcesWithOrphanEntitlementsOk + +`func (o *GetActiveCampaigns200ResponseInner) GetSourcesWithOrphanEntitlementsOk() (*[]FullcampaignAllOfSourcesWithOrphanEntitlements, bool)` + +GetSourcesWithOrphanEntitlementsOk returns a tuple with the SourcesWithOrphanEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourcesWithOrphanEntitlements + +`func (o *GetActiveCampaigns200ResponseInner) SetSourcesWithOrphanEntitlements(v []FullcampaignAllOfSourcesWithOrphanEntitlements)` + +SetSourcesWithOrphanEntitlements sets SourcesWithOrphanEntitlements field to given value. + +### HasSourcesWithOrphanEntitlements + +`func (o *GetActiveCampaigns200ResponseInner) HasSourcesWithOrphanEntitlements() bool` + +HasSourcesWithOrphanEntitlements returns a boolean if a field has been set. + +### GetMandatoryCommentRequirement + +`func (o *GetActiveCampaigns200ResponseInner) GetMandatoryCommentRequirement() string` + +GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise. + +### GetMandatoryCommentRequirementOk + +`func (o *GetActiveCampaigns200ResponseInner) GetMandatoryCommentRequirementOk() (*string, bool)` + +GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMandatoryCommentRequirement + +`func (o *GetActiveCampaigns200ResponseInner) SetMandatoryCommentRequirement(v string)` + +SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value. + +### HasMandatoryCommentRequirement + +`func (o *GetActiveCampaigns200ResponseInner) HasMandatoryCommentRequirement() bool` + +HasMandatoryCommentRequirement returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/GetDiscoveredApplications200ResponseInner.md b/docs/tools/sdk/go/Reference/Beta/Models/GetDiscoveredApplications200ResponseInner.md new file mode 100644 index 000000000..4ee2e61f1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/GetDiscoveredApplications200ResponseInner.md @@ -0,0 +1,298 @@ +--- +id: beta-get-discovered-applications200-response-inner +title: GetDiscoveredApplications200ResponseInner +pagination_label: GetDiscoveredApplications200ResponseInner +sidebar_label: GetDiscoveredApplications200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetDiscoveredApplications200ResponseInner', 'BetaGetDiscoveredApplications200ResponseInner'] +slug: /tools/sdk/go/beta/models/get-discovered-applications200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetDiscoveredApplications200ResponseInner', 'BetaGetDiscoveredApplications200ResponseInner'] +--- + +# GetDiscoveredApplications200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **string** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **string** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **string** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **string** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]string** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **SailPointTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **string** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [optional] +**AssociatedSources** | Pointer to **[]string** | List of associated sources related to this discovered application. | [optional] + +## Methods + +### NewGetDiscoveredApplications200ResponseInner + +`func NewGetDiscoveredApplications200ResponseInner() *GetDiscoveredApplications200ResponseInner` + +NewGetDiscoveredApplications200ResponseInner instantiates a new GetDiscoveredApplications200ResponseInner 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 + +### NewGetDiscoveredApplications200ResponseInnerWithDefaults + +`func NewGetDiscoveredApplications200ResponseInnerWithDefaults() *GetDiscoveredApplications200ResponseInner` + +NewGetDiscoveredApplications200ResponseInnerWithDefaults instantiates a new GetDiscoveredApplications200ResponseInner 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 + +### GetId + +`func (o *GetDiscoveredApplications200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetDiscoveredApplications200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetDiscoveredApplications200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *GetDiscoveredApplications200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetDiscoveredApplications200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *GetDiscoveredApplications200ResponseInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDiscoverySource + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoverySource() string` + +GetDiscoverySource returns the DiscoverySource field if non-nil, zero value otherwise. + +### GetDiscoverySourceOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoverySourceOk() (*string, bool)` + +GetDiscoverySourceOk returns a tuple with the DiscoverySource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoverySource + +`func (o *GetDiscoveredApplications200ResponseInner) SetDiscoverySource(v string)` + +SetDiscoverySource sets DiscoverySource field to given value. + +### HasDiscoverySource + +`func (o *GetDiscoveredApplications200ResponseInner) HasDiscoverySource() bool` + +HasDiscoverySource returns a boolean if a field has been set. + +### GetDiscoveredVendor + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoveredVendor() string` + +GetDiscoveredVendor returns the DiscoveredVendor field if non-nil, zero value otherwise. + +### GetDiscoveredVendorOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoveredVendorOk() (*string, bool)` + +GetDiscoveredVendorOk returns a tuple with the DiscoveredVendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredVendor + +`func (o *GetDiscoveredApplications200ResponseInner) SetDiscoveredVendor(v string)` + +SetDiscoveredVendor sets DiscoveredVendor field to given value. + +### HasDiscoveredVendor + +`func (o *GetDiscoveredApplications200ResponseInner) HasDiscoveredVendor() bool` + +HasDiscoveredVendor returns a boolean if a field has been set. + +### GetDescription + +`func (o *GetDiscoveredApplications200ResponseInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *GetDiscoveredApplications200ResponseInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *GetDiscoveredApplications200ResponseInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetRecommendedConnectors + +`func (o *GetDiscoveredApplications200ResponseInner) GetRecommendedConnectors() []string` + +GetRecommendedConnectors returns the RecommendedConnectors field if non-nil, zero value otherwise. + +### GetRecommendedConnectorsOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetRecommendedConnectorsOk() (*[]string, bool)` + +GetRecommendedConnectorsOk returns a tuple with the RecommendedConnectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendedConnectors + +`func (o *GetDiscoveredApplications200ResponseInner) SetRecommendedConnectors(v []string)` + +SetRecommendedConnectors sets RecommendedConnectors field to given value. + +### HasRecommendedConnectors + +`func (o *GetDiscoveredApplications200ResponseInner) HasRecommendedConnectors() bool` + +HasRecommendedConnectors returns a boolean if a field has been set. + +### GetDiscoveredAt + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoveredAt() SailPointTime` + +GetDiscoveredAt returns the DiscoveredAt field if non-nil, zero value otherwise. + +### GetDiscoveredAtOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoveredAtOk() (*SailPointTime, bool)` + +GetDiscoveredAtOk returns a tuple with the DiscoveredAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredAt + +`func (o *GetDiscoveredApplications200ResponseInner) SetDiscoveredAt(v SailPointTime)` + +SetDiscoveredAt sets DiscoveredAt field to given value. + +### HasDiscoveredAt + +`func (o *GetDiscoveredApplications200ResponseInner) HasDiscoveredAt() bool` + +HasDiscoveredAt returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *GetDiscoveredApplications200ResponseInner) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *GetDiscoveredApplications200ResponseInner) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *GetDiscoveredApplications200ResponseInner) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetStatus + +`func (o *GetDiscoveredApplications200ResponseInner) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GetDiscoveredApplications200ResponseInner) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GetDiscoveredApplications200ResponseInner) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetAssociatedSources + +`func (o *GetDiscoveredApplications200ResponseInner) GetAssociatedSources() []string` + +GetAssociatedSources returns the AssociatedSources field if non-nil, zero value otherwise. + +### GetAssociatedSourcesOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetAssociatedSourcesOk() (*[]string, bool)` + +GetAssociatedSourcesOk returns a tuple with the AssociatedSources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociatedSources + +`func (o *GetDiscoveredApplications200ResponseInner) SetAssociatedSources(v []string)` + +SetAssociatedSources sets AssociatedSources field to given value. + +### HasAssociatedSources + +`func (o *GetDiscoveredApplications200ResponseInner) HasAssociatedSources() bool` + +HasAssociatedSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/GetFormDefinitionByKey400Response.md b/docs/tools/sdk/go/Reference/Beta/Models/GetFormDefinitionByKey400Response.md new file mode 100644 index 000000000..9b9b3b008 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/GetFormDefinitionByKey400Response.md @@ -0,0 +1,142 @@ +--- +id: beta-get-form-definition-by-key400-response +title: GetFormDefinitionByKey400Response +pagination_label: GetFormDefinitionByKey400Response +sidebar_label: GetFormDefinitionByKey400Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetFormDefinitionByKey400Response', 'BetaGetFormDefinitionByKey400Response'] +slug: /tools/sdk/go/beta/models/get-form-definition-by-key400-response +tags: ['SDK', 'Software Development Kit', 'GetFormDefinitionByKey400Response', 'BetaGetFormDefinitionByKey400Response'] +--- + +# GetFormDefinitionByKey400Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **string** | | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | | [optional] +**StatusCode** | Pointer to **int64** | | [optional] +**TrackingId** | Pointer to **string** | | [optional] + +## Methods + +### NewGetFormDefinitionByKey400Response + +`func NewGetFormDefinitionByKey400Response() *GetFormDefinitionByKey400Response` + +NewGetFormDefinitionByKey400Response instantiates a new GetFormDefinitionByKey400Response 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 + +### NewGetFormDefinitionByKey400ResponseWithDefaults + +`func NewGetFormDefinitionByKey400ResponseWithDefaults() *GetFormDefinitionByKey400Response` + +NewGetFormDefinitionByKey400ResponseWithDefaults instantiates a new GetFormDefinitionByKey400Response 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 + +### GetDetailCode + +`func (o *GetFormDefinitionByKey400Response) GetDetailCode() string` + +GetDetailCode returns the DetailCode field if non-nil, zero value otherwise. + +### GetDetailCodeOk + +`func (o *GetFormDefinitionByKey400Response) GetDetailCodeOk() (*string, bool)` + +GetDetailCodeOk returns a tuple with the DetailCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetailCode + +`func (o *GetFormDefinitionByKey400Response) SetDetailCode(v string)` + +SetDetailCode sets DetailCode field to given value. + +### HasDetailCode + +`func (o *GetFormDefinitionByKey400Response) HasDetailCode() bool` + +HasDetailCode returns a boolean if a field has been set. + +### GetMessages + +`func (o *GetFormDefinitionByKey400Response) GetMessages() []ErrorMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *GetFormDefinitionByKey400Response) GetMessagesOk() (*[]ErrorMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *GetFormDefinitionByKey400Response) SetMessages(v []ErrorMessage)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *GetFormDefinitionByKey400Response) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetStatusCode + +`func (o *GetFormDefinitionByKey400Response) GetStatusCode() int64` + +GetStatusCode returns the StatusCode field if non-nil, zero value otherwise. + +### GetStatusCodeOk + +`func (o *GetFormDefinitionByKey400Response) GetStatusCodeOk() (*int64, bool)` + +GetStatusCodeOk returns a tuple with the StatusCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusCode + +`func (o *GetFormDefinitionByKey400Response) SetStatusCode(v int64)` + +SetStatusCode sets StatusCode field to given value. + +### HasStatusCode + +`func (o *GetFormDefinitionByKey400Response) HasStatusCode() bool` + +HasStatusCode returns a boolean if a field has been set. + +### GetTrackingId + +`func (o *GetFormDefinitionByKey400Response) GetTrackingId() string` + +GetTrackingId returns the TrackingId field if non-nil, zero value otherwise. + +### GetTrackingIdOk + +`func (o *GetFormDefinitionByKey400Response) GetTrackingIdOk() (*string, bool)` + +GetTrackingIdOk returns a tuple with the TrackingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingId + +`func (o *GetFormDefinitionByKey400Response) SetTrackingId(v string)` + +SetTrackingId sets TrackingId field to given value. + +### HasTrackingId + +`func (o *GetFormDefinitionByKey400Response) HasTrackingId() bool` + +HasTrackingId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md b/docs/tools/sdk/go/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md new file mode 100644 index 000000000..b08fb90f0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md @@ -0,0 +1,428 @@ +--- +id: beta-get-historical-identity-events200-response-inner +title: GetHistoricalIdentityEvents200ResponseInner +pagination_label: GetHistoricalIdentityEvents200ResponseInner +sidebar_label: GetHistoricalIdentityEvents200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetHistoricalIdentityEvents200ResponseInner', 'BetaGetHistoricalIdentityEvents200ResponseInner'] +slug: /tools/sdk/go/beta/models/get-historical-identity-events200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetHistoricalIdentityEvents200ResponseInner', 'BetaGetHistoricalIdentityEvents200ResponseInner'] +--- + +# GetHistoricalIdentityEvents200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] +**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] +**Changes** | Pointer to [**[]AttributeChange**](attribute-change) | | [optional] +**AccessRequest** | Pointer to [**AccessRequestResponse1**](access-request-response1) | | [optional] +**CertificationId** | Pointer to **string** | the id of the certification item | [optional] +**CertificationName** | Pointer to **string** | the certification item name | [optional] +**SignedDate** | Pointer to **string** | the date ceritification was signed | [optional] +**Certifiers** | Pointer to [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional] +**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional] +**Signer** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] +**Account** | Pointer to [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] +**StatusChange** | Pointer to [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional] + +## Methods + +### NewGetHistoricalIdentityEvents200ResponseInner + +`func NewGetHistoricalIdentityEvents200ResponseInner() *GetHistoricalIdentityEvents200ResponseInner` + +NewGetHistoricalIdentityEvents200ResponseInner instantiates a new GetHistoricalIdentityEvents200ResponseInner 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 + +### NewGetHistoricalIdentityEvents200ResponseInnerWithDefaults + +`func NewGetHistoricalIdentityEvents200ResponseInnerWithDefaults() *GetHistoricalIdentityEvents200ResponseInner` + +NewGetHistoricalIdentityEvents200ResponseInnerWithDefaults instantiates a new GetHistoricalIdentityEvents200ResponseInner 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 + +### GetAccessItem + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccessItem() AccessItemAssociatedAccessItem` + +GetAccessItem returns the AccessItem field if non-nil, zero value otherwise. + +### GetAccessItemOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccessItemOk() (*AccessItemAssociatedAccessItem, bool)` + +GetAccessItemOk returns a tuple with the AccessItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItem + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetAccessItem(v AccessItemAssociatedAccessItem)` + +SetAccessItem sets AccessItem field to given value. + +### HasAccessItem + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasAccessItem() bool` + +HasAccessItem returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEventType + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDt + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasDt() bool` + +HasDt returns a boolean if a field has been set. + +### GetGovernanceEvent + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetGovernanceEvent() CorrelatedGovernanceEvent` + +GetGovernanceEvent returns the GovernanceEvent field if non-nil, zero value otherwise. + +### GetGovernanceEventOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetGovernanceEventOk() (*CorrelatedGovernanceEvent, bool)` + +GetGovernanceEventOk returns a tuple with the GovernanceEvent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceEvent + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetGovernanceEvent(v CorrelatedGovernanceEvent)` + +SetGovernanceEvent sets GovernanceEvent field to given value. + +### HasGovernanceEvent + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasGovernanceEvent() bool` + +HasGovernanceEvent returns a boolean if a field has been set. + +### GetChanges + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetChanges() []AttributeChange` + +GetChanges returns the Changes field if non-nil, zero value otherwise. + +### GetChangesOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetChangesOk() (*[]AttributeChange, bool)` + +GetChangesOk returns a tuple with the Changes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanges + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetChanges(v []AttributeChange)` + +SetChanges sets Changes field to given value. + +### HasChanges + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasChanges() bool` + +HasChanges returns a boolean if a field has been set. + +### GetAccessRequest + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccessRequest() AccessRequestResponse1` + +GetAccessRequest returns the AccessRequest field if non-nil, zero value otherwise. + +### GetAccessRequestOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccessRequestOk() (*AccessRequestResponse1, bool)` + +GetAccessRequestOk returns a tuple with the AccessRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequest + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetAccessRequest(v AccessRequestResponse1)` + +SetAccessRequest sets AccessRequest field to given value. + +### HasAccessRequest + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasAccessRequest() bool` + +HasAccessRequest returns a boolean if a field has been set. + +### GetCertificationId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertificationId() string` + +GetCertificationId returns the CertificationId field if non-nil, zero value otherwise. + +### GetCertificationIdOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertificationIdOk() (*string, bool)` + +GetCertificationIdOk returns a tuple with the CertificationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetCertificationId(v string)` + +SetCertificationId sets CertificationId field to given value. + +### HasCertificationId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasCertificationId() bool` + +HasCertificationId returns a boolean if a field has been set. + +### GetCertificationName + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertificationName() string` + +GetCertificationName returns the CertificationName field if non-nil, zero value otherwise. + +### GetCertificationNameOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertificationNameOk() (*string, bool)` + +GetCertificationNameOk returns a tuple with the CertificationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationName + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetCertificationName(v string)` + +SetCertificationName sets CertificationName field to given value. + +### HasCertificationName + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasCertificationName() bool` + +HasCertificationName returns a boolean if a field has been set. + +### GetSignedDate + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetSignedDate() string` + +GetSignedDate returns the SignedDate field if non-nil, zero value otherwise. + +### GetSignedDateOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetSignedDateOk() (*string, bool)` + +GetSignedDateOk returns a tuple with the SignedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignedDate + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetSignedDate(v string)` + +SetSignedDate sets SignedDate field to given value. + +### HasSignedDate + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasSignedDate() bool` + +HasSignedDate returns a boolean if a field has been set. + +### GetCertifiers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertifiers() []CertifierResponse` + +GetCertifiers returns the Certifiers field if non-nil, zero value otherwise. + +### GetCertifiersOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertifiersOk() (*[]CertifierResponse, bool)` + +GetCertifiersOk returns a tuple with the Certifiers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertifiers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetCertifiers(v []CertifierResponse)` + +SetCertifiers sets Certifiers field to given value. + +### HasCertifiers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasCertifiers() bool` + +HasCertifiers returns a boolean if a field has been set. + +### GetReviewers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetReviewers() []CertifierResponse` + +GetReviewers returns the Reviewers field if non-nil, zero value otherwise. + +### GetReviewersOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetReviewersOk() (*[]CertifierResponse, bool)` + +GetReviewersOk returns a tuple with the Reviewers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetReviewers(v []CertifierResponse)` + +SetReviewers sets Reviewers field to given value. + +### HasReviewers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasReviewers() bool` + +HasReviewers returns a boolean if a field has been set. + +### GetSigner + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetSigner() CertifierResponse` + +GetSigner returns the Signer field if non-nil, zero value otherwise. + +### GetSignerOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetSignerOk() (*CertifierResponse, bool)` + +GetSignerOk returns a tuple with the Signer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigner + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetSigner(v CertifierResponse)` + +SetSigner sets Signer field to given value. + +### HasSigner + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasSigner() bool` + +HasSigner returns a boolean if a field has been set. + +### GetAccount + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccount() AccountStatusChangedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccountOk() (*AccountStatusChangedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetAccount(v AccountStatusChangedAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### GetStatusChange + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetStatusChange() AccountStatusChangedStatusChange` + +GetStatusChange returns the StatusChange field if non-nil, zero value otherwise. + +### GetStatusChangeOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetStatusChangeOk() (*AccountStatusChangedStatusChange, bool)` + +GetStatusChangeOk returns a tuple with the StatusChange field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusChange + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetStatusChange(v AccountStatusChangedStatusChange)` + +SetStatusChange sets StatusChange field to given value. + +### HasStatusChange + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasStatusChange() bool` + +HasStatusChange returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/GetLaunchers200Response.md b/docs/tools/sdk/go/Reference/Beta/Models/GetLaunchers200Response.md new file mode 100644 index 000000000..82a1a5c60 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/GetLaunchers200Response.md @@ -0,0 +1,90 @@ +--- +id: beta-get-launchers200-response +title: GetLaunchers200Response +pagination_label: GetLaunchers200Response +sidebar_label: GetLaunchers200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetLaunchers200Response', 'BetaGetLaunchers200Response'] +slug: /tools/sdk/go/beta/models/get-launchers200-response +tags: ['SDK', 'Software Development Kit', 'GetLaunchers200Response', 'BetaGetLaunchers200Response'] +--- + +# GetLaunchers200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Next** | Pointer to **string** | Pagination marker | [optional] +**Items** | Pointer to [**[]Launcher**](launcher) | | [optional] + +## Methods + +### NewGetLaunchers200Response + +`func NewGetLaunchers200Response() *GetLaunchers200Response` + +NewGetLaunchers200Response instantiates a new GetLaunchers200Response 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 + +### NewGetLaunchers200ResponseWithDefaults + +`func NewGetLaunchers200ResponseWithDefaults() *GetLaunchers200Response` + +NewGetLaunchers200ResponseWithDefaults instantiates a new GetLaunchers200Response 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 + +### GetNext + +`func (o *GetLaunchers200Response) GetNext() string` + +GetNext returns the Next field if non-nil, zero value otherwise. + +### GetNextOk + +`func (o *GetLaunchers200Response) GetNextOk() (*string, bool)` + +GetNextOk returns a tuple with the Next field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNext + +`func (o *GetLaunchers200Response) SetNext(v string)` + +SetNext sets Next field to given value. + +### HasNext + +`func (o *GetLaunchers200Response) HasNext() bool` + +HasNext returns a boolean if a field has been set. + +### GetItems + +`func (o *GetLaunchers200Response) GetItems() []Launcher` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *GetLaunchers200Response) GetItemsOk() (*[]Launcher, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *GetLaunchers200Response) SetItems(v []Launcher)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *GetLaunchers200Response) HasItems() bool` + +HasItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/GetOAuthClientResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/GetOAuthClientResponse.md new file mode 100644 index 000000000..1ba66f6ea --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/GetOAuthClientResponse.md @@ -0,0 +1,574 @@ +--- +id: beta-get-o-auth-client-response +title: GetOAuthClientResponse +pagination_label: GetOAuthClientResponse +sidebar_label: GetOAuthClientResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetOAuthClientResponse', 'BetaGetOAuthClientResponse'] +slug: /tools/sdk/go/beta/models/get-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'GetOAuthClientResponse', 'BetaGetOAuthClientResponse'] +--- + +# GetOAuthClientResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the OAuth client | +**BusinessName** | **NullableString** | The name of the business the API Client should belong to | +**HomepageUrl** | **NullableString** | The homepage URL associated with the owner of the API Client | +**Name** | **string** | A human-readable name for the API Client | +**Description** | **NullableString** | A description of the API Client | +**AccessTokenValiditySeconds** | **int32** | The number of seconds an access token generated for this API Client is valid for | +**RefreshTokenValiditySeconds** | **int32** | The number of seconds a refresh token generated for this API Client is valid for | +**RedirectUris** | **[]string** | A list of the approved redirect URIs used with the authorization_code flow | +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | +**AccessType** | [**AccessType**](access-type) | | +**Type** | [**ClientType**](client-type) | | +**Internal** | **bool** | An indicator of whether the API Client can be used for requests internal to IDN | +**Enabled** | **bool** | An indicator of whether the API Client is enabled for use | +**StrongAuthSupported** | **bool** | An indicator of whether the API Client supports strong authentication | +**ClaimsSupported** | **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | +**Created** | **SailPointTime** | The date and time, down to the millisecond, when the API Client was created | +**Modified** | **SailPointTime** | The date and time, down to the millisecond, when the API Client was last updated | +**Secret** | Pointer to **NullableString** | | [optional] +**Metadata** | Pointer to **NullableString** | | [optional] +**LastUsed** | Pointer to **NullableTime** | The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. | [optional] +**Scope** | **[]string** | Scopes of the API Client. | + +## Methods + +### NewGetOAuthClientResponse + +`func NewGetOAuthClientResponse(id string, businessName NullableString, homepageUrl NullableString, name string, description NullableString, accessTokenValiditySeconds int32, refreshTokenValiditySeconds int32, redirectUris []string, grantTypes []GrantType, accessType AccessType, type_ ClientType, internal bool, enabled bool, strongAuthSupported bool, claimsSupported bool, created SailPointTime, modified SailPointTime, scope []string, ) *GetOAuthClientResponse` + +NewGetOAuthClientResponse instantiates a new GetOAuthClientResponse 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 + +### NewGetOAuthClientResponseWithDefaults + +`func NewGetOAuthClientResponseWithDefaults() *GetOAuthClientResponse` + +NewGetOAuthClientResponseWithDefaults instantiates a new GetOAuthClientResponse 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 + +### GetId + +`func (o *GetOAuthClientResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetOAuthClientResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetOAuthClientResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetBusinessName + +`func (o *GetOAuthClientResponse) GetBusinessName() string` + +GetBusinessName returns the BusinessName field if non-nil, zero value otherwise. + +### GetBusinessNameOk + +`func (o *GetOAuthClientResponse) GetBusinessNameOk() (*string, bool)` + +GetBusinessNameOk returns a tuple with the BusinessName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBusinessName + +`func (o *GetOAuthClientResponse) SetBusinessName(v string)` + +SetBusinessName sets BusinessName field to given value. + + +### SetBusinessNameNil + +`func (o *GetOAuthClientResponse) SetBusinessNameNil(b bool)` + + SetBusinessNameNil sets the value for BusinessName to be an explicit nil + +### UnsetBusinessName +`func (o *GetOAuthClientResponse) UnsetBusinessName()` + +UnsetBusinessName ensures that no value is present for BusinessName, not even an explicit nil +### GetHomepageUrl + +`func (o *GetOAuthClientResponse) GetHomepageUrl() string` + +GetHomepageUrl returns the HomepageUrl field if non-nil, zero value otherwise. + +### GetHomepageUrlOk + +`func (o *GetOAuthClientResponse) GetHomepageUrlOk() (*string, bool)` + +GetHomepageUrlOk returns a tuple with the HomepageUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHomepageUrl + +`func (o *GetOAuthClientResponse) SetHomepageUrl(v string)` + +SetHomepageUrl sets HomepageUrl field to given value. + + +### SetHomepageUrlNil + +`func (o *GetOAuthClientResponse) SetHomepageUrlNil(b bool)` + + SetHomepageUrlNil sets the value for HomepageUrl to be an explicit nil + +### UnsetHomepageUrl +`func (o *GetOAuthClientResponse) UnsetHomepageUrl()` + +UnsetHomepageUrl ensures that no value is present for HomepageUrl, not even an explicit nil +### GetName + +`func (o *GetOAuthClientResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetOAuthClientResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetOAuthClientResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *GetOAuthClientResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *GetOAuthClientResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *GetOAuthClientResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *GetOAuthClientResponse) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *GetOAuthClientResponse) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAccessTokenValiditySeconds + +`func (o *GetOAuthClientResponse) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *GetOAuthClientResponse) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *GetOAuthClientResponse) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + + +### GetRefreshTokenValiditySeconds + +`func (o *GetOAuthClientResponse) GetRefreshTokenValiditySeconds() int32` + +GetRefreshTokenValiditySeconds returns the RefreshTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetRefreshTokenValiditySecondsOk + +`func (o *GetOAuthClientResponse) GetRefreshTokenValiditySecondsOk() (*int32, bool)` + +GetRefreshTokenValiditySecondsOk returns a tuple with the RefreshTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenValiditySeconds + +`func (o *GetOAuthClientResponse) SetRefreshTokenValiditySeconds(v int32)` + +SetRefreshTokenValiditySeconds sets RefreshTokenValiditySeconds field to given value. + + +### GetRedirectUris + +`func (o *GetOAuthClientResponse) GetRedirectUris() []string` + +GetRedirectUris returns the RedirectUris field if non-nil, zero value otherwise. + +### GetRedirectUrisOk + +`func (o *GetOAuthClientResponse) GetRedirectUrisOk() (*[]string, bool)` + +GetRedirectUrisOk returns a tuple with the RedirectUris field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedirectUris + +`func (o *GetOAuthClientResponse) SetRedirectUris(v []string)` + +SetRedirectUris sets RedirectUris field to given value. + + +### SetRedirectUrisNil + +`func (o *GetOAuthClientResponse) SetRedirectUrisNil(b bool)` + + SetRedirectUrisNil sets the value for RedirectUris to be an explicit nil + +### UnsetRedirectUris +`func (o *GetOAuthClientResponse) UnsetRedirectUris()` + +UnsetRedirectUris ensures that no value is present for RedirectUris, not even an explicit nil +### GetGrantTypes + +`func (o *GetOAuthClientResponse) GetGrantTypes() []GrantType` + +GetGrantTypes returns the GrantTypes field if non-nil, zero value otherwise. + +### GetGrantTypesOk + +`func (o *GetOAuthClientResponse) GetGrantTypesOk() (*[]GrantType, bool)` + +GetGrantTypesOk returns a tuple with the GrantTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantTypes + +`func (o *GetOAuthClientResponse) SetGrantTypes(v []GrantType)` + +SetGrantTypes sets GrantTypes field to given value. + + +### GetAccessType + +`func (o *GetOAuthClientResponse) GetAccessType() AccessType` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *GetOAuthClientResponse) GetAccessTypeOk() (*AccessType, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *GetOAuthClientResponse) SetAccessType(v AccessType)` + +SetAccessType sets AccessType field to given value. + + +### GetType + +`func (o *GetOAuthClientResponse) GetType() ClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *GetOAuthClientResponse) GetTypeOk() (*ClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *GetOAuthClientResponse) SetType(v ClientType)` + +SetType sets Type field to given value. + + +### GetInternal + +`func (o *GetOAuthClientResponse) GetInternal() bool` + +GetInternal returns the Internal field if non-nil, zero value otherwise. + +### GetInternalOk + +`func (o *GetOAuthClientResponse) GetInternalOk() (*bool, bool)` + +GetInternalOk returns a tuple with the Internal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternal + +`func (o *GetOAuthClientResponse) SetInternal(v bool)` + +SetInternal sets Internal field to given value. + + +### GetEnabled + +`func (o *GetOAuthClientResponse) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *GetOAuthClientResponse) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *GetOAuthClientResponse) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetStrongAuthSupported + +`func (o *GetOAuthClientResponse) GetStrongAuthSupported() bool` + +GetStrongAuthSupported returns the StrongAuthSupported field if non-nil, zero value otherwise. + +### GetStrongAuthSupportedOk + +`func (o *GetOAuthClientResponse) GetStrongAuthSupportedOk() (*bool, bool)` + +GetStrongAuthSupportedOk returns a tuple with the StrongAuthSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStrongAuthSupported + +`func (o *GetOAuthClientResponse) SetStrongAuthSupported(v bool)` + +SetStrongAuthSupported sets StrongAuthSupported field to given value. + + +### GetClaimsSupported + +`func (o *GetOAuthClientResponse) GetClaimsSupported() bool` + +GetClaimsSupported returns the ClaimsSupported field if non-nil, zero value otherwise. + +### GetClaimsSupportedOk + +`func (o *GetOAuthClientResponse) GetClaimsSupportedOk() (*bool, bool)` + +GetClaimsSupportedOk returns a tuple with the ClaimsSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClaimsSupported + +`func (o *GetOAuthClientResponse) SetClaimsSupported(v bool)` + +SetClaimsSupported sets ClaimsSupported field to given value. + + +### GetCreated + +`func (o *GetOAuthClientResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GetOAuthClientResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *GetOAuthClientResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *GetOAuthClientResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *GetOAuthClientResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *GetOAuthClientResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetSecret + +`func (o *GetOAuthClientResponse) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *GetOAuthClientResponse) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *GetOAuthClientResponse) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *GetOAuthClientResponse) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### SetSecretNil + +`func (o *GetOAuthClientResponse) SetSecretNil(b bool)` + + SetSecretNil sets the value for Secret to be an explicit nil + +### UnsetSecret +`func (o *GetOAuthClientResponse) UnsetSecret()` + +UnsetSecret ensures that no value is present for Secret, not even an explicit nil +### GetMetadata + +`func (o *GetOAuthClientResponse) GetMetadata() string` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetOAuthClientResponse) GetMetadataOk() (*string, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetOAuthClientResponse) SetMetadata(v string)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetOAuthClientResponse) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### SetMetadataNil + +`func (o *GetOAuthClientResponse) SetMetadataNil(b bool)` + + SetMetadataNil sets the value for Metadata to be an explicit nil + +### UnsetMetadata +`func (o *GetOAuthClientResponse) UnsetMetadata()` + +UnsetMetadata ensures that no value is present for Metadata, not even an explicit nil +### GetLastUsed + +`func (o *GetOAuthClientResponse) GetLastUsed() SailPointTime` + +GetLastUsed returns the LastUsed field if non-nil, zero value otherwise. + +### GetLastUsedOk + +`func (o *GetOAuthClientResponse) GetLastUsedOk() (*SailPointTime, bool)` + +GetLastUsedOk returns a tuple with the LastUsed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUsed + +`func (o *GetOAuthClientResponse) SetLastUsed(v SailPointTime)` + +SetLastUsed sets LastUsed field to given value. + +### HasLastUsed + +`func (o *GetOAuthClientResponse) HasLastUsed() bool` + +HasLastUsed returns a boolean if a field has been set. + +### SetLastUsedNil + +`func (o *GetOAuthClientResponse) SetLastUsedNil(b bool)` + + SetLastUsedNil sets the value for LastUsed to be an explicit nil + +### UnsetLastUsed +`func (o *GetOAuthClientResponse) UnsetLastUsed()` + +UnsetLastUsed ensures that no value is present for LastUsed, not even an explicit nil +### GetScope + +`func (o *GetOAuthClientResponse) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *GetOAuthClientResponse) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *GetOAuthClientResponse) SetScope(v []string)` + +SetScope sets Scope field to given value. + + +### SetScopeNil + +`func (o *GetOAuthClientResponse) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *GetOAuthClientResponse) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/GetPersonalAccessTokenResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/GetPersonalAccessTokenResponse.md new file mode 100644 index 000000000..fd7d7cd15 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/GetPersonalAccessTokenResponse.md @@ -0,0 +1,215 @@ +--- +id: beta-get-personal-access-token-response +title: GetPersonalAccessTokenResponse +pagination_label: GetPersonalAccessTokenResponse +sidebar_label: GetPersonalAccessTokenResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetPersonalAccessTokenResponse', 'BetaGetPersonalAccessTokenResponse'] +slug: /tools/sdk/go/beta/models/get-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'GetPersonalAccessTokenResponse', 'BetaGetPersonalAccessTokenResponse'] +--- + +# GetPersonalAccessTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The ID of the personal access token (to be used as the username for Basic Auth). | +**Name** | **string** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | +**Scope** | **[]string** | Scopes of the personal access token. | +**Owner** | [**PatOwner**](pat-owner) | | +**Created** | **SailPointTime** | The date and time, down to the millisecond, when this personal access token was created. | +**LastUsed** | Pointer to **NullableTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional] +**Managed** | Pointer to **bool** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to false] + +## Methods + +### NewGetPersonalAccessTokenResponse + +`func NewGetPersonalAccessTokenResponse(id string, name string, scope []string, owner PatOwner, created SailPointTime, ) *GetPersonalAccessTokenResponse` + +NewGetPersonalAccessTokenResponse instantiates a new GetPersonalAccessTokenResponse 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 + +### NewGetPersonalAccessTokenResponseWithDefaults + +`func NewGetPersonalAccessTokenResponseWithDefaults() *GetPersonalAccessTokenResponse` + +NewGetPersonalAccessTokenResponseWithDefaults instantiates a new GetPersonalAccessTokenResponse 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 + +### GetId + +`func (o *GetPersonalAccessTokenResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetPersonalAccessTokenResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetPersonalAccessTokenResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *GetPersonalAccessTokenResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetPersonalAccessTokenResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetPersonalAccessTokenResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetScope + +`func (o *GetPersonalAccessTokenResponse) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *GetPersonalAccessTokenResponse) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *GetPersonalAccessTokenResponse) SetScope(v []string)` + +SetScope sets Scope field to given value. + + +### SetScopeNil + +`func (o *GetPersonalAccessTokenResponse) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *GetPersonalAccessTokenResponse) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil +### GetOwner + +`func (o *GetPersonalAccessTokenResponse) GetOwner() PatOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *GetPersonalAccessTokenResponse) GetOwnerOk() (*PatOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *GetPersonalAccessTokenResponse) SetOwner(v PatOwner)` + +SetOwner sets Owner field to given value. + + +### GetCreated + +`func (o *GetPersonalAccessTokenResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GetPersonalAccessTokenResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *GetPersonalAccessTokenResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetLastUsed + +`func (o *GetPersonalAccessTokenResponse) GetLastUsed() SailPointTime` + +GetLastUsed returns the LastUsed field if non-nil, zero value otherwise. + +### GetLastUsedOk + +`func (o *GetPersonalAccessTokenResponse) GetLastUsedOk() (*SailPointTime, bool)` + +GetLastUsedOk returns a tuple with the LastUsed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUsed + +`func (o *GetPersonalAccessTokenResponse) SetLastUsed(v SailPointTime)` + +SetLastUsed sets LastUsed field to given value. + +### HasLastUsed + +`func (o *GetPersonalAccessTokenResponse) HasLastUsed() bool` + +HasLastUsed returns a boolean if a field has been set. + +### SetLastUsedNil + +`func (o *GetPersonalAccessTokenResponse) SetLastUsedNil(b bool)` + + SetLastUsedNil sets the value for LastUsed to be an explicit nil + +### UnsetLastUsed +`func (o *GetPersonalAccessTokenResponse) UnsetLastUsed()` + +UnsetLastUsed ensures that no value is present for LastUsed, not even an explicit nil +### GetManaged + +`func (o *GetPersonalAccessTokenResponse) GetManaged() bool` + +GetManaged returns the Managed field if non-nil, zero value otherwise. + +### GetManagedOk + +`func (o *GetPersonalAccessTokenResponse) GetManagedOk() (*bool, bool)` + +GetManagedOk returns a tuple with the Managed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManaged + +`func (o *GetPersonalAccessTokenResponse) SetManaged(v bool)` + +SetManaged sets Managed field to given value. + +### HasManaged + +`func (o *GetPersonalAccessTokenResponse) HasManaged() bool` + +HasManaged returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/GetRoleAssignments200ResponseInner.md b/docs/tools/sdk/go/Reference/Beta/Models/GetRoleAssignments200ResponseInner.md new file mode 100644 index 000000000..0d3464485 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/GetRoleAssignments200ResponseInner.md @@ -0,0 +1,272 @@ +--- +id: beta-get-role-assignments200-response-inner +title: GetRoleAssignments200ResponseInner +pagination_label: GetRoleAssignments200ResponseInner +sidebar_label: GetRoleAssignments200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetRoleAssignments200ResponseInner', 'BetaGetRoleAssignments200ResponseInner'] +slug: /tools/sdk/go/beta/models/get-role-assignments200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetRoleAssignments200ResponseInner', 'BetaGetRoleAssignments200ResponseInner'] +--- + +# GetRoleAssignments200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Assignment Id | [optional] +**Role** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**Comments** | Pointer to **string** | Comments added by the user when the assignment was made | [optional] +**AssignmentSource** | Pointer to **string** | Source describing how this assignment was made | [optional] +**Assigner** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**AssignedDimensions** | Pointer to [**[]BaseReferenceDto1**](base-reference-dto1) | Dimensions assigned related to this role | [optional] +**AssignmentContext** | Pointer to [**AssignmentContextDto**](assignment-context-dto) | | [optional] +**AccountTargets** | Pointer to [**[]RoleTargetDto**](role-target-dto) | | [optional] +**RemoveDate** | Pointer to **string** | Date that the assignment will be removed | [optional] + +## Methods + +### NewGetRoleAssignments200ResponseInner + +`func NewGetRoleAssignments200ResponseInner() *GetRoleAssignments200ResponseInner` + +NewGetRoleAssignments200ResponseInner instantiates a new GetRoleAssignments200ResponseInner 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 + +### NewGetRoleAssignments200ResponseInnerWithDefaults + +`func NewGetRoleAssignments200ResponseInnerWithDefaults() *GetRoleAssignments200ResponseInner` + +NewGetRoleAssignments200ResponseInnerWithDefaults instantiates a new GetRoleAssignments200ResponseInner 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 + +### GetId + +`func (o *GetRoleAssignments200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetRoleAssignments200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetRoleAssignments200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetRoleAssignments200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRole + +`func (o *GetRoleAssignments200ResponseInner) GetRole() BaseReferenceDto1` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *GetRoleAssignments200ResponseInner) GetRoleOk() (*BaseReferenceDto1, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *GetRoleAssignments200ResponseInner) SetRole(v BaseReferenceDto1)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *GetRoleAssignments200ResponseInner) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetComments + +`func (o *GetRoleAssignments200ResponseInner) GetComments() string` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *GetRoleAssignments200ResponseInner) GetCommentsOk() (*string, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *GetRoleAssignments200ResponseInner) SetComments(v string)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *GetRoleAssignments200ResponseInner) HasComments() bool` + +HasComments returns a boolean if a field has been set. + +### GetAssignmentSource + +`func (o *GetRoleAssignments200ResponseInner) GetAssignmentSource() string` + +GetAssignmentSource returns the AssignmentSource field if non-nil, zero value otherwise. + +### GetAssignmentSourceOk + +`func (o *GetRoleAssignments200ResponseInner) GetAssignmentSourceOk() (*string, bool)` + +GetAssignmentSourceOk returns a tuple with the AssignmentSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentSource + +`func (o *GetRoleAssignments200ResponseInner) SetAssignmentSource(v string)` + +SetAssignmentSource sets AssignmentSource field to given value. + +### HasAssignmentSource + +`func (o *GetRoleAssignments200ResponseInner) HasAssignmentSource() bool` + +HasAssignmentSource returns a boolean if a field has been set. + +### GetAssigner + +`func (o *GetRoleAssignments200ResponseInner) GetAssigner() BaseReferenceDto1` + +GetAssigner returns the Assigner field if non-nil, zero value otherwise. + +### GetAssignerOk + +`func (o *GetRoleAssignments200ResponseInner) GetAssignerOk() (*BaseReferenceDto1, bool)` + +GetAssignerOk returns a tuple with the Assigner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssigner + +`func (o *GetRoleAssignments200ResponseInner) SetAssigner(v BaseReferenceDto1)` + +SetAssigner sets Assigner field to given value. + +### HasAssigner + +`func (o *GetRoleAssignments200ResponseInner) HasAssigner() bool` + +HasAssigner returns a boolean if a field has been set. + +### GetAssignedDimensions + +`func (o *GetRoleAssignments200ResponseInner) GetAssignedDimensions() []BaseReferenceDto1` + +GetAssignedDimensions returns the AssignedDimensions field if non-nil, zero value otherwise. + +### GetAssignedDimensionsOk + +`func (o *GetRoleAssignments200ResponseInner) GetAssignedDimensionsOk() (*[]BaseReferenceDto1, bool)` + +GetAssignedDimensionsOk returns a tuple with the AssignedDimensions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignedDimensions + +`func (o *GetRoleAssignments200ResponseInner) SetAssignedDimensions(v []BaseReferenceDto1)` + +SetAssignedDimensions sets AssignedDimensions field to given value. + +### HasAssignedDimensions + +`func (o *GetRoleAssignments200ResponseInner) HasAssignedDimensions() bool` + +HasAssignedDimensions returns a boolean if a field has been set. + +### GetAssignmentContext + +`func (o *GetRoleAssignments200ResponseInner) GetAssignmentContext() AssignmentContextDto` + +GetAssignmentContext returns the AssignmentContext field if non-nil, zero value otherwise. + +### GetAssignmentContextOk + +`func (o *GetRoleAssignments200ResponseInner) GetAssignmentContextOk() (*AssignmentContextDto, bool)` + +GetAssignmentContextOk returns a tuple with the AssignmentContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentContext + +`func (o *GetRoleAssignments200ResponseInner) SetAssignmentContext(v AssignmentContextDto)` + +SetAssignmentContext sets AssignmentContext field to given value. + +### HasAssignmentContext + +`func (o *GetRoleAssignments200ResponseInner) HasAssignmentContext() bool` + +HasAssignmentContext returns a boolean if a field has been set. + +### GetAccountTargets + +`func (o *GetRoleAssignments200ResponseInner) GetAccountTargets() []RoleTargetDto` + +GetAccountTargets returns the AccountTargets field if non-nil, zero value otherwise. + +### GetAccountTargetsOk + +`func (o *GetRoleAssignments200ResponseInner) GetAccountTargetsOk() (*[]RoleTargetDto, bool)` + +GetAccountTargetsOk returns a tuple with the AccountTargets field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountTargets + +`func (o *GetRoleAssignments200ResponseInner) SetAccountTargets(v []RoleTargetDto)` + +SetAccountTargets sets AccountTargets field to given value. + +### HasAccountTargets + +`func (o *GetRoleAssignments200ResponseInner) HasAccountTargets() bool` + +HasAccountTargets returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *GetRoleAssignments200ResponseInner) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *GetRoleAssignments200ResponseInner) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *GetRoleAssignments200ResponseInner) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *GetRoleAssignments200ResponseInner) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/GrantType.md b/docs/tools/sdk/go/Reference/Beta/Models/GrantType.md new file mode 100644 index 000000000..fac9efeee --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/GrantType.md @@ -0,0 +1,23 @@ +--- +id: beta-grant-type +title: GrantType +pagination_label: GrantType +sidebar_label: GrantType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GrantType', 'BetaGrantType'] +slug: /tools/sdk/go/beta/models/grant-type +tags: ['SDK', 'Software Development Kit', 'GrantType', 'BetaGrantType'] +--- + +# GrantType + +## Enum + + +* `CLIENT_CREDENTIALS` (value: `"CLIENT_CREDENTIALS"`) + +* `AUTHORIZATION_CODE` (value: `"AUTHORIZATION_CODE"`) + +* `REFRESH_TOKEN` (value: `"REFRESH_TOKEN"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/HttpAuthenticationType.md b/docs/tools/sdk/go/Reference/Beta/Models/HttpAuthenticationType.md new file mode 100644 index 000000000..688e4de31 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/HttpAuthenticationType.md @@ -0,0 +1,23 @@ +--- +id: beta-http-authentication-type +title: HttpAuthenticationType +pagination_label: HttpAuthenticationType +sidebar_label: HttpAuthenticationType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'HttpAuthenticationType', 'BetaHttpAuthenticationType'] +slug: /tools/sdk/go/beta/models/http-authentication-type +tags: ['SDK', 'Software Development Kit', 'HttpAuthenticationType', 'BetaHttpAuthenticationType'] +--- + +# HttpAuthenticationType + +## Enum + + +* `NO_AUTH` (value: `"NO_AUTH"`) + +* `BASIC_AUTH` (value: `"BASIC_AUTH"`) + +* `BEARER_TOKEN` (value: `"BEARER_TOKEN"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/HttpConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/HttpConfig.md new file mode 100644 index 000000000..224eb022e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/HttpConfig.md @@ -0,0 +1,178 @@ +--- +id: beta-http-config +title: HttpConfig +pagination_label: HttpConfig +sidebar_label: HttpConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'HttpConfig', 'BetaHttpConfig'] +slug: /tools/sdk/go/beta/models/http-config +tags: ['SDK', 'Software Development Kit', 'HttpConfig', 'BetaHttpConfig'] +--- + +# HttpConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Url** | **string** | URL of the external/custom integration. | +**HttpDispatchMode** | [**HttpDispatchMode**](http-dispatch-mode) | | +**HttpAuthenticationType** | Pointer to [**HttpAuthenticationType**](http-authentication-type) | | [optional] [default to HTTPAUTHENTICATIONTYPE_NO_AUTH] +**BasicAuthConfig** | Pointer to [**NullableBasicAuthConfig**](basic-auth-config) | | [optional] +**BearerTokenAuthConfig** | Pointer to [**NullableBearerTokenAuthConfig**](bearer-token-auth-config) | | [optional] + +## Methods + +### NewHttpConfig + +`func NewHttpConfig(url string, httpDispatchMode HttpDispatchMode, ) *HttpConfig` + +NewHttpConfig instantiates a new HttpConfig 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 + +### NewHttpConfigWithDefaults + +`func NewHttpConfigWithDefaults() *HttpConfig` + +NewHttpConfigWithDefaults instantiates a new HttpConfig 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 + +### GetUrl + +`func (o *HttpConfig) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *HttpConfig) GetUrlOk() (*string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrl + +`func (o *HttpConfig) SetUrl(v string)` + +SetUrl sets Url field to given value. + + +### GetHttpDispatchMode + +`func (o *HttpConfig) GetHttpDispatchMode() HttpDispatchMode` + +GetHttpDispatchMode returns the HttpDispatchMode field if non-nil, zero value otherwise. + +### GetHttpDispatchModeOk + +`func (o *HttpConfig) GetHttpDispatchModeOk() (*HttpDispatchMode, bool)` + +GetHttpDispatchModeOk returns a tuple with the HttpDispatchMode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHttpDispatchMode + +`func (o *HttpConfig) SetHttpDispatchMode(v HttpDispatchMode)` + +SetHttpDispatchMode sets HttpDispatchMode field to given value. + + +### GetHttpAuthenticationType + +`func (o *HttpConfig) GetHttpAuthenticationType() HttpAuthenticationType` + +GetHttpAuthenticationType returns the HttpAuthenticationType field if non-nil, zero value otherwise. + +### GetHttpAuthenticationTypeOk + +`func (o *HttpConfig) GetHttpAuthenticationTypeOk() (*HttpAuthenticationType, bool)` + +GetHttpAuthenticationTypeOk returns a tuple with the HttpAuthenticationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHttpAuthenticationType + +`func (o *HttpConfig) SetHttpAuthenticationType(v HttpAuthenticationType)` + +SetHttpAuthenticationType sets HttpAuthenticationType field to given value. + +### HasHttpAuthenticationType + +`func (o *HttpConfig) HasHttpAuthenticationType() bool` + +HasHttpAuthenticationType returns a boolean if a field has been set. + +### GetBasicAuthConfig + +`func (o *HttpConfig) GetBasicAuthConfig() BasicAuthConfig` + +GetBasicAuthConfig returns the BasicAuthConfig field if non-nil, zero value otherwise. + +### GetBasicAuthConfigOk + +`func (o *HttpConfig) GetBasicAuthConfigOk() (*BasicAuthConfig, bool)` + +GetBasicAuthConfigOk returns a tuple with the BasicAuthConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBasicAuthConfig + +`func (o *HttpConfig) SetBasicAuthConfig(v BasicAuthConfig)` + +SetBasicAuthConfig sets BasicAuthConfig field to given value. + +### HasBasicAuthConfig + +`func (o *HttpConfig) HasBasicAuthConfig() bool` + +HasBasicAuthConfig returns a boolean if a field has been set. + +### SetBasicAuthConfigNil + +`func (o *HttpConfig) SetBasicAuthConfigNil(b bool)` + + SetBasicAuthConfigNil sets the value for BasicAuthConfig to be an explicit nil + +### UnsetBasicAuthConfig +`func (o *HttpConfig) UnsetBasicAuthConfig()` + +UnsetBasicAuthConfig ensures that no value is present for BasicAuthConfig, not even an explicit nil +### GetBearerTokenAuthConfig + +`func (o *HttpConfig) GetBearerTokenAuthConfig() BearerTokenAuthConfig` + +GetBearerTokenAuthConfig returns the BearerTokenAuthConfig field if non-nil, zero value otherwise. + +### GetBearerTokenAuthConfigOk + +`func (o *HttpConfig) GetBearerTokenAuthConfigOk() (*BearerTokenAuthConfig, bool)` + +GetBearerTokenAuthConfigOk returns a tuple with the BearerTokenAuthConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBearerTokenAuthConfig + +`func (o *HttpConfig) SetBearerTokenAuthConfig(v BearerTokenAuthConfig)` + +SetBearerTokenAuthConfig sets BearerTokenAuthConfig field to given value. + +### HasBearerTokenAuthConfig + +`func (o *HttpConfig) HasBearerTokenAuthConfig() bool` + +HasBearerTokenAuthConfig returns a boolean if a field has been set. + +### SetBearerTokenAuthConfigNil + +`func (o *HttpConfig) SetBearerTokenAuthConfigNil(b bool)` + + SetBearerTokenAuthConfigNil sets the value for BearerTokenAuthConfig to be an explicit nil + +### UnsetBearerTokenAuthConfig +`func (o *HttpConfig) UnsetBearerTokenAuthConfig()` + +UnsetBearerTokenAuthConfig ensures that no value is present for BearerTokenAuthConfig, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/HttpDispatchMode.md b/docs/tools/sdk/go/Reference/Beta/Models/HttpDispatchMode.md new file mode 100644 index 000000000..ad9a6b829 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/HttpDispatchMode.md @@ -0,0 +1,23 @@ +--- +id: beta-http-dispatch-mode +title: HttpDispatchMode +pagination_label: HttpDispatchMode +sidebar_label: HttpDispatchMode +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'HttpDispatchMode', 'BetaHttpDispatchMode'] +slug: /tools/sdk/go/beta/models/http-dispatch-mode +tags: ['SDK', 'Software Development Kit', 'HttpDispatchMode', 'BetaHttpDispatchMode'] +--- + +# HttpDispatchMode + +## Enum + + +* `SYNC` (value: `"SYNC"`) + +* `ASYNC` (value: `"ASYNC"`) + +* `DYNAMIC` (value: `"DYNAMIC"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentitiesAccountsBulkRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentitiesAccountsBulkRequest.md new file mode 100644 index 000000000..5d5582316 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentitiesAccountsBulkRequest.md @@ -0,0 +1,64 @@ +--- +id: beta-identities-accounts-bulk-request +title: IdentitiesAccountsBulkRequest +pagination_label: IdentitiesAccountsBulkRequest +sidebar_label: IdentitiesAccountsBulkRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitiesAccountsBulkRequest', 'BetaIdentitiesAccountsBulkRequest'] +slug: /tools/sdk/go/beta/models/identities-accounts-bulk-request +tags: ['SDK', 'Software Development Kit', 'IdentitiesAccountsBulkRequest', 'BetaIdentitiesAccountsBulkRequest'] +--- + +# IdentitiesAccountsBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityIds** | Pointer to **[]string** | The ids of the identities for which enable/disable accounts. | [optional] + +## Methods + +### NewIdentitiesAccountsBulkRequest + +`func NewIdentitiesAccountsBulkRequest() *IdentitiesAccountsBulkRequest` + +NewIdentitiesAccountsBulkRequest instantiates a new IdentitiesAccountsBulkRequest 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 + +### NewIdentitiesAccountsBulkRequestWithDefaults + +`func NewIdentitiesAccountsBulkRequestWithDefaults() *IdentitiesAccountsBulkRequest` + +NewIdentitiesAccountsBulkRequestWithDefaults instantiates a new IdentitiesAccountsBulkRequest 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 + +### GetIdentityIds + +`func (o *IdentitiesAccountsBulkRequest) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *IdentitiesAccountsBulkRequest) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *IdentitiesAccountsBulkRequest) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *IdentitiesAccountsBulkRequest) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Identity.md b/docs/tools/sdk/go/Reference/Beta/Models/Identity.md new file mode 100644 index 000000000..011617ef8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Identity.md @@ -0,0 +1,401 @@ +--- +id: beta-identity +title: Identity +pagination_label: Identity +sidebar_label: Identity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Identity', 'BetaIdentity'] +slug: /tools/sdk/go/beta/models/identity +tags: ['SDK', 'Software Development Kit', 'Identity', 'BetaIdentity'] +--- + +# Identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the identity | [optional] [readonly] +**Name** | **string** | The identity's name is equivalent to its Display Name attribute. | +**Created** | Pointer to **SailPointTime** | Creation date of the identity | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the identity | [optional] [readonly] +**Alias** | Pointer to **string** | The identity's alternate unique identifier is equivalent to its Account Name on the authoritative source account schema. | [optional] +**EmailAddress** | Pointer to **NullableString** | The email address of the identity | [optional] +**ProcessingState** | Pointer to **NullableString** | The processing state of the identity | [optional] +**IdentityStatus** | Pointer to **string** | The identity's status in the system | [optional] +**ManagerRef** | Pointer to [**NullableIdentityManagerRef**](identity-manager-ref) | | [optional] +**IsManager** | Pointer to **bool** | Whether this identity is a manager of another identity | [optional] [default to false] +**LastRefresh** | Pointer to **SailPointTime** | The last time the identity was refreshed by the system | [optional] +**Attributes** | Pointer to **map[string]interface{}** | A map with the identity attributes for the identity | [optional] +**LifecycleState** | Pointer to [**IdentityLifecycleState**](identity-lifecycle-state) | | [optional] + +## Methods + +### NewIdentity + +`func NewIdentity(name string, ) *Identity` + +NewIdentity instantiates a new Identity 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 + +### NewIdentityWithDefaults + +`func NewIdentityWithDefaults() *Identity` + +NewIdentityWithDefaults instantiates a new Identity 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 + +### GetId + +`func (o *Identity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Identity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Identity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Identity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Identity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Identity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Identity) SetName(v string)` + +SetName sets Name field to given value. + + +### GetCreated + +`func (o *Identity) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Identity) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Identity) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Identity) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Identity) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Identity) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Identity) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Identity) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetAlias + +`func (o *Identity) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *Identity) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *Identity) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *Identity) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + +### GetEmailAddress + +`func (o *Identity) GetEmailAddress() string` + +GetEmailAddress returns the EmailAddress field if non-nil, zero value otherwise. + +### GetEmailAddressOk + +`func (o *Identity) GetEmailAddressOk() (*string, bool)` + +GetEmailAddressOk returns a tuple with the EmailAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailAddress + +`func (o *Identity) SetEmailAddress(v string)` + +SetEmailAddress sets EmailAddress field to given value. + +### HasEmailAddress + +`func (o *Identity) HasEmailAddress() bool` + +HasEmailAddress returns a boolean if a field has been set. + +### SetEmailAddressNil + +`func (o *Identity) SetEmailAddressNil(b bool)` + + SetEmailAddressNil sets the value for EmailAddress to be an explicit nil + +### UnsetEmailAddress +`func (o *Identity) UnsetEmailAddress()` + +UnsetEmailAddress ensures that no value is present for EmailAddress, not even an explicit nil +### GetProcessingState + +`func (o *Identity) GetProcessingState() string` + +GetProcessingState returns the ProcessingState field if non-nil, zero value otherwise. + +### GetProcessingStateOk + +`func (o *Identity) GetProcessingStateOk() (*string, bool)` + +GetProcessingStateOk returns a tuple with the ProcessingState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessingState + +`func (o *Identity) SetProcessingState(v string)` + +SetProcessingState sets ProcessingState field to given value. + +### HasProcessingState + +`func (o *Identity) HasProcessingState() bool` + +HasProcessingState returns a boolean if a field has been set. + +### SetProcessingStateNil + +`func (o *Identity) SetProcessingStateNil(b bool)` + + SetProcessingStateNil sets the value for ProcessingState to be an explicit nil + +### UnsetProcessingState +`func (o *Identity) UnsetProcessingState()` + +UnsetProcessingState ensures that no value is present for ProcessingState, not even an explicit nil +### GetIdentityStatus + +`func (o *Identity) GetIdentityStatus() string` + +GetIdentityStatus returns the IdentityStatus field if non-nil, zero value otherwise. + +### GetIdentityStatusOk + +`func (o *Identity) GetIdentityStatusOk() (*string, bool)` + +GetIdentityStatusOk returns a tuple with the IdentityStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityStatus + +`func (o *Identity) SetIdentityStatus(v string)` + +SetIdentityStatus sets IdentityStatus field to given value. + +### HasIdentityStatus + +`func (o *Identity) HasIdentityStatus() bool` + +HasIdentityStatus returns a boolean if a field has been set. + +### GetManagerRef + +`func (o *Identity) GetManagerRef() IdentityManagerRef` + +GetManagerRef returns the ManagerRef field if non-nil, zero value otherwise. + +### GetManagerRefOk + +`func (o *Identity) GetManagerRefOk() (*IdentityManagerRef, bool)` + +GetManagerRefOk returns a tuple with the ManagerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerRef + +`func (o *Identity) SetManagerRef(v IdentityManagerRef)` + +SetManagerRef sets ManagerRef field to given value. + +### HasManagerRef + +`func (o *Identity) HasManagerRef() bool` + +HasManagerRef returns a boolean if a field has been set. + +### SetManagerRefNil + +`func (o *Identity) SetManagerRefNil(b bool)` + + SetManagerRefNil sets the value for ManagerRef to be an explicit nil + +### UnsetManagerRef +`func (o *Identity) UnsetManagerRef()` + +UnsetManagerRef ensures that no value is present for ManagerRef, not even an explicit nil +### GetIsManager + +`func (o *Identity) GetIsManager() bool` + +GetIsManager returns the IsManager field if non-nil, zero value otherwise. + +### GetIsManagerOk + +`func (o *Identity) GetIsManagerOk() (*bool, bool)` + +GetIsManagerOk returns a tuple with the IsManager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsManager + +`func (o *Identity) SetIsManager(v bool)` + +SetIsManager sets IsManager field to given value. + +### HasIsManager + +`func (o *Identity) HasIsManager() bool` + +HasIsManager returns a boolean if a field has been set. + +### GetLastRefresh + +`func (o *Identity) GetLastRefresh() SailPointTime` + +GetLastRefresh returns the LastRefresh field if non-nil, zero value otherwise. + +### GetLastRefreshOk + +`func (o *Identity) GetLastRefreshOk() (*SailPointTime, bool)` + +GetLastRefreshOk returns a tuple with the LastRefresh field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastRefresh + +`func (o *Identity) SetLastRefresh(v SailPointTime)` + +SetLastRefresh sets LastRefresh field to given value. + +### HasLastRefresh + +`func (o *Identity) HasLastRefresh() bool` + +HasLastRefresh returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Identity) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Identity) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Identity) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Identity) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetLifecycleState + +`func (o *Identity) GetLifecycleState() IdentityLifecycleState` + +GetLifecycleState returns the LifecycleState field if non-nil, zero value otherwise. + +### GetLifecycleStateOk + +`func (o *Identity) GetLifecycleStateOk() (*IdentityLifecycleState, bool)` + +GetLifecycleStateOk returns a tuple with the LifecycleState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLifecycleState + +`func (o *Identity) SetLifecycleState(v IdentityLifecycleState)` + +SetLifecycleState sets LifecycleState field to given value. + +### HasLifecycleState + +`func (o *Identity) HasLifecycleState() bool` + +HasLifecycleState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Identity1.md b/docs/tools/sdk/go/Reference/Beta/Models/Identity1.md new file mode 100644 index 000000000..db3a43278 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Identity1.md @@ -0,0 +1,90 @@ +--- +id: beta-identity1 +title: Identity1 +pagination_label: Identity1 +sidebar_label: Identity1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Identity1', 'BetaIdentity1'] +slug: /tools/sdk/go/beta/models/identity1 +tags: ['SDK', 'Software Development Kit', 'Identity1', 'BetaIdentity1'] +--- + +# Identity1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the object | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object | [optional] + +## Methods + +### NewIdentity1 + +`func NewIdentity1() *Identity1` + +NewIdentity1 instantiates a new Identity1 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 + +### NewIdentity1WithDefaults + +`func NewIdentity1WithDefaults() *Identity1` + +NewIdentity1WithDefaults instantiates a new Identity1 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 + +### GetId + +`func (o *Identity1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Identity1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Identity1) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Identity1) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Identity1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Identity1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Identity1) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Identity1) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityAssociationDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAssociationDetails.md new file mode 100644 index 000000000..1726bac02 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAssociationDetails.md @@ -0,0 +1,90 @@ +--- +id: beta-identity-association-details +title: IdentityAssociationDetails +pagination_label: IdentityAssociationDetails +sidebar_label: IdentityAssociationDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAssociationDetails', 'BetaIdentityAssociationDetails'] +slug: /tools/sdk/go/beta/models/identity-association-details +tags: ['SDK', 'Software Development Kit', 'IdentityAssociationDetails', 'BetaIdentityAssociationDetails'] +--- + +# IdentityAssociationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **string** | any additional context information of the http call result | [optional] +**AssociationDetails** | Pointer to [**[]IdentityAssociationDetailsAssociationDetailsInner**](identity-association-details-association-details-inner) | list of all the resource associations for the identity | [optional] + +## Methods + +### NewIdentityAssociationDetails + +`func NewIdentityAssociationDetails() *IdentityAssociationDetails` + +NewIdentityAssociationDetails instantiates a new IdentityAssociationDetails 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 + +### NewIdentityAssociationDetailsWithDefaults + +`func NewIdentityAssociationDetailsWithDefaults() *IdentityAssociationDetails` + +NewIdentityAssociationDetailsWithDefaults instantiates a new IdentityAssociationDetails 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 + +### GetMessage + +`func (o *IdentityAssociationDetails) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *IdentityAssociationDetails) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *IdentityAssociationDetails) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *IdentityAssociationDetails) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetAssociationDetails + +`func (o *IdentityAssociationDetails) GetAssociationDetails() []IdentityAssociationDetailsAssociationDetailsInner` + +GetAssociationDetails returns the AssociationDetails field if non-nil, zero value otherwise. + +### GetAssociationDetailsOk + +`func (o *IdentityAssociationDetails) GetAssociationDetailsOk() (*[]IdentityAssociationDetailsAssociationDetailsInner, bool)` + +GetAssociationDetailsOk returns a tuple with the AssociationDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociationDetails + +`func (o *IdentityAssociationDetails) SetAssociationDetails(v []IdentityAssociationDetailsAssociationDetailsInner)` + +SetAssociationDetails sets AssociationDetails field to given value. + +### HasAssociationDetails + +`func (o *IdentityAssociationDetails) HasAssociationDetails() bool` + +HasAssociationDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAssociationDetailsAssociationDetailsInner.md new file mode 100644 index 000000000..cf8ba8747 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAssociationDetailsAssociationDetailsInner.md @@ -0,0 +1,90 @@ +--- +id: beta-identity-association-details-association-details-inner +title: IdentityAssociationDetailsAssociationDetailsInner +pagination_label: IdentityAssociationDetailsAssociationDetailsInner +sidebar_label: IdentityAssociationDetailsAssociationDetailsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAssociationDetailsAssociationDetailsInner', 'BetaIdentityAssociationDetailsAssociationDetailsInner'] +slug: /tools/sdk/go/beta/models/identity-association-details-association-details-inner +tags: ['SDK', 'Software Development Kit', 'IdentityAssociationDetailsAssociationDetailsInner', 'BetaIdentityAssociationDetailsAssociationDetailsInner'] +--- + +# IdentityAssociationDetailsAssociationDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssociationType** | Pointer to **string** | association type with the identity | [optional] +**Entities** | Pointer to [**[]IdentityEntities**](identity-entities) | the specific resource this identity has ownership on | [optional] + +## Methods + +### NewIdentityAssociationDetailsAssociationDetailsInner + +`func NewIdentityAssociationDetailsAssociationDetailsInner() *IdentityAssociationDetailsAssociationDetailsInner` + +NewIdentityAssociationDetailsAssociationDetailsInner instantiates a new IdentityAssociationDetailsAssociationDetailsInner 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 + +### NewIdentityAssociationDetailsAssociationDetailsInnerWithDefaults + +`func NewIdentityAssociationDetailsAssociationDetailsInnerWithDefaults() *IdentityAssociationDetailsAssociationDetailsInner` + +NewIdentityAssociationDetailsAssociationDetailsInnerWithDefaults instantiates a new IdentityAssociationDetailsAssociationDetailsInner 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 + +### GetAssociationType + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) GetAssociationType() string` + +GetAssociationType returns the AssociationType field if non-nil, zero value otherwise. + +### GetAssociationTypeOk + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) GetAssociationTypeOk() (*string, bool)` + +GetAssociationTypeOk returns a tuple with the AssociationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociationType + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) SetAssociationType(v string)` + +SetAssociationType sets AssociationType field to given value. + +### HasAssociationType + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) HasAssociationType() bool` + +HasAssociationType returns a boolean if a field has been set. + +### GetEntities + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) GetEntities() []IdentityEntities` + +GetEntities returns the Entities field if non-nil, zero value otherwise. + +### GetEntitiesOk + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) GetEntitiesOk() (*[]IdentityEntities, bool)` + +GetEntitiesOk returns a tuple with the Entities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntities + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) SetEntities(v []IdentityEntities)` + +SetEntities sets Entities field to given value. + +### HasEntities + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) HasEntities() bool` + +HasEntities returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttribute.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttribute.md new file mode 100644 index 000000000..ec093c87d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttribute.md @@ -0,0 +1,251 @@ +--- +id: beta-identity-attribute +title: IdentityAttribute +pagination_label: IdentityAttribute +sidebar_label: IdentityAttribute +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttribute', 'BetaIdentityAttribute'] +slug: /tools/sdk/go/beta/models/identity-attribute +tags: ['SDK', 'Software Development Kit', 'IdentityAttribute', 'BetaIdentityAttribute'] +--- + +# IdentityAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Identity attribute's technical name. | +**DisplayName** | Pointer to **string** | Identity attribute's business-friendly name. | [optional] +**Standard** | Pointer to **bool** | Indicates whether the attribute is 'standard' or 'default'. | [optional] [default to false] +**Type** | Pointer to **NullableString** | Identity attribute's type. | [optional] +**Multi** | Pointer to **bool** | Indicates whether the identity attribute is multi-valued. | [optional] [default to false] +**Searchable** | Pointer to **bool** | Indicates whether the identity attribute is searchable. | [optional] [default to false] +**System** | Pointer to **bool** | Indicates whether the identity attribute is 'system', meaning that it doesn't have a source and isn't configurable. | [optional] [default to false] +**Sources** | Pointer to [**[]Source1**](source1) | Identity attribute's list of sources - this specifies how the rule's value is derived. | [optional] + +## Methods + +### NewIdentityAttribute + +`func NewIdentityAttribute(name string, ) *IdentityAttribute` + +NewIdentityAttribute instantiates a new IdentityAttribute 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 + +### NewIdentityAttributeWithDefaults + +`func NewIdentityAttributeWithDefaults() *IdentityAttribute` + +NewIdentityAttributeWithDefaults instantiates a new IdentityAttribute 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 + +### GetName + +`func (o *IdentityAttribute) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityAttribute) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityAttribute) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDisplayName + +`func (o *IdentityAttribute) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityAttribute) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityAttribute) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityAttribute) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetStandard + +`func (o *IdentityAttribute) GetStandard() bool` + +GetStandard returns the Standard field if non-nil, zero value otherwise. + +### GetStandardOk + +`func (o *IdentityAttribute) GetStandardOk() (*bool, bool)` + +GetStandardOk returns a tuple with the Standard field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandard + +`func (o *IdentityAttribute) SetStandard(v bool)` + +SetStandard sets Standard field to given value. + +### HasStandard + +`func (o *IdentityAttribute) HasStandard() bool` + +HasStandard returns a boolean if a field has been set. + +### GetType + +`func (o *IdentityAttribute) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityAttribute) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityAttribute) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityAttribute) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *IdentityAttribute) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *IdentityAttribute) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetMulti + +`func (o *IdentityAttribute) GetMulti() bool` + +GetMulti returns the Multi field if non-nil, zero value otherwise. + +### GetMultiOk + +`func (o *IdentityAttribute) GetMultiOk() (*bool, bool)` + +GetMultiOk returns a tuple with the Multi field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMulti + +`func (o *IdentityAttribute) SetMulti(v bool)` + +SetMulti sets Multi field to given value. + +### HasMulti + +`func (o *IdentityAttribute) HasMulti() bool` + +HasMulti returns a boolean if a field has been set. + +### GetSearchable + +`func (o *IdentityAttribute) GetSearchable() bool` + +GetSearchable returns the Searchable field if non-nil, zero value otherwise. + +### GetSearchableOk + +`func (o *IdentityAttribute) GetSearchableOk() (*bool, bool)` + +GetSearchableOk returns a tuple with the Searchable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchable + +`func (o *IdentityAttribute) SetSearchable(v bool)` + +SetSearchable sets Searchable field to given value. + +### HasSearchable + +`func (o *IdentityAttribute) HasSearchable() bool` + +HasSearchable returns a boolean if a field has been set. + +### GetSystem + +`func (o *IdentityAttribute) GetSystem() bool` + +GetSystem returns the System field if non-nil, zero value otherwise. + +### GetSystemOk + +`func (o *IdentityAttribute) GetSystemOk() (*bool, bool)` + +GetSystemOk returns a tuple with the System field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSystem + +`func (o *IdentityAttribute) SetSystem(v bool)` + +SetSystem sets System field to given value. + +### HasSystem + +`func (o *IdentityAttribute) HasSystem() bool` + +HasSystem returns a boolean if a field has been set. + +### GetSources + +`func (o *IdentityAttribute) GetSources() []Source1` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *IdentityAttribute) GetSourcesOk() (*[]Source1, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *IdentityAttribute) SetSources(v []Source1)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *IdentityAttribute) HasSources() bool` + +HasSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributeConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributeConfig.md new file mode 100644 index 000000000..02cd09da9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributeConfig.md @@ -0,0 +1,90 @@ +--- +id: beta-identity-attribute-config +title: IdentityAttributeConfig +pagination_label: IdentityAttributeConfig +sidebar_label: IdentityAttributeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributeConfig', 'BetaIdentityAttributeConfig'] +slug: /tools/sdk/go/beta/models/identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'BetaIdentityAttributeConfig'] +--- + +# IdentityAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to true] +**AttributeTransforms** | Pointer to [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] + +## Methods + +### NewIdentityAttributeConfig + +`func NewIdentityAttributeConfig() *IdentityAttributeConfig` + +NewIdentityAttributeConfig instantiates a new IdentityAttributeConfig 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 + +### NewIdentityAttributeConfigWithDefaults + +`func NewIdentityAttributeConfigWithDefaults() *IdentityAttributeConfig` + +NewIdentityAttributeConfigWithDefaults instantiates a new IdentityAttributeConfig 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 + +### GetEnabled + +`func (o *IdentityAttributeConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *IdentityAttributeConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *IdentityAttributeConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *IdentityAttributeConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetAttributeTransforms + +`func (o *IdentityAttributeConfig) GetAttributeTransforms() []IdentityAttributeTransform` + +GetAttributeTransforms returns the AttributeTransforms field if non-nil, zero value otherwise. + +### GetAttributeTransformsOk + +`func (o *IdentityAttributeConfig) GetAttributeTransformsOk() (*[]IdentityAttributeTransform, bool)` + +GetAttributeTransformsOk returns a tuple with the AttributeTransforms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeTransforms + +`func (o *IdentityAttributeConfig) SetAttributeTransforms(v []IdentityAttributeTransform)` + +SetAttributeTransforms sets AttributeTransforms field to given value. + +### HasAttributeTransforms + +`func (o *IdentityAttributeConfig) HasAttributeTransforms() bool` + +HasAttributeTransforms returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributeConfig1.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributeConfig1.md new file mode 100644 index 000000000..62a195898 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributeConfig1.md @@ -0,0 +1,90 @@ +--- +id: beta-identity-attribute-config1 +title: IdentityAttributeConfig1 +pagination_label: IdentityAttributeConfig1 +sidebar_label: IdentityAttributeConfig1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributeConfig1', 'BetaIdentityAttributeConfig1'] +slug: /tools/sdk/go/beta/models/identity-attribute-config1 +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig1', 'BetaIdentityAttributeConfig1'] +--- + +# IdentityAttributeConfig1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to false] +**AttributeTransforms** | Pointer to [**[]IdentityAttributeTransform1**](identity-attribute-transform1) | | [optional] + +## Methods + +### NewIdentityAttributeConfig1 + +`func NewIdentityAttributeConfig1() *IdentityAttributeConfig1` + +NewIdentityAttributeConfig1 instantiates a new IdentityAttributeConfig1 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 + +### NewIdentityAttributeConfig1WithDefaults + +`func NewIdentityAttributeConfig1WithDefaults() *IdentityAttributeConfig1` + +NewIdentityAttributeConfig1WithDefaults instantiates a new IdentityAttributeConfig1 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 + +### GetEnabled + +`func (o *IdentityAttributeConfig1) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *IdentityAttributeConfig1) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *IdentityAttributeConfig1) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *IdentityAttributeConfig1) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetAttributeTransforms + +`func (o *IdentityAttributeConfig1) GetAttributeTransforms() []IdentityAttributeTransform1` + +GetAttributeTransforms returns the AttributeTransforms field if non-nil, zero value otherwise. + +### GetAttributeTransformsOk + +`func (o *IdentityAttributeConfig1) GetAttributeTransformsOk() (*[]IdentityAttributeTransform1, bool)` + +GetAttributeTransformsOk returns a tuple with the AttributeTransforms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeTransforms + +`func (o *IdentityAttributeConfig1) SetAttributeTransforms(v []IdentityAttributeTransform1)` + +SetAttributeTransforms sets AttributeTransforms field to given value. + +### HasAttributeTransforms + +`func (o *IdentityAttributeConfig1) HasAttributeTransforms() bool` + +HasAttributeTransforms returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributeNames.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributeNames.md new file mode 100644 index 000000000..1ec448b4d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributeNames.md @@ -0,0 +1,64 @@ +--- +id: beta-identity-attribute-names +title: IdentityAttributeNames +pagination_label: IdentityAttributeNames +sidebar_label: IdentityAttributeNames +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributeNames', 'BetaIdentityAttributeNames'] +slug: /tools/sdk/go/beta/models/identity-attribute-names +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeNames', 'BetaIdentityAttributeNames'] +--- + +# IdentityAttributeNames + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]string** | List of identity attributes' technical names. | [optional] + +## Methods + +### NewIdentityAttributeNames + +`func NewIdentityAttributeNames() *IdentityAttributeNames` + +NewIdentityAttributeNames instantiates a new IdentityAttributeNames 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 + +### NewIdentityAttributeNamesWithDefaults + +`func NewIdentityAttributeNamesWithDefaults() *IdentityAttributeNames` + +NewIdentityAttributeNamesWithDefaults instantiates a new IdentityAttributeNames 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 + +### GetIds + +`func (o *IdentityAttributeNames) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *IdentityAttributeNames) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *IdentityAttributeNames) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *IdentityAttributeNames) HasIds() bool` + +HasIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributePreview.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributePreview.md new file mode 100644 index 000000000..a33fee68a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributePreview.md @@ -0,0 +1,142 @@ +--- +id: beta-identity-attribute-preview +title: IdentityAttributePreview +pagination_label: IdentityAttributePreview +sidebar_label: IdentityAttributePreview +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributePreview', 'BetaIdentityAttributePreview'] +slug: /tools/sdk/go/beta/models/identity-attribute-preview +tags: ['SDK', 'Software Development Kit', 'IdentityAttributePreview', 'BetaIdentityAttributePreview'] +--- + +# IdentityAttributePreview + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the attribute that is being previewed. | [optional] +**Value** | Pointer to **string** | Value that was derived during the preview. | [optional] +**PreviousValue** | Pointer to **string** | The value of the attribute before the preview. | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] + +## Methods + +### NewIdentityAttributePreview + +`func NewIdentityAttributePreview() *IdentityAttributePreview` + +NewIdentityAttributePreview instantiates a new IdentityAttributePreview 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 + +### NewIdentityAttributePreviewWithDefaults + +`func NewIdentityAttributePreviewWithDefaults() *IdentityAttributePreview` + +NewIdentityAttributePreviewWithDefaults instantiates a new IdentityAttributePreview 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 + +### GetName + +`func (o *IdentityAttributePreview) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityAttributePreview) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityAttributePreview) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityAttributePreview) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValue + +`func (o *IdentityAttributePreview) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *IdentityAttributePreview) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *IdentityAttributePreview) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *IdentityAttributePreview) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetPreviousValue + +`func (o *IdentityAttributePreview) GetPreviousValue() string` + +GetPreviousValue returns the PreviousValue field if non-nil, zero value otherwise. + +### GetPreviousValueOk + +`func (o *IdentityAttributePreview) GetPreviousValueOk() (*string, bool)` + +GetPreviousValueOk returns a tuple with the PreviousValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousValue + +`func (o *IdentityAttributePreview) SetPreviousValue(v string)` + +SetPreviousValue sets PreviousValue field to given value. + +### HasPreviousValue + +`func (o *IdentityAttributePreview) HasPreviousValue() bool` + +HasPreviousValue returns a boolean if a field has been set. + +### GetErrorMessages + +`func (o *IdentityAttributePreview) GetErrorMessages() []ErrorMessageDto` + +GetErrorMessages returns the ErrorMessages field if non-nil, zero value otherwise. + +### GetErrorMessagesOk + +`func (o *IdentityAttributePreview) GetErrorMessagesOk() (*[]ErrorMessageDto, bool)` + +GetErrorMessagesOk returns a tuple with the ErrorMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessages + +`func (o *IdentityAttributePreview) SetErrorMessages(v []ErrorMessageDto)` + +SetErrorMessages sets ErrorMessages field to given value. + +### HasErrorMessages + +`func (o *IdentityAttributePreview) HasErrorMessages() bool` + +HasErrorMessages returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributeTransform.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributeTransform.md new file mode 100644 index 000000000..47ce04c7b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributeTransform.md @@ -0,0 +1,90 @@ +--- +id: beta-identity-attribute-transform +title: IdentityAttributeTransform +pagination_label: IdentityAttributeTransform +sidebar_label: IdentityAttributeTransform +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributeTransform', 'BetaIdentityAttributeTransform'] +slug: /tools/sdk/go/beta/models/identity-attribute-transform +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'BetaIdentityAttributeTransform'] +--- + +# IdentityAttributeTransform + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttributeName** | Pointer to **string** | Identity attribute's name. | [optional] +**TransformDefinition** | Pointer to [**TransformDefinition**](transform-definition) | | [optional] + +## Methods + +### NewIdentityAttributeTransform + +`func NewIdentityAttributeTransform() *IdentityAttributeTransform` + +NewIdentityAttributeTransform instantiates a new IdentityAttributeTransform 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 + +### NewIdentityAttributeTransformWithDefaults + +`func NewIdentityAttributeTransformWithDefaults() *IdentityAttributeTransform` + +NewIdentityAttributeTransformWithDefaults instantiates a new IdentityAttributeTransform 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 + +### GetIdentityAttributeName + +`func (o *IdentityAttributeTransform) GetIdentityAttributeName() string` + +GetIdentityAttributeName returns the IdentityAttributeName field if non-nil, zero value otherwise. + +### GetIdentityAttributeNameOk + +`func (o *IdentityAttributeTransform) GetIdentityAttributeNameOk() (*string, bool)` + +GetIdentityAttributeNameOk returns a tuple with the IdentityAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeName + +`func (o *IdentityAttributeTransform) SetIdentityAttributeName(v string)` + +SetIdentityAttributeName sets IdentityAttributeName field to given value. + +### HasIdentityAttributeName + +`func (o *IdentityAttributeTransform) HasIdentityAttributeName() bool` + +HasIdentityAttributeName returns a boolean if a field has been set. + +### GetTransformDefinition + +`func (o *IdentityAttributeTransform) GetTransformDefinition() TransformDefinition` + +GetTransformDefinition returns the TransformDefinition field if non-nil, zero value otherwise. + +### GetTransformDefinitionOk + +`func (o *IdentityAttributeTransform) GetTransformDefinitionOk() (*TransformDefinition, bool)` + +GetTransformDefinitionOk returns a tuple with the TransformDefinition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTransformDefinition + +`func (o *IdentityAttributeTransform) SetTransformDefinition(v TransformDefinition)` + +SetTransformDefinition sets TransformDefinition field to given value. + +### HasTransformDefinition + +`func (o *IdentityAttributeTransform) HasTransformDefinition() bool` + +HasTransformDefinition returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributeTransform1.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributeTransform1.md new file mode 100644 index 000000000..ec9f49001 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributeTransform1.md @@ -0,0 +1,90 @@ +--- +id: beta-identity-attribute-transform1 +title: IdentityAttributeTransform1 +pagination_label: IdentityAttributeTransform1 +sidebar_label: IdentityAttributeTransform1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributeTransform1', 'BetaIdentityAttributeTransform1'] +slug: /tools/sdk/go/beta/models/identity-attribute-transform1 +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform1', 'BetaIdentityAttributeTransform1'] +--- + +# IdentityAttributeTransform1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttributeName** | Pointer to **string** | Identity attribute's name. | [optional] +**TransformDefinition** | Pointer to [**TransformDefinition1**](transform-definition1) | | [optional] + +## Methods + +### NewIdentityAttributeTransform1 + +`func NewIdentityAttributeTransform1() *IdentityAttributeTransform1` + +NewIdentityAttributeTransform1 instantiates a new IdentityAttributeTransform1 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 + +### NewIdentityAttributeTransform1WithDefaults + +`func NewIdentityAttributeTransform1WithDefaults() *IdentityAttributeTransform1` + +NewIdentityAttributeTransform1WithDefaults instantiates a new IdentityAttributeTransform1 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 + +### GetIdentityAttributeName + +`func (o *IdentityAttributeTransform1) GetIdentityAttributeName() string` + +GetIdentityAttributeName returns the IdentityAttributeName field if non-nil, zero value otherwise. + +### GetIdentityAttributeNameOk + +`func (o *IdentityAttributeTransform1) GetIdentityAttributeNameOk() (*string, bool)` + +GetIdentityAttributeNameOk returns a tuple with the IdentityAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeName + +`func (o *IdentityAttributeTransform1) SetIdentityAttributeName(v string)` + +SetIdentityAttributeName sets IdentityAttributeName field to given value. + +### HasIdentityAttributeName + +`func (o *IdentityAttributeTransform1) HasIdentityAttributeName() bool` + +HasIdentityAttributeName returns a boolean if a field has been set. + +### GetTransformDefinition + +`func (o *IdentityAttributeTransform1) GetTransformDefinition() TransformDefinition1` + +GetTransformDefinition returns the TransformDefinition field if non-nil, zero value otherwise. + +### GetTransformDefinitionOk + +`func (o *IdentityAttributeTransform1) GetTransformDefinitionOk() (*TransformDefinition1, bool)` + +GetTransformDefinitionOk returns a tuple with the TransformDefinition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTransformDefinition + +`func (o *IdentityAttributeTransform1) SetTransformDefinition(v TransformDefinition1)` + +SetTransformDefinition sets TransformDefinition field to given value. + +### HasTransformDefinition + +`func (o *IdentityAttributeTransform1) HasTransformDefinition() bool` + +HasTransformDefinition returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChanged.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChanged.md new file mode 100644 index 000000000..6a7f8fda1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChanged.md @@ -0,0 +1,80 @@ +--- +id: beta-identity-attributes-changed +title: IdentityAttributesChanged +pagination_label: IdentityAttributesChanged +sidebar_label: IdentityAttributesChanged +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChanged', 'BetaIdentityAttributesChanged'] +slug: /tools/sdk/go/beta/models/identity-attributes-changed +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChanged', 'BetaIdentityAttributesChanged'] +--- + +# IdentityAttributesChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**IdentityAttributesChangedIdentity**](identity-attributes-changed-identity) | | +**Changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | List of identity's attributes that changed. | + +## Methods + +### NewIdentityAttributesChanged + +`func NewIdentityAttributesChanged(identity IdentityAttributesChangedIdentity, changes []IdentityAttributesChangedChangesInner, ) *IdentityAttributesChanged` + +NewIdentityAttributesChanged instantiates a new IdentityAttributesChanged 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 + +### NewIdentityAttributesChangedWithDefaults + +`func NewIdentityAttributesChangedWithDefaults() *IdentityAttributesChanged` + +NewIdentityAttributesChangedWithDefaults instantiates a new IdentityAttributesChanged 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 + +### GetIdentity + +`func (o *IdentityAttributesChanged) GetIdentity() IdentityAttributesChangedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *IdentityAttributesChanged) GetIdentityOk() (*IdentityAttributesChangedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *IdentityAttributesChanged) SetIdentity(v IdentityAttributesChangedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetChanges + +`func (o *IdentityAttributesChanged) GetChanges() []IdentityAttributesChangedChangesInner` + +GetChanges returns the Changes field if non-nil, zero value otherwise. + +### GetChangesOk + +`func (o *IdentityAttributesChanged) GetChangesOk() (*[]IdentityAttributesChangedChangesInner, bool)` + +GetChangesOk returns a tuple with the Changes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanges + +`func (o *IdentityAttributesChanged) SetChanges(v []IdentityAttributesChangedChangesInner)` + +SetChanges sets Changes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChangedChangesInner.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChangedChangesInner.md new file mode 100644 index 000000000..71ecbbc8d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChangedChangesInner.md @@ -0,0 +1,121 @@ +--- +id: beta-identity-attributes-changed-changes-inner +title: IdentityAttributesChangedChangesInner +pagination_label: IdentityAttributesChangedChangesInner +sidebar_label: IdentityAttributesChangedChangesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChangedChangesInner', 'BetaIdentityAttributesChangedChangesInner'] +slug: /tools/sdk/go/beta/models/identity-attributes-changed-changes-inner +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInner', 'BetaIdentityAttributesChangedChangesInner'] +--- + +# IdentityAttributesChangedChangesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | **string** | Identity attribute's name. | +**OldValue** | Pointer to [**NullableIdentityAttributesChangedChangesInnerOldValue**](identity-attributes-changed-changes-inner-old-value) | | [optional] +**NewValue** | Pointer to [**IdentityAttributesChangedChangesInnerNewValue**](identity-attributes-changed-changes-inner-new-value) | | [optional] + +## Methods + +### NewIdentityAttributesChangedChangesInner + +`func NewIdentityAttributesChangedChangesInner(attribute string, ) *IdentityAttributesChangedChangesInner` + +NewIdentityAttributesChangedChangesInner instantiates a new IdentityAttributesChangedChangesInner 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 + +### NewIdentityAttributesChangedChangesInnerWithDefaults + +`func NewIdentityAttributesChangedChangesInnerWithDefaults() *IdentityAttributesChangedChangesInner` + +NewIdentityAttributesChangedChangesInnerWithDefaults instantiates a new IdentityAttributesChangedChangesInner 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 + +### GetAttribute + +`func (o *IdentityAttributesChangedChangesInner) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *IdentityAttributesChangedChangesInner) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *IdentityAttributesChangedChangesInner) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + + +### GetOldValue + +`func (o *IdentityAttributesChangedChangesInner) GetOldValue() IdentityAttributesChangedChangesInnerOldValue` + +GetOldValue returns the OldValue field if non-nil, zero value otherwise. + +### GetOldValueOk + +`func (o *IdentityAttributesChangedChangesInner) GetOldValueOk() (*IdentityAttributesChangedChangesInnerOldValue, bool)` + +GetOldValueOk returns a tuple with the OldValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOldValue + +`func (o *IdentityAttributesChangedChangesInner) SetOldValue(v IdentityAttributesChangedChangesInnerOldValue)` + +SetOldValue sets OldValue field to given value. + +### HasOldValue + +`func (o *IdentityAttributesChangedChangesInner) HasOldValue() bool` + +HasOldValue returns a boolean if a field has been set. + +### SetOldValueNil + +`func (o *IdentityAttributesChangedChangesInner) SetOldValueNil(b bool)` + + SetOldValueNil sets the value for OldValue to be an explicit nil + +### UnsetOldValue +`func (o *IdentityAttributesChangedChangesInner) UnsetOldValue()` + +UnsetOldValue ensures that no value is present for OldValue, not even an explicit nil +### GetNewValue + +`func (o *IdentityAttributesChangedChangesInner) GetNewValue() IdentityAttributesChangedChangesInnerNewValue` + +GetNewValue returns the NewValue field if non-nil, zero value otherwise. + +### GetNewValueOk + +`func (o *IdentityAttributesChangedChangesInner) GetNewValueOk() (*IdentityAttributesChangedChangesInnerNewValue, bool)` + +GetNewValueOk returns a tuple with the NewValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewValue + +`func (o *IdentityAttributesChangedChangesInner) SetNewValue(v IdentityAttributesChangedChangesInnerNewValue)` + +SetNewValue sets NewValue field to given value. + +### HasNewValue + +`func (o *IdentityAttributesChangedChangesInner) HasNewValue() bool` + +HasNewValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChangedChangesInnerNewValue.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChangedChangesInnerNewValue.md new file mode 100644 index 000000000..6ae380b0d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChangedChangesInnerNewValue.md @@ -0,0 +1,38 @@ +--- +id: beta-identity-attributes-changed-changes-inner-new-value +title: IdentityAttributesChangedChangesInnerNewValue +pagination_label: IdentityAttributesChangedChangesInnerNewValue +sidebar_label: IdentityAttributesChangedChangesInnerNewValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChangedChangesInnerNewValue', 'BetaIdentityAttributesChangedChangesInnerNewValue'] +slug: /tools/sdk/go/beta/models/identity-attributes-changed-changes-inner-new-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerNewValue', 'BetaIdentityAttributesChangedChangesInnerNewValue'] +--- + +# IdentityAttributesChangedChangesInnerNewValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewIdentityAttributesChangedChangesInnerNewValue + +`func NewIdentityAttributesChangedChangesInnerNewValue() *IdentityAttributesChangedChangesInnerNewValue` + +NewIdentityAttributesChangedChangesInnerNewValue instantiates a new IdentityAttributesChangedChangesInnerNewValue 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 + +### NewIdentityAttributesChangedChangesInnerNewValueWithDefaults + +`func NewIdentityAttributesChangedChangesInnerNewValueWithDefaults() *IdentityAttributesChangedChangesInnerNewValue` + +NewIdentityAttributesChangedChangesInnerNewValueWithDefaults instantiates a new IdentityAttributesChangedChangesInnerNewValue 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 + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChangedChangesInnerOldValue.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChangedChangesInnerOldValue.md new file mode 100644 index 000000000..56d96b478 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChangedChangesInnerOldValue.md @@ -0,0 +1,38 @@ +--- +id: beta-identity-attributes-changed-changes-inner-old-value +title: IdentityAttributesChangedChangesInnerOldValue +pagination_label: IdentityAttributesChangedChangesInnerOldValue +sidebar_label: IdentityAttributesChangedChangesInnerOldValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChangedChangesInnerOldValue', 'BetaIdentityAttributesChangedChangesInnerOldValue'] +slug: /tools/sdk/go/beta/models/identity-attributes-changed-changes-inner-old-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerOldValue', 'BetaIdentityAttributesChangedChangesInnerOldValue'] +--- + +# IdentityAttributesChangedChangesInnerOldValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewIdentityAttributesChangedChangesInnerOldValue + +`func NewIdentityAttributesChangedChangesInnerOldValue() *IdentityAttributesChangedChangesInnerOldValue` + +NewIdentityAttributesChangedChangesInnerOldValue instantiates a new IdentityAttributesChangedChangesInnerOldValue 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 + +### NewIdentityAttributesChangedChangesInnerOldValueWithDefaults + +`func NewIdentityAttributesChangedChangesInnerOldValueWithDefaults() *IdentityAttributesChangedChangesInnerOldValue` + +NewIdentityAttributesChangedChangesInnerOldValueWithDefaults instantiates a new IdentityAttributesChangedChangesInnerOldValue 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 + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md new file mode 100644 index 000000000..415020a8f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md @@ -0,0 +1,38 @@ +--- +id: beta-identity-attributes-changed-changes-inner-old-value-one-of-value +title: IdentityAttributesChangedChangesInnerOldValueOneOfValue +pagination_label: IdentityAttributesChangedChangesInnerOldValueOneOfValue +sidebar_label: IdentityAttributesChangedChangesInnerOldValueOneOfValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChangedChangesInnerOldValueOneOfValue', 'BetaIdentityAttributesChangedChangesInnerOldValueOneOfValue'] +slug: /tools/sdk/go/beta/models/identity-attributes-changed-changes-inner-old-value-one-of-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerOldValueOneOfValue', 'BetaIdentityAttributesChangedChangesInnerOldValueOneOfValue'] +--- + +# IdentityAttributesChangedChangesInnerOldValueOneOfValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewIdentityAttributesChangedChangesInnerOldValueOneOfValue + +`func NewIdentityAttributesChangedChangesInnerOldValueOneOfValue() *IdentityAttributesChangedChangesInnerOldValueOneOfValue` + +NewIdentityAttributesChangedChangesInnerOldValueOneOfValue instantiates a new IdentityAttributesChangedChangesInnerOldValueOneOfValue 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 + +### NewIdentityAttributesChangedChangesInnerOldValueOneOfValueWithDefaults + +`func NewIdentityAttributesChangedChangesInnerOldValueOneOfValueWithDefaults() *IdentityAttributesChangedChangesInnerOldValueOneOfValue` + +NewIdentityAttributesChangedChangesInnerOldValueOneOfValueWithDefaults instantiates a new IdentityAttributesChangedChangesInnerOldValueOneOfValue 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 + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChangedIdentity.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChangedIdentity.md new file mode 100644 index 000000000..01a3c86e7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityAttributesChangedIdentity.md @@ -0,0 +1,101 @@ +--- +id: beta-identity-attributes-changed-identity +title: IdentityAttributesChangedIdentity +pagination_label: IdentityAttributesChangedIdentity +sidebar_label: IdentityAttributesChangedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChangedIdentity', 'BetaIdentityAttributesChangedIdentity'] +slug: /tools/sdk/go/beta/models/identity-attributes-changed-identity +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedIdentity', 'BetaIdentityAttributesChangedIdentity'] +--- + +# IdentityAttributesChangedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of identity whose attributes changed. | +**Id** | **string** | ID of identity whose attributes changed. | +**Name** | **string** | Name of identity whose attributes changed. | + +## Methods + +### NewIdentityAttributesChangedIdentity + +`func NewIdentityAttributesChangedIdentity(type_ string, id string, name string, ) *IdentityAttributesChangedIdentity` + +NewIdentityAttributesChangedIdentity instantiates a new IdentityAttributesChangedIdentity 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 + +### NewIdentityAttributesChangedIdentityWithDefaults + +`func NewIdentityAttributesChangedIdentityWithDefaults() *IdentityAttributesChangedIdentity` + +NewIdentityAttributesChangedIdentityWithDefaults instantiates a new IdentityAttributesChangedIdentity 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 + +### GetType + +`func (o *IdentityAttributesChangedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityAttributesChangedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityAttributesChangedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *IdentityAttributesChangedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityAttributesChangedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityAttributesChangedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *IdentityAttributesChangedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityAttributesChangedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityAttributesChangedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityCertificationTask.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityCertificationTask.md new file mode 100644 index 000000000..1a6c5af7d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityCertificationTask.md @@ -0,0 +1,168 @@ +--- +id: beta-identity-certification-task +title: IdentityCertificationTask +pagination_label: IdentityCertificationTask +sidebar_label: IdentityCertificationTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCertificationTask', 'BetaIdentityCertificationTask'] +slug: /tools/sdk/go/beta/models/identity-certification-task +tags: ['SDK', 'Software Development Kit', 'IdentityCertificationTask', 'BetaIdentityCertificationTask'] +--- + +# IdentityCertificationTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The task id | [optional] +**CertificationId** | Pointer to **string** | The certification id | [optional] +**Type** | Pointer to **string** | | [optional] +**Status** | Pointer to **string** | | [optional] +**Errors** | Pointer to **[]string** | Any errors executing the task (Optional). | [optional] + +## Methods + +### NewIdentityCertificationTask + +`func NewIdentityCertificationTask() *IdentityCertificationTask` + +NewIdentityCertificationTask instantiates a new IdentityCertificationTask 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 + +### NewIdentityCertificationTaskWithDefaults + +`func NewIdentityCertificationTaskWithDefaults() *IdentityCertificationTask` + +NewIdentityCertificationTaskWithDefaults instantiates a new IdentityCertificationTask 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 + +### GetId + +`func (o *IdentityCertificationTask) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityCertificationTask) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityCertificationTask) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityCertificationTask) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCertificationId + +`func (o *IdentityCertificationTask) GetCertificationId() string` + +GetCertificationId returns the CertificationId field if non-nil, zero value otherwise. + +### GetCertificationIdOk + +`func (o *IdentityCertificationTask) GetCertificationIdOk() (*string, bool)` + +GetCertificationIdOk returns a tuple with the CertificationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationId + +`func (o *IdentityCertificationTask) SetCertificationId(v string)` + +SetCertificationId sets CertificationId field to given value. + +### HasCertificationId + +`func (o *IdentityCertificationTask) HasCertificationId() bool` + +HasCertificationId returns a boolean if a field has been set. + +### GetType + +`func (o *IdentityCertificationTask) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityCertificationTask) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityCertificationTask) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityCertificationTask) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetStatus + +`func (o *IdentityCertificationTask) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *IdentityCertificationTask) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *IdentityCertificationTask) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *IdentityCertificationTask) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetErrors + +`func (o *IdentityCertificationTask) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *IdentityCertificationTask) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *IdentityCertificationTask) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *IdentityCertificationTask) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityCertified.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityCertified.md new file mode 100644 index 000000000..45438589b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityCertified.md @@ -0,0 +1,246 @@ +--- +id: beta-identity-certified +title: IdentityCertified +pagination_label: IdentityCertified +sidebar_label: IdentityCertified +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCertified', 'BetaIdentityCertified'] +slug: /tools/sdk/go/beta/models/identity-certified +tags: ['SDK', 'Software Development Kit', 'IdentityCertified', 'BetaIdentityCertified'] +--- + +# IdentityCertified + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CertificationId** | Pointer to **string** | the id of the certification item | [optional] +**CertificationName** | Pointer to **string** | the certification item name | [optional] +**SignedDate** | Pointer to **string** | the date ceritification was signed | [optional] +**Certifiers** | Pointer to [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional] +**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional] +**Signer** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] + +## Methods + +### NewIdentityCertified + +`func NewIdentityCertified() *IdentityCertified` + +NewIdentityCertified instantiates a new IdentityCertified 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 + +### NewIdentityCertifiedWithDefaults + +`func NewIdentityCertifiedWithDefaults() *IdentityCertified` + +NewIdentityCertifiedWithDefaults instantiates a new IdentityCertified 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 + +### GetCertificationId + +`func (o *IdentityCertified) GetCertificationId() string` + +GetCertificationId returns the CertificationId field if non-nil, zero value otherwise. + +### GetCertificationIdOk + +`func (o *IdentityCertified) GetCertificationIdOk() (*string, bool)` + +GetCertificationIdOk returns a tuple with the CertificationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationId + +`func (o *IdentityCertified) SetCertificationId(v string)` + +SetCertificationId sets CertificationId field to given value. + +### HasCertificationId + +`func (o *IdentityCertified) HasCertificationId() bool` + +HasCertificationId returns a boolean if a field has been set. + +### GetCertificationName + +`func (o *IdentityCertified) GetCertificationName() string` + +GetCertificationName returns the CertificationName field if non-nil, zero value otherwise. + +### GetCertificationNameOk + +`func (o *IdentityCertified) GetCertificationNameOk() (*string, bool)` + +GetCertificationNameOk returns a tuple with the CertificationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationName + +`func (o *IdentityCertified) SetCertificationName(v string)` + +SetCertificationName sets CertificationName field to given value. + +### HasCertificationName + +`func (o *IdentityCertified) HasCertificationName() bool` + +HasCertificationName returns a boolean if a field has been set. + +### GetSignedDate + +`func (o *IdentityCertified) GetSignedDate() string` + +GetSignedDate returns the SignedDate field if non-nil, zero value otherwise. + +### GetSignedDateOk + +`func (o *IdentityCertified) GetSignedDateOk() (*string, bool)` + +GetSignedDateOk returns a tuple with the SignedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignedDate + +`func (o *IdentityCertified) SetSignedDate(v string)` + +SetSignedDate sets SignedDate field to given value. + +### HasSignedDate + +`func (o *IdentityCertified) HasSignedDate() bool` + +HasSignedDate returns a boolean if a field has been set. + +### GetCertifiers + +`func (o *IdentityCertified) GetCertifiers() []CertifierResponse` + +GetCertifiers returns the Certifiers field if non-nil, zero value otherwise. + +### GetCertifiersOk + +`func (o *IdentityCertified) GetCertifiersOk() (*[]CertifierResponse, bool)` + +GetCertifiersOk returns a tuple with the Certifiers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertifiers + +`func (o *IdentityCertified) SetCertifiers(v []CertifierResponse)` + +SetCertifiers sets Certifiers field to given value. + +### HasCertifiers + +`func (o *IdentityCertified) HasCertifiers() bool` + +HasCertifiers returns a boolean if a field has been set. + +### GetReviewers + +`func (o *IdentityCertified) GetReviewers() []CertifierResponse` + +GetReviewers returns the Reviewers field if non-nil, zero value otherwise. + +### GetReviewersOk + +`func (o *IdentityCertified) GetReviewersOk() (*[]CertifierResponse, bool)` + +GetReviewersOk returns a tuple with the Reviewers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewers + +`func (o *IdentityCertified) SetReviewers(v []CertifierResponse)` + +SetReviewers sets Reviewers field to given value. + +### HasReviewers + +`func (o *IdentityCertified) HasReviewers() bool` + +HasReviewers returns a boolean if a field has been set. + +### GetSigner + +`func (o *IdentityCertified) GetSigner() CertifierResponse` + +GetSigner returns the Signer field if non-nil, zero value otherwise. + +### GetSignerOk + +`func (o *IdentityCertified) GetSignerOk() (*CertifierResponse, bool)` + +GetSignerOk returns a tuple with the Signer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigner + +`func (o *IdentityCertified) SetSigner(v CertifierResponse)` + +SetSigner sets Signer field to given value. + +### HasSigner + +`func (o *IdentityCertified) HasSigner() bool` + +HasSigner returns a boolean if a field has been set. + +### GetEventType + +`func (o *IdentityCertified) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *IdentityCertified) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *IdentityCertified) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *IdentityCertified) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDt + +`func (o *IdentityCertified) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *IdentityCertified) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *IdentityCertified) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *IdentityCertified) HasDt() bool` + +HasDt returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityCompareResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityCompareResponse.md new file mode 100644 index 000000000..1d73651a6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityCompareResponse.md @@ -0,0 +1,64 @@ +--- +id: beta-identity-compare-response +title: IdentityCompareResponse +pagination_label: IdentityCompareResponse +sidebar_label: IdentityCompareResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCompareResponse', 'BetaIdentityCompareResponse'] +slug: /tools/sdk/go/beta/models/identity-compare-response +tags: ['SDK', 'Software Development Kit', 'IdentityCompareResponse', 'BetaIdentityCompareResponse'] +--- + +# IdentityCompareResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItemDiff** | Pointer to **map[string]map[string]interface{}** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] + +## Methods + +### NewIdentityCompareResponse + +`func NewIdentityCompareResponse() *IdentityCompareResponse` + +NewIdentityCompareResponse instantiates a new IdentityCompareResponse 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 + +### NewIdentityCompareResponseWithDefaults + +`func NewIdentityCompareResponseWithDefaults() *IdentityCompareResponse` + +NewIdentityCompareResponseWithDefaults instantiates a new IdentityCompareResponse 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 + +### GetAccessItemDiff + +`func (o *IdentityCompareResponse) GetAccessItemDiff() map[string]map[string]interface{}` + +GetAccessItemDiff returns the AccessItemDiff field if non-nil, zero value otherwise. + +### GetAccessItemDiffOk + +`func (o *IdentityCompareResponse) GetAccessItemDiffOk() (*map[string]map[string]interface{}, bool)` + +GetAccessItemDiffOk returns a tuple with the AccessItemDiff field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItemDiff + +`func (o *IdentityCompareResponse) SetAccessItemDiff(v map[string]map[string]interface{})` + +SetAccessItemDiff sets AccessItemDiff field to given value. + +### HasAccessItemDiff + +`func (o *IdentityCompareResponse) HasAccessItemDiff() bool` + +HasAccessItemDiff returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityCreated.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityCreated.md new file mode 100644 index 000000000..b1e4e3b8e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityCreated.md @@ -0,0 +1,80 @@ +--- +id: beta-identity-created +title: IdentityCreated +pagination_label: IdentityCreated +sidebar_label: IdentityCreated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCreated', 'BetaIdentityCreated'] +slug: /tools/sdk/go/beta/models/identity-created +tags: ['SDK', 'Software Development Kit', 'IdentityCreated', 'BetaIdentityCreated'] +--- + +# IdentityCreated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**IdentityCreatedIdentity**](identity-created-identity) | | +**Attributes** | **map[string]interface{}** | Attributes assigned to the identity. These attributes are determined by the identity profile. | + +## Methods + +### NewIdentityCreated + +`func NewIdentityCreated(identity IdentityCreatedIdentity, attributes map[string]interface{}, ) *IdentityCreated` + +NewIdentityCreated instantiates a new IdentityCreated 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 + +### NewIdentityCreatedWithDefaults + +`func NewIdentityCreatedWithDefaults() *IdentityCreated` + +NewIdentityCreatedWithDefaults instantiates a new IdentityCreated 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 + +### GetIdentity + +`func (o *IdentityCreated) GetIdentity() IdentityCreatedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *IdentityCreated) GetIdentityOk() (*IdentityCreatedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *IdentityCreated) SetIdentity(v IdentityCreatedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetAttributes + +`func (o *IdentityCreated) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *IdentityCreated) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *IdentityCreated) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityCreatedIdentity.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityCreatedIdentity.md new file mode 100644 index 000000000..0c5b8a6f2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityCreatedIdentity.md @@ -0,0 +1,101 @@ +--- +id: beta-identity-created-identity +title: IdentityCreatedIdentity +pagination_label: IdentityCreatedIdentity +sidebar_label: IdentityCreatedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCreatedIdentity', 'BetaIdentityCreatedIdentity'] +slug: /tools/sdk/go/beta/models/identity-created-identity +tags: ['SDK', 'Software Development Kit', 'IdentityCreatedIdentity', 'BetaIdentityCreatedIdentity'] +--- + +# IdentityCreatedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Identity's DTO type. | +**Id** | **string** | Identity's unique ID. | +**Name** | **string** | Identity's name. | + +## Methods + +### NewIdentityCreatedIdentity + +`func NewIdentityCreatedIdentity(type_ string, id string, name string, ) *IdentityCreatedIdentity` + +NewIdentityCreatedIdentity instantiates a new IdentityCreatedIdentity 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 + +### NewIdentityCreatedIdentityWithDefaults + +`func NewIdentityCreatedIdentityWithDefaults() *IdentityCreatedIdentity` + +NewIdentityCreatedIdentityWithDefaults instantiates a new IdentityCreatedIdentity 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 + +### GetType + +`func (o *IdentityCreatedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityCreatedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityCreatedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *IdentityCreatedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityCreatedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityCreatedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *IdentityCreatedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityCreatedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityCreatedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityDeleted.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityDeleted.md new file mode 100644 index 000000000..33bc96bb1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityDeleted.md @@ -0,0 +1,80 @@ +--- +id: beta-identity-deleted +title: IdentityDeleted +pagination_label: IdentityDeleted +sidebar_label: IdentityDeleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDeleted', 'BetaIdentityDeleted'] +slug: /tools/sdk/go/beta/models/identity-deleted +tags: ['SDK', 'Software Development Kit', 'IdentityDeleted', 'BetaIdentityDeleted'] +--- + +# IdentityDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | +**Attributes** | **map[string]interface{}** | Identity attributes. The attributes are determined by the identity profile. | + +## Methods + +### NewIdentityDeleted + +`func NewIdentityDeleted(identity IdentityDeletedIdentity, attributes map[string]interface{}, ) *IdentityDeleted` + +NewIdentityDeleted instantiates a new IdentityDeleted 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 + +### NewIdentityDeletedWithDefaults + +`func NewIdentityDeletedWithDefaults() *IdentityDeleted` + +NewIdentityDeletedWithDefaults instantiates a new IdentityDeleted 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 + +### GetIdentity + +`func (o *IdentityDeleted) GetIdentity() IdentityDeletedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *IdentityDeleted) GetIdentityOk() (*IdentityDeletedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *IdentityDeleted) SetIdentity(v IdentityDeletedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetAttributes + +`func (o *IdentityDeleted) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *IdentityDeleted) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *IdentityDeleted) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityDeletedIdentity.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityDeletedIdentity.md new file mode 100644 index 000000000..f02c1a359 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityDeletedIdentity.md @@ -0,0 +1,101 @@ +--- +id: beta-identity-deleted-identity +title: IdentityDeletedIdentity +pagination_label: IdentityDeletedIdentity +sidebar_label: IdentityDeletedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDeletedIdentity', 'BetaIdentityDeletedIdentity'] +slug: /tools/sdk/go/beta/models/identity-deleted-identity +tags: ['SDK', 'Software Development Kit', 'IdentityDeletedIdentity', 'BetaIdentityDeletedIdentity'] +--- + +# IdentityDeletedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Deleted identity's DTO type. | +**Id** | **string** | Deleted identity ID. | +**Name** | **string** | Deleted identity's name. | + +## Methods + +### NewIdentityDeletedIdentity + +`func NewIdentityDeletedIdentity(type_ string, id string, name string, ) *IdentityDeletedIdentity` + +NewIdentityDeletedIdentity instantiates a new IdentityDeletedIdentity 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 + +### NewIdentityDeletedIdentityWithDefaults + +`func NewIdentityDeletedIdentityWithDefaults() *IdentityDeletedIdentity` + +NewIdentityDeletedIdentityWithDefaults instantiates a new IdentityDeletedIdentity 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 + +### GetType + +`func (o *IdentityDeletedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityDeletedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityDeletedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *IdentityDeletedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityDeletedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityDeletedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *IdentityDeletedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityDeletedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityDeletedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityEntities.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityEntities.md new file mode 100644 index 000000000..c7bda6ded --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityEntities.md @@ -0,0 +1,64 @@ +--- +id: beta-identity-entities +title: IdentityEntities +pagination_label: IdentityEntities +sidebar_label: IdentityEntities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityEntities', 'BetaIdentityEntities'] +slug: /tools/sdk/go/beta/models/identity-entities +tags: ['SDK', 'Software Development Kit', 'IdentityEntities', 'BetaIdentityEntities'] +--- + +# IdentityEntities + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityEntity** | Pointer to [**IdentityEntitiesIdentityEntity**](identity-entities-identity-entity) | | [optional] + +## Methods + +### NewIdentityEntities + +`func NewIdentityEntities() *IdentityEntities` + +NewIdentityEntities instantiates a new IdentityEntities 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 + +### NewIdentityEntitiesWithDefaults + +`func NewIdentityEntitiesWithDefaults() *IdentityEntities` + +NewIdentityEntitiesWithDefaults instantiates a new IdentityEntities 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 + +### GetIdentityEntity + +`func (o *IdentityEntities) GetIdentityEntity() IdentityEntitiesIdentityEntity` + +GetIdentityEntity returns the IdentityEntity field if non-nil, zero value otherwise. + +### GetIdentityEntityOk + +`func (o *IdentityEntities) GetIdentityEntityOk() (*IdentityEntitiesIdentityEntity, bool)` + +GetIdentityEntityOk returns a tuple with the IdentityEntity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityEntity + +`func (o *IdentityEntities) SetIdentityEntity(v IdentityEntitiesIdentityEntity)` + +SetIdentityEntity sets IdentityEntity field to given value. + +### HasIdentityEntity + +`func (o *IdentityEntities) HasIdentityEntity() bool` + +HasIdentityEntity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityEntitiesIdentityEntity.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityEntitiesIdentityEntity.md new file mode 100644 index 000000000..7c3d313f5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityEntitiesIdentityEntity.md @@ -0,0 +1,116 @@ +--- +id: beta-identity-entities-identity-entity +title: IdentityEntitiesIdentityEntity +pagination_label: IdentityEntitiesIdentityEntity +sidebar_label: IdentityEntitiesIdentityEntity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityEntitiesIdentityEntity', 'BetaIdentityEntitiesIdentityEntity'] +slug: /tools/sdk/go/beta/models/identity-entities-identity-entity +tags: ['SDK', 'Software Development Kit', 'IdentityEntitiesIdentityEntity', 'BetaIdentityEntitiesIdentityEntity'] +--- + +# IdentityEntitiesIdentityEntity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | id of the resource to which the identity is associated | [optional] +**Name** | Pointer to **string** | name of the resource to which the identity is associated | [optional] +**Type** | Pointer to **string** | type of the resource to which the identity is associated | [optional] + +## Methods + +### NewIdentityEntitiesIdentityEntity + +`func NewIdentityEntitiesIdentityEntity() *IdentityEntitiesIdentityEntity` + +NewIdentityEntitiesIdentityEntity instantiates a new IdentityEntitiesIdentityEntity 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 + +### NewIdentityEntitiesIdentityEntityWithDefaults + +`func NewIdentityEntitiesIdentityEntityWithDefaults() *IdentityEntitiesIdentityEntity` + +NewIdentityEntitiesIdentityEntityWithDefaults instantiates a new IdentityEntitiesIdentityEntity 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 + +### GetId + +`func (o *IdentityEntitiesIdentityEntity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityEntitiesIdentityEntity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityEntitiesIdentityEntity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityEntitiesIdentityEntity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityEntitiesIdentityEntity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityEntitiesIdentityEntity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityEntitiesIdentityEntity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityEntitiesIdentityEntity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *IdentityEntitiesIdentityEntity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityEntitiesIdentityEntity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityEntitiesIdentityEntity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityEntitiesIdentityEntity) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityExceptionReportReference.md new file mode 100644 index 000000000..207460d00 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityExceptionReportReference.md @@ -0,0 +1,90 @@ +--- +id: beta-identity-exception-report-reference +title: IdentityExceptionReportReference +pagination_label: IdentityExceptionReportReference +sidebar_label: IdentityExceptionReportReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityExceptionReportReference', 'BetaIdentityExceptionReportReference'] +slug: /tools/sdk/go/beta/models/identity-exception-report-reference +tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'BetaIdentityExceptionReportReference'] +--- + +# IdentityExceptionReportReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TaskResultId** | Pointer to **string** | Task result ID. | [optional] +**ReportName** | Pointer to **string** | Report name. | [optional] + +## Methods + +### NewIdentityExceptionReportReference + +`func NewIdentityExceptionReportReference() *IdentityExceptionReportReference` + +NewIdentityExceptionReportReference instantiates a new IdentityExceptionReportReference 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 + +### NewIdentityExceptionReportReferenceWithDefaults + +`func NewIdentityExceptionReportReferenceWithDefaults() *IdentityExceptionReportReference` + +NewIdentityExceptionReportReferenceWithDefaults instantiates a new IdentityExceptionReportReference 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 + +### GetTaskResultId + +`func (o *IdentityExceptionReportReference) GetTaskResultId() string` + +GetTaskResultId returns the TaskResultId field if non-nil, zero value otherwise. + +### GetTaskResultIdOk + +`func (o *IdentityExceptionReportReference) GetTaskResultIdOk() (*string, bool)` + +GetTaskResultIdOk returns a tuple with the TaskResultId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskResultId + +`func (o *IdentityExceptionReportReference) SetTaskResultId(v string)` + +SetTaskResultId sets TaskResultId field to given value. + +### HasTaskResultId + +`func (o *IdentityExceptionReportReference) HasTaskResultId() bool` + +HasTaskResultId returns a boolean if a field has been set. + +### GetReportName + +`func (o *IdentityExceptionReportReference) GetReportName() string` + +GetReportName returns the ReportName field if non-nil, zero value otherwise. + +### GetReportNameOk + +`func (o *IdentityExceptionReportReference) GetReportNameOk() (*string, bool)` + +GetReportNameOk returns a tuple with the ReportName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportName + +`func (o *IdentityExceptionReportReference) SetReportName(v string)` + +SetReportName sets ReportName field to given value. + +### HasReportName + +`func (o *IdentityExceptionReportReference) HasReportName() bool` + +HasReportName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityExceptionReportReference1.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityExceptionReportReference1.md new file mode 100644 index 000000000..85fca2e35 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityExceptionReportReference1.md @@ -0,0 +1,90 @@ +--- +id: beta-identity-exception-report-reference1 +title: IdentityExceptionReportReference1 +pagination_label: IdentityExceptionReportReference1 +sidebar_label: IdentityExceptionReportReference1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityExceptionReportReference1', 'BetaIdentityExceptionReportReference1'] +slug: /tools/sdk/go/beta/models/identity-exception-report-reference1 +tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference1', 'BetaIdentityExceptionReportReference1'] +--- + +# IdentityExceptionReportReference1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TaskResultId** | Pointer to **string** | Task result ID. | [optional] +**ReportName** | Pointer to **string** | Report name. | [optional] + +## Methods + +### NewIdentityExceptionReportReference1 + +`func NewIdentityExceptionReportReference1() *IdentityExceptionReportReference1` + +NewIdentityExceptionReportReference1 instantiates a new IdentityExceptionReportReference1 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 + +### NewIdentityExceptionReportReference1WithDefaults + +`func NewIdentityExceptionReportReference1WithDefaults() *IdentityExceptionReportReference1` + +NewIdentityExceptionReportReference1WithDefaults instantiates a new IdentityExceptionReportReference1 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 + +### GetTaskResultId + +`func (o *IdentityExceptionReportReference1) GetTaskResultId() string` + +GetTaskResultId returns the TaskResultId field if non-nil, zero value otherwise. + +### GetTaskResultIdOk + +`func (o *IdentityExceptionReportReference1) GetTaskResultIdOk() (*string, bool)` + +GetTaskResultIdOk returns a tuple with the TaskResultId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskResultId + +`func (o *IdentityExceptionReportReference1) SetTaskResultId(v string)` + +SetTaskResultId sets TaskResultId field to given value. + +### HasTaskResultId + +`func (o *IdentityExceptionReportReference1) HasTaskResultId() bool` + +HasTaskResultId returns a boolean if a field has been set. + +### GetReportName + +`func (o *IdentityExceptionReportReference1) GetReportName() string` + +GetReportName returns the ReportName field if non-nil, zero value otherwise. + +### GetReportNameOk + +`func (o *IdentityExceptionReportReference1) GetReportNameOk() (*string, bool)` + +GetReportNameOk returns a tuple with the ReportName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportName + +`func (o *IdentityExceptionReportReference1) SetReportName(v string)` + +SetReportName sets ReportName field to given value. + +### HasReportName + +`func (o *IdentityExceptionReportReference1) HasReportName() bool` + +HasReportName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityHistoryResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityHistoryResponse.md new file mode 100644 index 000000000..3482ca6b5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityHistoryResponse.md @@ -0,0 +1,194 @@ +--- +id: beta-identity-history-response +title: IdentityHistoryResponse +pagination_label: IdentityHistoryResponse +sidebar_label: IdentityHistoryResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityHistoryResponse', 'BetaIdentityHistoryResponse'] +slug: /tools/sdk/go/beta/models/identity-history-response +tags: ['SDK', 'Software Development Kit', 'IdentityHistoryResponse', 'BetaIdentityHistoryResponse'] +--- + +# IdentityHistoryResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the identity ID | [optional] +**DisplayName** | Pointer to **string** | the display name of the identity | [optional] +**Snapshot** | Pointer to **string** | the date when the identity record was created | [optional] +**DeletedDate** | Pointer to **string** | the date when the identity was deleted | [optional] +**AccessItemCount** | Pointer to **map[string]int32** | A map containing the count of each access item | [optional] +**Attributes** | Pointer to **map[string]interface{}** | A map containing the identity attributes | [optional] + +## Methods + +### NewIdentityHistoryResponse + +`func NewIdentityHistoryResponse() *IdentityHistoryResponse` + +NewIdentityHistoryResponse instantiates a new IdentityHistoryResponse 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 + +### NewIdentityHistoryResponseWithDefaults + +`func NewIdentityHistoryResponseWithDefaults() *IdentityHistoryResponse` + +NewIdentityHistoryResponseWithDefaults instantiates a new IdentityHistoryResponse 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 + +### GetId + +`func (o *IdentityHistoryResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityHistoryResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityHistoryResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityHistoryResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *IdentityHistoryResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityHistoryResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityHistoryResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityHistoryResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSnapshot + +`func (o *IdentityHistoryResponse) GetSnapshot() string` + +GetSnapshot returns the Snapshot field if non-nil, zero value otherwise. + +### GetSnapshotOk + +`func (o *IdentityHistoryResponse) GetSnapshotOk() (*string, bool)` + +GetSnapshotOk returns a tuple with the Snapshot field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshot + +`func (o *IdentityHistoryResponse) SetSnapshot(v string)` + +SetSnapshot sets Snapshot field to given value. + +### HasSnapshot + +`func (o *IdentityHistoryResponse) HasSnapshot() bool` + +HasSnapshot returns a boolean if a field has been set. + +### GetDeletedDate + +`func (o *IdentityHistoryResponse) GetDeletedDate() string` + +GetDeletedDate returns the DeletedDate field if non-nil, zero value otherwise. + +### GetDeletedDateOk + +`func (o *IdentityHistoryResponse) GetDeletedDateOk() (*string, bool)` + +GetDeletedDateOk returns a tuple with the DeletedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeletedDate + +`func (o *IdentityHistoryResponse) SetDeletedDate(v string)` + +SetDeletedDate sets DeletedDate field to given value. + +### HasDeletedDate + +`func (o *IdentityHistoryResponse) HasDeletedDate() bool` + +HasDeletedDate returns a boolean if a field has been set. + +### GetAccessItemCount + +`func (o *IdentityHistoryResponse) GetAccessItemCount() map[string]int32` + +GetAccessItemCount returns the AccessItemCount field if non-nil, zero value otherwise. + +### GetAccessItemCountOk + +`func (o *IdentityHistoryResponse) GetAccessItemCountOk() (*map[string]int32, bool)` + +GetAccessItemCountOk returns a tuple with the AccessItemCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItemCount + +`func (o *IdentityHistoryResponse) SetAccessItemCount(v map[string]int32)` + +SetAccessItemCount sets AccessItemCount field to given value. + +### HasAccessItemCount + +`func (o *IdentityHistoryResponse) HasAccessItemCount() bool` + +HasAccessItemCount returns a boolean if a field has been set. + +### GetAttributes + +`func (o *IdentityHistoryResponse) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *IdentityHistoryResponse) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *IdentityHistoryResponse) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *IdentityHistoryResponse) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityLifecycleState.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityLifecycleState.md new file mode 100644 index 000000000..ac862838d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityLifecycleState.md @@ -0,0 +1,80 @@ +--- +id: beta-identity-lifecycle-state +title: IdentityLifecycleState +pagination_label: IdentityLifecycleState +sidebar_label: IdentityLifecycleState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityLifecycleState', 'BetaIdentityLifecycleState'] +slug: /tools/sdk/go/beta/models/identity-lifecycle-state +tags: ['SDK', 'Software Development Kit', 'IdentityLifecycleState', 'BetaIdentityLifecycleState'] +--- + +# IdentityLifecycleState + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**StateName** | **string** | The name of the lifecycle state | +**ManuallyUpdated** | **bool** | Whether the lifecycle state has been manually or automatically set | + +## Methods + +### NewIdentityLifecycleState + +`func NewIdentityLifecycleState(stateName string, manuallyUpdated bool, ) *IdentityLifecycleState` + +NewIdentityLifecycleState instantiates a new IdentityLifecycleState 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 + +### NewIdentityLifecycleStateWithDefaults + +`func NewIdentityLifecycleStateWithDefaults() *IdentityLifecycleState` + +NewIdentityLifecycleStateWithDefaults instantiates a new IdentityLifecycleState 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 + +### GetStateName + +`func (o *IdentityLifecycleState) GetStateName() string` + +GetStateName returns the StateName field if non-nil, zero value otherwise. + +### GetStateNameOk + +`func (o *IdentityLifecycleState) GetStateNameOk() (*string, bool)` + +GetStateNameOk returns a tuple with the StateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStateName + +`func (o *IdentityLifecycleState) SetStateName(v string)` + +SetStateName sets StateName field to given value. + + +### GetManuallyUpdated + +`func (o *IdentityLifecycleState) GetManuallyUpdated() bool` + +GetManuallyUpdated returns the ManuallyUpdated field if non-nil, zero value otherwise. + +### GetManuallyUpdatedOk + +`func (o *IdentityLifecycleState) GetManuallyUpdatedOk() (*bool, bool)` + +GetManuallyUpdatedOk returns a tuple with the ManuallyUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyUpdated + +`func (o *IdentityLifecycleState) SetManuallyUpdated(v bool)` + +SetManuallyUpdated sets ManuallyUpdated field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityListItem.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityListItem.md new file mode 100644 index 000000000..a1a753104 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityListItem.md @@ -0,0 +1,224 @@ +--- +id: beta-identity-list-item +title: IdentityListItem +pagination_label: IdentityListItem +sidebar_label: IdentityListItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityListItem', 'BetaIdentityListItem'] +slug: /tools/sdk/go/beta/models/identity-list-item +tags: ['SDK', 'Software Development Kit', 'IdentityListItem', 'BetaIdentityListItem'] +--- + +# IdentityListItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the identity ID | [optional] +**DisplayName** | Pointer to **string** | the display name of the identity | [optional] +**FirstName** | Pointer to **NullableString** | the first name of the identity | [optional] +**LastName** | Pointer to **NullableString** | the last name of the identity | [optional] +**Active** | Pointer to **bool** | indicates if an identity is active or not | [optional] [default to true] +**DeletedDate** | Pointer to **NullableString** | the date when the identity was deleted | [optional] + +## Methods + +### NewIdentityListItem + +`func NewIdentityListItem() *IdentityListItem` + +NewIdentityListItem instantiates a new IdentityListItem 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 + +### NewIdentityListItemWithDefaults + +`func NewIdentityListItemWithDefaults() *IdentityListItem` + +NewIdentityListItemWithDefaults instantiates a new IdentityListItem 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 + +### GetId + +`func (o *IdentityListItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityListItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityListItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityListItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *IdentityListItem) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityListItem) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityListItem) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityListItem) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *IdentityListItem) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *IdentityListItem) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *IdentityListItem) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *IdentityListItem) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### SetFirstNameNil + +`func (o *IdentityListItem) SetFirstNameNil(b bool)` + + SetFirstNameNil sets the value for FirstName to be an explicit nil + +### UnsetFirstName +`func (o *IdentityListItem) UnsetFirstName()` + +UnsetFirstName ensures that no value is present for FirstName, not even an explicit nil +### GetLastName + +`func (o *IdentityListItem) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *IdentityListItem) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *IdentityListItem) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *IdentityListItem) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### SetLastNameNil + +`func (o *IdentityListItem) SetLastNameNil(b bool)` + + SetLastNameNil sets the value for LastName to be an explicit nil + +### UnsetLastName +`func (o *IdentityListItem) UnsetLastName()` + +UnsetLastName ensures that no value is present for LastName, not even an explicit nil +### GetActive + +`func (o *IdentityListItem) GetActive() bool` + +GetActive returns the Active field if non-nil, zero value otherwise. + +### GetActiveOk + +`func (o *IdentityListItem) GetActiveOk() (*bool, bool)` + +GetActiveOk returns a tuple with the Active field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActive + +`func (o *IdentityListItem) SetActive(v bool)` + +SetActive sets Active field to given value. + +### HasActive + +`func (o *IdentityListItem) HasActive() bool` + +HasActive returns a boolean if a field has been set. + +### GetDeletedDate + +`func (o *IdentityListItem) GetDeletedDate() string` + +GetDeletedDate returns the DeletedDate field if non-nil, zero value otherwise. + +### GetDeletedDateOk + +`func (o *IdentityListItem) GetDeletedDateOk() (*string, bool)` + +GetDeletedDateOk returns a tuple with the DeletedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeletedDate + +`func (o *IdentityListItem) SetDeletedDate(v string)` + +SetDeletedDate sets DeletedDate field to given value. + +### HasDeletedDate + +`func (o *IdentityListItem) HasDeletedDate() bool` + +HasDeletedDate returns a boolean if a field has been set. + +### SetDeletedDateNil + +`func (o *IdentityListItem) SetDeletedDateNil(b bool)` + + SetDeletedDateNil sets the value for DeletedDate to be an explicit nil + +### UnsetDeletedDate +`func (o *IdentityListItem) UnsetDeletedDate()` + +UnsetDeletedDate ensures that no value is present for DeletedDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityManagerRef.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityManagerRef.md new file mode 100644 index 000000000..fef0cb2db --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityManagerRef.md @@ -0,0 +1,116 @@ +--- +id: beta-identity-manager-ref +title: IdentityManagerRef +pagination_label: IdentityManagerRef +sidebar_label: IdentityManagerRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityManagerRef', 'BetaIdentityManagerRef'] +slug: /tools/sdk/go/beta/models/identity-manager-ref +tags: ['SDK', 'Software Development Kit', 'IdentityManagerRef', 'BetaIdentityManagerRef'] +--- + +# IdentityManagerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity's manager | [optional] +**Id** | Pointer to **string** | ID of identity's manager | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity's manager | [optional] + +## Methods + +### NewIdentityManagerRef + +`func NewIdentityManagerRef() *IdentityManagerRef` + +NewIdentityManagerRef instantiates a new IdentityManagerRef 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 + +### NewIdentityManagerRefWithDefaults + +`func NewIdentityManagerRefWithDefaults() *IdentityManagerRef` + +NewIdentityManagerRefWithDefaults instantiates a new IdentityManagerRef 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 + +### GetType + +`func (o *IdentityManagerRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityManagerRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityManagerRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityManagerRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityManagerRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityManagerRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityManagerRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityManagerRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityManagerRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityManagerRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityManagerRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityManagerRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityOwnershipAssociationDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityOwnershipAssociationDetails.md new file mode 100644 index 000000000..6a303faea --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityOwnershipAssociationDetails.md @@ -0,0 +1,64 @@ +--- +id: beta-identity-ownership-association-details +title: IdentityOwnershipAssociationDetails +pagination_label: IdentityOwnershipAssociationDetails +sidebar_label: IdentityOwnershipAssociationDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityOwnershipAssociationDetails', 'BetaIdentityOwnershipAssociationDetails'] +slug: /tools/sdk/go/beta/models/identity-ownership-association-details +tags: ['SDK', 'Software Development Kit', 'IdentityOwnershipAssociationDetails', 'BetaIdentityOwnershipAssociationDetails'] +--- + +# IdentityOwnershipAssociationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssociationDetails** | Pointer to [**[]IdentityOwnershipAssociationDetailsAssociationDetailsInner**](identity-ownership-association-details-association-details-inner) | list of all the resource associations for the identity | [optional] + +## Methods + +### NewIdentityOwnershipAssociationDetails + +`func NewIdentityOwnershipAssociationDetails() *IdentityOwnershipAssociationDetails` + +NewIdentityOwnershipAssociationDetails instantiates a new IdentityOwnershipAssociationDetails 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 + +### NewIdentityOwnershipAssociationDetailsWithDefaults + +`func NewIdentityOwnershipAssociationDetailsWithDefaults() *IdentityOwnershipAssociationDetails` + +NewIdentityOwnershipAssociationDetailsWithDefaults instantiates a new IdentityOwnershipAssociationDetails 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 + +### GetAssociationDetails + +`func (o *IdentityOwnershipAssociationDetails) GetAssociationDetails() []IdentityOwnershipAssociationDetailsAssociationDetailsInner` + +GetAssociationDetails returns the AssociationDetails field if non-nil, zero value otherwise. + +### GetAssociationDetailsOk + +`func (o *IdentityOwnershipAssociationDetails) GetAssociationDetailsOk() (*[]IdentityOwnershipAssociationDetailsAssociationDetailsInner, bool)` + +GetAssociationDetailsOk returns a tuple with the AssociationDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociationDetails + +`func (o *IdentityOwnershipAssociationDetails) SetAssociationDetails(v []IdentityOwnershipAssociationDetailsAssociationDetailsInner)` + +SetAssociationDetails sets AssociationDetails field to given value. + +### HasAssociationDetails + +`func (o *IdentityOwnershipAssociationDetails) HasAssociationDetails() bool` + +HasAssociationDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md new file mode 100644 index 000000000..eeb83c763 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md @@ -0,0 +1,90 @@ +--- +id: beta-identity-ownership-association-details-association-details-inner +title: IdentityOwnershipAssociationDetailsAssociationDetailsInner +pagination_label: IdentityOwnershipAssociationDetailsAssociationDetailsInner +sidebar_label: IdentityOwnershipAssociationDetailsAssociationDetailsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityOwnershipAssociationDetailsAssociationDetailsInner', 'BetaIdentityOwnershipAssociationDetailsAssociationDetailsInner'] +slug: /tools/sdk/go/beta/models/identity-ownership-association-details-association-details-inner +tags: ['SDK', 'Software Development Kit', 'IdentityOwnershipAssociationDetailsAssociationDetailsInner', 'BetaIdentityOwnershipAssociationDetailsAssociationDetailsInner'] +--- + +# IdentityOwnershipAssociationDetailsAssociationDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssociationType** | Pointer to **string** | association type with the identity | [optional] +**Entities** | Pointer to [**[]IdentityEntities**](identity-entities) | the specific resource this identity has ownership on | [optional] + +## Methods + +### NewIdentityOwnershipAssociationDetailsAssociationDetailsInner + +`func NewIdentityOwnershipAssociationDetailsAssociationDetailsInner() *IdentityOwnershipAssociationDetailsAssociationDetailsInner` + +NewIdentityOwnershipAssociationDetailsAssociationDetailsInner instantiates a new IdentityOwnershipAssociationDetailsAssociationDetailsInner 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 + +### NewIdentityOwnershipAssociationDetailsAssociationDetailsInnerWithDefaults + +`func NewIdentityOwnershipAssociationDetailsAssociationDetailsInnerWithDefaults() *IdentityOwnershipAssociationDetailsAssociationDetailsInner` + +NewIdentityOwnershipAssociationDetailsAssociationDetailsInnerWithDefaults instantiates a new IdentityOwnershipAssociationDetailsAssociationDetailsInner 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 + +### GetAssociationType + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) GetAssociationType() string` + +GetAssociationType returns the AssociationType field if non-nil, zero value otherwise. + +### GetAssociationTypeOk + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) GetAssociationTypeOk() (*string, bool)` + +GetAssociationTypeOk returns a tuple with the AssociationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociationType + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) SetAssociationType(v string)` + +SetAssociationType sets AssociationType field to given value. + +### HasAssociationType + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) HasAssociationType() bool` + +HasAssociationType returns a boolean if a field has been set. + +### GetEntities + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) GetEntities() []IdentityEntities` + +GetEntities returns the Entities field if non-nil, zero value otherwise. + +### GetEntitiesOk + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) GetEntitiesOk() (*[]IdentityEntities, bool)` + +GetEntitiesOk returns a tuple with the Entities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntities + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) SetEntities(v []IdentityEntities)` + +SetEntities sets Entities field to given value. + +### HasEntities + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) HasEntities() bool` + +HasEntities returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityPreviewRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityPreviewRequest.md new file mode 100644 index 000000000..026dfd3b7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityPreviewRequest.md @@ -0,0 +1,90 @@ +--- +id: beta-identity-preview-request +title: IdentityPreviewRequest +pagination_label: IdentityPreviewRequest +sidebar_label: IdentityPreviewRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityPreviewRequest', 'BetaIdentityPreviewRequest'] +slug: /tools/sdk/go/beta/models/identity-preview-request +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewRequest', 'BetaIdentityPreviewRequest'] +--- + +# IdentityPreviewRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | | [optional] +**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] + +## Methods + +### NewIdentityPreviewRequest + +`func NewIdentityPreviewRequest() *IdentityPreviewRequest` + +NewIdentityPreviewRequest instantiates a new IdentityPreviewRequest 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 + +### NewIdentityPreviewRequestWithDefaults + +`func NewIdentityPreviewRequestWithDefaults() *IdentityPreviewRequest` + +NewIdentityPreviewRequestWithDefaults instantiates a new IdentityPreviewRequest 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 + +### GetIdentityId + +`func (o *IdentityPreviewRequest) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *IdentityPreviewRequest) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *IdentityPreviewRequest) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *IdentityPreviewRequest) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetIdentityAttributeConfig + +`func (o *IdentityPreviewRequest) GetIdentityAttributeConfig() IdentityAttributeConfig` + +GetIdentityAttributeConfig returns the IdentityAttributeConfig field if non-nil, zero value otherwise. + +### GetIdentityAttributeConfigOk + +`func (o *IdentityPreviewRequest) GetIdentityAttributeConfigOk() (*IdentityAttributeConfig, bool)` + +GetIdentityAttributeConfigOk returns a tuple with the IdentityAttributeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeConfig + +`func (o *IdentityPreviewRequest) SetIdentityAttributeConfig(v IdentityAttributeConfig)` + +SetIdentityAttributeConfig sets IdentityAttributeConfig field to given value. + +### HasIdentityAttributeConfig + +`func (o *IdentityPreviewRequest) HasIdentityAttributeConfig() bool` + +HasIdentityAttributeConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityPreviewResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityPreviewResponse.md new file mode 100644 index 000000000..bf082838a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityPreviewResponse.md @@ -0,0 +1,90 @@ +--- +id: beta-identity-preview-response +title: IdentityPreviewResponse +pagination_label: IdentityPreviewResponse +sidebar_label: IdentityPreviewResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityPreviewResponse', 'BetaIdentityPreviewResponse'] +slug: /tools/sdk/go/beta/models/identity-preview-response +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponse', 'BetaIdentityPreviewResponse'] +--- + +# IdentityPreviewResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**IdentityPreviewResponseIdentity**](identity-preview-response-identity) | | [optional] +**PreviewAttributes** | Pointer to [**[]IdentityAttributePreview**](identity-attribute-preview) | | [optional] + +## Methods + +### NewIdentityPreviewResponse + +`func NewIdentityPreviewResponse() *IdentityPreviewResponse` + +NewIdentityPreviewResponse instantiates a new IdentityPreviewResponse 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 + +### NewIdentityPreviewResponseWithDefaults + +`func NewIdentityPreviewResponseWithDefaults() *IdentityPreviewResponse` + +NewIdentityPreviewResponseWithDefaults instantiates a new IdentityPreviewResponse 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 + +### GetIdentity + +`func (o *IdentityPreviewResponse) GetIdentity() IdentityPreviewResponseIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *IdentityPreviewResponse) GetIdentityOk() (*IdentityPreviewResponseIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *IdentityPreviewResponse) SetIdentity(v IdentityPreviewResponseIdentity)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *IdentityPreviewResponse) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetPreviewAttributes + +`func (o *IdentityPreviewResponse) GetPreviewAttributes() []IdentityAttributePreview` + +GetPreviewAttributes returns the PreviewAttributes field if non-nil, zero value otherwise. + +### GetPreviewAttributesOk + +`func (o *IdentityPreviewResponse) GetPreviewAttributesOk() (*[]IdentityAttributePreview, bool)` + +GetPreviewAttributesOk returns a tuple with the PreviewAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviewAttributes + +`func (o *IdentityPreviewResponse) SetPreviewAttributes(v []IdentityAttributePreview)` + +SetPreviewAttributes sets PreviewAttributes field to given value. + +### HasPreviewAttributes + +`func (o *IdentityPreviewResponse) HasPreviewAttributes() bool` + +HasPreviewAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityPreviewResponseIdentity.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityPreviewResponseIdentity.md new file mode 100644 index 000000000..bebf765a7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityPreviewResponseIdentity.md @@ -0,0 +1,116 @@ +--- +id: beta-identity-preview-response-identity +title: IdentityPreviewResponseIdentity +pagination_label: IdentityPreviewResponseIdentity +sidebar_label: IdentityPreviewResponseIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityPreviewResponseIdentity', 'BetaIdentityPreviewResponseIdentity'] +slug: /tools/sdk/go/beta/models/identity-preview-response-identity +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponseIdentity', 'BetaIdentityPreviewResponseIdentity'] +--- + +# IdentityPreviewResponseIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity's manager. | [optional] +**Id** | Pointer to **string** | ID of identity's manager. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity's manager. | [optional] + +## Methods + +### NewIdentityPreviewResponseIdentity + +`func NewIdentityPreviewResponseIdentity() *IdentityPreviewResponseIdentity` + +NewIdentityPreviewResponseIdentity instantiates a new IdentityPreviewResponseIdentity 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 + +### NewIdentityPreviewResponseIdentityWithDefaults + +`func NewIdentityPreviewResponseIdentityWithDefaults() *IdentityPreviewResponseIdentity` + +NewIdentityPreviewResponseIdentityWithDefaults instantiates a new IdentityPreviewResponseIdentity 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 + +### GetType + +`func (o *IdentityPreviewResponseIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityPreviewResponseIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityPreviewResponseIdentity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityPreviewResponseIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityPreviewResponseIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityPreviewResponseIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityPreviewResponseIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityPreviewResponseIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityPreviewResponseIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityPreviewResponseIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityPreviewResponseIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityPreviewResponseIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfile.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfile.md new file mode 100644 index 000000000..0a16822b6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfile.md @@ -0,0 +1,406 @@ +--- +id: beta-identity-profile +title: IdentityProfile +pagination_label: IdentityProfile +sidebar_label: IdentityProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfile', 'BetaIdentityProfile'] +slug: /tools/sdk/go/beta/models/identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityProfile', 'BetaIdentityProfile'] +--- + +# IdentityProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Description** | Pointer to **NullableString** | Identity profile's description. | [optional] +**Owner** | Pointer to [**NullableIdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] +**Priority** | Pointer to **int64** | Identity profile's priority. | [optional] +**AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | +**IdentityRefreshRequired** | Pointer to **bool** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to false] +**IdentityCount** | Pointer to **int32** | Number of identities belonging to the identity profile. | [optional] +**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] +**IdentityExceptionReportReference** | Pointer to [**NullableIdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] +**HasTimeBasedAttr** | Pointer to **bool** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to true] + +## Methods + +### NewIdentityProfile + +`func NewIdentityProfile(name NullableString, authoritativeSource IdentityProfileAllOfAuthoritativeSource, ) *IdentityProfile` + +NewIdentityProfile instantiates a new IdentityProfile 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 + +### NewIdentityProfileWithDefaults + +`func NewIdentityProfileWithDefaults() *IdentityProfile` + +NewIdentityProfileWithDefaults instantiates a new IdentityProfile 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 + +### GetId + +`func (o *IdentityProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfile) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *IdentityProfile) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *IdentityProfile) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *IdentityProfile) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *IdentityProfile) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *IdentityProfile) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *IdentityProfile) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *IdentityProfile) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *IdentityProfile) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *IdentityProfile) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *IdentityProfile) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *IdentityProfile) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *IdentityProfile) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *IdentityProfile) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *IdentityProfile) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *IdentityProfile) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *IdentityProfile) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwner + +`func (o *IdentityProfile) GetOwner() IdentityProfileAllOfOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *IdentityProfile) GetOwnerOk() (*IdentityProfileAllOfOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *IdentityProfile) SetOwner(v IdentityProfileAllOfOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *IdentityProfile) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *IdentityProfile) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *IdentityProfile) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetPriority + +`func (o *IdentityProfile) GetPriority() int64` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *IdentityProfile) GetPriorityOk() (*int64, 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 *IdentityProfile) SetPriority(v int64)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *IdentityProfile) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetAuthoritativeSource + +`func (o *IdentityProfile) GetAuthoritativeSource() IdentityProfileAllOfAuthoritativeSource` + +GetAuthoritativeSource returns the AuthoritativeSource field if non-nil, zero value otherwise. + +### GetAuthoritativeSourceOk + +`func (o *IdentityProfile) GetAuthoritativeSourceOk() (*IdentityProfileAllOfAuthoritativeSource, bool)` + +GetAuthoritativeSourceOk returns a tuple with the AuthoritativeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritativeSource + +`func (o *IdentityProfile) SetAuthoritativeSource(v IdentityProfileAllOfAuthoritativeSource)` + +SetAuthoritativeSource sets AuthoritativeSource field to given value. + + +### GetIdentityRefreshRequired + +`func (o *IdentityProfile) GetIdentityRefreshRequired() bool` + +GetIdentityRefreshRequired returns the IdentityRefreshRequired field if non-nil, zero value otherwise. + +### GetIdentityRefreshRequiredOk + +`func (o *IdentityProfile) GetIdentityRefreshRequiredOk() (*bool, bool)` + +GetIdentityRefreshRequiredOk returns a tuple with the IdentityRefreshRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityRefreshRequired + +`func (o *IdentityProfile) SetIdentityRefreshRequired(v bool)` + +SetIdentityRefreshRequired sets IdentityRefreshRequired field to given value. + +### HasIdentityRefreshRequired + +`func (o *IdentityProfile) HasIdentityRefreshRequired() bool` + +HasIdentityRefreshRequired returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *IdentityProfile) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *IdentityProfile) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *IdentityProfile) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *IdentityProfile) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetIdentityAttributeConfig + +`func (o *IdentityProfile) GetIdentityAttributeConfig() IdentityAttributeConfig` + +GetIdentityAttributeConfig returns the IdentityAttributeConfig field if non-nil, zero value otherwise. + +### GetIdentityAttributeConfigOk + +`func (o *IdentityProfile) GetIdentityAttributeConfigOk() (*IdentityAttributeConfig, bool)` + +GetIdentityAttributeConfigOk returns a tuple with the IdentityAttributeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeConfig + +`func (o *IdentityProfile) SetIdentityAttributeConfig(v IdentityAttributeConfig)` + +SetIdentityAttributeConfig sets IdentityAttributeConfig field to given value. + +### HasIdentityAttributeConfig + +`func (o *IdentityProfile) HasIdentityAttributeConfig() bool` + +HasIdentityAttributeConfig returns a boolean if a field has been set. + +### GetIdentityExceptionReportReference + +`func (o *IdentityProfile) GetIdentityExceptionReportReference() IdentityExceptionReportReference` + +GetIdentityExceptionReportReference returns the IdentityExceptionReportReference field if non-nil, zero value otherwise. + +### GetIdentityExceptionReportReferenceOk + +`func (o *IdentityProfile) GetIdentityExceptionReportReferenceOk() (*IdentityExceptionReportReference, bool)` + +GetIdentityExceptionReportReferenceOk returns a tuple with the IdentityExceptionReportReference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityExceptionReportReference + +`func (o *IdentityProfile) SetIdentityExceptionReportReference(v IdentityExceptionReportReference)` + +SetIdentityExceptionReportReference sets IdentityExceptionReportReference field to given value. + +### HasIdentityExceptionReportReference + +`func (o *IdentityProfile) HasIdentityExceptionReportReference() bool` + +HasIdentityExceptionReportReference returns a boolean if a field has been set. + +### SetIdentityExceptionReportReferenceNil + +`func (o *IdentityProfile) SetIdentityExceptionReportReferenceNil(b bool)` + + SetIdentityExceptionReportReferenceNil sets the value for IdentityExceptionReportReference to be an explicit nil + +### UnsetIdentityExceptionReportReference +`func (o *IdentityProfile) UnsetIdentityExceptionReportReference()` + +UnsetIdentityExceptionReportReference ensures that no value is present for IdentityExceptionReportReference, not even an explicit nil +### GetHasTimeBasedAttr + +`func (o *IdentityProfile) GetHasTimeBasedAttr() bool` + +GetHasTimeBasedAttr returns the HasTimeBasedAttr field if non-nil, zero value otherwise. + +### GetHasTimeBasedAttrOk + +`func (o *IdentityProfile) GetHasTimeBasedAttrOk() (*bool, bool)` + +GetHasTimeBasedAttrOk returns a tuple with the HasTimeBasedAttr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasTimeBasedAttr + +`func (o *IdentityProfile) SetHasTimeBasedAttr(v bool)` + +SetHasTimeBasedAttr sets HasTimeBasedAttr field to given value. + +### HasHasTimeBasedAttr + +`func (o *IdentityProfile) HasHasTimeBasedAttr() bool` + +HasHasTimeBasedAttr returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfile1.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfile1.md new file mode 100644 index 000000000..bd4f85c50 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfile1.md @@ -0,0 +1,406 @@ +--- +id: beta-identity-profile1 +title: IdentityProfile1 +pagination_label: IdentityProfile1 +sidebar_label: IdentityProfile1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfile1', 'BetaIdentityProfile1'] +slug: /tools/sdk/go/beta/models/identity-profile1 +tags: ['SDK', 'Software Development Kit', 'IdentityProfile1', 'BetaIdentityProfile1'] +--- + +# IdentityProfile1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Description** | Pointer to **NullableString** | Identity profile's description. | [optional] +**Owner** | Pointer to [**NullableIdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] +**Priority** | Pointer to **int64** | Identity profile's priority. | [optional] +**AuthoritativeSource** | [**IdentityProfile1AllOfAuthoritativeSource**](identity-profile1-all-of-authoritative-source) | | +**IdentityRefreshRequired** | Pointer to **bool** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to false] +**IdentityCount** | Pointer to **int32** | Number of identities belonging to the identity profile. | [optional] +**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig1**](identity-attribute-config1) | | [optional] +**IdentityExceptionReportReference** | Pointer to [**NullableIdentityExceptionReportReference1**](identity-exception-report-reference1) | | [optional] +**HasTimeBasedAttr** | Pointer to **bool** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to false] + +## Methods + +### NewIdentityProfile1 + +`func NewIdentityProfile1(name NullableString, authoritativeSource IdentityProfile1AllOfAuthoritativeSource, ) *IdentityProfile1` + +NewIdentityProfile1 instantiates a new IdentityProfile1 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 + +### NewIdentityProfile1WithDefaults + +`func NewIdentityProfile1WithDefaults() *IdentityProfile1` + +NewIdentityProfile1WithDefaults instantiates a new IdentityProfile1 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 + +### GetId + +`func (o *IdentityProfile1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfile1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfile1) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfile1) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfile1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfile1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfile1) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *IdentityProfile1) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *IdentityProfile1) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *IdentityProfile1) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *IdentityProfile1) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *IdentityProfile1) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *IdentityProfile1) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *IdentityProfile1) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *IdentityProfile1) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *IdentityProfile1) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *IdentityProfile1) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *IdentityProfile1) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *IdentityProfile1) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *IdentityProfile1) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *IdentityProfile1) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *IdentityProfile1) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *IdentityProfile1) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwner + +`func (o *IdentityProfile1) GetOwner() IdentityProfileAllOfOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *IdentityProfile1) GetOwnerOk() (*IdentityProfileAllOfOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *IdentityProfile1) SetOwner(v IdentityProfileAllOfOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *IdentityProfile1) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *IdentityProfile1) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *IdentityProfile1) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetPriority + +`func (o *IdentityProfile1) GetPriority() int64` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *IdentityProfile1) GetPriorityOk() (*int64, 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 *IdentityProfile1) SetPriority(v int64)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *IdentityProfile1) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetAuthoritativeSource + +`func (o *IdentityProfile1) GetAuthoritativeSource() IdentityProfile1AllOfAuthoritativeSource` + +GetAuthoritativeSource returns the AuthoritativeSource field if non-nil, zero value otherwise. + +### GetAuthoritativeSourceOk + +`func (o *IdentityProfile1) GetAuthoritativeSourceOk() (*IdentityProfile1AllOfAuthoritativeSource, bool)` + +GetAuthoritativeSourceOk returns a tuple with the AuthoritativeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritativeSource + +`func (o *IdentityProfile1) SetAuthoritativeSource(v IdentityProfile1AllOfAuthoritativeSource)` + +SetAuthoritativeSource sets AuthoritativeSource field to given value. + + +### GetIdentityRefreshRequired + +`func (o *IdentityProfile1) GetIdentityRefreshRequired() bool` + +GetIdentityRefreshRequired returns the IdentityRefreshRequired field if non-nil, zero value otherwise. + +### GetIdentityRefreshRequiredOk + +`func (o *IdentityProfile1) GetIdentityRefreshRequiredOk() (*bool, bool)` + +GetIdentityRefreshRequiredOk returns a tuple with the IdentityRefreshRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityRefreshRequired + +`func (o *IdentityProfile1) SetIdentityRefreshRequired(v bool)` + +SetIdentityRefreshRequired sets IdentityRefreshRequired field to given value. + +### HasIdentityRefreshRequired + +`func (o *IdentityProfile1) HasIdentityRefreshRequired() bool` + +HasIdentityRefreshRequired returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *IdentityProfile1) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *IdentityProfile1) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *IdentityProfile1) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *IdentityProfile1) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetIdentityAttributeConfig + +`func (o *IdentityProfile1) GetIdentityAttributeConfig() IdentityAttributeConfig1` + +GetIdentityAttributeConfig returns the IdentityAttributeConfig field if non-nil, zero value otherwise. + +### GetIdentityAttributeConfigOk + +`func (o *IdentityProfile1) GetIdentityAttributeConfigOk() (*IdentityAttributeConfig1, bool)` + +GetIdentityAttributeConfigOk returns a tuple with the IdentityAttributeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeConfig + +`func (o *IdentityProfile1) SetIdentityAttributeConfig(v IdentityAttributeConfig1)` + +SetIdentityAttributeConfig sets IdentityAttributeConfig field to given value. + +### HasIdentityAttributeConfig + +`func (o *IdentityProfile1) HasIdentityAttributeConfig() bool` + +HasIdentityAttributeConfig returns a boolean if a field has been set. + +### GetIdentityExceptionReportReference + +`func (o *IdentityProfile1) GetIdentityExceptionReportReference() IdentityExceptionReportReference1` + +GetIdentityExceptionReportReference returns the IdentityExceptionReportReference field if non-nil, zero value otherwise. + +### GetIdentityExceptionReportReferenceOk + +`func (o *IdentityProfile1) GetIdentityExceptionReportReferenceOk() (*IdentityExceptionReportReference1, bool)` + +GetIdentityExceptionReportReferenceOk returns a tuple with the IdentityExceptionReportReference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityExceptionReportReference + +`func (o *IdentityProfile1) SetIdentityExceptionReportReference(v IdentityExceptionReportReference1)` + +SetIdentityExceptionReportReference sets IdentityExceptionReportReference field to given value. + +### HasIdentityExceptionReportReference + +`func (o *IdentityProfile1) HasIdentityExceptionReportReference() bool` + +HasIdentityExceptionReportReference returns a boolean if a field has been set. + +### SetIdentityExceptionReportReferenceNil + +`func (o *IdentityProfile1) SetIdentityExceptionReportReferenceNil(b bool)` + + SetIdentityExceptionReportReferenceNil sets the value for IdentityExceptionReportReference to be an explicit nil + +### UnsetIdentityExceptionReportReference +`func (o *IdentityProfile1) UnsetIdentityExceptionReportReference()` + +UnsetIdentityExceptionReportReference ensures that no value is present for IdentityExceptionReportReference, not even an explicit nil +### GetHasTimeBasedAttr + +`func (o *IdentityProfile1) GetHasTimeBasedAttr() bool` + +GetHasTimeBasedAttr returns the HasTimeBasedAttr field if non-nil, zero value otherwise. + +### GetHasTimeBasedAttrOk + +`func (o *IdentityProfile1) GetHasTimeBasedAttrOk() (*bool, bool)` + +GetHasTimeBasedAttrOk returns a tuple with the HasTimeBasedAttr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasTimeBasedAttr + +`func (o *IdentityProfile1) SetHasTimeBasedAttr(v bool)` + +SetHasTimeBasedAttr sets HasTimeBasedAttr field to given value. + +### HasHasTimeBasedAttr + +`func (o *IdentityProfile1) HasHasTimeBasedAttr() bool` + +HasHasTimeBasedAttr returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md new file mode 100644 index 000000000..dbea3881f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md @@ -0,0 +1,116 @@ +--- +id: beta-identity-profile1-all-of-authoritative-source +title: IdentityProfile1AllOfAuthoritativeSource +pagination_label: IdentityProfile1AllOfAuthoritativeSource +sidebar_label: IdentityProfile1AllOfAuthoritativeSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfile1AllOfAuthoritativeSource', 'BetaIdentityProfile1AllOfAuthoritativeSource'] +slug: /tools/sdk/go/beta/models/identity-profile1-all-of-authoritative-source +tags: ['SDK', 'Software Development Kit', 'IdentityProfile1AllOfAuthoritativeSource', 'BetaIdentityProfile1AllOfAuthoritativeSource'] +--- + +# IdentityProfile1AllOfAuthoritativeSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Authoritative source's object type. | [optional] +**Id** | Pointer to **string** | Authoritative source's ID. | [optional] +**Name** | Pointer to **string** | Authoritative source's name. | [optional] + +## Methods + +### NewIdentityProfile1AllOfAuthoritativeSource + +`func NewIdentityProfile1AllOfAuthoritativeSource() *IdentityProfile1AllOfAuthoritativeSource` + +NewIdentityProfile1AllOfAuthoritativeSource instantiates a new IdentityProfile1AllOfAuthoritativeSource 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 + +### NewIdentityProfile1AllOfAuthoritativeSourceWithDefaults + +`func NewIdentityProfile1AllOfAuthoritativeSourceWithDefaults() *IdentityProfile1AllOfAuthoritativeSource` + +NewIdentityProfile1AllOfAuthoritativeSourceWithDefaults instantiates a new IdentityProfile1AllOfAuthoritativeSource 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 + +### GetType + +`func (o *IdentityProfile1AllOfAuthoritativeSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityProfile1AllOfAuthoritativeSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityProfile1AllOfAuthoritativeSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityProfile1AllOfAuthoritativeSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityProfile1AllOfAuthoritativeSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfile1AllOfAuthoritativeSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfile1AllOfAuthoritativeSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfile1AllOfAuthoritativeSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfile1AllOfAuthoritativeSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfile1AllOfAuthoritativeSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfile1AllOfAuthoritativeSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityProfile1AllOfAuthoritativeSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md new file mode 100644 index 000000000..0fc85abd4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -0,0 +1,116 @@ +--- +id: beta-identity-profile-all-of-authoritative-source +title: IdentityProfileAllOfAuthoritativeSource +pagination_label: IdentityProfileAllOfAuthoritativeSource +sidebar_label: IdentityProfileAllOfAuthoritativeSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileAllOfAuthoritativeSource', 'BetaIdentityProfileAllOfAuthoritativeSource'] +slug: /tools/sdk/go/beta/models/identity-profile-all-of-authoritative-source +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSource', 'BetaIdentityProfileAllOfAuthoritativeSource'] +--- + +# IdentityProfileAllOfAuthoritativeSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Authoritative source's object type. | [optional] +**Id** | Pointer to **string** | Authoritative source's ID. | [optional] +**Name** | Pointer to **string** | Authoritative source's name. | [optional] + +## Methods + +### NewIdentityProfileAllOfAuthoritativeSource + +`func NewIdentityProfileAllOfAuthoritativeSource() *IdentityProfileAllOfAuthoritativeSource` + +NewIdentityProfileAllOfAuthoritativeSource instantiates a new IdentityProfileAllOfAuthoritativeSource 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 + +### NewIdentityProfileAllOfAuthoritativeSourceWithDefaults + +`func NewIdentityProfileAllOfAuthoritativeSourceWithDefaults() *IdentityProfileAllOfAuthoritativeSource` + +NewIdentityProfileAllOfAuthoritativeSourceWithDefaults instantiates a new IdentityProfileAllOfAuthoritativeSource 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 + +### GetType + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityProfileAllOfAuthoritativeSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityProfileAllOfAuthoritativeSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfileAllOfAuthoritativeSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfileAllOfAuthoritativeSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfileAllOfAuthoritativeSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityProfileAllOfAuthoritativeSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfileAllOfOwner.md new file mode 100644 index 000000000..098b3b885 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfileAllOfOwner.md @@ -0,0 +1,116 @@ +--- +id: beta-identity-profile-all-of-owner +title: IdentityProfileAllOfOwner +pagination_label: IdentityProfileAllOfOwner +sidebar_label: IdentityProfileAllOfOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileAllOfOwner', 'BetaIdentityProfileAllOfOwner'] +slug: /tools/sdk/go/beta/models/identity-profile-all-of-owner +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'BetaIdentityProfileAllOfOwner'] +--- + +# IdentityProfileAllOfOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's object type. | [optional] +**Id** | Pointer to **string** | Owner's ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] + +## Methods + +### NewIdentityProfileAllOfOwner + +`func NewIdentityProfileAllOfOwner() *IdentityProfileAllOfOwner` + +NewIdentityProfileAllOfOwner instantiates a new IdentityProfileAllOfOwner 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 + +### NewIdentityProfileAllOfOwnerWithDefaults + +`func NewIdentityProfileAllOfOwnerWithDefaults() *IdentityProfileAllOfOwner` + +NewIdentityProfileAllOfOwnerWithDefaults instantiates a new IdentityProfileAllOfOwner 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 + +### GetType + +`func (o *IdentityProfileAllOfOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityProfileAllOfOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityProfileAllOfOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityProfileAllOfOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityProfileAllOfOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfileAllOfOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfileAllOfOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfileAllOfOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfileAllOfOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfileAllOfOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfileAllOfOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityProfileAllOfOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfileExportedObject.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfileExportedObject.md new file mode 100644 index 000000000..6b89c7c28 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityProfileExportedObject.md @@ -0,0 +1,116 @@ +--- +id: beta-identity-profile-exported-object +title: IdentityProfileExportedObject +pagination_label: IdentityProfileExportedObject +sidebar_label: IdentityProfileExportedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileExportedObject', 'BetaIdentityProfileExportedObject'] +slug: /tools/sdk/go/beta/models/identity-profile-exported-object +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObject', 'BetaIdentityProfileExportedObject'] +--- + +# IdentityProfileExportedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **int32** | Version or object from the target service. | [optional] +**Self** | Pointer to [**SelfImportExportDto**](self-import-export-dto) | | [optional] +**Object** | Pointer to [**IdentityProfile1**](identity-profile1) | | [optional] + +## Methods + +### NewIdentityProfileExportedObject + +`func NewIdentityProfileExportedObject() *IdentityProfileExportedObject` + +NewIdentityProfileExportedObject instantiates a new IdentityProfileExportedObject 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 + +### NewIdentityProfileExportedObjectWithDefaults + +`func NewIdentityProfileExportedObjectWithDefaults() *IdentityProfileExportedObject` + +NewIdentityProfileExportedObjectWithDefaults instantiates a new IdentityProfileExportedObject 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 + +### GetVersion + +`func (o *IdentityProfileExportedObject) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *IdentityProfileExportedObject) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *IdentityProfileExportedObject) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *IdentityProfileExportedObject) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### GetSelf + +`func (o *IdentityProfileExportedObject) GetSelf() SelfImportExportDto` + +GetSelf returns the Self field if non-nil, zero value otherwise. + +### GetSelfOk + +`func (o *IdentityProfileExportedObject) GetSelfOk() (*SelfImportExportDto, bool)` + +GetSelfOk returns a tuple with the Self field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelf + +`func (o *IdentityProfileExportedObject) SetSelf(v SelfImportExportDto)` + +SetSelf sets Self field to given value. + +### HasSelf + +`func (o *IdentityProfileExportedObject) HasSelf() bool` + +HasSelf returns a boolean if a field has been set. + +### GetObject + +`func (o *IdentityProfileExportedObject) GetObject() IdentityProfile1` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *IdentityProfileExportedObject) GetObjectOk() (*IdentityProfile1, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *IdentityProfileExportedObject) SetObject(v IdentityProfile1)` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *IdentityProfileExportedObject) HasObject() bool` + +HasObject returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityReference.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityReference.md new file mode 100644 index 000000000..efcee1764 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityReference.md @@ -0,0 +1,116 @@ +--- +id: beta-identity-reference +title: IdentityReference +pagination_label: IdentityReference +sidebar_label: IdentityReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityReference', 'BetaIdentityReference'] +slug: /tools/sdk/go/beta/models/identity-reference +tags: ['SDK', 'Software Development Kit', 'IdentityReference', 'BetaIdentityReference'] +--- + +# IdentityReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | Identity id | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity. | [optional] + +## Methods + +### NewIdentityReference + +`func NewIdentityReference() *IdentityReference` + +NewIdentityReference instantiates a new IdentityReference 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 + +### NewIdentityReferenceWithDefaults + +`func NewIdentityReferenceWithDefaults() *IdentityReference` + +NewIdentityReferenceWithDefaults instantiates a new IdentityReference 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 + +### GetType + +`func (o *IdentityReference) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityReference) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityReference) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityReference) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityReferenceWithId.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityReferenceWithId.md new file mode 100644 index 000000000..4690ef7c2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityReferenceWithId.md @@ -0,0 +1,90 @@ +--- +id: beta-identity-reference-with-id +title: IdentityReferenceWithId +pagination_label: IdentityReferenceWithId +sidebar_label: IdentityReferenceWithId +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityReferenceWithId', 'BetaIdentityReferenceWithId'] +slug: /tools/sdk/go/beta/models/identity-reference-with-id +tags: ['SDK', 'Software Development Kit', 'IdentityReferenceWithId', 'BetaIdentityReferenceWithId'] +--- + +# IdentityReferenceWithId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | Identity id | [optional] + +## Methods + +### NewIdentityReferenceWithId + +`func NewIdentityReferenceWithId() *IdentityReferenceWithId` + +NewIdentityReferenceWithId instantiates a new IdentityReferenceWithId 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 + +### NewIdentityReferenceWithIdWithDefaults + +`func NewIdentityReferenceWithIdWithDefaults() *IdentityReferenceWithId` + +NewIdentityReferenceWithIdWithDefaults instantiates a new IdentityReferenceWithId 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 + +### GetType + +`func (o *IdentityReferenceWithId) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityReferenceWithId) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityReferenceWithId) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityReferenceWithId) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityReferenceWithId) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityReferenceWithId) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityReferenceWithId) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityReferenceWithId) HasId() bool` + +HasId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityReferenceWithNameAndEmail.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityReferenceWithNameAndEmail.md new file mode 100644 index 000000000..9c137e9b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityReferenceWithNameAndEmail.md @@ -0,0 +1,142 @@ +--- +id: beta-identity-reference-with-name-and-email +title: IdentityReferenceWithNameAndEmail +pagination_label: IdentityReferenceWithNameAndEmail +sidebar_label: IdentityReferenceWithNameAndEmail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityReferenceWithNameAndEmail', 'BetaIdentityReferenceWithNameAndEmail'] +slug: /tools/sdk/go/beta/models/identity-reference-with-name-and-email +tags: ['SDK', 'Software Development Kit', 'IdentityReferenceWithNameAndEmail', 'BetaIdentityReferenceWithNameAndEmail'] +--- + +# IdentityReferenceWithNameAndEmail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type can only be IDENTITY. This is read-only. | [optional] +**Id** | Pointer to **string** | Identity ID. | [optional] +**Name** | Pointer to **string** | Identity's human-readable display name. This is read-only. | [optional] +**Email** | Pointer to **string** | Identity's email address. This is read-only. | [optional] + +## Methods + +### NewIdentityReferenceWithNameAndEmail + +`func NewIdentityReferenceWithNameAndEmail() *IdentityReferenceWithNameAndEmail` + +NewIdentityReferenceWithNameAndEmail instantiates a new IdentityReferenceWithNameAndEmail 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 + +### NewIdentityReferenceWithNameAndEmailWithDefaults + +`func NewIdentityReferenceWithNameAndEmailWithDefaults() *IdentityReferenceWithNameAndEmail` + +NewIdentityReferenceWithNameAndEmailWithDefaults instantiates a new IdentityReferenceWithNameAndEmail 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 + +### GetType + +`func (o *IdentityReferenceWithNameAndEmail) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityReferenceWithNameAndEmail) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityReferenceWithNameAndEmail) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityReferenceWithNameAndEmail) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityReferenceWithNameAndEmail) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityReferenceWithNameAndEmail) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityReferenceWithNameAndEmail) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityReferenceWithNameAndEmail) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityReferenceWithNameAndEmail) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityReferenceWithNameAndEmail) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityReferenceWithNameAndEmail) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityReferenceWithNameAndEmail) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *IdentityReferenceWithNameAndEmail) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *IdentityReferenceWithNameAndEmail) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *IdentityReferenceWithNameAndEmail) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *IdentityReferenceWithNameAndEmail) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentitySnapshotSummaryResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentitySnapshotSummaryResponse.md new file mode 100644 index 000000000..b6bec7fd2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentitySnapshotSummaryResponse.md @@ -0,0 +1,64 @@ +--- +id: beta-identity-snapshot-summary-response +title: IdentitySnapshotSummaryResponse +pagination_label: IdentitySnapshotSummaryResponse +sidebar_label: IdentitySnapshotSummaryResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitySnapshotSummaryResponse', 'BetaIdentitySnapshotSummaryResponse'] +slug: /tools/sdk/go/beta/models/identity-snapshot-summary-response +tags: ['SDK', 'Software Development Kit', 'IdentitySnapshotSummaryResponse', 'BetaIdentitySnapshotSummaryResponse'] +--- + +# IdentitySnapshotSummaryResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Snapshot** | Pointer to **string** | the date when the identity record was created | [optional] + +## Methods + +### NewIdentitySnapshotSummaryResponse + +`func NewIdentitySnapshotSummaryResponse() *IdentitySnapshotSummaryResponse` + +NewIdentitySnapshotSummaryResponse instantiates a new IdentitySnapshotSummaryResponse 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 + +### NewIdentitySnapshotSummaryResponseWithDefaults + +`func NewIdentitySnapshotSummaryResponseWithDefaults() *IdentitySnapshotSummaryResponse` + +NewIdentitySnapshotSummaryResponseWithDefaults instantiates a new IdentitySnapshotSummaryResponse 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 + +### GetSnapshot + +`func (o *IdentitySnapshotSummaryResponse) GetSnapshot() string` + +GetSnapshot returns the Snapshot field if non-nil, zero value otherwise. + +### GetSnapshotOk + +`func (o *IdentitySnapshotSummaryResponse) GetSnapshotOk() (*string, bool)` + +GetSnapshotOk returns a tuple with the Snapshot field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshot + +`func (o *IdentitySnapshotSummaryResponse) SetSnapshot(v string)` + +SetSnapshot sets Snapshot field to given value. + +### HasSnapshot + +`func (o *IdentitySnapshotSummaryResponse) HasSnapshot() bool` + +HasSnapshot returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentitySummary.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentitySummary.md new file mode 100644 index 000000000..13cd027fa --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentitySummary.md @@ -0,0 +1,142 @@ +--- +id: beta-identity-summary +title: IdentitySummary +pagination_label: IdentitySummary +sidebar_label: IdentitySummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitySummary', 'BetaIdentitySummary'] +slug: /tools/sdk/go/beta/models/identity-summary +tags: ['SDK', 'Software Development Kit', 'IdentitySummary', 'BetaIdentitySummary'] +--- + +# IdentitySummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of this identity summary | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity | [optional] +**IdentityId** | Pointer to **string** | ID of the identity that this summary represents | [optional] +**Completed** | Pointer to **bool** | Indicates if all access items for this summary have been decided on | [optional] [default to false] + +## Methods + +### NewIdentitySummary + +`func NewIdentitySummary() *IdentitySummary` + +NewIdentitySummary instantiates a new IdentitySummary 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 + +### NewIdentitySummaryWithDefaults + +`func NewIdentitySummaryWithDefaults() *IdentitySummary` + +NewIdentitySummaryWithDefaults instantiates a new IdentitySummary 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 + +### GetId + +`func (o *IdentitySummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentitySummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentitySummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentitySummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentitySummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentitySummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentitySummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentitySummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *IdentitySummary) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *IdentitySummary) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *IdentitySummary) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *IdentitySummary) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetCompleted + +`func (o *IdentitySummary) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *IdentitySummary) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *IdentitySummary) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *IdentitySummary) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentitySyncJob.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentitySyncJob.md new file mode 100644 index 000000000..3658866d1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentitySyncJob.md @@ -0,0 +1,101 @@ +--- +id: beta-identity-sync-job +title: IdentitySyncJob +pagination_label: IdentitySyncJob +sidebar_label: IdentitySyncJob +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitySyncJob', 'BetaIdentitySyncJob'] +slug: /tools/sdk/go/beta/models/identity-sync-job +tags: ['SDK', 'Software Development Kit', 'IdentitySyncJob', 'BetaIdentitySyncJob'] +--- + +# IdentitySyncJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Job ID. | +**Status** | **string** | The job status. | +**Payload** | [**IdentitySyncPayload**](identity-sync-payload) | | + +## Methods + +### NewIdentitySyncJob + +`func NewIdentitySyncJob(id string, status string, payload IdentitySyncPayload, ) *IdentitySyncJob` + +NewIdentitySyncJob instantiates a new IdentitySyncJob 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 + +### NewIdentitySyncJobWithDefaults + +`func NewIdentitySyncJobWithDefaults() *IdentitySyncJob` + +NewIdentitySyncJobWithDefaults instantiates a new IdentitySyncJob 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 + +### GetId + +`func (o *IdentitySyncJob) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentitySyncJob) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentitySyncJob) SetId(v string)` + +SetId sets Id field to given value. + + +### GetStatus + +`func (o *IdentitySyncJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *IdentitySyncJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *IdentitySyncJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetPayload + +`func (o *IdentitySyncJob) GetPayload() IdentitySyncPayload` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *IdentitySyncJob) GetPayloadOk() (*IdentitySyncPayload, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPayload + +`func (o *IdentitySyncJob) SetPayload(v IdentitySyncPayload)` + +SetPayload sets Payload field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentitySyncPayload.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentitySyncPayload.md new file mode 100644 index 000000000..2e3d6f4f7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentitySyncPayload.md @@ -0,0 +1,80 @@ +--- +id: beta-identity-sync-payload +title: IdentitySyncPayload +pagination_label: IdentitySyncPayload +sidebar_label: IdentitySyncPayload +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitySyncPayload', 'BetaIdentitySyncPayload'] +slug: /tools/sdk/go/beta/models/identity-sync-payload +tags: ['SDK', 'Software Development Kit', 'IdentitySyncPayload', 'BetaIdentitySyncPayload'] +--- + +# IdentitySyncPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Payload type. | +**DataJson** | **string** | Payload type. | + +## Methods + +### NewIdentitySyncPayload + +`func NewIdentitySyncPayload(type_ string, dataJson string, ) *IdentitySyncPayload` + +NewIdentitySyncPayload instantiates a new IdentitySyncPayload 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 + +### NewIdentitySyncPayloadWithDefaults + +`func NewIdentitySyncPayloadWithDefaults() *IdentitySyncPayload` + +NewIdentitySyncPayloadWithDefaults instantiates a new IdentitySyncPayload 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 + +### GetType + +`func (o *IdentitySyncPayload) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentitySyncPayload) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentitySyncPayload) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDataJson + +`func (o *IdentitySyncPayload) GetDataJson() string` + +GetDataJson returns the DataJson field if non-nil, zero value otherwise. + +### GetDataJsonOk + +`func (o *IdentitySyncPayload) GetDataJsonOk() (*string, bool)` + +GetDataJsonOk returns a tuple with the DataJson field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataJson + +`func (o *IdentitySyncPayload) SetDataJson(v string)` + +SetDataJson sets DataJson field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityWithNewAccess.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityWithNewAccess.md new file mode 100644 index 000000000..43221d382 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityWithNewAccess.md @@ -0,0 +1,80 @@ +--- +id: beta-identity-with-new-access +title: IdentityWithNewAccess +pagination_label: IdentityWithNewAccess +sidebar_label: IdentityWithNewAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityWithNewAccess', 'BetaIdentityWithNewAccess'] +slug: /tools/sdk/go/beta/models/identity-with-new-access +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess', 'BetaIdentityWithNewAccess'] +--- + +# IdentityWithNewAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **string** | Identity id to be checked. | +**AccessRefs** | [**[]IdentityWithNewAccessAccessRefsInner**](identity-with-new-access-access-refs-inner) | The list of entitlements to consider for possible violations in a preventive check. | + +## Methods + +### NewIdentityWithNewAccess + +`func NewIdentityWithNewAccess(identityId string, accessRefs []IdentityWithNewAccessAccessRefsInner, ) *IdentityWithNewAccess` + +NewIdentityWithNewAccess instantiates a new IdentityWithNewAccess 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 + +### NewIdentityWithNewAccessWithDefaults + +`func NewIdentityWithNewAccessWithDefaults() *IdentityWithNewAccess` + +NewIdentityWithNewAccessWithDefaults instantiates a new IdentityWithNewAccess 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 + +### GetIdentityId + +`func (o *IdentityWithNewAccess) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *IdentityWithNewAccess) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *IdentityWithNewAccess) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetAccessRefs + +`func (o *IdentityWithNewAccess) GetAccessRefs() []IdentityWithNewAccessAccessRefsInner` + +GetAccessRefs returns the AccessRefs field if non-nil, zero value otherwise. + +### GetAccessRefsOk + +`func (o *IdentityWithNewAccess) GetAccessRefsOk() (*[]IdentityWithNewAccessAccessRefsInner, bool)` + +GetAccessRefsOk returns a tuple with the AccessRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRefs + +`func (o *IdentityWithNewAccess) SetAccessRefs(v []IdentityWithNewAccessAccessRefsInner)` + +SetAccessRefs sets AccessRefs field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/go/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md new file mode 100644 index 000000000..eb1d14799 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md @@ -0,0 +1,116 @@ +--- +id: beta-identity-with-new-access-access-refs-inner +title: IdentityWithNewAccessAccessRefsInner +pagination_label: IdentityWithNewAccessAccessRefsInner +sidebar_label: IdentityWithNewAccessAccessRefsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityWithNewAccessAccessRefsInner', 'BetaIdentityWithNewAccessAccessRefsInner'] +slug: /tools/sdk/go/beta/models/identity-with-new-access-access-refs-inner +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccessAccessRefsInner', 'BetaIdentityWithNewAccessAccessRefsInner'] +--- + +# IdentityWithNewAccessAccessRefsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Entitlement's DTO type. | [optional] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **string** | Entitlement's display name. | [optional] + +## Methods + +### NewIdentityWithNewAccessAccessRefsInner + +`func NewIdentityWithNewAccessAccessRefsInner() *IdentityWithNewAccessAccessRefsInner` + +NewIdentityWithNewAccessAccessRefsInner instantiates a new IdentityWithNewAccessAccessRefsInner 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 + +### NewIdentityWithNewAccessAccessRefsInnerWithDefaults + +`func NewIdentityWithNewAccessAccessRefsInnerWithDefaults() *IdentityWithNewAccessAccessRefsInner` + +NewIdentityWithNewAccessAccessRefsInnerWithDefaults instantiates a new IdentityWithNewAccessAccessRefsInner 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 + +### GetType + +`func (o *IdentityWithNewAccessAccessRefsInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityWithNewAccessAccessRefsInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityWithNewAccessAccessRefsInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityWithNewAccessAccessRefsInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityWithNewAccessAccessRefsInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityWithNewAccessAccessRefsInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityWithNewAccessAccessRefsInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityWithNewAccessAccessRefsInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityWithNewAccessAccessRefsInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityWithNewAccessAccessRefsInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityWithNewAccessAccessRefsInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityWithNewAccessAccessRefsInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ImportAccountsRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/ImportAccountsRequest.md new file mode 100644 index 000000000..64c921902 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ImportAccountsRequest.md @@ -0,0 +1,90 @@ +--- +id: beta-import-accounts-request +title: ImportAccountsRequest +pagination_label: ImportAccountsRequest +sidebar_label: ImportAccountsRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportAccountsRequest', 'BetaImportAccountsRequest'] +slug: /tools/sdk/go/beta/models/import-accounts-request +tags: ['SDK', 'Software Development Kit', 'ImportAccountsRequest', 'BetaImportAccountsRequest'] +--- + +# ImportAccountsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | Pointer to ***os.File** | The CSV file containing the source accounts to aggregate. | [optional] +**DisableOptimization** | Pointer to **string** | Use this flag to reprocess every account whether or not the data has changed. | [optional] + +## Methods + +### NewImportAccountsRequest + +`func NewImportAccountsRequest() *ImportAccountsRequest` + +NewImportAccountsRequest instantiates a new ImportAccountsRequest 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 + +### NewImportAccountsRequestWithDefaults + +`func NewImportAccountsRequestWithDefaults() *ImportAccountsRequest` + +NewImportAccountsRequestWithDefaults instantiates a new ImportAccountsRequest 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 + +### GetFile + +`func (o *ImportAccountsRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *ImportAccountsRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *ImportAccountsRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + +### HasFile + +`func (o *ImportAccountsRequest) HasFile() bool` + +HasFile returns a boolean if a field has been set. + +### GetDisableOptimization + +`func (o *ImportAccountsRequest) GetDisableOptimization() string` + +GetDisableOptimization returns the DisableOptimization field if non-nil, zero value otherwise. + +### GetDisableOptimizationOk + +`func (o *ImportAccountsRequest) GetDisableOptimizationOk() (*string, bool)` + +GetDisableOptimizationOk returns a tuple with the DisableOptimization field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisableOptimization + +`func (o *ImportAccountsRequest) SetDisableOptimization(v string)` + +SetDisableOptimization sets DisableOptimization field to given value. + +### HasDisableOptimization + +`func (o *ImportAccountsRequest) HasDisableOptimization() bool` + +HasDisableOptimization returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ImportAccountsRequest1.md b/docs/tools/sdk/go/Reference/Beta/Models/ImportAccountsRequest1.md new file mode 100644 index 000000000..9bf9d907c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ImportAccountsRequest1.md @@ -0,0 +1,64 @@ +--- +id: beta-import-accounts-request1 +title: ImportAccountsRequest1 +pagination_label: ImportAccountsRequest1 +sidebar_label: ImportAccountsRequest1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportAccountsRequest1', 'BetaImportAccountsRequest1'] +slug: /tools/sdk/go/beta/models/import-accounts-request1 +tags: ['SDK', 'Software Development Kit', 'ImportAccountsRequest1', 'BetaImportAccountsRequest1'] +--- + +# ImportAccountsRequest1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisableOptimization** | Pointer to **string** | Use this flag to reprocess every account whether or not the data has changed. | [optional] + +## Methods + +### NewImportAccountsRequest1 + +`func NewImportAccountsRequest1() *ImportAccountsRequest1` + +NewImportAccountsRequest1 instantiates a new ImportAccountsRequest1 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 + +### NewImportAccountsRequest1WithDefaults + +`func NewImportAccountsRequest1WithDefaults() *ImportAccountsRequest1` + +NewImportAccountsRequest1WithDefaults instantiates a new ImportAccountsRequest1 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 + +### GetDisableOptimization + +`func (o *ImportAccountsRequest1) GetDisableOptimization() string` + +GetDisableOptimization returns the DisableOptimization field if non-nil, zero value otherwise. + +### GetDisableOptimizationOk + +`func (o *ImportAccountsRequest1) GetDisableOptimizationOk() (*string, bool)` + +GetDisableOptimizationOk returns a tuple with the DisableOptimization field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisableOptimization + +`func (o *ImportAccountsRequest1) SetDisableOptimization(v string)` + +SetDisableOptimization sets DisableOptimization field to given value. + +### HasDisableOptimization + +`func (o *ImportAccountsRequest1) HasDisableOptimization() bool` + +HasDisableOptimization returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ImportEntitlementsBySourceRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/ImportEntitlementsBySourceRequest.md new file mode 100644 index 000000000..73d99af46 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ImportEntitlementsBySourceRequest.md @@ -0,0 +1,64 @@ +--- +id: beta-import-entitlements-by-source-request +title: ImportEntitlementsBySourceRequest +pagination_label: ImportEntitlementsBySourceRequest +sidebar_label: ImportEntitlementsBySourceRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportEntitlementsBySourceRequest', 'BetaImportEntitlementsBySourceRequest'] +slug: /tools/sdk/go/beta/models/import-entitlements-by-source-request +tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsBySourceRequest', 'BetaImportEntitlementsBySourceRequest'] +--- + +# ImportEntitlementsBySourceRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CsvFile** | Pointer to ***os.File** | The CSV file containing the source entitlements to aggregate. | [optional] + +## Methods + +### NewImportEntitlementsBySourceRequest + +`func NewImportEntitlementsBySourceRequest() *ImportEntitlementsBySourceRequest` + +NewImportEntitlementsBySourceRequest instantiates a new ImportEntitlementsBySourceRequest 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 + +### NewImportEntitlementsBySourceRequestWithDefaults + +`func NewImportEntitlementsBySourceRequestWithDefaults() *ImportEntitlementsBySourceRequest` + +NewImportEntitlementsBySourceRequestWithDefaults instantiates a new ImportEntitlementsBySourceRequest 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 + +### GetCsvFile + +`func (o *ImportEntitlementsBySourceRequest) GetCsvFile() *os.File` + +GetCsvFile returns the CsvFile field if non-nil, zero value otherwise. + +### GetCsvFileOk + +`func (o *ImportEntitlementsBySourceRequest) GetCsvFileOk() (**os.File, bool)` + +GetCsvFileOk returns a tuple with the CsvFile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCsvFile + +`func (o *ImportEntitlementsBySourceRequest) SetCsvFile(v *os.File)` + +SetCsvFile sets CsvFile field to given value. + +### HasCsvFile + +`func (o *ImportEntitlementsBySourceRequest) HasCsvFile() bool` + +HasCsvFile returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ImportEntitlementsRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/ImportEntitlementsRequest.md new file mode 100644 index 000000000..90dfc603a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ImportEntitlementsRequest.md @@ -0,0 +1,64 @@ +--- +id: beta-import-entitlements-request +title: ImportEntitlementsRequest +pagination_label: ImportEntitlementsRequest +sidebar_label: ImportEntitlementsRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportEntitlementsRequest', 'BetaImportEntitlementsRequest'] +slug: /tools/sdk/go/beta/models/import-entitlements-request +tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsRequest', 'BetaImportEntitlementsRequest'] +--- + +# ImportEntitlementsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | Pointer to ***os.File** | The CSV file containing the source entitlements to aggregate. | [optional] + +## Methods + +### NewImportEntitlementsRequest + +`func NewImportEntitlementsRequest() *ImportEntitlementsRequest` + +NewImportEntitlementsRequest instantiates a new ImportEntitlementsRequest 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 + +### NewImportEntitlementsRequestWithDefaults + +`func NewImportEntitlementsRequestWithDefaults() *ImportEntitlementsRequest` + +NewImportEntitlementsRequestWithDefaults instantiates a new ImportEntitlementsRequest 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 + +### GetFile + +`func (o *ImportEntitlementsRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *ImportEntitlementsRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *ImportEntitlementsRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + +### HasFile + +`func (o *ImportEntitlementsRequest) HasFile() bool` + +HasFile returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ImportFormDefinitions202Response.md b/docs/tools/sdk/go/Reference/Beta/Models/ImportFormDefinitions202Response.md new file mode 100644 index 000000000..bb544b33e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ImportFormDefinitions202Response.md @@ -0,0 +1,142 @@ +--- +id: beta-import-form-definitions202-response +title: ImportFormDefinitions202Response +pagination_label: ImportFormDefinitions202Response +sidebar_label: ImportFormDefinitions202Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportFormDefinitions202Response', 'BetaImportFormDefinitions202Response'] +slug: /tools/sdk/go/beta/models/import-form-definitions202-response +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202Response', 'BetaImportFormDefinitions202Response'] +--- + +# ImportFormDefinitions202Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] +**ImportedObjects** | Pointer to [**[]ExportFormDefinitionsByTenant200ResponseInner**](export-form-definitions-by-tenant200-response-inner) | | [optional] +**Infos** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] +**Warnings** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] + +## Methods + +### NewImportFormDefinitions202Response + +`func NewImportFormDefinitions202Response() *ImportFormDefinitions202Response` + +NewImportFormDefinitions202Response instantiates a new ImportFormDefinitions202Response 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 + +### NewImportFormDefinitions202ResponseWithDefaults + +`func NewImportFormDefinitions202ResponseWithDefaults() *ImportFormDefinitions202Response` + +NewImportFormDefinitions202ResponseWithDefaults instantiates a new ImportFormDefinitions202Response 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 + +### GetErrors + +`func (o *ImportFormDefinitions202Response) GetErrors() []ImportFormDefinitions202ResponseErrorsInner` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *ImportFormDefinitions202Response) GetErrorsOk() (*[]ImportFormDefinitions202ResponseErrorsInner, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *ImportFormDefinitions202Response) SetErrors(v []ImportFormDefinitions202ResponseErrorsInner)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *ImportFormDefinitions202Response) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### GetImportedObjects + +`func (o *ImportFormDefinitions202Response) GetImportedObjects() []ExportFormDefinitionsByTenant200ResponseInner` + +GetImportedObjects returns the ImportedObjects field if non-nil, zero value otherwise. + +### GetImportedObjectsOk + +`func (o *ImportFormDefinitions202Response) GetImportedObjectsOk() (*[]ExportFormDefinitionsByTenant200ResponseInner, bool)` + +GetImportedObjectsOk returns a tuple with the ImportedObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImportedObjects + +`func (o *ImportFormDefinitions202Response) SetImportedObjects(v []ExportFormDefinitionsByTenant200ResponseInner)` + +SetImportedObjects sets ImportedObjects field to given value. + +### HasImportedObjects + +`func (o *ImportFormDefinitions202Response) HasImportedObjects() bool` + +HasImportedObjects returns a boolean if a field has been set. + +### GetInfos + +`func (o *ImportFormDefinitions202Response) GetInfos() []ImportFormDefinitions202ResponseErrorsInner` + +GetInfos returns the Infos field if non-nil, zero value otherwise. + +### GetInfosOk + +`func (o *ImportFormDefinitions202Response) GetInfosOk() (*[]ImportFormDefinitions202ResponseErrorsInner, bool)` + +GetInfosOk returns a tuple with the Infos field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfos + +`func (o *ImportFormDefinitions202Response) SetInfos(v []ImportFormDefinitions202ResponseErrorsInner)` + +SetInfos sets Infos field to given value. + +### HasInfos + +`func (o *ImportFormDefinitions202Response) HasInfos() bool` + +HasInfos returns a boolean if a field has been set. + +### GetWarnings + +`func (o *ImportFormDefinitions202Response) GetWarnings() []ImportFormDefinitions202ResponseErrorsInner` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *ImportFormDefinitions202Response) GetWarningsOk() (*[]ImportFormDefinitions202ResponseErrorsInner, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *ImportFormDefinitions202Response) SetWarnings(v []ImportFormDefinitions202ResponseErrorsInner)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *ImportFormDefinitions202Response) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ImportFormDefinitions202ResponseErrorsInner.md b/docs/tools/sdk/go/Reference/Beta/Models/ImportFormDefinitions202ResponseErrorsInner.md new file mode 100644 index 000000000..a4206e271 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ImportFormDefinitions202ResponseErrorsInner.md @@ -0,0 +1,116 @@ +--- +id: beta-import-form-definitions202-response-errors-inner +title: ImportFormDefinitions202ResponseErrorsInner +pagination_label: ImportFormDefinitions202ResponseErrorsInner +sidebar_label: ImportFormDefinitions202ResponseErrorsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportFormDefinitions202ResponseErrorsInner', 'BetaImportFormDefinitions202ResponseErrorsInner'] +slug: /tools/sdk/go/beta/models/import-form-definitions202-response-errors-inner +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202ResponseErrorsInner', 'BetaImportFormDefinitions202ResponseErrorsInner'] +--- + +# ImportFormDefinitions202ResponseErrorsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Detail** | Pointer to **map[string]map[string]interface{}** | | [optional] +**Key** | Pointer to **string** | | [optional] +**Text** | Pointer to **string** | | [optional] + +## Methods + +### NewImportFormDefinitions202ResponseErrorsInner + +`func NewImportFormDefinitions202ResponseErrorsInner() *ImportFormDefinitions202ResponseErrorsInner` + +NewImportFormDefinitions202ResponseErrorsInner instantiates a new ImportFormDefinitions202ResponseErrorsInner 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 + +### NewImportFormDefinitions202ResponseErrorsInnerWithDefaults + +`func NewImportFormDefinitions202ResponseErrorsInnerWithDefaults() *ImportFormDefinitions202ResponseErrorsInner` + +NewImportFormDefinitions202ResponseErrorsInnerWithDefaults instantiates a new ImportFormDefinitions202ResponseErrorsInner 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 + +### GetDetail + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetDetail() map[string]map[string]interface{}` + +GetDetail returns the Detail field if non-nil, zero value otherwise. + +### GetDetailOk + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetDetailOk() (*map[string]map[string]interface{}, bool)` + +GetDetailOk returns a tuple with the Detail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetail + +`func (o *ImportFormDefinitions202ResponseErrorsInner) SetDetail(v map[string]map[string]interface{})` + +SetDetail sets Detail field to given value. + +### HasDetail + +`func (o *ImportFormDefinitions202ResponseErrorsInner) HasDetail() bool` + +HasDetail returns a boolean if a field has been set. + +### GetKey + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *ImportFormDefinitions202ResponseErrorsInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *ImportFormDefinitions202ResponseErrorsInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetText + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *ImportFormDefinitions202ResponseErrorsInner) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *ImportFormDefinitions202ResponseErrorsInner) HasText() bool` + +HasText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ImportFormDefinitionsRequestInner.md b/docs/tools/sdk/go/Reference/Beta/Models/ImportFormDefinitionsRequestInner.md new file mode 100644 index 000000000..46c22376b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ImportFormDefinitionsRequestInner.md @@ -0,0 +1,116 @@ +--- +id: beta-import-form-definitions-request-inner +title: ImportFormDefinitionsRequestInner +pagination_label: ImportFormDefinitionsRequestInner +sidebar_label: ImportFormDefinitionsRequestInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportFormDefinitionsRequestInner', 'BetaImportFormDefinitionsRequestInner'] +slug: /tools/sdk/go/beta/models/import-form-definitions-request-inner +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitionsRequestInner', 'BetaImportFormDefinitionsRequestInner'] +--- + +# ImportFormDefinitionsRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Object** | Pointer to [**FormDefinitionResponse**](form-definition-response) | | [optional] +**Self** | Pointer to **string** | | [optional] +**Version** | Pointer to **int32** | | [optional] + +## Methods + +### NewImportFormDefinitionsRequestInner + +`func NewImportFormDefinitionsRequestInner() *ImportFormDefinitionsRequestInner` + +NewImportFormDefinitionsRequestInner instantiates a new ImportFormDefinitionsRequestInner 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 + +### NewImportFormDefinitionsRequestInnerWithDefaults + +`func NewImportFormDefinitionsRequestInnerWithDefaults() *ImportFormDefinitionsRequestInner` + +NewImportFormDefinitionsRequestInnerWithDefaults instantiates a new ImportFormDefinitionsRequestInner 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 + +### GetObject + +`func (o *ImportFormDefinitionsRequestInner) GetObject() FormDefinitionResponse` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *ImportFormDefinitionsRequestInner) GetObjectOk() (*FormDefinitionResponse, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *ImportFormDefinitionsRequestInner) SetObject(v FormDefinitionResponse)` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *ImportFormDefinitionsRequestInner) HasObject() bool` + +HasObject returns a boolean if a field has been set. + +### GetSelf + +`func (o *ImportFormDefinitionsRequestInner) GetSelf() string` + +GetSelf returns the Self field if non-nil, zero value otherwise. + +### GetSelfOk + +`func (o *ImportFormDefinitionsRequestInner) GetSelfOk() (*string, bool)` + +GetSelfOk returns a tuple with the Self field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelf + +`func (o *ImportFormDefinitionsRequestInner) SetSelf(v string)` + +SetSelf sets Self field to given value. + +### HasSelf + +`func (o *ImportFormDefinitionsRequestInner) HasSelf() bool` + +HasSelf returns a boolean if a field has been set. + +### GetVersion + +`func (o *ImportFormDefinitionsRequestInner) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ImportFormDefinitionsRequestInner) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ImportFormDefinitionsRequestInner) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *ImportFormDefinitionsRequestInner) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ImportNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/ImportNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..e918ca7d0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ImportNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,59 @@ +--- +id: beta-import-non-employee-records-in-bulk-request +title: ImportNonEmployeeRecordsInBulkRequest +pagination_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportNonEmployeeRecordsInBulkRequest', 'BetaImportNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/go/beta/models/import-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'ImportNonEmployeeRecordsInBulkRequest', 'BetaImportNonEmployeeRecordsInBulkRequest'] +--- + +# ImportNonEmployeeRecordsInBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | ***os.File** | | + +## Methods + +### NewImportNonEmployeeRecordsInBulkRequest + +`func NewImportNonEmployeeRecordsInBulkRequest(data *os.File, ) *ImportNonEmployeeRecordsInBulkRequest` + +NewImportNonEmployeeRecordsInBulkRequest instantiates a new ImportNonEmployeeRecordsInBulkRequest 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 + +### NewImportNonEmployeeRecordsInBulkRequestWithDefaults + +`func NewImportNonEmployeeRecordsInBulkRequestWithDefaults() *ImportNonEmployeeRecordsInBulkRequest` + +NewImportNonEmployeeRecordsInBulkRequestWithDefaults instantiates a new ImportNonEmployeeRecordsInBulkRequest 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 + +### GetData + +`func (o *ImportNonEmployeeRecordsInBulkRequest) GetData() *os.File` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *ImportNonEmployeeRecordsInBulkRequest) GetDataOk() (**os.File, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *ImportNonEmployeeRecordsInBulkRequest) SetData(v *os.File)` + +SetData sets Data field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ImportObject.md b/docs/tools/sdk/go/Reference/Beta/Models/ImportObject.md new file mode 100644 index 000000000..9a7d8e0d6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ImportObject.md @@ -0,0 +1,116 @@ +--- +id: beta-import-object +title: ImportObject +pagination_label: ImportObject +sidebar_label: ImportObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportObject', 'BetaImportObject'] +slug: /tools/sdk/go/beta/models/import-object +tags: ['SDK', 'Software Development Kit', 'ImportObject', 'BetaImportObject'] +--- + +# ImportObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of object created or updated by import. | [optional] +**Id** | Pointer to **string** | ID of object created or updated by import. | [optional] +**Name** | Pointer to **string** | Display name of object created or updated by import. | [optional] + +## Methods + +### NewImportObject + +`func NewImportObject() *ImportObject` + +NewImportObject instantiates a new ImportObject 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 + +### NewImportObjectWithDefaults + +`func NewImportObjectWithDefaults() *ImportObject` + +NewImportObjectWithDefaults instantiates a new ImportObject 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 + +### GetType + +`func (o *ImportObject) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ImportObject) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ImportObject) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ImportObject) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ImportObject) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ImportObject) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ImportObject) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ImportObject) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ImportObject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ImportObject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ImportObject) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ImportObject) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ImportOptions.md b/docs/tools/sdk/go/Reference/Beta/Models/ImportOptions.md new file mode 100644 index 000000000..2aa5ad5bb --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ImportOptions.md @@ -0,0 +1,168 @@ +--- +id: beta-import-options +title: ImportOptions +pagination_label: ImportOptions +sidebar_label: ImportOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportOptions', 'BetaImportOptions'] +slug: /tools/sdk/go/beta/models/import-options +tags: ['SDK', 'Software Development Kit', 'ImportOptions', 'BetaImportOptions'] +--- + +# ImportOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExcludeTypes** | Pointer to **[]string** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]string** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] +**DefaultReferences** | Pointer to **[]string** | List of object types that can be used to resolve references on import. | [optional] +**ExcludeBackup** | Pointer to **bool** | By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed. | [optional] [default to false] + +## Methods + +### NewImportOptions + +`func NewImportOptions() *ImportOptions` + +NewImportOptions instantiates a new ImportOptions 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 + +### NewImportOptionsWithDefaults + +`func NewImportOptionsWithDefaults() *ImportOptions` + +NewImportOptionsWithDefaults instantiates a new ImportOptions 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 + +### GetExcludeTypes + +`func (o *ImportOptions) GetExcludeTypes() []string` + +GetExcludeTypes returns the ExcludeTypes field if non-nil, zero value otherwise. + +### GetExcludeTypesOk + +`func (o *ImportOptions) GetExcludeTypesOk() (*[]string, bool)` + +GetExcludeTypesOk returns a tuple with the ExcludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeTypes + +`func (o *ImportOptions) SetExcludeTypes(v []string)` + +SetExcludeTypes sets ExcludeTypes field to given value. + +### HasExcludeTypes + +`func (o *ImportOptions) HasExcludeTypes() bool` + +HasExcludeTypes returns a boolean if a field has been set. + +### GetIncludeTypes + +`func (o *ImportOptions) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *ImportOptions) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *ImportOptions) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *ImportOptions) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *ImportOptions) GetObjectOptions() map[string]ObjectExportImportOptions` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *ImportOptions) GetObjectOptionsOk() (*map[string]ObjectExportImportOptions, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *ImportOptions) SetObjectOptions(v map[string]ObjectExportImportOptions)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *ImportOptions) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + +### GetDefaultReferences + +`func (o *ImportOptions) GetDefaultReferences() []string` + +GetDefaultReferences returns the DefaultReferences field if non-nil, zero value otherwise. + +### GetDefaultReferencesOk + +`func (o *ImportOptions) GetDefaultReferencesOk() (*[]string, bool)` + +GetDefaultReferencesOk returns a tuple with the DefaultReferences field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultReferences + +`func (o *ImportOptions) SetDefaultReferences(v []string)` + +SetDefaultReferences sets DefaultReferences field to given value. + +### HasDefaultReferences + +`func (o *ImportOptions) HasDefaultReferences() bool` + +HasDefaultReferences returns a boolean if a field has been set. + +### GetExcludeBackup + +`func (o *ImportOptions) GetExcludeBackup() bool` + +GetExcludeBackup returns the ExcludeBackup field if non-nil, zero value otherwise. + +### GetExcludeBackupOk + +`func (o *ImportOptions) GetExcludeBackupOk() (*bool, bool)` + +GetExcludeBackupOk returns a tuple with the ExcludeBackup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeBackup + +`func (o *ImportOptions) SetExcludeBackup(v bool)` + +SetExcludeBackup sets ExcludeBackup field to given value. + +### HasExcludeBackup + +`func (o *ImportOptions) HasExcludeBackup() bool` + +HasExcludeBackup returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ImportSpConfigRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/ImportSpConfigRequest.md new file mode 100644 index 000000000..940fc53e3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ImportSpConfigRequest.md @@ -0,0 +1,85 @@ +--- +id: beta-import-sp-config-request +title: ImportSpConfigRequest +pagination_label: ImportSpConfigRequest +sidebar_label: ImportSpConfigRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportSpConfigRequest', 'BetaImportSpConfigRequest'] +slug: /tools/sdk/go/beta/models/import-sp-config-request +tags: ['SDK', 'Software Development Kit', 'ImportSpConfigRequest', 'BetaImportSpConfigRequest'] +--- + +# ImportSpConfigRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | ***os.File** | JSON file containing the objects to be imported. | +**Options** | Pointer to [**ImportOptions**](import-options) | | [optional] + +## Methods + +### NewImportSpConfigRequest + +`func NewImportSpConfigRequest(data *os.File, ) *ImportSpConfigRequest` + +NewImportSpConfigRequest instantiates a new ImportSpConfigRequest 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 + +### NewImportSpConfigRequestWithDefaults + +`func NewImportSpConfigRequestWithDefaults() *ImportSpConfigRequest` + +NewImportSpConfigRequestWithDefaults instantiates a new ImportSpConfigRequest 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 + +### GetData + +`func (o *ImportSpConfigRequest) GetData() *os.File` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *ImportSpConfigRequest) GetDataOk() (**os.File, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *ImportSpConfigRequest) SetData(v *os.File)` + +SetData sets Data field to given value. + + +### GetOptions + +`func (o *ImportSpConfigRequest) GetOptions() ImportOptions` + +GetOptions returns the Options field if non-nil, zero value otherwise. + +### GetOptionsOk + +`func (o *ImportSpConfigRequest) GetOptionsOk() (*ImportOptions, bool)` + +GetOptionsOk returns a tuple with the Options field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOptions + +`func (o *ImportSpConfigRequest) SetOptions(v ImportOptions)` + +SetOptions sets Options field to given value. + +### HasOptions + +`func (o *ImportSpConfigRequest) HasOptions() bool` + +HasOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Index.md b/docs/tools/sdk/go/Reference/Beta/Models/Index.md new file mode 100644 index 000000000..2fc5dee6f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Index.md @@ -0,0 +1,18 @@ +--- +id: models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 3 +sidebar_class_name: models +keywords: ['go', 'Golang', 'sdk', 'models'] +slug: /tools/sdk/go/beta/models +tags: ['SDK', 'Software Development Kit', 'beta', 'models'] +--- + +The Python SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. \ No newline at end of file diff --git a/docs/tools/sdk/go/Reference/Beta/Models/InviteIdentitiesRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/InviteIdentitiesRequest.md new file mode 100644 index 000000000..07225310b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/InviteIdentitiesRequest.md @@ -0,0 +1,100 @@ +--- +id: beta-invite-identities-request +title: InviteIdentitiesRequest +pagination_label: InviteIdentitiesRequest +sidebar_label: InviteIdentitiesRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'InviteIdentitiesRequest', 'BetaInviteIdentitiesRequest'] +slug: /tools/sdk/go/beta/models/invite-identities-request +tags: ['SDK', 'Software Development Kit', 'InviteIdentitiesRequest', 'BetaInviteIdentitiesRequest'] +--- + +# InviteIdentitiesRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]string** | The list of Identities IDs to invite - required when 'uninvited' is false | [optional] +**Uninvited** | Pointer to **bool** | indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when 'ids' is empty. | [optional] [default to false] + +## Methods + +### NewInviteIdentitiesRequest + +`func NewInviteIdentitiesRequest() *InviteIdentitiesRequest` + +NewInviteIdentitiesRequest instantiates a new InviteIdentitiesRequest 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 + +### NewInviteIdentitiesRequestWithDefaults + +`func NewInviteIdentitiesRequestWithDefaults() *InviteIdentitiesRequest` + +NewInviteIdentitiesRequestWithDefaults instantiates a new InviteIdentitiesRequest 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 + +### GetIds + +`func (o *InviteIdentitiesRequest) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *InviteIdentitiesRequest) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *InviteIdentitiesRequest) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *InviteIdentitiesRequest) HasIds() bool` + +HasIds returns a boolean if a field has been set. + +### SetIdsNil + +`func (o *InviteIdentitiesRequest) SetIdsNil(b bool)` + + SetIdsNil sets the value for Ids to be an explicit nil + +### UnsetIds +`func (o *InviteIdentitiesRequest) UnsetIds()` + +UnsetIds ensures that no value is present for Ids, not even an explicit nil +### GetUninvited + +`func (o *InviteIdentitiesRequest) GetUninvited() bool` + +GetUninvited returns the Uninvited field if non-nil, zero value otherwise. + +### GetUninvitedOk + +`func (o *InviteIdentitiesRequest) GetUninvitedOk() (*bool, bool)` + +GetUninvitedOk returns a tuple with the Uninvited field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUninvited + +`func (o *InviteIdentitiesRequest) SetUninvited(v bool)` + +SetUninvited sets Uninvited field to given value. + +### HasUninvited + +`func (o *InviteIdentitiesRequest) HasUninvited() bool` + +HasUninvited returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Invocation.md b/docs/tools/sdk/go/Reference/Beta/Models/Invocation.md new file mode 100644 index 000000000..32aea517a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Invocation.md @@ -0,0 +1,142 @@ +--- +id: beta-invocation +title: Invocation +pagination_label: Invocation +sidebar_label: Invocation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Invocation', 'BetaInvocation'] +slug: /tools/sdk/go/beta/models/invocation +tags: ['SDK', 'Software Development Kit', 'Invocation', 'BetaInvocation'] +--- + +# Invocation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Invocation ID | [optional] +**TriggerId** | Pointer to **string** | Trigger ID | [optional] +**Secret** | Pointer to **string** | Unique invocation secret. | [optional] +**ContentJson** | Pointer to **map[string]interface{}** | JSON map of invocation metadata. | [optional] + +## Methods + +### NewInvocation + +`func NewInvocation() *Invocation` + +NewInvocation instantiates a new Invocation 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 + +### NewInvocationWithDefaults + +`func NewInvocationWithDefaults() *Invocation` + +NewInvocationWithDefaults instantiates a new Invocation 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 + +### GetId + +`func (o *Invocation) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Invocation) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Invocation) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Invocation) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetTriggerId + +`func (o *Invocation) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *Invocation) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *Invocation) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + +### HasTriggerId + +`func (o *Invocation) HasTriggerId() bool` + +HasTriggerId returns a boolean if a field has been set. + +### GetSecret + +`func (o *Invocation) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *Invocation) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *Invocation) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *Invocation) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### GetContentJson + +`func (o *Invocation) GetContentJson() map[string]interface{}` + +GetContentJson returns the ContentJson field if non-nil, zero value otherwise. + +### GetContentJsonOk + +`func (o *Invocation) GetContentJsonOk() (*map[string]interface{}, bool)` + +GetContentJsonOk returns a tuple with the ContentJson field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContentJson + +`func (o *Invocation) SetContentJson(v map[string]interface{})` + +SetContentJson sets ContentJson field to given value. + +### HasContentJson + +`func (o *Invocation) HasContentJson() bool` + +HasContentJson returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/InvocationStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/InvocationStatus.md new file mode 100644 index 000000000..dbbfa0bba --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/InvocationStatus.md @@ -0,0 +1,237 @@ +--- +id: beta-invocation-status +title: InvocationStatus +pagination_label: InvocationStatus +sidebar_label: InvocationStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'InvocationStatus', 'BetaInvocationStatus'] +slug: /tools/sdk/go/beta/models/invocation-status +tags: ['SDK', 'Software Development Kit', 'InvocationStatus', 'BetaInvocationStatus'] +--- + +# InvocationStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Invocation ID | +**TriggerId** | **string** | Trigger ID | +**SubscriptionName** | **string** | Subscription name | +**SubscriptionId** | **string** | Subscription ID | +**Type** | [**InvocationStatusType**](invocation-status-type) | | +**Created** | **SailPointTime** | Invocation created timestamp. ISO-8601 in UTC. | +**Completed** | Pointer to **SailPointTime** | Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC. | [optional] +**StartInvocationInput** | [**StartInvocationInput**](start-invocation-input) | | +**CompleteInvocationInput** | Pointer to [**CompleteInvocationInput**](complete-invocation-input) | | [optional] + +## Methods + +### NewInvocationStatus + +`func NewInvocationStatus(id string, triggerId string, subscriptionName string, subscriptionId string, type_ InvocationStatusType, created SailPointTime, startInvocationInput StartInvocationInput, ) *InvocationStatus` + +NewInvocationStatus instantiates a new InvocationStatus 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 + +### NewInvocationStatusWithDefaults + +`func NewInvocationStatusWithDefaults() *InvocationStatus` + +NewInvocationStatusWithDefaults instantiates a new InvocationStatus 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 + +### GetId + +`func (o *InvocationStatus) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *InvocationStatus) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *InvocationStatus) SetId(v string)` + +SetId sets Id field to given value. + + +### GetTriggerId + +`func (o *InvocationStatus) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *InvocationStatus) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *InvocationStatus) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + + +### GetSubscriptionName + +`func (o *InvocationStatus) GetSubscriptionName() string` + +GetSubscriptionName returns the SubscriptionName field if non-nil, zero value otherwise. + +### GetSubscriptionNameOk + +`func (o *InvocationStatus) GetSubscriptionNameOk() (*string, bool)` + +GetSubscriptionNameOk returns a tuple with the SubscriptionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubscriptionName + +`func (o *InvocationStatus) SetSubscriptionName(v string)` + +SetSubscriptionName sets SubscriptionName field to given value. + + +### GetSubscriptionId + +`func (o *InvocationStatus) GetSubscriptionId() string` + +GetSubscriptionId returns the SubscriptionId field if non-nil, zero value otherwise. + +### GetSubscriptionIdOk + +`func (o *InvocationStatus) GetSubscriptionIdOk() (*string, bool)` + +GetSubscriptionIdOk returns a tuple with the SubscriptionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubscriptionId + +`func (o *InvocationStatus) SetSubscriptionId(v string)` + +SetSubscriptionId sets SubscriptionId field to given value. + + +### GetType + +`func (o *InvocationStatus) GetType() InvocationStatusType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *InvocationStatus) GetTypeOk() (*InvocationStatusType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *InvocationStatus) SetType(v InvocationStatusType)` + +SetType sets Type field to given value. + + +### GetCreated + +`func (o *InvocationStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *InvocationStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *InvocationStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetCompleted + +`func (o *InvocationStatus) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *InvocationStatus) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *InvocationStatus) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *InvocationStatus) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetStartInvocationInput + +`func (o *InvocationStatus) GetStartInvocationInput() StartInvocationInput` + +GetStartInvocationInput returns the StartInvocationInput field if non-nil, zero value otherwise. + +### GetStartInvocationInputOk + +`func (o *InvocationStatus) GetStartInvocationInputOk() (*StartInvocationInput, bool)` + +GetStartInvocationInputOk returns a tuple with the StartInvocationInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartInvocationInput + +`func (o *InvocationStatus) SetStartInvocationInput(v StartInvocationInput)` + +SetStartInvocationInput sets StartInvocationInput field to given value. + + +### GetCompleteInvocationInput + +`func (o *InvocationStatus) GetCompleteInvocationInput() CompleteInvocationInput` + +GetCompleteInvocationInput returns the CompleteInvocationInput field if non-nil, zero value otherwise. + +### GetCompleteInvocationInputOk + +`func (o *InvocationStatus) GetCompleteInvocationInputOk() (*CompleteInvocationInput, bool)` + +GetCompleteInvocationInputOk returns a tuple with the CompleteInvocationInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleteInvocationInput + +`func (o *InvocationStatus) SetCompleteInvocationInput(v CompleteInvocationInput)` + +SetCompleteInvocationInput sets CompleteInvocationInput field to given value. + +### HasCompleteInvocationInput + +`func (o *InvocationStatus) HasCompleteInvocationInput() bool` + +HasCompleteInvocationInput returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/InvocationStatusType.md b/docs/tools/sdk/go/Reference/Beta/Models/InvocationStatusType.md new file mode 100644 index 000000000..7e4382b04 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/InvocationStatusType.md @@ -0,0 +1,21 @@ +--- +id: beta-invocation-status-type +title: InvocationStatusType +pagination_label: InvocationStatusType +sidebar_label: InvocationStatusType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'InvocationStatusType', 'BetaInvocationStatusType'] +slug: /tools/sdk/go/beta/models/invocation-status-type +tags: ['SDK', 'Software Development Kit', 'InvocationStatusType', 'BetaInvocationStatusType'] +--- + +# InvocationStatusType + +## Enum + + +* `TEST` (value: `"TEST"`) + +* `REAL_TIME` (value: `"REAL_TIME"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/JsonPatch.md b/docs/tools/sdk/go/Reference/Beta/Models/JsonPatch.md new file mode 100644 index 000000000..9757a78f5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/JsonPatch.md @@ -0,0 +1,64 @@ +--- +id: beta-json-patch +title: JsonPatch +pagination_label: JsonPatch +sidebar_label: JsonPatch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'JsonPatch', 'BetaJsonPatch'] +slug: /tools/sdk/go/beta/models/json-patch +tags: ['SDK', 'Software Development Kit', 'JsonPatch', 'BetaJsonPatch'] +--- + +# JsonPatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operations** | Pointer to [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] + +## Methods + +### NewJsonPatch + +`func NewJsonPatch() *JsonPatch` + +NewJsonPatch instantiates a new JsonPatch 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 + +### NewJsonPatchWithDefaults + +`func NewJsonPatchWithDefaults() *JsonPatch` + +NewJsonPatchWithDefaults instantiates a new JsonPatch 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 + +### GetOperations + +`func (o *JsonPatch) GetOperations() []JsonPatchOperation` + +GetOperations returns the Operations field if non-nil, zero value otherwise. + +### GetOperationsOk + +`func (o *JsonPatch) GetOperationsOk() (*[]JsonPatchOperation, bool)` + +GetOperationsOk returns a tuple with the Operations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperations + +`func (o *JsonPatch) SetOperations(v []JsonPatchOperation)` + +SetOperations sets Operations field to given value. + +### HasOperations + +`func (o *JsonPatch) HasOperations() bool` + +HasOperations returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/JsonPatchOperation.md b/docs/tools/sdk/go/Reference/Beta/Models/JsonPatchOperation.md new file mode 100644 index 000000000..5a6388c1a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/JsonPatchOperation.md @@ -0,0 +1,106 @@ +--- +id: beta-json-patch-operation +title: JsonPatchOperation +pagination_label: JsonPatchOperation +sidebar_label: JsonPatchOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'JsonPatchOperation', 'BetaJsonPatchOperation'] +slug: /tools/sdk/go/beta/models/json-patch-operation +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperation', 'BetaJsonPatchOperation'] +--- + +# JsonPatchOperation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **string** | The operation to be performed | +**Path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | +**Value** | Pointer to [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] + +## Methods + +### NewJsonPatchOperation + +`func NewJsonPatchOperation(op string, path string, ) *JsonPatchOperation` + +NewJsonPatchOperation instantiates a new JsonPatchOperation 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 + +### NewJsonPatchOperationWithDefaults + +`func NewJsonPatchOperationWithDefaults() *JsonPatchOperation` + +NewJsonPatchOperationWithDefaults instantiates a new JsonPatchOperation 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 + +### GetOp + +`func (o *JsonPatchOperation) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *JsonPatchOperation) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *JsonPatchOperation) SetOp(v string)` + +SetOp sets Op field to given value. + + +### GetPath + +`func (o *JsonPatchOperation) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *JsonPatchOperation) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *JsonPatchOperation) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetValue + +`func (o *JsonPatchOperation) GetValue() UpdateMultiHostSourcesRequestInnerValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *JsonPatchOperation) GetValueOk() (*UpdateMultiHostSourcesRequestInnerValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *JsonPatchOperation) SetValue(v UpdateMultiHostSourcesRequestInnerValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *JsonPatchOperation) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/JsonPatchOperations.md b/docs/tools/sdk/go/Reference/Beta/Models/JsonPatchOperations.md new file mode 100644 index 000000000..3ef131c8d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/JsonPatchOperations.md @@ -0,0 +1,106 @@ +--- +id: beta-json-patch-operations +title: JsonPatchOperations +pagination_label: JsonPatchOperations +sidebar_label: JsonPatchOperations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'JsonPatchOperations', 'BetaJsonPatchOperations'] +slug: /tools/sdk/go/beta/models/json-patch-operations +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperations', 'BetaJsonPatchOperations'] +--- + +# JsonPatchOperations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **string** | The operation to be performed | +**Path** | **string** | A string representing the target path to an element to be affected by the operation | +**Value** | Pointer to [**JsonPatchOperationsValue**](json-patch-operations-value) | | [optional] + +## Methods + +### NewJsonPatchOperations + +`func NewJsonPatchOperations(op string, path string, ) *JsonPatchOperations` + +NewJsonPatchOperations instantiates a new JsonPatchOperations 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 + +### NewJsonPatchOperationsWithDefaults + +`func NewJsonPatchOperationsWithDefaults() *JsonPatchOperations` + +NewJsonPatchOperationsWithDefaults instantiates a new JsonPatchOperations 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 + +### GetOp + +`func (o *JsonPatchOperations) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *JsonPatchOperations) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *JsonPatchOperations) SetOp(v string)` + +SetOp sets Op field to given value. + + +### GetPath + +`func (o *JsonPatchOperations) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *JsonPatchOperations) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *JsonPatchOperations) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetValue + +`func (o *JsonPatchOperations) GetValue() JsonPatchOperationsValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *JsonPatchOperations) GetValueOk() (*JsonPatchOperationsValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *JsonPatchOperations) SetValue(v JsonPatchOperationsValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *JsonPatchOperations) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/JsonPatchOperationsValue.md b/docs/tools/sdk/go/Reference/Beta/Models/JsonPatchOperationsValue.md new file mode 100644 index 000000000..1f2b62459 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/JsonPatchOperationsValue.md @@ -0,0 +1,38 @@ +--- +id: beta-json-patch-operations-value +title: JsonPatchOperationsValue +pagination_label: JsonPatchOperationsValue +sidebar_label: JsonPatchOperationsValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'JsonPatchOperationsValue', 'BetaJsonPatchOperationsValue'] +slug: /tools/sdk/go/beta/models/json-patch-operations-value +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperationsValue', 'BetaJsonPatchOperationsValue'] +--- + +# JsonPatchOperationsValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewJsonPatchOperationsValue + +`func NewJsonPatchOperationsValue() *JsonPatchOperationsValue` + +NewJsonPatchOperationsValue instantiates a new JsonPatchOperationsValue 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 + +### NewJsonPatchOperationsValueWithDefaults + +`func NewJsonPatchOperationsValueWithDefaults() *JsonPatchOperationsValue` + +NewJsonPatchOperationsValueWithDefaults instantiates a new JsonPatchOperationsValue 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 + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/KbaAnswerRequestItem.md b/docs/tools/sdk/go/Reference/Beta/Models/KbaAnswerRequestItem.md new file mode 100644 index 000000000..efc28933e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/KbaAnswerRequestItem.md @@ -0,0 +1,80 @@ +--- +id: beta-kba-answer-request-item +title: KbaAnswerRequestItem +pagination_label: KbaAnswerRequestItem +sidebar_label: KbaAnswerRequestItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'KbaAnswerRequestItem', 'BetaKbaAnswerRequestItem'] +slug: /tools/sdk/go/beta/models/kba-answer-request-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerRequestItem', 'BetaKbaAnswerRequestItem'] +--- + +# KbaAnswerRequestItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Question Id | +**Answer** | **string** | An answer for the KBA question | + +## Methods + +### NewKbaAnswerRequestItem + +`func NewKbaAnswerRequestItem(id string, answer string, ) *KbaAnswerRequestItem` + +NewKbaAnswerRequestItem instantiates a new KbaAnswerRequestItem 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 + +### NewKbaAnswerRequestItemWithDefaults + +`func NewKbaAnswerRequestItemWithDefaults() *KbaAnswerRequestItem` + +NewKbaAnswerRequestItemWithDefaults instantiates a new KbaAnswerRequestItem 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 + +### GetId + +`func (o *KbaAnswerRequestItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *KbaAnswerRequestItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *KbaAnswerRequestItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetAnswer + +`func (o *KbaAnswerRequestItem) GetAnswer() string` + +GetAnswer returns the Answer field if non-nil, zero value otherwise. + +### GetAnswerOk + +`func (o *KbaAnswerRequestItem) GetAnswerOk() (*string, bool)` + +GetAnswerOk returns a tuple with the Answer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnswer + +`func (o *KbaAnswerRequestItem) SetAnswer(v string)` + +SetAnswer sets Answer field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/KbaAnswerResponseItem.md b/docs/tools/sdk/go/Reference/Beta/Models/KbaAnswerResponseItem.md new file mode 100644 index 000000000..3c3aca45a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/KbaAnswerResponseItem.md @@ -0,0 +1,101 @@ +--- +id: beta-kba-answer-response-item +title: KbaAnswerResponseItem +pagination_label: KbaAnswerResponseItem +sidebar_label: KbaAnswerResponseItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'KbaAnswerResponseItem', 'BetaKbaAnswerResponseItem'] +slug: /tools/sdk/go/beta/models/kba-answer-response-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerResponseItem', 'BetaKbaAnswerResponseItem'] +--- + +# KbaAnswerResponseItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Question Id | +**Question** | **string** | Question description | +**HasAnswer** | **bool** | Denotes whether the KBA question has an answer configured for the current user | + +## Methods + +### NewKbaAnswerResponseItem + +`func NewKbaAnswerResponseItem(id string, question string, hasAnswer bool, ) *KbaAnswerResponseItem` + +NewKbaAnswerResponseItem instantiates a new KbaAnswerResponseItem 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 + +### NewKbaAnswerResponseItemWithDefaults + +`func NewKbaAnswerResponseItemWithDefaults() *KbaAnswerResponseItem` + +NewKbaAnswerResponseItemWithDefaults instantiates a new KbaAnswerResponseItem 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 + +### GetId + +`func (o *KbaAnswerResponseItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *KbaAnswerResponseItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *KbaAnswerResponseItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetQuestion + +`func (o *KbaAnswerResponseItem) GetQuestion() string` + +GetQuestion returns the Question field if non-nil, zero value otherwise. + +### GetQuestionOk + +`func (o *KbaAnswerResponseItem) GetQuestionOk() (*string, bool)` + +GetQuestionOk returns a tuple with the Question field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuestion + +`func (o *KbaAnswerResponseItem) SetQuestion(v string)` + +SetQuestion sets Question field to given value. + + +### GetHasAnswer + +`func (o *KbaAnswerResponseItem) GetHasAnswer() bool` + +GetHasAnswer returns the HasAnswer field if non-nil, zero value otherwise. + +### GetHasAnswerOk + +`func (o *KbaAnswerResponseItem) GetHasAnswerOk() (*bool, bool)` + +GetHasAnswerOk returns a tuple with the HasAnswer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasAnswer + +`func (o *KbaAnswerResponseItem) SetHasAnswer(v bool)` + +SetHasAnswer sets HasAnswer field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/KbaAuthResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/KbaAuthResponse.md new file mode 100644 index 000000000..762e2fef3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/KbaAuthResponse.md @@ -0,0 +1,90 @@ +--- +id: beta-kba-auth-response +title: KbaAuthResponse +pagination_label: KbaAuthResponse +sidebar_label: KbaAuthResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'KbaAuthResponse', 'BetaKbaAuthResponse'] +slug: /tools/sdk/go/beta/models/kba-auth-response +tags: ['SDK', 'Software Development Kit', 'KbaAuthResponse', 'BetaKbaAuthResponse'] +--- + +# KbaAuthResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**KbaAuthResponseItems** | Pointer to [**[]KbaAuthResponseItem**](kba-auth-response-item) | | [optional] +**Status** | Pointer to **string** | MFA Authentication status | [optional] + +## Methods + +### NewKbaAuthResponse + +`func NewKbaAuthResponse() *KbaAuthResponse` + +NewKbaAuthResponse instantiates a new KbaAuthResponse 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 + +### NewKbaAuthResponseWithDefaults + +`func NewKbaAuthResponseWithDefaults() *KbaAuthResponse` + +NewKbaAuthResponseWithDefaults instantiates a new KbaAuthResponse 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 + +### GetKbaAuthResponseItems + +`func (o *KbaAuthResponse) GetKbaAuthResponseItems() []KbaAuthResponseItem` + +GetKbaAuthResponseItems returns the KbaAuthResponseItems field if non-nil, zero value otherwise. + +### GetKbaAuthResponseItemsOk + +`func (o *KbaAuthResponse) GetKbaAuthResponseItemsOk() (*[]KbaAuthResponseItem, bool)` + +GetKbaAuthResponseItemsOk returns a tuple with the KbaAuthResponseItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKbaAuthResponseItems + +`func (o *KbaAuthResponse) SetKbaAuthResponseItems(v []KbaAuthResponseItem)` + +SetKbaAuthResponseItems sets KbaAuthResponseItems field to given value. + +### HasKbaAuthResponseItems + +`func (o *KbaAuthResponse) HasKbaAuthResponseItems() bool` + +HasKbaAuthResponseItems returns a boolean if a field has been set. + +### GetStatus + +`func (o *KbaAuthResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *KbaAuthResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *KbaAuthResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *KbaAuthResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/KbaAuthResponseItem.md b/docs/tools/sdk/go/Reference/Beta/Models/KbaAuthResponseItem.md new file mode 100644 index 000000000..4315938ab --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/KbaAuthResponseItem.md @@ -0,0 +1,110 @@ +--- +id: beta-kba-auth-response-item +title: KbaAuthResponseItem +pagination_label: KbaAuthResponseItem +sidebar_label: KbaAuthResponseItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'KbaAuthResponseItem', 'BetaKbaAuthResponseItem'] +slug: /tools/sdk/go/beta/models/kba-auth-response-item +tags: ['SDK', 'Software Development Kit', 'KbaAuthResponseItem', 'BetaKbaAuthResponseItem'] +--- + +# KbaAuthResponseItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**QuestionId** | Pointer to **NullableString** | The KBA question id | [optional] +**IsVerified** | Pointer to **NullableBool** | Return true if verified | [optional] + +## Methods + +### NewKbaAuthResponseItem + +`func NewKbaAuthResponseItem() *KbaAuthResponseItem` + +NewKbaAuthResponseItem instantiates a new KbaAuthResponseItem 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 + +### NewKbaAuthResponseItemWithDefaults + +`func NewKbaAuthResponseItemWithDefaults() *KbaAuthResponseItem` + +NewKbaAuthResponseItemWithDefaults instantiates a new KbaAuthResponseItem 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 + +### GetQuestionId + +`func (o *KbaAuthResponseItem) GetQuestionId() string` + +GetQuestionId returns the QuestionId field if non-nil, zero value otherwise. + +### GetQuestionIdOk + +`func (o *KbaAuthResponseItem) GetQuestionIdOk() (*string, bool)` + +GetQuestionIdOk returns a tuple with the QuestionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuestionId + +`func (o *KbaAuthResponseItem) SetQuestionId(v string)` + +SetQuestionId sets QuestionId field to given value. + +### HasQuestionId + +`func (o *KbaAuthResponseItem) HasQuestionId() bool` + +HasQuestionId returns a boolean if a field has been set. + +### SetQuestionIdNil + +`func (o *KbaAuthResponseItem) SetQuestionIdNil(b bool)` + + SetQuestionIdNil sets the value for QuestionId to be an explicit nil + +### UnsetQuestionId +`func (o *KbaAuthResponseItem) UnsetQuestionId()` + +UnsetQuestionId ensures that no value is present for QuestionId, not even an explicit nil +### GetIsVerified + +`func (o *KbaAuthResponseItem) GetIsVerified() bool` + +GetIsVerified returns the IsVerified field if non-nil, zero value otherwise. + +### GetIsVerifiedOk + +`func (o *KbaAuthResponseItem) GetIsVerifiedOk() (*bool, bool)` + +GetIsVerifiedOk returns a tuple with the IsVerified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsVerified + +`func (o *KbaAuthResponseItem) SetIsVerified(v bool)` + +SetIsVerified sets IsVerified field to given value. + +### HasIsVerified + +`func (o *KbaAuthResponseItem) HasIsVerified() bool` + +HasIsVerified returns a boolean if a field has been set. + +### SetIsVerifiedNil + +`func (o *KbaAuthResponseItem) SetIsVerifiedNil(b bool)` + + SetIsVerifiedNil sets the value for IsVerified to be an explicit nil + +### UnsetIsVerified +`func (o *KbaAuthResponseItem) UnsetIsVerified()` + +UnsetIsVerified ensures that no value is present for IsVerified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/KbaQuestion.md b/docs/tools/sdk/go/Reference/Beta/Models/KbaQuestion.md new file mode 100644 index 000000000..837c2f4ed --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/KbaQuestion.md @@ -0,0 +1,122 @@ +--- +id: beta-kba-question +title: KbaQuestion +pagination_label: KbaQuestion +sidebar_label: KbaQuestion +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'KbaQuestion', 'BetaKbaQuestion'] +slug: /tools/sdk/go/beta/models/kba-question +tags: ['SDK', 'Software Development Kit', 'KbaQuestion', 'BetaKbaQuestion'] +--- + +# KbaQuestion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | KBA Question Id | +**Text** | **string** | KBA Question description | +**HasAnswer** | **bool** | Denotes whether the KBA question has an answer configured for any user in the tenant | +**NumAnswers** | **int32** | Denotes the number of KBA configurations for this question | + +## Methods + +### NewKbaQuestion + +`func NewKbaQuestion(id string, text string, hasAnswer bool, numAnswers int32, ) *KbaQuestion` + +NewKbaQuestion instantiates a new KbaQuestion 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 + +### NewKbaQuestionWithDefaults + +`func NewKbaQuestionWithDefaults() *KbaQuestion` + +NewKbaQuestionWithDefaults instantiates a new KbaQuestion 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 + +### GetId + +`func (o *KbaQuestion) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *KbaQuestion) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *KbaQuestion) SetId(v string)` + +SetId sets Id field to given value. + + +### GetText + +`func (o *KbaQuestion) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *KbaQuestion) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *KbaQuestion) SetText(v string)` + +SetText sets Text field to given value. + + +### GetHasAnswer + +`func (o *KbaQuestion) GetHasAnswer() bool` + +GetHasAnswer returns the HasAnswer field if non-nil, zero value otherwise. + +### GetHasAnswerOk + +`func (o *KbaQuestion) GetHasAnswerOk() (*bool, bool)` + +GetHasAnswerOk returns a tuple with the HasAnswer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasAnswer + +`func (o *KbaQuestion) SetHasAnswer(v bool)` + +SetHasAnswer sets HasAnswer field to given value. + + +### GetNumAnswers + +`func (o *KbaQuestion) GetNumAnswers() int32` + +GetNumAnswers returns the NumAnswers field if non-nil, zero value otherwise. + +### GetNumAnswersOk + +`func (o *KbaQuestion) GetNumAnswersOk() (*int32, bool)` + +GetNumAnswersOk returns a tuple with the NumAnswers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumAnswers + +`func (o *KbaQuestion) SetNumAnswers(v int32)` + +SetNumAnswers sets NumAnswers field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LatestOutlierSummary.md b/docs/tools/sdk/go/Reference/Beta/Models/LatestOutlierSummary.md new file mode 100644 index 000000000..106618e7b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LatestOutlierSummary.md @@ -0,0 +1,168 @@ +--- +id: beta-latest-outlier-summary +title: LatestOutlierSummary +pagination_label: LatestOutlierSummary +sidebar_label: LatestOutlierSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LatestOutlierSummary', 'BetaLatestOutlierSummary'] +slug: /tools/sdk/go/beta/models/latest-outlier-summary +tags: ['SDK', 'Software Development Kit', 'LatestOutlierSummary', 'BetaLatestOutlierSummary'] +--- + +# LatestOutlierSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of outlier summary | [optional] +**SnapshotDate** | Pointer to **SailPointTime** | The date the bulk outlier detection ran/snapshot was created | [optional] +**TotalOutliers** | Pointer to **int32** | Total number of outliers for the customer making the request | [optional] +**TotalIdentities** | Pointer to **int32** | Total number of identities for the customer making the request | [optional] +**TotalIgnored** | Pointer to **int32** | Total number of ignored outliers | [optional] + +## Methods + +### NewLatestOutlierSummary + +`func NewLatestOutlierSummary() *LatestOutlierSummary` + +NewLatestOutlierSummary instantiates a new LatestOutlierSummary 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 + +### NewLatestOutlierSummaryWithDefaults + +`func NewLatestOutlierSummaryWithDefaults() *LatestOutlierSummary` + +NewLatestOutlierSummaryWithDefaults instantiates a new LatestOutlierSummary 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 + +### GetType + +`func (o *LatestOutlierSummary) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LatestOutlierSummary) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LatestOutlierSummary) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LatestOutlierSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSnapshotDate + +`func (o *LatestOutlierSummary) GetSnapshotDate() SailPointTime` + +GetSnapshotDate returns the SnapshotDate field if non-nil, zero value otherwise. + +### GetSnapshotDateOk + +`func (o *LatestOutlierSummary) GetSnapshotDateOk() (*SailPointTime, bool)` + +GetSnapshotDateOk returns a tuple with the SnapshotDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotDate + +`func (o *LatestOutlierSummary) SetSnapshotDate(v SailPointTime)` + +SetSnapshotDate sets SnapshotDate field to given value. + +### HasSnapshotDate + +`func (o *LatestOutlierSummary) HasSnapshotDate() bool` + +HasSnapshotDate returns a boolean if a field has been set. + +### GetTotalOutliers + +`func (o *LatestOutlierSummary) GetTotalOutliers() int32` + +GetTotalOutliers returns the TotalOutliers field if non-nil, zero value otherwise. + +### GetTotalOutliersOk + +`func (o *LatestOutlierSummary) GetTotalOutliersOk() (*int32, bool)` + +GetTotalOutliersOk returns a tuple with the TotalOutliers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalOutliers + +`func (o *LatestOutlierSummary) SetTotalOutliers(v int32)` + +SetTotalOutliers sets TotalOutliers field to given value. + +### HasTotalOutliers + +`func (o *LatestOutlierSummary) HasTotalOutliers() bool` + +HasTotalOutliers returns a boolean if a field has been set. + +### GetTotalIdentities + +`func (o *LatestOutlierSummary) GetTotalIdentities() int32` + +GetTotalIdentities returns the TotalIdentities field if non-nil, zero value otherwise. + +### GetTotalIdentitiesOk + +`func (o *LatestOutlierSummary) 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 *LatestOutlierSummary) SetTotalIdentities(v int32)` + +SetTotalIdentities sets TotalIdentities field to given value. + +### HasTotalIdentities + +`func (o *LatestOutlierSummary) HasTotalIdentities() bool` + +HasTotalIdentities returns a boolean if a field has been set. + +### GetTotalIgnored + +`func (o *LatestOutlierSummary) GetTotalIgnored() int32` + +GetTotalIgnored returns the TotalIgnored field if non-nil, zero value otherwise. + +### GetTotalIgnoredOk + +`func (o *LatestOutlierSummary) GetTotalIgnoredOk() (*int32, bool)` + +GetTotalIgnoredOk returns a tuple with the TotalIgnored field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalIgnored + +`func (o *LatestOutlierSummary) SetTotalIgnored(v int32)` + +SetTotalIgnored sets TotalIgnored field to given value. + +### HasTotalIgnored + +`func (o *LatestOutlierSummary) HasTotalIgnored() bool` + +HasTotalIgnored returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Launcher.md b/docs/tools/sdk/go/Reference/Beta/Models/Launcher.md new file mode 100644 index 000000000..70b93ed1f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Launcher.md @@ -0,0 +1,253 @@ +--- +id: beta-launcher +title: Launcher +pagination_label: Launcher +sidebar_label: Launcher +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Launcher', 'BetaLauncher'] +slug: /tools/sdk/go/beta/models/launcher +tags: ['SDK', 'Software Development Kit', 'Launcher', 'BetaLauncher'] +--- + +# Launcher + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the Launcher | +**Created** | **SailPointTime** | Date the Launcher was created | +**Modified** | **SailPointTime** | Date the Launcher was last modified | +**Owner** | [**LauncherOwner**](launcher-owner) | | +**Name** | **string** | Name of the Launcher, limited to 255 characters | +**Description** | **string** | Description of the Launcher, limited to 2000 characters | +**Type** | **string** | Launcher type | +**Disabled** | **bool** | State of the Launcher | +**Reference** | Pointer to [**LauncherReference**](launcher-reference) | | [optional] +**Config** | **string** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | + +## Methods + +### NewLauncher + +`func NewLauncher(id string, created SailPointTime, modified SailPointTime, owner LauncherOwner, name string, description string, type_ string, disabled bool, config string, ) *Launcher` + +NewLauncher instantiates a new Launcher 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 + +### NewLauncherWithDefaults + +`func NewLauncherWithDefaults() *Launcher` + +NewLauncherWithDefaults instantiates a new Launcher 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 + +### GetId + +`func (o *Launcher) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Launcher) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Launcher) SetId(v string)` + +SetId sets Id field to given value. + + +### GetCreated + +`func (o *Launcher) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Launcher) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Launcher) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *Launcher) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Launcher) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Launcher) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetOwner + +`func (o *Launcher) GetOwner() LauncherOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Launcher) GetOwnerOk() (*LauncherOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Launcher) SetOwner(v LauncherOwner)` + +SetOwner sets Owner field to given value. + + +### GetName + +`func (o *Launcher) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Launcher) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Launcher) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Launcher) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Launcher) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Launcher) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetType + +`func (o *Launcher) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Launcher) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Launcher) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDisabled + +`func (o *Launcher) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *Launcher) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *Launcher) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + + +### GetReference + +`func (o *Launcher) GetReference() LauncherReference` + +GetReference returns the Reference field if non-nil, zero value otherwise. + +### GetReferenceOk + +`func (o *Launcher) GetReferenceOk() (*LauncherReference, bool)` + +GetReferenceOk returns a tuple with the Reference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReference + +`func (o *Launcher) SetReference(v LauncherReference)` + +SetReference sets Reference field to given value. + +### HasReference + +`func (o *Launcher) HasReference() bool` + +HasReference returns a boolean if a field has been set. + +### GetConfig + +`func (o *Launcher) GetConfig() string` + +GetConfig returns the Config field if non-nil, zero value otherwise. + +### GetConfigOk + +`func (o *Launcher) GetConfigOk() (*string, bool)` + +GetConfigOk returns a tuple with the Config field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfig + +`func (o *Launcher) SetConfig(v string)` + +SetConfig sets Config field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LauncherOwner.md b/docs/tools/sdk/go/Reference/Beta/Models/LauncherOwner.md new file mode 100644 index 000000000..5c6ae600b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LauncherOwner.md @@ -0,0 +1,80 @@ +--- +id: beta-launcher-owner +title: LauncherOwner +pagination_label: LauncherOwner +sidebar_label: LauncherOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LauncherOwner', 'BetaLauncherOwner'] +slug: /tools/sdk/go/beta/models/launcher-owner +tags: ['SDK', 'Software Development Kit', 'LauncherOwner', 'BetaLauncherOwner'] +--- + +# LauncherOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Owner type | +**Id** | **string** | Owner ID | + +## Methods + +### NewLauncherOwner + +`func NewLauncherOwner(type_ string, id string, ) *LauncherOwner` + +NewLauncherOwner instantiates a new LauncherOwner 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 + +### NewLauncherOwnerWithDefaults + +`func NewLauncherOwnerWithDefaults() *LauncherOwner` + +NewLauncherOwnerWithDefaults instantiates a new LauncherOwner 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 + +### GetType + +`func (o *LauncherOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LauncherOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LauncherOwner) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *LauncherOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LauncherOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LauncherOwner) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LauncherReference.md b/docs/tools/sdk/go/Reference/Beta/Models/LauncherReference.md new file mode 100644 index 000000000..83b40734d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LauncherReference.md @@ -0,0 +1,90 @@ +--- +id: beta-launcher-reference +title: LauncherReference +pagination_label: LauncherReference +sidebar_label: LauncherReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LauncherReference', 'BetaLauncherReference'] +slug: /tools/sdk/go/beta/models/launcher-reference +tags: ['SDK', 'Software Development Kit', 'LauncherReference', 'BetaLauncherReference'] +--- + +# LauncherReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of Launcher reference | [optional] +**Id** | Pointer to **string** | ID of Launcher reference | [optional] + +## Methods + +### NewLauncherReference + +`func NewLauncherReference() *LauncherReference` + +NewLauncherReference instantiates a new LauncherReference 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 + +### NewLauncherReferenceWithDefaults + +`func NewLauncherReferenceWithDefaults() *LauncherReference` + +NewLauncherReferenceWithDefaults instantiates a new LauncherReference 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 + +### GetType + +`func (o *LauncherReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LauncherReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LauncherReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LauncherReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *LauncherReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LauncherReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LauncherReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LauncherReference) HasId() bool` + +HasId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LauncherRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/LauncherRequest.md new file mode 100644 index 000000000..f61e22f8a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LauncherRequest.md @@ -0,0 +1,169 @@ +--- +id: beta-launcher-request +title: LauncherRequest +pagination_label: LauncherRequest +sidebar_label: LauncherRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LauncherRequest', 'BetaLauncherRequest'] +slug: /tools/sdk/go/beta/models/launcher-request +tags: ['SDK', 'Software Development Kit', 'LauncherRequest', 'BetaLauncherRequest'] +--- + +# LauncherRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Name of the Launcher, limited to 255 characters | +**Description** | **string** | Description of the Launcher, limited to 2000 characters | +**Type** | **string** | Launcher type | +**Disabled** | **bool** | State of the Launcher | +**Reference** | Pointer to [**LauncherRequestReference**](launcher-request-reference) | | [optional] +**Config** | **string** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | + +## Methods + +### NewLauncherRequest + +`func NewLauncherRequest(name string, description string, type_ string, disabled bool, config string, ) *LauncherRequest` + +NewLauncherRequest instantiates a new LauncherRequest 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 + +### NewLauncherRequestWithDefaults + +`func NewLauncherRequestWithDefaults() *LauncherRequest` + +NewLauncherRequestWithDefaults instantiates a new LauncherRequest 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 + +### GetName + +`func (o *LauncherRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LauncherRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *LauncherRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *LauncherRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *LauncherRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *LauncherRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetType + +`func (o *LauncherRequest) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LauncherRequest) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LauncherRequest) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDisabled + +`func (o *LauncherRequest) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *LauncherRequest) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *LauncherRequest) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + + +### GetReference + +`func (o *LauncherRequest) GetReference() LauncherRequestReference` + +GetReference returns the Reference field if non-nil, zero value otherwise. + +### GetReferenceOk + +`func (o *LauncherRequest) GetReferenceOk() (*LauncherRequestReference, bool)` + +GetReferenceOk returns a tuple with the Reference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReference + +`func (o *LauncherRequest) SetReference(v LauncherRequestReference)` + +SetReference sets Reference field to given value. + +### HasReference + +`func (o *LauncherRequest) HasReference() bool` + +HasReference returns a boolean if a field has been set. + +### GetConfig + +`func (o *LauncherRequest) GetConfig() string` + +GetConfig returns the Config field if non-nil, zero value otherwise. + +### GetConfigOk + +`func (o *LauncherRequest) GetConfigOk() (*string, bool)` + +GetConfigOk returns a tuple with the Config field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfig + +`func (o *LauncherRequest) SetConfig(v string)` + +SetConfig sets Config field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LauncherRequestReference.md b/docs/tools/sdk/go/Reference/Beta/Models/LauncherRequestReference.md new file mode 100644 index 000000000..0a0bd8d2f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LauncherRequestReference.md @@ -0,0 +1,80 @@ +--- +id: beta-launcher-request-reference +title: LauncherRequestReference +pagination_label: LauncherRequestReference +sidebar_label: LauncherRequestReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LauncherRequestReference', 'BetaLauncherRequestReference'] +slug: /tools/sdk/go/beta/models/launcher-request-reference +tags: ['SDK', 'Software Development Kit', 'LauncherRequestReference', 'BetaLauncherRequestReference'] +--- + +# LauncherRequestReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of Launcher reference | +**Id** | **string** | ID of Launcher reference | + +## Methods + +### NewLauncherRequestReference + +`func NewLauncherRequestReference(type_ string, id string, ) *LauncherRequestReference` + +NewLauncherRequestReference instantiates a new LauncherRequestReference 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 + +### NewLauncherRequestReferenceWithDefaults + +`func NewLauncherRequestReferenceWithDefaults() *LauncherRequestReference` + +NewLauncherRequestReferenceWithDefaults instantiates a new LauncherRequestReference 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 + +### GetType + +`func (o *LauncherRequestReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LauncherRequestReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LauncherRequestReference) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *LauncherRequestReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LauncherRequestReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LauncherRequestReference) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/License.md b/docs/tools/sdk/go/Reference/Beta/Models/License.md new file mode 100644 index 000000000..0352a6861 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/License.md @@ -0,0 +1,90 @@ +--- +id: beta-license +title: License +pagination_label: License +sidebar_label: License +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'License', 'BetaLicense'] +slug: /tools/sdk/go/beta/models/license +tags: ['SDK', 'Software Development Kit', 'License', 'BetaLicense'] +--- + +# License + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LicenseId** | Pointer to **string** | Name of the license | [optional] +**LegacyFeatureName** | Pointer to **string** | Legacy name of the license | [optional] + +## Methods + +### NewLicense + +`func NewLicense() *License` + +NewLicense instantiates a new License 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 + +### NewLicenseWithDefaults + +`func NewLicenseWithDefaults() *License` + +NewLicenseWithDefaults instantiates a new License 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 + +### GetLicenseId + +`func (o *License) GetLicenseId() string` + +GetLicenseId returns the LicenseId field if non-nil, zero value otherwise. + +### GetLicenseIdOk + +`func (o *License) GetLicenseIdOk() (*string, bool)` + +GetLicenseIdOk returns a tuple with the LicenseId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLicenseId + +`func (o *License) SetLicenseId(v string)` + +SetLicenseId sets LicenseId field to given value. + +### HasLicenseId + +`func (o *License) HasLicenseId() bool` + +HasLicenseId returns a boolean if a field has been set. + +### GetLegacyFeatureName + +`func (o *License) GetLegacyFeatureName() string` + +GetLegacyFeatureName returns the LegacyFeatureName field if non-nil, zero value otherwise. + +### GetLegacyFeatureNameOk + +`func (o *License) GetLegacyFeatureNameOk() (*string, bool)` + +GetLegacyFeatureNameOk returns a tuple with the LegacyFeatureName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyFeatureName + +`func (o *License) SetLegacyFeatureName(v string)` + +SetLegacyFeatureName sets LegacyFeatureName field to given value. + +### HasLegacyFeatureName + +`func (o *License) HasLegacyFeatureName() bool` + +HasLegacyFeatureName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LifecycleState.md b/docs/tools/sdk/go/Reference/Beta/Models/LifecycleState.md new file mode 100644 index 000000000..c172ce042 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LifecycleState.md @@ -0,0 +1,324 @@ +--- +id: beta-lifecycle-state +title: LifecycleState +pagination_label: LifecycleState +sidebar_label: LifecycleState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LifecycleState', 'BetaLifecycleState'] +slug: /tools/sdk/go/beta/models/lifecycle-state +tags: ['SDK', 'Software Development Kit', 'LifecycleState', 'BetaLifecycleState'] +--- + +# LifecycleState + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Lifecycle state ID. | [optional] [readonly] +**Name** | Pointer to **string** | Lifecycle state name. | [optional] [readonly] +**TechnicalName** | Pointer to **string** | Lifecycle state technical name. This is for internal use. | [optional] [readonly] +**Description** | Pointer to **string** | Lifecycle state description. | [optional] +**Created** | Pointer to **SailPointTime** | Lifecycle state created date. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Lifecycle state modified date. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Indicates whether the lifecycle state is enabled or disabled. | [optional] [default to false] +**IdentityCount** | Pointer to **int32** | Number of identities that have the lifecycle state. | [optional] [readonly] +**EmailNotificationOption** | Pointer to [**EmailNotificationOption**](email-notification-option) | | [optional] +**AccountActions** | Pointer to [**[]AccountAction**](account-action) | | [optional] +**AccessProfileIds** | Pointer to **[]string** | List of access-profile IDs that are associated with the lifecycle state. | [optional] + +## Methods + +### NewLifecycleState + +`func NewLifecycleState() *LifecycleState` + +NewLifecycleState instantiates a new LifecycleState 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 + +### NewLifecycleStateWithDefaults + +`func NewLifecycleStateWithDefaults() *LifecycleState` + +NewLifecycleStateWithDefaults instantiates a new LifecycleState 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 + +### GetId + +`func (o *LifecycleState) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LifecycleState) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LifecycleState) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LifecycleState) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *LifecycleState) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LifecycleState) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *LifecycleState) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *LifecycleState) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetTechnicalName + +`func (o *LifecycleState) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *LifecycleState) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *LifecycleState) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + +### HasTechnicalName + +`func (o *LifecycleState) HasTechnicalName() bool` + +HasTechnicalName returns a boolean if a field has been set. + +### GetDescription + +`func (o *LifecycleState) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *LifecycleState) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *LifecycleState) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *LifecycleState) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetCreated + +`func (o *LifecycleState) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LifecycleState) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *LifecycleState) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *LifecycleState) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *LifecycleState) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *LifecycleState) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *LifecycleState) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *LifecycleState) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetEnabled + +`func (o *LifecycleState) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *LifecycleState) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *LifecycleState) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *LifecycleState) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *LifecycleState) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *LifecycleState) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *LifecycleState) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *LifecycleState) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetEmailNotificationOption + +`func (o *LifecycleState) GetEmailNotificationOption() EmailNotificationOption` + +GetEmailNotificationOption returns the EmailNotificationOption field if non-nil, zero value otherwise. + +### GetEmailNotificationOptionOk + +`func (o *LifecycleState) GetEmailNotificationOptionOk() (*EmailNotificationOption, bool)` + +GetEmailNotificationOptionOk returns a tuple with the EmailNotificationOption field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationOption + +`func (o *LifecycleState) SetEmailNotificationOption(v EmailNotificationOption)` + +SetEmailNotificationOption sets EmailNotificationOption field to given value. + +### HasEmailNotificationOption + +`func (o *LifecycleState) HasEmailNotificationOption() bool` + +HasEmailNotificationOption returns a boolean if a field has been set. + +### GetAccountActions + +`func (o *LifecycleState) GetAccountActions() []AccountAction` + +GetAccountActions returns the AccountActions field if non-nil, zero value otherwise. + +### GetAccountActionsOk + +`func (o *LifecycleState) GetAccountActionsOk() (*[]AccountAction, bool)` + +GetAccountActionsOk returns a tuple with the AccountActions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActions + +`func (o *LifecycleState) SetAccountActions(v []AccountAction)` + +SetAccountActions sets AccountActions field to given value. + +### HasAccountActions + +`func (o *LifecycleState) HasAccountActions() bool` + +HasAccountActions returns a boolean if a field has been set. + +### GetAccessProfileIds + +`func (o *LifecycleState) GetAccessProfileIds() []string` + +GetAccessProfileIds returns the AccessProfileIds field if non-nil, zero value otherwise. + +### GetAccessProfileIdsOk + +`func (o *LifecycleState) GetAccessProfileIdsOk() (*[]string, bool)` + +GetAccessProfileIdsOk returns a tuple with the AccessProfileIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileIds + +`func (o *LifecycleState) SetAccessProfileIds(v []string)` + +SetAccessProfileIds sets AccessProfileIds field to given value. + +### HasAccessProfileIds + +`func (o *LifecycleState) HasAccessProfileIds() bool` + +HasAccessProfileIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LifecycleStateDto.md b/docs/tools/sdk/go/Reference/Beta/Models/LifecycleStateDto.md new file mode 100644 index 000000000..ffaf7568d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LifecycleStateDto.md @@ -0,0 +1,80 @@ +--- +id: beta-lifecycle-state-dto +title: LifecycleStateDto +pagination_label: LifecycleStateDto +sidebar_label: LifecycleStateDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LifecycleStateDto', 'BetaLifecycleStateDto'] +slug: /tools/sdk/go/beta/models/lifecycle-state-dto +tags: ['SDK', 'Software Development Kit', 'LifecycleStateDto', 'BetaLifecycleStateDto'] +--- + +# LifecycleStateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**StateName** | **string** | The name of the lifecycle state | +**ManuallyUpdated** | **bool** | Whether the lifecycle state has been manually or automatically set | + +## Methods + +### NewLifecycleStateDto + +`func NewLifecycleStateDto(stateName string, manuallyUpdated bool, ) *LifecycleStateDto` + +NewLifecycleStateDto instantiates a new LifecycleStateDto 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 + +### NewLifecycleStateDtoWithDefaults + +`func NewLifecycleStateDtoWithDefaults() *LifecycleStateDto` + +NewLifecycleStateDtoWithDefaults instantiates a new LifecycleStateDto 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 + +### GetStateName + +`func (o *LifecycleStateDto) GetStateName() string` + +GetStateName returns the StateName field if non-nil, zero value otherwise. + +### GetStateNameOk + +`func (o *LifecycleStateDto) GetStateNameOk() (*string, bool)` + +GetStateNameOk returns a tuple with the StateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStateName + +`func (o *LifecycleStateDto) SetStateName(v string)` + +SetStateName sets StateName field to given value. + + +### GetManuallyUpdated + +`func (o *LifecycleStateDto) GetManuallyUpdated() bool` + +GetManuallyUpdated returns the ManuallyUpdated field if non-nil, zero value otherwise. + +### GetManuallyUpdatedOk + +`func (o *LifecycleStateDto) GetManuallyUpdatedOk() (*bool, bool)` + +GetManuallyUpdatedOk returns a tuple with the ManuallyUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyUpdated + +`func (o *LifecycleStateDto) SetManuallyUpdated(v bool)` + +SetManuallyUpdated sets ManuallyUpdated field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ListAccessModelMetadataAttribute401Response.md b/docs/tools/sdk/go/Reference/Beta/Models/ListAccessModelMetadataAttribute401Response.md new file mode 100644 index 000000000..696f86565 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ListAccessModelMetadataAttribute401Response.md @@ -0,0 +1,64 @@ +--- +id: beta-list-access-model-metadata-attribute401-response +title: ListAccessModelMetadataAttribute401Response +pagination_label: ListAccessModelMetadataAttribute401Response +sidebar_label: ListAccessModelMetadataAttribute401Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListAccessModelMetadataAttribute401Response', 'BetaListAccessModelMetadataAttribute401Response'] +slug: /tools/sdk/go/beta/models/list-access-model-metadata-attribute401-response +tags: ['SDK', 'Software Development Kit', 'ListAccessModelMetadataAttribute401Response', 'BetaListAccessModelMetadataAttribute401Response'] +--- + +# ListAccessModelMetadataAttribute401Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Error** | Pointer to **map[string]interface{}** | A message describing the error | [optional] + +## Methods + +### NewListAccessModelMetadataAttribute401Response + +`func NewListAccessModelMetadataAttribute401Response() *ListAccessModelMetadataAttribute401Response` + +NewListAccessModelMetadataAttribute401Response instantiates a new ListAccessModelMetadataAttribute401Response 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 + +### NewListAccessModelMetadataAttribute401ResponseWithDefaults + +`func NewListAccessModelMetadataAttribute401ResponseWithDefaults() *ListAccessModelMetadataAttribute401Response` + +NewListAccessModelMetadataAttribute401ResponseWithDefaults instantiates a new ListAccessModelMetadataAttribute401Response 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 + +### GetError + +`func (o *ListAccessModelMetadataAttribute401Response) GetError() map[string]interface{}` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *ListAccessModelMetadataAttribute401Response) GetErrorOk() (*map[string]interface{}, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *ListAccessModelMetadataAttribute401Response) SetError(v map[string]interface{})` + +SetError sets Error field to given value. + +### HasError + +`func (o *ListAccessModelMetadataAttribute401Response) HasError() bool` + +HasError returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ListAccessModelMetadataAttribute429Response.md b/docs/tools/sdk/go/Reference/Beta/Models/ListAccessModelMetadataAttribute429Response.md new file mode 100644 index 000000000..294c8c499 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ListAccessModelMetadataAttribute429Response.md @@ -0,0 +1,64 @@ +--- +id: beta-list-access-model-metadata-attribute429-response +title: ListAccessModelMetadataAttribute429Response +pagination_label: ListAccessModelMetadataAttribute429Response +sidebar_label: ListAccessModelMetadataAttribute429Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListAccessModelMetadataAttribute429Response', 'BetaListAccessModelMetadataAttribute429Response'] +slug: /tools/sdk/go/beta/models/list-access-model-metadata-attribute429-response +tags: ['SDK', 'Software Development Kit', 'ListAccessModelMetadataAttribute429Response', 'BetaListAccessModelMetadataAttribute429Response'] +--- + +# ListAccessModelMetadataAttribute429Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **map[string]interface{}** | A message describing the error | [optional] + +## Methods + +### NewListAccessModelMetadataAttribute429Response + +`func NewListAccessModelMetadataAttribute429Response() *ListAccessModelMetadataAttribute429Response` + +NewListAccessModelMetadataAttribute429Response instantiates a new ListAccessModelMetadataAttribute429Response 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 + +### NewListAccessModelMetadataAttribute429ResponseWithDefaults + +`func NewListAccessModelMetadataAttribute429ResponseWithDefaults() *ListAccessModelMetadataAttribute429Response` + +NewListAccessModelMetadataAttribute429ResponseWithDefaults instantiates a new ListAccessModelMetadataAttribute429Response 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 + +### GetMessage + +`func (o *ListAccessModelMetadataAttribute429Response) GetMessage() map[string]interface{}` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *ListAccessModelMetadataAttribute429Response) GetMessageOk() (*map[string]interface{}, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *ListAccessModelMetadataAttribute429Response) SetMessage(v map[string]interface{})` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *ListAccessModelMetadataAttribute429Response) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ListCompleteWorkflowLibrary200ResponseInner.md b/docs/tools/sdk/go/Reference/Beta/Models/ListCompleteWorkflowLibrary200ResponseInner.md new file mode 100644 index 000000000..76ba7bf60 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ListCompleteWorkflowLibrary200ResponseInner.md @@ -0,0 +1,396 @@ +--- +id: beta-list-complete-workflow-library200-response-inner +title: ListCompleteWorkflowLibrary200ResponseInner +pagination_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListCompleteWorkflowLibrary200ResponseInner', 'BetaListCompleteWorkflowLibrary200ResponseInner'] +slug: /tools/sdk/go/beta/models/list-complete-workflow-library200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListCompleteWorkflowLibrary200ResponseInner', 'BetaListCompleteWorkflowLibrary200ResponseInner'] +--- + +# ListCompleteWorkflowLibrary200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Operator ID. | [optional] +**Name** | Pointer to **string** | Operator friendly name | [optional] +**Type** | Pointer to **string** | Operator type | [optional] +**Description** | Pointer to **string** | Description of the operator | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] +**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**Deprecated** | Pointer to **bool** | | [optional] +**DeprecatedBy** | Pointer to **SailPointTime** | | [optional] +**VersionNumber** | Pointer to **int32** | Version number | [optional] +**IsSimulationEnabled** | Pointer to **bool** | | [optional] +**IsDynamicSchema** | Pointer to **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**OutputSchema** | Pointer to **map[string]interface{}** | Example output schema | [optional] +**InputExample** | Pointer to **map[string]interface{}** | Example trigger payload if applicable | [optional] + +## Methods + +### NewListCompleteWorkflowLibrary200ResponseInner + +`func NewListCompleteWorkflowLibrary200ResponseInner() *ListCompleteWorkflowLibrary200ResponseInner` + +NewListCompleteWorkflowLibrary200ResponseInner instantiates a new ListCompleteWorkflowLibrary200ResponseInner 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 + +### NewListCompleteWorkflowLibrary200ResponseInnerWithDefaults + +`func NewListCompleteWorkflowLibrary200ResponseInnerWithDefaults() *ListCompleteWorkflowLibrary200ResponseInner` + +NewListCompleteWorkflowLibrary200ResponseInnerWithDefaults instantiates a new ListCompleteWorkflowLibrary200ResponseInner 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 + +### GetId + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDescription + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetFormFields + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetFormFields() []WorkflowLibraryFormFields` + +GetFormFields returns the FormFields field if non-nil, zero value otherwise. + +### GetFormFieldsOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetFormFieldsOk() (*[]WorkflowLibraryFormFields, bool)` + +GetFormFieldsOk returns a tuple with the FormFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormFields + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetFormFields(v []WorkflowLibraryFormFields)` + +SetFormFields sets FormFields field to given value. + +### HasFormFields + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasFormFields() bool` + +HasFormFields returns a boolean if a field has been set. + +### SetFormFieldsNil + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetFormFieldsNil(b bool)` + + SetFormFieldsNil sets the value for FormFields to be an explicit nil + +### UnsetFormFields +`func (o *ListCompleteWorkflowLibrary200ResponseInner) UnsetFormFields()` + +UnsetFormFields ensures that no value is present for FormFields, not even an explicit nil +### GetExampleOutput + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetExampleOutput() WorkflowLibraryActionExampleOutput` + +GetExampleOutput returns the ExampleOutput field if non-nil, zero value otherwise. + +### GetExampleOutputOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetExampleOutputOk() (*WorkflowLibraryActionExampleOutput, bool)` + +GetExampleOutputOk returns a tuple with the ExampleOutput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExampleOutput + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetExampleOutput(v WorkflowLibraryActionExampleOutput)` + +SetExampleOutput sets ExampleOutput field to given value. + +### HasExampleOutput + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasExampleOutput() bool` + +HasExampleOutput returns a boolean if a field has been set. + +### GetDeprecated + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDeprecated() bool` + +GetDeprecated returns the Deprecated field if non-nil, zero value otherwise. + +### GetDeprecatedOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDeprecatedOk() (*bool, bool)` + +GetDeprecatedOk returns a tuple with the Deprecated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecated + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetDeprecated(v bool)` + +SetDeprecated sets Deprecated field to given value. + +### HasDeprecated + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasDeprecated() bool` + +HasDeprecated returns a boolean if a field has been set. + +### GetDeprecatedBy + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDeprecatedBy() SailPointTime` + +GetDeprecatedBy returns the DeprecatedBy field if non-nil, zero value otherwise. + +### GetDeprecatedByOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDeprecatedByOk() (*SailPointTime, bool)` + +GetDeprecatedByOk returns a tuple with the DeprecatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecatedBy + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetDeprecatedBy(v SailPointTime)` + +SetDeprecatedBy sets DeprecatedBy field to given value. + +### HasDeprecatedBy + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasDeprecatedBy() bool` + +HasDeprecatedBy returns a boolean if a field has been set. + +### GetVersionNumber + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetVersionNumber() int32` + +GetVersionNumber returns the VersionNumber field if non-nil, zero value otherwise. + +### GetVersionNumberOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetVersionNumberOk() (*int32, bool)` + +GetVersionNumberOk returns a tuple with the VersionNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionNumber + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetVersionNumber(v int32)` + +SetVersionNumber sets VersionNumber field to given value. + +### HasVersionNumber + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasVersionNumber() bool` + +HasVersionNumber returns a boolean if a field has been set. + +### GetIsSimulationEnabled + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIsSimulationEnabled() bool` + +GetIsSimulationEnabled returns the IsSimulationEnabled field if non-nil, zero value otherwise. + +### GetIsSimulationEnabledOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIsSimulationEnabledOk() (*bool, bool)` + +GetIsSimulationEnabledOk returns a tuple with the IsSimulationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSimulationEnabled + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetIsSimulationEnabled(v bool)` + +SetIsSimulationEnabled sets IsSimulationEnabled field to given value. + +### HasIsSimulationEnabled + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasIsSimulationEnabled() bool` + +HasIsSimulationEnabled returns a boolean if a field has been set. + +### GetIsDynamicSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIsDynamicSchema() bool` + +GetIsDynamicSchema returns the IsDynamicSchema field if non-nil, zero value otherwise. + +### GetIsDynamicSchemaOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIsDynamicSchemaOk() (*bool, bool)` + +GetIsDynamicSchemaOk returns a tuple with the IsDynamicSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDynamicSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetIsDynamicSchema(v bool)` + +SetIsDynamicSchema sets IsDynamicSchema field to given value. + +### HasIsDynamicSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasIsDynamicSchema() bool` + +HasIsDynamicSchema returns a boolean if a field has been set. + +### GetOutputSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetOutputSchema() map[string]interface{}` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetOutputSchemaOk() (*map[string]interface{}, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetOutputSchema(v map[string]interface{})` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + +### GetInputExample + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetInputExample() map[string]interface{}` + +GetInputExample returns the InputExample field if non-nil, zero value otherwise. + +### GetInputExampleOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetInputExampleOk() (*map[string]interface{}, bool)` + +GetInputExampleOk returns a tuple with the InputExample field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInputExample + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetInputExample(v map[string]interface{})` + +SetInputExample sets InputExample field to given value. + +### HasInputExample + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasInputExample() bool` + +HasInputExample returns a boolean if a field has been set. + +### SetInputExampleNil + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetInputExampleNil(b bool)` + + SetInputExampleNil sets the value for InputExample to be an explicit nil + +### UnsetInputExample +`func (o *ListCompleteWorkflowLibrary200ResponseInner) UnsetInputExample()` + +UnsetInputExample ensures that no value is present for InputExample, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ListFormDefinitionsByTenantResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/ListFormDefinitionsByTenantResponse.md new file mode 100644 index 000000000..4ea6bb796 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ListFormDefinitionsByTenantResponse.md @@ -0,0 +1,90 @@ +--- +id: beta-list-form-definitions-by-tenant-response +title: ListFormDefinitionsByTenantResponse +pagination_label: ListFormDefinitionsByTenantResponse +sidebar_label: ListFormDefinitionsByTenantResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListFormDefinitionsByTenantResponse', 'BetaListFormDefinitionsByTenantResponse'] +slug: /tools/sdk/go/beta/models/list-form-definitions-by-tenant-response +tags: ['SDK', 'Software Development Kit', 'ListFormDefinitionsByTenantResponse', 'BetaListFormDefinitionsByTenantResponse'] +--- + +# ListFormDefinitionsByTenantResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **int64** | Count number of results. | [optional] +**Results** | Pointer to [**[]FormDefinitionResponse**](form-definition-response) | List of FormDefinitionResponse items. | [optional] + +## Methods + +### NewListFormDefinitionsByTenantResponse + +`func NewListFormDefinitionsByTenantResponse() *ListFormDefinitionsByTenantResponse` + +NewListFormDefinitionsByTenantResponse instantiates a new ListFormDefinitionsByTenantResponse 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 + +### NewListFormDefinitionsByTenantResponseWithDefaults + +`func NewListFormDefinitionsByTenantResponseWithDefaults() *ListFormDefinitionsByTenantResponse` + +NewListFormDefinitionsByTenantResponseWithDefaults instantiates a new ListFormDefinitionsByTenantResponse 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 + +### GetCount + +`func (o *ListFormDefinitionsByTenantResponse) GetCount() int64` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *ListFormDefinitionsByTenantResponse) GetCountOk() (*int64, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *ListFormDefinitionsByTenantResponse) SetCount(v int64)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *ListFormDefinitionsByTenantResponse) HasCount() bool` + +HasCount returns a boolean if a field has been set. + +### GetResults + +`func (o *ListFormDefinitionsByTenantResponse) GetResults() []FormDefinitionResponse` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *ListFormDefinitionsByTenantResponse) GetResultsOk() (*[]FormDefinitionResponse, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *ListFormDefinitionsByTenantResponse) SetResults(v []FormDefinitionResponse)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *ListFormDefinitionsByTenantResponse) HasResults() bool` + +HasResults returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ListFormElementDataByElementIDResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/ListFormElementDataByElementIDResponse.md new file mode 100644 index 000000000..792575d4e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ListFormElementDataByElementIDResponse.md @@ -0,0 +1,64 @@ +--- +id: beta-list-form-element-data-by-element-id-response +title: ListFormElementDataByElementIDResponse +pagination_label: ListFormElementDataByElementIDResponse +sidebar_label: ListFormElementDataByElementIDResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListFormElementDataByElementIDResponse', 'BetaListFormElementDataByElementIDResponse'] +slug: /tools/sdk/go/beta/models/list-form-element-data-by-element-id-response +tags: ['SDK', 'Software Development Kit', 'ListFormElementDataByElementIDResponse', 'BetaListFormElementDataByElementIDResponse'] +--- + +# ListFormElementDataByElementIDResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | Pointer to [**[]FormElementDataSourceConfigOptions**](form-element-data-source-config-options) | Results holds a list of FormElementDataSourceConfigOptions items | [optional] + +## Methods + +### NewListFormElementDataByElementIDResponse + +`func NewListFormElementDataByElementIDResponse() *ListFormElementDataByElementIDResponse` + +NewListFormElementDataByElementIDResponse instantiates a new ListFormElementDataByElementIDResponse 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 + +### NewListFormElementDataByElementIDResponseWithDefaults + +`func NewListFormElementDataByElementIDResponseWithDefaults() *ListFormElementDataByElementIDResponse` + +NewListFormElementDataByElementIDResponseWithDefaults instantiates a new ListFormElementDataByElementIDResponse 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 + +### GetResults + +`func (o *ListFormElementDataByElementIDResponse) GetResults() []FormElementDataSourceConfigOptions` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *ListFormElementDataByElementIDResponse) GetResultsOk() (*[]FormElementDataSourceConfigOptions, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *ListFormElementDataByElementIDResponse) SetResults(v []FormElementDataSourceConfigOptions)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *ListFormElementDataByElementIDResponse) HasResults() bool` + +HasResults returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ListIdentityAccessItems200ResponseInner.md b/docs/tools/sdk/go/Reference/Beta/Models/ListIdentityAccessItems200ResponseInner.md new file mode 100644 index 000000000..8c6e804f1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ListIdentityAccessItems200ResponseInner.md @@ -0,0 +1,512 @@ +--- +id: beta-list-identity-access-items200-response-inner +title: ListIdentityAccessItems200ResponseInner +pagination_label: ListIdentityAccessItems200ResponseInner +sidebar_label: ListIdentityAccessItems200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListIdentityAccessItems200ResponseInner', 'BetaListIdentityAccessItems200ResponseInner'] +slug: /tools/sdk/go/beta/models/list-identity-access-items200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListIdentityAccessItems200ResponseInner', 'BetaListIdentityAccessItems200ResponseInner'] +--- + +# ListIdentityAccessItems200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. role in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**Name** | Pointer to **string** | the access profile name | [optional] +**SourceName** | Pointer to **string** | the associated source name if it exists | [optional] +**SourceId** | Pointer to **string** | the id of the source | [optional] +**Description** | Pointer to **string** | the description for the role | [optional] +**DisplayName** | Pointer to **string** | the role display name | [optional] +**EntitlementCount** | Pointer to **string** | the number of entitlements the account will create | [optional] +**AppDisplayName** | Pointer to **string** | the name of | [optional] +**RemoveDate** | Pointer to **string** | the date the role is no longer assigned to the specified identity | [optional] +**Standalone** | **bool** | indicates whether the entitlement is standalone | +**Revocable** | **bool** | indicates whether the role is revocable | +**NativeIdentity** | Pointer to **string** | the native identifier used to uniquely identify an acccount | [optional] +**AppRoleId** | Pointer to **string** | the app role id | [optional] +**Attribute** | Pointer to **string** | the entitlement attribute | [optional] +**Value** | Pointer to **string** | the associated value | [optional] +**EntitlementType** | Pointer to **string** | the type of entitlement | [optional] +**Privileged** | **bool** | indicates whether the entitlement is privileged | +**CloudGoverned** | **bool** | indicates whether the entitlement is cloud governed | + +## Methods + +### NewListIdentityAccessItems200ResponseInner + +`func NewListIdentityAccessItems200ResponseInner(standalone bool, revocable bool, privileged bool, cloudGoverned bool, ) *ListIdentityAccessItems200ResponseInner` + +NewListIdentityAccessItems200ResponseInner instantiates a new ListIdentityAccessItems200ResponseInner 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 + +### NewListIdentityAccessItems200ResponseInnerWithDefaults + +`func NewListIdentityAccessItems200ResponseInnerWithDefaults() *ListIdentityAccessItems200ResponseInner` + +NewListIdentityAccessItems200ResponseInnerWithDefaults instantiates a new ListIdentityAccessItems200ResponseInner 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 + +### GetAccessType + +`func (o *ListIdentityAccessItems200ResponseInner) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *ListIdentityAccessItems200ResponseInner) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *ListIdentityAccessItems200ResponseInner) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *ListIdentityAccessItems200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ListIdentityAccessItems200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ListIdentityAccessItems200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ListIdentityAccessItems200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ListIdentityAccessItems200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ListIdentityAccessItems200ResponseInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *ListIdentityAccessItems200ResponseInner) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *ListIdentityAccessItems200ResponseInner) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *ListIdentityAccessItems200ResponseInner) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *ListIdentityAccessItems200ResponseInner) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *ListIdentityAccessItems200ResponseInner) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *ListIdentityAccessItems200ResponseInner) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetDescription + +`func (o *ListIdentityAccessItems200ResponseInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ListIdentityAccessItems200ResponseInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ListIdentityAccessItems200ResponseInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *ListIdentityAccessItems200ResponseInner) GetEntitlementCount() string` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetEntitlementCountOk() (*string, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *ListIdentityAccessItems200ResponseInner) SetEntitlementCount(v string)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *ListIdentityAccessItems200ResponseInner) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetAppDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) GetAppDisplayName() string` + +GetAppDisplayName returns the AppDisplayName field if non-nil, zero value otherwise. + +### GetAppDisplayNameOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetAppDisplayNameOk() (*string, bool)` + +GetAppDisplayNameOk returns a tuple with the AppDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) SetAppDisplayName(v string)` + +SetAppDisplayName sets AppDisplayName field to given value. + +### HasAppDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) HasAppDisplayName() bool` + +HasAppDisplayName returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *ListIdentityAccessItems200ResponseInner) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *ListIdentityAccessItems200ResponseInner) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *ListIdentityAccessItems200ResponseInner) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetStandalone + +`func (o *ListIdentityAccessItems200ResponseInner) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *ListIdentityAccessItems200ResponseInner) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + + +### GetRevocable + +`func (o *ListIdentityAccessItems200ResponseInner) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *ListIdentityAccessItems200ResponseInner) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + + +### GetNativeIdentity + +`func (o *ListIdentityAccessItems200ResponseInner) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *ListIdentityAccessItems200ResponseInner) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *ListIdentityAccessItems200ResponseInner) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetAppRoleId + +`func (o *ListIdentityAccessItems200ResponseInner) GetAppRoleId() string` + +GetAppRoleId returns the AppRoleId field if non-nil, zero value otherwise. + +### GetAppRoleIdOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetAppRoleIdOk() (*string, bool)` + +GetAppRoleIdOk returns a tuple with the AppRoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppRoleId + +`func (o *ListIdentityAccessItems200ResponseInner) SetAppRoleId(v string)` + +SetAppRoleId sets AppRoleId field to given value. + +### HasAppRoleId + +`func (o *ListIdentityAccessItems200ResponseInner) HasAppRoleId() bool` + +HasAppRoleId returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ListIdentityAccessItems200ResponseInner) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ListIdentityAccessItems200ResponseInner) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ListIdentityAccessItems200ResponseInner) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *ListIdentityAccessItems200ResponseInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ListIdentityAccessItems200ResponseInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ListIdentityAccessItems200ResponseInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetEntitlementType + +`func (o *ListIdentityAccessItems200ResponseInner) GetEntitlementType() string` + +GetEntitlementType returns the EntitlementType field if non-nil, zero value otherwise. + +### GetEntitlementTypeOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetEntitlementTypeOk() (*string, bool)` + +GetEntitlementTypeOk returns a tuple with the EntitlementType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementType + +`func (o *ListIdentityAccessItems200ResponseInner) SetEntitlementType(v string)` + +SetEntitlementType sets EntitlementType field to given value. + +### HasEntitlementType + +`func (o *ListIdentityAccessItems200ResponseInner) HasEntitlementType() bool` + +HasEntitlementType returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *ListIdentityAccessItems200ResponseInner) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *ListIdentityAccessItems200ResponseInner) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + + +### GetCloudGoverned + +`func (o *ListIdentityAccessItems200ResponseInner) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *ListIdentityAccessItems200ResponseInner) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ListPredefinedSelectOptionsResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/ListPredefinedSelectOptionsResponse.md new file mode 100644 index 000000000..e8841b269 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ListPredefinedSelectOptionsResponse.md @@ -0,0 +1,64 @@ +--- +id: beta-list-predefined-select-options-response +title: ListPredefinedSelectOptionsResponse +pagination_label: ListPredefinedSelectOptionsResponse +sidebar_label: ListPredefinedSelectOptionsResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListPredefinedSelectOptionsResponse', 'BetaListPredefinedSelectOptionsResponse'] +slug: /tools/sdk/go/beta/models/list-predefined-select-options-response +tags: ['SDK', 'Software Development Kit', 'ListPredefinedSelectOptionsResponse', 'BetaListPredefinedSelectOptionsResponse'] +--- + +# ListPredefinedSelectOptionsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | Pointer to **[]string** | Results holds a list of PreDefinedSelectOption items | [optional] + +## Methods + +### NewListPredefinedSelectOptionsResponse + +`func NewListPredefinedSelectOptionsResponse() *ListPredefinedSelectOptionsResponse` + +NewListPredefinedSelectOptionsResponse instantiates a new ListPredefinedSelectOptionsResponse 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 + +### NewListPredefinedSelectOptionsResponseWithDefaults + +`func NewListPredefinedSelectOptionsResponseWithDefaults() *ListPredefinedSelectOptionsResponse` + +NewListPredefinedSelectOptionsResponseWithDefaults instantiates a new ListPredefinedSelectOptionsResponse 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 + +### GetResults + +`func (o *ListPredefinedSelectOptionsResponse) GetResults() []string` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *ListPredefinedSelectOptionsResponse) GetResultsOk() (*[]string, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *ListPredefinedSelectOptionsResponse) SetResults(v []string)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *ListPredefinedSelectOptionsResponse) HasResults() bool` + +HasResults returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ListWorkgroupMembers200ResponseInner.md b/docs/tools/sdk/go/Reference/Beta/Models/ListWorkgroupMembers200ResponseInner.md new file mode 100644 index 000000000..e2a25d07a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ListWorkgroupMembers200ResponseInner.md @@ -0,0 +1,142 @@ +--- +id: beta-list-workgroup-members200-response-inner +title: ListWorkgroupMembers200ResponseInner +pagination_label: ListWorkgroupMembers200ResponseInner +sidebar_label: ListWorkgroupMembers200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListWorkgroupMembers200ResponseInner', 'BetaListWorkgroupMembers200ResponseInner'] +slug: /tools/sdk/go/beta/models/list-workgroup-members200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListWorkgroupMembers200ResponseInner', 'BetaListWorkgroupMembers200ResponseInner'] +--- + +# ListWorkgroupMembers200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Workgroup member identity DTO type. | [optional] +**Id** | Pointer to **string** | Workgroup member identity ID. | [optional] +**Name** | Pointer to **string** | Workgroup member identity display name. | [optional] +**Email** | Pointer to **string** | Workgroup member identity email. | [optional] + +## Methods + +### NewListWorkgroupMembers200ResponseInner + +`func NewListWorkgroupMembers200ResponseInner() *ListWorkgroupMembers200ResponseInner` + +NewListWorkgroupMembers200ResponseInner instantiates a new ListWorkgroupMembers200ResponseInner 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 + +### NewListWorkgroupMembers200ResponseInnerWithDefaults + +`func NewListWorkgroupMembers200ResponseInnerWithDefaults() *ListWorkgroupMembers200ResponseInner` + +NewListWorkgroupMembers200ResponseInnerWithDefaults instantiates a new ListWorkgroupMembers200ResponseInner 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 + +### GetType + +`func (o *ListWorkgroupMembers200ResponseInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ListWorkgroupMembers200ResponseInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ListWorkgroupMembers200ResponseInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ListWorkgroupMembers200ResponseInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ListWorkgroupMembers200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ListWorkgroupMembers200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ListWorkgroupMembers200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ListWorkgroupMembers200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ListWorkgroupMembers200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ListWorkgroupMembers200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ListWorkgroupMembers200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ListWorkgroupMembers200ResponseInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *ListWorkgroupMembers200ResponseInner) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *ListWorkgroupMembers200ResponseInner) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *ListWorkgroupMembers200ResponseInner) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *ListWorkgroupMembers200ResponseInner) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LoadAccountsTask.md b/docs/tools/sdk/go/Reference/Beta/Models/LoadAccountsTask.md new file mode 100644 index 000000000..a92b8c878 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LoadAccountsTask.md @@ -0,0 +1,90 @@ +--- +id: beta-load-accounts-task +title: LoadAccountsTask +pagination_label: LoadAccountsTask +sidebar_label: LoadAccountsTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadAccountsTask', 'BetaLoadAccountsTask'] +slug: /tools/sdk/go/beta/models/load-accounts-task +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTask', 'BetaLoadAccountsTask'] +--- + +# LoadAccountsTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Success** | Pointer to **bool** | The status of the result | [optional] [default to true] +**Task** | Pointer to [**LoadAccountsTaskTask**](load-accounts-task-task) | | [optional] + +## Methods + +### NewLoadAccountsTask + +`func NewLoadAccountsTask() *LoadAccountsTask` + +NewLoadAccountsTask instantiates a new LoadAccountsTask 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 + +### NewLoadAccountsTaskWithDefaults + +`func NewLoadAccountsTaskWithDefaults() *LoadAccountsTask` + +NewLoadAccountsTaskWithDefaults instantiates a new LoadAccountsTask 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 + +### GetSuccess + +`func (o *LoadAccountsTask) GetSuccess() bool` + +GetSuccess returns the Success field if non-nil, zero value otherwise. + +### GetSuccessOk + +`func (o *LoadAccountsTask) GetSuccessOk() (*bool, bool)` + +GetSuccessOk returns a tuple with the Success field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSuccess + +`func (o *LoadAccountsTask) SetSuccess(v bool)` + +SetSuccess sets Success field to given value. + +### HasSuccess + +`func (o *LoadAccountsTask) HasSuccess() bool` + +HasSuccess returns a boolean if a field has been set. + +### GetTask + +`func (o *LoadAccountsTask) GetTask() LoadAccountsTaskTask` + +GetTask returns the Task field if non-nil, zero value otherwise. + +### GetTaskOk + +`func (o *LoadAccountsTask) GetTaskOk() (*LoadAccountsTaskTask, bool)` + +GetTaskOk returns a tuple with the Task field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTask + +`func (o *LoadAccountsTask) SetTask(v LoadAccountsTaskTask)` + +SetTask sets Task field to given value. + +### HasTask + +`func (o *LoadAccountsTask) HasTask() bool` + +HasTask returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LoadAccountsTaskTask.md b/docs/tools/sdk/go/Reference/Beta/Models/LoadAccountsTaskTask.md new file mode 100644 index 000000000..8bbe35920 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LoadAccountsTaskTask.md @@ -0,0 +1,452 @@ +--- +id: beta-load-accounts-task-task +title: LoadAccountsTaskTask +pagination_label: LoadAccountsTaskTask +sidebar_label: LoadAccountsTaskTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadAccountsTaskTask', 'BetaLoadAccountsTaskTask'] +slug: /tools/sdk/go/beta/models/load-accounts-task-task +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTask', 'BetaLoadAccountsTaskTask'] +--- + +# LoadAccountsTaskTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the task this taskStatus represents | [optional] +**Type** | Pointer to **string** | Type of task this task represents | [optional] +**Name** | Pointer to **string** | The name of the aggregation process | [optional] +**Description** | Pointer to **string** | The description of the task | [optional] +**Launcher** | Pointer to **string** | The user who initiated the task | [optional] +**Created** | Pointer to **SailPointTime** | The Task creation date | [optional] +**Launched** | Pointer to **NullableTime** | The task start date | [optional] +**Completed** | Pointer to **NullableTime** | The task completion date | [optional] +**CompletionStatus** | Pointer to **NullableString** | Task completion status. | [optional] +**ParentName** | Pointer to **NullableString** | Name of the parent task if exists. | [optional] +**Messages** | Pointer to [**[]LoadAccountsTaskTaskMessagesInner**](load-accounts-task-task-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**Progress** | Pointer to **NullableString** | Current task state. | [optional] +**Attributes** | Pointer to [**LoadAccountsTaskTaskAttributes**](load-accounts-task-task-attributes) | | [optional] +**Returns** | Pointer to [**[]LoadAccountsTaskTaskReturnsInner**](load-accounts-task-task-returns-inner) | Return values from the task | [optional] + +## Methods + +### NewLoadAccountsTaskTask + +`func NewLoadAccountsTaskTask() *LoadAccountsTaskTask` + +NewLoadAccountsTaskTask instantiates a new LoadAccountsTaskTask 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 + +### NewLoadAccountsTaskTaskWithDefaults + +`func NewLoadAccountsTaskTaskWithDefaults() *LoadAccountsTaskTask` + +NewLoadAccountsTaskTaskWithDefaults instantiates a new LoadAccountsTaskTask 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 + +### GetId + +`func (o *LoadAccountsTaskTask) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LoadAccountsTaskTask) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LoadAccountsTaskTask) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LoadAccountsTaskTask) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *LoadAccountsTaskTask) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LoadAccountsTaskTask) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LoadAccountsTaskTask) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LoadAccountsTaskTask) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *LoadAccountsTaskTask) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LoadAccountsTaskTask) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *LoadAccountsTaskTask) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *LoadAccountsTaskTask) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *LoadAccountsTaskTask) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *LoadAccountsTaskTask) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *LoadAccountsTaskTask) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *LoadAccountsTaskTask) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetLauncher + +`func (o *LoadAccountsTaskTask) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *LoadAccountsTaskTask) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *LoadAccountsTaskTask) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + +### HasLauncher + +`func (o *LoadAccountsTaskTask) HasLauncher() bool` + +HasLauncher returns a boolean if a field has been set. + +### GetCreated + +`func (o *LoadAccountsTaskTask) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LoadAccountsTaskTask) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *LoadAccountsTaskTask) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *LoadAccountsTaskTask) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetLaunched + +`func (o *LoadAccountsTaskTask) GetLaunched() SailPointTime` + +GetLaunched returns the Launched field if non-nil, zero value otherwise. + +### GetLaunchedOk + +`func (o *LoadAccountsTaskTask) GetLaunchedOk() (*SailPointTime, bool)` + +GetLaunchedOk returns a tuple with the Launched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunched + +`func (o *LoadAccountsTaskTask) SetLaunched(v SailPointTime)` + +SetLaunched sets Launched field to given value. + +### HasLaunched + +`func (o *LoadAccountsTaskTask) HasLaunched() bool` + +HasLaunched returns a boolean if a field has been set. + +### SetLaunchedNil + +`func (o *LoadAccountsTaskTask) SetLaunchedNil(b bool)` + + SetLaunchedNil sets the value for Launched to be an explicit nil + +### UnsetLaunched +`func (o *LoadAccountsTaskTask) UnsetLaunched()` + +UnsetLaunched ensures that no value is present for Launched, not even an explicit nil +### GetCompleted + +`func (o *LoadAccountsTaskTask) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *LoadAccountsTaskTask) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *LoadAccountsTaskTask) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *LoadAccountsTaskTask) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *LoadAccountsTaskTask) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *LoadAccountsTaskTask) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetCompletionStatus + +`func (o *LoadAccountsTaskTask) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *LoadAccountsTaskTask) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *LoadAccountsTaskTask) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *LoadAccountsTaskTask) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + +### SetCompletionStatusNil + +`func (o *LoadAccountsTaskTask) SetCompletionStatusNil(b bool)` + + SetCompletionStatusNil sets the value for CompletionStatus to be an explicit nil + +### UnsetCompletionStatus +`func (o *LoadAccountsTaskTask) UnsetCompletionStatus()` + +UnsetCompletionStatus ensures that no value is present for CompletionStatus, not even an explicit nil +### GetParentName + +`func (o *LoadAccountsTaskTask) GetParentName() string` + +GetParentName returns the ParentName field if non-nil, zero value otherwise. + +### GetParentNameOk + +`func (o *LoadAccountsTaskTask) GetParentNameOk() (*string, bool)` + +GetParentNameOk returns a tuple with the ParentName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentName + +`func (o *LoadAccountsTaskTask) SetParentName(v string)` + +SetParentName sets ParentName field to given value. + +### HasParentName + +`func (o *LoadAccountsTaskTask) HasParentName() bool` + +HasParentName returns a boolean if a field has been set. + +### SetParentNameNil + +`func (o *LoadAccountsTaskTask) SetParentNameNil(b bool)` + + SetParentNameNil sets the value for ParentName to be an explicit nil + +### UnsetParentName +`func (o *LoadAccountsTaskTask) UnsetParentName()` + +UnsetParentName ensures that no value is present for ParentName, not even an explicit nil +### GetMessages + +`func (o *LoadAccountsTaskTask) GetMessages() []LoadAccountsTaskTaskMessagesInner` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *LoadAccountsTaskTask) GetMessagesOk() (*[]LoadAccountsTaskTaskMessagesInner, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *LoadAccountsTaskTask) SetMessages(v []LoadAccountsTaskTaskMessagesInner)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *LoadAccountsTaskTask) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetProgress + +`func (o *LoadAccountsTaskTask) GetProgress() string` + +GetProgress returns the Progress field if non-nil, zero value otherwise. + +### GetProgressOk + +`func (o *LoadAccountsTaskTask) GetProgressOk() (*string, bool)` + +GetProgressOk returns a tuple with the Progress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProgress + +`func (o *LoadAccountsTaskTask) SetProgress(v string)` + +SetProgress sets Progress field to given value. + +### HasProgress + +`func (o *LoadAccountsTaskTask) HasProgress() bool` + +HasProgress returns a boolean if a field has been set. + +### SetProgressNil + +`func (o *LoadAccountsTaskTask) SetProgressNil(b bool)` + + SetProgressNil sets the value for Progress to be an explicit nil + +### UnsetProgress +`func (o *LoadAccountsTaskTask) UnsetProgress()` + +UnsetProgress ensures that no value is present for Progress, not even an explicit nil +### GetAttributes + +`func (o *LoadAccountsTaskTask) GetAttributes() LoadAccountsTaskTaskAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *LoadAccountsTaskTask) GetAttributesOk() (*LoadAccountsTaskTaskAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *LoadAccountsTaskTask) SetAttributes(v LoadAccountsTaskTaskAttributes)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *LoadAccountsTaskTask) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetReturns + +`func (o *LoadAccountsTaskTask) GetReturns() []LoadAccountsTaskTaskReturnsInner` + +GetReturns returns the Returns field if non-nil, zero value otherwise. + +### GetReturnsOk + +`func (o *LoadAccountsTaskTask) GetReturnsOk() (*[]LoadAccountsTaskTaskReturnsInner, bool)` + +GetReturnsOk returns a tuple with the Returns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReturns + +`func (o *LoadAccountsTaskTask) SetReturns(v []LoadAccountsTaskTaskReturnsInner)` + +SetReturns sets Returns field to given value. + +### HasReturns + +`func (o *LoadAccountsTaskTask) HasReturns() bool` + +HasReturns returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LoadAccountsTaskTaskAttributes.md b/docs/tools/sdk/go/Reference/Beta/Models/LoadAccountsTaskTaskAttributes.md new file mode 100644 index 000000000..59c5ccbb3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LoadAccountsTaskTaskAttributes.md @@ -0,0 +1,90 @@ +--- +id: beta-load-accounts-task-task-attributes +title: LoadAccountsTaskTaskAttributes +pagination_label: LoadAccountsTaskTaskAttributes +sidebar_label: LoadAccountsTaskTaskAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadAccountsTaskTaskAttributes', 'BetaLoadAccountsTaskTaskAttributes'] +slug: /tools/sdk/go/beta/models/load-accounts-task-task-attributes +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskAttributes', 'BetaLoadAccountsTaskTaskAttributes'] +--- + +# LoadAccountsTaskTaskAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AppId** | Pointer to **string** | The id of the source | [optional] +**OptimizedAggregation** | Pointer to **string** | The indicator if the aggregation process was enabled/disabled for the aggregation job | [optional] + +## Methods + +### NewLoadAccountsTaskTaskAttributes + +`func NewLoadAccountsTaskTaskAttributes() *LoadAccountsTaskTaskAttributes` + +NewLoadAccountsTaskTaskAttributes instantiates a new LoadAccountsTaskTaskAttributes 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 + +### NewLoadAccountsTaskTaskAttributesWithDefaults + +`func NewLoadAccountsTaskTaskAttributesWithDefaults() *LoadAccountsTaskTaskAttributes` + +NewLoadAccountsTaskTaskAttributesWithDefaults instantiates a new LoadAccountsTaskTaskAttributes 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 + +### GetAppId + +`func (o *LoadAccountsTaskTaskAttributes) GetAppId() string` + +GetAppId returns the AppId field if non-nil, zero value otherwise. + +### GetAppIdOk + +`func (o *LoadAccountsTaskTaskAttributes) GetAppIdOk() (*string, bool)` + +GetAppIdOk returns a tuple with the AppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppId + +`func (o *LoadAccountsTaskTaskAttributes) SetAppId(v string)` + +SetAppId sets AppId field to given value. + +### HasAppId + +`func (o *LoadAccountsTaskTaskAttributes) HasAppId() bool` + +HasAppId returns a boolean if a field has been set. + +### GetOptimizedAggregation + +`func (o *LoadAccountsTaskTaskAttributes) GetOptimizedAggregation() string` + +GetOptimizedAggregation returns the OptimizedAggregation field if non-nil, zero value otherwise. + +### GetOptimizedAggregationOk + +`func (o *LoadAccountsTaskTaskAttributes) GetOptimizedAggregationOk() (*string, bool)` + +GetOptimizedAggregationOk returns a tuple with the OptimizedAggregation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOptimizedAggregation + +`func (o *LoadAccountsTaskTaskAttributes) SetOptimizedAggregation(v string)` + +SetOptimizedAggregation sets OptimizedAggregation field to given value. + +### HasOptimizedAggregation + +`func (o *LoadAccountsTaskTaskAttributes) HasOptimizedAggregation() bool` + +HasOptimizedAggregation returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LoadAccountsTaskTaskMessagesInner.md b/docs/tools/sdk/go/Reference/Beta/Models/LoadAccountsTaskTaskMessagesInner.md new file mode 100644 index 000000000..23c0d4daf --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LoadAccountsTaskTaskMessagesInner.md @@ -0,0 +1,168 @@ +--- +id: beta-load-accounts-task-task-messages-inner +title: LoadAccountsTaskTaskMessagesInner +pagination_label: LoadAccountsTaskTaskMessagesInner +sidebar_label: LoadAccountsTaskTaskMessagesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadAccountsTaskTaskMessagesInner', 'BetaLoadAccountsTaskTaskMessagesInner'] +slug: /tools/sdk/go/beta/models/load-accounts-task-task-messages-inner +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskMessagesInner', 'BetaLoadAccountsTaskTaskMessagesInner'] +--- + +# LoadAccountsTaskTaskMessagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the message. | [optional] +**Error** | Pointer to **bool** | Flag whether message is an error. | [optional] [default to false] +**Warning** | Pointer to **bool** | Flag whether message is a warning. | [optional] [default to false] +**Key** | Pointer to **string** | Message string identifier. | [optional] +**LocalizedText** | Pointer to **string** | Message context with the locale based language. | [optional] + +## Methods + +### NewLoadAccountsTaskTaskMessagesInner + +`func NewLoadAccountsTaskTaskMessagesInner() *LoadAccountsTaskTaskMessagesInner` + +NewLoadAccountsTaskTaskMessagesInner instantiates a new LoadAccountsTaskTaskMessagesInner 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 + +### NewLoadAccountsTaskTaskMessagesInnerWithDefaults + +`func NewLoadAccountsTaskTaskMessagesInnerWithDefaults() *LoadAccountsTaskTaskMessagesInner` + +NewLoadAccountsTaskTaskMessagesInnerWithDefaults instantiates a new LoadAccountsTaskTaskMessagesInner 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 + +### GetType + +`func (o *LoadAccountsTaskTaskMessagesInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LoadAccountsTaskTaskMessagesInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LoadAccountsTaskTaskMessagesInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LoadAccountsTaskTaskMessagesInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetError + +`func (o *LoadAccountsTaskTaskMessagesInner) GetError() bool` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *LoadAccountsTaskTaskMessagesInner) GetErrorOk() (*bool, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *LoadAccountsTaskTaskMessagesInner) SetError(v bool)` + +SetError sets Error field to given value. + +### HasError + +`func (o *LoadAccountsTaskTaskMessagesInner) HasError() bool` + +HasError returns a boolean if a field has been set. + +### GetWarning + +`func (o *LoadAccountsTaskTaskMessagesInner) GetWarning() bool` + +GetWarning returns the Warning field if non-nil, zero value otherwise. + +### GetWarningOk + +`func (o *LoadAccountsTaskTaskMessagesInner) GetWarningOk() (*bool, bool)` + +GetWarningOk returns a tuple with the Warning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarning + +`func (o *LoadAccountsTaskTaskMessagesInner) SetWarning(v bool)` + +SetWarning sets Warning field to given value. + +### HasWarning + +`func (o *LoadAccountsTaskTaskMessagesInner) HasWarning() bool` + +HasWarning returns a boolean if a field has been set. + +### GetKey + +`func (o *LoadAccountsTaskTaskMessagesInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *LoadAccountsTaskTaskMessagesInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *LoadAccountsTaskTaskMessagesInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *LoadAccountsTaskTaskMessagesInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetLocalizedText + +`func (o *LoadAccountsTaskTaskMessagesInner) GetLocalizedText() string` + +GetLocalizedText returns the LocalizedText field if non-nil, zero value otherwise. + +### GetLocalizedTextOk + +`func (o *LoadAccountsTaskTaskMessagesInner) GetLocalizedTextOk() (*string, bool)` + +GetLocalizedTextOk returns a tuple with the LocalizedText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizedText + +`func (o *LoadAccountsTaskTaskMessagesInner) SetLocalizedText(v string)` + +SetLocalizedText sets LocalizedText field to given value. + +### HasLocalizedText + +`func (o *LoadAccountsTaskTaskMessagesInner) HasLocalizedText() bool` + +HasLocalizedText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LoadAccountsTaskTaskReturnsInner.md b/docs/tools/sdk/go/Reference/Beta/Models/LoadAccountsTaskTaskReturnsInner.md new file mode 100644 index 000000000..dc054819e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LoadAccountsTaskTaskReturnsInner.md @@ -0,0 +1,90 @@ +--- +id: beta-load-accounts-task-task-returns-inner +title: LoadAccountsTaskTaskReturnsInner +pagination_label: LoadAccountsTaskTaskReturnsInner +sidebar_label: LoadAccountsTaskTaskReturnsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadAccountsTaskTaskReturnsInner', 'BetaLoadAccountsTaskTaskReturnsInner'] +slug: /tools/sdk/go/beta/models/load-accounts-task-task-returns-inner +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskReturnsInner', 'BetaLoadAccountsTaskTaskReturnsInner'] +--- + +# LoadAccountsTaskTaskReturnsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayLabel** | Pointer to **string** | The display label of the return value | [optional] +**AttributeName** | Pointer to **string** | The attribute name of the return value | [optional] + +## Methods + +### NewLoadAccountsTaskTaskReturnsInner + +`func NewLoadAccountsTaskTaskReturnsInner() *LoadAccountsTaskTaskReturnsInner` + +NewLoadAccountsTaskTaskReturnsInner instantiates a new LoadAccountsTaskTaskReturnsInner 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 + +### NewLoadAccountsTaskTaskReturnsInnerWithDefaults + +`func NewLoadAccountsTaskTaskReturnsInnerWithDefaults() *LoadAccountsTaskTaskReturnsInner` + +NewLoadAccountsTaskTaskReturnsInnerWithDefaults instantiates a new LoadAccountsTaskTaskReturnsInner 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 + +### GetDisplayLabel + +`func (o *LoadAccountsTaskTaskReturnsInner) GetDisplayLabel() string` + +GetDisplayLabel returns the DisplayLabel field if non-nil, zero value otherwise. + +### GetDisplayLabelOk + +`func (o *LoadAccountsTaskTaskReturnsInner) GetDisplayLabelOk() (*string, bool)` + +GetDisplayLabelOk returns a tuple with the DisplayLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayLabel + +`func (o *LoadAccountsTaskTaskReturnsInner) SetDisplayLabel(v string)` + +SetDisplayLabel sets DisplayLabel field to given value. + +### HasDisplayLabel + +`func (o *LoadAccountsTaskTaskReturnsInner) HasDisplayLabel() bool` + +HasDisplayLabel returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *LoadAccountsTaskTaskReturnsInner) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *LoadAccountsTaskTaskReturnsInner) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *LoadAccountsTaskTaskReturnsInner) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *LoadAccountsTaskTaskReturnsInner) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LoadEntitlementTask.md b/docs/tools/sdk/go/Reference/Beta/Models/LoadEntitlementTask.md new file mode 100644 index 000000000..6fb8e2c10 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LoadEntitlementTask.md @@ -0,0 +1,220 @@ +--- +id: beta-load-entitlement-task +title: LoadEntitlementTask +pagination_label: LoadEntitlementTask +sidebar_label: LoadEntitlementTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadEntitlementTask', 'BetaLoadEntitlementTask'] +slug: /tools/sdk/go/beta/models/load-entitlement-task +tags: ['SDK', 'Software Development Kit', 'LoadEntitlementTask', 'BetaLoadEntitlementTask'] +--- + +# LoadEntitlementTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the task this taskStatus represents | [optional] +**Type** | Pointer to **string** | Type of task this task represents | [optional] +**UniqueName** | Pointer to **string** | The name of the task | [optional] +**Description** | Pointer to **string** | The description of the task | [optional] +**Launcher** | Pointer to **string** | The user who initiated the task | [optional] +**Created** | Pointer to **SailPointTime** | The creation date of the task | [optional] +**Returns** | Pointer to [**[]LoadEntitlementTaskReturnsInner**](load-entitlement-task-returns-inner) | Return values from the task | [optional] + +## Methods + +### NewLoadEntitlementTask + +`func NewLoadEntitlementTask() *LoadEntitlementTask` + +NewLoadEntitlementTask instantiates a new LoadEntitlementTask 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 + +### NewLoadEntitlementTaskWithDefaults + +`func NewLoadEntitlementTaskWithDefaults() *LoadEntitlementTask` + +NewLoadEntitlementTaskWithDefaults instantiates a new LoadEntitlementTask 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 + +### GetId + +`func (o *LoadEntitlementTask) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LoadEntitlementTask) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LoadEntitlementTask) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LoadEntitlementTask) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *LoadEntitlementTask) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LoadEntitlementTask) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LoadEntitlementTask) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LoadEntitlementTask) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetUniqueName + +`func (o *LoadEntitlementTask) GetUniqueName() string` + +GetUniqueName returns the UniqueName field if non-nil, zero value otherwise. + +### GetUniqueNameOk + +`func (o *LoadEntitlementTask) GetUniqueNameOk() (*string, bool)` + +GetUniqueNameOk returns a tuple with the UniqueName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUniqueName + +`func (o *LoadEntitlementTask) SetUniqueName(v string)` + +SetUniqueName sets UniqueName field to given value. + +### HasUniqueName + +`func (o *LoadEntitlementTask) HasUniqueName() bool` + +HasUniqueName returns a boolean if a field has been set. + +### GetDescription + +`func (o *LoadEntitlementTask) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *LoadEntitlementTask) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *LoadEntitlementTask) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *LoadEntitlementTask) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetLauncher + +`func (o *LoadEntitlementTask) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *LoadEntitlementTask) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *LoadEntitlementTask) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + +### HasLauncher + +`func (o *LoadEntitlementTask) HasLauncher() bool` + +HasLauncher returns a boolean if a field has been set. + +### GetCreated + +`func (o *LoadEntitlementTask) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LoadEntitlementTask) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *LoadEntitlementTask) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *LoadEntitlementTask) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetReturns + +`func (o *LoadEntitlementTask) GetReturns() []LoadEntitlementTaskReturnsInner` + +GetReturns returns the Returns field if non-nil, zero value otherwise. + +### GetReturnsOk + +`func (o *LoadEntitlementTask) GetReturnsOk() (*[]LoadEntitlementTaskReturnsInner, bool)` + +GetReturnsOk returns a tuple with the Returns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReturns + +`func (o *LoadEntitlementTask) SetReturns(v []LoadEntitlementTaskReturnsInner)` + +SetReturns sets Returns field to given value. + +### HasReturns + +`func (o *LoadEntitlementTask) HasReturns() bool` + +HasReturns returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LoadEntitlementTaskReturnsInner.md b/docs/tools/sdk/go/Reference/Beta/Models/LoadEntitlementTaskReturnsInner.md new file mode 100644 index 000000000..8829e5c56 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LoadEntitlementTaskReturnsInner.md @@ -0,0 +1,90 @@ +--- +id: beta-load-entitlement-task-returns-inner +title: LoadEntitlementTaskReturnsInner +pagination_label: LoadEntitlementTaskReturnsInner +sidebar_label: LoadEntitlementTaskReturnsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadEntitlementTaskReturnsInner', 'BetaLoadEntitlementTaskReturnsInner'] +slug: /tools/sdk/go/beta/models/load-entitlement-task-returns-inner +tags: ['SDK', 'Software Development Kit', 'LoadEntitlementTaskReturnsInner', 'BetaLoadEntitlementTaskReturnsInner'] +--- + +# LoadEntitlementTaskReturnsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayLabel** | Pointer to **string** | The display label for the return value | [optional] +**AttributeName** | Pointer to **string** | The attribute name for the return value | [optional] + +## Methods + +### NewLoadEntitlementTaskReturnsInner + +`func NewLoadEntitlementTaskReturnsInner() *LoadEntitlementTaskReturnsInner` + +NewLoadEntitlementTaskReturnsInner instantiates a new LoadEntitlementTaskReturnsInner 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 + +### NewLoadEntitlementTaskReturnsInnerWithDefaults + +`func NewLoadEntitlementTaskReturnsInnerWithDefaults() *LoadEntitlementTaskReturnsInner` + +NewLoadEntitlementTaskReturnsInnerWithDefaults instantiates a new LoadEntitlementTaskReturnsInner 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 + +### GetDisplayLabel + +`func (o *LoadEntitlementTaskReturnsInner) GetDisplayLabel() string` + +GetDisplayLabel returns the DisplayLabel field if non-nil, zero value otherwise. + +### GetDisplayLabelOk + +`func (o *LoadEntitlementTaskReturnsInner) GetDisplayLabelOk() (*string, bool)` + +GetDisplayLabelOk returns a tuple with the DisplayLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayLabel + +`func (o *LoadEntitlementTaskReturnsInner) SetDisplayLabel(v string)` + +SetDisplayLabel sets DisplayLabel field to given value. + +### HasDisplayLabel + +`func (o *LoadEntitlementTaskReturnsInner) HasDisplayLabel() bool` + +HasDisplayLabel returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *LoadEntitlementTaskReturnsInner) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *LoadEntitlementTaskReturnsInner) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *LoadEntitlementTaskReturnsInner) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *LoadEntitlementTaskReturnsInner) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LoadUncorrelatedAccountsTask.md b/docs/tools/sdk/go/Reference/Beta/Models/LoadUncorrelatedAccountsTask.md new file mode 100644 index 000000000..ee4fb076c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LoadUncorrelatedAccountsTask.md @@ -0,0 +1,90 @@ +--- +id: beta-load-uncorrelated-accounts-task +title: LoadUncorrelatedAccountsTask +pagination_label: LoadUncorrelatedAccountsTask +sidebar_label: LoadUncorrelatedAccountsTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadUncorrelatedAccountsTask', 'BetaLoadUncorrelatedAccountsTask'] +slug: /tools/sdk/go/beta/models/load-uncorrelated-accounts-task +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTask', 'BetaLoadUncorrelatedAccountsTask'] +--- + +# LoadUncorrelatedAccountsTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Success** | Pointer to **bool** | The status of the result | [optional] [default to true] +**Task** | Pointer to [**LoadUncorrelatedAccountsTaskTask**](load-uncorrelated-accounts-task-task) | | [optional] + +## Methods + +### NewLoadUncorrelatedAccountsTask + +`func NewLoadUncorrelatedAccountsTask() *LoadUncorrelatedAccountsTask` + +NewLoadUncorrelatedAccountsTask instantiates a new LoadUncorrelatedAccountsTask 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 + +### NewLoadUncorrelatedAccountsTaskWithDefaults + +`func NewLoadUncorrelatedAccountsTaskWithDefaults() *LoadUncorrelatedAccountsTask` + +NewLoadUncorrelatedAccountsTaskWithDefaults instantiates a new LoadUncorrelatedAccountsTask 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 + +### GetSuccess + +`func (o *LoadUncorrelatedAccountsTask) GetSuccess() bool` + +GetSuccess returns the Success field if non-nil, zero value otherwise. + +### GetSuccessOk + +`func (o *LoadUncorrelatedAccountsTask) GetSuccessOk() (*bool, bool)` + +GetSuccessOk returns a tuple with the Success field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSuccess + +`func (o *LoadUncorrelatedAccountsTask) SetSuccess(v bool)` + +SetSuccess sets Success field to given value. + +### HasSuccess + +`func (o *LoadUncorrelatedAccountsTask) HasSuccess() bool` + +HasSuccess returns a boolean if a field has been set. + +### GetTask + +`func (o *LoadUncorrelatedAccountsTask) GetTask() LoadUncorrelatedAccountsTaskTask` + +GetTask returns the Task field if non-nil, zero value otherwise. + +### GetTaskOk + +`func (o *LoadUncorrelatedAccountsTask) GetTaskOk() (*LoadUncorrelatedAccountsTaskTask, bool)` + +GetTaskOk returns a tuple with the Task field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTask + +`func (o *LoadUncorrelatedAccountsTask) SetTask(v LoadUncorrelatedAccountsTaskTask)` + +SetTask sets Task field to given value. + +### HasTask + +`func (o *LoadUncorrelatedAccountsTask) HasTask() bool` + +HasTask returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTask.md b/docs/tools/sdk/go/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTask.md new file mode 100644 index 000000000..8b6b6337c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTask.md @@ -0,0 +1,452 @@ +--- +id: beta-load-uncorrelated-accounts-task-task +title: LoadUncorrelatedAccountsTaskTask +pagination_label: LoadUncorrelatedAccountsTaskTask +sidebar_label: LoadUncorrelatedAccountsTaskTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadUncorrelatedAccountsTaskTask', 'BetaLoadUncorrelatedAccountsTaskTask'] +slug: /tools/sdk/go/beta/models/load-uncorrelated-accounts-task-task +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTask', 'BetaLoadUncorrelatedAccountsTaskTask'] +--- + +# LoadUncorrelatedAccountsTaskTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the task this taskStatus represents | [optional] +**Type** | Pointer to **string** | Type of task this task represents | [optional] +**Name** | Pointer to **string** | The name of uncorrelated accounts process | [optional] +**Description** | Pointer to **string** | The description of the task | [optional] +**Launcher** | Pointer to **string** | The user who initiated the task | [optional] +**Created** | Pointer to **SailPointTime** | The Task creation date | [optional] +**Launched** | Pointer to **NullableTime** | The task start date | [optional] +**Completed** | Pointer to **NullableTime** | The task completion date | [optional] +**CompletionStatus** | Pointer to **NullableString** | Task completion status. | [optional] +**ParentName** | Pointer to **NullableString** | Name of the parent task if exists. | [optional] +**Messages** | Pointer to [**[]LoadUncorrelatedAccountsTaskTaskMessagesInner**](load-uncorrelated-accounts-task-task-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**Progress** | Pointer to **NullableString** | Current task state. | [optional] +**Attributes** | Pointer to [**LoadUncorrelatedAccountsTaskTaskAttributes**](load-uncorrelated-accounts-task-task-attributes) | | [optional] +**Returns** | Pointer to **map[string]interface{}** | Return values from the task | [optional] + +## Methods + +### NewLoadUncorrelatedAccountsTaskTask + +`func NewLoadUncorrelatedAccountsTaskTask() *LoadUncorrelatedAccountsTaskTask` + +NewLoadUncorrelatedAccountsTaskTask instantiates a new LoadUncorrelatedAccountsTaskTask 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 + +### NewLoadUncorrelatedAccountsTaskTaskWithDefaults + +`func NewLoadUncorrelatedAccountsTaskTaskWithDefaults() *LoadUncorrelatedAccountsTaskTask` + +NewLoadUncorrelatedAccountsTaskTaskWithDefaults instantiates a new LoadUncorrelatedAccountsTaskTask 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 + +### GetId + +`func (o *LoadUncorrelatedAccountsTaskTask) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LoadUncorrelatedAccountsTaskTask) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LoadUncorrelatedAccountsTaskTask) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *LoadUncorrelatedAccountsTaskTask) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LoadUncorrelatedAccountsTaskTask) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LoadUncorrelatedAccountsTaskTask) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *LoadUncorrelatedAccountsTaskTask) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *LoadUncorrelatedAccountsTaskTask) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *LoadUncorrelatedAccountsTaskTask) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *LoadUncorrelatedAccountsTaskTask) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *LoadUncorrelatedAccountsTaskTask) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *LoadUncorrelatedAccountsTaskTask) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetLauncher + +`func (o *LoadUncorrelatedAccountsTaskTask) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *LoadUncorrelatedAccountsTaskTask) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + +### HasLauncher + +`func (o *LoadUncorrelatedAccountsTaskTask) HasLauncher() bool` + +HasLauncher returns a boolean if a field has been set. + +### GetCreated + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *LoadUncorrelatedAccountsTaskTask) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *LoadUncorrelatedAccountsTaskTask) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetLaunched + +`func (o *LoadUncorrelatedAccountsTaskTask) GetLaunched() SailPointTime` + +GetLaunched returns the Launched field if non-nil, zero value otherwise. + +### GetLaunchedOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetLaunchedOk() (*SailPointTime, bool)` + +GetLaunchedOk returns a tuple with the Launched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunched + +`func (o *LoadUncorrelatedAccountsTaskTask) SetLaunched(v SailPointTime)` + +SetLaunched sets Launched field to given value. + +### HasLaunched + +`func (o *LoadUncorrelatedAccountsTaskTask) HasLaunched() bool` + +HasLaunched returns a boolean if a field has been set. + +### SetLaunchedNil + +`func (o *LoadUncorrelatedAccountsTaskTask) SetLaunchedNil(b bool)` + + SetLaunchedNil sets the value for Launched to be an explicit nil + +### UnsetLaunched +`func (o *LoadUncorrelatedAccountsTaskTask) UnsetLaunched()` + +UnsetLaunched ensures that no value is present for Launched, not even an explicit nil +### GetCompleted + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *LoadUncorrelatedAccountsTaskTask) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *LoadUncorrelatedAccountsTaskTask) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *LoadUncorrelatedAccountsTaskTask) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *LoadUncorrelatedAccountsTaskTask) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetCompletionStatus + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *LoadUncorrelatedAccountsTaskTask) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *LoadUncorrelatedAccountsTaskTask) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + +### SetCompletionStatusNil + +`func (o *LoadUncorrelatedAccountsTaskTask) SetCompletionStatusNil(b bool)` + + SetCompletionStatusNil sets the value for CompletionStatus to be an explicit nil + +### UnsetCompletionStatus +`func (o *LoadUncorrelatedAccountsTaskTask) UnsetCompletionStatus()` + +UnsetCompletionStatus ensures that no value is present for CompletionStatus, not even an explicit nil +### GetParentName + +`func (o *LoadUncorrelatedAccountsTaskTask) GetParentName() string` + +GetParentName returns the ParentName field if non-nil, zero value otherwise. + +### GetParentNameOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetParentNameOk() (*string, bool)` + +GetParentNameOk returns a tuple with the ParentName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentName + +`func (o *LoadUncorrelatedAccountsTaskTask) SetParentName(v string)` + +SetParentName sets ParentName field to given value. + +### HasParentName + +`func (o *LoadUncorrelatedAccountsTaskTask) HasParentName() bool` + +HasParentName returns a boolean if a field has been set. + +### SetParentNameNil + +`func (o *LoadUncorrelatedAccountsTaskTask) SetParentNameNil(b bool)` + + SetParentNameNil sets the value for ParentName to be an explicit nil + +### UnsetParentName +`func (o *LoadUncorrelatedAccountsTaskTask) UnsetParentName()` + +UnsetParentName ensures that no value is present for ParentName, not even an explicit nil +### GetMessages + +`func (o *LoadUncorrelatedAccountsTaskTask) GetMessages() []LoadUncorrelatedAccountsTaskTaskMessagesInner` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetMessagesOk() (*[]LoadUncorrelatedAccountsTaskTaskMessagesInner, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *LoadUncorrelatedAccountsTaskTask) SetMessages(v []LoadUncorrelatedAccountsTaskTaskMessagesInner)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *LoadUncorrelatedAccountsTaskTask) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetProgress + +`func (o *LoadUncorrelatedAccountsTaskTask) GetProgress() string` + +GetProgress returns the Progress field if non-nil, zero value otherwise. + +### GetProgressOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetProgressOk() (*string, bool)` + +GetProgressOk returns a tuple with the Progress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProgress + +`func (o *LoadUncorrelatedAccountsTaskTask) SetProgress(v string)` + +SetProgress sets Progress field to given value. + +### HasProgress + +`func (o *LoadUncorrelatedAccountsTaskTask) HasProgress() bool` + +HasProgress returns a boolean if a field has been set. + +### SetProgressNil + +`func (o *LoadUncorrelatedAccountsTaskTask) SetProgressNil(b bool)` + + SetProgressNil sets the value for Progress to be an explicit nil + +### UnsetProgress +`func (o *LoadUncorrelatedAccountsTaskTask) UnsetProgress()` + +UnsetProgress ensures that no value is present for Progress, not even an explicit nil +### GetAttributes + +`func (o *LoadUncorrelatedAccountsTaskTask) GetAttributes() LoadUncorrelatedAccountsTaskTaskAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetAttributesOk() (*LoadUncorrelatedAccountsTaskTaskAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *LoadUncorrelatedAccountsTaskTask) SetAttributes(v LoadUncorrelatedAccountsTaskTaskAttributes)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *LoadUncorrelatedAccountsTaskTask) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetReturns + +`func (o *LoadUncorrelatedAccountsTaskTask) GetReturns() map[string]interface{}` + +GetReturns returns the Returns field if non-nil, zero value otherwise. + +### GetReturnsOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetReturnsOk() (*map[string]interface{}, bool)` + +GetReturnsOk returns a tuple with the Returns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReturns + +`func (o *LoadUncorrelatedAccountsTaskTask) SetReturns(v map[string]interface{})` + +SetReturns sets Returns field to given value. + +### HasReturns + +`func (o *LoadUncorrelatedAccountsTaskTask) HasReturns() bool` + +HasReturns returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md b/docs/tools/sdk/go/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md new file mode 100644 index 000000000..52271cc8a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md @@ -0,0 +1,90 @@ +--- +id: beta-load-uncorrelated-accounts-task-task-attributes +title: LoadUncorrelatedAccountsTaskTaskAttributes +pagination_label: LoadUncorrelatedAccountsTaskTaskAttributes +sidebar_label: LoadUncorrelatedAccountsTaskTaskAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadUncorrelatedAccountsTaskTaskAttributes', 'BetaLoadUncorrelatedAccountsTaskTaskAttributes'] +slug: /tools/sdk/go/beta/models/load-uncorrelated-accounts-task-task-attributes +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTaskAttributes', 'BetaLoadUncorrelatedAccountsTaskTaskAttributes'] +--- + +# LoadUncorrelatedAccountsTaskTaskAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**QpocJobId** | Pointer to **string** | The id of qpoc job | [optional] +**TaskStartDelay** | Pointer to **map[string]interface{}** | the task start delay value | [optional] + +## Methods + +### NewLoadUncorrelatedAccountsTaskTaskAttributes + +`func NewLoadUncorrelatedAccountsTaskTaskAttributes() *LoadUncorrelatedAccountsTaskTaskAttributes` + +NewLoadUncorrelatedAccountsTaskTaskAttributes instantiates a new LoadUncorrelatedAccountsTaskTaskAttributes 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 + +### NewLoadUncorrelatedAccountsTaskTaskAttributesWithDefaults + +`func NewLoadUncorrelatedAccountsTaskTaskAttributesWithDefaults() *LoadUncorrelatedAccountsTaskTaskAttributes` + +NewLoadUncorrelatedAccountsTaskTaskAttributesWithDefaults instantiates a new LoadUncorrelatedAccountsTaskTaskAttributes 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 + +### GetQpocJobId + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) GetQpocJobId() string` + +GetQpocJobId returns the QpocJobId field if non-nil, zero value otherwise. + +### GetQpocJobIdOk + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) GetQpocJobIdOk() (*string, bool)` + +GetQpocJobIdOk returns a tuple with the QpocJobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQpocJobId + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) SetQpocJobId(v string)` + +SetQpocJobId sets QpocJobId field to given value. + +### HasQpocJobId + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) HasQpocJobId() bool` + +HasQpocJobId returns a boolean if a field has been set. + +### GetTaskStartDelay + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) GetTaskStartDelay() map[string]interface{}` + +GetTaskStartDelay returns the TaskStartDelay field if non-nil, zero value otherwise. + +### GetTaskStartDelayOk + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) GetTaskStartDelayOk() (*map[string]interface{}, bool)` + +GetTaskStartDelayOk returns a tuple with the TaskStartDelay field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskStartDelay + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) SetTaskStartDelay(v map[string]interface{})` + +SetTaskStartDelay sets TaskStartDelay field to given value. + +### HasTaskStartDelay + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) HasTaskStartDelay() bool` + +HasTaskStartDelay returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md b/docs/tools/sdk/go/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md new file mode 100644 index 000000000..032b0d81f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md @@ -0,0 +1,168 @@ +--- +id: beta-load-uncorrelated-accounts-task-task-messages-inner +title: LoadUncorrelatedAccountsTaskTaskMessagesInner +pagination_label: LoadUncorrelatedAccountsTaskTaskMessagesInner +sidebar_label: LoadUncorrelatedAccountsTaskTaskMessagesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadUncorrelatedAccountsTaskTaskMessagesInner', 'BetaLoadUncorrelatedAccountsTaskTaskMessagesInner'] +slug: /tools/sdk/go/beta/models/load-uncorrelated-accounts-task-task-messages-inner +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTaskMessagesInner', 'BetaLoadUncorrelatedAccountsTaskTaskMessagesInner'] +--- + +# LoadUncorrelatedAccountsTaskTaskMessagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the message. | [optional] +**Error** | Pointer to **bool** | Flag whether message is an error. | [optional] [default to false] +**Warning** | Pointer to **bool** | Flag whether message is a warning. | [optional] [default to false] +**Key** | Pointer to **string** | Message string identifier. | [optional] +**LocalizedText** | Pointer to **string** | Message context with the locale based language. | [optional] + +## Methods + +### NewLoadUncorrelatedAccountsTaskTaskMessagesInner + +`func NewLoadUncorrelatedAccountsTaskTaskMessagesInner() *LoadUncorrelatedAccountsTaskTaskMessagesInner` + +NewLoadUncorrelatedAccountsTaskTaskMessagesInner instantiates a new LoadUncorrelatedAccountsTaskTaskMessagesInner 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 + +### NewLoadUncorrelatedAccountsTaskTaskMessagesInnerWithDefaults + +`func NewLoadUncorrelatedAccountsTaskTaskMessagesInnerWithDefaults() *LoadUncorrelatedAccountsTaskTaskMessagesInner` + +NewLoadUncorrelatedAccountsTaskTaskMessagesInnerWithDefaults instantiates a new LoadUncorrelatedAccountsTaskTaskMessagesInner 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 + +### GetType + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetError + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetError() bool` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetErrorOk() (*bool, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) SetError(v bool)` + +SetError sets Error field to given value. + +### HasError + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) HasError() bool` + +HasError returns a boolean if a field has been set. + +### GetWarning + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetWarning() bool` + +GetWarning returns the Warning field if non-nil, zero value otherwise. + +### GetWarningOk + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetWarningOk() (*bool, bool)` + +GetWarningOk returns a tuple with the Warning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarning + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) SetWarning(v bool)` + +SetWarning sets Warning field to given value. + +### HasWarning + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) HasWarning() bool` + +HasWarning returns a boolean if a field has been set. + +### GetKey + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetLocalizedText + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetLocalizedText() string` + +GetLocalizedText returns the LocalizedText field if non-nil, zero value otherwise. + +### GetLocalizedTextOk + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetLocalizedTextOk() (*string, bool)` + +GetLocalizedTextOk returns a tuple with the LocalizedText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizedText + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) SetLocalizedText(v string)` + +SetLocalizedText sets LocalizedText field to given value. + +### HasLocalizedText + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) HasLocalizedText() bool` + +HasLocalizedText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LocaleOrigin.md b/docs/tools/sdk/go/Reference/Beta/Models/LocaleOrigin.md new file mode 100644 index 000000000..319f9f919 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LocaleOrigin.md @@ -0,0 +1,21 @@ +--- +id: beta-locale-origin +title: LocaleOrigin +pagination_label: LocaleOrigin +sidebar_label: LocaleOrigin +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LocaleOrigin', 'BetaLocaleOrigin'] +slug: /tools/sdk/go/beta/models/locale-origin +tags: ['SDK', 'Software Development Kit', 'LocaleOrigin', 'BetaLocaleOrigin'] +--- + +# LocaleOrigin + +## Enum + + +* `DEFAULT` (value: `"DEFAULT"`) + +* `REQUEST` (value: `"REQUEST"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LocalizedMessage.md b/docs/tools/sdk/go/Reference/Beta/Models/LocalizedMessage.md new file mode 100644 index 000000000..24754cf0d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LocalizedMessage.md @@ -0,0 +1,80 @@ +--- +id: beta-localized-message +title: LocalizedMessage +pagination_label: LocalizedMessage +sidebar_label: LocalizedMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LocalizedMessage', 'BetaLocalizedMessage'] +slug: /tools/sdk/go/beta/models/localized-message +tags: ['SDK', 'Software Development Kit', 'LocalizedMessage', 'BetaLocalizedMessage'] +--- + +# LocalizedMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | **string** | Message locale | +**Message** | **string** | Message text | + +## Methods + +### NewLocalizedMessage + +`func NewLocalizedMessage(locale string, message string, ) *LocalizedMessage` + +NewLocalizedMessage instantiates a new LocalizedMessage 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 + +### NewLocalizedMessageWithDefaults + +`func NewLocalizedMessageWithDefaults() *LocalizedMessage` + +NewLocalizedMessageWithDefaults instantiates a new LocalizedMessage 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 + +### GetLocale + +`func (o *LocalizedMessage) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *LocalizedMessage) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *LocalizedMessage) SetLocale(v string)` + +SetLocale sets Locale field to given value. + + +### GetMessage + +`func (o *LocalizedMessage) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *LocalizedMessage) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *LocalizedMessage) SetMessage(v string)` + +SetMessage sets Message field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/LookupStep.md b/docs/tools/sdk/go/Reference/Beta/Models/LookupStep.md new file mode 100644 index 000000000..4259b873e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/LookupStep.md @@ -0,0 +1,116 @@ +--- +id: beta-lookup-step +title: LookupStep +pagination_label: LookupStep +sidebar_label: LookupStep +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LookupStep', 'BetaLookupStep'] +slug: /tools/sdk/go/beta/models/lookup-step +tags: ['SDK', 'Software Development Kit', 'LookupStep', 'BetaLookupStep'] +--- + +# LookupStep + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReassignedToId** | Pointer to **string** | The ID of the Identity who work is reassigned to | [optional] +**ReassignedFromId** | Pointer to **string** | The ID of the Identity who work is reassigned from | [optional] +**ReassignmentType** | Pointer to [**ReassignmentTypeEnum**](reassignment-type-enum) | | [optional] + +## Methods + +### NewLookupStep + +`func NewLookupStep() *LookupStep` + +NewLookupStep instantiates a new LookupStep 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 + +### NewLookupStepWithDefaults + +`func NewLookupStepWithDefaults() *LookupStep` + +NewLookupStepWithDefaults instantiates a new LookupStep 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 + +### GetReassignedToId + +`func (o *LookupStep) GetReassignedToId() string` + +GetReassignedToId returns the ReassignedToId field if non-nil, zero value otherwise. + +### GetReassignedToIdOk + +`func (o *LookupStep) GetReassignedToIdOk() (*string, bool)` + +GetReassignedToIdOk returns a tuple with the ReassignedToId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignedToId + +`func (o *LookupStep) SetReassignedToId(v string)` + +SetReassignedToId sets ReassignedToId field to given value. + +### HasReassignedToId + +`func (o *LookupStep) HasReassignedToId() bool` + +HasReassignedToId returns a boolean if a field has been set. + +### GetReassignedFromId + +`func (o *LookupStep) GetReassignedFromId() string` + +GetReassignedFromId returns the ReassignedFromId field if non-nil, zero value otherwise. + +### GetReassignedFromIdOk + +`func (o *LookupStep) GetReassignedFromIdOk() (*string, bool)` + +GetReassignedFromIdOk returns a tuple with the ReassignedFromId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignedFromId + +`func (o *LookupStep) SetReassignedFromId(v string)` + +SetReassignedFromId sets ReassignedFromId field to given value. + +### HasReassignedFromId + +`func (o *LookupStep) HasReassignedFromId() bool` + +HasReassignedFromId returns a boolean if a field has been set. + +### GetReassignmentType + +`func (o *LookupStep) GetReassignmentType() ReassignmentTypeEnum` + +GetReassignmentType returns the ReassignmentType field if non-nil, zero value otherwise. + +### GetReassignmentTypeOk + +`func (o *LookupStep) GetReassignmentTypeOk() (*ReassignmentTypeEnum, bool)` + +GetReassignmentTypeOk returns a tuple with the ReassignmentType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignmentType + +`func (o *LookupStep) SetReassignmentType(v ReassignmentTypeEnum)` + +SetReassignmentType sets ReassignmentType field to given value. + +### HasReassignmentType + +`func (o *LookupStep) HasReassignmentType() bool` + +HasReassignmentType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MailFromAttributes.md b/docs/tools/sdk/go/Reference/Beta/Models/MailFromAttributes.md new file mode 100644 index 000000000..8b83723b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MailFromAttributes.md @@ -0,0 +1,168 @@ +--- +id: beta-mail-from-attributes +title: MailFromAttributes +pagination_label: MailFromAttributes +sidebar_label: MailFromAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MailFromAttributes', 'BetaMailFromAttributes'] +slug: /tools/sdk/go/beta/models/mail-from-attributes +tags: ['SDK', 'Software Development Kit', 'MailFromAttributes', 'BetaMailFromAttributes'] +--- + +# MailFromAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to **string** | The email identity | [optional] +**MailFromDomain** | Pointer to **string** | The name of a domain that an email identity uses as a custom MAIL FROM domain | [optional] +**MxRecord** | Pointer to **string** | MX record that is required in customer's DNS to allow the domain to receive bounce and complaint notifications that email providers send you | [optional] +**TxtRecord** | Pointer to **string** | TXT record that is required in customer's DNS in order to prove that Amazon SES is authorized to send email from your domain | [optional] +**MailFromDomainStatus** | Pointer to **string** | The current status of the MAIL FROM verification | [optional] + +## Methods + +### NewMailFromAttributes + +`func NewMailFromAttributes() *MailFromAttributes` + +NewMailFromAttributes instantiates a new MailFromAttributes 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 + +### NewMailFromAttributesWithDefaults + +`func NewMailFromAttributesWithDefaults() *MailFromAttributes` + +NewMailFromAttributesWithDefaults instantiates a new MailFromAttributes 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 + +### GetIdentity + +`func (o *MailFromAttributes) GetIdentity() string` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *MailFromAttributes) GetIdentityOk() (*string, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *MailFromAttributes) SetIdentity(v string)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *MailFromAttributes) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetMailFromDomain + +`func (o *MailFromAttributes) GetMailFromDomain() string` + +GetMailFromDomain returns the MailFromDomain field if non-nil, zero value otherwise. + +### GetMailFromDomainOk + +`func (o *MailFromAttributes) GetMailFromDomainOk() (*string, bool)` + +GetMailFromDomainOk returns a tuple with the MailFromDomain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMailFromDomain + +`func (o *MailFromAttributes) SetMailFromDomain(v string)` + +SetMailFromDomain sets MailFromDomain field to given value. + +### HasMailFromDomain + +`func (o *MailFromAttributes) HasMailFromDomain() bool` + +HasMailFromDomain returns a boolean if a field has been set. + +### GetMxRecord + +`func (o *MailFromAttributes) GetMxRecord() string` + +GetMxRecord returns the MxRecord field if non-nil, zero value otherwise. + +### GetMxRecordOk + +`func (o *MailFromAttributes) GetMxRecordOk() (*string, bool)` + +GetMxRecordOk returns a tuple with the MxRecord field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMxRecord + +`func (o *MailFromAttributes) SetMxRecord(v string)` + +SetMxRecord sets MxRecord field to given value. + +### HasMxRecord + +`func (o *MailFromAttributes) HasMxRecord() bool` + +HasMxRecord returns a boolean if a field has been set. + +### GetTxtRecord + +`func (o *MailFromAttributes) GetTxtRecord() string` + +GetTxtRecord returns the TxtRecord field if non-nil, zero value otherwise. + +### GetTxtRecordOk + +`func (o *MailFromAttributes) GetTxtRecordOk() (*string, bool)` + +GetTxtRecordOk returns a tuple with the TxtRecord field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTxtRecord + +`func (o *MailFromAttributes) SetTxtRecord(v string)` + +SetTxtRecord sets TxtRecord field to given value. + +### HasTxtRecord + +`func (o *MailFromAttributes) HasTxtRecord() bool` + +HasTxtRecord returns a boolean if a field has been set. + +### GetMailFromDomainStatus + +`func (o *MailFromAttributes) GetMailFromDomainStatus() string` + +GetMailFromDomainStatus returns the MailFromDomainStatus field if non-nil, zero value otherwise. + +### GetMailFromDomainStatusOk + +`func (o *MailFromAttributes) GetMailFromDomainStatusOk() (*string, bool)` + +GetMailFromDomainStatusOk returns a tuple with the MailFromDomainStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMailFromDomainStatus + +`func (o *MailFromAttributes) SetMailFromDomainStatus(v string)` + +SetMailFromDomainStatus sets MailFromDomainStatus field to given value. + +### HasMailFromDomainStatus + +`func (o *MailFromAttributes) HasMailFromDomainStatus() bool` + +HasMailFromDomainStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MailFromAttributesDto.md b/docs/tools/sdk/go/Reference/Beta/Models/MailFromAttributesDto.md new file mode 100644 index 000000000..80fc8f2ce --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MailFromAttributesDto.md @@ -0,0 +1,90 @@ +--- +id: beta-mail-from-attributes-dto +title: MailFromAttributesDto +pagination_label: MailFromAttributesDto +sidebar_label: MailFromAttributesDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MailFromAttributesDto', 'BetaMailFromAttributesDto'] +slug: /tools/sdk/go/beta/models/mail-from-attributes-dto +tags: ['SDK', 'Software Development Kit', 'MailFromAttributesDto', 'BetaMailFromAttributesDto'] +--- + +# MailFromAttributesDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to **string** | The identity or domain address | [optional] +**MailFromDomain** | Pointer to **string** | The new MAIL FROM domain of the identity. Must be a subdomain of the identity. | [optional] + +## Methods + +### NewMailFromAttributesDto + +`func NewMailFromAttributesDto() *MailFromAttributesDto` + +NewMailFromAttributesDto instantiates a new MailFromAttributesDto 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 + +### NewMailFromAttributesDtoWithDefaults + +`func NewMailFromAttributesDtoWithDefaults() *MailFromAttributesDto` + +NewMailFromAttributesDtoWithDefaults instantiates a new MailFromAttributesDto 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 + +### GetIdentity + +`func (o *MailFromAttributesDto) GetIdentity() string` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *MailFromAttributesDto) GetIdentityOk() (*string, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *MailFromAttributesDto) SetIdentity(v string)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *MailFromAttributesDto) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetMailFromDomain + +`func (o *MailFromAttributesDto) GetMailFromDomain() string` + +GetMailFromDomain returns the MailFromDomain field if non-nil, zero value otherwise. + +### GetMailFromDomainOk + +`func (o *MailFromAttributesDto) GetMailFromDomainOk() (*string, bool)` + +GetMailFromDomainOk returns a tuple with the MailFromDomain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMailFromDomain + +`func (o *MailFromAttributesDto) SetMailFromDomain(v string)` + +SetMailFromDomain sets MailFromDomain field to given value. + +### HasMailFromDomain + +`func (o *MailFromAttributesDto) HasMailFromDomain() bool` + +HasMailFromDomain returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManagedClient.md b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClient.md new file mode 100644 index 000000000..2cf138924 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClient.md @@ -0,0 +1,460 @@ +--- +id: beta-managed-client +title: ManagedClient +pagination_label: ManagedClient +sidebar_label: ManagedClient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClient', 'BetaManagedClient'] +slug: /tools/sdk/go/beta/models/managed-client +tags: ['SDK', 'Software Development Kit', 'ManagedClient', 'BetaManagedClient'] +--- + +# ManagedClient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ManagedClient ID | [optional] [readonly] +**AlertKey** | Pointer to **string** | ManagedClient alert key | [optional] [readonly] +**ApiGatewayBaseUrl** | Pointer to **string** | ManagedClient gateway base url | [optional] [readonly] +**CcId** | Pointer to **int64** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] +**ClientId** | **string** | The client ID used in API management | +**ClusterId** | **string** | Cluster ID that the ManagedClient is linked to | +**Cookbook** | Pointer to **string** | VA cookbook | [optional] [readonly] +**Description** | **string** | ManagedClient description | +**IpAddress** | Pointer to **string** | The public IP address of the ManagedClient | [optional] [readonly] +**LastSeen** | Pointer to **SailPointTime** | When the ManagedClient was last seen by the server | [optional] [readonly] +**Name** | Pointer to **string** | ManagedClient name | [optional] +**SinceLastSeen** | Pointer to **string** | Milliseconds since the ManagedClient has polled the server | [optional] [readonly] +**Status** | Pointer to [**ManagedClientStatusEnum**](managed-client-status-enum) | Status of the ManagedClient | [optional] [readonly] +**Type** | **string** | Type of the ManagedClient (VA, CCG) | +**VaDownloadUrl** | Pointer to **string** | ManagedClient VA download URL | [optional] [readonly] +**VaVersion** | Pointer to **string** | Version that the ManagedClient's VA is running | [optional] [readonly] +**Secret** | Pointer to **string** | Client's apiKey | [optional] + +## Methods + +### NewManagedClient + +`func NewManagedClient(clientId string, clusterId string, description string, type_ string, ) *ManagedClient` + +NewManagedClient instantiates a new ManagedClient 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 + +### NewManagedClientWithDefaults + +`func NewManagedClientWithDefaults() *ManagedClient` + +NewManagedClientWithDefaults instantiates a new ManagedClient 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 + +### GetId + +`func (o *ManagedClient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManagedClient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManagedClient) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ManagedClient) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAlertKey + +`func (o *ManagedClient) GetAlertKey() string` + +GetAlertKey returns the AlertKey field if non-nil, zero value otherwise. + +### GetAlertKeyOk + +`func (o *ManagedClient) GetAlertKeyOk() (*string, bool)` + +GetAlertKeyOk returns a tuple with the AlertKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertKey + +`func (o *ManagedClient) SetAlertKey(v string)` + +SetAlertKey sets AlertKey field to given value. + +### HasAlertKey + +`func (o *ManagedClient) HasAlertKey() bool` + +HasAlertKey returns a boolean if a field has been set. + +### GetApiGatewayBaseUrl + +`func (o *ManagedClient) GetApiGatewayBaseUrl() string` + +GetApiGatewayBaseUrl returns the ApiGatewayBaseUrl field if non-nil, zero value otherwise. + +### GetApiGatewayBaseUrlOk + +`func (o *ManagedClient) GetApiGatewayBaseUrlOk() (*string, bool)` + +GetApiGatewayBaseUrlOk returns a tuple with the ApiGatewayBaseUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiGatewayBaseUrl + +`func (o *ManagedClient) SetApiGatewayBaseUrl(v string)` + +SetApiGatewayBaseUrl sets ApiGatewayBaseUrl field to given value. + +### HasApiGatewayBaseUrl + +`func (o *ManagedClient) HasApiGatewayBaseUrl() bool` + +HasApiGatewayBaseUrl returns a boolean if a field has been set. + +### GetCcId + +`func (o *ManagedClient) GetCcId() int64` + +GetCcId returns the CcId field if non-nil, zero value otherwise. + +### GetCcIdOk + +`func (o *ManagedClient) GetCcIdOk() (*int64, bool)` + +GetCcIdOk returns a tuple with the CcId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCcId + +`func (o *ManagedClient) SetCcId(v int64)` + +SetCcId sets CcId field to given value. + +### HasCcId + +`func (o *ManagedClient) HasCcId() bool` + +HasCcId returns a boolean if a field has been set. + +### GetClientId + +`func (o *ManagedClient) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ManagedClient) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ManagedClient) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + + +### GetClusterId + +`func (o *ManagedClient) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *ManagedClient) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *ManagedClient) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + + +### GetCookbook + +`func (o *ManagedClient) GetCookbook() string` + +GetCookbook returns the Cookbook field if non-nil, zero value otherwise. + +### GetCookbookOk + +`func (o *ManagedClient) GetCookbookOk() (*string, bool)` + +GetCookbookOk returns a tuple with the Cookbook field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCookbook + +`func (o *ManagedClient) SetCookbook(v string)` + +SetCookbook sets Cookbook field to given value. + +### HasCookbook + +`func (o *ManagedClient) HasCookbook() bool` + +HasCookbook returns a boolean if a field has been set. + +### GetDescription + +`func (o *ManagedClient) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManagedClient) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManagedClient) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetIpAddress + +`func (o *ManagedClient) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *ManagedClient) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *ManagedClient) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + +### HasIpAddress + +`func (o *ManagedClient) HasIpAddress() bool` + +HasIpAddress returns a boolean if a field has been set. + +### GetLastSeen + +`func (o *ManagedClient) GetLastSeen() SailPointTime` + +GetLastSeen returns the LastSeen field if non-nil, zero value otherwise. + +### GetLastSeenOk + +`func (o *ManagedClient) GetLastSeenOk() (*SailPointTime, bool)` + +GetLastSeenOk returns a tuple with the LastSeen field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastSeen + +`func (o *ManagedClient) SetLastSeen(v SailPointTime)` + +SetLastSeen sets LastSeen field to given value. + +### HasLastSeen + +`func (o *ManagedClient) HasLastSeen() bool` + +HasLastSeen returns a boolean if a field has been set. + +### GetName + +`func (o *ManagedClient) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedClient) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedClient) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManagedClient) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSinceLastSeen + +`func (o *ManagedClient) GetSinceLastSeen() string` + +GetSinceLastSeen returns the SinceLastSeen field if non-nil, zero value otherwise. + +### GetSinceLastSeenOk + +`func (o *ManagedClient) GetSinceLastSeenOk() (*string, bool)` + +GetSinceLastSeenOk returns a tuple with the SinceLastSeen field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSinceLastSeen + +`func (o *ManagedClient) SetSinceLastSeen(v string)` + +SetSinceLastSeen sets SinceLastSeen field to given value. + +### HasSinceLastSeen + +`func (o *ManagedClient) HasSinceLastSeen() bool` + +HasSinceLastSeen returns a boolean if a field has been set. + +### GetStatus + +`func (o *ManagedClient) GetStatus() ManagedClientStatusEnum` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManagedClient) GetStatusOk() (*ManagedClientStatusEnum, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManagedClient) SetStatus(v ManagedClientStatusEnum)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ManagedClient) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetType + +`func (o *ManagedClient) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClient) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClient) SetType(v string)` + +SetType sets Type field to given value. + + +### GetVaDownloadUrl + +`func (o *ManagedClient) GetVaDownloadUrl() string` + +GetVaDownloadUrl returns the VaDownloadUrl field if non-nil, zero value otherwise. + +### GetVaDownloadUrlOk + +`func (o *ManagedClient) GetVaDownloadUrlOk() (*string, bool)` + +GetVaDownloadUrlOk returns a tuple with the VaDownloadUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVaDownloadUrl + +`func (o *ManagedClient) SetVaDownloadUrl(v string)` + +SetVaDownloadUrl sets VaDownloadUrl field to given value. + +### HasVaDownloadUrl + +`func (o *ManagedClient) HasVaDownloadUrl() bool` + +HasVaDownloadUrl returns a boolean if a field has been set. + +### GetVaVersion + +`func (o *ManagedClient) GetVaVersion() string` + +GetVaVersion returns the VaVersion field if non-nil, zero value otherwise. + +### GetVaVersionOk + +`func (o *ManagedClient) GetVaVersionOk() (*string, bool)` + +GetVaVersionOk returns a tuple with the VaVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVaVersion + +`func (o *ManagedClient) SetVaVersion(v string)` + +SetVaVersion sets VaVersion field to given value. + +### HasVaVersion + +`func (o *ManagedClient) HasVaVersion() bool` + +HasVaVersion returns a boolean if a field has been set. + +### GetSecret + +`func (o *ManagedClient) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *ManagedClient) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *ManagedClient) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *ManagedClient) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManagedClientStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClientStatus.md new file mode 100644 index 000000000..d1f78dda6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClientStatus.md @@ -0,0 +1,132 @@ +--- +id: beta-managed-client-status +title: ManagedClientStatus +pagination_label: ManagedClientStatus +sidebar_label: ManagedClientStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClientStatus', 'BetaManagedClientStatus'] +slug: /tools/sdk/go/beta/models/managed-client-status +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatus', 'BetaManagedClientStatus'] +--- + +# ManagedClientStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Body** | **map[string]interface{}** | ManagedClientStatus body information | +**Status** | [**ManagedClientStatusEnum**](managed-client-status-enum) | | +**Type** | [**NullableManagedClientType**](managed-client-type) | | +**Timestamp** | **SailPointTime** | timestamp on the Client Status update | + +## Methods + +### NewManagedClientStatus + +`func NewManagedClientStatus(body map[string]interface{}, status ManagedClientStatusEnum, type_ NullableManagedClientType, timestamp SailPointTime, ) *ManagedClientStatus` + +NewManagedClientStatus instantiates a new ManagedClientStatus 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 + +### NewManagedClientStatusWithDefaults + +`func NewManagedClientStatusWithDefaults() *ManagedClientStatus` + +NewManagedClientStatusWithDefaults instantiates a new ManagedClientStatus 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 + +### GetBody + +`func (o *ManagedClientStatus) GetBody() map[string]interface{}` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *ManagedClientStatus) GetBodyOk() (*map[string]interface{}, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBody + +`func (o *ManagedClientStatus) SetBody(v map[string]interface{})` + +SetBody sets Body field to given value. + + +### GetStatus + +`func (o *ManagedClientStatus) GetStatus() ManagedClientStatusEnum` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManagedClientStatus) GetStatusOk() (*ManagedClientStatusEnum, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManagedClientStatus) SetStatus(v ManagedClientStatusEnum)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *ManagedClientStatus) GetType() ManagedClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClientStatus) GetTypeOk() (*ManagedClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClientStatus) SetType(v ManagedClientType)` + +SetType sets Type field to given value. + + +### SetTypeNil + +`func (o *ManagedClientStatus) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *ManagedClientStatus) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetTimestamp + +`func (o *ManagedClientStatus) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *ManagedClientStatus) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *ManagedClientStatus) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManagedClientStatusAggResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClientStatusAggResponse.md new file mode 100644 index 000000000..8612e42d4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClientStatusAggResponse.md @@ -0,0 +1,132 @@ +--- +id: beta-managed-client-status-agg-response +title: ManagedClientStatusAggResponse +pagination_label: ManagedClientStatusAggResponse +sidebar_label: ManagedClientStatusAggResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClientStatusAggResponse', 'BetaManagedClientStatusAggResponse'] +slug: /tools/sdk/go/beta/models/managed-client-status-agg-response +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatusAggResponse', 'BetaManagedClientStatusAggResponse'] +--- + +# ManagedClientStatusAggResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Body** | **map[string]interface{}** | ManagedClientStatus body information | +**Status** | [**ManagedClientStatusEnum**](managed-client-status-enum) | | +**Type** | [**NullableManagedClientType**](managed-client-type) | | +**Timestamp** | **SailPointTime** | timestamp on the Client Status update | + +## Methods + +### NewManagedClientStatusAggResponse + +`func NewManagedClientStatusAggResponse(body map[string]interface{}, status ManagedClientStatusEnum, type_ NullableManagedClientType, timestamp SailPointTime, ) *ManagedClientStatusAggResponse` + +NewManagedClientStatusAggResponse instantiates a new ManagedClientStatusAggResponse 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 + +### NewManagedClientStatusAggResponseWithDefaults + +`func NewManagedClientStatusAggResponseWithDefaults() *ManagedClientStatusAggResponse` + +NewManagedClientStatusAggResponseWithDefaults instantiates a new ManagedClientStatusAggResponse 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 + +### GetBody + +`func (o *ManagedClientStatusAggResponse) GetBody() map[string]interface{}` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *ManagedClientStatusAggResponse) GetBodyOk() (*map[string]interface{}, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBody + +`func (o *ManagedClientStatusAggResponse) SetBody(v map[string]interface{})` + +SetBody sets Body field to given value. + + +### GetStatus + +`func (o *ManagedClientStatusAggResponse) GetStatus() ManagedClientStatusEnum` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManagedClientStatusAggResponse) GetStatusOk() (*ManagedClientStatusEnum, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManagedClientStatusAggResponse) SetStatus(v ManagedClientStatusEnum)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *ManagedClientStatusAggResponse) GetType() ManagedClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClientStatusAggResponse) GetTypeOk() (*ManagedClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClientStatusAggResponse) SetType(v ManagedClientType)` + +SetType sets Type field to given value. + + +### SetTypeNil + +`func (o *ManagedClientStatusAggResponse) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *ManagedClientStatusAggResponse) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetTimestamp + +`func (o *ManagedClientStatusAggResponse) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *ManagedClientStatusAggResponse) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *ManagedClientStatusAggResponse) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManagedClientStatusEnum.md b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClientStatusEnum.md new file mode 100644 index 000000000..c0283415b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClientStatusEnum.md @@ -0,0 +1,31 @@ +--- +id: beta-managed-client-status-enum +title: ManagedClientStatusEnum +pagination_label: ManagedClientStatusEnum +sidebar_label: ManagedClientStatusEnum +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClientStatusEnum', 'BetaManagedClientStatusEnum'] +slug: /tools/sdk/go/beta/models/managed-client-status-enum +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatusEnum', 'BetaManagedClientStatusEnum'] +--- + +# ManagedClientStatusEnum + +## Enum + + +* `NORMAL` (value: `"NORMAL"`) + +* `UNDEFINED` (value: `"UNDEFINED"`) + +* `NOT_CONFIGURED` (value: `"NOT_CONFIGURED"`) + +* `CONFIGURING` (value: `"CONFIGURING"`) + +* `WARNING` (value: `"WARNING"`) + +* `ERROR` (value: `"ERROR"`) + +* `FAILED` (value: `"FAILED"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManagedClientType.md b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClientType.md new file mode 100644 index 000000000..8ad2ca239 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClientType.md @@ -0,0 +1,25 @@ +--- +id: beta-managed-client-type +title: ManagedClientType +pagination_label: ManagedClientType +sidebar_label: ManagedClientType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClientType', 'BetaManagedClientType'] +slug: /tools/sdk/go/beta/models/managed-client-type +tags: ['SDK', 'Software Development Kit', 'ManagedClientType', 'BetaManagedClientType'] +--- + +# ManagedClientType + +## Enum + + +* `CCG` (value: `"CCG"`) + +* `VA` (value: `"VA"`) + +* `INTERNAL` (value: `"INTERNAL"`) + +* `IIQ_HARVESTER` (value: `"IIQ_HARVESTER"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManagedCluster.md b/docs/tools/sdk/go/Reference/Beta/Models/ManagedCluster.md new file mode 100644 index 000000000..cafcdc469 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManagedCluster.md @@ -0,0 +1,743 @@ +--- +id: beta-managed-cluster +title: ManagedCluster +pagination_label: ManagedCluster +sidebar_label: ManagedCluster +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedCluster', 'BetaManagedCluster'] +slug: /tools/sdk/go/beta/models/managed-cluster +tags: ['SDK', 'Software Development Kit', 'ManagedCluster', 'BetaManagedCluster'] +--- + +# ManagedCluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ManagedCluster ID | +**Name** | Pointer to **string** | ManagedCluster name | [optional] +**Pod** | Pointer to **string** | ManagedCluster pod | [optional] +**Org** | Pointer to **string** | ManagedCluster org | [optional] +**Type** | Pointer to [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**Configuration** | Pointer to **map[string]string** | ManagedProcess configuration map | [optional] +**KeyPair** | Pointer to [**ManagedClusterKeyPair**](managed-cluster-key-pair) | | [optional] +**Attributes** | Pointer to [**ManagedClusterAttributes**](managed-cluster-attributes) | | [optional] +**Description** | Pointer to **string** | ManagedCluster description | [optional] +**Redis** | Pointer to [**ManagedClusterRedis**](managed-cluster-redis) | | [optional] +**ClientType** | [**NullableManagedClientType**](managed-client-type) | | +**CcgVersion** | **string** | CCG version used by the ManagedCluster | +**PinnedConfig** | Pointer to **bool** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to false] +**LogConfiguration** | Pointer to [**NullableClientLogConfiguration**](client-log-configuration) | | [optional] +**Operational** | Pointer to **bool** | Whether or not the cluster is operational or not | [optional] [default to false] +**Status** | Pointer to **string** | Cluster status | [optional] +**PublicKeyCertificate** | Pointer to **NullableString** | Public key certificate | [optional] +**PublicKeyThumbprint** | Pointer to **NullableString** | Public key thumbprint | [optional] +**PublicKey** | Pointer to **NullableString** | Public key | [optional] +**AlertKey** | Pointer to **string** | Key describing any immediate cluster alerts | [optional] +**ClientIds** | Pointer to **[]string** | List of clients in a cluster | [optional] +**ServiceCount** | Pointer to **int32** | Number of services bound to a cluster | [optional] [default to 0] +**CcId** | Pointer to **string** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to "0"] +**CreatedAt** | Pointer to **NullableTime** | The date/time this cluster was created | [optional] +**UpdatedAt** | Pointer to **NullableTime** | The date/time this cluster was last updated | [optional] + +## Methods + +### NewManagedCluster + +`func NewManagedCluster(id string, clientType NullableManagedClientType, ccgVersion string, ) *ManagedCluster` + +NewManagedCluster instantiates a new ManagedCluster 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 + +### NewManagedClusterWithDefaults + +`func NewManagedClusterWithDefaults() *ManagedCluster` + +NewManagedClusterWithDefaults instantiates a new ManagedCluster 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 + +### GetId + +`func (o *ManagedCluster) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManagedCluster) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManagedCluster) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *ManagedCluster) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedCluster) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedCluster) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManagedCluster) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPod + +`func (o *ManagedCluster) GetPod() string` + +GetPod returns the Pod field if non-nil, zero value otherwise. + +### GetPodOk + +`func (o *ManagedCluster) GetPodOk() (*string, bool)` + +GetPodOk returns a tuple with the Pod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPod + +`func (o *ManagedCluster) SetPod(v string)` + +SetPod sets Pod field to given value. + +### HasPod + +`func (o *ManagedCluster) HasPod() bool` + +HasPod returns a boolean if a field has been set. + +### GetOrg + +`func (o *ManagedCluster) GetOrg() string` + +GetOrg returns the Org field if non-nil, zero value otherwise. + +### GetOrgOk + +`func (o *ManagedCluster) GetOrgOk() (*string, bool)` + +GetOrgOk returns a tuple with the Org field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrg + +`func (o *ManagedCluster) SetOrg(v string)` + +SetOrg sets Org field to given value. + +### HasOrg + +`func (o *ManagedCluster) HasOrg() bool` + +HasOrg returns a boolean if a field has been set. + +### GetType + +`func (o *ManagedCluster) GetType() ManagedClusterTypes` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedCluster) GetTypeOk() (*ManagedClusterTypes, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedCluster) SetType(v ManagedClusterTypes)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManagedCluster) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConfiguration + +`func (o *ManagedCluster) GetConfiguration() map[string]string` + +GetConfiguration returns the Configuration field if non-nil, zero value otherwise. + +### GetConfigurationOk + +`func (o *ManagedCluster) GetConfigurationOk() (*map[string]string, bool)` + +GetConfigurationOk returns a tuple with the Configuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfiguration + +`func (o *ManagedCluster) SetConfiguration(v map[string]string)` + +SetConfiguration sets Configuration field to given value. + +### HasConfiguration + +`func (o *ManagedCluster) HasConfiguration() bool` + +HasConfiguration returns a boolean if a field has been set. + +### GetKeyPair + +`func (o *ManagedCluster) GetKeyPair() ManagedClusterKeyPair` + +GetKeyPair returns the KeyPair field if non-nil, zero value otherwise. + +### GetKeyPairOk + +`func (o *ManagedCluster) GetKeyPairOk() (*ManagedClusterKeyPair, bool)` + +GetKeyPairOk returns a tuple with the KeyPair field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKeyPair + +`func (o *ManagedCluster) SetKeyPair(v ManagedClusterKeyPair)` + +SetKeyPair sets KeyPair field to given value. + +### HasKeyPair + +`func (o *ManagedCluster) HasKeyPair() bool` + +HasKeyPair returns a boolean if a field has been set. + +### GetAttributes + +`func (o *ManagedCluster) GetAttributes() ManagedClusterAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ManagedCluster) GetAttributesOk() (*ManagedClusterAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ManagedCluster) SetAttributes(v ManagedClusterAttributes)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ManagedCluster) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetDescription + +`func (o *ManagedCluster) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManagedCluster) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManagedCluster) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ManagedCluster) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetRedis + +`func (o *ManagedCluster) GetRedis() ManagedClusterRedis` + +GetRedis returns the Redis field if non-nil, zero value otherwise. + +### GetRedisOk + +`func (o *ManagedCluster) GetRedisOk() (*ManagedClusterRedis, bool)` + +GetRedisOk returns a tuple with the Redis field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedis + +`func (o *ManagedCluster) SetRedis(v ManagedClusterRedis)` + +SetRedis sets Redis field to given value. + +### HasRedis + +`func (o *ManagedCluster) HasRedis() bool` + +HasRedis returns a boolean if a field has been set. + +### GetClientType + +`func (o *ManagedCluster) GetClientType() ManagedClientType` + +GetClientType returns the ClientType field if non-nil, zero value otherwise. + +### GetClientTypeOk + +`func (o *ManagedCluster) GetClientTypeOk() (*ManagedClientType, bool)` + +GetClientTypeOk returns a tuple with the ClientType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientType + +`func (o *ManagedCluster) SetClientType(v ManagedClientType)` + +SetClientType sets ClientType field to given value. + + +### SetClientTypeNil + +`func (o *ManagedCluster) SetClientTypeNil(b bool)` + + SetClientTypeNil sets the value for ClientType to be an explicit nil + +### UnsetClientType +`func (o *ManagedCluster) UnsetClientType()` + +UnsetClientType ensures that no value is present for ClientType, not even an explicit nil +### GetCcgVersion + +`func (o *ManagedCluster) GetCcgVersion() string` + +GetCcgVersion returns the CcgVersion field if non-nil, zero value otherwise. + +### GetCcgVersionOk + +`func (o *ManagedCluster) GetCcgVersionOk() (*string, bool)` + +GetCcgVersionOk returns a tuple with the CcgVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCcgVersion + +`func (o *ManagedCluster) SetCcgVersion(v string)` + +SetCcgVersion sets CcgVersion field to given value. + + +### GetPinnedConfig + +`func (o *ManagedCluster) GetPinnedConfig() bool` + +GetPinnedConfig returns the PinnedConfig field if non-nil, zero value otherwise. + +### GetPinnedConfigOk + +`func (o *ManagedCluster) GetPinnedConfigOk() (*bool, bool)` + +GetPinnedConfigOk returns a tuple with the PinnedConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPinnedConfig + +`func (o *ManagedCluster) SetPinnedConfig(v bool)` + +SetPinnedConfig sets PinnedConfig field to given value. + +### HasPinnedConfig + +`func (o *ManagedCluster) HasPinnedConfig() bool` + +HasPinnedConfig returns a boolean if a field has been set. + +### GetLogConfiguration + +`func (o *ManagedCluster) GetLogConfiguration() ClientLogConfiguration` + +GetLogConfiguration returns the LogConfiguration field if non-nil, zero value otherwise. + +### GetLogConfigurationOk + +`func (o *ManagedCluster) GetLogConfigurationOk() (*ClientLogConfiguration, bool)` + +GetLogConfigurationOk returns a tuple with the LogConfiguration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogConfiguration + +`func (o *ManagedCluster) SetLogConfiguration(v ClientLogConfiguration)` + +SetLogConfiguration sets LogConfiguration field to given value. + +### HasLogConfiguration + +`func (o *ManagedCluster) HasLogConfiguration() bool` + +HasLogConfiguration returns a boolean if a field has been set. + +### SetLogConfigurationNil + +`func (o *ManagedCluster) SetLogConfigurationNil(b bool)` + + SetLogConfigurationNil sets the value for LogConfiguration to be an explicit nil + +### UnsetLogConfiguration +`func (o *ManagedCluster) UnsetLogConfiguration()` + +UnsetLogConfiguration ensures that no value is present for LogConfiguration, not even an explicit nil +### GetOperational + +`func (o *ManagedCluster) GetOperational() bool` + +GetOperational returns the Operational field if non-nil, zero value otherwise. + +### GetOperationalOk + +`func (o *ManagedCluster) GetOperationalOk() (*bool, bool)` + +GetOperationalOk returns a tuple with the Operational field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperational + +`func (o *ManagedCluster) SetOperational(v bool)` + +SetOperational sets Operational field to given value. + +### HasOperational + +`func (o *ManagedCluster) HasOperational() bool` + +HasOperational returns a boolean if a field has been set. + +### GetStatus + +`func (o *ManagedCluster) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManagedCluster) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManagedCluster) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ManagedCluster) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetPublicKeyCertificate + +`func (o *ManagedCluster) GetPublicKeyCertificate() string` + +GetPublicKeyCertificate returns the PublicKeyCertificate field if non-nil, zero value otherwise. + +### GetPublicKeyCertificateOk + +`func (o *ManagedCluster) GetPublicKeyCertificateOk() (*string, bool)` + +GetPublicKeyCertificateOk returns a tuple with the PublicKeyCertificate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyCertificate + +`func (o *ManagedCluster) SetPublicKeyCertificate(v string)` + +SetPublicKeyCertificate sets PublicKeyCertificate field to given value. + +### HasPublicKeyCertificate + +`func (o *ManagedCluster) HasPublicKeyCertificate() bool` + +HasPublicKeyCertificate returns a boolean if a field has been set. + +### SetPublicKeyCertificateNil + +`func (o *ManagedCluster) SetPublicKeyCertificateNil(b bool)` + + SetPublicKeyCertificateNil sets the value for PublicKeyCertificate to be an explicit nil + +### UnsetPublicKeyCertificate +`func (o *ManagedCluster) UnsetPublicKeyCertificate()` + +UnsetPublicKeyCertificate ensures that no value is present for PublicKeyCertificate, not even an explicit nil +### GetPublicKeyThumbprint + +`func (o *ManagedCluster) GetPublicKeyThumbprint() string` + +GetPublicKeyThumbprint returns the PublicKeyThumbprint field if non-nil, zero value otherwise. + +### GetPublicKeyThumbprintOk + +`func (o *ManagedCluster) GetPublicKeyThumbprintOk() (*string, bool)` + +GetPublicKeyThumbprintOk returns a tuple with the PublicKeyThumbprint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyThumbprint + +`func (o *ManagedCluster) SetPublicKeyThumbprint(v string)` + +SetPublicKeyThumbprint sets PublicKeyThumbprint field to given value. + +### HasPublicKeyThumbprint + +`func (o *ManagedCluster) HasPublicKeyThumbprint() bool` + +HasPublicKeyThumbprint returns a boolean if a field has been set. + +### SetPublicKeyThumbprintNil + +`func (o *ManagedCluster) SetPublicKeyThumbprintNil(b bool)` + + SetPublicKeyThumbprintNil sets the value for PublicKeyThumbprint to be an explicit nil + +### UnsetPublicKeyThumbprint +`func (o *ManagedCluster) UnsetPublicKeyThumbprint()` + +UnsetPublicKeyThumbprint ensures that no value is present for PublicKeyThumbprint, not even an explicit nil +### GetPublicKey + +`func (o *ManagedCluster) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *ManagedCluster) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *ManagedCluster) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *ManagedCluster) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### SetPublicKeyNil + +`func (o *ManagedCluster) SetPublicKeyNil(b bool)` + + SetPublicKeyNil sets the value for PublicKey to be an explicit nil + +### UnsetPublicKey +`func (o *ManagedCluster) UnsetPublicKey()` + +UnsetPublicKey ensures that no value is present for PublicKey, not even an explicit nil +### GetAlertKey + +`func (o *ManagedCluster) GetAlertKey() string` + +GetAlertKey returns the AlertKey field if non-nil, zero value otherwise. + +### GetAlertKeyOk + +`func (o *ManagedCluster) GetAlertKeyOk() (*string, bool)` + +GetAlertKeyOk returns a tuple with the AlertKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertKey + +`func (o *ManagedCluster) SetAlertKey(v string)` + +SetAlertKey sets AlertKey field to given value. + +### HasAlertKey + +`func (o *ManagedCluster) HasAlertKey() bool` + +HasAlertKey returns a boolean if a field has been set. + +### GetClientIds + +`func (o *ManagedCluster) GetClientIds() []string` + +GetClientIds returns the ClientIds field if non-nil, zero value otherwise. + +### GetClientIdsOk + +`func (o *ManagedCluster) GetClientIdsOk() (*[]string, bool)` + +GetClientIdsOk returns a tuple with the ClientIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientIds + +`func (o *ManagedCluster) SetClientIds(v []string)` + +SetClientIds sets ClientIds field to given value. + +### HasClientIds + +`func (o *ManagedCluster) HasClientIds() bool` + +HasClientIds returns a boolean if a field has been set. + +### GetServiceCount + +`func (o *ManagedCluster) GetServiceCount() int32` + +GetServiceCount returns the ServiceCount field if non-nil, zero value otherwise. + +### GetServiceCountOk + +`func (o *ManagedCluster) GetServiceCountOk() (*int32, bool)` + +GetServiceCountOk returns a tuple with the ServiceCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceCount + +`func (o *ManagedCluster) SetServiceCount(v int32)` + +SetServiceCount sets ServiceCount field to given value. + +### HasServiceCount + +`func (o *ManagedCluster) HasServiceCount() bool` + +HasServiceCount returns a boolean if a field has been set. + +### GetCcId + +`func (o *ManagedCluster) GetCcId() string` + +GetCcId returns the CcId field if non-nil, zero value otherwise. + +### GetCcIdOk + +`func (o *ManagedCluster) GetCcIdOk() (*string, bool)` + +GetCcIdOk returns a tuple with the CcId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCcId + +`func (o *ManagedCluster) SetCcId(v string)` + +SetCcId sets CcId field to given value. + +### HasCcId + +`func (o *ManagedCluster) HasCcId() bool` + +HasCcId returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *ManagedCluster) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *ManagedCluster) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *ManagedCluster) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *ManagedCluster) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### SetCreatedAtNil + +`func (o *ManagedCluster) SetCreatedAtNil(b bool)` + + SetCreatedAtNil sets the value for CreatedAt to be an explicit nil + +### UnsetCreatedAt +`func (o *ManagedCluster) UnsetCreatedAt()` + +UnsetCreatedAt ensures that no value is present for CreatedAt, not even an explicit nil +### GetUpdatedAt + +`func (o *ManagedCluster) GetUpdatedAt() SailPointTime` + +GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise. + +### GetUpdatedAtOk + +`func (o *ManagedCluster) GetUpdatedAtOk() (*SailPointTime, bool)` + +GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedAt + +`func (o *ManagedCluster) SetUpdatedAt(v SailPointTime)` + +SetUpdatedAt sets UpdatedAt field to given value. + +### HasUpdatedAt + +`func (o *ManagedCluster) HasUpdatedAt() bool` + +HasUpdatedAt returns a boolean if a field has been set. + +### SetUpdatedAtNil + +`func (o *ManagedCluster) SetUpdatedAtNil(b bool)` + + SetUpdatedAtNil sets the value for UpdatedAt to be an explicit nil + +### UnsetUpdatedAt +`func (o *ManagedCluster) UnsetUpdatedAt()` + +UnsetUpdatedAt ensures that no value is present for UpdatedAt, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManagedClusterAttributes.md b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClusterAttributes.md new file mode 100644 index 000000000..3bd87391e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClusterAttributes.md @@ -0,0 +1,100 @@ +--- +id: beta-managed-cluster-attributes +title: ManagedClusterAttributes +pagination_label: ManagedClusterAttributes +sidebar_label: ManagedClusterAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterAttributes', 'BetaManagedClusterAttributes'] +slug: /tools/sdk/go/beta/models/managed-cluster-attributes +tags: ['SDK', 'Software Development Kit', 'ManagedClusterAttributes', 'BetaManagedClusterAttributes'] +--- + +# ManagedClusterAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Queue** | Pointer to [**ManagedClusterQueue**](managed-cluster-queue) | | [optional] +**Keystore** | Pointer to **NullableString** | ManagedCluster keystore for spConnectCluster type | [optional] + +## Methods + +### NewManagedClusterAttributes + +`func NewManagedClusterAttributes() *ManagedClusterAttributes` + +NewManagedClusterAttributes instantiates a new ManagedClusterAttributes 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 + +### NewManagedClusterAttributesWithDefaults + +`func NewManagedClusterAttributesWithDefaults() *ManagedClusterAttributes` + +NewManagedClusterAttributesWithDefaults instantiates a new ManagedClusterAttributes 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 + +### GetQueue + +`func (o *ManagedClusterAttributes) GetQueue() ManagedClusterQueue` + +GetQueue returns the Queue field if non-nil, zero value otherwise. + +### GetQueueOk + +`func (o *ManagedClusterAttributes) GetQueueOk() (*ManagedClusterQueue, bool)` + +GetQueueOk returns a tuple with the Queue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueue + +`func (o *ManagedClusterAttributes) SetQueue(v ManagedClusterQueue)` + +SetQueue sets Queue field to given value. + +### HasQueue + +`func (o *ManagedClusterAttributes) HasQueue() bool` + +HasQueue returns a boolean if a field has been set. + +### GetKeystore + +`func (o *ManagedClusterAttributes) GetKeystore() string` + +GetKeystore returns the Keystore field if non-nil, zero value otherwise. + +### GetKeystoreOk + +`func (o *ManagedClusterAttributes) GetKeystoreOk() (*string, bool)` + +GetKeystoreOk returns a tuple with the Keystore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKeystore + +`func (o *ManagedClusterAttributes) SetKeystore(v string)` + +SetKeystore sets Keystore field to given value. + +### HasKeystore + +`func (o *ManagedClusterAttributes) HasKeystore() bool` + +HasKeystore returns a boolean if a field has been set. + +### SetKeystoreNil + +`func (o *ManagedClusterAttributes) SetKeystoreNil(b bool)` + + SetKeystoreNil sets the value for Keystore to be an explicit nil + +### UnsetKeystore +`func (o *ManagedClusterAttributes) UnsetKeystore()` + +UnsetKeystore ensures that no value is present for Keystore, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManagedClusterKeyPair.md b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClusterKeyPair.md new file mode 100644 index 000000000..4b387049d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClusterKeyPair.md @@ -0,0 +1,146 @@ +--- +id: beta-managed-cluster-key-pair +title: ManagedClusterKeyPair +pagination_label: ManagedClusterKeyPair +sidebar_label: ManagedClusterKeyPair +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterKeyPair', 'BetaManagedClusterKeyPair'] +slug: /tools/sdk/go/beta/models/managed-cluster-key-pair +tags: ['SDK', 'Software Development Kit', 'ManagedClusterKeyPair', 'BetaManagedClusterKeyPair'] +--- + +# ManagedClusterKeyPair + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PublicKey** | Pointer to **NullableString** | ManagedCluster publicKey | [optional] +**PublicKeyThumbprint** | Pointer to **NullableString** | ManagedCluster publicKeyThumbprint | [optional] +**PublicKeyCertificate** | Pointer to **NullableString** | ManagedCluster publicKeyCertificate | [optional] + +## Methods + +### NewManagedClusterKeyPair + +`func NewManagedClusterKeyPair() *ManagedClusterKeyPair` + +NewManagedClusterKeyPair instantiates a new ManagedClusterKeyPair 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 + +### NewManagedClusterKeyPairWithDefaults + +`func NewManagedClusterKeyPairWithDefaults() *ManagedClusterKeyPair` + +NewManagedClusterKeyPairWithDefaults instantiates a new ManagedClusterKeyPair 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 + +### GetPublicKey + +`func (o *ManagedClusterKeyPair) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *ManagedClusterKeyPair) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *ManagedClusterKeyPair) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *ManagedClusterKeyPair) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### SetPublicKeyNil + +`func (o *ManagedClusterKeyPair) SetPublicKeyNil(b bool)` + + SetPublicKeyNil sets the value for PublicKey to be an explicit nil + +### UnsetPublicKey +`func (o *ManagedClusterKeyPair) UnsetPublicKey()` + +UnsetPublicKey ensures that no value is present for PublicKey, not even an explicit nil +### GetPublicKeyThumbprint + +`func (o *ManagedClusterKeyPair) GetPublicKeyThumbprint() string` + +GetPublicKeyThumbprint returns the PublicKeyThumbprint field if non-nil, zero value otherwise. + +### GetPublicKeyThumbprintOk + +`func (o *ManagedClusterKeyPair) GetPublicKeyThumbprintOk() (*string, bool)` + +GetPublicKeyThumbprintOk returns a tuple with the PublicKeyThumbprint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyThumbprint + +`func (o *ManagedClusterKeyPair) SetPublicKeyThumbprint(v string)` + +SetPublicKeyThumbprint sets PublicKeyThumbprint field to given value. + +### HasPublicKeyThumbprint + +`func (o *ManagedClusterKeyPair) HasPublicKeyThumbprint() bool` + +HasPublicKeyThumbprint returns a boolean if a field has been set. + +### SetPublicKeyThumbprintNil + +`func (o *ManagedClusterKeyPair) SetPublicKeyThumbprintNil(b bool)` + + SetPublicKeyThumbprintNil sets the value for PublicKeyThumbprint to be an explicit nil + +### UnsetPublicKeyThumbprint +`func (o *ManagedClusterKeyPair) UnsetPublicKeyThumbprint()` + +UnsetPublicKeyThumbprint ensures that no value is present for PublicKeyThumbprint, not even an explicit nil +### GetPublicKeyCertificate + +`func (o *ManagedClusterKeyPair) GetPublicKeyCertificate() string` + +GetPublicKeyCertificate returns the PublicKeyCertificate field if non-nil, zero value otherwise. + +### GetPublicKeyCertificateOk + +`func (o *ManagedClusterKeyPair) GetPublicKeyCertificateOk() (*string, bool)` + +GetPublicKeyCertificateOk returns a tuple with the PublicKeyCertificate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyCertificate + +`func (o *ManagedClusterKeyPair) SetPublicKeyCertificate(v string)` + +SetPublicKeyCertificate sets PublicKeyCertificate field to given value. + +### HasPublicKeyCertificate + +`func (o *ManagedClusterKeyPair) HasPublicKeyCertificate() bool` + +HasPublicKeyCertificate returns a boolean if a field has been set. + +### SetPublicKeyCertificateNil + +`func (o *ManagedClusterKeyPair) SetPublicKeyCertificateNil(b bool)` + + SetPublicKeyCertificateNil sets the value for PublicKeyCertificate to be an explicit nil + +### UnsetPublicKeyCertificate +`func (o *ManagedClusterKeyPair) UnsetPublicKeyCertificate()` + +UnsetPublicKeyCertificate ensures that no value is present for PublicKeyCertificate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManagedClusterQueue.md b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClusterQueue.md new file mode 100644 index 000000000..58725be4b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClusterQueue.md @@ -0,0 +1,90 @@ +--- +id: beta-managed-cluster-queue +title: ManagedClusterQueue +pagination_label: ManagedClusterQueue +sidebar_label: ManagedClusterQueue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterQueue', 'BetaManagedClusterQueue'] +slug: /tools/sdk/go/beta/models/managed-cluster-queue +tags: ['SDK', 'Software Development Kit', 'ManagedClusterQueue', 'BetaManagedClusterQueue'] +--- + +# ManagedClusterQueue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | ManagedCluster queue name | [optional] +**Region** | Pointer to **string** | ManagedCluster queue aws region | [optional] + +## Methods + +### NewManagedClusterQueue + +`func NewManagedClusterQueue() *ManagedClusterQueue` + +NewManagedClusterQueue instantiates a new ManagedClusterQueue 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 + +### NewManagedClusterQueueWithDefaults + +`func NewManagedClusterQueueWithDefaults() *ManagedClusterQueue` + +NewManagedClusterQueueWithDefaults instantiates a new ManagedClusterQueue 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 + +### GetName + +`func (o *ManagedClusterQueue) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedClusterQueue) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedClusterQueue) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManagedClusterQueue) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetRegion + +`func (o *ManagedClusterQueue) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *ManagedClusterQueue) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *ManagedClusterQueue) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *ManagedClusterQueue) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManagedClusterRedis.md b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClusterRedis.md new file mode 100644 index 000000000..241f3a31d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClusterRedis.md @@ -0,0 +1,90 @@ +--- +id: beta-managed-cluster-redis +title: ManagedClusterRedis +pagination_label: ManagedClusterRedis +sidebar_label: ManagedClusterRedis +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterRedis', 'BetaManagedClusterRedis'] +slug: /tools/sdk/go/beta/models/managed-cluster-redis +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRedis', 'BetaManagedClusterRedis'] +--- + +# ManagedClusterRedis + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RedisHost** | Pointer to **string** | ManagedCluster redisHost | [optional] +**RedisPort** | Pointer to **int32** | ManagedCluster redisPort | [optional] + +## Methods + +### NewManagedClusterRedis + +`func NewManagedClusterRedis() *ManagedClusterRedis` + +NewManagedClusterRedis instantiates a new ManagedClusterRedis 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 + +### NewManagedClusterRedisWithDefaults + +`func NewManagedClusterRedisWithDefaults() *ManagedClusterRedis` + +NewManagedClusterRedisWithDefaults instantiates a new ManagedClusterRedis 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 + +### GetRedisHost + +`func (o *ManagedClusterRedis) GetRedisHost() string` + +GetRedisHost returns the RedisHost field if non-nil, zero value otherwise. + +### GetRedisHostOk + +`func (o *ManagedClusterRedis) GetRedisHostOk() (*string, bool)` + +GetRedisHostOk returns a tuple with the RedisHost field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedisHost + +`func (o *ManagedClusterRedis) SetRedisHost(v string)` + +SetRedisHost sets RedisHost field to given value. + +### HasRedisHost + +`func (o *ManagedClusterRedis) HasRedisHost() bool` + +HasRedisHost returns a boolean if a field has been set. + +### GetRedisPort + +`func (o *ManagedClusterRedis) GetRedisPort() int32` + +GetRedisPort returns the RedisPort field if non-nil, zero value otherwise. + +### GetRedisPortOk + +`func (o *ManagedClusterRedis) GetRedisPortOk() (*int32, bool)` + +GetRedisPortOk returns a tuple with the RedisPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedisPort + +`func (o *ManagedClusterRedis) SetRedisPort(v int32)` + +SetRedisPort sets RedisPort field to given value. + +### HasRedisPort + +`func (o *ManagedClusterRedis) HasRedisPort() bool` + +HasRedisPort returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManagedClusterTypes.md b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClusterTypes.md new file mode 100644 index 000000000..100ed4e71 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManagedClusterTypes.md @@ -0,0 +1,21 @@ +--- +id: beta-managed-cluster-types +title: ManagedClusterTypes +pagination_label: ManagedClusterTypes +sidebar_label: ManagedClusterTypes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterTypes', 'BetaManagedClusterTypes'] +slug: /tools/sdk/go/beta/models/managed-cluster-types +tags: ['SDK', 'Software Development Kit', 'ManagedClusterTypes', 'BetaManagedClusterTypes'] +--- + +# ManagedClusterTypes + +## Enum + + +* `IDN` (value: `"idn"`) + +* `IAI` (value: `"iai"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManagerCorrelationMapping.md b/docs/tools/sdk/go/Reference/Beta/Models/ManagerCorrelationMapping.md new file mode 100644 index 000000000..cdb42fce7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManagerCorrelationMapping.md @@ -0,0 +1,90 @@ +--- +id: beta-manager-correlation-mapping +title: ManagerCorrelationMapping +pagination_label: ManagerCorrelationMapping +sidebar_label: ManagerCorrelationMapping +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagerCorrelationMapping', 'BetaManagerCorrelationMapping'] +slug: /tools/sdk/go/beta/models/manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'ManagerCorrelationMapping', 'BetaManagerCorrelationMapping'] +--- + +# ManagerCorrelationMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountAttributeName** | Pointer to **string** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**IdentityAttributeName** | Pointer to **string** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] + +## Methods + +### NewManagerCorrelationMapping + +`func NewManagerCorrelationMapping() *ManagerCorrelationMapping` + +NewManagerCorrelationMapping instantiates a new ManagerCorrelationMapping 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 + +### NewManagerCorrelationMappingWithDefaults + +`func NewManagerCorrelationMappingWithDefaults() *ManagerCorrelationMapping` + +NewManagerCorrelationMappingWithDefaults instantiates a new ManagerCorrelationMapping 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 + +### GetAccountAttributeName + +`func (o *ManagerCorrelationMapping) GetAccountAttributeName() string` + +GetAccountAttributeName returns the AccountAttributeName field if non-nil, zero value otherwise. + +### GetAccountAttributeNameOk + +`func (o *ManagerCorrelationMapping) GetAccountAttributeNameOk() (*string, bool)` + +GetAccountAttributeNameOk returns a tuple with the AccountAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountAttributeName + +`func (o *ManagerCorrelationMapping) SetAccountAttributeName(v string)` + +SetAccountAttributeName sets AccountAttributeName field to given value. + +### HasAccountAttributeName + +`func (o *ManagerCorrelationMapping) HasAccountAttributeName() bool` + +HasAccountAttributeName returns a boolean if a field has been set. + +### GetIdentityAttributeName + +`func (o *ManagerCorrelationMapping) GetIdentityAttributeName() string` + +GetIdentityAttributeName returns the IdentityAttributeName field if non-nil, zero value otherwise. + +### GetIdentityAttributeNameOk + +`func (o *ManagerCorrelationMapping) GetIdentityAttributeNameOk() (*string, bool)` + +GetIdentityAttributeNameOk returns a tuple with the IdentityAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeName + +`func (o *ManagerCorrelationMapping) SetIdentityAttributeName(v string)` + +SetIdentityAttributeName sets IdentityAttributeName field to given value. + +### HasIdentityAttributeName + +`func (o *ManagerCorrelationMapping) HasIdentityAttributeName() bool` + +HasIdentityAttributeName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManualDiscoverApplications.md b/docs/tools/sdk/go/Reference/Beta/Models/ManualDiscoverApplications.md new file mode 100644 index 000000000..ba6a47eca --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManualDiscoverApplications.md @@ -0,0 +1,59 @@ +--- +id: beta-manual-discover-applications +title: ManualDiscoverApplications +pagination_label: ManualDiscoverApplications +sidebar_label: ManualDiscoverApplications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualDiscoverApplications', 'BetaManualDiscoverApplications'] +slug: /tools/sdk/go/beta/models/manual-discover-applications +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplications', 'BetaManualDiscoverApplications'] +--- + +# ManualDiscoverApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | ***os.File** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | + +## Methods + +### NewManualDiscoverApplications + +`func NewManualDiscoverApplications(file *os.File, ) *ManualDiscoverApplications` + +NewManualDiscoverApplications instantiates a new ManualDiscoverApplications 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 + +### NewManualDiscoverApplicationsWithDefaults + +`func NewManualDiscoverApplicationsWithDefaults() *ManualDiscoverApplications` + +NewManualDiscoverApplicationsWithDefaults instantiates a new ManualDiscoverApplications 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 + +### GetFile + +`func (o *ManualDiscoverApplications) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *ManualDiscoverApplications) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *ManualDiscoverApplications) SetFile(v *os.File)` + +SetFile sets File field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManualDiscoverApplicationsTemplate.md b/docs/tools/sdk/go/Reference/Beta/Models/ManualDiscoverApplicationsTemplate.md new file mode 100644 index 000000000..c1a251c31 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManualDiscoverApplicationsTemplate.md @@ -0,0 +1,90 @@ +--- +id: beta-manual-discover-applications-template +title: ManualDiscoverApplicationsTemplate +pagination_label: ManualDiscoverApplicationsTemplate +sidebar_label: ManualDiscoverApplicationsTemplate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualDiscoverApplicationsTemplate', 'BetaManualDiscoverApplicationsTemplate'] +slug: /tools/sdk/go/beta/models/manual-discover-applications-template +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplicationsTemplate', 'BetaManualDiscoverApplicationsTemplate'] +--- + +# ManualDiscoverApplicationsTemplate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationName** | Pointer to **string** | Name of the example application. | [optional] +**Description** | Pointer to **string** | Description of the example application. | [optional] + +## Methods + +### NewManualDiscoverApplicationsTemplate + +`func NewManualDiscoverApplicationsTemplate() *ManualDiscoverApplicationsTemplate` + +NewManualDiscoverApplicationsTemplate instantiates a new ManualDiscoverApplicationsTemplate 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 + +### NewManualDiscoverApplicationsTemplateWithDefaults + +`func NewManualDiscoverApplicationsTemplateWithDefaults() *ManualDiscoverApplicationsTemplate` + +NewManualDiscoverApplicationsTemplateWithDefaults instantiates a new ManualDiscoverApplicationsTemplate 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 + +### GetApplicationName + +`func (o *ManualDiscoverApplicationsTemplate) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *ManualDiscoverApplicationsTemplate) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *ManualDiscoverApplicationsTemplate) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *ManualDiscoverApplicationsTemplate) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ManualDiscoverApplicationsTemplate) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManualDiscoverApplicationsTemplate) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManualDiscoverApplicationsTemplate) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ManualDiscoverApplicationsTemplate) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManualWorkItemDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/ManualWorkItemDetails.md new file mode 100644 index 000000000..749b390fc --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManualWorkItemDetails.md @@ -0,0 +1,224 @@ +--- +id: beta-manual-work-item-details +title: ManualWorkItemDetails +pagination_label: ManualWorkItemDetails +sidebar_label: ManualWorkItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualWorkItemDetails', 'BetaManualWorkItemDetails'] +slug: /tools/sdk/go/beta/models/manual-work-item-details +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetails', 'BetaManualWorkItemDetails'] +--- + +# ManualWorkItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Forwarded** | Pointer to **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to false] +**OriginalOwner** | Pointer to [**NullableManualWorkItemDetailsOriginalOwner**](manual-work-item-details-original-owner) | | [optional] +**CurrentOwner** | Pointer to [**NullableManualWorkItemDetailsCurrentOwner**](manual-work-item-details-current-owner) | | [optional] +**Modified** | Pointer to **SailPointTime** | Time at which item was modified. | [optional] +**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] + +## Methods + +### NewManualWorkItemDetails + +`func NewManualWorkItemDetails() *ManualWorkItemDetails` + +NewManualWorkItemDetails instantiates a new ManualWorkItemDetails 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 + +### NewManualWorkItemDetailsWithDefaults + +`func NewManualWorkItemDetailsWithDefaults() *ManualWorkItemDetails` + +NewManualWorkItemDetailsWithDefaults instantiates a new ManualWorkItemDetails 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 + +### GetForwarded + +`func (o *ManualWorkItemDetails) GetForwarded() bool` + +GetForwarded returns the Forwarded field if non-nil, zero value otherwise. + +### GetForwardedOk + +`func (o *ManualWorkItemDetails) GetForwardedOk() (*bool, bool)` + +GetForwardedOk returns a tuple with the Forwarded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwarded + +`func (o *ManualWorkItemDetails) SetForwarded(v bool)` + +SetForwarded sets Forwarded field to given value. + +### HasForwarded + +`func (o *ManualWorkItemDetails) HasForwarded() bool` + +HasForwarded returns a boolean if a field has been set. + +### GetOriginalOwner + +`func (o *ManualWorkItemDetails) GetOriginalOwner() ManualWorkItemDetailsOriginalOwner` + +GetOriginalOwner returns the OriginalOwner field if non-nil, zero value otherwise. + +### GetOriginalOwnerOk + +`func (o *ManualWorkItemDetails) GetOriginalOwnerOk() (*ManualWorkItemDetailsOriginalOwner, bool)` + +GetOriginalOwnerOk returns a tuple with the OriginalOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalOwner + +`func (o *ManualWorkItemDetails) SetOriginalOwner(v ManualWorkItemDetailsOriginalOwner)` + +SetOriginalOwner sets OriginalOwner field to given value. + +### HasOriginalOwner + +`func (o *ManualWorkItemDetails) HasOriginalOwner() bool` + +HasOriginalOwner returns a boolean if a field has been set. + +### SetOriginalOwnerNil + +`func (o *ManualWorkItemDetails) SetOriginalOwnerNil(b bool)` + + SetOriginalOwnerNil sets the value for OriginalOwner to be an explicit nil + +### UnsetOriginalOwner +`func (o *ManualWorkItemDetails) UnsetOriginalOwner()` + +UnsetOriginalOwner ensures that no value is present for OriginalOwner, not even an explicit nil +### GetCurrentOwner + +`func (o *ManualWorkItemDetails) GetCurrentOwner() ManualWorkItemDetailsCurrentOwner` + +GetCurrentOwner returns the CurrentOwner field if non-nil, zero value otherwise. + +### GetCurrentOwnerOk + +`func (o *ManualWorkItemDetails) GetCurrentOwnerOk() (*ManualWorkItemDetailsCurrentOwner, bool)` + +GetCurrentOwnerOk returns a tuple with the CurrentOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentOwner + +`func (o *ManualWorkItemDetails) SetCurrentOwner(v ManualWorkItemDetailsCurrentOwner)` + +SetCurrentOwner sets CurrentOwner field to given value. + +### HasCurrentOwner + +`func (o *ManualWorkItemDetails) HasCurrentOwner() bool` + +HasCurrentOwner returns a boolean if a field has been set. + +### SetCurrentOwnerNil + +`func (o *ManualWorkItemDetails) SetCurrentOwnerNil(b bool)` + + SetCurrentOwnerNil sets the value for CurrentOwner to be an explicit nil + +### UnsetCurrentOwner +`func (o *ManualWorkItemDetails) UnsetCurrentOwner()` + +UnsetCurrentOwner ensures that no value is present for CurrentOwner, not even an explicit nil +### GetModified + +`func (o *ManualWorkItemDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ManualWorkItemDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ManualWorkItemDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ManualWorkItemDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetStatus + +`func (o *ManualWorkItemDetails) GetStatus() ManualWorkItemState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManualWorkItemDetails) GetStatusOk() (*ManualWorkItemState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManualWorkItemDetails) SetStatus(v ManualWorkItemState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ManualWorkItemDetails) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetForwardHistory + +`func (o *ManualWorkItemDetails) GetForwardHistory() []ApprovalForwardHistory` + +GetForwardHistory returns the ForwardHistory field if non-nil, zero value otherwise. + +### GetForwardHistoryOk + +`func (o *ManualWorkItemDetails) GetForwardHistoryOk() (*[]ApprovalForwardHistory, bool)` + +GetForwardHistoryOk returns a tuple with the ForwardHistory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwardHistory + +`func (o *ManualWorkItemDetails) SetForwardHistory(v []ApprovalForwardHistory)` + +SetForwardHistory sets ForwardHistory field to given value. + +### HasForwardHistory + +`func (o *ManualWorkItemDetails) HasForwardHistory() bool` + +HasForwardHistory returns a boolean if a field has been set. + +### SetForwardHistoryNil + +`func (o *ManualWorkItemDetails) SetForwardHistoryNil(b bool)` + + SetForwardHistoryNil sets the value for ForwardHistory to be an explicit nil + +### UnsetForwardHistory +`func (o *ManualWorkItemDetails) UnsetForwardHistory()` + +UnsetForwardHistory ensures that no value is present for ForwardHistory, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManualWorkItemDetailsCurrentOwner.md b/docs/tools/sdk/go/Reference/Beta/Models/ManualWorkItemDetailsCurrentOwner.md new file mode 100644 index 000000000..6e86d89bf --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManualWorkItemDetailsCurrentOwner.md @@ -0,0 +1,116 @@ +--- +id: beta-manual-work-item-details-current-owner +title: ManualWorkItemDetailsCurrentOwner +pagination_label: ManualWorkItemDetailsCurrentOwner +sidebar_label: ManualWorkItemDetailsCurrentOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualWorkItemDetailsCurrentOwner', 'BetaManualWorkItemDetailsCurrentOwner'] +slug: /tools/sdk/go/beta/models/manual-work-item-details-current-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsCurrentOwner', 'BetaManualWorkItemDetailsCurrentOwner'] +--- + +# ManualWorkItemDetailsCurrentOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of current work item owner's identity. | [optional] +**Id** | Pointer to **string** | ID of current work item owner's identity. | [optional] +**Name** | Pointer to **string** | Display name of current work item owner. | [optional] + +## Methods + +### NewManualWorkItemDetailsCurrentOwner + +`func NewManualWorkItemDetailsCurrentOwner() *ManualWorkItemDetailsCurrentOwner` + +NewManualWorkItemDetailsCurrentOwner instantiates a new ManualWorkItemDetailsCurrentOwner 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 + +### NewManualWorkItemDetailsCurrentOwnerWithDefaults + +`func NewManualWorkItemDetailsCurrentOwnerWithDefaults() *ManualWorkItemDetailsCurrentOwner` + +NewManualWorkItemDetailsCurrentOwnerWithDefaults instantiates a new ManualWorkItemDetailsCurrentOwner 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 + +### GetType + +`func (o *ManualWorkItemDetailsCurrentOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManualWorkItemDetailsCurrentOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManualWorkItemDetailsCurrentOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManualWorkItemDetailsCurrentOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ManualWorkItemDetailsCurrentOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManualWorkItemDetailsCurrentOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManualWorkItemDetailsCurrentOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ManualWorkItemDetailsCurrentOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ManualWorkItemDetailsCurrentOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManualWorkItemDetailsCurrentOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManualWorkItemDetailsCurrentOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManualWorkItemDetailsCurrentOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManualWorkItemDetailsOriginalOwner.md b/docs/tools/sdk/go/Reference/Beta/Models/ManualWorkItemDetailsOriginalOwner.md new file mode 100644 index 000000000..f41e90889 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManualWorkItemDetailsOriginalOwner.md @@ -0,0 +1,116 @@ +--- +id: beta-manual-work-item-details-original-owner +title: ManualWorkItemDetailsOriginalOwner +pagination_label: ManualWorkItemDetailsOriginalOwner +sidebar_label: ManualWorkItemDetailsOriginalOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualWorkItemDetailsOriginalOwner', 'BetaManualWorkItemDetailsOriginalOwner'] +slug: /tools/sdk/go/beta/models/manual-work-item-details-original-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsOriginalOwner', 'BetaManualWorkItemDetailsOriginalOwner'] +--- + +# ManualWorkItemDetailsOriginalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of original work item owner's identity. | [optional] +**Id** | Pointer to **string** | ID of original work item owner's identity. | [optional] +**Name** | Pointer to **string** | Display name of original work item owner. | [optional] + +## Methods + +### NewManualWorkItemDetailsOriginalOwner + +`func NewManualWorkItemDetailsOriginalOwner() *ManualWorkItemDetailsOriginalOwner` + +NewManualWorkItemDetailsOriginalOwner instantiates a new ManualWorkItemDetailsOriginalOwner 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 + +### NewManualWorkItemDetailsOriginalOwnerWithDefaults + +`func NewManualWorkItemDetailsOriginalOwnerWithDefaults() *ManualWorkItemDetailsOriginalOwner` + +NewManualWorkItemDetailsOriginalOwnerWithDefaults instantiates a new ManualWorkItemDetailsOriginalOwner 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 + +### GetType + +`func (o *ManualWorkItemDetailsOriginalOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManualWorkItemDetailsOriginalOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManualWorkItemDetailsOriginalOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManualWorkItemDetailsOriginalOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ManualWorkItemDetailsOriginalOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManualWorkItemDetailsOriginalOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManualWorkItemDetailsOriginalOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ManualWorkItemDetailsOriginalOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ManualWorkItemDetailsOriginalOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManualWorkItemDetailsOriginalOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManualWorkItemDetailsOriginalOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManualWorkItemDetailsOriginalOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManualWorkItemState.md b/docs/tools/sdk/go/Reference/Beta/Models/ManualWorkItemState.md new file mode 100644 index 000000000..0e11935e8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManualWorkItemState.md @@ -0,0 +1,29 @@ +--- +id: beta-manual-work-item-state +title: ManualWorkItemState +pagination_label: ManualWorkItemState +sidebar_label: ManualWorkItemState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualWorkItemState', 'BetaManualWorkItemState'] +slug: /tools/sdk/go/beta/models/manual-work-item-state +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemState', 'BetaManualWorkItemState'] +--- + +# ManualWorkItemState + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `EXPIRED` (value: `"EXPIRED"`) + +* `CANCELLED` (value: `"CANCELLED"`) + +* `ARCHIVED` (value: `"ARCHIVED"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ManuallyUpdatedFieldsDTO.md b/docs/tools/sdk/go/Reference/Beta/Models/ManuallyUpdatedFieldsDTO.md new file mode 100644 index 000000000..79d64577a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ManuallyUpdatedFieldsDTO.md @@ -0,0 +1,90 @@ +--- +id: beta-manually-updated-fields-dto +title: ManuallyUpdatedFieldsDTO +pagination_label: ManuallyUpdatedFieldsDTO +sidebar_label: ManuallyUpdatedFieldsDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManuallyUpdatedFieldsDTO', 'BetaManuallyUpdatedFieldsDTO'] +slug: /tools/sdk/go/beta/models/manually-updated-fields-dto +tags: ['SDK', 'Software Development Kit', 'ManuallyUpdatedFieldsDTO', 'BetaManuallyUpdatedFieldsDTO'] +--- + +# ManuallyUpdatedFieldsDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DISPLAY_NAME** | Pointer to **bool** | True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property. | [optional] [default to false] +**DESCRIPTION** | Pointer to **bool** | True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property. | [optional] [default to false] + +## Methods + +### NewManuallyUpdatedFieldsDTO + +`func NewManuallyUpdatedFieldsDTO() *ManuallyUpdatedFieldsDTO` + +NewManuallyUpdatedFieldsDTO instantiates a new ManuallyUpdatedFieldsDTO 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 + +### NewManuallyUpdatedFieldsDTOWithDefaults + +`func NewManuallyUpdatedFieldsDTOWithDefaults() *ManuallyUpdatedFieldsDTO` + +NewManuallyUpdatedFieldsDTOWithDefaults instantiates a new ManuallyUpdatedFieldsDTO 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 + +### GetDISPLAY_NAME + +`func (o *ManuallyUpdatedFieldsDTO) GetDISPLAY_NAME() bool` + +GetDISPLAY_NAME returns the DISPLAY_NAME field if non-nil, zero value otherwise. + +### GetDISPLAY_NAMEOk + +`func (o *ManuallyUpdatedFieldsDTO) GetDISPLAY_NAMEOk() (*bool, bool)` + +GetDISPLAY_NAMEOk returns a tuple with the DISPLAY_NAME field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDISPLAY_NAME + +`func (o *ManuallyUpdatedFieldsDTO) SetDISPLAY_NAME(v bool)` + +SetDISPLAY_NAME sets DISPLAY_NAME field to given value. + +### HasDISPLAY_NAME + +`func (o *ManuallyUpdatedFieldsDTO) HasDISPLAY_NAME() bool` + +HasDISPLAY_NAME returns a boolean if a field has been set. + +### GetDESCRIPTION + +`func (o *ManuallyUpdatedFieldsDTO) GetDESCRIPTION() bool` + +GetDESCRIPTION returns the DESCRIPTION field if non-nil, zero value otherwise. + +### GetDESCRIPTIONOk + +`func (o *ManuallyUpdatedFieldsDTO) GetDESCRIPTIONOk() (*bool, bool)` + +GetDESCRIPTIONOk returns a tuple with the DESCRIPTION field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDESCRIPTION + +`func (o *ManuallyUpdatedFieldsDTO) SetDESCRIPTION(v bool)` + +SetDESCRIPTION sets DESCRIPTION field to given value. + +### HasDESCRIPTION + +`func (o *ManuallyUpdatedFieldsDTO) HasDESCRIPTION() bool` + +HasDESCRIPTION returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MatchTerm.md b/docs/tools/sdk/go/Reference/Beta/Models/MatchTerm.md new file mode 100644 index 000000000..f5b233b0f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MatchTerm.md @@ -0,0 +1,204 @@ +--- +id: beta-match-term +title: MatchTerm +pagination_label: MatchTerm +sidebar_label: MatchTerm +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MatchTerm', 'BetaMatchTerm'] +slug: /tools/sdk/go/beta/models/match-term +tags: ['SDK', 'Software Development Kit', 'MatchTerm', 'BetaMatchTerm'] +--- + +# MatchTerm + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The attribute name | [optional] +**Value** | Pointer to **string** | The attribute value | [optional] +**Op** | Pointer to **string** | The operator between name and value | [optional] +**Container** | Pointer to **bool** | If it is a container or a real match term | [optional] [default to false] +**And** | Pointer to **bool** | If it is AND logical operator for the children match terms | [optional] [default to false] +**Children** | Pointer to **[]map[string]interface{}** | The children under this match term | [optional] + +## Methods + +### NewMatchTerm + +`func NewMatchTerm() *MatchTerm` + +NewMatchTerm instantiates a new MatchTerm 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 + +### NewMatchTermWithDefaults + +`func NewMatchTermWithDefaults() *MatchTerm` + +NewMatchTermWithDefaults instantiates a new MatchTerm 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 + +### GetName + +`func (o *MatchTerm) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MatchTerm) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MatchTerm) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MatchTerm) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValue + +`func (o *MatchTerm) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *MatchTerm) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *MatchTerm) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *MatchTerm) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetOp + +`func (o *MatchTerm) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *MatchTerm) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *MatchTerm) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *MatchTerm) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetContainer + +`func (o *MatchTerm) GetContainer() bool` + +GetContainer returns the Container field if non-nil, zero value otherwise. + +### GetContainerOk + +`func (o *MatchTerm) GetContainerOk() (*bool, bool)` + +GetContainerOk returns a tuple with the Container field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainer + +`func (o *MatchTerm) SetContainer(v bool)` + +SetContainer sets Container field to given value. + +### HasContainer + +`func (o *MatchTerm) HasContainer() bool` + +HasContainer returns a boolean if a field has been set. + +### GetAnd + +`func (o *MatchTerm) GetAnd() bool` + +GetAnd returns the And field if non-nil, zero value otherwise. + +### GetAndOk + +`func (o *MatchTerm) GetAndOk() (*bool, bool)` + +GetAndOk returns a tuple with the And field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnd + +`func (o *MatchTerm) SetAnd(v bool)` + +SetAnd sets And field to given value. + +### HasAnd + +`func (o *MatchTerm) HasAnd() bool` + +HasAnd returns a boolean if a field has been set. + +### GetChildren + +`func (o *MatchTerm) GetChildren() []map[string]interface{}` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *MatchTerm) GetChildrenOk() (*[]map[string]interface{}, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *MatchTerm) SetChildren(v []map[string]interface{})` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *MatchTerm) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *MatchTerm) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *MatchTerm) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Medium.md b/docs/tools/sdk/go/Reference/Beta/Models/Medium.md new file mode 100644 index 000000000..8c27841b3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Medium.md @@ -0,0 +1,27 @@ +--- +id: beta-medium +title: Medium +pagination_label: Medium +sidebar_label: Medium +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Medium', 'BetaMedium'] +slug: /tools/sdk/go/beta/models/medium +tags: ['SDK', 'Software Development Kit', 'Medium', 'BetaMedium'] +--- + +# Medium + +## Enum + + +* `EMAIL` (value: `"EMAIL"`) + +* `SMS` (value: `"SMS"`) + +* `PHONE` (value: `"PHONE"`) + +* `SLACK` (value: `"SLACK"`) + +* `TEAMS` (value: `"TEAMS"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MessageCatalogDto.md b/docs/tools/sdk/go/Reference/Beta/Models/MessageCatalogDto.md new file mode 100644 index 000000000..b5f4ccb26 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MessageCatalogDto.md @@ -0,0 +1,90 @@ +--- +id: beta-message-catalog-dto +title: MessageCatalogDto +pagination_label: MessageCatalogDto +sidebar_label: MessageCatalogDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MessageCatalogDto', 'BetaMessageCatalogDto'] +slug: /tools/sdk/go/beta/models/message-catalog-dto +tags: ['SDK', 'Software Development Kit', 'MessageCatalogDto', 'BetaMessageCatalogDto'] +--- + +# MessageCatalogDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | Pointer to **string** | The language in which the messages are returned | [optional] +**Messages** | Pointer to [**[]ResourceBundleMessage**](resource-bundle-message) | The list of message with their keys and formats | [optional] + +## Methods + +### NewMessageCatalogDto + +`func NewMessageCatalogDto() *MessageCatalogDto` + +NewMessageCatalogDto instantiates a new MessageCatalogDto 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 + +### NewMessageCatalogDtoWithDefaults + +`func NewMessageCatalogDtoWithDefaults() *MessageCatalogDto` + +NewMessageCatalogDtoWithDefaults instantiates a new MessageCatalogDto 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 + +### GetLocale + +`func (o *MessageCatalogDto) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *MessageCatalogDto) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *MessageCatalogDto) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *MessageCatalogDto) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + +### GetMessages + +`func (o *MessageCatalogDto) GetMessages() []ResourceBundleMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *MessageCatalogDto) GetMessagesOk() (*[]ResourceBundleMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *MessageCatalogDto) SetMessages(v []ResourceBundleMessage)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *MessageCatalogDto) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MetricResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/MetricResponse.md new file mode 100644 index 000000000..bbde6a50b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MetricResponse.md @@ -0,0 +1,90 @@ +--- +id: beta-metric-response +title: MetricResponse +pagination_label: MetricResponse +sidebar_label: MetricResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MetricResponse', 'BetaMetricResponse'] +slug: /tools/sdk/go/beta/models/metric-response +tags: ['SDK', 'Software Development Kit', 'MetricResponse', 'BetaMetricResponse'] +--- + +# MetricResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | the name of metric | [optional] +**Value** | Pointer to **float32** | the value associated to the metric | [optional] + +## Methods + +### NewMetricResponse + +`func NewMetricResponse() *MetricResponse` + +NewMetricResponse instantiates a new MetricResponse 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 + +### NewMetricResponseWithDefaults + +`func NewMetricResponseWithDefaults() *MetricResponse` + +NewMetricResponseWithDefaults instantiates a new MetricResponse 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 + +### GetName + +`func (o *MetricResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MetricResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MetricResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MetricResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValue + +`func (o *MetricResponse) GetValue() float32` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *MetricResponse) GetValueOk() (*float32, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *MetricResponse) SetValue(v float32)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *MetricResponse) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MfaConfigTestResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/MfaConfigTestResponse.md new file mode 100644 index 000000000..7cb705bec --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MfaConfigTestResponse.md @@ -0,0 +1,90 @@ +--- +id: beta-mfa-config-test-response +title: MfaConfigTestResponse +pagination_label: MfaConfigTestResponse +sidebar_label: MfaConfigTestResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MfaConfigTestResponse', 'BetaMfaConfigTestResponse'] +slug: /tools/sdk/go/beta/models/mfa-config-test-response +tags: ['SDK', 'Software Development Kit', 'MfaConfigTestResponse', 'BetaMfaConfigTestResponse'] +--- + +# MfaConfigTestResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **string** | The configuration test result. | [optional] [readonly] +**Error** | Pointer to **string** | The error message to indicate the failure of configuration test. | [optional] [readonly] + +## Methods + +### NewMfaConfigTestResponse + +`func NewMfaConfigTestResponse() *MfaConfigTestResponse` + +NewMfaConfigTestResponse instantiates a new MfaConfigTestResponse 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 + +### NewMfaConfigTestResponseWithDefaults + +`func NewMfaConfigTestResponseWithDefaults() *MfaConfigTestResponse` + +NewMfaConfigTestResponseWithDefaults instantiates a new MfaConfigTestResponse 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 + +### GetState + +`func (o *MfaConfigTestResponse) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *MfaConfigTestResponse) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *MfaConfigTestResponse) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *MfaConfigTestResponse) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetError + +`func (o *MfaConfigTestResponse) GetError() string` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *MfaConfigTestResponse) GetErrorOk() (*string, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *MfaConfigTestResponse) SetError(v string)` + +SetError sets Error field to given value. + +### HasError + +`func (o *MfaConfigTestResponse) HasError() bool` + +HasError returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MfaDuoConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/MfaDuoConfig.md new file mode 100644 index 000000000..4c0724596 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MfaDuoConfig.md @@ -0,0 +1,244 @@ +--- +id: beta-mfa-duo-config +title: MfaDuoConfig +pagination_label: MfaDuoConfig +sidebar_label: MfaDuoConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MfaDuoConfig', 'BetaMfaDuoConfig'] +slug: /tools/sdk/go/beta/models/mfa-duo-config +tags: ['SDK', 'Software Development Kit', 'MfaDuoConfig', 'BetaMfaDuoConfig'] +--- + +# MfaDuoConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MfaMethod** | Pointer to **NullableString** | Mfa method name | [optional] +**Enabled** | Pointer to **bool** | If MFA method is enabled. | [optional] [default to false] +**Host** | Pointer to **NullableString** | The server host name or IP address of the MFA provider. | [optional] +**AccessKey** | Pointer to **NullableString** | The secret key for authenticating requests to the MFA provider. | [optional] +**IdentityAttribute** | Pointer to **NullableString** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] +**ConfigProperties** | Pointer to **map[string]interface{}** | A map with additional config properties for the given MFA method - duo-web. | [optional] + +## Methods + +### NewMfaDuoConfig + +`func NewMfaDuoConfig() *MfaDuoConfig` + +NewMfaDuoConfig instantiates a new MfaDuoConfig 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 + +### NewMfaDuoConfigWithDefaults + +`func NewMfaDuoConfigWithDefaults() *MfaDuoConfig` + +NewMfaDuoConfigWithDefaults instantiates a new MfaDuoConfig 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 + +### GetMfaMethod + +`func (o *MfaDuoConfig) GetMfaMethod() string` + +GetMfaMethod returns the MfaMethod field if non-nil, zero value otherwise. + +### GetMfaMethodOk + +`func (o *MfaDuoConfig) GetMfaMethodOk() (*string, bool)` + +GetMfaMethodOk returns a tuple with the MfaMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMfaMethod + +`func (o *MfaDuoConfig) SetMfaMethod(v string)` + +SetMfaMethod sets MfaMethod field to given value. + +### HasMfaMethod + +`func (o *MfaDuoConfig) HasMfaMethod() bool` + +HasMfaMethod returns a boolean if a field has been set. + +### SetMfaMethodNil + +`func (o *MfaDuoConfig) SetMfaMethodNil(b bool)` + + SetMfaMethodNil sets the value for MfaMethod to be an explicit nil + +### UnsetMfaMethod +`func (o *MfaDuoConfig) UnsetMfaMethod()` + +UnsetMfaMethod ensures that no value is present for MfaMethod, not even an explicit nil +### GetEnabled + +`func (o *MfaDuoConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *MfaDuoConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *MfaDuoConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *MfaDuoConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetHost + +`func (o *MfaDuoConfig) GetHost() string` + +GetHost returns the Host field if non-nil, zero value otherwise. + +### GetHostOk + +`func (o *MfaDuoConfig) GetHostOk() (*string, bool)` + +GetHostOk returns a tuple with the Host field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHost + +`func (o *MfaDuoConfig) SetHost(v string)` + +SetHost sets Host field to given value. + +### HasHost + +`func (o *MfaDuoConfig) HasHost() bool` + +HasHost returns a boolean if a field has been set. + +### SetHostNil + +`func (o *MfaDuoConfig) SetHostNil(b bool)` + + SetHostNil sets the value for Host to be an explicit nil + +### UnsetHost +`func (o *MfaDuoConfig) UnsetHost()` + +UnsetHost ensures that no value is present for Host, not even an explicit nil +### GetAccessKey + +`func (o *MfaDuoConfig) GetAccessKey() string` + +GetAccessKey returns the AccessKey field if non-nil, zero value otherwise. + +### GetAccessKeyOk + +`func (o *MfaDuoConfig) GetAccessKeyOk() (*string, bool)` + +GetAccessKeyOk returns a tuple with the AccessKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessKey + +`func (o *MfaDuoConfig) SetAccessKey(v string)` + +SetAccessKey sets AccessKey field to given value. + +### HasAccessKey + +`func (o *MfaDuoConfig) HasAccessKey() bool` + +HasAccessKey returns a boolean if a field has been set. + +### SetAccessKeyNil + +`func (o *MfaDuoConfig) SetAccessKeyNil(b bool)` + + SetAccessKeyNil sets the value for AccessKey to be an explicit nil + +### UnsetAccessKey +`func (o *MfaDuoConfig) UnsetAccessKey()` + +UnsetAccessKey ensures that no value is present for AccessKey, not even an explicit nil +### GetIdentityAttribute + +`func (o *MfaDuoConfig) GetIdentityAttribute() string` + +GetIdentityAttribute returns the IdentityAttribute field if non-nil, zero value otherwise. + +### GetIdentityAttributeOk + +`func (o *MfaDuoConfig) GetIdentityAttributeOk() (*string, bool)` + +GetIdentityAttributeOk returns a tuple with the IdentityAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttribute + +`func (o *MfaDuoConfig) SetIdentityAttribute(v string)` + +SetIdentityAttribute sets IdentityAttribute field to given value. + +### HasIdentityAttribute + +`func (o *MfaDuoConfig) HasIdentityAttribute() bool` + +HasIdentityAttribute returns a boolean if a field has been set. + +### SetIdentityAttributeNil + +`func (o *MfaDuoConfig) SetIdentityAttributeNil(b bool)` + + SetIdentityAttributeNil sets the value for IdentityAttribute to be an explicit nil + +### UnsetIdentityAttribute +`func (o *MfaDuoConfig) UnsetIdentityAttribute()` + +UnsetIdentityAttribute ensures that no value is present for IdentityAttribute, not even an explicit nil +### GetConfigProperties + +`func (o *MfaDuoConfig) GetConfigProperties() map[string]interface{}` + +GetConfigProperties returns the ConfigProperties field if non-nil, zero value otherwise. + +### GetConfigPropertiesOk + +`func (o *MfaDuoConfig) GetConfigPropertiesOk() (*map[string]interface{}, bool)` + +GetConfigPropertiesOk returns a tuple with the ConfigProperties field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigProperties + +`func (o *MfaDuoConfig) SetConfigProperties(v map[string]interface{})` + +SetConfigProperties sets ConfigProperties field to given value. + +### HasConfigProperties + +`func (o *MfaDuoConfig) HasConfigProperties() bool` + +HasConfigProperties returns a boolean if a field has been set. + +### SetConfigPropertiesNil + +`func (o *MfaDuoConfig) SetConfigPropertiesNil(b bool)` + + SetConfigPropertiesNil sets the value for ConfigProperties to be an explicit nil + +### UnsetConfigProperties +`func (o *MfaDuoConfig) UnsetConfigProperties()` + +UnsetConfigProperties ensures that no value is present for ConfigProperties, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MfaOktaConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/MfaOktaConfig.md new file mode 100644 index 000000000..da09ed609 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MfaOktaConfig.md @@ -0,0 +1,208 @@ +--- +id: beta-mfa-okta-config +title: MfaOktaConfig +pagination_label: MfaOktaConfig +sidebar_label: MfaOktaConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MfaOktaConfig', 'BetaMfaOktaConfig'] +slug: /tools/sdk/go/beta/models/mfa-okta-config +tags: ['SDK', 'Software Development Kit', 'MfaOktaConfig', 'BetaMfaOktaConfig'] +--- + +# MfaOktaConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MfaMethod** | Pointer to **NullableString** | Mfa method name | [optional] +**Enabled** | Pointer to **bool** | If MFA method is enabled. | [optional] [default to false] +**Host** | Pointer to **NullableString** | The server host name or IP address of the MFA provider. | [optional] +**AccessKey** | Pointer to **NullableString** | The secret key for authenticating requests to the MFA provider. | [optional] +**IdentityAttribute** | Pointer to **NullableString** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] + +## Methods + +### NewMfaOktaConfig + +`func NewMfaOktaConfig() *MfaOktaConfig` + +NewMfaOktaConfig instantiates a new MfaOktaConfig 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 + +### NewMfaOktaConfigWithDefaults + +`func NewMfaOktaConfigWithDefaults() *MfaOktaConfig` + +NewMfaOktaConfigWithDefaults instantiates a new MfaOktaConfig 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 + +### GetMfaMethod + +`func (o *MfaOktaConfig) GetMfaMethod() string` + +GetMfaMethod returns the MfaMethod field if non-nil, zero value otherwise. + +### GetMfaMethodOk + +`func (o *MfaOktaConfig) GetMfaMethodOk() (*string, bool)` + +GetMfaMethodOk returns a tuple with the MfaMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMfaMethod + +`func (o *MfaOktaConfig) SetMfaMethod(v string)` + +SetMfaMethod sets MfaMethod field to given value. + +### HasMfaMethod + +`func (o *MfaOktaConfig) HasMfaMethod() bool` + +HasMfaMethod returns a boolean if a field has been set. + +### SetMfaMethodNil + +`func (o *MfaOktaConfig) SetMfaMethodNil(b bool)` + + SetMfaMethodNil sets the value for MfaMethod to be an explicit nil + +### UnsetMfaMethod +`func (o *MfaOktaConfig) UnsetMfaMethod()` + +UnsetMfaMethod ensures that no value is present for MfaMethod, not even an explicit nil +### GetEnabled + +`func (o *MfaOktaConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *MfaOktaConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *MfaOktaConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *MfaOktaConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetHost + +`func (o *MfaOktaConfig) GetHost() string` + +GetHost returns the Host field if non-nil, zero value otherwise. + +### GetHostOk + +`func (o *MfaOktaConfig) GetHostOk() (*string, bool)` + +GetHostOk returns a tuple with the Host field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHost + +`func (o *MfaOktaConfig) SetHost(v string)` + +SetHost sets Host field to given value. + +### HasHost + +`func (o *MfaOktaConfig) HasHost() bool` + +HasHost returns a boolean if a field has been set. + +### SetHostNil + +`func (o *MfaOktaConfig) SetHostNil(b bool)` + + SetHostNil sets the value for Host to be an explicit nil + +### UnsetHost +`func (o *MfaOktaConfig) UnsetHost()` + +UnsetHost ensures that no value is present for Host, not even an explicit nil +### GetAccessKey + +`func (o *MfaOktaConfig) GetAccessKey() string` + +GetAccessKey returns the AccessKey field if non-nil, zero value otherwise. + +### GetAccessKeyOk + +`func (o *MfaOktaConfig) GetAccessKeyOk() (*string, bool)` + +GetAccessKeyOk returns a tuple with the AccessKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessKey + +`func (o *MfaOktaConfig) SetAccessKey(v string)` + +SetAccessKey sets AccessKey field to given value. + +### HasAccessKey + +`func (o *MfaOktaConfig) HasAccessKey() bool` + +HasAccessKey returns a boolean if a field has been set. + +### SetAccessKeyNil + +`func (o *MfaOktaConfig) SetAccessKeyNil(b bool)` + + SetAccessKeyNil sets the value for AccessKey to be an explicit nil + +### UnsetAccessKey +`func (o *MfaOktaConfig) UnsetAccessKey()` + +UnsetAccessKey ensures that no value is present for AccessKey, not even an explicit nil +### GetIdentityAttribute + +`func (o *MfaOktaConfig) GetIdentityAttribute() string` + +GetIdentityAttribute returns the IdentityAttribute field if non-nil, zero value otherwise. + +### GetIdentityAttributeOk + +`func (o *MfaOktaConfig) GetIdentityAttributeOk() (*string, bool)` + +GetIdentityAttributeOk returns a tuple with the IdentityAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttribute + +`func (o *MfaOktaConfig) SetIdentityAttribute(v string)` + +SetIdentityAttribute sets IdentityAttribute field to given value. + +### HasIdentityAttribute + +`func (o *MfaOktaConfig) HasIdentityAttribute() bool` + +HasIdentityAttribute returns a boolean if a field has been set. + +### SetIdentityAttributeNil + +`func (o *MfaOktaConfig) SetIdentityAttributeNil(b bool)` + + SetIdentityAttributeNil sets the value for IdentityAttribute to be an explicit nil + +### UnsetIdentityAttribute +`func (o *MfaOktaConfig) UnsetIdentityAttribute()` + +UnsetIdentityAttribute ensures that no value is present for IdentityAttribute, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationTemplateType.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationTemplateType.md new file mode 100644 index 000000000..4a512d1cc --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationTemplateType.md @@ -0,0 +1,106 @@ +--- +id: beta-multi-host-integration-template-type +title: MultiHostIntegrationTemplateType +pagination_label: MultiHostIntegrationTemplateType +sidebar_label: MultiHostIntegrationTemplateType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationTemplateType', 'BetaMultiHostIntegrationTemplateType'] +slug: /tools/sdk/go/beta/models/multi-host-integration-template-type +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationTemplateType', 'BetaMultiHostIntegrationTemplateType'] +--- + +# MultiHostIntegrationTemplateType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | This is the name of the type. | [optional] +**Type** | **string** | This is the type value for the type. | +**ScriptName** | **string** | This is the scriptName attribute value for the type. | + +## Methods + +### NewMultiHostIntegrationTemplateType + +`func NewMultiHostIntegrationTemplateType(type_ string, scriptName string, ) *MultiHostIntegrationTemplateType` + +NewMultiHostIntegrationTemplateType instantiates a new MultiHostIntegrationTemplateType 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 + +### NewMultiHostIntegrationTemplateTypeWithDefaults + +`func NewMultiHostIntegrationTemplateTypeWithDefaults() *MultiHostIntegrationTemplateType` + +NewMultiHostIntegrationTemplateTypeWithDefaults instantiates a new MultiHostIntegrationTemplateType 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 + +### GetName + +`func (o *MultiHostIntegrationTemplateType) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrationTemplateType) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrationTemplateType) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MultiHostIntegrationTemplateType) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *MultiHostIntegrationTemplateType) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostIntegrationTemplateType) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostIntegrationTemplateType) SetType(v string)` + +SetType sets Type field to given value. + + +### GetScriptName + +`func (o *MultiHostIntegrationTemplateType) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *MultiHostIntegrationTemplateType) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *MultiHostIntegrationTemplateType) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrations.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrations.md new file mode 100644 index 000000000..3b68a0969 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrations.md @@ -0,0 +1,693 @@ +--- +id: beta-multi-host-integrations +title: MultiHostIntegrations +pagination_label: MultiHostIntegrations +sidebar_label: MultiHostIntegrations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrations', 'BetaMultiHostIntegrations'] +slug: /tools/sdk/go/beta/models/multi-host-integrations +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrations', 'BetaMultiHostIntegrations'] +--- + +# MultiHostIntegrations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Multi-Host Integration ID. | [readonly] +**Name** | **string** | Multi-Host Integration's human-readable name. | +**Description** | **string** | Multi-Host Integration's human-readable description. | +**Owner** | [**MultiHostIntegrationsOwner**](multi-host-integrations-owner) | | +**Cluster** | Pointer to [**NullableMultiHostIntegrationsCluster**](multi-host-integrations-cluster) | | [optional] +**Type** | Pointer to **string** | Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Connector** | **string** | Connector script name. | +**LastSourceUploadSuccessCount** | Pointer to **int32** | Last successfully uploaded source count of given Multi-Host Integration. | [optional] +**MaxSourcesPerAggGroup** | Pointer to **int32** | Maximum sources that can contain in a aggregation group of Multi-Host Integration. | [optional] +**ConnectorClass** | Pointer to **string** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**ConnectorAttributes** | Pointer to [**MultiHostIntegrationsConnectorAttributes**](multi-host-integrations-connector-attributes) | | [optional] +**DeleteThreshold** | Pointer to **int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**Authoritative** | Pointer to **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to false] +**ManagementWorkgroup** | Pointer to [**NullableMultiHostIntegrationsManagementWorkgroup**](multi-host-integrations-management-workgroup) | | [optional] +**Healthy** | Pointer to **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to false] +**Status** | Pointer to **string** | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**Since** | Pointer to **SailPointTime** | Timestamp that shows when a source health check was last performed. | [optional] +**ConnectorId** | Pointer to **string** | Connector ID | [optional] +**ConnectorName** | Pointer to **string** | Name of the connector that was chosen during source creation. | [optional] +**ConnectionType** | Pointer to **string** | Type of connection (direct or file). | [optional] +**ConnectorImplementationId** | Pointer to **string** | Connector implementation ID. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date-time when the source was last modified. | [optional] +**CredentialProviderEnabled** | Pointer to **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to false] +**Category** | Pointer to **NullableString** | Source category (e.g. null, CredentialProvider). | [optional] + +## Methods + +### NewMultiHostIntegrations + +`func NewMultiHostIntegrations(id string, name string, description string, owner MultiHostIntegrationsOwner, connector string, ) *MultiHostIntegrations` + +NewMultiHostIntegrations instantiates a new MultiHostIntegrations 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 + +### NewMultiHostIntegrationsWithDefaults + +`func NewMultiHostIntegrationsWithDefaults() *MultiHostIntegrations` + +NewMultiHostIntegrationsWithDefaults instantiates a new MultiHostIntegrations 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 + +### GetId + +`func (o *MultiHostIntegrations) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostIntegrations) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostIntegrations) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *MultiHostIntegrations) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrations) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrations) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *MultiHostIntegrations) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *MultiHostIntegrations) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *MultiHostIntegrations) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetOwner + +`func (o *MultiHostIntegrations) GetOwner() MultiHostIntegrationsOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *MultiHostIntegrations) GetOwnerOk() (*MultiHostIntegrationsOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *MultiHostIntegrations) SetOwner(v MultiHostIntegrationsOwner)` + +SetOwner sets Owner field to given value. + + +### GetCluster + +`func (o *MultiHostIntegrations) GetCluster() MultiHostIntegrationsCluster` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *MultiHostIntegrations) GetClusterOk() (*MultiHostIntegrationsCluster, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *MultiHostIntegrations) SetCluster(v MultiHostIntegrationsCluster)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *MultiHostIntegrations) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### SetClusterNil + +`func (o *MultiHostIntegrations) SetClusterNil(b bool)` + + SetClusterNil sets the value for Cluster to be an explicit nil + +### UnsetCluster +`func (o *MultiHostIntegrations) UnsetCluster()` + +UnsetCluster ensures that no value is present for Cluster, not even an explicit nil +### GetType + +`func (o *MultiHostIntegrations) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostIntegrations) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostIntegrations) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MultiHostIntegrations) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConnector + +`func (o *MultiHostIntegrations) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *MultiHostIntegrations) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *MultiHostIntegrations) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetLastSourceUploadSuccessCount + +`func (o *MultiHostIntegrations) GetLastSourceUploadSuccessCount() int32` + +GetLastSourceUploadSuccessCount returns the LastSourceUploadSuccessCount field if non-nil, zero value otherwise. + +### GetLastSourceUploadSuccessCountOk + +`func (o *MultiHostIntegrations) GetLastSourceUploadSuccessCountOk() (*int32, bool)` + +GetLastSourceUploadSuccessCountOk returns a tuple with the LastSourceUploadSuccessCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastSourceUploadSuccessCount + +`func (o *MultiHostIntegrations) SetLastSourceUploadSuccessCount(v int32)` + +SetLastSourceUploadSuccessCount sets LastSourceUploadSuccessCount field to given value. + +### HasLastSourceUploadSuccessCount + +`func (o *MultiHostIntegrations) HasLastSourceUploadSuccessCount() bool` + +HasLastSourceUploadSuccessCount returns a boolean if a field has been set. + +### GetMaxSourcesPerAggGroup + +`func (o *MultiHostIntegrations) GetMaxSourcesPerAggGroup() int32` + +GetMaxSourcesPerAggGroup returns the MaxSourcesPerAggGroup field if non-nil, zero value otherwise. + +### GetMaxSourcesPerAggGroupOk + +`func (o *MultiHostIntegrations) GetMaxSourcesPerAggGroupOk() (*int32, bool)` + +GetMaxSourcesPerAggGroupOk returns a tuple with the MaxSourcesPerAggGroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxSourcesPerAggGroup + +`func (o *MultiHostIntegrations) SetMaxSourcesPerAggGroup(v int32)` + +SetMaxSourcesPerAggGroup sets MaxSourcesPerAggGroup field to given value. + +### HasMaxSourcesPerAggGroup + +`func (o *MultiHostIntegrations) HasMaxSourcesPerAggGroup() bool` + +HasMaxSourcesPerAggGroup returns a boolean if a field has been set. + +### GetConnectorClass + +`func (o *MultiHostIntegrations) GetConnectorClass() string` + +GetConnectorClass returns the ConnectorClass field if non-nil, zero value otherwise. + +### GetConnectorClassOk + +`func (o *MultiHostIntegrations) GetConnectorClassOk() (*string, bool)` + +GetConnectorClassOk returns a tuple with the ConnectorClass field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorClass + +`func (o *MultiHostIntegrations) SetConnectorClass(v string)` + +SetConnectorClass sets ConnectorClass field to given value. + +### HasConnectorClass + +`func (o *MultiHostIntegrations) HasConnectorClass() bool` + +HasConnectorClass returns a boolean if a field has been set. + +### GetConnectorAttributes + +`func (o *MultiHostIntegrations) GetConnectorAttributes() MultiHostIntegrationsConnectorAttributes` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *MultiHostIntegrations) GetConnectorAttributesOk() (*MultiHostIntegrationsConnectorAttributes, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *MultiHostIntegrations) SetConnectorAttributes(v MultiHostIntegrationsConnectorAttributes)` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + +### HasConnectorAttributes + +`func (o *MultiHostIntegrations) HasConnectorAttributes() bool` + +HasConnectorAttributes returns a boolean if a field has been set. + +### GetDeleteThreshold + +`func (o *MultiHostIntegrations) GetDeleteThreshold() int32` + +GetDeleteThreshold returns the DeleteThreshold field if non-nil, zero value otherwise. + +### GetDeleteThresholdOk + +`func (o *MultiHostIntegrations) GetDeleteThresholdOk() (*int32, bool)` + +GetDeleteThresholdOk returns a tuple with the DeleteThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteThreshold + +`func (o *MultiHostIntegrations) SetDeleteThreshold(v int32)` + +SetDeleteThreshold sets DeleteThreshold field to given value. + +### HasDeleteThreshold + +`func (o *MultiHostIntegrations) HasDeleteThreshold() bool` + +HasDeleteThreshold returns a boolean if a field has been set. + +### GetAuthoritative + +`func (o *MultiHostIntegrations) GetAuthoritative() bool` + +GetAuthoritative returns the Authoritative field if non-nil, zero value otherwise. + +### GetAuthoritativeOk + +`func (o *MultiHostIntegrations) GetAuthoritativeOk() (*bool, bool)` + +GetAuthoritativeOk returns a tuple with the Authoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritative + +`func (o *MultiHostIntegrations) SetAuthoritative(v bool)` + +SetAuthoritative sets Authoritative field to given value. + +### HasAuthoritative + +`func (o *MultiHostIntegrations) HasAuthoritative() bool` + +HasAuthoritative returns a boolean if a field has been set. + +### GetManagementWorkgroup + +`func (o *MultiHostIntegrations) GetManagementWorkgroup() MultiHostIntegrationsManagementWorkgroup` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *MultiHostIntegrations) GetManagementWorkgroupOk() (*MultiHostIntegrationsManagementWorkgroup, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *MultiHostIntegrations) SetManagementWorkgroup(v MultiHostIntegrationsManagementWorkgroup)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *MultiHostIntegrations) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### SetManagementWorkgroupNil + +`func (o *MultiHostIntegrations) SetManagementWorkgroupNil(b bool)` + + SetManagementWorkgroupNil sets the value for ManagementWorkgroup to be an explicit nil + +### UnsetManagementWorkgroup +`func (o *MultiHostIntegrations) UnsetManagementWorkgroup()` + +UnsetManagementWorkgroup ensures that no value is present for ManagementWorkgroup, not even an explicit nil +### GetHealthy + +`func (o *MultiHostIntegrations) GetHealthy() bool` + +GetHealthy returns the Healthy field if non-nil, zero value otherwise. + +### GetHealthyOk + +`func (o *MultiHostIntegrations) GetHealthyOk() (*bool, bool)` + +GetHealthyOk returns a tuple with the Healthy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthy + +`func (o *MultiHostIntegrations) SetHealthy(v bool)` + +SetHealthy sets Healthy field to given value. + +### HasHealthy + +`func (o *MultiHostIntegrations) HasHealthy() bool` + +HasHealthy returns a boolean if a field has been set. + +### GetStatus + +`func (o *MultiHostIntegrations) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *MultiHostIntegrations) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *MultiHostIntegrations) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *MultiHostIntegrations) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSince + +`func (o *MultiHostIntegrations) GetSince() SailPointTime` + +GetSince returns the Since field if non-nil, zero value otherwise. + +### GetSinceOk + +`func (o *MultiHostIntegrations) GetSinceOk() (*SailPointTime, bool)` + +GetSinceOk returns a tuple with the Since field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSince + +`func (o *MultiHostIntegrations) SetSince(v SailPointTime)` + +SetSince sets Since field to given value. + +### HasSince + +`func (o *MultiHostIntegrations) HasSince() bool` + +HasSince returns a boolean if a field has been set. + +### GetConnectorId + +`func (o *MultiHostIntegrations) GetConnectorId() string` + +GetConnectorId returns the ConnectorId field if non-nil, zero value otherwise. + +### GetConnectorIdOk + +`func (o *MultiHostIntegrations) GetConnectorIdOk() (*string, bool)` + +GetConnectorIdOk returns a tuple with the ConnectorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorId + +`func (o *MultiHostIntegrations) SetConnectorId(v string)` + +SetConnectorId sets ConnectorId field to given value. + +### HasConnectorId + +`func (o *MultiHostIntegrations) HasConnectorId() bool` + +HasConnectorId returns a boolean if a field has been set. + +### GetConnectorName + +`func (o *MultiHostIntegrations) GetConnectorName() string` + +GetConnectorName returns the ConnectorName field if non-nil, zero value otherwise. + +### GetConnectorNameOk + +`func (o *MultiHostIntegrations) GetConnectorNameOk() (*string, bool)` + +GetConnectorNameOk returns a tuple with the ConnectorName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorName + +`func (o *MultiHostIntegrations) SetConnectorName(v string)` + +SetConnectorName sets ConnectorName field to given value. + +### HasConnectorName + +`func (o *MultiHostIntegrations) HasConnectorName() bool` + +HasConnectorName returns a boolean if a field has been set. + +### GetConnectionType + +`func (o *MultiHostIntegrations) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *MultiHostIntegrations) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *MultiHostIntegrations) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *MultiHostIntegrations) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + +### GetConnectorImplementationId + +`func (o *MultiHostIntegrations) GetConnectorImplementationId() string` + +GetConnectorImplementationId returns the ConnectorImplementationId field if non-nil, zero value otherwise. + +### GetConnectorImplementationIdOk + +`func (o *MultiHostIntegrations) GetConnectorImplementationIdOk() (*string, bool)` + +GetConnectorImplementationIdOk returns a tuple with the ConnectorImplementationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorImplementationId + +`func (o *MultiHostIntegrations) SetConnectorImplementationId(v string)` + +SetConnectorImplementationId sets ConnectorImplementationId field to given value. + +### HasConnectorImplementationId + +`func (o *MultiHostIntegrations) HasConnectorImplementationId() bool` + +HasConnectorImplementationId returns a boolean if a field has been set. + +### GetCreated + +`func (o *MultiHostIntegrations) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MultiHostIntegrations) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MultiHostIntegrations) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MultiHostIntegrations) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MultiHostIntegrations) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MultiHostIntegrations) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MultiHostIntegrations) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MultiHostIntegrations) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCredentialProviderEnabled + +`func (o *MultiHostIntegrations) GetCredentialProviderEnabled() bool` + +GetCredentialProviderEnabled returns the CredentialProviderEnabled field if non-nil, zero value otherwise. + +### GetCredentialProviderEnabledOk + +`func (o *MultiHostIntegrations) GetCredentialProviderEnabledOk() (*bool, bool)` + +GetCredentialProviderEnabledOk returns a tuple with the CredentialProviderEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialProviderEnabled + +`func (o *MultiHostIntegrations) SetCredentialProviderEnabled(v bool)` + +SetCredentialProviderEnabled sets CredentialProviderEnabled field to given value. + +### HasCredentialProviderEnabled + +`func (o *MultiHostIntegrations) HasCredentialProviderEnabled() bool` + +HasCredentialProviderEnabled returns a boolean if a field has been set. + +### GetCategory + +`func (o *MultiHostIntegrations) GetCategory() string` + +GetCategory returns the Category field if non-nil, zero value otherwise. + +### GetCategoryOk + +`func (o *MultiHostIntegrations) GetCategoryOk() (*string, bool)` + +GetCategoryOk returns a tuple with the Category field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCategory + +`func (o *MultiHostIntegrations) SetCategory(v string)` + +SetCategory sets Category field to given value. + +### HasCategory + +`func (o *MultiHostIntegrations) HasCategory() bool` + +HasCategory returns a boolean if a field has been set. + +### SetCategoryNil + +`func (o *MultiHostIntegrations) SetCategoryNil(b bool)` + + SetCategoryNil sets the value for Category to be an explicit nil + +### UnsetCategory +`func (o *MultiHostIntegrations) UnsetCategory()` + +UnsetCategory ensures that no value is present for Category, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsAggScheduleUpdate.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsAggScheduleUpdate.md new file mode 100644 index 000000000..b0968990c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsAggScheduleUpdate.md @@ -0,0 +1,216 @@ +--- +id: beta-multi-host-integrations-agg-schedule-update +title: MultiHostIntegrationsAggScheduleUpdate +pagination_label: MultiHostIntegrationsAggScheduleUpdate +sidebar_label: MultiHostIntegrationsAggScheduleUpdate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsAggScheduleUpdate', 'BetaMultiHostIntegrationsAggScheduleUpdate'] +slug: /tools/sdk/go/beta/models/multi-host-integrations-agg-schedule-update +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsAggScheduleUpdate', 'BetaMultiHostIntegrationsAggScheduleUpdate'] +--- + +# MultiHostIntegrationsAggScheduleUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MultihostId** | **string** | Multi-Host Integration ID. The ID must be unique | +**AggregationGrpId** | **string** | Multi-Host Integration aggregation group ID | +**AggregationGrpName** | **string** | Multi-Host Integration name | +**AggregationCronSchedule** | **string** | Cron expression to schedule aggregation | +**EnableSchedule** | **bool** | Boolean value for Multi-Host Integration aggregation schedule. This specifies if scheduled aggregation is enabled or disabled. | [default to false] +**SourceIdList** | **[]string** | Source IDs of the Multi-Host Integration | +**Created** | Pointer to **SailPointTime** | Created date of Multi-Host Integration aggregation schedule | [optional] +**Modified** | Pointer to **SailPointTime** | Modified date of Multi-Host Integration aggregation schedule | [optional] + +## Methods + +### NewMultiHostIntegrationsAggScheduleUpdate + +`func NewMultiHostIntegrationsAggScheduleUpdate(multihostId string, aggregationGrpId string, aggregationGrpName string, aggregationCronSchedule string, enableSchedule bool, sourceIdList []string, ) *MultiHostIntegrationsAggScheduleUpdate` + +NewMultiHostIntegrationsAggScheduleUpdate instantiates a new MultiHostIntegrationsAggScheduleUpdate 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 + +### NewMultiHostIntegrationsAggScheduleUpdateWithDefaults + +`func NewMultiHostIntegrationsAggScheduleUpdateWithDefaults() *MultiHostIntegrationsAggScheduleUpdate` + +NewMultiHostIntegrationsAggScheduleUpdateWithDefaults instantiates a new MultiHostIntegrationsAggScheduleUpdate 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 + +### GetMultihostId + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetMultihostId() string` + +GetMultihostId returns the MultihostId field if non-nil, zero value otherwise. + +### GetMultihostIdOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetMultihostIdOk() (*string, bool)` + +GetMultihostIdOk returns a tuple with the MultihostId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultihostId + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetMultihostId(v string)` + +SetMultihostId sets MultihostId field to given value. + + +### GetAggregationGrpId + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationGrpId() string` + +GetAggregationGrpId returns the AggregationGrpId field if non-nil, zero value otherwise. + +### GetAggregationGrpIdOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationGrpIdOk() (*string, bool)` + +GetAggregationGrpIdOk returns a tuple with the AggregationGrpId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationGrpId + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetAggregationGrpId(v string)` + +SetAggregationGrpId sets AggregationGrpId field to given value. + + +### GetAggregationGrpName + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationGrpName() string` + +GetAggregationGrpName returns the AggregationGrpName field if non-nil, zero value otherwise. + +### GetAggregationGrpNameOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationGrpNameOk() (*string, bool)` + +GetAggregationGrpNameOk returns a tuple with the AggregationGrpName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationGrpName + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetAggregationGrpName(v string)` + +SetAggregationGrpName sets AggregationGrpName field to given value. + + +### GetAggregationCronSchedule + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationCronSchedule() string` + +GetAggregationCronSchedule returns the AggregationCronSchedule field if non-nil, zero value otherwise. + +### GetAggregationCronScheduleOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationCronScheduleOk() (*string, bool)` + +GetAggregationCronScheduleOk returns a tuple with the AggregationCronSchedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationCronSchedule + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetAggregationCronSchedule(v string)` + +SetAggregationCronSchedule sets AggregationCronSchedule field to given value. + + +### GetEnableSchedule + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetEnableSchedule() bool` + +GetEnableSchedule returns the EnableSchedule field if non-nil, zero value otherwise. + +### GetEnableScheduleOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetEnableScheduleOk() (*bool, bool)` + +GetEnableScheduleOk returns a tuple with the EnableSchedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnableSchedule + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetEnableSchedule(v bool)` + +SetEnableSchedule sets EnableSchedule field to given value. + + +### GetSourceIdList + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetSourceIdList() []string` + +GetSourceIdList returns the SourceIdList field if non-nil, zero value otherwise. + +### GetSourceIdListOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetSourceIdListOk() (*[]string, bool)` + +GetSourceIdListOk returns a tuple with the SourceIdList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIdList + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetSourceIdList(v []string)` + +SetSourceIdList sets SourceIdList field to given value. + + +### GetCreated + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MultiHostIntegrationsAggScheduleUpdate) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MultiHostIntegrationsAggScheduleUpdate) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsCluster.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsCluster.md new file mode 100644 index 000000000..1d893ef99 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsCluster.md @@ -0,0 +1,101 @@ +--- +id: beta-multi-host-integrations-cluster +title: MultiHostIntegrationsCluster +pagination_label: MultiHostIntegrationsCluster +sidebar_label: MultiHostIntegrationsCluster +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsCluster', 'BetaMultiHostIntegrationsCluster'] +slug: /tools/sdk/go/beta/models/multi-host-integrations-cluster +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCluster', 'BetaMultiHostIntegrationsCluster'] +--- + +# MultiHostIntegrationsCluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of object being referenced. | +**Id** | **string** | Cluster ID. | +**Name** | **string** | Cluster's human-readable display name. | + +## Methods + +### NewMultiHostIntegrationsCluster + +`func NewMultiHostIntegrationsCluster(type_ string, id string, name string, ) *MultiHostIntegrationsCluster` + +NewMultiHostIntegrationsCluster instantiates a new MultiHostIntegrationsCluster 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 + +### NewMultiHostIntegrationsClusterWithDefaults + +`func NewMultiHostIntegrationsClusterWithDefaults() *MultiHostIntegrationsCluster` + +NewMultiHostIntegrationsClusterWithDefaults instantiates a new MultiHostIntegrationsCluster 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 + +### GetType + +`func (o *MultiHostIntegrationsCluster) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostIntegrationsCluster) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostIntegrationsCluster) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *MultiHostIntegrationsCluster) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostIntegrationsCluster) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostIntegrationsCluster) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *MultiHostIntegrationsCluster) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrationsCluster) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrationsCluster) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributes.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributes.md new file mode 100644 index 000000000..3285316d2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributes.md @@ -0,0 +1,220 @@ +--- +id: beta-multi-host-integrations-connector-attributes +title: MultiHostIntegrationsConnectorAttributes +pagination_label: MultiHostIntegrationsConnectorAttributes +sidebar_label: MultiHostIntegrationsConnectorAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsConnectorAttributes', 'BetaMultiHostIntegrationsConnectorAttributes'] +slug: /tools/sdk/go/beta/models/multi-host-integrations-connector-attributes +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributes', 'BetaMultiHostIntegrationsConnectorAttributes'] +--- + +# MultiHostIntegrationsConnectorAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxAllowedSources** | Pointer to **int32** | Maximum sources allowed count of a Multi-Host Integration | [optional] +**LastSourceUploadCount** | Pointer to **int32** | Last upload sources count of a Multi-Host Integration | [optional] +**ConnectorFileUploadHistory** | Pointer to [**MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory**](multi-host-integrations-connector-attributes-connector-file-upload-history) | | [optional] +**MultihostStatus** | Pointer to **string** | Multi-Host integration status. | [optional] +**ShowAccountSchema** | Pointer to **bool** | Show account schema | [optional] [default to true] +**ShowEntitlementSchema** | Pointer to **bool** | Show entitlement schema | [optional] [default to true] +**MultiHostAttributes** | Pointer to [**MultiHostIntegrationsConnectorAttributesMultiHostAttributes**](multi-host-integrations-connector-attributes-multi-host-attributes) | | [optional] + +## Methods + +### NewMultiHostIntegrationsConnectorAttributes + +`func NewMultiHostIntegrationsConnectorAttributes() *MultiHostIntegrationsConnectorAttributes` + +NewMultiHostIntegrationsConnectorAttributes instantiates a new MultiHostIntegrationsConnectorAttributes 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 + +### NewMultiHostIntegrationsConnectorAttributesWithDefaults + +`func NewMultiHostIntegrationsConnectorAttributesWithDefaults() *MultiHostIntegrationsConnectorAttributes` + +NewMultiHostIntegrationsConnectorAttributesWithDefaults instantiates a new MultiHostIntegrationsConnectorAttributes 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 + +### GetMaxAllowedSources + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMaxAllowedSources() int32` + +GetMaxAllowedSources returns the MaxAllowedSources field if non-nil, zero value otherwise. + +### GetMaxAllowedSourcesOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMaxAllowedSourcesOk() (*int32, bool)` + +GetMaxAllowedSourcesOk returns a tuple with the MaxAllowedSources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxAllowedSources + +`func (o *MultiHostIntegrationsConnectorAttributes) SetMaxAllowedSources(v int32)` + +SetMaxAllowedSources sets MaxAllowedSources field to given value. + +### HasMaxAllowedSources + +`func (o *MultiHostIntegrationsConnectorAttributes) HasMaxAllowedSources() bool` + +HasMaxAllowedSources returns a boolean if a field has been set. + +### GetLastSourceUploadCount + +`func (o *MultiHostIntegrationsConnectorAttributes) GetLastSourceUploadCount() int32` + +GetLastSourceUploadCount returns the LastSourceUploadCount field if non-nil, zero value otherwise. + +### GetLastSourceUploadCountOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetLastSourceUploadCountOk() (*int32, bool)` + +GetLastSourceUploadCountOk returns a tuple with the LastSourceUploadCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastSourceUploadCount + +`func (o *MultiHostIntegrationsConnectorAttributes) SetLastSourceUploadCount(v int32)` + +SetLastSourceUploadCount sets LastSourceUploadCount field to given value. + +### HasLastSourceUploadCount + +`func (o *MultiHostIntegrationsConnectorAttributes) HasLastSourceUploadCount() bool` + +HasLastSourceUploadCount returns a boolean if a field has been set. + +### GetConnectorFileUploadHistory + +`func (o *MultiHostIntegrationsConnectorAttributes) GetConnectorFileUploadHistory() MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory` + +GetConnectorFileUploadHistory returns the ConnectorFileUploadHistory field if non-nil, zero value otherwise. + +### GetConnectorFileUploadHistoryOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetConnectorFileUploadHistoryOk() (*MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory, bool)` + +GetConnectorFileUploadHistoryOk returns a tuple with the ConnectorFileUploadHistory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorFileUploadHistory + +`func (o *MultiHostIntegrationsConnectorAttributes) SetConnectorFileUploadHistory(v MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory)` + +SetConnectorFileUploadHistory sets ConnectorFileUploadHistory field to given value. + +### HasConnectorFileUploadHistory + +`func (o *MultiHostIntegrationsConnectorAttributes) HasConnectorFileUploadHistory() bool` + +HasConnectorFileUploadHistory returns a boolean if a field has been set. + +### GetMultihostStatus + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMultihostStatus() string` + +GetMultihostStatus returns the MultihostStatus field if non-nil, zero value otherwise. + +### GetMultihostStatusOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMultihostStatusOk() (*string, bool)` + +GetMultihostStatusOk returns a tuple with the MultihostStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultihostStatus + +`func (o *MultiHostIntegrationsConnectorAttributes) SetMultihostStatus(v string)` + +SetMultihostStatus sets MultihostStatus field to given value. + +### HasMultihostStatus + +`func (o *MultiHostIntegrationsConnectorAttributes) HasMultihostStatus() bool` + +HasMultihostStatus returns a boolean if a field has been set. + +### GetShowAccountSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) GetShowAccountSchema() bool` + +GetShowAccountSchema returns the ShowAccountSchema field if non-nil, zero value otherwise. + +### GetShowAccountSchemaOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetShowAccountSchemaOk() (*bool, bool)` + +GetShowAccountSchemaOk returns a tuple with the ShowAccountSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShowAccountSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) SetShowAccountSchema(v bool)` + +SetShowAccountSchema sets ShowAccountSchema field to given value. + +### HasShowAccountSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) HasShowAccountSchema() bool` + +HasShowAccountSchema returns a boolean if a field has been set. + +### GetShowEntitlementSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) GetShowEntitlementSchema() bool` + +GetShowEntitlementSchema returns the ShowEntitlementSchema field if non-nil, zero value otherwise. + +### GetShowEntitlementSchemaOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetShowEntitlementSchemaOk() (*bool, bool)` + +GetShowEntitlementSchemaOk returns a tuple with the ShowEntitlementSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShowEntitlementSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) SetShowEntitlementSchema(v bool)` + +SetShowEntitlementSchema sets ShowEntitlementSchema field to given value. + +### HasShowEntitlementSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) HasShowEntitlementSchema() bool` + +HasShowEntitlementSchema returns a boolean if a field has been set. + +### GetMultiHostAttributes + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMultiHostAttributes() MultiHostIntegrationsConnectorAttributesMultiHostAttributes` + +GetMultiHostAttributes returns the MultiHostAttributes field if non-nil, zero value otherwise. + +### GetMultiHostAttributesOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMultiHostAttributesOk() (*MultiHostIntegrationsConnectorAttributesMultiHostAttributes, bool)` + +GetMultiHostAttributesOk returns a tuple with the MultiHostAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultiHostAttributes + +`func (o *MultiHostIntegrationsConnectorAttributes) SetMultiHostAttributes(v MultiHostIntegrationsConnectorAttributesMultiHostAttributes)` + +SetMultiHostAttributes sets MultiHostAttributes field to given value. + +### HasMultiHostAttributes + +`func (o *MultiHostIntegrationsConnectorAttributes) HasMultiHostAttributes() bool` + +HasMultiHostAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md new file mode 100644 index 000000000..aae0c20ea --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md @@ -0,0 +1,64 @@ +--- +id: beta-multi-host-integrations-connector-attributes-connector-file-upload-history +title: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory +pagination_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory +sidebar_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory', 'BetaMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory'] +slug: /tools/sdk/go/beta/models/multi-host-integrations-connector-attributes-connector-file-upload-history +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory', 'BetaMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory'] +--- + +# MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConnectorFileNameUploadedDate** | Pointer to **string** | File name of the connector JAR | [optional] + +## Methods + +### NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory + +`func NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory() *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory` + +NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory instantiates a new MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory 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 + +### NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryWithDefaults + +`func NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryWithDefaults() *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory` + +NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryWithDefaults instantiates a new MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory 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 + +### GetConnectorFileNameUploadedDate + +`func (o *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory) GetConnectorFileNameUploadedDate() string` + +GetConnectorFileNameUploadedDate returns the ConnectorFileNameUploadedDate field if non-nil, zero value otherwise. + +### GetConnectorFileNameUploadedDateOk + +`func (o *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory) GetConnectorFileNameUploadedDateOk() (*string, bool)` + +GetConnectorFileNameUploadedDateOk returns a tuple with the ConnectorFileNameUploadedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorFileNameUploadedDate + +`func (o *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory) SetConnectorFileNameUploadedDate(v string)` + +SetConnectorFileNameUploadedDate sets ConnectorFileNameUploadedDate field to given value. + +### HasConnectorFileNameUploadedDate + +`func (o *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory) HasConnectorFileNameUploadedDate() bool` + +HasConnectorFileNameUploadedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md new file mode 100644 index 000000000..09325e4ea --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md @@ -0,0 +1,142 @@ +--- +id: beta-multi-host-integrations-connector-attributes-multi-host-attributes +title: MultiHostIntegrationsConnectorAttributesMultiHostAttributes +pagination_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes +sidebar_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes', 'BetaMultiHostIntegrationsConnectorAttributesMultiHostAttributes'] +slug: /tools/sdk/go/beta/models/multi-host-integrations-connector-attributes-multi-host-attributes +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes', 'BetaMultiHostIntegrationsConnectorAttributesMultiHostAttributes'] +--- + +# MultiHostIntegrationsConnectorAttributesMultiHostAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Password** | Pointer to **string** | Password. | [optional] +**ConnectorFiles** | Pointer to **string** | Connector file. | [optional] +**AuthType** | Pointer to **string** | Authentication type. | [optional] +**User** | Pointer to **string** | Username. | [optional] + +## Methods + +### NewMultiHostIntegrationsConnectorAttributesMultiHostAttributes + +`func NewMultiHostIntegrationsConnectorAttributesMultiHostAttributes() *MultiHostIntegrationsConnectorAttributesMultiHostAttributes` + +NewMultiHostIntegrationsConnectorAttributesMultiHostAttributes instantiates a new MultiHostIntegrationsConnectorAttributesMultiHostAttributes 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 + +### NewMultiHostIntegrationsConnectorAttributesMultiHostAttributesWithDefaults + +`func NewMultiHostIntegrationsConnectorAttributesMultiHostAttributesWithDefaults() *MultiHostIntegrationsConnectorAttributesMultiHostAttributes` + +NewMultiHostIntegrationsConnectorAttributesMultiHostAttributesWithDefaults instantiates a new MultiHostIntegrationsConnectorAttributesMultiHostAttributes 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 + +### GetPassword + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) SetPassword(v string)` + +SetPassword sets Password field to given value. + +### HasPassword + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) HasPassword() bool` + +HasPassword returns a boolean if a field has been set. + +### GetConnectorFiles + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetConnectorFiles() string` + +GetConnectorFiles returns the ConnectorFiles field if non-nil, zero value otherwise. + +### GetConnectorFilesOk + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetConnectorFilesOk() (*string, bool)` + +GetConnectorFilesOk returns a tuple with the ConnectorFiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorFiles + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) SetConnectorFiles(v string)` + +SetConnectorFiles sets ConnectorFiles field to given value. + +### HasConnectorFiles + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) HasConnectorFiles() bool` + +HasConnectorFiles returns a boolean if a field has been set. + +### GetAuthType + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetAuthType() string` + +GetAuthType returns the AuthType field if non-nil, zero value otherwise. + +### GetAuthTypeOk + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetAuthTypeOk() (*string, bool)` + +GetAuthTypeOk returns a tuple with the AuthType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthType + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) SetAuthType(v string)` + +SetAuthType sets AuthType field to given value. + +### HasAuthType + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) HasAuthType() bool` + +HasAuthType returns a boolean if a field has been set. + +### GetUser + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetUser() string` + +GetUser returns the User field if non-nil, zero value otherwise. + +### GetUserOk + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetUserOk() (*string, bool)` + +GetUserOk returns a tuple with the User field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUser + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) SetUser(v string)` + +SetUser sets User field to given value. + +### HasUser + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) HasUser() bool` + +HasUser returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsCreate.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsCreate.md new file mode 100644 index 000000000..1102b819a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsCreate.md @@ -0,0 +1,272 @@ +--- +id: beta-multi-host-integrations-create +title: MultiHostIntegrationsCreate +pagination_label: MultiHostIntegrationsCreate +sidebar_label: MultiHostIntegrationsCreate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsCreate', 'BetaMultiHostIntegrationsCreate'] +slug: /tools/sdk/go/beta/models/multi-host-integrations-create +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreate', 'BetaMultiHostIntegrationsCreate'] +--- + +# MultiHostIntegrationsCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Multi-Host Integration's human-readable name. | +**Description** | **string** | Multi-Host Integration's human-readable description. | +**Owner** | [**MultiHostIntegrationsOwner**](multi-host-integrations-owner) | | +**Cluster** | Pointer to [**NullableMultiHostIntegrationsCluster**](multi-host-integrations-cluster) | | [optional] +**Connector** | **string** | Connector script name. | +**ConnectorAttributes** | Pointer to **map[string]interface{}** | Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc. | [optional] +**ManagementWorkgroup** | Pointer to [**NullableMultiHostIntegrationsManagementWorkgroup**](multi-host-integrations-management-workgroup) | | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date-time when the source was last modified. | [optional] + +## Methods + +### NewMultiHostIntegrationsCreate + +`func NewMultiHostIntegrationsCreate(name string, description string, owner MultiHostIntegrationsOwner, connector string, ) *MultiHostIntegrationsCreate` + +NewMultiHostIntegrationsCreate instantiates a new MultiHostIntegrationsCreate 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 + +### NewMultiHostIntegrationsCreateWithDefaults + +`func NewMultiHostIntegrationsCreateWithDefaults() *MultiHostIntegrationsCreate` + +NewMultiHostIntegrationsCreateWithDefaults instantiates a new MultiHostIntegrationsCreate 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 + +### GetName + +`func (o *MultiHostIntegrationsCreate) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrationsCreate) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrationsCreate) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *MultiHostIntegrationsCreate) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *MultiHostIntegrationsCreate) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *MultiHostIntegrationsCreate) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetOwner + +`func (o *MultiHostIntegrationsCreate) GetOwner() MultiHostIntegrationsOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *MultiHostIntegrationsCreate) GetOwnerOk() (*MultiHostIntegrationsOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *MultiHostIntegrationsCreate) SetOwner(v MultiHostIntegrationsOwner)` + +SetOwner sets Owner field to given value. + + +### GetCluster + +`func (o *MultiHostIntegrationsCreate) GetCluster() MultiHostIntegrationsCluster` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *MultiHostIntegrationsCreate) GetClusterOk() (*MultiHostIntegrationsCluster, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *MultiHostIntegrationsCreate) SetCluster(v MultiHostIntegrationsCluster)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *MultiHostIntegrationsCreate) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### SetClusterNil + +`func (o *MultiHostIntegrationsCreate) SetClusterNil(b bool)` + + SetClusterNil sets the value for Cluster to be an explicit nil + +### UnsetCluster +`func (o *MultiHostIntegrationsCreate) UnsetCluster()` + +UnsetCluster ensures that no value is present for Cluster, not even an explicit nil +### GetConnector + +`func (o *MultiHostIntegrationsCreate) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *MultiHostIntegrationsCreate) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *MultiHostIntegrationsCreate) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetConnectorAttributes + +`func (o *MultiHostIntegrationsCreate) GetConnectorAttributes() map[string]interface{}` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *MultiHostIntegrationsCreate) GetConnectorAttributesOk() (*map[string]interface{}, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *MultiHostIntegrationsCreate) SetConnectorAttributes(v map[string]interface{})` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + +### HasConnectorAttributes + +`func (o *MultiHostIntegrationsCreate) HasConnectorAttributes() bool` + +HasConnectorAttributes returns a boolean if a field has been set. + +### GetManagementWorkgroup + +`func (o *MultiHostIntegrationsCreate) GetManagementWorkgroup() MultiHostIntegrationsManagementWorkgroup` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *MultiHostIntegrationsCreate) GetManagementWorkgroupOk() (*MultiHostIntegrationsManagementWorkgroup, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *MultiHostIntegrationsCreate) SetManagementWorkgroup(v MultiHostIntegrationsManagementWorkgroup)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *MultiHostIntegrationsCreate) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### SetManagementWorkgroupNil + +`func (o *MultiHostIntegrationsCreate) SetManagementWorkgroupNil(b bool)` + + SetManagementWorkgroupNil sets the value for ManagementWorkgroup to be an explicit nil + +### UnsetManagementWorkgroup +`func (o *MultiHostIntegrationsCreate) UnsetManagementWorkgroup()` + +UnsetManagementWorkgroup ensures that no value is present for ManagementWorkgroup, not even an explicit nil +### GetCreated + +`func (o *MultiHostIntegrationsCreate) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MultiHostIntegrationsCreate) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MultiHostIntegrationsCreate) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MultiHostIntegrationsCreate) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MultiHostIntegrationsCreate) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MultiHostIntegrationsCreate) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MultiHostIntegrationsCreate) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MultiHostIntegrationsCreate) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsCreateSources.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsCreateSources.md new file mode 100644 index 000000000..48699de53 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsCreateSources.md @@ -0,0 +1,111 @@ +--- +id: beta-multi-host-integrations-create-sources +title: MultiHostIntegrationsCreateSources +pagination_label: MultiHostIntegrationsCreateSources +sidebar_label: MultiHostIntegrationsCreateSources +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsCreateSources', 'BetaMultiHostIntegrationsCreateSources'] +slug: /tools/sdk/go/beta/models/multi-host-integrations-create-sources +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreateSources', 'BetaMultiHostIntegrationsCreateSources'] +--- + +# MultiHostIntegrationsCreateSources + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Source's human-readable name. | +**Description** | Pointer to **string** | Source's human-readable description. | [optional] +**ConnectorAttributes** | Pointer to **map[string]interface{}** | Connector specific configuration. This configuration will differ from type to type. | [optional] + +## Methods + +### NewMultiHostIntegrationsCreateSources + +`func NewMultiHostIntegrationsCreateSources(name string, ) *MultiHostIntegrationsCreateSources` + +NewMultiHostIntegrationsCreateSources instantiates a new MultiHostIntegrationsCreateSources 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 + +### NewMultiHostIntegrationsCreateSourcesWithDefaults + +`func NewMultiHostIntegrationsCreateSourcesWithDefaults() *MultiHostIntegrationsCreateSources` + +NewMultiHostIntegrationsCreateSourcesWithDefaults instantiates a new MultiHostIntegrationsCreateSources 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 + +### GetName + +`func (o *MultiHostIntegrationsCreateSources) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrationsCreateSources) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrationsCreateSources) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *MultiHostIntegrationsCreateSources) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *MultiHostIntegrationsCreateSources) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *MultiHostIntegrationsCreateSources) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *MultiHostIntegrationsCreateSources) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetConnectorAttributes + +`func (o *MultiHostIntegrationsCreateSources) GetConnectorAttributes() map[string]interface{}` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *MultiHostIntegrationsCreateSources) GetConnectorAttributesOk() (*map[string]interface{}, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *MultiHostIntegrationsCreateSources) SetConnectorAttributes(v map[string]interface{})` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + +### HasConnectorAttributes + +`func (o *MultiHostIntegrationsCreateSources) HasConnectorAttributes() bool` + +HasConnectorAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsManagementWorkgroup.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsManagementWorkgroup.md new file mode 100644 index 000000000..bc5bf6b31 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsManagementWorkgroup.md @@ -0,0 +1,116 @@ +--- +id: beta-multi-host-integrations-management-workgroup +title: MultiHostIntegrationsManagementWorkgroup +pagination_label: MultiHostIntegrationsManagementWorkgroup +sidebar_label: MultiHostIntegrationsManagementWorkgroup +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsManagementWorkgroup', 'BetaMultiHostIntegrationsManagementWorkgroup'] +slug: /tools/sdk/go/beta/models/multi-host-integrations-management-workgroup +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsManagementWorkgroup', 'BetaMultiHostIntegrationsManagementWorkgroup'] +--- + +# MultiHostIntegrationsManagementWorkgroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Management workgroup ID. | [optional] +**Name** | Pointer to **string** | Management workgroup's human-readable display name. | [optional] + +## Methods + +### NewMultiHostIntegrationsManagementWorkgroup + +`func NewMultiHostIntegrationsManagementWorkgroup() *MultiHostIntegrationsManagementWorkgroup` + +NewMultiHostIntegrationsManagementWorkgroup instantiates a new MultiHostIntegrationsManagementWorkgroup 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 + +### NewMultiHostIntegrationsManagementWorkgroupWithDefaults + +`func NewMultiHostIntegrationsManagementWorkgroupWithDefaults() *MultiHostIntegrationsManagementWorkgroup` + +NewMultiHostIntegrationsManagementWorkgroupWithDefaults instantiates a new MultiHostIntegrationsManagementWorkgroup 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 + +### GetType + +`func (o *MultiHostIntegrationsManagementWorkgroup) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostIntegrationsManagementWorkgroup) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostIntegrationsManagementWorkgroup) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MultiHostIntegrationsManagementWorkgroup) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *MultiHostIntegrationsManagementWorkgroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostIntegrationsManagementWorkgroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostIntegrationsManagementWorkgroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *MultiHostIntegrationsManagementWorkgroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *MultiHostIntegrationsManagementWorkgroup) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrationsManagementWorkgroup) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrationsManagementWorkgroup) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MultiHostIntegrationsManagementWorkgroup) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsOwner.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsOwner.md new file mode 100644 index 000000000..57125d3e9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostIntegrationsOwner.md @@ -0,0 +1,116 @@ +--- +id: beta-multi-host-integrations-owner +title: MultiHostIntegrationsOwner +pagination_label: MultiHostIntegrationsOwner +sidebar_label: MultiHostIntegrationsOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsOwner', 'BetaMultiHostIntegrationsOwner'] +slug: /tools/sdk/go/beta/models/multi-host-integrations-owner +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsOwner', 'BetaMultiHostIntegrationsOwner'] +--- + +# MultiHostIntegrationsOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Owner identity's ID. | [optional] +**Name** | Pointer to **string** | Owner identity's human-readable display name. | [optional] + +## Methods + +### NewMultiHostIntegrationsOwner + +`func NewMultiHostIntegrationsOwner() *MultiHostIntegrationsOwner` + +NewMultiHostIntegrationsOwner instantiates a new MultiHostIntegrationsOwner 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 + +### NewMultiHostIntegrationsOwnerWithDefaults + +`func NewMultiHostIntegrationsOwnerWithDefaults() *MultiHostIntegrationsOwner` + +NewMultiHostIntegrationsOwnerWithDefaults instantiates a new MultiHostIntegrationsOwner 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 + +### GetType + +`func (o *MultiHostIntegrationsOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostIntegrationsOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostIntegrationsOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MultiHostIntegrationsOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *MultiHostIntegrationsOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostIntegrationsOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostIntegrationsOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *MultiHostIntegrationsOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *MultiHostIntegrationsOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrationsOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrationsOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MultiHostIntegrationsOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSources.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSources.md new file mode 100644 index 000000000..cd5d55109 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSources.md @@ -0,0 +1,909 @@ +--- +id: beta-multi-host-sources +title: MultiHostSources +pagination_label: MultiHostSources +sidebar_label: MultiHostSources +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostSources', 'BetaMultiHostSources'] +slug: /tools/sdk/go/beta/models/multi-host-sources +tags: ['SDK', 'Software Development Kit', 'MultiHostSources', 'BetaMultiHostSources'] +--- + +# MultiHostSources + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Source ID. | [readonly] +**Name** | **string** | Source's human-readable name. | +**Description** | Pointer to **string** | Source's human-readable description. | [optional] +**Owner** | [**MultiHostIntegrationsOwner**](multi-host-integrations-owner) | | +**Cluster** | Pointer to [**NullableMultiHostIntegrationsCluster**](multi-host-integrations-cluster) | | [optional] +**AccountCorrelationConfig** | Pointer to [**NullableMultiHostSourcesAccountCorrelationConfig**](multi-host-sources-account-correlation-config) | | [optional] +**AccountCorrelationRule** | Pointer to [**NullableMultiHostSourcesAccountCorrelationRule**](multi-host-sources-account-correlation-rule) | | [optional] +**ManagerCorrelationMapping** | Pointer to [**NullableManagerCorrelationMapping**](manager-correlation-mapping) | | [optional] +**ManagerCorrelationRule** | Pointer to [**NullableMultiHostSourcesManagerCorrelationRule**](multi-host-sources-manager-correlation-rule) | | [optional] +**BeforeProvisioningRule** | Pointer to [**NullableMultiHostSourcesBeforeProvisioningRule**](multi-host-sources-before-provisioning-rule) | | [optional] +**Schemas** | Pointer to [**[]MultiHostSourcesSchemasInner**](multi-host-sources-schemas-inner) | List of references to schema objects. | [optional] +**PasswordPolicies** | Pointer to [**[]MultiHostSourcesPasswordPoliciesInner**](multi-host-sources-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**Features** | Pointer to **[]string** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Type** | Pointer to **string** | Specifies the type of system being managed e.g. Multi-Host - Microsoft SQL Server, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Connector** | **string** | Connector script name. | +**ConnectorClass** | Pointer to **string** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**ConnectorAttributes** | Pointer to **map[string]interface{}** | Connector specific configuration. This configuration will differ from type to type. | [optional] +**DeleteThreshold** | Pointer to **int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**Authoritative** | Pointer to **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to false] +**ManagementWorkgroup** | Pointer to [**NullableMultiHostIntegrationsManagementWorkgroup**](multi-host-integrations-management-workgroup) | | [optional] +**Healthy** | Pointer to **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to false] +**Status** | Pointer to **string** | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**Since** | Pointer to **SailPointTime** | Timestamp that shows when a source health check was last performed. | [optional] +**ConnectorId** | Pointer to **string** | Connector ID | [optional] +**ConnectorName** | **string** | Name of the connector that was chosen during source creation. | +**ConnectionType** | Pointer to **string** | Type of connection (direct or file). | [optional] +**ConnectorImplementationId** | Pointer to **string** | Connector implementation ID. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date-time when the source was last modified. | [optional] +**CredentialProviderEnabled** | Pointer to **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to false] +**Category** | Pointer to **NullableString** | Source category (e.g. null, CredentialProvider). | [optional] + +## Methods + +### NewMultiHostSources + +`func NewMultiHostSources(id string, name string, owner MultiHostIntegrationsOwner, connector string, connectorName string, ) *MultiHostSources` + +NewMultiHostSources instantiates a new MultiHostSources 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 + +### NewMultiHostSourcesWithDefaults + +`func NewMultiHostSourcesWithDefaults() *MultiHostSources` + +NewMultiHostSourcesWithDefaults instantiates a new MultiHostSources 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 + +### GetId + +`func (o *MultiHostSources) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostSources) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostSources) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *MultiHostSources) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostSources) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostSources) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *MultiHostSources) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *MultiHostSources) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *MultiHostSources) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *MultiHostSources) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *MultiHostSources) GetOwner() MultiHostIntegrationsOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *MultiHostSources) GetOwnerOk() (*MultiHostIntegrationsOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *MultiHostSources) SetOwner(v MultiHostIntegrationsOwner)` + +SetOwner sets Owner field to given value. + + +### GetCluster + +`func (o *MultiHostSources) GetCluster() MultiHostIntegrationsCluster` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *MultiHostSources) GetClusterOk() (*MultiHostIntegrationsCluster, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *MultiHostSources) SetCluster(v MultiHostIntegrationsCluster)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *MultiHostSources) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### SetClusterNil + +`func (o *MultiHostSources) SetClusterNil(b bool)` + + SetClusterNil sets the value for Cluster to be an explicit nil + +### UnsetCluster +`func (o *MultiHostSources) UnsetCluster()` + +UnsetCluster ensures that no value is present for Cluster, not even an explicit nil +### GetAccountCorrelationConfig + +`func (o *MultiHostSources) GetAccountCorrelationConfig() MultiHostSourcesAccountCorrelationConfig` + +GetAccountCorrelationConfig returns the AccountCorrelationConfig field if non-nil, zero value otherwise. + +### GetAccountCorrelationConfigOk + +`func (o *MultiHostSources) GetAccountCorrelationConfigOk() (*MultiHostSourcesAccountCorrelationConfig, bool)` + +GetAccountCorrelationConfigOk returns a tuple with the AccountCorrelationConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationConfig + +`func (o *MultiHostSources) SetAccountCorrelationConfig(v MultiHostSourcesAccountCorrelationConfig)` + +SetAccountCorrelationConfig sets AccountCorrelationConfig field to given value. + +### HasAccountCorrelationConfig + +`func (o *MultiHostSources) HasAccountCorrelationConfig() bool` + +HasAccountCorrelationConfig returns a boolean if a field has been set. + +### SetAccountCorrelationConfigNil + +`func (o *MultiHostSources) SetAccountCorrelationConfigNil(b bool)` + + SetAccountCorrelationConfigNil sets the value for AccountCorrelationConfig to be an explicit nil + +### UnsetAccountCorrelationConfig +`func (o *MultiHostSources) UnsetAccountCorrelationConfig()` + +UnsetAccountCorrelationConfig ensures that no value is present for AccountCorrelationConfig, not even an explicit nil +### GetAccountCorrelationRule + +`func (o *MultiHostSources) GetAccountCorrelationRule() MultiHostSourcesAccountCorrelationRule` + +GetAccountCorrelationRule returns the AccountCorrelationRule field if non-nil, zero value otherwise. + +### GetAccountCorrelationRuleOk + +`func (o *MultiHostSources) GetAccountCorrelationRuleOk() (*MultiHostSourcesAccountCorrelationRule, bool)` + +GetAccountCorrelationRuleOk returns a tuple with the AccountCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationRule + +`func (o *MultiHostSources) SetAccountCorrelationRule(v MultiHostSourcesAccountCorrelationRule)` + +SetAccountCorrelationRule sets AccountCorrelationRule field to given value. + +### HasAccountCorrelationRule + +`func (o *MultiHostSources) HasAccountCorrelationRule() bool` + +HasAccountCorrelationRule returns a boolean if a field has been set. + +### SetAccountCorrelationRuleNil + +`func (o *MultiHostSources) SetAccountCorrelationRuleNil(b bool)` + + SetAccountCorrelationRuleNil sets the value for AccountCorrelationRule to be an explicit nil + +### UnsetAccountCorrelationRule +`func (o *MultiHostSources) UnsetAccountCorrelationRule()` + +UnsetAccountCorrelationRule ensures that no value is present for AccountCorrelationRule, not even an explicit nil +### GetManagerCorrelationMapping + +`func (o *MultiHostSources) GetManagerCorrelationMapping() ManagerCorrelationMapping` + +GetManagerCorrelationMapping returns the ManagerCorrelationMapping field if non-nil, zero value otherwise. + +### GetManagerCorrelationMappingOk + +`func (o *MultiHostSources) GetManagerCorrelationMappingOk() (*ManagerCorrelationMapping, bool)` + +GetManagerCorrelationMappingOk returns a tuple with the ManagerCorrelationMapping field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationMapping + +`func (o *MultiHostSources) SetManagerCorrelationMapping(v ManagerCorrelationMapping)` + +SetManagerCorrelationMapping sets ManagerCorrelationMapping field to given value. + +### HasManagerCorrelationMapping + +`func (o *MultiHostSources) HasManagerCorrelationMapping() bool` + +HasManagerCorrelationMapping returns a boolean if a field has been set. + +### SetManagerCorrelationMappingNil + +`func (o *MultiHostSources) SetManagerCorrelationMappingNil(b bool)` + + SetManagerCorrelationMappingNil sets the value for ManagerCorrelationMapping to be an explicit nil + +### UnsetManagerCorrelationMapping +`func (o *MultiHostSources) UnsetManagerCorrelationMapping()` + +UnsetManagerCorrelationMapping ensures that no value is present for ManagerCorrelationMapping, not even an explicit nil +### GetManagerCorrelationRule + +`func (o *MultiHostSources) GetManagerCorrelationRule() MultiHostSourcesManagerCorrelationRule` + +GetManagerCorrelationRule returns the ManagerCorrelationRule field if non-nil, zero value otherwise. + +### GetManagerCorrelationRuleOk + +`func (o *MultiHostSources) GetManagerCorrelationRuleOk() (*MultiHostSourcesManagerCorrelationRule, bool)` + +GetManagerCorrelationRuleOk returns a tuple with the ManagerCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationRule + +`func (o *MultiHostSources) SetManagerCorrelationRule(v MultiHostSourcesManagerCorrelationRule)` + +SetManagerCorrelationRule sets ManagerCorrelationRule field to given value. + +### HasManagerCorrelationRule + +`func (o *MultiHostSources) HasManagerCorrelationRule() bool` + +HasManagerCorrelationRule returns a boolean if a field has been set. + +### SetManagerCorrelationRuleNil + +`func (o *MultiHostSources) SetManagerCorrelationRuleNil(b bool)` + + SetManagerCorrelationRuleNil sets the value for ManagerCorrelationRule to be an explicit nil + +### UnsetManagerCorrelationRule +`func (o *MultiHostSources) UnsetManagerCorrelationRule()` + +UnsetManagerCorrelationRule ensures that no value is present for ManagerCorrelationRule, not even an explicit nil +### GetBeforeProvisioningRule + +`func (o *MultiHostSources) GetBeforeProvisioningRule() MultiHostSourcesBeforeProvisioningRule` + +GetBeforeProvisioningRule returns the BeforeProvisioningRule field if non-nil, zero value otherwise. + +### GetBeforeProvisioningRuleOk + +`func (o *MultiHostSources) GetBeforeProvisioningRuleOk() (*MultiHostSourcesBeforeProvisioningRule, bool)` + +GetBeforeProvisioningRuleOk returns a tuple with the BeforeProvisioningRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBeforeProvisioningRule + +`func (o *MultiHostSources) SetBeforeProvisioningRule(v MultiHostSourcesBeforeProvisioningRule)` + +SetBeforeProvisioningRule sets BeforeProvisioningRule field to given value. + +### HasBeforeProvisioningRule + +`func (o *MultiHostSources) HasBeforeProvisioningRule() bool` + +HasBeforeProvisioningRule returns a boolean if a field has been set. + +### SetBeforeProvisioningRuleNil + +`func (o *MultiHostSources) SetBeforeProvisioningRuleNil(b bool)` + + SetBeforeProvisioningRuleNil sets the value for BeforeProvisioningRule to be an explicit nil + +### UnsetBeforeProvisioningRule +`func (o *MultiHostSources) UnsetBeforeProvisioningRule()` + +UnsetBeforeProvisioningRule ensures that no value is present for BeforeProvisioningRule, not even an explicit nil +### GetSchemas + +`func (o *MultiHostSources) GetSchemas() []MultiHostSourcesSchemasInner` + +GetSchemas returns the Schemas field if non-nil, zero value otherwise. + +### GetSchemasOk + +`func (o *MultiHostSources) GetSchemasOk() (*[]MultiHostSourcesSchemasInner, bool)` + +GetSchemasOk returns a tuple with the Schemas field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchemas + +`func (o *MultiHostSources) SetSchemas(v []MultiHostSourcesSchemasInner)` + +SetSchemas sets Schemas field to given value. + +### HasSchemas + +`func (o *MultiHostSources) HasSchemas() bool` + +HasSchemas returns a boolean if a field has been set. + +### GetPasswordPolicies + +`func (o *MultiHostSources) GetPasswordPolicies() []MultiHostSourcesPasswordPoliciesInner` + +GetPasswordPolicies returns the PasswordPolicies field if non-nil, zero value otherwise. + +### GetPasswordPoliciesOk + +`func (o *MultiHostSources) GetPasswordPoliciesOk() (*[]MultiHostSourcesPasswordPoliciesInner, bool)` + +GetPasswordPoliciesOk returns a tuple with the PasswordPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicies + +`func (o *MultiHostSources) SetPasswordPolicies(v []MultiHostSourcesPasswordPoliciesInner)` + +SetPasswordPolicies sets PasswordPolicies field to given value. + +### HasPasswordPolicies + +`func (o *MultiHostSources) HasPasswordPolicies() bool` + +HasPasswordPolicies returns a boolean if a field has been set. + +### SetPasswordPoliciesNil + +`func (o *MultiHostSources) SetPasswordPoliciesNil(b bool)` + + SetPasswordPoliciesNil sets the value for PasswordPolicies to be an explicit nil + +### UnsetPasswordPolicies +`func (o *MultiHostSources) UnsetPasswordPolicies()` + +UnsetPasswordPolicies ensures that no value is present for PasswordPolicies, not even an explicit nil +### GetFeatures + +`func (o *MultiHostSources) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *MultiHostSources) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *MultiHostSources) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *MultiHostSources) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### GetType + +`func (o *MultiHostSources) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostSources) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostSources) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MultiHostSources) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConnector + +`func (o *MultiHostSources) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *MultiHostSources) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *MultiHostSources) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetConnectorClass + +`func (o *MultiHostSources) GetConnectorClass() string` + +GetConnectorClass returns the ConnectorClass field if non-nil, zero value otherwise. + +### GetConnectorClassOk + +`func (o *MultiHostSources) GetConnectorClassOk() (*string, bool)` + +GetConnectorClassOk returns a tuple with the ConnectorClass field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorClass + +`func (o *MultiHostSources) SetConnectorClass(v string)` + +SetConnectorClass sets ConnectorClass field to given value. + +### HasConnectorClass + +`func (o *MultiHostSources) HasConnectorClass() bool` + +HasConnectorClass returns a boolean if a field has been set. + +### GetConnectorAttributes + +`func (o *MultiHostSources) GetConnectorAttributes() map[string]interface{}` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *MultiHostSources) GetConnectorAttributesOk() (*map[string]interface{}, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *MultiHostSources) SetConnectorAttributes(v map[string]interface{})` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + +### HasConnectorAttributes + +`func (o *MultiHostSources) HasConnectorAttributes() bool` + +HasConnectorAttributes returns a boolean if a field has been set. + +### GetDeleteThreshold + +`func (o *MultiHostSources) GetDeleteThreshold() int32` + +GetDeleteThreshold returns the DeleteThreshold field if non-nil, zero value otherwise. + +### GetDeleteThresholdOk + +`func (o *MultiHostSources) GetDeleteThresholdOk() (*int32, bool)` + +GetDeleteThresholdOk returns a tuple with the DeleteThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteThreshold + +`func (o *MultiHostSources) SetDeleteThreshold(v int32)` + +SetDeleteThreshold sets DeleteThreshold field to given value. + +### HasDeleteThreshold + +`func (o *MultiHostSources) HasDeleteThreshold() bool` + +HasDeleteThreshold returns a boolean if a field has been set. + +### GetAuthoritative + +`func (o *MultiHostSources) GetAuthoritative() bool` + +GetAuthoritative returns the Authoritative field if non-nil, zero value otherwise. + +### GetAuthoritativeOk + +`func (o *MultiHostSources) GetAuthoritativeOk() (*bool, bool)` + +GetAuthoritativeOk returns a tuple with the Authoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritative + +`func (o *MultiHostSources) SetAuthoritative(v bool)` + +SetAuthoritative sets Authoritative field to given value. + +### HasAuthoritative + +`func (o *MultiHostSources) HasAuthoritative() bool` + +HasAuthoritative returns a boolean if a field has been set. + +### GetManagementWorkgroup + +`func (o *MultiHostSources) GetManagementWorkgroup() MultiHostIntegrationsManagementWorkgroup` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *MultiHostSources) GetManagementWorkgroupOk() (*MultiHostIntegrationsManagementWorkgroup, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *MultiHostSources) SetManagementWorkgroup(v MultiHostIntegrationsManagementWorkgroup)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *MultiHostSources) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### SetManagementWorkgroupNil + +`func (o *MultiHostSources) SetManagementWorkgroupNil(b bool)` + + SetManagementWorkgroupNil sets the value for ManagementWorkgroup to be an explicit nil + +### UnsetManagementWorkgroup +`func (o *MultiHostSources) UnsetManagementWorkgroup()` + +UnsetManagementWorkgroup ensures that no value is present for ManagementWorkgroup, not even an explicit nil +### GetHealthy + +`func (o *MultiHostSources) GetHealthy() bool` + +GetHealthy returns the Healthy field if non-nil, zero value otherwise. + +### GetHealthyOk + +`func (o *MultiHostSources) GetHealthyOk() (*bool, bool)` + +GetHealthyOk returns a tuple with the Healthy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthy + +`func (o *MultiHostSources) SetHealthy(v bool)` + +SetHealthy sets Healthy field to given value. + +### HasHealthy + +`func (o *MultiHostSources) HasHealthy() bool` + +HasHealthy returns a boolean if a field has been set. + +### GetStatus + +`func (o *MultiHostSources) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *MultiHostSources) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *MultiHostSources) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *MultiHostSources) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSince + +`func (o *MultiHostSources) GetSince() SailPointTime` + +GetSince returns the Since field if non-nil, zero value otherwise. + +### GetSinceOk + +`func (o *MultiHostSources) GetSinceOk() (*SailPointTime, bool)` + +GetSinceOk returns a tuple with the Since field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSince + +`func (o *MultiHostSources) SetSince(v SailPointTime)` + +SetSince sets Since field to given value. + +### HasSince + +`func (o *MultiHostSources) HasSince() bool` + +HasSince returns a boolean if a field has been set. + +### GetConnectorId + +`func (o *MultiHostSources) GetConnectorId() string` + +GetConnectorId returns the ConnectorId field if non-nil, zero value otherwise. + +### GetConnectorIdOk + +`func (o *MultiHostSources) GetConnectorIdOk() (*string, bool)` + +GetConnectorIdOk returns a tuple with the ConnectorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorId + +`func (o *MultiHostSources) SetConnectorId(v string)` + +SetConnectorId sets ConnectorId field to given value. + +### HasConnectorId + +`func (o *MultiHostSources) HasConnectorId() bool` + +HasConnectorId returns a boolean if a field has been set. + +### GetConnectorName + +`func (o *MultiHostSources) GetConnectorName() string` + +GetConnectorName returns the ConnectorName field if non-nil, zero value otherwise. + +### GetConnectorNameOk + +`func (o *MultiHostSources) GetConnectorNameOk() (*string, bool)` + +GetConnectorNameOk returns a tuple with the ConnectorName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorName + +`func (o *MultiHostSources) SetConnectorName(v string)` + +SetConnectorName sets ConnectorName field to given value. + + +### GetConnectionType + +`func (o *MultiHostSources) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *MultiHostSources) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *MultiHostSources) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *MultiHostSources) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + +### GetConnectorImplementationId + +`func (o *MultiHostSources) GetConnectorImplementationId() string` + +GetConnectorImplementationId returns the ConnectorImplementationId field if non-nil, zero value otherwise. + +### GetConnectorImplementationIdOk + +`func (o *MultiHostSources) GetConnectorImplementationIdOk() (*string, bool)` + +GetConnectorImplementationIdOk returns a tuple with the ConnectorImplementationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorImplementationId + +`func (o *MultiHostSources) SetConnectorImplementationId(v string)` + +SetConnectorImplementationId sets ConnectorImplementationId field to given value. + +### HasConnectorImplementationId + +`func (o *MultiHostSources) HasConnectorImplementationId() bool` + +HasConnectorImplementationId returns a boolean if a field has been set. + +### GetCreated + +`func (o *MultiHostSources) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MultiHostSources) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MultiHostSources) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MultiHostSources) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MultiHostSources) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MultiHostSources) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MultiHostSources) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MultiHostSources) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCredentialProviderEnabled + +`func (o *MultiHostSources) GetCredentialProviderEnabled() bool` + +GetCredentialProviderEnabled returns the CredentialProviderEnabled field if non-nil, zero value otherwise. + +### GetCredentialProviderEnabledOk + +`func (o *MultiHostSources) GetCredentialProviderEnabledOk() (*bool, bool)` + +GetCredentialProviderEnabledOk returns a tuple with the CredentialProviderEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialProviderEnabled + +`func (o *MultiHostSources) SetCredentialProviderEnabled(v bool)` + +SetCredentialProviderEnabled sets CredentialProviderEnabled field to given value. + +### HasCredentialProviderEnabled + +`func (o *MultiHostSources) HasCredentialProviderEnabled() bool` + +HasCredentialProviderEnabled returns a boolean if a field has been set. + +### GetCategory + +`func (o *MultiHostSources) GetCategory() string` + +GetCategory returns the Category field if non-nil, zero value otherwise. + +### GetCategoryOk + +`func (o *MultiHostSources) GetCategoryOk() (*string, bool)` + +GetCategoryOk returns a tuple with the Category field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCategory + +`func (o *MultiHostSources) SetCategory(v string)` + +SetCategory sets Category field to given value. + +### HasCategory + +`func (o *MultiHostSources) HasCategory() bool` + +HasCategory returns a boolean if a field has been set. + +### SetCategoryNil + +`func (o *MultiHostSources) SetCategoryNil(b bool)` + + SetCategoryNil sets the value for Category to be an explicit nil + +### UnsetCategory +`func (o *MultiHostSources) UnsetCategory()` + +UnsetCategory ensures that no value is present for Category, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesAccountCorrelationConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesAccountCorrelationConfig.md new file mode 100644 index 000000000..edf2cbc76 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesAccountCorrelationConfig.md @@ -0,0 +1,116 @@ +--- +id: beta-multi-host-sources-account-correlation-config +title: MultiHostSourcesAccountCorrelationConfig +pagination_label: MultiHostSourcesAccountCorrelationConfig +sidebar_label: MultiHostSourcesAccountCorrelationConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostSourcesAccountCorrelationConfig', 'BetaMultiHostSourcesAccountCorrelationConfig'] +slug: /tools/sdk/go/beta/models/multi-host-sources-account-correlation-config +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesAccountCorrelationConfig', 'BetaMultiHostSourcesAccountCorrelationConfig'] +--- + +# MultiHostSourcesAccountCorrelationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Account correlation config ID. | [optional] +**Name** | Pointer to **string** | Account correlation config's human-readable display name. | [optional] + +## Methods + +### NewMultiHostSourcesAccountCorrelationConfig + +`func NewMultiHostSourcesAccountCorrelationConfig() *MultiHostSourcesAccountCorrelationConfig` + +NewMultiHostSourcesAccountCorrelationConfig instantiates a new MultiHostSourcesAccountCorrelationConfig 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 + +### NewMultiHostSourcesAccountCorrelationConfigWithDefaults + +`func NewMultiHostSourcesAccountCorrelationConfigWithDefaults() *MultiHostSourcesAccountCorrelationConfig` + +NewMultiHostSourcesAccountCorrelationConfigWithDefaults instantiates a new MultiHostSourcesAccountCorrelationConfig 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 + +### GetType + +`func (o *MultiHostSourcesAccountCorrelationConfig) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostSourcesAccountCorrelationConfig) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostSourcesAccountCorrelationConfig) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MultiHostSourcesAccountCorrelationConfig) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *MultiHostSourcesAccountCorrelationConfig) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostSourcesAccountCorrelationConfig) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostSourcesAccountCorrelationConfig) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *MultiHostSourcesAccountCorrelationConfig) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *MultiHostSourcesAccountCorrelationConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostSourcesAccountCorrelationConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostSourcesAccountCorrelationConfig) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MultiHostSourcesAccountCorrelationConfig) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesAccountCorrelationRule.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesAccountCorrelationRule.md new file mode 100644 index 000000000..50d859539 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesAccountCorrelationRule.md @@ -0,0 +1,116 @@ +--- +id: beta-multi-host-sources-account-correlation-rule +title: MultiHostSourcesAccountCorrelationRule +pagination_label: MultiHostSourcesAccountCorrelationRule +sidebar_label: MultiHostSourcesAccountCorrelationRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostSourcesAccountCorrelationRule', 'BetaMultiHostSourcesAccountCorrelationRule'] +slug: /tools/sdk/go/beta/models/multi-host-sources-account-correlation-rule +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesAccountCorrelationRule', 'BetaMultiHostSourcesAccountCorrelationRule'] +--- + +# MultiHostSourcesAccountCorrelationRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Rule ID. | [optional] +**Name** | Pointer to **string** | Rule's human-readable display name. | [optional] + +## Methods + +### NewMultiHostSourcesAccountCorrelationRule + +`func NewMultiHostSourcesAccountCorrelationRule() *MultiHostSourcesAccountCorrelationRule` + +NewMultiHostSourcesAccountCorrelationRule instantiates a new MultiHostSourcesAccountCorrelationRule 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 + +### NewMultiHostSourcesAccountCorrelationRuleWithDefaults + +`func NewMultiHostSourcesAccountCorrelationRuleWithDefaults() *MultiHostSourcesAccountCorrelationRule` + +NewMultiHostSourcesAccountCorrelationRuleWithDefaults instantiates a new MultiHostSourcesAccountCorrelationRule 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 + +### GetType + +`func (o *MultiHostSourcesAccountCorrelationRule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostSourcesAccountCorrelationRule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostSourcesAccountCorrelationRule) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MultiHostSourcesAccountCorrelationRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *MultiHostSourcesAccountCorrelationRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostSourcesAccountCorrelationRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostSourcesAccountCorrelationRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *MultiHostSourcesAccountCorrelationRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *MultiHostSourcesAccountCorrelationRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostSourcesAccountCorrelationRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostSourcesAccountCorrelationRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MultiHostSourcesAccountCorrelationRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesBeforeProvisioningRule.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesBeforeProvisioningRule.md new file mode 100644 index 000000000..679c2c460 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesBeforeProvisioningRule.md @@ -0,0 +1,116 @@ +--- +id: beta-multi-host-sources-before-provisioning-rule +title: MultiHostSourcesBeforeProvisioningRule +pagination_label: MultiHostSourcesBeforeProvisioningRule +sidebar_label: MultiHostSourcesBeforeProvisioningRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostSourcesBeforeProvisioningRule', 'BetaMultiHostSourcesBeforeProvisioningRule'] +slug: /tools/sdk/go/beta/models/multi-host-sources-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesBeforeProvisioningRule', 'BetaMultiHostSourcesBeforeProvisioningRule'] +--- + +# MultiHostSourcesBeforeProvisioningRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Rule ID. | [optional] +**Name** | Pointer to **string** | Rule's human-readable display name. | [optional] + +## Methods + +### NewMultiHostSourcesBeforeProvisioningRule + +`func NewMultiHostSourcesBeforeProvisioningRule() *MultiHostSourcesBeforeProvisioningRule` + +NewMultiHostSourcesBeforeProvisioningRule instantiates a new MultiHostSourcesBeforeProvisioningRule 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 + +### NewMultiHostSourcesBeforeProvisioningRuleWithDefaults + +`func NewMultiHostSourcesBeforeProvisioningRuleWithDefaults() *MultiHostSourcesBeforeProvisioningRule` + +NewMultiHostSourcesBeforeProvisioningRuleWithDefaults instantiates a new MultiHostSourcesBeforeProvisioningRule 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 + +### GetType + +`func (o *MultiHostSourcesBeforeProvisioningRule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostSourcesBeforeProvisioningRule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostSourcesBeforeProvisioningRule) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MultiHostSourcesBeforeProvisioningRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *MultiHostSourcesBeforeProvisioningRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostSourcesBeforeProvisioningRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostSourcesBeforeProvisioningRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *MultiHostSourcesBeforeProvisioningRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *MultiHostSourcesBeforeProvisioningRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostSourcesBeforeProvisioningRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostSourcesBeforeProvisioningRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MultiHostSourcesBeforeProvisioningRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesManagerCorrelationRule.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesManagerCorrelationRule.md new file mode 100644 index 000000000..c4e3f5b0d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesManagerCorrelationRule.md @@ -0,0 +1,116 @@ +--- +id: beta-multi-host-sources-manager-correlation-rule +title: MultiHostSourcesManagerCorrelationRule +pagination_label: MultiHostSourcesManagerCorrelationRule +sidebar_label: MultiHostSourcesManagerCorrelationRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostSourcesManagerCorrelationRule', 'BetaMultiHostSourcesManagerCorrelationRule'] +slug: /tools/sdk/go/beta/models/multi-host-sources-manager-correlation-rule +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesManagerCorrelationRule', 'BetaMultiHostSourcesManagerCorrelationRule'] +--- + +# MultiHostSourcesManagerCorrelationRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Rule ID. | [optional] +**Name** | Pointer to **string** | Rule's human-readable display name. | [optional] + +## Methods + +### NewMultiHostSourcesManagerCorrelationRule + +`func NewMultiHostSourcesManagerCorrelationRule() *MultiHostSourcesManagerCorrelationRule` + +NewMultiHostSourcesManagerCorrelationRule instantiates a new MultiHostSourcesManagerCorrelationRule 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 + +### NewMultiHostSourcesManagerCorrelationRuleWithDefaults + +`func NewMultiHostSourcesManagerCorrelationRuleWithDefaults() *MultiHostSourcesManagerCorrelationRule` + +NewMultiHostSourcesManagerCorrelationRuleWithDefaults instantiates a new MultiHostSourcesManagerCorrelationRule 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 + +### GetType + +`func (o *MultiHostSourcesManagerCorrelationRule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostSourcesManagerCorrelationRule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostSourcesManagerCorrelationRule) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MultiHostSourcesManagerCorrelationRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *MultiHostSourcesManagerCorrelationRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostSourcesManagerCorrelationRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostSourcesManagerCorrelationRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *MultiHostSourcesManagerCorrelationRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *MultiHostSourcesManagerCorrelationRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostSourcesManagerCorrelationRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostSourcesManagerCorrelationRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MultiHostSourcesManagerCorrelationRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesPasswordPoliciesInner.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesPasswordPoliciesInner.md new file mode 100644 index 000000000..6786a00c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesPasswordPoliciesInner.md @@ -0,0 +1,116 @@ +--- +id: beta-multi-host-sources-password-policies-inner +title: MultiHostSourcesPasswordPoliciesInner +pagination_label: MultiHostSourcesPasswordPoliciesInner +sidebar_label: MultiHostSourcesPasswordPoliciesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostSourcesPasswordPoliciesInner', 'BetaMultiHostSourcesPasswordPoliciesInner'] +slug: /tools/sdk/go/beta/models/multi-host-sources-password-policies-inner +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesPasswordPoliciesInner', 'BetaMultiHostSourcesPasswordPoliciesInner'] +--- + +# MultiHostSourcesPasswordPoliciesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Policy ID. | [optional] +**Name** | Pointer to **string** | Policy's human-readable display name. | [optional] + +## Methods + +### NewMultiHostSourcesPasswordPoliciesInner + +`func NewMultiHostSourcesPasswordPoliciesInner() *MultiHostSourcesPasswordPoliciesInner` + +NewMultiHostSourcesPasswordPoliciesInner instantiates a new MultiHostSourcesPasswordPoliciesInner 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 + +### NewMultiHostSourcesPasswordPoliciesInnerWithDefaults + +`func NewMultiHostSourcesPasswordPoliciesInnerWithDefaults() *MultiHostSourcesPasswordPoliciesInner` + +NewMultiHostSourcesPasswordPoliciesInnerWithDefaults instantiates a new MultiHostSourcesPasswordPoliciesInner 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 + +### GetType + +`func (o *MultiHostSourcesPasswordPoliciesInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostSourcesPasswordPoliciesInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostSourcesPasswordPoliciesInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MultiHostSourcesPasswordPoliciesInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *MultiHostSourcesPasswordPoliciesInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostSourcesPasswordPoliciesInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostSourcesPasswordPoliciesInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *MultiHostSourcesPasswordPoliciesInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *MultiHostSourcesPasswordPoliciesInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostSourcesPasswordPoliciesInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostSourcesPasswordPoliciesInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MultiHostSourcesPasswordPoliciesInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesSchemasInner.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesSchemasInner.md new file mode 100644 index 000000000..9f5531174 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiHostSourcesSchemasInner.md @@ -0,0 +1,116 @@ +--- +id: beta-multi-host-sources-schemas-inner +title: MultiHostSourcesSchemasInner +pagination_label: MultiHostSourcesSchemasInner +sidebar_label: MultiHostSourcesSchemasInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostSourcesSchemasInner', 'BetaMultiHostSourcesSchemasInner'] +slug: /tools/sdk/go/beta/models/multi-host-sources-schemas-inner +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesSchemasInner', 'BetaMultiHostSourcesSchemasInner'] +--- + +# MultiHostSourcesSchemasInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Schema ID. | [optional] +**Name** | Pointer to **string** | Schema's human-readable display name. | [optional] + +## Methods + +### NewMultiHostSourcesSchemasInner + +`func NewMultiHostSourcesSchemasInner() *MultiHostSourcesSchemasInner` + +NewMultiHostSourcesSchemasInner instantiates a new MultiHostSourcesSchemasInner 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 + +### NewMultiHostSourcesSchemasInnerWithDefaults + +`func NewMultiHostSourcesSchemasInnerWithDefaults() *MultiHostSourcesSchemasInner` + +NewMultiHostSourcesSchemasInnerWithDefaults instantiates a new MultiHostSourcesSchemasInner 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 + +### GetType + +`func (o *MultiHostSourcesSchemasInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostSourcesSchemasInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostSourcesSchemasInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MultiHostSourcesSchemasInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *MultiHostSourcesSchemasInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostSourcesSchemasInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostSourcesSchemasInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *MultiHostSourcesSchemasInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *MultiHostSourcesSchemasInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostSourcesSchemasInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostSourcesSchemasInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MultiHostSourcesSchemasInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/MultiPolicyRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/MultiPolicyRequest.md new file mode 100644 index 000000000..756e38d9a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/MultiPolicyRequest.md @@ -0,0 +1,64 @@ +--- +id: beta-multi-policy-request +title: MultiPolicyRequest +pagination_label: MultiPolicyRequest +sidebar_label: MultiPolicyRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiPolicyRequest', 'BetaMultiPolicyRequest'] +slug: /tools/sdk/go/beta/models/multi-policy-request +tags: ['SDK', 'Software Development Kit', 'MultiPolicyRequest', 'BetaMultiPolicyRequest'] +--- + +# MultiPolicyRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FilteredPolicyList** | Pointer to **[]string** | Multi-policy report will be run for this list of ids | [optional] + +## Methods + +### NewMultiPolicyRequest + +`func NewMultiPolicyRequest() *MultiPolicyRequest` + +NewMultiPolicyRequest instantiates a new MultiPolicyRequest 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 + +### NewMultiPolicyRequestWithDefaults + +`func NewMultiPolicyRequestWithDefaults() *MultiPolicyRequest` + +NewMultiPolicyRequestWithDefaults instantiates a new MultiPolicyRequest 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 + +### GetFilteredPolicyList + +`func (o *MultiPolicyRequest) GetFilteredPolicyList() []string` + +GetFilteredPolicyList returns the FilteredPolicyList field if non-nil, zero value otherwise. + +### GetFilteredPolicyListOk + +`func (o *MultiPolicyRequest) GetFilteredPolicyListOk() (*[]string, bool)` + +GetFilteredPolicyListOk returns a tuple with the FilteredPolicyList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilteredPolicyList + +`func (o *MultiPolicyRequest) SetFilteredPolicyList(v []string)` + +SetFilteredPolicyList sets FilteredPolicyList field to given value. + +### HasFilteredPolicyList + +`func (o *MultiPolicyRequest) HasFilteredPolicyList() bool` + +HasFilteredPolicyList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NativeChangeDetectionConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/NativeChangeDetectionConfig.md new file mode 100644 index 000000000..4780c6e39 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NativeChangeDetectionConfig.md @@ -0,0 +1,194 @@ +--- +id: beta-native-change-detection-config +title: NativeChangeDetectionConfig +pagination_label: NativeChangeDetectionConfig +sidebar_label: NativeChangeDetectionConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NativeChangeDetectionConfig', 'BetaNativeChangeDetectionConfig'] +slug: /tools/sdk/go/beta/models/native-change-detection-config +tags: ['SDK', 'Software Development Kit', 'NativeChangeDetectionConfig', 'BetaNativeChangeDetectionConfig'] +--- + +# NativeChangeDetectionConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | A flag indicating if Native Change Detection is enabled for a source. | [optional] [default to false] +**Operations** | Pointer to **[]string** | Operation types for which Native Change Detection is enabled for a source. | [optional] +**AllEntitlements** | Pointer to **bool** | A flag indicating that all entitlements participate in Native Change Detection. | [optional] [default to false] +**AllNonEntitlementAttributes** | Pointer to **bool** | A flag indicating that all non-entitlement account attributes participate in Native Change Detection. | [optional] [default to false] +**SelectedEntitlements** | Pointer to **[]string** | If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection. | [optional] +**SelectedNonEntitlementAttributes** | Pointer to **[]string** | If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection. | [optional] + +## Methods + +### NewNativeChangeDetectionConfig + +`func NewNativeChangeDetectionConfig() *NativeChangeDetectionConfig` + +NewNativeChangeDetectionConfig instantiates a new NativeChangeDetectionConfig 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 + +### NewNativeChangeDetectionConfigWithDefaults + +`func NewNativeChangeDetectionConfigWithDefaults() *NativeChangeDetectionConfig` + +NewNativeChangeDetectionConfigWithDefaults instantiates a new NativeChangeDetectionConfig 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 + +### GetEnabled + +`func (o *NativeChangeDetectionConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *NativeChangeDetectionConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *NativeChangeDetectionConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *NativeChangeDetectionConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetOperations + +`func (o *NativeChangeDetectionConfig) GetOperations() []string` + +GetOperations returns the Operations field if non-nil, zero value otherwise. + +### GetOperationsOk + +`func (o *NativeChangeDetectionConfig) GetOperationsOk() (*[]string, bool)` + +GetOperationsOk returns a tuple with the Operations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperations + +`func (o *NativeChangeDetectionConfig) SetOperations(v []string)` + +SetOperations sets Operations field to given value. + +### HasOperations + +`func (o *NativeChangeDetectionConfig) HasOperations() bool` + +HasOperations returns a boolean if a field has been set. + +### GetAllEntitlements + +`func (o *NativeChangeDetectionConfig) GetAllEntitlements() bool` + +GetAllEntitlements returns the AllEntitlements field if non-nil, zero value otherwise. + +### GetAllEntitlementsOk + +`func (o *NativeChangeDetectionConfig) GetAllEntitlementsOk() (*bool, bool)` + +GetAllEntitlementsOk returns a tuple with the AllEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllEntitlements + +`func (o *NativeChangeDetectionConfig) SetAllEntitlements(v bool)` + +SetAllEntitlements sets AllEntitlements field to given value. + +### HasAllEntitlements + +`func (o *NativeChangeDetectionConfig) HasAllEntitlements() bool` + +HasAllEntitlements returns a boolean if a field has been set. + +### GetAllNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) GetAllNonEntitlementAttributes() bool` + +GetAllNonEntitlementAttributes returns the AllNonEntitlementAttributes field if non-nil, zero value otherwise. + +### GetAllNonEntitlementAttributesOk + +`func (o *NativeChangeDetectionConfig) GetAllNonEntitlementAttributesOk() (*bool, bool)` + +GetAllNonEntitlementAttributesOk returns a tuple with the AllNonEntitlementAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) SetAllNonEntitlementAttributes(v bool)` + +SetAllNonEntitlementAttributes sets AllNonEntitlementAttributes field to given value. + +### HasAllNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) HasAllNonEntitlementAttributes() bool` + +HasAllNonEntitlementAttributes returns a boolean if a field has been set. + +### GetSelectedEntitlements + +`func (o *NativeChangeDetectionConfig) GetSelectedEntitlements() []string` + +GetSelectedEntitlements returns the SelectedEntitlements field if non-nil, zero value otherwise. + +### GetSelectedEntitlementsOk + +`func (o *NativeChangeDetectionConfig) GetSelectedEntitlementsOk() (*[]string, bool)` + +GetSelectedEntitlementsOk returns a tuple with the SelectedEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectedEntitlements + +`func (o *NativeChangeDetectionConfig) SetSelectedEntitlements(v []string)` + +SetSelectedEntitlements sets SelectedEntitlements field to given value. + +### HasSelectedEntitlements + +`func (o *NativeChangeDetectionConfig) HasSelectedEntitlements() bool` + +HasSelectedEntitlements returns a boolean if a field has been set. + +### GetSelectedNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) GetSelectedNonEntitlementAttributes() []string` + +GetSelectedNonEntitlementAttributes returns the SelectedNonEntitlementAttributes field if non-nil, zero value otherwise. + +### GetSelectedNonEntitlementAttributesOk + +`func (o *NativeChangeDetectionConfig) GetSelectedNonEntitlementAttributesOk() (*[]string, bool)` + +GetSelectedNonEntitlementAttributesOk returns a tuple with the SelectedNonEntitlementAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectedNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) SetSelectedNonEntitlementAttributes(v []string)` + +SetSelectedNonEntitlementAttributes sets SelectedNonEntitlementAttributes field to given value. + +### HasSelectedNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) HasSelectedNonEntitlementAttributes() bool` + +HasSelectedNonEntitlementAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeApprovalDecision.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeApprovalDecision.md new file mode 100644 index 000000000..8ed36043c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeApprovalDecision.md @@ -0,0 +1,64 @@ +--- +id: beta-non-employee-approval-decision +title: NonEmployeeApprovalDecision +pagination_label: NonEmployeeApprovalDecision +sidebar_label: NonEmployeeApprovalDecision +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalDecision', 'BetaNonEmployeeApprovalDecision'] +slug: /tools/sdk/go/beta/models/non-employee-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalDecision', 'BetaNonEmployeeApprovalDecision'] +--- + +# NonEmployeeApprovalDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment on the approval item. | [optional] + +## Methods + +### NewNonEmployeeApprovalDecision + +`func NewNonEmployeeApprovalDecision() *NonEmployeeApprovalDecision` + +NewNonEmployeeApprovalDecision instantiates a new NonEmployeeApprovalDecision 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 + +### NewNonEmployeeApprovalDecisionWithDefaults + +`func NewNonEmployeeApprovalDecisionWithDefaults() *NonEmployeeApprovalDecision` + +NewNonEmployeeApprovalDecisionWithDefaults instantiates a new NonEmployeeApprovalDecision 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 + +### GetComment + +`func (o *NonEmployeeApprovalDecision) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeApprovalDecision) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeApprovalDecision) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeApprovalDecision) HasComment() bool` + +HasComment returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeApprovalItem.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeApprovalItem.md new file mode 100644 index 000000000..203b47ee8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeApprovalItem.md @@ -0,0 +1,272 @@ +--- +id: beta-non-employee-approval-item +title: NonEmployeeApprovalItem +pagination_label: NonEmployeeApprovalItem +sidebar_label: NonEmployeeApprovalItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalItem', 'BetaNonEmployeeApprovalItem'] +slug: /tools/sdk/go/beta/models/non-employee-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItem', 'BetaNonEmployeeApprovalItem'] +--- + +# NonEmployeeApprovalItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **string** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **float32** | Approval order | [optional] +**Comment** | Pointer to **string** | comment of approver | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestLite**](non-employee-request-lite) | | [optional] + +## Methods + +### NewNonEmployeeApprovalItem + +`func NewNonEmployeeApprovalItem() *NonEmployeeApprovalItem` + +NewNonEmployeeApprovalItem instantiates a new NonEmployeeApprovalItem 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 + +### NewNonEmployeeApprovalItemWithDefaults + +`func NewNonEmployeeApprovalItemWithDefaults() *NonEmployeeApprovalItem` + +NewNonEmployeeApprovalItemWithDefaults instantiates a new NonEmployeeApprovalItem 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 + +### GetId + +`func (o *NonEmployeeApprovalItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeApprovalItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeApprovalItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeApprovalItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetApprover + +`func (o *NonEmployeeApprovalItem) GetApprover() IdentityReferenceWithId` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *NonEmployeeApprovalItem) GetApproverOk() (*IdentityReferenceWithId, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *NonEmployeeApprovalItem) SetApprover(v IdentityReferenceWithId)` + +SetApprover sets Approver field to given value. + +### HasApprover + +`func (o *NonEmployeeApprovalItem) HasApprover() bool` + +HasApprover returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeApprovalItem) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeApprovalItem) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeApprovalItem) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeApprovalItem) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeApprovalItem) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeApprovalItem) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeApprovalItem) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeApprovalItem) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetApprovalOrder + +`func (o *NonEmployeeApprovalItem) GetApprovalOrder() float32` + +GetApprovalOrder returns the ApprovalOrder field if non-nil, zero value otherwise. + +### GetApprovalOrderOk + +`func (o *NonEmployeeApprovalItem) GetApprovalOrderOk() (*float32, bool)` + +GetApprovalOrderOk returns a tuple with the ApprovalOrder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalOrder + +`func (o *NonEmployeeApprovalItem) SetApprovalOrder(v float32)` + +SetApprovalOrder sets ApprovalOrder field to given value. + +### HasApprovalOrder + +`func (o *NonEmployeeApprovalItem) HasApprovalOrder() bool` + +HasApprovalOrder returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeApprovalItem) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeApprovalItem) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeApprovalItem) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeApprovalItem) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeApprovalItem) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeApprovalItem) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeApprovalItem) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeApprovalItem) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeApprovalItem) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeApprovalItem) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeApprovalItem) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeApprovalItem) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetNonEmployeeRequest + +`func (o *NonEmployeeApprovalItem) GetNonEmployeeRequest() NonEmployeeRequestLite` + +GetNonEmployeeRequest returns the NonEmployeeRequest field if non-nil, zero value otherwise. + +### GetNonEmployeeRequestOk + +`func (o *NonEmployeeApprovalItem) GetNonEmployeeRequestOk() (*NonEmployeeRequestLite, bool)` + +GetNonEmployeeRequestOk returns a tuple with the NonEmployeeRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeRequest + +`func (o *NonEmployeeApprovalItem) SetNonEmployeeRequest(v NonEmployeeRequestLite)` + +SetNonEmployeeRequest sets NonEmployeeRequest field to given value. + +### HasNonEmployeeRequest + +`func (o *NonEmployeeApprovalItem) HasNonEmployeeRequest() bool` + +HasNonEmployeeRequest returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeApprovalItemBase.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeApprovalItemBase.md new file mode 100644 index 000000000..3f143155f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeApprovalItemBase.md @@ -0,0 +1,246 @@ +--- +id: beta-non-employee-approval-item-base +title: NonEmployeeApprovalItemBase +pagination_label: NonEmployeeApprovalItemBase +sidebar_label: NonEmployeeApprovalItemBase +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalItemBase', 'BetaNonEmployeeApprovalItemBase'] +slug: /tools/sdk/go/beta/models/non-employee-approval-item-base +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemBase', 'BetaNonEmployeeApprovalItemBase'] +--- + +# NonEmployeeApprovalItemBase + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **string** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **float32** | Approval order | [optional] +**Comment** | Pointer to **string** | comment of approver | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeApprovalItemBase + +`func NewNonEmployeeApprovalItemBase() *NonEmployeeApprovalItemBase` + +NewNonEmployeeApprovalItemBase instantiates a new NonEmployeeApprovalItemBase 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 + +### NewNonEmployeeApprovalItemBaseWithDefaults + +`func NewNonEmployeeApprovalItemBaseWithDefaults() *NonEmployeeApprovalItemBase` + +NewNonEmployeeApprovalItemBaseWithDefaults instantiates a new NonEmployeeApprovalItemBase 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 + +### GetId + +`func (o *NonEmployeeApprovalItemBase) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeApprovalItemBase) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeApprovalItemBase) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeApprovalItemBase) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetApprover + +`func (o *NonEmployeeApprovalItemBase) GetApprover() IdentityReferenceWithId` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *NonEmployeeApprovalItemBase) GetApproverOk() (*IdentityReferenceWithId, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *NonEmployeeApprovalItemBase) SetApprover(v IdentityReferenceWithId)` + +SetApprover sets Approver field to given value. + +### HasApprover + +`func (o *NonEmployeeApprovalItemBase) HasApprover() bool` + +HasApprover returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeApprovalItemBase) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeApprovalItemBase) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeApprovalItemBase) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeApprovalItemBase) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeApprovalItemBase) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeApprovalItemBase) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeApprovalItemBase) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeApprovalItemBase) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetApprovalOrder + +`func (o *NonEmployeeApprovalItemBase) GetApprovalOrder() float32` + +GetApprovalOrder returns the ApprovalOrder field if non-nil, zero value otherwise. + +### GetApprovalOrderOk + +`func (o *NonEmployeeApprovalItemBase) GetApprovalOrderOk() (*float32, bool)` + +GetApprovalOrderOk returns a tuple with the ApprovalOrder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalOrder + +`func (o *NonEmployeeApprovalItemBase) SetApprovalOrder(v float32)` + +SetApprovalOrder sets ApprovalOrder field to given value. + +### HasApprovalOrder + +`func (o *NonEmployeeApprovalItemBase) HasApprovalOrder() bool` + +HasApprovalOrder returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeApprovalItemBase) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeApprovalItemBase) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeApprovalItemBase) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeApprovalItemBase) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeApprovalItemBase) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeApprovalItemBase) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeApprovalItemBase) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeApprovalItemBase) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeApprovalItemBase) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeApprovalItemBase) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeApprovalItemBase) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeApprovalItemBase) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeApprovalItemDetail.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeApprovalItemDetail.md new file mode 100644 index 000000000..9e469ff7d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeApprovalItemDetail.md @@ -0,0 +1,272 @@ +--- +id: beta-non-employee-approval-item-detail +title: NonEmployeeApprovalItemDetail +pagination_label: NonEmployeeApprovalItemDetail +sidebar_label: NonEmployeeApprovalItemDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalItemDetail', 'BetaNonEmployeeApprovalItemDetail'] +slug: /tools/sdk/go/beta/models/non-employee-approval-item-detail +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemDetail', 'BetaNonEmployeeApprovalItemDetail'] +--- + +# NonEmployeeApprovalItemDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **string** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **float32** | Approval order | [optional] +**Comment** | Pointer to **string** | comment of approver | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestWithoutApprovalItem**](non-employee-request-without-approval-item) | | [optional] + +## Methods + +### NewNonEmployeeApprovalItemDetail + +`func NewNonEmployeeApprovalItemDetail() *NonEmployeeApprovalItemDetail` + +NewNonEmployeeApprovalItemDetail instantiates a new NonEmployeeApprovalItemDetail 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 + +### NewNonEmployeeApprovalItemDetailWithDefaults + +`func NewNonEmployeeApprovalItemDetailWithDefaults() *NonEmployeeApprovalItemDetail` + +NewNonEmployeeApprovalItemDetailWithDefaults instantiates a new NonEmployeeApprovalItemDetail 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 + +### GetId + +`func (o *NonEmployeeApprovalItemDetail) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeApprovalItemDetail) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeApprovalItemDetail) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeApprovalItemDetail) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetApprover + +`func (o *NonEmployeeApprovalItemDetail) GetApprover() IdentityReferenceWithId` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *NonEmployeeApprovalItemDetail) GetApproverOk() (*IdentityReferenceWithId, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *NonEmployeeApprovalItemDetail) SetApprover(v IdentityReferenceWithId)` + +SetApprover sets Approver field to given value. + +### HasApprover + +`func (o *NonEmployeeApprovalItemDetail) HasApprover() bool` + +HasApprover returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeApprovalItemDetail) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeApprovalItemDetail) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeApprovalItemDetail) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeApprovalItemDetail) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeApprovalItemDetail) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeApprovalItemDetail) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeApprovalItemDetail) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeApprovalItemDetail) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetApprovalOrder + +`func (o *NonEmployeeApprovalItemDetail) GetApprovalOrder() float32` + +GetApprovalOrder returns the ApprovalOrder field if non-nil, zero value otherwise. + +### GetApprovalOrderOk + +`func (o *NonEmployeeApprovalItemDetail) GetApprovalOrderOk() (*float32, bool)` + +GetApprovalOrderOk returns a tuple with the ApprovalOrder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalOrder + +`func (o *NonEmployeeApprovalItemDetail) SetApprovalOrder(v float32)` + +SetApprovalOrder sets ApprovalOrder field to given value. + +### HasApprovalOrder + +`func (o *NonEmployeeApprovalItemDetail) HasApprovalOrder() bool` + +HasApprovalOrder returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeApprovalItemDetail) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeApprovalItemDetail) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeApprovalItemDetail) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeApprovalItemDetail) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeApprovalItemDetail) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeApprovalItemDetail) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeApprovalItemDetail) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeApprovalItemDetail) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeApprovalItemDetail) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeApprovalItemDetail) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeApprovalItemDetail) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeApprovalItemDetail) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetNonEmployeeRequest + +`func (o *NonEmployeeApprovalItemDetail) GetNonEmployeeRequest() NonEmployeeRequestWithoutApprovalItem` + +GetNonEmployeeRequest returns the NonEmployeeRequest field if non-nil, zero value otherwise. + +### GetNonEmployeeRequestOk + +`func (o *NonEmployeeApprovalItemDetail) GetNonEmployeeRequestOk() (*NonEmployeeRequestWithoutApprovalItem, bool)` + +GetNonEmployeeRequestOk returns a tuple with the NonEmployeeRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeRequest + +`func (o *NonEmployeeApprovalItemDetail) SetNonEmployeeRequest(v NonEmployeeRequestWithoutApprovalItem)` + +SetNonEmployeeRequest sets NonEmployeeRequest field to given value. + +### HasNonEmployeeRequest + +`func (o *NonEmployeeApprovalItemDetail) HasNonEmployeeRequest() bool` + +HasNonEmployeeRequest returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeApprovalSummary.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeApprovalSummary.md new file mode 100644 index 000000000..f79a3db11 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeApprovalSummary.md @@ -0,0 +1,116 @@ +--- +id: beta-non-employee-approval-summary +title: NonEmployeeApprovalSummary +pagination_label: NonEmployeeApprovalSummary +sidebar_label: NonEmployeeApprovalSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalSummary', 'BetaNonEmployeeApprovalSummary'] +slug: /tools/sdk/go/beta/models/non-employee-approval-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalSummary', 'BetaNonEmployeeApprovalSummary'] +--- + +# NonEmployeeApprovalSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | Pointer to **float32** | The number of approved non-employee approval requests. | [optional] +**Pending** | Pointer to **float32** | The number of pending non-employee approval requests. | [optional] +**Rejected** | Pointer to **float32** | The number of rejected non-employee approval requests. | [optional] + +## Methods + +### NewNonEmployeeApprovalSummary + +`func NewNonEmployeeApprovalSummary() *NonEmployeeApprovalSummary` + +NewNonEmployeeApprovalSummary instantiates a new NonEmployeeApprovalSummary 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 + +### NewNonEmployeeApprovalSummaryWithDefaults + +`func NewNonEmployeeApprovalSummaryWithDefaults() *NonEmployeeApprovalSummary` + +NewNonEmployeeApprovalSummaryWithDefaults instantiates a new NonEmployeeApprovalSummary 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 + +### GetApproved + +`func (o *NonEmployeeApprovalSummary) GetApproved() float32` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *NonEmployeeApprovalSummary) GetApprovedOk() (*float32, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *NonEmployeeApprovalSummary) SetApproved(v float32)` + +SetApproved sets Approved field to given value. + +### HasApproved + +`func (o *NonEmployeeApprovalSummary) HasApproved() bool` + +HasApproved returns a boolean if a field has been set. + +### GetPending + +`func (o *NonEmployeeApprovalSummary) GetPending() float32` + +GetPending returns the Pending field if non-nil, zero value otherwise. + +### GetPendingOk + +`func (o *NonEmployeeApprovalSummary) GetPendingOk() (*float32, bool)` + +GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPending + +`func (o *NonEmployeeApprovalSummary) SetPending(v float32)` + +SetPending sets Pending field to given value. + +### HasPending + +`func (o *NonEmployeeApprovalSummary) HasPending() bool` + +HasPending returns a boolean if a field has been set. + +### GetRejected + +`func (o *NonEmployeeApprovalSummary) GetRejected() float32` + +GetRejected returns the Rejected field if non-nil, zero value otherwise. + +### GetRejectedOk + +`func (o *NonEmployeeApprovalSummary) GetRejectedOk() (*float32, bool)` + +GetRejectedOk returns a tuple with the Rejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRejected + +`func (o *NonEmployeeApprovalSummary) SetRejected(v float32)` + +SetRejected sets Rejected field to given value. + +### HasRejected + +`func (o *NonEmployeeApprovalSummary) HasRejected() bool` + +HasRejected returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeBulkUploadJob.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeBulkUploadJob.md new file mode 100644 index 000000000..123b1ad8d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeBulkUploadJob.md @@ -0,0 +1,168 @@ +--- +id: beta-non-employee-bulk-upload-job +title: NonEmployeeBulkUploadJob +pagination_label: NonEmployeeBulkUploadJob +sidebar_label: NonEmployeeBulkUploadJob +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeBulkUploadJob', 'BetaNonEmployeeBulkUploadJob'] +slug: /tools/sdk/go/beta/models/non-employee-bulk-upload-job +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadJob', 'BetaNonEmployeeBulkUploadJob'] +--- + +# NonEmployeeBulkUploadJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The bulk upload job's ID. (UUID) | [optional] +**SourceId** | Pointer to **string** | The ID of the source to bulk-upload non-employees to. (UUID) | [optional] +**Created** | Pointer to **SailPointTime** | The date-time the job was submitted. | [optional] +**Modified** | Pointer to **SailPointTime** | The date-time that the job was last updated. | [optional] +**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. | [optional] + +## Methods + +### NewNonEmployeeBulkUploadJob + +`func NewNonEmployeeBulkUploadJob() *NonEmployeeBulkUploadJob` + +NewNonEmployeeBulkUploadJob instantiates a new NonEmployeeBulkUploadJob 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 + +### NewNonEmployeeBulkUploadJobWithDefaults + +`func NewNonEmployeeBulkUploadJobWithDefaults() *NonEmployeeBulkUploadJob` + +NewNonEmployeeBulkUploadJobWithDefaults instantiates a new NonEmployeeBulkUploadJob 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 + +### GetId + +`func (o *NonEmployeeBulkUploadJob) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeBulkUploadJob) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeBulkUploadJob) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeBulkUploadJob) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeBulkUploadJob) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeBulkUploadJob) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeBulkUploadJob) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeBulkUploadJob) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeBulkUploadJob) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeBulkUploadJob) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeBulkUploadJob) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeBulkUploadJob) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeBulkUploadJob) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeBulkUploadJob) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeBulkUploadJob) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeBulkUploadJob) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetStatus + +`func (o *NonEmployeeBulkUploadJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *NonEmployeeBulkUploadJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *NonEmployeeBulkUploadJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *NonEmployeeBulkUploadJob) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeBulkUploadStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeBulkUploadStatus.md new file mode 100644 index 000000000..f9c55ad46 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeBulkUploadStatus.md @@ -0,0 +1,64 @@ +--- +id: beta-non-employee-bulk-upload-status +title: NonEmployeeBulkUploadStatus +pagination_label: NonEmployeeBulkUploadStatus +sidebar_label: NonEmployeeBulkUploadStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeBulkUploadStatus', 'BetaNonEmployeeBulkUploadStatus'] +slug: /tools/sdk/go/beta/models/non-employee-bulk-upload-status +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadStatus', 'BetaNonEmployeeBulkUploadStatus'] +--- + +# NonEmployeeBulkUploadStatus + +## Properties + +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] + +## Methods + +### NewNonEmployeeBulkUploadStatus + +`func NewNonEmployeeBulkUploadStatus() *NonEmployeeBulkUploadStatus` + +NewNonEmployeeBulkUploadStatus instantiates a new NonEmployeeBulkUploadStatus 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 + +### NewNonEmployeeBulkUploadStatusWithDefaults + +`func NewNonEmployeeBulkUploadStatusWithDefaults() *NonEmployeeBulkUploadStatus` + +NewNonEmployeeBulkUploadStatusWithDefaults instantiates a new NonEmployeeBulkUploadStatus 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 + +### GetStatus + +`func (o *NonEmployeeBulkUploadStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *NonEmployeeBulkUploadStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *NonEmployeeBulkUploadStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *NonEmployeeBulkUploadStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeIdnUserRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeIdnUserRequest.md new file mode 100644 index 000000000..46a55afd9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeIdnUserRequest.md @@ -0,0 +1,59 @@ +--- +id: beta-non-employee-idn-user-request +title: NonEmployeeIdnUserRequest +pagination_label: NonEmployeeIdnUserRequest +sidebar_label: NonEmployeeIdnUserRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeIdnUserRequest', 'BetaNonEmployeeIdnUserRequest'] +slug: /tools/sdk/go/beta/models/non-employee-idn-user-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdnUserRequest', 'BetaNonEmployeeIdnUserRequest'] +--- + +# NonEmployeeIdnUserRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Identity id. | + +## Methods + +### NewNonEmployeeIdnUserRequest + +`func NewNonEmployeeIdnUserRequest(id string, ) *NonEmployeeIdnUserRequest` + +NewNonEmployeeIdnUserRequest instantiates a new NonEmployeeIdnUserRequest 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 + +### NewNonEmployeeIdnUserRequestWithDefaults + +`func NewNonEmployeeIdnUserRequestWithDefaults() *NonEmployeeIdnUserRequest` + +NewNonEmployeeIdnUserRequestWithDefaults instantiates a new NonEmployeeIdnUserRequest 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 + +### GetId + +`func (o *NonEmployeeIdnUserRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeIdnUserRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeIdnUserRequest) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRecord.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRecord.md new file mode 100644 index 000000000..40a594ceb --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRecord.md @@ -0,0 +1,376 @@ +--- +id: beta-non-employee-record +title: NonEmployeeRecord +pagination_label: NonEmployeeRecord +sidebar_label: NonEmployeeRecord +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRecord', 'BetaNonEmployeeRecord'] +slug: /tools/sdk/go/beta/models/non-employee-record +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRecord', 'BetaNonEmployeeRecord'] +--- + +# NonEmployeeRecord + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee record id. | [optional] +**AccountName** | Pointer to **string** | Requested identity account name. | [optional] +**FirstName** | Pointer to **string** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **string** | Non-Employee's last name. | [optional] +**Email** | Pointer to **string** | Non-Employee's email. | [optional] +**Phone** | Pointer to **string** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **string** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**SourceId** | Pointer to **string** | Non-Employee's source id. | [optional] +**Data** | Pointer to **map[string]string** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**StartDate** | Pointer to **SailPointTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **SailPointTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeRecord + +`func NewNonEmployeeRecord() *NonEmployeeRecord` + +NewNonEmployeeRecord instantiates a new NonEmployeeRecord 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 + +### NewNonEmployeeRecordWithDefaults + +`func NewNonEmployeeRecordWithDefaults() *NonEmployeeRecord` + +NewNonEmployeeRecordWithDefaults instantiates a new NonEmployeeRecord 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 + +### GetId + +`func (o *NonEmployeeRecord) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeRecord) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeRecord) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeRecord) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeRecord) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeRecord) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeRecord) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeRecord) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *NonEmployeeRecord) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *NonEmployeeRecord) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *NonEmployeeRecord) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *NonEmployeeRecord) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### GetLastName + +`func (o *NonEmployeeRecord) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *NonEmployeeRecord) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *NonEmployeeRecord) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *NonEmployeeRecord) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### GetEmail + +`func (o *NonEmployeeRecord) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *NonEmployeeRecord) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *NonEmployeeRecord) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *NonEmployeeRecord) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetPhone + +`func (o *NonEmployeeRecord) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *NonEmployeeRecord) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *NonEmployeeRecord) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *NonEmployeeRecord) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### GetManager + +`func (o *NonEmployeeRecord) GetManager() string` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *NonEmployeeRecord) GetManagerOk() (*string, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *NonEmployeeRecord) SetManager(v string)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *NonEmployeeRecord) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeRecord) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeRecord) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeRecord) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeRecord) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetData + +`func (o *NonEmployeeRecord) GetData() map[string]string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *NonEmployeeRecord) GetDataOk() (*map[string]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *NonEmployeeRecord) SetData(v map[string]string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *NonEmployeeRecord) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetStartDate + +`func (o *NonEmployeeRecord) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NonEmployeeRecord) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *NonEmployeeRecord) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *NonEmployeeRecord) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *NonEmployeeRecord) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *NonEmployeeRecord) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *NonEmployeeRecord) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *NonEmployeeRecord) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeRecord) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeRecord) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeRecord) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeRecord) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeRecord) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeRecord) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeRecord) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeRecord) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRejectApprovalDecision.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRejectApprovalDecision.md new file mode 100644 index 000000000..3bbbb3fb6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRejectApprovalDecision.md @@ -0,0 +1,59 @@ +--- +id: beta-non-employee-reject-approval-decision +title: NonEmployeeRejectApprovalDecision +pagination_label: NonEmployeeRejectApprovalDecision +sidebar_label: NonEmployeeRejectApprovalDecision +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRejectApprovalDecision', 'BetaNonEmployeeRejectApprovalDecision'] +slug: /tools/sdk/go/beta/models/non-employee-reject-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRejectApprovalDecision', 'BetaNonEmployeeRejectApprovalDecision'] +--- + +# NonEmployeeRejectApprovalDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | **string** | Comment on the approval item. | + +## Methods + +### NewNonEmployeeRejectApprovalDecision + +`func NewNonEmployeeRejectApprovalDecision(comment string, ) *NonEmployeeRejectApprovalDecision` + +NewNonEmployeeRejectApprovalDecision instantiates a new NonEmployeeRejectApprovalDecision 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 + +### NewNonEmployeeRejectApprovalDecisionWithDefaults + +`func NewNonEmployeeRejectApprovalDecisionWithDefaults() *NonEmployeeRejectApprovalDecision` + +NewNonEmployeeRejectApprovalDecisionWithDefaults instantiates a new NonEmployeeRejectApprovalDecision 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 + +### GetComment + +`func (o *NonEmployeeRejectApprovalDecision) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeRejectApprovalDecision) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeRejectApprovalDecision) SetComment(v string)` + +SetComment sets Comment field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRequest.md new file mode 100644 index 000000000..9f91cfa42 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRequest.md @@ -0,0 +1,558 @@ +--- +id: beta-non-employee-request +title: NonEmployeeRequest +pagination_label: NonEmployeeRequest +sidebar_label: NonEmployeeRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequest', 'BetaNonEmployeeRequest'] +slug: /tools/sdk/go/beta/models/non-employee-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequest', 'BetaNonEmployeeRequest'] +--- + +# NonEmployeeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**AccountName** | Pointer to **string** | Requested identity account name. | [optional] +**FirstName** | Pointer to **string** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **string** | Non-Employee's last name. | [optional] +**Email** | Pointer to **string** | Non-Employee's email. | [optional] +**Phone** | Pointer to **string** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **string** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLite**](non-employee-source-lite) | | [optional] +**Data** | Pointer to **map[string]string** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**ApprovalItems** | Pointer to [**[]NonEmployeeApprovalItemBase**](non-employee-approval-item-base) | List of approval item for the request | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**Comment** | Pointer to **string** | Comment of requester | [optional] +**CompletionDate** | Pointer to **SailPointTime** | When the request was completely approved. | [optional] +**StartDate** | Pointer to **SailPointTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **SailPointTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeRequest + +`func NewNonEmployeeRequest() *NonEmployeeRequest` + +NewNonEmployeeRequest instantiates a new NonEmployeeRequest 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 + +### NewNonEmployeeRequestWithDefaults + +`func NewNonEmployeeRequestWithDefaults() *NonEmployeeRequest` + +NewNonEmployeeRequestWithDefaults instantiates a new NonEmployeeRequest 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 + +### GetId + +`func (o *NonEmployeeRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeRequest) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeRequest) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeRequest) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeRequest) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeRequest) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeRequest) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeRequest) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeRequest) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeRequest) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeRequest) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *NonEmployeeRequest) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *NonEmployeeRequest) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *NonEmployeeRequest) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *NonEmployeeRequest) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### GetLastName + +`func (o *NonEmployeeRequest) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *NonEmployeeRequest) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *NonEmployeeRequest) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *NonEmployeeRequest) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### GetEmail + +`func (o *NonEmployeeRequest) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *NonEmployeeRequest) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *NonEmployeeRequest) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *NonEmployeeRequest) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetPhone + +`func (o *NonEmployeeRequest) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *NonEmployeeRequest) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *NonEmployeeRequest) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *NonEmployeeRequest) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### GetManager + +`func (o *NonEmployeeRequest) GetManager() string` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *NonEmployeeRequest) GetManagerOk() (*string, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *NonEmployeeRequest) SetManager(v string)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *NonEmployeeRequest) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### GetNonEmployeeSource + +`func (o *NonEmployeeRequest) GetNonEmployeeSource() NonEmployeeSourceLite` + +GetNonEmployeeSource returns the NonEmployeeSource field if non-nil, zero value otherwise. + +### GetNonEmployeeSourceOk + +`func (o *NonEmployeeRequest) GetNonEmployeeSourceOk() (*NonEmployeeSourceLite, bool)` + +GetNonEmployeeSourceOk returns a tuple with the NonEmployeeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeSource + +`func (o *NonEmployeeRequest) SetNonEmployeeSource(v NonEmployeeSourceLite)` + +SetNonEmployeeSource sets NonEmployeeSource field to given value. + +### HasNonEmployeeSource + +`func (o *NonEmployeeRequest) HasNonEmployeeSource() bool` + +HasNonEmployeeSource returns a boolean if a field has been set. + +### GetData + +`func (o *NonEmployeeRequest) GetData() map[string]string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *NonEmployeeRequest) GetDataOk() (*map[string]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *NonEmployeeRequest) SetData(v map[string]string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *NonEmployeeRequest) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetApprovalItems + +`func (o *NonEmployeeRequest) GetApprovalItems() []NonEmployeeApprovalItemBase` + +GetApprovalItems returns the ApprovalItems field if non-nil, zero value otherwise. + +### GetApprovalItemsOk + +`func (o *NonEmployeeRequest) GetApprovalItemsOk() (*[]NonEmployeeApprovalItemBase, bool)` + +GetApprovalItemsOk returns a tuple with the ApprovalItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalItems + +`func (o *NonEmployeeRequest) SetApprovalItems(v []NonEmployeeApprovalItemBase)` + +SetApprovalItems sets ApprovalItems field to given value. + +### HasApprovalItems + +`func (o *NonEmployeeRequest) HasApprovalItems() bool` + +HasApprovalItems returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeRequest) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeRequest) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeRequest) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeRequest) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeRequest) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeRequest) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeRequest) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeRequest) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetCompletionDate + +`func (o *NonEmployeeRequest) GetCompletionDate() SailPointTime` + +GetCompletionDate returns the CompletionDate field if non-nil, zero value otherwise. + +### GetCompletionDateOk + +`func (o *NonEmployeeRequest) GetCompletionDateOk() (*SailPointTime, bool)` + +GetCompletionDateOk returns a tuple with the CompletionDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionDate + +`func (o *NonEmployeeRequest) SetCompletionDate(v SailPointTime)` + +SetCompletionDate sets CompletionDate field to given value. + +### HasCompletionDate + +`func (o *NonEmployeeRequest) HasCompletionDate() bool` + +HasCompletionDate returns a boolean if a field has been set. + +### GetStartDate + +`func (o *NonEmployeeRequest) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NonEmployeeRequest) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *NonEmployeeRequest) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *NonEmployeeRequest) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *NonEmployeeRequest) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *NonEmployeeRequest) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *NonEmployeeRequest) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *NonEmployeeRequest) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeRequest) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeRequest) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeRequest) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeRequest) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeRequest) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeRequest) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeRequest) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeRequest) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRequestBody.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRequestBody.md new file mode 100644 index 000000000..c8d5db162 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRequestBody.md @@ -0,0 +1,253 @@ +--- +id: beta-non-employee-request-body +title: NonEmployeeRequestBody +pagination_label: NonEmployeeRequestBody +sidebar_label: NonEmployeeRequestBody +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequestBody', 'BetaNonEmployeeRequestBody'] +slug: /tools/sdk/go/beta/models/non-employee-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestBody', 'BetaNonEmployeeRequestBody'] +--- + +# NonEmployeeRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountName** | **string** | Requested identity account name. | +**FirstName** | **string** | Non-Employee's first name. | +**LastName** | **string** | Non-Employee's last name. | +**Email** | **string** | Non-Employee's email. | +**Phone** | **string** | Non-Employee's phone. | +**Manager** | **string** | The account ID of a valid identity to serve as this non-employee's manager. | +**SourceId** | **string** | Non-Employee's source id. | +**Data** | Pointer to **map[string]string** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**StartDate** | **SailPointTime** | Non-Employee employment start date. | +**EndDate** | **SailPointTime** | Non-Employee employment end date. | + +## Methods + +### NewNonEmployeeRequestBody + +`func NewNonEmployeeRequestBody(accountName string, firstName string, lastName string, email string, phone string, manager string, sourceId string, startDate SailPointTime, endDate SailPointTime, ) *NonEmployeeRequestBody` + +NewNonEmployeeRequestBody instantiates a new NonEmployeeRequestBody 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 + +### NewNonEmployeeRequestBodyWithDefaults + +`func NewNonEmployeeRequestBodyWithDefaults() *NonEmployeeRequestBody` + +NewNonEmployeeRequestBodyWithDefaults instantiates a new NonEmployeeRequestBody 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 + +### GetAccountName + +`func (o *NonEmployeeRequestBody) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeRequestBody) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeRequestBody) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + + +### GetFirstName + +`func (o *NonEmployeeRequestBody) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *NonEmployeeRequestBody) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *NonEmployeeRequestBody) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + + +### GetLastName + +`func (o *NonEmployeeRequestBody) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *NonEmployeeRequestBody) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *NonEmployeeRequestBody) SetLastName(v string)` + +SetLastName sets LastName field to given value. + + +### GetEmail + +`func (o *NonEmployeeRequestBody) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *NonEmployeeRequestBody) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *NonEmployeeRequestBody) SetEmail(v string)` + +SetEmail sets Email field to given value. + + +### GetPhone + +`func (o *NonEmployeeRequestBody) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *NonEmployeeRequestBody) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *NonEmployeeRequestBody) SetPhone(v string)` + +SetPhone sets Phone field to given value. + + +### GetManager + +`func (o *NonEmployeeRequestBody) GetManager() string` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *NonEmployeeRequestBody) GetManagerOk() (*string, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *NonEmployeeRequestBody) SetManager(v string)` + +SetManager sets Manager field to given value. + + +### GetSourceId + +`func (o *NonEmployeeRequestBody) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeRequestBody) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeRequestBody) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetData + +`func (o *NonEmployeeRequestBody) GetData() map[string]string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *NonEmployeeRequestBody) GetDataOk() (*map[string]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *NonEmployeeRequestBody) SetData(v map[string]string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *NonEmployeeRequestBody) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetStartDate + +`func (o *NonEmployeeRequestBody) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NonEmployeeRequestBody) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *NonEmployeeRequestBody) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + + +### GetEndDate + +`func (o *NonEmployeeRequestBody) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *NonEmployeeRequestBody) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *NonEmployeeRequestBody) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRequestLite.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRequestLite.md new file mode 100644 index 000000000..3adf3667c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRequestLite.md @@ -0,0 +1,90 @@ +--- +id: beta-non-employee-request-lite +title: NonEmployeeRequestLite +pagination_label: NonEmployeeRequestLite +sidebar_label: NonEmployeeRequestLite +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequestLite', 'BetaNonEmployeeRequestLite'] +slug: /tools/sdk/go/beta/models/non-employee-request-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestLite', 'BetaNonEmployeeRequestLite'] +--- + +# NonEmployeeRequestLite + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee request id. | [optional] +**Requester** | Pointer to [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] + +## Methods + +### NewNonEmployeeRequestLite + +`func NewNonEmployeeRequestLite() *NonEmployeeRequestLite` + +NewNonEmployeeRequestLite instantiates a new NonEmployeeRequestLite 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 + +### NewNonEmployeeRequestLiteWithDefaults + +`func NewNonEmployeeRequestLiteWithDefaults() *NonEmployeeRequestLite` + +NewNonEmployeeRequestLiteWithDefaults instantiates a new NonEmployeeRequestLite 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 + +### GetId + +`func (o *NonEmployeeRequestLite) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeRequestLite) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeRequestLite) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeRequestLite) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRequester + +`func (o *NonEmployeeRequestLite) GetRequester() IdentityReferenceWithId` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *NonEmployeeRequestLite) GetRequesterOk() (*IdentityReferenceWithId, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *NonEmployeeRequestLite) SetRequester(v IdentityReferenceWithId)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *NonEmployeeRequestLite) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRequestSummary.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRequestSummary.md new file mode 100644 index 000000000..8abafcce1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRequestSummary.md @@ -0,0 +1,142 @@ +--- +id: beta-non-employee-request-summary +title: NonEmployeeRequestSummary +pagination_label: NonEmployeeRequestSummary +sidebar_label: NonEmployeeRequestSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequestSummary', 'BetaNonEmployeeRequestSummary'] +slug: /tools/sdk/go/beta/models/non-employee-request-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestSummary', 'BetaNonEmployeeRequestSummary'] +--- + +# NonEmployeeRequestSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | Pointer to **float32** | The number of approved non-employee requests on all sources that *requested-for* user manages. | [optional] +**Rejected** | Pointer to **float32** | The number of rejected non-employee requests on all sources that *requested-for* user manages. | [optional] +**Pending** | Pointer to **float32** | The number of pending non-employee requests on all sources that *requested-for* user manages. | [optional] +**NonEmployeeCount** | Pointer to **float32** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] + +## Methods + +### NewNonEmployeeRequestSummary + +`func NewNonEmployeeRequestSummary() *NonEmployeeRequestSummary` + +NewNonEmployeeRequestSummary instantiates a new NonEmployeeRequestSummary 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 + +### NewNonEmployeeRequestSummaryWithDefaults + +`func NewNonEmployeeRequestSummaryWithDefaults() *NonEmployeeRequestSummary` + +NewNonEmployeeRequestSummaryWithDefaults instantiates a new NonEmployeeRequestSummary 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 + +### GetApproved + +`func (o *NonEmployeeRequestSummary) GetApproved() float32` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *NonEmployeeRequestSummary) GetApprovedOk() (*float32, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *NonEmployeeRequestSummary) SetApproved(v float32)` + +SetApproved sets Approved field to given value. + +### HasApproved + +`func (o *NonEmployeeRequestSummary) HasApproved() bool` + +HasApproved returns a boolean if a field has been set. + +### GetRejected + +`func (o *NonEmployeeRequestSummary) GetRejected() float32` + +GetRejected returns the Rejected field if non-nil, zero value otherwise. + +### GetRejectedOk + +`func (o *NonEmployeeRequestSummary) GetRejectedOk() (*float32, bool)` + +GetRejectedOk returns a tuple with the Rejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRejected + +`func (o *NonEmployeeRequestSummary) SetRejected(v float32)` + +SetRejected sets Rejected field to given value. + +### HasRejected + +`func (o *NonEmployeeRequestSummary) HasRejected() bool` + +HasRejected returns a boolean if a field has been set. + +### GetPending + +`func (o *NonEmployeeRequestSummary) GetPending() float32` + +GetPending returns the Pending field if non-nil, zero value otherwise. + +### GetPendingOk + +`func (o *NonEmployeeRequestSummary) GetPendingOk() (*float32, bool)` + +GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPending + +`func (o *NonEmployeeRequestSummary) SetPending(v float32)` + +SetPending sets Pending field to given value. + +### HasPending + +`func (o *NonEmployeeRequestSummary) HasPending() bool` + +HasPending returns a boolean if a field has been set. + +### GetNonEmployeeCount + +`func (o *NonEmployeeRequestSummary) GetNonEmployeeCount() float32` + +GetNonEmployeeCount returns the NonEmployeeCount field if non-nil, zero value otherwise. + +### GetNonEmployeeCountOk + +`func (o *NonEmployeeRequestSummary) GetNonEmployeeCountOk() (*float32, bool)` + +GetNonEmployeeCountOk returns a tuple with the NonEmployeeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeCount + +`func (o *NonEmployeeRequestSummary) SetNonEmployeeCount(v float32)` + +SetNonEmployeeCount sets NonEmployeeCount field to given value. + +### HasNonEmployeeCount + +`func (o *NonEmployeeRequestSummary) HasNonEmployeeCount() bool` + +HasNonEmployeeCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md new file mode 100644 index 000000000..602b06a39 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -0,0 +1,480 @@ +--- +id: beta-non-employee-request-without-approval-item +title: NonEmployeeRequestWithoutApprovalItem +pagination_label: NonEmployeeRequestWithoutApprovalItem +sidebar_label: NonEmployeeRequestWithoutApprovalItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequestWithoutApprovalItem', 'BetaNonEmployeeRequestWithoutApprovalItem'] +slug: /tools/sdk/go/beta/models/non-employee-request-without-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestWithoutApprovalItem', 'BetaNonEmployeeRequestWithoutApprovalItem'] +--- + +# NonEmployeeRequestWithoutApprovalItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee request id. | [optional] +**Requester** | Pointer to [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **string** | Requested identity account name. | [optional] +**FirstName** | Pointer to **string** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **string** | Non-Employee's last name. | [optional] +**Email** | Pointer to **string** | Non-Employee's email. | [optional] +**Phone** | Pointer to **string** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **string** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLiteWithSchemaAttributes**](non-employee-source-lite-with-schema-attributes) | | [optional] +**Data** | Pointer to **map[string]string** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**Comment** | Pointer to **string** | Comment of requester | [optional] +**CompletionDate** | Pointer to **SailPointTime** | When the request was completely approved. | [optional] +**StartDate** | Pointer to **string** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **string** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeRequestWithoutApprovalItem + +`func NewNonEmployeeRequestWithoutApprovalItem() *NonEmployeeRequestWithoutApprovalItem` + +NewNonEmployeeRequestWithoutApprovalItem instantiates a new NonEmployeeRequestWithoutApprovalItem 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 + +### NewNonEmployeeRequestWithoutApprovalItemWithDefaults + +`func NewNonEmployeeRequestWithoutApprovalItemWithDefaults() *NonEmployeeRequestWithoutApprovalItem` + +NewNonEmployeeRequestWithoutApprovalItemWithDefaults instantiates a new NonEmployeeRequestWithoutApprovalItem 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 + +### GetId + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRequester + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetRequester() IdentityReferenceWithId` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetRequesterOk() (*IdentityReferenceWithId, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetRequester(v IdentityReferenceWithId)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### GetLastName + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### GetEmail + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetPhone + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### GetManager + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetManager() string` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetManagerOk() (*string, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetManager(v string)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### GetNonEmployeeSource + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetNonEmployeeSource() NonEmployeeSourceLiteWithSchemaAttributes` + +GetNonEmployeeSource returns the NonEmployeeSource field if non-nil, zero value otherwise. + +### GetNonEmployeeSourceOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetNonEmployeeSourceOk() (*NonEmployeeSourceLiteWithSchemaAttributes, bool)` + +GetNonEmployeeSourceOk returns a tuple with the NonEmployeeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeSource + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetNonEmployeeSource(v NonEmployeeSourceLiteWithSchemaAttributes)` + +SetNonEmployeeSource sets NonEmployeeSource field to given value. + +### HasNonEmployeeSource + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasNonEmployeeSource() bool` + +HasNonEmployeeSource returns a boolean if a field has been set. + +### GetData + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetData() map[string]string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetDataOk() (*map[string]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetData(v map[string]string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetCompletionDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCompletionDate() SailPointTime` + +GetCompletionDate returns the CompletionDate field if non-nil, zero value otherwise. + +### GetCompletionDateOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCompletionDateOk() (*SailPointTime, bool)` + +GetCompletionDateOk returns a tuple with the CompletionDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetCompletionDate(v SailPointTime)` + +SetCompletionDate sets CompletionDate field to given value. + +### HasCompletionDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasCompletionDate() bool` + +HasCompletionDate returns a boolean if a field has been set. + +### GetStartDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetStartDate() string` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetStartDateOk() (*string, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetStartDate(v string)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetEndDate() string` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetEndDateOk() (*string, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetEndDate(v string)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSchemaAttribute.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSchemaAttribute.md new file mode 100644 index 000000000..c958102ad --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSchemaAttribute.md @@ -0,0 +1,283 @@ +--- +id: beta-non-employee-schema-attribute +title: NonEmployeeSchemaAttribute +pagination_label: NonEmployeeSchemaAttribute +sidebar_label: NonEmployeeSchemaAttribute +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSchemaAttribute', 'BetaNonEmployeeSchemaAttribute'] +slug: /tools/sdk/go/beta/models/non-employee-schema-attribute +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttribute', 'BetaNonEmployeeSchemaAttribute'] +--- + +# NonEmployeeSchemaAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Schema Attribute Id | [optional] +**System** | Pointer to **bool** | True if this schema attribute is mandatory on all non-employees sources. | [optional] [default to false] +**Modified** | Pointer to **SailPointTime** | When the schema attribute was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the schema attribute was created. | [optional] +**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] +**Required** | Pointer to **bool** | If true, the schema attribute is required for all non-employees in the source | [optional] [default to false] + +## Methods + +### NewNonEmployeeSchemaAttribute + +`func NewNonEmployeeSchemaAttribute(type_ NonEmployeeSchemaAttributeType, label string, technicalName string, ) *NonEmployeeSchemaAttribute` + +NewNonEmployeeSchemaAttribute instantiates a new NonEmployeeSchemaAttribute 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 + +### NewNonEmployeeSchemaAttributeWithDefaults + +`func NewNonEmployeeSchemaAttributeWithDefaults() *NonEmployeeSchemaAttribute` + +NewNonEmployeeSchemaAttributeWithDefaults instantiates a new NonEmployeeSchemaAttribute 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 + +### GetId + +`func (o *NonEmployeeSchemaAttribute) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSchemaAttribute) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSchemaAttribute) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSchemaAttribute) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSystem + +`func (o *NonEmployeeSchemaAttribute) GetSystem() bool` + +GetSystem returns the System field if non-nil, zero value otherwise. + +### GetSystemOk + +`func (o *NonEmployeeSchemaAttribute) GetSystemOk() (*bool, bool)` + +GetSystemOk returns a tuple with the System field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSystem + +`func (o *NonEmployeeSchemaAttribute) SetSystem(v bool)` + +SetSystem sets System field to given value. + +### HasSystem + +`func (o *NonEmployeeSchemaAttribute) HasSystem() bool` + +HasSystem returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeSchemaAttribute) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeSchemaAttribute) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeSchemaAttribute) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeSchemaAttribute) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeSchemaAttribute) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeSchemaAttribute) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeSchemaAttribute) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeSchemaAttribute) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetType + +`func (o *NonEmployeeSchemaAttribute) GetType() NonEmployeeSchemaAttributeType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NonEmployeeSchemaAttribute) GetTypeOk() (*NonEmployeeSchemaAttributeType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NonEmployeeSchemaAttribute) SetType(v NonEmployeeSchemaAttributeType)` + +SetType sets Type field to given value. + + +### GetLabel + +`func (o *NonEmployeeSchemaAttribute) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *NonEmployeeSchemaAttribute) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *NonEmployeeSchemaAttribute) SetLabel(v string)` + +SetLabel sets Label field to given value. + + +### GetTechnicalName + +`func (o *NonEmployeeSchemaAttribute) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *NonEmployeeSchemaAttribute) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *NonEmployeeSchemaAttribute) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + + +### GetHelpText + +`func (o *NonEmployeeSchemaAttribute) GetHelpText() string` + +GetHelpText returns the HelpText field if non-nil, zero value otherwise. + +### GetHelpTextOk + +`func (o *NonEmployeeSchemaAttribute) GetHelpTextOk() (*string, bool)` + +GetHelpTextOk returns a tuple with the HelpText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHelpText + +`func (o *NonEmployeeSchemaAttribute) SetHelpText(v string)` + +SetHelpText sets HelpText field to given value. + +### HasHelpText + +`func (o *NonEmployeeSchemaAttribute) HasHelpText() bool` + +HasHelpText returns a boolean if a field has been set. + +### GetPlaceholder + +`func (o *NonEmployeeSchemaAttribute) GetPlaceholder() string` + +GetPlaceholder returns the Placeholder field if non-nil, zero value otherwise. + +### GetPlaceholderOk + +`func (o *NonEmployeeSchemaAttribute) GetPlaceholderOk() (*string, bool)` + +GetPlaceholderOk returns a tuple with the Placeholder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPlaceholder + +`func (o *NonEmployeeSchemaAttribute) SetPlaceholder(v string)` + +SetPlaceholder sets Placeholder field to given value. + +### HasPlaceholder + +`func (o *NonEmployeeSchemaAttribute) HasPlaceholder() bool` + +HasPlaceholder returns a boolean if a field has been set. + +### GetRequired + +`func (o *NonEmployeeSchemaAttribute) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *NonEmployeeSchemaAttribute) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *NonEmployeeSchemaAttribute) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *NonEmployeeSchemaAttribute) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSchemaAttributeBody.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSchemaAttributeBody.md new file mode 100644 index 000000000..69144fa3d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSchemaAttributeBody.md @@ -0,0 +1,179 @@ +--- +id: beta-non-employee-schema-attribute-body +title: NonEmployeeSchemaAttributeBody +pagination_label: NonEmployeeSchemaAttributeBody +sidebar_label: NonEmployeeSchemaAttributeBody +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSchemaAttributeBody', 'BetaNonEmployeeSchemaAttributeBody'] +slug: /tools/sdk/go/beta/models/non-employee-schema-attribute-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeBody', 'BetaNonEmployeeSchemaAttributeBody'] +--- + +# NonEmployeeSchemaAttributeBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of the attribute. Only type 'TEXT' is supported for custom attributes. | +**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] +**Required** | Pointer to **bool** | If true, the schema attribute is required for all non-employees in the source | [optional] + +## Methods + +### NewNonEmployeeSchemaAttributeBody + +`func NewNonEmployeeSchemaAttributeBody(type_ string, label string, technicalName string, ) *NonEmployeeSchemaAttributeBody` + +NewNonEmployeeSchemaAttributeBody instantiates a new NonEmployeeSchemaAttributeBody 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 + +### NewNonEmployeeSchemaAttributeBodyWithDefaults + +`func NewNonEmployeeSchemaAttributeBodyWithDefaults() *NonEmployeeSchemaAttributeBody` + +NewNonEmployeeSchemaAttributeBodyWithDefaults instantiates a new NonEmployeeSchemaAttributeBody 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 + +### GetType + +`func (o *NonEmployeeSchemaAttributeBody) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NonEmployeeSchemaAttributeBody) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NonEmployeeSchemaAttributeBody) SetType(v string)` + +SetType sets Type field to given value. + + +### GetLabel + +`func (o *NonEmployeeSchemaAttributeBody) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *NonEmployeeSchemaAttributeBody) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *NonEmployeeSchemaAttributeBody) SetLabel(v string)` + +SetLabel sets Label field to given value. + + +### GetTechnicalName + +`func (o *NonEmployeeSchemaAttributeBody) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *NonEmployeeSchemaAttributeBody) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *NonEmployeeSchemaAttributeBody) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + + +### GetHelpText + +`func (o *NonEmployeeSchemaAttributeBody) GetHelpText() string` + +GetHelpText returns the HelpText field if non-nil, zero value otherwise. + +### GetHelpTextOk + +`func (o *NonEmployeeSchemaAttributeBody) GetHelpTextOk() (*string, bool)` + +GetHelpTextOk returns a tuple with the HelpText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHelpText + +`func (o *NonEmployeeSchemaAttributeBody) SetHelpText(v string)` + +SetHelpText sets HelpText field to given value. + +### HasHelpText + +`func (o *NonEmployeeSchemaAttributeBody) HasHelpText() bool` + +HasHelpText returns a boolean if a field has been set. + +### GetPlaceholder + +`func (o *NonEmployeeSchemaAttributeBody) GetPlaceholder() string` + +GetPlaceholder returns the Placeholder field if non-nil, zero value otherwise. + +### GetPlaceholderOk + +`func (o *NonEmployeeSchemaAttributeBody) GetPlaceholderOk() (*string, bool)` + +GetPlaceholderOk returns a tuple with the Placeholder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPlaceholder + +`func (o *NonEmployeeSchemaAttributeBody) SetPlaceholder(v string)` + +SetPlaceholder sets Placeholder field to given value. + +### HasPlaceholder + +`func (o *NonEmployeeSchemaAttributeBody) HasPlaceholder() bool` + +HasPlaceholder returns a boolean if a field has been set. + +### GetRequired + +`func (o *NonEmployeeSchemaAttributeBody) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *NonEmployeeSchemaAttributeBody) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *NonEmployeeSchemaAttributeBody) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *NonEmployeeSchemaAttributeBody) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSchemaAttributeType.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSchemaAttributeType.md new file mode 100644 index 000000000..8f9dead2f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSchemaAttributeType.md @@ -0,0 +1,23 @@ +--- +id: beta-non-employee-schema-attribute-type +title: NonEmployeeSchemaAttributeType +pagination_label: NonEmployeeSchemaAttributeType +sidebar_label: NonEmployeeSchemaAttributeType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSchemaAttributeType', 'BetaNonEmployeeSchemaAttributeType'] +slug: /tools/sdk/go/beta/models/non-employee-schema-attribute-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeType', 'BetaNonEmployeeSchemaAttributeType'] +--- + +# NonEmployeeSchemaAttributeType + +## Enum + + +* `TEXT` (value: `"TEXT"`) + +* `DATE` (value: `"DATE"`) + +* `IDENTITY` (value: `"IDENTITY"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSource.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSource.md new file mode 100644 index 000000000..3df16be50 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSource.md @@ -0,0 +1,282 @@ +--- +id: beta-non-employee-source +title: NonEmployeeSource +pagination_label: NonEmployeeSource +sidebar_label: NonEmployeeSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSource', 'BetaNonEmployeeSource'] +slug: /tools/sdk/go/beta/models/non-employee-source +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSource', 'BetaNonEmployeeSource'] +--- + +# NonEmployeeSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**NonEmployeeCount** | Pointer to **NullableInt32** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] + +## Methods + +### NewNonEmployeeSource + +`func NewNonEmployeeSource() *NonEmployeeSource` + +NewNonEmployeeSource instantiates a new NonEmployeeSource 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 + +### NewNonEmployeeSourceWithDefaults + +`func NewNonEmployeeSourceWithDefaults() *NonEmployeeSource` + +NewNonEmployeeSourceWithDefaults instantiates a new NonEmployeeSource 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 + +### GetId + +`func (o *NonEmployeeSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSource) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSource) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSource) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSource) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSource) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSource) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSource) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSource) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetApprovers + +`func (o *NonEmployeeSource) GetApprovers() []IdentityReferenceWithId` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *NonEmployeeSource) GetApproversOk() (*[]IdentityReferenceWithId, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *NonEmployeeSource) SetApprovers(v []IdentityReferenceWithId)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *NonEmployeeSource) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetAccountManagers + +`func (o *NonEmployeeSource) GetAccountManagers() []IdentityReferenceWithId` + +GetAccountManagers returns the AccountManagers field if non-nil, zero value otherwise. + +### GetAccountManagersOk + +`func (o *NonEmployeeSource) GetAccountManagersOk() (*[]IdentityReferenceWithId, bool)` + +GetAccountManagersOk returns a tuple with the AccountManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountManagers + +`func (o *NonEmployeeSource) SetAccountManagers(v []IdentityReferenceWithId)` + +SetAccountManagers sets AccountManagers field to given value. + +### HasAccountManagers + +`func (o *NonEmployeeSource) HasAccountManagers() bool` + +HasAccountManagers returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeSource) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeSource) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeSource) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeSource) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeSource) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeSource) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeSource) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeSource) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetNonEmployeeCount + +`func (o *NonEmployeeSource) GetNonEmployeeCount() int32` + +GetNonEmployeeCount returns the NonEmployeeCount field if non-nil, zero value otherwise. + +### GetNonEmployeeCountOk + +`func (o *NonEmployeeSource) GetNonEmployeeCountOk() (*int32, bool)` + +GetNonEmployeeCountOk returns a tuple with the NonEmployeeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeCount + +`func (o *NonEmployeeSource) SetNonEmployeeCount(v int32)` + +SetNonEmployeeCount sets NonEmployeeCount field to given value. + +### HasNonEmployeeCount + +`func (o *NonEmployeeSource) HasNonEmployeeCount() bool` + +HasNonEmployeeCount returns a boolean if a field has been set. + +### SetNonEmployeeCountNil + +`func (o *NonEmployeeSource) SetNonEmployeeCountNil(b bool)` + + SetNonEmployeeCountNil sets the value for NonEmployeeCount to be an explicit nil + +### UnsetNonEmployeeCount +`func (o *NonEmployeeSource) UnsetNonEmployeeCount()` + +UnsetNonEmployeeCount ensures that no value is present for NonEmployeeCount, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSourceLite.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSourceLite.md new file mode 100644 index 000000000..df6d610ab --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSourceLite.md @@ -0,0 +1,142 @@ +--- +id: beta-non-employee-source-lite +title: NonEmployeeSourceLite +pagination_label: NonEmployeeSourceLite +sidebar_label: NonEmployeeSourceLite +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceLite', 'BetaNonEmployeeSourceLite'] +slug: /tools/sdk/go/beta/models/non-employee-source-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLite', 'BetaNonEmployeeSourceLite'] +--- + +# NonEmployeeSourceLite + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] + +## Methods + +### NewNonEmployeeSourceLite + +`func NewNonEmployeeSourceLite() *NonEmployeeSourceLite` + +NewNonEmployeeSourceLite instantiates a new NonEmployeeSourceLite 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 + +### NewNonEmployeeSourceLiteWithDefaults + +`func NewNonEmployeeSourceLiteWithDefaults() *NonEmployeeSourceLite` + +NewNonEmployeeSourceLiteWithDefaults instantiates a new NonEmployeeSourceLite 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 + +### GetId + +`func (o *NonEmployeeSourceLite) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSourceLite) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSourceLite) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSourceLite) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSourceLite) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSourceLite) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSourceLite) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSourceLite) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSourceLite) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceLite) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceLite) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSourceLite) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSourceLite) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceLite) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceLite) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSourceLite) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSourceLiteWithSchemaAttributes.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSourceLiteWithSchemaAttributes.md new file mode 100644 index 000000000..ccb2f642c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSourceLiteWithSchemaAttributes.md @@ -0,0 +1,168 @@ +--- +id: beta-non-employee-source-lite-with-schema-attributes +title: NonEmployeeSourceLiteWithSchemaAttributes +pagination_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceLiteWithSchemaAttributes', 'BetaNonEmployeeSourceLiteWithSchemaAttributes'] +slug: /tools/sdk/go/beta/models/non-employee-source-lite-with-schema-attributes +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLiteWithSchemaAttributes', 'BetaNonEmployeeSourceLiteWithSchemaAttributes'] +--- + +# NonEmployeeSourceLiteWithSchemaAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**SchemaAttributes** | Pointer to [**[]NonEmployeeSchemaAttribute**](non-employee-schema-attribute) | List of schema attributes associated with this non-employee source. | [optional] + +## Methods + +### NewNonEmployeeSourceLiteWithSchemaAttributes + +`func NewNonEmployeeSourceLiteWithSchemaAttributes() *NonEmployeeSourceLiteWithSchemaAttributes` + +NewNonEmployeeSourceLiteWithSchemaAttributes instantiates a new NonEmployeeSourceLiteWithSchemaAttributes 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 + +### NewNonEmployeeSourceLiteWithSchemaAttributesWithDefaults + +`func NewNonEmployeeSourceLiteWithSchemaAttributesWithDefaults() *NonEmployeeSourceLiteWithSchemaAttributes` + +NewNonEmployeeSourceLiteWithSchemaAttributesWithDefaults instantiates a new NonEmployeeSourceLiteWithSchemaAttributes 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 + +### GetId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetSchemaAttributes + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetSchemaAttributes() []NonEmployeeSchemaAttribute` + +GetSchemaAttributes returns the SchemaAttributes field if non-nil, zero value otherwise. + +### GetSchemaAttributesOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetSchemaAttributesOk() (*[]NonEmployeeSchemaAttribute, bool)` + +GetSchemaAttributesOk returns a tuple with the SchemaAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchemaAttributes + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetSchemaAttributes(v []NonEmployeeSchemaAttribute)` + +SetSchemaAttributes sets SchemaAttributes field to given value. + +### HasSchemaAttributes + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasSchemaAttributes() bool` + +HasSchemaAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSourceRequestBody.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSourceRequestBody.md new file mode 100644 index 000000000..f9ae2d39c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSourceRequestBody.md @@ -0,0 +1,179 @@ +--- +id: beta-non-employee-source-request-body +title: NonEmployeeSourceRequestBody +pagination_label: NonEmployeeSourceRequestBody +sidebar_label: NonEmployeeSourceRequestBody +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceRequestBody', 'BetaNonEmployeeSourceRequestBody'] +slug: /tools/sdk/go/beta/models/non-employee-source-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceRequestBody', 'BetaNonEmployeeSourceRequestBody'] +--- + +# NonEmployeeSourceRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Name of non-employee source. | +**Description** | **string** | Description of non-employee source. | +**Owner** | [**NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | | +**ManagementWorkgroup** | Pointer to **string** | The ID for the management workgroup that contains source sub-admins | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of approvers. | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of account managers. | [optional] + +## Methods + +### NewNonEmployeeSourceRequestBody + +`func NewNonEmployeeSourceRequestBody(name string, description string, owner NonEmployeeIdnUserRequest, ) *NonEmployeeSourceRequestBody` + +NewNonEmployeeSourceRequestBody instantiates a new NonEmployeeSourceRequestBody 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 + +### NewNonEmployeeSourceRequestBodyWithDefaults + +`func NewNonEmployeeSourceRequestBodyWithDefaults() *NonEmployeeSourceRequestBody` + +NewNonEmployeeSourceRequestBodyWithDefaults instantiates a new NonEmployeeSourceRequestBody 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 + +### GetName + +`func (o *NonEmployeeSourceRequestBody) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceRequestBody) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceRequestBody) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *NonEmployeeSourceRequestBody) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceRequestBody) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceRequestBody) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetOwner + +`func (o *NonEmployeeSourceRequestBody) GetOwner() NonEmployeeIdnUserRequest` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *NonEmployeeSourceRequestBody) GetOwnerOk() (*NonEmployeeIdnUserRequest, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *NonEmployeeSourceRequestBody) SetOwner(v NonEmployeeIdnUserRequest)` + +SetOwner sets Owner field to given value. + + +### GetManagementWorkgroup + +`func (o *NonEmployeeSourceRequestBody) GetManagementWorkgroup() string` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *NonEmployeeSourceRequestBody) GetManagementWorkgroupOk() (*string, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *NonEmployeeSourceRequestBody) SetManagementWorkgroup(v string)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *NonEmployeeSourceRequestBody) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### GetApprovers + +`func (o *NonEmployeeSourceRequestBody) GetApprovers() []NonEmployeeIdnUserRequest` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *NonEmployeeSourceRequestBody) GetApproversOk() (*[]NonEmployeeIdnUserRequest, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *NonEmployeeSourceRequestBody) SetApprovers(v []NonEmployeeIdnUserRequest)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *NonEmployeeSourceRequestBody) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetAccountManagers + +`func (o *NonEmployeeSourceRequestBody) GetAccountManagers() []NonEmployeeIdnUserRequest` + +GetAccountManagers returns the AccountManagers field if non-nil, zero value otherwise. + +### GetAccountManagersOk + +`func (o *NonEmployeeSourceRequestBody) GetAccountManagersOk() (*[]NonEmployeeIdnUserRequest, bool)` + +GetAccountManagersOk returns a tuple with the AccountManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountManagers + +`func (o *NonEmployeeSourceRequestBody) SetAccountManagers(v []NonEmployeeIdnUserRequest)` + +SetAccountManagers sets AccountManagers field to given value. + +### HasAccountManagers + +`func (o *NonEmployeeSourceRequestBody) HasAccountManagers() bool` + +HasAccountManagers returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSourceWithCloudExternalId.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSourceWithCloudExternalId.md new file mode 100644 index 000000000..2ad5f0ed9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSourceWithCloudExternalId.md @@ -0,0 +1,308 @@ +--- +id: beta-non-employee-source-with-cloud-external-id +title: NonEmployeeSourceWithCloudExternalId +pagination_label: NonEmployeeSourceWithCloudExternalId +sidebar_label: NonEmployeeSourceWithCloudExternalId +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceWithCloudExternalId', 'BetaNonEmployeeSourceWithCloudExternalId'] +slug: /tools/sdk/go/beta/models/non-employee-source-with-cloud-external-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithCloudExternalId', 'BetaNonEmployeeSourceWithCloudExternalId'] +--- + +# NonEmployeeSourceWithCloudExternalId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**NonEmployeeCount** | Pointer to **NullableInt32** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] +**CloudExternalId** | Pointer to **string** | Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. | [optional] + +## Methods + +### NewNonEmployeeSourceWithCloudExternalId + +`func NewNonEmployeeSourceWithCloudExternalId() *NonEmployeeSourceWithCloudExternalId` + +NewNonEmployeeSourceWithCloudExternalId instantiates a new NonEmployeeSourceWithCloudExternalId 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 + +### NewNonEmployeeSourceWithCloudExternalIdWithDefaults + +`func NewNonEmployeeSourceWithCloudExternalIdWithDefaults() *NonEmployeeSourceWithCloudExternalId` + +NewNonEmployeeSourceWithCloudExternalIdWithDefaults instantiates a new NonEmployeeSourceWithCloudExternalId 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 + +### GetId + +`func (o *NonEmployeeSourceWithCloudExternalId) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSourceWithCloudExternalId) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSourceWithCloudExternalId) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSourceWithCloudExternalId) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSourceWithCloudExternalId) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSourceWithCloudExternalId) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSourceWithCloudExternalId) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceWithCloudExternalId) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSourceWithCloudExternalId) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSourceWithCloudExternalId) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceWithCloudExternalId) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSourceWithCloudExternalId) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetApprovers + +`func (o *NonEmployeeSourceWithCloudExternalId) GetApprovers() []IdentityReferenceWithId` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetApproversOk() (*[]IdentityReferenceWithId, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *NonEmployeeSourceWithCloudExternalId) SetApprovers(v []IdentityReferenceWithId)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *NonEmployeeSourceWithCloudExternalId) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetAccountManagers + +`func (o *NonEmployeeSourceWithCloudExternalId) GetAccountManagers() []IdentityReferenceWithId` + +GetAccountManagers returns the AccountManagers field if non-nil, zero value otherwise. + +### GetAccountManagersOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetAccountManagersOk() (*[]IdentityReferenceWithId, bool)` + +GetAccountManagersOk returns a tuple with the AccountManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountManagers + +`func (o *NonEmployeeSourceWithCloudExternalId) SetAccountManagers(v []IdentityReferenceWithId)` + +SetAccountManagers sets AccountManagers field to given value. + +### HasAccountManagers + +`func (o *NonEmployeeSourceWithCloudExternalId) HasAccountManagers() bool` + +HasAccountManagers returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeSourceWithCloudExternalId) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeSourceWithCloudExternalId) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeSourceWithCloudExternalId) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeSourceWithCloudExternalId) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeSourceWithCloudExternalId) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeSourceWithCloudExternalId) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetNonEmployeeCount + +`func (o *NonEmployeeSourceWithCloudExternalId) GetNonEmployeeCount() int32` + +GetNonEmployeeCount returns the NonEmployeeCount field if non-nil, zero value otherwise. + +### GetNonEmployeeCountOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetNonEmployeeCountOk() (*int32, bool)` + +GetNonEmployeeCountOk returns a tuple with the NonEmployeeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeCount + +`func (o *NonEmployeeSourceWithCloudExternalId) SetNonEmployeeCount(v int32)` + +SetNonEmployeeCount sets NonEmployeeCount field to given value. + +### HasNonEmployeeCount + +`func (o *NonEmployeeSourceWithCloudExternalId) HasNonEmployeeCount() bool` + +HasNonEmployeeCount returns a boolean if a field has been set. + +### SetNonEmployeeCountNil + +`func (o *NonEmployeeSourceWithCloudExternalId) SetNonEmployeeCountNil(b bool)` + + SetNonEmployeeCountNil sets the value for NonEmployeeCount to be an explicit nil + +### UnsetNonEmployeeCount +`func (o *NonEmployeeSourceWithCloudExternalId) UnsetNonEmployeeCount()` + +UnsetNonEmployeeCount ensures that no value is present for NonEmployeeCount, not even an explicit nil +### GetCloudExternalId + +`func (o *NonEmployeeSourceWithCloudExternalId) GetCloudExternalId() string` + +GetCloudExternalId returns the CloudExternalId field if non-nil, zero value otherwise. + +### GetCloudExternalIdOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetCloudExternalIdOk() (*string, bool)` + +GetCloudExternalIdOk returns a tuple with the CloudExternalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudExternalId + +`func (o *NonEmployeeSourceWithCloudExternalId) SetCloudExternalId(v string)` + +SetCloudExternalId sets CloudExternalId field to given value. + +### HasCloudExternalId + +`func (o *NonEmployeeSourceWithCloudExternalId) HasCloudExternalId() bool` + +HasCloudExternalId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSourceWithNECount.md new file mode 100644 index 000000000..a474a4f48 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NonEmployeeSourceWithNECount.md @@ -0,0 +1,272 @@ +--- +id: beta-non-employee-source-with-ne-count +title: NonEmployeeSourceWithNECount +pagination_label: NonEmployeeSourceWithNECount +sidebar_label: NonEmployeeSourceWithNECount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceWithNECount', 'BetaNonEmployeeSourceWithNECount'] +slug: /tools/sdk/go/beta/models/non-employee-source-with-ne-count +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithNECount', 'BetaNonEmployeeSourceWithNECount'] +--- + +# NonEmployeeSourceWithNECount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**NonEmployeeCount** | Pointer to **int32** | Number of non-employee records associated with this source. This value is 'null' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional] + +## Methods + +### NewNonEmployeeSourceWithNECount + +`func NewNonEmployeeSourceWithNECount() *NonEmployeeSourceWithNECount` + +NewNonEmployeeSourceWithNECount instantiates a new NonEmployeeSourceWithNECount 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 + +### NewNonEmployeeSourceWithNECountWithDefaults + +`func NewNonEmployeeSourceWithNECountWithDefaults() *NonEmployeeSourceWithNECount` + +NewNonEmployeeSourceWithNECountWithDefaults instantiates a new NonEmployeeSourceWithNECount 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 + +### GetId + +`func (o *NonEmployeeSourceWithNECount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSourceWithNECount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSourceWithNECount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSourceWithNECount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSourceWithNECount) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSourceWithNECount) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSourceWithNECount) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSourceWithNECount) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSourceWithNECount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceWithNECount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceWithNECount) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSourceWithNECount) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSourceWithNECount) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceWithNECount) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceWithNECount) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSourceWithNECount) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetApprovers + +`func (o *NonEmployeeSourceWithNECount) GetApprovers() []IdentityReferenceWithId` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *NonEmployeeSourceWithNECount) GetApproversOk() (*[]IdentityReferenceWithId, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *NonEmployeeSourceWithNECount) SetApprovers(v []IdentityReferenceWithId)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *NonEmployeeSourceWithNECount) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetAccountManagers + +`func (o *NonEmployeeSourceWithNECount) GetAccountManagers() []IdentityReferenceWithId` + +GetAccountManagers returns the AccountManagers field if non-nil, zero value otherwise. + +### GetAccountManagersOk + +`func (o *NonEmployeeSourceWithNECount) GetAccountManagersOk() (*[]IdentityReferenceWithId, bool)` + +GetAccountManagersOk returns a tuple with the AccountManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountManagers + +`func (o *NonEmployeeSourceWithNECount) SetAccountManagers(v []IdentityReferenceWithId)` + +SetAccountManagers sets AccountManagers field to given value. + +### HasAccountManagers + +`func (o *NonEmployeeSourceWithNECount) HasAccountManagers() bool` + +HasAccountManagers returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeSourceWithNECount) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeSourceWithNECount) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeSourceWithNECount) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeSourceWithNECount) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeSourceWithNECount) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeSourceWithNECount) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeSourceWithNECount) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeSourceWithNECount) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetNonEmployeeCount + +`func (o *NonEmployeeSourceWithNECount) GetNonEmployeeCount() int32` + +GetNonEmployeeCount returns the NonEmployeeCount field if non-nil, zero value otherwise. + +### GetNonEmployeeCountOk + +`func (o *NonEmployeeSourceWithNECount) GetNonEmployeeCountOk() (*int32, bool)` + +GetNonEmployeeCountOk returns a tuple with the NonEmployeeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeCount + +`func (o *NonEmployeeSourceWithNECount) SetNonEmployeeCount(v int32)` + +SetNonEmployeeCount sets NonEmployeeCount field to given value. + +### HasNonEmployeeCount + +`func (o *NonEmployeeSourceWithNECount) HasNonEmployeeCount() bool` + +HasNonEmployeeCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/NotificationTemplateContext.md b/docs/tools/sdk/go/Reference/Beta/Models/NotificationTemplateContext.md new file mode 100644 index 000000000..6392b960e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/NotificationTemplateContext.md @@ -0,0 +1,116 @@ +--- +id: beta-notification-template-context +title: NotificationTemplateContext +pagination_label: NotificationTemplateContext +sidebar_label: NotificationTemplateContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NotificationTemplateContext', 'BetaNotificationTemplateContext'] +slug: /tools/sdk/go/beta/models/notification-template-context +tags: ['SDK', 'Software Development Kit', 'NotificationTemplateContext', 'BetaNotificationTemplateContext'] +--- + +# NotificationTemplateContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to **map[string]interface{}** | A JSON object that stores the context. | [optional] +**Created** | Pointer to **SailPointTime** | When the global context was created | [optional] +**Modified** | Pointer to **SailPointTime** | When the global context was last modified | [optional] + +## Methods + +### NewNotificationTemplateContext + +`func NewNotificationTemplateContext() *NotificationTemplateContext` + +NewNotificationTemplateContext instantiates a new NotificationTemplateContext 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 + +### NewNotificationTemplateContextWithDefaults + +`func NewNotificationTemplateContextWithDefaults() *NotificationTemplateContext` + +NewNotificationTemplateContextWithDefaults instantiates a new NotificationTemplateContext 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 + +### GetAttributes + +`func (o *NotificationTemplateContext) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *NotificationTemplateContext) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *NotificationTemplateContext) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *NotificationTemplateContext) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetCreated + +`func (o *NotificationTemplateContext) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NotificationTemplateContext) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NotificationTemplateContext) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NotificationTemplateContext) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *NotificationTemplateContext) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NotificationTemplateContext) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NotificationTemplateContext) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NotificationTemplateContext) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ObjectExportImportOptions.md b/docs/tools/sdk/go/Reference/Beta/Models/ObjectExportImportOptions.md new file mode 100644 index 000000000..1ee404612 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ObjectExportImportOptions.md @@ -0,0 +1,90 @@ +--- +id: beta-object-export-import-options +title: ObjectExportImportOptions +pagination_label: ObjectExportImportOptions +sidebar_label: ObjectExportImportOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectExportImportOptions', 'BetaObjectExportImportOptions'] +slug: /tools/sdk/go/beta/models/object-export-import-options +tags: ['SDK', 'Software Development Kit', 'ObjectExportImportOptions', 'BetaObjectExportImportOptions'] +--- + +# ObjectExportImportOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludedIds** | Pointer to **[]string** | Object ids to be included in an import or export. | [optional] +**IncludedNames** | Pointer to **[]string** | Object names to be included in an import or export. | [optional] + +## Methods + +### NewObjectExportImportOptions + +`func NewObjectExportImportOptions() *ObjectExportImportOptions` + +NewObjectExportImportOptions instantiates a new ObjectExportImportOptions 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 + +### NewObjectExportImportOptionsWithDefaults + +`func NewObjectExportImportOptionsWithDefaults() *ObjectExportImportOptions` + +NewObjectExportImportOptionsWithDefaults instantiates a new ObjectExportImportOptions 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 + +### GetIncludedIds + +`func (o *ObjectExportImportOptions) GetIncludedIds() []string` + +GetIncludedIds returns the IncludedIds field if non-nil, zero value otherwise. + +### GetIncludedIdsOk + +`func (o *ObjectExportImportOptions) GetIncludedIdsOk() (*[]string, bool)` + +GetIncludedIdsOk returns a tuple with the IncludedIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludedIds + +`func (o *ObjectExportImportOptions) SetIncludedIds(v []string)` + +SetIncludedIds sets IncludedIds field to given value. + +### HasIncludedIds + +`func (o *ObjectExportImportOptions) HasIncludedIds() bool` + +HasIncludedIds returns a boolean if a field has been set. + +### GetIncludedNames + +`func (o *ObjectExportImportOptions) GetIncludedNames() []string` + +GetIncludedNames returns the IncludedNames field if non-nil, zero value otherwise. + +### GetIncludedNamesOk + +`func (o *ObjectExportImportOptions) GetIncludedNamesOk() (*[]string, bool)` + +GetIncludedNamesOk returns a tuple with the IncludedNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludedNames + +`func (o *ObjectExportImportOptions) SetIncludedNames(v []string)` + +SetIncludedNames sets IncludedNames field to given value. + +### HasIncludedNames + +`func (o *ObjectExportImportOptions) HasIncludedNames() bool` + +HasIncludedNames returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ObjectImportResult.md b/docs/tools/sdk/go/Reference/Beta/Models/ObjectImportResult.md new file mode 100644 index 000000000..258af93c6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ObjectImportResult.md @@ -0,0 +1,122 @@ +--- +id: beta-object-import-result +title: ObjectImportResult +pagination_label: ObjectImportResult +sidebar_label: ObjectImportResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectImportResult', 'BetaObjectImportResult'] +slug: /tools/sdk/go/beta/models/object-import-result +tags: ['SDK', 'Software Development Kit', 'ObjectImportResult', 'BetaObjectImportResult'] +--- + +# ObjectImportResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Infos** | [**[]SpConfigMessage**](sp-config-message) | Informational messages returned from the target service on import. | +**Warnings** | [**[]SpConfigMessage**](sp-config-message) | Warning messages returned from the target service on import. | +**Errors** | [**[]SpConfigMessage**](sp-config-message) | Error messages returned from the target service on import. | +**ImportedObjects** | [**[]ImportObject**](import-object) | References to objects that were created or updated by the import. | + +## Methods + +### NewObjectImportResult + +`func NewObjectImportResult(infos []SpConfigMessage, warnings []SpConfigMessage, errors []SpConfigMessage, importedObjects []ImportObject, ) *ObjectImportResult` + +NewObjectImportResult instantiates a new ObjectImportResult 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 + +### NewObjectImportResultWithDefaults + +`func NewObjectImportResultWithDefaults() *ObjectImportResult` + +NewObjectImportResultWithDefaults instantiates a new ObjectImportResult 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 + +### GetInfos + +`func (o *ObjectImportResult) GetInfos() []SpConfigMessage` + +GetInfos returns the Infos field if non-nil, zero value otherwise. + +### GetInfosOk + +`func (o *ObjectImportResult) GetInfosOk() (*[]SpConfigMessage, bool)` + +GetInfosOk returns a tuple with the Infos field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfos + +`func (o *ObjectImportResult) SetInfos(v []SpConfigMessage)` + +SetInfos sets Infos field to given value. + + +### GetWarnings + +`func (o *ObjectImportResult) GetWarnings() []SpConfigMessage` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *ObjectImportResult) GetWarningsOk() (*[]SpConfigMessage, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *ObjectImportResult) SetWarnings(v []SpConfigMessage)` + +SetWarnings sets Warnings field to given value. + + +### GetErrors + +`func (o *ObjectImportResult) GetErrors() []SpConfigMessage` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *ObjectImportResult) GetErrorsOk() (*[]SpConfigMessage, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *ObjectImportResult) SetErrors(v []SpConfigMessage)` + +SetErrors sets Errors field to given value. + + +### GetImportedObjects + +`func (o *ObjectImportResult) GetImportedObjects() []ImportObject` + +GetImportedObjects returns the ImportedObjects field if non-nil, zero value otherwise. + +### GetImportedObjectsOk + +`func (o *ObjectImportResult) GetImportedObjectsOk() (*[]ImportObject, bool)` + +GetImportedObjectsOk returns a tuple with the ImportedObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImportedObjects + +`func (o *ObjectImportResult) SetImportedObjects(v []ImportObject)` + +SetImportedObjects sets ImportedObjects field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/OktaVerificationRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/OktaVerificationRequest.md new file mode 100644 index 000000000..65bd3771f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/OktaVerificationRequest.md @@ -0,0 +1,59 @@ +--- +id: beta-okta-verification-request +title: OktaVerificationRequest +pagination_label: OktaVerificationRequest +sidebar_label: OktaVerificationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OktaVerificationRequest', 'BetaOktaVerificationRequest'] +slug: /tools/sdk/go/beta/models/okta-verification-request +tags: ['SDK', 'Software Development Kit', 'OktaVerificationRequest', 'BetaOktaVerificationRequest'] +--- + +# OktaVerificationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **string** | User identifier for Verification request. The value of the user's attribute. | + +## Methods + +### NewOktaVerificationRequest + +`func NewOktaVerificationRequest(userId string, ) *OktaVerificationRequest` + +NewOktaVerificationRequest instantiates a new OktaVerificationRequest 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 + +### NewOktaVerificationRequestWithDefaults + +`func NewOktaVerificationRequestWithDefaults() *OktaVerificationRequest` + +NewOktaVerificationRequestWithDefaults instantiates a new OktaVerificationRequest 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 + +### GetUserId + +`func (o *OktaVerificationRequest) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *OktaVerificationRequest) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *OktaVerificationRequest) SetUserId(v string)` + +SetUserId sets UserId field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/OrgConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/OrgConfig.md new file mode 100644 index 000000000..4bb9300ce --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/OrgConfig.md @@ -0,0 +1,348 @@ +--- +id: beta-org-config +title: OrgConfig +pagination_label: OrgConfig +sidebar_label: OrgConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OrgConfig', 'BetaOrgConfig'] +slug: /tools/sdk/go/beta/models/org-config +tags: ['SDK', 'Software Development Kit', 'OrgConfig', 'BetaOrgConfig'] +--- + +# OrgConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrgName** | Pointer to **string** | The name of the org. | [optional] +**TimeZone** | Pointer to **string** | The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones | [optional] +**LcsChangeHonorsSourceEnableFeature** | Pointer to **bool** | Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org. | [optional] +**ArmCustomerId** | Pointer to **NullableString** | ARM Customer ID | [optional] +**ArmSapSystemIdMappings** | Pointer to **NullableString** | A list of IDN::sourceId to ARM::systemId mappings. | [optional] +**ArmAuth** | Pointer to **NullableString** | ARM authentication string | [optional] +**ArmDb** | Pointer to **NullableString** | ARM database name | [optional] +**ArmSsoUrl** | Pointer to **NullableString** | ARM SSO URL | [optional] +**IaiEnableCertificationRecommendations** | Pointer to **bool** | Flag to determine whether IAI Certification Recommendations are enabled for the current org | [optional] +**SodReportConfigs** | Pointer to [**[]ReportConfigDTO**](report-config-dto) | | [optional] + +## Methods + +### NewOrgConfig + +`func NewOrgConfig() *OrgConfig` + +NewOrgConfig instantiates a new OrgConfig 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 + +### NewOrgConfigWithDefaults + +`func NewOrgConfigWithDefaults() *OrgConfig` + +NewOrgConfigWithDefaults instantiates a new OrgConfig 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 + +### GetOrgName + +`func (o *OrgConfig) GetOrgName() string` + +GetOrgName returns the OrgName field if non-nil, zero value otherwise. + +### GetOrgNameOk + +`func (o *OrgConfig) GetOrgNameOk() (*string, bool)` + +GetOrgNameOk returns a tuple with the OrgName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgName + +`func (o *OrgConfig) SetOrgName(v string)` + +SetOrgName sets OrgName field to given value. + +### HasOrgName + +`func (o *OrgConfig) HasOrgName() bool` + +HasOrgName returns a boolean if a field has been set. + +### GetTimeZone + +`func (o *OrgConfig) GetTimeZone() string` + +GetTimeZone returns the TimeZone field if non-nil, zero value otherwise. + +### GetTimeZoneOk + +`func (o *OrgConfig) GetTimeZoneOk() (*string, bool)` + +GetTimeZoneOk returns a tuple with the TimeZone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZone + +`func (o *OrgConfig) SetTimeZone(v string)` + +SetTimeZone sets TimeZone field to given value. + +### HasTimeZone + +`func (o *OrgConfig) HasTimeZone() bool` + +HasTimeZone returns a boolean if a field has been set. + +### GetLcsChangeHonorsSourceEnableFeature + +`func (o *OrgConfig) GetLcsChangeHonorsSourceEnableFeature() bool` + +GetLcsChangeHonorsSourceEnableFeature returns the LcsChangeHonorsSourceEnableFeature field if non-nil, zero value otherwise. + +### GetLcsChangeHonorsSourceEnableFeatureOk + +`func (o *OrgConfig) GetLcsChangeHonorsSourceEnableFeatureOk() (*bool, bool)` + +GetLcsChangeHonorsSourceEnableFeatureOk returns a tuple with the LcsChangeHonorsSourceEnableFeature field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLcsChangeHonorsSourceEnableFeature + +`func (o *OrgConfig) SetLcsChangeHonorsSourceEnableFeature(v bool)` + +SetLcsChangeHonorsSourceEnableFeature sets LcsChangeHonorsSourceEnableFeature field to given value. + +### HasLcsChangeHonorsSourceEnableFeature + +`func (o *OrgConfig) HasLcsChangeHonorsSourceEnableFeature() bool` + +HasLcsChangeHonorsSourceEnableFeature returns a boolean if a field has been set. + +### GetArmCustomerId + +`func (o *OrgConfig) GetArmCustomerId() string` + +GetArmCustomerId returns the ArmCustomerId field if non-nil, zero value otherwise. + +### GetArmCustomerIdOk + +`func (o *OrgConfig) GetArmCustomerIdOk() (*string, bool)` + +GetArmCustomerIdOk returns a tuple with the ArmCustomerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArmCustomerId + +`func (o *OrgConfig) SetArmCustomerId(v string)` + +SetArmCustomerId sets ArmCustomerId field to given value. + +### HasArmCustomerId + +`func (o *OrgConfig) HasArmCustomerId() bool` + +HasArmCustomerId returns a boolean if a field has been set. + +### SetArmCustomerIdNil + +`func (o *OrgConfig) SetArmCustomerIdNil(b bool)` + + SetArmCustomerIdNil sets the value for ArmCustomerId to be an explicit nil + +### UnsetArmCustomerId +`func (o *OrgConfig) UnsetArmCustomerId()` + +UnsetArmCustomerId ensures that no value is present for ArmCustomerId, not even an explicit nil +### GetArmSapSystemIdMappings + +`func (o *OrgConfig) GetArmSapSystemIdMappings() string` + +GetArmSapSystemIdMappings returns the ArmSapSystemIdMappings field if non-nil, zero value otherwise. + +### GetArmSapSystemIdMappingsOk + +`func (o *OrgConfig) GetArmSapSystemIdMappingsOk() (*string, bool)` + +GetArmSapSystemIdMappingsOk returns a tuple with the ArmSapSystemIdMappings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArmSapSystemIdMappings + +`func (o *OrgConfig) SetArmSapSystemIdMappings(v string)` + +SetArmSapSystemIdMappings sets ArmSapSystemIdMappings field to given value. + +### HasArmSapSystemIdMappings + +`func (o *OrgConfig) HasArmSapSystemIdMappings() bool` + +HasArmSapSystemIdMappings returns a boolean if a field has been set. + +### SetArmSapSystemIdMappingsNil + +`func (o *OrgConfig) SetArmSapSystemIdMappingsNil(b bool)` + + SetArmSapSystemIdMappingsNil sets the value for ArmSapSystemIdMappings to be an explicit nil + +### UnsetArmSapSystemIdMappings +`func (o *OrgConfig) UnsetArmSapSystemIdMappings()` + +UnsetArmSapSystemIdMappings ensures that no value is present for ArmSapSystemIdMappings, not even an explicit nil +### GetArmAuth + +`func (o *OrgConfig) GetArmAuth() string` + +GetArmAuth returns the ArmAuth field if non-nil, zero value otherwise. + +### GetArmAuthOk + +`func (o *OrgConfig) GetArmAuthOk() (*string, bool)` + +GetArmAuthOk returns a tuple with the ArmAuth field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArmAuth + +`func (o *OrgConfig) SetArmAuth(v string)` + +SetArmAuth sets ArmAuth field to given value. + +### HasArmAuth + +`func (o *OrgConfig) HasArmAuth() bool` + +HasArmAuth returns a boolean if a field has been set. + +### SetArmAuthNil + +`func (o *OrgConfig) SetArmAuthNil(b bool)` + + SetArmAuthNil sets the value for ArmAuth to be an explicit nil + +### UnsetArmAuth +`func (o *OrgConfig) UnsetArmAuth()` + +UnsetArmAuth ensures that no value is present for ArmAuth, not even an explicit nil +### GetArmDb + +`func (o *OrgConfig) GetArmDb() string` + +GetArmDb returns the ArmDb field if non-nil, zero value otherwise. + +### GetArmDbOk + +`func (o *OrgConfig) GetArmDbOk() (*string, bool)` + +GetArmDbOk returns a tuple with the ArmDb field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArmDb + +`func (o *OrgConfig) SetArmDb(v string)` + +SetArmDb sets ArmDb field to given value. + +### HasArmDb + +`func (o *OrgConfig) HasArmDb() bool` + +HasArmDb returns a boolean if a field has been set. + +### SetArmDbNil + +`func (o *OrgConfig) SetArmDbNil(b bool)` + + SetArmDbNil sets the value for ArmDb to be an explicit nil + +### UnsetArmDb +`func (o *OrgConfig) UnsetArmDb()` + +UnsetArmDb ensures that no value is present for ArmDb, not even an explicit nil +### GetArmSsoUrl + +`func (o *OrgConfig) GetArmSsoUrl() string` + +GetArmSsoUrl returns the ArmSsoUrl field if non-nil, zero value otherwise. + +### GetArmSsoUrlOk + +`func (o *OrgConfig) GetArmSsoUrlOk() (*string, bool)` + +GetArmSsoUrlOk returns a tuple with the ArmSsoUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArmSsoUrl + +`func (o *OrgConfig) SetArmSsoUrl(v string)` + +SetArmSsoUrl sets ArmSsoUrl field to given value. + +### HasArmSsoUrl + +`func (o *OrgConfig) HasArmSsoUrl() bool` + +HasArmSsoUrl returns a boolean if a field has been set. + +### SetArmSsoUrlNil + +`func (o *OrgConfig) SetArmSsoUrlNil(b bool)` + + SetArmSsoUrlNil sets the value for ArmSsoUrl to be an explicit nil + +### UnsetArmSsoUrl +`func (o *OrgConfig) UnsetArmSsoUrl()` + +UnsetArmSsoUrl ensures that no value is present for ArmSsoUrl, not even an explicit nil +### GetIaiEnableCertificationRecommendations + +`func (o *OrgConfig) GetIaiEnableCertificationRecommendations() bool` + +GetIaiEnableCertificationRecommendations returns the IaiEnableCertificationRecommendations field if non-nil, zero value otherwise. + +### GetIaiEnableCertificationRecommendationsOk + +`func (o *OrgConfig) GetIaiEnableCertificationRecommendationsOk() (*bool, bool)` + +GetIaiEnableCertificationRecommendationsOk returns a tuple with the IaiEnableCertificationRecommendations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIaiEnableCertificationRecommendations + +`func (o *OrgConfig) SetIaiEnableCertificationRecommendations(v bool)` + +SetIaiEnableCertificationRecommendations sets IaiEnableCertificationRecommendations field to given value. + +### HasIaiEnableCertificationRecommendations + +`func (o *OrgConfig) HasIaiEnableCertificationRecommendations() bool` + +HasIaiEnableCertificationRecommendations returns a boolean if a field has been set. + +### GetSodReportConfigs + +`func (o *OrgConfig) GetSodReportConfigs() []ReportConfigDTO` + +GetSodReportConfigs returns the SodReportConfigs field if non-nil, zero value otherwise. + +### GetSodReportConfigsOk + +`func (o *OrgConfig) GetSodReportConfigsOk() (*[]ReportConfigDTO, bool)` + +GetSodReportConfigsOk returns a tuple with the SodReportConfigs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodReportConfigs + +`func (o *OrgConfig) SetSodReportConfigs(v []ReportConfigDTO)` + +SetSodReportConfigs sets SodReportConfigs field to given value. + +### HasSodReportConfigs + +`func (o *OrgConfig) HasSodReportConfigs() bool` + +HasSodReportConfigs returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Outlier.md b/docs/tools/sdk/go/Reference/Beta/Models/Outlier.md new file mode 100644 index 000000000..cf7155ead --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Outlier.md @@ -0,0 +1,354 @@ +--- +id: beta-outlier +title: Outlier +pagination_label: Outlier +sidebar_label: Outlier +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Outlier', 'BetaOutlier'] +slug: /tools/sdk/go/beta/models/outlier +tags: ['SDK', 'Software Development Kit', 'Outlier', 'BetaOutlier'] +--- + +# Outlier + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity's unique identifier for the outlier record | [optional] +**IdentityId** | Pointer to **string** | The ID of the identity that is detected as an outlier | [optional] +**Type** | Pointer to **string** | The type of outlier summary | [optional] +**FirstDetectionDate** | Pointer to **SailPointTime** | The first date the outlier was detected | [optional] +**LatestDetectionDate** | Pointer to **SailPointTime** | The most recent date the outlier was detected | [optional] +**Ignored** | Pointer to **bool** | Flag whether or not the outlier has been ignored | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Object containing mapped identity attributes | [optional] +**Score** | Pointer to **float32** | The outlier score determined by the detection engine ranging from 0..1 | [optional] +**UnignoreType** | Pointer to **NullableString** | Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored | [optional] +**UnignoreDate** | Pointer to **NullableTime** | shows date when last time has been unignored outlier | [optional] +**IgnoreDate** | Pointer to **NullableTime** | shows date when last time has been ignored outlier | [optional] + +## Methods + +### NewOutlier + +`func NewOutlier() *Outlier` + +NewOutlier instantiates a new Outlier 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 + +### NewOutlierWithDefaults + +`func NewOutlierWithDefaults() *Outlier` + +NewOutlierWithDefaults instantiates a new Outlier 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 + +### GetId + +`func (o *Outlier) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Outlier) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Outlier) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Outlier) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *Outlier) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *Outlier) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *Outlier) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *Outlier) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetType + +`func (o *Outlier) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Outlier) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Outlier) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Outlier) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetFirstDetectionDate + +`func (o *Outlier) GetFirstDetectionDate() SailPointTime` + +GetFirstDetectionDate returns the FirstDetectionDate field if non-nil, zero value otherwise. + +### GetFirstDetectionDateOk + +`func (o *Outlier) GetFirstDetectionDateOk() (*SailPointTime, bool)` + +GetFirstDetectionDateOk returns a tuple with the FirstDetectionDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstDetectionDate + +`func (o *Outlier) SetFirstDetectionDate(v SailPointTime)` + +SetFirstDetectionDate sets FirstDetectionDate field to given value. + +### HasFirstDetectionDate + +`func (o *Outlier) HasFirstDetectionDate() bool` + +HasFirstDetectionDate returns a boolean if a field has been set. + +### GetLatestDetectionDate + +`func (o *Outlier) GetLatestDetectionDate() SailPointTime` + +GetLatestDetectionDate returns the LatestDetectionDate field if non-nil, zero value otherwise. + +### GetLatestDetectionDateOk + +`func (o *Outlier) GetLatestDetectionDateOk() (*SailPointTime, bool)` + +GetLatestDetectionDateOk returns a tuple with the LatestDetectionDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLatestDetectionDate + +`func (o *Outlier) SetLatestDetectionDate(v SailPointTime)` + +SetLatestDetectionDate sets LatestDetectionDate field to given value. + +### HasLatestDetectionDate + +`func (o *Outlier) HasLatestDetectionDate() bool` + +HasLatestDetectionDate returns a boolean if a field has been set. + +### GetIgnored + +`func (o *Outlier) GetIgnored() bool` + +GetIgnored returns the Ignored field if non-nil, zero value otherwise. + +### GetIgnoredOk + +`func (o *Outlier) GetIgnoredOk() (*bool, bool)` + +GetIgnoredOk returns a tuple with the Ignored field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIgnored + +`func (o *Outlier) SetIgnored(v bool)` + +SetIgnored sets Ignored field to given value. + +### HasIgnored + +`func (o *Outlier) HasIgnored() bool` + +HasIgnored returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Outlier) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Outlier) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Outlier) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Outlier) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetScore + +`func (o *Outlier) GetScore() float32` + +GetScore returns the Score field if non-nil, zero value otherwise. + +### GetScoreOk + +`func (o *Outlier) GetScoreOk() (*float32, bool)` + +GetScoreOk returns a tuple with the Score field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScore + +`func (o *Outlier) SetScore(v float32)` + +SetScore sets Score field to given value. + +### HasScore + +`func (o *Outlier) HasScore() bool` + +HasScore returns a boolean if a field has been set. + +### GetUnignoreType + +`func (o *Outlier) GetUnignoreType() string` + +GetUnignoreType returns the UnignoreType field if non-nil, zero value otherwise. + +### GetUnignoreTypeOk + +`func (o *Outlier) GetUnignoreTypeOk() (*string, bool)` + +GetUnignoreTypeOk returns a tuple with the UnignoreType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnignoreType + +`func (o *Outlier) SetUnignoreType(v string)` + +SetUnignoreType sets UnignoreType field to given value. + +### HasUnignoreType + +`func (o *Outlier) HasUnignoreType() bool` + +HasUnignoreType returns a boolean if a field has been set. + +### SetUnignoreTypeNil + +`func (o *Outlier) SetUnignoreTypeNil(b bool)` + + SetUnignoreTypeNil sets the value for UnignoreType to be an explicit nil + +### UnsetUnignoreType +`func (o *Outlier) UnsetUnignoreType()` + +UnsetUnignoreType ensures that no value is present for UnignoreType, not even an explicit nil +### GetUnignoreDate + +`func (o *Outlier) GetUnignoreDate() SailPointTime` + +GetUnignoreDate returns the UnignoreDate field if non-nil, zero value otherwise. + +### GetUnignoreDateOk + +`func (o *Outlier) GetUnignoreDateOk() (*SailPointTime, bool)` + +GetUnignoreDateOk returns a tuple with the UnignoreDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnignoreDate + +`func (o *Outlier) SetUnignoreDate(v SailPointTime)` + +SetUnignoreDate sets UnignoreDate field to given value. + +### HasUnignoreDate + +`func (o *Outlier) HasUnignoreDate() bool` + +HasUnignoreDate returns a boolean if a field has been set. + +### SetUnignoreDateNil + +`func (o *Outlier) SetUnignoreDateNil(b bool)` + + SetUnignoreDateNil sets the value for UnignoreDate to be an explicit nil + +### UnsetUnignoreDate +`func (o *Outlier) UnsetUnignoreDate()` + +UnsetUnignoreDate ensures that no value is present for UnignoreDate, not even an explicit nil +### GetIgnoreDate + +`func (o *Outlier) GetIgnoreDate() SailPointTime` + +GetIgnoreDate returns the IgnoreDate field if non-nil, zero value otherwise. + +### GetIgnoreDateOk + +`func (o *Outlier) GetIgnoreDateOk() (*SailPointTime, bool)` + +GetIgnoreDateOk returns a tuple with the IgnoreDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIgnoreDate + +`func (o *Outlier) SetIgnoreDate(v SailPointTime)` + +SetIgnoreDate sets IgnoreDate field to given value. + +### HasIgnoreDate + +`func (o *Outlier) HasIgnoreDate() bool` + +HasIgnoreDate returns a boolean if a field has been set. + +### SetIgnoreDateNil + +`func (o *Outlier) SetIgnoreDateNil(b bool)` + + SetIgnoreDateNil sets the value for IgnoreDate to be an explicit nil + +### UnsetIgnoreDate +`func (o *Outlier) UnsetIgnoreDate()` + +UnsetIgnoreDate ensures that no value is present for IgnoreDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/OutlierContributingFeature.md b/docs/tools/sdk/go/Reference/Beta/Models/OutlierContributingFeature.md new file mode 100644 index 000000000..925576dc4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/OutlierContributingFeature.md @@ -0,0 +1,246 @@ +--- +id: beta-outlier-contributing-feature +title: OutlierContributingFeature +pagination_label: OutlierContributingFeature +sidebar_label: OutlierContributingFeature +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierContributingFeature', 'BetaOutlierContributingFeature'] +slug: /tools/sdk/go/beta/models/outlier-contributing-feature +tags: ['SDK', 'Software Development Kit', 'OutlierContributingFeature', 'BetaOutlierContributingFeature'] +--- + +# OutlierContributingFeature + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Contributing feature id | [optional] +**Name** | Pointer to **string** | The name of the feature | [optional] +**ValueType** | Pointer to **string** | The data type of the value field | [optional] +**Value** | Pointer to [**OutlierContributingFeatureValue**](outlier-contributing-feature-value) | | [optional] +**Importance** | Pointer to **float32** | The importance of the feature. This can also be a negative value | [optional] +**DisplayName** | Pointer to **string** | The (translated if header is passed) displayName for the feature | [optional] +**Description** | Pointer to **string** | The (translated if header is passed) description for the feature | [optional] +**TranslationMessages** | Pointer to [**OutlierFeatureTranslation**](outlier-feature-translation) | | [optional] + +## Methods + +### NewOutlierContributingFeature + +`func NewOutlierContributingFeature() *OutlierContributingFeature` + +NewOutlierContributingFeature instantiates a new OutlierContributingFeature 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 + +### NewOutlierContributingFeatureWithDefaults + +`func NewOutlierContributingFeatureWithDefaults() *OutlierContributingFeature` + +NewOutlierContributingFeatureWithDefaults instantiates a new OutlierContributingFeature 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 + +### GetId + +`func (o *OutlierContributingFeature) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OutlierContributingFeature) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OutlierContributingFeature) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OutlierContributingFeature) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OutlierContributingFeature) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OutlierContributingFeature) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OutlierContributingFeature) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OutlierContributingFeature) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValueType + +`func (o *OutlierContributingFeature) GetValueType() string` + +GetValueType returns the ValueType field if non-nil, zero value otherwise. + +### GetValueTypeOk + +`func (o *OutlierContributingFeature) GetValueTypeOk() (*string, bool)` + +GetValueTypeOk returns a tuple with the ValueType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValueType + +`func (o *OutlierContributingFeature) SetValueType(v string)` + +SetValueType sets ValueType field to given value. + +### HasValueType + +`func (o *OutlierContributingFeature) HasValueType() bool` + +HasValueType returns a boolean if a field has been set. + +### GetValue + +`func (o *OutlierContributingFeature) GetValue() OutlierContributingFeatureValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *OutlierContributingFeature) GetValueOk() (*OutlierContributingFeatureValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *OutlierContributingFeature) SetValue(v OutlierContributingFeatureValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *OutlierContributingFeature) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetImportance + +`func (o *OutlierContributingFeature) GetImportance() float32` + +GetImportance returns the Importance field if non-nil, zero value otherwise. + +### GetImportanceOk + +`func (o *OutlierContributingFeature) GetImportanceOk() (*float32, bool)` + +GetImportanceOk returns a tuple with the Importance field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImportance + +`func (o *OutlierContributingFeature) SetImportance(v float32)` + +SetImportance sets Importance field to given value. + +### HasImportance + +`func (o *OutlierContributingFeature) HasImportance() bool` + +HasImportance returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *OutlierContributingFeature) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *OutlierContributingFeature) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *OutlierContributingFeature) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *OutlierContributingFeature) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *OutlierContributingFeature) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *OutlierContributingFeature) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *OutlierContributingFeature) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *OutlierContributingFeature) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetTranslationMessages + +`func (o *OutlierContributingFeature) GetTranslationMessages() OutlierFeatureTranslation` + +GetTranslationMessages returns the TranslationMessages field if non-nil, zero value otherwise. + +### GetTranslationMessagesOk + +`func (o *OutlierContributingFeature) GetTranslationMessagesOk() (*OutlierFeatureTranslation, bool)` + +GetTranslationMessagesOk returns a tuple with the TranslationMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslationMessages + +`func (o *OutlierContributingFeature) SetTranslationMessages(v OutlierFeatureTranslation)` + +SetTranslationMessages sets TranslationMessages field to given value. + +### HasTranslationMessages + +`func (o *OutlierContributingFeature) HasTranslationMessages() bool` + +HasTranslationMessages returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/OutlierContributingFeatureValue.md b/docs/tools/sdk/go/Reference/Beta/Models/OutlierContributingFeatureValue.md new file mode 100644 index 000000000..57e03679b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/OutlierContributingFeatureValue.md @@ -0,0 +1,38 @@ +--- +id: beta-outlier-contributing-feature-value +title: OutlierContributingFeatureValue +pagination_label: OutlierContributingFeatureValue +sidebar_label: OutlierContributingFeatureValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierContributingFeatureValue', 'BetaOutlierContributingFeatureValue'] +slug: /tools/sdk/go/beta/models/outlier-contributing-feature-value +tags: ['SDK', 'Software Development Kit', 'OutlierContributingFeatureValue', 'BetaOutlierContributingFeatureValue'] +--- + +# OutlierContributingFeatureValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewOutlierContributingFeatureValue + +`func NewOutlierContributingFeatureValue() *OutlierContributingFeatureValue` + +NewOutlierContributingFeatureValue instantiates a new OutlierContributingFeatureValue 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 + +### NewOutlierContributingFeatureValueWithDefaults + +`func NewOutlierContributingFeatureValueWithDefaults() *OutlierContributingFeatureValue` + +NewOutlierContributingFeatureValueWithDefaults instantiates a new OutlierContributingFeatureValue 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 + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/OutlierFeatureSummary.md b/docs/tools/sdk/go/Reference/Beta/Models/OutlierFeatureSummary.md new file mode 100644 index 000000000..1ef96ca59 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/OutlierFeatureSummary.md @@ -0,0 +1,246 @@ +--- +id: beta-outlier-feature-summary +title: OutlierFeatureSummary +pagination_label: OutlierFeatureSummary +sidebar_label: OutlierFeatureSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierFeatureSummary', 'BetaOutlierFeatureSummary'] +slug: /tools/sdk/go/beta/models/outlier-feature-summary +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureSummary', 'BetaOutlierFeatureSummary'] +--- + +# OutlierFeatureSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContributingFeatureName** | Pointer to **string** | Contributing feature name | [optional] +**IdentityOutlierDisplayName** | Pointer to **string** | Identity display name | [optional] +**OutlierFeatureDisplayValues** | Pointer to [**[]OutlierFeatureSummaryOutlierFeatureDisplayValuesInner**](outlier-feature-summary-outlier-feature-display-values-inner) | | [optional] +**FeatureDefinition** | Pointer to **string** | Definition of the feature | [optional] +**FeatureExplanation** | Pointer to **string** | Detailed explanation of the feature | [optional] +**PeerDisplayName** | Pointer to **string** | outlier's peer identity display name | [optional] +**PeerIdentityId** | Pointer to **string** | outlier's peer identity id | [optional] +**AccessItemReference** | Pointer to **map[string]interface{}** | Access Item reference | [optional] + +## Methods + +### NewOutlierFeatureSummary + +`func NewOutlierFeatureSummary() *OutlierFeatureSummary` + +NewOutlierFeatureSummary instantiates a new OutlierFeatureSummary 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 + +### NewOutlierFeatureSummaryWithDefaults + +`func NewOutlierFeatureSummaryWithDefaults() *OutlierFeatureSummary` + +NewOutlierFeatureSummaryWithDefaults instantiates a new OutlierFeatureSummary 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 + +### GetContributingFeatureName + +`func (o *OutlierFeatureSummary) GetContributingFeatureName() string` + +GetContributingFeatureName returns the ContributingFeatureName field if non-nil, zero value otherwise. + +### GetContributingFeatureNameOk + +`func (o *OutlierFeatureSummary) GetContributingFeatureNameOk() (*string, bool)` + +GetContributingFeatureNameOk returns a tuple with the ContributingFeatureName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContributingFeatureName + +`func (o *OutlierFeatureSummary) SetContributingFeatureName(v string)` + +SetContributingFeatureName sets ContributingFeatureName field to given value. + +### HasContributingFeatureName + +`func (o *OutlierFeatureSummary) HasContributingFeatureName() bool` + +HasContributingFeatureName returns a boolean if a field has been set. + +### GetIdentityOutlierDisplayName + +`func (o *OutlierFeatureSummary) GetIdentityOutlierDisplayName() string` + +GetIdentityOutlierDisplayName returns the IdentityOutlierDisplayName field if non-nil, zero value otherwise. + +### GetIdentityOutlierDisplayNameOk + +`func (o *OutlierFeatureSummary) GetIdentityOutlierDisplayNameOk() (*string, bool)` + +GetIdentityOutlierDisplayNameOk returns a tuple with the IdentityOutlierDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityOutlierDisplayName + +`func (o *OutlierFeatureSummary) SetIdentityOutlierDisplayName(v string)` + +SetIdentityOutlierDisplayName sets IdentityOutlierDisplayName field to given value. + +### HasIdentityOutlierDisplayName + +`func (o *OutlierFeatureSummary) HasIdentityOutlierDisplayName() bool` + +HasIdentityOutlierDisplayName returns a boolean if a field has been set. + +### GetOutlierFeatureDisplayValues + +`func (o *OutlierFeatureSummary) GetOutlierFeatureDisplayValues() []OutlierFeatureSummaryOutlierFeatureDisplayValuesInner` + +GetOutlierFeatureDisplayValues returns the OutlierFeatureDisplayValues field if non-nil, zero value otherwise. + +### GetOutlierFeatureDisplayValuesOk + +`func (o *OutlierFeatureSummary) GetOutlierFeatureDisplayValuesOk() (*[]OutlierFeatureSummaryOutlierFeatureDisplayValuesInner, bool)` + +GetOutlierFeatureDisplayValuesOk returns a tuple with the OutlierFeatureDisplayValues field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutlierFeatureDisplayValues + +`func (o *OutlierFeatureSummary) SetOutlierFeatureDisplayValues(v []OutlierFeatureSummaryOutlierFeatureDisplayValuesInner)` + +SetOutlierFeatureDisplayValues sets OutlierFeatureDisplayValues field to given value. + +### HasOutlierFeatureDisplayValues + +`func (o *OutlierFeatureSummary) HasOutlierFeatureDisplayValues() bool` + +HasOutlierFeatureDisplayValues returns a boolean if a field has been set. + +### GetFeatureDefinition + +`func (o *OutlierFeatureSummary) GetFeatureDefinition() string` + +GetFeatureDefinition returns the FeatureDefinition field if non-nil, zero value otherwise. + +### GetFeatureDefinitionOk + +`func (o *OutlierFeatureSummary) GetFeatureDefinitionOk() (*string, bool)` + +GetFeatureDefinitionOk returns a tuple with the FeatureDefinition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureDefinition + +`func (o *OutlierFeatureSummary) SetFeatureDefinition(v string)` + +SetFeatureDefinition sets FeatureDefinition field to given value. + +### HasFeatureDefinition + +`func (o *OutlierFeatureSummary) HasFeatureDefinition() bool` + +HasFeatureDefinition returns a boolean if a field has been set. + +### GetFeatureExplanation + +`func (o *OutlierFeatureSummary) GetFeatureExplanation() string` + +GetFeatureExplanation returns the FeatureExplanation field if non-nil, zero value otherwise. + +### GetFeatureExplanationOk + +`func (o *OutlierFeatureSummary) GetFeatureExplanationOk() (*string, bool)` + +GetFeatureExplanationOk returns a tuple with the FeatureExplanation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureExplanation + +`func (o *OutlierFeatureSummary) SetFeatureExplanation(v string)` + +SetFeatureExplanation sets FeatureExplanation field to given value. + +### HasFeatureExplanation + +`func (o *OutlierFeatureSummary) HasFeatureExplanation() bool` + +HasFeatureExplanation returns a boolean if a field has been set. + +### GetPeerDisplayName + +`func (o *OutlierFeatureSummary) GetPeerDisplayName() string` + +GetPeerDisplayName returns the PeerDisplayName field if non-nil, zero value otherwise. + +### GetPeerDisplayNameOk + +`func (o *OutlierFeatureSummary) GetPeerDisplayNameOk() (*string, bool)` + +GetPeerDisplayNameOk returns a tuple with the PeerDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPeerDisplayName + +`func (o *OutlierFeatureSummary) SetPeerDisplayName(v string)` + +SetPeerDisplayName sets PeerDisplayName field to given value. + +### HasPeerDisplayName + +`func (o *OutlierFeatureSummary) HasPeerDisplayName() bool` + +HasPeerDisplayName returns a boolean if a field has been set. + +### GetPeerIdentityId + +`func (o *OutlierFeatureSummary) GetPeerIdentityId() string` + +GetPeerIdentityId returns the PeerIdentityId field if non-nil, zero value otherwise. + +### GetPeerIdentityIdOk + +`func (o *OutlierFeatureSummary) GetPeerIdentityIdOk() (*string, bool)` + +GetPeerIdentityIdOk returns a tuple with the PeerIdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPeerIdentityId + +`func (o *OutlierFeatureSummary) SetPeerIdentityId(v string)` + +SetPeerIdentityId sets PeerIdentityId field to given value. + +### HasPeerIdentityId + +`func (o *OutlierFeatureSummary) HasPeerIdentityId() bool` + +HasPeerIdentityId returns a boolean if a field has been set. + +### GetAccessItemReference + +`func (o *OutlierFeatureSummary) GetAccessItemReference() map[string]interface{}` + +GetAccessItemReference returns the AccessItemReference field if non-nil, zero value otherwise. + +### GetAccessItemReferenceOk + +`func (o *OutlierFeatureSummary) GetAccessItemReferenceOk() (*map[string]interface{}, bool)` + +GetAccessItemReferenceOk returns a tuple with the AccessItemReference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItemReference + +`func (o *OutlierFeatureSummary) SetAccessItemReference(v map[string]interface{})` + +SetAccessItemReference sets AccessItemReference field to given value. + +### HasAccessItemReference + +`func (o *OutlierFeatureSummary) HasAccessItemReference() bool` + +HasAccessItemReference returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md b/docs/tools/sdk/go/Reference/Beta/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md new file mode 100644 index 000000000..60c895fda --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md @@ -0,0 +1,116 @@ +--- +id: beta-outlier-feature-summary-outlier-feature-display-values-inner +title: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +pagination_label: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +sidebar_label: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierFeatureSummaryOutlierFeatureDisplayValuesInner', 'BetaOutlierFeatureSummaryOutlierFeatureDisplayValuesInner'] +slug: /tools/sdk/go/beta/models/outlier-feature-summary-outlier-feature-display-values-inner +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureSummaryOutlierFeatureDisplayValuesInner', 'BetaOutlierFeatureSummaryOutlierFeatureDisplayValuesInner'] +--- + +# OutlierFeatureSummaryOutlierFeatureDisplayValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayName** | Pointer to **string** | display name | [optional] +**Value** | Pointer to **string** | value | [optional] +**ValueType** | Pointer to **string** | The data type of the value field | [optional] + +## Methods + +### NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInner + +`func NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInner() *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner` + +NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInner instantiates a new OutlierFeatureSummaryOutlierFeatureDisplayValuesInner 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 + +### NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInnerWithDefaults + +`func NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInnerWithDefaults() *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner` + +NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInnerWithDefaults instantiates a new OutlierFeatureSummaryOutlierFeatureDisplayValuesInner 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 + +### GetDisplayName + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetValue + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetValueType + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetValueType() string` + +GetValueType returns the ValueType field if non-nil, zero value otherwise. + +### GetValueTypeOk + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetValueTypeOk() (*string, bool)` + +GetValueTypeOk returns a tuple with the ValueType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValueType + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) SetValueType(v string)` + +SetValueType sets ValueType field to given value. + +### HasValueType + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) HasValueType() bool` + +HasValueType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/OutlierFeatureTranslation.md b/docs/tools/sdk/go/Reference/Beta/Models/OutlierFeatureTranslation.md new file mode 100644 index 000000000..59838b879 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/OutlierFeatureTranslation.md @@ -0,0 +1,90 @@ +--- +id: beta-outlier-feature-translation +title: OutlierFeatureTranslation +pagination_label: OutlierFeatureTranslation +sidebar_label: OutlierFeatureTranslation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierFeatureTranslation', 'BetaOutlierFeatureTranslation'] +slug: /tools/sdk/go/beta/models/outlier-feature-translation +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureTranslation', 'BetaOutlierFeatureTranslation'] +--- + +# OutlierFeatureTranslation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayName** | Pointer to [**TranslationMessage**](translation-message) | | [optional] +**Description** | Pointer to [**TranslationMessage**](translation-message) | | [optional] + +## Methods + +### NewOutlierFeatureTranslation + +`func NewOutlierFeatureTranslation() *OutlierFeatureTranslation` + +NewOutlierFeatureTranslation instantiates a new OutlierFeatureTranslation 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 + +### NewOutlierFeatureTranslationWithDefaults + +`func NewOutlierFeatureTranslationWithDefaults() *OutlierFeatureTranslation` + +NewOutlierFeatureTranslationWithDefaults instantiates a new OutlierFeatureTranslation 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 + +### GetDisplayName + +`func (o *OutlierFeatureTranslation) GetDisplayName() TranslationMessage` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *OutlierFeatureTranslation) GetDisplayNameOk() (*TranslationMessage, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *OutlierFeatureTranslation) SetDisplayName(v TranslationMessage)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *OutlierFeatureTranslation) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *OutlierFeatureTranslation) GetDescription() TranslationMessage` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *OutlierFeatureTranslation) GetDescriptionOk() (*TranslationMessage, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *OutlierFeatureTranslation) SetDescription(v TranslationMessage)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *OutlierFeatureTranslation) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/OutlierSummary.md b/docs/tools/sdk/go/Reference/Beta/Models/OutlierSummary.md new file mode 100644 index 000000000..4a3e74579 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/OutlierSummary.md @@ -0,0 +1,168 @@ +--- +id: beta-outlier-summary +title: OutlierSummary +pagination_label: OutlierSummary +sidebar_label: OutlierSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierSummary', 'BetaOutlierSummary'] +slug: /tools/sdk/go/beta/models/outlier-summary +tags: ['SDK', 'Software Development Kit', 'OutlierSummary', 'BetaOutlierSummary'] +--- + +# OutlierSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of outlier summary | [optional] +**SnapshotDate** | Pointer to **SailPointTime** | The date the bulk outlier detection ran/snapshot was created | [optional] +**TotalOutliers** | Pointer to **int32** | Total number of outliers for the customer making the request | [optional] +**TotalIdentities** | Pointer to **int32** | Total number of identities for the customer making the request | [optional] +**TotalIgnored** | Pointer to **int32** | | [optional] [default to 0] + +## Methods + +### NewOutlierSummary + +`func NewOutlierSummary() *OutlierSummary` + +NewOutlierSummary instantiates a new OutlierSummary 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 + +### NewOutlierSummaryWithDefaults + +`func NewOutlierSummaryWithDefaults() *OutlierSummary` + +NewOutlierSummaryWithDefaults instantiates a new OutlierSummary 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 + +### GetType + +`func (o *OutlierSummary) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OutlierSummary) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OutlierSummary) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OutlierSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSnapshotDate + +`func (o *OutlierSummary) GetSnapshotDate() SailPointTime` + +GetSnapshotDate returns the SnapshotDate field if non-nil, zero value otherwise. + +### GetSnapshotDateOk + +`func (o *OutlierSummary) GetSnapshotDateOk() (*SailPointTime, bool)` + +GetSnapshotDateOk returns a tuple with the SnapshotDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotDate + +`func (o *OutlierSummary) SetSnapshotDate(v SailPointTime)` + +SetSnapshotDate sets SnapshotDate field to given value. + +### HasSnapshotDate + +`func (o *OutlierSummary) HasSnapshotDate() bool` + +HasSnapshotDate returns a boolean if a field has been set. + +### GetTotalOutliers + +`func (o *OutlierSummary) GetTotalOutliers() int32` + +GetTotalOutliers returns the TotalOutliers field if non-nil, zero value otherwise. + +### GetTotalOutliersOk + +`func (o *OutlierSummary) GetTotalOutliersOk() (*int32, bool)` + +GetTotalOutliersOk returns a tuple with the TotalOutliers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalOutliers + +`func (o *OutlierSummary) SetTotalOutliers(v int32)` + +SetTotalOutliers sets TotalOutliers field to given value. + +### HasTotalOutliers + +`func (o *OutlierSummary) HasTotalOutliers() bool` + +HasTotalOutliers returns a boolean if a field has been set. + +### GetTotalIdentities + +`func (o *OutlierSummary) GetTotalIdentities() int32` + +GetTotalIdentities returns the TotalIdentities field if non-nil, zero value otherwise. + +### GetTotalIdentitiesOk + +`func (o *OutlierSummary) 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 *OutlierSummary) SetTotalIdentities(v int32)` + +SetTotalIdentities sets TotalIdentities field to given value. + +### HasTotalIdentities + +`func (o *OutlierSummary) HasTotalIdentities() bool` + +HasTotalIdentities returns a boolean if a field has been set. + +### GetTotalIgnored + +`func (o *OutlierSummary) GetTotalIgnored() int32` + +GetTotalIgnored returns the TotalIgnored field if non-nil, zero value otherwise. + +### GetTotalIgnoredOk + +`func (o *OutlierSummary) GetTotalIgnoredOk() (*int32, bool)` + +GetTotalIgnoredOk returns a tuple with the TotalIgnored field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalIgnored + +`func (o *OutlierSummary) SetTotalIgnored(v int32)` + +SetTotalIgnored sets TotalIgnored field to given value. + +### HasTotalIgnored + +`func (o *OutlierSummary) HasTotalIgnored() bool` + +HasTotalIgnored returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/OutliersContributingFeatureAccessItems.md b/docs/tools/sdk/go/Reference/Beta/Models/OutliersContributingFeatureAccessItems.md new file mode 100644 index 000000000..75d544fbe --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/OutliersContributingFeatureAccessItems.md @@ -0,0 +1,194 @@ +--- +id: beta-outliers-contributing-feature-access-items +title: OutliersContributingFeatureAccessItems +pagination_label: OutliersContributingFeatureAccessItems +sidebar_label: OutliersContributingFeatureAccessItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutliersContributingFeatureAccessItems', 'BetaOutliersContributingFeatureAccessItems'] +slug: /tools/sdk/go/beta/models/outliers-contributing-feature-access-items +tags: ['SDK', 'Software Development Kit', 'OutliersContributingFeatureAccessItems', 'BetaOutliersContributingFeatureAccessItems'] +--- + +# OutliersContributingFeatureAccessItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the access item | [optional] +**DisplayName** | Pointer to **string** | the display name of the access item | [optional] +**Description** | Pointer to **string** | Description of the access item. | [optional] +**AccessType** | Pointer to **string** | The type of the access item. | [optional] +**SourceName** | Pointer to **string** | the associated source name if it exists | [optional] +**ExtremelyRare** | Pointer to **bool** | rarest access | [optional] [default to false] + +## Methods + +### NewOutliersContributingFeatureAccessItems + +`func NewOutliersContributingFeatureAccessItems() *OutliersContributingFeatureAccessItems` + +NewOutliersContributingFeatureAccessItems instantiates a new OutliersContributingFeatureAccessItems 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 + +### NewOutliersContributingFeatureAccessItemsWithDefaults + +`func NewOutliersContributingFeatureAccessItemsWithDefaults() *OutliersContributingFeatureAccessItems` + +NewOutliersContributingFeatureAccessItemsWithDefaults instantiates a new OutliersContributingFeatureAccessItems 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 + +### GetId + +`func (o *OutliersContributingFeatureAccessItems) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OutliersContributingFeatureAccessItems) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OutliersContributingFeatureAccessItems) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OutliersContributingFeatureAccessItems) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *OutliersContributingFeatureAccessItems) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *OutliersContributingFeatureAccessItems) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *OutliersContributingFeatureAccessItems) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *OutliersContributingFeatureAccessItems) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *OutliersContributingFeatureAccessItems) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *OutliersContributingFeatureAccessItems) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *OutliersContributingFeatureAccessItems) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *OutliersContributingFeatureAccessItems) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetAccessType + +`func (o *OutliersContributingFeatureAccessItems) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *OutliersContributingFeatureAccessItems) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *OutliersContributingFeatureAccessItems) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *OutliersContributingFeatureAccessItems) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetSourceName + +`func (o *OutliersContributingFeatureAccessItems) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *OutliersContributingFeatureAccessItems) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *OutliersContributingFeatureAccessItems) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *OutliersContributingFeatureAccessItems) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetExtremelyRare + +`func (o *OutliersContributingFeatureAccessItems) GetExtremelyRare() bool` + +GetExtremelyRare returns the ExtremelyRare field if non-nil, zero value otherwise. + +### GetExtremelyRareOk + +`func (o *OutliersContributingFeatureAccessItems) GetExtremelyRareOk() (*bool, bool)` + +GetExtremelyRareOk returns a tuple with the ExtremelyRare field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExtremelyRare + +`func (o *OutliersContributingFeatureAccessItems) SetExtremelyRare(v bool)` + +SetExtremelyRare sets ExtremelyRare field to given value. + +### HasExtremelyRare + +`func (o *OutliersContributingFeatureAccessItems) HasExtremelyRare() bool` + +HasExtremelyRare returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/OwnerDto.md b/docs/tools/sdk/go/Reference/Beta/Models/OwnerDto.md new file mode 100644 index 000000000..95d8e277b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/OwnerDto.md @@ -0,0 +1,116 @@ +--- +id: beta-owner-dto +title: OwnerDto +pagination_label: OwnerDto +sidebar_label: OwnerDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OwnerDto', 'BetaOwnerDto'] +slug: /tools/sdk/go/beta/models/owner-dto +tags: ['SDK', 'Software Development Kit', 'OwnerDto', 'BetaOwnerDto'] +--- + +# OwnerDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's DTO type. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] + +## Methods + +### NewOwnerDto + +`func NewOwnerDto() *OwnerDto` + +NewOwnerDto instantiates a new OwnerDto 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 + +### NewOwnerDtoWithDefaults + +`func NewOwnerDtoWithDefaults() *OwnerDto` + +NewOwnerDtoWithDefaults instantiates a new OwnerDto 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 + +### GetType + +`func (o *OwnerDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OwnerDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OwnerDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OwnerDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *OwnerDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OwnerDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OwnerDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OwnerDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OwnerDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OwnerDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OwnerDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OwnerDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/OwnerReference.md b/docs/tools/sdk/go/Reference/Beta/Models/OwnerReference.md new file mode 100644 index 000000000..9077407b2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/OwnerReference.md @@ -0,0 +1,116 @@ +--- +id: beta-owner-reference +title: OwnerReference +pagination_label: OwnerReference +sidebar_label: OwnerReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OwnerReference', 'BetaOwnerReference'] +slug: /tools/sdk/go/beta/models/owner-reference +tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'BetaOwnerReference'] +--- + +# OwnerReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] + +## Methods + +### NewOwnerReference + +`func NewOwnerReference() *OwnerReference` + +NewOwnerReference instantiates a new OwnerReference 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 + +### NewOwnerReferenceWithDefaults + +`func NewOwnerReferenceWithDefaults() *OwnerReference` + +NewOwnerReferenceWithDefaults instantiates a new OwnerReference 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 + +### GetType + +`func (o *OwnerReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OwnerReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OwnerReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OwnerReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *OwnerReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OwnerReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OwnerReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OwnerReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OwnerReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OwnerReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OwnerReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OwnerReference) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/OwnerReferenceDto.md b/docs/tools/sdk/go/Reference/Beta/Models/OwnerReferenceDto.md new file mode 100644 index 000000000..49f734094 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/OwnerReferenceDto.md @@ -0,0 +1,116 @@ +--- +id: beta-owner-reference-dto +title: OwnerReferenceDto +pagination_label: OwnerReferenceDto +sidebar_label: OwnerReferenceDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OwnerReferenceDto', 'BetaOwnerReferenceDto'] +slug: /tools/sdk/go/beta/models/owner-reference-dto +tags: ['SDK', 'Software Development Kit', 'OwnerReferenceDto', 'BetaOwnerReferenceDto'] +--- + +# OwnerReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The owner id for the entitlement | [optional] +**Name** | Pointer to **string** | The owner name for the entitlement | [optional] +**Type** | Pointer to **string** | The type of the owner. Initially only type IDENTITY is supported | [optional] + +## Methods + +### NewOwnerReferenceDto + +`func NewOwnerReferenceDto() *OwnerReferenceDto` + +NewOwnerReferenceDto instantiates a new OwnerReferenceDto 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 + +### NewOwnerReferenceDtoWithDefaults + +`func NewOwnerReferenceDtoWithDefaults() *OwnerReferenceDto` + +NewOwnerReferenceDtoWithDefaults instantiates a new OwnerReferenceDto 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 + +### GetId + +`func (o *OwnerReferenceDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OwnerReferenceDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OwnerReferenceDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OwnerReferenceDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OwnerReferenceDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OwnerReferenceDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OwnerReferenceDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OwnerReferenceDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *OwnerReferenceDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OwnerReferenceDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OwnerReferenceDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OwnerReferenceDto) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/OwnerReferenceSegments.md b/docs/tools/sdk/go/Reference/Beta/Models/OwnerReferenceSegments.md new file mode 100644 index 000000000..94786c588 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/OwnerReferenceSegments.md @@ -0,0 +1,116 @@ +--- +id: beta-owner-reference-segments +title: OwnerReferenceSegments +pagination_label: OwnerReferenceSegments +sidebar_label: OwnerReferenceSegments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OwnerReferenceSegments', 'BetaOwnerReferenceSegments'] +slug: /tools/sdk/go/beta/models/owner-reference-segments +tags: ['SDK', 'Software Development Kit', 'OwnerReferenceSegments', 'BetaOwnerReferenceSegments'] +--- + +# OwnerReferenceSegments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**Id** | Pointer to **string** | Identity id | [optional] +**Name** | Pointer to **string** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] + +## Methods + +### NewOwnerReferenceSegments + +`func NewOwnerReferenceSegments() *OwnerReferenceSegments` + +NewOwnerReferenceSegments instantiates a new OwnerReferenceSegments 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 + +### NewOwnerReferenceSegmentsWithDefaults + +`func NewOwnerReferenceSegmentsWithDefaults() *OwnerReferenceSegments` + +NewOwnerReferenceSegmentsWithDefaults instantiates a new OwnerReferenceSegments 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 + +### GetType + +`func (o *OwnerReferenceSegments) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OwnerReferenceSegments) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OwnerReferenceSegments) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OwnerReferenceSegments) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *OwnerReferenceSegments) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OwnerReferenceSegments) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OwnerReferenceSegments) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OwnerReferenceSegments) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OwnerReferenceSegments) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OwnerReferenceSegments) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OwnerReferenceSegments) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OwnerReferenceSegments) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PasswordChangeRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/PasswordChangeRequest.md new file mode 100644 index 000000000..478ba6e17 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PasswordChangeRequest.md @@ -0,0 +1,168 @@ +--- +id: beta-password-change-request +title: PasswordChangeRequest +pagination_label: PasswordChangeRequest +sidebar_label: PasswordChangeRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordChangeRequest', 'BetaPasswordChangeRequest'] +slug: /tools/sdk/go/beta/models/password-change-request +tags: ['SDK', 'Software Development Kit', 'PasswordChangeRequest', 'BetaPasswordChangeRequest'] +--- + +# PasswordChangeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | The identity ID that requested the password change | [optional] +**EncryptedPassword** | Pointer to **string** | The RSA encrypted password | [optional] +**PublicKeyId** | Pointer to **string** | The encryption key ID | [optional] +**AccountId** | Pointer to **string** | Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**SourceId** | Pointer to **string** | The ID of the source for which identity is requesting the password change | [optional] + +## Methods + +### NewPasswordChangeRequest + +`func NewPasswordChangeRequest() *PasswordChangeRequest` + +NewPasswordChangeRequest instantiates a new PasswordChangeRequest 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 + +### NewPasswordChangeRequestWithDefaults + +`func NewPasswordChangeRequestWithDefaults() *PasswordChangeRequest` + +NewPasswordChangeRequestWithDefaults instantiates a new PasswordChangeRequest 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 + +### GetIdentityId + +`func (o *PasswordChangeRequest) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *PasswordChangeRequest) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *PasswordChangeRequest) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *PasswordChangeRequest) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEncryptedPassword + +`func (o *PasswordChangeRequest) GetEncryptedPassword() string` + +GetEncryptedPassword returns the EncryptedPassword field if non-nil, zero value otherwise. + +### GetEncryptedPasswordOk + +`func (o *PasswordChangeRequest) GetEncryptedPasswordOk() (*string, bool)` + +GetEncryptedPasswordOk returns a tuple with the EncryptedPassword field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEncryptedPassword + +`func (o *PasswordChangeRequest) SetEncryptedPassword(v string)` + +SetEncryptedPassword sets EncryptedPassword field to given value. + +### HasEncryptedPassword + +`func (o *PasswordChangeRequest) HasEncryptedPassword() bool` + +HasEncryptedPassword returns a boolean if a field has been set. + +### GetPublicKeyId + +`func (o *PasswordChangeRequest) GetPublicKeyId() string` + +GetPublicKeyId returns the PublicKeyId field if non-nil, zero value otherwise. + +### GetPublicKeyIdOk + +`func (o *PasswordChangeRequest) GetPublicKeyIdOk() (*string, bool)` + +GetPublicKeyIdOk returns a tuple with the PublicKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyId + +`func (o *PasswordChangeRequest) SetPublicKeyId(v string)` + +SetPublicKeyId sets PublicKeyId field to given value. + +### HasPublicKeyId + +`func (o *PasswordChangeRequest) HasPublicKeyId() bool` + +HasPublicKeyId returns a boolean if a field has been set. + +### GetAccountId + +`func (o *PasswordChangeRequest) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *PasswordChangeRequest) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *PasswordChangeRequest) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *PasswordChangeRequest) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *PasswordChangeRequest) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *PasswordChangeRequest) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *PasswordChangeRequest) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *PasswordChangeRequest) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PasswordChangeResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/PasswordChangeResponse.md new file mode 100644 index 000000000..353ba7612 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PasswordChangeResponse.md @@ -0,0 +1,100 @@ +--- +id: beta-password-change-response +title: PasswordChangeResponse +pagination_label: PasswordChangeResponse +sidebar_label: PasswordChangeResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordChangeResponse', 'BetaPasswordChangeResponse'] +slug: /tools/sdk/go/beta/models/password-change-response +tags: ['SDK', 'Software Development Kit', 'PasswordChangeResponse', 'BetaPasswordChangeResponse'] +--- + +# PasswordChangeResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **NullableString** | The password change request ID | [optional] +**State** | Pointer to **string** | Password change state | [optional] + +## Methods + +### NewPasswordChangeResponse + +`func NewPasswordChangeResponse() *PasswordChangeResponse` + +NewPasswordChangeResponse instantiates a new PasswordChangeResponse 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 + +### NewPasswordChangeResponseWithDefaults + +`func NewPasswordChangeResponseWithDefaults() *PasswordChangeResponse` + +NewPasswordChangeResponseWithDefaults instantiates a new PasswordChangeResponse 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 + +### GetRequestId + +`func (o *PasswordChangeResponse) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *PasswordChangeResponse) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *PasswordChangeResponse) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *PasswordChangeResponse) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *PasswordChangeResponse) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *PasswordChangeResponse) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetState + +`func (o *PasswordChangeResponse) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *PasswordChangeResponse) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *PasswordChangeResponse) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *PasswordChangeResponse) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PasswordDigitToken.md b/docs/tools/sdk/go/Reference/Beta/Models/PasswordDigitToken.md new file mode 100644 index 000000000..dd1020586 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PasswordDigitToken.md @@ -0,0 +1,90 @@ +--- +id: beta-password-digit-token +title: PasswordDigitToken +pagination_label: PasswordDigitToken +sidebar_label: PasswordDigitToken +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordDigitToken', 'BetaPasswordDigitToken'] +slug: /tools/sdk/go/beta/models/password-digit-token +tags: ['SDK', 'Software Development Kit', 'PasswordDigitToken', 'BetaPasswordDigitToken'] +--- + +# PasswordDigitToken + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DigitToken** | Pointer to **string** | The digit token for password management | [optional] +**RequestId** | Pointer to **string** | The reference ID of the digit token generation request | [optional] + +## Methods + +### NewPasswordDigitToken + +`func NewPasswordDigitToken() *PasswordDigitToken` + +NewPasswordDigitToken instantiates a new PasswordDigitToken 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 + +### NewPasswordDigitTokenWithDefaults + +`func NewPasswordDigitTokenWithDefaults() *PasswordDigitToken` + +NewPasswordDigitTokenWithDefaults instantiates a new PasswordDigitToken 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 + +### GetDigitToken + +`func (o *PasswordDigitToken) GetDigitToken() string` + +GetDigitToken returns the DigitToken field if non-nil, zero value otherwise. + +### GetDigitTokenOk + +`func (o *PasswordDigitToken) GetDigitTokenOk() (*string, bool)` + +GetDigitTokenOk returns a tuple with the DigitToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDigitToken + +`func (o *PasswordDigitToken) SetDigitToken(v string)` + +SetDigitToken sets DigitToken field to given value. + +### HasDigitToken + +`func (o *PasswordDigitToken) HasDigitToken() bool` + +HasDigitToken returns a boolean if a field has been set. + +### GetRequestId + +`func (o *PasswordDigitToken) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *PasswordDigitToken) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *PasswordDigitToken) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *PasswordDigitToken) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PasswordDigitTokenReset.md b/docs/tools/sdk/go/Reference/Beta/Models/PasswordDigitTokenReset.md new file mode 100644 index 000000000..45c5aac31 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PasswordDigitTokenReset.md @@ -0,0 +1,111 @@ +--- +id: beta-password-digit-token-reset +title: PasswordDigitTokenReset +pagination_label: PasswordDigitTokenReset +sidebar_label: PasswordDigitTokenReset +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordDigitTokenReset', 'BetaPasswordDigitTokenReset'] +slug: /tools/sdk/go/beta/models/password-digit-token-reset +tags: ['SDK', 'Software Development Kit', 'PasswordDigitTokenReset', 'BetaPasswordDigitTokenReset'] +--- + +# PasswordDigitTokenReset + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **string** | The uid of the user requested for digit token | +**Length** | Pointer to **int32** | The length of digit token. It should be from 6 to 18, inclusive. The default value is 6. | [optional] +**DurationMinutes** | Pointer to **int32** | The time to live for the digit token in minutes. The default value is 5 minutes. | [optional] + +## Methods + +### NewPasswordDigitTokenReset + +`func NewPasswordDigitTokenReset(userId string, ) *PasswordDigitTokenReset` + +NewPasswordDigitTokenReset instantiates a new PasswordDigitTokenReset 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 + +### NewPasswordDigitTokenResetWithDefaults + +`func NewPasswordDigitTokenResetWithDefaults() *PasswordDigitTokenReset` + +NewPasswordDigitTokenResetWithDefaults instantiates a new PasswordDigitTokenReset 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 + +### GetUserId + +`func (o *PasswordDigitTokenReset) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *PasswordDigitTokenReset) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *PasswordDigitTokenReset) SetUserId(v string)` + +SetUserId sets UserId field to given value. + + +### GetLength + +`func (o *PasswordDigitTokenReset) GetLength() int32` + +GetLength returns the Length field if non-nil, zero value otherwise. + +### GetLengthOk + +`func (o *PasswordDigitTokenReset) GetLengthOk() (*int32, bool)` + +GetLengthOk returns a tuple with the Length field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLength + +`func (o *PasswordDigitTokenReset) SetLength(v int32)` + +SetLength sets Length field to given value. + +### HasLength + +`func (o *PasswordDigitTokenReset) HasLength() bool` + +HasLength returns a boolean if a field has been set. + +### GetDurationMinutes + +`func (o *PasswordDigitTokenReset) GetDurationMinutes() int32` + +GetDurationMinutes returns the DurationMinutes field if non-nil, zero value otherwise. + +### GetDurationMinutesOk + +`func (o *PasswordDigitTokenReset) GetDurationMinutesOk() (*int32, bool)` + +GetDurationMinutesOk returns a tuple with the DurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDurationMinutes + +`func (o *PasswordDigitTokenReset) SetDurationMinutes(v int32)` + +SetDurationMinutes sets DurationMinutes field to given value. + +### HasDurationMinutes + +`func (o *PasswordDigitTokenReset) HasDurationMinutes() bool` + +HasDurationMinutes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PasswordInfo.md b/docs/tools/sdk/go/Reference/Beta/Models/PasswordInfo.md new file mode 100644 index 000000000..24f693f8d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PasswordInfo.md @@ -0,0 +1,194 @@ +--- +id: beta-password-info +title: PasswordInfo +pagination_label: PasswordInfo +sidebar_label: PasswordInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordInfo', 'BetaPasswordInfo'] +slug: /tools/sdk/go/beta/models/password-info +tags: ['SDK', 'Software Development Kit', 'PasswordInfo', 'BetaPasswordInfo'] +--- + +# PasswordInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | | [optional] +**SourceId** | Pointer to **string** | | [optional] +**PublicKeyId** | Pointer to **string** | | [optional] +**PublicKey** | Pointer to **string** | User's public key with Base64 encoding | [optional] +**Accounts** | Pointer to [**[]PasswordInfoAccount**](password-info-account) | Account info related to queried identity and source | [optional] +**Policies** | Pointer to **[]string** | Password constraints | [optional] + +## Methods + +### NewPasswordInfo + +`func NewPasswordInfo() *PasswordInfo` + +NewPasswordInfo instantiates a new PasswordInfo 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 + +### NewPasswordInfoWithDefaults + +`func NewPasswordInfoWithDefaults() *PasswordInfo` + +NewPasswordInfoWithDefaults instantiates a new PasswordInfo 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 + +### GetIdentityId + +`func (o *PasswordInfo) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *PasswordInfo) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *PasswordInfo) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *PasswordInfo) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *PasswordInfo) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *PasswordInfo) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *PasswordInfo) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *PasswordInfo) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetPublicKeyId + +`func (o *PasswordInfo) GetPublicKeyId() string` + +GetPublicKeyId returns the PublicKeyId field if non-nil, zero value otherwise. + +### GetPublicKeyIdOk + +`func (o *PasswordInfo) GetPublicKeyIdOk() (*string, bool)` + +GetPublicKeyIdOk returns a tuple with the PublicKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyId + +`func (o *PasswordInfo) SetPublicKeyId(v string)` + +SetPublicKeyId sets PublicKeyId field to given value. + +### HasPublicKeyId + +`func (o *PasswordInfo) HasPublicKeyId() bool` + +HasPublicKeyId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *PasswordInfo) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *PasswordInfo) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *PasswordInfo) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *PasswordInfo) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetAccounts + +`func (o *PasswordInfo) GetAccounts() []PasswordInfoAccount` + +GetAccounts returns the Accounts field if non-nil, zero value otherwise. + +### GetAccountsOk + +`func (o *PasswordInfo) GetAccountsOk() (*[]PasswordInfoAccount, bool)` + +GetAccountsOk returns a tuple with the Accounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccounts + +`func (o *PasswordInfo) SetAccounts(v []PasswordInfoAccount)` + +SetAccounts sets Accounts field to given value. + +### HasAccounts + +`func (o *PasswordInfo) HasAccounts() bool` + +HasAccounts returns a boolean if a field has been set. + +### GetPolicies + +`func (o *PasswordInfo) GetPolicies() []string` + +GetPolicies returns the Policies field if non-nil, zero value otherwise. + +### GetPoliciesOk + +`func (o *PasswordInfo) GetPoliciesOk() (*[]string, bool)` + +GetPoliciesOk returns a tuple with the Policies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicies + +`func (o *PasswordInfo) SetPolicies(v []string)` + +SetPolicies sets Policies field to given value. + +### HasPolicies + +`func (o *PasswordInfo) HasPolicies() bool` + +HasPolicies returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PasswordInfoAccount.md b/docs/tools/sdk/go/Reference/Beta/Models/PasswordInfoAccount.md new file mode 100644 index 000000000..e29a59134 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PasswordInfoAccount.md @@ -0,0 +1,90 @@ +--- +id: beta-password-info-account +title: PasswordInfoAccount +pagination_label: PasswordInfoAccount +sidebar_label: PasswordInfoAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordInfoAccount', 'BetaPasswordInfoAccount'] +slug: /tools/sdk/go/beta/models/password-info-account +tags: ['SDK', 'Software Development Kit', 'PasswordInfoAccount', 'BetaPasswordInfoAccount'] +--- + +# PasswordInfoAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **string** | Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**AccountName** | Pointer to **string** | Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 | [optional] + +## Methods + +### NewPasswordInfoAccount + +`func NewPasswordInfoAccount() *PasswordInfoAccount` + +NewPasswordInfoAccount instantiates a new PasswordInfoAccount 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 + +### NewPasswordInfoAccountWithDefaults + +`func NewPasswordInfoAccountWithDefaults() *PasswordInfoAccount` + +NewPasswordInfoAccountWithDefaults instantiates a new PasswordInfoAccount 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 + +### GetAccountId + +`func (o *PasswordInfoAccount) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *PasswordInfoAccount) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *PasswordInfoAccount) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *PasswordInfoAccount) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetAccountName + +`func (o *PasswordInfoAccount) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *PasswordInfoAccount) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *PasswordInfoAccount) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *PasswordInfoAccount) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PasswordInfoQueryDTO.md b/docs/tools/sdk/go/Reference/Beta/Models/PasswordInfoQueryDTO.md new file mode 100644 index 000000000..1c1404596 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PasswordInfoQueryDTO.md @@ -0,0 +1,90 @@ +--- +id: beta-password-info-query-dto +title: PasswordInfoQueryDTO +pagination_label: PasswordInfoQueryDTO +sidebar_label: PasswordInfoQueryDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordInfoQueryDTO', 'BetaPasswordInfoQueryDTO'] +slug: /tools/sdk/go/beta/models/password-info-query-dto +tags: ['SDK', 'Software Development Kit', 'PasswordInfoQueryDTO', 'BetaPasswordInfoQueryDTO'] +--- + +# PasswordInfoQueryDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserName** | Pointer to **string** | The login name of the user | [optional] +**SourceName** | Pointer to **string** | The display name of the source | [optional] + +## Methods + +### NewPasswordInfoQueryDTO + +`func NewPasswordInfoQueryDTO() *PasswordInfoQueryDTO` + +NewPasswordInfoQueryDTO instantiates a new PasswordInfoQueryDTO 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 + +### NewPasswordInfoQueryDTOWithDefaults + +`func NewPasswordInfoQueryDTOWithDefaults() *PasswordInfoQueryDTO` + +NewPasswordInfoQueryDTOWithDefaults instantiates a new PasswordInfoQueryDTO 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 + +### GetUserName + +`func (o *PasswordInfoQueryDTO) GetUserName() string` + +GetUserName returns the UserName field if non-nil, zero value otherwise. + +### GetUserNameOk + +`func (o *PasswordInfoQueryDTO) GetUserNameOk() (*string, bool)` + +GetUserNameOk returns a tuple with the UserName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserName + +`func (o *PasswordInfoQueryDTO) SetUserName(v string)` + +SetUserName sets UserName field to given value. + +### HasUserName + +`func (o *PasswordInfoQueryDTO) HasUserName() bool` + +HasUserName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *PasswordInfoQueryDTO) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *PasswordInfoQueryDTO) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *PasswordInfoQueryDTO) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *PasswordInfoQueryDTO) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PasswordOrgConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/PasswordOrgConfig.md new file mode 100644 index 000000000..681dc1fb7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PasswordOrgConfig.md @@ -0,0 +1,142 @@ +--- +id: beta-password-org-config +title: PasswordOrgConfig +pagination_label: PasswordOrgConfig +sidebar_label: PasswordOrgConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordOrgConfig', 'BetaPasswordOrgConfig'] +slug: /tools/sdk/go/beta/models/password-org-config +tags: ['SDK', 'Software Development Kit', 'PasswordOrgConfig', 'BetaPasswordOrgConfig'] +--- + +# PasswordOrgConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomInstructionsEnabled** | Pointer to **bool** | Indicator whether custom password instructions feature is enabled. The default value is false. | [optional] [default to false] +**DigitTokenEnabled** | Pointer to **bool** | Indicator whether \"digit token\" feature is enabled. The default value is false. | [optional] [default to false] +**DigitTokenDurationMinutes** | Pointer to **int32** | The duration of \"digit token\" in minutes. The default value is 5. | [optional] [default to 5] +**DigitTokenLength** | Pointer to **int32** | The length of \"digit token\". The default value is 6. | [optional] [default to 6] + +## Methods + +### NewPasswordOrgConfig + +`func NewPasswordOrgConfig() *PasswordOrgConfig` + +NewPasswordOrgConfig instantiates a new PasswordOrgConfig 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 + +### NewPasswordOrgConfigWithDefaults + +`func NewPasswordOrgConfigWithDefaults() *PasswordOrgConfig` + +NewPasswordOrgConfigWithDefaults instantiates a new PasswordOrgConfig 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 + +### GetCustomInstructionsEnabled + +`func (o *PasswordOrgConfig) GetCustomInstructionsEnabled() bool` + +GetCustomInstructionsEnabled returns the CustomInstructionsEnabled field if non-nil, zero value otherwise. + +### GetCustomInstructionsEnabledOk + +`func (o *PasswordOrgConfig) GetCustomInstructionsEnabledOk() (*bool, bool)` + +GetCustomInstructionsEnabledOk returns a tuple with the CustomInstructionsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomInstructionsEnabled + +`func (o *PasswordOrgConfig) SetCustomInstructionsEnabled(v bool)` + +SetCustomInstructionsEnabled sets CustomInstructionsEnabled field to given value. + +### HasCustomInstructionsEnabled + +`func (o *PasswordOrgConfig) HasCustomInstructionsEnabled() bool` + +HasCustomInstructionsEnabled returns a boolean if a field has been set. + +### GetDigitTokenEnabled + +`func (o *PasswordOrgConfig) GetDigitTokenEnabled() bool` + +GetDigitTokenEnabled returns the DigitTokenEnabled field if non-nil, zero value otherwise. + +### GetDigitTokenEnabledOk + +`func (o *PasswordOrgConfig) GetDigitTokenEnabledOk() (*bool, bool)` + +GetDigitTokenEnabledOk returns a tuple with the DigitTokenEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDigitTokenEnabled + +`func (o *PasswordOrgConfig) SetDigitTokenEnabled(v bool)` + +SetDigitTokenEnabled sets DigitTokenEnabled field to given value. + +### HasDigitTokenEnabled + +`func (o *PasswordOrgConfig) HasDigitTokenEnabled() bool` + +HasDigitTokenEnabled returns a boolean if a field has been set. + +### GetDigitTokenDurationMinutes + +`func (o *PasswordOrgConfig) GetDigitTokenDurationMinutes() int32` + +GetDigitTokenDurationMinutes returns the DigitTokenDurationMinutes field if non-nil, zero value otherwise. + +### GetDigitTokenDurationMinutesOk + +`func (o *PasswordOrgConfig) GetDigitTokenDurationMinutesOk() (*int32, bool)` + +GetDigitTokenDurationMinutesOk returns a tuple with the DigitTokenDurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDigitTokenDurationMinutes + +`func (o *PasswordOrgConfig) SetDigitTokenDurationMinutes(v int32)` + +SetDigitTokenDurationMinutes sets DigitTokenDurationMinutes field to given value. + +### HasDigitTokenDurationMinutes + +`func (o *PasswordOrgConfig) HasDigitTokenDurationMinutes() bool` + +HasDigitTokenDurationMinutes returns a boolean if a field has been set. + +### GetDigitTokenLength + +`func (o *PasswordOrgConfig) GetDigitTokenLength() int32` + +GetDigitTokenLength returns the DigitTokenLength field if non-nil, zero value otherwise. + +### GetDigitTokenLengthOk + +`func (o *PasswordOrgConfig) GetDigitTokenLengthOk() (*int32, bool)` + +GetDigitTokenLengthOk returns a tuple with the DigitTokenLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDigitTokenLength + +`func (o *PasswordOrgConfig) SetDigitTokenLength(v int32)` + +SetDigitTokenLength sets DigitTokenLength field to given value. + +### HasDigitTokenLength + +`func (o *PasswordOrgConfig) HasDigitTokenLength() bool` + +HasDigitTokenLength returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PasswordPolicyV3Dto.md b/docs/tools/sdk/go/Reference/Beta/Models/PasswordPolicyV3Dto.md new file mode 100644 index 000000000..fb77ebd3f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PasswordPolicyV3Dto.md @@ -0,0 +1,884 @@ +--- +id: beta-password-policy-v3-dto +title: PasswordPolicyV3Dto +pagination_label: PasswordPolicyV3Dto +sidebar_label: PasswordPolicyV3Dto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordPolicyV3Dto', 'BetaPasswordPolicyV3Dto'] +slug: /tools/sdk/go/beta/models/password-policy-v3-dto +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyV3Dto', 'BetaPasswordPolicyV3Dto'] +--- + +# PasswordPolicyV3Dto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The password policy Id. | [optional] +**Description** | Pointer to **NullableString** | Description for current password policy. | [optional] +**Name** | Pointer to **string** | The name of the password policy. | [optional] +**DateCreated** | Pointer to **SailPointTime** | Date the Password Policy was created. | [optional] +**LastUpdated** | Pointer to **NullableTime** | Date the Password Policy was updated. | [optional] +**FirstExpirationReminder** | Pointer to **int64** | The number of days before expiration remaninder. | [optional] +**AccountIdMinWordLength** | Pointer to **int64** | The minimun length of account Id. By default is equals to -1. | [optional] +**AccountNameMinWordLength** | Pointer to **int64** | The minimun length of account name. By default is equals to -1. | [optional] +**MinAlpha** | Pointer to **int64** | Maximum alpha. By default is equals to 0. | [optional] +**MinCharacterTypes** | Pointer to **int64** | MinCharacterTypes. By default is equals to -1. | [optional] +**MaxLength** | Pointer to **int64** | Maximum length of the password. | [optional] +**MinLength** | Pointer to **int64** | Minimum length of the password. By default is equals to 0. | [optional] +**MaxRepeatedChars** | Pointer to **int64** | Maximum repetition of the same character in the password. By default is equals to -1. | [optional] +**MinLower** | Pointer to **int64** | Minimum amount of lower case character in the password. By default is equals to 0. | [optional] +**MinNumeric** | Pointer to **int64** | Minimum amount of numeric characters in the password. By default is equals to 0. | [optional] +**MinSpecial** | Pointer to **int64** | Minimum amount of special symbols in the password. By default is equals to 0. | [optional] +**MinUpper** | Pointer to **int64** | Minimum amount of upper case symbols in the password. By default is equals to 0. | [optional] +**PasswordExpiration** | Pointer to **int64** | Number of days before current password expires. By default is equals to 90. | [optional] +**DefaultPolicy** | Pointer to **bool** | Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. | [optional] [default to false] +**EnablePasswdExpiration** | Pointer to **bool** | Defines whether this policy is enabled to expire or not. This field is false by default. | [optional] [default to false] +**RequireStrongAuthn** | Pointer to **bool** | Defines whether this policy require strong Auth or not. This field is false by default. | [optional] [default to false] +**RequireStrongAuthOffNetwork** | Pointer to **bool** | Defines whether this policy require strong Auth of network or not. This field is false by default. | [optional] [default to false] +**RequireStrongAuthUntrustedGeographies** | Pointer to **bool** | Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. | [optional] [default to false] +**UseAccountAttributes** | Pointer to **bool** | Defines whether this policy uses account attributes or not. This field is false by default. | [optional] [default to false] +**UseDictionary** | Pointer to **bool** | Defines whether this policy uses dictionary or not. This field is false by default. | [optional] [default to false] +**UseIdentityAttributes** | Pointer to **bool** | Defines whether this policy uses identity attributes or not. This field is false by default. | [optional] [default to false] +**ValidateAgainstAccountId** | Pointer to **bool** | Defines whether this policy validate against account id or not. This field is false by default. | [optional] [default to false] +**ValidateAgainstAccountName** | Pointer to **bool** | Defines whether this policy validate against account name or not. This field is false by default. | [optional] [default to false] +**Created** | Pointer to **NullableString** | | [optional] +**Modified** | Pointer to **NullableString** | | [optional] +**SourceIds** | Pointer to **[]string** | List of sources IDs managed by this password policy. | [optional] + +## Methods + +### NewPasswordPolicyV3Dto + +`func NewPasswordPolicyV3Dto() *PasswordPolicyV3Dto` + +NewPasswordPolicyV3Dto instantiates a new PasswordPolicyV3Dto 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 + +### NewPasswordPolicyV3DtoWithDefaults + +`func NewPasswordPolicyV3DtoWithDefaults() *PasswordPolicyV3Dto` + +NewPasswordPolicyV3DtoWithDefaults instantiates a new PasswordPolicyV3Dto 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 + +### GetId + +`func (o *PasswordPolicyV3Dto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PasswordPolicyV3Dto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PasswordPolicyV3Dto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PasswordPolicyV3Dto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDescription + +`func (o *PasswordPolicyV3Dto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *PasswordPolicyV3Dto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *PasswordPolicyV3Dto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *PasswordPolicyV3Dto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *PasswordPolicyV3Dto) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *PasswordPolicyV3Dto) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetName + +`func (o *PasswordPolicyV3Dto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PasswordPolicyV3Dto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PasswordPolicyV3Dto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PasswordPolicyV3Dto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDateCreated + +`func (o *PasswordPolicyV3Dto) GetDateCreated() SailPointTime` + +GetDateCreated returns the DateCreated field if non-nil, zero value otherwise. + +### GetDateCreatedOk + +`func (o *PasswordPolicyV3Dto) GetDateCreatedOk() (*SailPointTime, bool)` + +GetDateCreatedOk returns a tuple with the DateCreated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDateCreated + +`func (o *PasswordPolicyV3Dto) SetDateCreated(v SailPointTime)` + +SetDateCreated sets DateCreated field to given value. + +### HasDateCreated + +`func (o *PasswordPolicyV3Dto) HasDateCreated() bool` + +HasDateCreated returns a boolean if a field has been set. + +### GetLastUpdated + +`func (o *PasswordPolicyV3Dto) GetLastUpdated() SailPointTime` + +GetLastUpdated returns the LastUpdated field if non-nil, zero value otherwise. + +### GetLastUpdatedOk + +`func (o *PasswordPolicyV3Dto) GetLastUpdatedOk() (*SailPointTime, bool)` + +GetLastUpdatedOk returns a tuple with the LastUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdated + +`func (o *PasswordPolicyV3Dto) SetLastUpdated(v SailPointTime)` + +SetLastUpdated sets LastUpdated field to given value. + +### HasLastUpdated + +`func (o *PasswordPolicyV3Dto) HasLastUpdated() bool` + +HasLastUpdated returns a boolean if a field has been set. + +### SetLastUpdatedNil + +`func (o *PasswordPolicyV3Dto) SetLastUpdatedNil(b bool)` + + SetLastUpdatedNil sets the value for LastUpdated to be an explicit nil + +### UnsetLastUpdated +`func (o *PasswordPolicyV3Dto) UnsetLastUpdated()` + +UnsetLastUpdated ensures that no value is present for LastUpdated, not even an explicit nil +### GetFirstExpirationReminder + +`func (o *PasswordPolicyV3Dto) GetFirstExpirationReminder() int64` + +GetFirstExpirationReminder returns the FirstExpirationReminder field if non-nil, zero value otherwise. + +### GetFirstExpirationReminderOk + +`func (o *PasswordPolicyV3Dto) GetFirstExpirationReminderOk() (*int64, bool)` + +GetFirstExpirationReminderOk returns a tuple with the FirstExpirationReminder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstExpirationReminder + +`func (o *PasswordPolicyV3Dto) SetFirstExpirationReminder(v int64)` + +SetFirstExpirationReminder sets FirstExpirationReminder field to given value. + +### HasFirstExpirationReminder + +`func (o *PasswordPolicyV3Dto) HasFirstExpirationReminder() bool` + +HasFirstExpirationReminder returns a boolean if a field has been set. + +### GetAccountIdMinWordLength + +`func (o *PasswordPolicyV3Dto) GetAccountIdMinWordLength() int64` + +GetAccountIdMinWordLength returns the AccountIdMinWordLength field if non-nil, zero value otherwise. + +### GetAccountIdMinWordLengthOk + +`func (o *PasswordPolicyV3Dto) GetAccountIdMinWordLengthOk() (*int64, bool)` + +GetAccountIdMinWordLengthOk returns a tuple with the AccountIdMinWordLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountIdMinWordLength + +`func (o *PasswordPolicyV3Dto) SetAccountIdMinWordLength(v int64)` + +SetAccountIdMinWordLength sets AccountIdMinWordLength field to given value. + +### HasAccountIdMinWordLength + +`func (o *PasswordPolicyV3Dto) HasAccountIdMinWordLength() bool` + +HasAccountIdMinWordLength returns a boolean if a field has been set. + +### GetAccountNameMinWordLength + +`func (o *PasswordPolicyV3Dto) GetAccountNameMinWordLength() int64` + +GetAccountNameMinWordLength returns the AccountNameMinWordLength field if non-nil, zero value otherwise. + +### GetAccountNameMinWordLengthOk + +`func (o *PasswordPolicyV3Dto) GetAccountNameMinWordLengthOk() (*int64, bool)` + +GetAccountNameMinWordLengthOk returns a tuple with the AccountNameMinWordLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountNameMinWordLength + +`func (o *PasswordPolicyV3Dto) SetAccountNameMinWordLength(v int64)` + +SetAccountNameMinWordLength sets AccountNameMinWordLength field to given value. + +### HasAccountNameMinWordLength + +`func (o *PasswordPolicyV3Dto) HasAccountNameMinWordLength() bool` + +HasAccountNameMinWordLength returns a boolean if a field has been set. + +### GetMinAlpha + +`func (o *PasswordPolicyV3Dto) GetMinAlpha() int64` + +GetMinAlpha returns the MinAlpha field if non-nil, zero value otherwise. + +### GetMinAlphaOk + +`func (o *PasswordPolicyV3Dto) GetMinAlphaOk() (*int64, bool)` + +GetMinAlphaOk returns a tuple with the MinAlpha field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinAlpha + +`func (o *PasswordPolicyV3Dto) SetMinAlpha(v int64)` + +SetMinAlpha sets MinAlpha field to given value. + +### HasMinAlpha + +`func (o *PasswordPolicyV3Dto) HasMinAlpha() bool` + +HasMinAlpha returns a boolean if a field has been set. + +### GetMinCharacterTypes + +`func (o *PasswordPolicyV3Dto) GetMinCharacterTypes() int64` + +GetMinCharacterTypes returns the MinCharacterTypes field if non-nil, zero value otherwise. + +### GetMinCharacterTypesOk + +`func (o *PasswordPolicyV3Dto) GetMinCharacterTypesOk() (*int64, bool)` + +GetMinCharacterTypesOk returns a tuple with the MinCharacterTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinCharacterTypes + +`func (o *PasswordPolicyV3Dto) SetMinCharacterTypes(v int64)` + +SetMinCharacterTypes sets MinCharacterTypes field to given value. + +### HasMinCharacterTypes + +`func (o *PasswordPolicyV3Dto) HasMinCharacterTypes() bool` + +HasMinCharacterTypes returns a boolean if a field has been set. + +### GetMaxLength + +`func (o *PasswordPolicyV3Dto) GetMaxLength() int64` + +GetMaxLength returns the MaxLength field if non-nil, zero value otherwise. + +### GetMaxLengthOk + +`func (o *PasswordPolicyV3Dto) GetMaxLengthOk() (*int64, bool)` + +GetMaxLengthOk returns a tuple with the MaxLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxLength + +`func (o *PasswordPolicyV3Dto) SetMaxLength(v int64)` + +SetMaxLength sets MaxLength field to given value. + +### HasMaxLength + +`func (o *PasswordPolicyV3Dto) HasMaxLength() bool` + +HasMaxLength returns a boolean if a field has been set. + +### GetMinLength + +`func (o *PasswordPolicyV3Dto) GetMinLength() int64` + +GetMinLength returns the MinLength field if non-nil, zero value otherwise. + +### GetMinLengthOk + +`func (o *PasswordPolicyV3Dto) GetMinLengthOk() (*int64, bool)` + +GetMinLengthOk returns a tuple with the MinLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinLength + +`func (o *PasswordPolicyV3Dto) SetMinLength(v int64)` + +SetMinLength sets MinLength field to given value. + +### HasMinLength + +`func (o *PasswordPolicyV3Dto) HasMinLength() bool` + +HasMinLength returns a boolean if a field has been set. + +### GetMaxRepeatedChars + +`func (o *PasswordPolicyV3Dto) GetMaxRepeatedChars() int64` + +GetMaxRepeatedChars returns the MaxRepeatedChars field if non-nil, zero value otherwise. + +### GetMaxRepeatedCharsOk + +`func (o *PasswordPolicyV3Dto) GetMaxRepeatedCharsOk() (*int64, bool)` + +GetMaxRepeatedCharsOk returns a tuple with the MaxRepeatedChars field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxRepeatedChars + +`func (o *PasswordPolicyV3Dto) SetMaxRepeatedChars(v int64)` + +SetMaxRepeatedChars sets MaxRepeatedChars field to given value. + +### HasMaxRepeatedChars + +`func (o *PasswordPolicyV3Dto) HasMaxRepeatedChars() bool` + +HasMaxRepeatedChars returns a boolean if a field has been set. + +### GetMinLower + +`func (o *PasswordPolicyV3Dto) GetMinLower() int64` + +GetMinLower returns the MinLower field if non-nil, zero value otherwise. + +### GetMinLowerOk + +`func (o *PasswordPolicyV3Dto) GetMinLowerOk() (*int64, bool)` + +GetMinLowerOk returns a tuple with the MinLower field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinLower + +`func (o *PasswordPolicyV3Dto) SetMinLower(v int64)` + +SetMinLower sets MinLower field to given value. + +### HasMinLower + +`func (o *PasswordPolicyV3Dto) HasMinLower() bool` + +HasMinLower returns a boolean if a field has been set. + +### GetMinNumeric + +`func (o *PasswordPolicyV3Dto) GetMinNumeric() int64` + +GetMinNumeric returns the MinNumeric field if non-nil, zero value otherwise. + +### GetMinNumericOk + +`func (o *PasswordPolicyV3Dto) GetMinNumericOk() (*int64, bool)` + +GetMinNumericOk returns a tuple with the MinNumeric field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinNumeric + +`func (o *PasswordPolicyV3Dto) SetMinNumeric(v int64)` + +SetMinNumeric sets MinNumeric field to given value. + +### HasMinNumeric + +`func (o *PasswordPolicyV3Dto) HasMinNumeric() bool` + +HasMinNumeric returns a boolean if a field has been set. + +### GetMinSpecial + +`func (o *PasswordPolicyV3Dto) GetMinSpecial() int64` + +GetMinSpecial returns the MinSpecial field if non-nil, zero value otherwise. + +### GetMinSpecialOk + +`func (o *PasswordPolicyV3Dto) GetMinSpecialOk() (*int64, bool)` + +GetMinSpecialOk returns a tuple with the MinSpecial field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinSpecial + +`func (o *PasswordPolicyV3Dto) SetMinSpecial(v int64)` + +SetMinSpecial sets MinSpecial field to given value. + +### HasMinSpecial + +`func (o *PasswordPolicyV3Dto) HasMinSpecial() bool` + +HasMinSpecial returns a boolean if a field has been set. + +### GetMinUpper + +`func (o *PasswordPolicyV3Dto) GetMinUpper() int64` + +GetMinUpper returns the MinUpper field if non-nil, zero value otherwise. + +### GetMinUpperOk + +`func (o *PasswordPolicyV3Dto) GetMinUpperOk() (*int64, bool)` + +GetMinUpperOk returns a tuple with the MinUpper field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinUpper + +`func (o *PasswordPolicyV3Dto) SetMinUpper(v int64)` + +SetMinUpper sets MinUpper field to given value. + +### HasMinUpper + +`func (o *PasswordPolicyV3Dto) HasMinUpper() bool` + +HasMinUpper returns a boolean if a field has been set. + +### GetPasswordExpiration + +`func (o *PasswordPolicyV3Dto) GetPasswordExpiration() int64` + +GetPasswordExpiration returns the PasswordExpiration field if non-nil, zero value otherwise. + +### GetPasswordExpirationOk + +`func (o *PasswordPolicyV3Dto) GetPasswordExpirationOk() (*int64, bool)` + +GetPasswordExpirationOk returns a tuple with the PasswordExpiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordExpiration + +`func (o *PasswordPolicyV3Dto) SetPasswordExpiration(v int64)` + +SetPasswordExpiration sets PasswordExpiration field to given value. + +### HasPasswordExpiration + +`func (o *PasswordPolicyV3Dto) HasPasswordExpiration() bool` + +HasPasswordExpiration returns a boolean if a field has been set. + +### GetDefaultPolicy + +`func (o *PasswordPolicyV3Dto) GetDefaultPolicy() bool` + +GetDefaultPolicy returns the DefaultPolicy field if non-nil, zero value otherwise. + +### GetDefaultPolicyOk + +`func (o *PasswordPolicyV3Dto) GetDefaultPolicyOk() (*bool, bool)` + +GetDefaultPolicyOk returns a tuple with the DefaultPolicy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultPolicy + +`func (o *PasswordPolicyV3Dto) SetDefaultPolicy(v bool)` + +SetDefaultPolicy sets DefaultPolicy field to given value. + +### HasDefaultPolicy + +`func (o *PasswordPolicyV3Dto) HasDefaultPolicy() bool` + +HasDefaultPolicy returns a boolean if a field has been set. + +### GetEnablePasswdExpiration + +`func (o *PasswordPolicyV3Dto) GetEnablePasswdExpiration() bool` + +GetEnablePasswdExpiration returns the EnablePasswdExpiration field if non-nil, zero value otherwise. + +### GetEnablePasswdExpirationOk + +`func (o *PasswordPolicyV3Dto) GetEnablePasswdExpirationOk() (*bool, bool)` + +GetEnablePasswdExpirationOk returns a tuple with the EnablePasswdExpiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnablePasswdExpiration + +`func (o *PasswordPolicyV3Dto) SetEnablePasswdExpiration(v bool)` + +SetEnablePasswdExpiration sets EnablePasswdExpiration field to given value. + +### HasEnablePasswdExpiration + +`func (o *PasswordPolicyV3Dto) HasEnablePasswdExpiration() bool` + +HasEnablePasswdExpiration returns a boolean if a field has been set. + +### GetRequireStrongAuthn + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthn() bool` + +GetRequireStrongAuthn returns the RequireStrongAuthn field if non-nil, zero value otherwise. + +### GetRequireStrongAuthnOk + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthnOk() (*bool, bool)` + +GetRequireStrongAuthnOk returns a tuple with the RequireStrongAuthn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequireStrongAuthn + +`func (o *PasswordPolicyV3Dto) SetRequireStrongAuthn(v bool)` + +SetRequireStrongAuthn sets RequireStrongAuthn field to given value. + +### HasRequireStrongAuthn + +`func (o *PasswordPolicyV3Dto) HasRequireStrongAuthn() bool` + +HasRequireStrongAuthn returns a boolean if a field has been set. + +### GetRequireStrongAuthOffNetwork + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthOffNetwork() bool` + +GetRequireStrongAuthOffNetwork returns the RequireStrongAuthOffNetwork field if non-nil, zero value otherwise. + +### GetRequireStrongAuthOffNetworkOk + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthOffNetworkOk() (*bool, bool)` + +GetRequireStrongAuthOffNetworkOk returns a tuple with the RequireStrongAuthOffNetwork field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequireStrongAuthOffNetwork + +`func (o *PasswordPolicyV3Dto) SetRequireStrongAuthOffNetwork(v bool)` + +SetRequireStrongAuthOffNetwork sets RequireStrongAuthOffNetwork field to given value. + +### HasRequireStrongAuthOffNetwork + +`func (o *PasswordPolicyV3Dto) HasRequireStrongAuthOffNetwork() bool` + +HasRequireStrongAuthOffNetwork returns a boolean if a field has been set. + +### GetRequireStrongAuthUntrustedGeographies + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthUntrustedGeographies() bool` + +GetRequireStrongAuthUntrustedGeographies returns the RequireStrongAuthUntrustedGeographies field if non-nil, zero value otherwise. + +### GetRequireStrongAuthUntrustedGeographiesOk + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthUntrustedGeographiesOk() (*bool, bool)` + +GetRequireStrongAuthUntrustedGeographiesOk returns a tuple with the RequireStrongAuthUntrustedGeographies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequireStrongAuthUntrustedGeographies + +`func (o *PasswordPolicyV3Dto) SetRequireStrongAuthUntrustedGeographies(v bool)` + +SetRequireStrongAuthUntrustedGeographies sets RequireStrongAuthUntrustedGeographies field to given value. + +### HasRequireStrongAuthUntrustedGeographies + +`func (o *PasswordPolicyV3Dto) HasRequireStrongAuthUntrustedGeographies() bool` + +HasRequireStrongAuthUntrustedGeographies returns a boolean if a field has been set. + +### GetUseAccountAttributes + +`func (o *PasswordPolicyV3Dto) GetUseAccountAttributes() bool` + +GetUseAccountAttributes returns the UseAccountAttributes field if non-nil, zero value otherwise. + +### GetUseAccountAttributesOk + +`func (o *PasswordPolicyV3Dto) GetUseAccountAttributesOk() (*bool, bool)` + +GetUseAccountAttributesOk returns a tuple with the UseAccountAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseAccountAttributes + +`func (o *PasswordPolicyV3Dto) SetUseAccountAttributes(v bool)` + +SetUseAccountAttributes sets UseAccountAttributes field to given value. + +### HasUseAccountAttributes + +`func (o *PasswordPolicyV3Dto) HasUseAccountAttributes() bool` + +HasUseAccountAttributes returns a boolean if a field has been set. + +### GetUseDictionary + +`func (o *PasswordPolicyV3Dto) GetUseDictionary() bool` + +GetUseDictionary returns the UseDictionary field if non-nil, zero value otherwise. + +### GetUseDictionaryOk + +`func (o *PasswordPolicyV3Dto) GetUseDictionaryOk() (*bool, bool)` + +GetUseDictionaryOk returns a tuple with the UseDictionary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseDictionary + +`func (o *PasswordPolicyV3Dto) SetUseDictionary(v bool)` + +SetUseDictionary sets UseDictionary field to given value. + +### HasUseDictionary + +`func (o *PasswordPolicyV3Dto) HasUseDictionary() bool` + +HasUseDictionary returns a boolean if a field has been set. + +### GetUseIdentityAttributes + +`func (o *PasswordPolicyV3Dto) GetUseIdentityAttributes() bool` + +GetUseIdentityAttributes returns the UseIdentityAttributes field if non-nil, zero value otherwise. + +### GetUseIdentityAttributesOk + +`func (o *PasswordPolicyV3Dto) GetUseIdentityAttributesOk() (*bool, bool)` + +GetUseIdentityAttributesOk returns a tuple with the UseIdentityAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseIdentityAttributes + +`func (o *PasswordPolicyV3Dto) SetUseIdentityAttributes(v bool)` + +SetUseIdentityAttributes sets UseIdentityAttributes field to given value. + +### HasUseIdentityAttributes + +`func (o *PasswordPolicyV3Dto) HasUseIdentityAttributes() bool` + +HasUseIdentityAttributes returns a boolean if a field has been set. + +### GetValidateAgainstAccountId + +`func (o *PasswordPolicyV3Dto) GetValidateAgainstAccountId() bool` + +GetValidateAgainstAccountId returns the ValidateAgainstAccountId field if non-nil, zero value otherwise. + +### GetValidateAgainstAccountIdOk + +`func (o *PasswordPolicyV3Dto) GetValidateAgainstAccountIdOk() (*bool, bool)` + +GetValidateAgainstAccountIdOk returns a tuple with the ValidateAgainstAccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValidateAgainstAccountId + +`func (o *PasswordPolicyV3Dto) SetValidateAgainstAccountId(v bool)` + +SetValidateAgainstAccountId sets ValidateAgainstAccountId field to given value. + +### HasValidateAgainstAccountId + +`func (o *PasswordPolicyV3Dto) HasValidateAgainstAccountId() bool` + +HasValidateAgainstAccountId returns a boolean if a field has been set. + +### GetValidateAgainstAccountName + +`func (o *PasswordPolicyV3Dto) GetValidateAgainstAccountName() bool` + +GetValidateAgainstAccountName returns the ValidateAgainstAccountName field if non-nil, zero value otherwise. + +### GetValidateAgainstAccountNameOk + +`func (o *PasswordPolicyV3Dto) GetValidateAgainstAccountNameOk() (*bool, bool)` + +GetValidateAgainstAccountNameOk returns a tuple with the ValidateAgainstAccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValidateAgainstAccountName + +`func (o *PasswordPolicyV3Dto) SetValidateAgainstAccountName(v bool)` + +SetValidateAgainstAccountName sets ValidateAgainstAccountName field to given value. + +### HasValidateAgainstAccountName + +`func (o *PasswordPolicyV3Dto) HasValidateAgainstAccountName() bool` + +HasValidateAgainstAccountName returns a boolean if a field has been set. + +### GetCreated + +`func (o *PasswordPolicyV3Dto) GetCreated() string` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *PasswordPolicyV3Dto) GetCreatedOk() (*string, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *PasswordPolicyV3Dto) SetCreated(v string)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *PasswordPolicyV3Dto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *PasswordPolicyV3Dto) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *PasswordPolicyV3Dto) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *PasswordPolicyV3Dto) GetModified() string` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PasswordPolicyV3Dto) GetModifiedOk() (*string, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PasswordPolicyV3Dto) SetModified(v string)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PasswordPolicyV3Dto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *PasswordPolicyV3Dto) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *PasswordPolicyV3Dto) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSourceIds + +`func (o *PasswordPolicyV3Dto) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *PasswordPolicyV3Dto) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *PasswordPolicyV3Dto) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *PasswordPolicyV3Dto) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PasswordStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/PasswordStatus.md new file mode 100644 index 000000000..be862d879 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PasswordStatus.md @@ -0,0 +1,152 @@ +--- +id: beta-password-status +title: PasswordStatus +pagination_label: PasswordStatus +sidebar_label: PasswordStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordStatus', 'BetaPasswordStatus'] +slug: /tools/sdk/go/beta/models/password-status +tags: ['SDK', 'Software Development Kit', 'PasswordStatus', 'BetaPasswordStatus'] +--- + +# PasswordStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **NullableString** | The password change request ID | [optional] +**State** | Pointer to **string** | Password change state | [optional] +**Errors** | Pointer to **[]string** | The errors during the password change request | [optional] +**SourceIds** | Pointer to **[]string** | List of source IDs in the password change request | [optional] + +## Methods + +### NewPasswordStatus + +`func NewPasswordStatus() *PasswordStatus` + +NewPasswordStatus instantiates a new PasswordStatus 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 + +### NewPasswordStatusWithDefaults + +`func NewPasswordStatusWithDefaults() *PasswordStatus` + +NewPasswordStatusWithDefaults instantiates a new PasswordStatus 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 + +### GetRequestId + +`func (o *PasswordStatus) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *PasswordStatus) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *PasswordStatus) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *PasswordStatus) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *PasswordStatus) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *PasswordStatus) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetState + +`func (o *PasswordStatus) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *PasswordStatus) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *PasswordStatus) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *PasswordStatus) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetErrors + +`func (o *PasswordStatus) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *PasswordStatus) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *PasswordStatus) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *PasswordStatus) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### GetSourceIds + +`func (o *PasswordStatus) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *PasswordStatus) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *PasswordStatus) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *PasswordStatus) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PasswordSyncGroup.md b/docs/tools/sdk/go/Reference/Beta/Models/PasswordSyncGroup.md new file mode 100644 index 000000000..d3ca91bb8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PasswordSyncGroup.md @@ -0,0 +1,214 @@ +--- +id: beta-password-sync-group +title: PasswordSyncGroup +pagination_label: PasswordSyncGroup +sidebar_label: PasswordSyncGroup +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordSyncGroup', 'BetaPasswordSyncGroup'] +slug: /tools/sdk/go/beta/models/password-sync-group +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroup', 'BetaPasswordSyncGroup'] +--- + +# PasswordSyncGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the sync group | [optional] +**Name** | Pointer to **string** | Name of the sync group | [optional] +**PasswordPolicyId** | Pointer to **string** | ID of the password policy | [optional] +**SourceIds** | Pointer to **[]string** | List of password managed sources IDs | [optional] +**Created** | Pointer to **NullableTime** | The date and time this sync group was created | [optional] +**Modified** | Pointer to **NullableTime** | The date and time this sync group was last modified | [optional] + +## Methods + +### NewPasswordSyncGroup + +`func NewPasswordSyncGroup() *PasswordSyncGroup` + +NewPasswordSyncGroup instantiates a new PasswordSyncGroup 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 + +### NewPasswordSyncGroupWithDefaults + +`func NewPasswordSyncGroupWithDefaults() *PasswordSyncGroup` + +NewPasswordSyncGroupWithDefaults instantiates a new PasswordSyncGroup 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 + +### GetId + +`func (o *PasswordSyncGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PasswordSyncGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PasswordSyncGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PasswordSyncGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *PasswordSyncGroup) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PasswordSyncGroup) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PasswordSyncGroup) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PasswordSyncGroup) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPasswordPolicyId + +`func (o *PasswordSyncGroup) GetPasswordPolicyId() string` + +GetPasswordPolicyId returns the PasswordPolicyId field if non-nil, zero value otherwise. + +### GetPasswordPolicyIdOk + +`func (o *PasswordSyncGroup) GetPasswordPolicyIdOk() (*string, bool)` + +GetPasswordPolicyIdOk returns a tuple with the PasswordPolicyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicyId + +`func (o *PasswordSyncGroup) SetPasswordPolicyId(v string)` + +SetPasswordPolicyId sets PasswordPolicyId field to given value. + +### HasPasswordPolicyId + +`func (o *PasswordSyncGroup) HasPasswordPolicyId() bool` + +HasPasswordPolicyId returns a boolean if a field has been set. + +### GetSourceIds + +`func (o *PasswordSyncGroup) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *PasswordSyncGroup) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *PasswordSyncGroup) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *PasswordSyncGroup) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + +### GetCreated + +`func (o *PasswordSyncGroup) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *PasswordSyncGroup) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *PasswordSyncGroup) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *PasswordSyncGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *PasswordSyncGroup) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *PasswordSyncGroup) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *PasswordSyncGroup) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PasswordSyncGroup) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PasswordSyncGroup) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PasswordSyncGroup) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *PasswordSyncGroup) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *PasswordSyncGroup) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PatOwner.md b/docs/tools/sdk/go/Reference/Beta/Models/PatOwner.md new file mode 100644 index 000000000..3695d9af1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PatOwner.md @@ -0,0 +1,116 @@ +--- +id: beta-pat-owner +title: PatOwner +pagination_label: PatOwner +sidebar_label: PatOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PatOwner', 'BetaPatOwner'] +slug: /tools/sdk/go/beta/models/pat-owner +tags: ['SDK', 'Software Development Kit', 'PatOwner', 'BetaPatOwner'] +--- + +# PatOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Personal access token owner's DTO type. | [optional] +**Id** | Pointer to **string** | Personal access token owner's identity ID. | [optional] +**Name** | Pointer to **string** | Personal access token owner's human-readable display name. | [optional] + +## Methods + +### NewPatOwner + +`func NewPatOwner() *PatOwner` + +NewPatOwner instantiates a new PatOwner 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 + +### NewPatOwnerWithDefaults + +`func NewPatOwnerWithDefaults() *PatOwner` + +NewPatOwnerWithDefaults instantiates a new PatOwner 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 + +### GetType + +`func (o *PatOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *PatOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *PatOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *PatOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *PatOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PatOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PatOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PatOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *PatOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PatOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PatOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PatOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PatchPotentialRoleRequestInner.md b/docs/tools/sdk/go/Reference/Beta/Models/PatchPotentialRoleRequestInner.md new file mode 100644 index 000000000..13752eedb --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PatchPotentialRoleRequestInner.md @@ -0,0 +1,111 @@ +--- +id: beta-patch-potential-role-request-inner +title: PatchPotentialRoleRequestInner +pagination_label: PatchPotentialRoleRequestInner +sidebar_label: PatchPotentialRoleRequestInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PatchPotentialRoleRequestInner', 'BetaPatchPotentialRoleRequestInner'] +slug: /tools/sdk/go/beta/models/patch-potential-role-request-inner +tags: ['SDK', 'Software Development Kit', 'PatchPotentialRoleRequestInner', 'BetaPatchPotentialRoleRequestInner'] +--- + +# PatchPotentialRoleRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | Pointer to **string** | The operation to be performed | [optional] +**Path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | +**Value** | Pointer to [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] + +## Methods + +### NewPatchPotentialRoleRequestInner + +`func NewPatchPotentialRoleRequestInner(path string, ) *PatchPotentialRoleRequestInner` + +NewPatchPotentialRoleRequestInner instantiates a new PatchPotentialRoleRequestInner 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 + +### NewPatchPotentialRoleRequestInnerWithDefaults + +`func NewPatchPotentialRoleRequestInnerWithDefaults() *PatchPotentialRoleRequestInner` + +NewPatchPotentialRoleRequestInnerWithDefaults instantiates a new PatchPotentialRoleRequestInner 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 + +### GetOp + +`func (o *PatchPotentialRoleRequestInner) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *PatchPotentialRoleRequestInner) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *PatchPotentialRoleRequestInner) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *PatchPotentialRoleRequestInner) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetPath + +`func (o *PatchPotentialRoleRequestInner) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *PatchPotentialRoleRequestInner) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *PatchPotentialRoleRequestInner) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetValue + +`func (o *PatchPotentialRoleRequestInner) GetValue() UpdateMultiHostSourcesRequestInnerValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *PatchPotentialRoleRequestInner) GetValueOk() (*UpdateMultiHostSourcesRequestInnerValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *PatchPotentialRoleRequestInner) SetValue(v UpdateMultiHostSourcesRequestInnerValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *PatchPotentialRoleRequestInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PeerGroupMember.md b/docs/tools/sdk/go/Reference/Beta/Models/PeerGroupMember.md new file mode 100644 index 000000000..447885311 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PeerGroupMember.md @@ -0,0 +1,142 @@ +--- +id: beta-peer-group-member +title: PeerGroupMember +pagination_label: PeerGroupMember +sidebar_label: PeerGroupMember +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PeerGroupMember', 'BetaPeerGroupMember'] +slug: /tools/sdk/go/beta/models/peer-group-member +tags: ['SDK', 'Software Development Kit', 'PeerGroupMember', 'BetaPeerGroupMember'] +--- + +# PeerGroupMember + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | A unique identifier for the peer group member. | [optional] +**Type** | Pointer to **string** | The type of the peer group member. | [optional] +**PeerGroupId** | Pointer to **string** | The ID of the peer group. | [optional] +**Attributes** | Pointer to **map[string]map[string]interface{}** | Arbitrary key-value pairs, belonging to the peer group member. | [optional] + +## Methods + +### NewPeerGroupMember + +`func NewPeerGroupMember() *PeerGroupMember` + +NewPeerGroupMember instantiates a new PeerGroupMember 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 + +### NewPeerGroupMemberWithDefaults + +`func NewPeerGroupMemberWithDefaults() *PeerGroupMember` + +NewPeerGroupMemberWithDefaults instantiates a new PeerGroupMember 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 + +### GetId + +`func (o *PeerGroupMember) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PeerGroupMember) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PeerGroupMember) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PeerGroupMember) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *PeerGroupMember) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *PeerGroupMember) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *PeerGroupMember) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *PeerGroupMember) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetPeerGroupId + +`func (o *PeerGroupMember) GetPeerGroupId() string` + +GetPeerGroupId returns the PeerGroupId field if non-nil, zero value otherwise. + +### GetPeerGroupIdOk + +`func (o *PeerGroupMember) GetPeerGroupIdOk() (*string, bool)` + +GetPeerGroupIdOk returns a tuple with the PeerGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPeerGroupId + +`func (o *PeerGroupMember) SetPeerGroupId(v string)` + +SetPeerGroupId sets PeerGroupId field to given value. + +### HasPeerGroupId + +`func (o *PeerGroupMember) HasPeerGroupId() bool` + +HasPeerGroupId returns a boolean if a field has been set. + +### GetAttributes + +`func (o *PeerGroupMember) GetAttributes() map[string]map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *PeerGroupMember) GetAttributesOk() (*map[string]map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *PeerGroupMember) SetAttributes(v map[string]map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *PeerGroupMember) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PendingApproval.md b/docs/tools/sdk/go/Reference/Beta/Models/PendingApproval.md new file mode 100644 index 000000000..a36a1af08 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PendingApproval.md @@ -0,0 +1,624 @@ +--- +id: beta-pending-approval +title: PendingApproval +pagination_label: PendingApproval +sidebar_label: PendingApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PendingApproval', 'BetaPendingApproval'] +slug: /tools/sdk/go/beta/models/pending-approval +tags: ['SDK', 'Software Development Kit', 'PendingApproval', 'BetaPendingApproval'] +--- + +# PendingApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The approval id. | [optional] +**Name** | Pointer to **string** | The name of the approval. | [optional] +**Created** | Pointer to **SailPointTime** | When the approval was created. | [optional] +**Modified** | Pointer to **SailPointTime** | When the approval was modified last time. | [optional] +**RequestCreated** | Pointer to **SailPointTime** | When the access-request was created. | [optional] +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**Requester** | Pointer to [**AccessItemRequesterDto**](access-item-requester-dto) | | [optional] +**RequestedFor** | Pointer to [**AccessItemRequestedForDto**](access-item-requested-for-dto) | | [optional] +**Owner** | Pointer to [**AccessItemOwnerDto**](access-item-owner-dto) | | [optional] +**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**RequesterComment** | Pointer to [**CommentDto1**](comment-dto1) | | [optional] +**PreviousReviewersComments** | Pointer to [**[]CommentDto1**](comment-dto1) | The history of the previous reviewers comments. | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**CommentRequiredWhenRejected** | Pointer to **bool** | When true the rejector has to provide comments when rejecting | [optional] [default to false] +**ActionInProcess** | Pointer to [**PendingApprovalAction**](pending-approval-action) | | [optional] +**RemoveDate** | Pointer to **SailPointTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**RemoveDateUpdateRequested** | Pointer to **bool** | If true, then the request is to change the remove date or sunset date. | [optional] [default to false] +**CurrentRemoveDate** | Pointer to **SailPointTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**SodViolationContext** | Pointer to [**NullableSodViolationContextCheckCompleted1**](sod-violation-context-check-completed1) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional] +**RequestedAccounts** | Pointer to [**[]RequestedAccountRef**](requested-account-ref) | The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. | [optional] + +## Methods + +### NewPendingApproval + +`func NewPendingApproval() *PendingApproval` + +NewPendingApproval instantiates a new PendingApproval 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 + +### NewPendingApprovalWithDefaults + +`func NewPendingApprovalWithDefaults() *PendingApproval` + +NewPendingApprovalWithDefaults instantiates a new PendingApproval 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 + +### GetId + +`func (o *PendingApproval) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PendingApproval) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PendingApproval) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PendingApproval) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *PendingApproval) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PendingApproval) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PendingApproval) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PendingApproval) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *PendingApproval) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *PendingApproval) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *PendingApproval) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *PendingApproval) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *PendingApproval) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PendingApproval) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PendingApproval) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PendingApproval) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetRequestCreated + +`func (o *PendingApproval) GetRequestCreated() SailPointTime` + +GetRequestCreated returns the RequestCreated field if non-nil, zero value otherwise. + +### GetRequestCreatedOk + +`func (o *PendingApproval) GetRequestCreatedOk() (*SailPointTime, bool)` + +GetRequestCreatedOk returns a tuple with the RequestCreated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCreated + +`func (o *PendingApproval) SetRequestCreated(v SailPointTime)` + +SetRequestCreated sets RequestCreated field to given value. + +### HasRequestCreated + +`func (o *PendingApproval) HasRequestCreated() bool` + +HasRequestCreated returns a boolean if a field has been set. + +### GetRequestType + +`func (o *PendingApproval) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *PendingApproval) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *PendingApproval) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *PendingApproval) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *PendingApproval) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *PendingApproval) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetRequester + +`func (o *PendingApproval) GetRequester() AccessItemRequesterDto` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *PendingApproval) GetRequesterOk() (*AccessItemRequesterDto, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *PendingApproval) SetRequester(v AccessItemRequesterDto)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *PendingApproval) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRequestedFor + +`func (o *PendingApproval) GetRequestedFor() AccessItemRequestedForDto` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *PendingApproval) GetRequestedForOk() (*AccessItemRequestedForDto, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *PendingApproval) SetRequestedFor(v AccessItemRequestedForDto)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *PendingApproval) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetOwner + +`func (o *PendingApproval) GetOwner() AccessItemOwnerDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *PendingApproval) GetOwnerOk() (*AccessItemOwnerDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *PendingApproval) SetOwner(v AccessItemOwnerDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *PendingApproval) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRequestedObject + +`func (o *PendingApproval) GetRequestedObject() RequestableObjectReference` + +GetRequestedObject returns the RequestedObject field if non-nil, zero value otherwise. + +### GetRequestedObjectOk + +`func (o *PendingApproval) GetRequestedObjectOk() (*RequestableObjectReference, bool)` + +GetRequestedObjectOk returns a tuple with the RequestedObject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObject + +`func (o *PendingApproval) SetRequestedObject(v RequestableObjectReference)` + +SetRequestedObject sets RequestedObject field to given value. + +### HasRequestedObject + +`func (o *PendingApproval) HasRequestedObject() bool` + +HasRequestedObject returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *PendingApproval) GetRequesterComment() CommentDto1` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *PendingApproval) GetRequesterCommentOk() (*CommentDto1, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *PendingApproval) SetRequesterComment(v CommentDto1)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *PendingApproval) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### GetPreviousReviewersComments + +`func (o *PendingApproval) GetPreviousReviewersComments() []CommentDto1` + +GetPreviousReviewersComments returns the PreviousReviewersComments field if non-nil, zero value otherwise. + +### GetPreviousReviewersCommentsOk + +`func (o *PendingApproval) GetPreviousReviewersCommentsOk() (*[]CommentDto1, bool)` + +GetPreviousReviewersCommentsOk returns a tuple with the PreviousReviewersComments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousReviewersComments + +`func (o *PendingApproval) SetPreviousReviewersComments(v []CommentDto1)` + +SetPreviousReviewersComments sets PreviousReviewersComments field to given value. + +### HasPreviousReviewersComments + +`func (o *PendingApproval) HasPreviousReviewersComments() bool` + +HasPreviousReviewersComments returns a boolean if a field has been set. + +### GetForwardHistory + +`func (o *PendingApproval) GetForwardHistory() []ApprovalForwardHistory` + +GetForwardHistory returns the ForwardHistory field if non-nil, zero value otherwise. + +### GetForwardHistoryOk + +`func (o *PendingApproval) GetForwardHistoryOk() (*[]ApprovalForwardHistory, bool)` + +GetForwardHistoryOk returns a tuple with the ForwardHistory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwardHistory + +`func (o *PendingApproval) SetForwardHistory(v []ApprovalForwardHistory)` + +SetForwardHistory sets ForwardHistory field to given value. + +### HasForwardHistory + +`func (o *PendingApproval) HasForwardHistory() bool` + +HasForwardHistory returns a boolean if a field has been set. + +### GetCommentRequiredWhenRejected + +`func (o *PendingApproval) GetCommentRequiredWhenRejected() bool` + +GetCommentRequiredWhenRejected returns the CommentRequiredWhenRejected field if non-nil, zero value otherwise. + +### GetCommentRequiredWhenRejectedOk + +`func (o *PendingApproval) GetCommentRequiredWhenRejectedOk() (*bool, bool)` + +GetCommentRequiredWhenRejectedOk returns a tuple with the CommentRequiredWhenRejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentRequiredWhenRejected + +`func (o *PendingApproval) SetCommentRequiredWhenRejected(v bool)` + +SetCommentRequiredWhenRejected sets CommentRequiredWhenRejected field to given value. + +### HasCommentRequiredWhenRejected + +`func (o *PendingApproval) HasCommentRequiredWhenRejected() bool` + +HasCommentRequiredWhenRejected returns a boolean if a field has been set. + +### GetActionInProcess + +`func (o *PendingApproval) GetActionInProcess() PendingApprovalAction` + +GetActionInProcess returns the ActionInProcess field if non-nil, zero value otherwise. + +### GetActionInProcessOk + +`func (o *PendingApproval) GetActionInProcessOk() (*PendingApprovalAction, bool)` + +GetActionInProcessOk returns a tuple with the ActionInProcess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActionInProcess + +`func (o *PendingApproval) SetActionInProcess(v PendingApprovalAction)` + +SetActionInProcess sets ActionInProcess field to given value. + +### HasActionInProcess + +`func (o *PendingApproval) HasActionInProcess() bool` + +HasActionInProcess returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *PendingApproval) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *PendingApproval) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *PendingApproval) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *PendingApproval) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetRemoveDateUpdateRequested + +`func (o *PendingApproval) GetRemoveDateUpdateRequested() bool` + +GetRemoveDateUpdateRequested returns the RemoveDateUpdateRequested field if non-nil, zero value otherwise. + +### GetRemoveDateUpdateRequestedOk + +`func (o *PendingApproval) GetRemoveDateUpdateRequestedOk() (*bool, bool)` + +GetRemoveDateUpdateRequestedOk returns a tuple with the RemoveDateUpdateRequested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDateUpdateRequested + +`func (o *PendingApproval) SetRemoveDateUpdateRequested(v bool)` + +SetRemoveDateUpdateRequested sets RemoveDateUpdateRequested field to given value. + +### HasRemoveDateUpdateRequested + +`func (o *PendingApproval) HasRemoveDateUpdateRequested() bool` + +HasRemoveDateUpdateRequested returns a boolean if a field has been set. + +### GetCurrentRemoveDate + +`func (o *PendingApproval) GetCurrentRemoveDate() SailPointTime` + +GetCurrentRemoveDate returns the CurrentRemoveDate field if non-nil, zero value otherwise. + +### GetCurrentRemoveDateOk + +`func (o *PendingApproval) GetCurrentRemoveDateOk() (*SailPointTime, bool)` + +GetCurrentRemoveDateOk returns a tuple with the CurrentRemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentRemoveDate + +`func (o *PendingApproval) SetCurrentRemoveDate(v SailPointTime)` + +SetCurrentRemoveDate sets CurrentRemoveDate field to given value. + +### HasCurrentRemoveDate + +`func (o *PendingApproval) HasCurrentRemoveDate() bool` + +HasCurrentRemoveDate returns a boolean if a field has been set. + +### GetSodViolationContext + +`func (o *PendingApproval) GetSodViolationContext() SodViolationContextCheckCompleted1` + +GetSodViolationContext returns the SodViolationContext field if non-nil, zero value otherwise. + +### GetSodViolationContextOk + +`func (o *PendingApproval) GetSodViolationContextOk() (*SodViolationContextCheckCompleted1, bool)` + +GetSodViolationContextOk returns a tuple with the SodViolationContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodViolationContext + +`func (o *PendingApproval) SetSodViolationContext(v SodViolationContextCheckCompleted1)` + +SetSodViolationContext sets SodViolationContext field to given value. + +### HasSodViolationContext + +`func (o *PendingApproval) HasSodViolationContext() bool` + +HasSodViolationContext returns a boolean if a field has been set. + +### SetSodViolationContextNil + +`func (o *PendingApproval) SetSodViolationContextNil(b bool)` + + SetSodViolationContextNil sets the value for SodViolationContext to be an explicit nil + +### UnsetSodViolationContext +`func (o *PendingApproval) UnsetSodViolationContext()` + +UnsetSodViolationContext ensures that no value is present for SodViolationContext, not even an explicit nil +### GetClientMetadata + +`func (o *PendingApproval) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *PendingApproval) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *PendingApproval) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *PendingApproval) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *PendingApproval) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *PendingApproval) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetRequestedAccounts + +`func (o *PendingApproval) GetRequestedAccounts() []RequestedAccountRef` + +GetRequestedAccounts returns the RequestedAccounts field if non-nil, zero value otherwise. + +### GetRequestedAccountsOk + +`func (o *PendingApproval) GetRequestedAccountsOk() (*[]RequestedAccountRef, bool)` + +GetRequestedAccountsOk returns a tuple with the RequestedAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedAccounts + +`func (o *PendingApproval) SetRequestedAccounts(v []RequestedAccountRef)` + +SetRequestedAccounts sets RequestedAccounts field to given value. + +### HasRequestedAccounts + +`func (o *PendingApproval) HasRequestedAccounts() bool` + +HasRequestedAccounts returns a boolean if a field has been set. + +### SetRequestedAccountsNil + +`func (o *PendingApproval) SetRequestedAccountsNil(b bool)` + + SetRequestedAccountsNil sets the value for RequestedAccounts to be an explicit nil + +### UnsetRequestedAccounts +`func (o *PendingApproval) UnsetRequestedAccounts()` + +UnsetRequestedAccounts ensures that no value is present for RequestedAccounts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PendingApprovalAction.md b/docs/tools/sdk/go/Reference/Beta/Models/PendingApprovalAction.md new file mode 100644 index 000000000..9ae292938 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PendingApprovalAction.md @@ -0,0 +1,23 @@ +--- +id: beta-pending-approval-action +title: PendingApprovalAction +pagination_label: PendingApprovalAction +sidebar_label: PendingApprovalAction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PendingApprovalAction', 'BetaPendingApprovalAction'] +slug: /tools/sdk/go/beta/models/pending-approval-action +tags: ['SDK', 'Software Development Kit', 'PendingApprovalAction', 'BetaPendingApprovalAction'] +--- + +# PendingApprovalAction + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `FORWARDED` (value: `"FORWARDED"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PermissionDto.md b/docs/tools/sdk/go/Reference/Beta/Models/PermissionDto.md new file mode 100644 index 000000000..3097a53dd --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PermissionDto.md @@ -0,0 +1,90 @@ +--- +id: beta-permission-dto +title: PermissionDto +pagination_label: PermissionDto +sidebar_label: PermissionDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PermissionDto', 'BetaPermissionDto'] +slug: /tools/sdk/go/beta/models/permission-dto +tags: ['SDK', 'Software Development Kit', 'PermissionDto', 'BetaPermissionDto'] +--- + +# PermissionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Rights** | Pointer to **[]string** | All the rights (e.g. actions) that this permission allows on the target | [optional] [readonly] +**Target** | Pointer to **string** | The target the permission would grants rights on. | [optional] [readonly] + +## Methods + +### NewPermissionDto + +`func NewPermissionDto() *PermissionDto` + +NewPermissionDto instantiates a new PermissionDto 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 + +### NewPermissionDtoWithDefaults + +`func NewPermissionDtoWithDefaults() *PermissionDto` + +NewPermissionDtoWithDefaults instantiates a new PermissionDto 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 + +### GetRights + +`func (o *PermissionDto) GetRights() []string` + +GetRights returns the Rights field if non-nil, zero value otherwise. + +### GetRightsOk + +`func (o *PermissionDto) GetRightsOk() (*[]string, bool)` + +GetRightsOk returns a tuple with the Rights field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRights + +`func (o *PermissionDto) SetRights(v []string)` + +SetRights sets Rights field to given value. + +### HasRights + +`func (o *PermissionDto) HasRights() bool` + +HasRights returns a boolean if a field has been set. + +### GetTarget + +`func (o *PermissionDto) GetTarget() string` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *PermissionDto) GetTargetOk() (*string, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *PermissionDto) SetTarget(v string)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *PermissionDto) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PostExternalExecuteWorkflow200Response.md b/docs/tools/sdk/go/Reference/Beta/Models/PostExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..f75771072 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PostExternalExecuteWorkflow200Response.md @@ -0,0 +1,90 @@ +--- +id: beta-post-external-execute-workflow200-response +title: PostExternalExecuteWorkflow200Response +pagination_label: PostExternalExecuteWorkflow200Response +sidebar_label: PostExternalExecuteWorkflow200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PostExternalExecuteWorkflow200Response', 'BetaPostExternalExecuteWorkflow200Response'] +slug: /tools/sdk/go/beta/models/post-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'PostExternalExecuteWorkflow200Response', 'BetaPostExternalExecuteWorkflow200Response'] +--- + +# PostExternalExecuteWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**WorkflowExecutionId** | Pointer to **string** | The workflow execution id | [optional] +**Message** | Pointer to **string** | An error message if any errors occurred | [optional] + +## Methods + +### NewPostExternalExecuteWorkflow200Response + +`func NewPostExternalExecuteWorkflow200Response() *PostExternalExecuteWorkflow200Response` + +NewPostExternalExecuteWorkflow200Response instantiates a new PostExternalExecuteWorkflow200Response 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 + +### NewPostExternalExecuteWorkflow200ResponseWithDefaults + +`func NewPostExternalExecuteWorkflow200ResponseWithDefaults() *PostExternalExecuteWorkflow200Response` + +NewPostExternalExecuteWorkflow200ResponseWithDefaults instantiates a new PostExternalExecuteWorkflow200Response 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 + +### GetWorkflowExecutionId + +`func (o *PostExternalExecuteWorkflow200Response) GetWorkflowExecutionId() string` + +GetWorkflowExecutionId returns the WorkflowExecutionId field if non-nil, zero value otherwise. + +### GetWorkflowExecutionIdOk + +`func (o *PostExternalExecuteWorkflow200Response) GetWorkflowExecutionIdOk() (*string, bool)` + +GetWorkflowExecutionIdOk returns a tuple with the WorkflowExecutionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWorkflowExecutionId + +`func (o *PostExternalExecuteWorkflow200Response) SetWorkflowExecutionId(v string)` + +SetWorkflowExecutionId sets WorkflowExecutionId field to given value. + +### HasWorkflowExecutionId + +`func (o *PostExternalExecuteWorkflow200Response) HasWorkflowExecutionId() bool` + +HasWorkflowExecutionId returns a boolean if a field has been set. + +### GetMessage + +`func (o *PostExternalExecuteWorkflow200Response) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *PostExternalExecuteWorkflow200Response) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *PostExternalExecuteWorkflow200Response) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *PostExternalExecuteWorkflow200Response) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PostExternalExecuteWorkflowRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/PostExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..c17278c86 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PostExternalExecuteWorkflowRequest.md @@ -0,0 +1,64 @@ +--- +id: beta-post-external-execute-workflow-request +title: PostExternalExecuteWorkflowRequest +pagination_label: PostExternalExecuteWorkflowRequest +sidebar_label: PostExternalExecuteWorkflowRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PostExternalExecuteWorkflowRequest', 'BetaPostExternalExecuteWorkflowRequest'] +slug: /tools/sdk/go/beta/models/post-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'PostExternalExecuteWorkflowRequest', 'BetaPostExternalExecuteWorkflowRequest'] +--- + +# PostExternalExecuteWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | Pointer to **map[string]interface{}** | The input for the workflow | [optional] + +## Methods + +### NewPostExternalExecuteWorkflowRequest + +`func NewPostExternalExecuteWorkflowRequest() *PostExternalExecuteWorkflowRequest` + +NewPostExternalExecuteWorkflowRequest instantiates a new PostExternalExecuteWorkflowRequest 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 + +### NewPostExternalExecuteWorkflowRequestWithDefaults + +`func NewPostExternalExecuteWorkflowRequestWithDefaults() *PostExternalExecuteWorkflowRequest` + +NewPostExternalExecuteWorkflowRequestWithDefaults instantiates a new PostExternalExecuteWorkflowRequest 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 + +### GetInput + +`func (o *PostExternalExecuteWorkflowRequest) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *PostExternalExecuteWorkflowRequest) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *PostExternalExecuteWorkflowRequest) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + +### HasInput + +`func (o *PostExternalExecuteWorkflowRequest) HasInput() bool` + +HasInput returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PreApprovalTriggerDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/PreApprovalTriggerDetails.md new file mode 100644 index 000000000..77df673e7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PreApprovalTriggerDetails.md @@ -0,0 +1,116 @@ +--- +id: beta-pre-approval-trigger-details +title: PreApprovalTriggerDetails +pagination_label: PreApprovalTriggerDetails +sidebar_label: PreApprovalTriggerDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PreApprovalTriggerDetails', 'BetaPreApprovalTriggerDetails'] +slug: /tools/sdk/go/beta/models/pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'PreApprovalTriggerDetails', 'BetaPreApprovalTriggerDetails'] +--- + +# PreApprovalTriggerDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment left for the pre-approval decision | [optional] +**Reviewer** | Pointer to **string** | The reviewer of the pre-approval decision | [optional] +**Decision** | Pointer to **string** | The decision of the pre-approval trigger | [optional] + +## Methods + +### NewPreApprovalTriggerDetails + +`func NewPreApprovalTriggerDetails() *PreApprovalTriggerDetails` + +NewPreApprovalTriggerDetails instantiates a new PreApprovalTriggerDetails 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 + +### NewPreApprovalTriggerDetailsWithDefaults + +`func NewPreApprovalTriggerDetailsWithDefaults() *PreApprovalTriggerDetails` + +NewPreApprovalTriggerDetailsWithDefaults instantiates a new PreApprovalTriggerDetails 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 + +### GetComment + +`func (o *PreApprovalTriggerDetails) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *PreApprovalTriggerDetails) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *PreApprovalTriggerDetails) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *PreApprovalTriggerDetails) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetReviewer + +`func (o *PreApprovalTriggerDetails) GetReviewer() string` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *PreApprovalTriggerDetails) GetReviewerOk() (*string, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *PreApprovalTriggerDetails) SetReviewer(v string)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *PreApprovalTriggerDetails) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetDecision + +`func (o *PreApprovalTriggerDetails) GetDecision() string` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *PreApprovalTriggerDetails) GetDecisionOk() (*string, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *PreApprovalTriggerDetails) SetDecision(v string)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *PreApprovalTriggerDetails) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PreferencesDto.md b/docs/tools/sdk/go/Reference/Beta/Models/PreferencesDto.md new file mode 100644 index 000000000..03ccbe1b7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PreferencesDto.md @@ -0,0 +1,116 @@ +--- +id: beta-preferences-dto +title: PreferencesDto +pagination_label: PreferencesDto +sidebar_label: PreferencesDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PreferencesDto', 'BetaPreferencesDto'] +slug: /tools/sdk/go/beta/models/preferences-dto +tags: ['SDK', 'Software Development Kit', 'PreferencesDto', 'BetaPreferencesDto'] +--- + +# PreferencesDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The template notification key. | [optional] +**Mediums** | Pointer to [**[]Medium**](medium) | List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. | [optional] +**Modified** | Pointer to **SailPointTime** | Modified date of preference | [optional] + +## Methods + +### NewPreferencesDto + +`func NewPreferencesDto() *PreferencesDto` + +NewPreferencesDto instantiates a new PreferencesDto 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 + +### NewPreferencesDtoWithDefaults + +`func NewPreferencesDtoWithDefaults() *PreferencesDto` + +NewPreferencesDtoWithDefaults instantiates a new PreferencesDto 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 + +### GetKey + +`func (o *PreferencesDto) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *PreferencesDto) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *PreferencesDto) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *PreferencesDto) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetMediums + +`func (o *PreferencesDto) GetMediums() []Medium` + +GetMediums returns the Mediums field if non-nil, zero value otherwise. + +### GetMediumsOk + +`func (o *PreferencesDto) GetMediumsOk() (*[]Medium, bool)` + +GetMediumsOk returns a tuple with the Mediums field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMediums + +`func (o *PreferencesDto) SetMediums(v []Medium)` + +SetMediums sets Mediums field to given value. + +### HasMediums + +`func (o *PreferencesDto) HasMediums() bool` + +HasMediums returns a boolean if a field has been set. + +### GetModified + +`func (o *PreferencesDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PreferencesDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PreferencesDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PreferencesDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PreviewDataSourceResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/PreviewDataSourceResponse.md new file mode 100644 index 000000000..c5b409350 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PreviewDataSourceResponse.md @@ -0,0 +1,64 @@ +--- +id: beta-preview-data-source-response +title: PreviewDataSourceResponse +pagination_label: PreviewDataSourceResponse +sidebar_label: PreviewDataSourceResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PreviewDataSourceResponse', 'BetaPreviewDataSourceResponse'] +slug: /tools/sdk/go/beta/models/preview-data-source-response +tags: ['SDK', 'Software Development Kit', 'PreviewDataSourceResponse', 'BetaPreviewDataSourceResponse'] +--- + +# PreviewDataSourceResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | Pointer to [**[]FormElementDataSourceConfigOptions**](form-element-data-source-config-options) | Results holds a list of FormElementDataSourceConfigOptions items | [optional] + +## Methods + +### NewPreviewDataSourceResponse + +`func NewPreviewDataSourceResponse() *PreviewDataSourceResponse` + +NewPreviewDataSourceResponse instantiates a new PreviewDataSourceResponse 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 + +### NewPreviewDataSourceResponseWithDefaults + +`func NewPreviewDataSourceResponseWithDefaults() *PreviewDataSourceResponse` + +NewPreviewDataSourceResponseWithDefaults instantiates a new PreviewDataSourceResponse 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 + +### GetResults + +`func (o *PreviewDataSourceResponse) GetResults() []FormElementDataSourceConfigOptions` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PreviewDataSourceResponse) GetResultsOk() (*[]FormElementDataSourceConfigOptions, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PreviewDataSourceResponse) SetResults(v []FormElementDataSourceConfigOptions)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PreviewDataSourceResponse) HasResults() bool` + +HasResults returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProcessIdentitiesRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/ProcessIdentitiesRequest.md new file mode 100644 index 000000000..c11f2dadb --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProcessIdentitiesRequest.md @@ -0,0 +1,64 @@ +--- +id: beta-process-identities-request +title: ProcessIdentitiesRequest +pagination_label: ProcessIdentitiesRequest +sidebar_label: ProcessIdentitiesRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProcessIdentitiesRequest', 'BetaProcessIdentitiesRequest'] +slug: /tools/sdk/go/beta/models/process-identities-request +tags: ['SDK', 'Software Development Kit', 'ProcessIdentitiesRequest', 'BetaProcessIdentitiesRequest'] +--- + +# ProcessIdentitiesRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityIds** | Pointer to **[]string** | List of up to 250 identity IDs to process. | [optional] + +## Methods + +### NewProcessIdentitiesRequest + +`func NewProcessIdentitiesRequest() *ProcessIdentitiesRequest` + +NewProcessIdentitiesRequest instantiates a new ProcessIdentitiesRequest 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 + +### NewProcessIdentitiesRequestWithDefaults + +`func NewProcessIdentitiesRequestWithDefaults() *ProcessIdentitiesRequest` + +NewProcessIdentitiesRequestWithDefaults instantiates a new ProcessIdentitiesRequest 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 + +### GetIdentityIds + +`func (o *ProcessIdentitiesRequest) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *ProcessIdentitiesRequest) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *ProcessIdentitiesRequest) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *ProcessIdentitiesRequest) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Product.md b/docs/tools/sdk/go/Reference/Beta/Models/Product.md new file mode 100644 index 000000000..e064db8c0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Product.md @@ -0,0 +1,494 @@ +--- +id: beta-product +title: Product +pagination_label: Product +sidebar_label: Product +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Product', 'BetaProduct'] +slug: /tools/sdk/go/beta/models/product +tags: ['SDK', 'Software Development Kit', 'Product', 'BetaProduct'] +--- + +# Product + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProductName** | Pointer to **string** | Name of the Product | [optional] +**Url** | Pointer to **string** | URL of the Product | [optional] +**ProductTenantId** | Pointer to **string** | An identifier for a specific product-tenant combination | [optional] +**ProductRegion** | Pointer to **string** | Product region | [optional] +**ProductRight** | Pointer to **string** | Right needed for the Product | [optional] +**ApiUrl** | Pointer to **NullableString** | API URL of the Product | [optional] +**Licenses** | Pointer to [**[]License**](license) | | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Additional attributes for a product | [optional] +**Zone** | Pointer to **string** | Zone | [optional] +**Status** | Pointer to **string** | Status of the product | [optional] +**StatusDateTime** | Pointer to **SailPointTime** | Status datetime | [optional] +**Reason** | Pointer to **string** | If there's a tenant provisioning failure then reason will have the description of error | [optional] +**Notes** | Pointer to **string** | Product could have additional notes added during tenant provisioning. | [optional] +**DateCreated** | Pointer to **NullableTime** | Date when the product was created | [optional] +**LastUpdated** | Pointer to **NullableTime** | Date when the product was last updated | [optional] +**OrgType** | Pointer to **NullableString** | Type of org | [optional] + +## Methods + +### NewProduct + +`func NewProduct() *Product` + +NewProduct instantiates a new Product 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 + +### NewProductWithDefaults + +`func NewProductWithDefaults() *Product` + +NewProductWithDefaults instantiates a new Product 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 + +### GetProductName + +`func (o *Product) GetProductName() string` + +GetProductName returns the ProductName field if non-nil, zero value otherwise. + +### GetProductNameOk + +`func (o *Product) GetProductNameOk() (*string, bool)` + +GetProductNameOk returns a tuple with the ProductName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductName + +`func (o *Product) SetProductName(v string)` + +SetProductName sets ProductName field to given value. + +### HasProductName + +`func (o *Product) HasProductName() bool` + +HasProductName returns a boolean if a field has been set. + +### GetUrl + +`func (o *Product) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *Product) GetUrlOk() (*string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrl + +`func (o *Product) SetUrl(v string)` + +SetUrl sets Url field to given value. + +### HasUrl + +`func (o *Product) HasUrl() bool` + +HasUrl returns a boolean if a field has been set. + +### GetProductTenantId + +`func (o *Product) GetProductTenantId() string` + +GetProductTenantId returns the ProductTenantId field if non-nil, zero value otherwise. + +### GetProductTenantIdOk + +`func (o *Product) GetProductTenantIdOk() (*string, bool)` + +GetProductTenantIdOk returns a tuple with the ProductTenantId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductTenantId + +`func (o *Product) SetProductTenantId(v string)` + +SetProductTenantId sets ProductTenantId field to given value. + +### HasProductTenantId + +`func (o *Product) HasProductTenantId() bool` + +HasProductTenantId returns a boolean if a field has been set. + +### GetProductRegion + +`func (o *Product) GetProductRegion() string` + +GetProductRegion returns the ProductRegion field if non-nil, zero value otherwise. + +### GetProductRegionOk + +`func (o *Product) GetProductRegionOk() (*string, bool)` + +GetProductRegionOk returns a tuple with the ProductRegion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductRegion + +`func (o *Product) SetProductRegion(v string)` + +SetProductRegion sets ProductRegion field to given value. + +### HasProductRegion + +`func (o *Product) HasProductRegion() bool` + +HasProductRegion returns a boolean if a field has been set. + +### GetProductRight + +`func (o *Product) GetProductRight() string` + +GetProductRight returns the ProductRight field if non-nil, zero value otherwise. + +### GetProductRightOk + +`func (o *Product) GetProductRightOk() (*string, bool)` + +GetProductRightOk returns a tuple with the ProductRight field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductRight + +`func (o *Product) SetProductRight(v string)` + +SetProductRight sets ProductRight field to given value. + +### HasProductRight + +`func (o *Product) HasProductRight() bool` + +HasProductRight returns a boolean if a field has been set. + +### GetApiUrl + +`func (o *Product) GetApiUrl() string` + +GetApiUrl returns the ApiUrl field if non-nil, zero value otherwise. + +### GetApiUrlOk + +`func (o *Product) GetApiUrlOk() (*string, bool)` + +GetApiUrlOk returns a tuple with the ApiUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiUrl + +`func (o *Product) SetApiUrl(v string)` + +SetApiUrl sets ApiUrl field to given value. + +### HasApiUrl + +`func (o *Product) HasApiUrl() bool` + +HasApiUrl returns a boolean if a field has been set. + +### SetApiUrlNil + +`func (o *Product) SetApiUrlNil(b bool)` + + SetApiUrlNil sets the value for ApiUrl to be an explicit nil + +### UnsetApiUrl +`func (o *Product) UnsetApiUrl()` + +UnsetApiUrl ensures that no value is present for ApiUrl, not even an explicit nil +### GetLicenses + +`func (o *Product) GetLicenses() []License` + +GetLicenses returns the Licenses field if non-nil, zero value otherwise. + +### GetLicensesOk + +`func (o *Product) GetLicensesOk() (*[]License, bool)` + +GetLicensesOk returns a tuple with the Licenses field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLicenses + +`func (o *Product) SetLicenses(v []License)` + +SetLicenses sets Licenses field to given value. + +### HasLicenses + +`func (o *Product) HasLicenses() bool` + +HasLicenses returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Product) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Product) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Product) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Product) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetZone + +`func (o *Product) GetZone() string` + +GetZone returns the Zone field if non-nil, zero value otherwise. + +### GetZoneOk + +`func (o *Product) GetZoneOk() (*string, bool)` + +GetZoneOk returns a tuple with the Zone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetZone + +`func (o *Product) SetZone(v string)` + +SetZone sets Zone field to given value. + +### HasZone + +`func (o *Product) HasZone() bool` + +HasZone returns a boolean if a field has been set. + +### GetStatus + +`func (o *Product) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Product) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Product) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Product) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetStatusDateTime + +`func (o *Product) GetStatusDateTime() SailPointTime` + +GetStatusDateTime returns the StatusDateTime field if non-nil, zero value otherwise. + +### GetStatusDateTimeOk + +`func (o *Product) GetStatusDateTimeOk() (*SailPointTime, bool)` + +GetStatusDateTimeOk returns a tuple with the StatusDateTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusDateTime + +`func (o *Product) SetStatusDateTime(v SailPointTime)` + +SetStatusDateTime sets StatusDateTime field to given value. + +### HasStatusDateTime + +`func (o *Product) HasStatusDateTime() bool` + +HasStatusDateTime returns a boolean if a field has been set. + +### GetReason + +`func (o *Product) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *Product) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *Product) SetReason(v string)` + +SetReason sets Reason field to given value. + +### HasReason + +`func (o *Product) HasReason() bool` + +HasReason returns a boolean if a field has been set. + +### GetNotes + +`func (o *Product) GetNotes() string` + +GetNotes returns the Notes field if non-nil, zero value otherwise. + +### GetNotesOk + +`func (o *Product) GetNotesOk() (*string, bool)` + +GetNotesOk returns a tuple with the Notes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotes + +`func (o *Product) SetNotes(v string)` + +SetNotes sets Notes field to given value. + +### HasNotes + +`func (o *Product) HasNotes() bool` + +HasNotes returns a boolean if a field has been set. + +### GetDateCreated + +`func (o *Product) GetDateCreated() SailPointTime` + +GetDateCreated returns the DateCreated field if non-nil, zero value otherwise. + +### GetDateCreatedOk + +`func (o *Product) GetDateCreatedOk() (*SailPointTime, bool)` + +GetDateCreatedOk returns a tuple with the DateCreated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDateCreated + +`func (o *Product) SetDateCreated(v SailPointTime)` + +SetDateCreated sets DateCreated field to given value. + +### HasDateCreated + +`func (o *Product) HasDateCreated() bool` + +HasDateCreated returns a boolean if a field has been set. + +### SetDateCreatedNil + +`func (o *Product) SetDateCreatedNil(b bool)` + + SetDateCreatedNil sets the value for DateCreated to be an explicit nil + +### UnsetDateCreated +`func (o *Product) UnsetDateCreated()` + +UnsetDateCreated ensures that no value is present for DateCreated, not even an explicit nil +### GetLastUpdated + +`func (o *Product) GetLastUpdated() SailPointTime` + +GetLastUpdated returns the LastUpdated field if non-nil, zero value otherwise. + +### GetLastUpdatedOk + +`func (o *Product) GetLastUpdatedOk() (*SailPointTime, bool)` + +GetLastUpdatedOk returns a tuple with the LastUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdated + +`func (o *Product) SetLastUpdated(v SailPointTime)` + +SetLastUpdated sets LastUpdated field to given value. + +### HasLastUpdated + +`func (o *Product) HasLastUpdated() bool` + +HasLastUpdated returns a boolean if a field has been set. + +### SetLastUpdatedNil + +`func (o *Product) SetLastUpdatedNil(b bool)` + + SetLastUpdatedNil sets the value for LastUpdated to be an explicit nil + +### UnsetLastUpdated +`func (o *Product) UnsetLastUpdated()` + +UnsetLastUpdated ensures that no value is present for LastUpdated, not even an explicit nil +### GetOrgType + +`func (o *Product) GetOrgType() string` + +GetOrgType returns the OrgType field if non-nil, zero value otherwise. + +### GetOrgTypeOk + +`func (o *Product) GetOrgTypeOk() (*string, bool)` + +GetOrgTypeOk returns a tuple with the OrgType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgType + +`func (o *Product) SetOrgType(v string)` + +SetOrgType sets OrgType field to given value. + +### HasOrgType + +`func (o *Product) HasOrgType() bool` + +HasOrgType returns a boolean if a field has been set. + +### SetOrgTypeNil + +`func (o *Product) SetOrgTypeNil(b bool)` + + SetOrgTypeNil sets the value for OrgType to be an explicit nil + +### UnsetOrgType +`func (o *Product) UnsetOrgType()` + +UnsetOrgType ensures that no value is present for OrgType, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompleted.md b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompleted.md new file mode 100644 index 000000000..ad1bc14ba --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompleted.md @@ -0,0 +1,266 @@ +--- +id: beta-provisioning-completed +title: ProvisioningCompleted +pagination_label: ProvisioningCompleted +sidebar_label: ProvisioningCompleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompleted', 'BetaProvisioningCompleted'] +slug: /tools/sdk/go/beta/models/provisioning-completed +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompleted', 'BetaProvisioningCompleted'] +--- + +# ProvisioningCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TrackingNumber** | **string** | Provisioning request's reference number. Useful for tracking status in the 'Account Activity' search interface. | +**Sources** | **string** | Sources the provisioning transactions were performed on. Sources are comma separated. | +**Action** | Pointer to **NullableString** | Origin of the provisioning request. | [optional] +**Errors** | Pointer to **[]string** | List of any accumulated error messages that occurred during provisioning. | [optional] +**Warnings** | Pointer to **[]string** | List of any accumulated warning messages that occurred during provisioning. | [optional] +**Recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | +**Requester** | Pointer to [**NullableProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional] +**AccountRequests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | List of provisioning instructions to perform on an account-by-account basis. | + +## Methods + +### NewProvisioningCompleted + +`func NewProvisioningCompleted(trackingNumber string, sources string, recipient ProvisioningCompletedRecipient, accountRequests []ProvisioningCompletedAccountRequestsInner, ) *ProvisioningCompleted` + +NewProvisioningCompleted instantiates a new ProvisioningCompleted 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 + +### NewProvisioningCompletedWithDefaults + +`func NewProvisioningCompletedWithDefaults() *ProvisioningCompleted` + +NewProvisioningCompletedWithDefaults instantiates a new ProvisioningCompleted 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 + +### GetTrackingNumber + +`func (o *ProvisioningCompleted) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *ProvisioningCompleted) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *ProvisioningCompleted) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + + +### GetSources + +`func (o *ProvisioningCompleted) GetSources() string` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *ProvisioningCompleted) GetSourcesOk() (*string, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *ProvisioningCompleted) SetSources(v string)` + +SetSources sets Sources field to given value. + + +### GetAction + +`func (o *ProvisioningCompleted) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *ProvisioningCompleted) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *ProvisioningCompleted) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *ProvisioningCompleted) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### SetActionNil + +`func (o *ProvisioningCompleted) SetActionNil(b bool)` + + SetActionNil sets the value for Action to be an explicit nil + +### UnsetAction +`func (o *ProvisioningCompleted) UnsetAction()` + +UnsetAction ensures that no value is present for Action, not even an explicit nil +### GetErrors + +`func (o *ProvisioningCompleted) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *ProvisioningCompleted) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *ProvisioningCompleted) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *ProvisioningCompleted) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### SetErrorsNil + +`func (o *ProvisioningCompleted) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *ProvisioningCompleted) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *ProvisioningCompleted) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *ProvisioningCompleted) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *ProvisioningCompleted) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *ProvisioningCompleted) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + +### SetWarningsNil + +`func (o *ProvisioningCompleted) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *ProvisioningCompleted) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetRecipient + +`func (o *ProvisioningCompleted) GetRecipient() ProvisioningCompletedRecipient` + +GetRecipient returns the Recipient field if non-nil, zero value otherwise. + +### GetRecipientOk + +`func (o *ProvisioningCompleted) GetRecipientOk() (*ProvisioningCompletedRecipient, bool)` + +GetRecipientOk returns a tuple with the Recipient field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipient + +`func (o *ProvisioningCompleted) SetRecipient(v ProvisioningCompletedRecipient)` + +SetRecipient sets Recipient field to given value. + + +### GetRequester + +`func (o *ProvisioningCompleted) GetRequester() ProvisioningCompletedRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *ProvisioningCompleted) GetRequesterOk() (*ProvisioningCompletedRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *ProvisioningCompleted) SetRequester(v ProvisioningCompletedRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *ProvisioningCompleted) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### SetRequesterNil + +`func (o *ProvisioningCompleted) SetRequesterNil(b bool)` + + SetRequesterNil sets the value for Requester to be an explicit nil + +### UnsetRequester +`func (o *ProvisioningCompleted) UnsetRequester()` + +UnsetRequester ensures that no value is present for Requester, not even an explicit nil +### GetAccountRequests + +`func (o *ProvisioningCompleted) GetAccountRequests() []ProvisioningCompletedAccountRequestsInner` + +GetAccountRequests returns the AccountRequests field if non-nil, zero value otherwise. + +### GetAccountRequestsOk + +`func (o *ProvisioningCompleted) GetAccountRequestsOk() (*[]ProvisioningCompletedAccountRequestsInner, bool)` + +GetAccountRequestsOk returns a tuple with the AccountRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountRequests + +`func (o *ProvisioningCompleted) SetAccountRequests(v []ProvisioningCompletedAccountRequestsInner)` + +SetAccountRequests sets AccountRequests field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInner.md b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInner.md new file mode 100644 index 000000000..b58d801ac --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInner.md @@ -0,0 +1,220 @@ +--- +id: beta-provisioning-completed-account-requests-inner +title: ProvisioningCompletedAccountRequestsInner +pagination_label: ProvisioningCompletedAccountRequestsInner +sidebar_label: ProvisioningCompletedAccountRequestsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompletedAccountRequestsInner', 'BetaProvisioningCompletedAccountRequestsInner'] +slug: /tools/sdk/go/beta/models/provisioning-completed-account-requests-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInner', 'BetaProvisioningCompletedAccountRequestsInner'] +--- + +# ProvisioningCompletedAccountRequestsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**ProvisioningCompletedAccountRequestsInnerSource**](provisioning-completed-account-requests-inner-source) | | +**AccountId** | Pointer to **string** | Unique idenfier of the account being provisioned. | [optional] +**AccountOperation** | **string** | Provisioning operation. | +**ProvisioningResult** | **map[string]interface{}** | Overall result of the provisioning transaction. | +**ProvisioningTarget** | **string** | Nme of the selected provisioning channel selected. This could be the same as the source, or it could be a Service Desk Integration Module (SDIM). | +**TicketId** | Pointer to **NullableString** | Reference to a tracking number for if this is sent to a SDIM. | [optional] +**AttributeRequests** | Pointer to [**[]ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner**](provisioning-completed-account-requests-inner-attribute-requests-inner) | List of attributes to include in the provisioning transaction. | [optional] + +## Methods + +### NewProvisioningCompletedAccountRequestsInner + +`func NewProvisioningCompletedAccountRequestsInner(source ProvisioningCompletedAccountRequestsInnerSource, accountOperation string, provisioningResult map[string]interface{}, provisioningTarget string, ) *ProvisioningCompletedAccountRequestsInner` + +NewProvisioningCompletedAccountRequestsInner instantiates a new ProvisioningCompletedAccountRequestsInner 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 + +### NewProvisioningCompletedAccountRequestsInnerWithDefaults + +`func NewProvisioningCompletedAccountRequestsInnerWithDefaults() *ProvisioningCompletedAccountRequestsInner` + +NewProvisioningCompletedAccountRequestsInnerWithDefaults instantiates a new ProvisioningCompletedAccountRequestsInner 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 + +### GetSource + +`func (o *ProvisioningCompletedAccountRequestsInner) GetSource() ProvisioningCompletedAccountRequestsInnerSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetSourceOk() (*ProvisioningCompletedAccountRequestsInnerSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *ProvisioningCompletedAccountRequestsInner) SetSource(v ProvisioningCompletedAccountRequestsInnerSource)` + +SetSource sets Source field to given value. + + +### GetAccountId + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *ProvisioningCompletedAccountRequestsInner) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *ProvisioningCompletedAccountRequestsInner) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetAccountOperation + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAccountOperation() string` + +GetAccountOperation returns the AccountOperation field if non-nil, zero value otherwise. + +### GetAccountOperationOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAccountOperationOk() (*string, bool)` + +GetAccountOperationOk returns a tuple with the AccountOperation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountOperation + +`func (o *ProvisioningCompletedAccountRequestsInner) SetAccountOperation(v string)` + +SetAccountOperation sets AccountOperation field to given value. + + +### GetProvisioningResult + +`func (o *ProvisioningCompletedAccountRequestsInner) GetProvisioningResult() map[string]interface{}` + +GetProvisioningResult returns the ProvisioningResult field if non-nil, zero value otherwise. + +### GetProvisioningResultOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetProvisioningResultOk() (*map[string]interface{}, bool)` + +GetProvisioningResultOk returns a tuple with the ProvisioningResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningResult + +`func (o *ProvisioningCompletedAccountRequestsInner) SetProvisioningResult(v map[string]interface{})` + +SetProvisioningResult sets ProvisioningResult field to given value. + + +### GetProvisioningTarget + +`func (o *ProvisioningCompletedAccountRequestsInner) GetProvisioningTarget() string` + +GetProvisioningTarget returns the ProvisioningTarget field if non-nil, zero value otherwise. + +### GetProvisioningTargetOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetProvisioningTargetOk() (*string, bool)` + +GetProvisioningTargetOk returns a tuple with the ProvisioningTarget field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningTarget + +`func (o *ProvisioningCompletedAccountRequestsInner) SetProvisioningTarget(v string)` + +SetProvisioningTarget sets ProvisioningTarget field to given value. + + +### GetTicketId + +`func (o *ProvisioningCompletedAccountRequestsInner) GetTicketId() string` + +GetTicketId returns the TicketId field if non-nil, zero value otherwise. + +### GetTicketIdOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetTicketIdOk() (*string, bool)` + +GetTicketIdOk returns a tuple with the TicketId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTicketId + +`func (o *ProvisioningCompletedAccountRequestsInner) SetTicketId(v string)` + +SetTicketId sets TicketId field to given value. + +### HasTicketId + +`func (o *ProvisioningCompletedAccountRequestsInner) HasTicketId() bool` + +HasTicketId returns a boolean if a field has been set. + +### SetTicketIdNil + +`func (o *ProvisioningCompletedAccountRequestsInner) SetTicketIdNil(b bool)` + + SetTicketIdNil sets the value for TicketId to be an explicit nil + +### UnsetTicketId +`func (o *ProvisioningCompletedAccountRequestsInner) UnsetTicketId()` + +UnsetTicketId ensures that no value is present for TicketId, not even an explicit nil +### GetAttributeRequests + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAttributeRequests() []ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner` + +GetAttributeRequests returns the AttributeRequests field if non-nil, zero value otherwise. + +### GetAttributeRequestsOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAttributeRequestsOk() (*[]ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner, bool)` + +GetAttributeRequestsOk returns a tuple with the AttributeRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeRequests + +`func (o *ProvisioningCompletedAccountRequestsInner) SetAttributeRequests(v []ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner)` + +SetAttributeRequests sets AttributeRequests field to given value. + +### HasAttributeRequests + +`func (o *ProvisioningCompletedAccountRequestsInner) HasAttributeRequests() bool` + +HasAttributeRequests returns a boolean if a field has been set. + +### SetAttributeRequestsNil + +`func (o *ProvisioningCompletedAccountRequestsInner) SetAttributeRequestsNil(b bool)` + + SetAttributeRequestsNil sets the value for AttributeRequests to be an explicit nil + +### UnsetAttributeRequests +`func (o *ProvisioningCompletedAccountRequestsInner) UnsetAttributeRequests()` + +UnsetAttributeRequests ensures that no value is present for AttributeRequests, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md new file mode 100644 index 000000000..6a056e035 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md @@ -0,0 +1,116 @@ +--- +id: beta-provisioning-completed-account-requests-inner-attribute-requests-inner +title: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +pagination_label: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +sidebar_label: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner', 'BetaProvisioningCompletedAccountRequestsInnerAttributeRequestsInner'] +slug: /tools/sdk/go/beta/models/provisioning-completed-account-requests-inner-attribute-requests-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner', 'BetaProvisioningCompletedAccountRequestsInnerAttributeRequestsInner'] +--- + +# ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeName** | **string** | Name of the attribute being provisioned. | +**AttributeValue** | Pointer to **NullableString** | Value of the attribute being provisioned. | [optional] +**Operation** | **string** | The operation to handle the attribute. | + +## Methods + +### NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInner + +`func NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInner(attributeName string, operation string, ) *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner` + +NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInner instantiates a new ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner 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 + +### NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerWithDefaults + +`func NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerWithDefaults() *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner` + +NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerWithDefaults instantiates a new ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner 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 + +### GetAttributeName + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + + +### GetAttributeValue + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetAttributeValue() string` + +GetAttributeValue returns the AttributeValue field if non-nil, zero value otherwise. + +### GetAttributeValueOk + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetAttributeValueOk() (*string, bool)` + +GetAttributeValueOk returns a tuple with the AttributeValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeValue + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) SetAttributeValue(v string)` + +SetAttributeValue sets AttributeValue field to given value. + +### HasAttributeValue + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) HasAttributeValue() bool` + +HasAttributeValue returns a boolean if a field has been set. + +### SetAttributeValueNil + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) SetAttributeValueNil(b bool)` + + SetAttributeValueNil sets the value for AttributeValue to be an explicit nil + +### UnsetAttributeValue +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) UnsetAttributeValue()` + +UnsetAttributeValue ensures that no value is present for AttributeValue, not even an explicit nil +### GetOperation + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) SetOperation(v string)` + +SetOperation sets Operation field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerSource.md b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerSource.md new file mode 100644 index 000000000..66783d7d2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerSource.md @@ -0,0 +1,101 @@ +--- +id: beta-provisioning-completed-account-requests-inner-source +title: ProvisioningCompletedAccountRequestsInnerSource +pagination_label: ProvisioningCompletedAccountRequestsInnerSource +sidebar_label: ProvisioningCompletedAccountRequestsInnerSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompletedAccountRequestsInnerSource', 'BetaProvisioningCompletedAccountRequestsInnerSource'] +slug: /tools/sdk/go/beta/models/provisioning-completed-account-requests-inner-source +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInnerSource', 'BetaProvisioningCompletedAccountRequestsInnerSource'] +--- + +# ProvisioningCompletedAccountRequestsInnerSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Source ID. | +**Type** | **string** | Source DTO type. | +**Name** | **string** | Source name. | + +## Methods + +### NewProvisioningCompletedAccountRequestsInnerSource + +`func NewProvisioningCompletedAccountRequestsInnerSource(id string, type_ string, name string, ) *ProvisioningCompletedAccountRequestsInnerSource` + +NewProvisioningCompletedAccountRequestsInnerSource instantiates a new ProvisioningCompletedAccountRequestsInnerSource 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 + +### NewProvisioningCompletedAccountRequestsInnerSourceWithDefaults + +`func NewProvisioningCompletedAccountRequestsInnerSourceWithDefaults() *ProvisioningCompletedAccountRequestsInnerSource` + +NewProvisioningCompletedAccountRequestsInnerSourceWithDefaults instantiates a new ProvisioningCompletedAccountRequestsInnerSource 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 + +### GetId + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetName + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompletedRecipient.md b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompletedRecipient.md new file mode 100644 index 000000000..28e791945 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompletedRecipient.md @@ -0,0 +1,101 @@ +--- +id: beta-provisioning-completed-recipient +title: ProvisioningCompletedRecipient +pagination_label: ProvisioningCompletedRecipient +sidebar_label: ProvisioningCompletedRecipient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompletedRecipient', 'BetaProvisioningCompletedRecipient'] +slug: /tools/sdk/go/beta/models/provisioning-completed-recipient +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedRecipient', 'BetaProvisioningCompletedRecipient'] +--- + +# ProvisioningCompletedRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Provisioning recipient DTO type. | +**Id** | **string** | Provisioning recipient's identity ID. | +**Name** | **string** | Provisioning recipient's name. | + +## Methods + +### NewProvisioningCompletedRecipient + +`func NewProvisioningCompletedRecipient(type_ string, id string, name string, ) *ProvisioningCompletedRecipient` + +NewProvisioningCompletedRecipient instantiates a new ProvisioningCompletedRecipient 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 + +### NewProvisioningCompletedRecipientWithDefaults + +`func NewProvisioningCompletedRecipientWithDefaults() *ProvisioningCompletedRecipient` + +NewProvisioningCompletedRecipientWithDefaults instantiates a new ProvisioningCompletedRecipient 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 + +### GetType + +`func (o *ProvisioningCompletedRecipient) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ProvisioningCompletedRecipient) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ProvisioningCompletedRecipient) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *ProvisioningCompletedRecipient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ProvisioningCompletedRecipient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ProvisioningCompletedRecipient) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *ProvisioningCompletedRecipient) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningCompletedRecipient) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningCompletedRecipient) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompletedRequester.md b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompletedRequester.md new file mode 100644 index 000000000..91b2416d3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCompletedRequester.md @@ -0,0 +1,101 @@ +--- +id: beta-provisioning-completed-requester +title: ProvisioningCompletedRequester +pagination_label: ProvisioningCompletedRequester +sidebar_label: ProvisioningCompletedRequester +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompletedRequester', 'BetaProvisioningCompletedRequester'] +slug: /tools/sdk/go/beta/models/provisioning-completed-requester +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedRequester', 'BetaProvisioningCompletedRequester'] +--- + +# ProvisioningCompletedRequester + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Provisioning requester's DTO type. | +**Id** | **string** | Provisioning requester's identity ID. | +**Name** | **string** | Provisioning requester's name. | + +## Methods + +### NewProvisioningCompletedRequester + +`func NewProvisioningCompletedRequester(type_ string, id string, name string, ) *ProvisioningCompletedRequester` + +NewProvisioningCompletedRequester instantiates a new ProvisioningCompletedRequester 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 + +### NewProvisioningCompletedRequesterWithDefaults + +`func NewProvisioningCompletedRequesterWithDefaults() *ProvisioningCompletedRequester` + +NewProvisioningCompletedRequesterWithDefaults instantiates a new ProvisioningCompletedRequester 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 + +### GetType + +`func (o *ProvisioningCompletedRequester) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ProvisioningCompletedRequester) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ProvisioningCompletedRequester) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *ProvisioningCompletedRequester) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ProvisioningCompletedRequester) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ProvisioningCompletedRequester) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *ProvisioningCompletedRequester) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningCompletedRequester) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningCompletedRequester) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningConfig.md new file mode 100644 index 000000000..4ffc980c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningConfig.md @@ -0,0 +1,168 @@ +--- +id: beta-provisioning-config +title: ProvisioningConfig +pagination_label: ProvisioningConfig +sidebar_label: ProvisioningConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningConfig', 'BetaProvisioningConfig'] +slug: /tools/sdk/go/beta/models/provisioning-config +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig', 'BetaProvisioningConfig'] +--- + +# ProvisioningConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UniversalManager** | Pointer to **bool** | Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. | [optional] [readonly] [default to false] +**ManagedResourceRefs** | Pointer to [**[]ProvisioningConfigManagedResourceRefsInner**](provisioning-config-managed-resource-refs-inner) | References to sources for the Service Desk integration template. May only be specified if universalManager is false. | [optional] +**PlanInitializerScript** | Pointer to [**ProvisioningConfigPlanInitializerScript**](provisioning-config-plan-initializer-script) | | [optional] +**NoProvisioningRequests** | Pointer to **bool** | Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. | [optional] [default to false] +**ProvisioningRequestExpiration** | Pointer to **int32** | When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. | [optional] + +## Methods + +### NewProvisioningConfig + +`func NewProvisioningConfig() *ProvisioningConfig` + +NewProvisioningConfig instantiates a new ProvisioningConfig 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 + +### NewProvisioningConfigWithDefaults + +`func NewProvisioningConfigWithDefaults() *ProvisioningConfig` + +NewProvisioningConfigWithDefaults instantiates a new ProvisioningConfig 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 + +### GetUniversalManager + +`func (o *ProvisioningConfig) GetUniversalManager() bool` + +GetUniversalManager returns the UniversalManager field if non-nil, zero value otherwise. + +### GetUniversalManagerOk + +`func (o *ProvisioningConfig) GetUniversalManagerOk() (*bool, bool)` + +GetUniversalManagerOk returns a tuple with the UniversalManager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUniversalManager + +`func (o *ProvisioningConfig) SetUniversalManager(v bool)` + +SetUniversalManager sets UniversalManager field to given value. + +### HasUniversalManager + +`func (o *ProvisioningConfig) HasUniversalManager() bool` + +HasUniversalManager returns a boolean if a field has been set. + +### GetManagedResourceRefs + +`func (o *ProvisioningConfig) GetManagedResourceRefs() []ProvisioningConfigManagedResourceRefsInner` + +GetManagedResourceRefs returns the ManagedResourceRefs field if non-nil, zero value otherwise. + +### GetManagedResourceRefsOk + +`func (o *ProvisioningConfig) GetManagedResourceRefsOk() (*[]ProvisioningConfigManagedResourceRefsInner, bool)` + +GetManagedResourceRefsOk returns a tuple with the ManagedResourceRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagedResourceRefs + +`func (o *ProvisioningConfig) SetManagedResourceRefs(v []ProvisioningConfigManagedResourceRefsInner)` + +SetManagedResourceRefs sets ManagedResourceRefs field to given value. + +### HasManagedResourceRefs + +`func (o *ProvisioningConfig) HasManagedResourceRefs() bool` + +HasManagedResourceRefs returns a boolean if a field has been set. + +### GetPlanInitializerScript + +`func (o *ProvisioningConfig) GetPlanInitializerScript() ProvisioningConfigPlanInitializerScript` + +GetPlanInitializerScript returns the PlanInitializerScript field if non-nil, zero value otherwise. + +### GetPlanInitializerScriptOk + +`func (o *ProvisioningConfig) GetPlanInitializerScriptOk() (*ProvisioningConfigPlanInitializerScript, bool)` + +GetPlanInitializerScriptOk returns a tuple with the PlanInitializerScript field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPlanInitializerScript + +`func (o *ProvisioningConfig) SetPlanInitializerScript(v ProvisioningConfigPlanInitializerScript)` + +SetPlanInitializerScript sets PlanInitializerScript field to given value. + +### HasPlanInitializerScript + +`func (o *ProvisioningConfig) HasPlanInitializerScript() bool` + +HasPlanInitializerScript returns a boolean if a field has been set. + +### GetNoProvisioningRequests + +`func (o *ProvisioningConfig) GetNoProvisioningRequests() bool` + +GetNoProvisioningRequests returns the NoProvisioningRequests field if non-nil, zero value otherwise. + +### GetNoProvisioningRequestsOk + +`func (o *ProvisioningConfig) GetNoProvisioningRequestsOk() (*bool, bool)` + +GetNoProvisioningRequestsOk returns a tuple with the NoProvisioningRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNoProvisioningRequests + +`func (o *ProvisioningConfig) SetNoProvisioningRequests(v bool)` + +SetNoProvisioningRequests sets NoProvisioningRequests field to given value. + +### HasNoProvisioningRequests + +`func (o *ProvisioningConfig) HasNoProvisioningRequests() bool` + +HasNoProvisioningRequests returns a boolean if a field has been set. + +### GetProvisioningRequestExpiration + +`func (o *ProvisioningConfig) GetProvisioningRequestExpiration() int32` + +GetProvisioningRequestExpiration returns the ProvisioningRequestExpiration field if non-nil, zero value otherwise. + +### GetProvisioningRequestExpirationOk + +`func (o *ProvisioningConfig) GetProvisioningRequestExpirationOk() (*int32, bool)` + +GetProvisioningRequestExpirationOk returns a tuple with the ProvisioningRequestExpiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningRequestExpiration + +`func (o *ProvisioningConfig) SetProvisioningRequestExpiration(v int32)` + +SetProvisioningRequestExpiration sets ProvisioningRequestExpiration field to given value. + +### HasProvisioningRequestExpiration + +`func (o *ProvisioningConfig) HasProvisioningRequestExpiration() bool` + +HasProvisioningRequestExpiration returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningConfigManagedResourceRefsInner.md b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningConfigManagedResourceRefsInner.md new file mode 100644 index 000000000..ad2c4d12e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningConfigManagedResourceRefsInner.md @@ -0,0 +1,116 @@ +--- +id: beta-provisioning-config-managed-resource-refs-inner +title: ProvisioningConfigManagedResourceRefsInner +pagination_label: ProvisioningConfigManagedResourceRefsInner +sidebar_label: ProvisioningConfigManagedResourceRefsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningConfigManagedResourceRefsInner', 'BetaProvisioningConfigManagedResourceRefsInner'] +slug: /tools/sdk/go/beta/models/provisioning-config-managed-resource-refs-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfigManagedResourceRefsInner', 'BetaProvisioningConfigManagedResourceRefsInner'] +--- + +# ProvisioningConfigManagedResourceRefsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **map[string]interface{}** | The type of object being referenced | [optional] +**Id** | Pointer to **map[string]interface{}** | ID of the source | [optional] +**Name** | Pointer to **map[string]interface{}** | Human-readable display name of the source | [optional] + +## Methods + +### NewProvisioningConfigManagedResourceRefsInner + +`func NewProvisioningConfigManagedResourceRefsInner() *ProvisioningConfigManagedResourceRefsInner` + +NewProvisioningConfigManagedResourceRefsInner instantiates a new ProvisioningConfigManagedResourceRefsInner 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 + +### NewProvisioningConfigManagedResourceRefsInnerWithDefaults + +`func NewProvisioningConfigManagedResourceRefsInnerWithDefaults() *ProvisioningConfigManagedResourceRefsInner` + +NewProvisioningConfigManagedResourceRefsInnerWithDefaults instantiates a new ProvisioningConfigManagedResourceRefsInner 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 + +### GetType + +`func (o *ProvisioningConfigManagedResourceRefsInner) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ProvisioningConfigManagedResourceRefsInner) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ProvisioningConfigManagedResourceRefsInner) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + +### HasType + +`func (o *ProvisioningConfigManagedResourceRefsInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ProvisioningConfigManagedResourceRefsInner) GetId() map[string]interface{}` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ProvisioningConfigManagedResourceRefsInner) GetIdOk() (*map[string]interface{}, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ProvisioningConfigManagedResourceRefsInner) SetId(v map[string]interface{})` + +SetId sets Id field to given value. + +### HasId + +`func (o *ProvisioningConfigManagedResourceRefsInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ProvisioningConfigManagedResourceRefsInner) GetName() map[string]interface{}` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningConfigManagedResourceRefsInner) GetNameOk() (*map[string]interface{}, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningConfigManagedResourceRefsInner) SetName(v map[string]interface{})` + +SetName sets Name field to given value. + +### HasName + +`func (o *ProvisioningConfigManagedResourceRefsInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningConfigPlanInitializerScript.md b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningConfigPlanInitializerScript.md new file mode 100644 index 000000000..057ff6a9f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningConfigPlanInitializerScript.md @@ -0,0 +1,64 @@ +--- +id: beta-provisioning-config-plan-initializer-script +title: ProvisioningConfigPlanInitializerScript +pagination_label: ProvisioningConfigPlanInitializerScript +sidebar_label: ProvisioningConfigPlanInitializerScript +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningConfigPlanInitializerScript', 'BetaProvisioningConfigPlanInitializerScript'] +slug: /tools/sdk/go/beta/models/provisioning-config-plan-initializer-script +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfigPlanInitializerScript', 'BetaProvisioningConfigPlanInitializerScript'] +--- + +# ProvisioningConfigPlanInitializerScript + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | Pointer to **string** | This is a Rule that allows provisioning instruction changes. | [optional] + +## Methods + +### NewProvisioningConfigPlanInitializerScript + +`func NewProvisioningConfigPlanInitializerScript() *ProvisioningConfigPlanInitializerScript` + +NewProvisioningConfigPlanInitializerScript instantiates a new ProvisioningConfigPlanInitializerScript 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 + +### NewProvisioningConfigPlanInitializerScriptWithDefaults + +`func NewProvisioningConfigPlanInitializerScriptWithDefaults() *ProvisioningConfigPlanInitializerScript` + +NewProvisioningConfigPlanInitializerScriptWithDefaults instantiates a new ProvisioningConfigPlanInitializerScript 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 + +### GetSource + +`func (o *ProvisioningConfigPlanInitializerScript) GetSource() string` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *ProvisioningConfigPlanInitializerScript) GetSourceOk() (*string, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *ProvisioningConfigPlanInitializerScript) SetSource(v string)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *ProvisioningConfigPlanInitializerScript) HasSource() bool` + +HasSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCriteriaLevel1.md new file mode 100644 index 000000000..90e6e20ed --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCriteriaLevel1.md @@ -0,0 +1,172 @@ +--- +id: beta-provisioning-criteria-level1 +title: ProvisioningCriteriaLevel1 +pagination_label: ProvisioningCriteriaLevel1 +sidebar_label: ProvisioningCriteriaLevel1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCriteriaLevel1', 'BetaProvisioningCriteriaLevel1'] +slug: /tools/sdk/go/beta/models/provisioning-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'BetaProvisioningCriteriaLevel1'] +--- + +# ProvisioningCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **NullableString** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | Pointer to **NullableString** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | Pointer to [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Methods + +### NewProvisioningCriteriaLevel1 + +`func NewProvisioningCriteriaLevel1() *ProvisioningCriteriaLevel1` + +NewProvisioningCriteriaLevel1 instantiates a new ProvisioningCriteriaLevel1 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 + +### NewProvisioningCriteriaLevel1WithDefaults + +`func NewProvisioningCriteriaLevel1WithDefaults() *ProvisioningCriteriaLevel1` + +NewProvisioningCriteriaLevel1WithDefaults instantiates a new ProvisioningCriteriaLevel1 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 + +### GetOperation + +`func (o *ProvisioningCriteriaLevel1) GetOperation() ProvisioningCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ProvisioningCriteriaLevel1) GetOperationOk() (*ProvisioningCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ProvisioningCriteriaLevel1) SetOperation(v ProvisioningCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ProvisioningCriteriaLevel1) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ProvisioningCriteriaLevel1) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ProvisioningCriteriaLevel1) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ProvisioningCriteriaLevel1) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ProvisioningCriteriaLevel1) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *ProvisioningCriteriaLevel1) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *ProvisioningCriteriaLevel1) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *ProvisioningCriteriaLevel1) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ProvisioningCriteriaLevel1) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ProvisioningCriteriaLevel1) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ProvisioningCriteriaLevel1) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ProvisioningCriteriaLevel1) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ProvisioningCriteriaLevel1) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *ProvisioningCriteriaLevel1) GetChildren() []ProvisioningCriteriaLevel2` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *ProvisioningCriteriaLevel1) GetChildrenOk() (*[]ProvisioningCriteriaLevel2, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *ProvisioningCriteriaLevel1) SetChildren(v []ProvisioningCriteriaLevel2)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *ProvisioningCriteriaLevel1) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *ProvisioningCriteriaLevel1) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *ProvisioningCriteriaLevel1) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCriteriaLevel2.md new file mode 100644 index 000000000..29bacfbc0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCriteriaLevel2.md @@ -0,0 +1,172 @@ +--- +id: beta-provisioning-criteria-level2 +title: ProvisioningCriteriaLevel2 +pagination_label: ProvisioningCriteriaLevel2 +sidebar_label: ProvisioningCriteriaLevel2 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCriteriaLevel2', 'BetaProvisioningCriteriaLevel2'] +slug: /tools/sdk/go/beta/models/provisioning-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'BetaProvisioningCriteriaLevel2'] +--- + +# ProvisioningCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **NullableString** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | Pointer to **NullableString** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | Pointer to [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Methods + +### NewProvisioningCriteriaLevel2 + +`func NewProvisioningCriteriaLevel2() *ProvisioningCriteriaLevel2` + +NewProvisioningCriteriaLevel2 instantiates a new ProvisioningCriteriaLevel2 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 + +### NewProvisioningCriteriaLevel2WithDefaults + +`func NewProvisioningCriteriaLevel2WithDefaults() *ProvisioningCriteriaLevel2` + +NewProvisioningCriteriaLevel2WithDefaults instantiates a new ProvisioningCriteriaLevel2 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 + +### GetOperation + +`func (o *ProvisioningCriteriaLevel2) GetOperation() ProvisioningCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ProvisioningCriteriaLevel2) GetOperationOk() (*ProvisioningCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ProvisioningCriteriaLevel2) SetOperation(v ProvisioningCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ProvisioningCriteriaLevel2) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ProvisioningCriteriaLevel2) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ProvisioningCriteriaLevel2) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ProvisioningCriteriaLevel2) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ProvisioningCriteriaLevel2) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *ProvisioningCriteriaLevel2) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *ProvisioningCriteriaLevel2) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *ProvisioningCriteriaLevel2) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ProvisioningCriteriaLevel2) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ProvisioningCriteriaLevel2) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ProvisioningCriteriaLevel2) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ProvisioningCriteriaLevel2) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ProvisioningCriteriaLevel2) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *ProvisioningCriteriaLevel2) GetChildren() []ProvisioningCriteriaLevel3` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *ProvisioningCriteriaLevel2) GetChildrenOk() (*[]ProvisioningCriteriaLevel3, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *ProvisioningCriteriaLevel2) SetChildren(v []ProvisioningCriteriaLevel3)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *ProvisioningCriteriaLevel2) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *ProvisioningCriteriaLevel2) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *ProvisioningCriteriaLevel2) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCriteriaLevel3.md new file mode 100644 index 000000000..3ba8536ac --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCriteriaLevel3.md @@ -0,0 +1,172 @@ +--- +id: beta-provisioning-criteria-level3 +title: ProvisioningCriteriaLevel3 +pagination_label: ProvisioningCriteriaLevel3 +sidebar_label: ProvisioningCriteriaLevel3 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCriteriaLevel3', 'BetaProvisioningCriteriaLevel3'] +slug: /tools/sdk/go/beta/models/provisioning-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'BetaProvisioningCriteriaLevel3'] +--- + +# ProvisioningCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **NullableString** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | Pointer to **NullableString** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | Pointer to **NullableString** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Methods + +### NewProvisioningCriteriaLevel3 + +`func NewProvisioningCriteriaLevel3() *ProvisioningCriteriaLevel3` + +NewProvisioningCriteriaLevel3 instantiates a new ProvisioningCriteriaLevel3 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 + +### NewProvisioningCriteriaLevel3WithDefaults + +`func NewProvisioningCriteriaLevel3WithDefaults() *ProvisioningCriteriaLevel3` + +NewProvisioningCriteriaLevel3WithDefaults instantiates a new ProvisioningCriteriaLevel3 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 + +### GetOperation + +`func (o *ProvisioningCriteriaLevel3) GetOperation() ProvisioningCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ProvisioningCriteriaLevel3) GetOperationOk() (*ProvisioningCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ProvisioningCriteriaLevel3) SetOperation(v ProvisioningCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ProvisioningCriteriaLevel3) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ProvisioningCriteriaLevel3) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ProvisioningCriteriaLevel3) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ProvisioningCriteriaLevel3) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ProvisioningCriteriaLevel3) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *ProvisioningCriteriaLevel3) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *ProvisioningCriteriaLevel3) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *ProvisioningCriteriaLevel3) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ProvisioningCriteriaLevel3) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ProvisioningCriteriaLevel3) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ProvisioningCriteriaLevel3) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ProvisioningCriteriaLevel3) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ProvisioningCriteriaLevel3) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *ProvisioningCriteriaLevel3) GetChildren() string` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *ProvisioningCriteriaLevel3) GetChildrenOk() (*string, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *ProvisioningCriteriaLevel3) SetChildren(v string)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *ProvisioningCriteriaLevel3) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *ProvisioningCriteriaLevel3) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *ProvisioningCriteriaLevel3) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCriteriaOperation.md new file mode 100644 index 000000000..123d0d678 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningCriteriaOperation.md @@ -0,0 +1,29 @@ +--- +id: beta-provisioning-criteria-operation +title: ProvisioningCriteriaOperation +pagination_label: ProvisioningCriteriaOperation +sidebar_label: ProvisioningCriteriaOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCriteriaOperation', 'BetaProvisioningCriteriaOperation'] +slug: /tools/sdk/go/beta/models/provisioning-criteria-operation +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'BetaProvisioningCriteriaOperation'] +--- + +# ProvisioningCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `HAS` (value: `"HAS"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningDetails.md new file mode 100644 index 000000000..2ca160ad0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningDetails.md @@ -0,0 +1,64 @@ +--- +id: beta-provisioning-details +title: ProvisioningDetails +pagination_label: ProvisioningDetails +sidebar_label: ProvisioningDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningDetails', 'BetaProvisioningDetails'] +slug: /tools/sdk/go/beta/models/provisioning-details +tags: ['SDK', 'Software Development Kit', 'ProvisioningDetails', 'BetaProvisioningDetails'] +--- + +# ProvisioningDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrderedSubPhaseReferences** | Pointer to **string** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. | [optional] + +## Methods + +### NewProvisioningDetails + +`func NewProvisioningDetails() *ProvisioningDetails` + +NewProvisioningDetails instantiates a new ProvisioningDetails 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 + +### NewProvisioningDetailsWithDefaults + +`func NewProvisioningDetailsWithDefaults() *ProvisioningDetails` + +NewProvisioningDetailsWithDefaults instantiates a new ProvisioningDetails 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 + +### GetOrderedSubPhaseReferences + +`func (o *ProvisioningDetails) GetOrderedSubPhaseReferences() string` + +GetOrderedSubPhaseReferences returns the OrderedSubPhaseReferences field if non-nil, zero value otherwise. + +### GetOrderedSubPhaseReferencesOk + +`func (o *ProvisioningDetails) GetOrderedSubPhaseReferencesOk() (*string, bool)` + +GetOrderedSubPhaseReferencesOk returns a tuple with the OrderedSubPhaseReferences field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderedSubPhaseReferences + +`func (o *ProvisioningDetails) SetOrderedSubPhaseReferences(v string)` + +SetOrderedSubPhaseReferences sets OrderedSubPhaseReferences field to given value. + +### HasOrderedSubPhaseReferences + +`func (o *ProvisioningDetails) HasOrderedSubPhaseReferences() bool` + +HasOrderedSubPhaseReferences returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningPolicyDto.md b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningPolicyDto.md new file mode 100644 index 000000000..ed0bf5fba --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningPolicyDto.md @@ -0,0 +1,147 @@ +--- +id: beta-provisioning-policy-dto +title: ProvisioningPolicyDto +pagination_label: ProvisioningPolicyDto +sidebar_label: ProvisioningPolicyDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningPolicyDto', 'BetaProvisioningPolicyDto'] +slug: /tools/sdk/go/beta/models/provisioning-policy-dto +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicyDto', 'BetaProvisioningPolicyDto'] +--- + +# ProvisioningPolicyDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **NullableString** | the provisioning policy name | +**Description** | Pointer to **string** | the description of the provisioning policy | [optional] +**UsageType** | Pointer to [**UsageType**](usage-type) | | [optional] +**Fields** | Pointer to [**[]FieldDetailsDto**](field-details-dto) | | [optional] + +## Methods + +### NewProvisioningPolicyDto + +`func NewProvisioningPolicyDto(name NullableString, ) *ProvisioningPolicyDto` + +NewProvisioningPolicyDto instantiates a new ProvisioningPolicyDto 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 + +### NewProvisioningPolicyDtoWithDefaults + +`func NewProvisioningPolicyDtoWithDefaults() *ProvisioningPolicyDto` + +NewProvisioningPolicyDtoWithDefaults instantiates a new ProvisioningPolicyDto 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 + +### GetName + +`func (o *ProvisioningPolicyDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningPolicyDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningPolicyDto) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *ProvisioningPolicyDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ProvisioningPolicyDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *ProvisioningPolicyDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ProvisioningPolicyDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ProvisioningPolicyDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ProvisioningPolicyDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetUsageType + +`func (o *ProvisioningPolicyDto) GetUsageType() UsageType` + +GetUsageType returns the UsageType field if non-nil, zero value otherwise. + +### GetUsageTypeOk + +`func (o *ProvisioningPolicyDto) GetUsageTypeOk() (*UsageType, bool)` + +GetUsageTypeOk returns a tuple with the UsageType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsageType + +`func (o *ProvisioningPolicyDto) SetUsageType(v UsageType)` + +SetUsageType sets UsageType field to given value. + +### HasUsageType + +`func (o *ProvisioningPolicyDto) HasUsageType() bool` + +HasUsageType returns a boolean if a field has been set. + +### GetFields + +`func (o *ProvisioningPolicyDto) GetFields() []FieldDetailsDto` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *ProvisioningPolicyDto) GetFieldsOk() (*[]FieldDetailsDto, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *ProvisioningPolicyDto) SetFields(v []FieldDetailsDto)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *ProvisioningPolicyDto) HasFields() bool` + +HasFields returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningState.md b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningState.md new file mode 100644 index 000000000..0aa3218e5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ProvisioningState.md @@ -0,0 +1,29 @@ +--- +id: beta-provisioning-state +title: ProvisioningState +pagination_label: ProvisioningState +sidebar_label: ProvisioningState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningState', 'BetaProvisioningState'] +slug: /tools/sdk/go/beta/models/provisioning-state +tags: ['SDK', 'Software Development Kit', 'ProvisioningState', 'BetaProvisioningState'] +--- + +# ProvisioningState + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `FINISHED` (value: `"FINISHED"`) + +* `UNVERIFIABLE` (value: `"UNVERIFIABLE"`) + +* `COMMITED` (value: `"COMMITED"`) + +* `FAILED` (value: `"FAILED"`) + +* `RETRY` (value: `"RETRY"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PublicIdentityAttributeConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/PublicIdentityAttributeConfig.md new file mode 100644 index 000000000..7412e0885 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PublicIdentityAttributeConfig.md @@ -0,0 +1,90 @@ +--- +id: beta-public-identity-attribute-config +title: PublicIdentityAttributeConfig +pagination_label: PublicIdentityAttributeConfig +sidebar_label: PublicIdentityAttributeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentityAttributeConfig', 'BetaPublicIdentityAttributeConfig'] +slug: /tools/sdk/go/beta/models/public-identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributeConfig', 'BetaPublicIdentityAttributeConfig'] +--- + +# PublicIdentityAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | the key of the attribute | [optional] +**Name** | Pointer to **string** | the display name of the attribute | [optional] + +## Methods + +### NewPublicIdentityAttributeConfig + +`func NewPublicIdentityAttributeConfig() *PublicIdentityAttributeConfig` + +NewPublicIdentityAttributeConfig instantiates a new PublicIdentityAttributeConfig 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 + +### NewPublicIdentityAttributeConfigWithDefaults + +`func NewPublicIdentityAttributeConfigWithDefaults() *PublicIdentityAttributeConfig` + +NewPublicIdentityAttributeConfigWithDefaults instantiates a new PublicIdentityAttributeConfig 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 + +### GetKey + +`func (o *PublicIdentityAttributeConfig) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *PublicIdentityAttributeConfig) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *PublicIdentityAttributeConfig) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *PublicIdentityAttributeConfig) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *PublicIdentityAttributeConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PublicIdentityAttributeConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PublicIdentityAttributeConfig) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PublicIdentityAttributeConfig) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PublicIdentityConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/PublicIdentityConfig.md new file mode 100644 index 000000000..fc814d056 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PublicIdentityConfig.md @@ -0,0 +1,136 @@ +--- +id: beta-public-identity-config +title: PublicIdentityConfig +pagination_label: PublicIdentityConfig +sidebar_label: PublicIdentityConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentityConfig', 'BetaPublicIdentityConfig'] +slug: /tools/sdk/go/beta/models/public-identity-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityConfig', 'BetaPublicIdentityConfig'] +--- + +# PublicIdentityConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]PublicIdentityAttributeConfig**](public-identity-attribute-config) | | [optional] +**ModifiedBy** | Pointer to [**NullableIdentityReference**](identity-reference) | | [optional] +**Modified** | Pointer to **NullableTime** | the date/time of the modification | [optional] + +## Methods + +### NewPublicIdentityConfig + +`func NewPublicIdentityConfig() *PublicIdentityConfig` + +NewPublicIdentityConfig instantiates a new PublicIdentityConfig 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 + +### NewPublicIdentityConfigWithDefaults + +`func NewPublicIdentityConfigWithDefaults() *PublicIdentityConfig` + +NewPublicIdentityConfigWithDefaults instantiates a new PublicIdentityConfig 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 + +### GetAttributes + +`func (o *PublicIdentityConfig) GetAttributes() []PublicIdentityAttributeConfig` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *PublicIdentityConfig) GetAttributesOk() (*[]PublicIdentityAttributeConfig, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *PublicIdentityConfig) SetAttributes(v []PublicIdentityAttributeConfig)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *PublicIdentityConfig) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetModifiedBy + +`func (o *PublicIdentityConfig) GetModifiedBy() IdentityReference` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *PublicIdentityConfig) GetModifiedByOk() (*IdentityReference, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedBy + +`func (o *PublicIdentityConfig) SetModifiedBy(v IdentityReference)` + +SetModifiedBy sets ModifiedBy field to given value. + +### HasModifiedBy + +`func (o *PublicIdentityConfig) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### SetModifiedByNil + +`func (o *PublicIdentityConfig) SetModifiedByNil(b bool)` + + SetModifiedByNil sets the value for ModifiedBy to be an explicit nil + +### UnsetModifiedBy +`func (o *PublicIdentityConfig) UnsetModifiedBy()` + +UnsetModifiedBy ensures that no value is present for ModifiedBy, not even an explicit nil +### GetModified + +`func (o *PublicIdentityConfig) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PublicIdentityConfig) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PublicIdentityConfig) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PublicIdentityConfig) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *PublicIdentityConfig) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *PublicIdentityConfig) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/PutPasswordDictionaryRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/PutPasswordDictionaryRequest.md new file mode 100644 index 000000000..a834f6c67 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/PutPasswordDictionaryRequest.md @@ -0,0 +1,64 @@ +--- +id: beta-put-password-dictionary-request +title: PutPasswordDictionaryRequest +pagination_label: PutPasswordDictionaryRequest +sidebar_label: PutPasswordDictionaryRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PutPasswordDictionaryRequest', 'BetaPutPasswordDictionaryRequest'] +slug: /tools/sdk/go/beta/models/put-password-dictionary-request +tags: ['SDK', 'Software Development Kit', 'PutPasswordDictionaryRequest', 'BetaPutPasswordDictionaryRequest'] +--- + +# PutPasswordDictionaryRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | Pointer to ***os.File** | | [optional] + +## Methods + +### NewPutPasswordDictionaryRequest + +`func NewPutPasswordDictionaryRequest() *PutPasswordDictionaryRequest` + +NewPutPasswordDictionaryRequest instantiates a new PutPasswordDictionaryRequest 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 + +### NewPutPasswordDictionaryRequestWithDefaults + +`func NewPutPasswordDictionaryRequestWithDefaults() *PutPasswordDictionaryRequest` + +NewPutPasswordDictionaryRequestWithDefaults instantiates a new PutPasswordDictionaryRequest 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 + +### GetFile + +`func (o *PutPasswordDictionaryRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *PutPasswordDictionaryRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *PutPasswordDictionaryRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + +### HasFile + +`func (o *PutPasswordDictionaryRequest) HasFile() bool` + +HasFile returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/QueuedCheckConfigDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/QueuedCheckConfigDetails.md new file mode 100644 index 000000000..606700277 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/QueuedCheckConfigDetails.md @@ -0,0 +1,80 @@ +--- +id: beta-queued-check-config-details +title: QueuedCheckConfigDetails +pagination_label: QueuedCheckConfigDetails +sidebar_label: QueuedCheckConfigDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'QueuedCheckConfigDetails', 'BetaQueuedCheckConfigDetails'] +slug: /tools/sdk/go/beta/models/queued-check-config-details +tags: ['SDK', 'Software Development Kit', 'QueuedCheckConfigDetails', 'BetaQueuedCheckConfigDetails'] +--- + +# QueuedCheckConfigDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProvisioningStatusCheckIntervalMinutes** | **string** | Interval in minutes between status checks | +**ProvisioningMaxStatusCheckDays** | **string** | Maximum number of days to check | + +## Methods + +### NewQueuedCheckConfigDetails + +`func NewQueuedCheckConfigDetails(provisioningStatusCheckIntervalMinutes string, provisioningMaxStatusCheckDays string, ) *QueuedCheckConfigDetails` + +NewQueuedCheckConfigDetails instantiates a new QueuedCheckConfigDetails 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 + +### NewQueuedCheckConfigDetailsWithDefaults + +`func NewQueuedCheckConfigDetailsWithDefaults() *QueuedCheckConfigDetails` + +NewQueuedCheckConfigDetailsWithDefaults instantiates a new QueuedCheckConfigDetails 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 + +### GetProvisioningStatusCheckIntervalMinutes + +`func (o *QueuedCheckConfigDetails) GetProvisioningStatusCheckIntervalMinutes() string` + +GetProvisioningStatusCheckIntervalMinutes returns the ProvisioningStatusCheckIntervalMinutes field if non-nil, zero value otherwise. + +### GetProvisioningStatusCheckIntervalMinutesOk + +`func (o *QueuedCheckConfigDetails) GetProvisioningStatusCheckIntervalMinutesOk() (*string, bool)` + +GetProvisioningStatusCheckIntervalMinutesOk returns a tuple with the ProvisioningStatusCheckIntervalMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningStatusCheckIntervalMinutes + +`func (o *QueuedCheckConfigDetails) SetProvisioningStatusCheckIntervalMinutes(v string)` + +SetProvisioningStatusCheckIntervalMinutes sets ProvisioningStatusCheckIntervalMinutes field to given value. + + +### GetProvisioningMaxStatusCheckDays + +`func (o *QueuedCheckConfigDetails) GetProvisioningMaxStatusCheckDays() string` + +GetProvisioningMaxStatusCheckDays returns the ProvisioningMaxStatusCheckDays field if non-nil, zero value otherwise. + +### GetProvisioningMaxStatusCheckDaysOk + +`func (o *QueuedCheckConfigDetails) GetProvisioningMaxStatusCheckDaysOk() (*string, bool)` + +GetProvisioningMaxStatusCheckDaysOk returns a tuple with the ProvisioningMaxStatusCheckDays field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningMaxStatusCheckDays + +`func (o *QueuedCheckConfigDetails) SetProvisioningMaxStatusCheckDays(v string)` + +SetProvisioningMaxStatusCheckDays sets ProvisioningMaxStatusCheckDays field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ReassignReference.md b/docs/tools/sdk/go/Reference/Beta/Models/ReassignReference.md new file mode 100644 index 000000000..501be6308 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ReassignReference.md @@ -0,0 +1,80 @@ +--- +id: beta-reassign-reference +title: ReassignReference +pagination_label: ReassignReference +sidebar_label: ReassignReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignReference', 'BetaReassignReference'] +slug: /tools/sdk/go/beta/models/reassign-reference +tags: ['SDK', 'Software Development Kit', 'ReassignReference', 'BetaReassignReference'] +--- + +# ReassignReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The ID of item or identity being reassigned. | +**Type** | **string** | The type of item or identity being reassigned. | + +## Methods + +### NewReassignReference + +`func NewReassignReference(id string, type_ string, ) *ReassignReference` + +NewReassignReference instantiates a new ReassignReference 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 + +### NewReassignReferenceWithDefaults + +`func NewReassignReferenceWithDefaults() *ReassignReference` + +NewReassignReferenceWithDefaults instantiates a new ReassignReference 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 + +### GetId + +`func (o *ReassignReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReassignReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReassignReference) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *ReassignReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReassignReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReassignReference) SetType(v string)` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Reassignment.md b/docs/tools/sdk/go/Reference/Beta/Models/Reassignment.md new file mode 100644 index 000000000..684003628 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Reassignment.md @@ -0,0 +1,90 @@ +--- +id: beta-reassignment +title: Reassignment +pagination_label: Reassignment +sidebar_label: Reassignment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Reassignment', 'BetaReassignment'] +slug: /tools/sdk/go/beta/models/reassignment +tags: ['SDK', 'Software Development Kit', 'Reassignment', 'BetaReassignment'] +--- + +# Reassignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**From** | Pointer to [**CertificationReference**](certification-reference) | | [optional] +**Comment** | Pointer to **string** | Comments from the previous reviewer. | [optional] + +## Methods + +### NewReassignment + +`func NewReassignment() *Reassignment` + +NewReassignment instantiates a new Reassignment 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 + +### NewReassignmentWithDefaults + +`func NewReassignmentWithDefaults() *Reassignment` + +NewReassignmentWithDefaults instantiates a new Reassignment 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 + +### GetFrom + +`func (o *Reassignment) GetFrom() CertificationReference` + +GetFrom returns the From field if non-nil, zero value otherwise. + +### GetFromOk + +`func (o *Reassignment) GetFromOk() (*CertificationReference, bool)` + +GetFromOk returns a tuple with the From field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrom + +`func (o *Reassignment) SetFrom(v CertificationReference)` + +SetFrom sets From field to given value. + +### HasFrom + +`func (o *Reassignment) HasFrom() bool` + +HasFrom returns a boolean if a field has been set. + +### GetComment + +`func (o *Reassignment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *Reassignment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *Reassignment) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *Reassignment) HasComment() bool` + +HasComment returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ReassignmentType.md b/docs/tools/sdk/go/Reference/Beta/Models/ReassignmentType.md new file mode 100644 index 000000000..d108de6ca --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ReassignmentType.md @@ -0,0 +1,25 @@ +--- +id: beta-reassignment-type +title: ReassignmentType +pagination_label: ReassignmentType +sidebar_label: ReassignmentType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignmentType', 'BetaReassignmentType'] +slug: /tools/sdk/go/beta/models/reassignment-type +tags: ['SDK', 'Software Development Kit', 'ReassignmentType', 'BetaReassignmentType'] +--- + +# ReassignmentType + +## Enum + + +* `MANUAL_REASSIGNMENT` (value: `"MANUAL_REASSIGNMENT"`) + +* `AUTOMATIC_REASSIGNMENT` (value: `"AUTOMATIC_REASSIGNMENT"`) + +* `AUTO_ESCALATION` (value: `"AUTO_ESCALATION"`) + +* `SELF_REVIEW_DELEGATION` (value: `"SELF_REVIEW_DELEGATION"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ReassignmentTypeEnum.md b/docs/tools/sdk/go/Reference/Beta/Models/ReassignmentTypeEnum.md new file mode 100644 index 000000000..f52df6ade --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ReassignmentTypeEnum.md @@ -0,0 +1,25 @@ +--- +id: beta-reassignment-type-enum +title: ReassignmentTypeEnum +pagination_label: ReassignmentTypeEnum +sidebar_label: ReassignmentTypeEnum +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignmentTypeEnum', 'BetaReassignmentTypeEnum'] +slug: /tools/sdk/go/beta/models/reassignment-type-enum +tags: ['SDK', 'Software Development Kit', 'ReassignmentTypeEnum', 'BetaReassignmentTypeEnum'] +--- + +# ReassignmentTypeEnum + +## Enum + + +* `MANUAL_REASSIGNMENT` (value: `"MANUAL_REASSIGNMENT,"`) + +* `AUTOMATIC_REASSIGNMENT` (value: `"AUTOMATIC_REASSIGNMENT,"`) + +* `AUTO_ESCALATION` (value: `"AUTO_ESCALATION,"`) + +* `SELF_REVIEW_DELEGATION` (value: `"SELF_REVIEW_DELEGATION"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Recommendation.md b/docs/tools/sdk/go/Reference/Beta/Models/Recommendation.md new file mode 100644 index 000000000..3e2cc5a9f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Recommendation.md @@ -0,0 +1,80 @@ +--- +id: beta-recommendation +title: Recommendation +pagination_label: Recommendation +sidebar_label: Recommendation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Recommendation', 'BetaRecommendation'] +slug: /tools/sdk/go/beta/models/recommendation +tags: ['SDK', 'Software Development Kit', 'Recommendation', 'BetaRecommendation'] +--- + +# Recommendation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Recommended type of account. | +**Method** | **string** | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | + +## Methods + +### NewRecommendation + +`func NewRecommendation(type_ string, method string, ) *Recommendation` + +NewRecommendation instantiates a new Recommendation 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 + +### NewRecommendationWithDefaults + +`func NewRecommendationWithDefaults() *Recommendation` + +NewRecommendationWithDefaults instantiates a new Recommendation 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 + +### GetType + +`func (o *Recommendation) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Recommendation) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Recommendation) SetType(v string)` + +SetType sets Type field to given value. + + +### GetMethod + +`func (o *Recommendation) GetMethod() string` + +GetMethod returns the Method field if non-nil, zero value otherwise. + +### GetMethodOk + +`func (o *Recommendation) GetMethodOk() (*string, bool)` + +GetMethodOk returns a tuple with the Method field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMethod + +`func (o *Recommendation) SetMethod(v string)` + +SetMethod sets Method field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RecommendationConfigDto.md b/docs/tools/sdk/go/Reference/Beta/Models/RecommendationConfigDto.md new file mode 100644 index 000000000..e5d2a7860 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RecommendationConfigDto.md @@ -0,0 +1,142 @@ +--- +id: beta-recommendation-config-dto +title: RecommendationConfigDto +pagination_label: RecommendationConfigDto +sidebar_label: RecommendationConfigDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommendationConfigDto', 'BetaRecommendationConfigDto'] +slug: /tools/sdk/go/beta/models/recommendation-config-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationConfigDto', 'BetaRecommendationConfigDto'] +--- + +# RecommendationConfigDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RecommenderFeatures** | Pointer to **[]string** | List of identity attributes to use for calculating certification recommendations | [optional] +**PeerGroupPercentageThreshold** | Pointer to **float32** | The percent value that the recommendation calculation must surpass to produce a YES recommendation | [optional] +**RunAutoSelectOnce** | Pointer to **bool** | If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run | [optional] [default to false] +**OnlyTuneThreshold** | Pointer to **bool** | If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run | [optional] [default to false] + +## Methods + +### NewRecommendationConfigDto + +`func NewRecommendationConfigDto() *RecommendationConfigDto` + +NewRecommendationConfigDto instantiates a new RecommendationConfigDto 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 + +### NewRecommendationConfigDtoWithDefaults + +`func NewRecommendationConfigDtoWithDefaults() *RecommendationConfigDto` + +NewRecommendationConfigDtoWithDefaults instantiates a new RecommendationConfigDto 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 + +### GetRecommenderFeatures + +`func (o *RecommendationConfigDto) GetRecommenderFeatures() []string` + +GetRecommenderFeatures returns the RecommenderFeatures field if non-nil, zero value otherwise. + +### GetRecommenderFeaturesOk + +`func (o *RecommendationConfigDto) GetRecommenderFeaturesOk() (*[]string, bool)` + +GetRecommenderFeaturesOk returns a tuple with the RecommenderFeatures field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommenderFeatures + +`func (o *RecommendationConfigDto) SetRecommenderFeatures(v []string)` + +SetRecommenderFeatures sets RecommenderFeatures field to given value. + +### HasRecommenderFeatures + +`func (o *RecommendationConfigDto) HasRecommenderFeatures() bool` + +HasRecommenderFeatures returns a boolean if a field has been set. + +### GetPeerGroupPercentageThreshold + +`func (o *RecommendationConfigDto) GetPeerGroupPercentageThreshold() float32` + +GetPeerGroupPercentageThreshold returns the PeerGroupPercentageThreshold field if non-nil, zero value otherwise. + +### GetPeerGroupPercentageThresholdOk + +`func (o *RecommendationConfigDto) GetPeerGroupPercentageThresholdOk() (*float32, bool)` + +GetPeerGroupPercentageThresholdOk returns a tuple with the PeerGroupPercentageThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPeerGroupPercentageThreshold + +`func (o *RecommendationConfigDto) SetPeerGroupPercentageThreshold(v float32)` + +SetPeerGroupPercentageThreshold sets PeerGroupPercentageThreshold field to given value. + +### HasPeerGroupPercentageThreshold + +`func (o *RecommendationConfigDto) HasPeerGroupPercentageThreshold() bool` + +HasPeerGroupPercentageThreshold returns a boolean if a field has been set. + +### GetRunAutoSelectOnce + +`func (o *RecommendationConfigDto) GetRunAutoSelectOnce() bool` + +GetRunAutoSelectOnce returns the RunAutoSelectOnce field if non-nil, zero value otherwise. + +### GetRunAutoSelectOnceOk + +`func (o *RecommendationConfigDto) GetRunAutoSelectOnceOk() (*bool, bool)` + +GetRunAutoSelectOnceOk returns a tuple with the RunAutoSelectOnce field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRunAutoSelectOnce + +`func (o *RecommendationConfigDto) SetRunAutoSelectOnce(v bool)` + +SetRunAutoSelectOnce sets RunAutoSelectOnce field to given value. + +### HasRunAutoSelectOnce + +`func (o *RecommendationConfigDto) HasRunAutoSelectOnce() bool` + +HasRunAutoSelectOnce returns a boolean if a field has been set. + +### GetOnlyTuneThreshold + +`func (o *RecommendationConfigDto) GetOnlyTuneThreshold() bool` + +GetOnlyTuneThreshold returns the OnlyTuneThreshold field if non-nil, zero value otherwise. + +### GetOnlyTuneThresholdOk + +`func (o *RecommendationConfigDto) GetOnlyTuneThresholdOk() (*bool, bool)` + +GetOnlyTuneThresholdOk returns a tuple with the OnlyTuneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOnlyTuneThreshold + +`func (o *RecommendationConfigDto) SetOnlyTuneThreshold(v bool)` + +SetOnlyTuneThreshold sets OnlyTuneThreshold field to given value. + +### HasOnlyTuneThreshold + +`func (o *RecommendationConfigDto) HasOnlyTuneThreshold() bool` + +HasOnlyTuneThreshold returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RecommendationRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/RecommendationRequest.md new file mode 100644 index 000000000..7d53f5dcd --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RecommendationRequest.md @@ -0,0 +1,90 @@ +--- +id: beta-recommendation-request +title: RecommendationRequest +pagination_label: RecommendationRequest +sidebar_label: RecommendationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommendationRequest', 'BetaRecommendationRequest'] +slug: /tools/sdk/go/beta/models/recommendation-request +tags: ['SDK', 'Software Development Kit', 'RecommendationRequest', 'BetaRecommendationRequest'] +--- + +# RecommendationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | The identity ID | [optional] +**Item** | Pointer to [**AccessItemRef**](access-item-ref) | | [optional] + +## Methods + +### NewRecommendationRequest + +`func NewRecommendationRequest() *RecommendationRequest` + +NewRecommendationRequest instantiates a new RecommendationRequest 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 + +### NewRecommendationRequestWithDefaults + +`func NewRecommendationRequestWithDefaults() *RecommendationRequest` + +NewRecommendationRequestWithDefaults instantiates a new RecommendationRequest 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 + +### GetIdentityId + +`func (o *RecommendationRequest) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *RecommendationRequest) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *RecommendationRequest) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *RecommendationRequest) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetItem + +`func (o *RecommendationRequest) GetItem() AccessItemRef` + +GetItem returns the Item field if non-nil, zero value otherwise. + +### GetItemOk + +`func (o *RecommendationRequest) GetItemOk() (*AccessItemRef, bool)` + +GetItemOk returns a tuple with the Item field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItem + +`func (o *RecommendationRequest) SetItem(v AccessItemRef)` + +SetItem sets Item field to given value. + +### HasItem + +`func (o *RecommendationRequest) HasItem() bool` + +HasItem returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RecommendationRequestDto.md b/docs/tools/sdk/go/Reference/Beta/Models/RecommendationRequestDto.md new file mode 100644 index 000000000..fa6d5ae9a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RecommendationRequestDto.md @@ -0,0 +1,168 @@ +--- +id: beta-recommendation-request-dto +title: RecommendationRequestDto +pagination_label: RecommendationRequestDto +sidebar_label: RecommendationRequestDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommendationRequestDto', 'BetaRecommendationRequestDto'] +slug: /tools/sdk/go/beta/models/recommendation-request-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationRequestDto', 'BetaRecommendationRequestDto'] +--- + +# RecommendationRequestDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Requests** | Pointer to [**[]RecommendationRequest**](recommendation-request) | | [optional] +**ExcludeInterpretations** | Pointer to **bool** | Exclude interpretations in the response if \"true\". Return interpretations in the response if this attribute is not specified. | [optional] [default to false] +**IncludeTranslationMessages** | Pointer to **bool** | When set to true, the calling system uses the translated messages for the specified language | [optional] [default to false] +**IncludeDebugInformation** | Pointer to **bool** | Returns the recommender calculations if set to true | [optional] [default to false] +**PrescribeMode** | Pointer to **bool** | When set to true, uses prescribedRulesRecommenderConfig to get identity attributes and peer group threshold instead of standard config. | [optional] [default to false] + +## Methods + +### NewRecommendationRequestDto + +`func NewRecommendationRequestDto() *RecommendationRequestDto` + +NewRecommendationRequestDto instantiates a new RecommendationRequestDto 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 + +### NewRecommendationRequestDtoWithDefaults + +`func NewRecommendationRequestDtoWithDefaults() *RecommendationRequestDto` + +NewRecommendationRequestDtoWithDefaults instantiates a new RecommendationRequestDto 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 + +### GetRequests + +`func (o *RecommendationRequestDto) GetRequests() []RecommendationRequest` + +GetRequests returns the Requests field if non-nil, zero value otherwise. + +### GetRequestsOk + +`func (o *RecommendationRequestDto) GetRequestsOk() (*[]RecommendationRequest, bool)` + +GetRequestsOk returns a tuple with the Requests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequests + +`func (o *RecommendationRequestDto) SetRequests(v []RecommendationRequest)` + +SetRequests sets Requests field to given value. + +### HasRequests + +`func (o *RecommendationRequestDto) HasRequests() bool` + +HasRequests returns a boolean if a field has been set. + +### GetExcludeInterpretations + +`func (o *RecommendationRequestDto) GetExcludeInterpretations() bool` + +GetExcludeInterpretations returns the ExcludeInterpretations field if non-nil, zero value otherwise. + +### GetExcludeInterpretationsOk + +`func (o *RecommendationRequestDto) GetExcludeInterpretationsOk() (*bool, bool)` + +GetExcludeInterpretationsOk returns a tuple with the ExcludeInterpretations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeInterpretations + +`func (o *RecommendationRequestDto) SetExcludeInterpretations(v bool)` + +SetExcludeInterpretations sets ExcludeInterpretations field to given value. + +### HasExcludeInterpretations + +`func (o *RecommendationRequestDto) HasExcludeInterpretations() bool` + +HasExcludeInterpretations returns a boolean if a field has been set. + +### GetIncludeTranslationMessages + +`func (o *RecommendationRequestDto) GetIncludeTranslationMessages() bool` + +GetIncludeTranslationMessages returns the IncludeTranslationMessages field if non-nil, zero value otherwise. + +### GetIncludeTranslationMessagesOk + +`func (o *RecommendationRequestDto) GetIncludeTranslationMessagesOk() (*bool, bool)` + +GetIncludeTranslationMessagesOk returns a tuple with the IncludeTranslationMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTranslationMessages + +`func (o *RecommendationRequestDto) SetIncludeTranslationMessages(v bool)` + +SetIncludeTranslationMessages sets IncludeTranslationMessages field to given value. + +### HasIncludeTranslationMessages + +`func (o *RecommendationRequestDto) HasIncludeTranslationMessages() bool` + +HasIncludeTranslationMessages returns a boolean if a field has been set. + +### GetIncludeDebugInformation + +`func (o *RecommendationRequestDto) GetIncludeDebugInformation() bool` + +GetIncludeDebugInformation returns the IncludeDebugInformation field if non-nil, zero value otherwise. + +### GetIncludeDebugInformationOk + +`func (o *RecommendationRequestDto) GetIncludeDebugInformationOk() (*bool, bool)` + +GetIncludeDebugInformationOk returns a tuple with the IncludeDebugInformation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeDebugInformation + +`func (o *RecommendationRequestDto) SetIncludeDebugInformation(v bool)` + +SetIncludeDebugInformation sets IncludeDebugInformation field to given value. + +### HasIncludeDebugInformation + +`func (o *RecommendationRequestDto) HasIncludeDebugInformation() bool` + +HasIncludeDebugInformation returns a boolean if a field has been set. + +### GetPrescribeMode + +`func (o *RecommendationRequestDto) GetPrescribeMode() bool` + +GetPrescribeMode returns the PrescribeMode field if non-nil, zero value otherwise. + +### GetPrescribeModeOk + +`func (o *RecommendationRequestDto) GetPrescribeModeOk() (*bool, bool)` + +GetPrescribeModeOk returns a tuple with the PrescribeMode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrescribeMode + +`func (o *RecommendationRequestDto) SetPrescribeMode(v bool)` + +SetPrescribeMode sets PrescribeMode field to given value. + +### HasPrescribeMode + +`func (o *RecommendationRequestDto) HasPrescribeMode() bool` + +HasPrescribeMode returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RecommendationResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/RecommendationResponse.md new file mode 100644 index 000000000..2d822416a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RecommendationResponse.md @@ -0,0 +1,168 @@ +--- +id: beta-recommendation-response +title: RecommendationResponse +pagination_label: RecommendationResponse +sidebar_label: RecommendationResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommendationResponse', 'BetaRecommendationResponse'] +slug: /tools/sdk/go/beta/models/recommendation-response +tags: ['SDK', 'Software Development Kit', 'RecommendationResponse', 'BetaRecommendationResponse'] +--- + +# RecommendationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Request** | Pointer to [**RecommendationRequest**](recommendation-request) | | [optional] +**Recommendation** | Pointer to **string** | The recommendation - YES if the access is recommended, NO if not recommended, MAYBE if there is not enough information to make a recommendation, NOT_FOUND if the identity is not found in the system | [optional] +**Interpretations** | Pointer to **[]string** | The list of interpretations explaining the recommendation. The array is empty if includeInterpretations is false or not present in the request. e.g. - [ \"Not approved in the last 6 months.\" ]. Interpretations will be translated using the client's locale as found in the Accept-Language header. If a translation for the client's locale cannot be found, the US English translation will be returned. | [optional] +**TranslationMessages** | Pointer to [**[]TranslationMessage**](translation-message) | The list of translation messages, if they have been requested. | [optional] +**RecommenderCalculations** | Pointer to [**RecommenderCalculations**](recommender-calculations) | | [optional] + +## Methods + +### NewRecommendationResponse + +`func NewRecommendationResponse() *RecommendationResponse` + +NewRecommendationResponse instantiates a new RecommendationResponse 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 + +### NewRecommendationResponseWithDefaults + +`func NewRecommendationResponseWithDefaults() *RecommendationResponse` + +NewRecommendationResponseWithDefaults instantiates a new RecommendationResponse 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 + +### GetRequest + +`func (o *RecommendationResponse) GetRequest() RecommendationRequest` + +GetRequest returns the Request field if non-nil, zero value otherwise. + +### GetRequestOk + +`func (o *RecommendationResponse) GetRequestOk() (*RecommendationRequest, bool)` + +GetRequestOk returns a tuple with the Request field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequest + +`func (o *RecommendationResponse) SetRequest(v RecommendationRequest)` + +SetRequest sets Request field to given value. + +### HasRequest + +`func (o *RecommendationResponse) HasRequest() bool` + +HasRequest returns a boolean if a field has been set. + +### GetRecommendation + +`func (o *RecommendationResponse) GetRecommendation() string` + +GetRecommendation returns the Recommendation field if non-nil, zero value otherwise. + +### GetRecommendationOk + +`func (o *RecommendationResponse) GetRecommendationOk() (*string, bool)` + +GetRecommendationOk returns a tuple with the Recommendation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendation + +`func (o *RecommendationResponse) SetRecommendation(v string)` + +SetRecommendation sets Recommendation field to given value. + +### HasRecommendation + +`func (o *RecommendationResponse) HasRecommendation() bool` + +HasRecommendation returns a boolean if a field has been set. + +### GetInterpretations + +`func (o *RecommendationResponse) GetInterpretations() []string` + +GetInterpretations returns the Interpretations field if non-nil, zero value otherwise. + +### GetInterpretationsOk + +`func (o *RecommendationResponse) GetInterpretationsOk() (*[]string, bool)` + +GetInterpretationsOk returns a tuple with the Interpretations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterpretations + +`func (o *RecommendationResponse) SetInterpretations(v []string)` + +SetInterpretations sets Interpretations field to given value. + +### HasInterpretations + +`func (o *RecommendationResponse) HasInterpretations() bool` + +HasInterpretations returns a boolean if a field has been set. + +### GetTranslationMessages + +`func (o *RecommendationResponse) GetTranslationMessages() []TranslationMessage` + +GetTranslationMessages returns the TranslationMessages field if non-nil, zero value otherwise. + +### GetTranslationMessagesOk + +`func (o *RecommendationResponse) GetTranslationMessagesOk() (*[]TranslationMessage, bool)` + +GetTranslationMessagesOk returns a tuple with the TranslationMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslationMessages + +`func (o *RecommendationResponse) SetTranslationMessages(v []TranslationMessage)` + +SetTranslationMessages sets TranslationMessages field to given value. + +### HasTranslationMessages + +`func (o *RecommendationResponse) HasTranslationMessages() bool` + +HasTranslationMessages returns a boolean if a field has been set. + +### GetRecommenderCalculations + +`func (o *RecommendationResponse) GetRecommenderCalculations() RecommenderCalculations` + +GetRecommenderCalculations returns the RecommenderCalculations field if non-nil, zero value otherwise. + +### GetRecommenderCalculationsOk + +`func (o *RecommendationResponse) GetRecommenderCalculationsOk() (*RecommenderCalculations, bool)` + +GetRecommenderCalculationsOk returns a tuple with the RecommenderCalculations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommenderCalculations + +`func (o *RecommendationResponse) SetRecommenderCalculations(v RecommenderCalculations)` + +SetRecommenderCalculations sets RecommenderCalculations field to given value. + +### HasRecommenderCalculations + +`func (o *RecommendationResponse) HasRecommenderCalculations() bool` + +HasRecommenderCalculations returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RecommendationResponseDto.md b/docs/tools/sdk/go/Reference/Beta/Models/RecommendationResponseDto.md new file mode 100644 index 000000000..1f2133144 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RecommendationResponseDto.md @@ -0,0 +1,64 @@ +--- +id: beta-recommendation-response-dto +title: RecommendationResponseDto +pagination_label: RecommendationResponseDto +sidebar_label: RecommendationResponseDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommendationResponseDto', 'BetaRecommendationResponseDto'] +slug: /tools/sdk/go/beta/models/recommendation-response-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationResponseDto', 'BetaRecommendationResponseDto'] +--- + +# RecommendationResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Response** | Pointer to [**[]RecommendationResponse**](recommendation-response) | | [optional] + +## Methods + +### NewRecommendationResponseDto + +`func NewRecommendationResponseDto() *RecommendationResponseDto` + +NewRecommendationResponseDto instantiates a new RecommendationResponseDto 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 + +### NewRecommendationResponseDtoWithDefaults + +`func NewRecommendationResponseDtoWithDefaults() *RecommendationResponseDto` + +NewRecommendationResponseDtoWithDefaults instantiates a new RecommendationResponseDto 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 + +### GetResponse + +`func (o *RecommendationResponseDto) GetResponse() []RecommendationResponse` + +GetResponse returns the Response field if non-nil, zero value otherwise. + +### GetResponseOk + +`func (o *RecommendationResponseDto) GetResponseOk() (*[]RecommendationResponse, bool)` + +GetResponseOk returns a tuple with the Response field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponse + +`func (o *RecommendationResponseDto) SetResponse(v []RecommendationResponse)` + +SetResponse sets Response field to given value. + +### HasResponse + +`func (o *RecommendationResponseDto) HasResponse() bool` + +HasResponse returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RecommenderCalculations.md b/docs/tools/sdk/go/Reference/Beta/Models/RecommenderCalculations.md new file mode 100644 index 000000000..3fc58d975 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RecommenderCalculations.md @@ -0,0 +1,246 @@ +--- +id: beta-recommender-calculations +title: RecommenderCalculations +pagination_label: RecommenderCalculations +sidebar_label: RecommenderCalculations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommenderCalculations', 'BetaRecommenderCalculations'] +slug: /tools/sdk/go/beta/models/recommender-calculations +tags: ['SDK', 'Software Development Kit', 'RecommenderCalculations', 'BetaRecommenderCalculations'] +--- + +# RecommenderCalculations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | The ID of the identity | [optional] +**EntitlementId** | Pointer to **string** | The entitlement ID | [optional] +**Recommendation** | Pointer to **string** | The actual recommendation | [optional] +**OverallWeightedScore** | Pointer to **float32** | The overall weighted score | [optional] +**FeatureWeightedScores** | Pointer to **map[string]float32** | The weighted score of each individual feature | [optional] +**Threshold** | Pointer to **float32** | The configured value against which the overallWeightedScore is compared | [optional] +**IdentityAttributes** | Pointer to [**map[string]RecommenderCalculationsIdentityAttributesValue**](recommender-calculations-identity-attributes-value) | The values for your configured features | [optional] +**FeatureValues** | Pointer to [**FeatureValueDto**](feature-value-dto) | | [optional] + +## Methods + +### NewRecommenderCalculations + +`func NewRecommenderCalculations() *RecommenderCalculations` + +NewRecommenderCalculations instantiates a new RecommenderCalculations 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 + +### NewRecommenderCalculationsWithDefaults + +`func NewRecommenderCalculationsWithDefaults() *RecommenderCalculations` + +NewRecommenderCalculationsWithDefaults instantiates a new RecommenderCalculations 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 + +### GetIdentityId + +`func (o *RecommenderCalculations) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *RecommenderCalculations) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *RecommenderCalculations) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *RecommenderCalculations) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEntitlementId + +`func (o *RecommenderCalculations) GetEntitlementId() string` + +GetEntitlementId returns the EntitlementId field if non-nil, zero value otherwise. + +### GetEntitlementIdOk + +`func (o *RecommenderCalculations) GetEntitlementIdOk() (*string, bool)` + +GetEntitlementIdOk returns a tuple with the EntitlementId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementId + +`func (o *RecommenderCalculations) SetEntitlementId(v string)` + +SetEntitlementId sets EntitlementId field to given value. + +### HasEntitlementId + +`func (o *RecommenderCalculations) HasEntitlementId() bool` + +HasEntitlementId returns a boolean if a field has been set. + +### GetRecommendation + +`func (o *RecommenderCalculations) GetRecommendation() string` + +GetRecommendation returns the Recommendation field if non-nil, zero value otherwise. + +### GetRecommendationOk + +`func (o *RecommenderCalculations) GetRecommendationOk() (*string, bool)` + +GetRecommendationOk returns a tuple with the Recommendation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendation + +`func (o *RecommenderCalculations) SetRecommendation(v string)` + +SetRecommendation sets Recommendation field to given value. + +### HasRecommendation + +`func (o *RecommenderCalculations) HasRecommendation() bool` + +HasRecommendation returns a boolean if a field has been set. + +### GetOverallWeightedScore + +`func (o *RecommenderCalculations) GetOverallWeightedScore() float32` + +GetOverallWeightedScore returns the OverallWeightedScore field if non-nil, zero value otherwise. + +### GetOverallWeightedScoreOk + +`func (o *RecommenderCalculations) GetOverallWeightedScoreOk() (*float32, bool)` + +GetOverallWeightedScoreOk returns a tuple with the OverallWeightedScore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOverallWeightedScore + +`func (o *RecommenderCalculations) SetOverallWeightedScore(v float32)` + +SetOverallWeightedScore sets OverallWeightedScore field to given value. + +### HasOverallWeightedScore + +`func (o *RecommenderCalculations) HasOverallWeightedScore() bool` + +HasOverallWeightedScore returns a boolean if a field has been set. + +### GetFeatureWeightedScores + +`func (o *RecommenderCalculations) GetFeatureWeightedScores() map[string]float32` + +GetFeatureWeightedScores returns the FeatureWeightedScores field if non-nil, zero value otherwise. + +### GetFeatureWeightedScoresOk + +`func (o *RecommenderCalculations) GetFeatureWeightedScoresOk() (*map[string]float32, bool)` + +GetFeatureWeightedScoresOk returns a tuple with the FeatureWeightedScores field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureWeightedScores + +`func (o *RecommenderCalculations) SetFeatureWeightedScores(v map[string]float32)` + +SetFeatureWeightedScores sets FeatureWeightedScores field to given value. + +### HasFeatureWeightedScores + +`func (o *RecommenderCalculations) HasFeatureWeightedScores() bool` + +HasFeatureWeightedScores returns a boolean if a field has been set. + +### GetThreshold + +`func (o *RecommenderCalculations) GetThreshold() float32` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *RecommenderCalculations) GetThresholdOk() (*float32, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *RecommenderCalculations) SetThreshold(v float32)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *RecommenderCalculations) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetIdentityAttributes + +`func (o *RecommenderCalculations) GetIdentityAttributes() map[string]RecommenderCalculationsIdentityAttributesValue` + +GetIdentityAttributes returns the IdentityAttributes field if non-nil, zero value otherwise. + +### GetIdentityAttributesOk + +`func (o *RecommenderCalculations) GetIdentityAttributesOk() (*map[string]RecommenderCalculationsIdentityAttributesValue, bool)` + +GetIdentityAttributesOk returns a tuple with the IdentityAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributes + +`func (o *RecommenderCalculations) SetIdentityAttributes(v map[string]RecommenderCalculationsIdentityAttributesValue)` + +SetIdentityAttributes sets IdentityAttributes field to given value. + +### HasIdentityAttributes + +`func (o *RecommenderCalculations) HasIdentityAttributes() bool` + +HasIdentityAttributes returns a boolean if a field has been set. + +### GetFeatureValues + +`func (o *RecommenderCalculations) GetFeatureValues() FeatureValueDto` + +GetFeatureValues returns the FeatureValues field if non-nil, zero value otherwise. + +### GetFeatureValuesOk + +`func (o *RecommenderCalculations) GetFeatureValuesOk() (*FeatureValueDto, bool)` + +GetFeatureValuesOk returns a tuple with the FeatureValues field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureValues + +`func (o *RecommenderCalculations) SetFeatureValues(v FeatureValueDto)` + +SetFeatureValues sets FeatureValues field to given value. + +### HasFeatureValues + +`func (o *RecommenderCalculations) HasFeatureValues() bool` + +HasFeatureValues returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RecommenderCalculationsIdentityAttributesValue.md b/docs/tools/sdk/go/Reference/Beta/Models/RecommenderCalculationsIdentityAttributesValue.md new file mode 100644 index 000000000..c07a3f672 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RecommenderCalculationsIdentityAttributesValue.md @@ -0,0 +1,64 @@ +--- +id: beta-recommender-calculations-identity-attributes-value +title: RecommenderCalculationsIdentityAttributesValue +pagination_label: RecommenderCalculationsIdentityAttributesValue +sidebar_label: RecommenderCalculationsIdentityAttributesValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommenderCalculationsIdentityAttributesValue', 'BetaRecommenderCalculationsIdentityAttributesValue'] +slug: /tools/sdk/go/beta/models/recommender-calculations-identity-attributes-value +tags: ['SDK', 'Software Development Kit', 'RecommenderCalculationsIdentityAttributesValue', 'BetaRecommenderCalculationsIdentityAttributesValue'] +--- + +# RecommenderCalculationsIdentityAttributesValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | | [optional] + +## Methods + +### NewRecommenderCalculationsIdentityAttributesValue + +`func NewRecommenderCalculationsIdentityAttributesValue() *RecommenderCalculationsIdentityAttributesValue` + +NewRecommenderCalculationsIdentityAttributesValue instantiates a new RecommenderCalculationsIdentityAttributesValue 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 + +### NewRecommenderCalculationsIdentityAttributesValueWithDefaults + +`func NewRecommenderCalculationsIdentityAttributesValueWithDefaults() *RecommenderCalculationsIdentityAttributesValue` + +NewRecommenderCalculationsIdentityAttributesValueWithDefaults instantiates a new RecommenderCalculationsIdentityAttributesValue 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 + +### GetValue + +`func (o *RecommenderCalculationsIdentityAttributesValue) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *RecommenderCalculationsIdentityAttributesValue) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *RecommenderCalculationsIdentityAttributesValue) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *RecommenderCalculationsIdentityAttributesValue) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RemediationItemDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/RemediationItemDetails.md new file mode 100644 index 000000000..497967a98 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RemediationItemDetails.md @@ -0,0 +1,272 @@ +--- +id: beta-remediation-item-details +title: RemediationItemDetails +pagination_label: RemediationItemDetails +sidebar_label: RemediationItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RemediationItemDetails', 'BetaRemediationItemDetails'] +slug: /tools/sdk/go/beta/models/remediation-item-details +tags: ['SDK', 'Software Development Kit', 'RemediationItemDetails', 'BetaRemediationItemDetails'] +--- + +# RemediationItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the certification | [optional] +**TargetId** | Pointer to **string** | The ID of the certification target | [optional] +**TargetName** | Pointer to **string** | The name of the certification target | [optional] +**TargetDisplayName** | Pointer to **string** | The display name of the certification target | [optional] +**ApplicationName** | Pointer to **string** | The name of the application/source | [optional] +**AttributeName** | Pointer to **string** | The name of the attribute being certified | [optional] +**AttributeOperation** | Pointer to **string** | The operation of the certification on the attribute | [optional] +**AttributeValue** | Pointer to **string** | The value of the attribute being certified | [optional] +**NativeIdentity** | Pointer to **string** | The native identity of the target | [optional] + +## Methods + +### NewRemediationItemDetails + +`func NewRemediationItemDetails() *RemediationItemDetails` + +NewRemediationItemDetails instantiates a new RemediationItemDetails 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 + +### NewRemediationItemDetailsWithDefaults + +`func NewRemediationItemDetailsWithDefaults() *RemediationItemDetails` + +NewRemediationItemDetailsWithDefaults instantiates a new RemediationItemDetails 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 + +### GetId + +`func (o *RemediationItemDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RemediationItemDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RemediationItemDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RemediationItemDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetTargetId + +`func (o *RemediationItemDetails) GetTargetId() string` + +GetTargetId returns the TargetId field if non-nil, zero value otherwise. + +### GetTargetIdOk + +`func (o *RemediationItemDetails) GetTargetIdOk() (*string, bool)` + +GetTargetIdOk returns a tuple with the TargetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetId + +`func (o *RemediationItemDetails) SetTargetId(v string)` + +SetTargetId sets TargetId field to given value. + +### HasTargetId + +`func (o *RemediationItemDetails) HasTargetId() bool` + +HasTargetId returns a boolean if a field has been set. + +### GetTargetName + +`func (o *RemediationItemDetails) GetTargetName() string` + +GetTargetName returns the TargetName field if non-nil, zero value otherwise. + +### GetTargetNameOk + +`func (o *RemediationItemDetails) GetTargetNameOk() (*string, bool)` + +GetTargetNameOk returns a tuple with the TargetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetName + +`func (o *RemediationItemDetails) SetTargetName(v string)` + +SetTargetName sets TargetName field to given value. + +### HasTargetName + +`func (o *RemediationItemDetails) HasTargetName() bool` + +HasTargetName returns a boolean if a field has been set. + +### GetTargetDisplayName + +`func (o *RemediationItemDetails) GetTargetDisplayName() string` + +GetTargetDisplayName returns the TargetDisplayName field if non-nil, zero value otherwise. + +### GetTargetDisplayNameOk + +`func (o *RemediationItemDetails) GetTargetDisplayNameOk() (*string, bool)` + +GetTargetDisplayNameOk returns a tuple with the TargetDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetDisplayName + +`func (o *RemediationItemDetails) SetTargetDisplayName(v string)` + +SetTargetDisplayName sets TargetDisplayName field to given value. + +### HasTargetDisplayName + +`func (o *RemediationItemDetails) HasTargetDisplayName() bool` + +HasTargetDisplayName returns a boolean if a field has been set. + +### GetApplicationName + +`func (o *RemediationItemDetails) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *RemediationItemDetails) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *RemediationItemDetails) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *RemediationItemDetails) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *RemediationItemDetails) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *RemediationItemDetails) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *RemediationItemDetails) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *RemediationItemDetails) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + +### GetAttributeOperation + +`func (o *RemediationItemDetails) GetAttributeOperation() string` + +GetAttributeOperation returns the AttributeOperation field if non-nil, zero value otherwise. + +### GetAttributeOperationOk + +`func (o *RemediationItemDetails) GetAttributeOperationOk() (*string, bool)` + +GetAttributeOperationOk returns a tuple with the AttributeOperation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeOperation + +`func (o *RemediationItemDetails) SetAttributeOperation(v string)` + +SetAttributeOperation sets AttributeOperation field to given value. + +### HasAttributeOperation + +`func (o *RemediationItemDetails) HasAttributeOperation() bool` + +HasAttributeOperation returns a boolean if a field has been set. + +### GetAttributeValue + +`func (o *RemediationItemDetails) GetAttributeValue() string` + +GetAttributeValue returns the AttributeValue field if non-nil, zero value otherwise. + +### GetAttributeValueOk + +`func (o *RemediationItemDetails) GetAttributeValueOk() (*string, bool)` + +GetAttributeValueOk returns a tuple with the AttributeValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeValue + +`func (o *RemediationItemDetails) SetAttributeValue(v string)` + +SetAttributeValue sets AttributeValue field to given value. + +### HasAttributeValue + +`func (o *RemediationItemDetails) HasAttributeValue() bool` + +HasAttributeValue returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *RemediationItemDetails) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *RemediationItemDetails) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *RemediationItemDetails) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *RemediationItemDetails) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RemediationItems.md b/docs/tools/sdk/go/Reference/Beta/Models/RemediationItems.md new file mode 100644 index 000000000..911d6b2e4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RemediationItems.md @@ -0,0 +1,272 @@ +--- +id: beta-remediation-items +title: RemediationItems +pagination_label: RemediationItems +sidebar_label: RemediationItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RemediationItems', 'BetaRemediationItems'] +slug: /tools/sdk/go/beta/models/remediation-items +tags: ['SDK', 'Software Development Kit', 'RemediationItems', 'BetaRemediationItems'] +--- + +# RemediationItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the certification | [optional] +**TargetId** | Pointer to **string** | The ID of the certification target | [optional] +**TargetName** | Pointer to **string** | The name of the certification target | [optional] +**TargetDisplayName** | Pointer to **string** | The display name of the certification target | [optional] +**ApplicationName** | Pointer to **string** | The name of the application/source | [optional] +**AttributeName** | Pointer to **string** | The name of the attribute being certified | [optional] +**AttributeOperation** | Pointer to **string** | The operation of the certification on the attribute | [optional] +**AttributeValue** | Pointer to **string** | The value of the attribute being certified | [optional] +**NativeIdentity** | Pointer to **string** | The native identity of the target | [optional] + +## Methods + +### NewRemediationItems + +`func NewRemediationItems() *RemediationItems` + +NewRemediationItems instantiates a new RemediationItems 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 + +### NewRemediationItemsWithDefaults + +`func NewRemediationItemsWithDefaults() *RemediationItems` + +NewRemediationItemsWithDefaults instantiates a new RemediationItems 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 + +### GetId + +`func (o *RemediationItems) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RemediationItems) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RemediationItems) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RemediationItems) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetTargetId + +`func (o *RemediationItems) GetTargetId() string` + +GetTargetId returns the TargetId field if non-nil, zero value otherwise. + +### GetTargetIdOk + +`func (o *RemediationItems) GetTargetIdOk() (*string, bool)` + +GetTargetIdOk returns a tuple with the TargetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetId + +`func (o *RemediationItems) SetTargetId(v string)` + +SetTargetId sets TargetId field to given value. + +### HasTargetId + +`func (o *RemediationItems) HasTargetId() bool` + +HasTargetId returns a boolean if a field has been set. + +### GetTargetName + +`func (o *RemediationItems) GetTargetName() string` + +GetTargetName returns the TargetName field if non-nil, zero value otherwise. + +### GetTargetNameOk + +`func (o *RemediationItems) GetTargetNameOk() (*string, bool)` + +GetTargetNameOk returns a tuple with the TargetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetName + +`func (o *RemediationItems) SetTargetName(v string)` + +SetTargetName sets TargetName field to given value. + +### HasTargetName + +`func (o *RemediationItems) HasTargetName() bool` + +HasTargetName returns a boolean if a field has been set. + +### GetTargetDisplayName + +`func (o *RemediationItems) GetTargetDisplayName() string` + +GetTargetDisplayName returns the TargetDisplayName field if non-nil, zero value otherwise. + +### GetTargetDisplayNameOk + +`func (o *RemediationItems) GetTargetDisplayNameOk() (*string, bool)` + +GetTargetDisplayNameOk returns a tuple with the TargetDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetDisplayName + +`func (o *RemediationItems) SetTargetDisplayName(v string)` + +SetTargetDisplayName sets TargetDisplayName field to given value. + +### HasTargetDisplayName + +`func (o *RemediationItems) HasTargetDisplayName() bool` + +HasTargetDisplayName returns a boolean if a field has been set. + +### GetApplicationName + +`func (o *RemediationItems) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *RemediationItems) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *RemediationItems) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *RemediationItems) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *RemediationItems) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *RemediationItems) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *RemediationItems) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *RemediationItems) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + +### GetAttributeOperation + +`func (o *RemediationItems) GetAttributeOperation() string` + +GetAttributeOperation returns the AttributeOperation field if non-nil, zero value otherwise. + +### GetAttributeOperationOk + +`func (o *RemediationItems) GetAttributeOperationOk() (*string, bool)` + +GetAttributeOperationOk returns a tuple with the AttributeOperation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeOperation + +`func (o *RemediationItems) SetAttributeOperation(v string)` + +SetAttributeOperation sets AttributeOperation field to given value. + +### HasAttributeOperation + +`func (o *RemediationItems) HasAttributeOperation() bool` + +HasAttributeOperation returns a boolean if a field has been set. + +### GetAttributeValue + +`func (o *RemediationItems) GetAttributeValue() string` + +GetAttributeValue returns the AttributeValue field if non-nil, zero value otherwise. + +### GetAttributeValueOk + +`func (o *RemediationItems) GetAttributeValueOk() (*string, bool)` + +GetAttributeValueOk returns a tuple with the AttributeValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeValue + +`func (o *RemediationItems) SetAttributeValue(v string)` + +SetAttributeValue sets AttributeValue field to given value. + +### HasAttributeValue + +`func (o *RemediationItems) HasAttributeValue() bool` + +HasAttributeValue returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *RemediationItems) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *RemediationItems) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *RemediationItems) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *RemediationItems) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ReportConfigDTO.md b/docs/tools/sdk/go/Reference/Beta/Models/ReportConfigDTO.md new file mode 100644 index 000000000..6a090a8bf --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ReportConfigDTO.md @@ -0,0 +1,142 @@ +--- +id: beta-report-config-dto +title: ReportConfigDTO +pagination_label: ReportConfigDTO +sidebar_label: ReportConfigDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportConfigDTO', 'BetaReportConfigDTO'] +slug: /tools/sdk/go/beta/models/report-config-dto +tags: ['SDK', 'Software Development Kit', 'ReportConfigDTO', 'BetaReportConfigDTO'] +--- + +# ReportConfigDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ColumnName** | Pointer to **string** | Name of column in report | [optional] +**Required** | Pointer to **bool** | If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column's definition. | [optional] [default to false] +**Included** | Pointer to **bool** | If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true. | [optional] [default to false] +**Order** | Pointer to **int32** | Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order. | [optional] + +## Methods + +### NewReportConfigDTO + +`func NewReportConfigDTO() *ReportConfigDTO` + +NewReportConfigDTO instantiates a new ReportConfigDTO 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 + +### NewReportConfigDTOWithDefaults + +`func NewReportConfigDTOWithDefaults() *ReportConfigDTO` + +NewReportConfigDTOWithDefaults instantiates a new ReportConfigDTO 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 + +### GetColumnName + +`func (o *ReportConfigDTO) GetColumnName() string` + +GetColumnName returns the ColumnName field if non-nil, zero value otherwise. + +### GetColumnNameOk + +`func (o *ReportConfigDTO) GetColumnNameOk() (*string, bool)` + +GetColumnNameOk returns a tuple with the ColumnName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumnName + +`func (o *ReportConfigDTO) SetColumnName(v string)` + +SetColumnName sets ColumnName field to given value. + +### HasColumnName + +`func (o *ReportConfigDTO) HasColumnName() bool` + +HasColumnName returns a boolean if a field has been set. + +### GetRequired + +`func (o *ReportConfigDTO) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *ReportConfigDTO) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *ReportConfigDTO) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *ReportConfigDTO) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + +### GetIncluded + +`func (o *ReportConfigDTO) GetIncluded() bool` + +GetIncluded returns the Included field if non-nil, zero value otherwise. + +### GetIncludedOk + +`func (o *ReportConfigDTO) GetIncludedOk() (*bool, bool)` + +GetIncludedOk returns a tuple with the Included field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncluded + +`func (o *ReportConfigDTO) SetIncluded(v bool)` + +SetIncluded sets Included field to given value. + +### HasIncluded + +`func (o *ReportConfigDTO) HasIncluded() bool` + +HasIncluded returns a boolean if a field has been set. + +### GetOrder + +`func (o *ReportConfigDTO) GetOrder() int32` + +GetOrder returns the Order field if non-nil, zero value otherwise. + +### GetOrderOk + +`func (o *ReportConfigDTO) GetOrderOk() (*int32, bool)` + +GetOrderOk returns a tuple with the Order field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrder + +`func (o *ReportConfigDTO) SetOrder(v int32)` + +SetOrder sets Order field to given value. + +### HasOrder + +`func (o *ReportConfigDTO) HasOrder() bool` + +HasOrder returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ReportResultReference.md b/docs/tools/sdk/go/Reference/Beta/Models/ReportResultReference.md new file mode 100644 index 000000000..5bd45e878 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ReportResultReference.md @@ -0,0 +1,142 @@ +--- +id: beta-report-result-reference +title: ReportResultReference +pagination_label: ReportResultReference +sidebar_label: ReportResultReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportResultReference', 'BetaReportResultReference'] +slug: /tools/sdk/go/beta/models/report-result-reference +tags: ['SDK', 'Software Development Kit', 'ReportResultReference', 'BetaReportResultReference'] +--- + +# ReportResultReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **string** | Human-readable name of the SOD policy violation report result. | [optional] +**Status** | Pointer to **string** | Status of a SOD policy violation report. | [optional] + +## Methods + +### NewReportResultReference + +`func NewReportResultReference() *ReportResultReference` + +NewReportResultReference instantiates a new ReportResultReference 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 + +### NewReportResultReferenceWithDefaults + +`func NewReportResultReferenceWithDefaults() *ReportResultReference` + +NewReportResultReferenceWithDefaults instantiates a new ReportResultReference 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 + +### GetType + +`func (o *ReportResultReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReportResultReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReportResultReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ReportResultReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ReportResultReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReportResultReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReportResultReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReportResultReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ReportResultReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ReportResultReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ReportResultReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ReportResultReference) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *ReportResultReference) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ReportResultReference) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ReportResultReference) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ReportResultReference) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ReportType.md b/docs/tools/sdk/go/Reference/Beta/Models/ReportType.md new file mode 100644 index 000000000..54e726cc7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ReportType.md @@ -0,0 +1,25 @@ +--- +id: beta-report-type +title: ReportType +pagination_label: ReportType +sidebar_label: ReportType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportType', 'BetaReportType'] +slug: /tools/sdk/go/beta/models/report-type +tags: ['SDK', 'Software Development Kit', 'ReportType', 'BetaReportType'] +--- + +# ReportType + +## Enum + + +* `CAMPAIGN_COMPOSITION_REPORT` (value: `"CAMPAIGN_COMPOSITION_REPORT"`) + +* `CAMPAIGN_REMEDIATION_STATUS_REPORT` (value: `"CAMPAIGN_REMEDIATION_STATUS_REPORT"`) + +* `CAMPAIGN_STATUS_REPORT` (value: `"CAMPAIGN_STATUS_REPORT"`) + +* `CERTIFICATION_SIGNOFF_REPORT` (value: `"CERTIFICATION_SIGNOFF_REPORT"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestOnBehalfOfConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestOnBehalfOfConfig.md new file mode 100644 index 000000000..155a52b16 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestOnBehalfOfConfig.md @@ -0,0 +1,90 @@ +--- +id: beta-request-on-behalf-of-config +title: RequestOnBehalfOfConfig +pagination_label: RequestOnBehalfOfConfig +sidebar_label: RequestOnBehalfOfConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestOnBehalfOfConfig', 'BetaRequestOnBehalfOfConfig'] +slug: /tools/sdk/go/beta/models/request-on-behalf-of-config +tags: ['SDK', 'Software Development Kit', 'RequestOnBehalfOfConfig', 'BetaRequestOnBehalfOfConfig'] +--- + +# RequestOnBehalfOfConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AllowRequestOnBehalfOfAnyoneByAnyone** | Pointer to **bool** | If this is true, anyone can request access for anyone. | [optional] [default to false] +**AllowRequestOnBehalfOfEmployeeByManager** | Pointer to **bool** | If this is true, a manager can request access for his or her direct reports. | [optional] [default to false] + +## Methods + +### NewRequestOnBehalfOfConfig + +`func NewRequestOnBehalfOfConfig() *RequestOnBehalfOfConfig` + +NewRequestOnBehalfOfConfig instantiates a new RequestOnBehalfOfConfig 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 + +### NewRequestOnBehalfOfConfigWithDefaults + +`func NewRequestOnBehalfOfConfigWithDefaults() *RequestOnBehalfOfConfig` + +NewRequestOnBehalfOfConfigWithDefaults instantiates a new RequestOnBehalfOfConfig 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 + +### GetAllowRequestOnBehalfOfAnyoneByAnyone + +`func (o *RequestOnBehalfOfConfig) GetAllowRequestOnBehalfOfAnyoneByAnyone() bool` + +GetAllowRequestOnBehalfOfAnyoneByAnyone returns the AllowRequestOnBehalfOfAnyoneByAnyone field if non-nil, zero value otherwise. + +### GetAllowRequestOnBehalfOfAnyoneByAnyoneOk + +`func (o *RequestOnBehalfOfConfig) GetAllowRequestOnBehalfOfAnyoneByAnyoneOk() (*bool, bool)` + +GetAllowRequestOnBehalfOfAnyoneByAnyoneOk returns a tuple with the AllowRequestOnBehalfOfAnyoneByAnyone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllowRequestOnBehalfOfAnyoneByAnyone + +`func (o *RequestOnBehalfOfConfig) SetAllowRequestOnBehalfOfAnyoneByAnyone(v bool)` + +SetAllowRequestOnBehalfOfAnyoneByAnyone sets AllowRequestOnBehalfOfAnyoneByAnyone field to given value. + +### HasAllowRequestOnBehalfOfAnyoneByAnyone + +`func (o *RequestOnBehalfOfConfig) HasAllowRequestOnBehalfOfAnyoneByAnyone() bool` + +HasAllowRequestOnBehalfOfAnyoneByAnyone returns a boolean if a field has been set. + +### GetAllowRequestOnBehalfOfEmployeeByManager + +`func (o *RequestOnBehalfOfConfig) GetAllowRequestOnBehalfOfEmployeeByManager() bool` + +GetAllowRequestOnBehalfOfEmployeeByManager returns the AllowRequestOnBehalfOfEmployeeByManager field if non-nil, zero value otherwise. + +### GetAllowRequestOnBehalfOfEmployeeByManagerOk + +`func (o *RequestOnBehalfOfConfig) GetAllowRequestOnBehalfOfEmployeeByManagerOk() (*bool, bool)` + +GetAllowRequestOnBehalfOfEmployeeByManagerOk returns a tuple with the AllowRequestOnBehalfOfEmployeeByManager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllowRequestOnBehalfOfEmployeeByManager + +`func (o *RequestOnBehalfOfConfig) SetAllowRequestOnBehalfOfEmployeeByManager(v bool)` + +SetAllowRequestOnBehalfOfEmployeeByManager sets AllowRequestOnBehalfOfEmployeeByManager field to given value. + +### HasAllowRequestOnBehalfOfEmployeeByManager + +`func (o *RequestOnBehalfOfConfig) HasAllowRequestOnBehalfOfEmployeeByManager() bool` + +HasAllowRequestOnBehalfOfEmployeeByManager returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Requestability.md b/docs/tools/sdk/go/Reference/Beta/Models/Requestability.md new file mode 100644 index 000000000..db4f642a0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Requestability.md @@ -0,0 +1,182 @@ +--- +id: beta-requestability +title: Requestability +pagination_label: Requestability +sidebar_label: Requestability +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Requestability', 'BetaRequestability'] +slug: /tools/sdk/go/beta/models/requestability +tags: ['SDK', 'Software Development Kit', 'Requestability', 'BetaRequestability'] +--- + +# Requestability + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **NullableBool** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to false] +**DenialCommentsRequired** | Pointer to **NullableBool** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to false] +**ReauthorizationRequired** | Pointer to **NullableBool** | Indicates whether reauthorization is required for the request. | [optional] [default to false] +**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] + +## Methods + +### NewRequestability + +`func NewRequestability() *Requestability` + +NewRequestability instantiates a new Requestability 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 + +### NewRequestabilityWithDefaults + +`func NewRequestabilityWithDefaults() *Requestability` + +NewRequestabilityWithDefaults instantiates a new Requestability 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 + +### GetCommentsRequired + +`func (o *Requestability) GetCommentsRequired() bool` + +GetCommentsRequired returns the CommentsRequired field if non-nil, zero value otherwise. + +### GetCommentsRequiredOk + +`func (o *Requestability) GetCommentsRequiredOk() (*bool, bool)` + +GetCommentsRequiredOk returns a tuple with the CommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentsRequired + +`func (o *Requestability) SetCommentsRequired(v bool)` + +SetCommentsRequired sets CommentsRequired field to given value. + +### HasCommentsRequired + +`func (o *Requestability) HasCommentsRequired() bool` + +HasCommentsRequired returns a boolean if a field has been set. + +### SetCommentsRequiredNil + +`func (o *Requestability) SetCommentsRequiredNil(b bool)` + + SetCommentsRequiredNil sets the value for CommentsRequired to be an explicit nil + +### UnsetCommentsRequired +`func (o *Requestability) UnsetCommentsRequired()` + +UnsetCommentsRequired ensures that no value is present for CommentsRequired, not even an explicit nil +### GetDenialCommentsRequired + +`func (o *Requestability) GetDenialCommentsRequired() bool` + +GetDenialCommentsRequired returns the DenialCommentsRequired field if non-nil, zero value otherwise. + +### GetDenialCommentsRequiredOk + +`func (o *Requestability) GetDenialCommentsRequiredOk() (*bool, bool)` + +GetDenialCommentsRequiredOk returns a tuple with the DenialCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenialCommentsRequired + +`func (o *Requestability) SetDenialCommentsRequired(v bool)` + +SetDenialCommentsRequired sets DenialCommentsRequired field to given value. + +### HasDenialCommentsRequired + +`func (o *Requestability) HasDenialCommentsRequired() bool` + +HasDenialCommentsRequired returns a boolean if a field has been set. + +### SetDenialCommentsRequiredNil + +`func (o *Requestability) SetDenialCommentsRequiredNil(b bool)` + + SetDenialCommentsRequiredNil sets the value for DenialCommentsRequired to be an explicit nil + +### UnsetDenialCommentsRequired +`func (o *Requestability) UnsetDenialCommentsRequired()` + +UnsetDenialCommentsRequired ensures that no value is present for DenialCommentsRequired, not even an explicit nil +### GetReauthorizationRequired + +`func (o *Requestability) GetReauthorizationRequired() bool` + +GetReauthorizationRequired returns the ReauthorizationRequired field if non-nil, zero value otherwise. + +### GetReauthorizationRequiredOk + +`func (o *Requestability) GetReauthorizationRequiredOk() (*bool, bool)` + +GetReauthorizationRequiredOk returns a tuple with the ReauthorizationRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReauthorizationRequired + +`func (o *Requestability) SetReauthorizationRequired(v bool)` + +SetReauthorizationRequired sets ReauthorizationRequired field to given value. + +### HasReauthorizationRequired + +`func (o *Requestability) HasReauthorizationRequired() bool` + +HasReauthorizationRequired returns a boolean if a field has been set. + +### SetReauthorizationRequiredNil + +`func (o *Requestability) SetReauthorizationRequiredNil(b bool)` + + SetReauthorizationRequiredNil sets the value for ReauthorizationRequired to be an explicit nil + +### UnsetReauthorizationRequired +`func (o *Requestability) UnsetReauthorizationRequired()` + +UnsetReauthorizationRequired ensures that no value is present for ReauthorizationRequired, not even an explicit nil +### GetApprovalSchemes + +`func (o *Requestability) GetApprovalSchemes() []AccessProfileApprovalScheme` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *Requestability) GetApprovalSchemesOk() (*[]AccessProfileApprovalScheme, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *Requestability) SetApprovalSchemes(v []AccessProfileApprovalScheme)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *Requestability) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + +### SetApprovalSchemesNil + +`func (o *Requestability) SetApprovalSchemesNil(b bool)` + + SetApprovalSchemesNil sets the value for ApprovalSchemes to be an explicit nil + +### UnsetApprovalSchemes +`func (o *Requestability) UnsetApprovalSchemes()` + +UnsetApprovalSchemes ensures that no value is present for ApprovalSchemes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestabilityForRole.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestabilityForRole.md new file mode 100644 index 000000000..a494adb52 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestabilityForRole.md @@ -0,0 +1,172 @@ +--- +id: beta-requestability-for-role +title: RequestabilityForRole +pagination_label: RequestabilityForRole +sidebar_label: RequestabilityForRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestabilityForRole', 'BetaRequestabilityForRole'] +slug: /tools/sdk/go/beta/models/requestability-for-role +tags: ['SDK', 'Software Development Kit', 'RequestabilityForRole', 'BetaRequestabilityForRole'] +--- + +# RequestabilityForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **NullableBool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to false] +**DenialCommentsRequired** | Pointer to **NullableBool** | Whether an approver must provide comments when denying the request | [optional] [default to false] +**ReauthorizationRequired** | Pointer to **NullableBool** | Indicates whether reauthorization is required for the request. | [optional] [default to false] +**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] + +## Methods + +### NewRequestabilityForRole + +`func NewRequestabilityForRole() *RequestabilityForRole` + +NewRequestabilityForRole instantiates a new RequestabilityForRole 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 + +### NewRequestabilityForRoleWithDefaults + +`func NewRequestabilityForRoleWithDefaults() *RequestabilityForRole` + +NewRequestabilityForRoleWithDefaults instantiates a new RequestabilityForRole 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 + +### GetCommentsRequired + +`func (o *RequestabilityForRole) GetCommentsRequired() bool` + +GetCommentsRequired returns the CommentsRequired field if non-nil, zero value otherwise. + +### GetCommentsRequiredOk + +`func (o *RequestabilityForRole) GetCommentsRequiredOk() (*bool, bool)` + +GetCommentsRequiredOk returns a tuple with the CommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentsRequired + +`func (o *RequestabilityForRole) SetCommentsRequired(v bool)` + +SetCommentsRequired sets CommentsRequired field to given value. + +### HasCommentsRequired + +`func (o *RequestabilityForRole) HasCommentsRequired() bool` + +HasCommentsRequired returns a boolean if a field has been set. + +### SetCommentsRequiredNil + +`func (o *RequestabilityForRole) SetCommentsRequiredNil(b bool)` + + SetCommentsRequiredNil sets the value for CommentsRequired to be an explicit nil + +### UnsetCommentsRequired +`func (o *RequestabilityForRole) UnsetCommentsRequired()` + +UnsetCommentsRequired ensures that no value is present for CommentsRequired, not even an explicit nil +### GetDenialCommentsRequired + +`func (o *RequestabilityForRole) GetDenialCommentsRequired() bool` + +GetDenialCommentsRequired returns the DenialCommentsRequired field if non-nil, zero value otherwise. + +### GetDenialCommentsRequiredOk + +`func (o *RequestabilityForRole) GetDenialCommentsRequiredOk() (*bool, bool)` + +GetDenialCommentsRequiredOk returns a tuple with the DenialCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenialCommentsRequired + +`func (o *RequestabilityForRole) SetDenialCommentsRequired(v bool)` + +SetDenialCommentsRequired sets DenialCommentsRequired field to given value. + +### HasDenialCommentsRequired + +`func (o *RequestabilityForRole) HasDenialCommentsRequired() bool` + +HasDenialCommentsRequired returns a boolean if a field has been set. + +### SetDenialCommentsRequiredNil + +`func (o *RequestabilityForRole) SetDenialCommentsRequiredNil(b bool)` + + SetDenialCommentsRequiredNil sets the value for DenialCommentsRequired to be an explicit nil + +### UnsetDenialCommentsRequired +`func (o *RequestabilityForRole) UnsetDenialCommentsRequired()` + +UnsetDenialCommentsRequired ensures that no value is present for DenialCommentsRequired, not even an explicit nil +### GetReauthorizationRequired + +`func (o *RequestabilityForRole) GetReauthorizationRequired() bool` + +GetReauthorizationRequired returns the ReauthorizationRequired field if non-nil, zero value otherwise. + +### GetReauthorizationRequiredOk + +`func (o *RequestabilityForRole) GetReauthorizationRequiredOk() (*bool, bool)` + +GetReauthorizationRequiredOk returns a tuple with the ReauthorizationRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReauthorizationRequired + +`func (o *RequestabilityForRole) SetReauthorizationRequired(v bool)` + +SetReauthorizationRequired sets ReauthorizationRequired field to given value. + +### HasReauthorizationRequired + +`func (o *RequestabilityForRole) HasReauthorizationRequired() bool` + +HasReauthorizationRequired returns a boolean if a field has been set. + +### SetReauthorizationRequiredNil + +`func (o *RequestabilityForRole) SetReauthorizationRequiredNil(b bool)` + + SetReauthorizationRequiredNil sets the value for ReauthorizationRequired to be an explicit nil + +### UnsetReauthorizationRequired +`func (o *RequestabilityForRole) UnsetReauthorizationRequired()` + +UnsetReauthorizationRequired ensures that no value is present for ReauthorizationRequired, not even an explicit nil +### GetApprovalSchemes + +`func (o *RequestabilityForRole) GetApprovalSchemes() []ApprovalSchemeForRole` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *RequestabilityForRole) GetApprovalSchemesOk() (*[]ApprovalSchemeForRole, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *RequestabilityForRole) SetApprovalSchemes(v []ApprovalSchemeForRole)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *RequestabilityForRole) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestableObject.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestableObject.md new file mode 100644 index 000000000..b9c5d6436 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestableObject.md @@ -0,0 +1,338 @@ +--- +id: beta-requestable-object +title: RequestableObject +pagination_label: RequestableObject +sidebar_label: RequestableObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObject', 'BetaRequestableObject'] +slug: /tools/sdk/go/beta/models/requestable-object +tags: ['SDK', 'Software Development Kit', 'RequestableObject', 'BetaRequestableObject'] +--- + +# RequestableObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the requestable object itself | [optional] +**Name** | Pointer to **string** | Human-readable display name of the requestable object | [optional] +**Created** | Pointer to **SailPointTime** | The time when the requestable object was created | [optional] +**Modified** | Pointer to **NullableTime** | The time when the requestable object was last modified | [optional] +**Description** | Pointer to **NullableString** | Description of the requestable object. | [optional] +**Type** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional] +**RequestStatus** | Pointer to [**RequestableObjectRequestStatus**](requestable-object-request-status) | | [optional] +**IdentityRequestId** | Pointer to **NullableString** | If *requestStatus* is *PENDING*, indicates the id of the associated account activity. | [optional] +**OwnerRef** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**RequestCommentsRequired** | Pointer to **bool** | Whether the requester must provide comments when requesting the object. | [optional] + +## Methods + +### NewRequestableObject + +`func NewRequestableObject() *RequestableObject` + +NewRequestableObject instantiates a new RequestableObject 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 + +### NewRequestableObjectWithDefaults + +`func NewRequestableObjectWithDefaults() *RequestableObject` + +NewRequestableObjectWithDefaults instantiates a new RequestableObject 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 + +### GetId + +`func (o *RequestableObject) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestableObject) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestableObject) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestableObject) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RequestableObject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestableObject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestableObject) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestableObject) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *RequestableObject) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RequestableObject) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RequestableObject) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RequestableObject) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *RequestableObject) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RequestableObject) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RequestableObject) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RequestableObject) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *RequestableObject) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *RequestableObject) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDescription + +`func (o *RequestableObject) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RequestableObject) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RequestableObject) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RequestableObject) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RequestableObject) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RequestableObject) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *RequestableObject) GetType() RequestableObjectType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestableObject) GetTypeOk() (*RequestableObjectType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestableObject) SetType(v RequestableObjectType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestableObject) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRequestStatus + +`func (o *RequestableObject) GetRequestStatus() RequestableObjectRequestStatus` + +GetRequestStatus returns the RequestStatus field if non-nil, zero value otherwise. + +### GetRequestStatusOk + +`func (o *RequestableObject) GetRequestStatusOk() (*RequestableObjectRequestStatus, bool)` + +GetRequestStatusOk returns a tuple with the RequestStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestStatus + +`func (o *RequestableObject) SetRequestStatus(v RequestableObjectRequestStatus)` + +SetRequestStatus sets RequestStatus field to given value. + +### HasRequestStatus + +`func (o *RequestableObject) HasRequestStatus() bool` + +HasRequestStatus returns a boolean if a field has been set. + +### GetIdentityRequestId + +`func (o *RequestableObject) GetIdentityRequestId() string` + +GetIdentityRequestId returns the IdentityRequestId field if non-nil, zero value otherwise. + +### GetIdentityRequestIdOk + +`func (o *RequestableObject) GetIdentityRequestIdOk() (*string, bool)` + +GetIdentityRequestIdOk returns a tuple with the IdentityRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityRequestId + +`func (o *RequestableObject) SetIdentityRequestId(v string)` + +SetIdentityRequestId sets IdentityRequestId field to given value. + +### HasIdentityRequestId + +`func (o *RequestableObject) HasIdentityRequestId() bool` + +HasIdentityRequestId returns a boolean if a field has been set. + +### SetIdentityRequestIdNil + +`func (o *RequestableObject) SetIdentityRequestIdNil(b bool)` + + SetIdentityRequestIdNil sets the value for IdentityRequestId to be an explicit nil + +### UnsetIdentityRequestId +`func (o *RequestableObject) UnsetIdentityRequestId()` + +UnsetIdentityRequestId ensures that no value is present for IdentityRequestId, not even an explicit nil +### GetOwnerRef + +`func (o *RequestableObject) GetOwnerRef() IdentityReferenceWithNameAndEmail` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *RequestableObject) GetOwnerRefOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *RequestableObject) SetOwnerRef(v IdentityReferenceWithNameAndEmail)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *RequestableObject) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### SetOwnerRefNil + +`func (o *RequestableObject) SetOwnerRefNil(b bool)` + + SetOwnerRefNil sets the value for OwnerRef to be an explicit nil + +### UnsetOwnerRef +`func (o *RequestableObject) UnsetOwnerRef()` + +UnsetOwnerRef ensures that no value is present for OwnerRef, not even an explicit nil +### GetRequestCommentsRequired + +`func (o *RequestableObject) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *RequestableObject) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *RequestableObject) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *RequestableObject) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestableObjectReference.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestableObjectReference.md new file mode 100644 index 000000000..cd3b3511a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestableObjectReference.md @@ -0,0 +1,142 @@ +--- +id: beta-requestable-object-reference +title: RequestableObjectReference +pagination_label: RequestableObjectReference +sidebar_label: RequestableObjectReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObjectReference', 'BetaRequestableObjectReference'] +slug: /tools/sdk/go/beta/models/requestable-object-reference +tags: ['SDK', 'Software Development Kit', 'RequestableObjectReference', 'BetaRequestableObjectReference'] +--- + +# RequestableObjectReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the object. | [optional] +**Name** | Pointer to **string** | Name of the object. | [optional] +**Description** | Pointer to **string** | Description of the object. | [optional] +**Type** | Pointer to **string** | Type of the object. | [optional] + +## Methods + +### NewRequestableObjectReference + +`func NewRequestableObjectReference() *RequestableObjectReference` + +NewRequestableObjectReference instantiates a new RequestableObjectReference 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 + +### NewRequestableObjectReferenceWithDefaults + +`func NewRequestableObjectReferenceWithDefaults() *RequestableObjectReference` + +NewRequestableObjectReferenceWithDefaults instantiates a new RequestableObjectReference 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 + +### GetId + +`func (o *RequestableObjectReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestableObjectReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestableObjectReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestableObjectReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RequestableObjectReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestableObjectReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestableObjectReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestableObjectReference) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RequestableObjectReference) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RequestableObjectReference) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RequestableObjectReference) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RequestableObjectReference) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetType + +`func (o *RequestableObjectReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestableObjectReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestableObjectReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestableObjectReference) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestableObjectRequestStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestableObjectRequestStatus.md new file mode 100644 index 000000000..adb020940 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestableObjectRequestStatus.md @@ -0,0 +1,23 @@ +--- +id: beta-requestable-object-request-status +title: RequestableObjectRequestStatus +pagination_label: RequestableObjectRequestStatus +sidebar_label: RequestableObjectRequestStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObjectRequestStatus', 'BetaRequestableObjectRequestStatus'] +slug: /tools/sdk/go/beta/models/requestable-object-request-status +tags: ['SDK', 'Software Development Kit', 'RequestableObjectRequestStatus', 'BetaRequestableObjectRequestStatus'] +--- + +# RequestableObjectRequestStatus + +## Enum + + +* `AVAILABLE` (value: `"AVAILABLE"`) + +* `PENDING` (value: `"PENDING"`) + +* `ASSIGNED` (value: `"ASSIGNED"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestableObjectType.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestableObjectType.md new file mode 100644 index 000000000..4699c0b87 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestableObjectType.md @@ -0,0 +1,23 @@ +--- +id: beta-requestable-object-type +title: RequestableObjectType +pagination_label: RequestableObjectType +sidebar_label: RequestableObjectType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObjectType', 'BetaRequestableObjectType'] +slug: /tools/sdk/go/beta/models/requestable-object-type +tags: ['SDK', 'Software Development Kit', 'RequestableObjectType', 'BetaRequestableObjectType'] +--- + +# RequestableObjectType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestedAccountRef.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestedAccountRef.md new file mode 100644 index 000000000..8902d28ac --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestedAccountRef.md @@ -0,0 +1,188 @@ +--- +id: beta-requested-account-ref +title: RequestedAccountRef +pagination_label: RequestedAccountRef +sidebar_label: RequestedAccountRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedAccountRef', 'BetaRequestedAccountRef'] +slug: /tools/sdk/go/beta/models/requested-account-ref +tags: ['SDK', 'Software Development Kit', 'RequestedAccountRef', 'BetaRequestedAccountRef'] +--- + +# RequestedAccountRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Display name of the account for the user | [optional] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**AccountUuid** | Pointer to **NullableString** | The uuid for the account | [optional] +**AccountId** | Pointer to **NullableString** | The native identity for the account | [optional] +**SourceName** | Pointer to **string** | Display name of the source for the account | [optional] + +## Methods + +### NewRequestedAccountRef + +`func NewRequestedAccountRef() *RequestedAccountRef` + +NewRequestedAccountRef instantiates a new RequestedAccountRef 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 + +### NewRequestedAccountRefWithDefaults + +`func NewRequestedAccountRefWithDefaults() *RequestedAccountRef` + +NewRequestedAccountRefWithDefaults instantiates a new RequestedAccountRef 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 + +### GetName + +`func (o *RequestedAccountRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestedAccountRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestedAccountRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestedAccountRef) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *RequestedAccountRef) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedAccountRef) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedAccountRef) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedAccountRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetAccountUuid + +`func (o *RequestedAccountRef) GetAccountUuid() string` + +GetAccountUuid returns the AccountUuid field if non-nil, zero value otherwise. + +### GetAccountUuidOk + +`func (o *RequestedAccountRef) GetAccountUuidOk() (*string, bool)` + +GetAccountUuidOk returns a tuple with the AccountUuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountUuid + +`func (o *RequestedAccountRef) SetAccountUuid(v string)` + +SetAccountUuid sets AccountUuid field to given value. + +### HasAccountUuid + +`func (o *RequestedAccountRef) HasAccountUuid() bool` + +HasAccountUuid returns a boolean if a field has been set. + +### SetAccountUuidNil + +`func (o *RequestedAccountRef) SetAccountUuidNil(b bool)` + + SetAccountUuidNil sets the value for AccountUuid to be an explicit nil + +### UnsetAccountUuid +`func (o *RequestedAccountRef) UnsetAccountUuid()` + +UnsetAccountUuid ensures that no value is present for AccountUuid, not even an explicit nil +### GetAccountId + +`func (o *RequestedAccountRef) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *RequestedAccountRef) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *RequestedAccountRef) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *RequestedAccountRef) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountIdNil + +`func (o *RequestedAccountRef) SetAccountIdNil(b bool)` + + SetAccountIdNil sets the value for AccountId to be an explicit nil + +### UnsetAccountId +`func (o *RequestedAccountRef) UnsetAccountId()` + +UnsetAccountId ensures that no value is present for AccountId, not even an explicit nil +### GetSourceName + +`func (o *RequestedAccountRef) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *RequestedAccountRef) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *RequestedAccountRef) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *RequestedAccountRef) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestedForDtoRef.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..9c02e7060 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestedForDtoRef.md @@ -0,0 +1,80 @@ +--- +id: beta-requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedForDtoRef', 'BetaRequestedForDtoRef'] +slug: /tools/sdk/go/beta/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'BetaRequestedForDtoRef'] +--- + +# RequestedForDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **string** | The identity id for which the access is requested | +**RequestedItems** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | + +## Methods + +### NewRequestedForDtoRef + +`func NewRequestedForDtoRef(identityId string, requestedItems []RequestedItemDtoRef, ) *RequestedForDtoRef` + +NewRequestedForDtoRef instantiates a new RequestedForDtoRef 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 + +### NewRequestedForDtoRefWithDefaults + +`func NewRequestedForDtoRefWithDefaults() *RequestedForDtoRef` + +NewRequestedForDtoRefWithDefaults instantiates a new RequestedForDtoRef 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 + +### GetIdentityId + +`func (o *RequestedForDtoRef) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *RequestedForDtoRef) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *RequestedForDtoRef) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetRequestedItems + +`func (o *RequestedForDtoRef) GetRequestedItems() []RequestedItemDtoRef` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *RequestedForDtoRef) GetRequestedItemsOk() (*[]RequestedItemDtoRef, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *RequestedForDtoRef) SetRequestedItems(v []RequestedItemDtoRef)` + +SetRequestedItems sets RequestedItems field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemDetails.md new file mode 100644 index 000000000..1eb86e5c3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemDetails.md @@ -0,0 +1,90 @@ +--- +id: beta-requested-item-details +title: RequestedItemDetails +pagination_label: RequestedItemDetails +sidebar_label: RequestedItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemDetails', 'BetaRequestedItemDetails'] +slug: /tools/sdk/go/beta/models/requested-item-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemDetails', 'BetaRequestedItemDetails'] +--- + +# RequestedItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of access item requested. | [optional] +**Id** | Pointer to **string** | The id of the access item requested. | [optional] + +## Methods + +### NewRequestedItemDetails + +`func NewRequestedItemDetails() *RequestedItemDetails` + +NewRequestedItemDetails instantiates a new RequestedItemDetails 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 + +### NewRequestedItemDetailsWithDefaults + +`func NewRequestedItemDetailsWithDefaults() *RequestedItemDetails` + +NewRequestedItemDetailsWithDefaults instantiates a new RequestedItemDetails 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 + +### GetType + +`func (o *RequestedItemDetails) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemDetails) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemDetails) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedItemDetails) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RequestedItemDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestedItemDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemDtoRef.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..0a49d7769 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemDtoRef.md @@ -0,0 +1,266 @@ +--- +id: beta-requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemDtoRef', 'BetaRequestedItemDtoRef'] +slug: /tools/sdk/go/beta/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'BetaRequestedItemDtoRef'] +--- + +# RequestedItemDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of the item being requested. | +**Id** | **string** | ID of Role, Access Profile or Entitlement being requested. | +**Comment** | Pointer to **string** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | Pointer to **SailPointTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | Pointer to **NullableString** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | Pointer to **NullableString** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**AccountSelection** | Pointer to [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] + +## Methods + +### NewRequestedItemDtoRef + +`func NewRequestedItemDtoRef(type_ string, id string, ) *RequestedItemDtoRef` + +NewRequestedItemDtoRef instantiates a new RequestedItemDtoRef 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 + +### NewRequestedItemDtoRefWithDefaults + +`func NewRequestedItemDtoRefWithDefaults() *RequestedItemDtoRef` + +NewRequestedItemDtoRefWithDefaults instantiates a new RequestedItemDtoRef 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 + +### GetType + +`func (o *RequestedItemDtoRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemDtoRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemDtoRef) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *RequestedItemDtoRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemDtoRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemDtoRef) SetId(v string)` + +SetId sets Id field to given value. + + +### GetComment + +`func (o *RequestedItemDtoRef) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *RequestedItemDtoRef) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *RequestedItemDtoRef) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *RequestedItemDtoRef) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *RequestedItemDtoRef) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *RequestedItemDtoRef) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *RequestedItemDtoRef) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *RequestedItemDtoRef) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *RequestedItemDtoRef) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *RequestedItemDtoRef) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *RequestedItemDtoRef) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *RequestedItemDtoRef) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetAssignmentId + +`func (o *RequestedItemDtoRef) GetAssignmentId() string` + +GetAssignmentId returns the AssignmentId field if non-nil, zero value otherwise. + +### GetAssignmentIdOk + +`func (o *RequestedItemDtoRef) GetAssignmentIdOk() (*string, bool)` + +GetAssignmentIdOk returns a tuple with the AssignmentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentId + +`func (o *RequestedItemDtoRef) SetAssignmentId(v string)` + +SetAssignmentId sets AssignmentId field to given value. + +### HasAssignmentId + +`func (o *RequestedItemDtoRef) HasAssignmentId() bool` + +HasAssignmentId returns a boolean if a field has been set. + +### SetAssignmentIdNil + +`func (o *RequestedItemDtoRef) SetAssignmentIdNil(b bool)` + + SetAssignmentIdNil sets the value for AssignmentId to be an explicit nil + +### UnsetAssignmentId +`func (o *RequestedItemDtoRef) UnsetAssignmentId()` + +UnsetAssignmentId ensures that no value is present for AssignmentId, not even an explicit nil +### GetNativeIdentity + +`func (o *RequestedItemDtoRef) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *RequestedItemDtoRef) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *RequestedItemDtoRef) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *RequestedItemDtoRef) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### SetNativeIdentityNil + +`func (o *RequestedItemDtoRef) SetNativeIdentityNil(b bool)` + + SetNativeIdentityNil sets the value for NativeIdentity to be an explicit nil + +### UnsetNativeIdentity +`func (o *RequestedItemDtoRef) UnsetNativeIdentity()` + +UnsetNativeIdentity ensures that no value is present for NativeIdentity, not even an explicit nil +### GetAccountSelection + +`func (o *RequestedItemDtoRef) GetAccountSelection() []SourceItemRef` + +GetAccountSelection returns the AccountSelection field if non-nil, zero value otherwise. + +### GetAccountSelectionOk + +`func (o *RequestedItemDtoRef) GetAccountSelectionOk() (*[]SourceItemRef, bool)` + +GetAccountSelectionOk returns a tuple with the AccountSelection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSelection + +`func (o *RequestedItemDtoRef) SetAccountSelection(v []SourceItemRef)` + +SetAccountSelection sets AccountSelection field to given value. + +### HasAccountSelection + +`func (o *RequestedItemDtoRef) HasAccountSelection() bool` + +HasAccountSelection returns a boolean if a field has been set. + +### SetAccountSelectionNil + +`func (o *RequestedItemDtoRef) SetAccountSelectionNil(b bool)` + + SetAccountSelectionNil sets the value for AccountSelection to be an explicit nil + +### UnsetAccountSelection +`func (o *RequestedItemDtoRef) UnsetAccountSelection()` + +UnsetAccountSelection ensures that no value is present for AccountSelection, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatus.md new file mode 100644 index 000000000..190a52e01 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatus.md @@ -0,0 +1,834 @@ +--- +id: beta-requested-item-status +title: RequestedItemStatus +pagination_label: RequestedItemStatus +sidebar_label: RequestedItemStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatus', 'BetaRequestedItemStatus'] +slug: /tools/sdk/go/beta/models/requested-item-status +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'BetaRequestedItemStatus'] +--- + +# RequestedItemStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the access request. | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the item being requested. | [optional] +**Type** | Pointer to **NullableString** | Type of requested object. | [optional] +**CancelledRequestDetails** | Pointer to [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional] +**ErrorMessages** | Pointer to [**[][]ErrorMessageDto**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional] +**State** | Pointer to [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional] +**ApprovalDetails** | Pointer to [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional] +**ApprovalIds** | Pointer to **[]string** | List of approval IDs associated with the request. | [optional] +**ManualWorkItemDetails** | Pointer to [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional] +**AccountActivityItemId** | Pointer to **string** | Id of associated account activity item. | [optional] +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**Modified** | Pointer to **NullableTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**RequesterComment** | Pointer to [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional] +**SodViolationContext** | Pointer to [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional] +**ProvisioningDetails** | Pointer to [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional] +**PreApprovalTriggerDetails** | Pointer to [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional] +**AccessRequestPhases** | Pointer to [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional] +**Description** | Pointer to **NullableString** | Description associated to the requested object. | [optional] +**RemoveDate** | Pointer to **NullableTime** | When the role access is scheduled for removal. | [optional] +**Cancelable** | Pointer to **bool** | True if the request can be canceled. | [optional] [default to false] +**AccessRequestId** | Pointer to **string** | This is the account activity id. | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] +**RequestedAccounts** | Pointer to [**[]RequestedAccountRef**](requested-account-ref) | The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. | [optional] + +## Methods + +### NewRequestedItemStatus + +`func NewRequestedItemStatus() *RequestedItemStatus` + +NewRequestedItemStatus instantiates a new RequestedItemStatus 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 + +### NewRequestedItemStatusWithDefaults + +`func NewRequestedItemStatusWithDefaults() *RequestedItemStatus` + +NewRequestedItemStatusWithDefaults instantiates a new RequestedItemStatus 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 + +### GetId + +`func (o *RequestedItemStatus) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemStatus) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemStatus) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestedItemStatus) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RequestedItemStatus) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestedItemStatus) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestedItemStatus) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestedItemStatus) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RequestedItemStatus) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RequestedItemStatus) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetType + +`func (o *RequestedItemStatus) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemStatus) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemStatus) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedItemStatus) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *RequestedItemStatus) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *RequestedItemStatus) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetCancelledRequestDetails + +`func (o *RequestedItemStatus) GetCancelledRequestDetails() RequestedItemStatusCancelledRequestDetails` + +GetCancelledRequestDetails returns the CancelledRequestDetails field if non-nil, zero value otherwise. + +### GetCancelledRequestDetailsOk + +`func (o *RequestedItemStatus) GetCancelledRequestDetailsOk() (*RequestedItemStatusCancelledRequestDetails, bool)` + +GetCancelledRequestDetailsOk returns a tuple with the CancelledRequestDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCancelledRequestDetails + +`func (o *RequestedItemStatus) SetCancelledRequestDetails(v RequestedItemStatusCancelledRequestDetails)` + +SetCancelledRequestDetails sets CancelledRequestDetails field to given value. + +### HasCancelledRequestDetails + +`func (o *RequestedItemStatus) HasCancelledRequestDetails() bool` + +HasCancelledRequestDetails returns a boolean if a field has been set. + +### GetErrorMessages + +`func (o *RequestedItemStatus) GetErrorMessages() [][]ErrorMessageDto` + +GetErrorMessages returns the ErrorMessages field if non-nil, zero value otherwise. + +### GetErrorMessagesOk + +`func (o *RequestedItemStatus) GetErrorMessagesOk() (*[][]ErrorMessageDto, bool)` + +GetErrorMessagesOk returns a tuple with the ErrorMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessages + +`func (o *RequestedItemStatus) SetErrorMessages(v [][]ErrorMessageDto)` + +SetErrorMessages sets ErrorMessages field to given value. + +### HasErrorMessages + +`func (o *RequestedItemStatus) HasErrorMessages() bool` + +HasErrorMessages returns a boolean if a field has been set. + +### SetErrorMessagesNil + +`func (o *RequestedItemStatus) SetErrorMessagesNil(b bool)` + + SetErrorMessagesNil sets the value for ErrorMessages to be an explicit nil + +### UnsetErrorMessages +`func (o *RequestedItemStatus) UnsetErrorMessages()` + +UnsetErrorMessages ensures that no value is present for ErrorMessages, not even an explicit nil +### GetState + +`func (o *RequestedItemStatus) GetState() RequestedItemStatusRequestState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *RequestedItemStatus) GetStateOk() (*RequestedItemStatusRequestState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *RequestedItemStatus) SetState(v RequestedItemStatusRequestState)` + +SetState sets State field to given value. + +### HasState + +`func (o *RequestedItemStatus) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetApprovalDetails + +`func (o *RequestedItemStatus) GetApprovalDetails() []ApprovalStatusDto` + +GetApprovalDetails returns the ApprovalDetails field if non-nil, zero value otherwise. + +### GetApprovalDetailsOk + +`func (o *RequestedItemStatus) GetApprovalDetailsOk() (*[]ApprovalStatusDto, bool)` + +GetApprovalDetailsOk returns a tuple with the ApprovalDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalDetails + +`func (o *RequestedItemStatus) SetApprovalDetails(v []ApprovalStatusDto)` + +SetApprovalDetails sets ApprovalDetails field to given value. + +### HasApprovalDetails + +`func (o *RequestedItemStatus) HasApprovalDetails() bool` + +HasApprovalDetails returns a boolean if a field has been set. + +### GetApprovalIds + +`func (o *RequestedItemStatus) GetApprovalIds() []string` + +GetApprovalIds returns the ApprovalIds field if non-nil, zero value otherwise. + +### GetApprovalIdsOk + +`func (o *RequestedItemStatus) GetApprovalIdsOk() (*[]string, bool)` + +GetApprovalIdsOk returns a tuple with the ApprovalIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalIds + +`func (o *RequestedItemStatus) SetApprovalIds(v []string)` + +SetApprovalIds sets ApprovalIds field to given value. + +### HasApprovalIds + +`func (o *RequestedItemStatus) HasApprovalIds() bool` + +HasApprovalIds returns a boolean if a field has been set. + +### SetApprovalIdsNil + +`func (o *RequestedItemStatus) SetApprovalIdsNil(b bool)` + + SetApprovalIdsNil sets the value for ApprovalIds to be an explicit nil + +### UnsetApprovalIds +`func (o *RequestedItemStatus) UnsetApprovalIds()` + +UnsetApprovalIds ensures that no value is present for ApprovalIds, not even an explicit nil +### GetManualWorkItemDetails + +`func (o *RequestedItemStatus) GetManualWorkItemDetails() []ManualWorkItemDetails` + +GetManualWorkItemDetails returns the ManualWorkItemDetails field if non-nil, zero value otherwise. + +### GetManualWorkItemDetailsOk + +`func (o *RequestedItemStatus) GetManualWorkItemDetailsOk() (*[]ManualWorkItemDetails, bool)` + +GetManualWorkItemDetailsOk returns a tuple with the ManualWorkItemDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManualWorkItemDetails + +`func (o *RequestedItemStatus) SetManualWorkItemDetails(v []ManualWorkItemDetails)` + +SetManualWorkItemDetails sets ManualWorkItemDetails field to given value. + +### HasManualWorkItemDetails + +`func (o *RequestedItemStatus) HasManualWorkItemDetails() bool` + +HasManualWorkItemDetails returns a boolean if a field has been set. + +### SetManualWorkItemDetailsNil + +`func (o *RequestedItemStatus) SetManualWorkItemDetailsNil(b bool)` + + SetManualWorkItemDetailsNil sets the value for ManualWorkItemDetails to be an explicit nil + +### UnsetManualWorkItemDetails +`func (o *RequestedItemStatus) UnsetManualWorkItemDetails()` + +UnsetManualWorkItemDetails ensures that no value is present for ManualWorkItemDetails, not even an explicit nil +### GetAccountActivityItemId + +`func (o *RequestedItemStatus) GetAccountActivityItemId() string` + +GetAccountActivityItemId returns the AccountActivityItemId field if non-nil, zero value otherwise. + +### GetAccountActivityItemIdOk + +`func (o *RequestedItemStatus) GetAccountActivityItemIdOk() (*string, bool)` + +GetAccountActivityItemIdOk returns a tuple with the AccountActivityItemId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActivityItemId + +`func (o *RequestedItemStatus) SetAccountActivityItemId(v string)` + +SetAccountActivityItemId sets AccountActivityItemId field to given value. + +### HasAccountActivityItemId + +`func (o *RequestedItemStatus) HasAccountActivityItemId() bool` + +HasAccountActivityItemId returns a boolean if a field has been set. + +### GetRequestType + +`func (o *RequestedItemStatus) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *RequestedItemStatus) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *RequestedItemStatus) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *RequestedItemStatus) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *RequestedItemStatus) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *RequestedItemStatus) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetModified + +`func (o *RequestedItemStatus) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RequestedItemStatus) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RequestedItemStatus) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RequestedItemStatus) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *RequestedItemStatus) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *RequestedItemStatus) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetCreated + +`func (o *RequestedItemStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RequestedItemStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RequestedItemStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RequestedItemStatus) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetRequester + +`func (o *RequestedItemStatus) GetRequester() AccessItemRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *RequestedItemStatus) GetRequesterOk() (*AccessItemRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *RequestedItemStatus) SetRequester(v AccessItemRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *RequestedItemStatus) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRequestedFor + +`func (o *RequestedItemStatus) GetRequestedFor() RequestedItemStatusRequestedFor` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *RequestedItemStatus) GetRequestedForOk() (*RequestedItemStatusRequestedFor, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *RequestedItemStatus) SetRequestedFor(v RequestedItemStatusRequestedFor)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *RequestedItemStatus) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *RequestedItemStatus) GetRequesterComment() RequestedItemStatusRequesterComment` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *RequestedItemStatus) GetRequesterCommentOk() (*RequestedItemStatusRequesterComment, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *RequestedItemStatus) SetRequesterComment(v RequestedItemStatusRequesterComment)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *RequestedItemStatus) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### GetSodViolationContext + +`func (o *RequestedItemStatus) GetSodViolationContext() RequestedItemStatusSodViolationContext` + +GetSodViolationContext returns the SodViolationContext field if non-nil, zero value otherwise. + +### GetSodViolationContextOk + +`func (o *RequestedItemStatus) GetSodViolationContextOk() (*RequestedItemStatusSodViolationContext, bool)` + +GetSodViolationContextOk returns a tuple with the SodViolationContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodViolationContext + +`func (o *RequestedItemStatus) SetSodViolationContext(v RequestedItemStatusSodViolationContext)` + +SetSodViolationContext sets SodViolationContext field to given value. + +### HasSodViolationContext + +`func (o *RequestedItemStatus) HasSodViolationContext() bool` + +HasSodViolationContext returns a boolean if a field has been set. + +### GetProvisioningDetails + +`func (o *RequestedItemStatus) GetProvisioningDetails() RequestedItemStatusProvisioningDetails` + +GetProvisioningDetails returns the ProvisioningDetails field if non-nil, zero value otherwise. + +### GetProvisioningDetailsOk + +`func (o *RequestedItemStatus) GetProvisioningDetailsOk() (*RequestedItemStatusProvisioningDetails, bool)` + +GetProvisioningDetailsOk returns a tuple with the ProvisioningDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningDetails + +`func (o *RequestedItemStatus) SetProvisioningDetails(v RequestedItemStatusProvisioningDetails)` + +SetProvisioningDetails sets ProvisioningDetails field to given value. + +### HasProvisioningDetails + +`func (o *RequestedItemStatus) HasProvisioningDetails() bool` + +HasProvisioningDetails returns a boolean if a field has been set. + +### GetPreApprovalTriggerDetails + +`func (o *RequestedItemStatus) GetPreApprovalTriggerDetails() RequestedItemStatusPreApprovalTriggerDetails` + +GetPreApprovalTriggerDetails returns the PreApprovalTriggerDetails field if non-nil, zero value otherwise. + +### GetPreApprovalTriggerDetailsOk + +`func (o *RequestedItemStatus) GetPreApprovalTriggerDetailsOk() (*RequestedItemStatusPreApprovalTriggerDetails, bool)` + +GetPreApprovalTriggerDetailsOk returns a tuple with the PreApprovalTriggerDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreApprovalTriggerDetails + +`func (o *RequestedItemStatus) SetPreApprovalTriggerDetails(v RequestedItemStatusPreApprovalTriggerDetails)` + +SetPreApprovalTriggerDetails sets PreApprovalTriggerDetails field to given value. + +### HasPreApprovalTriggerDetails + +`func (o *RequestedItemStatus) HasPreApprovalTriggerDetails() bool` + +HasPreApprovalTriggerDetails returns a boolean if a field has been set. + +### GetAccessRequestPhases + +`func (o *RequestedItemStatus) GetAccessRequestPhases() []AccessRequestPhases` + +GetAccessRequestPhases returns the AccessRequestPhases field if non-nil, zero value otherwise. + +### GetAccessRequestPhasesOk + +`func (o *RequestedItemStatus) GetAccessRequestPhasesOk() (*[]AccessRequestPhases, bool)` + +GetAccessRequestPhasesOk returns a tuple with the AccessRequestPhases field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestPhases + +`func (o *RequestedItemStatus) SetAccessRequestPhases(v []AccessRequestPhases)` + +SetAccessRequestPhases sets AccessRequestPhases field to given value. + +### HasAccessRequestPhases + +`func (o *RequestedItemStatus) HasAccessRequestPhases() bool` + +HasAccessRequestPhases returns a boolean if a field has been set. + +### SetAccessRequestPhasesNil + +`func (o *RequestedItemStatus) SetAccessRequestPhasesNil(b bool)` + + SetAccessRequestPhasesNil sets the value for AccessRequestPhases to be an explicit nil + +### UnsetAccessRequestPhases +`func (o *RequestedItemStatus) UnsetAccessRequestPhases()` + +UnsetAccessRequestPhases ensures that no value is present for AccessRequestPhases, not even an explicit nil +### GetDescription + +`func (o *RequestedItemStatus) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RequestedItemStatus) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RequestedItemStatus) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RequestedItemStatus) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RequestedItemStatus) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RequestedItemStatus) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetRemoveDate + +`func (o *RequestedItemStatus) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *RequestedItemStatus) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *RequestedItemStatus) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *RequestedItemStatus) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *RequestedItemStatus) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *RequestedItemStatus) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil +### GetCancelable + +`func (o *RequestedItemStatus) GetCancelable() bool` + +GetCancelable returns the Cancelable field if non-nil, zero value otherwise. + +### GetCancelableOk + +`func (o *RequestedItemStatus) GetCancelableOk() (*bool, bool)` + +GetCancelableOk returns a tuple with the Cancelable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCancelable + +`func (o *RequestedItemStatus) SetCancelable(v bool)` + +SetCancelable sets Cancelable field to given value. + +### HasCancelable + +`func (o *RequestedItemStatus) HasCancelable() bool` + +HasCancelable returns a boolean if a field has been set. + +### GetAccessRequestId + +`func (o *RequestedItemStatus) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *RequestedItemStatus) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *RequestedItemStatus) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + +### HasAccessRequestId + +`func (o *RequestedItemStatus) HasAccessRequestId() bool` + +HasAccessRequestId returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *RequestedItemStatus) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *RequestedItemStatus) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *RequestedItemStatus) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *RequestedItemStatus) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *RequestedItemStatus) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *RequestedItemStatus) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetRequestedAccounts + +`func (o *RequestedItemStatus) GetRequestedAccounts() []RequestedAccountRef` + +GetRequestedAccounts returns the RequestedAccounts field if non-nil, zero value otherwise. + +### GetRequestedAccountsOk + +`func (o *RequestedItemStatus) GetRequestedAccountsOk() (*[]RequestedAccountRef, bool)` + +GetRequestedAccountsOk returns a tuple with the RequestedAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedAccounts + +`func (o *RequestedItemStatus) SetRequestedAccounts(v []RequestedAccountRef)` + +SetRequestedAccounts sets RequestedAccounts field to given value. + +### HasRequestedAccounts + +`func (o *RequestedItemStatus) HasRequestedAccounts() bool` + +HasRequestedAccounts returns a boolean if a field has been set. + +### SetRequestedAccountsNil + +`func (o *RequestedItemStatus) SetRequestedAccountsNil(b bool)` + + SetRequestedAccountsNil sets the value for RequestedAccounts to be an explicit nil + +### UnsetRequestedAccounts +`func (o *RequestedItemStatus) UnsetRequestedAccounts()` + +UnsetRequestedAccounts ensures that no value is present for RequestedAccounts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusCancelledRequestDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusCancelledRequestDetails.md new file mode 100644 index 000000000..643a5953a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusCancelledRequestDetails.md @@ -0,0 +1,116 @@ +--- +id: beta-requested-item-status-cancelled-request-details +title: RequestedItemStatusCancelledRequestDetails +pagination_label: RequestedItemStatusCancelledRequestDetails +sidebar_label: RequestedItemStatusCancelledRequestDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusCancelledRequestDetails', 'BetaRequestedItemStatusCancelledRequestDetails'] +slug: /tools/sdk/go/beta/models/requested-item-status-cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusCancelledRequestDetails', 'BetaRequestedItemStatusCancelledRequestDetails'] +--- + +# RequestedItemStatusCancelledRequestDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment made by the owner when cancelling the associated request. | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Modified** | Pointer to **SailPointTime** | Date comment was added by the owner when cancelling the associated request. | [optional] + +## Methods + +### NewRequestedItemStatusCancelledRequestDetails + +`func NewRequestedItemStatusCancelledRequestDetails() *RequestedItemStatusCancelledRequestDetails` + +NewRequestedItemStatusCancelledRequestDetails instantiates a new RequestedItemStatusCancelledRequestDetails 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 + +### NewRequestedItemStatusCancelledRequestDetailsWithDefaults + +`func NewRequestedItemStatusCancelledRequestDetailsWithDefaults() *RequestedItemStatusCancelledRequestDetails` + +NewRequestedItemStatusCancelledRequestDetailsWithDefaults instantiates a new RequestedItemStatusCancelledRequestDetails 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 + +### GetComment + +`func (o *RequestedItemStatusCancelledRequestDetails) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *RequestedItemStatusCancelledRequestDetails) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *RequestedItemStatusCancelledRequestDetails) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *RequestedItemStatusCancelledRequestDetails) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetOwner + +`func (o *RequestedItemStatusCancelledRequestDetails) GetOwner() OwnerDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *RequestedItemStatusCancelledRequestDetails) GetOwnerOk() (*OwnerDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *RequestedItemStatusCancelledRequestDetails) SetOwner(v OwnerDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *RequestedItemStatusCancelledRequestDetails) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetModified + +`func (o *RequestedItemStatusCancelledRequestDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RequestedItemStatusCancelledRequestDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RequestedItemStatusCancelledRequestDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RequestedItemStatusCancelledRequestDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusPreApprovalTriggerDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusPreApprovalTriggerDetails.md new file mode 100644 index 000000000..f118d69c8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusPreApprovalTriggerDetails.md @@ -0,0 +1,116 @@ +--- +id: beta-requested-item-status-pre-approval-trigger-details +title: RequestedItemStatusPreApprovalTriggerDetails +pagination_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusPreApprovalTriggerDetails', 'BetaRequestedItemStatusPreApprovalTriggerDetails'] +slug: /tools/sdk/go/beta/models/requested-item-status-pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusPreApprovalTriggerDetails', 'BetaRequestedItemStatusPreApprovalTriggerDetails'] +--- + +# RequestedItemStatusPreApprovalTriggerDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment left for the pre-approval decision | [optional] +**Reviewer** | Pointer to **string** | The reviewer of the pre-approval decision | [optional] +**Decision** | Pointer to **string** | The decision of the pre-approval trigger | [optional] + +## Methods + +### NewRequestedItemStatusPreApprovalTriggerDetails + +`func NewRequestedItemStatusPreApprovalTriggerDetails() *RequestedItemStatusPreApprovalTriggerDetails` + +NewRequestedItemStatusPreApprovalTriggerDetails instantiates a new RequestedItemStatusPreApprovalTriggerDetails 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 + +### NewRequestedItemStatusPreApprovalTriggerDetailsWithDefaults + +`func NewRequestedItemStatusPreApprovalTriggerDetailsWithDefaults() *RequestedItemStatusPreApprovalTriggerDetails` + +NewRequestedItemStatusPreApprovalTriggerDetailsWithDefaults instantiates a new RequestedItemStatusPreApprovalTriggerDetails 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 + +### GetComment + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetReviewer + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetReviewer() string` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetReviewerOk() (*string, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) SetReviewer(v string)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetDecision + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetDecision() string` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetDecisionOk() (*string, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) SetDecision(v string)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusProvisioningDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusProvisioningDetails.md new file mode 100644 index 000000000..5b25588a6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusProvisioningDetails.md @@ -0,0 +1,64 @@ +--- +id: beta-requested-item-status-provisioning-details +title: RequestedItemStatusProvisioningDetails +pagination_label: RequestedItemStatusProvisioningDetails +sidebar_label: RequestedItemStatusProvisioningDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusProvisioningDetails', 'BetaRequestedItemStatusProvisioningDetails'] +slug: /tools/sdk/go/beta/models/requested-item-status-provisioning-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusProvisioningDetails', 'BetaRequestedItemStatusProvisioningDetails'] +--- + +# RequestedItemStatusProvisioningDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrderedSubPhaseReferences** | Pointer to **string** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. | [optional] + +## Methods + +### NewRequestedItemStatusProvisioningDetails + +`func NewRequestedItemStatusProvisioningDetails() *RequestedItemStatusProvisioningDetails` + +NewRequestedItemStatusProvisioningDetails instantiates a new RequestedItemStatusProvisioningDetails 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 + +### NewRequestedItemStatusProvisioningDetailsWithDefaults + +`func NewRequestedItemStatusProvisioningDetailsWithDefaults() *RequestedItemStatusProvisioningDetails` + +NewRequestedItemStatusProvisioningDetailsWithDefaults instantiates a new RequestedItemStatusProvisioningDetails 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 + +### GetOrderedSubPhaseReferences + +`func (o *RequestedItemStatusProvisioningDetails) GetOrderedSubPhaseReferences() string` + +GetOrderedSubPhaseReferences returns the OrderedSubPhaseReferences field if non-nil, zero value otherwise. + +### GetOrderedSubPhaseReferencesOk + +`func (o *RequestedItemStatusProvisioningDetails) GetOrderedSubPhaseReferencesOk() (*string, bool)` + +GetOrderedSubPhaseReferencesOk returns a tuple with the OrderedSubPhaseReferences field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderedSubPhaseReferences + +`func (o *RequestedItemStatusProvisioningDetails) SetOrderedSubPhaseReferences(v string)` + +SetOrderedSubPhaseReferences sets OrderedSubPhaseReferences field to given value. + +### HasOrderedSubPhaseReferences + +`func (o *RequestedItemStatusProvisioningDetails) HasOrderedSubPhaseReferences() bool` + +HasOrderedSubPhaseReferences returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusRequestState.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusRequestState.md new file mode 100644 index 000000000..3db2c30f3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusRequestState.md @@ -0,0 +1,35 @@ +--- +id: beta-requested-item-status-request-state +title: RequestedItemStatusRequestState +pagination_label: RequestedItemStatusRequestState +sidebar_label: RequestedItemStatusRequestState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusRequestState', 'BetaRequestedItemStatusRequestState'] +slug: /tools/sdk/go/beta/models/requested-item-status-request-state +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestState', 'BetaRequestedItemStatusRequestState'] +--- + +# RequestedItemStatusRequestState + +## Enum + + +* `EXECUTING` (value: `"EXECUTING"`) + +* `REQUEST_COMPLETED` (value: `"REQUEST_COMPLETED"`) + +* `CANCELLED` (value: `"CANCELLED"`) + +* `TERMINATED` (value: `"TERMINATED"`) + +* `PROVISIONING_VERIFICATION_PENDING` (value: `"PROVISIONING_VERIFICATION_PENDING"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `PROVISIONING_FAILED` (value: `"PROVISIONING_FAILED"`) + +* `NOT_ALL_ITEMS_PROVISIONED` (value: `"NOT_ALL_ITEMS_PROVISIONED"`) + +* `ERROR` (value: `"ERROR"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusRequestedFor.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusRequestedFor.md new file mode 100644 index 000000000..325271d2f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusRequestedFor.md @@ -0,0 +1,116 @@ +--- +id: beta-requested-item-status-requested-for +title: RequestedItemStatusRequestedFor +pagination_label: RequestedItemStatusRequestedFor +sidebar_label: RequestedItemStatusRequestedFor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusRequestedFor', 'BetaRequestedItemStatusRequestedFor'] +slug: /tools/sdk/go/beta/models/requested-item-status-requested-for +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestedFor', 'BetaRequestedItemStatusRequestedFor'] +--- + +# RequestedItemStatusRequestedFor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the object to which this reference applies | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewRequestedItemStatusRequestedFor + +`func NewRequestedItemStatusRequestedFor() *RequestedItemStatusRequestedFor` + +NewRequestedItemStatusRequestedFor instantiates a new RequestedItemStatusRequestedFor 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 + +### NewRequestedItemStatusRequestedForWithDefaults + +`func NewRequestedItemStatusRequestedForWithDefaults() *RequestedItemStatusRequestedFor` + +NewRequestedItemStatusRequestedForWithDefaults instantiates a new RequestedItemStatusRequestedFor 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 + +### GetType + +`func (o *RequestedItemStatusRequestedFor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemStatusRequestedFor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemStatusRequestedFor) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedItemStatusRequestedFor) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RequestedItemStatusRequestedFor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemStatusRequestedFor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemStatusRequestedFor) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestedItemStatusRequestedFor) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RequestedItemStatusRequestedFor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestedItemStatusRequestedFor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestedItemStatusRequestedFor) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestedItemStatusRequestedFor) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusRequesterComment.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusRequesterComment.md new file mode 100644 index 000000000..c653caf20 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusRequesterComment.md @@ -0,0 +1,126 @@ +--- +id: beta-requested-item-status-requester-comment +title: RequestedItemStatusRequesterComment +pagination_label: RequestedItemStatusRequesterComment +sidebar_label: RequestedItemStatusRequesterComment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusRequesterComment', 'BetaRequestedItemStatusRequesterComment'] +slug: /tools/sdk/go/beta/models/requested-item-status-requester-comment +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequesterComment', 'BetaRequestedItemStatusRequesterComment'] +--- + +# RequestedItemStatusRequesterComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **NullableString** | Comment content. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDto1Author**](comment-dto1-author) | | [optional] + +## Methods + +### NewRequestedItemStatusRequesterComment + +`func NewRequestedItemStatusRequesterComment() *RequestedItemStatusRequesterComment` + +NewRequestedItemStatusRequesterComment instantiates a new RequestedItemStatusRequesterComment 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 + +### NewRequestedItemStatusRequesterCommentWithDefaults + +`func NewRequestedItemStatusRequesterCommentWithDefaults() *RequestedItemStatusRequesterComment` + +NewRequestedItemStatusRequesterCommentWithDefaults instantiates a new RequestedItemStatusRequesterComment 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 + +### GetComment + +`func (o *RequestedItemStatusRequesterComment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *RequestedItemStatusRequesterComment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *RequestedItemStatusRequesterComment) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *RequestedItemStatusRequesterComment) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *RequestedItemStatusRequesterComment) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *RequestedItemStatusRequesterComment) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetCreated + +`func (o *RequestedItemStatusRequesterComment) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RequestedItemStatusRequesterComment) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RequestedItemStatusRequesterComment) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RequestedItemStatusRequesterComment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetAuthor + +`func (o *RequestedItemStatusRequesterComment) GetAuthor() CommentDto1Author` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *RequestedItemStatusRequesterComment) GetAuthorOk() (*CommentDto1Author, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *RequestedItemStatusRequesterComment) SetAuthor(v CommentDto1Author)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *RequestedItemStatusRequesterComment) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusSodViolationContext.md b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusSodViolationContext.md new file mode 100644 index 000000000..90ff40917 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RequestedItemStatusSodViolationContext.md @@ -0,0 +1,136 @@ +--- +id: beta-requested-item-status-sod-violation-context +title: RequestedItemStatusSodViolationContext +pagination_label: RequestedItemStatusSodViolationContext +sidebar_label: RequestedItemStatusSodViolationContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusSodViolationContext', 'BetaRequestedItemStatusSodViolationContext'] +slug: /tools/sdk/go/beta/models/requested-item-status-sod-violation-context +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusSodViolationContext', 'BetaRequestedItemStatusSodViolationContext'] +--- + +# RequestedItemStatusSodViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **NullableString** | The status of SOD violation check | [optional] +**Uuid** | Pointer to **NullableString** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] + +## Methods + +### NewRequestedItemStatusSodViolationContext + +`func NewRequestedItemStatusSodViolationContext() *RequestedItemStatusSodViolationContext` + +NewRequestedItemStatusSodViolationContext instantiates a new RequestedItemStatusSodViolationContext 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 + +### NewRequestedItemStatusSodViolationContextWithDefaults + +`func NewRequestedItemStatusSodViolationContextWithDefaults() *RequestedItemStatusSodViolationContext` + +NewRequestedItemStatusSodViolationContextWithDefaults instantiates a new RequestedItemStatusSodViolationContext 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 + +### GetState + +`func (o *RequestedItemStatusSodViolationContext) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *RequestedItemStatusSodViolationContext) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *RequestedItemStatusSodViolationContext) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *RequestedItemStatusSodViolationContext) HasState() bool` + +HasState returns a boolean if a field has been set. + +### SetStateNil + +`func (o *RequestedItemStatusSodViolationContext) SetStateNil(b bool)` + + SetStateNil sets the value for State to be an explicit nil + +### UnsetState +`func (o *RequestedItemStatusSodViolationContext) UnsetState()` + +UnsetState ensures that no value is present for State, not even an explicit nil +### GetUuid + +`func (o *RequestedItemStatusSodViolationContext) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *RequestedItemStatusSodViolationContext) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *RequestedItemStatusSodViolationContext) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *RequestedItemStatusSodViolationContext) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *RequestedItemStatusSodViolationContext) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *RequestedItemStatusSodViolationContext) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetViolationCheckResult + +`func (o *RequestedItemStatusSodViolationContext) GetViolationCheckResult() SodViolationCheckResult` + +GetViolationCheckResult returns the ViolationCheckResult field if non-nil, zero value otherwise. + +### GetViolationCheckResultOk + +`func (o *RequestedItemStatusSodViolationContext) GetViolationCheckResultOk() (*SodViolationCheckResult, bool)` + +GetViolationCheckResultOk returns a tuple with the ViolationCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationCheckResult + +`func (o *RequestedItemStatusSodViolationContext) SetViolationCheckResult(v SodViolationCheckResult)` + +SetViolationCheckResult sets ViolationCheckResult field to given value. + +### HasViolationCheckResult + +`func (o *RequestedItemStatusSodViolationContext) HasViolationCheckResult() bool` + +HasViolationCheckResult returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ResourceBundleMessage.md b/docs/tools/sdk/go/Reference/Beta/Models/ResourceBundleMessage.md new file mode 100644 index 000000000..fb21670f3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ResourceBundleMessage.md @@ -0,0 +1,90 @@ +--- +id: beta-resource-bundle-message +title: ResourceBundleMessage +pagination_label: ResourceBundleMessage +sidebar_label: ResourceBundleMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ResourceBundleMessage', 'BetaResourceBundleMessage'] +slug: /tools/sdk/go/beta/models/resource-bundle-message +tags: ['SDK', 'Software Development Kit', 'ResourceBundleMessage', 'BetaResourceBundleMessage'] +--- + +# ResourceBundleMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The key of the message | [optional] +**Format** | Pointer to **string** | The format of the message | [optional] + +## Methods + +### NewResourceBundleMessage + +`func NewResourceBundleMessage() *ResourceBundleMessage` + +NewResourceBundleMessage instantiates a new ResourceBundleMessage 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 + +### NewResourceBundleMessageWithDefaults + +`func NewResourceBundleMessageWithDefaults() *ResourceBundleMessage` + +NewResourceBundleMessageWithDefaults instantiates a new ResourceBundleMessage 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 + +### GetKey + +`func (o *ResourceBundleMessage) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *ResourceBundleMessage) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *ResourceBundleMessage) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *ResourceBundleMessage) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetFormat + +`func (o *ResourceBundleMessage) GetFormat() string` + +GetFormat returns the Format field if non-nil, zero value otherwise. + +### GetFormatOk + +`func (o *ResourceBundleMessage) GetFormatOk() (*string, bool)` + +GetFormatOk returns a tuple with the Format field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormat + +`func (o *ResourceBundleMessage) SetFormat(v string)` + +SetFormat sets Format field to given value. + +### HasFormat + +`func (o *ResourceBundleMessage) HasFormat() bool` + +HasFormat returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ResourceObject.md b/docs/tools/sdk/go/Reference/Beta/Models/ResourceObject.md new file mode 100644 index 000000000..49f714698 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ResourceObject.md @@ -0,0 +1,376 @@ +--- +id: beta-resource-object +title: ResourceObject +pagination_label: ResourceObject +sidebar_label: ResourceObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ResourceObject', 'BetaResourceObject'] +slug: /tools/sdk/go/beta/models/resource-object +tags: ['SDK', 'Software Development Kit', 'ResourceObject', 'BetaResourceObject'] +--- + +# ResourceObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Instance** | Pointer to **string** | Identifier of the specific instance where this object resides. | [optional] [readonly] +**Identity** | Pointer to **string** | Native identity of the object in the Source. | [optional] [readonly] +**Uuid** | Pointer to **string** | Universal unique identifier of the object in the Source. | [optional] [readonly] +**PreviousIdentity** | Pointer to **string** | Native identity that the object has previously. | [optional] [readonly] +**Name** | Pointer to **string** | Display name for this object. | [optional] [readonly] +**ObjectType** | Pointer to **string** | Type of object. | [optional] [readonly] +**Incomplete** | Pointer to **bool** | A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. | [optional] [readonly] +**Incremental** | Pointer to **bool** | A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. | [optional] [readonly] +**Delete** | Pointer to **bool** | A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. | [optional] [readonly] +**Remove** | Pointer to **bool** | A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. | [optional] [readonly] +**Missing** | Pointer to **[]string** | A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain \"groups\". | [optional] [readonly] +**Attributes** | Pointer to **map[string]interface{}** | Attributes of this ResourceObject. | [optional] [readonly] +**FinalUpdate** | Pointer to **bool** | In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. | [optional] [readonly] + +## Methods + +### NewResourceObject + +`func NewResourceObject() *ResourceObject` + +NewResourceObject instantiates a new ResourceObject 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 + +### NewResourceObjectWithDefaults + +`func NewResourceObjectWithDefaults() *ResourceObject` + +NewResourceObjectWithDefaults instantiates a new ResourceObject 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 + +### GetInstance + +`func (o *ResourceObject) GetInstance() string` + +GetInstance returns the Instance field if non-nil, zero value otherwise. + +### GetInstanceOk + +`func (o *ResourceObject) GetInstanceOk() (*string, bool)` + +GetInstanceOk returns a tuple with the Instance field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstance + +`func (o *ResourceObject) SetInstance(v string)` + +SetInstance sets Instance field to given value. + +### HasInstance + +`func (o *ResourceObject) HasInstance() bool` + +HasInstance returns a boolean if a field has been set. + +### GetIdentity + +`func (o *ResourceObject) GetIdentity() string` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *ResourceObject) GetIdentityOk() (*string, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *ResourceObject) SetIdentity(v string)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *ResourceObject) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetUuid + +`func (o *ResourceObject) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *ResourceObject) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *ResourceObject) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *ResourceObject) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### GetPreviousIdentity + +`func (o *ResourceObject) GetPreviousIdentity() string` + +GetPreviousIdentity returns the PreviousIdentity field if non-nil, zero value otherwise. + +### GetPreviousIdentityOk + +`func (o *ResourceObject) GetPreviousIdentityOk() (*string, bool)` + +GetPreviousIdentityOk returns a tuple with the PreviousIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousIdentity + +`func (o *ResourceObject) SetPreviousIdentity(v string)` + +SetPreviousIdentity sets PreviousIdentity field to given value. + +### HasPreviousIdentity + +`func (o *ResourceObject) HasPreviousIdentity() bool` + +HasPreviousIdentity returns a boolean if a field has been set. + +### GetName + +`func (o *ResourceObject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ResourceObject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ResourceObject) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ResourceObject) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetObjectType + +`func (o *ResourceObject) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *ResourceObject) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *ResourceObject) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + +### HasObjectType + +`func (o *ResourceObject) HasObjectType() bool` + +HasObjectType returns a boolean if a field has been set. + +### GetIncomplete + +`func (o *ResourceObject) GetIncomplete() bool` + +GetIncomplete returns the Incomplete field if non-nil, zero value otherwise. + +### GetIncompleteOk + +`func (o *ResourceObject) GetIncompleteOk() (*bool, bool)` + +GetIncompleteOk returns a tuple with the Incomplete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncomplete + +`func (o *ResourceObject) SetIncomplete(v bool)` + +SetIncomplete sets Incomplete field to given value. + +### HasIncomplete + +`func (o *ResourceObject) HasIncomplete() bool` + +HasIncomplete returns a boolean if a field has been set. + +### GetIncremental + +`func (o *ResourceObject) GetIncremental() bool` + +GetIncremental returns the Incremental field if non-nil, zero value otherwise. + +### GetIncrementalOk + +`func (o *ResourceObject) GetIncrementalOk() (*bool, bool)` + +GetIncrementalOk returns a tuple with the Incremental field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncremental + +`func (o *ResourceObject) SetIncremental(v bool)` + +SetIncremental sets Incremental field to given value. + +### HasIncremental + +`func (o *ResourceObject) HasIncremental() bool` + +HasIncremental returns a boolean if a field has been set. + +### GetDelete + +`func (o *ResourceObject) GetDelete() bool` + +GetDelete returns the Delete field if non-nil, zero value otherwise. + +### GetDeleteOk + +`func (o *ResourceObject) GetDeleteOk() (*bool, bool)` + +GetDeleteOk returns a tuple with the Delete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelete + +`func (o *ResourceObject) SetDelete(v bool)` + +SetDelete sets Delete field to given value. + +### HasDelete + +`func (o *ResourceObject) HasDelete() bool` + +HasDelete returns a boolean if a field has been set. + +### GetRemove + +`func (o *ResourceObject) GetRemove() bool` + +GetRemove returns the Remove field if non-nil, zero value otherwise. + +### GetRemoveOk + +`func (o *ResourceObject) GetRemoveOk() (*bool, bool)` + +GetRemoveOk returns a tuple with the Remove field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemove + +`func (o *ResourceObject) SetRemove(v bool)` + +SetRemove sets Remove field to given value. + +### HasRemove + +`func (o *ResourceObject) HasRemove() bool` + +HasRemove returns a boolean if a field has been set. + +### GetMissing + +`func (o *ResourceObject) GetMissing() []string` + +GetMissing returns the Missing field if non-nil, zero value otherwise. + +### GetMissingOk + +`func (o *ResourceObject) GetMissingOk() (*[]string, bool)` + +GetMissingOk returns a tuple with the Missing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMissing + +`func (o *ResourceObject) SetMissing(v []string)` + +SetMissing sets Missing field to given value. + +### HasMissing + +`func (o *ResourceObject) HasMissing() bool` + +HasMissing returns a boolean if a field has been set. + +### GetAttributes + +`func (o *ResourceObject) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ResourceObject) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ResourceObject) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ResourceObject) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetFinalUpdate + +`func (o *ResourceObject) GetFinalUpdate() bool` + +GetFinalUpdate returns the FinalUpdate field if non-nil, zero value otherwise. + +### GetFinalUpdateOk + +`func (o *ResourceObject) GetFinalUpdateOk() (*bool, bool)` + +GetFinalUpdateOk returns a tuple with the FinalUpdate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFinalUpdate + +`func (o *ResourceObject) SetFinalUpdate(v bool)` + +SetFinalUpdate sets FinalUpdate field to given value. + +### HasFinalUpdate + +`func (o *ResourceObject) HasFinalUpdate() bool` + +HasFinalUpdate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ResourceObjectsRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/ResourceObjectsRequest.md new file mode 100644 index 000000000..5eaf91240 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ResourceObjectsRequest.md @@ -0,0 +1,90 @@ +--- +id: beta-resource-objects-request +title: ResourceObjectsRequest +pagination_label: ResourceObjectsRequest +sidebar_label: ResourceObjectsRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ResourceObjectsRequest', 'BetaResourceObjectsRequest'] +slug: /tools/sdk/go/beta/models/resource-objects-request +tags: ['SDK', 'Software Development Kit', 'ResourceObjectsRequest', 'BetaResourceObjectsRequest'] +--- + +# ResourceObjectsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectType** | Pointer to **string** | The type of resource objects to iterate over. | [optional] [default to "account"] +**MaxCount** | Pointer to **int32** | The maximum number of resource objects to iterate over and return. | [optional] [default to 25] + +## Methods + +### NewResourceObjectsRequest + +`func NewResourceObjectsRequest() *ResourceObjectsRequest` + +NewResourceObjectsRequest instantiates a new ResourceObjectsRequest 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 + +### NewResourceObjectsRequestWithDefaults + +`func NewResourceObjectsRequestWithDefaults() *ResourceObjectsRequest` + +NewResourceObjectsRequestWithDefaults instantiates a new ResourceObjectsRequest 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 + +### GetObjectType + +`func (o *ResourceObjectsRequest) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *ResourceObjectsRequest) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *ResourceObjectsRequest) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + +### HasObjectType + +`func (o *ResourceObjectsRequest) HasObjectType() bool` + +HasObjectType returns a boolean if a field has been set. + +### GetMaxCount + +`func (o *ResourceObjectsRequest) GetMaxCount() int32` + +GetMaxCount returns the MaxCount field if non-nil, zero value otherwise. + +### GetMaxCountOk + +`func (o *ResourceObjectsRequest) GetMaxCountOk() (*int32, bool)` + +GetMaxCountOk returns a tuple with the MaxCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxCount + +`func (o *ResourceObjectsRequest) SetMaxCount(v int32)` + +SetMaxCount sets MaxCount field to given value. + +### HasMaxCount + +`func (o *ResourceObjectsRequest) HasMaxCount() bool` + +HasMaxCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ResourceObjectsResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/ResourceObjectsResponse.md new file mode 100644 index 000000000..269017483 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ResourceObjectsResponse.md @@ -0,0 +1,168 @@ +--- +id: beta-resource-objects-response +title: ResourceObjectsResponse +pagination_label: ResourceObjectsResponse +sidebar_label: ResourceObjectsResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ResourceObjectsResponse', 'BetaResourceObjectsResponse'] +slug: /tools/sdk/go/beta/models/resource-objects-response +tags: ['SDK', 'Software Development Kit', 'ResourceObjectsResponse', 'BetaResourceObjectsResponse'] +--- + +# ResourceObjectsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the source | [optional] [readonly] +**Name** | Pointer to **string** | Name of the source | [optional] [readonly] +**ObjectCount** | Pointer to **int32** | The number of objects that were fetched by the connector. | [optional] [readonly] +**ElapsedMillis** | Pointer to **int32** | The number of milliseconds spent on the entire request. | [optional] [readonly] +**ResourceObjects** | Pointer to [**[]ResourceObject**](resource-object) | Fetched objects from the source connector. | [optional] [readonly] + +## Methods + +### NewResourceObjectsResponse + +`func NewResourceObjectsResponse() *ResourceObjectsResponse` + +NewResourceObjectsResponse instantiates a new ResourceObjectsResponse 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 + +### NewResourceObjectsResponseWithDefaults + +`func NewResourceObjectsResponseWithDefaults() *ResourceObjectsResponse` + +NewResourceObjectsResponseWithDefaults instantiates a new ResourceObjectsResponse 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 + +### GetId + +`func (o *ResourceObjectsResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ResourceObjectsResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ResourceObjectsResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ResourceObjectsResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ResourceObjectsResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ResourceObjectsResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ResourceObjectsResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ResourceObjectsResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetObjectCount + +`func (o *ResourceObjectsResponse) GetObjectCount() int32` + +GetObjectCount returns the ObjectCount field if non-nil, zero value otherwise. + +### GetObjectCountOk + +`func (o *ResourceObjectsResponse) GetObjectCountOk() (*int32, bool)` + +GetObjectCountOk returns a tuple with the ObjectCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectCount + +`func (o *ResourceObjectsResponse) SetObjectCount(v int32)` + +SetObjectCount sets ObjectCount field to given value. + +### HasObjectCount + +`func (o *ResourceObjectsResponse) HasObjectCount() bool` + +HasObjectCount returns a boolean if a field has been set. + +### GetElapsedMillis + +`func (o *ResourceObjectsResponse) GetElapsedMillis() int32` + +GetElapsedMillis returns the ElapsedMillis field if non-nil, zero value otherwise. + +### GetElapsedMillisOk + +`func (o *ResourceObjectsResponse) GetElapsedMillisOk() (*int32, bool)` + +GetElapsedMillisOk returns a tuple with the ElapsedMillis field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElapsedMillis + +`func (o *ResourceObjectsResponse) SetElapsedMillis(v int32)` + +SetElapsedMillis sets ElapsedMillis field to given value. + +### HasElapsedMillis + +`func (o *ResourceObjectsResponse) HasElapsedMillis() bool` + +HasElapsedMillis returns a boolean if a field has been set. + +### GetResourceObjects + +`func (o *ResourceObjectsResponse) GetResourceObjects() []ResourceObject` + +GetResourceObjects returns the ResourceObjects field if non-nil, zero value otherwise. + +### GetResourceObjectsOk + +`func (o *ResourceObjectsResponse) GetResourceObjectsOk() (*[]ResourceObject, bool)` + +GetResourceObjectsOk returns a tuple with the ResourceObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResourceObjects + +`func (o *ResourceObjectsResponse) SetResourceObjects(v []ResourceObject)` + +SetResourceObjects sets ResourceObjects field to given value. + +### HasResourceObjects + +`func (o *ResourceObjectsResponse) HasResourceObjects() bool` + +HasResourceObjects returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ReviewReassign.md b/docs/tools/sdk/go/Reference/Beta/Models/ReviewReassign.md new file mode 100644 index 000000000..616aab4a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ReviewReassign.md @@ -0,0 +1,101 @@ +--- +id: beta-review-reassign +title: ReviewReassign +pagination_label: ReviewReassign +sidebar_label: ReviewReassign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewReassign', 'BetaReviewReassign'] +slug: /tools/sdk/go/beta/models/review-reassign +tags: ['SDK', 'Software Development Kit', 'ReviewReassign', 'BetaReviewReassign'] +--- + +# ReviewReassign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Reassign** | [**[]ReassignReference**](reassign-reference) | | +**ReassignTo** | **string** | The ID of the identity to which the certification is reassigned | +**Reason** | **string** | The reason comment for why the reassign was made | + +## Methods + +### NewReviewReassign + +`func NewReviewReassign(reassign []ReassignReference, reassignTo string, reason string, ) *ReviewReassign` + +NewReviewReassign instantiates a new ReviewReassign 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 + +### NewReviewReassignWithDefaults + +`func NewReviewReassignWithDefaults() *ReviewReassign` + +NewReviewReassignWithDefaults instantiates a new ReviewReassign 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 + +### GetReassign + +`func (o *ReviewReassign) GetReassign() []ReassignReference` + +GetReassign returns the Reassign field if non-nil, zero value otherwise. + +### GetReassignOk + +`func (o *ReviewReassign) GetReassignOk() (*[]ReassignReference, bool)` + +GetReassignOk returns a tuple with the Reassign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassign + +`func (o *ReviewReassign) SetReassign(v []ReassignReference)` + +SetReassign sets Reassign field to given value. + + +### GetReassignTo + +`func (o *ReviewReassign) GetReassignTo() string` + +GetReassignTo returns the ReassignTo field if non-nil, zero value otherwise. + +### GetReassignToOk + +`func (o *ReviewReassign) GetReassignToOk() (*string, bool)` + +GetReassignToOk returns a tuple with the ReassignTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignTo + +`func (o *ReviewReassign) SetReassignTo(v string)` + +SetReassignTo sets ReassignTo field to given value. + + +### GetReason + +`func (o *ReviewReassign) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *ReviewReassign) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *ReviewReassign) SetReason(v string)` + +SetReason sets Reason field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Reviewer.md b/docs/tools/sdk/go/Reference/Beta/Models/Reviewer.md new file mode 100644 index 000000000..9522164f7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Reviewer.md @@ -0,0 +1,137 @@ +--- +id: beta-reviewer +title: Reviewer +pagination_label: Reviewer +sidebar_label: Reviewer +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Reviewer', 'BetaReviewer'] +slug: /tools/sdk/go/beta/models/reviewer +tags: ['SDK', 'Software Development Kit', 'Reviewer', 'BetaReviewer'] +--- + +# Reviewer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Reviewer's DTO type. | +**Id** | **string** | Reviewer's ID. | +**Name** | **string** | Reviewer's display name. | +**Email** | Pointer to **NullableString** | Reviewing identity's email. This is only applicable to reviewers of the `IDENTITY` type. | [optional] + +## Methods + +### NewReviewer + +`func NewReviewer(type_ string, id string, name string, ) *Reviewer` + +NewReviewer instantiates a new Reviewer 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 + +### NewReviewerWithDefaults + +`func NewReviewerWithDefaults() *Reviewer` + +NewReviewerWithDefaults instantiates a new Reviewer 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 + +### GetType + +`func (o *Reviewer) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Reviewer) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Reviewer) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *Reviewer) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Reviewer) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Reviewer) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *Reviewer) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Reviewer) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Reviewer) SetName(v string)` + +SetName sets Name field to given value. + + +### GetEmail + +`func (o *Reviewer) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *Reviewer) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *Reviewer) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *Reviewer) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### SetEmailNil + +`func (o *Reviewer) SetEmailNil(b bool)` + + SetEmailNil sets the value for Email to be an explicit nil + +### UnsetEmail +`func (o *Reviewer) UnsetEmail()` + +UnsetEmail ensures that no value is present for Email, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Revocability.md b/docs/tools/sdk/go/Reference/Beta/Models/Revocability.md new file mode 100644 index 000000000..43041a2d6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Revocability.md @@ -0,0 +1,74 @@ +--- +id: beta-revocability +title: Revocability +pagination_label: Revocability +sidebar_label: Revocability +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Revocability', 'BetaRevocability'] +slug: /tools/sdk/go/beta/models/revocability +tags: ['SDK', 'Software Development Kit', 'Revocability', 'BetaRevocability'] +--- + +# Revocability + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] + +## Methods + +### NewRevocability + +`func NewRevocability() *Revocability` + +NewRevocability instantiates a new Revocability 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 + +### NewRevocabilityWithDefaults + +`func NewRevocabilityWithDefaults() *Revocability` + +NewRevocabilityWithDefaults instantiates a new Revocability 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 + +### GetApprovalSchemes + +`func (o *Revocability) GetApprovalSchemes() []AccessProfileApprovalScheme` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *Revocability) GetApprovalSchemesOk() (*[]AccessProfileApprovalScheme, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *Revocability) SetApprovalSchemes(v []AccessProfileApprovalScheme)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *Revocability) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + +### SetApprovalSchemesNil + +`func (o *Revocability) SetApprovalSchemesNil(b bool)` + + SetApprovalSchemesNil sets the value for ApprovalSchemes to be an explicit nil + +### UnsetApprovalSchemes +`func (o *Revocability) UnsetApprovalSchemes()` + +UnsetApprovalSchemes ensures that no value is present for ApprovalSchemes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RevocabilityForRole.md b/docs/tools/sdk/go/Reference/Beta/Models/RevocabilityForRole.md new file mode 100644 index 000000000..b1831d9a4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RevocabilityForRole.md @@ -0,0 +1,136 @@ +--- +id: beta-revocability-for-role +title: RevocabilityForRole +pagination_label: RevocabilityForRole +sidebar_label: RevocabilityForRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RevocabilityForRole', 'BetaRevocabilityForRole'] +slug: /tools/sdk/go/beta/models/revocability-for-role +tags: ['SDK', 'Software Development Kit', 'RevocabilityForRole', 'BetaRevocabilityForRole'] +--- + +# RevocabilityForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **NullableBool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to false] +**DenialCommentsRequired** | Pointer to **NullableBool** | Whether an approver must provide comments when denying the request | [optional] [default to false] +**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the revocation request | [optional] + +## Methods + +### NewRevocabilityForRole + +`func NewRevocabilityForRole() *RevocabilityForRole` + +NewRevocabilityForRole instantiates a new RevocabilityForRole 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 + +### NewRevocabilityForRoleWithDefaults + +`func NewRevocabilityForRoleWithDefaults() *RevocabilityForRole` + +NewRevocabilityForRoleWithDefaults instantiates a new RevocabilityForRole 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 + +### GetCommentsRequired + +`func (o *RevocabilityForRole) GetCommentsRequired() bool` + +GetCommentsRequired returns the CommentsRequired field if non-nil, zero value otherwise. + +### GetCommentsRequiredOk + +`func (o *RevocabilityForRole) GetCommentsRequiredOk() (*bool, bool)` + +GetCommentsRequiredOk returns a tuple with the CommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentsRequired + +`func (o *RevocabilityForRole) SetCommentsRequired(v bool)` + +SetCommentsRequired sets CommentsRequired field to given value. + +### HasCommentsRequired + +`func (o *RevocabilityForRole) HasCommentsRequired() bool` + +HasCommentsRequired returns a boolean if a field has been set. + +### SetCommentsRequiredNil + +`func (o *RevocabilityForRole) SetCommentsRequiredNil(b bool)` + + SetCommentsRequiredNil sets the value for CommentsRequired to be an explicit nil + +### UnsetCommentsRequired +`func (o *RevocabilityForRole) UnsetCommentsRequired()` + +UnsetCommentsRequired ensures that no value is present for CommentsRequired, not even an explicit nil +### GetDenialCommentsRequired + +`func (o *RevocabilityForRole) GetDenialCommentsRequired() bool` + +GetDenialCommentsRequired returns the DenialCommentsRequired field if non-nil, zero value otherwise. + +### GetDenialCommentsRequiredOk + +`func (o *RevocabilityForRole) GetDenialCommentsRequiredOk() (*bool, bool)` + +GetDenialCommentsRequiredOk returns a tuple with the DenialCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenialCommentsRequired + +`func (o *RevocabilityForRole) SetDenialCommentsRequired(v bool)` + +SetDenialCommentsRequired sets DenialCommentsRequired field to given value. + +### HasDenialCommentsRequired + +`func (o *RevocabilityForRole) HasDenialCommentsRequired() bool` + +HasDenialCommentsRequired returns a boolean if a field has been set. + +### SetDenialCommentsRequiredNil + +`func (o *RevocabilityForRole) SetDenialCommentsRequiredNil(b bool)` + + SetDenialCommentsRequiredNil sets the value for DenialCommentsRequired to be an explicit nil + +### UnsetDenialCommentsRequired +`func (o *RevocabilityForRole) UnsetDenialCommentsRequired()` + +UnsetDenialCommentsRequired ensures that no value is present for DenialCommentsRequired, not even an explicit nil +### GetApprovalSchemes + +`func (o *RevocabilityForRole) GetApprovalSchemes() []ApprovalSchemeForRole` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *RevocabilityForRole) GetApprovalSchemesOk() (*[]ApprovalSchemeForRole, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *RevocabilityForRole) SetApprovalSchemes(v []ApprovalSchemeForRole)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *RevocabilityForRole) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Role.md b/docs/tools/sdk/go/Reference/Beta/Models/Role.md new file mode 100644 index 000000000..c424afbd7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Role.md @@ -0,0 +1,566 @@ +--- +id: beta-role +title: Role +pagination_label: Role +sidebar_label: Role +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Role', 'BetaRole'] +slug: /tools/sdk/go/beta/models/role +tags: ['SDK', 'Software Development Kit', 'Role', 'BetaRole'] +--- + +# Role + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. | [optional] +**Name** | **string** | The human-readable display name of the Role | +**Created** | Pointer to **SailPointTime** | Date the Role was created | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Date the Role was last modified. | [optional] [readonly] +**Description** | Pointer to **NullableString** | A human-readable description of the Role | [optional] +**Owner** | [**OwnerReference**](owner-reference) | | +**AccessProfiles** | Pointer to [**[]AccessProfileRef**](access-profile-ref) | | [optional] +**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | | [optional] +**Membership** | Pointer to [**NullableRoleMembershipSelector**](role-membership-selector) | | [optional] +**LegacyMembershipInfo** | Pointer to **map[string]interface{}** | This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. | [optional] +**Enabled** | Pointer to **bool** | Whether the Role is enabled or not. | [optional] [default to false] +**Requestable** | Pointer to **bool** | Whether the Role can be the target of access requests. | [optional] [default to false] +**AccessRequestConfig** | Pointer to [**RequestabilityForRole**](requestability-for-role) | | [optional] +**RevocationRequestConfig** | Pointer to [**RevocabilityForRole**](revocability-for-role) | | [optional] +**Segments** | Pointer to **[]string** | List of IDs of segments, if any, to which this Role is assigned. | [optional] +**Dimensional** | Pointer to **NullableBool** | Whether the Role is dimensional. | [optional] [default to false] +**DimensionRefs** | Pointer to [**[]DimensionRef**](dimension-ref) | List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. | [optional] +**AccessModelMetadata** | Pointer to [**AttributeDTOList**](attribute-dto-list) | | [optional] + +## Methods + +### NewRole + +`func NewRole(name string, owner OwnerReference, ) *Role` + +NewRole instantiates a new Role 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 + +### NewRoleWithDefaults + +`func NewRoleWithDefaults() *Role` + +NewRoleWithDefaults instantiates a new Role 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 + +### GetId + +`func (o *Role) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Role) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Role) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Role) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Role) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Role) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Role) SetName(v string)` + +SetName sets Name field to given value. + + +### GetCreated + +`func (o *Role) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Role) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Role) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Role) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Role) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Role) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Role) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Role) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *Role) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Role) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Role) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Role) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Role) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Role) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwner + +`func (o *Role) GetOwner() OwnerReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Role) GetOwnerOk() (*OwnerReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Role) SetOwner(v OwnerReference)` + +SetOwner sets Owner field to given value. + + +### GetAccessProfiles + +`func (o *Role) GetAccessProfiles() []AccessProfileRef` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *Role) GetAccessProfilesOk() (*[]AccessProfileRef, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *Role) SetAccessProfiles(v []AccessProfileRef)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *Role) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### SetAccessProfilesNil + +`func (o *Role) SetAccessProfilesNil(b bool)` + + SetAccessProfilesNil sets the value for AccessProfiles to be an explicit nil + +### UnsetAccessProfiles +`func (o *Role) UnsetAccessProfiles()` + +UnsetAccessProfiles ensures that no value is present for AccessProfiles, not even an explicit nil +### GetEntitlements + +`func (o *Role) GetEntitlements() []EntitlementRef` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *Role) GetEntitlementsOk() (*[]EntitlementRef, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *Role) SetEntitlements(v []EntitlementRef)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *Role) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetMembership + +`func (o *Role) GetMembership() RoleMembershipSelector` + +GetMembership returns the Membership field if non-nil, zero value otherwise. + +### GetMembershipOk + +`func (o *Role) GetMembershipOk() (*RoleMembershipSelector, bool)` + +GetMembershipOk returns a tuple with the Membership field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMembership + +`func (o *Role) SetMembership(v RoleMembershipSelector)` + +SetMembership sets Membership field to given value. + +### HasMembership + +`func (o *Role) HasMembership() bool` + +HasMembership returns a boolean if a field has been set. + +### SetMembershipNil + +`func (o *Role) SetMembershipNil(b bool)` + + SetMembershipNil sets the value for Membership to be an explicit nil + +### UnsetMembership +`func (o *Role) UnsetMembership()` + +UnsetMembership ensures that no value is present for Membership, not even an explicit nil +### GetLegacyMembershipInfo + +`func (o *Role) GetLegacyMembershipInfo() map[string]interface{}` + +GetLegacyMembershipInfo returns the LegacyMembershipInfo field if non-nil, zero value otherwise. + +### GetLegacyMembershipInfoOk + +`func (o *Role) GetLegacyMembershipInfoOk() (*map[string]interface{}, bool)` + +GetLegacyMembershipInfoOk returns a tuple with the LegacyMembershipInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyMembershipInfo + +`func (o *Role) SetLegacyMembershipInfo(v map[string]interface{})` + +SetLegacyMembershipInfo sets LegacyMembershipInfo field to given value. + +### HasLegacyMembershipInfo + +`func (o *Role) HasLegacyMembershipInfo() bool` + +HasLegacyMembershipInfo returns a boolean if a field has been set. + +### SetLegacyMembershipInfoNil + +`func (o *Role) SetLegacyMembershipInfoNil(b bool)` + + SetLegacyMembershipInfoNil sets the value for LegacyMembershipInfo to be an explicit nil + +### UnsetLegacyMembershipInfo +`func (o *Role) UnsetLegacyMembershipInfo()` + +UnsetLegacyMembershipInfo ensures that no value is present for LegacyMembershipInfo, not even an explicit nil +### GetEnabled + +`func (o *Role) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *Role) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *Role) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *Role) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetRequestable + +`func (o *Role) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *Role) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *Role) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *Role) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetAccessRequestConfig + +`func (o *Role) GetAccessRequestConfig() RequestabilityForRole` + +GetAccessRequestConfig returns the AccessRequestConfig field if non-nil, zero value otherwise. + +### GetAccessRequestConfigOk + +`func (o *Role) GetAccessRequestConfigOk() (*RequestabilityForRole, bool)` + +GetAccessRequestConfigOk returns a tuple with the AccessRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestConfig + +`func (o *Role) SetAccessRequestConfig(v RequestabilityForRole)` + +SetAccessRequestConfig sets AccessRequestConfig field to given value. + +### HasAccessRequestConfig + +`func (o *Role) HasAccessRequestConfig() bool` + +HasAccessRequestConfig returns a boolean if a field has been set. + +### GetRevocationRequestConfig + +`func (o *Role) GetRevocationRequestConfig() RevocabilityForRole` + +GetRevocationRequestConfig returns the RevocationRequestConfig field if non-nil, zero value otherwise. + +### GetRevocationRequestConfigOk + +`func (o *Role) GetRevocationRequestConfigOk() (*RevocabilityForRole, bool)` + +GetRevocationRequestConfigOk returns a tuple with the RevocationRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocationRequestConfig + +`func (o *Role) SetRevocationRequestConfig(v RevocabilityForRole)` + +SetRevocationRequestConfig sets RevocationRequestConfig field to given value. + +### HasRevocationRequestConfig + +`func (o *Role) HasRevocationRequestConfig() bool` + +HasRevocationRequestConfig returns a boolean if a field has been set. + +### GetSegments + +`func (o *Role) GetSegments() []string` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *Role) GetSegmentsOk() (*[]string, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *Role) SetSegments(v []string)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *Role) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### SetSegmentsNil + +`func (o *Role) SetSegmentsNil(b bool)` + + SetSegmentsNil sets the value for Segments to be an explicit nil + +### UnsetSegments +`func (o *Role) UnsetSegments()` + +UnsetSegments ensures that no value is present for Segments, not even an explicit nil +### GetDimensional + +`func (o *Role) GetDimensional() bool` + +GetDimensional returns the Dimensional field if non-nil, zero value otherwise. + +### GetDimensionalOk + +`func (o *Role) GetDimensionalOk() (*bool, bool)` + +GetDimensionalOk returns a tuple with the Dimensional field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensional + +`func (o *Role) SetDimensional(v bool)` + +SetDimensional sets Dimensional field to given value. + +### HasDimensional + +`func (o *Role) HasDimensional() bool` + +HasDimensional returns a boolean if a field has been set. + +### SetDimensionalNil + +`func (o *Role) SetDimensionalNil(b bool)` + + SetDimensionalNil sets the value for Dimensional to be an explicit nil + +### UnsetDimensional +`func (o *Role) UnsetDimensional()` + +UnsetDimensional ensures that no value is present for Dimensional, not even an explicit nil +### GetDimensionRefs + +`func (o *Role) GetDimensionRefs() []DimensionRef` + +GetDimensionRefs returns the DimensionRefs field if non-nil, zero value otherwise. + +### GetDimensionRefsOk + +`func (o *Role) GetDimensionRefsOk() (*[]DimensionRef, bool)` + +GetDimensionRefsOk returns a tuple with the DimensionRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensionRefs + +`func (o *Role) SetDimensionRefs(v []DimensionRef)` + +SetDimensionRefs sets DimensionRefs field to given value. + +### HasDimensionRefs + +`func (o *Role) HasDimensionRefs() bool` + +HasDimensionRefs returns a boolean if a field has been set. + +### SetDimensionRefsNil + +`func (o *Role) SetDimensionRefsNil(b bool)` + + SetDimensionRefsNil sets the value for DimensionRefs to be an explicit nil + +### UnsetDimensionRefs +`func (o *Role) UnsetDimensionRefs()` + +UnsetDimensionRefs ensures that no value is present for DimensionRefs, not even an explicit nil +### GetAccessModelMetadata + +`func (o *Role) GetAccessModelMetadata() AttributeDTOList` + +GetAccessModelMetadata returns the AccessModelMetadata field if non-nil, zero value otherwise. + +### GetAccessModelMetadataOk + +`func (o *Role) GetAccessModelMetadataOk() (*AttributeDTOList, bool)` + +GetAccessModelMetadataOk returns a tuple with the AccessModelMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessModelMetadata + +`func (o *Role) SetAccessModelMetadata(v AttributeDTOList)` + +SetAccessModelMetadata sets AccessModelMetadata field to given value. + +### HasAccessModelMetadata + +`func (o *Role) HasAccessModelMetadata() bool` + +HasAccessModelMetadata returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleAssignmentDto.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleAssignmentDto.md new file mode 100644 index 000000000..c38e7c44e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleAssignmentDto.md @@ -0,0 +1,272 @@ +--- +id: beta-role-assignment-dto +title: RoleAssignmentDto +pagination_label: RoleAssignmentDto +sidebar_label: RoleAssignmentDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleAssignmentDto', 'BetaRoleAssignmentDto'] +slug: /tools/sdk/go/beta/models/role-assignment-dto +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentDto', 'BetaRoleAssignmentDto'] +--- + +# RoleAssignmentDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Assignment Id | [optional] +**Role** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**Comments** | Pointer to **string** | Comments added by the user when the assignment was made | [optional] +**AssignmentSource** | Pointer to **string** | Source describing how this assignment was made | [optional] +**Assigner** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**AssignedDimensions** | Pointer to [**[]BaseReferenceDto1**](base-reference-dto1) | Dimensions assigned related to this role | [optional] +**AssignmentContext** | Pointer to [**AssignmentContextDto**](assignment-context-dto) | | [optional] +**AccountTargets** | Pointer to [**[]RoleTargetDto**](role-target-dto) | | [optional] +**RemoveDate** | Pointer to **string** | Date that the assignment will be removed | [optional] + +## Methods + +### NewRoleAssignmentDto + +`func NewRoleAssignmentDto() *RoleAssignmentDto` + +NewRoleAssignmentDto instantiates a new RoleAssignmentDto 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 + +### NewRoleAssignmentDtoWithDefaults + +`func NewRoleAssignmentDtoWithDefaults() *RoleAssignmentDto` + +NewRoleAssignmentDtoWithDefaults instantiates a new RoleAssignmentDto 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 + +### GetId + +`func (o *RoleAssignmentDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleAssignmentDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleAssignmentDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleAssignmentDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRole + +`func (o *RoleAssignmentDto) GetRole() BaseReferenceDto1` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *RoleAssignmentDto) GetRoleOk() (*BaseReferenceDto1, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *RoleAssignmentDto) SetRole(v BaseReferenceDto1)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *RoleAssignmentDto) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetComments + +`func (o *RoleAssignmentDto) GetComments() string` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *RoleAssignmentDto) GetCommentsOk() (*string, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *RoleAssignmentDto) SetComments(v string)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *RoleAssignmentDto) HasComments() bool` + +HasComments returns a boolean if a field has been set. + +### GetAssignmentSource + +`func (o *RoleAssignmentDto) GetAssignmentSource() string` + +GetAssignmentSource returns the AssignmentSource field if non-nil, zero value otherwise. + +### GetAssignmentSourceOk + +`func (o *RoleAssignmentDto) GetAssignmentSourceOk() (*string, bool)` + +GetAssignmentSourceOk returns a tuple with the AssignmentSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentSource + +`func (o *RoleAssignmentDto) SetAssignmentSource(v string)` + +SetAssignmentSource sets AssignmentSource field to given value. + +### HasAssignmentSource + +`func (o *RoleAssignmentDto) HasAssignmentSource() bool` + +HasAssignmentSource returns a boolean if a field has been set. + +### GetAssigner + +`func (o *RoleAssignmentDto) GetAssigner() BaseReferenceDto1` + +GetAssigner returns the Assigner field if non-nil, zero value otherwise. + +### GetAssignerOk + +`func (o *RoleAssignmentDto) GetAssignerOk() (*BaseReferenceDto1, bool)` + +GetAssignerOk returns a tuple with the Assigner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssigner + +`func (o *RoleAssignmentDto) SetAssigner(v BaseReferenceDto1)` + +SetAssigner sets Assigner field to given value. + +### HasAssigner + +`func (o *RoleAssignmentDto) HasAssigner() bool` + +HasAssigner returns a boolean if a field has been set. + +### GetAssignedDimensions + +`func (o *RoleAssignmentDto) GetAssignedDimensions() []BaseReferenceDto1` + +GetAssignedDimensions returns the AssignedDimensions field if non-nil, zero value otherwise. + +### GetAssignedDimensionsOk + +`func (o *RoleAssignmentDto) GetAssignedDimensionsOk() (*[]BaseReferenceDto1, bool)` + +GetAssignedDimensionsOk returns a tuple with the AssignedDimensions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignedDimensions + +`func (o *RoleAssignmentDto) SetAssignedDimensions(v []BaseReferenceDto1)` + +SetAssignedDimensions sets AssignedDimensions field to given value. + +### HasAssignedDimensions + +`func (o *RoleAssignmentDto) HasAssignedDimensions() bool` + +HasAssignedDimensions returns a boolean if a field has been set. + +### GetAssignmentContext + +`func (o *RoleAssignmentDto) GetAssignmentContext() AssignmentContextDto` + +GetAssignmentContext returns the AssignmentContext field if non-nil, zero value otherwise. + +### GetAssignmentContextOk + +`func (o *RoleAssignmentDto) GetAssignmentContextOk() (*AssignmentContextDto, bool)` + +GetAssignmentContextOk returns a tuple with the AssignmentContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentContext + +`func (o *RoleAssignmentDto) SetAssignmentContext(v AssignmentContextDto)` + +SetAssignmentContext sets AssignmentContext field to given value. + +### HasAssignmentContext + +`func (o *RoleAssignmentDto) HasAssignmentContext() bool` + +HasAssignmentContext returns a boolean if a field has been set. + +### GetAccountTargets + +`func (o *RoleAssignmentDto) GetAccountTargets() []RoleTargetDto` + +GetAccountTargets returns the AccountTargets field if non-nil, zero value otherwise. + +### GetAccountTargetsOk + +`func (o *RoleAssignmentDto) GetAccountTargetsOk() (*[]RoleTargetDto, bool)` + +GetAccountTargetsOk returns a tuple with the AccountTargets field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountTargets + +`func (o *RoleAssignmentDto) SetAccountTargets(v []RoleTargetDto)` + +SetAccountTargets sets AccountTargets field to given value. + +### HasAccountTargets + +`func (o *RoleAssignmentDto) HasAccountTargets() bool` + +HasAccountTargets returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *RoleAssignmentDto) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *RoleAssignmentDto) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *RoleAssignmentDto) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *RoleAssignmentDto) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleAssignmentRef.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleAssignmentRef.md new file mode 100644 index 000000000..17d8c42d7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleAssignmentRef.md @@ -0,0 +1,90 @@ +--- +id: beta-role-assignment-ref +title: RoleAssignmentRef +pagination_label: RoleAssignmentRef +sidebar_label: RoleAssignmentRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleAssignmentRef', 'BetaRoleAssignmentRef'] +slug: /tools/sdk/go/beta/models/role-assignment-ref +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentRef', 'BetaRoleAssignmentRef'] +--- + +# RoleAssignmentRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Assignment Id | [optional] +**Role** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] + +## Methods + +### NewRoleAssignmentRef + +`func NewRoleAssignmentRef() *RoleAssignmentRef` + +NewRoleAssignmentRef instantiates a new RoleAssignmentRef 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 + +### NewRoleAssignmentRefWithDefaults + +`func NewRoleAssignmentRefWithDefaults() *RoleAssignmentRef` + +NewRoleAssignmentRefWithDefaults instantiates a new RoleAssignmentRef 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 + +### GetId + +`func (o *RoleAssignmentRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleAssignmentRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleAssignmentRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleAssignmentRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRole + +`func (o *RoleAssignmentRef) GetRole() BaseReferenceDto1` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *RoleAssignmentRef) GetRoleOk() (*BaseReferenceDto1, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *RoleAssignmentRef) SetRole(v BaseReferenceDto1)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *RoleAssignmentRef) HasRole() bool` + +HasRole returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleAssignmentSourceType.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleAssignmentSourceType.md new file mode 100644 index 000000000..1bdda0b3a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleAssignmentSourceType.md @@ -0,0 +1,21 @@ +--- +id: beta-role-assignment-source-type +title: RoleAssignmentSourceType +pagination_label: RoleAssignmentSourceType +sidebar_label: RoleAssignmentSourceType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleAssignmentSourceType', 'BetaRoleAssignmentSourceType'] +slug: /tools/sdk/go/beta/models/role-assignment-source-type +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentSourceType', 'BetaRoleAssignmentSourceType'] +--- + +# RoleAssignmentSourceType + +## Enum + + +* `ACCESS_REQUEST` (value: `"ACCESS_REQUEST"`) + +* `ROLE_MEMBERSHIP` (value: `"ROLE_MEMBERSHIP"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleBulkDeleteRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleBulkDeleteRequest.md new file mode 100644 index 000000000..859b3e364 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleBulkDeleteRequest.md @@ -0,0 +1,59 @@ +--- +id: beta-role-bulk-delete-request +title: RoleBulkDeleteRequest +pagination_label: RoleBulkDeleteRequest +sidebar_label: RoleBulkDeleteRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleBulkDeleteRequest', 'BetaRoleBulkDeleteRequest'] +slug: /tools/sdk/go/beta/models/role-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'RoleBulkDeleteRequest', 'BetaRoleBulkDeleteRequest'] +--- + +# RoleBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleIds** | **[]string** | List of IDs of Roles to be deleted. | + +## Methods + +### NewRoleBulkDeleteRequest + +`func NewRoleBulkDeleteRequest(roleIds []string, ) *RoleBulkDeleteRequest` + +NewRoleBulkDeleteRequest instantiates a new RoleBulkDeleteRequest 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 + +### NewRoleBulkDeleteRequestWithDefaults + +`func NewRoleBulkDeleteRequestWithDefaults() *RoleBulkDeleteRequest` + +NewRoleBulkDeleteRequestWithDefaults instantiates a new RoleBulkDeleteRequest 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 + +### GetRoleIds + +`func (o *RoleBulkDeleteRequest) GetRoleIds() []string` + +GetRoleIds returns the RoleIds field if non-nil, zero value otherwise. + +### GetRoleIdsOk + +`func (o *RoleBulkDeleteRequest) GetRoleIdsOk() (*[]string, bool)` + +GetRoleIdsOk returns a tuple with the RoleIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleIds + +`func (o *RoleBulkDeleteRequest) SetRoleIds(v []string)` + +SetRoleIds sets RoleIds field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaKey.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaKey.md new file mode 100644 index 000000000..6089b7f5b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaKey.md @@ -0,0 +1,116 @@ +--- +id: beta-role-criteria-key +title: RoleCriteriaKey +pagination_label: RoleCriteriaKey +sidebar_label: RoleCriteriaKey +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaKey', 'BetaRoleCriteriaKey'] +slug: /tools/sdk/go/beta/models/role-criteria-key +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKey', 'BetaRoleCriteriaKey'] +--- + +# RoleCriteriaKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**RoleCriteriaKeyType**](role-criteria-key-type) | | +**Property** | **string** | The name of the attribute or entitlement to which the associated criteria applies. | +**SourceId** | Pointer to **NullableString** | ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT | [optional] + +## Methods + +### NewRoleCriteriaKey + +`func NewRoleCriteriaKey(type_ RoleCriteriaKeyType, property string, ) *RoleCriteriaKey` + +NewRoleCriteriaKey instantiates a new RoleCriteriaKey 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 + +### NewRoleCriteriaKeyWithDefaults + +`func NewRoleCriteriaKeyWithDefaults() *RoleCriteriaKey` + +NewRoleCriteriaKeyWithDefaults instantiates a new RoleCriteriaKey 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 + +### GetType + +`func (o *RoleCriteriaKey) GetType() RoleCriteriaKeyType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleCriteriaKey) GetTypeOk() (*RoleCriteriaKeyType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleCriteriaKey) SetType(v RoleCriteriaKeyType)` + +SetType sets Type field to given value. + + +### GetProperty + +`func (o *RoleCriteriaKey) GetProperty() string` + +GetProperty returns the Property field if non-nil, zero value otherwise. + +### GetPropertyOk + +`func (o *RoleCriteriaKey) GetPropertyOk() (*string, bool)` + +GetPropertyOk returns a tuple with the Property field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperty + +`func (o *RoleCriteriaKey) SetProperty(v string)` + +SetProperty sets Property field to given value. + + +### GetSourceId + +`func (o *RoleCriteriaKey) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *RoleCriteriaKey) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *RoleCriteriaKey) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *RoleCriteriaKey) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### SetSourceIdNil + +`func (o *RoleCriteriaKey) SetSourceIdNil(b bool)` + + SetSourceIdNil sets the value for SourceId to be an explicit nil + +### UnsetSourceId +`func (o *RoleCriteriaKey) UnsetSourceId()` + +UnsetSourceId ensures that no value is present for SourceId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaKeyType.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaKeyType.md new file mode 100644 index 000000000..91eb6e293 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaKeyType.md @@ -0,0 +1,23 @@ +--- +id: beta-role-criteria-key-type +title: RoleCriteriaKeyType +pagination_label: RoleCriteriaKeyType +sidebar_label: RoleCriteriaKeyType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaKeyType', 'BetaRoleCriteriaKeyType'] +slug: /tools/sdk/go/beta/models/role-criteria-key-type +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKeyType', 'BetaRoleCriteriaKeyType'] +--- + +# RoleCriteriaKeyType + +## Enum + + +* `IDENTITY` (value: `"IDENTITY"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaLevel1.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaLevel1.md new file mode 100644 index 000000000..23056a0d0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaLevel1.md @@ -0,0 +1,172 @@ +--- +id: beta-role-criteria-level1 +title: RoleCriteriaLevel1 +pagination_label: RoleCriteriaLevel1 +sidebar_label: RoleCriteriaLevel1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaLevel1', 'BetaRoleCriteriaLevel1'] +slug: /tools/sdk/go/beta/models/role-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel1', 'BetaRoleCriteriaLevel1'] +--- + +# RoleCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableRoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **NullableString** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]RoleCriteriaLevel2**](role-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Methods + +### NewRoleCriteriaLevel1 + +`func NewRoleCriteriaLevel1() *RoleCriteriaLevel1` + +NewRoleCriteriaLevel1 instantiates a new RoleCriteriaLevel1 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 + +### NewRoleCriteriaLevel1WithDefaults + +`func NewRoleCriteriaLevel1WithDefaults() *RoleCriteriaLevel1` + +NewRoleCriteriaLevel1WithDefaults instantiates a new RoleCriteriaLevel1 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 + +### GetOperation + +`func (o *RoleCriteriaLevel1) GetOperation() RoleCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleCriteriaLevel1) GetOperationOk() (*RoleCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleCriteriaLevel1) SetOperation(v RoleCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *RoleCriteriaLevel1) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *RoleCriteriaLevel1) GetKey() RoleCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *RoleCriteriaLevel1) GetKeyOk() (*RoleCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *RoleCriteriaLevel1) SetKey(v RoleCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *RoleCriteriaLevel1) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *RoleCriteriaLevel1) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *RoleCriteriaLevel1) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *RoleCriteriaLevel1) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *RoleCriteriaLevel1) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *RoleCriteriaLevel1) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *RoleCriteriaLevel1) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + +### SetStringValueNil + +`func (o *RoleCriteriaLevel1) SetStringValueNil(b bool)` + + SetStringValueNil sets the value for StringValue to be an explicit nil + +### UnsetStringValue +`func (o *RoleCriteriaLevel1) UnsetStringValue()` + +UnsetStringValue ensures that no value is present for StringValue, not even an explicit nil +### GetChildren + +`func (o *RoleCriteriaLevel1) GetChildren() []RoleCriteriaLevel2` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *RoleCriteriaLevel1) GetChildrenOk() (*[]RoleCriteriaLevel2, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *RoleCriteriaLevel1) SetChildren(v []RoleCriteriaLevel2)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *RoleCriteriaLevel1) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *RoleCriteriaLevel1) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *RoleCriteriaLevel1) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaLevel2.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaLevel2.md new file mode 100644 index 000000000..6058523d1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaLevel2.md @@ -0,0 +1,172 @@ +--- +id: beta-role-criteria-level2 +title: RoleCriteriaLevel2 +pagination_label: RoleCriteriaLevel2 +sidebar_label: RoleCriteriaLevel2 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaLevel2', 'BetaRoleCriteriaLevel2'] +slug: /tools/sdk/go/beta/models/role-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel2', 'BetaRoleCriteriaLevel2'] +--- + +# RoleCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableRoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **NullableString** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]RoleCriteriaLevel3**](role-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Methods + +### NewRoleCriteriaLevel2 + +`func NewRoleCriteriaLevel2() *RoleCriteriaLevel2` + +NewRoleCriteriaLevel2 instantiates a new RoleCriteriaLevel2 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 + +### NewRoleCriteriaLevel2WithDefaults + +`func NewRoleCriteriaLevel2WithDefaults() *RoleCriteriaLevel2` + +NewRoleCriteriaLevel2WithDefaults instantiates a new RoleCriteriaLevel2 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 + +### GetOperation + +`func (o *RoleCriteriaLevel2) GetOperation() RoleCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleCriteriaLevel2) GetOperationOk() (*RoleCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleCriteriaLevel2) SetOperation(v RoleCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *RoleCriteriaLevel2) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *RoleCriteriaLevel2) GetKey() RoleCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *RoleCriteriaLevel2) GetKeyOk() (*RoleCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *RoleCriteriaLevel2) SetKey(v RoleCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *RoleCriteriaLevel2) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *RoleCriteriaLevel2) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *RoleCriteriaLevel2) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *RoleCriteriaLevel2) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *RoleCriteriaLevel2) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *RoleCriteriaLevel2) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *RoleCriteriaLevel2) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + +### SetStringValueNil + +`func (o *RoleCriteriaLevel2) SetStringValueNil(b bool)` + + SetStringValueNil sets the value for StringValue to be an explicit nil + +### UnsetStringValue +`func (o *RoleCriteriaLevel2) UnsetStringValue()` + +UnsetStringValue ensures that no value is present for StringValue, not even an explicit nil +### GetChildren + +`func (o *RoleCriteriaLevel2) GetChildren() []RoleCriteriaLevel3` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *RoleCriteriaLevel2) GetChildrenOk() (*[]RoleCriteriaLevel3, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *RoleCriteriaLevel2) SetChildren(v []RoleCriteriaLevel3)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *RoleCriteriaLevel2) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *RoleCriteriaLevel2) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *RoleCriteriaLevel2) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaLevel3.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaLevel3.md new file mode 100644 index 000000000..4356fad63 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaLevel3.md @@ -0,0 +1,126 @@ +--- +id: beta-role-criteria-level3 +title: RoleCriteriaLevel3 +pagination_label: RoleCriteriaLevel3 +sidebar_label: RoleCriteriaLevel3 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaLevel3', 'BetaRoleCriteriaLevel3'] +slug: /tools/sdk/go/beta/models/role-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel3', 'BetaRoleCriteriaLevel3'] +--- + +# RoleCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableRoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **string** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] + +## Methods + +### NewRoleCriteriaLevel3 + +`func NewRoleCriteriaLevel3() *RoleCriteriaLevel3` + +NewRoleCriteriaLevel3 instantiates a new RoleCriteriaLevel3 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 + +### NewRoleCriteriaLevel3WithDefaults + +`func NewRoleCriteriaLevel3WithDefaults() *RoleCriteriaLevel3` + +NewRoleCriteriaLevel3WithDefaults instantiates a new RoleCriteriaLevel3 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 + +### GetOperation + +`func (o *RoleCriteriaLevel3) GetOperation() RoleCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleCriteriaLevel3) GetOperationOk() (*RoleCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleCriteriaLevel3) SetOperation(v RoleCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *RoleCriteriaLevel3) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *RoleCriteriaLevel3) GetKey() RoleCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *RoleCriteriaLevel3) GetKeyOk() (*RoleCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *RoleCriteriaLevel3) SetKey(v RoleCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *RoleCriteriaLevel3) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *RoleCriteriaLevel3) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *RoleCriteriaLevel3) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *RoleCriteriaLevel3) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *RoleCriteriaLevel3) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *RoleCriteriaLevel3) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *RoleCriteriaLevel3) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaOperation.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaOperation.md new file mode 100644 index 000000000..c7da9e2bc --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleCriteriaOperation.md @@ -0,0 +1,31 @@ +--- +id: beta-role-criteria-operation +title: RoleCriteriaOperation +pagination_label: RoleCriteriaOperation +sidebar_label: RoleCriteriaOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaOperation', 'BetaRoleCriteriaOperation'] +slug: /tools/sdk/go/beta/models/role-criteria-operation +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaOperation', 'BetaRoleCriteriaOperation'] +--- + +# RoleCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `STARTS_WITH` (value: `"STARTS_WITH"`) + +* `ENDS_WITH` (value: `"ENDS_WITH"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleIdentity.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleIdentity.md new file mode 100644 index 000000000..5bd9767d4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleIdentity.md @@ -0,0 +1,168 @@ +--- +id: beta-role-identity +title: RoleIdentity +pagination_label: RoleIdentity +sidebar_label: RoleIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleIdentity', 'BetaRoleIdentity'] +slug: /tools/sdk/go/beta/models/role-identity +tags: ['SDK', 'Software Development Kit', 'RoleIdentity', 'BetaRoleIdentity'] +--- + +# RoleIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the Identity | [optional] +**AliasName** | Pointer to **string** | The alias / username of the Identity | [optional] +**Name** | Pointer to **string** | The human-readable display name of the Identity | [optional] +**Email** | Pointer to **string** | Email address of the Identity | [optional] +**RoleAssignmentSource** | Pointer to [**RoleAssignmentSourceType**](role-assignment-source-type) | | [optional] + +## Methods + +### NewRoleIdentity + +`func NewRoleIdentity() *RoleIdentity` + +NewRoleIdentity instantiates a new RoleIdentity 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 + +### NewRoleIdentityWithDefaults + +`func NewRoleIdentityWithDefaults() *RoleIdentity` + +NewRoleIdentityWithDefaults instantiates a new RoleIdentity 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 + +### GetId + +`func (o *RoleIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAliasName + +`func (o *RoleIdentity) GetAliasName() string` + +GetAliasName returns the AliasName field if non-nil, zero value otherwise. + +### GetAliasNameOk + +`func (o *RoleIdentity) GetAliasNameOk() (*string, bool)` + +GetAliasNameOk returns a tuple with the AliasName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAliasName + +`func (o *RoleIdentity) SetAliasName(v string)` + +SetAliasName sets AliasName field to given value. + +### HasAliasName + +`func (o *RoleIdentity) HasAliasName() bool` + +HasAliasName returns a boolean if a field has been set. + +### GetName + +`func (o *RoleIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *RoleIdentity) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *RoleIdentity) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *RoleIdentity) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *RoleIdentity) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetRoleAssignmentSource + +`func (o *RoleIdentity) GetRoleAssignmentSource() RoleAssignmentSourceType` + +GetRoleAssignmentSource returns the RoleAssignmentSource field if non-nil, zero value otherwise. + +### GetRoleAssignmentSourceOk + +`func (o *RoleIdentity) GetRoleAssignmentSourceOk() (*RoleAssignmentSourceType, bool)` + +GetRoleAssignmentSourceOk returns a tuple with the RoleAssignmentSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleAssignmentSource + +`func (o *RoleIdentity) SetRoleAssignmentSource(v RoleAssignmentSourceType)` + +SetRoleAssignmentSource sets RoleAssignmentSource field to given value. + +### HasRoleAssignmentSource + +`func (o *RoleIdentity) HasRoleAssignmentSource() bool` + +HasRoleAssignmentSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleInsight.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleInsight.md new file mode 100644 index 000000000..84562467e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleInsight.md @@ -0,0 +1,204 @@ +--- +id: beta-role-insight +title: RoleInsight +pagination_label: RoleInsight +sidebar_label: RoleInsight +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsight', 'BetaRoleInsight'] +slug: /tools/sdk/go/beta/models/role-insight +tags: ['SDK', 'Software Development Kit', 'RoleInsight', 'BetaRoleInsight'] +--- + +# RoleInsight + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Insight id | [optional] +**NumberOfUpdates** | Pointer to **int32** | Total number of updates for this role | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time insights were last created for this role. | [optional] +**ModifiedDate** | Pointer to **NullableTime** | The date-time insights were last modified for this role. | [optional] +**Role** | Pointer to [**RoleInsightsRole**](role-insights-role) | | [optional] +**Insight** | Pointer to [**RoleInsightsInsight**](role-insights-insight) | | [optional] + +## Methods + +### NewRoleInsight + +`func NewRoleInsight() *RoleInsight` + +NewRoleInsight instantiates a new RoleInsight 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 + +### NewRoleInsightWithDefaults + +`func NewRoleInsightWithDefaults() *RoleInsight` + +NewRoleInsightWithDefaults instantiates a new RoleInsight 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 + +### GetId + +`func (o *RoleInsight) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsight) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsight) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsight) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetNumberOfUpdates + +`func (o *RoleInsight) GetNumberOfUpdates() int32` + +GetNumberOfUpdates returns the NumberOfUpdates field if non-nil, zero value otherwise. + +### GetNumberOfUpdatesOk + +`func (o *RoleInsight) GetNumberOfUpdatesOk() (*int32, bool)` + +GetNumberOfUpdatesOk returns a tuple with the NumberOfUpdates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumberOfUpdates + +`func (o *RoleInsight) SetNumberOfUpdates(v int32)` + +SetNumberOfUpdates sets NumberOfUpdates field to given value. + +### HasNumberOfUpdates + +`func (o *RoleInsight) HasNumberOfUpdates() bool` + +HasNumberOfUpdates returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleInsight) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleInsight) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleInsight) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleInsight) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetModifiedDate + +`func (o *RoleInsight) GetModifiedDate() SailPointTime` + +GetModifiedDate returns the ModifiedDate field if non-nil, zero value otherwise. + +### GetModifiedDateOk + +`func (o *RoleInsight) GetModifiedDateOk() (*SailPointTime, bool)` + +GetModifiedDateOk returns a tuple with the ModifiedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedDate + +`func (o *RoleInsight) SetModifiedDate(v SailPointTime)` + +SetModifiedDate sets ModifiedDate field to given value. + +### HasModifiedDate + +`func (o *RoleInsight) HasModifiedDate() bool` + +HasModifiedDate returns a boolean if a field has been set. + +### SetModifiedDateNil + +`func (o *RoleInsight) SetModifiedDateNil(b bool)` + + SetModifiedDateNil sets the value for ModifiedDate to be an explicit nil + +### UnsetModifiedDate +`func (o *RoleInsight) UnsetModifiedDate()` + +UnsetModifiedDate ensures that no value is present for ModifiedDate, not even an explicit nil +### GetRole + +`func (o *RoleInsight) GetRole() RoleInsightsRole` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *RoleInsight) GetRoleOk() (*RoleInsightsRole, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *RoleInsight) SetRole(v RoleInsightsRole)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *RoleInsight) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetInsight + +`func (o *RoleInsight) GetInsight() RoleInsightsInsight` + +GetInsight returns the Insight field if non-nil, zero value otherwise. + +### GetInsightOk + +`func (o *RoleInsight) GetInsightOk() (*RoleInsightsInsight, bool)` + +GetInsightOk returns a tuple with the Insight field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInsight + +`func (o *RoleInsight) SetInsight(v RoleInsightsInsight)` + +SetInsight sets Insight field to given value. + +### HasInsight + +`func (o *RoleInsight) HasInsight() bool` + +HasInsight returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsEntitlement.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsEntitlement.md new file mode 100644 index 000000000..3b7115c00 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsEntitlement.md @@ -0,0 +1,194 @@ +--- +id: beta-role-insights-entitlement +title: RoleInsightsEntitlement +pagination_label: RoleInsightsEntitlement +sidebar_label: RoleInsightsEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsEntitlement', 'BetaRoleInsightsEntitlement'] +slug: /tools/sdk/go/beta/models/role-insights-entitlement +tags: ['SDK', 'Software Development Kit', 'RoleInsightsEntitlement', 'BetaRoleInsightsEntitlement'] +--- + +# RoleInsightsEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the entitlement | [optional] +**Id** | Pointer to **string** | Id of the entitlement | [optional] +**Description** | Pointer to **string** | Description for the entitlement | [optional] +**Source** | Pointer to **string** | Source or the application for the entitlement | [optional] +**Attribute** | Pointer to **string** | Attribute for the entitlement | [optional] +**Value** | Pointer to **string** | Attribute value for the entitlement | [optional] + +## Methods + +### NewRoleInsightsEntitlement + +`func NewRoleInsightsEntitlement() *RoleInsightsEntitlement` + +NewRoleInsightsEntitlement instantiates a new RoleInsightsEntitlement 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 + +### NewRoleInsightsEntitlementWithDefaults + +`func NewRoleInsightsEntitlementWithDefaults() *RoleInsightsEntitlement` + +NewRoleInsightsEntitlementWithDefaults instantiates a new RoleInsightsEntitlement 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 + +### GetName + +`func (o *RoleInsightsEntitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleInsightsEntitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleInsightsEntitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleInsightsEntitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetId + +`func (o *RoleInsightsEntitlement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsightsEntitlement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsightsEntitlement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsightsEntitlement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleInsightsEntitlement) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleInsightsEntitlement) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleInsightsEntitlement) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleInsightsEntitlement) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetSource + +`func (o *RoleInsightsEntitlement) GetSource() string` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *RoleInsightsEntitlement) GetSourceOk() (*string, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *RoleInsightsEntitlement) SetSource(v string)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *RoleInsightsEntitlement) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAttribute + +`func (o *RoleInsightsEntitlement) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleInsightsEntitlement) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleInsightsEntitlement) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleInsightsEntitlement) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *RoleInsightsEntitlement) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *RoleInsightsEntitlement) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *RoleInsightsEntitlement) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *RoleInsightsEntitlement) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsEntitlementChanges.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsEntitlementChanges.md new file mode 100644 index 000000000..849a0ea64 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsEntitlementChanges.md @@ -0,0 +1,220 @@ +--- +id: beta-role-insights-entitlement-changes +title: RoleInsightsEntitlementChanges +pagination_label: RoleInsightsEntitlementChanges +sidebar_label: RoleInsightsEntitlementChanges +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsEntitlementChanges', 'BetaRoleInsightsEntitlementChanges'] +slug: /tools/sdk/go/beta/models/role-insights-entitlement-changes +tags: ['SDK', 'Software Development Kit', 'RoleInsightsEntitlementChanges', 'BetaRoleInsightsEntitlementChanges'] +--- + +# RoleInsightsEntitlementChanges + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the entitlement | [optional] +**Id** | Pointer to **string** | Id of the entitlement | [optional] +**Description** | Pointer to **string** | Description for the entitlement | [optional] +**Attribute** | Pointer to **string** | Attribute for the entitlement | [optional] +**Value** | Pointer to **string** | Attribute value for the entitlement | [optional] +**Source** | Pointer to **string** | Source or the application for the entitlement | [optional] +**Insight** | Pointer to [**RoleInsightsInsight**](role-insights-insight) | | [optional] + +## Methods + +### NewRoleInsightsEntitlementChanges + +`func NewRoleInsightsEntitlementChanges() *RoleInsightsEntitlementChanges` + +NewRoleInsightsEntitlementChanges instantiates a new RoleInsightsEntitlementChanges 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 + +### NewRoleInsightsEntitlementChangesWithDefaults + +`func NewRoleInsightsEntitlementChangesWithDefaults() *RoleInsightsEntitlementChanges` + +NewRoleInsightsEntitlementChangesWithDefaults instantiates a new RoleInsightsEntitlementChanges 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 + +### GetName + +`func (o *RoleInsightsEntitlementChanges) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleInsightsEntitlementChanges) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleInsightsEntitlementChanges) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleInsightsEntitlementChanges) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetId + +`func (o *RoleInsightsEntitlementChanges) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsightsEntitlementChanges) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsightsEntitlementChanges) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsightsEntitlementChanges) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleInsightsEntitlementChanges) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleInsightsEntitlementChanges) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleInsightsEntitlementChanges) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleInsightsEntitlementChanges) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetAttribute + +`func (o *RoleInsightsEntitlementChanges) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleInsightsEntitlementChanges) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleInsightsEntitlementChanges) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleInsightsEntitlementChanges) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *RoleInsightsEntitlementChanges) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *RoleInsightsEntitlementChanges) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *RoleInsightsEntitlementChanges) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *RoleInsightsEntitlementChanges) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSource + +`func (o *RoleInsightsEntitlementChanges) GetSource() string` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *RoleInsightsEntitlementChanges) GetSourceOk() (*string, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *RoleInsightsEntitlementChanges) SetSource(v string)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *RoleInsightsEntitlementChanges) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetInsight + +`func (o *RoleInsightsEntitlementChanges) GetInsight() RoleInsightsInsight` + +GetInsight returns the Insight field if non-nil, zero value otherwise. + +### GetInsightOk + +`func (o *RoleInsightsEntitlementChanges) GetInsightOk() (*RoleInsightsInsight, bool)` + +GetInsightOk returns a tuple with the Insight field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInsight + +`func (o *RoleInsightsEntitlementChanges) SetInsight(v RoleInsightsInsight)` + +SetInsight sets Insight field to given value. + +### HasInsight + +`func (o *RoleInsightsEntitlementChanges) HasInsight() bool` + +HasInsight returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsIdentities.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsIdentities.md new file mode 100644 index 000000000..ee3c34ded --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsIdentities.md @@ -0,0 +1,116 @@ +--- +id: beta-role-insights-identities +title: RoleInsightsIdentities +pagination_label: RoleInsightsIdentities +sidebar_label: RoleInsightsIdentities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsIdentities', 'BetaRoleInsightsIdentities'] +slug: /tools/sdk/go/beta/models/role-insights-identities +tags: ['SDK', 'Software Development Kit', 'RoleInsightsIdentities', 'BetaRoleInsightsIdentities'] +--- + +# RoleInsightsIdentities + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id for identity | [optional] +**Name** | Pointer to **string** | Name for identity | [optional] +**Attributes** | Pointer to **map[string]string** | | [optional] + +## Methods + +### NewRoleInsightsIdentities + +`func NewRoleInsightsIdentities() *RoleInsightsIdentities` + +NewRoleInsightsIdentities instantiates a new RoleInsightsIdentities 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 + +### NewRoleInsightsIdentitiesWithDefaults + +`func NewRoleInsightsIdentitiesWithDefaults() *RoleInsightsIdentities` + +NewRoleInsightsIdentitiesWithDefaults instantiates a new RoleInsightsIdentities 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 + +### GetId + +`func (o *RoleInsightsIdentities) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsightsIdentities) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsightsIdentities) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsightsIdentities) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleInsightsIdentities) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleInsightsIdentities) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleInsightsIdentities) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleInsightsIdentities) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAttributes + +`func (o *RoleInsightsIdentities) GetAttributes() map[string]string` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *RoleInsightsIdentities) GetAttributesOk() (*map[string]string, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *RoleInsightsIdentities) SetAttributes(v map[string]string)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *RoleInsightsIdentities) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsInsight.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsInsight.md new file mode 100644 index 000000000..573568fb3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsInsight.md @@ -0,0 +1,178 @@ +--- +id: beta-role-insights-insight +title: RoleInsightsInsight +pagination_label: RoleInsightsInsight +sidebar_label: RoleInsightsInsight +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsInsight', 'BetaRoleInsightsInsight'] +slug: /tools/sdk/go/beta/models/role-insights-insight +tags: ['SDK', 'Software Development Kit', 'RoleInsightsInsight', 'BetaRoleInsightsInsight'] +--- + +# RoleInsightsInsight + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The number of identities in this role with the entitlement. | [optional] +**IdentitiesWithAccess** | Pointer to **int32** | The number of identities in this role with the entitlement. | [optional] +**IdentitiesImpacted** | Pointer to **int32** | The number of identities in this role that do not have the specified entitlement. | [optional] +**TotalNumberOfIdentities** | Pointer to **int32** | The total number of identities. | [optional] +**ImpactedIdentityNames** | Pointer to **NullableString** | | [optional] + +## Methods + +### NewRoleInsightsInsight + +`func NewRoleInsightsInsight() *RoleInsightsInsight` + +NewRoleInsightsInsight instantiates a new RoleInsightsInsight 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 + +### NewRoleInsightsInsightWithDefaults + +`func NewRoleInsightsInsightWithDefaults() *RoleInsightsInsight` + +NewRoleInsightsInsightWithDefaults instantiates a new RoleInsightsInsight 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 + +### GetType + +`func (o *RoleInsightsInsight) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleInsightsInsight) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleInsightsInsight) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleInsightsInsight) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetIdentitiesWithAccess + +`func (o *RoleInsightsInsight) GetIdentitiesWithAccess() int32` + +GetIdentitiesWithAccess returns the IdentitiesWithAccess field if non-nil, zero value otherwise. + +### GetIdentitiesWithAccessOk + +`func (o *RoleInsightsInsight) GetIdentitiesWithAccessOk() (*int32, bool)` + +GetIdentitiesWithAccessOk returns a tuple with the IdentitiesWithAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesWithAccess + +`func (o *RoleInsightsInsight) SetIdentitiesWithAccess(v int32)` + +SetIdentitiesWithAccess sets IdentitiesWithAccess field to given value. + +### HasIdentitiesWithAccess + +`func (o *RoleInsightsInsight) HasIdentitiesWithAccess() bool` + +HasIdentitiesWithAccess returns a boolean if a field has been set. + +### GetIdentitiesImpacted + +`func (o *RoleInsightsInsight) GetIdentitiesImpacted() int32` + +GetIdentitiesImpacted returns the IdentitiesImpacted field if non-nil, zero value otherwise. + +### GetIdentitiesImpactedOk + +`func (o *RoleInsightsInsight) GetIdentitiesImpactedOk() (*int32, bool)` + +GetIdentitiesImpactedOk returns a tuple with the IdentitiesImpacted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesImpacted + +`func (o *RoleInsightsInsight) SetIdentitiesImpacted(v int32)` + +SetIdentitiesImpacted sets IdentitiesImpacted field to given value. + +### HasIdentitiesImpacted + +`func (o *RoleInsightsInsight) HasIdentitiesImpacted() bool` + +HasIdentitiesImpacted returns a boolean if a field has been set. + +### GetTotalNumberOfIdentities + +`func (o *RoleInsightsInsight) GetTotalNumberOfIdentities() int32` + +GetTotalNumberOfIdentities returns the TotalNumberOfIdentities field if non-nil, zero value otherwise. + +### GetTotalNumberOfIdentitiesOk + +`func (o *RoleInsightsInsight) GetTotalNumberOfIdentitiesOk() (*int32, bool)` + +GetTotalNumberOfIdentitiesOk returns a tuple with the TotalNumberOfIdentities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalNumberOfIdentities + +`func (o *RoleInsightsInsight) SetTotalNumberOfIdentities(v int32)` + +SetTotalNumberOfIdentities sets TotalNumberOfIdentities field to given value. + +### HasTotalNumberOfIdentities + +`func (o *RoleInsightsInsight) HasTotalNumberOfIdentities() bool` + +HasTotalNumberOfIdentities returns a boolean if a field has been set. + +### GetImpactedIdentityNames + +`func (o *RoleInsightsInsight) GetImpactedIdentityNames() string` + +GetImpactedIdentityNames returns the ImpactedIdentityNames field if non-nil, zero value otherwise. + +### GetImpactedIdentityNamesOk + +`func (o *RoleInsightsInsight) GetImpactedIdentityNamesOk() (*string, bool)` + +GetImpactedIdentityNamesOk returns a tuple with the ImpactedIdentityNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImpactedIdentityNames + +`func (o *RoleInsightsInsight) SetImpactedIdentityNames(v string)` + +SetImpactedIdentityNames sets ImpactedIdentityNames field to given value. + +### HasImpactedIdentityNames + +`func (o *RoleInsightsInsight) HasImpactedIdentityNames() bool` + +HasImpactedIdentityNames returns a boolean if a field has been set. + +### SetImpactedIdentityNamesNil + +`func (o *RoleInsightsInsight) SetImpactedIdentityNamesNil(b bool)` + + SetImpactedIdentityNamesNil sets the value for ImpactedIdentityNames to be an explicit nil + +### UnsetImpactedIdentityNames +`func (o *RoleInsightsInsight) UnsetImpactedIdentityNames()` + +UnsetImpactedIdentityNames ensures that no value is present for ImpactedIdentityNames, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsResponse.md new file mode 100644 index 000000000..4496503ad --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsResponse.md @@ -0,0 +1,194 @@ +--- +id: beta-role-insights-response +title: RoleInsightsResponse +pagination_label: RoleInsightsResponse +sidebar_label: RoleInsightsResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsResponse', 'BetaRoleInsightsResponse'] +slug: /tools/sdk/go/beta/models/role-insights-response +tags: ['SDK', 'Software Development Kit', 'RoleInsightsResponse', 'BetaRoleInsightsResponse'] +--- + +# RoleInsightsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Request Id for a role insight generation request | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time role insights request was created. | [optional] +**LastGenerated** | Pointer to **SailPointTime** | The date-time role insights request was completed. | [optional] +**NumberOfUpdates** | Pointer to **int32** | Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED. | [optional] +**RoleIds** | Pointer to **[]string** | The role IDs that are in this request. | [optional] +**Status** | Pointer to **string** | Request status | [optional] + +## Methods + +### NewRoleInsightsResponse + +`func NewRoleInsightsResponse() *RoleInsightsResponse` + +NewRoleInsightsResponse instantiates a new RoleInsightsResponse 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 + +### NewRoleInsightsResponseWithDefaults + +`func NewRoleInsightsResponseWithDefaults() *RoleInsightsResponse` + +NewRoleInsightsResponseWithDefaults instantiates a new RoleInsightsResponse 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 + +### GetId + +`func (o *RoleInsightsResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsightsResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsightsResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsightsResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleInsightsResponse) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleInsightsResponse) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleInsightsResponse) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleInsightsResponse) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetLastGenerated + +`func (o *RoleInsightsResponse) GetLastGenerated() SailPointTime` + +GetLastGenerated returns the LastGenerated field if non-nil, zero value otherwise. + +### GetLastGeneratedOk + +`func (o *RoleInsightsResponse) GetLastGeneratedOk() (*SailPointTime, bool)` + +GetLastGeneratedOk returns a tuple with the LastGenerated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastGenerated + +`func (o *RoleInsightsResponse) SetLastGenerated(v SailPointTime)` + +SetLastGenerated sets LastGenerated field to given value. + +### HasLastGenerated + +`func (o *RoleInsightsResponse) HasLastGenerated() bool` + +HasLastGenerated returns a boolean if a field has been set. + +### GetNumberOfUpdates + +`func (o *RoleInsightsResponse) GetNumberOfUpdates() int32` + +GetNumberOfUpdates returns the NumberOfUpdates field if non-nil, zero value otherwise. + +### GetNumberOfUpdatesOk + +`func (o *RoleInsightsResponse) GetNumberOfUpdatesOk() (*int32, bool)` + +GetNumberOfUpdatesOk returns a tuple with the NumberOfUpdates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumberOfUpdates + +`func (o *RoleInsightsResponse) SetNumberOfUpdates(v int32)` + +SetNumberOfUpdates sets NumberOfUpdates field to given value. + +### HasNumberOfUpdates + +`func (o *RoleInsightsResponse) HasNumberOfUpdates() bool` + +HasNumberOfUpdates returns a boolean if a field has been set. + +### GetRoleIds + +`func (o *RoleInsightsResponse) GetRoleIds() []string` + +GetRoleIds returns the RoleIds field if non-nil, zero value otherwise. + +### GetRoleIdsOk + +`func (o *RoleInsightsResponse) GetRoleIdsOk() (*[]string, bool)` + +GetRoleIdsOk returns a tuple with the RoleIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleIds + +`func (o *RoleInsightsResponse) SetRoleIds(v []string)` + +SetRoleIds sets RoleIds field to given value. + +### HasRoleIds + +`func (o *RoleInsightsResponse) HasRoleIds() bool` + +HasRoleIds returns a boolean if a field has been set. + +### GetStatus + +`func (o *RoleInsightsResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *RoleInsightsResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *RoleInsightsResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *RoleInsightsResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsRole.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsRole.md new file mode 100644 index 000000000..5b5be6011 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsRole.md @@ -0,0 +1,168 @@ +--- +id: beta-role-insights-role +title: RoleInsightsRole +pagination_label: RoleInsightsRole +sidebar_label: RoleInsightsRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsRole', 'BetaRoleInsightsRole'] +slug: /tools/sdk/go/beta/models/role-insights-role +tags: ['SDK', 'Software Development Kit', 'RoleInsightsRole', 'BetaRoleInsightsRole'] +--- + +# RoleInsightsRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Role name | [optional] +**Id** | Pointer to **string** | Role id | [optional] +**Description** | Pointer to **string** | Role description | [optional] +**OwnerName** | Pointer to **string** | Role owner name | [optional] +**OwnerId** | Pointer to **string** | Role owner id | [optional] + +## Methods + +### NewRoleInsightsRole + +`func NewRoleInsightsRole() *RoleInsightsRole` + +NewRoleInsightsRole instantiates a new RoleInsightsRole 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 + +### NewRoleInsightsRoleWithDefaults + +`func NewRoleInsightsRoleWithDefaults() *RoleInsightsRole` + +NewRoleInsightsRoleWithDefaults instantiates a new RoleInsightsRole 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 + +### GetName + +`func (o *RoleInsightsRole) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleInsightsRole) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleInsightsRole) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleInsightsRole) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetId + +`func (o *RoleInsightsRole) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsightsRole) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsightsRole) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsightsRole) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleInsightsRole) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleInsightsRole) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleInsightsRole) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleInsightsRole) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwnerName + +`func (o *RoleInsightsRole) GetOwnerName() string` + +GetOwnerName returns the OwnerName field if non-nil, zero value otherwise. + +### GetOwnerNameOk + +`func (o *RoleInsightsRole) GetOwnerNameOk() (*string, bool)` + +GetOwnerNameOk returns a tuple with the OwnerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerName + +`func (o *RoleInsightsRole) SetOwnerName(v string)` + +SetOwnerName sets OwnerName field to given value. + +### HasOwnerName + +`func (o *RoleInsightsRole) HasOwnerName() bool` + +HasOwnerName returns a boolean if a field has been set. + +### GetOwnerId + +`func (o *RoleInsightsRole) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *RoleInsightsRole) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *RoleInsightsRole) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *RoleInsightsRole) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsSummary.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsSummary.md new file mode 100644 index 000000000..ea038429e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleInsightsSummary.md @@ -0,0 +1,194 @@ +--- +id: beta-role-insights-summary +title: RoleInsightsSummary +pagination_label: RoleInsightsSummary +sidebar_label: RoleInsightsSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsSummary', 'BetaRoleInsightsSummary'] +slug: /tools/sdk/go/beta/models/role-insights-summary +tags: ['SDK', 'Software Development Kit', 'RoleInsightsSummary', 'BetaRoleInsightsSummary'] +--- + +# RoleInsightsSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NumberOfUpdates** | Pointer to **int32** | Total number of roles with updates | [optional] +**LastGenerated** | Pointer to **SailPointTime** | The date-time role insights were last found. | [optional] +**EntitlementsIncludedInRoles** | Pointer to **int32** | The number of entitlements included in roles (vs free radicals). | [optional] +**TotalNumberOfEntitlements** | Pointer to **int32** | The total number of entitlements. | [optional] +**IdentitiesWithAccessViaRoles** | Pointer to **int32** | The number of identities in roles vs. identities with just entitlements and not in roles. | [optional] +**TotalNumberOfIdentities** | Pointer to **int32** | The total number of identities. | [optional] + +## Methods + +### NewRoleInsightsSummary + +`func NewRoleInsightsSummary() *RoleInsightsSummary` + +NewRoleInsightsSummary instantiates a new RoleInsightsSummary 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 + +### NewRoleInsightsSummaryWithDefaults + +`func NewRoleInsightsSummaryWithDefaults() *RoleInsightsSummary` + +NewRoleInsightsSummaryWithDefaults instantiates a new RoleInsightsSummary 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 + +### GetNumberOfUpdates + +`func (o *RoleInsightsSummary) GetNumberOfUpdates() int32` + +GetNumberOfUpdates returns the NumberOfUpdates field if non-nil, zero value otherwise. + +### GetNumberOfUpdatesOk + +`func (o *RoleInsightsSummary) GetNumberOfUpdatesOk() (*int32, bool)` + +GetNumberOfUpdatesOk returns a tuple with the NumberOfUpdates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumberOfUpdates + +`func (o *RoleInsightsSummary) SetNumberOfUpdates(v int32)` + +SetNumberOfUpdates sets NumberOfUpdates field to given value. + +### HasNumberOfUpdates + +`func (o *RoleInsightsSummary) HasNumberOfUpdates() bool` + +HasNumberOfUpdates returns a boolean if a field has been set. + +### GetLastGenerated + +`func (o *RoleInsightsSummary) GetLastGenerated() SailPointTime` + +GetLastGenerated returns the LastGenerated field if non-nil, zero value otherwise. + +### GetLastGeneratedOk + +`func (o *RoleInsightsSummary) GetLastGeneratedOk() (*SailPointTime, bool)` + +GetLastGeneratedOk returns a tuple with the LastGenerated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastGenerated + +`func (o *RoleInsightsSummary) SetLastGenerated(v SailPointTime)` + +SetLastGenerated sets LastGenerated field to given value. + +### HasLastGenerated + +`func (o *RoleInsightsSummary) HasLastGenerated() bool` + +HasLastGenerated returns a boolean if a field has been set. + +### GetEntitlementsIncludedInRoles + +`func (o *RoleInsightsSummary) GetEntitlementsIncludedInRoles() int32` + +GetEntitlementsIncludedInRoles returns the EntitlementsIncludedInRoles field if non-nil, zero value otherwise. + +### GetEntitlementsIncludedInRolesOk + +`func (o *RoleInsightsSummary) GetEntitlementsIncludedInRolesOk() (*int32, bool)` + +GetEntitlementsIncludedInRolesOk returns a tuple with the EntitlementsIncludedInRoles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementsIncludedInRoles + +`func (o *RoleInsightsSummary) SetEntitlementsIncludedInRoles(v int32)` + +SetEntitlementsIncludedInRoles sets EntitlementsIncludedInRoles field to given value. + +### HasEntitlementsIncludedInRoles + +`func (o *RoleInsightsSummary) HasEntitlementsIncludedInRoles() bool` + +HasEntitlementsIncludedInRoles returns a boolean if a field has been set. + +### GetTotalNumberOfEntitlements + +`func (o *RoleInsightsSummary) GetTotalNumberOfEntitlements() int32` + +GetTotalNumberOfEntitlements returns the TotalNumberOfEntitlements field if non-nil, zero value otherwise. + +### GetTotalNumberOfEntitlementsOk + +`func (o *RoleInsightsSummary) GetTotalNumberOfEntitlementsOk() (*int32, bool)` + +GetTotalNumberOfEntitlementsOk returns a tuple with the TotalNumberOfEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalNumberOfEntitlements + +`func (o *RoleInsightsSummary) SetTotalNumberOfEntitlements(v int32)` + +SetTotalNumberOfEntitlements sets TotalNumberOfEntitlements field to given value. + +### HasTotalNumberOfEntitlements + +`func (o *RoleInsightsSummary) HasTotalNumberOfEntitlements() bool` + +HasTotalNumberOfEntitlements returns a boolean if a field has been set. + +### GetIdentitiesWithAccessViaRoles + +`func (o *RoleInsightsSummary) GetIdentitiesWithAccessViaRoles() int32` + +GetIdentitiesWithAccessViaRoles returns the IdentitiesWithAccessViaRoles field if non-nil, zero value otherwise. + +### GetIdentitiesWithAccessViaRolesOk + +`func (o *RoleInsightsSummary) GetIdentitiesWithAccessViaRolesOk() (*int32, bool)` + +GetIdentitiesWithAccessViaRolesOk returns a tuple with the IdentitiesWithAccessViaRoles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesWithAccessViaRoles + +`func (o *RoleInsightsSummary) SetIdentitiesWithAccessViaRoles(v int32)` + +SetIdentitiesWithAccessViaRoles sets IdentitiesWithAccessViaRoles field to given value. + +### HasIdentitiesWithAccessViaRoles + +`func (o *RoleInsightsSummary) HasIdentitiesWithAccessViaRoles() bool` + +HasIdentitiesWithAccessViaRoles returns a boolean if a field has been set. + +### GetTotalNumberOfIdentities + +`func (o *RoleInsightsSummary) GetTotalNumberOfIdentities() int32` + +GetTotalNumberOfIdentities returns the TotalNumberOfIdentities field if non-nil, zero value otherwise. + +### GetTotalNumberOfIdentitiesOk + +`func (o *RoleInsightsSummary) GetTotalNumberOfIdentitiesOk() (*int32, bool)` + +GetTotalNumberOfIdentitiesOk returns a tuple with the TotalNumberOfIdentities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalNumberOfIdentities + +`func (o *RoleInsightsSummary) SetTotalNumberOfIdentities(v int32)` + +SetTotalNumberOfIdentities sets TotalNumberOfIdentities field to given value. + +### HasTotalNumberOfIdentities + +`func (o *RoleInsightsSummary) HasTotalNumberOfIdentities() bool` + +HasTotalNumberOfIdentities returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMatchDto.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMatchDto.md new file mode 100644 index 000000000..eb80e499c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMatchDto.md @@ -0,0 +1,90 @@ +--- +id: beta-role-match-dto +title: RoleMatchDto +pagination_label: RoleMatchDto +sidebar_label: RoleMatchDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMatchDto', 'BetaRoleMatchDto'] +slug: /tools/sdk/go/beta/models/role-match-dto +tags: ['SDK', 'Software Development Kit', 'RoleMatchDto', 'BetaRoleMatchDto'] +--- + +# RoleMatchDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleRef** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**MatchedAttributes** | Pointer to [**[]ContextAttributeDto**](context-attribute-dto) | | [optional] + +## Methods + +### NewRoleMatchDto + +`func NewRoleMatchDto() *RoleMatchDto` + +NewRoleMatchDto instantiates a new RoleMatchDto 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 + +### NewRoleMatchDtoWithDefaults + +`func NewRoleMatchDtoWithDefaults() *RoleMatchDto` + +NewRoleMatchDtoWithDefaults instantiates a new RoleMatchDto 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 + +### GetRoleRef + +`func (o *RoleMatchDto) GetRoleRef() BaseReferenceDto1` + +GetRoleRef returns the RoleRef field if non-nil, zero value otherwise. + +### GetRoleRefOk + +`func (o *RoleMatchDto) GetRoleRefOk() (*BaseReferenceDto1, bool)` + +GetRoleRefOk returns a tuple with the RoleRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleRef + +`func (o *RoleMatchDto) SetRoleRef(v BaseReferenceDto1)` + +SetRoleRef sets RoleRef field to given value. + +### HasRoleRef + +`func (o *RoleMatchDto) HasRoleRef() bool` + +HasRoleRef returns a boolean if a field has been set. + +### GetMatchedAttributes + +`func (o *RoleMatchDto) GetMatchedAttributes() []ContextAttributeDto` + +GetMatchedAttributes returns the MatchedAttributes field if non-nil, zero value otherwise. + +### GetMatchedAttributesOk + +`func (o *RoleMatchDto) GetMatchedAttributesOk() (*[]ContextAttributeDto, bool)` + +GetMatchedAttributesOk returns a tuple with the MatchedAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchedAttributes + +`func (o *RoleMatchDto) SetMatchedAttributes(v []ContextAttributeDto)` + +SetMatchedAttributes sets MatchedAttributes field to given value. + +### HasMatchedAttributes + +`func (o *RoleMatchDto) HasMatchedAttributes() bool` + +HasMatchedAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMembershipIdentity.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMembershipIdentity.md new file mode 100644 index 000000000..1f856122c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMembershipIdentity.md @@ -0,0 +1,162 @@ +--- +id: beta-role-membership-identity +title: RoleMembershipIdentity +pagination_label: RoleMembershipIdentity +sidebar_label: RoleMembershipIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMembershipIdentity', 'BetaRoleMembershipIdentity'] +slug: /tools/sdk/go/beta/models/role-membership-identity +tags: ['SDK', 'Software Development Kit', 'RoleMembershipIdentity', 'BetaRoleMembershipIdentity'] +--- + +# RoleMembershipIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | Identity id | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the Identity. | [optional] +**AliasName** | Pointer to **NullableString** | User name of the Identity | [optional] + +## Methods + +### NewRoleMembershipIdentity + +`func NewRoleMembershipIdentity() *RoleMembershipIdentity` + +NewRoleMembershipIdentity instantiates a new RoleMembershipIdentity 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 + +### NewRoleMembershipIdentityWithDefaults + +`func NewRoleMembershipIdentityWithDefaults() *RoleMembershipIdentity` + +NewRoleMembershipIdentityWithDefaults instantiates a new RoleMembershipIdentity 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 + +### GetType + +`func (o *RoleMembershipIdentity) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMembershipIdentity) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMembershipIdentity) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMembershipIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RoleMembershipIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMembershipIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMembershipIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMembershipIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMembershipIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMembershipIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMembershipIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMembershipIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RoleMembershipIdentity) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RoleMembershipIdentity) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetAliasName + +`func (o *RoleMembershipIdentity) GetAliasName() string` + +GetAliasName returns the AliasName field if non-nil, zero value otherwise. + +### GetAliasNameOk + +`func (o *RoleMembershipIdentity) GetAliasNameOk() (*string, bool)` + +GetAliasNameOk returns a tuple with the AliasName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAliasName + +`func (o *RoleMembershipIdentity) SetAliasName(v string)` + +SetAliasName sets AliasName field to given value. + +### HasAliasName + +`func (o *RoleMembershipIdentity) HasAliasName() bool` + +HasAliasName returns a boolean if a field has been set. + +### SetAliasNameNil + +`func (o *RoleMembershipIdentity) SetAliasNameNil(b bool)` + + SetAliasNameNil sets the value for AliasName to be an explicit nil + +### UnsetAliasName +`func (o *RoleMembershipIdentity) UnsetAliasName()` + +UnsetAliasName ensures that no value is present for AliasName, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMembershipSelector.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMembershipSelector.md new file mode 100644 index 000000000..005077d1d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMembershipSelector.md @@ -0,0 +1,136 @@ +--- +id: beta-role-membership-selector +title: RoleMembershipSelector +pagination_label: RoleMembershipSelector +sidebar_label: RoleMembershipSelector +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMembershipSelector', 'BetaRoleMembershipSelector'] +slug: /tools/sdk/go/beta/models/role-membership-selector +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelector', 'BetaRoleMembershipSelector'] +--- + +# RoleMembershipSelector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**RoleMembershipSelectorType**](role-membership-selector-type) | | [optional] +**Criteria** | Pointer to [**NullableRoleCriteriaLevel1**](role-criteria-level1) | | [optional] +**Identities** | Pointer to [**[]RoleMembershipIdentity**](role-membership-identity) | Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. | [optional] + +## Methods + +### NewRoleMembershipSelector + +`func NewRoleMembershipSelector() *RoleMembershipSelector` + +NewRoleMembershipSelector instantiates a new RoleMembershipSelector 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 + +### NewRoleMembershipSelectorWithDefaults + +`func NewRoleMembershipSelectorWithDefaults() *RoleMembershipSelector` + +NewRoleMembershipSelectorWithDefaults instantiates a new RoleMembershipSelector 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 + +### GetType + +`func (o *RoleMembershipSelector) GetType() RoleMembershipSelectorType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMembershipSelector) GetTypeOk() (*RoleMembershipSelectorType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMembershipSelector) SetType(v RoleMembershipSelectorType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMembershipSelector) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetCriteria + +`func (o *RoleMembershipSelector) GetCriteria() RoleCriteriaLevel1` + +GetCriteria returns the Criteria field if non-nil, zero value otherwise. + +### GetCriteriaOk + +`func (o *RoleMembershipSelector) GetCriteriaOk() (*RoleCriteriaLevel1, bool)` + +GetCriteriaOk returns a tuple with the Criteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteria + +`func (o *RoleMembershipSelector) SetCriteria(v RoleCriteriaLevel1)` + +SetCriteria sets Criteria field to given value. + +### HasCriteria + +`func (o *RoleMembershipSelector) HasCriteria() bool` + +HasCriteria returns a boolean if a field has been set. + +### SetCriteriaNil + +`func (o *RoleMembershipSelector) SetCriteriaNil(b bool)` + + SetCriteriaNil sets the value for Criteria to be an explicit nil + +### UnsetCriteria +`func (o *RoleMembershipSelector) UnsetCriteria()` + +UnsetCriteria ensures that no value is present for Criteria, not even an explicit nil +### GetIdentities + +`func (o *RoleMembershipSelector) GetIdentities() []RoleMembershipIdentity` + +GetIdentities returns the Identities field if non-nil, zero value otherwise. + +### GetIdentitiesOk + +`func (o *RoleMembershipSelector) GetIdentitiesOk() (*[]RoleMembershipIdentity, bool)` + +GetIdentitiesOk returns a tuple with the Identities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentities + +`func (o *RoleMembershipSelector) SetIdentities(v []RoleMembershipIdentity)` + +SetIdentities sets Identities field to given value. + +### HasIdentities + +`func (o *RoleMembershipSelector) HasIdentities() bool` + +HasIdentities returns a boolean if a field has been set. + +### SetIdentitiesNil + +`func (o *RoleMembershipSelector) SetIdentitiesNil(b bool)` + + SetIdentitiesNil sets the value for Identities to be an explicit nil + +### UnsetIdentities +`func (o *RoleMembershipSelector) UnsetIdentities()` + +UnsetIdentities ensures that no value is present for Identities, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMembershipSelectorType.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMembershipSelectorType.md new file mode 100644 index 000000000..5dafdd073 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMembershipSelectorType.md @@ -0,0 +1,21 @@ +--- +id: beta-role-membership-selector-type +title: RoleMembershipSelectorType +pagination_label: RoleMembershipSelectorType +sidebar_label: RoleMembershipSelectorType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMembershipSelectorType', 'BetaRoleMembershipSelectorType'] +slug: /tools/sdk/go/beta/models/role-membership-selector-type +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelectorType', 'BetaRoleMembershipSelectorType'] +--- + +# RoleMembershipSelectorType + +## Enum + + +* `STANDARD` (value: `"STANDARD"`) + +* `IDENTITY_LIST` (value: `"IDENTITY_LIST"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningEntitlement.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningEntitlement.md new file mode 100644 index 000000000..5c837d759 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningEntitlement.md @@ -0,0 +1,292 @@ +--- +id: beta-role-mining-entitlement +title: RoleMiningEntitlement +pagination_label: RoleMiningEntitlement +sidebar_label: RoleMiningEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningEntitlement', 'BetaRoleMiningEntitlement'] +slug: /tools/sdk/go/beta/models/role-mining-entitlement +tags: ['SDK', 'Software Development Kit', 'RoleMiningEntitlement', 'BetaRoleMiningEntitlement'] +--- + +# RoleMiningEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EntitlementRef** | Pointer to [**RoleMiningEntitlementRef**](role-mining-entitlement-ref) | | [optional] +**Name** | Pointer to **string** | Name of the entitlement | [optional] +**ApplicationName** | Pointer to **string** | Application name of the entitlement | [optional] +**IdentityCount** | Pointer to **int32** | The number of identities with this entitlement in a role. | [optional] +**Popularity** | Pointer to **float32** | The % popularity of this entitlement in a role. | [optional] +**PopularityInOrg** | Pointer to **float32** | The % popularity of this entitlement in the org. | [optional] +**SourceId** | Pointer to **string** | The ID of the source/application. | [optional] +**ActivitySourceState** | Pointer to **NullableString** | The status of activity data for the source. Value is complete or notComplete. | [optional] +**SourceUsagePercent** | Pointer to **NullableFloat32** | The percentage of identities in the potential role that have usage of the source/application of this entitlement. | [optional] + +## Methods + +### NewRoleMiningEntitlement + +`func NewRoleMiningEntitlement() *RoleMiningEntitlement` + +NewRoleMiningEntitlement instantiates a new RoleMiningEntitlement 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 + +### NewRoleMiningEntitlementWithDefaults + +`func NewRoleMiningEntitlementWithDefaults() *RoleMiningEntitlement` + +NewRoleMiningEntitlementWithDefaults instantiates a new RoleMiningEntitlement 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 + +### GetEntitlementRef + +`func (o *RoleMiningEntitlement) GetEntitlementRef() RoleMiningEntitlementRef` + +GetEntitlementRef returns the EntitlementRef field if non-nil, zero value otherwise. + +### GetEntitlementRefOk + +`func (o *RoleMiningEntitlement) GetEntitlementRefOk() (*RoleMiningEntitlementRef, bool)` + +GetEntitlementRefOk returns a tuple with the EntitlementRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementRef + +`func (o *RoleMiningEntitlement) SetEntitlementRef(v RoleMiningEntitlementRef)` + +SetEntitlementRef sets EntitlementRef field to given value. + +### HasEntitlementRef + +`func (o *RoleMiningEntitlement) HasEntitlementRef() bool` + +HasEntitlementRef returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningEntitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningEntitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningEntitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningEntitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetApplicationName + +`func (o *RoleMiningEntitlement) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *RoleMiningEntitlement) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *RoleMiningEntitlement) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *RoleMiningEntitlement) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *RoleMiningEntitlement) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *RoleMiningEntitlement) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *RoleMiningEntitlement) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *RoleMiningEntitlement) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetPopularity + +`func (o *RoleMiningEntitlement) GetPopularity() float32` + +GetPopularity returns the Popularity field if non-nil, zero value otherwise. + +### GetPopularityOk + +`func (o *RoleMiningEntitlement) GetPopularityOk() (*float32, bool)` + +GetPopularityOk returns a tuple with the Popularity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPopularity + +`func (o *RoleMiningEntitlement) SetPopularity(v float32)` + +SetPopularity sets Popularity field to given value. + +### HasPopularity + +`func (o *RoleMiningEntitlement) HasPopularity() bool` + +HasPopularity returns a boolean if a field has been set. + +### GetPopularityInOrg + +`func (o *RoleMiningEntitlement) GetPopularityInOrg() float32` + +GetPopularityInOrg returns the PopularityInOrg field if non-nil, zero value otherwise. + +### GetPopularityInOrgOk + +`func (o *RoleMiningEntitlement) GetPopularityInOrgOk() (*float32, bool)` + +GetPopularityInOrgOk returns a tuple with the PopularityInOrg field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPopularityInOrg + +`func (o *RoleMiningEntitlement) SetPopularityInOrg(v float32)` + +SetPopularityInOrg sets PopularityInOrg field to given value. + +### HasPopularityInOrg + +`func (o *RoleMiningEntitlement) HasPopularityInOrg() bool` + +HasPopularityInOrg returns a boolean if a field has been set. + +### GetSourceId + +`func (o *RoleMiningEntitlement) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *RoleMiningEntitlement) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *RoleMiningEntitlement) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *RoleMiningEntitlement) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetActivitySourceState + +`func (o *RoleMiningEntitlement) GetActivitySourceState() string` + +GetActivitySourceState returns the ActivitySourceState field if non-nil, zero value otherwise. + +### GetActivitySourceStateOk + +`func (o *RoleMiningEntitlement) GetActivitySourceStateOk() (*string, bool)` + +GetActivitySourceStateOk returns a tuple with the ActivitySourceState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActivitySourceState + +`func (o *RoleMiningEntitlement) SetActivitySourceState(v string)` + +SetActivitySourceState sets ActivitySourceState field to given value. + +### HasActivitySourceState + +`func (o *RoleMiningEntitlement) HasActivitySourceState() bool` + +HasActivitySourceState returns a boolean if a field has been set. + +### SetActivitySourceStateNil + +`func (o *RoleMiningEntitlement) SetActivitySourceStateNil(b bool)` + + SetActivitySourceStateNil sets the value for ActivitySourceState to be an explicit nil + +### UnsetActivitySourceState +`func (o *RoleMiningEntitlement) UnsetActivitySourceState()` + +UnsetActivitySourceState ensures that no value is present for ActivitySourceState, not even an explicit nil +### GetSourceUsagePercent + +`func (o *RoleMiningEntitlement) GetSourceUsagePercent() float32` + +GetSourceUsagePercent returns the SourceUsagePercent field if non-nil, zero value otherwise. + +### GetSourceUsagePercentOk + +`func (o *RoleMiningEntitlement) GetSourceUsagePercentOk() (*float32, bool)` + +GetSourceUsagePercentOk returns a tuple with the SourceUsagePercent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceUsagePercent + +`func (o *RoleMiningEntitlement) SetSourceUsagePercent(v float32)` + +SetSourceUsagePercent sets SourceUsagePercent field to given value. + +### HasSourceUsagePercent + +`func (o *RoleMiningEntitlement) HasSourceUsagePercent() bool` + +HasSourceUsagePercent returns a boolean if a field has been set. + +### SetSourceUsagePercentNil + +`func (o *RoleMiningEntitlement) SetSourceUsagePercentNil(b bool)` + + SetSourceUsagePercentNil sets the value for SourceUsagePercent to be an explicit nil + +### UnsetSourceUsagePercent +`func (o *RoleMiningEntitlement) UnsetSourceUsagePercent()` + +UnsetSourceUsagePercent ensures that no value is present for SourceUsagePercent, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningEntitlementRef.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningEntitlementRef.md new file mode 100644 index 000000000..98baab7c1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningEntitlementRef.md @@ -0,0 +1,152 @@ +--- +id: beta-role-mining-entitlement-ref +title: RoleMiningEntitlementRef +pagination_label: RoleMiningEntitlementRef +sidebar_label: RoleMiningEntitlementRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningEntitlementRef', 'BetaRoleMiningEntitlementRef'] +slug: /tools/sdk/go/beta/models/role-mining-entitlement-ref +tags: ['SDK', 'Software Development Kit', 'RoleMiningEntitlementRef', 'BetaRoleMiningEntitlementRef'] +--- + +# RoleMiningEntitlementRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the entitlement | [optional] +**Name** | Pointer to **string** | Name of the entitlement | [optional] +**Description** | Pointer to **NullableString** | Description forthe entitlement | [optional] +**Attribute** | Pointer to **string** | The entitlement attribute | [optional] + +## Methods + +### NewRoleMiningEntitlementRef + +`func NewRoleMiningEntitlementRef() *RoleMiningEntitlementRef` + +NewRoleMiningEntitlementRef instantiates a new RoleMiningEntitlementRef 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 + +### NewRoleMiningEntitlementRefWithDefaults + +`func NewRoleMiningEntitlementRefWithDefaults() *RoleMiningEntitlementRef` + +NewRoleMiningEntitlementRefWithDefaults instantiates a new RoleMiningEntitlementRef 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 + +### GetId + +`func (o *RoleMiningEntitlementRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningEntitlementRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningEntitlementRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningEntitlementRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningEntitlementRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningEntitlementRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningEntitlementRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningEntitlementRef) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleMiningEntitlementRef) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleMiningEntitlementRef) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleMiningEntitlementRef) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleMiningEntitlementRef) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleMiningEntitlementRef) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleMiningEntitlementRef) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAttribute + +`func (o *RoleMiningEntitlementRef) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleMiningEntitlementRef) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleMiningEntitlementRef) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleMiningEntitlementRef) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningIdentity.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningIdentity.md new file mode 100644 index 000000000..ec95b177f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningIdentity.md @@ -0,0 +1,116 @@ +--- +id: beta-role-mining-identity +title: RoleMiningIdentity +pagination_label: RoleMiningIdentity +sidebar_label: RoleMiningIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningIdentity', 'BetaRoleMiningIdentity'] +slug: /tools/sdk/go/beta/models/role-mining-identity +tags: ['SDK', 'Software Development Kit', 'RoleMiningIdentity', 'BetaRoleMiningIdentity'] +--- + +# RoleMiningIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the identity | [optional] +**Name** | Pointer to **string** | Name of the identity | [optional] +**Attributes** | Pointer to **map[string]string** | | [optional] + +## Methods + +### NewRoleMiningIdentity + +`func NewRoleMiningIdentity() *RoleMiningIdentity` + +NewRoleMiningIdentity instantiates a new RoleMiningIdentity 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 + +### NewRoleMiningIdentityWithDefaults + +`func NewRoleMiningIdentityWithDefaults() *RoleMiningIdentity` + +NewRoleMiningIdentityWithDefaults instantiates a new RoleMiningIdentity 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 + +### GetId + +`func (o *RoleMiningIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAttributes + +`func (o *RoleMiningIdentity) GetAttributes() map[string]string` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *RoleMiningIdentity) GetAttributesOk() (*map[string]string, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *RoleMiningIdentity) SetAttributes(v map[string]string)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *RoleMiningIdentity) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningIdentityDistribution.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningIdentityDistribution.md new file mode 100644 index 000000000..7e25ede2a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningIdentityDistribution.md @@ -0,0 +1,90 @@ +--- +id: beta-role-mining-identity-distribution +title: RoleMiningIdentityDistribution +pagination_label: RoleMiningIdentityDistribution +sidebar_label: RoleMiningIdentityDistribution +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningIdentityDistribution', 'BetaRoleMiningIdentityDistribution'] +slug: /tools/sdk/go/beta/models/role-mining-identity-distribution +tags: ['SDK', 'Software Development Kit', 'RoleMiningIdentityDistribution', 'BetaRoleMiningIdentityDistribution'] +--- + +# RoleMiningIdentityDistribution + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeName** | Pointer to **string** | Id of the potential role | [optional] +**Distribution** | Pointer to **[]map[string]string** | | [optional] + +## Methods + +### NewRoleMiningIdentityDistribution + +`func NewRoleMiningIdentityDistribution() *RoleMiningIdentityDistribution` + +NewRoleMiningIdentityDistribution instantiates a new RoleMiningIdentityDistribution 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 + +### NewRoleMiningIdentityDistributionWithDefaults + +`func NewRoleMiningIdentityDistributionWithDefaults() *RoleMiningIdentityDistribution` + +NewRoleMiningIdentityDistributionWithDefaults instantiates a new RoleMiningIdentityDistribution 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 + +### GetAttributeName + +`func (o *RoleMiningIdentityDistribution) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *RoleMiningIdentityDistribution) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *RoleMiningIdentityDistribution) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *RoleMiningIdentityDistribution) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + +### GetDistribution + +`func (o *RoleMiningIdentityDistribution) GetDistribution() []map[string]string` + +GetDistribution returns the Distribution field if non-nil, zero value otherwise. + +### GetDistributionOk + +`func (o *RoleMiningIdentityDistribution) GetDistributionOk() (*[]map[string]string, bool)` + +GetDistributionOk returns a tuple with the Distribution field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDistribution + +`func (o *RoleMiningIdentityDistribution) SetDistribution(v []map[string]string)` + +SetDistribution sets Distribution field to given value. + +### HasDistribution + +`func (o *RoleMiningIdentityDistribution) HasDistribution() bool` + +HasDistribution returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRole.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRole.md new file mode 100644 index 000000000..8f7436029 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRole.md @@ -0,0 +1,572 @@ +--- +id: beta-role-mining-potential-role +title: RoleMiningPotentialRole +pagination_label: RoleMiningPotentialRole +sidebar_label: RoleMiningPotentialRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRole', 'BetaRoleMiningPotentialRole'] +slug: /tools/sdk/go/beta/models/role-mining-potential-role +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRole', 'BetaRoleMiningPotentialRole'] +--- + +# RoleMiningPotentialRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedBy** | Pointer to [**RoleMiningSessionResponseCreatedBy**](role-mining-session-response-created-by) | | [optional] +**Density** | Pointer to **int32** | The density of a potential role. | [optional] +**Description** | Pointer to **NullableString** | The description of a potential role. | [optional] +**EntitlementCount** | Pointer to **int32** | The number of entitlements in a potential role. | [optional] +**ExcludedEntitlements** | Pointer to **[]string** | The list of entitlement ids to be excluded. | [optional] +**Freshness** | Pointer to **int32** | The freshness of a potential role. | [optional] +**IdentityCount** | Pointer to **int32** | The number of identities in a potential role. | [optional] +**IdentityDistribution** | Pointer to [**[]RoleMiningIdentityDistribution**](role-mining-identity-distribution) | Identity attribute distribution. | [optional] +**IdentityIds** | Pointer to **[]string** | The list of ids in a potential role. | [optional] +**Name** | Pointer to **string** | Name of the potential role. | [optional] +**ProvisionState** | Pointer to [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional] +**Quality** | Pointer to **int32** | The quality of a potential role. | [optional] +**RoleId** | Pointer to **NullableString** | The roleId of a potential role. | [optional] +**Saved** | Pointer to **bool** | The potential role's saved status. | [optional] +**Session** | Pointer to [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**Id** | Pointer to **string** | Id of the potential role | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time when this potential role was created. | [optional] +**ModifiedDate** | Pointer to **SailPointTime** | The date-time when this potential role was modified. | [optional] + +## Methods + +### NewRoleMiningPotentialRole + +`func NewRoleMiningPotentialRole() *RoleMiningPotentialRole` + +NewRoleMiningPotentialRole instantiates a new RoleMiningPotentialRole 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 + +### NewRoleMiningPotentialRoleWithDefaults + +`func NewRoleMiningPotentialRoleWithDefaults() *RoleMiningPotentialRole` + +NewRoleMiningPotentialRoleWithDefaults instantiates a new RoleMiningPotentialRole 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 + +### GetCreatedBy + +`func (o *RoleMiningPotentialRole) GetCreatedBy() RoleMiningSessionResponseCreatedBy` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *RoleMiningPotentialRole) GetCreatedByOk() (*RoleMiningSessionResponseCreatedBy, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *RoleMiningPotentialRole) SetCreatedBy(v RoleMiningSessionResponseCreatedBy)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *RoleMiningPotentialRole) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetDensity + +`func (o *RoleMiningPotentialRole) GetDensity() int32` + +GetDensity returns the Density field if non-nil, zero value otherwise. + +### GetDensityOk + +`func (o *RoleMiningPotentialRole) GetDensityOk() (*int32, bool)` + +GetDensityOk returns a tuple with the Density field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDensity + +`func (o *RoleMiningPotentialRole) SetDensity(v int32)` + +SetDensity sets Density field to given value. + +### HasDensity + +`func (o *RoleMiningPotentialRole) HasDensity() bool` + +HasDensity returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleMiningPotentialRole) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleMiningPotentialRole) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleMiningPotentialRole) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleMiningPotentialRole) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleMiningPotentialRole) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleMiningPotentialRole) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetEntitlementCount + +`func (o *RoleMiningPotentialRole) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *RoleMiningPotentialRole) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *RoleMiningPotentialRole) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *RoleMiningPotentialRole) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetExcludedEntitlements + +`func (o *RoleMiningPotentialRole) GetExcludedEntitlements() []string` + +GetExcludedEntitlements returns the ExcludedEntitlements field if non-nil, zero value otherwise. + +### GetExcludedEntitlementsOk + +`func (o *RoleMiningPotentialRole) GetExcludedEntitlementsOk() (*[]string, bool)` + +GetExcludedEntitlementsOk returns a tuple with the ExcludedEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludedEntitlements + +`func (o *RoleMiningPotentialRole) SetExcludedEntitlements(v []string)` + +SetExcludedEntitlements sets ExcludedEntitlements field to given value. + +### HasExcludedEntitlements + +`func (o *RoleMiningPotentialRole) HasExcludedEntitlements() bool` + +HasExcludedEntitlements returns a boolean if a field has been set. + +### SetExcludedEntitlementsNil + +`func (o *RoleMiningPotentialRole) SetExcludedEntitlementsNil(b bool)` + + SetExcludedEntitlementsNil sets the value for ExcludedEntitlements to be an explicit nil + +### UnsetExcludedEntitlements +`func (o *RoleMiningPotentialRole) UnsetExcludedEntitlements()` + +UnsetExcludedEntitlements ensures that no value is present for ExcludedEntitlements, not even an explicit nil +### GetFreshness + +`func (o *RoleMiningPotentialRole) GetFreshness() int32` + +GetFreshness returns the Freshness field if non-nil, zero value otherwise. + +### GetFreshnessOk + +`func (o *RoleMiningPotentialRole) GetFreshnessOk() (*int32, bool)` + +GetFreshnessOk returns a tuple with the Freshness field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFreshness + +`func (o *RoleMiningPotentialRole) SetFreshness(v int32)` + +SetFreshness sets Freshness field to given value. + +### HasFreshness + +`func (o *RoleMiningPotentialRole) HasFreshness() bool` + +HasFreshness returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *RoleMiningPotentialRole) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *RoleMiningPotentialRole) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *RoleMiningPotentialRole) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *RoleMiningPotentialRole) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetIdentityDistribution + +`func (o *RoleMiningPotentialRole) GetIdentityDistribution() []RoleMiningIdentityDistribution` + +GetIdentityDistribution returns the IdentityDistribution field if non-nil, zero value otherwise. + +### GetIdentityDistributionOk + +`func (o *RoleMiningPotentialRole) GetIdentityDistributionOk() (*[]RoleMiningIdentityDistribution, bool)` + +GetIdentityDistributionOk returns a tuple with the IdentityDistribution field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityDistribution + +`func (o *RoleMiningPotentialRole) SetIdentityDistribution(v []RoleMiningIdentityDistribution)` + +SetIdentityDistribution sets IdentityDistribution field to given value. + +### HasIdentityDistribution + +`func (o *RoleMiningPotentialRole) HasIdentityDistribution() bool` + +HasIdentityDistribution returns a boolean if a field has been set. + +### SetIdentityDistributionNil + +`func (o *RoleMiningPotentialRole) SetIdentityDistributionNil(b bool)` + + SetIdentityDistributionNil sets the value for IdentityDistribution to be an explicit nil + +### UnsetIdentityDistribution +`func (o *RoleMiningPotentialRole) UnsetIdentityDistribution()` + +UnsetIdentityDistribution ensures that no value is present for IdentityDistribution, not even an explicit nil +### GetIdentityIds + +`func (o *RoleMiningPotentialRole) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *RoleMiningPotentialRole) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *RoleMiningPotentialRole) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *RoleMiningPotentialRole) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningPotentialRole) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningPotentialRole) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningPotentialRole) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningPotentialRole) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetProvisionState + +`func (o *RoleMiningPotentialRole) GetProvisionState() RoleMiningPotentialRoleProvisionState` + +GetProvisionState returns the ProvisionState field if non-nil, zero value otherwise. + +### GetProvisionStateOk + +`func (o *RoleMiningPotentialRole) GetProvisionStateOk() (*RoleMiningPotentialRoleProvisionState, bool)` + +GetProvisionStateOk returns a tuple with the ProvisionState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionState + +`func (o *RoleMiningPotentialRole) SetProvisionState(v RoleMiningPotentialRoleProvisionState)` + +SetProvisionState sets ProvisionState field to given value. + +### HasProvisionState + +`func (o *RoleMiningPotentialRole) HasProvisionState() bool` + +HasProvisionState returns a boolean if a field has been set. + +### GetQuality + +`func (o *RoleMiningPotentialRole) GetQuality() int32` + +GetQuality returns the Quality field if non-nil, zero value otherwise. + +### GetQualityOk + +`func (o *RoleMiningPotentialRole) GetQualityOk() (*int32, bool)` + +GetQualityOk returns a tuple with the Quality field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuality + +`func (o *RoleMiningPotentialRole) SetQuality(v int32)` + +SetQuality sets Quality field to given value. + +### HasQuality + +`func (o *RoleMiningPotentialRole) HasQuality() bool` + +HasQuality returns a boolean if a field has been set. + +### GetRoleId + +`func (o *RoleMiningPotentialRole) GetRoleId() string` + +GetRoleId returns the RoleId field if non-nil, zero value otherwise. + +### GetRoleIdOk + +`func (o *RoleMiningPotentialRole) GetRoleIdOk() (*string, bool)` + +GetRoleIdOk returns a tuple with the RoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleId + +`func (o *RoleMiningPotentialRole) SetRoleId(v string)` + +SetRoleId sets RoleId field to given value. + +### HasRoleId + +`func (o *RoleMiningPotentialRole) HasRoleId() bool` + +HasRoleId returns a boolean if a field has been set. + +### SetRoleIdNil + +`func (o *RoleMiningPotentialRole) SetRoleIdNil(b bool)` + + SetRoleIdNil sets the value for RoleId to be an explicit nil + +### UnsetRoleId +`func (o *RoleMiningPotentialRole) UnsetRoleId()` + +UnsetRoleId ensures that no value is present for RoleId, not even an explicit nil +### GetSaved + +`func (o *RoleMiningPotentialRole) GetSaved() bool` + +GetSaved returns the Saved field if non-nil, zero value otherwise. + +### GetSavedOk + +`func (o *RoleMiningPotentialRole) GetSavedOk() (*bool, bool)` + +GetSavedOk returns a tuple with the Saved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSaved + +`func (o *RoleMiningPotentialRole) SetSaved(v bool)` + +SetSaved sets Saved field to given value. + +### HasSaved + +`func (o *RoleMiningPotentialRole) HasSaved() bool` + +HasSaved returns a boolean if a field has been set. + +### GetSession + +`func (o *RoleMiningPotentialRole) GetSession() RoleMiningSessionParametersDto` + +GetSession returns the Session field if non-nil, zero value otherwise. + +### GetSessionOk + +`func (o *RoleMiningPotentialRole) GetSessionOk() (*RoleMiningSessionParametersDto, bool)` + +GetSessionOk returns a tuple with the Session field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSession + +`func (o *RoleMiningPotentialRole) SetSession(v RoleMiningSessionParametersDto)` + +SetSession sets Session field to given value. + +### HasSession + +`func (o *RoleMiningPotentialRole) HasSession() bool` + +HasSession returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningPotentialRole) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningPotentialRole) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningPotentialRole) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningPotentialRole) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RoleMiningPotentialRole) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRole) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRole) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRole) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleMiningPotentialRole) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleMiningPotentialRole) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleMiningPotentialRole) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleMiningPotentialRole) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetModifiedDate + +`func (o *RoleMiningPotentialRole) GetModifiedDate() SailPointTime` + +GetModifiedDate returns the ModifiedDate field if non-nil, zero value otherwise. + +### GetModifiedDateOk + +`func (o *RoleMiningPotentialRole) GetModifiedDateOk() (*SailPointTime, bool)` + +GetModifiedDateOk returns a tuple with the ModifiedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedDate + +`func (o *RoleMiningPotentialRole) SetModifiedDate(v SailPointTime)` + +SetModifiedDate sets ModifiedDate field to given value. + +### HasModifiedDate + +`func (o *RoleMiningPotentialRole) HasModifiedDate() bool` + +HasModifiedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleApplication.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleApplication.md new file mode 100644 index 000000000..3add7f615 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleApplication.md @@ -0,0 +1,90 @@ +--- +id: beta-role-mining-potential-role-application +title: RoleMiningPotentialRoleApplication +pagination_label: RoleMiningPotentialRoleApplication +sidebar_label: RoleMiningPotentialRoleApplication +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleApplication', 'BetaRoleMiningPotentialRoleApplication'] +slug: /tools/sdk/go/beta/models/role-mining-potential-role-application +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleApplication', 'BetaRoleMiningPotentialRoleApplication'] +--- + +# RoleMiningPotentialRoleApplication + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the application | [optional] +**Name** | Pointer to **string** | Name of the application | [optional] + +## Methods + +### NewRoleMiningPotentialRoleApplication + +`func NewRoleMiningPotentialRoleApplication() *RoleMiningPotentialRoleApplication` + +NewRoleMiningPotentialRoleApplication instantiates a new RoleMiningPotentialRoleApplication 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 + +### NewRoleMiningPotentialRoleApplicationWithDefaults + +`func NewRoleMiningPotentialRoleApplicationWithDefaults() *RoleMiningPotentialRoleApplication` + +NewRoleMiningPotentialRoleApplicationWithDefaults instantiates a new RoleMiningPotentialRoleApplication 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 + +### GetId + +`func (o *RoleMiningPotentialRoleApplication) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleApplication) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleApplication) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleApplication) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningPotentialRoleApplication) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningPotentialRoleApplication) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningPotentialRoleApplication) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningPotentialRoleApplication) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleEditEntitlements.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleEditEntitlements.md new file mode 100644 index 000000000..9e73c8d30 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleEditEntitlements.md @@ -0,0 +1,90 @@ +--- +id: beta-role-mining-potential-role-edit-entitlements +title: RoleMiningPotentialRoleEditEntitlements +pagination_label: RoleMiningPotentialRoleEditEntitlements +sidebar_label: RoleMiningPotentialRoleEditEntitlements +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleEditEntitlements', 'BetaRoleMiningPotentialRoleEditEntitlements'] +slug: /tools/sdk/go/beta/models/role-mining-potential-role-edit-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleEditEntitlements', 'BetaRoleMiningPotentialRoleEditEntitlements'] +--- + +# RoleMiningPotentialRoleEditEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]string** | The list of entitlement ids to be edited | [optional] +**Exclude** | Pointer to **bool** | If true, add ids to be exclusion list. If false, remove ids from the exclusion list. | [optional] + +## Methods + +### NewRoleMiningPotentialRoleEditEntitlements + +`func NewRoleMiningPotentialRoleEditEntitlements() *RoleMiningPotentialRoleEditEntitlements` + +NewRoleMiningPotentialRoleEditEntitlements instantiates a new RoleMiningPotentialRoleEditEntitlements 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 + +### NewRoleMiningPotentialRoleEditEntitlementsWithDefaults + +`func NewRoleMiningPotentialRoleEditEntitlementsWithDefaults() *RoleMiningPotentialRoleEditEntitlements` + +NewRoleMiningPotentialRoleEditEntitlementsWithDefaults instantiates a new RoleMiningPotentialRoleEditEntitlements 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 + +### GetIds + +`func (o *RoleMiningPotentialRoleEditEntitlements) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *RoleMiningPotentialRoleEditEntitlements) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *RoleMiningPotentialRoleEditEntitlements) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *RoleMiningPotentialRoleEditEntitlements) HasIds() bool` + +HasIds returns a boolean if a field has been set. + +### GetExclude + +`func (o *RoleMiningPotentialRoleEditEntitlements) GetExclude() bool` + +GetExclude returns the Exclude field if non-nil, zero value otherwise. + +### GetExcludeOk + +`func (o *RoleMiningPotentialRoleEditEntitlements) GetExcludeOk() (*bool, bool)` + +GetExcludeOk returns a tuple with the Exclude field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExclude + +`func (o *RoleMiningPotentialRoleEditEntitlements) SetExclude(v bool)` + +SetExclude sets Exclude field to given value. + +### HasExclude + +`func (o *RoleMiningPotentialRoleEditEntitlements) HasExclude() bool` + +HasExclude returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleEntitlements.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleEntitlements.md new file mode 100644 index 000000000..786c463f2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleEntitlements.md @@ -0,0 +1,90 @@ +--- +id: beta-role-mining-potential-role-entitlements +title: RoleMiningPotentialRoleEntitlements +pagination_label: RoleMiningPotentialRoleEntitlements +sidebar_label: RoleMiningPotentialRoleEntitlements +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleEntitlements', 'BetaRoleMiningPotentialRoleEntitlements'] +slug: /tools/sdk/go/beta/models/role-mining-potential-role-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleEntitlements', 'BetaRoleMiningPotentialRoleEntitlements'] +--- + +# RoleMiningPotentialRoleEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the entitlement | [optional] +**Name** | Pointer to **string** | Name of the entitlement | [optional] + +## Methods + +### NewRoleMiningPotentialRoleEntitlements + +`func NewRoleMiningPotentialRoleEntitlements() *RoleMiningPotentialRoleEntitlements` + +NewRoleMiningPotentialRoleEntitlements instantiates a new RoleMiningPotentialRoleEntitlements 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 + +### NewRoleMiningPotentialRoleEntitlementsWithDefaults + +`func NewRoleMiningPotentialRoleEntitlementsWithDefaults() *RoleMiningPotentialRoleEntitlements` + +NewRoleMiningPotentialRoleEntitlementsWithDefaults instantiates a new RoleMiningPotentialRoleEntitlements 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 + +### GetId + +`func (o *RoleMiningPotentialRoleEntitlements) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleEntitlements) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleEntitlements) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleEntitlements) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningPotentialRoleEntitlements) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningPotentialRoleEntitlements) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningPotentialRoleEntitlements) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningPotentialRoleEntitlements) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleExportRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleExportRequest.md new file mode 100644 index 000000000..67f9422d7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleExportRequest.md @@ -0,0 +1,90 @@ +--- +id: beta-role-mining-potential-role-export-request +title: RoleMiningPotentialRoleExportRequest +pagination_label: RoleMiningPotentialRoleExportRequest +sidebar_label: RoleMiningPotentialRoleExportRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleExportRequest', 'BetaRoleMiningPotentialRoleExportRequest'] +slug: /tools/sdk/go/beta/models/role-mining-potential-role-export-request +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportRequest', 'BetaRoleMiningPotentialRoleExportRequest'] +--- + +# RoleMiningPotentialRoleExportRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MinEntitlementPopularity** | Pointer to **int32** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [optional] +**IncludeCommonAccess** | Pointer to **bool** | If false, do not include entitlements that are highly popular among the entire orginization | [optional] + +## Methods + +### NewRoleMiningPotentialRoleExportRequest + +`func NewRoleMiningPotentialRoleExportRequest() *RoleMiningPotentialRoleExportRequest` + +NewRoleMiningPotentialRoleExportRequest instantiates a new RoleMiningPotentialRoleExportRequest 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 + +### NewRoleMiningPotentialRoleExportRequestWithDefaults + +`func NewRoleMiningPotentialRoleExportRequestWithDefaults() *RoleMiningPotentialRoleExportRequest` + +NewRoleMiningPotentialRoleExportRequestWithDefaults instantiates a new RoleMiningPotentialRoleExportRequest 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 + +### GetMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportRequest) GetMinEntitlementPopularity() int32` + +GetMinEntitlementPopularity returns the MinEntitlementPopularity field if non-nil, zero value otherwise. + +### GetMinEntitlementPopularityOk + +`func (o *RoleMiningPotentialRoleExportRequest) GetMinEntitlementPopularityOk() (*int32, bool)` + +GetMinEntitlementPopularityOk returns a tuple with the MinEntitlementPopularity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportRequest) SetMinEntitlementPopularity(v int32)` + +SetMinEntitlementPopularity sets MinEntitlementPopularity field to given value. + +### HasMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportRequest) HasMinEntitlementPopularity() bool` + +HasMinEntitlementPopularity returns a boolean if a field has been set. + +### GetIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportRequest) GetIncludeCommonAccess() bool` + +GetIncludeCommonAccess returns the IncludeCommonAccess field if non-nil, zero value otherwise. + +### GetIncludeCommonAccessOk + +`func (o *RoleMiningPotentialRoleExportRequest) GetIncludeCommonAccessOk() (*bool, bool)` + +GetIncludeCommonAccessOk returns a tuple with the IncludeCommonAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportRequest) SetIncludeCommonAccess(v bool)` + +SetIncludeCommonAccess sets IncludeCommonAccess field to given value. + +### HasIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportRequest) HasIncludeCommonAccess() bool` + +HasIncludeCommonAccess returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleExportResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleExportResponse.md new file mode 100644 index 000000000..61e44d5d7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleExportResponse.md @@ -0,0 +1,142 @@ +--- +id: beta-role-mining-potential-role-export-response +title: RoleMiningPotentialRoleExportResponse +pagination_label: RoleMiningPotentialRoleExportResponse +sidebar_label: RoleMiningPotentialRoleExportResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleExportResponse', 'BetaRoleMiningPotentialRoleExportResponse'] +slug: /tools/sdk/go/beta/models/role-mining-potential-role-export-response +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportResponse', 'BetaRoleMiningPotentialRoleExportResponse'] +--- + +# RoleMiningPotentialRoleExportResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MinEntitlementPopularity** | Pointer to **int32** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [optional] +**IncludeCommonAccess** | Pointer to **bool** | If false, do not include entitlements that are highly popular among the entire orginization | [optional] +**ExportId** | Pointer to **string** | ID used to reference this export | [optional] +**Status** | Pointer to [**RoleMiningPotentialRoleExportState**](role-mining-potential-role-export-state) | | [optional] + +## Methods + +### NewRoleMiningPotentialRoleExportResponse + +`func NewRoleMiningPotentialRoleExportResponse() *RoleMiningPotentialRoleExportResponse` + +NewRoleMiningPotentialRoleExportResponse instantiates a new RoleMiningPotentialRoleExportResponse 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 + +### NewRoleMiningPotentialRoleExportResponseWithDefaults + +`func NewRoleMiningPotentialRoleExportResponseWithDefaults() *RoleMiningPotentialRoleExportResponse` + +NewRoleMiningPotentialRoleExportResponseWithDefaults instantiates a new RoleMiningPotentialRoleExportResponse 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 + +### GetMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportResponse) GetMinEntitlementPopularity() int32` + +GetMinEntitlementPopularity returns the MinEntitlementPopularity field if non-nil, zero value otherwise. + +### GetMinEntitlementPopularityOk + +`func (o *RoleMiningPotentialRoleExportResponse) GetMinEntitlementPopularityOk() (*int32, bool)` + +GetMinEntitlementPopularityOk returns a tuple with the MinEntitlementPopularity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportResponse) SetMinEntitlementPopularity(v int32)` + +SetMinEntitlementPopularity sets MinEntitlementPopularity field to given value. + +### HasMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportResponse) HasMinEntitlementPopularity() bool` + +HasMinEntitlementPopularity returns a boolean if a field has been set. + +### GetIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportResponse) GetIncludeCommonAccess() bool` + +GetIncludeCommonAccess returns the IncludeCommonAccess field if non-nil, zero value otherwise. + +### GetIncludeCommonAccessOk + +`func (o *RoleMiningPotentialRoleExportResponse) GetIncludeCommonAccessOk() (*bool, bool)` + +GetIncludeCommonAccessOk returns a tuple with the IncludeCommonAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportResponse) SetIncludeCommonAccess(v bool)` + +SetIncludeCommonAccess sets IncludeCommonAccess field to given value. + +### HasIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportResponse) HasIncludeCommonAccess() bool` + +HasIncludeCommonAccess returns a boolean if a field has been set. + +### GetExportId + +`func (o *RoleMiningPotentialRoleExportResponse) GetExportId() string` + +GetExportId returns the ExportId field if non-nil, zero value otherwise. + +### GetExportIdOk + +`func (o *RoleMiningPotentialRoleExportResponse) GetExportIdOk() (*string, bool)` + +GetExportIdOk returns a tuple with the ExportId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExportId + +`func (o *RoleMiningPotentialRoleExportResponse) SetExportId(v string)` + +SetExportId sets ExportId field to given value. + +### HasExportId + +`func (o *RoleMiningPotentialRoleExportResponse) HasExportId() bool` + +HasExportId returns a boolean if a field has been set. + +### GetStatus + +`func (o *RoleMiningPotentialRoleExportResponse) GetStatus() RoleMiningPotentialRoleExportState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *RoleMiningPotentialRoleExportResponse) GetStatusOk() (*RoleMiningPotentialRoleExportState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *RoleMiningPotentialRoleExportResponse) SetStatus(v RoleMiningPotentialRoleExportState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *RoleMiningPotentialRoleExportResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleExportState.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleExportState.md new file mode 100644 index 000000000..4b9103ae4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleExportState.md @@ -0,0 +1,25 @@ +--- +id: beta-role-mining-potential-role-export-state +title: RoleMiningPotentialRoleExportState +pagination_label: RoleMiningPotentialRoleExportState +sidebar_label: RoleMiningPotentialRoleExportState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleExportState', 'BetaRoleMiningPotentialRoleExportState'] +slug: /tools/sdk/go/beta/models/role-mining-potential-role-export-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportState', 'BetaRoleMiningPotentialRoleExportState'] +--- + +# RoleMiningPotentialRoleExportState + +## Enum + + +* `QUEUED` (value: `"QUEUED"`) + +* `IN_PROGRESS` (value: `"IN_PROGRESS"`) + +* `SUCCESS` (value: `"SUCCESS"`) + +* `ERROR` (value: `"ERROR"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleProvisionRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleProvisionRequest.md new file mode 100644 index 000000000..fd5fec822 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleProvisionRequest.md @@ -0,0 +1,168 @@ +--- +id: beta-role-mining-potential-role-provision-request +title: RoleMiningPotentialRoleProvisionRequest +pagination_label: RoleMiningPotentialRoleProvisionRequest +sidebar_label: RoleMiningPotentialRoleProvisionRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleProvisionRequest', 'BetaRoleMiningPotentialRoleProvisionRequest'] +slug: /tools/sdk/go/beta/models/role-mining-potential-role-provision-request +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleProvisionRequest', 'BetaRoleMiningPotentialRoleProvisionRequest'] +--- + +# RoleMiningPotentialRoleProvisionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleName** | Pointer to **string** | Name of the new role being created | [optional] +**RoleDescription** | Pointer to **string** | Short description of the new role being created | [optional] +**OwnerId** | Pointer to **string** | ID of the identity that will own this role | [optional] +**IncludeIdentities** | Pointer to **bool** | When true, create access requests for the identities associated with the potential role | [optional] [default to false] +**DirectlyAssignedEntitlements** | Pointer to **bool** | When true, assign entitlements directly to the role; otherwise, create access profiles containing the entitlements | [optional] [default to false] + +## Methods + +### NewRoleMiningPotentialRoleProvisionRequest + +`func NewRoleMiningPotentialRoleProvisionRequest() *RoleMiningPotentialRoleProvisionRequest` + +NewRoleMiningPotentialRoleProvisionRequest instantiates a new RoleMiningPotentialRoleProvisionRequest 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 + +### NewRoleMiningPotentialRoleProvisionRequestWithDefaults + +`func NewRoleMiningPotentialRoleProvisionRequestWithDefaults() *RoleMiningPotentialRoleProvisionRequest` + +NewRoleMiningPotentialRoleProvisionRequestWithDefaults instantiates a new RoleMiningPotentialRoleProvisionRequest 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 + +### GetRoleName + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetRoleName() string` + +GetRoleName returns the RoleName field if non-nil, zero value otherwise. + +### GetRoleNameOk + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetRoleNameOk() (*string, bool)` + +GetRoleNameOk returns a tuple with the RoleName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleName + +`func (o *RoleMiningPotentialRoleProvisionRequest) SetRoleName(v string)` + +SetRoleName sets RoleName field to given value. + +### HasRoleName + +`func (o *RoleMiningPotentialRoleProvisionRequest) HasRoleName() bool` + +HasRoleName returns a boolean if a field has been set. + +### GetRoleDescription + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetRoleDescription() string` + +GetRoleDescription returns the RoleDescription field if non-nil, zero value otherwise. + +### GetRoleDescriptionOk + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetRoleDescriptionOk() (*string, bool)` + +GetRoleDescriptionOk returns a tuple with the RoleDescription field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleDescription + +`func (o *RoleMiningPotentialRoleProvisionRequest) SetRoleDescription(v string)` + +SetRoleDescription sets RoleDescription field to given value. + +### HasRoleDescription + +`func (o *RoleMiningPotentialRoleProvisionRequest) HasRoleDescription() bool` + +HasRoleDescription returns a boolean if a field has been set. + +### GetOwnerId + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *RoleMiningPotentialRoleProvisionRequest) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *RoleMiningPotentialRoleProvisionRequest) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + +### GetIncludeIdentities + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetIncludeIdentities() bool` + +GetIncludeIdentities returns the IncludeIdentities field if non-nil, zero value otherwise. + +### GetIncludeIdentitiesOk + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetIncludeIdentitiesOk() (*bool, bool)` + +GetIncludeIdentitiesOk returns a tuple with the IncludeIdentities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeIdentities + +`func (o *RoleMiningPotentialRoleProvisionRequest) SetIncludeIdentities(v bool)` + +SetIncludeIdentities sets IncludeIdentities field to given value. + +### HasIncludeIdentities + +`func (o *RoleMiningPotentialRoleProvisionRequest) HasIncludeIdentities() bool` + +HasIncludeIdentities returns a boolean if a field has been set. + +### GetDirectlyAssignedEntitlements + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetDirectlyAssignedEntitlements() bool` + +GetDirectlyAssignedEntitlements returns the DirectlyAssignedEntitlements field if non-nil, zero value otherwise. + +### GetDirectlyAssignedEntitlementsOk + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetDirectlyAssignedEntitlementsOk() (*bool, bool)` + +GetDirectlyAssignedEntitlementsOk returns a tuple with the DirectlyAssignedEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectlyAssignedEntitlements + +`func (o *RoleMiningPotentialRoleProvisionRequest) SetDirectlyAssignedEntitlements(v bool)` + +SetDirectlyAssignedEntitlements sets DirectlyAssignedEntitlements field to given value. + +### HasDirectlyAssignedEntitlements + +`func (o *RoleMiningPotentialRoleProvisionRequest) HasDirectlyAssignedEntitlements() bool` + +HasDirectlyAssignedEntitlements returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleProvisionState.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleProvisionState.md new file mode 100644 index 000000000..e0aef64df --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleProvisionState.md @@ -0,0 +1,25 @@ +--- +id: beta-role-mining-potential-role-provision-state +title: RoleMiningPotentialRoleProvisionState +pagination_label: RoleMiningPotentialRoleProvisionState +sidebar_label: RoleMiningPotentialRoleProvisionState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleProvisionState', 'BetaRoleMiningPotentialRoleProvisionState'] +slug: /tools/sdk/go/beta/models/role-mining-potential-role-provision-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleProvisionState', 'BetaRoleMiningPotentialRoleProvisionState'] +--- + +# RoleMiningPotentialRoleProvisionState + +## Enum + + +* `POTENTIAL` (value: `"POTENTIAL"`) + +* `PENDING` (value: `"PENDING"`) + +* `COMPLETE` (value: `"COMPLETE"`) + +* `FAILED` (value: `"FAILED"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleRef.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleRef.md new file mode 100644 index 000000000..49070a5f7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleRef.md @@ -0,0 +1,90 @@ +--- +id: beta-role-mining-potential-role-ref +title: RoleMiningPotentialRoleRef +pagination_label: RoleMiningPotentialRoleRef +sidebar_label: RoleMiningPotentialRoleRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleRef', 'BetaRoleMiningPotentialRoleRef'] +slug: /tools/sdk/go/beta/models/role-mining-potential-role-ref +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleRef', 'BetaRoleMiningPotentialRoleRef'] +--- + +# RoleMiningPotentialRoleRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the potential role | [optional] +**Name** | Pointer to **string** | Name of the potential role | [optional] + +## Methods + +### NewRoleMiningPotentialRoleRef + +`func NewRoleMiningPotentialRoleRef() *RoleMiningPotentialRoleRef` + +NewRoleMiningPotentialRoleRef instantiates a new RoleMiningPotentialRoleRef 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 + +### NewRoleMiningPotentialRoleRefWithDefaults + +`func NewRoleMiningPotentialRoleRefWithDefaults() *RoleMiningPotentialRoleRef` + +NewRoleMiningPotentialRoleRefWithDefaults instantiates a new RoleMiningPotentialRoleRef 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 + +### GetId + +`func (o *RoleMiningPotentialRoleRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningPotentialRoleRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningPotentialRoleRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningPotentialRoleRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningPotentialRoleRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleSourceUsage.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleSourceUsage.md new file mode 100644 index 000000000..81fa71c0b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleSourceUsage.md @@ -0,0 +1,142 @@ +--- +id: beta-role-mining-potential-role-source-usage +title: RoleMiningPotentialRoleSourceUsage +pagination_label: RoleMiningPotentialRoleSourceUsage +sidebar_label: RoleMiningPotentialRoleSourceUsage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleSourceUsage', 'BetaRoleMiningPotentialRoleSourceUsage'] +slug: /tools/sdk/go/beta/models/role-mining-potential-role-source-usage +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSourceUsage', 'BetaRoleMiningPotentialRoleSourceUsage'] +--- + +# RoleMiningPotentialRoleSourceUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity ID | [optional] +**DisplayName** | Pointer to **string** | Display name for the identity | [optional] +**Email** | Pointer to **string** | Email address for the identity | [optional] +**UsageCount** | Pointer to **int32** | The number of days there has been usage of the source by the identity. | [optional] + +## Methods + +### NewRoleMiningPotentialRoleSourceUsage + +`func NewRoleMiningPotentialRoleSourceUsage() *RoleMiningPotentialRoleSourceUsage` + +NewRoleMiningPotentialRoleSourceUsage instantiates a new RoleMiningPotentialRoleSourceUsage 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 + +### NewRoleMiningPotentialRoleSourceUsageWithDefaults + +`func NewRoleMiningPotentialRoleSourceUsageWithDefaults() *RoleMiningPotentialRoleSourceUsage` + +NewRoleMiningPotentialRoleSourceUsageWithDefaults instantiates a new RoleMiningPotentialRoleSourceUsage 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 + +### GetId + +`func (o *RoleMiningPotentialRoleSourceUsage) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleSourceUsage) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleSourceUsage) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleSourceUsage) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *RoleMiningPotentialRoleSourceUsage) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *RoleMiningPotentialRoleSourceUsage) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *RoleMiningPotentialRoleSourceUsage) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *RoleMiningPotentialRoleSourceUsage) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetEmail + +`func (o *RoleMiningPotentialRoleSourceUsage) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *RoleMiningPotentialRoleSourceUsage) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *RoleMiningPotentialRoleSourceUsage) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *RoleMiningPotentialRoleSourceUsage) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetUsageCount + +`func (o *RoleMiningPotentialRoleSourceUsage) GetUsageCount() int32` + +GetUsageCount returns the UsageCount field if non-nil, zero value otherwise. + +### GetUsageCountOk + +`func (o *RoleMiningPotentialRoleSourceUsage) GetUsageCountOk() (*int32, bool)` + +GetUsageCountOk returns a tuple with the UsageCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsageCount + +`func (o *RoleMiningPotentialRoleSourceUsage) SetUsageCount(v int32)` + +SetUsageCount sets UsageCount field to given value. + +### HasUsageCount + +`func (o *RoleMiningPotentialRoleSourceUsage) HasUsageCount() bool` + +HasUsageCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleSummary.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleSummary.md new file mode 100644 index 000000000..489489f86 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleSummary.md @@ -0,0 +1,500 @@ +--- +id: beta-role-mining-potential-role-summary +title: RoleMiningPotentialRoleSummary +pagination_label: RoleMiningPotentialRoleSummary +sidebar_label: RoleMiningPotentialRoleSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleSummary', 'BetaRoleMiningPotentialRoleSummary'] +slug: /tools/sdk/go/beta/models/role-mining-potential-role-summary +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummary', 'BetaRoleMiningPotentialRoleSummary'] +--- + +# RoleMiningPotentialRoleSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the potential role | [optional] +**Name** | Pointer to **string** | Name of the potential role | [optional] +**PotentialRoleRef** | Pointer to [**RoleMiningPotentialRoleRef**](role-mining-potential-role-ref) | | [optional] +**IdentityCount** | Pointer to **int32** | The number of identities in a potential role. | [optional] +**EntitlementCount** | Pointer to **int32** | The number of entitlements in a potential role. | [optional] +**IdentityGroupStatus** | Pointer to **string** | The status for this identity group which can be \"REQUESTED\" or \"OBTAINED\" | [optional] +**ProvisionState** | Pointer to [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional] +**RoleId** | Pointer to **NullableString** | ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. | [optional] +**Density** | Pointer to **int32** | The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. | [optional] +**Freshness** | Pointer to **int32** | The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. | [optional] +**Quality** | Pointer to **int32** | The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**CreatedBy** | Pointer to [**RoleMiningPotentialRoleSummaryCreatedBy**](role-mining-potential-role-summary-created-by) | | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time when this potential role was created. | [optional] +**Saved** | Pointer to **bool** | The potential role's saved status | [optional] [default to false] +**Description** | Pointer to **NullableString** | Description of the potential role | [optional] +**Session** | Pointer to [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional] + +## Methods + +### NewRoleMiningPotentialRoleSummary + +`func NewRoleMiningPotentialRoleSummary() *RoleMiningPotentialRoleSummary` + +NewRoleMiningPotentialRoleSummary instantiates a new RoleMiningPotentialRoleSummary 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 + +### NewRoleMiningPotentialRoleSummaryWithDefaults + +`func NewRoleMiningPotentialRoleSummaryWithDefaults() *RoleMiningPotentialRoleSummary` + +NewRoleMiningPotentialRoleSummaryWithDefaults instantiates a new RoleMiningPotentialRoleSummary 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 + +### GetId + +`func (o *RoleMiningPotentialRoleSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleSummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleSummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningPotentialRoleSummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningPotentialRoleSummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningPotentialRoleSummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningPotentialRoleSummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPotentialRoleRef + +`func (o *RoleMiningPotentialRoleSummary) GetPotentialRoleRef() RoleMiningPotentialRoleRef` + +GetPotentialRoleRef returns the PotentialRoleRef field if non-nil, zero value otherwise. + +### GetPotentialRoleRefOk + +`func (o *RoleMiningPotentialRoleSummary) GetPotentialRoleRefOk() (*RoleMiningPotentialRoleRef, bool)` + +GetPotentialRoleRefOk returns a tuple with the PotentialRoleRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPotentialRoleRef + +`func (o *RoleMiningPotentialRoleSummary) SetPotentialRoleRef(v RoleMiningPotentialRoleRef)` + +SetPotentialRoleRef sets PotentialRoleRef field to given value. + +### HasPotentialRoleRef + +`func (o *RoleMiningPotentialRoleSummary) HasPotentialRoleRef() bool` + +HasPotentialRoleRef returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *RoleMiningPotentialRoleSummary) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *RoleMiningPotentialRoleSummary) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *RoleMiningPotentialRoleSummary) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *RoleMiningPotentialRoleSummary) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *RoleMiningPotentialRoleSummary) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *RoleMiningPotentialRoleSummary) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *RoleMiningPotentialRoleSummary) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *RoleMiningPotentialRoleSummary) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetIdentityGroupStatus + +`func (o *RoleMiningPotentialRoleSummary) GetIdentityGroupStatus() string` + +GetIdentityGroupStatus returns the IdentityGroupStatus field if non-nil, zero value otherwise. + +### GetIdentityGroupStatusOk + +`func (o *RoleMiningPotentialRoleSummary) GetIdentityGroupStatusOk() (*string, bool)` + +GetIdentityGroupStatusOk returns a tuple with the IdentityGroupStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityGroupStatus + +`func (o *RoleMiningPotentialRoleSummary) SetIdentityGroupStatus(v string)` + +SetIdentityGroupStatus sets IdentityGroupStatus field to given value. + +### HasIdentityGroupStatus + +`func (o *RoleMiningPotentialRoleSummary) HasIdentityGroupStatus() bool` + +HasIdentityGroupStatus returns a boolean if a field has been set. + +### GetProvisionState + +`func (o *RoleMiningPotentialRoleSummary) GetProvisionState() RoleMiningPotentialRoleProvisionState` + +GetProvisionState returns the ProvisionState field if non-nil, zero value otherwise. + +### GetProvisionStateOk + +`func (o *RoleMiningPotentialRoleSummary) GetProvisionStateOk() (*RoleMiningPotentialRoleProvisionState, bool)` + +GetProvisionStateOk returns a tuple with the ProvisionState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionState + +`func (o *RoleMiningPotentialRoleSummary) SetProvisionState(v RoleMiningPotentialRoleProvisionState)` + +SetProvisionState sets ProvisionState field to given value. + +### HasProvisionState + +`func (o *RoleMiningPotentialRoleSummary) HasProvisionState() bool` + +HasProvisionState returns a boolean if a field has been set. + +### GetRoleId + +`func (o *RoleMiningPotentialRoleSummary) GetRoleId() string` + +GetRoleId returns the RoleId field if non-nil, zero value otherwise. + +### GetRoleIdOk + +`func (o *RoleMiningPotentialRoleSummary) GetRoleIdOk() (*string, bool)` + +GetRoleIdOk returns a tuple with the RoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleId + +`func (o *RoleMiningPotentialRoleSummary) SetRoleId(v string)` + +SetRoleId sets RoleId field to given value. + +### HasRoleId + +`func (o *RoleMiningPotentialRoleSummary) HasRoleId() bool` + +HasRoleId returns a boolean if a field has been set. + +### SetRoleIdNil + +`func (o *RoleMiningPotentialRoleSummary) SetRoleIdNil(b bool)` + + SetRoleIdNil sets the value for RoleId to be an explicit nil + +### UnsetRoleId +`func (o *RoleMiningPotentialRoleSummary) UnsetRoleId()` + +UnsetRoleId ensures that no value is present for RoleId, not even an explicit nil +### GetDensity + +`func (o *RoleMiningPotentialRoleSummary) GetDensity() int32` + +GetDensity returns the Density field if non-nil, zero value otherwise. + +### GetDensityOk + +`func (o *RoleMiningPotentialRoleSummary) GetDensityOk() (*int32, bool)` + +GetDensityOk returns a tuple with the Density field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDensity + +`func (o *RoleMiningPotentialRoleSummary) SetDensity(v int32)` + +SetDensity sets Density field to given value. + +### HasDensity + +`func (o *RoleMiningPotentialRoleSummary) HasDensity() bool` + +HasDensity returns a boolean if a field has been set. + +### GetFreshness + +`func (o *RoleMiningPotentialRoleSummary) GetFreshness() int32` + +GetFreshness returns the Freshness field if non-nil, zero value otherwise. + +### GetFreshnessOk + +`func (o *RoleMiningPotentialRoleSummary) GetFreshnessOk() (*int32, bool)` + +GetFreshnessOk returns a tuple with the Freshness field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFreshness + +`func (o *RoleMiningPotentialRoleSummary) SetFreshness(v int32)` + +SetFreshness sets Freshness field to given value. + +### HasFreshness + +`func (o *RoleMiningPotentialRoleSummary) HasFreshness() bool` + +HasFreshness returns a boolean if a field has been set. + +### GetQuality + +`func (o *RoleMiningPotentialRoleSummary) GetQuality() int32` + +GetQuality returns the Quality field if non-nil, zero value otherwise. + +### GetQualityOk + +`func (o *RoleMiningPotentialRoleSummary) GetQualityOk() (*int32, bool)` + +GetQualityOk returns a tuple with the Quality field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuality + +`func (o *RoleMiningPotentialRoleSummary) SetQuality(v int32)` + +SetQuality sets Quality field to given value. + +### HasQuality + +`func (o *RoleMiningPotentialRoleSummary) HasQuality() bool` + +HasQuality returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningPotentialRoleSummary) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningPotentialRoleSummary) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningPotentialRoleSummary) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningPotentialRoleSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetCreatedBy + +`func (o *RoleMiningPotentialRoleSummary) GetCreatedBy() RoleMiningPotentialRoleSummaryCreatedBy` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *RoleMiningPotentialRoleSummary) GetCreatedByOk() (*RoleMiningPotentialRoleSummaryCreatedBy, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *RoleMiningPotentialRoleSummary) SetCreatedBy(v RoleMiningPotentialRoleSummaryCreatedBy)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *RoleMiningPotentialRoleSummary) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleMiningPotentialRoleSummary) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleMiningPotentialRoleSummary) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleMiningPotentialRoleSummary) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleMiningPotentialRoleSummary) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetSaved + +`func (o *RoleMiningPotentialRoleSummary) GetSaved() bool` + +GetSaved returns the Saved field if non-nil, zero value otherwise. + +### GetSavedOk + +`func (o *RoleMiningPotentialRoleSummary) GetSavedOk() (*bool, bool)` + +GetSavedOk returns a tuple with the Saved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSaved + +`func (o *RoleMiningPotentialRoleSummary) SetSaved(v bool)` + +SetSaved sets Saved field to given value. + +### HasSaved + +`func (o *RoleMiningPotentialRoleSummary) HasSaved() bool` + +HasSaved returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleMiningPotentialRoleSummary) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleMiningPotentialRoleSummary) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleMiningPotentialRoleSummary) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleMiningPotentialRoleSummary) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleMiningPotentialRoleSummary) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleMiningPotentialRoleSummary) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSession + +`func (o *RoleMiningPotentialRoleSummary) GetSession() RoleMiningSessionParametersDto` + +GetSession returns the Session field if non-nil, zero value otherwise. + +### GetSessionOk + +`func (o *RoleMiningPotentialRoleSummary) GetSessionOk() (*RoleMiningSessionParametersDto, bool)` + +GetSessionOk returns a tuple with the Session field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSession + +`func (o *RoleMiningPotentialRoleSummary) SetSession(v RoleMiningSessionParametersDto)` + +SetSession sets Session field to given value. + +### HasSession + +`func (o *RoleMiningPotentialRoleSummary) HasSession() bool` + +HasSession returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleSummaryCreatedBy.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleSummaryCreatedBy.md new file mode 100644 index 000000000..01cd7bf4b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningPotentialRoleSummaryCreatedBy.md @@ -0,0 +1,90 @@ +--- +id: beta-role-mining-potential-role-summary-created-by +title: RoleMiningPotentialRoleSummaryCreatedBy +pagination_label: RoleMiningPotentialRoleSummaryCreatedBy +sidebar_label: RoleMiningPotentialRoleSummaryCreatedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleSummaryCreatedBy', 'BetaRoleMiningPotentialRoleSummaryCreatedBy'] +slug: /tools/sdk/go/beta/models/role-mining-potential-role-summary-created-by +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummaryCreatedBy', 'BetaRoleMiningPotentialRoleSummaryCreatedBy'] +--- + +# RoleMiningPotentialRoleSummaryCreatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the creator | [optional] +**DisplayName** | Pointer to **string** | The display name of the creator | [optional] + +## Methods + +### NewRoleMiningPotentialRoleSummaryCreatedBy + +`func NewRoleMiningPotentialRoleSummaryCreatedBy() *RoleMiningPotentialRoleSummaryCreatedBy` + +NewRoleMiningPotentialRoleSummaryCreatedBy instantiates a new RoleMiningPotentialRoleSummaryCreatedBy 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 + +### NewRoleMiningPotentialRoleSummaryCreatedByWithDefaults + +`func NewRoleMiningPotentialRoleSummaryCreatedByWithDefaults() *RoleMiningPotentialRoleSummaryCreatedBy` + +NewRoleMiningPotentialRoleSummaryCreatedByWithDefaults instantiates a new RoleMiningPotentialRoleSummaryCreatedBy 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 + +### GetId + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningRoleType.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningRoleType.md new file mode 100644 index 000000000..42e378e1c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningRoleType.md @@ -0,0 +1,21 @@ +--- +id: beta-role-mining-role-type +title: RoleMiningRoleType +pagination_label: RoleMiningRoleType +sidebar_label: RoleMiningRoleType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningRoleType', 'BetaRoleMiningRoleType'] +slug: /tools/sdk/go/beta/models/role-mining-role-type +tags: ['SDK', 'Software Development Kit', 'RoleMiningRoleType', 'BetaRoleMiningRoleType'] +--- + +# RoleMiningRoleType + +## Enum + + +* `SPECIALIZED` (value: `"SPECIALIZED"`) + +* `COMMON` (value: `"COMMON"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionDraftRoleDto.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionDraftRoleDto.md new file mode 100644 index 000000000..5545f86d8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionDraftRoleDto.md @@ -0,0 +1,298 @@ +--- +id: beta-role-mining-session-draft-role-dto +title: RoleMiningSessionDraftRoleDto +pagination_label: RoleMiningSessionDraftRoleDto +sidebar_label: RoleMiningSessionDraftRoleDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionDraftRoleDto', 'BetaRoleMiningSessionDraftRoleDto'] +slug: /tools/sdk/go/beta/models/role-mining-session-draft-role-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionDraftRoleDto', 'BetaRoleMiningSessionDraftRoleDto'] +--- + +# RoleMiningSessionDraftRoleDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the draft role | [optional] +**Description** | Pointer to **string** | Draft role description | [optional] +**IdentityIds** | Pointer to **[]string** | The list of identities for this role mining session. | [optional] +**EntitlementIds** | Pointer to **[]string** | The list of entitlement ids for this role mining session. | [optional] +**ExcludedEntitlements** | Pointer to **[]string** | The list of excluded entitlement ids. | [optional] +**Modified** | Pointer to **SailPointTime** | Last modified date | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**Id** | Pointer to **string** | Id of the potential draft role | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time when this potential draft role was created. | [optional] +**ModifiedDate** | Pointer to **SailPointTime** | The date-time when this potential draft role was modified. | [optional] + +## Methods + +### NewRoleMiningSessionDraftRoleDto + +`func NewRoleMiningSessionDraftRoleDto() *RoleMiningSessionDraftRoleDto` + +NewRoleMiningSessionDraftRoleDto instantiates a new RoleMiningSessionDraftRoleDto 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 + +### NewRoleMiningSessionDraftRoleDtoWithDefaults + +`func NewRoleMiningSessionDraftRoleDtoWithDefaults() *RoleMiningSessionDraftRoleDto` + +NewRoleMiningSessionDraftRoleDtoWithDefaults instantiates a new RoleMiningSessionDraftRoleDto 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 + +### GetName + +`func (o *RoleMiningSessionDraftRoleDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningSessionDraftRoleDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningSessionDraftRoleDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningSessionDraftRoleDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleMiningSessionDraftRoleDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleMiningSessionDraftRoleDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleMiningSessionDraftRoleDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleMiningSessionDraftRoleDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIdentityIds + +`func (o *RoleMiningSessionDraftRoleDto) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *RoleMiningSessionDraftRoleDto) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *RoleMiningSessionDraftRoleDto) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *RoleMiningSessionDraftRoleDto) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + +### GetEntitlementIds + +`func (o *RoleMiningSessionDraftRoleDto) GetEntitlementIds() []string` + +GetEntitlementIds returns the EntitlementIds field if non-nil, zero value otherwise. + +### GetEntitlementIdsOk + +`func (o *RoleMiningSessionDraftRoleDto) GetEntitlementIdsOk() (*[]string, bool)` + +GetEntitlementIdsOk returns a tuple with the EntitlementIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementIds + +`func (o *RoleMiningSessionDraftRoleDto) SetEntitlementIds(v []string)` + +SetEntitlementIds sets EntitlementIds field to given value. + +### HasEntitlementIds + +`func (o *RoleMiningSessionDraftRoleDto) HasEntitlementIds() bool` + +HasEntitlementIds returns a boolean if a field has been set. + +### GetExcludedEntitlements + +`func (o *RoleMiningSessionDraftRoleDto) GetExcludedEntitlements() []string` + +GetExcludedEntitlements returns the ExcludedEntitlements field if non-nil, zero value otherwise. + +### GetExcludedEntitlementsOk + +`func (o *RoleMiningSessionDraftRoleDto) GetExcludedEntitlementsOk() (*[]string, bool)` + +GetExcludedEntitlementsOk returns a tuple with the ExcludedEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludedEntitlements + +`func (o *RoleMiningSessionDraftRoleDto) SetExcludedEntitlements(v []string)` + +SetExcludedEntitlements sets ExcludedEntitlements field to given value. + +### HasExcludedEntitlements + +`func (o *RoleMiningSessionDraftRoleDto) HasExcludedEntitlements() bool` + +HasExcludedEntitlements returns a boolean if a field has been set. + +### GetModified + +`func (o *RoleMiningSessionDraftRoleDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RoleMiningSessionDraftRoleDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RoleMiningSessionDraftRoleDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RoleMiningSessionDraftRoleDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningSessionDraftRoleDto) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningSessionDraftRoleDto) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningSessionDraftRoleDto) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningSessionDraftRoleDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RoleMiningSessionDraftRoleDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningSessionDraftRoleDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningSessionDraftRoleDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningSessionDraftRoleDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleMiningSessionDraftRoleDto) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleMiningSessionDraftRoleDto) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleMiningSessionDraftRoleDto) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleMiningSessionDraftRoleDto) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetModifiedDate + +`func (o *RoleMiningSessionDraftRoleDto) GetModifiedDate() SailPointTime` + +GetModifiedDate returns the ModifiedDate field if non-nil, zero value otherwise. + +### GetModifiedDateOk + +`func (o *RoleMiningSessionDraftRoleDto) GetModifiedDateOk() (*SailPointTime, bool)` + +GetModifiedDateOk returns a tuple with the ModifiedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedDate + +`func (o *RoleMiningSessionDraftRoleDto) SetModifiedDate(v SailPointTime)` + +SetModifiedDate sets ModifiedDate field to given value. + +### HasModifiedDate + +`func (o *RoleMiningSessionDraftRoleDto) HasModifiedDate() bool` + +HasModifiedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionDto.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionDto.md new file mode 100644 index 000000000..ce09e7f90 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionDto.md @@ -0,0 +1,374 @@ +--- +id: beta-role-mining-session-dto +title: RoleMiningSessionDto +pagination_label: RoleMiningSessionDto +sidebar_label: RoleMiningSessionDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionDto', 'BetaRoleMiningSessionDto'] +slug: /tools/sdk/go/beta/models/role-mining-session-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionDto', 'BetaRoleMiningSessionDto'] +--- + +# RoleMiningSessionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**PruneThreshold** | Pointer to **NullableInt32** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [optional] +**PrescribedPruneThreshold** | Pointer to **NullableInt32** | The calculated prescribedPruneThreshold | [optional] +**MinNumIdentitiesInPotentialRole** | Pointer to **NullableInt32** | Minimum number of identities in a potential role | [optional] +**PotentialRoleCount** | Pointer to **int32** | Number of potential roles | [optional] +**PotentialRolesReadyCount** | Pointer to **int32** | Number of potential roles ready | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**EmailRecipientId** | Pointer to **NullableString** | The id of the user who will receive an email about the role mining session | [optional] +**IdentityCount** | Pointer to **int32** | Number of identities in the population which meet the search criteria or identity list provided | [optional] +**Saved** | Pointer to **bool** | The session's saved status | [optional] [default to false] +**Name** | Pointer to **NullableString** | The session's saved name | [optional] + +## Methods + +### NewRoleMiningSessionDto + +`func NewRoleMiningSessionDto() *RoleMiningSessionDto` + +NewRoleMiningSessionDto instantiates a new RoleMiningSessionDto 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 + +### NewRoleMiningSessionDtoWithDefaults + +`func NewRoleMiningSessionDtoWithDefaults() *RoleMiningSessionDto` + +NewRoleMiningSessionDtoWithDefaults instantiates a new RoleMiningSessionDto 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 + +### GetScope + +`func (o *RoleMiningSessionDto) GetScope() RoleMiningSessionScope` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *RoleMiningSessionDto) GetScopeOk() (*RoleMiningSessionScope, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *RoleMiningSessionDto) SetScope(v RoleMiningSessionScope)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *RoleMiningSessionDto) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### GetPruneThreshold + +`func (o *RoleMiningSessionDto) GetPruneThreshold() int32` + +GetPruneThreshold returns the PruneThreshold field if non-nil, zero value otherwise. + +### GetPruneThresholdOk + +`func (o *RoleMiningSessionDto) GetPruneThresholdOk() (*int32, bool)` + +GetPruneThresholdOk returns a tuple with the PruneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPruneThreshold + +`func (o *RoleMiningSessionDto) SetPruneThreshold(v int32)` + +SetPruneThreshold sets PruneThreshold field to given value. + +### HasPruneThreshold + +`func (o *RoleMiningSessionDto) HasPruneThreshold() bool` + +HasPruneThreshold returns a boolean if a field has been set. + +### SetPruneThresholdNil + +`func (o *RoleMiningSessionDto) SetPruneThresholdNil(b bool)` + + SetPruneThresholdNil sets the value for PruneThreshold to be an explicit nil + +### UnsetPruneThreshold +`func (o *RoleMiningSessionDto) UnsetPruneThreshold()` + +UnsetPruneThreshold ensures that no value is present for PruneThreshold, not even an explicit nil +### GetPrescribedPruneThreshold + +`func (o *RoleMiningSessionDto) GetPrescribedPruneThreshold() int32` + +GetPrescribedPruneThreshold returns the PrescribedPruneThreshold field if non-nil, zero value otherwise. + +### GetPrescribedPruneThresholdOk + +`func (o *RoleMiningSessionDto) GetPrescribedPruneThresholdOk() (*int32, bool)` + +GetPrescribedPruneThresholdOk returns a tuple with the PrescribedPruneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrescribedPruneThreshold + +`func (o *RoleMiningSessionDto) SetPrescribedPruneThreshold(v int32)` + +SetPrescribedPruneThreshold sets PrescribedPruneThreshold field to given value. + +### HasPrescribedPruneThreshold + +`func (o *RoleMiningSessionDto) HasPrescribedPruneThreshold() bool` + +HasPrescribedPruneThreshold returns a boolean if a field has been set. + +### SetPrescribedPruneThresholdNil + +`func (o *RoleMiningSessionDto) SetPrescribedPruneThresholdNil(b bool)` + + SetPrescribedPruneThresholdNil sets the value for PrescribedPruneThreshold to be an explicit nil + +### UnsetPrescribedPruneThreshold +`func (o *RoleMiningSessionDto) UnsetPrescribedPruneThreshold()` + +UnsetPrescribedPruneThreshold ensures that no value is present for PrescribedPruneThreshold, not even an explicit nil +### GetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionDto) GetMinNumIdentitiesInPotentialRole() int32` + +GetMinNumIdentitiesInPotentialRole returns the MinNumIdentitiesInPotentialRole field if non-nil, zero value otherwise. + +### GetMinNumIdentitiesInPotentialRoleOk + +`func (o *RoleMiningSessionDto) GetMinNumIdentitiesInPotentialRoleOk() (*int32, bool)` + +GetMinNumIdentitiesInPotentialRoleOk returns a tuple with the MinNumIdentitiesInPotentialRole field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionDto) SetMinNumIdentitiesInPotentialRole(v int32)` + +SetMinNumIdentitiesInPotentialRole sets MinNumIdentitiesInPotentialRole field to given value. + +### HasMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionDto) HasMinNumIdentitiesInPotentialRole() bool` + +HasMinNumIdentitiesInPotentialRole returns a boolean if a field has been set. + +### SetMinNumIdentitiesInPotentialRoleNil + +`func (o *RoleMiningSessionDto) SetMinNumIdentitiesInPotentialRoleNil(b bool)` + + SetMinNumIdentitiesInPotentialRoleNil sets the value for MinNumIdentitiesInPotentialRole to be an explicit nil + +### UnsetMinNumIdentitiesInPotentialRole +`func (o *RoleMiningSessionDto) UnsetMinNumIdentitiesInPotentialRole()` + +UnsetMinNumIdentitiesInPotentialRole ensures that no value is present for MinNumIdentitiesInPotentialRole, not even an explicit nil +### GetPotentialRoleCount + +`func (o *RoleMiningSessionDto) GetPotentialRoleCount() int32` + +GetPotentialRoleCount returns the PotentialRoleCount field if non-nil, zero value otherwise. + +### GetPotentialRoleCountOk + +`func (o *RoleMiningSessionDto) GetPotentialRoleCountOk() (*int32, bool)` + +GetPotentialRoleCountOk returns a tuple with the PotentialRoleCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPotentialRoleCount + +`func (o *RoleMiningSessionDto) SetPotentialRoleCount(v int32)` + +SetPotentialRoleCount sets PotentialRoleCount field to given value. + +### HasPotentialRoleCount + +`func (o *RoleMiningSessionDto) HasPotentialRoleCount() bool` + +HasPotentialRoleCount returns a boolean if a field has been set. + +### GetPotentialRolesReadyCount + +`func (o *RoleMiningSessionDto) GetPotentialRolesReadyCount() int32` + +GetPotentialRolesReadyCount returns the PotentialRolesReadyCount field if non-nil, zero value otherwise. + +### GetPotentialRolesReadyCountOk + +`func (o *RoleMiningSessionDto) GetPotentialRolesReadyCountOk() (*int32, bool)` + +GetPotentialRolesReadyCountOk returns a tuple with the PotentialRolesReadyCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPotentialRolesReadyCount + +`func (o *RoleMiningSessionDto) SetPotentialRolesReadyCount(v int32)` + +SetPotentialRolesReadyCount sets PotentialRolesReadyCount field to given value. + +### HasPotentialRolesReadyCount + +`func (o *RoleMiningSessionDto) HasPotentialRolesReadyCount() bool` + +HasPotentialRolesReadyCount returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningSessionDto) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningSessionDto) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningSessionDto) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningSessionDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetEmailRecipientId + +`func (o *RoleMiningSessionDto) GetEmailRecipientId() string` + +GetEmailRecipientId returns the EmailRecipientId field if non-nil, zero value otherwise. + +### GetEmailRecipientIdOk + +`func (o *RoleMiningSessionDto) GetEmailRecipientIdOk() (*string, bool)` + +GetEmailRecipientIdOk returns a tuple with the EmailRecipientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailRecipientId + +`func (o *RoleMiningSessionDto) SetEmailRecipientId(v string)` + +SetEmailRecipientId sets EmailRecipientId field to given value. + +### HasEmailRecipientId + +`func (o *RoleMiningSessionDto) HasEmailRecipientId() bool` + +HasEmailRecipientId returns a boolean if a field has been set. + +### SetEmailRecipientIdNil + +`func (o *RoleMiningSessionDto) SetEmailRecipientIdNil(b bool)` + + SetEmailRecipientIdNil sets the value for EmailRecipientId to be an explicit nil + +### UnsetEmailRecipientId +`func (o *RoleMiningSessionDto) UnsetEmailRecipientId()` + +UnsetEmailRecipientId ensures that no value is present for EmailRecipientId, not even an explicit nil +### GetIdentityCount + +`func (o *RoleMiningSessionDto) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *RoleMiningSessionDto) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *RoleMiningSessionDto) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *RoleMiningSessionDto) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetSaved + +`func (o *RoleMiningSessionDto) GetSaved() bool` + +GetSaved returns the Saved field if non-nil, zero value otherwise. + +### GetSavedOk + +`func (o *RoleMiningSessionDto) GetSavedOk() (*bool, bool)` + +GetSavedOk returns a tuple with the Saved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSaved + +`func (o *RoleMiningSessionDto) SetSaved(v bool)` + +SetSaved sets Saved field to given value. + +### HasSaved + +`func (o *RoleMiningSessionDto) HasSaved() bool` + +HasSaved returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningSessionDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningSessionDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningSessionDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningSessionDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RoleMiningSessionDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RoleMiningSessionDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionParametersDto.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionParametersDto.md new file mode 100644 index 000000000..b27755b82 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionParametersDto.md @@ -0,0 +1,302 @@ +--- +id: beta-role-mining-session-parameters-dto +title: RoleMiningSessionParametersDto +pagination_label: RoleMiningSessionParametersDto +sidebar_label: RoleMiningSessionParametersDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionParametersDto', 'BetaRoleMiningSessionParametersDto'] +slug: /tools/sdk/go/beta/models/role-mining-session-parameters-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionParametersDto', 'BetaRoleMiningSessionParametersDto'] +--- + +# RoleMiningSessionParametersDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the role mining session | [optional] +**Name** | Pointer to **NullableString** | The session's saved name | [optional] +**MinNumIdentitiesInPotentialRole** | Pointer to **NullableInt32** | Minimum number of identities in a potential role | [optional] +**PruneThreshold** | Pointer to **NullableInt32** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [optional] +**Saved** | Pointer to **bool** | The session's saved status | [optional] [default to true] +**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**State** | Pointer to [**RoleMiningSessionState**](role-mining-session-state) | | [optional] +**ScopingMethod** | Pointer to [**RoleMiningSessionScopingMethod**](role-mining-session-scoping-method) | | [optional] + +## Methods + +### NewRoleMiningSessionParametersDto + +`func NewRoleMiningSessionParametersDto() *RoleMiningSessionParametersDto` + +NewRoleMiningSessionParametersDto instantiates a new RoleMiningSessionParametersDto 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 + +### NewRoleMiningSessionParametersDtoWithDefaults + +`func NewRoleMiningSessionParametersDtoWithDefaults() *RoleMiningSessionParametersDto` + +NewRoleMiningSessionParametersDtoWithDefaults instantiates a new RoleMiningSessionParametersDto 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 + +### GetId + +`func (o *RoleMiningSessionParametersDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningSessionParametersDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningSessionParametersDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningSessionParametersDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningSessionParametersDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningSessionParametersDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningSessionParametersDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningSessionParametersDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RoleMiningSessionParametersDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RoleMiningSessionParametersDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionParametersDto) GetMinNumIdentitiesInPotentialRole() int32` + +GetMinNumIdentitiesInPotentialRole returns the MinNumIdentitiesInPotentialRole field if non-nil, zero value otherwise. + +### GetMinNumIdentitiesInPotentialRoleOk + +`func (o *RoleMiningSessionParametersDto) GetMinNumIdentitiesInPotentialRoleOk() (*int32, bool)` + +GetMinNumIdentitiesInPotentialRoleOk returns a tuple with the MinNumIdentitiesInPotentialRole field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionParametersDto) SetMinNumIdentitiesInPotentialRole(v int32)` + +SetMinNumIdentitiesInPotentialRole sets MinNumIdentitiesInPotentialRole field to given value. + +### HasMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionParametersDto) HasMinNumIdentitiesInPotentialRole() bool` + +HasMinNumIdentitiesInPotentialRole returns a boolean if a field has been set. + +### SetMinNumIdentitiesInPotentialRoleNil + +`func (o *RoleMiningSessionParametersDto) SetMinNumIdentitiesInPotentialRoleNil(b bool)` + + SetMinNumIdentitiesInPotentialRoleNil sets the value for MinNumIdentitiesInPotentialRole to be an explicit nil + +### UnsetMinNumIdentitiesInPotentialRole +`func (o *RoleMiningSessionParametersDto) UnsetMinNumIdentitiesInPotentialRole()` + +UnsetMinNumIdentitiesInPotentialRole ensures that no value is present for MinNumIdentitiesInPotentialRole, not even an explicit nil +### GetPruneThreshold + +`func (o *RoleMiningSessionParametersDto) GetPruneThreshold() int32` + +GetPruneThreshold returns the PruneThreshold field if non-nil, zero value otherwise. + +### GetPruneThresholdOk + +`func (o *RoleMiningSessionParametersDto) GetPruneThresholdOk() (*int32, bool)` + +GetPruneThresholdOk returns a tuple with the PruneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPruneThreshold + +`func (o *RoleMiningSessionParametersDto) SetPruneThreshold(v int32)` + +SetPruneThreshold sets PruneThreshold field to given value. + +### HasPruneThreshold + +`func (o *RoleMiningSessionParametersDto) HasPruneThreshold() bool` + +HasPruneThreshold returns a boolean if a field has been set. + +### SetPruneThresholdNil + +`func (o *RoleMiningSessionParametersDto) SetPruneThresholdNil(b bool)` + + SetPruneThresholdNil sets the value for PruneThreshold to be an explicit nil + +### UnsetPruneThreshold +`func (o *RoleMiningSessionParametersDto) UnsetPruneThreshold()` + +UnsetPruneThreshold ensures that no value is present for PruneThreshold, not even an explicit nil +### GetSaved + +`func (o *RoleMiningSessionParametersDto) GetSaved() bool` + +GetSaved returns the Saved field if non-nil, zero value otherwise. + +### GetSavedOk + +`func (o *RoleMiningSessionParametersDto) GetSavedOk() (*bool, bool)` + +GetSavedOk returns a tuple with the Saved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSaved + +`func (o *RoleMiningSessionParametersDto) SetSaved(v bool)` + +SetSaved sets Saved field to given value. + +### HasSaved + +`func (o *RoleMiningSessionParametersDto) HasSaved() bool` + +HasSaved returns a boolean if a field has been set. + +### GetScope + +`func (o *RoleMiningSessionParametersDto) GetScope() RoleMiningSessionScope` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *RoleMiningSessionParametersDto) GetScopeOk() (*RoleMiningSessionScope, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *RoleMiningSessionParametersDto) SetScope(v RoleMiningSessionScope)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *RoleMiningSessionParametersDto) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningSessionParametersDto) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningSessionParametersDto) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningSessionParametersDto) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningSessionParametersDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetState + +`func (o *RoleMiningSessionParametersDto) GetState() RoleMiningSessionState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *RoleMiningSessionParametersDto) GetStateOk() (*RoleMiningSessionState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *RoleMiningSessionParametersDto) SetState(v RoleMiningSessionState)` + +SetState sets State field to given value. + +### HasState + +`func (o *RoleMiningSessionParametersDto) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetScopingMethod + +`func (o *RoleMiningSessionParametersDto) GetScopingMethod() RoleMiningSessionScopingMethod` + +GetScopingMethod returns the ScopingMethod field if non-nil, zero value otherwise. + +### GetScopingMethodOk + +`func (o *RoleMiningSessionParametersDto) GetScopingMethodOk() (*RoleMiningSessionScopingMethod, bool)` + +GetScopingMethodOk returns a tuple with the ScopingMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScopingMethod + +`func (o *RoleMiningSessionParametersDto) SetScopingMethod(v RoleMiningSessionScopingMethod)` + +SetScopingMethod sets ScopingMethod field to given value. + +### HasScopingMethod + +`func (o *RoleMiningSessionParametersDto) HasScopingMethod() bool` + +HasScopingMethod returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionResponse.md new file mode 100644 index 000000000..9a48a515a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionResponse.md @@ -0,0 +1,576 @@ +--- +id: beta-role-mining-session-response +title: RoleMiningSessionResponse +pagination_label: RoleMiningSessionResponse +sidebar_label: RoleMiningSessionResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionResponse', 'BetaRoleMiningSessionResponse'] +slug: /tools/sdk/go/beta/models/role-mining-session-response +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionResponse', 'BetaRoleMiningSessionResponse'] +--- + +# RoleMiningSessionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**MinNumIdentitiesInPotentialRole** | Pointer to **NullableInt32** | Minimum number of identities in a potential role | [optional] +**ScopingMethod** | Pointer to **NullableString** | The scoping method of the role mining session | [optional] +**PrescribedPruneThreshold** | Pointer to **NullableInt32** | The computed (or prescribed) prune threshold for this session | [optional] +**PruneThreshold** | Pointer to **NullableInt32** | The prune threshold to be used for this role mining session | [optional] +**PotentialRoleCount** | Pointer to **int32** | The number of potential roles | [optional] +**PotentialRolesReadyCount** | Pointer to **int32** | The number of potential roles which have completed processing | [optional] +**Status** | Pointer to [**RoleMiningSessionStatus**](role-mining-session-status) | | [optional] +**EmailRecipientId** | Pointer to **NullableString** | The id of the user who will receive an email about the role mining session | [optional] +**CreatedBy** | Pointer to [**RoleMiningSessionResponseCreatedBy**](role-mining-session-response-created-by) | | [optional] +**IdentityCount** | Pointer to **int32** | The number of identities | [optional] +**Saved** | Pointer to **bool** | The session's saved status | [optional] [default to false] +**Name** | Pointer to **NullableString** | The session's saved name | [optional] +**DataFilePath** | Pointer to **NullableString** | The data file path of the role mining session | [optional] +**Id** | Pointer to **string** | Session Id for this role mining session | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time when this role mining session was created. | [optional] +**ModifiedDate** | Pointer to **SailPointTime** | The date-time when this role mining session was completed. | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] + +## Methods + +### NewRoleMiningSessionResponse + +`func NewRoleMiningSessionResponse() *RoleMiningSessionResponse` + +NewRoleMiningSessionResponse instantiates a new RoleMiningSessionResponse 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 + +### NewRoleMiningSessionResponseWithDefaults + +`func NewRoleMiningSessionResponseWithDefaults() *RoleMiningSessionResponse` + +NewRoleMiningSessionResponseWithDefaults instantiates a new RoleMiningSessionResponse 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 + +### GetScope + +`func (o *RoleMiningSessionResponse) GetScope() RoleMiningSessionScope` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *RoleMiningSessionResponse) GetScopeOk() (*RoleMiningSessionScope, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *RoleMiningSessionResponse) SetScope(v RoleMiningSessionScope)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *RoleMiningSessionResponse) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### GetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionResponse) GetMinNumIdentitiesInPotentialRole() int32` + +GetMinNumIdentitiesInPotentialRole returns the MinNumIdentitiesInPotentialRole field if non-nil, zero value otherwise. + +### GetMinNumIdentitiesInPotentialRoleOk + +`func (o *RoleMiningSessionResponse) GetMinNumIdentitiesInPotentialRoleOk() (*int32, bool)` + +GetMinNumIdentitiesInPotentialRoleOk returns a tuple with the MinNumIdentitiesInPotentialRole field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionResponse) SetMinNumIdentitiesInPotentialRole(v int32)` + +SetMinNumIdentitiesInPotentialRole sets MinNumIdentitiesInPotentialRole field to given value. + +### HasMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionResponse) HasMinNumIdentitiesInPotentialRole() bool` + +HasMinNumIdentitiesInPotentialRole returns a boolean if a field has been set. + +### SetMinNumIdentitiesInPotentialRoleNil + +`func (o *RoleMiningSessionResponse) SetMinNumIdentitiesInPotentialRoleNil(b bool)` + + SetMinNumIdentitiesInPotentialRoleNil sets the value for MinNumIdentitiesInPotentialRole to be an explicit nil + +### UnsetMinNumIdentitiesInPotentialRole +`func (o *RoleMiningSessionResponse) UnsetMinNumIdentitiesInPotentialRole()` + +UnsetMinNumIdentitiesInPotentialRole ensures that no value is present for MinNumIdentitiesInPotentialRole, not even an explicit nil +### GetScopingMethod + +`func (o *RoleMiningSessionResponse) GetScopingMethod() string` + +GetScopingMethod returns the ScopingMethod field if non-nil, zero value otherwise. + +### GetScopingMethodOk + +`func (o *RoleMiningSessionResponse) GetScopingMethodOk() (*string, bool)` + +GetScopingMethodOk returns a tuple with the ScopingMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScopingMethod + +`func (o *RoleMiningSessionResponse) SetScopingMethod(v string)` + +SetScopingMethod sets ScopingMethod field to given value. + +### HasScopingMethod + +`func (o *RoleMiningSessionResponse) HasScopingMethod() bool` + +HasScopingMethod returns a boolean if a field has been set. + +### SetScopingMethodNil + +`func (o *RoleMiningSessionResponse) SetScopingMethodNil(b bool)` + + SetScopingMethodNil sets the value for ScopingMethod to be an explicit nil + +### UnsetScopingMethod +`func (o *RoleMiningSessionResponse) UnsetScopingMethod()` + +UnsetScopingMethod ensures that no value is present for ScopingMethod, not even an explicit nil +### GetPrescribedPruneThreshold + +`func (o *RoleMiningSessionResponse) GetPrescribedPruneThreshold() int32` + +GetPrescribedPruneThreshold returns the PrescribedPruneThreshold field if non-nil, zero value otherwise. + +### GetPrescribedPruneThresholdOk + +`func (o *RoleMiningSessionResponse) GetPrescribedPruneThresholdOk() (*int32, bool)` + +GetPrescribedPruneThresholdOk returns a tuple with the PrescribedPruneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrescribedPruneThreshold + +`func (o *RoleMiningSessionResponse) SetPrescribedPruneThreshold(v int32)` + +SetPrescribedPruneThreshold sets PrescribedPruneThreshold field to given value. + +### HasPrescribedPruneThreshold + +`func (o *RoleMiningSessionResponse) HasPrescribedPruneThreshold() bool` + +HasPrescribedPruneThreshold returns a boolean if a field has been set. + +### SetPrescribedPruneThresholdNil + +`func (o *RoleMiningSessionResponse) SetPrescribedPruneThresholdNil(b bool)` + + SetPrescribedPruneThresholdNil sets the value for PrescribedPruneThreshold to be an explicit nil + +### UnsetPrescribedPruneThreshold +`func (o *RoleMiningSessionResponse) UnsetPrescribedPruneThreshold()` + +UnsetPrescribedPruneThreshold ensures that no value is present for PrescribedPruneThreshold, not even an explicit nil +### GetPruneThreshold + +`func (o *RoleMiningSessionResponse) GetPruneThreshold() int32` + +GetPruneThreshold returns the PruneThreshold field if non-nil, zero value otherwise. + +### GetPruneThresholdOk + +`func (o *RoleMiningSessionResponse) GetPruneThresholdOk() (*int32, bool)` + +GetPruneThresholdOk returns a tuple with the PruneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPruneThreshold + +`func (o *RoleMiningSessionResponse) SetPruneThreshold(v int32)` + +SetPruneThreshold sets PruneThreshold field to given value. + +### HasPruneThreshold + +`func (o *RoleMiningSessionResponse) HasPruneThreshold() bool` + +HasPruneThreshold returns a boolean if a field has been set. + +### SetPruneThresholdNil + +`func (o *RoleMiningSessionResponse) SetPruneThresholdNil(b bool)` + + SetPruneThresholdNil sets the value for PruneThreshold to be an explicit nil + +### UnsetPruneThreshold +`func (o *RoleMiningSessionResponse) UnsetPruneThreshold()` + +UnsetPruneThreshold ensures that no value is present for PruneThreshold, not even an explicit nil +### GetPotentialRoleCount + +`func (o *RoleMiningSessionResponse) GetPotentialRoleCount() int32` + +GetPotentialRoleCount returns the PotentialRoleCount field if non-nil, zero value otherwise. + +### GetPotentialRoleCountOk + +`func (o *RoleMiningSessionResponse) GetPotentialRoleCountOk() (*int32, bool)` + +GetPotentialRoleCountOk returns a tuple with the PotentialRoleCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPotentialRoleCount + +`func (o *RoleMiningSessionResponse) SetPotentialRoleCount(v int32)` + +SetPotentialRoleCount sets PotentialRoleCount field to given value. + +### HasPotentialRoleCount + +`func (o *RoleMiningSessionResponse) HasPotentialRoleCount() bool` + +HasPotentialRoleCount returns a boolean if a field has been set. + +### GetPotentialRolesReadyCount + +`func (o *RoleMiningSessionResponse) GetPotentialRolesReadyCount() int32` + +GetPotentialRolesReadyCount returns the PotentialRolesReadyCount field if non-nil, zero value otherwise. + +### GetPotentialRolesReadyCountOk + +`func (o *RoleMiningSessionResponse) GetPotentialRolesReadyCountOk() (*int32, bool)` + +GetPotentialRolesReadyCountOk returns a tuple with the PotentialRolesReadyCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPotentialRolesReadyCount + +`func (o *RoleMiningSessionResponse) SetPotentialRolesReadyCount(v int32)` + +SetPotentialRolesReadyCount sets PotentialRolesReadyCount field to given value. + +### HasPotentialRolesReadyCount + +`func (o *RoleMiningSessionResponse) HasPotentialRolesReadyCount() bool` + +HasPotentialRolesReadyCount returns a boolean if a field has been set. + +### GetStatus + +`func (o *RoleMiningSessionResponse) GetStatus() RoleMiningSessionStatus` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *RoleMiningSessionResponse) GetStatusOk() (*RoleMiningSessionStatus, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *RoleMiningSessionResponse) SetStatus(v RoleMiningSessionStatus)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *RoleMiningSessionResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetEmailRecipientId + +`func (o *RoleMiningSessionResponse) GetEmailRecipientId() string` + +GetEmailRecipientId returns the EmailRecipientId field if non-nil, zero value otherwise. + +### GetEmailRecipientIdOk + +`func (o *RoleMiningSessionResponse) GetEmailRecipientIdOk() (*string, bool)` + +GetEmailRecipientIdOk returns a tuple with the EmailRecipientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailRecipientId + +`func (o *RoleMiningSessionResponse) SetEmailRecipientId(v string)` + +SetEmailRecipientId sets EmailRecipientId field to given value. + +### HasEmailRecipientId + +`func (o *RoleMiningSessionResponse) HasEmailRecipientId() bool` + +HasEmailRecipientId returns a boolean if a field has been set. + +### SetEmailRecipientIdNil + +`func (o *RoleMiningSessionResponse) SetEmailRecipientIdNil(b bool)` + + SetEmailRecipientIdNil sets the value for EmailRecipientId to be an explicit nil + +### UnsetEmailRecipientId +`func (o *RoleMiningSessionResponse) UnsetEmailRecipientId()` + +UnsetEmailRecipientId ensures that no value is present for EmailRecipientId, not even an explicit nil +### GetCreatedBy + +`func (o *RoleMiningSessionResponse) GetCreatedBy() RoleMiningSessionResponseCreatedBy` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *RoleMiningSessionResponse) GetCreatedByOk() (*RoleMiningSessionResponseCreatedBy, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *RoleMiningSessionResponse) SetCreatedBy(v RoleMiningSessionResponseCreatedBy)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *RoleMiningSessionResponse) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *RoleMiningSessionResponse) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *RoleMiningSessionResponse) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *RoleMiningSessionResponse) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *RoleMiningSessionResponse) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetSaved + +`func (o *RoleMiningSessionResponse) GetSaved() bool` + +GetSaved returns the Saved field if non-nil, zero value otherwise. + +### GetSavedOk + +`func (o *RoleMiningSessionResponse) GetSavedOk() (*bool, bool)` + +GetSavedOk returns a tuple with the Saved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSaved + +`func (o *RoleMiningSessionResponse) SetSaved(v bool)` + +SetSaved sets Saved field to given value. + +### HasSaved + +`func (o *RoleMiningSessionResponse) HasSaved() bool` + +HasSaved returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningSessionResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningSessionResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningSessionResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningSessionResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RoleMiningSessionResponse) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RoleMiningSessionResponse) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDataFilePath + +`func (o *RoleMiningSessionResponse) GetDataFilePath() string` + +GetDataFilePath returns the DataFilePath field if non-nil, zero value otherwise. + +### GetDataFilePathOk + +`func (o *RoleMiningSessionResponse) GetDataFilePathOk() (*string, bool)` + +GetDataFilePathOk returns a tuple with the DataFilePath field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataFilePath + +`func (o *RoleMiningSessionResponse) SetDataFilePath(v string)` + +SetDataFilePath sets DataFilePath field to given value. + +### HasDataFilePath + +`func (o *RoleMiningSessionResponse) HasDataFilePath() bool` + +HasDataFilePath returns a boolean if a field has been set. + +### SetDataFilePathNil + +`func (o *RoleMiningSessionResponse) SetDataFilePathNil(b bool)` + + SetDataFilePathNil sets the value for DataFilePath to be an explicit nil + +### UnsetDataFilePath +`func (o *RoleMiningSessionResponse) UnsetDataFilePath()` + +UnsetDataFilePath ensures that no value is present for DataFilePath, not even an explicit nil +### GetId + +`func (o *RoleMiningSessionResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningSessionResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningSessionResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningSessionResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleMiningSessionResponse) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleMiningSessionResponse) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleMiningSessionResponse) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleMiningSessionResponse) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetModifiedDate + +`func (o *RoleMiningSessionResponse) GetModifiedDate() SailPointTime` + +GetModifiedDate returns the ModifiedDate field if non-nil, zero value otherwise. + +### GetModifiedDateOk + +`func (o *RoleMiningSessionResponse) GetModifiedDateOk() (*SailPointTime, bool)` + +GetModifiedDateOk returns a tuple with the ModifiedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedDate + +`func (o *RoleMiningSessionResponse) SetModifiedDate(v SailPointTime)` + +SetModifiedDate sets ModifiedDate field to given value. + +### HasModifiedDate + +`func (o *RoleMiningSessionResponse) HasModifiedDate() bool` + +HasModifiedDate returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningSessionResponse) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningSessionResponse) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningSessionResponse) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningSessionResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionResponseCreatedBy.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionResponseCreatedBy.md new file mode 100644 index 000000000..65152f55b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionResponseCreatedBy.md @@ -0,0 +1,90 @@ +--- +id: beta-role-mining-session-response-created-by +title: RoleMiningSessionResponseCreatedBy +pagination_label: RoleMiningSessionResponseCreatedBy +sidebar_label: RoleMiningSessionResponseCreatedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionResponseCreatedBy', 'BetaRoleMiningSessionResponseCreatedBy'] +slug: /tools/sdk/go/beta/models/role-mining-session-response-created-by +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionResponseCreatedBy', 'BetaRoleMiningSessionResponseCreatedBy'] +--- + +# RoleMiningSessionResponseCreatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the creator | [optional] +**DisplayName** | Pointer to **string** | The display name of the creator | [optional] + +## Methods + +### NewRoleMiningSessionResponseCreatedBy + +`func NewRoleMiningSessionResponseCreatedBy() *RoleMiningSessionResponseCreatedBy` + +NewRoleMiningSessionResponseCreatedBy instantiates a new RoleMiningSessionResponseCreatedBy 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 + +### NewRoleMiningSessionResponseCreatedByWithDefaults + +`func NewRoleMiningSessionResponseCreatedByWithDefaults() *RoleMiningSessionResponseCreatedBy` + +NewRoleMiningSessionResponseCreatedByWithDefaults instantiates a new RoleMiningSessionResponseCreatedBy 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 + +### GetId + +`func (o *RoleMiningSessionResponseCreatedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningSessionResponseCreatedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningSessionResponseCreatedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningSessionResponseCreatedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *RoleMiningSessionResponseCreatedBy) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *RoleMiningSessionResponseCreatedBy) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *RoleMiningSessionResponseCreatedBy) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *RoleMiningSessionResponseCreatedBy) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionScope.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionScope.md new file mode 100644 index 000000000..1acf2da21 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionScope.md @@ -0,0 +1,136 @@ +--- +id: beta-role-mining-session-scope +title: RoleMiningSessionScope +pagination_label: RoleMiningSessionScope +sidebar_label: RoleMiningSessionScope +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionScope', 'BetaRoleMiningSessionScope'] +slug: /tools/sdk/go/beta/models/role-mining-session-scope +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionScope', 'BetaRoleMiningSessionScope'] +--- + +# RoleMiningSessionScope + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityIds** | Pointer to **[]string** | The list of identities for this role mining session. | [optional] +**Criteria** | Pointer to **NullableString** | The \"search\" criteria that produces the list of identities for this role mining session. | [optional] +**AttributeFilterCriteria** | Pointer to **[]map[string]interface{}** | The filter criteria for this role mining session. | [optional] + +## Methods + +### NewRoleMiningSessionScope + +`func NewRoleMiningSessionScope() *RoleMiningSessionScope` + +NewRoleMiningSessionScope instantiates a new RoleMiningSessionScope 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 + +### NewRoleMiningSessionScopeWithDefaults + +`func NewRoleMiningSessionScopeWithDefaults() *RoleMiningSessionScope` + +NewRoleMiningSessionScopeWithDefaults instantiates a new RoleMiningSessionScope 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 + +### GetIdentityIds + +`func (o *RoleMiningSessionScope) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *RoleMiningSessionScope) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *RoleMiningSessionScope) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *RoleMiningSessionScope) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + +### GetCriteria + +`func (o *RoleMiningSessionScope) GetCriteria() string` + +GetCriteria returns the Criteria field if non-nil, zero value otherwise. + +### GetCriteriaOk + +`func (o *RoleMiningSessionScope) GetCriteriaOk() (*string, bool)` + +GetCriteriaOk returns a tuple with the Criteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteria + +`func (o *RoleMiningSessionScope) SetCriteria(v string)` + +SetCriteria sets Criteria field to given value. + +### HasCriteria + +`func (o *RoleMiningSessionScope) HasCriteria() bool` + +HasCriteria returns a boolean if a field has been set. + +### SetCriteriaNil + +`func (o *RoleMiningSessionScope) SetCriteriaNil(b bool)` + + SetCriteriaNil sets the value for Criteria to be an explicit nil + +### UnsetCriteria +`func (o *RoleMiningSessionScope) UnsetCriteria()` + +UnsetCriteria ensures that no value is present for Criteria, not even an explicit nil +### GetAttributeFilterCriteria + +`func (o *RoleMiningSessionScope) GetAttributeFilterCriteria() []map[string]interface{}` + +GetAttributeFilterCriteria returns the AttributeFilterCriteria field if non-nil, zero value otherwise. + +### GetAttributeFilterCriteriaOk + +`func (o *RoleMiningSessionScope) GetAttributeFilterCriteriaOk() (*[]map[string]interface{}, bool)` + +GetAttributeFilterCriteriaOk returns a tuple with the AttributeFilterCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeFilterCriteria + +`func (o *RoleMiningSessionScope) SetAttributeFilterCriteria(v []map[string]interface{})` + +SetAttributeFilterCriteria sets AttributeFilterCriteria field to given value. + +### HasAttributeFilterCriteria + +`func (o *RoleMiningSessionScope) HasAttributeFilterCriteria() bool` + +HasAttributeFilterCriteria returns a boolean if a field has been set. + +### SetAttributeFilterCriteriaNil + +`func (o *RoleMiningSessionScope) SetAttributeFilterCriteriaNil(b bool)` + + SetAttributeFilterCriteriaNil sets the value for AttributeFilterCriteria to be an explicit nil + +### UnsetAttributeFilterCriteria +`func (o *RoleMiningSessionScope) UnsetAttributeFilterCriteria()` + +UnsetAttributeFilterCriteria ensures that no value is present for AttributeFilterCriteria, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionScopingMethod.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionScopingMethod.md new file mode 100644 index 000000000..472394ca5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionScopingMethod.md @@ -0,0 +1,21 @@ +--- +id: beta-role-mining-session-scoping-method +title: RoleMiningSessionScopingMethod +pagination_label: RoleMiningSessionScopingMethod +sidebar_label: RoleMiningSessionScopingMethod +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionScopingMethod', 'BetaRoleMiningSessionScopingMethod'] +slug: /tools/sdk/go/beta/models/role-mining-session-scoping-method +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionScopingMethod', 'BetaRoleMiningSessionScopingMethod'] +--- + +# RoleMiningSessionScopingMethod + +## Enum + + +* `MANUAL` (value: `"MANUAL"`) + +* `AUTO_RM` (value: `"AUTO_RM"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionState.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionState.md new file mode 100644 index 000000000..99316141c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionState.md @@ -0,0 +1,29 @@ +--- +id: beta-role-mining-session-state +title: RoleMiningSessionState +pagination_label: RoleMiningSessionState +sidebar_label: RoleMiningSessionState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionState', 'BetaRoleMiningSessionState'] +slug: /tools/sdk/go/beta/models/role-mining-session-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionState', 'BetaRoleMiningSessionState'] +--- + +# RoleMiningSessionState + +## Enum + + +* `CREATED` (value: `"CREATED"`) + +* `UPDATED` (value: `"UPDATED"`) + +* `IDENTITIES_OBTAINED` (value: `"IDENTITIES_OBTAINED"`) + +* `PRUNE_THRESHOLD_OBTAINED` (value: `"PRUNE_THRESHOLD_OBTAINED"`) + +* `POTENTIAL_ROLES_PROCESSING` (value: `"POTENTIAL_ROLES_PROCESSING"`) + +* `POTENTIAL_ROLES_CREATED` (value: `"POTENTIAL_ROLES_CREATED"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionStatus.md new file mode 100644 index 000000000..550ddbd49 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleMiningSessionStatus.md @@ -0,0 +1,64 @@ +--- +id: beta-role-mining-session-status +title: RoleMiningSessionStatus +pagination_label: RoleMiningSessionStatus +sidebar_label: RoleMiningSessionStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionStatus', 'BetaRoleMiningSessionStatus'] +slug: /tools/sdk/go/beta/models/role-mining-session-status +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionStatus', 'BetaRoleMiningSessionStatus'] +--- + +# RoleMiningSessionStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to [**RoleMiningSessionState**](role-mining-session-state) | | [optional] + +## Methods + +### NewRoleMiningSessionStatus + +`func NewRoleMiningSessionStatus() *RoleMiningSessionStatus` + +NewRoleMiningSessionStatus instantiates a new RoleMiningSessionStatus 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 + +### NewRoleMiningSessionStatusWithDefaults + +`func NewRoleMiningSessionStatusWithDefaults() *RoleMiningSessionStatus` + +NewRoleMiningSessionStatusWithDefaults instantiates a new RoleMiningSessionStatus 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 + +### GetState + +`func (o *RoleMiningSessionStatus) GetState() RoleMiningSessionState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *RoleMiningSessionStatus) GetStateOk() (*RoleMiningSessionState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *RoleMiningSessionStatus) SetState(v RoleMiningSessionState)` + +SetState sets State field to given value. + +### HasState + +`func (o *RoleMiningSessionStatus) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/RoleTargetDto.md b/docs/tools/sdk/go/Reference/Beta/Models/RoleTargetDto.md new file mode 100644 index 000000000..5f8deefec --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/RoleTargetDto.md @@ -0,0 +1,116 @@ +--- +id: beta-role-target-dto +title: RoleTargetDto +pagination_label: RoleTargetDto +sidebar_label: RoleTargetDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleTargetDto', 'BetaRoleTargetDto'] +slug: /tools/sdk/go/beta/models/role-target-dto +tags: ['SDK', 'Software Development Kit', 'RoleTargetDto', 'BetaRoleTargetDto'] +--- + +# RoleTargetDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**AccountInfo** | Pointer to [**AccountInfoDto**](account-info-dto) | | [optional] +**RoleName** | Pointer to **string** | Specific role name for this target if using multiple accounts | [optional] + +## Methods + +### NewRoleTargetDto + +`func NewRoleTargetDto() *RoleTargetDto` + +NewRoleTargetDto instantiates a new RoleTargetDto 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 + +### NewRoleTargetDtoWithDefaults + +`func NewRoleTargetDtoWithDefaults() *RoleTargetDto` + +NewRoleTargetDtoWithDefaults instantiates a new RoleTargetDto 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 + +### GetSource + +`func (o *RoleTargetDto) GetSource() BaseReferenceDto1` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *RoleTargetDto) GetSourceOk() (*BaseReferenceDto1, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *RoleTargetDto) SetSource(v BaseReferenceDto1)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *RoleTargetDto) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAccountInfo + +`func (o *RoleTargetDto) GetAccountInfo() AccountInfoDto` + +GetAccountInfo returns the AccountInfo field if non-nil, zero value otherwise. + +### GetAccountInfoOk + +`func (o *RoleTargetDto) GetAccountInfoOk() (*AccountInfoDto, bool)` + +GetAccountInfoOk returns a tuple with the AccountInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountInfo + +`func (o *RoleTargetDto) SetAccountInfo(v AccountInfoDto)` + +SetAccountInfo sets AccountInfo field to given value. + +### HasAccountInfo + +`func (o *RoleTargetDto) HasAccountInfo() bool` + +HasAccountInfo returns a boolean if a field has been set. + +### GetRoleName + +`func (o *RoleTargetDto) GetRoleName() string` + +GetRoleName returns the RoleName field if non-nil, zero value otherwise. + +### GetRoleNameOk + +`func (o *RoleTargetDto) GetRoleNameOk() (*string, bool)` + +GetRoleNameOk returns a tuple with the RoleName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleName + +`func (o *RoleTargetDto) SetRoleName(v string)` + +SetRoleName sets RoleName field to given value. + +### HasRoleName + +`func (o *RoleTargetDto) HasRoleName() bool` + +HasRoleName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SavedSearchComplete.md b/docs/tools/sdk/go/Reference/Beta/Models/SavedSearchComplete.md new file mode 100644 index 000000000..9a064df3d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SavedSearchComplete.md @@ -0,0 +1,185 @@ +--- +id: beta-saved-search-complete +title: SavedSearchComplete +pagination_label: SavedSearchComplete +sidebar_label: SavedSearchComplete +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchComplete', 'BetaSavedSearchComplete'] +slug: /tools/sdk/go/beta/models/saved-search-complete +tags: ['SDK', 'Software Development Kit', 'SavedSearchComplete', 'BetaSavedSearchComplete'] +--- + +# SavedSearchComplete + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FileName** | **string** | Report file name. | +**OwnerEmail** | **string** | Email address of the identity who owns the saved search. | +**OwnerName** | **string** | Name of the identity who owns the saved search. | +**Query** | **string** | Search query used to generate the report. | +**SearchName** | **string** | Saved search name. | +**SearchResults** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | +**SignedS3Url** | **string** | The Amazon S3 URL to download the report from. | + +## Methods + +### NewSavedSearchComplete + +`func NewSavedSearchComplete(fileName string, ownerEmail string, ownerName string, query string, searchName string, searchResults SavedSearchCompleteSearchResults, signedS3Url string, ) *SavedSearchComplete` + +NewSavedSearchComplete instantiates a new SavedSearchComplete 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 + +### NewSavedSearchCompleteWithDefaults + +`func NewSavedSearchCompleteWithDefaults() *SavedSearchComplete` + +NewSavedSearchCompleteWithDefaults instantiates a new SavedSearchComplete 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 + +### GetFileName + +`func (o *SavedSearchComplete) GetFileName() string` + +GetFileName returns the FileName field if non-nil, zero value otherwise. + +### GetFileNameOk + +`func (o *SavedSearchComplete) GetFileNameOk() (*string, bool)` + +GetFileNameOk returns a tuple with the FileName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileName + +`func (o *SavedSearchComplete) SetFileName(v string)` + +SetFileName sets FileName field to given value. + + +### GetOwnerEmail + +`func (o *SavedSearchComplete) GetOwnerEmail() string` + +GetOwnerEmail returns the OwnerEmail field if non-nil, zero value otherwise. + +### GetOwnerEmailOk + +`func (o *SavedSearchComplete) GetOwnerEmailOk() (*string, bool)` + +GetOwnerEmailOk returns a tuple with the OwnerEmail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerEmail + +`func (o *SavedSearchComplete) SetOwnerEmail(v string)` + +SetOwnerEmail sets OwnerEmail field to given value. + + +### GetOwnerName + +`func (o *SavedSearchComplete) GetOwnerName() string` + +GetOwnerName returns the OwnerName field if non-nil, zero value otherwise. + +### GetOwnerNameOk + +`func (o *SavedSearchComplete) GetOwnerNameOk() (*string, bool)` + +GetOwnerNameOk returns a tuple with the OwnerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerName + +`func (o *SavedSearchComplete) SetOwnerName(v string)` + +SetOwnerName sets OwnerName field to given value. + + +### GetQuery + +`func (o *SavedSearchComplete) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SavedSearchComplete) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SavedSearchComplete) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetSearchName + +`func (o *SavedSearchComplete) GetSearchName() string` + +GetSearchName returns the SearchName field if non-nil, zero value otherwise. + +### GetSearchNameOk + +`func (o *SavedSearchComplete) GetSearchNameOk() (*string, bool)` + +GetSearchNameOk returns a tuple with the SearchName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchName + +`func (o *SavedSearchComplete) SetSearchName(v string)` + +SetSearchName sets SearchName field to given value. + + +### GetSearchResults + +`func (o *SavedSearchComplete) GetSearchResults() SavedSearchCompleteSearchResults` + +GetSearchResults returns the SearchResults field if non-nil, zero value otherwise. + +### GetSearchResultsOk + +`func (o *SavedSearchComplete) GetSearchResultsOk() (*SavedSearchCompleteSearchResults, bool)` + +GetSearchResultsOk returns a tuple with the SearchResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchResults + +`func (o *SavedSearchComplete) SetSearchResults(v SavedSearchCompleteSearchResults)` + +SetSearchResults sets SearchResults field to given value. + + +### GetSignedS3Url + +`func (o *SavedSearchComplete) GetSignedS3Url() string` + +GetSignedS3Url returns the SignedS3Url field if non-nil, zero value otherwise. + +### GetSignedS3UrlOk + +`func (o *SavedSearchComplete) GetSignedS3UrlOk() (*string, bool)` + +GetSignedS3UrlOk returns a tuple with the SignedS3Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignedS3Url + +`func (o *SavedSearchComplete) SetSignedS3Url(v string)` + +SetSignedS3Url sets SignedS3Url field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SavedSearchCompleteSearchResults.md b/docs/tools/sdk/go/Reference/Beta/Models/SavedSearchCompleteSearchResults.md new file mode 100644 index 000000000..83dd9a99e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SavedSearchCompleteSearchResults.md @@ -0,0 +1,146 @@ +--- +id: beta-saved-search-complete-search-results +title: SavedSearchCompleteSearchResults +pagination_label: SavedSearchCompleteSearchResults +sidebar_label: SavedSearchCompleteSearchResults +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchCompleteSearchResults', 'BetaSavedSearchCompleteSearchResults'] +slug: /tools/sdk/go/beta/models/saved-search-complete-search-results +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResults', 'BetaSavedSearchCompleteSearchResults'] +--- + +# SavedSearchCompleteSearchResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Account** | Pointer to [**NullableSavedSearchCompleteSearchResultsAccount**](saved-search-complete-search-results-account) | | [optional] +**Entitlement** | Pointer to [**NullableSavedSearchCompleteSearchResultsEntitlement**](saved-search-complete-search-results-entitlement) | | [optional] +**Identity** | Pointer to [**NullableSavedSearchCompleteSearchResultsIdentity**](saved-search-complete-search-results-identity) | | [optional] + +## Methods + +### NewSavedSearchCompleteSearchResults + +`func NewSavedSearchCompleteSearchResults() *SavedSearchCompleteSearchResults` + +NewSavedSearchCompleteSearchResults instantiates a new SavedSearchCompleteSearchResults 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 + +### NewSavedSearchCompleteSearchResultsWithDefaults + +`func NewSavedSearchCompleteSearchResultsWithDefaults() *SavedSearchCompleteSearchResults` + +NewSavedSearchCompleteSearchResultsWithDefaults instantiates a new SavedSearchCompleteSearchResults 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 + +### GetAccount + +`func (o *SavedSearchCompleteSearchResults) GetAccount() SavedSearchCompleteSearchResultsAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *SavedSearchCompleteSearchResults) GetAccountOk() (*SavedSearchCompleteSearchResultsAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *SavedSearchCompleteSearchResults) SetAccount(v SavedSearchCompleteSearchResultsAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *SavedSearchCompleteSearchResults) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### SetAccountNil + +`func (o *SavedSearchCompleteSearchResults) SetAccountNil(b bool)` + + SetAccountNil sets the value for Account to be an explicit nil + +### UnsetAccount +`func (o *SavedSearchCompleteSearchResults) UnsetAccount()` + +UnsetAccount ensures that no value is present for Account, not even an explicit nil +### GetEntitlement + +`func (o *SavedSearchCompleteSearchResults) GetEntitlement() SavedSearchCompleteSearchResultsEntitlement` + +GetEntitlement returns the Entitlement field if non-nil, zero value otherwise. + +### GetEntitlementOk + +`func (o *SavedSearchCompleteSearchResults) GetEntitlementOk() (*SavedSearchCompleteSearchResultsEntitlement, bool)` + +GetEntitlementOk returns a tuple with the Entitlement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlement + +`func (o *SavedSearchCompleteSearchResults) SetEntitlement(v SavedSearchCompleteSearchResultsEntitlement)` + +SetEntitlement sets Entitlement field to given value. + +### HasEntitlement + +`func (o *SavedSearchCompleteSearchResults) HasEntitlement() bool` + +HasEntitlement returns a boolean if a field has been set. + +### SetEntitlementNil + +`func (o *SavedSearchCompleteSearchResults) SetEntitlementNil(b bool)` + + SetEntitlementNil sets the value for Entitlement to be an explicit nil + +### UnsetEntitlement +`func (o *SavedSearchCompleteSearchResults) UnsetEntitlement()` + +UnsetEntitlement ensures that no value is present for Entitlement, not even an explicit nil +### GetIdentity + +`func (o *SavedSearchCompleteSearchResults) GetIdentity() SavedSearchCompleteSearchResultsIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *SavedSearchCompleteSearchResults) GetIdentityOk() (*SavedSearchCompleteSearchResultsIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *SavedSearchCompleteSearchResults) SetIdentity(v SavedSearchCompleteSearchResultsIdentity)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *SavedSearchCompleteSearchResults) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### SetIdentityNil + +`func (o *SavedSearchCompleteSearchResults) SetIdentityNil(b bool)` + + SetIdentityNil sets the value for Identity to be an explicit nil + +### UnsetIdentity +`func (o *SavedSearchCompleteSearchResults) UnsetIdentity()` + +UnsetIdentity ensures that no value is present for Identity, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SavedSearchCompleteSearchResultsAccount.md b/docs/tools/sdk/go/Reference/Beta/Models/SavedSearchCompleteSearchResultsAccount.md new file mode 100644 index 000000000..8f64ce092 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SavedSearchCompleteSearchResultsAccount.md @@ -0,0 +1,101 @@ +--- +id: beta-saved-search-complete-search-results-account +title: SavedSearchCompleteSearchResultsAccount +pagination_label: SavedSearchCompleteSearchResultsAccount +sidebar_label: SavedSearchCompleteSearchResultsAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchCompleteSearchResultsAccount', 'BetaSavedSearchCompleteSearchResultsAccount'] +slug: /tools/sdk/go/beta/models/saved-search-complete-search-results-account +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsAccount', 'BetaSavedSearchCompleteSearchResultsAccount'] +--- + +# SavedSearchCompleteSearchResultsAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **string** | Number of rows in the table. | +**Noun** | **string** | Type of object represented in the table. | +**Preview** | **[][]string** | Sample of table data. | + +## Methods + +### NewSavedSearchCompleteSearchResultsAccount + +`func NewSavedSearchCompleteSearchResultsAccount(count string, noun string, preview [][]string, ) *SavedSearchCompleteSearchResultsAccount` + +NewSavedSearchCompleteSearchResultsAccount instantiates a new SavedSearchCompleteSearchResultsAccount 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 + +### NewSavedSearchCompleteSearchResultsAccountWithDefaults + +`func NewSavedSearchCompleteSearchResultsAccountWithDefaults() *SavedSearchCompleteSearchResultsAccount` + +NewSavedSearchCompleteSearchResultsAccountWithDefaults instantiates a new SavedSearchCompleteSearchResultsAccount 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 + +### GetCount + +`func (o *SavedSearchCompleteSearchResultsAccount) GetCount() string` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *SavedSearchCompleteSearchResultsAccount) GetCountOk() (*string, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *SavedSearchCompleteSearchResultsAccount) SetCount(v string)` + +SetCount sets Count field to given value. + + +### GetNoun + +`func (o *SavedSearchCompleteSearchResultsAccount) GetNoun() string` + +GetNoun returns the Noun field if non-nil, zero value otherwise. + +### GetNounOk + +`func (o *SavedSearchCompleteSearchResultsAccount) GetNounOk() (*string, bool)` + +GetNounOk returns a tuple with the Noun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNoun + +`func (o *SavedSearchCompleteSearchResultsAccount) SetNoun(v string)` + +SetNoun sets Noun field to given value. + + +### GetPreview + +`func (o *SavedSearchCompleteSearchResultsAccount) GetPreview() [][]string` + +GetPreview returns the Preview field if non-nil, zero value otherwise. + +### GetPreviewOk + +`func (o *SavedSearchCompleteSearchResultsAccount) GetPreviewOk() (*[][]string, bool)` + +GetPreviewOk returns a tuple with the Preview field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreview + +`func (o *SavedSearchCompleteSearchResultsAccount) SetPreview(v [][]string)` + +SetPreview sets Preview field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SavedSearchCompleteSearchResultsEntitlement.md b/docs/tools/sdk/go/Reference/Beta/Models/SavedSearchCompleteSearchResultsEntitlement.md new file mode 100644 index 000000000..cec7cf3ae --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SavedSearchCompleteSearchResultsEntitlement.md @@ -0,0 +1,101 @@ +--- +id: beta-saved-search-complete-search-results-entitlement +title: SavedSearchCompleteSearchResultsEntitlement +pagination_label: SavedSearchCompleteSearchResultsEntitlement +sidebar_label: SavedSearchCompleteSearchResultsEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchCompleteSearchResultsEntitlement', 'BetaSavedSearchCompleteSearchResultsEntitlement'] +slug: /tools/sdk/go/beta/models/saved-search-complete-search-results-entitlement +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsEntitlement', 'BetaSavedSearchCompleteSearchResultsEntitlement'] +--- + +# SavedSearchCompleteSearchResultsEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **string** | Number of rows in the table. | +**Noun** | **string** | Type of object represented in the table. | +**Preview** | **[][]string** | Sample of table data. | + +## Methods + +### NewSavedSearchCompleteSearchResultsEntitlement + +`func NewSavedSearchCompleteSearchResultsEntitlement(count string, noun string, preview [][]string, ) *SavedSearchCompleteSearchResultsEntitlement` + +NewSavedSearchCompleteSearchResultsEntitlement instantiates a new SavedSearchCompleteSearchResultsEntitlement 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 + +### NewSavedSearchCompleteSearchResultsEntitlementWithDefaults + +`func NewSavedSearchCompleteSearchResultsEntitlementWithDefaults() *SavedSearchCompleteSearchResultsEntitlement` + +NewSavedSearchCompleteSearchResultsEntitlementWithDefaults instantiates a new SavedSearchCompleteSearchResultsEntitlement 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 + +### GetCount + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetCount() string` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetCountOk() (*string, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *SavedSearchCompleteSearchResultsEntitlement) SetCount(v string)` + +SetCount sets Count field to given value. + + +### GetNoun + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetNoun() string` + +GetNoun returns the Noun field if non-nil, zero value otherwise. + +### GetNounOk + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetNounOk() (*string, bool)` + +GetNounOk returns a tuple with the Noun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNoun + +`func (o *SavedSearchCompleteSearchResultsEntitlement) SetNoun(v string)` + +SetNoun sets Noun field to given value. + + +### GetPreview + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetPreview() [][]string` + +GetPreview returns the Preview field if non-nil, zero value otherwise. + +### GetPreviewOk + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetPreviewOk() (*[][]string, bool)` + +GetPreviewOk returns a tuple with the Preview field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreview + +`func (o *SavedSearchCompleteSearchResultsEntitlement) SetPreview(v [][]string)` + +SetPreview sets Preview field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SavedSearchCompleteSearchResultsIdentity.md b/docs/tools/sdk/go/Reference/Beta/Models/SavedSearchCompleteSearchResultsIdentity.md new file mode 100644 index 000000000..9467cce3b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SavedSearchCompleteSearchResultsIdentity.md @@ -0,0 +1,101 @@ +--- +id: beta-saved-search-complete-search-results-identity +title: SavedSearchCompleteSearchResultsIdentity +pagination_label: SavedSearchCompleteSearchResultsIdentity +sidebar_label: SavedSearchCompleteSearchResultsIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchCompleteSearchResultsIdentity', 'BetaSavedSearchCompleteSearchResultsIdentity'] +slug: /tools/sdk/go/beta/models/saved-search-complete-search-results-identity +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsIdentity', 'BetaSavedSearchCompleteSearchResultsIdentity'] +--- + +# SavedSearchCompleteSearchResultsIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **string** | Number of rows in the table. | +**Noun** | **string** | Type of object represented in the table. | +**Preview** | **[][]string** | Sample of the table data. | + +## Methods + +### NewSavedSearchCompleteSearchResultsIdentity + +`func NewSavedSearchCompleteSearchResultsIdentity(count string, noun string, preview [][]string, ) *SavedSearchCompleteSearchResultsIdentity` + +NewSavedSearchCompleteSearchResultsIdentity instantiates a new SavedSearchCompleteSearchResultsIdentity 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 + +### NewSavedSearchCompleteSearchResultsIdentityWithDefaults + +`func NewSavedSearchCompleteSearchResultsIdentityWithDefaults() *SavedSearchCompleteSearchResultsIdentity` + +NewSavedSearchCompleteSearchResultsIdentityWithDefaults instantiates a new SavedSearchCompleteSearchResultsIdentity 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 + +### GetCount + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetCount() string` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetCountOk() (*string, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *SavedSearchCompleteSearchResultsIdentity) SetCount(v string)` + +SetCount sets Count field to given value. + + +### GetNoun + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetNoun() string` + +GetNoun returns the Noun field if non-nil, zero value otherwise. + +### GetNounOk + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetNounOk() (*string, bool)` + +GetNounOk returns a tuple with the Noun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNoun + +`func (o *SavedSearchCompleteSearchResultsIdentity) SetNoun(v string)` + +SetNoun sets Noun field to given value. + + +### GetPreview + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetPreview() [][]string` + +GetPreview returns the Preview field if non-nil, zero value otherwise. + +### GetPreviewOk + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetPreviewOk() (*[][]string, bool)` + +GetPreviewOk returns a tuple with the Preview field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreview + +`func (o *SavedSearchCompleteSearchResultsIdentity) SetPreview(v [][]string)` + +SetPreview sets Preview field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Schedule.md b/docs/tools/sdk/go/Reference/Beta/Models/Schedule.md new file mode 100644 index 000000000..769c45d4a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Schedule.md @@ -0,0 +1,184 @@ +--- +id: beta-schedule +title: Schedule +pagination_label: Schedule +sidebar_label: Schedule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule', 'BetaSchedule'] +slug: /tools/sdk/go/beta/models/schedule +tags: ['SDK', 'Software Development Kit', 'Schedule', 'BetaSchedule'] +--- + +# Schedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set. | +**Months** | Pointer to [**ScheduleMonths**](schedule-months) | | [optional] +**Days** | Pointer to [**ScheduleDays**](schedule-days) | | [optional] +**Hours** | [**ScheduleHours**](schedule-hours) | | +**Expiration** | Pointer to **SailPointTime** | Specifies the time after which this schedule will no longer occur. | [optional] +**TimeZoneId** | Pointer to **string** | The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST. | [optional] + +## Methods + +### NewSchedule + +`func NewSchedule(type_ string, hours ScheduleHours, ) *Schedule` + +NewSchedule instantiates a new Schedule 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 + +### NewScheduleWithDefaults + +`func NewScheduleWithDefaults() *Schedule` + +NewScheduleWithDefaults instantiates a new Schedule 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 + +### GetType + +`func (o *Schedule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Schedule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Schedule) SetType(v string)` + +SetType sets Type field to given value. + + +### GetMonths + +`func (o *Schedule) GetMonths() ScheduleMonths` + +GetMonths returns the Months field if non-nil, zero value otherwise. + +### GetMonthsOk + +`func (o *Schedule) GetMonthsOk() (*ScheduleMonths, bool)` + +GetMonthsOk returns a tuple with the Months field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMonths + +`func (o *Schedule) SetMonths(v ScheduleMonths)` + +SetMonths sets Months field to given value. + +### HasMonths + +`func (o *Schedule) HasMonths() bool` + +HasMonths returns a boolean if a field has been set. + +### GetDays + +`func (o *Schedule) GetDays() ScheduleDays` + +GetDays returns the Days field if non-nil, zero value otherwise. + +### GetDaysOk + +`func (o *Schedule) GetDaysOk() (*ScheduleDays, bool)` + +GetDaysOk returns a tuple with the Days field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDays + +`func (o *Schedule) SetDays(v ScheduleDays)` + +SetDays sets Days field to given value. + +### HasDays + +`func (o *Schedule) HasDays() bool` + +HasDays returns a boolean if a field has been set. + +### GetHours + +`func (o *Schedule) GetHours() ScheduleHours` + +GetHours returns the Hours field if non-nil, zero value otherwise. + +### GetHoursOk + +`func (o *Schedule) GetHoursOk() (*ScheduleHours, bool)` + +GetHoursOk returns a tuple with the Hours field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHours + +`func (o *Schedule) SetHours(v ScheduleHours)` + +SetHours sets Hours field to given value. + + +### GetExpiration + +`func (o *Schedule) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *Schedule) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *Schedule) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *Schedule) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + +### GetTimeZoneId + +`func (o *Schedule) GetTimeZoneId() string` + +GetTimeZoneId returns the TimeZoneId field if non-nil, zero value otherwise. + +### GetTimeZoneIdOk + +`func (o *Schedule) GetTimeZoneIdOk() (*string, bool)` + +GetTimeZoneIdOk returns a tuple with the TimeZoneId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZoneId + +`func (o *Schedule) SetTimeZoneId(v string)` + +SetTimeZoneId sets TimeZoneId field to given value. + +### HasTimeZoneId + +`func (o *Schedule) HasTimeZoneId() bool` + +HasTimeZoneId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Schedule1.md b/docs/tools/sdk/go/Reference/Beta/Models/Schedule1.md new file mode 100644 index 000000000..476c3c356 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Schedule1.md @@ -0,0 +1,204 @@ +--- +id: beta-schedule1 +title: Schedule1 +pagination_label: Schedule1 +sidebar_label: Schedule1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule1', 'BetaSchedule1'] +slug: /tools/sdk/go/beta/models/schedule1 +tags: ['SDK', 'Software Development Kit', 'Schedule1', 'BetaSchedule1'] +--- + +# Schedule1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**ScheduleType**](schedule-type) | | +**Months** | Pointer to [**Schedule1Months**](schedule1-months) | | [optional] +**Days** | Pointer to [**Schedule1Days**](schedule1-days) | | [optional] +**Hours** | [**Schedule1Hours**](schedule1-hours) | | +**Expiration** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**TimeZoneId** | Pointer to **NullableString** | The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used. | [optional] + +## Methods + +### NewSchedule1 + +`func NewSchedule1(type_ ScheduleType, hours Schedule1Hours, ) *Schedule1` + +NewSchedule1 instantiates a new Schedule1 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 + +### NewSchedule1WithDefaults + +`func NewSchedule1WithDefaults() *Schedule1` + +NewSchedule1WithDefaults instantiates a new Schedule1 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 + +### GetType + +`func (o *Schedule1) GetType() ScheduleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Schedule1) GetTypeOk() (*ScheduleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Schedule1) SetType(v ScheduleType)` + +SetType sets Type field to given value. + + +### GetMonths + +`func (o *Schedule1) GetMonths() Schedule1Months` + +GetMonths returns the Months field if non-nil, zero value otherwise. + +### GetMonthsOk + +`func (o *Schedule1) GetMonthsOk() (*Schedule1Months, bool)` + +GetMonthsOk returns a tuple with the Months field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMonths + +`func (o *Schedule1) SetMonths(v Schedule1Months)` + +SetMonths sets Months field to given value. + +### HasMonths + +`func (o *Schedule1) HasMonths() bool` + +HasMonths returns a boolean if a field has been set. + +### GetDays + +`func (o *Schedule1) GetDays() Schedule1Days` + +GetDays returns the Days field if non-nil, zero value otherwise. + +### GetDaysOk + +`func (o *Schedule1) GetDaysOk() (*Schedule1Days, bool)` + +GetDaysOk returns a tuple with the Days field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDays + +`func (o *Schedule1) SetDays(v Schedule1Days)` + +SetDays sets Days field to given value. + +### HasDays + +`func (o *Schedule1) HasDays() bool` + +HasDays returns a boolean if a field has been set. + +### GetHours + +`func (o *Schedule1) GetHours() Schedule1Hours` + +GetHours returns the Hours field if non-nil, zero value otherwise. + +### GetHoursOk + +`func (o *Schedule1) GetHoursOk() (*Schedule1Hours, bool)` + +GetHoursOk returns a tuple with the Hours field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHours + +`func (o *Schedule1) SetHours(v Schedule1Hours)` + +SetHours sets Hours field to given value. + + +### GetExpiration + +`func (o *Schedule1) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *Schedule1) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *Schedule1) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *Schedule1) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + +### SetExpirationNil + +`func (o *Schedule1) SetExpirationNil(b bool)` + + SetExpirationNil sets the value for Expiration to be an explicit nil + +### UnsetExpiration +`func (o *Schedule1) UnsetExpiration()` + +UnsetExpiration ensures that no value is present for Expiration, not even an explicit nil +### GetTimeZoneId + +`func (o *Schedule1) GetTimeZoneId() string` + +GetTimeZoneId returns the TimeZoneId field if non-nil, zero value otherwise. + +### GetTimeZoneIdOk + +`func (o *Schedule1) GetTimeZoneIdOk() (*string, bool)` + +GetTimeZoneIdOk returns a tuple with the TimeZoneId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZoneId + +`func (o *Schedule1) SetTimeZoneId(v string)` + +SetTimeZoneId sets TimeZoneId field to given value. + +### HasTimeZoneId + +`func (o *Schedule1) HasTimeZoneId() bool` + +HasTimeZoneId returns a boolean if a field has been set. + +### SetTimeZoneIdNil + +`func (o *Schedule1) SetTimeZoneIdNil(b bool)` + + SetTimeZoneIdNil sets the value for TimeZoneId to be an explicit nil + +### UnsetTimeZoneId +`func (o *Schedule1) UnsetTimeZoneId()` + +UnsetTimeZoneId ensures that no value is present for TimeZoneId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Schedule1Days.md b/docs/tools/sdk/go/Reference/Beta/Models/Schedule1Days.md new file mode 100644 index 000000000..42a5183c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Schedule1Days.md @@ -0,0 +1,90 @@ +--- +id: beta-schedule1-days +title: Schedule1Days +pagination_label: Schedule1Days +sidebar_label: Schedule1Days +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule1Days', 'BetaSchedule1Days'] +slug: /tools/sdk/go/beta/models/schedule1-days +tags: ['SDK', 'Software Development Kit', 'Schedule1Days', 'BetaSchedule1Days'] +--- + +# Schedule1Days + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **string** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Methods + +### NewSchedule1Days + +`func NewSchedule1Days() *Schedule1Days` + +NewSchedule1Days instantiates a new Schedule1Days 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 + +### NewSchedule1DaysWithDefaults + +`func NewSchedule1DaysWithDefaults() *Schedule1Days` + +NewSchedule1DaysWithDefaults instantiates a new Schedule1Days 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 + +### GetApplicationId + +`func (o *Schedule1Days) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *Schedule1Days) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *Schedule1Days) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *Schedule1Days) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### GetAccountMatchConfig + +`func (o *Schedule1Days) GetAccountMatchConfig() SelectorAccountMatchConfig` + +GetAccountMatchConfig returns the AccountMatchConfig field if non-nil, zero value otherwise. + +### GetAccountMatchConfigOk + +`func (o *Schedule1Days) GetAccountMatchConfigOk() (*SelectorAccountMatchConfig, bool)` + +GetAccountMatchConfigOk returns a tuple with the AccountMatchConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountMatchConfig + +`func (o *Schedule1Days) SetAccountMatchConfig(v SelectorAccountMatchConfig)` + +SetAccountMatchConfig sets AccountMatchConfig field to given value. + +### HasAccountMatchConfig + +`func (o *Schedule1Days) HasAccountMatchConfig() bool` + +HasAccountMatchConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Schedule1Hours.md b/docs/tools/sdk/go/Reference/Beta/Models/Schedule1Hours.md new file mode 100644 index 000000000..3cbb83f57 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Schedule1Hours.md @@ -0,0 +1,90 @@ +--- +id: beta-schedule1-hours +title: Schedule1Hours +pagination_label: Schedule1Hours +sidebar_label: Schedule1Hours +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule1Hours', 'BetaSchedule1Hours'] +slug: /tools/sdk/go/beta/models/schedule1-hours +tags: ['SDK', 'Software Development Kit', 'Schedule1Hours', 'BetaSchedule1Hours'] +--- + +# Schedule1Hours + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **string** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Methods + +### NewSchedule1Hours + +`func NewSchedule1Hours() *Schedule1Hours` + +NewSchedule1Hours instantiates a new Schedule1Hours 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 + +### NewSchedule1HoursWithDefaults + +`func NewSchedule1HoursWithDefaults() *Schedule1Hours` + +NewSchedule1HoursWithDefaults instantiates a new Schedule1Hours 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 + +### GetApplicationId + +`func (o *Schedule1Hours) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *Schedule1Hours) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *Schedule1Hours) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *Schedule1Hours) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### GetAccountMatchConfig + +`func (o *Schedule1Hours) GetAccountMatchConfig() SelectorAccountMatchConfig` + +GetAccountMatchConfig returns the AccountMatchConfig field if non-nil, zero value otherwise. + +### GetAccountMatchConfigOk + +`func (o *Schedule1Hours) GetAccountMatchConfigOk() (*SelectorAccountMatchConfig, bool)` + +GetAccountMatchConfigOk returns a tuple with the AccountMatchConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountMatchConfig + +`func (o *Schedule1Hours) SetAccountMatchConfig(v SelectorAccountMatchConfig)` + +SetAccountMatchConfig sets AccountMatchConfig field to given value. + +### HasAccountMatchConfig + +`func (o *Schedule1Hours) HasAccountMatchConfig() bool` + +HasAccountMatchConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Schedule1Months.md b/docs/tools/sdk/go/Reference/Beta/Models/Schedule1Months.md new file mode 100644 index 000000000..fe70a14ba --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Schedule1Months.md @@ -0,0 +1,90 @@ +--- +id: beta-schedule1-months +title: Schedule1Months +pagination_label: Schedule1Months +sidebar_label: Schedule1Months +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule1Months', 'BetaSchedule1Months'] +slug: /tools/sdk/go/beta/models/schedule1-months +tags: ['SDK', 'Software Development Kit', 'Schedule1Months', 'BetaSchedule1Months'] +--- + +# Schedule1Months + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **string** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Methods + +### NewSchedule1Months + +`func NewSchedule1Months() *Schedule1Months` + +NewSchedule1Months instantiates a new Schedule1Months 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 + +### NewSchedule1MonthsWithDefaults + +`func NewSchedule1MonthsWithDefaults() *Schedule1Months` + +NewSchedule1MonthsWithDefaults instantiates a new Schedule1Months 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 + +### GetApplicationId + +`func (o *Schedule1Months) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *Schedule1Months) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *Schedule1Months) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *Schedule1Months) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### GetAccountMatchConfig + +`func (o *Schedule1Months) GetAccountMatchConfig() SelectorAccountMatchConfig` + +GetAccountMatchConfig returns the AccountMatchConfig field if non-nil, zero value otherwise. + +### GetAccountMatchConfigOk + +`func (o *Schedule1Months) GetAccountMatchConfigOk() (*SelectorAccountMatchConfig, bool)` + +GetAccountMatchConfigOk returns a tuple with the AccountMatchConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountMatchConfig + +`func (o *Schedule1Months) SetAccountMatchConfig(v SelectorAccountMatchConfig)` + +SetAccountMatchConfig sets AccountMatchConfig field to given value. + +### HasAccountMatchConfig + +`func (o *Schedule1Months) HasAccountMatchConfig() bool` + +HasAccountMatchConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ScheduleDays.md b/docs/tools/sdk/go/Reference/Beta/Models/ScheduleDays.md new file mode 100644 index 000000000..8ed88ad65 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ScheduleDays.md @@ -0,0 +1,106 @@ +--- +id: beta-schedule-days +title: ScheduleDays +pagination_label: ScheduleDays +sidebar_label: ScheduleDays +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduleDays', 'BetaScheduleDays'] +slug: /tools/sdk/go/beta/models/schedule-days +tags: ['SDK', 'Software Development Kit', 'ScheduleDays', 'BetaScheduleDays'] +--- + +# ScheduleDays + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Enum type to specify days value | +**Values** | **[]string** | Values of the days based on the enum type mentioned above | +**Interval** | Pointer to **int64** | Interval between the cert generations | [optional] + +## Methods + +### NewScheduleDays + +`func NewScheduleDays(type_ string, values []string, ) *ScheduleDays` + +NewScheduleDays instantiates a new ScheduleDays 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 + +### NewScheduleDaysWithDefaults + +`func NewScheduleDaysWithDefaults() *ScheduleDays` + +NewScheduleDaysWithDefaults instantiates a new ScheduleDays 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 + +### GetType + +`func (o *ScheduleDays) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ScheduleDays) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ScheduleDays) SetType(v string)` + +SetType sets Type field to given value. + + +### GetValues + +`func (o *ScheduleDays) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *ScheduleDays) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *ScheduleDays) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### GetInterval + +`func (o *ScheduleDays) GetInterval() int64` + +GetInterval returns the Interval field if non-nil, zero value otherwise. + +### GetIntervalOk + +`func (o *ScheduleDays) GetIntervalOk() (*int64, bool)` + +GetIntervalOk returns a tuple with the Interval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterval + +`func (o *ScheduleDays) SetInterval(v int64)` + +SetInterval sets Interval field to given value. + +### HasInterval + +`func (o *ScheduleDays) HasInterval() bool` + +HasInterval returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ScheduleHours.md b/docs/tools/sdk/go/Reference/Beta/Models/ScheduleHours.md new file mode 100644 index 000000000..59d768675 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ScheduleHours.md @@ -0,0 +1,106 @@ +--- +id: beta-schedule-hours +title: ScheduleHours +pagination_label: ScheduleHours +sidebar_label: ScheduleHours +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduleHours', 'BetaScheduleHours'] +slug: /tools/sdk/go/beta/models/schedule-hours +tags: ['SDK', 'Software Development Kit', 'ScheduleHours', 'BetaScheduleHours'] +--- + +# ScheduleHours + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Enum type to specify hours value | +**Values** | **[]string** | Values of the days based on the enum type mentioned above | +**Interval** | Pointer to **int64** | Interval between the cert generations | [optional] + +## Methods + +### NewScheduleHours + +`func NewScheduleHours(type_ string, values []string, ) *ScheduleHours` + +NewScheduleHours instantiates a new ScheduleHours 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 + +### NewScheduleHoursWithDefaults + +`func NewScheduleHoursWithDefaults() *ScheduleHours` + +NewScheduleHoursWithDefaults instantiates a new ScheduleHours 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 + +### GetType + +`func (o *ScheduleHours) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ScheduleHours) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ScheduleHours) SetType(v string)` + +SetType sets Type field to given value. + + +### GetValues + +`func (o *ScheduleHours) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *ScheduleHours) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *ScheduleHours) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### GetInterval + +`func (o *ScheduleHours) GetInterval() int64` + +GetInterval returns the Interval field if non-nil, zero value otherwise. + +### GetIntervalOk + +`func (o *ScheduleHours) GetIntervalOk() (*int64, bool)` + +GetIntervalOk returns a tuple with the Interval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterval + +`func (o *ScheduleHours) SetInterval(v int64)` + +SetInterval sets Interval field to given value. + +### HasInterval + +`func (o *ScheduleHours) HasInterval() bool` + +HasInterval returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ScheduleMonths.md b/docs/tools/sdk/go/Reference/Beta/Models/ScheduleMonths.md new file mode 100644 index 000000000..01c88034b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ScheduleMonths.md @@ -0,0 +1,106 @@ +--- +id: beta-schedule-months +title: ScheduleMonths +pagination_label: ScheduleMonths +sidebar_label: ScheduleMonths +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduleMonths', 'BetaScheduleMonths'] +slug: /tools/sdk/go/beta/models/schedule-months +tags: ['SDK', 'Software Development Kit', 'ScheduleMonths', 'BetaScheduleMonths'] +--- + +# ScheduleMonths + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Enum type to specify months value | +**Values** | **[]string** | Values of the months based on the enum type mentioned above | +**Interval** | Pointer to **int64** | Interval between the cert generations | [optional] + +## Methods + +### NewScheduleMonths + +`func NewScheduleMonths(type_ string, values []string, ) *ScheduleMonths` + +NewScheduleMonths instantiates a new ScheduleMonths 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 + +### NewScheduleMonthsWithDefaults + +`func NewScheduleMonthsWithDefaults() *ScheduleMonths` + +NewScheduleMonthsWithDefaults instantiates a new ScheduleMonths 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 + +### GetType + +`func (o *ScheduleMonths) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ScheduleMonths) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ScheduleMonths) SetType(v string)` + +SetType sets Type field to given value. + + +### GetValues + +`func (o *ScheduleMonths) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *ScheduleMonths) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *ScheduleMonths) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### GetInterval + +`func (o *ScheduleMonths) GetInterval() int64` + +GetInterval returns the Interval field if non-nil, zero value otherwise. + +### GetIntervalOk + +`func (o *ScheduleMonths) GetIntervalOk() (*int64, bool)` + +GetIntervalOk returns a tuple with the Interval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterval + +`func (o *ScheduleMonths) SetInterval(v int64)` + +SetInterval sets Interval field to given value. + +### HasInterval + +`func (o *ScheduleMonths) HasInterval() bool` + +HasInterval returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ScheduleType.md b/docs/tools/sdk/go/Reference/Beta/Models/ScheduleType.md new file mode 100644 index 000000000..3026d8cbf --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ScheduleType.md @@ -0,0 +1,27 @@ +--- +id: beta-schedule-type +title: ScheduleType +pagination_label: ScheduleType +sidebar_label: ScheduleType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduleType', 'BetaScheduleType'] +slug: /tools/sdk/go/beta/models/schedule-type +tags: ['SDK', 'Software Development Kit', 'ScheduleType', 'BetaScheduleType'] +--- + +# ScheduleType + +## Enum + + +* `DAILY` (value: `"DAILY"`) + +* `WEEKLY` (value: `"WEEKLY"`) + +* `MONTHLY` (value: `"MONTHLY"`) + +* `CALENDAR` (value: `"CALENDAR"`) + +* `ANNUALLY` (value: `"ANNUALLY"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Schema.md b/docs/tools/sdk/go/Reference/Beta/Models/Schema.md new file mode 100644 index 000000000..234583a6b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Schema.md @@ -0,0 +1,370 @@ +--- +id: beta-schema +title: Schema +pagination_label: Schema +sidebar_label: Schema +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schema', 'BetaSchema'] +slug: /tools/sdk/go/beta/models/schema +tags: ['SDK', 'Software Development Kit', 'Schema', 'BetaSchema'] +--- + +# Schema + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the Schema. | [optional] +**Name** | Pointer to **string** | The name of the Schema. | [optional] +**NativeObjectType** | Pointer to **string** | The name of the object type on the native system that the schema represents. | [optional] +**IdentityAttribute** | Pointer to **string** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional] +**DisplayAttribute** | Pointer to **string** | The name of the attribute used to calculate the display value for an object in the schema. | [optional] +**HierarchyAttribute** | Pointer to **NullableString** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional] +**IncludePermissions** | Pointer to **bool** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] [default to false] +**Features** | Pointer to **[]string** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Configuration** | Pointer to **map[string]interface{}** | Holds any extra configuration data that the schema may require. | [optional] +**Attributes** | Pointer to [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional] +**Created** | Pointer to **SailPointTime** | The date the Schema was created. | [optional] +**Modified** | Pointer to **NullableTime** | The date the Schema was last modified. | [optional] + +## Methods + +### NewSchema + +`func NewSchema() *Schema` + +NewSchema instantiates a new Schema 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 + +### NewSchemaWithDefaults + +`func NewSchemaWithDefaults() *Schema` + +NewSchemaWithDefaults instantiates a new Schema 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 + +### GetId + +`func (o *Schema) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Schema) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Schema) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Schema) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Schema) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Schema) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Schema) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Schema) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetNativeObjectType + +`func (o *Schema) GetNativeObjectType() string` + +GetNativeObjectType returns the NativeObjectType field if non-nil, zero value otherwise. + +### GetNativeObjectTypeOk + +`func (o *Schema) GetNativeObjectTypeOk() (*string, bool)` + +GetNativeObjectTypeOk returns a tuple with the NativeObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeObjectType + +`func (o *Schema) SetNativeObjectType(v string)` + +SetNativeObjectType sets NativeObjectType field to given value. + +### HasNativeObjectType + +`func (o *Schema) HasNativeObjectType() bool` + +HasNativeObjectType returns a boolean if a field has been set. + +### GetIdentityAttribute + +`func (o *Schema) GetIdentityAttribute() string` + +GetIdentityAttribute returns the IdentityAttribute field if non-nil, zero value otherwise. + +### GetIdentityAttributeOk + +`func (o *Schema) GetIdentityAttributeOk() (*string, bool)` + +GetIdentityAttributeOk returns a tuple with the IdentityAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttribute + +`func (o *Schema) SetIdentityAttribute(v string)` + +SetIdentityAttribute sets IdentityAttribute field to given value. + +### HasIdentityAttribute + +`func (o *Schema) HasIdentityAttribute() bool` + +HasIdentityAttribute returns a boolean if a field has been set. + +### GetDisplayAttribute + +`func (o *Schema) GetDisplayAttribute() string` + +GetDisplayAttribute returns the DisplayAttribute field if non-nil, zero value otherwise. + +### GetDisplayAttributeOk + +`func (o *Schema) GetDisplayAttributeOk() (*string, bool)` + +GetDisplayAttributeOk returns a tuple with the DisplayAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayAttribute + +`func (o *Schema) SetDisplayAttribute(v string)` + +SetDisplayAttribute sets DisplayAttribute field to given value. + +### HasDisplayAttribute + +`func (o *Schema) HasDisplayAttribute() bool` + +HasDisplayAttribute returns a boolean if a field has been set. + +### GetHierarchyAttribute + +`func (o *Schema) GetHierarchyAttribute() string` + +GetHierarchyAttribute returns the HierarchyAttribute field if non-nil, zero value otherwise. + +### GetHierarchyAttributeOk + +`func (o *Schema) GetHierarchyAttributeOk() (*string, bool)` + +GetHierarchyAttributeOk returns a tuple with the HierarchyAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHierarchyAttribute + +`func (o *Schema) SetHierarchyAttribute(v string)` + +SetHierarchyAttribute sets HierarchyAttribute field to given value. + +### HasHierarchyAttribute + +`func (o *Schema) HasHierarchyAttribute() bool` + +HasHierarchyAttribute returns a boolean if a field has been set. + +### SetHierarchyAttributeNil + +`func (o *Schema) SetHierarchyAttributeNil(b bool)` + + SetHierarchyAttributeNil sets the value for HierarchyAttribute to be an explicit nil + +### UnsetHierarchyAttribute +`func (o *Schema) UnsetHierarchyAttribute()` + +UnsetHierarchyAttribute ensures that no value is present for HierarchyAttribute, not even an explicit nil +### GetIncludePermissions + +`func (o *Schema) GetIncludePermissions() bool` + +GetIncludePermissions returns the IncludePermissions field if non-nil, zero value otherwise. + +### GetIncludePermissionsOk + +`func (o *Schema) GetIncludePermissionsOk() (*bool, bool)` + +GetIncludePermissionsOk returns a tuple with the IncludePermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludePermissions + +`func (o *Schema) SetIncludePermissions(v bool)` + +SetIncludePermissions sets IncludePermissions field to given value. + +### HasIncludePermissions + +`func (o *Schema) HasIncludePermissions() bool` + +HasIncludePermissions returns a boolean if a field has been set. + +### GetFeatures + +`func (o *Schema) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *Schema) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *Schema) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *Schema) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### GetConfiguration + +`func (o *Schema) GetConfiguration() map[string]interface{}` + +GetConfiguration returns the Configuration field if non-nil, zero value otherwise. + +### GetConfigurationOk + +`func (o *Schema) GetConfigurationOk() (*map[string]interface{}, bool)` + +GetConfigurationOk returns a tuple with the Configuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfiguration + +`func (o *Schema) SetConfiguration(v map[string]interface{})` + +SetConfiguration sets Configuration field to given value. + +### HasConfiguration + +`func (o *Schema) HasConfiguration() bool` + +HasConfiguration returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Schema) GetAttributes() []AttributeDefinition` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Schema) GetAttributesOk() (*[]AttributeDefinition, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Schema) SetAttributes(v []AttributeDefinition)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Schema) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetCreated + +`func (o *Schema) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Schema) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Schema) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Schema) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Schema) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Schema) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Schema) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Schema) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *Schema) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *Schema) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SearchAttributeConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/SearchAttributeConfig.md new file mode 100644 index 000000000..df8925dcf --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SearchAttributeConfig.md @@ -0,0 +1,116 @@ +--- +id: beta-search-attribute-config +title: SearchAttributeConfig +pagination_label: SearchAttributeConfig +sidebar_label: SearchAttributeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchAttributeConfig', 'BetaSearchAttributeConfig'] +slug: /tools/sdk/go/beta/models/search-attribute-config +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfig', 'BetaSearchAttributeConfig'] +--- + +# SearchAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the new attribute | [optional] +**DisplayName** | Pointer to **string** | The display name of the new attribute | [optional] +**ApplicationAttributes** | Pointer to **map[string]interface{}** | Map of application id and their associated attribute. | [optional] + +## Methods + +### NewSearchAttributeConfig + +`func NewSearchAttributeConfig() *SearchAttributeConfig` + +NewSearchAttributeConfig instantiates a new SearchAttributeConfig 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 + +### NewSearchAttributeConfigWithDefaults + +`func NewSearchAttributeConfigWithDefaults() *SearchAttributeConfig` + +NewSearchAttributeConfigWithDefaults instantiates a new SearchAttributeConfig 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 + +### GetName + +`func (o *SearchAttributeConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SearchAttributeConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SearchAttributeConfig) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SearchAttributeConfig) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *SearchAttributeConfig) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *SearchAttributeConfig) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *SearchAttributeConfig) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *SearchAttributeConfig) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetApplicationAttributes + +`func (o *SearchAttributeConfig) GetApplicationAttributes() map[string]interface{}` + +GetApplicationAttributes returns the ApplicationAttributes field if non-nil, zero value otherwise. + +### GetApplicationAttributesOk + +`func (o *SearchAttributeConfig) GetApplicationAttributesOk() (*map[string]interface{}, bool)` + +GetApplicationAttributesOk returns a tuple with the ApplicationAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationAttributes + +`func (o *SearchAttributeConfig) SetApplicationAttributes(v map[string]interface{})` + +SetApplicationAttributes sets ApplicationAttributes field to given value. + +### HasApplicationAttributes + +`func (o *SearchAttributeConfig) HasApplicationAttributes() bool` + +HasApplicationAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SearchFormDefinitionsByTenant400Response.md b/docs/tools/sdk/go/Reference/Beta/Models/SearchFormDefinitionsByTenant400Response.md new file mode 100644 index 000000000..c8b396e6a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SearchFormDefinitionsByTenant400Response.md @@ -0,0 +1,142 @@ +--- +id: beta-search-form-definitions-by-tenant400-response +title: SearchFormDefinitionsByTenant400Response +pagination_label: SearchFormDefinitionsByTenant400Response +sidebar_label: SearchFormDefinitionsByTenant400Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchFormDefinitionsByTenant400Response', 'BetaSearchFormDefinitionsByTenant400Response'] +slug: /tools/sdk/go/beta/models/search-form-definitions-by-tenant400-response +tags: ['SDK', 'Software Development Kit', 'SearchFormDefinitionsByTenant400Response', 'BetaSearchFormDefinitionsByTenant400Response'] +--- + +# SearchFormDefinitionsByTenant400Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **string** | | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | | [optional] +**StatusCode** | Pointer to **int64** | | [optional] +**TrackingId** | Pointer to **string** | | [optional] + +## Methods + +### NewSearchFormDefinitionsByTenant400Response + +`func NewSearchFormDefinitionsByTenant400Response() *SearchFormDefinitionsByTenant400Response` + +NewSearchFormDefinitionsByTenant400Response instantiates a new SearchFormDefinitionsByTenant400Response 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 + +### NewSearchFormDefinitionsByTenant400ResponseWithDefaults + +`func NewSearchFormDefinitionsByTenant400ResponseWithDefaults() *SearchFormDefinitionsByTenant400Response` + +NewSearchFormDefinitionsByTenant400ResponseWithDefaults instantiates a new SearchFormDefinitionsByTenant400Response 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 + +### GetDetailCode + +`func (o *SearchFormDefinitionsByTenant400Response) GetDetailCode() string` + +GetDetailCode returns the DetailCode field if non-nil, zero value otherwise. + +### GetDetailCodeOk + +`func (o *SearchFormDefinitionsByTenant400Response) GetDetailCodeOk() (*string, bool)` + +GetDetailCodeOk returns a tuple with the DetailCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetailCode + +`func (o *SearchFormDefinitionsByTenant400Response) SetDetailCode(v string)` + +SetDetailCode sets DetailCode field to given value. + +### HasDetailCode + +`func (o *SearchFormDefinitionsByTenant400Response) HasDetailCode() bool` + +HasDetailCode returns a boolean if a field has been set. + +### GetMessages + +`func (o *SearchFormDefinitionsByTenant400Response) GetMessages() []ErrorMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *SearchFormDefinitionsByTenant400Response) GetMessagesOk() (*[]ErrorMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *SearchFormDefinitionsByTenant400Response) SetMessages(v []ErrorMessage)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *SearchFormDefinitionsByTenant400Response) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetStatusCode + +`func (o *SearchFormDefinitionsByTenant400Response) GetStatusCode() int64` + +GetStatusCode returns the StatusCode field if non-nil, zero value otherwise. + +### GetStatusCodeOk + +`func (o *SearchFormDefinitionsByTenant400Response) GetStatusCodeOk() (*int64, bool)` + +GetStatusCodeOk returns a tuple with the StatusCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusCode + +`func (o *SearchFormDefinitionsByTenant400Response) SetStatusCode(v int64)` + +SetStatusCode sets StatusCode field to given value. + +### HasStatusCode + +`func (o *SearchFormDefinitionsByTenant400Response) HasStatusCode() bool` + +HasStatusCode returns a boolean if a field has been set. + +### GetTrackingId + +`func (o *SearchFormDefinitionsByTenant400Response) GetTrackingId() string` + +GetTrackingId returns the TrackingId field if non-nil, zero value otherwise. + +### GetTrackingIdOk + +`func (o *SearchFormDefinitionsByTenant400Response) GetTrackingIdOk() (*string, bool)` + +GetTrackingIdOk returns a tuple with the TrackingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingId + +`func (o *SearchFormDefinitionsByTenant400Response) SetTrackingId(v string)` + +SetTrackingId sets TrackingId field to given value. + +### HasTrackingId + +`func (o *SearchFormDefinitionsByTenant400Response) HasTrackingId() bool` + +HasTrackingId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Section.md b/docs/tools/sdk/go/Reference/Beta/Models/Section.md new file mode 100644 index 000000000..8fd0ce7eb --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Section.md @@ -0,0 +1,116 @@ +--- +id: beta-section +title: Section +pagination_label: Section +sidebar_label: Section +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Section', 'BetaSection'] +slug: /tools/sdk/go/beta/models/section +tags: ['SDK', 'Software Development Kit', 'Section', 'BetaSection'] +--- + +# Section + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the FormItem | [optional] +**Label** | Pointer to **string** | Label of the section | [optional] +**FormItems** | Pointer to **[]map[string]interface{}** | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [optional] + +## Methods + +### NewSection + +`func NewSection() *Section` + +NewSection instantiates a new Section 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 + +### NewSectionWithDefaults + +`func NewSectionWithDefaults() *Section` + +NewSectionWithDefaults instantiates a new Section 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 + +### GetName + +`func (o *Section) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Section) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Section) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Section) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetLabel + +`func (o *Section) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *Section) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *Section) SetLabel(v string)` + +SetLabel sets Label field to given value. + +### HasLabel + +`func (o *Section) HasLabel() bool` + +HasLabel returns a boolean if a field has been set. + +### GetFormItems + +`func (o *Section) GetFormItems() []map[string]interface{}` + +GetFormItems returns the FormItems field if non-nil, zero value otherwise. + +### GetFormItemsOk + +`func (o *Section) GetFormItemsOk() (*[]map[string]interface{}, bool)` + +GetFormItemsOk returns a tuple with the FormItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormItems + +`func (o *Section) SetFormItems(v []map[string]interface{})` + +SetFormItems sets FormItems field to given value. + +### HasFormItems + +`func (o *Section) HasFormItems() bool` + +HasFormItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SectionDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/SectionDetails.md new file mode 100644 index 000000000..36fe82239 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SectionDetails.md @@ -0,0 +1,116 @@ +--- +id: beta-section-details +title: SectionDetails +pagination_label: SectionDetails +sidebar_label: SectionDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SectionDetails', 'BetaSectionDetails'] +slug: /tools/sdk/go/beta/models/section-details +tags: ['SDK', 'Software Development Kit', 'SectionDetails', 'BetaSectionDetails'] +--- + +# SectionDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the FormItem | [optional] +**Label** | Pointer to **string** | Label of the section | [optional] +**FormItems** | Pointer to **[]map[string]interface{}** | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [optional] + +## Methods + +### NewSectionDetails + +`func NewSectionDetails() *SectionDetails` + +NewSectionDetails instantiates a new SectionDetails 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 + +### NewSectionDetailsWithDefaults + +`func NewSectionDetailsWithDefaults() *SectionDetails` + +NewSectionDetailsWithDefaults instantiates a new SectionDetails 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 + +### GetName + +`func (o *SectionDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SectionDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SectionDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SectionDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetLabel + +`func (o *SectionDetails) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *SectionDetails) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *SectionDetails) SetLabel(v string)` + +SetLabel sets Label field to given value. + +### HasLabel + +`func (o *SectionDetails) HasLabel() bool` + +HasLabel returns a boolean if a field has been set. + +### GetFormItems + +`func (o *SectionDetails) GetFormItems() []map[string]interface{}` + +GetFormItems returns the FormItems field if non-nil, zero value otherwise. + +### GetFormItemsOk + +`func (o *SectionDetails) GetFormItemsOk() (*[]map[string]interface{}, bool)` + +GetFormItemsOk returns a tuple with the FormItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormItems + +`func (o *SectionDetails) SetFormItems(v []map[string]interface{})` + +SetFormItems sets FormItems field to given value. + +### HasFormItems + +`func (o *SectionDetails) HasFormItems() bool` + +HasFormItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Sed.md b/docs/tools/sdk/go/Reference/Beta/Models/Sed.md new file mode 100644 index 000000000..69c1e2227 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Sed.md @@ -0,0 +1,402 @@ +--- +id: beta-sed +title: Sed +pagination_label: Sed +sidebar_label: Sed +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Sed', 'BetaSed'] +slug: /tools/sdk/go/beta/models/sed +tags: ['SDK', 'Software Development Kit', 'Sed', 'BetaSed'] +--- + +# Sed + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | name of the entitlement | [optional] +**ApprovedBy** | Pointer to **string** | entitlement approved by | [optional] +**ApprovedType** | Pointer to **string** | entitlement approved type | [optional] +**ApprovedWhen** | Pointer to **SailPointTime** | entitlement approved then | [optional] +**Attribute** | Pointer to **string** | entitlement attribute | [optional] +**Description** | Pointer to **string** | description of entitlement | [optional] +**DisplayName** | Pointer to **string** | entitlement display name | [optional] +**Id** | Pointer to **string** | sed id | [optional] +**SourceId** | Pointer to **string** | entitlement source id | [optional] +**SourceName** | Pointer to **string** | entitlement source name | [optional] +**Status** | Pointer to **string** | entitlement status | [optional] +**SuggestedDescription** | Pointer to **string** | llm suggested entitlement description | [optional] +**Type** | Pointer to **string** | entitlement type | [optional] +**Value** | Pointer to **string** | entitlement value | [optional] + +## Methods + +### NewSed + +`func NewSed() *Sed` + +NewSed instantiates a new Sed 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 + +### NewSedWithDefaults + +`func NewSedWithDefaults() *Sed` + +NewSedWithDefaults instantiates a new Sed 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 + +### GetName + +`func (o *Sed) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Sed) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Sed) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Sed) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetApprovedBy + +`func (o *Sed) GetApprovedBy() string` + +GetApprovedBy returns the ApprovedBy field if non-nil, zero value otherwise. + +### GetApprovedByOk + +`func (o *Sed) GetApprovedByOk() (*string, bool)` + +GetApprovedByOk returns a tuple with the ApprovedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovedBy + +`func (o *Sed) SetApprovedBy(v string)` + +SetApprovedBy sets ApprovedBy field to given value. + +### HasApprovedBy + +`func (o *Sed) HasApprovedBy() bool` + +HasApprovedBy returns a boolean if a field has been set. + +### GetApprovedType + +`func (o *Sed) GetApprovedType() string` + +GetApprovedType returns the ApprovedType field if non-nil, zero value otherwise. + +### GetApprovedTypeOk + +`func (o *Sed) GetApprovedTypeOk() (*string, bool)` + +GetApprovedTypeOk returns a tuple with the ApprovedType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovedType + +`func (o *Sed) SetApprovedType(v string)` + +SetApprovedType sets ApprovedType field to given value. + +### HasApprovedType + +`func (o *Sed) HasApprovedType() bool` + +HasApprovedType returns a boolean if a field has been set. + +### GetApprovedWhen + +`func (o *Sed) GetApprovedWhen() SailPointTime` + +GetApprovedWhen returns the ApprovedWhen field if non-nil, zero value otherwise. + +### GetApprovedWhenOk + +`func (o *Sed) GetApprovedWhenOk() (*SailPointTime, bool)` + +GetApprovedWhenOk returns a tuple with the ApprovedWhen field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovedWhen + +`func (o *Sed) SetApprovedWhen(v SailPointTime)` + +SetApprovedWhen sets ApprovedWhen field to given value. + +### HasApprovedWhen + +`func (o *Sed) HasApprovedWhen() bool` + +HasApprovedWhen returns a boolean if a field has been set. + +### GetAttribute + +`func (o *Sed) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *Sed) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *Sed) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *Sed) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetDescription + +`func (o *Sed) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Sed) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Sed) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Sed) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *Sed) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *Sed) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *Sed) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *Sed) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetId + +`func (o *Sed) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Sed) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Sed) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Sed) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *Sed) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *Sed) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *Sed) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *Sed) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceName + +`func (o *Sed) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *Sed) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *Sed) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *Sed) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetStatus + +`func (o *Sed) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Sed) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Sed) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Sed) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSuggestedDescription + +`func (o *Sed) GetSuggestedDescription() string` + +GetSuggestedDescription returns the SuggestedDescription field if non-nil, zero value otherwise. + +### GetSuggestedDescriptionOk + +`func (o *Sed) GetSuggestedDescriptionOk() (*string, bool)` + +GetSuggestedDescriptionOk returns a tuple with the SuggestedDescription field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSuggestedDescription + +`func (o *Sed) SetSuggestedDescription(v string)` + +SetSuggestedDescription sets SuggestedDescription field to given value. + +### HasSuggestedDescription + +`func (o *Sed) HasSuggestedDescription() bool` + +HasSuggestedDescription returns a boolean if a field has been set. + +### GetType + +`func (o *Sed) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Sed) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Sed) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Sed) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetValue + +`func (o *Sed) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Sed) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Sed) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Sed) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SedApproval.md b/docs/tools/sdk/go/Reference/Beta/Models/SedApproval.md new file mode 100644 index 000000000..9271e99de --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SedApproval.md @@ -0,0 +1,64 @@ +--- +id: beta-sed-approval +title: SedApproval +pagination_label: SedApproval +sidebar_label: SedApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedApproval', 'BetaSedApproval'] +slug: /tools/sdk/go/beta/models/sed-approval +tags: ['SDK', 'Software Development Kit', 'SedApproval', 'BetaSedApproval'] +--- + +# SedApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Items** | Pointer to **[]string** | List of SED id's | [optional] + +## Methods + +### NewSedApproval + +`func NewSedApproval() *SedApproval` + +NewSedApproval instantiates a new SedApproval 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 + +### NewSedApprovalWithDefaults + +`func NewSedApprovalWithDefaults() *SedApproval` + +NewSedApprovalWithDefaults instantiates a new SedApproval 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 + +### GetItems + +`func (o *SedApproval) GetItems() []string` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *SedApproval) GetItemsOk() (*[]string, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *SedApproval) SetItems(v []string)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *SedApproval) HasItems() bool` + +HasItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SedApprovalStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/SedApprovalStatus.md new file mode 100644 index 000000000..0c8427390 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SedApprovalStatus.md @@ -0,0 +1,116 @@ +--- +id: beta-sed-approval-status +title: SedApprovalStatus +pagination_label: SedApprovalStatus +sidebar_label: SedApprovalStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedApprovalStatus', 'BetaSedApprovalStatus'] +slug: /tools/sdk/go/beta/models/sed-approval-status +tags: ['SDK', 'Software Development Kit', 'SedApprovalStatus', 'BetaSedApprovalStatus'] +--- + +# SedApprovalStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FailedReason** | Pointer to **string** | failed reason will be display if status is failed | [optional] +**Id** | Pointer to **string** | Sed id | [optional] +**Status** | Pointer to **string** | SUCCESS | FAILED | [optional] + +## Methods + +### NewSedApprovalStatus + +`func NewSedApprovalStatus() *SedApprovalStatus` + +NewSedApprovalStatus instantiates a new SedApprovalStatus 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 + +### NewSedApprovalStatusWithDefaults + +`func NewSedApprovalStatusWithDefaults() *SedApprovalStatus` + +NewSedApprovalStatusWithDefaults instantiates a new SedApprovalStatus 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 + +### GetFailedReason + +`func (o *SedApprovalStatus) GetFailedReason() string` + +GetFailedReason returns the FailedReason field if non-nil, zero value otherwise. + +### GetFailedReasonOk + +`func (o *SedApprovalStatus) GetFailedReasonOk() (*string, bool)` + +GetFailedReasonOk returns a tuple with the FailedReason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFailedReason + +`func (o *SedApprovalStatus) SetFailedReason(v string)` + +SetFailedReason sets FailedReason field to given value. + +### HasFailedReason + +`func (o *SedApprovalStatus) HasFailedReason() bool` + +HasFailedReason returns a boolean if a field has been set. + +### GetId + +`func (o *SedApprovalStatus) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SedApprovalStatus) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SedApprovalStatus) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SedApprovalStatus) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetStatus + +`func (o *SedApprovalStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SedApprovalStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SedApprovalStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SedApprovalStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SedAssignee.md b/docs/tools/sdk/go/Reference/Beta/Models/SedAssignee.md new file mode 100644 index 000000000..d2221ef6d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SedAssignee.md @@ -0,0 +1,85 @@ +--- +id: beta-sed-assignee +title: SedAssignee +pagination_label: SedAssignee +sidebar_label: SedAssignee +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedAssignee', 'BetaSedAssignee'] +slug: /tools/sdk/go/beta/models/sed-assignee +tags: ['SDK', 'Software Development Kit', 'SedAssignee', 'BetaSedAssignee'] +--- + +# SedAssignee + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of assignment When value is PERSONA, the value MUST be SOURCE_OWNER or ENTITLEMENT_OWNER IDENTITY SED_ASSIGNEE_IDENTITY_TYPE GROUP SED_ASSIGNEE_GROUP_TYPE SOURCE_OWNER SED_ASSIGNEE_SOURCE_OWNER_TYPE ENTITLEMENT_OWNER SED_ASSIGNEE_ENTITLEMENT_OWNER_TYPE | +**Value** | Pointer to **string** | Identity or Group identifier Empty when using source/entitlement owner personas | [optional] + +## Methods + +### NewSedAssignee + +`func NewSedAssignee(type_ string, ) *SedAssignee` + +NewSedAssignee instantiates a new SedAssignee 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 + +### NewSedAssigneeWithDefaults + +`func NewSedAssigneeWithDefaults() *SedAssignee` + +NewSedAssigneeWithDefaults instantiates a new SedAssignee 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 + +### GetType + +`func (o *SedAssignee) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SedAssignee) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SedAssignee) SetType(v string)` + +SetType sets Type field to given value. + + +### GetValue + +`func (o *SedAssignee) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SedAssignee) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SedAssignee) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SedAssignee) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SedAssignment.md b/docs/tools/sdk/go/Reference/Beta/Models/SedAssignment.md new file mode 100644 index 000000000..992230665 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SedAssignment.md @@ -0,0 +1,90 @@ +--- +id: beta-sed-assignment +title: SedAssignment +pagination_label: SedAssignment +sidebar_label: SedAssignment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedAssignment', 'BetaSedAssignment'] +slug: /tools/sdk/go/beta/models/sed-assignment +tags: ['SDK', 'Software Development Kit', 'SedAssignment', 'BetaSedAssignment'] +--- + +# SedAssignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Assignee** | Pointer to [**SedAssignee**](sed-assignee) | | [optional] +**Items** | Pointer to **[]string** | List of SED id's | [optional] + +## Methods + +### NewSedAssignment + +`func NewSedAssignment() *SedAssignment` + +NewSedAssignment instantiates a new SedAssignment 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 + +### NewSedAssignmentWithDefaults + +`func NewSedAssignmentWithDefaults() *SedAssignment` + +NewSedAssignmentWithDefaults instantiates a new SedAssignment 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 + +### GetAssignee + +`func (o *SedAssignment) GetAssignee() SedAssignee` + +GetAssignee returns the Assignee field if non-nil, zero value otherwise. + +### GetAssigneeOk + +`func (o *SedAssignment) GetAssigneeOk() (*SedAssignee, bool)` + +GetAssigneeOk returns a tuple with the Assignee field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignee + +`func (o *SedAssignment) SetAssignee(v SedAssignee)` + +SetAssignee sets Assignee field to given value. + +### HasAssignee + +`func (o *SedAssignment) HasAssignee() bool` + +HasAssignee returns a boolean if a field has been set. + +### GetItems + +`func (o *SedAssignment) GetItems() []string` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *SedAssignment) GetItemsOk() (*[]string, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *SedAssignment) SetItems(v []string)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *SedAssignment) HasItems() bool` + +HasItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SedAssignmentResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/SedAssignmentResponse.md new file mode 100644 index 000000000..0b097970f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SedAssignmentResponse.md @@ -0,0 +1,64 @@ +--- +id: beta-sed-assignment-response +title: SedAssignmentResponse +pagination_label: SedAssignmentResponse +sidebar_label: SedAssignmentResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedAssignmentResponse', 'BetaSedAssignmentResponse'] +slug: /tools/sdk/go/beta/models/sed-assignment-response +tags: ['SDK', 'Software Development Kit', 'SedAssignmentResponse', 'BetaSedAssignmentResponse'] +--- + +# SedAssignmentResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **string** | BatchId that groups all the ids together | [optional] + +## Methods + +### NewSedAssignmentResponse + +`func NewSedAssignmentResponse() *SedAssignmentResponse` + +NewSedAssignmentResponse instantiates a new SedAssignmentResponse 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 + +### NewSedAssignmentResponseWithDefaults + +`func NewSedAssignmentResponseWithDefaults() *SedAssignmentResponse` + +NewSedAssignmentResponseWithDefaults instantiates a new SedAssignmentResponse 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 + +### GetBatchId + +`func (o *SedAssignmentResponse) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *SedAssignmentResponse) GetBatchIdOk() (*string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchId + +`func (o *SedAssignmentResponse) SetBatchId(v string)` + +SetBatchId sets BatchId field to given value. + +### HasBatchId + +`func (o *SedAssignmentResponse) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SedBatchRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/SedBatchRequest.md new file mode 100644 index 000000000..987c011ad --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SedBatchRequest.md @@ -0,0 +1,90 @@ +--- +id: beta-sed-batch-request +title: SedBatchRequest +pagination_label: SedBatchRequest +sidebar_label: SedBatchRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedBatchRequest', 'BetaSedBatchRequest'] +slug: /tools/sdk/go/beta/models/sed-batch-request +tags: ['SDK', 'Software Development Kit', 'SedBatchRequest', 'BetaSedBatchRequest'] +--- + +# SedBatchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Entitlements** | Pointer to **[]string** | list of entitlement ids | [optional] +**Seds** | Pointer to **[]string** | list of sed ids | [optional] + +## Methods + +### NewSedBatchRequest + +`func NewSedBatchRequest() *SedBatchRequest` + +NewSedBatchRequest instantiates a new SedBatchRequest 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 + +### NewSedBatchRequestWithDefaults + +`func NewSedBatchRequestWithDefaults() *SedBatchRequest` + +NewSedBatchRequestWithDefaults instantiates a new SedBatchRequest 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 + +### GetEntitlements + +`func (o *SedBatchRequest) GetEntitlements() []string` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *SedBatchRequest) GetEntitlementsOk() (*[]string, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *SedBatchRequest) SetEntitlements(v []string)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *SedBatchRequest) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetSeds + +`func (o *SedBatchRequest) GetSeds() []string` + +GetSeds returns the Seds field if non-nil, zero value otherwise. + +### GetSedsOk + +`func (o *SedBatchRequest) GetSedsOk() (*[]string, bool)` + +GetSedsOk returns a tuple with the Seds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSeds + +`func (o *SedBatchRequest) SetSeds(v []string)` + +SetSeds sets Seds field to given value. + +### HasSeds + +`func (o *SedBatchRequest) HasSeds() bool` + +HasSeds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SedBatchResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/SedBatchResponse.md new file mode 100644 index 000000000..b3a344ea0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SedBatchResponse.md @@ -0,0 +1,64 @@ +--- +id: beta-sed-batch-response +title: SedBatchResponse +pagination_label: SedBatchResponse +sidebar_label: SedBatchResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedBatchResponse', 'BetaSedBatchResponse'] +slug: /tools/sdk/go/beta/models/sed-batch-response +tags: ['SDK', 'Software Development Kit', 'SedBatchResponse', 'BetaSedBatchResponse'] +--- + +# SedBatchResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **string** | BatchId that groups all the ids together | [optional] + +## Methods + +### NewSedBatchResponse + +`func NewSedBatchResponse() *SedBatchResponse` + +NewSedBatchResponse instantiates a new SedBatchResponse 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 + +### NewSedBatchResponseWithDefaults + +`func NewSedBatchResponseWithDefaults() *SedBatchResponse` + +NewSedBatchResponseWithDefaults instantiates a new SedBatchResponse 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 + +### GetBatchId + +`func (o *SedBatchResponse) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *SedBatchResponse) GetBatchIdOk() (*string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchId + +`func (o *SedBatchResponse) SetBatchId(v string)` + +SetBatchId sets BatchId field to given value. + +### HasBatchId + +`func (o *SedBatchResponse) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SedBatchStats.md b/docs/tools/sdk/go/Reference/Beta/Models/SedBatchStats.md new file mode 100644 index 000000000..5d089d7d3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SedBatchStats.md @@ -0,0 +1,168 @@ +--- +id: beta-sed-batch-stats +title: SedBatchStats +pagination_label: SedBatchStats +sidebar_label: SedBatchStats +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedBatchStats', 'BetaSedBatchStats'] +slug: /tools/sdk/go/beta/models/sed-batch-stats +tags: ['SDK', 'Software Development Kit', 'SedBatchStats', 'BetaSedBatchStats'] +--- + +# SedBatchStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchComplete** | Pointer to **bool** | batch complete | [optional] [default to false] +**BatchId** | Pointer to **string** | batch Id | [optional] +**DiscoveredCount** | Pointer to **int64** | discovered count | [optional] +**DiscoveryComplete** | Pointer to **bool** | discovery complete | [optional] [default to false] +**ProcessedCount** | Pointer to **int64** | processed count | [optional] + +## Methods + +### NewSedBatchStats + +`func NewSedBatchStats() *SedBatchStats` + +NewSedBatchStats instantiates a new SedBatchStats 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 + +### NewSedBatchStatsWithDefaults + +`func NewSedBatchStatsWithDefaults() *SedBatchStats` + +NewSedBatchStatsWithDefaults instantiates a new SedBatchStats 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 + +### GetBatchComplete + +`func (o *SedBatchStats) GetBatchComplete() bool` + +GetBatchComplete returns the BatchComplete field if non-nil, zero value otherwise. + +### GetBatchCompleteOk + +`func (o *SedBatchStats) GetBatchCompleteOk() (*bool, bool)` + +GetBatchCompleteOk returns a tuple with the BatchComplete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchComplete + +`func (o *SedBatchStats) SetBatchComplete(v bool)` + +SetBatchComplete sets BatchComplete field to given value. + +### HasBatchComplete + +`func (o *SedBatchStats) HasBatchComplete() bool` + +HasBatchComplete returns a boolean if a field has been set. + +### GetBatchId + +`func (o *SedBatchStats) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *SedBatchStats) GetBatchIdOk() (*string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchId + +`func (o *SedBatchStats) SetBatchId(v string)` + +SetBatchId sets BatchId field to given value. + +### HasBatchId + +`func (o *SedBatchStats) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### GetDiscoveredCount + +`func (o *SedBatchStats) GetDiscoveredCount() int64` + +GetDiscoveredCount returns the DiscoveredCount field if non-nil, zero value otherwise. + +### GetDiscoveredCountOk + +`func (o *SedBatchStats) GetDiscoveredCountOk() (*int64, bool)` + +GetDiscoveredCountOk returns a tuple with the DiscoveredCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredCount + +`func (o *SedBatchStats) SetDiscoveredCount(v int64)` + +SetDiscoveredCount sets DiscoveredCount field to given value. + +### HasDiscoveredCount + +`func (o *SedBatchStats) HasDiscoveredCount() bool` + +HasDiscoveredCount returns a boolean if a field has been set. + +### GetDiscoveryComplete + +`func (o *SedBatchStats) GetDiscoveryComplete() bool` + +GetDiscoveryComplete returns the DiscoveryComplete field if non-nil, zero value otherwise. + +### GetDiscoveryCompleteOk + +`func (o *SedBatchStats) GetDiscoveryCompleteOk() (*bool, bool)` + +GetDiscoveryCompleteOk returns a tuple with the DiscoveryComplete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveryComplete + +`func (o *SedBatchStats) SetDiscoveryComplete(v bool)` + +SetDiscoveryComplete sets DiscoveryComplete field to given value. + +### HasDiscoveryComplete + +`func (o *SedBatchStats) HasDiscoveryComplete() bool` + +HasDiscoveryComplete returns a boolean if a field has been set. + +### GetProcessedCount + +`func (o *SedBatchStats) GetProcessedCount() int64` + +GetProcessedCount returns the ProcessedCount field if non-nil, zero value otherwise. + +### GetProcessedCountOk + +`func (o *SedBatchStats) GetProcessedCountOk() (*int64, bool)` + +GetProcessedCountOk returns a tuple with the ProcessedCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessedCount + +`func (o *SedBatchStats) SetProcessedCount(v int64)` + +SetProcessedCount sets ProcessedCount field to given value. + +### HasProcessedCount + +`func (o *SedBatchStats) HasProcessedCount() bool` + +HasProcessedCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SedBatchStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/SedBatchStatus.md new file mode 100644 index 000000000..be2a00587 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SedBatchStatus.md @@ -0,0 +1,64 @@ +--- +id: beta-sed-batch-status +title: SedBatchStatus +pagination_label: SedBatchStatus +sidebar_label: SedBatchStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedBatchStatus', 'BetaSedBatchStatus'] +slug: /tools/sdk/go/beta/models/sed-batch-status +tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'BetaSedBatchStatus'] +--- + +# SedBatchStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | status of batch | [optional] + +## Methods + +### NewSedBatchStatus + +`func NewSedBatchStatus() *SedBatchStatus` + +NewSedBatchStatus instantiates a new SedBatchStatus 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 + +### NewSedBatchStatusWithDefaults + +`func NewSedBatchStatusWithDefaults() *SedBatchStatus` + +NewSedBatchStatusWithDefaults instantiates a new SedBatchStatus 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 + +### GetStatus + +`func (o *SedBatchStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SedBatchStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SedBatchStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SedBatchStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SedPatch.md b/docs/tools/sdk/go/Reference/Beta/Models/SedPatch.md new file mode 100644 index 000000000..c68b0f4e2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SedPatch.md @@ -0,0 +1,116 @@ +--- +id: beta-sed-patch +title: SedPatch +pagination_label: SedPatch +sidebar_label: SedPatch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedPatch', 'BetaSedPatch'] +slug: /tools/sdk/go/beta/models/sed-patch +tags: ['SDK', 'Software Development Kit', 'SedPatch', 'BetaSedPatch'] +--- + +# SedPatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | Pointer to **string** | desired operation | [optional] +**Path** | Pointer to **string** | field to be patched | [optional] +**Value** | Pointer to **map[string]interface{}** | value to replace with | [optional] + +## Methods + +### NewSedPatch + +`func NewSedPatch() *SedPatch` + +NewSedPatch instantiates a new SedPatch 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 + +### NewSedPatchWithDefaults + +`func NewSedPatchWithDefaults() *SedPatch` + +NewSedPatchWithDefaults instantiates a new SedPatch 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 + +### GetOp + +`func (o *SedPatch) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *SedPatch) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *SedPatch) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *SedPatch) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetPath + +`func (o *SedPatch) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *SedPatch) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *SedPatch) SetPath(v string)` + +SetPath sets Path field to given value. + +### HasPath + +`func (o *SedPatch) HasPath() bool` + +HasPath returns a boolean if a field has been set. + +### GetValue + +`func (o *SedPatch) GetValue() map[string]interface{}` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SedPatch) GetValueOk() (*map[string]interface{}, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SedPatch) SetValue(v map[string]interface{})` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SedPatch) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Segment.md b/docs/tools/sdk/go/Reference/Beta/Models/Segment.md new file mode 100644 index 000000000..a2f66a370 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Segment.md @@ -0,0 +1,266 @@ +--- +id: beta-segment +title: Segment +pagination_label: Segment +sidebar_label: Segment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Segment', 'BetaSegment'] +slug: /tools/sdk/go/beta/models/segment +tags: ['SDK', 'Software Development Kit', 'Segment', 'BetaSegment'] +--- + +# Segment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The segment's ID. | [optional] +**Name** | Pointer to **string** | The segment's business name. | [optional] +**Created** | Pointer to **SailPointTime** | The time when the segment is created. | [optional] +**Modified** | Pointer to **SailPointTime** | The time when the segment is modified. | [optional] +**Description** | Pointer to **string** | The segment's optional description. | [optional] +**Owner** | Pointer to [**NullableOwnerReferenceSegments**](owner-reference-segments) | | [optional] +**VisibilityCriteria** | Pointer to [**NullableVisibilityCriteria**](visibility-criteria) | | [optional] +**Active** | Pointer to **bool** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to false] + +## Methods + +### NewSegment + +`func NewSegment() *Segment` + +NewSegment instantiates a new Segment 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 + +### NewSegmentWithDefaults + +`func NewSegmentWithDefaults() *Segment` + +NewSegmentWithDefaults instantiates a new Segment 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 + +### GetId + +`func (o *Segment) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Segment) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Segment) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Segment) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Segment) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Segment) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Segment) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Segment) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *Segment) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Segment) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Segment) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Segment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Segment) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Segment) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Segment) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Segment) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *Segment) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Segment) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Segment) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Segment) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *Segment) GetOwner() OwnerReferenceSegments` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Segment) GetOwnerOk() (*OwnerReferenceSegments, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Segment) SetOwner(v OwnerReferenceSegments)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *Segment) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *Segment) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *Segment) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetVisibilityCriteria + +`func (o *Segment) GetVisibilityCriteria() VisibilityCriteria` + +GetVisibilityCriteria returns the VisibilityCriteria field if non-nil, zero value otherwise. + +### GetVisibilityCriteriaOk + +`func (o *Segment) GetVisibilityCriteriaOk() (*VisibilityCriteria, bool)` + +GetVisibilityCriteriaOk returns a tuple with the VisibilityCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVisibilityCriteria + +`func (o *Segment) SetVisibilityCriteria(v VisibilityCriteria)` + +SetVisibilityCriteria sets VisibilityCriteria field to given value. + +### HasVisibilityCriteria + +`func (o *Segment) HasVisibilityCriteria() bool` + +HasVisibilityCriteria returns a boolean if a field has been set. + +### SetVisibilityCriteriaNil + +`func (o *Segment) SetVisibilityCriteriaNil(b bool)` + + SetVisibilityCriteriaNil sets the value for VisibilityCriteria to be an explicit nil + +### UnsetVisibilityCriteria +`func (o *Segment) UnsetVisibilityCriteria()` + +UnsetVisibilityCriteria ensures that no value is present for VisibilityCriteria, not even an explicit nil +### GetActive + +`func (o *Segment) GetActive() bool` + +GetActive returns the Active field if non-nil, zero value otherwise. + +### GetActiveOk + +`func (o *Segment) GetActiveOk() (*bool, bool)` + +GetActiveOk returns a tuple with the Active field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActive + +`func (o *Segment) SetActive(v bool)` + +SetActive sets Active field to given value. + +### HasActive + +`func (o *Segment) HasActive() bool` + +HasActive returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Selector.md b/docs/tools/sdk/go/Reference/Beta/Models/Selector.md new file mode 100644 index 000000000..d68babdae --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Selector.md @@ -0,0 +1,90 @@ +--- +id: beta-selector +title: Selector +pagination_label: Selector +sidebar_label: Selector +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Selector', 'BetaSelector'] +slug: /tools/sdk/go/beta/models/selector +tags: ['SDK', 'Software Development Kit', 'Selector', 'BetaSelector'] +--- + +# Selector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **string** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Methods + +### NewSelector + +`func NewSelector() *Selector` + +NewSelector instantiates a new Selector 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 + +### NewSelectorWithDefaults + +`func NewSelectorWithDefaults() *Selector` + +NewSelectorWithDefaults instantiates a new Selector 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 + +### GetApplicationId + +`func (o *Selector) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *Selector) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *Selector) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *Selector) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### GetAccountMatchConfig + +`func (o *Selector) GetAccountMatchConfig() SelectorAccountMatchConfig` + +GetAccountMatchConfig returns the AccountMatchConfig field if non-nil, zero value otherwise. + +### GetAccountMatchConfigOk + +`func (o *Selector) GetAccountMatchConfigOk() (*SelectorAccountMatchConfig, bool)` + +GetAccountMatchConfigOk returns a tuple with the AccountMatchConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountMatchConfig + +`func (o *Selector) SetAccountMatchConfig(v SelectorAccountMatchConfig)` + +SetAccountMatchConfig sets AccountMatchConfig field to given value. + +### HasAccountMatchConfig + +`func (o *Selector) HasAccountMatchConfig() bool` + +HasAccountMatchConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SelectorAccountMatchConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/SelectorAccountMatchConfig.md new file mode 100644 index 000000000..a74c8599a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SelectorAccountMatchConfig.md @@ -0,0 +1,64 @@ +--- +id: beta-selector-account-match-config +title: SelectorAccountMatchConfig +pagination_label: SelectorAccountMatchConfig +sidebar_label: SelectorAccountMatchConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SelectorAccountMatchConfig', 'BetaSelectorAccountMatchConfig'] +slug: /tools/sdk/go/beta/models/selector-account-match-config +tags: ['SDK', 'Software Development Kit', 'SelectorAccountMatchConfig', 'BetaSelectorAccountMatchConfig'] +--- + +# SelectorAccountMatchConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MatchExpression** | Pointer to [**SelectorAccountMatchConfigMatchExpression**](selector-account-match-config-match-expression) | | [optional] + +## Methods + +### NewSelectorAccountMatchConfig + +`func NewSelectorAccountMatchConfig() *SelectorAccountMatchConfig` + +NewSelectorAccountMatchConfig instantiates a new SelectorAccountMatchConfig 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 + +### NewSelectorAccountMatchConfigWithDefaults + +`func NewSelectorAccountMatchConfigWithDefaults() *SelectorAccountMatchConfig` + +NewSelectorAccountMatchConfigWithDefaults instantiates a new SelectorAccountMatchConfig 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 + +### GetMatchExpression + +`func (o *SelectorAccountMatchConfig) GetMatchExpression() SelectorAccountMatchConfigMatchExpression` + +GetMatchExpression returns the MatchExpression field if non-nil, zero value otherwise. + +### GetMatchExpressionOk + +`func (o *SelectorAccountMatchConfig) GetMatchExpressionOk() (*SelectorAccountMatchConfigMatchExpression, bool)` + +GetMatchExpressionOk returns a tuple with the MatchExpression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchExpression + +`func (o *SelectorAccountMatchConfig) SetMatchExpression(v SelectorAccountMatchConfigMatchExpression)` + +SetMatchExpression sets MatchExpression field to given value. + +### HasMatchExpression + +`func (o *SelectorAccountMatchConfig) HasMatchExpression() bool` + +HasMatchExpression returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SelectorAccountMatchConfigMatchExpression.md b/docs/tools/sdk/go/Reference/Beta/Models/SelectorAccountMatchConfigMatchExpression.md new file mode 100644 index 000000000..e37cd3831 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SelectorAccountMatchConfigMatchExpression.md @@ -0,0 +1,90 @@ +--- +id: beta-selector-account-match-config-match-expression +title: SelectorAccountMatchConfigMatchExpression +pagination_label: SelectorAccountMatchConfigMatchExpression +sidebar_label: SelectorAccountMatchConfigMatchExpression +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SelectorAccountMatchConfigMatchExpression', 'BetaSelectorAccountMatchConfigMatchExpression'] +slug: /tools/sdk/go/beta/models/selector-account-match-config-match-expression +tags: ['SDK', 'Software Development Kit', 'SelectorAccountMatchConfigMatchExpression', 'BetaSelectorAccountMatchConfigMatchExpression'] +--- + +# SelectorAccountMatchConfigMatchExpression + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MatchTerms** | Pointer to [**[]MatchTerm**](match-term) | | [optional] +**And** | Pointer to **bool** | If it is AND operators for match terms | [optional] [default to true] + +## Methods + +### NewSelectorAccountMatchConfigMatchExpression + +`func NewSelectorAccountMatchConfigMatchExpression() *SelectorAccountMatchConfigMatchExpression` + +NewSelectorAccountMatchConfigMatchExpression instantiates a new SelectorAccountMatchConfigMatchExpression 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 + +### NewSelectorAccountMatchConfigMatchExpressionWithDefaults + +`func NewSelectorAccountMatchConfigMatchExpressionWithDefaults() *SelectorAccountMatchConfigMatchExpression` + +NewSelectorAccountMatchConfigMatchExpressionWithDefaults instantiates a new SelectorAccountMatchConfigMatchExpression 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 + +### GetMatchTerms + +`func (o *SelectorAccountMatchConfigMatchExpression) GetMatchTerms() []MatchTerm` + +GetMatchTerms returns the MatchTerms field if non-nil, zero value otherwise. + +### GetMatchTermsOk + +`func (o *SelectorAccountMatchConfigMatchExpression) GetMatchTermsOk() (*[]MatchTerm, bool)` + +GetMatchTermsOk returns a tuple with the MatchTerms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchTerms + +`func (o *SelectorAccountMatchConfigMatchExpression) SetMatchTerms(v []MatchTerm)` + +SetMatchTerms sets MatchTerms field to given value. + +### HasMatchTerms + +`func (o *SelectorAccountMatchConfigMatchExpression) HasMatchTerms() bool` + +HasMatchTerms returns a boolean if a field has been set. + +### GetAnd + +`func (o *SelectorAccountMatchConfigMatchExpression) GetAnd() bool` + +GetAnd returns the And field if non-nil, zero value otherwise. + +### GetAndOk + +`func (o *SelectorAccountMatchConfigMatchExpression) GetAndOk() (*bool, bool)` + +GetAndOk returns a tuple with the And field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnd + +`func (o *SelectorAccountMatchConfigMatchExpression) SetAnd(v bool)` + +SetAnd sets And field to given value. + +### HasAnd + +`func (o *SelectorAccountMatchConfigMatchExpression) HasAnd() bool` + +HasAnd returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SelfImportExportDto.md b/docs/tools/sdk/go/Reference/Beta/Models/SelfImportExportDto.md new file mode 100644 index 000000000..38d7ad22b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SelfImportExportDto.md @@ -0,0 +1,116 @@ +--- +id: beta-self-import-export-dto +title: SelfImportExportDto +pagination_label: SelfImportExportDto +sidebar_label: SelfImportExportDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SelfImportExportDto', 'BetaSelfImportExportDto'] +slug: /tools/sdk/go/beta/models/self-import-export-dto +tags: ['SDK', 'Software Development Kit', 'SelfImportExportDto', 'BetaSelfImportExportDto'] +--- + +# SelfImportExportDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Imported/exported object's DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [optional] +**Id** | Pointer to **string** | Imported/exported object's ID. | [optional] +**Name** | Pointer to **string** | Imported/exported object's display name. | [optional] + +## Methods + +### NewSelfImportExportDto + +`func NewSelfImportExportDto() *SelfImportExportDto` + +NewSelfImportExportDto instantiates a new SelfImportExportDto 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 + +### NewSelfImportExportDtoWithDefaults + +`func NewSelfImportExportDtoWithDefaults() *SelfImportExportDto` + +NewSelfImportExportDtoWithDefaults instantiates a new SelfImportExportDto 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 + +### GetType + +`func (o *SelfImportExportDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SelfImportExportDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SelfImportExportDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SelfImportExportDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SelfImportExportDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SelfImportExportDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SelfImportExportDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SelfImportExportDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SelfImportExportDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SelfImportExportDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SelfImportExportDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SelfImportExportDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SendAccountVerificationRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/SendAccountVerificationRequest.md new file mode 100644 index 000000000..176af7975 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SendAccountVerificationRequest.md @@ -0,0 +1,95 @@ +--- +id: beta-send-account-verification-request +title: SendAccountVerificationRequest +pagination_label: SendAccountVerificationRequest +sidebar_label: SendAccountVerificationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SendAccountVerificationRequest', 'BetaSendAccountVerificationRequest'] +slug: /tools/sdk/go/beta/models/send-account-verification-request +tags: ['SDK', 'Software Development Kit', 'SendAccountVerificationRequest', 'BetaSendAccountVerificationRequest'] +--- + +# SendAccountVerificationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceName** | Pointer to **NullableString** | The source name where identity account password should be reset | [optional] +**Via** | **string** | The method to send notification | + +## Methods + +### NewSendAccountVerificationRequest + +`func NewSendAccountVerificationRequest(via string, ) *SendAccountVerificationRequest` + +NewSendAccountVerificationRequest instantiates a new SendAccountVerificationRequest 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 + +### NewSendAccountVerificationRequestWithDefaults + +`func NewSendAccountVerificationRequestWithDefaults() *SendAccountVerificationRequest` + +NewSendAccountVerificationRequestWithDefaults instantiates a new SendAccountVerificationRequest 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 + +### GetSourceName + +`func (o *SendAccountVerificationRequest) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *SendAccountVerificationRequest) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *SendAccountVerificationRequest) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *SendAccountVerificationRequest) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### SetSourceNameNil + +`func (o *SendAccountVerificationRequest) SetSourceNameNil(b bool)` + + SetSourceNameNil sets the value for SourceName to be an explicit nil + +### UnsetSourceName +`func (o *SendAccountVerificationRequest) UnsetSourceName()` + +UnsetSourceName ensures that no value is present for SourceName, not even an explicit nil +### GetVia + +`func (o *SendAccountVerificationRequest) GetVia() string` + +GetVia returns the Via field if non-nil, zero value otherwise. + +### GetViaOk + +`func (o *SendAccountVerificationRequest) GetViaOk() (*string, bool)` + +GetViaOk returns a tuple with the Via field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVia + +`func (o *SendAccountVerificationRequest) SetVia(v string)` + +SetVia sets Via field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SendTestNotificationRequestDto.md b/docs/tools/sdk/go/Reference/Beta/Models/SendTestNotificationRequestDto.md new file mode 100644 index 000000000..270d61a53 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SendTestNotificationRequestDto.md @@ -0,0 +1,116 @@ +--- +id: beta-send-test-notification-request-dto +title: SendTestNotificationRequestDto +pagination_label: SendTestNotificationRequestDto +sidebar_label: SendTestNotificationRequestDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SendTestNotificationRequestDto', 'BetaSendTestNotificationRequestDto'] +slug: /tools/sdk/go/beta/models/send-test-notification-request-dto +tags: ['SDK', 'Software Development Kit', 'SendTestNotificationRequestDto', 'BetaSendTestNotificationRequestDto'] +--- + +# SendTestNotificationRequestDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The template notification key. | [optional] +**Medium** | Pointer to **string** | The notification medium. Has to be one of the following enum values. | [optional] +**Context** | Pointer to **map[string]interface{}** | A Json object that denotes the context specific to the template. | [optional] + +## Methods + +### NewSendTestNotificationRequestDto + +`func NewSendTestNotificationRequestDto() *SendTestNotificationRequestDto` + +NewSendTestNotificationRequestDto instantiates a new SendTestNotificationRequestDto 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 + +### NewSendTestNotificationRequestDtoWithDefaults + +`func NewSendTestNotificationRequestDtoWithDefaults() *SendTestNotificationRequestDto` + +NewSendTestNotificationRequestDtoWithDefaults instantiates a new SendTestNotificationRequestDto 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 + +### GetKey + +`func (o *SendTestNotificationRequestDto) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *SendTestNotificationRequestDto) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *SendTestNotificationRequestDto) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *SendTestNotificationRequestDto) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetMedium + +`func (o *SendTestNotificationRequestDto) GetMedium() string` + +GetMedium returns the Medium field if non-nil, zero value otherwise. + +### GetMediumOk + +`func (o *SendTestNotificationRequestDto) GetMediumOk() (*string, bool)` + +GetMediumOk returns a tuple with the Medium field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMedium + +`func (o *SendTestNotificationRequestDto) SetMedium(v string)` + +SetMedium sets Medium field to given value. + +### HasMedium + +`func (o *SendTestNotificationRequestDto) HasMedium() bool` + +HasMedium returns a boolean if a field has been set. + +### GetContext + +`func (o *SendTestNotificationRequestDto) GetContext() map[string]interface{}` + +GetContext returns the Context field if non-nil, zero value otherwise. + +### GetContextOk + +`func (o *SendTestNotificationRequestDto) GetContextOk() (*map[string]interface{}, bool)` + +GetContextOk returns a tuple with the Context field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContext + +`func (o *SendTestNotificationRequestDto) SetContext(v map[string]interface{})` + +SetContext sets Context field to given value. + +### HasContext + +`func (o *SendTestNotificationRequestDto) HasContext() bool` + +HasContext returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SendTokenRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/SendTokenRequest.md new file mode 100644 index 000000000..644264c1a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SendTokenRequest.md @@ -0,0 +1,80 @@ +--- +id: beta-send-token-request +title: SendTokenRequest +pagination_label: SendTokenRequest +sidebar_label: SendTokenRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SendTokenRequest', 'BetaSendTokenRequest'] +slug: /tools/sdk/go/beta/models/send-token-request +tags: ['SDK', 'Software Development Kit', 'SendTokenRequest', 'BetaSendTokenRequest'] +--- + +# SendTokenRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserAlias** | **string** | User alias from table spt_identity field named 'name' | +**DeliveryType** | **string** | Token delivery type | + +## Methods + +### NewSendTokenRequest + +`func NewSendTokenRequest(userAlias string, deliveryType string, ) *SendTokenRequest` + +NewSendTokenRequest instantiates a new SendTokenRequest 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 + +### NewSendTokenRequestWithDefaults + +`func NewSendTokenRequestWithDefaults() *SendTokenRequest` + +NewSendTokenRequestWithDefaults instantiates a new SendTokenRequest 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 + +### GetUserAlias + +`func (o *SendTokenRequest) GetUserAlias() string` + +GetUserAlias returns the UserAlias field if non-nil, zero value otherwise. + +### GetUserAliasOk + +`func (o *SendTokenRequest) GetUserAliasOk() (*string, bool)` + +GetUserAliasOk returns a tuple with the UserAlias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserAlias + +`func (o *SendTokenRequest) SetUserAlias(v string)` + +SetUserAlias sets UserAlias field to given value. + + +### GetDeliveryType + +`func (o *SendTokenRequest) GetDeliveryType() string` + +GetDeliveryType returns the DeliveryType field if non-nil, zero value otherwise. + +### GetDeliveryTypeOk + +`func (o *SendTokenRequest) GetDeliveryTypeOk() (*string, bool)` + +GetDeliveryTypeOk returns a tuple with the DeliveryType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeliveryType + +`func (o *SendTokenRequest) SetDeliveryType(v string)` + +SetDeliveryType sets DeliveryType field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SendTokenResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/SendTokenResponse.md new file mode 100644 index 000000000..5fba28514 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SendTokenResponse.md @@ -0,0 +1,136 @@ +--- +id: beta-send-token-response +title: SendTokenResponse +pagination_label: SendTokenResponse +sidebar_label: SendTokenResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SendTokenResponse', 'BetaSendTokenResponse'] +slug: /tools/sdk/go/beta/models/send-token-response +tags: ['SDK', 'Software Development Kit', 'SendTokenResponse', 'BetaSendTokenResponse'] +--- + +# SendTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **NullableString** | The token request ID | [optional] +**Status** | Pointer to **string** | Status of sending token | [optional] +**ErrorMessage** | Pointer to **NullableString** | Error messages from token send request | [optional] + +## Methods + +### NewSendTokenResponse + +`func NewSendTokenResponse() *SendTokenResponse` + +NewSendTokenResponse instantiates a new SendTokenResponse 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 + +### NewSendTokenResponseWithDefaults + +`func NewSendTokenResponseWithDefaults() *SendTokenResponse` + +NewSendTokenResponseWithDefaults instantiates a new SendTokenResponse 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 + +### GetRequestId + +`func (o *SendTokenResponse) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *SendTokenResponse) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *SendTokenResponse) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *SendTokenResponse) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *SendTokenResponse) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *SendTokenResponse) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetStatus + +`func (o *SendTokenResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SendTokenResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SendTokenResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SendTokenResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *SendTokenResponse) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *SendTokenResponse) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *SendTokenResponse) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *SendTokenResponse) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### SetErrorMessageNil + +`func (o *SendTokenResponse) SetErrorMessageNil(b bool)` + + SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil + +### UnsetErrorMessage +`func (o *SendTokenResponse) UnsetErrorMessage()` + +UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ServiceDeskIntegrationDto.md b/docs/tools/sdk/go/Reference/Beta/Models/ServiceDeskIntegrationDto.md new file mode 100644 index 000000000..65d64d0a6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ServiceDeskIntegrationDto.md @@ -0,0 +1,278 @@ +--- +id: beta-service-desk-integration-dto +title: ServiceDeskIntegrationDto +pagination_label: ServiceDeskIntegrationDto +sidebar_label: ServiceDeskIntegrationDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskIntegrationDto', 'BetaServiceDeskIntegrationDto'] +slug: /tools/sdk/go/beta/models/service-desk-integration-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationDto', 'BetaServiceDeskIntegrationDto'] +--- + +# ServiceDeskIntegrationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Service Desk integration's name. The name must be unique. | +**Description** | **string** | Service Desk integration's description. | +**Type** | **string** | Service Desk integration types: - ServiceNowSDIM - ServiceNow | [default to "ServiceNowSDIM"] +**OwnerRef** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**ClusterRef** | Pointer to [**SourceClusterDto**](source-cluster-dto) | | [optional] +**Cluster** | Pointer to **string** | Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). | [optional] +**ManagedSources** | Pointer to **[]string** | Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). | [optional] +**ProvisioningConfig** | Pointer to [**ProvisioningConfig**](provisioning-config) | | [optional] +**Attributes** | **map[string]interface{}** | Service Desk integration's attributes. Validation constraints enforced by the implementation. | +**BeforeProvisioningRule** | Pointer to [**BeforeProvisioningRuleDto**](before-provisioning-rule-dto) | | [optional] + +## Methods + +### NewServiceDeskIntegrationDto + +`func NewServiceDeskIntegrationDto(name string, description string, type_ string, attributes map[string]interface{}, ) *ServiceDeskIntegrationDto` + +NewServiceDeskIntegrationDto instantiates a new ServiceDeskIntegrationDto 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 + +### NewServiceDeskIntegrationDtoWithDefaults + +`func NewServiceDeskIntegrationDtoWithDefaults() *ServiceDeskIntegrationDto` + +NewServiceDeskIntegrationDtoWithDefaults instantiates a new ServiceDeskIntegrationDto 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 + +### GetName + +`func (o *ServiceDeskIntegrationDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServiceDeskIntegrationDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServiceDeskIntegrationDto) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *ServiceDeskIntegrationDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ServiceDeskIntegrationDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ServiceDeskIntegrationDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetType + +`func (o *ServiceDeskIntegrationDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServiceDeskIntegrationDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServiceDeskIntegrationDto) SetType(v string)` + +SetType sets Type field to given value. + + +### GetOwnerRef + +`func (o *ServiceDeskIntegrationDto) GetOwnerRef() OwnerDto` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *ServiceDeskIntegrationDto) GetOwnerRefOk() (*OwnerDto, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *ServiceDeskIntegrationDto) SetOwnerRef(v OwnerDto)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *ServiceDeskIntegrationDto) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### GetClusterRef + +`func (o *ServiceDeskIntegrationDto) GetClusterRef() SourceClusterDto` + +GetClusterRef returns the ClusterRef field if non-nil, zero value otherwise. + +### GetClusterRefOk + +`func (o *ServiceDeskIntegrationDto) GetClusterRefOk() (*SourceClusterDto, bool)` + +GetClusterRefOk returns a tuple with the ClusterRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterRef + +`func (o *ServiceDeskIntegrationDto) SetClusterRef(v SourceClusterDto)` + +SetClusterRef sets ClusterRef field to given value. + +### HasClusterRef + +`func (o *ServiceDeskIntegrationDto) HasClusterRef() bool` + +HasClusterRef returns a boolean if a field has been set. + +### GetCluster + +`func (o *ServiceDeskIntegrationDto) GetCluster() string` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *ServiceDeskIntegrationDto) GetClusterOk() (*string, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *ServiceDeskIntegrationDto) SetCluster(v string)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *ServiceDeskIntegrationDto) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### GetManagedSources + +`func (o *ServiceDeskIntegrationDto) GetManagedSources() []string` + +GetManagedSources returns the ManagedSources field if non-nil, zero value otherwise. + +### GetManagedSourcesOk + +`func (o *ServiceDeskIntegrationDto) GetManagedSourcesOk() (*[]string, bool)` + +GetManagedSourcesOk returns a tuple with the ManagedSources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagedSources + +`func (o *ServiceDeskIntegrationDto) SetManagedSources(v []string)` + +SetManagedSources sets ManagedSources field to given value. + +### HasManagedSources + +`func (o *ServiceDeskIntegrationDto) HasManagedSources() bool` + +HasManagedSources returns a boolean if a field has been set. + +### GetProvisioningConfig + +`func (o *ServiceDeskIntegrationDto) GetProvisioningConfig() ProvisioningConfig` + +GetProvisioningConfig returns the ProvisioningConfig field if non-nil, zero value otherwise. + +### GetProvisioningConfigOk + +`func (o *ServiceDeskIntegrationDto) GetProvisioningConfigOk() (*ProvisioningConfig, bool)` + +GetProvisioningConfigOk returns a tuple with the ProvisioningConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningConfig + +`func (o *ServiceDeskIntegrationDto) SetProvisioningConfig(v ProvisioningConfig)` + +SetProvisioningConfig sets ProvisioningConfig field to given value. + +### HasProvisioningConfig + +`func (o *ServiceDeskIntegrationDto) HasProvisioningConfig() bool` + +HasProvisioningConfig returns a boolean if a field has been set. + +### GetAttributes + +`func (o *ServiceDeskIntegrationDto) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ServiceDeskIntegrationDto) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ServiceDeskIntegrationDto) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetBeforeProvisioningRule + +`func (o *ServiceDeskIntegrationDto) GetBeforeProvisioningRule() BeforeProvisioningRuleDto` + +GetBeforeProvisioningRule returns the BeforeProvisioningRule field if non-nil, zero value otherwise. + +### GetBeforeProvisioningRuleOk + +`func (o *ServiceDeskIntegrationDto) GetBeforeProvisioningRuleOk() (*BeforeProvisioningRuleDto, bool)` + +GetBeforeProvisioningRuleOk returns a tuple with the BeforeProvisioningRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBeforeProvisioningRule + +`func (o *ServiceDeskIntegrationDto) SetBeforeProvisioningRule(v BeforeProvisioningRuleDto)` + +SetBeforeProvisioningRule sets BeforeProvisioningRule field to given value. + +### HasBeforeProvisioningRule + +`func (o *ServiceDeskIntegrationDto) HasBeforeProvisioningRule() bool` + +HasBeforeProvisioningRule returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ServiceDeskIntegrationTemplateDto.md b/docs/tools/sdk/go/Reference/Beta/Models/ServiceDeskIntegrationTemplateDto.md new file mode 100644 index 000000000..f92cea9ae --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ServiceDeskIntegrationTemplateDto.md @@ -0,0 +1,210 @@ +--- +id: beta-service-desk-integration-template-dto +title: ServiceDeskIntegrationTemplateDto +pagination_label: ServiceDeskIntegrationTemplateDto +sidebar_label: ServiceDeskIntegrationTemplateDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskIntegrationTemplateDto', 'BetaServiceDeskIntegrationTemplateDto'] +slug: /tools/sdk/go/beta/models/service-desk-integration-template-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateDto', 'BetaServiceDeskIntegrationTemplateDto'] +--- + +# ServiceDeskIntegrationTemplateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Type** | **string** | The 'type' property specifies the type of the Service Desk integration template. | [default to "Web Service SDIM"] +**Attributes** | **map[string]interface{}** | The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. | +**ProvisioningConfig** | [**ProvisioningConfig**](provisioning-config) | | + +## Methods + +### NewServiceDeskIntegrationTemplateDto + +`func NewServiceDeskIntegrationTemplateDto(name NullableString, type_ string, attributes map[string]interface{}, provisioningConfig ProvisioningConfig, ) *ServiceDeskIntegrationTemplateDto` + +NewServiceDeskIntegrationTemplateDto instantiates a new ServiceDeskIntegrationTemplateDto 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 + +### NewServiceDeskIntegrationTemplateDtoWithDefaults + +`func NewServiceDeskIntegrationTemplateDtoWithDefaults() *ServiceDeskIntegrationTemplateDto` + +NewServiceDeskIntegrationTemplateDtoWithDefaults instantiates a new ServiceDeskIntegrationTemplateDto 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 + +### GetId + +`func (o *ServiceDeskIntegrationTemplateDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServiceDeskIntegrationTemplateDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServiceDeskIntegrationTemplateDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ServiceDeskIntegrationTemplateDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServiceDeskIntegrationTemplateDto) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *ServiceDeskIntegrationTemplateDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ServiceDeskIntegrationTemplateDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *ServiceDeskIntegrationTemplateDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ServiceDeskIntegrationTemplateDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ServiceDeskIntegrationTemplateDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *ServiceDeskIntegrationTemplateDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ServiceDeskIntegrationTemplateDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ServiceDeskIntegrationTemplateDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetType + +`func (o *ServiceDeskIntegrationTemplateDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServiceDeskIntegrationTemplateDto) SetType(v string)` + +SetType sets Type field to given value. + + +### GetAttributes + +`func (o *ServiceDeskIntegrationTemplateDto) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ServiceDeskIntegrationTemplateDto) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetProvisioningConfig + +`func (o *ServiceDeskIntegrationTemplateDto) GetProvisioningConfig() ProvisioningConfig` + +GetProvisioningConfig returns the ProvisioningConfig field if non-nil, zero value otherwise. + +### GetProvisioningConfigOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetProvisioningConfigOk() (*ProvisioningConfig, bool)` + +GetProvisioningConfigOk returns a tuple with the ProvisioningConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningConfig + +`func (o *ServiceDeskIntegrationTemplateDto) SetProvisioningConfig(v ProvisioningConfig)` + +SetProvisioningConfig sets ProvisioningConfig field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ServiceDeskIntegrationTemplateType.md b/docs/tools/sdk/go/Reference/Beta/Models/ServiceDeskIntegrationTemplateType.md new file mode 100644 index 000000000..fa2ef8665 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ServiceDeskIntegrationTemplateType.md @@ -0,0 +1,106 @@ +--- +id: beta-service-desk-integration-template-type +title: ServiceDeskIntegrationTemplateType +pagination_label: ServiceDeskIntegrationTemplateType +sidebar_label: ServiceDeskIntegrationTemplateType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskIntegrationTemplateType', 'BetaServiceDeskIntegrationTemplateType'] +slug: /tools/sdk/go/beta/models/service-desk-integration-template-type +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateType', 'BetaServiceDeskIntegrationTemplateType'] +--- + +# ServiceDeskIntegrationTemplateType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | This is the name of the type. | [optional] +**Type** | **string** | This is the type value for the type. | +**ScriptName** | **string** | This is the scriptName attribute value for the type. | + +## Methods + +### NewServiceDeskIntegrationTemplateType + +`func NewServiceDeskIntegrationTemplateType(type_ string, scriptName string, ) *ServiceDeskIntegrationTemplateType` + +NewServiceDeskIntegrationTemplateType instantiates a new ServiceDeskIntegrationTemplateType 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 + +### NewServiceDeskIntegrationTemplateTypeWithDefaults + +`func NewServiceDeskIntegrationTemplateTypeWithDefaults() *ServiceDeskIntegrationTemplateType` + +NewServiceDeskIntegrationTemplateTypeWithDefaults instantiates a new ServiceDeskIntegrationTemplateType 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 + +### GetName + +`func (o *ServiceDeskIntegrationTemplateType) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServiceDeskIntegrationTemplateType) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServiceDeskIntegrationTemplateType) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ServiceDeskIntegrationTemplateType) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *ServiceDeskIntegrationTemplateType) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServiceDeskIntegrationTemplateType) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServiceDeskIntegrationTemplateType) SetType(v string)` + +SetType sets Type field to given value. + + +### GetScriptName + +`func (o *ServiceDeskIntegrationTemplateType) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *ServiceDeskIntegrationTemplateType) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *ServiceDeskIntegrationTemplateType) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ServiceDeskSource.md b/docs/tools/sdk/go/Reference/Beta/Models/ServiceDeskSource.md new file mode 100644 index 000000000..f71475e21 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ServiceDeskSource.md @@ -0,0 +1,116 @@ +--- +id: beta-service-desk-source +title: ServiceDeskSource +pagination_label: ServiceDeskSource +sidebar_label: ServiceDeskSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskSource', 'BetaServiceDeskSource'] +slug: /tools/sdk/go/beta/models/service-desk-source +tags: ['SDK', 'Software Development Kit', 'ServiceDeskSource', 'BetaServiceDeskSource'] +--- + +# ServiceDeskSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of source for service desk integration template. | [optional] +**Id** | Pointer to **string** | ID of source for service desk integration template. | [optional] +**Name** | Pointer to **string** | Human-readable name of source for service desk integration template. | [optional] + +## Methods + +### NewServiceDeskSource + +`func NewServiceDeskSource() *ServiceDeskSource` + +NewServiceDeskSource instantiates a new ServiceDeskSource 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 + +### NewServiceDeskSourceWithDefaults + +`func NewServiceDeskSourceWithDefaults() *ServiceDeskSource` + +NewServiceDeskSourceWithDefaults instantiates a new ServiceDeskSource 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 + +### GetType + +`func (o *ServiceDeskSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServiceDeskSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServiceDeskSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ServiceDeskSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ServiceDeskSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServiceDeskSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServiceDeskSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServiceDeskSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ServiceDeskSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServiceDeskSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServiceDeskSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ServiceDeskSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SetIcon200Response.md b/docs/tools/sdk/go/Reference/Beta/Models/SetIcon200Response.md new file mode 100644 index 000000000..de18a5dad --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SetIcon200Response.md @@ -0,0 +1,64 @@ +--- +id: beta-set-icon200-response +title: SetIcon200Response +pagination_label: SetIcon200Response +sidebar_label: SetIcon200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SetIcon200Response', 'BetaSetIcon200Response'] +slug: /tools/sdk/go/beta/models/set-icon200-response +tags: ['SDK', 'Software Development Kit', 'SetIcon200Response', 'BetaSetIcon200Response'] +--- + +# SetIcon200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Icon** | Pointer to **string** | url to file with icon | [optional] + +## Methods + +### NewSetIcon200Response + +`func NewSetIcon200Response() *SetIcon200Response` + +NewSetIcon200Response instantiates a new SetIcon200Response 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 + +### NewSetIcon200ResponseWithDefaults + +`func NewSetIcon200ResponseWithDefaults() *SetIcon200Response` + +NewSetIcon200ResponseWithDefaults instantiates a new SetIcon200Response 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 + +### GetIcon + +`func (o *SetIcon200Response) GetIcon() string` + +GetIcon returns the Icon field if non-nil, zero value otherwise. + +### GetIconOk + +`func (o *SetIcon200Response) GetIconOk() (*string, bool)` + +GetIconOk returns a tuple with the Icon field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIcon + +`func (o *SetIcon200Response) SetIcon(v string)` + +SetIcon sets Icon field to given value. + +### HasIcon + +`func (o *SetIcon200Response) HasIcon() bool` + +HasIcon returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SetIconRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/SetIconRequest.md new file mode 100644 index 000000000..5a350339b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SetIconRequest.md @@ -0,0 +1,59 @@ +--- +id: beta-set-icon-request +title: SetIconRequest +pagination_label: SetIconRequest +sidebar_label: SetIconRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SetIconRequest', 'BetaSetIconRequest'] +slug: /tools/sdk/go/beta/models/set-icon-request +tags: ['SDK', 'Software Development Kit', 'SetIconRequest', 'BetaSetIconRequest'] +--- + +# SetIconRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Image** | ***os.File** | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] | + +## Methods + +### NewSetIconRequest + +`func NewSetIconRequest(image *os.File, ) *SetIconRequest` + +NewSetIconRequest instantiates a new SetIconRequest 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 + +### NewSetIconRequestWithDefaults + +`func NewSetIconRequestWithDefaults() *SetIconRequest` + +NewSetIconRequestWithDefaults instantiates a new SetIconRequest 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 + +### GetImage + +`func (o *SetIconRequest) GetImage() *os.File` + +GetImage returns the Image field if non-nil, zero value otherwise. + +### GetImageOk + +`func (o *SetIconRequest) GetImageOk() (**os.File, bool)` + +GetImageOk returns a tuple with the Image field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImage + +`func (o *SetIconRequest) SetImage(v *os.File)` + +SetImage sets Image field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SimIntegrationDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/SimIntegrationDetails.md new file mode 100644 index 000000000..3c82e95e4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SimIntegrationDetails.md @@ -0,0 +1,365 @@ +--- +id: beta-sim-integration-details +title: SimIntegrationDetails +pagination_label: SimIntegrationDetails +sidebar_label: SimIntegrationDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SimIntegrationDetails', 'BetaSimIntegrationDetails'] +slug: /tools/sdk/go/beta/models/sim-integration-details +tags: ['SDK', 'Software Development Kit', 'SimIntegrationDetails', 'BetaSimIntegrationDetails'] +--- + +# SimIntegrationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Description** | Pointer to **string** | The description of the integration | [optional] +**Type** | Pointer to **string** | The integration type | [optional] +**Attributes** | Pointer to **map[string]interface{}** | The attributes map containing the credentials used to configure the integration. | [optional] +**Sources** | Pointer to **[]string** | The list of sources (managed resources) | [optional] +**Cluster** | Pointer to **string** | The cluster/proxy | [optional] +**StatusMap** | Pointer to **map[string]interface{}** | Custom mapping between the integration result and the provisioning result | [optional] +**Request** | Pointer to **map[string]interface{}** | Request data to customize desc and body of the created ticket | [optional] +**BeforeProvisioningRule** | Pointer to [**SimIntegrationDetailsAllOfBeforeProvisioningRule**](sim-integration-details-all-of-before-provisioning-rule) | | [optional] + +## Methods + +### NewSimIntegrationDetails + +`func NewSimIntegrationDetails(name NullableString, ) *SimIntegrationDetails` + +NewSimIntegrationDetails instantiates a new SimIntegrationDetails 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 + +### NewSimIntegrationDetailsWithDefaults + +`func NewSimIntegrationDetailsWithDefaults() *SimIntegrationDetails` + +NewSimIntegrationDetailsWithDefaults instantiates a new SimIntegrationDetails 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 + +### GetId + +`func (o *SimIntegrationDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SimIntegrationDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SimIntegrationDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SimIntegrationDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SimIntegrationDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SimIntegrationDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SimIntegrationDetails) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *SimIntegrationDetails) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *SimIntegrationDetails) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *SimIntegrationDetails) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SimIntegrationDetails) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SimIntegrationDetails) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SimIntegrationDetails) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SimIntegrationDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SimIntegrationDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SimIntegrationDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SimIntegrationDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *SimIntegrationDetails) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SimIntegrationDetails) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SimIntegrationDetails) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SimIntegrationDetails) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetType + +`func (o *SimIntegrationDetails) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SimIntegrationDetails) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SimIntegrationDetails) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SimIntegrationDetails) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetAttributes + +`func (o *SimIntegrationDetails) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *SimIntegrationDetails) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *SimIntegrationDetails) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *SimIntegrationDetails) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *SimIntegrationDetails) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *SimIntegrationDetails) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetSources + +`func (o *SimIntegrationDetails) GetSources() []string` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *SimIntegrationDetails) GetSourcesOk() (*[]string, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *SimIntegrationDetails) SetSources(v []string)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *SimIntegrationDetails) HasSources() bool` + +HasSources returns a boolean if a field has been set. + +### GetCluster + +`func (o *SimIntegrationDetails) GetCluster() string` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *SimIntegrationDetails) GetClusterOk() (*string, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *SimIntegrationDetails) SetCluster(v string)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *SimIntegrationDetails) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### GetStatusMap + +`func (o *SimIntegrationDetails) GetStatusMap() map[string]interface{}` + +GetStatusMap returns the StatusMap field if non-nil, zero value otherwise. + +### GetStatusMapOk + +`func (o *SimIntegrationDetails) GetStatusMapOk() (*map[string]interface{}, bool)` + +GetStatusMapOk returns a tuple with the StatusMap field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusMap + +`func (o *SimIntegrationDetails) SetStatusMap(v map[string]interface{})` + +SetStatusMap sets StatusMap field to given value. + +### HasStatusMap + +`func (o *SimIntegrationDetails) HasStatusMap() bool` + +HasStatusMap returns a boolean if a field has been set. + +### GetRequest + +`func (o *SimIntegrationDetails) GetRequest() map[string]interface{}` + +GetRequest returns the Request field if non-nil, zero value otherwise. + +### GetRequestOk + +`func (o *SimIntegrationDetails) GetRequestOk() (*map[string]interface{}, bool)` + +GetRequestOk returns a tuple with the Request field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequest + +`func (o *SimIntegrationDetails) SetRequest(v map[string]interface{})` + +SetRequest sets Request field to given value. + +### HasRequest + +`func (o *SimIntegrationDetails) HasRequest() bool` + +HasRequest returns a boolean if a field has been set. + +### GetBeforeProvisioningRule + +`func (o *SimIntegrationDetails) GetBeforeProvisioningRule() SimIntegrationDetailsAllOfBeforeProvisioningRule` + +GetBeforeProvisioningRule returns the BeforeProvisioningRule field if non-nil, zero value otherwise. + +### GetBeforeProvisioningRuleOk + +`func (o *SimIntegrationDetails) GetBeforeProvisioningRuleOk() (*SimIntegrationDetailsAllOfBeforeProvisioningRule, bool)` + +GetBeforeProvisioningRuleOk returns a tuple with the BeforeProvisioningRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBeforeProvisioningRule + +`func (o *SimIntegrationDetails) SetBeforeProvisioningRule(v SimIntegrationDetailsAllOfBeforeProvisioningRule)` + +SetBeforeProvisioningRule sets BeforeProvisioningRule field to given value. + +### HasBeforeProvisioningRule + +`func (o *SimIntegrationDetails) HasBeforeProvisioningRule() bool` + +HasBeforeProvisioningRule returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md b/docs/tools/sdk/go/Reference/Beta/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md new file mode 100644 index 000000000..f2a49f281 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md @@ -0,0 +1,116 @@ +--- +id: beta-sim-integration-details-all-of-before-provisioning-rule +title: SimIntegrationDetailsAllOfBeforeProvisioningRule +pagination_label: SimIntegrationDetailsAllOfBeforeProvisioningRule +sidebar_label: SimIntegrationDetailsAllOfBeforeProvisioningRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SimIntegrationDetailsAllOfBeforeProvisioningRule', 'BetaSimIntegrationDetailsAllOfBeforeProvisioningRule'] +slug: /tools/sdk/go/beta/models/sim-integration-details-all-of-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'SimIntegrationDetailsAllOfBeforeProvisioningRule', 'BetaSimIntegrationDetailsAllOfBeforeProvisioningRule'] +--- + +# SimIntegrationDetailsAllOfBeforeProvisioningRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | ID of the rule | [optional] +**Name** | Pointer to **string** | Human-readable display name of the rule | [optional] + +## Methods + +### NewSimIntegrationDetailsAllOfBeforeProvisioningRule + +`func NewSimIntegrationDetailsAllOfBeforeProvisioningRule() *SimIntegrationDetailsAllOfBeforeProvisioningRule` + +NewSimIntegrationDetailsAllOfBeforeProvisioningRule instantiates a new SimIntegrationDetailsAllOfBeforeProvisioningRule 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 + +### NewSimIntegrationDetailsAllOfBeforeProvisioningRuleWithDefaults + +`func NewSimIntegrationDetailsAllOfBeforeProvisioningRuleWithDefaults() *SimIntegrationDetailsAllOfBeforeProvisioningRule` + +NewSimIntegrationDetailsAllOfBeforeProvisioningRuleWithDefaults instantiates a new SimIntegrationDetailsAllOfBeforeProvisioningRule 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 + +### GetType + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SlimDiscoveredApplications.md b/docs/tools/sdk/go/Reference/Beta/Models/SlimDiscoveredApplications.md new file mode 100644 index 000000000..23e730806 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SlimDiscoveredApplications.md @@ -0,0 +1,272 @@ +--- +id: beta-slim-discovered-applications +title: SlimDiscoveredApplications +pagination_label: SlimDiscoveredApplications +sidebar_label: SlimDiscoveredApplications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SlimDiscoveredApplications', 'BetaSlimDiscoveredApplications'] +slug: /tools/sdk/go/beta/models/slim-discovered-applications +tags: ['SDK', 'Software Development Kit', 'SlimDiscoveredApplications', 'BetaSlimDiscoveredApplications'] +--- + +# SlimDiscoveredApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **string** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **string** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **string** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **string** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]string** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **SailPointTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **string** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [optional] + +## Methods + +### NewSlimDiscoveredApplications + +`func NewSlimDiscoveredApplications() *SlimDiscoveredApplications` + +NewSlimDiscoveredApplications instantiates a new SlimDiscoveredApplications 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 + +### NewSlimDiscoveredApplicationsWithDefaults + +`func NewSlimDiscoveredApplicationsWithDefaults() *SlimDiscoveredApplications` + +NewSlimDiscoveredApplicationsWithDefaults instantiates a new SlimDiscoveredApplications 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 + +### GetId + +`func (o *SlimDiscoveredApplications) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SlimDiscoveredApplications) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SlimDiscoveredApplications) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SlimDiscoveredApplications) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SlimDiscoveredApplications) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SlimDiscoveredApplications) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SlimDiscoveredApplications) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SlimDiscoveredApplications) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDiscoverySource + +`func (o *SlimDiscoveredApplications) GetDiscoverySource() string` + +GetDiscoverySource returns the DiscoverySource field if non-nil, zero value otherwise. + +### GetDiscoverySourceOk + +`func (o *SlimDiscoveredApplications) GetDiscoverySourceOk() (*string, bool)` + +GetDiscoverySourceOk returns a tuple with the DiscoverySource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoverySource + +`func (o *SlimDiscoveredApplications) SetDiscoverySource(v string)` + +SetDiscoverySource sets DiscoverySource field to given value. + +### HasDiscoverySource + +`func (o *SlimDiscoveredApplications) HasDiscoverySource() bool` + +HasDiscoverySource returns a boolean if a field has been set. + +### GetDiscoveredVendor + +`func (o *SlimDiscoveredApplications) GetDiscoveredVendor() string` + +GetDiscoveredVendor returns the DiscoveredVendor field if non-nil, zero value otherwise. + +### GetDiscoveredVendorOk + +`func (o *SlimDiscoveredApplications) GetDiscoveredVendorOk() (*string, bool)` + +GetDiscoveredVendorOk returns a tuple with the DiscoveredVendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredVendor + +`func (o *SlimDiscoveredApplications) SetDiscoveredVendor(v string)` + +SetDiscoveredVendor sets DiscoveredVendor field to given value. + +### HasDiscoveredVendor + +`func (o *SlimDiscoveredApplications) HasDiscoveredVendor() bool` + +HasDiscoveredVendor returns a boolean if a field has been set. + +### GetDescription + +`func (o *SlimDiscoveredApplications) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SlimDiscoveredApplications) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SlimDiscoveredApplications) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SlimDiscoveredApplications) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetRecommendedConnectors + +`func (o *SlimDiscoveredApplications) GetRecommendedConnectors() []string` + +GetRecommendedConnectors returns the RecommendedConnectors field if non-nil, zero value otherwise. + +### GetRecommendedConnectorsOk + +`func (o *SlimDiscoveredApplications) GetRecommendedConnectorsOk() (*[]string, bool)` + +GetRecommendedConnectorsOk returns a tuple with the RecommendedConnectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendedConnectors + +`func (o *SlimDiscoveredApplications) SetRecommendedConnectors(v []string)` + +SetRecommendedConnectors sets RecommendedConnectors field to given value. + +### HasRecommendedConnectors + +`func (o *SlimDiscoveredApplications) HasRecommendedConnectors() bool` + +HasRecommendedConnectors returns a boolean if a field has been set. + +### GetDiscoveredAt + +`func (o *SlimDiscoveredApplications) GetDiscoveredAt() SailPointTime` + +GetDiscoveredAt returns the DiscoveredAt field if non-nil, zero value otherwise. + +### GetDiscoveredAtOk + +`func (o *SlimDiscoveredApplications) GetDiscoveredAtOk() (*SailPointTime, bool)` + +GetDiscoveredAtOk returns a tuple with the DiscoveredAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredAt + +`func (o *SlimDiscoveredApplications) SetDiscoveredAt(v SailPointTime)` + +SetDiscoveredAt sets DiscoveredAt field to given value. + +### HasDiscoveredAt + +`func (o *SlimDiscoveredApplications) HasDiscoveredAt() bool` + +HasDiscoveredAt returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *SlimDiscoveredApplications) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *SlimDiscoveredApplications) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *SlimDiscoveredApplications) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *SlimDiscoveredApplications) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetStatus + +`func (o *SlimDiscoveredApplications) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SlimDiscoveredApplications) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SlimDiscoveredApplications) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SlimDiscoveredApplications) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Slimcampaign.md b/docs/tools/sdk/go/Reference/Beta/Models/Slimcampaign.md new file mode 100644 index 000000000..a76e86ad9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Slimcampaign.md @@ -0,0 +1,387 @@ +--- +id: beta-slimcampaign +title: Slimcampaign +pagination_label: Slimcampaign +sidebar_label: Slimcampaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Slimcampaign', 'BetaSlimcampaign'] +slug: /tools/sdk/go/beta/models/slimcampaign +tags: ['SDK', 'Software Development Kit', 'Slimcampaign', 'BetaSlimcampaign'] +--- + +# Slimcampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the campaign | [optional] [readonly] +**Name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Description** | **string** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Deadline** | Pointer to **SailPointTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **string** | The type of campaign. Could be extended in the future. | +**EmailNotificationEnabled** | Pointer to **bool** | Enables email notification for this campaign | [optional] [default to false] +**AutoRevokeAllowed** | Pointer to **bool** | Allows auto revoke for this campaign | [optional] [default to false] +**RecommendationsEnabled** | Pointer to **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to false] +**Status** | Pointer to **string** | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **SailPointTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] + +## Methods + +### NewSlimcampaign + +`func NewSlimcampaign(name string, description string, type_ string, ) *Slimcampaign` + +NewSlimcampaign instantiates a new Slimcampaign 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 + +### NewSlimcampaignWithDefaults + +`func NewSlimcampaignWithDefaults() *Slimcampaign` + +NewSlimcampaignWithDefaults instantiates a new Slimcampaign 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 + +### GetId + +`func (o *Slimcampaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Slimcampaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Slimcampaign) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Slimcampaign) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Slimcampaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Slimcampaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Slimcampaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Slimcampaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Slimcampaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Slimcampaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetDeadline + +`func (o *Slimcampaign) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *Slimcampaign) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *Slimcampaign) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *Slimcampaign) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### GetType + +`func (o *Slimcampaign) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Slimcampaign) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Slimcampaign) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEmailNotificationEnabled + +`func (o *Slimcampaign) GetEmailNotificationEnabled() bool` + +GetEmailNotificationEnabled returns the EmailNotificationEnabled field if non-nil, zero value otherwise. + +### GetEmailNotificationEnabledOk + +`func (o *Slimcampaign) GetEmailNotificationEnabledOk() (*bool, bool)` + +GetEmailNotificationEnabledOk returns a tuple with the EmailNotificationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationEnabled + +`func (o *Slimcampaign) SetEmailNotificationEnabled(v bool)` + +SetEmailNotificationEnabled sets EmailNotificationEnabled field to given value. + +### HasEmailNotificationEnabled + +`func (o *Slimcampaign) HasEmailNotificationEnabled() bool` + +HasEmailNotificationEnabled returns a boolean if a field has been set. + +### GetAutoRevokeAllowed + +`func (o *Slimcampaign) GetAutoRevokeAllowed() bool` + +GetAutoRevokeAllowed returns the AutoRevokeAllowed field if non-nil, zero value otherwise. + +### GetAutoRevokeAllowedOk + +`func (o *Slimcampaign) GetAutoRevokeAllowedOk() (*bool, bool)` + +GetAutoRevokeAllowedOk returns a tuple with the AutoRevokeAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoRevokeAllowed + +`func (o *Slimcampaign) SetAutoRevokeAllowed(v bool)` + +SetAutoRevokeAllowed sets AutoRevokeAllowed field to given value. + +### HasAutoRevokeAllowed + +`func (o *Slimcampaign) HasAutoRevokeAllowed() bool` + +HasAutoRevokeAllowed returns a boolean if a field has been set. + +### GetRecommendationsEnabled + +`func (o *Slimcampaign) GetRecommendationsEnabled() bool` + +GetRecommendationsEnabled returns the RecommendationsEnabled field if non-nil, zero value otherwise. + +### GetRecommendationsEnabledOk + +`func (o *Slimcampaign) GetRecommendationsEnabledOk() (*bool, bool)` + +GetRecommendationsEnabledOk returns a tuple with the RecommendationsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendationsEnabled + +`func (o *Slimcampaign) SetRecommendationsEnabled(v bool)` + +SetRecommendationsEnabled sets RecommendationsEnabled field to given value. + +### HasRecommendationsEnabled + +`func (o *Slimcampaign) HasRecommendationsEnabled() bool` + +HasRecommendationsEnabled returns a boolean if a field has been set. + +### GetStatus + +`func (o *Slimcampaign) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Slimcampaign) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Slimcampaign) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Slimcampaign) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetCorrelatedStatus + +`func (o *Slimcampaign) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *Slimcampaign) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *Slimcampaign) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + +### HasCorrelatedStatus + +`func (o *Slimcampaign) HasCorrelatedStatus() bool` + +HasCorrelatedStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *Slimcampaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Slimcampaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Slimcampaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Slimcampaign) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetTotalCertifications + +`func (o *Slimcampaign) GetTotalCertifications() int32` + +GetTotalCertifications returns the TotalCertifications field if non-nil, zero value otherwise. + +### GetTotalCertificationsOk + +`func (o *Slimcampaign) GetTotalCertificationsOk() (*int32, bool)` + +GetTotalCertificationsOk returns a tuple with the TotalCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCertifications + +`func (o *Slimcampaign) SetTotalCertifications(v int32)` + +SetTotalCertifications sets TotalCertifications field to given value. + +### HasTotalCertifications + +`func (o *Slimcampaign) HasTotalCertifications() bool` + +HasTotalCertifications returns a boolean if a field has been set. + +### GetCompletedCertifications + +`func (o *Slimcampaign) GetCompletedCertifications() int32` + +GetCompletedCertifications returns the CompletedCertifications field if non-nil, zero value otherwise. + +### GetCompletedCertificationsOk + +`func (o *Slimcampaign) GetCompletedCertificationsOk() (*int32, bool)` + +GetCompletedCertificationsOk returns a tuple with the CompletedCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedCertifications + +`func (o *Slimcampaign) SetCompletedCertifications(v int32)` + +SetCompletedCertifications sets CompletedCertifications field to given value. + +### HasCompletedCertifications + +`func (o *Slimcampaign) HasCompletedCertifications() bool` + +HasCompletedCertifications returns a boolean if a field has been set. + +### GetAlerts + +`func (o *Slimcampaign) GetAlerts() []CampaignAlert` + +GetAlerts returns the Alerts field if non-nil, zero value otherwise. + +### GetAlertsOk + +`func (o *Slimcampaign) GetAlertsOk() (*[]CampaignAlert, bool)` + +GetAlertsOk returns a tuple with the Alerts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlerts + +`func (o *Slimcampaign) SetAlerts(v []CampaignAlert)` + +SetAlerts sets Alerts field to given value. + +### HasAlerts + +`func (o *Slimcampaign) HasAlerts() bool` + +HasAlerts returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodExemptCriteria.md b/docs/tools/sdk/go/Reference/Beta/Models/SodExemptCriteria.md new file mode 100644 index 000000000..e5cec1787 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodExemptCriteria.md @@ -0,0 +1,142 @@ +--- +id: beta-sod-exempt-criteria +title: SodExemptCriteria +pagination_label: SodExemptCriteria +sidebar_label: SodExemptCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodExemptCriteria', 'BetaSodExemptCriteria'] +slug: /tools/sdk/go/beta/models/sod-exempt-criteria +tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria', 'BetaSodExemptCriteria'] +--- + +# SodExemptCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Existing** | Pointer to **bool** | If the entitlement already belonged to the user or not. | [optional] [default to false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | Entitlement ID | [optional] +**Name** | Pointer to **string** | Entitlement name | [optional] + +## Methods + +### NewSodExemptCriteria + +`func NewSodExemptCriteria() *SodExemptCriteria` + +NewSodExemptCriteria instantiates a new SodExemptCriteria 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 + +### NewSodExemptCriteriaWithDefaults + +`func NewSodExemptCriteriaWithDefaults() *SodExemptCriteria` + +NewSodExemptCriteriaWithDefaults instantiates a new SodExemptCriteria 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 + +### GetExisting + +`func (o *SodExemptCriteria) GetExisting() bool` + +GetExisting returns the Existing field if non-nil, zero value otherwise. + +### GetExistingOk + +`func (o *SodExemptCriteria) GetExistingOk() (*bool, bool)` + +GetExistingOk returns a tuple with the Existing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExisting + +`func (o *SodExemptCriteria) SetExisting(v bool)` + +SetExisting sets Existing field to given value. + +### HasExisting + +`func (o *SodExemptCriteria) HasExisting() bool` + +HasExisting returns a boolean if a field has been set. + +### GetType + +`func (o *SodExemptCriteria) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodExemptCriteria) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodExemptCriteria) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodExemptCriteria) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodExemptCriteria) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodExemptCriteria) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodExemptCriteria) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodExemptCriteria) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodExemptCriteria) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodExemptCriteria) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodExemptCriteria) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodExemptCriteria) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodExemptCriteria1.md b/docs/tools/sdk/go/Reference/Beta/Models/SodExemptCriteria1.md new file mode 100644 index 000000000..b7a197fb2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodExemptCriteria1.md @@ -0,0 +1,142 @@ +--- +id: beta-sod-exempt-criteria1 +title: SodExemptCriteria1 +pagination_label: SodExemptCriteria1 +sidebar_label: SodExemptCriteria1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodExemptCriteria1', 'BetaSodExemptCriteria1'] +slug: /tools/sdk/go/beta/models/sod-exempt-criteria1 +tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria1', 'BetaSodExemptCriteria1'] +--- + +# SodExemptCriteria1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Existing** | Pointer to **bool** | If the entitlement already belonged to the user or not. | [optional] [default to false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | Entitlement ID | [optional] +**Name** | Pointer to **string** | Entitlement name | [optional] + +## Methods + +### NewSodExemptCriteria1 + +`func NewSodExemptCriteria1() *SodExemptCriteria1` + +NewSodExemptCriteria1 instantiates a new SodExemptCriteria1 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 + +### NewSodExemptCriteria1WithDefaults + +`func NewSodExemptCriteria1WithDefaults() *SodExemptCriteria1` + +NewSodExemptCriteria1WithDefaults instantiates a new SodExemptCriteria1 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 + +### GetExisting + +`func (o *SodExemptCriteria1) GetExisting() bool` + +GetExisting returns the Existing field if non-nil, zero value otherwise. + +### GetExistingOk + +`func (o *SodExemptCriteria1) GetExistingOk() (*bool, bool)` + +GetExistingOk returns a tuple with the Existing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExisting + +`func (o *SodExemptCriteria1) SetExisting(v bool)` + +SetExisting sets Existing field to given value. + +### HasExisting + +`func (o *SodExemptCriteria1) HasExisting() bool` + +HasExisting returns a boolean if a field has been set. + +### GetType + +`func (o *SodExemptCriteria1) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodExemptCriteria1) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodExemptCriteria1) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodExemptCriteria1) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodExemptCriteria1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodExemptCriteria1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodExemptCriteria1) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodExemptCriteria1) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodExemptCriteria1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodExemptCriteria1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodExemptCriteria1) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodExemptCriteria1) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodPolicy.md b/docs/tools/sdk/go/Reference/Beta/Models/SodPolicy.md new file mode 100644 index 000000000..a2687b3e9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodPolicy.md @@ -0,0 +1,556 @@ +--- +id: beta-sod-policy +title: SodPolicy +pagination_label: SodPolicy +sidebar_label: SodPolicy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicy', 'BetaSodPolicy'] +slug: /tools/sdk/go/beta/models/sod-policy +tags: ['SDK', 'Software Development Kit', 'SodPolicy', 'BetaSodPolicy'] +--- + +# SodPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Policy ID. | [optional] [readonly] +**Name** | Pointer to **string** | Policy business name. | [optional] +**Created** | Pointer to **SailPointTime** | The time when this SOD policy is created. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | The time when this SOD policy is modified. | [optional] [readonly] +**Description** | Pointer to **NullableString** | Optional description of the SOD policy. | [optional] +**OwnerRef** | Pointer to [**SodPolicyOwnerRef**](sod-policy-owner-ref) | | [optional] +**ExternalPolicyReference** | Pointer to **NullableString** | Optional external policy reference. | [optional] +**PolicyQuery** | Pointer to **string** | Search query of the SOD policy. | [optional] +**CompensatingControls** | Pointer to **NullableString** | Optional compensating controls (Mitigating Controls). | [optional] +**CorrectionAdvice** | Pointer to **NullableString** | Optional correction advice. | [optional] +**State** | Pointer to **string** | Whether the policy is enforced or not. | [optional] +**Tags** | Pointer to **[]string** | Tags for the policy object. | [optional] +**CreatorId** | Pointer to **string** | Policy's creator ID. | [optional] [readonly] +**ModifierId** | Pointer to **NullableString** | Policy's modifier ID. | [optional] [readonly] +**ViolationOwnerAssignmentConfig** | Pointer to [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional] +**Scheduled** | Pointer to **bool** | Defines whether a policy has been scheduled or not. | [optional] [default to false] +**Type** | Pointer to **string** | Whether a policy is query based or conflicting access based. | [optional] [default to "GENERAL"] +**ConflictingAccessCriteria** | Pointer to [**SodPolicyConflictingAccessCriteria**](sod-policy-conflicting-access-criteria) | | [optional] + +## Methods + +### NewSodPolicy + +`func NewSodPolicy() *SodPolicy` + +NewSodPolicy instantiates a new SodPolicy 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 + +### NewSodPolicyWithDefaults + +`func NewSodPolicyWithDefaults() *SodPolicy` + +NewSodPolicyWithDefaults instantiates a new SodPolicy 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 + +### GetId + +`func (o *SodPolicy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodPolicy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodPolicy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodPolicy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodPolicy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodPolicy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodPolicy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodPolicy) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *SodPolicy) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SodPolicy) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SodPolicy) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SodPolicy) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SodPolicy) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SodPolicy) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SodPolicy) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SodPolicy) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *SodPolicy) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SodPolicy) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SodPolicy) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SodPolicy) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *SodPolicy) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *SodPolicy) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwnerRef + +`func (o *SodPolicy) GetOwnerRef() SodPolicyOwnerRef` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *SodPolicy) GetOwnerRefOk() (*SodPolicyOwnerRef, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *SodPolicy) SetOwnerRef(v SodPolicyOwnerRef)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *SodPolicy) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### GetExternalPolicyReference + +`func (o *SodPolicy) GetExternalPolicyReference() string` + +GetExternalPolicyReference returns the ExternalPolicyReference field if non-nil, zero value otherwise. + +### GetExternalPolicyReferenceOk + +`func (o *SodPolicy) GetExternalPolicyReferenceOk() (*string, bool)` + +GetExternalPolicyReferenceOk returns a tuple with the ExternalPolicyReference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExternalPolicyReference + +`func (o *SodPolicy) SetExternalPolicyReference(v string)` + +SetExternalPolicyReference sets ExternalPolicyReference field to given value. + +### HasExternalPolicyReference + +`func (o *SodPolicy) HasExternalPolicyReference() bool` + +HasExternalPolicyReference returns a boolean if a field has been set. + +### SetExternalPolicyReferenceNil + +`func (o *SodPolicy) SetExternalPolicyReferenceNil(b bool)` + + SetExternalPolicyReferenceNil sets the value for ExternalPolicyReference to be an explicit nil + +### UnsetExternalPolicyReference +`func (o *SodPolicy) UnsetExternalPolicyReference()` + +UnsetExternalPolicyReference ensures that no value is present for ExternalPolicyReference, not even an explicit nil +### GetPolicyQuery + +`func (o *SodPolicy) GetPolicyQuery() string` + +GetPolicyQuery returns the PolicyQuery field if non-nil, zero value otherwise. + +### GetPolicyQueryOk + +`func (o *SodPolicy) GetPolicyQueryOk() (*string, bool)` + +GetPolicyQueryOk returns a tuple with the PolicyQuery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyQuery + +`func (o *SodPolicy) SetPolicyQuery(v string)` + +SetPolicyQuery sets PolicyQuery field to given value. + +### HasPolicyQuery + +`func (o *SodPolicy) HasPolicyQuery() bool` + +HasPolicyQuery returns a boolean if a field has been set. + +### GetCompensatingControls + +`func (o *SodPolicy) GetCompensatingControls() string` + +GetCompensatingControls returns the CompensatingControls field if non-nil, zero value otherwise. + +### GetCompensatingControlsOk + +`func (o *SodPolicy) GetCompensatingControlsOk() (*string, bool)` + +GetCompensatingControlsOk returns a tuple with the CompensatingControls field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompensatingControls + +`func (o *SodPolicy) SetCompensatingControls(v string)` + +SetCompensatingControls sets CompensatingControls field to given value. + +### HasCompensatingControls + +`func (o *SodPolicy) HasCompensatingControls() bool` + +HasCompensatingControls returns a boolean if a field has been set. + +### SetCompensatingControlsNil + +`func (o *SodPolicy) SetCompensatingControlsNil(b bool)` + + SetCompensatingControlsNil sets the value for CompensatingControls to be an explicit nil + +### UnsetCompensatingControls +`func (o *SodPolicy) UnsetCompensatingControls()` + +UnsetCompensatingControls ensures that no value is present for CompensatingControls, not even an explicit nil +### GetCorrectionAdvice + +`func (o *SodPolicy) GetCorrectionAdvice() string` + +GetCorrectionAdvice returns the CorrectionAdvice field if non-nil, zero value otherwise. + +### GetCorrectionAdviceOk + +`func (o *SodPolicy) GetCorrectionAdviceOk() (*string, bool)` + +GetCorrectionAdviceOk returns a tuple with the CorrectionAdvice field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrectionAdvice + +`func (o *SodPolicy) SetCorrectionAdvice(v string)` + +SetCorrectionAdvice sets CorrectionAdvice field to given value. + +### HasCorrectionAdvice + +`func (o *SodPolicy) HasCorrectionAdvice() bool` + +HasCorrectionAdvice returns a boolean if a field has been set. + +### SetCorrectionAdviceNil + +`func (o *SodPolicy) SetCorrectionAdviceNil(b bool)` + + SetCorrectionAdviceNil sets the value for CorrectionAdvice to be an explicit nil + +### UnsetCorrectionAdvice +`func (o *SodPolicy) UnsetCorrectionAdvice()` + +UnsetCorrectionAdvice ensures that no value is present for CorrectionAdvice, not even an explicit nil +### GetState + +`func (o *SodPolicy) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *SodPolicy) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *SodPolicy) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *SodPolicy) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetTags + +`func (o *SodPolicy) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *SodPolicy) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *SodPolicy) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *SodPolicy) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetCreatorId + +`func (o *SodPolicy) GetCreatorId() string` + +GetCreatorId returns the CreatorId field if non-nil, zero value otherwise. + +### GetCreatorIdOk + +`func (o *SodPolicy) GetCreatorIdOk() (*string, bool)` + +GetCreatorIdOk returns a tuple with the CreatorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatorId + +`func (o *SodPolicy) SetCreatorId(v string)` + +SetCreatorId sets CreatorId field to given value. + +### HasCreatorId + +`func (o *SodPolicy) HasCreatorId() bool` + +HasCreatorId returns a boolean if a field has been set. + +### GetModifierId + +`func (o *SodPolicy) GetModifierId() string` + +GetModifierId returns the ModifierId field if non-nil, zero value otherwise. + +### GetModifierIdOk + +`func (o *SodPolicy) GetModifierIdOk() (*string, bool)` + +GetModifierIdOk returns a tuple with the ModifierId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifierId + +`func (o *SodPolicy) SetModifierId(v string)` + +SetModifierId sets ModifierId field to given value. + +### HasModifierId + +`func (o *SodPolicy) HasModifierId() bool` + +HasModifierId returns a boolean if a field has been set. + +### SetModifierIdNil + +`func (o *SodPolicy) SetModifierIdNil(b bool)` + + SetModifierIdNil sets the value for ModifierId to be an explicit nil + +### UnsetModifierId +`func (o *SodPolicy) UnsetModifierId()` + +UnsetModifierId ensures that no value is present for ModifierId, not even an explicit nil +### GetViolationOwnerAssignmentConfig + +`func (o *SodPolicy) GetViolationOwnerAssignmentConfig() ViolationOwnerAssignmentConfig` + +GetViolationOwnerAssignmentConfig returns the ViolationOwnerAssignmentConfig field if non-nil, zero value otherwise. + +### GetViolationOwnerAssignmentConfigOk + +`func (o *SodPolicy) GetViolationOwnerAssignmentConfigOk() (*ViolationOwnerAssignmentConfig, bool)` + +GetViolationOwnerAssignmentConfigOk returns a tuple with the ViolationOwnerAssignmentConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationOwnerAssignmentConfig + +`func (o *SodPolicy) SetViolationOwnerAssignmentConfig(v ViolationOwnerAssignmentConfig)` + +SetViolationOwnerAssignmentConfig sets ViolationOwnerAssignmentConfig field to given value. + +### HasViolationOwnerAssignmentConfig + +`func (o *SodPolicy) HasViolationOwnerAssignmentConfig() bool` + +HasViolationOwnerAssignmentConfig returns a boolean if a field has been set. + +### GetScheduled + +`func (o *SodPolicy) GetScheduled() bool` + +GetScheduled returns the Scheduled field if non-nil, zero value otherwise. + +### GetScheduledOk + +`func (o *SodPolicy) GetScheduledOk() (*bool, bool)` + +GetScheduledOk returns a tuple with the Scheduled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheduled + +`func (o *SodPolicy) SetScheduled(v bool)` + +SetScheduled sets Scheduled field to given value. + +### HasScheduled + +`func (o *SodPolicy) HasScheduled() bool` + +HasScheduled returns a boolean if a field has been set. + +### GetType + +`func (o *SodPolicy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodPolicy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodPolicy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodPolicy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConflictingAccessCriteria + +`func (o *SodPolicy) GetConflictingAccessCriteria() SodPolicyConflictingAccessCriteria` + +GetConflictingAccessCriteria returns the ConflictingAccessCriteria field if non-nil, zero value otherwise. + +### GetConflictingAccessCriteriaOk + +`func (o *SodPolicy) GetConflictingAccessCriteriaOk() (*SodPolicyConflictingAccessCriteria, bool)` + +GetConflictingAccessCriteriaOk returns a tuple with the ConflictingAccessCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConflictingAccessCriteria + +`func (o *SodPolicy) SetConflictingAccessCriteria(v SodPolicyConflictingAccessCriteria)` + +SetConflictingAccessCriteria sets ConflictingAccessCriteria field to given value. + +### HasConflictingAccessCriteria + +`func (o *SodPolicy) HasConflictingAccessCriteria() bool` + +HasConflictingAccessCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodPolicyConflictingAccessCriteria.md b/docs/tools/sdk/go/Reference/Beta/Models/SodPolicyConflictingAccessCriteria.md new file mode 100644 index 000000000..1f3254776 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodPolicyConflictingAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: beta-sod-policy-conflicting-access-criteria +title: SodPolicyConflictingAccessCriteria +pagination_label: SodPolicyConflictingAccessCriteria +sidebar_label: SodPolicyConflictingAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicyConflictingAccessCriteria', 'BetaSodPolicyConflictingAccessCriteria'] +slug: /tools/sdk/go/beta/models/sod-policy-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodPolicyConflictingAccessCriteria', 'BetaSodPolicyConflictingAccessCriteria'] +--- + +# SodPolicyConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] +**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] + +## Methods + +### NewSodPolicyConflictingAccessCriteria + +`func NewSodPolicyConflictingAccessCriteria() *SodPolicyConflictingAccessCriteria` + +NewSodPolicyConflictingAccessCriteria instantiates a new SodPolicyConflictingAccessCriteria 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 + +### NewSodPolicyConflictingAccessCriteriaWithDefaults + +`func NewSodPolicyConflictingAccessCriteriaWithDefaults() *SodPolicyConflictingAccessCriteria` + +NewSodPolicyConflictingAccessCriteriaWithDefaults instantiates a new SodPolicyConflictingAccessCriteria 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 + +### GetLeftCriteria + +`func (o *SodPolicyConflictingAccessCriteria) GetLeftCriteria() AccessCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *SodPolicyConflictingAccessCriteria) GetLeftCriteriaOk() (*AccessCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *SodPolicyConflictingAccessCriteria) SetLeftCriteria(v AccessCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *SodPolicyConflictingAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *SodPolicyConflictingAccessCriteria) GetRightCriteria() AccessCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *SodPolicyConflictingAccessCriteria) GetRightCriteriaOk() (*AccessCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *SodPolicyConflictingAccessCriteria) SetRightCriteria(v AccessCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *SodPolicyConflictingAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodPolicyDto.md b/docs/tools/sdk/go/Reference/Beta/Models/SodPolicyDto.md new file mode 100644 index 000000000..bd3d48d09 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodPolicyDto.md @@ -0,0 +1,116 @@ +--- +id: beta-sod-policy-dto +title: SodPolicyDto +pagination_label: SodPolicyDto +sidebar_label: SodPolicyDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicyDto', 'BetaSodPolicyDto'] +slug: /tools/sdk/go/beta/models/sod-policy-dto +tags: ['SDK', 'Software Development Kit', 'SodPolicyDto', 'BetaSodPolicyDto'] +--- + +# SodPolicyDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy ID. | [optional] +**Name** | Pointer to **string** | SOD policy display name. | [optional] + +## Methods + +### NewSodPolicyDto + +`func NewSodPolicyDto() *SodPolicyDto` + +NewSodPolicyDto instantiates a new SodPolicyDto 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 + +### NewSodPolicyDtoWithDefaults + +`func NewSodPolicyDtoWithDefaults() *SodPolicyDto` + +NewSodPolicyDtoWithDefaults instantiates a new SodPolicyDto 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 + +### GetType + +`func (o *SodPolicyDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodPolicyDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodPolicyDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodPolicyDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodPolicyDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodPolicyDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodPolicyDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodPolicyDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodPolicyDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodPolicyDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodPolicyDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodPolicyDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodPolicyOwnerRef.md b/docs/tools/sdk/go/Reference/Beta/Models/SodPolicyOwnerRef.md new file mode 100644 index 000000000..7a17e985d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodPolicyOwnerRef.md @@ -0,0 +1,116 @@ +--- +id: beta-sod-policy-owner-ref +title: SodPolicyOwnerRef +pagination_label: SodPolicyOwnerRef +sidebar_label: SodPolicyOwnerRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicyOwnerRef', 'BetaSodPolicyOwnerRef'] +slug: /tools/sdk/go/beta/models/sod-policy-owner-ref +tags: ['SDK', 'Software Development Kit', 'SodPolicyOwnerRef', 'BetaSodPolicyOwnerRef'] +--- + +# SodPolicyOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner type. | [optional] +**Id** | Pointer to **string** | Owner's ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] + +## Methods + +### NewSodPolicyOwnerRef + +`func NewSodPolicyOwnerRef() *SodPolicyOwnerRef` + +NewSodPolicyOwnerRef instantiates a new SodPolicyOwnerRef 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 + +### NewSodPolicyOwnerRefWithDefaults + +`func NewSodPolicyOwnerRefWithDefaults() *SodPolicyOwnerRef` + +NewSodPolicyOwnerRefWithDefaults instantiates a new SodPolicyOwnerRef 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 + +### GetType + +`func (o *SodPolicyOwnerRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodPolicyOwnerRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodPolicyOwnerRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodPolicyOwnerRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodPolicyOwnerRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodPolicyOwnerRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodPolicyOwnerRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodPolicyOwnerRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodPolicyOwnerRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodPolicyOwnerRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodPolicyOwnerRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodPolicyOwnerRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodPolicySchedule.md b/docs/tools/sdk/go/Reference/Beta/Models/SodPolicySchedule.md new file mode 100644 index 000000000..2ae4529c3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodPolicySchedule.md @@ -0,0 +1,272 @@ +--- +id: beta-sod-policy-schedule +title: SodPolicySchedule +pagination_label: SodPolicySchedule +sidebar_label: SodPolicySchedule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicySchedule', 'BetaSodPolicySchedule'] +slug: /tools/sdk/go/beta/models/sod-policy-schedule +tags: ['SDK', 'Software Development Kit', 'SodPolicySchedule', 'BetaSodPolicySchedule'] +--- + +# SodPolicySchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | SOD Policy schedule name | [optional] +**Created** | Pointer to **SailPointTime** | The time when this SOD policy schedule is created. | [optional] +**Modified** | Pointer to **SailPointTime** | The time when this SOD policy schedule is modified. | [optional] +**Description** | Pointer to **string** | SOD Policy schedule description | [optional] +**Schedule** | Pointer to [**Schedule1**](schedule1) | | [optional] +**Recipients** | Pointer to [**[]SodRecipient**](sod-recipient) | | [optional] +**EmailEmptyResults** | Pointer to **bool** | Indicates if empty results need to be emailed | [optional] +**CreatorId** | Pointer to **string** | Policy's creator ID | [optional] +**ModifierId** | Pointer to **string** | Policy's modifier ID | [optional] + +## Methods + +### NewSodPolicySchedule + +`func NewSodPolicySchedule() *SodPolicySchedule` + +NewSodPolicySchedule instantiates a new SodPolicySchedule 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 + +### NewSodPolicyScheduleWithDefaults + +`func NewSodPolicyScheduleWithDefaults() *SodPolicySchedule` + +NewSodPolicyScheduleWithDefaults instantiates a new SodPolicySchedule 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 + +### GetName + +`func (o *SodPolicySchedule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodPolicySchedule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodPolicySchedule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodPolicySchedule) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *SodPolicySchedule) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SodPolicySchedule) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SodPolicySchedule) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SodPolicySchedule) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SodPolicySchedule) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SodPolicySchedule) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SodPolicySchedule) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SodPolicySchedule) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *SodPolicySchedule) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SodPolicySchedule) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SodPolicySchedule) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SodPolicySchedule) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetSchedule + +`func (o *SodPolicySchedule) GetSchedule() Schedule1` + +GetSchedule returns the Schedule field if non-nil, zero value otherwise. + +### GetScheduleOk + +`func (o *SodPolicySchedule) GetScheduleOk() (*Schedule1, bool)` + +GetScheduleOk returns a tuple with the Schedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchedule + +`func (o *SodPolicySchedule) SetSchedule(v Schedule1)` + +SetSchedule sets Schedule field to given value. + +### HasSchedule + +`func (o *SodPolicySchedule) HasSchedule() bool` + +HasSchedule returns a boolean if a field has been set. + +### GetRecipients + +`func (o *SodPolicySchedule) GetRecipients() []SodRecipient` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *SodPolicySchedule) GetRecipientsOk() (*[]SodRecipient, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *SodPolicySchedule) SetRecipients(v []SodRecipient)` + +SetRecipients sets Recipients field to given value. + +### HasRecipients + +`func (o *SodPolicySchedule) HasRecipients() bool` + +HasRecipients returns a boolean if a field has been set. + +### GetEmailEmptyResults + +`func (o *SodPolicySchedule) GetEmailEmptyResults() bool` + +GetEmailEmptyResults returns the EmailEmptyResults field if non-nil, zero value otherwise. + +### GetEmailEmptyResultsOk + +`func (o *SodPolicySchedule) GetEmailEmptyResultsOk() (*bool, bool)` + +GetEmailEmptyResultsOk returns a tuple with the EmailEmptyResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEmptyResults + +`func (o *SodPolicySchedule) SetEmailEmptyResults(v bool)` + +SetEmailEmptyResults sets EmailEmptyResults field to given value. + +### HasEmailEmptyResults + +`func (o *SodPolicySchedule) HasEmailEmptyResults() bool` + +HasEmailEmptyResults returns a boolean if a field has been set. + +### GetCreatorId + +`func (o *SodPolicySchedule) GetCreatorId() string` + +GetCreatorId returns the CreatorId field if non-nil, zero value otherwise. + +### GetCreatorIdOk + +`func (o *SodPolicySchedule) GetCreatorIdOk() (*string, bool)` + +GetCreatorIdOk returns a tuple with the CreatorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatorId + +`func (o *SodPolicySchedule) SetCreatorId(v string)` + +SetCreatorId sets CreatorId field to given value. + +### HasCreatorId + +`func (o *SodPolicySchedule) HasCreatorId() bool` + +HasCreatorId returns a boolean if a field has been set. + +### GetModifierId + +`func (o *SodPolicySchedule) GetModifierId() string` + +GetModifierId returns the ModifierId field if non-nil, zero value otherwise. + +### GetModifierIdOk + +`func (o *SodPolicySchedule) GetModifierIdOk() (*string, bool)` + +GetModifierIdOk returns a tuple with the ModifierId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifierId + +`func (o *SodPolicySchedule) SetModifierId(v string)` + +SetModifierId sets ModifierId field to given value. + +### HasModifierId + +`func (o *SodPolicySchedule) HasModifierId() bool` + +HasModifierId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodRecipient.md b/docs/tools/sdk/go/Reference/Beta/Models/SodRecipient.md new file mode 100644 index 000000000..f409bd345 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodRecipient.md @@ -0,0 +1,116 @@ +--- +id: beta-sod-recipient +title: SodRecipient +pagination_label: SodRecipient +sidebar_label: SodRecipient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodRecipient', 'BetaSodRecipient'] +slug: /tools/sdk/go/beta/models/sod-recipient +tags: ['SDK', 'Software Development Kit', 'SodRecipient', 'BetaSodRecipient'] +--- + +# SodRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy recipient DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy recipient's identity ID. | [optional] +**Name** | Pointer to **string** | SOD policy recipient's display name. | [optional] + +## Methods + +### NewSodRecipient + +`func NewSodRecipient() *SodRecipient` + +NewSodRecipient instantiates a new SodRecipient 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 + +### NewSodRecipientWithDefaults + +`func NewSodRecipientWithDefaults() *SodRecipient` + +NewSodRecipientWithDefaults instantiates a new SodRecipient 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 + +### GetType + +`func (o *SodRecipient) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodRecipient) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodRecipient) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodRecipient) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodRecipient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodRecipient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodRecipient) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodRecipient) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodRecipient) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodRecipient) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodRecipient) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodRecipient) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodReportResultDto.md b/docs/tools/sdk/go/Reference/Beta/Models/SodReportResultDto.md new file mode 100644 index 000000000..d7634498a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodReportResultDto.md @@ -0,0 +1,116 @@ +--- +id: beta-sod-report-result-dto +title: SodReportResultDto +pagination_label: SodReportResultDto +sidebar_label: SodReportResultDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodReportResultDto', 'BetaSodReportResultDto'] +slug: /tools/sdk/go/beta/models/sod-report-result-dto +tags: ['SDK', 'Software Development Kit', 'SodReportResultDto', 'BetaSodReportResultDto'] +--- + +# SodReportResultDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **string** | Human-readable name of the SOD policy violation report result. | [optional] + +## Methods + +### NewSodReportResultDto + +`func NewSodReportResultDto() *SodReportResultDto` + +NewSodReportResultDto instantiates a new SodReportResultDto 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 + +### NewSodReportResultDtoWithDefaults + +`func NewSodReportResultDtoWithDefaults() *SodReportResultDto` + +NewSodReportResultDtoWithDefaults instantiates a new SodReportResultDto 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 + +### GetType + +`func (o *SodReportResultDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodReportResultDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodReportResultDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodReportResultDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodReportResultDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodReportResultDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodReportResultDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodReportResultDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodReportResultDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodReportResultDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodReportResultDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodReportResultDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodViolationCheckResult.md b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationCheckResult.md new file mode 100644 index 000000000..2f5b3d5a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationCheckResult.md @@ -0,0 +1,172 @@ +--- +id: beta-sod-violation-check-result +title: SodViolationCheckResult +pagination_label: SodViolationCheckResult +sidebar_label: SodViolationCheckResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationCheckResult', 'BetaSodViolationCheckResult'] +slug: /tools/sdk/go/beta/models/sod-violation-check-result +tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult', 'BetaSodViolationCheckResult'] +--- + +# SodViolationCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to [**ErrorMessageDto**](error-message-dto) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] +**ViolationContexts** | Pointer to [**[]SodViolationContext**](sod-violation-context) | | [optional] +**ViolatedPolicies** | Pointer to [**[]SodPolicyDto**](sod-policy-dto) | A list of the SOD policies that were violated. | [optional] + +## Methods + +### NewSodViolationCheckResult + +`func NewSodViolationCheckResult() *SodViolationCheckResult` + +NewSodViolationCheckResult instantiates a new SodViolationCheckResult 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 + +### NewSodViolationCheckResultWithDefaults + +`func NewSodViolationCheckResultWithDefaults() *SodViolationCheckResult` + +NewSodViolationCheckResultWithDefaults instantiates a new SodViolationCheckResult 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 + +### GetMessage + +`func (o *SodViolationCheckResult) GetMessage() ErrorMessageDto` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *SodViolationCheckResult) GetMessageOk() (*ErrorMessageDto, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *SodViolationCheckResult) SetMessage(v ErrorMessageDto)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *SodViolationCheckResult) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *SodViolationCheckResult) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *SodViolationCheckResult) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *SodViolationCheckResult) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *SodViolationCheckResult) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *SodViolationCheckResult) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *SodViolationCheckResult) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetViolationContexts + +`func (o *SodViolationCheckResult) GetViolationContexts() []SodViolationContext` + +GetViolationContexts returns the ViolationContexts field if non-nil, zero value otherwise. + +### GetViolationContextsOk + +`func (o *SodViolationCheckResult) GetViolationContextsOk() (*[]SodViolationContext, bool)` + +GetViolationContextsOk returns a tuple with the ViolationContexts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationContexts + +`func (o *SodViolationCheckResult) SetViolationContexts(v []SodViolationContext)` + +SetViolationContexts sets ViolationContexts field to given value. + +### HasViolationContexts + +`func (o *SodViolationCheckResult) HasViolationContexts() bool` + +HasViolationContexts returns a boolean if a field has been set. + +### SetViolationContextsNil + +`func (o *SodViolationCheckResult) SetViolationContextsNil(b bool)` + + SetViolationContextsNil sets the value for ViolationContexts to be an explicit nil + +### UnsetViolationContexts +`func (o *SodViolationCheckResult) UnsetViolationContexts()` + +UnsetViolationContexts ensures that no value is present for ViolationContexts, not even an explicit nil +### GetViolatedPolicies + +`func (o *SodViolationCheckResult) GetViolatedPolicies() []SodPolicyDto` + +GetViolatedPolicies returns the ViolatedPolicies field if non-nil, zero value otherwise. + +### GetViolatedPoliciesOk + +`func (o *SodViolationCheckResult) GetViolatedPoliciesOk() (*[]SodPolicyDto, bool)` + +GetViolatedPoliciesOk returns a tuple with the ViolatedPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolatedPolicies + +`func (o *SodViolationCheckResult) SetViolatedPolicies(v []SodPolicyDto)` + +SetViolatedPolicies sets ViolatedPolicies field to given value. + +### HasViolatedPolicies + +`func (o *SodViolationCheckResult) HasViolatedPolicies() bool` + +HasViolatedPolicies returns a boolean if a field has been set. + +### SetViolatedPoliciesNil + +`func (o *SodViolationCheckResult) SetViolatedPoliciesNil(b bool)` + + SetViolatedPoliciesNil sets the value for ViolatedPolicies to be an explicit nil + +### UnsetViolatedPolicies +`func (o *SodViolationCheckResult) UnsetViolatedPolicies()` + +UnsetViolatedPolicies ensures that no value is present for ViolatedPolicies, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodViolationCheckResult1.md b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationCheckResult1.md new file mode 100644 index 000000000..14efede9c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationCheckResult1.md @@ -0,0 +1,142 @@ +--- +id: beta-sod-violation-check-result1 +title: SodViolationCheckResult1 +pagination_label: SodViolationCheckResult1 +sidebar_label: SodViolationCheckResult1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationCheckResult1', 'BetaSodViolationCheckResult1'] +slug: /tools/sdk/go/beta/models/sod-violation-check-result1 +tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult1', 'BetaSodViolationCheckResult1'] +--- + +# SodViolationCheckResult1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to [**ErrorMessageDto**](error-message-dto) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] +**ViolationContexts** | Pointer to [**[]SodViolationContext1**](sod-violation-context1) | | [optional] +**ViolatedPolicies** | Pointer to [**[]SodPolicyDto**](sod-policy-dto) | A list of the Policies that were violated. | [optional] + +## Methods + +### NewSodViolationCheckResult1 + +`func NewSodViolationCheckResult1() *SodViolationCheckResult1` + +NewSodViolationCheckResult1 instantiates a new SodViolationCheckResult1 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 + +### NewSodViolationCheckResult1WithDefaults + +`func NewSodViolationCheckResult1WithDefaults() *SodViolationCheckResult1` + +NewSodViolationCheckResult1WithDefaults instantiates a new SodViolationCheckResult1 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 + +### GetMessage + +`func (o *SodViolationCheckResult1) GetMessage() ErrorMessageDto` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *SodViolationCheckResult1) GetMessageOk() (*ErrorMessageDto, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *SodViolationCheckResult1) SetMessage(v ErrorMessageDto)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *SodViolationCheckResult1) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *SodViolationCheckResult1) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *SodViolationCheckResult1) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *SodViolationCheckResult1) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *SodViolationCheckResult1) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetViolationContexts + +`func (o *SodViolationCheckResult1) GetViolationContexts() []SodViolationContext1` + +GetViolationContexts returns the ViolationContexts field if non-nil, zero value otherwise. + +### GetViolationContextsOk + +`func (o *SodViolationCheckResult1) GetViolationContextsOk() (*[]SodViolationContext1, bool)` + +GetViolationContextsOk returns a tuple with the ViolationContexts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationContexts + +`func (o *SodViolationCheckResult1) SetViolationContexts(v []SodViolationContext1)` + +SetViolationContexts sets ViolationContexts field to given value. + +### HasViolationContexts + +`func (o *SodViolationCheckResult1) HasViolationContexts() bool` + +HasViolationContexts returns a boolean if a field has been set. + +### GetViolatedPolicies + +`func (o *SodViolationCheckResult1) GetViolatedPolicies() []SodPolicyDto` + +GetViolatedPolicies returns the ViolatedPolicies field if non-nil, zero value otherwise. + +### GetViolatedPoliciesOk + +`func (o *SodViolationCheckResult1) GetViolatedPoliciesOk() (*[]SodPolicyDto, bool)` + +GetViolatedPoliciesOk returns a tuple with the ViolatedPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolatedPolicies + +`func (o *SodViolationCheckResult1) SetViolatedPolicies(v []SodPolicyDto)` + +SetViolatedPolicies sets ViolatedPolicies field to given value. + +### HasViolatedPolicies + +`func (o *SodViolationCheckResult1) HasViolatedPolicies() bool` + +HasViolatedPolicies returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContext.md b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContext.md new file mode 100644 index 000000000..01a57de7b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContext.md @@ -0,0 +1,90 @@ +--- +id: beta-sod-violation-context +title: SodViolationContext +pagination_label: SodViolationContext +sidebar_label: SodViolationContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContext', 'BetaSodViolationContext'] +slug: /tools/sdk/go/beta/models/sod-violation-context +tags: ['SDK', 'Software Development Kit', 'SodViolationContext', 'BetaSodViolationContext'] +--- + +# SodViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**SodPolicyDto**](sod-policy-dto) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteria**](sod-violation-context-conflicting-access-criteria) | | [optional] + +## Methods + +### NewSodViolationContext + +`func NewSodViolationContext() *SodViolationContext` + +NewSodViolationContext instantiates a new SodViolationContext 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 + +### NewSodViolationContextWithDefaults + +`func NewSodViolationContextWithDefaults() *SodViolationContext` + +NewSodViolationContextWithDefaults instantiates a new SodViolationContext 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 + +### GetPolicy + +`func (o *SodViolationContext) GetPolicy() SodPolicyDto` + +GetPolicy returns the Policy field if non-nil, zero value otherwise. + +### GetPolicyOk + +`func (o *SodViolationContext) GetPolicyOk() (*SodPolicyDto, bool)` + +GetPolicyOk returns a tuple with the Policy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicy + +`func (o *SodViolationContext) SetPolicy(v SodPolicyDto)` + +SetPolicy sets Policy field to given value. + +### HasPolicy + +`func (o *SodViolationContext) HasPolicy() bool` + +HasPolicy returns a boolean if a field has been set. + +### GetConflictingAccessCriteria + +`func (o *SodViolationContext) GetConflictingAccessCriteria() SodViolationContextConflictingAccessCriteria` + +GetConflictingAccessCriteria returns the ConflictingAccessCriteria field if non-nil, zero value otherwise. + +### GetConflictingAccessCriteriaOk + +`func (o *SodViolationContext) GetConflictingAccessCriteriaOk() (*SodViolationContextConflictingAccessCriteria, bool)` + +GetConflictingAccessCriteriaOk returns a tuple with the ConflictingAccessCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConflictingAccessCriteria + +`func (o *SodViolationContext) SetConflictingAccessCriteria(v SodViolationContextConflictingAccessCriteria)` + +SetConflictingAccessCriteria sets ConflictingAccessCriteria field to given value. + +### HasConflictingAccessCriteria + +`func (o *SodViolationContext) HasConflictingAccessCriteria() bool` + +HasConflictingAccessCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContext1.md b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContext1.md new file mode 100644 index 000000000..e0efa7c58 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContext1.md @@ -0,0 +1,90 @@ +--- +id: beta-sod-violation-context1 +title: SodViolationContext1 +pagination_label: SodViolationContext1 +sidebar_label: SodViolationContext1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContext1', 'BetaSodViolationContext1'] +slug: /tools/sdk/go/beta/models/sod-violation-context1 +tags: ['SDK', 'Software Development Kit', 'SodViolationContext1', 'BetaSodViolationContext1'] +--- + +# SodViolationContext1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**SodPolicyDto**](sod-policy-dto) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**SodViolationContext1ConflictingAccessCriteria**](sod-violation-context1-conflicting-access-criteria) | | [optional] + +## Methods + +### NewSodViolationContext1 + +`func NewSodViolationContext1() *SodViolationContext1` + +NewSodViolationContext1 instantiates a new SodViolationContext1 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 + +### NewSodViolationContext1WithDefaults + +`func NewSodViolationContext1WithDefaults() *SodViolationContext1` + +NewSodViolationContext1WithDefaults instantiates a new SodViolationContext1 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 + +### GetPolicy + +`func (o *SodViolationContext1) GetPolicy() SodPolicyDto` + +GetPolicy returns the Policy field if non-nil, zero value otherwise. + +### GetPolicyOk + +`func (o *SodViolationContext1) GetPolicyOk() (*SodPolicyDto, bool)` + +GetPolicyOk returns a tuple with the Policy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicy + +`func (o *SodViolationContext1) SetPolicy(v SodPolicyDto)` + +SetPolicy sets Policy field to given value. + +### HasPolicy + +`func (o *SodViolationContext1) HasPolicy() bool` + +HasPolicy returns a boolean if a field has been set. + +### GetConflictingAccessCriteria + +`func (o *SodViolationContext1) GetConflictingAccessCriteria() SodViolationContext1ConflictingAccessCriteria` + +GetConflictingAccessCriteria returns the ConflictingAccessCriteria field if non-nil, zero value otherwise. + +### GetConflictingAccessCriteriaOk + +`func (o *SodViolationContext1) GetConflictingAccessCriteriaOk() (*SodViolationContext1ConflictingAccessCriteria, bool)` + +GetConflictingAccessCriteriaOk returns a tuple with the ConflictingAccessCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConflictingAccessCriteria + +`func (o *SodViolationContext1) SetConflictingAccessCriteria(v SodViolationContext1ConflictingAccessCriteria)` + +SetConflictingAccessCriteria sets ConflictingAccessCriteria field to given value. + +### HasConflictingAccessCriteria + +`func (o *SodViolationContext1) HasConflictingAccessCriteria() bool` + +HasConflictingAccessCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContext1ConflictingAccessCriteria.md b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContext1ConflictingAccessCriteria.md new file mode 100644 index 000000000..510124f3b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContext1ConflictingAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: beta-sod-violation-context1-conflicting-access-criteria +title: SodViolationContext1ConflictingAccessCriteria +pagination_label: SodViolationContext1ConflictingAccessCriteria +sidebar_label: SodViolationContext1ConflictingAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContext1ConflictingAccessCriteria', 'BetaSodViolationContext1ConflictingAccessCriteria'] +slug: /tools/sdk/go/beta/models/sod-violation-context1-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContext1ConflictingAccessCriteria', 'BetaSodViolationContext1ConflictingAccessCriteria'] +--- + +# SodViolationContext1ConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**SodViolationContext1ConflictingAccessCriteriaLeftCriteria**](sod-violation-context1-conflicting-access-criteria-left-criteria) | | [optional] +**RightCriteria** | Pointer to [**SodViolationContext1ConflictingAccessCriteriaLeftCriteria**](sod-violation-context1-conflicting-access-criteria-left-criteria) | | [optional] + +## Methods + +### NewSodViolationContext1ConflictingAccessCriteria + +`func NewSodViolationContext1ConflictingAccessCriteria() *SodViolationContext1ConflictingAccessCriteria` + +NewSodViolationContext1ConflictingAccessCriteria instantiates a new SodViolationContext1ConflictingAccessCriteria 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 + +### NewSodViolationContext1ConflictingAccessCriteriaWithDefaults + +`func NewSodViolationContext1ConflictingAccessCriteriaWithDefaults() *SodViolationContext1ConflictingAccessCriteria` + +NewSodViolationContext1ConflictingAccessCriteriaWithDefaults instantiates a new SodViolationContext1ConflictingAccessCriteria 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 + +### GetLeftCriteria + +`func (o *SodViolationContext1ConflictingAccessCriteria) GetLeftCriteria() SodViolationContext1ConflictingAccessCriteriaLeftCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *SodViolationContext1ConflictingAccessCriteria) GetLeftCriteriaOk() (*SodViolationContext1ConflictingAccessCriteriaLeftCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *SodViolationContext1ConflictingAccessCriteria) SetLeftCriteria(v SodViolationContext1ConflictingAccessCriteriaLeftCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *SodViolationContext1ConflictingAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *SodViolationContext1ConflictingAccessCriteria) GetRightCriteria() SodViolationContext1ConflictingAccessCriteriaLeftCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *SodViolationContext1ConflictingAccessCriteria) GetRightCriteriaOk() (*SodViolationContext1ConflictingAccessCriteriaLeftCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *SodViolationContext1ConflictingAccessCriteria) SetRightCriteria(v SodViolationContext1ConflictingAccessCriteriaLeftCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *SodViolationContext1ConflictingAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContext1ConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContext1ConflictingAccessCriteriaLeftCriteria.md new file mode 100644 index 000000000..0bfbbb281 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContext1ConflictingAccessCriteriaLeftCriteria.md @@ -0,0 +1,64 @@ +--- +id: beta-sod-violation-context1-conflicting-access-criteria-left-criteria +title: SodViolationContext1ConflictingAccessCriteriaLeftCriteria +pagination_label: SodViolationContext1ConflictingAccessCriteriaLeftCriteria +sidebar_label: SodViolationContext1ConflictingAccessCriteriaLeftCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContext1ConflictingAccessCriteriaLeftCriteria', 'BetaSodViolationContext1ConflictingAccessCriteriaLeftCriteria'] +slug: /tools/sdk/go/beta/models/sod-violation-context1-conflicting-access-criteria-left-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContext1ConflictingAccessCriteriaLeftCriteria', 'BetaSodViolationContext1ConflictingAccessCriteriaLeftCriteria'] +--- + +# SodViolationContext1ConflictingAccessCriteriaLeftCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]SodExemptCriteria1**](sod-exempt-criteria1) | | [optional] + +## Methods + +### NewSodViolationContext1ConflictingAccessCriteriaLeftCriteria + +`func NewSodViolationContext1ConflictingAccessCriteriaLeftCriteria() *SodViolationContext1ConflictingAccessCriteriaLeftCriteria` + +NewSodViolationContext1ConflictingAccessCriteriaLeftCriteria instantiates a new SodViolationContext1ConflictingAccessCriteriaLeftCriteria 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 + +### NewSodViolationContext1ConflictingAccessCriteriaLeftCriteriaWithDefaults + +`func NewSodViolationContext1ConflictingAccessCriteriaLeftCriteriaWithDefaults() *SodViolationContext1ConflictingAccessCriteriaLeftCriteria` + +NewSodViolationContext1ConflictingAccessCriteriaLeftCriteriaWithDefaults instantiates a new SodViolationContext1ConflictingAccessCriteriaLeftCriteria 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 + +### GetCriteriaList + +`func (o *SodViolationContext1ConflictingAccessCriteriaLeftCriteria) GetCriteriaList() []SodExemptCriteria1` + +GetCriteriaList returns the CriteriaList field if non-nil, zero value otherwise. + +### GetCriteriaListOk + +`func (o *SodViolationContext1ConflictingAccessCriteriaLeftCriteria) GetCriteriaListOk() (*[]SodExemptCriteria1, bool)` + +GetCriteriaListOk returns a tuple with the CriteriaList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteriaList + +`func (o *SodViolationContext1ConflictingAccessCriteriaLeftCriteria) SetCriteriaList(v []SodExemptCriteria1)` + +SetCriteriaList sets CriteriaList field to given value. + +### HasCriteriaList + +`func (o *SodViolationContext1ConflictingAccessCriteriaLeftCriteria) HasCriteriaList() bool` + +HasCriteriaList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContextCheckCompleted.md b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContextCheckCompleted.md new file mode 100644 index 000000000..3842e05b1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContextCheckCompleted.md @@ -0,0 +1,136 @@ +--- +id: beta-sod-violation-context-check-completed +title: SodViolationContextCheckCompleted +pagination_label: SodViolationContextCheckCompleted +sidebar_label: SodViolationContextCheckCompleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContextCheckCompleted', 'BetaSodViolationContextCheckCompleted'] +slug: /tools/sdk/go/beta/models/sod-violation-context-check-completed +tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted', 'BetaSodViolationContextCheckCompleted'] +--- + +# SodViolationContextCheckCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **NullableString** | The status of SOD violation check | [optional] +**Uuid** | Pointer to **NullableString** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] + +## Methods + +### NewSodViolationContextCheckCompleted + +`func NewSodViolationContextCheckCompleted() *SodViolationContextCheckCompleted` + +NewSodViolationContextCheckCompleted instantiates a new SodViolationContextCheckCompleted 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 + +### NewSodViolationContextCheckCompletedWithDefaults + +`func NewSodViolationContextCheckCompletedWithDefaults() *SodViolationContextCheckCompleted` + +NewSodViolationContextCheckCompletedWithDefaults instantiates a new SodViolationContextCheckCompleted 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 + +### GetState + +`func (o *SodViolationContextCheckCompleted) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *SodViolationContextCheckCompleted) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *SodViolationContextCheckCompleted) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *SodViolationContextCheckCompleted) HasState() bool` + +HasState returns a boolean if a field has been set. + +### SetStateNil + +`func (o *SodViolationContextCheckCompleted) SetStateNil(b bool)` + + SetStateNil sets the value for State to be an explicit nil + +### UnsetState +`func (o *SodViolationContextCheckCompleted) UnsetState()` + +UnsetState ensures that no value is present for State, not even an explicit nil +### GetUuid + +`func (o *SodViolationContextCheckCompleted) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *SodViolationContextCheckCompleted) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *SodViolationContextCheckCompleted) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *SodViolationContextCheckCompleted) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *SodViolationContextCheckCompleted) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *SodViolationContextCheckCompleted) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetViolationCheckResult + +`func (o *SodViolationContextCheckCompleted) GetViolationCheckResult() SodViolationCheckResult` + +GetViolationCheckResult returns the ViolationCheckResult field if non-nil, zero value otherwise. + +### GetViolationCheckResultOk + +`func (o *SodViolationContextCheckCompleted) GetViolationCheckResultOk() (*SodViolationCheckResult, bool)` + +GetViolationCheckResultOk returns a tuple with the ViolationCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationCheckResult + +`func (o *SodViolationContextCheckCompleted) SetViolationCheckResult(v SodViolationCheckResult)` + +SetViolationCheckResult sets ViolationCheckResult field to given value. + +### HasViolationCheckResult + +`func (o *SodViolationContextCheckCompleted) HasViolationCheckResult() bool` + +HasViolationCheckResult returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContextCheckCompleted1.md b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContextCheckCompleted1.md new file mode 100644 index 000000000..b684c2696 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContextCheckCompleted1.md @@ -0,0 +1,116 @@ +--- +id: beta-sod-violation-context-check-completed1 +title: SodViolationContextCheckCompleted1 +pagination_label: SodViolationContextCheckCompleted1 +sidebar_label: SodViolationContextCheckCompleted1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContextCheckCompleted1', 'BetaSodViolationContextCheckCompleted1'] +slug: /tools/sdk/go/beta/models/sod-violation-context-check-completed1 +tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted1', 'BetaSodViolationContextCheckCompleted1'] +--- + +# SodViolationContextCheckCompleted1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **string** | The status of SOD violation check | [optional] +**Uuid** | Pointer to **string** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult1**](sod-violation-check-result1) | | [optional] + +## Methods + +### NewSodViolationContextCheckCompleted1 + +`func NewSodViolationContextCheckCompleted1() *SodViolationContextCheckCompleted1` + +NewSodViolationContextCheckCompleted1 instantiates a new SodViolationContextCheckCompleted1 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 + +### NewSodViolationContextCheckCompleted1WithDefaults + +`func NewSodViolationContextCheckCompleted1WithDefaults() *SodViolationContextCheckCompleted1` + +NewSodViolationContextCheckCompleted1WithDefaults instantiates a new SodViolationContextCheckCompleted1 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 + +### GetState + +`func (o *SodViolationContextCheckCompleted1) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *SodViolationContextCheckCompleted1) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *SodViolationContextCheckCompleted1) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *SodViolationContextCheckCompleted1) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetUuid + +`func (o *SodViolationContextCheckCompleted1) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *SodViolationContextCheckCompleted1) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *SodViolationContextCheckCompleted1) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *SodViolationContextCheckCompleted1) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### GetViolationCheckResult + +`func (o *SodViolationContextCheckCompleted1) GetViolationCheckResult() SodViolationCheckResult1` + +GetViolationCheckResult returns the ViolationCheckResult field if non-nil, zero value otherwise. + +### GetViolationCheckResultOk + +`func (o *SodViolationContextCheckCompleted1) GetViolationCheckResultOk() (*SodViolationCheckResult1, bool)` + +GetViolationCheckResultOk returns a tuple with the ViolationCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationCheckResult + +`func (o *SodViolationContextCheckCompleted1) SetViolationCheckResult(v SodViolationCheckResult1)` + +SetViolationCheckResult sets ViolationCheckResult field to given value. + +### HasViolationCheckResult + +`func (o *SodViolationContextCheckCompleted1) HasViolationCheckResult() bool` + +HasViolationCheckResult returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContextConflictingAccessCriteria.md b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContextConflictingAccessCriteria.md new file mode 100644 index 000000000..0d66210df --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContextConflictingAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: beta-sod-violation-context-conflicting-access-criteria +title: SodViolationContextConflictingAccessCriteria +pagination_label: SodViolationContextConflictingAccessCriteria +sidebar_label: SodViolationContextConflictingAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContextConflictingAccessCriteria', 'BetaSodViolationContextConflictingAccessCriteria'] +slug: /tools/sdk/go/beta/models/sod-violation-context-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteria', 'BetaSodViolationContextConflictingAccessCriteria'] +--- + +# SodViolationContextConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] +**RightCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] + +## Methods + +### NewSodViolationContextConflictingAccessCriteria + +`func NewSodViolationContextConflictingAccessCriteria() *SodViolationContextConflictingAccessCriteria` + +NewSodViolationContextConflictingAccessCriteria instantiates a new SodViolationContextConflictingAccessCriteria 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 + +### NewSodViolationContextConflictingAccessCriteriaWithDefaults + +`func NewSodViolationContextConflictingAccessCriteriaWithDefaults() *SodViolationContextConflictingAccessCriteria` + +NewSodViolationContextConflictingAccessCriteriaWithDefaults instantiates a new SodViolationContextConflictingAccessCriteria 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 + +### GetLeftCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) GetLeftCriteria() SodViolationContextConflictingAccessCriteriaLeftCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *SodViolationContextConflictingAccessCriteria) GetLeftCriteriaOk() (*SodViolationContextConflictingAccessCriteriaLeftCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) SetLeftCriteria(v SodViolationContextConflictingAccessCriteriaLeftCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) GetRightCriteria() SodViolationContextConflictingAccessCriteriaLeftCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *SodViolationContextConflictingAccessCriteria) GetRightCriteriaOk() (*SodViolationContextConflictingAccessCriteriaLeftCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) SetRightCriteria(v SodViolationContextConflictingAccessCriteriaLeftCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md new file mode 100644 index 000000000..8a6e47925 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md @@ -0,0 +1,64 @@ +--- +id: beta-sod-violation-context-conflicting-access-criteria-left-criteria +title: SodViolationContextConflictingAccessCriteriaLeftCriteria +pagination_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'BetaSodViolationContextConflictingAccessCriteriaLeftCriteria'] +slug: /tools/sdk/go/beta/models/sod-violation-context-conflicting-access-criteria-left-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'BetaSodViolationContextConflictingAccessCriteriaLeftCriteria'] +--- + +# SodViolationContextConflictingAccessCriteriaLeftCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]SodExemptCriteria**](sod-exempt-criteria) | | [optional] + +## Methods + +### NewSodViolationContextConflictingAccessCriteriaLeftCriteria + +`func NewSodViolationContextConflictingAccessCriteriaLeftCriteria() *SodViolationContextConflictingAccessCriteriaLeftCriteria` + +NewSodViolationContextConflictingAccessCriteriaLeftCriteria instantiates a new SodViolationContextConflictingAccessCriteriaLeftCriteria 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 + +### NewSodViolationContextConflictingAccessCriteriaLeftCriteriaWithDefaults + +`func NewSodViolationContextConflictingAccessCriteriaLeftCriteriaWithDefaults() *SodViolationContextConflictingAccessCriteriaLeftCriteria` + +NewSodViolationContextConflictingAccessCriteriaLeftCriteriaWithDefaults instantiates a new SodViolationContextConflictingAccessCriteriaLeftCriteria 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 + +### GetCriteriaList + +`func (o *SodViolationContextConflictingAccessCriteriaLeftCriteria) GetCriteriaList() []SodExemptCriteria` + +GetCriteriaList returns the CriteriaList field if non-nil, zero value otherwise. + +### GetCriteriaListOk + +`func (o *SodViolationContextConflictingAccessCriteriaLeftCriteria) GetCriteriaListOk() (*[]SodExemptCriteria, bool)` + +GetCriteriaListOk returns a tuple with the CriteriaList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteriaList + +`func (o *SodViolationContextConflictingAccessCriteriaLeftCriteria) SetCriteriaList(v []SodExemptCriteria)` + +SetCriteriaList sets CriteriaList field to given value. + +### HasCriteriaList + +`func (o *SodViolationContextConflictingAccessCriteriaLeftCriteria) HasCriteriaList() bool` + +HasCriteriaList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Source.md b/docs/tools/sdk/go/Reference/Beta/Models/Source.md new file mode 100644 index 000000000..eb7cb14d1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Source.md @@ -0,0 +1,919 @@ +--- +id: beta-source +title: Source +pagination_label: Source +sidebar_label: Source +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Source', 'BetaSource'] +slug: /tools/sdk/go/beta/models/source +tags: ['SDK', 'Software Development Kit', 'Source', 'BetaSource'] +--- + +# Source + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Source ID. | [optional] [readonly] +**Name** | **string** | Source's human-readable name. | +**Description** | Pointer to **string** | Source's human-readable description. | [optional] +**Owner** | [**MultiHostIntegrationsOwner**](multi-host-integrations-owner) | | +**Cluster** | Pointer to [**NullableMultiHostIntegrationsCluster**](multi-host-integrations-cluster) | | [optional] +**AccountCorrelationConfig** | Pointer to [**NullableMultiHostSourcesAccountCorrelationConfig**](multi-host-sources-account-correlation-config) | | [optional] +**AccountCorrelationRule** | Pointer to [**NullableMultiHostSourcesAccountCorrelationRule**](multi-host-sources-account-correlation-rule) | | [optional] +**ManagerCorrelationMapping** | Pointer to [**NullableManagerCorrelationMapping**](manager-correlation-mapping) | | [optional] +**ManagerCorrelationRule** | Pointer to [**NullableMultiHostSourcesManagerCorrelationRule**](multi-host-sources-manager-correlation-rule) | | [optional] +**BeforeProvisioningRule** | Pointer to [**NullableMultiHostSourcesBeforeProvisioningRule**](multi-host-sources-before-provisioning-rule) | | [optional] +**Schemas** | Pointer to [**[]MultiHostSourcesSchemasInner**](multi-host-sources-schemas-inner) | List of references to schema objects. | [optional] +**PasswordPolicies** | Pointer to [**[]MultiHostSourcesPasswordPoliciesInner**](multi-host-sources-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**Features** | Pointer to **[]string** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Type** | Pointer to **string** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Connector** | **string** | Connector script name. | +**ConnectorClass** | Pointer to **string** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**ConnectorAttributes** | Pointer to **map[string]interface{}** | Connector specific configuration. This configuration will differ from type to type. | [optional] +**DeleteThreshold** | Pointer to **int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**Authoritative** | Pointer to **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to false] +**ManagementWorkgroup** | Pointer to [**NullableMultiHostIntegrationsManagementWorkgroup**](multi-host-integrations-management-workgroup) | | [optional] +**Healthy** | Pointer to **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to false] +**Status** | Pointer to **string** | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**Since** | Pointer to **string** | Timestamp that shows when a source health check was last performed. | [optional] +**ConnectorId** | Pointer to **string** | Connector ID | [optional] +**ConnectorName** | Pointer to **string** | Name of the connector that was chosen during source creation. | [optional] +**ConnectionType** | Pointer to **string** | Type of connection (direct or file). | [optional] +**ConnectorImplementationId** | Pointer to **string** | Connector implementation ID. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date-time when the source was last modified. | [optional] +**CredentialProviderEnabled** | Pointer to **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to false] +**Category** | Pointer to **NullableString** | Source category (e.g. null, CredentialProvider). | [optional] + +## Methods + +### NewSource + +`func NewSource(name string, owner MultiHostIntegrationsOwner, connector string, ) *Source` + +NewSource instantiates a new Source 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 + +### NewSourceWithDefaults + +`func NewSourceWithDefaults() *Source` + +NewSourceWithDefaults instantiates a new Source 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 + +### GetId + +`func (o *Source) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Source) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Source) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Source) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Source) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Source) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Source) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Source) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Source) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Source) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Source) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *Source) GetOwner() MultiHostIntegrationsOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Source) GetOwnerOk() (*MultiHostIntegrationsOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Source) SetOwner(v MultiHostIntegrationsOwner)` + +SetOwner sets Owner field to given value. + + +### GetCluster + +`func (o *Source) GetCluster() MultiHostIntegrationsCluster` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *Source) GetClusterOk() (*MultiHostIntegrationsCluster, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *Source) SetCluster(v MultiHostIntegrationsCluster)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *Source) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### SetClusterNil + +`func (o *Source) SetClusterNil(b bool)` + + SetClusterNil sets the value for Cluster to be an explicit nil + +### UnsetCluster +`func (o *Source) UnsetCluster()` + +UnsetCluster ensures that no value is present for Cluster, not even an explicit nil +### GetAccountCorrelationConfig + +`func (o *Source) GetAccountCorrelationConfig() MultiHostSourcesAccountCorrelationConfig` + +GetAccountCorrelationConfig returns the AccountCorrelationConfig field if non-nil, zero value otherwise. + +### GetAccountCorrelationConfigOk + +`func (o *Source) GetAccountCorrelationConfigOk() (*MultiHostSourcesAccountCorrelationConfig, bool)` + +GetAccountCorrelationConfigOk returns a tuple with the AccountCorrelationConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationConfig + +`func (o *Source) SetAccountCorrelationConfig(v MultiHostSourcesAccountCorrelationConfig)` + +SetAccountCorrelationConfig sets AccountCorrelationConfig field to given value. + +### HasAccountCorrelationConfig + +`func (o *Source) HasAccountCorrelationConfig() bool` + +HasAccountCorrelationConfig returns a boolean if a field has been set. + +### SetAccountCorrelationConfigNil + +`func (o *Source) SetAccountCorrelationConfigNil(b bool)` + + SetAccountCorrelationConfigNil sets the value for AccountCorrelationConfig to be an explicit nil + +### UnsetAccountCorrelationConfig +`func (o *Source) UnsetAccountCorrelationConfig()` + +UnsetAccountCorrelationConfig ensures that no value is present for AccountCorrelationConfig, not even an explicit nil +### GetAccountCorrelationRule + +`func (o *Source) GetAccountCorrelationRule() MultiHostSourcesAccountCorrelationRule` + +GetAccountCorrelationRule returns the AccountCorrelationRule field if non-nil, zero value otherwise. + +### GetAccountCorrelationRuleOk + +`func (o *Source) GetAccountCorrelationRuleOk() (*MultiHostSourcesAccountCorrelationRule, bool)` + +GetAccountCorrelationRuleOk returns a tuple with the AccountCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationRule + +`func (o *Source) SetAccountCorrelationRule(v MultiHostSourcesAccountCorrelationRule)` + +SetAccountCorrelationRule sets AccountCorrelationRule field to given value. + +### HasAccountCorrelationRule + +`func (o *Source) HasAccountCorrelationRule() bool` + +HasAccountCorrelationRule returns a boolean if a field has been set. + +### SetAccountCorrelationRuleNil + +`func (o *Source) SetAccountCorrelationRuleNil(b bool)` + + SetAccountCorrelationRuleNil sets the value for AccountCorrelationRule to be an explicit nil + +### UnsetAccountCorrelationRule +`func (o *Source) UnsetAccountCorrelationRule()` + +UnsetAccountCorrelationRule ensures that no value is present for AccountCorrelationRule, not even an explicit nil +### GetManagerCorrelationMapping + +`func (o *Source) GetManagerCorrelationMapping() ManagerCorrelationMapping` + +GetManagerCorrelationMapping returns the ManagerCorrelationMapping field if non-nil, zero value otherwise. + +### GetManagerCorrelationMappingOk + +`func (o *Source) GetManagerCorrelationMappingOk() (*ManagerCorrelationMapping, bool)` + +GetManagerCorrelationMappingOk returns a tuple with the ManagerCorrelationMapping field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationMapping + +`func (o *Source) SetManagerCorrelationMapping(v ManagerCorrelationMapping)` + +SetManagerCorrelationMapping sets ManagerCorrelationMapping field to given value. + +### HasManagerCorrelationMapping + +`func (o *Source) HasManagerCorrelationMapping() bool` + +HasManagerCorrelationMapping returns a boolean if a field has been set. + +### SetManagerCorrelationMappingNil + +`func (o *Source) SetManagerCorrelationMappingNil(b bool)` + + SetManagerCorrelationMappingNil sets the value for ManagerCorrelationMapping to be an explicit nil + +### UnsetManagerCorrelationMapping +`func (o *Source) UnsetManagerCorrelationMapping()` + +UnsetManagerCorrelationMapping ensures that no value is present for ManagerCorrelationMapping, not even an explicit nil +### GetManagerCorrelationRule + +`func (o *Source) GetManagerCorrelationRule() MultiHostSourcesManagerCorrelationRule` + +GetManagerCorrelationRule returns the ManagerCorrelationRule field if non-nil, zero value otherwise. + +### GetManagerCorrelationRuleOk + +`func (o *Source) GetManagerCorrelationRuleOk() (*MultiHostSourcesManagerCorrelationRule, bool)` + +GetManagerCorrelationRuleOk returns a tuple with the ManagerCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationRule + +`func (o *Source) SetManagerCorrelationRule(v MultiHostSourcesManagerCorrelationRule)` + +SetManagerCorrelationRule sets ManagerCorrelationRule field to given value. + +### HasManagerCorrelationRule + +`func (o *Source) HasManagerCorrelationRule() bool` + +HasManagerCorrelationRule returns a boolean if a field has been set. + +### SetManagerCorrelationRuleNil + +`func (o *Source) SetManagerCorrelationRuleNil(b bool)` + + SetManagerCorrelationRuleNil sets the value for ManagerCorrelationRule to be an explicit nil + +### UnsetManagerCorrelationRule +`func (o *Source) UnsetManagerCorrelationRule()` + +UnsetManagerCorrelationRule ensures that no value is present for ManagerCorrelationRule, not even an explicit nil +### GetBeforeProvisioningRule + +`func (o *Source) GetBeforeProvisioningRule() MultiHostSourcesBeforeProvisioningRule` + +GetBeforeProvisioningRule returns the BeforeProvisioningRule field if non-nil, zero value otherwise. + +### GetBeforeProvisioningRuleOk + +`func (o *Source) GetBeforeProvisioningRuleOk() (*MultiHostSourcesBeforeProvisioningRule, bool)` + +GetBeforeProvisioningRuleOk returns a tuple with the BeforeProvisioningRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBeforeProvisioningRule + +`func (o *Source) SetBeforeProvisioningRule(v MultiHostSourcesBeforeProvisioningRule)` + +SetBeforeProvisioningRule sets BeforeProvisioningRule field to given value. + +### HasBeforeProvisioningRule + +`func (o *Source) HasBeforeProvisioningRule() bool` + +HasBeforeProvisioningRule returns a boolean if a field has been set. + +### SetBeforeProvisioningRuleNil + +`func (o *Source) SetBeforeProvisioningRuleNil(b bool)` + + SetBeforeProvisioningRuleNil sets the value for BeforeProvisioningRule to be an explicit nil + +### UnsetBeforeProvisioningRule +`func (o *Source) UnsetBeforeProvisioningRule()` + +UnsetBeforeProvisioningRule ensures that no value is present for BeforeProvisioningRule, not even an explicit nil +### GetSchemas + +`func (o *Source) GetSchemas() []MultiHostSourcesSchemasInner` + +GetSchemas returns the Schemas field if non-nil, zero value otherwise. + +### GetSchemasOk + +`func (o *Source) GetSchemasOk() (*[]MultiHostSourcesSchemasInner, bool)` + +GetSchemasOk returns a tuple with the Schemas field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchemas + +`func (o *Source) SetSchemas(v []MultiHostSourcesSchemasInner)` + +SetSchemas sets Schemas field to given value. + +### HasSchemas + +`func (o *Source) HasSchemas() bool` + +HasSchemas returns a boolean if a field has been set. + +### GetPasswordPolicies + +`func (o *Source) GetPasswordPolicies() []MultiHostSourcesPasswordPoliciesInner` + +GetPasswordPolicies returns the PasswordPolicies field if non-nil, zero value otherwise. + +### GetPasswordPoliciesOk + +`func (o *Source) GetPasswordPoliciesOk() (*[]MultiHostSourcesPasswordPoliciesInner, bool)` + +GetPasswordPoliciesOk returns a tuple with the PasswordPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicies + +`func (o *Source) SetPasswordPolicies(v []MultiHostSourcesPasswordPoliciesInner)` + +SetPasswordPolicies sets PasswordPolicies field to given value. + +### HasPasswordPolicies + +`func (o *Source) HasPasswordPolicies() bool` + +HasPasswordPolicies returns a boolean if a field has been set. + +### SetPasswordPoliciesNil + +`func (o *Source) SetPasswordPoliciesNil(b bool)` + + SetPasswordPoliciesNil sets the value for PasswordPolicies to be an explicit nil + +### UnsetPasswordPolicies +`func (o *Source) UnsetPasswordPolicies()` + +UnsetPasswordPolicies ensures that no value is present for PasswordPolicies, not even an explicit nil +### GetFeatures + +`func (o *Source) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *Source) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *Source) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *Source) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### GetType + +`func (o *Source) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Source) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Source) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Source) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConnector + +`func (o *Source) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *Source) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *Source) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetConnectorClass + +`func (o *Source) GetConnectorClass() string` + +GetConnectorClass returns the ConnectorClass field if non-nil, zero value otherwise. + +### GetConnectorClassOk + +`func (o *Source) GetConnectorClassOk() (*string, bool)` + +GetConnectorClassOk returns a tuple with the ConnectorClass field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorClass + +`func (o *Source) SetConnectorClass(v string)` + +SetConnectorClass sets ConnectorClass field to given value. + +### HasConnectorClass + +`func (o *Source) HasConnectorClass() bool` + +HasConnectorClass returns a boolean if a field has been set. + +### GetConnectorAttributes + +`func (o *Source) GetConnectorAttributes() map[string]interface{}` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *Source) GetConnectorAttributesOk() (*map[string]interface{}, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *Source) SetConnectorAttributes(v map[string]interface{})` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + +### HasConnectorAttributes + +`func (o *Source) HasConnectorAttributes() bool` + +HasConnectorAttributes returns a boolean if a field has been set. + +### GetDeleteThreshold + +`func (o *Source) GetDeleteThreshold() int32` + +GetDeleteThreshold returns the DeleteThreshold field if non-nil, zero value otherwise. + +### GetDeleteThresholdOk + +`func (o *Source) GetDeleteThresholdOk() (*int32, bool)` + +GetDeleteThresholdOk returns a tuple with the DeleteThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteThreshold + +`func (o *Source) SetDeleteThreshold(v int32)` + +SetDeleteThreshold sets DeleteThreshold field to given value. + +### HasDeleteThreshold + +`func (o *Source) HasDeleteThreshold() bool` + +HasDeleteThreshold returns a boolean if a field has been set. + +### GetAuthoritative + +`func (o *Source) GetAuthoritative() bool` + +GetAuthoritative returns the Authoritative field if non-nil, zero value otherwise. + +### GetAuthoritativeOk + +`func (o *Source) GetAuthoritativeOk() (*bool, bool)` + +GetAuthoritativeOk returns a tuple with the Authoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritative + +`func (o *Source) SetAuthoritative(v bool)` + +SetAuthoritative sets Authoritative field to given value. + +### HasAuthoritative + +`func (o *Source) HasAuthoritative() bool` + +HasAuthoritative returns a boolean if a field has been set. + +### GetManagementWorkgroup + +`func (o *Source) GetManagementWorkgroup() MultiHostIntegrationsManagementWorkgroup` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *Source) GetManagementWorkgroupOk() (*MultiHostIntegrationsManagementWorkgroup, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *Source) SetManagementWorkgroup(v MultiHostIntegrationsManagementWorkgroup)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *Source) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### SetManagementWorkgroupNil + +`func (o *Source) SetManagementWorkgroupNil(b bool)` + + SetManagementWorkgroupNil sets the value for ManagementWorkgroup to be an explicit nil + +### UnsetManagementWorkgroup +`func (o *Source) UnsetManagementWorkgroup()` + +UnsetManagementWorkgroup ensures that no value is present for ManagementWorkgroup, not even an explicit nil +### GetHealthy + +`func (o *Source) GetHealthy() bool` + +GetHealthy returns the Healthy field if non-nil, zero value otherwise. + +### GetHealthyOk + +`func (o *Source) GetHealthyOk() (*bool, bool)` + +GetHealthyOk returns a tuple with the Healthy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthy + +`func (o *Source) SetHealthy(v bool)` + +SetHealthy sets Healthy field to given value. + +### HasHealthy + +`func (o *Source) HasHealthy() bool` + +HasHealthy returns a boolean if a field has been set. + +### GetStatus + +`func (o *Source) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Source) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Source) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Source) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSince + +`func (o *Source) GetSince() string` + +GetSince returns the Since field if non-nil, zero value otherwise. + +### GetSinceOk + +`func (o *Source) GetSinceOk() (*string, bool)` + +GetSinceOk returns a tuple with the Since field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSince + +`func (o *Source) SetSince(v string)` + +SetSince sets Since field to given value. + +### HasSince + +`func (o *Source) HasSince() bool` + +HasSince returns a boolean if a field has been set. + +### GetConnectorId + +`func (o *Source) GetConnectorId() string` + +GetConnectorId returns the ConnectorId field if non-nil, zero value otherwise. + +### GetConnectorIdOk + +`func (o *Source) GetConnectorIdOk() (*string, bool)` + +GetConnectorIdOk returns a tuple with the ConnectorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorId + +`func (o *Source) SetConnectorId(v string)` + +SetConnectorId sets ConnectorId field to given value. + +### HasConnectorId + +`func (o *Source) HasConnectorId() bool` + +HasConnectorId returns a boolean if a field has been set. + +### GetConnectorName + +`func (o *Source) GetConnectorName() string` + +GetConnectorName returns the ConnectorName field if non-nil, zero value otherwise. + +### GetConnectorNameOk + +`func (o *Source) GetConnectorNameOk() (*string, bool)` + +GetConnectorNameOk returns a tuple with the ConnectorName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorName + +`func (o *Source) SetConnectorName(v string)` + +SetConnectorName sets ConnectorName field to given value. + +### HasConnectorName + +`func (o *Source) HasConnectorName() bool` + +HasConnectorName returns a boolean if a field has been set. + +### GetConnectionType + +`func (o *Source) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *Source) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *Source) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *Source) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + +### GetConnectorImplementationId + +`func (o *Source) GetConnectorImplementationId() string` + +GetConnectorImplementationId returns the ConnectorImplementationId field if non-nil, zero value otherwise. + +### GetConnectorImplementationIdOk + +`func (o *Source) GetConnectorImplementationIdOk() (*string, bool)` + +GetConnectorImplementationIdOk returns a tuple with the ConnectorImplementationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorImplementationId + +`func (o *Source) SetConnectorImplementationId(v string)` + +SetConnectorImplementationId sets ConnectorImplementationId field to given value. + +### HasConnectorImplementationId + +`func (o *Source) HasConnectorImplementationId() bool` + +HasConnectorImplementationId returns a boolean if a field has been set. + +### GetCreated + +`func (o *Source) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Source) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Source) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Source) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Source) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Source) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Source) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Source) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCredentialProviderEnabled + +`func (o *Source) GetCredentialProviderEnabled() bool` + +GetCredentialProviderEnabled returns the CredentialProviderEnabled field if non-nil, zero value otherwise. + +### GetCredentialProviderEnabledOk + +`func (o *Source) GetCredentialProviderEnabledOk() (*bool, bool)` + +GetCredentialProviderEnabledOk returns a tuple with the CredentialProviderEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialProviderEnabled + +`func (o *Source) SetCredentialProviderEnabled(v bool)` + +SetCredentialProviderEnabled sets CredentialProviderEnabled field to given value. + +### HasCredentialProviderEnabled + +`func (o *Source) HasCredentialProviderEnabled() bool` + +HasCredentialProviderEnabled returns a boolean if a field has been set. + +### GetCategory + +`func (o *Source) GetCategory() string` + +GetCategory returns the Category field if non-nil, zero value otherwise. + +### GetCategoryOk + +`func (o *Source) GetCategoryOk() (*string, bool)` + +GetCategoryOk returns a tuple with the Category field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCategory + +`func (o *Source) SetCategory(v string)` + +SetCategory sets Category field to given value. + +### HasCategory + +`func (o *Source) HasCategory() bool` + +HasCategory returns a boolean if a field has been set. + +### SetCategoryNil + +`func (o *Source) SetCategoryNil(b bool)` + + SetCategoryNil sets the value for Category to be an explicit nil + +### UnsetCategory +`func (o *Source) UnsetCategory()` + +UnsetCategory ensures that no value is present for Category, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Source1.md b/docs/tools/sdk/go/Reference/Beta/Models/Source1.md new file mode 100644 index 000000000..c41cd5282 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Source1.md @@ -0,0 +1,90 @@ +--- +id: beta-source1 +title: Source1 +pagination_label: Source1 +sidebar_label: Source1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Source1', 'BetaSource1'] +slug: /tools/sdk/go/beta/models/source1 +tags: ['SDK', 'Software Development Kit', 'Source1', 'BetaSource1'] +--- + +# Source1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Attribute mapping type. | [optional] +**Properties** | Pointer to **map[string]interface{}** | Attribute mapping properties. | [optional] + +## Methods + +### NewSource1 + +`func NewSource1() *Source1` + +NewSource1 instantiates a new Source1 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 + +### NewSource1WithDefaults + +`func NewSource1WithDefaults() *Source1` + +NewSource1WithDefaults instantiates a new Source1 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 + +### GetType + +`func (o *Source1) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Source1) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Source1) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Source1) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetProperties + +`func (o *Source1) GetProperties() map[string]interface{}` + +GetProperties returns the Properties field if non-nil, zero value otherwise. + +### GetPropertiesOk + +`func (o *Source1) GetPropertiesOk() (*map[string]interface{}, bool)` + +GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperties + +`func (o *Source1) SetProperties(v map[string]interface{})` + +SetProperties sets Properties field to given value. + +### HasProperties + +`func (o *Source1) HasProperties() bool` + +HasProperties returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceAccountCreated.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceAccountCreated.md new file mode 100644 index 000000000..6dffe156f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceAccountCreated.md @@ -0,0 +1,206 @@ +--- +id: beta-source-account-created +title: SourceAccountCreated +pagination_label: SourceAccountCreated +sidebar_label: SourceAccountCreated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountCreated', 'BetaSourceAccountCreated'] +slug: /tools/sdk/go/beta/models/source-account-created +tags: ['SDK', 'Software Development Kit', 'SourceAccountCreated', 'BetaSourceAccountCreated'] +--- + +# SourceAccountCreated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | **string** | Identity's universal unique identifier (UUID) on the source. The source system generates the UUID. | +**Id** | **string** | SailPoint generated unique identifier. | +**NativeIdentifier** | **string** | Account's unique ID on the source. | +**SourceId** | **string** | Source ID. | +**SourceName** | **string** | Source name. | +**IdentityId** | **string** | ID of the identity correlated with the account. | +**IdentityName** | **string** | Name of the identity correlated with the account. | +**Attributes** | **map[string]interface{}** | Account attributes. The attributes' contents depend on the source's account schema. | + +## Methods + +### NewSourceAccountCreated + +`func NewSourceAccountCreated(uuid string, id string, nativeIdentifier string, sourceId string, sourceName string, identityId string, identityName string, attributes map[string]interface{}, ) *SourceAccountCreated` + +NewSourceAccountCreated instantiates a new SourceAccountCreated 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 + +### NewSourceAccountCreatedWithDefaults + +`func NewSourceAccountCreatedWithDefaults() *SourceAccountCreated` + +NewSourceAccountCreatedWithDefaults instantiates a new SourceAccountCreated 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 + +### GetUuid + +`func (o *SourceAccountCreated) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *SourceAccountCreated) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *SourceAccountCreated) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + + +### GetId + +`func (o *SourceAccountCreated) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountCreated) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountCreated) SetId(v string)` + +SetId sets Id field to given value. + + +### GetNativeIdentifier + +`func (o *SourceAccountCreated) GetNativeIdentifier() string` + +GetNativeIdentifier returns the NativeIdentifier field if non-nil, zero value otherwise. + +### GetNativeIdentifierOk + +`func (o *SourceAccountCreated) GetNativeIdentifierOk() (*string, bool)` + +GetNativeIdentifierOk returns a tuple with the NativeIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentifier + +`func (o *SourceAccountCreated) SetNativeIdentifier(v string)` + +SetNativeIdentifier sets NativeIdentifier field to given value. + + +### GetSourceId + +`func (o *SourceAccountCreated) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *SourceAccountCreated) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *SourceAccountCreated) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetSourceName + +`func (o *SourceAccountCreated) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *SourceAccountCreated) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *SourceAccountCreated) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### GetIdentityId + +`func (o *SourceAccountCreated) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *SourceAccountCreated) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *SourceAccountCreated) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetIdentityName + +`func (o *SourceAccountCreated) GetIdentityName() string` + +GetIdentityName returns the IdentityName field if non-nil, zero value otherwise. + +### GetIdentityNameOk + +`func (o *SourceAccountCreated) GetIdentityNameOk() (*string, bool)` + +GetIdentityNameOk returns a tuple with the IdentityName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityName + +`func (o *SourceAccountCreated) SetIdentityName(v string)` + +SetIdentityName sets IdentityName field to given value. + + +### GetAttributes + +`func (o *SourceAccountCreated) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *SourceAccountCreated) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *SourceAccountCreated) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceAccountDeleted.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceAccountDeleted.md new file mode 100644 index 000000000..01fb0f40a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceAccountDeleted.md @@ -0,0 +1,206 @@ +--- +id: beta-source-account-deleted +title: SourceAccountDeleted +pagination_label: SourceAccountDeleted +sidebar_label: SourceAccountDeleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountDeleted', 'BetaSourceAccountDeleted'] +slug: /tools/sdk/go/beta/models/source-account-deleted +tags: ['SDK', 'Software Development Kit', 'SourceAccountDeleted', 'BetaSourceAccountDeleted'] +--- + +# SourceAccountDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | **string** | Identity's universal unique identifier (UUID) on the source. The source system generates the UUID. | +**Id** | **string** | SailPoint generated unique identifier. | +**NativeIdentifier** | **string** | Account's unique ID on the source. | +**SourceId** | **string** | Source ID. | +**SourceName** | **string** | Source name. | +**IdentityId** | **string** | ID of the identity correlated with the account. | +**IdentityName** | **string** | Name of the identity correlated with the account. | +**Attributes** | **map[string]interface{}** | Account attributes. The attributes' contents depend on the source's account schema. | + +## Methods + +### NewSourceAccountDeleted + +`func NewSourceAccountDeleted(uuid string, id string, nativeIdentifier string, sourceId string, sourceName string, identityId string, identityName string, attributes map[string]interface{}, ) *SourceAccountDeleted` + +NewSourceAccountDeleted instantiates a new SourceAccountDeleted 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 + +### NewSourceAccountDeletedWithDefaults + +`func NewSourceAccountDeletedWithDefaults() *SourceAccountDeleted` + +NewSourceAccountDeletedWithDefaults instantiates a new SourceAccountDeleted 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 + +### GetUuid + +`func (o *SourceAccountDeleted) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *SourceAccountDeleted) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *SourceAccountDeleted) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + + +### GetId + +`func (o *SourceAccountDeleted) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountDeleted) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountDeleted) SetId(v string)` + +SetId sets Id field to given value. + + +### GetNativeIdentifier + +`func (o *SourceAccountDeleted) GetNativeIdentifier() string` + +GetNativeIdentifier returns the NativeIdentifier field if non-nil, zero value otherwise. + +### GetNativeIdentifierOk + +`func (o *SourceAccountDeleted) GetNativeIdentifierOk() (*string, bool)` + +GetNativeIdentifierOk returns a tuple with the NativeIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentifier + +`func (o *SourceAccountDeleted) SetNativeIdentifier(v string)` + +SetNativeIdentifier sets NativeIdentifier field to given value. + + +### GetSourceId + +`func (o *SourceAccountDeleted) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *SourceAccountDeleted) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *SourceAccountDeleted) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetSourceName + +`func (o *SourceAccountDeleted) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *SourceAccountDeleted) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *SourceAccountDeleted) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### GetIdentityId + +`func (o *SourceAccountDeleted) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *SourceAccountDeleted) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *SourceAccountDeleted) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetIdentityName + +`func (o *SourceAccountDeleted) GetIdentityName() string` + +GetIdentityName returns the IdentityName field if non-nil, zero value otherwise. + +### GetIdentityNameOk + +`func (o *SourceAccountDeleted) GetIdentityNameOk() (*string, bool)` + +GetIdentityNameOk returns a tuple with the IdentityName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityName + +`func (o *SourceAccountDeleted) SetIdentityName(v string)` + +SetIdentityName sets IdentityName field to given value. + + +### GetAttributes + +`func (o *SourceAccountDeleted) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *SourceAccountDeleted) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *SourceAccountDeleted) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceAccountUpdated.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceAccountUpdated.md new file mode 100644 index 000000000..6769f9246 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceAccountUpdated.md @@ -0,0 +1,206 @@ +--- +id: beta-source-account-updated +title: SourceAccountUpdated +pagination_label: SourceAccountUpdated +sidebar_label: SourceAccountUpdated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountUpdated', 'BetaSourceAccountUpdated'] +slug: /tools/sdk/go/beta/models/source-account-updated +tags: ['SDK', 'Software Development Kit', 'SourceAccountUpdated', 'BetaSourceAccountUpdated'] +--- + +# SourceAccountUpdated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | **string** | Identity's universal unique identifier (UUID) on the source. The source system generates the UUID. | +**Id** | **string** | SailPoint generated unique identifier. | +**NativeIdentifier** | **string** | Account's unique ID on the source. | +**SourceId** | **string** | Source ID. | +**SourceName** | **string** | Source name. | +**IdentityId** | **string** | ID of the identity correlated with the account. | +**IdentityName** | **string** | Name of the identity correlated with the account. | +**Attributes** | **map[string]interface{}** | Account attributes. The attributes' contents depend on the source's account schema. | + +## Methods + +### NewSourceAccountUpdated + +`func NewSourceAccountUpdated(uuid string, id string, nativeIdentifier string, sourceId string, sourceName string, identityId string, identityName string, attributes map[string]interface{}, ) *SourceAccountUpdated` + +NewSourceAccountUpdated instantiates a new SourceAccountUpdated 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 + +### NewSourceAccountUpdatedWithDefaults + +`func NewSourceAccountUpdatedWithDefaults() *SourceAccountUpdated` + +NewSourceAccountUpdatedWithDefaults instantiates a new SourceAccountUpdated 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 + +### GetUuid + +`func (o *SourceAccountUpdated) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *SourceAccountUpdated) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *SourceAccountUpdated) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + + +### GetId + +`func (o *SourceAccountUpdated) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountUpdated) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountUpdated) SetId(v string)` + +SetId sets Id field to given value. + + +### GetNativeIdentifier + +`func (o *SourceAccountUpdated) GetNativeIdentifier() string` + +GetNativeIdentifier returns the NativeIdentifier field if non-nil, zero value otherwise. + +### GetNativeIdentifierOk + +`func (o *SourceAccountUpdated) GetNativeIdentifierOk() (*string, bool)` + +GetNativeIdentifierOk returns a tuple with the NativeIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentifier + +`func (o *SourceAccountUpdated) SetNativeIdentifier(v string)` + +SetNativeIdentifier sets NativeIdentifier field to given value. + + +### GetSourceId + +`func (o *SourceAccountUpdated) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *SourceAccountUpdated) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *SourceAccountUpdated) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetSourceName + +`func (o *SourceAccountUpdated) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *SourceAccountUpdated) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *SourceAccountUpdated) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### GetIdentityId + +`func (o *SourceAccountUpdated) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *SourceAccountUpdated) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *SourceAccountUpdated) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetIdentityName + +`func (o *SourceAccountUpdated) GetIdentityName() string` + +GetIdentityName returns the IdentityName field if non-nil, zero value otherwise. + +### GetIdentityNameOk + +`func (o *SourceAccountUpdated) GetIdentityNameOk() (*string, bool)` + +GetIdentityNameOk returns a tuple with the IdentityName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityName + +`func (o *SourceAccountUpdated) SetIdentityName(v string)` + +SetIdentityName sets IdentityName field to given value. + + +### GetAttributes + +`func (o *SourceAccountUpdated) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *SourceAccountUpdated) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *SourceAccountUpdated) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceApp.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceApp.md new file mode 100644 index 000000000..e7ca18b24 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceApp.md @@ -0,0 +1,370 @@ +--- +id: beta-source-app +title: SourceApp +pagination_label: SourceApp +sidebar_label: SourceApp +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceApp', 'BetaSourceApp'] +slug: /tools/sdk/go/beta/models/source-app +tags: ['SDK', 'Software Development Kit', 'SourceApp', 'BetaSourceApp'] +--- + +# SourceApp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The source app id | [optional] +**CloudAppId** | Pointer to **string** | The deprecated source app id | [optional] +**Name** | Pointer to **string** | The source app name | [optional] +**Created** | Pointer to **SailPointTime** | Time when the source app was created | [optional] +**Modified** | Pointer to **SailPointTime** | Time when the source app was last modified | [optional] +**Enabled** | Pointer to **bool** | True if the source app is enabled | [optional] [default to false] +**ProvisionRequestEnabled** | Pointer to **bool** | True if the source app is provision request enabled | [optional] [default to false] +**Description** | Pointer to **string** | The description of the source app | [optional] +**MatchAllAccounts** | Pointer to **bool** | True if the source app match all accounts | [optional] [default to false] +**AppCenterEnabled** | Pointer to **bool** | True if the source app is shown in the app center | [optional] [default to true] +**AccountSource** | Pointer to [**NullableSourceAppAccountSource**](source-app-account-source) | | [optional] +**Owner** | Pointer to [**NullableBaseReferenceDto**](base-reference-dto) | The owner of source app | [optional] + +## Methods + +### NewSourceApp + +`func NewSourceApp() *SourceApp` + +NewSourceApp instantiates a new SourceApp 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 + +### NewSourceAppWithDefaults + +`func NewSourceAppWithDefaults() *SourceApp` + +NewSourceAppWithDefaults instantiates a new SourceApp 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 + +### GetId + +`func (o *SourceApp) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceApp) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceApp) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceApp) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCloudAppId + +`func (o *SourceApp) GetCloudAppId() string` + +GetCloudAppId returns the CloudAppId field if non-nil, zero value otherwise. + +### GetCloudAppIdOk + +`func (o *SourceApp) GetCloudAppIdOk() (*string, bool)` + +GetCloudAppIdOk returns a tuple with the CloudAppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudAppId + +`func (o *SourceApp) SetCloudAppId(v string)` + +SetCloudAppId sets CloudAppId field to given value. + +### HasCloudAppId + +`func (o *SourceApp) HasCloudAppId() bool` + +HasCloudAppId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceApp) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceApp) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceApp) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceApp) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *SourceApp) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SourceApp) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SourceApp) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SourceApp) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SourceApp) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SourceApp) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SourceApp) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SourceApp) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetEnabled + +`func (o *SourceApp) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *SourceApp) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *SourceApp) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *SourceApp) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetProvisionRequestEnabled + +`func (o *SourceApp) GetProvisionRequestEnabled() bool` + +GetProvisionRequestEnabled returns the ProvisionRequestEnabled field if non-nil, zero value otherwise. + +### GetProvisionRequestEnabledOk + +`func (o *SourceApp) GetProvisionRequestEnabledOk() (*bool, bool)` + +GetProvisionRequestEnabledOk returns a tuple with the ProvisionRequestEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionRequestEnabled + +`func (o *SourceApp) SetProvisionRequestEnabled(v bool)` + +SetProvisionRequestEnabled sets ProvisionRequestEnabled field to given value. + +### HasProvisionRequestEnabled + +`func (o *SourceApp) HasProvisionRequestEnabled() bool` + +HasProvisionRequestEnabled returns a boolean if a field has been set. + +### GetDescription + +`func (o *SourceApp) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SourceApp) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SourceApp) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SourceApp) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetMatchAllAccounts + +`func (o *SourceApp) GetMatchAllAccounts() bool` + +GetMatchAllAccounts returns the MatchAllAccounts field if non-nil, zero value otherwise. + +### GetMatchAllAccountsOk + +`func (o *SourceApp) GetMatchAllAccountsOk() (*bool, bool)` + +GetMatchAllAccountsOk returns a tuple with the MatchAllAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAllAccounts + +`func (o *SourceApp) SetMatchAllAccounts(v bool)` + +SetMatchAllAccounts sets MatchAllAccounts field to given value. + +### HasMatchAllAccounts + +`func (o *SourceApp) HasMatchAllAccounts() bool` + +HasMatchAllAccounts returns a boolean if a field has been set. + +### GetAppCenterEnabled + +`func (o *SourceApp) GetAppCenterEnabled() bool` + +GetAppCenterEnabled returns the AppCenterEnabled field if non-nil, zero value otherwise. + +### GetAppCenterEnabledOk + +`func (o *SourceApp) GetAppCenterEnabledOk() (*bool, bool)` + +GetAppCenterEnabledOk returns a tuple with the AppCenterEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppCenterEnabled + +`func (o *SourceApp) SetAppCenterEnabled(v bool)` + +SetAppCenterEnabled sets AppCenterEnabled field to given value. + +### HasAppCenterEnabled + +`func (o *SourceApp) HasAppCenterEnabled() bool` + +HasAppCenterEnabled returns a boolean if a field has been set. + +### GetAccountSource + +`func (o *SourceApp) GetAccountSource() SourceAppAccountSource` + +GetAccountSource returns the AccountSource field if non-nil, zero value otherwise. + +### GetAccountSourceOk + +`func (o *SourceApp) GetAccountSourceOk() (*SourceAppAccountSource, bool)` + +GetAccountSourceOk returns a tuple with the AccountSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSource + +`func (o *SourceApp) SetAccountSource(v SourceAppAccountSource)` + +SetAccountSource sets AccountSource field to given value. + +### HasAccountSource + +`func (o *SourceApp) HasAccountSource() bool` + +HasAccountSource returns a boolean if a field has been set. + +### SetAccountSourceNil + +`func (o *SourceApp) SetAccountSourceNil(b bool)` + + SetAccountSourceNil sets the value for AccountSource to be an explicit nil + +### UnsetAccountSource +`func (o *SourceApp) UnsetAccountSource()` + +UnsetAccountSource ensures that no value is present for AccountSource, not even an explicit nil +### GetOwner + +`func (o *SourceApp) GetOwner() BaseReferenceDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *SourceApp) GetOwnerOk() (*BaseReferenceDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *SourceApp) SetOwner(v BaseReferenceDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *SourceApp) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *SourceApp) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *SourceApp) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceAppAccountSource.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceAppAccountSource.md new file mode 100644 index 000000000..f879c02b8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceAppAccountSource.md @@ -0,0 +1,178 @@ +--- +id: beta-source-app-account-source +title: SourceAppAccountSource +pagination_label: SourceAppAccountSource +sidebar_label: SourceAppAccountSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAppAccountSource', 'BetaSourceAppAccountSource'] +slug: /tools/sdk/go/beta/models/source-app-account-source +tags: ['SDK', 'Software Development Kit', 'SourceAppAccountSource', 'BetaSourceAppAccountSource'] +--- + +# SourceAppAccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The source ID | [optional] +**Type** | Pointer to **string** | The source type, will always be \"SOURCE\" | [optional] +**Name** | Pointer to **string** | The source name | [optional] +**UseForPasswordManagement** | Pointer to **bool** | If the source is used for password management | [optional] [default to false] +**PasswordPolicies** | Pointer to [**[]BaseReferenceDto**](base-reference-dto) | The password policies for the source | [optional] + +## Methods + +### NewSourceAppAccountSource + +`func NewSourceAppAccountSource() *SourceAppAccountSource` + +NewSourceAppAccountSource instantiates a new SourceAppAccountSource 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 + +### NewSourceAppAccountSourceWithDefaults + +`func NewSourceAppAccountSourceWithDefaults() *SourceAppAccountSource` + +NewSourceAppAccountSourceWithDefaults instantiates a new SourceAppAccountSource 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 + +### GetId + +`func (o *SourceAppAccountSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAppAccountSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAppAccountSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceAppAccountSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *SourceAppAccountSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceAppAccountSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceAppAccountSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceAppAccountSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAppAccountSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAppAccountSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAppAccountSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAppAccountSource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetUseForPasswordManagement + +`func (o *SourceAppAccountSource) GetUseForPasswordManagement() bool` + +GetUseForPasswordManagement returns the UseForPasswordManagement field if non-nil, zero value otherwise. + +### GetUseForPasswordManagementOk + +`func (o *SourceAppAccountSource) GetUseForPasswordManagementOk() (*bool, bool)` + +GetUseForPasswordManagementOk returns a tuple with the UseForPasswordManagement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseForPasswordManagement + +`func (o *SourceAppAccountSource) SetUseForPasswordManagement(v bool)` + +SetUseForPasswordManagement sets UseForPasswordManagement field to given value. + +### HasUseForPasswordManagement + +`func (o *SourceAppAccountSource) HasUseForPasswordManagement() bool` + +HasUseForPasswordManagement returns a boolean if a field has been set. + +### GetPasswordPolicies + +`func (o *SourceAppAccountSource) GetPasswordPolicies() []BaseReferenceDto` + +GetPasswordPolicies returns the PasswordPolicies field if non-nil, zero value otherwise. + +### GetPasswordPoliciesOk + +`func (o *SourceAppAccountSource) GetPasswordPoliciesOk() (*[]BaseReferenceDto, bool)` + +GetPasswordPoliciesOk returns a tuple with the PasswordPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicies + +`func (o *SourceAppAccountSource) SetPasswordPolicies(v []BaseReferenceDto)` + +SetPasswordPolicies sets PasswordPolicies field to given value. + +### HasPasswordPolicies + +`func (o *SourceAppAccountSource) HasPasswordPolicies() bool` + +HasPasswordPolicies returns a boolean if a field has been set. + +### SetPasswordPoliciesNil + +`func (o *SourceAppAccountSource) SetPasswordPoliciesNil(b bool)` + + SetPasswordPoliciesNil sets the value for PasswordPolicies to be an explicit nil + +### UnsetPasswordPolicies +`func (o *SourceAppAccountSource) UnsetPasswordPolicies()` + +UnsetPasswordPolicies ensures that no value is present for PasswordPolicies, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceAppBulkUpdateRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceAppBulkUpdateRequest.md new file mode 100644 index 000000000..81a9b7937 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceAppBulkUpdateRequest.md @@ -0,0 +1,80 @@ +--- +id: beta-source-app-bulk-update-request +title: SourceAppBulkUpdateRequest +pagination_label: SourceAppBulkUpdateRequest +sidebar_label: SourceAppBulkUpdateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAppBulkUpdateRequest', 'BetaSourceAppBulkUpdateRequest'] +slug: /tools/sdk/go/beta/models/source-app-bulk-update-request +tags: ['SDK', 'Software Development Kit', 'SourceAppBulkUpdateRequest', 'BetaSourceAppBulkUpdateRequest'] +--- + +# SourceAppBulkUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AppIds** | **[]string** | List of source app ids to update | +**JsonPatch** | [**[]JsonPatchOperation**](json-patch-operation) | The JSONPatch payload used to update the source app. | + +## Methods + +### NewSourceAppBulkUpdateRequest + +`func NewSourceAppBulkUpdateRequest(appIds []string, jsonPatch []JsonPatchOperation, ) *SourceAppBulkUpdateRequest` + +NewSourceAppBulkUpdateRequest instantiates a new SourceAppBulkUpdateRequest 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 + +### NewSourceAppBulkUpdateRequestWithDefaults + +`func NewSourceAppBulkUpdateRequestWithDefaults() *SourceAppBulkUpdateRequest` + +NewSourceAppBulkUpdateRequestWithDefaults instantiates a new SourceAppBulkUpdateRequest 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 + +### GetAppIds + +`func (o *SourceAppBulkUpdateRequest) GetAppIds() []string` + +GetAppIds returns the AppIds field if non-nil, zero value otherwise. + +### GetAppIdsOk + +`func (o *SourceAppBulkUpdateRequest) GetAppIdsOk() (*[]string, bool)` + +GetAppIdsOk returns a tuple with the AppIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppIds + +`func (o *SourceAppBulkUpdateRequest) SetAppIds(v []string)` + +SetAppIds sets AppIds field to given value. + + +### GetJsonPatch + +`func (o *SourceAppBulkUpdateRequest) GetJsonPatch() []JsonPatchOperation` + +GetJsonPatch returns the JsonPatch field if non-nil, zero value otherwise. + +### GetJsonPatchOk + +`func (o *SourceAppBulkUpdateRequest) GetJsonPatchOk() (*[]JsonPatchOperation, bool)` + +GetJsonPatchOk returns a tuple with the JsonPatch field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJsonPatch + +`func (o *SourceAppBulkUpdateRequest) SetJsonPatch(v []JsonPatchOperation)` + +SetJsonPatch sets JsonPatch field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceAppCreateDto.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceAppCreateDto.md new file mode 100644 index 000000000..ca9e97c8b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceAppCreateDto.md @@ -0,0 +1,127 @@ +--- +id: beta-source-app-create-dto +title: SourceAppCreateDto +pagination_label: SourceAppCreateDto +sidebar_label: SourceAppCreateDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAppCreateDto', 'BetaSourceAppCreateDto'] +slug: /tools/sdk/go/beta/models/source-app-create-dto +tags: ['SDK', 'Software Development Kit', 'SourceAppCreateDto', 'BetaSourceAppCreateDto'] +--- + +# SourceAppCreateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The source app name | +**Description** | **string** | The description of the source app | +**MatchAllAccounts** | Pointer to **bool** | True if the source app match all accounts | [optional] [default to false] +**AccountSource** | [**SourceAppCreateDtoAccountSource**](source-app-create-dto-account-source) | | + +## Methods + +### NewSourceAppCreateDto + +`func NewSourceAppCreateDto(name string, description string, accountSource SourceAppCreateDtoAccountSource, ) *SourceAppCreateDto` + +NewSourceAppCreateDto instantiates a new SourceAppCreateDto 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 + +### NewSourceAppCreateDtoWithDefaults + +`func NewSourceAppCreateDtoWithDefaults() *SourceAppCreateDto` + +NewSourceAppCreateDtoWithDefaults instantiates a new SourceAppCreateDto 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 + +### GetName + +`func (o *SourceAppCreateDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAppCreateDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAppCreateDto) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *SourceAppCreateDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SourceAppCreateDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SourceAppCreateDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetMatchAllAccounts + +`func (o *SourceAppCreateDto) GetMatchAllAccounts() bool` + +GetMatchAllAccounts returns the MatchAllAccounts field if non-nil, zero value otherwise. + +### GetMatchAllAccountsOk + +`func (o *SourceAppCreateDto) GetMatchAllAccountsOk() (*bool, bool)` + +GetMatchAllAccountsOk returns a tuple with the MatchAllAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAllAccounts + +`func (o *SourceAppCreateDto) SetMatchAllAccounts(v bool)` + +SetMatchAllAccounts sets MatchAllAccounts field to given value. + +### HasMatchAllAccounts + +`func (o *SourceAppCreateDto) HasMatchAllAccounts() bool` + +HasMatchAllAccounts returns a boolean if a field has been set. + +### GetAccountSource + +`func (o *SourceAppCreateDto) GetAccountSource() SourceAppCreateDtoAccountSource` + +GetAccountSource returns the AccountSource field if non-nil, zero value otherwise. + +### GetAccountSourceOk + +`func (o *SourceAppCreateDto) GetAccountSourceOk() (*SourceAppCreateDtoAccountSource, bool)` + +GetAccountSourceOk returns a tuple with the AccountSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSource + +`func (o *SourceAppCreateDto) SetAccountSource(v SourceAppCreateDtoAccountSource)` + +SetAccountSource sets AccountSource field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceAppCreateDtoAccountSource.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceAppCreateDtoAccountSource.md new file mode 100644 index 000000000..6cee721de --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceAppCreateDtoAccountSource.md @@ -0,0 +1,111 @@ +--- +id: beta-source-app-create-dto-account-source +title: SourceAppCreateDtoAccountSource +pagination_label: SourceAppCreateDtoAccountSource +sidebar_label: SourceAppCreateDtoAccountSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAppCreateDtoAccountSource', 'BetaSourceAppCreateDtoAccountSource'] +slug: /tools/sdk/go/beta/models/source-app-create-dto-account-source +tags: ['SDK', 'Software Development Kit', 'SourceAppCreateDtoAccountSource', 'BetaSourceAppCreateDtoAccountSource'] +--- + +# SourceAppCreateDtoAccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The source ID | +**Type** | Pointer to **string** | The source type, will always be \"SOURCE\" | [optional] +**Name** | Pointer to **string** | The source name | [optional] + +## Methods + +### NewSourceAppCreateDtoAccountSource + +`func NewSourceAppCreateDtoAccountSource(id string, ) *SourceAppCreateDtoAccountSource` + +NewSourceAppCreateDtoAccountSource instantiates a new SourceAppCreateDtoAccountSource 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 + +### NewSourceAppCreateDtoAccountSourceWithDefaults + +`func NewSourceAppCreateDtoAccountSourceWithDefaults() *SourceAppCreateDtoAccountSource` + +NewSourceAppCreateDtoAccountSourceWithDefaults instantiates a new SourceAppCreateDtoAccountSource 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 + +### GetId + +`func (o *SourceAppCreateDtoAccountSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAppCreateDtoAccountSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAppCreateDtoAccountSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *SourceAppCreateDtoAccountSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceAppCreateDtoAccountSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceAppCreateDtoAccountSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceAppCreateDtoAccountSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAppCreateDtoAccountSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAppCreateDtoAccountSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAppCreateDtoAccountSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAppCreateDtoAccountSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceAppPatchDto.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceAppPatchDto.md new file mode 100644 index 000000000..6b4a26b10 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceAppPatchDto.md @@ -0,0 +1,406 @@ +--- +id: beta-source-app-patch-dto +title: SourceAppPatchDto +pagination_label: SourceAppPatchDto +sidebar_label: SourceAppPatchDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAppPatchDto', 'BetaSourceAppPatchDto'] +slug: /tools/sdk/go/beta/models/source-app-patch-dto +tags: ['SDK', 'Software Development Kit', 'SourceAppPatchDto', 'BetaSourceAppPatchDto'] +--- + +# SourceAppPatchDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The source app id | [optional] +**CloudAppId** | Pointer to **string** | The deprecated source app id | [optional] +**Name** | Pointer to **string** | The source app name | [optional] +**Created** | Pointer to **SailPointTime** | Time when the source app was created | [optional] +**Modified** | Pointer to **SailPointTime** | Time when the source app was last modified | [optional] +**Enabled** | Pointer to **bool** | True if the source app is enabled | [optional] [default to false] +**ProvisionRequestEnabled** | Pointer to **bool** | True if the source app is provision request enabled | [optional] [default to false] +**Description** | Pointer to **string** | The description of the source app | [optional] +**MatchAllAccounts** | Pointer to **bool** | True if the source app match all accounts | [optional] [default to false] +**AppCenterEnabled** | Pointer to **bool** | True if the source app is shown in the app center | [optional] [default to true] +**AccessProfiles** | Pointer to **[]string** | List of IDs of access profiles | [optional] +**AccountSource** | Pointer to [**NullableSourceAppAccountSource**](source-app-account-source) | | [optional] +**Owner** | Pointer to [**NullableBaseReferenceDto**](base-reference-dto) | The owner of source app | [optional] + +## Methods + +### NewSourceAppPatchDto + +`func NewSourceAppPatchDto() *SourceAppPatchDto` + +NewSourceAppPatchDto instantiates a new SourceAppPatchDto 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 + +### NewSourceAppPatchDtoWithDefaults + +`func NewSourceAppPatchDtoWithDefaults() *SourceAppPatchDto` + +NewSourceAppPatchDtoWithDefaults instantiates a new SourceAppPatchDto 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 + +### GetId + +`func (o *SourceAppPatchDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAppPatchDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAppPatchDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceAppPatchDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCloudAppId + +`func (o *SourceAppPatchDto) GetCloudAppId() string` + +GetCloudAppId returns the CloudAppId field if non-nil, zero value otherwise. + +### GetCloudAppIdOk + +`func (o *SourceAppPatchDto) GetCloudAppIdOk() (*string, bool)` + +GetCloudAppIdOk returns a tuple with the CloudAppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudAppId + +`func (o *SourceAppPatchDto) SetCloudAppId(v string)` + +SetCloudAppId sets CloudAppId field to given value. + +### HasCloudAppId + +`func (o *SourceAppPatchDto) HasCloudAppId() bool` + +HasCloudAppId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAppPatchDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAppPatchDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAppPatchDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAppPatchDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *SourceAppPatchDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SourceAppPatchDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SourceAppPatchDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SourceAppPatchDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SourceAppPatchDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SourceAppPatchDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SourceAppPatchDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SourceAppPatchDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetEnabled + +`func (o *SourceAppPatchDto) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *SourceAppPatchDto) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *SourceAppPatchDto) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *SourceAppPatchDto) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetProvisionRequestEnabled + +`func (o *SourceAppPatchDto) GetProvisionRequestEnabled() bool` + +GetProvisionRequestEnabled returns the ProvisionRequestEnabled field if non-nil, zero value otherwise. + +### GetProvisionRequestEnabledOk + +`func (o *SourceAppPatchDto) GetProvisionRequestEnabledOk() (*bool, bool)` + +GetProvisionRequestEnabledOk returns a tuple with the ProvisionRequestEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionRequestEnabled + +`func (o *SourceAppPatchDto) SetProvisionRequestEnabled(v bool)` + +SetProvisionRequestEnabled sets ProvisionRequestEnabled field to given value. + +### HasProvisionRequestEnabled + +`func (o *SourceAppPatchDto) HasProvisionRequestEnabled() bool` + +HasProvisionRequestEnabled returns a boolean if a field has been set. + +### GetDescription + +`func (o *SourceAppPatchDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SourceAppPatchDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SourceAppPatchDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SourceAppPatchDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetMatchAllAccounts + +`func (o *SourceAppPatchDto) GetMatchAllAccounts() bool` + +GetMatchAllAccounts returns the MatchAllAccounts field if non-nil, zero value otherwise. + +### GetMatchAllAccountsOk + +`func (o *SourceAppPatchDto) GetMatchAllAccountsOk() (*bool, bool)` + +GetMatchAllAccountsOk returns a tuple with the MatchAllAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAllAccounts + +`func (o *SourceAppPatchDto) SetMatchAllAccounts(v bool)` + +SetMatchAllAccounts sets MatchAllAccounts field to given value. + +### HasMatchAllAccounts + +`func (o *SourceAppPatchDto) HasMatchAllAccounts() bool` + +HasMatchAllAccounts returns a boolean if a field has been set. + +### GetAppCenterEnabled + +`func (o *SourceAppPatchDto) GetAppCenterEnabled() bool` + +GetAppCenterEnabled returns the AppCenterEnabled field if non-nil, zero value otherwise. + +### GetAppCenterEnabledOk + +`func (o *SourceAppPatchDto) GetAppCenterEnabledOk() (*bool, bool)` + +GetAppCenterEnabledOk returns a tuple with the AppCenterEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppCenterEnabled + +`func (o *SourceAppPatchDto) SetAppCenterEnabled(v bool)` + +SetAppCenterEnabled sets AppCenterEnabled field to given value. + +### HasAppCenterEnabled + +`func (o *SourceAppPatchDto) HasAppCenterEnabled() bool` + +HasAppCenterEnabled returns a boolean if a field has been set. + +### GetAccessProfiles + +`func (o *SourceAppPatchDto) GetAccessProfiles() []string` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *SourceAppPatchDto) GetAccessProfilesOk() (*[]string, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *SourceAppPatchDto) SetAccessProfiles(v []string)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *SourceAppPatchDto) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### SetAccessProfilesNil + +`func (o *SourceAppPatchDto) SetAccessProfilesNil(b bool)` + + SetAccessProfilesNil sets the value for AccessProfiles to be an explicit nil + +### UnsetAccessProfiles +`func (o *SourceAppPatchDto) UnsetAccessProfiles()` + +UnsetAccessProfiles ensures that no value is present for AccessProfiles, not even an explicit nil +### GetAccountSource + +`func (o *SourceAppPatchDto) GetAccountSource() SourceAppAccountSource` + +GetAccountSource returns the AccountSource field if non-nil, zero value otherwise. + +### GetAccountSourceOk + +`func (o *SourceAppPatchDto) GetAccountSourceOk() (*SourceAppAccountSource, bool)` + +GetAccountSourceOk returns a tuple with the AccountSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSource + +`func (o *SourceAppPatchDto) SetAccountSource(v SourceAppAccountSource)` + +SetAccountSource sets AccountSource field to given value. + +### HasAccountSource + +`func (o *SourceAppPatchDto) HasAccountSource() bool` + +HasAccountSource returns a boolean if a field has been set. + +### SetAccountSourceNil + +`func (o *SourceAppPatchDto) SetAccountSourceNil(b bool)` + + SetAccountSourceNil sets the value for AccountSource to be an explicit nil + +### UnsetAccountSource +`func (o *SourceAppPatchDto) UnsetAccountSource()` + +UnsetAccountSource ensures that no value is present for AccountSource, not even an explicit nil +### GetOwner + +`func (o *SourceAppPatchDto) GetOwner() BaseReferenceDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *SourceAppPatchDto) GetOwnerOk() (*BaseReferenceDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *SourceAppPatchDto) SetOwner(v BaseReferenceDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *SourceAppPatchDto) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *SourceAppPatchDto) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *SourceAppPatchDto) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceClusterDto.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceClusterDto.md new file mode 100644 index 000000000..9a333bfcc --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceClusterDto.md @@ -0,0 +1,116 @@ +--- +id: beta-source-cluster-dto +title: SourceClusterDto +pagination_label: SourceClusterDto +sidebar_label: SourceClusterDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceClusterDto', 'BetaSourceClusterDto'] +slug: /tools/sdk/go/beta/models/source-cluster-dto +tags: ['SDK', 'Software Development Kit', 'SourceClusterDto', 'BetaSourceClusterDto'] +--- + +# SourceClusterDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Source cluster DTO type. | [optional] +**Id** | Pointer to **string** | Source cluster ID. | [optional] +**Name** | Pointer to **string** | Source cluster display name. | [optional] + +## Methods + +### NewSourceClusterDto + +`func NewSourceClusterDto() *SourceClusterDto` + +NewSourceClusterDto instantiates a new SourceClusterDto 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 + +### NewSourceClusterDtoWithDefaults + +`func NewSourceClusterDtoWithDefaults() *SourceClusterDto` + +NewSourceClusterDtoWithDefaults instantiates a new SourceClusterDto 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 + +### GetType + +`func (o *SourceClusterDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceClusterDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceClusterDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceClusterDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceClusterDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceClusterDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceClusterDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceClusterDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceClusterDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceClusterDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceClusterDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceClusterDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceCode.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceCode.md new file mode 100644 index 000000000..d89f396f8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceCode.md @@ -0,0 +1,80 @@ +--- +id: beta-source-code +title: SourceCode +pagination_label: SourceCode +sidebar_label: SourceCode +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceCode', 'BetaSourceCode'] +slug: /tools/sdk/go/beta/models/source-code +tags: ['SDK', 'Software Development Kit', 'SourceCode', 'BetaSourceCode'] +--- + +# SourceCode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | **string** | the version of the code | +**Script** | **string** | The code | + +## Methods + +### NewSourceCode + +`func NewSourceCode(version string, script string, ) *SourceCode` + +NewSourceCode instantiates a new SourceCode 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 + +### NewSourceCodeWithDefaults + +`func NewSourceCodeWithDefaults() *SourceCode` + +NewSourceCodeWithDefaults instantiates a new SourceCode 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 + +### GetVersion + +`func (o *SourceCode) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *SourceCode) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *SourceCode) SetVersion(v string)` + +SetVersion sets Version field to given value. + + +### GetScript + +`func (o *SourceCode) GetScript() string` + +GetScript returns the Script field if non-nil, zero value otherwise. + +### GetScriptOk + +`func (o *SourceCode) GetScriptOk() (*string, bool)` + +GetScriptOk returns a tuple with the Script field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScript + +`func (o *SourceCode) SetScript(v string)` + +SetScript sets Script field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceCreated.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceCreated.md new file mode 100644 index 000000000..90df33790 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceCreated.md @@ -0,0 +1,164 @@ +--- +id: beta-source-created +title: SourceCreated +pagination_label: SourceCreated +sidebar_label: SourceCreated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceCreated', 'BetaSourceCreated'] +slug: /tools/sdk/go/beta/models/source-created +tags: ['SDK', 'Software Development Kit', 'SourceCreated', 'BetaSourceCreated'] +--- + +# SourceCreated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Source's unique ID. | +**Name** | **string** | Source name. | +**Type** | **string** | Connection type. | +**Created** | **SailPointTime** | Date and time when the source was created. | +**Connector** | **string** | Connector type used to connect to the source. | +**Actor** | [**SourceCreatedActor**](source-created-actor) | | + +## Methods + +### NewSourceCreated + +`func NewSourceCreated(id string, name string, type_ string, created SailPointTime, connector string, actor SourceCreatedActor, ) *SourceCreated` + +NewSourceCreated instantiates a new SourceCreated 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 + +### NewSourceCreatedWithDefaults + +`func NewSourceCreatedWithDefaults() *SourceCreated` + +NewSourceCreatedWithDefaults instantiates a new SourceCreated 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 + +### GetId + +`func (o *SourceCreated) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceCreated) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceCreated) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceCreated) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceCreated) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceCreated) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *SourceCreated) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceCreated) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceCreated) SetType(v string)` + +SetType sets Type field to given value. + + +### GetCreated + +`func (o *SourceCreated) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SourceCreated) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SourceCreated) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetConnector + +`func (o *SourceCreated) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *SourceCreated) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *SourceCreated) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetActor + +`func (o *SourceCreated) GetActor() SourceCreatedActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *SourceCreated) GetActorOk() (*SourceCreatedActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *SourceCreated) SetActor(v SourceCreatedActor)` + +SetActor sets Actor field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceCreatedActor.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceCreatedActor.md new file mode 100644 index 000000000..1c0693d69 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceCreatedActor.md @@ -0,0 +1,101 @@ +--- +id: beta-source-created-actor +title: SourceCreatedActor +pagination_label: SourceCreatedActor +sidebar_label: SourceCreatedActor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceCreatedActor', 'BetaSourceCreatedActor'] +slug: /tools/sdk/go/beta/models/source-created-actor +tags: ['SDK', 'Software Development Kit', 'SourceCreatedActor', 'BetaSourceCreatedActor'] +--- + +# SourceCreatedActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of the identity who created the source. | +**Id** | **string** | ID of the identity who created the source. | +**Name** | **string** | Name of the identity who created the source. | + +## Methods + +### NewSourceCreatedActor + +`func NewSourceCreatedActor(type_ string, id string, name string, ) *SourceCreatedActor` + +NewSourceCreatedActor instantiates a new SourceCreatedActor 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 + +### NewSourceCreatedActorWithDefaults + +`func NewSourceCreatedActorWithDefaults() *SourceCreatedActor` + +NewSourceCreatedActorWithDefaults instantiates a new SourceCreatedActor 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 + +### GetType + +`func (o *SourceCreatedActor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceCreatedActor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceCreatedActor) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *SourceCreatedActor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceCreatedActor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceCreatedActor) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceCreatedActor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceCreatedActor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceCreatedActor) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceCreationErrors.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceCreationErrors.md new file mode 100644 index 000000000..dd8a01324 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceCreationErrors.md @@ -0,0 +1,204 @@ +--- +id: beta-source-creation-errors +title: SourceCreationErrors +pagination_label: SourceCreationErrors +sidebar_label: SourceCreationErrors +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceCreationErrors', 'BetaSourceCreationErrors'] +slug: /tools/sdk/go/beta/models/source-creation-errors +tags: ['SDK', 'Software Development Kit', 'SourceCreationErrors', 'BetaSourceCreationErrors'] +--- + +# SourceCreationErrors + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MultihostId** | Pointer to **string** | Multi-Host Integration ID. | [optional] [readonly] +**SourceName** | Pointer to **string** | Source's human-readable name. | [optional] +**SourceError** | Pointer to **string** | Source's human-readable description. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date-time when the source was last modified. | [optional] +**Operation** | Pointer to **NullableString** | operation category (e.g. DELETE). | [optional] + +## Methods + +### NewSourceCreationErrors + +`func NewSourceCreationErrors() *SourceCreationErrors` + +NewSourceCreationErrors instantiates a new SourceCreationErrors 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 + +### NewSourceCreationErrorsWithDefaults + +`func NewSourceCreationErrorsWithDefaults() *SourceCreationErrors` + +NewSourceCreationErrorsWithDefaults instantiates a new SourceCreationErrors 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 + +### GetMultihostId + +`func (o *SourceCreationErrors) GetMultihostId() string` + +GetMultihostId returns the MultihostId field if non-nil, zero value otherwise. + +### GetMultihostIdOk + +`func (o *SourceCreationErrors) GetMultihostIdOk() (*string, bool)` + +GetMultihostIdOk returns a tuple with the MultihostId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultihostId + +`func (o *SourceCreationErrors) SetMultihostId(v string)` + +SetMultihostId sets MultihostId field to given value. + +### HasMultihostId + +`func (o *SourceCreationErrors) HasMultihostId() bool` + +HasMultihostId returns a boolean if a field has been set. + +### GetSourceName + +`func (o *SourceCreationErrors) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *SourceCreationErrors) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *SourceCreationErrors) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *SourceCreationErrors) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceError + +`func (o *SourceCreationErrors) GetSourceError() string` + +GetSourceError returns the SourceError field if non-nil, zero value otherwise. + +### GetSourceErrorOk + +`func (o *SourceCreationErrors) GetSourceErrorOk() (*string, bool)` + +GetSourceErrorOk returns a tuple with the SourceError field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceError + +`func (o *SourceCreationErrors) SetSourceError(v string)` + +SetSourceError sets SourceError field to given value. + +### HasSourceError + +`func (o *SourceCreationErrors) HasSourceError() bool` + +HasSourceError returns a boolean if a field has been set. + +### GetCreated + +`func (o *SourceCreationErrors) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SourceCreationErrors) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SourceCreationErrors) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SourceCreationErrors) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SourceCreationErrors) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SourceCreationErrors) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SourceCreationErrors) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SourceCreationErrors) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetOperation + +`func (o *SourceCreationErrors) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *SourceCreationErrors) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *SourceCreationErrors) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *SourceCreationErrors) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### SetOperationNil + +`func (o *SourceCreationErrors) SetOperationNil(b bool)` + + SetOperationNil sets the value for Operation to be an explicit nil + +### UnsetOperation +`func (o *SourceCreationErrors) UnsetOperation()` + +UnsetOperation ensures that no value is present for Operation, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceDeleted.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceDeleted.md new file mode 100644 index 000000000..61aee9898 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceDeleted.md @@ -0,0 +1,164 @@ +--- +id: beta-source-deleted +title: SourceDeleted +pagination_label: SourceDeleted +sidebar_label: SourceDeleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceDeleted', 'BetaSourceDeleted'] +slug: /tools/sdk/go/beta/models/source-deleted +tags: ['SDK', 'Software Development Kit', 'SourceDeleted', 'BetaSourceDeleted'] +--- + +# SourceDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Source's unique ID. | +**Name** | **string** | Source name. | +**Type** | **string** | Connection type. | +**Deleted** | **SailPointTime** | Date and time when the source was deleted. | +**Connector** | **string** | Connector type used to connect to the source. | +**Actor** | [**SourceDeletedActor**](source-deleted-actor) | | + +## Methods + +### NewSourceDeleted + +`func NewSourceDeleted(id string, name string, type_ string, deleted SailPointTime, connector string, actor SourceDeletedActor, ) *SourceDeleted` + +NewSourceDeleted instantiates a new SourceDeleted 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 + +### NewSourceDeletedWithDefaults + +`func NewSourceDeletedWithDefaults() *SourceDeleted` + +NewSourceDeletedWithDefaults instantiates a new SourceDeleted 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 + +### GetId + +`func (o *SourceDeleted) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceDeleted) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceDeleted) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceDeleted) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceDeleted) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceDeleted) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *SourceDeleted) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceDeleted) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceDeleted) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDeleted + +`func (o *SourceDeleted) GetDeleted() SailPointTime` + +GetDeleted returns the Deleted field if non-nil, zero value otherwise. + +### GetDeletedOk + +`func (o *SourceDeleted) GetDeletedOk() (*SailPointTime, bool)` + +GetDeletedOk returns a tuple with the Deleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleted + +`func (o *SourceDeleted) SetDeleted(v SailPointTime)` + +SetDeleted sets Deleted field to given value. + + +### GetConnector + +`func (o *SourceDeleted) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *SourceDeleted) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *SourceDeleted) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetActor + +`func (o *SourceDeleted) GetActor() SourceDeletedActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *SourceDeleted) GetActorOk() (*SourceDeletedActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *SourceDeleted) SetActor(v SourceDeletedActor)` + +SetActor sets Actor field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceDeletedActor.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceDeletedActor.md new file mode 100644 index 000000000..6a8cef32f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceDeletedActor.md @@ -0,0 +1,101 @@ +--- +id: beta-source-deleted-actor +title: SourceDeletedActor +pagination_label: SourceDeletedActor +sidebar_label: SourceDeletedActor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceDeletedActor', 'BetaSourceDeletedActor'] +slug: /tools/sdk/go/beta/models/source-deleted-actor +tags: ['SDK', 'Software Development Kit', 'SourceDeletedActor', 'BetaSourceDeletedActor'] +--- + +# SourceDeletedActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of the identity who deleted the source. | +**Id** | **string** | ID of the identity who deleted the source. | +**Name** | **string** | Name of the identity who deleted the source. | + +## Methods + +### NewSourceDeletedActor + +`func NewSourceDeletedActor(type_ string, id string, name string, ) *SourceDeletedActor` + +NewSourceDeletedActor instantiates a new SourceDeletedActor 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 + +### NewSourceDeletedActorWithDefaults + +`func NewSourceDeletedActorWithDefaults() *SourceDeletedActor` + +NewSourceDeletedActorWithDefaults instantiates a new SourceDeletedActor 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 + +### GetType + +`func (o *SourceDeletedActor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceDeletedActor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceDeletedActor) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *SourceDeletedActor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceDeletedActor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceDeletedActor) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceDeletedActor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceDeletedActor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceDeletedActor) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceEntitlementRequestConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceEntitlementRequestConfig.md new file mode 100644 index 000000000..61057b293 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceEntitlementRequestConfig.md @@ -0,0 +1,64 @@ +--- +id: beta-source-entitlement-request-config +title: SourceEntitlementRequestConfig +pagination_label: SourceEntitlementRequestConfig +sidebar_label: SourceEntitlementRequestConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceEntitlementRequestConfig', 'BetaSourceEntitlementRequestConfig'] +slug: /tools/sdk/go/beta/models/source-entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'SourceEntitlementRequestConfig', 'BetaSourceEntitlementRequestConfig'] +--- + +# SourceEntitlementRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestConfig** | Pointer to [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] + +## Methods + +### NewSourceEntitlementRequestConfig + +`func NewSourceEntitlementRequestConfig() *SourceEntitlementRequestConfig` + +NewSourceEntitlementRequestConfig instantiates a new SourceEntitlementRequestConfig 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 + +### NewSourceEntitlementRequestConfigWithDefaults + +`func NewSourceEntitlementRequestConfigWithDefaults() *SourceEntitlementRequestConfig` + +NewSourceEntitlementRequestConfigWithDefaults instantiates a new SourceEntitlementRequestConfig 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 + +### GetAccessRequestConfig + +`func (o *SourceEntitlementRequestConfig) GetAccessRequestConfig() EntitlementAccessRequestConfig` + +GetAccessRequestConfig returns the AccessRequestConfig field if non-nil, zero value otherwise. + +### GetAccessRequestConfigOk + +`func (o *SourceEntitlementRequestConfig) GetAccessRequestConfigOk() (*EntitlementAccessRequestConfig, bool)` + +GetAccessRequestConfigOk returns a tuple with the AccessRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestConfig + +`func (o *SourceEntitlementRequestConfig) SetAccessRequestConfig(v EntitlementAccessRequestConfig)` + +SetAccessRequestConfig sets AccessRequestConfig field to given value. + +### HasAccessRequestConfig + +`func (o *SourceEntitlementRequestConfig) HasAccessRequestConfig() bool` + +HasAccessRequestConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceItemRef.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceItemRef.md new file mode 100644 index 000000000..d7a4b20c8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceItemRef.md @@ -0,0 +1,110 @@ +--- +id: beta-source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceItemRef', 'BetaSourceItemRef'] +slug: /tools/sdk/go/beta/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'BetaSourceItemRef'] +--- + +# SourceItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | Pointer to **NullableString** | The id for the source on which account selections are made | [optional] +**Accounts** | Pointer to [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] + +## Methods + +### NewSourceItemRef + +`func NewSourceItemRef() *SourceItemRef` + +NewSourceItemRef instantiates a new SourceItemRef 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 + +### NewSourceItemRefWithDefaults + +`func NewSourceItemRefWithDefaults() *SourceItemRef` + +NewSourceItemRefWithDefaults instantiates a new SourceItemRef 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 + +### GetSourceId + +`func (o *SourceItemRef) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *SourceItemRef) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *SourceItemRef) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *SourceItemRef) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### SetSourceIdNil + +`func (o *SourceItemRef) SetSourceIdNil(b bool)` + + SetSourceIdNil sets the value for SourceId to be an explicit nil + +### UnsetSourceId +`func (o *SourceItemRef) UnsetSourceId()` + +UnsetSourceId ensures that no value is present for SourceId, not even an explicit nil +### GetAccounts + +`func (o *SourceItemRef) GetAccounts() []AccountItemRef` + +GetAccounts returns the Accounts field if non-nil, zero value otherwise. + +### GetAccountsOk + +`func (o *SourceItemRef) GetAccountsOk() (*[]AccountItemRef, bool)` + +GetAccountsOk returns a tuple with the Accounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccounts + +`func (o *SourceItemRef) SetAccounts(v []AccountItemRef)` + +SetAccounts sets Accounts field to given value. + +### HasAccounts + +`func (o *SourceItemRef) HasAccounts() bool` + +HasAccounts returns a boolean if a field has been set. + +### SetAccountsNil + +`func (o *SourceItemRef) SetAccountsNil(b bool)` + + SetAccountsNil sets the value for Accounts to be an explicit nil + +### UnsetAccounts +`func (o *SourceItemRef) UnsetAccounts()` + +UnsetAccounts ensures that no value is present for Accounts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceSyncJob.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceSyncJob.md new file mode 100644 index 000000000..dd2b53e9f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceSyncJob.md @@ -0,0 +1,101 @@ +--- +id: beta-source-sync-job +title: SourceSyncJob +pagination_label: SourceSyncJob +sidebar_label: SourceSyncJob +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceSyncJob', 'BetaSourceSyncJob'] +slug: /tools/sdk/go/beta/models/source-sync-job +tags: ['SDK', 'Software Development Kit', 'SourceSyncJob', 'BetaSourceSyncJob'] +--- + +# SourceSyncJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Job ID. | +**Status** | **string** | The job status. | +**Payload** | [**SourceSyncPayload**](source-sync-payload) | | + +## Methods + +### NewSourceSyncJob + +`func NewSourceSyncJob(id string, status string, payload SourceSyncPayload, ) *SourceSyncJob` + +NewSourceSyncJob instantiates a new SourceSyncJob 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 + +### NewSourceSyncJobWithDefaults + +`func NewSourceSyncJobWithDefaults() *SourceSyncJob` + +NewSourceSyncJobWithDefaults instantiates a new SourceSyncJob 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 + +### GetId + +`func (o *SourceSyncJob) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceSyncJob) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceSyncJob) SetId(v string)` + +SetId sets Id field to given value. + + +### GetStatus + +`func (o *SourceSyncJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SourceSyncJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SourceSyncJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetPayload + +`func (o *SourceSyncJob) GetPayload() SourceSyncPayload` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *SourceSyncJob) GetPayloadOk() (*SourceSyncPayload, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPayload + +`func (o *SourceSyncJob) SetPayload(v SourceSyncPayload)` + +SetPayload sets Payload field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceSyncPayload.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceSyncPayload.md new file mode 100644 index 000000000..424c997e2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceSyncPayload.md @@ -0,0 +1,80 @@ +--- +id: beta-source-sync-payload +title: SourceSyncPayload +pagination_label: SourceSyncPayload +sidebar_label: SourceSyncPayload +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceSyncPayload', 'BetaSourceSyncPayload'] +slug: /tools/sdk/go/beta/models/source-sync-payload +tags: ['SDK', 'Software Development Kit', 'SourceSyncPayload', 'BetaSourceSyncPayload'] +--- + +# SourceSyncPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Payload type. | +**DataJson** | **string** | Payload type. | + +## Methods + +### NewSourceSyncPayload + +`func NewSourceSyncPayload(type_ string, dataJson string, ) *SourceSyncPayload` + +NewSourceSyncPayload instantiates a new SourceSyncPayload 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 + +### NewSourceSyncPayloadWithDefaults + +`func NewSourceSyncPayloadWithDefaults() *SourceSyncPayload` + +NewSourceSyncPayloadWithDefaults instantiates a new SourceSyncPayload 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 + +### GetType + +`func (o *SourceSyncPayload) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceSyncPayload) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceSyncPayload) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDataJson + +`func (o *SourceSyncPayload) GetDataJson() string` + +GetDataJson returns the DataJson field if non-nil, zero value otherwise. + +### GetDataJsonOk + +`func (o *SourceSyncPayload) GetDataJsonOk() (*string, bool)` + +GetDataJsonOk returns a tuple with the DataJson field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataJson + +`func (o *SourceSyncPayload) SetDataJson(v string)` + +SetDataJson sets DataJson field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceUpdated.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceUpdated.md new file mode 100644 index 000000000..71d2cc5e2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceUpdated.md @@ -0,0 +1,164 @@ +--- +id: beta-source-updated +title: SourceUpdated +pagination_label: SourceUpdated +sidebar_label: SourceUpdated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUpdated', 'BetaSourceUpdated'] +slug: /tools/sdk/go/beta/models/source-updated +tags: ['SDK', 'Software Development Kit', 'SourceUpdated', 'BetaSourceUpdated'] +--- + +# SourceUpdated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Source's unique ID. | +**Name** | **string** | Source name. | +**Type** | **string** | Connection type. | +**Modified** | **SailPointTime** | Date and time when the source was modified. | +**Connector** | **string** | Connector type used to connect to the source. | +**Actor** | [**SourceUpdatedActor**](source-updated-actor) | | + +## Methods + +### NewSourceUpdated + +`func NewSourceUpdated(id string, name string, type_ string, modified SailPointTime, connector string, actor SourceUpdatedActor, ) *SourceUpdated` + +NewSourceUpdated instantiates a new SourceUpdated 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 + +### NewSourceUpdatedWithDefaults + +`func NewSourceUpdatedWithDefaults() *SourceUpdated` + +NewSourceUpdatedWithDefaults instantiates a new SourceUpdated 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 + +### GetId + +`func (o *SourceUpdated) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceUpdated) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceUpdated) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceUpdated) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceUpdated) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceUpdated) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *SourceUpdated) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceUpdated) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceUpdated) SetType(v string)` + +SetType sets Type field to given value. + + +### GetModified + +`func (o *SourceUpdated) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SourceUpdated) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SourceUpdated) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetConnector + +`func (o *SourceUpdated) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *SourceUpdated) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *SourceUpdated) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetActor + +`func (o *SourceUpdated) GetActor() SourceUpdatedActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *SourceUpdated) GetActorOk() (*SourceUpdatedActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *SourceUpdated) SetActor(v SourceUpdatedActor)` + +SetActor sets Actor field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceUpdatedActor.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceUpdatedActor.md new file mode 100644 index 000000000..6ac5af75b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceUpdatedActor.md @@ -0,0 +1,101 @@ +--- +id: beta-source-updated-actor +title: SourceUpdatedActor +pagination_label: SourceUpdatedActor +sidebar_label: SourceUpdatedActor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUpdatedActor', 'BetaSourceUpdatedActor'] +slug: /tools/sdk/go/beta/models/source-updated-actor +tags: ['SDK', 'Software Development Kit', 'SourceUpdatedActor', 'BetaSourceUpdatedActor'] +--- + +# SourceUpdatedActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of the identity who updated the source. | +**Id** | **string** | ID of the identity who updated the source. | +**Name** | **string** | Name of the identity who updated the source. | + +## Methods + +### NewSourceUpdatedActor + +`func NewSourceUpdatedActor(type_ string, id string, name string, ) *SourceUpdatedActor` + +NewSourceUpdatedActor instantiates a new SourceUpdatedActor 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 + +### NewSourceUpdatedActorWithDefaults + +`func NewSourceUpdatedActorWithDefaults() *SourceUpdatedActor` + +NewSourceUpdatedActorWithDefaults instantiates a new SourceUpdatedActor 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 + +### GetType + +`func (o *SourceUpdatedActor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceUpdatedActor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceUpdatedActor) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *SourceUpdatedActor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceUpdatedActor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceUpdatedActor) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceUpdatedActor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceUpdatedActor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceUpdatedActor) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceUsage.md new file mode 100644 index 000000000..c83ef5064 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceUsage.md @@ -0,0 +1,90 @@ +--- +id: beta-source-usage +title: SourceUsage +pagination_label: SourceUsage +sidebar_label: SourceUsage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUsage', 'BetaSourceUsage'] +slug: /tools/sdk/go/beta/models/source-usage +tags: ['SDK', 'Software Development Kit', 'SourceUsage', 'BetaSourceUsage'] +--- + +# SourceUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **string** | The first day of the month for which activity is aggregated. | [optional] +**Count** | Pointer to **float32** | The average number of days that accounts were active within this source, for the month. | [optional] + +## Methods + +### NewSourceUsage + +`func NewSourceUsage() *SourceUsage` + +NewSourceUsage instantiates a new SourceUsage 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 + +### NewSourceUsageWithDefaults + +`func NewSourceUsageWithDefaults() *SourceUsage` + +NewSourceUsageWithDefaults instantiates a new SourceUsage 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 + +### GetDate + +`func (o *SourceUsage) GetDate() string` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *SourceUsage) GetDateOk() (*string, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *SourceUsage) SetDate(v string)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *SourceUsage) HasDate() bool` + +HasDate returns a boolean if a field has been set. + +### GetCount + +`func (o *SourceUsage) GetCount() float32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *SourceUsage) GetCountOk() (*float32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *SourceUsage) SetCount(v float32)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *SourceUsage) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SourceUsageStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/SourceUsageStatus.md new file mode 100644 index 000000000..4601ac2e1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SourceUsageStatus.md @@ -0,0 +1,64 @@ +--- +id: beta-source-usage-status +title: SourceUsageStatus +pagination_label: SourceUsageStatus +sidebar_label: SourceUsageStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUsageStatus', 'BetaSourceUsageStatus'] +slug: /tools/sdk/go/beta/models/source-usage-status +tags: ['SDK', 'Software Development Kit', 'SourceUsageStatus', 'BetaSourceUsageStatus'] +--- + +# SourceUsageStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. | [optional] + +## Methods + +### NewSourceUsageStatus + +`func NewSourceUsageStatus() *SourceUsageStatus` + +NewSourceUsageStatus instantiates a new SourceUsageStatus 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 + +### NewSourceUsageStatusWithDefaults + +`func NewSourceUsageStatusWithDefaults() *SourceUsageStatus` + +NewSourceUsageStatusWithDefaults instantiates a new SourceUsageStatus 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 + +### GetStatus + +`func (o *SourceUsageStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SourceUsageStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SourceUsageStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SourceUsageStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SpConfigExportJob.md b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigExportJob.md new file mode 100644 index 000000000..10482b134 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigExportJob.md @@ -0,0 +1,190 @@ +--- +id: beta-sp-config-export-job +title: SpConfigExportJob +pagination_label: SpConfigExportJob +sidebar_label: SpConfigExportJob +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigExportJob', 'BetaSpConfigExportJob'] +slug: /tools/sdk/go/beta/models/sp-config-export-job +tags: ['SDK', 'Software Development Kit', 'SpConfigExportJob', 'BetaSpConfigExportJob'] +--- + +# SpConfigExportJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **string** | Unique id assigned to this job. | +**Status** | **string** | Status of the job. | +**Type** | **string** | Type of the job, either export or import. | +**Expiration** | **SailPointTime** | The time until which the artifacts will be available for download. | +**Created** | **SailPointTime** | The time the job was started. | +**Modified** | **SailPointTime** | The time of the last update to the job. | +**Description** | Pointer to **string** | Optional user defined description/name for export job. | [optional] + +## Methods + +### NewSpConfigExportJob + +`func NewSpConfigExportJob(jobId string, status string, type_ string, expiration SailPointTime, created SailPointTime, modified SailPointTime, ) *SpConfigExportJob` + +NewSpConfigExportJob instantiates a new SpConfigExportJob 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 + +### NewSpConfigExportJobWithDefaults + +`func NewSpConfigExportJobWithDefaults() *SpConfigExportJob` + +NewSpConfigExportJobWithDefaults instantiates a new SpConfigExportJob 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 + +### GetJobId + +`func (o *SpConfigExportJob) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *SpConfigExportJob) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *SpConfigExportJob) SetJobId(v string)` + +SetJobId sets JobId field to given value. + + +### GetStatus + +`func (o *SpConfigExportJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SpConfigExportJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SpConfigExportJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *SpConfigExportJob) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SpConfigExportJob) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SpConfigExportJob) SetType(v string)` + +SetType sets Type field to given value. + + +### GetExpiration + +`func (o *SpConfigExportJob) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *SpConfigExportJob) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *SpConfigExportJob) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + + +### GetCreated + +`func (o *SpConfigExportJob) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SpConfigExportJob) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SpConfigExportJob) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *SpConfigExportJob) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SpConfigExportJob) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SpConfigExportJob) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetDescription + +`func (o *SpConfigExportJob) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SpConfigExportJob) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SpConfigExportJob) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SpConfigExportJob) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SpConfigExportJobStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigExportJobStatus.md new file mode 100644 index 000000000..c2ea52b79 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigExportJobStatus.md @@ -0,0 +1,216 @@ +--- +id: beta-sp-config-export-job-status +title: SpConfigExportJobStatus +pagination_label: SpConfigExportJobStatus +sidebar_label: SpConfigExportJobStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigExportJobStatus', 'BetaSpConfigExportJobStatus'] +slug: /tools/sdk/go/beta/models/sp-config-export-job-status +tags: ['SDK', 'Software Development Kit', 'SpConfigExportJobStatus', 'BetaSpConfigExportJobStatus'] +--- + +# SpConfigExportJobStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **string** | Unique id assigned to this job. | +**Status** | **string** | Status of the job. | +**Type** | **string** | Type of the job, either export or import. | +**Expiration** | **SailPointTime** | The time until which the artifacts will be available for download. | +**Created** | **SailPointTime** | The time the job was started. | +**Modified** | **SailPointTime** | The time of the last update to the job. | +**Description** | Pointer to **string** | Optional user defined description/name for export job. | [optional] +**Completed** | Pointer to **SailPointTime** | The time the job was completed. | [optional] + +## Methods + +### NewSpConfigExportJobStatus + +`func NewSpConfigExportJobStatus(jobId string, status string, type_ string, expiration SailPointTime, created SailPointTime, modified SailPointTime, ) *SpConfigExportJobStatus` + +NewSpConfigExportJobStatus instantiates a new SpConfigExportJobStatus 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 + +### NewSpConfigExportJobStatusWithDefaults + +`func NewSpConfigExportJobStatusWithDefaults() *SpConfigExportJobStatus` + +NewSpConfigExportJobStatusWithDefaults instantiates a new SpConfigExportJobStatus 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 + +### GetJobId + +`func (o *SpConfigExportJobStatus) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *SpConfigExportJobStatus) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *SpConfigExportJobStatus) SetJobId(v string)` + +SetJobId sets JobId field to given value. + + +### GetStatus + +`func (o *SpConfigExportJobStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SpConfigExportJobStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SpConfigExportJobStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *SpConfigExportJobStatus) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SpConfigExportJobStatus) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SpConfigExportJobStatus) SetType(v string)` + +SetType sets Type field to given value. + + +### GetExpiration + +`func (o *SpConfigExportJobStatus) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *SpConfigExportJobStatus) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *SpConfigExportJobStatus) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + + +### GetCreated + +`func (o *SpConfigExportJobStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SpConfigExportJobStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SpConfigExportJobStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *SpConfigExportJobStatus) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SpConfigExportJobStatus) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SpConfigExportJobStatus) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetDescription + +`func (o *SpConfigExportJobStatus) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SpConfigExportJobStatus) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SpConfigExportJobStatus) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SpConfigExportJobStatus) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetCompleted + +`func (o *SpConfigExportJobStatus) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *SpConfigExportJobStatus) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *SpConfigExportJobStatus) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *SpConfigExportJobStatus) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SpConfigExportResults.md b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigExportResults.md new file mode 100644 index 000000000..7622a8bd0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigExportResults.md @@ -0,0 +1,194 @@ +--- +id: beta-sp-config-export-results +title: SpConfigExportResults +pagination_label: SpConfigExportResults +sidebar_label: SpConfigExportResults +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigExportResults', 'BetaSpConfigExportResults'] +slug: /tools/sdk/go/beta/models/sp-config-export-results +tags: ['SDK', 'Software Development Kit', 'SpConfigExportResults', 'BetaSpConfigExportResults'] +--- + +# SpConfigExportResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **int32** | Current version of the export results object. | [optional] +**Timestamp** | Pointer to **SailPointTime** | Time the export was completed. | [optional] +**Tenant** | Pointer to **string** | Name of the tenant where this export originated. | [optional] +**Description** | Pointer to **string** | Optional user defined description/name for export job. | [optional] +**Options** | Pointer to [**ExportOptions**](export-options) | | [optional] +**Objects** | Pointer to [**[]ConfigObject**](config-object) | | [optional] + +## Methods + +### NewSpConfigExportResults + +`func NewSpConfigExportResults() *SpConfigExportResults` + +NewSpConfigExportResults instantiates a new SpConfigExportResults 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 + +### NewSpConfigExportResultsWithDefaults + +`func NewSpConfigExportResultsWithDefaults() *SpConfigExportResults` + +NewSpConfigExportResultsWithDefaults instantiates a new SpConfigExportResults 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 + +### GetVersion + +`func (o *SpConfigExportResults) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *SpConfigExportResults) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *SpConfigExportResults) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *SpConfigExportResults) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### GetTimestamp + +`func (o *SpConfigExportResults) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *SpConfigExportResults) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *SpConfigExportResults) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *SpConfigExportResults) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + +### GetTenant + +`func (o *SpConfigExportResults) GetTenant() string` + +GetTenant returns the Tenant field if non-nil, zero value otherwise. + +### GetTenantOk + +`func (o *SpConfigExportResults) GetTenantOk() (*string, bool)` + +GetTenantOk returns a tuple with the Tenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenant + +`func (o *SpConfigExportResults) SetTenant(v string)` + +SetTenant sets Tenant field to given value. + +### HasTenant + +`func (o *SpConfigExportResults) HasTenant() bool` + +HasTenant returns a boolean if a field has been set. + +### GetDescription + +`func (o *SpConfigExportResults) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SpConfigExportResults) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SpConfigExportResults) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SpConfigExportResults) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOptions + +`func (o *SpConfigExportResults) GetOptions() ExportOptions` + +GetOptions returns the Options field if non-nil, zero value otherwise. + +### GetOptionsOk + +`func (o *SpConfigExportResults) GetOptionsOk() (*ExportOptions, bool)` + +GetOptionsOk returns a tuple with the Options field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOptions + +`func (o *SpConfigExportResults) SetOptions(v ExportOptions)` + +SetOptions sets Options field to given value. + +### HasOptions + +`func (o *SpConfigExportResults) HasOptions() bool` + +HasOptions returns a boolean if a field has been set. + +### GetObjects + +`func (o *SpConfigExportResults) GetObjects() []ConfigObject` + +GetObjects returns the Objects field if non-nil, zero value otherwise. + +### GetObjectsOk + +`func (o *SpConfigExportResults) GetObjectsOk() (*[]ConfigObject, bool)` + +GetObjectsOk returns a tuple with the Objects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjects + +`func (o *SpConfigExportResults) SetObjects(v []ConfigObject)` + +SetObjects sets Objects field to given value. + +### HasObjects + +`func (o *SpConfigExportResults) HasObjects() bool` + +HasObjects returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SpConfigImportJobStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigImportJobStatus.md new file mode 100644 index 000000000..6c6fed644 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigImportJobStatus.md @@ -0,0 +1,216 @@ +--- +id: beta-sp-config-import-job-status +title: SpConfigImportJobStatus +pagination_label: SpConfigImportJobStatus +sidebar_label: SpConfigImportJobStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigImportJobStatus', 'BetaSpConfigImportJobStatus'] +slug: /tools/sdk/go/beta/models/sp-config-import-job-status +tags: ['SDK', 'Software Development Kit', 'SpConfigImportJobStatus', 'BetaSpConfigImportJobStatus'] +--- + +# SpConfigImportJobStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **string** | Unique id assigned to this job. | +**Status** | **string** | Status of the job. | +**Type** | **string** | Type of the job, either export or import. | +**Expiration** | **SailPointTime** | The time until which the artifacts will be available for download. | +**Created** | **SailPointTime** | The time the job was started. | +**Modified** | **SailPointTime** | The time of the last update to the job. | +**Message** | Pointer to **string** | This message contains additional information about the overall status of the job. | [optional] +**Completed** | Pointer to **SailPointTime** | The time the job was completed. | [optional] + +## Methods + +### NewSpConfigImportJobStatus + +`func NewSpConfigImportJobStatus(jobId string, status string, type_ string, expiration SailPointTime, created SailPointTime, modified SailPointTime, ) *SpConfigImportJobStatus` + +NewSpConfigImportJobStatus instantiates a new SpConfigImportJobStatus 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 + +### NewSpConfigImportJobStatusWithDefaults + +`func NewSpConfigImportJobStatusWithDefaults() *SpConfigImportJobStatus` + +NewSpConfigImportJobStatusWithDefaults instantiates a new SpConfigImportJobStatus 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 + +### GetJobId + +`func (o *SpConfigImportJobStatus) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *SpConfigImportJobStatus) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *SpConfigImportJobStatus) SetJobId(v string)` + +SetJobId sets JobId field to given value. + + +### GetStatus + +`func (o *SpConfigImportJobStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SpConfigImportJobStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SpConfigImportJobStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *SpConfigImportJobStatus) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SpConfigImportJobStatus) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SpConfigImportJobStatus) SetType(v string)` + +SetType sets Type field to given value. + + +### GetExpiration + +`func (o *SpConfigImportJobStatus) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *SpConfigImportJobStatus) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *SpConfigImportJobStatus) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + + +### GetCreated + +`func (o *SpConfigImportJobStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SpConfigImportJobStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SpConfigImportJobStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *SpConfigImportJobStatus) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SpConfigImportJobStatus) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SpConfigImportJobStatus) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetMessage + +`func (o *SpConfigImportJobStatus) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *SpConfigImportJobStatus) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *SpConfigImportJobStatus) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *SpConfigImportJobStatus) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetCompleted + +`func (o *SpConfigImportJobStatus) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *SpConfigImportJobStatus) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *SpConfigImportJobStatus) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *SpConfigImportJobStatus) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SpConfigImportResults.md b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigImportResults.md new file mode 100644 index 000000000..dccb7e1a4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigImportResults.md @@ -0,0 +1,85 @@ +--- +id: beta-sp-config-import-results +title: SpConfigImportResults +pagination_label: SpConfigImportResults +sidebar_label: SpConfigImportResults +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigImportResults', 'BetaSpConfigImportResults'] +slug: /tools/sdk/go/beta/models/sp-config-import-results +tags: ['SDK', 'Software Development Kit', 'SpConfigImportResults', 'BetaSpConfigImportResults'] +--- + +# SpConfigImportResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | [**map[string]ObjectImportResult**](object-import-result) | The results of an object configuration import job. | +**ExportJobId** | Pointer to **string** | If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export. | [optional] + +## Methods + +### NewSpConfigImportResults + +`func NewSpConfigImportResults(results map[string]ObjectImportResult, ) *SpConfigImportResults` + +NewSpConfigImportResults instantiates a new SpConfigImportResults 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 + +### NewSpConfigImportResultsWithDefaults + +`func NewSpConfigImportResultsWithDefaults() *SpConfigImportResults` + +NewSpConfigImportResultsWithDefaults instantiates a new SpConfigImportResults 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 + +### GetResults + +`func (o *SpConfigImportResults) GetResults() map[string]ObjectImportResult` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *SpConfigImportResults) GetResultsOk() (*map[string]ObjectImportResult, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *SpConfigImportResults) SetResults(v map[string]ObjectImportResult)` + +SetResults sets Results field to given value. + + +### GetExportJobId + +`func (o *SpConfigImportResults) GetExportJobId() string` + +GetExportJobId returns the ExportJobId field if non-nil, zero value otherwise. + +### GetExportJobIdOk + +`func (o *SpConfigImportResults) GetExportJobIdOk() (*string, bool)` + +GetExportJobIdOk returns a tuple with the ExportJobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExportJobId + +`func (o *SpConfigImportResults) SetExportJobId(v string)` + +SetExportJobId sets ExportJobId field to given value. + +### HasExportJobId + +`func (o *SpConfigImportResults) HasExportJobId() bool` + +HasExportJobId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SpConfigJob.md b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigJob.md new file mode 100644 index 000000000..d8f226db9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigJob.md @@ -0,0 +1,164 @@ +--- +id: beta-sp-config-job +title: SpConfigJob +pagination_label: SpConfigJob +sidebar_label: SpConfigJob +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigJob', 'BetaSpConfigJob'] +slug: /tools/sdk/go/beta/models/sp-config-job +tags: ['SDK', 'Software Development Kit', 'SpConfigJob', 'BetaSpConfigJob'] +--- + +# SpConfigJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **string** | Unique id assigned to this job. | +**Status** | **string** | Status of the job. | +**Type** | **string** | Type of the job, either export or import. | +**Expiration** | **SailPointTime** | The time until which the artifacts will be available for download. | +**Created** | **SailPointTime** | The time the job was started. | +**Modified** | **SailPointTime** | The time of the last update to the job. | + +## Methods + +### NewSpConfigJob + +`func NewSpConfigJob(jobId string, status string, type_ string, expiration SailPointTime, created SailPointTime, modified SailPointTime, ) *SpConfigJob` + +NewSpConfigJob instantiates a new SpConfigJob 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 + +### NewSpConfigJobWithDefaults + +`func NewSpConfigJobWithDefaults() *SpConfigJob` + +NewSpConfigJobWithDefaults instantiates a new SpConfigJob 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 + +### GetJobId + +`func (o *SpConfigJob) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *SpConfigJob) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *SpConfigJob) SetJobId(v string)` + +SetJobId sets JobId field to given value. + + +### GetStatus + +`func (o *SpConfigJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SpConfigJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SpConfigJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *SpConfigJob) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SpConfigJob) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SpConfigJob) SetType(v string)` + +SetType sets Type field to given value. + + +### GetExpiration + +`func (o *SpConfigJob) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *SpConfigJob) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *SpConfigJob) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + + +### GetCreated + +`func (o *SpConfigJob) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SpConfigJob) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SpConfigJob) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *SpConfigJob) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SpConfigJob) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SpConfigJob) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SpConfigMessage.md b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigMessage.md new file mode 100644 index 000000000..255f9c0cb --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigMessage.md @@ -0,0 +1,101 @@ +--- +id: beta-sp-config-message +title: SpConfigMessage +pagination_label: SpConfigMessage +sidebar_label: SpConfigMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigMessage', 'BetaSpConfigMessage'] +slug: /tools/sdk/go/beta/models/sp-config-message +tags: ['SDK', 'Software Development Kit', 'SpConfigMessage', 'BetaSpConfigMessage'] +--- + +# SpConfigMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **string** | Message key. | +**Text** | **string** | Message text. | +**Details** | **map[string]map[string]interface{}** | Message details if any, in key:value pairs. | + +## Methods + +### NewSpConfigMessage + +`func NewSpConfigMessage(key string, text string, details map[string]map[string]interface{}, ) *SpConfigMessage` + +NewSpConfigMessage instantiates a new SpConfigMessage 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 + +### NewSpConfigMessageWithDefaults + +`func NewSpConfigMessageWithDefaults() *SpConfigMessage` + +NewSpConfigMessageWithDefaults instantiates a new SpConfigMessage 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 + +### GetKey + +`func (o *SpConfigMessage) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *SpConfigMessage) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *SpConfigMessage) SetKey(v string)` + +SetKey sets Key field to given value. + + +### GetText + +`func (o *SpConfigMessage) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *SpConfigMessage) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *SpConfigMessage) SetText(v string)` + +SetText sets Text field to given value. + + +### GetDetails + +`func (o *SpConfigMessage) GetDetails() map[string]map[string]interface{}` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *SpConfigMessage) GetDetailsOk() (*map[string]map[string]interface{}, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *SpConfigMessage) SetDetails(v map[string]map[string]interface{})` + +SetDetails sets Details field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SpConfigObject.md b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigObject.md new file mode 100644 index 000000000..71cd0c928 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigObject.md @@ -0,0 +1,256 @@ +--- +id: beta-sp-config-object +title: SpConfigObject +pagination_label: SpConfigObject +sidebar_label: SpConfigObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigObject', 'BetaSpConfigObject'] +slug: /tools/sdk/go/beta/models/sp-config-object +tags: ['SDK', 'Software Development Kit', 'SpConfigObject', 'BetaSpConfigObject'] +--- + +# SpConfigObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectType** | Pointer to **string** | Object type the configuration is for. | [optional] +**ReferenceExtractors** | Pointer to **[]string** | List of JSON paths within an exported object of this type, representing references that must be resolved. | [optional] +**SignatureRequired** | Pointer to **bool** | Indicates whether this type of object will be JWS signed and cannot be modified before import. | [optional] [default to false] +**AlwaysResolveById** | Pointer to **bool** | Indicates whether this object type must be always be resolved by ID. | [optional] [default to false] +**LegacyObject** | Pointer to **bool** | Indicates whether this is a legacy object. | [optional] [default to false] +**OnePerTenant** | Pointer to **bool** | Indicates whether there is only one object of this type. | [optional] [default to false] +**Exportable** | Pointer to **bool** | Indicates whether the object can be exported or is just a reference object. | [optional] [default to false] +**Rules** | Pointer to [**SpConfigRules**](sp-config-rules) | | [optional] + +## Methods + +### NewSpConfigObject + +`func NewSpConfigObject() *SpConfigObject` + +NewSpConfigObject instantiates a new SpConfigObject 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 + +### NewSpConfigObjectWithDefaults + +`func NewSpConfigObjectWithDefaults() *SpConfigObject` + +NewSpConfigObjectWithDefaults instantiates a new SpConfigObject 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 + +### GetObjectType + +`func (o *SpConfigObject) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *SpConfigObject) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *SpConfigObject) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + +### HasObjectType + +`func (o *SpConfigObject) HasObjectType() bool` + +HasObjectType returns a boolean if a field has been set. + +### GetReferenceExtractors + +`func (o *SpConfigObject) GetReferenceExtractors() []string` + +GetReferenceExtractors returns the ReferenceExtractors field if non-nil, zero value otherwise. + +### GetReferenceExtractorsOk + +`func (o *SpConfigObject) GetReferenceExtractorsOk() (*[]string, bool)` + +GetReferenceExtractorsOk returns a tuple with the ReferenceExtractors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReferenceExtractors + +`func (o *SpConfigObject) SetReferenceExtractors(v []string)` + +SetReferenceExtractors sets ReferenceExtractors field to given value. + +### HasReferenceExtractors + +`func (o *SpConfigObject) HasReferenceExtractors() bool` + +HasReferenceExtractors returns a boolean if a field has been set. + +### SetReferenceExtractorsNil + +`func (o *SpConfigObject) SetReferenceExtractorsNil(b bool)` + + SetReferenceExtractorsNil sets the value for ReferenceExtractors to be an explicit nil + +### UnsetReferenceExtractors +`func (o *SpConfigObject) UnsetReferenceExtractors()` + +UnsetReferenceExtractors ensures that no value is present for ReferenceExtractors, not even an explicit nil +### GetSignatureRequired + +`func (o *SpConfigObject) GetSignatureRequired() bool` + +GetSignatureRequired returns the SignatureRequired field if non-nil, zero value otherwise. + +### GetSignatureRequiredOk + +`func (o *SpConfigObject) GetSignatureRequiredOk() (*bool, bool)` + +GetSignatureRequiredOk returns a tuple with the SignatureRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignatureRequired + +`func (o *SpConfigObject) SetSignatureRequired(v bool)` + +SetSignatureRequired sets SignatureRequired field to given value. + +### HasSignatureRequired + +`func (o *SpConfigObject) HasSignatureRequired() bool` + +HasSignatureRequired returns a boolean if a field has been set. + +### GetAlwaysResolveById + +`func (o *SpConfigObject) GetAlwaysResolveById() bool` + +GetAlwaysResolveById returns the AlwaysResolveById field if non-nil, zero value otherwise. + +### GetAlwaysResolveByIdOk + +`func (o *SpConfigObject) GetAlwaysResolveByIdOk() (*bool, bool)` + +GetAlwaysResolveByIdOk returns a tuple with the AlwaysResolveById field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlwaysResolveById + +`func (o *SpConfigObject) SetAlwaysResolveById(v bool)` + +SetAlwaysResolveById sets AlwaysResolveById field to given value. + +### HasAlwaysResolveById + +`func (o *SpConfigObject) HasAlwaysResolveById() bool` + +HasAlwaysResolveById returns a boolean if a field has been set. + +### GetLegacyObject + +`func (o *SpConfigObject) GetLegacyObject() bool` + +GetLegacyObject returns the LegacyObject field if non-nil, zero value otherwise. + +### GetLegacyObjectOk + +`func (o *SpConfigObject) GetLegacyObjectOk() (*bool, bool)` + +GetLegacyObjectOk returns a tuple with the LegacyObject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyObject + +`func (o *SpConfigObject) SetLegacyObject(v bool)` + +SetLegacyObject sets LegacyObject field to given value. + +### HasLegacyObject + +`func (o *SpConfigObject) HasLegacyObject() bool` + +HasLegacyObject returns a boolean if a field has been set. + +### GetOnePerTenant + +`func (o *SpConfigObject) GetOnePerTenant() bool` + +GetOnePerTenant returns the OnePerTenant field if non-nil, zero value otherwise. + +### GetOnePerTenantOk + +`func (o *SpConfigObject) GetOnePerTenantOk() (*bool, bool)` + +GetOnePerTenantOk returns a tuple with the OnePerTenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOnePerTenant + +`func (o *SpConfigObject) SetOnePerTenant(v bool)` + +SetOnePerTenant sets OnePerTenant field to given value. + +### HasOnePerTenant + +`func (o *SpConfigObject) HasOnePerTenant() bool` + +HasOnePerTenant returns a boolean if a field has been set. + +### GetExportable + +`func (o *SpConfigObject) GetExportable() bool` + +GetExportable returns the Exportable field if non-nil, zero value otherwise. + +### GetExportableOk + +`func (o *SpConfigObject) GetExportableOk() (*bool, bool)` + +GetExportableOk returns a tuple with the Exportable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExportable + +`func (o *SpConfigObject) SetExportable(v bool)` + +SetExportable sets Exportable field to given value. + +### HasExportable + +`func (o *SpConfigObject) HasExportable() bool` + +HasExportable returns a boolean if a field has been set. + +### GetRules + +`func (o *SpConfigObject) GetRules() SpConfigRules` + +GetRules returns the Rules field if non-nil, zero value otherwise. + +### GetRulesOk + +`func (o *SpConfigObject) GetRulesOk() (*SpConfigRules, bool)` + +GetRulesOk returns a tuple with the Rules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRules + +`func (o *SpConfigObject) SetRules(v SpConfigRules)` + +SetRules sets Rules field to given value. + +### HasRules + +`func (o *SpConfigObject) HasRules() bool` + +HasRules returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SpConfigRule.md b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigRule.md new file mode 100644 index 000000000..a4144e190 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigRule.md @@ -0,0 +1,126 @@ +--- +id: beta-sp-config-rule +title: SpConfigRule +pagination_label: SpConfigRule +sidebar_label: SpConfigRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigRule', 'BetaSpConfigRule'] +slug: /tools/sdk/go/beta/models/sp-config-rule +tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'BetaSpConfigRule'] +--- + +# SpConfigRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Path** | Pointer to **string** | JSONPath expression denoting the path within the object where a value substitution should be applied. | [optional] +**Value** | Pointer to [**NullableSpConfigRuleValue**](sp-config-rule-value) | | [optional] +**Modes** | Pointer to **[]string** | Draft modes the rule will apply to. | [optional] + +## Methods + +### NewSpConfigRule + +`func NewSpConfigRule() *SpConfigRule` + +NewSpConfigRule instantiates a new SpConfigRule 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 + +### NewSpConfigRuleWithDefaults + +`func NewSpConfigRuleWithDefaults() *SpConfigRule` + +NewSpConfigRuleWithDefaults instantiates a new SpConfigRule 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 + +### GetPath + +`func (o *SpConfigRule) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *SpConfigRule) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *SpConfigRule) SetPath(v string)` + +SetPath sets Path field to given value. + +### HasPath + +`func (o *SpConfigRule) HasPath() bool` + +HasPath returns a boolean if a field has been set. + +### GetValue + +`func (o *SpConfigRule) GetValue() SpConfigRuleValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SpConfigRule) GetValueOk() (*SpConfigRuleValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SpConfigRule) SetValue(v SpConfigRuleValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SpConfigRule) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *SpConfigRule) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *SpConfigRule) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetModes + +`func (o *SpConfigRule) GetModes() []string` + +GetModes returns the Modes field if non-nil, zero value otherwise. + +### GetModesOk + +`func (o *SpConfigRule) GetModesOk() (*[]string, bool)` + +GetModesOk returns a tuple with the Modes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModes + +`func (o *SpConfigRule) SetModes(v []string)` + +SetModes sets Modes field to given value. + +### HasModes + +`func (o *SpConfigRule) HasModes() bool` + +HasModes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SpConfigRuleValue.md b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigRuleValue.md new file mode 100644 index 000000000..e8a3d41ce --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigRuleValue.md @@ -0,0 +1,38 @@ +--- +id: beta-sp-config-rule-value +title: SpConfigRuleValue +pagination_label: SpConfigRuleValue +sidebar_label: SpConfigRuleValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigRuleValue', 'BetaSpConfigRuleValue'] +slug: /tools/sdk/go/beta/models/sp-config-rule-value +tags: ['SDK', 'Software Development Kit', 'SpConfigRuleValue', 'BetaSpConfigRuleValue'] +--- + +# SpConfigRuleValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewSpConfigRuleValue + +`func NewSpConfigRuleValue() *SpConfigRuleValue` + +NewSpConfigRuleValue instantiates a new SpConfigRuleValue 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 + +### NewSpConfigRuleValueWithDefaults + +`func NewSpConfigRuleValueWithDefaults() *SpConfigRuleValue` + +NewSpConfigRuleValueWithDefaults instantiates a new SpConfigRuleValue 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 + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SpConfigRules.md b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigRules.md new file mode 100644 index 000000000..250a0b074 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SpConfigRules.md @@ -0,0 +1,116 @@ +--- +id: beta-sp-config-rules +title: SpConfigRules +pagination_label: SpConfigRules +sidebar_label: SpConfigRules +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigRules', 'BetaSpConfigRules'] +slug: /tools/sdk/go/beta/models/sp-config-rules +tags: ['SDK', 'Software Development Kit', 'SpConfigRules', 'BetaSpConfigRules'] +--- + +# SpConfigRules + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TakeFromTargetRules** | Pointer to [**[]SpConfigRule**](sp-config-rule) | | [optional] +**DefaultRules** | Pointer to [**[]SpConfigRule**](sp-config-rule) | | [optional] +**Editable** | Pointer to **bool** | Indicates whether the object can be edited. | [optional] [default to false] + +## Methods + +### NewSpConfigRules + +`func NewSpConfigRules() *SpConfigRules` + +NewSpConfigRules instantiates a new SpConfigRules 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 + +### NewSpConfigRulesWithDefaults + +`func NewSpConfigRulesWithDefaults() *SpConfigRules` + +NewSpConfigRulesWithDefaults instantiates a new SpConfigRules 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 + +### GetTakeFromTargetRules + +`func (o *SpConfigRules) GetTakeFromTargetRules() []SpConfigRule` + +GetTakeFromTargetRules returns the TakeFromTargetRules field if non-nil, zero value otherwise. + +### GetTakeFromTargetRulesOk + +`func (o *SpConfigRules) GetTakeFromTargetRulesOk() (*[]SpConfigRule, bool)` + +GetTakeFromTargetRulesOk returns a tuple with the TakeFromTargetRules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTakeFromTargetRules + +`func (o *SpConfigRules) SetTakeFromTargetRules(v []SpConfigRule)` + +SetTakeFromTargetRules sets TakeFromTargetRules field to given value. + +### HasTakeFromTargetRules + +`func (o *SpConfigRules) HasTakeFromTargetRules() bool` + +HasTakeFromTargetRules returns a boolean if a field has been set. + +### GetDefaultRules + +`func (o *SpConfigRules) GetDefaultRules() []SpConfigRule` + +GetDefaultRules returns the DefaultRules field if non-nil, zero value otherwise. + +### GetDefaultRulesOk + +`func (o *SpConfigRules) GetDefaultRulesOk() (*[]SpConfigRule, bool)` + +GetDefaultRulesOk returns a tuple with the DefaultRules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultRules + +`func (o *SpConfigRules) SetDefaultRules(v []SpConfigRule)` + +SetDefaultRules sets DefaultRules field to given value. + +### HasDefaultRules + +`func (o *SpConfigRules) HasDefaultRules() bool` + +HasDefaultRules returns a boolean if a field has been set. + +### GetEditable + +`func (o *SpConfigRules) GetEditable() bool` + +GetEditable returns the Editable field if non-nil, zero value otherwise. + +### GetEditableOk + +`func (o *SpConfigRules) GetEditableOk() (*bool, bool)` + +GetEditableOk returns a tuple with the Editable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEditable + +`func (o *SpConfigRules) SetEditable(v bool)` + +SetEditable sets Editable field to given value. + +### HasEditable + +`func (o *SpConfigRules) HasEditable() bool` + +HasEditable returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/StandardLevel.md b/docs/tools/sdk/go/Reference/Beta/Models/StandardLevel.md new file mode 100644 index 000000000..fe4fa87ba --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/StandardLevel.md @@ -0,0 +1,31 @@ +--- +id: beta-standard-level +title: StandardLevel +pagination_label: StandardLevel +sidebar_label: StandardLevel +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'StandardLevel', 'BetaStandardLevel'] +slug: /tools/sdk/go/beta/models/standard-level +tags: ['SDK', 'Software Development Kit', 'StandardLevel', 'BetaStandardLevel'] +--- + +# StandardLevel + +## Enum + + +* `FALSE` (value: `"false"`) + +* `FATAL` (value: `"FATAL"`) + +* `ERROR` (value: `"ERROR"`) + +* `WARN` (value: `"WARN"`) + +* `INFO` (value: `"INFO"`) + +* `DEBUG` (value: `"DEBUG"`) + +* `TRACE` (value: `"TRACE"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/StartInvocationInput.md b/docs/tools/sdk/go/Reference/Beta/Models/StartInvocationInput.md new file mode 100644 index 000000000..851566c3e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/StartInvocationInput.md @@ -0,0 +1,116 @@ +--- +id: beta-start-invocation-input +title: StartInvocationInput +pagination_label: StartInvocationInput +sidebar_label: StartInvocationInput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'StartInvocationInput', 'BetaStartInvocationInput'] +slug: /tools/sdk/go/beta/models/start-invocation-input +tags: ['SDK', 'Software Development Kit', 'StartInvocationInput', 'BetaStartInvocationInput'] +--- + +# StartInvocationInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TriggerId** | Pointer to **string** | Trigger ID | [optional] +**Input** | Pointer to **map[string]interface{}** | Trigger input payload. Its schema is defined in the trigger definition. | [optional] +**ContentJson** | Pointer to **map[string]interface{}** | JSON map of invocation metadata | [optional] + +## Methods + +### NewStartInvocationInput + +`func NewStartInvocationInput() *StartInvocationInput` + +NewStartInvocationInput instantiates a new StartInvocationInput 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 + +### NewStartInvocationInputWithDefaults + +`func NewStartInvocationInputWithDefaults() *StartInvocationInput` + +NewStartInvocationInputWithDefaults instantiates a new StartInvocationInput 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 + +### GetTriggerId + +`func (o *StartInvocationInput) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *StartInvocationInput) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *StartInvocationInput) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + +### HasTriggerId + +`func (o *StartInvocationInput) HasTriggerId() bool` + +HasTriggerId returns a boolean if a field has been set. + +### GetInput + +`func (o *StartInvocationInput) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *StartInvocationInput) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *StartInvocationInput) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + +### HasInput + +`func (o *StartInvocationInput) HasInput() bool` + +HasInput returns a boolean if a field has been set. + +### GetContentJson + +`func (o *StartInvocationInput) GetContentJson() map[string]interface{}` + +GetContentJson returns the ContentJson field if non-nil, zero value otherwise. + +### GetContentJsonOk + +`func (o *StartInvocationInput) GetContentJsonOk() (*map[string]interface{}, bool)` + +GetContentJsonOk returns a tuple with the ContentJson field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContentJson + +`func (o *StartInvocationInput) SetContentJson(v map[string]interface{})` + +SetContentJson sets ContentJson field to given value. + +### HasContentJson + +`func (o *StartInvocationInput) HasContentJson() bool` + +HasContentJson returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/StartLauncher200Response.md b/docs/tools/sdk/go/Reference/Beta/Models/StartLauncher200Response.md new file mode 100644 index 000000000..ab96e362e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/StartLauncher200Response.md @@ -0,0 +1,59 @@ +--- +id: beta-start-launcher200-response +title: StartLauncher200Response +pagination_label: StartLauncher200Response +sidebar_label: StartLauncher200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'StartLauncher200Response', 'BetaStartLauncher200Response'] +slug: /tools/sdk/go/beta/models/start-launcher200-response +tags: ['SDK', 'Software Development Kit', 'StartLauncher200Response', 'BetaStartLauncher200Response'] +--- + +# StartLauncher200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InteractiveProcessId** | **string** | ID of the Interactive Process that was launched | + +## Methods + +### NewStartLauncher200Response + +`func NewStartLauncher200Response(interactiveProcessId string, ) *StartLauncher200Response` + +NewStartLauncher200Response instantiates a new StartLauncher200Response 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 + +### NewStartLauncher200ResponseWithDefaults + +`func NewStartLauncher200ResponseWithDefaults() *StartLauncher200Response` + +NewStartLauncher200ResponseWithDefaults instantiates a new StartLauncher200Response 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 + +### GetInteractiveProcessId + +`func (o *StartLauncher200Response) GetInteractiveProcessId() string` + +GetInteractiveProcessId returns the InteractiveProcessId field if non-nil, zero value otherwise. + +### GetInteractiveProcessIdOk + +`func (o *StartLauncher200Response) GetInteractiveProcessIdOk() (*string, bool)` + +GetInteractiveProcessIdOk returns a tuple with the InteractiveProcessId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInteractiveProcessId + +`func (o *StartLauncher200Response) SetInteractiveProcessId(v string)` + +SetInteractiveProcessId sets InteractiveProcessId field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/StatusResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/StatusResponse.md new file mode 100644 index 000000000..825e78e51 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/StatusResponse.md @@ -0,0 +1,168 @@ +--- +id: beta-status-response +title: StatusResponse +pagination_label: StatusResponse +sidebar_label: StatusResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'StatusResponse', 'BetaStatusResponse'] +slug: /tools/sdk/go/beta/models/status-response +tags: ['SDK', 'Software Development Kit', 'StatusResponse', 'BetaStatusResponse'] +--- + +# StatusResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the source | [optional] [readonly] +**Name** | Pointer to **string** | Name of the source | [optional] [readonly] +**Status** | Pointer to **string** | The status of the health check. | [optional] [readonly] +**ElapsedMillis** | Pointer to **int32** | The number of milliseconds spent on the entire request. | [optional] [readonly] +**Details** | Pointer to **map[string]interface{}** | The document contains the results of the health check. The schema of this document depends on the type of source used. | [optional] [readonly] + +## Methods + +### NewStatusResponse + +`func NewStatusResponse() *StatusResponse` + +NewStatusResponse instantiates a new StatusResponse 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 + +### NewStatusResponseWithDefaults + +`func NewStatusResponseWithDefaults() *StatusResponse` + +NewStatusResponseWithDefaults instantiates a new StatusResponse 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 + +### GetId + +`func (o *StatusResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *StatusResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *StatusResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *StatusResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *StatusResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *StatusResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *StatusResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *StatusResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *StatusResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *StatusResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *StatusResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *StatusResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetElapsedMillis + +`func (o *StatusResponse) GetElapsedMillis() int32` + +GetElapsedMillis returns the ElapsedMillis field if non-nil, zero value otherwise. + +### GetElapsedMillisOk + +`func (o *StatusResponse) GetElapsedMillisOk() (*int32, bool)` + +GetElapsedMillisOk returns a tuple with the ElapsedMillis field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElapsedMillis + +`func (o *StatusResponse) SetElapsedMillis(v int32)` + +SetElapsedMillis sets ElapsedMillis field to given value. + +### HasElapsedMillis + +`func (o *StatusResponse) HasElapsedMillis() bool` + +HasElapsedMillis returns a boolean if a field has been set. + +### GetDetails + +`func (o *StatusResponse) GetDetails() map[string]interface{}` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *StatusResponse) GetDetailsOk() (*map[string]interface{}, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *StatusResponse) SetDetails(v map[string]interface{})` + +SetDetails sets Details field to given value. + +### HasDetails + +`func (o *StatusResponse) HasDetails() bool` + +HasDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Subscription.md b/docs/tools/sdk/go/Reference/Beta/Models/Subscription.md new file mode 100644 index 000000000..da236ffdc --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Subscription.md @@ -0,0 +1,294 @@ +--- +id: beta-subscription +title: Subscription +pagination_label: Subscription +sidebar_label: Subscription +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Subscription', 'BetaSubscription'] +slug: /tools/sdk/go/beta/models/subscription +tags: ['SDK', 'Software Development Kit', 'Subscription', 'BetaSubscription'] +--- + +# Subscription + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Subscription ID. | +**Name** | **string** | Subscription name. | +**Description** | Pointer to **string** | Subscription description. | [optional] +**TriggerId** | **string** | ID of trigger subscribed to. | +**TriggerName** | **string** | Trigger name of trigger subscribed to. | +**Type** | [**SubscriptionType**](subscription-type) | | +**ResponseDeadline** | Pointer to **string** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] +**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] +**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] +**Enabled** | **bool** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [default to true] +**Filter** | Pointer to **string** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] + +## Methods + +### NewSubscription + +`func NewSubscription(id string, name string, triggerId string, triggerName string, type_ SubscriptionType, enabled bool, ) *Subscription` + +NewSubscription instantiates a new Subscription 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 + +### NewSubscriptionWithDefaults + +`func NewSubscriptionWithDefaults() *Subscription` + +NewSubscriptionWithDefaults instantiates a new Subscription 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 + +### GetId + +`func (o *Subscription) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Subscription) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Subscription) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *Subscription) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Subscription) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Subscription) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Subscription) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Subscription) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Subscription) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Subscription) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetTriggerId + +`func (o *Subscription) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *Subscription) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *Subscription) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + + +### GetTriggerName + +`func (o *Subscription) GetTriggerName() string` + +GetTriggerName returns the TriggerName field if non-nil, zero value otherwise. + +### GetTriggerNameOk + +`func (o *Subscription) GetTriggerNameOk() (*string, bool)` + +GetTriggerNameOk returns a tuple with the TriggerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerName + +`func (o *Subscription) SetTriggerName(v string)` + +SetTriggerName sets TriggerName field to given value. + + +### GetType + +`func (o *Subscription) GetType() SubscriptionType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Subscription) GetTypeOk() (*SubscriptionType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Subscription) SetType(v SubscriptionType)` + +SetType sets Type field to given value. + + +### GetResponseDeadline + +`func (o *Subscription) GetResponseDeadline() string` + +GetResponseDeadline returns the ResponseDeadline field if non-nil, zero value otherwise. + +### GetResponseDeadlineOk + +`func (o *Subscription) GetResponseDeadlineOk() (*string, bool)` + +GetResponseDeadlineOk returns a tuple with the ResponseDeadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseDeadline + +`func (o *Subscription) SetResponseDeadline(v string)` + +SetResponseDeadline sets ResponseDeadline field to given value. + +### HasResponseDeadline + +`func (o *Subscription) HasResponseDeadline() bool` + +HasResponseDeadline returns a boolean if a field has been set. + +### GetHttpConfig + +`func (o *Subscription) GetHttpConfig() HttpConfig` + +GetHttpConfig returns the HttpConfig field if non-nil, zero value otherwise. + +### GetHttpConfigOk + +`func (o *Subscription) GetHttpConfigOk() (*HttpConfig, bool)` + +GetHttpConfigOk returns a tuple with the HttpConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHttpConfig + +`func (o *Subscription) SetHttpConfig(v HttpConfig)` + +SetHttpConfig sets HttpConfig field to given value. + +### HasHttpConfig + +`func (o *Subscription) HasHttpConfig() bool` + +HasHttpConfig returns a boolean if a field has been set. + +### GetEventBridgeConfig + +`func (o *Subscription) GetEventBridgeConfig() EventBridgeConfig` + +GetEventBridgeConfig returns the EventBridgeConfig field if non-nil, zero value otherwise. + +### GetEventBridgeConfigOk + +`func (o *Subscription) GetEventBridgeConfigOk() (*EventBridgeConfig, bool)` + +GetEventBridgeConfigOk returns a tuple with the EventBridgeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventBridgeConfig + +`func (o *Subscription) SetEventBridgeConfig(v EventBridgeConfig)` + +SetEventBridgeConfig sets EventBridgeConfig field to given value. + +### HasEventBridgeConfig + +`func (o *Subscription) HasEventBridgeConfig() bool` + +HasEventBridgeConfig returns a boolean if a field has been set. + +### GetEnabled + +`func (o *Subscription) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *Subscription) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *Subscription) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetFilter + +`func (o *Subscription) GetFilter() string` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *Subscription) GetFilterOk() (*string, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *Subscription) SetFilter(v string)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *Subscription) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionPatchRequestInner.md b/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionPatchRequestInner.md new file mode 100644 index 000000000..34b883526 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionPatchRequestInner.md @@ -0,0 +1,106 @@ +--- +id: beta-subscription-patch-request-inner +title: SubscriptionPatchRequestInner +pagination_label: SubscriptionPatchRequestInner +sidebar_label: SubscriptionPatchRequestInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionPatchRequestInner', 'BetaSubscriptionPatchRequestInner'] +slug: /tools/sdk/go/beta/models/subscription-patch-request-inner +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInner', 'BetaSubscriptionPatchRequestInner'] +--- + +# SubscriptionPatchRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **string** | The operation to be performed | +**Path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | +**Value** | Pointer to [**SubscriptionPatchRequestInnerValue**](subscription-patch-request-inner-value) | | [optional] + +## Methods + +### NewSubscriptionPatchRequestInner + +`func NewSubscriptionPatchRequestInner(op string, path string, ) *SubscriptionPatchRequestInner` + +NewSubscriptionPatchRequestInner instantiates a new SubscriptionPatchRequestInner 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 + +### NewSubscriptionPatchRequestInnerWithDefaults + +`func NewSubscriptionPatchRequestInnerWithDefaults() *SubscriptionPatchRequestInner` + +NewSubscriptionPatchRequestInnerWithDefaults instantiates a new SubscriptionPatchRequestInner 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 + +### GetOp + +`func (o *SubscriptionPatchRequestInner) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *SubscriptionPatchRequestInner) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *SubscriptionPatchRequestInner) SetOp(v string)` + +SetOp sets Op field to given value. + + +### GetPath + +`func (o *SubscriptionPatchRequestInner) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *SubscriptionPatchRequestInner) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *SubscriptionPatchRequestInner) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetValue + +`func (o *SubscriptionPatchRequestInner) GetValue() SubscriptionPatchRequestInnerValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SubscriptionPatchRequestInner) GetValueOk() (*SubscriptionPatchRequestInnerValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SubscriptionPatchRequestInner) SetValue(v SubscriptionPatchRequestInnerValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SubscriptionPatchRequestInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionPatchRequestInnerValue.md b/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionPatchRequestInnerValue.md new file mode 100644 index 000000000..54741044b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionPatchRequestInnerValue.md @@ -0,0 +1,38 @@ +--- +id: beta-subscription-patch-request-inner-value +title: SubscriptionPatchRequestInnerValue +pagination_label: SubscriptionPatchRequestInnerValue +sidebar_label: SubscriptionPatchRequestInnerValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionPatchRequestInnerValue', 'BetaSubscriptionPatchRequestInnerValue'] +slug: /tools/sdk/go/beta/models/subscription-patch-request-inner-value +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInnerValue', 'BetaSubscriptionPatchRequestInnerValue'] +--- + +# SubscriptionPatchRequestInnerValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewSubscriptionPatchRequestInnerValue + +`func NewSubscriptionPatchRequestInnerValue() *SubscriptionPatchRequestInnerValue` + +NewSubscriptionPatchRequestInnerValue instantiates a new SubscriptionPatchRequestInnerValue 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 + +### NewSubscriptionPatchRequestInnerValueWithDefaults + +`func NewSubscriptionPatchRequestInnerValueWithDefaults() *SubscriptionPatchRequestInnerValue` + +NewSubscriptionPatchRequestInnerValueWithDefaults instantiates a new SubscriptionPatchRequestInnerValue 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 + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md b/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md new file mode 100644 index 000000000..98e7a7748 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md @@ -0,0 +1,38 @@ +--- +id: beta-subscription-patch-request-inner-value-any-of-inner +title: SubscriptionPatchRequestInnerValueAnyOfInner +pagination_label: SubscriptionPatchRequestInnerValueAnyOfInner +sidebar_label: SubscriptionPatchRequestInnerValueAnyOfInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionPatchRequestInnerValueAnyOfInner', 'BetaSubscriptionPatchRequestInnerValueAnyOfInner'] +slug: /tools/sdk/go/beta/models/subscription-patch-request-inner-value-any-of-inner +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInnerValueAnyOfInner', 'BetaSubscriptionPatchRequestInnerValueAnyOfInner'] +--- + +# SubscriptionPatchRequestInnerValueAnyOfInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewSubscriptionPatchRequestInnerValueAnyOfInner + +`func NewSubscriptionPatchRequestInnerValueAnyOfInner() *SubscriptionPatchRequestInnerValueAnyOfInner` + +NewSubscriptionPatchRequestInnerValueAnyOfInner instantiates a new SubscriptionPatchRequestInnerValueAnyOfInner 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 + +### NewSubscriptionPatchRequestInnerValueAnyOfInnerWithDefaults + +`func NewSubscriptionPatchRequestInnerValueAnyOfInnerWithDefaults() *SubscriptionPatchRequestInnerValueAnyOfInner` + +NewSubscriptionPatchRequestInnerValueAnyOfInnerWithDefaults instantiates a new SubscriptionPatchRequestInnerValueAnyOfInner 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 + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionPostRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionPostRequest.md new file mode 100644 index 000000000..26f1c1da7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionPostRequest.md @@ -0,0 +1,257 @@ +--- +id: beta-subscription-post-request +title: SubscriptionPostRequest +pagination_label: SubscriptionPostRequest +sidebar_label: SubscriptionPostRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionPostRequest', 'BetaSubscriptionPostRequest'] +slug: /tools/sdk/go/beta/models/subscription-post-request +tags: ['SDK', 'Software Development Kit', 'SubscriptionPostRequest', 'BetaSubscriptionPostRequest'] +--- + +# SubscriptionPostRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Subscription name. | +**Description** | Pointer to **string** | Subscription description. | [optional] +**TriggerId** | **string** | ID of trigger subscribed to. | +**Type** | [**SubscriptionType**](subscription-type) | | +**ResponseDeadline** | Pointer to **string** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] +**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] +**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] +**Enabled** | Pointer to **bool** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [optional] [default to true] +**Filter** | Pointer to **string** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] + +## Methods + +### NewSubscriptionPostRequest + +`func NewSubscriptionPostRequest(name string, triggerId string, type_ SubscriptionType, ) *SubscriptionPostRequest` + +NewSubscriptionPostRequest instantiates a new SubscriptionPostRequest 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 + +### NewSubscriptionPostRequestWithDefaults + +`func NewSubscriptionPostRequestWithDefaults() *SubscriptionPostRequest` + +NewSubscriptionPostRequestWithDefaults instantiates a new SubscriptionPostRequest 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 + +### GetName + +`func (o *SubscriptionPostRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SubscriptionPostRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SubscriptionPostRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *SubscriptionPostRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SubscriptionPostRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SubscriptionPostRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SubscriptionPostRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetTriggerId + +`func (o *SubscriptionPostRequest) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *SubscriptionPostRequest) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *SubscriptionPostRequest) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + + +### GetType + +`func (o *SubscriptionPostRequest) GetType() SubscriptionType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SubscriptionPostRequest) GetTypeOk() (*SubscriptionType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SubscriptionPostRequest) SetType(v SubscriptionType)` + +SetType sets Type field to given value. + + +### GetResponseDeadline + +`func (o *SubscriptionPostRequest) GetResponseDeadline() string` + +GetResponseDeadline returns the ResponseDeadline field if non-nil, zero value otherwise. + +### GetResponseDeadlineOk + +`func (o *SubscriptionPostRequest) GetResponseDeadlineOk() (*string, bool)` + +GetResponseDeadlineOk returns a tuple with the ResponseDeadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseDeadline + +`func (o *SubscriptionPostRequest) SetResponseDeadline(v string)` + +SetResponseDeadline sets ResponseDeadline field to given value. + +### HasResponseDeadline + +`func (o *SubscriptionPostRequest) HasResponseDeadline() bool` + +HasResponseDeadline returns a boolean if a field has been set. + +### GetHttpConfig + +`func (o *SubscriptionPostRequest) GetHttpConfig() HttpConfig` + +GetHttpConfig returns the HttpConfig field if non-nil, zero value otherwise. + +### GetHttpConfigOk + +`func (o *SubscriptionPostRequest) GetHttpConfigOk() (*HttpConfig, bool)` + +GetHttpConfigOk returns a tuple with the HttpConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHttpConfig + +`func (o *SubscriptionPostRequest) SetHttpConfig(v HttpConfig)` + +SetHttpConfig sets HttpConfig field to given value. + +### HasHttpConfig + +`func (o *SubscriptionPostRequest) HasHttpConfig() bool` + +HasHttpConfig returns a boolean if a field has been set. + +### GetEventBridgeConfig + +`func (o *SubscriptionPostRequest) GetEventBridgeConfig() EventBridgeConfig` + +GetEventBridgeConfig returns the EventBridgeConfig field if non-nil, zero value otherwise. + +### GetEventBridgeConfigOk + +`func (o *SubscriptionPostRequest) GetEventBridgeConfigOk() (*EventBridgeConfig, bool)` + +GetEventBridgeConfigOk returns a tuple with the EventBridgeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventBridgeConfig + +`func (o *SubscriptionPostRequest) SetEventBridgeConfig(v EventBridgeConfig)` + +SetEventBridgeConfig sets EventBridgeConfig field to given value. + +### HasEventBridgeConfig + +`func (o *SubscriptionPostRequest) HasEventBridgeConfig() bool` + +HasEventBridgeConfig returns a boolean if a field has been set. + +### GetEnabled + +`func (o *SubscriptionPostRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *SubscriptionPostRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *SubscriptionPostRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *SubscriptionPostRequest) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetFilter + +`func (o *SubscriptionPostRequest) GetFilter() string` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *SubscriptionPostRequest) GetFilterOk() (*string, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *SubscriptionPostRequest) SetFilter(v string)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *SubscriptionPostRequest) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionPutRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionPutRequest.md new file mode 100644 index 000000000..122c2d8a0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionPutRequest.md @@ -0,0 +1,246 @@ +--- +id: beta-subscription-put-request +title: SubscriptionPutRequest +pagination_label: SubscriptionPutRequest +sidebar_label: SubscriptionPutRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionPutRequest', 'BetaSubscriptionPutRequest'] +slug: /tools/sdk/go/beta/models/subscription-put-request +tags: ['SDK', 'Software Development Kit', 'SubscriptionPutRequest', 'BetaSubscriptionPutRequest'] +--- + +# SubscriptionPutRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Subscription name. | [optional] +**Description** | Pointer to **string** | Subscription description. | [optional] +**Type** | Pointer to [**SubscriptionType**](subscription-type) | | [optional] +**ResponseDeadline** | Pointer to **string** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] +**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] +**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] +**Enabled** | Pointer to **bool** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [optional] [default to true] +**Filter** | Pointer to **string** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] + +## Methods + +### NewSubscriptionPutRequest + +`func NewSubscriptionPutRequest() *SubscriptionPutRequest` + +NewSubscriptionPutRequest instantiates a new SubscriptionPutRequest 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 + +### NewSubscriptionPutRequestWithDefaults + +`func NewSubscriptionPutRequestWithDefaults() *SubscriptionPutRequest` + +NewSubscriptionPutRequestWithDefaults instantiates a new SubscriptionPutRequest 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 + +### GetName + +`func (o *SubscriptionPutRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SubscriptionPutRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SubscriptionPutRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SubscriptionPutRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *SubscriptionPutRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SubscriptionPutRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SubscriptionPutRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SubscriptionPutRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetType + +`func (o *SubscriptionPutRequest) GetType() SubscriptionType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SubscriptionPutRequest) GetTypeOk() (*SubscriptionType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SubscriptionPutRequest) SetType(v SubscriptionType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SubscriptionPutRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetResponseDeadline + +`func (o *SubscriptionPutRequest) GetResponseDeadline() string` + +GetResponseDeadline returns the ResponseDeadline field if non-nil, zero value otherwise. + +### GetResponseDeadlineOk + +`func (o *SubscriptionPutRequest) GetResponseDeadlineOk() (*string, bool)` + +GetResponseDeadlineOk returns a tuple with the ResponseDeadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseDeadline + +`func (o *SubscriptionPutRequest) SetResponseDeadline(v string)` + +SetResponseDeadline sets ResponseDeadline field to given value. + +### HasResponseDeadline + +`func (o *SubscriptionPutRequest) HasResponseDeadline() bool` + +HasResponseDeadline returns a boolean if a field has been set. + +### GetHttpConfig + +`func (o *SubscriptionPutRequest) GetHttpConfig() HttpConfig` + +GetHttpConfig returns the HttpConfig field if non-nil, zero value otherwise. + +### GetHttpConfigOk + +`func (o *SubscriptionPutRequest) GetHttpConfigOk() (*HttpConfig, bool)` + +GetHttpConfigOk returns a tuple with the HttpConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHttpConfig + +`func (o *SubscriptionPutRequest) SetHttpConfig(v HttpConfig)` + +SetHttpConfig sets HttpConfig field to given value. + +### HasHttpConfig + +`func (o *SubscriptionPutRequest) HasHttpConfig() bool` + +HasHttpConfig returns a boolean if a field has been set. + +### GetEventBridgeConfig + +`func (o *SubscriptionPutRequest) GetEventBridgeConfig() EventBridgeConfig` + +GetEventBridgeConfig returns the EventBridgeConfig field if non-nil, zero value otherwise. + +### GetEventBridgeConfigOk + +`func (o *SubscriptionPutRequest) GetEventBridgeConfigOk() (*EventBridgeConfig, bool)` + +GetEventBridgeConfigOk returns a tuple with the EventBridgeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventBridgeConfig + +`func (o *SubscriptionPutRequest) SetEventBridgeConfig(v EventBridgeConfig)` + +SetEventBridgeConfig sets EventBridgeConfig field to given value. + +### HasEventBridgeConfig + +`func (o *SubscriptionPutRequest) HasEventBridgeConfig() bool` + +HasEventBridgeConfig returns a boolean if a field has been set. + +### GetEnabled + +`func (o *SubscriptionPutRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *SubscriptionPutRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *SubscriptionPutRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *SubscriptionPutRequest) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetFilter + +`func (o *SubscriptionPutRequest) GetFilter() string` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *SubscriptionPutRequest) GetFilterOk() (*string, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *SubscriptionPutRequest) SetFilter(v string)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *SubscriptionPutRequest) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionType.md b/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionType.md new file mode 100644 index 000000000..51c03b369 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SubscriptionType.md @@ -0,0 +1,27 @@ +--- +id: beta-subscription-type +title: SubscriptionType +pagination_label: SubscriptionType +sidebar_label: SubscriptionType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionType', 'BetaSubscriptionType'] +slug: /tools/sdk/go/beta/models/subscription-type +tags: ['SDK', 'Software Development Kit', 'SubscriptionType', 'BetaSubscriptionType'] +--- + +# SubscriptionType + +## Enum + + +* `HTTP` (value: `"HTTP"`) + +* `EVENTBRIDGE` (value: `"EVENTBRIDGE"`) + +* `INLINE` (value: `"INLINE"`) + +* `SCRIPT` (value: `"SCRIPT"`) + +* `WORKFLOW` (value: `"WORKFLOW"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Tag.md b/docs/tools/sdk/go/Reference/Beta/Models/Tag.md new file mode 100644 index 000000000..30c03928f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Tag.md @@ -0,0 +1,143 @@ +--- +id: beta-tag +title: Tag +pagination_label: Tag +sidebar_label: Tag +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Tag', 'BetaTag'] +slug: /tools/sdk/go/beta/models/tag +tags: ['SDK', 'Software Development Kit', 'Tag', 'BetaTag'] +--- + +# Tag + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Tag id | [readonly] +**Name** | **string** | Name of the tag. | +**Created** | **SailPointTime** | Date the tag was created. | [readonly] +**Modified** | **SailPointTime** | Date the tag was last modified. | [readonly] +**TagCategoryRefs** | [**[]TagTagCategoryRefsInner**](tag-tag-category-refs-inner) | | [readonly] + +## Methods + +### NewTag + +`func NewTag(id string, name string, created SailPointTime, modified SailPointTime, tagCategoryRefs []TagTagCategoryRefsInner, ) *Tag` + +NewTag instantiates a new Tag 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 + +### NewTagWithDefaults + +`func NewTagWithDefaults() *Tag` + +NewTagWithDefaults instantiates a new Tag 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 + +### GetId + +`func (o *Tag) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Tag) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Tag) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *Tag) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Tag) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Tag) SetName(v string)` + +SetName sets Name field to given value. + + +### GetCreated + +`func (o *Tag) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Tag) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Tag) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *Tag) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Tag) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Tag) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetTagCategoryRefs + +`func (o *Tag) GetTagCategoryRefs() []TagTagCategoryRefsInner` + +GetTagCategoryRefs returns the TagCategoryRefs field if non-nil, zero value otherwise. + +### GetTagCategoryRefsOk + +`func (o *Tag) GetTagCategoryRefsOk() (*[]TagTagCategoryRefsInner, bool)` + +GetTagCategoryRefsOk returns a tuple with the TagCategoryRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTagCategoryRefs + +`func (o *Tag) SetTagCategoryRefs(v []TagTagCategoryRefsInner)` + +SetTagCategoryRefs sets TagCategoryRefs field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TagTagCategoryRefsInner.md b/docs/tools/sdk/go/Reference/Beta/Models/TagTagCategoryRefsInner.md new file mode 100644 index 000000000..b97cc91eb --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TagTagCategoryRefsInner.md @@ -0,0 +1,116 @@ +--- +id: beta-tag-tag-category-refs-inner +title: TagTagCategoryRefsInner +pagination_label: TagTagCategoryRefsInner +sidebar_label: TagTagCategoryRefsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TagTagCategoryRefsInner', 'BetaTagTagCategoryRefsInner'] +slug: /tools/sdk/go/beta/models/tag-tag-category-refs-inner +tags: ['SDK', 'Software Development Kit', 'TagTagCategoryRefsInner', 'BetaTagTagCategoryRefsInner'] +--- + +# TagTagCategoryRefsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of the tagged object's category. | [optional] +**Id** | Pointer to **string** | Tagged object's ID. | [optional] +**Name** | Pointer to **string** | Tagged object's display name. | [optional] + +## Methods + +### NewTagTagCategoryRefsInner + +`func NewTagTagCategoryRefsInner() *TagTagCategoryRefsInner` + +NewTagTagCategoryRefsInner instantiates a new TagTagCategoryRefsInner 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 + +### NewTagTagCategoryRefsInnerWithDefaults + +`func NewTagTagCategoryRefsInnerWithDefaults() *TagTagCategoryRefsInner` + +NewTagTagCategoryRefsInnerWithDefaults instantiates a new TagTagCategoryRefsInner 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 + +### GetType + +`func (o *TagTagCategoryRefsInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TagTagCategoryRefsInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TagTagCategoryRefsInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TagTagCategoryRefsInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *TagTagCategoryRefsInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TagTagCategoryRefsInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TagTagCategoryRefsInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TagTagCategoryRefsInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TagTagCategoryRefsInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TagTagCategoryRefsInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TagTagCategoryRefsInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TagTagCategoryRefsInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TaggedObject.md b/docs/tools/sdk/go/Reference/Beta/Models/TaggedObject.md new file mode 100644 index 000000000..940b58c58 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TaggedObject.md @@ -0,0 +1,90 @@ +--- +id: beta-tagged-object +title: TaggedObject +pagination_label: TaggedObject +sidebar_label: TaggedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaggedObject', 'BetaTaggedObject'] +slug: /tools/sdk/go/beta/models/tagged-object +tags: ['SDK', 'Software Development Kit', 'TaggedObject', 'BetaTaggedObject'] +--- + +# TaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRef** | Pointer to [**TaggedObjectObjectRef**](tagged-object-object-ref) | | [optional] +**Tags** | Pointer to **[]string** | Labels to be applied to an Object | [optional] + +## Methods + +### NewTaggedObject + +`func NewTaggedObject() *TaggedObject` + +NewTaggedObject instantiates a new TaggedObject 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 + +### NewTaggedObjectWithDefaults + +`func NewTaggedObjectWithDefaults() *TaggedObject` + +NewTaggedObjectWithDefaults instantiates a new TaggedObject 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 + +### GetObjectRef + +`func (o *TaggedObject) GetObjectRef() TaggedObjectObjectRef` + +GetObjectRef returns the ObjectRef field if non-nil, zero value otherwise. + +### GetObjectRefOk + +`func (o *TaggedObject) GetObjectRefOk() (*TaggedObjectObjectRef, bool)` + +GetObjectRefOk returns a tuple with the ObjectRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectRef + +`func (o *TaggedObject) SetObjectRef(v TaggedObjectObjectRef)` + +SetObjectRef sets ObjectRef field to given value. + +### HasObjectRef + +`func (o *TaggedObject) HasObjectRef() bool` + +HasObjectRef returns a boolean if a field has been set. + +### GetTags + +`func (o *TaggedObject) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *TaggedObject) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *TaggedObject) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *TaggedObject) HasTags() bool` + +HasTags returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TaggedObjectDto.md b/docs/tools/sdk/go/Reference/Beta/Models/TaggedObjectDto.md new file mode 100644 index 000000000..585c4f562 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TaggedObjectDto.md @@ -0,0 +1,126 @@ +--- +id: beta-tagged-object-dto +title: TaggedObjectDto +pagination_label: TaggedObjectDto +sidebar_label: TaggedObjectDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaggedObjectDto', 'BetaTaggedObjectDto'] +slug: /tools/sdk/go/beta/models/tagged-object-dto +tags: ['SDK', 'Software Development Kit', 'TaggedObjectDto', 'BetaTaggedObjectDto'] +--- + +# TaggedObjectDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type | [optional] +**Id** | Pointer to **string** | ID of the object this reference applies to | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the object this reference applies to | [optional] + +## Methods + +### NewTaggedObjectDto + +`func NewTaggedObjectDto() *TaggedObjectDto` + +NewTaggedObjectDto instantiates a new TaggedObjectDto 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 + +### NewTaggedObjectDtoWithDefaults + +`func NewTaggedObjectDtoWithDefaults() *TaggedObjectDto` + +NewTaggedObjectDtoWithDefaults instantiates a new TaggedObjectDto 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 + +### GetType + +`func (o *TaggedObjectDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaggedObjectDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaggedObjectDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaggedObjectDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *TaggedObjectDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaggedObjectDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaggedObjectDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaggedObjectDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TaggedObjectDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaggedObjectDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaggedObjectDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TaggedObjectDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *TaggedObjectDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *TaggedObjectDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TaggedObjectObjectRef.md b/docs/tools/sdk/go/Reference/Beta/Models/TaggedObjectObjectRef.md new file mode 100644 index 000000000..8b2b8e142 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TaggedObjectObjectRef.md @@ -0,0 +1,126 @@ +--- +id: beta-tagged-object-object-ref +title: TaggedObjectObjectRef +pagination_label: TaggedObjectObjectRef +sidebar_label: TaggedObjectObjectRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaggedObjectObjectRef', 'BetaTaggedObjectObjectRef'] +slug: /tools/sdk/go/beta/models/tagged-object-object-ref +tags: ['SDK', 'Software Development Kit', 'TaggedObjectObjectRef', 'BetaTaggedObjectObjectRef'] +--- + +# TaggedObjectObjectRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewTaggedObjectObjectRef + +`func NewTaggedObjectObjectRef() *TaggedObjectObjectRef` + +NewTaggedObjectObjectRef instantiates a new TaggedObjectObjectRef 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 + +### NewTaggedObjectObjectRefWithDefaults + +`func NewTaggedObjectObjectRefWithDefaults() *TaggedObjectObjectRef` + +NewTaggedObjectObjectRefWithDefaults instantiates a new TaggedObjectObjectRef 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 + +### GetType + +`func (o *TaggedObjectObjectRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaggedObjectObjectRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaggedObjectObjectRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaggedObjectObjectRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *TaggedObjectObjectRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaggedObjectObjectRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaggedObjectObjectRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaggedObjectObjectRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TaggedObjectObjectRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaggedObjectObjectRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaggedObjectObjectRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TaggedObjectObjectRef) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *TaggedObjectObjectRef) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *TaggedObjectObjectRef) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Target.md b/docs/tools/sdk/go/Reference/Beta/Models/Target.md new file mode 100644 index 000000000..a6e62b595 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Target.md @@ -0,0 +1,126 @@ +--- +id: beta-target +title: Target +pagination_label: Target +sidebar_label: Target +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Target', 'BetaTarget'] +slug: /tools/sdk/go/beta/models/target +tags: ['SDK', 'Software Development Kit', 'Target', 'BetaTarget'] +--- + +# Target + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Target ID | [optional] +**Type** | Pointer to **NullableString** | Target type | [optional] +**Name** | Pointer to **string** | Target name | [optional] + +## Methods + +### NewTarget + +`func NewTarget() *Target` + +NewTarget instantiates a new Target 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 + +### NewTargetWithDefaults + +`func NewTargetWithDefaults() *Target` + +NewTargetWithDefaults instantiates a new Target 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 + +### GetId + +`func (o *Target) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Target) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Target) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Target) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *Target) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Target) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Target) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Target) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *Target) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *Target) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetName + +`func (o *Target) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Target) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Target) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Target) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TaskDefinitionSummary.md b/docs/tools/sdk/go/Reference/Beta/Models/TaskDefinitionSummary.md new file mode 100644 index 000000000..c52275f46 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TaskDefinitionSummary.md @@ -0,0 +1,184 @@ +--- +id: beta-task-definition-summary +title: TaskDefinitionSummary +pagination_label: TaskDefinitionSummary +sidebar_label: TaskDefinitionSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskDefinitionSummary', 'BetaTaskDefinitionSummary'] +slug: /tools/sdk/go/beta/models/task-definition-summary +tags: ['SDK', 'Software Development Kit', 'TaskDefinitionSummary', 'BetaTaskDefinitionSummary'] +--- + +# TaskDefinitionSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | System-generated unique ID of the TaskDefinition | +**UniqueName** | **string** | Name of the TaskDefinition | +**Description** | **NullableString** | Description of the TaskDefinition | +**ParentName** | **string** | Name of the parent of the TaskDefinition | +**Executor** | **NullableString** | Executor of the TaskDefinition | +**Arguments** | **map[string]interface{}** | Formal parameters of the TaskDefinition, without values | + +## Methods + +### NewTaskDefinitionSummary + +`func NewTaskDefinitionSummary(id string, uniqueName string, description NullableString, parentName string, executor NullableString, arguments map[string]interface{}, ) *TaskDefinitionSummary` + +NewTaskDefinitionSummary instantiates a new TaskDefinitionSummary 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 + +### NewTaskDefinitionSummaryWithDefaults + +`func NewTaskDefinitionSummaryWithDefaults() *TaskDefinitionSummary` + +NewTaskDefinitionSummaryWithDefaults instantiates a new TaskDefinitionSummary 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 + +### GetId + +`func (o *TaskDefinitionSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskDefinitionSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskDefinitionSummary) SetId(v string)` + +SetId sets Id field to given value. + + +### GetUniqueName + +`func (o *TaskDefinitionSummary) GetUniqueName() string` + +GetUniqueName returns the UniqueName field if non-nil, zero value otherwise. + +### GetUniqueNameOk + +`func (o *TaskDefinitionSummary) GetUniqueNameOk() (*string, bool)` + +GetUniqueNameOk returns a tuple with the UniqueName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUniqueName + +`func (o *TaskDefinitionSummary) SetUniqueName(v string)` + +SetUniqueName sets UniqueName field to given value. + + +### GetDescription + +`func (o *TaskDefinitionSummary) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TaskDefinitionSummary) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TaskDefinitionSummary) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *TaskDefinitionSummary) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *TaskDefinitionSummary) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetParentName + +`func (o *TaskDefinitionSummary) GetParentName() string` + +GetParentName returns the ParentName field if non-nil, zero value otherwise. + +### GetParentNameOk + +`func (o *TaskDefinitionSummary) GetParentNameOk() (*string, bool)` + +GetParentNameOk returns a tuple with the ParentName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentName + +`func (o *TaskDefinitionSummary) SetParentName(v string)` + +SetParentName sets ParentName field to given value. + + +### GetExecutor + +`func (o *TaskDefinitionSummary) GetExecutor() string` + +GetExecutor returns the Executor field if non-nil, zero value otherwise. + +### GetExecutorOk + +`func (o *TaskDefinitionSummary) GetExecutorOk() (*string, bool)` + +GetExecutorOk returns a tuple with the Executor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExecutor + +`func (o *TaskDefinitionSummary) SetExecutor(v string)` + +SetExecutor sets Executor field to given value. + + +### SetExecutorNil + +`func (o *TaskDefinitionSummary) SetExecutorNil(b bool)` + + SetExecutorNil sets the value for Executor to be an explicit nil + +### UnsetExecutor +`func (o *TaskDefinitionSummary) UnsetExecutor()` + +UnsetExecutor ensures that no value is present for Executor, not even an explicit nil +### GetArguments + +`func (o *TaskDefinitionSummary) GetArguments() map[string]interface{}` + +GetArguments returns the Arguments field if non-nil, zero value otherwise. + +### GetArgumentsOk + +`func (o *TaskDefinitionSummary) GetArgumentsOk() (*map[string]interface{}, bool)` + +GetArgumentsOk returns a tuple with the Arguments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArguments + +`func (o *TaskDefinitionSummary) SetArguments(v map[string]interface{})` + +SetArguments sets Arguments field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TaskResultDto.md b/docs/tools/sdk/go/Reference/Beta/Models/TaskResultDto.md new file mode 100644 index 000000000..f0242e6c6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TaskResultDto.md @@ -0,0 +1,126 @@ +--- +id: beta-task-result-dto +title: TaskResultDto +pagination_label: TaskResultDto +sidebar_label: TaskResultDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultDto', 'BetaTaskResultDto'] +slug: /tools/sdk/go/beta/models/task-result-dto +tags: ['SDK', 'Software Development Kit', 'TaskResultDto', 'BetaTaskResultDto'] +--- + +# TaskResultDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Task result DTO type. | [optional] +**Id** | Pointer to **string** | Task result ID. | [optional] +**Name** | Pointer to **NullableString** | Task result display name. | [optional] + +## Methods + +### NewTaskResultDto + +`func NewTaskResultDto() *TaskResultDto` + +NewTaskResultDto instantiates a new TaskResultDto 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 + +### NewTaskResultDtoWithDefaults + +`func NewTaskResultDtoWithDefaults() *TaskResultDto` + +NewTaskResultDtoWithDefaults instantiates a new TaskResultDto 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 + +### GetType + +`func (o *TaskResultDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskResultDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskResultDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaskResultDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *TaskResultDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskResultDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskResultDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaskResultDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TaskResultDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaskResultDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaskResultDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TaskResultDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *TaskResultDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *TaskResultDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TaskResultResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/TaskResultResponse.md new file mode 100644 index 000000000..bcd195b98 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TaskResultResponse.md @@ -0,0 +1,116 @@ +--- +id: beta-task-result-response +title: TaskResultResponse +pagination_label: TaskResultResponse +sidebar_label: TaskResultResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultResponse', 'BetaTaskResultResponse'] +slug: /tools/sdk/go/beta/models/task-result-response +tags: ['SDK', 'Software Development Kit', 'TaskResultResponse', 'BetaTaskResultResponse'] +--- + +# TaskResultResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | the type of response reference | [optional] +**Id** | Pointer to **string** | the task ID | [optional] +**Name** | Pointer to **string** | the task name (not used in this endpoint, always null) | [optional] + +## Methods + +### NewTaskResultResponse + +`func NewTaskResultResponse() *TaskResultResponse` + +NewTaskResultResponse instantiates a new TaskResultResponse 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 + +### NewTaskResultResponseWithDefaults + +`func NewTaskResultResponseWithDefaults() *TaskResultResponse` + +NewTaskResultResponseWithDefaults instantiates a new TaskResultResponse 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 + +### GetType + +`func (o *TaskResultResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskResultResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskResultResponse) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaskResultResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *TaskResultResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskResultResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskResultResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaskResultResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TaskResultResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaskResultResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaskResultResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TaskResultResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TaskResultSimplified.md b/docs/tools/sdk/go/Reference/Beta/Models/TaskResultSimplified.md new file mode 100644 index 000000000..27d3b4233 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TaskResultSimplified.md @@ -0,0 +1,220 @@ +--- +id: beta-task-result-simplified +title: TaskResultSimplified +pagination_label: TaskResultSimplified +sidebar_label: TaskResultSimplified +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultSimplified', 'BetaTaskResultSimplified'] +slug: /tools/sdk/go/beta/models/task-result-simplified +tags: ['SDK', 'Software Development Kit', 'TaskResultSimplified', 'BetaTaskResultSimplified'] +--- + +# TaskResultSimplified + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Task identifier | [optional] +**Name** | Pointer to **string** | Task name | [optional] +**Description** | Pointer to **string** | Task description | [optional] +**Launcher** | Pointer to **string** | User or process who launched the task | [optional] +**Completed** | Pointer to **SailPointTime** | Date time of completion | [optional] +**Launched** | Pointer to **SailPointTime** | Date time when the task was launched | [optional] +**CompletionStatus** | Pointer to **string** | Task result status | [optional] + +## Methods + +### NewTaskResultSimplified + +`func NewTaskResultSimplified() *TaskResultSimplified` + +NewTaskResultSimplified instantiates a new TaskResultSimplified 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 + +### NewTaskResultSimplifiedWithDefaults + +`func NewTaskResultSimplifiedWithDefaults() *TaskResultSimplified` + +NewTaskResultSimplifiedWithDefaults instantiates a new TaskResultSimplified 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 + +### GetId + +`func (o *TaskResultSimplified) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskResultSimplified) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskResultSimplified) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaskResultSimplified) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TaskResultSimplified) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaskResultSimplified) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaskResultSimplified) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TaskResultSimplified) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *TaskResultSimplified) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TaskResultSimplified) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TaskResultSimplified) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *TaskResultSimplified) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetLauncher + +`func (o *TaskResultSimplified) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *TaskResultSimplified) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *TaskResultSimplified) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + +### HasLauncher + +`func (o *TaskResultSimplified) HasLauncher() bool` + +HasLauncher returns a boolean if a field has been set. + +### GetCompleted + +`func (o *TaskResultSimplified) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *TaskResultSimplified) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *TaskResultSimplified) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *TaskResultSimplified) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetLaunched + +`func (o *TaskResultSimplified) GetLaunched() SailPointTime` + +GetLaunched returns the Launched field if non-nil, zero value otherwise. + +### GetLaunchedOk + +`func (o *TaskResultSimplified) GetLaunchedOk() (*SailPointTime, bool)` + +GetLaunchedOk returns a tuple with the Launched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunched + +`func (o *TaskResultSimplified) SetLaunched(v SailPointTime)` + +SetLaunched sets Launched field to given value. + +### HasLaunched + +`func (o *TaskResultSimplified) HasLaunched() bool` + +HasLaunched returns a boolean if a field has been set. + +### GetCompletionStatus + +`func (o *TaskResultSimplified) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *TaskResultSimplified) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *TaskResultSimplified) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *TaskResultSimplified) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TaskReturnDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/TaskReturnDetails.md new file mode 100644 index 000000000..6b7b258cd --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TaskReturnDetails.md @@ -0,0 +1,80 @@ +--- +id: beta-task-return-details +title: TaskReturnDetails +pagination_label: TaskReturnDetails +sidebar_label: TaskReturnDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskReturnDetails', 'BetaTaskReturnDetails'] +slug: /tools/sdk/go/beta/models/task-return-details +tags: ['SDK', 'Software Development Kit', 'TaskReturnDetails', 'BetaTaskReturnDetails'] +--- + +# TaskReturnDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Display name of the TaskReturnDetails | +**AttributeName** | **string** | Attribute the TaskReturnDetails is for | + +## Methods + +### NewTaskReturnDetails + +`func NewTaskReturnDetails(name string, attributeName string, ) *TaskReturnDetails` + +NewTaskReturnDetails instantiates a new TaskReturnDetails 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 + +### NewTaskReturnDetailsWithDefaults + +`func NewTaskReturnDetailsWithDefaults() *TaskReturnDetails` + +NewTaskReturnDetailsWithDefaults instantiates a new TaskReturnDetails 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 + +### GetName + +`func (o *TaskReturnDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaskReturnDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaskReturnDetails) SetName(v string)` + +SetName sets Name field to given value. + + +### GetAttributeName + +`func (o *TaskReturnDetails) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *TaskReturnDetails) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *TaskReturnDetails) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TaskStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/TaskStatus.md new file mode 100644 index 000000000..bc4859eca --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TaskStatus.md @@ -0,0 +1,486 @@ +--- +id: beta-task-status +title: TaskStatus +pagination_label: TaskStatus +sidebar_label: TaskStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskStatus', 'BetaTaskStatus'] +slug: /tools/sdk/go/beta/models/task-status +tags: ['SDK', 'Software Development Kit', 'TaskStatus', 'BetaTaskStatus'] +--- + +# TaskStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | System-generated unique ID of the task this TaskStatus represents | +**Type** | **string** | Type of task this TaskStatus represents | +**UniqueName** | **string** | Name of the task this TaskStatus represents | +**Description** | **string** | Description of the task this TaskStatus represents | +**ParentName** | **NullableString** | Name of the parent of the task this TaskStatus represents | +**Launcher** | **string** | Service to execute the task this TaskStatus represents | +**Target** | Pointer to [**NullableTarget**](target) | | [optional] +**Created** | **SailPointTime** | Creation date of the task this TaskStatus represents | +**Modified** | **SailPointTime** | Last modification date of the task this TaskStatus represents | +**Launched** | **NullableTime** | Launch date of the task this TaskStatus represents | +**Completed** | **NullableTime** | Completion date of the task this TaskStatus represents | +**CompletionStatus** | **NullableString** | Completion status of the task this TaskStatus represents | +**Messages** | [**[]TaskStatusMessage**](task-status-message) | Messages associated with the task this TaskStatus represents | +**Returns** | [**[]TaskReturnDetails**](task-return-details) | Return values from the task this TaskStatus represents | +**Attributes** | **map[string]interface{}** | Attributes of the task this TaskStatus represents | +**Progress** | **NullableString** | Current progress of the task this TaskStatus represents | +**PercentComplete** | **int32** | Current percentage completion of the task this TaskStatus represents | +**TaskDefinitionSummary** | Pointer to [**TaskDefinitionSummary**](task-definition-summary) | | [optional] + +## Methods + +### NewTaskStatus + +`func NewTaskStatus(id string, type_ string, uniqueName string, description string, parentName NullableString, launcher string, created SailPointTime, modified SailPointTime, launched NullableTime, completed NullableTime, completionStatus NullableString, messages []TaskStatusMessage, returns []TaskReturnDetails, attributes map[string]interface{}, progress NullableString, percentComplete int32, ) *TaskStatus` + +NewTaskStatus instantiates a new TaskStatus 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 + +### NewTaskStatusWithDefaults + +`func NewTaskStatusWithDefaults() *TaskStatus` + +NewTaskStatusWithDefaults instantiates a new TaskStatus 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 + +### GetId + +`func (o *TaskStatus) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskStatus) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskStatus) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *TaskStatus) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskStatus) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskStatus) SetType(v string)` + +SetType sets Type field to given value. + + +### GetUniqueName + +`func (o *TaskStatus) GetUniqueName() string` + +GetUniqueName returns the UniqueName field if non-nil, zero value otherwise. + +### GetUniqueNameOk + +`func (o *TaskStatus) GetUniqueNameOk() (*string, bool)` + +GetUniqueNameOk returns a tuple with the UniqueName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUniqueName + +`func (o *TaskStatus) SetUniqueName(v string)` + +SetUniqueName sets UniqueName field to given value. + + +### GetDescription + +`func (o *TaskStatus) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TaskStatus) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TaskStatus) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetParentName + +`func (o *TaskStatus) GetParentName() string` + +GetParentName returns the ParentName field if non-nil, zero value otherwise. + +### GetParentNameOk + +`func (o *TaskStatus) GetParentNameOk() (*string, bool)` + +GetParentNameOk returns a tuple with the ParentName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentName + +`func (o *TaskStatus) SetParentName(v string)` + +SetParentName sets ParentName field to given value. + + +### SetParentNameNil + +`func (o *TaskStatus) SetParentNameNil(b bool)` + + SetParentNameNil sets the value for ParentName to be an explicit nil + +### UnsetParentName +`func (o *TaskStatus) UnsetParentName()` + +UnsetParentName ensures that no value is present for ParentName, not even an explicit nil +### GetLauncher + +`func (o *TaskStatus) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *TaskStatus) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *TaskStatus) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + + +### GetTarget + +`func (o *TaskStatus) GetTarget() Target` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *TaskStatus) GetTargetOk() (*Target, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *TaskStatus) SetTarget(v Target)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *TaskStatus) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + +### SetTargetNil + +`func (o *TaskStatus) SetTargetNil(b bool)` + + SetTargetNil sets the value for Target to be an explicit nil + +### UnsetTarget +`func (o *TaskStatus) UnsetTarget()` + +UnsetTarget ensures that no value is present for Target, not even an explicit nil +### GetCreated + +`func (o *TaskStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *TaskStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *TaskStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *TaskStatus) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *TaskStatus) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *TaskStatus) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetLaunched + +`func (o *TaskStatus) GetLaunched() SailPointTime` + +GetLaunched returns the Launched field if non-nil, zero value otherwise. + +### GetLaunchedOk + +`func (o *TaskStatus) GetLaunchedOk() (*SailPointTime, bool)` + +GetLaunchedOk returns a tuple with the Launched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunched + +`func (o *TaskStatus) SetLaunched(v SailPointTime)` + +SetLaunched sets Launched field to given value. + + +### SetLaunchedNil + +`func (o *TaskStatus) SetLaunchedNil(b bool)` + + SetLaunchedNil sets the value for Launched to be an explicit nil + +### UnsetLaunched +`func (o *TaskStatus) UnsetLaunched()` + +UnsetLaunched ensures that no value is present for Launched, not even an explicit nil +### GetCompleted + +`func (o *TaskStatus) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *TaskStatus) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *TaskStatus) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + + +### SetCompletedNil + +`func (o *TaskStatus) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *TaskStatus) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetCompletionStatus + +`func (o *TaskStatus) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *TaskStatus) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *TaskStatus) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + + +### SetCompletionStatusNil + +`func (o *TaskStatus) SetCompletionStatusNil(b bool)` + + SetCompletionStatusNil sets the value for CompletionStatus to be an explicit nil + +### UnsetCompletionStatus +`func (o *TaskStatus) UnsetCompletionStatus()` + +UnsetCompletionStatus ensures that no value is present for CompletionStatus, not even an explicit nil +### GetMessages + +`func (o *TaskStatus) GetMessages() []TaskStatusMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *TaskStatus) GetMessagesOk() (*[]TaskStatusMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *TaskStatus) SetMessages(v []TaskStatusMessage)` + +SetMessages sets Messages field to given value. + + +### GetReturns + +`func (o *TaskStatus) GetReturns() []TaskReturnDetails` + +GetReturns returns the Returns field if non-nil, zero value otherwise. + +### GetReturnsOk + +`func (o *TaskStatus) GetReturnsOk() (*[]TaskReturnDetails, bool)` + +GetReturnsOk returns a tuple with the Returns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReturns + +`func (o *TaskStatus) SetReturns(v []TaskReturnDetails)` + +SetReturns sets Returns field to given value. + + +### GetAttributes + +`func (o *TaskStatus) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TaskStatus) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TaskStatus) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetProgress + +`func (o *TaskStatus) GetProgress() string` + +GetProgress returns the Progress field if non-nil, zero value otherwise. + +### GetProgressOk + +`func (o *TaskStatus) GetProgressOk() (*string, bool)` + +GetProgressOk returns a tuple with the Progress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProgress + +`func (o *TaskStatus) SetProgress(v string)` + +SetProgress sets Progress field to given value. + + +### SetProgressNil + +`func (o *TaskStatus) SetProgressNil(b bool)` + + SetProgressNil sets the value for Progress to be an explicit nil + +### UnsetProgress +`func (o *TaskStatus) UnsetProgress()` + +UnsetProgress ensures that no value is present for Progress, not even an explicit nil +### GetPercentComplete + +`func (o *TaskStatus) GetPercentComplete() int32` + +GetPercentComplete returns the PercentComplete field if non-nil, zero value otherwise. + +### GetPercentCompleteOk + +`func (o *TaskStatus) GetPercentCompleteOk() (*int32, bool)` + +GetPercentCompleteOk returns a tuple with the PercentComplete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPercentComplete + +`func (o *TaskStatus) SetPercentComplete(v int32)` + +SetPercentComplete sets PercentComplete field to given value. + + +### GetTaskDefinitionSummary + +`func (o *TaskStatus) GetTaskDefinitionSummary() TaskDefinitionSummary` + +GetTaskDefinitionSummary returns the TaskDefinitionSummary field if non-nil, zero value otherwise. + +### GetTaskDefinitionSummaryOk + +`func (o *TaskStatus) GetTaskDefinitionSummaryOk() (*TaskDefinitionSummary, bool)` + +GetTaskDefinitionSummaryOk returns a tuple with the TaskDefinitionSummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskDefinitionSummary + +`func (o *TaskStatus) SetTaskDefinitionSummary(v TaskDefinitionSummary)` + +SetTaskDefinitionSummary sets TaskDefinitionSummary field to given value. + +### HasTaskDefinitionSummary + +`func (o *TaskStatus) HasTaskDefinitionSummary() bool` + +HasTaskDefinitionSummary returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TaskStatusMessage.md b/docs/tools/sdk/go/Reference/Beta/Models/TaskStatusMessage.md new file mode 100644 index 000000000..bccde0952 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TaskStatusMessage.md @@ -0,0 +1,142 @@ +--- +id: beta-task-status-message +title: TaskStatusMessage +pagination_label: TaskStatusMessage +sidebar_label: TaskStatusMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskStatusMessage', 'BetaTaskStatusMessage'] +slug: /tools/sdk/go/beta/models/task-status-message +tags: ['SDK', 'Software Development Kit', 'TaskStatusMessage', 'BetaTaskStatusMessage'] +--- + +# TaskStatusMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of the message | +**LocalizedText** | [**NullableLocalizedMessage**](localized-message) | | +**Key** | **string** | Key of the message | +**Parameters** | [**[]TaskStatusMessageParametersInner**](task-status-message-parameters-inner) | Message parameters for internationalization | + +## Methods + +### NewTaskStatusMessage + +`func NewTaskStatusMessage(type_ string, localizedText NullableLocalizedMessage, key string, parameters []TaskStatusMessageParametersInner, ) *TaskStatusMessage` + +NewTaskStatusMessage instantiates a new TaskStatusMessage 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 + +### NewTaskStatusMessageWithDefaults + +`func NewTaskStatusMessageWithDefaults() *TaskStatusMessage` + +NewTaskStatusMessageWithDefaults instantiates a new TaskStatusMessage 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 + +### GetType + +`func (o *TaskStatusMessage) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskStatusMessage) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskStatusMessage) SetType(v string)` + +SetType sets Type field to given value. + + +### GetLocalizedText + +`func (o *TaskStatusMessage) GetLocalizedText() LocalizedMessage` + +GetLocalizedText returns the LocalizedText field if non-nil, zero value otherwise. + +### GetLocalizedTextOk + +`func (o *TaskStatusMessage) GetLocalizedTextOk() (*LocalizedMessage, bool)` + +GetLocalizedTextOk returns a tuple with the LocalizedText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizedText + +`func (o *TaskStatusMessage) SetLocalizedText(v LocalizedMessage)` + +SetLocalizedText sets LocalizedText field to given value. + + +### SetLocalizedTextNil + +`func (o *TaskStatusMessage) SetLocalizedTextNil(b bool)` + + SetLocalizedTextNil sets the value for LocalizedText to be an explicit nil + +### UnsetLocalizedText +`func (o *TaskStatusMessage) UnsetLocalizedText()` + +UnsetLocalizedText ensures that no value is present for LocalizedText, not even an explicit nil +### GetKey + +`func (o *TaskStatusMessage) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TaskStatusMessage) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TaskStatusMessage) SetKey(v string)` + +SetKey sets Key field to given value. + + +### GetParameters + +`func (o *TaskStatusMessage) GetParameters() []TaskStatusMessageParametersInner` + +GetParameters returns the Parameters field if non-nil, zero value otherwise. + +### GetParametersOk + +`func (o *TaskStatusMessage) GetParametersOk() (*[]TaskStatusMessageParametersInner, bool)` + +GetParametersOk returns a tuple with the Parameters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParameters + +`func (o *TaskStatusMessage) SetParameters(v []TaskStatusMessageParametersInner)` + +SetParameters sets Parameters field to given value. + + +### SetParametersNil + +`func (o *TaskStatusMessage) SetParametersNil(b bool)` + + SetParametersNil sets the value for Parameters to be an explicit nil + +### UnsetParameters +`func (o *TaskStatusMessage) UnsetParameters()` + +UnsetParameters ensures that no value is present for Parameters, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TaskStatusMessageParametersInner.md b/docs/tools/sdk/go/Reference/Beta/Models/TaskStatusMessageParametersInner.md new file mode 100644 index 000000000..34d29df46 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TaskStatusMessageParametersInner.md @@ -0,0 +1,38 @@ +--- +id: beta-task-status-message-parameters-inner +title: TaskStatusMessageParametersInner +pagination_label: TaskStatusMessageParametersInner +sidebar_label: TaskStatusMessageParametersInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskStatusMessageParametersInner', 'BetaTaskStatusMessageParametersInner'] +slug: /tools/sdk/go/beta/models/task-status-message-parameters-inner +tags: ['SDK', 'Software Development Kit', 'TaskStatusMessageParametersInner', 'BetaTaskStatusMessageParametersInner'] +--- + +# TaskStatusMessageParametersInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewTaskStatusMessageParametersInner + +`func NewTaskStatusMessageParametersInner() *TaskStatusMessageParametersInner` + +NewTaskStatusMessageParametersInner instantiates a new TaskStatusMessageParametersInner 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 + +### NewTaskStatusMessageParametersInnerWithDefaults + +`func NewTaskStatusMessageParametersInnerWithDefaults() *TaskStatusMessageParametersInner` + +NewTaskStatusMessageParametersInnerWithDefaults instantiates a new TaskStatusMessageParametersInner 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 + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TemplateBulkDeleteDto.md b/docs/tools/sdk/go/Reference/Beta/Models/TemplateBulkDeleteDto.md new file mode 100644 index 000000000..04ebb62b7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TemplateBulkDeleteDto.md @@ -0,0 +1,111 @@ +--- +id: beta-template-bulk-delete-dto +title: TemplateBulkDeleteDto +pagination_label: TemplateBulkDeleteDto +sidebar_label: TemplateBulkDeleteDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateBulkDeleteDto', 'BetaTemplateBulkDeleteDto'] +slug: /tools/sdk/go/beta/models/template-bulk-delete-dto +tags: ['SDK', 'Software Development Kit', 'TemplateBulkDeleteDto', 'BetaTemplateBulkDeleteDto'] +--- + +# TemplateBulkDeleteDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **string** | | +**Medium** | Pointer to **string** | | [optional] +**Locale** | Pointer to **string** | The locale for the message text, a BCP 47 language tag. | [optional] + +## Methods + +### NewTemplateBulkDeleteDto + +`func NewTemplateBulkDeleteDto(key string, ) *TemplateBulkDeleteDto` + +NewTemplateBulkDeleteDto instantiates a new TemplateBulkDeleteDto 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 + +### NewTemplateBulkDeleteDtoWithDefaults + +`func NewTemplateBulkDeleteDtoWithDefaults() *TemplateBulkDeleteDto` + +NewTemplateBulkDeleteDtoWithDefaults instantiates a new TemplateBulkDeleteDto 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 + +### GetKey + +`func (o *TemplateBulkDeleteDto) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TemplateBulkDeleteDto) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TemplateBulkDeleteDto) SetKey(v string)` + +SetKey sets Key field to given value. + + +### GetMedium + +`func (o *TemplateBulkDeleteDto) GetMedium() string` + +GetMedium returns the Medium field if non-nil, zero value otherwise. + +### GetMediumOk + +`func (o *TemplateBulkDeleteDto) GetMediumOk() (*string, bool)` + +GetMediumOk returns a tuple with the Medium field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMedium + +`func (o *TemplateBulkDeleteDto) SetMedium(v string)` + +SetMedium sets Medium field to given value. + +### HasMedium + +`func (o *TemplateBulkDeleteDto) HasMedium() bool` + +HasMedium returns a boolean if a field has been set. + +### GetLocale + +`func (o *TemplateBulkDeleteDto) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *TemplateBulkDeleteDto) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *TemplateBulkDeleteDto) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *TemplateBulkDeleteDto) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TemplateDto.md b/docs/tools/sdk/go/Reference/Beta/Models/TemplateDto.md new file mode 100644 index 000000000..2e5655f56 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TemplateDto.md @@ -0,0 +1,479 @@ +--- +id: beta-template-dto +title: TemplateDto +pagination_label: TemplateDto +sidebar_label: TemplateDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateDto', 'BetaTemplateDto'] +slug: /tools/sdk/go/beta/models/template-dto +tags: ['SDK', 'Software Development Kit', 'TemplateDto', 'BetaTemplateDto'] +--- + +# TemplateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **string** | The key of the template | +**Name** | Pointer to **string** | The name of the Task Manager Subscription | [optional] +**Medium** | **string** | The message medium. More mediums may be added in the future. | +**Locale** | **string** | The locale for the message text, a BCP 47 language tag. | +**Subject** | Pointer to **string** | The subject line in the template | [optional] +**Header** | Pointer to **NullableString** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**Body** | Pointer to **string** | The body in the template | [optional] +**Footer** | Pointer to **NullableString** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**From** | Pointer to **string** | The \"From:\" address in the template | [optional] +**ReplyTo** | Pointer to **string** | The \"Reply To\" line in the template | [optional] +**Description** | Pointer to **string** | The description in the template | [optional] +**Id** | Pointer to **string** | This is auto-generated. | [optional] +**Created** | Pointer to **SailPointTime** | The time when this template is created. This is auto-generated. | [optional] +**Modified** | Pointer to **SailPointTime** | The time when this template was last modified. This is auto-generated. | [optional] +**SlackTemplate** | Pointer to **NullableString** | | [optional] +**TeamsTemplate** | Pointer to **NullableString** | | [optional] + +## Methods + +### NewTemplateDto + +`func NewTemplateDto(key string, medium string, locale string, ) *TemplateDto` + +NewTemplateDto instantiates a new TemplateDto 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 + +### NewTemplateDtoWithDefaults + +`func NewTemplateDtoWithDefaults() *TemplateDto` + +NewTemplateDtoWithDefaults instantiates a new TemplateDto 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 + +### GetKey + +`func (o *TemplateDto) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TemplateDto) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TemplateDto) SetKey(v string)` + +SetKey sets Key field to given value. + + +### GetName + +`func (o *TemplateDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TemplateDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TemplateDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TemplateDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetMedium + +`func (o *TemplateDto) GetMedium() string` + +GetMedium returns the Medium field if non-nil, zero value otherwise. + +### GetMediumOk + +`func (o *TemplateDto) GetMediumOk() (*string, bool)` + +GetMediumOk returns a tuple with the Medium field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMedium + +`func (o *TemplateDto) SetMedium(v string)` + +SetMedium sets Medium field to given value. + + +### GetLocale + +`func (o *TemplateDto) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *TemplateDto) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *TemplateDto) SetLocale(v string)` + +SetLocale sets Locale field to given value. + + +### GetSubject + +`func (o *TemplateDto) GetSubject() string` + +GetSubject returns the Subject field if non-nil, zero value otherwise. + +### GetSubjectOk + +`func (o *TemplateDto) GetSubjectOk() (*string, bool)` + +GetSubjectOk returns a tuple with the Subject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubject + +`func (o *TemplateDto) SetSubject(v string)` + +SetSubject sets Subject field to given value. + +### HasSubject + +`func (o *TemplateDto) HasSubject() bool` + +HasSubject returns a boolean if a field has been set. + +### GetHeader + +`func (o *TemplateDto) GetHeader() string` + +GetHeader returns the Header field if non-nil, zero value otherwise. + +### GetHeaderOk + +`func (o *TemplateDto) GetHeaderOk() (*string, bool)` + +GetHeaderOk returns a tuple with the Header field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHeader + +`func (o *TemplateDto) SetHeader(v string)` + +SetHeader sets Header field to given value. + +### HasHeader + +`func (o *TemplateDto) HasHeader() bool` + +HasHeader returns a boolean if a field has been set. + +### SetHeaderNil + +`func (o *TemplateDto) SetHeaderNil(b bool)` + + SetHeaderNil sets the value for Header to be an explicit nil + +### UnsetHeader +`func (o *TemplateDto) UnsetHeader()` + +UnsetHeader ensures that no value is present for Header, not even an explicit nil +### GetBody + +`func (o *TemplateDto) GetBody() string` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *TemplateDto) GetBodyOk() (*string, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBody + +`func (o *TemplateDto) SetBody(v string)` + +SetBody sets Body field to given value. + +### HasBody + +`func (o *TemplateDto) HasBody() bool` + +HasBody returns a boolean if a field has been set. + +### GetFooter + +`func (o *TemplateDto) GetFooter() string` + +GetFooter returns the Footer field if non-nil, zero value otherwise. + +### GetFooterOk + +`func (o *TemplateDto) GetFooterOk() (*string, bool)` + +GetFooterOk returns a tuple with the Footer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFooter + +`func (o *TemplateDto) SetFooter(v string)` + +SetFooter sets Footer field to given value. + +### HasFooter + +`func (o *TemplateDto) HasFooter() bool` + +HasFooter returns a boolean if a field has been set. + +### SetFooterNil + +`func (o *TemplateDto) SetFooterNil(b bool)` + + SetFooterNil sets the value for Footer to be an explicit nil + +### UnsetFooter +`func (o *TemplateDto) UnsetFooter()` + +UnsetFooter ensures that no value is present for Footer, not even an explicit nil +### GetFrom + +`func (o *TemplateDto) GetFrom() string` + +GetFrom returns the From field if non-nil, zero value otherwise. + +### GetFromOk + +`func (o *TemplateDto) GetFromOk() (*string, bool)` + +GetFromOk returns a tuple with the From field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrom + +`func (o *TemplateDto) SetFrom(v string)` + +SetFrom sets From field to given value. + +### HasFrom + +`func (o *TemplateDto) HasFrom() bool` + +HasFrom returns a boolean if a field has been set. + +### GetReplyTo + +`func (o *TemplateDto) GetReplyTo() string` + +GetReplyTo returns the ReplyTo field if non-nil, zero value otherwise. + +### GetReplyToOk + +`func (o *TemplateDto) GetReplyToOk() (*string, bool)` + +GetReplyToOk returns a tuple with the ReplyTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplyTo + +`func (o *TemplateDto) SetReplyTo(v string)` + +SetReplyTo sets ReplyTo field to given value. + +### HasReplyTo + +`func (o *TemplateDto) HasReplyTo() bool` + +HasReplyTo returns a boolean if a field has been set. + +### GetDescription + +`func (o *TemplateDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TemplateDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TemplateDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *TemplateDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetId + +`func (o *TemplateDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TemplateDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TemplateDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TemplateDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreated + +`func (o *TemplateDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *TemplateDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *TemplateDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *TemplateDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *TemplateDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *TemplateDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *TemplateDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *TemplateDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetSlackTemplate + +`func (o *TemplateDto) GetSlackTemplate() string` + +GetSlackTemplate returns the SlackTemplate field if non-nil, zero value otherwise. + +### GetSlackTemplateOk + +`func (o *TemplateDto) GetSlackTemplateOk() (*string, bool)` + +GetSlackTemplateOk returns a tuple with the SlackTemplate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSlackTemplate + +`func (o *TemplateDto) SetSlackTemplate(v string)` + +SetSlackTemplate sets SlackTemplate field to given value. + +### HasSlackTemplate + +`func (o *TemplateDto) HasSlackTemplate() bool` + +HasSlackTemplate returns a boolean if a field has been set. + +### SetSlackTemplateNil + +`func (o *TemplateDto) SetSlackTemplateNil(b bool)` + + SetSlackTemplateNil sets the value for SlackTemplate to be an explicit nil + +### UnsetSlackTemplate +`func (o *TemplateDto) UnsetSlackTemplate()` + +UnsetSlackTemplate ensures that no value is present for SlackTemplate, not even an explicit nil +### GetTeamsTemplate + +`func (o *TemplateDto) GetTeamsTemplate() string` + +GetTeamsTemplate returns the TeamsTemplate field if non-nil, zero value otherwise. + +### GetTeamsTemplateOk + +`func (o *TemplateDto) GetTeamsTemplateOk() (*string, bool)` + +GetTeamsTemplateOk returns a tuple with the TeamsTemplate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamsTemplate + +`func (o *TemplateDto) SetTeamsTemplate(v string)` + +SetTeamsTemplate sets TeamsTemplate field to given value. + +### HasTeamsTemplate + +`func (o *TemplateDto) HasTeamsTemplate() bool` + +HasTeamsTemplate returns a boolean if a field has been set. + +### SetTeamsTemplateNil + +`func (o *TemplateDto) SetTeamsTemplateNil(b bool)` + + SetTeamsTemplateNil sets the value for TeamsTemplate to be an explicit nil + +### UnsetTeamsTemplate +`func (o *TemplateDto) UnsetTeamsTemplate()` + +UnsetTeamsTemplate ensures that no value is present for TeamsTemplate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TemplateDtoDefault.md b/docs/tools/sdk/go/Reference/Beta/Models/TemplateDtoDefault.md new file mode 100644 index 000000000..a8540d90d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TemplateDtoDefault.md @@ -0,0 +1,456 @@ +--- +id: beta-template-dto-default +title: TemplateDtoDefault +pagination_label: TemplateDtoDefault +sidebar_label: TemplateDtoDefault +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateDtoDefault', 'BetaTemplateDtoDefault'] +slug: /tools/sdk/go/beta/models/template-dto-default +tags: ['SDK', 'Software Development Kit', 'TemplateDtoDefault', 'BetaTemplateDtoDefault'] +--- + +# TemplateDtoDefault + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The key of the default template | [optional] +**Name** | Pointer to **string** | The name of the default template | [optional] +**Medium** | Pointer to **string** | The message medium. More mediums may be added in the future. | [optional] +**Locale** | Pointer to **string** | The locale for the message text, a BCP 47 language tag. | [optional] +**Subject** | Pointer to **NullableString** | The subject of the default template | [optional] +**Header** | Pointer to **NullableString** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**Body** | Pointer to **string** | The body of the default template | [optional] +**Footer** | Pointer to **NullableString** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**From** | Pointer to **NullableString** | The \"From:\" address of the default template | [optional] +**ReplyTo** | Pointer to **NullableString** | The \"Reply To\" field of the default template | [optional] +**Description** | Pointer to **NullableString** | The description of the default template | [optional] +**SlackTemplate** | Pointer to [**NullableTemplateSlack**](template-slack) | | [optional] +**TeamsTemplate** | Pointer to [**NullableTemplateTeams**](template-teams) | | [optional] + +## Methods + +### NewTemplateDtoDefault + +`func NewTemplateDtoDefault() *TemplateDtoDefault` + +NewTemplateDtoDefault instantiates a new TemplateDtoDefault 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 + +### NewTemplateDtoDefaultWithDefaults + +`func NewTemplateDtoDefaultWithDefaults() *TemplateDtoDefault` + +NewTemplateDtoDefaultWithDefaults instantiates a new TemplateDtoDefault 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 + +### GetKey + +`func (o *TemplateDtoDefault) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TemplateDtoDefault) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TemplateDtoDefault) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *TemplateDtoDefault) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *TemplateDtoDefault) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TemplateDtoDefault) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TemplateDtoDefault) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TemplateDtoDefault) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetMedium + +`func (o *TemplateDtoDefault) GetMedium() string` + +GetMedium returns the Medium field if non-nil, zero value otherwise. + +### GetMediumOk + +`func (o *TemplateDtoDefault) GetMediumOk() (*string, bool)` + +GetMediumOk returns a tuple with the Medium field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMedium + +`func (o *TemplateDtoDefault) SetMedium(v string)` + +SetMedium sets Medium field to given value. + +### HasMedium + +`func (o *TemplateDtoDefault) HasMedium() bool` + +HasMedium returns a boolean if a field has been set. + +### GetLocale + +`func (o *TemplateDtoDefault) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *TemplateDtoDefault) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *TemplateDtoDefault) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *TemplateDtoDefault) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + +### GetSubject + +`func (o *TemplateDtoDefault) GetSubject() string` + +GetSubject returns the Subject field if non-nil, zero value otherwise. + +### GetSubjectOk + +`func (o *TemplateDtoDefault) GetSubjectOk() (*string, bool)` + +GetSubjectOk returns a tuple with the Subject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubject + +`func (o *TemplateDtoDefault) SetSubject(v string)` + +SetSubject sets Subject field to given value. + +### HasSubject + +`func (o *TemplateDtoDefault) HasSubject() bool` + +HasSubject returns a boolean if a field has been set. + +### SetSubjectNil + +`func (o *TemplateDtoDefault) SetSubjectNil(b bool)` + + SetSubjectNil sets the value for Subject to be an explicit nil + +### UnsetSubject +`func (o *TemplateDtoDefault) UnsetSubject()` + +UnsetSubject ensures that no value is present for Subject, not even an explicit nil +### GetHeader + +`func (o *TemplateDtoDefault) GetHeader() string` + +GetHeader returns the Header field if non-nil, zero value otherwise. + +### GetHeaderOk + +`func (o *TemplateDtoDefault) GetHeaderOk() (*string, bool)` + +GetHeaderOk returns a tuple with the Header field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHeader + +`func (o *TemplateDtoDefault) SetHeader(v string)` + +SetHeader sets Header field to given value. + +### HasHeader + +`func (o *TemplateDtoDefault) HasHeader() bool` + +HasHeader returns a boolean if a field has been set. + +### SetHeaderNil + +`func (o *TemplateDtoDefault) SetHeaderNil(b bool)` + + SetHeaderNil sets the value for Header to be an explicit nil + +### UnsetHeader +`func (o *TemplateDtoDefault) UnsetHeader()` + +UnsetHeader ensures that no value is present for Header, not even an explicit nil +### GetBody + +`func (o *TemplateDtoDefault) GetBody() string` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *TemplateDtoDefault) GetBodyOk() (*string, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBody + +`func (o *TemplateDtoDefault) SetBody(v string)` + +SetBody sets Body field to given value. + +### HasBody + +`func (o *TemplateDtoDefault) HasBody() bool` + +HasBody returns a boolean if a field has been set. + +### GetFooter + +`func (o *TemplateDtoDefault) GetFooter() string` + +GetFooter returns the Footer field if non-nil, zero value otherwise. + +### GetFooterOk + +`func (o *TemplateDtoDefault) GetFooterOk() (*string, bool)` + +GetFooterOk returns a tuple with the Footer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFooter + +`func (o *TemplateDtoDefault) SetFooter(v string)` + +SetFooter sets Footer field to given value. + +### HasFooter + +`func (o *TemplateDtoDefault) HasFooter() bool` + +HasFooter returns a boolean if a field has been set. + +### SetFooterNil + +`func (o *TemplateDtoDefault) SetFooterNil(b bool)` + + SetFooterNil sets the value for Footer to be an explicit nil + +### UnsetFooter +`func (o *TemplateDtoDefault) UnsetFooter()` + +UnsetFooter ensures that no value is present for Footer, not even an explicit nil +### GetFrom + +`func (o *TemplateDtoDefault) GetFrom() string` + +GetFrom returns the From field if non-nil, zero value otherwise. + +### GetFromOk + +`func (o *TemplateDtoDefault) GetFromOk() (*string, bool)` + +GetFromOk returns a tuple with the From field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrom + +`func (o *TemplateDtoDefault) SetFrom(v string)` + +SetFrom sets From field to given value. + +### HasFrom + +`func (o *TemplateDtoDefault) HasFrom() bool` + +HasFrom returns a boolean if a field has been set. + +### SetFromNil + +`func (o *TemplateDtoDefault) SetFromNil(b bool)` + + SetFromNil sets the value for From to be an explicit nil + +### UnsetFrom +`func (o *TemplateDtoDefault) UnsetFrom()` + +UnsetFrom ensures that no value is present for From, not even an explicit nil +### GetReplyTo + +`func (o *TemplateDtoDefault) GetReplyTo() string` + +GetReplyTo returns the ReplyTo field if non-nil, zero value otherwise. + +### GetReplyToOk + +`func (o *TemplateDtoDefault) GetReplyToOk() (*string, bool)` + +GetReplyToOk returns a tuple with the ReplyTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplyTo + +`func (o *TemplateDtoDefault) SetReplyTo(v string)` + +SetReplyTo sets ReplyTo field to given value. + +### HasReplyTo + +`func (o *TemplateDtoDefault) HasReplyTo() bool` + +HasReplyTo returns a boolean if a field has been set. + +### SetReplyToNil + +`func (o *TemplateDtoDefault) SetReplyToNil(b bool)` + + SetReplyToNil sets the value for ReplyTo to be an explicit nil + +### UnsetReplyTo +`func (o *TemplateDtoDefault) UnsetReplyTo()` + +UnsetReplyTo ensures that no value is present for ReplyTo, not even an explicit nil +### GetDescription + +`func (o *TemplateDtoDefault) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TemplateDtoDefault) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TemplateDtoDefault) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *TemplateDtoDefault) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *TemplateDtoDefault) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *TemplateDtoDefault) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSlackTemplate + +`func (o *TemplateDtoDefault) GetSlackTemplate() TemplateSlack` + +GetSlackTemplate returns the SlackTemplate field if non-nil, zero value otherwise. + +### GetSlackTemplateOk + +`func (o *TemplateDtoDefault) GetSlackTemplateOk() (*TemplateSlack, bool)` + +GetSlackTemplateOk returns a tuple with the SlackTemplate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSlackTemplate + +`func (o *TemplateDtoDefault) SetSlackTemplate(v TemplateSlack)` + +SetSlackTemplate sets SlackTemplate field to given value. + +### HasSlackTemplate + +`func (o *TemplateDtoDefault) HasSlackTemplate() bool` + +HasSlackTemplate returns a boolean if a field has been set. + +### SetSlackTemplateNil + +`func (o *TemplateDtoDefault) SetSlackTemplateNil(b bool)` + + SetSlackTemplateNil sets the value for SlackTemplate to be an explicit nil + +### UnsetSlackTemplate +`func (o *TemplateDtoDefault) UnsetSlackTemplate()` + +UnsetSlackTemplate ensures that no value is present for SlackTemplate, not even an explicit nil +### GetTeamsTemplate + +`func (o *TemplateDtoDefault) GetTeamsTemplate() TemplateTeams` + +GetTeamsTemplate returns the TeamsTemplate field if non-nil, zero value otherwise. + +### GetTeamsTemplateOk + +`func (o *TemplateDtoDefault) GetTeamsTemplateOk() (*TemplateTeams, bool)` + +GetTeamsTemplateOk returns a tuple with the TeamsTemplate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamsTemplate + +`func (o *TemplateDtoDefault) SetTeamsTemplate(v TemplateTeams)` + +SetTeamsTemplate sets TeamsTemplate field to given value. + +### HasTeamsTemplate + +`func (o *TemplateDtoDefault) HasTeamsTemplate() bool` + +HasTeamsTemplate returns a boolean if a field has been set. + +### SetTeamsTemplateNil + +`func (o *TemplateDtoDefault) SetTeamsTemplateNil(b bool)` + + SetTeamsTemplateNil sets the value for TeamsTemplate to be an explicit nil + +### UnsetTeamsTemplate +`func (o *TemplateDtoDefault) UnsetTeamsTemplate()` + +UnsetTeamsTemplate ensures that no value is present for TeamsTemplate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TemplateSlack.md b/docs/tools/sdk/go/Reference/Beta/Models/TemplateSlack.md new file mode 100644 index 000000000..3fa6844ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TemplateSlack.md @@ -0,0 +1,414 @@ +--- +id: beta-template-slack +title: TemplateSlack +pagination_label: TemplateSlack +sidebar_label: TemplateSlack +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateSlack', 'BetaTemplateSlack'] +slug: /tools/sdk/go/beta/models/template-slack +tags: ['SDK', 'Software Development Kit', 'TemplateSlack', 'BetaTemplateSlack'] +--- + +# TemplateSlack + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **NullableString** | | [optional] +**Text** | Pointer to **string** | | [optional] +**Blocks** | Pointer to **NullableString** | | [optional] +**Attachments** | Pointer to **string** | | [optional] +**NotificationType** | Pointer to **NullableString** | | [optional] +**ApprovalId** | Pointer to **NullableString** | | [optional] +**RequestId** | Pointer to **NullableString** | | [optional] +**RequestedById** | Pointer to **NullableString** | | [optional] +**IsSubscription** | Pointer to **NullableBool** | | [optional] +**AutoApprovalData** | Pointer to [**NullableTemplateSlackAutoApprovalData**](template-slack-auto-approval-data) | | [optional] +**CustomFields** | Pointer to [**NullableTemplateSlackCustomFields**](template-slack-custom-fields) | | [optional] + +## Methods + +### NewTemplateSlack + +`func NewTemplateSlack() *TemplateSlack` + +NewTemplateSlack instantiates a new TemplateSlack 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 + +### NewTemplateSlackWithDefaults + +`func NewTemplateSlackWithDefaults() *TemplateSlack` + +NewTemplateSlackWithDefaults instantiates a new TemplateSlack 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 + +### GetKey + +`func (o *TemplateSlack) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TemplateSlack) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TemplateSlack) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *TemplateSlack) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *TemplateSlack) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *TemplateSlack) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetText + +`func (o *TemplateSlack) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *TemplateSlack) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *TemplateSlack) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *TemplateSlack) HasText() bool` + +HasText returns a boolean if a field has been set. + +### GetBlocks + +`func (o *TemplateSlack) GetBlocks() string` + +GetBlocks returns the Blocks field if non-nil, zero value otherwise. + +### GetBlocksOk + +`func (o *TemplateSlack) GetBlocksOk() (*string, bool)` + +GetBlocksOk returns a tuple with the Blocks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBlocks + +`func (o *TemplateSlack) SetBlocks(v string)` + +SetBlocks sets Blocks field to given value. + +### HasBlocks + +`func (o *TemplateSlack) HasBlocks() bool` + +HasBlocks returns a boolean if a field has been set. + +### SetBlocksNil + +`func (o *TemplateSlack) SetBlocksNil(b bool)` + + SetBlocksNil sets the value for Blocks to be an explicit nil + +### UnsetBlocks +`func (o *TemplateSlack) UnsetBlocks()` + +UnsetBlocks ensures that no value is present for Blocks, not even an explicit nil +### GetAttachments + +`func (o *TemplateSlack) GetAttachments() string` + +GetAttachments returns the Attachments field if non-nil, zero value otherwise. + +### GetAttachmentsOk + +`func (o *TemplateSlack) GetAttachmentsOk() (*string, bool)` + +GetAttachmentsOk returns a tuple with the Attachments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttachments + +`func (o *TemplateSlack) SetAttachments(v string)` + +SetAttachments sets Attachments field to given value. + +### HasAttachments + +`func (o *TemplateSlack) HasAttachments() bool` + +HasAttachments returns a boolean if a field has been set. + +### GetNotificationType + +`func (o *TemplateSlack) GetNotificationType() string` + +GetNotificationType returns the NotificationType field if non-nil, zero value otherwise. + +### GetNotificationTypeOk + +`func (o *TemplateSlack) GetNotificationTypeOk() (*string, bool)` + +GetNotificationTypeOk returns a tuple with the NotificationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotificationType + +`func (o *TemplateSlack) SetNotificationType(v string)` + +SetNotificationType sets NotificationType field to given value. + +### HasNotificationType + +`func (o *TemplateSlack) HasNotificationType() bool` + +HasNotificationType returns a boolean if a field has been set. + +### SetNotificationTypeNil + +`func (o *TemplateSlack) SetNotificationTypeNil(b bool)` + + SetNotificationTypeNil sets the value for NotificationType to be an explicit nil + +### UnsetNotificationType +`func (o *TemplateSlack) UnsetNotificationType()` + +UnsetNotificationType ensures that no value is present for NotificationType, not even an explicit nil +### GetApprovalId + +`func (o *TemplateSlack) GetApprovalId() string` + +GetApprovalId returns the ApprovalId field if non-nil, zero value otherwise. + +### GetApprovalIdOk + +`func (o *TemplateSlack) GetApprovalIdOk() (*string, bool)` + +GetApprovalIdOk returns a tuple with the ApprovalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalId + +`func (o *TemplateSlack) SetApprovalId(v string)` + +SetApprovalId sets ApprovalId field to given value. + +### HasApprovalId + +`func (o *TemplateSlack) HasApprovalId() bool` + +HasApprovalId returns a boolean if a field has been set. + +### SetApprovalIdNil + +`func (o *TemplateSlack) SetApprovalIdNil(b bool)` + + SetApprovalIdNil sets the value for ApprovalId to be an explicit nil + +### UnsetApprovalId +`func (o *TemplateSlack) UnsetApprovalId()` + +UnsetApprovalId ensures that no value is present for ApprovalId, not even an explicit nil +### GetRequestId + +`func (o *TemplateSlack) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *TemplateSlack) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *TemplateSlack) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *TemplateSlack) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *TemplateSlack) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *TemplateSlack) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetRequestedById + +`func (o *TemplateSlack) GetRequestedById() string` + +GetRequestedById returns the RequestedById field if non-nil, zero value otherwise. + +### GetRequestedByIdOk + +`func (o *TemplateSlack) GetRequestedByIdOk() (*string, bool)` + +GetRequestedByIdOk returns a tuple with the RequestedById field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedById + +`func (o *TemplateSlack) SetRequestedById(v string)` + +SetRequestedById sets RequestedById field to given value. + +### HasRequestedById + +`func (o *TemplateSlack) HasRequestedById() bool` + +HasRequestedById returns a boolean if a field has been set. + +### SetRequestedByIdNil + +`func (o *TemplateSlack) SetRequestedByIdNil(b bool)` + + SetRequestedByIdNil sets the value for RequestedById to be an explicit nil + +### UnsetRequestedById +`func (o *TemplateSlack) UnsetRequestedById()` + +UnsetRequestedById ensures that no value is present for RequestedById, not even an explicit nil +### GetIsSubscription + +`func (o *TemplateSlack) GetIsSubscription() bool` + +GetIsSubscription returns the IsSubscription field if non-nil, zero value otherwise. + +### GetIsSubscriptionOk + +`func (o *TemplateSlack) GetIsSubscriptionOk() (*bool, bool)` + +GetIsSubscriptionOk returns a tuple with the IsSubscription field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSubscription + +`func (o *TemplateSlack) SetIsSubscription(v bool)` + +SetIsSubscription sets IsSubscription field to given value. + +### HasIsSubscription + +`func (o *TemplateSlack) HasIsSubscription() bool` + +HasIsSubscription returns a boolean if a field has been set. + +### SetIsSubscriptionNil + +`func (o *TemplateSlack) SetIsSubscriptionNil(b bool)` + + SetIsSubscriptionNil sets the value for IsSubscription to be an explicit nil + +### UnsetIsSubscription +`func (o *TemplateSlack) UnsetIsSubscription()` + +UnsetIsSubscription ensures that no value is present for IsSubscription, not even an explicit nil +### GetAutoApprovalData + +`func (o *TemplateSlack) GetAutoApprovalData() TemplateSlackAutoApprovalData` + +GetAutoApprovalData returns the AutoApprovalData field if non-nil, zero value otherwise. + +### GetAutoApprovalDataOk + +`func (o *TemplateSlack) GetAutoApprovalDataOk() (*TemplateSlackAutoApprovalData, bool)` + +GetAutoApprovalDataOk returns a tuple with the AutoApprovalData field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoApprovalData + +`func (o *TemplateSlack) SetAutoApprovalData(v TemplateSlackAutoApprovalData)` + +SetAutoApprovalData sets AutoApprovalData field to given value. + +### HasAutoApprovalData + +`func (o *TemplateSlack) HasAutoApprovalData() bool` + +HasAutoApprovalData returns a boolean if a field has been set. + +### SetAutoApprovalDataNil + +`func (o *TemplateSlack) SetAutoApprovalDataNil(b bool)` + + SetAutoApprovalDataNil sets the value for AutoApprovalData to be an explicit nil + +### UnsetAutoApprovalData +`func (o *TemplateSlack) UnsetAutoApprovalData()` + +UnsetAutoApprovalData ensures that no value is present for AutoApprovalData, not even an explicit nil +### GetCustomFields + +`func (o *TemplateSlack) GetCustomFields() TemplateSlackCustomFields` + +GetCustomFields returns the CustomFields field if non-nil, zero value otherwise. + +### GetCustomFieldsOk + +`func (o *TemplateSlack) GetCustomFieldsOk() (*TemplateSlackCustomFields, bool)` + +GetCustomFieldsOk returns a tuple with the CustomFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomFields + +`func (o *TemplateSlack) SetCustomFields(v TemplateSlackCustomFields)` + +SetCustomFields sets CustomFields field to given value. + +### HasCustomFields + +`func (o *TemplateSlack) HasCustomFields() bool` + +HasCustomFields returns a boolean if a field has been set. + +### SetCustomFieldsNil + +`func (o *TemplateSlack) SetCustomFieldsNil(b bool)` + + SetCustomFieldsNil sets the value for CustomFields to be an explicit nil + +### UnsetCustomFields +`func (o *TemplateSlack) UnsetCustomFields()` + +UnsetCustomFields ensures that no value is present for CustomFields, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TemplateSlackAutoApprovalData.md b/docs/tools/sdk/go/Reference/Beta/Models/TemplateSlackAutoApprovalData.md new file mode 100644 index 000000000..558f68168 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TemplateSlackAutoApprovalData.md @@ -0,0 +1,218 @@ +--- +id: beta-template-slack-auto-approval-data +title: TemplateSlackAutoApprovalData +pagination_label: TemplateSlackAutoApprovalData +sidebar_label: TemplateSlackAutoApprovalData +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateSlackAutoApprovalData', 'BetaTemplateSlackAutoApprovalData'] +slug: /tools/sdk/go/beta/models/template-slack-auto-approval-data +tags: ['SDK', 'Software Development Kit', 'TemplateSlackAutoApprovalData', 'BetaTemplateSlackAutoApprovalData'] +--- + +# TemplateSlackAutoApprovalData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsAutoApproved** | Pointer to **NullableString** | | [optional] +**ItemId** | Pointer to **NullableString** | | [optional] +**ItemType** | Pointer to **NullableString** | | [optional] +**AutoApprovalMessageJSON** | Pointer to **NullableString** | | [optional] +**AutoApprovalTitle** | Pointer to **NullableString** | | [optional] + +## Methods + +### NewTemplateSlackAutoApprovalData + +`func NewTemplateSlackAutoApprovalData() *TemplateSlackAutoApprovalData` + +NewTemplateSlackAutoApprovalData instantiates a new TemplateSlackAutoApprovalData 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 + +### NewTemplateSlackAutoApprovalDataWithDefaults + +`func NewTemplateSlackAutoApprovalDataWithDefaults() *TemplateSlackAutoApprovalData` + +NewTemplateSlackAutoApprovalDataWithDefaults instantiates a new TemplateSlackAutoApprovalData 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 + +### GetIsAutoApproved + +`func (o *TemplateSlackAutoApprovalData) GetIsAutoApproved() string` + +GetIsAutoApproved returns the IsAutoApproved field if non-nil, zero value otherwise. + +### GetIsAutoApprovedOk + +`func (o *TemplateSlackAutoApprovalData) GetIsAutoApprovedOk() (*string, bool)` + +GetIsAutoApprovedOk returns a tuple with the IsAutoApproved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsAutoApproved + +`func (o *TemplateSlackAutoApprovalData) SetIsAutoApproved(v string)` + +SetIsAutoApproved sets IsAutoApproved field to given value. + +### HasIsAutoApproved + +`func (o *TemplateSlackAutoApprovalData) HasIsAutoApproved() bool` + +HasIsAutoApproved returns a boolean if a field has been set. + +### SetIsAutoApprovedNil + +`func (o *TemplateSlackAutoApprovalData) SetIsAutoApprovedNil(b bool)` + + SetIsAutoApprovedNil sets the value for IsAutoApproved to be an explicit nil + +### UnsetIsAutoApproved +`func (o *TemplateSlackAutoApprovalData) UnsetIsAutoApproved()` + +UnsetIsAutoApproved ensures that no value is present for IsAutoApproved, not even an explicit nil +### GetItemId + +`func (o *TemplateSlackAutoApprovalData) GetItemId() string` + +GetItemId returns the ItemId field if non-nil, zero value otherwise. + +### GetItemIdOk + +`func (o *TemplateSlackAutoApprovalData) GetItemIdOk() (*string, bool)` + +GetItemIdOk returns a tuple with the ItemId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItemId + +`func (o *TemplateSlackAutoApprovalData) SetItemId(v string)` + +SetItemId sets ItemId field to given value. + +### HasItemId + +`func (o *TemplateSlackAutoApprovalData) HasItemId() bool` + +HasItemId returns a boolean if a field has been set. + +### SetItemIdNil + +`func (o *TemplateSlackAutoApprovalData) SetItemIdNil(b bool)` + + SetItemIdNil sets the value for ItemId to be an explicit nil + +### UnsetItemId +`func (o *TemplateSlackAutoApprovalData) UnsetItemId()` + +UnsetItemId ensures that no value is present for ItemId, not even an explicit nil +### GetItemType + +`func (o *TemplateSlackAutoApprovalData) GetItemType() string` + +GetItemType returns the ItemType field if non-nil, zero value otherwise. + +### GetItemTypeOk + +`func (o *TemplateSlackAutoApprovalData) GetItemTypeOk() (*string, bool)` + +GetItemTypeOk returns a tuple with the ItemType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItemType + +`func (o *TemplateSlackAutoApprovalData) SetItemType(v string)` + +SetItemType sets ItemType field to given value. + +### HasItemType + +`func (o *TemplateSlackAutoApprovalData) HasItemType() bool` + +HasItemType returns a boolean if a field has been set. + +### SetItemTypeNil + +`func (o *TemplateSlackAutoApprovalData) SetItemTypeNil(b bool)` + + SetItemTypeNil sets the value for ItemType to be an explicit nil + +### UnsetItemType +`func (o *TemplateSlackAutoApprovalData) UnsetItemType()` + +UnsetItemType ensures that no value is present for ItemType, not even an explicit nil +### GetAutoApprovalMessageJSON + +`func (o *TemplateSlackAutoApprovalData) GetAutoApprovalMessageJSON() string` + +GetAutoApprovalMessageJSON returns the AutoApprovalMessageJSON field if non-nil, zero value otherwise. + +### GetAutoApprovalMessageJSONOk + +`func (o *TemplateSlackAutoApprovalData) GetAutoApprovalMessageJSONOk() (*string, bool)` + +GetAutoApprovalMessageJSONOk returns a tuple with the AutoApprovalMessageJSON field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoApprovalMessageJSON + +`func (o *TemplateSlackAutoApprovalData) SetAutoApprovalMessageJSON(v string)` + +SetAutoApprovalMessageJSON sets AutoApprovalMessageJSON field to given value. + +### HasAutoApprovalMessageJSON + +`func (o *TemplateSlackAutoApprovalData) HasAutoApprovalMessageJSON() bool` + +HasAutoApprovalMessageJSON returns a boolean if a field has been set. + +### SetAutoApprovalMessageJSONNil + +`func (o *TemplateSlackAutoApprovalData) SetAutoApprovalMessageJSONNil(b bool)` + + SetAutoApprovalMessageJSONNil sets the value for AutoApprovalMessageJSON to be an explicit nil + +### UnsetAutoApprovalMessageJSON +`func (o *TemplateSlackAutoApprovalData) UnsetAutoApprovalMessageJSON()` + +UnsetAutoApprovalMessageJSON ensures that no value is present for AutoApprovalMessageJSON, not even an explicit nil +### GetAutoApprovalTitle + +`func (o *TemplateSlackAutoApprovalData) GetAutoApprovalTitle() string` + +GetAutoApprovalTitle returns the AutoApprovalTitle field if non-nil, zero value otherwise. + +### GetAutoApprovalTitleOk + +`func (o *TemplateSlackAutoApprovalData) GetAutoApprovalTitleOk() (*string, bool)` + +GetAutoApprovalTitleOk returns a tuple with the AutoApprovalTitle field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoApprovalTitle + +`func (o *TemplateSlackAutoApprovalData) SetAutoApprovalTitle(v string)` + +SetAutoApprovalTitle sets AutoApprovalTitle field to given value. + +### HasAutoApprovalTitle + +`func (o *TemplateSlackAutoApprovalData) HasAutoApprovalTitle() bool` + +HasAutoApprovalTitle returns a boolean if a field has been set. + +### SetAutoApprovalTitleNil + +`func (o *TemplateSlackAutoApprovalData) SetAutoApprovalTitleNil(b bool)` + + SetAutoApprovalTitleNil sets the value for AutoApprovalTitle to be an explicit nil + +### UnsetAutoApprovalTitle +`func (o *TemplateSlackAutoApprovalData) UnsetAutoApprovalTitle()` + +UnsetAutoApprovalTitle ensures that no value is present for AutoApprovalTitle, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TemplateSlackCustomFields.md b/docs/tools/sdk/go/Reference/Beta/Models/TemplateSlackCustomFields.md new file mode 100644 index 000000000..7951754d0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TemplateSlackCustomFields.md @@ -0,0 +1,182 @@ +--- +id: beta-template-slack-custom-fields +title: TemplateSlackCustomFields +pagination_label: TemplateSlackCustomFields +sidebar_label: TemplateSlackCustomFields +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateSlackCustomFields', 'BetaTemplateSlackCustomFields'] +slug: /tools/sdk/go/beta/models/template-slack-custom-fields +tags: ['SDK', 'Software Development Kit', 'TemplateSlackCustomFields', 'BetaTemplateSlackCustomFields'] +--- + +# TemplateSlackCustomFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestType** | Pointer to **NullableString** | | [optional] +**ContainsDeny** | Pointer to **NullableString** | | [optional] +**CampaignId** | Pointer to **NullableString** | | [optional] +**CampaignStatus** | Pointer to **NullableString** | | [optional] + +## Methods + +### NewTemplateSlackCustomFields + +`func NewTemplateSlackCustomFields() *TemplateSlackCustomFields` + +NewTemplateSlackCustomFields instantiates a new TemplateSlackCustomFields 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 + +### NewTemplateSlackCustomFieldsWithDefaults + +`func NewTemplateSlackCustomFieldsWithDefaults() *TemplateSlackCustomFields` + +NewTemplateSlackCustomFieldsWithDefaults instantiates a new TemplateSlackCustomFields 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 + +### GetRequestType + +`func (o *TemplateSlackCustomFields) GetRequestType() string` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *TemplateSlackCustomFields) GetRequestTypeOk() (*string, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *TemplateSlackCustomFields) SetRequestType(v string)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *TemplateSlackCustomFields) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *TemplateSlackCustomFields) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *TemplateSlackCustomFields) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetContainsDeny + +`func (o *TemplateSlackCustomFields) GetContainsDeny() string` + +GetContainsDeny returns the ContainsDeny field if non-nil, zero value otherwise. + +### GetContainsDenyOk + +`func (o *TemplateSlackCustomFields) GetContainsDenyOk() (*string, bool)` + +GetContainsDenyOk returns a tuple with the ContainsDeny field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainsDeny + +`func (o *TemplateSlackCustomFields) SetContainsDeny(v string)` + +SetContainsDeny sets ContainsDeny field to given value. + +### HasContainsDeny + +`func (o *TemplateSlackCustomFields) HasContainsDeny() bool` + +HasContainsDeny returns a boolean if a field has been set. + +### SetContainsDenyNil + +`func (o *TemplateSlackCustomFields) SetContainsDenyNil(b bool)` + + SetContainsDenyNil sets the value for ContainsDeny to be an explicit nil + +### UnsetContainsDeny +`func (o *TemplateSlackCustomFields) UnsetContainsDeny()` + +UnsetContainsDeny ensures that no value is present for ContainsDeny, not even an explicit nil +### GetCampaignId + +`func (o *TemplateSlackCustomFields) GetCampaignId() string` + +GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. + +### GetCampaignIdOk + +`func (o *TemplateSlackCustomFields) GetCampaignIdOk() (*string, bool)` + +GetCampaignIdOk returns a tuple with the CampaignId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignId + +`func (o *TemplateSlackCustomFields) SetCampaignId(v string)` + +SetCampaignId sets CampaignId field to given value. + +### HasCampaignId + +`func (o *TemplateSlackCustomFields) HasCampaignId() bool` + +HasCampaignId returns a boolean if a field has been set. + +### SetCampaignIdNil + +`func (o *TemplateSlackCustomFields) SetCampaignIdNil(b bool)` + + SetCampaignIdNil sets the value for CampaignId to be an explicit nil + +### UnsetCampaignId +`func (o *TemplateSlackCustomFields) UnsetCampaignId()` + +UnsetCampaignId ensures that no value is present for CampaignId, not even an explicit nil +### GetCampaignStatus + +`func (o *TemplateSlackCustomFields) GetCampaignStatus() string` + +GetCampaignStatus returns the CampaignStatus field if non-nil, zero value otherwise. + +### GetCampaignStatusOk + +`func (o *TemplateSlackCustomFields) GetCampaignStatusOk() (*string, bool)` + +GetCampaignStatusOk returns a tuple with the CampaignStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignStatus + +`func (o *TemplateSlackCustomFields) SetCampaignStatus(v string)` + +SetCampaignStatus sets CampaignStatus field to given value. + +### HasCampaignStatus + +`func (o *TemplateSlackCustomFields) HasCampaignStatus() bool` + +HasCampaignStatus returns a boolean if a field has been set. + +### SetCampaignStatusNil + +`func (o *TemplateSlackCustomFields) SetCampaignStatusNil(b bool)` + + SetCampaignStatusNil sets the value for CampaignStatus to be an explicit nil + +### UnsetCampaignStatus +`func (o *TemplateSlackCustomFields) UnsetCampaignStatus()` + +UnsetCampaignStatus ensures that no value is present for CampaignStatus, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TemplateTeams.md b/docs/tools/sdk/go/Reference/Beta/Models/TemplateTeams.md new file mode 100644 index 000000000..54d073a93 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TemplateTeams.md @@ -0,0 +1,424 @@ +--- +id: beta-template-teams +title: TemplateTeams +pagination_label: TemplateTeams +sidebar_label: TemplateTeams +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateTeams', 'BetaTemplateTeams'] +slug: /tools/sdk/go/beta/models/template-teams +tags: ['SDK', 'Software Development Kit', 'TemplateTeams', 'BetaTemplateTeams'] +--- + +# TemplateTeams + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **NullableString** | | [optional] +**Title** | Pointer to **NullableString** | | [optional] +**Text** | Pointer to **string** | | [optional] +**MessageJSON** | Pointer to **NullableString** | | [optional] +**IsSubscription** | Pointer to **NullableBool** | | [optional] +**ApprovalId** | Pointer to **NullableString** | | [optional] +**RequestId** | Pointer to **NullableString** | | [optional] +**RequestedById** | Pointer to **NullableString** | | [optional] +**NotificationType** | Pointer to **NullableString** | | [optional] +**AutoApprovalData** | Pointer to [**NullableTemplateSlackAutoApprovalData**](template-slack-auto-approval-data) | | [optional] +**CustomFields** | Pointer to [**NullableTemplateSlackCustomFields**](template-slack-custom-fields) | | [optional] + +## Methods + +### NewTemplateTeams + +`func NewTemplateTeams() *TemplateTeams` + +NewTemplateTeams instantiates a new TemplateTeams 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 + +### NewTemplateTeamsWithDefaults + +`func NewTemplateTeamsWithDefaults() *TemplateTeams` + +NewTemplateTeamsWithDefaults instantiates a new TemplateTeams 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 + +### GetKey + +`func (o *TemplateTeams) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TemplateTeams) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TemplateTeams) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *TemplateTeams) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *TemplateTeams) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *TemplateTeams) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetTitle + +`func (o *TemplateTeams) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *TemplateTeams) GetTitleOk() (*string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTitle + +`func (o *TemplateTeams) SetTitle(v string)` + +SetTitle sets Title field to given value. + +### HasTitle + +`func (o *TemplateTeams) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### SetTitleNil + +`func (o *TemplateTeams) SetTitleNil(b bool)` + + SetTitleNil sets the value for Title to be an explicit nil + +### UnsetTitle +`func (o *TemplateTeams) UnsetTitle()` + +UnsetTitle ensures that no value is present for Title, not even an explicit nil +### GetText + +`func (o *TemplateTeams) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *TemplateTeams) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *TemplateTeams) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *TemplateTeams) HasText() bool` + +HasText returns a boolean if a field has been set. + +### GetMessageJSON + +`func (o *TemplateTeams) GetMessageJSON() string` + +GetMessageJSON returns the MessageJSON field if non-nil, zero value otherwise. + +### GetMessageJSONOk + +`func (o *TemplateTeams) GetMessageJSONOk() (*string, bool)` + +GetMessageJSONOk returns a tuple with the MessageJSON field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessageJSON + +`func (o *TemplateTeams) SetMessageJSON(v string)` + +SetMessageJSON sets MessageJSON field to given value. + +### HasMessageJSON + +`func (o *TemplateTeams) HasMessageJSON() bool` + +HasMessageJSON returns a boolean if a field has been set. + +### SetMessageJSONNil + +`func (o *TemplateTeams) SetMessageJSONNil(b bool)` + + SetMessageJSONNil sets the value for MessageJSON to be an explicit nil + +### UnsetMessageJSON +`func (o *TemplateTeams) UnsetMessageJSON()` + +UnsetMessageJSON ensures that no value is present for MessageJSON, not even an explicit nil +### GetIsSubscription + +`func (o *TemplateTeams) GetIsSubscription() bool` + +GetIsSubscription returns the IsSubscription field if non-nil, zero value otherwise. + +### GetIsSubscriptionOk + +`func (o *TemplateTeams) GetIsSubscriptionOk() (*bool, bool)` + +GetIsSubscriptionOk returns a tuple with the IsSubscription field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSubscription + +`func (o *TemplateTeams) SetIsSubscription(v bool)` + +SetIsSubscription sets IsSubscription field to given value. + +### HasIsSubscription + +`func (o *TemplateTeams) HasIsSubscription() bool` + +HasIsSubscription returns a boolean if a field has been set. + +### SetIsSubscriptionNil + +`func (o *TemplateTeams) SetIsSubscriptionNil(b bool)` + + SetIsSubscriptionNil sets the value for IsSubscription to be an explicit nil + +### UnsetIsSubscription +`func (o *TemplateTeams) UnsetIsSubscription()` + +UnsetIsSubscription ensures that no value is present for IsSubscription, not even an explicit nil +### GetApprovalId + +`func (o *TemplateTeams) GetApprovalId() string` + +GetApprovalId returns the ApprovalId field if non-nil, zero value otherwise. + +### GetApprovalIdOk + +`func (o *TemplateTeams) GetApprovalIdOk() (*string, bool)` + +GetApprovalIdOk returns a tuple with the ApprovalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalId + +`func (o *TemplateTeams) SetApprovalId(v string)` + +SetApprovalId sets ApprovalId field to given value. + +### HasApprovalId + +`func (o *TemplateTeams) HasApprovalId() bool` + +HasApprovalId returns a boolean if a field has been set. + +### SetApprovalIdNil + +`func (o *TemplateTeams) SetApprovalIdNil(b bool)` + + SetApprovalIdNil sets the value for ApprovalId to be an explicit nil + +### UnsetApprovalId +`func (o *TemplateTeams) UnsetApprovalId()` + +UnsetApprovalId ensures that no value is present for ApprovalId, not even an explicit nil +### GetRequestId + +`func (o *TemplateTeams) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *TemplateTeams) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *TemplateTeams) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *TemplateTeams) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *TemplateTeams) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *TemplateTeams) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetRequestedById + +`func (o *TemplateTeams) GetRequestedById() string` + +GetRequestedById returns the RequestedById field if non-nil, zero value otherwise. + +### GetRequestedByIdOk + +`func (o *TemplateTeams) GetRequestedByIdOk() (*string, bool)` + +GetRequestedByIdOk returns a tuple with the RequestedById field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedById + +`func (o *TemplateTeams) SetRequestedById(v string)` + +SetRequestedById sets RequestedById field to given value. + +### HasRequestedById + +`func (o *TemplateTeams) HasRequestedById() bool` + +HasRequestedById returns a boolean if a field has been set. + +### SetRequestedByIdNil + +`func (o *TemplateTeams) SetRequestedByIdNil(b bool)` + + SetRequestedByIdNil sets the value for RequestedById to be an explicit nil + +### UnsetRequestedById +`func (o *TemplateTeams) UnsetRequestedById()` + +UnsetRequestedById ensures that no value is present for RequestedById, not even an explicit nil +### GetNotificationType + +`func (o *TemplateTeams) GetNotificationType() string` + +GetNotificationType returns the NotificationType field if non-nil, zero value otherwise. + +### GetNotificationTypeOk + +`func (o *TemplateTeams) GetNotificationTypeOk() (*string, bool)` + +GetNotificationTypeOk returns a tuple with the NotificationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotificationType + +`func (o *TemplateTeams) SetNotificationType(v string)` + +SetNotificationType sets NotificationType field to given value. + +### HasNotificationType + +`func (o *TemplateTeams) HasNotificationType() bool` + +HasNotificationType returns a boolean if a field has been set. + +### SetNotificationTypeNil + +`func (o *TemplateTeams) SetNotificationTypeNil(b bool)` + + SetNotificationTypeNil sets the value for NotificationType to be an explicit nil + +### UnsetNotificationType +`func (o *TemplateTeams) UnsetNotificationType()` + +UnsetNotificationType ensures that no value is present for NotificationType, not even an explicit nil +### GetAutoApprovalData + +`func (o *TemplateTeams) GetAutoApprovalData() TemplateSlackAutoApprovalData` + +GetAutoApprovalData returns the AutoApprovalData field if non-nil, zero value otherwise. + +### GetAutoApprovalDataOk + +`func (o *TemplateTeams) GetAutoApprovalDataOk() (*TemplateSlackAutoApprovalData, bool)` + +GetAutoApprovalDataOk returns a tuple with the AutoApprovalData field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoApprovalData + +`func (o *TemplateTeams) SetAutoApprovalData(v TemplateSlackAutoApprovalData)` + +SetAutoApprovalData sets AutoApprovalData field to given value. + +### HasAutoApprovalData + +`func (o *TemplateTeams) HasAutoApprovalData() bool` + +HasAutoApprovalData returns a boolean if a field has been set. + +### SetAutoApprovalDataNil + +`func (o *TemplateTeams) SetAutoApprovalDataNil(b bool)` + + SetAutoApprovalDataNil sets the value for AutoApprovalData to be an explicit nil + +### UnsetAutoApprovalData +`func (o *TemplateTeams) UnsetAutoApprovalData()` + +UnsetAutoApprovalData ensures that no value is present for AutoApprovalData, not even an explicit nil +### GetCustomFields + +`func (o *TemplateTeams) GetCustomFields() TemplateSlackCustomFields` + +GetCustomFields returns the CustomFields field if non-nil, zero value otherwise. + +### GetCustomFieldsOk + +`func (o *TemplateTeams) GetCustomFieldsOk() (*TemplateSlackCustomFields, bool)` + +GetCustomFieldsOk returns a tuple with the CustomFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomFields + +`func (o *TemplateTeams) SetCustomFields(v TemplateSlackCustomFields)` + +SetCustomFields sets CustomFields field to given value. + +### HasCustomFields + +`func (o *TemplateTeams) HasCustomFields() bool` + +HasCustomFields returns a boolean if a field has been set. + +### SetCustomFieldsNil + +`func (o *TemplateTeams) SetCustomFieldsNil(b bool)` + + SetCustomFieldsNil sets the value for CustomFields to be an explicit nil + +### UnsetCustomFields +`func (o *TemplateTeams) UnsetCustomFields()` + +UnsetCustomFields ensures that no value is present for CustomFields, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Tenant.md b/docs/tools/sdk/go/Reference/Beta/Models/Tenant.md new file mode 100644 index 000000000..7590b1ebe --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Tenant.md @@ -0,0 +1,220 @@ +--- +id: beta-tenant +title: Tenant +pagination_label: Tenant +sidebar_label: Tenant +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Tenant', 'BetaTenant'] +slug: /tools/sdk/go/beta/models/tenant +tags: ['SDK', 'Software Development Kit', 'Tenant', 'BetaTenant'] +--- + +# Tenant + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique identifier for the Tenant | [optional] [readonly] +**Name** | Pointer to **string** | Abbreviated name of the Tenant | [optional] +**FullName** | Pointer to **string** | Human-readable name of the Tenant | [optional] +**Pod** | Pointer to **string** | Deployment pod for the Tenant | [optional] +**Region** | Pointer to **string** | Deployment region for the Tenant | [optional] +**Description** | Pointer to **string** | Description of the Tenant | [optional] +**Products** | Pointer to [**[]Product**](product) | | [optional] + +## Methods + +### NewTenant + +`func NewTenant() *Tenant` + +NewTenant instantiates a new Tenant 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 + +### NewTenantWithDefaults + +`func NewTenantWithDefaults() *Tenant` + +NewTenantWithDefaults instantiates a new Tenant 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 + +### GetId + +`func (o *Tenant) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Tenant) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Tenant) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Tenant) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Tenant) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Tenant) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Tenant) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Tenant) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetFullName + +`func (o *Tenant) GetFullName() string` + +GetFullName returns the FullName field if non-nil, zero value otherwise. + +### GetFullNameOk + +`func (o *Tenant) GetFullNameOk() (*string, bool)` + +GetFullNameOk returns a tuple with the FullName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFullName + +`func (o *Tenant) SetFullName(v string)` + +SetFullName sets FullName field to given value. + +### HasFullName + +`func (o *Tenant) HasFullName() bool` + +HasFullName returns a boolean if a field has been set. + +### GetPod + +`func (o *Tenant) GetPod() string` + +GetPod returns the Pod field if non-nil, zero value otherwise. + +### GetPodOk + +`func (o *Tenant) GetPodOk() (*string, bool)` + +GetPodOk returns a tuple with the Pod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPod + +`func (o *Tenant) SetPod(v string)` + +SetPod sets Pod field to given value. + +### HasPod + +`func (o *Tenant) HasPod() bool` + +HasPod returns a boolean if a field has been set. + +### GetRegion + +`func (o *Tenant) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *Tenant) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *Tenant) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *Tenant) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetDescription + +`func (o *Tenant) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Tenant) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Tenant) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Tenant) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetProducts + +`func (o *Tenant) GetProducts() []Product` + +GetProducts returns the Products field if non-nil, zero value otherwise. + +### GetProductsOk + +`func (o *Tenant) GetProductsOk() (*[]Product, bool)` + +GetProductsOk returns a tuple with the Products field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProducts + +`func (o *Tenant) SetProducts(v []Product)` + +SetProducts sets Products field to given value. + +### HasProducts + +`func (o *Tenant) HasProducts() bool` + +HasProducts returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TenantConfigurationDetails.md b/docs/tools/sdk/go/Reference/Beta/Models/TenantConfigurationDetails.md new file mode 100644 index 000000000..3d5b67693 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TenantConfigurationDetails.md @@ -0,0 +1,74 @@ +--- +id: beta-tenant-configuration-details +title: TenantConfigurationDetails +pagination_label: TenantConfigurationDetails +sidebar_label: TenantConfigurationDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantConfigurationDetails', 'BetaTenantConfigurationDetails'] +slug: /tools/sdk/go/beta/models/tenant-configuration-details +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationDetails', 'BetaTenantConfigurationDetails'] +--- + +# TenantConfigurationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Disabled** | Pointer to **NullableBool** | Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled. | [optional] [default to false] + +## Methods + +### NewTenantConfigurationDetails + +`func NewTenantConfigurationDetails() *TenantConfigurationDetails` + +NewTenantConfigurationDetails instantiates a new TenantConfigurationDetails 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 + +### NewTenantConfigurationDetailsWithDefaults + +`func NewTenantConfigurationDetailsWithDefaults() *TenantConfigurationDetails` + +NewTenantConfigurationDetailsWithDefaults instantiates a new TenantConfigurationDetails 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 + +### GetDisabled + +`func (o *TenantConfigurationDetails) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *TenantConfigurationDetails) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *TenantConfigurationDetails) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *TenantConfigurationDetails) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### SetDisabledNil + +`func (o *TenantConfigurationDetails) SetDisabledNil(b bool)` + + SetDisabledNil sets the value for Disabled to be an explicit nil + +### UnsetDisabled +`func (o *TenantConfigurationDetails) UnsetDisabled()` + +UnsetDisabled ensures that no value is present for Disabled, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TenantConfigurationRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/TenantConfigurationRequest.md new file mode 100644 index 000000000..8e633c8ca --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TenantConfigurationRequest.md @@ -0,0 +1,64 @@ +--- +id: beta-tenant-configuration-request +title: TenantConfigurationRequest +pagination_label: TenantConfigurationRequest +sidebar_label: TenantConfigurationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantConfigurationRequest', 'BetaTenantConfigurationRequest'] +slug: /tools/sdk/go/beta/models/tenant-configuration-request +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationRequest', 'BetaTenantConfigurationRequest'] +--- + +# TenantConfigurationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConfigDetails** | Pointer to [**TenantConfigurationDetails**](tenant-configuration-details) | | [optional] + +## Methods + +### NewTenantConfigurationRequest + +`func NewTenantConfigurationRequest() *TenantConfigurationRequest` + +NewTenantConfigurationRequest instantiates a new TenantConfigurationRequest 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 + +### NewTenantConfigurationRequestWithDefaults + +`func NewTenantConfigurationRequestWithDefaults() *TenantConfigurationRequest` + +NewTenantConfigurationRequestWithDefaults instantiates a new TenantConfigurationRequest 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 + +### GetConfigDetails + +`func (o *TenantConfigurationRequest) GetConfigDetails() TenantConfigurationDetails` + +GetConfigDetails returns the ConfigDetails field if non-nil, zero value otherwise. + +### GetConfigDetailsOk + +`func (o *TenantConfigurationRequest) GetConfigDetailsOk() (*TenantConfigurationDetails, bool)` + +GetConfigDetailsOk returns a tuple with the ConfigDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigDetails + +`func (o *TenantConfigurationRequest) SetConfigDetails(v TenantConfigurationDetails)` + +SetConfigDetails sets ConfigDetails field to given value. + +### HasConfigDetails + +`func (o *TenantConfigurationRequest) HasConfigDetails() bool` + +HasConfigDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TenantConfigurationResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/TenantConfigurationResponse.md new file mode 100644 index 000000000..a1e802065 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TenantConfigurationResponse.md @@ -0,0 +1,90 @@ +--- +id: beta-tenant-configuration-response +title: TenantConfigurationResponse +pagination_label: TenantConfigurationResponse +sidebar_label: TenantConfigurationResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantConfigurationResponse', 'BetaTenantConfigurationResponse'] +slug: /tools/sdk/go/beta/models/tenant-configuration-response +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationResponse', 'BetaTenantConfigurationResponse'] +--- + +# TenantConfigurationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuditDetails** | Pointer to [**AuditDetails**](audit-details) | | [optional] +**ConfigDetails** | Pointer to [**TenantConfigurationDetails**](tenant-configuration-details) | | [optional] + +## Methods + +### NewTenantConfigurationResponse + +`func NewTenantConfigurationResponse() *TenantConfigurationResponse` + +NewTenantConfigurationResponse instantiates a new TenantConfigurationResponse 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 + +### NewTenantConfigurationResponseWithDefaults + +`func NewTenantConfigurationResponseWithDefaults() *TenantConfigurationResponse` + +NewTenantConfigurationResponseWithDefaults instantiates a new TenantConfigurationResponse 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 + +### GetAuditDetails + +`func (o *TenantConfigurationResponse) GetAuditDetails() AuditDetails` + +GetAuditDetails returns the AuditDetails field if non-nil, zero value otherwise. + +### GetAuditDetailsOk + +`func (o *TenantConfigurationResponse) GetAuditDetailsOk() (*AuditDetails, bool)` + +GetAuditDetailsOk returns a tuple with the AuditDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuditDetails + +`func (o *TenantConfigurationResponse) SetAuditDetails(v AuditDetails)` + +SetAuditDetails sets AuditDetails field to given value. + +### HasAuditDetails + +`func (o *TenantConfigurationResponse) HasAuditDetails() bool` + +HasAuditDetails returns a boolean if a field has been set. + +### GetConfigDetails + +`func (o *TenantConfigurationResponse) GetConfigDetails() TenantConfigurationDetails` + +GetConfigDetails returns the ConfigDetails field if non-nil, zero value otherwise. + +### GetConfigDetailsOk + +`func (o *TenantConfigurationResponse) GetConfigDetailsOk() (*TenantConfigurationDetails, bool)` + +GetConfigDetailsOk returns a tuple with the ConfigDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigDetails + +`func (o *TenantConfigurationResponse) SetConfigDetails(v TenantConfigurationDetails)` + +SetConfigDetails sets ConfigDetails field to given value. + +### HasConfigDetails + +`func (o *TenantConfigurationResponse) HasConfigDetails() bool` + +HasConfigDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TenantUiMetadataItemResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/TenantUiMetadataItemResponse.md new file mode 100644 index 000000000..f19a1739f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TenantUiMetadataItemResponse.md @@ -0,0 +1,146 @@ +--- +id: beta-tenant-ui-metadata-item-response +title: TenantUiMetadataItemResponse +pagination_label: TenantUiMetadataItemResponse +sidebar_label: TenantUiMetadataItemResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantUiMetadataItemResponse', 'BetaTenantUiMetadataItemResponse'] +slug: /tools/sdk/go/beta/models/tenant-ui-metadata-item-response +tags: ['SDK', 'Software Development Kit', 'TenantUiMetadataItemResponse', 'BetaTenantUiMetadataItemResponse'] +--- + +# TenantUiMetadataItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IframeWhiteList** | Pointer to **NullableString** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [optional] +**UsernameLabel** | Pointer to **NullableString** | Descriptor for the username input field. If you would like to reset the value use \"null\". | [optional] +**UsernameEmptyText** | Pointer to **NullableString** | Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". | [optional] + +## Methods + +### NewTenantUiMetadataItemResponse + +`func NewTenantUiMetadataItemResponse() *TenantUiMetadataItemResponse` + +NewTenantUiMetadataItemResponse instantiates a new TenantUiMetadataItemResponse 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 + +### NewTenantUiMetadataItemResponseWithDefaults + +`func NewTenantUiMetadataItemResponseWithDefaults() *TenantUiMetadataItemResponse` + +NewTenantUiMetadataItemResponseWithDefaults instantiates a new TenantUiMetadataItemResponse 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 + +### GetIframeWhiteList + +`func (o *TenantUiMetadataItemResponse) GetIframeWhiteList() string` + +GetIframeWhiteList returns the IframeWhiteList field if non-nil, zero value otherwise. + +### GetIframeWhiteListOk + +`func (o *TenantUiMetadataItemResponse) GetIframeWhiteListOk() (*string, bool)` + +GetIframeWhiteListOk returns a tuple with the IframeWhiteList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIframeWhiteList + +`func (o *TenantUiMetadataItemResponse) SetIframeWhiteList(v string)` + +SetIframeWhiteList sets IframeWhiteList field to given value. + +### HasIframeWhiteList + +`func (o *TenantUiMetadataItemResponse) HasIframeWhiteList() bool` + +HasIframeWhiteList returns a boolean if a field has been set. + +### SetIframeWhiteListNil + +`func (o *TenantUiMetadataItemResponse) SetIframeWhiteListNil(b bool)` + + SetIframeWhiteListNil sets the value for IframeWhiteList to be an explicit nil + +### UnsetIframeWhiteList +`func (o *TenantUiMetadataItemResponse) UnsetIframeWhiteList()` + +UnsetIframeWhiteList ensures that no value is present for IframeWhiteList, not even an explicit nil +### GetUsernameLabel + +`func (o *TenantUiMetadataItemResponse) GetUsernameLabel() string` + +GetUsernameLabel returns the UsernameLabel field if non-nil, zero value otherwise. + +### GetUsernameLabelOk + +`func (o *TenantUiMetadataItemResponse) GetUsernameLabelOk() (*string, bool)` + +GetUsernameLabelOk returns a tuple with the UsernameLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsernameLabel + +`func (o *TenantUiMetadataItemResponse) SetUsernameLabel(v string)` + +SetUsernameLabel sets UsernameLabel field to given value. + +### HasUsernameLabel + +`func (o *TenantUiMetadataItemResponse) HasUsernameLabel() bool` + +HasUsernameLabel returns a boolean if a field has been set. + +### SetUsernameLabelNil + +`func (o *TenantUiMetadataItemResponse) SetUsernameLabelNil(b bool)` + + SetUsernameLabelNil sets the value for UsernameLabel to be an explicit nil + +### UnsetUsernameLabel +`func (o *TenantUiMetadataItemResponse) UnsetUsernameLabel()` + +UnsetUsernameLabel ensures that no value is present for UsernameLabel, not even an explicit nil +### GetUsernameEmptyText + +`func (o *TenantUiMetadataItemResponse) GetUsernameEmptyText() string` + +GetUsernameEmptyText returns the UsernameEmptyText field if non-nil, zero value otherwise. + +### GetUsernameEmptyTextOk + +`func (o *TenantUiMetadataItemResponse) GetUsernameEmptyTextOk() (*string, bool)` + +GetUsernameEmptyTextOk returns a tuple with the UsernameEmptyText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsernameEmptyText + +`func (o *TenantUiMetadataItemResponse) SetUsernameEmptyText(v string)` + +SetUsernameEmptyText sets UsernameEmptyText field to given value. + +### HasUsernameEmptyText + +`func (o *TenantUiMetadataItemResponse) HasUsernameEmptyText() bool` + +HasUsernameEmptyText returns a boolean if a field has been set. + +### SetUsernameEmptyTextNil + +`func (o *TenantUiMetadataItemResponse) SetUsernameEmptyTextNil(b bool)` + + SetUsernameEmptyTextNil sets the value for UsernameEmptyText to be an explicit nil + +### UnsetUsernameEmptyText +`func (o *TenantUiMetadataItemResponse) UnsetUsernameEmptyText()` + +UnsetUsernameEmptyText ensures that no value is present for UsernameEmptyText, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TenantUiMetadataItemUpdateRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/TenantUiMetadataItemUpdateRequest.md new file mode 100644 index 000000000..404cdbc7c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TenantUiMetadataItemUpdateRequest.md @@ -0,0 +1,146 @@ +--- +id: beta-tenant-ui-metadata-item-update-request +title: TenantUiMetadataItemUpdateRequest +pagination_label: TenantUiMetadataItemUpdateRequest +sidebar_label: TenantUiMetadataItemUpdateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantUiMetadataItemUpdateRequest', 'BetaTenantUiMetadataItemUpdateRequest'] +slug: /tools/sdk/go/beta/models/tenant-ui-metadata-item-update-request +tags: ['SDK', 'Software Development Kit', 'TenantUiMetadataItemUpdateRequest', 'BetaTenantUiMetadataItemUpdateRequest'] +--- + +# TenantUiMetadataItemUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IframeWhiteList** | Pointer to **NullableString** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [optional] +**UsernameLabel** | Pointer to **NullableString** | Descriptor for the username input field. If you would like to reset the value use \"null\". | [optional] +**UsernameEmptyText** | Pointer to **NullableString** | Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". | [optional] + +## Methods + +### NewTenantUiMetadataItemUpdateRequest + +`func NewTenantUiMetadataItemUpdateRequest() *TenantUiMetadataItemUpdateRequest` + +NewTenantUiMetadataItemUpdateRequest instantiates a new TenantUiMetadataItemUpdateRequest 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 + +### NewTenantUiMetadataItemUpdateRequestWithDefaults + +`func NewTenantUiMetadataItemUpdateRequestWithDefaults() *TenantUiMetadataItemUpdateRequest` + +NewTenantUiMetadataItemUpdateRequestWithDefaults instantiates a new TenantUiMetadataItemUpdateRequest 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 + +### GetIframeWhiteList + +`func (o *TenantUiMetadataItemUpdateRequest) GetIframeWhiteList() string` + +GetIframeWhiteList returns the IframeWhiteList field if non-nil, zero value otherwise. + +### GetIframeWhiteListOk + +`func (o *TenantUiMetadataItemUpdateRequest) GetIframeWhiteListOk() (*string, bool)` + +GetIframeWhiteListOk returns a tuple with the IframeWhiteList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIframeWhiteList + +`func (o *TenantUiMetadataItemUpdateRequest) SetIframeWhiteList(v string)` + +SetIframeWhiteList sets IframeWhiteList field to given value. + +### HasIframeWhiteList + +`func (o *TenantUiMetadataItemUpdateRequest) HasIframeWhiteList() bool` + +HasIframeWhiteList returns a boolean if a field has been set. + +### SetIframeWhiteListNil + +`func (o *TenantUiMetadataItemUpdateRequest) SetIframeWhiteListNil(b bool)` + + SetIframeWhiteListNil sets the value for IframeWhiteList to be an explicit nil + +### UnsetIframeWhiteList +`func (o *TenantUiMetadataItemUpdateRequest) UnsetIframeWhiteList()` + +UnsetIframeWhiteList ensures that no value is present for IframeWhiteList, not even an explicit nil +### GetUsernameLabel + +`func (o *TenantUiMetadataItemUpdateRequest) GetUsernameLabel() string` + +GetUsernameLabel returns the UsernameLabel field if non-nil, zero value otherwise. + +### GetUsernameLabelOk + +`func (o *TenantUiMetadataItemUpdateRequest) GetUsernameLabelOk() (*string, bool)` + +GetUsernameLabelOk returns a tuple with the UsernameLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsernameLabel + +`func (o *TenantUiMetadataItemUpdateRequest) SetUsernameLabel(v string)` + +SetUsernameLabel sets UsernameLabel field to given value. + +### HasUsernameLabel + +`func (o *TenantUiMetadataItemUpdateRequest) HasUsernameLabel() bool` + +HasUsernameLabel returns a boolean if a field has been set. + +### SetUsernameLabelNil + +`func (o *TenantUiMetadataItemUpdateRequest) SetUsernameLabelNil(b bool)` + + SetUsernameLabelNil sets the value for UsernameLabel to be an explicit nil + +### UnsetUsernameLabel +`func (o *TenantUiMetadataItemUpdateRequest) UnsetUsernameLabel()` + +UnsetUsernameLabel ensures that no value is present for UsernameLabel, not even an explicit nil +### GetUsernameEmptyText + +`func (o *TenantUiMetadataItemUpdateRequest) GetUsernameEmptyText() string` + +GetUsernameEmptyText returns the UsernameEmptyText field if non-nil, zero value otherwise. + +### GetUsernameEmptyTextOk + +`func (o *TenantUiMetadataItemUpdateRequest) GetUsernameEmptyTextOk() (*string, bool)` + +GetUsernameEmptyTextOk returns a tuple with the UsernameEmptyText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsernameEmptyText + +`func (o *TenantUiMetadataItemUpdateRequest) SetUsernameEmptyText(v string)` + +SetUsernameEmptyText sets UsernameEmptyText field to given value. + +### HasUsernameEmptyText + +`func (o *TenantUiMetadataItemUpdateRequest) HasUsernameEmptyText() bool` + +HasUsernameEmptyText returns a boolean if a field has been set. + +### SetUsernameEmptyTextNil + +`func (o *TenantUiMetadataItemUpdateRequest) SetUsernameEmptyTextNil(b bool)` + + SetUsernameEmptyTextNil sets the value for UsernameEmptyText to be an explicit nil + +### UnsetUsernameEmptyText +`func (o *TenantUiMetadataItemUpdateRequest) UnsetUsernameEmptyText()` + +UnsetUsernameEmptyText ensures that no value is present for UsernameEmptyText, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TestExternalExecuteWorkflow200Response.md b/docs/tools/sdk/go/Reference/Beta/Models/TestExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..7a0e8c12b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TestExternalExecuteWorkflow200Response.md @@ -0,0 +1,64 @@ +--- +id: beta-test-external-execute-workflow200-response +title: TestExternalExecuteWorkflow200Response +pagination_label: TestExternalExecuteWorkflow200Response +sidebar_label: TestExternalExecuteWorkflow200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestExternalExecuteWorkflow200Response', 'BetaTestExternalExecuteWorkflow200Response'] +slug: /tools/sdk/go/beta/models/test-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflow200Response', 'BetaTestExternalExecuteWorkflow200Response'] +--- + +# TestExternalExecuteWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Payload** | Pointer to **map[string]interface{}** | The input that was received | [optional] + +## Methods + +### NewTestExternalExecuteWorkflow200Response + +`func NewTestExternalExecuteWorkflow200Response() *TestExternalExecuteWorkflow200Response` + +NewTestExternalExecuteWorkflow200Response instantiates a new TestExternalExecuteWorkflow200Response 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 + +### NewTestExternalExecuteWorkflow200ResponseWithDefaults + +`func NewTestExternalExecuteWorkflow200ResponseWithDefaults() *TestExternalExecuteWorkflow200Response` + +NewTestExternalExecuteWorkflow200ResponseWithDefaults instantiates a new TestExternalExecuteWorkflow200Response 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 + +### GetPayload + +`func (o *TestExternalExecuteWorkflow200Response) GetPayload() map[string]interface{}` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *TestExternalExecuteWorkflow200Response) GetPayloadOk() (*map[string]interface{}, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPayload + +`func (o *TestExternalExecuteWorkflow200Response) SetPayload(v map[string]interface{})` + +SetPayload sets Payload field to given value. + +### HasPayload + +`func (o *TestExternalExecuteWorkflow200Response) HasPayload() bool` + +HasPayload returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TestExternalExecuteWorkflowRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/TestExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..b06c96abb --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TestExternalExecuteWorkflowRequest.md @@ -0,0 +1,64 @@ +--- +id: beta-test-external-execute-workflow-request +title: TestExternalExecuteWorkflowRequest +pagination_label: TestExternalExecuteWorkflowRequest +sidebar_label: TestExternalExecuteWorkflowRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestExternalExecuteWorkflowRequest', 'BetaTestExternalExecuteWorkflowRequest'] +slug: /tools/sdk/go/beta/models/test-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflowRequest', 'BetaTestExternalExecuteWorkflowRequest'] +--- + +# TestExternalExecuteWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | Pointer to **map[string]interface{}** | The test input for the workflow | [optional] + +## Methods + +### NewTestExternalExecuteWorkflowRequest + +`func NewTestExternalExecuteWorkflowRequest() *TestExternalExecuteWorkflowRequest` + +NewTestExternalExecuteWorkflowRequest instantiates a new TestExternalExecuteWorkflowRequest 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 + +### NewTestExternalExecuteWorkflowRequestWithDefaults + +`func NewTestExternalExecuteWorkflowRequestWithDefaults() *TestExternalExecuteWorkflowRequest` + +NewTestExternalExecuteWorkflowRequestWithDefaults instantiates a new TestExternalExecuteWorkflowRequest 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 + +### GetInput + +`func (o *TestExternalExecuteWorkflowRequest) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *TestExternalExecuteWorkflowRequest) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *TestExternalExecuteWorkflowRequest) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + +### HasInput + +`func (o *TestExternalExecuteWorkflowRequest) HasInput() bool` + +HasInput returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TestInvocation.md b/docs/tools/sdk/go/Reference/Beta/Models/TestInvocation.md new file mode 100644 index 000000000..68966acb0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TestInvocation.md @@ -0,0 +1,132 @@ +--- +id: beta-test-invocation +title: TestInvocation +pagination_label: TestInvocation +sidebar_label: TestInvocation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestInvocation', 'BetaTestInvocation'] +slug: /tools/sdk/go/beta/models/test-invocation +tags: ['SDK', 'Software Development Kit', 'TestInvocation', 'BetaTestInvocation'] +--- + +# TestInvocation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TriggerId** | **string** | Trigger ID | +**Input** | Pointer to **map[string]interface{}** | Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent. | [optional] +**ContentJson** | **map[string]interface{}** | JSON map of invocation metadata. | +**SubscriptionIds** | Pointer to **[]string** | Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers. | [optional] + +## Methods + +### NewTestInvocation + +`func NewTestInvocation(triggerId string, contentJson map[string]interface{}, ) *TestInvocation` + +NewTestInvocation instantiates a new TestInvocation 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 + +### NewTestInvocationWithDefaults + +`func NewTestInvocationWithDefaults() *TestInvocation` + +NewTestInvocationWithDefaults instantiates a new TestInvocation 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 + +### GetTriggerId + +`func (o *TestInvocation) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *TestInvocation) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *TestInvocation) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + + +### GetInput + +`func (o *TestInvocation) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *TestInvocation) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *TestInvocation) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + +### HasInput + +`func (o *TestInvocation) HasInput() bool` + +HasInput returns a boolean if a field has been set. + +### GetContentJson + +`func (o *TestInvocation) GetContentJson() map[string]interface{}` + +GetContentJson returns the ContentJson field if non-nil, zero value otherwise. + +### GetContentJsonOk + +`func (o *TestInvocation) GetContentJsonOk() (*map[string]interface{}, bool)` + +GetContentJsonOk returns a tuple with the ContentJson field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContentJson + +`func (o *TestInvocation) SetContentJson(v map[string]interface{})` + +SetContentJson sets ContentJson field to given value. + + +### GetSubscriptionIds + +`func (o *TestInvocation) GetSubscriptionIds() []string` + +GetSubscriptionIds returns the SubscriptionIds field if non-nil, zero value otherwise. + +### GetSubscriptionIdsOk + +`func (o *TestInvocation) GetSubscriptionIdsOk() (*[]string, bool)` + +GetSubscriptionIdsOk returns a tuple with the SubscriptionIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubscriptionIds + +`func (o *TestInvocation) SetSubscriptionIds(v []string)` + +SetSubscriptionIds sets SubscriptionIds field to given value. + +### HasSubscriptionIds + +`func (o *TestInvocation) HasSubscriptionIds() bool` + +HasSubscriptionIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TestSourceConnectionMultihost200Response.md b/docs/tools/sdk/go/Reference/Beta/Models/TestSourceConnectionMultihost200Response.md new file mode 100644 index 000000000..934e1bc4d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TestSourceConnectionMultihost200Response.md @@ -0,0 +1,168 @@ +--- +id: beta-test-source-connection-multihost200-response +title: TestSourceConnectionMultihost200Response +pagination_label: TestSourceConnectionMultihost200Response +sidebar_label: TestSourceConnectionMultihost200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestSourceConnectionMultihost200Response', 'BetaTestSourceConnectionMultihost200Response'] +slug: /tools/sdk/go/beta/models/test-source-connection-multihost200-response +tags: ['SDK', 'Software Development Kit', 'TestSourceConnectionMultihost200Response', 'BetaTestSourceConnectionMultihost200Response'] +--- + +# TestSourceConnectionMultihost200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Success** | Pointer to **bool** | Source's test connection status. | [optional] +**Message** | Pointer to **string** | Source's test connection message. | [optional] +**Timing** | Pointer to **int32** | Source's test connection timing. | [optional] +**ResultType** | Pointer to **map[string]interface{}** | Source's human-readable result type. | [optional] +**TestConnectionDetails** | Pointer to **string** | Source's human-readable test connection details. | [optional] + +## Methods + +### NewTestSourceConnectionMultihost200Response + +`func NewTestSourceConnectionMultihost200Response() *TestSourceConnectionMultihost200Response` + +NewTestSourceConnectionMultihost200Response instantiates a new TestSourceConnectionMultihost200Response 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 + +### NewTestSourceConnectionMultihost200ResponseWithDefaults + +`func NewTestSourceConnectionMultihost200ResponseWithDefaults() *TestSourceConnectionMultihost200Response` + +NewTestSourceConnectionMultihost200ResponseWithDefaults instantiates a new TestSourceConnectionMultihost200Response 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 + +### GetSuccess + +`func (o *TestSourceConnectionMultihost200Response) GetSuccess() bool` + +GetSuccess returns the Success field if non-nil, zero value otherwise. + +### GetSuccessOk + +`func (o *TestSourceConnectionMultihost200Response) GetSuccessOk() (*bool, bool)` + +GetSuccessOk returns a tuple with the Success field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSuccess + +`func (o *TestSourceConnectionMultihost200Response) SetSuccess(v bool)` + +SetSuccess sets Success field to given value. + +### HasSuccess + +`func (o *TestSourceConnectionMultihost200Response) HasSuccess() bool` + +HasSuccess returns a boolean if a field has been set. + +### GetMessage + +`func (o *TestSourceConnectionMultihost200Response) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *TestSourceConnectionMultihost200Response) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *TestSourceConnectionMultihost200Response) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *TestSourceConnectionMultihost200Response) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetTiming + +`func (o *TestSourceConnectionMultihost200Response) GetTiming() int32` + +GetTiming returns the Timing field if non-nil, zero value otherwise. + +### GetTimingOk + +`func (o *TestSourceConnectionMultihost200Response) GetTimingOk() (*int32, bool)` + +GetTimingOk returns a tuple with the Timing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTiming + +`func (o *TestSourceConnectionMultihost200Response) SetTiming(v int32)` + +SetTiming sets Timing field to given value. + +### HasTiming + +`func (o *TestSourceConnectionMultihost200Response) HasTiming() bool` + +HasTiming returns a boolean if a field has been set. + +### GetResultType + +`func (o *TestSourceConnectionMultihost200Response) GetResultType() map[string]interface{}` + +GetResultType returns the ResultType field if non-nil, zero value otherwise. + +### GetResultTypeOk + +`func (o *TestSourceConnectionMultihost200Response) GetResultTypeOk() (*map[string]interface{}, bool)` + +GetResultTypeOk returns a tuple with the ResultType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultType + +`func (o *TestSourceConnectionMultihost200Response) SetResultType(v map[string]interface{})` + +SetResultType sets ResultType field to given value. + +### HasResultType + +`func (o *TestSourceConnectionMultihost200Response) HasResultType() bool` + +HasResultType returns a boolean if a field has been set. + +### GetTestConnectionDetails + +`func (o *TestSourceConnectionMultihost200Response) GetTestConnectionDetails() string` + +GetTestConnectionDetails returns the TestConnectionDetails field if non-nil, zero value otherwise. + +### GetTestConnectionDetailsOk + +`func (o *TestSourceConnectionMultihost200Response) GetTestConnectionDetailsOk() (*string, bool)` + +GetTestConnectionDetailsOk returns a tuple with the TestConnectionDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTestConnectionDetails + +`func (o *TestSourceConnectionMultihost200Response) SetTestConnectionDetails(v string)` + +SetTestConnectionDetails sets TestConnectionDetails field to given value. + +### HasTestConnectionDetails + +`func (o *TestSourceConnectionMultihost200Response) HasTestConnectionDetails() bool` + +HasTestConnectionDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TestWorkflow200Response.md b/docs/tools/sdk/go/Reference/Beta/Models/TestWorkflow200Response.md new file mode 100644 index 000000000..d9d3c5b70 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TestWorkflow200Response.md @@ -0,0 +1,64 @@ +--- +id: beta-test-workflow200-response +title: TestWorkflow200Response +pagination_label: TestWorkflow200Response +sidebar_label: TestWorkflow200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestWorkflow200Response', 'BetaTestWorkflow200Response'] +slug: /tools/sdk/go/beta/models/test-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestWorkflow200Response', 'BetaTestWorkflow200Response'] +--- + +# TestWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**WorkflowExecutionId** | Pointer to **string** | The workflow execution id | [optional] + +## Methods + +### NewTestWorkflow200Response + +`func NewTestWorkflow200Response() *TestWorkflow200Response` + +NewTestWorkflow200Response instantiates a new TestWorkflow200Response 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 + +### NewTestWorkflow200ResponseWithDefaults + +`func NewTestWorkflow200ResponseWithDefaults() *TestWorkflow200Response` + +NewTestWorkflow200ResponseWithDefaults instantiates a new TestWorkflow200Response 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 + +### GetWorkflowExecutionId + +`func (o *TestWorkflow200Response) GetWorkflowExecutionId() string` + +GetWorkflowExecutionId returns the WorkflowExecutionId field if non-nil, zero value otherwise. + +### GetWorkflowExecutionIdOk + +`func (o *TestWorkflow200Response) GetWorkflowExecutionIdOk() (*string, bool)` + +GetWorkflowExecutionIdOk returns a tuple with the WorkflowExecutionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWorkflowExecutionId + +`func (o *TestWorkflow200Response) SetWorkflowExecutionId(v string)` + +SetWorkflowExecutionId sets WorkflowExecutionId field to given value. + +### HasWorkflowExecutionId + +`func (o *TestWorkflow200Response) HasWorkflowExecutionId() bool` + +HasWorkflowExecutionId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TestWorkflowRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/TestWorkflowRequest.md new file mode 100644 index 000000000..e1308a4e9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TestWorkflowRequest.md @@ -0,0 +1,59 @@ +--- +id: beta-test-workflow-request +title: TestWorkflowRequest +pagination_label: TestWorkflowRequest +sidebar_label: TestWorkflowRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestWorkflowRequest', 'BetaTestWorkflowRequest'] +slug: /tools/sdk/go/beta/models/test-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestWorkflowRequest', 'BetaTestWorkflowRequest'] +--- + +# TestWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | **map[string]interface{}** | The test input for the workflow. | + +## Methods + +### NewTestWorkflowRequest + +`func NewTestWorkflowRequest(input map[string]interface{}, ) *TestWorkflowRequest` + +NewTestWorkflowRequest instantiates a new TestWorkflowRequest 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 + +### NewTestWorkflowRequestWithDefaults + +`func NewTestWorkflowRequestWithDefaults() *TestWorkflowRequest` + +NewTestWorkflowRequestWithDefaults instantiates a new TestWorkflowRequest 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 + +### GetInput + +`func (o *TestWorkflowRequest) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *TestWorkflowRequest) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *TestWorkflowRequest) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TokenAuthRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/TokenAuthRequest.md new file mode 100644 index 000000000..050a0034c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TokenAuthRequest.md @@ -0,0 +1,101 @@ +--- +id: beta-token-auth-request +title: TokenAuthRequest +pagination_label: TokenAuthRequest +sidebar_label: TokenAuthRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TokenAuthRequest', 'BetaTokenAuthRequest'] +slug: /tools/sdk/go/beta/models/token-auth-request +tags: ['SDK', 'Software Development Kit', 'TokenAuthRequest', 'BetaTokenAuthRequest'] +--- + +# TokenAuthRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Token** | **string** | Token value | +**UserAlias** | **string** | User alias from table spt_identity field named 'name' | +**DeliveryType** | **string** | Token delivery type | + +## Methods + +### NewTokenAuthRequest + +`func NewTokenAuthRequest(token string, userAlias string, deliveryType string, ) *TokenAuthRequest` + +NewTokenAuthRequest instantiates a new TokenAuthRequest 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 + +### NewTokenAuthRequestWithDefaults + +`func NewTokenAuthRequestWithDefaults() *TokenAuthRequest` + +NewTokenAuthRequestWithDefaults instantiates a new TokenAuthRequest 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 + +### GetToken + +`func (o *TokenAuthRequest) GetToken() string` + +GetToken returns the Token field if non-nil, zero value otherwise. + +### GetTokenOk + +`func (o *TokenAuthRequest) GetTokenOk() (*string, bool)` + +GetTokenOk returns a tuple with the Token field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetToken + +`func (o *TokenAuthRequest) SetToken(v string)` + +SetToken sets Token field to given value. + + +### GetUserAlias + +`func (o *TokenAuthRequest) GetUserAlias() string` + +GetUserAlias returns the UserAlias field if non-nil, zero value otherwise. + +### GetUserAliasOk + +`func (o *TokenAuthRequest) GetUserAliasOk() (*string, bool)` + +GetUserAliasOk returns a tuple with the UserAlias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserAlias + +`func (o *TokenAuthRequest) SetUserAlias(v string)` + +SetUserAlias sets UserAlias field to given value. + + +### GetDeliveryType + +`func (o *TokenAuthRequest) GetDeliveryType() string` + +GetDeliveryType returns the DeliveryType field if non-nil, zero value otherwise. + +### GetDeliveryTypeOk + +`func (o *TokenAuthRequest) GetDeliveryTypeOk() (*string, bool)` + +GetDeliveryTypeOk returns a tuple with the DeliveryType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeliveryType + +`func (o *TokenAuthRequest) SetDeliveryType(v string)` + +SetDeliveryType sets DeliveryType field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TokenAuthResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/TokenAuthResponse.md new file mode 100644 index 000000000..6b4b68f9b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TokenAuthResponse.md @@ -0,0 +1,64 @@ +--- +id: beta-token-auth-response +title: TokenAuthResponse +pagination_label: TokenAuthResponse +sidebar_label: TokenAuthResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TokenAuthResponse', 'BetaTokenAuthResponse'] +slug: /tools/sdk/go/beta/models/token-auth-response +tags: ['SDK', 'Software Development Kit', 'TokenAuthResponse', 'BetaTokenAuthResponse'] +--- + +# TokenAuthResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | MFA Authentication status | [optional] + +## Methods + +### NewTokenAuthResponse + +`func NewTokenAuthResponse() *TokenAuthResponse` + +NewTokenAuthResponse instantiates a new TokenAuthResponse 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 + +### NewTokenAuthResponseWithDefaults + +`func NewTokenAuthResponseWithDefaults() *TokenAuthResponse` + +NewTokenAuthResponseWithDefaults instantiates a new TokenAuthResponse 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 + +### GetStatus + +`func (o *TokenAuthResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *TokenAuthResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *TokenAuthResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *TokenAuthResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Transform.md b/docs/tools/sdk/go/Reference/Beta/Models/Transform.md new file mode 100644 index 000000000..87c20f834 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Transform.md @@ -0,0 +1,111 @@ +--- +id: beta-transform +title: Transform +pagination_label: Transform +sidebar_label: Transform +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Transform', 'BetaTransform'] +slug: /tools/sdk/go/beta/models/transform +tags: ['SDK', 'Software Development Kit', 'Transform', 'BetaTransform'] +--- + +# Transform + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Unique name of this transform | +**Type** | **string** | The type of transform operation | +**Attributes** | **map[string]interface{}** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | + +## Methods + +### NewTransform + +`func NewTransform(name string, type_ string, attributes map[string]interface{}, ) *Transform` + +NewTransform instantiates a new Transform 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 + +### NewTransformWithDefaults + +`func NewTransformWithDefaults() *Transform` + +NewTransformWithDefaults instantiates a new Transform 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 + +### GetName + +`func (o *Transform) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Transform) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Transform) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *Transform) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Transform) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Transform) SetType(v string)` + +SetType sets Type field to given value. + + +### GetAttributes + +`func (o *Transform) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Transform) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Transform) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *Transform) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *Transform) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TransformDefinition.md b/docs/tools/sdk/go/Reference/Beta/Models/TransformDefinition.md new file mode 100644 index 000000000..3e998e78f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TransformDefinition.md @@ -0,0 +1,100 @@ +--- +id: beta-transform-definition +title: TransformDefinition +pagination_label: TransformDefinition +sidebar_label: TransformDefinition +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TransformDefinition', 'BetaTransformDefinition'] +slug: /tools/sdk/go/beta/models/transform-definition +tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'BetaTransformDefinition'] +--- + +# TransformDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Transform definition type. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Arbitrary key-value pairs to store any metadata for the object | [optional] + +## Methods + +### NewTransformDefinition + +`func NewTransformDefinition() *TransformDefinition` + +NewTransformDefinition instantiates a new TransformDefinition 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 + +### NewTransformDefinitionWithDefaults + +`func NewTransformDefinitionWithDefaults() *TransformDefinition` + +NewTransformDefinitionWithDefaults instantiates a new TransformDefinition 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 + +### GetType + +`func (o *TransformDefinition) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TransformDefinition) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TransformDefinition) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TransformDefinition) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetAttributes + +`func (o *TransformDefinition) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TransformDefinition) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TransformDefinition) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *TransformDefinition) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *TransformDefinition) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *TransformDefinition) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TransformDefinition1.md b/docs/tools/sdk/go/Reference/Beta/Models/TransformDefinition1.md new file mode 100644 index 000000000..17b23a190 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TransformDefinition1.md @@ -0,0 +1,90 @@ +--- +id: beta-transform-definition1 +title: TransformDefinition1 +pagination_label: TransformDefinition1 +sidebar_label: TransformDefinition1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TransformDefinition1', 'BetaTransformDefinition1'] +slug: /tools/sdk/go/beta/models/transform-definition1 +tags: ['SDK', 'Software Development Kit', 'TransformDefinition1', 'BetaTransformDefinition1'] +--- + +# TransformDefinition1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Transform definition type. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Arbitrary key-value pairs to store any metadata for the object | [optional] + +## Methods + +### NewTransformDefinition1 + +`func NewTransformDefinition1() *TransformDefinition1` + +NewTransformDefinition1 instantiates a new TransformDefinition1 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 + +### NewTransformDefinition1WithDefaults + +`func NewTransformDefinition1WithDefaults() *TransformDefinition1` + +NewTransformDefinition1WithDefaults instantiates a new TransformDefinition1 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 + +### GetType + +`func (o *TransformDefinition1) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TransformDefinition1) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TransformDefinition1) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TransformDefinition1) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetAttributes + +`func (o *TransformDefinition1) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TransformDefinition1) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TransformDefinition1) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *TransformDefinition1) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TransformRead.md b/docs/tools/sdk/go/Reference/Beta/Models/TransformRead.md new file mode 100644 index 000000000..267449ee0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TransformRead.md @@ -0,0 +1,153 @@ +--- +id: beta-transform-read +title: TransformRead +pagination_label: TransformRead +sidebar_label: TransformRead +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TransformRead', 'BetaTransformRead'] +slug: /tools/sdk/go/beta/models/transform-read +tags: ['SDK', 'Software Development Kit', 'TransformRead', 'BetaTransformRead'] +--- + +# TransformRead + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Unique name of this transform | +**Type** | **string** | The type of transform operation | +**Attributes** | **map[string]interface{}** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | +**Id** | **string** | Unique ID of this transform | +**Internal** | **bool** | Indicates whether this is an internal SailPoint-created transform or a customer-created transform | [default to false] + +## Methods + +### NewTransformRead + +`func NewTransformRead(name string, type_ string, attributes map[string]interface{}, id string, internal bool, ) *TransformRead` + +NewTransformRead instantiates a new TransformRead 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 + +### NewTransformReadWithDefaults + +`func NewTransformReadWithDefaults() *TransformRead` + +NewTransformReadWithDefaults instantiates a new TransformRead 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 + +### GetName + +`func (o *TransformRead) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TransformRead) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TransformRead) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *TransformRead) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TransformRead) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TransformRead) SetType(v string)` + +SetType sets Type field to given value. + + +### GetAttributes + +`func (o *TransformRead) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TransformRead) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TransformRead) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *TransformRead) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *TransformRead) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetId + +`func (o *TransformRead) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TransformRead) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TransformRead) SetId(v string)` + +SetId sets Id field to given value. + + +### GetInternal + +`func (o *TransformRead) GetInternal() bool` + +GetInternal returns the Internal field if non-nil, zero value otherwise. + +### GetInternalOk + +`func (o *TransformRead) GetInternalOk() (*bool, bool)` + +GetInternalOk returns a tuple with the Internal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternal + +`func (o *TransformRead) SetInternal(v bool)` + +SetInternal sets Internal field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TranslationMessage.md b/docs/tools/sdk/go/Reference/Beta/Models/TranslationMessage.md new file mode 100644 index 000000000..688c580f6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TranslationMessage.md @@ -0,0 +1,90 @@ +--- +id: beta-translation-message +title: TranslationMessage +pagination_label: TranslationMessage +sidebar_label: TranslationMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TranslationMessage', 'BetaTranslationMessage'] +slug: /tools/sdk/go/beta/models/translation-message +tags: ['SDK', 'Software Development Kit', 'TranslationMessage', 'BetaTranslationMessage'] +--- + +# TranslationMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The key of the translation message | [optional] +**Values** | Pointer to **[]string** | The values corresponding to the translation messages | [optional] + +## Methods + +### NewTranslationMessage + +`func NewTranslationMessage() *TranslationMessage` + +NewTranslationMessage instantiates a new TranslationMessage 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 + +### NewTranslationMessageWithDefaults + +`func NewTranslationMessageWithDefaults() *TranslationMessage` + +NewTranslationMessageWithDefaults instantiates a new TranslationMessage 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 + +### GetKey + +`func (o *TranslationMessage) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TranslationMessage) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TranslationMessage) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *TranslationMessage) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetValues + +`func (o *TranslationMessage) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *TranslationMessage) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *TranslationMessage) SetValues(v []string)` + +SetValues sets Values field to given value. + +### HasValues + +`func (o *TranslationMessage) HasValues() bool` + +HasValues returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Trigger.md b/docs/tools/sdk/go/Reference/Beta/Models/Trigger.md new file mode 100644 index 000000000..710fef4d3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Trigger.md @@ -0,0 +1,241 @@ +--- +id: beta-trigger +title: Trigger +pagination_label: Trigger +sidebar_label: Trigger +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Trigger', 'BetaTrigger'] +slug: /tools/sdk/go/beta/models/trigger +tags: ['SDK', 'Software Development Kit', 'Trigger', 'BetaTrigger'] +--- + +# Trigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier of the trigger. | +**Name** | **string** | Trigger Name. | +**Type** | [**TriggerType**](trigger-type) | | +**Description** | Pointer to **string** | Trigger Description. | [optional] +**InputSchema** | **string** | The JSON schema of the payload that will be sent by the trigger to the subscribed service. | +**ExampleInput** | [**TriggerExampleInput**](trigger-example-input) | | +**OutputSchema** | Pointer to **NullableString** | The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`. | [optional] +**ExampleOutput** | Pointer to [**NullableTriggerExampleOutput**](trigger-example-output) | | [optional] + +## Methods + +### NewTrigger + +`func NewTrigger(id string, name string, type_ TriggerType, inputSchema string, exampleInput TriggerExampleInput, ) *Trigger` + +NewTrigger instantiates a new Trigger 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 + +### NewTriggerWithDefaults + +`func NewTriggerWithDefaults() *Trigger` + +NewTriggerWithDefaults instantiates a new Trigger 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 + +### GetId + +`func (o *Trigger) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Trigger) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Trigger) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *Trigger) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Trigger) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Trigger) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *Trigger) GetType() TriggerType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Trigger) GetTypeOk() (*TriggerType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Trigger) SetType(v TriggerType)` + +SetType sets Type field to given value. + + +### GetDescription + +`func (o *Trigger) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Trigger) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Trigger) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Trigger) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetInputSchema + +`func (o *Trigger) GetInputSchema() string` + +GetInputSchema returns the InputSchema field if non-nil, zero value otherwise. + +### GetInputSchemaOk + +`func (o *Trigger) GetInputSchemaOk() (*string, bool)` + +GetInputSchemaOk returns a tuple with the InputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInputSchema + +`func (o *Trigger) SetInputSchema(v string)` + +SetInputSchema sets InputSchema field to given value. + + +### GetExampleInput + +`func (o *Trigger) GetExampleInput() TriggerExampleInput` + +GetExampleInput returns the ExampleInput field if non-nil, zero value otherwise. + +### GetExampleInputOk + +`func (o *Trigger) GetExampleInputOk() (*TriggerExampleInput, bool)` + +GetExampleInputOk returns a tuple with the ExampleInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExampleInput + +`func (o *Trigger) SetExampleInput(v TriggerExampleInput)` + +SetExampleInput sets ExampleInput field to given value. + + +### GetOutputSchema + +`func (o *Trigger) GetOutputSchema() string` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *Trigger) GetOutputSchemaOk() (*string, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *Trigger) SetOutputSchema(v string)` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *Trigger) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + +### SetOutputSchemaNil + +`func (o *Trigger) SetOutputSchemaNil(b bool)` + + SetOutputSchemaNil sets the value for OutputSchema to be an explicit nil + +### UnsetOutputSchema +`func (o *Trigger) UnsetOutputSchema()` + +UnsetOutputSchema ensures that no value is present for OutputSchema, not even an explicit nil +### GetExampleOutput + +`func (o *Trigger) GetExampleOutput() TriggerExampleOutput` + +GetExampleOutput returns the ExampleOutput field if non-nil, zero value otherwise. + +### GetExampleOutputOk + +`func (o *Trigger) GetExampleOutputOk() (*TriggerExampleOutput, bool)` + +GetExampleOutputOk returns a tuple with the ExampleOutput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExampleOutput + +`func (o *Trigger) SetExampleOutput(v TriggerExampleOutput)` + +SetExampleOutput sets ExampleOutput field to given value. + +### HasExampleOutput + +`func (o *Trigger) HasExampleOutput() bool` + +HasExampleOutput returns a boolean if a field has been set. + +### SetExampleOutputNil + +`func (o *Trigger) SetExampleOutputNil(b bool)` + + SetExampleOutputNil sets the value for ExampleOutput to be an explicit nil + +### UnsetExampleOutput +`func (o *Trigger) UnsetExampleOutput()` + +UnsetExampleOutput ensures that no value is present for ExampleOutput, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TriggerExampleInput.md b/docs/tools/sdk/go/Reference/Beta/Models/TriggerExampleInput.md new file mode 100644 index 000000000..6ea23e57e --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TriggerExampleInput.md @@ -0,0 +1,1122 @@ +--- +id: beta-trigger-example-input +title: TriggerExampleInput +pagination_label: TriggerExampleInput +sidebar_label: TriggerExampleInput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TriggerExampleInput', 'BetaTriggerExampleInput'] +slug: /tools/sdk/go/beta/models/trigger-example-input +tags: ['SDK', 'Software Development Kit', 'TriggerExampleInput', 'BetaTriggerExampleInput'] +--- + +# TriggerExampleInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **string** | Access request's unique ID. | +**RequestedFor** | [**[]AccessItemRequestedForDto1**](access-item-requested-for-dto1) | Identities whom access was requested for. | +**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details about each requested access item. | +**RequestedBy** | [**AccessItemRequesterDto1**](access-item-requester-dto1) | | +**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details about the outcome of each requested access item. | +**Source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | +**Status** | **map[string]interface{}** | The overall status of the collection. | +**Started** | **SailPointTime** | The date and time when the account collection started. | +**Completed** | **SailPointTime** | The date and time when the account collection finished. | +**Errors** | **[]string** | List of any accumulated error messages that occurred during provisioning. | +**Warnings** | **[]string** | List of any accumulated warning messages that occurred during provisioning. | +**Stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | +**Identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | +**Account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | +**Changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | List of identity's attributes that changed. | +**Attributes** | **map[string]interface{}** | Account attributes. The attributes' contents depend on the source's account schema. | +**EntitlementCount** | Pointer to **int32** | The number of entitlements associated with this account. | [optional] +**Campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | +**Certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | +**TrackingNumber** | **string** | Provisioning request's reference number. Useful for tracking status in the 'Account Activity' search interface. | +**Sources** | **string** | Sources the provisioning transactions were performed on. Sources are comma separated. | +**Action** | Pointer to **NullableString** | Origin of the provisioning request. | [optional] +**Recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | +**Requester** | Pointer to [**NullableProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional] +**AccountRequests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | List of provisioning instructions to perform on an account-by-account basis. | +**FileName** | **string** | Report file name. | +**OwnerEmail** | **string** | Email address of the identity who owns the saved search. | +**OwnerName** | **string** | Name of the identity who owns the saved search. | +**Query** | **string** | Search query used to generate the report. | +**SearchName** | **string** | Saved search name. | +**SearchResults** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | +**SignedS3Url** | **string** | The Amazon S3 URL to download the report from. | +**Uuid** | **string** | Identity's universal unique identifier (UUID) on the source. The source system generates the UUID. | +**Id** | **string** | Source's unique ID. | +**NativeIdentifier** | **string** | Account's unique ID on the source. | +**SourceId** | **string** | Source ID. | +**SourceName** | **string** | Source name. | +**IdentityId** | **string** | ID of the identity correlated with the account. | +**IdentityName** | **string** | Name of the identity correlated with the account. | +**Name** | **string** | Source name. | +**Type** | **string** | Connection type. | +**Created** | **SailPointTime** | Date and time when the status change occurred. | +**Connector** | **string** | Connector type used to connect to the source. | +**Actor** | [**SourceUpdatedActor**](source-updated-actor) | | +**Deleted** | **SailPointTime** | Date and time when the source was deleted. | +**Modified** | **SailPointTime** | Date and time when the source was modified. | +**Application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | +**HealthCheckResult** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | +**PreviousHealthCheckResult** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | + +## Methods + +### NewTriggerExampleInput + +`func NewTriggerExampleInput(accessRequestId string, requestedFor []AccessItemRequestedForDto1, requestedItems []AccessRequestPreApprovalRequestedItemsInner, requestedBy AccessItemRequesterDto1, requestedItemsStatus []AccessRequestPostApprovalRequestedItemsStatusInner, source AccountUncorrelatedSource, status map[string]interface{}, started SailPointTime, completed SailPointTime, errors []string, warnings []string, stats AccountsCollectedForAggregationStats, identity IdentityDeletedIdentity, account AccountUncorrelatedAccount, changes []IdentityAttributesChangedChangesInner, attributes map[string]interface{}, campaign CampaignGeneratedCampaign, certification CertificationSignedOffCertification, trackingNumber string, sources string, recipient ProvisioningCompletedRecipient, accountRequests []ProvisioningCompletedAccountRequestsInner, fileName string, ownerEmail string, ownerName string, query string, searchName string, searchResults SavedSearchCompleteSearchResults, signedS3Url string, uuid string, id string, nativeIdentifier string, sourceId string, sourceName string, identityId string, identityName string, name string, type_ string, created SailPointTime, connector string, actor SourceUpdatedActor, deleted SailPointTime, modified SailPointTime, application VAClusterStatusChangeEventApplication, healthCheckResult VAClusterStatusChangeEventHealthCheckResult, previousHealthCheckResult VAClusterStatusChangeEventPreviousHealthCheckResult, ) *TriggerExampleInput` + +NewTriggerExampleInput instantiates a new TriggerExampleInput 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 + +### NewTriggerExampleInputWithDefaults + +`func NewTriggerExampleInputWithDefaults() *TriggerExampleInput` + +NewTriggerExampleInputWithDefaults instantiates a new TriggerExampleInput 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 + +### GetAccessRequestId + +`func (o *TriggerExampleInput) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *TriggerExampleInput) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *TriggerExampleInput) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + + +### GetRequestedFor + +`func (o *TriggerExampleInput) GetRequestedFor() []AccessItemRequestedForDto1` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *TriggerExampleInput) GetRequestedForOk() (*[]AccessItemRequestedForDto1, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *TriggerExampleInput) SetRequestedFor(v []AccessItemRequestedForDto1)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestedItems + +`func (o *TriggerExampleInput) GetRequestedItems() []AccessRequestPreApprovalRequestedItemsInner` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *TriggerExampleInput) GetRequestedItemsOk() (*[]AccessRequestPreApprovalRequestedItemsInner, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *TriggerExampleInput) SetRequestedItems(v []AccessRequestPreApprovalRequestedItemsInner)` + +SetRequestedItems sets RequestedItems field to given value. + + +### GetRequestedBy + +`func (o *TriggerExampleInput) GetRequestedBy() AccessItemRequesterDto1` + +GetRequestedBy returns the RequestedBy field if non-nil, zero value otherwise. + +### GetRequestedByOk + +`func (o *TriggerExampleInput) GetRequestedByOk() (*AccessItemRequesterDto1, bool)` + +GetRequestedByOk returns a tuple with the RequestedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedBy + +`func (o *TriggerExampleInput) SetRequestedBy(v AccessItemRequesterDto1)` + +SetRequestedBy sets RequestedBy field to given value. + + +### GetRequestedItemsStatus + +`func (o *TriggerExampleInput) GetRequestedItemsStatus() []AccessRequestPostApprovalRequestedItemsStatusInner` + +GetRequestedItemsStatus returns the RequestedItemsStatus field if non-nil, zero value otherwise. + +### GetRequestedItemsStatusOk + +`func (o *TriggerExampleInput) GetRequestedItemsStatusOk() (*[]AccessRequestPostApprovalRequestedItemsStatusInner, bool)` + +GetRequestedItemsStatusOk returns a tuple with the RequestedItemsStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItemsStatus + +`func (o *TriggerExampleInput) SetRequestedItemsStatus(v []AccessRequestPostApprovalRequestedItemsStatusInner)` + +SetRequestedItemsStatus sets RequestedItemsStatus field to given value. + + +### GetSource + +`func (o *TriggerExampleInput) GetSource() AccountUncorrelatedSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *TriggerExampleInput) GetSourceOk() (*AccountUncorrelatedSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *TriggerExampleInput) SetSource(v AccountUncorrelatedSource)` + +SetSource sets Source field to given value. + + +### GetStatus + +`func (o *TriggerExampleInput) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *TriggerExampleInput) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *TriggerExampleInput) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + +### GetStarted + +`func (o *TriggerExampleInput) GetStarted() SailPointTime` + +GetStarted returns the Started field if non-nil, zero value otherwise. + +### GetStartedOk + +`func (o *TriggerExampleInput) GetStartedOk() (*SailPointTime, bool)` + +GetStartedOk returns a tuple with the Started field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStarted + +`func (o *TriggerExampleInput) SetStarted(v SailPointTime)` + +SetStarted sets Started field to given value. + + +### GetCompleted + +`func (o *TriggerExampleInput) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *TriggerExampleInput) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *TriggerExampleInput) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + + +### GetErrors + +`func (o *TriggerExampleInput) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *TriggerExampleInput) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *TriggerExampleInput) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + + +### SetErrorsNil + +`func (o *TriggerExampleInput) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *TriggerExampleInput) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *TriggerExampleInput) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *TriggerExampleInput) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *TriggerExampleInput) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + + +### SetWarningsNil + +`func (o *TriggerExampleInput) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *TriggerExampleInput) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetStats + +`func (o *TriggerExampleInput) GetStats() AccountsCollectedForAggregationStats` + +GetStats returns the Stats field if non-nil, zero value otherwise. + +### GetStatsOk + +`func (o *TriggerExampleInput) GetStatsOk() (*AccountsCollectedForAggregationStats, bool)` + +GetStatsOk returns a tuple with the Stats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStats + +`func (o *TriggerExampleInput) SetStats(v AccountsCollectedForAggregationStats)` + +SetStats sets Stats field to given value. + + +### GetIdentity + +`func (o *TriggerExampleInput) GetIdentity() IdentityDeletedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *TriggerExampleInput) GetIdentityOk() (*IdentityDeletedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *TriggerExampleInput) SetIdentity(v IdentityDeletedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetAccount + +`func (o *TriggerExampleInput) GetAccount() AccountUncorrelatedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *TriggerExampleInput) GetAccountOk() (*AccountUncorrelatedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *TriggerExampleInput) SetAccount(v AccountUncorrelatedAccount)` + +SetAccount sets Account field to given value. + + +### GetChanges + +`func (o *TriggerExampleInput) GetChanges() []IdentityAttributesChangedChangesInner` + +GetChanges returns the Changes field if non-nil, zero value otherwise. + +### GetChangesOk + +`func (o *TriggerExampleInput) GetChangesOk() (*[]IdentityAttributesChangedChangesInner, bool)` + +GetChangesOk returns a tuple with the Changes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanges + +`func (o *TriggerExampleInput) SetChanges(v []IdentityAttributesChangedChangesInner)` + +SetChanges sets Changes field to given value. + + +### GetAttributes + +`func (o *TriggerExampleInput) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TriggerExampleInput) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TriggerExampleInput) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetEntitlementCount + +`func (o *TriggerExampleInput) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *TriggerExampleInput) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *TriggerExampleInput) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *TriggerExampleInput) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetCampaign + +`func (o *TriggerExampleInput) GetCampaign() CampaignGeneratedCampaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *TriggerExampleInput) GetCampaignOk() (*CampaignGeneratedCampaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *TriggerExampleInput) SetCampaign(v CampaignGeneratedCampaign)` + +SetCampaign sets Campaign field to given value. + + +### GetCertification + +`func (o *TriggerExampleInput) GetCertification() CertificationSignedOffCertification` + +GetCertification returns the Certification field if non-nil, zero value otherwise. + +### GetCertificationOk + +`func (o *TriggerExampleInput) GetCertificationOk() (*CertificationSignedOffCertification, bool)` + +GetCertificationOk returns a tuple with the Certification field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertification + +`func (o *TriggerExampleInput) SetCertification(v CertificationSignedOffCertification)` + +SetCertification sets Certification field to given value. + + +### GetTrackingNumber + +`func (o *TriggerExampleInput) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *TriggerExampleInput) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *TriggerExampleInput) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + + +### GetSources + +`func (o *TriggerExampleInput) GetSources() string` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *TriggerExampleInput) GetSourcesOk() (*string, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *TriggerExampleInput) SetSources(v string)` + +SetSources sets Sources field to given value. + + +### GetAction + +`func (o *TriggerExampleInput) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *TriggerExampleInput) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *TriggerExampleInput) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *TriggerExampleInput) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### SetActionNil + +`func (o *TriggerExampleInput) SetActionNil(b bool)` + + SetActionNil sets the value for Action to be an explicit nil + +### UnsetAction +`func (o *TriggerExampleInput) UnsetAction()` + +UnsetAction ensures that no value is present for Action, not even an explicit nil +### GetRecipient + +`func (o *TriggerExampleInput) GetRecipient() ProvisioningCompletedRecipient` + +GetRecipient returns the Recipient field if non-nil, zero value otherwise. + +### GetRecipientOk + +`func (o *TriggerExampleInput) GetRecipientOk() (*ProvisioningCompletedRecipient, bool)` + +GetRecipientOk returns a tuple with the Recipient field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipient + +`func (o *TriggerExampleInput) SetRecipient(v ProvisioningCompletedRecipient)` + +SetRecipient sets Recipient field to given value. + + +### GetRequester + +`func (o *TriggerExampleInput) GetRequester() ProvisioningCompletedRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *TriggerExampleInput) GetRequesterOk() (*ProvisioningCompletedRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *TriggerExampleInput) SetRequester(v ProvisioningCompletedRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *TriggerExampleInput) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### SetRequesterNil + +`func (o *TriggerExampleInput) SetRequesterNil(b bool)` + + SetRequesterNil sets the value for Requester to be an explicit nil + +### UnsetRequester +`func (o *TriggerExampleInput) UnsetRequester()` + +UnsetRequester ensures that no value is present for Requester, not even an explicit nil +### GetAccountRequests + +`func (o *TriggerExampleInput) GetAccountRequests() []ProvisioningCompletedAccountRequestsInner` + +GetAccountRequests returns the AccountRequests field if non-nil, zero value otherwise. + +### GetAccountRequestsOk + +`func (o *TriggerExampleInput) GetAccountRequestsOk() (*[]ProvisioningCompletedAccountRequestsInner, bool)` + +GetAccountRequestsOk returns a tuple with the AccountRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountRequests + +`func (o *TriggerExampleInput) SetAccountRequests(v []ProvisioningCompletedAccountRequestsInner)` + +SetAccountRequests sets AccountRequests field to given value. + + +### GetFileName + +`func (o *TriggerExampleInput) GetFileName() string` + +GetFileName returns the FileName field if non-nil, zero value otherwise. + +### GetFileNameOk + +`func (o *TriggerExampleInput) GetFileNameOk() (*string, bool)` + +GetFileNameOk returns a tuple with the FileName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileName + +`func (o *TriggerExampleInput) SetFileName(v string)` + +SetFileName sets FileName field to given value. + + +### GetOwnerEmail + +`func (o *TriggerExampleInput) GetOwnerEmail() string` + +GetOwnerEmail returns the OwnerEmail field if non-nil, zero value otherwise. + +### GetOwnerEmailOk + +`func (o *TriggerExampleInput) GetOwnerEmailOk() (*string, bool)` + +GetOwnerEmailOk returns a tuple with the OwnerEmail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerEmail + +`func (o *TriggerExampleInput) SetOwnerEmail(v string)` + +SetOwnerEmail sets OwnerEmail field to given value. + + +### GetOwnerName + +`func (o *TriggerExampleInput) GetOwnerName() string` + +GetOwnerName returns the OwnerName field if non-nil, zero value otherwise. + +### GetOwnerNameOk + +`func (o *TriggerExampleInput) GetOwnerNameOk() (*string, bool)` + +GetOwnerNameOk returns a tuple with the OwnerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerName + +`func (o *TriggerExampleInput) SetOwnerName(v string)` + +SetOwnerName sets OwnerName field to given value. + + +### GetQuery + +`func (o *TriggerExampleInput) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *TriggerExampleInput) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *TriggerExampleInput) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetSearchName + +`func (o *TriggerExampleInput) GetSearchName() string` + +GetSearchName returns the SearchName field if non-nil, zero value otherwise. + +### GetSearchNameOk + +`func (o *TriggerExampleInput) GetSearchNameOk() (*string, bool)` + +GetSearchNameOk returns a tuple with the SearchName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchName + +`func (o *TriggerExampleInput) SetSearchName(v string)` + +SetSearchName sets SearchName field to given value. + + +### GetSearchResults + +`func (o *TriggerExampleInput) GetSearchResults() SavedSearchCompleteSearchResults` + +GetSearchResults returns the SearchResults field if non-nil, zero value otherwise. + +### GetSearchResultsOk + +`func (o *TriggerExampleInput) GetSearchResultsOk() (*SavedSearchCompleteSearchResults, bool)` + +GetSearchResultsOk returns a tuple with the SearchResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchResults + +`func (o *TriggerExampleInput) SetSearchResults(v SavedSearchCompleteSearchResults)` + +SetSearchResults sets SearchResults field to given value. + + +### GetSignedS3Url + +`func (o *TriggerExampleInput) GetSignedS3Url() string` + +GetSignedS3Url returns the SignedS3Url field if non-nil, zero value otherwise. + +### GetSignedS3UrlOk + +`func (o *TriggerExampleInput) GetSignedS3UrlOk() (*string, bool)` + +GetSignedS3UrlOk returns a tuple with the SignedS3Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignedS3Url + +`func (o *TriggerExampleInput) SetSignedS3Url(v string)` + +SetSignedS3Url sets SignedS3Url field to given value. + + +### GetUuid + +`func (o *TriggerExampleInput) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *TriggerExampleInput) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *TriggerExampleInput) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + + +### GetId + +`func (o *TriggerExampleInput) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TriggerExampleInput) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TriggerExampleInput) SetId(v string)` + +SetId sets Id field to given value. + + +### GetNativeIdentifier + +`func (o *TriggerExampleInput) GetNativeIdentifier() string` + +GetNativeIdentifier returns the NativeIdentifier field if non-nil, zero value otherwise. + +### GetNativeIdentifierOk + +`func (o *TriggerExampleInput) GetNativeIdentifierOk() (*string, bool)` + +GetNativeIdentifierOk returns a tuple with the NativeIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentifier + +`func (o *TriggerExampleInput) SetNativeIdentifier(v string)` + +SetNativeIdentifier sets NativeIdentifier field to given value. + + +### GetSourceId + +`func (o *TriggerExampleInput) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *TriggerExampleInput) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *TriggerExampleInput) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetSourceName + +`func (o *TriggerExampleInput) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *TriggerExampleInput) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *TriggerExampleInput) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### GetIdentityId + +`func (o *TriggerExampleInput) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *TriggerExampleInput) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *TriggerExampleInput) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetIdentityName + +`func (o *TriggerExampleInput) GetIdentityName() string` + +GetIdentityName returns the IdentityName field if non-nil, zero value otherwise. + +### GetIdentityNameOk + +`func (o *TriggerExampleInput) GetIdentityNameOk() (*string, bool)` + +GetIdentityNameOk returns a tuple with the IdentityName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityName + +`func (o *TriggerExampleInput) SetIdentityName(v string)` + +SetIdentityName sets IdentityName field to given value. + + +### GetName + +`func (o *TriggerExampleInput) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TriggerExampleInput) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TriggerExampleInput) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *TriggerExampleInput) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TriggerExampleInput) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TriggerExampleInput) SetType(v string)` + +SetType sets Type field to given value. + + +### GetCreated + +`func (o *TriggerExampleInput) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *TriggerExampleInput) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *TriggerExampleInput) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetConnector + +`func (o *TriggerExampleInput) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *TriggerExampleInput) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *TriggerExampleInput) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetActor + +`func (o *TriggerExampleInput) GetActor() SourceUpdatedActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *TriggerExampleInput) GetActorOk() (*SourceUpdatedActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *TriggerExampleInput) SetActor(v SourceUpdatedActor)` + +SetActor sets Actor field to given value. + + +### GetDeleted + +`func (o *TriggerExampleInput) GetDeleted() SailPointTime` + +GetDeleted returns the Deleted field if non-nil, zero value otherwise. + +### GetDeletedOk + +`func (o *TriggerExampleInput) GetDeletedOk() (*SailPointTime, bool)` + +GetDeletedOk returns a tuple with the Deleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleted + +`func (o *TriggerExampleInput) SetDeleted(v SailPointTime)` + +SetDeleted sets Deleted field to given value. + + +### GetModified + +`func (o *TriggerExampleInput) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *TriggerExampleInput) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *TriggerExampleInput) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetApplication + +`func (o *TriggerExampleInput) GetApplication() VAClusterStatusChangeEventApplication` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *TriggerExampleInput) GetApplicationOk() (*VAClusterStatusChangeEventApplication, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *TriggerExampleInput) SetApplication(v VAClusterStatusChangeEventApplication)` + +SetApplication sets Application field to given value. + + +### GetHealthCheckResult + +`func (o *TriggerExampleInput) GetHealthCheckResult() VAClusterStatusChangeEventHealthCheckResult` + +GetHealthCheckResult returns the HealthCheckResult field if non-nil, zero value otherwise. + +### GetHealthCheckResultOk + +`func (o *TriggerExampleInput) GetHealthCheckResultOk() (*VAClusterStatusChangeEventHealthCheckResult, bool)` + +GetHealthCheckResultOk returns a tuple with the HealthCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthCheckResult + +`func (o *TriggerExampleInput) SetHealthCheckResult(v VAClusterStatusChangeEventHealthCheckResult)` + +SetHealthCheckResult sets HealthCheckResult field to given value. + + +### GetPreviousHealthCheckResult + +`func (o *TriggerExampleInput) GetPreviousHealthCheckResult() VAClusterStatusChangeEventPreviousHealthCheckResult` + +GetPreviousHealthCheckResult returns the PreviousHealthCheckResult field if non-nil, zero value otherwise. + +### GetPreviousHealthCheckResultOk + +`func (o *TriggerExampleInput) GetPreviousHealthCheckResultOk() (*VAClusterStatusChangeEventPreviousHealthCheckResult, bool)` + +GetPreviousHealthCheckResultOk returns a tuple with the PreviousHealthCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousHealthCheckResult + +`func (o *TriggerExampleInput) SetPreviousHealthCheckResult(v VAClusterStatusChangeEventPreviousHealthCheckResult)` + +SetPreviousHealthCheckResult sets PreviousHealthCheckResult field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TriggerExampleOutput.md b/docs/tools/sdk/go/Reference/Beta/Models/TriggerExampleOutput.md new file mode 100644 index 000000000..f98acfb32 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TriggerExampleOutput.md @@ -0,0 +1,164 @@ +--- +id: beta-trigger-example-output +title: TriggerExampleOutput +pagination_label: TriggerExampleOutput +sidebar_label: TriggerExampleOutput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TriggerExampleOutput', 'BetaTriggerExampleOutput'] +slug: /tools/sdk/go/beta/models/trigger-example-output +tags: ['SDK', 'Software Development Kit', 'TriggerExampleOutput', 'BetaTriggerExampleOutput'] +--- + +# TriggerExampleOutput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the identity to add to the approver list for the access request. | +**Name** | **string** | The name of the identity to add to the approver list for the access request. | +**Type** | **map[string]interface{}** | The type of object being referenced. | +**Approved** | **bool** | Whether or not to approve the access request. | +**Comment** | **string** | A comment about the decision to approve or deny the request. | +**Approver** | **string** | The name of the entity that approved or denied the request. | + +## Methods + +### NewTriggerExampleOutput + +`func NewTriggerExampleOutput(id string, name string, type_ map[string]interface{}, approved bool, comment string, approver string, ) *TriggerExampleOutput` + +NewTriggerExampleOutput instantiates a new TriggerExampleOutput 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 + +### NewTriggerExampleOutputWithDefaults + +`func NewTriggerExampleOutputWithDefaults() *TriggerExampleOutput` + +NewTriggerExampleOutputWithDefaults instantiates a new TriggerExampleOutput 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 + +### GetId + +`func (o *TriggerExampleOutput) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TriggerExampleOutput) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TriggerExampleOutput) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *TriggerExampleOutput) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TriggerExampleOutput) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TriggerExampleOutput) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *TriggerExampleOutput) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TriggerExampleOutput) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TriggerExampleOutput) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetApproved + +`func (o *TriggerExampleOutput) GetApproved() bool` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *TriggerExampleOutput) GetApprovedOk() (*bool, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *TriggerExampleOutput) SetApproved(v bool)` + +SetApproved sets Approved field to given value. + + +### GetComment + +`func (o *TriggerExampleOutput) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *TriggerExampleOutput) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *TriggerExampleOutput) SetComment(v string)` + +SetComment sets Comment field to given value. + + +### GetApprover + +`func (o *TriggerExampleOutput) GetApprover() string` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *TriggerExampleOutput) GetApproverOk() (*string, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *TriggerExampleOutput) SetApprover(v string)` + +SetApprover sets Approver field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/TriggerType.md b/docs/tools/sdk/go/Reference/Beta/Models/TriggerType.md new file mode 100644 index 000000000..e9268d400 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/TriggerType.md @@ -0,0 +1,21 @@ +--- +id: beta-trigger-type +title: TriggerType +pagination_label: TriggerType +sidebar_label: TriggerType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TriggerType', 'BetaTriggerType'] +slug: /tools/sdk/go/beta/models/trigger-type +tags: ['SDK', 'Software Development Kit', 'TriggerType', 'BetaTriggerType'] +--- + +# TriggerType + +## Enum + + +* `REQUEST_RESPONSE` (value: `"REQUEST_RESPONSE"`) + +* `FIRE_AND_FORGET` (value: `"FIRE_AND_FORGET"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/UpdateAccessProfilesInBulk412Response.md b/docs/tools/sdk/go/Reference/Beta/Models/UpdateAccessProfilesInBulk412Response.md new file mode 100644 index 000000000..caf7c049a --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/UpdateAccessProfilesInBulk412Response.md @@ -0,0 +1,64 @@ +--- +id: beta-update-access-profiles-in-bulk412-response +title: UpdateAccessProfilesInBulk412Response +pagination_label: UpdateAccessProfilesInBulk412Response +sidebar_label: UpdateAccessProfilesInBulk412Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UpdateAccessProfilesInBulk412Response', 'BetaUpdateAccessProfilesInBulk412Response'] +slug: /tools/sdk/go/beta/models/update-access-profiles-in-bulk412-response +tags: ['SDK', 'Software Development Kit', 'UpdateAccessProfilesInBulk412Response', 'BetaUpdateAccessProfilesInBulk412Response'] +--- + +# UpdateAccessProfilesInBulk412Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **map[string]interface{}** | A message describing the error | [optional] + +## Methods + +### NewUpdateAccessProfilesInBulk412Response + +`func NewUpdateAccessProfilesInBulk412Response() *UpdateAccessProfilesInBulk412Response` + +NewUpdateAccessProfilesInBulk412Response instantiates a new UpdateAccessProfilesInBulk412Response 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 + +### NewUpdateAccessProfilesInBulk412ResponseWithDefaults + +`func NewUpdateAccessProfilesInBulk412ResponseWithDefaults() *UpdateAccessProfilesInBulk412Response` + +NewUpdateAccessProfilesInBulk412ResponseWithDefaults instantiates a new UpdateAccessProfilesInBulk412Response 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 + +### GetMessage + +`func (o *UpdateAccessProfilesInBulk412Response) GetMessage() map[string]interface{}` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *UpdateAccessProfilesInBulk412Response) GetMessageOk() (*map[string]interface{}, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *UpdateAccessProfilesInBulk412Response) SetMessage(v map[string]interface{})` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *UpdateAccessProfilesInBulk412Response) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/UpdateMultiHostSourcesRequestInner.md b/docs/tools/sdk/go/Reference/Beta/Models/UpdateMultiHostSourcesRequestInner.md new file mode 100644 index 000000000..8e35c35e7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/UpdateMultiHostSourcesRequestInner.md @@ -0,0 +1,106 @@ +--- +id: beta-update-multi-host-sources-request-inner +title: UpdateMultiHostSourcesRequestInner +pagination_label: UpdateMultiHostSourcesRequestInner +sidebar_label: UpdateMultiHostSourcesRequestInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UpdateMultiHostSourcesRequestInner', 'BetaUpdateMultiHostSourcesRequestInner'] +slug: /tools/sdk/go/beta/models/update-multi-host-sources-request-inner +tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInner', 'BetaUpdateMultiHostSourcesRequestInner'] +--- + +# UpdateMultiHostSourcesRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **string** | The operation to be performed | +**Path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | +**Value** | Pointer to [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] + +## Methods + +### NewUpdateMultiHostSourcesRequestInner + +`func NewUpdateMultiHostSourcesRequestInner(op string, path string, ) *UpdateMultiHostSourcesRequestInner` + +NewUpdateMultiHostSourcesRequestInner instantiates a new UpdateMultiHostSourcesRequestInner 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 + +### NewUpdateMultiHostSourcesRequestInnerWithDefaults + +`func NewUpdateMultiHostSourcesRequestInnerWithDefaults() *UpdateMultiHostSourcesRequestInner` + +NewUpdateMultiHostSourcesRequestInnerWithDefaults instantiates a new UpdateMultiHostSourcesRequestInner 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 + +### GetOp + +`func (o *UpdateMultiHostSourcesRequestInner) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *UpdateMultiHostSourcesRequestInner) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *UpdateMultiHostSourcesRequestInner) SetOp(v string)` + +SetOp sets Op field to given value. + + +### GetPath + +`func (o *UpdateMultiHostSourcesRequestInner) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *UpdateMultiHostSourcesRequestInner) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *UpdateMultiHostSourcesRequestInner) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetValue + +`func (o *UpdateMultiHostSourcesRequestInner) GetValue() UpdateMultiHostSourcesRequestInnerValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *UpdateMultiHostSourcesRequestInner) GetValueOk() (*UpdateMultiHostSourcesRequestInnerValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *UpdateMultiHostSourcesRequestInner) SetValue(v UpdateMultiHostSourcesRequestInnerValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *UpdateMultiHostSourcesRequestInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/UpdateMultiHostSourcesRequestInnerValue.md b/docs/tools/sdk/go/Reference/Beta/Models/UpdateMultiHostSourcesRequestInnerValue.md new file mode 100644 index 000000000..1de8835cd --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/UpdateMultiHostSourcesRequestInnerValue.md @@ -0,0 +1,38 @@ +--- +id: beta-update-multi-host-sources-request-inner-value +title: UpdateMultiHostSourcesRequestInnerValue +pagination_label: UpdateMultiHostSourcesRequestInnerValue +sidebar_label: UpdateMultiHostSourcesRequestInnerValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UpdateMultiHostSourcesRequestInnerValue', 'BetaUpdateMultiHostSourcesRequestInnerValue'] +slug: /tools/sdk/go/beta/models/update-multi-host-sources-request-inner-value +tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInnerValue', 'BetaUpdateMultiHostSourcesRequestInnerValue'] +--- + +# UpdateMultiHostSourcesRequestInnerValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewUpdateMultiHostSourcesRequestInnerValue + +`func NewUpdateMultiHostSourcesRequestInnerValue() *UpdateMultiHostSourcesRequestInnerValue` + +NewUpdateMultiHostSourcesRequestInnerValue instantiates a new UpdateMultiHostSourcesRequestInnerValue 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 + +### NewUpdateMultiHostSourcesRequestInnerValueWithDefaults + +`func NewUpdateMultiHostSourcesRequestInnerValueWithDefaults() *UpdateMultiHostSourcesRequestInnerValue` + +NewUpdateMultiHostSourcesRequestInnerValueWithDefaults instantiates a new UpdateMultiHostSourcesRequestInnerValue 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 + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/UsageType.md b/docs/tools/sdk/go/Reference/Beta/Models/UsageType.md new file mode 100644 index 000000000..5e325d22b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/UsageType.md @@ -0,0 +1,49 @@ +--- +id: beta-usage-type +title: UsageType +pagination_label: UsageType +sidebar_label: UsageType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UsageType', 'BetaUsageType'] +slug: /tools/sdk/go/beta/models/usage-type +tags: ['SDK', 'Software Development Kit', 'UsageType', 'BetaUsageType'] +--- + +# UsageType + +## Enum + + +* `CREATE` (value: `"CREATE"`) + +* `UPDATE` (value: `"UPDATE"`) + +* `ENABLE` (value: `"ENABLE"`) + +* `DISABLE` (value: `"DISABLE"`) + +* `DELETE` (value: `"DELETE"`) + +* `ASSIGN` (value: `"ASSIGN"`) + +* `UNASSIGN` (value: `"UNASSIGN"`) + +* `CREATE_GROUP` (value: `"CREATE_GROUP"`) + +* `UPDATE_GROUP` (value: `"UPDATE_GROUP"`) + +* `DELETE_GROUP` (value: `"DELETE_GROUP"`) + +* `REGISTER` (value: `"REGISTER"`) + +* `CREATE_IDENTITY` (value: `"CREATE_IDENTITY"`) + +* `UPDATE_IDENTITY` (value: `"UPDATE_IDENTITY"`) + +* `EDIT_GROUP` (value: `"EDIT_GROUP"`) + +* `UNLOCK` (value: `"UNLOCK"`) + +* `CHANGE_PASSWORD` (value: `"CHANGE_PASSWORD"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/UserApp.md b/docs/tools/sdk/go/Reference/Beta/Models/UserApp.md new file mode 100644 index 000000000..d079c0733 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/UserApp.md @@ -0,0 +1,324 @@ +--- +id: beta-user-app +title: UserApp +pagination_label: UserApp +sidebar_label: UserApp +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserApp', 'BetaUserApp'] +slug: /tools/sdk/go/beta/models/user-app +tags: ['SDK', 'Software Development Kit', 'UserApp', 'BetaUserApp'] +--- + +# UserApp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The user app id | [optional] +**Created** | Pointer to **SailPointTime** | Time when the user app was created | [optional] +**Modified** | Pointer to **SailPointTime** | Time when the user app was last modified | [optional] +**HasMultipleAccounts** | Pointer to **bool** | True if the owner has multiple accounts for the source | [optional] [default to false] +**UseForPasswordManagement** | Pointer to **bool** | True if the source has password feature | [optional] [default to false] +**ProvisionRequestEnabled** | Pointer to **bool** | True if the source app related to the user app is provision request enabled | [optional] [default to false] +**AppCenterEnabled** | Pointer to **bool** | True if the source app related to the user app is shown in the app center | [optional] [default to true] +**SourceApp** | Pointer to [**UserAppSourceApp**](user-app-source-app) | | [optional] +**Source** | Pointer to [**UserAppSource**](user-app-source) | | [optional] +**Account** | Pointer to [**UserAppAccount**](user-app-account) | | [optional] +**Owner** | Pointer to [**UserAppOwner**](user-app-owner) | | [optional] + +## Methods + +### NewUserApp + +`func NewUserApp() *UserApp` + +NewUserApp instantiates a new UserApp 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 + +### NewUserAppWithDefaults + +`func NewUserAppWithDefaults() *UserApp` + +NewUserAppWithDefaults instantiates a new UserApp 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 + +### GetId + +`func (o *UserApp) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserApp) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserApp) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserApp) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreated + +`func (o *UserApp) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *UserApp) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *UserApp) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *UserApp) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *UserApp) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *UserApp) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *UserApp) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *UserApp) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetHasMultipleAccounts + +`func (o *UserApp) GetHasMultipleAccounts() bool` + +GetHasMultipleAccounts returns the HasMultipleAccounts field if non-nil, zero value otherwise. + +### GetHasMultipleAccountsOk + +`func (o *UserApp) GetHasMultipleAccountsOk() (*bool, bool)` + +GetHasMultipleAccountsOk returns a tuple with the HasMultipleAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasMultipleAccounts + +`func (o *UserApp) SetHasMultipleAccounts(v bool)` + +SetHasMultipleAccounts sets HasMultipleAccounts field to given value. + +### HasHasMultipleAccounts + +`func (o *UserApp) HasHasMultipleAccounts() bool` + +HasHasMultipleAccounts returns a boolean if a field has been set. + +### GetUseForPasswordManagement + +`func (o *UserApp) GetUseForPasswordManagement() bool` + +GetUseForPasswordManagement returns the UseForPasswordManagement field if non-nil, zero value otherwise. + +### GetUseForPasswordManagementOk + +`func (o *UserApp) GetUseForPasswordManagementOk() (*bool, bool)` + +GetUseForPasswordManagementOk returns a tuple with the UseForPasswordManagement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseForPasswordManagement + +`func (o *UserApp) SetUseForPasswordManagement(v bool)` + +SetUseForPasswordManagement sets UseForPasswordManagement field to given value. + +### HasUseForPasswordManagement + +`func (o *UserApp) HasUseForPasswordManagement() bool` + +HasUseForPasswordManagement returns a boolean if a field has been set. + +### GetProvisionRequestEnabled + +`func (o *UserApp) GetProvisionRequestEnabled() bool` + +GetProvisionRequestEnabled returns the ProvisionRequestEnabled field if non-nil, zero value otherwise. + +### GetProvisionRequestEnabledOk + +`func (o *UserApp) GetProvisionRequestEnabledOk() (*bool, bool)` + +GetProvisionRequestEnabledOk returns a tuple with the ProvisionRequestEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionRequestEnabled + +`func (o *UserApp) SetProvisionRequestEnabled(v bool)` + +SetProvisionRequestEnabled sets ProvisionRequestEnabled field to given value. + +### HasProvisionRequestEnabled + +`func (o *UserApp) HasProvisionRequestEnabled() bool` + +HasProvisionRequestEnabled returns a boolean if a field has been set. + +### GetAppCenterEnabled + +`func (o *UserApp) GetAppCenterEnabled() bool` + +GetAppCenterEnabled returns the AppCenterEnabled field if non-nil, zero value otherwise. + +### GetAppCenterEnabledOk + +`func (o *UserApp) GetAppCenterEnabledOk() (*bool, bool)` + +GetAppCenterEnabledOk returns a tuple with the AppCenterEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppCenterEnabled + +`func (o *UserApp) SetAppCenterEnabled(v bool)` + +SetAppCenterEnabled sets AppCenterEnabled field to given value. + +### HasAppCenterEnabled + +`func (o *UserApp) HasAppCenterEnabled() bool` + +HasAppCenterEnabled returns a boolean if a field has been set. + +### GetSourceApp + +`func (o *UserApp) GetSourceApp() UserAppSourceApp` + +GetSourceApp returns the SourceApp field if non-nil, zero value otherwise. + +### GetSourceAppOk + +`func (o *UserApp) GetSourceAppOk() (*UserAppSourceApp, bool)` + +GetSourceAppOk returns a tuple with the SourceApp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceApp + +`func (o *UserApp) SetSourceApp(v UserAppSourceApp)` + +SetSourceApp sets SourceApp field to given value. + +### HasSourceApp + +`func (o *UserApp) HasSourceApp() bool` + +HasSourceApp returns a boolean if a field has been set. + +### GetSource + +`func (o *UserApp) GetSource() UserAppSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *UserApp) GetSourceOk() (*UserAppSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *UserApp) SetSource(v UserAppSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *UserApp) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAccount + +`func (o *UserApp) GetAccount() UserAppAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *UserApp) GetAccountOk() (*UserAppAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *UserApp) SetAccount(v UserAppAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *UserApp) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### GetOwner + +`func (o *UserApp) GetOwner() UserAppOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *UserApp) GetOwnerOk() (*UserAppOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *UserApp) SetOwner(v UserAppOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *UserApp) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/UserAppAccount.md b/docs/tools/sdk/go/Reference/Beta/Models/UserAppAccount.md new file mode 100644 index 000000000..28afb8831 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/UserAppAccount.md @@ -0,0 +1,116 @@ +--- +id: beta-user-app-account +title: UserAppAccount +pagination_label: UserAppAccount +sidebar_label: UserAppAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserAppAccount', 'BetaUserAppAccount'] +slug: /tools/sdk/go/beta/models/user-app-account +tags: ['SDK', 'Software Development Kit', 'UserAppAccount', 'BetaUserAppAccount'] +--- + +# UserAppAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the account ID | [optional] +**Type** | Pointer to **string** | It will always be \"ACCOUNT\" | [optional] +**Name** | Pointer to **string** | the account name | [optional] + +## Methods + +### NewUserAppAccount + +`func NewUserAppAccount() *UserAppAccount` + +NewUserAppAccount instantiates a new UserAppAccount 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 + +### NewUserAppAccountWithDefaults + +`func NewUserAppAccountWithDefaults() *UserAppAccount` + +NewUserAppAccountWithDefaults instantiates a new UserAppAccount 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 + +### GetId + +`func (o *UserAppAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserAppAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserAppAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserAppAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *UserAppAccount) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UserAppAccount) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *UserAppAccount) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *UserAppAccount) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *UserAppAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UserAppAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UserAppAccount) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *UserAppAccount) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/UserAppOwner.md b/docs/tools/sdk/go/Reference/Beta/Models/UserAppOwner.md new file mode 100644 index 000000000..b147cf268 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/UserAppOwner.md @@ -0,0 +1,142 @@ +--- +id: beta-user-app-owner +title: UserAppOwner +pagination_label: UserAppOwner +sidebar_label: UserAppOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserAppOwner', 'BetaUserAppOwner'] +slug: /tools/sdk/go/beta/models/user-app-owner +tags: ['SDK', 'Software Development Kit', 'UserAppOwner', 'BetaUserAppOwner'] +--- + +# UserAppOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity ID | [optional] +**Type** | Pointer to **string** | It will always be \"IDENTITY\" | [optional] +**Name** | Pointer to **string** | The identity name | [optional] +**Alias** | Pointer to **string** | The identity alias | [optional] + +## Methods + +### NewUserAppOwner + +`func NewUserAppOwner() *UserAppOwner` + +NewUserAppOwner instantiates a new UserAppOwner 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 + +### NewUserAppOwnerWithDefaults + +`func NewUserAppOwnerWithDefaults() *UserAppOwner` + +NewUserAppOwnerWithDefaults instantiates a new UserAppOwner 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 + +### GetId + +`func (o *UserAppOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserAppOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserAppOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserAppOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *UserAppOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UserAppOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *UserAppOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *UserAppOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *UserAppOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UserAppOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UserAppOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *UserAppOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAlias + +`func (o *UserAppOwner) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *UserAppOwner) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *UserAppOwner) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *UserAppOwner) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/UserAppSource.md b/docs/tools/sdk/go/Reference/Beta/Models/UserAppSource.md new file mode 100644 index 000000000..b143f7b02 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/UserAppSource.md @@ -0,0 +1,116 @@ +--- +id: beta-user-app-source +title: UserAppSource +pagination_label: UserAppSource +sidebar_label: UserAppSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserAppSource', 'BetaUserAppSource'] +slug: /tools/sdk/go/beta/models/user-app-source +tags: ['SDK', 'Software Development Kit', 'UserAppSource', 'BetaUserAppSource'] +--- + +# UserAppSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the source ID | [optional] +**Type** | Pointer to **string** | It will always be \"SOURCE\" | [optional] +**Name** | Pointer to **string** | the source name | [optional] + +## Methods + +### NewUserAppSource + +`func NewUserAppSource() *UserAppSource` + +NewUserAppSource instantiates a new UserAppSource 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 + +### NewUserAppSourceWithDefaults + +`func NewUserAppSourceWithDefaults() *UserAppSource` + +NewUserAppSourceWithDefaults instantiates a new UserAppSource 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 + +### GetId + +`func (o *UserAppSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserAppSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserAppSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserAppSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *UserAppSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UserAppSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *UserAppSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *UserAppSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *UserAppSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UserAppSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UserAppSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *UserAppSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/UserAppSourceApp.md b/docs/tools/sdk/go/Reference/Beta/Models/UserAppSourceApp.md new file mode 100644 index 000000000..b0c28c258 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/UserAppSourceApp.md @@ -0,0 +1,116 @@ +--- +id: beta-user-app-source-app +title: UserAppSourceApp +pagination_label: UserAppSourceApp +sidebar_label: UserAppSourceApp +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserAppSourceApp', 'BetaUserAppSourceApp'] +slug: /tools/sdk/go/beta/models/user-app-source-app +tags: ['SDK', 'Software Development Kit', 'UserAppSourceApp', 'BetaUserAppSourceApp'] +--- + +# UserAppSourceApp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the source app ID | [optional] +**Type** | Pointer to **string** | It will always be \"APPLICATION\" | [optional] +**Name** | Pointer to **string** | the source app name | [optional] + +## Methods + +### NewUserAppSourceApp + +`func NewUserAppSourceApp() *UserAppSourceApp` + +NewUserAppSourceApp instantiates a new UserAppSourceApp 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 + +### NewUserAppSourceAppWithDefaults + +`func NewUserAppSourceAppWithDefaults() *UserAppSourceApp` + +NewUserAppSourceAppWithDefaults instantiates a new UserAppSourceApp 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 + +### GetId + +`func (o *UserAppSourceApp) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserAppSourceApp) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserAppSourceApp) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserAppSourceApp) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *UserAppSourceApp) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UserAppSourceApp) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *UserAppSourceApp) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *UserAppSourceApp) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *UserAppSourceApp) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UserAppSourceApp) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UserAppSourceApp) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *UserAppSourceApp) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/V3ConnectorDto.md b/docs/tools/sdk/go/Reference/Beta/Models/V3ConnectorDto.md new file mode 100644 index 000000000..487e7f985 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/V3ConnectorDto.md @@ -0,0 +1,266 @@ +--- +id: beta-v3-connector-dto +title: V3ConnectorDto +pagination_label: V3ConnectorDto +sidebar_label: V3ConnectorDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'V3ConnectorDto', 'BetaV3ConnectorDto'] +slug: /tools/sdk/go/beta/models/v3-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3ConnectorDto', 'BetaV3ConnectorDto'] +--- + +# V3ConnectorDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The connector name | [optional] +**Type** | Pointer to **string** | The connector type | [optional] +**ScriptName** | Pointer to **string** | The connector script name | [optional] +**ClassName** | Pointer to **NullableString** | The connector class name. | [optional] +**Features** | Pointer to **[]string** | The list of features supported by the connector | [optional] +**DirectConnect** | Pointer to **bool** | true if the source is a direct connect source | [optional] [default to false] +**ConnectorMetadata** | Pointer to **map[string]interface{}** | Object containing metadata pertinent to the UI to be used | [optional] +**Status** | Pointer to **string** | The connector status | [optional] + +## Methods + +### NewV3ConnectorDto + +`func NewV3ConnectorDto() *V3ConnectorDto` + +NewV3ConnectorDto instantiates a new V3ConnectorDto 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 + +### NewV3ConnectorDtoWithDefaults + +`func NewV3ConnectorDtoWithDefaults() *V3ConnectorDto` + +NewV3ConnectorDtoWithDefaults instantiates a new V3ConnectorDto 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 + +### GetName + +`func (o *V3ConnectorDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *V3ConnectorDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *V3ConnectorDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *V3ConnectorDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *V3ConnectorDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *V3ConnectorDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *V3ConnectorDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *V3ConnectorDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetScriptName + +`func (o *V3ConnectorDto) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *V3ConnectorDto) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *V3ConnectorDto) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + +### HasScriptName + +`func (o *V3ConnectorDto) HasScriptName() bool` + +HasScriptName returns a boolean if a field has been set. + +### GetClassName + +`func (o *V3ConnectorDto) GetClassName() string` + +GetClassName returns the ClassName field if non-nil, zero value otherwise. + +### GetClassNameOk + +`func (o *V3ConnectorDto) GetClassNameOk() (*string, bool)` + +GetClassNameOk returns a tuple with the ClassName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClassName + +`func (o *V3ConnectorDto) SetClassName(v string)` + +SetClassName sets ClassName field to given value. + +### HasClassName + +`func (o *V3ConnectorDto) HasClassName() bool` + +HasClassName returns a boolean if a field has been set. + +### SetClassNameNil + +`func (o *V3ConnectorDto) SetClassNameNil(b bool)` + + SetClassNameNil sets the value for ClassName to be an explicit nil + +### UnsetClassName +`func (o *V3ConnectorDto) UnsetClassName()` + +UnsetClassName ensures that no value is present for ClassName, not even an explicit nil +### GetFeatures + +`func (o *V3ConnectorDto) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *V3ConnectorDto) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *V3ConnectorDto) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *V3ConnectorDto) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### SetFeaturesNil + +`func (o *V3ConnectorDto) SetFeaturesNil(b bool)` + + SetFeaturesNil sets the value for Features to be an explicit nil + +### UnsetFeatures +`func (o *V3ConnectorDto) UnsetFeatures()` + +UnsetFeatures ensures that no value is present for Features, not even an explicit nil +### GetDirectConnect + +`func (o *V3ConnectorDto) GetDirectConnect() bool` + +GetDirectConnect returns the DirectConnect field if non-nil, zero value otherwise. + +### GetDirectConnectOk + +`func (o *V3ConnectorDto) GetDirectConnectOk() (*bool, bool)` + +GetDirectConnectOk returns a tuple with the DirectConnect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectConnect + +`func (o *V3ConnectorDto) SetDirectConnect(v bool)` + +SetDirectConnect sets DirectConnect field to given value. + +### HasDirectConnect + +`func (o *V3ConnectorDto) HasDirectConnect() bool` + +HasDirectConnect returns a boolean if a field has been set. + +### GetConnectorMetadata + +`func (o *V3ConnectorDto) GetConnectorMetadata() map[string]interface{}` + +GetConnectorMetadata returns the ConnectorMetadata field if non-nil, zero value otherwise. + +### GetConnectorMetadataOk + +`func (o *V3ConnectorDto) GetConnectorMetadataOk() (*map[string]interface{}, bool)` + +GetConnectorMetadataOk returns a tuple with the ConnectorMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorMetadata + +`func (o *V3ConnectorDto) SetConnectorMetadata(v map[string]interface{})` + +SetConnectorMetadata sets ConnectorMetadata field to given value. + +### HasConnectorMetadata + +`func (o *V3ConnectorDto) HasConnectorMetadata() bool` + +HasConnectorMetadata returns a boolean if a field has been set. + +### GetStatus + +`func (o *V3ConnectorDto) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *V3ConnectorDto) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *V3ConnectorDto) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *V3ConnectorDto) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/VAClusterStatusChangeEvent.md b/docs/tools/sdk/go/Reference/Beta/Models/VAClusterStatusChangeEvent.md new file mode 100644 index 000000000..10f7ca3c4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/VAClusterStatusChangeEvent.md @@ -0,0 +1,143 @@ +--- +id: beta-va-cluster-status-change-event +title: VAClusterStatusChangeEvent +pagination_label: VAClusterStatusChangeEvent +sidebar_label: VAClusterStatusChangeEvent +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VAClusterStatusChangeEvent', 'BetaVAClusterStatusChangeEvent'] +slug: /tools/sdk/go/beta/models/va-cluster-status-change-event +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEvent', 'BetaVAClusterStatusChangeEvent'] +--- + +# VAClusterStatusChangeEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | **SailPointTime** | Date and time when the status change occurred. | +**Type** | **map[string]interface{}** | Type of the object that initiated the event. | +**Application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | +**HealthCheckResult** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | +**PreviousHealthCheckResult** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | + +## Methods + +### NewVAClusterStatusChangeEvent + +`func NewVAClusterStatusChangeEvent(created SailPointTime, type_ map[string]interface{}, application VAClusterStatusChangeEventApplication, healthCheckResult VAClusterStatusChangeEventHealthCheckResult, previousHealthCheckResult VAClusterStatusChangeEventPreviousHealthCheckResult, ) *VAClusterStatusChangeEvent` + +NewVAClusterStatusChangeEvent instantiates a new VAClusterStatusChangeEvent 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 + +### NewVAClusterStatusChangeEventWithDefaults + +`func NewVAClusterStatusChangeEventWithDefaults() *VAClusterStatusChangeEvent` + +NewVAClusterStatusChangeEventWithDefaults instantiates a new VAClusterStatusChangeEvent 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 + +### GetCreated + +`func (o *VAClusterStatusChangeEvent) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *VAClusterStatusChangeEvent) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *VAClusterStatusChangeEvent) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetType + +`func (o *VAClusterStatusChangeEvent) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *VAClusterStatusChangeEvent) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *VAClusterStatusChangeEvent) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetApplication + +`func (o *VAClusterStatusChangeEvent) GetApplication() VAClusterStatusChangeEventApplication` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *VAClusterStatusChangeEvent) GetApplicationOk() (*VAClusterStatusChangeEventApplication, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *VAClusterStatusChangeEvent) SetApplication(v VAClusterStatusChangeEventApplication)` + +SetApplication sets Application field to given value. + + +### GetHealthCheckResult + +`func (o *VAClusterStatusChangeEvent) GetHealthCheckResult() VAClusterStatusChangeEventHealthCheckResult` + +GetHealthCheckResult returns the HealthCheckResult field if non-nil, zero value otherwise. + +### GetHealthCheckResultOk + +`func (o *VAClusterStatusChangeEvent) GetHealthCheckResultOk() (*VAClusterStatusChangeEventHealthCheckResult, bool)` + +GetHealthCheckResultOk returns a tuple with the HealthCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthCheckResult + +`func (o *VAClusterStatusChangeEvent) SetHealthCheckResult(v VAClusterStatusChangeEventHealthCheckResult)` + +SetHealthCheckResult sets HealthCheckResult field to given value. + + +### GetPreviousHealthCheckResult + +`func (o *VAClusterStatusChangeEvent) GetPreviousHealthCheckResult() VAClusterStatusChangeEventPreviousHealthCheckResult` + +GetPreviousHealthCheckResult returns the PreviousHealthCheckResult field if non-nil, zero value otherwise. + +### GetPreviousHealthCheckResultOk + +`func (o *VAClusterStatusChangeEvent) GetPreviousHealthCheckResultOk() (*VAClusterStatusChangeEventPreviousHealthCheckResult, bool)` + +GetPreviousHealthCheckResultOk returns a tuple with the PreviousHealthCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousHealthCheckResult + +`func (o *VAClusterStatusChangeEvent) SetPreviousHealthCheckResult(v VAClusterStatusChangeEventPreviousHealthCheckResult)` + +SetPreviousHealthCheckResult sets PreviousHealthCheckResult field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/VAClusterStatusChangeEventApplication.md b/docs/tools/sdk/go/Reference/Beta/Models/VAClusterStatusChangeEventApplication.md new file mode 100644 index 000000000..f6302c650 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/VAClusterStatusChangeEventApplication.md @@ -0,0 +1,111 @@ +--- +id: beta-va-cluster-status-change-event-application +title: VAClusterStatusChangeEventApplication +pagination_label: VAClusterStatusChangeEventApplication +sidebar_label: VAClusterStatusChangeEventApplication +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VAClusterStatusChangeEventApplication', 'BetaVAClusterStatusChangeEventApplication'] +slug: /tools/sdk/go/beta/models/va-cluster-status-change-event-application +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventApplication', 'BetaVAClusterStatusChangeEventApplication'] +--- + +# VAClusterStatusChangeEventApplication + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Application's globally unique identifier (GUID). | +**Name** | **string** | Application name. | +**Attributes** | **map[string]interface{}** | Custom map of attributes for a source. Attributes only populate if the type is `SOURCE` and the source has a proxy. | + +## Methods + +### NewVAClusterStatusChangeEventApplication + +`func NewVAClusterStatusChangeEventApplication(id string, name string, attributes map[string]interface{}, ) *VAClusterStatusChangeEventApplication` + +NewVAClusterStatusChangeEventApplication instantiates a new VAClusterStatusChangeEventApplication 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 + +### NewVAClusterStatusChangeEventApplicationWithDefaults + +`func NewVAClusterStatusChangeEventApplicationWithDefaults() *VAClusterStatusChangeEventApplication` + +NewVAClusterStatusChangeEventApplicationWithDefaults instantiates a new VAClusterStatusChangeEventApplication 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 + +### GetId + +`func (o *VAClusterStatusChangeEventApplication) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *VAClusterStatusChangeEventApplication) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *VAClusterStatusChangeEventApplication) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *VAClusterStatusChangeEventApplication) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *VAClusterStatusChangeEventApplication) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *VAClusterStatusChangeEventApplication) SetName(v string)` + +SetName sets Name field to given value. + + +### GetAttributes + +`func (o *VAClusterStatusChangeEventApplication) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *VAClusterStatusChangeEventApplication) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *VAClusterStatusChangeEventApplication) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *VAClusterStatusChangeEventApplication) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *VAClusterStatusChangeEventApplication) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/VAClusterStatusChangeEventHealthCheckResult.md b/docs/tools/sdk/go/Reference/Beta/Models/VAClusterStatusChangeEventHealthCheckResult.md new file mode 100644 index 000000000..16faa68a0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/VAClusterStatusChangeEventHealthCheckResult.md @@ -0,0 +1,101 @@ +--- +id: beta-va-cluster-status-change-event-health-check-result +title: VAClusterStatusChangeEventHealthCheckResult +pagination_label: VAClusterStatusChangeEventHealthCheckResult +sidebar_label: VAClusterStatusChangeEventHealthCheckResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VAClusterStatusChangeEventHealthCheckResult', 'BetaVAClusterStatusChangeEventHealthCheckResult'] +slug: /tools/sdk/go/beta/models/va-cluster-status-change-event-health-check-result +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventHealthCheckResult', 'BetaVAClusterStatusChangeEventHealthCheckResult'] +--- + +# VAClusterStatusChangeEventHealthCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | **string** | Detailed message of the health check result.. | +**ResultType** | **string** | Health check result type. | +**Status** | **string** | Health check status. | + +## Methods + +### NewVAClusterStatusChangeEventHealthCheckResult + +`func NewVAClusterStatusChangeEventHealthCheckResult(message string, resultType string, status string, ) *VAClusterStatusChangeEventHealthCheckResult` + +NewVAClusterStatusChangeEventHealthCheckResult instantiates a new VAClusterStatusChangeEventHealthCheckResult 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 + +### NewVAClusterStatusChangeEventHealthCheckResultWithDefaults + +`func NewVAClusterStatusChangeEventHealthCheckResultWithDefaults() *VAClusterStatusChangeEventHealthCheckResult` + +NewVAClusterStatusChangeEventHealthCheckResultWithDefaults instantiates a new VAClusterStatusChangeEventHealthCheckResult 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 + +### GetMessage + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *VAClusterStatusChangeEventHealthCheckResult) SetMessage(v string)` + +SetMessage sets Message field to given value. + + +### GetResultType + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetResultType() string` + +GetResultType returns the ResultType field if non-nil, zero value otherwise. + +### GetResultTypeOk + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetResultTypeOk() (*string, bool)` + +GetResultTypeOk returns a tuple with the ResultType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultType + +`func (o *VAClusterStatusChangeEventHealthCheckResult) SetResultType(v string)` + +SetResultType sets ResultType field to given value. + + +### GetStatus + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *VAClusterStatusChangeEventHealthCheckResult) SetStatus(v string)` + +SetStatus sets Status field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md b/docs/tools/sdk/go/Reference/Beta/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md new file mode 100644 index 000000000..90cf48154 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md @@ -0,0 +1,101 @@ +--- +id: beta-va-cluster-status-change-event-previous-health-check-result +title: VAClusterStatusChangeEventPreviousHealthCheckResult +pagination_label: VAClusterStatusChangeEventPreviousHealthCheckResult +sidebar_label: VAClusterStatusChangeEventPreviousHealthCheckResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VAClusterStatusChangeEventPreviousHealthCheckResult', 'BetaVAClusterStatusChangeEventPreviousHealthCheckResult'] +slug: /tools/sdk/go/beta/models/va-cluster-status-change-event-previous-health-check-result +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventPreviousHealthCheckResult', 'BetaVAClusterStatusChangeEventPreviousHealthCheckResult'] +--- + +# VAClusterStatusChangeEventPreviousHealthCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | **string** | Detailed message of the health check result. | +**ResultType** | **string** | Health check result type. | +**Status** | **string** | Health check status. | + +## Methods + +### NewVAClusterStatusChangeEventPreviousHealthCheckResult + +`func NewVAClusterStatusChangeEventPreviousHealthCheckResult(message string, resultType string, status string, ) *VAClusterStatusChangeEventPreviousHealthCheckResult` + +NewVAClusterStatusChangeEventPreviousHealthCheckResult instantiates a new VAClusterStatusChangeEventPreviousHealthCheckResult 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 + +### NewVAClusterStatusChangeEventPreviousHealthCheckResultWithDefaults + +`func NewVAClusterStatusChangeEventPreviousHealthCheckResultWithDefaults() *VAClusterStatusChangeEventPreviousHealthCheckResult` + +NewVAClusterStatusChangeEventPreviousHealthCheckResultWithDefaults instantiates a new VAClusterStatusChangeEventPreviousHealthCheckResult 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 + +### GetMessage + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) SetMessage(v string)` + +SetMessage sets Message field to given value. + + +### GetResultType + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetResultType() string` + +GetResultType returns the ResultType field if non-nil, zero value otherwise. + +### GetResultTypeOk + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetResultTypeOk() (*string, bool)` + +GetResultTypeOk returns a tuple with the ResultType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultType + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) SetResultType(v string)` + +SetResultType sets ResultType field to given value. + + +### GetStatus + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) SetStatus(v string)` + +SetStatus sets Status field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ValidateFilterInputDto.md b/docs/tools/sdk/go/Reference/Beta/Models/ValidateFilterInputDto.md new file mode 100644 index 000000000..859b9c866 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ValidateFilterInputDto.md @@ -0,0 +1,80 @@ +--- +id: beta-validate-filter-input-dto +title: ValidateFilterInputDto +pagination_label: ValidateFilterInputDto +sidebar_label: ValidateFilterInputDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ValidateFilterInputDto', 'BetaValidateFilterInputDto'] +slug: /tools/sdk/go/beta/models/validate-filter-input-dto +tags: ['SDK', 'Software Development Kit', 'ValidateFilterInputDto', 'BetaValidateFilterInputDto'] +--- + +# ValidateFilterInputDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | **map[string]interface{}** | Mock input to evaluate filter expression against. | +**Filter** | **string** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | + +## Methods + +### NewValidateFilterInputDto + +`func NewValidateFilterInputDto(input map[string]interface{}, filter string, ) *ValidateFilterInputDto` + +NewValidateFilterInputDto instantiates a new ValidateFilterInputDto 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 + +### NewValidateFilterInputDtoWithDefaults + +`func NewValidateFilterInputDtoWithDefaults() *ValidateFilterInputDto` + +NewValidateFilterInputDtoWithDefaults instantiates a new ValidateFilterInputDto 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 + +### GetInput + +`func (o *ValidateFilterInputDto) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *ValidateFilterInputDto) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *ValidateFilterInputDto) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + + +### GetFilter + +`func (o *ValidateFilterInputDto) GetFilter() string` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *ValidateFilterInputDto) GetFilterOk() (*string, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *ValidateFilterInputDto) SetFilter(v string)` + +SetFilter sets Filter field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ValidateFilterOutputDto.md b/docs/tools/sdk/go/Reference/Beta/Models/ValidateFilterOutputDto.md new file mode 100644 index 000000000..e6729d20f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ValidateFilterOutputDto.md @@ -0,0 +1,116 @@ +--- +id: beta-validate-filter-output-dto +title: ValidateFilterOutputDto +pagination_label: ValidateFilterOutputDto +sidebar_label: ValidateFilterOutputDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ValidateFilterOutputDto', 'BetaValidateFilterOutputDto'] +slug: /tools/sdk/go/beta/models/validate-filter-output-dto +tags: ['SDK', 'Software Development Kit', 'ValidateFilterOutputDto', 'BetaValidateFilterOutputDto'] +--- + +# ValidateFilterOutputDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsValid** | Pointer to **bool** | When this field is true, the filter expression is valid against the input. | [optional] [default to false] +**IsValidJSONPath** | Pointer to **bool** | When this field is true, the filter expression is using a valid JSON path. | [optional] [default to false] +**IsPathExist** | Pointer to **bool** | When this field is true, the filter expression is using an existing path. | [optional] [default to false] + +## Methods + +### NewValidateFilterOutputDto + +`func NewValidateFilterOutputDto() *ValidateFilterOutputDto` + +NewValidateFilterOutputDto instantiates a new ValidateFilterOutputDto 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 + +### NewValidateFilterOutputDtoWithDefaults + +`func NewValidateFilterOutputDtoWithDefaults() *ValidateFilterOutputDto` + +NewValidateFilterOutputDtoWithDefaults instantiates a new ValidateFilterOutputDto 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 + +### GetIsValid + +`func (o *ValidateFilterOutputDto) GetIsValid() bool` + +GetIsValid returns the IsValid field if non-nil, zero value otherwise. + +### GetIsValidOk + +`func (o *ValidateFilterOutputDto) GetIsValidOk() (*bool, bool)` + +GetIsValidOk returns a tuple with the IsValid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsValid + +`func (o *ValidateFilterOutputDto) SetIsValid(v bool)` + +SetIsValid sets IsValid field to given value. + +### HasIsValid + +`func (o *ValidateFilterOutputDto) HasIsValid() bool` + +HasIsValid returns a boolean if a field has been set. + +### GetIsValidJSONPath + +`func (o *ValidateFilterOutputDto) GetIsValidJSONPath() bool` + +GetIsValidJSONPath returns the IsValidJSONPath field if non-nil, zero value otherwise. + +### GetIsValidJSONPathOk + +`func (o *ValidateFilterOutputDto) GetIsValidJSONPathOk() (*bool, bool)` + +GetIsValidJSONPathOk returns a tuple with the IsValidJSONPath field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsValidJSONPath + +`func (o *ValidateFilterOutputDto) SetIsValidJSONPath(v bool)` + +SetIsValidJSONPath sets IsValidJSONPath field to given value. + +### HasIsValidJSONPath + +`func (o *ValidateFilterOutputDto) HasIsValidJSONPath() bool` + +HasIsValidJSONPath returns a boolean if a field has been set. + +### GetIsPathExist + +`func (o *ValidateFilterOutputDto) GetIsPathExist() bool` + +GetIsPathExist returns the IsPathExist field if non-nil, zero value otherwise. + +### GetIsPathExistOk + +`func (o *ValidateFilterOutputDto) GetIsPathExistOk() (*bool, bool)` + +GetIsPathExistOk returns a tuple with the IsPathExist field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsPathExist + +`func (o *ValidateFilterOutputDto) SetIsPathExist(v bool)` + +SetIsPathExist sets IsPathExist field to given value. + +### HasIsPathExist + +`func (o *ValidateFilterOutputDto) HasIsPathExist() bool` + +HasIsPathExist returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Value.md b/docs/tools/sdk/go/Reference/Beta/Models/Value.md new file mode 100644 index 000000000..8a4ef1dbd --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Value.md @@ -0,0 +1,100 @@ +--- +id: beta-value +title: Value +pagination_label: Value +sidebar_label: Value +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Value', 'BetaValue'] +slug: /tools/sdk/go/beta/models/value +tags: ['SDK', 'Software Development Kit', 'Value', 'BetaValue'] +--- + +# Value + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **NullableString** | The type of attribute value | [optional] +**Value** | Pointer to **string** | The attribute value | [optional] + +## Methods + +### NewValue + +`func NewValue() *Value` + +NewValue instantiates a new Value 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 + +### NewValueWithDefaults + +`func NewValueWithDefaults() *Value` + +NewValueWithDefaults instantiates a new Value 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 + +### GetType + +`func (o *Value) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Value) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Value) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Value) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *Value) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *Value) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetValue + +`func (o *Value) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Value) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Value) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Value) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/VendorConnectorMapping.md b/docs/tools/sdk/go/Reference/Beta/Models/VendorConnectorMapping.md new file mode 100644 index 000000000..d803bfba2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/VendorConnectorMapping.md @@ -0,0 +1,312 @@ +--- +id: beta-vendor-connector-mapping +title: VendorConnectorMapping +pagination_label: VendorConnectorMapping +sidebar_label: VendorConnectorMapping +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMapping', 'BetaVendorConnectorMapping'] +slug: /tools/sdk/go/beta/models/vendor-connector-mapping +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMapping', 'BetaVendorConnectorMapping'] +--- + +# VendorConnectorMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique identifier for the vendor-connector mapping. | [optional] +**Vendor** | Pointer to **string** | The name of the vendor. | [optional] +**Connector** | Pointer to **string** | The name of the connector. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The creation timestamp of the mapping. | [optional] +**CreatedBy** | Pointer to **string** | The identifier of the user who created the mapping. | [optional] +**UpdatedAt** | Pointer to [**NullableVendorConnectorMappingUpdatedAt**](vendor-connector-mapping-updated-at) | | [optional] +**UpdatedBy** | Pointer to [**NullableVendorConnectorMappingUpdatedBy**](vendor-connector-mapping-updated-by) | | [optional] +**DeletedAt** | Pointer to [**NullableVendorConnectorMappingDeletedAt**](vendor-connector-mapping-deleted-at) | | [optional] +**DeletedBy** | Pointer to [**NullableVendorConnectorMappingDeletedBy**](vendor-connector-mapping-deleted-by) | | [optional] + +## Methods + +### NewVendorConnectorMapping + +`func NewVendorConnectorMapping() *VendorConnectorMapping` + +NewVendorConnectorMapping instantiates a new VendorConnectorMapping 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 + +### NewVendorConnectorMappingWithDefaults + +`func NewVendorConnectorMappingWithDefaults() *VendorConnectorMapping` + +NewVendorConnectorMappingWithDefaults instantiates a new VendorConnectorMapping 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 + +### GetId + +`func (o *VendorConnectorMapping) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *VendorConnectorMapping) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *VendorConnectorMapping) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *VendorConnectorMapping) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetVendor + +`func (o *VendorConnectorMapping) GetVendor() string` + +GetVendor returns the Vendor field if non-nil, zero value otherwise. + +### GetVendorOk + +`func (o *VendorConnectorMapping) GetVendorOk() (*string, bool)` + +GetVendorOk returns a tuple with the Vendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVendor + +`func (o *VendorConnectorMapping) SetVendor(v string)` + +SetVendor sets Vendor field to given value. + +### HasVendor + +`func (o *VendorConnectorMapping) HasVendor() bool` + +HasVendor returns a boolean if a field has been set. + +### GetConnector + +`func (o *VendorConnectorMapping) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *VendorConnectorMapping) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *VendorConnectorMapping) SetConnector(v string)` + +SetConnector sets Connector field to given value. + +### HasConnector + +`func (o *VendorConnectorMapping) HasConnector() bool` + +HasConnector returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *VendorConnectorMapping) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *VendorConnectorMapping) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *VendorConnectorMapping) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *VendorConnectorMapping) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetCreatedBy + +`func (o *VendorConnectorMapping) GetCreatedBy() string` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *VendorConnectorMapping) GetCreatedByOk() (*string, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *VendorConnectorMapping) SetCreatedBy(v string)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *VendorConnectorMapping) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetUpdatedAt + +`func (o *VendorConnectorMapping) GetUpdatedAt() VendorConnectorMappingUpdatedAt` + +GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise. + +### GetUpdatedAtOk + +`func (o *VendorConnectorMapping) GetUpdatedAtOk() (*VendorConnectorMappingUpdatedAt, bool)` + +GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedAt + +`func (o *VendorConnectorMapping) SetUpdatedAt(v VendorConnectorMappingUpdatedAt)` + +SetUpdatedAt sets UpdatedAt field to given value. + +### HasUpdatedAt + +`func (o *VendorConnectorMapping) HasUpdatedAt() bool` + +HasUpdatedAt returns a boolean if a field has been set. + +### SetUpdatedAtNil + +`func (o *VendorConnectorMapping) SetUpdatedAtNil(b bool)` + + SetUpdatedAtNil sets the value for UpdatedAt to be an explicit nil + +### UnsetUpdatedAt +`func (o *VendorConnectorMapping) UnsetUpdatedAt()` + +UnsetUpdatedAt ensures that no value is present for UpdatedAt, not even an explicit nil +### GetUpdatedBy + +`func (o *VendorConnectorMapping) GetUpdatedBy() VendorConnectorMappingUpdatedBy` + +GetUpdatedBy returns the UpdatedBy field if non-nil, zero value otherwise. + +### GetUpdatedByOk + +`func (o *VendorConnectorMapping) GetUpdatedByOk() (*VendorConnectorMappingUpdatedBy, bool)` + +GetUpdatedByOk returns a tuple with the UpdatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedBy + +`func (o *VendorConnectorMapping) SetUpdatedBy(v VendorConnectorMappingUpdatedBy)` + +SetUpdatedBy sets UpdatedBy field to given value. + +### HasUpdatedBy + +`func (o *VendorConnectorMapping) HasUpdatedBy() bool` + +HasUpdatedBy returns a boolean if a field has been set. + +### SetUpdatedByNil + +`func (o *VendorConnectorMapping) SetUpdatedByNil(b bool)` + + SetUpdatedByNil sets the value for UpdatedBy to be an explicit nil + +### UnsetUpdatedBy +`func (o *VendorConnectorMapping) UnsetUpdatedBy()` + +UnsetUpdatedBy ensures that no value is present for UpdatedBy, not even an explicit nil +### GetDeletedAt + +`func (o *VendorConnectorMapping) GetDeletedAt() VendorConnectorMappingDeletedAt` + +GetDeletedAt returns the DeletedAt field if non-nil, zero value otherwise. + +### GetDeletedAtOk + +`func (o *VendorConnectorMapping) GetDeletedAtOk() (*VendorConnectorMappingDeletedAt, bool)` + +GetDeletedAtOk returns a tuple with the DeletedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeletedAt + +`func (o *VendorConnectorMapping) SetDeletedAt(v VendorConnectorMappingDeletedAt)` + +SetDeletedAt sets DeletedAt field to given value. + +### HasDeletedAt + +`func (o *VendorConnectorMapping) HasDeletedAt() bool` + +HasDeletedAt returns a boolean if a field has been set. + +### SetDeletedAtNil + +`func (o *VendorConnectorMapping) SetDeletedAtNil(b bool)` + + SetDeletedAtNil sets the value for DeletedAt to be an explicit nil + +### UnsetDeletedAt +`func (o *VendorConnectorMapping) UnsetDeletedAt()` + +UnsetDeletedAt ensures that no value is present for DeletedAt, not even an explicit nil +### GetDeletedBy + +`func (o *VendorConnectorMapping) GetDeletedBy() VendorConnectorMappingDeletedBy` + +GetDeletedBy returns the DeletedBy field if non-nil, zero value otherwise. + +### GetDeletedByOk + +`func (o *VendorConnectorMapping) GetDeletedByOk() (*VendorConnectorMappingDeletedBy, bool)` + +GetDeletedByOk returns a tuple with the DeletedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeletedBy + +`func (o *VendorConnectorMapping) SetDeletedBy(v VendorConnectorMappingDeletedBy)` + +SetDeletedBy sets DeletedBy field to given value. + +### HasDeletedBy + +`func (o *VendorConnectorMapping) HasDeletedBy() bool` + +HasDeletedBy returns a boolean if a field has been set. + +### SetDeletedByNil + +`func (o *VendorConnectorMapping) SetDeletedByNil(b bool)` + + SetDeletedByNil sets the value for DeletedBy to be an explicit nil + +### UnsetDeletedBy +`func (o *VendorConnectorMapping) UnsetDeletedBy()` + +UnsetDeletedBy ensures that no value is present for DeletedBy, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/VendorConnectorMappingDeletedAt.md b/docs/tools/sdk/go/Reference/Beta/Models/VendorConnectorMappingDeletedAt.md new file mode 100644 index 000000000..df1b7236f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/VendorConnectorMappingDeletedAt.md @@ -0,0 +1,90 @@ +--- +id: beta-vendor-connector-mapping-deleted-at +title: VendorConnectorMappingDeletedAt +pagination_label: VendorConnectorMappingDeletedAt +sidebar_label: VendorConnectorMappingDeletedAt +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappingDeletedAt', 'BetaVendorConnectorMappingDeletedAt'] +slug: /tools/sdk/go/beta/models/vendor-connector-mapping-deleted-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedAt', 'BetaVendorConnectorMappingDeletedAt'] +--- + +# VendorConnectorMappingDeletedAt + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Time** | Pointer to **SailPointTime** | The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable. | [optional] +**Valid** | Pointer to **bool** | A flag indicating if the 'Time' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to false] + +## Methods + +### NewVendorConnectorMappingDeletedAt + +`func NewVendorConnectorMappingDeletedAt() *VendorConnectorMappingDeletedAt` + +NewVendorConnectorMappingDeletedAt instantiates a new VendorConnectorMappingDeletedAt 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 + +### NewVendorConnectorMappingDeletedAtWithDefaults + +`func NewVendorConnectorMappingDeletedAtWithDefaults() *VendorConnectorMappingDeletedAt` + +NewVendorConnectorMappingDeletedAtWithDefaults instantiates a new VendorConnectorMappingDeletedAt 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 + +### GetTime + +`func (o *VendorConnectorMappingDeletedAt) GetTime() SailPointTime` + +GetTime returns the Time field if non-nil, zero value otherwise. + +### GetTimeOk + +`func (o *VendorConnectorMappingDeletedAt) GetTimeOk() (*SailPointTime, bool)` + +GetTimeOk returns a tuple with the Time field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTime + +`func (o *VendorConnectorMappingDeletedAt) SetTime(v SailPointTime)` + +SetTime sets Time field to given value. + +### HasTime + +`func (o *VendorConnectorMappingDeletedAt) HasTime() bool` + +HasTime returns a boolean if a field has been set. + +### GetValid + +`func (o *VendorConnectorMappingDeletedAt) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *VendorConnectorMappingDeletedAt) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *VendorConnectorMappingDeletedAt) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *VendorConnectorMappingDeletedAt) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/VendorConnectorMappingDeletedBy.md b/docs/tools/sdk/go/Reference/Beta/Models/VendorConnectorMappingDeletedBy.md new file mode 100644 index 000000000..1e321cbb0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/VendorConnectorMappingDeletedBy.md @@ -0,0 +1,90 @@ +--- +id: beta-vendor-connector-mapping-deleted-by +title: VendorConnectorMappingDeletedBy +pagination_label: VendorConnectorMappingDeletedBy +sidebar_label: VendorConnectorMappingDeletedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappingDeletedBy', 'BetaVendorConnectorMappingDeletedBy'] +slug: /tools/sdk/go/beta/models/vendor-connector-mapping-deleted-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedBy', 'BetaVendorConnectorMappingDeletedBy'] +--- + +# VendorConnectorMappingDeletedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**String** | Pointer to **string** | The identifier of the user who deleted the mapping, if applicable. | [optional] +**Valid** | Pointer to **bool** | A flag indicating if the 'String' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to false] + +## Methods + +### NewVendorConnectorMappingDeletedBy + +`func NewVendorConnectorMappingDeletedBy() *VendorConnectorMappingDeletedBy` + +NewVendorConnectorMappingDeletedBy instantiates a new VendorConnectorMappingDeletedBy 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 + +### NewVendorConnectorMappingDeletedByWithDefaults + +`func NewVendorConnectorMappingDeletedByWithDefaults() *VendorConnectorMappingDeletedBy` + +NewVendorConnectorMappingDeletedByWithDefaults instantiates a new VendorConnectorMappingDeletedBy 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 + +### GetString + +`func (o *VendorConnectorMappingDeletedBy) GetString() string` + +GetString returns the String field if non-nil, zero value otherwise. + +### GetStringOk + +`func (o *VendorConnectorMappingDeletedBy) GetStringOk() (*string, bool)` + +GetStringOk returns a tuple with the String field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetString + +`func (o *VendorConnectorMappingDeletedBy) SetString(v string)` + +SetString sets String field to given value. + +### HasString + +`func (o *VendorConnectorMappingDeletedBy) HasString() bool` + +HasString returns a boolean if a field has been set. + +### GetValid + +`func (o *VendorConnectorMappingDeletedBy) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *VendorConnectorMappingDeletedBy) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *VendorConnectorMappingDeletedBy) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *VendorConnectorMappingDeletedBy) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/VendorConnectorMappingUpdatedAt.md b/docs/tools/sdk/go/Reference/Beta/Models/VendorConnectorMappingUpdatedAt.md new file mode 100644 index 000000000..772482eb4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/VendorConnectorMappingUpdatedAt.md @@ -0,0 +1,90 @@ +--- +id: beta-vendor-connector-mapping-updated-at +title: VendorConnectorMappingUpdatedAt +pagination_label: VendorConnectorMappingUpdatedAt +sidebar_label: VendorConnectorMappingUpdatedAt +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappingUpdatedAt', 'BetaVendorConnectorMappingUpdatedAt'] +slug: /tools/sdk/go/beta/models/vendor-connector-mapping-updated-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedAt', 'BetaVendorConnectorMappingUpdatedAt'] +--- + +# VendorConnectorMappingUpdatedAt + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Time** | Pointer to **SailPointTime** | The timestamp when the mapping was last updated, represented in ISO 8601 format. | [optional] +**Valid** | Pointer to **bool** | A flag indicating if the 'Time' field is set and valid. | [optional] [default to false] + +## Methods + +### NewVendorConnectorMappingUpdatedAt + +`func NewVendorConnectorMappingUpdatedAt() *VendorConnectorMappingUpdatedAt` + +NewVendorConnectorMappingUpdatedAt instantiates a new VendorConnectorMappingUpdatedAt 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 + +### NewVendorConnectorMappingUpdatedAtWithDefaults + +`func NewVendorConnectorMappingUpdatedAtWithDefaults() *VendorConnectorMappingUpdatedAt` + +NewVendorConnectorMappingUpdatedAtWithDefaults instantiates a new VendorConnectorMappingUpdatedAt 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 + +### GetTime + +`func (o *VendorConnectorMappingUpdatedAt) GetTime() SailPointTime` + +GetTime returns the Time field if non-nil, zero value otherwise. + +### GetTimeOk + +`func (o *VendorConnectorMappingUpdatedAt) GetTimeOk() (*SailPointTime, bool)` + +GetTimeOk returns a tuple with the Time field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTime + +`func (o *VendorConnectorMappingUpdatedAt) SetTime(v SailPointTime)` + +SetTime sets Time field to given value. + +### HasTime + +`func (o *VendorConnectorMappingUpdatedAt) HasTime() bool` + +HasTime returns a boolean if a field has been set. + +### GetValid + +`func (o *VendorConnectorMappingUpdatedAt) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *VendorConnectorMappingUpdatedAt) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *VendorConnectorMappingUpdatedAt) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *VendorConnectorMappingUpdatedAt) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/VendorConnectorMappingUpdatedBy.md b/docs/tools/sdk/go/Reference/Beta/Models/VendorConnectorMappingUpdatedBy.md new file mode 100644 index 000000000..25da40163 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/VendorConnectorMappingUpdatedBy.md @@ -0,0 +1,90 @@ +--- +id: beta-vendor-connector-mapping-updated-by +title: VendorConnectorMappingUpdatedBy +pagination_label: VendorConnectorMappingUpdatedBy +sidebar_label: VendorConnectorMappingUpdatedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappingUpdatedBy', 'BetaVendorConnectorMappingUpdatedBy'] +slug: /tools/sdk/go/beta/models/vendor-connector-mapping-updated-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedBy', 'BetaVendorConnectorMappingUpdatedBy'] +--- + +# VendorConnectorMappingUpdatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**String** | Pointer to **string** | The identifier of the user who last updated the mapping, if available. | [optional] +**Valid** | Pointer to **bool** | A flag indicating if the 'String' field is set and valid. | [optional] [default to false] + +## Methods + +### NewVendorConnectorMappingUpdatedBy + +`func NewVendorConnectorMappingUpdatedBy() *VendorConnectorMappingUpdatedBy` + +NewVendorConnectorMappingUpdatedBy instantiates a new VendorConnectorMappingUpdatedBy 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 + +### NewVendorConnectorMappingUpdatedByWithDefaults + +`func NewVendorConnectorMappingUpdatedByWithDefaults() *VendorConnectorMappingUpdatedBy` + +NewVendorConnectorMappingUpdatedByWithDefaults instantiates a new VendorConnectorMappingUpdatedBy 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 + +### GetString + +`func (o *VendorConnectorMappingUpdatedBy) GetString() string` + +GetString returns the String field if non-nil, zero value otherwise. + +### GetStringOk + +`func (o *VendorConnectorMappingUpdatedBy) GetStringOk() (*string, bool)` + +GetStringOk returns a tuple with the String field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetString + +`func (o *VendorConnectorMappingUpdatedBy) SetString(v string)` + +SetString sets String field to given value. + +### HasString + +`func (o *VendorConnectorMappingUpdatedBy) HasString() bool` + +HasString returns a boolean if a field has been set. + +### GetValid + +`func (o *VendorConnectorMappingUpdatedBy) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *VendorConnectorMappingUpdatedBy) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *VendorConnectorMappingUpdatedBy) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *VendorConnectorMappingUpdatedBy) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/VerificationPollRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/VerificationPollRequest.md new file mode 100644 index 000000000..528584808 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/VerificationPollRequest.md @@ -0,0 +1,59 @@ +--- +id: beta-verification-poll-request +title: VerificationPollRequest +pagination_label: VerificationPollRequest +sidebar_label: VerificationPollRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VerificationPollRequest', 'BetaVerificationPollRequest'] +slug: /tools/sdk/go/beta/models/verification-poll-request +tags: ['SDK', 'Software Development Kit', 'VerificationPollRequest', 'BetaVerificationPollRequest'] +--- + +# VerificationPollRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | **string** | Verification request Id | + +## Methods + +### NewVerificationPollRequest + +`func NewVerificationPollRequest(requestId string, ) *VerificationPollRequest` + +NewVerificationPollRequest instantiates a new VerificationPollRequest 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 + +### NewVerificationPollRequestWithDefaults + +`func NewVerificationPollRequestWithDefaults() *VerificationPollRequest` + +NewVerificationPollRequestWithDefaults instantiates a new VerificationPollRequest 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 + +### GetRequestId + +`func (o *VerificationPollRequest) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *VerificationPollRequest) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *VerificationPollRequest) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/VerificationResponse.md b/docs/tools/sdk/go/Reference/Beta/Models/VerificationResponse.md new file mode 100644 index 000000000..b1d26096d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/VerificationResponse.md @@ -0,0 +1,136 @@ +--- +id: beta-verification-response +title: VerificationResponse +pagination_label: VerificationResponse +sidebar_label: VerificationResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VerificationResponse', 'BetaVerificationResponse'] +slug: /tools/sdk/go/beta/models/verification-response +tags: ['SDK', 'Software Development Kit', 'VerificationResponse', 'BetaVerificationResponse'] +--- + +# VerificationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **NullableString** | The verificationPollRequest request ID | [optional] +**Status** | Pointer to **string** | MFA Authentication status | [optional] +**Error** | Pointer to **NullableString** | Error messages from MFA verification request | [optional] + +## Methods + +### NewVerificationResponse + +`func NewVerificationResponse() *VerificationResponse` + +NewVerificationResponse instantiates a new VerificationResponse 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 + +### NewVerificationResponseWithDefaults + +`func NewVerificationResponseWithDefaults() *VerificationResponse` + +NewVerificationResponseWithDefaults instantiates a new VerificationResponse 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 + +### GetRequestId + +`func (o *VerificationResponse) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *VerificationResponse) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *VerificationResponse) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *VerificationResponse) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *VerificationResponse) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *VerificationResponse) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetStatus + +`func (o *VerificationResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *VerificationResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *VerificationResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *VerificationResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetError + +`func (o *VerificationResponse) GetError() string` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *VerificationResponse) GetErrorOk() (*string, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *VerificationResponse) SetError(v string)` + +SetError sets Error field to given value. + +### HasError + +`func (o *VerificationResponse) HasError() bool` + +HasError returns a boolean if a field has been set. + +### SetErrorNil + +`func (o *VerificationResponse) SetErrorNil(b bool)` + + SetErrorNil sets the value for Error to be an explicit nil + +### UnsetError +`func (o *VerificationResponse) UnsetError()` + +UnsetError ensures that no value is present for Error, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ViolationContext.md b/docs/tools/sdk/go/Reference/Beta/Models/ViolationContext.md new file mode 100644 index 000000000..bfff5a3bf --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ViolationContext.md @@ -0,0 +1,90 @@ +--- +id: beta-violation-context +title: ViolationContext +pagination_label: ViolationContext +sidebar_label: ViolationContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationContext', 'BetaViolationContext'] +slug: /tools/sdk/go/beta/models/violation-context +tags: ['SDK', 'Software Development Kit', 'ViolationContext', 'BetaViolationContext'] +--- + +# ViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**ViolationContextPolicy**](violation-context-policy) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**ExceptionAccessCriteria**](exception-access-criteria) | | [optional] + +## Methods + +### NewViolationContext + +`func NewViolationContext() *ViolationContext` + +NewViolationContext instantiates a new ViolationContext 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 + +### NewViolationContextWithDefaults + +`func NewViolationContextWithDefaults() *ViolationContext` + +NewViolationContextWithDefaults instantiates a new ViolationContext 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 + +### GetPolicy + +`func (o *ViolationContext) GetPolicy() ViolationContextPolicy` + +GetPolicy returns the Policy field if non-nil, zero value otherwise. + +### GetPolicyOk + +`func (o *ViolationContext) GetPolicyOk() (*ViolationContextPolicy, bool)` + +GetPolicyOk returns a tuple with the Policy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicy + +`func (o *ViolationContext) SetPolicy(v ViolationContextPolicy)` + +SetPolicy sets Policy field to given value. + +### HasPolicy + +`func (o *ViolationContext) HasPolicy() bool` + +HasPolicy returns a boolean if a field has been set. + +### GetConflictingAccessCriteria + +`func (o *ViolationContext) GetConflictingAccessCriteria() ExceptionAccessCriteria` + +GetConflictingAccessCriteria returns the ConflictingAccessCriteria field if non-nil, zero value otherwise. + +### GetConflictingAccessCriteriaOk + +`func (o *ViolationContext) GetConflictingAccessCriteriaOk() (*ExceptionAccessCriteria, bool)` + +GetConflictingAccessCriteriaOk returns a tuple with the ConflictingAccessCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConflictingAccessCriteria + +`func (o *ViolationContext) SetConflictingAccessCriteria(v ExceptionAccessCriteria)` + +SetConflictingAccessCriteria sets ConflictingAccessCriteria field to given value. + +### HasConflictingAccessCriteria + +`func (o *ViolationContext) HasConflictingAccessCriteria() bool` + +HasConflictingAccessCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ViolationContextPolicy.md b/docs/tools/sdk/go/Reference/Beta/Models/ViolationContextPolicy.md new file mode 100644 index 000000000..47f36bca2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ViolationContextPolicy.md @@ -0,0 +1,116 @@ +--- +id: beta-violation-context-policy +title: ViolationContextPolicy +pagination_label: ViolationContextPolicy +sidebar_label: ViolationContextPolicy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationContextPolicy', 'BetaViolationContextPolicy'] +slug: /tools/sdk/go/beta/models/violation-context-policy +tags: ['SDK', 'Software Development Kit', 'ViolationContextPolicy', 'BetaViolationContextPolicy'] +--- + +# ViolationContextPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **map[string]interface{}** | The type of object supported for SOD policy violations. | [optional] +**Id** | Pointer to **string** | SOD policy ID. | [optional] +**Name** | Pointer to **string** | | [optional] + +## Methods + +### NewViolationContextPolicy + +`func NewViolationContextPolicy() *ViolationContextPolicy` + +NewViolationContextPolicy instantiates a new ViolationContextPolicy 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 + +### NewViolationContextPolicyWithDefaults + +`func NewViolationContextPolicyWithDefaults() *ViolationContextPolicy` + +NewViolationContextPolicyWithDefaults instantiates a new ViolationContextPolicy 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 + +### GetType + +`func (o *ViolationContextPolicy) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ViolationContextPolicy) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ViolationContextPolicy) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + +### HasType + +`func (o *ViolationContextPolicy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ViolationContextPolicy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ViolationContextPolicy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ViolationContextPolicy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ViolationContextPolicy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ViolationContextPolicy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ViolationContextPolicy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ViolationContextPolicy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ViolationContextPolicy) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ViolationOwnerAssignmentConfig.md b/docs/tools/sdk/go/Reference/Beta/Models/ViolationOwnerAssignmentConfig.md new file mode 100644 index 000000000..8b2255707 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ViolationOwnerAssignmentConfig.md @@ -0,0 +1,110 @@ +--- +id: beta-violation-owner-assignment-config +title: ViolationOwnerAssignmentConfig +pagination_label: ViolationOwnerAssignmentConfig +sidebar_label: ViolationOwnerAssignmentConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationOwnerAssignmentConfig', 'BetaViolationOwnerAssignmentConfig'] +slug: /tools/sdk/go/beta/models/violation-owner-assignment-config +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfig', 'BetaViolationOwnerAssignmentConfig'] +--- + +# ViolationOwnerAssignmentConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssignmentRule** | Pointer to **NullableString** | Details about the violations owner. MANAGER - identity's manager STATIC - Governance Group or Identity | [optional] +**OwnerRef** | Pointer to [**NullableViolationOwnerAssignmentConfigOwnerRef**](violation-owner-assignment-config-owner-ref) | | [optional] + +## Methods + +### NewViolationOwnerAssignmentConfig + +`func NewViolationOwnerAssignmentConfig() *ViolationOwnerAssignmentConfig` + +NewViolationOwnerAssignmentConfig instantiates a new ViolationOwnerAssignmentConfig 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 + +### NewViolationOwnerAssignmentConfigWithDefaults + +`func NewViolationOwnerAssignmentConfigWithDefaults() *ViolationOwnerAssignmentConfig` + +NewViolationOwnerAssignmentConfigWithDefaults instantiates a new ViolationOwnerAssignmentConfig 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 + +### GetAssignmentRule + +`func (o *ViolationOwnerAssignmentConfig) GetAssignmentRule() string` + +GetAssignmentRule returns the AssignmentRule field if non-nil, zero value otherwise. + +### GetAssignmentRuleOk + +`func (o *ViolationOwnerAssignmentConfig) GetAssignmentRuleOk() (*string, bool)` + +GetAssignmentRuleOk returns a tuple with the AssignmentRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentRule + +`func (o *ViolationOwnerAssignmentConfig) SetAssignmentRule(v string)` + +SetAssignmentRule sets AssignmentRule field to given value. + +### HasAssignmentRule + +`func (o *ViolationOwnerAssignmentConfig) HasAssignmentRule() bool` + +HasAssignmentRule returns a boolean if a field has been set. + +### SetAssignmentRuleNil + +`func (o *ViolationOwnerAssignmentConfig) SetAssignmentRuleNil(b bool)` + + SetAssignmentRuleNil sets the value for AssignmentRule to be an explicit nil + +### UnsetAssignmentRule +`func (o *ViolationOwnerAssignmentConfig) UnsetAssignmentRule()` + +UnsetAssignmentRule ensures that no value is present for AssignmentRule, not even an explicit nil +### GetOwnerRef + +`func (o *ViolationOwnerAssignmentConfig) GetOwnerRef() ViolationOwnerAssignmentConfigOwnerRef` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *ViolationOwnerAssignmentConfig) GetOwnerRefOk() (*ViolationOwnerAssignmentConfigOwnerRef, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *ViolationOwnerAssignmentConfig) SetOwnerRef(v ViolationOwnerAssignmentConfigOwnerRef)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *ViolationOwnerAssignmentConfig) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### SetOwnerRefNil + +`func (o *ViolationOwnerAssignmentConfig) SetOwnerRefNil(b bool)` + + SetOwnerRefNil sets the value for OwnerRef to be an explicit nil + +### UnsetOwnerRef +`func (o *ViolationOwnerAssignmentConfig) UnsetOwnerRef()` + +UnsetOwnerRef ensures that no value is present for OwnerRef, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ViolationOwnerAssignmentConfigOwnerRef.md b/docs/tools/sdk/go/Reference/Beta/Models/ViolationOwnerAssignmentConfigOwnerRef.md new file mode 100644 index 000000000..7dca0b22d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ViolationOwnerAssignmentConfigOwnerRef.md @@ -0,0 +1,126 @@ +--- +id: beta-violation-owner-assignment-config-owner-ref +title: ViolationOwnerAssignmentConfigOwnerRef +pagination_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationOwnerAssignmentConfigOwnerRef', 'BetaViolationOwnerAssignmentConfigOwnerRef'] +slug: /tools/sdk/go/beta/models/violation-owner-assignment-config-owner-ref +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfigOwnerRef', 'BetaViolationOwnerAssignmentConfigOwnerRef'] +--- + +# ViolationOwnerAssignmentConfigOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **NullableString** | Owner type. | [optional] +**Id** | Pointer to **string** | Owner's ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] + +## Methods + +### NewViolationOwnerAssignmentConfigOwnerRef + +`func NewViolationOwnerAssignmentConfigOwnerRef() *ViolationOwnerAssignmentConfigOwnerRef` + +NewViolationOwnerAssignmentConfigOwnerRef instantiates a new ViolationOwnerAssignmentConfigOwnerRef 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 + +### NewViolationOwnerAssignmentConfigOwnerRefWithDefaults + +`func NewViolationOwnerAssignmentConfigOwnerRefWithDefaults() *ViolationOwnerAssignmentConfigOwnerRef` + +NewViolationOwnerAssignmentConfigOwnerRefWithDefaults instantiates a new ViolationOwnerAssignmentConfigOwnerRef 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 + +### GetType + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *ViolationOwnerAssignmentConfigOwnerRef) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetId + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/ViolationPrediction.md b/docs/tools/sdk/go/Reference/Beta/Models/ViolationPrediction.md new file mode 100644 index 000000000..cc8cbcb8d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/ViolationPrediction.md @@ -0,0 +1,64 @@ +--- +id: beta-violation-prediction +title: ViolationPrediction +pagination_label: ViolationPrediction +sidebar_label: ViolationPrediction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationPrediction', 'BetaViolationPrediction'] +slug: /tools/sdk/go/beta/models/violation-prediction +tags: ['SDK', 'Software Development Kit', 'ViolationPrediction', 'BetaViolationPrediction'] +--- + +# ViolationPrediction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ViolationContexts** | Pointer to [**[]ViolationContext**](violation-context) | List of Violation Contexts | [optional] + +## Methods + +### NewViolationPrediction + +`func NewViolationPrediction() *ViolationPrediction` + +NewViolationPrediction instantiates a new ViolationPrediction 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 + +### NewViolationPredictionWithDefaults + +`func NewViolationPredictionWithDefaults() *ViolationPrediction` + +NewViolationPredictionWithDefaults instantiates a new ViolationPrediction 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 + +### GetViolationContexts + +`func (o *ViolationPrediction) GetViolationContexts() []ViolationContext` + +GetViolationContexts returns the ViolationContexts field if non-nil, zero value otherwise. + +### GetViolationContextsOk + +`func (o *ViolationPrediction) GetViolationContextsOk() (*[]ViolationContext, bool)` + +GetViolationContextsOk returns a tuple with the ViolationContexts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationContexts + +`func (o *ViolationPrediction) SetViolationContexts(v []ViolationContext)` + +SetViolationContexts sets ViolationContexts field to given value. + +### HasViolationContexts + +`func (o *ViolationPrediction) HasViolationContexts() bool` + +HasViolationContexts returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/VisibilityCriteria.md b/docs/tools/sdk/go/Reference/Beta/Models/VisibilityCriteria.md new file mode 100644 index 000000000..76df2b9be --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/VisibilityCriteria.md @@ -0,0 +1,64 @@ +--- +id: beta-visibility-criteria +title: VisibilityCriteria +pagination_label: VisibilityCriteria +sidebar_label: VisibilityCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VisibilityCriteria', 'BetaVisibilityCriteria'] +slug: /tools/sdk/go/beta/models/visibility-criteria +tags: ['SDK', 'Software Development Kit', 'VisibilityCriteria', 'BetaVisibilityCriteria'] +--- + +# VisibilityCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | Pointer to [**Expression**](expression) | | [optional] + +## Methods + +### NewVisibilityCriteria + +`func NewVisibilityCriteria() *VisibilityCriteria` + +NewVisibilityCriteria instantiates a new VisibilityCriteria 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 + +### NewVisibilityCriteriaWithDefaults + +`func NewVisibilityCriteriaWithDefaults() *VisibilityCriteria` + +NewVisibilityCriteriaWithDefaults instantiates a new VisibilityCriteria 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 + +### GetExpression + +`func (o *VisibilityCriteria) GetExpression() Expression` + +GetExpression returns the Expression field if non-nil, zero value otherwise. + +### GetExpressionOk + +`func (o *VisibilityCriteria) GetExpressionOk() (*Expression, bool)` + +GetExpressionOk returns a tuple with the Expression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpression + +`func (o *VisibilityCriteria) SetExpression(v Expression)` + +SetExpression sets Expression field to given value. + +### HasExpression + +`func (o *VisibilityCriteria) HasExpression() bool` + +HasExpression returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkItemForward.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkItemForward.md new file mode 100644 index 000000000..65e3c0a1d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkItemForward.md @@ -0,0 +1,106 @@ +--- +id: beta-work-item-forward +title: WorkItemForward +pagination_label: WorkItemForward +sidebar_label: WorkItemForward +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemForward', 'BetaWorkItemForward'] +slug: /tools/sdk/go/beta/models/work-item-forward +tags: ['SDK', 'Software Development Kit', 'WorkItemForward', 'BetaWorkItemForward'] +--- + +# WorkItemForward + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TargetOwnerId** | **string** | The ID of the identity to forward this work item to. | +**Comment** | **string** | Comments to send to the target owner | +**SendNotifications** | Pointer to **bool** | If true, send a notification to the target owner. | [optional] [default to true] + +## Methods + +### NewWorkItemForward + +`func NewWorkItemForward(targetOwnerId string, comment string, ) *WorkItemForward` + +NewWorkItemForward instantiates a new WorkItemForward 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 + +### NewWorkItemForwardWithDefaults + +`func NewWorkItemForwardWithDefaults() *WorkItemForward` + +NewWorkItemForwardWithDefaults instantiates a new WorkItemForward 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 + +### GetTargetOwnerId + +`func (o *WorkItemForward) GetTargetOwnerId() string` + +GetTargetOwnerId returns the TargetOwnerId field if non-nil, zero value otherwise. + +### GetTargetOwnerIdOk + +`func (o *WorkItemForward) GetTargetOwnerIdOk() (*string, bool)` + +GetTargetOwnerIdOk returns a tuple with the TargetOwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetOwnerId + +`func (o *WorkItemForward) SetTargetOwnerId(v string)` + +SetTargetOwnerId sets TargetOwnerId field to given value. + + +### GetComment + +`func (o *WorkItemForward) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *WorkItemForward) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *WorkItemForward) SetComment(v string)` + +SetComment sets Comment field to given value. + + +### GetSendNotifications + +`func (o *WorkItemForward) GetSendNotifications() bool` + +GetSendNotifications returns the SendNotifications field if non-nil, zero value otherwise. + +### GetSendNotificationsOk + +`func (o *WorkItemForward) GetSendNotificationsOk() (*bool, bool)` + +GetSendNotificationsOk returns a tuple with the SendNotifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSendNotifications + +`func (o *WorkItemForward) SetSendNotifications(v bool)` + +SetSendNotifications sets SendNotifications field to given value. + +### HasSendNotifications + +`func (o *WorkItemForward) HasSendNotifications() bool` + +HasSendNotifications returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkItemState.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkItemState.md new file mode 100644 index 000000000..07e9e8ed3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkItemState.md @@ -0,0 +1,29 @@ +--- +id: beta-work-item-state +title: WorkItemState +pagination_label: WorkItemState +sidebar_label: WorkItemState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemState', 'BetaWorkItemState'] +slug: /tools/sdk/go/beta/models/work-item-state +tags: ['SDK', 'Software Development Kit', 'WorkItemState', 'BetaWorkItemState'] +--- + +# WorkItemState + +## Enum + + +* `FINISHED` (value: `"Finished"`) + +* `REJECTED` (value: `"Rejected"`) + +* `RETURNED` (value: `"Returned"`) + +* `EXPIRED` (value: `"Expired"`) + +* `PENDING` (value: `"Pending"`) + +* `CANCELED` (value: `"Canceled"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkItemType.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkItemType.md new file mode 100644 index 000000000..fddbfdd47 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkItemType.md @@ -0,0 +1,47 @@ +--- +id: beta-work-item-type +title: WorkItemType +pagination_label: WorkItemType +sidebar_label: WorkItemType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemType', 'BetaWorkItemType'] +slug: /tools/sdk/go/beta/models/work-item-type +tags: ['SDK', 'Software Development Kit', 'WorkItemType', 'BetaWorkItemType'] +--- + +# WorkItemType + +## Enum + + +* `UNKNOWN` (value: `"Unknown"`) + +* `GENERIC` (value: `"Generic"`) + +* `CERTIFICATION` (value: `"Certification"`) + +* `REMEDIATION` (value: `"Remediation"`) + +* `DELEGATION` (value: `"Delegation"`) + +* `APPROVAL` (value: `"Approval"`) + +* `VIOLATION_REVIEW` (value: `"ViolationReview"`) + +* `FORM` (value: `"Form"`) + +* `POLICY_VIOLATION` (value: `"PolicyViolation"`) + +* `CHALLENGE` (value: `"Challenge"`) + +* `IMPACT_ANALYSIS` (value: `"ImpactAnalysis"`) + +* `SIGNOFF` (value: `"Signoff"`) + +* `EVENT` (value: `"Event"`) + +* `MANUAL_ACTION` (value: `"ManualAction"`) + +* `TEST` (value: `"Test"`) + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkItems.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkItems.md new file mode 100644 index 000000000..141158cb8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkItems.md @@ -0,0 +1,590 @@ +--- +id: beta-work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItems', 'BetaWorkItems'] +slug: /tools/sdk/go/beta/models/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'BetaWorkItems'] +--- + +# WorkItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the work item | [optional] +**RequesterId** | Pointer to **NullableString** | ID of the requester | [optional] +**RequesterDisplayName** | Pointer to **NullableString** | The displayname of the requester | [optional] +**OwnerId** | Pointer to **NullableString** | The ID of the owner | [optional] +**OwnerName** | Pointer to **string** | The name of the owner | [optional] +**Created** | Pointer to **SailPointTime** | | [optional] +**Modified** | Pointer to **NullableTime** | | [optional] +**Description** | Pointer to **string** | The description of the work item | [optional] +**State** | Pointer to [**NullableWorkItemState**](work-item-state) | | [optional] +**Type** | Pointer to [**WorkItemType**](work-item-type) | | [optional] +**RemediationItems** | Pointer to [**[]RemediationItemDetails**](remediation-item-details) | | [optional] +**ApprovalItems** | Pointer to [**[]ApprovalItemDetails**](approval-item-details) | | [optional] +**Name** | Pointer to **NullableString** | The work item name | [optional] +**Completed** | Pointer to **NullableTime** | | [optional] +**NumItems** | Pointer to **NullableInt32** | The number of items in the work item | [optional] +**Errors** | Pointer to **[]string** | | [optional] +**Form** | Pointer to [**NullableFormDetails**](form-details) | | [optional] + +## Methods + +### NewWorkItems + +`func NewWorkItems() *WorkItems` + +NewWorkItems instantiates a new WorkItems 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 + +### NewWorkItemsWithDefaults + +`func NewWorkItemsWithDefaults() *WorkItems` + +NewWorkItemsWithDefaults instantiates a new WorkItems 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 + +### GetId + +`func (o *WorkItems) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkItems) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkItems) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkItems) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRequesterId + +`func (o *WorkItems) GetRequesterId() string` + +GetRequesterId returns the RequesterId field if non-nil, zero value otherwise. + +### GetRequesterIdOk + +`func (o *WorkItems) GetRequesterIdOk() (*string, bool)` + +GetRequesterIdOk returns a tuple with the RequesterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterId + +`func (o *WorkItems) SetRequesterId(v string)` + +SetRequesterId sets RequesterId field to given value. + +### HasRequesterId + +`func (o *WorkItems) HasRequesterId() bool` + +HasRequesterId returns a boolean if a field has been set. + +### SetRequesterIdNil + +`func (o *WorkItems) SetRequesterIdNil(b bool)` + + SetRequesterIdNil sets the value for RequesterId to be an explicit nil + +### UnsetRequesterId +`func (o *WorkItems) UnsetRequesterId()` + +UnsetRequesterId ensures that no value is present for RequesterId, not even an explicit nil +### GetRequesterDisplayName + +`func (o *WorkItems) GetRequesterDisplayName() string` + +GetRequesterDisplayName returns the RequesterDisplayName field if non-nil, zero value otherwise. + +### GetRequesterDisplayNameOk + +`func (o *WorkItems) GetRequesterDisplayNameOk() (*string, bool)` + +GetRequesterDisplayNameOk returns a tuple with the RequesterDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterDisplayName + +`func (o *WorkItems) SetRequesterDisplayName(v string)` + +SetRequesterDisplayName sets RequesterDisplayName field to given value. + +### HasRequesterDisplayName + +`func (o *WorkItems) HasRequesterDisplayName() bool` + +HasRequesterDisplayName returns a boolean if a field has been set. + +### SetRequesterDisplayNameNil + +`func (o *WorkItems) SetRequesterDisplayNameNil(b bool)` + + SetRequesterDisplayNameNil sets the value for RequesterDisplayName to be an explicit nil + +### UnsetRequesterDisplayName +`func (o *WorkItems) UnsetRequesterDisplayName()` + +UnsetRequesterDisplayName ensures that no value is present for RequesterDisplayName, not even an explicit nil +### GetOwnerId + +`func (o *WorkItems) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *WorkItems) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *WorkItems) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *WorkItems) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + +### SetOwnerIdNil + +`func (o *WorkItems) SetOwnerIdNil(b bool)` + + SetOwnerIdNil sets the value for OwnerId to be an explicit nil + +### UnsetOwnerId +`func (o *WorkItems) UnsetOwnerId()` + +UnsetOwnerId ensures that no value is present for OwnerId, not even an explicit nil +### GetOwnerName + +`func (o *WorkItems) GetOwnerName() string` + +GetOwnerName returns the OwnerName field if non-nil, zero value otherwise. + +### GetOwnerNameOk + +`func (o *WorkItems) GetOwnerNameOk() (*string, bool)` + +GetOwnerNameOk returns a tuple with the OwnerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerName + +`func (o *WorkItems) SetOwnerName(v string)` + +SetOwnerName sets OwnerName field to given value. + +### HasOwnerName + +`func (o *WorkItems) HasOwnerName() bool` + +HasOwnerName returns a boolean if a field has been set. + +### GetCreated + +`func (o *WorkItems) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *WorkItems) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *WorkItems) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *WorkItems) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *WorkItems) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *WorkItems) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *WorkItems) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *WorkItems) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *WorkItems) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *WorkItems) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDescription + +`func (o *WorkItems) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkItems) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkItems) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkItems) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetState + +`func (o *WorkItems) GetState() WorkItemState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *WorkItems) GetStateOk() (*WorkItemState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *WorkItems) SetState(v WorkItemState)` + +SetState sets State field to given value. + +### HasState + +`func (o *WorkItems) HasState() bool` + +HasState returns a boolean if a field has been set. + +### SetStateNil + +`func (o *WorkItems) SetStateNil(b bool)` + + SetStateNil sets the value for State to be an explicit nil + +### UnsetState +`func (o *WorkItems) UnsetState()` + +UnsetState ensures that no value is present for State, not even an explicit nil +### GetType + +`func (o *WorkItems) GetType() WorkItemType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkItems) GetTypeOk() (*WorkItemType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkItems) SetType(v WorkItemType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkItems) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRemediationItems + +`func (o *WorkItems) GetRemediationItems() []RemediationItemDetails` + +GetRemediationItems returns the RemediationItems field if non-nil, zero value otherwise. + +### GetRemediationItemsOk + +`func (o *WorkItems) GetRemediationItemsOk() (*[]RemediationItemDetails, bool)` + +GetRemediationItemsOk returns a tuple with the RemediationItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemediationItems + +`func (o *WorkItems) SetRemediationItems(v []RemediationItemDetails)` + +SetRemediationItems sets RemediationItems field to given value. + +### HasRemediationItems + +`func (o *WorkItems) HasRemediationItems() bool` + +HasRemediationItems returns a boolean if a field has been set. + +### SetRemediationItemsNil + +`func (o *WorkItems) SetRemediationItemsNil(b bool)` + + SetRemediationItemsNil sets the value for RemediationItems to be an explicit nil + +### UnsetRemediationItems +`func (o *WorkItems) UnsetRemediationItems()` + +UnsetRemediationItems ensures that no value is present for RemediationItems, not even an explicit nil +### GetApprovalItems + +`func (o *WorkItems) GetApprovalItems() []ApprovalItemDetails` + +GetApprovalItems returns the ApprovalItems field if non-nil, zero value otherwise. + +### GetApprovalItemsOk + +`func (o *WorkItems) GetApprovalItemsOk() (*[]ApprovalItemDetails, bool)` + +GetApprovalItemsOk returns a tuple with the ApprovalItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalItems + +`func (o *WorkItems) SetApprovalItems(v []ApprovalItemDetails)` + +SetApprovalItems sets ApprovalItems field to given value. + +### HasApprovalItems + +`func (o *WorkItems) HasApprovalItems() bool` + +HasApprovalItems returns a boolean if a field has been set. + +### SetApprovalItemsNil + +`func (o *WorkItems) SetApprovalItemsNil(b bool)` + + SetApprovalItemsNil sets the value for ApprovalItems to be an explicit nil + +### UnsetApprovalItems +`func (o *WorkItems) UnsetApprovalItems()` + +UnsetApprovalItems ensures that no value is present for ApprovalItems, not even an explicit nil +### GetName + +`func (o *WorkItems) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkItems) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkItems) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkItems) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *WorkItems) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *WorkItems) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCompleted + +`func (o *WorkItems) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *WorkItems) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *WorkItems) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *WorkItems) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *WorkItems) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *WorkItems) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetNumItems + +`func (o *WorkItems) GetNumItems() int32` + +GetNumItems returns the NumItems field if non-nil, zero value otherwise. + +### GetNumItemsOk + +`func (o *WorkItems) GetNumItemsOk() (*int32, bool)` + +GetNumItemsOk returns a tuple with the NumItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumItems + +`func (o *WorkItems) SetNumItems(v int32)` + +SetNumItems sets NumItems field to given value. + +### HasNumItems + +`func (o *WorkItems) HasNumItems() bool` + +HasNumItems returns a boolean if a field has been set. + +### SetNumItemsNil + +`func (o *WorkItems) SetNumItemsNil(b bool)` + + SetNumItemsNil sets the value for NumItems to be an explicit nil + +### UnsetNumItems +`func (o *WorkItems) UnsetNumItems()` + +UnsetNumItems ensures that no value is present for NumItems, not even an explicit nil +### GetErrors + +`func (o *WorkItems) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *WorkItems) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *WorkItems) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *WorkItems) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### GetForm + +`func (o *WorkItems) GetForm() FormDetails` + +GetForm returns the Form field if non-nil, zero value otherwise. + +### GetFormOk + +`func (o *WorkItems) GetFormOk() (*FormDetails, bool)` + +GetFormOk returns a tuple with the Form field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForm + +`func (o *WorkItems) SetForm(v FormDetails)` + +SetForm sets Form field to given value. + +### HasForm + +`func (o *WorkItems) HasForm() bool` + +HasForm returns a boolean if a field has been set. + +### SetFormNil + +`func (o *WorkItems) SetFormNil(b bool)` + + SetFormNil sets the value for Form to be an explicit nil + +### UnsetForm +`func (o *WorkItems) UnsetForm()` + +UnsetForm ensures that no value is present for Form, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkItemsCount.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkItemsCount.md new file mode 100644 index 000000000..17504c38f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkItemsCount.md @@ -0,0 +1,64 @@ +--- +id: beta-work-items-count +title: WorkItemsCount +pagination_label: WorkItemsCount +sidebar_label: WorkItemsCount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemsCount', 'BetaWorkItemsCount'] +slug: /tools/sdk/go/beta/models/work-items-count +tags: ['SDK', 'Software Development Kit', 'WorkItemsCount', 'BetaWorkItemsCount'] +--- + +# WorkItemsCount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **int32** | The count of work items | [optional] + +## Methods + +### NewWorkItemsCount + +`func NewWorkItemsCount() *WorkItemsCount` + +NewWorkItemsCount instantiates a new WorkItemsCount 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 + +### NewWorkItemsCountWithDefaults + +`func NewWorkItemsCountWithDefaults() *WorkItemsCount` + +NewWorkItemsCountWithDefaults instantiates a new WorkItemsCount 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 + +### GetCount + +`func (o *WorkItemsCount) GetCount() int32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *WorkItemsCount) GetCountOk() (*int32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *WorkItemsCount) SetCount(v int32)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *WorkItemsCount) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkItemsSummary.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkItemsSummary.md new file mode 100644 index 000000000..8ccaa0824 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkItemsSummary.md @@ -0,0 +1,116 @@ +--- +id: beta-work-items-summary +title: WorkItemsSummary +pagination_label: WorkItemsSummary +sidebar_label: WorkItemsSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemsSummary', 'BetaWorkItemsSummary'] +slug: /tools/sdk/go/beta/models/work-items-summary +tags: ['SDK', 'Software Development Kit', 'WorkItemsSummary', 'BetaWorkItemsSummary'] +--- + +# WorkItemsSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Open** | Pointer to **int32** | The count of open work items | [optional] +**Completed** | Pointer to **int32** | The count of completed work items | [optional] +**Total** | Pointer to **int32** | The count of total work items | [optional] + +## Methods + +### NewWorkItemsSummary + +`func NewWorkItemsSummary() *WorkItemsSummary` + +NewWorkItemsSummary instantiates a new WorkItemsSummary 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 + +### NewWorkItemsSummaryWithDefaults + +`func NewWorkItemsSummaryWithDefaults() *WorkItemsSummary` + +NewWorkItemsSummaryWithDefaults instantiates a new WorkItemsSummary 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 + +### GetOpen + +`func (o *WorkItemsSummary) GetOpen() int32` + +GetOpen returns the Open field if non-nil, zero value otherwise. + +### GetOpenOk + +`func (o *WorkItemsSummary) GetOpenOk() (*int32, bool)` + +GetOpenOk returns a tuple with the Open field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOpen + +`func (o *WorkItemsSummary) SetOpen(v int32)` + +SetOpen sets Open field to given value. + +### HasOpen + +`func (o *WorkItemsSummary) HasOpen() bool` + +HasOpen returns a boolean if a field has been set. + +### GetCompleted + +`func (o *WorkItemsSummary) GetCompleted() int32` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *WorkItemsSummary) GetCompletedOk() (*int32, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *WorkItemsSummary) SetCompleted(v int32)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *WorkItemsSummary) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetTotal + +`func (o *WorkItemsSummary) GetTotal() int32` + +GetTotal returns the Total field if non-nil, zero value otherwise. + +### GetTotalOk + +`func (o *WorkItemsSummary) GetTotalOk() (*int32, bool)` + +GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotal + +`func (o *WorkItemsSummary) SetTotal(v int32)` + +SetTotal sets Total field to given value. + +### HasTotal + +`func (o *WorkItemsSummary) HasTotal() bool` + +HasTotal returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/Workflow.md b/docs/tools/sdk/go/Reference/Beta/Models/Workflow.md new file mode 100644 index 000000000..34fa709e8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/Workflow.md @@ -0,0 +1,376 @@ +--- +id: beta-workflow +title: Workflow +pagination_label: Workflow +sidebar_label: Workflow +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Workflow', 'BetaWorkflow'] +slug: /tools/sdk/go/beta/models/workflow +tags: ['SDK', 'Software Development Kit', 'Workflow', 'BetaWorkflow'] +--- + +# Workflow + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the workflow | [optional] +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **string** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **bool** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] +**Id** | Pointer to **string** | Workflow ID. This is a UUID generated upon creation. | [optional] +**Modified** | Pointer to **SailPointTime** | The date and time the workflow was modified. | [optional] +**ModifiedBy** | Pointer to [**WorkflowModifiedBy**](workflow-modified-by) | | [optional] +**ExecutionCount** | Pointer to **int32** | The number of times this workflow has been executed. | [optional] +**FailureCount** | Pointer to **int32** | The number of times this workflow has failed during execution. | [optional] +**Created** | Pointer to **SailPointTime** | The date and time the workflow was created. | [optional] +**Creator** | Pointer to [**WorkflowAllOfCreator**](workflow-all-of-creator) | | [optional] + +## Methods + +### NewWorkflow + +`func NewWorkflow() *Workflow` + +NewWorkflow instantiates a new Workflow 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 + +### NewWorkflowWithDefaults + +`func NewWorkflowWithDefaults() *Workflow` + +NewWorkflowWithDefaults instantiates a new Workflow 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 + +### GetName + +`func (o *Workflow) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Workflow) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Workflow) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Workflow) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOwner + +`func (o *Workflow) GetOwner() WorkflowBodyOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Workflow) GetOwnerOk() (*WorkflowBodyOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Workflow) SetOwner(v WorkflowBodyOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *Workflow) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDescription + +`func (o *Workflow) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Workflow) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Workflow) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Workflow) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDefinition + +`func (o *Workflow) GetDefinition() WorkflowDefinition` + +GetDefinition returns the Definition field if non-nil, zero value otherwise. + +### GetDefinitionOk + +`func (o *Workflow) GetDefinitionOk() (*WorkflowDefinition, bool)` + +GetDefinitionOk returns a tuple with the Definition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefinition + +`func (o *Workflow) SetDefinition(v WorkflowDefinition)` + +SetDefinition sets Definition field to given value. + +### HasDefinition + +`func (o *Workflow) HasDefinition() bool` + +HasDefinition returns a boolean if a field has been set. + +### GetEnabled + +`func (o *Workflow) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *Workflow) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *Workflow) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *Workflow) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetTrigger + +`func (o *Workflow) GetTrigger() WorkflowTrigger` + +GetTrigger returns the Trigger field if non-nil, zero value otherwise. + +### GetTriggerOk + +`func (o *Workflow) GetTriggerOk() (*WorkflowTrigger, bool)` + +GetTriggerOk returns a tuple with the Trigger field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrigger + +`func (o *Workflow) SetTrigger(v WorkflowTrigger)` + +SetTrigger sets Trigger field to given value. + +### HasTrigger + +`func (o *Workflow) HasTrigger() bool` + +HasTrigger returns a boolean if a field has been set. + +### GetId + +`func (o *Workflow) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Workflow) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Workflow) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Workflow) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetModified + +`func (o *Workflow) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Workflow) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Workflow) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Workflow) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetModifiedBy + +`func (o *Workflow) GetModifiedBy() WorkflowModifiedBy` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *Workflow) GetModifiedByOk() (*WorkflowModifiedBy, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedBy + +`func (o *Workflow) SetModifiedBy(v WorkflowModifiedBy)` + +SetModifiedBy sets ModifiedBy field to given value. + +### HasModifiedBy + +`func (o *Workflow) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### GetExecutionCount + +`func (o *Workflow) GetExecutionCount() int32` + +GetExecutionCount returns the ExecutionCount field if non-nil, zero value otherwise. + +### GetExecutionCountOk + +`func (o *Workflow) GetExecutionCountOk() (*int32, bool)` + +GetExecutionCountOk returns a tuple with the ExecutionCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExecutionCount + +`func (o *Workflow) SetExecutionCount(v int32)` + +SetExecutionCount sets ExecutionCount field to given value. + +### HasExecutionCount + +`func (o *Workflow) HasExecutionCount() bool` + +HasExecutionCount returns a boolean if a field has been set. + +### GetFailureCount + +`func (o *Workflow) GetFailureCount() int32` + +GetFailureCount returns the FailureCount field if non-nil, zero value otherwise. + +### GetFailureCountOk + +`func (o *Workflow) GetFailureCountOk() (*int32, bool)` + +GetFailureCountOk returns a tuple with the FailureCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFailureCount + +`func (o *Workflow) SetFailureCount(v int32)` + +SetFailureCount sets FailureCount field to given value. + +### HasFailureCount + +`func (o *Workflow) HasFailureCount() bool` + +HasFailureCount returns a boolean if a field has been set. + +### GetCreated + +`func (o *Workflow) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Workflow) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Workflow) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Workflow) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetCreator + +`func (o *Workflow) GetCreator() WorkflowAllOfCreator` + +GetCreator returns the Creator field if non-nil, zero value otherwise. + +### GetCreatorOk + +`func (o *Workflow) GetCreatorOk() (*WorkflowAllOfCreator, bool)` + +GetCreatorOk returns a tuple with the Creator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreator + +`func (o *Workflow) SetCreator(v WorkflowAllOfCreator)` + +SetCreator sets Creator field to given value. + +### HasCreator + +`func (o *Workflow) HasCreator() bool` + +HasCreator returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkflowAllOfCreator.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowAllOfCreator.md new file mode 100644 index 000000000..7334e7a36 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowAllOfCreator.md @@ -0,0 +1,116 @@ +--- +id: beta-workflow-all-of-creator +title: WorkflowAllOfCreator +pagination_label: WorkflowAllOfCreator +sidebar_label: WorkflowAllOfCreator +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowAllOfCreator', 'BetaWorkflowAllOfCreator'] +slug: /tools/sdk/go/beta/models/workflow-all-of-creator +tags: ['SDK', 'Software Development Kit', 'WorkflowAllOfCreator', 'BetaWorkflowAllOfCreator'] +--- + +# WorkflowAllOfCreator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Workflow creator's DTO type. | [optional] +**Id** | Pointer to **string** | Workflow creator's identity ID. | [optional] +**Name** | Pointer to **string** | Workflow creator's display name. | [optional] + +## Methods + +### NewWorkflowAllOfCreator + +`func NewWorkflowAllOfCreator() *WorkflowAllOfCreator` + +NewWorkflowAllOfCreator instantiates a new WorkflowAllOfCreator 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 + +### NewWorkflowAllOfCreatorWithDefaults + +`func NewWorkflowAllOfCreatorWithDefaults() *WorkflowAllOfCreator` + +NewWorkflowAllOfCreatorWithDefaults instantiates a new WorkflowAllOfCreator 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 + +### GetType + +`func (o *WorkflowAllOfCreator) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowAllOfCreator) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowAllOfCreator) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowAllOfCreator) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkflowAllOfCreator) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowAllOfCreator) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowAllOfCreator) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowAllOfCreator) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowAllOfCreator) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowAllOfCreator) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowAllOfCreator) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowAllOfCreator) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkflowBody.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowBody.md new file mode 100644 index 000000000..54e91bdc9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowBody.md @@ -0,0 +1,194 @@ +--- +id: beta-workflow-body +title: WorkflowBody +pagination_label: WorkflowBody +sidebar_label: WorkflowBody +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowBody', 'BetaWorkflowBody'] +slug: /tools/sdk/go/beta/models/workflow-body +tags: ['SDK', 'Software Development Kit', 'WorkflowBody', 'BetaWorkflowBody'] +--- + +# WorkflowBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the workflow | [optional] +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **string** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **bool** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] + +## Methods + +### NewWorkflowBody + +`func NewWorkflowBody() *WorkflowBody` + +NewWorkflowBody instantiates a new WorkflowBody 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 + +### NewWorkflowBodyWithDefaults + +`func NewWorkflowBodyWithDefaults() *WorkflowBody` + +NewWorkflowBodyWithDefaults instantiates a new WorkflowBody 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 + +### GetName + +`func (o *WorkflowBody) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowBody) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowBody) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowBody) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOwner + +`func (o *WorkflowBody) GetOwner() WorkflowBodyOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *WorkflowBody) GetOwnerOk() (*WorkflowBodyOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *WorkflowBody) SetOwner(v WorkflowBodyOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *WorkflowBody) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkflowBody) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowBody) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowBody) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowBody) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDefinition + +`func (o *WorkflowBody) GetDefinition() WorkflowDefinition` + +GetDefinition returns the Definition field if non-nil, zero value otherwise. + +### GetDefinitionOk + +`func (o *WorkflowBody) GetDefinitionOk() (*WorkflowDefinition, bool)` + +GetDefinitionOk returns a tuple with the Definition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefinition + +`func (o *WorkflowBody) SetDefinition(v WorkflowDefinition)` + +SetDefinition sets Definition field to given value. + +### HasDefinition + +`func (o *WorkflowBody) HasDefinition() bool` + +HasDefinition returns a boolean if a field has been set. + +### GetEnabled + +`func (o *WorkflowBody) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *WorkflowBody) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *WorkflowBody) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *WorkflowBody) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetTrigger + +`func (o *WorkflowBody) GetTrigger() WorkflowTrigger` + +GetTrigger returns the Trigger field if non-nil, zero value otherwise. + +### GetTriggerOk + +`func (o *WorkflowBody) GetTriggerOk() (*WorkflowTrigger, bool)` + +GetTriggerOk returns a tuple with the Trigger field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrigger + +`func (o *WorkflowBody) SetTrigger(v WorkflowTrigger)` + +SetTrigger sets Trigger field to given value. + +### HasTrigger + +`func (o *WorkflowBody) HasTrigger() bool` + +HasTrigger returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkflowBodyOwner.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowBodyOwner.md new file mode 100644 index 000000000..dac68aba0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowBodyOwner.md @@ -0,0 +1,116 @@ +--- +id: beta-workflow-body-owner +title: WorkflowBodyOwner +pagination_label: WorkflowBodyOwner +sidebar_label: WorkflowBodyOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowBodyOwner', 'BetaWorkflowBodyOwner'] +slug: /tools/sdk/go/beta/models/workflow-body-owner +tags: ['SDK', 'Software Development Kit', 'WorkflowBodyOwner', 'BetaWorkflowBodyOwner'] +--- + +# WorkflowBodyOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of object that is referenced | [optional] +**Id** | Pointer to **string** | The unique ID of the object | [optional] +**Name** | Pointer to **string** | The name of the object | [optional] + +## Methods + +### NewWorkflowBodyOwner + +`func NewWorkflowBodyOwner() *WorkflowBodyOwner` + +NewWorkflowBodyOwner instantiates a new WorkflowBodyOwner 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 + +### NewWorkflowBodyOwnerWithDefaults + +`func NewWorkflowBodyOwnerWithDefaults() *WorkflowBodyOwner` + +NewWorkflowBodyOwnerWithDefaults instantiates a new WorkflowBodyOwner 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 + +### GetType + +`func (o *WorkflowBodyOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowBodyOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowBodyOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowBodyOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkflowBodyOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowBodyOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowBodyOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowBodyOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowBodyOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowBodyOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowBodyOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowBodyOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkflowDefinition.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowDefinition.md new file mode 100644 index 000000000..088f73df0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowDefinition.md @@ -0,0 +1,90 @@ +--- +id: beta-workflow-definition +title: WorkflowDefinition +pagination_label: WorkflowDefinition +sidebar_label: WorkflowDefinition +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowDefinition', 'BetaWorkflowDefinition'] +slug: /tools/sdk/go/beta/models/workflow-definition +tags: ['SDK', 'Software Development Kit', 'WorkflowDefinition', 'BetaWorkflowDefinition'] +--- + +# WorkflowDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **string** | The name of the starting step. | [optional] +**Steps** | Pointer to **map[string]interface{}** | One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. | [optional] + +## Methods + +### NewWorkflowDefinition + +`func NewWorkflowDefinition() *WorkflowDefinition` + +NewWorkflowDefinition instantiates a new WorkflowDefinition 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 + +### NewWorkflowDefinitionWithDefaults + +`func NewWorkflowDefinitionWithDefaults() *WorkflowDefinition` + +NewWorkflowDefinitionWithDefaults instantiates a new WorkflowDefinition 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 + +### GetStart + +`func (o *WorkflowDefinition) GetStart() string` + +GetStart returns the Start field if non-nil, zero value otherwise. + +### GetStartOk + +`func (o *WorkflowDefinition) GetStartOk() (*string, bool)` + +GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStart + +`func (o *WorkflowDefinition) SetStart(v string)` + +SetStart sets Start field to given value. + +### HasStart + +`func (o *WorkflowDefinition) HasStart() bool` + +HasStart returns a boolean if a field has been set. + +### GetSteps + +`func (o *WorkflowDefinition) GetSteps() map[string]interface{}` + +GetSteps returns the Steps field if non-nil, zero value otherwise. + +### GetStepsOk + +`func (o *WorkflowDefinition) GetStepsOk() (*map[string]interface{}, bool)` + +GetStepsOk returns a tuple with the Steps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSteps + +`func (o *WorkflowDefinition) SetSteps(v map[string]interface{})` + +SetSteps sets Steps field to given value. + +### HasSteps + +`func (o *WorkflowDefinition) HasSteps() bool` + +HasSteps returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkflowExecution.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowExecution.md new file mode 100644 index 000000000..6ce57f7e1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowExecution.md @@ -0,0 +1,194 @@ +--- +id: beta-workflow-execution +title: WorkflowExecution +pagination_label: WorkflowExecution +sidebar_label: WorkflowExecution +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowExecution', 'BetaWorkflowExecution'] +slug: /tools/sdk/go/beta/models/workflow-execution +tags: ['SDK', 'Software Development Kit', 'WorkflowExecution', 'BetaWorkflowExecution'] +--- + +# WorkflowExecution + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Workflow execution ID. | [optional] +**WorkflowId** | Pointer to **string** | Workflow ID. | [optional] +**RequestId** | Pointer to **string** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] +**StartTime** | Pointer to **SailPointTime** | Date/time when the workflow started. | [optional] +**CloseTime** | Pointer to **SailPointTime** | Date/time when the workflow ended. | [optional] +**Status** | Pointer to **string** | Workflow execution status. | [optional] + +## Methods + +### NewWorkflowExecution + +`func NewWorkflowExecution() *WorkflowExecution` + +NewWorkflowExecution instantiates a new WorkflowExecution 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 + +### NewWorkflowExecutionWithDefaults + +`func NewWorkflowExecutionWithDefaults() *WorkflowExecution` + +NewWorkflowExecutionWithDefaults instantiates a new WorkflowExecution 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 + +### GetId + +`func (o *WorkflowExecution) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowExecution) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowExecution) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowExecution) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetWorkflowId + +`func (o *WorkflowExecution) GetWorkflowId() string` + +GetWorkflowId returns the WorkflowId field if non-nil, zero value otherwise. + +### GetWorkflowIdOk + +`func (o *WorkflowExecution) GetWorkflowIdOk() (*string, bool)` + +GetWorkflowIdOk returns a tuple with the WorkflowId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWorkflowId + +`func (o *WorkflowExecution) SetWorkflowId(v string)` + +SetWorkflowId sets WorkflowId field to given value. + +### HasWorkflowId + +`func (o *WorkflowExecution) HasWorkflowId() bool` + +HasWorkflowId returns a boolean if a field has been set. + +### GetRequestId + +`func (o *WorkflowExecution) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *WorkflowExecution) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *WorkflowExecution) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *WorkflowExecution) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### GetStartTime + +`func (o *WorkflowExecution) GetStartTime() SailPointTime` + +GetStartTime returns the StartTime field if non-nil, zero value otherwise. + +### GetStartTimeOk + +`func (o *WorkflowExecution) GetStartTimeOk() (*SailPointTime, bool)` + +GetStartTimeOk returns a tuple with the StartTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartTime + +`func (o *WorkflowExecution) SetStartTime(v SailPointTime)` + +SetStartTime sets StartTime field to given value. + +### HasStartTime + +`func (o *WorkflowExecution) HasStartTime() bool` + +HasStartTime returns a boolean if a field has been set. + +### GetCloseTime + +`func (o *WorkflowExecution) GetCloseTime() SailPointTime` + +GetCloseTime returns the CloseTime field if non-nil, zero value otherwise. + +### GetCloseTimeOk + +`func (o *WorkflowExecution) GetCloseTimeOk() (*SailPointTime, bool)` + +GetCloseTimeOk returns a tuple with the CloseTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloseTime + +`func (o *WorkflowExecution) SetCloseTime(v SailPointTime)` + +SetCloseTime sets CloseTime field to given value. + +### HasCloseTime + +`func (o *WorkflowExecution) HasCloseTime() bool` + +HasCloseTime returns a boolean if a field has been set. + +### GetStatus + +`func (o *WorkflowExecution) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *WorkflowExecution) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *WorkflowExecution) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *WorkflowExecution) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkflowExecutionEvent.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowExecutionEvent.md new file mode 100644 index 000000000..2c710c815 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowExecutionEvent.md @@ -0,0 +1,116 @@ +--- +id: beta-workflow-execution-event +title: WorkflowExecutionEvent +pagination_label: WorkflowExecutionEvent +sidebar_label: WorkflowExecutionEvent +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowExecutionEvent', 'BetaWorkflowExecutionEvent'] +slug: /tools/sdk/go/beta/models/workflow-execution-event +tags: ['SDK', 'Software Development Kit', 'WorkflowExecutionEvent', 'BetaWorkflowExecutionEvent'] +--- + +# WorkflowExecutionEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **map[string]interface{}** | The type of event | [optional] +**Timestamp** | Pointer to **SailPointTime** | The date-time when the event occurred | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Additional attributes associated with the event | [optional] + +## Methods + +### NewWorkflowExecutionEvent + +`func NewWorkflowExecutionEvent() *WorkflowExecutionEvent` + +NewWorkflowExecutionEvent instantiates a new WorkflowExecutionEvent 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 + +### NewWorkflowExecutionEventWithDefaults + +`func NewWorkflowExecutionEventWithDefaults() *WorkflowExecutionEvent` + +NewWorkflowExecutionEventWithDefaults instantiates a new WorkflowExecutionEvent 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 + +### GetType + +`func (o *WorkflowExecutionEvent) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowExecutionEvent) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowExecutionEvent) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowExecutionEvent) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetTimestamp + +`func (o *WorkflowExecutionEvent) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *WorkflowExecutionEvent) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *WorkflowExecutionEvent) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *WorkflowExecutionEvent) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + +### GetAttributes + +`func (o *WorkflowExecutionEvent) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *WorkflowExecutionEvent) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *WorkflowExecutionEvent) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *WorkflowExecutionEvent) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkflowLibraryAction.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowLibraryAction.md new file mode 100644 index 000000000..6522a8a83 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowLibraryAction.md @@ -0,0 +1,360 @@ +--- +id: beta-workflow-library-action +title: WorkflowLibraryAction +pagination_label: WorkflowLibraryAction +sidebar_label: WorkflowLibraryAction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryAction', 'BetaWorkflowLibraryAction'] +slug: /tools/sdk/go/beta/models/workflow-library-action +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryAction', 'BetaWorkflowLibraryAction'] +--- + +# WorkflowLibraryAction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Action ID. This is a static namespaced ID for the action | [optional] +**Name** | Pointer to **string** | Action Name | [optional] +**Type** | Pointer to **string** | Action type | [optional] +**Description** | Pointer to **string** | Action Description | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the action accepts | [optional] +**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**Deprecated** | Pointer to **bool** | | [optional] +**DeprecatedBy** | Pointer to **SailPointTime** | | [optional] +**VersionNumber** | Pointer to **int32** | Version number | [optional] +**IsSimulationEnabled** | Pointer to **bool** | | [optional] +**IsDynamicSchema** | Pointer to **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**OutputSchema** | Pointer to **map[string]interface{}** | Defines the output schema, if any, that this action produces. | [optional] + +## Methods + +### NewWorkflowLibraryAction + +`func NewWorkflowLibraryAction() *WorkflowLibraryAction` + +NewWorkflowLibraryAction instantiates a new WorkflowLibraryAction 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 + +### NewWorkflowLibraryActionWithDefaults + +`func NewWorkflowLibraryActionWithDefaults() *WorkflowLibraryAction` + +NewWorkflowLibraryActionWithDefaults instantiates a new WorkflowLibraryAction 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 + +### GetId + +`func (o *WorkflowLibraryAction) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowLibraryAction) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowLibraryAction) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowLibraryAction) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowLibraryAction) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowLibraryAction) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowLibraryAction) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowLibraryAction) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *WorkflowLibraryAction) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowLibraryAction) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowLibraryAction) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowLibraryAction) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkflowLibraryAction) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowLibraryAction) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowLibraryAction) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowLibraryAction) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetFormFields + +`func (o *WorkflowLibraryAction) GetFormFields() []WorkflowLibraryFormFields` + +GetFormFields returns the FormFields field if non-nil, zero value otherwise. + +### GetFormFieldsOk + +`func (o *WorkflowLibraryAction) GetFormFieldsOk() (*[]WorkflowLibraryFormFields, bool)` + +GetFormFieldsOk returns a tuple with the FormFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormFields + +`func (o *WorkflowLibraryAction) SetFormFields(v []WorkflowLibraryFormFields)` + +SetFormFields sets FormFields field to given value. + +### HasFormFields + +`func (o *WorkflowLibraryAction) HasFormFields() bool` + +HasFormFields returns a boolean if a field has been set. + +### SetFormFieldsNil + +`func (o *WorkflowLibraryAction) SetFormFieldsNil(b bool)` + + SetFormFieldsNil sets the value for FormFields to be an explicit nil + +### UnsetFormFields +`func (o *WorkflowLibraryAction) UnsetFormFields()` + +UnsetFormFields ensures that no value is present for FormFields, not even an explicit nil +### GetExampleOutput + +`func (o *WorkflowLibraryAction) GetExampleOutput() WorkflowLibraryActionExampleOutput` + +GetExampleOutput returns the ExampleOutput field if non-nil, zero value otherwise. + +### GetExampleOutputOk + +`func (o *WorkflowLibraryAction) GetExampleOutputOk() (*WorkflowLibraryActionExampleOutput, bool)` + +GetExampleOutputOk returns a tuple with the ExampleOutput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExampleOutput + +`func (o *WorkflowLibraryAction) SetExampleOutput(v WorkflowLibraryActionExampleOutput)` + +SetExampleOutput sets ExampleOutput field to given value. + +### HasExampleOutput + +`func (o *WorkflowLibraryAction) HasExampleOutput() bool` + +HasExampleOutput returns a boolean if a field has been set. + +### GetDeprecated + +`func (o *WorkflowLibraryAction) GetDeprecated() bool` + +GetDeprecated returns the Deprecated field if non-nil, zero value otherwise. + +### GetDeprecatedOk + +`func (o *WorkflowLibraryAction) GetDeprecatedOk() (*bool, bool)` + +GetDeprecatedOk returns a tuple with the Deprecated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecated + +`func (o *WorkflowLibraryAction) SetDeprecated(v bool)` + +SetDeprecated sets Deprecated field to given value. + +### HasDeprecated + +`func (o *WorkflowLibraryAction) HasDeprecated() bool` + +HasDeprecated returns a boolean if a field has been set. + +### GetDeprecatedBy + +`func (o *WorkflowLibraryAction) GetDeprecatedBy() SailPointTime` + +GetDeprecatedBy returns the DeprecatedBy field if non-nil, zero value otherwise. + +### GetDeprecatedByOk + +`func (o *WorkflowLibraryAction) GetDeprecatedByOk() (*SailPointTime, bool)` + +GetDeprecatedByOk returns a tuple with the DeprecatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecatedBy + +`func (o *WorkflowLibraryAction) SetDeprecatedBy(v SailPointTime)` + +SetDeprecatedBy sets DeprecatedBy field to given value. + +### HasDeprecatedBy + +`func (o *WorkflowLibraryAction) HasDeprecatedBy() bool` + +HasDeprecatedBy returns a boolean if a field has been set. + +### GetVersionNumber + +`func (o *WorkflowLibraryAction) GetVersionNumber() int32` + +GetVersionNumber returns the VersionNumber field if non-nil, zero value otherwise. + +### GetVersionNumberOk + +`func (o *WorkflowLibraryAction) GetVersionNumberOk() (*int32, bool)` + +GetVersionNumberOk returns a tuple with the VersionNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionNumber + +`func (o *WorkflowLibraryAction) SetVersionNumber(v int32)` + +SetVersionNumber sets VersionNumber field to given value. + +### HasVersionNumber + +`func (o *WorkflowLibraryAction) HasVersionNumber() bool` + +HasVersionNumber returns a boolean if a field has been set. + +### GetIsSimulationEnabled + +`func (o *WorkflowLibraryAction) GetIsSimulationEnabled() bool` + +GetIsSimulationEnabled returns the IsSimulationEnabled field if non-nil, zero value otherwise. + +### GetIsSimulationEnabledOk + +`func (o *WorkflowLibraryAction) GetIsSimulationEnabledOk() (*bool, bool)` + +GetIsSimulationEnabledOk returns a tuple with the IsSimulationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSimulationEnabled + +`func (o *WorkflowLibraryAction) SetIsSimulationEnabled(v bool)` + +SetIsSimulationEnabled sets IsSimulationEnabled field to given value. + +### HasIsSimulationEnabled + +`func (o *WorkflowLibraryAction) HasIsSimulationEnabled() bool` + +HasIsSimulationEnabled returns a boolean if a field has been set. + +### GetIsDynamicSchema + +`func (o *WorkflowLibraryAction) GetIsDynamicSchema() bool` + +GetIsDynamicSchema returns the IsDynamicSchema field if non-nil, zero value otherwise. + +### GetIsDynamicSchemaOk + +`func (o *WorkflowLibraryAction) GetIsDynamicSchemaOk() (*bool, bool)` + +GetIsDynamicSchemaOk returns a tuple with the IsDynamicSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDynamicSchema + +`func (o *WorkflowLibraryAction) SetIsDynamicSchema(v bool)` + +SetIsDynamicSchema sets IsDynamicSchema field to given value. + +### HasIsDynamicSchema + +`func (o *WorkflowLibraryAction) HasIsDynamicSchema() bool` + +HasIsDynamicSchema returns a boolean if a field has been set. + +### GetOutputSchema + +`func (o *WorkflowLibraryAction) GetOutputSchema() map[string]interface{}` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *WorkflowLibraryAction) GetOutputSchemaOk() (*map[string]interface{}, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *WorkflowLibraryAction) SetOutputSchema(v map[string]interface{})` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *WorkflowLibraryAction) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkflowLibraryActionExampleOutput.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowLibraryActionExampleOutput.md new file mode 100644 index 000000000..f06c0d271 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowLibraryActionExampleOutput.md @@ -0,0 +1,38 @@ +--- +id: beta-workflow-library-action-example-output +title: WorkflowLibraryActionExampleOutput +pagination_label: WorkflowLibraryActionExampleOutput +sidebar_label: WorkflowLibraryActionExampleOutput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryActionExampleOutput', 'BetaWorkflowLibraryActionExampleOutput'] +slug: /tools/sdk/go/beta/models/workflow-library-action-example-output +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryActionExampleOutput', 'BetaWorkflowLibraryActionExampleOutput'] +--- + +# WorkflowLibraryActionExampleOutput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewWorkflowLibraryActionExampleOutput + +`func NewWorkflowLibraryActionExampleOutput() *WorkflowLibraryActionExampleOutput` + +NewWorkflowLibraryActionExampleOutput instantiates a new WorkflowLibraryActionExampleOutput 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 + +### NewWorkflowLibraryActionExampleOutputWithDefaults + +`func NewWorkflowLibraryActionExampleOutputWithDefaults() *WorkflowLibraryActionExampleOutput` + +NewWorkflowLibraryActionExampleOutputWithDefaults instantiates a new WorkflowLibraryActionExampleOutput 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 + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkflowLibraryFormFields.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowLibraryFormFields.md new file mode 100644 index 000000000..fba4589f1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowLibraryFormFields.md @@ -0,0 +1,204 @@ +--- +id: beta-workflow-library-form-fields +title: WorkflowLibraryFormFields +pagination_label: WorkflowLibraryFormFields +sidebar_label: WorkflowLibraryFormFields +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryFormFields', 'BetaWorkflowLibraryFormFields'] +slug: /tools/sdk/go/beta/models/workflow-library-form-fields +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryFormFields', 'BetaWorkflowLibraryFormFields'] +--- + +# WorkflowLibraryFormFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Description of the form field | [optional] +**HelpText** | Pointer to **string** | Describes the form field in the UI | [optional] +**Label** | Pointer to **string** | A human readable name for this form field in the UI | [optional] +**Name** | Pointer to **string** | The name of the input attribute | [optional] +**Required** | Pointer to **bool** | Denotes if this field is a required attribute | [optional] +**Type** | Pointer to **NullableString** | The type of the form field | [optional] + +## Methods + +### NewWorkflowLibraryFormFields + +`func NewWorkflowLibraryFormFields() *WorkflowLibraryFormFields` + +NewWorkflowLibraryFormFields instantiates a new WorkflowLibraryFormFields 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 + +### NewWorkflowLibraryFormFieldsWithDefaults + +`func NewWorkflowLibraryFormFieldsWithDefaults() *WorkflowLibraryFormFields` + +NewWorkflowLibraryFormFieldsWithDefaults instantiates a new WorkflowLibraryFormFields 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 + +### GetDescription + +`func (o *WorkflowLibraryFormFields) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowLibraryFormFields) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowLibraryFormFields) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowLibraryFormFields) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetHelpText + +`func (o *WorkflowLibraryFormFields) GetHelpText() string` + +GetHelpText returns the HelpText field if non-nil, zero value otherwise. + +### GetHelpTextOk + +`func (o *WorkflowLibraryFormFields) GetHelpTextOk() (*string, bool)` + +GetHelpTextOk returns a tuple with the HelpText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHelpText + +`func (o *WorkflowLibraryFormFields) SetHelpText(v string)` + +SetHelpText sets HelpText field to given value. + +### HasHelpText + +`func (o *WorkflowLibraryFormFields) HasHelpText() bool` + +HasHelpText returns a boolean if a field has been set. + +### GetLabel + +`func (o *WorkflowLibraryFormFields) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *WorkflowLibraryFormFields) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *WorkflowLibraryFormFields) SetLabel(v string)` + +SetLabel sets Label field to given value. + +### HasLabel + +`func (o *WorkflowLibraryFormFields) HasLabel() bool` + +HasLabel returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowLibraryFormFields) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowLibraryFormFields) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowLibraryFormFields) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowLibraryFormFields) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetRequired + +`func (o *WorkflowLibraryFormFields) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *WorkflowLibraryFormFields) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *WorkflowLibraryFormFields) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *WorkflowLibraryFormFields) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + +### GetType + +`func (o *WorkflowLibraryFormFields) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowLibraryFormFields) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowLibraryFormFields) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowLibraryFormFields) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *WorkflowLibraryFormFields) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *WorkflowLibraryFormFields) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkflowLibraryOperator.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowLibraryOperator.md new file mode 100644 index 000000000..cfa891340 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowLibraryOperator.md @@ -0,0 +1,282 @@ +--- +id: beta-workflow-library-operator +title: WorkflowLibraryOperator +pagination_label: WorkflowLibraryOperator +sidebar_label: WorkflowLibraryOperator +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryOperator', 'BetaWorkflowLibraryOperator'] +slug: /tools/sdk/go/beta/models/workflow-library-operator +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryOperator', 'BetaWorkflowLibraryOperator'] +--- + +# WorkflowLibraryOperator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Operator ID. | [optional] +**Name** | Pointer to **string** | Operator friendly name | [optional] +**Type** | Pointer to **string** | Operator type | [optional] +**Description** | Pointer to **string** | Description of the operator | [optional] +**IsDynamicSchema** | Pointer to **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**Deprecated** | Pointer to **bool** | | [optional] +**DeprecatedBy** | Pointer to **SailPointTime** | | [optional] +**IsSimulationEnabled** | Pointer to **bool** | | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] + +## Methods + +### NewWorkflowLibraryOperator + +`func NewWorkflowLibraryOperator() *WorkflowLibraryOperator` + +NewWorkflowLibraryOperator instantiates a new WorkflowLibraryOperator 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 + +### NewWorkflowLibraryOperatorWithDefaults + +`func NewWorkflowLibraryOperatorWithDefaults() *WorkflowLibraryOperator` + +NewWorkflowLibraryOperatorWithDefaults instantiates a new WorkflowLibraryOperator 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 + +### GetId + +`func (o *WorkflowLibraryOperator) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowLibraryOperator) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowLibraryOperator) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowLibraryOperator) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowLibraryOperator) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowLibraryOperator) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowLibraryOperator) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowLibraryOperator) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *WorkflowLibraryOperator) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowLibraryOperator) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowLibraryOperator) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowLibraryOperator) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkflowLibraryOperator) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowLibraryOperator) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowLibraryOperator) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowLibraryOperator) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIsDynamicSchema + +`func (o *WorkflowLibraryOperator) GetIsDynamicSchema() bool` + +GetIsDynamicSchema returns the IsDynamicSchema field if non-nil, zero value otherwise. + +### GetIsDynamicSchemaOk + +`func (o *WorkflowLibraryOperator) GetIsDynamicSchemaOk() (*bool, bool)` + +GetIsDynamicSchemaOk returns a tuple with the IsDynamicSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDynamicSchema + +`func (o *WorkflowLibraryOperator) SetIsDynamicSchema(v bool)` + +SetIsDynamicSchema sets IsDynamicSchema field to given value. + +### HasIsDynamicSchema + +`func (o *WorkflowLibraryOperator) HasIsDynamicSchema() bool` + +HasIsDynamicSchema returns a boolean if a field has been set. + +### GetDeprecated + +`func (o *WorkflowLibraryOperator) GetDeprecated() bool` + +GetDeprecated returns the Deprecated field if non-nil, zero value otherwise. + +### GetDeprecatedOk + +`func (o *WorkflowLibraryOperator) GetDeprecatedOk() (*bool, bool)` + +GetDeprecatedOk returns a tuple with the Deprecated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecated + +`func (o *WorkflowLibraryOperator) SetDeprecated(v bool)` + +SetDeprecated sets Deprecated field to given value. + +### HasDeprecated + +`func (o *WorkflowLibraryOperator) HasDeprecated() bool` + +HasDeprecated returns a boolean if a field has been set. + +### GetDeprecatedBy + +`func (o *WorkflowLibraryOperator) GetDeprecatedBy() SailPointTime` + +GetDeprecatedBy returns the DeprecatedBy field if non-nil, zero value otherwise. + +### GetDeprecatedByOk + +`func (o *WorkflowLibraryOperator) GetDeprecatedByOk() (*SailPointTime, bool)` + +GetDeprecatedByOk returns a tuple with the DeprecatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecatedBy + +`func (o *WorkflowLibraryOperator) SetDeprecatedBy(v SailPointTime)` + +SetDeprecatedBy sets DeprecatedBy field to given value. + +### HasDeprecatedBy + +`func (o *WorkflowLibraryOperator) HasDeprecatedBy() bool` + +HasDeprecatedBy returns a boolean if a field has been set. + +### GetIsSimulationEnabled + +`func (o *WorkflowLibraryOperator) GetIsSimulationEnabled() bool` + +GetIsSimulationEnabled returns the IsSimulationEnabled field if non-nil, zero value otherwise. + +### GetIsSimulationEnabledOk + +`func (o *WorkflowLibraryOperator) GetIsSimulationEnabledOk() (*bool, bool)` + +GetIsSimulationEnabledOk returns a tuple with the IsSimulationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSimulationEnabled + +`func (o *WorkflowLibraryOperator) SetIsSimulationEnabled(v bool)` + +SetIsSimulationEnabled sets IsSimulationEnabled field to given value. + +### HasIsSimulationEnabled + +`func (o *WorkflowLibraryOperator) HasIsSimulationEnabled() bool` + +HasIsSimulationEnabled returns a boolean if a field has been set. + +### GetFormFields + +`func (o *WorkflowLibraryOperator) GetFormFields() []WorkflowLibraryFormFields` + +GetFormFields returns the FormFields field if non-nil, zero value otherwise. + +### GetFormFieldsOk + +`func (o *WorkflowLibraryOperator) GetFormFieldsOk() (*[]WorkflowLibraryFormFields, bool)` + +GetFormFieldsOk returns a tuple with the FormFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormFields + +`func (o *WorkflowLibraryOperator) SetFormFields(v []WorkflowLibraryFormFields)` + +SetFormFields sets FormFields field to given value. + +### HasFormFields + +`func (o *WorkflowLibraryOperator) HasFormFields() bool` + +HasFormFields returns a boolean if a field has been set. + +### SetFormFieldsNil + +`func (o *WorkflowLibraryOperator) SetFormFieldsNil(b bool)` + + SetFormFieldsNil sets the value for FormFields to be an explicit nil + +### UnsetFormFields +`func (o *WorkflowLibraryOperator) UnsetFormFields()` + +UnsetFormFields ensures that no value is present for FormFields, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkflowLibraryTrigger.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowLibraryTrigger.md new file mode 100644 index 000000000..48975cdad --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowLibraryTrigger.md @@ -0,0 +1,344 @@ +--- +id: beta-workflow-library-trigger +title: WorkflowLibraryTrigger +pagination_label: WorkflowLibraryTrigger +sidebar_label: WorkflowLibraryTrigger +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryTrigger', 'BetaWorkflowLibraryTrigger'] +slug: /tools/sdk/go/beta/models/workflow-library-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryTrigger', 'BetaWorkflowLibraryTrigger'] +--- + +# WorkflowLibraryTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Trigger ID. This is a static namespaced ID for the trigger. | [optional] +**Type** | Pointer to **string** | Trigger type | [optional] +**Deprecated** | Pointer to **bool** | | [optional] +**DeprecatedBy** | Pointer to **SailPointTime** | | [optional] +**IsSimulationEnabled** | Pointer to **bool** | | [optional] +**OutputSchema** | Pointer to **map[string]interface{}** | Example output schema | [optional] +**Name** | Pointer to **string** | Trigger Name | [optional] +**Description** | Pointer to **string** | Trigger Description | [optional] +**IsDynamicSchema** | Pointer to **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**InputExample** | Pointer to **map[string]interface{}** | Example trigger payload if applicable | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the trigger accepts | [optional] + +## Methods + +### NewWorkflowLibraryTrigger + +`func NewWorkflowLibraryTrigger() *WorkflowLibraryTrigger` + +NewWorkflowLibraryTrigger instantiates a new WorkflowLibraryTrigger 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 + +### NewWorkflowLibraryTriggerWithDefaults + +`func NewWorkflowLibraryTriggerWithDefaults() *WorkflowLibraryTrigger` + +NewWorkflowLibraryTriggerWithDefaults instantiates a new WorkflowLibraryTrigger 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 + +### GetId + +`func (o *WorkflowLibraryTrigger) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowLibraryTrigger) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowLibraryTrigger) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowLibraryTrigger) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *WorkflowLibraryTrigger) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowLibraryTrigger) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowLibraryTrigger) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowLibraryTrigger) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDeprecated + +`func (o *WorkflowLibraryTrigger) GetDeprecated() bool` + +GetDeprecated returns the Deprecated field if non-nil, zero value otherwise. + +### GetDeprecatedOk + +`func (o *WorkflowLibraryTrigger) GetDeprecatedOk() (*bool, bool)` + +GetDeprecatedOk returns a tuple with the Deprecated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecated + +`func (o *WorkflowLibraryTrigger) SetDeprecated(v bool)` + +SetDeprecated sets Deprecated field to given value. + +### HasDeprecated + +`func (o *WorkflowLibraryTrigger) HasDeprecated() bool` + +HasDeprecated returns a boolean if a field has been set. + +### GetDeprecatedBy + +`func (o *WorkflowLibraryTrigger) GetDeprecatedBy() SailPointTime` + +GetDeprecatedBy returns the DeprecatedBy field if non-nil, zero value otherwise. + +### GetDeprecatedByOk + +`func (o *WorkflowLibraryTrigger) GetDeprecatedByOk() (*SailPointTime, bool)` + +GetDeprecatedByOk returns a tuple with the DeprecatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecatedBy + +`func (o *WorkflowLibraryTrigger) SetDeprecatedBy(v SailPointTime)` + +SetDeprecatedBy sets DeprecatedBy field to given value. + +### HasDeprecatedBy + +`func (o *WorkflowLibraryTrigger) HasDeprecatedBy() bool` + +HasDeprecatedBy returns a boolean if a field has been set. + +### GetIsSimulationEnabled + +`func (o *WorkflowLibraryTrigger) GetIsSimulationEnabled() bool` + +GetIsSimulationEnabled returns the IsSimulationEnabled field if non-nil, zero value otherwise. + +### GetIsSimulationEnabledOk + +`func (o *WorkflowLibraryTrigger) GetIsSimulationEnabledOk() (*bool, bool)` + +GetIsSimulationEnabledOk returns a tuple with the IsSimulationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSimulationEnabled + +`func (o *WorkflowLibraryTrigger) SetIsSimulationEnabled(v bool)` + +SetIsSimulationEnabled sets IsSimulationEnabled field to given value. + +### HasIsSimulationEnabled + +`func (o *WorkflowLibraryTrigger) HasIsSimulationEnabled() bool` + +HasIsSimulationEnabled returns a boolean if a field has been set. + +### GetOutputSchema + +`func (o *WorkflowLibraryTrigger) GetOutputSchema() map[string]interface{}` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *WorkflowLibraryTrigger) GetOutputSchemaOk() (*map[string]interface{}, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *WorkflowLibraryTrigger) SetOutputSchema(v map[string]interface{})` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *WorkflowLibraryTrigger) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowLibraryTrigger) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowLibraryTrigger) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowLibraryTrigger) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowLibraryTrigger) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkflowLibraryTrigger) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowLibraryTrigger) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowLibraryTrigger) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowLibraryTrigger) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIsDynamicSchema + +`func (o *WorkflowLibraryTrigger) GetIsDynamicSchema() bool` + +GetIsDynamicSchema returns the IsDynamicSchema field if non-nil, zero value otherwise. + +### GetIsDynamicSchemaOk + +`func (o *WorkflowLibraryTrigger) GetIsDynamicSchemaOk() (*bool, bool)` + +GetIsDynamicSchemaOk returns a tuple with the IsDynamicSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDynamicSchema + +`func (o *WorkflowLibraryTrigger) SetIsDynamicSchema(v bool)` + +SetIsDynamicSchema sets IsDynamicSchema field to given value. + +### HasIsDynamicSchema + +`func (o *WorkflowLibraryTrigger) HasIsDynamicSchema() bool` + +HasIsDynamicSchema returns a boolean if a field has been set. + +### GetInputExample + +`func (o *WorkflowLibraryTrigger) GetInputExample() map[string]interface{}` + +GetInputExample returns the InputExample field if non-nil, zero value otherwise. + +### GetInputExampleOk + +`func (o *WorkflowLibraryTrigger) GetInputExampleOk() (*map[string]interface{}, bool)` + +GetInputExampleOk returns a tuple with the InputExample field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInputExample + +`func (o *WorkflowLibraryTrigger) SetInputExample(v map[string]interface{})` + +SetInputExample sets InputExample field to given value. + +### HasInputExample + +`func (o *WorkflowLibraryTrigger) HasInputExample() bool` + +HasInputExample returns a boolean if a field has been set. + +### SetInputExampleNil + +`func (o *WorkflowLibraryTrigger) SetInputExampleNil(b bool)` + + SetInputExampleNil sets the value for InputExample to be an explicit nil + +### UnsetInputExample +`func (o *WorkflowLibraryTrigger) UnsetInputExample()` + +UnsetInputExample ensures that no value is present for InputExample, not even an explicit nil +### GetFormFields + +`func (o *WorkflowLibraryTrigger) GetFormFields() []WorkflowLibraryFormFields` + +GetFormFields returns the FormFields field if non-nil, zero value otherwise. + +### GetFormFieldsOk + +`func (o *WorkflowLibraryTrigger) GetFormFieldsOk() (*[]WorkflowLibraryFormFields, bool)` + +GetFormFieldsOk returns a tuple with the FormFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormFields + +`func (o *WorkflowLibraryTrigger) SetFormFields(v []WorkflowLibraryFormFields)` + +SetFormFields sets FormFields field to given value. + +### HasFormFields + +`func (o *WorkflowLibraryTrigger) HasFormFields() bool` + +HasFormFields returns a boolean if a field has been set. + +### SetFormFieldsNil + +`func (o *WorkflowLibraryTrigger) SetFormFieldsNil(b bool)` + + SetFormFieldsNil sets the value for FormFields to be an explicit nil + +### UnsetFormFields +`func (o *WorkflowLibraryTrigger) UnsetFormFields()` + +UnsetFormFields ensures that no value is present for FormFields, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkflowModifiedBy.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowModifiedBy.md new file mode 100644 index 000000000..aed7d2bcc --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowModifiedBy.md @@ -0,0 +1,116 @@ +--- +id: beta-workflow-modified-by +title: WorkflowModifiedBy +pagination_label: WorkflowModifiedBy +sidebar_label: WorkflowModifiedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowModifiedBy', 'BetaWorkflowModifiedBy'] +slug: /tools/sdk/go/beta/models/workflow-modified-by +tags: ['SDK', 'Software Development Kit', 'WorkflowModifiedBy', 'BetaWorkflowModifiedBy'] +--- + +# WorkflowModifiedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | | [optional] +**Id** | Pointer to **string** | Identity ID | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity. | [optional] + +## Methods + +### NewWorkflowModifiedBy + +`func NewWorkflowModifiedBy() *WorkflowModifiedBy` + +NewWorkflowModifiedBy instantiates a new WorkflowModifiedBy 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 + +### NewWorkflowModifiedByWithDefaults + +`func NewWorkflowModifiedByWithDefaults() *WorkflowModifiedBy` + +NewWorkflowModifiedByWithDefaults instantiates a new WorkflowModifiedBy 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 + +### GetType + +`func (o *WorkflowModifiedBy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowModifiedBy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowModifiedBy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowModifiedBy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkflowModifiedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowModifiedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowModifiedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowModifiedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowModifiedBy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowModifiedBy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowModifiedBy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowModifiedBy) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkflowOAuthClient.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowOAuthClient.md new file mode 100644 index 000000000..f4101ad60 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowOAuthClient.md @@ -0,0 +1,116 @@ +--- +id: beta-workflow-o-auth-client +title: WorkflowOAuthClient +pagination_label: WorkflowOAuthClient +sidebar_label: WorkflowOAuthClient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowOAuthClient', 'BetaWorkflowOAuthClient'] +slug: /tools/sdk/go/beta/models/workflow-o-auth-client +tags: ['SDK', 'Software Development Kit', 'WorkflowOAuthClient', 'BetaWorkflowOAuthClient'] +--- + +# WorkflowOAuthClient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | OAuth client ID for the trigger. This is a UUID generated upon creation. | [optional] +**Secret** | Pointer to **string** | OAuthClient secret. | [optional] +**Url** | Pointer to **string** | URL for the external trigger to invoke | [optional] + +## Methods + +### NewWorkflowOAuthClient + +`func NewWorkflowOAuthClient() *WorkflowOAuthClient` + +NewWorkflowOAuthClient instantiates a new WorkflowOAuthClient 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 + +### NewWorkflowOAuthClientWithDefaults + +`func NewWorkflowOAuthClientWithDefaults() *WorkflowOAuthClient` + +NewWorkflowOAuthClientWithDefaults instantiates a new WorkflowOAuthClient 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 + +### GetId + +`func (o *WorkflowOAuthClient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowOAuthClient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowOAuthClient) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowOAuthClient) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSecret + +`func (o *WorkflowOAuthClient) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *WorkflowOAuthClient) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *WorkflowOAuthClient) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *WorkflowOAuthClient) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### GetUrl + +`func (o *WorkflowOAuthClient) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *WorkflowOAuthClient) GetUrlOk() (*string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrl + +`func (o *WorkflowOAuthClient) SetUrl(v string)` + +SetUrl sets Url field to given value. + +### HasUrl + +`func (o *WorkflowOAuthClient) HasUrl() bool` + +HasUrl returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkflowTrigger.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowTrigger.md new file mode 100644 index 000000000..50a189c24 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkflowTrigger.md @@ -0,0 +1,126 @@ +--- +id: beta-workflow-trigger +title: WorkflowTrigger +pagination_label: WorkflowTrigger +sidebar_label: WorkflowTrigger +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowTrigger', 'BetaWorkflowTrigger'] +slug: /tools/sdk/go/beta/models/workflow-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowTrigger', 'BetaWorkflowTrigger'] +--- + +# WorkflowTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The trigger type | +**DisplayName** | Pointer to **NullableString** | | [optional] +**Attributes** | **map[string]interface{}** | Workflow Trigger Attributes. | + +## Methods + +### NewWorkflowTrigger + +`func NewWorkflowTrigger(type_ string, attributes map[string]interface{}, ) *WorkflowTrigger` + +NewWorkflowTrigger instantiates a new WorkflowTrigger 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 + +### NewWorkflowTriggerWithDefaults + +`func NewWorkflowTriggerWithDefaults() *WorkflowTrigger` + +NewWorkflowTriggerWithDefaults instantiates a new WorkflowTrigger 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 + +### GetType + +`func (o *WorkflowTrigger) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowTrigger) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowTrigger) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDisplayName + +`func (o *WorkflowTrigger) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *WorkflowTrigger) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *WorkflowTrigger) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *WorkflowTrigger) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### SetDisplayNameNil + +`func (o *WorkflowTrigger) SetDisplayNameNil(b bool)` + + SetDisplayNameNil sets the value for DisplayName to be an explicit nil + +### UnsetDisplayName +`func (o *WorkflowTrigger) UnsetDisplayName()` + +UnsetDisplayName ensures that no value is present for DisplayName, not even an explicit nil +### GetAttributes + +`func (o *WorkflowTrigger) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *WorkflowTrigger) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *WorkflowTrigger) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *WorkflowTrigger) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *WorkflowTrigger) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupBulkDeleteRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupBulkDeleteRequest.md new file mode 100644 index 000000000..34d8b730d --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupBulkDeleteRequest.md @@ -0,0 +1,64 @@ +--- +id: beta-workgroup-bulk-delete-request +title: WorkgroupBulkDeleteRequest +pagination_label: WorkgroupBulkDeleteRequest +sidebar_label: WorkgroupBulkDeleteRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupBulkDeleteRequest', 'BetaWorkgroupBulkDeleteRequest'] +slug: /tools/sdk/go/beta/models/workgroup-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'WorkgroupBulkDeleteRequest', 'BetaWorkgroupBulkDeleteRequest'] +--- + +# WorkgroupBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]string** | List of IDs of Governance Groups to be deleted. | [optional] + +## Methods + +### NewWorkgroupBulkDeleteRequest + +`func NewWorkgroupBulkDeleteRequest() *WorkgroupBulkDeleteRequest` + +NewWorkgroupBulkDeleteRequest instantiates a new WorkgroupBulkDeleteRequest 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 + +### NewWorkgroupBulkDeleteRequestWithDefaults + +`func NewWorkgroupBulkDeleteRequestWithDefaults() *WorkgroupBulkDeleteRequest` + +NewWorkgroupBulkDeleteRequestWithDefaults instantiates a new WorkgroupBulkDeleteRequest 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 + +### GetIds + +`func (o *WorkgroupBulkDeleteRequest) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *WorkgroupBulkDeleteRequest) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *WorkgroupBulkDeleteRequest) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *WorkgroupBulkDeleteRequest) HasIds() bool` + +HasIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupConnectionDto.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupConnectionDto.md new file mode 100644 index 000000000..f20536a23 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupConnectionDto.md @@ -0,0 +1,90 @@ +--- +id: beta-workgroup-connection-dto +title: WorkgroupConnectionDto +pagination_label: WorkgroupConnectionDto +sidebar_label: WorkgroupConnectionDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupConnectionDto', 'BetaWorkgroupConnectionDto'] +slug: /tools/sdk/go/beta/models/workgroup-connection-dto +tags: ['SDK', 'Software Development Kit', 'WorkgroupConnectionDto', 'BetaWorkgroupConnectionDto'] +--- + +# WorkgroupConnectionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Object** | Pointer to [**ConnectedObject**](connected-object) | | [optional] +**ConnectionType** | Pointer to **string** | Connection Type. | [optional] + +## Methods + +### NewWorkgroupConnectionDto + +`func NewWorkgroupConnectionDto() *WorkgroupConnectionDto` + +NewWorkgroupConnectionDto instantiates a new WorkgroupConnectionDto 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 + +### NewWorkgroupConnectionDtoWithDefaults + +`func NewWorkgroupConnectionDtoWithDefaults() *WorkgroupConnectionDto` + +NewWorkgroupConnectionDtoWithDefaults instantiates a new WorkgroupConnectionDto 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 + +### GetObject + +`func (o *WorkgroupConnectionDto) GetObject() ConnectedObject` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *WorkgroupConnectionDto) GetObjectOk() (*ConnectedObject, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *WorkgroupConnectionDto) SetObject(v ConnectedObject)` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *WorkgroupConnectionDto) HasObject() bool` + +HasObject returns a boolean if a field has been set. + +### GetConnectionType + +`func (o *WorkgroupConnectionDto) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *WorkgroupConnectionDto) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *WorkgroupConnectionDto) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *WorkgroupConnectionDto) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupDeleteItem.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupDeleteItem.md new file mode 100644 index 000000000..1b290a5dc --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupDeleteItem.md @@ -0,0 +1,106 @@ +--- +id: beta-workgroup-delete-item +title: WorkgroupDeleteItem +pagination_label: WorkgroupDeleteItem +sidebar_label: WorkgroupDeleteItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupDeleteItem', 'BetaWorkgroupDeleteItem'] +slug: /tools/sdk/go/beta/models/workgroup-delete-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupDeleteItem', 'BetaWorkgroupDeleteItem'] +--- + +# WorkgroupDeleteItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Id of the Governance Group. | +**Status** | **int32** | The HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation. > 204 - Governance Group deleted successfully. > 409 - Governance Group is in use,hence can not be deleted. > 404 - Governance Group not found. | +**Description** | Pointer to **string** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Methods + +### NewWorkgroupDeleteItem + +`func NewWorkgroupDeleteItem(id string, status int32, ) *WorkgroupDeleteItem` + +NewWorkgroupDeleteItem instantiates a new WorkgroupDeleteItem 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 + +### NewWorkgroupDeleteItemWithDefaults + +`func NewWorkgroupDeleteItemWithDefaults() *WorkgroupDeleteItem` + +NewWorkgroupDeleteItemWithDefaults instantiates a new WorkgroupDeleteItem 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 + +### GetId + +`func (o *WorkgroupDeleteItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupDeleteItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupDeleteItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetStatus + +`func (o *WorkgroupDeleteItem) GetStatus() int32` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *WorkgroupDeleteItem) GetStatusOk() (*int32, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *WorkgroupDeleteItem) SetStatus(v int32)` + +SetStatus sets Status field to given value. + + +### GetDescription + +`func (o *WorkgroupDeleteItem) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkgroupDeleteItem) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkgroupDeleteItem) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkgroupDeleteItem) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupDto.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupDto.md new file mode 100644 index 000000000..4853a8183 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupDto.md @@ -0,0 +1,246 @@ +--- +id: beta-workgroup-dto +title: WorkgroupDto +pagination_label: WorkgroupDto +sidebar_label: WorkgroupDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupDto', 'BetaWorkgroupDto'] +slug: /tools/sdk/go/beta/models/workgroup-dto +tags: ['SDK', 'Software Development Kit', 'WorkgroupDto', 'BetaWorkgroupDto'] +--- + +# WorkgroupDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Owner** | Pointer to [**WorkgroupDtoOwner**](workgroup-dto-owner) | | [optional] +**Id** | Pointer to **string** | Governance group ID. | [optional] [readonly] +**Name** | Pointer to **string** | Governance group name. | [optional] +**Description** | Pointer to **string** | Governance group description. | [optional] +**MemberCount** | Pointer to **int64** | Number of members in the governance group. | [optional] [readonly] +**ConnectionCount** | Pointer to **int64** | Number of connections in the governance group. | [optional] [readonly] +**Created** | Pointer to **SailPointTime** | | [optional] +**Modified** | Pointer to **SailPointTime** | | [optional] + +## Methods + +### NewWorkgroupDto + +`func NewWorkgroupDto() *WorkgroupDto` + +NewWorkgroupDto instantiates a new WorkgroupDto 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 + +### NewWorkgroupDtoWithDefaults + +`func NewWorkgroupDtoWithDefaults() *WorkgroupDto` + +NewWorkgroupDtoWithDefaults instantiates a new WorkgroupDto 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 + +### GetOwner + +`func (o *WorkgroupDto) GetOwner() WorkgroupDtoOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *WorkgroupDto) GetOwnerOk() (*WorkgroupDtoOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *WorkgroupDto) SetOwner(v WorkgroupDtoOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *WorkgroupDto) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetId + +`func (o *WorkgroupDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkgroupDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkgroupDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkgroupDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkgroupDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkgroupDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkgroupDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkgroupDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkgroupDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkgroupDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetMemberCount + +`func (o *WorkgroupDto) GetMemberCount() int64` + +GetMemberCount returns the MemberCount field if non-nil, zero value otherwise. + +### GetMemberCountOk + +`func (o *WorkgroupDto) GetMemberCountOk() (*int64, bool)` + +GetMemberCountOk returns a tuple with the MemberCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMemberCount + +`func (o *WorkgroupDto) SetMemberCount(v int64)` + +SetMemberCount sets MemberCount field to given value. + +### HasMemberCount + +`func (o *WorkgroupDto) HasMemberCount() bool` + +HasMemberCount returns a boolean if a field has been set. + +### GetConnectionCount + +`func (o *WorkgroupDto) GetConnectionCount() int64` + +GetConnectionCount returns the ConnectionCount field if non-nil, zero value otherwise. + +### GetConnectionCountOk + +`func (o *WorkgroupDto) GetConnectionCountOk() (*int64, bool)` + +GetConnectionCountOk returns a tuple with the ConnectionCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionCount + +`func (o *WorkgroupDto) SetConnectionCount(v int64)` + +SetConnectionCount sets ConnectionCount field to given value. + +### HasConnectionCount + +`func (o *WorkgroupDto) HasConnectionCount() bool` + +HasConnectionCount returns a boolean if a field has been set. + +### GetCreated + +`func (o *WorkgroupDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *WorkgroupDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *WorkgroupDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *WorkgroupDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *WorkgroupDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *WorkgroupDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *WorkgroupDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *WorkgroupDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupDtoOwner.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupDtoOwner.md new file mode 100644 index 000000000..e870bdea7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupDtoOwner.md @@ -0,0 +1,168 @@ +--- +id: beta-workgroup-dto-owner +title: WorkgroupDtoOwner +pagination_label: WorkgroupDtoOwner +sidebar_label: WorkgroupDtoOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupDtoOwner', 'BetaWorkgroupDtoOwner'] +slug: /tools/sdk/go/beta/models/workgroup-dto-owner +tags: ['SDK', 'Software Development Kit', 'WorkgroupDtoOwner', 'BetaWorkgroupDtoOwner'] +--- + +# WorkgroupDtoOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's DTO type. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] +**DisplayName** | Pointer to **string** | The display name of the identity | [optional] [readonly] +**EmailAddress** | Pointer to **string** | The primary email address of the identity | [optional] [readonly] + +## Methods + +### NewWorkgroupDtoOwner + +`func NewWorkgroupDtoOwner() *WorkgroupDtoOwner` + +NewWorkgroupDtoOwner instantiates a new WorkgroupDtoOwner 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 + +### NewWorkgroupDtoOwnerWithDefaults + +`func NewWorkgroupDtoOwnerWithDefaults() *WorkgroupDtoOwner` + +NewWorkgroupDtoOwnerWithDefaults instantiates a new WorkgroupDtoOwner 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 + +### GetType + +`func (o *WorkgroupDtoOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkgroupDtoOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkgroupDtoOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkgroupDtoOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkgroupDtoOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupDtoOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupDtoOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkgroupDtoOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkgroupDtoOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkgroupDtoOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkgroupDtoOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkgroupDtoOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *WorkgroupDtoOwner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *WorkgroupDtoOwner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *WorkgroupDtoOwner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *WorkgroupDtoOwner) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetEmailAddress + +`func (o *WorkgroupDtoOwner) GetEmailAddress() string` + +GetEmailAddress returns the EmailAddress field if non-nil, zero value otherwise. + +### GetEmailAddressOk + +`func (o *WorkgroupDtoOwner) GetEmailAddressOk() (*string, bool)` + +GetEmailAddressOk returns a tuple with the EmailAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailAddress + +`func (o *WorkgroupDtoOwner) SetEmailAddress(v string)` + +SetEmailAddress sets EmailAddress field to given value. + +### HasEmailAddress + +`func (o *WorkgroupDtoOwner) HasEmailAddress() bool` + +HasEmailAddress returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupMemberAddItem.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupMemberAddItem.md new file mode 100644 index 000000000..f16bc51dc --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupMemberAddItem.md @@ -0,0 +1,106 @@ +--- +id: beta-workgroup-member-add-item +title: WorkgroupMemberAddItem +pagination_label: WorkgroupMemberAddItem +sidebar_label: WorkgroupMemberAddItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupMemberAddItem', 'BetaWorkgroupMemberAddItem'] +slug: /tools/sdk/go/beta/models/workgroup-member-add-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupMemberAddItem', 'BetaWorkgroupMemberAddItem'] +--- + +# WorkgroupMemberAddItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Identifier of identity in bulk member add request. | +**Status** | **int32** | The HTTP response status code returned for an individual member that is requested for addition during a bulk add operation. The HTTP response status code returned for an individual Governance Group is requested for deletion. > 201 - Identity is added into Governance Group members list. > 409 - Identity is already member of Governance Group. | +**Description** | Pointer to **string** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Methods + +### NewWorkgroupMemberAddItem + +`func NewWorkgroupMemberAddItem(id string, status int32, ) *WorkgroupMemberAddItem` + +NewWorkgroupMemberAddItem instantiates a new WorkgroupMemberAddItem 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 + +### NewWorkgroupMemberAddItemWithDefaults + +`func NewWorkgroupMemberAddItemWithDefaults() *WorkgroupMemberAddItem` + +NewWorkgroupMemberAddItemWithDefaults instantiates a new WorkgroupMemberAddItem 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 + +### GetId + +`func (o *WorkgroupMemberAddItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupMemberAddItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupMemberAddItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetStatus + +`func (o *WorkgroupMemberAddItem) GetStatus() int32` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *WorkgroupMemberAddItem) GetStatusOk() (*int32, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *WorkgroupMemberAddItem) SetStatus(v int32)` + +SetStatus sets Status field to given value. + + +### GetDescription + +`func (o *WorkgroupMemberAddItem) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkgroupMemberAddItem) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkgroupMemberAddItem) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkgroupMemberAddItem) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupMemberDeleteItem.md b/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupMemberDeleteItem.md new file mode 100644 index 000000000..967531d2b --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/WorkgroupMemberDeleteItem.md @@ -0,0 +1,106 @@ +--- +id: beta-workgroup-member-delete-item +title: WorkgroupMemberDeleteItem +pagination_label: WorkgroupMemberDeleteItem +sidebar_label: WorkgroupMemberDeleteItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupMemberDeleteItem', 'BetaWorkgroupMemberDeleteItem'] +slug: /tools/sdk/go/beta/models/workgroup-member-delete-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupMemberDeleteItem', 'BetaWorkgroupMemberDeleteItem'] +--- + +# WorkgroupMemberDeleteItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Identifier of identity in bulk member add /remove request. | +**Status** | **int32** | The HTTP response status code returned for an individual member that is requested for deletion during a bulk delete operation. > 204 - Identity is removed from Governance Group members list. > 404 - Identity is not member of Governance Group. | +**Description** | Pointer to **string** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Methods + +### NewWorkgroupMemberDeleteItem + +`func NewWorkgroupMemberDeleteItem(id string, status int32, ) *WorkgroupMemberDeleteItem` + +NewWorkgroupMemberDeleteItem instantiates a new WorkgroupMemberDeleteItem 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 + +### NewWorkgroupMemberDeleteItemWithDefaults + +`func NewWorkgroupMemberDeleteItemWithDefaults() *WorkgroupMemberDeleteItem` + +NewWorkgroupMemberDeleteItemWithDefaults instantiates a new WorkgroupMemberDeleteItem 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 + +### GetId + +`func (o *WorkgroupMemberDeleteItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupMemberDeleteItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupMemberDeleteItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetStatus + +`func (o *WorkgroupMemberDeleteItem) GetStatus() int32` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *WorkgroupMemberDeleteItem) GetStatusOk() (*int32, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *WorkgroupMemberDeleteItem) SetStatus(v int32)` + +SetStatus sets Status field to given value. + + +### GetDescription + +`func (o *WorkgroupMemberDeleteItem) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkgroupMemberDeleteItem) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkgroupMemberDeleteItem) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkgroupMemberDeleteItem) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Index.md b/docs/tools/sdk/go/Reference/V2024/Index.md new file mode 100644 index 000000000..42981eafb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Index.md @@ -0,0 +1,22 @@ +--- +id: v2024 +title: V2024 +pagination_label: V2024 +sidebar_label: V2024 +sidebar_position: 2 +sidebar_class_name: v2024 +keywords: ['v2024', 'Golang'] +description: Golang SDK reference V2024. +slug: /tools/go/reference/v2024 +tags: ['v2024'] +--- + +Welcome to the Golang SDK documentation for the Identity Security Cloud (ISC) V2024 API. This reference guide provides an overview of both methods and models, which will help you understand how to interact with the API effectively. + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AccessModelMetadataAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AccessModelMetadataAPI.md new file mode 100644 index 000000000..2d4be1579 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AccessModelMetadataAPI.md @@ -0,0 +1,348 @@ +--- +id: v2024-access-model-metadata +title: AccessModelMetadata +pagination_label: AccessModelMetadata +sidebar_label: AccessModelMetadata +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessModelMetadata', 'V2024AccessModelMetadata'] +slug: /tools/sdk/go/v2024/methods/access-model-metadata +tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'V2024AccessModelMetadata'] +--- + +# AccessModelMetadataAPI + Use this API to create and manage metadata attributes for your Access Model. +Access Model Metadata allows you to add contextual information to your ISC Access Model items using pre-defined metadata for risk, regulations, privacy levels, etc., or by creating your own metadata attributes to reflect the unique needs of your organization. This release of the API includes support for entitlement metadata. Support for role and access profile metadata will be introduced in a subsequent release. + +Common usages for Access Model metadata include: + +- Organizing and categorizing access items to make it easier for your users to search for and find the access rights they want to request, certify, or manage. + +- Providing richer information about access that is being acted on to allow stakeholders to make better decisions when approving, certifying, or managing access rights. + +- Identifying access that may requires additional approval requirements or be subject to more frequent review. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-access-model-metadata-attribute**](#get-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes/{key}` | Get Access Model Metadata Attribute +[**get-access-model-metadata-attribute-value**](#get-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values/{value}` | Get Access Model Metadata Value +[**list-access-model-metadata-attribute**](#list-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes` | List Access Model Metadata Attributes +[**list-access-model-metadata-attribute-value**](#list-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values + + +## get-access-model-metadata-attribute +:::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 Access Model Metadata Attribute +Get single Access Model Metadata Attribute + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-model-metadata-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**key** | **string** | Technical name of the Attribute. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessModelMetadataAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**AttributeDTO**](../models/attribute-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + 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.AccessModelMetadataAPI.GetAccessModelMetadataAttribute(context.Background(), key).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AccessModelMetadataAPI.GetAccessModelMetadataAttribute(context.Background(), key).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.GetAccessModelMetadataAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessModelMetadataAttribute`: AttributeDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.GetAccessModelMetadataAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-model-metadata-attribute-value +:::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 Access Model Metadata Value +Get single Access Model Metadata Attribute Value + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-model-metadata-attribute-value) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**key** | **string** | Technical name of the Attribute. | +**value** | **string** | Technical name of the Attribute value. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessModelMetadataAttributeValueRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**AttributeValueDTO**](../models/attribute-value-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + value := `public` // string | Technical name of the Attribute value. # string | Technical name of the Attribute value. + 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.AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue(context.Background(), key, value).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue(context.Background(), key, value).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessModelMetadataAttributeValue`: AttributeValueDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-model-metadata-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 + ``` +::: +List Access Model Metadata Attributes +Get a list of Access Model Metadata Attributes + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-model-metadata-attribute) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessModelMetadataAttributeRequest struct via the builder pattern + + +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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* | + +### Return type + +[**[]AttributeDTO**](../models/attribute-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 := `name eq "Privacy"` // 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessModelMetadataAPI.ListAccessModelMetadataAttribute(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AccessModelMetadataAPI.ListAccessModelMetadataAttribute(context.Background()).XSailPointExperimental(xSailPointExperimental).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.ListAccessModelMetadataAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessModelMetadataAttribute`: []AttributeDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.ListAccessModelMetadataAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-model-metadata-attribute-value +:::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 Access Model Metadata Values +Get a list of Access Model Metadata Attribute Values + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-model-metadata-attribute-value) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**key** | **string** | Technical name of the Attribute. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessModelMetadataAttributeValueRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**[]AttributeValueDTO**](../models/attribute-value-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + 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.AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue(context.Background(), key).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue(context.Background(), key).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessModelMetadataAttributeValue`: []AttributeValueDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AccessProfilesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AccessProfilesAPI.md new file mode 100644 index 000000000..49e036734 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AccessProfilesAPI.md @@ -0,0 +1,771 @@ +--- +id: v2024-access-profiles +title: AccessProfiles +pagination_label: AccessProfiles +sidebar_label: AccessProfiles +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfiles', 'V2024AccessProfiles'] +slug: /tools/sdk/go/v2024/methods/access-profiles +tags: ['SDK', 'Software Development Kit', 'AccessProfiles', 'V2024AccessProfiles'] +--- + +# AccessProfilesAPI + Use this API to implement and customize access profile functionality. +With this functionality in place, administrators can create access profiles and configure them for use throughout Identity Security Cloud, enabling users to get the access they need quickly and securely. + +Access profiles group entitlements, which represent access rights on sources. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +Identity Security Cloud uses access profiles in many features, including the following: + +- Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles. + +- Certifications: You can approve or revoke access profiles in certification campaigns, just like entitlements. + +- Access Requests: You can assign access profiles to applications, and when a user requests access to the app associated with an access profile and someone approves the request, access is granted to both the application and its associated access profile. + +- Roles: You can group one or more access profiles into a role to quickly assign access items based on an identity's role. + +In Identity Security Cloud, administrators can use the Access drop-down menu and select Access Profiles to view, configure, and delete existing access profiles, as well as create new ones. +Administrators can enable and disable an access profile, and they can also make the following configurations: + +- Manage Entitlements: Manage the profile's access by adding and removing entitlements. + +- Access Requests: Configure access profiles to be requestable and establish an approval process for any requests that the access profile be granted or revoked. +Do not configure an access profile to be requestable without first establishing a secure access request approval process for the access profile. + +- Multiple Account Options: Define the logic Identity Security Cloud uses to provision access to an identity with multiple accounts on the source. + +Refer to [Managing Access Profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) for more information about access profiles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-access-profile**](#create-access-profile) | **Post** `/access-profiles` | Create Access Profile +[**delete-access-profile**](#delete-access-profile) | **Delete** `/access-profiles/{id}` | Delete the specified Access Profile +[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-delete` | Delete Access Profile(s) +[**get-access-profile**](#get-access-profile) | **Get** `/access-profiles/{id}` | Get an Access Profile +[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **Get** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements +[**list-access-profiles**](#list-access-profiles) | **Get** `/access-profiles` | List Access Profiles +[**patch-access-profile**](#patch-access-profile) | **Patch** `/access-profiles/{id}` | Patch a specified Access Profile +[**update-access-profiles-in-bulk**](#update-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field. + + +## create-access-profile +Create Access Profile +Create an access profile. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-profile) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAccessProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessProfile** | [**AccessProfile**](../models/access-profile) | | + +### Return type + +[**AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accessprofile := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + }`) // AccessProfile | + + + var accessProfile v2024.AccessProfile + if err := json.Unmarshal(accessprofile, &accessProfile); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessProfilesAPI.CreateAccessProfile(context.Background()).AccessProfile(accessProfile).Execute() + //resp, r, err := apiClient.V2024.AccessProfilesAPI.CreateAccessProfile(context.Background()).AccessProfile(accessProfile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.CreateAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.CreateAccessProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-access-profile +Delete the specified Access Profile +This API deletes an existing Access Profile. + +The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. + +A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-access-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Access Profile to delete | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccessProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Access Profile to delete # string | ID of the Access Profile to delete + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.AccessProfilesAPI.DeleteAccessProfile(context.Background(), id).Execute() + //r, err := apiClient.V2024.AccessProfilesAPI.DeleteAccessProfile(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.DeleteAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-access-profiles-in-bulk +Delete Access Profile(s) +This endpoint initiates a bulk deletion of one or more access profiles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 access profiles per request. +By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. +A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they're able to administer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-access-profiles-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccessProfilesInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessProfileBulkDeleteRequest** | [**AccessProfileBulkDeleteRequest**](../models/access-profile-bulk-delete-request) | | + +### Return type + +[**AccessProfileBulkDeleteResponse**](../models/access-profile-bulk-delete-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accessprofilebulkdeleterequest := []byte(`{ + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + }`) // AccessProfileBulkDeleteRequest | + + + var accessProfileBulkDeleteRequest v2024.AccessProfileBulkDeleteRequest + if err := json.Unmarshal(accessprofilebulkdeleterequest, &accessProfileBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessProfilesAPI.DeleteAccessProfilesInBulk(context.Background()).AccessProfileBulkDeleteRequest(accessProfileBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V2024.AccessProfilesAPI.DeleteAccessProfilesInBulk(context.Background()).AccessProfileBulkDeleteRequest(accessProfileBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.DeleteAccessProfilesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccessProfilesInBulk`: AccessProfileBulkDeleteResponse + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.DeleteAccessProfilesInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-profile +Get an Access Profile +This API returns an Access Profile by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Access Profile | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Access Profile # string | ID of the Access Profile + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessProfilesAPI.GetAccessProfile(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.AccessProfilesAPI.GetAccessProfile(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.GetAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.GetAccessProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-profile-entitlements +List Access Profile's Entitlements +Use this API to get a list of an access profile's entitlements. +A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-profile-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the access profile containing the entitlements. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessProfileEntitlementsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. | + **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, attribute, value, created, modified** | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the access profile containing the entitlements. # string | ID of the access profile containing the entitlements. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessProfilesAPI.GetAccessProfileEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.AccessProfilesAPI.GetAccessProfileEntitlements(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.GetAccessProfileEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessProfileEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.GetAccessProfileEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-profiles +List Access Profiles +Get a list of access profiles. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessProfilesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **forSubadmin** | **string** | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. | + **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, created, modified** | + **forSegmentIds** | **string** | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. | + **includeUnsegmented** | **bool** | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. | [default to true] + +### Return type + +[**[]AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + forSubadmin := `8c190e6787aa4ed9a90bd9d5344523fb` // string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) # string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "SailPoint Support"` // 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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessProfilesAPI.ListAccessProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccessProfilesAPI.ListAccessProfiles(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.ListAccessProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessProfiles`: []AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.ListAccessProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-access-profile +Patch a specified Access Profile +This API updates an existing Access Profile. The following fields are patchable: + +**name** + +**description** + +**enabled** + +**owner** + +**requestable** + +**accessRequestConfig** + +**revokeRequestConfig** + +**segments** + +**entitlements** + +**provisioningCriteria** + +**source** (must be updated with entitlements belonging to new source in the same API call) + +If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example "Replace Source" in the examples dropdown. + +A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. +> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-access-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Access Profile to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAccessProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Access Profile to patch # string | ID of the Access Profile to patch + jsonpatchoperation := []byte(`[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessProfilesAPI.PatchAccessProfile(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.AccessProfilesAPI.PatchAccessProfile(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.PatchAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.PatchAccessProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-access-profiles-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 + ``` +::: +Update Access Profile(s) requestable field. +This API initiates a bulk update of field requestable for one or more Access Profiles. + +> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** + list of the response.Requestable field of these Access Profiles marked as **true** or **false**. + +> If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. + A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-access-profiles-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateAccessProfilesInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **accessProfileBulkUpdateRequestInner** | [**[]AccessProfileBulkUpdateRequestInner**](../models/access-profile-bulk-update-request-inner) | | + +### Return type + +[**[]AccessProfileUpdateItem**](../models/access-profile-update-item) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + accessprofilebulkupdaterequestinner := []byte(`[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]`) // []AccessProfileBulkUpdateRequestInner | + + + var accessProfileBulkUpdateRequestInner v2024.[]AccessProfileBulkUpdateRequestInner + if err := json.Unmarshal(accessprofilebulkupdaterequestinner, &accessProfileBulkUpdateRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessProfilesAPI.UpdateAccessProfilesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessProfileBulkUpdateRequestInner(accessProfileBulkUpdateRequestInner).Execute() + //resp, r, err := apiClient.V2024.AccessProfilesAPI.UpdateAccessProfilesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessProfileBulkUpdateRequestInner(accessProfileBulkUpdateRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.UpdateAccessProfilesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAccessProfilesInBulk`: []AccessProfileUpdateItem + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.UpdateAccessProfilesInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestApprovalsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestApprovalsAPI.md new file mode 100644 index 000000000..369a68440 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestApprovalsAPI.md @@ -0,0 +1,559 @@ +--- +id: v2024-access-request-approvals +title: AccessRequestApprovals +pagination_label: AccessRequestApprovals +sidebar_label: AccessRequestApprovals +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestApprovals', 'V2024AccessRequestApprovals'] +slug: /tools/sdk/go/v2024/methods/access-request-approvals +tags: ['SDK', 'Software Development Kit', 'AccessRequestApprovals', 'V2024AccessRequestApprovals'] +--- + +# AccessRequestApprovalsAPI + Use this API to implement and customize access request approval functionality. +With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. +This enables more qualified users to review access requests and the others to spend their time on other tasks. + +In Identity Security Cloud, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. +For applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. +For roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. +If the administrator designates a governance group as the required approver, any governance group member can approve the requests. + +When a user submits an access request, Identity Security Cloud sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration. + +In Approvals in Identity Security Cloud, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. +If the required approver approves the request and is the only reviewer required, Identity Security Cloud grants or revokes access, based on the request. +If multiple reviewers are required, Identity Security Cloud sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. +The required approver can then view any completed access requests under the Reviewed tab. + +Refer to [Access Requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for more information about access request approvals. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-access-request**](#approve-access-request) | **Post** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval +[**forward-access-request**](#forward-access-request) | **Post** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval +[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **Get** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number +[**list-access-request-approvers**](#list-access-request-approvers) | **Get** `/access-request-approvals/{accessRequestId}/approvers` | Access Request Approvers +[**list-completed-approvals**](#list-completed-approvals) | **Get** `/access-request-approvals/completed` | Completed Access Request Approvals List +[**list-pending-approvals**](#list-pending-approvals) | **Get** `/access-request-approvals/pending` | Pending Access Request Approvals List +[**reject-access-request**](#reject-access-request) | **Post** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval + + +## approve-access-request +Approve Access Request Approval +Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-access-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**approvalId** | **string** | Approval ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiApproveAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **commentDto** | [**CommentDto**](../models/comment-dto) | Reviewer's comment. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + commentdto := []byte(`{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + }`) // CommentDto | Reviewer's comment. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ApproveAccessRequest(context.Background(), approvalId).Execute() + //resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ApproveAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ApproveAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ApproveAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## forward-access-request +Forward Access Request Approval +Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/forward-access-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**approvalId** | **string** | Approval ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiForwardAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **forwardApprovalDto** | [**ForwardApprovalDto**](../models/forward-approval-dto) | Information about the forwarded approval. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + forwardapprovaldto := []byte(`{ + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" + }`) // ForwardApprovalDto | Information about the forwarded approval. + + + var forwardApprovalDto v2024.ForwardApprovalDto + if err := json.Unmarshal(forwardapprovaldto, &forwardApprovalDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ForwardAccessRequest(context.Background(), approvalId).ForwardApprovalDto(forwardApprovalDto).Execute() + //resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ForwardAccessRequest(context.Background(), approvalId).ForwardApprovalDto(forwardApprovalDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ForwardAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ForwardAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ForwardAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-approval-summary +Get Access Requests Approvals Number +Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-approval-summary) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestApprovalSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. | + **fromDate** | **string** | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. | + +### Return type + +[**ApprovalSummary**](../models/approval-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + fromDate := `from-date=2020-03-19T19:59:11Z` // string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) # string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary(context.Background()).OwnerId(ownerId).FromDate(fromDate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestApprovalSummary`: ApprovalSummary + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-request-approvers +Access Request Approvers +This API endpoint returns the list of approvers for the given access request id. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-request-approvers) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**accessRequestId** | **string** | Access Request ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessRequestApproversRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int32** | Max number of results to return. | [default to 250] + **offset** | **int32** | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. | + **count** | **bool** | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. | [default to false] + +### Return type + +[**[]AccessRequestApproversListResponse**](../models/access-request-approvers-list-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accessRequestId := `2c91808568c529c60168cca6f90c1313` // string | Access Request ID. # string | Access Request ID. + limit := 100 // int32 | Max number of results to return. (optional) (default to 250) # int32 | Max number of results to return. (optional) (default to 250) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + count := false // bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ListAccessRequestApprovers(context.Background(), accessRequestId).Execute() + //resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ListAccessRequestApprovers(context.Background(), accessRequestId).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListAccessRequestApprovers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessRequestApprovers`: []AccessRequestApproversListResponse + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListAccessRequestApprovers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-completed-approvals +Completed Access Request Approvals List +This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-completed-approvals) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCompletedApprovalsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* | + **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: **created, modified** | + +### Return type + +[**[]CompletedApproval**](../models/completed-approval) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "2c91808568c529c60168cca6f90c1313"` // 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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + sorters := `modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ListCompletedApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ListCompletedApprovals(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListCompletedApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCompletedApprovals`: []CompletedApproval + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListCompletedApprovals`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-pending-approvals +Pending Access Request Approvals List +This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-pending-approvals) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPendingApprovalsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* | + **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: **created, modified** | + +### Return type + +[**[]PendingApproval**](../models/pending-approval) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "2c91808568c529c60168cca6f90c1313"` // 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) + sorters := `modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ListPendingApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ListPendingApprovals(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListPendingApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPendingApprovals`: []PendingApproval + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListPendingApprovals`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reject-access-request +Reject Access Request Approval +Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reject-access-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**approvalId** | **string** | Approval ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRejectAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **commentDto** | [**CommentDto**](../models/comment-dto) | Reviewer's comment. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + commentdto := []byte(`{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + }`) // CommentDto | Reviewer's comment. + + + var commentDto v2024.CommentDto + if err := json.Unmarshal(commentdto, &commentDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.RejectAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + //resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.RejectAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.RejectAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.RejectAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestIdentityMetricsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestIdentityMetricsAPI.md new file mode 100644 index 000000000..39799099c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestIdentityMetricsAPI.md @@ -0,0 +1,96 @@ +--- +id: v2024-access-request-identity-metrics +title: AccessRequestIdentityMetrics +pagination_label: AccessRequestIdentityMetrics +sidebar_label: AccessRequestIdentityMetrics +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestIdentityMetrics', 'V2024AccessRequestIdentityMetrics'] +slug: /tools/sdk/go/v2024/methods/access-request-identity-metrics +tags: ['SDK', 'Software Development Kit', 'AccessRequestIdentityMetrics', 'V2024AccessRequestIdentityMetrics'] +--- + +# AccessRequestIdentityMetricsAPI + Use this API to implement access request identity metrics functionality. +With this functionality in place, access request reviewers can see relevant details about the requested access item and associated source activity. +This allows reviewers to see how many of the identities who share a manager with the access requester have this same type of access and how many of them have had activity in the related source. +This additional context about whether the access has been granted before and how often it has been used can help those approving access requests make more informed decisions. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-access-request-identity-metrics**](#get-access-request-identity-metrics) | **Get** `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` | Return access request identity metrics + + +## get-access-request-identity-metrics +Return access request identity metrics +Use this API to return information access metrics. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-identity-metrics) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | Manager's identity ID. | +**requestedObjectId** | **string** | Requested access item's ID. | +**type_** | **string** | Requested access item's type. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestIdentityMetricsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `7025c863-c270-4ba6-beea-edf3cb091573` // string | Manager's identity ID. # string | Manager's identity ID. + requestedObjectId := `2db501be-f0fb-4cc5-a695-334133c52891` // string | Requested access item's ID. # string | Requested access item's ID. + type_ := `ENTITLEMENT` // string | Requested access item's type. # string | Requested access item's type. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics(context.Background(), identityId, requestedObjectId, type_).Execute() + //resp, r, err := apiClient.V2024.AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics(context.Background(), identityId, requestedObjectId, type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestIdentityMetrics`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestsAPI.md new file mode 100644 index 000000000..326bd8c61 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AccessRequestsAPI.md @@ -0,0 +1,1100 @@ +--- +id: v2024-access-requests +title: AccessRequests +pagination_label: AccessRequests +sidebar_label: AccessRequests +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequests', 'V2024AccessRequests'] +slug: /tools/sdk/go/v2024/methods/access-requests +tags: ['SDK', 'Software Development Kit', 'AccessRequests', 'V2024AccessRequests'] +--- + +# AccessRequestsAPI + Use this API to implement and customize access request functionality. +With this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked. +This allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools. + +Identity Security Cloud's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them. + +In the Request Center in Identity Security Cloud, users can view available applications, roles, and entitlements and request access to them. +If the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them. + +Users can use My Requests to track and/or cancel the requests. + +In My Team on the Identity Security Cloud Home, managers can submit requests to revoke their team members' access. +They can use the My Requests tab under Request Center to track and/or cancel the requests. + +Refer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-bulk-access-request**](#approve-bulk-access-request) | **Post** `/access-request-approvals/bulk-approve` | Bulk Approve Access Request +[**cancel-access-request**](#cancel-access-request) | **Post** `/access-requests/cancel` | Cancel Access Request +[**cancel-access-request-in-bulk**](#cancel-access-request-in-bulk) | **Post** `/access-requests/bulk-cancel` | Bulk Cancel Access Request +[**close-access-request**](#close-access-request) | **Post** `/access-requests/close` | Close Access Request +[**create-access-request**](#create-access-request) | **Post** `/access-requests` | Submit Access Request +[**get-access-request-config**](#get-access-request-config) | **Get** `/access-request-config` | Get Access Request Configuration +[**list-access-request-status**](#list-access-request-status) | **Get** `/access-request-status` | Access Request Status +[**list-administrators-access-request-status**](#list-administrators-access-request-status) | **Get** `/access-request-administration` | Access Request Status for Administrators +[**load-account-selections**](#load-account-selections) | **Post** `/access-requests/accounts-selection` | Get accounts selections for identity +[**set-access-request-config**](#set-access-request-config) | **Put** `/access-request-config` | Update Access Request Configuration + + +## approve-bulk-access-request +Bulk Approve Access Request +This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights "idn:access-request-administration:write" can approve the access requests in bulk. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-bulk-access-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiApproveBulkAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulkApproveAccessRequest** | [**BulkApproveAccessRequest**](../models/bulk-approve-access-request) | | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + bulkapproveaccessrequest := []byte(`{ + "comment" : "I approve these request items", + "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] + }`) // BulkApproveAccessRequest | + + + var bulkApproveAccessRequest v2024.BulkApproveAccessRequest + if err := json.Unmarshal(bulkapproveaccessrequest, &bulkApproveAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.ApproveBulkAccessRequest(context.Background()).BulkApproveAccessRequest(bulkApproveAccessRequest).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.ApproveBulkAccessRequest(context.Background()).BulkApproveAccessRequest(bulkApproveAccessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.ApproveBulkAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveBulkAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.ApproveBulkAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## cancel-access-request +Cancel Access Request +This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. +In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-access-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCancelAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cancelAccessRequest** | [**CancelAccessRequest**](../models/cancel-access-request) | | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + cancelaccessrequest := []byte(`{ + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + }`) // CancelAccessRequest | + + + var cancelAccessRequest v2024.CancelAccessRequest + if err := json.Unmarshal(cancelaccessrequest, &cancelAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.CancelAccessRequest(context.Background()).CancelAccessRequest(cancelAccessRequest).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.CancelAccessRequest(context.Background()).CancelAccessRequest(cancelAccessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CancelAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CancelAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CancelAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## cancel-access-request-in-bulk +Bulk Cancel Access Request +This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. +Only ORG_ADMIN or users with rights "idn:access-request-administration:write" can cancel the access requests in bulk. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-access-request-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCancelAccessRequestInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulkCancelAccessRequest** | [**BulkCancelAccessRequest**](../models/bulk-cancel-access-request) | | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + bulkcancelaccessrequest := []byte(`{ + "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], + "comment" : "I requested this role by mistake." + }`) // BulkCancelAccessRequest | + + + var bulkCancelAccessRequest v2024.BulkCancelAccessRequest + if err := json.Unmarshal(bulkcancelaccessrequest, &bulkCancelAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.CancelAccessRequestInBulk(context.Background()).BulkCancelAccessRequest(bulkCancelAccessRequest).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.CancelAccessRequestInBulk(context.Background()).BulkCancelAccessRequest(bulkCancelAccessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CancelAccessRequestInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CancelAccessRequestInBulk`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CancelAccessRequestInBulk`: %v\n", resp) +} +``` + +[[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/). + +To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers. + +To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). + +Input the IDs from either source. + +To track the status of endpoint requests, navigate to Search and use this query: name:"Close Identity Requests". Search will include "Close Identity Requests Started" audits when requests are initiated and "Close Identity Requests Completed" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. + +This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/) for each access request that is closed. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/close-access-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCloseAccessRequestRequest struct via the builder pattern + + +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 + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + }`) // CloseAccessRequest | + + + var closeAccessRequest v2024.CloseAccessRequest + if err := json.Unmarshal(closeaccessrequest, &closeAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + 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() + 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) + } + // response from `CloseAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CloseAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-access-request +Submit Access Request +Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. + +Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request +has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn't return an error +if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. + +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. + +There are two types of access request: + +__GRANT_ACCESS__ +* Can be requested for multiple identities in a single request. +* 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. +* 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. +* 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. +* 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. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessRequest** | [**AccessRequest**](../models/access-request) | | + +### Return type + +[**AccessRequestResponse**](../models/access-request-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accessrequest := []byte(`{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } ] + }`) // AccessRequest | + + + var accessRequest v2024.AccessRequest + if err := json.Unmarshal(accessrequest, &accessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.CreateAccessRequest(context.Background()).AccessRequest(accessRequest).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.CreateAccessRequest(context.Background()).AccessRequest(accessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CreateAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessRequest`: AccessRequestResponse + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CreateAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-config +Get Access Request Configuration +This endpoint returns the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestConfigRequest struct via the builder pattern + + +### Return type + +[**AccessRequestConfig**](../models/access-request-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.GetAccessRequestConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.GetAccessRequestConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.GetAccessRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestConfig`: AccessRequestConfig + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.GetAccessRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-request-status +Access Request Status +Use this API to return a list of access request statuses based on the specified query parameters. +If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. +Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-request-status) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessRequestStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **requestedBy** | **string** | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **regardingIdentity** | **string** | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. | + **assignedTo** | **string** | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. | + **count** | **bool** | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. | [default to false] + **limit** | **int32** | Max number of results to return. | [default to 250] + **offset** | **int32** | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. | + **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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* | + **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: **created, modified, accountActivityItemId, name** | + **requestState** | **string** | Filter the results by the state of the request. The only valid value is *EXECUTING*. | + +### Return type + +[**[]RequestedItemStatus**](../models/requested-item-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + assignedTo := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + count := false // bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + limit := 100 // int32 | Max number of results to return. (optional) (default to 250) # int32 | Max number of results to return. (optional) (default to 250) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + filters := `accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"` // 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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + sorters := `created` // 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: **created, modified, accountActivityItemId, name** (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: **created, modified, accountActivityItemId, name** (optional) + requestState := `request-state=EXECUTING` // string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.ListAccessRequestStatus(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.ListAccessRequestStatus(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).AssignedTo(assignedTo).Count(count).Limit(limit).Offset(offset).Filters(filters).Sorters(sorters).RequestState(requestState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.ListAccessRequestStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessRequestStatus`: []RequestedItemStatus + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.ListAccessRequestStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-administrators-access-request-status +Access Request Status for Administrators +Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. +Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-administrators-access-request-status) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAdministratorsAccessRequestStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **requestedBy** | **string** | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **regardingIdentity** | **string** | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. | + **assignedTo** | **string** | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. | + **count** | **bool** | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. | [default to false] + **limit** | **int32** | Max number of results to return. | [default to 250] + **offset** | **int32** | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. | + **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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* | + **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: **created, modified, accountActivityItemId, name, accessRequestId** | + **requestState** | **string** | Filter the results by the state of the request. The only valid value is *EXECUTING*. | + +### Return type + +[**[]AccessRequestAdminItemStatus**](../models/access-request-admin-item-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + assignedTo := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + count := false // bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + limit := 100 // int32 | Max number of results to return. (optional) (default to 250) # int32 | Max number of results to return. (optional) (default to 250) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + filters := `accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"` // 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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + sorters := `created` // 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: **created, modified, accountActivityItemId, name, accessRequestId** (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: **created, modified, accountActivityItemId, name, accessRequestId** (optional) + requestState := `request-state=EXECUTING` // string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.ListAdministratorsAccessRequestStatus(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.ListAdministratorsAccessRequestStatus(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).AssignedTo(assignedTo).Count(count).Limit(limit).Offset(offset).Filters(filters).Sorters(sorters).RequestState(requestState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.ListAdministratorsAccessRequestStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAdministratorsAccessRequestStatus`: []AccessRequestAdminItemStatus + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.ListAdministratorsAccessRequestStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## load-account-selections +Get accounts selections for identity +Use this API to fetch account information for an identity against the items in an access request. + +Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/load-account-selections) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiLoadAccountSelectionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountsSelectionRequest** | [**AccountsSelectionRequest**](../models/accounts-selection-request) | | + +### Return type + +[**AccountsSelectionResponse**](../models/accounts-selection-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accountsselectionrequest := []byte(`{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }`) // AccountsSelectionRequest | + + + var accountsSelectionRequest v2024.AccountsSelectionRequest + if err := json.Unmarshal(accountsselectionrequest, &accountsSelectionRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.LoadAccountSelections(context.Background()).AccountsSelectionRequest(accountsSelectionRequest).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.LoadAccountSelections(context.Background()).AccountsSelectionRequest(accountsSelectionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.LoadAccountSelections``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `LoadAccountSelections`: AccountsSelectionResponse + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.LoadAccountSelections`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-access-request-config +Update Access Request Configuration +This endpoint replaces the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-access-request-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetAccessRequestConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessRequestConfig** | [**AccessRequestConfig**](../models/access-request-config) | | + +### Return type + +[**AccessRequestConfig**](../models/access-request-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accessrequestconfig := []byte(`{ + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + }`) // AccessRequestConfig | + + + var accessRequestConfig v2024.AccessRequestConfig + if err := json.Unmarshal(accessrequestconfig, &accessRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.SetAccessRequestConfig(context.Background()).AccessRequestConfig(accessRequestConfig).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.SetAccessRequestConfig(context.Background()).AccessRequestConfig(accessRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.SetAccessRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetAccessRequestConfig`: AccessRequestConfig + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.SetAccessRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AccountActivitiesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AccountActivitiesAPI.md new file mode 100644 index 000000000..3ae76ce1d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AccountActivitiesAPI.md @@ -0,0 +1,196 @@ +--- +id: v2024-account-activities +title: AccountActivities +pagination_label: AccountActivities +sidebar_label: AccountActivities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivities', 'V2024AccountActivities'] +slug: /tools/sdk/go/v2024/methods/account-activities +tags: ['SDK', 'Software Development Kit', 'AccountActivities', 'V2024AccountActivities'] +--- + +# AccountActivitiesAPI + Use this API to implement account activity tracking functionality. +With this functionality in place, users can track source account activity in Identity Security Cloud, which greatly improves traceability in the system. + +An account activity refers to a log of each action performed on a source account. This is useful for auditing the changes performed on an account throughout its life. +In Identity Security Cloud's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. + +Account activity includes most actions Identity Security Cloud completes on source accounts. Users can search in Identity Security Cloud for the following account action types: + +- Access Request: These include any access requests the source account is involved in. + +- Account Attribute Updates: These include updates to a single attribute on an account on a source. + +- Account State Update: These include locking or unlocking actions on an account on a source. + +- Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification. + +- Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. +Identity Security Cloud replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. + +- Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. +When you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays. +Account Activity does not include attribute updates that occur as a result of aggregation. + +- Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. +These also include refreshes that occur whenever Identity Security Cloud assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. + +- Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. + +- Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state. + +- Password Change: These include password changes on sources. + +Refer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-account-activity**](#get-account-activity) | **Get** `/account-activities/{id}` | Get an Account Activity +[**list-account-activities**](#list-account-activities) | **Get** `/account-activities` | List Account Activities + + +## get-account-activity +Get an Account Activity +This gets a single account activity by its id. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account-activity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account activity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountActivityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccountActivity**](../models/account-activity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account activity id # string | The account activity id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountActivitiesAPI.GetAccountActivity(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.AccountActivitiesAPI.GetAccountActivity(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountActivitiesAPI.GetAccountActivity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccountActivity`: AccountActivity + fmt.Fprintf(os.Stdout, "Response from `AccountActivitiesAPI.GetAccountActivity`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-account-activities +List Account Activities +This gets a collection of account activities that satisfy the given query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-account-activities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccountActivitiesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **requestedBy** | **string** | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **regardingIdentity** | **string** | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* | + **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: **type, created, modified** | + +### Return type + +[**[]AccountActivity**](../models/account-activity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c91808568c529c60168cca6f90c1313` // string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c91808568c529c60168cca6f90c1313` // string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c91808568c529c60168cca6f90c1313` // string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `type eq "Identity Refresh"` // 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + sorters := `created` // 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: **type, created, modified** (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: **type, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountActivitiesAPI.ListAccountActivities(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccountActivitiesAPI.ListAccountActivities(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountActivitiesAPI.ListAccountActivities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccountActivities`: []AccountActivity + fmt.Fprintf(os.Stdout, "Response from `AccountActivitiesAPI.ListAccountActivities`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AccountAggregationsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AccountAggregationsAPI.md new file mode 100644 index 000000000..6a23d552d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AccountAggregationsAPI.md @@ -0,0 +1,116 @@ +--- +id: v2024-account-aggregations +title: AccountAggregations +pagination_label: AccountAggregations +sidebar_label: AccountAggregations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAggregations', 'V2024AccountAggregations'] +slug: /tools/sdk/go/v2024/methods/account-aggregations +tags: ['SDK', 'Software Development Kit', 'AccountAggregations', 'V2024AccountAggregations'] +--- + +# AccountAggregationsAPI + Use this API to implement account aggregation progress tracking functionality. +With this functionality in place, administrators can view in-progress account aggregations, their statuses, and their relevant details. + +An account aggregation refers to the process Identity Security Cloud uses to gather and load account data from a source into Identity Security Cloud. + +Whenever Identity Security Cloud is in the process of aggregating a source, it adds an entry to the Aggregation Activity Log, along with its relevant details. +To view aggregation activity, administrators can select the Connections drop-down menu, select Sources, and select the relevant source, select its Import Data tab, and select Account Aggregation. +In Account Aggregation, administrators can view the account aggregations' statuses and details in the Account Activity Log. + +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about account aggregations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-account-aggregation-status**](#get-account-aggregation-status) | **Get** `/account-aggregations/{id}/status` | In-progress Account Aggregation status + + +## get-account-aggregation-status +:::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. + +Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. + +Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. + +*Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* +required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account-aggregation-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account aggregation id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountAggregationStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**AccountAggregationStatus**](../models/account-aggregation-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } + // response from `GetAccountAggregationStatus`: AccountAggregationStatus + fmt.Fprintf(os.Stdout, "Response from `AccountAggregationsAPI.GetAccountAggregationStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AccountUsagesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AccountUsagesAPI.md new file mode 100644 index 000000000..c4a744e67 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AccountUsagesAPI.md @@ -0,0 +1,97 @@ +--- +id: v2024-account-usages +title: AccountUsages +pagination_label: AccountUsages +sidebar_label: AccountUsages +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUsages', 'V2024AccountUsages'] +slug: /tools/sdk/go/v2024/methods/account-usages +tags: ['SDK', 'Software Development Kit', 'AccountUsages', 'V2024AccountUsages'] +--- + +# AccountUsagesAPI + Use this API to implement account usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used. +This allows organizations to get the information they need to start optimizing and securing source account usage. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-usages-by-account-id**](#get-usages-by-account-id) | **Get** `/account-usages/{accountId}/summaries` | Returns account usage insights + + +## get-usages-by-account-id +Returns account usage insights +This API returns a summary of account usage insights for past 12 months. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-usages-by-account-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**accountId** | **string** | ID of IDN account | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetUsagesByAccountIdRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **date** | + +### Return type + +[**[]AccountUsage**](../models/account-usage) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accountId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of IDN account # string | ID of IDN account + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `-date` // 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: **date** (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: **date** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountUsagesAPI.GetUsagesByAccountId(context.Background(), accountId).Execute() + //resp, r, err := apiClient.V2024.AccountUsagesAPI.GetUsagesByAccountId(context.Background(), accountId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountUsagesAPI.GetUsagesByAccountId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUsagesByAccountId`: []AccountUsage + fmt.Fprintf(os.Stdout, "Response from `AccountUsagesAPI.GetUsagesByAccountId`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AccountsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AccountsAPI.md new file mode 100644 index 000000000..faa030faf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AccountsAPI.md @@ -0,0 +1,1308 @@ +--- +id: v2024-accounts +title: Accounts +pagination_label: Accounts +sidebar_label: Accounts +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Accounts', 'V2024Accounts'] +slug: /tools/sdk/go/v2024/methods/accounts +tags: ['SDK', 'Software Development Kit', 'Accounts', 'V2024Accounts'] +--- + +# AccountsAPI + Use this API to implement and customize account functionality. +With this functionality in place, administrators can manage users' access across sources in Identity Security Cloud. + +In Identity Security Cloud, an account refers to a user's account on a supported source. +This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. Identity Security Cloud loads accounts through the creation of sources in Identity Security Cloud. + +Administrators can correlate users' identities with the users' accounts on the different sources they use. +This allows Identity Security Cloud to govern the access of identities and all their correlated accounts securely and cohesively. + +To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. + +To view and edit source account statuses for an identity in Identity Security Cloud, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. +Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. + +Accounts can have the following statuses: + +- Enabled: The account is enabled. The user can access it. + +- Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in Identity Security Cloud. This can occur when an administrator disables the account or when the user's lifecycle state changes. + +- Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times. + +- Pending: The account is currently updating. This status typically lasts seconds. + +Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed. + +Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-account**](#create-account) | **Post** `/accounts` | Create Account +[**delete-account**](#delete-account) | **Delete** `/accounts/{id}` | Delete Account +[**delete-account-async**](#delete-account-async) | **Post** `/accounts/{id}/remove` | Remove Account +[**disable-account**](#disable-account) | **Post** `/accounts/{id}/disable` | Disable Account +[**disable-account-for-identity**](#disable-account-for-identity) | **Post** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity +[**disable-accounts-for-identities**](#disable-accounts-for-identities) | **Post** `/identities-accounts/disable` | Disable IDN Accounts for Identities +[**enable-account**](#enable-account) | **Post** `/accounts/{id}/enable` | Enable Account +[**enable-account-for-identity**](#enable-account-for-identity) | **Post** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity +[**enable-accounts-for-identities**](#enable-accounts-for-identities) | **Post** `/identities-accounts/enable` | Enable IDN Accounts for Identities +[**get-account**](#get-account) | **Get** `/accounts/{id}` | Account Details +[**get-account-entitlements**](#get-account-entitlements) | **Get** `/accounts/{id}/entitlements` | Account Entitlements +[**list-accounts**](#list-accounts) | **Get** `/accounts` | Accounts List +[**put-account**](#put-account) | **Put** `/accounts/{id}` | Update Account +[**submit-reload-account**](#submit-reload-account) | **Post** `/accounts/{id}/reload` | Reload Account +[**unlock-account**](#unlock-account) | **Post** `/accounts/{id}/unlock` | Unlock Account +[**update-account**](#update-account) | **Patch** `/accounts/{id}` | Update Account + + +## create-account +Create Account +Submit an account creation task - the API then returns the task ID. + +You must include the `sourceId` where the account will be created in the `attributes` object. + +This endpoint creates an account on the source record in your ISC tenant. +This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. + +However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. +The endpoint doesn't actually provision the account on the target source, which means that if the account doesn't also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. + +By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-account) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountAttributesCreate** | [**AccountAttributesCreate**](../models/account-attributes-create) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accountattributescreate := []byte(`{ + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }`) // AccountAttributesCreate | + + + var accountAttributesCreate v2024.AccountAttributesCreate + if err := json.Unmarshal(accountattributescreate, &accountAttributesCreate); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.CreateAccount(context.Background()).AccountAttributesCreate(accountAttributesCreate).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.CreateAccount(context.Background()).AccountAttributesCreate(accountAttributesCreate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.CreateAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.CreateAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-account +Delete Account +Use this API to delete an account. +This endpoint submits an account delete task and returns the task ID. +This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. +>**NOTE: You can only delete accounts from sources of the "DelimitedFile" type.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.DeleteAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.DeleteAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DeleteAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DeleteAccount`: %v\n", resp) +} +``` + +[[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. + +This endpoint is good for: +* Removing accounts that no longer exist on the source. +* Removing accounts that won't be aggregated following updates to the source configuration. +* Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-account-async) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccountAsyncRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**TaskResultDto**](../models/task-result-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } + // response from `DeleteAccountAsync`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DeleteAccountAsync`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## disable-account +Disable Account +This API submits a task to disable the account and returns the task ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDisableAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **accountToggleRequest** | [**AccountToggleRequest**](../models/account-toggle-request) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + accounttogglerequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }`) // AccountToggleRequest | + + + var accountToggleRequest v2024.AccountToggleRequest + if err := json.Unmarshal(accounttogglerequest, &accountToggleRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.DisableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.DisableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DisableAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DisableAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccount`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-account-for-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDisableAccountForIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } + // response from `DisableAccountForIdentity`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccountForIdentity`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-accounts-for-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDisableAccountsForIdentitiesRequest struct via the builder pattern + + +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 + +[**[]BulkIdentitiesAccountsResponse**](../models/bulk-identities-accounts-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 | + + + var identitiesAccountsBulkRequest v2024.IdentitiesAccountsBulkRequest + if err := json.Unmarshal(identitiesaccountsbulkrequest, &identitiesAccountsBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + 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() + 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) + } + // response from `DisableAccountsForIdentities`: []BulkIdentitiesAccountsResponse + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccountsForIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## enable-account +Enable Account +This API submits a task to enable account and returns the task ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiEnableAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **accountToggleRequest** | [**AccountToggleRequest**](../models/account-toggle-request) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + accounttogglerequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }`) // AccountToggleRequest | + + + var accountToggleRequest v2024.AccountToggleRequest + if err := json.Unmarshal(accounttogglerequest, &accountToggleRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.EnableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.EnableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.EnableAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `EnableAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccount`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-account-for-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiEnableAccountForIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } + // response from `EnableAccountForIdentity`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccountForIdentity`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-accounts-for-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiEnableAccountsForIdentitiesRequest struct via the builder pattern + + +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 + +[**[]BulkIdentitiesAccountsResponse**](../models/bulk-identities-accounts-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 | + + + var identitiesAccountsBulkRequest v2024.IdentitiesAccountsBulkRequest + if err := json.Unmarshal(identitiesaccountsbulkrequest, &identitiesAccountsBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + 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() + 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) + } + // response from `EnableAccountsForIdentities`: []BulkIdentitiesAccountsResponse + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccountsForIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-account +Account Details +Use this API to return the details for a single account by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Account**](../models/account) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.GetAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.GetAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.GetAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccount`: Account + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.GetAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-account-entitlements +Account Entitlements +This API returns entitlements of the account. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountEntitlementsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.GetAccountEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.GetAccountEntitlements(context.Background(), id).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.GetAccountEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccountEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.GetAccountEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-accounts +Accounts List +List accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-accounts) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccountsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **detailLevel** | **string** | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. | + **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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* | + **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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** | + +### Return type + +[**[]Account**](../models/account) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + detailLevel := `FULL` // string | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) # string | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + filters := `identityId eq "2c9180858082150f0180893dbaf44201"` // 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) + sorters := `id,name` // 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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.ListAccounts(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.ListAccounts(context.Background()).Limit(limit).Offset(offset).Count(count).DetailLevel(detailLevel).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.ListAccounts``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccounts`: []Account + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.ListAccounts`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-account +Update Account +Use this API to update an account with a PUT request. + +This endpoint submits an account update task and returns the task ID. + +>**Note: You can only use this PUT endpoint to update accounts from flat file sources.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **accountAttributes** | [**AccountAttributes**](../models/account-attributes) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + accountattributes := []byte(`{ + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }`) // AccountAttributes | + + + var accountAttributes v2024.AccountAttributes + if err := json.Unmarshal(accountattributes, &accountAttributes); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.PutAccount(context.Background(), id).AccountAttributes(accountAttributes).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.PutAccount(context.Background(), id).AccountAttributes(accountAttributes).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.PutAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.PutAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-reload-account +Reload Account +This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-reload-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitReloadAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.SubmitReloadAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.SubmitReloadAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.SubmitReloadAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitReloadAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.SubmitReloadAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## unlock-account +Unlock Account +This API submits a task to unlock an account and returns the task ID. +To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/unlock-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUnlockAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **accountUnlockRequest** | [**AccountUnlockRequest**](../models/account-unlock-request) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account ID. # string | The account ID. + accountunlockrequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + }`) // AccountUnlockRequest | + + + var accountUnlockRequest v2024.AccountUnlockRequest + if err := json.Unmarshal(accountunlockrequest, &accountUnlockRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.UnlockAccount(context.Background(), id).AccountUnlockRequest(accountUnlockRequest).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.UnlockAccount(context.Background(), id).AccountUnlockRequest(accountUnlockRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.UnlockAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UnlockAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.UnlockAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-account +Update Account +Use this API to update account details. + +This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields. +To reassign an account from one identity to another, replace the current `identityId` with a new value. +If the account you're assigning was provisioned by Identity Security Cloud (ISC), it's possible for ISC to create a new account +for the previous identity as soon as the account is moved. If the account you're assigning is authoritative, +this causes the previous identity to become uncorrelated and can even result in its deletion. +All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. + +>**Note:** The `attributes` field can only be modified for flat file accounts. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **requestBody** | **[]map[string]interface{}** | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + requestbody := []byte(`[{op=remove, path=/identityId}]`) // []map[string]interface{} | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.UpdateAccount(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.UpdateAccount(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.UpdateAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAccount`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.UpdateAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ApplicationDiscoveryAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ApplicationDiscoveryAPI.md new file mode 100644 index 000000000..a0116f5b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ApplicationDiscoveryAPI.md @@ -0,0 +1,216 @@ +--- +id: v2024-application-discovery +title: ApplicationDiscovery +pagination_label: ApplicationDiscovery +sidebar_label: ApplicationDiscovery +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApplicationDiscovery', 'V2024ApplicationDiscovery'] +slug: /tools/sdk/go/v2024/methods/application-discovery +tags: ['SDK', 'Software Development Kit', 'ApplicationDiscovery', 'V2024ApplicationDiscovery'] +--- + +# ApplicationDiscoveryAPI + Use this API to implement application discovery functionality. +With this functionality in place, you can discover applications within your Okta connector and receive connector recommendations by manually uploading application names. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-discovered-applications**](#get-discovered-applications) | **Get** `/discovered-applications` | Get Discovered Applications for Tenant +[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **Get** `/manual-discover-applications-template` | Download CSV Template for Discovery +[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **Post** `/manual-discover-applications` | Upload CSV to Discover Applications + + +## get-discovered-applications +Get Discovered Applications for Tenant +Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-discovered-applications) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDiscoveredApplicationsRequest struct via the builder pattern + + +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] + **detail** | **string** | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. | + **filter** | **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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* | + **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, description, discoveredAt, discoverySource** | + +### Return type + +[**[]GetDiscoveredApplications200ResponseInner**](../models/get-discovered-applications200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + filter := `name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")` // 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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + sorters := `name` // 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, description, discoveredAt, discoverySource** (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, description, discoveredAt, discoverySource** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ApplicationDiscoveryAPI.GetDiscoveredApplications(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ApplicationDiscoveryAPI.GetDiscoveredApplications(context.Background()).Limit(limit).Offset(offset).Detail(detail).Filter(filter).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetDiscoveredApplications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDiscoveredApplications`: []GetDiscoveredApplications200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `ApplicationDiscoveryAPI.GetDiscoveredApplications`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-manual-discover-applications-csv-template +Download CSV Template for Discovery +Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. + +The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-manual-discover-applications-csv-template) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManualDiscoverApplicationsCsvTemplateRequest struct via the builder pattern + + +### Return type + +[**ManualDiscoverApplicationsTemplate**](../models/manual-discover-applications-template) + +### 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() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManualDiscoverApplicationsCsvTemplate`: ManualDiscoverApplicationsTemplate + fmt.Fprintf(os.Stdout, "Response from `ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## send-manual-discover-applications-csv-template +Upload CSV to Discover Applications +Uploading a CSV file with application data for manual correlation to specific ISC connectors. +If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-manual-discover-applications-csv-template) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendManualDiscoverApplicationsCsvTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file** | ***os.File** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | + +### Return type + + (empty response body) + +### 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() { + file := BINARY_DATA_HERE // *os.File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # *os.File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate(context.Background()).File(file).Execute() + //r, err := apiClient.V2024.ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate(context.Background()).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ApprovalsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ApprovalsAPI.md new file mode 100644 index 000000000..a99f8dd43 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ApprovalsAPI.md @@ -0,0 +1,183 @@ +--- +id: v2024-approvals +title: Approvals +pagination_label: Approvals +sidebar_label: Approvals +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Approvals', 'V2024Approvals'] +slug: /tools/sdk/go/v2024/methods/approvals +tags: ['SDK', 'Software Development Kit', 'Approvals', 'V2024Approvals'] +--- + +# ApprovalsAPI + Use this API to implement approval functionality. With this functionality in place, you can get generic approvals and modify them. + +The main advantages this API has vs [Access Request Approvals](https://developer.sailpoint.com/docs/api/v2024/access-request-approvals) are that you can use it to get generic approvals individually or in batches and make changes to those approvals. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-approval**](#get-approval) | **Get** `/generic-approvals/{id}` | Get an approval +[**get-approvals**](#get-approvals) | **Get** `/generic-approvals` | Get Approvals + + +## get-approval +:::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 an approval +Retrieve a single approval for a given approval ID. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-approval) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the approval that is to be returned | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetApprovalRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**Approval**](../models/approval) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `38453251-6be2-5f8f-df93-5ce19e295837` // string | ID of the approval that is to be returned # string | ID of the approval that is to be returned + 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.ApprovalsAPI.GetApproval(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.ApprovalsAPI.GetApproval(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApprovalsAPI.GetApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetApproval`: Approval + fmt.Fprintf(os.Stdout, "Response from `ApprovalsAPI.GetApproval`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-approvals +:::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 Approvals +Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. "Mine" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. +Absence of all query parameters will will default to mine=true. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-approvals) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetApprovalsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **mine** | **bool** | Returns the list of approvals for the current caller | + **requesterId** | **string** | Returns the list of approvals for a given requester ID | + **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: **status**: *eq* **referenceType**: *eq* | + +### Return type + +[**[]Approval**](../models/approval) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + mine := true // bool | Returns the list of approvals for the current caller (optional) # bool | Returns the list of approvals for the current caller (optional) + requesterId := `17e633e7d57e481569df76323169deb6a` // string | Returns the list of approvals for a given requester ID (optional) # string | Returns the list of approvals for a given requester ID (optional) + filters := `filters=status eq PENDING` // 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: **status**: *eq* **referenceType**: *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: **status**: *eq* **referenceType**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ApprovalsAPI.GetApprovals(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.ApprovalsAPI.GetApprovals(context.Background()).XSailPointExperimental(xSailPointExperimental).Mine(mine).RequesterId(requesterId).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApprovalsAPI.GetApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetApprovals`: []Approval + fmt.Fprintf(os.Stdout, "Response from `ApprovalsAPI.GetApprovals`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AppsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AppsAPI.md new file mode 100644 index 000000000..4d0eca216 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AppsAPI.md @@ -0,0 +1,1203 @@ +--- +id: v2024-apps +title: Apps +pagination_label: Apps +sidebar_label: Apps +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Apps', 'V2024Apps'] +slug: /tools/sdk/go/v2024/methods/apps +tags: ['SDK', 'Software Development Kit', 'Apps', 'V2024Apps'] +--- + +# AppsAPI + Use this API to implement source application functionality. +With this functionality in place, you can create, customize, and manage applications within sources. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-source-app**](#create-source-app) | **Post** `/source-apps` | Create source app +[**delete-access-profiles-from-source-app-by-bulk**](#delete-access-profiles-from-source-app-by-bulk) | **Post** `/source-apps/{id}/access-profiles/bulk-remove` | Bulk remove access profiles from the specified source app +[**delete-source-app**](#delete-source-app) | **Delete** `/source-apps/{id}` | Delete source app by ID +[**get-source-app**](#get-source-app) | **Get** `/source-apps/{id}` | Get source app by ID +[**list-access-profiles-for-source-app**](#list-access-profiles-for-source-app) | **Get** `/source-apps/{id}/access-profiles` | List access profiles for the specified source app +[**list-all-source-app**](#list-all-source-app) | **Get** `/source-apps/all` | List all source apps +[**list-all-user-apps**](#list-all-user-apps) | **Get** `/user-apps/all` | List all user apps +[**list-assigned-source-app**](#list-assigned-source-app) | **Get** `/source-apps/assigned` | List assigned source apps +[**list-available-accounts-for-user-app**](#list-available-accounts-for-user-app) | **Get** `/user-apps/{id}/available-accounts` | List available accounts for user app +[**list-available-source-apps**](#list-available-source-apps) | **Get** `/source-apps` | List available source apps +[**list-owned-user-apps**](#list-owned-user-apps) | **Get** `/user-apps` | List owned user apps +[**patch-source-app**](#patch-source-app) | **Patch** `/source-apps/{id}` | Patch source app by ID +[**patch-user-app**](#patch-user-app) | **Patch** `/user-apps/{id}` | Patch user app by ID +[**update-source-apps-in-bulk**](#update-source-apps-in-bulk) | **Post** `/source-apps/bulk-update` | Bulk update source apps + + +## create-source-app +:::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 source app +This endpoint creates a source app using the given source app payload + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-source-app) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **sourceAppCreateDto** | [**SourceAppCreateDto**](../models/source-app-create-dto) | | + +### Return type + +[**SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + sourceappcreatedto := []byte(`{ + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true + }`) // SourceAppCreateDto | + + + var sourceAppCreateDto v2024.SourceAppCreateDto + if err := json.Unmarshal(sourceappcreatedto, &sourceAppCreateDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.CreateSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceAppCreateDto(sourceAppCreateDto).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.CreateSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceAppCreateDto(sourceAppCreateDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.CreateSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.CreateSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-access-profiles-from-source-app-by-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 remove access profiles from the specified source app +This API returns the final list of access profiles for the specified source app after removing + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-access-profiles-from-source-app-by-bulk) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the source app | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccessProfilesFromSourceAppByBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **requestBody** | **[]string** | | + **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] + +### Return type + +[**[]AccessProfileDetails**](../models/access-profile-details) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + 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") + requestbody := []byte(`[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]`) // []string | + 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) + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.DeleteAccessProfilesFromSourceAppByBulk(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.DeleteAccessProfilesFromSourceAppByBulk(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.DeleteAccessProfilesFromSourceAppByBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccessProfilesFromSourceAppByBulk`: []AccessProfileDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.DeleteAccessProfilesFromSourceAppByBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-source-app +:::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 source app by ID +Use this API to delete a specific source app + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | source app ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | source app ID. # string | source app 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.AppsAPI.DeleteSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.DeleteSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.DeleteSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.DeleteSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-app +:::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 source app by ID +This API returns a source app by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the source app | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + 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.AppsAPI.GetSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.GetSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.GetSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.GetSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-profiles-for-source-app +:::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 access profiles for the specified source app +This API returns the list of access profiles for the specified source app + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-profiles-for-source-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the source app | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessProfilesForSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* | + +### Return type + +[**[]AccessProfileDetails**](../models/access-profile-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + 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") + 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) + filters := `name eq "developer access profile"` // 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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.ListAccessProfilesForSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.ListAccessProfilesForSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAccessProfilesForSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessProfilesForSourceApp`: []AccessProfileDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAccessProfilesForSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-all-source-app +:::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 all source apps +This API returns the list of all source apps for the org. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-all-source-app) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAllSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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] + **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: **id, name, created, modified, owner.id, accountSource.id** | + **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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* | + +### Return type + +[**[]SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, owner.id, accountSource.id** (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: **id, name, created, modified, owner.id, accountSource.id** (optional) + filters := `enabled eq true` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.ListAllSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.ListAllSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAllSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAllSourceApp`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAllSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-all-user-apps +:::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 all user apps +This API returns the list of all user apps with specified filters. +This API must be used with **filters** query parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-all-user-apps) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAllUserAppsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* | + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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 + +[**[]UserApp**](../models/user-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `name eq "user app name"` // 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.V2024.AppsAPI.ListAllUserApps(context.Background()).Filters(filters).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.ListAllUserApps(context.Background()).Filters(filters).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAllUserApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAllUserApps`: []UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAllUserApps`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-assigned-source-app +:::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 assigned source apps +This API returns the list of source apps assigned for logged in user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-assigned-source-app) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAssignedSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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] + **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: **id, name, created, modified, accountSource.id** | + **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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* | + +### Return type + +[**[]SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, accountSource.id** (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: **id, name, created, modified, accountSource.id** (optional) + filters := `name eq "source app name"` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.ListAssignedSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.ListAssignedSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAssignedSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAssignedSourceApp`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAssignedSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-available-accounts-for-user-app +:::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 available accounts for user app +This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-available-accounts-for-user-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the user app | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAvailableAccountsForUserAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]AppAccountDetails**](../models/app-account-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the user app # string | ID of the user app + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.ListAvailableAccountsForUserApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.ListAvailableAccountsForUserApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAvailableAccountsForUserApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAvailableAccountsForUserApp`: []AppAccountDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAvailableAccountsForUserApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-available-source-apps +:::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 available source apps +This API returns the list of source apps available for access request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-available-source-apps) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAvailableSourceAppsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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] + **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: **id, name, created, modified, owner.id, accountSource.id** | + **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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* | + +### Return type + +[**[]SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, owner.id, accountSource.id** (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: **id, name, created, modified, owner.id, accountSource.id** (optional) + filters := `name eq "source app name"` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.ListAvailableSourceApps(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.ListAvailableSourceApps(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAvailableSourceApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAvailableSourceApps`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAvailableSourceApps`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-owned-user-apps +:::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 owned user apps +This API returns the list of user apps assigned to logged in user + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-owned-user-apps) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOwnedUserAppsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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] + **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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* | + +### Return type + +[**[]UserApp**](../models/user-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + filters := `name eq "user app name"` // 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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.ListOwnedUserApps(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.ListOwnedUserApps(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListOwnedUserApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOwnedUserApps`: []UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListOwnedUserApps`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-source-app +:::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 + ``` +::: +Patch source app by ID +This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. +Name, description and owner can't be empty or null. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-source-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the source app to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**SourceAppPatchDto**](../models/source-app-patch-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app to patch # string | ID of the source app to patch + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]`) // []JsonPatchOperation | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.PatchSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.PatchSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.PatchSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSourceApp`: SourceAppPatchDto + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.PatchSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-user-app +:::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 + ``` +::: +Patch user app by ID +This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **account** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-user-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the user app to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchUserAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**UserApp**](../models/user-app) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the user app to patch # string | ID of the user app to patch + 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") + jsonpatchoperation := []byte(``) // []JsonPatchOperation | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.PatchUserApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.PatchUserApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.PatchUserApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchUserApp`: UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.PatchUserApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-source-apps-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 update source apps +This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. +The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. +Name, description and owner can't be empty or null. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-source-apps-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSourceAppsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **sourceAppBulkUpdateRequest** | [**SourceAppBulkUpdateRequest**](../models/source-app-bulk-update-request) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + sourceappbulkupdaterequest := []byte(`{ + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] + }`) // SourceAppBulkUpdateRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.AppsAPI.UpdateSourceAppsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.AppsAPI.UpdateSourceAppsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceAppBulkUpdateRequest(sourceAppBulkUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.UpdateSourceAppsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AuthProfileAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AuthProfileAPI.md new file mode 100644 index 000000000..8dc39908c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AuthProfileAPI.md @@ -0,0 +1,268 @@ +--- +id: v2024-auth-profile +title: AuthProfile +pagination_label: AuthProfile +sidebar_label: AuthProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuthProfile', 'V2024AuthProfile'] +slug: /tools/sdk/go/v2024/methods/auth-profile +tags: ['SDK', 'Software Development Kit', 'AuthProfile', 'V2024AuthProfile'] +--- + +# AuthProfileAPI + Use this API to implement Auth Profile functionality. +With this functionality in place, users can read authentication profiles and make changes to them. + +An authentication profile represents an identity profile's authentication configuration. +When the identity profile is created, its authentication profile is also created. +An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-profile-config**](#get-profile-config) | **Get** `/auth-profiles/{id}` | Get Auth Profile +[**get-profile-config-list**](#get-profile-config-list) | **Get** `/auth-profiles` | Get list of Auth Profiles +[**patch-profile-config**](#patch-profile-config) | **Patch** `/auth-profiles/{id}` | Patch a specified Auth Profile + + +## get-profile-config +:::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 Auth Profile +This API returns auth profile information. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-profile-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Auth Profile to patch. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProfileConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + + +### Return type + +[**AuthProfile**](../models/auth-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + id := `2c91808a7813090a017814121919ecca` // string | ID of the Auth Profile to patch. # string | ID of the Auth Profile to patch. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AuthProfileAPI.GetProfileConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AuthProfileAPI.GetProfileConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.GetProfileConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProfileConfig`: AuthProfile + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.GetProfileConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-profile-config-list +:::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 list of Auth Profiles +This API returns a list of auth profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-profile-config-list) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProfileConfigListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**[]AuthProfileSummary**](../models/auth-profile-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AuthProfileAPI.GetProfileConfigList(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AuthProfileAPI.GetProfileConfigList(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.GetProfileConfigList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProfileConfigList`: []AuthProfileSummary + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.GetProfileConfigList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-profile-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 + ``` +::: +Patch a specified Auth Profile +This API updates an existing Auth Profile. The following fields are patchable: +**offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-profile-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Auth Profile to patch. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchProfileConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**AuthProfile**](../models/auth-profile) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Auth Profile to patch. # string | ID of the Auth Profile to patch. + 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") + jsonpatchoperation := []byte(``) // []JsonPatchOperation | + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AuthProfileAPI.PatchProfileConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.AuthProfileAPI.PatchProfileConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.PatchProfileConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchProfileConfig`: AuthProfile + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.PatchProfileConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/AuthUsersAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/AuthUsersAPI.md new file mode 100644 index 000000000..8938f108d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/AuthUsersAPI.md @@ -0,0 +1,170 @@ +--- +id: v2024-auth-users +title: AuthUsers +pagination_label: AuthUsers +sidebar_label: AuthUsers +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuthUsers', 'V2024AuthUsers'] +slug: /tools/sdk/go/v2024/methods/auth-users +tags: ['SDK', 'Software Development Kit', 'AuthUsers', 'V2024AuthUsers'] +--- + +# AuthUsersAPI + Use this API to implement user authentication system functionality. +With this functionality in place, users can get a user's authentication system details, including their capabilities, and modify those capabilities. +The user's capabilities refer to their access to different systems, or authorization, within the tenant, like access to certifications (CERT_ADMIN) or reports (REPORT_ADMIN). +These capabilities also determine a user's access to the different APIs. +This API provides users with a way to determine a user's access and make quick and easy changes to that access. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-auth-user**](#get-auth-user) | **Get** `/auth-users/{id}` | Auth User Details +[**patch-auth-user**](#patch-auth-user) | **Patch** `/auth-users/{id}` | Auth User Update + + +## get-auth-user +Auth User Details +Return the specified user's authentication system details. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-user) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Identity ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAuthUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AuthUser**](../models/auth-user) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AuthUsersAPI.GetAuthUser(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.AuthUsersAPI.GetAuthUser(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthUsersAPI.GetAuthUser``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthUser`: AuthUser + fmt.Fprintf(os.Stdout, "Response from `AuthUsersAPI.GetAuthUser`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-auth-user +Auth User Update +Use a PATCH request to update an existing user in the authentication system. +Use this endpoint to modify these fields: + * `capabilities` + +A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-user) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Identity ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAuthUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +[**AuthUser**](../models/auth-user) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + jsonpatchoperation := []byte(`[{op=replace, path=/capabilities, value=[ORG_ADMIN]}]`) // []JsonPatchOperation | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AuthUsersAPI.PatchAuthUser(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.AuthUsersAPI.PatchAuthUser(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthUsersAPI.PatchAuthUser``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthUser`: AuthUser + fmt.Fprintf(os.Stdout, "Response from `AuthUsersAPI.PatchAuthUser`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/BrandingAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/BrandingAPI.md new file mode 100644 index 000000000..00a0205d0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/BrandingAPI.md @@ -0,0 +1,374 @@ +--- +id: v2024-branding +title: Branding +pagination_label: Branding +sidebar_label: Branding +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Branding', 'V2024Branding'] +slug: /tools/sdk/go/v2024/methods/branding +tags: ['SDK', 'Software Development Kit', 'Branding', 'V2024Branding'] +--- + +# BrandingAPI + Use this API to implement and customize branding functionality. +With this functionality in place, administrators can get and manage existing branding items, and they can also create new branding items and configure them for use throughout Identity Security Cloud. +The Branding APIs provide administrators with a way to customize branding items. +This customization includes details like their colors, logos, and other information. +Refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) for more information about certifications. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-branding-item**](#create-branding-item) | **Post** `/brandings` | Create a branding item +[**delete-branding**](#delete-branding) | **Delete** `/brandings/{name}` | Delete a branding item +[**get-branding**](#get-branding) | **Get** `/brandings/{name}` | Get a branding item +[**get-branding-list**](#get-branding-list) | **Get** `/brandings` | List of branding items +[**set-branding-item**](#set-branding-item) | **Put** `/brandings/{name}` | Update a branding item + + +## create-branding-item +Create a branding item +This API endpoint creates a branding item. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-branding-item) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateBrandingItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **string** | name of branding item | + **productName** | **string** | product name | + **actionButtonColor** | **string** | hex value of color for action button | + **activeLinkColor** | **string** | hex value of color for link | + **navigationColor** | **string** | hex value of color for navigation bar | + **emailFromAddress** | **string** | email from address | + **loginInformationalMessage** | **string** | login information message | + **fileStandard** | ***os.File** | png file with logo | + +### Return type + +[**BrandingItem**](../models/branding-item) + +### 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() { + name := `name_example` // string | name of branding item # string | name of branding item + productName := `productName_example` // string | product name # string | product name + actionButtonColor := `actionButtonColor_example` // string | hex value of color for action button (optional) # string | hex value of color for action button (optional) + activeLinkColor := `activeLinkColor_example` // string | hex value of color for link (optional) # string | hex value of color for link (optional) + navigationColor := `navigationColor_example` // string | hex value of color for navigation bar (optional) # string | hex value of color for navigation bar (optional) + emailFromAddress := `emailFromAddress_example` // string | email from address (optional) # string | email from address (optional) + loginInformationalMessage := `loginInformationalMessage_example` // string | login information message (optional) # string | login information message (optional) + fileStandard := BINARY_DATA_HERE // *os.File | png file with logo (optional) # *os.File | png file with logo (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.BrandingAPI.CreateBrandingItem(context.Background()).Name(name).ProductName(productName).Execute() + //resp, r, err := apiClient.V2024.BrandingAPI.CreateBrandingItem(context.Background()).Name(name).ProductName(productName).ActionButtonColor(actionButtonColor).ActiveLinkColor(activeLinkColor).NavigationColor(navigationColor).EmailFromAddress(emailFromAddress).LoginInformationalMessage(loginInformationalMessage).FileStandard(fileStandard).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.CreateBrandingItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateBrandingItem`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.CreateBrandingItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-branding +Delete a branding item +This API endpoint delete information for an existing branding item by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-branding) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The name of the branding item to be deleted | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteBrandingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `default` // string | The name of the branding item to be deleted # string | The name of the branding item to be deleted + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.BrandingAPI.DeleteBranding(context.Background(), name).Execute() + //r, err := apiClient.V2024.BrandingAPI.DeleteBranding(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.DeleteBranding``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-branding +Get a branding item +This API endpoint retrieves information for an existing branding item by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-branding) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The name of the branding item to be retrieved | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetBrandingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**BrandingItem**](../models/branding-item) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `default` // string | The name of the branding item to be retrieved # string | The name of the branding item to be retrieved + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.BrandingAPI.GetBranding(context.Background(), name).Execute() + //resp, r, err := apiClient.V2024.BrandingAPI.GetBranding(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.GetBranding``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBranding`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.GetBranding`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-branding-list +List of branding items +This API endpoint returns a list of branding items. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-branding-list) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetBrandingListRequest struct via the builder pattern + + +### Return type + +[**[]BrandingItem**](../models/branding-item) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.BrandingAPI.GetBrandingList(context.Background()).Execute() + //resp, r, err := apiClient.V2024.BrandingAPI.GetBrandingList(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.GetBrandingList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBrandingList`: []BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.GetBrandingList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-branding-item +Update a branding item +This API endpoint updates information for an existing branding item. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-branding-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The name of the branding item to be retrieved | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetBrandingItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **name2** | **string** | name of branding item | + **productName** | **string** | product name | + **actionButtonColor** | **string** | hex value of color for action button | + **activeLinkColor** | **string** | hex value of color for link | + **navigationColor** | **string** | hex value of color for navigation bar | + **emailFromAddress** | **string** | email from address | + **loginInformationalMessage** | **string** | login information message | + **fileStandard** | ***os.File** | png file with logo | + +### Return type + +[**BrandingItem**](../models/branding-item) + +### 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() { + name := `default` // string | The name of the branding item to be retrieved # string | The name of the branding item to be retrieved + name2 := `name_example` // string | name of branding item # string | name of branding item + productName := `productName_example` // string | product name # string | product name + actionButtonColor := `actionButtonColor_example` // string | hex value of color for action button (optional) # string | hex value of color for action button (optional) + activeLinkColor := `activeLinkColor_example` // string | hex value of color for link (optional) # string | hex value of color for link (optional) + navigationColor := `navigationColor_example` // string | hex value of color for navigation bar (optional) # string | hex value of color for navigation bar (optional) + emailFromAddress := `emailFromAddress_example` // string | email from address (optional) # string | email from address (optional) + loginInformationalMessage := `loginInformationalMessage_example` // string | login information message (optional) # string | login information message (optional) + fileStandard := BINARY_DATA_HERE // *os.File | png file with logo (optional) # *os.File | png file with logo (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.BrandingAPI.SetBrandingItem(context.Background(), name).Name2(name2).ProductName(productName).Execute() + //resp, r, err := apiClient.V2024.BrandingAPI.SetBrandingItem(context.Background(), name).Name2(name2).ProductName(productName).ActionButtonColor(actionButtonColor).ActiveLinkColor(activeLinkColor).NavigationColor(navigationColor).EmailFromAddress(emailFromAddress).LoginInformationalMessage(loginInformationalMessage).FileStandard(fileStandard).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.SetBrandingItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetBrandingItem`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.SetBrandingItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/CertificationCampaignFiltersAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/CertificationCampaignFiltersAPI.md new file mode 100644 index 000000000..a3c0564b8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/CertificationCampaignFiltersAPI.md @@ -0,0 +1,425 @@ +--- +id: v2024-certification-campaign-filters +title: CertificationCampaignFilters +pagination_label: CertificationCampaignFilters +sidebar_label: CertificationCampaignFilters +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationCampaignFilters', 'V2024CertificationCampaignFilters'] +slug: /tools/sdk/go/v2024/methods/certification-campaign-filters +tags: ['SDK', 'Software Development Kit', 'CertificationCampaignFilters', 'V2024CertificationCampaignFilters'] +--- + +# CertificationCampaignFiltersAPI + Use this API to implement the certification campaign filter functionality. These filters can be used to create a certification campaign that includes a subset of your entitlements or users to certify. + +For example, if for a certification campaign an organization wants to certify only specific users or entitlements, then those can be included/excluded on the basis of campaign filters. + +For more information about creating a campaign filter, refer to [Creating a Campaign Filter](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#creating-a-campaign-filter) + +You can create campaign filters using any of the following criteria types: + +- Access Profile : This criteria type includes or excludes access profiles from a campaign. + +- Account Attribute : This criteria type includes or excludes certification items that match a specified value in an account attribute. + +- Entitlement : This criteria type includes or excludes entitlements from a campaign. + +- Identity : This criteria type includes or excludes specific identities from your campaign. + +- Identity Attribute : This criteria type includes or excludes identities based on whether they have an identity attribute that matches criteria you've chosen. + +- Role : This criteria type includes or excludes roles, as opposed to identities. + +- Source : This criteria type includes or excludes entitlements from a source you select. + +For more information about these criteria types, refer to [Types of Campaign Filters](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#types-of-campaign-filters) + +Once the campaign filter is created, it can be linked while creating the campaign. The generated campaign will have the items to review as per the campaign filter. + +For example, An inclusion campaign filter is created with a source of Source 1, an operation of Equals, and an entitlement of Entitlement 1. When this filter is selected, only users who have Entitlement 1 are included in the campaign, and only Entitlement 1 is shown in the certification. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-campaign-filter**](#create-campaign-filter) | **Post** `/campaign-filters` | Create Campaign Filter +[**delete-campaign-filters**](#delete-campaign-filters) | **Post** `/campaign-filters/delete` | Deletes Campaign Filters +[**get-campaign-filter-by-id**](#get-campaign-filter-by-id) | **Get** `/campaign-filters/{id}` | Get Campaign Filter by ID +[**list-campaign-filters**](#list-campaign-filters) | **Get** `/campaign-filters` | List Campaign Filters +[**update-campaign-filter**](#update-campaign-filter) | **Post** `/campaign-filters/{id}` | Updates a Campaign Filter + + +## create-campaign-filter +Create Campaign Filter +Use this API to create a campaign filter based on filter details and criteria. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-campaign-filter) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCampaignFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaignFilterDetails** | [**CampaignFilterDetails**](../models/campaign-filter-details) | | + +### Return type + +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + campaignfilterdetails := []byte(`{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + }`) // CampaignFilterDetails | + + + var campaignFilterDetails v2024.CampaignFilterDetails + if err := json.Unmarshal(campaignfilterdetails, &campaignFilterDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignFiltersAPI.CreateCampaignFilter(context.Background()).CampaignFilterDetails(campaignFilterDetails).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignFiltersAPI.CreateCampaignFilter(context.Background()).CampaignFilterDetails(campaignFilterDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.CreateCampaignFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaignFilter`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.CreateCampaignFilter`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-campaign-filters +Deletes Campaign Filters +Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-campaign-filters) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCampaignFiltersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestBody** | **[]string** | A json list of IDs of campaign filters to delete. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestbody := []byte(``) // []string | A json list of IDs of campaign filters to delete. + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.CertificationCampaignFiltersAPI.DeleteCampaignFilters(context.Background()).RequestBody(requestBody).Execute() + //r, err := apiClient.V2024.CertificationCampaignFiltersAPI.DeleteCampaignFilters(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.DeleteCampaignFilters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-campaign-filter-by-id +Get Campaign Filter by ID +Retrieves information for an existing campaign filter using the filter's ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-filter-by-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the campaign filter to be retrieved. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignFilterByIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `e9f9a1397b842fd5a65842087040d3ac` // string | The ID of the campaign filter to be retrieved. # string | The ID of the campaign filter to be retrieved. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignFiltersAPI.GetCampaignFilterById(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignFiltersAPI.GetCampaignFilterById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.GetCampaignFilterById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignFilterById`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.GetCampaignFilterById`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-campaign-filters +List Campaign Filters +Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-campaign-filters) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCampaignFiltersRequest struct via the builder pattern + + +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] + **start** | **int32** | Start/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] + **includeSystemFilters** | **bool** | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. | [default to true] + +### Return type + +[**ListCampaignFilters200Response**](../models/list-campaign-filters200-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + start := 0 // int32 | Start/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 | Start/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) + includeSystemFilters := true // bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to true) # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignFiltersAPI.ListCampaignFilters(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignFiltersAPI.ListCampaignFilters(context.Background()).Limit(limit).Start(start).IncludeSystemFilters(includeSystemFilters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.ListCampaignFilters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCampaignFilters`: ListCampaignFilters200Response + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.ListCampaignFilters`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-campaign-filter +Updates a Campaign Filter +Updates an existing campaign filter using the filter's ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-campaign-filter) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**filterId** | **string** | The ID of the campaign filter being modified. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateCampaignFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **campaignFilterDetails** | [**CampaignFilterDetails**](../models/campaign-filter-details) | A campaign filter details with updated field values. | + +### Return type + +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filterId := `e9f9a1397b842fd5a65842087040d3ac` // string | The ID of the campaign filter being modified. # string | The ID of the campaign filter being modified. + campaignfilterdetails := []byte(`{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + }`) // CampaignFilterDetails | A campaign filter details with updated field values. + + + var campaignFilterDetails v2024.CampaignFilterDetails + if err := json.Unmarshal(campaignfilterdetails, &campaignFilterDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignFiltersAPI.UpdateCampaignFilter(context.Background(), filterId).CampaignFilterDetails(campaignFilterDetails).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignFiltersAPI.UpdateCampaignFilter(context.Background(), filterId).CampaignFilterDetails(campaignFilterDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.UpdateCampaignFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCampaignFilter`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.UpdateCampaignFilter`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/CertificationCampaignsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/CertificationCampaignsAPI.md new file mode 100644 index 000000000..6bb0a121f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/CertificationCampaignsAPI.md @@ -0,0 +1,1907 @@ +--- +id: v2024-certification-campaigns +title: CertificationCampaigns +pagination_label: CertificationCampaigns +sidebar_label: CertificationCampaigns +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationCampaigns', 'V2024CertificationCampaigns'] +slug: /tools/sdk/go/v2024/methods/certification-campaigns +tags: ['SDK', 'Software Development Kit', 'CertificationCampaigns', 'V2024CertificationCampaigns'] +--- + +# CertificationCampaignsAPI + Use this API to implement certification campaign functionality. +With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use. +Certification campaigns provide Identity Security Cloud users with an interactive review process they can use to identify and verify access to systems. +Campaigns help organizations reduce risk of inappropriate access and satisfy audit requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers. +Once this campaign has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Identity Security Cloud provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns: + +You can create these types of campaigns without using any search queries in Identity Security Cloud: + +- ManagerCampaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access is certified by their managers. +You only need to provide a name and description to create one. + +- Source Owner Campaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners. +You only need to provide a name and description to create one. +You can specify the sources whose owners you want involved or just run it across all sources. + +For more information about these campaign types, refer to [Starting a Manager or Source Owner Campaign](https://documentation.sailpoint.com/saas/help/certs/starting_campaign.html). + +One useful way to create certification campaigns in Identity Security Cloud is to use a specific search and then run a campaign on the results returned by that search. +This allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns. +For example, you can search for all identities who are managed by "Amanda.Ross" and also have the access to the "Accounting" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified. + +You can use Identity Security Cloud search queries to create these types of campaigns: + +- Identities: Use this campaign type to review and revoke access items for specific identities. +You can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign. + +- Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them. +You can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign. + +- Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria. +You can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign. + +- Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in Identity Security Cloud. +You can use this campaign type to view all the uncorrelated accounts for a source and certify them. + +For more information about search-based campaigns, refer to [Starting a Campaign from Search](https://documentation.sailpoint.com/saas/help/certs/starting_search_campaign.html). + +Once you have generated your campaign, it becomes available for preview. +An administrator can review the campaign and make changes, or if it's ready and accurate, activate it. + +Once the campaign is active, organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed). + +When a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review. +Reviewers can then make decisions to grant or revoke access, as well as reassign the certification to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must "Sign Off" to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. +In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +The end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision. + +For more information about certifications and certification campaigns, refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html). + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**complete-campaign**](#complete-campaign) | **Post** `/campaigns/{id}/complete` | Complete a Campaign +[**create-campaign**](#create-campaign) | **Post** `/campaigns` | Create a campaign +[**create-campaign-template**](#create-campaign-template) | **Post** `/campaign-templates` | Create a Campaign Template +[**delete-campaign-template**](#delete-campaign-template) | **Delete** `/campaign-templates/{id}` | Delete a Campaign Template +[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **Delete** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule +[**delete-campaigns**](#delete-campaigns) | **Post** `/campaigns/delete` | Delete Campaigns +[**get-active-campaigns**](#get-active-campaigns) | **Get** `/campaigns` | List Campaigns +[**get-campaign**](#get-campaign) | **Get** `/campaigns/{id}` | Get Campaign +[**get-campaign-reports**](#get-campaign-reports) | **Get** `/campaigns/{id}/reports` | Get Campaign Reports +[**get-campaign-reports-config**](#get-campaign-reports-config) | **Get** `/campaigns/reports-configuration` | Get Campaign Reports Configuration +[**get-campaign-template**](#get-campaign-template) | **Get** `/campaign-templates/{id}` | Get a Campaign Template +[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **Get** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule +[**get-campaign-templates**](#get-campaign-templates) | **Get** `/campaign-templates` | List Campaign Templates +[**move**](#move) | **Post** `/campaigns/{id}/reassign` | Reassign Certifications +[**patch-campaign-template**](#patch-campaign-template) | **Patch** `/campaign-templates/{id}` | Update a Campaign Template +[**set-campaign-reports-config**](#set-campaign-reports-config) | **Put** `/campaigns/reports-configuration` | Set Campaign Reports Configuration +[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **Put** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule +[**start-campaign**](#start-campaign) | **Post** `/campaigns/{id}/activate` | Activate a Campaign +[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **Post** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan +[**start-campaign-report**](#start-campaign-report) | **Post** `/campaigns/{id}/run-report/{type}` | Run Campaign Report +[**start-generate-campaign-template**](#start-generate-campaign-template) | **Post** `/campaign-templates/{id}/generate` | Generate a Campaign from Template +[**update-campaign**](#update-campaign) | **Patch** `/campaigns/{id}` | Update a Campaign + + +## complete-campaign +Complete a Campaign +:::caution + +This endpoint will run successfully for any campaigns that are **past due**. + +This endpoint will return a content error if the campaign is **not past due**. + +::: + +Use this API to complete a certification campaign. This functionality is provided to admins so that they +can complete a certification even if all items have not been completed. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/complete-campaign) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Campaign ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompleteCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **campaignCompleteOptions** | [**CampaignCompleteOptions**](../models/campaign-complete-options) | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Campaign ID. # string | Campaign ID. + campaigncompleteoptions := []byte(`{ + "autoCompleteAction" : "REVOKE" + }`) // CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.CompleteCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.CompleteCampaign(context.Background(), id).CampaignCompleteOptions(campaignCompleteOptions).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CompleteCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompleteCampaign`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CompleteCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-campaign +Create a campaign +Use this API to create a certification campaign with the information provided in the request body. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-campaign) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaign** | [**Campaign**](../models/campaign) | | + +### Return type + +[**Campaign**](../models/campaign) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + campaign := []byte(`{ + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }`) // Campaign | + + + var campaign v2024.Campaign + if err := json.Unmarshal(campaign, &campaign); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.CreateCampaign(context.Background()).Campaign(campaign).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.CreateCampaign(context.Background()).Campaign(campaign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CreateCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaign`: Campaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CreateCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-campaign-template +Create a Campaign Template +Use this API to create a certification campaign template based on campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-campaign-template) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaignTemplate** | [**CampaignTemplate**](../models/campaign-template) | | + +### Return type + +[**CampaignTemplate**](../models/campaign-template) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + campaigntemplate := []byte(`{ + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + }`) // CampaignTemplate | + + + var campaignTemplate v2024.CampaignTemplate + if err := json.Unmarshal(campaigntemplate, &campaignTemplate); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.CreateCampaignTemplate(context.Background()).CampaignTemplate(campaignTemplate).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.CreateCampaignTemplate(context.Background()).CampaignTemplate(campaignTemplate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CreateCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CreateCampaignTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-campaign-template +Delete a Campaign Template +Use this API to delete a certification campaign template by ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-campaign-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template being deleted. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template being deleted. # string | ID of the campaign template being deleted. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.CertificationCampaignsAPI.DeleteCampaignTemplate(context.Background(), id).Execute() + //r, err := apiClient.V2024.CertificationCampaignsAPI.DeleteCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-campaign-template-schedule +Delete Campaign Template Schedule +Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-campaign-template-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template whose schedule is being deleted. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCampaignTemplateScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template whose schedule is being deleted. # string | ID of the campaign template whose schedule is being deleted. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.CertificationCampaignsAPI.DeleteCampaignTemplateSchedule(context.Background(), id).Execute() + //r, err := apiClient.V2024.CertificationCampaignsAPI.DeleteCampaignTemplateSchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-campaigns +Delete Campaigns +Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-campaigns) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCampaignsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaignsDeleteRequest** | [**CampaignsDeleteRequest**](../models/campaigns-delete-request) | IDs of the campaigns to delete. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + campaignsdeleterequest := []byte(`{ + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + }`) // CampaignsDeleteRequest | IDs of the campaigns to delete. + + + var campaignsDeleteRequest v2024.CampaignsDeleteRequest + if err := json.Unmarshal(campaignsdeleterequest, &campaignsDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).CampaignsDeleteRequest(campaignsDeleteRequest).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).CampaignsDeleteRequest(campaignsDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaigns``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteCampaigns`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.DeleteCampaigns`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-active-campaigns +List Campaigns +Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-active-campaigns) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetActiveCampaignsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **detail** | **string** | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **status**: *eq, in* | + **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, created** | + +### Return type + +[**[]GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Manager Campaign"` // 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* **status**: *eq, in* (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* **status**: *eq, in* (optional) + sorters := `name` // 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, created** (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, created** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetActiveCampaigns(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetActiveCampaigns(context.Background()).Detail(detail).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetActiveCampaigns``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetActiveCampaigns`: []GetActiveCampaigns200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetActiveCampaigns`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign +Get Campaign +Use this API to get information for an existing certification campaign by the campaign's ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign to be retrieved. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **detail** | **string** | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. | + +### Return type + +[**GetCampaign200Response**](../models/get-campaign200-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign to be retrieved. # string | ID of the campaign to be retrieved. + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaign(context.Background(), id).Detail(detail).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaign`: GetCampaign200Response + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-reports +Get Campaign Reports +Use this API to fetch all reports for a certification campaign by campaign ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-reports) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign whose reports are being fetched. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignReportsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]CampaignReport**](../models/campaign-report) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign whose reports are being fetched. # string | ID of the campaign whose reports are being fetched. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignReports(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignReports(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignReports``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignReports`: []CampaignReport + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignReports`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-reports-config +Get Campaign Reports Configuration +Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-reports-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignReportsConfigRequest struct via the builder pattern + + +### Return type + +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignReportsConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignReportsConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignReportsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignReportsConfig`: CampaignReportsConfig + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignReportsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-template +Get a Campaign Template +Use this API to fetch a certification campaign template by ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Requested campaign template's ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CampaignTemplate**](../models/campaign-template) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Requested campaign template's ID. # string | Requested campaign template's ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-template-schedule +Get Campaign Template Schedule +Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-template-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template whose schedule is being fetched. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignTemplateScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Schedule**](../models/schedule) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template whose schedule is being fetched. # string | ID of the campaign template whose schedule is being fetched. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignTemplateSchedule(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignTemplateSchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplateSchedule`: Schedule + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplateSchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-templates +List Campaign Templates +Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. + +The API returns all campaign templates matching the query parameters. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-templates) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignTemplatesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, created, modified** | + **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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* | + +### Return type + +[**[]CampaignTemplate**](../models/campaign-template) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name` // 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, created, modified** (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, created, modified** (optional) + filters := `name eq "manager template"` // 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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignTemplates(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignTemplates(context.Background()).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplates`: []CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplates`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## move +Reassign Certifications +This API reassigns the specified certifications from one identity to another. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/move) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The certification campaign ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiMoveRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **adminReviewReassign** | [**AdminReviewReassign**](../models/admin-review-reassign) | | + +### Return type + +[**CertificationTask**](../models/certification-task) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification campaign ID # string | The certification campaign ID + adminreviewreassign := []byte(`{ + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + }`) // AdminReviewReassign | + + + var adminReviewReassign v2024.AdminReviewReassign + if err := json.Unmarshal(adminreviewreassign, &adminReviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.Move(context.Background(), id).AdminReviewReassign(adminReviewReassign).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.Move(context.Background(), id).AdminReviewReassign(adminReviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.Move``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `Move`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.Move`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-campaign-template +Update a Campaign Template +Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-campaign-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template being modified. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) | + +### Return type + +[**CampaignTemplate**](../models/campaign-template) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template being modified. # string | ID of the campaign template being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/campaign/filter/id, value=ff80818155fe8c080155fe8d925b0316}]`) // []JsonPatchOperation | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.PatchCampaignTemplate(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.PatchCampaignTemplate(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.PatchCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.PatchCampaignTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-campaign-reports-config +Set Campaign Reports Configuration +Use this API to overwrite the configuration for campaign reports. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-campaign-reports-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetCampaignReportsConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaignReportsConfig** | [**CampaignReportsConfig**](../models/campaign-reports-config) | Campaign report configuration. | + +### Return type + +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + campaignreportsconfig := []byte(`{ + "identityAttributeColumns" : [ "firstname", "lastname" ] + }`) // CampaignReportsConfig | Campaign report configuration. + + + var campaignReportsConfig v2024.CampaignReportsConfig + if err := json.Unmarshal(campaignreportsconfig, &campaignReportsConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.SetCampaignReportsConfig(context.Background()).CampaignReportsConfig(campaignReportsConfig).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.SetCampaignReportsConfig(context.Background()).CampaignReportsConfig(campaignReportsConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.SetCampaignReportsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetCampaignReportsConfig`: CampaignReportsConfig + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.SetCampaignReportsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-campaign-template-schedule +Set Campaign Template Schedule +Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-campaign-template-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template being scheduled. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetCampaignTemplateScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schedule** | [**Schedule**](../models/schedule) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template being scheduled. # string | ID of the campaign template being scheduled. + schedule := []byte(`{ + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + }`) // Schedule | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.CertificationCampaignsAPI.SetCampaignTemplateSchedule(context.Background(), id).Execute() + //r, err := apiClient.V2024.CertificationCampaignsAPI.SetCampaignTemplateSchedule(context.Background(), id).Schedule(schedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.SetCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## start-campaign +Activate a Campaign +Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-campaign) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Campaign ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **activateCampaignOptions** | [**ActivateCampaignOptions**](../models/activate-campaign-options) | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Campaign ID. # string | Campaign ID. + activatecampaignoptions := []byte(`{ + "timeZone" : "-05:00" + }`) // ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.StartCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.StartCampaign(context.Background(), id).ActivateCampaignOptions(activateCampaignOptions).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaign`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-campaign-remediation-scan +Run Campaign Remediation Scan +Use this API to run a remediation scan task for a certification campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-campaign-remediation-scan) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign the remediation scan is being run for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartCampaignRemediationScanRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign the remediation scan is being run for. # string | ID of the campaign the remediation scan is being run for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.StartCampaignRemediationScan(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.StartCampaignRemediationScan(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaignRemediationScan``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaignRemediationScan`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaignRemediationScan`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-campaign-report +Run Campaign Report +Use this API to run a report for a certification campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-campaign-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign the report is being run for. | +**type_** | [**ReportType**](../models/) | Type of the report to run. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartCampaignReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign the report is being run for. # string | ID of the campaign the report is being run for. + type_ := // ReportType | Type of the report to run. # ReportType | Type of the report to run. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.StartCampaignReport(context.Background(), id, type_).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.StartCampaignReport(context.Background(), id, type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaignReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaignReport`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaignReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-generate-campaign-template +Generate a Campaign from Template +Use this API to generate a new certification campaign from a campaign template. + +The campaign object contained in the template has special formatting applied to its name and description +fields that determine the generated campaign's name/description. Placeholders in those fields are +formatted with the current date and time upon generation. + +Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For +example, "%Y" inserts the current year, and a campaign template named "Campaign for %y" generates a +campaign called "Campaign for 2020" (assuming the year at generation time is 2020). + +Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-generate-campaign-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template to use for generation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartGenerateCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CampaignReference**](../models/campaign-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template to use for generation. # string | ID of the campaign template to use for generation. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.StartGenerateCampaignTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.StartGenerateCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartGenerateCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartGenerateCampaignTemplate`: CampaignReference + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartGenerateCampaignTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-campaign +Update a Campaign +Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-campaign) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template being modified. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline | + +### Return type + +[**SlimCampaign**](../models/slim-campaign) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign template being modified. # string | ID of the campaign template being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]`) // []JsonPatchOperation | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.UpdateCampaign(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.UpdateCampaign(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.UpdateCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCampaign`: SlimCampaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.UpdateCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/CertificationSummariesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/CertificationSummariesAPI.md new file mode 100644 index 000000000..30803f2d4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/CertificationSummariesAPI.md @@ -0,0 +1,329 @@ +--- +id: v2024-certification-summaries +title: CertificationSummaries +pagination_label: CertificationSummaries +sidebar_label: CertificationSummaries +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationSummaries', 'V2024CertificationSummaries'] +slug: /tools/sdk/go/v2024/methods/certification-summaries +tags: ['SDK', 'Software Development Kit', 'CertificationSummaries', 'V2024CertificationSummaries'] +--- + +# CertificationSummariesAPI + Use this API to implement certification summary functionality. +With this functionality in place, administrators and designated certification reviewers can review summaries of identity certification campaigns and draw conclusions about the campaigns' scope, security, and effectiveness. +Implementing certification summary functionality improves organizations' ability to review their [certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) and helps them satisfy audit and regulatory requirements by enabling them to trace access changes and the decisions made in their review processes. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Certification summaries provide information about identity certification campaigns such as the identities involved, the number of decisions made, and the access changed. +For example, an administrator or designated certification reviewer can examine the Manager Certification campaign to get an overview of how many entitlement decisions are made in that campaign as opposed to role decisions, which identities would be affected by changes to the campaign, and how those identities' access would be affected. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-identity-access-summaries**](#get-identity-access-summaries) | **Get** `/certifications/{id}/access-summaries/{type}` | Access Summaries +[**get-identity-decision-summary**](#get-identity-decision-summary) | **Get** `/certifications/{id}/decision-summary` | Summary of Certification Decisions +[**get-identity-summaries**](#get-identity-summaries) | **Get** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification +[**get-identity-summary**](#get-identity-summary) | **Get** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity + + +## get-identity-access-summaries +Access Summaries +This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-access-summaries) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | +**type_** | **string** | The type of access review item to retrieve summaries for | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityAccessSummariesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* | + **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: **access.name** | + +### Return type + +[**[]AccessSummary**](../models/access-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + type_ := `ACCESS_PROFILE` // string | The type of access review item to retrieve summaries for # string | The type of access review item to retrieve summaries for + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "ef38f94347e94562b5bb8424a56397d8"` // 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters := `access.name` // 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: **access.name** (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: **access.name** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationSummariesAPI.GetIdentityAccessSummaries(context.Background(), id, type_).Execute() + //resp, r, err := apiClient.V2024.CertificationSummariesAPI.GetIdentityAccessSummaries(context.Background(), id, type_).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentityAccessSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityAccessSummaries`: []AccessSummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentityAccessSummaries`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-decision-summary +Summary of Certification Decisions +This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-decision-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityDecisionSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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: **identitySummary.id**: *eq, in* | + +### Return type + +[**IdentityCertDecisionSummary**](../models/identity-cert-decision-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification ID + filters := `identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"` // 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: **identitySummary.id**: *eq, in* (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: **identitySummary.id**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationSummariesAPI.GetIdentityDecisionSummary(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationSummariesAPI.GetIdentityDecisionSummary(context.Background(), id).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentityDecisionSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityDecisionSummary`: IdentityCertDecisionSummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentityDecisionSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-summaries +Identity Summaries for Campaign Certification +This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-summaries) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentitySummariesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **completed**: *eq, ne* **name**: *eq, sw* | + **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** | + +### Return type + +[**[]CertificationIdentitySummary**](../models/certification-identity-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **completed**: *eq, ne* **name**: *eq, sw* (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* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters := `name` // 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** (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** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationSummariesAPI.GetIdentitySummaries(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationSummariesAPI.GetIdentitySummaries(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentitySummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySummaries`: []CertificationIdentitySummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentitySummaries`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-summary +Summary for Identity +This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | +**identitySummaryId** | **string** | The identity summary ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentitySummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**CertificationIdentitySummary**](../models/certification-identity-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + identitySummaryId := `2c91808772a504f50172a9540e501ba8` // string | The identity summary ID # string | The identity summary ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationSummariesAPI.GetIdentitySummary(context.Background(), id, identitySummaryId).Execute() + //resp, r, err := apiClient.V2024.CertificationSummariesAPI.GetIdentitySummary(context.Background(), id, identitySummaryId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentitySummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySummary`: CertificationIdentitySummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentitySummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/CertificationsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/CertificationsAPI.md new file mode 100644 index 000000000..12aa1845f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/CertificationsAPI.md @@ -0,0 +1,875 @@ +--- +id: v2024-certifications +title: Certifications +pagination_label: Certifications +sidebar_label: Certifications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Certifications', 'V2024Certifications'] +slug: /tools/sdk/go/v2024/methods/certifications +tags: ['SDK', 'Software Development Kit', 'Certifications', 'V2024Certifications'] +--- + +# CertificationsAPI + Use this API to implement certification functionality. +With this functionality in place, administrators and designated certification reviewers can review users' access certifications and decide whether to approve access, revoke it, or reassign the review to another reviewer. +Implementing certifications improves organizations' data security by reducing inappropriate access through a distributed review process and helping them satisfy audit and regulatory requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can select the 'Certifications' tab to view any of the certifications they either need to review or have already reviewed under the 'Active' and 'Completed' tabs, respectively. + +When a certification campaign is in progress, certification reviewers will see certifications listed under 'Active,' where they can review the involved identities. +Under the 'Decision' column on the right, next to each access item, reviewers can select the checkmark to approve access, select the 'X' to revoke access, or they can toggle the 'More Options' menu to reassign the certification to another reviewer and provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must select 'Sign Off' to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-certification-task**](#get-certification-task) | **Get** `/certification-tasks/{id}` | Certification Task by ID +[**get-identity-certification**](#get-identity-certification) | **Get** `/certifications/{id}` | Identity Certification by ID +[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **Get** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item +[**get-pending-certification-tasks**](#get-pending-certification-tasks) | **Get** `/certification-tasks` | List of Pending Certification Tasks +[**list-certification-reviewers**](#list-certification-reviewers) | **Get** `/certifications/{id}/reviewers` | List of Reviewers for certification +[**list-identity-access-review-items**](#list-identity-access-review-items) | **Get** `/certifications/{id}/access-review-items` | List of Access Review Items +[**list-identity-certifications**](#list-identity-certifications) | **Get** `/certifications` | List Identity Campaign Certifications +[**make-identity-decision**](#make-identity-decision) | **Post** `/certifications/{id}/decide` | Decide on a Certification Item +[**reassign-identity-certifications**](#reassign-identity-certifications) | **Post** `/certifications/{id}/reassign` | Reassign Identities or Items +[**sign-off-identity-certification**](#sign-off-identity-certification) | **Post** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions +[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **Post** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously + + +## get-certification-task +Certification Task by ID +This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-certification-task) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The task ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCertificationTaskRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CertificationTask**](../models/certification-task) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `63b32151-26c0-42f4-9299-8898dc1c9daa` // string | The task ID # string | The task ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.GetCertificationTask(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.GetCertificationTask(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetCertificationTask``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCertificationTask`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetCertificationTask`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-certification +Identity Certification by ID +This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-certification) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The certification id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityCertificationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification id # string | The certification id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.GetIdentityCertification(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.GetIdentityCertification(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertification`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertification`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-certification-item-permissions +Permissions for Entitlement Certification Item +This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-certification-item-permissions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**certificationId** | **string** | The certification ID | +**itemId** | **string** | The certification item ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityCertificationItemPermissionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]PermissionDto**](../models/permission-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + certificationId := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification ID + itemId := `2c91808671bcbab40171bd945d961227` // string | The certification item ID # string | The certification item ID + filters := `target eq "SYS.OBJAUTH2"` // 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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.GetIdentityCertificationItemPermissions(context.Background(), certificationId, itemId).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.GetIdentityCertificationItemPermissions(context.Background(), certificationId, itemId).Filters(filters).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertificationItemPermissions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertificationItemPermissions`: []PermissionDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertificationItemPermissions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-pending-certification-tasks +List of Pending Certification Tasks +This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-pending-certification-tasks) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPendingCertificationTasksRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **reviewerIdentity** | **string** | The ID of reviewer identity. *me* indicates the current user. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **targetId**: *eq, in* **type**: *eq, in* | + +### Return type + +[**[]CertificationTask**](../models/certification-task) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reviewerIdentity := `Ada.1de82e55078344` // string | The ID of reviewer identity. *me* indicates the current user. (optional) # string | The ID of reviewer identity. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `type eq "ADMIN_REASSIGN"` // 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* **targetId**: *eq, in* **type**: *eq, in* (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* **targetId**: *eq, in* **type**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.GetPendingCertificationTasks(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.GetPendingCertificationTasks(context.Background()).ReviewerIdentity(reviewerIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetPendingCertificationTasks``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPendingCertificationTasks`: []CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetPendingCertificationTasks`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-certification-reviewers +List of Reviewers for certification +This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-certification-reviewers) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCertificationReviewersRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **email**: *eq, sw* | + **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, email** | + +### Return type + +[**[]IdentityReferenceWithNameAndEmail**](../models/identity-reference-with-name-and-email) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Bob"` // 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* **email**: *eq, sw* (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* **email**: *eq, sw* (optional) + sorters := `name` // 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, email** (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, email** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.ListCertificationReviewers(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.ListCertificationReviewers(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListCertificationReviewers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCertificationReviewers`: []IdentityReferenceWithNameAndEmail + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListCertificationReviewers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-access-review-items +List of Access Review Items +This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-access-review-items) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityAccessReviewItemsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* | + **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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** | + **entitlements** | **string** | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. | + **accessProfiles** | **string** | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. | + **roles** | **string** | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. | + +### Return type + +[**[]AccessReviewItem**](../models/access-review-item) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters := `access.name,-accessProfile.sourceName` // 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) + entitlements := `identityEntitlement` // string | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) + accessProfiles := `accessProfile1` // string | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) + roles := `userRole` // string | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.ListIdentityAccessReviewItems(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.ListIdentityAccessReviewItems(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Entitlements(entitlements).AccessProfiles(accessProfiles).Roles(roles).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListIdentityAccessReviewItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityAccessReviewItems`: []AccessReviewItem + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListIdentityAccessReviewItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-certifications +List Identity Campaign Certifications +Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-certifications) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityCertificationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **reviewerIdentity** | **string** | Reviewer's identity. *me* indicates the current user. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *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, due, signed** | + +### Return type + +[**[]IdentityCertificationDto**](../models/identity-certification-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reviewerIdentity := `me` // string | Reviewer's identity. *me* indicates the current user. (optional) # string | Reviewer's identity. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) + sorters := `name,due` // 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, due, signed** (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, due, signed** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.ListIdentityCertifications(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.ListIdentityCertifications(context.Background()).ReviewerIdentity(reviewerIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListIdentityCertifications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityCertifications`: []IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListIdentityCertifications`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## make-identity-decision +Decide on a Certification Item +The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/make-identity-decision) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the identity campaign certification on which to make decisions | + +### Other Parameters + +Other parameters are passed through a pointer to a apiMakeIdentityDecisionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **reviewDecision** | [**[]ReviewDecision**](../models/review-decision) | A non-empty array of decisions to be made. | + +### Return type + +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the identity campaign certification on which to make decisions # string | The ID of the identity campaign certification on which to make decisions + reviewdecision := []byte(`[{id=ef38f94347e94562b5bb8424a56396b5, decision=APPROVE, bulk=true, comments=This user still needs access to this source.}, {id=ef38f94347e94562b5bb8424a56397d8, decision=APPROVE, bulk=true, comments=This user still needs access to this source too.}]`) // []ReviewDecision | A non-empty array of decisions to be made. + + + var reviewDecision v2024.[]ReviewDecision + if err := json.Unmarshal(reviewdecision, &reviewDecision); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.MakeIdentityDecision(context.Background(), id).ReviewDecision(reviewDecision).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.MakeIdentityDecision(context.Background(), id).ReviewDecision(reviewDecision).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.MakeIdentityDecision``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `MakeIdentityDecision`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.MakeIdentityDecision`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reassign-identity-certifications +Reassign Identities or Items +This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reassign-identity-certifications) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiReassignIdentityCertificationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **reviewReassign** | [**ReviewReassign**](../models/review-reassign) | | + +### Return type + +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + reviewreassign := []byte(`{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + }`) // ReviewReassign | + + + var reviewReassign v2024.ReviewReassign + if err := json.Unmarshal(reviewreassign, &reviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.ReassignIdentityCertifications(context.Background(), id).ReviewReassign(reviewReassign).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.ReassignIdentityCertifications(context.Background(), id).ReviewReassign(reviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ReassignIdentityCertifications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ReassignIdentityCertifications`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ReassignIdentityCertifications`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## sign-off-identity-certification +Finalize Identity Certification Decisions +This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/sign-off-identity-certification) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSignOffIdentityCertificationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.SignOffIdentityCertification(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.SignOffIdentityCertification(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.SignOffIdentityCertification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SignOffIdentityCertification`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.SignOffIdentityCertification`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-reassign-certs-async +Reassign Certifications Asynchronously +This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another +reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the +reassignment is complete. + +Reviewers for this certification can also call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-reassign-certs-async) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitReassignCertsAsyncRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **reviewReassign** | [**ReviewReassign**](../models/review-reassign) | | + +### Return type + +[**CertificationTask**](../models/certification-task) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + reviewreassign := []byte(`{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + }`) // ReviewReassign | + + + var reviewReassign v2024.ReviewReassign + if err := json.Unmarshal(reviewreassign, &reviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.SubmitReassignCertsAsync(context.Background(), id).ReviewReassign(reviewReassign).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.SubmitReassignCertsAsync(context.Background(), id).ReviewReassign(reviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.SubmitReassignCertsAsync``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitReassignCertsAsync`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.SubmitReassignCertsAsync`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ConfigurationHubAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ConfigurationHubAPI.md new file mode 100644 index 000000000..a961416a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ConfigurationHubAPI.md @@ -0,0 +1,1465 @@ +--- +id: v2024-configuration-hub +title: ConfigurationHub +pagination_label: ConfigurationHub +sidebar_label: ConfigurationHub +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigurationHub', 'V2024ConfigurationHub'] +slug: /tools/sdk/go/v2024/methods/configuration-hub +tags: ['SDK', 'Software Development Kit', 'ConfigurationHub', 'V2024ConfigurationHub'] +--- + +# ConfigurationHubAPI + Use this API to implement and customize configuration settings management. With this functionality, you can access the Configuration Hub actions and build your own automated pipeline for Identity Security Cloud configuration change delivery and deployment. + +Common usages for Configuration Hub includes: + +- Upload configuration file - Configuration files can be managed and deployed using Configuration Hub by uploading a JSON file which contains configuration data. +- Manage object mapping - Create rules to map and substitute attributes when migrating configurations. +- Manage backups for configuration settings +- Manage configuration drafts +- Upload configurations and manage object mappings between tenants. + +Refer to [Using the SailPoint Configuration Hub](https://documentation.sailpoint.com/saas/help/confighub/config_hub.html) for more information about Configuration Hub. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-deploy**](#create-deploy) | **Post** `/configuration-hub/deploys` | Create a Deploy +[**create-object-mapping**](#create-object-mapping) | **Post** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping +[**create-object-mappings**](#create-object-mappings) | **Post** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings +[**create-scheduled-action**](#create-scheduled-action) | **Post** `/configuration-hub/scheduled-actions` | Create Scheduled Action +[**create-uploaded-configuration**](#create-uploaded-configuration) | **Post** `/configuration-hub/backups/uploads` | Upload a Configuration +[**delete-backup**](#delete-backup) | **Delete** `/configuration-hub/backups/{id}` | Delete a Backup +[**delete-draft**](#delete-draft) | **Delete** `/configuration-hub/drafts/{id}` | Delete a draft +[**delete-object-mapping**](#delete-object-mapping) | **Delete** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping +[**delete-scheduled-action**](#delete-scheduled-action) | **Delete** `/configuration-hub/scheduled-actions/{id}` | Delete Scheduled Action +[**delete-uploaded-configuration**](#delete-uploaded-configuration) | **Delete** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration +[**get-deploy**](#get-deploy) | **Get** `/configuration-hub/deploys/{id}` | Get a Deploy +[**get-object-mappings**](#get-object-mappings) | **Get** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings +[**get-uploaded-configuration**](#get-uploaded-configuration) | **Get** `/configuration-hub/backups/uploads/{id}` | Get an Uploaded Configuration +[**list-backups**](#list-backups) | **Get** `/configuration-hub/backups` | List Backups +[**list-deploys**](#list-deploys) | **Get** `/configuration-hub/deploys` | List Deploys +[**list-drafts**](#list-drafts) | **Get** `/configuration-hub/drafts` | List Drafts +[**list-scheduled-actions**](#list-scheduled-actions) | **Get** `/configuration-hub/scheduled-actions` | List Scheduled Actions +[**list-uploaded-configurations**](#list-uploaded-configurations) | **Get** `/configuration-hub/backups/uploads` | List Uploaded Configurations +[**update-object-mappings**](#update-object-mappings) | **Post** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings +[**update-scheduled-action**](#update-scheduled-action) | **Patch** `/configuration-hub/scheduled-actions/{id}` | Update Scheduled Action + + +## create-deploy +Create a Deploy +This API performs a deploy based on an existing daft. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-deploy) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateDeployRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **deployRequest** | [**DeployRequest**](../models/deploy-request) | The deploy request body. | + +### Return type + +[**DeployResponse**](../models/deploy-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + deployrequest := []byte(`{ + "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" + }`) // DeployRequest | The deploy request body. + + + var deployRequest v2024.DeployRequest + if err := json.Unmarshal(deployrequest, &deployRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateDeploy(context.Background()).DeployRequest(deployRequest).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateDeploy(context.Background()).DeployRequest(deployRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateDeploy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDeploy`: DeployResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateDeploy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-object-mapping +Creates an object mapping +This creates an object mapping between current org and source org. +Source org should be "default" when creating an object mapping that is not to be associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-object-mapping) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceOrg** | **string** | The name of the source org. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateObjectMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **objectMappingRequest** | [**ObjectMappingRequest**](../models/object-mapping-request) | The object mapping request body. | + +### Return type + +[**ObjectMappingResponse**](../models/object-mapping-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingrequest := []byte(`{ + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }`) // ObjectMappingRequest | The object mapping request body. + + + var objectMappingRequest v2024.ObjectMappingRequest + if err := json.Unmarshal(objectmappingrequest, &objectMappingRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateObjectMapping(context.Background(), sourceOrg).ObjectMappingRequest(objectMappingRequest).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateObjectMapping(context.Background(), sourceOrg).ObjectMappingRequest(objectMappingRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateObjectMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateObjectMapping`: ObjectMappingResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateObjectMapping`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-object-mappings +Bulk creates object mappings +This creates a set of object mappings (Max 25) between current org and source org. +Source org should be "default" when creating object mappings that are not to be associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-object-mappings) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceOrg** | **string** | The name of the source org. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateObjectMappingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **objectMappingBulkCreateRequest** | [**ObjectMappingBulkCreateRequest**](../models/object-mapping-bulk-create-request) | The bulk create object mapping request body. | + +### Return type + +[**ObjectMappingBulkCreateResponse**](../models/object-mapping-bulk-create-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingbulkcreaterequest := []byte(`{ + "newObjectsMappings" : [ { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }, { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } ] + }`) // ObjectMappingBulkCreateRequest | The bulk create object mapping request body. + + + var objectMappingBulkCreateRequest v2024.ObjectMappingBulkCreateRequest + if err := json.Unmarshal(objectmappingbulkcreaterequest, &objectMappingBulkCreateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkCreateRequest(objectMappingBulkCreateRequest).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkCreateRequest(objectMappingBulkCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateObjectMappings`: ObjectMappingBulkCreateResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateObjectMappings`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-scheduled-action +Create Scheduled Action +This API creates a new scheduled action for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-scheduled-action) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateScheduledActionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scheduledActionPayload** | [**ScheduledActionPayload**](../models/scheduled-action-payload) | The scheduled action creation request body. | + +### Return type + +[**ScheduledActionResponse**](../models/scheduled-action-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scheduledactionpayload := []byte(`{ + "cronString" : "0 0 12 * * * *", + "timeZoneId" : "America/Chicago", + "startTime" : "2024-08-16T14:16:58.389Z", + "jobType" : "BACKUP", + "content" : { + "sourceTenant" : "tenant-name", + "draftId" : "9012b87d-48ca-439a-868f-2160001da8c3", + "name" : "Daily Backup", + "backupOptions" : { + "includeTypes" : [ "ROLE", "IDENTITY_PROFILE" ], + "objectOptions" : { + "SOURCE" : { + "includedNames" : [ "Source1", "Source2" ] + }, + "ROLE" : { + "includedNames" : [ "Admin Role", "User Role" ] + } + } + }, + "sourceBackupId" : "5678b87d-48ca-439a-868f-2160001da8c2" + } + }`) // ScheduledActionPayload | The scheduled action creation request body. + + + var scheduledActionPayload v2024.ScheduledActionPayload + if err := json.Unmarshal(scheduledactionpayload, &scheduledActionPayload); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateScheduledAction(context.Background()).ScheduledActionPayload(scheduledActionPayload).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateScheduledAction(context.Background()).ScheduledActionPayload(scheduledActionPayload).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateScheduledAction``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateScheduledAction`: ScheduledActionResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateScheduledAction`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-uploaded-configuration +Upload a Configuration +This API uploads a JSON configuration file into a tenant. + +Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. + +Refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects) for more information about supported objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-uploaded-configuration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateUploadedConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **data** | ***os.File** | JSON file containing the objects to be imported. | + **name** | **string** | Name that will be assigned to the uploaded configuration file. | + +### Return type + +[**BackupResponse**](../models/backup-response) + +### 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() { + data := BINARY_DATA_HERE // *os.File | JSON file containing the objects to be imported. # *os.File | JSON file containing the objects to be imported. + name := `name_example` // string | Name that will be assigned to the uploaded configuration file. # string | Name that will be assigned to the uploaded configuration file. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateUploadedConfiguration(context.Background()).Data(data).Name(name).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateUploadedConfiguration(context.Background()).Data(data).Name(name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateUploadedConfiguration`: BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateUploadedConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-backup +Delete a Backup +This API deletes an existing backup for the current tenant. + +On success, this endpoint will return an empty response. + +The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-backup) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the backup to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteBackupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `07659d7d-2cce-47c0-9e49-185787ee565a` // string | The id of the backup to delete. # string | The id of the backup to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ConfigurationHubAPI.DeleteBackup(context.Background(), id).Execute() + //r, err := apiClient.V2024.ConfigurationHubAPI.DeleteBackup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteBackup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-draft +Delete a draft +This API deletes an existing draft for the current tenant. + +On success, this endpoint will return an empty response. + +The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-draft) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the draft to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteDraftRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `07659d7d-2cce-47c0-9e49-185787ee565a` // string | The id of the draft to delete. # string | The id of the draft to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ConfigurationHubAPI.DeleteDraft(context.Background(), id).Execute() + //r, err := apiClient.V2024.ConfigurationHubAPI.DeleteDraft(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteDraft``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-object-mapping +Deletes an object mapping +This deletes an existing object mapping. +Source org should be "default" when deleting an object mapping that is not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-object-mapping) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceOrg** | **string** | The name of the source org. | +**objectMappingId** | **string** | The id of the object mapping to be deleted. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteObjectMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectMappingId := `3d6e0144-963f-4bd6-8d8d-d77b4e507ce4` // string | The id of the object mapping to be deleted. # string | The id of the object mapping to be deleted. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ConfigurationHubAPI.DeleteObjectMapping(context.Background(), sourceOrg, objectMappingId).Execute() + //r, err := apiClient.V2024.ConfigurationHubAPI.DeleteObjectMapping(context.Background(), sourceOrg, objectMappingId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteObjectMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-scheduled-action +Delete Scheduled Action +This API deletes an existing scheduled action. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-scheduled-action) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scheduledActionId** | **string** | The ID of the scheduled action. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteScheduledActionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scheduledActionId := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | The ID of the scheduled action. # string | The ID of the scheduled action. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ConfigurationHubAPI.DeleteScheduledAction(context.Background(), scheduledActionId).Execute() + //r, err := apiClient.V2024.ConfigurationHubAPI.DeleteScheduledAction(context.Background(), scheduledActionId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteScheduledAction``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-uploaded-configuration +Delete an Uploaded Configuration +This API deletes an uploaded configuration based on Id. + +On success, this endpoint will return an empty response. + +The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-uploaded-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the uploaded configuration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteUploadedConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `3d0fe04b-57df-4a46-a83b-8f04b0f9d10b` // string | The id of the uploaded configuration. # string | The id of the uploaded configuration. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ConfigurationHubAPI.DeleteUploadedConfiguration(context.Background(), id).Execute() + //r, err := apiClient.V2024.ConfigurationHubAPI.DeleteUploadedConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-deploy +Get a Deploy +This API gets an existing deploy for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-deploy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the deploy. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDeployRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**DeployResponse**](../models/deploy-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `3d0fe04b-57df-4a46-a83b-8f04b0f9d10b` // string | The id of the deploy. # string | The id of the deploy. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.GetDeploy(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.GetDeploy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.GetDeploy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDeploy`: DeployResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.GetDeploy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-object-mappings +Gets list of object mappings +This gets a list of existing object mappings between current org and source org. +Source org should be "default" when getting object mappings that are not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:read + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-object-mappings) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceOrg** | **string** | The name of the source org. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetObjectMappingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]ObjectMappingResponse**](../models/object-mapping-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.GetObjectMappings(context.Background(), sourceOrg).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.GetObjectMappings(context.Background(), sourceOrg).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.GetObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetObjectMappings`: []ObjectMappingResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.GetObjectMappings`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-uploaded-configuration +Get an Uploaded Configuration +This API gets an existing uploaded configuration for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-uploaded-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the uploaded configuration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetUploadedConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**BackupResponse**](../models/backup-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `3d0fe04b-57df-4a46-a83b-8f04b0f9d10b` // string | The id of the uploaded configuration. # string | The id of the uploaded configuration. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.GetUploadedConfiguration(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.GetUploadedConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.GetUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUploadedConfiguration`: BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.GetUploadedConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-backups +List Backups +This API gets a list of existing backups for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-backups) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListBackupsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **status**: *eq* | + +### Return type + +[**[]BackupResponse**](../models/backup-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `status eq "COMPLETE"` // 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: **status**: *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: **status**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListBackups(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListBackups(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListBackups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListBackups`: []BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListBackups`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-deploys +List Deploys +This API gets a list of deploys for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-deploys) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiListDeploysRequest struct via the builder pattern + + +### Return type + +[**ListDeploys200Response**](../models/list-deploys200-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListDeploys(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListDeploys(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListDeploys``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDeploys`: ListDeploys200Response + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListDeploys`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-drafts +List Drafts +This API gets a list of existing drafts for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-drafts) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListDraftsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **status**: *eq* **approvalStatus**: *eq* | + +### Return type + +[**[]DraftResponse**](../models/draft-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `status eq "COMPLETE"` // 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: **status**: *eq* **approvalStatus**: *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: **status**: *eq* **approvalStatus**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListDrafts(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListDrafts(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListDrafts``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDrafts`: []DraftResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListDrafts`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-scheduled-actions +List Scheduled Actions +This API gets a list of existing scheduled actions for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-scheduled-actions) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiListScheduledActionsRequest struct via the builder pattern + + +### Return type + +[**[]ScheduledActionResponse**](../models/scheduled-action-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListScheduledActions(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListScheduledActions(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListScheduledActions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListScheduledActions`: []ScheduledActionResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListScheduledActions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-uploaded-configurations +List Uploaded Configurations +This API gets a list of existing uploaded configurations for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-uploaded-configurations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListUploadedConfigurationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **status**: *eq* | + +### Return type + +[**[]BackupResponse**](../models/backup-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `status eq "COMPLETE"` // 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: **status**: *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: **status**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListUploadedConfigurations(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListUploadedConfigurations(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListUploadedConfigurations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListUploadedConfigurations`: []BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListUploadedConfigurations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-object-mappings +Bulk updates object mappings +This updates a set of object mappings, only enabled and targetValue fields can be updated. +Source org should be "default" when updating object mappings that are not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-object-mappings) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceOrg** | **string** | The name of the source org. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateObjectMappingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **objectMappingBulkPatchRequest** | [**ObjectMappingBulkPatchRequest**](../models/object-mapping-bulk-patch-request) | The object mapping request body. | + +### Return type + +[**ObjectMappingBulkPatchResponse**](../models/object-mapping-bulk-patch-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingbulkpatchrequest := []byte(`{ + "patches" : { + "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : true + } ], + "00bece34-f50d-4227-8878-76f620b5a971" : [ { + "op" : "replace", + "path" : "/targetValue", + "value" : "New Target Value" + } ] + } + }`) // ObjectMappingBulkPatchRequest | The object mapping request body. + + + var objectMappingBulkPatchRequest v2024.ObjectMappingBulkPatchRequest + if err := json.Unmarshal(objectmappingbulkpatchrequest, &objectMappingBulkPatchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.UpdateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkPatchRequest(objectMappingBulkPatchRequest).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.UpdateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkPatchRequest(objectMappingBulkPatchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.UpdateObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateObjectMappings`: ObjectMappingBulkPatchResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.UpdateObjectMappings`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-scheduled-action +Update Scheduled Action +This API updates an existing scheduled action using JSON Patch format. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-scheduled-action) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scheduledActionId** | **string** | The ID of the scheduled action. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateScheduledActionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatch** | [**JsonPatch**](../models/json-patch) | The JSON Patch document containing the changes to apply to the scheduled action. | + +### Return type + +[**ScheduledActionResponse**](../models/scheduled-action-response) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scheduledActionId := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | The ID of the scheduled action. # string | The ID of the scheduled action. + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | The JSON Patch document containing the changes to apply to the scheduled action. + + + var jsonPatch v2024.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.UpdateScheduledAction(context.Background(), scheduledActionId).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.UpdateScheduledAction(context.Background(), scheduledActionId).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.UpdateScheduledAction``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateScheduledAction`: ScheduledActionResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.UpdateScheduledAction`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorCustomizersAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorCustomizersAPI.md new file mode 100644 index 000000000..866edbbcb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorCustomizersAPI.md @@ -0,0 +1,428 @@ +--- +id: v2024-connector-customizers +title: ConnectorCustomizers +pagination_label: ConnectorCustomizers +sidebar_label: ConnectorCustomizers +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorCustomizers', 'V2024ConnectorCustomizers'] +slug: /tools/sdk/go/v2024/methods/connector-customizers +tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizers', 'V2024ConnectorCustomizers'] +--- + +# ConnectorCustomizersAPI + Saas Connectivity Customizers are cloud-based connector customizers. The customizers allow you to customize the out of the box connectors in a similar way to how you can use rules to customize VA (virtual appliance) based connectors. + +Use these APIs to implement connector customizers functionality. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-connector-customizer**](#create-connector-customizer) | **Post** `/connector-customizers` | Create Connector Customizer +[**create-connector-customizer-version**](#create-connector-customizer-version) | **Post** `/connector-customizers/{id}/versions` | Creates a connector customizer version +[**delete-connector-customizer**](#delete-connector-customizer) | **Delete** `/connector-customizers/{id}` | Delete Connector Customizer +[**get-connector-customizer**](#get-connector-customizer) | **Get** `/connector-customizers/{id}` | Get connector customizer +[**list-connector-customizers**](#list-connector-customizers) | **Get** `/connector-customizers` | List All Connector Customizers +[**put-connector-customizer**](#put-connector-customizer) | **Put** `/connector-customizers/{id}` | Update Connector Customizer + + +## create-connector-customizer +Create Connector Customizer +Create a connector customizer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-connector-customizer) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateConnectorCustomizerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **connectorCustomizerCreateRequest** | [**ConnectorCustomizerCreateRequest**](../models/connector-customizer-create-request) | Connector customizer to create. | + +### Return type + +[**ConnectorCustomizerCreateResponse**](../models/connector-customizer-create-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + connectorcustomizercreaterequest := []byte(`{ + "name" : "My Custom Connector" + }`) // ConnectorCustomizerCreateRequest | Connector customizer to create. + + + var connectorCustomizerCreateRequest v2024.ConnectorCustomizerCreateRequest + if err := json.Unmarshal(connectorcustomizercreaterequest, &connectorCustomizerCreateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.CreateConnectorCustomizer(context.Background()).ConnectorCustomizerCreateRequest(connectorCustomizerCreateRequest).Execute() + //resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.CreateConnectorCustomizer(context.Background()).ConnectorCustomizerCreateRequest(connectorCustomizerCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.CreateConnectorCustomizer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateConnectorCustomizer`: ConnectorCustomizerCreateResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.CreateConnectorCustomizer`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-connector-customizer-version +Creates a connector customizer version +Creates a new version for the customizer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-connector-customizer-version) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the connector customizer. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateConnectorCustomizerVersionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ConnectorCustomizerVersionCreateResponse**](../models/connector-customizer-version-create-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | The id of the connector customizer. # string | The id of the connector customizer. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.CreateConnectorCustomizerVersion(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.CreateConnectorCustomizerVersion(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.CreateConnectorCustomizerVersion``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateConnectorCustomizerVersion`: ConnectorCustomizerVersionCreateResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.CreateConnectorCustomizerVersion`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-connector-customizer +Delete Connector Customizer +Delete the connector customizer for the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-connector-customizer) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the connector customizer to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteConnectorCustomizerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | ID of the connector customizer to delete. # string | ID of the connector customizer to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ConnectorCustomizersAPI.DeleteConnectorCustomizer(context.Background(), id).Execute() + //r, err := apiClient.V2024.ConnectorCustomizersAPI.DeleteConnectorCustomizer(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.DeleteConnectorCustomizer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-connector-customizer +Get connector customizer +Gets connector customizer by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-customizer) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the connector customizer to get. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorCustomizerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ConnectorCustomizersResponse**](../models/connector-customizers-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | ID of the connector customizer to get. # string | ID of the connector customizer to get. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.GetConnectorCustomizer(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.GetConnectorCustomizer(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.GetConnectorCustomizer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorCustomizer`: ConnectorCustomizersResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.GetConnectorCustomizer`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-connector-customizers +List All Connector Customizers +List all connector customizers. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-connector-customizers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListConnectorCustomizersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + +### Return type + +[**[]ConnectorCustomizersResponse**](../models/connector-customizers-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.ListConnectorCustomizers(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.ListConnectorCustomizers(context.Background()).Offset(offset).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.ListConnectorCustomizers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListConnectorCustomizers`: []ConnectorCustomizersResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.ListConnectorCustomizers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-connector-customizer +Update Connector Customizer +Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-customizer) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the connector customizer to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutConnectorCustomizerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **connectorCustomizerUpdateRequest** | [**ConnectorCustomizerUpdateRequest**](../models/connector-customizer-update-request) | Connector rule with updated data. | + +### Return type + +[**ConnectorCustomizerUpdateResponse**](../models/connector-customizer-update-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | ID of the connector customizer to update. # string | ID of the connector customizer to update. + connectorcustomizerupdaterequest := []byte(`{ + "name" : "My Custom Connector" + }`) // ConnectorCustomizerUpdateRequest | Connector rule with updated data. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.PutConnectorCustomizer(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.PutConnectorCustomizer(context.Background(), id).ConnectorCustomizerUpdateRequest(connectorCustomizerUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.PutConnectorCustomizer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorCustomizer`: ConnectorCustomizerUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.PutConnectorCustomizer`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorRuleManagementAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorRuleManagementAPI.md new file mode 100644 index 000000000..9e3fa0866 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorRuleManagementAPI.md @@ -0,0 +1,486 @@ +--- +id: v2024-connector-rule-management +title: ConnectorRuleManagement +pagination_label: ConnectorRuleManagement +sidebar_label: ConnectorRuleManagement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleManagement', 'V2024ConnectorRuleManagement'] +slug: /tools/sdk/go/v2024/methods/connector-rule-management +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleManagement', 'V2024ConnectorRuleManagement'] +--- + +# ConnectorRuleManagementAPI + Use this API to implement connector rule management functionality. +With this functionality in place, administrators can implement connector-executed rules in a programmatic, scalable way. + +In Identity Security Cloud (ISC), [rules](https://developer.sailpoint.com/docs/extensibility/rules) serve as a flexible configuration framework you can leverage to perform complex or advanced configurations. +[Connector-executed rules](https://developer.sailpoint.com/docs/extensibility/rules/connector-rules) are rules that are executed in the ISC virtual appliance (VA), usually extensions of the [connector](https://documentation.sailpoint.com/connectors/isc/landingpages/help/landingpages/isc_landing.html) itself, the bridge between the data source and ISC. + +This API allows administrators to view existing connector-executed rules, make changes to them, delete them, and create new ones from the available types. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-connector-rule**](#create-connector-rule) | **Post** `/connector-rules` | Create Connector Rule +[**delete-connector-rule**](#delete-connector-rule) | **Delete** `/connector-rules/{id}` | Delete Connector Rule +[**get-connector-rule**](#get-connector-rule) | **Get** `/connector-rules/{id}` | Get Connector Rule +[**get-connector-rule-list**](#get-connector-rule-list) | **Get** `/connector-rules` | List Connector Rules +[**put-connector-rule**](#put-connector-rule) | **Put** `/connector-rules/{id}` | Update Connector Rule +[**test-connector-rule**](#test-connector-rule) | **Post** `/connector-rules/validate` | Validate Connector Rule + + +## create-connector-rule +Create Connector Rule +Create a connector rule from the available types. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-connector-rule) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateConnectorRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **connectorRuleCreateRequest** | [**ConnectorRuleCreateRequest**](../models/connector-rule-create-request) | Connector rule to create. | + +### Return type + +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + connectorrulecreaterequest := []byte(`{ + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "type" : "BuildMap" + }`) // ConnectorRuleCreateRequest | Connector rule to create. + + + var connectorRuleCreateRequest v2024.ConnectorRuleCreateRequest + if err := json.Unmarshal(connectorrulecreaterequest, &connectorRuleCreateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.CreateConnectorRule(context.Background()).ConnectorRuleCreateRequest(connectorRuleCreateRequest).Execute() + //resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.CreateConnectorRule(context.Background()).ConnectorRuleCreateRequest(connectorRuleCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.CreateConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.CreateConnectorRule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-connector-rule +Delete Connector Rule +Delete the connector rule for the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-connector-rule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the connector rule to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteConnectorRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to delete. # string | ID of the connector rule to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ConnectorRuleManagementAPI.DeleteConnectorRule(context.Background(), id).Execute() + //r, err := apiClient.V2024.ConnectorRuleManagementAPI.DeleteConnectorRule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.DeleteConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-connector-rule +Get Connector Rule +Get a connector rule by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-rule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the connector rule to get. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to get. # string | ID of the connector rule to get. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.GetConnectorRule(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.GetConnectorRule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.GetConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.GetConnectorRule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-rule-list +List Connector Rules +List existing connector rules. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-rule-list) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorRuleListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]ConnectorRuleResponse**](../models/connector-rule-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.GetConnectorRuleList(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.GetConnectorRuleList(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.GetConnectorRuleList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorRuleList`: []ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.GetConnectorRuleList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-connector-rule +Update Connector Rule +Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-rule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the connector rule to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutConnectorRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **connectorRuleUpdateRequest** | [**ConnectorRuleUpdateRequest**](../models/connector-rule-update-request) | Connector rule with updated data. | + +### Return type + +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to update. # string | ID of the connector rule to update. + connectorruleupdaterequest := []byte(`{ + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", + "type" : "BuildMap" + }`) // ConnectorRuleUpdateRequest | Connector rule with updated data. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.PutConnectorRule(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.PutConnectorRule(context.Background(), id).ConnectorRuleUpdateRequest(connectorRuleUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.PutConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.PutConnectorRule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-connector-rule +Validate Connector Rule +Detect issues within the connector rule's code to fix and list them. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-connector-rule) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestConnectorRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sourceCode** | [**SourceCode**](../models/source-code) | Code to validate. | + +### Return type + +[**ConnectorRuleValidationResponse**](../models/connector-rule-validation-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourcecode := []byte(`{ + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }`) // SourceCode | Code to validate. + + + var sourceCode v2024.SourceCode + if err := json.Unmarshal(sourcecode, &sourceCode); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.TestConnectorRule(context.Background()).SourceCode(sourceCode).Execute() + //resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.TestConnectorRule(context.Background()).SourceCode(sourceCode).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.TestConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestConnectorRule`: ConnectorRuleValidationResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.TestConnectorRule`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorsAPI.md new file mode 100644 index 000000000..44518b27c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ConnectorsAPI.md @@ -0,0 +1,948 @@ +--- +id: v2024-connectors +title: Connectors +pagination_label: Connectors +sidebar_label: Connectors +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Connectors', 'V2024Connectors'] +slug: /tools/sdk/go/v2024/methods/connectors +tags: ['SDK', 'Software Development Kit', 'Connectors', 'V2024Connectors'] +--- + +# ConnectorsAPI + Use this API to implement connector functionality. +With this functionality in place, administrators can view available connectors. + +Connectors are the bridges Identity Security Cloud uses to communicate with and aggregate data from sources. +For example, if it is necessary to set up a connection between Identity Security Cloud and the Active Directory source, a connector can bridge the two and enable Identity Security Cloud to synchronize data between the systems. +This ensures account entitlements and states are correct throughout the organization. + +In Identity Security Cloud, administrators can use the Connections drop-down menu and select Sources to view the available source connectors. + +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in Identity Security Cloud. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources. + +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about using connectors in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-custom-connector**](#create-custom-connector) | **Post** `/connectors` | Create Custom Connector +[**delete-custom-connector**](#delete-custom-connector) | **Delete** `/connectors/{scriptName}` | Delete Connector by Script Name +[**get-connector**](#get-connector) | **Get** `/connectors/{scriptName}` | Get Connector by Script Name +[**get-connector-correlation-config**](#get-connector-correlation-config) | **Get** `/connectors/{scriptName}/correlation-config` | Get Connector Correlation Configuration +[**get-connector-list**](#get-connector-list) | **Get** `/connectors` | Get Connector List +[**get-connector-source-config**](#get-connector-source-config) | **Get** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration +[**get-connector-source-template**](#get-connector-source-template) | **Get** `/connectors/{scriptName}/source-template` | Get Connector Source Template +[**get-connector-translations**](#get-connector-translations) | **Get** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations +[**put-connector-correlation-config**](#put-connector-correlation-config) | **Put** `/connectors/{scriptName}/correlation-config` | Update Connector Correlation Configuration +[**put-connector-source-config**](#put-connector-source-config) | **Put** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration +[**put-connector-source-template**](#put-connector-source-template) | **Put** `/connectors/{scriptName}/source-template` | Update Connector Source Template +[**put-connector-translations**](#put-connector-translations) | **Put** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations +[**update-connector**](#update-connector) | **Patch** `/connectors/{scriptName}` | Update Connector by Script Name + + +## create-custom-connector +Create Custom Connector +Create custom connector. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-custom-connector) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCustomConnectorRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **v3CreateConnectorDto** | [**V3CreateConnectorDto**](../models/v3-create-connector-dto) | | + +### Return type + +[**V3ConnectorDto**](../models/v3-connector-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + v3createconnectordto := []byte(`{ + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + }`) // V3CreateConnectorDto | + + + var v3CreateConnectorDto v2024.V3CreateConnectorDto + if err := json.Unmarshal(v3createconnectordto, &v3CreateConnectorDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.CreateCustomConnector(context.Background()).V3CreateConnectorDto(v3CreateConnectorDto).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.CreateCustomConnector(context.Background()).V3CreateConnectorDto(v3CreateConnectorDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.CreateCustomConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCustomConnector`: V3ConnectorDto + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.CreateCustomConnector`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-custom-connector +Delete Connector by Script Name +Delete a custom connector that using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-custom-connector) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCustomConnectorRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ConnectorsAPI.DeleteCustomConnector(context.Background(), scriptName).Execute() + //r, err := apiClient.V2024.ConnectorsAPI.DeleteCustomConnector(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.DeleteCustomConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-connector +Get Connector by Script Name +Fetches a connector that using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **locale** | **string** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | + +### Return type + +[**ConnectorDetail**](../models/connector-detail) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnector(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnector(context.Background(), scriptName).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnector`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnector`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-correlation-config +Get Connector Correlation Configuration +Fetches a connector's correlation config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-correlation-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorCorrelationConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorCorrelationConfig(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorCorrelationConfig(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorCorrelationConfig`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorCorrelationConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-list +Get Connector List +Fetches list of connectors that have 'RELEASED' status using filtering and pagination. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-list) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **locale** | **string** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | + +### Return type + +[**[]V3ConnectorDto**](../models/v3-connector-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `directConnect eq "true"` // 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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorList(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorList(context.Background()).Filters(filters).Limit(limit).Offset(offset).Count(count).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorList`: []V3ConnectorDto + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-source-config +Get Connector Source Configuration +Fetches a connector's source config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-source-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorSourceConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorSourceConfig(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorSourceConfig(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorSourceConfig`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorSourceConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-source-template +Get Connector Source Template +Fetches a connector's source template using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-source-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorSourceTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorSourceTemplate(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorSourceTemplate(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorSourceTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorSourceTemplate`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorSourceTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-translations +Get Connector Translations +Fetches a connector's translations using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-translations) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. | +**locale** | **string** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorTranslationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorTranslations(context.Background(), scriptName, locale).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorTranslations(context.Background(), scriptName, locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorTranslations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorTranslations`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorTranslations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-connector-correlation-config +Update Connector Correlation Configuration +Update a connector's correlation config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-correlation-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutConnectorCorrelationConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | connector correlation config xml file | + +### Return type + +[**UpdateDetail**](../models/update-detail) + +### 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() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + file := BINARY_DATA_HERE // *os.File | connector correlation config xml file # *os.File | connector correlation config xml file + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.PutConnectorCorrelationConfig(context.Background(), scriptName).File(file).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.PutConnectorCorrelationConfig(context.Background(), scriptName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorCorrelationConfig`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorCorrelationConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-connector-source-config +Update Connector Source Configuration +Update a connector's source config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-source-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutConnectorSourceConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | connector source config xml file | + +### Return type + +[**UpdateDetail**](../models/update-detail) + +### 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() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + file := BINARY_DATA_HERE // *os.File | connector source config xml file # *os.File | connector source config xml file + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.PutConnectorSourceConfig(context.Background(), scriptName).File(file).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.PutConnectorSourceConfig(context.Background(), scriptName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorSourceConfig`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorSourceConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-connector-source-template +Update Connector Source Template +Update a connector's source template using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-source-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutConnectorSourceTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | connector source template xml file | + +### Return type + +[**UpdateDetail**](../models/update-detail) + +### 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() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + file := BINARY_DATA_HERE // *os.File | connector source template xml file # *os.File | connector source template xml file + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.PutConnectorSourceTemplate(context.Background(), scriptName).File(file).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.PutConnectorSourceTemplate(context.Background(), scriptName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorSourceTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorSourceTemplate`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorSourceTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-connector-translations +Update Connector Translations +Update a connector's translations using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-translations) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. | +**locale** | **string** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutConnectorTranslationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**UpdateDetail**](../models/update-detail) + +### 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() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.PutConnectorTranslations(context.Background(), scriptName, locale).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.PutConnectorTranslations(context.Background(), scriptName, locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorTranslations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorTranslations`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorTranslations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-connector +Update Connector by Script Name +This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: + + +* connectorMetadata + +* applicationXml + +* correlationConfigXml + +* sourceConfigXml + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-connector) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateConnectorRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of connector detail update operations | + +### Return type + +[**ConnectorDetail**](../models/connector-detail) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | A list of connector detail update operations + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.UpdateConnector(context.Background(), scriptName).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.UpdateConnector(context.Background(), scriptName).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.UpdateConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateConnector`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.UpdateConnector`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/CustomFormsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/CustomFormsAPI.md new file mode 100644 index 000000000..e64b7906f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/CustomFormsAPI.md @@ -0,0 +1,1381 @@ +--- +id: v2024-custom-forms +title: CustomForms +pagination_label: CustomForms +sidebar_label: CustomForms +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CustomForms', 'V2024CustomForms'] +slug: /tools/sdk/go/v2024/methods/custom-forms +tags: ['SDK', 'Software Development Kit', 'CustomForms', 'V2024CustomForms'] +--- + +# CustomFormsAPI + Use this API to build and manage custom forms. +With this functionality in place, administrators can create and view form definitions and form instances. + +Forms are composed of sections and fields. Sections split the form into logical groups of fields and fields are the data collection points within the form. Configure conditions to modify elements of the form as the responder provides input. Create form inputs to pass information from a calling feature, like a workflow, to your form. + +Forms can be used within workflows as an action or as a trigger. The Form Action allows you to assign a form as a step in a running workflow, suspending the workflow until the form is submitted or times out, and the workflow resumes. The Form Submitted Trigger initiates a workflow when a form is submitted. The trigger can be configured to initiate on submission of a full form, a form element with any value, or a form element with a particular value. + +Refer to [Forms](https://documentation.sailpoint.com/saas/help/forms/index.html) for more information about using forms in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-form-definition**](#create-form-definition) | **Post** `/form-definitions` | Creates a form definition. +[**create-form-definition-dynamic-schema**](#create-form-definition-dynamic-schema) | **Post** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically. +[**create-form-definition-file-request**](#create-form-definition-file-request) | **Post** `/form-definitions/{formDefinitionID}/upload` | Upload new form definition file. +[**create-form-instance**](#create-form-instance) | **Post** `/form-instances` | Creates a form instance. +[**delete-form-definition**](#delete-form-definition) | **Delete** `/form-definitions/{formDefinitionID}` | Deletes a form definition. +[**export-form-definitions-by-tenant**](#export-form-definitions-by-tenant) | **Get** `/form-definitions/export` | List form definitions by tenant. +[**get-file-from-s3**](#get-file-from-s3) | **Get** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileId. +[**get-form-definition-by-key**](#get-form-definition-by-key) | **Get** `/form-definitions/{formDefinitionID}` | Return a form definition. +[**get-form-instance-by-key**](#get-form-instance-by-key) | **Get** `/form-instances/{formInstanceID}` | Returns a form instance. +[**get-form-instance-file**](#get-form-instance-file) | **Get** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileId. +[**import-form-definitions**](#import-form-definitions) | **Post** `/form-definitions/import` | Import form definitions from export. +[**patch-form-definition**](#patch-form-definition) | **Patch** `/form-definitions/{formDefinitionID}` | Patch a form definition. +[**patch-form-instance**](#patch-form-instance) | **Patch** `/form-instances/{formInstanceID}` | Patch a form instance. +[**search-form-definitions-by-tenant**](#search-form-definitions-by-tenant) | **Get** `/form-definitions` | Export form definitions by tenant. +[**search-form-element-data-by-element-id**](#search-form-element-data-by-element-id) | **Get** `/form-instances/{formInstanceID}/data-source/{formElementID}` | Retrieves dynamic data by element. +[**search-form-instances-by-tenant**](#search-form-instances-by-tenant) | **Get** `/form-instances` | List form instances by tenant. +[**search-pre-defined-select-options**](#search-pre-defined-select-options) | **Get** `/form-definitions/predefined-select-options` | List predefined select options. +[**show-preview-data-source**](#show-preview-data-source) | **Post** `/form-definitions/{formDefinitionID}/data-source` | Preview form definition data source. + + +## create-form-definition +Creates a form definition. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateFormDefinitionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | Body is the request payload to create form definition request | + +### Return type + +[**FormDefinitionResponse**](../models/form-definition-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + body := []byte(`{ + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + }`) // CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.CreateFormDefinition(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.CreateFormDefinition(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinition`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinition`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-form-definition-dynamic-schema +Generate JSON Schema dynamically. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition-dynamic-schema) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateFormDefinitionDynamicSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**FormDefinitionDynamicSchemaRequest**](../models/form-definition-dynamic-schema-request) | Body is the request payload to create a form definition dynamic schema | + +### Return type + +[**FormDefinitionDynamicSchemaResponse**](../models/form-definition-dynamic-schema-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + body := []byte(`{ + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 + }`) // FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.CreateFormDefinitionDynamicSchema(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.CreateFormDefinitionDynamicSchema(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinitionDynamicSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinitionDynamicSchema`: FormDefinitionDynamicSchemaResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinitionDynamicSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-form-definition-file-request +Upload new form definition file. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition-file-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | FormDefinitionID String specifying FormDefinitionID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateFormDefinitionFileRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | File specifying the multipart | + +### Return type + +[**FormDefinitionFileUploadResponse**](../models/form-definition-file-upload-response) + +### 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() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | FormDefinitionID String specifying FormDefinitionID # string | FormDefinitionID String specifying FormDefinitionID + file := BINARY_DATA_HERE // *os.File | File specifying the multipart # *os.File | File specifying the multipart + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.CreateFormDefinitionFileRequest(context.Background(), formDefinitionID).File(file).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.CreateFormDefinitionFileRequest(context.Background(), formDefinitionID).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinitionFileRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinitionFileRequest`: FormDefinitionFileUploadResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinitionFileRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-form-instance +Creates a form instance. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-instance) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateFormInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateFormInstanceRequest**](../models/create-form-instance-request) | Body is the request payload to create a form instance | + +### Return type + +[**FormInstanceResponse**](../models/form-instance-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + body := []byte(`{ + "formInput" : { + "input1" : "Sales" + }, + "standAloneForm" : false, + "createdBy" : { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "WORKFLOW_EXECUTION" + }, + "recipients" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + } ], + "expire" : "2023-08-12T20:14:57.74486Z", + "formDefinitionId" : "00000000-0000-0000-0000-000000000000", + "state" : "ASSIGNED", + "ttl" : 1571827560 + }`) // CreateFormInstanceRequest | Body is the request payload to create a form instance (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.CreateFormInstance(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.CreateFormInstance(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormInstance`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormInstance`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-form-definition +Deletes a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-form-definition) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | Form definition ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteFormDefinitionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.DeleteFormDefinition(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.DeleteFormDefinition(context.Background(), formDefinitionID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.DeleteFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteFormDefinition`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.DeleteFormDefinition`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## export-form-definitions-by-tenant +List form definitions by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-form-definitions-by-tenant) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportFormDefinitionsByTenantRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int64** | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. | [default to 0] + **limit** | **int64** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [default to 250] + **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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* | + **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, description, created, modified** | [default to "name"] + +### Return type + +[**[]ExportFormDefinitionsByTenant200ResponseInner**](../models/export-form-definitions-by-tenant200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + offset := 0 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `name sw "my form"` // 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + sorters := `name` // 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, description, created, modified** (optional) (default to "name") # 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, description, created, modified** (optional) (default to "name") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.ExportFormDefinitionsByTenant(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.ExportFormDefinitionsByTenant(context.Background()).Offset(offset).Limit(limit).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ExportFormDefinitionsByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportFormDefinitionsByTenant`: []ExportFormDefinitionsByTenant200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ExportFormDefinitionsByTenant`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-file-from-s3 +Download definition file by fileId. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-file-from-s3) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | FormDefinitionID Form definition ID | +**fileID** | **string** | FileID String specifying the hashed name of the uploaded file we are retrieving. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetFileFromS3Request struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, image/jpeg, image/png, application/octet-stream + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | FormDefinitionID Form definition ID # string | FormDefinitionID Form definition ID + fileID := `00000031N0J7R2B57M8YG73J7M.png` // string | FileID String specifying the hashed name of the uploaded file we are retrieving. # string | FileID String specifying the hashed name of the uploaded file we are retrieving. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.GetFileFromS3(context.Background(), formDefinitionID, fileID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.GetFileFromS3(context.Background(), formDefinitionID, fileID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFileFromS3``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFileFromS3`: *os.File + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFileFromS3`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-form-definition-by-key +Return a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-definition-by-key) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | Form definition ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetFormDefinitionByKeyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**FormDefinitionResponse**](../models/form-definition-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.GetFormDefinitionByKey(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.GetFormDefinitionByKey(context.Background(), formDefinitionID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormDefinitionByKey``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormDefinitionByKey`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormDefinitionByKey`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-form-instance-by-key +Returns a form instance. +Parameter `{formInstanceID}` should match a form instance ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-instance-by-key) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formInstanceID** | **string** | Form instance ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetFormInstanceByKeyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**FormInstanceResponse**](../models/form-instance-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.GetFormInstanceByKey(context.Background(), formInstanceID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.GetFormInstanceByKey(context.Background(), formInstanceID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormInstanceByKey``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormInstanceByKey`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormInstanceByKey`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-form-instance-file +Download instance file by fileId. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-instance-file) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formInstanceID** | **string** | FormInstanceID Form instance ID | +**fileID** | **string** | FileID String specifying the hashed name of the uploaded file we are retrieving. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetFormInstanceFileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, image/jpeg, image/png, application/octet-stream + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | FormInstanceID Form instance ID # string | FormInstanceID Form instance ID + fileID := `00000031N0J7R2B57M8YG73J7M.png` // string | FileID String specifying the hashed name of the uploaded file we are retrieving. # string | FileID String specifying the hashed name of the uploaded file we are retrieving. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.GetFormInstanceFile(context.Background(), formInstanceID, fileID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.GetFormInstanceFile(context.Background(), formInstanceID, fileID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormInstanceFile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormInstanceFile`: *os.File + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormInstanceFile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-form-definitions +Import form definitions from export. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-form-definitions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportFormDefinitionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**[]ImportFormDefinitionsRequestInner**](../models/import-form-definitions-request-inner) | Body is the request payload to import form definitions | + +### Return type + +[**ImportFormDefinitions202Response**](../models/import-form-definitions202-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + body := []byte(`[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]`) // []ImportFormDefinitionsRequestInner | Body is the request payload to import form definitions (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.ImportFormDefinitions(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.ImportFormDefinitions(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ImportFormDefinitions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportFormDefinitions`: ImportFormDefinitions202Response + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ImportFormDefinitions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-form-definition +Patch a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-form-definition) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | Form definition ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchFormDefinitionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | **[]map[string]map[string]interface{}** | Body is the request payload to patch a form definition, check: https://jsonpatch.com | + +### Return type + +[**FormDefinitionResponse**](../models/form-definition-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + body := []byte(`[{op=replace, path=/description, value=test-description}]`) // []map[string]map[string]interface{} | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.PatchFormDefinition(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.PatchFormDefinition(context.Background(), formDefinitionID).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.PatchFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchFormDefinition`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.PatchFormDefinition`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-form-instance +Patch a form instance. +Parameter `{formInstanceID}` should match a form instance ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-form-instance) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formInstanceID** | **string** | Form instance ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchFormInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | **[]map[string]map[string]interface{}** | Body is the request payload to patch a form instance, check: https://jsonpatch.com | + +### Return type + +[**FormInstanceResponse**](../models/form-instance-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + body := []byte(`[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]`) // []map[string]map[string]interface{} | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.PatchFormInstance(context.Background(), formInstanceID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.PatchFormInstance(context.Background(), formInstanceID).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.PatchFormInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchFormInstance`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.PatchFormInstance`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-form-definitions-by-tenant +Export form definitions by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-definitions-by-tenant) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchFormDefinitionsByTenantRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int64** | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. | [default to 0] + **limit** | **int64** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [default to 250] + **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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* | + **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, description, created, modified** | [default to "name"] + +### Return type + +[**ListFormDefinitionsByTenantResponse**](../models/list-form-definitions-by-tenant-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + offset := 250 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `name sw "my form"` // 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + sorters := `name` // 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, description, created, modified** (optional) (default to "name") # 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, description, created, modified** (optional) (default to "name") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.SearchFormDefinitionsByTenant(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.SearchFormDefinitionsByTenant(context.Background()).Offset(offset).Limit(limit).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormDefinitionsByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormDefinitionsByTenant`: ListFormDefinitionsByTenantResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormDefinitionsByTenant`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-form-element-data-by-element-id +Retrieves dynamic data by element. +Parameter `{formInstanceID}` should match a form instance ID. +Parameter `{formElementID}` should match a form element ID at the data source configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-element-data-by-element-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formInstanceID** | **string** | Form instance ID | +**formElementID** | **string** | Form element ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchFormElementDataByElementIDRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **limit** | **int64** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [default to 250] + **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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` | + **query** | **string** | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. | + +### Return type + +[**ListFormElementDataByElementIDResponse**](../models/list-form-element-data-by-element-id-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + formElementID := `1` // string | Form element ID # string | Form element ID + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `value eq "ID01"` // 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) + query := `support` // string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.SearchFormElementDataByElementID(context.Background(), formInstanceID, formElementID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.SearchFormElementDataByElementID(context.Background(), formInstanceID, formElementID).Limit(limit).Filters(filters).Query(query).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormElementDataByElementID``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormElementDataByElementID`: ListFormElementDataByElementIDResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormElementDataByElementID`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-form-instances-by-tenant +List form instances by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-instances-by-tenant) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchFormInstancesByTenantRequest struct via the builder pattern + + +### Return type + +[**[]ListFormInstancesByTenantResponse**](../models/list-form-instances-by-tenant-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.SearchFormInstancesByTenant(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.SearchFormInstancesByTenant(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormInstancesByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormInstancesByTenant`: []ListFormInstancesByTenantResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormInstancesByTenant`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-pre-defined-select-options +List predefined select options. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-pre-defined-select-options) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchPreDefinedSelectOptionsRequest struct via the builder pattern + + +### Return type + +[**ListPredefinedSelectOptionsResponse**](../models/list-predefined-select-options-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.SearchPreDefinedSelectOptions(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.SearchPreDefinedSelectOptions(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchPreDefinedSelectOptions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchPreDefinedSelectOptions`: ListPredefinedSelectOptionsResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchPreDefinedSelectOptions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## show-preview-data-source +Preview form definition data source. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/show-preview-data-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | Form definition ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiShowPreviewDataSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int64** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [default to 10] + **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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` | + **query** | **string** | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. | + **formElementPreviewRequest** | [**FormElementPreviewRequest**](../models/form-element-preview-request) | Body is the request payload to create a form definition dynamic schema | + +### Return type + +[**PreviewDataSourceResponse**](../models/preview-data-source-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + limit := 10 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) + filters := `value eq "ID01"` // 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) + query := `ac` // string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) + formelementpreviewrequest := []byte(`{ + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } + }`) // FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.ShowPreviewDataSource(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.ShowPreviewDataSource(context.Background(), formDefinitionID).Limit(limit).Filters(filters).Query(query).FormElementPreviewRequest(formElementPreviewRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ShowPreviewDataSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ShowPreviewDataSource`: PreviewDataSourceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ShowPreviewDataSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/CustomPasswordInstructionsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/CustomPasswordInstructionsAPI.md new file mode 100644 index 000000000..529a8a592 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/CustomPasswordInstructionsAPI.md @@ -0,0 +1,278 @@ +--- +id: v2024-custom-password-instructions +title: CustomPasswordInstructions +pagination_label: CustomPasswordInstructions +sidebar_label: CustomPasswordInstructions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CustomPasswordInstructions', 'V2024CustomPasswordInstructions'] +slug: /tools/sdk/go/v2024/methods/custom-password-instructions +tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstructions', 'V2024CustomPasswordInstructions'] +--- + +# CustomPasswordInstructionsAPI + Use this API to implement custom password instruction functionality. +With this functionality in place, administrators can create custom password instructions to help users reset their passwords, change them, unlock their accounts, or recover their usernames. +This allows administrators to emphasize password policies or provide organization-specific instructions. + +Administrators must first use [Update Password Org Config](https://developer.sailpoint.com/docs/api/v2024/put-password-org-config/) to set `customInstructionsEnabled` to `true`. + +Once they have enabled custom instructions, they can use [Create Custom Password Instructions](https://developer.sailpoint.com/docs/api/v2024/create-custom-password-instructions/) to create custom page content for the specific pageId they select. + +For example, an administrator can use the pageId forget-username:user-email to set the custom text for the case when users forget their usernames and must enter their emails. + +Refer to [Creating Custom Instruction Text](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html#creating-custom-instruction-text) for more information about creating custom password instructions. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-custom-password-instructions**](#create-custom-password-instructions) | **Post** `/custom-password-instructions` | Create Custom Password Instructions +[**delete-custom-password-instructions**](#delete-custom-password-instructions) | **Delete** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID +[**get-custom-password-instructions**](#get-custom-password-instructions) | **Get** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID + + +## create-custom-password-instructions +:::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 Custom Password Instructions +This API creates the custom password instructions for the specified page ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-custom-password-instructions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCustomPasswordInstructionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **customPasswordInstruction** | [**CustomPasswordInstruction**](../models/custom-password-instruction) | | + +### Return type + +[**CustomPasswordInstruction**](../models/custom-password-instruction) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + custompasswordinstruction := []byte(`{ + "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", + "pageId" : "change-password:enter-password", + "locale" : "en" + }`) // CustomPasswordInstruction | + + + var customPasswordInstruction v2024.CustomPasswordInstruction + if err := json.Unmarshal(custompasswordinstruction, &customPasswordInstruction); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions(context.Background()).XSailPointExperimental(xSailPointExperimental).CustomPasswordInstruction(customPasswordInstruction).Execute() + //resp, r, err := apiClient.V2024.CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions(context.Background()).XSailPointExperimental(xSailPointExperimental).CustomPasswordInstruction(customPasswordInstruction).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCustomPasswordInstructions`: CustomPasswordInstruction + fmt.Fprintf(os.Stdout, "Response from `CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-custom-password-instructions +:::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 Custom Password Instructions by page ID +This API delete the custom password instructions for the specified page ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-custom-password-instructions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**pageId** | **string** | The page ID of custom password instructions to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCustomPasswordInstructionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **locale** | **string** | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + pageId := `mfa:select` // string | The page ID of custom password instructions to delete. # string | The page ID of custom password instructions to delete. + 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") + locale := `locale_example` // string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions(context.Background(), pageId).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions(context.Background(), pageId).XSailPointExperimental(xSailPointExperimental).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-custom-password-instructions +:::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 Custom Password Instructions by Page ID +This API returns the custom password instructions for the specified page ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-custom-password-instructions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**pageId** | **string** | The page ID of custom password instructions to query. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCustomPasswordInstructionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **locale** | **string** | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". | + +### Return type + +[**CustomPasswordInstruction**](../models/custom-password-instruction) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + pageId := `mfa:select` // string | The page ID of custom password instructions to query. # string | The page ID of custom password instructions to query. + 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") + locale := `locale_example` // string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomPasswordInstructionsAPI.GetCustomPasswordInstructions(context.Background(), pageId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.CustomPasswordInstructionsAPI.GetCustomPasswordInstructions(context.Background(), pageId).XSailPointExperimental(xSailPointExperimental).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.GetCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCustomPasswordInstructions`: CustomPasswordInstruction + fmt.Fprintf(os.Stdout, "Response from `CustomPasswordInstructionsAPI.GetCustomPasswordInstructions`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/DataSegmentationAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/DataSegmentationAPI.md new file mode 100644 index 000000000..5fc6fb8c3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/DataSegmentationAPI.md @@ -0,0 +1,669 @@ +--- +id: v2024-data-segmentation +title: DataSegmentation +pagination_label: DataSegmentation +sidebar_label: DataSegmentation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DataSegmentation', 'V2024DataSegmentation'] +slug: /tools/sdk/go/v2024/methods/data-segmentation +tags: ['SDK', 'Software Development Kit', 'DataSegmentation', 'V2024DataSegmentation'] +--- + +# DataSegmentationAPI + This service is responsible for creating segments that will determine how access is delegated to identities +withing the organization. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-data-segment**](#create-data-segment) | **Post** `/data-segments` | Create Segment +[**delete-data-segment**](#delete-data-segment) | **Delete** `/data-segments/{segmentId}` | Delete Segment by ID +[**get-data-segment**](#get-data-segment) | **Get** `/data-segments/{segmentId}` | Get Segment by ID +[**get-data-segment-identity-membership**](#get-data-segment-identity-membership) | **Get** `/data-segments/membership/{identityId}` | Get SegmentMembership by Identity ID +[**get-data-segmentation-enabled-for-user**](#get-data-segmentation-enabled-for-user) | **Get** `/data-segments/user-enabled/{identityId}` | Is Segmentation enabled by Identity +[**list-data-segments**](#list-data-segments) | **Get** `/data-segments` | Get Segments +[**patch-data-segment**](#patch-data-segment) | **Patch** `/data-segments/{segmentId}` | Update Segment +[**publish-data-segment**](#publish-data-segment) | **Post** `/data-segments/{segmentId}` | Publish segment by ID + + +## create-data-segment +Create Segment +This API creates a segment. +>**Note:** Segment definitions may take time to propagate to all identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-data-segment) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateDataSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **dataSegment** | [**DataSegment**](../models/data-segment) | | + +### Return type + +[**DataSegment**](../models/data-segment) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + datasegment := []byte(``) // DataSegment | + + + var dataSegment v2024.DataSegment + if err := json.Unmarshal(datasegment, &dataSegment); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DataSegmentationAPI.CreateDataSegment(context.Background()).DataSegment(dataSegment).Execute() + //resp, r, err := apiClient.V2024.DataSegmentationAPI.CreateDataSegment(context.Background()).DataSegment(dataSegment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.CreateDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDataSegment`: DataSegment + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.CreateDataSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-data-segment +:::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 Segment by ID +This API deletes the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-data-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteDataSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **published** | **bool** | This determines which version of the segment to delete | [default to false] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The segment ID to delete. # string | The segment ID to delete. + 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") + published := false // bool | This determines which version of the segment to delete (optional) (default to false) # bool | This determines which version of the segment to delete (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.DataSegmentationAPI.DeleteDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.DataSegmentationAPI.DeleteDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Published(published).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.DeleteDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-data-segment +:::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 Segment by ID +This API returns the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-data-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDataSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**DataSegment**](../models/data-segment) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The segment ID to retrieve. # string | The segment ID to retrieve. + 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.DataSegmentationAPI.GetDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.DataSegmentationAPI.GetDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.GetDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDataSegment`: DataSegment + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.GetDataSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-data-segment-identity-membership +:::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 SegmentMembership by Identity ID +This API returns the segment membership specified by the given identity ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-data-segment-identity-membership) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | The identity ID to retrieve the segments they are in. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDataSegmentIdentityMembershipRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The identity ID to retrieve the segments they are in. # string | The identity ID to retrieve the segments they are in. + 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.DataSegmentationAPI.GetDataSegmentIdentityMembership(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.DataSegmentationAPI.GetDataSegmentIdentityMembership(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.GetDataSegmentIdentityMembership``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDataSegmentIdentityMembership`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.GetDataSegmentIdentityMembership`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-data-segmentation-enabled-for-user +:::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 + ``` +::: +Is Segmentation enabled by Identity +This API returns whether or not segmentation is enabled for the identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-data-segmentation-enabled-for-user) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | The identity ID to retrieve if segmentation is enabled for the identity. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDataSegmentationEnabledForUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +**bool** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The identity ID to retrieve if segmentation is enabled for the identity. # string | The identity ID to retrieve if segmentation is enabled for the identity. + 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.DataSegmentationAPI.GetDataSegmentationEnabledForUser(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.DataSegmentationAPI.GetDataSegmentationEnabledForUser(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.GetDataSegmentationEnabledForUser``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDataSegmentationEnabledForUser`: bool + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.GetDataSegmentationEnabledForUser`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-data-segments +:::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 Segments +This API returns the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-data-segments) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListDataSegmentsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **enabled** | **bool** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [default to true] + **unique** | **bool** | This returns only one record if set to true and that would be the published record if exists. | [default to false] + **published** | **bool** | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published | [default to true] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, sw* **name**: *eq, in, sw* | + +### Return type + +[**[]DataSegment**](../models/data-segment) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + enabled := true // bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to true) # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to true) + unique := false // bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to false) # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to false) + published := true // bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to true) # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to true) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq ""` // 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, sw* **name**: *eq, in, sw* (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, sw* **name**: *eq, in, sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DataSegmentationAPI.ListDataSegments(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.DataSegmentationAPI.ListDataSegments(context.Background()).XSailPointExperimental(xSailPointExperimental).Enabled(enabled).Unique(unique).Published(published).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.ListDataSegments``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDataSegments`: []DataSegment + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.ListDataSegments`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-data-segment +:::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 Segment +Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-data-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to modify. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchDataSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **requestBody** | **[]map[string]interface{}** | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled | + +### Return type + +[**DataSegment**](../models/data-segment) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The segment ID to modify. # string | The segment ID to modify. + 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") + requestbody := []byte(`[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]`) // []map[string]interface{} | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DataSegmentationAPI.PatchDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2024.DataSegmentationAPI.PatchDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.PatchDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchDataSegment`: DataSegment + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.PatchDataSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## publish-data-segment +:::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 + ``` +::: +Publish segment by ID +This will publish the segment so that it starts applying the segmentation to the desired users if enabled + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/publish-data-segment) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPublishDataSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **requestBody** | **[]string** | A list of segment ids that you wish to publish | + **publishAll** | **bool** | This flag decides whether you want to publish all unpublished or a list of specific segment ids | [default to true] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + requestbody := []byte(``) // []string | A list of segment ids that you wish to publish + publishAll := true // bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to true) # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to true) + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.DataSegmentationAPI.PublishDataSegment(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //r, err := apiClient.V2024.DataSegmentationAPI.PublishDataSegment(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).PublishAll(publishAll).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.PublishDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/DimensionsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/DimensionsAPI.md new file mode 100644 index 000000000..b7019a5d9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/DimensionsAPI.md @@ -0,0 +1,732 @@ +--- +id: v2024-dimensions +title: Dimensions +pagination_label: Dimensions +sidebar_label: Dimensions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Dimensions', 'V2024Dimensions'] +slug: /tools/sdk/go/v2024/methods/dimensions +tags: ['SDK', 'Software Development Kit', 'Dimensions', 'V2024Dimensions'] +--- + +# DimensionsAPI + Use this API to implement and customize dynamic role functionality. With this functionality in place, administrators can create dimensions and configure them for use throughout Identity Security Cloud. Identity Security Cloud can use established criteria to automatically assign the dimensions to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. Entitlements represent the most granular level of access in Identity Security Cloud. +Access profiles represent the next level and often group entitlements. Dimension represent access selectively based on the evaluation of contextual information that is available or provided. Each Dimension include context attributes and access selection expressions which map criteria to access right assignments. Each dimension can contain up to 5 context attributes. Dynamic Access Roles represent the broadest level of access and often group access profiles ,entitlements and dimensions.Each Dynamic Access Role may contain one or more Dimensions. +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-dimension**](#create-dimension) | **Post** `/roles/{roleId}/dimensions` | Create a Dimension +[**delete-bulk-dimensions**](#delete-bulk-dimensions) | **Post** `/roles/{roleId}/dimensions/bulk-delete` | Delete Dimension(s) +[**delete-dimension**](#delete-dimension) | **Delete** `/roles/{roleId}/dimensions/{dimensionId}` | Delete a Dimension +[**get-dimension**](#get-dimension) | **Get** `/roles/{roleId}/dimensions/{dimensionId}` | Get a Dimension under Role. +[**get-dimension-entitlements**](#get-dimension-entitlements) | **Get** `/roles/{roleId}/dimensions/{dimensionId}/entitlements` | List Dimension's Entitlements +[**list-dimension-access-profiles**](#list-dimension-access-profiles) | **Get** `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` | List Dimension's Access Profiles +[**list-dimensions**](#list-dimensions) | **Get** `/roles/{roleId}/dimensions` | List Dimensions +[**patch-dimension**](#patch-dimension) | **Patch** `/roles/{roleId}/dimensions/{dimensionId}` | Patch a specified Dimension + + +## create-dimension +Create a Dimension +This API creates a dimension. +You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. +Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. +The maximum supported length for the description field is 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-dimension) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**roleId** | **string** | Parent Role Id of the dimension. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateDimensionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **dimension** | [**Dimension**](../models/dimension) | | + +### Return type + +[**Dimension**](../models/dimension) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimension := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "name" : "Dimension 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "id" : "2c918086749d78830174a1a40e121518", + "membership" : { + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, + "type" : "STANDARD" + }, + "parentId" : "2c918086749d78830174a1a40e121518" + }`) // Dimension | + + + var dimension v2024.Dimension + if err := json.Unmarshal(dimension, &dimension); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DimensionsAPI.CreateDimension(context.Background(), roleId).Dimension(dimension).Execute() + //resp, r, err := apiClient.V2024.DimensionsAPI.CreateDimension(context.Background(), roleId).Dimension(dimension).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.CreateDimension``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDimension`: Dimension + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.CreateDimension`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-bulk-dimensions +Delete Dimension(s) +This endpoint initiates a bulk deletion of one or more dimensions. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 roles per request. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-bulk-dimensions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**roleId** | **string** | Parent Role Id of the dimensions. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteBulkDimensionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **dimensionBulkDeleteRequest** | [**DimensionBulkDeleteRequest**](../models/dimension-bulk-delete-request) | | + +### Return type + +[**TaskResultDto**](../models/task-result-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimensions. # string | Parent Role Id of the dimensions. + dimensionbulkdeleterequest := []byte(`{ + "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + }`) // DimensionBulkDeleteRequest | + + + var dimensionBulkDeleteRequest v2024.DimensionBulkDeleteRequest + if err := json.Unmarshal(dimensionbulkdeleterequest, &dimensionBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DimensionsAPI.DeleteBulkDimensions(context.Background(), roleId).DimensionBulkDeleteRequest(dimensionBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V2024.DimensionsAPI.DeleteBulkDimensions(context.Background(), roleId).DimensionBulkDeleteRequest(dimensionBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.DeleteBulkDimensions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteBulkDimensions`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.DeleteBulkDimensions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-dimension +Delete a Dimension +This API deletes a Dimension by its ID. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-dimension) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**roleId** | **string** | Parent Role Id of the dimension. | +**dimensionId** | **string** | Id of the Dimension | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteDimensionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.DimensionsAPI.DeleteDimension(context.Background(), roleId, dimensionId).Execute() + //r, err := apiClient.V2024.DimensionsAPI.DeleteDimension(context.Background(), roleId, dimensionId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.DeleteDimension``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-dimension +Get a Dimension under Role. +This API returns a Dimension by its ID. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-dimension) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**roleId** | **string** | Parent Role Id of the dimension. | +**dimensionId** | **string** | Id of the Dimension | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDimensionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Dimension**](../models/dimension) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DimensionsAPI.GetDimension(context.Background(), roleId, dimensionId).Execute() + //resp, r, err := apiClient.V2024.DimensionsAPI.GetDimension(context.Background(), roleId, dimensionId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.GetDimension``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDimension`: Dimension + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.GetDimension`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-dimension-entitlements +List Dimension's Entitlements +This API lists the Entitlements associated with a given dimension. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-dimension-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**roleId** | **string** | Parent Role Id of the dimension. | +**dimensionId** | **string** | Id of the Dimension | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDimensionEntitlementsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* | + **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, attribute, value, created, modified** | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DimensionsAPI.GetDimensionEntitlements(context.Background(), roleId, dimensionId).Execute() + //resp, r, err := apiClient.V2024.DimensionsAPI.GetDimensionEntitlements(context.Background(), roleId, dimensionId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.GetDimensionEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDimensionEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.GetDimensionEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-dimension-access-profiles +List Dimension's Access Profiles +This API lists the Access Profiles associated with a given Dimension + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-dimension-access-profiles) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**roleId** | **string** | Parent Role Id of the dimension. | +**dimensionId** | **string** | Id of the Dimension | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListDimensionAccessProfilesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* | + **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, created, modified** | + +### Return type + +[**[]AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `source.id eq "2c91808982f979270182f99e386d00fa"` // 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DimensionsAPI.ListDimensionAccessProfiles(context.Background(), roleId, dimensionId).Execute() + //resp, r, err := apiClient.V2024.DimensionsAPI.ListDimensionAccessProfiles(context.Background(), roleId, dimensionId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.ListDimensionAccessProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDimensionAccessProfiles`: []AccessProfile + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.ListDimensionAccessProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-dimensions +List Dimensions +This API returns a list of dimensions under a specified role. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-dimensions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**roleId** | **string** | Parent Role Id of the dimension. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListDimensionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **forSubadmin** | **string** | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. | + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* | + **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, created, modified** | + +### Return type + +[**[]Dimension**](../models/dimension) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq '2c918086749d78830174a1a40e121518'` // 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DimensionsAPI.ListDimensions(context.Background(), roleId).Execute() + //resp, r, err := apiClient.V2024.DimensionsAPI.ListDimensions(context.Background(), roleId).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.ListDimensions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDimensions`: []Dimension + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.ListDimensions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-dimension +Patch a specified Dimension +This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +The maximum supported length for the description field is 2000 characters. +When you use this API to modify a dimension's membership identities, you can only modify up to a limit of 500 membership identities at a time. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-dimension) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**roleId** | **string** | Parent Role Id of the dimension. | +**dimensionId** | **string** | Id of the Dimension | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchDimensionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**Dimension**](../models/dimension) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Test Description}, {op=replace, path=/name, value=new name}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DimensionsAPI.PatchDimension(context.Background(), roleId, dimensionId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.DimensionsAPI.PatchDimension(context.Background(), roleId, dimensionId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.PatchDimension``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchDimension`: Dimension + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.PatchDimension`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/EntitlementsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/EntitlementsAPI.md new file mode 100644 index 000000000..eec467b1f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/EntitlementsAPI.md @@ -0,0 +1,1127 @@ +--- +id: v2024-entitlements +title: Entitlements +pagination_label: Entitlements +sidebar_label: Entitlements +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Entitlements', 'V2024Entitlements'] +slug: /tools/sdk/go/v2024/methods/entitlements +tags: ['SDK', 'Software Development Kit', 'Entitlements', 'V2024Entitlements'] +--- + +# EntitlementsAPI + Use this API to implement and customize entitlement functionality. +With this functionality in place, administrators can view entitlements and configure them for use throughout Identity Security Cloud in certifications, access profiles, and roles. +Administrators in Identity Security Cloud can then grant users access to the entitlements or configure them so users themselves can request access to the entitlements whenever they need them. +With a good approval process, this entitlement functionality allows users to gain the specific access they need on sources quickly and securely. + +Entitlements represent access rights on sources. +Entitlements are the most granular form of access in Identity Security Cloud. +Entitlements are often grouped into access profiles, and access profiles themselves are often grouped into roles, the broadest form of access in Identity Security Cloud. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Administrators often use roles and access profiles within those roles to manage access so that users can gain access more quickly, but the hierarchy of access all starts with entitlements. + +Anywhere entitlements appear, you can select them to find more information about the following: + +- Cloud Access Details: These provide details about the cloud access entitlements on cloud-enabled sources. + +- Permissions: Permissions represent individual units of read/write/admin access to a system. + +- Relationships: These list each entitlement's parent and child relationships. + +- Type: This is the entitlement's type. Some sources support multiple types, each with a different attribute schema. + +Identity Security Cloud uses entitlements in many features, including the following: + +- Certifications: Entitlements can be revoked from an identity that no longer needs them. + +- Roles: Roles can group access profiles which themselves group entitlements. You can grant and revoke access on a broad level with roles. Role membership criteria can grant roles to identities based on whether they have certain entitlements or attributes. + +- Access Profiles: Access profiles group entitlements. +They are the most important units of access in Identity Security Cloud. +Identity Security Cloud uses them in provisioning, certifications, and access requests, and administrators can configure them to grant very broad or very granular access. + +You cannot delete entitlements directly from Identity Security Cloud. +Entitlements are deleted based on their inclusion in aggregations. + +Refer to [Deleting Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html#deleting-entitlements) more information about deleting entitlements. + +Refer to [Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html) for more information about entitlements. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-access-model-metadata-for-entitlement**](#create-access-model-metadata-for-entitlement) | **Post** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add metadata to an entitlement. +[**delete-access-model-metadata-from-entitlement**](#delete-access-model-metadata-from-entitlement) | **Delete** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove metadata from an entitlement. +[**get-entitlement**](#get-entitlement) | **Get** `/entitlements/{id}` | Get an entitlement +[**get-entitlement-request-config**](#get-entitlement-request-config) | **Get** `/entitlements/{id}/entitlement-request-config` | Get Entitlement Request Config +[**import-entitlements-by-source**](#import-entitlements-by-source) | **Post** `/entitlements/aggregate/sources/{id}` | Aggregate Entitlements +[**list-entitlement-children**](#list-entitlement-children) | **Get** `/entitlements/{id}/children` | List of entitlements children +[**list-entitlement-parents**](#list-entitlement-parents) | **Get** `/entitlements/{id}/parents` | List of entitlements parents +[**list-entitlements**](#list-entitlements) | **Get** `/entitlements` | Gets a list of entitlements. +[**patch-entitlement**](#patch-entitlement) | **Patch** `/entitlements/{id}` | Patch an entitlement +[**put-entitlement-request-config**](#put-entitlement-request-config) | **Put** `/entitlements/{id}/entitlement-request-config` | Replace Entitlement Request Config +[**reset-source-entitlements**](#reset-source-entitlements) | **Post** `/entitlements/reset/sources/{id}` | Reset Source Entitlements +[**update-entitlements-in-bulk**](#update-entitlements-in-bulk) | **Post** `/entitlements/bulk-update` | Bulk update an entitlement list + + +## create-access-model-metadata-for-entitlement +:::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 + ``` +::: +Add metadata to an entitlement. +Add single Access Model Metadata to an entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-model-metadata-for-entitlement) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The entitlement id. | +**attributeKey** | **string** | Technical name of the Attribute. | +**attributeValue** | **string** | Technical name of the Attribute Value. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAccessModelMetadataForEntitlementRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | The entitlement id. # string | The entitlement id. + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + 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.EntitlementsAPI.CreateAccessModelMetadataForEntitlement(context.Background(), id, attributeKey, attributeValue).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.CreateAccessModelMetadataForEntitlement(context.Background(), id, attributeKey, attributeValue).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.CreateAccessModelMetadataForEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessModelMetadataForEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.CreateAccessModelMetadataForEntitlement`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-access-model-metadata-from-entitlement +:::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 metadata from an entitlement. +Remove single Access Model Metadata from an entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-access-model-metadata-from-entitlement) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The entitlement id. | +**attributeKey** | **string** | Technical name of the Attribute. | +**attributeValue** | **string** | Technical name of the Attribute Value. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccessModelMetadataFromEntitlementRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | The entitlement id. # string | The entitlement id. + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + 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.EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement(context.Background(), id, attributeKey, attributeValue).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement(context.Background(), id, attributeKey, attributeValue).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-entitlement +:::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 an entitlement +This API returns an entitlement by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The entitlement ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808874ff91550175097daaec161c` // string | The entitlement ID # string | The entitlement 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.EntitlementsAPI.GetEntitlement(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.GetEntitlement(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.GetEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.GetEntitlement`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlement-request-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 + ``` +::: +Get Entitlement Request Config +This API returns the entitlement request config for a specified entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-request-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Entitlement Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementRequestConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**EntitlementRequestConfig**](../models/entitlement-request-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808874ff91550175097daaec161c` // string | Entitlement Id # string | Entitlement 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.EntitlementsAPI.GetEntitlementRequestConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.GetEntitlementRequestConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.GetEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementRequestConfig`: EntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.GetEntitlementRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-entitlements-by-source +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::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 + ``` +::: +Aggregate Entitlements +Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). + +If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. + +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`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-entitlements-by-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportEntitlementsBySourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **csvFile** | ***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() { + 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") + csvFile := 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.EntitlementsAPI.ImportEntitlementsBySource(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.ImportEntitlementsBySource(context.Background(), id).XSailPointExperimental(xSailPointExperimental).CsvFile(csvFile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ImportEntitlementsBySource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportEntitlementsBySource`: LoadEntitlementTask + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ImportEntitlementsBySource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-entitlement-children +:::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 of entitlements children +This API returns a list of all child entitlements of a given entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlement-children) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Entitlement Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListEntitlementChildrenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **id, name, created, modified, type, attribute, value, source.id** | + **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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808874ff91550175097daaec161c` // string | Entitlement Id # string | Entitlement 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id** (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: **id, name, created, modified, type, attribute, value, source.id** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.EntitlementsAPI.ListEntitlementChildren(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.ListEntitlementChildren(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlementChildren``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlementChildren`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlementChildren`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-entitlement-parents +:::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 of entitlements parents +This API returns a list of all parent entitlements of a given entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlement-parents) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Entitlement Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListEntitlementParentsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **id, name, created, modified, type, attribute, value, source.id** | + **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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | Entitlement Id # string | Entitlement 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id** (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: **id, name, created, modified, type, attribute, value, source.id** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.EntitlementsAPI.ListEntitlementParents(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.ListEntitlementParents(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlementParents``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlementParents`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlementParents`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-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 + ``` +::: +Gets a list of entitlements. +This API returns a list of entitlements. + +This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). + +Any authenticated token can call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlements) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListEntitlementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **accountId** | **string** | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). | + **segmentedForIdentity** | **string** | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. | + **forSegmentIds** | **string** | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). | + **includeUnsegmented** | **bool** | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. | [default to true] + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **id, name, created, modified, type, attribute, value, source.id, requestable** | + **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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + accountId := `ef38f94347e94562b5bb8424a56397d8` // string | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) # string | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) + segmentedForIdentity := `me` // string | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) # string | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) + forSegmentIds := `041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649` // string | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) # string | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) + includeUnsegmented := true // bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to true) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id, requestable** (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: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.EntitlementsAPI.ListEntitlements(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.ListEntitlements(context.Background()).XSailPointExperimental(xSailPointExperimental).AccountId(accountId).SegmentedForIdentity(segmentedForIdentity).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-entitlement +:::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 + ``` +::: +Patch an entitlement +This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** + +When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-entitlement) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the entitlement to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchEntitlementRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the entitlement to patch # string | ID of the entitlement to patch + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]`) // []JsonPatchOperation | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.EntitlementsAPI.PatchEntitlement(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.PatchEntitlement(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.PatchEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.PatchEntitlement`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-entitlement-request-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 + ``` +::: +Replace Entitlement Request Config +This API replaces the entitlement request config for a specified entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-entitlement-request-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Entitlement ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutEntitlementRequestConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **entitlementRequestConfig** | [**EntitlementRequestConfig**](../models/entitlement-request-config) | | + +### Return type + +[**EntitlementRequestConfig**](../models/entitlement-request-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | Entitlement ID # string | Entitlement 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") + entitlementrequestconfig := []byte(`{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }`) // EntitlementRequestConfig | + + + var entitlementRequestConfig v2024.EntitlementRequestConfig + if err := json.Unmarshal(entitlementrequestconfig, &entitlementRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.EntitlementsAPI.PutEntitlementRequestConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).EntitlementRequestConfig(entitlementRequestConfig).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.PutEntitlementRequestConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).EntitlementRequestConfig(entitlementRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.PutEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutEntitlementRequestConfig`: EntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.PutEntitlementRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reset-source-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 + ``` +::: +Reset Source Entitlements +Remove all entitlements from a specific source. +To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reset-source-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of source for the entitlement reset | + +### Other Parameters + +Other parameters are passed through a pointer to a apiResetSourceEntitlementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of source for the entitlement reset # string | ID of source for the entitlement reset + 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.EntitlementsAPI.ResetSourceEntitlements(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.ResetSourceEntitlements(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ResetSourceEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ResetSourceEntitlements`: EntitlementSourceResetBaseReferenceDto + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ResetSourceEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-entitlements-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 update an entitlement list +"This API applies an update to every entitlement of the list.\n\nThe\ + \ number of entitlements to update is limited to 50 items maximum.\n\nThe JsonPatch\ + \ update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\ + \ allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"\ + value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\"\ + : boolean }**`" + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-entitlements-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateEntitlementsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **entitlementBulkUpdateRequest** | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + entitlementbulkupdaterequest := []byte(`{ + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] + }`) // EntitlementBulkUpdateRequest | + + + var entitlementBulkUpdateRequest v2024.EntitlementBulkUpdateRequest + if err := json.Unmarshal(entitlementbulkupdaterequest, &entitlementBulkUpdateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.EntitlementsAPI.UpdateEntitlementsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).EntitlementBulkUpdateRequest(entitlementBulkUpdateRequest).Execute() + //r, err := apiClient.V2024.EntitlementsAPI.UpdateEntitlementsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).EntitlementBulkUpdateRequest(entitlementBulkUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.UpdateEntitlementsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/GlobalTenantSecuritySettingsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/GlobalTenantSecuritySettingsAPI.md new file mode 100644 index 000000000..eed49bcd5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/GlobalTenantSecuritySettingsAPI.md @@ -0,0 +1,605 @@ +--- +id: v2024-global-tenant-security-settings +title: GlobalTenantSecuritySettings +pagination_label: GlobalTenantSecuritySettings +sidebar_label: GlobalTenantSecuritySettings +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GlobalTenantSecuritySettings', 'V2024GlobalTenantSecuritySettings'] +slug: /tools/sdk/go/v2024/methods/global-tenant-security-settings +tags: ['SDK', 'Software Development Kit', 'GlobalTenantSecuritySettings', 'V2024GlobalTenantSecuritySettings'] +--- + +# GlobalTenantSecuritySettingsAPI + Use this API to implement and customize global tenant security settings. +With this functionality in place, administrators can manage the global security settings that a tenant/org has. +This API can be used to configure the networks and Geographies allowed to access Identity Security Cloud URLs. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-auth-org-network-config**](#create-auth-org-network-config) | **Post** `/auth-org/network-config` | Create security network configuration. +[**get-auth-org-lockout-config**](#get-auth-org-lockout-config) | **Get** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. +[**get-auth-org-network-config**](#get-auth-org-network-config) | **Get** `/auth-org/network-config` | Get security network configuration. +[**get-auth-org-service-provider-config**](#get-auth-org-service-provider-config) | **Get** `/auth-org/service-provider-config` | Get Service Provider Configuration. +[**get-auth-org-session-config**](#get-auth-org-session-config) | **Get** `/auth-org/session-config` | Get Auth Org Session Configuration. +[**patch-auth-org-lockout-config**](#patch-auth-org-lockout-config) | **Patch** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration +[**patch-auth-org-network-config**](#patch-auth-org-network-config) | **Patch** `/auth-org/network-config` | Update security network configuration. +[**patch-auth-org-service-provider-config**](#patch-auth-org-service-provider-config) | **Patch** `/auth-org/service-provider-config` | Update Service Provider Configuration +[**patch-auth-org-session-config**](#patch-auth-org-session-config) | **Patch** `/auth-org/session-config` | Update Auth Org Session Configuration + + +## create-auth-org-network-config +Create security network configuration. +This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:manage' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-auth-org-network-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAuthOrgNetworkConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **networkConfiguration** | [**NetworkConfiguration**](../models/network-configuration) | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. | + +### Return type + +[**NetworkConfiguration**](../models/network-configuration) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + networkconfiguration := []byte(`{ + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] + }`) // NetworkConfiguration | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + + + var networkConfiguration v2024.NetworkConfiguration + if err := json.Unmarshal(networkconfiguration, &networkConfiguration); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig(context.Background()).NetworkConfiguration(networkConfiguration).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig(context.Background()).NetworkConfiguration(networkConfiguration).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-auth-org-lockout-config +Get Auth Org Lockout Configuration. +This API returns the details of an org's lockout auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-lockout-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAuthOrgLockoutConfigRequest struct via the builder pattern + + +### Return type + +[**LockoutConfiguration**](../models/lockout-configuration) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgLockoutConfig`: LockoutConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-auth-org-network-config +Get security network configuration. +This API returns the details of an org's network auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-network-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAuthOrgNetworkConfigRequest struct via the builder pattern + + +### Return type + +[**NetworkConfiguration**](../models/network-configuration) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-auth-org-service-provider-config +Get Service Provider Configuration. +This API returns the details of an org's service provider auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-service-provider-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAuthOrgServiceProviderConfigRequest struct via the builder pattern + + +### Return type + +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgServiceProviderConfig`: ServiceProviderConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-auth-org-session-config +Get Auth Org Session Configuration. +This API returns the details of an org's session auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-session-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAuthOrgSessionConfigRequest struct via the builder pattern + + +### Return type + +[**SessionConfiguration**](../models/session-configuration) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgSessionConfig`: SessionConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-auth-org-lockout-config +Update Auth Org Lockout Configuration +This API updates an existing lockout configuration for an org using PATCH + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-lockout-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAuthOrgLockoutConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` | + +### Return type + +[**LockoutConfiguration**](../models/lockout-configuration) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}]`) // []JsonPatchOperation | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgLockoutConfig`: LockoutConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-auth-org-network-config +Update security network configuration. +This API updates an existing network configuration for an org using PATCH + Requires security scope of: 'sp:auth-org:manage' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-network-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAuthOrgNetworkConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. | + +### Return type + +[**NetworkConfiguration**](../models/network-configuration) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/whitelisted, value=false,}, {op=add, path=/geolocation, value=[AF, HN, ES]}]`) // []JsonPatchOperation | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-auth-org-service-provider-config +Update Service Provider Configuration +This API updates an existing service provider configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-service-provider-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAuthOrgServiceProviderConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) | + +### Return type + +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}]`) // []JsonPatchOperation | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgServiceProviderConfig`: ServiceProviderConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-auth-org-session-config +Update Auth Org Session Configuration +This API updates an existing session configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-session-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAuthOrgSessionConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` | + +### Return type + +[**SessionConfiguration**](../models/session-configuration) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}]`) // []JsonPatchOperation | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgSessionConfig`: SessionConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/GovernanceGroupsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/GovernanceGroupsAPI.md new file mode 100644 index 000000000..ee1965d1c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/GovernanceGroupsAPI.md @@ -0,0 +1,902 @@ +--- +id: v2024-governance-groups +title: GovernanceGroups +pagination_label: GovernanceGroups +sidebar_label: GovernanceGroups +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GovernanceGroups', 'V2024GovernanceGroups'] +slug: /tools/sdk/go/v2024/methods/governance-groups +tags: ['SDK', 'Software Development Kit', 'GovernanceGroups', 'V2024GovernanceGroups'] +--- + +# GovernanceGroupsAPI + Use this API to implement and customize Governance Group functionality. With this functionality in place, administrators can create Governance Groups and configure them for use throughout Identity Security Cloud. + +A governance group is a group of users that can make governance decisions about access. If your organization has the Access Request or Certifications service, you can configure governance groups to review access requests or certifications. A governance group can determine whether specific access is appropriate for a user. + +Refer to [Creating and Managing Governance Groups](https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html) for more information about how to build Governance Groups in the visual builder in the Identity Security Cloud UI. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-workgroup**](#create-workgroup) | **Post** `/workgroups` | Create a new Governance Group. +[**delete-workgroup**](#delete-workgroup) | **Delete** `/workgroups/{id}` | Delete a Governance Group +[**delete-workgroup-members**](#delete-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from Governance Group +[**delete-workgroups-in-bulk**](#delete-workgroups-in-bulk) | **Post** `/workgroups/bulk-delete` | Delete Governance Group(s) +[**get-workgroup**](#get-workgroup) | **Get** `/workgroups/{id}` | Get Governance Group by Id +[**list-connections**](#list-connections) | **Get** `/workgroups/{workgroupId}/connections` | List connections for Governance Group +[**list-workgroup-members**](#list-workgroup-members) | **Get** `/workgroups/{workgroupId}/members` | List Governance Group Members +[**list-workgroups**](#list-workgroups) | **Get** `/workgroups` | List Governance Groups +[**patch-workgroup**](#patch-workgroup) | **Patch** `/workgroups/{id}` | Patch a Governance Group +[**update-workgroup-members**](#update-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group + + +## create-workgroup +:::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 a new Governance Group. +This API creates a new Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-workgroup) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateWorkgroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **workgroupDto** | [**WorkgroupDto**](../models/workgroup-dto) | | + +### Return type + +[**WorkgroupDto**](../models/workgroup-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + workgroupdto := []byte(`{ + "owner" : { + "emailAddress" : "support@sailpoint.com", + "displayName" : "Support", + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "connectionCount" : 1641498673000, + "created" : "2022-01-06T19:51:13Z", + "memberCount" : 1641498673000, + "name" : "DB Access Governance Group", + "description" : "Description of the Governance Group", + "modified" : "2022-01-06T19:51:13Z", + "id" : "2c91808568c529c60168cca6f90c1313" + }`) // WorkgroupDto | + + + var workgroupDto v2024.WorkgroupDto + if err := json.Unmarshal(workgroupdto, &workgroupDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GovernanceGroupsAPI.CreateWorkgroup(context.Background()).XSailPointExperimental(xSailPointExperimental).WorkgroupDto(workgroupDto).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.CreateWorkgroup(context.Background()).XSailPointExperimental(xSailPointExperimental).WorkgroupDto(workgroupDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.CreateWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.CreateWorkgroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-workgroup +:::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 a Governance Group +This API deletes a Governance Group by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroup) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Governance Group | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteWorkgroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + 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.GovernanceGroupsAPI.DeleteWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.GovernanceGroupsAPI.DeleteWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-workgroup-members +:::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 members from Governance Group +This API removes one or more members from a Governance Group. A +> **Following field of Identity is an optional field in the request.** + +> **name** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroup-members) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**workgroupId** | **string** | ID of the Governance Group. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteWorkgroupMembersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **identityPreviewResponseIdentity** | [**[]IdentityPreviewResponseIdentity**](../models/identity-preview-response-identity) | List of identities to be removed from a Governance Group members list. | + +### Return type + +[**[]WorkgroupMemberDeleteItem**](../models/workgroup-member-delete-item) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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") + identitypreviewresponseidentity := []byte(``) // []IdentityPreviewResponseIdentity | List of identities to be removed from a Governance Group members list. + + + var identityPreviewResponseIdentity v2024.[]IdentityPreviewResponseIdentity + if err := json.Unmarshal(identitypreviewresponseidentity, &identityPreviewResponseIdentity); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GovernanceGroupsAPI.DeleteWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).IdentityPreviewResponseIdentity(identityPreviewResponseIdentity).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.DeleteWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).IdentityPreviewResponseIdentity(identityPreviewResponseIdentity).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteWorkgroupMembers`: []WorkgroupMemberDeleteItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.DeleteWorkgroupMembers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-workgroups-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 + ``` +::: +Delete Governance Group(s) + +This API initiates a bulk deletion of one or more Governance Groups. + +> If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. + +> If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. + +> If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. + +> If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. + +> **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroups-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteWorkgroupsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **workgroupBulkDeleteRequest** | [**WorkgroupBulkDeleteRequest**](../models/workgroup-bulk-delete-request) | | + +### Return type + +[**[]WorkgroupDeleteItem**](../models/workgroup-delete-item) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + workgroupbulkdeleterequest := []byte(`{ + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + }`) // WorkgroupBulkDeleteRequest | + + + var workgroupBulkDeleteRequest v2024.WorkgroupBulkDeleteRequest + if err := json.Unmarshal(workgroupbulkdeleterequest, &workgroupBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GovernanceGroupsAPI.DeleteWorkgroupsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).WorkgroupBulkDeleteRequest(workgroupBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.DeleteWorkgroupsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).WorkgroupBulkDeleteRequest(workgroupBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroupsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteWorkgroupsInBulk`: []WorkgroupDeleteItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.DeleteWorkgroupsInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-workgroup +:::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 Governance Group by Id +This API returns a Governance Groups by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workgroup) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Governance Group | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkgroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**WorkgroupDto**](../models/workgroup-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + 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.GovernanceGroupsAPI.GetWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.GetWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.GetWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.GetWorkgroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-connections +:::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 connections for Governance Group +This API returns list of connections associated with a Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-connections) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**workgroupId** | **string** | ID of the Governance Group. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListConnectionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, created, modified** | + +### Return type + +[**[]WorkgroupConnectionDto**](../models/workgroup-connection-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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") + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GovernanceGroupsAPI.ListConnections(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.ListConnections(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListConnections``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListConnections`: []WorkgroupConnectionDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListConnections`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workgroup-members +:::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 Governance Group Members +This API returns list of members associated with a Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workgroup-members) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**workgroupId** | **string** | ID of the Governance Group. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkgroupMembersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, created, modified** | + +### Return type + +[**[]ListWorkgroupMembers200ResponseInner**](../models/list-workgroup-members200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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") + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GovernanceGroupsAPI.ListWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.ListWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkgroupMembers`: []ListWorkgroupMembers200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListWorkgroupMembers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workgroups +:::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 Governance Groups +This API returns list of Governance Groups + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workgroups) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkgroupsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* | + **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, created, modified, id, description** | + +### Return type + +[**[]WorkgroupDto**](../models/workgroup-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw "Test"` // 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, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (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, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) + sorters := `name,-modified` // 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, created, modified, id, description** (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, created, modified, id, description** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GovernanceGroupsAPI.ListWorkgroups(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.ListWorkgroups(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListWorkgroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkgroups`: []WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListWorkgroups`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-workgroup +:::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 + ``` +::: +Patch a Governance Group +This API updates an existing governance group by ID. The following fields and objects are patchable: +* name +* description +* owner + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-workgroup) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Governance Group | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchWorkgroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**WorkgroupDto**](../models/workgroup-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Governance Group new description.}]`) // []JsonPatchOperation | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GovernanceGroupsAPI.PatchWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.PatchWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.PatchWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.PatchWorkgroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-workgroup-members +:::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 + ``` +::: +Add members to Governance Group +This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. + +> **Following field of Identity is an optional field in the request.** + +> **name** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-workgroup-members) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**workgroupId** | **string** | ID of the Governance Group. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateWorkgroupMembersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **identityPreviewResponseIdentity** | [**[]IdentityPreviewResponseIdentity**](../models/identity-preview-response-identity) | List of identities to be added to a Governance Group members list. | + +### Return type + +[**[]WorkgroupMemberAddItem**](../models/workgroup-member-add-item) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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") + identitypreviewresponseidentity := []byte(``) // []IdentityPreviewResponseIdentity | List of identities to be added to a Governance Group members list. + + + var identityPreviewResponseIdentity v2024.[]IdentityPreviewResponseIdentity + if err := json.Unmarshal(identitypreviewresponseidentity, &identityPreviewResponseIdentity); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GovernanceGroupsAPI.UpdateWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).IdentityPreviewResponseIdentity(identityPreviewResponseIdentity).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.UpdateWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).IdentityPreviewResponseIdentity(identityPreviewResponseIdentity).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.UpdateWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateWorkgroupMembers`: []WorkgroupMemberAddItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.UpdateWorkgroupMembers`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IAIAccessRequestRecommendationsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IAIAccessRequestRecommendationsAPI.md new file mode 100644 index 000000000..e4e13e61d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IAIAccessRequestRecommendationsAPI.md @@ -0,0 +1,868 @@ +--- +id: v2024-iai-access-request-recommendations +title: IAIAccessRequestRecommendations +pagination_label: IAIAccessRequestRecommendations +sidebar_label: IAIAccessRequestRecommendations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAIAccessRequestRecommendations', 'V2024IAIAccessRequestRecommendations'] +slug: /tools/sdk/go/v2024/methods/iai-access-request-recommendations +tags: ['SDK', 'Software Development Kit', 'IAIAccessRequestRecommendations', 'V2024IAIAccessRequestRecommendations'] +--- + +# IAIAccessRequestRecommendationsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add-access-request-recommendations-ignored-item**](#add-access-request-recommendations-ignored-item) | **Post** `/ai-access-request-recommendations/ignored-items` | Ignore Access Request Recommendation +[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **Post** `/ai-access-request-recommendations/requested-items` | Accept Access Request Recommendation +[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **Post** `/ai-access-request-recommendations/viewed-items` | Mark Viewed Access Request Recommendations +[**add-access-request-recommendations-viewed-items**](#add-access-request-recommendations-viewed-items) | **Post** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk Mark Viewed Access Request Recommendations +[**get-access-request-recommendations**](#get-access-request-recommendations) | **Get** `/ai-access-request-recommendations` | Identity Access Request Recommendations +[**get-access-request-recommendations-config**](#get-access-request-recommendations-config) | **Get** `/ai-access-request-recommendations/config` | Get Access Request Recommendations config +[**get-access-request-recommendations-ignored-items**](#get-access-request-recommendations-ignored-items) | **Get** `/ai-access-request-recommendations/ignored-items` | List Ignored Access Request Recommendations +[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **Get** `/ai-access-request-recommendations/requested-items` | List Accepted Access Request Recommendations +[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **Get** `/ai-access-request-recommendations/viewed-items` | List Viewed Access Request Recommendations +[**set-access-request-recommendations-config**](#set-access-request-recommendations-config) | **Put** `/ai-access-request-recommendations/config` | Update Access Request Recommendations config + + +## add-access-request-recommendations-ignored-item +:::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 + ``` +::: +Ignore Access Request Recommendation +This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-ignored-item) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddAccessRequestRecommendationsIgnoredItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **accessRequestRecommendationActionItemDto** | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | The recommended access item to ignore for an identity. | + +### Return type + +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity. + + + var accessRequestRecommendationActionItemDto v2024.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsIgnoredItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## add-access-request-recommendations-requested-item +:::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 + ``` +::: +Accept Access Request Recommendation +This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-requested-item) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddAccessRequestRecommendationsRequestedItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **accessRequestRecommendationActionItemDto** | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | The recommended access item that was requested for an identity. | + +### Return type + +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity. + + + var accessRequestRecommendationActionItemDto v2024.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsRequestedItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## add-access-request-recommendations-viewed-item +:::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 + ``` +::: +Mark Viewed Access Request Recommendations +This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-viewed-item) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddAccessRequestRecommendationsViewedItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **accessRequestRecommendationActionItemDto** | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | The recommended access that was viewed for an identity. | + +### Return type + +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity. + + + var accessRequestRecommendationActionItemDto v2024.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsViewedItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## add-access-request-recommendations-viewed-items +:::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 Mark Viewed Access Request Recommendations +This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-viewed-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddAccessRequestRecommendationsViewedItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **accessRequestRecommendationActionItemDto** | [**[]AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | The recommended access items that were viewed for an identity. | + +### Return type + +[**[]AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + accessrequestrecommendationactionitemdto := []byte(``) // []AccessRequestRecommendationActionItemDto | The recommended access items that were viewed for an identity. + + + var accessRequestRecommendationActionItemDto v2024.[]AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsViewedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-recommendations +:::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 Access Request Recommendations +This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestRecommendationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **identityId** | **string** | Get access request recommendations for an identityId. *me* indicates the current user. | [default to "me"] + **limit** | **int32** | Max number of results to return. | [default to 15] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **includeTranslationMessages** | **bool** | If *true* it will populate a list of translation messages in the response. | [default to false] + **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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* | + **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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. | + +### Return type + +[**[]AccessRequestRecommendationItemDetail**](../models/access-request-recommendation-item-detail) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + identityId := `2c91808570313110017040b06f344ec9` // string | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") # string | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") + limit := 15 // int32 | Max number of results to return. (optional) (default to 15) # int32 | Max number of results to return. (optional) (default to 15) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + includeTranslationMessages := false // bool | If *true* it will populate a list of translation messages in the response. (optional) (default to false) # bool | If *true* it will populate a list of translation messages in the response. (optional) (default to false) + filters := `access.name co "admin"` // 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) + sorters := `access.name` // 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityId(identityId).Limit(limit).Offset(offset).Count(count).IncludeTranslationMessages(includeTranslationMessages).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendations`: []AccessRequestRecommendationItemDetail + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-recommendations-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 + ``` +::: +Get Access Request Recommendations config +This API returns the configurations for Access Request Recommender for the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestRecommendationsConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsConfig`: AccessRequestRecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-recommendations-ignored-items +:::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 Ignored Access Request Recommendations +This API returns the list of ignored access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-ignored-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestRecommendationsIgnoredItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* | + **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: **access.id, access.type, identityId, timestamp** | + +### Return type + +[**[]AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `identityId eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsIgnoredItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-recommendations-requested-items +:::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 Accepted Access Request Recommendations +This API returns a list of requested access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-requested-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestRecommendationsRequestedItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* | + **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: **access.id, access.type, identityId, timestamp** | + +### Return type + +[**[]AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsRequestedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-recommendations-viewed-items +:::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 Viewed Access Request Recommendations +This API returns the list of viewed access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-viewed-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestRecommendationsViewedItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* | + **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: **access.id, access.type, identityId, timestamp** | + +### Return type + +[**[]AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsViewedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-access-request-recommendations-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 Access Request Recommendations config +This API updates the configurations for Access Request Recommender for the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-access-request-recommendations-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetAccessRequestRecommendationsConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **accessRequestRecommendationConfigDto** | [**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) | The desired configurations for Access Request Recommender for the tenant. | + +### Return type + +[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + accessrequestrecommendationconfigdto := []byte(`{ + "scoreThreshold" : 0.5, + "startDateAttribute" : "startDate", + "restrictionAttribute" : "location", + "moverAttribute" : "isMover", + "joinerAttribute" : "isJoiner", + "useRestrictionAttribute" : true + }`) // AccessRequestRecommendationConfigDto | The desired configurations for Access Request Recommender for the tenant. + + + var accessRequestRecommendationConfigDto v2024.AccessRequestRecommendationConfigDto + if err := json.Unmarshal(accessrequestrecommendationconfigdto, &accessRequestRecommendationConfigDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.SetAccessRequestRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationConfigDto(accessRequestRecommendationConfigDto).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.SetAccessRequestRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationConfigDto(accessRequestRecommendationConfigDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.SetAccessRequestRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetAccessRequestRecommendationsConfig`: AccessRequestRecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.SetAccessRequestRecommendationsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IAICommonAccessAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IAICommonAccessAPI.md new file mode 100644 index 000000000..828f859eb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IAICommonAccessAPI.md @@ -0,0 +1,277 @@ +--- +id: v2024-iai-common-access +title: IAICommonAccess +pagination_label: IAICommonAccess +sidebar_label: IAICommonAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAICommonAccess', 'V2024IAICommonAccess'] +slug: /tools/sdk/go/v2024/methods/iai-common-access +tags: ['SDK', 'Software Development Kit', 'IAICommonAccess', 'V2024IAICommonAccess'] +--- + +# IAICommonAccessAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-common-access**](#create-common-access) | **Post** `/common-access` | Create common access items +[**get-common-access**](#get-common-access) | **Get** `/common-access` | Get a paginated list of common access +[**update-common-access-status-in-bulk**](#update-common-access-status-in-bulk) | **Post** `/common-access/update-status` | Bulk update common access status + + +## create-common-access +:::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 common access items +This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-common-access) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCommonAccessRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **commonAccessItemRequest** | [**CommonAccessItemRequest**](../models/common-access-item-request) | | + +### Return type + +[**CommonAccessItemResponse**](../models/common-access-item-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + commonaccessitemrequest := []byte(`{ + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" + }`) // CommonAccessItemRequest | + + + var commonAccessItemRequest v2024.CommonAccessItemRequest + if err := json.Unmarshal(commonaccessitemrequest, &commonAccessItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAICommonAccessAPI.CreateCommonAccess(context.Background()).XSailPointExperimental(xSailPointExperimental).CommonAccessItemRequest(commonAccessItemRequest).Execute() + //resp, r, err := apiClient.V2024.IAICommonAccessAPI.CreateCommonAccess(context.Background()).XSailPointExperimental(xSailPointExperimental).CommonAccessItemRequest(commonAccessItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.CreateCommonAccess``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCommonAccess`: CommonAccessItemResponse + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.CreateCommonAccess`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-common-access +:::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 a paginated list of common access +This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-common-access) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCommonAccessRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, 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: **access.name, status** By default the common access items are sorted by name, ascending. | + +### Return type + +[**[]CommonAccessResponse**](../models/common-access-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.type eq "ROLE"` // 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) + sorters := `access.name` // 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: **access.name, status** By default the common access items are sorted by name, ascending. (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: **access.name, status** By default the common access items are sorted by name, ascending. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAICommonAccessAPI.GetCommonAccess(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAICommonAccessAPI.GetCommonAccess(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.GetCommonAccess``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCommonAccess`: []CommonAccessResponse + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.GetCommonAccess`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-common-access-status-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 update common access status +This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-common-access-status-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateCommonAccessStatusInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **commonAccessIDStatus** | [**[]CommonAccessIDStatus**](../models/common-access-id-status) | Confirm or deny in bulk the common access ids that are (or aren't) common access | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + commonaccessidstatus := []byte(``) // []CommonAccessIDStatus | Confirm or deny in bulk the common access ids that are (or aren't) common access + + + var commonAccessIDStatus v2024.[]CommonAccessIDStatus + if err := json.Unmarshal(commonaccessidstatus, &commonAccessIDStatus); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAICommonAccessAPI.UpdateCommonAccessStatusInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).CommonAccessIDStatus(commonAccessIDStatus).Execute() + //resp, r, err := apiClient.V2024.IAICommonAccessAPI.UpdateCommonAccessStatusInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).CommonAccessIDStatus(commonAccessIDStatus).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.UpdateCommonAccessStatusInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCommonAccessStatusInBulk`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.UpdateCommonAccessStatusInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IAIOutliersAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IAIOutliersAPI.md new file mode 100644 index 000000000..c842b7f56 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IAIOutliersAPI.md @@ -0,0 +1,776 @@ +--- +id: v2024-iai-outliers +title: IAIOutliers +pagination_label: IAIOutliers +sidebar_label: IAIOutliers +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAIOutliers', 'V2024IAIOutliers'] +slug: /tools/sdk/go/v2024/methods/iai-outliers +tags: ['SDK', 'Software Development Kit', 'IAIOutliers', 'V2024IAIOutliers'] +--- + +# IAIOutliersAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**export-outliers-zip**](#export-outliers-zip) | **Get** `/outliers/export` | IAI Identity Outliers Export +[**get-identity-outlier-snapshots**](#get-identity-outlier-snapshots) | **Get** `/outlier-summaries` | IAI Identity Outliers Summary +[**get-identity-outliers**](#get-identity-outliers) | **Get** `/outliers` | IAI Get Identity Outliers +[**get-latest-identity-outlier-snapshots**](#get-latest-identity-outlier-snapshots) | **Get** `/outlier-summaries/latest` | IAI Identity Outliers Latest Summary +[**get-outlier-contributing-feature-summary**](#get-outlier-contributing-feature-summary) | **Get** `/outlier-feature-summaries/{outlierFeatureId}` | Get identity outlier contibuting feature summary +[**get-peer-group-outliers-contributing-features**](#get-peer-group-outliers-contributing-features) | **Get** `/outliers/{outlierId}/contributing-features` | Get identity outlier's contibuting features +[**ignore-identity-outliers**](#ignore-identity-outliers) | **Post** `/outliers/ignore` | IAI Identity Outliers Ignore +[**list-outliers-contributing-feature-access-items**](#list-outliers-contributing-feature-access-items) | **Get** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature +[**un-ignore-identity-outliers**](#un-ignore-identity-outliers) | **Post** `/outliers/unignore` | IAI Identity Outliers Unignore + + +## export-outliers-zip +:::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 + ``` +::: +IAI Identity Outliers Export +This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. + +Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-outliers-zip) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportOutliersZipRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **type_** | **string** | Type of the identity outliers snapshot to filter on | + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIOutliersAPI.ExportOutliersZip(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIOutliersAPI.ExportOutliersZip(context.Background()).XSailPointExperimental(xSailPointExperimental).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.ExportOutliersZip``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportOutliersZip`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.ExportOutliersZip`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-outlier-snapshots +:::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 + ``` +::: +IAI Identity Outliers Summary +This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-outlier-snapshots) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityOutlierSnapshotsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **type_** | **string** | Type of the identity outliers snapshot to filter on | + **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: **snapshotDate**: *ge, le* | + **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: **snapshotDate** | + +### Return type + +[**[]OutlierSummary**](../models/outlier-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + filters := `snapshotDate ge "2022-02-07T20:13:29.356648026Z"` // 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: **snapshotDate**: *ge, le* (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: **snapshotDate**: *ge, le* (optional) + sorters := `snapshotDate` // 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: **snapshotDate** (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: **snapshotDate** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIOutliersAPI.GetIdentityOutlierSnapshots(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIOutliersAPI.GetIdentityOutlierSnapshots(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Type_(type_).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetIdentityOutlierSnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityOutlierSnapshots`: []OutlierSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetIdentityOutlierSnapshots`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-outliers +:::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 + ``` +::: +IAI Get Identity Outliers +This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-outliers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityOutliersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **type_** | **string** | Type of the identity outliers snapshot to filter on | + **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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* | + **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: **firstDetectionDate, attributes, score** | + +### Return type + +[**[]Outlier**](../models/outlier) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + filters := `attributes.displayName sw "John" and certStatus 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) + sorters := `attributes.displayName,firstDetectionDate,-score` // 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: **firstDetectionDate, attributes, score** (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: **firstDetectionDate, attributes, score** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIOutliersAPI.GetIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIOutliersAPI.GetIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Type_(type_).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityOutliers`: []Outlier + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetIdentityOutliers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-latest-identity-outlier-snapshots +:::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 + ``` +::: +IAI Identity Outliers Latest Summary +This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-latest-identity-outlier-snapshots) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLatestIdentityOutlierSnapshotsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **type_** | **string** | Type of the identity outliers snapshot to filter on | + +### Return type + +[**[]LatestOutlierSummary**](../models/latest-outlier-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIOutliersAPI.GetLatestIdentityOutlierSnapshots(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIOutliersAPI.GetLatestIdentityOutlierSnapshots(context.Background()).XSailPointExperimental(xSailPointExperimental).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetLatestIdentityOutlierSnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLatestIdentityOutlierSnapshots`: []LatestOutlierSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetLatestIdentityOutlierSnapshots`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-outlier-contributing-feature-summary +:::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 outlier contibuting feature summary +This API returns a summary of a contributing feature for an identity outlier. + +The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-outlier-contributing-feature-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**outlierFeatureId** | **string** | Contributing feature id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOutlierContributingFeatureSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**OutlierFeatureSummary**](../models/outlier-feature-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + outlierFeatureId := `04654b66-7561-4090-94f9-abee0722a1af` // string | Contributing feature id # string | Contributing feature 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.IAIOutliersAPI.GetOutlierContributingFeatureSummary(context.Background(), outlierFeatureId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIOutliersAPI.GetOutlierContributingFeatureSummary(context.Background(), outlierFeatureId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetOutlierContributingFeatureSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOutlierContributingFeatureSummary`: OutlierFeatureSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetOutlierContributingFeatureSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-peer-group-outliers-contributing-features +:::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 outlier's contibuting features +This API returns a list of contributing feature objects for a single outlier. + +The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-peer-group-outliers-contributing-features) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**outlierId** | **string** | The outlier id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPeerGroupOutliersContributingFeaturesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **includeTranslationMessages** | **string** | Whether or not to include translation messages object in returned response | + **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: **importance** | + +### Return type + +[**[]OutlierContributingFeature**](../models/outlier-contributing-feature) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + outlierId := `2c918085842e69ae018432d22ccb212f` // string | The outlier id # string | The outlier 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + includeTranslationMessages := `include-translation-messages=` // string | Whether or not to include translation messages object in returned response (optional) # string | Whether or not to include translation messages object in returned response (optional) + sorters := `importance` // 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: **importance** (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: **importance** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures(context.Background(), outlierId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures(context.Background(), outlierId).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).IncludeTranslationMessages(includeTranslationMessages).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPeerGroupOutliersContributingFeatures`: []OutlierContributingFeature + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## ignore-identity-outliers +:::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 + ``` +::: +IAI Identity Outliers Ignore +This API receives a list of identity IDs in the request, changes the outliers to be ignored. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/ignore-identity-outliers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiIgnoreIdentityOutliersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **requestBody** | **[]string** | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + requestbody := []byte(``) // []string | + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.IAIOutliersAPI.IgnoreIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //r, err := apiClient.V2024.IAIOutliersAPI.IgnoreIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.IgnoreIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## list-outliers-contributing-feature-access-items +:::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 + ``` +::: +Gets a list of access items associated with each identity outlier contributing feature +This API returns a list of the enriched access items associated with each feature filtered by the access item type. + +The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-outliers-contributing-feature-access-items) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**outlierId** | **string** | The outlier id | +**contributingFeatureName** | **string** | The name of contributing feature | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOutliersContributingFeatureAccessItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **accessType** | **string** | The type of access item for the identity outlier contributing feature. If not provided, it returns all. | + **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: **displayName** | + +### Return type + +[**[]OutliersContributingFeatureAccessItems**](../models/outliers-contributing-feature-access-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + outlierId := `2c918085842e69ae018432d22ccb212f` // string | The outlier id # string | The outlier id + contributingFeatureName := `entitlement_count` // string | The name of contributing feature # string | The name of contributing feature + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + accessType := `ENTITLEMENT` // string | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) # string | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) + sorters := `displayName` // 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: **displayName** (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: **displayName** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIOutliersAPI.ListOutliersContributingFeatureAccessItems(context.Background(), outlierId, contributingFeatureName).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIOutliersAPI.ListOutliersContributingFeatureAccessItems(context.Background(), outlierId, contributingFeatureName).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).AccessType(accessType).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.ListOutliersContributingFeatureAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOutliersContributingFeatureAccessItems`: []OutliersContributingFeatureAccessItems + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.ListOutliersContributingFeatureAccessItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## un-ignore-identity-outliers +:::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 + ``` +::: +IAI Identity Outliers Unignore +This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/un-ignore-identity-outliers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUnIgnoreIdentityOutliersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **requestBody** | **[]string** | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + requestbody := []byte(``) // []string | + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.IAIOutliersAPI.UnIgnoreIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //r, err := apiClient.V2024.IAIOutliersAPI.UnIgnoreIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.UnIgnoreIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IAIPeerGroupStrategiesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IAIPeerGroupStrategiesAPI.md new file mode 100644 index 000000000..3530eba6c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IAIPeerGroupStrategiesAPI.md @@ -0,0 +1,108 @@ +--- +id: v2024-iai-peer-group-strategies +title: IAIPeerGroupStrategies +pagination_label: IAIPeerGroupStrategies +sidebar_label: IAIPeerGroupStrategies +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAIPeerGroupStrategies', 'V2024IAIPeerGroupStrategies'] +slug: /tools/sdk/go/v2024/methods/iai-peer-group-strategies +tags: ['SDK', 'Software Development Kit', 'IAIPeerGroupStrategies', 'V2024IAIPeerGroupStrategies'] +--- + +# IAIPeerGroupStrategiesAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-peer-group-outliers**](#get-peer-group-outliers) | **Get** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List + + +## get-peer-group-outliers +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::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 Outliers List +-- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-peer-group-outliers) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**strategy** | **string** | The strategy used to create peer groups. Currently, 'entitlement' is supported. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPeerGroupOutliersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]PeerGroupMember**](../models/peer-group-member) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + strategy := `entitlement` // string | The strategy used to create peer groups. Currently, 'entitlement' is supported. # string | The strategy used to create peer groups. Currently, 'entitlement' is supported. + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers(context.Background(), strategy).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers(context.Background(), strategy).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPeerGroupOutliers`: []PeerGroupMember + fmt.Fprintf(os.Stdout, "Response from `IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IAIRecommendationsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IAIRecommendationsAPI.md new file mode 100644 index 000000000..c0a3546b0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IAIRecommendationsAPI.md @@ -0,0 +1,280 @@ +--- +id: v2024-iai-recommendations +title: IAIRecommendations +pagination_label: IAIRecommendations +sidebar_label: IAIRecommendations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAIRecommendations', 'V2024IAIRecommendations'] +slug: /tools/sdk/go/v2024/methods/iai-recommendations +tags: ['SDK', 'Software Development Kit', 'IAIRecommendations', 'V2024IAIRecommendations'] +--- + +# IAIRecommendationsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-recommendations**](#get-recommendations) | **Post** `/recommendations/request` | Returns Recommendation Based on Object +[**get-recommendations-config**](#get-recommendations-config) | **Get** `/recommendations/config` | Get certification recommendation config values +[**update-recommendations-config**](#update-recommendations-config) | **Put** `/recommendations/config` | Update certification recommendation config values + + +## get-recommendations +:::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 + ``` +::: +Returns Recommendation Based on Object +The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-recommendations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRecommendationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **recommendationRequestDto** | [**RecommendationRequestDto**](../models/recommendation-request-dto) | | + +### Return type + +[**RecommendationResponseDto**](../models/recommendation-response-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + recommendationrequestdto := []byte(`{ + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true + }`) // RecommendationRequestDto | + + + var recommendationRequestDto v2024.RecommendationRequestDto + if err := json.Unmarshal(recommendationrequestdto, &recommendationRequestDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRecommendationsAPI.GetRecommendations(context.Background()).XSailPointExperimental(xSailPointExperimental).RecommendationRequestDto(recommendationRequestDto).Execute() + //resp, r, err := apiClient.V2024.IAIRecommendationsAPI.GetRecommendations(context.Background()).XSailPointExperimental(xSailPointExperimental).RecommendationRequestDto(recommendationRequestDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.GetRecommendations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRecommendations`: RecommendationResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.GetRecommendations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-recommendations-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 + ``` +::: +Get certification recommendation config values +Retrieves configuration attributes used by certification recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-recommendations-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRecommendationsConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RecommendationConfigDto**](../models/recommendation-config-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRecommendationsAPI.GetRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRecommendationsAPI.GetRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.GetRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRecommendationsConfig`: RecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.GetRecommendationsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-recommendations-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 certification recommendation config values +Updates configuration attributes used by certification recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-recommendations-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateRecommendationsConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **recommendationConfigDto** | [**RecommendationConfigDto**](../models/recommendation-config-dto) | | + +### Return type + +[**RecommendationConfigDto**](../models/recommendation-config-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + recommendationconfigdto := []byte(`{ + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + }`) // RecommendationConfigDto | + + + var recommendationConfigDto v2024.RecommendationConfigDto + if err := json.Unmarshal(recommendationconfigdto, &recommendationConfigDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRecommendationsAPI.UpdateRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).RecommendationConfigDto(recommendationConfigDto).Execute() + //resp, r, err := apiClient.V2024.IAIRecommendationsAPI.UpdateRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).RecommendationConfigDto(recommendationConfigDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.UpdateRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRecommendationsConfig`: RecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.UpdateRecommendationsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IAIRoleMiningAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IAIRoleMiningAPI.md new file mode 100644 index 000000000..9d1cbccf4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IAIRoleMiningAPI.md @@ -0,0 +1,2260 @@ +--- +id: v2024-iai-role-mining +title: IAIRoleMining +pagination_label: IAIRoleMining +sidebar_label: IAIRoleMining +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAIRoleMining', 'V2024IAIRoleMining'] +slug: /tools/sdk/go/v2024/methods/iai-role-mining +tags: ['SDK', 'Software Development Kit', 'IAIRoleMining', 'V2024IAIRoleMining'] +--- + +# IAIRoleMiningAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-potential-role-provision-request**](#create-potential-role-provision-request) | **Post** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision` | Create request to provision a potential role into an actual role. +[**create-role-mining-sessions**](#create-role-mining-sessions) | **Post** `/role-mining-sessions` | Create a role mining session +[**download-role-mining-potential-role-zip**](#download-role-mining-potential-role-zip) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` | Export (download) details for a potential role in a role mining session +[**export-role-mining-potential-role**](#export-role-mining-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export` | Export (download) details for a potential role in a role mining session +[**export-role-mining-potential-role-async**](#export-role-mining-potential-role-async) | **Post** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` | Asynchronously export details for a potential role in a role mining session and upload to S3 +[**export-role-mining-potential-role-status**](#export-role-mining-potential-role-status) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` | Retrieve status of a potential role export job +[**get-all-potential-role-summaries**](#get-all-potential-role-summaries) | **Get** `/role-mining-potential-roles` | Retrieves all potential role summaries +[**get-entitlement-distribution-potential-role**](#get-entitlement-distribution-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` | Retrieves entitlement popularity distribution for a potential role in a role mining session +[**get-entitlements-potential-role**](#get-entitlements-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities` | Retrieves entitlements for a potential role in a role mining session +[**get-excluded-entitlements-potential-role**](#get-excluded-entitlements-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements` | Retrieves excluded entitlements for a potential role in a role mining session +[**get-identities-potential-role**](#get-identities-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities` | Retrieves identities for a potential role in a role mining session +[**get-potential-role**](#get-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` | Retrieves a specific potential role +[**get-potential-role-applications**](#get-potential-role-applications) | **Get** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications` | Retrieves the applications of a potential role for a role mining session +[**get-potential-role-entitlements**](#get-potential-role-entitlements) | **Get** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements` | Retrieves the entitlements of a potential role for a role mining session +[**get-potential-role-source-identity-usage**](#get-potential-role-source-identity-usage) | **Get** `/role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage` | Retrieves potential role source usage +[**get-potential-role-summaries**](#get-potential-role-summaries) | **Get** `/role-mining-sessions/{sessionId}/potential-role-summaries` | Retrieves all potential role summaries +[**get-role-mining-potential-role**](#get-role-mining-potential-role) | **Get** `/role-mining-potential-roles/{potentialRoleId}` | Retrieves a specific potential role +[**get-role-mining-session**](#get-role-mining-session) | **Get** `/role-mining-sessions/{sessionId}` | Get a role mining session +[**get-role-mining-session-status**](#get-role-mining-session-status) | **Get** `/role-mining-sessions/{sessionId}/status` | Get role mining session status state +[**get-role-mining-sessions**](#get-role-mining-sessions) | **Get** `/role-mining-sessions` | Retrieves all role mining sessions +[**get-saved-potential-roles**](#get-saved-potential-roles) | **Get** `/role-mining-potential-roles/saved` | Retrieves all saved potential roles +[**patch-potential-role**](#patch-potential-role) | **Patch** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` | Update a potential role +[**patch-potential-role-0**](#patch-potential-role-0) | **Patch** `/role-mining-potential-roles/{potentialRoleId}` | Update a potential role +[**patch-role-mining-session**](#patch-role-mining-session) | **Patch** `/role-mining-sessions/{sessionId}` | Patch a role mining session +[**update-entitlements-potential-role**](#update-entitlements-potential-role) | **Post** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` | Edit entitlements for a potential role to exclude some entitlements + + +## create-potential-role-provision-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 + ``` +::: +Create request to provision a potential role into an actual role. +This method starts a job to provision a potential role + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-potential-role-provision-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePotentialRoleProvisionRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **minEntitlementPopularity** | **int32** | Minimum popularity required for an entitlement to be included in the provisioned role. | [default to 0] + **includeCommonAccess** | **bool** | Boolean determining whether common access entitlements will be included in the provisioned role. | [default to true] + **roleMiningPotentialRoleProvisionRequest** | [**RoleMiningPotentialRoleProvisionRequest**](../models/role-mining-potential-role-provision-request) | Required information to create a new role | + +### Return type + +[**RoleMiningPotentialRoleSummary**](../models/role-mining-potential-role-summary) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + minEntitlementPopularity := 56 // int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) # int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to true) # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to true) + roleminingpotentialroleprovisionrequest := []byte(`{ + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false + }`) // RoleMiningPotentialRoleProvisionRequest | Required information to create a new role (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).MinEntitlementPopularity(minEntitlementPopularity).IncludeCommonAccess(includeCommonAccess).RoleMiningPotentialRoleProvisionRequest(roleMiningPotentialRoleProvisionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePotentialRoleProvisionRequest`: RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-role-mining-sessions +:::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 a role mining session +This submits a create role mining session request to the role mining application. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-role-mining-sessions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateRoleMiningSessionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **roleMiningSessionDto** | [**RoleMiningSessionDto**](../models/role-mining-session-dto) | Role mining session parameters | + +### Return type + +[**RoleMiningSessionResponse**](../models/role-mining-session-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + roleminingsessiondto := []byte(`{ + "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", + "prescribedPruneThreshold" : 10, + "pruneThreshold" : 50, + "saved" : true, + "potentialRolesReadyCount" : 0, + "scope" : { + "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], + "attributeFilterCriteria" : { + "displayName" : { + "untranslated" : "Location: Miami" + }, + "ariaLabel" : { + "untranslated" : "Location: Miami" + }, + "data" : { + "displayName" : { + "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" + }, + "name" : "location", + "operator" : "EQUALS", + "values" : [ "Miami" ] + } + }, + "criteria" : "source.name:DataScienceDataset" + }, + "potentialRoleCount" : 0, + "name" : "Saved RM Session - 07/10", + "minNumIdentitiesInPotentialRole" : 20, + "identityCount" : 0, + "type" : "SPECIALIZED" + }`) // RoleMiningSessionDto | Role mining session parameters + + + var roleMiningSessionDto v2024.RoleMiningSessionDto + if err := json.Unmarshal(roleminingsessiondto, &roleMiningSessionDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.CreateRoleMiningSessions(context.Background()).XSailPointExperimental(xSailPointExperimental).RoleMiningSessionDto(roleMiningSessionDto).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.CreateRoleMiningSessions(context.Background()).XSailPointExperimental(xSailPointExperimental).RoleMiningSessionDto(roleMiningSessionDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.CreateRoleMiningSessions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRoleMiningSessions`: RoleMiningSessionResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.CreateRoleMiningSessions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## download-role-mining-potential-role-zip +:::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 + ``` +::: +Export (download) details for a potential role in a role mining session +This endpoint downloads a completed export of information for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/download-role-mining-potential-role-zip) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | +**exportId** | **string** | The id of a previously run export job for this potential role | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDownloadRoleMiningPotentialRoleZipRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + exportId := `4940ffd4-836f-48a3-b2b0-6d498c3fdf40` // string | The id of a previously run export job for this potential role # string | The id of a previously run export job for this potential role + 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.IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip(context.Background(), sessionId, potentialRoleId, exportId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip(context.Background(), sessionId, potentialRoleId, exportId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DownloadRoleMiningPotentialRoleZip`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## export-role-mining-potential-role +:::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 + ``` +::: +Export (download) details for a potential role in a role mining session +This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-role-mining-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportRoleMiningPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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.IAIRoleMiningAPI.ExportRoleMiningPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.ExportRoleMiningPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRole`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## export-role-mining-potential-role-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 + ``` +::: +Asynchronously export details for a potential role in a role mining session and upload to S3 +This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-role-mining-potential-role-async) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportRoleMiningPotentialRoleAsyncRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **roleMiningPotentialRoleExportRequest** | [**RoleMiningPotentialRoleExportRequest**](../models/role-mining-potential-role-export-request) | | + +### Return type + +[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + roleminingpotentialroleexportrequest := []byte(`{ + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true + }`) // RoleMiningPotentialRoleExportRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).RoleMiningPotentialRoleExportRequest(roleMiningPotentialRoleExportRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRoleAsync`: RoleMiningPotentialRoleExportResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## export-role-mining-potential-role-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 + ``` +::: +Retrieve status of a potential role export job +This endpoint retrieves information about the current status of a potential role export. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-role-mining-potential-role-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | +**exportId** | **string** | The id of a previously run export job for this potential role | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportRoleMiningPotentialRoleStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + exportId := `4940ffd4-836f-48a3-b2b0-6d498c3fdf40` // string | The id of a previously run export job for this potential role # string | The id of a previously run export job for this potential role + 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.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus(context.Background(), sessionId, potentialRoleId, exportId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus(context.Background(), sessionId, potentialRoleId, exportId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRoleStatus`: RoleMiningPotentialRoleExportResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-all-potential-role-summaries +:::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 + ``` +::: +Retrieves all potential role summaries +Returns all potential role summaries that match the query parameters + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-all-potential-role-summaries) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAllPotentialRoleSummariesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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: **createdDate, identityCount, entitlementCount, freshness, quality** | + **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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningPotentialRoleSummary**](../models/role-mining-potential-role-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + sorters := `createdDate` // 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: **createdDate, identityCount, entitlementCount, freshness, quality** (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: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) + filters := `(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))` // 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetAllPotentialRoleSummaries(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetAllPotentialRoleSummaries(context.Background()).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetAllPotentialRoleSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAllPotentialRoleSummaries`: []RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetAllPotentialRoleSummaries`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlement-distribution-potential-role +:::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 + ``` +::: +Retrieves entitlement popularity distribution for a potential role in a role mining session +This method returns entitlement popularity distribution for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-distribution-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementDistributionPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **includeCommonAccess** | **bool** | Boolean determining whether common access entitlements will be included or not | + +### Return type + +**map[string]int32** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included or not (optional) # bool | Boolean determining whether common access entitlements will be included or not (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).IncludeCommonAccess(includeCommonAccess).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementDistributionPotentialRole`: map[string]int32 + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlements-potential-role +:::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 + ``` +::: +Retrieves entitlements for a potential role in a role mining session +This method returns entitlements for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlements-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementsPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **includeCommonAccess** | **bool** | Boolean determining whether common access entitlements will be included or not | [default to true] + **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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. | + **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: **applicationName**: *sw* **entitlementRef.name**: *sw* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningEntitlement**](../models/role-mining-entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included or not (optional) (default to true) # bool | Boolean determining whether common access entitlements will be included or not (optional) (default to true) + sorters := `popularity` // 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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) + filters := `applicationName sw "AD"` // 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).IncludeCommonAccess(includeCommonAccess).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementsPotentialRole`: []RoleMiningEntitlement + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetEntitlementsPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-excluded-entitlements-potential-role +:::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 + ``` +::: +Retrieves excluded entitlements for a potential role in a role mining session +This method returns excluded entitlements for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-excluded-entitlements-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetExcludedEntitlementsPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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: **popularity** | + **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: **applicationName**: *sw* **entitlementRef.name**: *sw* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningEntitlement**](../models/role-mining-entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + sorters := `populariity` // 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: **popularity** (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: **popularity** (optional) + filters := `applicationName sw "AD"` // 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetExcludedEntitlementsPotentialRole`: []RoleMiningEntitlement + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identities-potential-role +:::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 + ``` +::: +Retrieves identities for a potential role in a role mining session +This method returns identities for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identities-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentitiesPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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** | + **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: **name**: *sw* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningIdentity**](../models/role-mining-identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + sorters := `name` // 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** (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** (optional) + filters := `filters_example` // 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: **name**: *sw* (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: **name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetIdentitiesPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetIdentitiesPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetIdentitiesPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitiesPotentialRole`: []RoleMiningIdentity + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetIdentitiesPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-potential-role +:::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 + ``` +::: +Retrieves a specific potential role +This method returns a specific potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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.IAIRoleMiningAPI.GetPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-potential-role-applications +:::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 + ``` +::: +Retrieves the applications of a potential role for a role mining session +This method returns the applications of a potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role-applications) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPotentialRoleApplicationsRequest struct via the builder pattern + + +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: **applicationName**: *sw* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningPotentialRoleApplication**](../models/role-mining-potential-role-application) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `62f28d91-7d9f-4d17-be15-666d5b41d77f` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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 := `applicationName sw "test"` // 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: **applicationName**: *sw* (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: **applicationName**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRoleApplications(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRoleApplications(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleApplications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleApplications`: []RoleMiningPotentialRoleApplication + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleApplications`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-potential-role-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 + ``` +::: +Retrieves the entitlements of a potential role for a role mining session +This method returns the entitlements of a potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPotentialRoleEntitlementsRequest struct via the builder pattern + + +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: **entitlementRef.name**: *sw* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningPotentialRoleEntitlements**](../models/role-mining-potential-role-entitlements) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `62f28d91-7d9f-4d17-be15-666d5b41d77f` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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 := `entitlementRef.name sw "test"` // 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: **entitlementRef.name**: *sw* (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: **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRoleEntitlements(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRoleEntitlements(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleEntitlements`: []RoleMiningPotentialRoleEntitlements + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-potential-role-source-identity-usage +:::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 + ``` +::: +Retrieves potential role source usage +This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role-source-identity-usage) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**potentialRoleId** | **string** | A potential role id | +**sourceId** | **string** | A source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPotentialRoleSourceIdentityUsageRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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 is supported for the following fields: **displayName, email, usageCount** | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningPotentialRoleSourceUsage**](../models/role-mining-potential-role-source-usage) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + potentialRoleId := `e0cc5d7d-bf7f-4f81-b2af-8885b09d9923` // string | A potential role id # string | A potential role id + sourceId := `2c9180877620c1460176267f336a106f` // string | A source id # string | A 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") + sorters := `-usageCount` // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (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 is supported for the following fields: **displayName, email, usageCount** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage(context.Background(), potentialRoleId, sourceId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage(context.Background(), potentialRoleId, sourceId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleSourceIdentityUsage`: []RoleMiningPotentialRoleSourceUsage + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-potential-role-summaries +:::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 + ``` +::: +Retrieves all potential role summaries +This method returns the potential role summaries for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role-summaries) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPotentialRoleSummariesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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: **createdDate** | + **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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningPotentialRoleSummary**](../models/role-mining-potential-role-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session 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") + sorters := `createdDate` // 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: **createdDate** (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: **createdDate** (optional) + filters := `(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))` // 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRoleSummaries(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRoleSummaries(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleSummaries`: []RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleSummaries`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-mining-potential-role +:::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 + ``` +::: +Retrieves a specific potential role +This method returns a specific potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-mining-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**potentialRoleId** | **string** | A potential role id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleMiningPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id # string | A potential role 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.IAIRoleMiningAPI.GetRoleMiningPotentialRole(context.Background(), potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetRoleMiningPotentialRole(context.Background(), potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-mining-session +:::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 a role mining session +The method retrieves a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-mining-session) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id to be retrieved. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleMiningSessionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleMiningSessionResponse**](../models/role-mining-session-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id to be retrieved. # string | The role mining session id to be retrieved. + 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.IAIRoleMiningAPI.GetRoleMiningSession(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetRoleMiningSession(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSession``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSession`: RoleMiningSessionResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSession`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-mining-session-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 + ``` +::: +Get role mining session status state +This method returns a role mining session status for a customer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-mining-session-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleMiningSessionStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleMiningSessionStatus**](../models/role-mining-session-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session 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.IAIRoleMiningAPI.GetRoleMiningSessionStatus(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetRoleMiningSessionStatus(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSessionStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSessionStatus`: RoleMiningSessionStatus + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSessionStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-mining-sessions +:::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 + ``` +::: +Retrieves all role mining sessions +Returns all role mining sessions that match the query parameters + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-mining-sessions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleMiningSessionsRequest struct via the builder pattern + + +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: **saved**: *eq* **name**: *eq, sw* | + **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: **createdBy, createdDate** | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningSessionDto**](../models/role-mining-session-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 := `saved eq "true" and name sw "RM Session"` // 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: **saved**: *eq* **name**: *eq, sw* (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: **saved**: *eq* **name**: *eq, sw* (optional) + sorters := `createdBy,createdDate` // 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: **createdBy, createdDate** (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: **createdBy, createdDate** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetRoleMiningSessions(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetRoleMiningSessions(context.Background()).XSailPointExperimental(xSailPointExperimental).Filters(filters).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSessions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSessions`: []RoleMiningSessionDto + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSessions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-saved-potential-roles +:::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 + ``` +::: +Retrieves all saved potential roles +This method returns all saved potential roles (draft roles). + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-saved-potential-roles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSavedPotentialRolesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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 is supported for the following fields: **modified** | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningSessionDraftRoleDto**](../models/role-mining-session-draft-role-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + sorters := `modified` // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (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 is supported for the following fields: **modified** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetSavedPotentialRoles(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetSavedPotentialRoles(context.Background()).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetSavedPotentialRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSavedPotentialRoles`: []RoleMiningSessionDraftRoleDto + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetSavedPotentialRoles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-potential-role +:::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 a potential role +The method updates an existing potential role using. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | The potential role summary id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **patchPotentialRoleRequestInner** | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The potential role summary id # string | The potential role summary 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") + patchpotentialrolerequestinner := []byte(`[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]`) // []PatchPotentialRoleRequestInner | + + + var patchPotentialRoleRequestInner v2024.[]PatchPotentialRoleRequestInner + if err := json.Unmarshal(patchpotentialrolerequestinner, &patchPotentialRoleRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.PatchPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.PatchPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPotentialRole`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-potential-role-0 +:::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 a potential role +The method updates an existing potential role using. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-potential-role-0) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | The potential role summary id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchPotentialRole_1Request struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **patchPotentialRoleRequestInner** | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The potential role summary id # string | The potential role summary 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") + patchpotentialrolerequestinner := []byte(`[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]`) // []PatchPotentialRoleRequestInner | + + + var patchPotentialRoleRequestInner v2024.[]PatchPotentialRoleRequestInner + if err := json.Unmarshal(patchpotentialrolerequestinner, &patchPotentialRoleRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.PatchPotentialRole_0(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.PatchPotentialRole_0(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchPotentialRole_0``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPotentialRole_0`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchPotentialRole_0`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-role-mining-session +:::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 + ``` +::: +Patch a role mining session +The method updates an existing role mining session using PATCH. Supports op in {"replace"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-role-mining-session) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id to be patched | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchRoleMiningSessionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id to be patched # string | The role mining session id to be patched + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/pruneThreshold, value=83}, {op=replace, path=/minNumIdentitiesInPotentialRole, value=10}, {op=replace, path=/saved, value=false}, {op=replace, path=/name, value=RM Session - 07/10/22}, {op=add, path=/name, value=RM Session - 07/10/22}]`) // []JsonPatchOperation | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.PatchRoleMiningSession(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.PatchRoleMiningSession(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchRoleMiningSession``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchRoleMiningSession`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchRoleMiningSession`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-entitlements-potential-role +:::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 + ``` +::: +Edit entitlements for a potential role to exclude some entitlements +This endpoint adds or removes entitlements from an exclusion list for a potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-entitlements-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateEntitlementsPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **roleMiningPotentialRoleEditEntitlements** | [**RoleMiningPotentialRoleEditEntitlements**](../models/role-mining-potential-role-edit-entitlements) | Role mining session parameters | + +### Return type + +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + roleminingpotentialroleeditentitlements := []byte(`{ + "ids" : [ "entId1", "entId2" ], + "exclude" : true + }`) // RoleMiningPotentialRoleEditEntitlements | Role mining session parameters + + + var roleMiningPotentialRoleEditEntitlements v2024.RoleMiningPotentialRoleEditEntitlements + if err := json.Unmarshal(roleminingpotentialroleeditentitlements, &roleMiningPotentialRoleEditEntitlements); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.UpdateEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).RoleMiningPotentialRoleEditEntitlements(roleMiningPotentialRoleEditEntitlements).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.UpdateEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).RoleMiningPotentialRoleEditEntitlements(roleMiningPotentialRoleEditEntitlements).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.UpdateEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateEntitlementsPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.UpdateEntitlementsPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IconsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IconsAPI.md new file mode 100644 index 000000000..8bd522d4a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IconsAPI.md @@ -0,0 +1,187 @@ +--- +id: v2024-icons +title: Icons +pagination_label: Icons +sidebar_label: Icons +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Icons', 'V2024Icons'] +slug: /tools/sdk/go/v2024/methods/icons +tags: ['SDK', 'Software Development Kit', 'Icons', 'V2024Icons'] +--- + +# IconsAPI + Use this API to implement functionality related to object icons (application icons for example). +With this functionality in place, administrators can set or remove an icon for specific object type for use throughout Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-icon**](#delete-icon) | **Delete** `/icons/{objectType}/{objectId}` | Delete an icon +[**set-icon**](#set-icon) | **Put** `/icons/{objectType}/{objectId}` | Update an icon + + +## delete-icon +:::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 an icon +This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-icon) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**objectType** | **string** | Object type. Available options ['application'] | +**objectId** | **string** | Object id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIconRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + objectType := `application` // string | Object type. Available options ['application'] # string | Object type. Available options ['application'] + objectId := `a291e870-48c3-4953-b656-fb5ce2a93169` // string | Object id. # string | Object 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.IconsAPI.DeleteIcon(context.Background(), objectType, objectId).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.IconsAPI.DeleteIcon(context.Background(), objectType, objectId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IconsAPI.DeleteIcon``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## set-icon +:::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 an icon +This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-icon) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**objectType** | **string** | Object type. Available options ['application'] | +**objectId** | **string** | Object id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetIconRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **image** | ***os.File** | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] | + +### Return type + +[**SetIcon200Response**](../models/set-icon200-response) + +### 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() { + objectType := `application` // string | Object type. Available options ['application'] # string | Object type. Available options ['application'] + objectId := `a291e870-48c3-4953-b656-fb5ce2a93169` // string | Object id. # string | Object 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") + image := BINARY_DATA_HERE // *os.File | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] # *os.File | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IconsAPI.SetIcon(context.Background(), objectType, objectId).XSailPointExperimental(xSailPointExperimental).Image(image).Execute() + //resp, r, err := apiClient.V2024.IconsAPI.SetIcon(context.Background(), objectType, objectId).XSailPointExperimental(xSailPointExperimental).Image(image).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IconsAPI.SetIcon``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetIcon`: SetIcon200Response + fmt.Fprintf(os.Stdout, "Response from `IconsAPI.SetIcon`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IdentitiesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IdentitiesAPI.md new file mode 100644 index 000000000..bc75251c3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IdentitiesAPI.md @@ -0,0 +1,956 @@ +--- +id: v2024-identities +title: Identities +pagination_label: Identities +sidebar_label: Identities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Identities', 'V2024Identities'] +slug: /tools/sdk/go/v2024/methods/identities +tags: ['SDK', 'Software Development Kit', 'Identities', 'V2024Identities'] +--- + +# IdentitiesAPI + Use this API to implement identity functionality. +With this functionality in place, administrators can synchronize an identity's attributes with its various source attributes. + +Identity Security Cloud uses identities as users' authoritative accounts. Identities can own other accounts, entitlements, and attributes. + +An identity has a variety of attributes, such as an account name, an email address, a job title, and more. +These identity attributes can be correlated with different attributes on different sources. +For example, the identity John.Smith can own an account in the GitHub source with the account name John-Smith-Org, and Identity Security Cloud knows they are the same person with the same access and attributes. + +In Identity Security Cloud, administrators often set up these synchronizations to get triggered automatically with a change or to run on a schedule. +To manually synchronize attributes for an identity, administrators can use the Identities drop-down menu and select Identity List to view the list of identities. +They can then select the identity they want to manually synchronize and use the hamburger menu to select 'Synchronize Attributes.' +Doing so immediately begins the attribute synchronization and analyzes all accounts for the selected identity. + +Refer to [Synchronizing Attributes](https://documentation.sailpoint.com/saas/help/provisioning/attr_sync.html) for more information about synchronizing attributes. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-identity**](#delete-identity) | **Delete** `/identities/{id}` | Delete identity +[**get-identity**](#get-identity) | **Get** `/identities/{id}` | Identity Details +[**get-identity-ownership-details**](#get-identity-ownership-details) | **Get** `/identities/{identityId}/ownership` | Get ownership details +[**get-role-assignment**](#get-role-assignment) | **Get** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details +[**get-role-assignments**](#get-role-assignments) | **Get** `/identities/{identityId}/role-assignments` | List role assignments +[**list-identities**](#list-identities) | **Get** `/identities` | List Identities +[**reset-identity**](#reset-identity) | **Post** `/identities/{id}/reset` | Reset an identity +[**send-identity-verification-account-token**](#send-identity-verification-account-token) | **Post** `/identities/{id}/verification/account/send` | Send password reset email +[**start-identities-invite**](#start-identities-invite) | **Post** `/identities/invite` | Invite identities to register +[**start-identity-processing**](#start-identity-processing) | **Post** `/identities/process` | Process a list of identityIds +[**synchronize-attributes-for-identity**](#synchronize-attributes-for-identity) | **Post** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity. + + +## 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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Identity Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Identity Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**Identity**](../models/identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } + // response from `GetIdentity`: Identity + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetIdentity`: %v\n", resp) +} +``` + +[[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. +For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity's owned objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-ownership-details) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | Identity ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityOwnershipDetailsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**IdentityOwnershipAssociationDetails**](../models/identity-ownership-association-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } + // response from `GetIdentityOwnershipDetails`: IdentityOwnershipAssociationDetails + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetIdentityOwnershipDetails`: %v\n", resp) +} +``` + +[[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 + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-assignment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | Identity Id | +**assignmentId** | **string** | Assignment Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleAssignmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleAssignmentDto**](../models/role-assignment-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } + // response from `GetRoleAssignment`: RoleAssignmentDto + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetRoleAssignment`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-assignments) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | Identity Id to get the role assignments for | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleAssignmentsRequest struct via the builder pattern + + +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 | + +### Return type + +[**[]GetRoleAssignments200ResponseInner**](../models/get-role-assignments200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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) + + + + 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() + 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) + } + // response from `GetRoleAssignments`: []GetRoleAssignments200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetRoleAssignments`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentitiesRequest struct via the builder pattern + + +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"] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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 + +[**[]Identity**](../models/identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.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() + 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) + } + // response from `ListIdentities`: []Identity + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.ListIdentities`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reset-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | Identity Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiResetIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } +} +``` + +[[Back to top]](#) + +## send-identity-verification-account-token +:::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 + ``` +::: +Send password reset email +This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-identity-verification-account-token) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Identity ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendIdentityVerificationAccountTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + + **sendAccountVerificationRequest** | [**SendAccountVerificationRequest**](../models/send-account-verification-request) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + sendaccountverificationrequest := []byte(`{ + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" + }`) // SendAccountVerificationRequest | + + + var sendAccountVerificationRequest v2024.SendAccountVerificationRequest + if err := json.Unmarshal(sendaccountverificationrequest, &sendAccountVerificationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.IdentitiesAPI.SendIdentityVerificationAccountToken(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SendAccountVerificationRequest(sendAccountVerificationRequest).Execute() + //r, err := apiClient.V2024.IdentitiesAPI.SendIdentityVerificationAccountToken(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SendAccountVerificationRequest(sendAccountVerificationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.SendIdentityVerificationAccountToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[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. + +This task will send an invitation email only for unregistered identities. + +The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-identities-invite) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartIdentitiesInviteRequest struct via the builder pattern + + +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 + +[**TaskStatus**](../models/task-status) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 + }`) // InviteIdentitiesRequest | + + + var inviteIdentitiesRequest v2024.InviteIdentitiesRequest + if err := json.Unmarshal(inviteidentitiesrequest, &inviteIdentitiesRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + 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() + 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) + } + // response from `StartIdentitiesInvite`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.StartIdentitiesInvite`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-identity-processing +:::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 a list of identityIds +This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. + +This endpoint will perform the following tasks: +1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change). +2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. +3. Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health). +4. Recalculate manager relationships. +5. Potentially clean-up identity processing errors, assuming the error has been resolved. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-identity-processing) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartIdentityProcessingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **processIdentitiesRequest** | [**ProcessIdentitiesRequest**](../models/process-identities-request) | | + +### Return type + +[**TaskResultResponse**](../models/task-result-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + processidentitiesrequest := []byte(`{ + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + }`) // ProcessIdentitiesRequest | + + + var processIdentitiesRequest v2024.ProcessIdentitiesRequest + if err := json.Unmarshal(processidentitiesrequest, &processIdentitiesRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentitiesAPI.StartIdentityProcessing(context.Background()).XSailPointExperimental(xSailPointExperimental).ProcessIdentitiesRequest(processIdentitiesRequest).Execute() + //resp, r, err := apiClient.V2024.IdentitiesAPI.StartIdentityProcessing(context.Background()).XSailPointExperimental(xSailPointExperimental).ProcessIdentitiesRequest(processIdentitiesRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.StartIdentityProcessing``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartIdentityProcessing`: TaskResultResponse + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.StartIdentityProcessing`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## synchronize-attributes-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 + ``` +::: +Attribute synchronization for single identity. +This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/synchronize-attributes-for-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | The Identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSynchronizeAttributesForIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**IdentitySyncJob**](../models/identity-sync-job) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `identityId_example` // 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.IdentitiesAPI.SynchronizeAttributesForIdentity(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentitiesAPI.SynchronizeAttributesForIdentity(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.SynchronizeAttributesForIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SynchronizeAttributesForIdentity`: IdentitySyncJob + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.SynchronizeAttributesForIdentity`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IdentityAttributesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IdentityAttributesAPI.md new file mode 100644 index 000000000..595ef27d5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IdentityAttributesAPI.md @@ -0,0 +1,553 @@ +--- +id: v2024-identity-attributes +title: IdentityAttributes +pagination_label: IdentityAttributes +sidebar_label: IdentityAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributes', 'V2024IdentityAttributes'] +slug: /tools/sdk/go/v2024/methods/identity-attributes +tags: ['SDK', 'Software Development Kit', 'IdentityAttributes', 'V2024IdentityAttributes'] +--- + +# IdentityAttributesAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-identity-attribute**](#create-identity-attribute) | **Post** `/identity-attributes` | Create Identity Attribute +[**delete-identity-attribute**](#delete-identity-attribute) | **Delete** `/identity-attributes/{name}` | Delete Identity Attribute +[**delete-identity-attributes-in-bulk**](#delete-identity-attributes-in-bulk) | **Delete** `/identity-attributes/bulk-delete` | Bulk delete Identity Attributes +[**get-identity-attribute**](#get-identity-attribute) | **Get** `/identity-attributes/{name}` | Get Identity Attribute +[**list-identity-attributes**](#list-identity-attributes) | **Get** `/identity-attributes` | List Identity Attributes +[**put-identity-attribute**](#put-identity-attribute) | **Put** `/identity-attributes/{name}` | Update Identity Attribute + + +## create-identity-attribute +:::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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-attribute) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateIdentityAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **identityAttribute** | [**IdentityAttribute**](../models/identity-attribute) | | + +### Return type + +[**IdentityAttribute**](../models/identity-attribute) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + }`) // IdentityAttribute | + + + var identityAttribute v2024.IdentityAttribute + if err := json.Unmarshal(identityattribute, &identityAttribute); err != nil { + fmt.Println("Error:", err) + return + } + + + 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() + 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) + } + // response from `CreateIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.CreateIdentityAttribute`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The attribute's technical name. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-attributes-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityAttributesInBulkRequest struct via the builder pattern + + +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 + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 | + + + var identityAttributeNames v2024.IdentityAttributeNames + if err := json.Unmarshal(identityattributenames, &identityAttributeNames); err != nil { + fmt.Println("Error:", err) + return + } + + + 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() + 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) + } +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The attribute's technical name. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**IdentityAttribute**](../models/identity-attribute) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } + // response from `GetIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.GetIdentityAttribute`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-attributes) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityAttributesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]IdentityAttribute**](../models/identity-attribute) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + 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() + 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) + } + // response from `ListIdentityAttributes`: []IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.ListIdentityAttributes`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-identity-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The attribute's technical name. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutIdentityAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **identityAttribute** | [**IdentityAttribute**](../models/identity-attribute) | | + +### Return type + +[**IdentityAttribute**](../models/identity-attribute) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + }`) // IdentityAttribute | + + + var identityAttribute v2024.IdentityAttribute + if err := json.Unmarshal(identityattribute, &identityAttribute); err != nil { + fmt.Println("Error:", err) + return + } + + + 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() + 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) + } + // response from `PutIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.PutIdentityAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IdentityHistoryAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IdentityHistoryAPI.md new file mode 100644 index 000000000..6743eafb1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IdentityHistoryAPI.md @@ -0,0 +1,981 @@ +--- +id: v2024-identity-history +title: IdentityHistory +pagination_label: IdentityHistory +sidebar_label: IdentityHistory +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityHistory', 'V2024IdentityHistory'] +slug: /tools/sdk/go/v2024/methods/identity-history +tags: ['SDK', 'Software Development Kit', 'IdentityHistory', 'V2024IdentityHistory'] +--- + +# IdentityHistoryAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**compare-identity-snapshots**](#compare-identity-snapshots) | **Get** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots +[**compare-identity-snapshots-access-type**](#compare-identity-snapshots-access-type) | **Get** `/historical-identities/{id}/compare/{access-type}` | Gets a list of differences of specific accessType for the given identity between 2 snapshots +[**get-historical-identity**](#get-historical-identity) | **Get** `/historical-identities/{id}` | Get latest snapshot of identity +[**get-historical-identity-events**](#get-historical-identity-events) | **Get** `/historical-identities/{id}/events` | Lists all events for the given identity +[**get-identity-snapshot**](#get-identity-snapshot) | **Get** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date +[**get-identity-snapshot-summary**](#get-identity-snapshot-summary) | **Get** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity +[**get-identity-start-date**](#get-identity-start-date) | **Get** `/historical-identities/{id}/start-date` | Gets the start date of the identity +[**list-historical-identities**](#list-historical-identities) | **Get** `/historical-identities` | Lists all the identities +[**list-identity-access-items**](#list-identity-access-items) | **Get** `/historical-identities/{id}/access-items` | List Access Items by Identity +[**list-identity-snapshot-access-items**](#list-identity-snapshot-access-items) | **Get** `/historical-identities/{id}/snapshots/{date}/access-items` | Gets the list of identity access items at a given date filterd by item type +[**list-identity-snapshots**](#list-identity-snapshots) | **Get** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity + + +## compare-identity-snapshots +:::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 + ``` +::: +Gets a difference of count for each access item types for the given identity between 2 snapshots +This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/compare-identity-snapshots) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompareIdentitySnapshotsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **snapshot1** | **string** | The snapshot 1 of identity | + **snapshot2** | **string** | The snapshot 2 of identity | + **accessItemTypes** | **[]string** | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]IdentityCompareResponse**](../models/identity-compare-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + snapshot1 := `2007-03-01T13:00:00Z` // string | The snapshot 1 of identity (optional) # string | The snapshot 1 of identity (optional) + snapshot2 := `2008-03-01T13:00:00Z` // string | The snapshot 2 of identity (optional) # string | The snapshot 2 of identity (optional) + accessitemtypes := []byte(``) // []string | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityHistoryAPI.CompareIdentitySnapshots(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.CompareIdentitySnapshots(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Snapshot1(snapshot1).Snapshot2(snapshot2).AccessItemTypes(accessItemTypes).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.CompareIdentitySnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompareIdentitySnapshots`: []IdentityCompareResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.CompareIdentitySnapshots`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## compare-identity-snapshots-access-type +:::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 + ``` +::: +Gets a list of differences of specific accessType for the given identity between 2 snapshots +This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/compare-identity-snapshots-access-type) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | +**accessType** | **string** | The specific type which needs to be compared | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompareIdentitySnapshotsAccessTypeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **accessAssociated** | **bool** | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed | + **snapshot1** | **string** | The snapshot 1 of identity | + **snapshot2** | **string** | The snapshot 2 of identity | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]AccessItemDiff**](../models/access-item-diff) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + accessType := `role` // string | The specific type which needs to be compared # string | The specific type which needs to be compared + 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") + accessAssociated := 2007-03-01T13:00:00Z // bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) # bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) + snapshot1 := `2008-03-01T13:00:00Z` // string | The snapshot 1 of identity (optional) # string | The snapshot 1 of identity (optional) + snapshot2 := `2009-03-01T13:00:00Z` // string | The snapshot 2 of identity (optional) # string | The snapshot 2 of identity (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityHistoryAPI.CompareIdentitySnapshotsAccessType(context.Background(), id, accessType).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.CompareIdentitySnapshotsAccessType(context.Background(), id, accessType).XSailPointExperimental(xSailPointExperimental).AccessAssociated(accessAssociated).Snapshot1(snapshot1).Snapshot2(snapshot2).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.CompareIdentitySnapshotsAccessType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompareIdentitySnapshotsAccessType`: []AccessItemDiff + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.CompareIdentitySnapshotsAccessType`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-historical-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 + ``` +::: +Get latest snapshot of identity +This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-historical-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetHistoricalIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**IdentityHistoryResponse**](../models/identity-history-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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.IdentityHistoryAPI.GetHistoricalIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.GetHistoricalIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetHistoricalIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetHistoricalIdentity`: IdentityHistoryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetHistoricalIdentity`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-historical-identity-events +:::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 + ``` +::: +Lists all events for the given identity +This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-historical-identity-events) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetHistoricalIdentityEventsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **from** | **string** | The optional instant until which access events are returned | + **eventTypes** | **[]string** | An optional list of event types to return. If null or empty, all events are returned | + **accessItemTypes** | **[]string** | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]GetHistoricalIdentityEvents200ResponseInner**](../models/get-historical-identity-events200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + from := `2024-03-01T13:00:00Z` // string | The optional instant until which access events are returned (optional) # string | The optional instant until which access events are returned (optional) + eventtypes := []byte(`[AccessAddedEvent, AccessRemovedEvent]`) // []string | An optional list of event types to return. If null or empty, all events are returned (optional) + accessitemtypes := []byte(`[entitlement, account]`) // []string | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityHistoryAPI.GetHistoricalIdentityEvents(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.GetHistoricalIdentityEvents(context.Background(), id).XSailPointExperimental(xSailPointExperimental).From(from).EventTypes(eventTypes).AccessItemTypes(accessItemTypes).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetHistoricalIdentityEvents``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetHistoricalIdentityEvents`: []GetHistoricalIdentityEvents200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetHistoricalIdentityEvents`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-snapshot +:::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 + ``` +::: +Gets an identity snapshot at a given date +This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-snapshot) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | +**date** | **string** | The specified date | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentitySnapshotRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**IdentityHistoryResponse**](../models/identity-history-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + date := `2007-03-01T13:00:00Z` // string | The specified date # string | The specified date + 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.IdentityHistoryAPI.GetIdentitySnapshot(context.Background(), id, date).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.GetIdentitySnapshot(context.Background(), id, date).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentitySnapshot``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySnapshot`: IdentityHistoryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentitySnapshot`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-snapshot-summary +:::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 + ``` +::: +Gets the summary for the event count for a specific identity +This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-snapshot-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentitySnapshotSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **before** | **string** | The date before which snapshot summary is required | + **interval** | **string** | The interval indicating day or month. Defaults to month if not specified | + **timeZone** | **string** | The time zone. Defaults to UTC if not provided | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]MetricResponse**](../models/metric-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + before := `2007-03-01T13:00:00Z` // string | The date before which snapshot summary is required (optional) # string | The date before which snapshot summary is required (optional) + interval := `interval_example` // string | The interval indicating day or month. Defaults to month if not specified (optional) # string | The interval indicating day or month. Defaults to month if not specified (optional) + timeZone := `UTC` // string | The time zone. Defaults to UTC if not provided (optional) # string | The time zone. Defaults to UTC if not provided (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityHistoryAPI.GetIdentitySnapshotSummary(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.GetIdentitySnapshotSummary(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Before(before).Interval(interval).TimeZone(timeZone).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentitySnapshotSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySnapshotSummary`: []MetricResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentitySnapshotSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-start-date +:::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 + ``` +::: +Gets the start date of the identity +This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-start-date) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityStartDateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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.IdentityHistoryAPI.GetIdentityStartDate(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.GetIdentityStartDate(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentityStartDate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityStartDate`: string + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentityStartDate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-historical-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 + ``` +::: +Lists all the identities +This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-historical-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListHistoricalIdentitiesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **startsWithQuery** | **string** | This param is used for starts-with search for first, last and display name of the identity | + **isDeleted** | **bool** | Indicates if we want to only list down deleted identities or not. | + **isActive** | **bool** | Indicates if we want to only list active or inactive identities. | + **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 + +[**[]IdentityListItem**](../models/identity-list-item) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + startsWithQuery := `Ada` // string | This param is used for starts-with search for first, last and display name of the identity (optional) # string | This param is used for starts-with search for first, last and display name of the identity (optional) + isDeleted := true // bool | Indicates if we want to only list down deleted identities or not. (optional) # bool | Indicates if we want to only list down deleted identities or not. (optional) + isActive := true // bool | Indicates if we want to only list active or inactive identities. (optional) # bool | Indicates if we want to only list active or inactive identities. (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) + 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.V2024.IdentityHistoryAPI.ListHistoricalIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.ListHistoricalIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).StartsWithQuery(startsWithQuery).IsDeleted(isDeleted).IsActive(isActive).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListHistoricalIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListHistoricalIdentities`: []IdentityListItem + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListHistoricalIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-access-items +:::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 Access Items by Identity +This method retrieves a list of access item for the identity filtered by the access item type + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-access-items) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityAccessItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **type_** | **string** | The type of access item for the identity. If not provided, it defaults to account | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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 + +[**[]ListIdentityAccessItems200ResponseInner**](../models/list-identity-access-items200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + type_ := `account` // string | The type of access item for the identity. If not provided, it defaults to account (optional) # string | The type of access item for the identity. If not provided, it defaults to account (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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.V2024.IdentityHistoryAPI.ListIdentityAccessItems(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.ListIdentityAccessItems(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Type_(type_).Limit(limit).Count(count).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentityAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityAccessItems`: []ListIdentityAccessItems200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentityAccessItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-snapshot-access-items +:::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 + ``` +::: +Gets the list of identity access items at a given date filterd by item type +This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-snapshot-access-items) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | +**date** | **string** | The specified date | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentitySnapshotAccessItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **type_** | **string** | The access item type | + +### Return type + +[**[]ListIdentityAccessItems200ResponseInner**](../models/list-identity-access-items200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + date := `2007-03-01T13:00:00Z` // string | The specified date # string | The specified date + 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") + type_ := `account` // string | The access item type (optional) # string | The access item type (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityHistoryAPI.ListIdentitySnapshotAccessItems(context.Background(), id, date).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.ListIdentitySnapshotAccessItems(context.Background(), id, date).XSailPointExperimental(xSailPointExperimental).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentitySnapshotAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentitySnapshotAccessItems`: []ListIdentityAccessItems200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentitySnapshotAccessItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-snapshots +:::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 + ``` +::: +Lists all the snapshots for the identity +This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-snapshots) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentitySnapshotsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **start** | **string** | The specified start date | + **interval** | **string** | The interval indicating the range in day or month for the specified interval-name | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]IdentitySnapshotSummaryResponse**](../models/identity-snapshot-summary-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + start := `2007-03-01T13:00:00Z` // string | The specified start date (optional) # string | The specified start date (optional) + interval := `interval_example` // string | The interval indicating the range in day or month for the specified interval-name (optional) # string | The interval indicating the range in day or month for the specified interval-name (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityHistoryAPI.ListIdentitySnapshots(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.ListIdentitySnapshots(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Start(start).Interval(interval).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentitySnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentitySnapshots`: []IdentitySnapshotSummaryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentitySnapshots`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/IdentityProfilesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/IdentityProfilesAPI.md new file mode 100644 index 000000000..5dccdd394 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/IdentityProfilesAPI.md @@ -0,0 +1,894 @@ +--- +id: v2024-identity-profiles +title: IdentityProfiles +pagination_label: IdentityProfiles +sidebar_label: IdentityProfiles +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfiles', 'V2024IdentityProfiles'] +slug: /tools/sdk/go/v2024/methods/identity-profiles +tags: ['SDK', 'Software Development Kit', 'IdentityProfiles', 'V2024IdentityProfiles'] +--- + +# IdentityProfilesAPI + Use this API to implement identity profile functionality. +With this functionality in place, administrators can view identity profiles and their configurations. + +Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. + +In Identity Security Cloud, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. +This list shows some details about each identity profile, along with its status. +They can select an identity profile to view its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. + +Refer to [Creating Identity Profiles](https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html) for more information about identity profiles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-identity-profile**](#create-identity-profile) | **Post** `/identity-profiles` | Create Identity Profile +[**delete-identity-profile**](#delete-identity-profile) | **Delete** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile +[**delete-identity-profiles**](#delete-identity-profiles) | **Post** `/identity-profiles/bulk-delete` | Delete Identity Profiles +[**export-identity-profiles**](#export-identity-profiles) | **Get** `/identity-profiles/export` | Export Identity Profiles +[**generate-identity-preview**](#generate-identity-preview) | **Post** `/identity-profiles/identity-preview` | Generate Identity Profile Preview +[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **Get** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config +[**get-identity-profile**](#get-identity-profile) | **Get** `/identity-profiles/{identity-profile-id}` | Get Identity Profile +[**import-identity-profiles**](#import-identity-profiles) | **Post** `/identity-profiles/import` | Import Identity Profiles +[**list-identity-profiles**](#list-identity-profiles) | **Get** `/identity-profiles` | List Identity Profiles +[**sync-identity-profile**](#sync-identity-profile) | **Post** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile +[**update-identity-profile**](#update-identity-profile) | **Patch** `/identity-profiles/{identity-profile-id}` | Update Identity Profile + + +## create-identity-profile +Create Identity Profile +Creates an identity profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-profile) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityProfile** | [**IdentityProfile**](../models/identity-profile) | | + +### Return type + +[**IdentityProfile**](../models/identity-profile) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityprofile := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + }`) // IdentityProfile | + + + var identityProfile v2024.IdentityProfile + if err := json.Unmarshal(identityprofile, &identityProfile); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.CreateIdentityProfile(context.Background()).IdentityProfile(identityProfile).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.CreateIdentityProfile(context.Background()).IdentityProfile(identityProfile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.CreateIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.CreateIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-identity-profile +Delete Identity Profile +Delete an identity profile by ID. +On success, this endpoint will return a reference to the bulk delete task result. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**TaskResultSimplified**](../models/task-result-simplified) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.DeleteIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.DeleteIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.DeleteIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteIdentityProfile`: TaskResultSimplified + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.DeleteIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-identity-profiles +Delete Identity Profiles +This deletes multiple Identity Profiles via a list of supplied IDs. + +On success, this endpoint will return a reference to the bulk delete task result. + +The following rights are required to access this endpoint: idn:identity-profile:delete + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityProfilesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestBody** | **[]string** | Identity Profile bulk delete request body. | + +### Return type + +[**TaskResultSimplified**](../models/task-result-simplified) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestbody := []byte(``) // []string | Identity Profile bulk delete request body. + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.DeleteIdentityProfiles(context.Background()).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.DeleteIdentityProfiles(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.DeleteIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteIdentityProfiles`: TaskResultSimplified + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.DeleteIdentityProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## export-identity-profiles +Export Identity Profiles +This exports existing identity profiles in the format specified by the sp-config service. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-identity-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportIdentityProfilesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ne* **name**: *eq, ne* **priority**: *eq, ne* | + **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: **id, name, priority** | + +### Return type + +[**[]IdentityProfileExportedObject**](../models/identity-profile-exported-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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, ne* **name**: *eq, ne* **priority**: *eq, ne* (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, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + sorters := `id,name` // 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: **id, name, priority** (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: **id, name, priority** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.ExportIdentityProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.ExportIdentityProfiles(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ExportIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportIdentityProfiles`: []IdentityProfileExportedObject + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ExportIdentityProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## generate-identity-preview +:::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 + ``` +::: +Generate Identity Profile Preview +This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy''s attribute config is applied. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/generate-identity-preview) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGenerateIdentityPreviewRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **identityPreviewRequest** | [**IdentityPreviewRequest**](../models/identity-preview-request) | Identity Preview request body. | + +### Return type + +[**IdentityPreviewResponse**](../models/identity-preview-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + identitypreviewrequest := []byte(`{ + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + }`) // IdentityPreviewRequest | Identity Preview request body. + + + var identityPreviewRequest v2024.IdentityPreviewRequest + if err := json.Unmarshal(identitypreviewrequest, &identityPreviewRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.GenerateIdentityPreview(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityPreviewRequest(identityPreviewRequest).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.GenerateIdentityPreview(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityPreviewRequest(identityPreviewRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GenerateIdentityPreview``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GenerateIdentityPreview`: IdentityPreviewResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GenerateIdentityPreview`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-default-identity-attribute-config +Get default Identity Attribute Config +This returns the default identity attribute config. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-default-identity-attribute-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | The Identity Profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDefaultIdentityAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityAttributeConfig**](../models/identity-attribute-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | The Identity Profile ID. # string | The Identity Profile ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.GetDefaultIdentityAttributeConfig(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.GetDefaultIdentityAttributeConfig(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GetDefaultIdentityAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDefaultIdentityAttributeConfig`: IdentityAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GetDefaultIdentityAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-profile +Get Identity Profile +Get a single identity profile by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityProfile**](../models/identity-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.GetIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.GetIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GetIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GetIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-identity-profiles +Import Identity Profiles +This imports previously exported identity profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-identity-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportIdentityProfilesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityProfileExportedObject** | [**[]IdentityProfileExportedObject**](../models/identity-profile-exported-object) | Previously exported Identity Profiles. | + +### Return type + +[**ObjectImportResult**](../models/object-import-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityprofileexportedobject := []byte(``) // []IdentityProfileExportedObject | Previously exported Identity Profiles. + + + var identityProfileExportedObject v2024.[]IdentityProfileExportedObject + if err := json.Unmarshal(identityprofileexportedobject, &identityProfileExportedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.ImportIdentityProfiles(context.Background()).IdentityProfileExportedObject(identityProfileExportedObject).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.ImportIdentityProfiles(context.Background()).IdentityProfileExportedObject(identityProfileExportedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ImportIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportIdentityProfiles`: ObjectImportResult + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ImportIdentityProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-profiles +List Identity Profiles +Get a list of identity profiles, based on the specified query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityProfilesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* | + **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: **id, name, priority, created, modified, owner.id, owner.name** | + +### Return type + +[**[]IdentityProfile**](../models/identity-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) + sorters := `id,name` // 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: **id, name, priority, created, modified, owner.id, owner.name** (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: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.ListIdentityProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.ListIdentityProfiles(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ListIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityProfiles`: []IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ListIdentityProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## sync-identity-profile +Process identities under profile +Process identities under the profile +This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. +This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. +This operation will perform the following activities on all identities under the identity profile. +1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/sync-identity-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | The Identity Profile ID to be processed | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSyncIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | The Identity Profile ID to be processed # string | The Identity Profile ID to be processed + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.SyncIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.SyncIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.SyncIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SyncIdentityProfile`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.SyncIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-identity-profile +Update Identity Profile +Update a specified identity profile with this PATCH request. + +You cannot update these fields: +* id +* created +* modified +* identityCount +* identityRefreshRequired +* Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-identity-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +[**IdentityProfile**](../models/identity-profile) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + jsonpatchoperation := []byte(`[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]`) // []JsonPatchOperation | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.UpdateIdentityProfile(context.Background(), identityProfileId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.UpdateIdentityProfile(context.Background(), identityProfileId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.UpdateIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.UpdateIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/Index.md b/docs/tools/sdk/go/Reference/V2024/Methods/Index.md new file mode 100644 index 000000000..cfb246fd4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/Index.md @@ -0,0 +1,29 @@ +--- +id: methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_class_name: methods +keywords: ['go', 'Golang', 'sdk', 'methods'] +slug: /tools/sdk/go/v2024/methods +tags: ['SDK', 'Software Development Kit', 'v2024', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the Python SDK for **V2024** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/LifecycleStatesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/LifecycleStatesAPI.md new file mode 100644 index 000000000..4a5b05403 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/LifecycleStatesAPI.md @@ -0,0 +1,524 @@ +--- +id: v2024-lifecycle-states +title: LifecycleStates +pagination_label: LifecycleStates +sidebar_label: LifecycleStates +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LifecycleStates', 'V2024LifecycleStates'] +slug: /tools/sdk/go/v2024/methods/lifecycle-states +tags: ['SDK', 'Software Development Kit', 'LifecycleStates', 'V2024LifecycleStates'] +--- + +# LifecycleStatesAPI + Use this API to implement and customize lifecycle state functionality. +With this functionality in place, administrators can create and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have. + +A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with Identity Security Cloud: 'Active' and 'Inactive.' +When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. +The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. +This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. + +Administrators can create a variety of custom lifecycle states. Refer to [Planning New Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#planning-new-lifecycle-states) for some custom lifecycle state ideas. + +Administrators must define the criteria for being in each lifecycle state, and they must define how Identity Security Cloud manages users' access to apps and sources for each lifecycle state. + +In Identity Security Cloud, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to either select the lifecycle state they want to modify or create a new lifecycle state. + +In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: + +- Enable/disable the lifecycle state for the identity profile. + +- Enable/disable source accounts for the identity profile's lifecycle state. + +- Add existing access profiles to grant to the identity profiles in that lifecycle state. + +- Create a new access profile to grant to the identity profile in that lifecycle state. + +Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. +To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. +For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states. + +During scheduled refreshes, Identity Security Cloud evaluates lifecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. +If the identities are missing access, Identity Security Cloud provisions that access. + +Administrators can also use the 'Provisioning' tab to configure email notifications for Identity Security Cloud to send whenever an identity with that identity profile has a lifecycle state change. +Refer to [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so. + +An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' +Refer to [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. + +Refer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-lifecycle-state**](#create-lifecycle-state) | **Post** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create Lifecycle State +[**delete-lifecycle-state**](#delete-lifecycle-state) | **Delete** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete Lifecycle State +[**get-lifecycle-state**](#get-lifecycle-state) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State +[**get-lifecycle-states**](#get-lifecycle-states) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists LifecycleStates +[**set-lifecycle-state**](#set-lifecycle-state) | **Post** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State +[**update-lifecycle-states**](#update-lifecycle-states) | **Patch** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State + + +## create-lifecycle-state +Create Lifecycle State +Use this endpoint to create a lifecycle state. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-lifecycle-state) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateLifecycleStateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **lifecycleState** | [**LifecycleState**](../models/lifecycle-state) | Lifecycle state to be created. | + +### Return type + +[**LifecycleState**](../models/lifecycle-state) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile ID. + lifecyclestate := []byte(`{ + "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], + "emailNotificationOption" : { + "notifyManagers" : true, + "notifySpecificUsers" : true, + "emailAddressList" : [ "test@test.com", "test2@test.com" ], + "notifyAllAdmins" : true + }, + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Lifecycle description", + "accountActions" : [ { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }, { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } ], + "id" : "id12345", + "identityCount" : 42, + "technicalName" : "Technical Name", + "identityState" : "identityState", + "enabled" : true + }`) // LifecycleState | Lifecycle state to be created. + + + var lifecycleState v2024.LifecycleState + if err := json.Unmarshal(lifecyclestate, &lifecycleState); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.LifecycleStatesAPI.CreateLifecycleState(context.Background(), identityProfileId).LifecycleState(lifecycleState).Execute() + //resp, r, err := apiClient.V2024.LifecycleStatesAPI.CreateLifecycleState(context.Background(), identityProfileId).LifecycleState(lifecycleState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.CreateLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateLifecycleState`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.CreateLifecycleState`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-lifecycle-state +Delete Lifecycle State +Use this endpoint to delete the lifecycle state by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-lifecycle-state) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | +**lifecycleStateId** | **string** | Lifecycle state ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteLifecycleStateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**LifecyclestateDeleted**](../models/lifecyclestate-deleted) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.LifecycleStatesAPI.DeleteLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + //resp, r, err := apiClient.V2024.LifecycleStatesAPI.DeleteLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.DeleteLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteLifecycleState`: LifecyclestateDeleted + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.DeleteLifecycleState`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-lifecycle-state +Get Lifecycle State +Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-lifecycle-state) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | +**lifecycleStateId** | **string** | Lifecycle state ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLifecycleStateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**LifecycleState**](../models/lifecycle-state) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.LifecycleStatesAPI.GetLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + //resp, r, err := apiClient.V2024.LifecycleStatesAPI.GetLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.GetLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLifecycleState`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.GetLifecycleState`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-lifecycle-states +Lists LifecycleStates +Use this endpoint to list all lifecycle states by their associated identity profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-lifecycle-states) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLifecycleStatesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **created, modified** | + +### Return type + +[**[]LifecycleState**](../models/lifecycle-state) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `created,modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.LifecycleStatesAPI.GetLifecycleStates(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2024.LifecycleStatesAPI.GetLifecycleStates(context.Background(), identityProfileId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.GetLifecycleStates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLifecycleStates`: []LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.GetLifecycleStates`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-lifecycle-state +Set Lifecycle State +Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-lifecycle-state) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | ID of the identity to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetLifecycleStateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **setLifecycleStateRequest** | [**SetLifecycleStateRequest**](../models/set-lifecycle-state-request) | | + +### Return type + +[**SetLifecycleState200Response**](../models/set-lifecycle-state200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `2c9180857893f1290178944561990364` // string | ID of the identity to update. # string | ID of the identity to update. + setlifecyclestaterequest := []byte(``) // SetLifecycleStateRequest | + + + var setLifecycleStateRequest v2024.SetLifecycleStateRequest + if err := json.Unmarshal(setlifecyclestaterequest, &setLifecycleStateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.LifecycleStatesAPI.SetLifecycleState(context.Background(), identityId).SetLifecycleStateRequest(setLifecycleStateRequest).Execute() + //resp, r, err := apiClient.V2024.LifecycleStatesAPI.SetLifecycleState(context.Background(), identityId).SetLifecycleStateRequest(setLifecycleStateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.SetLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetLifecycleState`: SetLifecycleState200Response + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.SetLifecycleState`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-lifecycle-states +Update Lifecycle State +Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-lifecycle-states) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | +**lifecycleStateId** | **string** | Lifecycle state ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateLifecycleStatesRequest struct via the builder pattern + + +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 | + +### Return type + +[**LifecycleState**](../models/lifecycle-state) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.LifecycleStatesAPI.UpdateLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.LifecycleStatesAPI.UpdateLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.UpdateLifecycleStates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateLifecycleStates`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.UpdateLifecycleStates`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/MFAConfigurationAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/MFAConfigurationAPI.md new file mode 100644 index 000000000..cf8506921 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/MFAConfigurationAPI.md @@ -0,0 +1,488 @@ +--- +id: v2024-mfa-configuration +title: MFAConfiguration +pagination_label: MFAConfiguration +sidebar_label: MFAConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MFAConfiguration', 'V2024MFAConfiguration'] +slug: /tools/sdk/go/v2024/methods/mfa-configuration +tags: ['SDK', 'Software Development Kit', 'MFAConfiguration', 'V2024MFAConfiguration'] +--- + +# MFAConfigurationAPI + Configure and test multifactor authentication (MFA) methods +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-mfa-duo-config**](#get-mfa-duo-config) | **Get** `/mfa/duo-web/config` | Configuration of Duo MFA method +[**get-mfa-kba-config**](#get-mfa-kba-config) | **Get** `/mfa/kba/config` | Configuration of KBA MFA method +[**get-mfa-okta-config**](#get-mfa-okta-config) | **Get** `/mfa/okta-verify/config` | Configuration of Okta MFA method +[**set-mfa-duo-config**](#set-mfa-duo-config) | **Put** `/mfa/duo-web/config` | Set Duo MFA configuration +[**set-mfakba-config**](#set-mfakba-config) | **Post** `/mfa/kba/config/answers` | Set MFA KBA configuration +[**set-mfa-okta-config**](#set-mfa-okta-config) | **Put** `/mfa/okta-verify/config` | Set Okta MFA configuration +[**test-mfa-config**](#test-mfa-config) | **Get** `/mfa/{method}/test` | MFA method's test configuration + + +## get-mfa-duo-config +Configuration of Duo MFA method +This API returns the configuration of an Duo MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mfa-duo-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMFADuoConfigRequest struct via the builder pattern + + +### Return type + +[**MfaDuoConfig**](../models/mfa-duo-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MFAConfigurationAPI.GetMFADuoConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.MFAConfigurationAPI.GetMFADuoConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFADuoConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFADuoConfig`: MfaDuoConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFADuoConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-mfa-kba-config +Configuration of KBA MFA method +This API returns the KBA configuration for MFA. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mfa-kba-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMFAKbaConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allLanguages** | **bool** | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false | + +### Return type + +[**[]KbaQuestion**](../models/kba-question) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + allLanguages := allLanguages=true // bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MFAConfigurationAPI.GetMFAKbaConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.MFAConfigurationAPI.GetMFAKbaConfig(context.Background()).AllLanguages(allLanguages).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFAKbaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFAKbaConfig`: []KbaQuestion + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFAKbaConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-mfa-okta-config +Configuration of Okta MFA method +This API returns the configuration of an Okta MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mfa-okta-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMFAOktaConfigRequest struct via the builder pattern + + +### Return type + +[**MfaOktaConfig**](../models/mfa-okta-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MFAConfigurationAPI.GetMFAOktaConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.MFAConfigurationAPI.GetMFAOktaConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFAOktaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFAOktaConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFAOktaConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-mfa-duo-config +Set Duo MFA configuration +This API sets the configuration of an Duo MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-mfa-duo-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetMFADuoConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mfaDuoConfig** | [**MfaDuoConfig**](../models/mfa-duo-config) | | + +### Return type + +[**MfaDuoConfig**](../models/mfa-duo-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + mfaduoconfig := []byte(`{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }`) // MfaDuoConfig | + + + var mfaDuoConfig v2024.MfaDuoConfig + if err := json.Unmarshal(mfaduoconfig, &mfaDuoConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MFAConfigurationAPI.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute() + //resp, r, err := apiClient.V2024.MFAConfigurationAPI.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFADuoConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFADuoConfig`: MfaDuoConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFADuoConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-mfakba-config +Set MFA KBA configuration +This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-mfakba-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetMFAKBAConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **kbaAnswerRequestItem** | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | | + +### Return type + +[**[]KbaAnswerResponseItem**](../models/kba-answer-response-item) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + kbaanswerrequestitem := []byte(`[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]`) // []KbaAnswerRequestItem | + + + var kbaAnswerRequestItem v2024.[]KbaAnswerRequestItem + if err := json.Unmarshal(kbaanswerrequestitem, &kbaAnswerRequestItem); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MFAConfigurationAPI.SetMFAKBAConfig(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + //resp, r, err := apiClient.V2024.MFAConfigurationAPI.SetMFAKBAConfig(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFAKBAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFAKBAConfig`: []KbaAnswerResponseItem + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFAKBAConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-mfa-okta-config +Set Okta MFA configuration +This API sets the configuration of an Okta MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-mfa-okta-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetMFAOktaConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mfaOktaConfig** | [**MfaOktaConfig**](../models/mfa-okta-config) | | + +### Return type + +[**MfaOktaConfig**](../models/mfa-okta-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + mfaoktaconfig := []byte(`{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }`) // MfaOktaConfig | + + + var mfaOktaConfig v2024.MfaOktaConfig + if err := json.Unmarshal(mfaoktaconfig, &mfaOktaConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MFAConfigurationAPI.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute() + //resp, r, err := apiClient.V2024.MFAConfigurationAPI.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFAOktaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFAOktaConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFAOktaConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-mfa-config +MFA method's test configuration +This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-mfa-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**method** | **string** | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestMFAConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**MfaConfigTestResponse**](../models/mfa-config-test-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + method := `okta-verify` // string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MFAConfigurationAPI.TestMFAConfig(context.Background(), method).Execute() + //resp, r, err := apiClient.V2024.MFAConfigurationAPI.TestMFAConfig(context.Background(), method).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.TestMFAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestMFAConfig`: MfaConfigTestResponse + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.TestMFAConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountClassifyAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountClassifyAPI.md new file mode 100644 index 000000000..63db027a1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountClassifyAPI.md @@ -0,0 +1,89 @@ +--- +id: v2024-machine-account-classify +title: MachineAccountClassify +pagination_label: MachineAccountClassify +sidebar_label: MachineAccountClassify +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MachineAccountClassify', 'V2024MachineAccountClassify'] +slug: /tools/sdk/go/v2024/methods/machine-account-classify +tags: ['SDK', 'Software Development Kit', 'MachineAccountClassify', 'V2024MachineAccountClassify'] +--- + +# MachineAccountClassifyAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**send-classify-machine-account**](#send-classify-machine-account) | **Post** `/accounts/{id}/classify` | Classify a Single Machine Account + + +## send-classify-machine-account +Classify a Single Machine Account +Use this API to classify a single machine account. +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-classify-machine-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendClassifyMachineAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **classificationMode** | **string** | Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. | [default to "default"] + +### Return type + +[**SendClassifyMachineAccount200Response**](../models/send-classify-machine-account200-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + classificationMode := `forceMachine` // string | Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. (optional) (default to "default") # string | Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. (optional) (default to "default") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineAccountClassifyAPI.SendClassifyMachineAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.MachineAccountClassifyAPI.SendClassifyMachineAccount(context.Background(), id).ClassificationMode(classificationMode).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountClassifyAPI.SendClassifyMachineAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendClassifyMachineAccount`: SendClassifyMachineAccount200Response + fmt.Fprintf(os.Stdout, "Response from `MachineAccountClassifyAPI.SendClassifyMachineAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountMappingsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountMappingsAPI.md new file mode 100644 index 000000000..8d0035a2f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountMappingsAPI.md @@ -0,0 +1,347 @@ +--- +id: v2024-machine-account-mappings +title: MachineAccountMappings +pagination_label: MachineAccountMappings +sidebar_label: MachineAccountMappings +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MachineAccountMappings', 'V2024MachineAccountMappings'] +slug: /tools/sdk/go/v2024/methods/machine-account-mappings +tags: ['SDK', 'Software Development Kit', 'MachineAccountMappings', 'V2024MachineAccountMappings'] +--- + +# MachineAccountMappingsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-machine-account-mappings**](#create-machine-account-mappings) | **Post** `/sources/{sourceId}/machine-account-mappings` | Create Machine Account Mappings +[**delete-machine-account-mappings**](#delete-machine-account-mappings) | **Delete** `/sources/{sourceId}/machine-account-mappings` | Delete Source's Machine Account Mappings +[**list-machine-account-mappings**](#list-machine-account-mappings) | **Get** `/sources/{sourceId}/machine-account-mappings` | Machine Account Mapping for Source +[**set-machine-account-mappings**](#set-machine-account-mappings) | **Put** `/sources/{sourceId}/machine-mappings` | Update Source's Machine Account Mappings + + +## create-machine-account-mappings +Create Machine Account Mappings +Creates Machine Account Mappings for both identities and accounts for a source. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-machine-account-mappings) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateMachineAccountMappingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **attributeMappings** | [**AttributeMappings**](../models/attribute-mappings) | | + +### Return type + +[**[]AttributeMappings**](../models/attribute-mappings) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source ID. # string | Source ID. + attributemappings := []byte(`{ + "transformDefinition" : { + "attributes" : { + "input" : { + "attributes" : { + "name" : "8d3e0094e99445de98eef6c75e25jc04", + "attributeName" : "givenName", + "sourceName" : "delimited-src" + }, + "type" : "accountAttribute" + } + }, + "id" : "ToUpper", + "type" : "reference" + }, + "target" : { + "sourceId" : "2c9180835d2e5168015d32f890ca1581", + "attributeName" : "businessApplication", + "type" : "IDENTITY" + } + }`) // AttributeMappings | + + + var attributeMappings v2024.AttributeMappings + if err := json.Unmarshal(attributemappings, &attributeMappings); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineAccountMappingsAPI.CreateMachineAccountMappings(context.Background(), id).AttributeMappings(attributeMappings).Execute() + //resp, r, err := apiClient.V2024.MachineAccountMappingsAPI.CreateMachineAccountMappings(context.Background(), id).AttributeMappings(attributeMappings).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountMappingsAPI.CreateMachineAccountMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateMachineAccountMappings`: []AttributeMappings + fmt.Fprintf(os.Stdout, "Response from `MachineAccountMappingsAPI.CreateMachineAccountMappings`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-machine-account-mappings +Delete Source's Machine Account Mappings +Use this API to remove machine account attribute mappings for a Source. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-machine-account-mappings) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteMachineAccountMappingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | source ID. # string | source ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.MachineAccountMappingsAPI.DeleteMachineAccountMappings(context.Background(), id).Execute() + //r, err := apiClient.V2024.MachineAccountMappingsAPI.DeleteMachineAccountMappings(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountMappingsAPI.DeleteMachineAccountMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## list-machine-account-mappings +Machine Account Mapping for Source +Retrieves Machine account mappings for a specified source using Source ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-account-mappings) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListMachineAccountMappingsRequest struct via the builder pattern + + +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 + +[**[]AttributeMappings**](../models/attribute-mappings) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source ID # string | 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.V2024.MachineAccountMappingsAPI.ListMachineAccountMappings(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.MachineAccountMappingsAPI.ListMachineAccountMappings(context.Background(), id).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountMappingsAPI.ListMachineAccountMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListMachineAccountMappings`: []AttributeMappings + fmt.Fprintf(os.Stdout, "Response from `MachineAccountMappingsAPI.ListMachineAccountMappings`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-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) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetMachineAccountMappingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **attributeMappings** | [**AttributeMappings**](../models/attribute-mappings) | | + +### Return type + +[**[]AttributeMappings**](../models/attribute-mappings) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source ID. # string | Source ID. + attributemappings := []byte(`{ + "transformDefinition" : { + "attributes" : { + "input" : { + "attributes" : { + "name" : "8d3e0094e99445de98eef6c75e25jc04", + "attributeName" : "givenName", + "sourceName" : "delimited-src" + }, + "type" : "accountAttribute" + } + }, + "id" : "ToUpper", + "type" : "reference" + }, + "target" : { + "sourceId" : "2c9180835d2e5168015d32f890ca1581", + "attributeName" : "businessApplication", + "type" : "IDENTITY" + } + }`) // AttributeMappings | + + + var attributeMappings v2024.AttributeMappings + if err := json.Unmarshal(attributemappings, &attributeMappings); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineAccountMappingsAPI.SetMachineAccountMappings(context.Background(), id).AttributeMappings(attributeMappings).Execute() + //resp, r, err := apiClient.V2024.MachineAccountMappingsAPI.SetMachineAccountMappings(context.Background(), id).AttributeMappings(attributeMappings).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountMappingsAPI.SetMachineAccountMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMachineAccountMappings`: []AttributeMappings + fmt.Fprintf(os.Stdout, "Response from `MachineAccountMappingsAPI.SetMachineAccountMappings`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountsAPI.md new file mode 100644 index 000000000..4f91da0ea --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/MachineAccountsAPI.md @@ -0,0 +1,272 @@ +--- +id: v2024-machine-accounts +title: MachineAccounts +pagination_label: MachineAccounts +sidebar_label: MachineAccounts +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MachineAccounts', 'V2024MachineAccounts'] +slug: /tools/sdk/go/v2024/methods/machine-accounts +tags: ['SDK', 'Software Development Kit', 'MachineAccounts', 'V2024MachineAccounts'] +--- + +# MachineAccountsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-machine-account**](#get-machine-account) | **Get** `/machine-accounts/{id}` | Machine Account Details +[**list-machine-accounts**](#list-machine-accounts) | **Get** `/machine-accounts` | Machine Accounts List +[**update-machine-account**](#update-machine-account) | **Patch** `/machine-accounts/{id}` | Update a Machine Account + + +## get-machine-account +:::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 + ``` +::: +Machine Account Details +Use this API to return the details for a single machine account by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Machine Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMachineAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**MachineAccount**](../models/machine-account) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Account ID. # string | Machine 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.MachineAccountsAPI.GetMachineAccount(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.MachineAccountsAPI.GetMachineAccount(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountsAPI.GetMachineAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMachineAccount`: MachineAccount + fmt.Fprintf(os.Stdout, "Response from `MachineAccountsAPI.GetMachineAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-machine-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 + ``` +::: +Machine Accounts List +This returns a list of machine accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-accounts) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListMachineAccountsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *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: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** | + +### Return type + +[**[]MachineAccount**](../models/machine-account) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `identityId eq "2c9180858082150f0180893dbaf44201"` // 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, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *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, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) + sorters := `id,name` // 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: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (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: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineAccountsAPI.ListMachineAccounts(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.MachineAccountsAPI.ListMachineAccounts(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountsAPI.ListMachineAccounts``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListMachineAccounts`: []MachineAccount + fmt.Fprintf(os.Stdout, "Response from `MachineAccountsAPI.ListMachineAccounts`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-machine-account +:::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 a Machine Account +Use this API to update machine accounts details. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-machine-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Machine Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateMachineAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **requestBody** | **[]map[string]interface{}** | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes | + +### Return type + +[**MachineAccount**](../models/machine-account) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Account ID. # string | Machine 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") + requestbody := []byte(`[{op=add, path=/environment, value=test}]`) // []map[string]interface{} | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineAccountsAPI.UpdateMachineAccount(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2024.MachineAccountsAPI.UpdateMachineAccount(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountsAPI.UpdateMachineAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateMachineAccount`: MachineAccount + fmt.Fprintf(os.Stdout, "Response from `MachineAccountsAPI.UpdateMachineAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/MachineClassificationConfigAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/MachineClassificationConfigAPI.md new file mode 100644 index 000000000..fdc0c44e2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/MachineClassificationConfigAPI.md @@ -0,0 +1,233 @@ +--- +id: v2024-machine-classification-config +title: MachineClassificationConfig +pagination_label: MachineClassificationConfig +sidebar_label: MachineClassificationConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MachineClassificationConfig', 'V2024MachineClassificationConfig'] +slug: /tools/sdk/go/v2024/methods/machine-classification-config +tags: ['SDK', 'Software Development Kit', 'MachineClassificationConfig', 'V2024MachineClassificationConfig'] +--- + +# MachineClassificationConfigAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-machine-classification-config**](#delete-machine-classification-config) | **Delete** `/sources/{sourceId}/machine-classification-config` | Delete Source's Classification Config +[**get-machine-classification-config**](#get-machine-classification-config) | **Get** `/sources/{sourceId}/machine-classification-config` | Machine Classification Config for Source +[**set-machine-classification-config**](#set-machine-classification-config) | **Put** `/sources/{sourceId}/machine-classification-config` | Update Source's Classification Config + + +## delete-machine-classification-config +Delete Source's Classification Config +Use this API to remove Classification Config for a Source. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-machine-classification-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteMachineClassificationConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source ID. # string | Source ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.MachineClassificationConfigAPI.DeleteMachineClassificationConfig(context.Background(), id).Execute() + //r, err := apiClient.V2024.MachineClassificationConfigAPI.DeleteMachineClassificationConfig(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineClassificationConfigAPI.DeleteMachineClassificationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-machine-classification-config +Machine Classification Config for Source +This API returns a Machine Classification Config for a Source using Source ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-classification-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMachineClassificationConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**MachineClassificationConfig**](../models/machine-classification-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source ID # string | Source ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineClassificationConfigAPI.GetMachineClassificationConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.MachineClassificationConfigAPI.GetMachineClassificationConfig(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineClassificationConfigAPI.GetMachineClassificationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMachineClassificationConfig`: MachineClassificationConfig + fmt.Fprintf(os.Stdout, "Response from `MachineClassificationConfigAPI.GetMachineClassificationConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-machine-classification-config +Update Source's Classification Config +Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-machine-classification-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetMachineClassificationConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **machineClassificationConfig** | [**MachineClassificationConfig**](../models/machine-classification-config) | | + +### Return type + +[**MachineClassificationConfig**](../models/machine-classification-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source ID. # string | Source ID. + machineclassificationconfig := []byte(`{ + "criteria" : "criteria", + "created" : "2017-07-11T18:45:37.098Z", + "modified" : "2018-06-25T20:22:28.104Z", + "classificationMethod" : "SOURCE", + "enabled" : true + }`) // MachineClassificationConfig | + + + var machineClassificationConfig v2024.MachineClassificationConfig + if err := json.Unmarshal(machineclassificationconfig, &machineClassificationConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineClassificationConfigAPI.SetMachineClassificationConfig(context.Background(), id).MachineClassificationConfig(machineClassificationConfig).Execute() + //resp, r, err := apiClient.V2024.MachineClassificationConfigAPI.SetMachineClassificationConfig(context.Background(), id).MachineClassificationConfig(machineClassificationConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineClassificationConfigAPI.SetMachineClassificationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMachineClassificationConfig`: MachineClassificationConfig + fmt.Fprintf(os.Stdout, "Response from `MachineClassificationConfigAPI.SetMachineClassificationConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/MachineIdentitiesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/MachineIdentitiesAPI.md new file mode 100644 index 000000000..e8dbf53a9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/MachineIdentitiesAPI.md @@ -0,0 +1,442 @@ +--- +id: v2024-machine-identities +title: MachineIdentities +pagination_label: MachineIdentities +sidebar_label: MachineIdentities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MachineIdentities', 'V2024MachineIdentities'] +slug: /tools/sdk/go/v2024/methods/machine-identities +tags: ['SDK', 'Software Development Kit', 'MachineIdentities', 'V2024MachineIdentities'] +--- + +# MachineIdentitiesAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-machine-identity**](#create-machine-identity) | **Post** `/machine-identities` | Create Machine Identities +[**delete-machine-identity**](#delete-machine-identity) | **Delete** `/machine-identities/{id}` | Delete machine identity +[**get-machine-identity**](#get-machine-identity) | **Get** `/machine-identities/{id}` | Machine Identity Details +[**list-machine-identities**](#list-machine-identities) | **Get** `/machine-identities` | List Machine Identities +[**update-machine-identity**](#update-machine-identity) | **Patch** `/machine-identities/{id}` | Update a Machine Identity + + +## create-machine-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 + ``` +::: +Create Machine Identities +Use this API to create a machine identity. +The maximum supported length for the description field is 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-machine-identity) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateMachineIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **machineIdentity** | [**MachineIdentity**](../models/machine-identity) | | + +### Return type + +[**MachineIdentity**](../models/machine-identity) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + machineidentity := []byte(`{ + "created" : "2015-05-28T14:07:17Z", + "businessApplication" : "ADService", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "", + "attributes" : "{\"Region\":\"EU\"}", + "id" : "id12345", + "manuallyEdited" : true + }`) // MachineIdentity | + + + var machineIdentity v2024.MachineIdentity + if err := json.Unmarshal(machineidentity, &machineIdentity); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineIdentitiesAPI.CreateMachineIdentity(context.Background()).XSailPointExperimental(xSailPointExperimental).MachineIdentity(machineIdentity).Execute() + //resp, r, err := apiClient.V2024.MachineIdentitiesAPI.CreateMachineIdentity(context.Background()).XSailPointExperimental(xSailPointExperimental).MachineIdentity(machineIdentity).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.CreateMachineIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateMachineIdentity`: MachineIdentity + fmt.Fprintf(os.Stdout, "Response from `MachineIdentitiesAPI.CreateMachineIdentity`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-machine-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 machine identity +The API returns successful response if the requested machine identity was deleted. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-machine-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Machine Identity ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteMachineIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Identity ID # string | Machine 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.MachineIdentitiesAPI.DeleteMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.MachineIdentitiesAPI.DeleteMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.DeleteMachineIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-machine-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 + ``` +::: +Machine Identity Details +This API returns a single machine identity using the Machine Identity ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Machine Identity ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMachineIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**MachineIdentity**](../models/machine-identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Identity ID # string | Machine 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.MachineIdentitiesAPI.GetMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.MachineIdentitiesAPI.GetMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.GetMachineIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMachineIdentity`: MachineIdentity + fmt.Fprintf(os.Stdout, "Response from `MachineIdentitiesAPI.GetMachineIdentity`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-machine-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 Machine Identities +This API returns a list of machine identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListMachineIdentitiesRequest struct via the builder pattern + + +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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *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: **businessApplication, name** | + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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 + +[**[]MachineIdentity**](../models/machine-identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 := `identityId eq "2c9180858082150f0180893dbaf44201"` // 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) + sorters := `businessApplication` // 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: **businessApplication, name** (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: **businessApplication, name** (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.V2024.MachineIdentitiesAPI.ListMachineIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.MachineIdentitiesAPI.ListMachineIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).Filters(filters).Sorters(sorters).Count(count).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.ListMachineIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListMachineIdentities`: []MachineIdentity + fmt.Fprintf(os.Stdout, "Response from `MachineIdentitiesAPI.ListMachineIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-machine-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 + ``` +::: +Update a Machine Identity +Use this API to update machine identity details. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-machine-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Machine Identity ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateMachineIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **requestBody** | **[]map[string]interface{}** | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +[**MachineIdentity**](../models/machine-identity) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Identity ID. # string | Machine 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") + requestbody := []byte(`[{op=add, path=/attributes/securityRisk, value=medium}]`) // []map[string]interface{} | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineIdentitiesAPI.UpdateMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2024.MachineIdentitiesAPI.UpdateMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.UpdateMachineIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateMachineIdentity`: MachineIdentity + fmt.Fprintf(os.Stdout, "Response from `MachineIdentitiesAPI.UpdateMachineIdentity`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClientsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClientsAPI.md new file mode 100644 index 000000000..833214a20 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClientsAPI.md @@ -0,0 +1,441 @@ +--- +id: v2024-managed-clients +title: ManagedClients +pagination_label: ManagedClients +sidebar_label: ManagedClients +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClients', 'V2024ManagedClients'] +slug: /tools/sdk/go/v2024/methods/managed-clients +tags: ['SDK', 'Software Development Kit', 'ManagedClients', 'V2024ManagedClients'] +--- + +# ManagedClientsAPI + Use this API to implement managed client functionality. +With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-managed-client**](#create-managed-client) | **Post** `/managed-clients` | Create Managed Client +[**delete-managed-client**](#delete-managed-client) | **Delete** `/managed-clients/{id}` | Delete Managed Client +[**get-managed-client**](#get-managed-client) | **Get** `/managed-clients/{id}` | Get Managed Client +[**get-managed-client-status**](#get-managed-client-status) | **Get** `/managed-clients/{id}/status` | Get Managed Client Status +[**get-managed-clients**](#get-managed-clients) | **Get** `/managed-clients` | Get Managed Clients +[**update-managed-client**](#update-managed-client) | **Patch** `/managed-clients/{id}` | Update Managed Client + + +## create-managed-client +Create Managed Client +Create a new managed client. +The API returns a result that includes the managed client ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-managed-client) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateManagedClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **managedClientRequest** | [**ManagedClientRequest**](../models/managed-client-request) | | + +### Return type + +[**ManagedClient**](../models/managed-client) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + managedclientrequest := []byte(`{ + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + }`) // ManagedClientRequest | + + + var managedClientRequest v2024.ManagedClientRequest + if err := json.Unmarshal(managedclientrequest, &managedClientRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClientsAPI.CreateManagedClient(context.Background()).ManagedClientRequest(managedClientRequest).Execute() + //resp, r, err := apiClient.V2024.ManagedClientsAPI.CreateManagedClient(context.Background()).ManagedClientRequest(managedClientRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.CreateManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.CreateManagedClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-managed-client +Delete Managed Client +Delete an existing managed client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-managed-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed client ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteManagedClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ManagedClientsAPI.DeleteManagedClient(context.Background(), id).Execute() + //r, err := apiClient.V2024.ManagedClientsAPI.DeleteManagedClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.DeleteManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-managed-client +Get Managed Client +Get managed client by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed client ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ManagedClient**](../models/managed-client) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClientsAPI.GetManagedClient(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ManagedClientsAPI.GetManagedClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-managed-client-status +Get Managed Client Status +Get a managed client's status, using its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-client-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed client ID to get status for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClientStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **type_** | [**ManagedClientType**](../models/managed-client-type) | Managed client type to get status for. | + +### Return type + +[**ManagedClientStatus**](../models/managed-client-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `aClientId` // string | Managed client ID to get status for. # string | Managed client ID to get status for. + type_ := // ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClientsAPI.GetManagedClientStatus(context.Background(), id).Type_(type_).Execute() + //resp, r, err := apiClient.V2024.ManagedClientsAPI.GetManagedClientStatus(context.Background(), id).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClientStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClientStatus`: ManagedClientStatus + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClientStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-managed-clients +Get Managed Clients +List managed clients. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-clients) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClientsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* | + +### Return type + +[**[]ManagedClient**](../models/managed-client) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "client name"` // 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* **name**: *eq* **clientId**: *eq* **clusterId**: *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* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClientsAPI.GetManagedClients(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ManagedClientsAPI.GetManagedClients(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClients``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClients`: []ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClients`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-managed-client +Update Managed Client +Update an existing managed client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-managed-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed client ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateManagedClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | JSONPatch payload used to update the object. | + +### Return type + +[**ManagedClient**](../models/managed-client) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | JSONPatch payload used to update the object. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClientsAPI.UpdateManagedClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.ManagedClientsAPI.UpdateManagedClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.UpdateManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.UpdateManagedClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClusterTypesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClusterTypesAPI.md new file mode 100644 index 000000000..91b19bdd5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClusterTypesAPI.md @@ -0,0 +1,390 @@ +--- +id: v2024-managed-cluster-types +title: ManagedClusterTypes +pagination_label: ManagedClusterTypes +sidebar_label: ManagedClusterTypes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterTypes', 'V2024ManagedClusterTypes'] +slug: /tools/sdk/go/v2024/methods/managed-cluster-types +tags: ['SDK', 'Software Development Kit', 'ManagedClusterTypes', 'V2024ManagedClusterTypes'] +--- + +# ManagedClusterTypesAPI + Use this API to implement managed cluster types functionality. +With this functionality in place, administrators can modify and delete existing managed cluster types and create new ones. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-managed-cluster-type**](#create-managed-cluster-type) | **Post** `/managed-cluster-types` | Create new Managed Cluster Type +[**delete-managed-cluster-type**](#delete-managed-cluster-type) | **Delete** `/managed-cluster-types/{id}` | Delete a Managed Cluster Type +[**get-managed-cluster-type**](#get-managed-cluster-type) | **Get** `/managed-cluster-types/{id}` | Get a Managed Cluster Type +[**get-managed-cluster-types**](#get-managed-cluster-types) | **Get** `/managed-cluster-types` | Get Managed Cluster Types +[**update-managed-cluster-type**](#update-managed-cluster-type) | **Patch** `/managed-cluster-types/{id}` | Update a Managed Cluster Type + + +## create-managed-cluster-type +Create new Managed Cluster Type +Create a new Managed Cluster Type. +AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. +The API returns a result that includes the Managed Cluster Type ID + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-managed-cluster-type) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateManagedClusterTypeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **managedClusterType** | [**ManagedClusterType**](../models/managed-cluster-type) | | + +### Return type + +[**ManagedClusterType**](../models/managed-cluster-type) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + managedclustertype := []byte(`{ + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + }`) // ManagedClusterType | + + + var managedClusterType v2024.ManagedClusterType + if err := json.Unmarshal(managedclustertype, &managedClusterType); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClusterTypesAPI.CreateManagedClusterType(context.Background()).ManagedClusterType(managedClusterType).Execute() + //resp, r, err := apiClient.V2024.ManagedClusterTypesAPI.CreateManagedClusterType(context.Background()).ManagedClusterType(managedClusterType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.CreateManagedClusterType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateManagedClusterType`: ManagedClusterType + fmt.Fprintf(os.Stdout, "Response from `ManagedClusterTypesAPI.CreateManagedClusterType`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-managed-cluster-type +Delete a Managed Cluster Type +Delete an existing Managed Cluster Type. +AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-managed-cluster-type) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Managed Cluster Type ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteManagedClusterTypeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `aClusterTypeId` // string | The Managed Cluster Type ID # string | The Managed Cluster Type ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ManagedClusterTypesAPI.DeleteManagedClusterType(context.Background(), id).Execute() + //r, err := apiClient.V2024.ManagedClusterTypesAPI.DeleteManagedClusterType(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.DeleteManagedClusterType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-managed-cluster-type +Get a Managed Cluster Type +Get a Managed Cluster Type. +AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-cluster-type) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Managed Cluster Type ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClusterTypeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ManagedClusterType**](../models/managed-cluster-type) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `aClusterTypeId` // string | The Managed Cluster Type ID # string | The Managed Cluster Type ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClusterTypesAPI.GetManagedClusterType(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ManagedClusterTypesAPI.GetManagedClusterType(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.GetManagedClusterType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClusterType`: ManagedClusterType + fmt.Fprintf(os.Stdout, "Response from `ManagedClusterTypesAPI.GetManagedClusterType`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-managed-cluster-types +Get Managed Cluster Types +Get a list of Managed Cluster Types. +AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-cluster-types) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClusterTypesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type_** | **string** | Type descriptor | + **pod** | **string** | Pinned pod (or default) | + **org** | **string** | Pinned org (or default) | + **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] + **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] + +### Return type + +[**[]ManagedClusterType**](../models/managed-cluster-type) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `IDN` // string | Type descriptor (optional) # string | Type descriptor (optional) + pod := `megapod-useast1` // string | Pinned pod (or default) (optional) # string | Pinned pod (or default) (optional) + org := `denali-xyz` // string | Pinned org (or default) (optional) # string | Pinned org (or default) (optional) + 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) + 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) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClusterTypesAPI.GetManagedClusterTypes(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ManagedClusterTypesAPI.GetManagedClusterTypes(context.Background()).Type_(type_).Pod(pod).Org(org).Offset(offset).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.GetManagedClusterTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClusterTypes`: []ManagedClusterType + fmt.Fprintf(os.Stdout, "Response from `ManagedClusterTypesAPI.GetManagedClusterTypes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-managed-cluster-type +Update a Managed Cluster Type +Update an existing Managed Cluster Type. +AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-managed-cluster-type) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Managed Cluster Type ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateManagedClusterTypeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatch** | [**JsonPatch**](../models/json-patch) | The JSONPatch payload used to update the schema. | + +### Return type + +[**ManagedClusterType**](../models/managed-cluster-type) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `aClusterTypeId` // string | The Managed Cluster Type ID # string | The Managed Cluster Type ID + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | The JSONPatch payload used to update the schema. + + + var jsonPatch v2024.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClusterTypesAPI.UpdateManagedClusterType(context.Background(), id).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2024.ManagedClusterTypesAPI.UpdateManagedClusterType(context.Background(), id).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.UpdateManagedClusterType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedClusterType`: ManagedClusterType + fmt.Fprintf(os.Stdout, "Response from `ManagedClusterTypesAPI.UpdateManagedClusterType`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClustersAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClustersAPI.md new file mode 100644 index 000000000..471e4505d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ManagedClustersAPI.md @@ -0,0 +1,587 @@ +--- +id: v2024-managed-clusters +title: ManagedClusters +pagination_label: ManagedClusters +sidebar_label: ManagedClusters +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusters', 'V2024ManagedClusters'] +slug: /tools/sdk/go/v2024/methods/managed-clusters +tags: ['SDK', 'Software Development Kit', 'ManagedClusters', 'V2024ManagedClusters'] +--- + +# ManagedClustersAPI + Use this API to implement managed cluster functionality. +With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-managed-cluster**](#create-managed-cluster) | **Post** `/managed-clusters` | Create Create Managed Cluster +[**delete-managed-cluster**](#delete-managed-cluster) | **Delete** `/managed-clusters/{id}` | Delete Managed Cluster +[**get-client-log-configuration**](#get-client-log-configuration) | **Get** `/managed-clusters/{id}/log-config` | Get Managed Cluster Log Configuration +[**get-managed-cluster**](#get-managed-cluster) | **Get** `/managed-clusters/{id}` | Get Managed Cluster +[**get-managed-clusters**](#get-managed-clusters) | **Get** `/managed-clusters` | Get Managed Clusters +[**put-client-log-configuration**](#put-client-log-configuration) | **Put** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration +[**update**](#update) | **Post** `/managed-clusters/{id}/manualUpgrade` | Trigger Manual Upgrade for Managed Cluster +[**update-managed-cluster**](#update-managed-cluster) | **Patch** `/managed-clusters/{id}` | Update Managed Cluster + + +## create-managed-cluster +Create Create Managed Cluster +Create a new Managed Cluster. +The API returns a result that includes the managed cluster ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-managed-cluster) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateManagedClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **managedClusterRequest** | [**ManagedClusterRequest**](../models/managed-cluster-request) | | + +### Return type + +[**ManagedCluster**](../models/managed-cluster) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + managedclusterrequest := []byte(`{ + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + }`) // ManagedClusterRequest | + + + var managedClusterRequest v2024.ManagedClusterRequest + if err := json.Unmarshal(managedclusterrequest, &managedClusterRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClustersAPI.CreateManagedCluster(context.Background()).ManagedClusterRequest(managedClusterRequest).Execute() + //resp, r, err := apiClient.V2024.ManagedClustersAPI.CreateManagedCluster(context.Background()).ManagedClusterRequest(managedClusterRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.CreateManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.CreateManagedCluster`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-managed-cluster +Delete Managed Cluster +Delete an existing managed cluster. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-managed-cluster) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed cluster ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteManagedClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **removeClients** | **bool** | Flag to determine the need to delete a cluster with clients. | [default to false] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + removeClients := false // bool | Flag to determine the need to delete a cluster with clients. (optional) (default to false) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ManagedClustersAPI.DeleteManagedCluster(context.Background(), id).Execute() + //r, err := apiClient.V2024.ManagedClustersAPI.DeleteManagedCluster(context.Background(), id).RemoveClients(removeClients).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.DeleteManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-client-log-configuration +Get Managed Cluster Log Configuration +Get a managed cluster's log configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-client-log-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of managed cluster to get log configuration for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetClientLogConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ClientLogConfiguration**](../models/client-log-configuration) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | ID of managed cluster to get log configuration for. # string | ID of managed cluster to get log configuration for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClustersAPI.GetClientLogConfiguration(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ManagedClustersAPI.GetClientLogConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetClientLogConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetClientLogConfiguration`: ClientLogConfiguration + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetClientLogConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-managed-cluster +Get Managed Cluster +Get a managed cluster by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-cluster) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed cluster ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ManagedCluster**](../models/managed-cluster) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClustersAPI.GetManagedCluster(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ManagedClustersAPI.GetManagedCluster(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetManagedCluster`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-managed-clusters +Get Managed Clusters +List current organization's managed clusters, based on request context. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-clusters) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClustersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* | + +### Return type + +[**[]ManagedCluster**](../models/managed-cluster) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `operational eq "operation"` // 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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClustersAPI.GetManagedClusters(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ManagedClustersAPI.GetManagedClusters(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetManagedClusters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClusters`: []ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetManagedClusters`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-client-log-configuration +Update Managed Cluster Log Configuration +Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-client-log-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the managed cluster to update the log configuration for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutClientLogConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **putClientLogConfigurationRequest** | [**PutClientLogConfigurationRequest**](../models/put-client-log-configuration-request) | Client log configuration for the given managed cluster. | + +### Return type + +[**ClientLogConfiguration**](../models/client-log-configuration) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | ID of the managed cluster to update the log configuration for. # string | ID of the managed cluster to update the log configuration for. + putclientlogconfigurationrequest := []byte(``) // PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + + + var putClientLogConfigurationRequest v2024.PutClientLogConfigurationRequest + if err := json.Unmarshal(putclientlogconfigurationrequest, &putClientLogConfigurationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClustersAPI.PutClientLogConfiguration(context.Background(), id).PutClientLogConfigurationRequest(putClientLogConfigurationRequest).Execute() + //resp, r, err := apiClient.V2024.ManagedClustersAPI.PutClientLogConfiguration(context.Background(), id).PutClientLogConfigurationRequest(putClientLogConfigurationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.PutClientLogConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutClientLogConfiguration`: ClientLogConfiguration + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.PutClientLogConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update +Trigger Manual Upgrade for Managed Cluster +Trigger Manual Upgrade for Managed Cluster. +AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of managed cluster to trigger manual upgrade. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ClusterManualUpgrade**](../models/cluster-manual-upgrade) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | ID of managed cluster to trigger manual upgrade. # string | ID of managed cluster to trigger manual upgrade. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClustersAPI.Update(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ManagedClustersAPI.Update(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.Update``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `Update`: ClusterManualUpgrade + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.Update`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-managed-cluster +Update Managed Cluster +Update an existing managed cluster. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-managed-cluster) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed cluster ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateManagedClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | JSONPatch payload used to update the object. | + +### Return type + +[**ManagedCluster**](../models/managed-cluster) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | JSONPatch payload used to update the object. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClustersAPI.UpdateManagedCluster(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.ManagedClustersAPI.UpdateManagedCluster(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.UpdateManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.UpdateManagedCluster`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/MultiHostIntegrationAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/MultiHostIntegrationAPI.md new file mode 100644 index 000000000..0b50d6378 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/MultiHostIntegrationAPI.md @@ -0,0 +1,971 @@ +--- +id: v2024-multi-host-integration +title: MultiHostIntegration +pagination_label: MultiHostIntegration +sidebar_label: MultiHostIntegration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegration', 'V2024MultiHostIntegration'] +slug: /tools/sdk/go/v2024/methods/multi-host-integration +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegration', 'V2024MultiHostIntegration'] +--- + +# MultiHostIntegrationAPI + Use this API to build a Multi-Host Integration. +Multi-Host Integration will help customers to configure and manage similar type of target system in Identity Security Cloud. +In Identity Security Cloud, administrators can create a Multi-Host Integration by going to Admin > Connections > Multi-Host Sources and selecting 'Create.' + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-multi-host-integration**](#create-multi-host-integration) | **Post** `/multihosts` | Create Multi-Host Integration +[**create-sources-within-multi-host**](#create-sources-within-multi-host) | **Post** `/multihosts/{multihostId}` | Create Sources Within Multi-Host Integration +[**delete-multi-host**](#delete-multi-host) | **Delete** `/multihosts/{multihostId}` | Delete Multi-Host Integration +[**get-acct-aggregation-groups**](#get-acct-aggregation-groups) | **Get** `/multihosts/{multihostId}/acctAggregationGroups` | List Account-Aggregation-Groups by Multi-Host ID +[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **Get** `/multihosts/{multiHostId}/entitlementAggregationGroups` | List Entitlement-Aggregation-Groups by Integration ID +[**get-multi-host-integrations**](#get-multi-host-integrations) | **Get** `/multihosts/{multihostId}` | Get Multi-Host Integration By ID +[**get-multi-host-integrations-list**](#get-multi-host-integrations-list) | **Get** `/multihosts` | List All Existing Multi-Host Integrations +[**get-multi-host-source-creation-errors**](#get-multi-host-source-creation-errors) | **Get** `/multihosts/{multiHostId}/sources/errors` | List Multi-Host Source Creation Errors +[**get-multihost-integration-types**](#get-multihost-integration-types) | **Get** `/multihosts/types` | List Multi-Host Integration Types +[**get-sources-within-multi-host**](#get-sources-within-multi-host) | **Get** `/multihosts/{multihostId}/sources` | List Sources Within Multi-Host Integration +[**test-connection-multi-host-sources**](#test-connection-multi-host-sources) | **Post** `/multihosts/{multihostId}/sources/testConnection` | Test Configuration For Multi-Host Integration +[**test-source-connection-multihost**](#test-source-connection-multihost) | **Get** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source +[**update-multi-host-sources**](#update-multi-host-sources) | **Patch** `/multihosts/{multihostId}` | Update Multi-Host Integration + + +## create-multi-host-integration +Create Multi-Host Integration +This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-multi-host-integration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateMultiHostIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **multiHostIntegrationsCreate** | [**MultiHostIntegrationsCreate**](../models/multi-host-integrations-create) | The specifics of the Multi-Host Integration to create | + +### Return type + +[**MultiHostIntegrations**](../models/multi-host-integrations) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostintegrationscreate := []byte(`{ + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + }`) // MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create + + + var multiHostIntegrationsCreate v2024.MultiHostIntegrationsCreate + if err := json.Unmarshal(multihostintegrationscreate, &multiHostIntegrationsCreate); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.CreateMultiHostIntegration(context.Background()).MultiHostIntegrationsCreate(multiHostIntegrationsCreate).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.CreateMultiHostIntegration(context.Background()).MultiHostIntegrationsCreate(multiHostIntegrationsCreate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.CreateMultiHostIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateMultiHostIntegration`: MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.CreateMultiHostIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-sources-within-multi-host +Create Sources Within Multi-Host Integration +This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-sources-within-multi-host) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSourcesWithinMultiHostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **multiHostIntegrationsCreateSources** | [**[]MultiHostIntegrationsCreateSources**](../models/multi-host-integrations-create-sources) | The specifics of the sources to create within Multi-Host Integration. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration. # string | ID of the Multi-Host Integration. + multihostintegrationscreatesources := []byte(``) // []MultiHostIntegrationsCreateSources | The specifics of the sources to create within Multi-Host Integration. + + + var multiHostIntegrationsCreateSources v2024.[]MultiHostIntegrationsCreateSources + if err := json.Unmarshal(multihostintegrationscreatesources, &multiHostIntegrationsCreateSources); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.MultiHostIntegrationAPI.CreateSourcesWithinMultiHost(context.Background(), multihostId).MultiHostIntegrationsCreateSources(multiHostIntegrationsCreateSources).Execute() + //r, err := apiClient.V2024.MultiHostIntegrationAPI.CreateSourcesWithinMultiHost(context.Background(), multihostId).MultiHostIntegrationsCreateSources(multiHostIntegrationsCreateSources).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.CreateSourcesWithinMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-multi-host +Delete Multi-Host Integration +Delete an existing Multi-Host Integration by ID. + +A token with Org Admin or Multi Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-multi-host) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of Multi-Host Integration to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteMultiHostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of Multi-Host Integration to delete. # string | ID of Multi-Host Integration to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.MultiHostIntegrationAPI.DeleteMultiHost(context.Background(), multihostId).Execute() + //r, err := apiClient.V2024.MultiHostIntegrationAPI.DeleteMultiHost(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.DeleteMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-acct-aggregation-groups +List Account-Aggregation-Groups by Multi-Host ID +This API will return array of account aggregation groups within provided Multi-Host Integration ID. +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-acct-aggregation-groups) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAcctAggregationGroupsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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] + **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] + +### Return type + +[**[]MultiHostIntegrationsAggScheduleUpdate**](../models/multi-host-integrations-agg-schedule-update) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + 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) + 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) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetAcctAggregationGroups(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetAcctAggregationGroups(context.Background(), multihostId).Offset(offset).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetAcctAggregationGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAcctAggregationGroups`: []MultiHostIntegrationsAggScheduleUpdate + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetAcctAggregationGroups`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlement-aggregation-groups +List Entitlement-Aggregation-Groups by Integration ID +This API will return array of aggregation groups within provided Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-aggregation-groups) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multiHostId** | **string** | ID of the Multi-Host Integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementAggregationGroupsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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] + **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] + +### Return type + +[**[]MultiHostIntegrationsAggScheduleUpdate**](../models/multi-host-integrations-agg-schedule-update) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multiHostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + 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) + 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) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetEntitlementAggregationGroups(context.Background(), multiHostId).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetEntitlementAggregationGroups(context.Background(), multiHostId).Offset(offset).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetEntitlementAggregationGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementAggregationGroups`: []MultiHostIntegrationsAggScheduleUpdate + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetEntitlementAggregationGroups`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-multi-host-integrations +Get Multi-Host Integration By ID +Get an existing Multi-Host Integration. + +A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-multi-host-integrations) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMultiHostIntegrationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**MultiHostIntegrations**](../models/multi-host-integrations) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration. # string | ID of the Multi-Host Integration. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetMultiHostIntegrations(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetMultiHostIntegrations(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostIntegrations`: MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostIntegrations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-multi-host-integrations-list +List All Existing Multi-Host Integrations +Get a list of Multi-Host Integrations. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-multi-host-integrations-list) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMultiHostIntegrationsListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **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** | + **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: **type**: *in* **forSubAdminId**: *in* | + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **forSubadmin** | **string** | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. | + +### Return type + +[**[]MultiHostIntegrations**](../models/multi-host-integrations) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `id eq 2c91808b6ef1d43e016efba0ce470904` // 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: **type**: *in* **forSubAdminId**: *in* (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: **type**: *in* **forSubAdminId**: *in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetMultiHostIntegrationsList(context.Background()).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetMultiHostIntegrationsList(context.Background()).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).ForSubadmin(forSubadmin).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostIntegrationsList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostIntegrationsList`: []MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostIntegrationsList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-multi-host-source-creation-errors +List Multi-Host Source Creation Errors +Get a list of sources creation errors within Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-multi-host-source-creation-errors) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multiHostId** | **string** | ID of the Multi-Host Integration | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMultiHostSourceCreationErrorsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]SourceCreationErrors**](../models/source-creation-errors) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multiHostId := `004091cb79b04636b88662afa50a4440` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors(context.Background(), multiHostId).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors(context.Background(), multiHostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostSourceCreationErrors`: []SourceCreationErrors + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-multihost-integration-types +List Multi-Host Integration Types +This API endpoint returns the current list of supported Multi-Host Integration types. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-multihost-integration-types) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMultihostIntegrationTypesRequest struct via the builder pattern + + +### Return type + +[**[]MultiHostIntegrationTemplateType**](../models/multi-host-integration-template-type) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetMultihostIntegrationTypes(context.Background()).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetMultihostIntegrationTypes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultihostIntegrationTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultihostIntegrationTypes`: []MultiHostIntegrationTemplateType + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultihostIntegrationTypes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sources-within-multi-host +List Sources Within Multi-Host Integration +Get a list of sources within Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sources-within-multi-host) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourcesWithinMultiHostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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] + **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] + **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** | + **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**: *in* | + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]MultiHostSources**](../models/multi-host-sources) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `id eq 2c91808b6ef1d43e016efba0ce470904` // 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**: *in* (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**: *in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetSourcesWithinMultiHost(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetSourcesWithinMultiHost(context.Background(), multihostId).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetSourcesWithinMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourcesWithinMultiHost`: []MultiHostSources + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetSourcesWithinMultiHost`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-connection-multi-host-sources +Test Configuration For Multi-Host Integration +This endpoint performs a more detailed validation of the Multi-Host Integration's configuration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-connection-multi-host-sources) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestConnectionMultiHostSourcesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `2c91808568c529c60168cca6f90c1324` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.MultiHostIntegrationAPI.TestConnectionMultiHostSources(context.Background(), multihostId).Execute() + //r, err := apiClient.V2024.MultiHostIntegrationAPI.TestConnectionMultiHostSources(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.TestConnectionMultiHostSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## test-source-connection-multihost +Test Configuration For Multi-Host Integration's Single Source +This endpoint performs a more detailed validation of the source's configuration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-source-connection-multihost) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration | +**sourceId** | **string** | ID of the source within the Multi-Host Integration | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestSourceConnectionMultihostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**TestSourceConnectionMultihost200Response**](../models/test-source-connection-multihost200-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + sourceId := `2c91808568c529f60168cca6f90c1324` // string | ID of the source within the Multi-Host Integration # string | ID of the source within the Multi-Host Integration + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.TestSourceConnectionMultihost(context.Background(), multihostId, sourceId).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.TestSourceConnectionMultihost(context.Background(), multihostId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.TestSourceConnectionMultihost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConnectionMultihost`: TestSourceConnectionMultihost200Response + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.TestSourceConnectionMultihost`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-multi-host-sources +Update Multi-Host Integration +Update existing sources within Multi-Host Integration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-multi-host-sources) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateMultiHostSourcesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **updateMultiHostSourcesRequestInner** | [**[]UpdateMultiHostSourcesRequestInner**](../models/update-multi-host-sources-request-inner) | This endpoint allows you to update a Multi-Host Integration. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `anId` // string | ID of the Multi-Host Integration to update. # string | ID of the Multi-Host Integration to update. + updatemultihostsourcesrequestinner := []byte(`[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]`) // []UpdateMultiHostSourcesRequestInner | This endpoint allows you to update a Multi-Host Integration. + + + var updateMultiHostSourcesRequestInner v2024.[]UpdateMultiHostSourcesRequestInner + if err := json.Unmarshal(updatemultihostsourcesrequestinner, &updateMultiHostSourcesRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.MultiHostIntegrationAPI.UpdateMultiHostSources(context.Background(), multihostId).UpdateMultiHostSourcesRequestInner(updateMultiHostSourcesRequestInner).Execute() + //r, err := apiClient.V2024.MultiHostIntegrationAPI.UpdateMultiHostSources(context.Background(), multihostId).UpdateMultiHostSourcesRequestInner(updateMultiHostSourcesRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.UpdateMultiHostSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/NonEmployeeLifecycleManagementAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/NonEmployeeLifecycleManagementAPI.md new file mode 100644 index 000000000..b2b5d91d9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/NonEmployeeLifecycleManagementAPI.md @@ -0,0 +1,2406 @@ +--- +id: v2024-non-employee-lifecycle-management +title: NonEmployeeLifecycleManagement +pagination_label: NonEmployeeLifecycleManagement +sidebar_label: NonEmployeeLifecycleManagement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeLifecycleManagement', 'V2024NonEmployeeLifecycleManagement'] +slug: /tools/sdk/go/v2024/methods/non-employee-lifecycle-management +tags: ['SDK', 'Software Development Kit', 'NonEmployeeLifecycleManagement', 'V2024NonEmployeeLifecycleManagement'] +--- + +# NonEmployeeLifecycleManagementAPI + Use this API to implement non-employee lifecycle management functionality. +With this functionality in place, administrators can create non-employee records and configure them for use in their organizations. +This allows organizations to provide secure access to non-employees and control that access. + +The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. +Organizations can track non-employees' access and activity in Identity Security Cloud by creating and maintaining non-employee sources. +Organizations can have a maximum of 50 non-employee sources. + +By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following: + +- SailPoint is not responsible for storing sensitive data. +You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in Identity Security Cloud. + +- You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts. + +To manage non-employees in Identity Security Cloud, administrators must create a non-employee source and add accounts to the source. + +To create a non-employee source in Identity Security Cloud, administrators must use the Admin panel to go to Connections > Sources. +They must then specify 'Non-Employee' in the 'Source Type' field. +Refer to [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources. + +To add accounts to a non-employee source in Identity Security Cloud, administrators can select the non-employee source and add the accounts. +They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. + +Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. +To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. +Refer to [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources. + +Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. + +Refer to [Managing Non-Employee Sources and Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html) for more information about non-employee lifecycle management. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-non-employee-request**](#approve-non-employee-request) | **Post** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request +[**create-non-employee-record**](#create-non-employee-record) | **Post** `/non-employee-records` | Create Non-Employee Record +[**create-non-employee-request**](#create-non-employee-request) | **Post** `/non-employee-requests` | Create Non-Employee Request +[**create-non-employee-source**](#create-non-employee-source) | **Post** `/non-employee-sources` | Create Non-Employee Source +[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **Post** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new Schema Attribute for Non-Employee Source +[**delete-non-employee-record**](#delete-non-employee-record) | **Delete** `/non-employee-records/{id}` | Delete Non-Employee Record +[**delete-non-employee-records-in-bulk**](#delete-non-employee-records-in-bulk) | **Post** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records +[**delete-non-employee-request**](#delete-non-employee-request) | **Delete** `/non-employee-requests/{id}` | Delete Non-Employee Request +[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a Schema Attribute for Non-Employee Source +[**delete-non-employee-source**](#delete-non-employee-source) | **Delete** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source +[**delete-non-employee-source-schema-attributes**](#delete-non-employee-source-schema-attributes) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for Non-Employee Source +[**export-non-employee-records**](#export-non-employee-records) | **Get** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV +[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **Get** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template +[**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-bulk-upload-status**](#get-non-employee-bulk-upload-status) | **Get** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Obtain the status of bulk upload on the source +[**get-non-employee-record**](#get-non-employee-record) | **Get** `/non-employee-records/{id}` | Get a Non-Employee Record +[**get-non-employee-request**](#get-non-employee-request) | **Get** `/non-employee-requests/{id}` | Get a Non-Employee Request +[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **Get** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests +[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **Get** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source +[**get-non-employee-source**](#get-non-employee-source) | **Get** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source +[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **Get** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source +[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **Post** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records +[**list-non-employee-approvals**](#list-non-employee-approvals) | **Get** `/non-employee-approvals` | Get List of Non-Employee Approval Requests +[**list-non-employee-records**](#list-non-employee-records) | **Get** `/non-employee-records` | List Non-Employee Records +[**list-non-employee-requests**](#list-non-employee-requests) | **Get** `/non-employee-requests` | List Non-Employee Requests +[**list-non-employee-sources**](#list-non-employee-sources) | **Get** `/non-employee-sources` | List Non-Employee Sources +[**patch-non-employee-record**](#patch-non-employee-record) | **Patch** `/non-employee-records/{id}` | Patch Non-Employee Record +[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **Patch** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a Schema Attribute for Non-Employee Source +[**patch-non-employee-source**](#patch-non-employee-source) | **Patch** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source +[**reject-non-employee-request**](#reject-non-employee-request) | **Post** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request +[**update-non-employee-record**](#update-non-employee-record) | **Put** `/non-employee-records/{id}` | Update Non-Employee Record + + +## approve-non-employee-request +Approve a Non-Employee Request +Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-non-employee-request) + +### 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 apiApproveNonEmployeeRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **nonEmployeeApprovalDecision** | [**NonEmployeeApprovalDecision**](../models/non-employee-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" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + nonemployeeapprovaldecision := []byte(`{ + "comment" : "Approved by manager" + }`) // NonEmployeeApprovalDecision | + + + var nonEmployeeApprovalDecision v2024.NonEmployeeApprovalDecision + if err := json.Unmarshal(nonemployeeapprovaldecision, &nonEmployeeApprovalDecision); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest(context.Background(), id).NonEmployeeApprovalDecision(nonEmployeeApprovalDecision).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest(context.Background(), id).NonEmployeeApprovalDecision(nonEmployeeApprovalDecision).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveNonEmployeeRequest`: NonEmployeeApprovalItem + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-non-employee-record +Create Non-Employee Record +This request will create a non-employee record. +Requires role context of `idn:nesr:create` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-record) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nonEmployeeRequestBody** | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | Non-Employee record creation request body. | + +### Return type + +[**NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-Employee record creation request body. + + + var nonEmployeeRequestBody v2024.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-non-employee-request +Create Non-Employee Request +This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNonEmployeeRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nonEmployeeRequestBody** | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | Non-Employee creation request body | + +### Return type + +[**NonEmployeeRequest**](../models/non-employee-request) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-Employee creation request body + + + var nonEmployeeRequestBody v2024.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeRequest`: NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-non-employee-source +Create Non-Employee Source +Create a non-employee source. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-source) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNonEmployeeSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nonEmployeeSourceRequestBody** | [**NonEmployeeSourceRequestBody**](../models/non-employee-source-request-body) | Non-Employee source creation request body. | + +### Return type + +[**NonEmployeeSourceWithCloudExternalId**](../models/non-employee-source-with-cloud-external-id) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + nonemployeesourcerequestbody := []byte(`{ + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + }`) // NonEmployeeSourceRequestBody | Non-Employee source creation request body. + + + var nonEmployeeSourceRequestBody v2024.NonEmployeeSourceRequestBody + if err := json.Unmarshal(nonemployeesourcerequestbody, &nonEmployeeSourceRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource(context.Background()).NonEmployeeSourceRequestBody(nonEmployeeSourceRequestBody).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource(context.Background()).NonEmployeeSourceRequestBody(nonEmployeeSourceRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeSource`: NonEmployeeSourceWithCloudExternalId + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-non-employee-source-schema-attributes +Create a new Schema Attribute for Non-Employee Source +This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. +Requires role context of `idn:nesr:create` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-source-schema-attributes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNonEmployeeSourceSchemaAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **nonEmployeeSchemaAttributeBody** | [**NonEmployeeSchemaAttributeBody**](../models/non-employee-schema-attribute-body) | | + +### Return type + +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + nonemployeeschemaattributebody := []byte(`{ + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + }`) // NonEmployeeSchemaAttributeBody | + + + var nonEmployeeSchemaAttributeBody v2024.NonEmployeeSchemaAttributeBody + if err := json.Unmarshal(nonemployeeschemaattributebody, &nonEmployeeSchemaAttributeBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).NonEmployeeSchemaAttributeBody(nonEmployeeSchemaAttributeBody).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).NonEmployeeSchemaAttributeBody(nonEmployeeSchemaAttributeBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeSourceSchemaAttributes`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-non-employee-record +Delete Non-Employee Record +This request will delete a non-employee record. +Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-record) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-Employee record id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-Employee record id (UUID) # string | Non-Employee record id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord(context.Background(), id).Execute() + //r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-records-in-bulk +Delete Multiple Non-Employee Records +This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-records-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeRecordsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **deleteNonEmployeeRecordsInBulkRequest** | [**DeleteNonEmployeeRecordsInBulkRequest**](../models/delete-non-employee-records-in-bulk-request) | Non-Employee bulk delete request body. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + deletenonemployeerecordsinbulkrequest := []byte(``) // DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. + + + var deleteNonEmployeeRecordsInBulkRequest v2024.DeleteNonEmployeeRecordsInBulkRequest + if err := json.Unmarshal(deletenonemployeerecordsinbulkrequest, &deleteNonEmployeeRecordsInBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk(context.Background()).DeleteNonEmployeeRecordsInBulkRequest(deleteNonEmployeeRecordsInBulkRequest).Execute() + //r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk(context.Background()).DeleteNonEmployeeRecordsInBulkRequest(deleteNonEmployeeRecordsInBulkRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-request +Delete Non-Employee Request +This request will delete a non-employee request. +Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-Employee request id in the UUID format | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ac110005-7156-1150-8171-5b292e3e0084` // string | Non-Employee request id in the UUID format # string | Non-Employee request id in the UUID format + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest(context.Background(), id).Execute() + //r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-schema-attribute +Delete a Schema Attribute for Non-Employee Source +This end-point deletes a specific schema attribute for a non-employee source. +Requires role context of `idn:nesr:delete` + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-schema-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**attributeId** | **string** | The Schema Attribute Id (UUID) | +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeSchemaAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + //r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-source +Delete Non-Employee Source +This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-source) + +### 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 apiDeleteNonEmployeeSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id # string | Source Id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource(context.Background(), sourceId).Execute() + //r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-source-schema-attributes +Delete all custom schema attributes for Non-Employee Source +This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-source-schema-attributes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeSourceSchemaAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + //r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[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. Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/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 := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id (UUID) # string | Source Id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ExportNonEmployeeRecords(context.Background(), id).Execute() + //r, err := apiClient.V2024.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. Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/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 := `ef38f94347e94562b5bb8424a56397d8` // string | Source Id (UUID) # string | Source Id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ExportNonEmployeeSourceSchemaTemplate(context.Background(), id).Execute() + //r, err := apiClient.V2024.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 +Gets a non-employee approval item detail. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they +can get any approval. + 2. The user owns the requested approval. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-approval) + +### 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 apiGetNonEmployeeApprovalRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeDetail** | **bool** | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* | + +### Return type + +[**NonEmployeeApprovalItemDetail**](../models/non-employee-approval-item-detail) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + includeDetail := true // bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval(context.Background(), id).IncludeDetail(includeDetail).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeApproval`: NonEmployeeApprovalItemDetail + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-approval-summary +Get Summary of Non-Employee Approval Requests +This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. + 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/v2024/get-non-employee-approval-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**requestedFor** | **string** | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeApprovalSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeApprovalSummary**](../models/non-employee-approval-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary(context.Background(), requestedFor).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary(context.Background(), requestedFor).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeApprovalSummary`: NonEmployeeApprovalSummary + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-bulk-upload-status +Obtain the status of bulk upload on the source +The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. +Requires role context of `idn:nesr:read` + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-bulk-upload-status) + +### 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 apiGetNonEmployeeBulkUploadStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeBulkUploadStatus**](../models/non-employee-bulk-upload-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Source ID (UUID) # string | Source ID (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeBulkUploadStatus`: NonEmployeeBulkUploadStatus + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-record +Get a Non-Employee Record +This gets a non-employee record. +Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-record) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-Employee record id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-Employee record id (UUID) # string | Non-Employee record id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-request +Get a Non-Employee Request +This gets a non-employee request. +There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in this case the user +can get the non-employee request for any user. + 2. The user must be the owner of the non-employee request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-Employee request id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeRequest**](../models/non-employee-request) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ac110005-7156-1150-8171-5b292e3e0084` // string | Non-Employee request id (UUID) # string | Non-Employee request id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRequest`: NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-request-summary +Get Summary of Non-Employee Requests +This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. + 2. The current user is an account manager, in which case "me" should be +provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-request-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**requestedFor** | **string** | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeRequestSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeRequestSummary**](../models/non-employee-request-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary(context.Background(), requestedFor).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary(context.Background(), requestedFor).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRequestSummary`: NonEmployeeRequestSummary + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-schema-attribute +Get Schema Attribute Non-Employee Source +This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-schema-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**attributeId** | **string** | The Schema Attribute Id (UUID) | +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeSchemaAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeSchemaAttribute`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-source +Get a Non-Employee Source +This gets a non-employee source. There are two contextual uses for the requested-for path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request any source. + 2. The current user is an account manager, in which case the user can only +request sources that they own. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-source) + +### 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 apiGetNonEmployeeSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeSource**](../models/non-employee-source) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c91808b7c28b350017c2a2ec5790aa1` // string | Source Id # string | Source Id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeSource`: NonEmployeeSource + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-source-schema-attributes +List Schema Attributes Non-Employee Source +This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. +Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-source-schema-attributes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeSourceSchemaAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).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) + } + // response from `GetNonEmployeeSourceSchemaAttributes`: []NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-non-employee-records-in-bulk +Imports, or Updates, Non-Employee Records +This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-non-employee-records-in-bulk) + +### 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 apiImportNonEmployeeRecordsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **data** | ***os.File** | | + +### Return type + +[**NonEmployeeBulkUploadJob**](../models/non-employee-bulk-upload-job) + +### 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() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id (UUID) # string | Source Id (UUID) + data := BINARY_DATA_HERE // *os.File | # *os.File | + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk(context.Background(), id).Data(data).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk(context.Background(), id).Data(data).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportNonEmployeeRecordsInBulk`: NonEmployeeBulkUploadJob + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-non-employee-approvals +Get List of Non-Employee Approval Requests +This gets a list of non-employee approval requests. +There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they +can list the approvals for any approver. + 2. The user owns the requested approval. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-non-employee-approvals) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNonEmployeeApprovalsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | The identity for whom the request was made. *me* indicates the current user. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **approvalStatus**: *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: **created, modified** | + +### Return type + +[**[]NonEmployeeApprovalItem**](../models/non-employee-approval-item) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity for whom the request was made. *me* indicates the current user. (optional) # string | The identity for whom the request was made. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `approvalStatus eq "Pending"` // 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: **approvalStatus**: *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: **approvalStatus**: *eq* (optional) + sorters := `created` // 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: **created, modified** (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: **created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals(context.Background()).RequestedFor(requestedFor).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeApprovals`: []NonEmployeeApprovalItem + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-non-employee-records +List Non-Employee Records +This gets a list of non-employee records. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. + 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-non-employee-records) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNonEmployeeRecordsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** | + **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: **sourceId**: *eq* | + +### Return type + +[**[]NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `accountName,sourceId` // 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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + filters := `sourceId eq "2c91808568c529c60168cca6f90c1313"` // 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: **sourceId**: *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: **sourceId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords(context.Background()).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords(context.Background()).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeRecords`: []NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-non-employee-requests +List Non-Employee Requests +This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id. + 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 list of the non-employee requests in the source(s) he or she manages. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-non-employee-requests) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNonEmployeeRequestsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | The identity for whom the request was made. *me* indicates the current user. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** | + **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: **sourceId**: *eq* | + +### Return type + +[**[]NonEmployeeRequest**](../models/non-employee-request) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `e136567de87e4d029e60b3c3c55db56d` // string | The identity for whom the request was made. *me* indicates the current user. # string | The identity for whom the request was made. *me* indicates the current user. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `created,approvalStatus` // 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + filters := `sourceId eq "2c91808568c529c60168cca6f90c1313"` // 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: **sourceId**: *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: **sourceId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests(context.Background()).RequestedFor(requestedFor).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests(context.Background()).RequestedFor(requestedFor).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeRequests`: []NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-non-employee-sources +List Non-Employee Sources +Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: + 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. + 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-non-employee-sources) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNonEmployeeSourcesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **requestedFor** | **string** | Identity the request was made for. Use 'me' to indicate the current user. | + **nonEmployeeCount** | **bool** | Flag that determines whether the API will return a non-employee count associated with the source. | [default to false] + **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, created, sourceId** | + +### Return type + +[**[]NonEmployeeSourceWithNECount**](../models/non-employee-source-with-ne-count) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + requestedFor := `me` // string | Identity the request was made for. Use 'me' to indicate the current user. (optional) # string | Identity the request was made for. Use 'me' to indicate the current user. (optional) + nonEmployeeCount := true // bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) + sorters := `name,created` // 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, created, sourceId** (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, created, sourceId** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources(context.Background()).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources(context.Background()).Limit(limit).Offset(offset).Count(count).RequestedFor(requestedFor).NonEmployeeCount(nonEmployeeCount).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeSources`: []NonEmployeeSourceWithNECount + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-non-employee-record +Patch Non-Employee Record +This request will patch a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they +update all available fields. + 2. The user is owner of the source, in this case they can only update the +end date. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-non-employee-record) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-employee record id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. | + +### Return type + +[**NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-employee record id (UUID) # string | Non-employee record id (UUID) + jsonpatchoperation := []byte(`[{op=replace, path=/endDate, value=2019-08-23T18:40:35.772Z}]`) // []JsonPatchOperation | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-non-employee-schema-attribute +Patch a Schema Attribute for Non-Employee Source +This end-point patches a specific schema attribute for a non-employee SourceId. +Requires role context of `idn:nesr:update` + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-non-employee-schema-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**attributeId** | **string** | The Schema Attribute Id (UUID) | +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchNonEmployeeSchemaAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. | + +### Return type + +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + jsonpatchoperation := []byte(`[{op=replace, path=/label, value={new attribute label=null}}]`) // []JsonPatchOperation | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeSchemaAttribute`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-non-employee-source +Patch a Non-Employee Source +patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-non-employee-source) + +### 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 apiPatchNonEmployeeSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +[**NonEmployeeSource**](../models/non-employee-source) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id # string | Source Id + jsonpatchoperation := []byte(`[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}]`) // []JsonPatchOperation | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource(context.Background(), sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource(context.Background(), sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeSource`: NonEmployeeSource + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reject-non-employee-request +Reject a Non-Employee Request +This endpoint will reject an approval item request and notify user. The current user must be the requested approver. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reject-non-employee-request) + +### 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" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + nonemployeerejectapprovaldecision := []byte(`{ + "comment" : "approved" + }`) // NonEmployeeRejectApprovalDecision | + + + var nonEmployeeRejectApprovalDecision v2024.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.V2024.NonEmployeeLifecycleManagementAPI.RejectNonEmployeeRequest(context.Background(), id).NonEmployeeRejectApprovalDecision(nonEmployeeRejectApprovalDecision).Execute() + //resp, r, err := apiClient.V2024.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 +Update Non-Employee Record +This request will update a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they +update all available fields. + 2. The user is owner of the source, in this case they can only update the +end date. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-non-employee-record) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-employee record id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **nonEmployeeRequestBody** | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. | + +### Return type + +[**NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-employee record id (UUID) # string | Non-employee record id (UUID) + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + + var nonEmployeeRequestBody v2024.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord(context.Background(), id).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord(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, "Full HTTP response: %v\n", r) + } + // response from `UpdateNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/NotificationsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/NotificationsAPI.md new file mode 100644 index 000000000..725d415a9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/NotificationsAPI.md @@ -0,0 +1,1241 @@ +--- +id: v2024-notifications +title: Notifications +pagination_label: Notifications +sidebar_label: Notifications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Notifications', 'V2024Notifications'] +slug: /tools/sdk/go/v2024/methods/notifications +tags: ['SDK', 'Software Development Kit', 'Notifications', 'V2024Notifications'] +--- + +# NotificationsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-domain-dkim**](#create-domain-dkim) | **Post** `/verified-domains` | Verify domain address via DKIM +[**create-notification-template**](#create-notification-template) | **Post** `/notification-templates` | Create Notification Template +[**create-verified-from-address**](#create-verified-from-address) | **Post** `/verified-from-addresses` | Create Verified From Address +[**delete-notification-templates-in-bulk**](#delete-notification-templates-in-bulk) | **Post** `/notification-templates/bulk-delete` | Bulk Delete Notification Templates +[**delete-verified-from-address**](#delete-verified-from-address) | **Delete** `/verified-from-addresses/{id}` | Delete Verified From Address +[**get-dkim-attributes**](#get-dkim-attributes) | **Get** `/verified-domains` | Get DKIM Attributes +[**get-mail-from-attributes**](#get-mail-from-attributes) | **Get** `/mail-from-attributes/{identity}` | Get MAIL FROM Attributes +[**get-notification-template**](#get-notification-template) | **Get** `/notification-templates/{id}` | Get Notification Template By Id +[**get-notifications-template-context**](#get-notifications-template-context) | **Get** `/notification-template-context` | Get Notification Template Context +[**list-from-addresses**](#list-from-addresses) | **Get** `/verified-from-addresses` | List From Addresses +[**list-notification-preferences**](#list-notification-preferences) | **Get** `/notification-preferences/{key}` | List Notification Preferences for tenant. +[**list-notification-template-defaults**](#list-notification-template-defaults) | **Get** `/notification-template-defaults` | List Notification Template Defaults +[**list-notification-templates**](#list-notification-templates) | **Get** `/notification-templates` | List Notification Templates +[**put-mail-from-attributes**](#put-mail-from-attributes) | **Put** `/mail-from-attributes` | Change MAIL FROM domain +[**send-test-notification**](#send-test-notification) | **Post** `/send-test-notification` | Send Test Notification + + +## create-domain-dkim +:::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 + ``` +::: +Verify domain address via DKIM +Create a domain to be verified via DKIM (DomainKeys Identified Mail) + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-domain-dkim) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateDomainDkimRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **domainAddress** | [**DomainAddress**](../models/domain-address) | | + +### Return type + +[**DomainStatusDto**](../models/domain-status-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + domainaddress := []byte(`{ + "domain" : "sailpoint.com" + }`) // DomainAddress | + + + var domainAddress v2024.DomainAddress + if err := json.Unmarshal(domainaddress, &domainAddress); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.CreateDomainDkim(context.Background()).XSailPointExperimental(xSailPointExperimental).DomainAddress(domainAddress).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.CreateDomainDkim(context.Background()).XSailPointExperimental(xSailPointExperimental).DomainAddress(domainAddress).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateDomainDkim``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDomainDkim`: DomainStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateDomainDkim`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-notification-template +:::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 Notification Template +This creates a template for your site. + +You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-notification-template) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNotificationTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **templateDto** | [**TemplateDto**](../models/template-dto) | | + +### Return type + +[**TemplateDto**](../models/template-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + templatedto := []byte(`{ + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" + }`) // TemplateDto | + + + var templateDto v2024.TemplateDto + if err := json.Unmarshal(templatedto, &templateDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.CreateNotificationTemplate(context.Background()).XSailPointExperimental(xSailPointExperimental).TemplateDto(templateDto).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.CreateNotificationTemplate(context.Background()).XSailPointExperimental(xSailPointExperimental).TemplateDto(templateDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateNotificationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNotificationTemplate`: TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateNotificationTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-verified-from-address +:::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 Verified From Address +Create a new sender email address and initiate verification process. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-verified-from-address) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateVerifiedFromAddressRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **emailStatusDto** | [**EmailStatusDto**](../models/email-status-dto) | | + +### Return type + +[**EmailStatusDto**](../models/email-status-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + emailstatusdto := []byte(`{ + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + }`) // EmailStatusDto | + + + var emailStatusDto v2024.EmailStatusDto + if err := json.Unmarshal(emailstatusdto, &emailStatusDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.CreateVerifiedFromAddress(context.Background()).XSailPointExperimental(xSailPointExperimental).EmailStatusDto(emailStatusDto).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.CreateVerifiedFromAddress(context.Background()).XSailPointExperimental(xSailPointExperimental).EmailStatusDto(emailStatusDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateVerifiedFromAddress``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateVerifiedFromAddress`: EmailStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateVerifiedFromAddress`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-notification-templates-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 Notification Templates +This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-notification-templates-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNotificationTemplatesInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **templateBulkDeleteDto** | [**[]TemplateBulkDeleteDto**](../models/template-bulk-delete-dto) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + templatebulkdeletedto := []byte(``) // []TemplateBulkDeleteDto | + + + var templateBulkDeleteDto v2024.[]TemplateBulkDeleteDto + if err := json.Unmarshal(templatebulkdeletedto, &templateBulkDeleteDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NotificationsAPI.DeleteNotificationTemplatesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).TemplateBulkDeleteDto(templateBulkDeleteDto).Execute() + //r, err := apiClient.V2024.NotificationsAPI.DeleteNotificationTemplatesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).TemplateBulkDeleteDto(templateBulkDeleteDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.DeleteNotificationTemplatesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-verified-from-address +:::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 Verified From Address +Delete a verified sender email address + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-verified-from-address) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteVerifiedFromAddressRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `id_example` // string | # string | + 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.NotificationsAPI.DeleteVerifiedFromAddress(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.NotificationsAPI.DeleteVerifiedFromAddress(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.DeleteVerifiedFromAddress``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-dkim-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 + ``` +::: +Get DKIM Attributes +Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-dkim-attributes) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDkimAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**[]DkimAttributes**](../models/dkim-attributes) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.GetDkimAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.GetDkimAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetDkimAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDkimAttributes`: []DkimAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetDkimAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-mail-from-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 + ``` +::: +Get MAIL FROM Attributes +Retrieve MAIL FROM attributes for a given AWS SES identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mail-from-attributes) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMailFromAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **string** | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status | + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**MailFromAttributes**](../models/mail-from-attributes) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `bobsmith@sailpoint.com` // string | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # string | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + 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.NotificationsAPI.GetMailFromAttributes(context.Background()).Id(id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.GetMailFromAttributes(context.Background()).Id(id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetMailFromAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMailFromAttributes`: MailFromAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetMailFromAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-notification-template +:::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 Notification Template By Id +This gets a template that you have modified for your site by Id. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-notification-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the Notification Template | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNotificationTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**TemplateDto**](../models/template-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Notification Template # string | Id of the Notification Template + 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.NotificationsAPI.GetNotificationTemplate(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.GetNotificationTemplate(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetNotificationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNotificationTemplate`: TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetNotificationTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-notifications-template-context +:::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 Notification Template Context +The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes + that will be available per tenant (organization). + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-notifications-template-context) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNotificationsTemplateContextRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**NotificationTemplateContext**](../models/notification-template-context) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.GetNotificationsTemplateContext(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.GetNotificationsTemplateContext(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetNotificationsTemplateContext``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNotificationsTemplateContext`: NotificationTemplateContext + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetNotificationsTemplateContext`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-from-addresses +:::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 From Addresses +Retrieve a list of sender email addresses and their verification statuses + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-from-addresses) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListFromAddressesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **email**: *eq, ge, le, sw* | + **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: **email** | + +### Return type + +[**[]EmailStatusDto**](../models/email-status-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `email eq "john.doe@company.com"` // 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: **email**: *eq, ge, le, sw* (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: **email**: *eq, ge, le, sw* (optional) + sorters := `email` // 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: **email** (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: **email** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.ListFromAddresses(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.ListFromAddresses(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListFromAddresses``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListFromAddresses`: []EmailStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListFromAddresses`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-notification-preferences +:::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 Notification Preferences for tenant. +Returns a list of notification preferences for tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-preferences) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNotificationPreferencesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**PreferencesDto**](../models/preferences-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.ListNotificationPreferences(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.ListNotificationPreferences(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationPreferences``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationPreferences`: PreferencesDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationPreferences`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-notification-template-defaults +:::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 Notification Template Defaults +This lists the default templates used for notifications, such as emails from IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-template-defaults) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNotificationTemplateDefaultsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* | + +### Return type + +[**[]TemplateDtoDefault**](../models/template-dto-default) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + filters := `key eq "cloud_manual_work_item_summary"` // 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.ListNotificationTemplateDefaults(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.ListNotificationTemplateDefaults(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationTemplateDefaults``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationTemplateDefaults`: []TemplateDtoDefault + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationTemplateDefaults`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-notification-templates +:::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 Notification Templates +This lists the templates that you have modified for your site. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-templates) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNotificationTemplatesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* | + +### Return type + +[**[]TemplateDto**](../models/template-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + filters := `medium eq "EMAIL"` // 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.ListNotificationTemplates(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.ListNotificationTemplates(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationTemplates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationTemplates`: []TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationTemplates`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-mail-from-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 + ``` +::: +Change MAIL FROM domain +Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-mail-from-attributes) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutMailFromAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **mailFromAttributesDto** | [**MailFromAttributesDto**](../models/mail-from-attributes-dto) | | + +### Return type + +[**MailFromAttributes**](../models/mail-from-attributes) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + mailfromattributesdto := []byte(`{ + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + }`) // MailFromAttributesDto | + + + var mailFromAttributesDto v2024.MailFromAttributesDto + if err := json.Unmarshal(mailfromattributesdto, &mailFromAttributesDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.PutMailFromAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).MailFromAttributesDto(mailFromAttributesDto).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.PutMailFromAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).MailFromAttributesDto(mailFromAttributesDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.PutMailFromAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutMailFromAttributes`: MailFromAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.PutMailFromAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## send-test-notification +:::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 + ``` +::: +Send Test Notification +Send a Test Notification + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-test-notification) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendTestNotificationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **sendTestNotificationRequestDto** | [**SendTestNotificationRequestDto**](../models/send-test-notification-request-dto) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + sendtestnotificationrequestdto := []byte(`{ + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + }`) // SendTestNotificationRequestDto | + + + var sendTestNotificationRequestDto v2024.SendTestNotificationRequestDto + if err := json.Unmarshal(sendtestnotificationrequestdto, &sendTestNotificationRequestDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NotificationsAPI.SendTestNotification(context.Background()).XSailPointExperimental(xSailPointExperimental).SendTestNotificationRequestDto(sendTestNotificationRequestDto).Execute() + //r, err := apiClient.V2024.NotificationsAPI.SendTestNotification(context.Background()).XSailPointExperimental(xSailPointExperimental).SendTestNotificationRequestDto(sendTestNotificationRequestDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.SendTestNotification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/OAuthClientsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/OAuthClientsAPI.md new file mode 100644 index 000000000..d862ae3a2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/OAuthClientsAPI.md @@ -0,0 +1,377 @@ +--- +id: v2024-o-auth-clients +title: OAuthClients +pagination_label: OAuthClients +sidebar_label: OAuthClients +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OAuthClients', 'V2024OAuthClients'] +slug: /tools/sdk/go/v2024/methods/o-auth-clients +tags: ['SDK', 'Software Development Kit', 'OAuthClients', 'V2024OAuthClients'] +--- + +# OAuthClientsAPI + Use this API to implement OAuth client functionality. +With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the Identity Security Cloud REST API. +Refer to [Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information about OAuth and how it works with the Identity Security Cloud REST API. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-oauth-client**](#create-oauth-client) | **Post** `/oauth-clients` | Create OAuth Client +[**delete-oauth-client**](#delete-oauth-client) | **Delete** `/oauth-clients/{id}` | Delete OAuth Client +[**get-oauth-client**](#get-oauth-client) | **Get** `/oauth-clients/{id}` | Get OAuth Client +[**list-oauth-clients**](#list-oauth-clients) | **Get** `/oauth-clients` | List OAuth Clients +[**patch-oauth-client**](#patch-oauth-client) | **Patch** `/oauth-clients/{id}` | Patch OAuth Client + + +## create-oauth-client +Create OAuth Client +This creates an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-oauth-client) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateOauthClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createOAuthClientRequest** | [**CreateOAuthClientRequest**](../models/create-o-auth-client-request) | | + +### Return type + +[**CreateOAuthClientResponse**](../models/create-o-auth-client-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createoauthclientrequest := []byte(`{ + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + }`) // CreateOAuthClientRequest | + + + var createOAuthClientRequest v2024.CreateOAuthClientRequest + if err := json.Unmarshal(createoauthclientrequest, &createOAuthClientRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.OAuthClientsAPI.CreateOauthClient(context.Background()).CreateOAuthClientRequest(createOAuthClientRequest).Execute() + //resp, r, err := apiClient.V2024.OAuthClientsAPI.CreateOauthClient(context.Background()).CreateOAuthClientRequest(createOAuthClientRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.CreateOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateOauthClient`: CreateOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.CreateOauthClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-oauth-client +Delete OAuth Client +This deletes an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-oauth-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The OAuth client id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteOauthClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.OAuthClientsAPI.DeleteOauthClient(context.Background(), id).Execute() + //r, err := apiClient.V2024.OAuthClientsAPI.DeleteOauthClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.DeleteOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-oauth-client +Get OAuth Client +This gets details of an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-oauth-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The OAuth client id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOauthClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.OAuthClientsAPI.GetOauthClient(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.OAuthClientsAPI.GetOauthClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.GetOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOauthClient`: GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.GetOauthClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-oauth-clients +List OAuth Clients +This gets a list of OAuth clients. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-oauth-clients) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOauthClientsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **lastUsed**: *le, isnull* | + +### Return type + +[**[]GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `lastUsed le 2023-02-05T10:59:27.214Z` // 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.OAuthClientsAPI.ListOauthClients(context.Background()).Execute() + //resp, r, err := apiClient.V2024.OAuthClientsAPI.ListOauthClients(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.ListOauthClients``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOauthClients`: []GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.ListOauthClients`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-oauth-client +Patch OAuth Client +This performs a targeted update to the field(s) of an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-oauth-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The OAuth client id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchOauthClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported | + +### Return type + +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + jsonpatchoperation := []byte(`[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}]`) // []JsonPatchOperation | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.OAuthClientsAPI.PatchOauthClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.OAuthClientsAPI.PatchOauthClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.PatchOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchOauthClient`: GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.PatchOauthClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/OrgConfigAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/OrgConfigAPI.md new file mode 100644 index 000000000..19c0e87da --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/OrgConfigAPI.md @@ -0,0 +1,257 @@ +--- +id: v2024-org-config +title: OrgConfig +pagination_label: OrgConfig +sidebar_label: OrgConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OrgConfig', 'V2024OrgConfig'] +slug: /tools/sdk/go/v2024/methods/org-config +tags: ['SDK', 'Software Development Kit', 'OrgConfig', 'V2024OrgConfig'] +--- + +# OrgConfigAPI + Use this API to implement organization configuration functionality. +Administrators can use this functionality to manage organization settings, such as time zones. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-org-config**](#get-org-config) | **Get** `/org-config` | Get Org Config Settings +[**get-valid-time-zones**](#get-valid-time-zones) | **Get** `/org-config/valid-time-zones` | Get Valid Time Zones +[**patch-org-config**](#patch-org-config) | **Patch** `/org-config` | Patch Org Config + + +## get-org-config +:::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 Org Config Settings +Get the current organization's configuration settings, only external accessible properties. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-org-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOrgConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**OrgConfig**](../models/org-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.OrgConfigAPI.GetOrgConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.OrgConfigAPI.GetOrgConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.GetOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOrgConfig`: OrgConfig + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.GetOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-valid-time-zones +:::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 Valid Time Zones +List the valid time zones that can be set in organization configurations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-valid-time-zones) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetValidTimeZonesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +**[]string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.OrgConfigAPI.GetValidTimeZones(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.OrgConfigAPI.GetValidTimeZones(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.GetValidTimeZones``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetValidTimeZones`: []string + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.GetValidTimeZones`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-org-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 + ``` +::: +Patch Org Config +Patch the current organization's configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization's time zone. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-org-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchOrgConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +[**OrgConfig**](../models/org-config) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + jsonpatchoperation := []byte(`[{op=replace, path=/timeZone, value=America/Toronto}]`) // []JsonPatchOperation | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.OrgConfigAPI.PatchOrgConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.OrgConfigAPI.PatchOrgConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.PatchOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchOrgConfig`: OrgConfig + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.PatchOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/PasswordConfigurationAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordConfigurationAPI.md new file mode 100644 index 000000000..96d01e33d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordConfigurationAPI.md @@ -0,0 +1,235 @@ +--- +id: v2024-password-configuration +title: PasswordConfiguration +pagination_label: PasswordConfiguration +sidebar_label: PasswordConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordConfiguration', 'V2024PasswordConfiguration'] +slug: /tools/sdk/go/v2024/methods/password-configuration +tags: ['SDK', 'Software Development Kit', 'PasswordConfiguration', 'V2024PasswordConfiguration'] +--- + +# PasswordConfigurationAPI + Use this API to implement organization password configuration functionality. +With this functionality in place, organization administrators can create organization-specific password configurations. + +These configurations include details like custom password instructions, as well as digit token length and duration. + +Refer to [Configuring User Authentication for Password Resets](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html) for more information about organization password configuration functionality. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-org-config**](#create-password-org-config) | **Post** `/password-org-config` | Create Password Org Config +[**get-password-org-config**](#get-password-org-config) | **Get** `/password-org-config` | Get Password Org Config +[**put-password-org-config**](#put-password-org-config) | **Put** `/password-org-config` | Update Password Org Config + + +## create-password-org-config +Create Password Org Config +This API creates the password org config. Unspecified fields will use default value. +To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-password-org-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePasswordOrgConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordOrgConfig** | [**PasswordOrgConfig**](../models/password-org-config) | | + +### Return type + +[**PasswordOrgConfig**](../models/password-org-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordorgconfig := []byte(`{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }`) // PasswordOrgConfig | + + + var passwordOrgConfig v2024.PasswordOrgConfig + if err := json.Unmarshal(passwordorgconfig, &passwordOrgConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordConfigurationAPI.CreatePasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + //resp, r, err := apiClient.V2024.PasswordConfigurationAPI.CreatePasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.CreatePasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.CreatePasswordOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-password-org-config +Get Password Org Config +This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-org-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordOrgConfigRequest struct via the builder pattern + + +### Return type + +[**PasswordOrgConfig**](../models/password-org-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordConfigurationAPI.GetPasswordOrgConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.PasswordConfigurationAPI.GetPasswordOrgConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.GetPasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.GetPasswordOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-password-org-config +Update Password Org Config +This API updates the password org config for specified fields. Other fields will keep original value. +You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-password-org-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutPasswordOrgConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordOrgConfig** | [**PasswordOrgConfig**](../models/password-org-config) | | + +### Return type + +[**PasswordOrgConfig**](../models/password-org-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordorgconfig := []byte(`{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }`) // PasswordOrgConfig | + + + var passwordOrgConfig v2024.PasswordOrgConfig + if err := json.Unmarshal(passwordorgconfig, &passwordOrgConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordConfigurationAPI.PutPasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + //resp, r, err := apiClient.V2024.PasswordConfigurationAPI.PutPasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.PutPasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutPasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.PutPasswordOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/PasswordDictionaryAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordDictionaryAPI.md new file mode 100644 index 000000000..0cf2360c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordDictionaryAPI.md @@ -0,0 +1,241 @@ +--- +id: v2024-password-dictionary +title: PasswordDictionary +pagination_label: PasswordDictionary +sidebar_label: PasswordDictionary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordDictionary', 'V2024PasswordDictionary'] +slug: /tools/sdk/go/v2024/methods/password-dictionary +tags: ['SDK', 'Software Development Kit', 'PasswordDictionary', 'V2024PasswordDictionary'] +--- + +# PasswordDictionaryAPI + Use this API to implement password dictionary functionality. +With this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords. + +A password dictionary is a list of words or characters that users are prevented from including in their passwords. +This can help protect users from themselves and force them to create passwords that are not easy to break. + +A password dictionary must meet the following requirements to for the API to handle them correctly: + +- It must be in .txt format. + +- All characters must be UTF-8 characters. + +- Each line must contain a single word or character with no spaces or whitespace characters. + +- It must contain at least one line other than the locale string. + +- Each line must not exceed 128 characters. + +- The file must not exceed 2500 lines. + +Administrators should also consider the following when they create their dictionaries: + +- Lines starting with a # represent comments. + +- All words in the password dictionary are case-insensitive. +For example, adding the word "password" to the dictionary also disallows the following: PASSWORD, Password, and PassWord. + +- The dictionary uses substring matching. +For example, adding the word "spring" to the dictionary also disallows the following: Spring124, 345SprinG, and 8spring. +Users can then select 'Change Password' to update their passwords. + +Administrators must do the following to create a password dictionary: + +- Create the text file that will contain the prohibited password values. + +- If the dictionary is not in English, they must add a locale string to the top line: locale:`languageCode`_`countryCode` + +The languageCode value refers to the language's 2-letter ISO 639-1 code. +The countryCode value refers to the country's 2-letter ISO 3166-1 code. + +Refer to this list https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html to see all the available ISO 639-1 language codes and ISO 3166-1 country codes. + +- Upload the .txt file to Identity Security Cloud with [Update Password Dictionary](https://developer.sailpoint.com/docs/api/v2024/put-password-dictionary). Uploading a new file always overwrites the previous dictionary file. + +Administrators can then specify which password policies check new passwords against the password dictionary by doing the following: In the Admin panel, they can use the Password Mgmt dropdown menu to select Policies, select the policy, and select the 'Prevent use of words in this site's password dictionary' checkbox beside it. + +Refer to [Configuring Advanced Password Management Options](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html) for more information about password dictionaries. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-password-dictionary**](#get-password-dictionary) | **Get** `/password-dictionary` | Get Password Dictionary +[**put-password-dictionary**](#put-password-dictionary) | **Put** `/password-dictionary` | Update Password Dictionary + + +## get-password-dictionary +Get Password Dictionary +This gets password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-dictionary) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordDictionaryRequest struct via the builder pattern + + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordDictionaryAPI.GetPasswordDictionary(context.Background()).Execute() + //resp, r, err := apiClient.V2024.PasswordDictionaryAPI.GetPasswordDictionary(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordDictionaryAPI.GetPasswordDictionary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordDictionary`: string + fmt.Fprintf(os.Stdout, "Response from `PasswordDictionaryAPI.GetPasswordDictionary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-password-dictionary +Update Password Dictionary +This updates password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-password-dictionary) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutPasswordDictionaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file** | ***os.File** | | + +### Return type + + (empty response body) + +### 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() { + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.PasswordDictionaryAPI.PutPasswordDictionary(context.Background()).Execute() + //r, err := apiClient.V2024.PasswordDictionaryAPI.PutPasswordDictionary(context.Background()).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordDictionaryAPI.PutPasswordDictionary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/PasswordManagementAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordManagementAPI.md new file mode 100644 index 000000000..3819669f5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordManagementAPI.md @@ -0,0 +1,363 @@ +--- +id: v2024-password-management +title: PasswordManagement +pagination_label: PasswordManagement +sidebar_label: PasswordManagement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordManagement', 'V2024PasswordManagement'] +slug: /tools/sdk/go/v2024/methods/password-management +tags: ['SDK', 'Software Development Kit', 'PasswordManagement', 'V2024PasswordManagement'] +--- + +# PasswordManagementAPI + Use this API to implement password management functionality. +With this functionality in place, users can manage their identity passwords for all their applications. + +In Identity Security Cloud, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. +Password Manager lists the user's identity's applications, possibly grouped to share passwords. +Users can then select 'Change Password' to update their passwords. + +Grouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. +Password Manager may list the applications and sources in the following groups: + +- Password Group: This refers to a group of applications that share a password. +For example, a user can use the same password for Google Drive, Google Mail, and YouTube. +Updating the password for the password group updates the password for all its included applications. + +- Multi-Application Source: This refers to a source with multiple applications that share a password. +For example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. +Updating the password for the multi-application source updates the password for all its included applications. + +- Applications: These are applications that do not share passwords with other applications. + +An organization may require some authentication for users to update their passwords. +Users may be required to answer security questions or use a third-party authenticator before they can confirm their updates. + +Refer to [Managing Passwords](https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html) for more information about password management. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-digit-token**](#create-digit-token) | **Post** `/generate-password-reset-token/digit` | Generate a digit token +[**get-password-change-status**](#get-password-change-status) | **Get** `/password-change-status/{id}` | Get Password Change Request Status +[**query-password-info**](#query-password-info) | **Post** `/query-password-info` | Query Password Info +[**set-password**](#set-password) | **Post** `/set-password` | Set Identity's Password + + +## create-digit-token +:::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 + ``` +::: +Generate a digit token +This API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create". + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-digit-token) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateDigitTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **passwordDigitTokenReset** | [**PasswordDigitTokenReset**](../models/password-digit-token-reset) | | + +### Return type + +[**PasswordDigitToken**](../models/password-digit-token) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + passworddigittokenreset := []byte(`{ + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + }`) // PasswordDigitTokenReset | + + + var passwordDigitTokenReset v2024.PasswordDigitTokenReset + if err := json.Unmarshal(passworddigittokenreset, &passwordDigitTokenReset); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordManagementAPI.CreateDigitToken(context.Background()).XSailPointExperimental(xSailPointExperimental).PasswordDigitTokenReset(passwordDigitTokenReset).Execute() + //resp, r, err := apiClient.V2024.PasswordManagementAPI.CreateDigitToken(context.Background()).XSailPointExperimental(xSailPointExperimental).PasswordDigitTokenReset(passwordDigitTokenReset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.CreateDigitToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDigitToken`: PasswordDigitToken + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.CreateDigitToken`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-password-change-status +Get Password Change Request Status +This API returns the status of a password change request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-change-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Password change request ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordChangeStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**PasswordStatus**](../models/password-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `089899f13a8f4da7824996191587bab9` // string | Password change request ID # string | Password change request ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordManagementAPI.GetPasswordChangeStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.PasswordManagementAPI.GetPasswordChangeStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.GetPasswordChangeStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordChangeStatus`: PasswordStatus + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.GetPasswordChangeStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## query-password-info +Query Password Info +This API is used to query password related information. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/query-password-info) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiQueryPasswordInfoRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordInfoQueryDTO** | [**PasswordInfoQueryDTO**](../models/password-info-query-dto) | | + +### Return type + +[**PasswordInfo**](../models/password-info) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordinfoquerydto := []byte(`{ + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + }`) // PasswordInfoQueryDTO | + + + var passwordInfoQueryDTO v2024.PasswordInfoQueryDTO + if err := json.Unmarshal(passwordinfoquerydto, &passwordInfoQueryDTO); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordManagementAPI.QueryPasswordInfo(context.Background()).PasswordInfoQueryDTO(passwordInfoQueryDTO).Execute() + //resp, r, err := apiClient.V2024.PasswordManagementAPI.QueryPasswordInfo(context.Background()).PasswordInfoQueryDTO(passwordInfoQueryDTO).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.QueryPasswordInfo``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `QueryPasswordInfo`: PasswordInfo + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.QueryPasswordInfo`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-password +Set Identity's Password +This API is used to set a password for an identity. + +An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). + +>**Note: If you want to set an identity's source account password, you must enable `PASSWORD` as one of the source's features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** + +To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: + +```bash +echo -n "myPassword" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 +``` + +In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. + +To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. + +If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. + +You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-password) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetPasswordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordChangeRequest** | [**PasswordChangeRequest**](../models/password-change-request) | | + +### Return type + +[**PasswordChangeResponse**](../models/password-change-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordchangerequest := []byte(`{ + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + }`) // PasswordChangeRequest | + + + var passwordChangeRequest v2024.PasswordChangeRequest + if err := json.Unmarshal(passwordchangerequest, &passwordChangeRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordManagementAPI.SetPassword(context.Background()).PasswordChangeRequest(passwordChangeRequest).Execute() + //resp, r, err := apiClient.V2024.PasswordManagementAPI.SetPassword(context.Background()).PasswordChangeRequest(passwordChangeRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.SetPassword``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetPassword`: PasswordChangeResponse + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.SetPassword`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/PasswordPoliciesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordPoliciesAPI.md new file mode 100644 index 000000000..cfc4fa94d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordPoliciesAPI.md @@ -0,0 +1,435 @@ +--- +id: v2024-password-policies +title: PasswordPolicies +pagination_label: PasswordPolicies +sidebar_label: PasswordPolicies +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordPolicies', 'V2024PasswordPolicies'] +slug: /tools/sdk/go/v2024/methods/password-policies +tags: ['SDK', 'Software Development Kit', 'PasswordPolicies', 'V2024PasswordPolicies'] +--- + +# PasswordPoliciesAPI + Use these APIs to implement password policies functionality. +These APIs allow you to define the policy parameters for choosing passwords. + +IdentityNow comes with a default policy that you can modify to define the password requirements your users must meet to log in to IdentityNow, such as requiring a minimum password length, including special characters, and disallowing certain patterns. +If you have licensed Password Management, you can create additional password policies beyond the default one to manage passwords for supported sources in your org. + +In the Identity Security Cloud Admin panel, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/pwd_policies/pwd_policies.html) for more information about password policies. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-policy**](#create-password-policy) | **Post** `/password-policies` | Create Password Policy +[**delete-password-policy**](#delete-password-policy) | **Delete** `/password-policies/{id}` | Delete Password Policy by ID +[**get-password-policy-by-id**](#get-password-policy-by-id) | **Get** `/password-policies/{id}` | Get Password Policy by ID +[**list-password-policies**](#list-password-policies) | **Get** `/password-policies` | List Password Policies +[**set-password-policy**](#set-password-policy) | **Put** `/password-policies/{id}` | Update Password Policy by ID + + +## create-password-policy +Create Password Policy +This API creates the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-password-policy) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePasswordPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordPolicyV3Dto** | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | | + +### Return type + +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordpolicyv3dto := []byte(`{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : 1939056206564, + "validateAgainstAccountId" : false, + "dateCreated" : 1639056206564, + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }`) // PasswordPolicyV3Dto | + + + var passwordPolicyV3Dto v2024.PasswordPolicyV3Dto + if err := json.Unmarshal(passwordpolicyv3dto, &passwordPolicyV3Dto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordPoliciesAPI.CreatePasswordPolicy(context.Background()).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + //resp, r, err := apiClient.V2024.PasswordPoliciesAPI.CreatePasswordPolicy(context.Background()).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.CreatePasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordPolicy`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.CreatePasswordPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-password-policy +Delete Password Policy by ID +This API deletes the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-password-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password policy to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePasswordPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ff808081838d9e9d01838da6a03e0002` // string | The ID of password policy to delete. # string | The ID of password policy to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.PasswordPoliciesAPI.DeletePasswordPolicy(context.Background(), id).Execute() + //r, err := apiClient.V2024.PasswordPoliciesAPI.DeletePasswordPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.DeletePasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-password-policy-by-id +Get Password Policy by ID +This API returns the password policy for the specified ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-policy-by-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password policy to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordPolicyByIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ff808081838d9e9d01838da6a03e0005` // string | The ID of password policy to retrieve. # string | The ID of password policy to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordPoliciesAPI.GetPasswordPolicyById(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.PasswordPoliciesAPI.GetPasswordPolicyById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.GetPasswordPolicyById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordPolicyById`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.GetPasswordPolicyById`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-password-policies +List Password Policies +This gets list of all Password Policies. +Requires role of ORG_ADMIN + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-password-policies) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPasswordPoliciesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordPoliciesAPI.ListPasswordPolicies(context.Background()).Execute() + //resp, r, err := apiClient.V2024.PasswordPoliciesAPI.ListPasswordPolicies(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.ListPasswordPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPasswordPolicies`: []PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.ListPasswordPolicies`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-password-policy +Update Password Policy by ID +This API updates the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-password-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password policy to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetPasswordPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **passwordPolicyV3Dto** | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | | + +### Return type + +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ff808081838d9e9d01838da6a03e0007` // string | The ID of password policy to update. # string | The ID of password policy to update. + passwordpolicyv3dto := []byte(`{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : 1939056206564, + "validateAgainstAccountId" : false, + "dateCreated" : 1639056206564, + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }`) // PasswordPolicyV3Dto | + + + var passwordPolicyV3Dto v2024.PasswordPolicyV3Dto + if err := json.Unmarshal(passwordpolicyv3dto, &passwordPolicyV3Dto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordPoliciesAPI.SetPasswordPolicy(context.Background(), id).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + //resp, r, err := apiClient.V2024.PasswordPoliciesAPI.SetPasswordPolicy(context.Background(), id).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.SetPasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetPasswordPolicy`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.SetPasswordPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/PasswordSyncGroupsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordSyncGroupsAPI.md new file mode 100644 index 000000000..06c02ca70 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/PasswordSyncGroupsAPI.md @@ -0,0 +1,408 @@ +--- +id: v2024-password-sync-groups +title: PasswordSyncGroups +pagination_label: PasswordSyncGroups +sidebar_label: PasswordSyncGroups +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordSyncGroups', 'V2024PasswordSyncGroups'] +slug: /tools/sdk/go/v2024/methods/password-sync-groups +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroups', 'V2024PasswordSyncGroups'] +--- + +# PasswordSyncGroupsAPI + Use this API to implement password sync group functionality. +With this functionality in place, administrators can group sources into password sync groups so that all their applications share the same password. +This allows users to update the password for all the applications in a sync group if they want, rather than updating each password individually. + +A password sync group is a group of applications that shares a password. +Administrators create these groups by grouping the applications' sources. +For example, an administrator can group the ActiveDirectory, GitHub, and G Suite sources together so that all those sources' applications can also be grouped to share a password. +A user can then update his or her password for ActiveDirectory, GitHub, Gmail, Google Drive, and Google Calendar all at once, rather then updating each one individually. + +The following are required for administrators to create a password sync group in Identity Security Cloud: + +- At least two direct connect sources connected to Identity Security Cloud and configured for Password Management. + +- Each authentication source in a sync group must have at least one application. Refer to [Adding and Resetting Application Passwords](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html#adding-and-resetting-application-passwords) for more information about adding applications to sources. + +- At least one password policy. Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/policies.html) for more information about password policies. + +In the Admin panel in Identity Security Cloud, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +To create a sync group, administrators must provide a name, choose a password policy to be enforced across the sources in the sync group, and select the sources to include in the sync group. + +Administrators can also delete sync groups in Identity Security Cloud, but they should know the following before they do: + +- Passwords related to the associated sources will become independent, so changing one will not change the others anymore. + +- Passwords for the sources' connected applications will also become independent. + +- Password policies assigned to the sync group are then assigned directly to the associated sources. +To change the password policy for a source, administrators must edit it directly. + +Once the password sync group has been created, users can update the password for the group in Password Manager. + +Refer to [Managing Password Sync Groups](https://documentation.sailpoint.com/saas/help/pwd/sync_grps.html) for more information about password sync groups. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-sync-group**](#create-password-sync-group) | **Post** `/password-sync-groups` | Create Password Sync Group +[**delete-password-sync-group**](#delete-password-sync-group) | **Delete** `/password-sync-groups/{id}` | Delete Password Sync Group by ID +[**get-password-sync-group**](#get-password-sync-group) | **Get** `/password-sync-groups/{id}` | Get Password Sync Group by ID +[**get-password-sync-groups**](#get-password-sync-groups) | **Get** `/password-sync-groups` | Get Password Sync Group List +[**update-password-sync-group**](#update-password-sync-group) | **Put** `/password-sync-groups/{id}` | Update Password Sync Group by ID + + +## create-password-sync-group +Create Password Sync Group +This API creates a password sync group based on the specifications provided. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-password-sync-group) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePasswordSyncGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordSyncGroup** | [**PasswordSyncGroup**](../models/password-sync-group) | | + +### Return type + +[**PasswordSyncGroup**](../models/password-sync-group) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordsyncgroup := []byte(`{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }`) // PasswordSyncGroup | + + + var passwordSyncGroup v2024.PasswordSyncGroup + if err := json.Unmarshal(passwordsyncgroup, &passwordSyncGroup); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordSyncGroupsAPI.CreatePasswordSyncGroup(context.Background()).PasswordSyncGroup(passwordSyncGroup).Execute() + //resp, r, err := apiClient.V2024.PasswordSyncGroupsAPI.CreatePasswordSyncGroup(context.Background()).PasswordSyncGroup(passwordSyncGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.CreatePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.CreatePasswordSyncGroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-password-sync-group +Delete Password Sync Group by ID +This API deletes the specified password sync group. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-password-sync-group) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password sync group to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePasswordSyncGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to delete. # string | The ID of password sync group to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.PasswordSyncGroupsAPI.DeletePasswordSyncGroup(context.Background(), id).Execute() + //r, err := apiClient.V2024.PasswordSyncGroupsAPI.DeletePasswordSyncGroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.DeletePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-password-sync-group +Get Password Sync Group by ID +This API returns the sync group for the specified ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-sync-group) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password sync group to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordSyncGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**PasswordSyncGroup**](../models/password-sync-group) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to retrieve. # string | The ID of password sync group to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordSyncGroupsAPI.GetPasswordSyncGroup(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.PasswordSyncGroupsAPI.GetPasswordSyncGroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.GetPasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.GetPasswordSyncGroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-password-sync-groups +Get Password Sync Group List +This API returns a list of password sync groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-sync-groups) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordSyncGroupsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]PasswordSyncGroup**](../models/password-sync-group) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordSyncGroupsAPI.GetPasswordSyncGroups(context.Background()).Execute() + //resp, r, err := apiClient.V2024.PasswordSyncGroupsAPI.GetPasswordSyncGroups(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.GetPasswordSyncGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordSyncGroups`: []PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.GetPasswordSyncGroups`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-password-sync-group +Update Password Sync Group by ID +This API updates the specified password sync group. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-password-sync-group) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password sync group to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdatePasswordSyncGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **passwordSyncGroup** | [**PasswordSyncGroup**](../models/password-sync-group) | | + +### Return type + +[**PasswordSyncGroup**](../models/password-sync-group) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to update. # string | The ID of password sync group to update. + passwordsyncgroup := []byte(`{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }`) // PasswordSyncGroup | + + + var passwordSyncGroup v2024.PasswordSyncGroup + if err := json.Unmarshal(passwordsyncgroup, &passwordSyncGroup); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordSyncGroupsAPI.UpdatePasswordSyncGroup(context.Background(), id).PasswordSyncGroup(passwordSyncGroup).Execute() + //resp, r, err := apiClient.V2024.PasswordSyncGroupsAPI.UpdatePasswordSyncGroup(context.Background(), id).PasswordSyncGroup(passwordSyncGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.UpdatePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.UpdatePasswordSyncGroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/PersonalAccessTokensAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/PersonalAccessTokensAPI.md new file mode 100644 index 000000000..66283d879 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/PersonalAccessTokensAPI.md @@ -0,0 +1,309 @@ +--- +id: v2024-personal-access-tokens +title: PersonalAccessTokens +pagination_label: PersonalAccessTokens +sidebar_label: PersonalAccessTokens +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PersonalAccessTokens', 'V2024PersonalAccessTokens'] +slug: /tools/sdk/go/v2024/methods/personal-access-tokens +tags: ['SDK', 'Software Development Kit', 'PersonalAccessTokens', 'V2024PersonalAccessTokens'] +--- + +# PersonalAccessTokensAPI + Use this API to implement personal access token (PAT) functionality. +With this functionality in place, users can use PATs as an alternative to passwords for authentication in Identity Security Cloud. + +PATs embed user information into the client ID and secret. +This replaces the API clients' need to store and provide a username and password to establish a connection, improving Identity Security Cloud organizations' integration security. + +In Identity Security Cloud, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens. +They must then provide a description about the token's purpose. +They can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID. + +Refer to [Managing Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/generate_tokens.html) for more information about PATs. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-personal-access-token**](#create-personal-access-token) | **Post** `/personal-access-tokens` | Create Personal Access Token +[**delete-personal-access-token**](#delete-personal-access-token) | **Delete** `/personal-access-tokens/{id}` | Delete Personal Access Token +[**list-personal-access-tokens**](#list-personal-access-tokens) | **Get** `/personal-access-tokens` | List Personal Access Tokens +[**patch-personal-access-token**](#patch-personal-access-token) | **Patch** `/personal-access-tokens/{id}` | Patch Personal Access Token + + +## create-personal-access-token +Create Personal Access Token +This creates a personal access token. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-personal-access-token) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePersonalAccessTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createPersonalAccessTokenRequest** | [**CreatePersonalAccessTokenRequest**](../models/create-personal-access-token-request) | Name and scope of personal access token. | + +### Return type + +[**CreatePersonalAccessTokenResponse**](../models/create-personal-access-token-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createpersonalaccesstokenrequest := []byte(`{ + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + }`) // CreatePersonalAccessTokenRequest | Name and scope of personal access token. + + + var createPersonalAccessTokenRequest v2024.CreatePersonalAccessTokenRequest + if err := json.Unmarshal(createpersonalaccesstokenrequest, &createPersonalAccessTokenRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PersonalAccessTokensAPI.CreatePersonalAccessToken(context.Background()).CreatePersonalAccessTokenRequest(createPersonalAccessTokenRequest).Execute() + //resp, r, err := apiClient.V2024.PersonalAccessTokensAPI.CreatePersonalAccessToken(context.Background()).CreatePersonalAccessTokenRequest(createPersonalAccessTokenRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.CreatePersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePersonalAccessToken`: CreatePersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.CreatePersonalAccessToken`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-personal-access-token +Delete Personal Access Token +This deletes a personal access token. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-personal-access-token) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The personal access token id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePersonalAccessTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The personal access token id # string | The personal access token id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.PersonalAccessTokensAPI.DeletePersonalAccessToken(context.Background(), id).Execute() + //r, err := apiClient.V2024.PersonalAccessTokensAPI.DeletePersonalAccessToken(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.DeletePersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## list-personal-access-tokens +List Personal Access Tokens +This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-personal-access-tokens) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPersonalAccessTokensRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' | + **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: **lastUsed**: *le, isnull* | + +### Return type + +[**[]GetPersonalAccessTokenResponse**](../models/get-personal-access-token-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c9180867b50d088017b554662fb281e` // string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) # string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + filters := `lastUsed le 2023-02-05T10:59:27.214Z` // 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PersonalAccessTokensAPI.ListPersonalAccessTokens(context.Background()).Execute() + //resp, r, err := apiClient.V2024.PersonalAccessTokensAPI.ListPersonalAccessTokens(context.Background()).OwnerId(ownerId).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.ListPersonalAccessTokens``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPersonalAccessTokens`: []GetPersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.ListPersonalAccessTokens`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-personal-access-token +Patch Personal Access Token +This performs a targeted update to the field(s) of a Personal Access Token. +Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-personal-access-token) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Personal Access Token id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchPersonalAccessTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope | + +### Return type + +[**GetPersonalAccessTokenResponse**](../models/get-personal-access-token-response) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The Personal Access Token id # string | The Personal Access Token id + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}]`) // []JsonPatchOperation | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PersonalAccessTokensAPI.PatchPersonalAccessToken(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.PersonalAccessTokensAPI.PatchPersonalAccessToken(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.PatchPersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPersonalAccessToken`: GetPersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.PatchPersonalAccessToken`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/PublicIdentitiesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/PublicIdentitiesAPI.md new file mode 100644 index 000000000..045fa35dd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/PublicIdentitiesAPI.md @@ -0,0 +1,95 @@ +--- +id: v2024-public-identities +title: PublicIdentities +pagination_label: PublicIdentities +sidebar_label: PublicIdentities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentities', 'V2024PublicIdentities'] +slug: /tools/sdk/go/v2024/methods/public-identities +tags: ['SDK', 'Software Development Kit', 'PublicIdentities', 'V2024PublicIdentities'] +--- + +# PublicIdentitiesAPI + Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/docs/api/v2024/public-identities-config/) to enable non-administrators to view identities' publicly visible attributes. +With this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public. +This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-public-identities**](#get-public-identities) | **Get** `/public-identities` | Get list of public identities + + +## get-public-identities +Get list of public identities +Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-public-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPublicIdentitiesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* | + **addCoreFilters** | **bool** | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. | [default to false] + **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** | + +### Return type + +[**[]PublicIdentity**](../models/public-identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `firstname eq "John"` // 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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) + addCoreFilters := false // bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to false) # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to false) + sorters := `name` // 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** (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** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PublicIdentitiesAPI.GetPublicIdentities(context.Background()).Execute() + //resp, r, err := apiClient.V2024.PublicIdentitiesAPI.GetPublicIdentities(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).AddCoreFilters(addCoreFilters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesAPI.GetPublicIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPublicIdentities`: []PublicIdentity + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesAPI.GetPublicIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/PublicIdentitiesConfigAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/PublicIdentitiesConfigAPI.md new file mode 100644 index 000000000..98eb1f056 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/PublicIdentitiesConfigAPI.md @@ -0,0 +1,170 @@ +--- +id: v2024-public-identities-config +title: PublicIdentitiesConfig +pagination_label: PublicIdentitiesConfig +sidebar_label: PublicIdentitiesConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentitiesConfig', 'V2024PublicIdentitiesConfig'] +slug: /tools/sdk/go/v2024/methods/public-identities-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentitiesConfig', 'V2024PublicIdentitiesConfig'] +--- + +# PublicIdentitiesConfigAPI + Use this API to implement public identity configuration functionality. +With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. +This can be helpful for approvers making approvals, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +By default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. +However, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc. +Administrators can use this API to make those necessary identity attributes public to non-administrators. + +For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. +If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/docs/api/v2024/update-public-identity-config/) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-public-identity-config**](#get-public-identity-config) | **Get** `/public-identities-config` | Get the Public Identities Configuration +[**update-public-identity-config**](#update-public-identity-config) | **Put** `/public-identities-config` | Update the Public Identities Configuration + + +## get-public-identity-config +Get the Public Identities Configuration +Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-public-identity-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPublicIdentityConfigRequest struct via the builder pattern + + +### Return type + +[**PublicIdentityConfig**](../models/public-identity-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PublicIdentitiesConfigAPI.GetPublicIdentityConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.PublicIdentitiesConfigAPI.GetPublicIdentityConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesConfigAPI.GetPublicIdentityConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPublicIdentityConfig`: PublicIdentityConfig + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesConfigAPI.GetPublicIdentityConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-public-identity-config +Update the Public Identities Configuration +Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-public-identity-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdatePublicIdentityConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **publicIdentityConfig** | [**PublicIdentityConfig**](../models/public-identity-config) | | + +### Return type + +[**PublicIdentityConfig**](../models/public-identity-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + publicidentityconfig := []byte(`{ + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }`) // PublicIdentityConfig | + + + var publicIdentityConfig v2024.PublicIdentityConfig + if err := json.Unmarshal(publicidentityconfig, &publicIdentityConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig(context.Background()).PublicIdentityConfig(publicIdentityConfig).Execute() + //resp, r, err := apiClient.V2024.PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig(context.Background()).PublicIdentityConfig(publicIdentityConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePublicIdentityConfig`: PublicIdentityConfig + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ReportsDataExtractionAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ReportsDataExtractionAPI.md new file mode 100644 index 000000000..e171865ac --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ReportsDataExtractionAPI.md @@ -0,0 +1,304 @@ +--- +id: v2024-reports-data-extraction +title: ReportsDataExtraction +pagination_label: ReportsDataExtraction +sidebar_label: ReportsDataExtraction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportsDataExtraction', 'V2024ReportsDataExtraction'] +slug: /tools/sdk/go/v2024/methods/reports-data-extraction +tags: ['SDK', 'Software Development Kit', 'ReportsDataExtraction', 'V2024ReportsDataExtraction'] +--- + +# ReportsDataExtractionAPI + Use this API to implement reports lifecycle managing and monitoring. +With this functionality in place, users can run reports, view their results, and cancel reports in progress. +This can be potentially helpful for auditing purposes. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-report**](#cancel-report) | **Post** `/reports/{id}/cancel` | Cancel Report +[**get-report**](#get-report) | **Get** `/reports/{taskResultId}` | Get Report File +[**get-report-result**](#get-report-result) | **Get** `/reports/{taskResultId}/result` | Get Report Result +[**start-report**](#start-report) | **Post** `/reports/run` | Run Report + + +## cancel-report +Cancel Report +Cancels a running report. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the running Report to cancel | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCancelReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `a1ed223247144cc29d23c632624b4767` // string | ID of the running Report to cancel # string | ID of the running Report to cancel + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ReportsDataExtractionAPI.CancelReport(context.Background(), id).Execute() + //r, err := apiClient.V2024.ReportsDataExtractionAPI.CancelReport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.CancelReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-report +Get Report File +Gets a report in file format. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**taskResultId** | **string** | Unique identifier of the task result which handled report | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **fileFormat** | **string** | Output format of the requested report file | + **name** | **string** | preferred Report file name, by default will be used report name from task result. | + **auditable** | **bool** | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. | [default to false] + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/csv, application/pdf, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + taskResultId := `ef38f94347e94562b5bb8424a56397d8` // string | Unique identifier of the task result which handled report # string | Unique identifier of the task result which handled report + fileFormat := `csv` // string | Output format of the requested report file # string | Output format of the requested report file + name := `Identities Details Report` // string | preferred Report file name, by default will be used report name from task result. (optional) # string | preferred Report file name, by default will be used report name from task result. (optional) + auditable := true // bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to false) # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ReportsDataExtractionAPI.GetReport(context.Background(), taskResultId).FileFormat(fileFormat).Execute() + //resp, r, err := apiClient.V2024.ReportsDataExtractionAPI.GetReport(context.Background(), taskResultId).FileFormat(fileFormat).Name(name).Auditable(auditable).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.GetReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.GetReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-report-result +Get Report Result +Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-report-result) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**taskResultId** | **string** | Unique identifier of the task result which handled report | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetReportResultRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **completed** | **bool** | state of task result to apply ordering when results are fetching from the DB | [default to false] + +### Return type + +[**ReportResults**](../models/report-results) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + taskResultId := `ef38f94347e94562b5bb8424a56397d8` // string | Unique identifier of the task result which handled report # string | Unique identifier of the task result which handled report + completed := true // bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to false) # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ReportsDataExtractionAPI.GetReportResult(context.Background(), taskResultId).Execute() + //resp, r, err := apiClient.V2024.ReportsDataExtractionAPI.GetReportResult(context.Background(), taskResultId).Completed(completed).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.GetReportResult``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReportResult`: ReportResults + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.GetReportResult`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-report +Run Report +Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-report) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **reportDetails** | [**ReportDetails**](../models/report-details) | | + +### Return type + +[**TaskResultDetails**](../models/task-result-details) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reportdetails := []byte(`{ + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + }`) // ReportDetails | + + + var reportDetails v2024.ReportDetails + if err := json.Unmarshal(reportdetails, &reportDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ReportsDataExtractionAPI.StartReport(context.Background()).ReportDetails(reportDetails).Execute() + //resp, r, err := apiClient.V2024.ReportsDataExtractionAPI.StartReport(context.Background()).ReportDetails(reportDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.StartReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartReport`: TaskResultDetails + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.StartReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/RequestableObjectsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/RequestableObjectsAPI.md new file mode 100644 index 000000000..69597c03e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/RequestableObjectsAPI.md @@ -0,0 +1,102 @@ +--- +id: v2024-requestable-objects +title: RequestableObjects +pagination_label: RequestableObjects +sidebar_label: RequestableObjects +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObjects', 'V2024RequestableObjects'] +slug: /tools/sdk/go/v2024/methods/requestable-objects +tags: ['SDK', 'Software Development Kit', 'RequestableObjects', 'V2024RequestableObjects'] +--- + +# RequestableObjectsAPI + Use this API to implement requestable object functionality. +With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/docs/api/v2024/access-requests/), along with their statuses. +This can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**list-requestable-objects**](#list-requestable-objects) | **Get** `/requestable-objects` | Requestable Objects List + + +## list-requestable-objects +Requestable Objects List +Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. +Any authenticated token can call this endpoint to see their requestable access items. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-requestable-objects) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListRequestableObjectsRequest struct via the builder pattern + + +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. | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, in, sw* | + **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** | + +### Return type + +[**[]RequestableObject**](../models/requestable-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw "bob"` // 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, in, sw* (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, in, sw* (optional) + sorters := `name` // 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** (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** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RequestableObjectsAPI.ListRequestableObjects(context.Background()).Execute() + //resp, r, err := apiClient.V2024.RequestableObjectsAPI.ListRequestableObjects(context.Background()).IdentityId(identityId).Types(types).Term(term).Statuses(statuses).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RequestableObjectsAPI.ListRequestableObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListRequestableObjects`: []RequestableObject + fmt.Fprintf(os.Stdout, "Response from `RequestableObjectsAPI.ListRequestableObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/RoleInsightsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/RoleInsightsAPI.md new file mode 100644 index 000000000..ab36b3739 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/RoleInsightsAPI.md @@ -0,0 +1,762 @@ +--- +id: v2024-role-insights +title: RoleInsights +pagination_label: RoleInsights +sidebar_label: RoleInsights +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsights', 'V2024RoleInsights'] +slug: /tools/sdk/go/v2024/methods/role-insights +tags: ['SDK', 'Software Development Kit', 'RoleInsights', 'V2024RoleInsights'] +--- + +# RoleInsightsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-role-insight-requests**](#create-role-insight-requests) | **Post** `/role-insights/requests` | Generate insights for roles +[**download-role-insights-entitlements-changes**](#download-role-insights-entitlements-changes) | **Get** `/role-insights/{insightId}/entitlement-changes/download` | Download entitlement insights for a role +[**get-entitlement-changes-identities**](#get-entitlement-changes-identities) | **Get** `/role-insights/{insightId}/entitlement-changes/{entitlementId}/identities` | Get identities for a suggested entitlement (for a role) +[**get-role-insight**](#get-role-insight) | **Get** `/role-insights/{insightId}` | Get a single role insight +[**get-role-insights**](#get-role-insights) | **Get** `/role-insights` | Get role insights +[**get-role-insights-current-entitlements**](#get-role-insights-current-entitlements) | **Get** `/role-insights/{insightId}/current-entitlements` | Get current entitlement for a role +[**get-role-insights-entitlements-changes**](#get-role-insights-entitlements-changes) | **Get** `/role-insights/{insightId}/entitlement-changes` | Get entitlement insights for a role +[**get-role-insights-requests**](#get-role-insights-requests) | **Get** `/role-insights/requests/{id}` | Returns metadata from prior request. +[**get-role-insights-summary**](#get-role-insights-summary) | **Get** `/role-insights/summary` | Get role insights summary information + + +## create-role-insight-requests +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::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 + ``` +::: +Generate insights for roles +Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-role-insight-requests) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateRoleInsightRequestsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleInsightsResponse**](../models/role-insights-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RoleInsightsAPI.CreateRoleInsightRequests(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.CreateRoleInsightRequests(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.CreateRoleInsightRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRoleInsightRequests`: RoleInsightsResponse + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.CreateRoleInsightRequests`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## download-role-insights-entitlements-changes +:::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 + ``` +::: +Download entitlement insights for a role +This endpoint returns the entitlement insights for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/download-role-insights-entitlements-changes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**insightId** | **string** | The role insight id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDownloadRoleInsightsEntitlementsChangesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. | + **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: **name**: *sw* **description**: *sw* | + +### Return type + +**string** + +### 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() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight 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") + sorters := `identitiesWithAccess` // 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + filters := `name sw "r"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DownloadRoleInsightsEntitlementsChanges`: string + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlement-changes-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 + ``` +::: +Get identities for a suggested entitlement (for a role) +Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-changes-identities) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**insightId** | **string** | The role insight id | +**entitlementId** | **string** | The entitlement id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementChangesIdentitiesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **hasEntitlement** | **bool** | Identity has this entitlement or not | [default to false] + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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** | + **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: **name**: *sw* | + +### Return type + +[**[]RoleInsightsIdentities**](../models/role-insights-identities) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight id + entitlementId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The entitlement id # string | The entitlement 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") + hasEntitlement := true // bool | Identity has this entitlement or not (optional) (default to false) # bool | Identity has this entitlement or not (optional) (default to false) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name` // 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** (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** (optional) + filters := `name sw "Jan"` // 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: **name**: *sw* (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: **name**: *sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RoleInsightsAPI.GetEntitlementChangesIdentities(context.Background(), insightId, entitlementId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.GetEntitlementChangesIdentities(context.Background(), insightId, entitlementId).XSailPointExperimental(xSailPointExperimental).HasEntitlement(hasEntitlement).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetEntitlementChangesIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementChangesIdentities`: []RoleInsightsIdentities + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetEntitlementChangesIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insight +:::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 a single role insight +This endpoint gets role insights information for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insight) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**insightId** | **string** | The role insight id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleInsight**](../models/role-insight) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight 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.RoleInsightsAPI.GetRoleInsight(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsight(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsight``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsight`: RoleInsight + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsight`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insights +:::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 role insights +This method returns detailed role insights for each role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** | + **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: **name**: *sw* **ownerName**: *sw* **description**: *sw* | + +### Return type + +[**[]RoleInsight**](../models/role-insight) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `numberOfUpdates` // 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + filters := `name sw "John"` // 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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsights(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsights(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsights``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsights`: []RoleInsight + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsights`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insights-current-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 + ``` +::: +Get current entitlement for a role +This endpoint gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-current-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**insightId** | **string** | The role insight id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightsCurrentEntitlementsRequest struct via the builder pattern + + +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: **name**: *sw* **description**: *sw* | + +### Return type + +[**[]RoleInsightsEntitlement**](../models/role-insights-entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight 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") + filters := `name sw "r"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsightsCurrentEntitlements(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsightsCurrentEntitlements(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsCurrentEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsCurrentEntitlements`: []RoleInsightsEntitlement + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsCurrentEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insights-entitlements-changes +:::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 entitlement insights for a role +This endpoint returns entitlement insights for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-entitlements-changes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**insightId** | **string** | The role insight id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightsEntitlementsChangesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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: **identitiesWithAccess, name** | + **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: **name**: *sw* **description**: *sw* | + +### Return type + +[**[]RoleInsightsEntitlementChanges**](../models/role-insights-entitlement-changes) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight 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") + sorters := `sorters_example` // 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: **identitiesWithAccess, name** (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: **identitiesWithAccess, name** (optional) + filters := `name sw "Admin"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsightsEntitlementsChanges(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsightsEntitlementsChanges(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsEntitlementsChanges``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsEntitlementsChanges`: []RoleInsightsEntitlementChanges + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsEntitlementsChanges`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insights-requests +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::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 + ``` +::: +Returns metadata from prior request. +This endpoint returns details of a prior role insights request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-requests) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The role insights request id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightsRequestsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleInsightsResponse**](../models/role-insights-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insights request id # string | The role insights request 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.RoleInsightsAPI.GetRoleInsightsRequests(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsightsRequests(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsRequests`: RoleInsightsResponse + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsRequests`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insights-summary +:::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 role insights summary information +This method returns high level summary information for role insights for a customer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-summary) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightsSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleInsightsSummary**](../models/role-insights-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsightsSummary(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsightsSummary(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsSummary`: RoleInsightsSummary + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/RolesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/RolesAPI.md new file mode 100644 index 000000000..da2f4a0e3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/RolesAPI.md @@ -0,0 +1,1449 @@ +--- +id: v2024-roles +title: Roles +pagination_label: Roles +sidebar_label: Roles +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Roles', 'V2024Roles'] +slug: /tools/sdk/go/v2024/methods/roles +tags: ['SDK', 'Software Development Kit', 'Roles', 'V2024Roles'] +--- + +# RolesAPI + Use this API to implement and customize role functionality. +With this functionality in place, administrators can create roles and configure them for use throughout Identity Security Cloud. +Identity Security Cloud can use established criteria to automatically assign the roles to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. + +Entitlements represent the most granular level of access in Identity Security Cloud. +Access profiles represent the next level and often group entitlements. +Roles represent the broadest level of access and often group access profiles. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Roles often represent positions within organizations. +For example, an organization's accountant can access all the tools the organization's accountants need with the 'Accountant' role. +If the accountant switches to engineering, a qualified member of the organization can quickly revoke the accountant's 'Accountant' access and grant access to the 'Engineer' role instead, granting access to all the tools the organization's engineers need. + +In Identity Security Cloud, adminstrators can use the Access drop-down menu and select Roles to view, configure, and delete existing roles, as well as create new ones. +Administrators can enable and disable the role, and they can also make the following configurations: + +- Manage Access: Manage the role's access by adding or removing access profiles. + +- Define Assignment: Define the criteria Identity Security Cloud uses to assign the role to identities. +Use the first option, 'Standard Criteria,' to provide specific criteria for assignment like specific account attributes, entitlements, or identity attributes. +Use the second, 'Identity List,' to specify the identities for assignment. + +- Access Requests: Configure roles to be requestable and establish an approval process for any requests that the role be granted or revoked. +Do not configure a role to be requestable without establishing a secure access request approval process for that role first. + +Refer to [Working with Roles](https://documentation.sailpoint.com/saas/help/access/roles.html) for more information about roles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-role**](#create-role) | **Post** `/roles` | Create a Role +[**delete-bulk-roles**](#delete-bulk-roles) | **Post** `/roles/bulk-delete` | Delete Role(s) +[**delete-metadata-from-role-by-key-and-value**](#delete-metadata-from-role-by-key-and-value) | **Delete** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove a Metadata From Role. +[**delete-role**](#delete-role) | **Delete** `/roles/{id}` | Delete a Role +[**get-bulk-update-status**](#get-bulk-update-status) | **Get** `/roles/access-model-metadata/bulk-update` | Get Bulk-Update Statuses +[**get-bulk-update-status-by-id**](#get-bulk-update-status-by-id) | **Get** `/roles/access-model-metadata/bulk-update/id` | Get Bulk-Update Status by ID +[**get-role**](#get-role) | **Get** `/roles/{id}` | Get a Role +[**get-role-assigned-identities**](#get-role-assigned-identities) | **Get** `/roles/{id}/assigned-identities` | List Identities assigned a Role +[**get-role-entitlements**](#get-role-entitlements) | **Get** `/roles/{id}/entitlements` | List Role's Entitlements +[**list-roles**](#list-roles) | **Get** `/roles` | List Roles +[**patch-role**](#patch-role) | **Patch** `/roles/{id}` | Patch a specified Role +[**search-roles-by-filter**](#search-roles-by-filter) | **Post** `/roles/filter` | Filter Roles by Metadata +[**update-attribute-key-and-value-to-role**](#update-attribute-key-and-value-to-role) | **Post** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add a Metadata to Role. +[**update-roles-metadata-by-filter**](#update-roles-metadata-by-filter) | **Post** `/roles/access-model-metadata/bulk-update/filter` | Bulk-Update Roles' Metadata by Filters +[**update-roles-metadata-by-ids**](#update-roles-metadata-by-ids) | **Post** `/roles/access-model-metadata/bulk-update/ids` | Bulk-Update Roles' Metadata by ID +[**update-roles-metadata-by-query**](#update-roles-metadata-by-query) | **Post** `/roles/access-model-metadata/bulk-update/query` | Bulk-Update Roles' Metadata by Query + + +## create-role +Create a Role +This API creates a role. + +You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. + +In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-role) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **role** | [**Role**](../models/role) | | + +### Return type + +[**Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + role := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + }`) // Role | + + + var role v2024.Role + if err := json.Unmarshal(role, &role); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.CreateRole(context.Background()).Role(role).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.CreateRole(context.Background()).Role(role).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.CreateRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.CreateRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-bulk-roles +Delete Role(s) +This endpoint initiates a bulk deletion of one or more roles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 roles per request. +A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-bulk-roles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteBulkRolesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **roleBulkDeleteRequest** | [**RoleBulkDeleteRequest**](../models/role-bulk-delete-request) | | + +### Return type + +[**TaskResultDto**](../models/task-result-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + rolebulkdeleterequest := []byte(`{ + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + }`) // RoleBulkDeleteRequest | + + + var roleBulkDeleteRequest v2024.RoleBulkDeleteRequest + if err := json.Unmarshal(rolebulkdeleterequest, &roleBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.DeleteBulkRoles(context.Background()).RoleBulkDeleteRequest(roleBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.DeleteBulkRoles(context.Background()).RoleBulkDeleteRequest(roleBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteBulkRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteBulkRoles`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.DeleteBulkRoles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-metadata-from-role-by-key-and-value +Remove a Metadata From Role. +This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-metadata-from-role-by-key-and-value) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The role's id. | +**attributeKey** | **string** | Technical name of the Attribute. | +**attributeValue** | **string** | Technical name of the Attribute Value. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteMetadataFromRoleByKeyAndValueRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | The role's id. # string | The role's id. + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.RolesAPI.DeleteMetadataFromRoleByKeyAndValue(context.Background(), id, attributeKey, attributeValue).Execute() + //r, err := apiClient.V2024.RolesAPI.DeleteMetadataFromRoleByKeyAndValue(context.Background(), id, attributeKey, attributeValue).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteMetadataFromRoleByKeyAndValue``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-role +Delete a Role +This API deletes a Role by its ID. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Role | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role # string | ID of the Role + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.RolesAPI.DeleteRole(context.Background(), id).Execute() + //r, err := apiClient.V2024.RolesAPI.DeleteRole(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-bulk-update-status +Get Bulk-Update Statuses +This API returns a list of all unfinished bulk update process status of the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-bulk-update-status) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetBulkUpdateStatusRequest struct via the builder pattern + + +### Return type + +[**[]RoleGetAllBulkUpdateResponse**](../models/role-get-all-bulk-update-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.GetBulkUpdateStatus(context.Background()).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.GetBulkUpdateStatus(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetBulkUpdateStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBulkUpdateStatus`: []RoleGetAllBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetBulkUpdateStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-bulk-update-status-by-id +Get Bulk-Update Status by ID + +This API initial a request for one bulk update's status by bulk update Id returns the status of the bulk update process. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-bulk-update-status-by-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Id of the bulk update task. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetBulkUpdateStatusByIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**RoleBulkUpdateResponse**](../models/role-bulk-update-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c24359c389374d0fb8585698a2189e3d` // string | The Id of the bulk update task. # string | The Id of the bulk update task. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.GetBulkUpdateStatusById(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.GetBulkUpdateStatusById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetBulkUpdateStatusById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBulkUpdateStatusById`: RoleBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetBulkUpdateStatusById`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role +Get a Role +This API returns a Role by its ID. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Role | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role # string | ID of the Role + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.GetRole(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.GetRole(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-assigned-identities +List Identities assigned a Role + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-assigned-identities) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Role for which the assigned Identities are to be listed | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleAssignedIdentitiesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* | + **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: **id, name, aliasName, email** | + +### Return type + +[**[]RoleIdentity**](../models/role-identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role for which the assigned Identities are to be listed # string | ID of the Role for which the assigned Identities are to be listed + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw Joe` // 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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + sorters := `aliasName,name` // 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: **id, name, aliasName, email** (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: **id, name, aliasName, email** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.GetRoleAssignedIdentities(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.GetRoleAssignedIdentities(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRoleAssignedIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleAssignedIdentities`: []RoleIdentity + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRoleAssignedIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-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 + ``` +::: +List Role's Entitlements +Get a list of entitlements associated with a specified role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Containing role's ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleEntitlementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* | + **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, attribute, value, created, modified** | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | Containing role's ID. # string | Containing role's 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") + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.GetRoleEntitlements(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.GetRoleEntitlements(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRoleEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRoleEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-roles +List Roles +This API returns a list of Roles. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-roles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListRolesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **forSubadmin** | **string** | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. | + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *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, created, modified** | + **forSegmentIds** | **string** | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. | + **includeUnsegmented** | **bool** | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. | [default to true] + +### Return type + +[**[]Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `requestable 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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.ListRoles(context.Background()).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.ListRoles(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.ListRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListRoles`: []Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.ListRoles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-role +Patch a specified Role +This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: + +* name +* description +* enabled +* owner +* accessProfiles +* entitlements +* membership +* requestable +* accessRequestConfig +* revokeRequestConfig +* segments +* accessModelMetadata +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Role to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role to patch # string | ID of the Role to patch + jsonpatchoperation := []byte(`[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.PatchRole(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.PatchRole(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.PatchRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.PatchRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-roles-by-filter +Filter Roles by Metadata +This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-roles-by-filter) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchRolesByFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **forSubadmin** | **string** | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. | + **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 50] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, created, modified** | + **forSegmentIds** | **string** | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. | + **includeUnsegmented** | **bool** | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. | [default to true] + **roleListFilterDTO** | [**RoleListFilterDTO**](../models/role-list-filter-dto) | | + +### Return type + +**Role** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit := 50 // 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 50) # 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 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) + rolelistfilterdto := []byte(`{ + "ammKeyValues" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "secret" ] + } ], + "filters" : "dimensional eq false" + }`) // RoleListFilterDTO | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.SearchRolesByFilter(context.Background()).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.SearchRolesByFilter(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).RoleListFilterDTO(roleListFilterDTO).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.SearchRolesByFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchRolesByFilter`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.SearchRolesByFilter`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-attribute-key-and-value-to-role +Add a Metadata to Role. +This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-attribute-key-and-value-to-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Id of a role | +**attributeKey** | **string** | Technical name of the Attribute. | +**attributeValue** | **string** | Technical name of the Attribute Value. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateAttributeKeyAndValueToRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c24359c389374d0fb8585698a2189e3d` // string | The Id of a role # string | The Id of a role + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.UpdateAttributeKeyAndValueToRole(context.Background(), id, attributeKey, attributeValue).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.UpdateAttributeKeyAndValueToRole(context.Background(), id, attributeKey, attributeValue).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.UpdateAttributeKeyAndValueToRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAttributeKeyAndValueToRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.UpdateAttributeKeyAndValueToRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-roles-metadata-by-filter +Bulk-Update Roles' Metadata by Filters +This API initiates a bulk update of metadata for one or more Roles by filter. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +The maximum metadata value count for a single role is 25. +Custom metadata update, including add, replace need suit licensed. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-roles-metadata-by-filter) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateRolesMetadataByFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **roleMetadataBulkUpdateByFilterRequest** | [**RoleMetadataBulkUpdateByFilterRequest**](../models/role-metadata-bulk-update-by-filter-request) | | + +### Return type + +[**RoleBulkUpdateResponse**](../models/role-bulk-update-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + rolemetadatabulkupdatebyfilterrequest := []byte(`{ + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "filters" : " requestable eq false", + "replaceScope" : "ALL", + "operation" : "REPLACE" + }`) // RoleMetadataBulkUpdateByFilterRequest | + + + var roleMetadataBulkUpdateByFilterRequest v2024.RoleMetadataBulkUpdateByFilterRequest + if err := json.Unmarshal(rolemetadatabulkupdatebyfilterrequest, &roleMetadataBulkUpdateByFilterRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.UpdateRolesMetadataByFilter(context.Background()).RoleMetadataBulkUpdateByFilterRequest(roleMetadataBulkUpdateByFilterRequest).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.UpdateRolesMetadataByFilter(context.Background()).RoleMetadataBulkUpdateByFilterRequest(roleMetadataBulkUpdateByFilterRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.UpdateRolesMetadataByFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRolesMetadataByFilter`: RoleBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.UpdateRolesMetadataByFilter`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-roles-metadata-by-ids +Bulk-Update Roles' Metadata by ID +This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. +Custom metadata update, including add, replace need suit licensed. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-roles-metadata-by-ids) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateRolesMetadataByIdsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **roleMetadataBulkUpdateByIdRequest** | [**RoleMetadataBulkUpdateByIdRequest**](../models/role-metadata-bulk-update-by-id-request) | | + +### Return type + +[**RoleBulkUpdateResponse**](../models/role-bulk-update-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + rolemetadatabulkupdatebyidrequest := []byte(`{ + "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + }`) // RoleMetadataBulkUpdateByIdRequest | + + + var roleMetadataBulkUpdateByIdRequest v2024.RoleMetadataBulkUpdateByIdRequest + if err := json.Unmarshal(rolemetadatabulkupdatebyidrequest, &roleMetadataBulkUpdateByIdRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.UpdateRolesMetadataByIds(context.Background()).RoleMetadataBulkUpdateByIdRequest(roleMetadataBulkUpdateByIdRequest).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.UpdateRolesMetadataByIds(context.Background()).RoleMetadataBulkUpdateByIdRequest(roleMetadataBulkUpdateByIdRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.UpdateRolesMetadataByIds``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRolesMetadataByIds`: RoleBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.UpdateRolesMetadataByIds`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-roles-metadata-by-query +Bulk-Update Roles' Metadata by Query +This API initiates a bulk update of metadata for one or more Roles by query. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +The maximum metadata value count for a single role is 25. +Custom metadata update, including add, replace need suit licensed. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-roles-metadata-by-query) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateRolesMetadataByQueryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **roleMetadataBulkUpdateByQueryRequest** | [**RoleMetadataBulkUpdateByQueryRequest**](../models/role-metadata-bulk-update-by-query-request) | | + +### Return type + +[**RoleBulkUpdateResponse**](../models/role-bulk-update-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + rolemetadatabulkupdatebyqueryrequest := []byte(`{ + "query" : { + "query\"" : { + "indices" : [ "roles" ], + "queryType" : "TEXT", + "textQuery" : { + "terms" : [ "test123" ], + "fields" : [ "id" ], + "matchAny" : false, + "contains" : true + }, + "includeNested" : false + } + }, + "values" : [ { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + }, { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + }`) // RoleMetadataBulkUpdateByQueryRequest | + + + var roleMetadataBulkUpdateByQueryRequest v2024.RoleMetadataBulkUpdateByQueryRequest + if err := json.Unmarshal(rolemetadatabulkupdatebyqueryrequest, &roleMetadataBulkUpdateByQueryRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.UpdateRolesMetadataByQuery(context.Background()).RoleMetadataBulkUpdateByQueryRequest(roleMetadataBulkUpdateByQueryRequest).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.UpdateRolesMetadataByQuery(context.Background()).RoleMetadataBulkUpdateByQueryRequest(roleMetadataBulkUpdateByQueryRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.UpdateRolesMetadataByQuery``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRolesMetadataByQuery`: RoleBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.UpdateRolesMetadataByQuery`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SIMIntegrationsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SIMIntegrationsAPI.md new file mode 100644 index 000000000..a3501afe4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SIMIntegrationsAPI.md @@ -0,0 +1,658 @@ +--- +id: v2024-sim-integrations +title: SIMIntegrations +pagination_label: SIMIntegrations +sidebar_label: SIMIntegrations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SIMIntegrations', 'V2024SIMIntegrations'] +slug: /tools/sdk/go/v2024/methods/sim-integrations +tags: ['SDK', 'Software Development Kit', 'SIMIntegrations', 'V2024SIMIntegrations'] +--- + +# SIMIntegrationsAPI + Use this API to administer IdentityNow's Service Integration Module, or SIM integration with ServiceNow, so that it converts IdentityNow provisioning actions into tickets in ServiceNow. + +ServiceNow is a software platform that supports IT service management and automates common business processes for requesting and fulfilling service requests across a business enterprise. + +You must have an IdentityNow ServiceNow ServiceDesk license to use this integration. Contact your Customer Success Manager for more information. + +Service Desk integration for IdentityNow and in deprecation - not available for new implementation, as of July 21st, 2021. As per SailPoint’s [support policy](https://community.sailpoint.com/t5/Connector-Directory/SailPoint-Support-Policy-for-Connectivity/ta-p/79422), all existing SailPoint IdentityNow customers using this legacy integration will be supported until July 2022. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-sim-integration**](#create-sim-integration) | **Post** `/sim-integrations` | Create new SIM integration +[**delete-sim-integration**](#delete-sim-integration) | **Delete** `/sim-integrations/{id}` | Delete a SIM integration +[**get-sim-integration**](#get-sim-integration) | **Get** `/sim-integrations/{id}` | Get a SIM integration details. +[**get-sim-integrations**](#get-sim-integrations) | **Get** `/sim-integrations` | List the existing SIM integrations. +[**patch-before-provisioning-rule**](#patch-before-provisioning-rule) | **Patch** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a SIM beforeProvisioningRule attribute. +[**patch-sim-attributes**](#patch-sim-attributes) | **Patch** `/sim-integrations/{id}` | Patch a SIM attribute. +[**put-sim-integration**](#put-sim-integration) | **Put** `/sim-integrations/{id}` | Update an existing SIM integration + + +## create-sim-integration +:::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 new SIM integration +Create a new SIM Integrations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-sim-integration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSIMIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **simIntegrationDetails** | [**SimIntegrationDetails**](../models/sim-integration-details) | DTO containing the details of the SIM integration | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + simintegrationdetails := []byte(`{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }`) // SimIntegrationDetails | DTO containing the details of the SIM integration + + + var simIntegrationDetails v2024.SimIntegrationDetails + if err := json.Unmarshal(simintegrationdetails, &simIntegrationDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SIMIntegrationsAPI.CreateSIMIntegration(context.Background()).XSailPointExperimental(xSailPointExperimental).SimIntegrationDetails(simIntegrationDetails).Execute() + //resp, r, err := apiClient.V2024.SIMIntegrationsAPI.CreateSIMIntegration(context.Background()).XSailPointExperimental(xSailPointExperimental).SimIntegrationDetails(simIntegrationDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.CreateSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.CreateSIMIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-sim-integration +:::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 a SIM integration +Get the details of a SIM integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-sim-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the integration to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSIMIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `12345` // string | The id of the integration to delete. # string | The id of the integration to delete. + 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.SIMIntegrationsAPI.DeleteSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.SIMIntegrationsAPI.DeleteSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.DeleteSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-sim-integration +:::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 a SIM integration details. +Get the details of a SIM integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sim-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the integration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSIMIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `12345` // string | The id of the integration. # string | The id of the integration. + 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.SIMIntegrationsAPI.GetSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.SIMIntegrationsAPI.GetSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.GetSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.GetSIMIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sim-integrations +:::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 the existing SIM integrations. +List the existing SIM integrations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sim-integrations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSIMIntegrationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**[]ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SIMIntegrationsAPI.GetSIMIntegrations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.SIMIntegrationsAPI.GetSIMIntegrations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.GetSIMIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSIMIntegrations`: []ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.GetSIMIntegrations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-before-provisioning-rule +:::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 + ``` +::: +Patch a SIM beforeProvisioningRule attribute. +Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-before-provisioning-rule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | SIM integration id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchBeforeProvisioningRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatch** | [**JsonPatch**](../models/json-patch) | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `12345` // string | SIM integration id # string | SIM integration 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") + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + + + var jsonPatch v2024.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SIMIntegrationsAPI.PatchBeforeProvisioningRule(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2024.SIMIntegrationsAPI.PatchBeforeProvisioningRule(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PatchBeforeProvisioningRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchBeforeProvisioningRule`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PatchBeforeProvisioningRule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-sim-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 + ``` +::: +Patch a SIM attribute. +Patch a SIM attribute given a JsonPatch object. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sim-attributes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | SIM integration id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSIMAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatch** | [**JsonPatch**](../models/json-patch) | The JsonPatch object that describes the changes of SIM | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `12345` // string | SIM integration id # string | SIM integration 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") + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | The JsonPatch object that describes the changes of SIM + + + var jsonPatch v2024.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SIMIntegrationsAPI.PatchSIMAttributes(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2024.SIMIntegrationsAPI.PatchSIMAttributes(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PatchSIMAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSIMAttributes`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PatchSIMAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-sim-integration +:::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 an existing SIM integration +Update an existing SIM integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-sim-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the integration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSIMIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **simIntegrationDetails** | [**SimIntegrationDetails**](../models/sim-integration-details) | The full DTO of the integration containing the updated model | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `12345` // string | The id of the integration. # string | The id of the integration. + 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") + simintegrationdetails := []byte(`{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }`) // SimIntegrationDetails | The full DTO of the integration containing the updated model + + + var simIntegrationDetails v2024.SimIntegrationDetails + if err := json.Unmarshal(simintegrationdetails, &simIntegrationDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SIMIntegrationsAPI.PutSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SimIntegrationDetails(simIntegrationDetails).Execute() + //resp, r, err := apiClient.V2024.SIMIntegrationsAPI.PutSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SimIntegrationDetails(simIntegrationDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PutSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PutSIMIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SODPoliciesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SODPoliciesAPI.md new file mode 100644 index 000000000..22853fc4f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SODPoliciesAPI.md @@ -0,0 +1,1406 @@ +--- +id: v2024-sod-policies +title: SODPolicies +pagination_label: SODPolicies +sidebar_label: SODPolicies +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SODPolicies', 'V2024SODPolicies'] +slug: /tools/sdk/go/v2024/methods/sod-policies +tags: ['SDK', 'Software Development Kit', 'SODPolicies', 'V2024SODPolicies'] +--- + +# SODPoliciesAPI + Use this API to implement and manage "separation of duties" (SOD) policies. +With SOD policy functionality in place, administrators can organize the access in their tenants to prevent individuals from gaining conflicting or excessive access. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +To create SOD policies in Identity Security Cloud, administrators use 'Search' and then access 'Policies'. +To create a policy, they must configure two lists of access items. Each access item can only be added to one of the two lists. +They can search for the entitlements they want to add to these access lists. + +>Note: You can have a maximum of 500 policies of any type (including general policies) in your organization. In each access-based SOD policy, you can have a maximum of 50 entitlements in each access list. + +Once a SOD policy is in place, if an identity has access items on both lists, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +To create a subscription to a SOD policy in Identity Security Cloud, administrators use 'Search' and then access 'Layers'. +They can create a subscription to the policy and schedule it to run at a regular interval. + +Refer to [Managing Policies](https://documentation.sailpoint.com/saas/help/sod/manage-policies.html) for more information about SOD policies. + +Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-sod-policy**](#create-sod-policy) | **Post** `/sod-policies` | Create SOD policy +[**delete-sod-policy**](#delete-sod-policy) | **Delete** `/sod-policies/{id}` | Delete SOD policy by ID +[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **Delete** `/sod-policies/{id}/schedule` | Delete SOD policy schedule +[**get-custom-violation-report**](#get-custom-violation-report) | **Get** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report +[**get-default-violation-report**](#get-default-violation-report) | **Get** `/sod-violation-report/{reportResultId}/download` | Download violation report +[**get-sod-all-report-run-status**](#get-sod-all-report-run-status) | **Get** `/sod-violation-report` | Get multi-report run task status +[**get-sod-policy**](#get-sod-policy) | **Get** `/sod-policies/{id}` | Get SOD policy by ID +[**get-sod-policy-schedule**](#get-sod-policy-schedule) | **Get** `/sod-policies/{id}/schedule` | Get SOD policy schedule +[**get-sod-violation-report-run-status**](#get-sod-violation-report-run-status) | **Get** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status +[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **Get** `/sod-policies/{id}/violation-report` | Get SOD violation report status +[**list-sod-policies**](#list-sod-policies) | **Get** `/sod-policies` | List SOD policies +[**patch-sod-policy**](#patch-sod-policy) | **Patch** `/sod-policies/{id}` | Patch SOD policy by ID +[**put-policy-schedule**](#put-policy-schedule) | **Put** `/sod-policies/{id}/schedule` | Update SOD Policy schedule +[**put-sod-policy**](#put-sod-policy) | **Put** `/sod-policies/{id}` | Update SOD policy by ID +[**start-evaluate-sod-policy**](#start-evaluate-sod-policy) | **Post** `/sod-policies/{id}/evaluate` | Evaluate one policy by ID +[**start-sod-all-policies-for-org**](#start-sod-all-policies-for-org) | **Post** `/sod-violation-report/run` | Runs all policies for org +[**start-sod-policy**](#start-sod-policy) | **Post** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report + + +## create-sod-policy +Create SOD policy +This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-sod-policy) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sodPolicy** | [**SodPolicy**](../models/sod-policy) | | + +### Return type + +[**SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sodpolicy := []byte(`{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }`) // SodPolicy | + + + var sodPolicy v2024.SodPolicy + if err := json.Unmarshal(sodpolicy, &sodPolicy); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.CreateSodPolicy(context.Background()).SodPolicy(sodPolicy).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.CreateSodPolicy(context.Background()).SodPolicy(sodPolicy).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.CreateSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.CreateSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-sod-policy +Delete SOD policy by ID +This deletes a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD Policy to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **logical** | **bool** | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. | [default to true] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD Policy to delete. # string | The ID of the SOD Policy to delete. + logical := true // bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to true) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SODPoliciesAPI.DeleteSodPolicy(context.Background(), id).Execute() + //r, err := apiClient.V2024.SODPoliciesAPI.DeleteSodPolicy(context.Background(), id).Logical(logical).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.DeleteSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-sod-policy-schedule +Delete SOD policy schedule +This deletes schedule for a specified SOD policy by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-sod-policy-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy the schedule must be deleted for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSodPolicyScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy the schedule must be deleted for. # string | The ID of the SOD policy the schedule must be deleted for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SODPoliciesAPI.DeleteSodPolicySchedule(context.Background(), id).Execute() + //r, err := apiClient.V2024.SODPoliciesAPI.DeleteSodPolicySchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.DeleteSodPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-custom-violation-report +Download custom violation report +This allows to download a specified named violation report for a given report reference. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-custom-violation-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**reportResultId** | **string** | The ID of the report reference to download. | +**fileName** | **string** | Custom Name for the file. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCustomViolationReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reportResultId := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the report reference to download. # string | The ID of the report reference to download. + fileName := `custom-name` // string | Custom Name for the file. # string | Custom Name for the file. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.GetCustomViolationReport(context.Background(), reportResultId, fileName).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.GetCustomViolationReport(context.Background(), reportResultId, fileName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetCustomViolationReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCustomViolationReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetCustomViolationReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-default-violation-report +Download violation report +This allows to download a violation report for a given report reference. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-default-violation-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**reportResultId** | **string** | The ID of the report reference to download. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDefaultViolationReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reportResultId := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the report reference to download. # string | The ID of the report reference to download. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.GetDefaultViolationReport(context.Background(), reportResultId).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.GetDefaultViolationReport(context.Background(), reportResultId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetDefaultViolationReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDefaultViolationReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetDefaultViolationReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-all-report-run-status +Get multi-report run task status +This endpoint gets the status for a violation report for all policy run. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-all-report-run-status) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodAllReportRunStatusRequest struct via the builder pattern + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodAllReportRunStatus(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodAllReportRunStatus(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodAllReportRunStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodAllReportRunStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodAllReportRunStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-policy +Get SOD policy by ID +This gets specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD Policy to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD Policy to retrieve. # string | The ID of the SOD Policy to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-policy-schedule +Get SOD policy schedule +This endpoint gets a specified SOD policy's schedule. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-policy-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy schedule to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodPolicyScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy schedule to retrieve. # string | The ID of the SOD policy schedule to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodPolicySchedule(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodPolicySchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodPolicySchedule`: SodPolicySchedule + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodPolicySchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-violation-report-run-status +Get violation report run status +This gets the status for a violation report run task that has already been invoked. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-violation-report-run-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**reportResultId** | **string** | The ID of the report reference to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodViolationReportRunStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reportResultId := `2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | The ID of the report reference to retrieve. # string | The ID of the report reference to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodViolationReportRunStatus(context.Background(), reportResultId).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodViolationReportRunStatus(context.Background(), reportResultId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodViolationReportRunStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodViolationReportRunStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodViolationReportRunStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-violation-report-status +Get SOD violation report status +This gets the status for a violation report run task that has already been invoked. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-violation-report-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the violation report to retrieve status for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodViolationReportStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the violation report to retrieve status for. # string | The ID of the violation report to retrieve status for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodViolationReportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodViolationReportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodViolationReportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodViolationReportStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodViolationReportStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-sod-policies +List SOD policies +This gets list of all SOD policies. +Requires role of ORG_ADMIN + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sod-policies) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSodPoliciesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, in* **state**: *eq, in* | + **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: **id, name, created, modified, description** | + +### Return type + +[**[]SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "bc693f07e7b645539626c25954c58554"` // 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, in* **state**: *eq, in* (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, in* **state**: *eq, in* (optional) + sorters := `id,name` // 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: **id, name, created, modified, description** (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: **id, name, created, modified, description** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.ListSodPolicies(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.ListSodPolicies(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.ListSodPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSodPolicies`: []SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.ListSodPolicies`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-sod-policy +Patch SOD policy by ID +Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Requires role of ORG_ADMIN. +This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy being modified. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria | + +### Return type + +[**SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c918083-5d19-1a86-015d-28455b4a2329` // string | The ID of the SOD policy being modified. # string | The ID of the SOD policy being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]`) // []JsonPatchOperation | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.PatchSodPolicy(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.PatchSodPolicy(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PatchSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PatchSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-policy-schedule +Update SOD Policy schedule +This updates schedule for a specified SOD policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-policy-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy to update its schedule. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutPolicyScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **sodPolicySchedule** | [**SodPolicySchedule**](../models/sod-policy-schedule) | | + +### Return type + +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy to update its schedule. # string | The ID of the SOD policy to update its schedule. + sodpolicyschedule := []byte(`{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }`) // SodPolicySchedule | + + + var sodPolicySchedule v2024.SodPolicySchedule + if err := json.Unmarshal(sodpolicyschedule, &sodPolicySchedule); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.PutPolicySchedule(context.Background(), id).SodPolicySchedule(sodPolicySchedule).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.PutPolicySchedule(context.Background(), id).SodPolicySchedule(sodPolicySchedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PutPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutPolicySchedule`: SodPolicySchedule + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PutPolicySchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-sod-policy +Update SOD policy by ID +This updates a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **sodPolicy** | [**SodPolicy**](../models/sod-policy) | | + +### Return type + +[**SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy to update. # string | The ID of the SOD policy to update. + sodpolicy := []byte(`{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }`) // SodPolicy | + + + var sodPolicy v2024.SodPolicy + if err := json.Unmarshal(sodpolicy, &sodPolicy); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.PutSodPolicy(context.Background(), id).SodPolicy(sodPolicy).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.PutSodPolicy(context.Background(), id).SodPolicy(sodPolicy).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PutSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PutSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-evaluate-sod-policy +Evaluate one policy by ID +Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-evaluate-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The SOD policy ID to run. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartEvaluateSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The SOD policy ID to run. # string | The SOD policy ID to run. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.StartEvaluateSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.StartEvaluateSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartEvaluateSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartEvaluateSodPolicy`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartEvaluateSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-sod-all-policies-for-org +Runs all policies for org +Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-sod-all-policies-for-org) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartSodAllPoliciesForOrgRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **multiPolicyRequest** | [**MultiPolicyRequest**](../models/multi-policy-request) | | + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multipolicyrequest := []byte(`{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }`) // MultiPolicyRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.StartSodAllPoliciesForOrg(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.StartSodAllPoliciesForOrg(context.Background()).MultiPolicyRequest(multiPolicyRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartSodAllPoliciesForOrg``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartSodAllPoliciesForOrg`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartSodAllPoliciesForOrg`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-sod-policy +Runs SOD policy violation report +This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The SOD policy ID to run. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The SOD policy ID to run. # string | The SOD policy ID to run. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.StartSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.StartSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartSodPolicy`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SODViolationsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SODViolationsAPI.md new file mode 100644 index 000000000..4cc87a6c0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SODViolationsAPI.md @@ -0,0 +1,186 @@ +--- +id: v2024-sod-violations +title: SODViolations +pagination_label: SODViolations +sidebar_label: SODViolations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SODViolations', 'V2024SODViolations'] +slug: /tools/sdk/go/v2024/methods/sod-violations +tags: ['SDK', 'Software Development Kit', 'SODViolations', 'V2024SODViolations'] +--- + +# SODViolationsAPI + Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations. +With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +Once a SOD policy is in place, if an identity has conflicting access items, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. +This second option is a good way to prevent SOD violations from triggering at all. + +Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**start-predict-sod-violations**](#start-predict-sod-violations) | **Post** `/sod-violations/predict` | Predict SOD violations for identity. +[**start-violation-check**](#start-violation-check) | **Post** `/sod-violations/check` | Check SOD violations + + +## start-predict-sod-violations +Predict SOD violations for identity. +This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-predict-sod-violations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartPredictSodViolationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityWithNewAccess** | [**IdentityWithNewAccess**](../models/identity-with-new-access) | | + +### Return type + +[**ViolationPrediction**](../models/violation-prediction) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identitywithnewaccess := []byte(`{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }`) // IdentityWithNewAccess | + + + var identityWithNewAccess v2024.IdentityWithNewAccess + if err := json.Unmarshal(identitywithnewaccess, &identityWithNewAccess); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODViolationsAPI.StartPredictSodViolations(context.Background()).IdentityWithNewAccess(identityWithNewAccess).Execute() + //resp, r, err := apiClient.V2024.SODViolationsAPI.StartPredictSodViolations(context.Background()).IdentityWithNewAccess(identityWithNewAccess).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODViolationsAPI.StartPredictSodViolations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartPredictSodViolations`: ViolationPrediction + fmt.Fprintf(os.Stdout, "Response from `SODViolationsAPI.StartPredictSodViolations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-violation-check +Check SOD violations +This API initiates a SOD policy verification asynchronously. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-violation-check) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartViolationCheckRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityWithNewAccess1** | [**IdentityWithNewAccess1**](../models/identity-with-new-access1) | | + +### Return type + +[**SodViolationCheck**](../models/sod-violation-check) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identitywithnewaccess1 := []byte(`{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}`) // IdentityWithNewAccess1 | + + + var identityWithNewAccess1 v2024.IdentityWithNewAccess1 + if err := json.Unmarshal(identitywithnewaccess1, &identityWithNewAccess1); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODViolationsAPI.StartViolationCheck(context.Background()).IdentityWithNewAccess1(identityWithNewAccess1).Execute() + //resp, r, err := apiClient.V2024.SODViolationsAPI.StartViolationCheck(context.Background()).IdentityWithNewAccess1(identityWithNewAccess1).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODViolationsAPI.StartViolationCheck``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartViolationCheck`: SodViolationCheck + fmt.Fprintf(os.Stdout, "Response from `SODViolationsAPI.StartViolationCheck`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SPConfigAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SPConfigAPI.md new file mode 100644 index 000000000..22b301c59 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SPConfigAPI.md @@ -0,0 +1,504 @@ +--- +id: v2024-sp-config +title: SPConfig +pagination_label: SPConfig +sidebar_label: SPConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SPConfig', 'V2024SPConfig'] +slug: /tools/sdk/go/v2024/methods/sp-config +tags: ['SDK', 'Software Development Kit', 'SPConfig', 'V2024SPConfig'] +--- + +# SPConfigAPI + Import and export configuration for some objects between tenants. +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**export-sp-config**](#export-sp-config) | **Post** `/sp-config/export` | Initiates configuration objects export job +[**get-sp-config-export**](#get-sp-config-export) | **Get** `/sp-config/export/{id}/download` | Download export job result. +[**get-sp-config-export-status**](#get-sp-config-export-status) | **Get** `/sp-config/export/{id}` | Get export job status +[**get-sp-config-import**](#get-sp-config-import) | **Get** `/sp-config/import/{id}/download` | Download import job result +[**get-sp-config-import-status**](#get-sp-config-import-status) | **Get** `/sp-config/import/{id}` | Get import job status +[**import-sp-config**](#import-sp-config) | **Post** `/sp-config/import` | Initiates configuration objects import job +[**list-sp-config-objects**](#list-sp-config-objects) | **Get** `/sp-config/config-objects` | List Config Objects + + +## export-sp-config +Initiates configuration objects export job +This post will export objects from the tenant to a JSON configuration file. +For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-sp-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportSpConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **exportPayload** | [**ExportPayload**](../models/export-payload) | Export options control what will be included in the export. | + +### Return type + +[**SpConfigExportJob**](../models/sp-config-export-job) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + exportpayload := []byte(`{ + "description" : "Export Job 1 Test" + }`) // ExportPayload | Export options control what will be included in the export. + + + var exportPayload v2024.ExportPayload + if err := json.Unmarshal(exportpayload, &exportPayload); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SPConfigAPI.ExportSpConfig(context.Background()).ExportPayload(exportPayload).Execute() + //resp, r, err := apiClient.V2024.SPConfigAPI.ExportSpConfig(context.Background()).ExportPayload(exportPayload).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ExportSpConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportSpConfig`: SpConfigExportJob + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ExportSpConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sp-config-export +Download export job result. +This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. +The request will need one of the following security scopes: +- sp:config:read - sp:config:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sp-config-export) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the export job whose results will be downloaded. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSpConfigExportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SpConfigExportResults**](../models/sp-config-export-results) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the export job whose results will be downloaded. # string | The ID of the export job whose results will be downloaded. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SPConfigAPI.GetSpConfigExport(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SPConfigAPI.GetSpConfigExport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigExport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigExport`: SpConfigExportResults + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigExport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sp-config-export-status +Get export job status +This gets the status of the export job identified by the `id` parameter. +The request will need one of the following security scopes: +- sp:config:read - sp:config:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sp-config-export-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the export job whose status will be returned. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSpConfigExportStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SpConfigExportJobStatus**](../models/sp-config-export-job-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the export job whose status will be returned. # string | The ID of the export job whose status will be returned. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SPConfigAPI.GetSpConfigExportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SPConfigAPI.GetSpConfigExportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigExportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigExportStatus`: SpConfigExportJobStatus + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigExportStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sp-config-import +Download import job result +This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. +The request will need the following security scope: +- sp:config:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sp-config-import) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the import job whose results will be downloaded. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSpConfigImportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SpConfigImportResults**](../models/sp-config-import-results) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the import job whose results will be downloaded. # string | The ID of the import job whose results will be downloaded. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SPConfigAPI.GetSpConfigImport(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SPConfigAPI.GetSpConfigImport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigImport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigImport`: SpConfigImportResults + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigImport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sp-config-import-status +Get import job status +'This gets the status of the import job identified by the `id` parameter. + + For more information about the object types that currently support import functionality, + refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).' + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sp-config-import-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the import job whose status will be returned. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSpConfigImportStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SpConfigImportJobStatus**](../models/sp-config-import-job-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the import job whose status will be returned. # string | The ID of the import job whose status will be returned. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SPConfigAPI.GetSpConfigImportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SPConfigAPI.GetSpConfigImportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigImportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigImportStatus`: SpConfigImportJobStatus + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigImportStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-sp-config +Initiates configuration objects import job +This post will import objects from a JSON configuration file into a tenant. +By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. +The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. +The backup can be skipped by setting "excludeBackup" to true in the import options. +If a backup is performed, the id of the backup will be provided in the ImportResult as the "exportJobId". This can be downloaded +using the `/sp-config/export/{exportJobId}/download` endpoint. + +You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. + +For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-sp-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportSpConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **data** | ***os.File** | JSON file containing the objects to be imported. | + **preview** | **bool** | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. | [default to false] + **options** | [**ImportOptions**](../models/import-options) | | + +### Return type + +[**SpConfigJob**](../models/sp-config-job) + +### 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() { + data := BINARY_DATA_HERE // *os.File | JSON file containing the objects to be imported. # *os.File | JSON file containing the objects to be imported. + preview := true // bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to false) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to false) + options := []byte(``) // ImportOptions | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SPConfigAPI.ImportSpConfig(context.Background()).Data(data).Execute() + //resp, r, err := apiClient.V2024.SPConfigAPI.ImportSpConfig(context.Background()).Data(data).Preview(preview).Options(options).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ImportSpConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportSpConfig`: SpConfigJob + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ImportSpConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-sp-config-objects +List Config Objects +Get a list of object configurations that the tenant export/import service knows. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sp-config-objects) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSpConfigObjectsRequest struct via the builder pattern + + +### Return type + +[**[]SpConfigObject**](../models/sp-config-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SPConfigAPI.ListSpConfigObjects(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SPConfigAPI.ListSpConfigObjects(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ListSpConfigObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSpConfigObjects`: []SpConfigObject + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ListSpConfigObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SavedSearchAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SavedSearchAPI.md new file mode 100644 index 000000000..a768c53a0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SavedSearchAPI.md @@ -0,0 +1,509 @@ +--- +id: v2024-saved-search +title: SavedSearch +pagination_label: SavedSearch +sidebar_label: SavedSearch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearch', 'V2024SavedSearch'] +slug: /tools/sdk/go/v2024/methods/saved-search +tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'V2024SavedSearch'] +--- + +# SavedSearchAPI + Use this API to implement saved search functionality. +With saved search functionality in place, users can save search queries and then view those saved searches, as well as rerun them. + +Search queries in Identity Security Cloud can grow very long and specific, which can make reconstructing them difficult or tedious, so it can be especially helpful to save search queries. +It also opens the possibility to configure Identity Security Cloud to run the saved queries on a schedule, which is essential to detecting user information and access changes throughout an organization's tenant and across all its sources. +Refer to [Scheduled Search](https://developer.sailpoint.com/docs/api/v2024/scheduled-search/) for more information about running saved searches on a schedule. + +In Identity Security Cloud, users can save searches under a name, and then they can access that saved search and run it again when they want. + +Refer to [Managing Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html) for more information about saving searches and using them. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-saved-search**](#create-saved-search) | **Post** `/saved-searches` | Create a saved search +[**delete-saved-search**](#delete-saved-search) | **Delete** `/saved-searches/{id}` | Delete document by ID +[**execute-saved-search**](#execute-saved-search) | **Post** `/saved-searches/{id}/execute` | Execute a saved search by ID +[**get-saved-search**](#get-saved-search) | **Get** `/saved-searches/{id}` | Return saved search by ID +[**list-saved-searches**](#list-saved-searches) | **Get** `/saved-searches` | A list of Saved Searches +[**put-saved-search**](#put-saved-search) | **Put** `/saved-searches/{id}` | Updates an existing saved search + + +## create-saved-search +Create a saved search +Creates a new saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-saved-search) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSavedSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createSavedSearchRequest** | [**CreateSavedSearchRequest**](../models/create-saved-search-request) | The saved search to persist. | + +### Return type + +[**SavedSearch**](../models/saved-search) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createsavedsearchrequest := []byte(``) // CreateSavedSearchRequest | The saved search to persist. + + + var createSavedSearchRequest v2024.CreateSavedSearchRequest + if err := json.Unmarshal(createsavedsearchrequest, &createSavedSearchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SavedSearchAPI.CreateSavedSearch(context.Background()).CreateSavedSearchRequest(createSavedSearchRequest).Execute() + //resp, r, err := apiClient.V2024.SavedSearchAPI.CreateSavedSearch(context.Background()).CreateSavedSearchRequest(createSavedSearchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.CreateSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.CreateSavedSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-saved-search +Delete document by ID +Deletes the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-saved-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSavedSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SavedSearchAPI.DeleteSavedSearch(context.Background(), id).Execute() + //r, err := apiClient.V2024.SavedSearchAPI.DeleteSavedSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.DeleteSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## execute-saved-search +Execute a saved search by ID +Executes the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/execute-saved-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExecuteSavedSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **searchArguments** | [**SearchArguments**](../models/search-arguments) | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + searcharguments := []byte(`{ + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + }`) // SearchArguments | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + + + var searchArguments v2024.SearchArguments + if err := json.Unmarshal(searcharguments, &searchArguments); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SavedSearchAPI.ExecuteSavedSearch(context.Background(), id).SearchArguments(searchArguments).Execute() + //r, err := apiClient.V2024.SavedSearchAPI.ExecuteSavedSearch(context.Background(), id).SearchArguments(searchArguments).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.ExecuteSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-saved-search +Return saved search by ID +Returns the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-saved-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSavedSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SavedSearch**](../models/saved-search) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SavedSearchAPI.GetSavedSearch(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SavedSearchAPI.GetSavedSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.GetSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.GetSavedSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-saved-searches +A list of Saved Searches +Returns a list of saved searches. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-saved-searches) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSavedSearchesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **owner.id**: *eq* | + +### Return type + +[**[]SavedSearch**](../models/saved-search) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"` // 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: **owner.id**: *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: **owner.id**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SavedSearchAPI.ListSavedSearches(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SavedSearchAPI.ListSavedSearches(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.ListSavedSearches``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSavedSearches`: []SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.ListSavedSearches`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-saved-search +Updates an existing saved search +Updates an existing saved search. + +>**NOTE: You cannot update the `owner` of the saved search.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-saved-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSavedSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **savedSearch** | [**SavedSearch**](../models/saved-search) | The saved search to persist. | + +### Return type + +[**SavedSearch**](../models/saved-search) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + savedsearch := []byte(`{ + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + }`) // SavedSearch | The saved search to persist. + + + var savedSearch v2024.SavedSearch + if err := json.Unmarshal(savedsearch, &savedSearch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SavedSearchAPI.PutSavedSearch(context.Background(), id).SavedSearch(savedSearch).Execute() + //resp, r, err := apiClient.V2024.SavedSearchAPI.PutSavedSearch(context.Background(), id).SavedSearch(savedSearch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.PutSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.PutSavedSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ScheduledSearchAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ScheduledSearchAPI.md new file mode 100644 index 000000000..fa5c1cecd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ScheduledSearchAPI.md @@ -0,0 +1,561 @@ +--- +id: v2024-scheduled-search +title: ScheduledSearch +pagination_label: ScheduledSearch +sidebar_label: ScheduledSearch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledSearch', 'V2024ScheduledSearch'] +slug: /tools/sdk/go/v2024/methods/scheduled-search +tags: ['SDK', 'Software Development Kit', 'ScheduledSearch', 'V2024ScheduledSearch'] +--- + +# ScheduledSearchAPI + Use this API to implement scheduled search functionality. +With scheduled search functionality in place, users can run saved search queries on their tenants on a schedule, and Identity Security Cloud emails them the search results. +Users can also share these search results with other users by email by adding those users as subscribers, or those users can subscribe themselves. + +One of the greatest benefits of saving searches is the ability to run those searches on a schedule. +This is essential for organizations to constantly detect any changes to user information or access throughout their tenants and across all their sources. +For example, the manager Amanda Ross can schedule a saved search "manager.name:amanda.ross AND attributes.location:austin" on a schedule to regularly stay aware of changes with the Austin employees reporting to her. +Identity Security Cloud emails her the search results when the search runs, so she can work on other tasks instead of actively running this search. + +In Identity Security Cloud, scheduling a search involves a subscription. +Users can create a subscription for a saved search and schedule it to run daily, weekly, or monthly (you can only use one schedule option at a time). +The user can add other identities as subscribers so when the scheduled search runs, the subscribers and the user all receive emails. + +By default, subscriptions exclude detailed results from the emails, for security purposes. +Including detailed results about user access in an email may expose sensitive information. +However, the subscription creator can choose to include the information in the emails. + +By default, Identity Security Cloud sends emails to the subscribers even when the searches do not return new results. +However, the subscription creator can choose to suppress these empty emails. + +Users can also subscribe to saved searches that already have existing subscriptions so they receive emails when the searches run. +A saved search can have up to 10 subscriptions configured at a time. + +The subscription creator can enable, disable, or delete the subscription. + +Refer to [Subscribing to Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html#subscribing-to-saved-searches) for more information about scheduling searches and subscribing to them. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-scheduled-search**](#create-scheduled-search) | **Post** `/scheduled-searches` | Create a new scheduled search +[**delete-scheduled-search**](#delete-scheduled-search) | **Delete** `/scheduled-searches/{id}` | Delete a Scheduled Search +[**get-scheduled-search**](#get-scheduled-search) | **Get** `/scheduled-searches/{id}` | Get a Scheduled Search +[**list-scheduled-search**](#list-scheduled-search) | **Get** `/scheduled-searches` | List scheduled searches +[**unsubscribe-scheduled-search**](#unsubscribe-scheduled-search) | **Post** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search +[**update-scheduled-search**](#update-scheduled-search) | **Put** `/scheduled-searches/{id}` | Update an existing Scheduled Search + + +## create-scheduled-search +Create a new scheduled search +Creates a new scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-scheduled-search) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createScheduledSearchRequest** | [**CreateScheduledSearchRequest**](../models/create-scheduled-search-request) | The scheduled search to persist. | + +### Return type + +[**ScheduledSearch**](../models/scheduled-search) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createscheduledsearchrequest := []byte(`{savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]}`) // CreateScheduledSearchRequest | The scheduled search to persist. + + + var createScheduledSearchRequest v2024.CreateScheduledSearchRequest + if err := json.Unmarshal(createscheduledsearchrequest, &createScheduledSearchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ScheduledSearchAPI.CreateScheduledSearch(context.Background()).CreateScheduledSearchRequest(createScheduledSearchRequest).Execute() + //resp, r, err := apiClient.V2024.ScheduledSearchAPI.CreateScheduledSearch(context.Background()).CreateScheduledSearchRequest(createScheduledSearchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.CreateScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.CreateScheduledSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-scheduled-search +Delete a Scheduled Search +Deletes the specified scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-scheduled-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ScheduledSearchAPI.DeleteScheduledSearch(context.Background(), id).Execute() + //r, err := apiClient.V2024.ScheduledSearchAPI.DeleteScheduledSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.DeleteScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-scheduled-search +Get a Scheduled Search +Returns the specified scheduled search. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-scheduled-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ScheduledSearch**](../models/scheduled-search) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ScheduledSearchAPI.GetScheduledSearch(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ScheduledSearchAPI.GetScheduledSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.GetScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.GetScheduledSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-scheduled-search +List scheduled searches +Returns a list of scheduled searches. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-scheduled-search) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **owner.id**: *eq* **savedSearchId**: *eq* | + +### Return type + +[**[]ScheduledSearch**](../models/scheduled-search) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"` // 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: **owner.id**: *eq* **savedSearchId**: *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: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ScheduledSearchAPI.ListScheduledSearch(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ScheduledSearchAPI.ListScheduledSearch(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.ListScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListScheduledSearch`: []ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.ListScheduledSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## unsubscribe-scheduled-search +Unsubscribe a recipient from Scheduled Search +Unsubscribes a recipient from the specified scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/unsubscribe-scheduled-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUnsubscribeScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **typedReference** | [**TypedReference**](../models/typed-reference) | The recipient to be removed from the scheduled search. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + typedreference := []byte(`{ + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }`) // TypedReference | The recipient to be removed from the scheduled search. + + + var typedReference v2024.TypedReference + if err := json.Unmarshal(typedreference, &typedReference); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ScheduledSearchAPI.UnsubscribeScheduledSearch(context.Background(), id).TypedReference(typedReference).Execute() + //r, err := apiClient.V2024.ScheduledSearchAPI.UnsubscribeScheduledSearch(context.Background(), id).TypedReference(typedReference).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.UnsubscribeScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## update-scheduled-search +Update an existing Scheduled Search +Updates an existing scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-scheduled-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **scheduledSearch** | [**ScheduledSearch**](../models/scheduled-search) | The scheduled search to persist. | + +### Return type + +[**ScheduledSearch**](../models/scheduled-search) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + scheduledsearch := []byte(`{ + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false + }`) // ScheduledSearch | The scheduled search to persist. + + + var scheduledSearch v2024.ScheduledSearch + if err := json.Unmarshal(scheduledsearch, &scheduledSearch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ScheduledSearchAPI.UpdateScheduledSearch(context.Background(), id).ScheduledSearch(scheduledSearch).Execute() + //resp, r, err := apiClient.V2024.ScheduledSearchAPI.UpdateScheduledSearch(context.Background(), id).ScheduledSearch(scheduledSearch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.UpdateScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.UpdateScheduledSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SearchAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SearchAPI.md new file mode 100644 index 000000000..0e86d09f7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SearchAPI.md @@ -0,0 +1,677 @@ +--- +id: v2024-search +title: Search +pagination_label: Search +sidebar_label: Search +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Search', 'V2024Search'] +slug: /tools/sdk/go/v2024/methods/search +tags: ['SDK', 'Software Development Kit', 'Search', 'V2024Search'] +--- + +# SearchAPI + Use this API to implement search functionality. +With search functionality in place, users can search their tenants for nearly any information from throughout their organizations. + +Identity Security Cloud enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using Identity Security Cloud's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about Identity Security Cloud's search and its different possibilities. + +The search feature uses Elasticsearch as a datastore and query engine. +The power of Elasticsearch makes this feature suitable for ad-hoc reporting. +However, data from the operational databases (ex. identities, roles, events, etc) has to be ingested into Elasticsearch. +This ingestion process introduces a latency from when the operational data is created to when it is available in search. +Depending on the system load, this can take a few seconds to a few minutes. +Please keep this latency in mind when you use search. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**search-aggregate**](#search-aggregate) | **Post** `/search/aggregate` | Perform a Search Query Aggregation +[**search-count**](#search-count) | **Post** `/search/count` | Count Documents Satisfying a Query +[**search-get**](#search-get) | **Get** `/search/{index}/{id}` | Get a Document by ID +[**search-post**](#search-post) | **Post** `/search` | Perform Search + + +## search-aggregate +Perform a Search Query Aggregation +Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-aggregate) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchAggregateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search** | [**Search**](../models/search) | | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**AggregationResult**](../models/aggregation-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json, text/csv + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + var search v2024.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SearchAPI.SearchAggregate(context.Background()).Search(search).Execute() + //resp, r, err := apiClient.V2024.SearchAPI.SearchAggregate(context.Background()).Search(search).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchAggregate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchAggregate`: AggregationResult + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchAggregate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-count +Count Documents Satisfying a Query +Performs a search with a provided query and returns the count of results in the X-Total-Count header. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-count) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchCountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search** | [**Search**](../models/search) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + + + var search v2024.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SearchAPI.SearchCount(context.Background()).Search(search).Execute() + //r, err := apiClient.V2024.SearchAPI.SearchCount(context.Background()).Search(search).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchCount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## search-get +Get a Document by ID +Fetches a single document from the specified index, using the specified document ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-get) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**index** | **string** | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. | +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchGetRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + index := `identities` // string | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. # string | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SearchAPI.SearchGet(context.Background(), index, id).Execute() + //resp, r, err := apiClient.V2024.SearchAPI.SearchGet(context.Background(), index, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchGet``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchGet`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchGet`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-post +Perform Search +Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-post) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchPostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search** | [**Search**](../models/search) | | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +**[]map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + 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) + limit := 10000 // 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + var search v2024.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SearchAPI.SearchPost(context.Background()).Search(search).Execute() + //resp, r, err := apiClient.V2024.SearchAPI.SearchPost(context.Background()).Search(search).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchPost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchPost`: []map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchPost`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SearchAttributeConfigurationAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SearchAttributeConfigurationAPI.md new file mode 100644 index 000000000..9cc3b0b47 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SearchAttributeConfigurationAPI.md @@ -0,0 +1,453 @@ +--- +id: v2024-search-attribute-configuration +title: SearchAttributeConfiguration +pagination_label: SearchAttributeConfiguration +sidebar_label: SearchAttributeConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchAttributeConfiguration', 'V2024SearchAttributeConfiguration'] +slug: /tools/sdk/go/v2024/methods/search-attribute-configuration +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfiguration', 'V2024SearchAttributeConfiguration'] +--- + +# SearchAttributeConfigurationAPI + Use this API to implement search attribute configuration functionality, along with [Search](https://developer.sailpoint.com/docs/api/v2024/search). +With this functionality in place, administrators can create custom search attributes that and run extended searches based on those attributes to further narrow down their searches and get the information and insights they want. + +Identity Security Cloud (ISC) enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using ISC's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about ISC's search and its different possibilities. + +With Search Attribute Configuration, administrators can create, manage, and run searches based on the attributes they want to search. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-search-attribute-config**](#create-search-attribute-config) | **Post** `/accounts/search-attribute-config` | Create Extended Search Attributes +[**delete-search-attribute-config**](#delete-search-attribute-config) | **Delete** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute +[**get-search-attribute-config**](#get-search-attribute-config) | **Get** `/accounts/search-attribute-config` | List Extended Search Attributes +[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **Get** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute +[**patch-search-attribute-config**](#patch-search-attribute-config) | **Patch** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute + + +## create-search-attribute-config +:::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 Extended Search Attributes +Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. +>**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-search-attribute-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **searchAttributeConfig** | [**SearchAttributeConfig**](../models/search-attribute-config) | | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + searchattributeconfig := []byte(`{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }`) // SearchAttributeConfig | + + + var searchAttributeConfig v2024.SearchAttributeConfig + if err := json.Unmarshal(searchattributeconfig, &searchAttributeConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SearchAttributeConfigurationAPI.CreateSearchAttributeConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).SearchAttributeConfig(searchAttributeConfig).Execute() + //resp, r, err := apiClient.V2024.SearchAttributeConfigurationAPI.CreateSearchAttributeConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).SearchAttributeConfig(searchAttributeConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.CreateSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSearchAttributeConfig`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.CreateSearchAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-search-attribute-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 Extended Search Attribute +Delete an extended attribute configuration by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-search-attribute-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | Name of the extended search attribute configuration to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `newMailAttribute` // string | Name of the extended search attribute configuration to delete. # string | Name of the extended search attribute configuration to delete. + 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.SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-search-attribute-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 + ``` +::: +List Extended Search Attributes +Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-search-attribute-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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 + +[**[]SearchAttributeConfig**](../models/search-attribute-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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.V2024.SearchAttributeConfigurationAPI.GetSearchAttributeConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.SearchAttributeConfigurationAPI.GetSearchAttributeConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.GetSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSearchAttributeConfig`: []SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.GetSearchAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-single-search-attribute-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 + ``` +::: +Get Extended Search Attribute +Get an extended attribute configuration by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-single-search-attribute-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | Name of the extended search attribute configuration to get. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSingleSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**SearchAttributeConfig**](../models/search-attribute-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `newMailAttribute` // string | Name of the extended search attribute configuration to get. # string | Name of the extended search attribute configuration to get. + 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.SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSingleSearchAttributeConfig`: SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-search-attribute-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 Extended Search Attribute +Update an existing search attribute configuration. +You can patch these fields: +* name * displayName * applicationAttributes + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-search-attribute-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | Name of the search attribute configuration to patch. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**SearchAttributeConfig**](../models/search-attribute-config) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `promotedMailAttribute` // string | Name of the search attribute configuration to patch. # string | Name of the search attribute configuration to patch. + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SearchAttributeConfigurationAPI.PatchSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.SearchAttributeConfigurationAPI.PatchSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.PatchSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSearchAttributeConfig`: SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.PatchSearchAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SegmentsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SegmentsAPI.md new file mode 100644 index 000000000..13995029d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SegmentsAPI.md @@ -0,0 +1,405 @@ +--- +id: v2024-segments +title: Segments +pagination_label: Segments +sidebar_label: Segments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Segments', 'V2024Segments'] +slug: /tools/sdk/go/v2024/methods/segments +tags: ['SDK', 'Software Development Kit', 'Segments', 'V2024Segments'] +--- + +# SegmentsAPI + Use this API to implement and customize access request segment functionality. +With this functionality in place, administrators can create and manage access request segments. +Segments provide organizations with a way to make the access their users have even more granular - this can simply the access request process for the organization's users and improves security by reducing the risk of overprovisoning access. + +Segments represent sets of identities, all grouped by specified identity attributes, who are only able to see and access the access items associated with their segments. +For example, administrators could group all their organization's London office employees into one segment, "London Office Employees," by their shared location. +The administrators could then define the access items the London employees would need, and the identities in the "London Office Employees" would then only be able to see and access those items. + +In Identity Security Cloud, administrators can use the 'Access' drop-down menu and select 'Segments' to reach the 'Access Requests Segments' page. +This page lists all the existing access request segments, along with their statuses, enabled or disabled. +Administrators can use this page to create, edit, enable, disable, and delete segments. +To create a segment, an administrator must provide a name, define the identities grouped in the segment, and define the items the identities in the segment can access. +These items can be access profiles, roles, or entitlements. + +When administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items. + +Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-segment**](#create-segment) | **Post** `/segments` | Create Segment +[**delete-segment**](#delete-segment) | **Delete** `/segments/{id}` | Delete Segment by ID +[**get-segment**](#get-segment) | **Get** `/segments/{id}` | Get Segment by ID +[**list-segments**](#list-segments) | **Get** `/segments` | List Segments +[**patch-segment**](#patch-segment) | **Patch** `/segments/{id}` | Update Segment + + +## create-segment +Create Segment +This API creates a segment. +>**Note:** Segment definitions may take time to propagate to all identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-segment) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **segment** | [**Segment**](../models/segment) | | + +### Return type + +[**Segment**](../models/segment) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + segment := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }`) // Segment | + + + var segment v2024.Segment + if err := json.Unmarshal(segment, &segment); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SegmentsAPI.CreateSegment(context.Background()).Segment(segment).Execute() + //resp, r, err := apiClient.V2024.SegmentsAPI.CreateSegment(context.Background()).Segment(segment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.CreateSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.CreateSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-segment +Delete Segment by ID +This API deletes the segment specified by the given ID. +>**Note:** that segment deletion may take some time to become effective. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to delete. # string | The segment ID to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SegmentsAPI.DeleteSegment(context.Background(), id).Execute() + //r, err := apiClient.V2024.SegmentsAPI.DeleteSegment(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.DeleteSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-segment +Get Segment by ID +This API returns the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Segment**](../models/segment) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to retrieve. # string | The segment ID to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SegmentsAPI.GetSegment(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SegmentsAPI.GetSegment(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.GetSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.GetSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-segments +List Segments +This API returns a list of all segments. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-segments) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSegmentsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]Segment**](../models/segment) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SegmentsAPI.ListSegments(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SegmentsAPI.ListSegments(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.ListSegments``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSegments`: []Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.ListSegments`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-segment +Update Segment +Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +>**Note:** Changes to a segment may take some time to propagate to all identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to modify. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **requestBody** | **[]map[string]interface{}** | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active | + +### Return type + +[**Segment**](../models/segment) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to modify. # string | The segment ID to modify. + requestbody := []byte(`[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]`) // []map[string]interface{} | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SegmentsAPI.PatchSegment(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2024.SegmentsAPI.PatchSegment(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.PatchSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.PatchSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/ServiceDeskIntegrationAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/ServiceDeskIntegrationAPI.md new file mode 100644 index 000000000..709520e7f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/ServiceDeskIntegrationAPI.md @@ -0,0 +1,786 @@ +--- +id: v2024-service-desk-integration +title: ServiceDeskIntegration +pagination_label: ServiceDeskIntegration +sidebar_label: ServiceDeskIntegration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskIntegration', 'V2024ServiceDeskIntegration'] +slug: /tools/sdk/go/v2024/methods/service-desk-integration +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegration', 'V2024ServiceDeskIntegration'] +--- + +# ServiceDeskIntegrationAPI + Use this API to build an integration between Identity Security Cloud and a service desk ITSM (IT service management) solution. +Once an administrator builds this integration between Identity Security Cloud and a service desk, users can use Identity Security Cloud to raise and track tickets that are synchronized between Identity Security Cloud and the service desk. + +In Identity Security Cloud, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.' + +To create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. +Refer to [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in Identity Security Cloud. + +Administrators can create various service desk integrations, all with their own nuances. +The following service desk integrations are available: + +- [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud_sd/introduction.html) + +- [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server_sd/introduction.html) + +- [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html) + +- [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html) + +- [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) + +- [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html) + +- [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html) + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-service-desk-integration**](#create-service-desk-integration) | **Post** `/service-desk-integrations` | Create new Service Desk integration +[**delete-service-desk-integration**](#delete-service-desk-integration) | **Delete** `/service-desk-integrations/{id}` | Delete a Service Desk integration +[**get-service-desk-integration**](#get-service-desk-integration) | **Get** `/service-desk-integrations/{id}` | Get a Service Desk integration +[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **Get** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName +[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **Get** `/service-desk-integrations/types` | List Service Desk integration types +[**get-service-desk-integrations**](#get-service-desk-integrations) | **Get** `/service-desk-integrations` | List existing Service Desk integrations +[**get-status-check-details**](#get-status-check-details) | **Get** `/service-desk-integrations/status-check-configuration` | Get the time check configuration +[**patch-service-desk-integration**](#patch-service-desk-integration) | **Patch** `/service-desk-integrations/{id}` | Patch a Service Desk Integration +[**put-service-desk-integration**](#put-service-desk-integration) | **Put** `/service-desk-integrations/{id}` | Update a Service Desk integration +[**update-status-check-details**](#update-status-check-details) | **Put** `/service-desk-integrations/status-check-configuration` | Update the time check configuration + + +## create-service-desk-integration +Create new Service Desk integration +Create a new Service Desk integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-service-desk-integration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **serviceDeskIntegrationDto** | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | The specifics of a new integration to create | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + servicedeskintegrationdto := []byte(`{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + }`) // ServiceDeskIntegrationDto | The specifics of a new integration to create + + + var serviceDeskIntegrationDto v2024.ServiceDeskIntegrationDto + if err := json.Unmarshal(servicedeskintegrationdto, &serviceDeskIntegrationDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.CreateServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.CreateServiceDeskIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-service-desk-integration +Delete a Service Desk integration +Delete an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-service-desk-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of Service Desk integration to delete | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `anId` // string | ID of Service Desk integration to delete # string | ID of Service Desk integration to delete + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration(context.Background(), id).Execute() + //r, err := apiClient.V2024.ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-service-desk-integration +Get a Service Desk integration +Get an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Service Desk integration to get | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `anId` // string | ID of the Service Desk integration to get # string | ID of the Service Desk integration to get + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetServiceDeskIntegration(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetServiceDeskIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-service-desk-integration-template +Service Desk integration template by scriptName +This API endpoint returns an existing Service Desk integration template by scriptName. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integration-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the Service Desk integration template to get | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ServiceDeskIntegrationTemplateDto**](../models/service-desk-integration-template-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the Service Desk integration template to get # string | The scriptName value of the Service Desk integration template to get + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationTemplate`: ServiceDeskIntegrationTemplateDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-service-desk-integration-types +List Service Desk integration types +This API endpoint returns the current list of supported Service Desk integration types. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integration-types) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationTypesRequest struct via the builder pattern + + +### Return type + +[**[]ServiceDeskIntegrationTemplateType**](../models/service-desk-integration-template-type) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationTypes`: []ServiceDeskIntegrationTemplateType + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-service-desk-integrations +List existing Service Desk integrations +Get a list of Service Desk integration objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integrations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **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** | + **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* **type**: *eq, in* **cluster**: *eq, in* | + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `name eq "John Doe"` // 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* **type**: *eq, in* **cluster**: *eq, in* (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* **type**: *eq, in* **cluster**: *eq, in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetServiceDeskIntegrations(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetServiceDeskIntegrations(context.Background()).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrations`: []ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-status-check-details +Get the time check configuration +Get the time check configuration of queued SDIM tickets. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-status-check-details) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetStatusCheckDetailsRequest struct via the builder pattern + + +### Return type + +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetStatusCheckDetails(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetStatusCheckDetails(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetStatusCheckDetails``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetStatusCheckDetails`: QueuedCheckConfigDetails + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetStatusCheckDetails`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-service-desk-integration +Patch a Service Desk Integration +Update an existing Service Desk integration by ID with a PATCH request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-service-desk-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Service Desk integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `anId` // string | ID of the Service Desk integration to update # string | ID of the Service Desk integration to update + jsonpatchoperation := []byte(``) // []JsonPatchOperation | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.PatchServiceDeskIntegration(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.PatchServiceDeskIntegration(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.PatchServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.PatchServiceDeskIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-service-desk-integration +Update a Service Desk integration +Update an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-service-desk-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Service Desk integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **serviceDeskIntegrationDto** | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | The specifics of the integration to update | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `anId` // string | ID of the Service Desk integration to update # string | ID of the Service Desk integration to update + servicedeskintegrationdto := []byte(`{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + }`) // ServiceDeskIntegrationDto | The specifics of the integration to update + + + var serviceDeskIntegrationDto v2024.ServiceDeskIntegrationDto + if err := json.Unmarshal(servicedeskintegrationdto, &serviceDeskIntegrationDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.PutServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.PutServiceDeskIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-status-check-details +Update the time check configuration +Update the time check configuration of queued SDIM tickets. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-status-check-details) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateStatusCheckDetailsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **queuedCheckConfigDetails** | [**QueuedCheckConfigDetails**](../models/queued-check-config-details) | The modified time check configuration | + +### Return type + +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + queuedcheckconfigdetails := []byte(`{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + }`) // QueuedCheckConfigDetails | The modified time check configuration + + + var queuedCheckConfigDetails v2024.QueuedCheckConfigDetails + if err := json.Unmarshal(queuedcheckconfigdetails, &queuedCheckConfigDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.UpdateStatusCheckDetails``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateStatusCheckDetails`: QueuedCheckConfigDetails + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.UpdateStatusCheckDetails`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SourceUsagesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SourceUsagesAPI.md new file mode 100644 index 000000000..77b81323c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SourceUsagesAPI.md @@ -0,0 +1,164 @@ +--- +id: v2024-source-usages +title: SourceUsages +pagination_label: SourceUsages +sidebar_label: SourceUsages +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUsages', 'V2024SourceUsages'] +slug: /tools/sdk/go/v2024/methods/source-usages +tags: ['SDK', 'Software Development Kit', 'SourceUsages', 'V2024SourceUsages'] +--- + +# SourceUsagesAPI + Use this API to implement source usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used. +This allows organizations to get the information they need to start optimizing and securing source usage. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-status-by-source-id**](#get-status-by-source-id) | **Get** `/source-usages/{sourceId}/status` | Finds status of source usage +[**get-usages-by-source-id**](#get-usages-by-source-id) | **Get** `/source-usages/{sourceId}/summaries` | Returns source usage insights + + +## get-status-by-source-id +Finds status of source usage +This API returns the status of the source usage insights setup by IDN source ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-status-by-source-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | ID of IDN source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetStatusBySourceIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SourceUsageStatus**](../models/source-usage-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | ID of IDN source # string | ID of IDN source + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourceUsagesAPI.GetStatusBySourceId(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourceUsagesAPI.GetStatusBySourceId(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourceUsagesAPI.GetStatusBySourceId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetStatusBySourceId`: SourceUsageStatus + fmt.Fprintf(os.Stdout, "Response from `SourceUsagesAPI.GetStatusBySourceId`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-usages-by-source-id +Returns source usage insights +This API returns a summary of source usage insights for past 12 months. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-usages-by-source-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | ID of IDN source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetUsagesBySourceIdRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **date** | + +### Return type + +[**[]SourceUsage**](../models/source-usage) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | ID of IDN source # string | ID of IDN source + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `-date` // 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: **date** (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: **date** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourceUsagesAPI.GetUsagesBySourceId(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourceUsagesAPI.GetUsagesBySourceId(context.Background(), sourceId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourceUsagesAPI.GetUsagesBySourceId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUsagesBySourceId`: []SourceUsage + fmt.Fprintf(os.Stdout, "Response from `SourceUsagesAPI.GetUsagesBySourceId`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SourcesAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SourcesAPI.md new file mode 100644 index 000000000..cc9fcfb52 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SourcesAPI.md @@ -0,0 +1,4239 @@ +--- +id: v2024-sources +title: Sources +pagination_label: Sources +sidebar_label: Sources +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Sources', 'V2024Sources'] +slug: /tools/sdk/go/v2024/methods/sources +tags: ['SDK', 'Software Development Kit', 'Sources', 'V2024Sources'] +--- + +# SourcesAPI + Use this API to implement and customize source functionality. +With source functionality in place, organizations can use Identity Security Cloud to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way. + +[Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) refer to the Identity Security Cloud representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example. +Organizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records. +Connecting these sources to Identity Security Cloud makes it possible to manage user access across them all. +Then, if a new hire starts at an organization, Identity Security Cloud can grant the new hire access to all the sources they need. +If an employee moves to a new department and needs access to new sources but no longer needs access to others, Identity Security Cloud can grant the necessary access and revoke the unnecessary access for all the employee's various sources. +If an employee leaves the company, Identity Security Cloud can revoke access to all the employee's various source accounts immediately. +These are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure. + +In Identity Security Cloud, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so. +They can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups. +Admins go to Connections > Sources to see a list of the existing source representations in their organizations. +They can create new sources or select existing ones. + +To create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type. +Refer to [Configuring a Source](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source) for more information about the source configuration process. + +Identity Security Cloud connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in. +Different sources use different connectors to share data with Identity Security Cloud, and each connector's setup process is specific to that connector. +SailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors. +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about these SailPoint supported connectors. +Refer to the following links for more information about two useful connectors: + +- [JDBC Connector](https://documentation.sailpoint.com/connectors/jdbc/help/integrating_jdbc/introduction.html): This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity). + +- [Web Services Connector](https://documentation.sailpoint.com/connectors/webservices/help/integrating_webservices/introduction.html): This connector can directly connect to databases that support Web Services. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources. + +When admins select existing sources, they can view the following information about the source: + +- Associated connections (any associated identity profiles, apps, or references to the source in a transform). + +- Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources. + +- Associated entitlements (sets of access rights on sources). + +- Associated access profiles (groupings of entitlements). + +The user account data and the entitlements update with each data aggregation from the source. +Organizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their Identity Security Cloud tenants so an access change on a source is detected quickly in Identity Security Cloud. +Admins can view a history of these aggregations, and they can also run manual imports. +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about manual and scheduled aggregations. + +Admins can also make changes to determine which user account data Identity Security Cloud collects from the source and how it correlates that account data with identity data. +To define which account attributes the source shares with Identity Security Cloud, admins can edit the account schema on the source. +Refer to [Managing Source Account Schemas](https://documentation.sailpoint.com/saas/help/accounts/schema.html) for more information about source account schemas and how to edit them. +To define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source. +Refer to [Assigning Source Accounts to Identities](https://documentation.sailpoint.com/saas/help/accounts/correlation.html) for more information about this correlation process between source accounts and identities. + +Admins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform. +Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources. + +Well organized, mapped out connections between sources and Identity Security Cloud are essential to achieving comprehensive identity access governance across all the source systems organizations need. +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-provisioning-policy**](#create-provisioning-policy) | **Post** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy +[**create-source**](#create-source) | **Post** `/sources` | Creates a source in IdentityNow. +[**create-source-schedule**](#create-source-schedule) | **Post** `/sources/{sourceId}/schedules` | Create Schedule on Source +[**create-source-schema**](#create-source-schema) | **Post** `/sources/{sourceId}/schemas` | Create Schema on Source +[**delete-accounts-async**](#delete-accounts-async) | **Post** `/sources/{id}/remove-accounts` | Remove All Accounts in a Source +[**delete-native-change-detection-config**](#delete-native-change-detection-config) | **Delete** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration +[**delete-provisioning-policy**](#delete-provisioning-policy) | **Delete** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType +[**delete-source**](#delete-source) | **Delete** `/sources/{id}` | Delete Source by ID +[**delete-source-schedule**](#delete-source-schedule) | **Delete** `/sources/{sourceId}/schedules/{scheduleType}` | Delete Source Schedule by type. +[**delete-source-schema**](#delete-source-schema) | **Delete** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID +[**get-accounts-schema**](#get-accounts-schema) | **Get** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template +[**get-correlation-config**](#get-correlation-config) | **Get** `/sources/{id}/correlation-config` | Get Source Correlation Configuration +[**get-entitlements-schema**](#get-entitlements-schema) | **Get** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template +[**get-native-change-detection-config**](#get-native-change-detection-config) | **Get** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration +[**get-provisioning-policy**](#get-provisioning-policy) | **Get** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType +[**get-source**](#get-source) | **Get** `/sources/{id}` | Get Source by ID +[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **Get** `/sources/{id}/attribute-sync-config` | Attribute Sync Config +[**get-source-config**](#get-source-config) | **Get** `/sources/{id}/connectors/source-config` | Gets source config with language-translations +[**get-source-connections**](#get-source-connections) | **Get** `/sources/{sourceId}/connections` | Get Source Connections by ID +[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **Get** `/sources/{id}/entitlement-request-config` | Get Source Entitlement Request Configuration +[**get-source-health**](#get-source-health) | **Get** `/sources/{sourceId}/source-health` | Fetches source health by id +[**get-source-schedule**](#get-source-schedule) | **Get** `/sources/{sourceId}/schedules/{scheduleType}` | Get Source Schedule by Type +[**get-source-schedules**](#get-source-schedules) | **Get** `/sources/{sourceId}/schedules` | List Schedules on Source +[**get-source-schema**](#get-source-schema) | **Get** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID +[**get-source-schemas**](#get-source-schemas) | **Get** `/sources/{sourceId}/schemas` | List Schemas on Source +[**import-accounts**](#import-accounts) | **Post** `/sources/{id}/load-accounts` | Account Aggregation +[**import-accounts-schema**](#import-accounts-schema) | **Post** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template +[**import-connector-file**](#import-connector-file) | **Post** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source +[**import-entitlements-schema**](#import-entitlements-schema) | **Post** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template +[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **Post** `/sources/{id}/load-uncorrelated-accounts` | Process Uncorrelated Accounts +[**list-provisioning-policies**](#list-provisioning-policies) | **Get** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies +[**list-sources**](#list-sources) | **Get** `/sources` | Lists all sources in IdentityNow. +[**ping-cluster**](#ping-cluster) | **Post** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector +[**put-correlation-config**](#put-correlation-config) | **Put** `/sources/{id}/correlation-config` | Update Source Correlation Configuration +[**put-native-change-detection-config**](#put-native-change-detection-config) | **Put** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration +[**put-provisioning-policy**](#put-provisioning-policy) | **Put** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType +[**put-source**](#put-source) | **Put** `/sources/{id}` | Update Source (Full) +[**put-source-attr-sync-config**](#put-source-attr-sync-config) | **Put** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config +[**put-source-schema**](#put-source-schema) | **Put** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) +[**search-resource-objects**](#search-resource-objects) | **Post** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects +[**sync-attributes-for-source**](#sync-attributes-for-source) | **Post** `/sources/{id}/synchronize-attributes` | Synchronize single source attributes. +[**test-source-configuration**](#test-source-configuration) | **Post** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector +[**test-source-connection**](#test-source-connection) | **Post** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector. +[**update-password-policy-holders**](#update-password-policy-holders) | **Patch** `/sources/{sourceId}/password-policies` | Update Password Policy +[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **Post** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies +[**update-provisioning-policy**](#update-provisioning-policy) | **Patch** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy +[**update-source**](#update-source) | **Patch** `/sources/{id}` | Update Source (Partial) +[**update-source-entitlement-request-config**](#update-source-entitlement-request-config) | **Put** `/sources/{id}/entitlement-request-config` | Update Source Entitlement Request Configuration +[**update-source-schedule**](#update-source-schedule) | **Patch** `/sources/{sourceId}/schedules/{scheduleType}` | Update Source Schedule (Partial) +[**update-source-schema**](#update-source-schema) | **Patch** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) + + +## create-provisioning-policy +Create Provisioning Policy +This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **provisioningPolicyDto** | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | | + +### Return type + +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id # string | The Source id + provisioningpolicydto := []byte(`{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }`) // ProvisioningPolicyDto | + + + var provisioningPolicyDto v2024.ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.CreateProvisioningPolicy(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.CreateProvisioningPolicy(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateProvisioningPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-source +Creates a source in IdentityNow. +This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-source) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **source** | [**Source**](../models/source) | | + **provisionAsCsv** | **bool** | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. | + +### Return type + +[**Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + source := []byte(`{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }`) // Source | + provisionAsCsv := false // bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + + var source v2024.Source + if err := json.Unmarshal(source, &source); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.CreateSource(context.Background()).Source(source).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.CreateSource(context.Background()).Source(source).ProvisionAsCsv(provisionAsCsv).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-source-schedule +Create Schedule on Source +Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-source-schedule) + +### 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 apiCreateSourceScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schedule1** | [**Schedule1**](../models/schedule1) | | + +### Return type + +[**Schedule1**](../models/schedule1) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + schedule1 := []byte(``) // Schedule1 | + + + var schedule1 v2024.Schedule1 + if err := json.Unmarshal(schedule1, &schedule1); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.CreateSourceSchedule(context.Background(), sourceId).Schedule1(schedule1).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.CreateSourceSchedule(context.Background(), sourceId).Schedule1(schedule1).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSourceSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceSchedule`: Schedule1 + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSourceSchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-source-schema +Create Schema on Source +Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-source-schema) + +### 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 apiCreateSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schema** | [**Schema**](../models/schema) | | + +### Return type + +[**Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + schema := []byte(`{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + }`) // Schema | + + + var schema v2024.Schema + if err := json.Unmarshal(schema, &schema); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.CreateSourceSchema(context.Background(), sourceId).Schema(schema).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.CreateSourceSchema(context.Background(), sourceId).Schema(schema).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSourceSchema`: %v\n", resp) +} +``` + +[[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 +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: +* Removing accounts that no longer exist on the source. +* Removing accounts that won't be aggregated following updates to the source configuration. +* Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-accounts-async) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccountsAsyncRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**TaskResultDto**](../models/task-result-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } + // response from `DeleteAccountsAsync`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.DeleteAccountsAsync`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-native-change-detection-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNativeChangeDetectionConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } +} +``` + +[[Back to top]](#) + +## delete-provisioning-policy +Delete Provisioning Policy by UsageType +Deletes the provisioning policy with the specified usage on an application. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source ID. | +**usageType** | [**UsageType**](../models/) | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SourcesAPI.DeleteProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + //r, err := apiClient.V2024.SourcesAPI.DeleteProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-source +Delete Source by ID +Use this API to delete a specific source in Identity Security Cloud (ISC). +The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**DeleteSource202Response**](../models/delete-source202-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.DeleteSource(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.DeleteSource(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteSource`: DeleteSource202Response + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.DeleteSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-source-schedule +Delete Source Schedule by type. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**scheduleType** | **string** | The Schedule type. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSourceScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + scheduleType := `ACCOUNT_AGGREGATION` // string | The Schedule type. # string | The Schedule type. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SourcesAPI.DeleteSourceSchedule(context.Background(), sourceId, scheduleType).Execute() + //r, err := apiClient.V2024.SourcesAPI.DeleteSourceSchedule(context.Background(), sourceId, scheduleType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSourceSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-source-schema +Delete Source Schema by ID + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**schemaId** | **string** | The Schema id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SourcesAPI.DeleteSourceSchema(context.Background(), sourceId, schemaId).Execute() + //r, err := apiClient.V2024.SourcesAPI.DeleteSourceSchema(context.Background(), sourceId, schemaId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-accounts-schema +Downloads source accounts schema template +This API downloads the CSV schema that defines the account attributes on a source. +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-accounts-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountsSchemaRequest 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SourcesAPI.GetAccountsSchema(context.Background(), id).Execute() + //r, err := apiClient.V2024.SourcesAPI.GetAccountsSchema(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetAccountsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-correlation-config +Get Source Correlation Configuration +This API returns the existing correlation configuration for a source specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-correlation-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCorrelationConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CorrelationConfig**](../models/correlation-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetCorrelationConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetCorrelationConfig(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCorrelationConfig`: CorrelationConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetCorrelationConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlements-schema +Downloads source entitlements schema template +This API downloads the CSV schema that defines the entitlement attributes on a source. + +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlements-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementsSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schemaName** | **string** | Name of entitlement schema | + +### 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + schemaName := `?schemaName=group` // string | Name of entitlement schema (optional) # string | Name of entitlement schema (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SourcesAPI.GetEntitlementsSchema(context.Background(), id).Execute() + //r, err := apiClient.V2024.SourcesAPI.GetEntitlementsSchema(context.Background(), id).SchemaName(schemaName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetEntitlementsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-native-change-detection-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNativeChangeDetectionConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**NativeChangeDetectionConfig**](../models/native-change-detection-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } + // response from `GetNativeChangeDetectionConfig`: NativeChangeDetectionConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetNativeChangeDetectionConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-provisioning-policy +Get Provisioning Policy by UsageType +This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source ID. | +**usageType** | [**UsageType**](../models/) | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetProvisioningPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source +Get Source by ID +Use this API to get a source by a specified ID in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSource(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSource(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-attr-sync-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 + ``` +::: +Attribute Sync Config +This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-attr-sync-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceAttrSyncConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**AttrSyncSourceConfig**](../models/attr-sync-source-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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.GetSourceAttrSyncConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceAttrSyncConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceAttrSyncConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceAttrSyncConfig`: AttrSyncSourceConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceAttrSyncConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-config +Gets source config with language-translations +Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **locale** | **string** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | + +### Return type + +[**ConnectorDetail**](../models/connector-detail) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `cef3ee201db947c5912551015ba0c679` // string | The Source id # string | The Source id + locale := `en` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSourceConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceConfig(context.Background(), id).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceConfig`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-connections +Get Source Connections by ID +Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-connections) + +### 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 apiGetSourceConnectionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SourceConnectionsDto**](../models/source-connections-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSourceConnections(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceConnections(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceConnections``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceConnections`: SourceConnectionsDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceConnections`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-entitlement-request-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 + ``` +::: +Get Source Entitlement Request Configuration +This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. + +Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. +- During access request, this source-level entitlement request configuration overrides the global organization-level configuration. +- However, the entitlement-level configuration (if defined) overrides this source-level configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-entitlement-request-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceEntitlementRequestConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSourceEntitlementRequestConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceEntitlementRequestConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceEntitlementRequestConfig`: SourceEntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceEntitlementRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-health +Fetches source health by id +This endpoint fetches source health by source's id + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-health) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceHealthRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SourceHealthDto**](../models/source-health-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSourceHealth(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceHealth(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceHealth``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceHealth`: SourceHealthDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceHealth`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-schedule +Get Source Schedule by Type +Get the source schedule by type in Identity Security Cloud (ISC). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**scheduleType** | **string** | The Schedule type. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Schedule1**](../models/schedule1) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + scheduleType := `ACCOUNT_AGGREGATION` // string | The Schedule type. # string | The Schedule type. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSourceSchedule(context.Background(), sourceId, scheduleType).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceSchedule(context.Background(), sourceId, scheduleType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchedule`: Schedule1 + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-schedules +List Schedules on Source +Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). +:::info +This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. + +For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. + +**Days of the week are represented as 1-7 (Sunday-Saturday).** +::: + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-schedules) + +### 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 apiGetSourceSchedulesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]Schedule1**](../models/schedule1) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSourceSchedules(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceSchedules(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchedules``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchedules`: []Schedule1 + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchedules`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-schema +Get Source Schema by ID +Get the Source Schema by ID in IdentityNow. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**schemaId** | **string** | The Schema id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSourceSchema(context.Background(), sourceId, schemaId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceSchema(context.Background(), sourceId, schemaId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-schemas +List Schemas on Source +Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-schemas) + +### 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 apiGetSourceSchemasRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeTypes** | **string** | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. | + **includeNames** | **string** | A comma-separated list of schema names to filter result. | + +### Return type + +[**[]Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + includeTypes := `group` // string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) # string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + includeNames := `account` // string | A comma-separated list of schema names to filter result. (optional) # string | A comma-separated list of schema names to filter result. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).IncludeTypes(includeTypes).IncludeNames(includeNames).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchemas``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchemas`: []Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchemas`: %v\n", resp) +} +``` + +[[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. +You will also need to set the Content-Type header to `multipart/form-data`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-accounts) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportAccountsRequest 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 accounts to aggregate. | + **disableOptimization** | **string** | Use this flag to reprocess every account whether or not the data has changed. | + +### Return type + +[**LoadAccountsTask**](../models/load-accounts-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() { + 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) + + + + 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() + 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) + } + // response from `ImportAccounts`: LoadAccountsTask + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportAccounts`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-accounts-schema +Uploads source accounts schema template +This API uploads a source schema template file to configure a source's account attributes. + +To retrieve the file to modify and upload, log into Identity Now. + +Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** + +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-accounts-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportAccountsSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | | + +### Return type + +[**Schema**](../models/schema) + +### 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() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.ImportAccountsSchema(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.ImportAccountsSchema(context.Background(), id).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportAccountsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportAccountsSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportAccountsSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-connector-file +Upload connector file to source +This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-connector-file) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportConnectorFileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | | + +### Return type + +[**Source**](../models/source) + +### 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 := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.ImportConnectorFile(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.ImportConnectorFile(context.Background(), sourceId).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportConnectorFile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportConnectorFile`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportConnectorFile`: %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. + +To retrieve the file to modify and upload, log into Identity Now. + +Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** + +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-entitlements-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportEntitlementsSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schemaName** | **string** | Name of entitlement schema | + **file** | ***os.File** | | + +### Return type + +[**Schema**](../models/schema) + +### 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() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + schemaName := `?schemaName=group` // string | Name of entitlement schema (optional) # string | Name of entitlement schema (optional) + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.ImportEntitlementsSchema(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.ImportEntitlementsSchema(context.Background(), id).SchemaName(schemaName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportEntitlementsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportEntitlementsSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportEntitlementsSchema`: %v\n", resp) +} +``` + +[[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` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-uncorrelated-accounts) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportUncorrelatedAccountsRequest 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** | | + +### Return type + +[**LoadUncorrelatedAccountsTask**](../models/load-uncorrelated-accounts-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() { + 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() + 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) + } + // response from `ImportUncorrelatedAccounts`: LoadUncorrelatedAccountsTask + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportUncorrelatedAccounts`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-provisioning-policies +Lists ProvisioningPolicies +This end-point lists all the ProvisioningPolicies in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-provisioning-policies) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListProvisioningPoliciesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.ListProvisioningPolicies(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.ListProvisioningPolicies(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ListProvisioningPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListProvisioningPolicies`: []ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ListProvisioningPolicies`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-sources +Lists all sources in IdentityNow. +This end-point lists all the sources in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sources) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSourcesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* | + **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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** | + **forSubadmin** | **string** | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. | + **includeIDNSource** | **bool** | Include the IdentityNow source in the response. | [default to false] + +### Return type + +[**[]Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Employees"` // 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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + sorters := `name` // 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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + forSubadmin := `name` // string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) # string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + includeIDNSource := true // bool | Include the IdentityNow source in the response. (optional) (default to false) # bool | Include the IdentityNow source in the response. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.ListSources(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.ListSources(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSubadmin(forSubadmin).IncludeIDNSource(includeIDNSource).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ListSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSources`: []Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ListSources`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## ping-cluster +Ping cluster for source connector +This endpoint validates that the cluster being used by the source is reachable from IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/ping-cluster) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The ID of the Source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPingClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**StatusResponse**](../models/status-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.PingCluster(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.PingCluster(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PingCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PingCluster`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PingCluster`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-correlation-config +Update Source Correlation Configuration +Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-correlation-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutCorrelationConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **correlationConfig** | [**CorrelationConfig**](../models/correlation-config) | | + +### Return type + +[**CorrelationConfig**](../models/correlation-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + correlationconfig := []byte(`{ + "attributeAssignments" : [ { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + }, { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + } ], + "name" : "Source [source] Account Correlation", + "id" : "2c9180835d191a86015d28455b4a2329" + }`) // CorrelationConfig | + + + var correlationConfig v2024.CorrelationConfig + if err := json.Unmarshal(correlationconfig, &correlationConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.PutCorrelationConfig(context.Background(), id).CorrelationConfig(correlationConfig).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.PutCorrelationConfig(context.Background(), id).CorrelationConfig(correlationConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutCorrelationConfig`: CorrelationConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutCorrelationConfig`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-native-change-detection-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutNativeChangeDetectionConfigRequest struct via the builder pattern + + +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 + +[**NativeChangeDetectionConfig**](../models/native-change-detection-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true + }`) // NativeChangeDetectionConfig | + + + var nativeChangeDetectionConfig v2024.NativeChangeDetectionConfig + if err := json.Unmarshal(nativechangedetectionconfig, &nativeChangeDetectionConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + 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() + 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) + } + // response from `PutNativeChangeDetectionConfig`: NativeChangeDetectionConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutNativeChangeDetectionConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-provisioning-policy +Update Provisioning Policy by UsageType +This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source ID. | +**usageType** | [**UsageType**](../models/) | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **provisioningPolicyDto** | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | | + +### Return type + +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + provisioningpolicydto := []byte(`{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }`) // ProvisioningPolicyDto | + + + var provisioningPolicyDto v2024.ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.PutProvisioningPolicy(context.Background(), sourceId, usageType).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.PutProvisioningPolicy(context.Background(), sourceId, usageType).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutProvisioningPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-source +Update Source (Full) +Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. + +These fields are immutable, so they cannot be changed: + +* id +* type +* authoritative +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **source** | [**Source**](../models/source) | | + +### Return type + +[**Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + source := []byte(`{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }`) // Source | + + + var source v2024.Source + if err := json.Unmarshal(source, &source); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.PutSource(context.Background(), id).Source(source).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.PutSource(context.Background(), id).Source(source).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-source-attr-sync-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 Attribute Sync Config +Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-source-attr-sync-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSourceAttrSyncConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **attrSyncSourceConfig** | [**AttrSyncSourceConfig**](../models/attr-sync-source-config) | | + +### Return type + +[**AttrSyncSourceConfig**](../models/attr-sync-source-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + attrsyncsourceconfig := []byte(`{ + "attributes" : [ { + "name" : "email", + "displayName" : "Email", + "enabled" : true, + "target" : "mail" + }, { + "name" : "firstname", + "displayName" : "First Name", + "enabled" : false, + "target" : "givenName" + } ], + "source" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + } + }`) // AttrSyncSourceConfig | + + + var attrSyncSourceConfig v2024.AttrSyncSourceConfig + if err := json.Unmarshal(attrsyncsourceconfig, &attrSyncSourceConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.PutSourceAttrSyncConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).AttrSyncSourceConfig(attrSyncSourceConfig).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.PutSourceAttrSyncConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).AttrSyncSourceConfig(attrSyncSourceConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSourceAttrSyncConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSourceAttrSyncConfig`: AttrSyncSourceConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSourceAttrSyncConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-source-schema +Update Source Schema (Full) +This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. + +* id +* name +* created +* modified + +Any attempt to modify these fields will result in an error response with a status code of 400. + +> `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-source-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**schemaId** | **string** | The Schema id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **schema** | [**Schema**](../models/schema) | | + +### Return type + +[**Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + schema := []byte(`{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + }`) // Schema | + + + var schema v2024.Schema + if err := json.Unmarshal(schema, &schema); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.PutSourceSchema(context.Background(), sourceId, schemaId).Schema(schema).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.PutSourceSchema(context.Background(), sourceId, schemaId).Schema(schema).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSourceSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-resource-objects +Peek source connector's resource objects +Retrieves a sample of data returned from account and group aggregation requests. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-resource-objects) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The ID of the Source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchResourceObjectsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **resourceObjectsRequest** | [**ResourceObjectsRequest**](../models/resource-objects-request) | | + +### Return type + +[**ResourceObjectsResponse**](../models/resource-objects-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + resourceobjectsrequest := []byte(`{ + "maxCount" : 100, + "objectType" : "group" + }`) // ResourceObjectsRequest | + + + var resourceObjectsRequest v2024.ResourceObjectsRequest + if err := json.Unmarshal(resourceobjectsrequest, &resourceObjectsRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.SearchResourceObjects(context.Background(), sourceId).ResourceObjectsRequest(resourceObjectsRequest).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.SearchResourceObjects(context.Background(), sourceId).ResourceObjectsRequest(resourceObjectsRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.SearchResourceObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchResourceObjects`: ResourceObjectsResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.SearchResourceObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## sync-attributes-for-source +:::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 + ``` +::: +Synchronize single source attributes. +This end-point performs attribute synchronization for a selected source. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/sync-attributes-for-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSyncAttributesForSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**SourceSyncJob**](../models/source-sync-job) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `id_example` // 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.SyncAttributesForSource(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.SyncAttributesForSource(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.SyncAttributesForSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SyncAttributesForSource`: SourceSyncJob + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.SyncAttributesForSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-source-configuration +Test configuration for source connector +This endpoint performs a more detailed validation of the source''s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-source-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The ID of the Source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestSourceConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**StatusResponse**](../models/status-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.TestSourceConfiguration(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.TestSourceConfiguration(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.TestSourceConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConfiguration`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.TestSourceConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-source-connection +Check connection for source connector. +This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-source-connection) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The ID of the Source. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestSourceConnectionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**StatusResponse**](../models/status-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source. # string | The ID of the Source. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.TestSourceConnection(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.TestSourceConnection(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.TestSourceConnection``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConnection`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.TestSourceConnection`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-password-policy-holders +Update Password Policy +This API can be used to set up or update Password Policy in IdentityNow for the specified Source. +Source must support PASSWORD feature. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-password-policy-holders) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdatePasswordPolicyHoldersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **passwordPolicyHoldersDtoInner** | [**[]PasswordPolicyHoldersDtoInner**](../models/password-policy-holders-dto-inner) | | + +### Return type + +[**[]PasswordPolicyHoldersDtoInner**](../models/password-policy-holders-dto-inner) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + passwordpolicyholdersdtoinner := []byte(``) // []PasswordPolicyHoldersDtoInner | + + + var passwordPolicyHoldersDtoInner v2024.[]PasswordPolicyHoldersDtoInner + if err := json.Unmarshal(passwordpolicyholdersdtoinner, &passwordPolicyHoldersDtoInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.UpdatePasswordPolicyHolders(context.Background(), sourceId).PasswordPolicyHoldersDtoInner(passwordPolicyHoldersDtoInner).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.UpdatePasswordPolicyHolders(context.Background(), sourceId).PasswordPolicyHoldersDtoInner(passwordPolicyHoldersDtoInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdatePasswordPolicyHolders``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePasswordPolicyHolders`: []PasswordPolicyHoldersDtoInner + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdatePasswordPolicyHolders`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-provisioning-policies-in-bulk +Bulk Update Provisioning Policies +This end-point updates a list of provisioning policies on the specified source in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-provisioning-policies-in-bulk) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateProvisioningPoliciesInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **provisioningPolicyDto** | [**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) | | + +### Return type + +[**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + provisioningpolicydto := []byte(``) // []ProvisioningPolicyDto | + + + var provisioningPolicyDto v2024.[]ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.UpdateProvisioningPoliciesInBulk(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.UpdateProvisioningPoliciesInBulk(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateProvisioningPoliciesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateProvisioningPoliciesInBulk`: []ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateProvisioningPoliciesInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-provisioning-policy +Partial update of Provisioning Policy +This API selectively updates an existing Provisioning Policy using a JSONPatch payload. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**usageType** | [**UsageType**](../models/) | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | The JSONPatch payload used to update the schema. | + +### Return type + +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + jsonpatchoperation := []byte(`[{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schema. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.UpdateProvisioningPolicy(context.Background(), sourceId, usageType).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.UpdateProvisioningPolicy(context.Background(), sourceId, usageType).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateProvisioningPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-source +Update Source (Partial) +Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the +[JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +These fields are immutable, so they cannot be changed: + +* id +* type +* authoritative +* created +* modified +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). | + +### Return type + +[**Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=new description}]`) // []JsonPatchOperation | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.UpdateSource(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.UpdateSource(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-source-entitlement-request-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 Source Entitlement Request Configuration +This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. + +Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. +- During access request, this source-level entitlement request configuration overrides the global organization-level configuration. +- However, the entitlement-level configuration (if defined) overrides this source-level configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-source-entitlement-request-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSourceEntitlementRequestConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **sourceEntitlementRequestConfig** | [**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) | | + +### Return type + +[**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + sourceentitlementrequestconfig := []byte(`{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }`) // SourceEntitlementRequestConfig | + + + var sourceEntitlementRequestConfig v2024.SourceEntitlementRequestConfig + if err := json.Unmarshal(sourceentitlementrequestconfig, &sourceEntitlementRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.UpdateSourceEntitlementRequestConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceEntitlementRequestConfig(sourceEntitlementRequestConfig).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.UpdateSourceEntitlementRequestConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceEntitlementRequestConfig(sourceEntitlementRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceEntitlementRequestConfig`: SourceEntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceEntitlementRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-source-schedule +Update Source Schedule (Partial) +Use this API to selectively update an existing Schedule using a JSONPatch payload. + +The following schedule fields are immutable and cannot be updated: + +- type + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-source-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**scheduleType** | **string** | The Schedule type. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSourceScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | The JSONPatch payload used to update the schedule. | + +### Return type + +[**Schedule1**](../models/schedule1) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + scheduleType := `ACCOUNT_AGGREGATION` // string | The Schedule type. # string | The Schedule type. + jsonpatchoperation := []byte(`[{op=replace, path=/cronExpression, value=0 0 6 * * ?}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schedule. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.UpdateSourceSchedule(context.Background(), sourceId, scheduleType).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.UpdateSourceSchedule(context.Background(), sourceId, scheduleType).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceSchedule`: Schedule1 + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceSchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-source-schema +Update Source Schema (Partial) +Use this API to selectively update an existing Schema using a JSONPatch payload. + +The following schema fields are immutable and cannot be updated: + +- id +- name +- created +- modified + + +To switch an account attribute to a group entitlement, you need to have the following in place: + +- `isEntitlement: true` +- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: +```json +{ + "name": "groups", + "type": "STRING", + "schema": { + "type": "CONNECTOR_SCHEMA", + "id": "2c9180887671ff8c01767b4671fc7d60", + "name": "group" + }, + "description": "The groups, roles etc. that reference account group objects", + "isMulti": true, + "isEntitlement": true, + "isGroup": true +} +``` + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-source-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**schemaId** | **string** | The Schema id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | The JSONPatch payload used to update the schema. | + +### Return type + +[**Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + jsonpatchoperation := []byte(`[{op=add, path=/attributes/-, value={name=location, type=STRING, schema=null, description=Employee location, isMulti=false, isEntitlement=false, isGroup=false}}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schema. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.UpdateSourceSchema(context.Background(), sourceId, schemaId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.UpdateSourceSchema(context.Background(), sourceId, schemaId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SuggestedEntitlementDescriptionAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SuggestedEntitlementDescriptionAPI.md new file mode 100644 index 000000000..e96e6e74c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SuggestedEntitlementDescriptionAPI.md @@ -0,0 +1,531 @@ +--- +id: v2024-suggested-entitlement-description +title: SuggestedEntitlementDescription +pagination_label: SuggestedEntitlementDescription +sidebar_label: SuggestedEntitlementDescription +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SuggestedEntitlementDescription', 'V2024SuggestedEntitlementDescription'] +slug: /tools/sdk/go/v2024/methods/suggested-entitlement-description +tags: ['SDK', 'Software Development Kit', 'SuggestedEntitlementDescription', 'V2024SuggestedEntitlementDescription'] +--- + +# SuggestedEntitlementDescriptionAPI + Use this API to implement Suggested Entitlement Description (SED) functionality. +SED functionality leverages the power of LLM to generate suggested entitlement descriptions. +Refer to [GenAI Entitlement Descriptions](https://documentation.sailpoint.com/saas/help/access/entitlements.html#genai-entitlement-descriptions) to learn more about SED in Identity Security Cloud (ISC). + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-sed-batch-stats**](#get-sed-batch-stats) | **Get** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit Sed Batch Stats Request +[**get-sed-batches**](#get-sed-batches) | **Get** `/suggested-entitlement-description-batches` | List Sed Batch Request +[**list-seds**](#list-seds) | **Get** `/suggested-entitlement-descriptions` | List Suggested Entitlement Descriptions +[**patch-sed**](#patch-sed) | **Patch** `/suggested-entitlement-descriptions` | Patch Suggested Entitlement Description +[**submit-sed-approval**](#submit-sed-approval) | **Post** `/suggested-entitlement-description-approvals` | Submit Bulk Approval Request +[**submit-sed-assignment**](#submit-sed-assignment) | **Post** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request +[**submit-sed-batch-request**](#submit-sed-batch-request) | **Post** `/suggested-entitlement-description-batches` | Submit Sed Batch Request + + +## get-sed-batch-stats +Submit Sed Batch Stats Request +'Submit Sed Batch Stats Request. + + Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats + of the batchId.' + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sed-batch-stats) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**batchId** | **string** | Batch Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSedBatchStatsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SedBatchStats**](../models/sed-batch-stats) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + batchId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | Batch Id # string | Batch Id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.GetSedBatchStats(context.Background(), batchId).Execute() + //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.GetSedBatchStats(context.Background(), batchId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatchStats``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSedBatchStats`: SedBatchStats + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatchStats`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sed-batches +List Sed Batch Request +List Sed Batches. +API responses with Sed Batch Status + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sed-batches) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSedBatchesRequest struct via the builder pattern + + +### Return type + +[**SedBatchStatus**](../models/sed-batch-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatches``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSedBatches`: SedBatchStatus + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatches`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-seds +List Suggested Entitlement Descriptions +List of Suggested Entitlement Descriptions (SED) + +SED field descriptions: + +**batchId**: the ID of the batch of entitlements that are submitted for description generation + +**displayName**: the display name of the entitlement that we are generating a description for + +**sourceName**: the name of the source associated with the entitlement that we are generating the description for + +**sourceId**: the ID of the source associated with the entitlement that we are generating the description for + +**status**: the status of the suggested entitlement description, valid status options: "requested", "suggested", "not_suggested", "failed", "assigned", "approved", "denied" + +**fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-seds) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSedsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* | + **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: **displayName, sourceName, status** | + **countOnly** | **bool** | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. | [default to false] + **requestedByAnyone** | **bool** | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested | [default to false] + **showPendingStatusOnly** | **bool** | Will limit records to items that are in \"suggested\" or \"approved\" status | [default to false] + +### Return type + +[**[]Sed**](../models/sed) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `displayName co "Read and Write"` // 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) + sorters := `sorters=displayName` // 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: **displayName, sourceName, status** (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: **displayName, sourceName, status** (optional) + countOnly := count-only=true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) + requestedByAnyone := requested-by-anyone=true // bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to false) # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to false) + showPendingStatusOnly := show-pending-status-only=true // bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to false) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.ListSeds(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.ListSeds(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).CountOnly(countOnly).RequestedByAnyone(requestedByAnyone).ShowPendingStatusOnly(showPendingStatusOnly).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.ListSeds``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSeds`: []Sed + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.ListSeds`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-sed +Patch Suggested Entitlement Description +Patch Suggested Entitlement Description + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sed) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | id is sed id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSedRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **sedPatch** | [**[]SedPatch**](../models/sed-patch) | Sed Patch Request | + +### Return type + +[**Sed**](../models/sed) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ebab396f-0af1-4050-89b7-dafc63ec70e7` // string | id is sed id # string | id is sed id + sedpatch := []byte(``) // []SedPatch | Sed Patch Request + + + var sedPatch v2024.[]SedPatch + if err := json.Unmarshal(sedpatch, &sedPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.PatchSed(context.Background(), id).SedPatch(sedPatch).Execute() + //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.PatchSed(context.Background(), id).SedPatch(sedPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.PatchSed``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSed`: Sed + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.PatchSed`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-sed-approval +Submit Bulk Approval Request +Submit Bulk Approval Request for SED. +Request body takes list of SED Ids. API responses with list of SED Approval Status + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-sed-approval) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitSedApprovalRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sedApproval** | [**[]SedApproval**](../models/sed-approval) | Sed Approval | + +### Return type + +[**[]SedApprovalStatus**](../models/sed-approval-status) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sedapproval := []byte(``) // []SedApproval | Sed Approval + + + var sedApproval v2024.[]SedApproval + if err := json.Unmarshal(sedapproval, &sedApproval); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.SubmitSedApproval(context.Background()).SedApproval(sedApproval).Execute() + //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.SubmitSedApproval(context.Background()).SedApproval(sedApproval).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedApproval`: []SedApprovalStatus + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedApproval`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-sed-assignment +Submit Sed Assignment Request +Submit Assignment Request. +Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-sed-assignment) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitSedAssignmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sedAssignment** | [**SedAssignment**](../models/sed-assignment) | Sed Assignment Request | + +### Return type + +[**SedAssignmentResponse**](../models/sed-assignment-response) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sedassignment := []byte(`{ + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] + }`) // SedAssignment | Sed Assignment Request + + + var sedAssignment v2024.SedAssignment + if err := json.Unmarshal(sedassignment, &sedAssignment); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.SubmitSedAssignment(context.Background()).SedAssignment(sedAssignment).Execute() + //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.SubmitSedAssignment(context.Background()).SedAssignment(sedAssignment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedAssignment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedAssignment`: SedAssignmentResponse + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedAssignment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-sed-batch-request +Submit Sed Batch Request +Submit Sed Batch Request. +Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-sed-batch-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitSedBatchRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sedBatchRequest** | [**SedBatchRequest**](../models/sed-batch-request) | Sed Batch Request | + +### Return type + +[**SedBatchResponse**](../models/sed-batch-response) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sedbatchrequest := []byte(`{ + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + }`) // SedBatchRequest | Sed Batch Request (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest(context.Background()).SedBatchRequest(sedBatchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedBatchRequest`: SedBatchResponse + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/TaggedObjectsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/TaggedObjectsAPI.md new file mode 100644 index 000000000..7872bee0f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/TaggedObjectsAPI.md @@ -0,0 +1,678 @@ +--- +id: v2024-tagged-objects +title: TaggedObjects +pagination_label: TaggedObjects +sidebar_label: TaggedObjects +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaggedObjects', 'V2024TaggedObjects'] +slug: /tools/sdk/go/v2024/methods/tagged-objects +tags: ['SDK', 'Software Development Kit', 'TaggedObjects', 'V2024TaggedObjects'] +--- + +# TaggedObjectsAPI + Use this API to implement object tagging functionality. +With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches Identity Security Cloud. + +In Identity Security Cloud, users can search their tenants for information and add tags objects they find. +Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future. + +For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. +Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. +The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. +When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag. + +With the API, you can tag even more different object types than you can in Identity Security Cloud (access profiles, entitlements, identities, and roles). +You can use the API to tag all these objects: + +- Access profiles + +- Applications + +- Certification campaigns + +- Entitlements + +- Identities + +- Roles + +- SOD (separation of duties) policies + +- Sources + +You can also use the API to directly find, create, and manage tagged objects without using search queries. + +There are limits to tags: + +- You can have up to 500 different tags in your tenant. + +- You can apply up to 30 tags to one object. + +- You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant. + +Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by Identity Security Cloud. + +These are the types of information often expressed in tags: + +- Affected departments + +- Compliance and regulatory categories + +- Remediation urgency levels + +- Risk levels + +Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-tagged-object**](#delete-tagged-object) | **Delete** `/tagged-objects/{type}/{id}` | Delete Object Tags +[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **Post** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects +[**get-tagged-object**](#get-tagged-object) | **Get** `/tagged-objects/{type}/{id}` | Get Tagged Object +[**list-tagged-objects**](#list-tagged-objects) | **Get** `/tagged-objects` | List Tagged Objects +[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **Get** `/tagged-objects/{type}` | List Tagged Objects by Type +[**put-tagged-object**](#put-tagged-object) | **Put** `/tagged-objects/{type}/{id}` | Update Tagged Object +[**set-tag-to-object**](#set-tag-to-object) | **Post** `/tagged-objects` | Add Tag to Object +[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **Post** `/tagged-objects/bulk-add` | Tag Multiple Objects + + +## delete-tagged-object +Delete Object Tags +Delete all tags from a tagged object. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-tagged-object) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**type_** | **string** | The type of object to delete tags from. | +**id** | **string** | The ID of the object to delete tags from. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteTaggedObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `ROLE` // string | The type of object to delete tags from. # string | The type of object to delete tags from. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object to delete tags from. # string | The ID of the object to delete tags from. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.TaggedObjectsAPI.DeleteTaggedObject(context.Background(), type_, id).Execute() + //r, err := apiClient.V2024.TaggedObjectsAPI.DeleteTaggedObject(context.Background(), type_, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.DeleteTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-tags-to-many-object +Remove Tags from Multiple Objects +This API removes tags from multiple objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-tags-to-many-object) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteTagsToManyObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulkRemoveTaggedObject** | [**BulkRemoveTaggedObject**](../models/bulk-remove-tagged-object) | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + bulkremovetaggedobject := []byte(`{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // BulkRemoveTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + + var bulkRemoveTaggedObject v2024.BulkRemoveTaggedObject + if err := json.Unmarshal(bulkremovetaggedobject, &bulkRemoveTaggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.TaggedObjectsAPI.DeleteTagsToManyObject(context.Background()).BulkRemoveTaggedObject(bulkRemoveTaggedObject).Execute() + //r, err := apiClient.V2024.TaggedObjectsAPI.DeleteTagsToManyObject(context.Background()).BulkRemoveTaggedObject(bulkRemoveTaggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.DeleteTagsToManyObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-tagged-object +Get Tagged Object +This gets a tagged object for the specified type. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tagged-object) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**type_** | **string** | The type of tagged object to retrieve. | +**id** | **string** | The ID of the object reference to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTaggedObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**TaggedObject**](../models/tagged-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `ROLE` // string | The type of tagged object to retrieve. # string | The type of tagged object to retrieve. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to retrieve. # string | The ID of the object reference to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TaggedObjectsAPI.GetTaggedObject(context.Background(), type_, id).Execute() + //resp, r, err := apiClient.V2024.TaggedObjectsAPI.GetTaggedObject(context.Background(), type_, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.GetTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaggedObject`: TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.GetTaggedObject`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-tagged-objects +List Tagged Objects +This API returns a list of all tagged objects. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-tagged-objects) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTaggedObjectsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* | + +### Return type + +[**[]TaggedObject**](../models/tagged-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `tagName eq "BU_FINANCE"` // 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TaggedObjectsAPI.ListTaggedObjects(context.Background()).Execute() + //resp, r, err := apiClient.V2024.TaggedObjectsAPI.ListTaggedObjects(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.ListTaggedObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTaggedObjects`: []TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.ListTaggedObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-tagged-objects-by-type +List Tagged Objects by Type +This API returns a list of all tagged objects by type. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-tagged-objects-by-type) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**type_** | **string** | The type of tagged object to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTaggedObjectsByTypeRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **objectRef.id**: *eq* **objectRef.type**: *eq* | + +### Return type + +[**[]TaggedObject**](../models/tagged-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `ROLE` // string | The type of tagged object to retrieve. # string | The type of tagged object to retrieve. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `objectRef.id eq "2c91808568c529c60168cca6f90c1313"` // 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: **objectRef.id**: *eq* **objectRef.type**: *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: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TaggedObjectsAPI.ListTaggedObjectsByType(context.Background(), type_).Execute() + //resp, r, err := apiClient.V2024.TaggedObjectsAPI.ListTaggedObjectsByType(context.Background(), type_).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.ListTaggedObjectsByType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTaggedObjectsByType`: []TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.ListTaggedObjectsByType`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-tagged-object +Update Tagged Object +This updates a tagged object for the specified type. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-tagged-object) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**type_** | **string** | The type of tagged object to update. | +**id** | **string** | The ID of the object reference to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutTaggedObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **taggedObject** | [**TaggedObject**](../models/tagged-object) | | + +### Return type + +[**TaggedObject**](../models/tagged-object) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `ROLE` // string | The type of tagged object to update. # string | The type of tagged object to update. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to update. # string | The ID of the object reference to update. + taggedobject := []byte(`{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // TaggedObject | + + + var taggedObject v2024.TaggedObject + if err := json.Unmarshal(taggedobject, &taggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TaggedObjectsAPI.PutTaggedObject(context.Background(), type_, id).TaggedObject(taggedObject).Execute() + //resp, r, err := apiClient.V2024.TaggedObjectsAPI.PutTaggedObject(context.Background(), type_, id).TaggedObject(taggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.PutTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutTaggedObject`: TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.PutTaggedObject`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-tag-to-object +Add Tag to Object +This adds a tag to an object. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-tag-to-object) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetTagToObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **taggedObject** | [**TaggedObject**](../models/tagged-object) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + taggedobject := []byte(`{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // TaggedObject | + + + var taggedObject v2024.TaggedObject + if err := json.Unmarshal(taggedobject, &taggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.TaggedObjectsAPI.SetTagToObject(context.Background()).TaggedObject(taggedObject).Execute() + //r, err := apiClient.V2024.TaggedObjectsAPI.SetTagToObject(context.Background()).TaggedObject(taggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.SetTagToObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## set-tags-to-many-objects +Tag Multiple Objects +This API adds tags to multiple objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-tags-to-many-objects) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetTagsToManyObjectsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulkAddTaggedObject** | [**BulkAddTaggedObject**](../models/bulk-add-tagged-object) | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. | + +### Return type + +[**[]BulkTaggedObjectResponse**](../models/bulk-tagged-object-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + bulkaddtaggedobject := []byte(`{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // BulkAddTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + + var bulkAddTaggedObject v2024.BulkAddTaggedObject + if err := json.Unmarshal(bulkaddtaggedobject, &bulkAddTaggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TaggedObjectsAPI.SetTagsToManyObjects(context.Background()).BulkAddTaggedObject(bulkAddTaggedObject).Execute() + //resp, r, err := apiClient.V2024.TaggedObjectsAPI.SetTagsToManyObjects(context.Background()).BulkAddTaggedObject(bulkAddTaggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.SetTagsToManyObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetTagsToManyObjects`: []BulkTaggedObjectResponse + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.SetTagsToManyObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/TaskManagementAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/TaskManagementAPI.md new file mode 100644 index 000000000..9957adcb4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/TaskManagementAPI.md @@ -0,0 +1,430 @@ +--- +id: v2024-task-management +title: TaskManagement +pagination_label: TaskManagement +sidebar_label: TaskManagement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskManagement', 'V2024TaskManagement'] +slug: /tools/sdk/go/v2024/methods/task-management +tags: ['SDK', 'Software Development Kit', 'TaskManagement', 'V2024TaskManagement'] +--- + +# TaskManagementAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-pending-task-headers**](#get-pending-task-headers) | **Head** `/task-status/pending-tasks` | Retrieve Pending Task List Headers +[**get-pending-tasks**](#get-pending-tasks) | **Get** `/task-status/pending-tasks` | Retrieve Pending Task Status List +[**get-task-status**](#get-task-status) | **Get** `/task-status/{id}` | Get Task Status by ID +[**get-task-status-list**](#get-task-status-list) | **Get** `/task-status` | Retrieve Task Status List +[**update-task-status**](#update-task-status) | **Patch** `/task-status/{id}` | Update Task Status by ID + + +## get-pending-task-headers +:::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 + ``` +::: +Retrieve Pending Task List Headers +Responds with headers only for list of task statuses for pending tasks. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-pending-task-headers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPendingTaskHeadersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.TaskManagementAPI.GetPendingTaskHeaders(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.TaskManagementAPI.GetPendingTaskHeaders(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetPendingTaskHeaders``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-pending-tasks +:::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 + ``` +::: +Retrieve Pending Task Status List +Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPendingTasksRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]TaskStatus**](../models/task-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TaskManagementAPI.GetPendingTasks(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.TaskManagementAPI.GetPendingTasks(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetPendingTasks``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPendingTasks`: []TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetPendingTasks`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-task-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 + ``` +::: +Get Task Status by ID +Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-task-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Task ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTaskStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**TaskStatus**](../models/task-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `00eebcf881994e419d72e757fd30dc0e` // string | Task ID. # string | Task 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.TaskManagementAPI.GetTaskStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.TaskManagementAPI.GetTaskStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetTaskStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaskStatus`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetTaskStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-task-status-list +:::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 + ``` +::: +Retrieve Task Status List +Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-task-status-list) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTaskStatusListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* | + **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: **created** | + +### Return type + +[**[]TaskStatus**](../models/task-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `completionStatus eq "Success"` // 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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) + sorters := `-created` // 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: **created** (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: **created** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TaskManagementAPI.GetTaskStatusList(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.TaskManagementAPI.GetTaskStatusList(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetTaskStatusList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaskStatusList`: []TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetTaskStatusList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-task-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 + ``` +::: +Update Task Status by ID +Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-task-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Task ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateTaskStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | The JSONPatch payload used to update the object. | + +### Return type + +[**TaskStatus**](../models/task-status) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `00eebcf881994e419d72e757fd30dc0e` // string | Task ID. # string | Task 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") + jsonpatchoperation := []byte(``) // []JsonPatchOperation | The JSONPatch payload used to update the object. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TaskManagementAPI.UpdateTaskStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.TaskManagementAPI.UpdateTaskStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.UpdateTaskStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateTaskStatus`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.UpdateTaskStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/TenantAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/TenantAPI.md new file mode 100644 index 000000000..a6a31bdfb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/TenantAPI.md @@ -0,0 +1,77 @@ +--- +id: v2024-tenant +title: Tenant +pagination_label: Tenant +sidebar_label: Tenant +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Tenant', 'V2024Tenant'] +slug: /tools/sdk/go/v2024/methods/tenant +tags: ['SDK', 'Software Development Kit', 'Tenant', 'V2024Tenant'] +--- + +# TenantAPI + API for reading tenant details. +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-tenant**](#get-tenant) | **Get** `/tenant` | Get Tenant Information. + + +## get-tenant +Get Tenant Information. +This rest endpoint can be used to retrieve tenant details. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTenantRequest struct via the builder pattern + + +### Return type + +[**Tenant**](../models/tenant) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TenantAPI.GetTenant(context.Background()).Execute() + //resp, r, err := apiClient.V2024.TenantAPI.GetTenant(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TenantAPI.GetTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenant`: Tenant + fmt.Fprintf(os.Stdout, "Response from `TenantAPI.GetTenant`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/TenantContextAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/TenantContextAPI.md new file mode 100644 index 000000000..74036b57a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/TenantContextAPI.md @@ -0,0 +1,185 @@ +--- +id: v2024-tenant-context +title: TenantContext +pagination_label: TenantContext +sidebar_label: TenantContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantContext', 'V2024TenantContext'] +slug: /tools/sdk/go/v2024/methods/tenant-context +tags: ['SDK', 'Software Development Kit', 'TenantContext', 'V2024TenantContext'] +--- + +# TenantContextAPI + The purpose of this API is to manage key-value pairs specific to a tenant's context, enabling dynamic configuration and personalized settings per tenant. +Context key-value pairs will consist of common terms and acronyms used within your organization. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-tenant-context**](#get-tenant-context) | **Get** `/tenant-context` | Retrieve tenant context +[**patch-tenant-context**](#patch-tenant-context) | **Patch** `/tenant-context` | Update tenant context + + +## get-tenant-context +:::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 + ``` +::: +Retrieve tenant context +Returns a list of key-value pairs representing the current state of the tenant's context. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant-context) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTenantContextRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**[]GetTenantContext200ResponseInner**](../models/get-tenant-context200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TenantContextAPI.GetTenantContext(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.TenantContextAPI.GetTenantContext(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TenantContextAPI.GetTenantContext``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenantContext`: []GetTenantContext200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `TenantContextAPI.GetTenantContext`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-tenant-context +:::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 tenant context +Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +This endpoint is specifically designed to modify the `/Key/*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. + +Note that each tenant is limited to a maximum of 100 key-value pairs. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-tenant-context) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchTenantContextRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + jsonpatchoperation := []byte(`{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }`) // JsonPatchOperation | + + + var jsonPatchOperation v2024.JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.TenantContextAPI.PatchTenantContext(context.Background()).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //r, err := apiClient.V2024.TenantContextAPI.PatchTenantContext(context.Background()).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TenantContextAPI.PatchTenantContext``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/TransformsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/TransformsAPI.md new file mode 100644 index 000000000..74b47f151 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/TransformsAPI.md @@ -0,0 +1,373 @@ +--- +id: v2024-transforms +title: Transforms +pagination_label: Transforms +sidebar_label: Transforms +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Transforms', 'V2024Transforms'] +slug: /tools/sdk/go/v2024/methods/transforms +tags: ['SDK', 'Software Development Kit', 'Transforms', 'V2024Transforms'] +--- + +# TransformsAPI + The purpose of this API is to expose functionality for the manipulation of Transform objects. +Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having +to write code. + +Refer to [Transforms](https://developer.sailpoint.com/docs/extensibility/transforms/) for more information about transforms. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-transform**](#create-transform) | **Post** `/transforms` | Create transform +[**delete-transform**](#delete-transform) | **Delete** `/transforms/{id}` | Delete a transform +[**get-transform**](#get-transform) | **Get** `/transforms/{id}` | Transform by ID +[**list-transforms**](#list-transforms) | **Get** `/transforms` | List transforms +[**update-transform**](#update-transform) | **Put** `/transforms/{id}` | Update a transform + + +## create-transform +Create transform +Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-transform) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateTransformRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transform** | [**Transform**](../models/transform) | The transform to be created. | + +### Return type + +[**TransformRead**](../models/transform-read) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + transform := []byte(`{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }`) // Transform | The transform to be created. + + + var transform v2024.Transform + if err := json.Unmarshal(transform, &transform); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TransformsAPI.CreateTransform(context.Background()).Transform(transform).Execute() + //resp, r, err := apiClient.V2024.TransformsAPI.CreateTransform(context.Background()).Transform(transform).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.CreateTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.CreateTransform`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-transform +Delete a transform +Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-transform) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the transform to delete | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteTransformRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to delete # string | ID of the transform to delete + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.TransformsAPI.DeleteTransform(context.Background(), id).Execute() + //r, err := apiClient.V2024.TransformsAPI.DeleteTransform(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.DeleteTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-transform +Transform by ID +This API returns the transform specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-transform) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the transform to retrieve | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTransformRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**TransformRead**](../models/transform-read) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to retrieve # string | ID of the transform to retrieve + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TransformsAPI.GetTransform(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.TransformsAPI.GetTransform(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.GetTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.GetTransform`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-transforms +List transforms +Gets a list of all saved transform objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-transforms) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTransformsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **name** | **string** | Name of the transform to retrieve from the list. | + **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: **internal**: *eq* **name**: *eq, sw* | + +### Return type + +[**[]TransformRead**](../models/transform-read) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + name := `ExampleTransformName123` // string | Name of the transform to retrieve from the list. (optional) # string | Name of the transform to retrieve from the list. (optional) + filters := `name eq "Uppercase"` // 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: **internal**: *eq* **name**: *eq, sw* (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: **internal**: *eq* **name**: *eq, sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TransformsAPI.ListTransforms(context.Background()).Execute() + //resp, r, err := apiClient.V2024.TransformsAPI.ListTransforms(context.Background()).Offset(offset).Limit(limit).Count(count).Name(name).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.ListTransforms``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTransforms`: []TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.ListTransforms`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-transform +Update a transform +Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-transform) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the transform to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateTransformRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **transform** | [**Transform**](../models/transform) | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. | + +### Return type + +[**TransformRead**](../models/transform-read) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to update # string | ID of the transform to update + transform := []byte(`{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }`) // Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TransformsAPI.UpdateTransform(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.TransformsAPI.UpdateTransform(context.Background(), id).Transform(transform).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.UpdateTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.UpdateTransform`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/TriggersAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/TriggersAPI.md new file mode 100644 index 000000000..4b5e9d8d8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/TriggersAPI.md @@ -0,0 +1,981 @@ +--- +id: v2024-triggers +title: Triggers +pagination_label: Triggers +sidebar_label: Triggers +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Triggers', 'V2024Triggers'] +slug: /tools/sdk/go/v2024/methods/triggers +tags: ['SDK', 'Software Development Kit', 'Triggers', 'V2024Triggers'] +--- + +# TriggersAPI + Event Triggers provide real-time updates to changes in Identity Security Cloud so you can take action as soon as an event occurs, rather than poll an API endpoint for updates. Identity Security Cloud provides a user interface within the admin console to create and manage trigger subscriptions. These endpoints allow for programatically creating and managing trigger subscriptions. + +There are two types of event triggers: + * `FIRE_AND_FORGET`: This trigger type will send a payload to each subscriber without needing a response. Each trigger of this type has a limit of **50 subscriptions**. + * `REQUEST_RESPONSE`: This trigger type will send a payload to a subscriber and expect a response back. Each trigger of this type may only have **one subscription**. + +## Available Event Triggers +Production ready event triggers that are available in all tenants. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Access Request Dynamic Approval](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-dynamic-approval/) | idn:access-request-dynamic-approver | REQUEST_RESPONSE |After an access request is submitted. Expects the subscriber to respond with the ID of an identity or workgroup to add to the approval workflow. | +| [Access Request Decision](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-decision/) | idn:access-request-post-approval | FIRE_AND_FORGET | After an access request is approved. | +| [Access Request Submitted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-submitted/) | idn:access-request-pre-approval | REQUEST_RESPONSE | After an access request is submitted. Expects the subscriber to respond with an approval decision. | +| [Account Aggregation Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:account-aggregation-completed | FIRE_AND_FORGET | After an account aggregation completed, terminated, failed. | +| Account Attributes Changed | idn:account-attributes-changed | FIRE_AND_FORGET | After an account aggregation, and one or more account attributes have changed. | +| Account Correlated | idn:account-correlated | FIRE_AND_FORGET | After an account is added to an identity. | +| Accounts Collected for Aggregation | idn:aggregation-accounts-collected | FIRE_AND_FORGET | New, changed, and deleted accounts have been gathered during an aggregation and are being processed. | +| Account Uncorrelated | idn:account-uncorrelated | FIRE_AND_FORGET | After an account is removed from an identity. | +| Campaign Activated | idn:campaign-activated | FIRE_AND_FORGET | After a campaign is activated. | +| Campaign Ended | idn:campaign-ended | FIRE_AND_FORGET | After a campaign ends. | +| Campaign Generated | idn:campaign-generated | FIRE_AND_FORGET | After a campaign finishes generating. | +| Certification Signed Off | idn:certification-signed-off | FIRE_AND_FORGET | After a certification is signed off by its reviewer. | +| [Identity Attributes Changed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:identity-attributes-changed | FIRE_AND_FORGET | After One or more identity attributes changed. | +| [Identity Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-created/) | idn:identity-created | FIRE_AND_FORGET | After an identity is created. | +| [Provisioning Action Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) | idn:post-provisioning | FIRE_AND_FORGET | After a provisioning action completed on a source. | +| [Scheduled Search](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/scheduled-search/) | idn:saved-search-complete | FIRE_AND_FORGET | After a scheduled search completed. | +| [Source Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-created/) | idn:source-created | FIRE_AND_FORGET | After a source is created. | +| [Source Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-deleted/) | idn:source-deleted | FIRE_AND_FORGET | After a source is deleted. | +| [Source Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-updated/) | idn:source-updated | FIRE_AND_FORGET | After configuration changes have been made to a source. | +| [VA Cluster Status Change](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/va-cluster-status-change/) | idn:va-cluster-status-change | FIRE_AND_FORGET | After the status of a VA cluster has changed. | + +## Early Access Event Triggers +Triggers that are in-development and not ready for production use. Please contact support to enable these triggers in your tenant. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Identity Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-deleted/) | idn:identity-deleted | FIRE_AND_FORGET | After an identity is deleted. | +| [Source Account Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-created/) | idn:source-account-created | FIRE_AND_FORGET | After a source account is created. | +| [Source Account Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-deleted/) | idn:source-account-deleted | FIRE_AND_FORGET | After a source account is deleted. | +| [Source Account Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-updated/) | idn:source-account-updated | FIRE_AND_FORGET | After a source account is changed. | + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**complete-trigger-invocation**](#complete-trigger-invocation) | **Post** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation +[**create-subscription**](#create-subscription) | **Post** `/trigger-subscriptions` | Create a Subscription +[**delete-subscription**](#delete-subscription) | **Delete** `/trigger-subscriptions/{id}` | Delete a Subscription +[**list-subscriptions**](#list-subscriptions) | **Get** `/trigger-subscriptions` | List Subscriptions +[**list-trigger-invocation-status**](#list-trigger-invocation-status) | **Get** `/trigger-invocations/status` | List Latest Invocation Statuses +[**list-triggers**](#list-triggers) | **Get** `/triggers` | List Triggers +[**patch-subscription**](#patch-subscription) | **Patch** `/trigger-subscriptions/{id}` | Patch a Subscription +[**start-test-trigger-invocation**](#start-test-trigger-invocation) | **Post** `/trigger-invocations/test` | Start a Test Invocation +[**test-subscription-filter**](#test-subscription-filter) | **Post** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter +[**update-subscription**](#update-subscription) | **Put** `/trigger-subscriptions/{id}` | Update a Subscription + + +## complete-trigger-invocation +:::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 + ``` +::: +Complete Trigger Invocation +Completes an invocation to a REQUEST_RESPONSE type trigger. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/complete-trigger-invocation) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the invocation to complete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompleteTriggerInvocationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **completeInvocation** | [**CompleteInvocation**](../models/complete-invocation) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | The ID of the invocation to complete. # string | The ID of the invocation to complete. + 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") + completeinvocation := []byte(`{ + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + }`) // CompleteInvocation | + + + var completeInvocation v2024.CompleteInvocation + if err := json.Unmarshal(completeinvocation, &completeInvocation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.TriggersAPI.CompleteTriggerInvocation(context.Background(), id).XSailPointExperimental(xSailPointExperimental).CompleteInvocation(completeInvocation).Execute() + //r, err := apiClient.V2024.TriggersAPI.CompleteTriggerInvocation(context.Background(), id).XSailPointExperimental(xSailPointExperimental).CompleteInvocation(completeInvocation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.CompleteTriggerInvocation``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## create-subscription +:::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 a Subscription +This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: +* HTTP subscriptions require httpConfig +* EventBridge subscriptions require eventBridgeConfig + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-subscription) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSubscriptionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **subscriptionPostRequest** | [**SubscriptionPostRequest**](../models/subscription-post-request) | | + +### Return type + +[**Subscription**](../models/subscription) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + subscriptionpostrequest := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "triggerId" : "idn:access-requested", + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + }`) // SubscriptionPostRequest | + + + var subscriptionPostRequest v2024.SubscriptionPostRequest + if err := json.Unmarshal(subscriptionpostrequest, &subscriptionPostRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TriggersAPI.CreateSubscription(context.Background()).XSailPointExperimental(xSailPointExperimental).SubscriptionPostRequest(subscriptionPostRequest).Execute() + //resp, r, err := apiClient.V2024.TriggersAPI.CreateSubscription(context.Background()).XSailPointExperimental(xSailPointExperimental).SubscriptionPostRequest(subscriptionPostRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.CreateSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.CreateSubscription`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-subscription +:::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 a Subscription +Deletes an existing subscription to a trigger. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-subscription) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Subscription ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSubscriptionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | Subscription ID # string | Subscription 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.TriggersAPI.DeleteSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.TriggersAPI.DeleteSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.DeleteSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## list-subscriptions +:::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 Subscriptions +Gets a list of all trigger subscriptions. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-subscriptions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSubscriptionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **triggerId**: *eq* **type**: *eq, le* | + **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: **triggerId, triggerName** | + +### Return type + +[**[]Subscription**](../models/subscription) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"` // 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* **triggerId**: *eq* **type**: *eq, le* (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* **triggerId**: *eq* **type**: *eq, le* (optional) + sorters := `triggerName` // 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: **triggerId, triggerName** (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: **triggerId, triggerName** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TriggersAPI.ListSubscriptions(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.TriggersAPI.ListSubscriptions(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListSubscriptions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSubscriptions`: []Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListSubscriptions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-trigger-invocation-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 + ``` +::: +List Latest Invocation Statuses +Gets a list of latest invocation statuses. +Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. +This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-trigger-invocation-status) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTriggerInvocationStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **triggerId**: *eq* **subscriptionId**: *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: **triggerId, subscriptionName, created, completed** | + +### Return type + +[**[]InvocationStatus**](../models/invocation-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `triggerId eq "idn:access-request-dynamic-approver"` // 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: **triggerId**: *eq* **subscriptionId**: *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: **triggerId**: *eq* **subscriptionId**: *eq* (optional) + sorters := `created` // 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: **triggerId, subscriptionName, created, completed** (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: **triggerId, subscriptionName, created, completed** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TriggersAPI.ListTriggerInvocationStatus(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.TriggersAPI.ListTriggerInvocationStatus(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListTriggerInvocationStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTriggerInvocationStatus`: []InvocationStatus + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListTriggerInvocationStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-triggers +:::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 Triggers +Gets a list of triggers that are available in the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-triggers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTriggersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ge, le* | + **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: **id, name** | + +### Return type + +[**[]Trigger**](../models/trigger) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "idn:access-request-post-approval"` // 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, ge, le* (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, ge, le* (optional) + sorters := `name` // 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: **id, name** (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: **id, name** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TriggersAPI.ListTriggers(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.TriggersAPI.ListTriggers(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListTriggers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTriggers`: []Trigger + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListTriggers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-subscription +:::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 + ``` +::: +Patch a Subscription +This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: + +**name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-subscription) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Subscription to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSubscriptionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **subscriptionPatchRequestInner** | [**[]SubscriptionPatchRequestInner**](../models/subscription-patch-request-inner) | | + +### Return type + +[**Subscription**](../models/subscription) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | ID of the Subscription to patch # string | ID of the Subscription to patch + 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") + subscriptionpatchrequestinner := []byte(``) // []SubscriptionPatchRequestInner | + + + var subscriptionPatchRequestInner v2024.[]SubscriptionPatchRequestInner + if err := json.Unmarshal(subscriptionpatchrequestinner, &subscriptionPatchRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TriggersAPI.PatchSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SubscriptionPatchRequestInner(subscriptionPatchRequestInner).Execute() + //resp, r, err := apiClient.V2024.TriggersAPI.PatchSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SubscriptionPatchRequestInner(subscriptionPatchRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.PatchSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.PatchSubscription`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-test-trigger-invocation +:::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 + ``` +::: +Start a Test Invocation +Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-test-trigger-invocation) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartTestTriggerInvocationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **testInvocation** | [**TestInvocation**](../models/test-invocation) | | + +### Return type + +[**[]Invocation**](../models/invocation) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + testinvocation := []byte(`{ + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } + }`) // TestInvocation | + + + var testInvocation v2024.TestInvocation + if err := json.Unmarshal(testinvocation, &testInvocation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TriggersAPI.StartTestTriggerInvocation(context.Background()).XSailPointExperimental(xSailPointExperimental).TestInvocation(testInvocation).Execute() + //resp, r, err := apiClient.V2024.TriggersAPI.StartTestTriggerInvocation(context.Background()).XSailPointExperimental(xSailPointExperimental).TestInvocation(testInvocation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.StartTestTriggerInvocation``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartTestTriggerInvocation`: []Invocation + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.StartTestTriggerInvocation`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-subscription-filter +:::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 + ``` +::: +Validate a Subscription Filter +Validates a JSONPath filter expression against a provided mock input. +Request requires a security scope of: + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-subscription-filter) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestSubscriptionFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **validateFilterInputDto** | [**ValidateFilterInputDto**](../models/validate-filter-input-dto) | | + +### Return type + +[**ValidateFilterOutputDto**](../models/validate-filter-output-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + validatefilterinputdto := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + }`) // ValidateFilterInputDto | + + + var validateFilterInputDto v2024.ValidateFilterInputDto + if err := json.Unmarshal(validatefilterinputdto, &validateFilterInputDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TriggersAPI.TestSubscriptionFilter(context.Background()).XSailPointExperimental(xSailPointExperimental).ValidateFilterInputDto(validateFilterInputDto).Execute() + //resp, r, err := apiClient.V2024.TriggersAPI.TestSubscriptionFilter(context.Background()).XSailPointExperimental(xSailPointExperimental).ValidateFilterInputDto(validateFilterInputDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.TestSubscriptionFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSubscriptionFilter`: ValidateFilterOutputDto + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.TestSubscriptionFilter`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-subscription +:::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 a Subscription +This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing + Subscription is completely replaced. The following fields are immutable: + + + * id + + * triggerId + + + Attempts to modify these fields result in 400. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-subscription) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Subscription ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSubscriptionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **subscriptionPutRequest** | [**SubscriptionPutRequest**](../models/subscription-put-request) | | + +### Return type + +[**Subscription**](../models/subscription) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | Subscription ID # string | Subscription 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") + subscriptionputrequest := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + }`) // SubscriptionPutRequest | + + + var subscriptionPutRequest v2024.SubscriptionPutRequest + if err := json.Unmarshal(subscriptionputrequest, &subscriptionPutRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TriggersAPI.UpdateSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SubscriptionPutRequest(subscriptionPutRequest).Execute() + //resp, r, err := apiClient.V2024.TriggersAPI.UpdateSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SubscriptionPutRequest(subscriptionPutRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.UpdateSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.UpdateSubscription`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/UIMetadataAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/UIMetadataAPI.md new file mode 100644 index 000000000..deb0480a6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/UIMetadataAPI.md @@ -0,0 +1,180 @@ +--- +id: v2024-ui-metadata +title: UIMetadata +pagination_label: UIMetadata +sidebar_label: UIMetadata +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UIMetadata', 'V2024UIMetadata'] +slug: /tools/sdk/go/v2024/methods/ui-metadata +tags: ['SDK', 'Software Development Kit', 'UIMetadata', 'V2024UIMetadata'] +--- + +# UIMetadataAPI + API for managing UI Metadata. Use this API to manage metadata about your User Interface. +For example you can set the iFrameWhitelist parameter to permit another domain to encapsulate IDN within an iframe or set the usernameEmptyText to change the placeholder text for Username on your tenant's login screen. +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-tenant-ui-metadata**](#get-tenant-ui-metadata) | **Get** `/ui-metadata/tenant` | Get a tenant UI metadata +[**set-tenant-ui-metadata**](#set-tenant-ui-metadata) | **Put** `/ui-metadata/tenant` | Update tenant UI metadata + + +## get-tenant-ui-metadata +:::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 a tenant UI metadata +This API endpoint retrieves UI metadata configured for your tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant-ui-metadata) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTenantUiMetadataRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.UIMetadataAPI.GetTenantUiMetadata(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.UIMetadataAPI.GetTenantUiMetadata(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `UIMetadataAPI.GetTenantUiMetadata``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenantUiMetadata`: TenantUiMetadataItemResponse + fmt.Fprintf(os.Stdout, "Response from `UIMetadataAPI.GetTenantUiMetadata`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-tenant-ui-metadata +:::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 tenant UI metadata +This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-tenant-ui-metadata) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetTenantUiMetadataRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **tenantUiMetadataItemUpdateRequest** | [**TenantUiMetadataItemUpdateRequest**](../models/tenant-ui-metadata-item-update-request) | | + +### Return type + +[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + tenantuimetadataitemupdaterequest := []byte(`{ + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" + }`) // TenantUiMetadataItemUpdateRequest | + + + var tenantUiMetadataItemUpdateRequest v2024.TenantUiMetadataItemUpdateRequest + if err := json.Unmarshal(tenantuimetadataitemupdaterequest, &tenantUiMetadataItemUpdateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.UIMetadataAPI.SetTenantUiMetadata(context.Background()).XSailPointExperimental(xSailPointExperimental).TenantUiMetadataItemUpdateRequest(tenantUiMetadataItemUpdateRequest).Execute() + //resp, r, err := apiClient.V2024.UIMetadataAPI.SetTenantUiMetadata(context.Background()).XSailPointExperimental(xSailPointExperimental).TenantUiMetadataItemUpdateRequest(tenantUiMetadataItemUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `UIMetadataAPI.SetTenantUiMetadata``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetTenantUiMetadata`: TenantUiMetadataItemResponse + fmt.Fprintf(os.Stdout, "Response from `UIMetadataAPI.SetTenantUiMetadata`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/VendorConnectorMappingsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/VendorConnectorMappingsAPI.md new file mode 100644 index 000000000..3ecdff766 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/VendorConnectorMappingsAPI.md @@ -0,0 +1,266 @@ +--- +id: v2024-vendor-connector-mappings +title: VendorConnectorMappings +pagination_label: VendorConnectorMappings +sidebar_label: VendorConnectorMappings +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappings', 'V2024VendorConnectorMappings'] +slug: /tools/sdk/go/v2024/methods/vendor-connector-mappings +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappings', 'V2024VendorConnectorMappings'] +--- + +# VendorConnectorMappingsAPI + Vendors use ISC connectors to connect their source data to ISC, but the data in their source and the data in ISC may be stored in different formats. +Connector mappings allow vendors to match their data on both sides of the connection. +The vendors can then track and manage access across their sources from ISC. +This API allows you to create and manage these vendor connector mappings. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **Post** `/vendor-connector-mappings` | Create Vendor Connector Mapping +[**delete-vendor-connector-mapping**](#delete-vendor-connector-mapping) | **Delete** `/vendor-connector-mappings` | Delete Vendor Connector Mapping +[**get-vendor-connector-mappings**](#get-vendor-connector-mappings) | **Get** `/vendor-connector-mappings` | List Vendor Connector Mappings + + +## create-vendor-connector-mapping +Create Vendor Connector Mapping +Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-vendor-connector-mapping) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateVendorConnectorMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vendorConnectorMapping** | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | | + +### Return type + +[**VendorConnectorMapping**](../models/vendor-connector-mapping) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + vendorconnectormapping := []byte(`{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }`) // VendorConnectorMapping | + + + var vendorConnectorMapping v2024.VendorConnectorMapping + if err := json.Unmarshal(vendorconnectormapping, &vendorConnectorMapping); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.VendorConnectorMappingsAPI.CreateVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + //resp, r, err := apiClient.V2024.VendorConnectorMappingsAPI.CreateVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.CreateVendorConnectorMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateVendorConnectorMapping`: VendorConnectorMapping + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.CreateVendorConnectorMapping`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-vendor-connector-mapping +Delete Vendor Connector Mapping +Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-vendor-connector-mapping) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteVendorConnectorMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vendorConnectorMapping** | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | | + +### Return type + +[**DeleteVendorConnectorMapping200Response**](../models/delete-vendor-connector-mapping200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + vendorconnectormapping := []byte(`{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }`) // VendorConnectorMapping | + + + var vendorConnectorMapping v2024.VendorConnectorMapping + if err := json.Unmarshal(vendorconnectormapping, &vendorConnectorMapping); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.VendorConnectorMappingsAPI.DeleteVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + //resp, r, err := apiClient.V2024.VendorConnectorMappingsAPI.DeleteVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.DeleteVendorConnectorMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteVendorConnectorMapping`: DeleteVendorConnectorMapping200Response + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.DeleteVendorConnectorMapping`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-vendor-connector-mappings +List Vendor Connector Mappings +Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-vendor-connector-mappings) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetVendorConnectorMappingsRequest struct via the builder pattern + + +### Return type + +[**[]VendorConnectorMapping**](../models/vendor-connector-mapping) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.VendorConnectorMappingsAPI.GetVendorConnectorMappings(context.Background()).Execute() + //resp, r, err := apiClient.V2024.VendorConnectorMappingsAPI.GetVendorConnectorMappings(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.GetVendorConnectorMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetVendorConnectorMappings`: []VendorConnectorMapping + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.GetVendorConnectorMappings`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/WorkItemsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/WorkItemsAPI.md new file mode 100644 index 000000000..c0cd262a8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/WorkItemsAPI.md @@ -0,0 +1,948 @@ +--- +id: v2024-work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItems', 'V2024WorkItems'] +slug: /tools/sdk/go/v2024/methods/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'V2024WorkItems'] +--- + +# WorkItemsAPI + Use this API to implement work item functionality. +With this functionality in place, users can manage their work items (tasks). + +Work items refer to the tasks users see in Identity Security Cloud's Task Manager. +They can see the pending work items they need to complete, as well as the work items they have already completed. +Task Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. +For example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. +Once the user completes the work item, the work item will be listed with his or her other completed work items. + +To complete work items, users can use their dashboards and select the 'My Tasks' widget. +The widget will list any work items they need to complete, and they can select the work item from the list to review its details. +When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. + +Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-approval-item**](#approve-approval-item) | **Post** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item +[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **Post** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items +[**complete-work-item**](#complete-work-item) | **Post** `/work-items/{id}` | Complete a Work Item +[**forward-work-item**](#forward-work-item) | **Post** `/work-items/{id}/forward` | Forward a Work Item +[**get-completed-work-items**](#get-completed-work-items) | **Get** `/work-items/completed` | Completed Work Items +[**get-count-completed-work-items**](#get-count-completed-work-items) | **Get** `/work-items/completed/count` | Count Completed Work Items +[**get-count-work-items**](#get-count-work-items) | **Get** `/work-items/count` | Count Work Items +[**get-work-item**](#get-work-item) | **Get** `/work-items/{id}` | Get a Work Item +[**get-work-items-summary**](#get-work-items-summary) | **Get** `/work-items/summary` | Work Items Summary +[**list-work-items**](#list-work-items) | **Get** `/work-items` | List Work Items +[**reject-approval-item**](#reject-approval-item) | **Post** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item +[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **Post** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items +[**submit-account-selection**](#submit-account-selection) | **Post** `/work-items/{id}/submit-account-selection` | Submit Account Selections + + +## approve-approval-item +Approve an Approval Item +This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-approval-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | +**approvalItemId** | **string** | The ID of the approval item. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiApproveApprovalItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveApprovalItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## approve-approval-items-in-bulk +Bulk approve Approval Items +This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-approval-items-in-bulk) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiApproveApprovalItemsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.ApproveApprovalItemsInBulk(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.ApproveApprovalItemsInBulk(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItemsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveApprovalItemsInBulk`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItemsInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## complete-work-item +Complete a Work Item +This API completes a work item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/complete-work-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompleteWorkItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | **string** | Body is the request payload to create form definition request | + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + body := `body_example` // string | Body is the request payload to create form definition request (optional) # string | Body is the request payload to create form definition request (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.CompleteWorkItem(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.CompleteWorkItem(context.Background(), id).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.CompleteWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompleteWorkItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.CompleteWorkItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## forward-work-item +:::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 + ``` +::: +Forward a Work Item +This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/forward-work-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiForwardWorkItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **workItemForward** | [**WorkItemForward**](../models/work-item-forward) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + 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") + workitemforward := []byte(`{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + }`) // WorkItemForward | + + + var workItemForward v2024.WorkItemForward + if err := json.Unmarshal(workitemforward, &workItemForward); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.WorkItemsAPI.ForwardWorkItem(context.Background(), id).XSailPointExperimental(xSailPointExperimental).WorkItemForward(workItemForward).Execute() + //r, err := apiClient.V2024.WorkItemsAPI.ForwardWorkItem(context.Background(), id).XSailPointExperimental(xSailPointExperimental).WorkItemForward(workItemForward).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ForwardWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-completed-work-items +Completed Work Items +This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-completed-work-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCompletedWorkItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.GetCompletedWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.GetCompletedWorkItems(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCompletedWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCompletedWorkItems`: []WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCompletedWorkItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-count-completed-work-items +:::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 + ``` +::: +Count Completed Work Items +This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-count-completed-work-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCountCompletedWorkItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **ownerId** | **string** | ID of the work item owner. | + +### Return type + +[**WorkItemsCount**](../models/work-items-count) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + ownerId := `ownerId_example` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.GetCountCompletedWorkItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.GetCountCompletedWorkItems(context.Background()).XSailPointExperimental(xSailPointExperimental).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCountCompletedWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCountCompletedWorkItems`: WorkItemsCount + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCountCompletedWorkItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-count-work-items +Count Work Items +This gets a count of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-count-work-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCountWorkItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | ID of the work item owner. | + +### Return type + +[**WorkItemsCount**](../models/work-items-count) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.GetCountWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.GetCountWorkItems(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCountWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCountWorkItems`: WorkItemsCount + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCountWorkItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-work-item +Get a Work Item +This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-work-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the work item. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the work item. # string | ID of the work item. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.GetWorkItem(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.GetWorkItem(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetWorkItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-work-items-summary +Work Items Summary +This gets a summary of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-work-items-summary) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkItemsSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | ID of the work item owner. | + +### Return type + +[**WorkItemsSummary**](../models/work-items-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.GetWorkItemsSummary(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.GetWorkItemsSummary(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetWorkItemsSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkItemsSummary`: WorkItemsSummary + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetWorkItemsSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-work-items +List Work Items +This gets a collection of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-work-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkItemsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **ownerId** | **string** | ID of the work item owner. | + +### Return type + +[**[]WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.ListWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.ListWorkItems(context.Background()).Limit(limit).Offset(offset).Count(count).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ListWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkItems`: []WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ListWorkItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reject-approval-item +Reject an Approval Item +This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reject-approval-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | +**approvalItemId** | **string** | The ID of the approval item. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRejectApprovalItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.RejectApprovalItem(context.Background(), id, approvalItemId).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.RejectApprovalItem(context.Background(), id, approvalItemId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.RejectApprovalItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectApprovalItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.RejectApprovalItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reject-approval-items-in-bulk +Bulk reject Approval Items +This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reject-approval-items-in-bulk) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRejectApprovalItemsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.RejectApprovalItemsInBulk(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.RejectApprovalItemsInBulk(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.RejectApprovalItemsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectApprovalItemsInBulk`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.RejectApprovalItemsInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-account-selection +Submit Account Selections +This API submits account selections. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-account-selection) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitAccountSelectionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **requestBody** | **map[string]interface{}** | Account Selection Data map, keyed on fieldName | + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + requestBody := {fieldName=fieldValue} // map[string]interface{} | Account Selection Data map, keyed on fieldName # map[string]interface{} | Account Selection Data map, keyed on fieldName + + + var requestBody v2024.RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.SubmitAccountSelection(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.SubmitAccountSelection(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.SubmitAccountSelection``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitAccountSelection`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.SubmitAccountSelection`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/WorkReassignmentAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/WorkReassignmentAPI.md new file mode 100644 index 000000000..efeba7e34 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/WorkReassignmentAPI.md @@ -0,0 +1,765 @@ +--- +id: v2024-work-reassignment +title: WorkReassignment +pagination_label: WorkReassignment +sidebar_label: WorkReassignment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkReassignment', 'V2024WorkReassignment'] +slug: /tools/sdk/go/v2024/methods/work-reassignment +tags: ['SDK', 'Software Development Kit', 'WorkReassignment', 'V2024WorkReassignment'] +--- + +# WorkReassignmentAPI + Use this API to implement work reassignment functionality. + +Work Reassignment allows access request reviews, certifications, and manual provisioning tasks assigned to a user to be reassigned to a different user. This is primarily used for: + +- Temporarily redirecting work for users who are out of office, such as on vacation or sick leave +- Permanently redirecting work for users who should not be assigned these tasks at all, such as senior executives or service identities + +Users can define reassignments for themselves, managers can add them for their team members, and administrators can configure them on any user’s behalf. Work assigned during the specified reassignment timeframes will be automatically reassigned to the designated user as it is created. + +Refer to [Work Reassignment](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html) for more information about this topic. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-reassignment-configuration**](#create-reassignment-configuration) | **Post** `/reassignment-configurations` | Create a Reassignment Configuration +[**delete-reassignment-configuration**](#delete-reassignment-configuration) | **Delete** `/reassignment-configurations/{identityId}/{configType}` | Delete Reassignment Configuration +[**get-evaluate-reassignment-configuration**](#get-evaluate-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate Reassignment Configuration +[**get-reassignment-config-types**](#get-reassignment-config-types) | **Get** `/reassignment-configurations/types` | List Reassignment Config Types +[**get-reassignment-configuration**](#get-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}` | Get Reassignment Configuration +[**get-tenant-config-configuration**](#get-tenant-config-configuration) | **Get** `/reassignment-configurations/tenant-config` | Get Tenant-wide Reassignment Configuration settings +[**list-reassignment-configurations**](#list-reassignment-configurations) | **Get** `/reassignment-configurations` | List Reassignment Configurations +[**put-reassignment-config**](#put-reassignment-config) | **Put** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration +[**put-tenant-configuration**](#put-tenant-configuration) | **Put** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings + + +## create-reassignment-configuration +:::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 a Reassignment Configuration +Creates a new Reassignment Configuration for the specified identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-reassignment-configuration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateReassignmentConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **configurationItemRequest** | [**ConfigurationItemRequest**](../models/configuration-item-request) | | + +### Return type + +[**ConfigurationItemResponse**](../models/configuration-item-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + configurationitemrequest := []byte(`{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }`) // ConfigurationItemRequest | + + + var configurationItemRequest v2024.ConfigurationItemRequest + if err := json.Unmarshal(configurationitemrequest, &configurationItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkReassignmentAPI.CreateReassignmentConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).ConfigurationItemRequest(configurationItemRequest).Execute() + //resp, r, err := apiClient.V2024.WorkReassignmentAPI.CreateReassignmentConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).ConfigurationItemRequest(configurationItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.CreateReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateReassignmentConfiguration`: ConfigurationItemResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.CreateReassignmentConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-reassignment-configuration +:::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 Reassignment Configuration +Deletes a single reassignment configuration for the specified identity + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-reassignment-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | unique identity id | +**configType** | [**ConfigTypeEnum**](../models/) | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteReassignmentConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique identity id + configType := // ConfigTypeEnum | # ConfigTypeEnum | + 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.WorkReassignmentAPI.DeleteReassignmentConfiguration(context.Background(), identityId, configType).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.WorkReassignmentAPI.DeleteReassignmentConfiguration(context.Background(), identityId, configType).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.DeleteReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-evaluate-reassignment-configuration +:::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 + ``` +::: +Evaluate Reassignment Configuration +Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-evaluate-reassignment-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | unique identity id | +**configType** | [**ConfigTypeEnum**](../models/) | Reassignment work type | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEvaluateReassignmentConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **exclusionFilters** | **[]string** | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments | + +### Return type + +[**[]EvaluateResponse**](../models/evaluate-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique identity id + configType := accessRequests // ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type + 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") + exclusionfilters := []byte(`SELF_REVIEW_DELEGATION`) // []string | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkReassignmentAPI.GetEvaluateReassignmentConfiguration(context.Background(), identityId, configType).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.WorkReassignmentAPI.GetEvaluateReassignmentConfiguration(context.Background(), identityId, configType).XSailPointExperimental(xSailPointExperimental).ExclusionFilters(exclusionFilters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetEvaluateReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEvaluateReassignmentConfiguration`: []EvaluateResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetEvaluateReassignmentConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-reassignment-config-types +:::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 Reassignment Config Types +Gets a collection of types which are available in the Reassignment Configuration UI. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-reassignment-config-types) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetReassignmentConfigTypesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**[]ConfigType**](../models/config-type) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkReassignmentAPI.GetReassignmentConfigTypes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.WorkReassignmentAPI.GetReassignmentConfigTypes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetReassignmentConfigTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReassignmentConfigTypes`: []ConfigType + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetReassignmentConfigTypes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-reassignment-configuration +:::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 Reassignment Configuration +Gets the Reassignment Configuration for an identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-reassignment-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | unique identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetReassignmentConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**ConfigurationResponse**](../models/configuration-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `2c91808781a71ddb0181b9090b5c504f` // string | unique identity id # string | unique 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.WorkReassignmentAPI.GetReassignmentConfiguration(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.WorkReassignmentAPI.GetReassignmentConfiguration(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReassignmentConfiguration`: ConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetReassignmentConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-tenant-config-configuration +:::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 Tenant-wide Reassignment Configuration settings +Gets the global Reassignment Configuration settings for the requestor's tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant-config-configuration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTenantConfigConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**TenantConfigurationResponse**](../models/tenant-configuration-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkReassignmentAPI.GetTenantConfigConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.WorkReassignmentAPI.GetTenantConfigConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetTenantConfigConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenantConfigConfiguration`: TenantConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetTenantConfigConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-reassignment-configurations +:::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 Reassignment Configurations +Gets all Reassignment configuration for the current org. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-reassignment-configurations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListReassignmentConfigurationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**[]ConfigurationResponse**](../models/configuration-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkReassignmentAPI.ListReassignmentConfigurations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.WorkReassignmentAPI.ListReassignmentConfigurations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.ListReassignmentConfigurations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListReassignmentConfigurations`: []ConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.ListReassignmentConfigurations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-reassignment-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 Reassignment Configuration +Replaces existing Reassignment configuration for an identity with the newly provided configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-reassignment-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | unique identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutReassignmentConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **configurationItemRequest** | [**ConfigurationItemRequest**](../models/configuration-item-request) | | + +### Return type + +[**ConfigurationItemResponse**](../models/configuration-item-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique 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") + configurationitemrequest := []byte(`{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }`) // ConfigurationItemRequest | + + + var configurationItemRequest v2024.ConfigurationItemRequest + if err := json.Unmarshal(configurationitemrequest, &configurationItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkReassignmentAPI.PutReassignmentConfig(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).ConfigurationItemRequest(configurationItemRequest).Execute() + //resp, r, err := apiClient.V2024.WorkReassignmentAPI.PutReassignmentConfig(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).ConfigurationItemRequest(configurationItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.PutReassignmentConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutReassignmentConfig`: ConfigurationItemResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.PutReassignmentConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-tenant-configuration +:::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 Tenant-wide Reassignment Configuration settings +Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-tenant-configuration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutTenantConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **tenantConfigurationRequest** | [**TenantConfigurationRequest**](../models/tenant-configuration-request) | | + +### Return type + +[**TenantConfigurationResponse**](../models/tenant-configuration-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + tenantconfigurationrequest := []byte(`{ + "configDetails" : { + "disabled" : true + } + }`) // TenantConfigurationRequest | + + + var tenantConfigurationRequest v2024.TenantConfigurationRequest + if err := json.Unmarshal(tenantconfigurationrequest, &tenantConfigurationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkReassignmentAPI.PutTenantConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).TenantConfigurationRequest(tenantConfigurationRequest).Execute() + //resp, r, err := apiClient.V2024.WorkReassignmentAPI.PutTenantConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).TenantConfigurationRequest(tenantConfigurationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.PutTenantConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutTenantConfiguration`: TenantConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.PutTenantConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/WorkflowsAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/WorkflowsAPI.md new file mode 100644 index 000000000..0bf38c350 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Methods/WorkflowsAPI.md @@ -0,0 +1,1294 @@ +--- +id: v2024-workflows +title: Workflows +pagination_label: Workflows +sidebar_label: Workflows +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Workflows', 'V2024Workflows'] +slug: /tools/sdk/go/v2024/methods/workflows +tags: ['SDK', 'Software Development Kit', 'Workflows', 'V2024Workflows'] +--- + +# WorkflowsAPI + Workflows allow administrators to create custom automation scripts directly within Identity Security Cloud. These automation scripts respond to [event triggers](https://developer.sailpoint.com/docs/extensibility/event-triggers/#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the Identity Security Cloud UI. Workflows can be configured via a graphical user interface within Identity Security Cloud, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-workflow-execution**](#cancel-workflow-execution) | **Post** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID +[**create-external-execute-workflow**](#create-external-execute-workflow) | **Post** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger +[**create-workflow**](#create-workflow) | **Post** `/workflows` | Create Workflow +[**create-workflow-external-trigger**](#create-workflow-external-trigger) | **Post** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client +[**delete-workflow**](#delete-workflow) | **Delete** `/workflows/{id}` | Delete Workflow By Id +[**get-workflow**](#get-workflow) | **Get** `/workflows/{id}` | Get Workflow By Id +[**get-workflow-execution**](#get-workflow-execution) | **Get** `/workflow-executions/{id}` | Get Workflow Execution +[**get-workflow-execution-history**](#get-workflow-execution-history) | **Get** `/workflow-executions/{id}/history` | Get Workflow Execution History +[**get-workflow-executions**](#get-workflow-executions) | **Get** `/workflows/{id}/executions` | List Workflow Executions +[**list-complete-workflow-library**](#list-complete-workflow-library) | **Get** `/workflow-library` | List Complete Workflow Library +[**list-workflow-library-actions**](#list-workflow-library-actions) | **Get** `/workflow-library/actions` | List Workflow Library Actions +[**list-workflow-library-operators**](#list-workflow-library-operators) | **Get** `/workflow-library/operators` | List Workflow Library Operators +[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **Get** `/workflow-library/triggers` | List Workflow Library Triggers +[**list-workflows**](#list-workflows) | **Get** `/workflows` | List Workflows +[**patch-workflow**](#patch-workflow) | **Patch** `/workflows/{id}` | Patch Workflow +[**put-workflow**](#put-workflow) | **Put** `/workflows/{id}` | Update Workflow +[**test-external-execute-workflow**](#test-external-execute-workflow) | **Post** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger +[**test-workflow**](#test-workflow) | **Post** `/workflows/{id}/test` | Test Workflow By Id + + +## cancel-workflow-execution +Cancel Workflow Execution by ID +Use this API to cancel a running workflow execution. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-workflow-execution) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The workflow execution ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCancelWorkflowExecutionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | The workflow execution ID # string | The workflow execution ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.WorkflowsAPI.CancelWorkflowExecution(context.Background(), id).Execute() + //r, err := apiClient.V2024.WorkflowsAPI.CancelWorkflowExecution(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CancelWorkflowExecution``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## create-external-execute-workflow +Execute Workflow via External Trigger +This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-external-execute-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateExternalExecuteWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **createExternalExecuteWorkflowRequest** | [**CreateExternalExecuteWorkflowRequest**](../models/create-external-execute-workflow-request) | | + +### Return type + +[**CreateExternalExecuteWorkflow200Response**](../models/create-external-execute-workflow200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + createexternalexecuteworkflowrequest := []byte(``) // CreateExternalExecuteWorkflowRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.CreateExternalExecuteWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.CreateExternalExecuteWorkflow(context.Background(), id).CreateExternalExecuteWorkflowRequest(createExternalExecuteWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateExternalExecuteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateExternalExecuteWorkflow`: CreateExternalExecuteWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateExternalExecuteWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-workflow +Create Workflow +Create a new workflow with the desired trigger and steps specified in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-workflow) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createWorkflowRequest** | [**CreateWorkflowRequest**](../models/create-workflow-request) | | + +### Return type + +[**Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createworkflowrequest := []byte(`{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}`) // CreateWorkflowRequest | + + + var createWorkflowRequest v2024.CreateWorkflowRequest + if err := json.Unmarshal(createworkflowrequest, &createWorkflowRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.CreateWorkflow(context.Background()).CreateWorkflowRequest(createWorkflowRequest).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.CreateWorkflow(context.Background()).CreateWorkflowRequest(createWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-workflow-external-trigger +Generate External Trigger OAuth Client +Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-workflow-external-trigger) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateWorkflowExternalTriggerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**WorkflowOAuthClient**](../models/workflow-o-auth-client) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.CreateWorkflowExternalTrigger(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.CreateWorkflowExternalTrigger(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateWorkflowExternalTrigger``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkflowExternalTrigger`: WorkflowOAuthClient + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateWorkflowExternalTrigger`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-workflow +Delete Workflow By Id +Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the Workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.WorkflowsAPI.DeleteWorkflow(context.Background(), id).Execute() + //r, err := apiClient.V2024.WorkflowsAPI.DeleteWorkflow(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.DeleteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-workflow +Get Workflow By Id +Get a single workflow by id. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.GetWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.GetWorkflow(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-workflow-execution +Get Workflow Execution +Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow-execution) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Workflow execution ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkflowExecutionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Workflow execution ID. # string | Workflow execution ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.GetWorkflowExecution(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.GetWorkflowExecution(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecution``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecution`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecution`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-workflow-execution-history +Get Workflow Execution History +Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow-execution-history) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow execution | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkflowExecutionHistoryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]WorkflowExecutionEvent**](../models/workflow-execution-event) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow execution # string | Id of the workflow execution + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.GetWorkflowExecutionHistory(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.GetWorkflowExecutionHistory(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutionHistory``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecutionHistory`: []WorkflowExecutionEvent + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutionHistory`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-workflow-executions +List Workflow Executions +Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: +1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. +2. Get your workflow ID from the response. +3. You can then do either of the following: + + - Filter to find relevant workflow executions. + For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq "Failed"` + + - Paginate through results with the `offset` parameter. + For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. + Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow-executions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Workflow ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkflowExecutionsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* | + +### Return type + +[**[]WorkflowExecution**](../models/workflow-execution) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Workflow ID. # string | Workflow 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `status eq "Failed"` // 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: **start_time**: *eq, lt, le, gt, ge* **status**: *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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.GetWorkflowExecutions(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.GetWorkflowExecutions(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecutions`: []WorkflowExecution + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-complete-workflow-library +List Complete Workflow Library +This lists all triggers, actions, and operators in the library + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-complete-workflow-library) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCompleteWorkflowLibraryRequest struct via the builder pattern + + +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 + +[**[]ListCompleteWorkflowLibrary200ResponseInner**](../models/list-complete-workflow-library200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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.V2024.WorkflowsAPI.ListCompleteWorkflowLibrary(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.ListCompleteWorkflowLibrary(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListCompleteWorkflowLibrary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCompleteWorkflowLibrary`: []ListCompleteWorkflowLibrary200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListCompleteWorkflowLibrary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workflow-library-actions +List Workflow Library Actions +This lists the workflow actions available to you. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflow-library-actions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkflowLibraryActionsRequest struct via the builder pattern + + +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] + **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* | + +### Return type + +[**[]WorkflowLibraryAction**](../models/workflow-library-action) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + filters := `id eq "sp:create-campaign"` // 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* (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* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.ListWorkflowLibraryActions(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.ListWorkflowLibraryActions(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryActions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryActions`: []WorkflowLibraryAction + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryActions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workflow-library-operators +List Workflow Library Operators +This lists the workflow operators available to you + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflow-library-operators) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkflowLibraryOperatorsRequest struct via the builder pattern + + +### Return type + +[**[]WorkflowLibraryOperator**](../models/workflow-library-operator) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.ListWorkflowLibraryOperators(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.ListWorkflowLibraryOperators(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryOperators``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryOperators`: []WorkflowLibraryOperator + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryOperators`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workflow-library-triggers +List Workflow Library Triggers +This lists the workflow triggers available to you + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflow-library-triggers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkflowLibraryTriggersRequest struct via the builder pattern + + +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] + **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* | + +### Return type + +[**[]WorkflowLibraryTrigger**](../models/workflow-library-trigger) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + filters := `id eq "idn:identity-attributes-changed"` // 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* (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* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.ListWorkflowLibraryTriggers(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.ListWorkflowLibraryTriggers(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryTriggers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryTriggers`: []WorkflowLibraryTrigger + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryTriggers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workflows +List Workflows +List all workflows in the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflows) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkflowsRequest struct via the builder pattern + + +### Return type + +[**[]Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.ListWorkflows(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.ListWorkflows(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflows``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflows`: []Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflows`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-workflow +Patch Workflow +Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the Workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.PatchWorkflow(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.PatchWorkflow(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PatchWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PatchWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-workflow +Update Workflow +Perform a full update of a workflow. The updated workflow object is returned in the response. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the Workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **workflowBody** | [**WorkflowBody**](../models/workflow-body) | | + +### Return type + +[**Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + workflowbody := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : "{}", + "type" : "EVENT" + }, + "enabled" : false + }`) // WorkflowBody | + + + var workflowBody v2024.WorkflowBody + if err := json.Unmarshal(workflowbody, &workflowBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.PutWorkflow(context.Background(), id).WorkflowBody(workflowBody).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.PutWorkflow(context.Background(), id).WorkflowBody(workflowBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PutWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PutWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-external-execute-workflow +Test Workflow via External Trigger +Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-external-execute-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestExternalExecuteWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **testExternalExecuteWorkflowRequest** | [**TestExternalExecuteWorkflowRequest**](../models/test-external-execute-workflow-request) | | + +### Return type + +[**TestExternalExecuteWorkflow200Response**](../models/test-external-execute-workflow200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + testexternalexecuteworkflowrequest := []byte(``) // TestExternalExecuteWorkflowRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.TestExternalExecuteWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.TestExternalExecuteWorkflow(context.Background(), id).TestExternalExecuteWorkflowRequest(testExternalExecuteWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.TestExternalExecuteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestExternalExecuteWorkflow`: TestExternalExecuteWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.TestExternalExecuteWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-workflow +Test Workflow By Id +:::info + +Workflow must be disabled in order to use this endpoint. + +::: + +Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. + +This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. + +**This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **testWorkflowRequest** | [**TestWorkflowRequest**](../models/test-workflow-request) | | + +### Return type + +[**TestWorkflow200Response**](../models/test-workflow200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + testworkflowrequest := []byte(`{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}`) // TestWorkflowRequest | + + + var testWorkflowRequest v2024.TestWorkflowRequest + if err := json.Unmarshal(testworkflowrequest, &testWorkflowRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.TestWorkflow(context.Background(), id).TestWorkflowRequest(testWorkflowRequest).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.TestWorkflow(context.Background(), id).TestWorkflowRequest(testWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.TestWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestWorkflow`: TestWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.TestWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Access.md b/docs/tools/sdk/go/Reference/V2024/Models/Access.md new file mode 100644 index 000000000..066e59ca5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Access.md @@ -0,0 +1,152 @@ +--- +id: v2024-access +title: Access +pagination_label: Access +sidebar_label: Access +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Access', 'V2024Access'] +slug: /tools/sdk/go/v2024/models/access +tags: ['SDK', 'Software Development Kit', 'Access', 'V2024Access'] +--- + +# Access + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] + +## Methods + +### NewAccess + +`func NewAccess() *Access` + +NewAccess instantiates a new Access 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 + +### NewAccessWithDefaults + +`func NewAccessWithDefaults() *Access` + +NewAccessWithDefaults instantiates a new Access 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 + +### GetId + +`func (o *Access) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Access) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Access) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Access) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Access) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Access) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Access) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Access) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *Access) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *Access) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *Access) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *Access) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *Access) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Access) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Access) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Access) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Access) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Access) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessApps.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessApps.md new file mode 100644 index 000000000..ff93be05a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessApps.md @@ -0,0 +1,142 @@ +--- +id: v2024-access-apps +title: AccessApps +pagination_label: AccessApps +sidebar_label: AccessApps +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessApps', 'V2024AccessApps'] +slug: /tools/sdk/go/v2024/models/access-apps +tags: ['SDK', 'Software Development Kit', 'AccessApps', 'V2024AccessApps'] +--- + +# AccessApps + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | Name of application | [optional] +**Description** | Pointer to **string** | Description of application. | [optional] +**Owner** | Pointer to [**AccessAppsOwner**](access-apps-owner) | | [optional] + +## Methods + +### NewAccessApps + +`func NewAccessApps() *AccessApps` + +NewAccessApps instantiates a new AccessApps 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 + +### NewAccessAppsWithDefaults + +`func NewAccessAppsWithDefaults() *AccessApps` + +NewAccessAppsWithDefaults instantiates a new AccessApps 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 + +### GetId + +`func (o *AccessApps) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessApps) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessApps) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessApps) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessApps) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessApps) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessApps) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessApps) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessApps) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessApps) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessApps) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessApps) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *AccessApps) GetOwner() AccessAppsOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *AccessApps) GetOwnerOk() (*AccessAppsOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *AccessApps) SetOwner(v AccessAppsOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *AccessApps) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessAppsOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessAppsOwner.md new file mode 100644 index 000000000..41363c23c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessAppsOwner.md @@ -0,0 +1,142 @@ +--- +id: v2024-access-apps-owner +title: AccessAppsOwner +pagination_label: AccessAppsOwner +sidebar_label: AccessAppsOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessAppsOwner', 'V2024AccessAppsOwner'] +slug: /tools/sdk/go/v2024/models/access-apps-owner +tags: ['SDK', 'Software Development Kit', 'AccessAppsOwner', 'V2024AccessAppsOwner'] +--- + +# AccessAppsOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's DTO type. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's display name. | [optional] +**Email** | Pointer to **string** | Owner's email. | [optional] + +## Methods + +### NewAccessAppsOwner + +`func NewAccessAppsOwner() *AccessAppsOwner` + +NewAccessAppsOwner instantiates a new AccessAppsOwner 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 + +### NewAccessAppsOwnerWithDefaults + +`func NewAccessAppsOwnerWithDefaults() *AccessAppsOwner` + +NewAccessAppsOwnerWithDefaults instantiates a new AccessAppsOwner 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 + +### GetType + +`func (o *AccessAppsOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessAppsOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessAppsOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessAppsOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessAppsOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessAppsOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessAppsOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessAppsOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessAppsOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessAppsOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessAppsOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessAppsOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *AccessAppsOwner) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *AccessAppsOwner) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *AccessAppsOwner) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *AccessAppsOwner) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessConstraint.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessConstraint.md new file mode 100644 index 000000000..ee6cb655b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessConstraint.md @@ -0,0 +1,106 @@ +--- +id: v2024-access-constraint +title: AccessConstraint +pagination_label: AccessConstraint +sidebar_label: AccessConstraint +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessConstraint', 'V2024AccessConstraint'] +slug: /tools/sdk/go/v2024/models/access-constraint +tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'V2024AccessConstraint'] +--- + +# AccessConstraint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of Access | +**Ids** | Pointer to **[]string** | Must be set only if operator is SELECTED. | [optional] +**Operator** | **string** | Used to determine whether the scope of the campaign should be reduced for selected ids or all. | + +## Methods + +### NewAccessConstraint + +`func NewAccessConstraint(type_ string, operator string, ) *AccessConstraint` + +NewAccessConstraint instantiates a new AccessConstraint 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 + +### NewAccessConstraintWithDefaults + +`func NewAccessConstraintWithDefaults() *AccessConstraint` + +NewAccessConstraintWithDefaults instantiates a new AccessConstraint 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 + +### GetType + +`func (o *AccessConstraint) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessConstraint) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessConstraint) SetType(v string)` + +SetType sets Type field to given value. + + +### GetIds + +`func (o *AccessConstraint) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *AccessConstraint) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *AccessConstraint) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *AccessConstraint) HasIds() bool` + +HasIds returns a boolean if a field has been set. + +### GetOperator + +`func (o *AccessConstraint) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *AccessConstraint) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *AccessConstraint) SetOperator(v string)` + +SetOperator sets Operator field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessCriteria.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessCriteria.md new file mode 100644 index 000000000..260410069 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: v2024-access-criteria +title: AccessCriteria +pagination_label: AccessCriteria +sidebar_label: AccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessCriteria', 'V2024AccessCriteria'] +slug: /tools/sdk/go/v2024/models/access-criteria +tags: ['SDK', 'Software Development Kit', 'AccessCriteria', 'V2024AccessCriteria'] +--- + +# AccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Business name for the access construct list | [optional] +**CriteriaList** | Pointer to [**[]AccessCriteriaCriteriaListInner**](access-criteria-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional] + +## Methods + +### NewAccessCriteria + +`func NewAccessCriteria() *AccessCriteria` + +NewAccessCriteria instantiates a new AccessCriteria 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 + +### NewAccessCriteriaWithDefaults + +`func NewAccessCriteriaWithDefaults() *AccessCriteria` + +NewAccessCriteriaWithDefaults instantiates a new AccessCriteria 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 + +### GetName + +`func (o *AccessCriteria) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessCriteria) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessCriteria) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessCriteria) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCriteriaList + +`func (o *AccessCriteria) GetCriteriaList() []AccessCriteriaCriteriaListInner` + +GetCriteriaList returns the CriteriaList field if non-nil, zero value otherwise. + +### GetCriteriaListOk + +`func (o *AccessCriteria) GetCriteriaListOk() (*[]AccessCriteriaCriteriaListInner, bool)` + +GetCriteriaListOk returns a tuple with the CriteriaList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteriaList + +`func (o *AccessCriteria) SetCriteriaList(v []AccessCriteriaCriteriaListInner)` + +SetCriteriaList sets CriteriaList field to given value. + +### HasCriteriaList + +`func (o *AccessCriteria) HasCriteriaList() bool` + +HasCriteriaList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessCriteriaCriteriaListInner.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessCriteriaCriteriaListInner.md new file mode 100644 index 000000000..9afd1e840 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessCriteriaCriteriaListInner.md @@ -0,0 +1,116 @@ +--- +id: v2024-access-criteria-criteria-list-inner +title: AccessCriteriaCriteriaListInner +pagination_label: AccessCriteriaCriteriaListInner +sidebar_label: AccessCriteriaCriteriaListInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessCriteriaCriteriaListInner', 'V2024AccessCriteriaCriteriaListInner'] +slug: /tools/sdk/go/v2024/models/access-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'V2024AccessCriteriaCriteriaListInner'] +--- + +# AccessCriteriaCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the propery to which this reference applies to | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies to | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies to | [optional] + +## Methods + +### NewAccessCriteriaCriteriaListInner + +`func NewAccessCriteriaCriteriaListInner() *AccessCriteriaCriteriaListInner` + +NewAccessCriteriaCriteriaListInner instantiates a new AccessCriteriaCriteriaListInner 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 + +### NewAccessCriteriaCriteriaListInnerWithDefaults + +`func NewAccessCriteriaCriteriaListInnerWithDefaults() *AccessCriteriaCriteriaListInner` + +NewAccessCriteriaCriteriaListInnerWithDefaults instantiates a new AccessCriteriaCriteriaListInner 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 + +### GetType + +`func (o *AccessCriteriaCriteriaListInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessCriteriaCriteriaListInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessCriteriaCriteriaListInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessCriteriaCriteriaListInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessCriteriaCriteriaListInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessCriteriaCriteriaListInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessCriteriaCriteriaListInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessCriteriaCriteriaListInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessCriteriaCriteriaListInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessCriteriaCriteriaListInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessCriteriaCriteriaListInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessCriteriaCriteriaListInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessItemAccessProfileResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemAccessProfileResponse.md new file mode 100644 index 000000000..d8ce32c65 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemAccessProfileResponse.md @@ -0,0 +1,340 @@ +--- +id: v2024-access-item-access-profile-response +title: AccessItemAccessProfileResponse +pagination_label: AccessItemAccessProfileResponse +sidebar_label: AccessItemAccessProfileResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemAccessProfileResponse', 'V2024AccessItemAccessProfileResponse'] +slug: /tools/sdk/go/v2024/models/access-item-access-profile-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'V2024AccessItemAccessProfileResponse'] +--- + +# AccessItemAccessProfileResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. accessProfile in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**Name** | Pointer to **string** | the access profile name | [optional] +**SourceName** | Pointer to **string** | the name of the source | [optional] +**SourceId** | Pointer to **string** | the id of the source | [optional] +**Description** | Pointer to **string** | the description for the access profile | [optional] +**DisplayName** | Pointer to **string** | the display name of the identity | [optional] +**EntitlementCount** | Pointer to **string** | the number of entitlements the access profile will create | [optional] +**AppDisplayName** | Pointer to **string** | the name of | [optional] +**RemoveDate** | Pointer to **string** | the date the access profile is no longer assigned to the specified identity | [optional] +**Standalone** | **bool** | indicates whether the access profile is standalone | +**Revocable** | **bool** | indicates whether the access profile is | + +## Methods + +### NewAccessItemAccessProfileResponse + +`func NewAccessItemAccessProfileResponse(standalone bool, revocable bool, ) *AccessItemAccessProfileResponse` + +NewAccessItemAccessProfileResponse instantiates a new AccessItemAccessProfileResponse 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 + +### NewAccessItemAccessProfileResponseWithDefaults + +`func NewAccessItemAccessProfileResponseWithDefaults() *AccessItemAccessProfileResponse` + +NewAccessItemAccessProfileResponseWithDefaults instantiates a new AccessItemAccessProfileResponse 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 + +### GetAccessType + +`func (o *AccessItemAccessProfileResponse) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemAccessProfileResponse) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemAccessProfileResponse) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemAccessProfileResponse) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemAccessProfileResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemAccessProfileResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemAccessProfileResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemAccessProfileResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemAccessProfileResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemAccessProfileResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemAccessProfileResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemAccessProfileResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemAccessProfileResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemAccessProfileResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemAccessProfileResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemAccessProfileResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessItemAccessProfileResponse) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessItemAccessProfileResponse) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessItemAccessProfileResponse) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessItemAccessProfileResponse) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessItemAccessProfileResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessItemAccessProfileResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessItemAccessProfileResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessItemAccessProfileResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemAccessProfileResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemAccessProfileResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemAccessProfileResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemAccessProfileResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccessItemAccessProfileResponse) GetEntitlementCount() string` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccessItemAccessProfileResponse) GetEntitlementCountOk() (*string, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccessItemAccessProfileResponse) SetEntitlementCount(v string)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccessItemAccessProfileResponse) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetAppDisplayName + +`func (o *AccessItemAccessProfileResponse) GetAppDisplayName() string` + +GetAppDisplayName returns the AppDisplayName field if non-nil, zero value otherwise. + +### GetAppDisplayNameOk + +`func (o *AccessItemAccessProfileResponse) GetAppDisplayNameOk() (*string, bool)` + +GetAppDisplayNameOk returns a tuple with the AppDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppDisplayName + +`func (o *AccessItemAccessProfileResponse) SetAppDisplayName(v string)` + +SetAppDisplayName sets AppDisplayName field to given value. + +### HasAppDisplayName + +`func (o *AccessItemAccessProfileResponse) HasAppDisplayName() bool` + +HasAppDisplayName returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *AccessItemAccessProfileResponse) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccessItemAccessProfileResponse) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccessItemAccessProfileResponse) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccessItemAccessProfileResponse) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetStandalone + +`func (o *AccessItemAccessProfileResponse) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *AccessItemAccessProfileResponse) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *AccessItemAccessProfileResponse) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + + +### GetRevocable + +`func (o *AccessItemAccessProfileResponse) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *AccessItemAccessProfileResponse) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *AccessItemAccessProfileResponse) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessItemAccountResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemAccountResponse.md new file mode 100644 index 000000000..25fc9db43 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemAccountResponse.md @@ -0,0 +1,220 @@ +--- +id: v2024-access-item-account-response +title: AccessItemAccountResponse +pagination_label: AccessItemAccountResponse +sidebar_label: AccessItemAccountResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemAccountResponse', 'V2024AccessItemAccountResponse'] +slug: /tools/sdk/go/v2024/models/access-item-account-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAccountResponse', 'V2024AccessItemAccountResponse'] +--- + +# AccessItemAccountResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. account in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**NativeIdentity** | Pointer to **string** | the native identifier used to uniquely identify an acccount | [optional] +**SourceName** | Pointer to **string** | the name of the source | [optional] +**SourceId** | Pointer to **string** | the id of the source | [optional] +**EntitlementCount** | Pointer to **string** | the number of entitlements the account will create | [optional] +**DisplayName** | Pointer to **string** | the display name of the identity | [optional] + +## Methods + +### NewAccessItemAccountResponse + +`func NewAccessItemAccountResponse() *AccessItemAccountResponse` + +NewAccessItemAccountResponse instantiates a new AccessItemAccountResponse 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 + +### NewAccessItemAccountResponseWithDefaults + +`func NewAccessItemAccountResponseWithDefaults() *AccessItemAccountResponse` + +NewAccessItemAccountResponseWithDefaults instantiates a new AccessItemAccountResponse 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 + +### GetAccessType + +`func (o *AccessItemAccountResponse) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemAccountResponse) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemAccountResponse) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemAccountResponse) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemAccountResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemAccountResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemAccountResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemAccountResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *AccessItemAccountResponse) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccessItemAccountResponse) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccessItemAccountResponse) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccessItemAccountResponse) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemAccountResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemAccountResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemAccountResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemAccountResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessItemAccountResponse) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessItemAccountResponse) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessItemAccountResponse) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessItemAccountResponse) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccessItemAccountResponse) GetEntitlementCount() string` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccessItemAccountResponse) GetEntitlementCountOk() (*string, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccessItemAccountResponse) SetEntitlementCount(v string)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccessItemAccountResponse) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemAccountResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemAccountResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemAccountResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemAccountResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessItemAppResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemAppResponse.md new file mode 100644 index 000000000..4085b7820 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemAppResponse.md @@ -0,0 +1,168 @@ +--- +id: v2024-access-item-app-response +title: AccessItemAppResponse +pagination_label: AccessItemAppResponse +sidebar_label: AccessItemAppResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemAppResponse', 'V2024AccessItemAppResponse'] +slug: /tools/sdk/go/v2024/models/access-item-app-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAppResponse', 'V2024AccessItemAppResponse'] +--- + +# AccessItemAppResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. entitlement in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**DisplayName** | Pointer to **string** | the access item display name | [optional] +**SourceName** | Pointer to **string** | the associated source name if it exists | [optional] +**AppRoleId** | Pointer to **string** | the app role id | [optional] + +## Methods + +### NewAccessItemAppResponse + +`func NewAccessItemAppResponse() *AccessItemAppResponse` + +NewAccessItemAppResponse instantiates a new AccessItemAppResponse 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 + +### NewAccessItemAppResponseWithDefaults + +`func NewAccessItemAppResponseWithDefaults() *AccessItemAppResponse` + +NewAccessItemAppResponseWithDefaults instantiates a new AccessItemAppResponse 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 + +### GetAccessType + +`func (o *AccessItemAppResponse) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemAppResponse) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemAppResponse) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemAppResponse) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemAppResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemAppResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemAppResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemAppResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemAppResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemAppResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemAppResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemAppResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemAppResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemAppResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemAppResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemAppResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetAppRoleId + +`func (o *AccessItemAppResponse) GetAppRoleId() string` + +GetAppRoleId returns the AppRoleId field if non-nil, zero value otherwise. + +### GetAppRoleIdOk + +`func (o *AccessItemAppResponse) GetAppRoleIdOk() (*string, bool)` + +GetAppRoleIdOk returns a tuple with the AppRoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppRoleId + +`func (o *AccessItemAppResponse) SetAppRoleId(v string)` + +SetAppRoleId sets AppRoleId field to given value. + +### HasAppRoleId + +`func (o *AccessItemAppResponse) HasAppRoleId() bool` + +HasAppRoleId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessItemApproverDto.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemApproverDto.md new file mode 100644 index 000000000..a539ca124 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemApproverDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-access-item-approver-dto +title: AccessItemApproverDto +pagination_label: AccessItemApproverDto +sidebar_label: AccessItemApproverDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemApproverDto', 'V2024AccessItemApproverDto'] +slug: /tools/sdk/go/v2024/models/access-item-approver-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemApproverDto', 'V2024AccessItemApproverDto'] +--- + +# AccessItemApproverDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity who approved the access item request. | [optional] +**Id** | Pointer to **string** | ID of identity who approved the access item request. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity who approved the access item request. | [optional] + +## Methods + +### NewAccessItemApproverDto + +`func NewAccessItemApproverDto() *AccessItemApproverDto` + +NewAccessItemApproverDto instantiates a new AccessItemApproverDto 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 + +### NewAccessItemApproverDtoWithDefaults + +`func NewAccessItemApproverDtoWithDefaults() *AccessItemApproverDto` + +NewAccessItemApproverDtoWithDefaults instantiates a new AccessItemApproverDto 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 + +### GetType + +`func (o *AccessItemApproverDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemApproverDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemApproverDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemApproverDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemApproverDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemApproverDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemApproverDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemApproverDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemApproverDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemApproverDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemApproverDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemApproverDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessItemAssociated.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemAssociated.md new file mode 100644 index 000000000..690508707 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemAssociated.md @@ -0,0 +1,168 @@ +--- +id: v2024-access-item-associated +title: AccessItemAssociated +pagination_label: AccessItemAssociated +sidebar_label: AccessItemAssociated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemAssociated', 'V2024AccessItemAssociated'] +slug: /tools/sdk/go/v2024/models/access-item-associated +tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'V2024AccessItemAssociated'] +--- + +# AccessItemAssociated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] +**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] + +## Methods + +### NewAccessItemAssociated + +`func NewAccessItemAssociated() *AccessItemAssociated` + +NewAccessItemAssociated instantiates a new AccessItemAssociated 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 + +### NewAccessItemAssociatedWithDefaults + +`func NewAccessItemAssociatedWithDefaults() *AccessItemAssociated` + +NewAccessItemAssociatedWithDefaults instantiates a new AccessItemAssociated 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 + +### GetAccessItem + +`func (o *AccessItemAssociated) GetAccessItem() AccessItemAssociatedAccessItem` + +GetAccessItem returns the AccessItem field if non-nil, zero value otherwise. + +### GetAccessItemOk + +`func (o *AccessItemAssociated) GetAccessItemOk() (*AccessItemAssociatedAccessItem, bool)` + +GetAccessItemOk returns a tuple with the AccessItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItem + +`func (o *AccessItemAssociated) SetAccessItem(v AccessItemAssociatedAccessItem)` + +SetAccessItem sets AccessItem field to given value. + +### HasAccessItem + +`func (o *AccessItemAssociated) HasAccessItem() bool` + +HasAccessItem returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *AccessItemAssociated) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessItemAssociated) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessItemAssociated) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccessItemAssociated) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEventType + +`func (o *AccessItemAssociated) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AccessItemAssociated) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AccessItemAssociated) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AccessItemAssociated) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDt + +`func (o *AccessItemAssociated) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *AccessItemAssociated) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *AccessItemAssociated) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *AccessItemAssociated) HasDt() bool` + +HasDt returns a boolean if a field has been set. + +### GetGovernanceEvent + +`func (o *AccessItemAssociated) GetGovernanceEvent() CorrelatedGovernanceEvent` + +GetGovernanceEvent returns the GovernanceEvent field if non-nil, zero value otherwise. + +### GetGovernanceEventOk + +`func (o *AccessItemAssociated) GetGovernanceEventOk() (*CorrelatedGovernanceEvent, bool)` + +GetGovernanceEventOk returns a tuple with the GovernanceEvent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceEvent + +`func (o *AccessItemAssociated) SetGovernanceEvent(v CorrelatedGovernanceEvent)` + +SetGovernanceEvent sets GovernanceEvent field to given value. + +### HasGovernanceEvent + +`func (o *AccessItemAssociated) HasGovernanceEvent() bool` + +HasGovernanceEvent returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessItemAssociatedAccessItem.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemAssociatedAccessItem.md new file mode 100644 index 000000000..cb40fedd3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemAssociatedAccessItem.md @@ -0,0 +1,512 @@ +--- +id: v2024-access-item-associated-access-item +title: AccessItemAssociatedAccessItem +pagination_label: AccessItemAssociatedAccessItem +sidebar_label: AccessItemAssociatedAccessItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemAssociatedAccessItem', 'V2024AccessItemAssociatedAccessItem'] +slug: /tools/sdk/go/v2024/models/access-item-associated-access-item +tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'V2024AccessItemAssociatedAccessItem'] +--- + +# AccessItemAssociatedAccessItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. role in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**Name** | Pointer to **string** | the access profile name | [optional] +**SourceName** | Pointer to **string** | the associated source name if it exists | [optional] +**SourceId** | Pointer to **string** | the id of the source | [optional] +**Description** | Pointer to **string** | the description for the role | [optional] +**DisplayName** | Pointer to **string** | the role display name | [optional] +**EntitlementCount** | Pointer to **string** | the number of entitlements the account will create | [optional] +**AppDisplayName** | Pointer to **string** | the name of | [optional] +**RemoveDate** | Pointer to **string** | the date the role is no longer assigned to the specified identity | [optional] +**Standalone** | **bool** | indicates whether the entitlement is standalone | +**Revocable** | **bool** | indicates whether the role is revocable | +**NativeIdentity** | Pointer to **string** | the native identifier used to uniquely identify an acccount | [optional] +**AppRoleId** | Pointer to **string** | the app role id | [optional] +**Attribute** | Pointer to **string** | the entitlement attribute | [optional] +**Value** | Pointer to **string** | the associated value | [optional] +**EntitlementType** | Pointer to **string** | the type of entitlement | [optional] +**Privileged** | **bool** | indicates whether the entitlement is privileged | +**CloudGoverned** | **bool** | indicates whether the entitlement is cloud governed | + +## Methods + +### NewAccessItemAssociatedAccessItem + +`func NewAccessItemAssociatedAccessItem(standalone bool, revocable bool, privileged bool, cloudGoverned bool, ) *AccessItemAssociatedAccessItem` + +NewAccessItemAssociatedAccessItem instantiates a new AccessItemAssociatedAccessItem 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 + +### NewAccessItemAssociatedAccessItemWithDefaults + +`func NewAccessItemAssociatedAccessItemWithDefaults() *AccessItemAssociatedAccessItem` + +NewAccessItemAssociatedAccessItemWithDefaults instantiates a new AccessItemAssociatedAccessItem 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 + +### GetAccessType + +`func (o *AccessItemAssociatedAccessItem) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemAssociatedAccessItem) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemAssociatedAccessItem) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemAssociatedAccessItem) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemAssociatedAccessItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemAssociatedAccessItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemAssociatedAccessItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemAssociatedAccessItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemAssociatedAccessItem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemAssociatedAccessItem) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemAssociatedAccessItem) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemAssociatedAccessItem) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemAssociatedAccessItem) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemAssociatedAccessItem) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemAssociatedAccessItem) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemAssociatedAccessItem) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessItemAssociatedAccessItem) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessItemAssociatedAccessItem) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessItemAssociatedAccessItem) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessItemAssociatedAccessItem) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessItemAssociatedAccessItem) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessItemAssociatedAccessItem) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessItemAssociatedAccessItem) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessItemAssociatedAccessItem) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemAssociatedAccessItem) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemAssociatedAccessItem) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemAssociatedAccessItem) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemAssociatedAccessItem) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccessItemAssociatedAccessItem) GetEntitlementCount() string` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccessItemAssociatedAccessItem) GetEntitlementCountOk() (*string, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccessItemAssociatedAccessItem) SetEntitlementCount(v string)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccessItemAssociatedAccessItem) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetAppDisplayName + +`func (o *AccessItemAssociatedAccessItem) GetAppDisplayName() string` + +GetAppDisplayName returns the AppDisplayName field if non-nil, zero value otherwise. + +### GetAppDisplayNameOk + +`func (o *AccessItemAssociatedAccessItem) GetAppDisplayNameOk() (*string, bool)` + +GetAppDisplayNameOk returns a tuple with the AppDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppDisplayName + +`func (o *AccessItemAssociatedAccessItem) SetAppDisplayName(v string)` + +SetAppDisplayName sets AppDisplayName field to given value. + +### HasAppDisplayName + +`func (o *AccessItemAssociatedAccessItem) HasAppDisplayName() bool` + +HasAppDisplayName returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *AccessItemAssociatedAccessItem) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccessItemAssociatedAccessItem) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccessItemAssociatedAccessItem) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccessItemAssociatedAccessItem) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetStandalone + +`func (o *AccessItemAssociatedAccessItem) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *AccessItemAssociatedAccessItem) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *AccessItemAssociatedAccessItem) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + + +### GetRevocable + +`func (o *AccessItemAssociatedAccessItem) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *AccessItemAssociatedAccessItem) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *AccessItemAssociatedAccessItem) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + + +### GetNativeIdentity + +`func (o *AccessItemAssociatedAccessItem) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccessItemAssociatedAccessItem) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccessItemAssociatedAccessItem) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccessItemAssociatedAccessItem) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetAppRoleId + +`func (o *AccessItemAssociatedAccessItem) GetAppRoleId() string` + +GetAppRoleId returns the AppRoleId field if non-nil, zero value otherwise. + +### GetAppRoleIdOk + +`func (o *AccessItemAssociatedAccessItem) GetAppRoleIdOk() (*string, bool)` + +GetAppRoleIdOk returns a tuple with the AppRoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppRoleId + +`func (o *AccessItemAssociatedAccessItem) SetAppRoleId(v string)` + +SetAppRoleId sets AppRoleId field to given value. + +### HasAppRoleId + +`func (o *AccessItemAssociatedAccessItem) HasAppRoleId() bool` + +HasAppRoleId returns a boolean if a field has been set. + +### GetAttribute + +`func (o *AccessItemAssociatedAccessItem) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *AccessItemAssociatedAccessItem) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *AccessItemAssociatedAccessItem) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *AccessItemAssociatedAccessItem) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *AccessItemAssociatedAccessItem) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AccessItemAssociatedAccessItem) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AccessItemAssociatedAccessItem) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AccessItemAssociatedAccessItem) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetEntitlementType + +`func (o *AccessItemAssociatedAccessItem) GetEntitlementType() string` + +GetEntitlementType returns the EntitlementType field if non-nil, zero value otherwise. + +### GetEntitlementTypeOk + +`func (o *AccessItemAssociatedAccessItem) GetEntitlementTypeOk() (*string, bool)` + +GetEntitlementTypeOk returns a tuple with the EntitlementType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementType + +`func (o *AccessItemAssociatedAccessItem) SetEntitlementType(v string)` + +SetEntitlementType sets EntitlementType field to given value. + +### HasEntitlementType + +`func (o *AccessItemAssociatedAccessItem) HasEntitlementType() bool` + +HasEntitlementType returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *AccessItemAssociatedAccessItem) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *AccessItemAssociatedAccessItem) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *AccessItemAssociatedAccessItem) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + + +### GetCloudGoverned + +`func (o *AccessItemAssociatedAccessItem) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *AccessItemAssociatedAccessItem) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *AccessItemAssociatedAccessItem) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessItemDiff.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemDiff.md new file mode 100644 index 000000000..144dfe561 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemDiff.md @@ -0,0 +1,142 @@ +--- +id: v2024-access-item-diff +title: AccessItemDiff +pagination_label: AccessItemDiff +sidebar_label: AccessItemDiff +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemDiff', 'V2024AccessItemDiff'] +slug: /tools/sdk/go/v2024/models/access-item-diff +tags: ['SDK', 'Software Development Kit', 'AccessItemDiff', 'V2024AccessItemDiff'] +--- + +# AccessItemDiff + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the id of the access item | [optional] +**EventType** | Pointer to **string** | | [optional] +**DisplayName** | Pointer to **string** | the display name of the access item | [optional] +**SourceName** | Pointer to **string** | the source name of the access item | [optional] + +## Methods + +### NewAccessItemDiff + +`func NewAccessItemDiff() *AccessItemDiff` + +NewAccessItemDiff instantiates a new AccessItemDiff 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 + +### NewAccessItemDiffWithDefaults + +`func NewAccessItemDiffWithDefaults() *AccessItemDiff` + +NewAccessItemDiffWithDefaults instantiates a new AccessItemDiff 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 + +### GetId + +`func (o *AccessItemDiff) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemDiff) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemDiff) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemDiff) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetEventType + +`func (o *AccessItemDiff) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AccessItemDiff) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AccessItemDiff) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AccessItemDiff) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemDiff) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemDiff) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemDiff) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemDiff) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemDiff) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemDiff) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemDiff) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemDiff) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessItemEntitlementResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemEntitlementResponse.md new file mode 100644 index 000000000..aaaaae004 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemEntitlementResponse.md @@ -0,0 +1,335 @@ +--- +id: v2024-access-item-entitlement-response +title: AccessItemEntitlementResponse +pagination_label: AccessItemEntitlementResponse +sidebar_label: AccessItemEntitlementResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemEntitlementResponse', 'V2024AccessItemEntitlementResponse'] +slug: /tools/sdk/go/v2024/models/access-item-entitlement-response +tags: ['SDK', 'Software Development Kit', 'AccessItemEntitlementResponse', 'V2024AccessItemEntitlementResponse'] +--- + +# AccessItemEntitlementResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. entitlement in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**Attribute** | Pointer to **string** | the entitlement attribute | [optional] +**Value** | Pointer to **string** | the associated value | [optional] +**EntitlementType** | Pointer to **string** | the type of entitlement | [optional] +**SourceName** | Pointer to **string** | the name of the source | [optional] +**SourceId** | Pointer to **string** | the id of the source | [optional] +**Description** | Pointer to **string** | the description for the entitlment | [optional] +**DisplayName** | Pointer to **string** | the display name of the identity | [optional] +**Standalone** | **bool** | indicates whether the entitlement is standalone | +**Privileged** | **bool** | indicates whether the entitlement is privileged | +**CloudGoverned** | **bool** | indicates whether the entitlement is cloud governed | + +## Methods + +### NewAccessItemEntitlementResponse + +`func NewAccessItemEntitlementResponse(standalone bool, privileged bool, cloudGoverned bool, ) *AccessItemEntitlementResponse` + +NewAccessItemEntitlementResponse instantiates a new AccessItemEntitlementResponse 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 + +### NewAccessItemEntitlementResponseWithDefaults + +`func NewAccessItemEntitlementResponseWithDefaults() *AccessItemEntitlementResponse` + +NewAccessItemEntitlementResponseWithDefaults instantiates a new AccessItemEntitlementResponse 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 + +### GetAccessType + +`func (o *AccessItemEntitlementResponse) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemEntitlementResponse) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemEntitlementResponse) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemEntitlementResponse) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemEntitlementResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemEntitlementResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemEntitlementResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemEntitlementResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAttribute + +`func (o *AccessItemEntitlementResponse) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *AccessItemEntitlementResponse) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *AccessItemEntitlementResponse) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *AccessItemEntitlementResponse) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *AccessItemEntitlementResponse) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AccessItemEntitlementResponse) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AccessItemEntitlementResponse) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AccessItemEntitlementResponse) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetEntitlementType + +`func (o *AccessItemEntitlementResponse) GetEntitlementType() string` + +GetEntitlementType returns the EntitlementType field if non-nil, zero value otherwise. + +### GetEntitlementTypeOk + +`func (o *AccessItemEntitlementResponse) GetEntitlementTypeOk() (*string, bool)` + +GetEntitlementTypeOk returns a tuple with the EntitlementType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementType + +`func (o *AccessItemEntitlementResponse) SetEntitlementType(v string)` + +SetEntitlementType sets EntitlementType field to given value. + +### HasEntitlementType + +`func (o *AccessItemEntitlementResponse) HasEntitlementType() bool` + +HasEntitlementType returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemEntitlementResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemEntitlementResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemEntitlementResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemEntitlementResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessItemEntitlementResponse) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessItemEntitlementResponse) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessItemEntitlementResponse) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessItemEntitlementResponse) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessItemEntitlementResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessItemEntitlementResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessItemEntitlementResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessItemEntitlementResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemEntitlementResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemEntitlementResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemEntitlementResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemEntitlementResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetStandalone + +`func (o *AccessItemEntitlementResponse) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *AccessItemEntitlementResponse) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *AccessItemEntitlementResponse) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + + +### GetPrivileged + +`func (o *AccessItemEntitlementResponse) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *AccessItemEntitlementResponse) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *AccessItemEntitlementResponse) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + + +### GetCloudGoverned + +`func (o *AccessItemEntitlementResponse) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *AccessItemEntitlementResponse) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *AccessItemEntitlementResponse) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRef.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRef.md new file mode 100644 index 000000000..2821423e6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRef.md @@ -0,0 +1,90 @@ +--- +id: v2024-access-item-ref +title: AccessItemRef +pagination_label: AccessItemRef +sidebar_label: AccessItemRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRef', 'V2024AccessItemRef'] +slug: /tools/sdk/go/v2024/models/access-item-ref +tags: ['SDK', 'Software Development Kit', 'AccessItemRef', 'V2024AccessItemRef'] +--- + +# AccessItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the access item to retrieve the recommendation for. | [optional] +**Type** | Pointer to **string** | Access item's type. | [optional] + +## Methods + +### NewAccessItemRef + +`func NewAccessItemRef() *AccessItemRef` + +NewAccessItemRef instantiates a new AccessItemRef 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 + +### NewAccessItemRefWithDefaults + +`func NewAccessItemRefWithDefaults() *AccessItemRef` + +NewAccessItemRefWithDefaults instantiates a new AccessItemRef 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 + +### GetId + +`func (o *AccessItemRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessItemRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRef) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRemoved.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRemoved.md new file mode 100644 index 000000000..4f29bc9ff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRemoved.md @@ -0,0 +1,168 @@ +--- +id: v2024-access-item-removed +title: AccessItemRemoved +pagination_label: AccessItemRemoved +sidebar_label: AccessItemRemoved +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRemoved', 'V2024AccessItemRemoved'] +slug: /tools/sdk/go/v2024/models/access-item-removed +tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'V2024AccessItemRemoved'] +--- + +# AccessItemRemoved + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] +**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] + +## Methods + +### NewAccessItemRemoved + +`func NewAccessItemRemoved() *AccessItemRemoved` + +NewAccessItemRemoved instantiates a new AccessItemRemoved 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 + +### NewAccessItemRemovedWithDefaults + +`func NewAccessItemRemovedWithDefaults() *AccessItemRemoved` + +NewAccessItemRemovedWithDefaults instantiates a new AccessItemRemoved 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 + +### GetAccessItem + +`func (o *AccessItemRemoved) GetAccessItem() AccessItemAssociatedAccessItem` + +GetAccessItem returns the AccessItem field if non-nil, zero value otherwise. + +### GetAccessItemOk + +`func (o *AccessItemRemoved) GetAccessItemOk() (*AccessItemAssociatedAccessItem, bool)` + +GetAccessItemOk returns a tuple with the AccessItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItem + +`func (o *AccessItemRemoved) SetAccessItem(v AccessItemAssociatedAccessItem)` + +SetAccessItem sets AccessItem field to given value. + +### HasAccessItem + +`func (o *AccessItemRemoved) HasAccessItem() bool` + +HasAccessItem returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *AccessItemRemoved) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessItemRemoved) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessItemRemoved) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccessItemRemoved) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEventType + +`func (o *AccessItemRemoved) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AccessItemRemoved) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AccessItemRemoved) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AccessItemRemoved) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDt + +`func (o *AccessItemRemoved) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *AccessItemRemoved) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *AccessItemRemoved) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *AccessItemRemoved) HasDt() bool` + +HasDt returns a boolean if a field has been set. + +### GetGovernanceEvent + +`func (o *AccessItemRemoved) GetGovernanceEvent() CorrelatedGovernanceEvent` + +GetGovernanceEvent returns the GovernanceEvent field if non-nil, zero value otherwise. + +### GetGovernanceEventOk + +`func (o *AccessItemRemoved) GetGovernanceEventOk() (*CorrelatedGovernanceEvent, bool)` + +GetGovernanceEventOk returns a tuple with the GovernanceEvent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceEvent + +`func (o *AccessItemRemoved) SetGovernanceEvent(v CorrelatedGovernanceEvent)` + +SetGovernanceEvent sets GovernanceEvent field to given value. + +### HasGovernanceEvent + +`func (o *AccessItemRemoved) HasGovernanceEvent() bool` + +HasGovernanceEvent returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRequestedFor.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRequestedFor.md new file mode 100644 index 000000000..84489339f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRequestedFor.md @@ -0,0 +1,116 @@ +--- +id: v2024-access-item-requested-for +title: AccessItemRequestedFor +pagination_label: AccessItemRequestedFor +sidebar_label: AccessItemRequestedFor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRequestedFor', 'V2024AccessItemRequestedFor'] +slug: /tools/sdk/go/v2024/models/access-item-requested-for +tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedFor', 'V2024AccessItemRequestedFor'] +--- + +# AccessItemRequestedFor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity the access item is requested for. | [optional] +**Id** | Pointer to **string** | ID of identity the access item is requested for. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity the access item is requested for. | [optional] + +## Methods + +### NewAccessItemRequestedFor + +`func NewAccessItemRequestedFor() *AccessItemRequestedFor` + +NewAccessItemRequestedFor instantiates a new AccessItemRequestedFor 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 + +### NewAccessItemRequestedForWithDefaults + +`func NewAccessItemRequestedForWithDefaults() *AccessItemRequestedFor` + +NewAccessItemRequestedForWithDefaults instantiates a new AccessItemRequestedFor 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 + +### GetType + +`func (o *AccessItemRequestedFor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRequestedFor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRequestedFor) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRequestedFor) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRequestedFor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRequestedFor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRequestedFor) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRequestedFor) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemRequestedFor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemRequestedFor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemRequestedFor) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemRequestedFor) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRequestedForDto.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRequestedForDto.md new file mode 100644 index 000000000..e5ffe0d5c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRequestedForDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-access-item-requested-for-dto +title: AccessItemRequestedForDto +pagination_label: AccessItemRequestedForDto +sidebar_label: AccessItemRequestedForDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRequestedForDto', 'V2024AccessItemRequestedForDto'] +slug: /tools/sdk/go/v2024/models/access-item-requested-for-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedForDto', 'V2024AccessItemRequestedForDto'] +--- + +# AccessItemRequestedForDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity the access item is requested for. | [optional] +**Id** | Pointer to **string** | ID of identity the access item is requested for. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity the access item is requested for. | [optional] + +## Methods + +### NewAccessItemRequestedForDto + +`func NewAccessItemRequestedForDto() *AccessItemRequestedForDto` + +NewAccessItemRequestedForDto instantiates a new AccessItemRequestedForDto 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 + +### NewAccessItemRequestedForDtoWithDefaults + +`func NewAccessItemRequestedForDtoWithDefaults() *AccessItemRequestedForDto` + +NewAccessItemRequestedForDtoWithDefaults instantiates a new AccessItemRequestedForDto 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 + +### GetType + +`func (o *AccessItemRequestedForDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRequestedForDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRequestedForDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRequestedForDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRequestedForDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRequestedForDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRequestedForDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRequestedForDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemRequestedForDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemRequestedForDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemRequestedForDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemRequestedForDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRequester.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRequester.md new file mode 100644 index 000000000..29a7166c9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRequester.md @@ -0,0 +1,116 @@ +--- +id: v2024-access-item-requester +title: AccessItemRequester +pagination_label: AccessItemRequester +sidebar_label: AccessItemRequester +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRequester', 'V2024AccessItemRequester'] +slug: /tools/sdk/go/v2024/models/access-item-requester +tags: ['SDK', 'Software Development Kit', 'AccessItemRequester', 'V2024AccessItemRequester'] +--- + +# AccessItemRequester + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Access item requester's DTO type. | [optional] +**Id** | Pointer to **string** | Access item requester's identity ID. | [optional] +**Name** | Pointer to **string** | Access item owner's human-readable display name. | [optional] + +## Methods + +### NewAccessItemRequester + +`func NewAccessItemRequester() *AccessItemRequester` + +NewAccessItemRequester instantiates a new AccessItemRequester 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 + +### NewAccessItemRequesterWithDefaults + +`func NewAccessItemRequesterWithDefaults() *AccessItemRequester` + +NewAccessItemRequesterWithDefaults instantiates a new AccessItemRequester 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 + +### GetType + +`func (o *AccessItemRequester) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRequester) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRequester) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRequester) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRequester) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRequester) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRequester) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRequester) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemRequester) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemRequester) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemRequester) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemRequester) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRequesterDto.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRequesterDto.md new file mode 100644 index 000000000..dafa50447 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRequesterDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-access-item-requester-dto +title: AccessItemRequesterDto +pagination_label: AccessItemRequesterDto +sidebar_label: AccessItemRequesterDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRequesterDto', 'V2024AccessItemRequesterDto'] +slug: /tools/sdk/go/v2024/models/access-item-requester-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemRequesterDto', 'V2024AccessItemRequesterDto'] +--- + +# AccessItemRequesterDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Access item requester's DTO type. | [optional] +**Id** | Pointer to **string** | Access item requester's identity ID. | [optional] +**Name** | Pointer to **string** | Access item owner's human-readable display name. | [optional] + +## Methods + +### NewAccessItemRequesterDto + +`func NewAccessItemRequesterDto() *AccessItemRequesterDto` + +NewAccessItemRequesterDto instantiates a new AccessItemRequesterDto 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 + +### NewAccessItemRequesterDtoWithDefaults + +`func NewAccessItemRequesterDtoWithDefaults() *AccessItemRequesterDto` + +NewAccessItemRequesterDtoWithDefaults instantiates a new AccessItemRequesterDto 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 + +### GetType + +`func (o *AccessItemRequesterDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRequesterDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRequesterDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRequesterDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRequesterDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRequesterDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRequesterDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRequesterDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemRequesterDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemRequesterDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemRequesterDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemRequesterDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessItemReviewedBy.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemReviewedBy.md new file mode 100644 index 000000000..f962562cd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemReviewedBy.md @@ -0,0 +1,116 @@ +--- +id: v2024-access-item-reviewed-by +title: AccessItemReviewedBy +pagination_label: AccessItemReviewedBy +sidebar_label: AccessItemReviewedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemReviewedBy', 'V2024AccessItemReviewedBy'] +slug: /tools/sdk/go/v2024/models/access-item-reviewed-by +tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy', 'V2024AccessItemReviewedBy'] +--- + +# AccessItemReviewedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity who reviewed the access item request. | [optional] +**Id** | Pointer to **string** | ID of identity who reviewed the access item request. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity who reviewed the access item request. | [optional] + +## Methods + +### NewAccessItemReviewedBy + +`func NewAccessItemReviewedBy() *AccessItemReviewedBy` + +NewAccessItemReviewedBy instantiates a new AccessItemReviewedBy 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 + +### NewAccessItemReviewedByWithDefaults + +`func NewAccessItemReviewedByWithDefaults() *AccessItemReviewedBy` + +NewAccessItemReviewedByWithDefaults instantiates a new AccessItemReviewedBy 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 + +### GetType + +`func (o *AccessItemReviewedBy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemReviewedBy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemReviewedBy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemReviewedBy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemReviewedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemReviewedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemReviewedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemReviewedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemReviewedBy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemReviewedBy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemReviewedBy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemReviewedBy) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRoleResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRoleResponse.md new file mode 100644 index 000000000..1fabe146e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessItemRoleResponse.md @@ -0,0 +1,215 @@ +--- +id: v2024-access-item-role-response +title: AccessItemRoleResponse +pagination_label: AccessItemRoleResponse +sidebar_label: AccessItemRoleResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRoleResponse', 'V2024AccessItemRoleResponse'] +slug: /tools/sdk/go/v2024/models/access-item-role-response +tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'V2024AccessItemRoleResponse'] +--- + +# AccessItemRoleResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. role in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**DisplayName** | Pointer to **string** | the role display name | [optional] +**Description** | Pointer to **string** | the description for the role | [optional] +**SourceName** | Pointer to **string** | the associated source name if it exists | [optional] +**RemoveDate** | Pointer to **string** | the date the role is no longer assigned to the specified identity | [optional] +**Revocable** | **bool** | indicates whether the role is revocable | + +## Methods + +### NewAccessItemRoleResponse + +`func NewAccessItemRoleResponse(revocable bool, ) *AccessItemRoleResponse` + +NewAccessItemRoleResponse instantiates a new AccessItemRoleResponse 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 + +### NewAccessItemRoleResponseWithDefaults + +`func NewAccessItemRoleResponseWithDefaults() *AccessItemRoleResponse` + +NewAccessItemRoleResponseWithDefaults instantiates a new AccessItemRoleResponse 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 + +### GetAccessType + +`func (o *AccessItemRoleResponse) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemRoleResponse) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemRoleResponse) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemRoleResponse) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRoleResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRoleResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRoleResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRoleResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemRoleResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemRoleResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemRoleResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemRoleResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessItemRoleResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessItemRoleResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessItemRoleResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessItemRoleResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemRoleResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemRoleResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemRoleResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemRoleResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *AccessItemRoleResponse) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccessItemRoleResponse) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccessItemRoleResponse) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccessItemRoleResponse) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetRevocable + +`func (o *AccessItemRoleResponse) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *AccessItemRoleResponse) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *AccessItemRoleResponse) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessModelMetadata.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessModelMetadata.md new file mode 100644 index 000000000..69fab0020 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessModelMetadata.md @@ -0,0 +1,246 @@ +--- +id: v2024-access-model-metadata +title: AccessModelMetadata +pagination_label: AccessModelMetadata +sidebar_label: AccessModelMetadata +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessModelMetadata', 'V2024AccessModelMetadata'] +slug: /tools/sdk/go/v2024/models/access-model-metadata +tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'V2024AccessModelMetadata'] +--- + +# AccessModelMetadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | Unique identifier for the metadata type | [optional] +**Name** | Pointer to **string** | Human readable name of the metadata type | [optional] +**Multiselect** | Pointer to **bool** | Allows selecting multiple values | [optional] [default to false] +**Status** | Pointer to **string** | The state of the metadata item | [optional] +**Type** | Pointer to **string** | The type of the metadata item | [optional] +**ObjectTypes** | Pointer to **[]string** | The types of objects | [optional] +**Description** | Pointer to **string** | Describes the metadata item | [optional] +**Values** | Pointer to [**[]AccessModelMetadataValuesInner**](access-model-metadata-values-inner) | The value to assign to the metadata item | [optional] + +## Methods + +### NewAccessModelMetadata + +`func NewAccessModelMetadata() *AccessModelMetadata` + +NewAccessModelMetadata instantiates a new AccessModelMetadata 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 + +### NewAccessModelMetadataWithDefaults + +`func NewAccessModelMetadataWithDefaults() *AccessModelMetadata` + +NewAccessModelMetadataWithDefaults instantiates a new AccessModelMetadata 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 + +### GetKey + +`func (o *AccessModelMetadata) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *AccessModelMetadata) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *AccessModelMetadata) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *AccessModelMetadata) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *AccessModelMetadata) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessModelMetadata) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessModelMetadata) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessModelMetadata) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetMultiselect + +`func (o *AccessModelMetadata) GetMultiselect() bool` + +GetMultiselect returns the Multiselect field if non-nil, zero value otherwise. + +### GetMultiselectOk + +`func (o *AccessModelMetadata) GetMultiselectOk() (*bool, bool)` + +GetMultiselectOk returns a tuple with the Multiselect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultiselect + +`func (o *AccessModelMetadata) SetMultiselect(v bool)` + +SetMultiselect sets Multiselect field to given value. + +### HasMultiselect + +`func (o *AccessModelMetadata) HasMultiselect() bool` + +HasMultiselect returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccessModelMetadata) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccessModelMetadata) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccessModelMetadata) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccessModelMetadata) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetType + +`func (o *AccessModelMetadata) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessModelMetadata) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessModelMetadata) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessModelMetadata) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetObjectTypes + +`func (o *AccessModelMetadata) GetObjectTypes() []string` + +GetObjectTypes returns the ObjectTypes field if non-nil, zero value otherwise. + +### GetObjectTypesOk + +`func (o *AccessModelMetadata) GetObjectTypesOk() (*[]string, bool)` + +GetObjectTypesOk returns a tuple with the ObjectTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectTypes + +`func (o *AccessModelMetadata) SetObjectTypes(v []string)` + +SetObjectTypes sets ObjectTypes field to given value. + +### HasObjectTypes + +`func (o *AccessModelMetadata) HasObjectTypes() bool` + +HasObjectTypes returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessModelMetadata) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessModelMetadata) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessModelMetadata) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessModelMetadata) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetValues + +`func (o *AccessModelMetadata) GetValues() []AccessModelMetadataValuesInner` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *AccessModelMetadata) GetValuesOk() (*[]AccessModelMetadataValuesInner, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *AccessModelMetadata) SetValues(v []AccessModelMetadataValuesInner)` + +SetValues sets Values field to given value. + +### HasValues + +`func (o *AccessModelMetadata) HasValues() bool` + +HasValues returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessModelMetadataValuesInner.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessModelMetadataValuesInner.md new file mode 100644 index 000000000..0d9cf2072 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessModelMetadataValuesInner.md @@ -0,0 +1,116 @@ +--- +id: v2024-access-model-metadata-values-inner +title: AccessModelMetadataValuesInner +pagination_label: AccessModelMetadataValuesInner +sidebar_label: AccessModelMetadataValuesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessModelMetadataValuesInner', 'V2024AccessModelMetadataValuesInner'] +slug: /tools/sdk/go/v2024/models/access-model-metadata-values-inner +tags: ['SDK', 'Software Development Kit', 'AccessModelMetadataValuesInner', 'V2024AccessModelMetadataValuesInner'] +--- + +# AccessModelMetadataValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | The value to assign to the metdata item | [optional] +**Name** | Pointer to **string** | Display name of the value | [optional] +**Status** | Pointer to **string** | The status of the individual value | [optional] + +## Methods + +### NewAccessModelMetadataValuesInner + +`func NewAccessModelMetadataValuesInner() *AccessModelMetadataValuesInner` + +NewAccessModelMetadataValuesInner instantiates a new AccessModelMetadataValuesInner 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 + +### NewAccessModelMetadataValuesInnerWithDefaults + +`func NewAccessModelMetadataValuesInnerWithDefaults() *AccessModelMetadataValuesInner` + +NewAccessModelMetadataValuesInnerWithDefaults instantiates a new AccessModelMetadataValuesInner 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 + +### GetValue + +`func (o *AccessModelMetadataValuesInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AccessModelMetadataValuesInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AccessModelMetadataValuesInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AccessModelMetadataValuesInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetName + +`func (o *AccessModelMetadataValuesInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessModelMetadataValuesInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessModelMetadataValuesInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessModelMetadataValuesInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccessModelMetadataValuesInner) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccessModelMetadataValuesInner) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccessModelMetadataValuesInner) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccessModelMetadataValuesInner) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfile.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfile.md new file mode 100644 index 000000000..c2d7bc53e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfile.md @@ -0,0 +1,447 @@ +--- +id: v2024-access-profile +title: AccessProfile +pagination_label: AccessProfile +sidebar_label: AccessProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfile', 'V2024AccessProfile'] +slug: /tools/sdk/go/v2024/models/access-profile +tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'V2024AccessProfile'] +--- + +# AccessProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Access profile ID. | [optional] [readonly] +**Name** | **string** | Access profile name. | +**Description** | Pointer to **NullableString** | Access profile description. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time when the access profile was created. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Date and time when the access profile was last modified. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to false] +**Owner** | [**OwnerReference**](owner-reference) | | +**Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | +**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**Requestable** | Pointer to **bool** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to true] +**AccessRequestConfig** | Pointer to [**NullableRequestability**](requestability) | | [optional] +**RevocationRequestConfig** | Pointer to [**NullableRevocability**](revocability) | | [optional] +**Segments** | Pointer to **[]string** | List of segment IDs, if any, that the access profile is assigned to. | [optional] +**ProvisioningCriteria** | Pointer to [**NullableProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] + +## Methods + +### NewAccessProfile + +`func NewAccessProfile(name string, owner OwnerReference, source AccessProfileSourceRef, ) *AccessProfile` + +NewAccessProfile instantiates a new AccessProfile 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 + +### NewAccessProfileWithDefaults + +`func NewAccessProfileWithDefaults() *AccessProfile` + +NewAccessProfileWithDefaults instantiates a new AccessProfile 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 + +### GetId + +`func (o *AccessProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfile) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *AccessProfile) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfile) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfile) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfile) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessProfile) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessProfile) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCreated + +`func (o *AccessProfile) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccessProfile) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccessProfile) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccessProfile) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *AccessProfile) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccessProfile) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccessProfile) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccessProfile) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetEnabled + +`func (o *AccessProfile) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AccessProfile) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AccessProfile) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *AccessProfile) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetOwner + +`func (o *AccessProfile) GetOwner() OwnerReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *AccessProfile) GetOwnerOk() (*OwnerReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *AccessProfile) SetOwner(v OwnerReference)` + +SetOwner sets Owner field to given value. + + +### GetSource + +`func (o *AccessProfile) GetSource() AccessProfileSourceRef` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccessProfile) GetSourceOk() (*AccessProfileSourceRef, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccessProfile) SetSource(v AccessProfileSourceRef)` + +SetSource sets Source field to given value. + + +### GetEntitlements + +`func (o *AccessProfile) GetEntitlements() []EntitlementRef` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *AccessProfile) GetEntitlementsOk() (*[]EntitlementRef, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *AccessProfile) SetEntitlements(v []EntitlementRef)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *AccessProfile) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### SetEntitlementsNil + +`func (o *AccessProfile) SetEntitlementsNil(b bool)` + + SetEntitlementsNil sets the value for Entitlements to be an explicit nil + +### UnsetEntitlements +`func (o *AccessProfile) UnsetEntitlements()` + +UnsetEntitlements ensures that no value is present for Entitlements, not even an explicit nil +### GetRequestable + +`func (o *AccessProfile) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *AccessProfile) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *AccessProfile) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *AccessProfile) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetAccessRequestConfig + +`func (o *AccessProfile) GetAccessRequestConfig() Requestability` + +GetAccessRequestConfig returns the AccessRequestConfig field if non-nil, zero value otherwise. + +### GetAccessRequestConfigOk + +`func (o *AccessProfile) GetAccessRequestConfigOk() (*Requestability, bool)` + +GetAccessRequestConfigOk returns a tuple with the AccessRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestConfig + +`func (o *AccessProfile) SetAccessRequestConfig(v Requestability)` + +SetAccessRequestConfig sets AccessRequestConfig field to given value. + +### HasAccessRequestConfig + +`func (o *AccessProfile) HasAccessRequestConfig() bool` + +HasAccessRequestConfig returns a boolean if a field has been set. + +### SetAccessRequestConfigNil + +`func (o *AccessProfile) SetAccessRequestConfigNil(b bool)` + + SetAccessRequestConfigNil sets the value for AccessRequestConfig to be an explicit nil + +### UnsetAccessRequestConfig +`func (o *AccessProfile) UnsetAccessRequestConfig()` + +UnsetAccessRequestConfig ensures that no value is present for AccessRequestConfig, not even an explicit nil +### GetRevocationRequestConfig + +`func (o *AccessProfile) GetRevocationRequestConfig() Revocability` + +GetRevocationRequestConfig returns the RevocationRequestConfig field if non-nil, zero value otherwise. + +### GetRevocationRequestConfigOk + +`func (o *AccessProfile) GetRevocationRequestConfigOk() (*Revocability, bool)` + +GetRevocationRequestConfigOk returns a tuple with the RevocationRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocationRequestConfig + +`func (o *AccessProfile) SetRevocationRequestConfig(v Revocability)` + +SetRevocationRequestConfig sets RevocationRequestConfig field to given value. + +### HasRevocationRequestConfig + +`func (o *AccessProfile) HasRevocationRequestConfig() bool` + +HasRevocationRequestConfig returns a boolean if a field has been set. + +### SetRevocationRequestConfigNil + +`func (o *AccessProfile) SetRevocationRequestConfigNil(b bool)` + + SetRevocationRequestConfigNil sets the value for RevocationRequestConfig to be an explicit nil + +### UnsetRevocationRequestConfig +`func (o *AccessProfile) UnsetRevocationRequestConfig()` + +UnsetRevocationRequestConfig ensures that no value is present for RevocationRequestConfig, not even an explicit nil +### GetSegments + +`func (o *AccessProfile) GetSegments() []string` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *AccessProfile) GetSegmentsOk() (*[]string, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *AccessProfile) SetSegments(v []string)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *AccessProfile) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### SetSegmentsNil + +`func (o *AccessProfile) SetSegmentsNil(b bool)` + + SetSegmentsNil sets the value for Segments to be an explicit nil + +### UnsetSegments +`func (o *AccessProfile) UnsetSegments()` + +UnsetSegments ensures that no value is present for Segments, not even an explicit nil +### GetProvisioningCriteria + +`func (o *AccessProfile) GetProvisioningCriteria() ProvisioningCriteriaLevel1` + +GetProvisioningCriteria returns the ProvisioningCriteria field if non-nil, zero value otherwise. + +### GetProvisioningCriteriaOk + +`func (o *AccessProfile) GetProvisioningCriteriaOk() (*ProvisioningCriteriaLevel1, bool)` + +GetProvisioningCriteriaOk returns a tuple with the ProvisioningCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningCriteria + +`func (o *AccessProfile) SetProvisioningCriteria(v ProvisioningCriteriaLevel1)` + +SetProvisioningCriteria sets ProvisioningCriteria field to given value. + +### HasProvisioningCriteria + +`func (o *AccessProfile) HasProvisioningCriteria() bool` + +HasProvisioningCriteria returns a boolean if a field has been set. + +### SetProvisioningCriteriaNil + +`func (o *AccessProfile) SetProvisioningCriteriaNil(b bool)` + + SetProvisioningCriteriaNil sets the value for ProvisioningCriteria to be an explicit nil + +### UnsetProvisioningCriteria +`func (o *AccessProfile) UnsetProvisioningCriteria()` + +UnsetProvisioningCriteria ensures that no value is present for ProvisioningCriteria, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileApprovalScheme.md new file mode 100644 index 000000000..afcc0d87d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileApprovalScheme.md @@ -0,0 +1,100 @@ +--- +id: v2024-access-profile-approval-scheme +title: AccessProfileApprovalScheme +pagination_label: AccessProfileApprovalScheme +sidebar_label: AccessProfileApprovalScheme +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileApprovalScheme', 'V2024AccessProfileApprovalScheme'] +slug: /tools/sdk/go/v2024/models/access-profile-approval-scheme +tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'V2024AccessProfileApprovalScheme'] +--- + +# AccessProfileApprovalScheme + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApproverType** | Pointer to **string** | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | Pointer to **NullableString** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] + +## Methods + +### NewAccessProfileApprovalScheme + +`func NewAccessProfileApprovalScheme() *AccessProfileApprovalScheme` + +NewAccessProfileApprovalScheme instantiates a new AccessProfileApprovalScheme 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 + +### NewAccessProfileApprovalSchemeWithDefaults + +`func NewAccessProfileApprovalSchemeWithDefaults() *AccessProfileApprovalScheme` + +NewAccessProfileApprovalSchemeWithDefaults instantiates a new AccessProfileApprovalScheme 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 + +### GetApproverType + +`func (o *AccessProfileApprovalScheme) GetApproverType() string` + +GetApproverType returns the ApproverType field if non-nil, zero value otherwise. + +### GetApproverTypeOk + +`func (o *AccessProfileApprovalScheme) GetApproverTypeOk() (*string, bool)` + +GetApproverTypeOk returns a tuple with the ApproverType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverType + +`func (o *AccessProfileApprovalScheme) SetApproverType(v string)` + +SetApproverType sets ApproverType field to given value. + +### HasApproverType + +`func (o *AccessProfileApprovalScheme) HasApproverType() bool` + +HasApproverType returns a boolean if a field has been set. + +### GetApproverId + +`func (o *AccessProfileApprovalScheme) GetApproverId() string` + +GetApproverId returns the ApproverId field if non-nil, zero value otherwise. + +### GetApproverIdOk + +`func (o *AccessProfileApprovalScheme) GetApproverIdOk() (*string, bool)` + +GetApproverIdOk returns a tuple with the ApproverId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverId + +`func (o *AccessProfileApprovalScheme) SetApproverId(v string)` + +SetApproverId sets ApproverId field to given value. + +### HasApproverId + +`func (o *AccessProfileApprovalScheme) HasApproverId() bool` + +HasApproverId returns a boolean if a field has been set. + +### SetApproverIdNil + +`func (o *AccessProfileApprovalScheme) SetApproverIdNil(b bool)` + + SetApproverIdNil sets the value for ApproverId to be an explicit nil + +### UnsetApproverId +`func (o *AccessProfileApprovalScheme) UnsetApproverId()` + +UnsetApproverId ensures that no value is present for ApproverId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileBulkDeleteRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileBulkDeleteRequest.md new file mode 100644 index 000000000..b437965f4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileBulkDeleteRequest.md @@ -0,0 +1,90 @@ +--- +id: v2024-access-profile-bulk-delete-request +title: AccessProfileBulkDeleteRequest +pagination_label: AccessProfileBulkDeleteRequest +sidebar_label: AccessProfileBulkDeleteRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileBulkDeleteRequest', 'V2024AccessProfileBulkDeleteRequest'] +slug: /tools/sdk/go/v2024/models/access-profile-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest', 'V2024AccessProfileBulkDeleteRequest'] +--- + +# AccessProfileBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessProfileIds** | Pointer to **[]string** | List of IDs of Access Profiles to be deleted. | [optional] +**BestEffortOnly** | Pointer to **bool** | If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. | [optional] + +## Methods + +### NewAccessProfileBulkDeleteRequest + +`func NewAccessProfileBulkDeleteRequest() *AccessProfileBulkDeleteRequest` + +NewAccessProfileBulkDeleteRequest instantiates a new AccessProfileBulkDeleteRequest 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 + +### NewAccessProfileBulkDeleteRequestWithDefaults + +`func NewAccessProfileBulkDeleteRequestWithDefaults() *AccessProfileBulkDeleteRequest` + +NewAccessProfileBulkDeleteRequestWithDefaults instantiates a new AccessProfileBulkDeleteRequest 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 + +### GetAccessProfileIds + +`func (o *AccessProfileBulkDeleteRequest) GetAccessProfileIds() []string` + +GetAccessProfileIds returns the AccessProfileIds field if non-nil, zero value otherwise. + +### GetAccessProfileIdsOk + +`func (o *AccessProfileBulkDeleteRequest) GetAccessProfileIdsOk() (*[]string, bool)` + +GetAccessProfileIdsOk returns a tuple with the AccessProfileIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileIds + +`func (o *AccessProfileBulkDeleteRequest) SetAccessProfileIds(v []string)` + +SetAccessProfileIds sets AccessProfileIds field to given value. + +### HasAccessProfileIds + +`func (o *AccessProfileBulkDeleteRequest) HasAccessProfileIds() bool` + +HasAccessProfileIds returns a boolean if a field has been set. + +### GetBestEffortOnly + +`func (o *AccessProfileBulkDeleteRequest) GetBestEffortOnly() bool` + +GetBestEffortOnly returns the BestEffortOnly field if non-nil, zero value otherwise. + +### GetBestEffortOnlyOk + +`func (o *AccessProfileBulkDeleteRequest) GetBestEffortOnlyOk() (*bool, bool)` + +GetBestEffortOnlyOk returns a tuple with the BestEffortOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBestEffortOnly + +`func (o *AccessProfileBulkDeleteRequest) SetBestEffortOnly(v bool)` + +SetBestEffortOnly sets BestEffortOnly field to given value. + +### HasBestEffortOnly + +`func (o *AccessProfileBulkDeleteRequest) HasBestEffortOnly() bool` + +HasBestEffortOnly returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileBulkDeleteResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileBulkDeleteResponse.md new file mode 100644 index 000000000..6d6a5d6d8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileBulkDeleteResponse.md @@ -0,0 +1,116 @@ +--- +id: v2024-access-profile-bulk-delete-response +title: AccessProfileBulkDeleteResponse +pagination_label: AccessProfileBulkDeleteResponse +sidebar_label: AccessProfileBulkDeleteResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileBulkDeleteResponse', 'V2024AccessProfileBulkDeleteResponse'] +slug: /tools/sdk/go/v2024/models/access-profile-bulk-delete-response +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse', 'V2024AccessProfileBulkDeleteResponse'] +--- + +# AccessProfileBulkDeleteResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TaskId** | Pointer to **string** | ID of the task which is executing the bulk deletion. This can be passed to the **_/task-status** API to track status. | [optional] +**Pending** | Pointer to **[]string** | List of IDs of Access Profiles which are pending deletion. | [optional] +**InUse** | Pointer to [**[]AccessProfileUsage**](access-profile-usage) | List of usages of Access Profiles targeted for deletion. | [optional] + +## Methods + +### NewAccessProfileBulkDeleteResponse + +`func NewAccessProfileBulkDeleteResponse() *AccessProfileBulkDeleteResponse` + +NewAccessProfileBulkDeleteResponse instantiates a new AccessProfileBulkDeleteResponse 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 + +### NewAccessProfileBulkDeleteResponseWithDefaults + +`func NewAccessProfileBulkDeleteResponseWithDefaults() *AccessProfileBulkDeleteResponse` + +NewAccessProfileBulkDeleteResponseWithDefaults instantiates a new AccessProfileBulkDeleteResponse 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 + +### GetTaskId + +`func (o *AccessProfileBulkDeleteResponse) GetTaskId() string` + +GetTaskId returns the TaskId field if non-nil, zero value otherwise. + +### GetTaskIdOk + +`func (o *AccessProfileBulkDeleteResponse) GetTaskIdOk() (*string, bool)` + +GetTaskIdOk returns a tuple with the TaskId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskId + +`func (o *AccessProfileBulkDeleteResponse) SetTaskId(v string)` + +SetTaskId sets TaskId field to given value. + +### HasTaskId + +`func (o *AccessProfileBulkDeleteResponse) HasTaskId() bool` + +HasTaskId returns a boolean if a field has been set. + +### GetPending + +`func (o *AccessProfileBulkDeleteResponse) GetPending() []string` + +GetPending returns the Pending field if non-nil, zero value otherwise. + +### GetPendingOk + +`func (o *AccessProfileBulkDeleteResponse) GetPendingOk() (*[]string, bool)` + +GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPending + +`func (o *AccessProfileBulkDeleteResponse) SetPending(v []string)` + +SetPending sets Pending field to given value. + +### HasPending + +`func (o *AccessProfileBulkDeleteResponse) HasPending() bool` + +HasPending returns a boolean if a field has been set. + +### GetInUse + +`func (o *AccessProfileBulkDeleteResponse) GetInUse() []AccessProfileUsage` + +GetInUse returns the InUse field if non-nil, zero value otherwise. + +### GetInUseOk + +`func (o *AccessProfileBulkDeleteResponse) GetInUseOk() (*[]AccessProfileUsage, bool)` + +GetInUseOk returns a tuple with the InUse field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInUse + +`func (o *AccessProfileBulkDeleteResponse) SetInUse(v []AccessProfileUsage)` + +SetInUse sets InUse field to given value. + +### HasInUse + +`func (o *AccessProfileBulkDeleteResponse) HasInUse() bool` + +HasInUse returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileBulkUpdateRequestInner.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileBulkUpdateRequestInner.md new file mode 100644 index 000000000..f8925542f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileBulkUpdateRequestInner.md @@ -0,0 +1,90 @@ +--- +id: v2024-access-profile-bulk-update-request-inner +title: AccessProfileBulkUpdateRequestInner +pagination_label: AccessProfileBulkUpdateRequestInner +sidebar_label: AccessProfileBulkUpdateRequestInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileBulkUpdateRequestInner', 'V2024AccessProfileBulkUpdateRequestInner'] +slug: /tools/sdk/go/v2024/models/access-profile-bulk-update-request-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkUpdateRequestInner', 'V2024AccessProfileBulkUpdateRequestInner'] +--- + +# AccessProfileBulkUpdateRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Access Profile ID. | [optional] +**Requestable** | Pointer to **bool** | Access Profile is requestable or not. | [optional] + +## Methods + +### NewAccessProfileBulkUpdateRequestInner + +`func NewAccessProfileBulkUpdateRequestInner() *AccessProfileBulkUpdateRequestInner` + +NewAccessProfileBulkUpdateRequestInner instantiates a new AccessProfileBulkUpdateRequestInner 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 + +### NewAccessProfileBulkUpdateRequestInnerWithDefaults + +`func NewAccessProfileBulkUpdateRequestInnerWithDefaults() *AccessProfileBulkUpdateRequestInner` + +NewAccessProfileBulkUpdateRequestInnerWithDefaults instantiates a new AccessProfileBulkUpdateRequestInner 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 + +### GetId + +`func (o *AccessProfileBulkUpdateRequestInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileBulkUpdateRequestInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileBulkUpdateRequestInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileBulkUpdateRequestInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRequestable + +`func (o *AccessProfileBulkUpdateRequestInner) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *AccessProfileBulkUpdateRequestInner) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *AccessProfileBulkUpdateRequestInner) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *AccessProfileBulkUpdateRequestInner) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileDetails.md new file mode 100644 index 000000000..62953d135 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileDetails.md @@ -0,0 +1,676 @@ +--- +id: v2024-access-profile-details +title: AccessProfileDetails +pagination_label: AccessProfileDetails +sidebar_label: AccessProfileDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileDetails', 'V2024AccessProfileDetails'] +slug: /tools/sdk/go/v2024/models/access-profile-details +tags: ['SDK', 'Software Development Kit', 'AccessProfileDetails', 'V2024AccessProfileDetails'] +--- + +# AccessProfileDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the Access Profile | [optional] +**Name** | Pointer to **string** | Name of the Access Profile | [optional] +**Description** | Pointer to **NullableString** | Information about the Access Profile | [optional] +**Created** | Pointer to **SailPointTime** | Date the Access Profile was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date the Access Profile was last modified. | [optional] +**Disabled** | Pointer to **bool** | Whether the Access Profile is enabled. | [optional] [default to true] +**Requestable** | Pointer to **bool** | Whether the Access Profile is requestable via access request. | [optional] [default to false] +**Protected** | Pointer to **bool** | Whether the Access Profile is protected. | [optional] [default to false] +**OwnerId** | Pointer to **string** | The owner ID of the Access Profile | [optional] +**SourceId** | Pointer to **NullableInt64** | The source ID of the Access Profile | [optional] +**SourceName** | Pointer to **string** | The source name of the Access Profile | [optional] +**AppId** | Pointer to **NullableInt64** | The source app ID of the Access Profile | [optional] +**AppName** | Pointer to **NullableString** | The source app name of the Access Profile | [optional] +**ApplicationId** | Pointer to **string** | The id of the application | [optional] +**Type** | Pointer to **string** | The type of the access profile | [optional] +**Entitlements** | Pointer to **[]string** | List of IDs of entitlements | [optional] +**EntitlementCount** | Pointer to **int32** | The number of entitlements in the access profile | [optional] +**Segments** | Pointer to **[]string** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**ApprovalSchemes** | Pointer to **string** | Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional] +**RevokeRequestApprovalSchemes** | Pointer to **string** | Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional] +**RequestCommentsRequired** | Pointer to **bool** | Whether the access profile require request comment for access request. | [optional] [default to false] +**DeniedCommentsRequired** | Pointer to **bool** | Whether denied comment is required when access request is denied. | [optional] [default to false] +**AccountSelector** | Pointer to [**AccessProfileDetailsAccountSelector**](access-profile-details-account-selector) | | [optional] + +## Methods + +### NewAccessProfileDetails + +`func NewAccessProfileDetails() *AccessProfileDetails` + +NewAccessProfileDetails instantiates a new AccessProfileDetails 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 + +### NewAccessProfileDetailsWithDefaults + +`func NewAccessProfileDetailsWithDefaults() *AccessProfileDetails` + +NewAccessProfileDetailsWithDefaults instantiates a new AccessProfileDetails 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 + +### GetId + +`func (o *AccessProfileDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessProfileDetails) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileDetails) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileDetails) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileDetails) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessProfileDetails) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessProfileDetails) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCreated + +`func (o *AccessProfileDetails) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccessProfileDetails) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccessProfileDetails) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccessProfileDetails) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *AccessProfileDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccessProfileDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccessProfileDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccessProfileDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDisabled + +`func (o *AccessProfileDetails) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *AccessProfileDetails) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *AccessProfileDetails) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *AccessProfileDetails) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetRequestable + +`func (o *AccessProfileDetails) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *AccessProfileDetails) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *AccessProfileDetails) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *AccessProfileDetails) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetProtected + +`func (o *AccessProfileDetails) GetProtected() bool` + +GetProtected returns the Protected field if non-nil, zero value otherwise. + +### GetProtectedOk + +`func (o *AccessProfileDetails) GetProtectedOk() (*bool, bool)` + +GetProtectedOk returns a tuple with the Protected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProtected + +`func (o *AccessProfileDetails) SetProtected(v bool)` + +SetProtected sets Protected field to given value. + +### HasProtected + +`func (o *AccessProfileDetails) HasProtected() bool` + +HasProtected returns a boolean if a field has been set. + +### GetOwnerId + +`func (o *AccessProfileDetails) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *AccessProfileDetails) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *AccessProfileDetails) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *AccessProfileDetails) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessProfileDetails) GetSourceId() int64` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessProfileDetails) GetSourceIdOk() (*int64, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessProfileDetails) SetSourceId(v int64)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessProfileDetails) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### SetSourceIdNil + +`func (o *AccessProfileDetails) SetSourceIdNil(b bool)` + + SetSourceIdNil sets the value for SourceId to be an explicit nil + +### UnsetSourceId +`func (o *AccessProfileDetails) UnsetSourceId()` + +UnsetSourceId ensures that no value is present for SourceId, not even an explicit nil +### GetSourceName + +`func (o *AccessProfileDetails) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessProfileDetails) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessProfileDetails) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessProfileDetails) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetAppId + +`func (o *AccessProfileDetails) GetAppId() int64` + +GetAppId returns the AppId field if non-nil, zero value otherwise. + +### GetAppIdOk + +`func (o *AccessProfileDetails) GetAppIdOk() (*int64, bool)` + +GetAppIdOk returns a tuple with the AppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppId + +`func (o *AccessProfileDetails) SetAppId(v int64)` + +SetAppId sets AppId field to given value. + +### HasAppId + +`func (o *AccessProfileDetails) HasAppId() bool` + +HasAppId returns a boolean if a field has been set. + +### SetAppIdNil + +`func (o *AccessProfileDetails) SetAppIdNil(b bool)` + + SetAppIdNil sets the value for AppId to be an explicit nil + +### UnsetAppId +`func (o *AccessProfileDetails) UnsetAppId()` + +UnsetAppId ensures that no value is present for AppId, not even an explicit nil +### GetAppName + +`func (o *AccessProfileDetails) GetAppName() string` + +GetAppName returns the AppName field if non-nil, zero value otherwise. + +### GetAppNameOk + +`func (o *AccessProfileDetails) GetAppNameOk() (*string, bool)` + +GetAppNameOk returns a tuple with the AppName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppName + +`func (o *AccessProfileDetails) SetAppName(v string)` + +SetAppName sets AppName field to given value. + +### HasAppName + +`func (o *AccessProfileDetails) HasAppName() bool` + +HasAppName returns a boolean if a field has been set. + +### SetAppNameNil + +`func (o *AccessProfileDetails) SetAppNameNil(b bool)` + + SetAppNameNil sets the value for AppName to be an explicit nil + +### UnsetAppName +`func (o *AccessProfileDetails) UnsetAppName()` + +UnsetAppName ensures that no value is present for AppName, not even an explicit nil +### GetApplicationId + +`func (o *AccessProfileDetails) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *AccessProfileDetails) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *AccessProfileDetails) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *AccessProfileDetails) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessProfileDetails) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileDetails) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileDetails) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileDetails) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetEntitlements + +`func (o *AccessProfileDetails) GetEntitlements() []string` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *AccessProfileDetails) GetEntitlementsOk() (*[]string, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *AccessProfileDetails) SetEntitlements(v []string)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *AccessProfileDetails) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccessProfileDetails) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccessProfileDetails) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccessProfileDetails) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccessProfileDetails) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetSegments + +`func (o *AccessProfileDetails) GetSegments() []string` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *AccessProfileDetails) GetSegmentsOk() (*[]string, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *AccessProfileDetails) SetSegments(v []string)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *AccessProfileDetails) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### GetApprovalSchemes + +`func (o *AccessProfileDetails) GetApprovalSchemes() string` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *AccessProfileDetails) GetApprovalSchemesOk() (*string, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *AccessProfileDetails) SetApprovalSchemes(v string)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *AccessProfileDetails) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + +### GetRevokeRequestApprovalSchemes + +`func (o *AccessProfileDetails) GetRevokeRequestApprovalSchemes() string` + +GetRevokeRequestApprovalSchemes returns the RevokeRequestApprovalSchemes field if non-nil, zero value otherwise. + +### GetRevokeRequestApprovalSchemesOk + +`func (o *AccessProfileDetails) GetRevokeRequestApprovalSchemesOk() (*string, bool)` + +GetRevokeRequestApprovalSchemesOk returns a tuple with the RevokeRequestApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevokeRequestApprovalSchemes + +`func (o *AccessProfileDetails) SetRevokeRequestApprovalSchemes(v string)` + +SetRevokeRequestApprovalSchemes sets RevokeRequestApprovalSchemes field to given value. + +### HasRevokeRequestApprovalSchemes + +`func (o *AccessProfileDetails) HasRevokeRequestApprovalSchemes() bool` + +HasRevokeRequestApprovalSchemes returns a boolean if a field has been set. + +### GetRequestCommentsRequired + +`func (o *AccessProfileDetails) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *AccessProfileDetails) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *AccessProfileDetails) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *AccessProfileDetails) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + +### GetDeniedCommentsRequired + +`func (o *AccessProfileDetails) GetDeniedCommentsRequired() bool` + +GetDeniedCommentsRequired returns the DeniedCommentsRequired field if non-nil, zero value otherwise. + +### GetDeniedCommentsRequiredOk + +`func (o *AccessProfileDetails) GetDeniedCommentsRequiredOk() (*bool, bool)` + +GetDeniedCommentsRequiredOk returns a tuple with the DeniedCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeniedCommentsRequired + +`func (o *AccessProfileDetails) SetDeniedCommentsRequired(v bool)` + +SetDeniedCommentsRequired sets DeniedCommentsRequired field to given value. + +### HasDeniedCommentsRequired + +`func (o *AccessProfileDetails) HasDeniedCommentsRequired() bool` + +HasDeniedCommentsRequired returns a boolean if a field has been set. + +### GetAccountSelector + +`func (o *AccessProfileDetails) GetAccountSelector() AccessProfileDetailsAccountSelector` + +GetAccountSelector returns the AccountSelector field if non-nil, zero value otherwise. + +### GetAccountSelectorOk + +`func (o *AccessProfileDetails) GetAccountSelectorOk() (*AccessProfileDetailsAccountSelector, bool)` + +GetAccountSelectorOk returns a tuple with the AccountSelector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSelector + +`func (o *AccessProfileDetails) SetAccountSelector(v AccessProfileDetailsAccountSelector)` + +SetAccountSelector sets AccountSelector field to given value. + +### HasAccountSelector + +`func (o *AccessProfileDetails) HasAccountSelector() bool` + +HasAccountSelector returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileDetailsAccountSelector.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileDetailsAccountSelector.md new file mode 100644 index 000000000..2b077a1cf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileDetailsAccountSelector.md @@ -0,0 +1,74 @@ +--- +id: v2024-access-profile-details-account-selector +title: AccessProfileDetailsAccountSelector +pagination_label: AccessProfileDetailsAccountSelector +sidebar_label: AccessProfileDetailsAccountSelector +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileDetailsAccountSelector', 'V2024AccessProfileDetailsAccountSelector'] +slug: /tools/sdk/go/v2024/models/access-profile-details-account-selector +tags: ['SDK', 'Software Development Kit', 'AccessProfileDetailsAccountSelector', 'V2024AccessProfileDetailsAccountSelector'] +--- + +# AccessProfileDetailsAccountSelector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Selectors** | Pointer to [**[]Selector**](selector) | | [optional] + +## Methods + +### NewAccessProfileDetailsAccountSelector + +`func NewAccessProfileDetailsAccountSelector() *AccessProfileDetailsAccountSelector` + +NewAccessProfileDetailsAccountSelector instantiates a new AccessProfileDetailsAccountSelector 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 + +### NewAccessProfileDetailsAccountSelectorWithDefaults + +`func NewAccessProfileDetailsAccountSelectorWithDefaults() *AccessProfileDetailsAccountSelector` + +NewAccessProfileDetailsAccountSelectorWithDefaults instantiates a new AccessProfileDetailsAccountSelector 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 + +### GetSelectors + +`func (o *AccessProfileDetailsAccountSelector) GetSelectors() []Selector` + +GetSelectors returns the Selectors field if non-nil, zero value otherwise. + +### GetSelectorsOk + +`func (o *AccessProfileDetailsAccountSelector) GetSelectorsOk() (*[]Selector, bool)` + +GetSelectorsOk returns a tuple with the Selectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectors + +`func (o *AccessProfileDetailsAccountSelector) SetSelectors(v []Selector)` + +SetSelectors sets Selectors field to given value. + +### HasSelectors + +`func (o *AccessProfileDetailsAccountSelector) HasSelectors() bool` + +HasSelectors returns a boolean if a field has been set. + +### SetSelectorsNil + +`func (o *AccessProfileDetailsAccountSelector) SetSelectorsNil(b bool)` + + SetSelectorsNil sets the value for Selectors to be an explicit nil + +### UnsetSelectors +`func (o *AccessProfileDetailsAccountSelector) UnsetSelectors()` + +UnsetSelectors ensures that no value is present for Selectors, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileDocument.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileDocument.md new file mode 100644 index 000000000..3a8738e6e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileDocument.md @@ -0,0 +1,500 @@ +--- +id: v2024-access-profile-document +title: AccessProfileDocument +pagination_label: AccessProfileDocument +sidebar_label: AccessProfileDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileDocument', 'V2024AccessProfileDocument'] +slug: /tools/sdk/go/v2024/models/access-profile-document +tags: ['SDK', 'Software Development Kit', 'AccessProfileDocument', 'V2024AccessProfileDocument'] +--- + +# AccessProfileDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Access item's description. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **NullableTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Enabled** | Pointer to **bool** | Indicates whether the access item is currently enabled. | [optional] [default to false] +**Requestable** | Pointer to **bool** | Indicates whether the access item can be requested. | [optional] [default to true] +**RequestCommentsRequired** | Pointer to **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to false] +**Owner** | Pointer to [**BaseAccessOwner**](base-access-owner) | | [optional] +**Id** | **string** | Access profile's ID. | +**Name** | **string** | Access profile's name. | +**Source** | Pointer to [**AccessProfileDocumentAllOfSource**](access-profile-document-all-of-source) | | [optional] +**Entitlements** | Pointer to [**[]BaseEntitlement**](base-entitlement) | Entitlements the access profile has access to. | [optional] +**EntitlementCount** | Pointer to **int32** | Number of entitlements. | [optional] +**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the access profile. | [optional] +**SegmentCount** | Pointer to **int32** | Number of segments with the access profile. | [optional] +**Tags** | Pointer to **[]string** | Tags that have been applied to the object. | [optional] +**Apps** | Pointer to [**[]AccessApps**](access-apps) | Applications with the access profile | [optional] + +## Methods + +### NewAccessProfileDocument + +`func NewAccessProfileDocument(id string, name string, ) *AccessProfileDocument` + +NewAccessProfileDocument instantiates a new AccessProfileDocument 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 + +### NewAccessProfileDocumentWithDefaults + +`func NewAccessProfileDocumentWithDefaults() *AccessProfileDocument` + +NewAccessProfileDocumentWithDefaults instantiates a new AccessProfileDocument 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 + +### GetDescription + +`func (o *AccessProfileDocument) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileDocument) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileDocument) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileDocument) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetCreated + +`func (o *AccessProfileDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccessProfileDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccessProfileDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccessProfileDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *AccessProfileDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *AccessProfileDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *AccessProfileDocument) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccessProfileDocument) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccessProfileDocument) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccessProfileDocument) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *AccessProfileDocument) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *AccessProfileDocument) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *AccessProfileDocument) GetSynced() SailPointTime` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *AccessProfileDocument) GetSyncedOk() (*SailPointTime, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *AccessProfileDocument) SetSynced(v SailPointTime)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *AccessProfileDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### SetSyncedNil + +`func (o *AccessProfileDocument) SetSyncedNil(b bool)` + + SetSyncedNil sets the value for Synced to be an explicit nil + +### UnsetSynced +`func (o *AccessProfileDocument) UnsetSynced()` + +UnsetSynced ensures that no value is present for Synced, not even an explicit nil +### GetEnabled + +`func (o *AccessProfileDocument) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AccessProfileDocument) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AccessProfileDocument) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *AccessProfileDocument) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetRequestable + +`func (o *AccessProfileDocument) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *AccessProfileDocument) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *AccessProfileDocument) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *AccessProfileDocument) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetRequestCommentsRequired + +`func (o *AccessProfileDocument) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *AccessProfileDocument) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *AccessProfileDocument) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *AccessProfileDocument) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + +### GetOwner + +`func (o *AccessProfileDocument) GetOwner() BaseAccessOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *AccessProfileDocument) GetOwnerOk() (*BaseAccessOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *AccessProfileDocument) SetOwner(v BaseAccessOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *AccessProfileDocument) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetId + +`func (o *AccessProfileDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileDocument) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessProfileDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileDocument) SetName(v string)` + +SetName sets Name field to given value. + + +### GetSource + +`func (o *AccessProfileDocument) GetSource() AccessProfileDocumentAllOfSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccessProfileDocument) GetSourceOk() (*AccessProfileDocumentAllOfSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccessProfileDocument) SetSource(v AccessProfileDocumentAllOfSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *AccessProfileDocument) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetEntitlements + +`func (o *AccessProfileDocument) GetEntitlements() []BaseEntitlement` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *AccessProfileDocument) GetEntitlementsOk() (*[]BaseEntitlement, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *AccessProfileDocument) SetEntitlements(v []BaseEntitlement)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *AccessProfileDocument) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccessProfileDocument) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccessProfileDocument) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccessProfileDocument) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccessProfileDocument) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetSegments + +`func (o *AccessProfileDocument) GetSegments() []BaseSegment` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *AccessProfileDocument) GetSegmentsOk() (*[]BaseSegment, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *AccessProfileDocument) SetSegments(v []BaseSegment)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *AccessProfileDocument) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### GetSegmentCount + +`func (o *AccessProfileDocument) GetSegmentCount() int32` + +GetSegmentCount returns the SegmentCount field if non-nil, zero value otherwise. + +### GetSegmentCountOk + +`func (o *AccessProfileDocument) GetSegmentCountOk() (*int32, bool)` + +GetSegmentCountOk returns a tuple with the SegmentCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegmentCount + +`func (o *AccessProfileDocument) SetSegmentCount(v int32)` + +SetSegmentCount sets SegmentCount field to given value. + +### HasSegmentCount + +`func (o *AccessProfileDocument) HasSegmentCount() bool` + +HasSegmentCount returns a boolean if a field has been set. + +### GetTags + +`func (o *AccessProfileDocument) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *AccessProfileDocument) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *AccessProfileDocument) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *AccessProfileDocument) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetApps + +`func (o *AccessProfileDocument) GetApps() []AccessApps` + +GetApps returns the Apps field if non-nil, zero value otherwise. + +### GetAppsOk + +`func (o *AccessProfileDocument) GetAppsOk() (*[]AccessApps, bool)` + +GetAppsOk returns a tuple with the Apps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApps + +`func (o *AccessProfileDocument) SetApps(v []AccessApps)` + +SetApps sets Apps field to given value. + +### HasApps + +`func (o *AccessProfileDocument) HasApps() bool` + +HasApps returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileDocumentAllOfSource.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileDocumentAllOfSource.md new file mode 100644 index 000000000..889acd789 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileDocumentAllOfSource.md @@ -0,0 +1,90 @@ +--- +id: v2024-access-profile-document-all-of-source +title: AccessProfileDocumentAllOfSource +pagination_label: AccessProfileDocumentAllOfSource +sidebar_label: AccessProfileDocumentAllOfSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileDocumentAllOfSource', 'V2024AccessProfileDocumentAllOfSource'] +slug: /tools/sdk/go/v2024/models/access-profile-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'AccessProfileDocumentAllOfSource', 'V2024AccessProfileDocumentAllOfSource'] +--- + +# AccessProfileDocumentAllOfSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Source's ID. | [optional] +**Name** | Pointer to **string** | Source's name. | [optional] + +## Methods + +### NewAccessProfileDocumentAllOfSource + +`func NewAccessProfileDocumentAllOfSource() *AccessProfileDocumentAllOfSource` + +NewAccessProfileDocumentAllOfSource instantiates a new AccessProfileDocumentAllOfSource 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 + +### NewAccessProfileDocumentAllOfSourceWithDefaults + +`func NewAccessProfileDocumentAllOfSourceWithDefaults() *AccessProfileDocumentAllOfSource` + +NewAccessProfileDocumentAllOfSourceWithDefaults instantiates a new AccessProfileDocumentAllOfSource 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 + +### GetId + +`func (o *AccessProfileDocumentAllOfSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileDocumentAllOfSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileDocumentAllOfSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileDocumentAllOfSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileDocumentAllOfSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileDocumentAllOfSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileDocumentAllOfSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileDocumentAllOfSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileEntitlement.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileEntitlement.md new file mode 100644 index 000000000..6f3162bf0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileEntitlement.md @@ -0,0 +1,308 @@ +--- +id: v2024-access-profile-entitlement +title: AccessProfileEntitlement +pagination_label: AccessProfileEntitlement +sidebar_label: AccessProfileEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileEntitlement', 'V2024AccessProfileEntitlement'] +slug: /tools/sdk/go/v2024/models/access-profile-entitlement +tags: ['SDK', 'Software Development Kit', 'AccessProfileEntitlement', 'V2024AccessProfileEntitlement'] +--- + +# AccessProfileEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Source** | Pointer to [**Reference**](reference) | | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Privileged** | Pointer to **bool** | | [optional] +**Attribute** | Pointer to **string** | | [optional] +**Value** | Pointer to **string** | | [optional] +**Standalone** | Pointer to **bool** | | [optional] + +## Methods + +### NewAccessProfileEntitlement + +`func NewAccessProfileEntitlement() *AccessProfileEntitlement` + +NewAccessProfileEntitlement instantiates a new AccessProfileEntitlement 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 + +### NewAccessProfileEntitlementWithDefaults + +`func NewAccessProfileEntitlementWithDefaults() *AccessProfileEntitlement` + +NewAccessProfileEntitlementWithDefaults instantiates a new AccessProfileEntitlement 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 + +### GetId + +`func (o *AccessProfileEntitlement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileEntitlement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileEntitlement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileEntitlement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileEntitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileEntitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileEntitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileEntitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessProfileEntitlement) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessProfileEntitlement) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessProfileEntitlement) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessProfileEntitlement) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessProfileEntitlement) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileEntitlement) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileEntitlement) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileEntitlement) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessProfileEntitlement) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessProfileEntitlement) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSource + +`func (o *AccessProfileEntitlement) GetSource() Reference` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccessProfileEntitlement) GetSourceOk() (*Reference, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccessProfileEntitlement) SetSource(v Reference)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *AccessProfileEntitlement) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetType + +`func (o *AccessProfileEntitlement) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileEntitlement) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileEntitlement) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileEntitlement) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *AccessProfileEntitlement) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *AccessProfileEntitlement) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *AccessProfileEntitlement) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *AccessProfileEntitlement) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetAttribute + +`func (o *AccessProfileEntitlement) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *AccessProfileEntitlement) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *AccessProfileEntitlement) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *AccessProfileEntitlement) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *AccessProfileEntitlement) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AccessProfileEntitlement) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AccessProfileEntitlement) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AccessProfileEntitlement) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetStandalone + +`func (o *AccessProfileEntitlement) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *AccessProfileEntitlement) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *AccessProfileEntitlement) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + +### HasStandalone + +`func (o *AccessProfileEntitlement) HasStandalone() bool` + +HasStandalone returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileRef.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileRef.md new file mode 100644 index 000000000..21ec6d90c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileRef.md @@ -0,0 +1,116 @@ +--- +id: v2024-access-profile-ref +title: AccessProfileRef +pagination_label: AccessProfileRef +sidebar_label: AccessProfileRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileRef', 'V2024AccessProfileRef'] +slug: /tools/sdk/go/v2024/models/access-profile-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'V2024AccessProfileRef'] +--- + +# AccessProfileRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the Access Profile | [optional] +**Type** | Pointer to **string** | Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result. | [optional] +**Name** | Pointer to **string** | Human-readable display name of the Access Profile. This field is ignored on input. | [optional] + +## Methods + +### NewAccessProfileRef + +`func NewAccessProfileRef() *AccessProfileRef` + +NewAccessProfileRef instantiates a new AccessProfileRef 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 + +### NewAccessProfileRefWithDefaults + +`func NewAccessProfileRefWithDefaults() *AccessProfileRef` + +NewAccessProfileRefWithDefaults instantiates a new AccessProfileRef 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 + +### GetId + +`func (o *AccessProfileRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessProfileRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileRole.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileRole.md new file mode 100644 index 000000000..c3af88fa0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileRole.md @@ -0,0 +1,256 @@ +--- +id: v2024-access-profile-role +title: AccessProfileRole +pagination_label: AccessProfileRole +sidebar_label: AccessProfileRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileRole', 'V2024AccessProfileRole'] +slug: /tools/sdk/go/v2024/models/access-profile-role +tags: ['SDK', 'Software Development Kit', 'AccessProfileRole', 'V2024AccessProfileRole'] +--- + +# AccessProfileRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional] +**Disabled** | Pointer to **bool** | | [optional] +**Revocable** | Pointer to **bool** | | [optional] + +## Methods + +### NewAccessProfileRole + +`func NewAccessProfileRole() *AccessProfileRole` + +NewAccessProfileRole instantiates a new AccessProfileRole 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 + +### NewAccessProfileRoleWithDefaults + +`func NewAccessProfileRoleWithDefaults() *AccessProfileRole` + +NewAccessProfileRoleWithDefaults instantiates a new AccessProfileRole 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 + +### GetId + +`func (o *AccessProfileRole) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileRole) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileRole) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileRole) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileRole) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileRole) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileRole) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileRole) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessProfileRole) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessProfileRole) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessProfileRole) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessProfileRole) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessProfileRole) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileRole) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileRole) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileRole) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessProfileRole) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessProfileRole) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *AccessProfileRole) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileRole) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileRole) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileRole) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetOwner + +`func (o *AccessProfileRole) GetOwner() DisplayReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *AccessProfileRole) GetOwnerOk() (*DisplayReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *AccessProfileRole) SetOwner(v DisplayReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *AccessProfileRole) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDisabled + +`func (o *AccessProfileRole) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *AccessProfileRole) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *AccessProfileRole) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *AccessProfileRole) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetRevocable + +`func (o *AccessProfileRole) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *AccessProfileRole) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *AccessProfileRole) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *AccessProfileRole) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileSourceRef.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileSourceRef.md new file mode 100644 index 000000000..6f6897ebd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileSourceRef.md @@ -0,0 +1,116 @@ +--- +id: v2024-access-profile-source-ref +title: AccessProfileSourceRef +pagination_label: AccessProfileSourceRef +sidebar_label: AccessProfileSourceRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileSourceRef', 'V2024AccessProfileSourceRef'] +slug: /tools/sdk/go/v2024/models/access-profile-source-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'V2024AccessProfileSourceRef'] +--- + +# AccessProfileSourceRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the source the access profile is associated with. | [optional] +**Type** | Pointer to **string** | Source's DTO type. | [optional] +**Name** | Pointer to **string** | Source name. | [optional] + +## Methods + +### NewAccessProfileSourceRef + +`func NewAccessProfileSourceRef() *AccessProfileSourceRef` + +NewAccessProfileSourceRef instantiates a new AccessProfileSourceRef 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 + +### NewAccessProfileSourceRefWithDefaults + +`func NewAccessProfileSourceRefWithDefaults() *AccessProfileSourceRef` + +NewAccessProfileSourceRefWithDefaults instantiates a new AccessProfileSourceRef 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 + +### GetId + +`func (o *AccessProfileSourceRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileSourceRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileSourceRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileSourceRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessProfileSourceRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileSourceRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileSourceRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileSourceRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileSourceRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileSourceRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileSourceRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileSourceRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileSummary.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileSummary.md new file mode 100644 index 000000000..f0c4db9da --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileSummary.md @@ -0,0 +1,256 @@ +--- +id: v2024-access-profile-summary +title: AccessProfileSummary +pagination_label: AccessProfileSummary +sidebar_label: AccessProfileSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileSummary', 'V2024AccessProfileSummary'] +slug: /tools/sdk/go/v2024/models/access-profile-summary +tags: ['SDK', 'Software Development Kit', 'AccessProfileSummary', 'V2024AccessProfileSummary'] +--- + +# AccessProfileSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Source** | Pointer to [**Reference**](reference) | | [optional] +**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional] +**Revocable** | Pointer to **bool** | | [optional] + +## Methods + +### NewAccessProfileSummary + +`func NewAccessProfileSummary() *AccessProfileSummary` + +NewAccessProfileSummary instantiates a new AccessProfileSummary 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 + +### NewAccessProfileSummaryWithDefaults + +`func NewAccessProfileSummaryWithDefaults() *AccessProfileSummary` + +NewAccessProfileSummaryWithDefaults instantiates a new AccessProfileSummary 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 + +### GetId + +`func (o *AccessProfileSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileSummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileSummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileSummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileSummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileSummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileSummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessProfileSummary) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessProfileSummary) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessProfileSummary) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessProfileSummary) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessProfileSummary) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileSummary) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileSummary) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileSummary) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessProfileSummary) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessProfileSummary) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *AccessProfileSummary) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileSummary) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileSummary) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSource + +`func (o *AccessProfileSummary) GetSource() Reference` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccessProfileSummary) GetSourceOk() (*Reference, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccessProfileSummary) SetSource(v Reference)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *AccessProfileSummary) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetOwner + +`func (o *AccessProfileSummary) GetOwner() DisplayReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *AccessProfileSummary) GetOwnerOk() (*DisplayReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *AccessProfileSummary) SetOwner(v DisplayReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *AccessProfileSummary) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRevocable + +`func (o *AccessProfileSummary) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *AccessProfileSummary) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *AccessProfileSummary) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *AccessProfileSummary) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileUpdateItem.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileUpdateItem.md new file mode 100644 index 000000000..75bc4236c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileUpdateItem.md @@ -0,0 +1,127 @@ +--- +id: v2024-access-profile-update-item +title: AccessProfileUpdateItem +pagination_label: AccessProfileUpdateItem +sidebar_label: AccessProfileUpdateItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileUpdateItem', 'V2024AccessProfileUpdateItem'] +slug: /tools/sdk/go/v2024/models/access-profile-update-item +tags: ['SDK', 'Software Development Kit', 'AccessProfileUpdateItem', 'V2024AccessProfileUpdateItem'] +--- + +# AccessProfileUpdateItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Identifier of Access Profile in bulk update request. | +**Requestable** | **bool** | Access Profile requestable or not. | +**Status** | **string** | The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. | +**Description** | Pointer to **string** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Methods + +### NewAccessProfileUpdateItem + +`func NewAccessProfileUpdateItem(id string, requestable bool, status string, ) *AccessProfileUpdateItem` + +NewAccessProfileUpdateItem instantiates a new AccessProfileUpdateItem 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 + +### NewAccessProfileUpdateItemWithDefaults + +`func NewAccessProfileUpdateItemWithDefaults() *AccessProfileUpdateItem` + +NewAccessProfileUpdateItemWithDefaults instantiates a new AccessProfileUpdateItem 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 + +### GetId + +`func (o *AccessProfileUpdateItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileUpdateItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileUpdateItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetRequestable + +`func (o *AccessProfileUpdateItem) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *AccessProfileUpdateItem) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *AccessProfileUpdateItem) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + + +### GetStatus + +`func (o *AccessProfileUpdateItem) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccessProfileUpdateItem) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccessProfileUpdateItem) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetDescription + +`func (o *AccessProfileUpdateItem) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileUpdateItem) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileUpdateItem) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileUpdateItem) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileUsage.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileUsage.md new file mode 100644 index 000000000..61acc6c0c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileUsage.md @@ -0,0 +1,90 @@ +--- +id: v2024-access-profile-usage +title: AccessProfileUsage +pagination_label: AccessProfileUsage +sidebar_label: AccessProfileUsage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileUsage', 'V2024AccessProfileUsage'] +slug: /tools/sdk/go/v2024/models/access-profile-usage +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'V2024AccessProfileUsage'] +--- + +# AccessProfileUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessProfileId** | Pointer to **string** | ID of the Access Profile that is in use | [optional] +**UsedBy** | Pointer to [**[]AccessProfileUsageUsedByInner**](access-profile-usage-used-by-inner) | List of references to objects which are using the indicated Access Profile | [optional] + +## Methods + +### NewAccessProfileUsage + +`func NewAccessProfileUsage() *AccessProfileUsage` + +NewAccessProfileUsage instantiates a new AccessProfileUsage 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 + +### NewAccessProfileUsageWithDefaults + +`func NewAccessProfileUsageWithDefaults() *AccessProfileUsage` + +NewAccessProfileUsageWithDefaults instantiates a new AccessProfileUsage 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 + +### GetAccessProfileId + +`func (o *AccessProfileUsage) GetAccessProfileId() string` + +GetAccessProfileId returns the AccessProfileId field if non-nil, zero value otherwise. + +### GetAccessProfileIdOk + +`func (o *AccessProfileUsage) GetAccessProfileIdOk() (*string, bool)` + +GetAccessProfileIdOk returns a tuple with the AccessProfileId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileId + +`func (o *AccessProfileUsage) SetAccessProfileId(v string)` + +SetAccessProfileId sets AccessProfileId field to given value. + +### HasAccessProfileId + +`func (o *AccessProfileUsage) HasAccessProfileId() bool` + +HasAccessProfileId returns a boolean if a field has been set. + +### GetUsedBy + +`func (o *AccessProfileUsage) GetUsedBy() []AccessProfileUsageUsedByInner` + +GetUsedBy returns the UsedBy field if non-nil, zero value otherwise. + +### GetUsedByOk + +`func (o *AccessProfileUsage) GetUsedByOk() (*[]AccessProfileUsageUsedByInner, bool)` + +GetUsedByOk returns a tuple with the UsedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsedBy + +`func (o *AccessProfileUsage) SetUsedBy(v []AccessProfileUsageUsedByInner)` + +SetUsedBy sets UsedBy field to given value. + +### HasUsedBy + +`func (o *AccessProfileUsage) HasUsedBy() bool` + +HasUsedBy returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileUsageUsedByInner.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileUsageUsedByInner.md new file mode 100644 index 000000000..ecf352d15 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessProfileUsageUsedByInner.md @@ -0,0 +1,116 @@ +--- +id: v2024-access-profile-usage-used-by-inner +title: AccessProfileUsageUsedByInner +pagination_label: AccessProfileUsageUsedByInner +sidebar_label: AccessProfileUsageUsedByInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileUsageUsedByInner', 'V2024AccessProfileUsageUsedByInner'] +slug: /tools/sdk/go/v2024/models/access-profile-usage-used-by-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner', 'V2024AccessProfileUsageUsedByInner'] +--- + +# AccessProfileUsageUsedByInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of role using the access profile. | [optional] +**Id** | Pointer to **string** | ID of role using the access profile. | [optional] +**Name** | Pointer to **string** | Display name of role using the access profile. | [optional] + +## Methods + +### NewAccessProfileUsageUsedByInner + +`func NewAccessProfileUsageUsedByInner() *AccessProfileUsageUsedByInner` + +NewAccessProfileUsageUsedByInner instantiates a new AccessProfileUsageUsedByInner 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 + +### NewAccessProfileUsageUsedByInnerWithDefaults + +`func NewAccessProfileUsageUsedByInnerWithDefaults() *AccessProfileUsageUsedByInner` + +NewAccessProfileUsageUsedByInnerWithDefaults instantiates a new AccessProfileUsageUsedByInner 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 + +### GetType + +`func (o *AccessProfileUsageUsedByInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileUsageUsedByInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileUsageUsedByInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileUsageUsedByInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessProfileUsageUsedByInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileUsageUsedByInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileUsageUsedByInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileUsageUsedByInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileUsageUsedByInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileUsageUsedByInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileUsageUsedByInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileUsageUsedByInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRecommendationMessage.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRecommendationMessage.md new file mode 100644 index 000000000..e588eebc2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRecommendationMessage.md @@ -0,0 +1,64 @@ +--- +id: v2024-access-recommendation-message +title: AccessRecommendationMessage +pagination_label: AccessRecommendationMessage +sidebar_label: AccessRecommendationMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRecommendationMessage', 'V2024AccessRecommendationMessage'] +slug: /tools/sdk/go/v2024/models/access-recommendation-message +tags: ['SDK', 'Software Development Kit', 'AccessRecommendationMessage', 'V2024AccessRecommendationMessage'] +--- + +# AccessRecommendationMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Interpretation** | Pointer to **string** | Information about why the access item was recommended. | [optional] + +## Methods + +### NewAccessRecommendationMessage + +`func NewAccessRecommendationMessage() *AccessRecommendationMessage` + +NewAccessRecommendationMessage instantiates a new AccessRecommendationMessage 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 + +### NewAccessRecommendationMessageWithDefaults + +`func NewAccessRecommendationMessageWithDefaults() *AccessRecommendationMessage` + +NewAccessRecommendationMessageWithDefaults instantiates a new AccessRecommendationMessage 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 + +### GetInterpretation + +`func (o *AccessRecommendationMessage) GetInterpretation() string` + +GetInterpretation returns the Interpretation field if non-nil, zero value otherwise. + +### GetInterpretationOk + +`func (o *AccessRecommendationMessage) GetInterpretationOk() (*string, bool)` + +GetInterpretationOk returns a tuple with the Interpretation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterpretation + +`func (o *AccessRecommendationMessage) SetInterpretation(v string)` + +SetInterpretation sets Interpretation field to given value. + +### HasInterpretation + +`func (o *AccessRecommendationMessage) HasInterpretation() bool` + +HasInterpretation returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequest.md new file mode 100644 index 000000000..4d3fa5578 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequest.md @@ -0,0 +1,178 @@ +--- +id: v2024-access-request +title: AccessRequest +pagination_label: AccessRequest +sidebar_label: AccessRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequest', 'V2024AccessRequest'] +slug: /tools/sdk/go/v2024/models/access-request +tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'V2024AccessRequest'] +--- + +# AccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedFor** | **[]string** | A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. | +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**RequestedForWithRequestedItems** | Pointer to [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] + +## Methods + +### NewAccessRequest + +`func NewAccessRequest(requestedFor []string, requestedItems []AccessRequestItem, ) *AccessRequest` + +NewAccessRequest instantiates a new AccessRequest 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 + +### NewAccessRequestWithDefaults + +`func NewAccessRequestWithDefaults() *AccessRequest` + +NewAccessRequestWithDefaults instantiates a new AccessRequest 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 + +### GetRequestedFor + +`func (o *AccessRequest) GetRequestedFor() []string` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequest) GetRequestedForOk() (*[]string, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequest) SetRequestedFor(v []string)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestType + +`func (o *AccessRequest) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *AccessRequest) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *AccessRequest) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *AccessRequest) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *AccessRequest) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *AccessRequest) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetRequestedItems + +`func (o *AccessRequest) GetRequestedItems() []AccessRequestItem` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *AccessRequest) GetRequestedItemsOk() (*[]AccessRequestItem, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *AccessRequest) SetRequestedItems(v []AccessRequestItem)` + +SetRequestedItems sets RequestedItems field to given value. + + +### GetClientMetadata + +`func (o *AccessRequest) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccessRequest) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccessRequest) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccessRequest) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRequestedForWithRequestedItems + +`func (o *AccessRequest) GetRequestedForWithRequestedItems() []RequestedForDtoRef` + +GetRequestedForWithRequestedItems returns the RequestedForWithRequestedItems field if non-nil, zero value otherwise. + +### GetRequestedForWithRequestedItemsOk + +`func (o *AccessRequest) GetRequestedForWithRequestedItemsOk() (*[]RequestedForDtoRef, bool)` + +GetRequestedForWithRequestedItemsOk returns a tuple with the RequestedForWithRequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedForWithRequestedItems + +`func (o *AccessRequest) SetRequestedForWithRequestedItems(v []RequestedForDtoRef)` + +SetRequestedForWithRequestedItems sets RequestedForWithRequestedItems field to given value. + +### HasRequestedForWithRequestedItems + +`func (o *AccessRequest) HasRequestedForWithRequestedItems() bool` + +HasRequestedForWithRequestedItems returns a boolean if a field has been set. + +### SetRequestedForWithRequestedItemsNil + +`func (o *AccessRequest) SetRequestedForWithRequestedItemsNil(b bool)` + + SetRequestedForWithRequestedItemsNil sets the value for RequestedForWithRequestedItems to be an explicit nil + +### UnsetRequestedForWithRequestedItems +`func (o *AccessRequest) UnsetRequestedForWithRequestedItems()` + +UnsetRequestedForWithRequestedItems ensures that no value is present for RequestedForWithRequestedItems, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestAdminItemStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestAdminItemStatus.md new file mode 100644 index 000000000..9eac8ebd7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestAdminItemStatus.md @@ -0,0 +1,798 @@ +--- +id: v2024-access-request-admin-item-status +title: AccessRequestAdminItemStatus +pagination_label: AccessRequestAdminItemStatus +sidebar_label: AccessRequestAdminItemStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestAdminItemStatus', 'V2024AccessRequestAdminItemStatus'] +slug: /tools/sdk/go/v2024/models/access-request-admin-item-status +tags: ['SDK', 'Software Development Kit', 'AccessRequestAdminItemStatus', 'V2024AccessRequestAdminItemStatus'] +--- + +# AccessRequestAdminItemStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | ID of the access request. This is a new property as of 2025. Older access requests may not have an ID. | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the item being requested. | [optional] +**Type** | Pointer to **NullableString** | Type of requested object. | [optional] +**CancelledRequestDetails** | Pointer to [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional] +**ErrorMessages** | Pointer to [**[][]ErrorMessageDto**](error-message-dto) | List of localized error messages, if any, encountered during the approval/provisioning process. | [optional] +**State** | Pointer to [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional] +**ApprovalDetails** | Pointer to [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional] +**ManualWorkItemDetails** | Pointer to [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional] +**AccountActivityItemId** | Pointer to **string** | Id of associated account activity item. | [optional] +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**Modified** | Pointer to **NullableTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**RequesterComment** | Pointer to [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional] +**SodViolationContext** | Pointer to [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional] +**ProvisioningDetails** | Pointer to [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional] +**PreApprovalTriggerDetails** | Pointer to [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional] +**AccessRequestPhases** | Pointer to [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional] +**Description** | Pointer to **NullableString** | Description associated to the requested object. | [optional] +**RemoveDate** | Pointer to **NullableTime** | When the role access is scheduled for removal. | [optional] +**Cancelable** | Pointer to **bool** | True if the request can be canceled. | [optional] [default to false] +**ReauthorizationRequired** | Pointer to **bool** | True if re-auth is required. | [optional] [default to false] +**AccessRequestId** | Pointer to **string** | This is the account activity id. | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] + +## Methods + +### NewAccessRequestAdminItemStatus + +`func NewAccessRequestAdminItemStatus() *AccessRequestAdminItemStatus` + +NewAccessRequestAdminItemStatus instantiates a new AccessRequestAdminItemStatus 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 + +### NewAccessRequestAdminItemStatusWithDefaults + +`func NewAccessRequestAdminItemStatusWithDefaults() *AccessRequestAdminItemStatus` + +NewAccessRequestAdminItemStatusWithDefaults instantiates a new AccessRequestAdminItemStatus 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 + +### GetId + +`func (o *AccessRequestAdminItemStatus) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestAdminItemStatus) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestAdminItemStatus) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessRequestAdminItemStatus) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *AccessRequestAdminItemStatus) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *AccessRequestAdminItemStatus) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *AccessRequestAdminItemStatus) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestAdminItemStatus) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestAdminItemStatus) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessRequestAdminItemStatus) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *AccessRequestAdminItemStatus) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *AccessRequestAdminItemStatus) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetType + +`func (o *AccessRequestAdminItemStatus) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestAdminItemStatus) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestAdminItemStatus) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessRequestAdminItemStatus) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *AccessRequestAdminItemStatus) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *AccessRequestAdminItemStatus) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetCancelledRequestDetails + +`func (o *AccessRequestAdminItemStatus) GetCancelledRequestDetails() RequestedItemStatusCancelledRequestDetails` + +GetCancelledRequestDetails returns the CancelledRequestDetails field if non-nil, zero value otherwise. + +### GetCancelledRequestDetailsOk + +`func (o *AccessRequestAdminItemStatus) GetCancelledRequestDetailsOk() (*RequestedItemStatusCancelledRequestDetails, bool)` + +GetCancelledRequestDetailsOk returns a tuple with the CancelledRequestDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCancelledRequestDetails + +`func (o *AccessRequestAdminItemStatus) SetCancelledRequestDetails(v RequestedItemStatusCancelledRequestDetails)` + +SetCancelledRequestDetails sets CancelledRequestDetails field to given value. + +### HasCancelledRequestDetails + +`func (o *AccessRequestAdminItemStatus) HasCancelledRequestDetails() bool` + +HasCancelledRequestDetails returns a boolean if a field has been set. + +### GetErrorMessages + +`func (o *AccessRequestAdminItemStatus) GetErrorMessages() [][]ErrorMessageDto` + +GetErrorMessages returns the ErrorMessages field if non-nil, zero value otherwise. + +### GetErrorMessagesOk + +`func (o *AccessRequestAdminItemStatus) GetErrorMessagesOk() (*[][]ErrorMessageDto, bool)` + +GetErrorMessagesOk returns a tuple with the ErrorMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessages + +`func (o *AccessRequestAdminItemStatus) SetErrorMessages(v [][]ErrorMessageDto)` + +SetErrorMessages sets ErrorMessages field to given value. + +### HasErrorMessages + +`func (o *AccessRequestAdminItemStatus) HasErrorMessages() bool` + +HasErrorMessages returns a boolean if a field has been set. + +### SetErrorMessagesNil + +`func (o *AccessRequestAdminItemStatus) SetErrorMessagesNil(b bool)` + + SetErrorMessagesNil sets the value for ErrorMessages to be an explicit nil + +### UnsetErrorMessages +`func (o *AccessRequestAdminItemStatus) UnsetErrorMessages()` + +UnsetErrorMessages ensures that no value is present for ErrorMessages, not even an explicit nil +### GetState + +`func (o *AccessRequestAdminItemStatus) GetState() RequestedItemStatusRequestState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *AccessRequestAdminItemStatus) GetStateOk() (*RequestedItemStatusRequestState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *AccessRequestAdminItemStatus) SetState(v RequestedItemStatusRequestState)` + +SetState sets State field to given value. + +### HasState + +`func (o *AccessRequestAdminItemStatus) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetApprovalDetails + +`func (o *AccessRequestAdminItemStatus) GetApprovalDetails() []ApprovalStatusDto` + +GetApprovalDetails returns the ApprovalDetails field if non-nil, zero value otherwise. + +### GetApprovalDetailsOk + +`func (o *AccessRequestAdminItemStatus) GetApprovalDetailsOk() (*[]ApprovalStatusDto, bool)` + +GetApprovalDetailsOk returns a tuple with the ApprovalDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalDetails + +`func (o *AccessRequestAdminItemStatus) SetApprovalDetails(v []ApprovalStatusDto)` + +SetApprovalDetails sets ApprovalDetails field to given value. + +### HasApprovalDetails + +`func (o *AccessRequestAdminItemStatus) HasApprovalDetails() bool` + +HasApprovalDetails returns a boolean if a field has been set. + +### GetManualWorkItemDetails + +`func (o *AccessRequestAdminItemStatus) GetManualWorkItemDetails() []ManualWorkItemDetails` + +GetManualWorkItemDetails returns the ManualWorkItemDetails field if non-nil, zero value otherwise. + +### GetManualWorkItemDetailsOk + +`func (o *AccessRequestAdminItemStatus) GetManualWorkItemDetailsOk() (*[]ManualWorkItemDetails, bool)` + +GetManualWorkItemDetailsOk returns a tuple with the ManualWorkItemDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManualWorkItemDetails + +`func (o *AccessRequestAdminItemStatus) SetManualWorkItemDetails(v []ManualWorkItemDetails)` + +SetManualWorkItemDetails sets ManualWorkItemDetails field to given value. + +### HasManualWorkItemDetails + +`func (o *AccessRequestAdminItemStatus) HasManualWorkItemDetails() bool` + +HasManualWorkItemDetails returns a boolean if a field has been set. + +### SetManualWorkItemDetailsNil + +`func (o *AccessRequestAdminItemStatus) SetManualWorkItemDetailsNil(b bool)` + + SetManualWorkItemDetailsNil sets the value for ManualWorkItemDetails to be an explicit nil + +### UnsetManualWorkItemDetails +`func (o *AccessRequestAdminItemStatus) UnsetManualWorkItemDetails()` + +UnsetManualWorkItemDetails ensures that no value is present for ManualWorkItemDetails, not even an explicit nil +### GetAccountActivityItemId + +`func (o *AccessRequestAdminItemStatus) GetAccountActivityItemId() string` + +GetAccountActivityItemId returns the AccountActivityItemId field if non-nil, zero value otherwise. + +### GetAccountActivityItemIdOk + +`func (o *AccessRequestAdminItemStatus) GetAccountActivityItemIdOk() (*string, bool)` + +GetAccountActivityItemIdOk returns a tuple with the AccountActivityItemId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActivityItemId + +`func (o *AccessRequestAdminItemStatus) SetAccountActivityItemId(v string)` + +SetAccountActivityItemId sets AccountActivityItemId field to given value. + +### HasAccountActivityItemId + +`func (o *AccessRequestAdminItemStatus) HasAccountActivityItemId() bool` + +HasAccountActivityItemId returns a boolean if a field has been set. + +### GetRequestType + +`func (o *AccessRequestAdminItemStatus) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *AccessRequestAdminItemStatus) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *AccessRequestAdminItemStatus) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *AccessRequestAdminItemStatus) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *AccessRequestAdminItemStatus) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *AccessRequestAdminItemStatus) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetModified + +`func (o *AccessRequestAdminItemStatus) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccessRequestAdminItemStatus) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccessRequestAdminItemStatus) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccessRequestAdminItemStatus) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *AccessRequestAdminItemStatus) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *AccessRequestAdminItemStatus) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetCreated + +`func (o *AccessRequestAdminItemStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccessRequestAdminItemStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccessRequestAdminItemStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccessRequestAdminItemStatus) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetRequester + +`func (o *AccessRequestAdminItemStatus) GetRequester() AccessItemRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *AccessRequestAdminItemStatus) GetRequesterOk() (*AccessItemRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *AccessRequestAdminItemStatus) SetRequester(v AccessItemRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *AccessRequestAdminItemStatus) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRequestedFor + +`func (o *AccessRequestAdminItemStatus) GetRequestedFor() RequestedItemStatusRequestedFor` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequestAdminItemStatus) GetRequestedForOk() (*RequestedItemStatusRequestedFor, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequestAdminItemStatus) SetRequestedFor(v RequestedItemStatusRequestedFor)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *AccessRequestAdminItemStatus) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *AccessRequestAdminItemStatus) GetRequesterComment() RequestedItemStatusRequesterComment` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *AccessRequestAdminItemStatus) GetRequesterCommentOk() (*RequestedItemStatusRequesterComment, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *AccessRequestAdminItemStatus) SetRequesterComment(v RequestedItemStatusRequesterComment)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *AccessRequestAdminItemStatus) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### GetSodViolationContext + +`func (o *AccessRequestAdminItemStatus) GetSodViolationContext() RequestedItemStatusSodViolationContext` + +GetSodViolationContext returns the SodViolationContext field if non-nil, zero value otherwise. + +### GetSodViolationContextOk + +`func (o *AccessRequestAdminItemStatus) GetSodViolationContextOk() (*RequestedItemStatusSodViolationContext, bool)` + +GetSodViolationContextOk returns a tuple with the SodViolationContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodViolationContext + +`func (o *AccessRequestAdminItemStatus) SetSodViolationContext(v RequestedItemStatusSodViolationContext)` + +SetSodViolationContext sets SodViolationContext field to given value. + +### HasSodViolationContext + +`func (o *AccessRequestAdminItemStatus) HasSodViolationContext() bool` + +HasSodViolationContext returns a boolean if a field has been set. + +### GetProvisioningDetails + +`func (o *AccessRequestAdminItemStatus) GetProvisioningDetails() RequestedItemStatusProvisioningDetails` + +GetProvisioningDetails returns the ProvisioningDetails field if non-nil, zero value otherwise. + +### GetProvisioningDetailsOk + +`func (o *AccessRequestAdminItemStatus) GetProvisioningDetailsOk() (*RequestedItemStatusProvisioningDetails, bool)` + +GetProvisioningDetailsOk returns a tuple with the ProvisioningDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningDetails + +`func (o *AccessRequestAdminItemStatus) SetProvisioningDetails(v RequestedItemStatusProvisioningDetails)` + +SetProvisioningDetails sets ProvisioningDetails field to given value. + +### HasProvisioningDetails + +`func (o *AccessRequestAdminItemStatus) HasProvisioningDetails() bool` + +HasProvisioningDetails returns a boolean if a field has been set. + +### GetPreApprovalTriggerDetails + +`func (o *AccessRequestAdminItemStatus) GetPreApprovalTriggerDetails() RequestedItemStatusPreApprovalTriggerDetails` + +GetPreApprovalTriggerDetails returns the PreApprovalTriggerDetails field if non-nil, zero value otherwise. + +### GetPreApprovalTriggerDetailsOk + +`func (o *AccessRequestAdminItemStatus) GetPreApprovalTriggerDetailsOk() (*RequestedItemStatusPreApprovalTriggerDetails, bool)` + +GetPreApprovalTriggerDetailsOk returns a tuple with the PreApprovalTriggerDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreApprovalTriggerDetails + +`func (o *AccessRequestAdminItemStatus) SetPreApprovalTriggerDetails(v RequestedItemStatusPreApprovalTriggerDetails)` + +SetPreApprovalTriggerDetails sets PreApprovalTriggerDetails field to given value. + +### HasPreApprovalTriggerDetails + +`func (o *AccessRequestAdminItemStatus) HasPreApprovalTriggerDetails() bool` + +HasPreApprovalTriggerDetails returns a boolean if a field has been set. + +### GetAccessRequestPhases + +`func (o *AccessRequestAdminItemStatus) GetAccessRequestPhases() []AccessRequestPhases` + +GetAccessRequestPhases returns the AccessRequestPhases field if non-nil, zero value otherwise. + +### GetAccessRequestPhasesOk + +`func (o *AccessRequestAdminItemStatus) GetAccessRequestPhasesOk() (*[]AccessRequestPhases, bool)` + +GetAccessRequestPhasesOk returns a tuple with the AccessRequestPhases field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestPhases + +`func (o *AccessRequestAdminItemStatus) SetAccessRequestPhases(v []AccessRequestPhases)` + +SetAccessRequestPhases sets AccessRequestPhases field to given value. + +### HasAccessRequestPhases + +`func (o *AccessRequestAdminItemStatus) HasAccessRequestPhases() bool` + +HasAccessRequestPhases returns a boolean if a field has been set. + +### SetAccessRequestPhasesNil + +`func (o *AccessRequestAdminItemStatus) SetAccessRequestPhasesNil(b bool)` + + SetAccessRequestPhasesNil sets the value for AccessRequestPhases to be an explicit nil + +### UnsetAccessRequestPhases +`func (o *AccessRequestAdminItemStatus) UnsetAccessRequestPhases()` + +UnsetAccessRequestPhases ensures that no value is present for AccessRequestPhases, not even an explicit nil +### GetDescription + +`func (o *AccessRequestAdminItemStatus) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestAdminItemStatus) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestAdminItemStatus) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestAdminItemStatus) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessRequestAdminItemStatus) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessRequestAdminItemStatus) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetRemoveDate + +`func (o *AccessRequestAdminItemStatus) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccessRequestAdminItemStatus) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccessRequestAdminItemStatus) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccessRequestAdminItemStatus) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *AccessRequestAdminItemStatus) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *AccessRequestAdminItemStatus) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil +### GetCancelable + +`func (o *AccessRequestAdminItemStatus) GetCancelable() bool` + +GetCancelable returns the Cancelable field if non-nil, zero value otherwise. + +### GetCancelableOk + +`func (o *AccessRequestAdminItemStatus) GetCancelableOk() (*bool, bool)` + +GetCancelableOk returns a tuple with the Cancelable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCancelable + +`func (o *AccessRequestAdminItemStatus) SetCancelable(v bool)` + +SetCancelable sets Cancelable field to given value. + +### HasCancelable + +`func (o *AccessRequestAdminItemStatus) HasCancelable() bool` + +HasCancelable returns a boolean if a field has been set. + +### GetReauthorizationRequired + +`func (o *AccessRequestAdminItemStatus) GetReauthorizationRequired() bool` + +GetReauthorizationRequired returns the ReauthorizationRequired field if non-nil, zero value otherwise. + +### GetReauthorizationRequiredOk + +`func (o *AccessRequestAdminItemStatus) GetReauthorizationRequiredOk() (*bool, bool)` + +GetReauthorizationRequiredOk returns a tuple with the ReauthorizationRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReauthorizationRequired + +`func (o *AccessRequestAdminItemStatus) SetReauthorizationRequired(v bool)` + +SetReauthorizationRequired sets ReauthorizationRequired field to given value. + +### HasReauthorizationRequired + +`func (o *AccessRequestAdminItemStatus) HasReauthorizationRequired() bool` + +HasReauthorizationRequired returns a boolean if a field has been set. + +### GetAccessRequestId + +`func (o *AccessRequestAdminItemStatus) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *AccessRequestAdminItemStatus) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *AccessRequestAdminItemStatus) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + +### HasAccessRequestId + +`func (o *AccessRequestAdminItemStatus) HasAccessRequestId() bool` + +HasAccessRequestId returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *AccessRequestAdminItemStatus) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccessRequestAdminItemStatus) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccessRequestAdminItemStatus) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccessRequestAdminItemStatus) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *AccessRequestAdminItemStatus) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *AccessRequestAdminItemStatus) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestApproversListResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestApproversListResponse.md new file mode 100644 index 000000000..1bdaeeeee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestApproversListResponse.md @@ -0,0 +1,168 @@ +--- +id: v2024-access-request-approvers-list-response +title: AccessRequestApproversListResponse +pagination_label: AccessRequestApproversListResponse +sidebar_label: AccessRequestApproversListResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestApproversListResponse', 'V2024AccessRequestApproversListResponse'] +slug: /tools/sdk/go/v2024/models/access-request-approvers-list-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestApproversListResponse', 'V2024AccessRequestApproversListResponse'] +--- + +# AccessRequestApproversListResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Approver id. | [optional] +**Email** | Pointer to **string** | Email of the approver. | [optional] +**Name** | Pointer to **string** | Name of the approver. | [optional] +**ApprovalId** | Pointer to **string** | Id of the approval item. | [optional] +**Type** | Pointer to **string** | Type of the object returned. In this case, the value for this field will always Identity. | [optional] + +## Methods + +### NewAccessRequestApproversListResponse + +`func NewAccessRequestApproversListResponse() *AccessRequestApproversListResponse` + +NewAccessRequestApproversListResponse instantiates a new AccessRequestApproversListResponse 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 + +### NewAccessRequestApproversListResponseWithDefaults + +`func NewAccessRequestApproversListResponseWithDefaults() *AccessRequestApproversListResponse` + +NewAccessRequestApproversListResponseWithDefaults instantiates a new AccessRequestApproversListResponse 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 + +### GetId + +`func (o *AccessRequestApproversListResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestApproversListResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestApproversListResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessRequestApproversListResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetEmail + +`func (o *AccessRequestApproversListResponse) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *AccessRequestApproversListResponse) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *AccessRequestApproversListResponse) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *AccessRequestApproversListResponse) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetName + +`func (o *AccessRequestApproversListResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestApproversListResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestApproversListResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessRequestApproversListResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetApprovalId + +`func (o *AccessRequestApproversListResponse) GetApprovalId() string` + +GetApprovalId returns the ApprovalId field if non-nil, zero value otherwise. + +### GetApprovalIdOk + +`func (o *AccessRequestApproversListResponse) GetApprovalIdOk() (*string, bool)` + +GetApprovalIdOk returns a tuple with the ApprovalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalId + +`func (o *AccessRequestApproversListResponse) SetApprovalId(v string)` + +SetApprovalId sets ApprovalId field to given value. + +### HasApprovalId + +`func (o *AccessRequestApproversListResponse) HasApprovalId() bool` + +HasApprovalId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessRequestApproversListResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestApproversListResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestApproversListResponse) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessRequestApproversListResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestConfig.md new file mode 100644 index 000000000..42f6c5785 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestConfig.md @@ -0,0 +1,194 @@ +--- +id: v2024-access-request-config +title: AccessRequestConfig +pagination_label: AccessRequestConfig +sidebar_label: AccessRequestConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestConfig', 'V2024AccessRequestConfig'] +slug: /tools/sdk/go/v2024/models/access-request-config +tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig', 'V2024AccessRequestConfig'] +--- + +# AccessRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalsMustBeExternal** | Pointer to **bool** | If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin. | [optional] [default to false] +**AutoApprovalEnabled** | Pointer to **bool** | If this is true and the requester and reviewer are the same, the request is automatically approved. | [optional] [default to false] +**ReauthorizationEnabled** | Pointer to **bool** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to false] +**RequestOnBehalfOfConfig** | Pointer to [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional] +**ApprovalReminderAndEscalationConfig** | Pointer to [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional] +**EntitlementRequestConfig** | Pointer to [**EntitlementRequestConfig**](entitlement-request-config) | | [optional] + +## Methods + +### NewAccessRequestConfig + +`func NewAccessRequestConfig() *AccessRequestConfig` + +NewAccessRequestConfig instantiates a new AccessRequestConfig 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 + +### NewAccessRequestConfigWithDefaults + +`func NewAccessRequestConfigWithDefaults() *AccessRequestConfig` + +NewAccessRequestConfigWithDefaults instantiates a new AccessRequestConfig 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 + +### GetApprovalsMustBeExternal + +`func (o *AccessRequestConfig) GetApprovalsMustBeExternal() bool` + +GetApprovalsMustBeExternal returns the ApprovalsMustBeExternal field if non-nil, zero value otherwise. + +### GetApprovalsMustBeExternalOk + +`func (o *AccessRequestConfig) GetApprovalsMustBeExternalOk() (*bool, bool)` + +GetApprovalsMustBeExternalOk returns a tuple with the ApprovalsMustBeExternal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalsMustBeExternal + +`func (o *AccessRequestConfig) SetApprovalsMustBeExternal(v bool)` + +SetApprovalsMustBeExternal sets ApprovalsMustBeExternal field to given value. + +### HasApprovalsMustBeExternal + +`func (o *AccessRequestConfig) HasApprovalsMustBeExternal() bool` + +HasApprovalsMustBeExternal returns a boolean if a field has been set. + +### GetAutoApprovalEnabled + +`func (o *AccessRequestConfig) GetAutoApprovalEnabled() bool` + +GetAutoApprovalEnabled returns the AutoApprovalEnabled field if non-nil, zero value otherwise. + +### GetAutoApprovalEnabledOk + +`func (o *AccessRequestConfig) GetAutoApprovalEnabledOk() (*bool, bool)` + +GetAutoApprovalEnabledOk returns a tuple with the AutoApprovalEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoApprovalEnabled + +`func (o *AccessRequestConfig) SetAutoApprovalEnabled(v bool)` + +SetAutoApprovalEnabled sets AutoApprovalEnabled field to given value. + +### HasAutoApprovalEnabled + +`func (o *AccessRequestConfig) HasAutoApprovalEnabled() bool` + +HasAutoApprovalEnabled returns a boolean if a field has been set. + +### GetReauthorizationEnabled + +`func (o *AccessRequestConfig) GetReauthorizationEnabled() bool` + +GetReauthorizationEnabled returns the ReauthorizationEnabled field if non-nil, zero value otherwise. + +### GetReauthorizationEnabledOk + +`func (o *AccessRequestConfig) GetReauthorizationEnabledOk() (*bool, bool)` + +GetReauthorizationEnabledOk returns a tuple with the ReauthorizationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReauthorizationEnabled + +`func (o *AccessRequestConfig) SetReauthorizationEnabled(v bool)` + +SetReauthorizationEnabled sets ReauthorizationEnabled field to given value. + +### HasReauthorizationEnabled + +`func (o *AccessRequestConfig) HasReauthorizationEnabled() bool` + +HasReauthorizationEnabled returns a boolean if a field has been set. + +### GetRequestOnBehalfOfConfig + +`func (o *AccessRequestConfig) GetRequestOnBehalfOfConfig() RequestOnBehalfOfConfig` + +GetRequestOnBehalfOfConfig returns the RequestOnBehalfOfConfig field if non-nil, zero value otherwise. + +### GetRequestOnBehalfOfConfigOk + +`func (o *AccessRequestConfig) GetRequestOnBehalfOfConfigOk() (*RequestOnBehalfOfConfig, bool)` + +GetRequestOnBehalfOfConfigOk returns a tuple with the RequestOnBehalfOfConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestOnBehalfOfConfig + +`func (o *AccessRequestConfig) SetRequestOnBehalfOfConfig(v RequestOnBehalfOfConfig)` + +SetRequestOnBehalfOfConfig sets RequestOnBehalfOfConfig field to given value. + +### HasRequestOnBehalfOfConfig + +`func (o *AccessRequestConfig) HasRequestOnBehalfOfConfig() bool` + +HasRequestOnBehalfOfConfig returns a boolean if a field has been set. + +### GetApprovalReminderAndEscalationConfig + +`func (o *AccessRequestConfig) GetApprovalReminderAndEscalationConfig() ApprovalReminderAndEscalationConfig` + +GetApprovalReminderAndEscalationConfig returns the ApprovalReminderAndEscalationConfig field if non-nil, zero value otherwise. + +### GetApprovalReminderAndEscalationConfigOk + +`func (o *AccessRequestConfig) GetApprovalReminderAndEscalationConfigOk() (*ApprovalReminderAndEscalationConfig, bool)` + +GetApprovalReminderAndEscalationConfigOk returns a tuple with the ApprovalReminderAndEscalationConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalReminderAndEscalationConfig + +`func (o *AccessRequestConfig) SetApprovalReminderAndEscalationConfig(v ApprovalReminderAndEscalationConfig)` + +SetApprovalReminderAndEscalationConfig sets ApprovalReminderAndEscalationConfig field to given value. + +### HasApprovalReminderAndEscalationConfig + +`func (o *AccessRequestConfig) HasApprovalReminderAndEscalationConfig() bool` + +HasApprovalReminderAndEscalationConfig returns a boolean if a field has been set. + +### GetEntitlementRequestConfig + +`func (o *AccessRequestConfig) GetEntitlementRequestConfig() EntitlementRequestConfig` + +GetEntitlementRequestConfig returns the EntitlementRequestConfig field if non-nil, zero value otherwise. + +### GetEntitlementRequestConfigOk + +`func (o *AccessRequestConfig) GetEntitlementRequestConfigOk() (*EntitlementRequestConfig, bool)` + +GetEntitlementRequestConfigOk returns a tuple with the EntitlementRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementRequestConfig + +`func (o *AccessRequestConfig) SetEntitlementRequestConfig(v EntitlementRequestConfig)` + +SetEntitlementRequestConfig sets EntitlementRequestConfig field to given value. + +### HasEntitlementRequestConfig + +`func (o *AccessRequestConfig) HasEntitlementRequestConfig() bool` + +HasEntitlementRequestConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestContext.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestContext.md new file mode 100644 index 000000000..9b99981fa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestContext.md @@ -0,0 +1,64 @@ +--- +id: v2024-access-request-context +title: AccessRequestContext +pagination_label: AccessRequestContext +sidebar_label: AccessRequestContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestContext', 'V2024AccessRequestContext'] +slug: /tools/sdk/go/v2024/models/access-request-context +tags: ['SDK', 'Software Development Kit', 'AccessRequestContext', 'V2024AccessRequestContext'] +--- + +# AccessRequestContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContextAttributes** | Pointer to [**[]ContextAttributeDto**](context-attribute-dto) | | [optional] + +## Methods + +### NewAccessRequestContext + +`func NewAccessRequestContext() *AccessRequestContext` + +NewAccessRequestContext instantiates a new AccessRequestContext 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 + +### NewAccessRequestContextWithDefaults + +`func NewAccessRequestContextWithDefaults() *AccessRequestContext` + +NewAccessRequestContextWithDefaults instantiates a new AccessRequestContext 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 + +### GetContextAttributes + +`func (o *AccessRequestContext) GetContextAttributes() []ContextAttributeDto` + +GetContextAttributes returns the ContextAttributes field if non-nil, zero value otherwise. + +### GetContextAttributesOk + +`func (o *AccessRequestContext) GetContextAttributesOk() (*[]ContextAttributeDto, bool)` + +GetContextAttributesOk returns a tuple with the ContextAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContextAttributes + +`func (o *AccessRequestContext) SetContextAttributes(v []ContextAttributeDto)` + +SetContextAttributes sets ContextAttributes field to given value. + +### HasContextAttributes + +`func (o *AccessRequestContext) HasContextAttributes() bool` + +HasContextAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestDynamicApprover.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestDynamicApprover.md new file mode 100644 index 000000000..d52974f05 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestDynamicApprover.md @@ -0,0 +1,122 @@ +--- +id: v2024-access-request-dynamic-approver +title: AccessRequestDynamicApprover +pagination_label: AccessRequestDynamicApprover +sidebar_label: AccessRequestDynamicApprover +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestDynamicApprover', 'V2024AccessRequestDynamicApprover'] +slug: /tools/sdk/go/v2024/models/access-request-dynamic-approver +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover', 'V2024AccessRequestDynamicApprover'] +--- + +# AccessRequestDynamicApprover + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **string** | The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. | +**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | +**RequestedItems** | [**[]AccessRequestDynamicApproverRequestedItemsInner**](access-request-dynamic-approver-requested-items-inner) | The access items that are being requested. | +**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | + +## Methods + +### NewAccessRequestDynamicApprover + +`func NewAccessRequestDynamicApprover(accessRequestId string, requestedFor []AccessItemRequestedForDto, requestedItems []AccessRequestDynamicApproverRequestedItemsInner, requestedBy AccessItemRequesterDto, ) *AccessRequestDynamicApprover` + +NewAccessRequestDynamicApprover instantiates a new AccessRequestDynamicApprover 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 + +### NewAccessRequestDynamicApproverWithDefaults + +`func NewAccessRequestDynamicApproverWithDefaults() *AccessRequestDynamicApprover` + +NewAccessRequestDynamicApproverWithDefaults instantiates a new AccessRequestDynamicApprover 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 + +### GetAccessRequestId + +`func (o *AccessRequestDynamicApprover) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *AccessRequestDynamicApprover) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *AccessRequestDynamicApprover) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + + +### GetRequestedFor + +`func (o *AccessRequestDynamicApprover) GetRequestedFor() []AccessItemRequestedForDto` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequestDynamicApprover) GetRequestedForOk() (*[]AccessItemRequestedForDto, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequestDynamicApprover) SetRequestedFor(v []AccessItemRequestedForDto)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestedItems + +`func (o *AccessRequestDynamicApprover) GetRequestedItems() []AccessRequestDynamicApproverRequestedItemsInner` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *AccessRequestDynamicApprover) GetRequestedItemsOk() (*[]AccessRequestDynamicApproverRequestedItemsInner, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *AccessRequestDynamicApprover) SetRequestedItems(v []AccessRequestDynamicApproverRequestedItemsInner)` + +SetRequestedItems sets RequestedItems field to given value. + + +### GetRequestedBy + +`func (o *AccessRequestDynamicApprover) GetRequestedBy() AccessItemRequesterDto` + +GetRequestedBy returns the RequestedBy field if non-nil, zero value otherwise. + +### GetRequestedByOk + +`func (o *AccessRequestDynamicApprover) GetRequestedByOk() (*AccessItemRequesterDto, bool)` + +GetRequestedByOk returns a tuple with the RequestedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedBy + +`func (o *AccessRequestDynamicApprover) SetRequestedBy(v AccessItemRequesterDto)` + +SetRequestedBy sets RequestedBy field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestDynamicApprover1.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestDynamicApprover1.md new file mode 100644 index 000000000..4c656dc00 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestDynamicApprover1.md @@ -0,0 +1,101 @@ +--- +id: v2024-access-request-dynamic-approver1 +title: AccessRequestDynamicApprover1 +pagination_label: AccessRequestDynamicApprover1 +sidebar_label: AccessRequestDynamicApprover1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestDynamicApprover1', 'V2024AccessRequestDynamicApprover1'] +slug: /tools/sdk/go/v2024/models/access-request-dynamic-approver1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover1', 'V2024AccessRequestDynamicApprover1'] +--- + +# AccessRequestDynamicApprover1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the identity to add to the approver list for the access request. | +**Name** | **string** | The name of the identity to add to the approver list for the access request. | +**Type** | **map[string]interface{}** | The type of object being referenced. | + +## Methods + +### NewAccessRequestDynamicApprover1 + +`func NewAccessRequestDynamicApprover1(id string, name string, type_ map[string]interface{}, ) *AccessRequestDynamicApprover1` + +NewAccessRequestDynamicApprover1 instantiates a new AccessRequestDynamicApprover1 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 + +### NewAccessRequestDynamicApprover1WithDefaults + +`func NewAccessRequestDynamicApprover1WithDefaults() *AccessRequestDynamicApprover1` + +NewAccessRequestDynamicApprover1WithDefaults instantiates a new AccessRequestDynamicApprover1 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 + +### GetId + +`func (o *AccessRequestDynamicApprover1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestDynamicApprover1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestDynamicApprover1) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessRequestDynamicApprover1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestDynamicApprover1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestDynamicApprover1) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *AccessRequestDynamicApprover1) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestDynamicApprover1) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestDynamicApprover1) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestDynamicApproverRequestedItemsInner.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestDynamicApproverRequestedItemsInner.md new file mode 100644 index 000000000..a7b7df60e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestDynamicApproverRequestedItemsInner.md @@ -0,0 +1,194 @@ +--- +id: v2024-access-request-dynamic-approver-requested-items-inner +title: AccessRequestDynamicApproverRequestedItemsInner +pagination_label: AccessRequestDynamicApproverRequestedItemsInner +sidebar_label: AccessRequestDynamicApproverRequestedItemsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestDynamicApproverRequestedItemsInner', 'V2024AccessRequestDynamicApproverRequestedItemsInner'] +slug: /tools/sdk/go/v2024/models/access-request-dynamic-approver-requested-items-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApproverRequestedItemsInner', 'V2024AccessRequestDynamicApproverRequestedItemsInner'] +--- + +# AccessRequestDynamicApproverRequestedItemsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the access item. | +**Name** | **string** | Human friendly name of the access item. | +**Description** | Pointer to **NullableString** | Extended description of the access item. | [optional] +**Type** | **map[string]interface{}** | The type of access item being requested. | +**Operation** | **map[string]interface{}** | Grant or revoke the access item | +**Comment** | Pointer to **NullableString** | A comment from the requestor on why the access is needed. | [optional] + +## Methods + +### NewAccessRequestDynamicApproverRequestedItemsInner + +`func NewAccessRequestDynamicApproverRequestedItemsInner(id string, name string, type_ map[string]interface{}, operation map[string]interface{}, ) *AccessRequestDynamicApproverRequestedItemsInner` + +NewAccessRequestDynamicApproverRequestedItemsInner instantiates a new AccessRequestDynamicApproverRequestedItemsInner 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 + +### NewAccessRequestDynamicApproverRequestedItemsInnerWithDefaults + +`func NewAccessRequestDynamicApproverRequestedItemsInnerWithDefaults() *AccessRequestDynamicApproverRequestedItemsInner` + +NewAccessRequestDynamicApproverRequestedItemsInnerWithDefaults instantiates a new AccessRequestDynamicApproverRequestedItemsInner 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 + +### GetId + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessRequestDynamicApproverRequestedItemsInner) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetOperation + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetOperation() map[string]interface{}` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetOperationOk() (*map[string]interface{}, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetOperation(v map[string]interface{})` + +SetOperation sets Operation field to given value. + + +### GetComment + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *AccessRequestDynamicApproverRequestedItemsInner) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestItem.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestItem.md new file mode 100644 index 000000000..72a01e5ac --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestItem.md @@ -0,0 +1,230 @@ +--- +id: v2024-access-request-item +title: AccessRequestItem +pagination_label: AccessRequestItem +sidebar_label: AccessRequestItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestItem', 'V2024AccessRequestItem'] +slug: /tools/sdk/go/v2024/models/access-request-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'V2024AccessRequestItem'] +--- + +# AccessRequestItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of the item being requested. | +**Id** | **string** | ID of Role, Access Profile or Entitlement being requested. | +**Comment** | Pointer to **string** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | Pointer to **SailPointTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | Pointer to **NullableString** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | Pointer to **NullableString** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] + +## Methods + +### NewAccessRequestItem + +`func NewAccessRequestItem(type_ string, id string, ) *AccessRequestItem` + +NewAccessRequestItem instantiates a new AccessRequestItem 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 + +### NewAccessRequestItemWithDefaults + +`func NewAccessRequestItemWithDefaults() *AccessRequestItem` + +NewAccessRequestItemWithDefaults instantiates a new AccessRequestItem 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 + +### GetType + +`func (o *AccessRequestItem) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestItem) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestItem) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccessRequestItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetComment + +`func (o *AccessRequestItem) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestItem) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestItem) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *AccessRequestItem) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *AccessRequestItem) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccessRequestItem) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccessRequestItem) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccessRequestItem) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *AccessRequestItem) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccessRequestItem) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccessRequestItem) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccessRequestItem) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetAssignmentId + +`func (o *AccessRequestItem) GetAssignmentId() string` + +GetAssignmentId returns the AssignmentId field if non-nil, zero value otherwise. + +### GetAssignmentIdOk + +`func (o *AccessRequestItem) GetAssignmentIdOk() (*string, bool)` + +GetAssignmentIdOk returns a tuple with the AssignmentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentId + +`func (o *AccessRequestItem) SetAssignmentId(v string)` + +SetAssignmentId sets AssignmentId field to given value. + +### HasAssignmentId + +`func (o *AccessRequestItem) HasAssignmentId() bool` + +HasAssignmentId returns a boolean if a field has been set. + +### SetAssignmentIdNil + +`func (o *AccessRequestItem) SetAssignmentIdNil(b bool)` + + SetAssignmentIdNil sets the value for AssignmentId to be an explicit nil + +### UnsetAssignmentId +`func (o *AccessRequestItem) UnsetAssignmentId()` + +UnsetAssignmentId ensures that no value is present for AssignmentId, not even an explicit nil +### GetNativeIdentity + +`func (o *AccessRequestItem) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccessRequestItem) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccessRequestItem) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccessRequestItem) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### SetNativeIdentityNil + +`func (o *AccessRequestItem) SetNativeIdentityNil(b bool)` + + SetNativeIdentityNil sets the value for NativeIdentity to be an explicit nil + +### UnsetNativeIdentity +`func (o *AccessRequestItem) UnsetNativeIdentity()` + +UnsetNativeIdentity ensures that no value is present for NativeIdentity, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestItemResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestItemResponse.md new file mode 100644 index 000000000..b7a5aa685 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestItemResponse.md @@ -0,0 +1,246 @@ +--- +id: v2024-access-request-item-response +title: AccessRequestItemResponse +pagination_label: AccessRequestItemResponse +sidebar_label: AccessRequestItemResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestItemResponse', 'V2024AccessRequestItemResponse'] +slug: /tools/sdk/go/v2024/models/access-request-item-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestItemResponse', 'V2024AccessRequestItemResponse'] +--- + +# AccessRequestItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to **string** | the access request item operation | [optional] +**AccessItemType** | Pointer to **string** | the access item type | [optional] +**Name** | Pointer to **string** | the name of access request item | [optional] +**Decision** | Pointer to **string** | the final decision for the access request | [optional] +**Description** | Pointer to **string** | the description of access request item | [optional] +**SourceId** | Pointer to **string** | the source id | [optional] +**SourceName** | Pointer to **string** | the source Name | [optional] +**ApprovalInfos** | Pointer to [**[]ApprovalInfoResponse**](approval-info-response) | | [optional] + +## Methods + +### NewAccessRequestItemResponse + +`func NewAccessRequestItemResponse() *AccessRequestItemResponse` + +NewAccessRequestItemResponse instantiates a new AccessRequestItemResponse 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 + +### NewAccessRequestItemResponseWithDefaults + +`func NewAccessRequestItemResponseWithDefaults() *AccessRequestItemResponse` + +NewAccessRequestItemResponseWithDefaults instantiates a new AccessRequestItemResponse 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 + +### GetOperation + +`func (o *AccessRequestItemResponse) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *AccessRequestItemResponse) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *AccessRequestItemResponse) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *AccessRequestItemResponse) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetAccessItemType + +`func (o *AccessRequestItemResponse) GetAccessItemType() string` + +GetAccessItemType returns the AccessItemType field if non-nil, zero value otherwise. + +### GetAccessItemTypeOk + +`func (o *AccessRequestItemResponse) GetAccessItemTypeOk() (*string, bool)` + +GetAccessItemTypeOk returns a tuple with the AccessItemType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItemType + +`func (o *AccessRequestItemResponse) SetAccessItemType(v string)` + +SetAccessItemType sets AccessItemType field to given value. + +### HasAccessItemType + +`func (o *AccessRequestItemResponse) HasAccessItemType() bool` + +HasAccessItemType returns a boolean if a field has been set. + +### GetName + +`func (o *AccessRequestItemResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestItemResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestItemResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessRequestItemResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDecision + +`func (o *AccessRequestItemResponse) GetDecision() string` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *AccessRequestItemResponse) GetDecisionOk() (*string, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *AccessRequestItemResponse) SetDecision(v string)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *AccessRequestItemResponse) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessRequestItemResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestItemResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestItemResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestItemResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessRequestItemResponse) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessRequestItemResponse) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessRequestItemResponse) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessRequestItemResponse) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessRequestItemResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessRequestItemResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessRequestItemResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessRequestItemResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetApprovalInfos + +`func (o *AccessRequestItemResponse) GetApprovalInfos() []ApprovalInfoResponse` + +GetApprovalInfos returns the ApprovalInfos field if non-nil, zero value otherwise. + +### GetApprovalInfosOk + +`func (o *AccessRequestItemResponse) GetApprovalInfosOk() (*[]ApprovalInfoResponse, bool)` + +GetApprovalInfosOk returns a tuple with the ApprovalInfos field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalInfos + +`func (o *AccessRequestItemResponse) SetApprovalInfos(v []ApprovalInfoResponse)` + +SetApprovalInfos sets ApprovalInfos field to given value. + +### HasApprovalInfos + +`func (o *AccessRequestItemResponse) HasApprovalInfos() bool` + +HasApprovalInfos returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPhases.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPhases.md new file mode 100644 index 000000000..b9be0a981 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPhases.md @@ -0,0 +1,224 @@ +--- +id: v2024-access-request-phases +title: AccessRequestPhases +pagination_label: AccessRequestPhases +sidebar_label: AccessRequestPhases +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPhases', 'V2024AccessRequestPhases'] +slug: /tools/sdk/go/v2024/models/access-request-phases +tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'V2024AccessRequestPhases'] +--- + +# AccessRequestPhases + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Started** | Pointer to **SailPointTime** | The time that this phase started. | [optional] +**Finished** | Pointer to **NullableTime** | The time that this phase finished. | [optional] +**Name** | Pointer to **string** | The name of this phase. | [optional] +**State** | Pointer to **string** | The state of this phase. | [optional] +**Result** | Pointer to **NullableString** | The state of this phase. | [optional] +**PhaseReference** | Pointer to **NullableString** | A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. | [optional] + +## Methods + +### NewAccessRequestPhases + +`func NewAccessRequestPhases() *AccessRequestPhases` + +NewAccessRequestPhases instantiates a new AccessRequestPhases 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 + +### NewAccessRequestPhasesWithDefaults + +`func NewAccessRequestPhasesWithDefaults() *AccessRequestPhases` + +NewAccessRequestPhasesWithDefaults instantiates a new AccessRequestPhases 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 + +### GetStarted + +`func (o *AccessRequestPhases) GetStarted() SailPointTime` + +GetStarted returns the Started field if non-nil, zero value otherwise. + +### GetStartedOk + +`func (o *AccessRequestPhases) GetStartedOk() (*SailPointTime, bool)` + +GetStartedOk returns a tuple with the Started field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStarted + +`func (o *AccessRequestPhases) SetStarted(v SailPointTime)` + +SetStarted sets Started field to given value. + +### HasStarted + +`func (o *AccessRequestPhases) HasStarted() bool` + +HasStarted returns a boolean if a field has been set. + +### GetFinished + +`func (o *AccessRequestPhases) GetFinished() SailPointTime` + +GetFinished returns the Finished field if non-nil, zero value otherwise. + +### GetFinishedOk + +`func (o *AccessRequestPhases) GetFinishedOk() (*SailPointTime, bool)` + +GetFinishedOk returns a tuple with the Finished field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFinished + +`func (o *AccessRequestPhases) SetFinished(v SailPointTime)` + +SetFinished sets Finished field to given value. + +### HasFinished + +`func (o *AccessRequestPhases) HasFinished() bool` + +HasFinished returns a boolean if a field has been set. + +### SetFinishedNil + +`func (o *AccessRequestPhases) SetFinishedNil(b bool)` + + SetFinishedNil sets the value for Finished to be an explicit nil + +### UnsetFinished +`func (o *AccessRequestPhases) UnsetFinished()` + +UnsetFinished ensures that no value is present for Finished, not even an explicit nil +### GetName + +`func (o *AccessRequestPhases) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestPhases) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestPhases) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessRequestPhases) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetState + +`func (o *AccessRequestPhases) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *AccessRequestPhases) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *AccessRequestPhases) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *AccessRequestPhases) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetResult + +`func (o *AccessRequestPhases) GetResult() string` + +GetResult returns the Result field if non-nil, zero value otherwise. + +### GetResultOk + +`func (o *AccessRequestPhases) GetResultOk() (*string, bool)` + +GetResultOk returns a tuple with the Result field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResult + +`func (o *AccessRequestPhases) SetResult(v string)` + +SetResult sets Result field to given value. + +### HasResult + +`func (o *AccessRequestPhases) HasResult() bool` + +HasResult returns a boolean if a field has been set. + +### SetResultNil + +`func (o *AccessRequestPhases) SetResultNil(b bool)` + + SetResultNil sets the value for Result to be an explicit nil + +### UnsetResult +`func (o *AccessRequestPhases) UnsetResult()` + +UnsetResult ensures that no value is present for Result, not even an explicit nil +### GetPhaseReference + +`func (o *AccessRequestPhases) GetPhaseReference() string` + +GetPhaseReference returns the PhaseReference field if non-nil, zero value otherwise. + +### GetPhaseReferenceOk + +`func (o *AccessRequestPhases) GetPhaseReferenceOk() (*string, bool)` + +GetPhaseReferenceOk returns a tuple with the PhaseReference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhaseReference + +`func (o *AccessRequestPhases) SetPhaseReference(v string)` + +SetPhaseReference sets PhaseReference field to given value. + +### HasPhaseReference + +`func (o *AccessRequestPhases) HasPhaseReference() bool` + +HasPhaseReference returns a boolean if a field has been set. + +### SetPhaseReferenceNil + +`func (o *AccessRequestPhases) SetPhaseReferenceNil(b bool)` + + SetPhaseReferenceNil sets the value for PhaseReference to be an explicit nil + +### UnsetPhaseReference +`func (o *AccessRequestPhases) UnsetPhaseReference()` + +UnsetPhaseReference ensures that no value is present for PhaseReference, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPostApproval.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPostApproval.md new file mode 100644 index 000000000..ac3e1a656 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPostApproval.md @@ -0,0 +1,122 @@ +--- +id: v2024-access-request-post-approval +title: AccessRequestPostApproval +pagination_label: AccessRequestPostApproval +sidebar_label: AccessRequestPostApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPostApproval', 'V2024AccessRequestPostApproval'] +slug: /tools/sdk/go/v2024/models/access-request-post-approval +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApproval', 'V2024AccessRequestPostApproval'] +--- + +# AccessRequestPostApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **string** | The unique ID of the access request. | +**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | +**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | +**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | + +## Methods + +### NewAccessRequestPostApproval + +`func NewAccessRequestPostApproval(accessRequestId string, requestedFor []AccessItemRequestedForDto, requestedItemsStatus []AccessRequestPostApprovalRequestedItemsStatusInner, requestedBy AccessItemRequesterDto, ) *AccessRequestPostApproval` + +NewAccessRequestPostApproval instantiates a new AccessRequestPostApproval 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 + +### NewAccessRequestPostApprovalWithDefaults + +`func NewAccessRequestPostApprovalWithDefaults() *AccessRequestPostApproval` + +NewAccessRequestPostApprovalWithDefaults instantiates a new AccessRequestPostApproval 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 + +### GetAccessRequestId + +`func (o *AccessRequestPostApproval) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *AccessRequestPostApproval) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *AccessRequestPostApproval) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + + +### GetRequestedFor + +`func (o *AccessRequestPostApproval) GetRequestedFor() []AccessItemRequestedForDto` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequestPostApproval) GetRequestedForOk() (*[]AccessItemRequestedForDto, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequestPostApproval) SetRequestedFor(v []AccessItemRequestedForDto)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestedItemsStatus + +`func (o *AccessRequestPostApproval) GetRequestedItemsStatus() []AccessRequestPostApprovalRequestedItemsStatusInner` + +GetRequestedItemsStatus returns the RequestedItemsStatus field if non-nil, zero value otherwise. + +### GetRequestedItemsStatusOk + +`func (o *AccessRequestPostApproval) GetRequestedItemsStatusOk() (*[]AccessRequestPostApprovalRequestedItemsStatusInner, bool)` + +GetRequestedItemsStatusOk returns a tuple with the RequestedItemsStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItemsStatus + +`func (o *AccessRequestPostApproval) SetRequestedItemsStatus(v []AccessRequestPostApprovalRequestedItemsStatusInner)` + +SetRequestedItemsStatus sets RequestedItemsStatus field to given value. + + +### GetRequestedBy + +`func (o *AccessRequestPostApproval) GetRequestedBy() AccessItemRequesterDto` + +GetRequestedBy returns the RequestedBy field if non-nil, zero value otherwise. + +### GetRequestedByOk + +`func (o *AccessRequestPostApproval) GetRequestedByOk() (*AccessItemRequesterDto, bool)` + +GetRequestedByOk returns a tuple with the RequestedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedBy + +`func (o *AccessRequestPostApproval) SetRequestedBy(v AccessItemRequesterDto)` + +SetRequestedBy sets RequestedBy field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md new file mode 100644 index 000000000..3e6a39b36 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md @@ -0,0 +1,251 @@ +--- +id: v2024-access-request-post-approval-requested-items-status-inner +title: AccessRequestPostApprovalRequestedItemsStatusInner +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInner +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'V2024AccessRequestPostApprovalRequestedItemsStatusInner'] +slug: /tools/sdk/go/v2024/models/access-request-post-approval-requested-items-status-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'V2024AccessRequestPostApprovalRequestedItemsStatusInner'] +--- + +# AccessRequestPostApprovalRequestedItemsStatusInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the access item being requested. | +**Name** | **string** | The human friendly name of the access item. | +**Description** | Pointer to **NullableString** | Detailed description of the access item. | [optional] +**Type** | **map[string]interface{}** | The type of access item. | +**Operation** | **map[string]interface{}** | The action to perform on the access item. | +**Comment** | Pointer to **NullableString** | A comment from the identity requesting the access. | [optional] +**ClientMetadata** | Pointer to **map[string]interface{}** | Additional customer defined metadata about the access item. | [optional] +**ApprovalInfo** | [**[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner**](access-request-post-approval-requested-items-status-inner-approval-info-inner) | A list of one or more approvers for the access request. | + +## Methods + +### NewAccessRequestPostApprovalRequestedItemsStatusInner + +`func NewAccessRequestPostApprovalRequestedItemsStatusInner(id string, name string, type_ map[string]interface{}, operation map[string]interface{}, approvalInfo []AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner, ) *AccessRequestPostApprovalRequestedItemsStatusInner` + +NewAccessRequestPostApprovalRequestedItemsStatusInner instantiates a new AccessRequestPostApprovalRequestedItemsStatusInner 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 + +### NewAccessRequestPostApprovalRequestedItemsStatusInnerWithDefaults + +`func NewAccessRequestPostApprovalRequestedItemsStatusInnerWithDefaults() *AccessRequestPostApprovalRequestedItemsStatusInner` + +NewAccessRequestPostApprovalRequestedItemsStatusInnerWithDefaults instantiates a new AccessRequestPostApprovalRequestedItemsStatusInner 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 + +### GetId + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetOperation + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetOperation() map[string]interface{}` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetOperationOk() (*map[string]interface{}, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetOperation(v map[string]interface{})` + +SetOperation sets Operation field to given value. + + +### GetComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetClientMetadata + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetClientMetadata() map[string]interface{}` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetClientMetadataOk() (*map[string]interface{}, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetClientMetadata(v map[string]interface{})` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetApprovalInfo + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetApprovalInfo() []AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner` + +GetApprovalInfo returns the ApprovalInfo field if non-nil, zero value otherwise. + +### GetApprovalInfoOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetApprovalInfoOk() (*[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner, bool)` + +GetApprovalInfoOk returns a tuple with the ApprovalInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalInfo + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetApprovalInfo(v []AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner)` + +SetApprovalInfo sets ApprovalInfo field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md new file mode 100644 index 000000000..4f7637707 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md @@ -0,0 +1,137 @@ +--- +id: v2024-access-request-post-approval-requested-items-status-inner-approval-info-inner +title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'V2024AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner'] +slug: /tools/sdk/go/v2024/models/access-request-post-approval-requested-items-status-inner-approval-info-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'V2024AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner'] +--- + +# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalComment** | Pointer to **NullableString** | A comment left by the approver. | [optional] +**ApprovalDecision** | **map[string]interface{}** | The final decision of the approver. | +**ApproverName** | **string** | The name of the approver | +**Approver** | [**AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover**](access-request-post-approval-requested-items-status-inner-approval-info-inner-approver) | | + +## Methods + +### NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner + +`func NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner(approvalDecision map[string]interface{}, approverName string, approver AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover, ) *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner` + +NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner instantiates a new AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner 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 + +### NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerWithDefaults + +`func NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerWithDefaults() *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner` + +NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerWithDefaults instantiates a new AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner 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 + +### GetApprovalComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApprovalComment() string` + +GetApprovalComment returns the ApprovalComment field if non-nil, zero value otherwise. + +### GetApprovalCommentOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApprovalCommentOk() (*string, bool)` + +GetApprovalCommentOk returns a tuple with the ApprovalComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) SetApprovalComment(v string)` + +SetApprovalComment sets ApprovalComment field to given value. + +### HasApprovalComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) HasApprovalComment() bool` + +HasApprovalComment returns a boolean if a field has been set. + +### SetApprovalCommentNil + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) SetApprovalCommentNil(b bool)` + + SetApprovalCommentNil sets the value for ApprovalComment to be an explicit nil + +### UnsetApprovalComment +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) UnsetApprovalComment()` + +UnsetApprovalComment ensures that no value is present for ApprovalComment, not even an explicit nil +### GetApprovalDecision + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApprovalDecision() map[string]interface{}` + +GetApprovalDecision returns the ApprovalDecision field if non-nil, zero value otherwise. + +### GetApprovalDecisionOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApprovalDecisionOk() (*map[string]interface{}, bool)` + +GetApprovalDecisionOk returns a tuple with the ApprovalDecision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalDecision + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) SetApprovalDecision(v map[string]interface{})` + +SetApprovalDecision sets ApprovalDecision field to given value. + + +### GetApproverName + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApproverName() string` + +GetApproverName returns the ApproverName field if non-nil, zero value otherwise. + +### GetApproverNameOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApproverNameOk() (*string, bool)` + +GetApproverNameOk returns a tuple with the ApproverName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverName + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) SetApproverName(v string)` + +SetApproverName sets ApproverName field to given value. + + +### GetApprover + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApprover() AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApproverOk() (*AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) SetApprover(v AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover)` + +SetApprover sets Approver field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md new file mode 100644 index 000000000..65287b02b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md @@ -0,0 +1,101 @@ +--- +id: v2024-access-request-post-approval-requested-items-status-inner-approval-info-inner-approver +title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'V2024AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover'] +slug: /tools/sdk/go/v2024/models/access-request-post-approval-requested-items-status-inner-approval-info-inner-approver +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'V2024AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover'] +--- + +# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **map[string]interface{}** | The type of object that is referenced | +**Id** | **string** | ID of identity who approved the access item request. | +**Name** | **string** | Human-readable display name of identity who approved the access item request. | + +## Methods + +### NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover + +`func NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover(type_ map[string]interface{}, id string, name string, ) *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover` + +NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover instantiates a new AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover 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 + +### NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverWithDefaults + +`func NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverWithDefaults() *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover` + +NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverWithDefaults instantiates a new AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover 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 + +### GetType + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPreApproval.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPreApproval.md new file mode 100644 index 000000000..4130d292f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPreApproval.md @@ -0,0 +1,122 @@ +--- +id: v2024-access-request-pre-approval +title: AccessRequestPreApproval +pagination_label: AccessRequestPreApproval +sidebar_label: AccessRequestPreApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPreApproval', 'V2024AccessRequestPreApproval'] +slug: /tools/sdk/go/v2024/models/access-request-pre-approval +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval', 'V2024AccessRequestPreApproval'] +--- + +# AccessRequestPreApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **string** | The unique ID of the access request. | +**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | +**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | +**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | + +## Methods + +### NewAccessRequestPreApproval + +`func NewAccessRequestPreApproval(accessRequestId string, requestedFor []AccessItemRequestedForDto, requestedItems []AccessRequestPreApprovalRequestedItemsInner, requestedBy AccessItemRequesterDto, ) *AccessRequestPreApproval` + +NewAccessRequestPreApproval instantiates a new AccessRequestPreApproval 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 + +### NewAccessRequestPreApprovalWithDefaults + +`func NewAccessRequestPreApprovalWithDefaults() *AccessRequestPreApproval` + +NewAccessRequestPreApprovalWithDefaults instantiates a new AccessRequestPreApproval 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 + +### GetAccessRequestId + +`func (o *AccessRequestPreApproval) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *AccessRequestPreApproval) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *AccessRequestPreApproval) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + + +### GetRequestedFor + +`func (o *AccessRequestPreApproval) GetRequestedFor() []AccessItemRequestedForDto` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequestPreApproval) GetRequestedForOk() (*[]AccessItemRequestedForDto, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequestPreApproval) SetRequestedFor(v []AccessItemRequestedForDto)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestedItems + +`func (o *AccessRequestPreApproval) GetRequestedItems() []AccessRequestPreApprovalRequestedItemsInner` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *AccessRequestPreApproval) GetRequestedItemsOk() (*[]AccessRequestPreApprovalRequestedItemsInner, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *AccessRequestPreApproval) SetRequestedItems(v []AccessRequestPreApprovalRequestedItemsInner)` + +SetRequestedItems sets RequestedItems field to given value. + + +### GetRequestedBy + +`func (o *AccessRequestPreApproval) GetRequestedBy() AccessItemRequesterDto` + +GetRequestedBy returns the RequestedBy field if non-nil, zero value otherwise. + +### GetRequestedByOk + +`func (o *AccessRequestPreApproval) GetRequestedByOk() (*AccessItemRequesterDto, bool)` + +GetRequestedByOk returns a tuple with the RequestedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedBy + +`func (o *AccessRequestPreApproval) SetRequestedBy(v AccessItemRequesterDto)` + +SetRequestedBy sets RequestedBy field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPreApproval1.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPreApproval1.md new file mode 100644 index 000000000..47a54c544 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPreApproval1.md @@ -0,0 +1,101 @@ +--- +id: v2024-access-request-pre-approval1 +title: AccessRequestPreApproval1 +pagination_label: AccessRequestPreApproval1 +sidebar_label: AccessRequestPreApproval1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPreApproval1', 'V2024AccessRequestPreApproval1'] +slug: /tools/sdk/go/v2024/models/access-request-pre-approval1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval1', 'V2024AccessRequestPreApproval1'] +--- + +# AccessRequestPreApproval1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | **bool** | Whether or not to approve the access request. | +**Comment** | **string** | A comment about the decision to approve or deny the request. | +**Approver** | **string** | The name of the entity that approved or denied the request. | + +## Methods + +### NewAccessRequestPreApproval1 + +`func NewAccessRequestPreApproval1(approved bool, comment string, approver string, ) *AccessRequestPreApproval1` + +NewAccessRequestPreApproval1 instantiates a new AccessRequestPreApproval1 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 + +### NewAccessRequestPreApproval1WithDefaults + +`func NewAccessRequestPreApproval1WithDefaults() *AccessRequestPreApproval1` + +NewAccessRequestPreApproval1WithDefaults instantiates a new AccessRequestPreApproval1 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 + +### GetApproved + +`func (o *AccessRequestPreApproval1) GetApproved() bool` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *AccessRequestPreApproval1) GetApprovedOk() (*bool, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *AccessRequestPreApproval1) SetApproved(v bool)` + +SetApproved sets Approved field to given value. + + +### GetComment + +`func (o *AccessRequestPreApproval1) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestPreApproval1) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestPreApproval1) SetComment(v string)` + +SetComment sets Comment field to given value. + + +### GetApprover + +`func (o *AccessRequestPreApproval1) GetApprover() string` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *AccessRequestPreApproval1) GetApproverOk() (*string, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *AccessRequestPreApproval1) SetApprover(v string)` + +SetApprover sets Approver field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPreApprovalRequestedItemsInner.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPreApprovalRequestedItemsInner.md new file mode 100644 index 000000000..70389792c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestPreApprovalRequestedItemsInner.md @@ -0,0 +1,194 @@ +--- +id: v2024-access-request-pre-approval-requested-items-inner +title: AccessRequestPreApprovalRequestedItemsInner +pagination_label: AccessRequestPreApprovalRequestedItemsInner +sidebar_label: AccessRequestPreApprovalRequestedItemsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPreApprovalRequestedItemsInner', 'V2024AccessRequestPreApprovalRequestedItemsInner'] +slug: /tools/sdk/go/v2024/models/access-request-pre-approval-requested-items-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApprovalRequestedItemsInner', 'V2024AccessRequestPreApprovalRequestedItemsInner'] +--- + +# AccessRequestPreApprovalRequestedItemsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the access item being requested. | +**Name** | **string** | The human friendly name of the access item. | +**Description** | Pointer to **NullableString** | Detailed description of the access item. | [optional] +**Type** | **map[string]interface{}** | The type of access item. | +**Operation** | **map[string]interface{}** | The action to perform on the access item. | +**Comment** | Pointer to **NullableString** | A comment from the identity requesting the access. | [optional] + +## Methods + +### NewAccessRequestPreApprovalRequestedItemsInner + +`func NewAccessRequestPreApprovalRequestedItemsInner(id string, name string, type_ map[string]interface{}, operation map[string]interface{}, ) *AccessRequestPreApprovalRequestedItemsInner` + +NewAccessRequestPreApprovalRequestedItemsInner instantiates a new AccessRequestPreApprovalRequestedItemsInner 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 + +### NewAccessRequestPreApprovalRequestedItemsInnerWithDefaults + +`func NewAccessRequestPreApprovalRequestedItemsInnerWithDefaults() *AccessRequestPreApprovalRequestedItemsInner` + +NewAccessRequestPreApprovalRequestedItemsInnerWithDefaults instantiates a new AccessRequestPreApprovalRequestedItemsInner 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 + +### GetId + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestPreApprovalRequestedItemsInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessRequestPreApprovalRequestedItemsInner) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetOperation + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetOperation() map[string]interface{}` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetOperationOk() (*map[string]interface{}, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetOperation(v map[string]interface{})` + +SetOperation sets Operation field to given value. + + +### GetComment + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *AccessRequestPreApprovalRequestedItemsInner) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *AccessRequestPreApprovalRequestedItemsInner) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationActionItemDto.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationActionItemDto.md new file mode 100644 index 000000000..f3bfddbd4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationActionItemDto.md @@ -0,0 +1,80 @@ +--- +id: v2024-access-request-recommendation-action-item-dto +title: AccessRequestRecommendationActionItemDto +pagination_label: AccessRequestRecommendationActionItemDto +sidebar_label: AccessRequestRecommendationActionItemDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationActionItemDto', 'V2024AccessRequestRecommendationActionItemDto'] +slug: /tools/sdk/go/v2024/models/access-request-recommendation-action-item-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemDto', 'V2024AccessRequestRecommendationActionItemDto'] +--- + +# AccessRequestRecommendationActionItemDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **string** | The identity ID taking the action. | +**Access** | [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | + +## Methods + +### NewAccessRequestRecommendationActionItemDto + +`func NewAccessRequestRecommendationActionItemDto(identityId string, access AccessRequestRecommendationItem, ) *AccessRequestRecommendationActionItemDto` + +NewAccessRequestRecommendationActionItemDto instantiates a new AccessRequestRecommendationActionItemDto 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 + +### NewAccessRequestRecommendationActionItemDtoWithDefaults + +`func NewAccessRequestRecommendationActionItemDtoWithDefaults() *AccessRequestRecommendationActionItemDto` + +NewAccessRequestRecommendationActionItemDtoWithDefaults instantiates a new AccessRequestRecommendationActionItemDto 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 + +### GetIdentityId + +`func (o *AccessRequestRecommendationActionItemDto) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessRequestRecommendationActionItemDto) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessRequestRecommendationActionItemDto) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetAccess + +`func (o *AccessRequestRecommendationActionItemDto) GetAccess() AccessRequestRecommendationItem` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *AccessRequestRecommendationActionItemDto) GetAccessOk() (*AccessRequestRecommendationItem, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *AccessRequestRecommendationActionItemDto) SetAccess(v AccessRequestRecommendationItem)` + +SetAccess sets Access field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationActionItemResponseDto.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationActionItemResponseDto.md new file mode 100644 index 000000000..df0325cfc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationActionItemResponseDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-access-request-recommendation-action-item-response-dto +title: AccessRequestRecommendationActionItemResponseDto +pagination_label: AccessRequestRecommendationActionItemResponseDto +sidebar_label: AccessRequestRecommendationActionItemResponseDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationActionItemResponseDto', 'V2024AccessRequestRecommendationActionItemResponseDto'] +slug: /tools/sdk/go/v2024/models/access-request-recommendation-action-item-response-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemResponseDto', 'V2024AccessRequestRecommendationActionItemResponseDto'] +--- + +# AccessRequestRecommendationActionItemResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | The identity ID taking the action. | [optional] +**Access** | Pointer to [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [optional] +**Timestamp** | Pointer to **SailPointTime** | | [optional] + +## Methods + +### NewAccessRequestRecommendationActionItemResponseDto + +`func NewAccessRequestRecommendationActionItemResponseDto() *AccessRequestRecommendationActionItemResponseDto` + +NewAccessRequestRecommendationActionItemResponseDto instantiates a new AccessRequestRecommendationActionItemResponseDto 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 + +### NewAccessRequestRecommendationActionItemResponseDtoWithDefaults + +`func NewAccessRequestRecommendationActionItemResponseDtoWithDefaults() *AccessRequestRecommendationActionItemResponseDto` + +NewAccessRequestRecommendationActionItemResponseDtoWithDefaults instantiates a new AccessRequestRecommendationActionItemResponseDto 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 + +### GetIdentityId + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessRequestRecommendationActionItemResponseDto) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccessRequestRecommendationActionItemResponseDto) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetAccess + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetAccess() AccessRequestRecommendationItem` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetAccessOk() (*AccessRequestRecommendationItem, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *AccessRequestRecommendationActionItemResponseDto) SetAccess(v AccessRequestRecommendationItem)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *AccessRequestRecommendationActionItemResponseDto) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetTimestamp + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *AccessRequestRecommendationActionItemResponseDto) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *AccessRequestRecommendationActionItemResponseDto) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md new file mode 100644 index 000000000..9e13ec537 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md @@ -0,0 +1,189 @@ +--- +id: v2024-access-request-recommendation-config-dto +title: AccessRequestRecommendationConfigDto +pagination_label: AccessRequestRecommendationConfigDto +sidebar_label: AccessRequestRecommendationConfigDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto'] +slug: /tools/sdk/go/v2024/models/access-request-recommendation-config-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto'] +--- + +# AccessRequestRecommendationConfigDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ScoreThreshold** | **float32** | The value that internal calculations need to exceed for recommendations to be made. | +**StartDateAttribute** | Pointer to **string** | Use to map an attribute name for determining identities' start date. | [optional] +**RestrictionAttribute** | Pointer to **string** | Use to only give recommendations based on this attribute. | [optional] +**MoverAttribute** | Pointer to **string** | Use to map an attribute name for determining whether identities are movers. | [optional] +**JoinerAttribute** | Pointer to **string** | Use to map an attribute name for determining whether identities are joiners. | [optional] +**UseRestrictionAttribute** | Pointer to **bool** | Use only the attribute named in restrictionAttribute to make recommendations. | [optional] [default to false] + +## Methods + +### NewAccessRequestRecommendationConfigDto + +`func NewAccessRequestRecommendationConfigDto(scoreThreshold float32, ) *AccessRequestRecommendationConfigDto` + +NewAccessRequestRecommendationConfigDto instantiates a new AccessRequestRecommendationConfigDto 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 + +### NewAccessRequestRecommendationConfigDtoWithDefaults + +`func NewAccessRequestRecommendationConfigDtoWithDefaults() *AccessRequestRecommendationConfigDto` + +NewAccessRequestRecommendationConfigDtoWithDefaults instantiates a new AccessRequestRecommendationConfigDto 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 + +### GetScoreThreshold + +`func (o *AccessRequestRecommendationConfigDto) GetScoreThreshold() float32` + +GetScoreThreshold returns the ScoreThreshold field if non-nil, zero value otherwise. + +### GetScoreThresholdOk + +`func (o *AccessRequestRecommendationConfigDto) GetScoreThresholdOk() (*float32, bool)` + +GetScoreThresholdOk returns a tuple with the ScoreThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScoreThreshold + +`func (o *AccessRequestRecommendationConfigDto) SetScoreThreshold(v float32)` + +SetScoreThreshold sets ScoreThreshold field to given value. + + +### GetStartDateAttribute + +`func (o *AccessRequestRecommendationConfigDto) GetStartDateAttribute() string` + +GetStartDateAttribute returns the StartDateAttribute field if non-nil, zero value otherwise. + +### GetStartDateAttributeOk + +`func (o *AccessRequestRecommendationConfigDto) GetStartDateAttributeOk() (*string, bool)` + +GetStartDateAttributeOk returns a tuple with the StartDateAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDateAttribute + +`func (o *AccessRequestRecommendationConfigDto) SetStartDateAttribute(v string)` + +SetStartDateAttribute sets StartDateAttribute field to given value. + +### HasStartDateAttribute + +`func (o *AccessRequestRecommendationConfigDto) HasStartDateAttribute() bool` + +HasStartDateAttribute returns a boolean if a field has been set. + +### GetRestrictionAttribute + +`func (o *AccessRequestRecommendationConfigDto) GetRestrictionAttribute() string` + +GetRestrictionAttribute returns the RestrictionAttribute field if non-nil, zero value otherwise. + +### GetRestrictionAttributeOk + +`func (o *AccessRequestRecommendationConfigDto) GetRestrictionAttributeOk() (*string, bool)` + +GetRestrictionAttributeOk returns a tuple with the RestrictionAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestrictionAttribute + +`func (o *AccessRequestRecommendationConfigDto) SetRestrictionAttribute(v string)` + +SetRestrictionAttribute sets RestrictionAttribute field to given value. + +### HasRestrictionAttribute + +`func (o *AccessRequestRecommendationConfigDto) HasRestrictionAttribute() bool` + +HasRestrictionAttribute returns a boolean if a field has been set. + +### GetMoverAttribute + +`func (o *AccessRequestRecommendationConfigDto) GetMoverAttribute() string` + +GetMoverAttribute returns the MoverAttribute field if non-nil, zero value otherwise. + +### GetMoverAttributeOk + +`func (o *AccessRequestRecommendationConfigDto) GetMoverAttributeOk() (*string, bool)` + +GetMoverAttributeOk returns a tuple with the MoverAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMoverAttribute + +`func (o *AccessRequestRecommendationConfigDto) SetMoverAttribute(v string)` + +SetMoverAttribute sets MoverAttribute field to given value. + +### HasMoverAttribute + +`func (o *AccessRequestRecommendationConfigDto) HasMoverAttribute() bool` + +HasMoverAttribute returns a boolean if a field has been set. + +### GetJoinerAttribute + +`func (o *AccessRequestRecommendationConfigDto) GetJoinerAttribute() string` + +GetJoinerAttribute returns the JoinerAttribute field if non-nil, zero value otherwise. + +### GetJoinerAttributeOk + +`func (o *AccessRequestRecommendationConfigDto) GetJoinerAttributeOk() (*string, bool)` + +GetJoinerAttributeOk returns a tuple with the JoinerAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJoinerAttribute + +`func (o *AccessRequestRecommendationConfigDto) SetJoinerAttribute(v string)` + +SetJoinerAttribute sets JoinerAttribute field to given value. + +### HasJoinerAttribute + +`func (o *AccessRequestRecommendationConfigDto) HasJoinerAttribute() bool` + +HasJoinerAttribute returns a boolean if a field has been set. + +### GetUseRestrictionAttribute + +`func (o *AccessRequestRecommendationConfigDto) GetUseRestrictionAttribute() bool` + +GetUseRestrictionAttribute returns the UseRestrictionAttribute field if non-nil, zero value otherwise. + +### GetUseRestrictionAttributeOk + +`func (o *AccessRequestRecommendationConfigDto) GetUseRestrictionAttributeOk() (*bool, bool)` + +GetUseRestrictionAttributeOk returns a tuple with the UseRestrictionAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseRestrictionAttribute + +`func (o *AccessRequestRecommendationConfigDto) SetUseRestrictionAttribute(v bool)` + +SetUseRestrictionAttribute sets UseRestrictionAttribute field to given value. + +### HasUseRestrictionAttribute + +`func (o *AccessRequestRecommendationConfigDto) HasUseRestrictionAttribute() bool` + +HasUseRestrictionAttribute returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationItem.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationItem.md new file mode 100644 index 000000000..01b7d77c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationItem.md @@ -0,0 +1,90 @@ +--- +id: v2024-access-request-recommendation-item +title: AccessRequestRecommendationItem +pagination_label: AccessRequestRecommendationItem +sidebar_label: AccessRequestRecommendationItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationItem', 'V2024AccessRequestRecommendationItem'] +slug: /tools/sdk/go/v2024/models/access-request-recommendation-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItem', 'V2024AccessRequestRecommendationItem'] +--- + +# AccessRequestRecommendationItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of access item being recommended. | [optional] +**Type** | Pointer to [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional] + +## Methods + +### NewAccessRequestRecommendationItem + +`func NewAccessRequestRecommendationItem() *AccessRequestRecommendationItem` + +NewAccessRequestRecommendationItem instantiates a new AccessRequestRecommendationItem 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 + +### NewAccessRequestRecommendationItemWithDefaults + +`func NewAccessRequestRecommendationItemWithDefaults() *AccessRequestRecommendationItem` + +NewAccessRequestRecommendationItemWithDefaults instantiates a new AccessRequestRecommendationItem 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 + +### GetId + +`func (o *AccessRequestRecommendationItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestRecommendationItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestRecommendationItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessRequestRecommendationItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessRequestRecommendationItem) GetType() AccessRequestRecommendationItemType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestRecommendationItem) GetTypeOk() (*AccessRequestRecommendationItemType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestRecommendationItem) SetType(v AccessRequestRecommendationItemType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessRequestRecommendationItem) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationItemDetail.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationItemDetail.md new file mode 100644 index 000000000..6083b5de2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationItemDetail.md @@ -0,0 +1,220 @@ +--- +id: v2024-access-request-recommendation-item-detail +title: AccessRequestRecommendationItemDetail +pagination_label: AccessRequestRecommendationItemDetail +sidebar_label: AccessRequestRecommendationItemDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationItemDetail', 'V2024AccessRequestRecommendationItemDetail'] +slug: /tools/sdk/go/v2024/models/access-request-recommendation-item-detail +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetail', 'V2024AccessRequestRecommendationItemDetail'] +--- + +# AccessRequestRecommendationItemDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | Identity ID for the recommendation | [optional] +**Access** | Pointer to [**AccessRequestRecommendationItemDetailAccess**](access-request-recommendation-item-detail-access) | | [optional] +**Ignored** | Pointer to **bool** | Whether or not the identity has already chosen to ignore this recommendation. | [optional] +**Requested** | Pointer to **bool** | Whether or not the identity has already chosen to request this recommendation. | [optional] +**Viewed** | Pointer to **bool** | Whether or not the identity reportedly viewed this recommendation. | [optional] +**Messages** | Pointer to [**[]AccessRecommendationMessage**](access-recommendation-message) | | [optional] +**TranslationMessages** | Pointer to [**[]TranslationMessage**](translation-message) | The list of translation messages | [optional] + +## Methods + +### NewAccessRequestRecommendationItemDetail + +`func NewAccessRequestRecommendationItemDetail() *AccessRequestRecommendationItemDetail` + +NewAccessRequestRecommendationItemDetail instantiates a new AccessRequestRecommendationItemDetail 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 + +### NewAccessRequestRecommendationItemDetailWithDefaults + +`func NewAccessRequestRecommendationItemDetailWithDefaults() *AccessRequestRecommendationItemDetail` + +NewAccessRequestRecommendationItemDetailWithDefaults instantiates a new AccessRequestRecommendationItemDetail 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 + +### GetIdentityId + +`func (o *AccessRequestRecommendationItemDetail) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessRequestRecommendationItemDetail) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessRequestRecommendationItemDetail) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccessRequestRecommendationItemDetail) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetAccess + +`func (o *AccessRequestRecommendationItemDetail) GetAccess() AccessRequestRecommendationItemDetailAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *AccessRequestRecommendationItemDetail) GetAccessOk() (*AccessRequestRecommendationItemDetailAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *AccessRequestRecommendationItemDetail) SetAccess(v AccessRequestRecommendationItemDetailAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *AccessRequestRecommendationItemDetail) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetIgnored + +`func (o *AccessRequestRecommendationItemDetail) GetIgnored() bool` + +GetIgnored returns the Ignored field if non-nil, zero value otherwise. + +### GetIgnoredOk + +`func (o *AccessRequestRecommendationItemDetail) GetIgnoredOk() (*bool, bool)` + +GetIgnoredOk returns a tuple with the Ignored field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIgnored + +`func (o *AccessRequestRecommendationItemDetail) SetIgnored(v bool)` + +SetIgnored sets Ignored field to given value. + +### HasIgnored + +`func (o *AccessRequestRecommendationItemDetail) HasIgnored() bool` + +HasIgnored returns a boolean if a field has been set. + +### GetRequested + +`func (o *AccessRequestRecommendationItemDetail) GetRequested() bool` + +GetRequested returns the Requested field if non-nil, zero value otherwise. + +### GetRequestedOk + +`func (o *AccessRequestRecommendationItemDetail) GetRequestedOk() (*bool, bool)` + +GetRequestedOk returns a tuple with the Requested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequested + +`func (o *AccessRequestRecommendationItemDetail) SetRequested(v bool)` + +SetRequested sets Requested field to given value. + +### HasRequested + +`func (o *AccessRequestRecommendationItemDetail) HasRequested() bool` + +HasRequested returns a boolean if a field has been set. + +### GetViewed + +`func (o *AccessRequestRecommendationItemDetail) GetViewed() bool` + +GetViewed returns the Viewed field if non-nil, zero value otherwise. + +### GetViewedOk + +`func (o *AccessRequestRecommendationItemDetail) GetViewedOk() (*bool, bool)` + +GetViewedOk returns a tuple with the Viewed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViewed + +`func (o *AccessRequestRecommendationItemDetail) SetViewed(v bool)` + +SetViewed sets Viewed field to given value. + +### HasViewed + +`func (o *AccessRequestRecommendationItemDetail) HasViewed() bool` + +HasViewed returns a boolean if a field has been set. + +### GetMessages + +`func (o *AccessRequestRecommendationItemDetail) GetMessages() []AccessRecommendationMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *AccessRequestRecommendationItemDetail) GetMessagesOk() (*[]AccessRecommendationMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *AccessRequestRecommendationItemDetail) SetMessages(v []AccessRecommendationMessage)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *AccessRequestRecommendationItemDetail) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetTranslationMessages + +`func (o *AccessRequestRecommendationItemDetail) GetTranslationMessages() []TranslationMessage` + +GetTranslationMessages returns the TranslationMessages field if non-nil, zero value otherwise. + +### GetTranslationMessagesOk + +`func (o *AccessRequestRecommendationItemDetail) GetTranslationMessagesOk() (*[]TranslationMessage, bool)` + +GetTranslationMessagesOk returns a tuple with the TranslationMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslationMessages + +`func (o *AccessRequestRecommendationItemDetail) SetTranslationMessages(v []TranslationMessage)` + +SetTranslationMessages sets TranslationMessages field to given value. + +### HasTranslationMessages + +`func (o *AccessRequestRecommendationItemDetail) HasTranslationMessages() bool` + +HasTranslationMessages returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationItemDetailAccess.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationItemDetailAccess.md new file mode 100644 index 000000000..0db505d3c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationItemDetailAccess.md @@ -0,0 +1,142 @@ +--- +id: v2024-access-request-recommendation-item-detail-access +title: AccessRequestRecommendationItemDetailAccess +pagination_label: AccessRequestRecommendationItemDetailAccess +sidebar_label: AccessRequestRecommendationItemDetailAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationItemDetailAccess', 'V2024AccessRequestRecommendationItemDetailAccess'] +slug: /tools/sdk/go/v2024/models/access-request-recommendation-item-detail-access +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetailAccess', 'V2024AccessRequestRecommendationItemDetailAccess'] +--- + +# AccessRequestRecommendationItemDetailAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of access item being recommended. | [optional] +**Type** | Pointer to [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional] +**Name** | Pointer to **string** | Name of the access item | [optional] +**Description** | Pointer to **string** | Description of the access item | [optional] + +## Methods + +### NewAccessRequestRecommendationItemDetailAccess + +`func NewAccessRequestRecommendationItemDetailAccess() *AccessRequestRecommendationItemDetailAccess` + +NewAccessRequestRecommendationItemDetailAccess instantiates a new AccessRequestRecommendationItemDetailAccess 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 + +### NewAccessRequestRecommendationItemDetailAccessWithDefaults + +`func NewAccessRequestRecommendationItemDetailAccessWithDefaults() *AccessRequestRecommendationItemDetailAccess` + +NewAccessRequestRecommendationItemDetailAccessWithDefaults instantiates a new AccessRequestRecommendationItemDetailAccess 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 + +### GetId + +`func (o *AccessRequestRecommendationItemDetailAccess) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestRecommendationItemDetailAccess) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestRecommendationItemDetailAccess) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessRequestRecommendationItemDetailAccess) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessRequestRecommendationItemDetailAccess) GetType() AccessRequestRecommendationItemType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestRecommendationItemDetailAccess) GetTypeOk() (*AccessRequestRecommendationItemType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestRecommendationItemDetailAccess) SetType(v AccessRequestRecommendationItemType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessRequestRecommendationItemDetailAccess) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccessRequestRecommendationItemDetailAccess) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestRecommendationItemDetailAccess) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestRecommendationItemDetailAccess) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessRequestRecommendationItemDetailAccess) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessRequestRecommendationItemDetailAccess) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestRecommendationItemDetailAccess) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestRecommendationItemDetailAccess) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestRecommendationItemDetailAccess) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationItemType.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationItemType.md new file mode 100644 index 000000000..3618c3a15 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestRecommendationItemType.md @@ -0,0 +1,21 @@ +--- +id: v2024-access-request-recommendation-item-type +title: AccessRequestRecommendationItemType +pagination_label: AccessRequestRecommendationItemType +sidebar_label: AccessRequestRecommendationItemType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationItemType', 'V2024AccessRequestRecommendationItemType'] +slug: /tools/sdk/go/v2024/models/access-request-recommendation-item-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemType', 'V2024AccessRequestRecommendationItemType'] +--- + +# AccessRequestRecommendationItemType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestResponse.md new file mode 100644 index 000000000..2739998ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestResponse.md @@ -0,0 +1,90 @@ +--- +id: v2024-access-request-response +title: AccessRequestResponse +pagination_label: AccessRequestResponse +sidebar_label: AccessRequestResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestResponse', 'V2024AccessRequestResponse'] +slug: /tools/sdk/go/v2024/models/access-request-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'V2024AccessRequestResponse'] +--- + +# AccessRequestResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewRequests** | Pointer to [**[]AccessRequestTracking**](access-request-tracking) | A list of new access request tracking data mapped to the values requested. | [optional] +**ExistingRequests** | Pointer to [**[]AccessRequestTracking**](access-request-tracking) | A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. | [optional] + +## Methods + +### NewAccessRequestResponse + +`func NewAccessRequestResponse() *AccessRequestResponse` + +NewAccessRequestResponse instantiates a new AccessRequestResponse 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 + +### NewAccessRequestResponseWithDefaults + +`func NewAccessRequestResponseWithDefaults() *AccessRequestResponse` + +NewAccessRequestResponseWithDefaults instantiates a new AccessRequestResponse 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 + +### GetNewRequests + +`func (o *AccessRequestResponse) GetNewRequests() []AccessRequestTracking` + +GetNewRequests returns the NewRequests field if non-nil, zero value otherwise. + +### GetNewRequestsOk + +`func (o *AccessRequestResponse) GetNewRequestsOk() (*[]AccessRequestTracking, bool)` + +GetNewRequestsOk returns a tuple with the NewRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewRequests + +`func (o *AccessRequestResponse) SetNewRequests(v []AccessRequestTracking)` + +SetNewRequests sets NewRequests field to given value. + +### HasNewRequests + +`func (o *AccessRequestResponse) HasNewRequests() bool` + +HasNewRequests returns a boolean if a field has been set. + +### GetExistingRequests + +`func (o *AccessRequestResponse) GetExistingRequests() []AccessRequestTracking` + +GetExistingRequests returns the ExistingRequests field if non-nil, zero value otherwise. + +### GetExistingRequestsOk + +`func (o *AccessRequestResponse) GetExistingRequestsOk() (*[]AccessRequestTracking, bool)` + +GetExistingRequestsOk returns a tuple with the ExistingRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExistingRequests + +`func (o *AccessRequestResponse) SetExistingRequests(v []AccessRequestTracking)` + +SetExistingRequests sets ExistingRequests field to given value. + +### HasExistingRequests + +`func (o *AccessRequestResponse) HasExistingRequests() bool` + +HasExistingRequests returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestResponse1.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestResponse1.md new file mode 100644 index 000000000..7b19b4fad --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestResponse1.md @@ -0,0 +1,116 @@ +--- +id: v2024-access-request-response1 +title: AccessRequestResponse1 +pagination_label: AccessRequestResponse1 +sidebar_label: AccessRequestResponse1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestResponse1', 'V2024AccessRequestResponse1'] +slug: /tools/sdk/go/v2024/models/access-request-response1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse1', 'V2024AccessRequestResponse1'] +--- + +# AccessRequestResponse1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequesterId** | Pointer to **string** | the requester Id | [optional] +**RequesterName** | Pointer to **string** | the requesterName | [optional] +**Items** | Pointer to [**[]AccessRequestItemResponse**](access-request-item-response) | | [optional] + +## Methods + +### NewAccessRequestResponse1 + +`func NewAccessRequestResponse1() *AccessRequestResponse1` + +NewAccessRequestResponse1 instantiates a new AccessRequestResponse1 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 + +### NewAccessRequestResponse1WithDefaults + +`func NewAccessRequestResponse1WithDefaults() *AccessRequestResponse1` + +NewAccessRequestResponse1WithDefaults instantiates a new AccessRequestResponse1 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 + +### GetRequesterId + +`func (o *AccessRequestResponse1) GetRequesterId() string` + +GetRequesterId returns the RequesterId field if non-nil, zero value otherwise. + +### GetRequesterIdOk + +`func (o *AccessRequestResponse1) GetRequesterIdOk() (*string, bool)` + +GetRequesterIdOk returns a tuple with the RequesterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterId + +`func (o *AccessRequestResponse1) SetRequesterId(v string)` + +SetRequesterId sets RequesterId field to given value. + +### HasRequesterId + +`func (o *AccessRequestResponse1) HasRequesterId() bool` + +HasRequesterId returns a boolean if a field has been set. + +### GetRequesterName + +`func (o *AccessRequestResponse1) GetRequesterName() string` + +GetRequesterName returns the RequesterName field if non-nil, zero value otherwise. + +### GetRequesterNameOk + +`func (o *AccessRequestResponse1) GetRequesterNameOk() (*string, bool)` + +GetRequesterNameOk returns a tuple with the RequesterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterName + +`func (o *AccessRequestResponse1) SetRequesterName(v string)` + +SetRequesterName sets RequesterName field to given value. + +### HasRequesterName + +`func (o *AccessRequestResponse1) HasRequesterName() bool` + +HasRequesterName returns a boolean if a field has been set. + +### GetItems + +`func (o *AccessRequestResponse1) GetItems() []AccessRequestItemResponse` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *AccessRequestResponse1) GetItemsOk() (*[]AccessRequestItemResponse, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *AccessRequestResponse1) SetItems(v []AccessRequestItemResponse)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *AccessRequestResponse1) HasItems() bool` + +HasItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestTracking.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestTracking.md new file mode 100644 index 000000000..aa68cc174 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestTracking.md @@ -0,0 +1,142 @@ +--- +id: v2024-access-request-tracking +title: AccessRequestTracking +pagination_label: AccessRequestTracking +sidebar_label: AccessRequestTracking +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestTracking', 'V2024AccessRequestTracking'] +slug: /tools/sdk/go/v2024/models/access-request-tracking +tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'V2024AccessRequestTracking'] +--- + +# AccessRequestTracking + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedFor** | Pointer to **string** | The identity id in which the access request is for. | [optional] +**RequestedItemsDetails** | Pointer to [**[]RequestedItemDetails**](requested-item-details) | The details of the item requested. | [optional] +**AttributesHash** | Pointer to **int32** | a hash representation of the access requested, useful for longer term tracking client side. | [optional] +**AccessRequestIds** | Pointer to **[]string** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [optional] + +## Methods + +### NewAccessRequestTracking + +`func NewAccessRequestTracking() *AccessRequestTracking` + +NewAccessRequestTracking instantiates a new AccessRequestTracking 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 + +### NewAccessRequestTrackingWithDefaults + +`func NewAccessRequestTrackingWithDefaults() *AccessRequestTracking` + +NewAccessRequestTrackingWithDefaults instantiates a new AccessRequestTracking 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 + +### GetRequestedFor + +`func (o *AccessRequestTracking) GetRequestedFor() string` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequestTracking) GetRequestedForOk() (*string, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequestTracking) SetRequestedFor(v string)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *AccessRequestTracking) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetRequestedItemsDetails + +`func (o *AccessRequestTracking) GetRequestedItemsDetails() []RequestedItemDetails` + +GetRequestedItemsDetails returns the RequestedItemsDetails field if non-nil, zero value otherwise. + +### GetRequestedItemsDetailsOk + +`func (o *AccessRequestTracking) GetRequestedItemsDetailsOk() (*[]RequestedItemDetails, bool)` + +GetRequestedItemsDetailsOk returns a tuple with the RequestedItemsDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItemsDetails + +`func (o *AccessRequestTracking) SetRequestedItemsDetails(v []RequestedItemDetails)` + +SetRequestedItemsDetails sets RequestedItemsDetails field to given value. + +### HasRequestedItemsDetails + +`func (o *AccessRequestTracking) HasRequestedItemsDetails() bool` + +HasRequestedItemsDetails returns a boolean if a field has been set. + +### GetAttributesHash + +`func (o *AccessRequestTracking) GetAttributesHash() int32` + +GetAttributesHash returns the AttributesHash field if non-nil, zero value otherwise. + +### GetAttributesHashOk + +`func (o *AccessRequestTracking) GetAttributesHashOk() (*int32, bool)` + +GetAttributesHashOk returns a tuple with the AttributesHash field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributesHash + +`func (o *AccessRequestTracking) SetAttributesHash(v int32)` + +SetAttributesHash sets AttributesHash field to given value. + +### HasAttributesHash + +`func (o *AccessRequestTracking) HasAttributesHash() bool` + +HasAttributesHash returns a boolean if a field has been set. + +### GetAccessRequestIds + +`func (o *AccessRequestTracking) GetAccessRequestIds() []string` + +GetAccessRequestIds returns the AccessRequestIds field if non-nil, zero value otherwise. + +### GetAccessRequestIdsOk + +`func (o *AccessRequestTracking) GetAccessRequestIdsOk() (*[]string, bool)` + +GetAccessRequestIdsOk returns a tuple with the AccessRequestIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestIds + +`func (o *AccessRequestTracking) SetAccessRequestIds(v []string)` + +SetAccessRequestIds sets AccessRequestIds field to given value. + +### HasAccessRequestIds + +`func (o *AccessRequestTracking) HasAccessRequestIds() bool` + +HasAccessRequestIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestType.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestType.md new file mode 100644 index 000000000..ed353f07f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequestType.md @@ -0,0 +1,21 @@ +--- +id: v2024-access-request-type +title: AccessRequestType +pagination_label: AccessRequestType +sidebar_label: AccessRequestType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestType', 'V2024AccessRequestType'] +slug: /tools/sdk/go/v2024/models/access-request-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestType', 'V2024AccessRequestType'] +--- + +# AccessRequestType + +## Enum + + +* `GRANT_ACCESS` (value: `"GRANT_ACCESS"`) + +* `REVOKE_ACCESS` (value: `"REVOKE_ACCESS"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessRequested.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequested.md new file mode 100644 index 000000000..56a183e93 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessRequested.md @@ -0,0 +1,142 @@ +--- +id: v2024-access-requested +title: AccessRequested +pagination_label: AccessRequested +sidebar_label: AccessRequested +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequested', 'V2024AccessRequested'] +slug: /tools/sdk/go/v2024/models/access-requested +tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'V2024AccessRequested'] +--- + +# AccessRequested + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequest** | Pointer to [**AccessRequestResponse1**](access-request-response1) | | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] + +## Methods + +### NewAccessRequested + +`func NewAccessRequested() *AccessRequested` + +NewAccessRequested instantiates a new AccessRequested 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 + +### NewAccessRequestedWithDefaults + +`func NewAccessRequestedWithDefaults() *AccessRequested` + +NewAccessRequestedWithDefaults instantiates a new AccessRequested 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 + +### GetAccessRequest + +`func (o *AccessRequested) GetAccessRequest() AccessRequestResponse1` + +GetAccessRequest returns the AccessRequest field if non-nil, zero value otherwise. + +### GetAccessRequestOk + +`func (o *AccessRequested) GetAccessRequestOk() (*AccessRequestResponse1, bool)` + +GetAccessRequestOk returns a tuple with the AccessRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequest + +`func (o *AccessRequested) SetAccessRequest(v AccessRequestResponse1)` + +SetAccessRequest sets AccessRequest field to given value. + +### HasAccessRequest + +`func (o *AccessRequested) HasAccessRequest() bool` + +HasAccessRequest returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *AccessRequested) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessRequested) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessRequested) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccessRequested) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEventType + +`func (o *AccessRequested) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AccessRequested) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AccessRequested) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AccessRequested) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDt + +`func (o *AccessRequested) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *AccessRequested) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *AccessRequested) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *AccessRequested) HasDt() bool` + +HasDt returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessReviewItem.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessReviewItem.md new file mode 100644 index 000000000..b7e6ae4ab --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessReviewItem.md @@ -0,0 +1,230 @@ +--- +id: v2024-access-review-item +title: AccessReviewItem +pagination_label: AccessReviewItem +sidebar_label: AccessReviewItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessReviewItem', 'V2024AccessReviewItem'] +slug: /tools/sdk/go/v2024/models/access-review-item +tags: ['SDK', 'Software Development Kit', 'AccessReviewItem', 'V2024AccessReviewItem'] +--- + +# AccessReviewItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessSummary** | Pointer to [**AccessSummary**](access-summary) | | [optional] +**IdentitySummary** | Pointer to [**CertificationIdentitySummary**](certification-identity-summary) | | [optional] +**Id** | Pointer to **string** | The review item's id | [optional] +**Completed** | Pointer to **bool** | Whether the review item is complete | [optional] +**NewAccess** | Pointer to **bool** | Indicates whether the review item is for new access to a source | [optional] +**Decision** | Pointer to [**CertificationDecision**](certification-decision) | | [optional] +**Comments** | Pointer to **NullableString** | Comments for this review item | [optional] + +## Methods + +### NewAccessReviewItem + +`func NewAccessReviewItem() *AccessReviewItem` + +NewAccessReviewItem instantiates a new AccessReviewItem 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 + +### NewAccessReviewItemWithDefaults + +`func NewAccessReviewItemWithDefaults() *AccessReviewItem` + +NewAccessReviewItemWithDefaults instantiates a new AccessReviewItem 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 + +### GetAccessSummary + +`func (o *AccessReviewItem) GetAccessSummary() AccessSummary` + +GetAccessSummary returns the AccessSummary field if non-nil, zero value otherwise. + +### GetAccessSummaryOk + +`func (o *AccessReviewItem) GetAccessSummaryOk() (*AccessSummary, bool)` + +GetAccessSummaryOk returns a tuple with the AccessSummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessSummary + +`func (o *AccessReviewItem) SetAccessSummary(v AccessSummary)` + +SetAccessSummary sets AccessSummary field to given value. + +### HasAccessSummary + +`func (o *AccessReviewItem) HasAccessSummary() bool` + +HasAccessSummary returns a boolean if a field has been set. + +### GetIdentitySummary + +`func (o *AccessReviewItem) GetIdentitySummary() CertificationIdentitySummary` + +GetIdentitySummary returns the IdentitySummary field if non-nil, zero value otherwise. + +### GetIdentitySummaryOk + +`func (o *AccessReviewItem) GetIdentitySummaryOk() (*CertificationIdentitySummary, bool)` + +GetIdentitySummaryOk returns a tuple with the IdentitySummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitySummary + +`func (o *AccessReviewItem) SetIdentitySummary(v CertificationIdentitySummary)` + +SetIdentitySummary sets IdentitySummary field to given value. + +### HasIdentitySummary + +`func (o *AccessReviewItem) HasIdentitySummary() bool` + +HasIdentitySummary returns a boolean if a field has been set. + +### GetId + +`func (o *AccessReviewItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessReviewItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessReviewItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessReviewItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCompleted + +`func (o *AccessReviewItem) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *AccessReviewItem) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *AccessReviewItem) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *AccessReviewItem) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetNewAccess + +`func (o *AccessReviewItem) GetNewAccess() bool` + +GetNewAccess returns the NewAccess field if non-nil, zero value otherwise. + +### GetNewAccessOk + +`func (o *AccessReviewItem) GetNewAccessOk() (*bool, bool)` + +GetNewAccessOk returns a tuple with the NewAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewAccess + +`func (o *AccessReviewItem) SetNewAccess(v bool)` + +SetNewAccess sets NewAccess field to given value. + +### HasNewAccess + +`func (o *AccessReviewItem) HasNewAccess() bool` + +HasNewAccess returns a boolean if a field has been set. + +### GetDecision + +`func (o *AccessReviewItem) GetDecision() CertificationDecision` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *AccessReviewItem) GetDecisionOk() (*CertificationDecision, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *AccessReviewItem) SetDecision(v CertificationDecision)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *AccessReviewItem) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + +### GetComments + +`func (o *AccessReviewItem) GetComments() string` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *AccessReviewItem) GetCommentsOk() (*string, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *AccessReviewItem) SetComments(v string)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *AccessReviewItem) HasComments() bool` + +HasComments returns a boolean if a field has been set. + +### SetCommentsNil + +`func (o *AccessReviewItem) SetCommentsNil(b bool)` + + SetCommentsNil sets the value for Comments to be an explicit nil + +### UnsetComments +`func (o *AccessReviewItem) UnsetComments()` + +UnsetComments ensures that no value is present for Comments, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessReviewReassignment.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessReviewReassignment.md new file mode 100644 index 000000000..feac85891 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessReviewReassignment.md @@ -0,0 +1,101 @@ +--- +id: v2024-access-review-reassignment +title: AccessReviewReassignment +pagination_label: AccessReviewReassignment +sidebar_label: AccessReviewReassignment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessReviewReassignment', 'V2024AccessReviewReassignment'] +slug: /tools/sdk/go/v2024/models/access-review-reassignment +tags: ['SDK', 'Software Development Kit', 'AccessReviewReassignment', 'V2024AccessReviewReassignment'] +--- + +# AccessReviewReassignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Reassign** | [**[]ReassignReference**](reassign-reference) | | +**ReassignTo** | **string** | The ID of the identity to which the certification is reassigned | +**Reason** | **string** | The reason comment for why the reassign was made | + +## Methods + +### NewAccessReviewReassignment + +`func NewAccessReviewReassignment(reassign []ReassignReference, reassignTo string, reason string, ) *AccessReviewReassignment` + +NewAccessReviewReassignment instantiates a new AccessReviewReassignment 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 + +### NewAccessReviewReassignmentWithDefaults + +`func NewAccessReviewReassignmentWithDefaults() *AccessReviewReassignment` + +NewAccessReviewReassignmentWithDefaults instantiates a new AccessReviewReassignment 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 + +### GetReassign + +`func (o *AccessReviewReassignment) GetReassign() []ReassignReference` + +GetReassign returns the Reassign field if non-nil, zero value otherwise. + +### GetReassignOk + +`func (o *AccessReviewReassignment) GetReassignOk() (*[]ReassignReference, bool)` + +GetReassignOk returns a tuple with the Reassign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassign + +`func (o *AccessReviewReassignment) SetReassign(v []ReassignReference)` + +SetReassign sets Reassign field to given value. + + +### GetReassignTo + +`func (o *AccessReviewReassignment) GetReassignTo() string` + +GetReassignTo returns the ReassignTo field if non-nil, zero value otherwise. + +### GetReassignToOk + +`func (o *AccessReviewReassignment) GetReassignToOk() (*string, bool)` + +GetReassignToOk returns a tuple with the ReassignTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignTo + +`func (o *AccessReviewReassignment) SetReassignTo(v string)` + +SetReassignTo sets ReassignTo field to given value. + + +### GetReason + +`func (o *AccessReviewReassignment) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *AccessReviewReassignment) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *AccessReviewReassignment) SetReason(v string)` + +SetReason sets Reason field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessSummary.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessSummary.md new file mode 100644 index 000000000..2b6ffd38d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessSummary.md @@ -0,0 +1,162 @@ +--- +id: v2024-access-summary +title: AccessSummary +pagination_label: AccessSummary +sidebar_label: AccessSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessSummary', 'V2024AccessSummary'] +slug: /tools/sdk/go/v2024/models/access-summary +tags: ['SDK', 'Software Development Kit', 'AccessSummary', 'V2024AccessSummary'] +--- + +# AccessSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Access** | Pointer to [**AccessSummaryAccess**](access-summary-access) | | [optional] +**Entitlement** | Pointer to [**NullableReviewableEntitlement**](reviewable-entitlement) | | [optional] +**AccessProfile** | Pointer to [**ReviewableAccessProfile**](reviewable-access-profile) | | [optional] +**Role** | Pointer to [**NullableReviewableRole**](reviewable-role) | | [optional] + +## Methods + +### NewAccessSummary + +`func NewAccessSummary() *AccessSummary` + +NewAccessSummary instantiates a new AccessSummary 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 + +### NewAccessSummaryWithDefaults + +`func NewAccessSummaryWithDefaults() *AccessSummary` + +NewAccessSummaryWithDefaults instantiates a new AccessSummary 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 + +### GetAccess + +`func (o *AccessSummary) GetAccess() AccessSummaryAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *AccessSummary) GetAccessOk() (*AccessSummaryAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *AccessSummary) SetAccess(v AccessSummaryAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *AccessSummary) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetEntitlement + +`func (o *AccessSummary) GetEntitlement() ReviewableEntitlement` + +GetEntitlement returns the Entitlement field if non-nil, zero value otherwise. + +### GetEntitlementOk + +`func (o *AccessSummary) GetEntitlementOk() (*ReviewableEntitlement, bool)` + +GetEntitlementOk returns a tuple with the Entitlement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlement + +`func (o *AccessSummary) SetEntitlement(v ReviewableEntitlement)` + +SetEntitlement sets Entitlement field to given value. + +### HasEntitlement + +`func (o *AccessSummary) HasEntitlement() bool` + +HasEntitlement returns a boolean if a field has been set. + +### SetEntitlementNil + +`func (o *AccessSummary) SetEntitlementNil(b bool)` + + SetEntitlementNil sets the value for Entitlement to be an explicit nil + +### UnsetEntitlement +`func (o *AccessSummary) UnsetEntitlement()` + +UnsetEntitlement ensures that no value is present for Entitlement, not even an explicit nil +### GetAccessProfile + +`func (o *AccessSummary) GetAccessProfile() ReviewableAccessProfile` + +GetAccessProfile returns the AccessProfile field if non-nil, zero value otherwise. + +### GetAccessProfileOk + +`func (o *AccessSummary) GetAccessProfileOk() (*ReviewableAccessProfile, bool)` + +GetAccessProfileOk returns a tuple with the AccessProfile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfile + +`func (o *AccessSummary) SetAccessProfile(v ReviewableAccessProfile)` + +SetAccessProfile sets AccessProfile field to given value. + +### HasAccessProfile + +`func (o *AccessSummary) HasAccessProfile() bool` + +HasAccessProfile returns a boolean if a field has been set. + +### GetRole + +`func (o *AccessSummary) GetRole() ReviewableRole` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *AccessSummary) GetRoleOk() (*ReviewableRole, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *AccessSummary) SetRole(v ReviewableRole)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *AccessSummary) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### SetRoleNil + +`func (o *AccessSummary) SetRoleNil(b bool)` + + SetRoleNil sets the value for Role to be an explicit nil + +### UnsetRole +`func (o *AccessSummary) UnsetRole()` + +UnsetRole ensures that no value is present for Role, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessSummaryAccess.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessSummaryAccess.md new file mode 100644 index 000000000..df789507c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessSummaryAccess.md @@ -0,0 +1,116 @@ +--- +id: v2024-access-summary-access +title: AccessSummaryAccess +pagination_label: AccessSummaryAccess +sidebar_label: AccessSummaryAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessSummaryAccess', 'V2024AccessSummaryAccess'] +slug: /tools/sdk/go/v2024/models/access-summary-access +tags: ['SDK', 'Software Development Kit', 'AccessSummaryAccess', 'V2024AccessSummaryAccess'] +--- + +# AccessSummaryAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | The ID of the item being certified | [optional] +**Name** | Pointer to **string** | The name of the item being certified | [optional] + +## Methods + +### NewAccessSummaryAccess + +`func NewAccessSummaryAccess() *AccessSummaryAccess` + +NewAccessSummaryAccess instantiates a new AccessSummaryAccess 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 + +### NewAccessSummaryAccessWithDefaults + +`func NewAccessSummaryAccessWithDefaults() *AccessSummaryAccess` + +NewAccessSummaryAccessWithDefaults instantiates a new AccessSummaryAccess 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 + +### GetType + +`func (o *AccessSummaryAccess) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessSummaryAccess) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessSummaryAccess) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessSummaryAccess) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessSummaryAccess) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessSummaryAccess) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessSummaryAccess) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessSummaryAccess) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessSummaryAccess) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessSummaryAccess) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessSummaryAccess) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessSummaryAccess) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccessType.md b/docs/tools/sdk/go/Reference/V2024/Models/AccessType.md new file mode 100644 index 000000000..e09c07a4c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccessType.md @@ -0,0 +1,21 @@ +--- +id: v2024-access-type +title: AccessType +pagination_label: AccessType +sidebar_label: AccessType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessType', 'V2024AccessType'] +slug: /tools/sdk/go/v2024/models/access-type +tags: ['SDK', 'Software Development Kit', 'AccessType', 'V2024AccessType'] +--- + +# AccessType + +## Enum + + +* `ONLINE` (value: `"ONLINE"`) + +* `OFFLINE` (value: `"OFFLINE"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Account.md b/docs/tools/sdk/go/Reference/V2024/Models/Account.md new file mode 100644 index 000000000..32e1cfedb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Account.md @@ -0,0 +1,816 @@ +--- +id: v2024-account +title: Account +pagination_label: Account +sidebar_label: Account +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Account', 'V2024Account'] +slug: /tools/sdk/go/v2024/models/account +tags: ['SDK', 'Software Development Kit', 'Account', 'V2024Account'] +--- + +# Account + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**SourceId** | **string** | The unique ID of the source this account belongs to | +**SourceName** | **NullableString** | The display name of the source this account belongs to | +**IdentityId** | Pointer to **string** | The unique ID of the identity this account is correlated to | [optional] +**CloudLifecycleState** | Pointer to **NullableString** | The lifecycle state of the identity this account is correlated to | [optional] +**IdentityState** | Pointer to **NullableString** | The identity state of the identity this account is correlated to | [optional] +**ConnectionType** | Pointer to **NullableString** | The connection type of the source this account is from | [optional] +**IsMachine** | Pointer to **bool** | Indicates if the account is of machine type | [optional] [default to false] +**Recommendation** | Pointer to [**AccountAllOfRecommendation**](account-all-of-recommendation) | | [optional] +**Attributes** | **map[string]interface{}** | The account attributes that are aggregated | +**Authoritative** | **bool** | Indicates if this account is from an authoritative source | +**Description** | Pointer to **NullableString** | A description of the account | [optional] +**Disabled** | **bool** | Indicates if the account is currently disabled | +**Locked** | **bool** | Indicates if the account is currently locked | +**NativeIdentity** | **string** | The unique ID of the account generated by the source system | +**SystemAccount** | **bool** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | +**Uncorrelated** | **bool** | Indicates if this account is not correlated to an identity | +**Uuid** | Pointer to **NullableString** | The unique ID of the account as determined by the account schema | [optional] +**ManuallyCorrelated** | **bool** | Indicates if the account has been manually correlated to an identity | +**HasEntitlements** | **bool** | Indicates if the account has entitlements | +**Identity** | Pointer to [**AccountAllOfIdentity**](account-all-of-identity) | | [optional] +**SourceOwner** | Pointer to [**NullableAccountAllOfSourceOwner**](account-all-of-source-owner) | | [optional] +**Features** | Pointer to **NullableString** | A string list containing the owning source's features | [optional] +**Origin** | Pointer to **NullableString** | The origin of the account either aggregated or provisioned | [optional] +**OwnerIdentity** | Pointer to [**AccountAllOfOwnerIdentity**](account-all-of-owner-identity) | | [optional] + +## Methods + +### NewAccount + +`func NewAccount(name NullableString, sourceId string, sourceName NullableString, attributes map[string]interface{}, authoritative bool, disabled bool, locked bool, nativeIdentity string, systemAccount bool, uncorrelated bool, manuallyCorrelated bool, hasEntitlements bool, ) *Account` + +NewAccount instantiates a new Account 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 + +### NewAccountWithDefaults + +`func NewAccountWithDefaults() *Account` + +NewAccountWithDefaults instantiates a new Account 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 + +### GetId + +`func (o *Account) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Account) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Account) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Account) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Account) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Account) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Account) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *Account) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *Account) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *Account) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Account) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Account) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Account) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Account) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Account) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Account) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Account) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetSourceId + +`func (o *Account) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *Account) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *Account) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetSourceName + +`func (o *Account) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *Account) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *Account) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### SetSourceNameNil + +`func (o *Account) SetSourceNameNil(b bool)` + + SetSourceNameNil sets the value for SourceName to be an explicit nil + +### UnsetSourceName +`func (o *Account) UnsetSourceName()` + +UnsetSourceName ensures that no value is present for SourceName, not even an explicit nil +### GetIdentityId + +`func (o *Account) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *Account) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *Account) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *Account) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetCloudLifecycleState + +`func (o *Account) GetCloudLifecycleState() string` + +GetCloudLifecycleState returns the CloudLifecycleState field if non-nil, zero value otherwise. + +### GetCloudLifecycleStateOk + +`func (o *Account) GetCloudLifecycleStateOk() (*string, bool)` + +GetCloudLifecycleStateOk returns a tuple with the CloudLifecycleState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudLifecycleState + +`func (o *Account) SetCloudLifecycleState(v string)` + +SetCloudLifecycleState sets CloudLifecycleState field to given value. + +### HasCloudLifecycleState + +`func (o *Account) HasCloudLifecycleState() bool` + +HasCloudLifecycleState returns a boolean if a field has been set. + +### SetCloudLifecycleStateNil + +`func (o *Account) SetCloudLifecycleStateNil(b bool)` + + SetCloudLifecycleStateNil sets the value for CloudLifecycleState to be an explicit nil + +### UnsetCloudLifecycleState +`func (o *Account) UnsetCloudLifecycleState()` + +UnsetCloudLifecycleState ensures that no value is present for CloudLifecycleState, not even an explicit nil +### GetIdentityState + +`func (o *Account) GetIdentityState() string` + +GetIdentityState returns the IdentityState field if non-nil, zero value otherwise. + +### GetIdentityStateOk + +`func (o *Account) GetIdentityStateOk() (*string, bool)` + +GetIdentityStateOk returns a tuple with the IdentityState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityState + +`func (o *Account) SetIdentityState(v string)` + +SetIdentityState sets IdentityState field to given value. + +### HasIdentityState + +`func (o *Account) HasIdentityState() bool` + +HasIdentityState returns a boolean if a field has been set. + +### SetIdentityStateNil + +`func (o *Account) SetIdentityStateNil(b bool)` + + SetIdentityStateNil sets the value for IdentityState to be an explicit nil + +### UnsetIdentityState +`func (o *Account) UnsetIdentityState()` + +UnsetIdentityState ensures that no value is present for IdentityState, not even an explicit nil +### GetConnectionType + +`func (o *Account) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *Account) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *Account) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *Account) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + +### SetConnectionTypeNil + +`func (o *Account) SetConnectionTypeNil(b bool)` + + SetConnectionTypeNil sets the value for ConnectionType to be an explicit nil + +### UnsetConnectionType +`func (o *Account) UnsetConnectionType()` + +UnsetConnectionType ensures that no value is present for ConnectionType, not even an explicit nil +### GetIsMachine + +`func (o *Account) GetIsMachine() bool` + +GetIsMachine returns the IsMachine field if non-nil, zero value otherwise. + +### GetIsMachineOk + +`func (o *Account) GetIsMachineOk() (*bool, bool)` + +GetIsMachineOk returns a tuple with the IsMachine field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsMachine + +`func (o *Account) SetIsMachine(v bool)` + +SetIsMachine sets IsMachine field to given value. + +### HasIsMachine + +`func (o *Account) HasIsMachine() bool` + +HasIsMachine returns a boolean if a field has been set. + +### GetRecommendation + +`func (o *Account) GetRecommendation() AccountAllOfRecommendation` + +GetRecommendation returns the Recommendation field if non-nil, zero value otherwise. + +### GetRecommendationOk + +`func (o *Account) GetRecommendationOk() (*AccountAllOfRecommendation, bool)` + +GetRecommendationOk returns a tuple with the Recommendation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendation + +`func (o *Account) SetRecommendation(v AccountAllOfRecommendation)` + +SetRecommendation sets Recommendation field to given value. + +### HasRecommendation + +`func (o *Account) HasRecommendation() bool` + +HasRecommendation returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Account) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Account) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Account) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *Account) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *Account) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetAuthoritative + +`func (o *Account) GetAuthoritative() bool` + +GetAuthoritative returns the Authoritative field if non-nil, zero value otherwise. + +### GetAuthoritativeOk + +`func (o *Account) GetAuthoritativeOk() (*bool, bool)` + +GetAuthoritativeOk returns a tuple with the Authoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritative + +`func (o *Account) SetAuthoritative(v bool)` + +SetAuthoritative sets Authoritative field to given value. + + +### GetDescription + +`func (o *Account) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Account) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Account) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Account) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Account) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Account) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetDisabled + +`func (o *Account) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *Account) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *Account) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + + +### GetLocked + +`func (o *Account) GetLocked() bool` + +GetLocked returns the Locked field if non-nil, zero value otherwise. + +### GetLockedOk + +`func (o *Account) GetLockedOk() (*bool, bool)` + +GetLockedOk returns a tuple with the Locked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocked + +`func (o *Account) SetLocked(v bool)` + +SetLocked sets Locked field to given value. + + +### GetNativeIdentity + +`func (o *Account) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *Account) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *Account) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + + +### GetSystemAccount + +`func (o *Account) GetSystemAccount() bool` + +GetSystemAccount returns the SystemAccount field if non-nil, zero value otherwise. + +### GetSystemAccountOk + +`func (o *Account) GetSystemAccountOk() (*bool, bool)` + +GetSystemAccountOk returns a tuple with the SystemAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSystemAccount + +`func (o *Account) SetSystemAccount(v bool)` + +SetSystemAccount sets SystemAccount field to given value. + + +### GetUncorrelated + +`func (o *Account) GetUncorrelated() bool` + +GetUncorrelated returns the Uncorrelated field if non-nil, zero value otherwise. + +### GetUncorrelatedOk + +`func (o *Account) GetUncorrelatedOk() (*bool, bool)` + +GetUncorrelatedOk returns a tuple with the Uncorrelated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUncorrelated + +`func (o *Account) SetUncorrelated(v bool)` + +SetUncorrelated sets Uncorrelated field to given value. + + +### GetUuid + +`func (o *Account) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *Account) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *Account) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *Account) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *Account) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *Account) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetManuallyCorrelated + +`func (o *Account) GetManuallyCorrelated() bool` + +GetManuallyCorrelated returns the ManuallyCorrelated field if non-nil, zero value otherwise. + +### GetManuallyCorrelatedOk + +`func (o *Account) GetManuallyCorrelatedOk() (*bool, bool)` + +GetManuallyCorrelatedOk returns a tuple with the ManuallyCorrelated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyCorrelated + +`func (o *Account) SetManuallyCorrelated(v bool)` + +SetManuallyCorrelated sets ManuallyCorrelated field to given value. + + +### GetHasEntitlements + +`func (o *Account) GetHasEntitlements() bool` + +GetHasEntitlements returns the HasEntitlements field if non-nil, zero value otherwise. + +### GetHasEntitlementsOk + +`func (o *Account) GetHasEntitlementsOk() (*bool, bool)` + +GetHasEntitlementsOk returns a tuple with the HasEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasEntitlements + +`func (o *Account) SetHasEntitlements(v bool)` + +SetHasEntitlements sets HasEntitlements field to given value. + + +### GetIdentity + +`func (o *Account) GetIdentity() AccountAllOfIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *Account) GetIdentityOk() (*AccountAllOfIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *Account) SetIdentity(v AccountAllOfIdentity)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *Account) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetSourceOwner + +`func (o *Account) GetSourceOwner() AccountAllOfSourceOwner` + +GetSourceOwner returns the SourceOwner field if non-nil, zero value otherwise. + +### GetSourceOwnerOk + +`func (o *Account) GetSourceOwnerOk() (*AccountAllOfSourceOwner, bool)` + +GetSourceOwnerOk returns a tuple with the SourceOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceOwner + +`func (o *Account) SetSourceOwner(v AccountAllOfSourceOwner)` + +SetSourceOwner sets SourceOwner field to given value. + +### HasSourceOwner + +`func (o *Account) HasSourceOwner() bool` + +HasSourceOwner returns a boolean if a field has been set. + +### SetSourceOwnerNil + +`func (o *Account) SetSourceOwnerNil(b bool)` + + SetSourceOwnerNil sets the value for SourceOwner to be an explicit nil + +### UnsetSourceOwner +`func (o *Account) UnsetSourceOwner()` + +UnsetSourceOwner ensures that no value is present for SourceOwner, not even an explicit nil +### GetFeatures + +`func (o *Account) GetFeatures() string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *Account) GetFeaturesOk() (*string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *Account) SetFeatures(v string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *Account) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### SetFeaturesNil + +`func (o *Account) SetFeaturesNil(b bool)` + + SetFeaturesNil sets the value for Features to be an explicit nil + +### UnsetFeatures +`func (o *Account) UnsetFeatures()` + +UnsetFeatures ensures that no value is present for Features, not even an explicit nil +### GetOrigin + +`func (o *Account) GetOrigin() string` + +GetOrigin returns the Origin field if non-nil, zero value otherwise. + +### GetOriginOk + +`func (o *Account) GetOriginOk() (*string, bool)` + +GetOriginOk returns a tuple with the Origin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrigin + +`func (o *Account) SetOrigin(v string)` + +SetOrigin sets Origin field to given value. + +### HasOrigin + +`func (o *Account) HasOrigin() bool` + +HasOrigin returns a boolean if a field has been set. + +### SetOriginNil + +`func (o *Account) SetOriginNil(b bool)` + + SetOriginNil sets the value for Origin to be an explicit nil + +### UnsetOrigin +`func (o *Account) UnsetOrigin()` + +UnsetOrigin ensures that no value is present for Origin, not even an explicit nil +### GetOwnerIdentity + +`func (o *Account) GetOwnerIdentity() AccountAllOfOwnerIdentity` + +GetOwnerIdentity returns the OwnerIdentity field if non-nil, zero value otherwise. + +### GetOwnerIdentityOk + +`func (o *Account) GetOwnerIdentityOk() (*AccountAllOfOwnerIdentity, bool)` + +GetOwnerIdentityOk returns a tuple with the OwnerIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerIdentity + +`func (o *Account) SetOwnerIdentity(v AccountAllOfOwnerIdentity)` + +SetOwnerIdentity sets OwnerIdentity field to given value. + +### HasOwnerIdentity + +`func (o *Account) HasOwnerIdentity() bool` + +HasOwnerIdentity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAction.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAction.md new file mode 100644 index 000000000..9bf0f5b15 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAction.md @@ -0,0 +1,90 @@ +--- +id: v2024-account-action +title: AccountAction +pagination_label: AccountAction +sidebar_label: AccountAction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAction', 'V2024AccountAction'] +slug: /tools/sdk/go/v2024/models/account-action +tags: ['SDK', 'Software Development Kit', 'AccountAction', 'V2024AccountAction'] +--- + +# AccountAction + +## Properties + +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] + +## Methods + +### NewAccountAction + +`func NewAccountAction() *AccountAction` + +NewAccountAction instantiates a new AccountAction 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 + +### NewAccountActionWithDefaults + +`func NewAccountActionWithDefaults() *AccountAction` + +NewAccountActionWithDefaults instantiates a new AccountAction 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 + +### GetAction + +`func (o *AccountAction) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *AccountAction) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *AccountAction) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *AccountAction) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetSourceIds + +`func (o *AccountAction) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *AccountAction) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *AccountAction) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *AccountAction) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountActivity.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountActivity.md new file mode 100644 index 000000000..a08bcce5d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountActivity.md @@ -0,0 +1,502 @@ +--- +id: v2024-account-activity +title: AccountActivity +pagination_label: AccountActivity +sidebar_label: AccountActivity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivity', 'V2024AccountActivity'] +slug: /tools/sdk/go/v2024/models/account-activity +tags: ['SDK', 'Software Development Kit', 'AccountActivity', 'V2024AccountActivity'] +--- + +# AccountActivity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the account activity | [optional] +**Name** | Pointer to **string** | The name of the activity | [optional] +**Created** | Pointer to **SailPointTime** | When the activity was first created | [optional] +**Modified** | Pointer to **NullableTime** | When the activity was last modified | [optional] +**Completed** | Pointer to **NullableTime** | When the activity was completed | [optional] +**CompletionStatus** | Pointer to [**NullableCompletionStatus**](completion-status) | | [optional] +**Type** | Pointer to **NullableString** | The type of action the activity performed. Please see the following list of types. This list may grow over time. - CloudAutomated - IdentityAttributeUpdate - appRequest - LifecycleStateChange - AccountStateUpdate - AccountAttributeUpdate - CloudPasswordRequest - Attribute Synchronization Refresh - Certification - Identity Refresh - Lifecycle Change Refresh [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). | [optional] +**RequesterIdentitySummary** | Pointer to [**NullableIdentitySummary**](identity-summary) | | [optional] +**TargetIdentitySummary** | Pointer to [**NullableIdentitySummary**](identity-summary) | | [optional] +**Errors** | Pointer to **[]string** | A list of error messages, if any, that were encountered. | [optional] +**Warnings** | Pointer to **[]string** | A list of warning messages, if any, that were encountered. | [optional] +**Items** | Pointer to [**[]AccountActivityItem**](account-activity-item) | Individual actions performed as part of this account activity | [optional] +**ExecutionStatus** | Pointer to [**ExecutionStatus**](execution-status) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] + +## Methods + +### NewAccountActivity + +`func NewAccountActivity() *AccountActivity` + +NewAccountActivity instantiates a new AccountActivity 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 + +### NewAccountActivityWithDefaults + +`func NewAccountActivityWithDefaults() *AccountActivity` + +NewAccountActivityWithDefaults instantiates a new AccountActivity 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 + +### GetId + +`func (o *AccountActivity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountActivity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountActivity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountActivity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccountActivity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountActivity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountActivity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountActivity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *AccountActivity) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccountActivity) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccountActivity) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccountActivity) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *AccountActivity) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccountActivity) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccountActivity) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccountActivity) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *AccountActivity) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *AccountActivity) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetCompleted + +`func (o *AccountActivity) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *AccountActivity) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *AccountActivity) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *AccountActivity) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *AccountActivity) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *AccountActivity) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetCompletionStatus + +`func (o *AccountActivity) GetCompletionStatus() CompletionStatus` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *AccountActivity) GetCompletionStatusOk() (*CompletionStatus, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *AccountActivity) SetCompletionStatus(v CompletionStatus)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *AccountActivity) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + +### SetCompletionStatusNil + +`func (o *AccountActivity) SetCompletionStatusNil(b bool)` + + SetCompletionStatusNil sets the value for CompletionStatus to be an explicit nil + +### UnsetCompletionStatus +`func (o *AccountActivity) UnsetCompletionStatus()` + +UnsetCompletionStatus ensures that no value is present for CompletionStatus, not even an explicit nil +### GetType + +`func (o *AccountActivity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountActivity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountActivity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountActivity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *AccountActivity) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *AccountActivity) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetRequesterIdentitySummary + +`func (o *AccountActivity) GetRequesterIdentitySummary() IdentitySummary` + +GetRequesterIdentitySummary returns the RequesterIdentitySummary field if non-nil, zero value otherwise. + +### GetRequesterIdentitySummaryOk + +`func (o *AccountActivity) GetRequesterIdentitySummaryOk() (*IdentitySummary, bool)` + +GetRequesterIdentitySummaryOk returns a tuple with the RequesterIdentitySummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterIdentitySummary + +`func (o *AccountActivity) SetRequesterIdentitySummary(v IdentitySummary)` + +SetRequesterIdentitySummary sets RequesterIdentitySummary field to given value. + +### HasRequesterIdentitySummary + +`func (o *AccountActivity) HasRequesterIdentitySummary() bool` + +HasRequesterIdentitySummary returns a boolean if a field has been set. + +### SetRequesterIdentitySummaryNil + +`func (o *AccountActivity) SetRequesterIdentitySummaryNil(b bool)` + + SetRequesterIdentitySummaryNil sets the value for RequesterIdentitySummary to be an explicit nil + +### UnsetRequesterIdentitySummary +`func (o *AccountActivity) UnsetRequesterIdentitySummary()` + +UnsetRequesterIdentitySummary ensures that no value is present for RequesterIdentitySummary, not even an explicit nil +### GetTargetIdentitySummary + +`func (o *AccountActivity) GetTargetIdentitySummary() IdentitySummary` + +GetTargetIdentitySummary returns the TargetIdentitySummary field if non-nil, zero value otherwise. + +### GetTargetIdentitySummaryOk + +`func (o *AccountActivity) GetTargetIdentitySummaryOk() (*IdentitySummary, bool)` + +GetTargetIdentitySummaryOk returns a tuple with the TargetIdentitySummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetIdentitySummary + +`func (o *AccountActivity) SetTargetIdentitySummary(v IdentitySummary)` + +SetTargetIdentitySummary sets TargetIdentitySummary field to given value. + +### HasTargetIdentitySummary + +`func (o *AccountActivity) HasTargetIdentitySummary() bool` + +HasTargetIdentitySummary returns a boolean if a field has been set. + +### SetTargetIdentitySummaryNil + +`func (o *AccountActivity) SetTargetIdentitySummaryNil(b bool)` + + SetTargetIdentitySummaryNil sets the value for TargetIdentitySummary to be an explicit nil + +### UnsetTargetIdentitySummary +`func (o *AccountActivity) UnsetTargetIdentitySummary()` + +UnsetTargetIdentitySummary ensures that no value is present for TargetIdentitySummary, not even an explicit nil +### GetErrors + +`func (o *AccountActivity) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountActivity) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountActivity) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *AccountActivity) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### SetErrorsNil + +`func (o *AccountActivity) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *AccountActivity) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *AccountActivity) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *AccountActivity) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *AccountActivity) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *AccountActivity) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + +### SetWarningsNil + +`func (o *AccountActivity) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *AccountActivity) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetItems + +`func (o *AccountActivity) GetItems() []AccountActivityItem` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *AccountActivity) GetItemsOk() (*[]AccountActivityItem, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *AccountActivity) SetItems(v []AccountActivityItem)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *AccountActivity) HasItems() bool` + +HasItems returns a boolean if a field has been set. + +### SetItemsNil + +`func (o *AccountActivity) SetItemsNil(b bool)` + + SetItemsNil sets the value for Items to be an explicit nil + +### UnsetItems +`func (o *AccountActivity) UnsetItems()` + +UnsetItems ensures that no value is present for Items, not even an explicit nil +### GetExecutionStatus + +`func (o *AccountActivity) GetExecutionStatus() ExecutionStatus` + +GetExecutionStatus returns the ExecutionStatus field if non-nil, zero value otherwise. + +### GetExecutionStatusOk + +`func (o *AccountActivity) GetExecutionStatusOk() (*ExecutionStatus, bool)` + +GetExecutionStatusOk returns a tuple with the ExecutionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExecutionStatus + +`func (o *AccountActivity) SetExecutionStatus(v ExecutionStatus)` + +SetExecutionStatus sets ExecutionStatus field to given value. + +### HasExecutionStatus + +`func (o *AccountActivity) HasExecutionStatus() bool` + +HasExecutionStatus returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *AccountActivity) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccountActivity) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccountActivity) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccountActivity) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *AccountActivity) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *AccountActivity) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountActivityApprovalStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountActivityApprovalStatus.md new file mode 100644 index 000000000..a70e130d7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountActivityApprovalStatus.md @@ -0,0 +1,29 @@ +--- +id: v2024-account-activity-approval-status +title: AccountActivityApprovalStatus +pagination_label: AccountActivityApprovalStatus +sidebar_label: AccountActivityApprovalStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivityApprovalStatus', 'V2024AccountActivityApprovalStatus'] +slug: /tools/sdk/go/v2024/models/account-activity-approval-status +tags: ['SDK', 'Software Development Kit', 'AccountActivityApprovalStatus', 'V2024AccountActivityApprovalStatus'] +--- + +# AccountActivityApprovalStatus + +## Enum + + +* `FINISHED` (value: `"FINISHED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `RETURNED` (value: `"RETURNED"`) + +* `EXPIRED` (value: `"EXPIRED"`) + +* `PENDING` (value: `"PENDING"`) + +* `CANCELED` (value: `"CANCELED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountActivityDocument.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountActivityDocument.md new file mode 100644 index 000000000..305d66673 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountActivityDocument.md @@ -0,0 +1,520 @@ +--- +id: v2024-account-activity-document +title: AccountActivityDocument +pagination_label: AccountActivityDocument +sidebar_label: AccountActivityDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivityDocument', 'V2024AccountActivityDocument'] +slug: /tools/sdk/go/v2024/models/account-activity-document +tags: ['SDK', 'Software Development Kit', 'AccountActivityDocument', 'V2024AccountActivityDocument'] +--- + +# AccountActivityDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of account activity. | [optional] +**Action** | Pointer to **string** | Type of action performed in the activity. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Stage** | Pointer to **string** | Activity's current stage. | [optional] +**Status** | Pointer to **string** | Activity's current status. | [optional] +**Requester** | Pointer to [**ActivityIdentity**](activity-identity) | | [optional] +**Recipient** | Pointer to [**ActivityIdentity**](activity-identity) | | [optional] +**TrackingNumber** | Pointer to **string** | Account activity's tracking number. | [optional] +**Errors** | Pointer to **[]string** | Errors provided by the source while completing account actions. | [optional] +**Warnings** | Pointer to **[]string** | Warnings provided by the source while completing account actions. | [optional] +**Approvals** | Pointer to [**[]Approval1**](approval1) | Approvals performed on an item during activity. | [optional] +**OriginalRequests** | Pointer to [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional] +**ExpansionItems** | Pointer to [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional] +**AccountRequests** | Pointer to [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional] +**Sources** | Pointer to **string** | Sources involved in the account activity. | [optional] + +## Methods + +### NewAccountActivityDocument + +`func NewAccountActivityDocument() *AccountActivityDocument` + +NewAccountActivityDocument instantiates a new AccountActivityDocument 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 + +### NewAccountActivityDocumentWithDefaults + +`func NewAccountActivityDocumentWithDefaults() *AccountActivityDocument` + +NewAccountActivityDocumentWithDefaults instantiates a new AccountActivityDocument 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 + +### GetId + +`func (o *AccountActivityDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountActivityDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountActivityDocument) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountActivityDocument) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAction + +`func (o *AccountActivityDocument) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *AccountActivityDocument) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *AccountActivityDocument) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *AccountActivityDocument) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetCreated + +`func (o *AccountActivityDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccountActivityDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccountActivityDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccountActivityDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *AccountActivityDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *AccountActivityDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *AccountActivityDocument) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccountActivityDocument) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccountActivityDocument) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccountActivityDocument) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *AccountActivityDocument) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *AccountActivityDocument) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *AccountActivityDocument) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *AccountActivityDocument) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *AccountActivityDocument) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *AccountActivityDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetStage + +`func (o *AccountActivityDocument) GetStage() string` + +GetStage returns the Stage field if non-nil, zero value otherwise. + +### GetStageOk + +`func (o *AccountActivityDocument) GetStageOk() (*string, bool)` + +GetStageOk returns a tuple with the Stage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStage + +`func (o *AccountActivityDocument) SetStage(v string)` + +SetStage sets Stage field to given value. + +### HasStage + +`func (o *AccountActivityDocument) HasStage() bool` + +HasStage returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccountActivityDocument) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountActivityDocument) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountActivityDocument) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccountActivityDocument) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetRequester + +`func (o *AccountActivityDocument) GetRequester() ActivityIdentity` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *AccountActivityDocument) GetRequesterOk() (*ActivityIdentity, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *AccountActivityDocument) SetRequester(v ActivityIdentity)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *AccountActivityDocument) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRecipient + +`func (o *AccountActivityDocument) GetRecipient() ActivityIdentity` + +GetRecipient returns the Recipient field if non-nil, zero value otherwise. + +### GetRecipientOk + +`func (o *AccountActivityDocument) GetRecipientOk() (*ActivityIdentity, bool)` + +GetRecipientOk returns a tuple with the Recipient field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipient + +`func (o *AccountActivityDocument) SetRecipient(v ActivityIdentity)` + +SetRecipient sets Recipient field to given value. + +### HasRecipient + +`func (o *AccountActivityDocument) HasRecipient() bool` + +HasRecipient returns a boolean if a field has been set. + +### GetTrackingNumber + +`func (o *AccountActivityDocument) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *AccountActivityDocument) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *AccountActivityDocument) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + +### HasTrackingNumber + +`func (o *AccountActivityDocument) HasTrackingNumber() bool` + +HasTrackingNumber returns a boolean if a field has been set. + +### GetErrors + +`func (o *AccountActivityDocument) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountActivityDocument) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountActivityDocument) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *AccountActivityDocument) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### SetErrorsNil + +`func (o *AccountActivityDocument) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *AccountActivityDocument) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *AccountActivityDocument) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *AccountActivityDocument) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *AccountActivityDocument) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *AccountActivityDocument) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + +### SetWarningsNil + +`func (o *AccountActivityDocument) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *AccountActivityDocument) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetApprovals + +`func (o *AccountActivityDocument) GetApprovals() []Approval1` + +GetApprovals returns the Approvals field if non-nil, zero value otherwise. + +### GetApprovalsOk + +`func (o *AccountActivityDocument) GetApprovalsOk() (*[]Approval1, bool)` + +GetApprovalsOk returns a tuple with the Approvals field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovals + +`func (o *AccountActivityDocument) SetApprovals(v []Approval1)` + +SetApprovals sets Approvals field to given value. + +### HasApprovals + +`func (o *AccountActivityDocument) HasApprovals() bool` + +HasApprovals returns a boolean if a field has been set. + +### GetOriginalRequests + +`func (o *AccountActivityDocument) GetOriginalRequests() []OriginalRequest` + +GetOriginalRequests returns the OriginalRequests field if non-nil, zero value otherwise. + +### GetOriginalRequestsOk + +`func (o *AccountActivityDocument) GetOriginalRequestsOk() (*[]OriginalRequest, bool)` + +GetOriginalRequestsOk returns a tuple with the OriginalRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalRequests + +`func (o *AccountActivityDocument) SetOriginalRequests(v []OriginalRequest)` + +SetOriginalRequests sets OriginalRequests field to given value. + +### HasOriginalRequests + +`func (o *AccountActivityDocument) HasOriginalRequests() bool` + +HasOriginalRequests returns a boolean if a field has been set. + +### GetExpansionItems + +`func (o *AccountActivityDocument) GetExpansionItems() []ExpansionItem` + +GetExpansionItems returns the ExpansionItems field if non-nil, zero value otherwise. + +### GetExpansionItemsOk + +`func (o *AccountActivityDocument) GetExpansionItemsOk() (*[]ExpansionItem, bool)` + +GetExpansionItemsOk returns a tuple with the ExpansionItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpansionItems + +`func (o *AccountActivityDocument) SetExpansionItems(v []ExpansionItem)` + +SetExpansionItems sets ExpansionItems field to given value. + +### HasExpansionItems + +`func (o *AccountActivityDocument) HasExpansionItems() bool` + +HasExpansionItems returns a boolean if a field has been set. + +### GetAccountRequests + +`func (o *AccountActivityDocument) GetAccountRequests() []AccountRequest` + +GetAccountRequests returns the AccountRequests field if non-nil, zero value otherwise. + +### GetAccountRequestsOk + +`func (o *AccountActivityDocument) GetAccountRequestsOk() (*[]AccountRequest, bool)` + +GetAccountRequestsOk returns a tuple with the AccountRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountRequests + +`func (o *AccountActivityDocument) SetAccountRequests(v []AccountRequest)` + +SetAccountRequests sets AccountRequests field to given value. + +### HasAccountRequests + +`func (o *AccountActivityDocument) HasAccountRequests() bool` + +HasAccountRequests returns a boolean if a field has been set. + +### GetSources + +`func (o *AccountActivityDocument) GetSources() string` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *AccountActivityDocument) GetSourcesOk() (*string, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *AccountActivityDocument) SetSources(v string)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *AccountActivityDocument) HasSources() bool` + +HasSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountActivityItem.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountActivityItem.md new file mode 100644 index 000000000..f45f95489 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountActivityItem.md @@ -0,0 +1,564 @@ +--- +id: v2024-account-activity-item +title: AccountActivityItem +pagination_label: AccountActivityItem +sidebar_label: AccountActivityItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivityItem', 'V2024AccountActivityItem'] +slug: /tools/sdk/go/v2024/models/account-activity-item +tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'V2024AccountActivityItem'] +--- + +# AccountActivityItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Item id | [optional] +**Name** | Pointer to **string** | Human-readable display name of item | [optional] +**Requested** | Pointer to **SailPointTime** | Date and time item was requested | [optional] +**ApprovalStatus** | Pointer to [**NullableAccountActivityApprovalStatus**](account-activity-approval-status) | | [optional] +**ProvisioningStatus** | Pointer to [**ProvisioningState**](provisioning-state) | | [optional] +**RequesterComment** | Pointer to [**NullableComment**](comment) | | [optional] +**ReviewerIdentitySummary** | Pointer to [**NullableIdentitySummary**](identity-summary) | | [optional] +**ReviewerComment** | Pointer to [**NullableComment**](comment) | | [optional] +**Operation** | Pointer to [**NullableAccountActivityItemOperation**](account-activity-item-operation) | | [optional] +**Attribute** | Pointer to **NullableString** | Attribute to which account activity applies | [optional] +**Value** | Pointer to **NullableString** | Value of attribute | [optional] +**NativeIdentity** | Pointer to **NullableString** | Native identity in the target system to which the account activity applies | [optional] +**SourceId** | Pointer to **string** | Id of Source to which account activity applies | [optional] +**AccountRequestInfo** | Pointer to [**NullableAccountRequestInfo**](account-request-info) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional] +**RemoveDate** | Pointer to **NullableTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] + +## Methods + +### NewAccountActivityItem + +`func NewAccountActivityItem() *AccountActivityItem` + +NewAccountActivityItem instantiates a new AccountActivityItem 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 + +### NewAccountActivityItemWithDefaults + +`func NewAccountActivityItemWithDefaults() *AccountActivityItem` + +NewAccountActivityItemWithDefaults instantiates a new AccountActivityItem 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 + +### GetId + +`func (o *AccountActivityItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountActivityItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountActivityItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountActivityItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccountActivityItem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountActivityItem) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountActivityItem) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountActivityItem) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetRequested + +`func (o *AccountActivityItem) GetRequested() SailPointTime` + +GetRequested returns the Requested field if non-nil, zero value otherwise. + +### GetRequestedOk + +`func (o *AccountActivityItem) GetRequestedOk() (*SailPointTime, bool)` + +GetRequestedOk returns a tuple with the Requested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequested + +`func (o *AccountActivityItem) SetRequested(v SailPointTime)` + +SetRequested sets Requested field to given value. + +### HasRequested + +`func (o *AccountActivityItem) HasRequested() bool` + +HasRequested returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *AccountActivityItem) GetApprovalStatus() AccountActivityApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *AccountActivityItem) GetApprovalStatusOk() (*AccountActivityApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *AccountActivityItem) SetApprovalStatus(v AccountActivityApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *AccountActivityItem) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### SetApprovalStatusNil + +`func (o *AccountActivityItem) SetApprovalStatusNil(b bool)` + + SetApprovalStatusNil sets the value for ApprovalStatus to be an explicit nil + +### UnsetApprovalStatus +`func (o *AccountActivityItem) UnsetApprovalStatus()` + +UnsetApprovalStatus ensures that no value is present for ApprovalStatus, not even an explicit nil +### GetProvisioningStatus + +`func (o *AccountActivityItem) GetProvisioningStatus() ProvisioningState` + +GetProvisioningStatus returns the ProvisioningStatus field if non-nil, zero value otherwise. + +### GetProvisioningStatusOk + +`func (o *AccountActivityItem) GetProvisioningStatusOk() (*ProvisioningState, bool)` + +GetProvisioningStatusOk returns a tuple with the ProvisioningStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningStatus + +`func (o *AccountActivityItem) SetProvisioningStatus(v ProvisioningState)` + +SetProvisioningStatus sets ProvisioningStatus field to given value. + +### HasProvisioningStatus + +`func (o *AccountActivityItem) HasProvisioningStatus() bool` + +HasProvisioningStatus returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *AccountActivityItem) GetRequesterComment() Comment` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *AccountActivityItem) GetRequesterCommentOk() (*Comment, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *AccountActivityItem) SetRequesterComment(v Comment)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *AccountActivityItem) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### SetRequesterCommentNil + +`func (o *AccountActivityItem) SetRequesterCommentNil(b bool)` + + SetRequesterCommentNil sets the value for RequesterComment to be an explicit nil + +### UnsetRequesterComment +`func (o *AccountActivityItem) UnsetRequesterComment()` + +UnsetRequesterComment ensures that no value is present for RequesterComment, not even an explicit nil +### GetReviewerIdentitySummary + +`func (o *AccountActivityItem) GetReviewerIdentitySummary() IdentitySummary` + +GetReviewerIdentitySummary returns the ReviewerIdentitySummary field if non-nil, zero value otherwise. + +### GetReviewerIdentitySummaryOk + +`func (o *AccountActivityItem) GetReviewerIdentitySummaryOk() (*IdentitySummary, bool)` + +GetReviewerIdentitySummaryOk returns a tuple with the ReviewerIdentitySummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerIdentitySummary + +`func (o *AccountActivityItem) SetReviewerIdentitySummary(v IdentitySummary)` + +SetReviewerIdentitySummary sets ReviewerIdentitySummary field to given value. + +### HasReviewerIdentitySummary + +`func (o *AccountActivityItem) HasReviewerIdentitySummary() bool` + +HasReviewerIdentitySummary returns a boolean if a field has been set. + +### SetReviewerIdentitySummaryNil + +`func (o *AccountActivityItem) SetReviewerIdentitySummaryNil(b bool)` + + SetReviewerIdentitySummaryNil sets the value for ReviewerIdentitySummary to be an explicit nil + +### UnsetReviewerIdentitySummary +`func (o *AccountActivityItem) UnsetReviewerIdentitySummary()` + +UnsetReviewerIdentitySummary ensures that no value is present for ReviewerIdentitySummary, not even an explicit nil +### GetReviewerComment + +`func (o *AccountActivityItem) GetReviewerComment() Comment` + +GetReviewerComment returns the ReviewerComment field if non-nil, zero value otherwise. + +### GetReviewerCommentOk + +`func (o *AccountActivityItem) GetReviewerCommentOk() (*Comment, bool)` + +GetReviewerCommentOk returns a tuple with the ReviewerComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerComment + +`func (o *AccountActivityItem) SetReviewerComment(v Comment)` + +SetReviewerComment sets ReviewerComment field to given value. + +### HasReviewerComment + +`func (o *AccountActivityItem) HasReviewerComment() bool` + +HasReviewerComment returns a boolean if a field has been set. + +### SetReviewerCommentNil + +`func (o *AccountActivityItem) SetReviewerCommentNil(b bool)` + + SetReviewerCommentNil sets the value for ReviewerComment to be an explicit nil + +### UnsetReviewerComment +`func (o *AccountActivityItem) UnsetReviewerComment()` + +UnsetReviewerComment ensures that no value is present for ReviewerComment, not even an explicit nil +### GetOperation + +`func (o *AccountActivityItem) GetOperation() AccountActivityItemOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *AccountActivityItem) GetOperationOk() (*AccountActivityItemOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *AccountActivityItem) SetOperation(v AccountActivityItemOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *AccountActivityItem) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### SetOperationNil + +`func (o *AccountActivityItem) SetOperationNil(b bool)` + + SetOperationNil sets the value for Operation to be an explicit nil + +### UnsetOperation +`func (o *AccountActivityItem) UnsetOperation()` + +UnsetOperation ensures that no value is present for Operation, not even an explicit nil +### GetAttribute + +`func (o *AccountActivityItem) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *AccountActivityItem) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *AccountActivityItem) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *AccountActivityItem) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *AccountActivityItem) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *AccountActivityItem) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *AccountActivityItem) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AccountActivityItem) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AccountActivityItem) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AccountActivityItem) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *AccountActivityItem) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *AccountActivityItem) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetNativeIdentity + +`func (o *AccountActivityItem) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountActivityItem) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountActivityItem) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccountActivityItem) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### SetNativeIdentityNil + +`func (o *AccountActivityItem) SetNativeIdentityNil(b bool)` + + SetNativeIdentityNil sets the value for NativeIdentity to be an explicit nil + +### UnsetNativeIdentity +`func (o *AccountActivityItem) UnsetNativeIdentity()` + +UnsetNativeIdentity ensures that no value is present for NativeIdentity, not even an explicit nil +### GetSourceId + +`func (o *AccountActivityItem) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccountActivityItem) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccountActivityItem) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccountActivityItem) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetAccountRequestInfo + +`func (o *AccountActivityItem) GetAccountRequestInfo() AccountRequestInfo` + +GetAccountRequestInfo returns the AccountRequestInfo field if non-nil, zero value otherwise. + +### GetAccountRequestInfoOk + +`func (o *AccountActivityItem) GetAccountRequestInfoOk() (*AccountRequestInfo, bool)` + +GetAccountRequestInfoOk returns a tuple with the AccountRequestInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountRequestInfo + +`func (o *AccountActivityItem) SetAccountRequestInfo(v AccountRequestInfo)` + +SetAccountRequestInfo sets AccountRequestInfo field to given value. + +### HasAccountRequestInfo + +`func (o *AccountActivityItem) HasAccountRequestInfo() bool` + +HasAccountRequestInfo returns a boolean if a field has been set. + +### SetAccountRequestInfoNil + +`func (o *AccountActivityItem) SetAccountRequestInfoNil(b bool)` + + SetAccountRequestInfoNil sets the value for AccountRequestInfo to be an explicit nil + +### UnsetAccountRequestInfo +`func (o *AccountActivityItem) UnsetAccountRequestInfo()` + +UnsetAccountRequestInfo ensures that no value is present for AccountRequestInfo, not even an explicit nil +### GetClientMetadata + +`func (o *AccountActivityItem) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccountActivityItem) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccountActivityItem) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccountActivityItem) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *AccountActivityItem) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *AccountActivityItem) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetRemoveDate + +`func (o *AccountActivityItem) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccountActivityItem) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccountActivityItem) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccountActivityItem) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *AccountActivityItem) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *AccountActivityItem) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountActivityItemOperation.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountActivityItemOperation.md new file mode 100644 index 000000000..52019e23e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountActivityItemOperation.md @@ -0,0 +1,37 @@ +--- +id: v2024-account-activity-item-operation +title: AccountActivityItemOperation +pagination_label: AccountActivityItemOperation +sidebar_label: AccountActivityItemOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivityItemOperation', 'V2024AccountActivityItemOperation'] +slug: /tools/sdk/go/v2024/models/account-activity-item-operation +tags: ['SDK', 'Software Development Kit', 'AccountActivityItemOperation', 'V2024AccountActivityItemOperation'] +--- + +# AccountActivityItemOperation + +## Enum + + +* `ADD` (value: `"ADD"`) + +* `CREATE` (value: `"CREATE"`) + +* `MODIFY` (value: `"MODIFY"`) + +* `DELETE` (value: `"DELETE"`) + +* `DISABLE` (value: `"DISABLE"`) + +* `ENABLE` (value: `"ENABLE"`) + +* `UNLOCK` (value: `"UNLOCK"`) + +* `LOCK` (value: `"LOCK"`) + +* `REMOVE` (value: `"REMOVE"`) + +* `SET` (value: `"SET"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountActivitySearchedItem.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountActivitySearchedItem.md new file mode 100644 index 000000000..83f6ac76e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountActivitySearchedItem.md @@ -0,0 +1,520 @@ +--- +id: v2024-account-activity-searched-item +title: AccountActivitySearchedItem +pagination_label: AccountActivitySearchedItem +sidebar_label: AccountActivitySearchedItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivitySearchedItem', 'V2024AccountActivitySearchedItem'] +slug: /tools/sdk/go/v2024/models/account-activity-searched-item +tags: ['SDK', 'Software Development Kit', 'AccountActivitySearchedItem', 'V2024AccountActivitySearchedItem'] +--- + +# AccountActivitySearchedItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of account activity. | [optional] +**Action** | Pointer to **string** | Type of action performed in the activity. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Stage** | Pointer to **string** | Activity's current stage. | [optional] +**Status** | Pointer to **string** | Activity's current status. | [optional] +**Requester** | Pointer to [**ActivityIdentity**](activity-identity) | | [optional] +**Recipient** | Pointer to [**ActivityIdentity**](activity-identity) | | [optional] +**TrackingNumber** | Pointer to **string** | Account activity's tracking number. | [optional] +**Errors** | Pointer to **[]string** | Errors provided by the source while completing account actions. | [optional] +**Warnings** | Pointer to **[]string** | Warnings provided by the source while completing account actions. | [optional] +**Approvals** | Pointer to [**[]Approval1**](approval1) | Approvals performed on an item during activity. | [optional] +**OriginalRequests** | Pointer to [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional] +**ExpansionItems** | Pointer to [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional] +**AccountRequests** | Pointer to [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional] +**Sources** | Pointer to **string** | Sources involved in the account activity. | [optional] + +## Methods + +### NewAccountActivitySearchedItem + +`func NewAccountActivitySearchedItem() *AccountActivitySearchedItem` + +NewAccountActivitySearchedItem instantiates a new AccountActivitySearchedItem 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 + +### NewAccountActivitySearchedItemWithDefaults + +`func NewAccountActivitySearchedItemWithDefaults() *AccountActivitySearchedItem` + +NewAccountActivitySearchedItemWithDefaults instantiates a new AccountActivitySearchedItem 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 + +### GetId + +`func (o *AccountActivitySearchedItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountActivitySearchedItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountActivitySearchedItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountActivitySearchedItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAction + +`func (o *AccountActivitySearchedItem) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *AccountActivitySearchedItem) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *AccountActivitySearchedItem) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *AccountActivitySearchedItem) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetCreated + +`func (o *AccountActivitySearchedItem) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccountActivitySearchedItem) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccountActivitySearchedItem) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccountActivitySearchedItem) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *AccountActivitySearchedItem) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *AccountActivitySearchedItem) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *AccountActivitySearchedItem) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccountActivitySearchedItem) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccountActivitySearchedItem) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccountActivitySearchedItem) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *AccountActivitySearchedItem) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *AccountActivitySearchedItem) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *AccountActivitySearchedItem) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *AccountActivitySearchedItem) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *AccountActivitySearchedItem) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *AccountActivitySearchedItem) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetStage + +`func (o *AccountActivitySearchedItem) GetStage() string` + +GetStage returns the Stage field if non-nil, zero value otherwise. + +### GetStageOk + +`func (o *AccountActivitySearchedItem) GetStageOk() (*string, bool)` + +GetStageOk returns a tuple with the Stage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStage + +`func (o *AccountActivitySearchedItem) SetStage(v string)` + +SetStage sets Stage field to given value. + +### HasStage + +`func (o *AccountActivitySearchedItem) HasStage() bool` + +HasStage returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccountActivitySearchedItem) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountActivitySearchedItem) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountActivitySearchedItem) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccountActivitySearchedItem) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetRequester + +`func (o *AccountActivitySearchedItem) GetRequester() ActivityIdentity` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *AccountActivitySearchedItem) GetRequesterOk() (*ActivityIdentity, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *AccountActivitySearchedItem) SetRequester(v ActivityIdentity)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *AccountActivitySearchedItem) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRecipient + +`func (o *AccountActivitySearchedItem) GetRecipient() ActivityIdentity` + +GetRecipient returns the Recipient field if non-nil, zero value otherwise. + +### GetRecipientOk + +`func (o *AccountActivitySearchedItem) GetRecipientOk() (*ActivityIdentity, bool)` + +GetRecipientOk returns a tuple with the Recipient field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipient + +`func (o *AccountActivitySearchedItem) SetRecipient(v ActivityIdentity)` + +SetRecipient sets Recipient field to given value. + +### HasRecipient + +`func (o *AccountActivitySearchedItem) HasRecipient() bool` + +HasRecipient returns a boolean if a field has been set. + +### GetTrackingNumber + +`func (o *AccountActivitySearchedItem) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *AccountActivitySearchedItem) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *AccountActivitySearchedItem) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + +### HasTrackingNumber + +`func (o *AccountActivitySearchedItem) HasTrackingNumber() bool` + +HasTrackingNumber returns a boolean if a field has been set. + +### GetErrors + +`func (o *AccountActivitySearchedItem) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountActivitySearchedItem) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountActivitySearchedItem) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *AccountActivitySearchedItem) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### SetErrorsNil + +`func (o *AccountActivitySearchedItem) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *AccountActivitySearchedItem) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *AccountActivitySearchedItem) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *AccountActivitySearchedItem) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *AccountActivitySearchedItem) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *AccountActivitySearchedItem) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + +### SetWarningsNil + +`func (o *AccountActivitySearchedItem) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *AccountActivitySearchedItem) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetApprovals + +`func (o *AccountActivitySearchedItem) GetApprovals() []Approval1` + +GetApprovals returns the Approvals field if non-nil, zero value otherwise. + +### GetApprovalsOk + +`func (o *AccountActivitySearchedItem) GetApprovalsOk() (*[]Approval1, bool)` + +GetApprovalsOk returns a tuple with the Approvals field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovals + +`func (o *AccountActivitySearchedItem) SetApprovals(v []Approval1)` + +SetApprovals sets Approvals field to given value. + +### HasApprovals + +`func (o *AccountActivitySearchedItem) HasApprovals() bool` + +HasApprovals returns a boolean if a field has been set. + +### GetOriginalRequests + +`func (o *AccountActivitySearchedItem) GetOriginalRequests() []OriginalRequest` + +GetOriginalRequests returns the OriginalRequests field if non-nil, zero value otherwise. + +### GetOriginalRequestsOk + +`func (o *AccountActivitySearchedItem) GetOriginalRequestsOk() (*[]OriginalRequest, bool)` + +GetOriginalRequestsOk returns a tuple with the OriginalRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalRequests + +`func (o *AccountActivitySearchedItem) SetOriginalRequests(v []OriginalRequest)` + +SetOriginalRequests sets OriginalRequests field to given value. + +### HasOriginalRequests + +`func (o *AccountActivitySearchedItem) HasOriginalRequests() bool` + +HasOriginalRequests returns a boolean if a field has been set. + +### GetExpansionItems + +`func (o *AccountActivitySearchedItem) GetExpansionItems() []ExpansionItem` + +GetExpansionItems returns the ExpansionItems field if non-nil, zero value otherwise. + +### GetExpansionItemsOk + +`func (o *AccountActivitySearchedItem) GetExpansionItemsOk() (*[]ExpansionItem, bool)` + +GetExpansionItemsOk returns a tuple with the ExpansionItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpansionItems + +`func (o *AccountActivitySearchedItem) SetExpansionItems(v []ExpansionItem)` + +SetExpansionItems sets ExpansionItems field to given value. + +### HasExpansionItems + +`func (o *AccountActivitySearchedItem) HasExpansionItems() bool` + +HasExpansionItems returns a boolean if a field has been set. + +### GetAccountRequests + +`func (o *AccountActivitySearchedItem) GetAccountRequests() []AccountRequest` + +GetAccountRequests returns the AccountRequests field if non-nil, zero value otherwise. + +### GetAccountRequestsOk + +`func (o *AccountActivitySearchedItem) GetAccountRequestsOk() (*[]AccountRequest, bool)` + +GetAccountRequestsOk returns a tuple with the AccountRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountRequests + +`func (o *AccountActivitySearchedItem) SetAccountRequests(v []AccountRequest)` + +SetAccountRequests sets AccountRequests field to given value. + +### HasAccountRequests + +`func (o *AccountActivitySearchedItem) HasAccountRequests() bool` + +HasAccountRequests returns a boolean if a field has been set. + +### GetSources + +`func (o *AccountActivitySearchedItem) GetSources() string` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *AccountActivitySearchedItem) GetSourcesOk() (*string, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *AccountActivitySearchedItem) SetSources(v string)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *AccountActivitySearchedItem) HasSources() bool` + +HasSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAggregationCompleted.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAggregationCompleted.md new file mode 100644 index 000000000..af8a41fa8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAggregationCompleted.md @@ -0,0 +1,205 @@ +--- +id: v2024-account-aggregation-completed +title: AccountAggregationCompleted +pagination_label: AccountAggregationCompleted +sidebar_label: AccountAggregationCompleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAggregationCompleted', 'V2024AccountAggregationCompleted'] +slug: /tools/sdk/go/v2024/models/account-aggregation-completed +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompleted', 'V2024AccountAggregationCompleted'] +--- + +# AccountAggregationCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**AccountAggregationCompletedSource**](account-aggregation-completed-source) | | +**Status** | **map[string]interface{}** | The overall status of the aggregation. | +**Started** | **SailPointTime** | The date and time when the account aggregation started. | +**Completed** | **SailPointTime** | The date and time when the account aggregation finished. | +**Errors** | **[]string** | A list of errors that occurred during the aggregation. | +**Warnings** | **[]string** | A list of warnings that occurred during the aggregation. | +**Stats** | [**AccountAggregationCompletedStats**](account-aggregation-completed-stats) | | + +## Methods + +### NewAccountAggregationCompleted + +`func NewAccountAggregationCompleted(source AccountAggregationCompletedSource, status map[string]interface{}, started SailPointTime, completed SailPointTime, errors []string, warnings []string, stats AccountAggregationCompletedStats, ) *AccountAggregationCompleted` + +NewAccountAggregationCompleted instantiates a new AccountAggregationCompleted 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 + +### NewAccountAggregationCompletedWithDefaults + +`func NewAccountAggregationCompletedWithDefaults() *AccountAggregationCompleted` + +NewAccountAggregationCompletedWithDefaults instantiates a new AccountAggregationCompleted 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 + +### GetSource + +`func (o *AccountAggregationCompleted) GetSource() AccountAggregationCompletedSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountAggregationCompleted) GetSourceOk() (*AccountAggregationCompletedSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountAggregationCompleted) SetSource(v AccountAggregationCompletedSource)` + +SetSource sets Source field to given value. + + +### GetStatus + +`func (o *AccountAggregationCompleted) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountAggregationCompleted) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountAggregationCompleted) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + +### GetStarted + +`func (o *AccountAggregationCompleted) GetStarted() SailPointTime` + +GetStarted returns the Started field if non-nil, zero value otherwise. + +### GetStartedOk + +`func (o *AccountAggregationCompleted) GetStartedOk() (*SailPointTime, bool)` + +GetStartedOk returns a tuple with the Started field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStarted + +`func (o *AccountAggregationCompleted) SetStarted(v SailPointTime)` + +SetStarted sets Started field to given value. + + +### GetCompleted + +`func (o *AccountAggregationCompleted) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *AccountAggregationCompleted) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *AccountAggregationCompleted) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + + +### GetErrors + +`func (o *AccountAggregationCompleted) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountAggregationCompleted) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountAggregationCompleted) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + + +### SetErrorsNil + +`func (o *AccountAggregationCompleted) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *AccountAggregationCompleted) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *AccountAggregationCompleted) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *AccountAggregationCompleted) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *AccountAggregationCompleted) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + + +### SetWarningsNil + +`func (o *AccountAggregationCompleted) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *AccountAggregationCompleted) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetStats + +`func (o *AccountAggregationCompleted) GetStats() AccountAggregationCompletedStats` + +GetStats returns the Stats field if non-nil, zero value otherwise. + +### GetStatsOk + +`func (o *AccountAggregationCompleted) GetStatsOk() (*AccountAggregationCompletedStats, bool)` + +GetStatsOk returns a tuple with the Stats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStats + +`func (o *AccountAggregationCompleted) SetStats(v AccountAggregationCompletedStats)` + +SetStats sets Stats field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAggregationCompletedSource.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAggregationCompletedSource.md new file mode 100644 index 000000000..a5c9f8bc4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAggregationCompletedSource.md @@ -0,0 +1,101 @@ +--- +id: v2024-account-aggregation-completed-source +title: AccountAggregationCompletedSource +pagination_label: AccountAggregationCompletedSource +sidebar_label: AccountAggregationCompletedSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAggregationCompletedSource', 'V2024AccountAggregationCompletedSource'] +slug: /tools/sdk/go/v2024/models/account-aggregation-completed-source +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedSource', 'V2024AccountAggregationCompletedSource'] +--- + +# AccountAggregationCompletedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The DTO type of the source the accounts are being aggregated from. | +**Id** | **string** | The ID of the source the accounts are being aggregated from. | +**Name** | **string** | Display name of the source the accounts are being aggregated from. | + +## Methods + +### NewAccountAggregationCompletedSource + +`func NewAccountAggregationCompletedSource(type_ string, id string, name string, ) *AccountAggregationCompletedSource` + +NewAccountAggregationCompletedSource instantiates a new AccountAggregationCompletedSource 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 + +### NewAccountAggregationCompletedSourceWithDefaults + +`func NewAccountAggregationCompletedSourceWithDefaults() *AccountAggregationCompletedSource` + +NewAccountAggregationCompletedSourceWithDefaults instantiates a new AccountAggregationCompletedSource 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 + +### GetType + +`func (o *AccountAggregationCompletedSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAggregationCompletedSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAggregationCompletedSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountAggregationCompletedSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAggregationCompletedSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAggregationCompletedSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountAggregationCompletedSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAggregationCompletedSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAggregationCompletedSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAggregationCompletedStats.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAggregationCompletedStats.md new file mode 100644 index 000000000..46dd79672 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAggregationCompletedStats.md @@ -0,0 +1,143 @@ +--- +id: v2024-account-aggregation-completed-stats +title: AccountAggregationCompletedStats +pagination_label: AccountAggregationCompletedStats +sidebar_label: AccountAggregationCompletedStats +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAggregationCompletedStats', 'V2024AccountAggregationCompletedStats'] +slug: /tools/sdk/go/v2024/models/account-aggregation-completed-stats +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedStats', 'V2024AccountAggregationCompletedStats'] +--- + +# AccountAggregationCompletedStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scanned** | **int32** | The number of accounts which were scanned / iterated over. | +**Unchanged** | **int32** | The number of accounts which existed before, but had no changes. | +**Changed** | **int32** | The number of accounts which existed before, but had changes. | +**Added** | **int32** | The number of accounts which are new - have not existed before. | +**Removed** | **int32** | The number accounts which existed before, but no longer exist (thus getting removed). | + +## Methods + +### NewAccountAggregationCompletedStats + +`func NewAccountAggregationCompletedStats(scanned int32, unchanged int32, changed int32, added int32, removed int32, ) *AccountAggregationCompletedStats` + +NewAccountAggregationCompletedStats instantiates a new AccountAggregationCompletedStats 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 + +### NewAccountAggregationCompletedStatsWithDefaults + +`func NewAccountAggregationCompletedStatsWithDefaults() *AccountAggregationCompletedStats` + +NewAccountAggregationCompletedStatsWithDefaults instantiates a new AccountAggregationCompletedStats 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 + +### GetScanned + +`func (o *AccountAggregationCompletedStats) GetScanned() int32` + +GetScanned returns the Scanned field if non-nil, zero value otherwise. + +### GetScannedOk + +`func (o *AccountAggregationCompletedStats) GetScannedOk() (*int32, bool)` + +GetScannedOk returns a tuple with the Scanned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScanned + +`func (o *AccountAggregationCompletedStats) SetScanned(v int32)` + +SetScanned sets Scanned field to given value. + + +### GetUnchanged + +`func (o *AccountAggregationCompletedStats) GetUnchanged() int32` + +GetUnchanged returns the Unchanged field if non-nil, zero value otherwise. + +### GetUnchangedOk + +`func (o *AccountAggregationCompletedStats) GetUnchangedOk() (*int32, bool)` + +GetUnchangedOk returns a tuple with the Unchanged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnchanged + +`func (o *AccountAggregationCompletedStats) SetUnchanged(v int32)` + +SetUnchanged sets Unchanged field to given value. + + +### GetChanged + +`func (o *AccountAggregationCompletedStats) GetChanged() int32` + +GetChanged returns the Changed field if non-nil, zero value otherwise. + +### GetChangedOk + +`func (o *AccountAggregationCompletedStats) GetChangedOk() (*int32, bool)` + +GetChangedOk returns a tuple with the Changed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanged + +`func (o *AccountAggregationCompletedStats) SetChanged(v int32)` + +SetChanged sets Changed field to given value. + + +### GetAdded + +`func (o *AccountAggregationCompletedStats) GetAdded() int32` + +GetAdded returns the Added field if non-nil, zero value otherwise. + +### GetAddedOk + +`func (o *AccountAggregationCompletedStats) GetAddedOk() (*int32, bool)` + +GetAddedOk returns a tuple with the Added field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAdded + +`func (o *AccountAggregationCompletedStats) SetAdded(v int32)` + +SetAdded sets Added field to given value. + + +### GetRemoved + +`func (o *AccountAggregationCompletedStats) GetRemoved() int32` + +GetRemoved returns the Removed field if non-nil, zero value otherwise. + +### GetRemovedOk + +`func (o *AccountAggregationCompletedStats) GetRemovedOk() (*int32, bool)` + +GetRemovedOk returns a tuple with the Removed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoved + +`func (o *AccountAggregationCompletedStats) SetRemoved(v int32)` + +SetRemoved sets Removed field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAggregationStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAggregationStatus.md new file mode 100644 index 000000000..5d286cf6d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAggregationStatus.md @@ -0,0 +1,152 @@ +--- +id: v2024-account-aggregation-status +title: AccountAggregationStatus +pagination_label: AccountAggregationStatus +sidebar_label: AccountAggregationStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAggregationStatus', 'V2024AccountAggregationStatus'] +slug: /tools/sdk/go/v2024/models/account-aggregation-status +tags: ['SDK', 'Software Development Kit', 'AccountAggregationStatus', 'V2024AccountAggregationStatus'] +--- + +# AccountAggregationStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **NullableTime** | When the aggregation started. | [optional] +**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] + +## Methods + +### NewAccountAggregationStatus + +`func NewAccountAggregationStatus() *AccountAggregationStatus` + +NewAccountAggregationStatus instantiates a new AccountAggregationStatus 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 + +### NewAccountAggregationStatusWithDefaults + +`func NewAccountAggregationStatusWithDefaults() *AccountAggregationStatus` + +NewAccountAggregationStatusWithDefaults instantiates a new AccountAggregationStatus 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 + +### GetStart + +`func (o *AccountAggregationStatus) GetStart() SailPointTime` + +GetStart returns the Start field if non-nil, zero value otherwise. + +### GetStartOk + +`func (o *AccountAggregationStatus) GetStartOk() (*SailPointTime, bool)` + +GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStart + +`func (o *AccountAggregationStatus) SetStart(v SailPointTime)` + +SetStart sets Start field to given value. + +### HasStart + +`func (o *AccountAggregationStatus) HasStart() bool` + +HasStart returns a boolean if a field has been set. + +### SetStartNil + +`func (o *AccountAggregationStatus) SetStartNil(b bool)` + + SetStartNil sets the value for Start to be an explicit nil + +### UnsetStart +`func (o *AccountAggregationStatus) UnsetStart()` + +UnsetStart ensures that no value is present for Start, not even an explicit nil +### GetStatus + +`func (o *AccountAggregationStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountAggregationStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountAggregationStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccountAggregationStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetTotalAccounts + +`func (o *AccountAggregationStatus) GetTotalAccounts() int32` + +GetTotalAccounts returns the TotalAccounts field if non-nil, zero value otherwise. + +### GetTotalAccountsOk + +`func (o *AccountAggregationStatus) GetTotalAccountsOk() (*int32, bool)` + +GetTotalAccountsOk returns a tuple with the TotalAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalAccounts + +`func (o *AccountAggregationStatus) SetTotalAccounts(v int32)` + +SetTotalAccounts sets TotalAccounts field to given value. + +### HasTotalAccounts + +`func (o *AccountAggregationStatus) HasTotalAccounts() bool` + +HasTotalAccounts returns a boolean if a field has been set. + +### GetProcessedAccounts + +`func (o *AccountAggregationStatus) GetProcessedAccounts() int32` + +GetProcessedAccounts returns the ProcessedAccounts field if non-nil, zero value otherwise. + +### GetProcessedAccountsOk + +`func (o *AccountAggregationStatus) GetProcessedAccountsOk() (*int32, bool)` + +GetProcessedAccountsOk returns a tuple with the ProcessedAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessedAccounts + +`func (o *AccountAggregationStatus) SetProcessedAccounts(v int32)` + +SetProcessedAccounts sets ProcessedAccounts field to given value. + +### HasProcessedAccounts + +`func (o *AccountAggregationStatus) HasProcessedAccounts() bool` + +HasProcessedAccounts returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAllOfIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAllOfIdentity.md new file mode 100644 index 000000000..309720521 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAllOfIdentity.md @@ -0,0 +1,116 @@ +--- +id: v2024-account-all-of-identity +title: AccountAllOfIdentity +pagination_label: AccountAllOfIdentity +sidebar_label: AccountAllOfIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAllOfIdentity', 'V2024AccountAllOfIdentity'] +slug: /tools/sdk/go/v2024/models/account-all-of-identity +tags: ['SDK', 'Software Development Kit', 'AccountAllOfIdentity', 'V2024AccountAllOfIdentity'] +--- + +# AccountAllOfIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the identity | [optional] +**Type** | Pointer to **string** | The type of object being referenced | [optional] +**Name** | Pointer to **string** | display name of identity | [optional] + +## Methods + +### NewAccountAllOfIdentity + +`func NewAccountAllOfIdentity() *AccountAllOfIdentity` + +NewAccountAllOfIdentity instantiates a new AccountAllOfIdentity 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 + +### NewAccountAllOfIdentityWithDefaults + +`func NewAccountAllOfIdentityWithDefaults() *AccountAllOfIdentity` + +NewAccountAllOfIdentityWithDefaults instantiates a new AccountAllOfIdentity 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 + +### GetId + +`func (o *AccountAllOfIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAllOfIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAllOfIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountAllOfIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccountAllOfIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAllOfIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAllOfIdentity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountAllOfIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccountAllOfIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAllOfIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAllOfIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountAllOfIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAllOfOwnerIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAllOfOwnerIdentity.md new file mode 100644 index 000000000..4263ae6b8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAllOfOwnerIdentity.md @@ -0,0 +1,116 @@ +--- +id: v2024-account-all-of-owner-identity +title: AccountAllOfOwnerIdentity +pagination_label: AccountAllOfOwnerIdentity +sidebar_label: AccountAllOfOwnerIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAllOfOwnerIdentity', 'V2024AccountAllOfOwnerIdentity'] +slug: /tools/sdk/go/v2024/models/account-all-of-owner-identity +tags: ['SDK', 'Software Development Kit', 'AccountAllOfOwnerIdentity', 'V2024AccountAllOfOwnerIdentity'] +--- + +# AccountAllOfOwnerIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewAccountAllOfOwnerIdentity + +`func NewAccountAllOfOwnerIdentity() *AccountAllOfOwnerIdentity` + +NewAccountAllOfOwnerIdentity instantiates a new AccountAllOfOwnerIdentity 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 + +### NewAccountAllOfOwnerIdentityWithDefaults + +`func NewAccountAllOfOwnerIdentityWithDefaults() *AccountAllOfOwnerIdentity` + +NewAccountAllOfOwnerIdentityWithDefaults instantiates a new AccountAllOfOwnerIdentity 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 + +### GetType + +`func (o *AccountAllOfOwnerIdentity) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAllOfOwnerIdentity) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAllOfOwnerIdentity) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountAllOfOwnerIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccountAllOfOwnerIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAllOfOwnerIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAllOfOwnerIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountAllOfOwnerIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccountAllOfOwnerIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAllOfOwnerIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAllOfOwnerIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountAllOfOwnerIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAllOfRecommendation.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAllOfRecommendation.md new file mode 100644 index 000000000..050a40923 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAllOfRecommendation.md @@ -0,0 +1,80 @@ +--- +id: v2024-account-all-of-recommendation +title: AccountAllOfRecommendation +pagination_label: AccountAllOfRecommendation +sidebar_label: AccountAllOfRecommendation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAllOfRecommendation', 'V2024AccountAllOfRecommendation'] +slug: /tools/sdk/go/v2024/models/account-all-of-recommendation +tags: ['SDK', 'Software Development Kit', 'AccountAllOfRecommendation', 'V2024AccountAllOfRecommendation'] +--- + +# AccountAllOfRecommendation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Recommended type of account. | +**Method** | **string** | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | + +## Methods + +### NewAccountAllOfRecommendation + +`func NewAccountAllOfRecommendation(type_ string, method string, ) *AccountAllOfRecommendation` + +NewAccountAllOfRecommendation instantiates a new AccountAllOfRecommendation 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 + +### NewAccountAllOfRecommendationWithDefaults + +`func NewAccountAllOfRecommendationWithDefaults() *AccountAllOfRecommendation` + +NewAccountAllOfRecommendationWithDefaults instantiates a new AccountAllOfRecommendation 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 + +### GetType + +`func (o *AccountAllOfRecommendation) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAllOfRecommendation) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAllOfRecommendation) SetType(v string)` + +SetType sets Type field to given value. + + +### GetMethod + +`func (o *AccountAllOfRecommendation) GetMethod() string` + +GetMethod returns the Method field if non-nil, zero value otherwise. + +### GetMethodOk + +`func (o *AccountAllOfRecommendation) GetMethodOk() (*string, bool)` + +GetMethodOk returns a tuple with the Method field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMethod + +`func (o *AccountAllOfRecommendation) SetMethod(v string)` + +SetMethod sets Method field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAllOfSourceOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAllOfSourceOwner.md new file mode 100644 index 000000000..dcdb26879 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAllOfSourceOwner.md @@ -0,0 +1,116 @@ +--- +id: v2024-account-all-of-source-owner +title: AccountAllOfSourceOwner +pagination_label: AccountAllOfSourceOwner +sidebar_label: AccountAllOfSourceOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAllOfSourceOwner', 'V2024AccountAllOfSourceOwner'] +slug: /tools/sdk/go/v2024/models/account-all-of-source-owner +tags: ['SDK', 'Software Development Kit', 'AccountAllOfSourceOwner', 'V2024AccountAllOfSourceOwner'] +--- + +# AccountAllOfSourceOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the identity | [optional] +**Type** | Pointer to **string** | The type of object being referenced | [optional] +**Name** | Pointer to **string** | display name of identity | [optional] + +## Methods + +### NewAccountAllOfSourceOwner + +`func NewAccountAllOfSourceOwner() *AccountAllOfSourceOwner` + +NewAccountAllOfSourceOwner instantiates a new AccountAllOfSourceOwner 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 + +### NewAccountAllOfSourceOwnerWithDefaults + +`func NewAccountAllOfSourceOwnerWithDefaults() *AccountAllOfSourceOwner` + +NewAccountAllOfSourceOwnerWithDefaults instantiates a new AccountAllOfSourceOwner 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 + +### GetId + +`func (o *AccountAllOfSourceOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAllOfSourceOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAllOfSourceOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountAllOfSourceOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccountAllOfSourceOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAllOfSourceOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAllOfSourceOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountAllOfSourceOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccountAllOfSourceOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAllOfSourceOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAllOfSourceOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountAllOfSourceOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributes.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributes.md new file mode 100644 index 000000000..055140a33 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributes.md @@ -0,0 +1,59 @@ +--- +id: v2024-account-attributes +title: AccountAttributes +pagination_label: AccountAttributes +sidebar_label: AccountAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributes', 'V2024AccountAttributes'] +slug: /tools/sdk/go/v2024/models/account-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributes', 'V2024AccountAttributes'] +--- + +# AccountAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | **map[string]interface{}** | The schema attribute values for the account | + +## Methods + +### NewAccountAttributes + +`func NewAccountAttributes(attributes map[string]interface{}, ) *AccountAttributes` + +NewAccountAttributes instantiates a new AccountAttributes 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 + +### NewAccountAttributesWithDefaults + +`func NewAccountAttributesWithDefaults() *AccountAttributes` + +NewAccountAttributesWithDefaults instantiates a new AccountAttributes 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 + +### GetAttributes + +`func (o *AccountAttributes) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AccountAttributes) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AccountAttributes) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChanged.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChanged.md new file mode 100644 index 000000000..7776c3f79 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChanged.md @@ -0,0 +1,122 @@ +--- +id: v2024-account-attributes-changed +title: AccountAttributesChanged +pagination_label: AccountAttributesChanged +sidebar_label: AccountAttributesChanged +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChanged', 'V2024AccountAttributesChanged'] +slug: /tools/sdk/go/v2024/models/account-attributes-changed +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChanged', 'V2024AccountAttributesChanged'] +--- + +# AccountAttributesChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**AccountAttributesChangedIdentity**](account-attributes-changed-identity) | | +**Source** | [**AccountAttributesChangedSource**](account-attributes-changed-source) | | +**Account** | [**AccountAttributesChangedAccount**](account-attributes-changed-account) | | +**Changes** | [**[]AccountAttributesChangedChangesInner**](account-attributes-changed-changes-inner) | A list of attributes that changed. | + +## Methods + +### NewAccountAttributesChanged + +`func NewAccountAttributesChanged(identity AccountAttributesChangedIdentity, source AccountAttributesChangedSource, account AccountAttributesChangedAccount, changes []AccountAttributesChangedChangesInner, ) *AccountAttributesChanged` + +NewAccountAttributesChanged instantiates a new AccountAttributesChanged 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 + +### NewAccountAttributesChangedWithDefaults + +`func NewAccountAttributesChangedWithDefaults() *AccountAttributesChanged` + +NewAccountAttributesChangedWithDefaults instantiates a new AccountAttributesChanged 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 + +### GetIdentity + +`func (o *AccountAttributesChanged) GetIdentity() AccountAttributesChangedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *AccountAttributesChanged) GetIdentityOk() (*AccountAttributesChangedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *AccountAttributesChanged) SetIdentity(v AccountAttributesChangedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetSource + +`func (o *AccountAttributesChanged) GetSource() AccountAttributesChangedSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountAttributesChanged) GetSourceOk() (*AccountAttributesChangedSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountAttributesChanged) SetSource(v AccountAttributesChangedSource)` + +SetSource sets Source field to given value. + + +### GetAccount + +`func (o *AccountAttributesChanged) GetAccount() AccountAttributesChangedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *AccountAttributesChanged) GetAccountOk() (*AccountAttributesChangedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *AccountAttributesChanged) SetAccount(v AccountAttributesChangedAccount)` + +SetAccount sets Account field to given value. + + +### GetChanges + +`func (o *AccountAttributesChanged) GetChanges() []AccountAttributesChangedChangesInner` + +GetChanges returns the Changes field if non-nil, zero value otherwise. + +### GetChangesOk + +`func (o *AccountAttributesChanged) GetChangesOk() (*[]AccountAttributesChangedChangesInner, bool)` + +GetChangesOk returns a tuple with the Changes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanges + +`func (o *AccountAttributesChanged) SetChanges(v []AccountAttributesChangedChangesInner)` + +SetChanges sets Changes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedAccount.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedAccount.md new file mode 100644 index 000000000..573417797 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedAccount.md @@ -0,0 +1,153 @@ +--- +id: v2024-account-attributes-changed-account +title: AccountAttributesChangedAccount +pagination_label: AccountAttributesChangedAccount +sidebar_label: AccountAttributesChangedAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedAccount', 'V2024AccountAttributesChangedAccount'] +slug: /tools/sdk/go/v2024/models/account-attributes-changed-account +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedAccount', 'V2024AccountAttributesChangedAccount'] +--- + +# AccountAttributesChangedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | SailPoint generated unique identifier. | +**Uuid** | **NullableString** | The source's unique identifier for the account. UUID is generated by the source system. | +**Name** | **string** | Name of the account. | +**NativeIdentity** | **string** | Unique ID of the account on the source. | +**Type** | **map[string]interface{}** | The type of the account | + +## Methods + +### NewAccountAttributesChangedAccount + +`func NewAccountAttributesChangedAccount(id string, uuid NullableString, name string, nativeIdentity string, type_ map[string]interface{}, ) *AccountAttributesChangedAccount` + +NewAccountAttributesChangedAccount instantiates a new AccountAttributesChangedAccount 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 + +### NewAccountAttributesChangedAccountWithDefaults + +`func NewAccountAttributesChangedAccountWithDefaults() *AccountAttributesChangedAccount` + +NewAccountAttributesChangedAccountWithDefaults instantiates a new AccountAttributesChangedAccount 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 + +### GetId + +`func (o *AccountAttributesChangedAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAttributesChangedAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAttributesChangedAccount) SetId(v string)` + +SetId sets Id field to given value. + + +### GetUuid + +`func (o *AccountAttributesChangedAccount) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *AccountAttributesChangedAccount) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *AccountAttributesChangedAccount) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + + +### SetUuidNil + +`func (o *AccountAttributesChangedAccount) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *AccountAttributesChangedAccount) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetName + +`func (o *AccountAttributesChangedAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAttributesChangedAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAttributesChangedAccount) SetName(v string)` + +SetName sets Name field to given value. + + +### GetNativeIdentity + +`func (o *AccountAttributesChangedAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountAttributesChangedAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountAttributesChangedAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + + +### GetType + +`func (o *AccountAttributesChangedAccount) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAttributesChangedAccount) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAttributesChangedAccount) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedChangesInner.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedChangesInner.md new file mode 100644 index 000000000..72467d6b9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedChangesInner.md @@ -0,0 +1,121 @@ +--- +id: v2024-account-attributes-changed-changes-inner +title: AccountAttributesChangedChangesInner +pagination_label: AccountAttributesChangedChangesInner +sidebar_label: AccountAttributesChangedChangesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedChangesInner', 'V2024AccountAttributesChangedChangesInner'] +slug: /tools/sdk/go/v2024/models/account-attributes-changed-changes-inner +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInner', 'V2024AccountAttributesChangedChangesInner'] +--- + +# AccountAttributesChangedChangesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | **string** | The name of the attribute. | +**OldValue** | [**NullableAccountAttributesChangedChangesInnerOldValue**](account-attributes-changed-changes-inner-old-value) | | +**NewValue** | [**NullableAccountAttributesChangedChangesInnerNewValue**](account-attributes-changed-changes-inner-new-value) | | + +## Methods + +### NewAccountAttributesChangedChangesInner + +`func NewAccountAttributesChangedChangesInner(attribute string, oldValue NullableAccountAttributesChangedChangesInnerOldValue, newValue NullableAccountAttributesChangedChangesInnerNewValue, ) *AccountAttributesChangedChangesInner` + +NewAccountAttributesChangedChangesInner instantiates a new AccountAttributesChangedChangesInner 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 + +### NewAccountAttributesChangedChangesInnerWithDefaults + +`func NewAccountAttributesChangedChangesInnerWithDefaults() *AccountAttributesChangedChangesInner` + +NewAccountAttributesChangedChangesInnerWithDefaults instantiates a new AccountAttributesChangedChangesInner 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 + +### GetAttribute + +`func (o *AccountAttributesChangedChangesInner) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *AccountAttributesChangedChangesInner) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *AccountAttributesChangedChangesInner) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + + +### GetOldValue + +`func (o *AccountAttributesChangedChangesInner) GetOldValue() AccountAttributesChangedChangesInnerOldValue` + +GetOldValue returns the OldValue field if non-nil, zero value otherwise. + +### GetOldValueOk + +`func (o *AccountAttributesChangedChangesInner) GetOldValueOk() (*AccountAttributesChangedChangesInnerOldValue, bool)` + +GetOldValueOk returns a tuple with the OldValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOldValue + +`func (o *AccountAttributesChangedChangesInner) SetOldValue(v AccountAttributesChangedChangesInnerOldValue)` + +SetOldValue sets OldValue field to given value. + + +### SetOldValueNil + +`func (o *AccountAttributesChangedChangesInner) SetOldValueNil(b bool)` + + SetOldValueNil sets the value for OldValue to be an explicit nil + +### UnsetOldValue +`func (o *AccountAttributesChangedChangesInner) UnsetOldValue()` + +UnsetOldValue ensures that no value is present for OldValue, not even an explicit nil +### GetNewValue + +`func (o *AccountAttributesChangedChangesInner) GetNewValue() AccountAttributesChangedChangesInnerNewValue` + +GetNewValue returns the NewValue field if non-nil, zero value otherwise. + +### GetNewValueOk + +`func (o *AccountAttributesChangedChangesInner) GetNewValueOk() (*AccountAttributesChangedChangesInnerNewValue, bool)` + +GetNewValueOk returns a tuple with the NewValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewValue + +`func (o *AccountAttributesChangedChangesInner) SetNewValue(v AccountAttributesChangedChangesInnerNewValue)` + +SetNewValue sets NewValue field to given value. + + +### SetNewValueNil + +`func (o *AccountAttributesChangedChangesInner) SetNewValueNil(b bool)` + + SetNewValueNil sets the value for NewValue to be an explicit nil + +### UnsetNewValue +`func (o *AccountAttributesChangedChangesInner) UnsetNewValue()` + +UnsetNewValue ensures that no value is present for NewValue, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedChangesInnerNewValue.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedChangesInnerNewValue.md new file mode 100644 index 000000000..1a5089161 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedChangesInnerNewValue.md @@ -0,0 +1,38 @@ +--- +id: v2024-account-attributes-changed-changes-inner-new-value +title: AccountAttributesChangedChangesInnerNewValue +pagination_label: AccountAttributesChangedChangesInnerNewValue +sidebar_label: AccountAttributesChangedChangesInnerNewValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedChangesInnerNewValue', 'V2024AccountAttributesChangedChangesInnerNewValue'] +slug: /tools/sdk/go/v2024/models/account-attributes-changed-changes-inner-new-value +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerNewValue', 'V2024AccountAttributesChangedChangesInnerNewValue'] +--- + +# AccountAttributesChangedChangesInnerNewValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewAccountAttributesChangedChangesInnerNewValue + +`func NewAccountAttributesChangedChangesInnerNewValue() *AccountAttributesChangedChangesInnerNewValue` + +NewAccountAttributesChangedChangesInnerNewValue instantiates a new AccountAttributesChangedChangesInnerNewValue 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 + +### NewAccountAttributesChangedChangesInnerNewValueWithDefaults + +`func NewAccountAttributesChangedChangesInnerNewValueWithDefaults() *AccountAttributesChangedChangesInnerNewValue` + +NewAccountAttributesChangedChangesInnerNewValueWithDefaults instantiates a new AccountAttributesChangedChangesInnerNewValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedChangesInnerOldValue.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedChangesInnerOldValue.md new file mode 100644 index 000000000..4e15e6c6a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedChangesInnerOldValue.md @@ -0,0 +1,38 @@ +--- +id: v2024-account-attributes-changed-changes-inner-old-value +title: AccountAttributesChangedChangesInnerOldValue +pagination_label: AccountAttributesChangedChangesInnerOldValue +sidebar_label: AccountAttributesChangedChangesInnerOldValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedChangesInnerOldValue', 'V2024AccountAttributesChangedChangesInnerOldValue'] +slug: /tools/sdk/go/v2024/models/account-attributes-changed-changes-inner-old-value +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerOldValue', 'V2024AccountAttributesChangedChangesInnerOldValue'] +--- + +# AccountAttributesChangedChangesInnerOldValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewAccountAttributesChangedChangesInnerOldValue + +`func NewAccountAttributesChangedChangesInnerOldValue() *AccountAttributesChangedChangesInnerOldValue` + +NewAccountAttributesChangedChangesInnerOldValue instantiates a new AccountAttributesChangedChangesInnerOldValue 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 + +### NewAccountAttributesChangedChangesInnerOldValueWithDefaults + +`func NewAccountAttributesChangedChangesInnerOldValueWithDefaults() *AccountAttributesChangedChangesInnerOldValue` + +NewAccountAttributesChangedChangesInnerOldValueWithDefaults instantiates a new AccountAttributesChangedChangesInnerOldValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedIdentity.md new file mode 100644 index 000000000..56b34cb9b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedIdentity.md @@ -0,0 +1,101 @@ +--- +id: v2024-account-attributes-changed-identity +title: AccountAttributesChangedIdentity +pagination_label: AccountAttributesChangedIdentity +sidebar_label: AccountAttributesChangedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedIdentity', 'V2024AccountAttributesChangedIdentity'] +slug: /tools/sdk/go/v2024/models/account-attributes-changed-identity +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedIdentity', 'V2024AccountAttributesChangedIdentity'] +--- + +# AccountAttributesChangedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of the identity whose account attributes were updated. | +**Id** | **string** | ID of the identity whose account attributes were updated. | +**Name** | **string** | Display name of the identity whose account attributes were updated. | + +## Methods + +### NewAccountAttributesChangedIdentity + +`func NewAccountAttributesChangedIdentity(type_ string, id string, name string, ) *AccountAttributesChangedIdentity` + +NewAccountAttributesChangedIdentity instantiates a new AccountAttributesChangedIdentity 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 + +### NewAccountAttributesChangedIdentityWithDefaults + +`func NewAccountAttributesChangedIdentityWithDefaults() *AccountAttributesChangedIdentity` + +NewAccountAttributesChangedIdentityWithDefaults instantiates a new AccountAttributesChangedIdentity 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 + +### GetType + +`func (o *AccountAttributesChangedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAttributesChangedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAttributesChangedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountAttributesChangedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAttributesChangedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAttributesChangedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountAttributesChangedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAttributesChangedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAttributesChangedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedSource.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedSource.md new file mode 100644 index 000000000..81d4a7520 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesChangedSource.md @@ -0,0 +1,101 @@ +--- +id: v2024-account-attributes-changed-source +title: AccountAttributesChangedSource +pagination_label: AccountAttributesChangedSource +sidebar_label: AccountAttributesChangedSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedSource', 'V2024AccountAttributesChangedSource'] +slug: /tools/sdk/go/v2024/models/account-attributes-changed-source +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedSource', 'V2024AccountAttributesChangedSource'] +--- + +# AccountAttributesChangedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the object to which this reference applies | +**Type** | **string** | The type of object that is referenced | +**Name** | **string** | Human-readable display name of the object to which this reference applies | + +## Methods + +### NewAccountAttributesChangedSource + +`func NewAccountAttributesChangedSource(id string, type_ string, name string, ) *AccountAttributesChangedSource` + +NewAccountAttributesChangedSource instantiates a new AccountAttributesChangedSource 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 + +### NewAccountAttributesChangedSourceWithDefaults + +`func NewAccountAttributesChangedSourceWithDefaults() *AccountAttributesChangedSource` + +NewAccountAttributesChangedSourceWithDefaults instantiates a new AccountAttributesChangedSource 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 + +### GetId + +`func (o *AccountAttributesChangedSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAttributesChangedSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAttributesChangedSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *AccountAttributesChangedSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAttributesChangedSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAttributesChangedSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetName + +`func (o *AccountAttributesChangedSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAttributesChangedSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAttributesChangedSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesCreate.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesCreate.md new file mode 100644 index 000000000..9f4d8f3e5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesCreate.md @@ -0,0 +1,59 @@ +--- +id: v2024-account-attributes-create +title: AccountAttributesCreate +pagination_label: AccountAttributesCreate +sidebar_label: AccountAttributesCreate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesCreate', 'V2024AccountAttributesCreate'] +slug: /tools/sdk/go/v2024/models/account-attributes-create +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate', 'V2024AccountAttributesCreate'] +--- + +# AccountAttributesCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | + +## Methods + +### NewAccountAttributesCreate + +`func NewAccountAttributesCreate(attributes AccountAttributesCreateAttributes, ) *AccountAttributesCreate` + +NewAccountAttributesCreate instantiates a new AccountAttributesCreate 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 + +### NewAccountAttributesCreateWithDefaults + +`func NewAccountAttributesCreateWithDefaults() *AccountAttributesCreate` + +NewAccountAttributesCreateWithDefaults instantiates a new AccountAttributesCreate 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 + +### GetAttributes + +`func (o *AccountAttributesCreate) GetAttributes() AccountAttributesCreateAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AccountAttributesCreate) GetAttributesOk() (*AccountAttributesCreateAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AccountAttributesCreate) SetAttributes(v AccountAttributesCreateAttributes)` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesCreateAttributes.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesCreateAttributes.md new file mode 100644 index 000000000..e562da99b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountAttributesCreateAttributes.md @@ -0,0 +1,59 @@ +--- +id: v2024-account-attributes-create-attributes +title: AccountAttributesCreateAttributes +pagination_label: AccountAttributesCreateAttributes +sidebar_label: AccountAttributesCreateAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesCreateAttributes', 'V2024AccountAttributesCreateAttributes'] +slug: /tools/sdk/go/v2024/models/account-attributes-create-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreateAttributes', 'V2024AccountAttributesCreateAttributes'] +--- + +# AccountAttributesCreateAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | **string** | Target source to create an account | + +## Methods + +### NewAccountAttributesCreateAttributes + +`func NewAccountAttributesCreateAttributes(sourceId string, ) *AccountAttributesCreateAttributes` + +NewAccountAttributesCreateAttributes instantiates a new AccountAttributesCreateAttributes 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 + +### NewAccountAttributesCreateAttributesWithDefaults + +`func NewAccountAttributesCreateAttributesWithDefaults() *AccountAttributesCreateAttributes` + +NewAccountAttributesCreateAttributesWithDefaults instantiates a new AccountAttributesCreateAttributes 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 + +### GetSourceId + +`func (o *AccountAttributesCreateAttributes) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccountAttributesCreateAttributes) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccountAttributesCreateAttributes) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountCorrelated.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountCorrelated.md new file mode 100644 index 000000000..171badf41 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountCorrelated.md @@ -0,0 +1,148 @@ +--- +id: v2024-account-correlated +title: AccountCorrelated +pagination_label: AccountCorrelated +sidebar_label: AccountCorrelated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountCorrelated', 'V2024AccountCorrelated'] +slug: /tools/sdk/go/v2024/models/account-correlated +tags: ['SDK', 'Software Development Kit', 'AccountCorrelated', 'V2024AccountCorrelated'] +--- + +# AccountCorrelated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**AccountCorrelatedIdentity**](account-correlated-identity) | | +**Source** | [**AccountCorrelatedSource**](account-correlated-source) | | +**Account** | [**AccountCorrelatedAccount**](account-correlated-account) | | +**Attributes** | **map[string]interface{}** | The attributes associated with the account. Attributes are unique per source. | +**EntitlementCount** | Pointer to **int32** | The number of entitlements associated with this account. | [optional] + +## Methods + +### NewAccountCorrelated + +`func NewAccountCorrelated(identity AccountCorrelatedIdentity, source AccountCorrelatedSource, account AccountCorrelatedAccount, attributes map[string]interface{}, ) *AccountCorrelated` + +NewAccountCorrelated instantiates a new AccountCorrelated 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 + +### NewAccountCorrelatedWithDefaults + +`func NewAccountCorrelatedWithDefaults() *AccountCorrelated` + +NewAccountCorrelatedWithDefaults instantiates a new AccountCorrelated 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 + +### GetIdentity + +`func (o *AccountCorrelated) GetIdentity() AccountCorrelatedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *AccountCorrelated) GetIdentityOk() (*AccountCorrelatedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *AccountCorrelated) SetIdentity(v AccountCorrelatedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetSource + +`func (o *AccountCorrelated) GetSource() AccountCorrelatedSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountCorrelated) GetSourceOk() (*AccountCorrelatedSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountCorrelated) SetSource(v AccountCorrelatedSource)` + +SetSource sets Source field to given value. + + +### GetAccount + +`func (o *AccountCorrelated) GetAccount() AccountCorrelatedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *AccountCorrelated) GetAccountOk() (*AccountCorrelatedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *AccountCorrelated) SetAccount(v AccountCorrelatedAccount)` + +SetAccount sets Account field to given value. + + +### GetAttributes + +`func (o *AccountCorrelated) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AccountCorrelated) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AccountCorrelated) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetEntitlementCount + +`func (o *AccountCorrelated) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccountCorrelated) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccountCorrelated) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccountCorrelated) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountCorrelatedAccount.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountCorrelatedAccount.md new file mode 100644 index 000000000..b343fcf5a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountCorrelatedAccount.md @@ -0,0 +1,158 @@ +--- +id: v2024-account-correlated-account +title: AccountCorrelatedAccount +pagination_label: AccountCorrelatedAccount +sidebar_label: AccountCorrelatedAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountCorrelatedAccount', 'V2024AccountCorrelatedAccount'] +slug: /tools/sdk/go/v2024/models/account-correlated-account +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedAccount', 'V2024AccountCorrelatedAccount'] +--- + +# AccountCorrelatedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The correlated account's DTO type. | +**Id** | **string** | The correlated account's ID. | +**Name** | **string** | The correlated account's display name. | +**NativeIdentity** | **string** | Unique ID of the account on the source. | +**Uuid** | Pointer to **NullableString** | The source's unique identifier for the account. UUID is generated by the source system. | [optional] + +## Methods + +### NewAccountCorrelatedAccount + +`func NewAccountCorrelatedAccount(type_ string, id string, name string, nativeIdentity string, ) *AccountCorrelatedAccount` + +NewAccountCorrelatedAccount instantiates a new AccountCorrelatedAccount 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 + +### NewAccountCorrelatedAccountWithDefaults + +`func NewAccountCorrelatedAccountWithDefaults() *AccountCorrelatedAccount` + +NewAccountCorrelatedAccountWithDefaults instantiates a new AccountCorrelatedAccount 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 + +### GetType + +`func (o *AccountCorrelatedAccount) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountCorrelatedAccount) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountCorrelatedAccount) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountCorrelatedAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountCorrelatedAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountCorrelatedAccount) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountCorrelatedAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountCorrelatedAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountCorrelatedAccount) SetName(v string)` + +SetName sets Name field to given value. + + +### GetNativeIdentity + +`func (o *AccountCorrelatedAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountCorrelatedAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountCorrelatedAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + + +### GetUuid + +`func (o *AccountCorrelatedAccount) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *AccountCorrelatedAccount) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *AccountCorrelatedAccount) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *AccountCorrelatedAccount) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *AccountCorrelatedAccount) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *AccountCorrelatedAccount) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountCorrelatedIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountCorrelatedIdentity.md new file mode 100644 index 000000000..d0d4ccdd1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountCorrelatedIdentity.md @@ -0,0 +1,101 @@ +--- +id: v2024-account-correlated-identity +title: AccountCorrelatedIdentity +pagination_label: AccountCorrelatedIdentity +sidebar_label: AccountCorrelatedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountCorrelatedIdentity', 'V2024AccountCorrelatedIdentity'] +slug: /tools/sdk/go/v2024/models/account-correlated-identity +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedIdentity', 'V2024AccountCorrelatedIdentity'] +--- + +# AccountCorrelatedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of the identity the account is correlated with. | +**Id** | **string** | ID of the identity the account is correlated with. | +**Name** | **string** | Display name of the identity the account is correlated with. | + +## Methods + +### NewAccountCorrelatedIdentity + +`func NewAccountCorrelatedIdentity(type_ string, id string, name string, ) *AccountCorrelatedIdentity` + +NewAccountCorrelatedIdentity instantiates a new AccountCorrelatedIdentity 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 + +### NewAccountCorrelatedIdentityWithDefaults + +`func NewAccountCorrelatedIdentityWithDefaults() *AccountCorrelatedIdentity` + +NewAccountCorrelatedIdentityWithDefaults instantiates a new AccountCorrelatedIdentity 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 + +### GetType + +`func (o *AccountCorrelatedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountCorrelatedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountCorrelatedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountCorrelatedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountCorrelatedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountCorrelatedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountCorrelatedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountCorrelatedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountCorrelatedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountCorrelatedSource.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountCorrelatedSource.md new file mode 100644 index 000000000..2ae0b8347 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountCorrelatedSource.md @@ -0,0 +1,101 @@ +--- +id: v2024-account-correlated-source +title: AccountCorrelatedSource +pagination_label: AccountCorrelatedSource +sidebar_label: AccountCorrelatedSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountCorrelatedSource', 'V2024AccountCorrelatedSource'] +slug: /tools/sdk/go/v2024/models/account-correlated-source +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedSource', 'V2024AccountCorrelatedSource'] +--- + +# AccountCorrelatedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The DTO type of the source the accounts are being correlated from. | +**Id** | **string** | The ID of the source the accounts are being correlated from. | +**Name** | **string** | Display name of the source the accounts are being correlated from. | + +## Methods + +### NewAccountCorrelatedSource + +`func NewAccountCorrelatedSource(type_ string, id string, name string, ) *AccountCorrelatedSource` + +NewAccountCorrelatedSource instantiates a new AccountCorrelatedSource 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 + +### NewAccountCorrelatedSourceWithDefaults + +`func NewAccountCorrelatedSourceWithDefaults() *AccountCorrelatedSource` + +NewAccountCorrelatedSourceWithDefaults instantiates a new AccountCorrelatedSource 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 + +### GetType + +`func (o *AccountCorrelatedSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountCorrelatedSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountCorrelatedSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountCorrelatedSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountCorrelatedSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountCorrelatedSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountCorrelatedSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountCorrelatedSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountCorrelatedSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountInfoDto.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountInfoDto.md new file mode 100644 index 000000000..28062fc01 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountInfoDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-account-info-dto +title: AccountInfoDto +pagination_label: AccountInfoDto +sidebar_label: AccountInfoDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountInfoDto', 'V2024AccountInfoDto'] +slug: /tools/sdk/go/v2024/models/account-info-dto +tags: ['SDK', 'Software Development Kit', 'AccountInfoDto', 'V2024AccountInfoDto'] +--- + +# AccountInfoDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NativeIdentity** | Pointer to **string** | The unique ID of the account generated by the source system | [optional] +**DisplayName** | Pointer to **string** | Display name for this account | [optional] +**Uuid** | Pointer to **string** | UUID associated with this account | [optional] + +## Methods + +### NewAccountInfoDto + +`func NewAccountInfoDto() *AccountInfoDto` + +NewAccountInfoDto instantiates a new AccountInfoDto 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 + +### NewAccountInfoDtoWithDefaults + +`func NewAccountInfoDtoWithDefaults() *AccountInfoDto` + +NewAccountInfoDtoWithDefaults instantiates a new AccountInfoDto 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 + +### GetNativeIdentity + +`func (o *AccountInfoDto) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountInfoDto) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountInfoDto) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccountInfoDto) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccountInfoDto) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccountInfoDto) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccountInfoDto) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccountInfoDto) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetUuid + +`func (o *AccountInfoDto) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *AccountInfoDto) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *AccountInfoDto) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *AccountInfoDto) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountInfoRef.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountInfoRef.md new file mode 100644 index 000000000..724a22f31 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountInfoRef.md @@ -0,0 +1,168 @@ +--- +id: v2024-account-info-ref +title: AccountInfoRef +pagination_label: AccountInfoRef +sidebar_label: AccountInfoRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountInfoRef', 'V2024AccountInfoRef'] +slug: /tools/sdk/go/v2024/models/account-info-ref +tags: ['SDK', 'Software Development Kit', 'AccountInfoRef', 'V2024AccountInfoRef'] +--- + +# AccountInfoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | Pointer to **string** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | Pointer to **string** | The 'distinguishedName' attribute for the account | [optional] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | The account id | [optional] +**Name** | Pointer to **string** | The account display name | [optional] + +## Methods + +### NewAccountInfoRef + +`func NewAccountInfoRef() *AccountInfoRef` + +NewAccountInfoRef instantiates a new AccountInfoRef 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 + +### NewAccountInfoRefWithDefaults + +`func NewAccountInfoRefWithDefaults() *AccountInfoRef` + +NewAccountInfoRefWithDefaults instantiates a new AccountInfoRef 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 + +### GetUuid + +`func (o *AccountInfoRef) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *AccountInfoRef) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *AccountInfoRef) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *AccountInfoRef) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *AccountInfoRef) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountInfoRef) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountInfoRef) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccountInfoRef) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetType + +`func (o *AccountInfoRef) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountInfoRef) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountInfoRef) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountInfoRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccountInfoRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountInfoRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountInfoRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountInfoRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccountInfoRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountInfoRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountInfoRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountInfoRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountItemRef.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountItemRef.md new file mode 100644 index 000000000..fe896d3c8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountItemRef.md @@ -0,0 +1,100 @@ +--- +id: v2024-account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountItemRef', 'V2024AccountItemRef'] +slug: /tools/sdk/go/v2024/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'V2024AccountItemRef'] +--- + +# AccountItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountUuid** | Pointer to **NullableString** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | Pointer to **string** | The 'distinguishedName' attribute for the account | [optional] + +## Methods + +### NewAccountItemRef + +`func NewAccountItemRef() *AccountItemRef` + +NewAccountItemRef instantiates a new AccountItemRef 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 + +### NewAccountItemRefWithDefaults + +`func NewAccountItemRefWithDefaults() *AccountItemRef` + +NewAccountItemRefWithDefaults instantiates a new AccountItemRef 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 + +### GetAccountUuid + +`func (o *AccountItemRef) GetAccountUuid() string` + +GetAccountUuid returns the AccountUuid field if non-nil, zero value otherwise. + +### GetAccountUuidOk + +`func (o *AccountItemRef) GetAccountUuidOk() (*string, bool)` + +GetAccountUuidOk returns a tuple with the AccountUuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountUuid + +`func (o *AccountItemRef) SetAccountUuid(v string)` + +SetAccountUuid sets AccountUuid field to given value. + +### HasAccountUuid + +`func (o *AccountItemRef) HasAccountUuid() bool` + +HasAccountUuid returns a boolean if a field has been set. + +### SetAccountUuidNil + +`func (o *AccountItemRef) SetAccountUuidNil(b bool)` + + SetAccountUuidNil sets the value for AccountUuid to be an explicit nil + +### UnsetAccountUuid +`func (o *AccountItemRef) UnsetAccountUuid()` + +UnsetAccountUuid ensures that no value is present for AccountUuid, not even an explicit nil +### GetNativeIdentity + +`func (o *AccountItemRef) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountItemRef) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountItemRef) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccountItemRef) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountRequest.md new file mode 100644 index 000000000..586b18b2d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountRequest.md @@ -0,0 +1,194 @@ +--- +id: v2024-account-request +title: AccountRequest +pagination_label: AccountRequest +sidebar_label: AccountRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountRequest', 'V2024AccountRequest'] +slug: /tools/sdk/go/v2024/models/account-request +tags: ['SDK', 'Software Development Kit', 'AccountRequest', 'V2024AccountRequest'] +--- + +# AccountRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **string** | Unique ID of the account | [optional] +**AttributeRequests** | Pointer to [**[]AttributeRequest**](attribute-request) | | [optional] +**Op** | Pointer to **string** | The operation that was performed | [optional] +**ProvisioningTarget** | Pointer to [**AccountSource**](account-source) | | [optional] +**Result** | Pointer to [**AccountRequestResult**](account-request-result) | | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] + +## Methods + +### NewAccountRequest + +`func NewAccountRequest() *AccountRequest` + +NewAccountRequest instantiates a new AccountRequest 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 + +### NewAccountRequestWithDefaults + +`func NewAccountRequestWithDefaults() *AccountRequest` + +NewAccountRequestWithDefaults instantiates a new AccountRequest 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 + +### GetAccountId + +`func (o *AccountRequest) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *AccountRequest) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *AccountRequest) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *AccountRequest) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetAttributeRequests + +`func (o *AccountRequest) GetAttributeRequests() []AttributeRequest` + +GetAttributeRequests returns the AttributeRequests field if non-nil, zero value otherwise. + +### GetAttributeRequestsOk + +`func (o *AccountRequest) GetAttributeRequestsOk() (*[]AttributeRequest, bool)` + +GetAttributeRequestsOk returns a tuple with the AttributeRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeRequests + +`func (o *AccountRequest) SetAttributeRequests(v []AttributeRequest)` + +SetAttributeRequests sets AttributeRequests field to given value. + +### HasAttributeRequests + +`func (o *AccountRequest) HasAttributeRequests() bool` + +HasAttributeRequests returns a boolean if a field has been set. + +### GetOp + +`func (o *AccountRequest) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *AccountRequest) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *AccountRequest) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *AccountRequest) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetProvisioningTarget + +`func (o *AccountRequest) GetProvisioningTarget() AccountSource` + +GetProvisioningTarget returns the ProvisioningTarget field if non-nil, zero value otherwise. + +### GetProvisioningTargetOk + +`func (o *AccountRequest) GetProvisioningTargetOk() (*AccountSource, bool)` + +GetProvisioningTargetOk returns a tuple with the ProvisioningTarget field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningTarget + +`func (o *AccountRequest) SetProvisioningTarget(v AccountSource)` + +SetProvisioningTarget sets ProvisioningTarget field to given value. + +### HasProvisioningTarget + +`func (o *AccountRequest) HasProvisioningTarget() bool` + +HasProvisioningTarget returns a boolean if a field has been set. + +### GetResult + +`func (o *AccountRequest) GetResult() AccountRequestResult` + +GetResult returns the Result field if non-nil, zero value otherwise. + +### GetResultOk + +`func (o *AccountRequest) GetResultOk() (*AccountRequestResult, bool)` + +GetResultOk returns a tuple with the Result field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResult + +`func (o *AccountRequest) SetResult(v AccountRequestResult)` + +SetResult sets Result field to given value. + +### HasResult + +`func (o *AccountRequest) HasResult() bool` + +HasResult returns a boolean if a field has been set. + +### GetSource + +`func (o *AccountRequest) GetSource() AccountSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountRequest) GetSourceOk() (*AccountSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountRequest) SetSource(v AccountSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *AccountRequest) HasSource() bool` + +HasSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountRequestInfo.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountRequestInfo.md new file mode 100644 index 000000000..ec14cd159 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountRequestInfo.md @@ -0,0 +1,116 @@ +--- +id: v2024-account-request-info +title: AccountRequestInfo +pagination_label: AccountRequestInfo +sidebar_label: AccountRequestInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountRequestInfo', 'V2024AccountRequestInfo'] +slug: /tools/sdk/go/v2024/models/account-request-info +tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'V2024AccountRequestInfo'] +--- + +# AccountRequestInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedObjectId** | Pointer to **string** | Id of requested object | [optional] +**RequestedObjectName** | Pointer to **string** | Human-readable name of requested object | [optional] +**RequestedObjectType** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional] + +## Methods + +### NewAccountRequestInfo + +`func NewAccountRequestInfo() *AccountRequestInfo` + +NewAccountRequestInfo instantiates a new AccountRequestInfo 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 + +### NewAccountRequestInfoWithDefaults + +`func NewAccountRequestInfoWithDefaults() *AccountRequestInfo` + +NewAccountRequestInfoWithDefaults instantiates a new AccountRequestInfo 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 + +### GetRequestedObjectId + +`func (o *AccountRequestInfo) GetRequestedObjectId() string` + +GetRequestedObjectId returns the RequestedObjectId field if non-nil, zero value otherwise. + +### GetRequestedObjectIdOk + +`func (o *AccountRequestInfo) GetRequestedObjectIdOk() (*string, bool)` + +GetRequestedObjectIdOk returns a tuple with the RequestedObjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObjectId + +`func (o *AccountRequestInfo) SetRequestedObjectId(v string)` + +SetRequestedObjectId sets RequestedObjectId field to given value. + +### HasRequestedObjectId + +`func (o *AccountRequestInfo) HasRequestedObjectId() bool` + +HasRequestedObjectId returns a boolean if a field has been set. + +### GetRequestedObjectName + +`func (o *AccountRequestInfo) GetRequestedObjectName() string` + +GetRequestedObjectName returns the RequestedObjectName field if non-nil, zero value otherwise. + +### GetRequestedObjectNameOk + +`func (o *AccountRequestInfo) GetRequestedObjectNameOk() (*string, bool)` + +GetRequestedObjectNameOk returns a tuple with the RequestedObjectName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObjectName + +`func (o *AccountRequestInfo) SetRequestedObjectName(v string)` + +SetRequestedObjectName sets RequestedObjectName field to given value. + +### HasRequestedObjectName + +`func (o *AccountRequestInfo) HasRequestedObjectName() bool` + +HasRequestedObjectName returns a boolean if a field has been set. + +### GetRequestedObjectType + +`func (o *AccountRequestInfo) GetRequestedObjectType() RequestableObjectType` + +GetRequestedObjectType returns the RequestedObjectType field if non-nil, zero value otherwise. + +### GetRequestedObjectTypeOk + +`func (o *AccountRequestInfo) GetRequestedObjectTypeOk() (*RequestableObjectType, bool)` + +GetRequestedObjectTypeOk returns a tuple with the RequestedObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObjectType + +`func (o *AccountRequestInfo) SetRequestedObjectType(v RequestableObjectType)` + +SetRequestedObjectType sets RequestedObjectType field to given value. + +### HasRequestedObjectType + +`func (o *AccountRequestInfo) HasRequestedObjectType() bool` + +HasRequestedObjectType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountRequestResult.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountRequestResult.md new file mode 100644 index 000000000..eddfe359a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountRequestResult.md @@ -0,0 +1,126 @@ +--- +id: v2024-account-request-result +title: AccountRequestResult +pagination_label: AccountRequestResult +sidebar_label: AccountRequestResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountRequestResult', 'V2024AccountRequestResult'] +slug: /tools/sdk/go/v2024/models/account-request-result +tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'V2024AccountRequestResult'] +--- + +# AccountRequestResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | Pointer to **[]string** | Error message. | [optional] +**Status** | Pointer to **string** | The status of the account request | [optional] +**TicketId** | Pointer to **NullableString** | ID of associated ticket. | [optional] + +## Methods + +### NewAccountRequestResult + +`func NewAccountRequestResult() *AccountRequestResult` + +NewAccountRequestResult instantiates a new AccountRequestResult 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 + +### NewAccountRequestResultWithDefaults + +`func NewAccountRequestResultWithDefaults() *AccountRequestResult` + +NewAccountRequestResultWithDefaults instantiates a new AccountRequestResult 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 + +### GetErrors + +`func (o *AccountRequestResult) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountRequestResult) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountRequestResult) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *AccountRequestResult) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccountRequestResult) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountRequestResult) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountRequestResult) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccountRequestResult) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetTicketId + +`func (o *AccountRequestResult) GetTicketId() string` + +GetTicketId returns the TicketId field if non-nil, zero value otherwise. + +### GetTicketIdOk + +`func (o *AccountRequestResult) GetTicketIdOk() (*string, bool)` + +GetTicketIdOk returns a tuple with the TicketId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTicketId + +`func (o *AccountRequestResult) SetTicketId(v string)` + +SetTicketId sets TicketId field to given value. + +### HasTicketId + +`func (o *AccountRequestResult) HasTicketId() bool` + +HasTicketId returns a boolean if a field has been set. + +### SetTicketIdNil + +`func (o *AccountRequestResult) SetTicketIdNil(b bool)` + + SetTicketIdNil sets the value for TicketId to be an explicit nil + +### UnsetTicketId +`func (o *AccountRequestResult) UnsetTicketId()` + +UnsetTicketId ensures that no value is present for TicketId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountSource.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountSource.md new file mode 100644 index 000000000..98d533a48 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountSource.md @@ -0,0 +1,116 @@ +--- +id: v2024-account-source +title: AccountSource +pagination_label: AccountSource +sidebar_label: AccountSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountSource', 'V2024AccountSource'] +slug: /tools/sdk/go/v2024/models/account-source +tags: ['SDK', 'Software Development Kit', 'AccountSource', 'V2024AccountSource'] +--- + +# AccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**Type** | Pointer to **string** | Type of source returned. | [optional] + +## Methods + +### NewAccountSource + +`func NewAccountSource() *AccountSource` + +NewAccountSource instantiates a new AccountSource 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 + +### NewAccountSourceWithDefaults + +`func NewAccountSourceWithDefaults() *AccountSource` + +NewAccountSourceWithDefaults instantiates a new AccountSource 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 + +### GetId + +`func (o *AccountSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccountSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountSource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *AccountSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountSource) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountStatusChanged.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountStatusChanged.md new file mode 100644 index 000000000..3e79d32f7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountStatusChanged.md @@ -0,0 +1,168 @@ +--- +id: v2024-account-status-changed +title: AccountStatusChanged +pagination_label: AccountStatusChanged +sidebar_label: AccountStatusChanged +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountStatusChanged', 'V2024AccountStatusChanged'] +slug: /tools/sdk/go/v2024/models/account-status-changed +tags: ['SDK', 'Software Development Kit', 'AccountStatusChanged', 'V2024AccountStatusChanged'] +--- + +# AccountStatusChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EventType** | Pointer to **string** | the event type | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] +**Account** | Pointer to [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] +**StatusChange** | Pointer to [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional] + +## Methods + +### NewAccountStatusChanged + +`func NewAccountStatusChanged() *AccountStatusChanged` + +NewAccountStatusChanged instantiates a new AccountStatusChanged 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 + +### NewAccountStatusChangedWithDefaults + +`func NewAccountStatusChangedWithDefaults() *AccountStatusChanged` + +NewAccountStatusChangedWithDefaults instantiates a new AccountStatusChanged 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 + +### GetEventType + +`func (o *AccountStatusChanged) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AccountStatusChanged) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AccountStatusChanged) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AccountStatusChanged) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *AccountStatusChanged) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccountStatusChanged) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccountStatusChanged) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccountStatusChanged) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetDt + +`func (o *AccountStatusChanged) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *AccountStatusChanged) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *AccountStatusChanged) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *AccountStatusChanged) HasDt() bool` + +HasDt returns a boolean if a field has been set. + +### GetAccount + +`func (o *AccountStatusChanged) GetAccount() AccountStatusChangedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *AccountStatusChanged) GetAccountOk() (*AccountStatusChangedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *AccountStatusChanged) SetAccount(v AccountStatusChangedAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *AccountStatusChanged) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### GetStatusChange + +`func (o *AccountStatusChanged) GetStatusChange() AccountStatusChangedStatusChange` + +GetStatusChange returns the StatusChange field if non-nil, zero value otherwise. + +### GetStatusChangeOk + +`func (o *AccountStatusChanged) GetStatusChangeOk() (*AccountStatusChangedStatusChange, bool)` + +GetStatusChangeOk returns a tuple with the StatusChange field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusChange + +`func (o *AccountStatusChanged) SetStatusChange(v AccountStatusChangedStatusChange)` + +SetStatusChange sets StatusChange field to given value. + +### HasStatusChange + +`func (o *AccountStatusChanged) HasStatusChange() bool` + +HasStatusChange returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountStatusChangedAccount.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountStatusChangedAccount.md new file mode 100644 index 000000000..5bfd289bb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountStatusChangedAccount.md @@ -0,0 +1,220 @@ +--- +id: v2024-account-status-changed-account +title: AccountStatusChangedAccount +pagination_label: AccountStatusChangedAccount +sidebar_label: AccountStatusChangedAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountStatusChangedAccount', 'V2024AccountStatusChangedAccount'] +slug: /tools/sdk/go/v2024/models/account-status-changed-account +tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedAccount', 'V2024AccountStatusChangedAccount'] +--- + +# AccountStatusChangedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the ID of the account in the database | [optional] +**NativeIdentity** | Pointer to **string** | the native identifier of the account | [optional] +**DisplayName** | Pointer to **string** | the display name of the account | [optional] +**SourceId** | Pointer to **string** | the ID of the source for this account | [optional] +**SourceName** | Pointer to **string** | the name of the source for this account | [optional] +**EntitlementCount** | Pointer to **int32** | the number of entitlements on this account | [optional] +**AccessType** | Pointer to **string** | this value is always \"account\" | [optional] + +## Methods + +### NewAccountStatusChangedAccount + +`func NewAccountStatusChangedAccount() *AccountStatusChangedAccount` + +NewAccountStatusChangedAccount instantiates a new AccountStatusChangedAccount 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 + +### NewAccountStatusChangedAccountWithDefaults + +`func NewAccountStatusChangedAccountWithDefaults() *AccountStatusChangedAccount` + +NewAccountStatusChangedAccountWithDefaults instantiates a new AccountStatusChangedAccount 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 + +### GetId + +`func (o *AccountStatusChangedAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountStatusChangedAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountStatusChangedAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountStatusChangedAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *AccountStatusChangedAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountStatusChangedAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountStatusChangedAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccountStatusChangedAccount) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccountStatusChangedAccount) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccountStatusChangedAccount) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccountStatusChangedAccount) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccountStatusChangedAccount) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccountStatusChangedAccount) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccountStatusChangedAccount) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccountStatusChangedAccount) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccountStatusChangedAccount) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccountStatusChangedAccount) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccountStatusChangedAccount) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccountStatusChangedAccount) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccountStatusChangedAccount) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccountStatusChangedAccount) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccountStatusChangedAccount) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccountStatusChangedAccount) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccountStatusChangedAccount) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetAccessType + +`func (o *AccountStatusChangedAccount) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccountStatusChangedAccount) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccountStatusChangedAccount) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccountStatusChangedAccount) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountStatusChangedStatusChange.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountStatusChangedStatusChange.md new file mode 100644 index 000000000..c16a75481 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountStatusChangedStatusChange.md @@ -0,0 +1,90 @@ +--- +id: v2024-account-status-changed-status-change +title: AccountStatusChangedStatusChange +pagination_label: AccountStatusChangedStatusChange +sidebar_label: AccountStatusChangedStatusChange +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountStatusChangedStatusChange', 'V2024AccountStatusChangedStatusChange'] +slug: /tools/sdk/go/v2024/models/account-status-changed-status-change +tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedStatusChange', 'V2024AccountStatusChangedStatusChange'] +--- + +# AccountStatusChangedStatusChange + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PreviousStatus** | Pointer to **string** | the previous status of the account | [optional] +**NewStatus** | Pointer to **string** | the new status of the account | [optional] + +## Methods + +### NewAccountStatusChangedStatusChange + +`func NewAccountStatusChangedStatusChange() *AccountStatusChangedStatusChange` + +NewAccountStatusChangedStatusChange instantiates a new AccountStatusChangedStatusChange 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 + +### NewAccountStatusChangedStatusChangeWithDefaults + +`func NewAccountStatusChangedStatusChangeWithDefaults() *AccountStatusChangedStatusChange` + +NewAccountStatusChangedStatusChangeWithDefaults instantiates a new AccountStatusChangedStatusChange 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 + +### GetPreviousStatus + +`func (o *AccountStatusChangedStatusChange) GetPreviousStatus() string` + +GetPreviousStatus returns the PreviousStatus field if non-nil, zero value otherwise. + +### GetPreviousStatusOk + +`func (o *AccountStatusChangedStatusChange) GetPreviousStatusOk() (*string, bool)` + +GetPreviousStatusOk returns a tuple with the PreviousStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousStatus + +`func (o *AccountStatusChangedStatusChange) SetPreviousStatus(v string)` + +SetPreviousStatus sets PreviousStatus field to given value. + +### HasPreviousStatus + +`func (o *AccountStatusChangedStatusChange) HasPreviousStatus() bool` + +HasPreviousStatus returns a boolean if a field has been set. + +### GetNewStatus + +`func (o *AccountStatusChangedStatusChange) GetNewStatus() string` + +GetNewStatus returns the NewStatus field if non-nil, zero value otherwise. + +### GetNewStatusOk + +`func (o *AccountStatusChangedStatusChange) GetNewStatusOk() (*string, bool)` + +GetNewStatusOk returns a tuple with the NewStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewStatus + +`func (o *AccountStatusChangedStatusChange) SetNewStatus(v string)` + +SetNewStatus sets NewStatus field to given value. + +### HasNewStatus + +`func (o *AccountStatusChangedStatusChange) HasNewStatus() bool` + +HasNewStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountToggleRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountToggleRequest.md new file mode 100644 index 000000000..eca459d50 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountToggleRequest.md @@ -0,0 +1,90 @@ +--- +id: v2024-account-toggle-request +title: AccountToggleRequest +pagination_label: AccountToggleRequest +sidebar_label: AccountToggleRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountToggleRequest', 'V2024AccountToggleRequest'] +slug: /tools/sdk/go/v2024/models/account-toggle-request +tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'V2024AccountToggleRequest'] +--- + +# AccountToggleRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExternalVerificationId** | Pointer to **string** | If set, an external process validates that the user wants to proceed with this request. | [optional] +**ForceProvisioning** | Pointer to **bool** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing 'true' for an unlocked account will add and process 'Unlock' operation by the workflow. | [optional] + +## Methods + +### NewAccountToggleRequest + +`func NewAccountToggleRequest() *AccountToggleRequest` + +NewAccountToggleRequest instantiates a new AccountToggleRequest 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 + +### NewAccountToggleRequestWithDefaults + +`func NewAccountToggleRequestWithDefaults() *AccountToggleRequest` + +NewAccountToggleRequestWithDefaults instantiates a new AccountToggleRequest 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 + +### GetExternalVerificationId + +`func (o *AccountToggleRequest) GetExternalVerificationId() string` + +GetExternalVerificationId returns the ExternalVerificationId field if non-nil, zero value otherwise. + +### GetExternalVerificationIdOk + +`func (o *AccountToggleRequest) GetExternalVerificationIdOk() (*string, bool)` + +GetExternalVerificationIdOk returns a tuple with the ExternalVerificationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExternalVerificationId + +`func (o *AccountToggleRequest) SetExternalVerificationId(v string)` + +SetExternalVerificationId sets ExternalVerificationId field to given value. + +### HasExternalVerificationId + +`func (o *AccountToggleRequest) HasExternalVerificationId() bool` + +HasExternalVerificationId returns a boolean if a field has been set. + +### GetForceProvisioning + +`func (o *AccountToggleRequest) GetForceProvisioning() bool` + +GetForceProvisioning returns the ForceProvisioning field if non-nil, zero value otherwise. + +### GetForceProvisioningOk + +`func (o *AccountToggleRequest) GetForceProvisioningOk() (*bool, bool)` + +GetForceProvisioningOk returns a tuple with the ForceProvisioning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForceProvisioning + +`func (o *AccountToggleRequest) SetForceProvisioning(v bool)` + +SetForceProvisioning sets ForceProvisioning field to given value. + +### HasForceProvisioning + +`func (o *AccountToggleRequest) HasForceProvisioning() bool` + +HasForceProvisioning returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountUncorrelated.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountUncorrelated.md new file mode 100644 index 000000000..825b4473e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountUncorrelated.md @@ -0,0 +1,127 @@ +--- +id: v2024-account-uncorrelated +title: AccountUncorrelated +pagination_label: AccountUncorrelated +sidebar_label: AccountUncorrelated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUncorrelated', 'V2024AccountUncorrelated'] +slug: /tools/sdk/go/v2024/models/account-uncorrelated +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelated', 'V2024AccountUncorrelated'] +--- + +# AccountUncorrelated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**AccountUncorrelatedIdentity**](account-uncorrelated-identity) | | +**Source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | +**Account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | +**EntitlementCount** | Pointer to **int32** | The number of entitlements associated with this account. | [optional] + +## Methods + +### NewAccountUncorrelated + +`func NewAccountUncorrelated(identity AccountUncorrelatedIdentity, source AccountUncorrelatedSource, account AccountUncorrelatedAccount, ) *AccountUncorrelated` + +NewAccountUncorrelated instantiates a new AccountUncorrelated 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 + +### NewAccountUncorrelatedWithDefaults + +`func NewAccountUncorrelatedWithDefaults() *AccountUncorrelated` + +NewAccountUncorrelatedWithDefaults instantiates a new AccountUncorrelated 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 + +### GetIdentity + +`func (o *AccountUncorrelated) GetIdentity() AccountUncorrelatedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *AccountUncorrelated) GetIdentityOk() (*AccountUncorrelatedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *AccountUncorrelated) SetIdentity(v AccountUncorrelatedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetSource + +`func (o *AccountUncorrelated) GetSource() AccountUncorrelatedSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountUncorrelated) GetSourceOk() (*AccountUncorrelatedSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountUncorrelated) SetSource(v AccountUncorrelatedSource)` + +SetSource sets Source field to given value. + + +### GetAccount + +`func (o *AccountUncorrelated) GetAccount() AccountUncorrelatedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *AccountUncorrelated) GetAccountOk() (*AccountUncorrelatedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *AccountUncorrelated) SetAccount(v AccountUncorrelatedAccount)` + +SetAccount sets Account field to given value. + + +### GetEntitlementCount + +`func (o *AccountUncorrelated) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccountUncorrelated) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccountUncorrelated) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccountUncorrelated) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountUncorrelatedAccount.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountUncorrelatedAccount.md new file mode 100644 index 000000000..63c214ddc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountUncorrelatedAccount.md @@ -0,0 +1,158 @@ +--- +id: v2024-account-uncorrelated-account +title: AccountUncorrelatedAccount +pagination_label: AccountUncorrelatedAccount +sidebar_label: AccountUncorrelatedAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUncorrelatedAccount', 'V2024AccountUncorrelatedAccount'] +slug: /tools/sdk/go/v2024/models/account-uncorrelated-account +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedAccount', 'V2024AccountUncorrelatedAccount'] +--- + +# AccountUncorrelatedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **map[string]interface{}** | Uncorrelated account's DTO type. | +**Id** | **string** | Uncorrelated account's ID. | +**Name** | **string** | Uncorrelated account's display name. | +**NativeIdentity** | **string** | Unique ID of the account on the source. | +**Uuid** | Pointer to **NullableString** | The source's unique identifier for the account. UUID is generated by the source system. | [optional] + +## Methods + +### NewAccountUncorrelatedAccount + +`func NewAccountUncorrelatedAccount(type_ map[string]interface{}, id string, name string, nativeIdentity string, ) *AccountUncorrelatedAccount` + +NewAccountUncorrelatedAccount instantiates a new AccountUncorrelatedAccount 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 + +### NewAccountUncorrelatedAccountWithDefaults + +`func NewAccountUncorrelatedAccountWithDefaults() *AccountUncorrelatedAccount` + +NewAccountUncorrelatedAccountWithDefaults instantiates a new AccountUncorrelatedAccount 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 + +### GetType + +`func (o *AccountUncorrelatedAccount) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountUncorrelatedAccount) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountUncorrelatedAccount) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountUncorrelatedAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountUncorrelatedAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountUncorrelatedAccount) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountUncorrelatedAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountUncorrelatedAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountUncorrelatedAccount) SetName(v string)` + +SetName sets Name field to given value. + + +### GetNativeIdentity + +`func (o *AccountUncorrelatedAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountUncorrelatedAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountUncorrelatedAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + + +### GetUuid + +`func (o *AccountUncorrelatedAccount) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *AccountUncorrelatedAccount) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *AccountUncorrelatedAccount) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *AccountUncorrelatedAccount) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *AccountUncorrelatedAccount) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *AccountUncorrelatedAccount) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountUncorrelatedIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountUncorrelatedIdentity.md new file mode 100644 index 000000000..789b5f11e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountUncorrelatedIdentity.md @@ -0,0 +1,101 @@ +--- +id: v2024-account-uncorrelated-identity +title: AccountUncorrelatedIdentity +pagination_label: AccountUncorrelatedIdentity +sidebar_label: AccountUncorrelatedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUncorrelatedIdentity', 'V2024AccountUncorrelatedIdentity'] +slug: /tools/sdk/go/v2024/models/account-uncorrelated-identity +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedIdentity', 'V2024AccountUncorrelatedIdentity'] +--- + +# AccountUncorrelatedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of the identity the account is uncorrelated with. | +**Id** | **string** | ID of the identity the account is uncorrelated with. | +**Name** | **string** | Display name of the identity the account is uncorrelated with. | + +## Methods + +### NewAccountUncorrelatedIdentity + +`func NewAccountUncorrelatedIdentity(type_ string, id string, name string, ) *AccountUncorrelatedIdentity` + +NewAccountUncorrelatedIdentity instantiates a new AccountUncorrelatedIdentity 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 + +### NewAccountUncorrelatedIdentityWithDefaults + +`func NewAccountUncorrelatedIdentityWithDefaults() *AccountUncorrelatedIdentity` + +NewAccountUncorrelatedIdentityWithDefaults instantiates a new AccountUncorrelatedIdentity 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 + +### GetType + +`func (o *AccountUncorrelatedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountUncorrelatedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountUncorrelatedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountUncorrelatedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountUncorrelatedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountUncorrelatedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountUncorrelatedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountUncorrelatedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountUncorrelatedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountUncorrelatedSource.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountUncorrelatedSource.md new file mode 100644 index 000000000..a76f4cd1e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountUncorrelatedSource.md @@ -0,0 +1,101 @@ +--- +id: v2024-account-uncorrelated-source +title: AccountUncorrelatedSource +pagination_label: AccountUncorrelatedSource +sidebar_label: AccountUncorrelatedSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUncorrelatedSource', 'V2024AccountUncorrelatedSource'] +slug: /tools/sdk/go/v2024/models/account-uncorrelated-source +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedSource', 'V2024AccountUncorrelatedSource'] +--- + +# AccountUncorrelatedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The DTO type of the source the accounts are uncorrelated from. | +**Id** | **string** | The ID of the source the accounts are uncorrelated from. | +**Name** | **string** | Display name of the source the accounts are uncorrelated from. | + +## Methods + +### NewAccountUncorrelatedSource + +`func NewAccountUncorrelatedSource(type_ string, id string, name string, ) *AccountUncorrelatedSource` + +NewAccountUncorrelatedSource instantiates a new AccountUncorrelatedSource 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 + +### NewAccountUncorrelatedSourceWithDefaults + +`func NewAccountUncorrelatedSourceWithDefaults() *AccountUncorrelatedSource` + +NewAccountUncorrelatedSourceWithDefaults instantiates a new AccountUncorrelatedSource 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 + +### GetType + +`func (o *AccountUncorrelatedSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountUncorrelatedSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountUncorrelatedSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountUncorrelatedSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountUncorrelatedSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountUncorrelatedSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountUncorrelatedSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountUncorrelatedSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountUncorrelatedSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountUnlockRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountUnlockRequest.md new file mode 100644 index 000000000..02cd97866 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountUnlockRequest.md @@ -0,0 +1,116 @@ +--- +id: v2024-account-unlock-request +title: AccountUnlockRequest +pagination_label: AccountUnlockRequest +sidebar_label: AccountUnlockRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUnlockRequest', 'V2024AccountUnlockRequest'] +slug: /tools/sdk/go/v2024/models/account-unlock-request +tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'V2024AccountUnlockRequest'] +--- + +# AccountUnlockRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExternalVerificationId** | Pointer to **string** | If set, an external process validates that the user wants to proceed with this request. | [optional] +**UnlockIDNAccount** | Pointer to **bool** | If set, the IDN account is unlocked after the workflow completes. | [optional] +**ForceProvisioning** | Pointer to **bool** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional] + +## Methods + +### NewAccountUnlockRequest + +`func NewAccountUnlockRequest() *AccountUnlockRequest` + +NewAccountUnlockRequest instantiates a new AccountUnlockRequest 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 + +### NewAccountUnlockRequestWithDefaults + +`func NewAccountUnlockRequestWithDefaults() *AccountUnlockRequest` + +NewAccountUnlockRequestWithDefaults instantiates a new AccountUnlockRequest 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 + +### GetExternalVerificationId + +`func (o *AccountUnlockRequest) GetExternalVerificationId() string` + +GetExternalVerificationId returns the ExternalVerificationId field if non-nil, zero value otherwise. + +### GetExternalVerificationIdOk + +`func (o *AccountUnlockRequest) GetExternalVerificationIdOk() (*string, bool)` + +GetExternalVerificationIdOk returns a tuple with the ExternalVerificationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExternalVerificationId + +`func (o *AccountUnlockRequest) SetExternalVerificationId(v string)` + +SetExternalVerificationId sets ExternalVerificationId field to given value. + +### HasExternalVerificationId + +`func (o *AccountUnlockRequest) HasExternalVerificationId() bool` + +HasExternalVerificationId returns a boolean if a field has been set. + +### GetUnlockIDNAccount + +`func (o *AccountUnlockRequest) GetUnlockIDNAccount() bool` + +GetUnlockIDNAccount returns the UnlockIDNAccount field if non-nil, zero value otherwise. + +### GetUnlockIDNAccountOk + +`func (o *AccountUnlockRequest) GetUnlockIDNAccountOk() (*bool, bool)` + +GetUnlockIDNAccountOk returns a tuple with the UnlockIDNAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnlockIDNAccount + +`func (o *AccountUnlockRequest) SetUnlockIDNAccount(v bool)` + +SetUnlockIDNAccount sets UnlockIDNAccount field to given value. + +### HasUnlockIDNAccount + +`func (o *AccountUnlockRequest) HasUnlockIDNAccount() bool` + +HasUnlockIDNAccount returns a boolean if a field has been set. + +### GetForceProvisioning + +`func (o *AccountUnlockRequest) GetForceProvisioning() bool` + +GetForceProvisioning returns the ForceProvisioning field if non-nil, zero value otherwise. + +### GetForceProvisioningOk + +`func (o *AccountUnlockRequest) GetForceProvisioningOk() (*bool, bool)` + +GetForceProvisioningOk returns a tuple with the ForceProvisioning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForceProvisioning + +`func (o *AccountUnlockRequest) SetForceProvisioning(v bool)` + +SetForceProvisioning sets ForceProvisioning field to given value. + +### HasForceProvisioning + +`func (o *AccountUnlockRequest) HasForceProvisioning() bool` + +HasForceProvisioning returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountUsage.md new file mode 100644 index 000000000..f953833a2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountUsage.md @@ -0,0 +1,90 @@ +--- +id: v2024-account-usage +title: AccountUsage +pagination_label: AccountUsage +sidebar_label: AccountUsage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUsage', 'V2024AccountUsage'] +slug: /tools/sdk/go/v2024/models/account-usage +tags: ['SDK', 'Software Development Kit', 'AccountUsage', 'V2024AccountUsage'] +--- + +# AccountUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **string** | The first day of the month for which activity is aggregated. | [optional] +**Count** | Pointer to **int64** | The number of days within the month that the account was active in a source. | [optional] + +## Methods + +### NewAccountUsage + +`func NewAccountUsage() *AccountUsage` + +NewAccountUsage instantiates a new AccountUsage 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 + +### NewAccountUsageWithDefaults + +`func NewAccountUsageWithDefaults() *AccountUsage` + +NewAccountUsageWithDefaults instantiates a new AccountUsage 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 + +### GetDate + +`func (o *AccountUsage) GetDate() string` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *AccountUsage) GetDateOk() (*string, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *AccountUsage) SetDate(v string)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *AccountUsage) HasDate() bool` + +HasDate returns a boolean if a field has been set. + +### GetCount + +`func (o *AccountUsage) GetCount() int64` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *AccountUsage) GetCountOk() (*int64, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *AccountUsage) SetCount(v int64)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *AccountUsage) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountsAsyncResult.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountsAsyncResult.md new file mode 100644 index 000000000..920601387 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountsAsyncResult.md @@ -0,0 +1,59 @@ +--- +id: v2024-accounts-async-result +title: AccountsAsyncResult +pagination_label: AccountsAsyncResult +sidebar_label: AccountsAsyncResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsAsyncResult', 'V2024AccountsAsyncResult'] +slug: /tools/sdk/go/v2024/models/accounts-async-result +tags: ['SDK', 'Software Development Kit', 'AccountsAsyncResult', 'V2024AccountsAsyncResult'] +--- + +# AccountsAsyncResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | id of the task | + +## Methods + +### NewAccountsAsyncResult + +`func NewAccountsAsyncResult(id string, ) *AccountsAsyncResult` + +NewAccountsAsyncResult instantiates a new AccountsAsyncResult 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 + +### NewAccountsAsyncResultWithDefaults + +`func NewAccountsAsyncResultWithDefaults() *AccountsAsyncResult` + +NewAccountsAsyncResultWithDefaults instantiates a new AccountsAsyncResult 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 + +### GetId + +`func (o *AccountsAsyncResult) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountsAsyncResult) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountsAsyncResult) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountsCollectedForAggregation.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountsCollectedForAggregation.md new file mode 100644 index 000000000..1184a80f8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountsCollectedForAggregation.md @@ -0,0 +1,205 @@ +--- +id: v2024-accounts-collected-for-aggregation +title: AccountsCollectedForAggregation +pagination_label: AccountsCollectedForAggregation +sidebar_label: AccountsCollectedForAggregation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsCollectedForAggregation', 'V2024AccountsCollectedForAggregation'] +slug: /tools/sdk/go/v2024/models/accounts-collected-for-aggregation +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregation', 'V2024AccountsCollectedForAggregation'] +--- + +# AccountsCollectedForAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**AccountsCollectedForAggregationSource**](accounts-collected-for-aggregation-source) | | +**Status** | **map[string]interface{}** | The overall status of the collection. | +**Started** | **SailPointTime** | The date and time when the account collection started. | +**Completed** | **SailPointTime** | The date and time when the account collection finished. | +**Errors** | **[]string** | A list of errors that occurred during the collection. | +**Warnings** | **[]string** | A list of warnings that occurred during the collection. | +**Stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | + +## Methods + +### NewAccountsCollectedForAggregation + +`func NewAccountsCollectedForAggregation(source AccountsCollectedForAggregationSource, status map[string]interface{}, started SailPointTime, completed SailPointTime, errors []string, warnings []string, stats AccountsCollectedForAggregationStats, ) *AccountsCollectedForAggregation` + +NewAccountsCollectedForAggregation instantiates a new AccountsCollectedForAggregation 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 + +### NewAccountsCollectedForAggregationWithDefaults + +`func NewAccountsCollectedForAggregationWithDefaults() *AccountsCollectedForAggregation` + +NewAccountsCollectedForAggregationWithDefaults instantiates a new AccountsCollectedForAggregation 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 + +### GetSource + +`func (o *AccountsCollectedForAggregation) GetSource() AccountsCollectedForAggregationSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountsCollectedForAggregation) GetSourceOk() (*AccountsCollectedForAggregationSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountsCollectedForAggregation) SetSource(v AccountsCollectedForAggregationSource)` + +SetSource sets Source field to given value. + + +### GetStatus + +`func (o *AccountsCollectedForAggregation) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountsCollectedForAggregation) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountsCollectedForAggregation) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + +### GetStarted + +`func (o *AccountsCollectedForAggregation) GetStarted() SailPointTime` + +GetStarted returns the Started field if non-nil, zero value otherwise. + +### GetStartedOk + +`func (o *AccountsCollectedForAggregation) GetStartedOk() (*SailPointTime, bool)` + +GetStartedOk returns a tuple with the Started field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStarted + +`func (o *AccountsCollectedForAggregation) SetStarted(v SailPointTime)` + +SetStarted sets Started field to given value. + + +### GetCompleted + +`func (o *AccountsCollectedForAggregation) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *AccountsCollectedForAggregation) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *AccountsCollectedForAggregation) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + + +### GetErrors + +`func (o *AccountsCollectedForAggregation) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountsCollectedForAggregation) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountsCollectedForAggregation) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + + +### SetErrorsNil + +`func (o *AccountsCollectedForAggregation) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *AccountsCollectedForAggregation) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *AccountsCollectedForAggregation) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *AccountsCollectedForAggregation) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *AccountsCollectedForAggregation) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + + +### SetWarningsNil + +`func (o *AccountsCollectedForAggregation) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *AccountsCollectedForAggregation) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetStats + +`func (o *AccountsCollectedForAggregation) GetStats() AccountsCollectedForAggregationStats` + +GetStats returns the Stats field if non-nil, zero value otherwise. + +### GetStatsOk + +`func (o *AccountsCollectedForAggregation) GetStatsOk() (*AccountsCollectedForAggregationStats, bool)` + +GetStatsOk returns a tuple with the Stats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStats + +`func (o *AccountsCollectedForAggregation) SetStats(v AccountsCollectedForAggregationStats)` + +SetStats sets Stats field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountsCollectedForAggregationSource.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountsCollectedForAggregationSource.md new file mode 100644 index 000000000..8a5185043 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountsCollectedForAggregationSource.md @@ -0,0 +1,101 @@ +--- +id: v2024-accounts-collected-for-aggregation-source +title: AccountsCollectedForAggregationSource +pagination_label: AccountsCollectedForAggregationSource +sidebar_label: AccountsCollectedForAggregationSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsCollectedForAggregationSource', 'V2024AccountsCollectedForAggregationSource'] +slug: /tools/sdk/go/v2024/models/accounts-collected-for-aggregation-source +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationSource', 'V2024AccountsCollectedForAggregationSource'] +--- + +# AccountsCollectedForAggregationSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the object to which this reference applies | +**Type** | **string** | The type of object that is referenced | +**Name** | **string** | Human-readable display name of the object to which this reference applies | + +## Methods + +### NewAccountsCollectedForAggregationSource + +`func NewAccountsCollectedForAggregationSource(id string, type_ string, name string, ) *AccountsCollectedForAggregationSource` + +NewAccountsCollectedForAggregationSource instantiates a new AccountsCollectedForAggregationSource 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 + +### NewAccountsCollectedForAggregationSourceWithDefaults + +`func NewAccountsCollectedForAggregationSourceWithDefaults() *AccountsCollectedForAggregationSource` + +NewAccountsCollectedForAggregationSourceWithDefaults instantiates a new AccountsCollectedForAggregationSource 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 + +### GetId + +`func (o *AccountsCollectedForAggregationSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountsCollectedForAggregationSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountsCollectedForAggregationSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *AccountsCollectedForAggregationSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountsCollectedForAggregationSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountsCollectedForAggregationSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetName + +`func (o *AccountsCollectedForAggregationSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountsCollectedForAggregationSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountsCollectedForAggregationSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountsCollectedForAggregationStats.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountsCollectedForAggregationStats.md new file mode 100644 index 000000000..6b214ac57 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountsCollectedForAggregationStats.md @@ -0,0 +1,143 @@ +--- +id: v2024-accounts-collected-for-aggregation-stats +title: AccountsCollectedForAggregationStats +pagination_label: AccountsCollectedForAggregationStats +sidebar_label: AccountsCollectedForAggregationStats +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsCollectedForAggregationStats', 'V2024AccountsCollectedForAggregationStats'] +slug: /tools/sdk/go/v2024/models/accounts-collected-for-aggregation-stats +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationStats', 'V2024AccountsCollectedForAggregationStats'] +--- + +# AccountsCollectedForAggregationStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scanned** | **int32** | The number of accounts which were scanned / iterated over. | +**Unchanged** | **int32** | The number of accounts which existed before, but had no changes. | +**Changed** | **int32** | The number of accounts which existed before, but had changes. | +**Added** | **int32** | The number of accounts which are new - have not existed before. | +**Removed** | **int32** | The number accounts which existed before, but no longer exist (thus getting removed). | + +## Methods + +### NewAccountsCollectedForAggregationStats + +`func NewAccountsCollectedForAggregationStats(scanned int32, unchanged int32, changed int32, added int32, removed int32, ) *AccountsCollectedForAggregationStats` + +NewAccountsCollectedForAggregationStats instantiates a new AccountsCollectedForAggregationStats 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 + +### NewAccountsCollectedForAggregationStatsWithDefaults + +`func NewAccountsCollectedForAggregationStatsWithDefaults() *AccountsCollectedForAggregationStats` + +NewAccountsCollectedForAggregationStatsWithDefaults instantiates a new AccountsCollectedForAggregationStats 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 + +### GetScanned + +`func (o *AccountsCollectedForAggregationStats) GetScanned() int32` + +GetScanned returns the Scanned field if non-nil, zero value otherwise. + +### GetScannedOk + +`func (o *AccountsCollectedForAggregationStats) GetScannedOk() (*int32, bool)` + +GetScannedOk returns a tuple with the Scanned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScanned + +`func (o *AccountsCollectedForAggregationStats) SetScanned(v int32)` + +SetScanned sets Scanned field to given value. + + +### GetUnchanged + +`func (o *AccountsCollectedForAggregationStats) GetUnchanged() int32` + +GetUnchanged returns the Unchanged field if non-nil, zero value otherwise. + +### GetUnchangedOk + +`func (o *AccountsCollectedForAggregationStats) GetUnchangedOk() (*int32, bool)` + +GetUnchangedOk returns a tuple with the Unchanged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnchanged + +`func (o *AccountsCollectedForAggregationStats) SetUnchanged(v int32)` + +SetUnchanged sets Unchanged field to given value. + + +### GetChanged + +`func (o *AccountsCollectedForAggregationStats) GetChanged() int32` + +GetChanged returns the Changed field if non-nil, zero value otherwise. + +### GetChangedOk + +`func (o *AccountsCollectedForAggregationStats) GetChangedOk() (*int32, bool)` + +GetChangedOk returns a tuple with the Changed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanged + +`func (o *AccountsCollectedForAggregationStats) SetChanged(v int32)` + +SetChanged sets Changed field to given value. + + +### GetAdded + +`func (o *AccountsCollectedForAggregationStats) GetAdded() int32` + +GetAdded returns the Added field if non-nil, zero value otherwise. + +### GetAddedOk + +`func (o *AccountsCollectedForAggregationStats) GetAddedOk() (*int32, bool)` + +GetAddedOk returns a tuple with the Added field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAdded + +`func (o *AccountsCollectedForAggregationStats) SetAdded(v int32)` + +SetAdded sets Added field to given value. + + +### GetRemoved + +`func (o *AccountsCollectedForAggregationStats) GetRemoved() int32` + +GetRemoved returns the Removed field if non-nil, zero value otherwise. + +### GetRemovedOk + +`func (o *AccountsCollectedForAggregationStats) GetRemovedOk() (*int32, bool)` + +GetRemovedOk returns a tuple with the Removed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoved + +`func (o *AccountsCollectedForAggregationStats) SetRemoved(v int32)` + +SetRemoved sets Removed field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountsExportReportArguments.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountsExportReportArguments.md new file mode 100644 index 000000000..e39de4a92 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountsExportReportArguments.md @@ -0,0 +1,80 @@ +--- +id: v2024-accounts-export-report-arguments +title: AccountsExportReportArguments +pagination_label: AccountsExportReportArguments +sidebar_label: AccountsExportReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsExportReportArguments', 'V2024AccountsExportReportArguments'] +slug: /tools/sdk/go/v2024/models/accounts-export-report-arguments +tags: ['SDK', 'Software Development Kit', 'AccountsExportReportArguments', 'V2024AccountsExportReportArguments'] +--- + +# AccountsExportReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Application** | **string** | Source ID. | +**SourceName** | **string** | Source name. | + +## Methods + +### NewAccountsExportReportArguments + +`func NewAccountsExportReportArguments(application string, sourceName string, ) *AccountsExportReportArguments` + +NewAccountsExportReportArguments instantiates a new AccountsExportReportArguments 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 + +### NewAccountsExportReportArgumentsWithDefaults + +`func NewAccountsExportReportArgumentsWithDefaults() *AccountsExportReportArguments` + +NewAccountsExportReportArgumentsWithDefaults instantiates a new AccountsExportReportArguments 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 + +### GetApplication + +`func (o *AccountsExportReportArguments) GetApplication() string` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *AccountsExportReportArguments) GetApplicationOk() (*string, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *AccountsExportReportArguments) SetApplication(v string)` + +SetApplication sets Application field to given value. + + +### GetSourceName + +`func (o *AccountsExportReportArguments) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccountsExportReportArguments) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccountsExportReportArguments) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountsSelectionRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountsSelectionRequest.md new file mode 100644 index 000000000..de08a4b61 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountsSelectionRequest.md @@ -0,0 +1,142 @@ +--- +id: v2024-accounts-selection-request +title: AccountsSelectionRequest +pagination_label: AccountsSelectionRequest +sidebar_label: AccountsSelectionRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsSelectionRequest', 'V2024AccountsSelectionRequest'] +slug: /tools/sdk/go/v2024/models/accounts-selection-request +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionRequest', 'V2024AccountsSelectionRequest'] +--- + +# AccountsSelectionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedFor** | **[]string** | A list of Identity IDs for whom the Access is requested. | +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] + +## Methods + +### NewAccountsSelectionRequest + +`func NewAccountsSelectionRequest(requestedFor []string, requestedItems []AccessRequestItem, ) *AccountsSelectionRequest` + +NewAccountsSelectionRequest instantiates a new AccountsSelectionRequest 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 + +### NewAccountsSelectionRequestWithDefaults + +`func NewAccountsSelectionRequestWithDefaults() *AccountsSelectionRequest` + +NewAccountsSelectionRequestWithDefaults instantiates a new AccountsSelectionRequest 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 + +### GetRequestedFor + +`func (o *AccountsSelectionRequest) GetRequestedFor() []string` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccountsSelectionRequest) GetRequestedForOk() (*[]string, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccountsSelectionRequest) SetRequestedFor(v []string)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestType + +`func (o *AccountsSelectionRequest) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *AccountsSelectionRequest) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *AccountsSelectionRequest) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *AccountsSelectionRequest) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *AccountsSelectionRequest) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *AccountsSelectionRequest) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetRequestedItems + +`func (o *AccountsSelectionRequest) GetRequestedItems() []AccessRequestItem` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *AccountsSelectionRequest) GetRequestedItemsOk() (*[]AccessRequestItem, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *AccountsSelectionRequest) SetRequestedItems(v []AccessRequestItem)` + +SetRequestedItems sets RequestedItems field to given value. + + +### GetClientMetadata + +`func (o *AccountsSelectionRequest) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccountsSelectionRequest) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccountsSelectionRequest) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccountsSelectionRequest) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AccountsSelectionResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/AccountsSelectionResponse.md new file mode 100644 index 000000000..e9f28cc4e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AccountsSelectionResponse.md @@ -0,0 +1,64 @@ +--- +id: v2024-accounts-selection-response +title: AccountsSelectionResponse +pagination_label: AccountsSelectionResponse +sidebar_label: AccountsSelectionResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsSelectionResponse', 'V2024AccountsSelectionResponse'] +slug: /tools/sdk/go/v2024/models/accounts-selection-response +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionResponse', 'V2024AccountsSelectionResponse'] +--- + +# AccountsSelectionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identities** | Pointer to [**[]IdentityAccountSelections**](identity-account-selections) | A list of available account selections per identity in the request, for all the requested items | [optional] + +## Methods + +### NewAccountsSelectionResponse + +`func NewAccountsSelectionResponse() *AccountsSelectionResponse` + +NewAccountsSelectionResponse instantiates a new AccountsSelectionResponse 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 + +### NewAccountsSelectionResponseWithDefaults + +`func NewAccountsSelectionResponseWithDefaults() *AccountsSelectionResponse` + +NewAccountsSelectionResponseWithDefaults instantiates a new AccountsSelectionResponse 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 + +### GetIdentities + +`func (o *AccountsSelectionResponse) GetIdentities() []IdentityAccountSelections` + +GetIdentities returns the Identities field if non-nil, zero value otherwise. + +### GetIdentitiesOk + +`func (o *AccountsSelectionResponse) GetIdentitiesOk() (*[]IdentityAccountSelections, bool)` + +GetIdentitiesOk returns a tuple with the Identities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentities + +`func (o *AccountsSelectionResponse) SetIdentities(v []IdentityAccountSelections)` + +SetIdentities sets Identities field to given value. + +### HasIdentities + +`func (o *AccountsSelectionResponse) HasIdentities() bool` + +HasIdentities returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ActivateCampaignOptions.md b/docs/tools/sdk/go/Reference/V2024/Models/ActivateCampaignOptions.md new file mode 100644 index 000000000..aa58719bf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ActivateCampaignOptions.md @@ -0,0 +1,64 @@ +--- +id: v2024-activate-campaign-options +title: ActivateCampaignOptions +pagination_label: ActivateCampaignOptions +sidebar_label: ActivateCampaignOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ActivateCampaignOptions', 'V2024ActivateCampaignOptions'] +slug: /tools/sdk/go/v2024/models/activate-campaign-options +tags: ['SDK', 'Software Development Kit', 'ActivateCampaignOptions', 'V2024ActivateCampaignOptions'] +--- + +# ActivateCampaignOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TimeZone** | Pointer to **string** | The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. | [optional] [default to "Z"] + +## Methods + +### NewActivateCampaignOptions + +`func NewActivateCampaignOptions() *ActivateCampaignOptions` + +NewActivateCampaignOptions instantiates a new ActivateCampaignOptions 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 + +### NewActivateCampaignOptionsWithDefaults + +`func NewActivateCampaignOptionsWithDefaults() *ActivateCampaignOptions` + +NewActivateCampaignOptionsWithDefaults instantiates a new ActivateCampaignOptions 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 + +### GetTimeZone + +`func (o *ActivateCampaignOptions) GetTimeZone() string` + +GetTimeZone returns the TimeZone field if non-nil, zero value otherwise. + +### GetTimeZoneOk + +`func (o *ActivateCampaignOptions) GetTimeZoneOk() (*string, bool)` + +GetTimeZoneOk returns a tuple with the TimeZone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZone + +`func (o *ActivateCampaignOptions) SetTimeZone(v string)` + +SetTimeZone sets TimeZone field to given value. + +### HasTimeZone + +`func (o *ActivateCampaignOptions) HasTimeZone() bool` + +HasTimeZone returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ActivityIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/ActivityIdentity.md new file mode 100644 index 000000000..f802f97ab --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ActivityIdentity.md @@ -0,0 +1,116 @@ +--- +id: v2024-activity-identity +title: ActivityIdentity +pagination_label: ActivityIdentity +sidebar_label: ActivityIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ActivityIdentity', 'V2024ActivityIdentity'] +slug: /tools/sdk/go/v2024/models/activity-identity +tags: ['SDK', 'Software Development Kit', 'ActivityIdentity', 'V2024ActivityIdentity'] +--- + +# ActivityIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**Type** | Pointer to **string** | Type of object | [optional] + +## Methods + +### NewActivityIdentity + +`func NewActivityIdentity() *ActivityIdentity` + +NewActivityIdentity instantiates a new ActivityIdentity 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 + +### NewActivityIdentityWithDefaults + +`func NewActivityIdentityWithDefaults() *ActivityIdentity` + +NewActivityIdentityWithDefaults instantiates a new ActivityIdentity 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 + +### GetId + +`func (o *ActivityIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ActivityIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ActivityIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ActivityIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ActivityIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ActivityIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ActivityIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ActivityIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *ActivityIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ActivityIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ActivityIdentity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ActivityIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ActivityInsights.md b/docs/tools/sdk/go/Reference/V2024/Models/ActivityInsights.md new file mode 100644 index 000000000..ad695d604 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ActivityInsights.md @@ -0,0 +1,116 @@ +--- +id: v2024-activity-insights +title: ActivityInsights +pagination_label: ActivityInsights +sidebar_label: ActivityInsights +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ActivityInsights', 'V2024ActivityInsights'] +slug: /tools/sdk/go/v2024/models/activity-insights +tags: ['SDK', 'Software Development Kit', 'ActivityInsights', 'V2024ActivityInsights'] +--- + +# ActivityInsights + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountID** | Pointer to **string** | UUID of the account | [optional] +**UsageDays** | Pointer to **int32** | The number of days of activity | [optional] +**UsageDaysState** | Pointer to **string** | Status indicating if the activity is complete or unknown | [optional] + +## Methods + +### NewActivityInsights + +`func NewActivityInsights() *ActivityInsights` + +NewActivityInsights instantiates a new ActivityInsights 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 + +### NewActivityInsightsWithDefaults + +`func NewActivityInsightsWithDefaults() *ActivityInsights` + +NewActivityInsightsWithDefaults instantiates a new ActivityInsights 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 + +### GetAccountID + +`func (o *ActivityInsights) GetAccountID() string` + +GetAccountID returns the AccountID field if non-nil, zero value otherwise. + +### GetAccountIDOk + +`func (o *ActivityInsights) GetAccountIDOk() (*string, bool)` + +GetAccountIDOk returns a tuple with the AccountID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountID + +`func (o *ActivityInsights) SetAccountID(v string)` + +SetAccountID sets AccountID field to given value. + +### HasAccountID + +`func (o *ActivityInsights) HasAccountID() bool` + +HasAccountID returns a boolean if a field has been set. + +### GetUsageDays + +`func (o *ActivityInsights) GetUsageDays() int32` + +GetUsageDays returns the UsageDays field if non-nil, zero value otherwise. + +### GetUsageDaysOk + +`func (o *ActivityInsights) GetUsageDaysOk() (*int32, bool)` + +GetUsageDaysOk returns a tuple with the UsageDays field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsageDays + +`func (o *ActivityInsights) SetUsageDays(v int32)` + +SetUsageDays sets UsageDays field to given value. + +### HasUsageDays + +`func (o *ActivityInsights) HasUsageDays() bool` + +HasUsageDays returns a boolean if a field has been set. + +### GetUsageDaysState + +`func (o *ActivityInsights) GetUsageDaysState() string` + +GetUsageDaysState returns the UsageDaysState field if non-nil, zero value otherwise. + +### GetUsageDaysStateOk + +`func (o *ActivityInsights) GetUsageDaysStateOk() (*string, bool)` + +GetUsageDaysStateOk returns a tuple with the UsageDaysState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsageDaysState + +`func (o *ActivityInsights) SetUsageDaysState(v string)` + +SetUsageDaysState sets UsageDaysState field to given value. + +### HasUsageDaysState + +`func (o *ActivityInsights) HasUsageDaysState() bool` + +HasUsageDaysState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AdminReviewReassign.md b/docs/tools/sdk/go/Reference/V2024/Models/AdminReviewReassign.md new file mode 100644 index 000000000..7aa476b84 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AdminReviewReassign.md @@ -0,0 +1,116 @@ +--- +id: v2024-admin-review-reassign +title: AdminReviewReassign +pagination_label: AdminReviewReassign +sidebar_label: AdminReviewReassign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AdminReviewReassign', 'V2024AdminReviewReassign'] +slug: /tools/sdk/go/v2024/models/admin-review-reassign +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassign', 'V2024AdminReviewReassign'] +--- + +# AdminReviewReassign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CertificationIds** | Pointer to **[]string** | List of certification IDs to reassign | [optional] +**ReassignTo** | Pointer to [**AdminReviewReassignReassignTo**](admin-review-reassign-reassign-to) | | [optional] +**Reason** | Pointer to **string** | Comment to explain why the certification was reassigned | [optional] + +## Methods + +### NewAdminReviewReassign + +`func NewAdminReviewReassign() *AdminReviewReassign` + +NewAdminReviewReassign instantiates a new AdminReviewReassign 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 + +### NewAdminReviewReassignWithDefaults + +`func NewAdminReviewReassignWithDefaults() *AdminReviewReassign` + +NewAdminReviewReassignWithDefaults instantiates a new AdminReviewReassign 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 + +### GetCertificationIds + +`func (o *AdminReviewReassign) GetCertificationIds() []string` + +GetCertificationIds returns the CertificationIds field if non-nil, zero value otherwise. + +### GetCertificationIdsOk + +`func (o *AdminReviewReassign) GetCertificationIdsOk() (*[]string, bool)` + +GetCertificationIdsOk returns a tuple with the CertificationIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationIds + +`func (o *AdminReviewReassign) SetCertificationIds(v []string)` + +SetCertificationIds sets CertificationIds field to given value. + +### HasCertificationIds + +`func (o *AdminReviewReassign) HasCertificationIds() bool` + +HasCertificationIds returns a boolean if a field has been set. + +### GetReassignTo + +`func (o *AdminReviewReassign) GetReassignTo() AdminReviewReassignReassignTo` + +GetReassignTo returns the ReassignTo field if non-nil, zero value otherwise. + +### GetReassignToOk + +`func (o *AdminReviewReassign) GetReassignToOk() (*AdminReviewReassignReassignTo, bool)` + +GetReassignToOk returns a tuple with the ReassignTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignTo + +`func (o *AdminReviewReassign) SetReassignTo(v AdminReviewReassignReassignTo)` + +SetReassignTo sets ReassignTo field to given value. + +### HasReassignTo + +`func (o *AdminReviewReassign) HasReassignTo() bool` + +HasReassignTo returns a boolean if a field has been set. + +### GetReason + +`func (o *AdminReviewReassign) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *AdminReviewReassign) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *AdminReviewReassign) SetReason(v string)` + +SetReason sets Reason field to given value. + +### HasReason + +`func (o *AdminReviewReassign) HasReason() bool` + +HasReason returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AdminReviewReassignReassignTo.md b/docs/tools/sdk/go/Reference/V2024/Models/AdminReviewReassignReassignTo.md new file mode 100644 index 000000000..b23c9487b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AdminReviewReassignReassignTo.md @@ -0,0 +1,90 @@ +--- +id: v2024-admin-review-reassign-reassign-to +title: AdminReviewReassignReassignTo +pagination_label: AdminReviewReassignReassignTo +sidebar_label: AdminReviewReassignReassignTo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AdminReviewReassignReassignTo', 'V2024AdminReviewReassignReassignTo'] +slug: /tools/sdk/go/v2024/models/admin-review-reassign-reassign-to +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassignReassignTo', 'V2024AdminReviewReassignReassignTo'] +--- + +# AdminReviewReassignReassignTo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity ID to which the review is being assigned. | [optional] +**Type** | Pointer to **string** | The type of the ID provided. | [optional] + +## Methods + +### NewAdminReviewReassignReassignTo + +`func NewAdminReviewReassignReassignTo() *AdminReviewReassignReassignTo` + +NewAdminReviewReassignReassignTo instantiates a new AdminReviewReassignReassignTo 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 + +### NewAdminReviewReassignReassignToWithDefaults + +`func NewAdminReviewReassignReassignToWithDefaults() *AdminReviewReassignReassignTo` + +NewAdminReviewReassignReassignToWithDefaults instantiates a new AdminReviewReassignReassignTo 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 + +### GetId + +`func (o *AdminReviewReassignReassignTo) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AdminReviewReassignReassignTo) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AdminReviewReassignReassignTo) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AdminReviewReassignReassignTo) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AdminReviewReassignReassignTo) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AdminReviewReassignReassignTo) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AdminReviewReassignReassignTo) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AdminReviewReassignReassignTo) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AggregationResult.md b/docs/tools/sdk/go/Reference/V2024/Models/AggregationResult.md new file mode 100644 index 000000000..2dc771f66 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AggregationResult.md @@ -0,0 +1,90 @@ +--- +id: v2024-aggregation-result +title: AggregationResult +pagination_label: AggregationResult +sidebar_label: AggregationResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AggregationResult', 'V2024AggregationResult'] +slug: /tools/sdk/go/v2024/models/aggregation-result +tags: ['SDK', 'Software Development Kit', 'AggregationResult', 'V2024AggregationResult'] +--- + +# AggregationResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Aggregations** | Pointer to **map[string]interface{}** | The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. | [optional] +**Hits** | Pointer to **[]map[string]interface{}** | The results of the aggregation search query. | [optional] + +## Methods + +### NewAggregationResult + +`func NewAggregationResult() *AggregationResult` + +NewAggregationResult instantiates a new AggregationResult 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 + +### NewAggregationResultWithDefaults + +`func NewAggregationResultWithDefaults() *AggregationResult` + +NewAggregationResultWithDefaults instantiates a new AggregationResult 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 + +### GetAggregations + +`func (o *AggregationResult) GetAggregations() map[string]interface{}` + +GetAggregations returns the Aggregations field if non-nil, zero value otherwise. + +### GetAggregationsOk + +`func (o *AggregationResult) GetAggregationsOk() (*map[string]interface{}, bool)` + +GetAggregationsOk returns a tuple with the Aggregations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregations + +`func (o *AggregationResult) SetAggregations(v map[string]interface{})` + +SetAggregations sets Aggregations field to given value. + +### HasAggregations + +`func (o *AggregationResult) HasAggregations() bool` + +HasAggregations returns a boolean if a field has been set. + +### GetHits + +`func (o *AggregationResult) GetHits() []map[string]interface{}` + +GetHits returns the Hits field if non-nil, zero value otherwise. + +### GetHitsOk + +`func (o *AggregationResult) GetHitsOk() (*[]map[string]interface{}, bool)` + +GetHitsOk returns a tuple with the Hits field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHits + +`func (o *AggregationResult) SetHits(v []map[string]interface{})` + +SetHits sets Hits field to given value. + +### HasHits + +`func (o *AggregationResult) HasHits() bool` + +HasHits returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AggregationType.md b/docs/tools/sdk/go/Reference/V2024/Models/AggregationType.md new file mode 100644 index 000000000..bb6ae3c26 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AggregationType.md @@ -0,0 +1,21 @@ +--- +id: v2024-aggregation-type +title: AggregationType +pagination_label: AggregationType +sidebar_label: AggregationType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AggregationType', 'V2024AggregationType'] +slug: /tools/sdk/go/v2024/models/aggregation-type +tags: ['SDK', 'Software Development Kit', 'AggregationType', 'V2024AggregationType'] +--- + +# AggregationType + +## Enum + + +* `DSL` (value: `"DSL"`) + +* `SAILPOINT` (value: `"SAILPOINT"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Aggregations.md b/docs/tools/sdk/go/Reference/V2024/Models/Aggregations.md new file mode 100644 index 000000000..f3cb9ba70 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Aggregations.md @@ -0,0 +1,142 @@ +--- +id: v2024-aggregations +title: Aggregations +pagination_label: Aggregations +sidebar_label: Aggregations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Aggregations', 'V2024Aggregations'] +slug: /tools/sdk/go/v2024/models/aggregations +tags: ['SDK', 'Software Development Kit', 'Aggregations', 'V2024Aggregations'] +--- + +# Aggregations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional] +**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional] +**Filter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional] +**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional] + +## Methods + +### NewAggregations + +`func NewAggregations() *Aggregations` + +NewAggregations instantiates a new Aggregations 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 + +### NewAggregationsWithDefaults + +`func NewAggregationsWithDefaults() *Aggregations` + +NewAggregationsWithDefaults instantiates a new Aggregations 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 + +### GetNested + +`func (o *Aggregations) GetNested() NestedAggregation` + +GetNested returns the Nested field if non-nil, zero value otherwise. + +### GetNestedOk + +`func (o *Aggregations) GetNestedOk() (*NestedAggregation, bool)` + +GetNestedOk returns a tuple with the Nested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNested + +`func (o *Aggregations) SetNested(v NestedAggregation)` + +SetNested sets Nested field to given value. + +### HasNested + +`func (o *Aggregations) HasNested() bool` + +HasNested returns a boolean if a field has been set. + +### GetMetric + +`func (o *Aggregations) GetMetric() MetricAggregation` + +GetMetric returns the Metric field if non-nil, zero value otherwise. + +### GetMetricOk + +`func (o *Aggregations) GetMetricOk() (*MetricAggregation, bool)` + +GetMetricOk returns a tuple with the Metric field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetric + +`func (o *Aggregations) SetMetric(v MetricAggregation)` + +SetMetric sets Metric field to given value. + +### HasMetric + +`func (o *Aggregations) HasMetric() bool` + +HasMetric returns a boolean if a field has been set. + +### GetFilter + +`func (o *Aggregations) GetFilter() FilterAggregation` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *Aggregations) GetFilterOk() (*FilterAggregation, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *Aggregations) SetFilter(v FilterAggregation)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *Aggregations) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### GetBucket + +`func (o *Aggregations) GetBucket() BucketAggregation` + +GetBucket returns the Bucket field if non-nil, zero value otherwise. + +### GetBucketOk + +`func (o *Aggregations) GetBucketOk() (*BucketAggregation, bool)` + +GetBucketOk returns a tuple with the Bucket field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBucket + +`func (o *Aggregations) SetBucket(v BucketAggregation)` + +SetBucket sets Bucket field to given value. + +### HasBucket + +`func (o *Aggregations) HasBucket() bool` + +HasBucket returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/App.md b/docs/tools/sdk/go/Reference/V2024/Models/App.md new file mode 100644 index 000000000..a9f76eb61 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/App.md @@ -0,0 +1,142 @@ +--- +id: v2024-app +title: App +pagination_label: App +sidebar_label: App +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'App', 'V2024App'] +slug: /tools/sdk/go/v2024/models/app +tags: ['SDK', 'Software Development Kit', 'App', 'V2024App'] +--- + +# App + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**Source** | Pointer to [**Reference**](reference) | | [optional] +**Account** | Pointer to [**AppAllOfAccount**](app-all-of-account) | | [optional] + +## Methods + +### NewApp + +`func NewApp() *App` + +NewApp instantiates a new App 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 + +### NewAppWithDefaults + +`func NewAppWithDefaults() *App` + +NewAppWithDefaults instantiates a new App 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 + +### GetId + +`func (o *App) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *App) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *App) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *App) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *App) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *App) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *App) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *App) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSource + +`func (o *App) GetSource() Reference` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *App) GetSourceOk() (*Reference, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *App) SetSource(v Reference)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *App) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAccount + +`func (o *App) GetAccount() AppAllOfAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *App) GetAccountOk() (*AppAllOfAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *App) SetAccount(v AppAllOfAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *App) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AppAccountDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/AppAccountDetails.md new file mode 100644 index 000000000..8d8453fa0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AppAccountDetails.md @@ -0,0 +1,116 @@ +--- +id: v2024-app-account-details +title: AppAccountDetails +pagination_label: AppAccountDetails +sidebar_label: AppAccountDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AppAccountDetails', 'V2024AppAccountDetails'] +slug: /tools/sdk/go/v2024/models/app-account-details +tags: ['SDK', 'Software Development Kit', 'AppAccountDetails', 'V2024AppAccountDetails'] +--- + +# AppAccountDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AppId** | Pointer to **string** | The source app ID | [optional] +**AppDisplayName** | Pointer to **string** | The source app display name | [optional] +**SourceAccount** | Pointer to [**AppAccountDetailsSourceAccount**](app-account-details-source-account) | | [optional] + +## Methods + +### NewAppAccountDetails + +`func NewAppAccountDetails() *AppAccountDetails` + +NewAppAccountDetails instantiates a new AppAccountDetails 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 + +### NewAppAccountDetailsWithDefaults + +`func NewAppAccountDetailsWithDefaults() *AppAccountDetails` + +NewAppAccountDetailsWithDefaults instantiates a new AppAccountDetails 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 + +### GetAppId + +`func (o *AppAccountDetails) GetAppId() string` + +GetAppId returns the AppId field if non-nil, zero value otherwise. + +### GetAppIdOk + +`func (o *AppAccountDetails) GetAppIdOk() (*string, bool)` + +GetAppIdOk returns a tuple with the AppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppId + +`func (o *AppAccountDetails) SetAppId(v string)` + +SetAppId sets AppId field to given value. + +### HasAppId + +`func (o *AppAccountDetails) HasAppId() bool` + +HasAppId returns a boolean if a field has been set. + +### GetAppDisplayName + +`func (o *AppAccountDetails) GetAppDisplayName() string` + +GetAppDisplayName returns the AppDisplayName field if non-nil, zero value otherwise. + +### GetAppDisplayNameOk + +`func (o *AppAccountDetails) GetAppDisplayNameOk() (*string, bool)` + +GetAppDisplayNameOk returns a tuple with the AppDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppDisplayName + +`func (o *AppAccountDetails) SetAppDisplayName(v string)` + +SetAppDisplayName sets AppDisplayName field to given value. + +### HasAppDisplayName + +`func (o *AppAccountDetails) HasAppDisplayName() bool` + +HasAppDisplayName returns a boolean if a field has been set. + +### GetSourceAccount + +`func (o *AppAccountDetails) GetSourceAccount() AppAccountDetailsSourceAccount` + +GetSourceAccount returns the SourceAccount field if non-nil, zero value otherwise. + +### GetSourceAccountOk + +`func (o *AppAccountDetails) GetSourceAccountOk() (*AppAccountDetailsSourceAccount, bool)` + +GetSourceAccountOk returns a tuple with the SourceAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceAccount + +`func (o *AppAccountDetails) SetSourceAccount(v AppAccountDetailsSourceAccount)` + +SetSourceAccount sets SourceAccount field to given value. + +### HasSourceAccount + +`func (o *AppAccountDetails) HasSourceAccount() bool` + +HasSourceAccount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AppAccountDetailsSourceAccount.md b/docs/tools/sdk/go/Reference/V2024/Models/AppAccountDetailsSourceAccount.md new file mode 100644 index 000000000..51cb9fd7b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AppAccountDetailsSourceAccount.md @@ -0,0 +1,168 @@ +--- +id: v2024-app-account-details-source-account +title: AppAccountDetailsSourceAccount +pagination_label: AppAccountDetailsSourceAccount +sidebar_label: AppAccountDetailsSourceAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AppAccountDetailsSourceAccount', 'V2024AppAccountDetailsSourceAccount'] +slug: /tools/sdk/go/v2024/models/app-account-details-source-account +tags: ['SDK', 'Software Development Kit', 'AppAccountDetailsSourceAccount', 'V2024AppAccountDetailsSourceAccount'] +--- + +# AppAccountDetailsSourceAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The account ID | [optional] +**NativeIdentity** | Pointer to **string** | The native identity of account | [optional] +**DisplayName** | Pointer to **string** | The display name of account | [optional] +**SourceId** | Pointer to **string** | The source ID of account | [optional] +**SourceDisplayName** | Pointer to **string** | The source name of account | [optional] + +## Methods + +### NewAppAccountDetailsSourceAccount + +`func NewAppAccountDetailsSourceAccount() *AppAccountDetailsSourceAccount` + +NewAppAccountDetailsSourceAccount instantiates a new AppAccountDetailsSourceAccount 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 + +### NewAppAccountDetailsSourceAccountWithDefaults + +`func NewAppAccountDetailsSourceAccountWithDefaults() *AppAccountDetailsSourceAccount` + +NewAppAccountDetailsSourceAccountWithDefaults instantiates a new AppAccountDetailsSourceAccount 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 + +### GetId + +`func (o *AppAccountDetailsSourceAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AppAccountDetailsSourceAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AppAccountDetailsSourceAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AppAccountDetailsSourceAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *AppAccountDetailsSourceAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AppAccountDetailsSourceAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AppAccountDetailsSourceAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AppAccountDetailsSourceAccount) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AppAccountDetailsSourceAccount) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AppAccountDetailsSourceAccount) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AppAccountDetailsSourceAccount) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AppAccountDetailsSourceAccount) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AppAccountDetailsSourceAccount) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AppAccountDetailsSourceAccount) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AppAccountDetailsSourceAccount) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AppAccountDetailsSourceAccount) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceDisplayName + +`func (o *AppAccountDetailsSourceAccount) GetSourceDisplayName() string` + +GetSourceDisplayName returns the SourceDisplayName field if non-nil, zero value otherwise. + +### GetSourceDisplayNameOk + +`func (o *AppAccountDetailsSourceAccount) GetSourceDisplayNameOk() (*string, bool)` + +GetSourceDisplayNameOk returns a tuple with the SourceDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceDisplayName + +`func (o *AppAccountDetailsSourceAccount) SetSourceDisplayName(v string)` + +SetSourceDisplayName sets SourceDisplayName field to given value. + +### HasSourceDisplayName + +`func (o *AppAccountDetailsSourceAccount) HasSourceDisplayName() bool` + +HasSourceDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AppAllOfAccount.md b/docs/tools/sdk/go/Reference/V2024/Models/AppAllOfAccount.md new file mode 100644 index 000000000..592673ac4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AppAllOfAccount.md @@ -0,0 +1,90 @@ +--- +id: v2024-app-all-of-account +title: AppAllOfAccount +pagination_label: AppAllOfAccount +sidebar_label: AppAllOfAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AppAllOfAccount', 'V2024AppAllOfAccount'] +slug: /tools/sdk/go/v2024/models/app-all-of-account +tags: ['SDK', 'Software Development Kit', 'AppAllOfAccount', 'V2024AppAllOfAccount'] +--- + +# AppAllOfAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The SailPoint generated unique ID | [optional] +**AccountId** | Pointer to **string** | The account ID generated by the source | [optional] + +## Methods + +### NewAppAllOfAccount + +`func NewAppAllOfAccount() *AppAllOfAccount` + +NewAppAllOfAccount instantiates a new AppAllOfAccount 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 + +### NewAppAllOfAccountWithDefaults + +`func NewAppAllOfAccountWithDefaults() *AppAllOfAccount` + +NewAppAllOfAccountWithDefaults instantiates a new AppAllOfAccount 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 + +### GetId + +`func (o *AppAllOfAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AppAllOfAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AppAllOfAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AppAllOfAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccountId + +`func (o *AppAllOfAccount) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *AppAllOfAccount) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *AppAllOfAccount) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *AppAllOfAccount) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Approval.md b/docs/tools/sdk/go/Reference/V2024/Models/Approval.md new file mode 100644 index 000000000..98ed51a8a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Approval.md @@ -0,0 +1,480 @@ +--- +id: v2024-approval +title: Approval +pagination_label: Approval +sidebar_label: Approval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Approval', 'V2024Approval'] +slug: /tools/sdk/go/v2024/models/approval +tags: ['SDK', 'Software Development Kit', 'Approval', 'V2024Approval'] +--- + +# Approval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalId** | Pointer to **string** | The Approval ID | [optional] +**Approvers** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Object representation of an approver of an approval | [optional] +**CreatedDate** | Pointer to **string** | Date the approval was created | [optional] +**Type** | Pointer to **string** | Type of approval | [optional] +**Name** | Pointer to [**[]ApprovalName**](approval-name) | The name of the approval for a given locale | [optional] +**BatchRequest** | Pointer to [**ApprovalBatch**](approval-batch) | The name of the approval for a given locale | [optional] +**Description** | Pointer to [**[]ApprovalDescription**](approval-description) | The description of the approval for a given locale | [optional] +**Priority** | Pointer to **string** | The priority of the approval | [optional] +**Requester** | Pointer to [**ApprovalIdentity**](approval-identity) | Object representation of the requester of the approval | [optional] +**Comments** | Pointer to [**[]ApprovalComment1**](approval-comment1) | Object representation of a comment on the approval | [optional] +**ApprovedBy** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have approved the approval | [optional] +**RejectedBy** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have rejected the approval | [optional] +**CompletedDate** | Pointer to **string** | Date the approval was completed | [optional] +**ApprovalCriteria** | Pointer to **string** | Criteria that needs to be met for an approval to be marked as approved | [optional] +**Status** | Pointer to **string** | The current status of the approval | [optional] +**AdditionalAttributes** | Pointer to **string** | Json string representing additional attributes known about the object to be approved. | [optional] +**ReferenceData** | Pointer to [**[]ApprovalReference**](approval-reference) | Reference data related to the approval | [optional] + +## Methods + +### NewApproval + +`func NewApproval() *Approval` + +NewApproval instantiates a new Approval 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 + +### NewApprovalWithDefaults + +`func NewApprovalWithDefaults() *Approval` + +NewApprovalWithDefaults instantiates a new Approval 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 + +### GetApprovalId + +`func (o *Approval) GetApprovalId() string` + +GetApprovalId returns the ApprovalId field if non-nil, zero value otherwise. + +### GetApprovalIdOk + +`func (o *Approval) GetApprovalIdOk() (*string, bool)` + +GetApprovalIdOk returns a tuple with the ApprovalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalId + +`func (o *Approval) SetApprovalId(v string)` + +SetApprovalId sets ApprovalId field to given value. + +### HasApprovalId + +`func (o *Approval) HasApprovalId() bool` + +HasApprovalId returns a boolean if a field has been set. + +### GetApprovers + +`func (o *Approval) GetApprovers() []ApprovalIdentity` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *Approval) GetApproversOk() (*[]ApprovalIdentity, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *Approval) SetApprovers(v []ApprovalIdentity)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *Approval) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *Approval) GetCreatedDate() string` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *Approval) GetCreatedDateOk() (*string, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *Approval) SetCreatedDate(v string)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *Approval) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetType + +`func (o *Approval) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Approval) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Approval) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Approval) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *Approval) GetName() []ApprovalName` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Approval) GetNameOk() (*[]ApprovalName, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Approval) SetName(v []ApprovalName)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Approval) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetBatchRequest + +`func (o *Approval) GetBatchRequest() ApprovalBatch` + +GetBatchRequest returns the BatchRequest field if non-nil, zero value otherwise. + +### GetBatchRequestOk + +`func (o *Approval) GetBatchRequestOk() (*ApprovalBatch, bool)` + +GetBatchRequestOk returns a tuple with the BatchRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchRequest + +`func (o *Approval) SetBatchRequest(v ApprovalBatch)` + +SetBatchRequest sets BatchRequest field to given value. + +### HasBatchRequest + +`func (o *Approval) HasBatchRequest() bool` + +HasBatchRequest returns a boolean if a field has been set. + +### GetDescription + +`func (o *Approval) GetDescription() []ApprovalDescription` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Approval) GetDescriptionOk() (*[]ApprovalDescription, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Approval) SetDescription(v []ApprovalDescription)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Approval) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetPriority + +`func (o *Approval) GetPriority() string` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *Approval) GetPriorityOk() (*string, 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 *Approval) SetPriority(v string)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *Approval) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetRequester + +`func (o *Approval) GetRequester() ApprovalIdentity` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *Approval) GetRequesterOk() (*ApprovalIdentity, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *Approval) SetRequester(v ApprovalIdentity)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *Approval) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetComments + +`func (o *Approval) GetComments() []ApprovalComment1` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *Approval) GetCommentsOk() (*[]ApprovalComment1, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *Approval) SetComments(v []ApprovalComment1)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *Approval) HasComments() bool` + +HasComments returns a boolean if a field has been set. + +### GetApprovedBy + +`func (o *Approval) GetApprovedBy() []ApprovalIdentity` + +GetApprovedBy returns the ApprovedBy field if non-nil, zero value otherwise. + +### GetApprovedByOk + +`func (o *Approval) GetApprovedByOk() (*[]ApprovalIdentity, bool)` + +GetApprovedByOk returns a tuple with the ApprovedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovedBy + +`func (o *Approval) SetApprovedBy(v []ApprovalIdentity)` + +SetApprovedBy sets ApprovedBy field to given value. + +### HasApprovedBy + +`func (o *Approval) HasApprovedBy() bool` + +HasApprovedBy returns a boolean if a field has been set. + +### GetRejectedBy + +`func (o *Approval) GetRejectedBy() []ApprovalIdentity` + +GetRejectedBy returns the RejectedBy field if non-nil, zero value otherwise. + +### GetRejectedByOk + +`func (o *Approval) GetRejectedByOk() (*[]ApprovalIdentity, bool)` + +GetRejectedByOk returns a tuple with the RejectedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRejectedBy + +`func (o *Approval) SetRejectedBy(v []ApprovalIdentity)` + +SetRejectedBy sets RejectedBy field to given value. + +### HasRejectedBy + +`func (o *Approval) HasRejectedBy() bool` + +HasRejectedBy returns a boolean if a field has been set. + +### GetCompletedDate + +`func (o *Approval) GetCompletedDate() string` + +GetCompletedDate returns the CompletedDate field if non-nil, zero value otherwise. + +### GetCompletedDateOk + +`func (o *Approval) GetCompletedDateOk() (*string, bool)` + +GetCompletedDateOk returns a tuple with the CompletedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedDate + +`func (o *Approval) SetCompletedDate(v string)` + +SetCompletedDate sets CompletedDate field to given value. + +### HasCompletedDate + +`func (o *Approval) HasCompletedDate() bool` + +HasCompletedDate returns a boolean if a field has been set. + +### GetApprovalCriteria + +`func (o *Approval) GetApprovalCriteria() string` + +GetApprovalCriteria returns the ApprovalCriteria field if non-nil, zero value otherwise. + +### GetApprovalCriteriaOk + +`func (o *Approval) GetApprovalCriteriaOk() (*string, bool)` + +GetApprovalCriteriaOk returns a tuple with the ApprovalCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalCriteria + +`func (o *Approval) SetApprovalCriteria(v string)` + +SetApprovalCriteria sets ApprovalCriteria field to given value. + +### HasApprovalCriteria + +`func (o *Approval) HasApprovalCriteria() bool` + +HasApprovalCriteria returns a boolean if a field has been set. + +### GetStatus + +`func (o *Approval) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Approval) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Approval) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Approval) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetAdditionalAttributes + +`func (o *Approval) GetAdditionalAttributes() string` + +GetAdditionalAttributes returns the AdditionalAttributes field if non-nil, zero value otherwise. + +### GetAdditionalAttributesOk + +`func (o *Approval) GetAdditionalAttributesOk() (*string, bool)` + +GetAdditionalAttributesOk returns a tuple with the AdditionalAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAdditionalAttributes + +`func (o *Approval) SetAdditionalAttributes(v string)` + +SetAdditionalAttributes sets AdditionalAttributes field to given value. + +### HasAdditionalAttributes + +`func (o *Approval) HasAdditionalAttributes() bool` + +HasAdditionalAttributes returns a boolean if a field has been set. + +### GetReferenceData + +`func (o *Approval) GetReferenceData() []ApprovalReference` + +GetReferenceData returns the ReferenceData field if non-nil, zero value otherwise. + +### GetReferenceDataOk + +`func (o *Approval) GetReferenceDataOk() (*[]ApprovalReference, bool)` + +GetReferenceDataOk returns a tuple with the ReferenceData field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReferenceData + +`func (o *Approval) SetReferenceData(v []ApprovalReference)` + +SetReferenceData sets ReferenceData field to given value. + +### HasReferenceData + +`func (o *Approval) HasReferenceData() bool` + +HasReferenceData returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Approval1.md b/docs/tools/sdk/go/Reference/V2024/Models/Approval1.md new file mode 100644 index 000000000..b45300907 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Approval1.md @@ -0,0 +1,204 @@ +--- +id: v2024-approval1 +title: Approval1 +pagination_label: Approval1 +sidebar_label: Approval1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Approval1', 'V2024Approval1'] +slug: /tools/sdk/go/v2024/models/approval1 +tags: ['SDK', 'Software Development Kit', 'Approval1', 'V2024Approval1'] +--- + +# Approval1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comments** | Pointer to [**[]ApprovalComment2**](approval-comment2) | | [optional] +**Modified** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Owner** | Pointer to [**ActivityIdentity**](activity-identity) | | [optional] +**Result** | Pointer to **string** | The result of the approval | [optional] +**AttributeRequest** | Pointer to [**AttributeRequest**](attribute-request) | | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] + +## Methods + +### NewApproval1 + +`func NewApproval1() *Approval1` + +NewApproval1 instantiates a new Approval1 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 + +### NewApproval1WithDefaults + +`func NewApproval1WithDefaults() *Approval1` + +NewApproval1WithDefaults instantiates a new Approval1 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 + +### GetComments + +`func (o *Approval1) GetComments() []ApprovalComment2` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *Approval1) GetCommentsOk() (*[]ApprovalComment2, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *Approval1) SetComments(v []ApprovalComment2)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *Approval1) HasComments() bool` + +HasComments returns a boolean if a field has been set. + +### GetModified + +`func (o *Approval1) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Approval1) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Approval1) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Approval1) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *Approval1) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *Approval1) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetOwner + +`func (o *Approval1) GetOwner() ActivityIdentity` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Approval1) GetOwnerOk() (*ActivityIdentity, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Approval1) SetOwner(v ActivityIdentity)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *Approval1) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetResult + +`func (o *Approval1) GetResult() string` + +GetResult returns the Result field if non-nil, zero value otherwise. + +### GetResultOk + +`func (o *Approval1) GetResultOk() (*string, bool)` + +GetResultOk returns a tuple with the Result field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResult + +`func (o *Approval1) SetResult(v string)` + +SetResult sets Result field to given value. + +### HasResult + +`func (o *Approval1) HasResult() bool` + +HasResult returns a boolean if a field has been set. + +### GetAttributeRequest + +`func (o *Approval1) GetAttributeRequest() AttributeRequest` + +GetAttributeRequest returns the AttributeRequest field if non-nil, zero value otherwise. + +### GetAttributeRequestOk + +`func (o *Approval1) GetAttributeRequestOk() (*AttributeRequest, bool)` + +GetAttributeRequestOk returns a tuple with the AttributeRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeRequest + +`func (o *Approval1) SetAttributeRequest(v AttributeRequest)` + +SetAttributeRequest sets AttributeRequest field to given value. + +### HasAttributeRequest + +`func (o *Approval1) HasAttributeRequest() bool` + +HasAttributeRequest returns a boolean if a field has been set. + +### GetSource + +`func (o *Approval1) GetSource() AccountSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *Approval1) GetSourceOk() (*AccountSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *Approval1) SetSource(v AccountSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *Approval1) HasSource() bool` + +HasSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalBatch.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalBatch.md new file mode 100644 index 000000000..c6e181c38 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalBatch.md @@ -0,0 +1,90 @@ +--- +id: v2024-approval-batch +title: ApprovalBatch +pagination_label: ApprovalBatch +sidebar_label: ApprovalBatch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalBatch', 'V2024ApprovalBatch'] +slug: /tools/sdk/go/v2024/models/approval-batch +tags: ['SDK', 'Software Development Kit', 'ApprovalBatch', 'V2024ApprovalBatch'] +--- + +# ApprovalBatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **string** | ID of the batch | [optional] +**BatchSize** | Pointer to **int64** | How many approvals are going to be in this batch. Defaults to 1 if not provided. | [optional] + +## Methods + +### NewApprovalBatch + +`func NewApprovalBatch() *ApprovalBatch` + +NewApprovalBatch instantiates a new ApprovalBatch 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 + +### NewApprovalBatchWithDefaults + +`func NewApprovalBatchWithDefaults() *ApprovalBatch` + +NewApprovalBatchWithDefaults instantiates a new ApprovalBatch 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 + +### GetBatchId + +`func (o *ApprovalBatch) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *ApprovalBatch) GetBatchIdOk() (*string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchId + +`func (o *ApprovalBatch) SetBatchId(v string)` + +SetBatchId sets BatchId field to given value. + +### HasBatchId + +`func (o *ApprovalBatch) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### GetBatchSize + +`func (o *ApprovalBatch) GetBatchSize() int64` + +GetBatchSize returns the BatchSize field if non-nil, zero value otherwise. + +### GetBatchSizeOk + +`func (o *ApprovalBatch) GetBatchSizeOk() (*int64, bool)` + +GetBatchSizeOk returns a tuple with the BatchSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchSize + +`func (o *ApprovalBatch) SetBatchSize(v int64)` + +SetBatchSize sets BatchSize field to given value. + +### HasBatchSize + +`func (o *ApprovalBatch) HasBatchSize() bool` + +HasBatchSize returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalComment.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalComment.md new file mode 100644 index 000000000..3d06f42a2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalComment.md @@ -0,0 +1,143 @@ +--- +id: v2024-approval-comment +title: ApprovalComment +pagination_label: ApprovalComment +sidebar_label: ApprovalComment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalComment', 'V2024ApprovalComment'] +slug: /tools/sdk/go/v2024/models/approval-comment +tags: ['SDK', 'Software Development Kit', 'ApprovalComment', 'V2024ApprovalComment'] +--- + +# ApprovalComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | **string** | Comment provided either by the approval requester or the approver. | +**Timestamp** | **SailPointTime** | The time when this comment was provided. | +**User** | **string** | Name of the user that provided this comment. | +**Id** | **string** | Id of the user that provided this comment. | +**ChangedToStatus** | **string** | Status transition of the draft. | + +## Methods + +### NewApprovalComment + +`func NewApprovalComment(comment string, timestamp SailPointTime, user string, id string, changedToStatus string, ) *ApprovalComment` + +NewApprovalComment instantiates a new ApprovalComment 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 + +### NewApprovalCommentWithDefaults + +`func NewApprovalCommentWithDefaults() *ApprovalComment` + +NewApprovalCommentWithDefaults instantiates a new ApprovalComment 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 + +### GetComment + +`func (o *ApprovalComment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ApprovalComment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ApprovalComment) SetComment(v string)` + +SetComment sets Comment field to given value. + + +### GetTimestamp + +`func (o *ApprovalComment) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *ApprovalComment) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *ApprovalComment) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + + +### GetUser + +`func (o *ApprovalComment) GetUser() string` + +GetUser returns the User field if non-nil, zero value otherwise. + +### GetUserOk + +`func (o *ApprovalComment) GetUserOk() (*string, bool)` + +GetUserOk returns a tuple with the User field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUser + +`func (o *ApprovalComment) SetUser(v string)` + +SetUser sets User field to given value. + + +### GetId + +`func (o *ApprovalComment) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalComment) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalComment) SetId(v string)` + +SetId sets Id field to given value. + + +### GetChangedToStatus + +`func (o *ApprovalComment) GetChangedToStatus() string` + +GetChangedToStatus returns the ChangedToStatus field if non-nil, zero value otherwise. + +### GetChangedToStatusOk + +`func (o *ApprovalComment) GetChangedToStatusOk() (*string, bool)` + +GetChangedToStatusOk returns a tuple with the ChangedToStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChangedToStatus + +`func (o *ApprovalComment) SetChangedToStatus(v string)` + +SetChangedToStatus sets ChangedToStatus field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalComment1.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalComment1.md new file mode 100644 index 000000000..b6688f83f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalComment1.md @@ -0,0 +1,116 @@ +--- +id: v2024-approval-comment1 +title: ApprovalComment1 +pagination_label: ApprovalComment1 +sidebar_label: ApprovalComment1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalComment1', 'V2024ApprovalComment1'] +slug: /tools/sdk/go/v2024/models/approval-comment1 +tags: ['SDK', 'Software Development Kit', 'ApprovalComment1', 'V2024ApprovalComment1'] +--- + +# ApprovalComment1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Author** | Pointer to [**ApprovalIdentity**](approval-identity) | | [optional] +**Comment** | Pointer to **string** | Comment to be left on an approval | [optional] +**CreatedDate** | Pointer to **string** | Date the comment was created | [optional] + +## Methods + +### NewApprovalComment1 + +`func NewApprovalComment1() *ApprovalComment1` + +NewApprovalComment1 instantiates a new ApprovalComment1 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 + +### NewApprovalComment1WithDefaults + +`func NewApprovalComment1WithDefaults() *ApprovalComment1` + +NewApprovalComment1WithDefaults instantiates a new ApprovalComment1 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 + +### GetAuthor + +`func (o *ApprovalComment1) GetAuthor() ApprovalIdentity` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *ApprovalComment1) GetAuthorOk() (*ApprovalIdentity, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *ApprovalComment1) SetAuthor(v ApprovalIdentity)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *ApprovalComment1) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + +### GetComment + +`func (o *ApprovalComment1) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ApprovalComment1) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ApprovalComment1) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ApprovalComment1) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *ApprovalComment1) GetCreatedDate() string` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *ApprovalComment1) GetCreatedDateOk() (*string, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *ApprovalComment1) SetCreatedDate(v string)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *ApprovalComment1) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalComment2.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalComment2.md new file mode 100644 index 000000000..ab77eaf24 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalComment2.md @@ -0,0 +1,126 @@ +--- +id: v2024-approval-comment2 +title: ApprovalComment2 +pagination_label: ApprovalComment2 +sidebar_label: ApprovalComment2 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalComment2', 'V2024ApprovalComment2'] +slug: /tools/sdk/go/v2024/models/approval-comment2 +tags: ['SDK', 'Software Development Kit', 'ApprovalComment2', 'V2024ApprovalComment2'] +--- + +# ApprovalComment2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | The comment text | [optional] +**Commenter** | Pointer to **string** | The name of the commenter | [optional] +**Date** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] + +## Methods + +### NewApprovalComment2 + +`func NewApprovalComment2() *ApprovalComment2` + +NewApprovalComment2 instantiates a new ApprovalComment2 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 + +### NewApprovalComment2WithDefaults + +`func NewApprovalComment2WithDefaults() *ApprovalComment2` + +NewApprovalComment2WithDefaults instantiates a new ApprovalComment2 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 + +### GetComment + +`func (o *ApprovalComment2) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ApprovalComment2) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ApprovalComment2) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ApprovalComment2) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetCommenter + +`func (o *ApprovalComment2) GetCommenter() string` + +GetCommenter returns the Commenter field if non-nil, zero value otherwise. + +### GetCommenterOk + +`func (o *ApprovalComment2) GetCommenterOk() (*string, bool)` + +GetCommenterOk returns a tuple with the Commenter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommenter + +`func (o *ApprovalComment2) SetCommenter(v string)` + +SetCommenter sets Commenter field to given value. + +### HasCommenter + +`func (o *ApprovalComment2) HasCommenter() bool` + +HasCommenter returns a boolean if a field has been set. + +### GetDate + +`func (o *ApprovalComment2) GetDate() SailPointTime` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *ApprovalComment2) GetDateOk() (*SailPointTime, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *ApprovalComment2) SetDate(v SailPointTime)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *ApprovalComment2) HasDate() bool` + +HasDate returns a boolean if a field has been set. + +### SetDateNil + +`func (o *ApprovalComment2) SetDateNil(b bool)` + + SetDateNil sets the value for Date to be an explicit nil + +### UnsetDate +`func (o *ApprovalComment2) UnsetDate()` + +UnsetDate ensures that no value is present for Date, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalDescription.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalDescription.md new file mode 100644 index 000000000..5afc8cae7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalDescription.md @@ -0,0 +1,90 @@ +--- +id: v2024-approval-description +title: ApprovalDescription +pagination_label: ApprovalDescription +sidebar_label: ApprovalDescription +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalDescription', 'V2024ApprovalDescription'] +slug: /tools/sdk/go/v2024/models/approval-description +tags: ['SDK', 'Software Development Kit', 'ApprovalDescription', 'V2024ApprovalDescription'] +--- + +# ApprovalDescription + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | The description of what the approval is asking for | [optional] +**Locale** | Pointer to **string** | What locale the description of the approval is using | [optional] + +## Methods + +### NewApprovalDescription + +`func NewApprovalDescription() *ApprovalDescription` + +NewApprovalDescription instantiates a new ApprovalDescription 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 + +### NewApprovalDescriptionWithDefaults + +`func NewApprovalDescriptionWithDefaults() *ApprovalDescription` + +NewApprovalDescriptionWithDefaults instantiates a new ApprovalDescription 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 + +### GetValue + +`func (o *ApprovalDescription) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ApprovalDescription) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ApprovalDescription) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ApprovalDescription) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetLocale + +`func (o *ApprovalDescription) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *ApprovalDescription) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *ApprovalDescription) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *ApprovalDescription) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalForwardHistory.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalForwardHistory.md new file mode 100644 index 000000000..146766960 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalForwardHistory.md @@ -0,0 +1,214 @@ +--- +id: v2024-approval-forward-history +title: ApprovalForwardHistory +pagination_label: ApprovalForwardHistory +sidebar_label: ApprovalForwardHistory +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalForwardHistory', 'V2024ApprovalForwardHistory'] +slug: /tools/sdk/go/v2024/models/approval-forward-history +tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory', 'V2024ApprovalForwardHistory'] +--- + +# ApprovalForwardHistory + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OldApproverName** | Pointer to **string** | Display name of approver from whom the approval was forwarded. | [optional] +**NewApproverName** | Pointer to **string** | Display name of approver to whom the approval was forwarded. | [optional] +**Comment** | Pointer to **NullableString** | Comment made while forwarding. | [optional] +**Modified** | Pointer to **SailPointTime** | Time at which approval was forwarded. | [optional] +**ForwarderName** | Pointer to **NullableString** | Display name of forwarder who forwarded the approval. | [optional] +**ReassignmentType** | Pointer to [**ReassignmentType**](reassignment-type) | | [optional] + +## Methods + +### NewApprovalForwardHistory + +`func NewApprovalForwardHistory() *ApprovalForwardHistory` + +NewApprovalForwardHistory instantiates a new ApprovalForwardHistory 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 + +### NewApprovalForwardHistoryWithDefaults + +`func NewApprovalForwardHistoryWithDefaults() *ApprovalForwardHistory` + +NewApprovalForwardHistoryWithDefaults instantiates a new ApprovalForwardHistory 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 + +### GetOldApproverName + +`func (o *ApprovalForwardHistory) GetOldApproverName() string` + +GetOldApproverName returns the OldApproverName field if non-nil, zero value otherwise. + +### GetOldApproverNameOk + +`func (o *ApprovalForwardHistory) GetOldApproverNameOk() (*string, bool)` + +GetOldApproverNameOk returns a tuple with the OldApproverName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOldApproverName + +`func (o *ApprovalForwardHistory) SetOldApproverName(v string)` + +SetOldApproverName sets OldApproverName field to given value. + +### HasOldApproverName + +`func (o *ApprovalForwardHistory) HasOldApproverName() bool` + +HasOldApproverName returns a boolean if a field has been set. + +### GetNewApproverName + +`func (o *ApprovalForwardHistory) GetNewApproverName() string` + +GetNewApproverName returns the NewApproverName field if non-nil, zero value otherwise. + +### GetNewApproverNameOk + +`func (o *ApprovalForwardHistory) GetNewApproverNameOk() (*string, bool)` + +GetNewApproverNameOk returns a tuple with the NewApproverName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewApproverName + +`func (o *ApprovalForwardHistory) SetNewApproverName(v string)` + +SetNewApproverName sets NewApproverName field to given value. + +### HasNewApproverName + +`func (o *ApprovalForwardHistory) HasNewApproverName() bool` + +HasNewApproverName returns a boolean if a field has been set. + +### GetComment + +`func (o *ApprovalForwardHistory) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ApprovalForwardHistory) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ApprovalForwardHistory) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ApprovalForwardHistory) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *ApprovalForwardHistory) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *ApprovalForwardHistory) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetModified + +`func (o *ApprovalForwardHistory) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ApprovalForwardHistory) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ApprovalForwardHistory) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ApprovalForwardHistory) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetForwarderName + +`func (o *ApprovalForwardHistory) GetForwarderName() string` + +GetForwarderName returns the ForwarderName field if non-nil, zero value otherwise. + +### GetForwarderNameOk + +`func (o *ApprovalForwardHistory) GetForwarderNameOk() (*string, bool)` + +GetForwarderNameOk returns a tuple with the ForwarderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwarderName + +`func (o *ApprovalForwardHistory) SetForwarderName(v string)` + +SetForwarderName sets ForwarderName field to given value. + +### HasForwarderName + +`func (o *ApprovalForwardHistory) HasForwarderName() bool` + +HasForwarderName returns a boolean if a field has been set. + +### SetForwarderNameNil + +`func (o *ApprovalForwardHistory) SetForwarderNameNil(b bool)` + + SetForwarderNameNil sets the value for ForwarderName to be an explicit nil + +### UnsetForwarderName +`func (o *ApprovalForwardHistory) UnsetForwarderName()` + +UnsetForwarderName ensures that no value is present for ForwarderName, not even an explicit nil +### GetReassignmentType + +`func (o *ApprovalForwardHistory) GetReassignmentType() ReassignmentType` + +GetReassignmentType returns the ReassignmentType field if non-nil, zero value otherwise. + +### GetReassignmentTypeOk + +`func (o *ApprovalForwardHistory) GetReassignmentTypeOk() (*ReassignmentType, bool)` + +GetReassignmentTypeOk returns a tuple with the ReassignmentType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignmentType + +`func (o *ApprovalForwardHistory) SetReassignmentType(v ReassignmentType)` + +SetReassignmentType sets ReassignmentType field to given value. + +### HasReassignmentType + +`func (o *ApprovalForwardHistory) HasReassignmentType() bool` + +HasReassignmentType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalIdentity.md new file mode 100644 index 000000000..964dd5e9c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalIdentity.md @@ -0,0 +1,116 @@ +--- +id: v2024-approval-identity +title: ApprovalIdentity +pagination_label: ApprovalIdentity +sidebar_label: ApprovalIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalIdentity', 'V2024ApprovalIdentity'] +slug: /tools/sdk/go/v2024/models/approval-identity +tags: ['SDK', 'Software Development Kit', 'ApprovalIdentity', 'V2024ApprovalIdentity'] +--- + +# ApprovalIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity ID | [optional] +**Type** | Pointer to **string** | Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc | [optional] +**Name** | Pointer to **string** | Name of the identity | [optional] + +## Methods + +### NewApprovalIdentity + +`func NewApprovalIdentity() *ApprovalIdentity` + +NewApprovalIdentity instantiates a new ApprovalIdentity 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 + +### NewApprovalIdentityWithDefaults + +`func NewApprovalIdentityWithDefaults() *ApprovalIdentity` + +NewApprovalIdentityWithDefaults instantiates a new ApprovalIdentity 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 + +### GetId + +`func (o *ApprovalIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *ApprovalIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ApprovalIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ApprovalIdentity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ApprovalIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalInfoResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalInfoResponse.md new file mode 100644 index 000000000..19d260e6c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalInfoResponse.md @@ -0,0 +1,116 @@ +--- +id: v2024-approval-info-response +title: ApprovalInfoResponse +pagination_label: ApprovalInfoResponse +sidebar_label: ApprovalInfoResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalInfoResponse', 'V2024ApprovalInfoResponse'] +slug: /tools/sdk/go/v2024/models/approval-info-response +tags: ['SDK', 'Software Development Kit', 'ApprovalInfoResponse', 'V2024ApprovalInfoResponse'] +--- + +# ApprovalInfoResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the id of approver | [optional] +**Name** | Pointer to **string** | the name of approver | [optional] +**Status** | Pointer to **string** | the status of the approval request | [optional] + +## Methods + +### NewApprovalInfoResponse + +`func NewApprovalInfoResponse() *ApprovalInfoResponse` + +NewApprovalInfoResponse instantiates a new ApprovalInfoResponse 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 + +### NewApprovalInfoResponseWithDefaults + +`func NewApprovalInfoResponseWithDefaults() *ApprovalInfoResponse` + +NewApprovalInfoResponseWithDefaults instantiates a new ApprovalInfoResponse 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 + +### GetId + +`func (o *ApprovalInfoResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalInfoResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalInfoResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalInfoResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalInfoResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalInfoResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalInfoResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalInfoResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *ApprovalInfoResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ApprovalInfoResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ApprovalInfoResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ApprovalInfoResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalItemDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalItemDetails.md new file mode 100644 index 000000000..fd35773b5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalItemDetails.md @@ -0,0 +1,250 @@ +--- +id: v2024-approval-item-details +title: ApprovalItemDetails +pagination_label: ApprovalItemDetails +sidebar_label: ApprovalItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalItemDetails', 'V2024ApprovalItemDetails'] +slug: /tools/sdk/go/v2024/models/approval-item-details +tags: ['SDK', 'Software Development Kit', 'ApprovalItemDetails', 'V2024ApprovalItemDetails'] +--- + +# ApprovalItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The approval item's ID | [optional] +**Account** | Pointer to **NullableString** | The account referenced by the approval item | [optional] +**Application** | Pointer to **string** | The name of the application/source | [optional] +**Name** | Pointer to **NullableString** | The attribute's name | [optional] +**Operation** | Pointer to **string** | The attribute's operation | [optional] +**Value** | Pointer to **NullableString** | The attribute's value | [optional] +**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional] + +## Methods + +### NewApprovalItemDetails + +`func NewApprovalItemDetails() *ApprovalItemDetails` + +NewApprovalItemDetails instantiates a new ApprovalItemDetails 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 + +### NewApprovalItemDetailsWithDefaults + +`func NewApprovalItemDetailsWithDefaults() *ApprovalItemDetails` + +NewApprovalItemDetailsWithDefaults instantiates a new ApprovalItemDetails 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 + +### GetId + +`func (o *ApprovalItemDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalItemDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalItemDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalItemDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccount + +`func (o *ApprovalItemDetails) GetAccount() string` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *ApprovalItemDetails) GetAccountOk() (*string, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *ApprovalItemDetails) SetAccount(v string)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *ApprovalItemDetails) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### SetAccountNil + +`func (o *ApprovalItemDetails) SetAccountNil(b bool)` + + SetAccountNil sets the value for Account to be an explicit nil + +### UnsetAccount +`func (o *ApprovalItemDetails) UnsetAccount()` + +UnsetAccount ensures that no value is present for Account, not even an explicit nil +### GetApplication + +`func (o *ApprovalItemDetails) GetApplication() string` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *ApprovalItemDetails) GetApplicationOk() (*string, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *ApprovalItemDetails) SetApplication(v string)` + +SetApplication sets Application field to given value. + +### HasApplication + +`func (o *ApprovalItemDetails) HasApplication() bool` + +HasApplication returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalItemDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalItemDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalItemDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalItemDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ApprovalItemDetails) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ApprovalItemDetails) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetOperation + +`func (o *ApprovalItemDetails) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ApprovalItemDetails) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ApprovalItemDetails) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ApprovalItemDetails) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetValue + +`func (o *ApprovalItemDetails) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ApprovalItemDetails) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ApprovalItemDetails) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ApprovalItemDetails) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ApprovalItemDetails) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ApprovalItemDetails) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetState + +`func (o *ApprovalItemDetails) GetState() WorkItemState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ApprovalItemDetails) GetStateOk() (*WorkItemState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ApprovalItemDetails) SetState(v WorkItemState)` + +SetState sets State field to given value. + +### HasState + +`func (o *ApprovalItemDetails) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalItems.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalItems.md new file mode 100644 index 000000000..901945164 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalItems.md @@ -0,0 +1,250 @@ +--- +id: v2024-approval-items +title: ApprovalItems +pagination_label: ApprovalItems +sidebar_label: ApprovalItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalItems', 'V2024ApprovalItems'] +slug: /tools/sdk/go/v2024/models/approval-items +tags: ['SDK', 'Software Development Kit', 'ApprovalItems', 'V2024ApprovalItems'] +--- + +# ApprovalItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The approval item's ID | [optional] +**Account** | Pointer to **NullableString** | The account referenced by the approval item | [optional] +**Application** | Pointer to **string** | The name of the application/source | [optional] +**Name** | Pointer to **NullableString** | The attribute's name | [optional] +**Operation** | Pointer to **string** | The attribute's operation | [optional] +**Value** | Pointer to **NullableString** | The attribute's value | [optional] +**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional] + +## Methods + +### NewApprovalItems + +`func NewApprovalItems() *ApprovalItems` + +NewApprovalItems instantiates a new ApprovalItems 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 + +### NewApprovalItemsWithDefaults + +`func NewApprovalItemsWithDefaults() *ApprovalItems` + +NewApprovalItemsWithDefaults instantiates a new ApprovalItems 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 + +### GetId + +`func (o *ApprovalItems) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalItems) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalItems) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalItems) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccount + +`func (o *ApprovalItems) GetAccount() string` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *ApprovalItems) GetAccountOk() (*string, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *ApprovalItems) SetAccount(v string)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *ApprovalItems) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### SetAccountNil + +`func (o *ApprovalItems) SetAccountNil(b bool)` + + SetAccountNil sets the value for Account to be an explicit nil + +### UnsetAccount +`func (o *ApprovalItems) UnsetAccount()` + +UnsetAccount ensures that no value is present for Account, not even an explicit nil +### GetApplication + +`func (o *ApprovalItems) GetApplication() string` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *ApprovalItems) GetApplicationOk() (*string, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *ApprovalItems) SetApplication(v string)` + +SetApplication sets Application field to given value. + +### HasApplication + +`func (o *ApprovalItems) HasApplication() bool` + +HasApplication returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalItems) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalItems) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalItems) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalItems) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ApprovalItems) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ApprovalItems) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetOperation + +`func (o *ApprovalItems) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ApprovalItems) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ApprovalItems) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ApprovalItems) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetValue + +`func (o *ApprovalItems) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ApprovalItems) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ApprovalItems) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ApprovalItems) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ApprovalItems) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ApprovalItems) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetState + +`func (o *ApprovalItems) GetState() WorkItemState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ApprovalItems) GetStateOk() (*WorkItemState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ApprovalItems) SetState(v WorkItemState)` + +SetState sets State field to given value. + +### HasState + +`func (o *ApprovalItems) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalName.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalName.md new file mode 100644 index 000000000..68acfdd73 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalName.md @@ -0,0 +1,90 @@ +--- +id: v2024-approval-name +title: ApprovalName +pagination_label: ApprovalName +sidebar_label: ApprovalName +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalName', 'V2024ApprovalName'] +slug: /tools/sdk/go/v2024/models/approval-name +tags: ['SDK', 'Software Development Kit', 'ApprovalName', 'V2024ApprovalName'] +--- + +# ApprovalName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | Name of the approval | [optional] +**Locale** | Pointer to **string** | What locale the name of the approval is using | [optional] + +## Methods + +### NewApprovalName + +`func NewApprovalName() *ApprovalName` + +NewApprovalName instantiates a new ApprovalName 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 + +### NewApprovalNameWithDefaults + +`func NewApprovalNameWithDefaults() *ApprovalName` + +NewApprovalNameWithDefaults instantiates a new ApprovalName 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 + +### GetValue + +`func (o *ApprovalName) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ApprovalName) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ApprovalName) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ApprovalName) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetLocale + +`func (o *ApprovalName) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *ApprovalName) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *ApprovalName) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *ApprovalName) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalReference.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalReference.md new file mode 100644 index 000000000..10b1318c4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalReference.md @@ -0,0 +1,90 @@ +--- +id: v2024-approval-reference +title: ApprovalReference +pagination_label: ApprovalReference +sidebar_label: ApprovalReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalReference', 'V2024ApprovalReference'] +slug: /tools/sdk/go/v2024/models/approval-reference +tags: ['SDK', 'Software Development Kit', 'ApprovalReference', 'V2024ApprovalReference'] +--- + +# ApprovalReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the reference object | [optional] +**Type** | Pointer to **string** | What reference object does this ID correspond to | [optional] + +## Methods + +### NewApprovalReference + +`func NewApprovalReference() *ApprovalReference` + +NewApprovalReference instantiates a new ApprovalReference 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 + +### NewApprovalReferenceWithDefaults + +`func NewApprovalReferenceWithDefaults() *ApprovalReference` + +NewApprovalReferenceWithDefaults instantiates a new ApprovalReference 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 + +### GetId + +`func (o *ApprovalReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *ApprovalReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ApprovalReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ApprovalReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ApprovalReference) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalReminderAndEscalationConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalReminderAndEscalationConfig.md new file mode 100644 index 000000000..e740ec122 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalReminderAndEscalationConfig.md @@ -0,0 +1,182 @@ +--- +id: v2024-approval-reminder-and-escalation-config +title: ApprovalReminderAndEscalationConfig +pagination_label: ApprovalReminderAndEscalationConfig +sidebar_label: ApprovalReminderAndEscalationConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalReminderAndEscalationConfig', 'V2024ApprovalReminderAndEscalationConfig'] +slug: /tools/sdk/go/v2024/models/approval-reminder-and-escalation-config +tags: ['SDK', 'Software Development Kit', 'ApprovalReminderAndEscalationConfig', 'V2024ApprovalReminderAndEscalationConfig'] +--- + +# ApprovalReminderAndEscalationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DaysUntilEscalation** | Pointer to **NullableInt32** | Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. | [optional] +**DaysBetweenReminders** | Pointer to **NullableInt32** | Number of days to wait between reminder notifications. | [optional] +**MaxReminders** | Pointer to **NullableInt32** | Maximum number of reminder notification to send to the reviewer before approval escalation. | [optional] +**FallbackApproverRef** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] + +## Methods + +### NewApprovalReminderAndEscalationConfig + +`func NewApprovalReminderAndEscalationConfig() *ApprovalReminderAndEscalationConfig` + +NewApprovalReminderAndEscalationConfig instantiates a new ApprovalReminderAndEscalationConfig 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 + +### NewApprovalReminderAndEscalationConfigWithDefaults + +`func NewApprovalReminderAndEscalationConfigWithDefaults() *ApprovalReminderAndEscalationConfig` + +NewApprovalReminderAndEscalationConfigWithDefaults instantiates a new ApprovalReminderAndEscalationConfig 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 + +### GetDaysUntilEscalation + +`func (o *ApprovalReminderAndEscalationConfig) GetDaysUntilEscalation() int32` + +GetDaysUntilEscalation returns the DaysUntilEscalation field if non-nil, zero value otherwise. + +### GetDaysUntilEscalationOk + +`func (o *ApprovalReminderAndEscalationConfig) GetDaysUntilEscalationOk() (*int32, bool)` + +GetDaysUntilEscalationOk returns a tuple with the DaysUntilEscalation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDaysUntilEscalation + +`func (o *ApprovalReminderAndEscalationConfig) SetDaysUntilEscalation(v int32)` + +SetDaysUntilEscalation sets DaysUntilEscalation field to given value. + +### HasDaysUntilEscalation + +`func (o *ApprovalReminderAndEscalationConfig) HasDaysUntilEscalation() bool` + +HasDaysUntilEscalation returns a boolean if a field has been set. + +### SetDaysUntilEscalationNil + +`func (o *ApprovalReminderAndEscalationConfig) SetDaysUntilEscalationNil(b bool)` + + SetDaysUntilEscalationNil sets the value for DaysUntilEscalation to be an explicit nil + +### UnsetDaysUntilEscalation +`func (o *ApprovalReminderAndEscalationConfig) UnsetDaysUntilEscalation()` + +UnsetDaysUntilEscalation ensures that no value is present for DaysUntilEscalation, not even an explicit nil +### GetDaysBetweenReminders + +`func (o *ApprovalReminderAndEscalationConfig) GetDaysBetweenReminders() int32` + +GetDaysBetweenReminders returns the DaysBetweenReminders field if non-nil, zero value otherwise. + +### GetDaysBetweenRemindersOk + +`func (o *ApprovalReminderAndEscalationConfig) GetDaysBetweenRemindersOk() (*int32, bool)` + +GetDaysBetweenRemindersOk returns a tuple with the DaysBetweenReminders field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDaysBetweenReminders + +`func (o *ApprovalReminderAndEscalationConfig) SetDaysBetweenReminders(v int32)` + +SetDaysBetweenReminders sets DaysBetweenReminders field to given value. + +### HasDaysBetweenReminders + +`func (o *ApprovalReminderAndEscalationConfig) HasDaysBetweenReminders() bool` + +HasDaysBetweenReminders returns a boolean if a field has been set. + +### SetDaysBetweenRemindersNil + +`func (o *ApprovalReminderAndEscalationConfig) SetDaysBetweenRemindersNil(b bool)` + + SetDaysBetweenRemindersNil sets the value for DaysBetweenReminders to be an explicit nil + +### UnsetDaysBetweenReminders +`func (o *ApprovalReminderAndEscalationConfig) UnsetDaysBetweenReminders()` + +UnsetDaysBetweenReminders ensures that no value is present for DaysBetweenReminders, not even an explicit nil +### GetMaxReminders + +`func (o *ApprovalReminderAndEscalationConfig) GetMaxReminders() int32` + +GetMaxReminders returns the MaxReminders field if non-nil, zero value otherwise. + +### GetMaxRemindersOk + +`func (o *ApprovalReminderAndEscalationConfig) GetMaxRemindersOk() (*int32, bool)` + +GetMaxRemindersOk returns a tuple with the MaxReminders field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxReminders + +`func (o *ApprovalReminderAndEscalationConfig) SetMaxReminders(v int32)` + +SetMaxReminders sets MaxReminders field to given value. + +### HasMaxReminders + +`func (o *ApprovalReminderAndEscalationConfig) HasMaxReminders() bool` + +HasMaxReminders returns a boolean if a field has been set. + +### SetMaxRemindersNil + +`func (o *ApprovalReminderAndEscalationConfig) SetMaxRemindersNil(b bool)` + + SetMaxRemindersNil sets the value for MaxReminders to be an explicit nil + +### UnsetMaxReminders +`func (o *ApprovalReminderAndEscalationConfig) UnsetMaxReminders()` + +UnsetMaxReminders ensures that no value is present for MaxReminders, not even an explicit nil +### GetFallbackApproverRef + +`func (o *ApprovalReminderAndEscalationConfig) GetFallbackApproverRef() IdentityReferenceWithNameAndEmail` + +GetFallbackApproverRef returns the FallbackApproverRef field if non-nil, zero value otherwise. + +### GetFallbackApproverRefOk + +`func (o *ApprovalReminderAndEscalationConfig) GetFallbackApproverRefOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetFallbackApproverRefOk returns a tuple with the FallbackApproverRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFallbackApproverRef + +`func (o *ApprovalReminderAndEscalationConfig) SetFallbackApproverRef(v IdentityReferenceWithNameAndEmail)` + +SetFallbackApproverRef sets FallbackApproverRef field to given value. + +### HasFallbackApproverRef + +`func (o *ApprovalReminderAndEscalationConfig) HasFallbackApproverRef() bool` + +HasFallbackApproverRef returns a boolean if a field has been set. + +### SetFallbackApproverRefNil + +`func (o *ApprovalReminderAndEscalationConfig) SetFallbackApproverRefNil(b bool)` + + SetFallbackApproverRefNil sets the value for FallbackApproverRef to be an explicit nil + +### UnsetFallbackApproverRef +`func (o *ApprovalReminderAndEscalationConfig) UnsetFallbackApproverRef()` + +UnsetFallbackApproverRef ensures that no value is present for FallbackApproverRef, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalScheme.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalScheme.md new file mode 100644 index 000000000..2060b01cb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalScheme.md @@ -0,0 +1,31 @@ +--- +id: v2024-approval-scheme +title: ApprovalScheme +pagination_label: ApprovalScheme +sidebar_label: ApprovalScheme +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalScheme', 'V2024ApprovalScheme'] +slug: /tools/sdk/go/v2024/models/approval-scheme +tags: ['SDK', 'Software Development Kit', 'ApprovalScheme', 'V2024ApprovalScheme'] +--- + +# ApprovalScheme + +## Enum + + +* `APP_OWNER` (value: `"APP_OWNER"`) + +* `SOURCE_OWNER` (value: `"SOURCE_OWNER"`) + +* `MANAGER` (value: `"MANAGER"`) + +* `ROLE_OWNER` (value: `"ROLE_OWNER"`) + +* `ACCESS_PROFILE_OWNER` (value: `"ACCESS_PROFILE_OWNER"`) + +* `ENTITLEMENT_OWNER` (value: `"ENTITLEMENT_OWNER"`) + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalSchemeForRole.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalSchemeForRole.md new file mode 100644 index 000000000..d126efc4c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalSchemeForRole.md @@ -0,0 +1,100 @@ +--- +id: v2024-approval-scheme-for-role +title: ApprovalSchemeForRole +pagination_label: ApprovalSchemeForRole +sidebar_label: ApprovalSchemeForRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalSchemeForRole', 'V2024ApprovalSchemeForRole'] +slug: /tools/sdk/go/v2024/models/approval-scheme-for-role +tags: ['SDK', 'Software Development Kit', 'ApprovalSchemeForRole', 'V2024ApprovalSchemeForRole'] +--- + +# ApprovalSchemeForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApproverType** | Pointer to **string** | Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | Pointer to **NullableString** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] + +## Methods + +### NewApprovalSchemeForRole + +`func NewApprovalSchemeForRole() *ApprovalSchemeForRole` + +NewApprovalSchemeForRole instantiates a new ApprovalSchemeForRole 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 + +### NewApprovalSchemeForRoleWithDefaults + +`func NewApprovalSchemeForRoleWithDefaults() *ApprovalSchemeForRole` + +NewApprovalSchemeForRoleWithDefaults instantiates a new ApprovalSchemeForRole 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 + +### GetApproverType + +`func (o *ApprovalSchemeForRole) GetApproverType() string` + +GetApproverType returns the ApproverType field if non-nil, zero value otherwise. + +### GetApproverTypeOk + +`func (o *ApprovalSchemeForRole) GetApproverTypeOk() (*string, bool)` + +GetApproverTypeOk returns a tuple with the ApproverType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverType + +`func (o *ApprovalSchemeForRole) SetApproverType(v string)` + +SetApproverType sets ApproverType field to given value. + +### HasApproverType + +`func (o *ApprovalSchemeForRole) HasApproverType() bool` + +HasApproverType returns a boolean if a field has been set. + +### GetApproverId + +`func (o *ApprovalSchemeForRole) GetApproverId() string` + +GetApproverId returns the ApproverId field if non-nil, zero value otherwise. + +### GetApproverIdOk + +`func (o *ApprovalSchemeForRole) GetApproverIdOk() (*string, bool)` + +GetApproverIdOk returns a tuple with the ApproverId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverId + +`func (o *ApprovalSchemeForRole) SetApproverId(v string)` + +SetApproverId sets ApproverId field to given value. + +### HasApproverId + +`func (o *ApprovalSchemeForRole) HasApproverId() bool` + +HasApproverId returns a boolean if a field has been set. + +### SetApproverIdNil + +`func (o *ApprovalSchemeForRole) SetApproverIdNil(b bool)` + + SetApproverIdNil sets the value for ApproverId to be an explicit nil + +### UnsetApproverId +`func (o *ApprovalSchemeForRole) UnsetApproverId()` + +UnsetApproverId ensures that no value is present for ApproverId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalStatus.md new file mode 100644 index 000000000..8ed402c24 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalStatus.md @@ -0,0 +1,27 @@ +--- +id: v2024-approval-status +title: ApprovalStatus +pagination_label: ApprovalStatus +sidebar_label: ApprovalStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalStatus', 'V2024ApprovalStatus'] +slug: /tools/sdk/go/v2024/models/approval-status +tags: ['SDK', 'Software Development Kit', 'ApprovalStatus', 'V2024ApprovalStatus'] +--- + +# ApprovalStatus + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `PENDING` (value: `"PENDING"`) + +* `NOT_READY` (value: `"NOT_READY"`) + +* `CANCELLED` (value: `"CANCELLED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalStatusDto.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalStatusDto.md new file mode 100644 index 000000000..ca9da6579 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalStatusDto.md @@ -0,0 +1,312 @@ +--- +id: v2024-approval-status-dto +title: ApprovalStatusDto +pagination_label: ApprovalStatusDto +sidebar_label: ApprovalStatusDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalStatusDto', 'V2024ApprovalStatusDto'] +slug: /tools/sdk/go/v2024/models/approval-status-dto +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto', 'V2024ApprovalStatusDto'] +--- + +# ApprovalStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Forwarded** | Pointer to **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to false] +**OriginalOwner** | Pointer to [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional] +**CurrentOwner** | Pointer to [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional] +**Modified** | Pointer to **NullableTime** | Time at which item was modified. | [optional] +**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**Scheme** | Pointer to [**ApprovalScheme**](approval-scheme) | | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | If the request failed, includes any error messages that were generated. | [optional] +**Comment** | Pointer to **NullableString** | Comment, if any, provided by the approver. | [optional] +**RemoveDate** | Pointer to **NullableTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] + +## Methods + +### NewApprovalStatusDto + +`func NewApprovalStatusDto() *ApprovalStatusDto` + +NewApprovalStatusDto instantiates a new ApprovalStatusDto 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 + +### NewApprovalStatusDtoWithDefaults + +`func NewApprovalStatusDtoWithDefaults() *ApprovalStatusDto` + +NewApprovalStatusDtoWithDefaults instantiates a new ApprovalStatusDto 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 + +### GetForwarded + +`func (o *ApprovalStatusDto) GetForwarded() bool` + +GetForwarded returns the Forwarded field if non-nil, zero value otherwise. + +### GetForwardedOk + +`func (o *ApprovalStatusDto) GetForwardedOk() (*bool, bool)` + +GetForwardedOk returns a tuple with the Forwarded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwarded + +`func (o *ApprovalStatusDto) SetForwarded(v bool)` + +SetForwarded sets Forwarded field to given value. + +### HasForwarded + +`func (o *ApprovalStatusDto) HasForwarded() bool` + +HasForwarded returns a boolean if a field has been set. + +### GetOriginalOwner + +`func (o *ApprovalStatusDto) GetOriginalOwner() ApprovalStatusDtoOriginalOwner` + +GetOriginalOwner returns the OriginalOwner field if non-nil, zero value otherwise. + +### GetOriginalOwnerOk + +`func (o *ApprovalStatusDto) GetOriginalOwnerOk() (*ApprovalStatusDtoOriginalOwner, bool)` + +GetOriginalOwnerOk returns a tuple with the OriginalOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalOwner + +`func (o *ApprovalStatusDto) SetOriginalOwner(v ApprovalStatusDtoOriginalOwner)` + +SetOriginalOwner sets OriginalOwner field to given value. + +### HasOriginalOwner + +`func (o *ApprovalStatusDto) HasOriginalOwner() bool` + +HasOriginalOwner returns a boolean if a field has been set. + +### GetCurrentOwner + +`func (o *ApprovalStatusDto) GetCurrentOwner() ApprovalStatusDtoCurrentOwner` + +GetCurrentOwner returns the CurrentOwner field if non-nil, zero value otherwise. + +### GetCurrentOwnerOk + +`func (o *ApprovalStatusDto) GetCurrentOwnerOk() (*ApprovalStatusDtoCurrentOwner, bool)` + +GetCurrentOwnerOk returns a tuple with the CurrentOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentOwner + +`func (o *ApprovalStatusDto) SetCurrentOwner(v ApprovalStatusDtoCurrentOwner)` + +SetCurrentOwner sets CurrentOwner field to given value. + +### HasCurrentOwner + +`func (o *ApprovalStatusDto) HasCurrentOwner() bool` + +HasCurrentOwner returns a boolean if a field has been set. + +### GetModified + +`func (o *ApprovalStatusDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ApprovalStatusDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ApprovalStatusDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ApprovalStatusDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *ApprovalStatusDto) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *ApprovalStatusDto) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetStatus + +`func (o *ApprovalStatusDto) GetStatus() ManualWorkItemState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ApprovalStatusDto) GetStatusOk() (*ManualWorkItemState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ApprovalStatusDto) SetStatus(v ManualWorkItemState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ApprovalStatusDto) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetScheme + +`func (o *ApprovalStatusDto) GetScheme() ApprovalScheme` + +GetScheme returns the Scheme field if non-nil, zero value otherwise. + +### GetSchemeOk + +`func (o *ApprovalStatusDto) GetSchemeOk() (*ApprovalScheme, bool)` + +GetSchemeOk returns a tuple with the Scheme field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheme + +`func (o *ApprovalStatusDto) SetScheme(v ApprovalScheme)` + +SetScheme sets Scheme field to given value. + +### HasScheme + +`func (o *ApprovalStatusDto) HasScheme() bool` + +HasScheme returns a boolean if a field has been set. + +### GetErrorMessages + +`func (o *ApprovalStatusDto) GetErrorMessages() []ErrorMessageDto` + +GetErrorMessages returns the ErrorMessages field if non-nil, zero value otherwise. + +### GetErrorMessagesOk + +`func (o *ApprovalStatusDto) GetErrorMessagesOk() (*[]ErrorMessageDto, bool)` + +GetErrorMessagesOk returns a tuple with the ErrorMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessages + +`func (o *ApprovalStatusDto) SetErrorMessages(v []ErrorMessageDto)` + +SetErrorMessages sets ErrorMessages field to given value. + +### HasErrorMessages + +`func (o *ApprovalStatusDto) HasErrorMessages() bool` + +HasErrorMessages returns a boolean if a field has been set. + +### SetErrorMessagesNil + +`func (o *ApprovalStatusDto) SetErrorMessagesNil(b bool)` + + SetErrorMessagesNil sets the value for ErrorMessages to be an explicit nil + +### UnsetErrorMessages +`func (o *ApprovalStatusDto) UnsetErrorMessages()` + +UnsetErrorMessages ensures that no value is present for ErrorMessages, not even an explicit nil +### GetComment + +`func (o *ApprovalStatusDto) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ApprovalStatusDto) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ApprovalStatusDto) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ApprovalStatusDto) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *ApprovalStatusDto) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *ApprovalStatusDto) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetRemoveDate + +`func (o *ApprovalStatusDto) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *ApprovalStatusDto) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *ApprovalStatusDto) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *ApprovalStatusDto) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *ApprovalStatusDto) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *ApprovalStatusDto) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalStatusDtoCurrentOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalStatusDtoCurrentOwner.md new file mode 100644 index 000000000..2f288c1a8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalStatusDtoCurrentOwner.md @@ -0,0 +1,116 @@ +--- +id: v2024-approval-status-dto-current-owner +title: ApprovalStatusDtoCurrentOwner +pagination_label: ApprovalStatusDtoCurrentOwner +sidebar_label: ApprovalStatusDtoCurrentOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalStatusDtoCurrentOwner', 'V2024ApprovalStatusDtoCurrentOwner'] +slug: /tools/sdk/go/v2024/models/approval-status-dto-current-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoCurrentOwner', 'V2024ApprovalStatusDtoCurrentOwner'] +--- + +# ApprovalStatusDtoCurrentOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity who reviewed the access item request. | [optional] +**Id** | Pointer to **string** | ID of identity who reviewed the access item request. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity who reviewed the access item request. | [optional] + +## Methods + +### NewApprovalStatusDtoCurrentOwner + +`func NewApprovalStatusDtoCurrentOwner() *ApprovalStatusDtoCurrentOwner` + +NewApprovalStatusDtoCurrentOwner instantiates a new ApprovalStatusDtoCurrentOwner 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 + +### NewApprovalStatusDtoCurrentOwnerWithDefaults + +`func NewApprovalStatusDtoCurrentOwnerWithDefaults() *ApprovalStatusDtoCurrentOwner` + +NewApprovalStatusDtoCurrentOwnerWithDefaults instantiates a new ApprovalStatusDtoCurrentOwner 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 + +### GetType + +`func (o *ApprovalStatusDtoCurrentOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ApprovalStatusDtoCurrentOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ApprovalStatusDtoCurrentOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ApprovalStatusDtoCurrentOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ApprovalStatusDtoCurrentOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalStatusDtoCurrentOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalStatusDtoCurrentOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalStatusDtoCurrentOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalStatusDtoCurrentOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalStatusDtoCurrentOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalStatusDtoCurrentOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalStatusDtoCurrentOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalStatusDtoOriginalOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalStatusDtoOriginalOwner.md new file mode 100644 index 000000000..2a1e22af6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalStatusDtoOriginalOwner.md @@ -0,0 +1,116 @@ +--- +id: v2024-approval-status-dto-original-owner +title: ApprovalStatusDtoOriginalOwner +pagination_label: ApprovalStatusDtoOriginalOwner +sidebar_label: ApprovalStatusDtoOriginalOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalStatusDtoOriginalOwner', 'V2024ApprovalStatusDtoOriginalOwner'] +slug: /tools/sdk/go/v2024/models/approval-status-dto-original-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoOriginalOwner', 'V2024ApprovalStatusDtoOriginalOwner'] +--- + +# ApprovalStatusDtoOriginalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of original approval owner's identity. | [optional] +**Id** | Pointer to **string** | ID of original approval owner's identity. | [optional] +**Name** | Pointer to **string** | Display name of original approval owner. | [optional] + +## Methods + +### NewApprovalStatusDtoOriginalOwner + +`func NewApprovalStatusDtoOriginalOwner() *ApprovalStatusDtoOriginalOwner` + +NewApprovalStatusDtoOriginalOwner instantiates a new ApprovalStatusDtoOriginalOwner 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 + +### NewApprovalStatusDtoOriginalOwnerWithDefaults + +`func NewApprovalStatusDtoOriginalOwnerWithDefaults() *ApprovalStatusDtoOriginalOwner` + +NewApprovalStatusDtoOriginalOwnerWithDefaults instantiates a new ApprovalStatusDtoOriginalOwner 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 + +### GetType + +`func (o *ApprovalStatusDtoOriginalOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ApprovalStatusDtoOriginalOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ApprovalStatusDtoOriginalOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ApprovalStatusDtoOriginalOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ApprovalStatusDtoOriginalOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalStatusDtoOriginalOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalStatusDtoOriginalOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalStatusDtoOriginalOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalStatusDtoOriginalOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalStatusDtoOriginalOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalStatusDtoOriginalOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalStatusDtoOriginalOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ApprovalSummary.md b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalSummary.md new file mode 100644 index 000000000..4ce53d4da --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ApprovalSummary.md @@ -0,0 +1,116 @@ +--- +id: v2024-approval-summary +title: ApprovalSummary +pagination_label: ApprovalSummary +sidebar_label: ApprovalSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalSummary', 'V2024ApprovalSummary'] +slug: /tools/sdk/go/v2024/models/approval-summary +tags: ['SDK', 'Software Development Kit', 'ApprovalSummary', 'V2024ApprovalSummary'] +--- + +# ApprovalSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Pending** | Pointer to **int32** | The number of pending access requests approvals. | [optional] +**Approved** | Pointer to **int32** | The number of approved access requests approvals. | [optional] +**Rejected** | Pointer to **int32** | The number of rejected access requests approvals. | [optional] + +## Methods + +### NewApprovalSummary + +`func NewApprovalSummary() *ApprovalSummary` + +NewApprovalSummary instantiates a new ApprovalSummary 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 + +### NewApprovalSummaryWithDefaults + +`func NewApprovalSummaryWithDefaults() *ApprovalSummary` + +NewApprovalSummaryWithDefaults instantiates a new ApprovalSummary 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 + +### GetPending + +`func (o *ApprovalSummary) GetPending() int32` + +GetPending returns the Pending field if non-nil, zero value otherwise. + +### GetPendingOk + +`func (o *ApprovalSummary) GetPendingOk() (*int32, bool)` + +GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPending + +`func (o *ApprovalSummary) SetPending(v int32)` + +SetPending sets Pending field to given value. + +### HasPending + +`func (o *ApprovalSummary) HasPending() bool` + +HasPending returns a boolean if a field has been set. + +### GetApproved + +`func (o *ApprovalSummary) GetApproved() int32` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *ApprovalSummary) GetApprovedOk() (*int32, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *ApprovalSummary) SetApproved(v int32)` + +SetApproved sets Approved field to given value. + +### HasApproved + +`func (o *ApprovalSummary) HasApproved() bool` + +HasApproved returns a boolean if a field has been set. + +### GetRejected + +`func (o *ApprovalSummary) GetRejected() int32` + +GetRejected returns the Rejected field if non-nil, zero value otherwise. + +### GetRejectedOk + +`func (o *ApprovalSummary) GetRejectedOk() (*int32, bool)` + +GetRejectedOk returns a tuple with the Rejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRejected + +`func (o *ApprovalSummary) SetRejected(v int32)` + +SetRejected sets Rejected field to given value. + +### HasRejected + +`func (o *ApprovalSummary) HasRejected() bool` + +HasRejected returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Argument.md b/docs/tools/sdk/go/Reference/V2024/Models/Argument.md new file mode 100644 index 000000000..14bdb27ca --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Argument.md @@ -0,0 +1,131 @@ +--- +id: v2024-argument +title: Argument +pagination_label: Argument +sidebar_label: Argument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Argument', 'V2024Argument'] +slug: /tools/sdk/go/v2024/models/argument +tags: ['SDK', 'Software Development Kit', 'Argument', 'V2024Argument'] +--- + +# Argument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | the name of the argument | +**Description** | Pointer to **NullableString** | the description of the argument | [optional] +**Type** | Pointer to **NullableString** | the programmatic type of the argument | [optional] + +## Methods + +### NewArgument + +`func NewArgument(name string, ) *Argument` + +NewArgument instantiates a new Argument 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 + +### NewArgumentWithDefaults + +`func NewArgumentWithDefaults() *Argument` + +NewArgumentWithDefaults instantiates a new Argument 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 + +### GetName + +`func (o *Argument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Argument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Argument) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Argument) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Argument) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Argument) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Argument) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Argument) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Argument) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *Argument) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Argument) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Argument) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Argument) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *Argument) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *Argument) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ArrayInner.md b/docs/tools/sdk/go/Reference/V2024/Models/ArrayInner.md new file mode 100644 index 000000000..b9170ab4c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ArrayInner.md @@ -0,0 +1,38 @@ +--- +id: v2024-array-inner +title: ArrayInner +pagination_label: ArrayInner +sidebar_label: ArrayInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ArrayInner', 'V2024ArrayInner'] +slug: /tools/sdk/go/v2024/models/array-inner +tags: ['SDK', 'Software Development Kit', 'ArrayInner', 'V2024ArrayInner'] +--- + +# ArrayInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewArrayInner + +`func NewArrayInner() *ArrayInner` + +NewArrayInner instantiates a new ArrayInner 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 + +### NewArrayInnerWithDefaults + +`func NewArrayInnerWithDefaults() *ArrayInner` + +NewArrayInnerWithDefaults instantiates a new ArrayInner 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 + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AssignmentContextDto.md b/docs/tools/sdk/go/Reference/V2024/Models/AssignmentContextDto.md new file mode 100644 index 000000000..f20d54138 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AssignmentContextDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-assignment-context-dto +title: AssignmentContextDto +pagination_label: AssignmentContextDto +sidebar_label: AssignmentContextDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AssignmentContextDto', 'V2024AssignmentContextDto'] +slug: /tools/sdk/go/v2024/models/assignment-context-dto +tags: ['SDK', 'Software Development Kit', 'AssignmentContextDto', 'V2024AssignmentContextDto'] +--- + +# AssignmentContextDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Requested** | Pointer to [**AccessRequestContext**](access-request-context) | | [optional] +**Matched** | Pointer to [**[]RoleMatchDto**](role-match-dto) | | [optional] +**ComputedDate** | Pointer to **string** | Date that the assignment will was evaluated | [optional] + +## Methods + +### NewAssignmentContextDto + +`func NewAssignmentContextDto() *AssignmentContextDto` + +NewAssignmentContextDto instantiates a new AssignmentContextDto 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 + +### NewAssignmentContextDtoWithDefaults + +`func NewAssignmentContextDtoWithDefaults() *AssignmentContextDto` + +NewAssignmentContextDtoWithDefaults instantiates a new AssignmentContextDto 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 + +### GetRequested + +`func (o *AssignmentContextDto) GetRequested() AccessRequestContext` + +GetRequested returns the Requested field if non-nil, zero value otherwise. + +### GetRequestedOk + +`func (o *AssignmentContextDto) GetRequestedOk() (*AccessRequestContext, bool)` + +GetRequestedOk returns a tuple with the Requested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequested + +`func (o *AssignmentContextDto) SetRequested(v AccessRequestContext)` + +SetRequested sets Requested field to given value. + +### HasRequested + +`func (o *AssignmentContextDto) HasRequested() bool` + +HasRequested returns a boolean if a field has been set. + +### GetMatched + +`func (o *AssignmentContextDto) GetMatched() []RoleMatchDto` + +GetMatched returns the Matched field if non-nil, zero value otherwise. + +### GetMatchedOk + +`func (o *AssignmentContextDto) GetMatchedOk() (*[]RoleMatchDto, bool)` + +GetMatchedOk returns a tuple with the Matched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatched + +`func (o *AssignmentContextDto) SetMatched(v []RoleMatchDto)` + +SetMatched sets Matched field to given value. + +### HasMatched + +`func (o *AssignmentContextDto) HasMatched() bool` + +HasMatched returns a boolean if a field has been set. + +### GetComputedDate + +`func (o *AssignmentContextDto) GetComputedDate() string` + +GetComputedDate returns the ComputedDate field if non-nil, zero value otherwise. + +### GetComputedDateOk + +`func (o *AssignmentContextDto) GetComputedDateOk() (*string, bool)` + +GetComputedDateOk returns a tuple with the ComputedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComputedDate + +`func (o *AssignmentContextDto) SetComputedDate(v string)` + +SetComputedDate sets ComputedDate field to given value. + +### HasComputedDate + +`func (o *AssignmentContextDto) HasComputedDate() bool` + +HasComputedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttrSyncSource.md b/docs/tools/sdk/go/Reference/V2024/Models/AttrSyncSource.md new file mode 100644 index 000000000..c58ad999c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttrSyncSource.md @@ -0,0 +1,126 @@ +--- +id: v2024-attr-sync-source +title: AttrSyncSource +pagination_label: AttrSyncSource +sidebar_label: AttrSyncSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttrSyncSource', 'V2024AttrSyncSource'] +slug: /tools/sdk/go/v2024/models/attr-sync-source +tags: ['SDK', 'Software Development Kit', 'AttrSyncSource', 'V2024AttrSyncSource'] +--- + +# AttrSyncSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of target source for attribute synchronization. | [optional] +**Id** | Pointer to **string** | ID of target source for attribute synchronization. | [optional] +**Name** | Pointer to **NullableString** | Human-readable name of target source for attribute synchronization. | [optional] + +## Methods + +### NewAttrSyncSource + +`func NewAttrSyncSource() *AttrSyncSource` + +NewAttrSyncSource instantiates a new AttrSyncSource 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 + +### NewAttrSyncSourceWithDefaults + +`func NewAttrSyncSourceWithDefaults() *AttrSyncSource` + +NewAttrSyncSourceWithDefaults instantiates a new AttrSyncSource 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 + +### GetType + +`func (o *AttrSyncSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttrSyncSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttrSyncSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttrSyncSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AttrSyncSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AttrSyncSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AttrSyncSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AttrSyncSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AttrSyncSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttrSyncSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttrSyncSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttrSyncSource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *AttrSyncSource) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *AttrSyncSource) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttrSyncSourceAttributeConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/AttrSyncSourceAttributeConfig.md new file mode 100644 index 000000000..727eeb1c9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttrSyncSourceAttributeConfig.md @@ -0,0 +1,122 @@ +--- +id: v2024-attr-sync-source-attribute-config +title: AttrSyncSourceAttributeConfig +pagination_label: AttrSyncSourceAttributeConfig +sidebar_label: AttrSyncSourceAttributeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttrSyncSourceAttributeConfig', 'V2024AttrSyncSourceAttributeConfig'] +slug: /tools/sdk/go/v2024/models/attr-sync-source-attribute-config +tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceAttributeConfig', 'V2024AttrSyncSourceAttributeConfig'] +--- + +# AttrSyncSourceAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Name of the identity attribute | +**DisplayName** | **string** | Display name of the identity attribute | +**Enabled** | **bool** | Determines whether or not the attribute is enabled for synchronization | +**Target** | **string** | Name of the source account attribute to which the identity attribute value will be synchronized if enabled | + +## Methods + +### NewAttrSyncSourceAttributeConfig + +`func NewAttrSyncSourceAttributeConfig(name string, displayName string, enabled bool, target string, ) *AttrSyncSourceAttributeConfig` + +NewAttrSyncSourceAttributeConfig instantiates a new AttrSyncSourceAttributeConfig 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 + +### NewAttrSyncSourceAttributeConfigWithDefaults + +`func NewAttrSyncSourceAttributeConfigWithDefaults() *AttrSyncSourceAttributeConfig` + +NewAttrSyncSourceAttributeConfigWithDefaults instantiates a new AttrSyncSourceAttributeConfig 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 + +### GetName + +`func (o *AttrSyncSourceAttributeConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttrSyncSourceAttributeConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttrSyncSourceAttributeConfig) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDisplayName + +`func (o *AttrSyncSourceAttributeConfig) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AttrSyncSourceAttributeConfig) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AttrSyncSourceAttributeConfig) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + + +### GetEnabled + +`func (o *AttrSyncSourceAttributeConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AttrSyncSourceAttributeConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AttrSyncSourceAttributeConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetTarget + +`func (o *AttrSyncSourceAttributeConfig) GetTarget() string` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *AttrSyncSourceAttributeConfig) GetTargetOk() (*string, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *AttrSyncSourceAttributeConfig) SetTarget(v string)` + +SetTarget sets Target field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttrSyncSourceConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/AttrSyncSourceConfig.md new file mode 100644 index 000000000..91f7b188f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttrSyncSourceConfig.md @@ -0,0 +1,80 @@ +--- +id: v2024-attr-sync-source-config +title: AttrSyncSourceConfig +pagination_label: AttrSyncSourceConfig +sidebar_label: AttrSyncSourceConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttrSyncSourceConfig', 'V2024AttrSyncSourceConfig'] +slug: /tools/sdk/go/v2024/models/attr-sync-source-config +tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceConfig', 'V2024AttrSyncSourceConfig'] +--- + +# AttrSyncSourceConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**AttrSyncSource**](attr-sync-source) | | +**Attributes** | [**[]AttrSyncSourceAttributeConfig**](attr-sync-source-attribute-config) | Attribute synchronization configuration for specific identity attributes in the context of a source | + +## Methods + +### NewAttrSyncSourceConfig + +`func NewAttrSyncSourceConfig(source AttrSyncSource, attributes []AttrSyncSourceAttributeConfig, ) *AttrSyncSourceConfig` + +NewAttrSyncSourceConfig instantiates a new AttrSyncSourceConfig 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 + +### NewAttrSyncSourceConfigWithDefaults + +`func NewAttrSyncSourceConfigWithDefaults() *AttrSyncSourceConfig` + +NewAttrSyncSourceConfigWithDefaults instantiates a new AttrSyncSourceConfig 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 + +### GetSource + +`func (o *AttrSyncSourceConfig) GetSource() AttrSyncSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AttrSyncSourceConfig) GetSourceOk() (*AttrSyncSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AttrSyncSourceConfig) SetSource(v AttrSyncSource)` + +SetSource sets Source field to given value. + + +### GetAttributes + +`func (o *AttrSyncSourceConfig) GetAttributes() []AttrSyncSourceAttributeConfig` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AttrSyncSourceConfig) GetAttributesOk() (*[]AttrSyncSourceAttributeConfig, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AttrSyncSourceConfig) SetAttributes(v []AttrSyncSourceAttributeConfig)` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttributeChange.md b/docs/tools/sdk/go/Reference/V2024/Models/AttributeChange.md new file mode 100644 index 000000000..963e45976 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttributeChange.md @@ -0,0 +1,116 @@ +--- +id: v2024-attribute-change +title: AttributeChange +pagination_label: AttributeChange +sidebar_label: AttributeChange +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeChange', 'V2024AttributeChange'] +slug: /tools/sdk/go/v2024/models/attribute-change +tags: ['SDK', 'Software Development Kit', 'AttributeChange', 'V2024AttributeChange'] +--- + +# AttributeChange + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | the attribute name | [optional] +**PreviousValue** | Pointer to **string** | the old value of attribute | [optional] +**NewValue** | Pointer to **string** | the new value of attribute | [optional] + +## Methods + +### NewAttributeChange + +`func NewAttributeChange() *AttributeChange` + +NewAttributeChange instantiates a new AttributeChange 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 + +### NewAttributeChangeWithDefaults + +`func NewAttributeChangeWithDefaults() *AttributeChange` + +NewAttributeChangeWithDefaults instantiates a new AttributeChange 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 + +### GetName + +`func (o *AttributeChange) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeChange) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeChange) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeChange) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPreviousValue + +`func (o *AttributeChange) GetPreviousValue() string` + +GetPreviousValue returns the PreviousValue field if non-nil, zero value otherwise. + +### GetPreviousValueOk + +`func (o *AttributeChange) GetPreviousValueOk() (*string, bool)` + +GetPreviousValueOk returns a tuple with the PreviousValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousValue + +`func (o *AttributeChange) SetPreviousValue(v string)` + +SetPreviousValue sets PreviousValue field to given value. + +### HasPreviousValue + +`func (o *AttributeChange) HasPreviousValue() bool` + +HasPreviousValue returns a boolean if a field has been set. + +### GetNewValue + +`func (o *AttributeChange) GetNewValue() string` + +GetNewValue returns the NewValue field if non-nil, zero value otherwise. + +### GetNewValueOk + +`func (o *AttributeChange) GetNewValueOk() (*string, bool)` + +GetNewValueOk returns a tuple with the NewValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewValue + +`func (o *AttributeChange) SetNewValue(v string)` + +SetNewValue sets NewValue field to given value. + +### HasNewValue + +`func (o *AttributeChange) HasNewValue() bool` + +HasNewValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttributeDTO.md b/docs/tools/sdk/go/Reference/V2024/Models/AttributeDTO.md new file mode 100644 index 000000000..371eddb54 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttributeDTO.md @@ -0,0 +1,266 @@ +--- +id: v2024-attribute-dto +title: AttributeDTO +pagination_label: AttributeDTO +sidebar_label: AttributeDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDTO', 'V2024AttributeDTO'] +slug: /tools/sdk/go/v2024/models/attribute-dto +tags: ['SDK', 'Software Development Kit', 'AttributeDTO', 'V2024AttributeDTO'] +--- + +# AttributeDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [optional] +**Name** | Pointer to **string** | The display name of the key. | [optional] +**Multiselect** | Pointer to **bool** | Indicates whether the attribute can have multiple values. | [optional] [default to false] +**Status** | Pointer to **string** | The status of the Attribute. | [optional] +**Type** | Pointer to **string** | The type of the Attribute. This can be either \"custom\" or \"governance\". | [optional] +**ObjectTypes** | Pointer to **[]string** | An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. | [optional] +**Description** | Pointer to **string** | The description of the Attribute. | [optional] +**Values** | Pointer to [**[]AttributeValueDTO**](attribute-value-dto) | | [optional] + +## Methods + +### NewAttributeDTO + +`func NewAttributeDTO() *AttributeDTO` + +NewAttributeDTO instantiates a new AttributeDTO 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 + +### NewAttributeDTOWithDefaults + +`func NewAttributeDTOWithDefaults() *AttributeDTO` + +NewAttributeDTOWithDefaults instantiates a new AttributeDTO 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 + +### GetKey + +`func (o *AttributeDTO) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *AttributeDTO) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *AttributeDTO) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *AttributeDTO) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *AttributeDTO) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeDTO) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeDTO) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeDTO) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetMultiselect + +`func (o *AttributeDTO) GetMultiselect() bool` + +GetMultiselect returns the Multiselect field if non-nil, zero value otherwise. + +### GetMultiselectOk + +`func (o *AttributeDTO) GetMultiselectOk() (*bool, bool)` + +GetMultiselectOk returns a tuple with the Multiselect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultiselect + +`func (o *AttributeDTO) SetMultiselect(v bool)` + +SetMultiselect sets Multiselect field to given value. + +### HasMultiselect + +`func (o *AttributeDTO) HasMultiselect() bool` + +HasMultiselect returns a boolean if a field has been set. + +### GetStatus + +`func (o *AttributeDTO) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AttributeDTO) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AttributeDTO) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AttributeDTO) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetType + +`func (o *AttributeDTO) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttributeDTO) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttributeDTO) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttributeDTO) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetObjectTypes + +`func (o *AttributeDTO) GetObjectTypes() []string` + +GetObjectTypes returns the ObjectTypes field if non-nil, zero value otherwise. + +### GetObjectTypesOk + +`func (o *AttributeDTO) GetObjectTypesOk() (*[]string, bool)` + +GetObjectTypesOk returns a tuple with the ObjectTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectTypes + +`func (o *AttributeDTO) SetObjectTypes(v []string)` + +SetObjectTypes sets ObjectTypes field to given value. + +### HasObjectTypes + +`func (o *AttributeDTO) HasObjectTypes() bool` + +HasObjectTypes returns a boolean if a field has been set. + +### SetObjectTypesNil + +`func (o *AttributeDTO) SetObjectTypesNil(b bool)` + + SetObjectTypesNil sets the value for ObjectTypes to be an explicit nil + +### UnsetObjectTypes +`func (o *AttributeDTO) UnsetObjectTypes()` + +UnsetObjectTypes ensures that no value is present for ObjectTypes, not even an explicit nil +### GetDescription + +`func (o *AttributeDTO) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AttributeDTO) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AttributeDTO) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AttributeDTO) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetValues + +`func (o *AttributeDTO) GetValues() []AttributeValueDTO` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *AttributeDTO) GetValuesOk() (*[]AttributeValueDTO, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *AttributeDTO) SetValues(v []AttributeValueDTO)` + +SetValues sets Values field to given value. + +### HasValues + +`func (o *AttributeDTO) HasValues() bool` + +HasValues returns a boolean if a field has been set. + +### SetValuesNil + +`func (o *AttributeDTO) SetValuesNil(b bool)` + + SetValuesNil sets the value for Values to be an explicit nil + +### UnsetValues +`func (o *AttributeDTO) UnsetValues()` + +UnsetValues ensures that no value is present for Values, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttributeDTOList.md b/docs/tools/sdk/go/Reference/V2024/Models/AttributeDTOList.md new file mode 100644 index 000000000..680bd854e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttributeDTOList.md @@ -0,0 +1,74 @@ +--- +id: v2024-attribute-dto-list +title: AttributeDTOList +pagination_label: AttributeDTOList +sidebar_label: AttributeDTOList +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDTOList', 'V2024AttributeDTOList'] +slug: /tools/sdk/go/v2024/models/attribute-dto-list +tags: ['SDK', 'Software Development Kit', 'AttributeDTOList', 'V2024AttributeDTOList'] +--- + +# AttributeDTOList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]AttributeDTO**](attribute-dto) | | [optional] + +## Methods + +### NewAttributeDTOList + +`func NewAttributeDTOList() *AttributeDTOList` + +NewAttributeDTOList instantiates a new AttributeDTOList 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 + +### NewAttributeDTOListWithDefaults + +`func NewAttributeDTOListWithDefaults() *AttributeDTOList` + +NewAttributeDTOListWithDefaults instantiates a new AttributeDTOList 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 + +### GetAttributes + +`func (o *AttributeDTOList) GetAttributes() []AttributeDTO` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AttributeDTOList) GetAttributesOk() (*[]AttributeDTO, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AttributeDTOList) SetAttributes(v []AttributeDTO)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *AttributeDTOList) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *AttributeDTOList) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *AttributeDTOList) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttributeDefinition.md b/docs/tools/sdk/go/Reference/V2024/Models/AttributeDefinition.md new file mode 100644 index 000000000..27b225edf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttributeDefinition.md @@ -0,0 +1,230 @@ +--- +id: v2024-attribute-definition +title: AttributeDefinition +pagination_label: AttributeDefinition +sidebar_label: AttributeDefinition +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDefinition', 'V2024AttributeDefinition'] +slug: /tools/sdk/go/v2024/models/attribute-definition +tags: ['SDK', 'Software Development Kit', 'AttributeDefinition', 'V2024AttributeDefinition'] +--- + +# AttributeDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the attribute. | [optional] +**Type** | Pointer to [**AttributeDefinitionType**](attribute-definition-type) | | [optional] +**Schema** | Pointer to [**NullableAttributeDefinitionSchema**](attribute-definition-schema) | | [optional] +**Description** | Pointer to **string** | A human-readable description of the attribute. | [optional] +**IsMulti** | Pointer to **bool** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to false] +**IsEntitlement** | Pointer to **bool** | Flag indicating whether or not the attribute is an entitlement. | [optional] [default to false] +**IsGroup** | Pointer to **bool** | Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. | [optional] [default to false] + +## Methods + +### NewAttributeDefinition + +`func NewAttributeDefinition() *AttributeDefinition` + +NewAttributeDefinition instantiates a new AttributeDefinition 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 + +### NewAttributeDefinitionWithDefaults + +`func NewAttributeDefinitionWithDefaults() *AttributeDefinition` + +NewAttributeDefinitionWithDefaults instantiates a new AttributeDefinition 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 + +### GetName + +`func (o *AttributeDefinition) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeDefinition) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeDefinition) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeDefinition) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *AttributeDefinition) GetType() AttributeDefinitionType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttributeDefinition) GetTypeOk() (*AttributeDefinitionType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttributeDefinition) SetType(v AttributeDefinitionType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttributeDefinition) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSchema + +`func (o *AttributeDefinition) GetSchema() AttributeDefinitionSchema` + +GetSchema returns the Schema field if non-nil, zero value otherwise. + +### GetSchemaOk + +`func (o *AttributeDefinition) GetSchemaOk() (*AttributeDefinitionSchema, bool)` + +GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchema + +`func (o *AttributeDefinition) SetSchema(v AttributeDefinitionSchema)` + +SetSchema sets Schema field to given value. + +### HasSchema + +`func (o *AttributeDefinition) HasSchema() bool` + +HasSchema returns a boolean if a field has been set. + +### SetSchemaNil + +`func (o *AttributeDefinition) SetSchemaNil(b bool)` + + SetSchemaNil sets the value for Schema to be an explicit nil + +### UnsetSchema +`func (o *AttributeDefinition) UnsetSchema()` + +UnsetSchema ensures that no value is present for Schema, not even an explicit nil +### GetDescription + +`func (o *AttributeDefinition) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AttributeDefinition) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AttributeDefinition) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AttributeDefinition) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIsMulti + +`func (o *AttributeDefinition) GetIsMulti() bool` + +GetIsMulti returns the IsMulti field if non-nil, zero value otherwise. + +### GetIsMultiOk + +`func (o *AttributeDefinition) GetIsMultiOk() (*bool, bool)` + +GetIsMultiOk returns a tuple with the IsMulti field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsMulti + +`func (o *AttributeDefinition) SetIsMulti(v bool)` + +SetIsMulti sets IsMulti field to given value. + +### HasIsMulti + +`func (o *AttributeDefinition) HasIsMulti() bool` + +HasIsMulti returns a boolean if a field has been set. + +### GetIsEntitlement + +`func (o *AttributeDefinition) GetIsEntitlement() bool` + +GetIsEntitlement returns the IsEntitlement field if non-nil, zero value otherwise. + +### GetIsEntitlementOk + +`func (o *AttributeDefinition) GetIsEntitlementOk() (*bool, bool)` + +GetIsEntitlementOk returns a tuple with the IsEntitlement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsEntitlement + +`func (o *AttributeDefinition) SetIsEntitlement(v bool)` + +SetIsEntitlement sets IsEntitlement field to given value. + +### HasIsEntitlement + +`func (o *AttributeDefinition) HasIsEntitlement() bool` + +HasIsEntitlement returns a boolean if a field has been set. + +### GetIsGroup + +`func (o *AttributeDefinition) GetIsGroup() bool` + +GetIsGroup returns the IsGroup field if non-nil, zero value otherwise. + +### GetIsGroupOk + +`func (o *AttributeDefinition) GetIsGroupOk() (*bool, bool)` + +GetIsGroupOk returns a tuple with the IsGroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGroup + +`func (o *AttributeDefinition) SetIsGroup(v bool)` + +SetIsGroup sets IsGroup field to given value. + +### HasIsGroup + +`func (o *AttributeDefinition) HasIsGroup() bool` + +HasIsGroup returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttributeDefinitionSchema.md b/docs/tools/sdk/go/Reference/V2024/Models/AttributeDefinitionSchema.md new file mode 100644 index 000000000..1091d156a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttributeDefinitionSchema.md @@ -0,0 +1,116 @@ +--- +id: v2024-attribute-definition-schema +title: AttributeDefinitionSchema +pagination_label: AttributeDefinitionSchema +sidebar_label: AttributeDefinitionSchema +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDefinitionSchema', 'V2024AttributeDefinitionSchema'] +slug: /tools/sdk/go/v2024/models/attribute-definition-schema +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionSchema', 'V2024AttributeDefinitionSchema'] +--- + +# AttributeDefinitionSchema + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of object being referenced | [optional] +**Id** | Pointer to **string** | The object ID this reference applies to. | [optional] +**Name** | Pointer to **string** | The human-readable display name of the object. | [optional] + +## Methods + +### NewAttributeDefinitionSchema + +`func NewAttributeDefinitionSchema() *AttributeDefinitionSchema` + +NewAttributeDefinitionSchema instantiates a new AttributeDefinitionSchema 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 + +### NewAttributeDefinitionSchemaWithDefaults + +`func NewAttributeDefinitionSchemaWithDefaults() *AttributeDefinitionSchema` + +NewAttributeDefinitionSchemaWithDefaults instantiates a new AttributeDefinitionSchema 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 + +### GetType + +`func (o *AttributeDefinitionSchema) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttributeDefinitionSchema) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttributeDefinitionSchema) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttributeDefinitionSchema) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AttributeDefinitionSchema) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AttributeDefinitionSchema) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AttributeDefinitionSchema) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AttributeDefinitionSchema) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AttributeDefinitionSchema) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeDefinitionSchema) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeDefinitionSchema) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeDefinitionSchema) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttributeDefinitionType.md b/docs/tools/sdk/go/Reference/V2024/Models/AttributeDefinitionType.md new file mode 100644 index 000000000..f7799614e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttributeDefinitionType.md @@ -0,0 +1,27 @@ +--- +id: v2024-attribute-definition-type +title: AttributeDefinitionType +pagination_label: AttributeDefinitionType +sidebar_label: AttributeDefinitionType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDefinitionType', 'V2024AttributeDefinitionType'] +slug: /tools/sdk/go/v2024/models/attribute-definition-type +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'V2024AttributeDefinitionType'] +--- + +# AttributeDefinitionType + +## Enum + + +* `STRING` (value: `"STRING"`) + +* `LONG` (value: `"LONG"`) + +* `INT` (value: `"INT"`) + +* `BOOLEAN` (value: `"BOOLEAN"`) + +* `DATE` (value: `"DATE"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappings.md b/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappings.md new file mode 100644 index 000000000..b745bf1de --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappings.md @@ -0,0 +1,90 @@ +--- +id: v2024-attribute-mappings +title: AttributeMappings +pagination_label: AttributeMappings +sidebar_label: AttributeMappings +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeMappings', 'V2024AttributeMappings'] +slug: /tools/sdk/go/v2024/models/attribute-mappings +tags: ['SDK', 'Software Development Kit', 'AttributeMappings', 'V2024AttributeMappings'] +--- + +# AttributeMappings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Target** | Pointer to [**AttributeMappingsAllOfTarget**](attribute-mappings-all-of-target) | | [optional] +**TransformDefinition** | Pointer to [**AttributeMappingsAllOfTransformDefinition**](attribute-mappings-all-of-transform-definition) | | [optional] + +## Methods + +### NewAttributeMappings + +`func NewAttributeMappings() *AttributeMappings` + +NewAttributeMappings instantiates a new AttributeMappings 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 + +### NewAttributeMappingsWithDefaults + +`func NewAttributeMappingsWithDefaults() *AttributeMappings` + +NewAttributeMappingsWithDefaults instantiates a new AttributeMappings 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 + +### GetTarget + +`func (o *AttributeMappings) GetTarget() AttributeMappingsAllOfTarget` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *AttributeMappings) GetTargetOk() (*AttributeMappingsAllOfTarget, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *AttributeMappings) SetTarget(v AttributeMappingsAllOfTarget)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *AttributeMappings) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + +### GetTransformDefinition + +`func (o *AttributeMappings) GetTransformDefinition() AttributeMappingsAllOfTransformDefinition` + +GetTransformDefinition returns the TransformDefinition field if non-nil, zero value otherwise. + +### GetTransformDefinitionOk + +`func (o *AttributeMappings) GetTransformDefinitionOk() (*AttributeMappingsAllOfTransformDefinition, bool)` + +GetTransformDefinitionOk returns a tuple with the TransformDefinition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTransformDefinition + +`func (o *AttributeMappings) SetTransformDefinition(v AttributeMappingsAllOfTransformDefinition)` + +SetTransformDefinition sets TransformDefinition field to given value. + +### HasTransformDefinition + +`func (o *AttributeMappings) HasTransformDefinition() bool` + +HasTransformDefinition returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappingsAllOfTarget.md b/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappingsAllOfTarget.md new file mode 100644 index 000000000..f2fec3088 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappingsAllOfTarget.md @@ -0,0 +1,116 @@ +--- +id: v2024-attribute-mappings-all-of-target +title: AttributeMappingsAllOfTarget +pagination_label: AttributeMappingsAllOfTarget +sidebar_label: AttributeMappingsAllOfTarget +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeMappingsAllOfTarget', 'V2024AttributeMappingsAllOfTarget'] +slug: /tools/sdk/go/v2024/models/attribute-mappings-all-of-target +tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTarget', 'V2024AttributeMappingsAllOfTarget'] +--- + +# AttributeMappingsAllOfTarget + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of target entity | [optional] +**AttributeName** | Pointer to **string** | Name of the targeted attribute | [optional] +**SourceId** | Pointer to **string** | The ID of Source | [optional] + +## Methods + +### NewAttributeMappingsAllOfTarget + +`func NewAttributeMappingsAllOfTarget() *AttributeMappingsAllOfTarget` + +NewAttributeMappingsAllOfTarget instantiates a new AttributeMappingsAllOfTarget 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 + +### NewAttributeMappingsAllOfTargetWithDefaults + +`func NewAttributeMappingsAllOfTargetWithDefaults() *AttributeMappingsAllOfTarget` + +NewAttributeMappingsAllOfTargetWithDefaults instantiates a new AttributeMappingsAllOfTarget 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 + +### GetType + +`func (o *AttributeMappingsAllOfTarget) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttributeMappingsAllOfTarget) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttributeMappingsAllOfTarget) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttributeMappingsAllOfTarget) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *AttributeMappingsAllOfTarget) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *AttributeMappingsAllOfTarget) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *AttributeMappingsAllOfTarget) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *AttributeMappingsAllOfTarget) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AttributeMappingsAllOfTarget) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AttributeMappingsAllOfTarget) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AttributeMappingsAllOfTarget) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AttributeMappingsAllOfTarget) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappingsAllOfTransformDefinition.md b/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappingsAllOfTransformDefinition.md new file mode 100644 index 000000000..b0d1195e6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappingsAllOfTransformDefinition.md @@ -0,0 +1,116 @@ +--- +id: v2024-attribute-mappings-all-of-transform-definition +title: AttributeMappingsAllOfTransformDefinition +pagination_label: AttributeMappingsAllOfTransformDefinition +sidebar_label: AttributeMappingsAllOfTransformDefinition +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeMappingsAllOfTransformDefinition', 'V2024AttributeMappingsAllOfTransformDefinition'] +slug: /tools/sdk/go/v2024/models/attribute-mappings-all-of-transform-definition +tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTransformDefinition', 'V2024AttributeMappingsAllOfTransformDefinition'] +--- + +# AttributeMappingsAllOfTransformDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of transform | [optional] +**Attributes** | Pointer to [**AttributeMappingsAllOfTransformDefinitionAttributes**](attribute-mappings-all-of-transform-definition-attributes) | | [optional] +**Id** | Pointer to **string** | Transform Operation | [optional] + +## Methods + +### NewAttributeMappingsAllOfTransformDefinition + +`func NewAttributeMappingsAllOfTransformDefinition() *AttributeMappingsAllOfTransformDefinition` + +NewAttributeMappingsAllOfTransformDefinition instantiates a new AttributeMappingsAllOfTransformDefinition 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 + +### NewAttributeMappingsAllOfTransformDefinitionWithDefaults + +`func NewAttributeMappingsAllOfTransformDefinitionWithDefaults() *AttributeMappingsAllOfTransformDefinition` + +NewAttributeMappingsAllOfTransformDefinitionWithDefaults instantiates a new AttributeMappingsAllOfTransformDefinition 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 + +### GetType + +`func (o *AttributeMappingsAllOfTransformDefinition) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttributeMappingsAllOfTransformDefinition) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttributeMappingsAllOfTransformDefinition) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttributeMappingsAllOfTransformDefinition) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetAttributes + +`func (o *AttributeMappingsAllOfTransformDefinition) GetAttributes() AttributeMappingsAllOfTransformDefinitionAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AttributeMappingsAllOfTransformDefinition) GetAttributesOk() (*AttributeMappingsAllOfTransformDefinitionAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AttributeMappingsAllOfTransformDefinition) SetAttributes(v AttributeMappingsAllOfTransformDefinitionAttributes)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *AttributeMappingsAllOfTransformDefinition) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetId + +`func (o *AttributeMappingsAllOfTransformDefinition) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AttributeMappingsAllOfTransformDefinition) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AttributeMappingsAllOfTransformDefinition) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AttributeMappingsAllOfTransformDefinition) HasId() bool` + +HasId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappingsAllOfTransformDefinitionAttributes.md b/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappingsAllOfTransformDefinitionAttributes.md new file mode 100644 index 000000000..416495b45 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappingsAllOfTransformDefinitionAttributes.md @@ -0,0 +1,64 @@ +--- +id: v2024-attribute-mappings-all-of-transform-definition-attributes +title: AttributeMappingsAllOfTransformDefinitionAttributes +pagination_label: AttributeMappingsAllOfTransformDefinitionAttributes +sidebar_label: AttributeMappingsAllOfTransformDefinitionAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeMappingsAllOfTransformDefinitionAttributes', 'V2024AttributeMappingsAllOfTransformDefinitionAttributes'] +slug: /tools/sdk/go/v2024/models/attribute-mappings-all-of-transform-definition-attributes +tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTransformDefinitionAttributes', 'V2024AttributeMappingsAllOfTransformDefinitionAttributes'] +--- + +# AttributeMappingsAllOfTransformDefinitionAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | Pointer to [**AttributeMappingsAllOfTransformDefinitionAttributesInput**](attribute-mappings-all-of-transform-definition-attributes-input) | | [optional] + +## Methods + +### NewAttributeMappingsAllOfTransformDefinitionAttributes + +`func NewAttributeMappingsAllOfTransformDefinitionAttributes() *AttributeMappingsAllOfTransformDefinitionAttributes` + +NewAttributeMappingsAllOfTransformDefinitionAttributes instantiates a new AttributeMappingsAllOfTransformDefinitionAttributes 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 + +### NewAttributeMappingsAllOfTransformDefinitionAttributesWithDefaults + +`func NewAttributeMappingsAllOfTransformDefinitionAttributesWithDefaults() *AttributeMappingsAllOfTransformDefinitionAttributes` + +NewAttributeMappingsAllOfTransformDefinitionAttributesWithDefaults instantiates a new AttributeMappingsAllOfTransformDefinitionAttributes 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 + +### GetInput + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributes) GetInput() AttributeMappingsAllOfTransformDefinitionAttributesInput` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributes) GetInputOk() (*AttributeMappingsAllOfTransformDefinitionAttributesInput, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributes) SetInput(v AttributeMappingsAllOfTransformDefinitionAttributesInput)` + +SetInput sets Input field to given value. + +### HasInput + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributes) HasInput() bool` + +HasInput returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappingsAllOfTransformDefinitionAttributesInput.md b/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappingsAllOfTransformDefinitionAttributesInput.md new file mode 100644 index 000000000..6a7ac6faf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappingsAllOfTransformDefinitionAttributesInput.md @@ -0,0 +1,90 @@ +--- +id: v2024-attribute-mappings-all-of-transform-definition-attributes-input +title: AttributeMappingsAllOfTransformDefinitionAttributesInput +pagination_label: AttributeMappingsAllOfTransformDefinitionAttributesInput +sidebar_label: AttributeMappingsAllOfTransformDefinitionAttributesInput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeMappingsAllOfTransformDefinitionAttributesInput', 'V2024AttributeMappingsAllOfTransformDefinitionAttributesInput'] +slug: /tools/sdk/go/v2024/models/attribute-mappings-all-of-transform-definition-attributes-input +tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTransformDefinitionAttributesInput', 'V2024AttributeMappingsAllOfTransformDefinitionAttributesInput'] +--- + +# AttributeMappingsAllOfTransformDefinitionAttributesInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The Type of Attribute | [optional] +**Attributes** | Pointer to [**AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes**](attribute-mappings-all-of-transform-definition-attributes-input-attributes) | | [optional] + +## Methods + +### NewAttributeMappingsAllOfTransformDefinitionAttributesInput + +`func NewAttributeMappingsAllOfTransformDefinitionAttributesInput() *AttributeMappingsAllOfTransformDefinitionAttributesInput` + +NewAttributeMappingsAllOfTransformDefinitionAttributesInput instantiates a new AttributeMappingsAllOfTransformDefinitionAttributesInput 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 + +### NewAttributeMappingsAllOfTransformDefinitionAttributesInputWithDefaults + +`func NewAttributeMappingsAllOfTransformDefinitionAttributesInputWithDefaults() *AttributeMappingsAllOfTransformDefinitionAttributesInput` + +NewAttributeMappingsAllOfTransformDefinitionAttributesInputWithDefaults instantiates a new AttributeMappingsAllOfTransformDefinitionAttributesInput 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 + +### GetType + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInput) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInput) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInput) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInput) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetAttributes + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInput) GetAttributes() AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInput) GetAttributesOk() (*AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInput) SetAttributes(v AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInput) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes.md b/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes.md new file mode 100644 index 000000000..09fcd4570 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes.md @@ -0,0 +1,116 @@ +--- +id: v2024-attribute-mappings-all-of-transform-definition-attributes-input-attributes +title: AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes +pagination_label: AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes +sidebar_label: AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes', 'V2024AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes'] +slug: /tools/sdk/go/v2024/models/attribute-mappings-all-of-transform-definition-attributes-input-attributes +tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes', 'V2024AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes'] +--- + +# AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeName** | Pointer to **string** | The name of attribute | [optional] +**SourceName** | Pointer to **string** | Name of the Source | [optional] +**Name** | Pointer to **string** | ID of the Source | [optional] + +## Methods + +### NewAttributeMappingsAllOfTransformDefinitionAttributesInputAttributes + +`func NewAttributeMappingsAllOfTransformDefinitionAttributesInputAttributes() *AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes` + +NewAttributeMappingsAllOfTransformDefinitionAttributesInputAttributes instantiates a new AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes 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 + +### NewAttributeMappingsAllOfTransformDefinitionAttributesInputAttributesWithDefaults + +`func NewAttributeMappingsAllOfTransformDefinitionAttributesInputAttributesWithDefaults() *AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes` + +NewAttributeMappingsAllOfTransformDefinitionAttributesInputAttributesWithDefaults instantiates a new AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes 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 + +### GetAttributeName + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetName + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttributeRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/AttributeRequest.md new file mode 100644 index 000000000..edbaed371 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttributeRequest.md @@ -0,0 +1,116 @@ +--- +id: v2024-attribute-request +title: AttributeRequest +pagination_label: AttributeRequest +sidebar_label: AttributeRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeRequest', 'V2024AttributeRequest'] +slug: /tools/sdk/go/v2024/models/attribute-request +tags: ['SDK', 'Software Development Kit', 'AttributeRequest', 'V2024AttributeRequest'] +--- + +# AttributeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Attribute name. | [optional] +**Op** | Pointer to **string** | Operation to perform on attribute. | [optional] +**Value** | Pointer to [**AttributeRequestValue**](attribute-request-value) | | [optional] + +## Methods + +### NewAttributeRequest + +`func NewAttributeRequest() *AttributeRequest` + +NewAttributeRequest instantiates a new AttributeRequest 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 + +### NewAttributeRequestWithDefaults + +`func NewAttributeRequestWithDefaults() *AttributeRequest` + +NewAttributeRequestWithDefaults instantiates a new AttributeRequest 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 + +### GetName + +`func (o *AttributeRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOp + +`func (o *AttributeRequest) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *AttributeRequest) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *AttributeRequest) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *AttributeRequest) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetValue + +`func (o *AttributeRequest) GetValue() AttributeRequestValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AttributeRequest) GetValueOk() (*AttributeRequestValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AttributeRequest) SetValue(v AttributeRequestValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AttributeRequest) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttributeRequestValue.md b/docs/tools/sdk/go/Reference/V2024/Models/AttributeRequestValue.md new file mode 100644 index 000000000..60a414731 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttributeRequestValue.md @@ -0,0 +1,38 @@ +--- +id: v2024-attribute-request-value +title: AttributeRequestValue +pagination_label: AttributeRequestValue +sidebar_label: AttributeRequestValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeRequestValue', 'V2024AttributeRequestValue'] +slug: /tools/sdk/go/v2024/models/attribute-request-value +tags: ['SDK', 'Software Development Kit', 'AttributeRequestValue', 'V2024AttributeRequestValue'] +--- + +# AttributeRequestValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewAttributeRequestValue + +`func NewAttributeRequestValue() *AttributeRequestValue` + +NewAttributeRequestValue instantiates a new AttributeRequestValue 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 + +### NewAttributeRequestValueWithDefaults + +`func NewAttributeRequestValueWithDefaults() *AttributeRequestValue` + +NewAttributeRequestValueWithDefaults instantiates a new AttributeRequestValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttributeValueDTO.md b/docs/tools/sdk/go/Reference/V2024/Models/AttributeValueDTO.md new file mode 100644 index 000000000..73e3bc9c1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttributeValueDTO.md @@ -0,0 +1,116 @@ +--- +id: v2024-attribute-value-dto +title: AttributeValueDTO +pagination_label: AttributeValueDTO +sidebar_label: AttributeValueDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeValueDTO', 'V2024AttributeValueDTO'] +slug: /tools/sdk/go/v2024/models/attribute-value-dto +tags: ['SDK', 'Software Development Kit', 'AttributeValueDTO', 'V2024AttributeValueDTO'] +--- + +# AttributeValueDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [optional] +**Name** | Pointer to **string** | The display name of the Attribute value. | [optional] +**Status** | Pointer to **string** | The status of the Attribute value. | [optional] + +## Methods + +### NewAttributeValueDTO + +`func NewAttributeValueDTO() *AttributeValueDTO` + +NewAttributeValueDTO instantiates a new AttributeValueDTO 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 + +### NewAttributeValueDTOWithDefaults + +`func NewAttributeValueDTOWithDefaults() *AttributeValueDTO` + +NewAttributeValueDTOWithDefaults instantiates a new AttributeValueDTO 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 + +### GetValue + +`func (o *AttributeValueDTO) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AttributeValueDTO) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AttributeValueDTO) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AttributeValueDTO) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetName + +`func (o *AttributeValueDTO) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeValueDTO) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeValueDTO) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeValueDTO) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *AttributeValueDTO) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AttributeValueDTO) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AttributeValueDTO) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AttributeValueDTO) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AttributesChanged.md b/docs/tools/sdk/go/Reference/V2024/Models/AttributesChanged.md new file mode 100644 index 000000000..f1c5470ce --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AttributesChanged.md @@ -0,0 +1,142 @@ +--- +id: v2024-attributes-changed +title: AttributesChanged +pagination_label: AttributesChanged +sidebar_label: AttributesChanged +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributesChanged', 'V2024AttributesChanged'] +slug: /tools/sdk/go/v2024/models/attributes-changed +tags: ['SDK', 'Software Development Kit', 'AttributesChanged', 'V2024AttributesChanged'] +--- + +# AttributesChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Changes** | Pointer to [**[]AttributeChange**](attribute-change) | | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] + +## Methods + +### NewAttributesChanged + +`func NewAttributesChanged() *AttributesChanged` + +NewAttributesChanged instantiates a new AttributesChanged 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 + +### NewAttributesChangedWithDefaults + +`func NewAttributesChangedWithDefaults() *AttributesChanged` + +NewAttributesChangedWithDefaults instantiates a new AttributesChanged 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 + +### GetChanges + +`func (o *AttributesChanged) GetChanges() []AttributeChange` + +GetChanges returns the Changes field if non-nil, zero value otherwise. + +### GetChangesOk + +`func (o *AttributesChanged) GetChangesOk() (*[]AttributeChange, bool)` + +GetChangesOk returns a tuple with the Changes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanges + +`func (o *AttributesChanged) SetChanges(v []AttributeChange)` + +SetChanges sets Changes field to given value. + +### HasChanges + +`func (o *AttributesChanged) HasChanges() bool` + +HasChanges returns a boolean if a field has been set. + +### GetEventType + +`func (o *AttributesChanged) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AttributesChanged) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AttributesChanged) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AttributesChanged) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *AttributesChanged) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AttributesChanged) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AttributesChanged) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AttributesChanged) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetDt + +`func (o *AttributesChanged) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *AttributesChanged) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *AttributesChanged) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *AttributesChanged) HasDt() bool` + +HasDt returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AuditDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/AuditDetails.md new file mode 100644 index 000000000..147f32640 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AuditDetails.md @@ -0,0 +1,142 @@ +--- +id: v2024-audit-details +title: AuditDetails +pagination_label: AuditDetails +sidebar_label: AuditDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuditDetails', 'V2024AuditDetails'] +slug: /tools/sdk/go/v2024/models/audit-details +tags: ['SDK', 'Software Development Kit', 'AuditDetails', 'V2024AuditDetails'] +--- + +# AuditDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **SailPointTime** | Initial date and time when the record was created | [optional] +**CreatedBy** | Pointer to [**Identity1**](identity1) | | [optional] +**Modified** | Pointer to **SailPointTime** | Last modified date and time for the record | [optional] +**ModifiedBy** | Pointer to [**Identity1**](identity1) | | [optional] + +## Methods + +### NewAuditDetails + +`func NewAuditDetails() *AuditDetails` + +NewAuditDetails instantiates a new AuditDetails 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 + +### NewAuditDetailsWithDefaults + +`func NewAuditDetailsWithDefaults() *AuditDetails` + +NewAuditDetailsWithDefaults instantiates a new AuditDetails 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 + +### GetCreated + +`func (o *AuditDetails) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AuditDetails) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AuditDetails) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AuditDetails) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetCreatedBy + +`func (o *AuditDetails) GetCreatedBy() Identity1` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *AuditDetails) GetCreatedByOk() (*Identity1, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *AuditDetails) SetCreatedBy(v Identity1)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *AuditDetails) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetModified + +`func (o *AuditDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AuditDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AuditDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AuditDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetModifiedBy + +`func (o *AuditDetails) GetModifiedBy() Identity1` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *AuditDetails) GetModifiedByOk() (*Identity1, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedBy + +`func (o *AuditDetails) SetModifiedBy(v Identity1)` + +SetModifiedBy sets ModifiedBy field to given value. + +### HasModifiedBy + +`func (o *AuditDetails) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AuthProfile.md b/docs/tools/sdk/go/Reference/V2024/Models/AuthProfile.md new file mode 100644 index 000000000..d527c5008 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AuthProfile.md @@ -0,0 +1,240 @@ +--- +id: v2024-auth-profile +title: AuthProfile +pagination_label: AuthProfile +sidebar_label: AuthProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuthProfile', 'V2024AuthProfile'] +slug: /tools/sdk/go/v2024/models/auth-profile +tags: ['SDK', 'Software Development Kit', 'AuthProfile', 'V2024AuthProfile'] +--- + +# AuthProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Authentication Profile name. | [optional] +**OffNetwork** | Pointer to **bool** | Use it to block access from off network. | [optional] [default to false] +**UntrustedGeography** | Pointer to **bool** | Use it to block access from untrusted geoographies. | [optional] [default to false] +**ApplicationId** | Pointer to **NullableString** | Application ID. | [optional] +**ApplicationName** | Pointer to **NullableString** | Application name. | [optional] +**Type** | Pointer to **string** | Type of the Authentication Profile. | [optional] +**StrongAuthLogin** | Pointer to **bool** | Use it to enable strong authentication. | [optional] [default to false] + +## Methods + +### NewAuthProfile + +`func NewAuthProfile() *AuthProfile` + +NewAuthProfile instantiates a new AuthProfile 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 + +### NewAuthProfileWithDefaults + +`func NewAuthProfileWithDefaults() *AuthProfile` + +NewAuthProfileWithDefaults instantiates a new AuthProfile 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 + +### GetName + +`func (o *AuthProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AuthProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AuthProfile) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AuthProfile) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOffNetwork + +`func (o *AuthProfile) GetOffNetwork() bool` + +GetOffNetwork returns the OffNetwork field if non-nil, zero value otherwise. + +### GetOffNetworkOk + +`func (o *AuthProfile) GetOffNetworkOk() (*bool, bool)` + +GetOffNetworkOk returns a tuple with the OffNetwork field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOffNetwork + +`func (o *AuthProfile) SetOffNetwork(v bool)` + +SetOffNetwork sets OffNetwork field to given value. + +### HasOffNetwork + +`func (o *AuthProfile) HasOffNetwork() bool` + +HasOffNetwork returns a boolean if a field has been set. + +### GetUntrustedGeography + +`func (o *AuthProfile) GetUntrustedGeography() bool` + +GetUntrustedGeography returns the UntrustedGeography field if non-nil, zero value otherwise. + +### GetUntrustedGeographyOk + +`func (o *AuthProfile) GetUntrustedGeographyOk() (*bool, bool)` + +GetUntrustedGeographyOk returns a tuple with the UntrustedGeography field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUntrustedGeography + +`func (o *AuthProfile) SetUntrustedGeography(v bool)` + +SetUntrustedGeography sets UntrustedGeography field to given value. + +### HasUntrustedGeography + +`func (o *AuthProfile) HasUntrustedGeography() bool` + +HasUntrustedGeography returns a boolean if a field has been set. + +### GetApplicationId + +`func (o *AuthProfile) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *AuthProfile) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *AuthProfile) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *AuthProfile) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationIdNil + +`func (o *AuthProfile) SetApplicationIdNil(b bool)` + + SetApplicationIdNil sets the value for ApplicationId to be an explicit nil + +### UnsetApplicationId +`func (o *AuthProfile) UnsetApplicationId()` + +UnsetApplicationId ensures that no value is present for ApplicationId, not even an explicit nil +### GetApplicationName + +`func (o *AuthProfile) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *AuthProfile) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *AuthProfile) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *AuthProfile) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### SetApplicationNameNil + +`func (o *AuthProfile) SetApplicationNameNil(b bool)` + + SetApplicationNameNil sets the value for ApplicationName to be an explicit nil + +### UnsetApplicationName +`func (o *AuthProfile) UnsetApplicationName()` + +UnsetApplicationName ensures that no value is present for ApplicationName, not even an explicit nil +### GetType + +`func (o *AuthProfile) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AuthProfile) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AuthProfile) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AuthProfile) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetStrongAuthLogin + +`func (o *AuthProfile) GetStrongAuthLogin() bool` + +GetStrongAuthLogin returns the StrongAuthLogin field if non-nil, zero value otherwise. + +### GetStrongAuthLoginOk + +`func (o *AuthProfile) GetStrongAuthLoginOk() (*bool, bool)` + +GetStrongAuthLoginOk returns a tuple with the StrongAuthLogin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStrongAuthLogin + +`func (o *AuthProfile) SetStrongAuthLogin(v bool)` + +SetStrongAuthLogin sets StrongAuthLogin field to given value. + +### HasStrongAuthLogin + +`func (o *AuthProfile) HasStrongAuthLogin() bool` + +HasStrongAuthLogin returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AuthProfileSummary.md b/docs/tools/sdk/go/Reference/V2024/Models/AuthProfileSummary.md new file mode 100644 index 000000000..27ce207ad --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AuthProfileSummary.md @@ -0,0 +1,90 @@ +--- +id: v2024-auth-profile-summary +title: AuthProfileSummary +pagination_label: AuthProfileSummary +sidebar_label: AuthProfileSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuthProfileSummary', 'V2024AuthProfileSummary'] +slug: /tools/sdk/go/v2024/models/auth-profile-summary +tags: ['SDK', 'Software Development Kit', 'AuthProfileSummary', 'V2024AuthProfileSummary'] +--- + +# AuthProfileSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Tenant** | Pointer to **string** | Tenant name. | [optional] +**Id** | Pointer to **string** | Identity ID. | [optional] + +## Methods + +### NewAuthProfileSummary + +`func NewAuthProfileSummary() *AuthProfileSummary` + +NewAuthProfileSummary instantiates a new AuthProfileSummary 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 + +### NewAuthProfileSummaryWithDefaults + +`func NewAuthProfileSummaryWithDefaults() *AuthProfileSummary` + +NewAuthProfileSummaryWithDefaults instantiates a new AuthProfileSummary 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 + +### GetTenant + +`func (o *AuthProfileSummary) GetTenant() string` + +GetTenant returns the Tenant field if non-nil, zero value otherwise. + +### GetTenantOk + +`func (o *AuthProfileSummary) GetTenantOk() (*string, bool)` + +GetTenantOk returns a tuple with the Tenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenant + +`func (o *AuthProfileSummary) SetTenant(v string)` + +SetTenant sets Tenant field to given value. + +### HasTenant + +`func (o *AuthProfileSummary) HasTenant() bool` + +HasTenant returns a boolean if a field has been set. + +### GetId + +`func (o *AuthProfileSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AuthProfileSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AuthProfileSummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AuthProfileSummary) HasId() bool` + +HasId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/AuthUser.md b/docs/tools/sdk/go/Reference/V2024/Models/AuthUser.md new file mode 100644 index 000000000..2b28045ae --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/AuthUser.md @@ -0,0 +1,606 @@ +--- +id: v2024-auth-user +title: AuthUser +pagination_label: AuthUser +sidebar_label: AuthUser +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuthUser', 'V2024AuthUser'] +slug: /tools/sdk/go/v2024/models/auth-user +tags: ['SDK', 'Software Development Kit', 'AuthUser', 'V2024AuthUser'] +--- + +# AuthUser + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Tenant** | Pointer to **string** | Tenant name. | [optional] +**Id** | Pointer to **string** | Identity ID. | [optional] +**Uid** | Pointer to **string** | Identity's unique identitifier. | [optional] +**Profile** | Pointer to **string** | ID of the auth profile associated with the auth user. | [optional] +**IdentificationNumber** | Pointer to **NullableString** | Auth user's employee number. | [optional] +**Email** | Pointer to **NullableString** | Auth user's email. | [optional] +**Phone** | Pointer to **NullableString** | Auth user's phone number. | [optional] +**WorkPhone** | Pointer to **NullableString** | Auth user's work phone number. | [optional] +**PersonalEmail** | Pointer to **NullableString** | Auth user's personal email. | [optional] +**Firstname** | Pointer to **NullableString** | Auth user's first name. | [optional] +**Lastname** | Pointer to **NullableString** | Auth user's last name. | [optional] +**DisplayName** | Pointer to **string** | Auth user's name in displayed format. | [optional] +**Alias** | Pointer to **string** | Auth user's alias. | [optional] +**LastPasswordChangeDate** | Pointer to **NullableTime** | Date of last password change. | [optional] +**LastLoginTimestamp** | Pointer to **int64** | Timestamp of the last login (long type value). | [optional] +**CurrentLoginTimestamp** | Pointer to **int64** | Timestamp of the current login (long type value). | [optional] +**LastUnlockTimestamp** | Pointer to **NullableTime** | The date and time when the user was last unlocked. | [optional] +**Capabilities** | Pointer to **[]string** | Array of the auth user's capabilities. | [optional] + +## Methods + +### NewAuthUser + +`func NewAuthUser() *AuthUser` + +NewAuthUser instantiates a new AuthUser 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 + +### NewAuthUserWithDefaults + +`func NewAuthUserWithDefaults() *AuthUser` + +NewAuthUserWithDefaults instantiates a new AuthUser 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 + +### GetTenant + +`func (o *AuthUser) GetTenant() string` + +GetTenant returns the Tenant field if non-nil, zero value otherwise. + +### GetTenantOk + +`func (o *AuthUser) GetTenantOk() (*string, bool)` + +GetTenantOk returns a tuple with the Tenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenant + +`func (o *AuthUser) SetTenant(v string)` + +SetTenant sets Tenant field to given value. + +### HasTenant + +`func (o *AuthUser) HasTenant() bool` + +HasTenant returns a boolean if a field has been set. + +### GetId + +`func (o *AuthUser) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AuthUser) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AuthUser) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AuthUser) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetUid + +`func (o *AuthUser) GetUid() string` + +GetUid returns the Uid field if non-nil, zero value otherwise. + +### GetUidOk + +`func (o *AuthUser) GetUidOk() (*string, bool)` + +GetUidOk returns a tuple with the Uid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUid + +`func (o *AuthUser) SetUid(v string)` + +SetUid sets Uid field to given value. + +### HasUid + +`func (o *AuthUser) HasUid() bool` + +HasUid returns a boolean if a field has been set. + +### GetProfile + +`func (o *AuthUser) GetProfile() string` + +GetProfile returns the Profile field if non-nil, zero value otherwise. + +### GetProfileOk + +`func (o *AuthUser) GetProfileOk() (*string, bool)` + +GetProfileOk returns a tuple with the Profile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProfile + +`func (o *AuthUser) SetProfile(v string)` + +SetProfile sets Profile field to given value. + +### HasProfile + +`func (o *AuthUser) HasProfile() bool` + +HasProfile returns a boolean if a field has been set. + +### GetIdentificationNumber + +`func (o *AuthUser) GetIdentificationNumber() string` + +GetIdentificationNumber returns the IdentificationNumber field if non-nil, zero value otherwise. + +### GetIdentificationNumberOk + +`func (o *AuthUser) GetIdentificationNumberOk() (*string, bool)` + +GetIdentificationNumberOk returns a tuple with the IdentificationNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentificationNumber + +`func (o *AuthUser) SetIdentificationNumber(v string)` + +SetIdentificationNumber sets IdentificationNumber field to given value. + +### HasIdentificationNumber + +`func (o *AuthUser) HasIdentificationNumber() bool` + +HasIdentificationNumber returns a boolean if a field has been set. + +### SetIdentificationNumberNil + +`func (o *AuthUser) SetIdentificationNumberNil(b bool)` + + SetIdentificationNumberNil sets the value for IdentificationNumber to be an explicit nil + +### UnsetIdentificationNumber +`func (o *AuthUser) UnsetIdentificationNumber()` + +UnsetIdentificationNumber ensures that no value is present for IdentificationNumber, not even an explicit nil +### GetEmail + +`func (o *AuthUser) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *AuthUser) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *AuthUser) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *AuthUser) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### SetEmailNil + +`func (o *AuthUser) SetEmailNil(b bool)` + + SetEmailNil sets the value for Email to be an explicit nil + +### UnsetEmail +`func (o *AuthUser) UnsetEmail()` + +UnsetEmail ensures that no value is present for Email, not even an explicit nil +### GetPhone + +`func (o *AuthUser) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *AuthUser) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *AuthUser) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *AuthUser) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### SetPhoneNil + +`func (o *AuthUser) SetPhoneNil(b bool)` + + SetPhoneNil sets the value for Phone to be an explicit nil + +### UnsetPhone +`func (o *AuthUser) UnsetPhone()` + +UnsetPhone ensures that no value is present for Phone, not even an explicit nil +### GetWorkPhone + +`func (o *AuthUser) GetWorkPhone() string` + +GetWorkPhone returns the WorkPhone field if non-nil, zero value otherwise. + +### GetWorkPhoneOk + +`func (o *AuthUser) GetWorkPhoneOk() (*string, bool)` + +GetWorkPhoneOk returns a tuple with the WorkPhone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWorkPhone + +`func (o *AuthUser) SetWorkPhone(v string)` + +SetWorkPhone sets WorkPhone field to given value. + +### HasWorkPhone + +`func (o *AuthUser) HasWorkPhone() bool` + +HasWorkPhone returns a boolean if a field has been set. + +### SetWorkPhoneNil + +`func (o *AuthUser) SetWorkPhoneNil(b bool)` + + SetWorkPhoneNil sets the value for WorkPhone to be an explicit nil + +### UnsetWorkPhone +`func (o *AuthUser) UnsetWorkPhone()` + +UnsetWorkPhone ensures that no value is present for WorkPhone, not even an explicit nil +### GetPersonalEmail + +`func (o *AuthUser) GetPersonalEmail() string` + +GetPersonalEmail returns the PersonalEmail field if non-nil, zero value otherwise. + +### GetPersonalEmailOk + +`func (o *AuthUser) GetPersonalEmailOk() (*string, bool)` + +GetPersonalEmailOk returns a tuple with the PersonalEmail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPersonalEmail + +`func (o *AuthUser) SetPersonalEmail(v string)` + +SetPersonalEmail sets PersonalEmail field to given value. + +### HasPersonalEmail + +`func (o *AuthUser) HasPersonalEmail() bool` + +HasPersonalEmail returns a boolean if a field has been set. + +### SetPersonalEmailNil + +`func (o *AuthUser) SetPersonalEmailNil(b bool)` + + SetPersonalEmailNil sets the value for PersonalEmail to be an explicit nil + +### UnsetPersonalEmail +`func (o *AuthUser) UnsetPersonalEmail()` + +UnsetPersonalEmail ensures that no value is present for PersonalEmail, not even an explicit nil +### GetFirstname + +`func (o *AuthUser) GetFirstname() string` + +GetFirstname returns the Firstname field if non-nil, zero value otherwise. + +### GetFirstnameOk + +`func (o *AuthUser) GetFirstnameOk() (*string, bool)` + +GetFirstnameOk returns a tuple with the Firstname field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstname + +`func (o *AuthUser) SetFirstname(v string)` + +SetFirstname sets Firstname field to given value. + +### HasFirstname + +`func (o *AuthUser) HasFirstname() bool` + +HasFirstname returns a boolean if a field has been set. + +### SetFirstnameNil + +`func (o *AuthUser) SetFirstnameNil(b bool)` + + SetFirstnameNil sets the value for Firstname to be an explicit nil + +### UnsetFirstname +`func (o *AuthUser) UnsetFirstname()` + +UnsetFirstname ensures that no value is present for Firstname, not even an explicit nil +### GetLastname + +`func (o *AuthUser) GetLastname() string` + +GetLastname returns the Lastname field if non-nil, zero value otherwise. + +### GetLastnameOk + +`func (o *AuthUser) GetLastnameOk() (*string, bool)` + +GetLastnameOk returns a tuple with the Lastname field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastname + +`func (o *AuthUser) SetLastname(v string)` + +SetLastname sets Lastname field to given value. + +### HasLastname + +`func (o *AuthUser) HasLastname() bool` + +HasLastname returns a boolean if a field has been set. + +### SetLastnameNil + +`func (o *AuthUser) SetLastnameNil(b bool)` + + SetLastnameNil sets the value for Lastname to be an explicit nil + +### UnsetLastname +`func (o *AuthUser) UnsetLastname()` + +UnsetLastname ensures that no value is present for Lastname, not even an explicit nil +### GetDisplayName + +`func (o *AuthUser) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AuthUser) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AuthUser) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AuthUser) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetAlias + +`func (o *AuthUser) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *AuthUser) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *AuthUser) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *AuthUser) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + +### GetLastPasswordChangeDate + +`func (o *AuthUser) GetLastPasswordChangeDate() SailPointTime` + +GetLastPasswordChangeDate returns the LastPasswordChangeDate field if non-nil, zero value otherwise. + +### GetLastPasswordChangeDateOk + +`func (o *AuthUser) GetLastPasswordChangeDateOk() (*SailPointTime, bool)` + +GetLastPasswordChangeDateOk returns a tuple with the LastPasswordChangeDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastPasswordChangeDate + +`func (o *AuthUser) SetLastPasswordChangeDate(v SailPointTime)` + +SetLastPasswordChangeDate sets LastPasswordChangeDate field to given value. + +### HasLastPasswordChangeDate + +`func (o *AuthUser) HasLastPasswordChangeDate() bool` + +HasLastPasswordChangeDate returns a boolean if a field has been set. + +### SetLastPasswordChangeDateNil + +`func (o *AuthUser) SetLastPasswordChangeDateNil(b bool)` + + SetLastPasswordChangeDateNil sets the value for LastPasswordChangeDate to be an explicit nil + +### UnsetLastPasswordChangeDate +`func (o *AuthUser) UnsetLastPasswordChangeDate()` + +UnsetLastPasswordChangeDate ensures that no value is present for LastPasswordChangeDate, not even an explicit nil +### GetLastLoginTimestamp + +`func (o *AuthUser) GetLastLoginTimestamp() int64` + +GetLastLoginTimestamp returns the LastLoginTimestamp field if non-nil, zero value otherwise. + +### GetLastLoginTimestampOk + +`func (o *AuthUser) GetLastLoginTimestampOk() (*int64, bool)` + +GetLastLoginTimestampOk returns a tuple with the LastLoginTimestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastLoginTimestamp + +`func (o *AuthUser) SetLastLoginTimestamp(v int64)` + +SetLastLoginTimestamp sets LastLoginTimestamp field to given value. + +### HasLastLoginTimestamp + +`func (o *AuthUser) HasLastLoginTimestamp() bool` + +HasLastLoginTimestamp returns a boolean if a field has been set. + +### GetCurrentLoginTimestamp + +`func (o *AuthUser) GetCurrentLoginTimestamp() int64` + +GetCurrentLoginTimestamp returns the CurrentLoginTimestamp field if non-nil, zero value otherwise. + +### GetCurrentLoginTimestampOk + +`func (o *AuthUser) GetCurrentLoginTimestampOk() (*int64, bool)` + +GetCurrentLoginTimestampOk returns a tuple with the CurrentLoginTimestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentLoginTimestamp + +`func (o *AuthUser) SetCurrentLoginTimestamp(v int64)` + +SetCurrentLoginTimestamp sets CurrentLoginTimestamp field to given value. + +### HasCurrentLoginTimestamp + +`func (o *AuthUser) HasCurrentLoginTimestamp() bool` + +HasCurrentLoginTimestamp returns a boolean if a field has been set. + +### GetLastUnlockTimestamp + +`func (o *AuthUser) GetLastUnlockTimestamp() SailPointTime` + +GetLastUnlockTimestamp returns the LastUnlockTimestamp field if non-nil, zero value otherwise. + +### GetLastUnlockTimestampOk + +`func (o *AuthUser) GetLastUnlockTimestampOk() (*SailPointTime, bool)` + +GetLastUnlockTimestampOk returns a tuple with the LastUnlockTimestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUnlockTimestamp + +`func (o *AuthUser) SetLastUnlockTimestamp(v SailPointTime)` + +SetLastUnlockTimestamp sets LastUnlockTimestamp field to given value. + +### HasLastUnlockTimestamp + +`func (o *AuthUser) HasLastUnlockTimestamp() bool` + +HasLastUnlockTimestamp returns a boolean if a field has been set. + +### SetLastUnlockTimestampNil + +`func (o *AuthUser) SetLastUnlockTimestampNil(b bool)` + + SetLastUnlockTimestampNil sets the value for LastUnlockTimestamp to be an explicit nil + +### UnsetLastUnlockTimestamp +`func (o *AuthUser) UnsetLastUnlockTimestamp()` + +UnsetLastUnlockTimestamp ensures that no value is present for LastUnlockTimestamp, not even an explicit nil +### GetCapabilities + +`func (o *AuthUser) GetCapabilities() []string` + +GetCapabilities returns the Capabilities field if non-nil, zero value otherwise. + +### GetCapabilitiesOk + +`func (o *AuthUser) GetCapabilitiesOk() (*[]string, bool)` + +GetCapabilitiesOk returns a tuple with the Capabilities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCapabilities + +`func (o *AuthUser) SetCapabilities(v []string)` + +SetCapabilities sets Capabilities field to given value. + +### HasCapabilities + +`func (o *AuthUser) HasCapabilities() bool` + +HasCapabilities returns a boolean if a field has been set. + +### SetCapabilitiesNil + +`func (o *AuthUser) SetCapabilitiesNil(b bool)` + + SetCapabilitiesNil sets the value for Capabilities to be an explicit nil + +### UnsetCapabilities +`func (o *AuthUser) UnsetCapabilities()` + +UnsetCapabilities ensures that no value is present for Capabilities, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BackupOptions.md b/docs/tools/sdk/go/Reference/V2024/Models/BackupOptions.md new file mode 100644 index 000000000..510c99d8b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BackupOptions.md @@ -0,0 +1,90 @@ +--- +id: v2024-backup-options +title: BackupOptions +pagination_label: BackupOptions +sidebar_label: BackupOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BackupOptions', 'V2024BackupOptions'] +slug: /tools/sdk/go/v2024/models/backup-options +tags: ['SDK', 'Software Development Kit', 'BackupOptions', 'V2024BackupOptions'] +--- + +# BackupOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludeTypes** | Pointer to **[]string** | Object type names to be included in a Configuration Hub backup command. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportNames**](object-export-import-names) | Additional options targeting specific objects related to each item in the includeTypes field. | [optional] + +## Methods + +### NewBackupOptions + +`func NewBackupOptions() *BackupOptions` + +NewBackupOptions instantiates a new BackupOptions 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 + +### NewBackupOptionsWithDefaults + +`func NewBackupOptionsWithDefaults() *BackupOptions` + +NewBackupOptionsWithDefaults instantiates a new BackupOptions 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 + +### GetIncludeTypes + +`func (o *BackupOptions) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *BackupOptions) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *BackupOptions) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *BackupOptions) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *BackupOptions) GetObjectOptions() map[string]ObjectExportImportNames` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *BackupOptions) GetObjectOptionsOk() (*map[string]ObjectExportImportNames, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *BackupOptions) SetObjectOptions(v map[string]ObjectExportImportNames)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *BackupOptions) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BackupResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/BackupResponse.md new file mode 100644 index 000000000..bcd51a894 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BackupResponse.md @@ -0,0 +1,490 @@ +--- +id: v2024-backup-response +title: BackupResponse +pagination_label: BackupResponse +sidebar_label: BackupResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BackupResponse', 'V2024BackupResponse'] +slug: /tools/sdk/go/v2024/models/backup-response +tags: ['SDK', 'Software Development Kit', 'BackupResponse', 'V2024BackupResponse'] +--- + +# BackupResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | Pointer to **string** | Unique id assigned to this backup. | [optional] +**Status** | Pointer to **string** | Status of the backup. | [optional] +**Type** | Pointer to **string** | Type of the job, will always be BACKUP for this type of job. | [optional] +**Tenant** | Pointer to **string** | The name of the tenant performing the upload | [optional] +**RequesterName** | Pointer to **string** | The name of the requester. | [optional] +**FileExists** | Pointer to **bool** | Whether or not a file was created and stored for this backup. | [optional] [default to true] +**Created** | Pointer to **SailPointTime** | The time the job was started. | [optional] +**Modified** | Pointer to **SailPointTime** | The time of the last update to the job. | [optional] +**Completed** | Pointer to **SailPointTime** | The time the job was completed. | [optional] +**Name** | Pointer to **string** | The name assigned to the upload file in the request body. | [optional] +**UserCanDelete** | Pointer to **bool** | Whether this backup can be deleted by a regular user. | [optional] [default to true] +**IsPartial** | Pointer to **bool** | Whether this backup contains all supported object types or only some of them. | [optional] [default to false] +**BackupType** | Pointer to **string** | Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. | [optional] +**Options** | Pointer to [**NullableBackupOptions**](backup-options) | | [optional] +**HydrationStatus** | Pointer to **string** | Whether the object details of this backup are ready. | [optional] +**TotalObjectCount** | Pointer to **int64** | Number of objects contained in this backup. | [optional] +**CloudStorageStatus** | Pointer to **string** | Whether this backup has been transferred to a customer storage location. | [optional] + +## Methods + +### NewBackupResponse + +`func NewBackupResponse() *BackupResponse` + +NewBackupResponse instantiates a new BackupResponse 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 + +### NewBackupResponseWithDefaults + +`func NewBackupResponseWithDefaults() *BackupResponse` + +NewBackupResponseWithDefaults instantiates a new BackupResponse 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 + +### GetJobId + +`func (o *BackupResponse) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *BackupResponse) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *BackupResponse) SetJobId(v string)` + +SetJobId sets JobId field to given value. + +### HasJobId + +`func (o *BackupResponse) HasJobId() bool` + +HasJobId returns a boolean if a field has been set. + +### GetStatus + +`func (o *BackupResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *BackupResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *BackupResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *BackupResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetType + +`func (o *BackupResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BackupResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BackupResponse) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BackupResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetTenant + +`func (o *BackupResponse) GetTenant() string` + +GetTenant returns the Tenant field if non-nil, zero value otherwise. + +### GetTenantOk + +`func (o *BackupResponse) GetTenantOk() (*string, bool)` + +GetTenantOk returns a tuple with the Tenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenant + +`func (o *BackupResponse) SetTenant(v string)` + +SetTenant sets Tenant field to given value. + +### HasTenant + +`func (o *BackupResponse) HasTenant() bool` + +HasTenant returns a boolean if a field has been set. + +### GetRequesterName + +`func (o *BackupResponse) GetRequesterName() string` + +GetRequesterName returns the RequesterName field if non-nil, zero value otherwise. + +### GetRequesterNameOk + +`func (o *BackupResponse) GetRequesterNameOk() (*string, bool)` + +GetRequesterNameOk returns a tuple with the RequesterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterName + +`func (o *BackupResponse) SetRequesterName(v string)` + +SetRequesterName sets RequesterName field to given value. + +### HasRequesterName + +`func (o *BackupResponse) HasRequesterName() bool` + +HasRequesterName returns a boolean if a field has been set. + +### GetFileExists + +`func (o *BackupResponse) GetFileExists() bool` + +GetFileExists returns the FileExists field if non-nil, zero value otherwise. + +### GetFileExistsOk + +`func (o *BackupResponse) GetFileExistsOk() (*bool, bool)` + +GetFileExistsOk returns a tuple with the FileExists field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileExists + +`func (o *BackupResponse) SetFileExists(v bool)` + +SetFileExists sets FileExists field to given value. + +### HasFileExists + +`func (o *BackupResponse) HasFileExists() bool` + +HasFileExists returns a boolean if a field has been set. + +### GetCreated + +`func (o *BackupResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BackupResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BackupResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *BackupResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *BackupResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *BackupResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *BackupResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *BackupResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCompleted + +`func (o *BackupResponse) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *BackupResponse) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *BackupResponse) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *BackupResponse) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetName + +`func (o *BackupResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BackupResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BackupResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BackupResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetUserCanDelete + +`func (o *BackupResponse) GetUserCanDelete() bool` + +GetUserCanDelete returns the UserCanDelete field if non-nil, zero value otherwise. + +### GetUserCanDeleteOk + +`func (o *BackupResponse) GetUserCanDeleteOk() (*bool, bool)` + +GetUserCanDeleteOk returns a tuple with the UserCanDelete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserCanDelete + +`func (o *BackupResponse) SetUserCanDelete(v bool)` + +SetUserCanDelete sets UserCanDelete field to given value. + +### HasUserCanDelete + +`func (o *BackupResponse) HasUserCanDelete() bool` + +HasUserCanDelete returns a boolean if a field has been set. + +### GetIsPartial + +`func (o *BackupResponse) GetIsPartial() bool` + +GetIsPartial returns the IsPartial field if non-nil, zero value otherwise. + +### GetIsPartialOk + +`func (o *BackupResponse) GetIsPartialOk() (*bool, bool)` + +GetIsPartialOk returns a tuple with the IsPartial field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsPartial + +`func (o *BackupResponse) SetIsPartial(v bool)` + +SetIsPartial sets IsPartial field to given value. + +### HasIsPartial + +`func (o *BackupResponse) HasIsPartial() bool` + +HasIsPartial returns a boolean if a field has been set. + +### GetBackupType + +`func (o *BackupResponse) GetBackupType() string` + +GetBackupType returns the BackupType field if non-nil, zero value otherwise. + +### GetBackupTypeOk + +`func (o *BackupResponse) GetBackupTypeOk() (*string, bool)` + +GetBackupTypeOk returns a tuple with the BackupType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackupType + +`func (o *BackupResponse) SetBackupType(v string)` + +SetBackupType sets BackupType field to given value. + +### HasBackupType + +`func (o *BackupResponse) HasBackupType() bool` + +HasBackupType returns a boolean if a field has been set. + +### GetOptions + +`func (o *BackupResponse) GetOptions() BackupOptions` + +GetOptions returns the Options field if non-nil, zero value otherwise. + +### GetOptionsOk + +`func (o *BackupResponse) GetOptionsOk() (*BackupOptions, bool)` + +GetOptionsOk returns a tuple with the Options field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOptions + +`func (o *BackupResponse) SetOptions(v BackupOptions)` + +SetOptions sets Options field to given value. + +### HasOptions + +`func (o *BackupResponse) HasOptions() bool` + +HasOptions returns a boolean if a field has been set. + +### SetOptionsNil + +`func (o *BackupResponse) SetOptionsNil(b bool)` + + SetOptionsNil sets the value for Options to be an explicit nil + +### UnsetOptions +`func (o *BackupResponse) UnsetOptions()` + +UnsetOptions ensures that no value is present for Options, not even an explicit nil +### GetHydrationStatus + +`func (o *BackupResponse) GetHydrationStatus() string` + +GetHydrationStatus returns the HydrationStatus field if non-nil, zero value otherwise. + +### GetHydrationStatusOk + +`func (o *BackupResponse) GetHydrationStatusOk() (*string, bool)` + +GetHydrationStatusOk returns a tuple with the HydrationStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHydrationStatus + +`func (o *BackupResponse) SetHydrationStatus(v string)` + +SetHydrationStatus sets HydrationStatus field to given value. + +### HasHydrationStatus + +`func (o *BackupResponse) HasHydrationStatus() bool` + +HasHydrationStatus returns a boolean if a field has been set. + +### GetTotalObjectCount + +`func (o *BackupResponse) GetTotalObjectCount() int64` + +GetTotalObjectCount returns the TotalObjectCount field if non-nil, zero value otherwise. + +### GetTotalObjectCountOk + +`func (o *BackupResponse) GetTotalObjectCountOk() (*int64, bool)` + +GetTotalObjectCountOk returns a tuple with the TotalObjectCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalObjectCount + +`func (o *BackupResponse) SetTotalObjectCount(v int64)` + +SetTotalObjectCount sets TotalObjectCount field to given value. + +### HasTotalObjectCount + +`func (o *BackupResponse) HasTotalObjectCount() bool` + +HasTotalObjectCount returns a boolean if a field has been set. + +### GetCloudStorageStatus + +`func (o *BackupResponse) GetCloudStorageStatus() string` + +GetCloudStorageStatus returns the CloudStorageStatus field if non-nil, zero value otherwise. + +### GetCloudStorageStatusOk + +`func (o *BackupResponse) GetCloudStorageStatusOk() (*string, bool)` + +GetCloudStorageStatusOk returns a tuple with the CloudStorageStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudStorageStatus + +`func (o *BackupResponse) SetCloudStorageStatus(v string)` + +SetCloudStorageStatus sets CloudStorageStatus field to given value. + +### HasCloudStorageStatus + +`func (o *BackupResponse) HasCloudStorageStatus() bool` + +HasCloudStorageStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BaseAccess.md b/docs/tools/sdk/go/Reference/V2024/Models/BaseAccess.md new file mode 100644 index 000000000..60a10d93f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BaseAccess.md @@ -0,0 +1,276 @@ +--- +id: v2024-base-access +title: BaseAccess +pagination_label: BaseAccess +sidebar_label: BaseAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseAccess', 'V2024BaseAccess'] +slug: /tools/sdk/go/v2024/models/base-access +tags: ['SDK', 'Software Development Kit', 'BaseAccess', 'V2024BaseAccess'] +--- + +# BaseAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Access item's description. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **NullableTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Enabled** | Pointer to **bool** | Indicates whether the access item is currently enabled. | [optional] [default to false] +**Requestable** | Pointer to **bool** | Indicates whether the access item can be requested. | [optional] [default to true] +**RequestCommentsRequired** | Pointer to **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to false] +**Owner** | Pointer to [**BaseAccessOwner**](base-access-owner) | | [optional] + +## Methods + +### NewBaseAccess + +`func NewBaseAccess() *BaseAccess` + +NewBaseAccess instantiates a new BaseAccess 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 + +### NewBaseAccessWithDefaults + +`func NewBaseAccessWithDefaults() *BaseAccess` + +NewBaseAccessWithDefaults instantiates a new BaseAccess 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 + +### GetDescription + +`func (o *BaseAccess) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *BaseAccess) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *BaseAccess) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *BaseAccess) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetCreated + +`func (o *BaseAccess) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BaseAccess) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BaseAccess) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *BaseAccess) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *BaseAccess) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *BaseAccess) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *BaseAccess) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *BaseAccess) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *BaseAccess) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *BaseAccess) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *BaseAccess) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *BaseAccess) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *BaseAccess) GetSynced() SailPointTime` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *BaseAccess) GetSyncedOk() (*SailPointTime, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *BaseAccess) SetSynced(v SailPointTime)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *BaseAccess) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### SetSyncedNil + +`func (o *BaseAccess) SetSyncedNil(b bool)` + + SetSyncedNil sets the value for Synced to be an explicit nil + +### UnsetSynced +`func (o *BaseAccess) UnsetSynced()` + +UnsetSynced ensures that no value is present for Synced, not even an explicit nil +### GetEnabled + +`func (o *BaseAccess) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *BaseAccess) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *BaseAccess) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *BaseAccess) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetRequestable + +`func (o *BaseAccess) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *BaseAccess) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *BaseAccess) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *BaseAccess) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetRequestCommentsRequired + +`func (o *BaseAccess) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *BaseAccess) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *BaseAccess) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *BaseAccess) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + +### GetOwner + +`func (o *BaseAccess) GetOwner() BaseAccessOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *BaseAccess) GetOwnerOk() (*BaseAccessOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *BaseAccess) SetOwner(v BaseAccessOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *BaseAccess) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BaseAccessOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/BaseAccessOwner.md new file mode 100644 index 000000000..1a3f4c108 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BaseAccessOwner.md @@ -0,0 +1,142 @@ +--- +id: v2024-base-access-owner +title: BaseAccessOwner +pagination_label: BaseAccessOwner +sidebar_label: BaseAccessOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseAccessOwner', 'V2024BaseAccessOwner'] +slug: /tools/sdk/go/v2024/models/base-access-owner +tags: ['SDK', 'Software Development Kit', 'BaseAccessOwner', 'V2024BaseAccessOwner'] +--- + +# BaseAccessOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's DTO type. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's display name. | [optional] +**Email** | Pointer to **string** | Owner's email. | [optional] + +## Methods + +### NewBaseAccessOwner + +`func NewBaseAccessOwner() *BaseAccessOwner` + +NewBaseAccessOwner instantiates a new BaseAccessOwner 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 + +### NewBaseAccessOwnerWithDefaults + +`func NewBaseAccessOwnerWithDefaults() *BaseAccessOwner` + +NewBaseAccessOwnerWithDefaults instantiates a new BaseAccessOwner 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 + +### GetType + +`func (o *BaseAccessOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BaseAccessOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BaseAccessOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BaseAccessOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *BaseAccessOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseAccessOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseAccessOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseAccessOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseAccessOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseAccessOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseAccessOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseAccessOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *BaseAccessOwner) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *BaseAccessOwner) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *BaseAccessOwner) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *BaseAccessOwner) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BaseAccessProfile.md b/docs/tools/sdk/go/Reference/V2024/Models/BaseAccessProfile.md new file mode 100644 index 000000000..059037e70 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BaseAccessProfile.md @@ -0,0 +1,90 @@ +--- +id: v2024-base-access-profile +title: BaseAccessProfile +pagination_label: BaseAccessProfile +sidebar_label: BaseAccessProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseAccessProfile', 'V2024BaseAccessProfile'] +slug: /tools/sdk/go/v2024/models/base-access-profile +tags: ['SDK', 'Software Development Kit', 'BaseAccessProfile', 'V2024BaseAccessProfile'] +--- + +# BaseAccessProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Access profile's unique ID. | [optional] +**Name** | Pointer to **string** | Access profile's display name. | [optional] + +## Methods + +### NewBaseAccessProfile + +`func NewBaseAccessProfile() *BaseAccessProfile` + +NewBaseAccessProfile instantiates a new BaseAccessProfile 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 + +### NewBaseAccessProfileWithDefaults + +`func NewBaseAccessProfileWithDefaults() *BaseAccessProfile` + +NewBaseAccessProfileWithDefaults instantiates a new BaseAccessProfile 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 + +### GetId + +`func (o *BaseAccessProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseAccessProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseAccessProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseAccessProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseAccessProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseAccessProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseAccessProfile) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseAccessProfile) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BaseAccount.md b/docs/tools/sdk/go/Reference/V2024/Models/BaseAccount.md new file mode 100644 index 000000000..ff3137df1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BaseAccount.md @@ -0,0 +1,416 @@ +--- +id: v2024-base-account +title: BaseAccount +pagination_label: BaseAccount +sidebar_label: BaseAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseAccount', 'V2024BaseAccount'] +slug: /tools/sdk/go/v2024/models/base-account +tags: ['SDK', 'Software Development Kit', 'BaseAccount', 'V2024BaseAccount'] +--- + +# BaseAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**AccountId** | Pointer to **string** | Account ID. | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] +**Disabled** | Pointer to **bool** | Indicates whether the account is disabled. | [optional] [default to false] +**Locked** | Pointer to **bool** | Indicates whether the account is locked. | [optional] [default to false] +**Privileged** | Pointer to **bool** | Indicates whether the account is privileged. | [optional] [default to false] +**ManuallyCorrelated** | Pointer to **bool** | Indicates whether the account has been manually correlated to an identity. | [optional] [default to false] +**PasswordLastSet** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**EntitlementAttributes** | Pointer to **map[string]interface{}** | Map or dictionary of key/value pairs. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**SupportsPasswordChange** | Pointer to **bool** | Indicates whether the account supports password change. | [optional] [default to false] +**AccountAttributes** | Pointer to **map[string]interface{}** | Map or dictionary of key/value pairs. | [optional] + +## Methods + +### NewBaseAccount + +`func NewBaseAccount() *BaseAccount` + +NewBaseAccount instantiates a new BaseAccount 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 + +### NewBaseAccountWithDefaults + +`func NewBaseAccountWithDefaults() *BaseAccount` + +NewBaseAccountWithDefaults instantiates a new BaseAccount 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 + +### GetId + +`func (o *BaseAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseAccount) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseAccount) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAccountId + +`func (o *BaseAccount) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *BaseAccount) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *BaseAccount) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *BaseAccount) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetSource + +`func (o *BaseAccount) GetSource() AccountSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *BaseAccount) GetSourceOk() (*AccountSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *BaseAccount) SetSource(v AccountSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *BaseAccount) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetDisabled + +`func (o *BaseAccount) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *BaseAccount) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *BaseAccount) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *BaseAccount) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetLocked + +`func (o *BaseAccount) GetLocked() bool` + +GetLocked returns the Locked field if non-nil, zero value otherwise. + +### GetLockedOk + +`func (o *BaseAccount) GetLockedOk() (*bool, bool)` + +GetLockedOk returns a tuple with the Locked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocked + +`func (o *BaseAccount) SetLocked(v bool)` + +SetLocked sets Locked field to given value. + +### HasLocked + +`func (o *BaseAccount) HasLocked() bool` + +HasLocked returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *BaseAccount) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *BaseAccount) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *BaseAccount) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *BaseAccount) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetManuallyCorrelated + +`func (o *BaseAccount) GetManuallyCorrelated() bool` + +GetManuallyCorrelated returns the ManuallyCorrelated field if non-nil, zero value otherwise. + +### GetManuallyCorrelatedOk + +`func (o *BaseAccount) GetManuallyCorrelatedOk() (*bool, bool)` + +GetManuallyCorrelatedOk returns a tuple with the ManuallyCorrelated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyCorrelated + +`func (o *BaseAccount) SetManuallyCorrelated(v bool)` + +SetManuallyCorrelated sets ManuallyCorrelated field to given value. + +### HasManuallyCorrelated + +`func (o *BaseAccount) HasManuallyCorrelated() bool` + +HasManuallyCorrelated returns a boolean if a field has been set. + +### GetPasswordLastSet + +`func (o *BaseAccount) GetPasswordLastSet() SailPointTime` + +GetPasswordLastSet returns the PasswordLastSet field if non-nil, zero value otherwise. + +### GetPasswordLastSetOk + +`func (o *BaseAccount) GetPasswordLastSetOk() (*SailPointTime, bool)` + +GetPasswordLastSetOk returns a tuple with the PasswordLastSet field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordLastSet + +`func (o *BaseAccount) SetPasswordLastSet(v SailPointTime)` + +SetPasswordLastSet sets PasswordLastSet field to given value. + +### HasPasswordLastSet + +`func (o *BaseAccount) HasPasswordLastSet() bool` + +HasPasswordLastSet returns a boolean if a field has been set. + +### SetPasswordLastSetNil + +`func (o *BaseAccount) SetPasswordLastSetNil(b bool)` + + SetPasswordLastSetNil sets the value for PasswordLastSet to be an explicit nil + +### UnsetPasswordLastSet +`func (o *BaseAccount) UnsetPasswordLastSet()` + +UnsetPasswordLastSet ensures that no value is present for PasswordLastSet, not even an explicit nil +### GetEntitlementAttributes + +`func (o *BaseAccount) GetEntitlementAttributes() map[string]interface{}` + +GetEntitlementAttributes returns the EntitlementAttributes field if non-nil, zero value otherwise. + +### GetEntitlementAttributesOk + +`func (o *BaseAccount) GetEntitlementAttributesOk() (*map[string]interface{}, bool)` + +GetEntitlementAttributesOk returns a tuple with the EntitlementAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementAttributes + +`func (o *BaseAccount) SetEntitlementAttributes(v map[string]interface{})` + +SetEntitlementAttributes sets EntitlementAttributes field to given value. + +### HasEntitlementAttributes + +`func (o *BaseAccount) HasEntitlementAttributes() bool` + +HasEntitlementAttributes returns a boolean if a field has been set. + +### SetEntitlementAttributesNil + +`func (o *BaseAccount) SetEntitlementAttributesNil(b bool)` + + SetEntitlementAttributesNil sets the value for EntitlementAttributes to be an explicit nil + +### UnsetEntitlementAttributes +`func (o *BaseAccount) UnsetEntitlementAttributes()` + +UnsetEntitlementAttributes ensures that no value is present for EntitlementAttributes, not even an explicit nil +### GetCreated + +`func (o *BaseAccount) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BaseAccount) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BaseAccount) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *BaseAccount) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *BaseAccount) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *BaseAccount) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetSupportsPasswordChange + +`func (o *BaseAccount) GetSupportsPasswordChange() bool` + +GetSupportsPasswordChange returns the SupportsPasswordChange field if non-nil, zero value otherwise. + +### GetSupportsPasswordChangeOk + +`func (o *BaseAccount) GetSupportsPasswordChangeOk() (*bool, bool)` + +GetSupportsPasswordChangeOk returns a tuple with the SupportsPasswordChange field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportsPasswordChange + +`func (o *BaseAccount) SetSupportsPasswordChange(v bool)` + +SetSupportsPasswordChange sets SupportsPasswordChange field to given value. + +### HasSupportsPasswordChange + +`func (o *BaseAccount) HasSupportsPasswordChange() bool` + +HasSupportsPasswordChange returns a boolean if a field has been set. + +### GetAccountAttributes + +`func (o *BaseAccount) GetAccountAttributes() map[string]interface{}` + +GetAccountAttributes returns the AccountAttributes field if non-nil, zero value otherwise. + +### GetAccountAttributesOk + +`func (o *BaseAccount) GetAccountAttributesOk() (*map[string]interface{}, bool)` + +GetAccountAttributesOk returns a tuple with the AccountAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountAttributes + +`func (o *BaseAccount) SetAccountAttributes(v map[string]interface{})` + +SetAccountAttributes sets AccountAttributes field to given value. + +### HasAccountAttributes + +`func (o *BaseAccount) HasAccountAttributes() bool` + +HasAccountAttributes returns a boolean if a field has been set. + +### SetAccountAttributesNil + +`func (o *BaseAccount) SetAccountAttributesNil(b bool)` + + SetAccountAttributesNil sets the value for AccountAttributes to be an explicit nil + +### UnsetAccountAttributes +`func (o *BaseAccount) UnsetAccountAttributes()` + +UnsetAccountAttributes ensures that no value is present for AccountAttributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BaseCommonDto.md b/docs/tools/sdk/go/Reference/V2024/Models/BaseCommonDto.md new file mode 100644 index 000000000..037a4323c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BaseCommonDto.md @@ -0,0 +1,147 @@ +--- +id: v2024-base-common-dto +title: BaseCommonDto +pagination_label: BaseCommonDto +sidebar_label: BaseCommonDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseCommonDto', 'V2024BaseCommonDto'] +slug: /tools/sdk/go/v2024/models/base-common-dto +tags: ['SDK', 'Software Development Kit', 'BaseCommonDto', 'V2024BaseCommonDto'] +--- + +# BaseCommonDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] + +## Methods + +### NewBaseCommonDto + +`func NewBaseCommonDto(name NullableString, ) *BaseCommonDto` + +NewBaseCommonDto instantiates a new BaseCommonDto 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 + +### NewBaseCommonDtoWithDefaults + +`func NewBaseCommonDtoWithDefaults() *BaseCommonDto` + +NewBaseCommonDtoWithDefaults instantiates a new BaseCommonDto 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 + +### GetId + +`func (o *BaseCommonDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseCommonDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseCommonDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseCommonDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseCommonDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseCommonDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseCommonDto) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *BaseCommonDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *BaseCommonDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *BaseCommonDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BaseCommonDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BaseCommonDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *BaseCommonDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *BaseCommonDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *BaseCommonDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *BaseCommonDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *BaseCommonDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BaseDocument.md b/docs/tools/sdk/go/Reference/V2024/Models/BaseDocument.md new file mode 100644 index 000000000..594df0dc1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BaseDocument.md @@ -0,0 +1,80 @@ +--- +id: v2024-base-document +title: BaseDocument +pagination_label: BaseDocument +sidebar_label: BaseDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseDocument', 'V2024BaseDocument'] +slug: /tools/sdk/go/v2024/models/base-document +tags: ['SDK', 'Software Development Kit', 'BaseDocument', 'V2024BaseDocument'] +--- + +# BaseDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the referenced object. | +**Name** | **string** | The human readable name of the referenced object. | + +## Methods + +### NewBaseDocument + +`func NewBaseDocument(id string, name string, ) *BaseDocument` + +NewBaseDocument instantiates a new BaseDocument 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 + +### NewBaseDocumentWithDefaults + +`func NewBaseDocumentWithDefaults() *BaseDocument` + +NewBaseDocumentWithDefaults instantiates a new BaseDocument 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 + +### GetId + +`func (o *BaseDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseDocument) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *BaseDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseDocument) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BaseEntitlement.md b/docs/tools/sdk/go/Reference/V2024/Models/BaseEntitlement.md new file mode 100644 index 000000000..db82adb37 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BaseEntitlement.md @@ -0,0 +1,256 @@ +--- +id: v2024-base-entitlement +title: BaseEntitlement +pagination_label: BaseEntitlement +sidebar_label: BaseEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseEntitlement', 'V2024BaseEntitlement'] +slug: /tools/sdk/go/v2024/models/base-entitlement +tags: ['SDK', 'Software Development Kit', 'BaseEntitlement', 'V2024BaseEntitlement'] +--- + +# BaseEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasPermissions** | Pointer to **bool** | Indicates whether the entitlement has permissions. | [optional] [default to false] +**Description** | Pointer to **NullableString** | Entitlement's description. | [optional] +**Attribute** | Pointer to **string** | Entitlement attribute's name. | [optional] +**Value** | Pointer to **string** | Entitlement's value. | [optional] +**Schema** | Pointer to **string** | Entitlement's schema. | [optional] +**Privileged** | Pointer to **bool** | Indicates whether the entitlement is privileged. | [optional] [default to false] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **string** | Entitlement's name. | [optional] + +## Methods + +### NewBaseEntitlement + +`func NewBaseEntitlement() *BaseEntitlement` + +NewBaseEntitlement instantiates a new BaseEntitlement 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 + +### NewBaseEntitlementWithDefaults + +`func NewBaseEntitlementWithDefaults() *BaseEntitlement` + +NewBaseEntitlementWithDefaults instantiates a new BaseEntitlement 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 + +### GetHasPermissions + +`func (o *BaseEntitlement) GetHasPermissions() bool` + +GetHasPermissions returns the HasPermissions field if non-nil, zero value otherwise. + +### GetHasPermissionsOk + +`func (o *BaseEntitlement) GetHasPermissionsOk() (*bool, bool)` + +GetHasPermissionsOk returns a tuple with the HasPermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasPermissions + +`func (o *BaseEntitlement) SetHasPermissions(v bool)` + +SetHasPermissions sets HasPermissions field to given value. + +### HasHasPermissions + +`func (o *BaseEntitlement) HasHasPermissions() bool` + +HasHasPermissions returns a boolean if a field has been set. + +### GetDescription + +`func (o *BaseEntitlement) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *BaseEntitlement) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *BaseEntitlement) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *BaseEntitlement) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *BaseEntitlement) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *BaseEntitlement) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAttribute + +`func (o *BaseEntitlement) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *BaseEntitlement) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *BaseEntitlement) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *BaseEntitlement) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *BaseEntitlement) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *BaseEntitlement) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *BaseEntitlement) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *BaseEntitlement) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSchema + +`func (o *BaseEntitlement) GetSchema() string` + +GetSchema returns the Schema field if non-nil, zero value otherwise. + +### GetSchemaOk + +`func (o *BaseEntitlement) GetSchemaOk() (*string, bool)` + +GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchema + +`func (o *BaseEntitlement) SetSchema(v string)` + +SetSchema sets Schema field to given value. + +### HasSchema + +`func (o *BaseEntitlement) HasSchema() bool` + +HasSchema returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *BaseEntitlement) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *BaseEntitlement) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *BaseEntitlement) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *BaseEntitlement) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetId + +`func (o *BaseEntitlement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseEntitlement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseEntitlement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseEntitlement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseEntitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseEntitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseEntitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseEntitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BaseReferenceDto.md b/docs/tools/sdk/go/Reference/V2024/Models/BaseReferenceDto.md new file mode 100644 index 000000000..117534ab3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BaseReferenceDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-base-reference-dto +title: BaseReferenceDto +pagination_label: BaseReferenceDto +sidebar_label: BaseReferenceDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseReferenceDto', 'V2024BaseReferenceDto'] +slug: /tools/sdk/go/v2024/models/base-reference-dto +tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto', 'V2024BaseReferenceDto'] +--- + +# BaseReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewBaseReferenceDto + +`func NewBaseReferenceDto() *BaseReferenceDto` + +NewBaseReferenceDto instantiates a new BaseReferenceDto 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 + +### NewBaseReferenceDtoWithDefaults + +`func NewBaseReferenceDtoWithDefaults() *BaseReferenceDto` + +NewBaseReferenceDtoWithDefaults instantiates a new BaseReferenceDto 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 + +### GetType + +`func (o *BaseReferenceDto) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BaseReferenceDto) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BaseReferenceDto) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BaseReferenceDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *BaseReferenceDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseReferenceDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseReferenceDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseReferenceDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseReferenceDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseReferenceDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseReferenceDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseReferenceDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BaseSegment.md b/docs/tools/sdk/go/Reference/V2024/Models/BaseSegment.md new file mode 100644 index 000000000..b92ba34bd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BaseSegment.md @@ -0,0 +1,90 @@ +--- +id: v2024-base-segment +title: BaseSegment +pagination_label: BaseSegment +sidebar_label: BaseSegment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseSegment', 'V2024BaseSegment'] +slug: /tools/sdk/go/v2024/models/base-segment +tags: ['SDK', 'Software Development Kit', 'BaseSegment', 'V2024BaseSegment'] +--- + +# BaseSegment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Segment's unique ID. | [optional] +**Name** | Pointer to **string** | Segment's display name. | [optional] + +## Methods + +### NewBaseSegment + +`func NewBaseSegment() *BaseSegment` + +NewBaseSegment instantiates a new BaseSegment 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 + +### NewBaseSegmentWithDefaults + +`func NewBaseSegmentWithDefaults() *BaseSegment` + +NewBaseSegmentWithDefaults instantiates a new BaseSegment 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 + +### GetId + +`func (o *BaseSegment) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseSegment) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseSegment) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseSegment) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseSegment) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseSegment) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseSegment) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseSegment) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BasicAuthConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/BasicAuthConfig.md new file mode 100644 index 000000000..35f90b423 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BasicAuthConfig.md @@ -0,0 +1,100 @@ +--- +id: v2024-basic-auth-config +title: BasicAuthConfig +pagination_label: BasicAuthConfig +sidebar_label: BasicAuthConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BasicAuthConfig', 'V2024BasicAuthConfig'] +slug: /tools/sdk/go/v2024/models/basic-auth-config +tags: ['SDK', 'Software Development Kit', 'BasicAuthConfig', 'V2024BasicAuthConfig'] +--- + +# BasicAuthConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserName** | Pointer to **string** | The username to authenticate. | [optional] +**Password** | Pointer to **NullableString** | The password to authenticate. On response, this field is set to null as to not return secrets. | [optional] + +## Methods + +### NewBasicAuthConfig + +`func NewBasicAuthConfig() *BasicAuthConfig` + +NewBasicAuthConfig instantiates a new BasicAuthConfig 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 + +### NewBasicAuthConfigWithDefaults + +`func NewBasicAuthConfigWithDefaults() *BasicAuthConfig` + +NewBasicAuthConfigWithDefaults instantiates a new BasicAuthConfig 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 + +### GetUserName + +`func (o *BasicAuthConfig) GetUserName() string` + +GetUserName returns the UserName field if non-nil, zero value otherwise. + +### GetUserNameOk + +`func (o *BasicAuthConfig) GetUserNameOk() (*string, bool)` + +GetUserNameOk returns a tuple with the UserName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserName + +`func (o *BasicAuthConfig) SetUserName(v string)` + +SetUserName sets UserName field to given value. + +### HasUserName + +`func (o *BasicAuthConfig) HasUserName() bool` + +HasUserName returns a boolean if a field has been set. + +### GetPassword + +`func (o *BasicAuthConfig) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *BasicAuthConfig) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *BasicAuthConfig) SetPassword(v string)` + +SetPassword sets Password field to given value. + +### HasPassword + +`func (o *BasicAuthConfig) HasPassword() bool` + +HasPassword returns a boolean if a field has been set. + +### SetPasswordNil + +`func (o *BasicAuthConfig) SetPasswordNil(b bool)` + + SetPasswordNil sets the value for Password to be an explicit nil + +### UnsetPassword +`func (o *BasicAuthConfig) UnsetPassword()` + +UnsetPassword ensures that no value is present for Password, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BearerTokenAuthConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/BearerTokenAuthConfig.md new file mode 100644 index 000000000..070efc1f3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BearerTokenAuthConfig.md @@ -0,0 +1,74 @@ +--- +id: v2024-bearer-token-auth-config +title: BearerTokenAuthConfig +pagination_label: BearerTokenAuthConfig +sidebar_label: BearerTokenAuthConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BearerTokenAuthConfig', 'V2024BearerTokenAuthConfig'] +slug: /tools/sdk/go/v2024/models/bearer-token-auth-config +tags: ['SDK', 'Software Development Kit', 'BearerTokenAuthConfig', 'V2024BearerTokenAuthConfig'] +--- + +# BearerTokenAuthConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BearerToken** | Pointer to **NullableString** | Bearer token | [optional] + +## Methods + +### NewBearerTokenAuthConfig + +`func NewBearerTokenAuthConfig() *BearerTokenAuthConfig` + +NewBearerTokenAuthConfig instantiates a new BearerTokenAuthConfig 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 + +### NewBearerTokenAuthConfigWithDefaults + +`func NewBearerTokenAuthConfigWithDefaults() *BearerTokenAuthConfig` + +NewBearerTokenAuthConfigWithDefaults instantiates a new BearerTokenAuthConfig 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 + +### GetBearerToken + +`func (o *BearerTokenAuthConfig) GetBearerToken() string` + +GetBearerToken returns the BearerToken field if non-nil, zero value otherwise. + +### GetBearerTokenOk + +`func (o *BearerTokenAuthConfig) GetBearerTokenOk() (*string, bool)` + +GetBearerTokenOk returns a tuple with the BearerToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBearerToken + +`func (o *BearerTokenAuthConfig) SetBearerToken(v string)` + +SetBearerToken sets BearerToken field to given value. + +### HasBearerToken + +`func (o *BearerTokenAuthConfig) HasBearerToken() bool` + +HasBearerToken returns a boolean if a field has been set. + +### SetBearerTokenNil + +`func (o *BearerTokenAuthConfig) SetBearerTokenNil(b bool)` + + SetBearerTokenNil sets the value for BearerToken to be an explicit nil + +### UnsetBearerToken +`func (o *BearerTokenAuthConfig) UnsetBearerToken()` + +UnsetBearerToken ensures that no value is present for BearerToken, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BeforeProvisioningRuleDto.md b/docs/tools/sdk/go/Reference/V2024/Models/BeforeProvisioningRuleDto.md new file mode 100644 index 000000000..ff717e170 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BeforeProvisioningRuleDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-before-provisioning-rule-dto +title: BeforeProvisioningRuleDto +pagination_label: BeforeProvisioningRuleDto +sidebar_label: BeforeProvisioningRuleDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BeforeProvisioningRuleDto', 'V2024BeforeProvisioningRuleDto'] +slug: /tools/sdk/go/v2024/models/before-provisioning-rule-dto +tags: ['SDK', 'Software Development Kit', 'BeforeProvisioningRuleDto', 'V2024BeforeProvisioningRuleDto'] +--- + +# BeforeProvisioningRuleDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Before Provisioning Rule DTO type. | [optional] +**Id** | Pointer to **string** | Before Provisioning Rule ID. | [optional] +**Name** | Pointer to **string** | Rule display name. | [optional] + +## Methods + +### NewBeforeProvisioningRuleDto + +`func NewBeforeProvisioningRuleDto() *BeforeProvisioningRuleDto` + +NewBeforeProvisioningRuleDto instantiates a new BeforeProvisioningRuleDto 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 + +### NewBeforeProvisioningRuleDtoWithDefaults + +`func NewBeforeProvisioningRuleDtoWithDefaults() *BeforeProvisioningRuleDto` + +NewBeforeProvisioningRuleDtoWithDefaults instantiates a new BeforeProvisioningRuleDto 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 + +### GetType + +`func (o *BeforeProvisioningRuleDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BeforeProvisioningRuleDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BeforeProvisioningRuleDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BeforeProvisioningRuleDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *BeforeProvisioningRuleDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BeforeProvisioningRuleDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BeforeProvisioningRuleDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BeforeProvisioningRuleDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BeforeProvisioningRuleDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BeforeProvisioningRuleDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BeforeProvisioningRuleDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BeforeProvisioningRuleDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Bound.md b/docs/tools/sdk/go/Reference/V2024/Models/Bound.md new file mode 100644 index 000000000..9e1e31515 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Bound.md @@ -0,0 +1,85 @@ +--- +id: v2024-bound +title: Bound +pagination_label: Bound +sidebar_label: Bound +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Bound', 'V2024Bound'] +slug: /tools/sdk/go/v2024/models/bound +tags: ['SDK', 'Software Development Kit', 'Bound', 'V2024Bound'] +--- + +# Bound + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | **string** | The value of the range's endpoint. | +**Inclusive** | Pointer to **bool** | Indicates if the endpoint is included in the range. | [optional] [default to false] + +## Methods + +### NewBound + +`func NewBound(value string, ) *Bound` + +NewBound instantiates a new Bound 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 + +### NewBoundWithDefaults + +`func NewBoundWithDefaults() *Bound` + +NewBoundWithDefaults instantiates a new Bound 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 + +### GetValue + +`func (o *Bound) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Bound) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Bound) SetValue(v string)` + +SetValue sets Value field to given value. + + +### GetInclusive + +`func (o *Bound) GetInclusive() bool` + +GetInclusive returns the Inclusive field if non-nil, zero value otherwise. + +### GetInclusiveOk + +`func (o *Bound) GetInclusiveOk() (*bool, bool)` + +GetInclusiveOk returns a tuple with the Inclusive field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInclusive + +`func (o *Bound) SetInclusive(v bool)` + +SetInclusive sets Inclusive field to given value. + +### HasInclusive + +`func (o *Bound) HasInclusive() bool` + +HasInclusive returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BrandingItem.md b/docs/tools/sdk/go/Reference/V2024/Models/BrandingItem.md new file mode 100644 index 000000000..f1d2326b0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BrandingItem.md @@ -0,0 +1,316 @@ +--- +id: v2024-branding-item +title: BrandingItem +pagination_label: BrandingItem +sidebar_label: BrandingItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BrandingItem', 'V2024BrandingItem'] +slug: /tools/sdk/go/v2024/models/branding-item +tags: ['SDK', 'Software Development Kit', 'BrandingItem', 'V2024BrandingItem'] +--- + +# BrandingItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | name of branding item | [optional] +**ProductName** | Pointer to **NullableString** | product name | [optional] +**ActionButtonColor** | Pointer to **NullableString** | hex value of color for action button | [optional] +**ActiveLinkColor** | Pointer to **NullableString** | hex value of color for link | [optional] +**NavigationColor** | Pointer to **NullableString** | hex value of color for navigation bar | [optional] +**EmailFromAddress** | Pointer to **NullableString** | email from address | [optional] +**StandardLogoURL** | Pointer to **NullableString** | url to standard logo | [optional] +**LoginInformationalMessage** | Pointer to **NullableString** | login information message | [optional] + +## Methods + +### NewBrandingItem + +`func NewBrandingItem() *BrandingItem` + +NewBrandingItem instantiates a new BrandingItem 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 + +### NewBrandingItemWithDefaults + +`func NewBrandingItemWithDefaults() *BrandingItem` + +NewBrandingItemWithDefaults instantiates a new BrandingItem 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 + +### GetName + +`func (o *BrandingItem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BrandingItem) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BrandingItem) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BrandingItem) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetProductName + +`func (o *BrandingItem) GetProductName() string` + +GetProductName returns the ProductName field if non-nil, zero value otherwise. + +### GetProductNameOk + +`func (o *BrandingItem) GetProductNameOk() (*string, bool)` + +GetProductNameOk returns a tuple with the ProductName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductName + +`func (o *BrandingItem) SetProductName(v string)` + +SetProductName sets ProductName field to given value. + +### HasProductName + +`func (o *BrandingItem) HasProductName() bool` + +HasProductName returns a boolean if a field has been set. + +### SetProductNameNil + +`func (o *BrandingItem) SetProductNameNil(b bool)` + + SetProductNameNil sets the value for ProductName to be an explicit nil + +### UnsetProductName +`func (o *BrandingItem) UnsetProductName()` + +UnsetProductName ensures that no value is present for ProductName, not even an explicit nil +### GetActionButtonColor + +`func (o *BrandingItem) GetActionButtonColor() string` + +GetActionButtonColor returns the ActionButtonColor field if non-nil, zero value otherwise. + +### GetActionButtonColorOk + +`func (o *BrandingItem) GetActionButtonColorOk() (*string, bool)` + +GetActionButtonColorOk returns a tuple with the ActionButtonColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActionButtonColor + +`func (o *BrandingItem) SetActionButtonColor(v string)` + +SetActionButtonColor sets ActionButtonColor field to given value. + +### HasActionButtonColor + +`func (o *BrandingItem) HasActionButtonColor() bool` + +HasActionButtonColor returns a boolean if a field has been set. + +### SetActionButtonColorNil + +`func (o *BrandingItem) SetActionButtonColorNil(b bool)` + + SetActionButtonColorNil sets the value for ActionButtonColor to be an explicit nil + +### UnsetActionButtonColor +`func (o *BrandingItem) UnsetActionButtonColor()` + +UnsetActionButtonColor ensures that no value is present for ActionButtonColor, not even an explicit nil +### GetActiveLinkColor + +`func (o *BrandingItem) GetActiveLinkColor() string` + +GetActiveLinkColor returns the ActiveLinkColor field if non-nil, zero value otherwise. + +### GetActiveLinkColorOk + +`func (o *BrandingItem) GetActiveLinkColorOk() (*string, bool)` + +GetActiveLinkColorOk returns a tuple with the ActiveLinkColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActiveLinkColor + +`func (o *BrandingItem) SetActiveLinkColor(v string)` + +SetActiveLinkColor sets ActiveLinkColor field to given value. + +### HasActiveLinkColor + +`func (o *BrandingItem) HasActiveLinkColor() bool` + +HasActiveLinkColor returns a boolean if a field has been set. + +### SetActiveLinkColorNil + +`func (o *BrandingItem) SetActiveLinkColorNil(b bool)` + + SetActiveLinkColorNil sets the value for ActiveLinkColor to be an explicit nil + +### UnsetActiveLinkColor +`func (o *BrandingItem) UnsetActiveLinkColor()` + +UnsetActiveLinkColor ensures that no value is present for ActiveLinkColor, not even an explicit nil +### GetNavigationColor + +`func (o *BrandingItem) GetNavigationColor() string` + +GetNavigationColor returns the NavigationColor field if non-nil, zero value otherwise. + +### GetNavigationColorOk + +`func (o *BrandingItem) GetNavigationColorOk() (*string, bool)` + +GetNavigationColorOk returns a tuple with the NavigationColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNavigationColor + +`func (o *BrandingItem) SetNavigationColor(v string)` + +SetNavigationColor sets NavigationColor field to given value. + +### HasNavigationColor + +`func (o *BrandingItem) HasNavigationColor() bool` + +HasNavigationColor returns a boolean if a field has been set. + +### SetNavigationColorNil + +`func (o *BrandingItem) SetNavigationColorNil(b bool)` + + SetNavigationColorNil sets the value for NavigationColor to be an explicit nil + +### UnsetNavigationColor +`func (o *BrandingItem) UnsetNavigationColor()` + +UnsetNavigationColor ensures that no value is present for NavigationColor, not even an explicit nil +### GetEmailFromAddress + +`func (o *BrandingItem) GetEmailFromAddress() string` + +GetEmailFromAddress returns the EmailFromAddress field if non-nil, zero value otherwise. + +### GetEmailFromAddressOk + +`func (o *BrandingItem) GetEmailFromAddressOk() (*string, bool)` + +GetEmailFromAddressOk returns a tuple with the EmailFromAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailFromAddress + +`func (o *BrandingItem) SetEmailFromAddress(v string)` + +SetEmailFromAddress sets EmailFromAddress field to given value. + +### HasEmailFromAddress + +`func (o *BrandingItem) HasEmailFromAddress() bool` + +HasEmailFromAddress returns a boolean if a field has been set. + +### SetEmailFromAddressNil + +`func (o *BrandingItem) SetEmailFromAddressNil(b bool)` + + SetEmailFromAddressNil sets the value for EmailFromAddress to be an explicit nil + +### UnsetEmailFromAddress +`func (o *BrandingItem) UnsetEmailFromAddress()` + +UnsetEmailFromAddress ensures that no value is present for EmailFromAddress, not even an explicit nil +### GetStandardLogoURL + +`func (o *BrandingItem) GetStandardLogoURL() string` + +GetStandardLogoURL returns the StandardLogoURL field if non-nil, zero value otherwise. + +### GetStandardLogoURLOk + +`func (o *BrandingItem) GetStandardLogoURLOk() (*string, bool)` + +GetStandardLogoURLOk returns a tuple with the StandardLogoURL field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandardLogoURL + +`func (o *BrandingItem) SetStandardLogoURL(v string)` + +SetStandardLogoURL sets StandardLogoURL field to given value. + +### HasStandardLogoURL + +`func (o *BrandingItem) HasStandardLogoURL() bool` + +HasStandardLogoURL returns a boolean if a field has been set. + +### SetStandardLogoURLNil + +`func (o *BrandingItem) SetStandardLogoURLNil(b bool)` + + SetStandardLogoURLNil sets the value for StandardLogoURL to be an explicit nil + +### UnsetStandardLogoURL +`func (o *BrandingItem) UnsetStandardLogoURL()` + +UnsetStandardLogoURL ensures that no value is present for StandardLogoURL, not even an explicit nil +### GetLoginInformationalMessage + +`func (o *BrandingItem) GetLoginInformationalMessage() string` + +GetLoginInformationalMessage returns the LoginInformationalMessage field if non-nil, zero value otherwise. + +### GetLoginInformationalMessageOk + +`func (o *BrandingItem) GetLoginInformationalMessageOk() (*string, bool)` + +GetLoginInformationalMessageOk returns a tuple with the LoginInformationalMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginInformationalMessage + +`func (o *BrandingItem) SetLoginInformationalMessage(v string)` + +SetLoginInformationalMessage sets LoginInformationalMessage field to given value. + +### HasLoginInformationalMessage + +`func (o *BrandingItem) HasLoginInformationalMessage() bool` + +HasLoginInformationalMessage returns a boolean if a field has been set. + +### SetLoginInformationalMessageNil + +`func (o *BrandingItem) SetLoginInformationalMessageNil(b bool)` + + SetLoginInformationalMessageNil sets the value for LoginInformationalMessage to be an explicit nil + +### UnsetLoginInformationalMessage +`func (o *BrandingItem) UnsetLoginInformationalMessage()` + +UnsetLoginInformationalMessage ensures that no value is present for LoginInformationalMessage, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BrandingItemCreate.md b/docs/tools/sdk/go/Reference/V2024/Models/BrandingItemCreate.md new file mode 100644 index 000000000..60fa41285 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BrandingItemCreate.md @@ -0,0 +1,246 @@ +--- +id: v2024-branding-item-create +title: BrandingItemCreate +pagination_label: BrandingItemCreate +sidebar_label: BrandingItemCreate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BrandingItemCreate', 'V2024BrandingItemCreate'] +slug: /tools/sdk/go/v2024/models/branding-item-create +tags: ['SDK', 'Software Development Kit', 'BrandingItemCreate', 'V2024BrandingItemCreate'] +--- + +# BrandingItemCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | name of branding item | +**ProductName** | **NullableString** | product name | +**ActionButtonColor** | Pointer to **string** | hex value of color for action button | [optional] +**ActiveLinkColor** | Pointer to **string** | hex value of color for link | [optional] +**NavigationColor** | Pointer to **string** | hex value of color for navigation bar | [optional] +**EmailFromAddress** | Pointer to **string** | email from address | [optional] +**LoginInformationalMessage** | Pointer to **string** | login information message | [optional] +**FileStandard** | Pointer to ***os.File** | png file with logo | [optional] + +## Methods + +### NewBrandingItemCreate + +`func NewBrandingItemCreate(name string, productName NullableString, ) *BrandingItemCreate` + +NewBrandingItemCreate instantiates a new BrandingItemCreate 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 + +### NewBrandingItemCreateWithDefaults + +`func NewBrandingItemCreateWithDefaults() *BrandingItemCreate` + +NewBrandingItemCreateWithDefaults instantiates a new BrandingItemCreate 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 + +### GetName + +`func (o *BrandingItemCreate) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BrandingItemCreate) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BrandingItemCreate) SetName(v string)` + +SetName sets Name field to given value. + + +### GetProductName + +`func (o *BrandingItemCreate) GetProductName() string` + +GetProductName returns the ProductName field if non-nil, zero value otherwise. + +### GetProductNameOk + +`func (o *BrandingItemCreate) GetProductNameOk() (*string, bool)` + +GetProductNameOk returns a tuple with the ProductName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductName + +`func (o *BrandingItemCreate) SetProductName(v string)` + +SetProductName sets ProductName field to given value. + + +### SetProductNameNil + +`func (o *BrandingItemCreate) SetProductNameNil(b bool)` + + SetProductNameNil sets the value for ProductName to be an explicit nil + +### UnsetProductName +`func (o *BrandingItemCreate) UnsetProductName()` + +UnsetProductName ensures that no value is present for ProductName, not even an explicit nil +### GetActionButtonColor + +`func (o *BrandingItemCreate) GetActionButtonColor() string` + +GetActionButtonColor returns the ActionButtonColor field if non-nil, zero value otherwise. + +### GetActionButtonColorOk + +`func (o *BrandingItemCreate) GetActionButtonColorOk() (*string, bool)` + +GetActionButtonColorOk returns a tuple with the ActionButtonColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActionButtonColor + +`func (o *BrandingItemCreate) SetActionButtonColor(v string)` + +SetActionButtonColor sets ActionButtonColor field to given value. + +### HasActionButtonColor + +`func (o *BrandingItemCreate) HasActionButtonColor() bool` + +HasActionButtonColor returns a boolean if a field has been set. + +### GetActiveLinkColor + +`func (o *BrandingItemCreate) GetActiveLinkColor() string` + +GetActiveLinkColor returns the ActiveLinkColor field if non-nil, zero value otherwise. + +### GetActiveLinkColorOk + +`func (o *BrandingItemCreate) GetActiveLinkColorOk() (*string, bool)` + +GetActiveLinkColorOk returns a tuple with the ActiveLinkColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActiveLinkColor + +`func (o *BrandingItemCreate) SetActiveLinkColor(v string)` + +SetActiveLinkColor sets ActiveLinkColor field to given value. + +### HasActiveLinkColor + +`func (o *BrandingItemCreate) HasActiveLinkColor() bool` + +HasActiveLinkColor returns a boolean if a field has been set. + +### GetNavigationColor + +`func (o *BrandingItemCreate) GetNavigationColor() string` + +GetNavigationColor returns the NavigationColor field if non-nil, zero value otherwise. + +### GetNavigationColorOk + +`func (o *BrandingItemCreate) GetNavigationColorOk() (*string, bool)` + +GetNavigationColorOk returns a tuple with the NavigationColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNavigationColor + +`func (o *BrandingItemCreate) SetNavigationColor(v string)` + +SetNavigationColor sets NavigationColor field to given value. + +### HasNavigationColor + +`func (o *BrandingItemCreate) HasNavigationColor() bool` + +HasNavigationColor returns a boolean if a field has been set. + +### GetEmailFromAddress + +`func (o *BrandingItemCreate) GetEmailFromAddress() string` + +GetEmailFromAddress returns the EmailFromAddress field if non-nil, zero value otherwise. + +### GetEmailFromAddressOk + +`func (o *BrandingItemCreate) GetEmailFromAddressOk() (*string, bool)` + +GetEmailFromAddressOk returns a tuple with the EmailFromAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailFromAddress + +`func (o *BrandingItemCreate) SetEmailFromAddress(v string)` + +SetEmailFromAddress sets EmailFromAddress field to given value. + +### HasEmailFromAddress + +`func (o *BrandingItemCreate) HasEmailFromAddress() bool` + +HasEmailFromAddress returns a boolean if a field has been set. + +### GetLoginInformationalMessage + +`func (o *BrandingItemCreate) GetLoginInformationalMessage() string` + +GetLoginInformationalMessage returns the LoginInformationalMessage field if non-nil, zero value otherwise. + +### GetLoginInformationalMessageOk + +`func (o *BrandingItemCreate) GetLoginInformationalMessageOk() (*string, bool)` + +GetLoginInformationalMessageOk returns a tuple with the LoginInformationalMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginInformationalMessage + +`func (o *BrandingItemCreate) SetLoginInformationalMessage(v string)` + +SetLoginInformationalMessage sets LoginInformationalMessage field to given value. + +### HasLoginInformationalMessage + +`func (o *BrandingItemCreate) HasLoginInformationalMessage() bool` + +HasLoginInformationalMessage returns a boolean if a field has been set. + +### GetFileStandard + +`func (o *BrandingItemCreate) GetFileStandard() *os.File` + +GetFileStandard returns the FileStandard field if non-nil, zero value otherwise. + +### GetFileStandardOk + +`func (o *BrandingItemCreate) GetFileStandardOk() (**os.File, bool)` + +GetFileStandardOk returns a tuple with the FileStandard field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileStandard + +`func (o *BrandingItemCreate) SetFileStandard(v *os.File)` + +SetFileStandard sets FileStandard field to given value. + +### HasFileStandard + +`func (o *BrandingItemCreate) HasFileStandard() bool` + +HasFileStandard returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BucketAggregation.md b/docs/tools/sdk/go/Reference/V2024/Models/BucketAggregation.md new file mode 100644 index 000000000..fc501d53f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BucketAggregation.md @@ -0,0 +1,158 @@ +--- +id: v2024-bucket-aggregation +title: BucketAggregation +pagination_label: BucketAggregation +sidebar_label: BucketAggregation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BucketAggregation', 'V2024BucketAggregation'] +slug: /tools/sdk/go/v2024/models/bucket-aggregation +tags: ['SDK', 'Software Development Kit', 'BucketAggregation', 'V2024BucketAggregation'] +--- + +# BucketAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the bucket aggregate to be included in the result. | +**Type** | Pointer to [**BucketType**](bucket-type) | | [optional] [default to BUCKETTYPE_TERMS] +**Field** | **string** | The field to bucket on. Prefix the field name with '@' to reference a nested object. | +**Size** | Pointer to **int32** | Maximum number of buckets to include. | [optional] +**MinDocCount** | Pointer to **int32** | Minimum number of documents a bucket should have. | [optional] + +## Methods + +### NewBucketAggregation + +`func NewBucketAggregation(name string, field string, ) *BucketAggregation` + +NewBucketAggregation instantiates a new BucketAggregation 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 + +### NewBucketAggregationWithDefaults + +`func NewBucketAggregationWithDefaults() *BucketAggregation` + +NewBucketAggregationWithDefaults instantiates a new BucketAggregation 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 + +### GetName + +`func (o *BucketAggregation) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BucketAggregation) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BucketAggregation) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *BucketAggregation) GetType() BucketType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BucketAggregation) GetTypeOk() (*BucketType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BucketAggregation) SetType(v BucketType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BucketAggregation) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetField + +`func (o *BucketAggregation) GetField() string` + +GetField returns the Field field if non-nil, zero value otherwise. + +### GetFieldOk + +`func (o *BucketAggregation) GetFieldOk() (*string, bool)` + +GetFieldOk returns a tuple with the Field field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetField + +`func (o *BucketAggregation) SetField(v string)` + +SetField sets Field field to given value. + + +### GetSize + +`func (o *BucketAggregation) GetSize() int32` + +GetSize returns the Size field if non-nil, zero value otherwise. + +### GetSizeOk + +`func (o *BucketAggregation) GetSizeOk() (*int32, bool)` + +GetSizeOk returns a tuple with the Size field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSize + +`func (o *BucketAggregation) SetSize(v int32)` + +SetSize sets Size field to given value. + +### HasSize + +`func (o *BucketAggregation) HasSize() bool` + +HasSize returns a boolean if a field has been set. + +### GetMinDocCount + +`func (o *BucketAggregation) GetMinDocCount() int32` + +GetMinDocCount returns the MinDocCount field if non-nil, zero value otherwise. + +### GetMinDocCountOk + +`func (o *BucketAggregation) GetMinDocCountOk() (*int32, bool)` + +GetMinDocCountOk returns a tuple with the MinDocCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinDocCount + +`func (o *BucketAggregation) SetMinDocCount(v int32)` + +SetMinDocCount sets MinDocCount field to given value. + +### HasMinDocCount + +`func (o *BucketAggregation) HasMinDocCount() bool` + +HasMinDocCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BucketType.md b/docs/tools/sdk/go/Reference/V2024/Models/BucketType.md new file mode 100644 index 000000000..a4cfdb48c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BucketType.md @@ -0,0 +1,19 @@ +--- +id: v2024-bucket-type +title: BucketType +pagination_label: BucketType +sidebar_label: BucketType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BucketType', 'V2024BucketType'] +slug: /tools/sdk/go/v2024/models/bucket-type +tags: ['SDK', 'Software Development Kit', 'BucketType', 'V2024BucketType'] +--- + +# BucketType + +## Enum + + +* `TERMS` (value: `"TERMS"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BulkAddTaggedObject.md b/docs/tools/sdk/go/Reference/V2024/Models/BulkAddTaggedObject.md new file mode 100644 index 000000000..e587d530a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BulkAddTaggedObject.md @@ -0,0 +1,116 @@ +--- +id: v2024-bulk-add-tagged-object +title: BulkAddTaggedObject +pagination_label: BulkAddTaggedObject +sidebar_label: BulkAddTaggedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkAddTaggedObject', 'V2024BulkAddTaggedObject'] +slug: /tools/sdk/go/v2024/models/bulk-add-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkAddTaggedObject', 'V2024BulkAddTaggedObject'] +--- + +# BulkAddTaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]string** | Label to be applied to an Object | [optional] +**Operation** | Pointer to **string** | If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. | [optional] [default to "APPEND"] + +## Methods + +### NewBulkAddTaggedObject + +`func NewBulkAddTaggedObject() *BulkAddTaggedObject` + +NewBulkAddTaggedObject instantiates a new BulkAddTaggedObject 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 + +### NewBulkAddTaggedObjectWithDefaults + +`func NewBulkAddTaggedObjectWithDefaults() *BulkAddTaggedObject` + +NewBulkAddTaggedObjectWithDefaults instantiates a new BulkAddTaggedObject 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 + +### GetObjectRefs + +`func (o *BulkAddTaggedObject) GetObjectRefs() []TaggedObjectDto` + +GetObjectRefs returns the ObjectRefs field if non-nil, zero value otherwise. + +### GetObjectRefsOk + +`func (o *BulkAddTaggedObject) GetObjectRefsOk() (*[]TaggedObjectDto, bool)` + +GetObjectRefsOk returns a tuple with the ObjectRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectRefs + +`func (o *BulkAddTaggedObject) SetObjectRefs(v []TaggedObjectDto)` + +SetObjectRefs sets ObjectRefs field to given value. + +### HasObjectRefs + +`func (o *BulkAddTaggedObject) HasObjectRefs() bool` + +HasObjectRefs returns a boolean if a field has been set. + +### GetTags + +`func (o *BulkAddTaggedObject) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *BulkAddTaggedObject) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *BulkAddTaggedObject) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *BulkAddTaggedObject) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetOperation + +`func (o *BulkAddTaggedObject) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *BulkAddTaggedObject) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *BulkAddTaggedObject) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *BulkAddTaggedObject) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BulkApproveAccessRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/BulkApproveAccessRequest.md new file mode 100644 index 000000000..90470e26b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BulkApproveAccessRequest.md @@ -0,0 +1,80 @@ +--- +id: v2024-bulk-approve-access-request +title: BulkApproveAccessRequest +pagination_label: BulkApproveAccessRequest +sidebar_label: BulkApproveAccessRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkApproveAccessRequest', 'V2024BulkApproveAccessRequest'] +slug: /tools/sdk/go/v2024/models/bulk-approve-access-request +tags: ['SDK', 'Software Development Kit', 'BulkApproveAccessRequest', 'V2024BulkApproveAccessRequest'] +--- + +# BulkApproveAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalIds** | **[]string** | List of approval ids to approve the pending requests | +**Comment** | **string** | Reason for approving the pending access request. | + +## Methods + +### NewBulkApproveAccessRequest + +`func NewBulkApproveAccessRequest(approvalIds []string, comment string, ) *BulkApproveAccessRequest` + +NewBulkApproveAccessRequest instantiates a new BulkApproveAccessRequest 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 + +### NewBulkApproveAccessRequestWithDefaults + +`func NewBulkApproveAccessRequestWithDefaults() *BulkApproveAccessRequest` + +NewBulkApproveAccessRequestWithDefaults instantiates a new BulkApproveAccessRequest 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 + +### GetApprovalIds + +`func (o *BulkApproveAccessRequest) GetApprovalIds() []string` + +GetApprovalIds returns the ApprovalIds field if non-nil, zero value otherwise. + +### GetApprovalIdsOk + +`func (o *BulkApproveAccessRequest) GetApprovalIdsOk() (*[]string, bool)` + +GetApprovalIdsOk returns a tuple with the ApprovalIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalIds + +`func (o *BulkApproveAccessRequest) SetApprovalIds(v []string)` + +SetApprovalIds sets ApprovalIds field to given value. + + +### GetComment + +`func (o *BulkApproveAccessRequest) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *BulkApproveAccessRequest) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *BulkApproveAccessRequest) SetComment(v string)` + +SetComment sets Comment field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BulkCancelAccessRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/BulkCancelAccessRequest.md new file mode 100644 index 000000000..e581464eb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BulkCancelAccessRequest.md @@ -0,0 +1,80 @@ +--- +id: v2024-bulk-cancel-access-request +title: BulkCancelAccessRequest +pagination_label: BulkCancelAccessRequest +sidebar_label: BulkCancelAccessRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkCancelAccessRequest', 'V2024BulkCancelAccessRequest'] +slug: /tools/sdk/go/v2024/models/bulk-cancel-access-request +tags: ['SDK', 'Software Development Kit', 'BulkCancelAccessRequest', 'V2024BulkCancelAccessRequest'] +--- + +# BulkCancelAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestIds** | **[]string** | List of access requests ids to cancel the pending requests | +**Comment** | **string** | Reason for cancelling the pending access request. | + +## Methods + +### NewBulkCancelAccessRequest + +`func NewBulkCancelAccessRequest(accessRequestIds []string, comment string, ) *BulkCancelAccessRequest` + +NewBulkCancelAccessRequest instantiates a new BulkCancelAccessRequest 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 + +### NewBulkCancelAccessRequestWithDefaults + +`func NewBulkCancelAccessRequestWithDefaults() *BulkCancelAccessRequest` + +NewBulkCancelAccessRequestWithDefaults instantiates a new BulkCancelAccessRequest 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 + +### GetAccessRequestIds + +`func (o *BulkCancelAccessRequest) GetAccessRequestIds() []string` + +GetAccessRequestIds returns the AccessRequestIds field if non-nil, zero value otherwise. + +### GetAccessRequestIdsOk + +`func (o *BulkCancelAccessRequest) GetAccessRequestIdsOk() (*[]string, bool)` + +GetAccessRequestIdsOk returns a tuple with the AccessRequestIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestIds + +`func (o *BulkCancelAccessRequest) SetAccessRequestIds(v []string)` + +SetAccessRequestIds sets AccessRequestIds field to given value. + + +### GetComment + +`func (o *BulkCancelAccessRequest) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *BulkCancelAccessRequest) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *BulkCancelAccessRequest) SetComment(v string)` + +SetComment sets Comment field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BulkIdentitiesAccountsResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/BulkIdentitiesAccountsResponse.md new file mode 100644 index 000000000..9cfb95d16 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BulkIdentitiesAccountsResponse.md @@ -0,0 +1,116 @@ +--- +id: v2024-bulk-identities-accounts-response +title: BulkIdentitiesAccountsResponse +pagination_label: BulkIdentitiesAccountsResponse +sidebar_label: BulkIdentitiesAccountsResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkIdentitiesAccountsResponse', 'V2024BulkIdentitiesAccountsResponse'] +slug: /tools/sdk/go/v2024/models/bulk-identities-accounts-response +tags: ['SDK', 'Software Development Kit', 'BulkIdentitiesAccountsResponse', 'V2024BulkIdentitiesAccountsResponse'] +--- + +# BulkIdentitiesAccountsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Identifier of bulk request item. | [optional] +**StatusCode** | Pointer to **int32** | Response status value. | [optional] +**Message** | Pointer to **string** | Status containing additional context information about failures. | [optional] + +## Methods + +### NewBulkIdentitiesAccountsResponse + +`func NewBulkIdentitiesAccountsResponse() *BulkIdentitiesAccountsResponse` + +NewBulkIdentitiesAccountsResponse instantiates a new BulkIdentitiesAccountsResponse 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 + +### NewBulkIdentitiesAccountsResponseWithDefaults + +`func NewBulkIdentitiesAccountsResponseWithDefaults() *BulkIdentitiesAccountsResponse` + +NewBulkIdentitiesAccountsResponseWithDefaults instantiates a new BulkIdentitiesAccountsResponse 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 + +### GetId + +`func (o *BulkIdentitiesAccountsResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BulkIdentitiesAccountsResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BulkIdentitiesAccountsResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BulkIdentitiesAccountsResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetStatusCode + +`func (o *BulkIdentitiesAccountsResponse) GetStatusCode() int32` + +GetStatusCode returns the StatusCode field if non-nil, zero value otherwise. + +### GetStatusCodeOk + +`func (o *BulkIdentitiesAccountsResponse) GetStatusCodeOk() (*int32, bool)` + +GetStatusCodeOk returns a tuple with the StatusCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusCode + +`func (o *BulkIdentitiesAccountsResponse) SetStatusCode(v int32)` + +SetStatusCode sets StatusCode field to given value. + +### HasStatusCode + +`func (o *BulkIdentitiesAccountsResponse) HasStatusCode() bool` + +HasStatusCode returns a boolean if a field has been set. + +### GetMessage + +`func (o *BulkIdentitiesAccountsResponse) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *BulkIdentitiesAccountsResponse) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *BulkIdentitiesAccountsResponse) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *BulkIdentitiesAccountsResponse) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BulkRemoveTaggedObject.md b/docs/tools/sdk/go/Reference/V2024/Models/BulkRemoveTaggedObject.md new file mode 100644 index 000000000..f25eb76e0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BulkRemoveTaggedObject.md @@ -0,0 +1,90 @@ +--- +id: v2024-bulk-remove-tagged-object +title: BulkRemoveTaggedObject +pagination_label: BulkRemoveTaggedObject +sidebar_label: BulkRemoveTaggedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkRemoveTaggedObject', 'V2024BulkRemoveTaggedObject'] +slug: /tools/sdk/go/v2024/models/bulk-remove-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkRemoveTaggedObject', 'V2024BulkRemoveTaggedObject'] +--- + +# BulkRemoveTaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]string** | Label to be applied to an Object | [optional] + +## Methods + +### NewBulkRemoveTaggedObject + +`func NewBulkRemoveTaggedObject() *BulkRemoveTaggedObject` + +NewBulkRemoveTaggedObject instantiates a new BulkRemoveTaggedObject 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 + +### NewBulkRemoveTaggedObjectWithDefaults + +`func NewBulkRemoveTaggedObjectWithDefaults() *BulkRemoveTaggedObject` + +NewBulkRemoveTaggedObjectWithDefaults instantiates a new BulkRemoveTaggedObject 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 + +### GetObjectRefs + +`func (o *BulkRemoveTaggedObject) GetObjectRefs() []TaggedObjectDto` + +GetObjectRefs returns the ObjectRefs field if non-nil, zero value otherwise. + +### GetObjectRefsOk + +`func (o *BulkRemoveTaggedObject) GetObjectRefsOk() (*[]TaggedObjectDto, bool)` + +GetObjectRefsOk returns a tuple with the ObjectRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectRefs + +`func (o *BulkRemoveTaggedObject) SetObjectRefs(v []TaggedObjectDto)` + +SetObjectRefs sets ObjectRefs field to given value. + +### HasObjectRefs + +`func (o *BulkRemoveTaggedObject) HasObjectRefs() bool` + +HasObjectRefs returns a boolean if a field has been set. + +### GetTags + +`func (o *BulkRemoveTaggedObject) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *BulkRemoveTaggedObject) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *BulkRemoveTaggedObject) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *BulkRemoveTaggedObject) HasTags() bool` + +HasTags returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/BulkTaggedObjectResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/BulkTaggedObjectResponse.md new file mode 100644 index 000000000..74ed3ea11 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/BulkTaggedObjectResponse.md @@ -0,0 +1,90 @@ +--- +id: v2024-bulk-tagged-object-response +title: BulkTaggedObjectResponse +pagination_label: BulkTaggedObjectResponse +sidebar_label: BulkTaggedObjectResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkTaggedObjectResponse', 'V2024BulkTaggedObjectResponse'] +slug: /tools/sdk/go/v2024/models/bulk-tagged-object-response +tags: ['SDK', 'Software Development Kit', 'BulkTaggedObjectResponse', 'V2024BulkTaggedObjectResponse'] +--- + +# BulkTaggedObjectResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]string** | Label to be applied to an Object | [optional] + +## Methods + +### NewBulkTaggedObjectResponse + +`func NewBulkTaggedObjectResponse() *BulkTaggedObjectResponse` + +NewBulkTaggedObjectResponse instantiates a new BulkTaggedObjectResponse 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 + +### NewBulkTaggedObjectResponseWithDefaults + +`func NewBulkTaggedObjectResponseWithDefaults() *BulkTaggedObjectResponse` + +NewBulkTaggedObjectResponseWithDefaults instantiates a new BulkTaggedObjectResponse 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 + +### GetObjectRefs + +`func (o *BulkTaggedObjectResponse) GetObjectRefs() []TaggedObjectDto` + +GetObjectRefs returns the ObjectRefs field if non-nil, zero value otherwise. + +### GetObjectRefsOk + +`func (o *BulkTaggedObjectResponse) GetObjectRefsOk() (*[]TaggedObjectDto, bool)` + +GetObjectRefsOk returns a tuple with the ObjectRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectRefs + +`func (o *BulkTaggedObjectResponse) SetObjectRefs(v []TaggedObjectDto)` + +SetObjectRefs sets ObjectRefs field to given value. + +### HasObjectRefs + +`func (o *BulkTaggedObjectResponse) HasObjectRefs() bool` + +HasObjectRefs returns a boolean if a field has been set. + +### GetTags + +`func (o *BulkTaggedObjectResponse) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *BulkTaggedObjectResponse) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *BulkTaggedObjectResponse) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *BulkTaggedObjectResponse) HasTags() bool` + +HasTags returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Campaign.md b/docs/tools/sdk/go/Reference/V2024/Models/Campaign.md new file mode 100644 index 000000000..e9b7aecbe --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Campaign.md @@ -0,0 +1,771 @@ +--- +id: v2024-campaign +title: Campaign +pagination_label: Campaign +sidebar_label: Campaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Campaign', 'V2024Campaign'] +slug: /tools/sdk/go/v2024/models/campaign +tags: ['SDK', 'Software Development Kit', 'Campaign', 'V2024Campaign'] +--- + +# Campaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | Id of the campaign | [optional] [readonly] +**Name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Description** | **NullableString** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Deadline** | Pointer to **NullableTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **string** | The type of campaign. Could be extended in the future. | +**EmailNotificationEnabled** | Pointer to **bool** | Enables email notification for this campaign | [optional] [default to false] +**AutoRevokeAllowed** | Pointer to **bool** | Allows auto revoke for this campaign | [optional] [default to false] +**RecommendationsEnabled** | Pointer to **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to false] +**Status** | Pointer to **NullableString** | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **NullableTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **NullableInt32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **NullableInt32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **NullableTime** | Modified time of the campaign | [optional] [readonly] +**Filter** | Pointer to [**NullableCampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **bool** | Determines if comments on sunset date changes are required. | [optional] [default to true] +**SourceOwnerCampaignInfo** | Pointer to [**NullableCampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**NullableCampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**NullableCampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**NullableCampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Methods + +### NewCampaign + +`func NewCampaign(name string, description NullableString, type_ string, ) *Campaign` + +NewCampaign instantiates a new Campaign 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 + +### NewCampaignWithDefaults + +`func NewCampaignWithDefaults() *Campaign` + +NewCampaignWithDefaults instantiates a new Campaign 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 + +### GetId + +`func (o *Campaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Campaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Campaign) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Campaign) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *Campaign) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *Campaign) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *Campaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Campaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Campaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Campaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Campaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Campaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *Campaign) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Campaign) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetDeadline + +`func (o *Campaign) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *Campaign) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *Campaign) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *Campaign) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### SetDeadlineNil + +`func (o *Campaign) SetDeadlineNil(b bool)` + + SetDeadlineNil sets the value for Deadline to be an explicit nil + +### UnsetDeadline +`func (o *Campaign) UnsetDeadline()` + +UnsetDeadline ensures that no value is present for Deadline, not even an explicit nil +### GetType + +`func (o *Campaign) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Campaign) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Campaign) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEmailNotificationEnabled + +`func (o *Campaign) GetEmailNotificationEnabled() bool` + +GetEmailNotificationEnabled returns the EmailNotificationEnabled field if non-nil, zero value otherwise. + +### GetEmailNotificationEnabledOk + +`func (o *Campaign) GetEmailNotificationEnabledOk() (*bool, bool)` + +GetEmailNotificationEnabledOk returns a tuple with the EmailNotificationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationEnabled + +`func (o *Campaign) SetEmailNotificationEnabled(v bool)` + +SetEmailNotificationEnabled sets EmailNotificationEnabled field to given value. + +### HasEmailNotificationEnabled + +`func (o *Campaign) HasEmailNotificationEnabled() bool` + +HasEmailNotificationEnabled returns a boolean if a field has been set. + +### GetAutoRevokeAllowed + +`func (o *Campaign) GetAutoRevokeAllowed() bool` + +GetAutoRevokeAllowed returns the AutoRevokeAllowed field if non-nil, zero value otherwise. + +### GetAutoRevokeAllowedOk + +`func (o *Campaign) GetAutoRevokeAllowedOk() (*bool, bool)` + +GetAutoRevokeAllowedOk returns a tuple with the AutoRevokeAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoRevokeAllowed + +`func (o *Campaign) SetAutoRevokeAllowed(v bool)` + +SetAutoRevokeAllowed sets AutoRevokeAllowed field to given value. + +### HasAutoRevokeAllowed + +`func (o *Campaign) HasAutoRevokeAllowed() bool` + +HasAutoRevokeAllowed returns a boolean if a field has been set. + +### GetRecommendationsEnabled + +`func (o *Campaign) GetRecommendationsEnabled() bool` + +GetRecommendationsEnabled returns the RecommendationsEnabled field if non-nil, zero value otherwise. + +### GetRecommendationsEnabledOk + +`func (o *Campaign) GetRecommendationsEnabledOk() (*bool, bool)` + +GetRecommendationsEnabledOk returns a tuple with the RecommendationsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendationsEnabled + +`func (o *Campaign) SetRecommendationsEnabled(v bool)` + +SetRecommendationsEnabled sets RecommendationsEnabled field to given value. + +### HasRecommendationsEnabled + +`func (o *Campaign) HasRecommendationsEnabled() bool` + +HasRecommendationsEnabled returns a boolean if a field has been set. + +### GetStatus + +`func (o *Campaign) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Campaign) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Campaign) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Campaign) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatusNil + +`func (o *Campaign) SetStatusNil(b bool)` + + SetStatusNil sets the value for Status to be an explicit nil + +### UnsetStatus +`func (o *Campaign) UnsetStatus()` + +UnsetStatus ensures that no value is present for Status, not even an explicit nil +### GetCorrelatedStatus + +`func (o *Campaign) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *Campaign) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *Campaign) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + +### HasCorrelatedStatus + +`func (o *Campaign) HasCorrelatedStatus() bool` + +HasCorrelatedStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *Campaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Campaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Campaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Campaign) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *Campaign) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *Campaign) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetTotalCertifications + +`func (o *Campaign) GetTotalCertifications() int32` + +GetTotalCertifications returns the TotalCertifications field if non-nil, zero value otherwise. + +### GetTotalCertificationsOk + +`func (o *Campaign) GetTotalCertificationsOk() (*int32, bool)` + +GetTotalCertificationsOk returns a tuple with the TotalCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCertifications + +`func (o *Campaign) SetTotalCertifications(v int32)` + +SetTotalCertifications sets TotalCertifications field to given value. + +### HasTotalCertifications + +`func (o *Campaign) HasTotalCertifications() bool` + +HasTotalCertifications returns a boolean if a field has been set. + +### SetTotalCertificationsNil + +`func (o *Campaign) SetTotalCertificationsNil(b bool)` + + SetTotalCertificationsNil sets the value for TotalCertifications to be an explicit nil + +### UnsetTotalCertifications +`func (o *Campaign) UnsetTotalCertifications()` + +UnsetTotalCertifications ensures that no value is present for TotalCertifications, not even an explicit nil +### GetCompletedCertifications + +`func (o *Campaign) GetCompletedCertifications() int32` + +GetCompletedCertifications returns the CompletedCertifications field if non-nil, zero value otherwise. + +### GetCompletedCertificationsOk + +`func (o *Campaign) GetCompletedCertificationsOk() (*int32, bool)` + +GetCompletedCertificationsOk returns a tuple with the CompletedCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedCertifications + +`func (o *Campaign) SetCompletedCertifications(v int32)` + +SetCompletedCertifications sets CompletedCertifications field to given value. + +### HasCompletedCertifications + +`func (o *Campaign) HasCompletedCertifications() bool` + +HasCompletedCertifications returns a boolean if a field has been set. + +### SetCompletedCertificationsNil + +`func (o *Campaign) SetCompletedCertificationsNil(b bool)` + + SetCompletedCertificationsNil sets the value for CompletedCertifications to be an explicit nil + +### UnsetCompletedCertifications +`func (o *Campaign) UnsetCompletedCertifications()` + +UnsetCompletedCertifications ensures that no value is present for CompletedCertifications, not even an explicit nil +### GetAlerts + +`func (o *Campaign) GetAlerts() []CampaignAlert` + +GetAlerts returns the Alerts field if non-nil, zero value otherwise. + +### GetAlertsOk + +`func (o *Campaign) GetAlertsOk() (*[]CampaignAlert, bool)` + +GetAlertsOk returns a tuple with the Alerts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlerts + +`func (o *Campaign) SetAlerts(v []CampaignAlert)` + +SetAlerts sets Alerts field to given value. + +### HasAlerts + +`func (o *Campaign) HasAlerts() bool` + +HasAlerts returns a boolean if a field has been set. + +### SetAlertsNil + +`func (o *Campaign) SetAlertsNil(b bool)` + + SetAlertsNil sets the value for Alerts to be an explicit nil + +### UnsetAlerts +`func (o *Campaign) UnsetAlerts()` + +UnsetAlerts ensures that no value is present for Alerts, not even an explicit nil +### GetModified + +`func (o *Campaign) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Campaign) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Campaign) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Campaign) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *Campaign) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *Campaign) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetFilter + +`func (o *Campaign) GetFilter() CampaignAllOfFilter` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *Campaign) GetFilterOk() (*CampaignAllOfFilter, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *Campaign) SetFilter(v CampaignAllOfFilter)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *Campaign) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### SetFilterNil + +`func (o *Campaign) SetFilterNil(b bool)` + + SetFilterNil sets the value for Filter to be an explicit nil + +### UnsetFilter +`func (o *Campaign) UnsetFilter()` + +UnsetFilter ensures that no value is present for Filter, not even an explicit nil +### GetSunsetCommentsRequired + +`func (o *Campaign) GetSunsetCommentsRequired() bool` + +GetSunsetCommentsRequired returns the SunsetCommentsRequired field if non-nil, zero value otherwise. + +### GetSunsetCommentsRequiredOk + +`func (o *Campaign) GetSunsetCommentsRequiredOk() (*bool, bool)` + +GetSunsetCommentsRequiredOk returns a tuple with the SunsetCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSunsetCommentsRequired + +`func (o *Campaign) SetSunsetCommentsRequired(v bool)` + +SetSunsetCommentsRequired sets SunsetCommentsRequired field to given value. + +### HasSunsetCommentsRequired + +`func (o *Campaign) HasSunsetCommentsRequired() bool` + +HasSunsetCommentsRequired returns a boolean if a field has been set. + +### GetSourceOwnerCampaignInfo + +`func (o *Campaign) GetSourceOwnerCampaignInfo() CampaignAllOfSourceOwnerCampaignInfo` + +GetSourceOwnerCampaignInfo returns the SourceOwnerCampaignInfo field if non-nil, zero value otherwise. + +### GetSourceOwnerCampaignInfoOk + +`func (o *Campaign) GetSourceOwnerCampaignInfoOk() (*CampaignAllOfSourceOwnerCampaignInfo, bool)` + +GetSourceOwnerCampaignInfoOk returns a tuple with the SourceOwnerCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceOwnerCampaignInfo + +`func (o *Campaign) SetSourceOwnerCampaignInfo(v CampaignAllOfSourceOwnerCampaignInfo)` + +SetSourceOwnerCampaignInfo sets SourceOwnerCampaignInfo field to given value. + +### HasSourceOwnerCampaignInfo + +`func (o *Campaign) HasSourceOwnerCampaignInfo() bool` + +HasSourceOwnerCampaignInfo returns a boolean if a field has been set. + +### SetSourceOwnerCampaignInfoNil + +`func (o *Campaign) SetSourceOwnerCampaignInfoNil(b bool)` + + SetSourceOwnerCampaignInfoNil sets the value for SourceOwnerCampaignInfo to be an explicit nil + +### UnsetSourceOwnerCampaignInfo +`func (o *Campaign) UnsetSourceOwnerCampaignInfo()` + +UnsetSourceOwnerCampaignInfo ensures that no value is present for SourceOwnerCampaignInfo, not even an explicit nil +### GetSearchCampaignInfo + +`func (o *Campaign) GetSearchCampaignInfo() CampaignAllOfSearchCampaignInfo` + +GetSearchCampaignInfo returns the SearchCampaignInfo field if non-nil, zero value otherwise. + +### GetSearchCampaignInfoOk + +`func (o *Campaign) GetSearchCampaignInfoOk() (*CampaignAllOfSearchCampaignInfo, bool)` + +GetSearchCampaignInfoOk returns a tuple with the SearchCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchCampaignInfo + +`func (o *Campaign) SetSearchCampaignInfo(v CampaignAllOfSearchCampaignInfo)` + +SetSearchCampaignInfo sets SearchCampaignInfo field to given value. + +### HasSearchCampaignInfo + +`func (o *Campaign) HasSearchCampaignInfo() bool` + +HasSearchCampaignInfo returns a boolean if a field has been set. + +### SetSearchCampaignInfoNil + +`func (o *Campaign) SetSearchCampaignInfoNil(b bool)` + + SetSearchCampaignInfoNil sets the value for SearchCampaignInfo to be an explicit nil + +### UnsetSearchCampaignInfo +`func (o *Campaign) UnsetSearchCampaignInfo()` + +UnsetSearchCampaignInfo ensures that no value is present for SearchCampaignInfo, not even an explicit nil +### GetRoleCompositionCampaignInfo + +`func (o *Campaign) GetRoleCompositionCampaignInfo() CampaignAllOfRoleCompositionCampaignInfo` + +GetRoleCompositionCampaignInfo returns the RoleCompositionCampaignInfo field if non-nil, zero value otherwise. + +### GetRoleCompositionCampaignInfoOk + +`func (o *Campaign) GetRoleCompositionCampaignInfoOk() (*CampaignAllOfRoleCompositionCampaignInfo, bool)` + +GetRoleCompositionCampaignInfoOk returns a tuple with the RoleCompositionCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleCompositionCampaignInfo + +`func (o *Campaign) SetRoleCompositionCampaignInfo(v CampaignAllOfRoleCompositionCampaignInfo)` + +SetRoleCompositionCampaignInfo sets RoleCompositionCampaignInfo field to given value. + +### HasRoleCompositionCampaignInfo + +`func (o *Campaign) HasRoleCompositionCampaignInfo() bool` + +HasRoleCompositionCampaignInfo returns a boolean if a field has been set. + +### SetRoleCompositionCampaignInfoNil + +`func (o *Campaign) SetRoleCompositionCampaignInfoNil(b bool)` + + SetRoleCompositionCampaignInfoNil sets the value for RoleCompositionCampaignInfo to be an explicit nil + +### UnsetRoleCompositionCampaignInfo +`func (o *Campaign) UnsetRoleCompositionCampaignInfo()` + +UnsetRoleCompositionCampaignInfo ensures that no value is present for RoleCompositionCampaignInfo, not even an explicit nil +### GetMachineAccountCampaignInfo + +`func (o *Campaign) GetMachineAccountCampaignInfo() CampaignAllOfMachineAccountCampaignInfo` + +GetMachineAccountCampaignInfo returns the MachineAccountCampaignInfo field if non-nil, zero value otherwise. + +### GetMachineAccountCampaignInfoOk + +`func (o *Campaign) GetMachineAccountCampaignInfoOk() (*CampaignAllOfMachineAccountCampaignInfo, bool)` + +GetMachineAccountCampaignInfoOk returns a tuple with the MachineAccountCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMachineAccountCampaignInfo + +`func (o *Campaign) SetMachineAccountCampaignInfo(v CampaignAllOfMachineAccountCampaignInfo)` + +SetMachineAccountCampaignInfo sets MachineAccountCampaignInfo field to given value. + +### HasMachineAccountCampaignInfo + +`func (o *Campaign) HasMachineAccountCampaignInfo() bool` + +HasMachineAccountCampaignInfo returns a boolean if a field has been set. + +### SetMachineAccountCampaignInfoNil + +`func (o *Campaign) SetMachineAccountCampaignInfoNil(b bool)` + + SetMachineAccountCampaignInfoNil sets the value for MachineAccountCampaignInfo to be an explicit nil + +### UnsetMachineAccountCampaignInfo +`func (o *Campaign) UnsetMachineAccountCampaignInfo()` + +UnsetMachineAccountCampaignInfo ensures that no value is present for MachineAccountCampaignInfo, not even an explicit nil +### GetSourcesWithOrphanEntitlements + +`func (o *Campaign) GetSourcesWithOrphanEntitlements() []CampaignAllOfSourcesWithOrphanEntitlements` + +GetSourcesWithOrphanEntitlements returns the SourcesWithOrphanEntitlements field if non-nil, zero value otherwise. + +### GetSourcesWithOrphanEntitlementsOk + +`func (o *Campaign) GetSourcesWithOrphanEntitlementsOk() (*[]CampaignAllOfSourcesWithOrphanEntitlements, bool)` + +GetSourcesWithOrphanEntitlementsOk returns a tuple with the SourcesWithOrphanEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourcesWithOrphanEntitlements + +`func (o *Campaign) SetSourcesWithOrphanEntitlements(v []CampaignAllOfSourcesWithOrphanEntitlements)` + +SetSourcesWithOrphanEntitlements sets SourcesWithOrphanEntitlements field to given value. + +### HasSourcesWithOrphanEntitlements + +`func (o *Campaign) HasSourcesWithOrphanEntitlements() bool` + +HasSourcesWithOrphanEntitlements returns a boolean if a field has been set. + +### SetSourcesWithOrphanEntitlementsNil + +`func (o *Campaign) SetSourcesWithOrphanEntitlementsNil(b bool)` + + SetSourcesWithOrphanEntitlementsNil sets the value for SourcesWithOrphanEntitlements to be an explicit nil + +### UnsetSourcesWithOrphanEntitlements +`func (o *Campaign) UnsetSourcesWithOrphanEntitlements()` + +UnsetSourcesWithOrphanEntitlements ensures that no value is present for SourcesWithOrphanEntitlements, not even an explicit nil +### GetMandatoryCommentRequirement + +`func (o *Campaign) GetMandatoryCommentRequirement() string` + +GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise. + +### GetMandatoryCommentRequirementOk + +`func (o *Campaign) GetMandatoryCommentRequirementOk() (*string, bool)` + +GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMandatoryCommentRequirement + +`func (o *Campaign) SetMandatoryCommentRequirement(v string)` + +SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value. + +### HasMandatoryCommentRequirement + +`func (o *Campaign) HasMandatoryCommentRequirement() bool` + +HasMandatoryCommentRequirement returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignActivated.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignActivated.md new file mode 100644 index 000000000..6ab12a98c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignActivated.md @@ -0,0 +1,59 @@ +--- +id: v2024-campaign-activated +title: CampaignActivated +pagination_label: CampaignActivated +sidebar_label: CampaignActivated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignActivated', 'V2024CampaignActivated'] +slug: /tools/sdk/go/v2024/models/campaign-activated +tags: ['SDK', 'Software Development Kit', 'CampaignActivated', 'V2024CampaignActivated'] +--- + +# CampaignActivated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | [**CampaignActivatedCampaign**](campaign-activated-campaign) | | + +## Methods + +### NewCampaignActivated + +`func NewCampaignActivated(campaign CampaignActivatedCampaign, ) *CampaignActivated` + +NewCampaignActivated instantiates a new CampaignActivated 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 + +### NewCampaignActivatedWithDefaults + +`func NewCampaignActivatedWithDefaults() *CampaignActivated` + +NewCampaignActivatedWithDefaults instantiates a new CampaignActivated 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 + +### GetCampaign + +`func (o *CampaignActivated) GetCampaign() CampaignActivatedCampaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignActivated) GetCampaignOk() (*CampaignActivatedCampaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *CampaignActivated) SetCampaign(v CampaignActivatedCampaign)` + +SetCampaign sets Campaign field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignActivatedCampaign.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignActivatedCampaign.md new file mode 100644 index 000000000..d1e7e2950 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignActivatedCampaign.md @@ -0,0 +1,242 @@ +--- +id: v2024-campaign-activated-campaign +title: CampaignActivatedCampaign +pagination_label: CampaignActivatedCampaign +sidebar_label: CampaignActivatedCampaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignActivatedCampaign', 'V2024CampaignActivatedCampaign'] +slug: /tools/sdk/go/v2024/models/campaign-activated-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaign', 'V2024CampaignActivatedCampaign'] +--- + +# CampaignActivatedCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique ID for the campaign. | +**Name** | **string** | The human friendly name of the campaign. | +**Description** | **string** | Extended description of the campaign. | +**Created** | **SailPointTime** | The date and time the campaign was created. | +**Modified** | Pointer to **NullableTime** | The date and time the campaign was last modified. | [optional] +**Deadline** | **SailPointTime** | The date and time the campaign is due. | +**Type** | **map[string]interface{}** | The type of campaign. | +**CampaignOwner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | +**Status** | **map[string]interface{}** | The current status of the campaign. | + +## Methods + +### NewCampaignActivatedCampaign + +`func NewCampaignActivatedCampaign(id string, name string, description string, created SailPointTime, deadline SailPointTime, type_ map[string]interface{}, campaignOwner CampaignActivatedCampaignCampaignOwner, status map[string]interface{}, ) *CampaignActivatedCampaign` + +NewCampaignActivatedCampaign instantiates a new CampaignActivatedCampaign 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 + +### NewCampaignActivatedCampaignWithDefaults + +`func NewCampaignActivatedCampaignWithDefaults() *CampaignActivatedCampaign` + +NewCampaignActivatedCampaignWithDefaults instantiates a new CampaignActivatedCampaign 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 + +### GetId + +`func (o *CampaignActivatedCampaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignActivatedCampaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignActivatedCampaign) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignActivatedCampaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignActivatedCampaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignActivatedCampaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CampaignActivatedCampaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignActivatedCampaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignActivatedCampaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetCreated + +`func (o *CampaignActivatedCampaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignActivatedCampaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CampaignActivatedCampaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CampaignActivatedCampaign) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CampaignActivatedCampaign) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CampaignActivatedCampaign) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CampaignActivatedCampaign) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CampaignActivatedCampaign) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CampaignActivatedCampaign) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDeadline + +`func (o *CampaignActivatedCampaign) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *CampaignActivatedCampaign) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *CampaignActivatedCampaign) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + + +### GetType + +`func (o *CampaignActivatedCampaign) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignActivatedCampaign) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignActivatedCampaign) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetCampaignOwner + +`func (o *CampaignActivatedCampaign) GetCampaignOwner() CampaignActivatedCampaignCampaignOwner` + +GetCampaignOwner returns the CampaignOwner field if non-nil, zero value otherwise. + +### GetCampaignOwnerOk + +`func (o *CampaignActivatedCampaign) GetCampaignOwnerOk() (*CampaignActivatedCampaignCampaignOwner, bool)` + +GetCampaignOwnerOk returns a tuple with the CampaignOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignOwner + +`func (o *CampaignActivatedCampaign) SetCampaignOwner(v CampaignActivatedCampaignCampaignOwner)` + +SetCampaignOwner sets CampaignOwner field to given value. + + +### GetStatus + +`func (o *CampaignActivatedCampaign) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CampaignActivatedCampaign) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CampaignActivatedCampaign) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignActivatedCampaignCampaignOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignActivatedCampaignCampaignOwner.md new file mode 100644 index 000000000..99348854b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignActivatedCampaignCampaignOwner.md @@ -0,0 +1,101 @@ +--- +id: v2024-campaign-activated-campaign-campaign-owner +title: CampaignActivatedCampaignCampaignOwner +pagination_label: CampaignActivatedCampaignCampaignOwner +sidebar_label: CampaignActivatedCampaignCampaignOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignActivatedCampaignCampaignOwner', 'V2024CampaignActivatedCampaignCampaignOwner'] +slug: /tools/sdk/go/v2024/models/campaign-activated-campaign-campaign-owner +tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaignCampaignOwner', 'V2024CampaignActivatedCampaignCampaignOwner'] +--- + +# CampaignActivatedCampaignCampaignOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the identity. | +**DisplayName** | **string** | The human friendly name of the identity. | +**Email** | **string** | The primary email address of the identity. | + +## Methods + +### NewCampaignActivatedCampaignCampaignOwner + +`func NewCampaignActivatedCampaignCampaignOwner(id string, displayName string, email string, ) *CampaignActivatedCampaignCampaignOwner` + +NewCampaignActivatedCampaignCampaignOwner instantiates a new CampaignActivatedCampaignCampaignOwner 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 + +### NewCampaignActivatedCampaignCampaignOwnerWithDefaults + +`func NewCampaignActivatedCampaignCampaignOwnerWithDefaults() *CampaignActivatedCampaignCampaignOwner` + +NewCampaignActivatedCampaignCampaignOwnerWithDefaults instantiates a new CampaignActivatedCampaignCampaignOwner 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 + +### GetId + +`func (o *CampaignActivatedCampaignCampaignOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignActivatedCampaignCampaignOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignActivatedCampaignCampaignOwner) SetId(v string)` + +SetId sets Id field to given value. + + +### GetDisplayName + +`func (o *CampaignActivatedCampaignCampaignOwner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *CampaignActivatedCampaignCampaignOwner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *CampaignActivatedCampaignCampaignOwner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + + +### GetEmail + +`func (o *CampaignActivatedCampaignCampaignOwner) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *CampaignActivatedCampaignCampaignOwner) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *CampaignActivatedCampaignCampaignOwner) SetEmail(v string)` + +SetEmail sets Email field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignAlert.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAlert.md new file mode 100644 index 000000000..f6dc12fc8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAlert.md @@ -0,0 +1,90 @@ +--- +id: v2024-campaign-alert +title: CampaignAlert +pagination_label: CampaignAlert +sidebar_label: CampaignAlert +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAlert', 'V2024CampaignAlert'] +slug: /tools/sdk/go/v2024/models/campaign-alert +tags: ['SDK', 'Software Development Kit', 'CampaignAlert', 'V2024CampaignAlert'] +--- + +# CampaignAlert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Level** | Pointer to **string** | Denotes the level of the message | [optional] +**Localizations** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] + +## Methods + +### NewCampaignAlert + +`func NewCampaignAlert() *CampaignAlert` + +NewCampaignAlert instantiates a new CampaignAlert 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 + +### NewCampaignAlertWithDefaults + +`func NewCampaignAlertWithDefaults() *CampaignAlert` + +NewCampaignAlertWithDefaults instantiates a new CampaignAlert 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 + +### GetLevel + +`func (o *CampaignAlert) GetLevel() string` + +GetLevel returns the Level field if non-nil, zero value otherwise. + +### GetLevelOk + +`func (o *CampaignAlert) GetLevelOk() (*string, bool)` + +GetLevelOk returns a tuple with the Level field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLevel + +`func (o *CampaignAlert) SetLevel(v string)` + +SetLevel sets Level field to given value. + +### HasLevel + +`func (o *CampaignAlert) HasLevel() bool` + +HasLevel returns a boolean if a field has been set. + +### GetLocalizations + +`func (o *CampaignAlert) GetLocalizations() []ErrorMessageDto` + +GetLocalizations returns the Localizations field if non-nil, zero value otherwise. + +### GetLocalizationsOk + +`func (o *CampaignAlert) GetLocalizationsOk() (*[]ErrorMessageDto, bool)` + +GetLocalizationsOk returns a tuple with the Localizations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizations + +`func (o *CampaignAlert) SetLocalizations(v []ErrorMessageDto)` + +SetLocalizations sets Localizations field to given value. + +### HasLocalizations + +`func (o *CampaignAlert) HasLocalizations() bool` + +HasLocalizations returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfFilter.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfFilter.md new file mode 100644 index 000000000..d1aac3556 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfFilter.md @@ -0,0 +1,116 @@ +--- +id: v2024-campaign-all-of-filter +title: CampaignAllOfFilter +pagination_label: CampaignAllOfFilter +sidebar_label: CampaignAllOfFilter +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfFilter', 'V2024CampaignAllOfFilter'] +slug: /tools/sdk/go/v2024/models/campaign-all-of-filter +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfFilter', 'V2024CampaignAllOfFilter'] +--- + +# CampaignAllOfFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of whatever type of filter is being used. | [optional] +**Type** | Pointer to **string** | Type of the filter | [optional] +**Name** | Pointer to **string** | Name of the filter | [optional] + +## Methods + +### NewCampaignAllOfFilter + +`func NewCampaignAllOfFilter() *CampaignAllOfFilter` + +NewCampaignAllOfFilter instantiates a new CampaignAllOfFilter 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 + +### NewCampaignAllOfFilterWithDefaults + +`func NewCampaignAllOfFilterWithDefaults() *CampaignAllOfFilter` + +NewCampaignAllOfFilterWithDefaults instantiates a new CampaignAllOfFilter 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 + +### GetId + +`func (o *CampaignAllOfFilter) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignAllOfFilter) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignAllOfFilter) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignAllOfFilter) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CampaignAllOfFilter) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfFilter) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfFilter) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignAllOfFilter) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignAllOfFilter) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignAllOfFilter) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignAllOfFilter) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignAllOfFilter) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfMachineAccountCampaignInfo.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfMachineAccountCampaignInfo.md new file mode 100644 index 000000000..9a447034a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfMachineAccountCampaignInfo.md @@ -0,0 +1,90 @@ +--- +id: v2024-campaign-all-of-machine-account-campaign-info +title: CampaignAllOfMachineAccountCampaignInfo +pagination_label: CampaignAllOfMachineAccountCampaignInfo +sidebar_label: CampaignAllOfMachineAccountCampaignInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfMachineAccountCampaignInfo', 'V2024CampaignAllOfMachineAccountCampaignInfo'] +slug: /tools/sdk/go/v2024/models/campaign-all-of-machine-account-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfMachineAccountCampaignInfo', 'V2024CampaignAllOfMachineAccountCampaignInfo'] +--- + +# CampaignAllOfMachineAccountCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceIds** | Pointer to **[]string** | The list of sources to be included in the campaign. | [optional] +**ReviewerType** | Pointer to **string** | The reviewer's type. | [optional] + +## Methods + +### NewCampaignAllOfMachineAccountCampaignInfo + +`func NewCampaignAllOfMachineAccountCampaignInfo() *CampaignAllOfMachineAccountCampaignInfo` + +NewCampaignAllOfMachineAccountCampaignInfo instantiates a new CampaignAllOfMachineAccountCampaignInfo 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 + +### NewCampaignAllOfMachineAccountCampaignInfoWithDefaults + +`func NewCampaignAllOfMachineAccountCampaignInfoWithDefaults() *CampaignAllOfMachineAccountCampaignInfo` + +NewCampaignAllOfMachineAccountCampaignInfoWithDefaults instantiates a new CampaignAllOfMachineAccountCampaignInfo 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 + +### GetSourceIds + +`func (o *CampaignAllOfMachineAccountCampaignInfo) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *CampaignAllOfMachineAccountCampaignInfo) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *CampaignAllOfMachineAccountCampaignInfo) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *CampaignAllOfMachineAccountCampaignInfo) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + +### GetReviewerType + +`func (o *CampaignAllOfMachineAccountCampaignInfo) GetReviewerType() string` + +GetReviewerType returns the ReviewerType field if non-nil, zero value otherwise. + +### GetReviewerTypeOk + +`func (o *CampaignAllOfMachineAccountCampaignInfo) GetReviewerTypeOk() (*string, bool)` + +GetReviewerTypeOk returns a tuple with the ReviewerType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerType + +`func (o *CampaignAllOfMachineAccountCampaignInfo) SetReviewerType(v string)` + +SetReviewerType sets ReviewerType field to given value. + +### HasReviewerType + +`func (o *CampaignAllOfMachineAccountCampaignInfo) HasReviewerType() bool` + +HasReviewerType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfo.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfo.md new file mode 100644 index 000000000..8ea0a33f7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfo.md @@ -0,0 +1,229 @@ +--- +id: v2024-campaign-all-of-role-composition-campaign-info +title: CampaignAllOfRoleCompositionCampaignInfo +pagination_label: CampaignAllOfRoleCompositionCampaignInfo +sidebar_label: CampaignAllOfRoleCompositionCampaignInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfo', 'V2024CampaignAllOfRoleCompositionCampaignInfo'] +slug: /tools/sdk/go/v2024/models/campaign-all-of-role-composition-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfo', 'V2024CampaignAllOfRoleCompositionCampaignInfo'] +--- + +# CampaignAllOfRoleCompositionCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReviewerId** | Pointer to **NullableString** | The ID of the identity or governance group reviewing this campaign. Deprecated in favor of the \"reviewer\" object. | [optional] +**Reviewer** | Pointer to [**NullableCampaignAllOfRoleCompositionCampaignInfoReviewer**](campaign-all-of-role-composition-campaign-info-reviewer) | | [optional] +**RoleIds** | Pointer to **[]string** | Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] +**RemediatorRef** | [**CampaignAllOfRoleCompositionCampaignInfoRemediatorRef**](campaign-all-of-role-composition-campaign-info-remediator-ref) | | +**Query** | Pointer to **NullableString** | Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] +**Description** | Pointer to **NullableString** | Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. | [optional] + +## Methods + +### NewCampaignAllOfRoleCompositionCampaignInfo + +`func NewCampaignAllOfRoleCompositionCampaignInfo(remediatorRef CampaignAllOfRoleCompositionCampaignInfoRemediatorRef, ) *CampaignAllOfRoleCompositionCampaignInfo` + +NewCampaignAllOfRoleCompositionCampaignInfo instantiates a new CampaignAllOfRoleCompositionCampaignInfo 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 + +### NewCampaignAllOfRoleCompositionCampaignInfoWithDefaults + +`func NewCampaignAllOfRoleCompositionCampaignInfoWithDefaults() *CampaignAllOfRoleCompositionCampaignInfo` + +NewCampaignAllOfRoleCompositionCampaignInfoWithDefaults instantiates a new CampaignAllOfRoleCompositionCampaignInfo 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 + +### GetReviewerId + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetReviewerId() string` + +GetReviewerId returns the ReviewerId field if non-nil, zero value otherwise. + +### GetReviewerIdOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetReviewerIdOk() (*string, bool)` + +GetReviewerIdOk returns a tuple with the ReviewerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerId + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetReviewerId(v string)` + +SetReviewerId sets ReviewerId field to given value. + +### HasReviewerId + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) HasReviewerId() bool` + +HasReviewerId returns a boolean if a field has been set. + +### SetReviewerIdNil + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetReviewerIdNil(b bool)` + + SetReviewerIdNil sets the value for ReviewerId to be an explicit nil + +### UnsetReviewerId +`func (o *CampaignAllOfRoleCompositionCampaignInfo) UnsetReviewerId()` + +UnsetReviewerId ensures that no value is present for ReviewerId, not even an explicit nil +### GetReviewer + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetReviewer() CampaignAllOfRoleCompositionCampaignInfoReviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetReviewerOk() (*CampaignAllOfRoleCompositionCampaignInfoReviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetReviewer(v CampaignAllOfRoleCompositionCampaignInfoReviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### SetReviewerNil + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetReviewerNil(b bool)` + + SetReviewerNil sets the value for Reviewer to be an explicit nil + +### UnsetReviewer +`func (o *CampaignAllOfRoleCompositionCampaignInfo) UnsetReviewer()` + +UnsetReviewer ensures that no value is present for Reviewer, not even an explicit nil +### GetRoleIds + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetRoleIds() []string` + +GetRoleIds returns the RoleIds field if non-nil, zero value otherwise. + +### GetRoleIdsOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetRoleIdsOk() (*[]string, bool)` + +GetRoleIdsOk returns a tuple with the RoleIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleIds + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetRoleIds(v []string)` + +SetRoleIds sets RoleIds field to given value. + +### HasRoleIds + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) HasRoleIds() bool` + +HasRoleIds returns a boolean if a field has been set. + +### GetRemediatorRef + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetRemediatorRef() CampaignAllOfRoleCompositionCampaignInfoRemediatorRef` + +GetRemediatorRef returns the RemediatorRef field if non-nil, zero value otherwise. + +### GetRemediatorRefOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetRemediatorRefOk() (*CampaignAllOfRoleCompositionCampaignInfoRemediatorRef, bool)` + +GetRemediatorRefOk returns a tuple with the RemediatorRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemediatorRef + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetRemediatorRef(v CampaignAllOfRoleCompositionCampaignInfoRemediatorRef)` + +SetRemediatorRef sets RemediatorRef field to given value. + + +### GetQuery + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### SetQueryNil + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetQueryNil(b bool)` + + SetQueryNil sets the value for Query to be an explicit nil + +### UnsetQuery +`func (o *CampaignAllOfRoleCompositionCampaignInfo) UnsetQuery()` + +UnsetQuery ensures that no value is present for Query, not even an explicit nil +### GetDescription + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CampaignAllOfRoleCompositionCampaignInfo) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md new file mode 100644 index 000000000..dac622722 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md @@ -0,0 +1,106 @@ +--- +id: v2024-campaign-all-of-role-composition-campaign-info-remediator-ref +title: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +pagination_label: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_label: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'V2024CampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +slug: /tools/sdk/go/v2024/models/campaign-all-of-role-composition-campaign-info-remediator-ref +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'V2024CampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +--- + +# CampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Legal Remediator Type | +**Id** | **string** | The ID of the remediator. | +**Name** | Pointer to **string** | The name of the remediator. | [optional] [readonly] + +## Methods + +### NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +`func NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRef(type_ string, id string, ) *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef` + +NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRef instantiates a new CampaignAllOfRoleCompositionCampaignInfoRemediatorRef 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 + +### NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRefWithDefaults + +`func NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRefWithDefaults() *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef` + +NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRefWithDefaults instantiates a new CampaignAllOfRoleCompositionCampaignInfoRemediatorRef 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 + +### GetType + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfoReviewer.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfoReviewer.md new file mode 100644 index 000000000..d8d0ddc54 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfRoleCompositionCampaignInfoReviewer.md @@ -0,0 +1,116 @@ +--- +id: v2024-campaign-all-of-role-composition-campaign-info-reviewer +title: CampaignAllOfRoleCompositionCampaignInfoReviewer +pagination_label: CampaignAllOfRoleCompositionCampaignInfoReviewer +sidebar_label: CampaignAllOfRoleCompositionCampaignInfoReviewer +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfoReviewer', 'V2024CampaignAllOfRoleCompositionCampaignInfoReviewer'] +slug: /tools/sdk/go/v2024/models/campaign-all-of-role-composition-campaign-info-reviewer +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfoReviewer', 'V2024CampaignAllOfRoleCompositionCampaignInfoReviewer'] +--- + +# CampaignAllOfRoleCompositionCampaignInfoReviewer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The reviewer's DTO type. | [optional] +**Id** | Pointer to **string** | The reviewer's ID. | [optional] +**Name** | Pointer to **string** | The reviewer's name. | [optional] + +## Methods + +### NewCampaignAllOfRoleCompositionCampaignInfoReviewer + +`func NewCampaignAllOfRoleCompositionCampaignInfoReviewer() *CampaignAllOfRoleCompositionCampaignInfoReviewer` + +NewCampaignAllOfRoleCompositionCampaignInfoReviewer instantiates a new CampaignAllOfRoleCompositionCampaignInfoReviewer 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 + +### NewCampaignAllOfRoleCompositionCampaignInfoReviewerWithDefaults + +`func NewCampaignAllOfRoleCompositionCampaignInfoReviewerWithDefaults() *CampaignAllOfRoleCompositionCampaignInfoReviewer` + +NewCampaignAllOfRoleCompositionCampaignInfoReviewerWithDefaults instantiates a new CampaignAllOfRoleCompositionCampaignInfoReviewer 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 + +### GetType + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfSearchCampaignInfo.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfSearchCampaignInfo.md new file mode 100644 index 000000000..5fd8d0d34 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfSearchCampaignInfo.md @@ -0,0 +1,219 @@ +--- +id: v2024-campaign-all-of-search-campaign-info +title: CampaignAllOfSearchCampaignInfo +pagination_label: CampaignAllOfSearchCampaignInfo +sidebar_label: CampaignAllOfSearchCampaignInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfSearchCampaignInfo', 'V2024CampaignAllOfSearchCampaignInfo'] +slug: /tools/sdk/go/v2024/models/campaign-all-of-search-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfo', 'V2024CampaignAllOfSearchCampaignInfo'] +--- + +# CampaignAllOfSearchCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of search campaign represented. | +**Description** | Pointer to **string** | Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. | [optional] +**Reviewer** | Pointer to [**NullableCampaignAllOfSearchCampaignInfoReviewer**](campaign-all-of-search-campaign-info-reviewer) | | [optional] +**Query** | Pointer to **NullableString** | The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set. | [optional] +**IdentityIds** | Pointer to **[]string** | A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. | [optional] +**AccessConstraints** | Pointer to [**[]AccessConstraint**](access-constraint) | Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. | [optional] + +## Methods + +### NewCampaignAllOfSearchCampaignInfo + +`func NewCampaignAllOfSearchCampaignInfo(type_ string, ) *CampaignAllOfSearchCampaignInfo` + +NewCampaignAllOfSearchCampaignInfo instantiates a new CampaignAllOfSearchCampaignInfo 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 + +### NewCampaignAllOfSearchCampaignInfoWithDefaults + +`func NewCampaignAllOfSearchCampaignInfoWithDefaults() *CampaignAllOfSearchCampaignInfo` + +NewCampaignAllOfSearchCampaignInfoWithDefaults instantiates a new CampaignAllOfSearchCampaignInfo 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 + +### GetType + +`func (o *CampaignAllOfSearchCampaignInfo) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfSearchCampaignInfo) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDescription + +`func (o *CampaignAllOfSearchCampaignInfo) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignAllOfSearchCampaignInfo) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CampaignAllOfSearchCampaignInfo) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetReviewer + +`func (o *CampaignAllOfSearchCampaignInfo) GetReviewer() CampaignAllOfSearchCampaignInfoReviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetReviewerOk() (*CampaignAllOfSearchCampaignInfoReviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CampaignAllOfSearchCampaignInfo) SetReviewer(v CampaignAllOfSearchCampaignInfoReviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *CampaignAllOfSearchCampaignInfo) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### SetReviewerNil + +`func (o *CampaignAllOfSearchCampaignInfo) SetReviewerNil(b bool)` + + SetReviewerNil sets the value for Reviewer to be an explicit nil + +### UnsetReviewer +`func (o *CampaignAllOfSearchCampaignInfo) UnsetReviewer()` + +UnsetReviewer ensures that no value is present for Reviewer, not even an explicit nil +### GetQuery + +`func (o *CampaignAllOfSearchCampaignInfo) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *CampaignAllOfSearchCampaignInfo) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *CampaignAllOfSearchCampaignInfo) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### SetQueryNil + +`func (o *CampaignAllOfSearchCampaignInfo) SetQueryNil(b bool)` + + SetQueryNil sets the value for Query to be an explicit nil + +### UnsetQuery +`func (o *CampaignAllOfSearchCampaignInfo) UnsetQuery()` + +UnsetQuery ensures that no value is present for Query, not even an explicit nil +### GetIdentityIds + +`func (o *CampaignAllOfSearchCampaignInfo) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *CampaignAllOfSearchCampaignInfo) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *CampaignAllOfSearchCampaignInfo) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + +### SetIdentityIdsNil + +`func (o *CampaignAllOfSearchCampaignInfo) SetIdentityIdsNil(b bool)` + + SetIdentityIdsNil sets the value for IdentityIds to be an explicit nil + +### UnsetIdentityIds +`func (o *CampaignAllOfSearchCampaignInfo) UnsetIdentityIds()` + +UnsetIdentityIds ensures that no value is present for IdentityIds, not even an explicit nil +### GetAccessConstraints + +`func (o *CampaignAllOfSearchCampaignInfo) GetAccessConstraints() []AccessConstraint` + +GetAccessConstraints returns the AccessConstraints field if non-nil, zero value otherwise. + +### GetAccessConstraintsOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetAccessConstraintsOk() (*[]AccessConstraint, bool)` + +GetAccessConstraintsOk returns a tuple with the AccessConstraints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessConstraints + +`func (o *CampaignAllOfSearchCampaignInfo) SetAccessConstraints(v []AccessConstraint)` + +SetAccessConstraints sets AccessConstraints field to given value. + +### HasAccessConstraints + +`func (o *CampaignAllOfSearchCampaignInfo) HasAccessConstraints() bool` + +HasAccessConstraints returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfSearchCampaignInfoReviewer.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfSearchCampaignInfoReviewer.md new file mode 100644 index 000000000..112005d4a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfSearchCampaignInfoReviewer.md @@ -0,0 +1,126 @@ +--- +id: v2024-campaign-all-of-search-campaign-info-reviewer +title: CampaignAllOfSearchCampaignInfoReviewer +pagination_label: CampaignAllOfSearchCampaignInfoReviewer +sidebar_label: CampaignAllOfSearchCampaignInfoReviewer +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfSearchCampaignInfoReviewer', 'V2024CampaignAllOfSearchCampaignInfoReviewer'] +slug: /tools/sdk/go/v2024/models/campaign-all-of-search-campaign-info-reviewer +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfoReviewer', 'V2024CampaignAllOfSearchCampaignInfoReviewer'] +--- + +# CampaignAllOfSearchCampaignInfoReviewer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The reviewer's DTO type. | [optional] +**Id** | Pointer to **string** | The reviewer's ID. | [optional] +**Name** | Pointer to **NullableString** | The reviewer's name. | [optional] + +## Methods + +### NewCampaignAllOfSearchCampaignInfoReviewer + +`func NewCampaignAllOfSearchCampaignInfoReviewer() *CampaignAllOfSearchCampaignInfoReviewer` + +NewCampaignAllOfSearchCampaignInfoReviewer instantiates a new CampaignAllOfSearchCampaignInfoReviewer 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 + +### NewCampaignAllOfSearchCampaignInfoReviewerWithDefaults + +`func NewCampaignAllOfSearchCampaignInfoReviewerWithDefaults() *CampaignAllOfSearchCampaignInfoReviewer` + +NewCampaignAllOfSearchCampaignInfoReviewerWithDefaults instantiates a new CampaignAllOfSearchCampaignInfoReviewer 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 + +### GetType + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *CampaignAllOfSearchCampaignInfoReviewer) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfSourceOwnerCampaignInfo.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfSourceOwnerCampaignInfo.md new file mode 100644 index 000000000..76f299ed3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfSourceOwnerCampaignInfo.md @@ -0,0 +1,64 @@ +--- +id: v2024-campaign-all-of-source-owner-campaign-info +title: CampaignAllOfSourceOwnerCampaignInfo +pagination_label: CampaignAllOfSourceOwnerCampaignInfo +sidebar_label: CampaignAllOfSourceOwnerCampaignInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfSourceOwnerCampaignInfo', 'V2024CampaignAllOfSourceOwnerCampaignInfo'] +slug: /tools/sdk/go/v2024/models/campaign-all-of-source-owner-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSourceOwnerCampaignInfo', 'V2024CampaignAllOfSourceOwnerCampaignInfo'] +--- + +# CampaignAllOfSourceOwnerCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceIds** | Pointer to **[]string** | The list of sources to be included in the campaign. | [optional] + +## Methods + +### NewCampaignAllOfSourceOwnerCampaignInfo + +`func NewCampaignAllOfSourceOwnerCampaignInfo() *CampaignAllOfSourceOwnerCampaignInfo` + +NewCampaignAllOfSourceOwnerCampaignInfo instantiates a new CampaignAllOfSourceOwnerCampaignInfo 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 + +### NewCampaignAllOfSourceOwnerCampaignInfoWithDefaults + +`func NewCampaignAllOfSourceOwnerCampaignInfoWithDefaults() *CampaignAllOfSourceOwnerCampaignInfo` + +NewCampaignAllOfSourceOwnerCampaignInfoWithDefaults instantiates a new CampaignAllOfSourceOwnerCampaignInfo 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 + +### GetSourceIds + +`func (o *CampaignAllOfSourceOwnerCampaignInfo) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *CampaignAllOfSourceOwnerCampaignInfo) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *CampaignAllOfSourceOwnerCampaignInfo) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *CampaignAllOfSourceOwnerCampaignInfo) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfSourcesWithOrphanEntitlements.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfSourcesWithOrphanEntitlements.md new file mode 100644 index 000000000..d0af75d11 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignAllOfSourcesWithOrphanEntitlements.md @@ -0,0 +1,116 @@ +--- +id: v2024-campaign-all-of-sources-with-orphan-entitlements +title: CampaignAllOfSourcesWithOrphanEntitlements +pagination_label: CampaignAllOfSourcesWithOrphanEntitlements +sidebar_label: CampaignAllOfSourcesWithOrphanEntitlements +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfSourcesWithOrphanEntitlements', 'V2024CampaignAllOfSourcesWithOrphanEntitlements'] +slug: /tools/sdk/go/v2024/models/campaign-all-of-sources-with-orphan-entitlements +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSourcesWithOrphanEntitlements', 'V2024CampaignAllOfSourcesWithOrphanEntitlements'] +--- + +# CampaignAllOfSourcesWithOrphanEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the source | [optional] +**Type** | Pointer to **string** | Type | [optional] +**Name** | Pointer to **string** | Name of the source | [optional] + +## Methods + +### NewCampaignAllOfSourcesWithOrphanEntitlements + +`func NewCampaignAllOfSourcesWithOrphanEntitlements() *CampaignAllOfSourcesWithOrphanEntitlements` + +NewCampaignAllOfSourcesWithOrphanEntitlements instantiates a new CampaignAllOfSourcesWithOrphanEntitlements 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 + +### NewCampaignAllOfSourcesWithOrphanEntitlementsWithDefaults + +`func NewCampaignAllOfSourcesWithOrphanEntitlementsWithDefaults() *CampaignAllOfSourcesWithOrphanEntitlements` + +NewCampaignAllOfSourcesWithOrphanEntitlementsWithDefaults instantiates a new CampaignAllOfSourcesWithOrphanEntitlements 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 + +### GetId + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignCompleteOptions.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignCompleteOptions.md new file mode 100644 index 000000000..241e098ab --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignCompleteOptions.md @@ -0,0 +1,64 @@ +--- +id: v2024-campaign-complete-options +title: CampaignCompleteOptions +pagination_label: CampaignCompleteOptions +sidebar_label: CampaignCompleteOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignCompleteOptions', 'V2024CampaignCompleteOptions'] +slug: /tools/sdk/go/v2024/models/campaign-complete-options +tags: ['SDK', 'Software Development Kit', 'CampaignCompleteOptions', 'V2024CampaignCompleteOptions'] +--- + +# CampaignCompleteOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AutoCompleteAction** | Pointer to **string** | Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. | [optional] [default to "APPROVE"] + +## Methods + +### NewCampaignCompleteOptions + +`func NewCampaignCompleteOptions() *CampaignCompleteOptions` + +NewCampaignCompleteOptions instantiates a new CampaignCompleteOptions 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 + +### NewCampaignCompleteOptionsWithDefaults + +`func NewCampaignCompleteOptionsWithDefaults() *CampaignCompleteOptions` + +NewCampaignCompleteOptionsWithDefaults instantiates a new CampaignCompleteOptions 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 + +### GetAutoCompleteAction + +`func (o *CampaignCompleteOptions) GetAutoCompleteAction() string` + +GetAutoCompleteAction returns the AutoCompleteAction field if non-nil, zero value otherwise. + +### GetAutoCompleteActionOk + +`func (o *CampaignCompleteOptions) GetAutoCompleteActionOk() (*string, bool)` + +GetAutoCompleteActionOk returns a tuple with the AutoCompleteAction field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoCompleteAction + +`func (o *CampaignCompleteOptions) SetAutoCompleteAction(v string)` + +SetAutoCompleteAction sets AutoCompleteAction field to given value. + +### HasAutoCompleteAction + +`func (o *CampaignCompleteOptions) HasAutoCompleteAction() bool` + +HasAutoCompleteAction returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignEnded.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignEnded.md new file mode 100644 index 000000000..1e7b29bbb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignEnded.md @@ -0,0 +1,59 @@ +--- +id: v2024-campaign-ended +title: CampaignEnded +pagination_label: CampaignEnded +sidebar_label: CampaignEnded +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignEnded', 'V2024CampaignEnded'] +slug: /tools/sdk/go/v2024/models/campaign-ended +tags: ['SDK', 'Software Development Kit', 'CampaignEnded', 'V2024CampaignEnded'] +--- + +# CampaignEnded + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | [**CampaignEndedCampaign**](campaign-ended-campaign) | | + +## Methods + +### NewCampaignEnded + +`func NewCampaignEnded(campaign CampaignEndedCampaign, ) *CampaignEnded` + +NewCampaignEnded instantiates a new CampaignEnded 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 + +### NewCampaignEndedWithDefaults + +`func NewCampaignEndedWithDefaults() *CampaignEnded` + +NewCampaignEndedWithDefaults instantiates a new CampaignEnded 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 + +### GetCampaign + +`func (o *CampaignEnded) GetCampaign() CampaignEndedCampaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignEnded) GetCampaignOk() (*CampaignEndedCampaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *CampaignEnded) SetCampaign(v CampaignEndedCampaign)` + +SetCampaign sets Campaign field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignEndedCampaign.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignEndedCampaign.md new file mode 100644 index 000000000..5e54b1945 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignEndedCampaign.md @@ -0,0 +1,242 @@ +--- +id: v2024-campaign-ended-campaign +title: CampaignEndedCampaign +pagination_label: CampaignEndedCampaign +sidebar_label: CampaignEndedCampaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignEndedCampaign', 'V2024CampaignEndedCampaign'] +slug: /tools/sdk/go/v2024/models/campaign-ended-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignEndedCampaign', 'V2024CampaignEndedCampaign'] +--- + +# CampaignEndedCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique ID for the campaign. | +**Name** | **string** | The human friendly name of the campaign. | +**Description** | **string** | Extended description of the campaign. | +**Created** | **SailPointTime** | The date and time the campaign was created. | +**Modified** | Pointer to **NullableTime** | The date and time the campaign was last modified. | [optional] +**Deadline** | **SailPointTime** | The date and time the campaign is due. | +**Type** | **map[string]interface{}** | The type of campaign. | +**CampaignOwner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | +**Status** | **map[string]interface{}** | The current status of the campaign. | + +## Methods + +### NewCampaignEndedCampaign + +`func NewCampaignEndedCampaign(id string, name string, description string, created SailPointTime, deadline SailPointTime, type_ map[string]interface{}, campaignOwner CampaignActivatedCampaignCampaignOwner, status map[string]interface{}, ) *CampaignEndedCampaign` + +NewCampaignEndedCampaign instantiates a new CampaignEndedCampaign 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 + +### NewCampaignEndedCampaignWithDefaults + +`func NewCampaignEndedCampaignWithDefaults() *CampaignEndedCampaign` + +NewCampaignEndedCampaignWithDefaults instantiates a new CampaignEndedCampaign 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 + +### GetId + +`func (o *CampaignEndedCampaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignEndedCampaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignEndedCampaign) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignEndedCampaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignEndedCampaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignEndedCampaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CampaignEndedCampaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignEndedCampaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignEndedCampaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetCreated + +`func (o *CampaignEndedCampaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignEndedCampaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CampaignEndedCampaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CampaignEndedCampaign) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CampaignEndedCampaign) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CampaignEndedCampaign) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CampaignEndedCampaign) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CampaignEndedCampaign) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CampaignEndedCampaign) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDeadline + +`func (o *CampaignEndedCampaign) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *CampaignEndedCampaign) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *CampaignEndedCampaign) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + + +### GetType + +`func (o *CampaignEndedCampaign) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignEndedCampaign) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignEndedCampaign) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetCampaignOwner + +`func (o *CampaignEndedCampaign) GetCampaignOwner() CampaignActivatedCampaignCampaignOwner` + +GetCampaignOwner returns the CampaignOwner field if non-nil, zero value otherwise. + +### GetCampaignOwnerOk + +`func (o *CampaignEndedCampaign) GetCampaignOwnerOk() (*CampaignActivatedCampaignCampaignOwner, bool)` + +GetCampaignOwnerOk returns a tuple with the CampaignOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignOwner + +`func (o *CampaignEndedCampaign) SetCampaignOwner(v CampaignActivatedCampaignCampaignOwner)` + +SetCampaignOwner sets CampaignOwner field to given value. + + +### GetStatus + +`func (o *CampaignEndedCampaign) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CampaignEndedCampaign) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CampaignEndedCampaign) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignFilterDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignFilterDetails.md new file mode 100644 index 000000000..7e96a9e3b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignFilterDetails.md @@ -0,0 +1,205 @@ +--- +id: v2024-campaign-filter-details +title: CampaignFilterDetails +pagination_label: CampaignFilterDetails +sidebar_label: CampaignFilterDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignFilterDetails', 'V2024CampaignFilterDetails'] +slug: /tools/sdk/go/v2024/models/campaign-filter-details +tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetails', 'V2024CampaignFilterDetails'] +--- + +# CampaignFilterDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the campaign filter | +**Name** | **string** | Campaign filter name. | +**Description** | Pointer to **string** | Campaign filter description. | [optional] +**Owner** | **NullableString** | Owner of the filter. This field automatically populates at creation time with the current user. | +**Mode** | **string** | Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria. | +**CriteriaList** | Pointer to [**[]CampaignFilterDetailsCriteriaListInner**](campaign-filter-details-criteria-list-inner) | List of criteria. | [optional] +**IsSystemFilter** | **bool** | If true, the filter is created by the system. If false, the filter is created by a user. | [default to false] + +## Methods + +### NewCampaignFilterDetails + +`func NewCampaignFilterDetails(id string, name string, owner NullableString, mode string, isSystemFilter bool, ) *CampaignFilterDetails` + +NewCampaignFilterDetails instantiates a new CampaignFilterDetails 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 + +### NewCampaignFilterDetailsWithDefaults + +`func NewCampaignFilterDetailsWithDefaults() *CampaignFilterDetails` + +NewCampaignFilterDetailsWithDefaults instantiates a new CampaignFilterDetails 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 + +### GetId + +`func (o *CampaignFilterDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignFilterDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignFilterDetails) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignFilterDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignFilterDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignFilterDetails) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CampaignFilterDetails) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignFilterDetails) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignFilterDetails) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CampaignFilterDetails) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *CampaignFilterDetails) GetOwner() string` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CampaignFilterDetails) GetOwnerOk() (*string, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CampaignFilterDetails) SetOwner(v string)` + +SetOwner sets Owner field to given value. + + +### SetOwnerNil + +`func (o *CampaignFilterDetails) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *CampaignFilterDetails) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetMode + +`func (o *CampaignFilterDetails) GetMode() string` + +GetMode returns the Mode field if non-nil, zero value otherwise. + +### GetModeOk + +`func (o *CampaignFilterDetails) GetModeOk() (*string, bool)` + +GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMode + +`func (o *CampaignFilterDetails) SetMode(v string)` + +SetMode sets Mode field to given value. + + +### GetCriteriaList + +`func (o *CampaignFilterDetails) GetCriteriaList() []CampaignFilterDetailsCriteriaListInner` + +GetCriteriaList returns the CriteriaList field if non-nil, zero value otherwise. + +### GetCriteriaListOk + +`func (o *CampaignFilterDetails) GetCriteriaListOk() (*[]CampaignFilterDetailsCriteriaListInner, bool)` + +GetCriteriaListOk returns a tuple with the CriteriaList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteriaList + +`func (o *CampaignFilterDetails) SetCriteriaList(v []CampaignFilterDetailsCriteriaListInner)` + +SetCriteriaList sets CriteriaList field to given value. + +### HasCriteriaList + +`func (o *CampaignFilterDetails) HasCriteriaList() bool` + +HasCriteriaList returns a boolean if a field has been set. + +### GetIsSystemFilter + +`func (o *CampaignFilterDetails) GetIsSystemFilter() bool` + +GetIsSystemFilter returns the IsSystemFilter field if non-nil, zero value otherwise. + +### GetIsSystemFilterOk + +`func (o *CampaignFilterDetails) GetIsSystemFilterOk() (*bool, bool)` + +GetIsSystemFilterOk returns a tuple with the IsSystemFilter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSystemFilter + +`func (o *CampaignFilterDetails) SetIsSystemFilter(v bool)` + +SetIsSystemFilter sets IsSystemFilter field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignFilterDetailsCriteriaListInner.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignFilterDetailsCriteriaListInner.md new file mode 100644 index 000000000..ee9cfb3a6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignFilterDetailsCriteriaListInner.md @@ -0,0 +1,323 @@ +--- +id: v2024-campaign-filter-details-criteria-list-inner +title: CampaignFilterDetailsCriteriaListInner +pagination_label: CampaignFilterDetailsCriteriaListInner +sidebar_label: CampaignFilterDetailsCriteriaListInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignFilterDetailsCriteriaListInner', 'V2024CampaignFilterDetailsCriteriaListInner'] +slug: /tools/sdk/go/v2024/models/campaign-filter-details-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetailsCriteriaListInner', 'V2024CampaignFilterDetailsCriteriaListInner'] +--- + +# CampaignFilterDetailsCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**CriteriaType**](criteria-type) | | +**Operation** | Pointer to [**NullableOperation**](operation) | | [optional] +**Property** | **NullableString** | Specified key from the type of criteria. | +**Value** | **NullableString** | Value for the specified key from the type of criteria. | +**NegateResult** | Pointer to **bool** | If true, the filter will negate the result of the criteria. | [optional] [default to false] +**ShortCircuit** | Pointer to **bool** | If true, the filter will short circuit the evaluation of the criteria. | [optional] [default to false] +**RecordChildMatches** | Pointer to **bool** | If true, the filter will record child matches for the criteria. | [optional] [default to false] +**Id** | Pointer to **NullableString** | The unique ID of the criteria. | [optional] +**SuppressMatchedItems** | Pointer to **bool** | If this value is true, then matched items will not only be excluded from the campaign, they will also not have archived certification items created. Such items will not appear in the exclusion report. | [optional] [default to false] +**Children** | Pointer to **[]map[string]interface{}** | List of child criteria. | [optional] + +## Methods + +### NewCampaignFilterDetailsCriteriaListInner + +`func NewCampaignFilterDetailsCriteriaListInner(type_ CriteriaType, property NullableString, value NullableString, ) *CampaignFilterDetailsCriteriaListInner` + +NewCampaignFilterDetailsCriteriaListInner instantiates a new CampaignFilterDetailsCriteriaListInner 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 + +### NewCampaignFilterDetailsCriteriaListInnerWithDefaults + +`func NewCampaignFilterDetailsCriteriaListInnerWithDefaults() *CampaignFilterDetailsCriteriaListInner` + +NewCampaignFilterDetailsCriteriaListInnerWithDefaults instantiates a new CampaignFilterDetailsCriteriaListInner 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 + +### GetType + +`func (o *CampaignFilterDetailsCriteriaListInner) GetType() CriteriaType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetTypeOk() (*CriteriaType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignFilterDetailsCriteriaListInner) SetType(v CriteriaType)` + +SetType sets Type field to given value. + + +### GetOperation + +`func (o *CampaignFilterDetailsCriteriaListInner) GetOperation() Operation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetOperationOk() (*Operation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *CampaignFilterDetailsCriteriaListInner) SetOperation(v Operation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *CampaignFilterDetailsCriteriaListInner) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### SetOperationNil + +`func (o *CampaignFilterDetailsCriteriaListInner) SetOperationNil(b bool)` + + SetOperationNil sets the value for Operation to be an explicit nil + +### UnsetOperation +`func (o *CampaignFilterDetailsCriteriaListInner) UnsetOperation()` + +UnsetOperation ensures that no value is present for Operation, not even an explicit nil +### GetProperty + +`func (o *CampaignFilterDetailsCriteriaListInner) GetProperty() string` + +GetProperty returns the Property field if non-nil, zero value otherwise. + +### GetPropertyOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetPropertyOk() (*string, bool)` + +GetPropertyOk returns a tuple with the Property field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperty + +`func (o *CampaignFilterDetailsCriteriaListInner) SetProperty(v string)` + +SetProperty sets Property field to given value. + + +### SetPropertyNil + +`func (o *CampaignFilterDetailsCriteriaListInner) SetPropertyNil(b bool)` + + SetPropertyNil sets the value for Property to be an explicit nil + +### UnsetProperty +`func (o *CampaignFilterDetailsCriteriaListInner) UnsetProperty()` + +UnsetProperty ensures that no value is present for Property, not even an explicit nil +### GetValue + +`func (o *CampaignFilterDetailsCriteriaListInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *CampaignFilterDetailsCriteriaListInner) SetValue(v string)` + +SetValue sets Value field to given value. + + +### SetValueNil + +`func (o *CampaignFilterDetailsCriteriaListInner) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *CampaignFilterDetailsCriteriaListInner) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetNegateResult + +`func (o *CampaignFilterDetailsCriteriaListInner) GetNegateResult() bool` + +GetNegateResult returns the NegateResult field if non-nil, zero value otherwise. + +### GetNegateResultOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetNegateResultOk() (*bool, bool)` + +GetNegateResultOk returns a tuple with the NegateResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNegateResult + +`func (o *CampaignFilterDetailsCriteriaListInner) SetNegateResult(v bool)` + +SetNegateResult sets NegateResult field to given value. + +### HasNegateResult + +`func (o *CampaignFilterDetailsCriteriaListInner) HasNegateResult() bool` + +HasNegateResult returns a boolean if a field has been set. + +### GetShortCircuit + +`func (o *CampaignFilterDetailsCriteriaListInner) GetShortCircuit() bool` + +GetShortCircuit returns the ShortCircuit field if non-nil, zero value otherwise. + +### GetShortCircuitOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetShortCircuitOk() (*bool, bool)` + +GetShortCircuitOk returns a tuple with the ShortCircuit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShortCircuit + +`func (o *CampaignFilterDetailsCriteriaListInner) SetShortCircuit(v bool)` + +SetShortCircuit sets ShortCircuit field to given value. + +### HasShortCircuit + +`func (o *CampaignFilterDetailsCriteriaListInner) HasShortCircuit() bool` + +HasShortCircuit returns a boolean if a field has been set. + +### GetRecordChildMatches + +`func (o *CampaignFilterDetailsCriteriaListInner) GetRecordChildMatches() bool` + +GetRecordChildMatches returns the RecordChildMatches field if non-nil, zero value otherwise. + +### GetRecordChildMatchesOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetRecordChildMatchesOk() (*bool, bool)` + +GetRecordChildMatchesOk returns a tuple with the RecordChildMatches field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecordChildMatches + +`func (o *CampaignFilterDetailsCriteriaListInner) SetRecordChildMatches(v bool)` + +SetRecordChildMatches sets RecordChildMatches field to given value. + +### HasRecordChildMatches + +`func (o *CampaignFilterDetailsCriteriaListInner) HasRecordChildMatches() bool` + +HasRecordChildMatches returns a boolean if a field has been set. + +### GetId + +`func (o *CampaignFilterDetailsCriteriaListInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignFilterDetailsCriteriaListInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignFilterDetailsCriteriaListInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *CampaignFilterDetailsCriteriaListInner) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *CampaignFilterDetailsCriteriaListInner) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetSuppressMatchedItems + +`func (o *CampaignFilterDetailsCriteriaListInner) GetSuppressMatchedItems() bool` + +GetSuppressMatchedItems returns the SuppressMatchedItems field if non-nil, zero value otherwise. + +### GetSuppressMatchedItemsOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetSuppressMatchedItemsOk() (*bool, bool)` + +GetSuppressMatchedItemsOk returns a tuple with the SuppressMatchedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSuppressMatchedItems + +`func (o *CampaignFilterDetailsCriteriaListInner) SetSuppressMatchedItems(v bool)` + +SetSuppressMatchedItems sets SuppressMatchedItems field to given value. + +### HasSuppressMatchedItems + +`func (o *CampaignFilterDetailsCriteriaListInner) HasSuppressMatchedItems() bool` + +HasSuppressMatchedItems returns a boolean if a field has been set. + +### GetChildren + +`func (o *CampaignFilterDetailsCriteriaListInner) GetChildren() []map[string]interface{}` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetChildrenOk() (*[]map[string]interface{}, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *CampaignFilterDetailsCriteriaListInner) SetChildren(v []map[string]interface{})` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *CampaignFilterDetailsCriteriaListInner) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignGenerated.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignGenerated.md new file mode 100644 index 000000000..3f8e8ec9c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignGenerated.md @@ -0,0 +1,59 @@ +--- +id: v2024-campaign-generated +title: CampaignGenerated +pagination_label: CampaignGenerated +sidebar_label: CampaignGenerated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignGenerated', 'V2024CampaignGenerated'] +slug: /tools/sdk/go/v2024/models/campaign-generated +tags: ['SDK', 'Software Development Kit', 'CampaignGenerated', 'V2024CampaignGenerated'] +--- + +# CampaignGenerated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | + +## Methods + +### NewCampaignGenerated + +`func NewCampaignGenerated(campaign CampaignGeneratedCampaign, ) *CampaignGenerated` + +NewCampaignGenerated instantiates a new CampaignGenerated 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 + +### NewCampaignGeneratedWithDefaults + +`func NewCampaignGeneratedWithDefaults() *CampaignGenerated` + +NewCampaignGeneratedWithDefaults instantiates a new CampaignGenerated 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 + +### GetCampaign + +`func (o *CampaignGenerated) GetCampaign() CampaignGeneratedCampaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignGenerated) GetCampaignOk() (*CampaignGeneratedCampaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *CampaignGenerated) SetCampaign(v CampaignGeneratedCampaign)` + +SetCampaign sets Campaign field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignGeneratedCampaign.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignGeneratedCampaign.md new file mode 100644 index 000000000..3364c5efd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignGeneratedCampaign.md @@ -0,0 +1,257 @@ +--- +id: v2024-campaign-generated-campaign +title: CampaignGeneratedCampaign +pagination_label: CampaignGeneratedCampaign +sidebar_label: CampaignGeneratedCampaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignGeneratedCampaign', 'V2024CampaignGeneratedCampaign'] +slug: /tools/sdk/go/v2024/models/campaign-generated-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaign', 'V2024CampaignGeneratedCampaign'] +--- + +# CampaignGeneratedCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the campaign. | +**Name** | **string** | Human friendly name of the campaign. | +**Description** | **string** | Extended description of the campaign. | +**Created** | **SailPointTime** | The date and time the campaign was created. | +**Modified** | Pointer to **NullableString** | The date and time the campaign was last modified. | [optional] +**Deadline** | Pointer to **NullableString** | The date and time when the campaign must be finished by. | [optional] +**Type** | **map[string]interface{}** | The type of campaign that was generated. | +**CampaignOwner** | [**CampaignGeneratedCampaignCampaignOwner**](campaign-generated-campaign-campaign-owner) | | +**Status** | **map[string]interface{}** | The current status of the campaign. | + +## Methods + +### NewCampaignGeneratedCampaign + +`func NewCampaignGeneratedCampaign(id string, name string, description string, created SailPointTime, type_ map[string]interface{}, campaignOwner CampaignGeneratedCampaignCampaignOwner, status map[string]interface{}, ) *CampaignGeneratedCampaign` + +NewCampaignGeneratedCampaign instantiates a new CampaignGeneratedCampaign 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 + +### NewCampaignGeneratedCampaignWithDefaults + +`func NewCampaignGeneratedCampaignWithDefaults() *CampaignGeneratedCampaign` + +NewCampaignGeneratedCampaignWithDefaults instantiates a new CampaignGeneratedCampaign 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 + +### GetId + +`func (o *CampaignGeneratedCampaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignGeneratedCampaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignGeneratedCampaign) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignGeneratedCampaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignGeneratedCampaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignGeneratedCampaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CampaignGeneratedCampaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignGeneratedCampaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignGeneratedCampaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetCreated + +`func (o *CampaignGeneratedCampaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignGeneratedCampaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CampaignGeneratedCampaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CampaignGeneratedCampaign) GetModified() string` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CampaignGeneratedCampaign) GetModifiedOk() (*string, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CampaignGeneratedCampaign) SetModified(v string)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CampaignGeneratedCampaign) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CampaignGeneratedCampaign) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CampaignGeneratedCampaign) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDeadline + +`func (o *CampaignGeneratedCampaign) GetDeadline() string` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *CampaignGeneratedCampaign) GetDeadlineOk() (*string, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *CampaignGeneratedCampaign) SetDeadline(v string)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *CampaignGeneratedCampaign) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### SetDeadlineNil + +`func (o *CampaignGeneratedCampaign) SetDeadlineNil(b bool)` + + SetDeadlineNil sets the value for Deadline to be an explicit nil + +### UnsetDeadline +`func (o *CampaignGeneratedCampaign) UnsetDeadline()` + +UnsetDeadline ensures that no value is present for Deadline, not even an explicit nil +### GetType + +`func (o *CampaignGeneratedCampaign) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignGeneratedCampaign) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignGeneratedCampaign) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetCampaignOwner + +`func (o *CampaignGeneratedCampaign) GetCampaignOwner() CampaignGeneratedCampaignCampaignOwner` + +GetCampaignOwner returns the CampaignOwner field if non-nil, zero value otherwise. + +### GetCampaignOwnerOk + +`func (o *CampaignGeneratedCampaign) GetCampaignOwnerOk() (*CampaignGeneratedCampaignCampaignOwner, bool)` + +GetCampaignOwnerOk returns a tuple with the CampaignOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignOwner + +`func (o *CampaignGeneratedCampaign) SetCampaignOwner(v CampaignGeneratedCampaignCampaignOwner)` + +SetCampaignOwner sets CampaignOwner field to given value. + + +### GetStatus + +`func (o *CampaignGeneratedCampaign) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CampaignGeneratedCampaign) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CampaignGeneratedCampaign) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignGeneratedCampaignCampaignOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignGeneratedCampaignCampaignOwner.md new file mode 100644 index 000000000..05ef2ec4f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignGeneratedCampaignCampaignOwner.md @@ -0,0 +1,101 @@ +--- +id: v2024-campaign-generated-campaign-campaign-owner +title: CampaignGeneratedCampaignCampaignOwner +pagination_label: CampaignGeneratedCampaignCampaignOwner +sidebar_label: CampaignGeneratedCampaignCampaignOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignGeneratedCampaignCampaignOwner', 'V2024CampaignGeneratedCampaignCampaignOwner'] +slug: /tools/sdk/go/v2024/models/campaign-generated-campaign-campaign-owner +tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaignCampaignOwner', 'V2024CampaignGeneratedCampaignCampaignOwner'] +--- + +# CampaignGeneratedCampaignCampaignOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the identity. | +**DisplayName** | **string** | The display name of the identity. | +**Email** | **string** | The primary email address of the identity. | + +## Methods + +### NewCampaignGeneratedCampaignCampaignOwner + +`func NewCampaignGeneratedCampaignCampaignOwner(id string, displayName string, email string, ) *CampaignGeneratedCampaignCampaignOwner` + +NewCampaignGeneratedCampaignCampaignOwner instantiates a new CampaignGeneratedCampaignCampaignOwner 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 + +### NewCampaignGeneratedCampaignCampaignOwnerWithDefaults + +`func NewCampaignGeneratedCampaignCampaignOwnerWithDefaults() *CampaignGeneratedCampaignCampaignOwner` + +NewCampaignGeneratedCampaignCampaignOwnerWithDefaults instantiates a new CampaignGeneratedCampaignCampaignOwner 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 + +### GetId + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignGeneratedCampaignCampaignOwner) SetId(v string)` + +SetId sets Id field to given value. + + +### GetDisplayName + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *CampaignGeneratedCampaignCampaignOwner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + + +### GetEmail + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *CampaignGeneratedCampaignCampaignOwner) SetEmail(v string)` + +SetEmail sets Email field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignReference.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignReference.md new file mode 100644 index 000000000..e169fdfad --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignReference.md @@ -0,0 +1,195 @@ +--- +id: v2024-campaign-reference +title: CampaignReference +pagination_label: CampaignReference +sidebar_label: CampaignReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignReference', 'V2024CampaignReference'] +slug: /tools/sdk/go/v2024/models/campaign-reference +tags: ['SDK', 'Software Development Kit', 'CampaignReference', 'V2024CampaignReference'] +--- + +# CampaignReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the campaign. | +**Name** | **string** | The name of the campaign. | +**Type** | **string** | The type of object that is being referenced. | +**CampaignType** | **string** | The type of the campaign. | +**Description** | **NullableString** | The description of the campaign set by the admin who created it. | +**CorrelatedStatus** | **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | +**MandatoryCommentRequirement** | **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | + +## Methods + +### NewCampaignReference + +`func NewCampaignReference(id string, name string, type_ string, campaignType string, description NullableString, correlatedStatus string, mandatoryCommentRequirement string, ) *CampaignReference` + +NewCampaignReference instantiates a new CampaignReference 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 + +### NewCampaignReferenceWithDefaults + +`func NewCampaignReferenceWithDefaults() *CampaignReference` + +NewCampaignReferenceWithDefaults instantiates a new CampaignReference 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 + +### GetId + +`func (o *CampaignReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignReference) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignReference) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *CampaignReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignReference) SetType(v string)` + +SetType sets Type field to given value. + + +### GetCampaignType + +`func (o *CampaignReference) GetCampaignType() string` + +GetCampaignType returns the CampaignType field if non-nil, zero value otherwise. + +### GetCampaignTypeOk + +`func (o *CampaignReference) GetCampaignTypeOk() (*string, bool)` + +GetCampaignTypeOk returns a tuple with the CampaignType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignType + +`func (o *CampaignReference) SetCampaignType(v string)` + +SetCampaignType sets CampaignType field to given value. + + +### GetDescription + +`func (o *CampaignReference) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignReference) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignReference) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *CampaignReference) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CampaignReference) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCorrelatedStatus + +`func (o *CampaignReference) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *CampaignReference) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *CampaignReference) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + + +### GetMandatoryCommentRequirement + +`func (o *CampaignReference) GetMandatoryCommentRequirement() string` + +GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise. + +### GetMandatoryCommentRequirementOk + +`func (o *CampaignReference) GetMandatoryCommentRequirementOk() (*string, bool)` + +GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMandatoryCommentRequirement + +`func (o *CampaignReference) SetMandatoryCommentRequirement(v string)` + +SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignReport.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignReport.md new file mode 100644 index 000000000..bcd3d7e5c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignReport.md @@ -0,0 +1,189 @@ +--- +id: v2024-campaign-report +title: CampaignReport +pagination_label: CampaignReport +sidebar_label: CampaignReport +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignReport', 'V2024CampaignReport'] +slug: /tools/sdk/go/v2024/models/campaign-report +tags: ['SDK', 'Software Development Kit', 'CampaignReport', 'V2024CampaignReport'] +--- + +# CampaignReport + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **string** | Human-readable name of the SOD policy violation report result. | [optional] +**Status** | Pointer to **string** | Status of a SOD policy violation report. | [optional] +**ReportType** | [**ReportType**](report-type) | | +**LastRunAt** | Pointer to **SailPointTime** | The most recent date and time this report was run | [optional] [readonly] + +## Methods + +### NewCampaignReport + +`func NewCampaignReport(reportType ReportType, ) *CampaignReport` + +NewCampaignReport instantiates a new CampaignReport 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 + +### NewCampaignReportWithDefaults + +`func NewCampaignReportWithDefaults() *CampaignReport` + +NewCampaignReportWithDefaults instantiates a new CampaignReport 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 + +### GetType + +`func (o *CampaignReport) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignReport) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignReport) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignReport) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CampaignReport) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignReport) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignReport) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignReport) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignReport) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignReport) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignReport) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignReport) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *CampaignReport) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CampaignReport) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CampaignReport) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CampaignReport) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetReportType + +`func (o *CampaignReport) GetReportType() ReportType` + +GetReportType returns the ReportType field if non-nil, zero value otherwise. + +### GetReportTypeOk + +`func (o *CampaignReport) GetReportTypeOk() (*ReportType, bool)` + +GetReportTypeOk returns a tuple with the ReportType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportType + +`func (o *CampaignReport) SetReportType(v ReportType)` + +SetReportType sets ReportType field to given value. + + +### GetLastRunAt + +`func (o *CampaignReport) GetLastRunAt() SailPointTime` + +GetLastRunAt returns the LastRunAt field if non-nil, zero value otherwise. + +### GetLastRunAtOk + +`func (o *CampaignReport) GetLastRunAtOk() (*SailPointTime, bool)` + +GetLastRunAtOk returns a tuple with the LastRunAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastRunAt + +`func (o *CampaignReport) SetLastRunAt(v SailPointTime)` + +SetLastRunAt sets LastRunAt field to given value. + +### HasLastRunAt + +`func (o *CampaignReport) HasLastRunAt() bool` + +HasLastRunAt returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignReportsConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignReportsConfig.md new file mode 100644 index 000000000..f1fed019b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignReportsConfig.md @@ -0,0 +1,74 @@ +--- +id: v2024-campaign-reports-config +title: CampaignReportsConfig +pagination_label: CampaignReportsConfig +sidebar_label: CampaignReportsConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignReportsConfig', 'V2024CampaignReportsConfig'] +slug: /tools/sdk/go/v2024/models/campaign-reports-config +tags: ['SDK', 'Software Development Kit', 'CampaignReportsConfig', 'V2024CampaignReportsConfig'] +--- + +# CampaignReportsConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttributeColumns** | Pointer to **[]string** | list of identity attribute columns | [optional] + +## Methods + +### NewCampaignReportsConfig + +`func NewCampaignReportsConfig() *CampaignReportsConfig` + +NewCampaignReportsConfig instantiates a new CampaignReportsConfig 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 + +### NewCampaignReportsConfigWithDefaults + +`func NewCampaignReportsConfigWithDefaults() *CampaignReportsConfig` + +NewCampaignReportsConfigWithDefaults instantiates a new CampaignReportsConfig 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 + +### GetIdentityAttributeColumns + +`func (o *CampaignReportsConfig) GetIdentityAttributeColumns() []string` + +GetIdentityAttributeColumns returns the IdentityAttributeColumns field if non-nil, zero value otherwise. + +### GetIdentityAttributeColumnsOk + +`func (o *CampaignReportsConfig) GetIdentityAttributeColumnsOk() (*[]string, bool)` + +GetIdentityAttributeColumnsOk returns a tuple with the IdentityAttributeColumns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeColumns + +`func (o *CampaignReportsConfig) SetIdentityAttributeColumns(v []string)` + +SetIdentityAttributeColumns sets IdentityAttributeColumns field to given value. + +### HasIdentityAttributeColumns + +`func (o *CampaignReportsConfig) HasIdentityAttributeColumns() bool` + +HasIdentityAttributeColumns returns a boolean if a field has been set. + +### SetIdentityAttributeColumnsNil + +`func (o *CampaignReportsConfig) SetIdentityAttributeColumnsNil(b bool)` + + SetIdentityAttributeColumnsNil sets the value for IdentityAttributeColumns to be an explicit nil + +### UnsetIdentityAttributeColumns +`func (o *CampaignReportsConfig) UnsetIdentityAttributeColumns()` + +UnsetIdentityAttributeColumns ensures that no value is present for IdentityAttributeColumns, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignTemplate.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignTemplate.md new file mode 100644 index 000000000..27b3d310e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignTemplate.md @@ -0,0 +1,267 @@ +--- +id: v2024-campaign-template +title: CampaignTemplate +pagination_label: CampaignTemplate +sidebar_label: CampaignTemplate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignTemplate', 'V2024CampaignTemplate'] +slug: /tools/sdk/go/v2024/models/campaign-template +tags: ['SDK', 'Software Development Kit', 'CampaignTemplate', 'V2024CampaignTemplate'] +--- + +# CampaignTemplate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the campaign template | [optional] +**Name** | **string** | This template's name. Has no bearing on generated campaigns' names. | +**Description** | **string** | This template's description. Has no bearing on generated campaigns' descriptions. | +**Created** | **SailPointTime** | Creation date of Campaign Template | [readonly] +**Modified** | **NullableTime** | Modification date of Campaign Template | [readonly] +**Scheduled** | Pointer to **bool** | Indicates if this campaign template has been scheduled. | [optional] [readonly] [default to false] +**OwnerRef** | Pointer to [**CampaignTemplateOwnerRef**](campaign-template-owner-ref) | | [optional] +**DeadlineDuration** | Pointer to **NullableString** | The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days). | [optional] +**Campaign** | [**Campaign**](campaign) | | + +## Methods + +### NewCampaignTemplate + +`func NewCampaignTemplate(name string, description string, created SailPointTime, modified NullableTime, campaign Campaign, ) *CampaignTemplate` + +NewCampaignTemplate instantiates a new CampaignTemplate 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 + +### NewCampaignTemplateWithDefaults + +`func NewCampaignTemplateWithDefaults() *CampaignTemplate` + +NewCampaignTemplateWithDefaults instantiates a new CampaignTemplate 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 + +### GetId + +`func (o *CampaignTemplate) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignTemplate) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignTemplate) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignTemplate) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignTemplate) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignTemplate) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignTemplate) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CampaignTemplate) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignTemplate) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignTemplate) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetCreated + +`func (o *CampaignTemplate) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignTemplate) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CampaignTemplate) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CampaignTemplate) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CampaignTemplate) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CampaignTemplate) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### SetModifiedNil + +`func (o *CampaignTemplate) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CampaignTemplate) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetScheduled + +`func (o *CampaignTemplate) GetScheduled() bool` + +GetScheduled returns the Scheduled field if non-nil, zero value otherwise. + +### GetScheduledOk + +`func (o *CampaignTemplate) GetScheduledOk() (*bool, bool)` + +GetScheduledOk returns a tuple with the Scheduled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheduled + +`func (o *CampaignTemplate) SetScheduled(v bool)` + +SetScheduled sets Scheduled field to given value. + +### HasScheduled + +`func (o *CampaignTemplate) HasScheduled() bool` + +HasScheduled returns a boolean if a field has been set. + +### GetOwnerRef + +`func (o *CampaignTemplate) GetOwnerRef() CampaignTemplateOwnerRef` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *CampaignTemplate) GetOwnerRefOk() (*CampaignTemplateOwnerRef, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *CampaignTemplate) SetOwnerRef(v CampaignTemplateOwnerRef)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *CampaignTemplate) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### GetDeadlineDuration + +`func (o *CampaignTemplate) GetDeadlineDuration() string` + +GetDeadlineDuration returns the DeadlineDuration field if non-nil, zero value otherwise. + +### GetDeadlineDurationOk + +`func (o *CampaignTemplate) GetDeadlineDurationOk() (*string, bool)` + +GetDeadlineDurationOk returns a tuple with the DeadlineDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadlineDuration + +`func (o *CampaignTemplate) SetDeadlineDuration(v string)` + +SetDeadlineDuration sets DeadlineDuration field to given value. + +### HasDeadlineDuration + +`func (o *CampaignTemplate) HasDeadlineDuration() bool` + +HasDeadlineDuration returns a boolean if a field has been set. + +### SetDeadlineDurationNil + +`func (o *CampaignTemplate) SetDeadlineDurationNil(b bool)` + + SetDeadlineDurationNil sets the value for DeadlineDuration to be an explicit nil + +### UnsetDeadlineDuration +`func (o *CampaignTemplate) UnsetDeadlineDuration()` + +UnsetDeadlineDuration ensures that no value is present for DeadlineDuration, not even an explicit nil +### GetCampaign + +`func (o *CampaignTemplate) GetCampaign() Campaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignTemplate) GetCampaignOk() (*Campaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *CampaignTemplate) SetCampaign(v Campaign)` + +SetCampaign sets Campaign field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignTemplateOwnerRef.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignTemplateOwnerRef.md new file mode 100644 index 000000000..2f1db80c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignTemplateOwnerRef.md @@ -0,0 +1,142 @@ +--- +id: v2024-campaign-template-owner-ref +title: CampaignTemplateOwnerRef +pagination_label: CampaignTemplateOwnerRef +sidebar_label: CampaignTemplateOwnerRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignTemplateOwnerRef', 'V2024CampaignTemplateOwnerRef'] +slug: /tools/sdk/go/v2024/models/campaign-template-owner-ref +tags: ['SDK', 'Software Development Kit', 'CampaignTemplateOwnerRef', 'V2024CampaignTemplateOwnerRef'] +--- + +# CampaignTemplateOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the owner | [optional] +**Type** | Pointer to **string** | Type of the owner | [optional] +**Name** | Pointer to **string** | Name of the owner | [optional] +**Email** | Pointer to **string** | Email of the owner | [optional] + +## Methods + +### NewCampaignTemplateOwnerRef + +`func NewCampaignTemplateOwnerRef() *CampaignTemplateOwnerRef` + +NewCampaignTemplateOwnerRef instantiates a new CampaignTemplateOwnerRef 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 + +### NewCampaignTemplateOwnerRefWithDefaults + +`func NewCampaignTemplateOwnerRefWithDefaults() *CampaignTemplateOwnerRef` + +NewCampaignTemplateOwnerRefWithDefaults instantiates a new CampaignTemplateOwnerRef 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 + +### GetId + +`func (o *CampaignTemplateOwnerRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignTemplateOwnerRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignTemplateOwnerRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignTemplateOwnerRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CampaignTemplateOwnerRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignTemplateOwnerRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignTemplateOwnerRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignTemplateOwnerRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignTemplateOwnerRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignTemplateOwnerRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignTemplateOwnerRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignTemplateOwnerRef) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *CampaignTemplateOwnerRef) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *CampaignTemplateOwnerRef) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *CampaignTemplateOwnerRef) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *CampaignTemplateOwnerRef) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CampaignsDeleteRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/CampaignsDeleteRequest.md new file mode 100644 index 000000000..8fd75c4d5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CampaignsDeleteRequest.md @@ -0,0 +1,64 @@ +--- +id: v2024-campaigns-delete-request +title: CampaignsDeleteRequest +pagination_label: CampaignsDeleteRequest +sidebar_label: CampaignsDeleteRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignsDeleteRequest', 'V2024CampaignsDeleteRequest'] +slug: /tools/sdk/go/v2024/models/campaigns-delete-request +tags: ['SDK', 'Software Development Kit', 'CampaignsDeleteRequest', 'V2024CampaignsDeleteRequest'] +--- + +# CampaignsDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]string** | The ids of the campaigns to delete | [optional] + +## Methods + +### NewCampaignsDeleteRequest + +`func NewCampaignsDeleteRequest() *CampaignsDeleteRequest` + +NewCampaignsDeleteRequest instantiates a new CampaignsDeleteRequest 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 + +### NewCampaignsDeleteRequestWithDefaults + +`func NewCampaignsDeleteRequestWithDefaults() *CampaignsDeleteRequest` + +NewCampaignsDeleteRequestWithDefaults instantiates a new CampaignsDeleteRequest 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 + +### GetIds + +`func (o *CampaignsDeleteRequest) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *CampaignsDeleteRequest) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *CampaignsDeleteRequest) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *CampaignsDeleteRequest) HasIds() bool` + +HasIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CancelAccessRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/CancelAccessRequest.md new file mode 100644 index 000000000..2db7da459 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CancelAccessRequest.md @@ -0,0 +1,80 @@ +--- +id: v2024-cancel-access-request +title: CancelAccessRequest +pagination_label: CancelAccessRequest +sidebar_label: CancelAccessRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CancelAccessRequest', 'V2024CancelAccessRequest'] +slug: /tools/sdk/go/v2024/models/cancel-access-request +tags: ['SDK', 'Software Development Kit', 'CancelAccessRequest', 'V2024CancelAccessRequest'] +--- + +# CancelAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountActivityId** | **string** | This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. | +**Comment** | **string** | Reason for cancelling the pending access request. | + +## Methods + +### NewCancelAccessRequest + +`func NewCancelAccessRequest(accountActivityId string, comment string, ) *CancelAccessRequest` + +NewCancelAccessRequest instantiates a new CancelAccessRequest 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 + +### NewCancelAccessRequestWithDefaults + +`func NewCancelAccessRequestWithDefaults() *CancelAccessRequest` + +NewCancelAccessRequestWithDefaults instantiates a new CancelAccessRequest 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 + +### GetAccountActivityId + +`func (o *CancelAccessRequest) GetAccountActivityId() string` + +GetAccountActivityId returns the AccountActivityId field if non-nil, zero value otherwise. + +### GetAccountActivityIdOk + +`func (o *CancelAccessRequest) GetAccountActivityIdOk() (*string, bool)` + +GetAccountActivityIdOk returns a tuple with the AccountActivityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActivityId + +`func (o *CancelAccessRequest) SetAccountActivityId(v string)` + +SetAccountActivityId sets AccountActivityId field to given value. + + +### GetComment + +`func (o *CancelAccessRequest) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CancelAccessRequest) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CancelAccessRequest) SetComment(v string)` + +SetComment sets Comment field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CancelledRequestDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/CancelledRequestDetails.md new file mode 100644 index 000000000..9e1346235 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CancelledRequestDetails.md @@ -0,0 +1,116 @@ +--- +id: v2024-cancelled-request-details +title: CancelledRequestDetails +pagination_label: CancelledRequestDetails +sidebar_label: CancelledRequestDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CancelledRequestDetails', 'V2024CancelledRequestDetails'] +slug: /tools/sdk/go/v2024/models/cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails', 'V2024CancelledRequestDetails'] +--- + +# CancelledRequestDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment made by the owner when cancelling the associated request. | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Modified** | Pointer to **SailPointTime** | Date comment was added by the owner when cancelling the associated request. | [optional] + +## Methods + +### NewCancelledRequestDetails + +`func NewCancelledRequestDetails() *CancelledRequestDetails` + +NewCancelledRequestDetails instantiates a new CancelledRequestDetails 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 + +### NewCancelledRequestDetailsWithDefaults + +`func NewCancelledRequestDetailsWithDefaults() *CancelledRequestDetails` + +NewCancelledRequestDetailsWithDefaults instantiates a new CancelledRequestDetails 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 + +### GetComment + +`func (o *CancelledRequestDetails) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CancelledRequestDetails) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CancelledRequestDetails) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CancelledRequestDetails) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetOwner + +`func (o *CancelledRequestDetails) GetOwner() OwnerDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CancelledRequestDetails) GetOwnerOk() (*OwnerDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CancelledRequestDetails) SetOwner(v OwnerDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *CancelledRequestDetails) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetModified + +`func (o *CancelledRequestDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CancelledRequestDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CancelledRequestDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CancelledRequestDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Certification.md b/docs/tools/sdk/go/Reference/V2024/Models/Certification.md new file mode 100644 index 000000000..c22952ee6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Certification.md @@ -0,0 +1,520 @@ +--- +id: v2024-certification +title: Certification +pagination_label: Certification +sidebar_label: Certification +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Certification', 'V2024Certification'] +slug: /tools/sdk/go/v2024/models/certification +tags: ['SDK', 'Software Development Kit', 'Certification', 'V2024Certification'] +--- + +# Certification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | id of the certification | [optional] +**Name** | Pointer to **string** | name of the certification | [optional] +**Campaign** | Pointer to [**CampaignReference**](campaign-reference) | | [optional] +**Completed** | Pointer to **bool** | Have all decisions been made? | [optional] +**IdentitiesCompleted** | Pointer to **int32** | The number of identities for whom all decisions have been made and are complete. | [optional] +**IdentitiesTotal** | Pointer to **int32** | The total number of identities in the Certification, both complete and incomplete. | [optional] +**Created** | Pointer to **SailPointTime** | created date | [optional] +**Modified** | Pointer to **SailPointTime** | modified date | [optional] +**DecisionsMade** | Pointer to **int32** | The number of approve/revoke/acknowledge decisions that have been made. | [optional] +**DecisionsTotal** | Pointer to **int32** | The total number of approve/revoke/acknowledge decisions. | [optional] +**Due** | Pointer to **NullableTime** | The due date of the certification. | [optional] +**Signed** | Pointer to **NullableTime** | The date the reviewer signed off on the Certification. | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] +**Reassignment** | Pointer to [**NullableReassignment**](reassignment) | | [optional] +**HasErrors** | Pointer to **bool** | Identifies if the certification has an error | [optional] +**ErrorMessage** | Pointer to **NullableString** | Description of the certification error | [optional] +**Phase** | Pointer to [**CertificationPhase**](certification-phase) | | [optional] + +## Methods + +### NewCertification + +`func NewCertification() *Certification` + +NewCertification instantiates a new Certification 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 + +### NewCertificationWithDefaults + +`func NewCertificationWithDefaults() *Certification` + +NewCertificationWithDefaults instantiates a new Certification 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 + +### GetId + +`func (o *Certification) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Certification) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Certification) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Certification) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Certification) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Certification) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Certification) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Certification) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCampaign + +`func (o *Certification) GetCampaign() CampaignReference` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *Certification) GetCampaignOk() (*CampaignReference, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *Certification) SetCampaign(v CampaignReference)` + +SetCampaign sets Campaign field to given value. + +### HasCampaign + +`func (o *Certification) HasCampaign() bool` + +HasCampaign returns a boolean if a field has been set. + +### GetCompleted + +`func (o *Certification) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *Certification) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *Certification) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *Certification) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetIdentitiesCompleted + +`func (o *Certification) GetIdentitiesCompleted() int32` + +GetIdentitiesCompleted returns the IdentitiesCompleted field if non-nil, zero value otherwise. + +### GetIdentitiesCompletedOk + +`func (o *Certification) GetIdentitiesCompletedOk() (*int32, bool)` + +GetIdentitiesCompletedOk returns a tuple with the IdentitiesCompleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesCompleted + +`func (o *Certification) SetIdentitiesCompleted(v int32)` + +SetIdentitiesCompleted sets IdentitiesCompleted field to given value. + +### HasIdentitiesCompleted + +`func (o *Certification) HasIdentitiesCompleted() bool` + +HasIdentitiesCompleted returns a boolean if a field has been set. + +### GetIdentitiesTotal + +`func (o *Certification) GetIdentitiesTotal() int32` + +GetIdentitiesTotal returns the IdentitiesTotal field if non-nil, zero value otherwise. + +### GetIdentitiesTotalOk + +`func (o *Certification) GetIdentitiesTotalOk() (*int32, bool)` + +GetIdentitiesTotalOk returns a tuple with the IdentitiesTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesTotal + +`func (o *Certification) SetIdentitiesTotal(v int32)` + +SetIdentitiesTotal sets IdentitiesTotal field to given value. + +### HasIdentitiesTotal + +`func (o *Certification) HasIdentitiesTotal() bool` + +HasIdentitiesTotal returns a boolean if a field has been set. + +### GetCreated + +`func (o *Certification) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Certification) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Certification) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Certification) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Certification) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Certification) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Certification) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Certification) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDecisionsMade + +`func (o *Certification) GetDecisionsMade() int32` + +GetDecisionsMade returns the DecisionsMade field if non-nil, zero value otherwise. + +### GetDecisionsMadeOk + +`func (o *Certification) GetDecisionsMadeOk() (*int32, bool)` + +GetDecisionsMadeOk returns a tuple with the DecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsMade + +`func (o *Certification) SetDecisionsMade(v int32)` + +SetDecisionsMade sets DecisionsMade field to given value. + +### HasDecisionsMade + +`func (o *Certification) HasDecisionsMade() bool` + +HasDecisionsMade returns a boolean if a field has been set. + +### GetDecisionsTotal + +`func (o *Certification) GetDecisionsTotal() int32` + +GetDecisionsTotal returns the DecisionsTotal field if non-nil, zero value otherwise. + +### GetDecisionsTotalOk + +`func (o *Certification) GetDecisionsTotalOk() (*int32, bool)` + +GetDecisionsTotalOk returns a tuple with the DecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsTotal + +`func (o *Certification) SetDecisionsTotal(v int32)` + +SetDecisionsTotal sets DecisionsTotal field to given value. + +### HasDecisionsTotal + +`func (o *Certification) HasDecisionsTotal() bool` + +HasDecisionsTotal returns a boolean if a field has been set. + +### GetDue + +`func (o *Certification) GetDue() SailPointTime` + +GetDue returns the Due field if non-nil, zero value otherwise. + +### GetDueOk + +`func (o *Certification) GetDueOk() (*SailPointTime, bool)` + +GetDueOk returns a tuple with the Due field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDue + +`func (o *Certification) SetDue(v SailPointTime)` + +SetDue sets Due field to given value. + +### HasDue + +`func (o *Certification) HasDue() bool` + +HasDue returns a boolean if a field has been set. + +### SetDueNil + +`func (o *Certification) SetDueNil(b bool)` + + SetDueNil sets the value for Due to be an explicit nil + +### UnsetDue +`func (o *Certification) UnsetDue()` + +UnsetDue ensures that no value is present for Due, not even an explicit nil +### GetSigned + +`func (o *Certification) GetSigned() SailPointTime` + +GetSigned returns the Signed field if non-nil, zero value otherwise. + +### GetSignedOk + +`func (o *Certification) GetSignedOk() (*SailPointTime, bool)` + +GetSignedOk returns a tuple with the Signed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigned + +`func (o *Certification) SetSigned(v SailPointTime)` + +SetSigned sets Signed field to given value. + +### HasSigned + +`func (o *Certification) HasSigned() bool` + +HasSigned returns a boolean if a field has been set. + +### SetSignedNil + +`func (o *Certification) SetSignedNil(b bool)` + + SetSignedNil sets the value for Signed to be an explicit nil + +### UnsetSigned +`func (o *Certification) UnsetSigned()` + +UnsetSigned ensures that no value is present for Signed, not even an explicit nil +### GetReviewer + +`func (o *Certification) GetReviewer() Reviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *Certification) GetReviewerOk() (*Reviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *Certification) SetReviewer(v Reviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *Certification) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetReassignment + +`func (o *Certification) GetReassignment() Reassignment` + +GetReassignment returns the Reassignment field if non-nil, zero value otherwise. + +### GetReassignmentOk + +`func (o *Certification) GetReassignmentOk() (*Reassignment, bool)` + +GetReassignmentOk returns a tuple with the Reassignment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignment + +`func (o *Certification) SetReassignment(v Reassignment)` + +SetReassignment sets Reassignment field to given value. + +### HasReassignment + +`func (o *Certification) HasReassignment() bool` + +HasReassignment returns a boolean if a field has been set. + +### SetReassignmentNil + +`func (o *Certification) SetReassignmentNil(b bool)` + + SetReassignmentNil sets the value for Reassignment to be an explicit nil + +### UnsetReassignment +`func (o *Certification) UnsetReassignment()` + +UnsetReassignment ensures that no value is present for Reassignment, not even an explicit nil +### GetHasErrors + +`func (o *Certification) GetHasErrors() bool` + +GetHasErrors returns the HasErrors field if non-nil, zero value otherwise. + +### GetHasErrorsOk + +`func (o *Certification) GetHasErrorsOk() (*bool, bool)` + +GetHasErrorsOk returns a tuple with the HasErrors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasErrors + +`func (o *Certification) SetHasErrors(v bool)` + +SetHasErrors sets HasErrors field to given value. + +### HasHasErrors + +`func (o *Certification) HasHasErrors() bool` + +HasHasErrors returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *Certification) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *Certification) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *Certification) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *Certification) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### SetErrorMessageNil + +`func (o *Certification) SetErrorMessageNil(b bool)` + + SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil + +### UnsetErrorMessage +`func (o *Certification) UnsetErrorMessage()` + +UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil +### GetPhase + +`func (o *Certification) GetPhase() CertificationPhase` + +GetPhase returns the Phase field if non-nil, zero value otherwise. + +### GetPhaseOk + +`func (o *Certification) GetPhaseOk() (*CertificationPhase, bool)` + +GetPhaseOk returns a tuple with the Phase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhase + +`func (o *Certification) SetPhase(v CertificationPhase)` + +SetPhase sets Phase field to given value. + +### HasPhase + +`func (o *Certification) HasPhase() bool` + +HasPhase returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CertificationDecision.md b/docs/tools/sdk/go/Reference/V2024/Models/CertificationDecision.md new file mode 100644 index 000000000..414e4049f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CertificationDecision.md @@ -0,0 +1,21 @@ +--- +id: v2024-certification-decision +title: CertificationDecision +pagination_label: CertificationDecision +sidebar_label: CertificationDecision +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationDecision', 'V2024CertificationDecision'] +slug: /tools/sdk/go/v2024/models/certification-decision +tags: ['SDK', 'Software Development Kit', 'CertificationDecision', 'V2024CertificationDecision'] +--- + +# CertificationDecision + +## Enum + + +* `APPROVE` (value: `"APPROVE"`) + +* `REVOKE` (value: `"REVOKE"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CertificationDto.md b/docs/tools/sdk/go/Reference/V2024/Models/CertificationDto.md new file mode 100644 index 000000000..bcfc904f1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CertificationDto.md @@ -0,0 +1,341 @@ +--- +id: v2024-certification-dto +title: CertificationDto +pagination_label: CertificationDto +sidebar_label: CertificationDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationDto', 'V2024CertificationDto'] +slug: /tools/sdk/go/v2024/models/certification-dto +tags: ['SDK', 'Software Development Kit', 'CertificationDto', 'V2024CertificationDto'] +--- + +# CertificationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CampaignRef** | [**CampaignReference**](campaign-reference) | | +**Phase** | [**CertificationPhase**](certification-phase) | | +**Due** | **SailPointTime** | The due date of the certification. | +**Signed** | **SailPointTime** | The date the reviewer signed off on the certification. | +**Reviewer** | [**Reviewer**](reviewer) | | +**Reassignment** | Pointer to [**NullableReassignment**](reassignment) | | [optional] +**HasErrors** | **bool** | Indicates it the certification has any errors. | +**ErrorMessage** | Pointer to **NullableString** | A message indicating what the error is. | [optional] +**Completed** | **bool** | Indicates if all certification decisions have been made. | +**DecisionsMade** | **int32** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | +**DecisionsTotal** | **int32** | The total number of approve/revoke/acknowledge decisions for the certification. | +**EntitiesCompleted** | **int32** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | +**EntitiesTotal** | **int32** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | + +## Methods + +### NewCertificationDto + +`func NewCertificationDto(campaignRef CampaignReference, phase CertificationPhase, due SailPointTime, signed SailPointTime, reviewer Reviewer, hasErrors bool, completed bool, decisionsMade int32, decisionsTotal int32, entitiesCompleted int32, entitiesTotal int32, ) *CertificationDto` + +NewCertificationDto instantiates a new CertificationDto 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 + +### NewCertificationDtoWithDefaults + +`func NewCertificationDtoWithDefaults() *CertificationDto` + +NewCertificationDtoWithDefaults instantiates a new CertificationDto 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 + +### GetCampaignRef + +`func (o *CertificationDto) GetCampaignRef() CampaignReference` + +GetCampaignRef returns the CampaignRef field if non-nil, zero value otherwise. + +### GetCampaignRefOk + +`func (o *CertificationDto) GetCampaignRefOk() (*CampaignReference, bool)` + +GetCampaignRefOk returns a tuple with the CampaignRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignRef + +`func (o *CertificationDto) SetCampaignRef(v CampaignReference)` + +SetCampaignRef sets CampaignRef field to given value. + + +### GetPhase + +`func (o *CertificationDto) GetPhase() CertificationPhase` + +GetPhase returns the Phase field if non-nil, zero value otherwise. + +### GetPhaseOk + +`func (o *CertificationDto) GetPhaseOk() (*CertificationPhase, bool)` + +GetPhaseOk returns a tuple with the Phase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhase + +`func (o *CertificationDto) SetPhase(v CertificationPhase)` + +SetPhase sets Phase field to given value. + + +### GetDue + +`func (o *CertificationDto) GetDue() SailPointTime` + +GetDue returns the Due field if non-nil, zero value otherwise. + +### GetDueOk + +`func (o *CertificationDto) GetDueOk() (*SailPointTime, bool)` + +GetDueOk returns a tuple with the Due field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDue + +`func (o *CertificationDto) SetDue(v SailPointTime)` + +SetDue sets Due field to given value. + + +### GetSigned + +`func (o *CertificationDto) GetSigned() SailPointTime` + +GetSigned returns the Signed field if non-nil, zero value otherwise. + +### GetSignedOk + +`func (o *CertificationDto) GetSignedOk() (*SailPointTime, bool)` + +GetSignedOk returns a tuple with the Signed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigned + +`func (o *CertificationDto) SetSigned(v SailPointTime)` + +SetSigned sets Signed field to given value. + + +### GetReviewer + +`func (o *CertificationDto) GetReviewer() Reviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CertificationDto) GetReviewerOk() (*Reviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CertificationDto) SetReviewer(v Reviewer)` + +SetReviewer sets Reviewer field to given value. + + +### GetReassignment + +`func (o *CertificationDto) GetReassignment() Reassignment` + +GetReassignment returns the Reassignment field if non-nil, zero value otherwise. + +### GetReassignmentOk + +`func (o *CertificationDto) GetReassignmentOk() (*Reassignment, bool)` + +GetReassignmentOk returns a tuple with the Reassignment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignment + +`func (o *CertificationDto) SetReassignment(v Reassignment)` + +SetReassignment sets Reassignment field to given value. + +### HasReassignment + +`func (o *CertificationDto) HasReassignment() bool` + +HasReassignment returns a boolean if a field has been set. + +### SetReassignmentNil + +`func (o *CertificationDto) SetReassignmentNil(b bool)` + + SetReassignmentNil sets the value for Reassignment to be an explicit nil + +### UnsetReassignment +`func (o *CertificationDto) UnsetReassignment()` + +UnsetReassignment ensures that no value is present for Reassignment, not even an explicit nil +### GetHasErrors + +`func (o *CertificationDto) GetHasErrors() bool` + +GetHasErrors returns the HasErrors field if non-nil, zero value otherwise. + +### GetHasErrorsOk + +`func (o *CertificationDto) GetHasErrorsOk() (*bool, bool)` + +GetHasErrorsOk returns a tuple with the HasErrors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasErrors + +`func (o *CertificationDto) SetHasErrors(v bool)` + +SetHasErrors sets HasErrors field to given value. + + +### GetErrorMessage + +`func (o *CertificationDto) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *CertificationDto) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *CertificationDto) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *CertificationDto) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### SetErrorMessageNil + +`func (o *CertificationDto) SetErrorMessageNil(b bool)` + + SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil + +### UnsetErrorMessage +`func (o *CertificationDto) UnsetErrorMessage()` + +UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil +### GetCompleted + +`func (o *CertificationDto) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *CertificationDto) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *CertificationDto) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + + +### GetDecisionsMade + +`func (o *CertificationDto) GetDecisionsMade() int32` + +GetDecisionsMade returns the DecisionsMade field if non-nil, zero value otherwise. + +### GetDecisionsMadeOk + +`func (o *CertificationDto) GetDecisionsMadeOk() (*int32, bool)` + +GetDecisionsMadeOk returns a tuple with the DecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsMade + +`func (o *CertificationDto) SetDecisionsMade(v int32)` + +SetDecisionsMade sets DecisionsMade field to given value. + + +### GetDecisionsTotal + +`func (o *CertificationDto) GetDecisionsTotal() int32` + +GetDecisionsTotal returns the DecisionsTotal field if non-nil, zero value otherwise. + +### GetDecisionsTotalOk + +`func (o *CertificationDto) GetDecisionsTotalOk() (*int32, bool)` + +GetDecisionsTotalOk returns a tuple with the DecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsTotal + +`func (o *CertificationDto) SetDecisionsTotal(v int32)` + +SetDecisionsTotal sets DecisionsTotal field to given value. + + +### GetEntitiesCompleted + +`func (o *CertificationDto) GetEntitiesCompleted() int32` + +GetEntitiesCompleted returns the EntitiesCompleted field if non-nil, zero value otherwise. + +### GetEntitiesCompletedOk + +`func (o *CertificationDto) GetEntitiesCompletedOk() (*int32, bool)` + +GetEntitiesCompletedOk returns a tuple with the EntitiesCompleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitiesCompleted + +`func (o *CertificationDto) SetEntitiesCompleted(v int32)` + +SetEntitiesCompleted sets EntitiesCompleted field to given value. + + +### GetEntitiesTotal + +`func (o *CertificationDto) GetEntitiesTotal() int32` + +GetEntitiesTotal returns the EntitiesTotal field if non-nil, zero value otherwise. + +### GetEntitiesTotalOk + +`func (o *CertificationDto) GetEntitiesTotalOk() (*int32, bool)` + +GetEntitiesTotalOk returns a tuple with the EntitiesTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitiesTotal + +`func (o *CertificationDto) SetEntitiesTotal(v int32)` + +SetEntitiesTotal sets EntitiesTotal field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CertificationIdentitySummary.md b/docs/tools/sdk/go/Reference/V2024/Models/CertificationIdentitySummary.md new file mode 100644 index 000000000..741254a11 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CertificationIdentitySummary.md @@ -0,0 +1,142 @@ +--- +id: v2024-certification-identity-summary +title: CertificationIdentitySummary +pagination_label: CertificationIdentitySummary +sidebar_label: CertificationIdentitySummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationIdentitySummary', 'V2024CertificationIdentitySummary'] +slug: /tools/sdk/go/v2024/models/certification-identity-summary +tags: ['SDK', 'Software Development Kit', 'CertificationIdentitySummary', 'V2024CertificationIdentitySummary'] +--- + +# CertificationIdentitySummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the identity summary | [optional] +**Name** | Pointer to **string** | Name of the linked identity | [optional] +**IdentityId** | Pointer to **string** | The ID of the identity being certified | [optional] +**Completed** | Pointer to **bool** | Indicates whether the review items for the linked identity's certification have been completed | [optional] + +## Methods + +### NewCertificationIdentitySummary + +`func NewCertificationIdentitySummary() *CertificationIdentitySummary` + +NewCertificationIdentitySummary instantiates a new CertificationIdentitySummary 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 + +### NewCertificationIdentitySummaryWithDefaults + +`func NewCertificationIdentitySummaryWithDefaults() *CertificationIdentitySummary` + +NewCertificationIdentitySummaryWithDefaults instantiates a new CertificationIdentitySummary 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 + +### GetId + +`func (o *CertificationIdentitySummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertificationIdentitySummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertificationIdentitySummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CertificationIdentitySummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CertificationIdentitySummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CertificationIdentitySummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CertificationIdentitySummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CertificationIdentitySummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *CertificationIdentitySummary) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *CertificationIdentitySummary) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *CertificationIdentitySummary) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *CertificationIdentitySummary) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetCompleted + +`func (o *CertificationIdentitySummary) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *CertificationIdentitySummary) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *CertificationIdentitySummary) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *CertificationIdentitySummary) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CertificationPhase.md b/docs/tools/sdk/go/Reference/V2024/Models/CertificationPhase.md new file mode 100644 index 000000000..4a4408eaa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CertificationPhase.md @@ -0,0 +1,23 @@ +--- +id: v2024-certification-phase +title: CertificationPhase +pagination_label: CertificationPhase +sidebar_label: CertificationPhase +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationPhase', 'V2024CertificationPhase'] +slug: /tools/sdk/go/v2024/models/certification-phase +tags: ['SDK', 'Software Development Kit', 'CertificationPhase', 'V2024CertificationPhase'] +--- + +# CertificationPhase + +## Enum + + +* `STAGED` (value: `"STAGED"`) + +* `ACTIVE` (value: `"ACTIVE"`) + +* `SIGNED` (value: `"SIGNED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CertificationReference.md b/docs/tools/sdk/go/Reference/V2024/Models/CertificationReference.md new file mode 100644 index 000000000..e4ba7818f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CertificationReference.md @@ -0,0 +1,142 @@ +--- +id: v2024-certification-reference +title: CertificationReference +pagination_label: CertificationReference +sidebar_label: CertificationReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationReference', 'V2024CertificationReference'] +slug: /tools/sdk/go/v2024/models/certification-reference +tags: ['SDK', 'Software Development Kit', 'CertificationReference', 'V2024CertificationReference'] +--- + +# CertificationReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the certification. | [optional] +**Name** | Pointer to **string** | The name of the certification. | [optional] +**Type** | Pointer to **string** | | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] + +## Methods + +### NewCertificationReference + +`func NewCertificationReference() *CertificationReference` + +NewCertificationReference instantiates a new CertificationReference 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 + +### NewCertificationReferenceWithDefaults + +`func NewCertificationReferenceWithDefaults() *CertificationReference` + +NewCertificationReferenceWithDefaults instantiates a new CertificationReference 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 + +### GetId + +`func (o *CertificationReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertificationReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertificationReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CertificationReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CertificationReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CertificationReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CertificationReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CertificationReference) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *CertificationReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CertificationReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CertificationReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CertificationReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetReviewer + +`func (o *CertificationReference) GetReviewer() Reviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CertificationReference) GetReviewerOk() (*Reviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CertificationReference) SetReviewer(v Reviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *CertificationReference) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CertificationSignedOff.md b/docs/tools/sdk/go/Reference/V2024/Models/CertificationSignedOff.md new file mode 100644 index 000000000..5afd13184 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CertificationSignedOff.md @@ -0,0 +1,59 @@ +--- +id: v2024-certification-signed-off +title: CertificationSignedOff +pagination_label: CertificationSignedOff +sidebar_label: CertificationSignedOff +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationSignedOff', 'V2024CertificationSignedOff'] +slug: /tools/sdk/go/v2024/models/certification-signed-off +tags: ['SDK', 'Software Development Kit', 'CertificationSignedOff', 'V2024CertificationSignedOff'] +--- + +# CertificationSignedOff + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | + +## Methods + +### NewCertificationSignedOff + +`func NewCertificationSignedOff(certification CertificationSignedOffCertification, ) *CertificationSignedOff` + +NewCertificationSignedOff instantiates a new CertificationSignedOff 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 + +### NewCertificationSignedOffWithDefaults + +`func NewCertificationSignedOffWithDefaults() *CertificationSignedOff` + +NewCertificationSignedOffWithDefaults instantiates a new CertificationSignedOff 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 + +### GetCertification + +`func (o *CertificationSignedOff) GetCertification() CertificationSignedOffCertification` + +GetCertification returns the Certification field if non-nil, zero value otherwise. + +### GetCertificationOk + +`func (o *CertificationSignedOff) GetCertificationOk() (*CertificationSignedOffCertification, bool)` + +GetCertificationOk returns a tuple with the Certification field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertification + +`func (o *CertificationSignedOff) SetCertification(v CertificationSignedOffCertification)` + +SetCertification sets Certification field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CertificationSignedOffCertification.md b/docs/tools/sdk/go/Reference/V2024/Models/CertificationSignedOffCertification.md new file mode 100644 index 000000000..d3d1d26fa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CertificationSignedOffCertification.md @@ -0,0 +1,440 @@ +--- +id: v2024-certification-signed-off-certification +title: CertificationSignedOffCertification +pagination_label: CertificationSignedOffCertification +sidebar_label: CertificationSignedOffCertification +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationSignedOffCertification', 'V2024CertificationSignedOffCertification'] +slug: /tools/sdk/go/v2024/models/certification-signed-off-certification +tags: ['SDK', 'Software Development Kit', 'CertificationSignedOffCertification', 'V2024CertificationSignedOffCertification'] +--- + +# CertificationSignedOffCertification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique ID of the certification. | +**Name** | **string** | The name of the certification. | +**Created** | **SailPointTime** | The date and time the certification was created. | +**Modified** | Pointer to **NullableTime** | The date and time the certification was last modified. | [optional] +**CampaignRef** | [**CampaignReference**](campaign-reference) | | +**Phase** | [**CertificationPhase**](certification-phase) | | +**Due** | **SailPointTime** | The due date of the certification. | +**Signed** | **SailPointTime** | The date the reviewer signed off on the certification. | +**Reviewer** | [**Reviewer**](reviewer) | | +**Reassignment** | Pointer to [**NullableReassignment**](reassignment) | | [optional] +**HasErrors** | **bool** | Indicates it the certification has any errors. | +**ErrorMessage** | Pointer to **NullableString** | A message indicating what the error is. | [optional] +**Completed** | **bool** | Indicates if all certification decisions have been made. | +**DecisionsMade** | **int32** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | +**DecisionsTotal** | **int32** | The total number of approve/revoke/acknowledge decisions for the certification. | +**EntitiesCompleted** | **int32** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | +**EntitiesTotal** | **int32** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | + +## Methods + +### NewCertificationSignedOffCertification + +`func NewCertificationSignedOffCertification(id string, name string, created SailPointTime, campaignRef CampaignReference, phase CertificationPhase, due SailPointTime, signed SailPointTime, reviewer Reviewer, hasErrors bool, completed bool, decisionsMade int32, decisionsTotal int32, entitiesCompleted int32, entitiesTotal int32, ) *CertificationSignedOffCertification` + +NewCertificationSignedOffCertification instantiates a new CertificationSignedOffCertification 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 + +### NewCertificationSignedOffCertificationWithDefaults + +`func NewCertificationSignedOffCertificationWithDefaults() *CertificationSignedOffCertification` + +NewCertificationSignedOffCertificationWithDefaults instantiates a new CertificationSignedOffCertification 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 + +### GetId + +`func (o *CertificationSignedOffCertification) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertificationSignedOffCertification) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertificationSignedOffCertification) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CertificationSignedOffCertification) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CertificationSignedOffCertification) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CertificationSignedOffCertification) SetName(v string)` + +SetName sets Name field to given value. + + +### GetCreated + +`func (o *CertificationSignedOffCertification) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CertificationSignedOffCertification) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CertificationSignedOffCertification) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CertificationSignedOffCertification) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CertificationSignedOffCertification) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CertificationSignedOffCertification) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CertificationSignedOffCertification) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CertificationSignedOffCertification) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CertificationSignedOffCertification) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetCampaignRef + +`func (o *CertificationSignedOffCertification) GetCampaignRef() CampaignReference` + +GetCampaignRef returns the CampaignRef field if non-nil, zero value otherwise. + +### GetCampaignRefOk + +`func (o *CertificationSignedOffCertification) GetCampaignRefOk() (*CampaignReference, bool)` + +GetCampaignRefOk returns a tuple with the CampaignRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignRef + +`func (o *CertificationSignedOffCertification) SetCampaignRef(v CampaignReference)` + +SetCampaignRef sets CampaignRef field to given value. + + +### GetPhase + +`func (o *CertificationSignedOffCertification) GetPhase() CertificationPhase` + +GetPhase returns the Phase field if non-nil, zero value otherwise. + +### GetPhaseOk + +`func (o *CertificationSignedOffCertification) GetPhaseOk() (*CertificationPhase, bool)` + +GetPhaseOk returns a tuple with the Phase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhase + +`func (o *CertificationSignedOffCertification) SetPhase(v CertificationPhase)` + +SetPhase sets Phase field to given value. + + +### GetDue + +`func (o *CertificationSignedOffCertification) GetDue() SailPointTime` + +GetDue returns the Due field if non-nil, zero value otherwise. + +### GetDueOk + +`func (o *CertificationSignedOffCertification) GetDueOk() (*SailPointTime, bool)` + +GetDueOk returns a tuple with the Due field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDue + +`func (o *CertificationSignedOffCertification) SetDue(v SailPointTime)` + +SetDue sets Due field to given value. + + +### GetSigned + +`func (o *CertificationSignedOffCertification) GetSigned() SailPointTime` + +GetSigned returns the Signed field if non-nil, zero value otherwise. + +### GetSignedOk + +`func (o *CertificationSignedOffCertification) GetSignedOk() (*SailPointTime, bool)` + +GetSignedOk returns a tuple with the Signed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigned + +`func (o *CertificationSignedOffCertification) SetSigned(v SailPointTime)` + +SetSigned sets Signed field to given value. + + +### GetReviewer + +`func (o *CertificationSignedOffCertification) GetReviewer() Reviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CertificationSignedOffCertification) GetReviewerOk() (*Reviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CertificationSignedOffCertification) SetReviewer(v Reviewer)` + +SetReviewer sets Reviewer field to given value. + + +### GetReassignment + +`func (o *CertificationSignedOffCertification) GetReassignment() Reassignment` + +GetReassignment returns the Reassignment field if non-nil, zero value otherwise. + +### GetReassignmentOk + +`func (o *CertificationSignedOffCertification) GetReassignmentOk() (*Reassignment, bool)` + +GetReassignmentOk returns a tuple with the Reassignment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignment + +`func (o *CertificationSignedOffCertification) SetReassignment(v Reassignment)` + +SetReassignment sets Reassignment field to given value. + +### HasReassignment + +`func (o *CertificationSignedOffCertification) HasReassignment() bool` + +HasReassignment returns a boolean if a field has been set. + +### SetReassignmentNil + +`func (o *CertificationSignedOffCertification) SetReassignmentNil(b bool)` + + SetReassignmentNil sets the value for Reassignment to be an explicit nil + +### UnsetReassignment +`func (o *CertificationSignedOffCertification) UnsetReassignment()` + +UnsetReassignment ensures that no value is present for Reassignment, not even an explicit nil +### GetHasErrors + +`func (o *CertificationSignedOffCertification) GetHasErrors() bool` + +GetHasErrors returns the HasErrors field if non-nil, zero value otherwise. + +### GetHasErrorsOk + +`func (o *CertificationSignedOffCertification) GetHasErrorsOk() (*bool, bool)` + +GetHasErrorsOk returns a tuple with the HasErrors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasErrors + +`func (o *CertificationSignedOffCertification) SetHasErrors(v bool)` + +SetHasErrors sets HasErrors field to given value. + + +### GetErrorMessage + +`func (o *CertificationSignedOffCertification) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *CertificationSignedOffCertification) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *CertificationSignedOffCertification) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *CertificationSignedOffCertification) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### SetErrorMessageNil + +`func (o *CertificationSignedOffCertification) SetErrorMessageNil(b bool)` + + SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil + +### UnsetErrorMessage +`func (o *CertificationSignedOffCertification) UnsetErrorMessage()` + +UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil +### GetCompleted + +`func (o *CertificationSignedOffCertification) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *CertificationSignedOffCertification) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *CertificationSignedOffCertification) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + + +### GetDecisionsMade + +`func (o *CertificationSignedOffCertification) GetDecisionsMade() int32` + +GetDecisionsMade returns the DecisionsMade field if non-nil, zero value otherwise. + +### GetDecisionsMadeOk + +`func (o *CertificationSignedOffCertification) GetDecisionsMadeOk() (*int32, bool)` + +GetDecisionsMadeOk returns a tuple with the DecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsMade + +`func (o *CertificationSignedOffCertification) SetDecisionsMade(v int32)` + +SetDecisionsMade sets DecisionsMade field to given value. + + +### GetDecisionsTotal + +`func (o *CertificationSignedOffCertification) GetDecisionsTotal() int32` + +GetDecisionsTotal returns the DecisionsTotal field if non-nil, zero value otherwise. + +### GetDecisionsTotalOk + +`func (o *CertificationSignedOffCertification) GetDecisionsTotalOk() (*int32, bool)` + +GetDecisionsTotalOk returns a tuple with the DecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsTotal + +`func (o *CertificationSignedOffCertification) SetDecisionsTotal(v int32)` + +SetDecisionsTotal sets DecisionsTotal field to given value. + + +### GetEntitiesCompleted + +`func (o *CertificationSignedOffCertification) GetEntitiesCompleted() int32` + +GetEntitiesCompleted returns the EntitiesCompleted field if non-nil, zero value otherwise. + +### GetEntitiesCompletedOk + +`func (o *CertificationSignedOffCertification) GetEntitiesCompletedOk() (*int32, bool)` + +GetEntitiesCompletedOk returns a tuple with the EntitiesCompleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitiesCompleted + +`func (o *CertificationSignedOffCertification) SetEntitiesCompleted(v int32)` + +SetEntitiesCompleted sets EntitiesCompleted field to given value. + + +### GetEntitiesTotal + +`func (o *CertificationSignedOffCertification) GetEntitiesTotal() int32` + +GetEntitiesTotal returns the EntitiesTotal field if non-nil, zero value otherwise. + +### GetEntitiesTotalOk + +`func (o *CertificationSignedOffCertification) GetEntitiesTotalOk() (*int32, bool)` + +GetEntitiesTotalOk returns a tuple with the EntitiesTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitiesTotal + +`func (o *CertificationSignedOffCertification) SetEntitiesTotal(v int32)` + +SetEntitiesTotal sets EntitiesTotal field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CertificationTask.md b/docs/tools/sdk/go/Reference/V2024/Models/CertificationTask.md new file mode 100644 index 000000000..f16831236 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CertificationTask.md @@ -0,0 +1,246 @@ +--- +id: v2024-certification-task +title: CertificationTask +pagination_label: CertificationTask +sidebar_label: CertificationTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationTask', 'V2024CertificationTask'] +slug: /tools/sdk/go/v2024/models/certification-task +tags: ['SDK', 'Software Development Kit', 'CertificationTask', 'V2024CertificationTask'] +--- + +# CertificationTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the certification task. | [optional] +**Type** | Pointer to **string** | The type of the certification task. More values may be added in the future. | [optional] +**TargetType** | Pointer to **string** | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [optional] +**TargetId** | Pointer to **string** | The ID of the item being operated on by this task. | [optional] +**Status** | Pointer to **string** | The status of the task. | [optional] +**Errors** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | List of error messages | [optional] +**ReassignmentTrailDTOs** | Pointer to [**[]ReassignmentTrailDTO**](reassignment-trail-dto) | Reassignment trails that lead to self certification identity | [optional] +**Created** | Pointer to **SailPointTime** | The date and time on which this task was created. | [optional] + +## Methods + +### NewCertificationTask + +`func NewCertificationTask() *CertificationTask` + +NewCertificationTask instantiates a new CertificationTask 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 + +### NewCertificationTaskWithDefaults + +`func NewCertificationTaskWithDefaults() *CertificationTask` + +NewCertificationTaskWithDefaults instantiates a new CertificationTask 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 + +### GetId + +`func (o *CertificationTask) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertificationTask) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertificationTask) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CertificationTask) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CertificationTask) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CertificationTask) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CertificationTask) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CertificationTask) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetTargetType + +`func (o *CertificationTask) GetTargetType() string` + +GetTargetType returns the TargetType field if non-nil, zero value otherwise. + +### GetTargetTypeOk + +`func (o *CertificationTask) GetTargetTypeOk() (*string, bool)` + +GetTargetTypeOk returns a tuple with the TargetType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetType + +`func (o *CertificationTask) SetTargetType(v string)` + +SetTargetType sets TargetType field to given value. + +### HasTargetType + +`func (o *CertificationTask) HasTargetType() bool` + +HasTargetType returns a boolean if a field has been set. + +### GetTargetId + +`func (o *CertificationTask) GetTargetId() string` + +GetTargetId returns the TargetId field if non-nil, zero value otherwise. + +### GetTargetIdOk + +`func (o *CertificationTask) GetTargetIdOk() (*string, bool)` + +GetTargetIdOk returns a tuple with the TargetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetId + +`func (o *CertificationTask) SetTargetId(v string)` + +SetTargetId sets TargetId field to given value. + +### HasTargetId + +`func (o *CertificationTask) HasTargetId() bool` + +HasTargetId returns a boolean if a field has been set. + +### GetStatus + +`func (o *CertificationTask) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CertificationTask) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CertificationTask) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CertificationTask) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetErrors + +`func (o *CertificationTask) GetErrors() []ErrorMessageDto` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *CertificationTask) GetErrorsOk() (*[]ErrorMessageDto, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *CertificationTask) SetErrors(v []ErrorMessageDto)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *CertificationTask) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### GetReassignmentTrailDTOs + +`func (o *CertificationTask) GetReassignmentTrailDTOs() []ReassignmentTrailDTO` + +GetReassignmentTrailDTOs returns the ReassignmentTrailDTOs field if non-nil, zero value otherwise. + +### GetReassignmentTrailDTOsOk + +`func (o *CertificationTask) GetReassignmentTrailDTOsOk() (*[]ReassignmentTrailDTO, bool)` + +GetReassignmentTrailDTOsOk returns a tuple with the ReassignmentTrailDTOs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignmentTrailDTOs + +`func (o *CertificationTask) SetReassignmentTrailDTOs(v []ReassignmentTrailDTO)` + +SetReassignmentTrailDTOs sets ReassignmentTrailDTOs field to given value. + +### HasReassignmentTrailDTOs + +`func (o *CertificationTask) HasReassignmentTrailDTOs() bool` + +HasReassignmentTrailDTOs returns a boolean if a field has been set. + +### GetCreated + +`func (o *CertificationTask) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CertificationTask) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CertificationTask) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CertificationTask) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CertifierResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/CertifierResponse.md new file mode 100644 index 000000000..335572f1c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CertifierResponse.md @@ -0,0 +1,90 @@ +--- +id: v2024-certifier-response +title: CertifierResponse +pagination_label: CertifierResponse +sidebar_label: CertifierResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertifierResponse', 'V2024CertifierResponse'] +slug: /tools/sdk/go/v2024/models/certifier-response +tags: ['SDK', 'Software Development Kit', 'CertifierResponse', 'V2024CertifierResponse'] +--- + +# CertifierResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the id of the certifier | [optional] +**DisplayName** | Pointer to **string** | the name of the certifier | [optional] + +## Methods + +### NewCertifierResponse + +`func NewCertifierResponse() *CertifierResponse` + +NewCertifierResponse instantiates a new CertifierResponse 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 + +### NewCertifierResponseWithDefaults + +`func NewCertifierResponseWithDefaults() *CertifierResponse` + +NewCertifierResponseWithDefaults instantiates a new CertifierResponse 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 + +### GetId + +`func (o *CertifierResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertifierResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertifierResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CertifierResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *CertifierResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *CertifierResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *CertifierResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *CertifierResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ClientLogConfiguration.md b/docs/tools/sdk/go/Reference/V2024/Models/ClientLogConfiguration.md new file mode 100644 index 000000000..e26f21bea --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ClientLogConfiguration.md @@ -0,0 +1,163 @@ +--- +id: v2024-client-log-configuration +title: ClientLogConfiguration +pagination_label: ClientLogConfiguration +sidebar_label: ClientLogConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClientLogConfiguration', 'V2024ClientLogConfiguration'] +slug: /tools/sdk/go/v2024/models/client-log-configuration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfiguration', 'V2024ClientLogConfiguration'] +--- + +# ClientLogConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **string** | Log configuration's client ID | [optional] +**DurationMinutes** | Pointer to **int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**Expiration** | Pointer to **SailPointTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] +**RootLevel** | [**StandardLevel**](standard-level) | | +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Methods + +### NewClientLogConfiguration + +`func NewClientLogConfiguration(rootLevel StandardLevel, ) *ClientLogConfiguration` + +NewClientLogConfiguration instantiates a new ClientLogConfiguration 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 + +### NewClientLogConfigurationWithDefaults + +`func NewClientLogConfigurationWithDefaults() *ClientLogConfiguration` + +NewClientLogConfigurationWithDefaults instantiates a new ClientLogConfiguration 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 + +### GetClientId + +`func (o *ClientLogConfiguration) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ClientLogConfiguration) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ClientLogConfiguration) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + +### HasClientId + +`func (o *ClientLogConfiguration) HasClientId() bool` + +HasClientId returns a boolean if a field has been set. + +### GetDurationMinutes + +`func (o *ClientLogConfiguration) GetDurationMinutes() int32` + +GetDurationMinutes returns the DurationMinutes field if non-nil, zero value otherwise. + +### GetDurationMinutesOk + +`func (o *ClientLogConfiguration) GetDurationMinutesOk() (*int32, bool)` + +GetDurationMinutesOk returns a tuple with the DurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDurationMinutes + +`func (o *ClientLogConfiguration) SetDurationMinutes(v int32)` + +SetDurationMinutes sets DurationMinutes field to given value. + +### HasDurationMinutes + +`func (o *ClientLogConfiguration) HasDurationMinutes() bool` + +HasDurationMinutes returns a boolean if a field has been set. + +### GetExpiration + +`func (o *ClientLogConfiguration) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *ClientLogConfiguration) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *ClientLogConfiguration) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *ClientLogConfiguration) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + +### GetRootLevel + +`func (o *ClientLogConfiguration) GetRootLevel() StandardLevel` + +GetRootLevel returns the RootLevel field if non-nil, zero value otherwise. + +### GetRootLevelOk + +`func (o *ClientLogConfiguration) GetRootLevelOk() (*StandardLevel, bool)` + +GetRootLevelOk returns a tuple with the RootLevel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootLevel + +`func (o *ClientLogConfiguration) SetRootLevel(v StandardLevel)` + +SetRootLevel sets RootLevel field to given value. + + +### GetLogLevels + +`func (o *ClientLogConfiguration) GetLogLevels() map[string]StandardLevel` + +GetLogLevels returns the LogLevels field if non-nil, zero value otherwise. + +### GetLogLevelsOk + +`func (o *ClientLogConfiguration) GetLogLevelsOk() (*map[string]StandardLevel, bool)` + +GetLogLevelsOk returns a tuple with the LogLevels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogLevels + +`func (o *ClientLogConfiguration) SetLogLevels(v map[string]StandardLevel)` + +SetLogLevels sets LogLevels field to given value. + +### HasLogLevels + +`func (o *ClientLogConfiguration) HasLogLevels() bool` + +HasLogLevels returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ClientLogConfigurationDurationMinutes.md b/docs/tools/sdk/go/Reference/V2024/Models/ClientLogConfigurationDurationMinutes.md new file mode 100644 index 000000000..77d3e01b2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ClientLogConfigurationDurationMinutes.md @@ -0,0 +1,137 @@ +--- +id: v2024-client-log-configuration-duration-minutes +title: ClientLogConfigurationDurationMinutes +pagination_label: ClientLogConfigurationDurationMinutes +sidebar_label: ClientLogConfigurationDurationMinutes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClientLogConfigurationDurationMinutes', 'V2024ClientLogConfigurationDurationMinutes'] +slug: /tools/sdk/go/v2024/models/client-log-configuration-duration-minutes +tags: ['SDK', 'Software Development Kit', 'ClientLogConfigurationDurationMinutes', 'V2024ClientLogConfigurationDurationMinutes'] +--- + +# ClientLogConfigurationDurationMinutes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **string** | Log configuration's client ID | [optional] +**DurationMinutes** | Pointer to **int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**RootLevel** | [**StandardLevel**](standard-level) | | +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Methods + +### NewClientLogConfigurationDurationMinutes + +`func NewClientLogConfigurationDurationMinutes(rootLevel StandardLevel, ) *ClientLogConfigurationDurationMinutes` + +NewClientLogConfigurationDurationMinutes instantiates a new ClientLogConfigurationDurationMinutes 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 + +### NewClientLogConfigurationDurationMinutesWithDefaults + +`func NewClientLogConfigurationDurationMinutesWithDefaults() *ClientLogConfigurationDurationMinutes` + +NewClientLogConfigurationDurationMinutesWithDefaults instantiates a new ClientLogConfigurationDurationMinutes 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 + +### GetClientId + +`func (o *ClientLogConfigurationDurationMinutes) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ClientLogConfigurationDurationMinutes) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ClientLogConfigurationDurationMinutes) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + +### HasClientId + +`func (o *ClientLogConfigurationDurationMinutes) HasClientId() bool` + +HasClientId returns a boolean if a field has been set. + +### GetDurationMinutes + +`func (o *ClientLogConfigurationDurationMinutes) GetDurationMinutes() int32` + +GetDurationMinutes returns the DurationMinutes field if non-nil, zero value otherwise. + +### GetDurationMinutesOk + +`func (o *ClientLogConfigurationDurationMinutes) GetDurationMinutesOk() (*int32, bool)` + +GetDurationMinutesOk returns a tuple with the DurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDurationMinutes + +`func (o *ClientLogConfigurationDurationMinutes) SetDurationMinutes(v int32)` + +SetDurationMinutes sets DurationMinutes field to given value. + +### HasDurationMinutes + +`func (o *ClientLogConfigurationDurationMinutes) HasDurationMinutes() bool` + +HasDurationMinutes returns a boolean if a field has been set. + +### GetRootLevel + +`func (o *ClientLogConfigurationDurationMinutes) GetRootLevel() StandardLevel` + +GetRootLevel returns the RootLevel field if non-nil, zero value otherwise. + +### GetRootLevelOk + +`func (o *ClientLogConfigurationDurationMinutes) GetRootLevelOk() (*StandardLevel, bool)` + +GetRootLevelOk returns a tuple with the RootLevel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootLevel + +`func (o *ClientLogConfigurationDurationMinutes) SetRootLevel(v StandardLevel)` + +SetRootLevel sets RootLevel field to given value. + + +### GetLogLevels + +`func (o *ClientLogConfigurationDurationMinutes) GetLogLevels() map[string]StandardLevel` + +GetLogLevels returns the LogLevels field if non-nil, zero value otherwise. + +### GetLogLevelsOk + +`func (o *ClientLogConfigurationDurationMinutes) GetLogLevelsOk() (*map[string]StandardLevel, bool)` + +GetLogLevelsOk returns a tuple with the LogLevels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogLevels + +`func (o *ClientLogConfigurationDurationMinutes) SetLogLevels(v map[string]StandardLevel)` + +SetLogLevels sets LogLevels field to given value. + +### HasLogLevels + +`func (o *ClientLogConfigurationDurationMinutes) HasLogLevels() bool` + +HasLogLevels returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ClientLogConfigurationExpiration.md b/docs/tools/sdk/go/Reference/V2024/Models/ClientLogConfigurationExpiration.md new file mode 100644 index 000000000..db3f06a5c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ClientLogConfigurationExpiration.md @@ -0,0 +1,137 @@ +--- +id: v2024-client-log-configuration-expiration +title: ClientLogConfigurationExpiration +pagination_label: ClientLogConfigurationExpiration +sidebar_label: ClientLogConfigurationExpiration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClientLogConfigurationExpiration', 'V2024ClientLogConfigurationExpiration'] +slug: /tools/sdk/go/v2024/models/client-log-configuration-expiration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfigurationExpiration', 'V2024ClientLogConfigurationExpiration'] +--- + +# ClientLogConfigurationExpiration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **string** | Log configuration's client ID | [optional] +**Expiration** | Pointer to **SailPointTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] +**RootLevel** | [**StandardLevel**](standard-level) | | +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Methods + +### NewClientLogConfigurationExpiration + +`func NewClientLogConfigurationExpiration(rootLevel StandardLevel, ) *ClientLogConfigurationExpiration` + +NewClientLogConfigurationExpiration instantiates a new ClientLogConfigurationExpiration 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 + +### NewClientLogConfigurationExpirationWithDefaults + +`func NewClientLogConfigurationExpirationWithDefaults() *ClientLogConfigurationExpiration` + +NewClientLogConfigurationExpirationWithDefaults instantiates a new ClientLogConfigurationExpiration 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 + +### GetClientId + +`func (o *ClientLogConfigurationExpiration) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ClientLogConfigurationExpiration) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ClientLogConfigurationExpiration) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + +### HasClientId + +`func (o *ClientLogConfigurationExpiration) HasClientId() bool` + +HasClientId returns a boolean if a field has been set. + +### GetExpiration + +`func (o *ClientLogConfigurationExpiration) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *ClientLogConfigurationExpiration) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *ClientLogConfigurationExpiration) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *ClientLogConfigurationExpiration) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + +### GetRootLevel + +`func (o *ClientLogConfigurationExpiration) GetRootLevel() StandardLevel` + +GetRootLevel returns the RootLevel field if non-nil, zero value otherwise. + +### GetRootLevelOk + +`func (o *ClientLogConfigurationExpiration) GetRootLevelOk() (*StandardLevel, bool)` + +GetRootLevelOk returns a tuple with the RootLevel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootLevel + +`func (o *ClientLogConfigurationExpiration) SetRootLevel(v StandardLevel)` + +SetRootLevel sets RootLevel field to given value. + + +### GetLogLevels + +`func (o *ClientLogConfigurationExpiration) GetLogLevels() map[string]StandardLevel` + +GetLogLevels returns the LogLevels field if non-nil, zero value otherwise. + +### GetLogLevelsOk + +`func (o *ClientLogConfigurationExpiration) GetLogLevelsOk() (*map[string]StandardLevel, bool)` + +GetLogLevelsOk returns a tuple with the LogLevels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogLevels + +`func (o *ClientLogConfigurationExpiration) SetLogLevels(v map[string]StandardLevel)` + +SetLogLevels sets LogLevels field to given value. + +### HasLogLevels + +`func (o *ClientLogConfigurationExpiration) HasLogLevels() bool` + +HasLogLevels returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ClientType.md b/docs/tools/sdk/go/Reference/V2024/Models/ClientType.md new file mode 100644 index 000000000..0224708e9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ClientType.md @@ -0,0 +1,21 @@ +--- +id: v2024-client-type +title: ClientType +pagination_label: ClientType +sidebar_label: ClientType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClientType', 'V2024ClientType'] +slug: /tools/sdk/go/v2024/models/client-type +tags: ['SDK', 'Software Development Kit', 'ClientType', 'V2024ClientType'] +--- + +# ClientType + +## Enum + + +* `CONFIDENTIAL` (value: `"CONFIDENTIAL"`) + +* `PUBLIC` (value: `"PUBLIC"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CloseAccessRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/CloseAccessRequest.md new file mode 100644 index 000000000..1cc847ea6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CloseAccessRequest.md @@ -0,0 +1,137 @@ +--- +id: v2024-close-access-request +title: CloseAccessRequest +pagination_label: CloseAccessRequest +sidebar_label: CloseAccessRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CloseAccessRequest', 'V2024CloseAccessRequest'] +slug: /tools/sdk/go/v2024/models/close-access-request +tags: ['SDK', 'Software Development Kit', 'CloseAccessRequest', 'V2024CloseAccessRequest'] +--- + +# CloseAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestIds** | **[]string** | Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request. | +**Message** | Pointer to **string** | Reason for closing the access request. Displayed under Warnings in IdentityNow. | [optional] [default to "The IdentityNow Administrator manually closed this request."] +**ExecutionStatus** | Pointer to **string** | The request's provisioning status. Displayed as Stage in IdentityNow. | [optional] [default to "Terminated"] +**CompletionStatus** | Pointer to **string** | The request's overall status. Displayed as Status in IdentityNow. | [optional] [default to "Failure"] + +## Methods + +### NewCloseAccessRequest + +`func NewCloseAccessRequest(accessRequestIds []string, ) *CloseAccessRequest` + +NewCloseAccessRequest instantiates a new CloseAccessRequest 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 + +### NewCloseAccessRequestWithDefaults + +`func NewCloseAccessRequestWithDefaults() *CloseAccessRequest` + +NewCloseAccessRequestWithDefaults instantiates a new CloseAccessRequest 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 + +### GetAccessRequestIds + +`func (o *CloseAccessRequest) GetAccessRequestIds() []string` + +GetAccessRequestIds returns the AccessRequestIds field if non-nil, zero value otherwise. + +### GetAccessRequestIdsOk + +`func (o *CloseAccessRequest) GetAccessRequestIdsOk() (*[]string, bool)` + +GetAccessRequestIdsOk returns a tuple with the AccessRequestIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestIds + +`func (o *CloseAccessRequest) SetAccessRequestIds(v []string)` + +SetAccessRequestIds sets AccessRequestIds field to given value. + + +### GetMessage + +`func (o *CloseAccessRequest) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *CloseAccessRequest) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *CloseAccessRequest) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *CloseAccessRequest) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetExecutionStatus + +`func (o *CloseAccessRequest) GetExecutionStatus() string` + +GetExecutionStatus returns the ExecutionStatus field if non-nil, zero value otherwise. + +### GetExecutionStatusOk + +`func (o *CloseAccessRequest) GetExecutionStatusOk() (*string, bool)` + +GetExecutionStatusOk returns a tuple with the ExecutionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExecutionStatus + +`func (o *CloseAccessRequest) SetExecutionStatus(v string)` + +SetExecutionStatus sets ExecutionStatus field to given value. + +### HasExecutionStatus + +`func (o *CloseAccessRequest) HasExecutionStatus() bool` + +HasExecutionStatus returns a boolean if a field has been set. + +### GetCompletionStatus + +`func (o *CloseAccessRequest) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *CloseAccessRequest) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *CloseAccessRequest) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *CloseAccessRequest) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgrade.md b/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgrade.md new file mode 100644 index 000000000..cf62fe84c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgrade.md @@ -0,0 +1,64 @@ +--- +id: v2024-cluster-manual-upgrade +title: ClusterManualUpgrade +pagination_label: ClusterManualUpgrade +sidebar_label: ClusterManualUpgrade +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClusterManualUpgrade', 'V2024ClusterManualUpgrade'] +slug: /tools/sdk/go/v2024/models/cluster-manual-upgrade +tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgrade', 'V2024ClusterManualUpgrade'] +--- + +# ClusterManualUpgrade + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Jobs** | Pointer to [**[]ClusterManualUpgradeJobsInner**](cluster-manual-upgrade-jobs-inner) | List of job objects for the upgrade request. | [optional] + +## Methods + +### NewClusterManualUpgrade + +`func NewClusterManualUpgrade() *ClusterManualUpgrade` + +NewClusterManualUpgrade instantiates a new ClusterManualUpgrade 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 + +### NewClusterManualUpgradeWithDefaults + +`func NewClusterManualUpgradeWithDefaults() *ClusterManualUpgrade` + +NewClusterManualUpgradeWithDefaults instantiates a new ClusterManualUpgrade 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 + +### GetJobs + +`func (o *ClusterManualUpgrade) GetJobs() []ClusterManualUpgradeJobsInner` + +GetJobs returns the Jobs field if non-nil, zero value otherwise. + +### GetJobsOk + +`func (o *ClusterManualUpgrade) GetJobsOk() (*[]ClusterManualUpgradeJobsInner, bool)` + +GetJobsOk returns a tuple with the Jobs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobs + +`func (o *ClusterManualUpgrade) SetJobs(v []ClusterManualUpgradeJobsInner)` + +SetJobs sets Jobs field to given value. + +### HasJobs + +`func (o *ClusterManualUpgrade) HasJobs() bool` + +HasJobs returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInner.md b/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInner.md new file mode 100644 index 000000000..01a98d952 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInner.md @@ -0,0 +1,164 @@ +--- +id: v2024-cluster-manual-upgrade-jobs-inner +title: ClusterManualUpgradeJobsInner +pagination_label: ClusterManualUpgradeJobsInner +sidebar_label: ClusterManualUpgradeJobsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClusterManualUpgradeJobsInner', 'V2024ClusterManualUpgradeJobsInner'] +slug: /tools/sdk/go/v2024/models/cluster-manual-upgrade-jobs-inner +tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInner', 'V2024ClusterManualUpgradeJobsInner'] +--- + +# ClusterManualUpgradeJobsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | **string** | Unique identifier for the upgrade job. | +**Cookbook** | **string** | Identifier for the cookbook used in the upgrade job. | +**State** | **string** | Current state of the upgrade job. | +**Type** | **string** | The type of upgrade job (e.g., VA_UPGRADE). | +**TargetId** | **string** | Unique identifier of the target for the upgrade job. | +**ManagedProcessConfiguration** | [**ClusterManualUpgradeJobsInnerManagedProcessConfiguration**](cluster-manual-upgrade-jobs-inner-managed-process-configuration) | | + +## Methods + +### NewClusterManualUpgradeJobsInner + +`func NewClusterManualUpgradeJobsInner(uuid string, cookbook string, state string, type_ string, targetId string, managedProcessConfiguration ClusterManualUpgradeJobsInnerManagedProcessConfiguration, ) *ClusterManualUpgradeJobsInner` + +NewClusterManualUpgradeJobsInner instantiates a new ClusterManualUpgradeJobsInner 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 + +### NewClusterManualUpgradeJobsInnerWithDefaults + +`func NewClusterManualUpgradeJobsInnerWithDefaults() *ClusterManualUpgradeJobsInner` + +NewClusterManualUpgradeJobsInnerWithDefaults instantiates a new ClusterManualUpgradeJobsInner 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 + +### GetUuid + +`func (o *ClusterManualUpgradeJobsInner) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *ClusterManualUpgradeJobsInner) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *ClusterManualUpgradeJobsInner) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + + +### GetCookbook + +`func (o *ClusterManualUpgradeJobsInner) GetCookbook() string` + +GetCookbook returns the Cookbook field if non-nil, zero value otherwise. + +### GetCookbookOk + +`func (o *ClusterManualUpgradeJobsInner) GetCookbookOk() (*string, bool)` + +GetCookbookOk returns a tuple with the Cookbook field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCookbook + +`func (o *ClusterManualUpgradeJobsInner) SetCookbook(v string)` + +SetCookbook sets Cookbook field to given value. + + +### GetState + +`func (o *ClusterManualUpgradeJobsInner) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ClusterManualUpgradeJobsInner) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ClusterManualUpgradeJobsInner) SetState(v string)` + +SetState sets State field to given value. + + +### GetType + +`func (o *ClusterManualUpgradeJobsInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ClusterManualUpgradeJobsInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ClusterManualUpgradeJobsInner) SetType(v string)` + +SetType sets Type field to given value. + + +### GetTargetId + +`func (o *ClusterManualUpgradeJobsInner) GetTargetId() string` + +GetTargetId returns the TargetId field if non-nil, zero value otherwise. + +### GetTargetIdOk + +`func (o *ClusterManualUpgradeJobsInner) GetTargetIdOk() (*string, bool)` + +GetTargetIdOk returns a tuple with the TargetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetId + +`func (o *ClusterManualUpgradeJobsInner) SetTargetId(v string)` + +SetTargetId sets TargetId field to given value. + + +### GetManagedProcessConfiguration + +`func (o *ClusterManualUpgradeJobsInner) GetManagedProcessConfiguration() ClusterManualUpgradeJobsInnerManagedProcessConfiguration` + +GetManagedProcessConfiguration returns the ManagedProcessConfiguration field if non-nil, zero value otherwise. + +### GetManagedProcessConfigurationOk + +`func (o *ClusterManualUpgradeJobsInner) GetManagedProcessConfigurationOk() (*ClusterManualUpgradeJobsInnerManagedProcessConfiguration, bool)` + +GetManagedProcessConfigurationOk returns a tuple with the ManagedProcessConfiguration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagedProcessConfiguration + +`func (o *ClusterManualUpgradeJobsInner) SetManagedProcessConfiguration(v ClusterManualUpgradeJobsInnerManagedProcessConfiguration)` + +SetManagedProcessConfiguration sets ManagedProcessConfiguration field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfiguration.md b/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfiguration.md new file mode 100644 index 000000000..3864e8cf2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfiguration.md @@ -0,0 +1,168 @@ +--- +id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration +title: ClusterManualUpgradeJobsInnerManagedProcessConfiguration +pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfiguration +sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfiguration', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfiguration'] +slug: /tools/sdk/go/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration +tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfiguration', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfiguration'] +--- + +# ClusterManualUpgradeJobsInnerManagedProcessConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Charon** | Pointer to [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-charon) | | [optional] +**Ccg** | Pointer to [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-ccg) | | [optional] +**OtelAgent** | Pointer to [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-otel-agent) | | [optional] +**Relay** | Pointer to [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-relay) | | [optional] +**Toolbox** | Pointer to [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-toolbox) | | [optional] + +## Methods + +### NewClusterManualUpgradeJobsInnerManagedProcessConfiguration + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfiguration() *ClusterManualUpgradeJobsInnerManagedProcessConfiguration` + +NewClusterManualUpgradeJobsInnerManagedProcessConfiguration instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfiguration 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 + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationWithDefaults + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationWithDefaults() *ClusterManualUpgradeJobsInnerManagedProcessConfiguration` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationWithDefaults instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfiguration 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 + +### GetCharon + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetCharon() ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon` + +GetCharon returns the Charon field if non-nil, zero value otherwise. + +### GetCharonOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetCharonOk() (*ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon, bool)` + +GetCharonOk returns a tuple with the Charon field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCharon + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) SetCharon(v ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon)` + +SetCharon sets Charon field to given value. + +### HasCharon + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) HasCharon() bool` + +HasCharon returns a boolean if a field has been set. + +### GetCcg + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetCcg() ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg` + +GetCcg returns the Ccg field if non-nil, zero value otherwise. + +### GetCcgOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetCcgOk() (*ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg, bool)` + +GetCcgOk returns a tuple with the Ccg field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCcg + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) SetCcg(v ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg)` + +SetCcg sets Ccg field to given value. + +### HasCcg + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) HasCcg() bool` + +HasCcg returns a boolean if a field has been set. + +### GetOtelAgent + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetOtelAgent() ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent` + +GetOtelAgent returns the OtelAgent field if non-nil, zero value otherwise. + +### GetOtelAgentOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetOtelAgentOk() (*ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent, bool)` + +GetOtelAgentOk returns a tuple with the OtelAgent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOtelAgent + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) SetOtelAgent(v ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent)` + +SetOtelAgent sets OtelAgent field to given value. + +### HasOtelAgent + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) HasOtelAgent() bool` + +HasOtelAgent returns a boolean if a field has been set. + +### GetRelay + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetRelay() ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay` + +GetRelay returns the Relay field if non-nil, zero value otherwise. + +### GetRelayOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetRelayOk() (*ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay, bool)` + +GetRelayOk returns a tuple with the Relay field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRelay + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) SetRelay(v ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay)` + +SetRelay sets Relay field to given value. + +### HasRelay + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) HasRelay() bool` + +HasRelay returns a boolean if a field has been set. + +### GetToolbox + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetToolbox() ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox` + +GetToolbox returns the Toolbox field if non-nil, zero value otherwise. + +### GetToolboxOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetToolboxOk() (*ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox, bool)` + +GetToolboxOk returns a tuple with the Toolbox field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetToolbox + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) SetToolbox(v ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox)` + +SetToolbox sets Toolbox field to given value. + +### HasToolbox + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) HasToolbox() bool` + +HasToolbox returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg.md b/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg.md new file mode 100644 index 000000000..71a35aac9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg.md @@ -0,0 +1,143 @@ +--- +id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration-ccg +title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg +pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg +sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg'] +slug: /tools/sdk/go/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-ccg +tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg'] +--- + +# ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | **string** | Version of the 'ccg' process. | +**Path** | **string** | Path to the 'ccg' process. | +**Description** | **string** | A brief description of the 'ccg' process. | +**RestartNeeded** | **bool** | Indicates whether the process needs to be restarted. | +**Dependencies** | **map[string]string** | A map of dependencies for the 'ccg' process. | + +## Methods + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg(version string, path string, description string, restartNeeded bool, dependencies map[string]string, ) *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg 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 + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgWithDefaults + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgWithDefaults() *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgWithDefaults instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg 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 + +### GetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) SetVersion(v string)` + +SetVersion sets Version field to given value. + + +### GetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetRestartNeeded() bool` + +GetRestartNeeded returns the RestartNeeded field if non-nil, zero value otherwise. + +### GetRestartNeededOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetRestartNeededOk() (*bool, bool)` + +GetRestartNeededOk returns a tuple with the RestartNeeded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) SetRestartNeeded(v bool)` + +SetRestartNeeded sets RestartNeeded field to given value. + + +### GetDependencies + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetDependencies() map[string]string` + +GetDependencies returns the Dependencies field if non-nil, zero value otherwise. + +### GetDependenciesOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetDependenciesOk() (*map[string]string, bool)` + +GetDependenciesOk returns a tuple with the Dependencies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDependencies + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) SetDependencies(v map[string]string)` + +SetDependencies sets Dependencies field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon.md b/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon.md new file mode 100644 index 000000000..5926dcbed --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon.md @@ -0,0 +1,122 @@ +--- +id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration-charon +title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon +pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon +sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon'] +slug: /tools/sdk/go/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-charon +tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon'] +--- + +# ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | **string** | Version of the 'charon' process. | +**Path** | **string** | Path to the 'charon' process. | +**Description** | **string** | A brief description of the 'charon' process. | +**RestartNeeded** | **bool** | Indicates whether the process needs to be restarted. | + +## Methods + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon(version string, path string, description string, restartNeeded bool, ) *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon 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 + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonWithDefaults + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonWithDefaults() *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonWithDefaults instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon 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 + +### GetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) SetVersion(v string)` + +SetVersion sets Version field to given value. + + +### GetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) GetRestartNeeded() bool` + +GetRestartNeeded returns the RestartNeeded field if non-nil, zero value otherwise. + +### GetRestartNeededOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) GetRestartNeededOk() (*bool, bool)` + +GetRestartNeededOk returns a tuple with the RestartNeeded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) SetRestartNeeded(v bool)` + +SetRestartNeeded sets RestartNeeded field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent.md b/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent.md new file mode 100644 index 000000000..745f93eb3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent.md @@ -0,0 +1,122 @@ +--- +id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration-otel-agent +title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent +pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent +sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent'] +slug: /tools/sdk/go/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-otel-agent +tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent'] +--- + +# ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | **string** | Version of the 'otel_agent' process. | +**Path** | **string** | Path to the 'otel_agent' process. | +**Description** | **string** | A brief description of the 'otel_agent' process. | +**RestartNeeded** | **bool** | Indicates whether the process needs to be restarted. | + +## Methods + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent(version string, path string, description string, restartNeeded bool, ) *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent 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 + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentWithDefaults + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentWithDefaults() *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentWithDefaults instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent 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 + +### GetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) SetVersion(v string)` + +SetVersion sets Version field to given value. + + +### GetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) GetRestartNeeded() bool` + +GetRestartNeeded returns the RestartNeeded field if non-nil, zero value otherwise. + +### GetRestartNeededOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) GetRestartNeededOk() (*bool, bool)` + +GetRestartNeededOk returns a tuple with the RestartNeeded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) SetRestartNeeded(v bool)` + +SetRestartNeeded sets RestartNeeded field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay.md b/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay.md new file mode 100644 index 000000000..a3dbe7c3c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay.md @@ -0,0 +1,122 @@ +--- +id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration-relay +title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay +pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay +sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay'] +slug: /tools/sdk/go/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-relay +tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay'] +--- + +# ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | **string** | Version of the 'relay' process. | +**Path** | **string** | Path to the 'relay' process. | +**Description** | **string** | A brief description of the 'relay' process. | +**RestartNeeded** | **bool** | Indicates whether the process needs to be restarted. | + +## Methods + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay(version string, path string, description string, restartNeeded bool, ) *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay 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 + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayWithDefaults + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayWithDefaults() *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayWithDefaults instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay 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 + +### GetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) SetVersion(v string)` + +SetVersion sets Version field to given value. + + +### GetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) GetRestartNeeded() bool` + +GetRestartNeeded returns the RestartNeeded field if non-nil, zero value otherwise. + +### GetRestartNeededOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) GetRestartNeededOk() (*bool, bool)` + +GetRestartNeededOk returns a tuple with the RestartNeeded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) SetRestartNeeded(v bool)` + +SetRestartNeeded sets RestartNeeded field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox.md b/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox.md new file mode 100644 index 000000000..3528fbf12 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox.md @@ -0,0 +1,122 @@ +--- +id: v2024-cluster-manual-upgrade-jobs-inner-managed-process-configuration-toolbox +title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox +pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox +sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox'] +slug: /tools/sdk/go/v2024/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-toolbox +tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox', 'V2024ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox'] +--- + +# ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | **string** | Version of the 'toolbox' process. | +**Path** | **string** | Path to the 'toolbox' process. | +**Description** | **string** | A brief description of the 'toolbox' process. | +**RestartNeeded** | **bool** | Indicates whether the process needs to be restarted. | + +## Methods + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox(version string, path string, description string, restartNeeded bool, ) *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox 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 + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxWithDefaults + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxWithDefaults() *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxWithDefaults instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox 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 + +### GetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) SetVersion(v string)` + +SetVersion sets Version field to given value. + + +### GetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) GetRestartNeeded() bool` + +GetRestartNeeded returns the RestartNeeded field if non-nil, zero value otherwise. + +### GetRestartNeededOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) GetRestartNeededOk() (*bool, bool)` + +GetRestartNeededOk returns a tuple with the RestartNeeded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) SetRestartNeeded(v bool)` + +SetRestartNeeded sets RestartNeeded field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Column.md b/docs/tools/sdk/go/Reference/V2024/Models/Column.md new file mode 100644 index 000000000..4a2df77fc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Column.md @@ -0,0 +1,85 @@ +--- +id: v2024-column +title: Column +pagination_label: Column +sidebar_label: Column +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Column', 'V2024Column'] +slug: /tools/sdk/go/v2024/models/column +tags: ['SDK', 'Software Development Kit', 'Column', 'V2024Column'] +--- + +# Column + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Field** | **string** | The name of the field. | +**Header** | Pointer to **string** | The value of the header. | [optional] + +## Methods + +### NewColumn + +`func NewColumn(field string, ) *Column` + +NewColumn instantiates a new Column 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 + +### NewColumnWithDefaults + +`func NewColumnWithDefaults() *Column` + +NewColumnWithDefaults instantiates a new Column 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 + +### GetField + +`func (o *Column) GetField() string` + +GetField returns the Field field if non-nil, zero value otherwise. + +### GetFieldOk + +`func (o *Column) GetFieldOk() (*string, bool)` + +GetFieldOk returns a tuple with the Field field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetField + +`func (o *Column) SetField(v string)` + +SetField sets Field field to given value. + + +### GetHeader + +`func (o *Column) GetHeader() string` + +GetHeader returns the Header field if non-nil, zero value otherwise. + +### GetHeaderOk + +`func (o *Column) GetHeaderOk() (*string, bool)` + +GetHeaderOk returns a tuple with the Header field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHeader + +`func (o *Column) SetHeader(v string)` + +SetHeader sets Header field to given value. + +### HasHeader + +`func (o *Column) HasHeader() bool` + +HasHeader returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Comment.md b/docs/tools/sdk/go/Reference/V2024/Models/Comment.md new file mode 100644 index 000000000..4547e6dff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Comment.md @@ -0,0 +1,142 @@ +--- +id: v2024-comment +title: Comment +pagination_label: Comment +sidebar_label: Comment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Comment', 'V2024Comment'] +slug: /tools/sdk/go/v2024/models/comment +tags: ['SDK', 'Software Development Kit', 'Comment', 'V2024Comment'] +--- + +# Comment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommenterId** | Pointer to **string** | Id of the identity making the comment | [optional] +**CommenterName** | Pointer to **string** | Human-readable display name of the identity making the comment | [optional] +**Body** | Pointer to **string** | Content of the comment | [optional] +**Date** | Pointer to **SailPointTime** | Date and time comment was made | [optional] + +## Methods + +### NewComment + +`func NewComment() *Comment` + +NewComment instantiates a new Comment 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 + +### NewCommentWithDefaults + +`func NewCommentWithDefaults() *Comment` + +NewCommentWithDefaults instantiates a new Comment 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 + +### GetCommenterId + +`func (o *Comment) GetCommenterId() string` + +GetCommenterId returns the CommenterId field if non-nil, zero value otherwise. + +### GetCommenterIdOk + +`func (o *Comment) GetCommenterIdOk() (*string, bool)` + +GetCommenterIdOk returns a tuple with the CommenterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommenterId + +`func (o *Comment) SetCommenterId(v string)` + +SetCommenterId sets CommenterId field to given value. + +### HasCommenterId + +`func (o *Comment) HasCommenterId() bool` + +HasCommenterId returns a boolean if a field has been set. + +### GetCommenterName + +`func (o *Comment) GetCommenterName() string` + +GetCommenterName returns the CommenterName field if non-nil, zero value otherwise. + +### GetCommenterNameOk + +`func (o *Comment) GetCommenterNameOk() (*string, bool)` + +GetCommenterNameOk returns a tuple with the CommenterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommenterName + +`func (o *Comment) SetCommenterName(v string)` + +SetCommenterName sets CommenterName field to given value. + +### HasCommenterName + +`func (o *Comment) HasCommenterName() bool` + +HasCommenterName returns a boolean if a field has been set. + +### GetBody + +`func (o *Comment) GetBody() string` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *Comment) GetBodyOk() (*string, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBody + +`func (o *Comment) SetBody(v string)` + +SetBody sets Body field to given value. + +### HasBody + +`func (o *Comment) HasBody() bool` + +HasBody returns a boolean if a field has been set. + +### GetDate + +`func (o *Comment) GetDate() SailPointTime` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *Comment) GetDateOk() (*SailPointTime, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *Comment) SetDate(v SailPointTime)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *Comment) HasDate() bool` + +HasDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CommentDto.md b/docs/tools/sdk/go/Reference/V2024/Models/CommentDto.md new file mode 100644 index 000000000..c39869059 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CommentDto.md @@ -0,0 +1,126 @@ +--- +id: v2024-comment-dto +title: CommentDto +pagination_label: CommentDto +sidebar_label: CommentDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommentDto', 'V2024CommentDto'] +slug: /tools/sdk/go/v2024/models/comment-dto +tags: ['SDK', 'Software Development Kit', 'CommentDto', 'V2024CommentDto'] +--- + +# CommentDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **NullableString** | Comment content. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Methods + +### NewCommentDto + +`func NewCommentDto() *CommentDto` + +NewCommentDto instantiates a new CommentDto 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 + +### NewCommentDtoWithDefaults + +`func NewCommentDtoWithDefaults() *CommentDto` + +NewCommentDtoWithDefaults instantiates a new CommentDto 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 + +### GetComment + +`func (o *CommentDto) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CommentDto) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CommentDto) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CommentDto) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *CommentDto) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *CommentDto) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetCreated + +`func (o *CommentDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CommentDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CommentDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CommentDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetAuthor + +`func (o *CommentDto) GetAuthor() CommentDtoAuthor` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *CommentDto) GetAuthorOk() (*CommentDtoAuthor, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *CommentDto) SetAuthor(v CommentDtoAuthor)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *CommentDto) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CommentDtoAuthor.md b/docs/tools/sdk/go/Reference/V2024/Models/CommentDtoAuthor.md new file mode 100644 index 000000000..435e5ded8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CommentDtoAuthor.md @@ -0,0 +1,116 @@ +--- +id: v2024-comment-dto-author +title: CommentDtoAuthor +pagination_label: CommentDtoAuthor +sidebar_label: CommentDtoAuthor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommentDtoAuthor', 'V2024CommentDtoAuthor'] +slug: /tools/sdk/go/v2024/models/comment-dto-author +tags: ['SDK', 'Software Development Kit', 'CommentDtoAuthor', 'V2024CommentDtoAuthor'] +--- + +# CommentDtoAuthor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of object | [optional] +**Id** | Pointer to **string** | The unique ID of the object | [optional] +**Name** | Pointer to **string** | The display name of the object | [optional] + +## Methods + +### NewCommentDtoAuthor + +`func NewCommentDtoAuthor() *CommentDtoAuthor` + +NewCommentDtoAuthor instantiates a new CommentDtoAuthor 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 + +### NewCommentDtoAuthorWithDefaults + +`func NewCommentDtoAuthorWithDefaults() *CommentDtoAuthor` + +NewCommentDtoAuthorWithDefaults instantiates a new CommentDtoAuthor 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 + +### GetType + +`func (o *CommentDtoAuthor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CommentDtoAuthor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CommentDtoAuthor) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CommentDtoAuthor) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CommentDtoAuthor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CommentDtoAuthor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CommentDtoAuthor) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CommentDtoAuthor) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CommentDtoAuthor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CommentDtoAuthor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CommentDtoAuthor) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CommentDtoAuthor) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessIDStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessIDStatus.md new file mode 100644 index 000000000..097dea291 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessIDStatus.md @@ -0,0 +1,90 @@ +--- +id: v2024-common-access-id-status +title: CommonAccessIDStatus +pagination_label: CommonAccessIDStatus +sidebar_label: CommonAccessIDStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessIDStatus', 'V2024CommonAccessIDStatus'] +slug: /tools/sdk/go/v2024/models/common-access-id-status +tags: ['SDK', 'Software Development Kit', 'CommonAccessIDStatus', 'V2024CommonAccessIDStatus'] +--- + +# CommonAccessIDStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConfirmedIds** | Pointer to **[]string** | List of confirmed common access ids. | [optional] +**DeniedIds** | Pointer to **[]string** | List of denied common access ids. | [optional] + +## Methods + +### NewCommonAccessIDStatus + +`func NewCommonAccessIDStatus() *CommonAccessIDStatus` + +NewCommonAccessIDStatus instantiates a new CommonAccessIDStatus 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 + +### NewCommonAccessIDStatusWithDefaults + +`func NewCommonAccessIDStatusWithDefaults() *CommonAccessIDStatus` + +NewCommonAccessIDStatusWithDefaults instantiates a new CommonAccessIDStatus 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 + +### GetConfirmedIds + +`func (o *CommonAccessIDStatus) GetConfirmedIds() []string` + +GetConfirmedIds returns the ConfirmedIds field if non-nil, zero value otherwise. + +### GetConfirmedIdsOk + +`func (o *CommonAccessIDStatus) GetConfirmedIdsOk() (*[]string, bool)` + +GetConfirmedIdsOk returns a tuple with the ConfirmedIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfirmedIds + +`func (o *CommonAccessIDStatus) SetConfirmedIds(v []string)` + +SetConfirmedIds sets ConfirmedIds field to given value. + +### HasConfirmedIds + +`func (o *CommonAccessIDStatus) HasConfirmedIds() bool` + +HasConfirmedIds returns a boolean if a field has been set. + +### GetDeniedIds + +`func (o *CommonAccessIDStatus) GetDeniedIds() []string` + +GetDeniedIds returns the DeniedIds field if non-nil, zero value otherwise. + +### GetDeniedIdsOk + +`func (o *CommonAccessIDStatus) GetDeniedIdsOk() (*[]string, bool)` + +GetDeniedIdsOk returns a tuple with the DeniedIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeniedIds + +`func (o *CommonAccessIDStatus) SetDeniedIds(v []string)` + +SetDeniedIds sets DeniedIds field to given value. + +### HasDeniedIds + +`func (o *CommonAccessIDStatus) HasDeniedIds() bool` + +HasDeniedIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessItemAccess.md b/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessItemAccess.md new file mode 100644 index 000000000..c59f3317a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessItemAccess.md @@ -0,0 +1,204 @@ +--- +id: v2024-common-access-item-access +title: CommonAccessItemAccess +pagination_label: CommonAccessItemAccess +sidebar_label: CommonAccessItemAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessItemAccess', 'V2024CommonAccessItemAccess'] +slug: /tools/sdk/go/v2024/models/common-access-item-access +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemAccess', 'V2024CommonAccessItemAccess'] +--- + +# CommonAccessItemAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Common access ID | [optional] +**Type** | Pointer to [**CommonAccessType**](common-access-type) | | [optional] +**Name** | Pointer to **string** | Common access name | [optional] +**Description** | Pointer to **NullableString** | Common access description | [optional] +**OwnerName** | Pointer to **string** | Common access owner name | [optional] +**OwnerId** | Pointer to **string** | Common access owner ID | [optional] + +## Methods + +### NewCommonAccessItemAccess + +`func NewCommonAccessItemAccess() *CommonAccessItemAccess` + +NewCommonAccessItemAccess instantiates a new CommonAccessItemAccess 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 + +### NewCommonAccessItemAccessWithDefaults + +`func NewCommonAccessItemAccessWithDefaults() *CommonAccessItemAccess` + +NewCommonAccessItemAccessWithDefaults instantiates a new CommonAccessItemAccess 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 + +### GetId + +`func (o *CommonAccessItemAccess) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CommonAccessItemAccess) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CommonAccessItemAccess) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CommonAccessItemAccess) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CommonAccessItemAccess) GetType() CommonAccessType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CommonAccessItemAccess) GetTypeOk() (*CommonAccessType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CommonAccessItemAccess) SetType(v CommonAccessType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CommonAccessItemAccess) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *CommonAccessItemAccess) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CommonAccessItemAccess) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CommonAccessItemAccess) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CommonAccessItemAccess) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *CommonAccessItemAccess) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CommonAccessItemAccess) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CommonAccessItemAccess) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CommonAccessItemAccess) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *CommonAccessItemAccess) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CommonAccessItemAccess) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwnerName + +`func (o *CommonAccessItemAccess) GetOwnerName() string` + +GetOwnerName returns the OwnerName field if non-nil, zero value otherwise. + +### GetOwnerNameOk + +`func (o *CommonAccessItemAccess) GetOwnerNameOk() (*string, bool)` + +GetOwnerNameOk returns a tuple with the OwnerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerName + +`func (o *CommonAccessItemAccess) SetOwnerName(v string)` + +SetOwnerName sets OwnerName field to given value. + +### HasOwnerName + +`func (o *CommonAccessItemAccess) HasOwnerName() bool` + +HasOwnerName returns a boolean if a field has been set. + +### GetOwnerId + +`func (o *CommonAccessItemAccess) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *CommonAccessItemAccess) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *CommonAccessItemAccess) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *CommonAccessItemAccess) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessItemRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessItemRequest.md new file mode 100644 index 000000000..18e9962ea --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessItemRequest.md @@ -0,0 +1,90 @@ +--- +id: v2024-common-access-item-request +title: CommonAccessItemRequest +pagination_label: CommonAccessItemRequest +sidebar_label: CommonAccessItemRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessItemRequest', 'V2024CommonAccessItemRequest'] +slug: /tools/sdk/go/v2024/models/common-access-item-request +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemRequest', 'V2024CommonAccessItemRequest'] +--- + +# CommonAccessItemRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**Status** | Pointer to [**CommonAccessItemState**](common-access-item-state) | | [optional] + +## Methods + +### NewCommonAccessItemRequest + +`func NewCommonAccessItemRequest() *CommonAccessItemRequest` + +NewCommonAccessItemRequest instantiates a new CommonAccessItemRequest 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 + +### NewCommonAccessItemRequestWithDefaults + +`func NewCommonAccessItemRequestWithDefaults() *CommonAccessItemRequest` + +NewCommonAccessItemRequestWithDefaults instantiates a new CommonAccessItemRequest 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 + +### GetAccess + +`func (o *CommonAccessItemRequest) GetAccess() CommonAccessItemAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *CommonAccessItemRequest) GetAccessOk() (*CommonAccessItemAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *CommonAccessItemRequest) SetAccess(v CommonAccessItemAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *CommonAccessItemRequest) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetStatus + +`func (o *CommonAccessItemRequest) GetStatus() CommonAccessItemState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CommonAccessItemRequest) GetStatusOk() (*CommonAccessItemState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CommonAccessItemRequest) SetStatus(v CommonAccessItemState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CommonAccessItemRequest) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessItemResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessItemResponse.md new file mode 100644 index 000000000..31f4b3a6e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessItemResponse.md @@ -0,0 +1,220 @@ +--- +id: v2024-common-access-item-response +title: CommonAccessItemResponse +pagination_label: CommonAccessItemResponse +sidebar_label: CommonAccessItemResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessItemResponse', 'V2024CommonAccessItemResponse'] +slug: /tools/sdk/go/v2024/models/common-access-item-response +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemResponse', 'V2024CommonAccessItemResponse'] +--- + +# CommonAccessItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Common Access Item ID | [optional] +**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**Status** | Pointer to [**CommonAccessItemState**](common-access-item-state) | | [optional] +**LastUpdated** | Pointer to **string** | | [optional] +**ReviewedByUser** | Pointer to **bool** | | [optional] +**LastReviewed** | Pointer to **string** | | [optional] +**CreatedByUser** | Pointer to **string** | | [optional] + +## Methods + +### NewCommonAccessItemResponse + +`func NewCommonAccessItemResponse() *CommonAccessItemResponse` + +NewCommonAccessItemResponse instantiates a new CommonAccessItemResponse 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 + +### NewCommonAccessItemResponseWithDefaults + +`func NewCommonAccessItemResponseWithDefaults() *CommonAccessItemResponse` + +NewCommonAccessItemResponseWithDefaults instantiates a new CommonAccessItemResponse 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 + +### GetId + +`func (o *CommonAccessItemResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CommonAccessItemResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CommonAccessItemResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CommonAccessItemResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccess + +`func (o *CommonAccessItemResponse) GetAccess() CommonAccessItemAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *CommonAccessItemResponse) GetAccessOk() (*CommonAccessItemAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *CommonAccessItemResponse) SetAccess(v CommonAccessItemAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *CommonAccessItemResponse) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetStatus + +`func (o *CommonAccessItemResponse) GetStatus() CommonAccessItemState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CommonAccessItemResponse) GetStatusOk() (*CommonAccessItemState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CommonAccessItemResponse) SetStatus(v CommonAccessItemState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CommonAccessItemResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetLastUpdated + +`func (o *CommonAccessItemResponse) GetLastUpdated() string` + +GetLastUpdated returns the LastUpdated field if non-nil, zero value otherwise. + +### GetLastUpdatedOk + +`func (o *CommonAccessItemResponse) GetLastUpdatedOk() (*string, bool)` + +GetLastUpdatedOk returns a tuple with the LastUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdated + +`func (o *CommonAccessItemResponse) SetLastUpdated(v string)` + +SetLastUpdated sets LastUpdated field to given value. + +### HasLastUpdated + +`func (o *CommonAccessItemResponse) HasLastUpdated() bool` + +HasLastUpdated returns a boolean if a field has been set. + +### GetReviewedByUser + +`func (o *CommonAccessItemResponse) GetReviewedByUser() bool` + +GetReviewedByUser returns the ReviewedByUser field if non-nil, zero value otherwise. + +### GetReviewedByUserOk + +`func (o *CommonAccessItemResponse) GetReviewedByUserOk() (*bool, bool)` + +GetReviewedByUserOk returns a tuple with the ReviewedByUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewedByUser + +`func (o *CommonAccessItemResponse) SetReviewedByUser(v bool)` + +SetReviewedByUser sets ReviewedByUser field to given value. + +### HasReviewedByUser + +`func (o *CommonAccessItemResponse) HasReviewedByUser() bool` + +HasReviewedByUser returns a boolean if a field has been set. + +### GetLastReviewed + +`func (o *CommonAccessItemResponse) GetLastReviewed() string` + +GetLastReviewed returns the LastReviewed field if non-nil, zero value otherwise. + +### GetLastReviewedOk + +`func (o *CommonAccessItemResponse) GetLastReviewedOk() (*string, bool)` + +GetLastReviewedOk returns a tuple with the LastReviewed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastReviewed + +`func (o *CommonAccessItemResponse) SetLastReviewed(v string)` + +SetLastReviewed sets LastReviewed field to given value. + +### HasLastReviewed + +`func (o *CommonAccessItemResponse) HasLastReviewed() bool` + +HasLastReviewed returns a boolean if a field has been set. + +### GetCreatedByUser + +`func (o *CommonAccessItemResponse) GetCreatedByUser() string` + +GetCreatedByUser returns the CreatedByUser field if non-nil, zero value otherwise. + +### GetCreatedByUserOk + +`func (o *CommonAccessItemResponse) GetCreatedByUserOk() (*string, bool)` + +GetCreatedByUserOk returns a tuple with the CreatedByUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedByUser + +`func (o *CommonAccessItemResponse) SetCreatedByUser(v string)` + +SetCreatedByUser sets CreatedByUser field to given value. + +### HasCreatedByUser + +`func (o *CommonAccessItemResponse) HasCreatedByUser() bool` + +HasCreatedByUser returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessItemState.md b/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessItemState.md new file mode 100644 index 000000000..d389cbb2b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessItemState.md @@ -0,0 +1,21 @@ +--- +id: v2024-common-access-item-state +title: CommonAccessItemState +pagination_label: CommonAccessItemState +sidebar_label: CommonAccessItemState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessItemState', 'V2024CommonAccessItemState'] +slug: /tools/sdk/go/v2024/models/common-access-item-state +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemState', 'V2024CommonAccessItemState'] +--- + +# CommonAccessItemState + +## Enum + + +* `CONFIRMED` (value: `"CONFIRMED"`) + +* `DENIED` (value: `"DENIED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessResponse.md new file mode 100644 index 000000000..4d4cd48ea --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessResponse.md @@ -0,0 +1,256 @@ +--- +id: v2024-common-access-response +title: CommonAccessResponse +pagination_label: CommonAccessResponse +sidebar_label: CommonAccessResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessResponse', 'V2024CommonAccessResponse'] +slug: /tools/sdk/go/v2024/models/common-access-response +tags: ['SDK', 'Software Development Kit', 'CommonAccessResponse', 'V2024CommonAccessResponse'] +--- + +# CommonAccessResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique ID of the common access item | [optional] +**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**Status** | Pointer to **string** | CONFIRMED or DENIED | [optional] +**CommonAccessType** | Pointer to **string** | | [optional] +**LastUpdated** | Pointer to **SailPointTime** | | [optional] [readonly] +**ReviewedByUser** | Pointer to **bool** | true if user has confirmed or denied status | [optional] +**LastReviewed** | Pointer to **NullableTime** | | [optional] [readonly] +**CreatedByUser** | Pointer to **bool** | | [optional] [default to false] + +## Methods + +### NewCommonAccessResponse + +`func NewCommonAccessResponse() *CommonAccessResponse` + +NewCommonAccessResponse instantiates a new CommonAccessResponse 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 + +### NewCommonAccessResponseWithDefaults + +`func NewCommonAccessResponseWithDefaults() *CommonAccessResponse` + +NewCommonAccessResponseWithDefaults instantiates a new CommonAccessResponse 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 + +### GetId + +`func (o *CommonAccessResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CommonAccessResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CommonAccessResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CommonAccessResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccess + +`func (o *CommonAccessResponse) GetAccess() CommonAccessItemAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *CommonAccessResponse) GetAccessOk() (*CommonAccessItemAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *CommonAccessResponse) SetAccess(v CommonAccessItemAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *CommonAccessResponse) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetStatus + +`func (o *CommonAccessResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CommonAccessResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CommonAccessResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CommonAccessResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetCommonAccessType + +`func (o *CommonAccessResponse) GetCommonAccessType() string` + +GetCommonAccessType returns the CommonAccessType field if non-nil, zero value otherwise. + +### GetCommonAccessTypeOk + +`func (o *CommonAccessResponse) GetCommonAccessTypeOk() (*string, bool)` + +GetCommonAccessTypeOk returns a tuple with the CommonAccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommonAccessType + +`func (o *CommonAccessResponse) SetCommonAccessType(v string)` + +SetCommonAccessType sets CommonAccessType field to given value. + +### HasCommonAccessType + +`func (o *CommonAccessResponse) HasCommonAccessType() bool` + +HasCommonAccessType returns a boolean if a field has been set. + +### GetLastUpdated + +`func (o *CommonAccessResponse) GetLastUpdated() SailPointTime` + +GetLastUpdated returns the LastUpdated field if non-nil, zero value otherwise. + +### GetLastUpdatedOk + +`func (o *CommonAccessResponse) GetLastUpdatedOk() (*SailPointTime, bool)` + +GetLastUpdatedOk returns a tuple with the LastUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdated + +`func (o *CommonAccessResponse) SetLastUpdated(v SailPointTime)` + +SetLastUpdated sets LastUpdated field to given value. + +### HasLastUpdated + +`func (o *CommonAccessResponse) HasLastUpdated() bool` + +HasLastUpdated returns a boolean if a field has been set. + +### GetReviewedByUser + +`func (o *CommonAccessResponse) GetReviewedByUser() bool` + +GetReviewedByUser returns the ReviewedByUser field if non-nil, zero value otherwise. + +### GetReviewedByUserOk + +`func (o *CommonAccessResponse) GetReviewedByUserOk() (*bool, bool)` + +GetReviewedByUserOk returns a tuple with the ReviewedByUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewedByUser + +`func (o *CommonAccessResponse) SetReviewedByUser(v bool)` + +SetReviewedByUser sets ReviewedByUser field to given value. + +### HasReviewedByUser + +`func (o *CommonAccessResponse) HasReviewedByUser() bool` + +HasReviewedByUser returns a boolean if a field has been set. + +### GetLastReviewed + +`func (o *CommonAccessResponse) GetLastReviewed() SailPointTime` + +GetLastReviewed returns the LastReviewed field if non-nil, zero value otherwise. + +### GetLastReviewedOk + +`func (o *CommonAccessResponse) GetLastReviewedOk() (*SailPointTime, bool)` + +GetLastReviewedOk returns a tuple with the LastReviewed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastReviewed + +`func (o *CommonAccessResponse) SetLastReviewed(v SailPointTime)` + +SetLastReviewed sets LastReviewed field to given value. + +### HasLastReviewed + +`func (o *CommonAccessResponse) HasLastReviewed() bool` + +HasLastReviewed returns a boolean if a field has been set. + +### SetLastReviewedNil + +`func (o *CommonAccessResponse) SetLastReviewedNil(b bool)` + + SetLastReviewedNil sets the value for LastReviewed to be an explicit nil + +### UnsetLastReviewed +`func (o *CommonAccessResponse) UnsetLastReviewed()` + +UnsetLastReviewed ensures that no value is present for LastReviewed, not even an explicit nil +### GetCreatedByUser + +`func (o *CommonAccessResponse) GetCreatedByUser() bool` + +GetCreatedByUser returns the CreatedByUser field if non-nil, zero value otherwise. + +### GetCreatedByUserOk + +`func (o *CommonAccessResponse) GetCreatedByUserOk() (*bool, bool)` + +GetCreatedByUserOk returns a tuple with the CreatedByUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedByUser + +`func (o *CommonAccessResponse) SetCreatedByUser(v bool)` + +SetCreatedByUser sets CreatedByUser field to given value. + +### HasCreatedByUser + +`func (o *CommonAccessResponse) HasCreatedByUser() bool` + +HasCreatedByUser returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessType.md b/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessType.md new file mode 100644 index 000000000..4dd657032 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CommonAccessType.md @@ -0,0 +1,21 @@ +--- +id: v2024-common-access-type +title: CommonAccessType +pagination_label: CommonAccessType +sidebar_label: CommonAccessType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessType', 'V2024CommonAccessType'] +slug: /tools/sdk/go/v2024/models/common-access-type +tags: ['SDK', 'Software Development Kit', 'CommonAccessType', 'V2024CommonAccessType'] +--- + +# CommonAccessType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CompleteInvocation.md b/docs/tools/sdk/go/Reference/V2024/Models/CompleteInvocation.md new file mode 100644 index 000000000..aa6841072 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CompleteInvocation.md @@ -0,0 +1,106 @@ +--- +id: v2024-complete-invocation +title: CompleteInvocation +pagination_label: CompleteInvocation +sidebar_label: CompleteInvocation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompleteInvocation', 'V2024CompleteInvocation'] +slug: /tools/sdk/go/v2024/models/complete-invocation +tags: ['SDK', 'Software Development Kit', 'CompleteInvocation', 'V2024CompleteInvocation'] +--- + +# CompleteInvocation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Secret** | **string** | Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint. | +**Error** | Pointer to **string** | The error message to indicate a failed invocation or error if any. | [optional] +**Output** | **map[string]interface{}** | Trigger output to complete the invocation. Its schema is defined in the trigger definition. | + +## Methods + +### NewCompleteInvocation + +`func NewCompleteInvocation(secret string, output map[string]interface{}, ) *CompleteInvocation` + +NewCompleteInvocation instantiates a new CompleteInvocation 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 + +### NewCompleteInvocationWithDefaults + +`func NewCompleteInvocationWithDefaults() *CompleteInvocation` + +NewCompleteInvocationWithDefaults instantiates a new CompleteInvocation 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 + +### GetSecret + +`func (o *CompleteInvocation) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *CompleteInvocation) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *CompleteInvocation) SetSecret(v string)` + +SetSecret sets Secret field to given value. + + +### GetError + +`func (o *CompleteInvocation) GetError() string` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *CompleteInvocation) GetErrorOk() (*string, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *CompleteInvocation) SetError(v string)` + +SetError sets Error field to given value. + +### HasError + +`func (o *CompleteInvocation) HasError() bool` + +HasError returns a boolean if a field has been set. + +### GetOutput + +`func (o *CompleteInvocation) GetOutput() map[string]interface{}` + +GetOutput returns the Output field if non-nil, zero value otherwise. + +### GetOutputOk + +`func (o *CompleteInvocation) GetOutputOk() (*map[string]interface{}, bool)` + +GetOutputOk returns a tuple with the Output field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutput + +`func (o *CompleteInvocation) SetOutput(v map[string]interface{})` + +SetOutput sets Output field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CompleteInvocationInput.md b/docs/tools/sdk/go/Reference/V2024/Models/CompleteInvocationInput.md new file mode 100644 index 000000000..ba90d2259 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CompleteInvocationInput.md @@ -0,0 +1,110 @@ +--- +id: v2024-complete-invocation-input +title: CompleteInvocationInput +pagination_label: CompleteInvocationInput +sidebar_label: CompleteInvocationInput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompleteInvocationInput', 'V2024CompleteInvocationInput'] +slug: /tools/sdk/go/v2024/models/complete-invocation-input +tags: ['SDK', 'Software Development Kit', 'CompleteInvocationInput', 'V2024CompleteInvocationInput'] +--- + +# CompleteInvocationInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LocalizedError** | Pointer to [**NullableLocalizedMessage**](localized-message) | | [optional] +**Output** | Pointer to **map[string]interface{}** | Trigger output that completed the invocation. Its schema is defined in the trigger definition. | [optional] + +## Methods + +### NewCompleteInvocationInput + +`func NewCompleteInvocationInput() *CompleteInvocationInput` + +NewCompleteInvocationInput instantiates a new CompleteInvocationInput 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 + +### NewCompleteInvocationInputWithDefaults + +`func NewCompleteInvocationInputWithDefaults() *CompleteInvocationInput` + +NewCompleteInvocationInputWithDefaults instantiates a new CompleteInvocationInput 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 + +### GetLocalizedError + +`func (o *CompleteInvocationInput) GetLocalizedError() LocalizedMessage` + +GetLocalizedError returns the LocalizedError field if non-nil, zero value otherwise. + +### GetLocalizedErrorOk + +`func (o *CompleteInvocationInput) GetLocalizedErrorOk() (*LocalizedMessage, bool)` + +GetLocalizedErrorOk returns a tuple with the LocalizedError field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizedError + +`func (o *CompleteInvocationInput) SetLocalizedError(v LocalizedMessage)` + +SetLocalizedError sets LocalizedError field to given value. + +### HasLocalizedError + +`func (o *CompleteInvocationInput) HasLocalizedError() bool` + +HasLocalizedError returns a boolean if a field has been set. + +### SetLocalizedErrorNil + +`func (o *CompleteInvocationInput) SetLocalizedErrorNil(b bool)` + + SetLocalizedErrorNil sets the value for LocalizedError to be an explicit nil + +### UnsetLocalizedError +`func (o *CompleteInvocationInput) UnsetLocalizedError()` + +UnsetLocalizedError ensures that no value is present for LocalizedError, not even an explicit nil +### GetOutput + +`func (o *CompleteInvocationInput) GetOutput() map[string]interface{}` + +GetOutput returns the Output field if non-nil, zero value otherwise. + +### GetOutputOk + +`func (o *CompleteInvocationInput) GetOutputOk() (*map[string]interface{}, bool)` + +GetOutputOk returns a tuple with the Output field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutput + +`func (o *CompleteInvocationInput) SetOutput(v map[string]interface{})` + +SetOutput sets Output field to given value. + +### HasOutput + +`func (o *CompleteInvocationInput) HasOutput() bool` + +HasOutput returns a boolean if a field has been set. + +### SetOutputNil + +`func (o *CompleteInvocationInput) SetOutputNil(b bool)` + + SetOutputNil sets the value for Output to be an explicit nil + +### UnsetOutput +`func (o *CompleteInvocationInput) UnsetOutput()` + +UnsetOutput ensures that no value is present for Output, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CompletedApproval.md b/docs/tools/sdk/go/Reference/V2024/Models/CompletedApproval.md new file mode 100644 index 000000000..55957e226 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CompletedApproval.md @@ -0,0 +1,722 @@ +--- +id: v2024-completed-approval +title: CompletedApproval +pagination_label: CompletedApproval +sidebar_label: CompletedApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApproval', 'V2024CompletedApproval'] +slug: /tools/sdk/go/v2024/models/completed-approval +tags: ['SDK', 'Software Development Kit', 'CompletedApproval', 'V2024CompletedApproval'] +--- + +# CompletedApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The approval id. | [optional] +**Name** | Pointer to **string** | The name of the approval. | [optional] +**Created** | Pointer to **SailPointTime** | When the approval was created. | [optional] +**Modified** | Pointer to **SailPointTime** | When the approval was modified last time. | [optional] +**RequestCreated** | Pointer to **SailPointTime** | When the access-request was created. | [optional] +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**ReviewedBy** | Pointer to [**AccessItemReviewedBy**](access-item-reviewed-by) | | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**RequesterComment** | Pointer to [**CompletedApprovalRequesterComment**](completed-approval-requester-comment) | | [optional] +**ReviewerComment** | Pointer to [**CompletedApprovalReviewerComment**](completed-approval-reviewer-comment) | | [optional] +**PreviousReviewersComments** | Pointer to [**[]CommentDto**](comment-dto) | The history of the previous reviewers comments. | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**CommentRequiredWhenRejected** | Pointer to **bool** | When true the rejector has to provide comments when rejecting | [optional] [default to false] +**State** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] +**RemoveDate** | Pointer to **NullableTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**RemoveDateUpdateRequested** | Pointer to **bool** | If true, then the request was to change the remove date or sunset date. | [optional] [default to false] +**CurrentRemoveDate** | Pointer to **NullableTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**SodViolationContext** | Pointer to [**NullableSodViolationContextCheckCompleted**](sod-violation-context-check-completed) | | [optional] +**PreApprovalTriggerResult** | Pointer to [**NullableCompletedApprovalPreApprovalTriggerResult**](completed-approval-pre-approval-trigger-result) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs provided during the request. | [optional] +**RequestedAccounts** | Pointer to [**[]RequestedAccountRef**](requested-account-ref) | The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. | [optional] + +## Methods + +### NewCompletedApproval + +`func NewCompletedApproval() *CompletedApproval` + +NewCompletedApproval instantiates a new CompletedApproval 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 + +### NewCompletedApprovalWithDefaults + +`func NewCompletedApprovalWithDefaults() *CompletedApproval` + +NewCompletedApprovalWithDefaults instantiates a new CompletedApproval 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 + +### GetId + +`func (o *CompletedApproval) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CompletedApproval) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CompletedApproval) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CompletedApproval) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CompletedApproval) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CompletedApproval) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CompletedApproval) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CompletedApproval) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *CompletedApproval) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CompletedApproval) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CompletedApproval) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CompletedApproval) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *CompletedApproval) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CompletedApproval) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CompletedApproval) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CompletedApproval) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetRequestCreated + +`func (o *CompletedApproval) GetRequestCreated() SailPointTime` + +GetRequestCreated returns the RequestCreated field if non-nil, zero value otherwise. + +### GetRequestCreatedOk + +`func (o *CompletedApproval) GetRequestCreatedOk() (*SailPointTime, bool)` + +GetRequestCreatedOk returns a tuple with the RequestCreated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCreated + +`func (o *CompletedApproval) SetRequestCreated(v SailPointTime)` + +SetRequestCreated sets RequestCreated field to given value. + +### HasRequestCreated + +`func (o *CompletedApproval) HasRequestCreated() bool` + +HasRequestCreated returns a boolean if a field has been set. + +### GetRequestType + +`func (o *CompletedApproval) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *CompletedApproval) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *CompletedApproval) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *CompletedApproval) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *CompletedApproval) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *CompletedApproval) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetRequester + +`func (o *CompletedApproval) GetRequester() AccessItemRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *CompletedApproval) GetRequesterOk() (*AccessItemRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *CompletedApproval) SetRequester(v AccessItemRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *CompletedApproval) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRequestedFor + +`func (o *CompletedApproval) GetRequestedFor() RequestedItemStatusRequestedFor` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *CompletedApproval) GetRequestedForOk() (*RequestedItemStatusRequestedFor, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *CompletedApproval) SetRequestedFor(v RequestedItemStatusRequestedFor)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *CompletedApproval) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetReviewedBy + +`func (o *CompletedApproval) GetReviewedBy() AccessItemReviewedBy` + +GetReviewedBy returns the ReviewedBy field if non-nil, zero value otherwise. + +### GetReviewedByOk + +`func (o *CompletedApproval) GetReviewedByOk() (*AccessItemReviewedBy, bool)` + +GetReviewedByOk returns a tuple with the ReviewedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewedBy + +`func (o *CompletedApproval) SetReviewedBy(v AccessItemReviewedBy)` + +SetReviewedBy sets ReviewedBy field to given value. + +### HasReviewedBy + +`func (o *CompletedApproval) HasReviewedBy() bool` + +HasReviewedBy returns a boolean if a field has been set. + +### GetOwner + +`func (o *CompletedApproval) GetOwner() OwnerDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CompletedApproval) GetOwnerOk() (*OwnerDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CompletedApproval) SetOwner(v OwnerDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *CompletedApproval) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRequestedObject + +`func (o *CompletedApproval) GetRequestedObject() RequestableObjectReference` + +GetRequestedObject returns the RequestedObject field if non-nil, zero value otherwise. + +### GetRequestedObjectOk + +`func (o *CompletedApproval) GetRequestedObjectOk() (*RequestableObjectReference, bool)` + +GetRequestedObjectOk returns a tuple with the RequestedObject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObject + +`func (o *CompletedApproval) SetRequestedObject(v RequestableObjectReference)` + +SetRequestedObject sets RequestedObject field to given value. + +### HasRequestedObject + +`func (o *CompletedApproval) HasRequestedObject() bool` + +HasRequestedObject returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *CompletedApproval) GetRequesterComment() CompletedApprovalRequesterComment` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *CompletedApproval) GetRequesterCommentOk() (*CompletedApprovalRequesterComment, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *CompletedApproval) SetRequesterComment(v CompletedApprovalRequesterComment)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *CompletedApproval) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### GetReviewerComment + +`func (o *CompletedApproval) GetReviewerComment() CompletedApprovalReviewerComment` + +GetReviewerComment returns the ReviewerComment field if non-nil, zero value otherwise. + +### GetReviewerCommentOk + +`func (o *CompletedApproval) GetReviewerCommentOk() (*CompletedApprovalReviewerComment, bool)` + +GetReviewerCommentOk returns a tuple with the ReviewerComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerComment + +`func (o *CompletedApproval) SetReviewerComment(v CompletedApprovalReviewerComment)` + +SetReviewerComment sets ReviewerComment field to given value. + +### HasReviewerComment + +`func (o *CompletedApproval) HasReviewerComment() bool` + +HasReviewerComment returns a boolean if a field has been set. + +### GetPreviousReviewersComments + +`func (o *CompletedApproval) GetPreviousReviewersComments() []CommentDto` + +GetPreviousReviewersComments returns the PreviousReviewersComments field if non-nil, zero value otherwise. + +### GetPreviousReviewersCommentsOk + +`func (o *CompletedApproval) GetPreviousReviewersCommentsOk() (*[]CommentDto, bool)` + +GetPreviousReviewersCommentsOk returns a tuple with the PreviousReviewersComments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousReviewersComments + +`func (o *CompletedApproval) SetPreviousReviewersComments(v []CommentDto)` + +SetPreviousReviewersComments sets PreviousReviewersComments field to given value. + +### HasPreviousReviewersComments + +`func (o *CompletedApproval) HasPreviousReviewersComments() bool` + +HasPreviousReviewersComments returns a boolean if a field has been set. + +### GetForwardHistory + +`func (o *CompletedApproval) GetForwardHistory() []ApprovalForwardHistory` + +GetForwardHistory returns the ForwardHistory field if non-nil, zero value otherwise. + +### GetForwardHistoryOk + +`func (o *CompletedApproval) GetForwardHistoryOk() (*[]ApprovalForwardHistory, bool)` + +GetForwardHistoryOk returns a tuple with the ForwardHistory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwardHistory + +`func (o *CompletedApproval) SetForwardHistory(v []ApprovalForwardHistory)` + +SetForwardHistory sets ForwardHistory field to given value. + +### HasForwardHistory + +`func (o *CompletedApproval) HasForwardHistory() bool` + +HasForwardHistory returns a boolean if a field has been set. + +### GetCommentRequiredWhenRejected + +`func (o *CompletedApproval) GetCommentRequiredWhenRejected() bool` + +GetCommentRequiredWhenRejected returns the CommentRequiredWhenRejected field if non-nil, zero value otherwise. + +### GetCommentRequiredWhenRejectedOk + +`func (o *CompletedApproval) GetCommentRequiredWhenRejectedOk() (*bool, bool)` + +GetCommentRequiredWhenRejectedOk returns a tuple with the CommentRequiredWhenRejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentRequiredWhenRejected + +`func (o *CompletedApproval) SetCommentRequiredWhenRejected(v bool)` + +SetCommentRequiredWhenRejected sets CommentRequiredWhenRejected field to given value. + +### HasCommentRequiredWhenRejected + +`func (o *CompletedApproval) HasCommentRequiredWhenRejected() bool` + +HasCommentRequiredWhenRejected returns a boolean if a field has been set. + +### GetState + +`func (o *CompletedApproval) GetState() CompletedApprovalState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *CompletedApproval) GetStateOk() (*CompletedApprovalState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *CompletedApproval) SetState(v CompletedApprovalState)` + +SetState sets State field to given value. + +### HasState + +`func (o *CompletedApproval) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *CompletedApproval) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *CompletedApproval) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *CompletedApproval) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *CompletedApproval) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *CompletedApproval) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *CompletedApproval) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil +### GetRemoveDateUpdateRequested + +`func (o *CompletedApproval) GetRemoveDateUpdateRequested() bool` + +GetRemoveDateUpdateRequested returns the RemoveDateUpdateRequested field if non-nil, zero value otherwise. + +### GetRemoveDateUpdateRequestedOk + +`func (o *CompletedApproval) GetRemoveDateUpdateRequestedOk() (*bool, bool)` + +GetRemoveDateUpdateRequestedOk returns a tuple with the RemoveDateUpdateRequested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDateUpdateRequested + +`func (o *CompletedApproval) SetRemoveDateUpdateRequested(v bool)` + +SetRemoveDateUpdateRequested sets RemoveDateUpdateRequested field to given value. + +### HasRemoveDateUpdateRequested + +`func (o *CompletedApproval) HasRemoveDateUpdateRequested() bool` + +HasRemoveDateUpdateRequested returns a boolean if a field has been set. + +### GetCurrentRemoveDate + +`func (o *CompletedApproval) GetCurrentRemoveDate() SailPointTime` + +GetCurrentRemoveDate returns the CurrentRemoveDate field if non-nil, zero value otherwise. + +### GetCurrentRemoveDateOk + +`func (o *CompletedApproval) GetCurrentRemoveDateOk() (*SailPointTime, bool)` + +GetCurrentRemoveDateOk returns a tuple with the CurrentRemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentRemoveDate + +`func (o *CompletedApproval) SetCurrentRemoveDate(v SailPointTime)` + +SetCurrentRemoveDate sets CurrentRemoveDate field to given value. + +### HasCurrentRemoveDate + +`func (o *CompletedApproval) HasCurrentRemoveDate() bool` + +HasCurrentRemoveDate returns a boolean if a field has been set. + +### SetCurrentRemoveDateNil + +`func (o *CompletedApproval) SetCurrentRemoveDateNil(b bool)` + + SetCurrentRemoveDateNil sets the value for CurrentRemoveDate to be an explicit nil + +### UnsetCurrentRemoveDate +`func (o *CompletedApproval) UnsetCurrentRemoveDate()` + +UnsetCurrentRemoveDate ensures that no value is present for CurrentRemoveDate, not even an explicit nil +### GetSodViolationContext + +`func (o *CompletedApproval) GetSodViolationContext() SodViolationContextCheckCompleted` + +GetSodViolationContext returns the SodViolationContext field if non-nil, zero value otherwise. + +### GetSodViolationContextOk + +`func (o *CompletedApproval) GetSodViolationContextOk() (*SodViolationContextCheckCompleted, bool)` + +GetSodViolationContextOk returns a tuple with the SodViolationContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodViolationContext + +`func (o *CompletedApproval) SetSodViolationContext(v SodViolationContextCheckCompleted)` + +SetSodViolationContext sets SodViolationContext field to given value. + +### HasSodViolationContext + +`func (o *CompletedApproval) HasSodViolationContext() bool` + +HasSodViolationContext returns a boolean if a field has been set. + +### SetSodViolationContextNil + +`func (o *CompletedApproval) SetSodViolationContextNil(b bool)` + + SetSodViolationContextNil sets the value for SodViolationContext to be an explicit nil + +### UnsetSodViolationContext +`func (o *CompletedApproval) UnsetSodViolationContext()` + +UnsetSodViolationContext ensures that no value is present for SodViolationContext, not even an explicit nil +### GetPreApprovalTriggerResult + +`func (o *CompletedApproval) GetPreApprovalTriggerResult() CompletedApprovalPreApprovalTriggerResult` + +GetPreApprovalTriggerResult returns the PreApprovalTriggerResult field if non-nil, zero value otherwise. + +### GetPreApprovalTriggerResultOk + +`func (o *CompletedApproval) GetPreApprovalTriggerResultOk() (*CompletedApprovalPreApprovalTriggerResult, bool)` + +GetPreApprovalTriggerResultOk returns a tuple with the PreApprovalTriggerResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreApprovalTriggerResult + +`func (o *CompletedApproval) SetPreApprovalTriggerResult(v CompletedApprovalPreApprovalTriggerResult)` + +SetPreApprovalTriggerResult sets PreApprovalTriggerResult field to given value. + +### HasPreApprovalTriggerResult + +`func (o *CompletedApproval) HasPreApprovalTriggerResult() bool` + +HasPreApprovalTriggerResult returns a boolean if a field has been set. + +### SetPreApprovalTriggerResultNil + +`func (o *CompletedApproval) SetPreApprovalTriggerResultNil(b bool)` + + SetPreApprovalTriggerResultNil sets the value for PreApprovalTriggerResult to be an explicit nil + +### UnsetPreApprovalTriggerResult +`func (o *CompletedApproval) UnsetPreApprovalTriggerResult()` + +UnsetPreApprovalTriggerResult ensures that no value is present for PreApprovalTriggerResult, not even an explicit nil +### GetClientMetadata + +`func (o *CompletedApproval) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *CompletedApproval) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *CompletedApproval) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *CompletedApproval) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRequestedAccounts + +`func (o *CompletedApproval) GetRequestedAccounts() []RequestedAccountRef` + +GetRequestedAccounts returns the RequestedAccounts field if non-nil, zero value otherwise. + +### GetRequestedAccountsOk + +`func (o *CompletedApproval) GetRequestedAccountsOk() (*[]RequestedAccountRef, bool)` + +GetRequestedAccountsOk returns a tuple with the RequestedAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedAccounts + +`func (o *CompletedApproval) SetRequestedAccounts(v []RequestedAccountRef)` + +SetRequestedAccounts sets RequestedAccounts field to given value. + +### HasRequestedAccounts + +`func (o *CompletedApproval) HasRequestedAccounts() bool` + +HasRequestedAccounts returns a boolean if a field has been set. + +### SetRequestedAccountsNil + +`func (o *CompletedApproval) SetRequestedAccountsNil(b bool)` + + SetRequestedAccountsNil sets the value for RequestedAccounts to be an explicit nil + +### UnsetRequestedAccounts +`func (o *CompletedApproval) UnsetRequestedAccounts()` + +UnsetRequestedAccounts ensures that no value is present for RequestedAccounts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CompletedApprovalPreApprovalTriggerResult.md b/docs/tools/sdk/go/Reference/V2024/Models/CompletedApprovalPreApprovalTriggerResult.md new file mode 100644 index 000000000..21aa27422 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CompletedApprovalPreApprovalTriggerResult.md @@ -0,0 +1,142 @@ +--- +id: v2024-completed-approval-pre-approval-trigger-result +title: CompletedApprovalPreApprovalTriggerResult +pagination_label: CompletedApprovalPreApprovalTriggerResult +sidebar_label: CompletedApprovalPreApprovalTriggerResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApprovalPreApprovalTriggerResult', 'V2024CompletedApprovalPreApprovalTriggerResult'] +slug: /tools/sdk/go/v2024/models/completed-approval-pre-approval-trigger-result +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalPreApprovalTriggerResult', 'V2024CompletedApprovalPreApprovalTriggerResult'] +--- + +# CompletedApprovalPreApprovalTriggerResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | The comment from the trigger | [optional] +**Decision** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] +**Reviewer** | Pointer to **string** | The name of the approver | [optional] +**Date** | Pointer to **SailPointTime** | The date and time the trigger decided on the request | [optional] + +## Methods + +### NewCompletedApprovalPreApprovalTriggerResult + +`func NewCompletedApprovalPreApprovalTriggerResult() *CompletedApprovalPreApprovalTriggerResult` + +NewCompletedApprovalPreApprovalTriggerResult instantiates a new CompletedApprovalPreApprovalTriggerResult 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 + +### NewCompletedApprovalPreApprovalTriggerResultWithDefaults + +`func NewCompletedApprovalPreApprovalTriggerResultWithDefaults() *CompletedApprovalPreApprovalTriggerResult` + +NewCompletedApprovalPreApprovalTriggerResultWithDefaults instantiates a new CompletedApprovalPreApprovalTriggerResult 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 + +### GetComment + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CompletedApprovalPreApprovalTriggerResult) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CompletedApprovalPreApprovalTriggerResult) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetDecision + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetDecision() CompletedApprovalState` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetDecisionOk() (*CompletedApprovalState, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *CompletedApprovalPreApprovalTriggerResult) SetDecision(v CompletedApprovalState)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *CompletedApprovalPreApprovalTriggerResult) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + +### GetReviewer + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetReviewer() string` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetReviewerOk() (*string, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CompletedApprovalPreApprovalTriggerResult) SetReviewer(v string)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *CompletedApprovalPreApprovalTriggerResult) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetDate + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetDate() SailPointTime` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetDateOk() (*SailPointTime, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *CompletedApprovalPreApprovalTriggerResult) SetDate(v SailPointTime)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *CompletedApprovalPreApprovalTriggerResult) HasDate() bool` + +HasDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CompletedApprovalRequesterComment.md b/docs/tools/sdk/go/Reference/V2024/Models/CompletedApprovalRequesterComment.md new file mode 100644 index 000000000..d895c2e20 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CompletedApprovalRequesterComment.md @@ -0,0 +1,126 @@ +--- +id: v2024-completed-approval-requester-comment +title: CompletedApprovalRequesterComment +pagination_label: CompletedApprovalRequesterComment +sidebar_label: CompletedApprovalRequesterComment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApprovalRequesterComment', 'V2024CompletedApprovalRequesterComment'] +slug: /tools/sdk/go/v2024/models/completed-approval-requester-comment +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalRequesterComment', 'V2024CompletedApprovalRequesterComment'] +--- + +# CompletedApprovalRequesterComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **NullableString** | Comment content. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Methods + +### NewCompletedApprovalRequesterComment + +`func NewCompletedApprovalRequesterComment() *CompletedApprovalRequesterComment` + +NewCompletedApprovalRequesterComment instantiates a new CompletedApprovalRequesterComment 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 + +### NewCompletedApprovalRequesterCommentWithDefaults + +`func NewCompletedApprovalRequesterCommentWithDefaults() *CompletedApprovalRequesterComment` + +NewCompletedApprovalRequesterCommentWithDefaults instantiates a new CompletedApprovalRequesterComment 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 + +### GetComment + +`func (o *CompletedApprovalRequesterComment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CompletedApprovalRequesterComment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CompletedApprovalRequesterComment) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CompletedApprovalRequesterComment) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *CompletedApprovalRequesterComment) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *CompletedApprovalRequesterComment) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetCreated + +`func (o *CompletedApprovalRequesterComment) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CompletedApprovalRequesterComment) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CompletedApprovalRequesterComment) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CompletedApprovalRequesterComment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetAuthor + +`func (o *CompletedApprovalRequesterComment) GetAuthor() CommentDtoAuthor` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *CompletedApprovalRequesterComment) GetAuthorOk() (*CommentDtoAuthor, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *CompletedApprovalRequesterComment) SetAuthor(v CommentDtoAuthor)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *CompletedApprovalRequesterComment) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CompletedApprovalReviewerComment.md b/docs/tools/sdk/go/Reference/V2024/Models/CompletedApprovalReviewerComment.md new file mode 100644 index 000000000..7604fedd8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CompletedApprovalReviewerComment.md @@ -0,0 +1,126 @@ +--- +id: v2024-completed-approval-reviewer-comment +title: CompletedApprovalReviewerComment +pagination_label: CompletedApprovalReviewerComment +sidebar_label: CompletedApprovalReviewerComment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApprovalReviewerComment', 'V2024CompletedApprovalReviewerComment'] +slug: /tools/sdk/go/v2024/models/completed-approval-reviewer-comment +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalReviewerComment', 'V2024CompletedApprovalReviewerComment'] +--- + +# CompletedApprovalReviewerComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **NullableString** | Comment content. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Methods + +### NewCompletedApprovalReviewerComment + +`func NewCompletedApprovalReviewerComment() *CompletedApprovalReviewerComment` + +NewCompletedApprovalReviewerComment instantiates a new CompletedApprovalReviewerComment 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 + +### NewCompletedApprovalReviewerCommentWithDefaults + +`func NewCompletedApprovalReviewerCommentWithDefaults() *CompletedApprovalReviewerComment` + +NewCompletedApprovalReviewerCommentWithDefaults instantiates a new CompletedApprovalReviewerComment 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 + +### GetComment + +`func (o *CompletedApprovalReviewerComment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CompletedApprovalReviewerComment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CompletedApprovalReviewerComment) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CompletedApprovalReviewerComment) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *CompletedApprovalReviewerComment) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *CompletedApprovalReviewerComment) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetCreated + +`func (o *CompletedApprovalReviewerComment) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CompletedApprovalReviewerComment) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CompletedApprovalReviewerComment) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CompletedApprovalReviewerComment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetAuthor + +`func (o *CompletedApprovalReviewerComment) GetAuthor() CommentDtoAuthor` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *CompletedApprovalReviewerComment) GetAuthorOk() (*CommentDtoAuthor, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *CompletedApprovalReviewerComment) SetAuthor(v CommentDtoAuthor)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *CompletedApprovalReviewerComment) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CompletedApprovalState.md b/docs/tools/sdk/go/Reference/V2024/Models/CompletedApprovalState.md new file mode 100644 index 000000000..5bbc993f4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CompletedApprovalState.md @@ -0,0 +1,21 @@ +--- +id: v2024-completed-approval-state +title: CompletedApprovalState +pagination_label: CompletedApprovalState +sidebar_label: CompletedApprovalState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApprovalState', 'V2024CompletedApprovalState'] +slug: /tools/sdk/go/v2024/models/completed-approval-state +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalState', 'V2024CompletedApprovalState'] +--- + +# CompletedApprovalState + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CompletionStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/CompletionStatus.md new file mode 100644 index 000000000..49a4fdc89 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CompletionStatus.md @@ -0,0 +1,25 @@ +--- +id: v2024-completion-status +title: CompletionStatus +pagination_label: CompletionStatus +sidebar_label: CompletionStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletionStatus', 'V2024CompletionStatus'] +slug: /tools/sdk/go/v2024/models/completion-status +tags: ['SDK', 'Software Development Kit', 'CompletionStatus', 'V2024CompletionStatus'] +--- + +# CompletionStatus + +## Enum + + +* `SUCCESS` (value: `"SUCCESS"`) + +* `FAILURE` (value: `"FAILURE"`) + +* `INCOMPLETE` (value: `"INCOMPLETE"`) + +* `PENDING` (value: `"PENDING"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConditionEffect.md b/docs/tools/sdk/go/Reference/V2024/Models/ConditionEffect.md new file mode 100644 index 000000000..1dd039fed --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConditionEffect.md @@ -0,0 +1,90 @@ +--- +id: v2024-condition-effect +title: ConditionEffect +pagination_label: ConditionEffect +sidebar_label: ConditionEffect +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConditionEffect', 'V2024ConditionEffect'] +slug: /tools/sdk/go/v2024/models/condition-effect +tags: ['SDK', 'Software Development Kit', 'ConditionEffect', 'V2024ConditionEffect'] +--- + +# ConditionEffect + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EffectType** | Pointer to **string** | Type of effect to perform when the conditions are evaluated for this logic block. HIDE ConditionEffectTypeHide Disables validations. SHOW ConditionEffectTypeShow Enables validations. DISABLE ConditionEffectTypeDisable Disables validations. ENABLE ConditionEffectTypeEnable Enables validations. REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. | [optional] +**Config** | Pointer to [**ConditionEffectConfig**](condition-effect-config) | | [optional] + +## Methods + +### NewConditionEffect + +`func NewConditionEffect() *ConditionEffect` + +NewConditionEffect instantiates a new ConditionEffect 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 + +### NewConditionEffectWithDefaults + +`func NewConditionEffectWithDefaults() *ConditionEffect` + +NewConditionEffectWithDefaults instantiates a new ConditionEffect 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 + +### GetEffectType + +`func (o *ConditionEffect) GetEffectType() string` + +GetEffectType returns the EffectType field if non-nil, zero value otherwise. + +### GetEffectTypeOk + +`func (o *ConditionEffect) GetEffectTypeOk() (*string, bool)` + +GetEffectTypeOk returns a tuple with the EffectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEffectType + +`func (o *ConditionEffect) SetEffectType(v string)` + +SetEffectType sets EffectType field to given value. + +### HasEffectType + +`func (o *ConditionEffect) HasEffectType() bool` + +HasEffectType returns a boolean if a field has been set. + +### GetConfig + +`func (o *ConditionEffect) GetConfig() ConditionEffectConfig` + +GetConfig returns the Config field if non-nil, zero value otherwise. + +### GetConfigOk + +`func (o *ConditionEffect) GetConfigOk() (*ConditionEffectConfig, bool)` + +GetConfigOk returns a tuple with the Config field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfig + +`func (o *ConditionEffect) SetConfig(v ConditionEffectConfig)` + +SetConfig sets Config field to given value. + +### HasConfig + +`func (o *ConditionEffect) HasConfig() bool` + +HasConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConditionEffectConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/ConditionEffectConfig.md new file mode 100644 index 000000000..4356b4eca --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConditionEffectConfig.md @@ -0,0 +1,90 @@ +--- +id: v2024-condition-effect-config +title: ConditionEffectConfig +pagination_label: ConditionEffectConfig +sidebar_label: ConditionEffectConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConditionEffectConfig', 'V2024ConditionEffectConfig'] +slug: /tools/sdk/go/v2024/models/condition-effect-config +tags: ['SDK', 'Software Development Kit', 'ConditionEffectConfig', 'V2024ConditionEffectConfig'] +--- + +# ConditionEffectConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DefaultValueLabel** | Pointer to **string** | Effect type's label. | [optional] +**Element** | Pointer to **string** | Element's identifier. | [optional] + +## Methods + +### NewConditionEffectConfig + +`func NewConditionEffectConfig() *ConditionEffectConfig` + +NewConditionEffectConfig instantiates a new ConditionEffectConfig 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 + +### NewConditionEffectConfigWithDefaults + +`func NewConditionEffectConfigWithDefaults() *ConditionEffectConfig` + +NewConditionEffectConfigWithDefaults instantiates a new ConditionEffectConfig 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 + +### GetDefaultValueLabel + +`func (o *ConditionEffectConfig) GetDefaultValueLabel() string` + +GetDefaultValueLabel returns the DefaultValueLabel field if non-nil, zero value otherwise. + +### GetDefaultValueLabelOk + +`func (o *ConditionEffectConfig) GetDefaultValueLabelOk() (*string, bool)` + +GetDefaultValueLabelOk returns a tuple with the DefaultValueLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultValueLabel + +`func (o *ConditionEffectConfig) SetDefaultValueLabel(v string)` + +SetDefaultValueLabel sets DefaultValueLabel field to given value. + +### HasDefaultValueLabel + +`func (o *ConditionEffectConfig) HasDefaultValueLabel() bool` + +HasDefaultValueLabel returns a boolean if a field has been set. + +### GetElement + +`func (o *ConditionEffectConfig) GetElement() string` + +GetElement returns the Element field if non-nil, zero value otherwise. + +### GetElementOk + +`func (o *ConditionEffectConfig) GetElementOk() (*string, bool)` + +GetElementOk returns a tuple with the Element field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElement + +`func (o *ConditionEffectConfig) SetElement(v string)` + +SetElement sets Element field to given value. + +### HasElement + +`func (o *ConditionEffectConfig) HasElement() bool` + +HasElement returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConditionRule.md b/docs/tools/sdk/go/Reference/V2024/Models/ConditionRule.md new file mode 100644 index 000000000..4ae83ae53 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConditionRule.md @@ -0,0 +1,168 @@ +--- +id: v2024-condition-rule +title: ConditionRule +pagination_label: ConditionRule +sidebar_label: ConditionRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConditionRule', 'V2024ConditionRule'] +slug: /tools/sdk/go/v2024/models/condition-rule +tags: ['SDK', 'Software Development Kit', 'ConditionRule', 'V2024ConditionRule'] +--- + +# ConditionRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceType** | Pointer to **string** | Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement | [optional] +**Source** | Pointer to **string** | Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, the source is the name of a technical key of an element to retrieve its value. | [optional] +**Operator** | Pointer to **string** | ConditionRuleComparisonOperatorType value. EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith | [optional] +**ValueType** | Pointer to **string** | ConditionRuleValueType type. STRING ConditionRuleValueTypeString This value is a static string. STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. INPUT ConditionRuleValueTypeInput This value is a reference to a form input. ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean | [optional] +**Value** | Pointer to **string** | Based on the ValueType. | [optional] + +## Methods + +### NewConditionRule + +`func NewConditionRule() *ConditionRule` + +NewConditionRule instantiates a new ConditionRule 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 + +### NewConditionRuleWithDefaults + +`func NewConditionRuleWithDefaults() *ConditionRule` + +NewConditionRuleWithDefaults instantiates a new ConditionRule 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 + +### GetSourceType + +`func (o *ConditionRule) GetSourceType() string` + +GetSourceType returns the SourceType field if non-nil, zero value otherwise. + +### GetSourceTypeOk + +`func (o *ConditionRule) GetSourceTypeOk() (*string, bool)` + +GetSourceTypeOk returns a tuple with the SourceType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceType + +`func (o *ConditionRule) SetSourceType(v string)` + +SetSourceType sets SourceType field to given value. + +### HasSourceType + +`func (o *ConditionRule) HasSourceType() bool` + +HasSourceType returns a boolean if a field has been set. + +### GetSource + +`func (o *ConditionRule) GetSource() string` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *ConditionRule) GetSourceOk() (*string, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *ConditionRule) SetSource(v string)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *ConditionRule) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetOperator + +`func (o *ConditionRule) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *ConditionRule) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *ConditionRule) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *ConditionRule) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetValueType + +`func (o *ConditionRule) GetValueType() string` + +GetValueType returns the ValueType field if non-nil, zero value otherwise. + +### GetValueTypeOk + +`func (o *ConditionRule) GetValueTypeOk() (*string, bool)` + +GetValueTypeOk returns a tuple with the ValueType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValueType + +`func (o *ConditionRule) SetValueType(v string)` + +SetValueType sets ValueType field to given value. + +### HasValueType + +`func (o *ConditionRule) HasValueType() bool` + +HasValueType returns a boolean if a field has been set. + +### GetValue + +`func (o *ConditionRule) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ConditionRule) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ConditionRule) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ConditionRule) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConfigObject.md b/docs/tools/sdk/go/Reference/V2024/Models/ConfigObject.md new file mode 100644 index 000000000..23c6d75a6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConfigObject.md @@ -0,0 +1,116 @@ +--- +id: v2024-config-object +title: ConfigObject +pagination_label: ConfigObject +sidebar_label: ConfigObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigObject', 'V2024ConfigObject'] +slug: /tools/sdk/go/v2024/models/config-object +tags: ['SDK', 'Software Development Kit', 'ConfigObject', 'V2024ConfigObject'] +--- + +# ConfigObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **int32** | Current version of configuration object. | [optional] +**Self** | Pointer to [**SelfImportExportDto**](self-import-export-dto) | | [optional] +**Object** | Pointer to **map[string]interface{}** | Object details. Format dependant on the object type. | [optional] + +## Methods + +### NewConfigObject + +`func NewConfigObject() *ConfigObject` + +NewConfigObject instantiates a new ConfigObject 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 + +### NewConfigObjectWithDefaults + +`func NewConfigObjectWithDefaults() *ConfigObject` + +NewConfigObjectWithDefaults instantiates a new ConfigObject 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 + +### GetVersion + +`func (o *ConfigObject) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ConfigObject) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ConfigObject) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *ConfigObject) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### GetSelf + +`func (o *ConfigObject) GetSelf() SelfImportExportDto` + +GetSelf returns the Self field if non-nil, zero value otherwise. + +### GetSelfOk + +`func (o *ConfigObject) GetSelfOk() (*SelfImportExportDto, bool)` + +GetSelfOk returns a tuple with the Self field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelf + +`func (o *ConfigObject) SetSelf(v SelfImportExportDto)` + +SetSelf sets Self field to given value. + +### HasSelf + +`func (o *ConfigObject) HasSelf() bool` + +HasSelf returns a boolean if a field has been set. + +### GetObject + +`func (o *ConfigObject) GetObject() map[string]interface{}` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *ConfigObject) GetObjectOk() (*map[string]interface{}, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *ConfigObject) SetObject(v map[string]interface{})` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *ConfigObject) HasObject() bool` + +HasObject returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConfigType.md b/docs/tools/sdk/go/Reference/V2024/Models/ConfigType.md new file mode 100644 index 000000000..e3db53d35 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConfigType.md @@ -0,0 +1,168 @@ +--- +id: v2024-config-type +title: ConfigType +pagination_label: ConfigType +sidebar_label: ConfigType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigType', 'V2024ConfigType'] +slug: /tools/sdk/go/v2024/models/config-type +tags: ['SDK', 'Software Development Kit', 'ConfigType', 'V2024ConfigType'] +--- + +# ConfigType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Priority** | Pointer to **int32** | | [optional] +**InternalName** | Pointer to [**ConfigTypeEnumCamel**](config-type-enum-camel) | | [optional] +**InternalNameCamel** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] +**DisplayName** | Pointer to **string** | Human readable display name of the type to be shown on UI | [optional] +**Description** | Pointer to **string** | Description of the type of work to be reassigned, displayed by the UI. | [optional] + +## Methods + +### NewConfigType + +`func NewConfigType() *ConfigType` + +NewConfigType instantiates a new ConfigType 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 + +### NewConfigTypeWithDefaults + +`func NewConfigTypeWithDefaults() *ConfigType` + +NewConfigTypeWithDefaults instantiates a new ConfigType 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 + +### GetPriority + +`func (o *ConfigType) GetPriority() int32` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *ConfigType) 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 *ConfigType) SetPriority(v int32)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *ConfigType) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetInternalName + +`func (o *ConfigType) GetInternalName() ConfigTypeEnumCamel` + +GetInternalName returns the InternalName field if non-nil, zero value otherwise. + +### GetInternalNameOk + +`func (o *ConfigType) GetInternalNameOk() (*ConfigTypeEnumCamel, bool)` + +GetInternalNameOk returns a tuple with the InternalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternalName + +`func (o *ConfigType) SetInternalName(v ConfigTypeEnumCamel)` + +SetInternalName sets InternalName field to given value. + +### HasInternalName + +`func (o *ConfigType) HasInternalName() bool` + +HasInternalName returns a boolean if a field has been set. + +### GetInternalNameCamel + +`func (o *ConfigType) GetInternalNameCamel() ConfigTypeEnum` + +GetInternalNameCamel returns the InternalNameCamel field if non-nil, zero value otherwise. + +### GetInternalNameCamelOk + +`func (o *ConfigType) GetInternalNameCamelOk() (*ConfigTypeEnum, bool)` + +GetInternalNameCamelOk returns a tuple with the InternalNameCamel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternalNameCamel + +`func (o *ConfigType) SetInternalNameCamel(v ConfigTypeEnum)` + +SetInternalNameCamel sets InternalNameCamel field to given value. + +### HasInternalNameCamel + +`func (o *ConfigType) HasInternalNameCamel() bool` + +HasInternalNameCamel returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *ConfigType) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *ConfigType) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *ConfigType) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *ConfigType) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ConfigType) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ConfigType) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ConfigType) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ConfigType) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConfigTypeEnum.md b/docs/tools/sdk/go/Reference/V2024/Models/ConfigTypeEnum.md new file mode 100644 index 000000000..536211cd3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConfigTypeEnum.md @@ -0,0 +1,23 @@ +--- +id: v2024-config-type-enum +title: ConfigTypeEnum +pagination_label: ConfigTypeEnum +sidebar_label: ConfigTypeEnum +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigTypeEnum', 'V2024ConfigTypeEnum'] +slug: /tools/sdk/go/v2024/models/config-type-enum +tags: ['SDK', 'Software Development Kit', 'ConfigTypeEnum', 'V2024ConfigTypeEnum'] +--- + +# ConfigTypeEnum + +## Enum + + +* `ACCESS_REQUESTS` (value: `"ACCESS_REQUESTS"`) + +* `CERTIFICATIONS` (value: `"CERTIFICATIONS"`) + +* `MANUAL_TASKS` (value: `"MANUAL_TASKS"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConfigTypeEnumCamel.md b/docs/tools/sdk/go/Reference/V2024/Models/ConfigTypeEnumCamel.md new file mode 100644 index 000000000..07a2cc6e8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConfigTypeEnumCamel.md @@ -0,0 +1,23 @@ +--- +id: v2024-config-type-enum-camel +title: ConfigTypeEnumCamel +pagination_label: ConfigTypeEnumCamel +sidebar_label: ConfigTypeEnumCamel +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigTypeEnumCamel', 'V2024ConfigTypeEnumCamel'] +slug: /tools/sdk/go/v2024/models/config-type-enum-camel +tags: ['SDK', 'Software Development Kit', 'ConfigTypeEnumCamel', 'V2024ConfigTypeEnumCamel'] +--- + +# ConfigTypeEnumCamel + +## Enum + + +* `ACCESS_REQUESTS` (value: `"accessRequests"`) + +* `CERTIFICATIONS` (value: `"certifications"`) + +* `MANUAL_TASKS` (value: `"manualTasks"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConfigurationDetailsResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ConfigurationDetailsResponse.md new file mode 100644 index 000000000..a38893522 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConfigurationDetailsResponse.md @@ -0,0 +1,168 @@ +--- +id: v2024-configuration-details-response +title: ConfigurationDetailsResponse +pagination_label: ConfigurationDetailsResponse +sidebar_label: ConfigurationDetailsResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigurationDetailsResponse', 'V2024ConfigurationDetailsResponse'] +slug: /tools/sdk/go/v2024/models/configuration-details-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationDetailsResponse', 'V2024ConfigurationDetailsResponse'] +--- + +# ConfigurationDetailsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConfigType** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] +**TargetIdentity** | Pointer to [**Identity1**](identity1) | | [optional] +**StartDate** | Pointer to **SailPointTime** | The date from which to start reassigning work items | [optional] +**EndDate** | Pointer to **SailPointTime** | The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment. | [optional] +**AuditDetails** | Pointer to [**AuditDetails**](audit-details) | | [optional] + +## Methods + +### NewConfigurationDetailsResponse + +`func NewConfigurationDetailsResponse() *ConfigurationDetailsResponse` + +NewConfigurationDetailsResponse instantiates a new ConfigurationDetailsResponse 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 + +### NewConfigurationDetailsResponseWithDefaults + +`func NewConfigurationDetailsResponseWithDefaults() *ConfigurationDetailsResponse` + +NewConfigurationDetailsResponseWithDefaults instantiates a new ConfigurationDetailsResponse 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 + +### GetConfigType + +`func (o *ConfigurationDetailsResponse) GetConfigType() ConfigTypeEnum` + +GetConfigType returns the ConfigType field if non-nil, zero value otherwise. + +### GetConfigTypeOk + +`func (o *ConfigurationDetailsResponse) GetConfigTypeOk() (*ConfigTypeEnum, bool)` + +GetConfigTypeOk returns a tuple with the ConfigType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigType + +`func (o *ConfigurationDetailsResponse) SetConfigType(v ConfigTypeEnum)` + +SetConfigType sets ConfigType field to given value. + +### HasConfigType + +`func (o *ConfigurationDetailsResponse) HasConfigType() bool` + +HasConfigType returns a boolean if a field has been set. + +### GetTargetIdentity + +`func (o *ConfigurationDetailsResponse) GetTargetIdentity() Identity1` + +GetTargetIdentity returns the TargetIdentity field if non-nil, zero value otherwise. + +### GetTargetIdentityOk + +`func (o *ConfigurationDetailsResponse) GetTargetIdentityOk() (*Identity1, bool)` + +GetTargetIdentityOk returns a tuple with the TargetIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetIdentity + +`func (o *ConfigurationDetailsResponse) SetTargetIdentity(v Identity1)` + +SetTargetIdentity sets TargetIdentity field to given value. + +### HasTargetIdentity + +`func (o *ConfigurationDetailsResponse) HasTargetIdentity() bool` + +HasTargetIdentity returns a boolean if a field has been set. + +### GetStartDate + +`func (o *ConfigurationDetailsResponse) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *ConfigurationDetailsResponse) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *ConfigurationDetailsResponse) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *ConfigurationDetailsResponse) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *ConfigurationDetailsResponse) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *ConfigurationDetailsResponse) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *ConfigurationDetailsResponse) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *ConfigurationDetailsResponse) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetAuditDetails + +`func (o *ConfigurationDetailsResponse) GetAuditDetails() AuditDetails` + +GetAuditDetails returns the AuditDetails field if non-nil, zero value otherwise. + +### GetAuditDetailsOk + +`func (o *ConfigurationDetailsResponse) GetAuditDetailsOk() (*AuditDetails, bool)` + +GetAuditDetailsOk returns a tuple with the AuditDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuditDetails + +`func (o *ConfigurationDetailsResponse) SetAuditDetails(v AuditDetails)` + +SetAuditDetails sets AuditDetails field to given value. + +### HasAuditDetails + +`func (o *ConfigurationDetailsResponse) HasAuditDetails() bool` + +HasAuditDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConfigurationItemRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/ConfigurationItemRequest.md new file mode 100644 index 000000000..7ae673752 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConfigurationItemRequest.md @@ -0,0 +1,178 @@ +--- +id: v2024-configuration-item-request +title: ConfigurationItemRequest +pagination_label: ConfigurationItemRequest +sidebar_label: ConfigurationItemRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigurationItemRequest', 'V2024ConfigurationItemRequest'] +slug: /tools/sdk/go/v2024/models/configuration-item-request +tags: ['SDK', 'Software Development Kit', 'ConfigurationItemRequest', 'V2024ConfigurationItemRequest'] +--- + +# ConfigurationItemRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReassignedFromId** | Pointer to **string** | The identity id to reassign an item from | [optional] +**ReassignedToId** | Pointer to **string** | The identity id to reassign an item to | [optional] +**ConfigType** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] +**StartDate** | Pointer to **SailPointTime** | The date from which to start reassigning work items | [optional] +**EndDate** | Pointer to **NullableTime** | The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment. | [optional] + +## Methods + +### NewConfigurationItemRequest + +`func NewConfigurationItemRequest() *ConfigurationItemRequest` + +NewConfigurationItemRequest instantiates a new ConfigurationItemRequest 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 + +### NewConfigurationItemRequestWithDefaults + +`func NewConfigurationItemRequestWithDefaults() *ConfigurationItemRequest` + +NewConfigurationItemRequestWithDefaults instantiates a new ConfigurationItemRequest 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 + +### GetReassignedFromId + +`func (o *ConfigurationItemRequest) GetReassignedFromId() string` + +GetReassignedFromId returns the ReassignedFromId field if non-nil, zero value otherwise. + +### GetReassignedFromIdOk + +`func (o *ConfigurationItemRequest) GetReassignedFromIdOk() (*string, bool)` + +GetReassignedFromIdOk returns a tuple with the ReassignedFromId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignedFromId + +`func (o *ConfigurationItemRequest) SetReassignedFromId(v string)` + +SetReassignedFromId sets ReassignedFromId field to given value. + +### HasReassignedFromId + +`func (o *ConfigurationItemRequest) HasReassignedFromId() bool` + +HasReassignedFromId returns a boolean if a field has been set. + +### GetReassignedToId + +`func (o *ConfigurationItemRequest) GetReassignedToId() string` + +GetReassignedToId returns the ReassignedToId field if non-nil, zero value otherwise. + +### GetReassignedToIdOk + +`func (o *ConfigurationItemRequest) GetReassignedToIdOk() (*string, bool)` + +GetReassignedToIdOk returns a tuple with the ReassignedToId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignedToId + +`func (o *ConfigurationItemRequest) SetReassignedToId(v string)` + +SetReassignedToId sets ReassignedToId field to given value. + +### HasReassignedToId + +`func (o *ConfigurationItemRequest) HasReassignedToId() bool` + +HasReassignedToId returns a boolean if a field has been set. + +### GetConfigType + +`func (o *ConfigurationItemRequest) GetConfigType() ConfigTypeEnum` + +GetConfigType returns the ConfigType field if non-nil, zero value otherwise. + +### GetConfigTypeOk + +`func (o *ConfigurationItemRequest) GetConfigTypeOk() (*ConfigTypeEnum, bool)` + +GetConfigTypeOk returns a tuple with the ConfigType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigType + +`func (o *ConfigurationItemRequest) SetConfigType(v ConfigTypeEnum)` + +SetConfigType sets ConfigType field to given value. + +### HasConfigType + +`func (o *ConfigurationItemRequest) HasConfigType() bool` + +HasConfigType returns a boolean if a field has been set. + +### GetStartDate + +`func (o *ConfigurationItemRequest) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *ConfigurationItemRequest) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *ConfigurationItemRequest) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *ConfigurationItemRequest) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *ConfigurationItemRequest) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *ConfigurationItemRequest) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *ConfigurationItemRequest) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *ConfigurationItemRequest) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### SetEndDateNil + +`func (o *ConfigurationItemRequest) SetEndDateNil(b bool)` + + SetEndDateNil sets the value for EndDate to be an explicit nil + +### UnsetEndDate +`func (o *ConfigurationItemRequest) UnsetEndDate()` + +UnsetEndDate ensures that no value is present for EndDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConfigurationItemResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ConfigurationItemResponse.md new file mode 100644 index 000000000..c74f92a78 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConfigurationItemResponse.md @@ -0,0 +1,90 @@ +--- +id: v2024-configuration-item-response +title: ConfigurationItemResponse +pagination_label: ConfigurationItemResponse +sidebar_label: ConfigurationItemResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigurationItemResponse', 'V2024ConfigurationItemResponse'] +slug: /tools/sdk/go/v2024/models/configuration-item-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationItemResponse', 'V2024ConfigurationItemResponse'] +--- + +# ConfigurationItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**Identity1**](identity1) | | [optional] +**ConfigDetails** | Pointer to [**[]ConfigurationDetailsResponse**](configuration-details-response) | Details of how work should be reassigned for an Identity | [optional] + +## Methods + +### NewConfigurationItemResponse + +`func NewConfigurationItemResponse() *ConfigurationItemResponse` + +NewConfigurationItemResponse instantiates a new ConfigurationItemResponse 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 + +### NewConfigurationItemResponseWithDefaults + +`func NewConfigurationItemResponseWithDefaults() *ConfigurationItemResponse` + +NewConfigurationItemResponseWithDefaults instantiates a new ConfigurationItemResponse 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 + +### GetIdentity + +`func (o *ConfigurationItemResponse) GetIdentity() Identity1` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *ConfigurationItemResponse) GetIdentityOk() (*Identity1, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *ConfigurationItemResponse) SetIdentity(v Identity1)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *ConfigurationItemResponse) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetConfigDetails + +`func (o *ConfigurationItemResponse) GetConfigDetails() []ConfigurationDetailsResponse` + +GetConfigDetails returns the ConfigDetails field if non-nil, zero value otherwise. + +### GetConfigDetailsOk + +`func (o *ConfigurationItemResponse) GetConfigDetailsOk() (*[]ConfigurationDetailsResponse, bool)` + +GetConfigDetailsOk returns a tuple with the ConfigDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigDetails + +`func (o *ConfigurationItemResponse) SetConfigDetails(v []ConfigurationDetailsResponse)` + +SetConfigDetails sets ConfigDetails field to given value. + +### HasConfigDetails + +`func (o *ConfigurationItemResponse) HasConfigDetails() bool` + +HasConfigDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConfigurationResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ConfigurationResponse.md new file mode 100644 index 000000000..930059c4d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConfigurationResponse.md @@ -0,0 +1,90 @@ +--- +id: v2024-configuration-response +title: ConfigurationResponse +pagination_label: ConfigurationResponse +sidebar_label: ConfigurationResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigurationResponse', 'V2024ConfigurationResponse'] +slug: /tools/sdk/go/v2024/models/configuration-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationResponse', 'V2024ConfigurationResponse'] +--- + +# ConfigurationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**Identity1**](identity1) | | [optional] +**ConfigDetails** | Pointer to [**[]ConfigurationDetailsResponse**](configuration-details-response) | Details of how work should be reassigned for an Identity | [optional] + +## Methods + +### NewConfigurationResponse + +`func NewConfigurationResponse() *ConfigurationResponse` + +NewConfigurationResponse instantiates a new ConfigurationResponse 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 + +### NewConfigurationResponseWithDefaults + +`func NewConfigurationResponseWithDefaults() *ConfigurationResponse` + +NewConfigurationResponseWithDefaults instantiates a new ConfigurationResponse 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 + +### GetIdentity + +`func (o *ConfigurationResponse) GetIdentity() Identity1` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *ConfigurationResponse) GetIdentityOk() (*Identity1, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *ConfigurationResponse) SetIdentity(v Identity1)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *ConfigurationResponse) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetConfigDetails + +`func (o *ConfigurationResponse) GetConfigDetails() []ConfigurationDetailsResponse` + +GetConfigDetails returns the ConfigDetails field if non-nil, zero value otherwise. + +### GetConfigDetailsOk + +`func (o *ConfigurationResponse) GetConfigDetailsOk() (*[]ConfigurationDetailsResponse, bool)` + +GetConfigDetailsOk returns a tuple with the ConfigDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigDetails + +`func (o *ConfigurationResponse) SetConfigDetails(v []ConfigurationDetailsResponse)` + +SetConfigDetails sets ConfigDetails field to given value. + +### HasConfigDetails + +`func (o *ConfigurationResponse) HasConfigDetails() bool` + +HasConfigDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConflictingAccessCriteria.md b/docs/tools/sdk/go/Reference/V2024/Models/ConflictingAccessCriteria.md new file mode 100644 index 000000000..706d4a60f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConflictingAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: v2024-conflicting-access-criteria +title: ConflictingAccessCriteria +pagination_label: ConflictingAccessCriteria +sidebar_label: ConflictingAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConflictingAccessCriteria', 'V2024ConflictingAccessCriteria'] +slug: /tools/sdk/go/v2024/models/conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'ConflictingAccessCriteria', 'V2024ConflictingAccessCriteria'] +--- + +# ConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] +**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] + +## Methods + +### NewConflictingAccessCriteria + +`func NewConflictingAccessCriteria() *ConflictingAccessCriteria` + +NewConflictingAccessCriteria instantiates a new ConflictingAccessCriteria 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 + +### NewConflictingAccessCriteriaWithDefaults + +`func NewConflictingAccessCriteriaWithDefaults() *ConflictingAccessCriteria` + +NewConflictingAccessCriteriaWithDefaults instantiates a new ConflictingAccessCriteria 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 + +### GetLeftCriteria + +`func (o *ConflictingAccessCriteria) GetLeftCriteria() AccessCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *ConflictingAccessCriteria) GetLeftCriteriaOk() (*AccessCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *ConflictingAccessCriteria) SetLeftCriteria(v AccessCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *ConflictingAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *ConflictingAccessCriteria) GetRightCriteria() AccessCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *ConflictingAccessCriteria) GetRightCriteriaOk() (*AccessCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *ConflictingAccessCriteria) SetRightCriteria(v AccessCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *ConflictingAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConnectedObject.md b/docs/tools/sdk/go/Reference/V2024/Models/ConnectedObject.md new file mode 100644 index 000000000..da6411bcf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConnectedObject.md @@ -0,0 +1,152 @@ +--- +id: v2024-connected-object +title: ConnectedObject +pagination_label: ConnectedObject +sidebar_label: ConnectedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectedObject', 'V2024ConnectedObject'] +slug: /tools/sdk/go/v2024/models/connected-object +tags: ['SDK', 'Software Development Kit', 'ConnectedObject', 'V2024ConnectedObject'] +--- + +# ConnectedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**ConnectedObjectType**](connected-object-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable name of Connected object | [optional] +**Description** | Pointer to **NullableString** | Description of the Connected object. | [optional] + +## Methods + +### NewConnectedObject + +`func NewConnectedObject() *ConnectedObject` + +NewConnectedObject instantiates a new ConnectedObject 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 + +### NewConnectedObjectWithDefaults + +`func NewConnectedObjectWithDefaults() *ConnectedObject` + +NewConnectedObjectWithDefaults instantiates a new ConnectedObject 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 + +### GetType + +`func (o *ConnectedObject) GetType() ConnectedObjectType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ConnectedObject) GetTypeOk() (*ConnectedObjectType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ConnectedObject) SetType(v ConnectedObjectType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ConnectedObject) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ConnectedObject) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ConnectedObject) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ConnectedObject) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ConnectedObject) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ConnectedObject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectedObject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectedObject) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectedObject) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ConnectedObject) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ConnectedObject) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ConnectedObject) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ConnectedObject) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ConnectedObject) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ConnectedObject) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConnectedObjectType.md b/docs/tools/sdk/go/Reference/V2024/Models/ConnectedObjectType.md new file mode 100644 index 000000000..912b0af57 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConnectedObjectType.md @@ -0,0 +1,25 @@ +--- +id: v2024-connected-object-type +title: ConnectedObjectType +pagination_label: ConnectedObjectType +sidebar_label: ConnectedObjectType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectedObjectType', 'V2024ConnectedObjectType'] +slug: /tools/sdk/go/v2024/models/connected-object-type +tags: ['SDK', 'Software Development Kit', 'ConnectedObjectType', 'V2024ConnectedObjectType'] +--- + +# ConnectedObjectType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + +* `SOD_POLICY` (value: `"SOD_POLICY"`) + +* `SOURCE` (value: `"SOURCE"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizerCreateRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizerCreateRequest.md new file mode 100644 index 000000000..5410d88d2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizerCreateRequest.md @@ -0,0 +1,64 @@ +--- +id: v2024-connector-customizer-create-request +title: ConnectorCustomizerCreateRequest +pagination_label: ConnectorCustomizerCreateRequest +sidebar_label: ConnectorCustomizerCreateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorCustomizerCreateRequest', 'V2024ConnectorCustomizerCreateRequest'] +slug: /tools/sdk/go/v2024/models/connector-customizer-create-request +tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerCreateRequest', 'V2024ConnectorCustomizerCreateRequest'] +--- + +# ConnectorCustomizerCreateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Connector customizer name. | [optional] + +## Methods + +### NewConnectorCustomizerCreateRequest + +`func NewConnectorCustomizerCreateRequest() *ConnectorCustomizerCreateRequest` + +NewConnectorCustomizerCreateRequest instantiates a new ConnectorCustomizerCreateRequest 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 + +### NewConnectorCustomizerCreateRequestWithDefaults + +`func NewConnectorCustomizerCreateRequestWithDefaults() *ConnectorCustomizerCreateRequest` + +NewConnectorCustomizerCreateRequestWithDefaults instantiates a new ConnectorCustomizerCreateRequest 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 + +### GetName + +`func (o *ConnectorCustomizerCreateRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorCustomizerCreateRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorCustomizerCreateRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectorCustomizerCreateRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizerCreateResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizerCreateResponse.md new file mode 100644 index 000000000..c7617162c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizerCreateResponse.md @@ -0,0 +1,142 @@ +--- +id: v2024-connector-customizer-create-response +title: ConnectorCustomizerCreateResponse +pagination_label: ConnectorCustomizerCreateResponse +sidebar_label: ConnectorCustomizerCreateResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorCustomizerCreateResponse', 'V2024ConnectorCustomizerCreateResponse'] +slug: /tools/sdk/go/v2024/models/connector-customizer-create-response +tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerCreateResponse', 'V2024ConnectorCustomizerCreateResponse'] +--- + +# ConnectorCustomizerCreateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the ID of connector customizer. | [optional] +**Name** | Pointer to **string** | name of the connector customizer. | [optional] +**TenantID** | Pointer to **string** | Connector customizer tenant id. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the connector customizer was created. | [optional] + +## Methods + +### NewConnectorCustomizerCreateResponse + +`func NewConnectorCustomizerCreateResponse() *ConnectorCustomizerCreateResponse` + +NewConnectorCustomizerCreateResponse instantiates a new ConnectorCustomizerCreateResponse 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 + +### NewConnectorCustomizerCreateResponseWithDefaults + +`func NewConnectorCustomizerCreateResponseWithDefaults() *ConnectorCustomizerCreateResponse` + +NewConnectorCustomizerCreateResponseWithDefaults instantiates a new ConnectorCustomizerCreateResponse 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 + +### GetId + +`func (o *ConnectorCustomizerCreateResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ConnectorCustomizerCreateResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ConnectorCustomizerCreateResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ConnectorCustomizerCreateResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ConnectorCustomizerCreateResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorCustomizerCreateResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorCustomizerCreateResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectorCustomizerCreateResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetTenantID + +`func (o *ConnectorCustomizerCreateResponse) GetTenantID() string` + +GetTenantID returns the TenantID field if non-nil, zero value otherwise. + +### GetTenantIDOk + +`func (o *ConnectorCustomizerCreateResponse) GetTenantIDOk() (*string, bool)` + +GetTenantIDOk returns a tuple with the TenantID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenantID + +`func (o *ConnectorCustomizerCreateResponse) SetTenantID(v string)` + +SetTenantID sets TenantID field to given value. + +### HasTenantID + +`func (o *ConnectorCustomizerCreateResponse) HasTenantID() bool` + +HasTenantID returns a boolean if a field has been set. + +### GetCreated + +`func (o *ConnectorCustomizerCreateResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ConnectorCustomizerCreateResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ConnectorCustomizerCreateResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ConnectorCustomizerCreateResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizerUpdateRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizerUpdateRequest.md new file mode 100644 index 000000000..8bfa6a325 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizerUpdateRequest.md @@ -0,0 +1,64 @@ +--- +id: v2024-connector-customizer-update-request +title: ConnectorCustomizerUpdateRequest +pagination_label: ConnectorCustomizerUpdateRequest +sidebar_label: ConnectorCustomizerUpdateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorCustomizerUpdateRequest', 'V2024ConnectorCustomizerUpdateRequest'] +slug: /tools/sdk/go/v2024/models/connector-customizer-update-request +tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerUpdateRequest', 'V2024ConnectorCustomizerUpdateRequest'] +--- + +# ConnectorCustomizerUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Connector customizer name. | [optional] + +## Methods + +### NewConnectorCustomizerUpdateRequest + +`func NewConnectorCustomizerUpdateRequest() *ConnectorCustomizerUpdateRequest` + +NewConnectorCustomizerUpdateRequest instantiates a new ConnectorCustomizerUpdateRequest 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 + +### NewConnectorCustomizerUpdateRequestWithDefaults + +`func NewConnectorCustomizerUpdateRequestWithDefaults() *ConnectorCustomizerUpdateRequest` + +NewConnectorCustomizerUpdateRequestWithDefaults instantiates a new ConnectorCustomizerUpdateRequest 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 + +### GetName + +`func (o *ConnectorCustomizerUpdateRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorCustomizerUpdateRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorCustomizerUpdateRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectorCustomizerUpdateRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizerUpdateResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizerUpdateResponse.md new file mode 100644 index 000000000..378b1a648 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizerUpdateResponse.md @@ -0,0 +1,194 @@ +--- +id: v2024-connector-customizer-update-response +title: ConnectorCustomizerUpdateResponse +pagination_label: ConnectorCustomizerUpdateResponse +sidebar_label: ConnectorCustomizerUpdateResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorCustomizerUpdateResponse', 'V2024ConnectorCustomizerUpdateResponse'] +slug: /tools/sdk/go/v2024/models/connector-customizer-update-response +tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerUpdateResponse', 'V2024ConnectorCustomizerUpdateResponse'] +--- + +# ConnectorCustomizerUpdateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the ID of connector customizer. | [optional] +**Name** | Pointer to **string** | name of the connector customizer. | [optional] +**TenantID** | Pointer to **string** | Connector customizer tenant id. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the connector customizer was created. | [optional] +**ImageVersion** | Pointer to **int64** | Connector customizer image version. | [optional] +**ImageID** | Pointer to **string** | Connector customizer image id. | [optional] + +## Methods + +### NewConnectorCustomizerUpdateResponse + +`func NewConnectorCustomizerUpdateResponse() *ConnectorCustomizerUpdateResponse` + +NewConnectorCustomizerUpdateResponse instantiates a new ConnectorCustomizerUpdateResponse 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 + +### NewConnectorCustomizerUpdateResponseWithDefaults + +`func NewConnectorCustomizerUpdateResponseWithDefaults() *ConnectorCustomizerUpdateResponse` + +NewConnectorCustomizerUpdateResponseWithDefaults instantiates a new ConnectorCustomizerUpdateResponse 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 + +### GetId + +`func (o *ConnectorCustomizerUpdateResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ConnectorCustomizerUpdateResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ConnectorCustomizerUpdateResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ConnectorCustomizerUpdateResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ConnectorCustomizerUpdateResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorCustomizerUpdateResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorCustomizerUpdateResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectorCustomizerUpdateResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetTenantID + +`func (o *ConnectorCustomizerUpdateResponse) GetTenantID() string` + +GetTenantID returns the TenantID field if non-nil, zero value otherwise. + +### GetTenantIDOk + +`func (o *ConnectorCustomizerUpdateResponse) GetTenantIDOk() (*string, bool)` + +GetTenantIDOk returns a tuple with the TenantID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenantID + +`func (o *ConnectorCustomizerUpdateResponse) SetTenantID(v string)` + +SetTenantID sets TenantID field to given value. + +### HasTenantID + +`func (o *ConnectorCustomizerUpdateResponse) HasTenantID() bool` + +HasTenantID returns a boolean if a field has been set. + +### GetCreated + +`func (o *ConnectorCustomizerUpdateResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ConnectorCustomizerUpdateResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ConnectorCustomizerUpdateResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ConnectorCustomizerUpdateResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetImageVersion + +`func (o *ConnectorCustomizerUpdateResponse) GetImageVersion() int64` + +GetImageVersion returns the ImageVersion field if non-nil, zero value otherwise. + +### GetImageVersionOk + +`func (o *ConnectorCustomizerUpdateResponse) GetImageVersionOk() (*int64, bool)` + +GetImageVersionOk returns a tuple with the ImageVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImageVersion + +`func (o *ConnectorCustomizerUpdateResponse) SetImageVersion(v int64)` + +SetImageVersion sets ImageVersion field to given value. + +### HasImageVersion + +`func (o *ConnectorCustomizerUpdateResponse) HasImageVersion() bool` + +HasImageVersion returns a boolean if a field has been set. + +### GetImageID + +`func (o *ConnectorCustomizerUpdateResponse) GetImageID() string` + +GetImageID returns the ImageID field if non-nil, zero value otherwise. + +### GetImageIDOk + +`func (o *ConnectorCustomizerUpdateResponse) GetImageIDOk() (*string, bool)` + +GetImageIDOk returns a tuple with the ImageID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImageID + +`func (o *ConnectorCustomizerUpdateResponse) SetImageID(v string)` + +SetImageID sets ImageID field to given value. + +### HasImageID + +`func (o *ConnectorCustomizerUpdateResponse) HasImageID() bool` + +HasImageID returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizerVersionCreateResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizerVersionCreateResponse.md new file mode 100644 index 000000000..d60f018ad --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizerVersionCreateResponse.md @@ -0,0 +1,142 @@ +--- +id: v2024-connector-customizer-version-create-response +title: ConnectorCustomizerVersionCreateResponse +pagination_label: ConnectorCustomizerVersionCreateResponse +sidebar_label: ConnectorCustomizerVersionCreateResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorCustomizerVersionCreateResponse', 'V2024ConnectorCustomizerVersionCreateResponse'] +slug: /tools/sdk/go/v2024/models/connector-customizer-version-create-response +tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerVersionCreateResponse', 'V2024ConnectorCustomizerVersionCreateResponse'] +--- + +# ConnectorCustomizerVersionCreateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomizerID** | Pointer to **string** | ID of connector customizer. | [optional] +**ImageID** | Pointer to **string** | ImageID of the connector customizer. | [optional] +**Version** | Pointer to **int64** | Image version of the connector customizer. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the connector customizer version was created. | [optional] + +## Methods + +### NewConnectorCustomizerVersionCreateResponse + +`func NewConnectorCustomizerVersionCreateResponse() *ConnectorCustomizerVersionCreateResponse` + +NewConnectorCustomizerVersionCreateResponse instantiates a new ConnectorCustomizerVersionCreateResponse 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 + +### NewConnectorCustomizerVersionCreateResponseWithDefaults + +`func NewConnectorCustomizerVersionCreateResponseWithDefaults() *ConnectorCustomizerVersionCreateResponse` + +NewConnectorCustomizerVersionCreateResponseWithDefaults instantiates a new ConnectorCustomizerVersionCreateResponse 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 + +### GetCustomizerID + +`func (o *ConnectorCustomizerVersionCreateResponse) GetCustomizerID() string` + +GetCustomizerID returns the CustomizerID field if non-nil, zero value otherwise. + +### GetCustomizerIDOk + +`func (o *ConnectorCustomizerVersionCreateResponse) GetCustomizerIDOk() (*string, bool)` + +GetCustomizerIDOk returns a tuple with the CustomizerID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomizerID + +`func (o *ConnectorCustomizerVersionCreateResponse) SetCustomizerID(v string)` + +SetCustomizerID sets CustomizerID field to given value. + +### HasCustomizerID + +`func (o *ConnectorCustomizerVersionCreateResponse) HasCustomizerID() bool` + +HasCustomizerID returns a boolean if a field has been set. + +### GetImageID + +`func (o *ConnectorCustomizerVersionCreateResponse) GetImageID() string` + +GetImageID returns the ImageID field if non-nil, zero value otherwise. + +### GetImageIDOk + +`func (o *ConnectorCustomizerVersionCreateResponse) GetImageIDOk() (*string, bool)` + +GetImageIDOk returns a tuple with the ImageID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImageID + +`func (o *ConnectorCustomizerVersionCreateResponse) SetImageID(v string)` + +SetImageID sets ImageID field to given value. + +### HasImageID + +`func (o *ConnectorCustomizerVersionCreateResponse) HasImageID() bool` + +HasImageID returns a boolean if a field has been set. + +### GetVersion + +`func (o *ConnectorCustomizerVersionCreateResponse) GetVersion() int64` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ConnectorCustomizerVersionCreateResponse) GetVersionOk() (*int64, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ConnectorCustomizerVersionCreateResponse) SetVersion(v int64)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *ConnectorCustomizerVersionCreateResponse) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### GetCreated + +`func (o *ConnectorCustomizerVersionCreateResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ConnectorCustomizerVersionCreateResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ConnectorCustomizerVersionCreateResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ConnectorCustomizerVersionCreateResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizersResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizersResponse.md new file mode 100644 index 000000000..9e70d6369 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorCustomizersResponse.md @@ -0,0 +1,194 @@ +--- +id: v2024-connector-customizers-response +title: ConnectorCustomizersResponse +pagination_label: ConnectorCustomizersResponse +sidebar_label: ConnectorCustomizersResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorCustomizersResponse', 'V2024ConnectorCustomizersResponse'] +slug: /tools/sdk/go/v2024/models/connector-customizers-response +tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizersResponse', 'V2024ConnectorCustomizersResponse'] +--- + +# ConnectorCustomizersResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Connector customizer ID. | [optional] [readonly] +**Name** | Pointer to **string** | Connector customizer name. | [optional] +**ImageVersion** | Pointer to **int64** | Connector customizer image version. | [optional] +**ImageID** | Pointer to **string** | Connector customizer image id. | [optional] +**TenantID** | Pointer to **string** | Connector customizer tenant id. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the connector customizer was created | [optional] + +## Methods + +### NewConnectorCustomizersResponse + +`func NewConnectorCustomizersResponse() *ConnectorCustomizersResponse` + +NewConnectorCustomizersResponse instantiates a new ConnectorCustomizersResponse 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 + +### NewConnectorCustomizersResponseWithDefaults + +`func NewConnectorCustomizersResponseWithDefaults() *ConnectorCustomizersResponse` + +NewConnectorCustomizersResponseWithDefaults instantiates a new ConnectorCustomizersResponse 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 + +### GetId + +`func (o *ConnectorCustomizersResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ConnectorCustomizersResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ConnectorCustomizersResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ConnectorCustomizersResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ConnectorCustomizersResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorCustomizersResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorCustomizersResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectorCustomizersResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetImageVersion + +`func (o *ConnectorCustomizersResponse) GetImageVersion() int64` + +GetImageVersion returns the ImageVersion field if non-nil, zero value otherwise. + +### GetImageVersionOk + +`func (o *ConnectorCustomizersResponse) GetImageVersionOk() (*int64, bool)` + +GetImageVersionOk returns a tuple with the ImageVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImageVersion + +`func (o *ConnectorCustomizersResponse) SetImageVersion(v int64)` + +SetImageVersion sets ImageVersion field to given value. + +### HasImageVersion + +`func (o *ConnectorCustomizersResponse) HasImageVersion() bool` + +HasImageVersion returns a boolean if a field has been set. + +### GetImageID + +`func (o *ConnectorCustomizersResponse) GetImageID() string` + +GetImageID returns the ImageID field if non-nil, zero value otherwise. + +### GetImageIDOk + +`func (o *ConnectorCustomizersResponse) GetImageIDOk() (*string, bool)` + +GetImageIDOk returns a tuple with the ImageID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImageID + +`func (o *ConnectorCustomizersResponse) SetImageID(v string)` + +SetImageID sets ImageID field to given value. + +### HasImageID + +`func (o *ConnectorCustomizersResponse) HasImageID() bool` + +HasImageID returns a boolean if a field has been set. + +### GetTenantID + +`func (o *ConnectorCustomizersResponse) GetTenantID() string` + +GetTenantID returns the TenantID field if non-nil, zero value otherwise. + +### GetTenantIDOk + +`func (o *ConnectorCustomizersResponse) GetTenantIDOk() (*string, bool)` + +GetTenantIDOk returns a tuple with the TenantID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenantID + +`func (o *ConnectorCustomizersResponse) SetTenantID(v string)` + +SetTenantID sets TenantID field to given value. + +### HasTenantID + +`func (o *ConnectorCustomizersResponse) HasTenantID() bool` + +HasTenantID returns a boolean if a field has been set. + +### GetCreated + +`func (o *ConnectorCustomizersResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ConnectorCustomizersResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ConnectorCustomizersResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ConnectorCustomizersResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConnectorDetail.md b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorDetail.md new file mode 100644 index 000000000..e0eb15047 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorDetail.md @@ -0,0 +1,484 @@ +--- +id: v2024-connector-detail +title: ConnectorDetail +pagination_label: ConnectorDetail +sidebar_label: ConnectorDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorDetail', 'V2024ConnectorDetail'] +slug: /tools/sdk/go/v2024/models/connector-detail +tags: ['SDK', 'Software Development Kit', 'ConnectorDetail', 'V2024ConnectorDetail'] +--- + +# ConnectorDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The connector name | [optional] +**Type** | Pointer to **string** | The connector type | [optional] +**ClassName** | Pointer to **string** | The connector class name | [optional] +**ScriptName** | Pointer to **string** | The connector script name | [optional] +**ApplicationXml** | Pointer to **string** | The connector application xml | [optional] +**CorrelationConfigXml** | Pointer to **string** | The connector correlation config xml | [optional] +**SourceConfigXml** | Pointer to **string** | The connector source config xml | [optional] +**SourceConfig** | Pointer to **NullableString** | The connector source config | [optional] +**SourceConfigFrom** | Pointer to **NullableString** | The connector source config origin | [optional] +**S3Location** | Pointer to **string** | storage path key for this connector | [optional] +**UploadedFiles** | Pointer to **[]string** | The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. | [optional] +**FileUpload** | Pointer to **bool** | true if the source is file upload | [optional] [default to false] +**DirectConnect** | Pointer to **bool** | true if the source is a direct connect source | [optional] [default to false] +**TranslationProperties** | Pointer to **map[string]interface{}** | A map containing translation attributes by loacale key | [optional] +**ConnectorMetadata** | Pointer to **map[string]interface{}** | A map containing metadata pertinent to the UI to be used | [optional] +**Status** | Pointer to **string** | The connector status | [optional] + +## Methods + +### NewConnectorDetail + +`func NewConnectorDetail() *ConnectorDetail` + +NewConnectorDetail instantiates a new ConnectorDetail 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 + +### NewConnectorDetailWithDefaults + +`func NewConnectorDetailWithDefaults() *ConnectorDetail` + +NewConnectorDetailWithDefaults instantiates a new ConnectorDetail 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 + +### GetName + +`func (o *ConnectorDetail) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorDetail) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorDetail) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectorDetail) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *ConnectorDetail) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ConnectorDetail) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ConnectorDetail) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ConnectorDetail) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetClassName + +`func (o *ConnectorDetail) GetClassName() string` + +GetClassName returns the ClassName field if non-nil, zero value otherwise. + +### GetClassNameOk + +`func (o *ConnectorDetail) GetClassNameOk() (*string, bool)` + +GetClassNameOk returns a tuple with the ClassName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClassName + +`func (o *ConnectorDetail) SetClassName(v string)` + +SetClassName sets ClassName field to given value. + +### HasClassName + +`func (o *ConnectorDetail) HasClassName() bool` + +HasClassName returns a boolean if a field has been set. + +### GetScriptName + +`func (o *ConnectorDetail) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *ConnectorDetail) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *ConnectorDetail) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + +### HasScriptName + +`func (o *ConnectorDetail) HasScriptName() bool` + +HasScriptName returns a boolean if a field has been set. + +### GetApplicationXml + +`func (o *ConnectorDetail) GetApplicationXml() string` + +GetApplicationXml returns the ApplicationXml field if non-nil, zero value otherwise. + +### GetApplicationXmlOk + +`func (o *ConnectorDetail) GetApplicationXmlOk() (*string, bool)` + +GetApplicationXmlOk returns a tuple with the ApplicationXml field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationXml + +`func (o *ConnectorDetail) SetApplicationXml(v string)` + +SetApplicationXml sets ApplicationXml field to given value. + +### HasApplicationXml + +`func (o *ConnectorDetail) HasApplicationXml() bool` + +HasApplicationXml returns a boolean if a field has been set. + +### GetCorrelationConfigXml + +`func (o *ConnectorDetail) GetCorrelationConfigXml() string` + +GetCorrelationConfigXml returns the CorrelationConfigXml field if non-nil, zero value otherwise. + +### GetCorrelationConfigXmlOk + +`func (o *ConnectorDetail) GetCorrelationConfigXmlOk() (*string, bool)` + +GetCorrelationConfigXmlOk returns a tuple with the CorrelationConfigXml field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelationConfigXml + +`func (o *ConnectorDetail) SetCorrelationConfigXml(v string)` + +SetCorrelationConfigXml sets CorrelationConfigXml field to given value. + +### HasCorrelationConfigXml + +`func (o *ConnectorDetail) HasCorrelationConfigXml() bool` + +HasCorrelationConfigXml returns a boolean if a field has been set. + +### GetSourceConfigXml + +`func (o *ConnectorDetail) GetSourceConfigXml() string` + +GetSourceConfigXml returns the SourceConfigXml field if non-nil, zero value otherwise. + +### GetSourceConfigXmlOk + +`func (o *ConnectorDetail) GetSourceConfigXmlOk() (*string, bool)` + +GetSourceConfigXmlOk returns a tuple with the SourceConfigXml field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceConfigXml + +`func (o *ConnectorDetail) SetSourceConfigXml(v string)` + +SetSourceConfigXml sets SourceConfigXml field to given value. + +### HasSourceConfigXml + +`func (o *ConnectorDetail) HasSourceConfigXml() bool` + +HasSourceConfigXml returns a boolean if a field has been set. + +### GetSourceConfig + +`func (o *ConnectorDetail) GetSourceConfig() string` + +GetSourceConfig returns the SourceConfig field if non-nil, zero value otherwise. + +### GetSourceConfigOk + +`func (o *ConnectorDetail) GetSourceConfigOk() (*string, bool)` + +GetSourceConfigOk returns a tuple with the SourceConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceConfig + +`func (o *ConnectorDetail) SetSourceConfig(v string)` + +SetSourceConfig sets SourceConfig field to given value. + +### HasSourceConfig + +`func (o *ConnectorDetail) HasSourceConfig() bool` + +HasSourceConfig returns a boolean if a field has been set. + +### SetSourceConfigNil + +`func (o *ConnectorDetail) SetSourceConfigNil(b bool)` + + SetSourceConfigNil sets the value for SourceConfig to be an explicit nil + +### UnsetSourceConfig +`func (o *ConnectorDetail) UnsetSourceConfig()` + +UnsetSourceConfig ensures that no value is present for SourceConfig, not even an explicit nil +### GetSourceConfigFrom + +`func (o *ConnectorDetail) GetSourceConfigFrom() string` + +GetSourceConfigFrom returns the SourceConfigFrom field if non-nil, zero value otherwise. + +### GetSourceConfigFromOk + +`func (o *ConnectorDetail) GetSourceConfigFromOk() (*string, bool)` + +GetSourceConfigFromOk returns a tuple with the SourceConfigFrom field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceConfigFrom + +`func (o *ConnectorDetail) SetSourceConfigFrom(v string)` + +SetSourceConfigFrom sets SourceConfigFrom field to given value. + +### HasSourceConfigFrom + +`func (o *ConnectorDetail) HasSourceConfigFrom() bool` + +HasSourceConfigFrom returns a boolean if a field has been set. + +### SetSourceConfigFromNil + +`func (o *ConnectorDetail) SetSourceConfigFromNil(b bool)` + + SetSourceConfigFromNil sets the value for SourceConfigFrom to be an explicit nil + +### UnsetSourceConfigFrom +`func (o *ConnectorDetail) UnsetSourceConfigFrom()` + +UnsetSourceConfigFrom ensures that no value is present for SourceConfigFrom, not even an explicit nil +### GetS3Location + +`func (o *ConnectorDetail) GetS3Location() string` + +GetS3Location returns the S3Location field if non-nil, zero value otherwise. + +### GetS3LocationOk + +`func (o *ConnectorDetail) GetS3LocationOk() (*string, bool)` + +GetS3LocationOk returns a tuple with the S3Location field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetS3Location + +`func (o *ConnectorDetail) SetS3Location(v string)` + +SetS3Location sets S3Location field to given value. + +### HasS3Location + +`func (o *ConnectorDetail) HasS3Location() bool` + +HasS3Location returns a boolean if a field has been set. + +### GetUploadedFiles + +`func (o *ConnectorDetail) GetUploadedFiles() []string` + +GetUploadedFiles returns the UploadedFiles field if non-nil, zero value otherwise. + +### GetUploadedFilesOk + +`func (o *ConnectorDetail) GetUploadedFilesOk() (*[]string, bool)` + +GetUploadedFilesOk returns a tuple with the UploadedFiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUploadedFiles + +`func (o *ConnectorDetail) SetUploadedFiles(v []string)` + +SetUploadedFiles sets UploadedFiles field to given value. + +### HasUploadedFiles + +`func (o *ConnectorDetail) HasUploadedFiles() bool` + +HasUploadedFiles returns a boolean if a field has been set. + +### SetUploadedFilesNil + +`func (o *ConnectorDetail) SetUploadedFilesNil(b bool)` + + SetUploadedFilesNil sets the value for UploadedFiles to be an explicit nil + +### UnsetUploadedFiles +`func (o *ConnectorDetail) UnsetUploadedFiles()` + +UnsetUploadedFiles ensures that no value is present for UploadedFiles, not even an explicit nil +### GetFileUpload + +`func (o *ConnectorDetail) GetFileUpload() bool` + +GetFileUpload returns the FileUpload field if non-nil, zero value otherwise. + +### GetFileUploadOk + +`func (o *ConnectorDetail) GetFileUploadOk() (*bool, bool)` + +GetFileUploadOk returns a tuple with the FileUpload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileUpload + +`func (o *ConnectorDetail) SetFileUpload(v bool)` + +SetFileUpload sets FileUpload field to given value. + +### HasFileUpload + +`func (o *ConnectorDetail) HasFileUpload() bool` + +HasFileUpload returns a boolean if a field has been set. + +### GetDirectConnect + +`func (o *ConnectorDetail) GetDirectConnect() bool` + +GetDirectConnect returns the DirectConnect field if non-nil, zero value otherwise. + +### GetDirectConnectOk + +`func (o *ConnectorDetail) GetDirectConnectOk() (*bool, bool)` + +GetDirectConnectOk returns a tuple with the DirectConnect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectConnect + +`func (o *ConnectorDetail) SetDirectConnect(v bool)` + +SetDirectConnect sets DirectConnect field to given value. + +### HasDirectConnect + +`func (o *ConnectorDetail) HasDirectConnect() bool` + +HasDirectConnect returns a boolean if a field has been set. + +### GetTranslationProperties + +`func (o *ConnectorDetail) GetTranslationProperties() map[string]interface{}` + +GetTranslationProperties returns the TranslationProperties field if non-nil, zero value otherwise. + +### GetTranslationPropertiesOk + +`func (o *ConnectorDetail) GetTranslationPropertiesOk() (*map[string]interface{}, bool)` + +GetTranslationPropertiesOk returns a tuple with the TranslationProperties field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslationProperties + +`func (o *ConnectorDetail) SetTranslationProperties(v map[string]interface{})` + +SetTranslationProperties sets TranslationProperties field to given value. + +### HasTranslationProperties + +`func (o *ConnectorDetail) HasTranslationProperties() bool` + +HasTranslationProperties returns a boolean if a field has been set. + +### GetConnectorMetadata + +`func (o *ConnectorDetail) GetConnectorMetadata() map[string]interface{}` + +GetConnectorMetadata returns the ConnectorMetadata field if non-nil, zero value otherwise. + +### GetConnectorMetadataOk + +`func (o *ConnectorDetail) GetConnectorMetadataOk() (*map[string]interface{}, bool)` + +GetConnectorMetadataOk returns a tuple with the ConnectorMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorMetadata + +`func (o *ConnectorDetail) SetConnectorMetadata(v map[string]interface{})` + +SetConnectorMetadata sets ConnectorMetadata field to given value. + +### HasConnectorMetadata + +`func (o *ConnectorDetail) HasConnectorMetadata() bool` + +HasConnectorMetadata returns a boolean if a field has been set. + +### GetStatus + +`func (o *ConnectorDetail) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ConnectorDetail) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ConnectorDetail) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ConnectorDetail) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleCreateRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleCreateRequest.md new file mode 100644 index 000000000..1b118a30b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleCreateRequest.md @@ -0,0 +1,199 @@ +--- +id: v2024-connector-rule-create-request +title: ConnectorRuleCreateRequest +pagination_label: ConnectorRuleCreateRequest +sidebar_label: ConnectorRuleCreateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleCreateRequest', 'V2024ConnectorRuleCreateRequest'] +slug: /tools/sdk/go/v2024/models/connector-rule-create-request +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleCreateRequest', 'V2024ConnectorRuleCreateRequest'] +--- + +# ConnectorRuleCreateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | the name of the rule | +**Description** | Pointer to **NullableString** | a description of the rule's purpose | [optional] +**Type** | **string** | the type of rule | +**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**SourceCode** | [**SourceCode**](source-code) | | +**Attributes** | Pointer to **map[string]interface{}** | a map of string to objects | [optional] + +## Methods + +### NewConnectorRuleCreateRequest + +`func NewConnectorRuleCreateRequest(name string, type_ string, sourceCode SourceCode, ) *ConnectorRuleCreateRequest` + +NewConnectorRuleCreateRequest instantiates a new ConnectorRuleCreateRequest 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 + +### NewConnectorRuleCreateRequestWithDefaults + +`func NewConnectorRuleCreateRequestWithDefaults() *ConnectorRuleCreateRequest` + +NewConnectorRuleCreateRequestWithDefaults instantiates a new ConnectorRuleCreateRequest 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 + +### GetName + +`func (o *ConnectorRuleCreateRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorRuleCreateRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorRuleCreateRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *ConnectorRuleCreateRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ConnectorRuleCreateRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ConnectorRuleCreateRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ConnectorRuleCreateRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ConnectorRuleCreateRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ConnectorRuleCreateRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *ConnectorRuleCreateRequest) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ConnectorRuleCreateRequest) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ConnectorRuleCreateRequest) SetType(v string)` + +SetType sets Type field to given value. + + +### GetSignature + +`func (o *ConnectorRuleCreateRequest) GetSignature() ConnectorRuleCreateRequestSignature` + +GetSignature returns the Signature field if non-nil, zero value otherwise. + +### GetSignatureOk + +`func (o *ConnectorRuleCreateRequest) GetSignatureOk() (*ConnectorRuleCreateRequestSignature, bool)` + +GetSignatureOk returns a tuple with the Signature field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignature + +`func (o *ConnectorRuleCreateRequest) SetSignature(v ConnectorRuleCreateRequestSignature)` + +SetSignature sets Signature field to given value. + +### HasSignature + +`func (o *ConnectorRuleCreateRequest) HasSignature() bool` + +HasSignature returns a boolean if a field has been set. + +### GetSourceCode + +`func (o *ConnectorRuleCreateRequest) GetSourceCode() SourceCode` + +GetSourceCode returns the SourceCode field if non-nil, zero value otherwise. + +### GetSourceCodeOk + +`func (o *ConnectorRuleCreateRequest) GetSourceCodeOk() (*SourceCode, bool)` + +GetSourceCodeOk returns a tuple with the SourceCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceCode + +`func (o *ConnectorRuleCreateRequest) SetSourceCode(v SourceCode)` + +SetSourceCode sets SourceCode field to given value. + + +### GetAttributes + +`func (o *ConnectorRuleCreateRequest) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ConnectorRuleCreateRequest) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ConnectorRuleCreateRequest) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ConnectorRuleCreateRequest) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *ConnectorRuleCreateRequest) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *ConnectorRuleCreateRequest) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleCreateRequestSignature.md b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleCreateRequestSignature.md new file mode 100644 index 000000000..1ef073b0d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleCreateRequestSignature.md @@ -0,0 +1,95 @@ +--- +id: v2024-connector-rule-create-request-signature +title: ConnectorRuleCreateRequestSignature +pagination_label: ConnectorRuleCreateRequestSignature +sidebar_label: ConnectorRuleCreateRequestSignature +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleCreateRequestSignature', 'V2024ConnectorRuleCreateRequestSignature'] +slug: /tools/sdk/go/v2024/models/connector-rule-create-request-signature +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleCreateRequestSignature', 'V2024ConnectorRuleCreateRequestSignature'] +--- + +# ConnectorRuleCreateRequestSignature + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | [**[]Argument**](argument) | | +**Output** | Pointer to [**NullableArgument**](argument) | | [optional] + +## Methods + +### NewConnectorRuleCreateRequestSignature + +`func NewConnectorRuleCreateRequestSignature(input []Argument, ) *ConnectorRuleCreateRequestSignature` + +NewConnectorRuleCreateRequestSignature instantiates a new ConnectorRuleCreateRequestSignature 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 + +### NewConnectorRuleCreateRequestSignatureWithDefaults + +`func NewConnectorRuleCreateRequestSignatureWithDefaults() *ConnectorRuleCreateRequestSignature` + +NewConnectorRuleCreateRequestSignatureWithDefaults instantiates a new ConnectorRuleCreateRequestSignature 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 + +### GetInput + +`func (o *ConnectorRuleCreateRequestSignature) GetInput() []Argument` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *ConnectorRuleCreateRequestSignature) GetInputOk() (*[]Argument, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *ConnectorRuleCreateRequestSignature) SetInput(v []Argument)` + +SetInput sets Input field to given value. + + +### GetOutput + +`func (o *ConnectorRuleCreateRequestSignature) GetOutput() Argument` + +GetOutput returns the Output field if non-nil, zero value otherwise. + +### GetOutputOk + +`func (o *ConnectorRuleCreateRequestSignature) GetOutputOk() (*Argument, bool)` + +GetOutputOk returns a tuple with the Output field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutput + +`func (o *ConnectorRuleCreateRequestSignature) SetOutput(v Argument)` + +SetOutput sets Output field to given value. + +### HasOutput + +`func (o *ConnectorRuleCreateRequestSignature) HasOutput() bool` + +HasOutput returns a boolean if a field has been set. + +### SetOutputNil + +`func (o *ConnectorRuleCreateRequestSignature) SetOutputNil(b bool)` + + SetOutputNil sets the value for Output to be an explicit nil + +### UnsetOutput +`func (o *ConnectorRuleCreateRequestSignature) UnsetOutput()` + +UnsetOutput ensures that no value is present for Output, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleResponse.md new file mode 100644 index 000000000..b3e5cec9f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleResponse.md @@ -0,0 +1,277 @@ +--- +id: v2024-connector-rule-response +title: ConnectorRuleResponse +pagination_label: ConnectorRuleResponse +sidebar_label: ConnectorRuleResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleResponse', 'V2024ConnectorRuleResponse'] +slug: /tools/sdk/go/v2024/models/connector-rule-response +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleResponse', 'V2024ConnectorRuleResponse'] +--- + +# ConnectorRuleResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | the name of the rule | +**Description** | Pointer to **NullableString** | a description of the rule's purpose | [optional] +**Type** | **string** | the type of rule | +**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**SourceCode** | [**SourceCode**](source-code) | | +**Attributes** | Pointer to **map[string]interface{}** | a map of string to objects | [optional] +**Id** | **string** | the ID of the rule | +**Created** | **string** | an ISO 8601 UTC timestamp when this rule was created | +**Modified** | Pointer to **NullableString** | an ISO 8601 UTC timestamp when this rule was last modified | [optional] + +## Methods + +### NewConnectorRuleResponse + +`func NewConnectorRuleResponse(name string, type_ string, sourceCode SourceCode, id string, created string, ) *ConnectorRuleResponse` + +NewConnectorRuleResponse instantiates a new ConnectorRuleResponse 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 + +### NewConnectorRuleResponseWithDefaults + +`func NewConnectorRuleResponseWithDefaults() *ConnectorRuleResponse` + +NewConnectorRuleResponseWithDefaults instantiates a new ConnectorRuleResponse 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 + +### GetName + +`func (o *ConnectorRuleResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorRuleResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorRuleResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *ConnectorRuleResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ConnectorRuleResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ConnectorRuleResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ConnectorRuleResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ConnectorRuleResponse) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ConnectorRuleResponse) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *ConnectorRuleResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ConnectorRuleResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ConnectorRuleResponse) SetType(v string)` + +SetType sets Type field to given value. + + +### GetSignature + +`func (o *ConnectorRuleResponse) GetSignature() ConnectorRuleCreateRequestSignature` + +GetSignature returns the Signature field if non-nil, zero value otherwise. + +### GetSignatureOk + +`func (o *ConnectorRuleResponse) GetSignatureOk() (*ConnectorRuleCreateRequestSignature, bool)` + +GetSignatureOk returns a tuple with the Signature field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignature + +`func (o *ConnectorRuleResponse) SetSignature(v ConnectorRuleCreateRequestSignature)` + +SetSignature sets Signature field to given value. + +### HasSignature + +`func (o *ConnectorRuleResponse) HasSignature() bool` + +HasSignature returns a boolean if a field has been set. + +### GetSourceCode + +`func (o *ConnectorRuleResponse) GetSourceCode() SourceCode` + +GetSourceCode returns the SourceCode field if non-nil, zero value otherwise. + +### GetSourceCodeOk + +`func (o *ConnectorRuleResponse) GetSourceCodeOk() (*SourceCode, bool)` + +GetSourceCodeOk returns a tuple with the SourceCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceCode + +`func (o *ConnectorRuleResponse) SetSourceCode(v SourceCode)` + +SetSourceCode sets SourceCode field to given value. + + +### GetAttributes + +`func (o *ConnectorRuleResponse) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ConnectorRuleResponse) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ConnectorRuleResponse) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ConnectorRuleResponse) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *ConnectorRuleResponse) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *ConnectorRuleResponse) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetId + +`func (o *ConnectorRuleResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ConnectorRuleResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ConnectorRuleResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetCreated + +`func (o *ConnectorRuleResponse) GetCreated() string` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ConnectorRuleResponse) GetCreatedOk() (*string, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ConnectorRuleResponse) SetCreated(v string)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *ConnectorRuleResponse) GetModified() string` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ConnectorRuleResponse) GetModifiedOk() (*string, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ConnectorRuleResponse) SetModified(v string)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ConnectorRuleResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *ConnectorRuleResponse) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *ConnectorRuleResponse) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleUpdateRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleUpdateRequest.md new file mode 100644 index 000000000..e4a7132f9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleUpdateRequest.md @@ -0,0 +1,220 @@ +--- +id: v2024-connector-rule-update-request +title: ConnectorRuleUpdateRequest +pagination_label: ConnectorRuleUpdateRequest +sidebar_label: ConnectorRuleUpdateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleUpdateRequest', 'V2024ConnectorRuleUpdateRequest'] +slug: /tools/sdk/go/v2024/models/connector-rule-update-request +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleUpdateRequest', 'V2024ConnectorRuleUpdateRequest'] +--- + +# ConnectorRuleUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | the name of the rule | +**Description** | Pointer to **NullableString** | a description of the rule's purpose | [optional] +**Type** | **string** | the type of rule | +**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**SourceCode** | [**SourceCode**](source-code) | | +**Attributes** | Pointer to **map[string]interface{}** | a map of string to objects | [optional] +**Id** | **string** | the ID of the rule to update | + +## Methods + +### NewConnectorRuleUpdateRequest + +`func NewConnectorRuleUpdateRequest(name string, type_ string, sourceCode SourceCode, id string, ) *ConnectorRuleUpdateRequest` + +NewConnectorRuleUpdateRequest instantiates a new ConnectorRuleUpdateRequest 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 + +### NewConnectorRuleUpdateRequestWithDefaults + +`func NewConnectorRuleUpdateRequestWithDefaults() *ConnectorRuleUpdateRequest` + +NewConnectorRuleUpdateRequestWithDefaults instantiates a new ConnectorRuleUpdateRequest 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 + +### GetName + +`func (o *ConnectorRuleUpdateRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorRuleUpdateRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorRuleUpdateRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *ConnectorRuleUpdateRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ConnectorRuleUpdateRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ConnectorRuleUpdateRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ConnectorRuleUpdateRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ConnectorRuleUpdateRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ConnectorRuleUpdateRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *ConnectorRuleUpdateRequest) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ConnectorRuleUpdateRequest) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ConnectorRuleUpdateRequest) SetType(v string)` + +SetType sets Type field to given value. + + +### GetSignature + +`func (o *ConnectorRuleUpdateRequest) GetSignature() ConnectorRuleCreateRequestSignature` + +GetSignature returns the Signature field if non-nil, zero value otherwise. + +### GetSignatureOk + +`func (o *ConnectorRuleUpdateRequest) GetSignatureOk() (*ConnectorRuleCreateRequestSignature, bool)` + +GetSignatureOk returns a tuple with the Signature field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignature + +`func (o *ConnectorRuleUpdateRequest) SetSignature(v ConnectorRuleCreateRequestSignature)` + +SetSignature sets Signature field to given value. + +### HasSignature + +`func (o *ConnectorRuleUpdateRequest) HasSignature() bool` + +HasSignature returns a boolean if a field has been set. + +### GetSourceCode + +`func (o *ConnectorRuleUpdateRequest) GetSourceCode() SourceCode` + +GetSourceCode returns the SourceCode field if non-nil, zero value otherwise. + +### GetSourceCodeOk + +`func (o *ConnectorRuleUpdateRequest) GetSourceCodeOk() (*SourceCode, bool)` + +GetSourceCodeOk returns a tuple with the SourceCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceCode + +`func (o *ConnectorRuleUpdateRequest) SetSourceCode(v SourceCode)` + +SetSourceCode sets SourceCode field to given value. + + +### GetAttributes + +`func (o *ConnectorRuleUpdateRequest) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ConnectorRuleUpdateRequest) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ConnectorRuleUpdateRequest) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ConnectorRuleUpdateRequest) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *ConnectorRuleUpdateRequest) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *ConnectorRuleUpdateRequest) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetId + +`func (o *ConnectorRuleUpdateRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ConnectorRuleUpdateRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ConnectorRuleUpdateRequest) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleValidationResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleValidationResponse.md new file mode 100644 index 000000000..52fbb2a46 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleValidationResponse.md @@ -0,0 +1,80 @@ +--- +id: v2024-connector-rule-validation-response +title: ConnectorRuleValidationResponse +pagination_label: ConnectorRuleValidationResponse +sidebar_label: ConnectorRuleValidationResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleValidationResponse', 'V2024ConnectorRuleValidationResponse'] +slug: /tools/sdk/go/v2024/models/connector-rule-validation-response +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleValidationResponse', 'V2024ConnectorRuleValidationResponse'] +--- + +# ConnectorRuleValidationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | **string** | | +**Details** | [**[]ConnectorRuleValidationResponseDetailsInner**](connector-rule-validation-response-details-inner) | | + +## Methods + +### NewConnectorRuleValidationResponse + +`func NewConnectorRuleValidationResponse(state string, details []ConnectorRuleValidationResponseDetailsInner, ) *ConnectorRuleValidationResponse` + +NewConnectorRuleValidationResponse instantiates a new ConnectorRuleValidationResponse 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 + +### NewConnectorRuleValidationResponseWithDefaults + +`func NewConnectorRuleValidationResponseWithDefaults() *ConnectorRuleValidationResponse` + +NewConnectorRuleValidationResponseWithDefaults instantiates a new ConnectorRuleValidationResponse 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 + +### GetState + +`func (o *ConnectorRuleValidationResponse) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ConnectorRuleValidationResponse) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ConnectorRuleValidationResponse) SetState(v string)` + +SetState sets State field to given value. + + +### GetDetails + +`func (o *ConnectorRuleValidationResponse) GetDetails() []ConnectorRuleValidationResponseDetailsInner` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *ConnectorRuleValidationResponse) GetDetailsOk() (*[]ConnectorRuleValidationResponseDetailsInner, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *ConnectorRuleValidationResponse) SetDetails(v []ConnectorRuleValidationResponseDetailsInner)` + +SetDetails sets Details field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleValidationResponseDetailsInner.md b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleValidationResponseDetailsInner.md new file mode 100644 index 000000000..fda044cf5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ConnectorRuleValidationResponseDetailsInner.md @@ -0,0 +1,106 @@ +--- +id: v2024-connector-rule-validation-response-details-inner +title: ConnectorRuleValidationResponseDetailsInner +pagination_label: ConnectorRuleValidationResponseDetailsInner +sidebar_label: ConnectorRuleValidationResponseDetailsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleValidationResponseDetailsInner', 'V2024ConnectorRuleValidationResponseDetailsInner'] +slug: /tools/sdk/go/v2024/models/connector-rule-validation-response-details-inner +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleValidationResponseDetailsInner', 'V2024ConnectorRuleValidationResponseDetailsInner'] +--- + +# ConnectorRuleValidationResponseDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Line** | **int32** | The line number where the issue occurred | +**Column** | **int32** | the column number where the issue occurred | +**Messsage** | Pointer to **string** | a description of the issue in the code | [optional] + +## Methods + +### NewConnectorRuleValidationResponseDetailsInner + +`func NewConnectorRuleValidationResponseDetailsInner(line int32, column int32, ) *ConnectorRuleValidationResponseDetailsInner` + +NewConnectorRuleValidationResponseDetailsInner instantiates a new ConnectorRuleValidationResponseDetailsInner 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 + +### NewConnectorRuleValidationResponseDetailsInnerWithDefaults + +`func NewConnectorRuleValidationResponseDetailsInnerWithDefaults() *ConnectorRuleValidationResponseDetailsInner` + +NewConnectorRuleValidationResponseDetailsInnerWithDefaults instantiates a new ConnectorRuleValidationResponseDetailsInner 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 + +### GetLine + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetLine() int32` + +GetLine returns the Line field if non-nil, zero value otherwise. + +### GetLineOk + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetLineOk() (*int32, bool)` + +GetLineOk returns a tuple with the Line field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLine + +`func (o *ConnectorRuleValidationResponseDetailsInner) SetLine(v int32)` + +SetLine sets Line field to given value. + + +### GetColumn + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetColumn() int32` + +GetColumn returns the Column field if non-nil, zero value otherwise. + +### GetColumnOk + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetColumnOk() (*int32, bool)` + +GetColumnOk returns a tuple with the Column field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumn + +`func (o *ConnectorRuleValidationResponseDetailsInner) SetColumn(v int32)` + +SetColumn sets Column field to given value. + + +### GetMesssage + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetMesssage() string` + +GetMesssage returns the Messsage field if non-nil, zero value otherwise. + +### GetMesssageOk + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetMesssageOk() (*string, bool)` + +GetMesssageOk returns a tuple with the Messsage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMesssage + +`func (o *ConnectorRuleValidationResponseDetailsInner) SetMesssage(v string)` + +SetMesssage sets Messsage field to given value. + +### HasMesssage + +`func (o *ConnectorRuleValidationResponseDetailsInner) HasMesssage() bool` + +HasMesssage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ContextAttributeDto.md b/docs/tools/sdk/go/Reference/V2024/Models/ContextAttributeDto.md new file mode 100644 index 000000000..c336786f6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ContextAttributeDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-context-attribute-dto +title: ContextAttributeDto +pagination_label: ContextAttributeDto +sidebar_label: ContextAttributeDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ContextAttributeDto', 'V2024ContextAttributeDto'] +slug: /tools/sdk/go/v2024/models/context-attribute-dto +tags: ['SDK', 'Software Development Kit', 'ContextAttributeDto', 'V2024ContextAttributeDto'] +--- + +# ContextAttributeDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | Pointer to **string** | The name of the attribute | [optional] +**Value** | Pointer to [**ContextAttributeDtoValue**](context-attribute-dto-value) | | [optional] +**Derived** | Pointer to **bool** | True if the attribute was derived. | [optional] [default to false] + +## Methods + +### NewContextAttributeDto + +`func NewContextAttributeDto() *ContextAttributeDto` + +NewContextAttributeDto instantiates a new ContextAttributeDto 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 + +### NewContextAttributeDtoWithDefaults + +`func NewContextAttributeDtoWithDefaults() *ContextAttributeDto` + +NewContextAttributeDtoWithDefaults instantiates a new ContextAttributeDto 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 + +### GetAttribute + +`func (o *ContextAttributeDto) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ContextAttributeDto) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ContextAttributeDto) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ContextAttributeDto) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *ContextAttributeDto) GetValue() ContextAttributeDtoValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ContextAttributeDto) GetValueOk() (*ContextAttributeDtoValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ContextAttributeDto) SetValue(v ContextAttributeDtoValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ContextAttributeDto) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetDerived + +`func (o *ContextAttributeDto) GetDerived() bool` + +GetDerived returns the Derived field if non-nil, zero value otherwise. + +### GetDerivedOk + +`func (o *ContextAttributeDto) GetDerivedOk() (*bool, bool)` + +GetDerivedOk returns a tuple with the Derived field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDerived + +`func (o *ContextAttributeDto) SetDerived(v bool)` + +SetDerived sets Derived field to given value. + +### HasDerived + +`func (o *ContextAttributeDto) HasDerived() bool` + +HasDerived returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ContextAttributeDtoValue.md b/docs/tools/sdk/go/Reference/V2024/Models/ContextAttributeDtoValue.md new file mode 100644 index 000000000..d569d9b08 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ContextAttributeDtoValue.md @@ -0,0 +1,38 @@ +--- +id: v2024-context-attribute-dto-value +title: ContextAttributeDtoValue +pagination_label: ContextAttributeDtoValue +sidebar_label: ContextAttributeDtoValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ContextAttributeDtoValue', 'V2024ContextAttributeDtoValue'] +slug: /tools/sdk/go/v2024/models/context-attribute-dto-value +tags: ['SDK', 'Software Development Kit', 'ContextAttributeDtoValue', 'V2024ContextAttributeDtoValue'] +--- + +# ContextAttributeDtoValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewContextAttributeDtoValue + +`func NewContextAttributeDtoValue() *ContextAttributeDtoValue` + +NewContextAttributeDtoValue instantiates a new ContextAttributeDtoValue 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 + +### NewContextAttributeDtoValueWithDefaults + +`func NewContextAttributeDtoValueWithDefaults() *ContextAttributeDtoValue` + +NewContextAttributeDtoValueWithDefaults instantiates a new ContextAttributeDtoValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CorrelatedGovernanceEvent.md b/docs/tools/sdk/go/Reference/V2024/Models/CorrelatedGovernanceEvent.md new file mode 100644 index 000000000..cb9d9ccec --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CorrelatedGovernanceEvent.md @@ -0,0 +1,220 @@ +--- +id: v2024-correlated-governance-event +title: CorrelatedGovernanceEvent +pagination_label: CorrelatedGovernanceEvent +sidebar_label: CorrelatedGovernanceEvent +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CorrelatedGovernanceEvent', 'V2024CorrelatedGovernanceEvent'] +slug: /tools/sdk/go/v2024/models/correlated-governance-event +tags: ['SDK', 'Software Development Kit', 'CorrelatedGovernanceEvent', 'V2024CorrelatedGovernanceEvent'] +--- + +# CorrelatedGovernanceEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the governance event, such as the certification name or access request ID. | [optional] +**Dt** | Pointer to **string** | The date that the certification or access request was completed. | [optional] +**Type** | Pointer to **string** | The type of governance event. | [optional] +**GovernanceId** | Pointer to **string** | The ID of the instance that caused the event - either the certification ID or access request ID. | [optional] +**Owners** | Pointer to [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers) | [optional] +**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers), this field should be preferred over owners | [optional] +**DecisionMaker** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] + +## Methods + +### NewCorrelatedGovernanceEvent + +`func NewCorrelatedGovernanceEvent() *CorrelatedGovernanceEvent` + +NewCorrelatedGovernanceEvent instantiates a new CorrelatedGovernanceEvent 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 + +### NewCorrelatedGovernanceEventWithDefaults + +`func NewCorrelatedGovernanceEventWithDefaults() *CorrelatedGovernanceEvent` + +NewCorrelatedGovernanceEventWithDefaults instantiates a new CorrelatedGovernanceEvent 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 + +### GetName + +`func (o *CorrelatedGovernanceEvent) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CorrelatedGovernanceEvent) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CorrelatedGovernanceEvent) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CorrelatedGovernanceEvent) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDt + +`func (o *CorrelatedGovernanceEvent) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *CorrelatedGovernanceEvent) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *CorrelatedGovernanceEvent) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *CorrelatedGovernanceEvent) HasDt() bool` + +HasDt returns a boolean if a field has been set. + +### GetType + +`func (o *CorrelatedGovernanceEvent) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CorrelatedGovernanceEvent) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CorrelatedGovernanceEvent) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CorrelatedGovernanceEvent) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetGovernanceId + +`func (o *CorrelatedGovernanceEvent) GetGovernanceId() string` + +GetGovernanceId returns the GovernanceId field if non-nil, zero value otherwise. + +### GetGovernanceIdOk + +`func (o *CorrelatedGovernanceEvent) GetGovernanceIdOk() (*string, bool)` + +GetGovernanceIdOk returns a tuple with the GovernanceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceId + +`func (o *CorrelatedGovernanceEvent) SetGovernanceId(v string)` + +SetGovernanceId sets GovernanceId field to given value. + +### HasGovernanceId + +`func (o *CorrelatedGovernanceEvent) HasGovernanceId() bool` + +HasGovernanceId returns a boolean if a field has been set. + +### GetOwners + +`func (o *CorrelatedGovernanceEvent) GetOwners() []CertifierResponse` + +GetOwners returns the Owners field if non-nil, zero value otherwise. + +### GetOwnersOk + +`func (o *CorrelatedGovernanceEvent) GetOwnersOk() (*[]CertifierResponse, bool)` + +GetOwnersOk returns a tuple with the Owners field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwners + +`func (o *CorrelatedGovernanceEvent) SetOwners(v []CertifierResponse)` + +SetOwners sets Owners field to given value. + +### HasOwners + +`func (o *CorrelatedGovernanceEvent) HasOwners() bool` + +HasOwners returns a boolean if a field has been set. + +### GetReviewers + +`func (o *CorrelatedGovernanceEvent) GetReviewers() []CertifierResponse` + +GetReviewers returns the Reviewers field if non-nil, zero value otherwise. + +### GetReviewersOk + +`func (o *CorrelatedGovernanceEvent) GetReviewersOk() (*[]CertifierResponse, bool)` + +GetReviewersOk returns a tuple with the Reviewers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewers + +`func (o *CorrelatedGovernanceEvent) SetReviewers(v []CertifierResponse)` + +SetReviewers sets Reviewers field to given value. + +### HasReviewers + +`func (o *CorrelatedGovernanceEvent) HasReviewers() bool` + +HasReviewers returns a boolean if a field has been set. + +### GetDecisionMaker + +`func (o *CorrelatedGovernanceEvent) GetDecisionMaker() CertifierResponse` + +GetDecisionMaker returns the DecisionMaker field if non-nil, zero value otherwise. + +### GetDecisionMakerOk + +`func (o *CorrelatedGovernanceEvent) GetDecisionMakerOk() (*CertifierResponse, bool)` + +GetDecisionMakerOk returns a tuple with the DecisionMaker field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionMaker + +`func (o *CorrelatedGovernanceEvent) SetDecisionMaker(v CertifierResponse)` + +SetDecisionMaker sets DecisionMaker field to given value. + +### HasDecisionMaker + +`func (o *CorrelatedGovernanceEvent) HasDecisionMaker() bool` + +HasDecisionMaker returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CorrelationConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/CorrelationConfig.md new file mode 100644 index 000000000..52105b3d6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CorrelationConfig.md @@ -0,0 +1,146 @@ +--- +id: v2024-correlation-config +title: CorrelationConfig +pagination_label: CorrelationConfig +sidebar_label: CorrelationConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CorrelationConfig', 'V2024CorrelationConfig'] +slug: /tools/sdk/go/v2024/models/correlation-config +tags: ['SDK', 'Software Development Kit', 'CorrelationConfig', 'V2024CorrelationConfig'] +--- + +# CorrelationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | The ID of the correlation configuration. | [optional] +**Name** | Pointer to **NullableString** | The name of the correlation configuration. | [optional] +**AttributeAssignments** | Pointer to [**[]CorrelationConfigAttributeAssignmentsInner**](correlation-config-attribute-assignments-inner) | The list of attribute assignments of the correlation configuration. | [optional] + +## Methods + +### NewCorrelationConfig + +`func NewCorrelationConfig() *CorrelationConfig` + +NewCorrelationConfig instantiates a new CorrelationConfig 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 + +### NewCorrelationConfigWithDefaults + +`func NewCorrelationConfigWithDefaults() *CorrelationConfig` + +NewCorrelationConfigWithDefaults instantiates a new CorrelationConfig 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 + +### GetId + +`func (o *CorrelationConfig) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CorrelationConfig) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CorrelationConfig) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CorrelationConfig) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *CorrelationConfig) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *CorrelationConfig) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *CorrelationConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CorrelationConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CorrelationConfig) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CorrelationConfig) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *CorrelationConfig) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *CorrelationConfig) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetAttributeAssignments + +`func (o *CorrelationConfig) GetAttributeAssignments() []CorrelationConfigAttributeAssignmentsInner` + +GetAttributeAssignments returns the AttributeAssignments field if non-nil, zero value otherwise. + +### GetAttributeAssignmentsOk + +`func (o *CorrelationConfig) GetAttributeAssignmentsOk() (*[]CorrelationConfigAttributeAssignmentsInner, bool)` + +GetAttributeAssignmentsOk returns a tuple with the AttributeAssignments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeAssignments + +`func (o *CorrelationConfig) SetAttributeAssignments(v []CorrelationConfigAttributeAssignmentsInner)` + +SetAttributeAssignments sets AttributeAssignments field to given value. + +### HasAttributeAssignments + +`func (o *CorrelationConfig) HasAttributeAssignments() bool` + +HasAttributeAssignments returns a boolean if a field has been set. + +### SetAttributeAssignmentsNil + +`func (o *CorrelationConfig) SetAttributeAssignmentsNil(b bool)` + + SetAttributeAssignmentsNil sets the value for AttributeAssignments to be an explicit nil + +### UnsetAttributeAssignments +`func (o *CorrelationConfig) UnsetAttributeAssignments()` + +UnsetAttributeAssignments ensures that no value is present for AttributeAssignments, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CorrelationConfigAttributeAssignmentsInner.md b/docs/tools/sdk/go/Reference/V2024/Models/CorrelationConfigAttributeAssignmentsInner.md new file mode 100644 index 000000000..82305789d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CorrelationConfigAttributeAssignmentsInner.md @@ -0,0 +1,220 @@ +--- +id: v2024-correlation-config-attribute-assignments-inner +title: CorrelationConfigAttributeAssignmentsInner +pagination_label: CorrelationConfigAttributeAssignmentsInner +sidebar_label: CorrelationConfigAttributeAssignmentsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CorrelationConfigAttributeAssignmentsInner', 'V2024CorrelationConfigAttributeAssignmentsInner'] +slug: /tools/sdk/go/v2024/models/correlation-config-attribute-assignments-inner +tags: ['SDK', 'Software Development Kit', 'CorrelationConfigAttributeAssignmentsInner', 'V2024CorrelationConfigAttributeAssignmentsInner'] +--- + +# CorrelationConfigAttributeAssignmentsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Property** | Pointer to **string** | The property of the attribute assignment. | [optional] +**Value** | Pointer to **string** | The value of the attribute assignment. | [optional] +**Operation** | Pointer to **string** | The operation of the attribute assignment. | [optional] +**Complex** | Pointer to **bool** | Whether or not the it's a complex attribute assignment. | [optional] [default to false] +**IgnoreCase** | Pointer to **bool** | Whether or not the attribute assignment should ignore case. | [optional] [default to false] +**MatchMode** | Pointer to **string** | The match mode of the attribute assignment. | [optional] +**FilterString** | Pointer to **string** | The filter string of the attribute assignment. | [optional] + +## Methods + +### NewCorrelationConfigAttributeAssignmentsInner + +`func NewCorrelationConfigAttributeAssignmentsInner() *CorrelationConfigAttributeAssignmentsInner` + +NewCorrelationConfigAttributeAssignmentsInner instantiates a new CorrelationConfigAttributeAssignmentsInner 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 + +### NewCorrelationConfigAttributeAssignmentsInnerWithDefaults + +`func NewCorrelationConfigAttributeAssignmentsInnerWithDefaults() *CorrelationConfigAttributeAssignmentsInner` + +NewCorrelationConfigAttributeAssignmentsInnerWithDefaults instantiates a new CorrelationConfigAttributeAssignmentsInner 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 + +### GetProperty + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetProperty() string` + +GetProperty returns the Property field if non-nil, zero value otherwise. + +### GetPropertyOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetPropertyOk() (*string, bool)` + +GetPropertyOk returns a tuple with the Property field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperty + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetProperty(v string)` + +SetProperty sets Property field to given value. + +### HasProperty + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasProperty() bool` + +HasProperty returns a boolean if a field has been set. + +### GetValue + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetOperation + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetComplex + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetComplex() bool` + +GetComplex returns the Complex field if non-nil, zero value otherwise. + +### GetComplexOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetComplexOk() (*bool, bool)` + +GetComplexOk returns a tuple with the Complex field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComplex + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetComplex(v bool)` + +SetComplex sets Complex field to given value. + +### HasComplex + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasComplex() bool` + +HasComplex returns a boolean if a field has been set. + +### GetIgnoreCase + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetIgnoreCase() bool` + +GetIgnoreCase returns the IgnoreCase field if non-nil, zero value otherwise. + +### GetIgnoreCaseOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetIgnoreCaseOk() (*bool, bool)` + +GetIgnoreCaseOk returns a tuple with the IgnoreCase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIgnoreCase + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetIgnoreCase(v bool)` + +SetIgnoreCase sets IgnoreCase field to given value. + +### HasIgnoreCase + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasIgnoreCase() bool` + +HasIgnoreCase returns a boolean if a field has been set. + +### GetMatchMode + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetMatchMode() string` + +GetMatchMode returns the MatchMode field if non-nil, zero value otherwise. + +### GetMatchModeOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetMatchModeOk() (*string, bool)` + +GetMatchModeOk returns a tuple with the MatchMode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchMode + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetMatchMode(v string)` + +SetMatchMode sets MatchMode field to given value. + +### HasMatchMode + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasMatchMode() bool` + +HasMatchMode returns a boolean if a field has been set. + +### GetFilterString + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetFilterString() string` + +GetFilterString returns the FilterString field if non-nil, zero value otherwise. + +### GetFilterStringOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetFilterStringOk() (*string, bool)` + +GetFilterStringOk returns a tuple with the FilterString field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilterString + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetFilterString(v string)` + +SetFilterString sets FilterString field to given value. + +### HasFilterString + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasFilterString() bool` + +HasFilterString returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CreateDomainDkim405Response.md b/docs/tools/sdk/go/Reference/V2024/Models/CreateDomainDkim405Response.md new file mode 100644 index 000000000..148fc21a5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CreateDomainDkim405Response.md @@ -0,0 +1,116 @@ +--- +id: v2024-create-domain-dkim405-response +title: CreateDomainDkim405Response +pagination_label: CreateDomainDkim405Response +sidebar_label: CreateDomainDkim405Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateDomainDkim405Response', 'V2024CreateDomainDkim405Response'] +slug: /tools/sdk/go/v2024/models/create-domain-dkim405-response +tags: ['SDK', 'Software Development Kit', 'CreateDomainDkim405Response', 'V2024CreateDomainDkim405Response'] +--- + +# CreateDomainDkim405Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ErrorName** | Pointer to **map[string]interface{}** | A message describing the error | [optional] +**ErrorMessage** | Pointer to **map[string]interface{}** | Description of the error | [optional] +**TrackingId** | Pointer to **string** | Unique tracking id for the error. | [optional] + +## Methods + +### NewCreateDomainDkim405Response + +`func NewCreateDomainDkim405Response() *CreateDomainDkim405Response` + +NewCreateDomainDkim405Response instantiates a new CreateDomainDkim405Response 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 + +### NewCreateDomainDkim405ResponseWithDefaults + +`func NewCreateDomainDkim405ResponseWithDefaults() *CreateDomainDkim405Response` + +NewCreateDomainDkim405ResponseWithDefaults instantiates a new CreateDomainDkim405Response 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 + +### GetErrorName + +`func (o *CreateDomainDkim405Response) GetErrorName() map[string]interface{}` + +GetErrorName returns the ErrorName field if non-nil, zero value otherwise. + +### GetErrorNameOk + +`func (o *CreateDomainDkim405Response) GetErrorNameOk() (*map[string]interface{}, bool)` + +GetErrorNameOk returns a tuple with the ErrorName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorName + +`func (o *CreateDomainDkim405Response) SetErrorName(v map[string]interface{})` + +SetErrorName sets ErrorName field to given value. + +### HasErrorName + +`func (o *CreateDomainDkim405Response) HasErrorName() bool` + +HasErrorName returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *CreateDomainDkim405Response) GetErrorMessage() map[string]interface{}` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *CreateDomainDkim405Response) GetErrorMessageOk() (*map[string]interface{}, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *CreateDomainDkim405Response) SetErrorMessage(v map[string]interface{})` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *CreateDomainDkim405Response) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetTrackingId + +`func (o *CreateDomainDkim405Response) GetTrackingId() string` + +GetTrackingId returns the TrackingId field if non-nil, zero value otherwise. + +### GetTrackingIdOk + +`func (o *CreateDomainDkim405Response) GetTrackingIdOk() (*string, bool)` + +GetTrackingIdOk returns a tuple with the TrackingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingId + +`func (o *CreateDomainDkim405Response) SetTrackingId(v string)` + +SetTrackingId sets TrackingId field to given value. + +### HasTrackingId + +`func (o *CreateDomainDkim405Response) HasTrackingId() bool` + +HasTrackingId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CreateExternalExecuteWorkflow200Response.md b/docs/tools/sdk/go/Reference/V2024/Models/CreateExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..d0cd41e24 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CreateExternalExecuteWorkflow200Response.md @@ -0,0 +1,90 @@ +--- +id: v2024-create-external-execute-workflow200-response +title: CreateExternalExecuteWorkflow200Response +pagination_label: CreateExternalExecuteWorkflow200Response +sidebar_label: CreateExternalExecuteWorkflow200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateExternalExecuteWorkflow200Response', 'V2024CreateExternalExecuteWorkflow200Response'] +slug: /tools/sdk/go/v2024/models/create-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflow200Response', 'V2024CreateExternalExecuteWorkflow200Response'] +--- + +# CreateExternalExecuteWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**WorkflowExecutionId** | Pointer to **string** | The workflow execution id | [optional] +**Message** | Pointer to **string** | An error message if any errors occurred | [optional] + +## Methods + +### NewCreateExternalExecuteWorkflow200Response + +`func NewCreateExternalExecuteWorkflow200Response() *CreateExternalExecuteWorkflow200Response` + +NewCreateExternalExecuteWorkflow200Response instantiates a new CreateExternalExecuteWorkflow200Response 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 + +### NewCreateExternalExecuteWorkflow200ResponseWithDefaults + +`func NewCreateExternalExecuteWorkflow200ResponseWithDefaults() *CreateExternalExecuteWorkflow200Response` + +NewCreateExternalExecuteWorkflow200ResponseWithDefaults instantiates a new CreateExternalExecuteWorkflow200Response 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 + +### GetWorkflowExecutionId + +`func (o *CreateExternalExecuteWorkflow200Response) GetWorkflowExecutionId() string` + +GetWorkflowExecutionId returns the WorkflowExecutionId field if non-nil, zero value otherwise. + +### GetWorkflowExecutionIdOk + +`func (o *CreateExternalExecuteWorkflow200Response) GetWorkflowExecutionIdOk() (*string, bool)` + +GetWorkflowExecutionIdOk returns a tuple with the WorkflowExecutionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWorkflowExecutionId + +`func (o *CreateExternalExecuteWorkflow200Response) SetWorkflowExecutionId(v string)` + +SetWorkflowExecutionId sets WorkflowExecutionId field to given value. + +### HasWorkflowExecutionId + +`func (o *CreateExternalExecuteWorkflow200Response) HasWorkflowExecutionId() bool` + +HasWorkflowExecutionId returns a boolean if a field has been set. + +### GetMessage + +`func (o *CreateExternalExecuteWorkflow200Response) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *CreateExternalExecuteWorkflow200Response) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *CreateExternalExecuteWorkflow200Response) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *CreateExternalExecuteWorkflow200Response) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CreateExternalExecuteWorkflowRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/CreateExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..83bb59de6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CreateExternalExecuteWorkflowRequest.md @@ -0,0 +1,64 @@ +--- +id: v2024-create-external-execute-workflow-request +title: CreateExternalExecuteWorkflowRequest +pagination_label: CreateExternalExecuteWorkflowRequest +sidebar_label: CreateExternalExecuteWorkflowRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateExternalExecuteWorkflowRequest', 'V2024CreateExternalExecuteWorkflowRequest'] +slug: /tools/sdk/go/v2024/models/create-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflowRequest', 'V2024CreateExternalExecuteWorkflowRequest'] +--- + +# CreateExternalExecuteWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | Pointer to **map[string]interface{}** | The input for the workflow | [optional] + +## Methods + +### NewCreateExternalExecuteWorkflowRequest + +`func NewCreateExternalExecuteWorkflowRequest() *CreateExternalExecuteWorkflowRequest` + +NewCreateExternalExecuteWorkflowRequest instantiates a new CreateExternalExecuteWorkflowRequest 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 + +### NewCreateExternalExecuteWorkflowRequestWithDefaults + +`func NewCreateExternalExecuteWorkflowRequestWithDefaults() *CreateExternalExecuteWorkflowRequest` + +NewCreateExternalExecuteWorkflowRequestWithDefaults instantiates a new CreateExternalExecuteWorkflowRequest 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 + +### GetInput + +`func (o *CreateExternalExecuteWorkflowRequest) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *CreateExternalExecuteWorkflowRequest) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *CreateExternalExecuteWorkflowRequest) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + +### HasInput + +`func (o *CreateExternalExecuteWorkflowRequest) HasInput() bool` + +HasInput returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CreateFormDefinitionFileRequestRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/CreateFormDefinitionFileRequestRequest.md new file mode 100644 index 000000000..8cd5204e8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CreateFormDefinitionFileRequestRequest.md @@ -0,0 +1,59 @@ +--- +id: v2024-create-form-definition-file-request-request +title: CreateFormDefinitionFileRequestRequest +pagination_label: CreateFormDefinitionFileRequestRequest +sidebar_label: CreateFormDefinitionFileRequestRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateFormDefinitionFileRequestRequest', 'V2024CreateFormDefinitionFileRequestRequest'] +slug: /tools/sdk/go/v2024/models/create-form-definition-file-request-request +tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionFileRequestRequest', 'V2024CreateFormDefinitionFileRequestRequest'] +--- + +# CreateFormDefinitionFileRequestRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | ***os.File** | File specifying the multipart | + +## Methods + +### NewCreateFormDefinitionFileRequestRequest + +`func NewCreateFormDefinitionFileRequestRequest(file *os.File, ) *CreateFormDefinitionFileRequestRequest` + +NewCreateFormDefinitionFileRequestRequest instantiates a new CreateFormDefinitionFileRequestRequest 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 + +### NewCreateFormDefinitionFileRequestRequestWithDefaults + +`func NewCreateFormDefinitionFileRequestRequestWithDefaults() *CreateFormDefinitionFileRequestRequest` + +NewCreateFormDefinitionFileRequestRequestWithDefaults instantiates a new CreateFormDefinitionFileRequestRequest 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 + +### GetFile + +`func (o *CreateFormDefinitionFileRequestRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *CreateFormDefinitionFileRequestRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *CreateFormDefinitionFileRequestRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CreateFormDefinitionRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/CreateFormDefinitionRequest.md new file mode 100644 index 000000000..4748e3745 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CreateFormDefinitionRequest.md @@ -0,0 +1,210 @@ +--- +id: v2024-create-form-definition-request +title: CreateFormDefinitionRequest +pagination_label: CreateFormDefinitionRequest +sidebar_label: CreateFormDefinitionRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateFormDefinitionRequest', 'V2024CreateFormDefinitionRequest'] +slug: /tools/sdk/go/v2024/models/create-form-definition-request +tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionRequest', 'V2024CreateFormDefinitionRequest'] +--- + +# CreateFormDefinitionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Description is the form definition description | [optional] +**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**FormElements** | Pointer to [**[]FormElement**](form-element) | FormElements is a list of nested form elements | [optional] +**FormInput** | Pointer to [**[]FormDefinitionInput**](form-definition-input) | FormInput is a list of form inputs that are required when creating a form-instance object | [optional] +**Name** | **string** | Name is the form definition name | +**Owner** | [**FormOwner**](form-owner) | | +**UsedBy** | Pointer to [**[]FormUsedBy**](form-used-by) | UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used | [optional] + +## Methods + +### NewCreateFormDefinitionRequest + +`func NewCreateFormDefinitionRequest(name string, owner FormOwner, ) *CreateFormDefinitionRequest` + +NewCreateFormDefinitionRequest instantiates a new CreateFormDefinitionRequest 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 + +### NewCreateFormDefinitionRequestWithDefaults + +`func NewCreateFormDefinitionRequestWithDefaults() *CreateFormDefinitionRequest` + +NewCreateFormDefinitionRequestWithDefaults instantiates a new CreateFormDefinitionRequest 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 + +### GetDescription + +`func (o *CreateFormDefinitionRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateFormDefinitionRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateFormDefinitionRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CreateFormDefinitionRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetFormConditions + +`func (o *CreateFormDefinitionRequest) GetFormConditions() []FormCondition` + +GetFormConditions returns the FormConditions field if non-nil, zero value otherwise. + +### GetFormConditionsOk + +`func (o *CreateFormDefinitionRequest) GetFormConditionsOk() (*[]FormCondition, bool)` + +GetFormConditionsOk returns a tuple with the FormConditions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormConditions + +`func (o *CreateFormDefinitionRequest) SetFormConditions(v []FormCondition)` + +SetFormConditions sets FormConditions field to given value. + +### HasFormConditions + +`func (o *CreateFormDefinitionRequest) HasFormConditions() bool` + +HasFormConditions returns a boolean if a field has been set. + +### GetFormElements + +`func (o *CreateFormDefinitionRequest) GetFormElements() []FormElement` + +GetFormElements returns the FormElements field if non-nil, zero value otherwise. + +### GetFormElementsOk + +`func (o *CreateFormDefinitionRequest) GetFormElementsOk() (*[]FormElement, bool)` + +GetFormElementsOk returns a tuple with the FormElements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormElements + +`func (o *CreateFormDefinitionRequest) SetFormElements(v []FormElement)` + +SetFormElements sets FormElements field to given value. + +### HasFormElements + +`func (o *CreateFormDefinitionRequest) HasFormElements() bool` + +HasFormElements returns a boolean if a field has been set. + +### GetFormInput + +`func (o *CreateFormDefinitionRequest) GetFormInput() []FormDefinitionInput` + +GetFormInput returns the FormInput field if non-nil, zero value otherwise. + +### GetFormInputOk + +`func (o *CreateFormDefinitionRequest) GetFormInputOk() (*[]FormDefinitionInput, bool)` + +GetFormInputOk returns a tuple with the FormInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormInput + +`func (o *CreateFormDefinitionRequest) SetFormInput(v []FormDefinitionInput)` + +SetFormInput sets FormInput field to given value. + +### HasFormInput + +`func (o *CreateFormDefinitionRequest) HasFormInput() bool` + +HasFormInput returns a boolean if a field has been set. + +### GetName + +`func (o *CreateFormDefinitionRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateFormDefinitionRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateFormDefinitionRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetOwner + +`func (o *CreateFormDefinitionRequest) GetOwner() FormOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CreateFormDefinitionRequest) GetOwnerOk() (*FormOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CreateFormDefinitionRequest) SetOwner(v FormOwner)` + +SetOwner sets Owner field to given value. + + +### GetUsedBy + +`func (o *CreateFormDefinitionRequest) GetUsedBy() []FormUsedBy` + +GetUsedBy returns the UsedBy field if non-nil, zero value otherwise. + +### GetUsedByOk + +`func (o *CreateFormDefinitionRequest) GetUsedByOk() (*[]FormUsedBy, bool)` + +GetUsedByOk returns a tuple with the UsedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsedBy + +`func (o *CreateFormDefinitionRequest) SetUsedBy(v []FormUsedBy)` + +SetUsedBy sets UsedBy field to given value. + +### HasUsedBy + +`func (o *CreateFormDefinitionRequest) HasUsedBy() bool` + +HasUsedBy returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CreateFormInstanceRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/CreateFormInstanceRequest.md new file mode 100644 index 000000000..66d25b1eb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CreateFormInstanceRequest.md @@ -0,0 +1,226 @@ +--- +id: v2024-create-form-instance-request +title: CreateFormInstanceRequest +pagination_label: CreateFormInstanceRequest +sidebar_label: CreateFormInstanceRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateFormInstanceRequest', 'V2024CreateFormInstanceRequest'] +slug: /tools/sdk/go/v2024/models/create-form-instance-request +tags: ['SDK', 'Software Development Kit', 'CreateFormInstanceRequest', 'V2024CreateFormInstanceRequest'] +--- + +# CreateFormInstanceRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedBy** | [**FormInstanceCreatedBy**](form-instance-created-by) | | +**Expire** | **string** | Expire is required | +**FormDefinitionId** | **string** | FormDefinitionID is the id of the form definition that created this form | +**FormInput** | Pointer to **map[string]interface{}** | FormInput is an object of form input labels to value | [optional] +**Recipients** | [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients is required | +**StandAloneForm** | Pointer to **bool** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to false] +**State** | Pointer to **string** | State is required, if not present initial state is FormInstanceStateAssigned ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] +**Ttl** | Pointer to **int64** | TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html | [optional] + +## Methods + +### NewCreateFormInstanceRequest + +`func NewCreateFormInstanceRequest(createdBy FormInstanceCreatedBy, expire string, formDefinitionId string, recipients []FormInstanceRecipient, ) *CreateFormInstanceRequest` + +NewCreateFormInstanceRequest instantiates a new CreateFormInstanceRequest 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 + +### NewCreateFormInstanceRequestWithDefaults + +`func NewCreateFormInstanceRequestWithDefaults() *CreateFormInstanceRequest` + +NewCreateFormInstanceRequestWithDefaults instantiates a new CreateFormInstanceRequest 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 + +### GetCreatedBy + +`func (o *CreateFormInstanceRequest) GetCreatedBy() FormInstanceCreatedBy` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *CreateFormInstanceRequest) GetCreatedByOk() (*FormInstanceCreatedBy, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *CreateFormInstanceRequest) SetCreatedBy(v FormInstanceCreatedBy)` + +SetCreatedBy sets CreatedBy field to given value. + + +### GetExpire + +`func (o *CreateFormInstanceRequest) GetExpire() string` + +GetExpire returns the Expire field if non-nil, zero value otherwise. + +### GetExpireOk + +`func (o *CreateFormInstanceRequest) GetExpireOk() (*string, bool)` + +GetExpireOk returns a tuple with the Expire field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpire + +`func (o *CreateFormInstanceRequest) SetExpire(v string)` + +SetExpire sets Expire field to given value. + + +### GetFormDefinitionId + +`func (o *CreateFormInstanceRequest) GetFormDefinitionId() string` + +GetFormDefinitionId returns the FormDefinitionId field if non-nil, zero value otherwise. + +### GetFormDefinitionIdOk + +`func (o *CreateFormInstanceRequest) GetFormDefinitionIdOk() (*string, bool)` + +GetFormDefinitionIdOk returns a tuple with the FormDefinitionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormDefinitionId + +`func (o *CreateFormInstanceRequest) SetFormDefinitionId(v string)` + +SetFormDefinitionId sets FormDefinitionId field to given value. + + +### GetFormInput + +`func (o *CreateFormInstanceRequest) GetFormInput() map[string]interface{}` + +GetFormInput returns the FormInput field if non-nil, zero value otherwise. + +### GetFormInputOk + +`func (o *CreateFormInstanceRequest) GetFormInputOk() (*map[string]interface{}, bool)` + +GetFormInputOk returns a tuple with the FormInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormInput + +`func (o *CreateFormInstanceRequest) SetFormInput(v map[string]interface{})` + +SetFormInput sets FormInput field to given value. + +### HasFormInput + +`func (o *CreateFormInstanceRequest) HasFormInput() bool` + +HasFormInput returns a boolean if a field has been set. + +### GetRecipients + +`func (o *CreateFormInstanceRequest) GetRecipients() []FormInstanceRecipient` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *CreateFormInstanceRequest) GetRecipientsOk() (*[]FormInstanceRecipient, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *CreateFormInstanceRequest) SetRecipients(v []FormInstanceRecipient)` + +SetRecipients sets Recipients field to given value. + + +### GetStandAloneForm + +`func (o *CreateFormInstanceRequest) GetStandAloneForm() bool` + +GetStandAloneForm returns the StandAloneForm field if non-nil, zero value otherwise. + +### GetStandAloneFormOk + +`func (o *CreateFormInstanceRequest) GetStandAloneFormOk() (*bool, bool)` + +GetStandAloneFormOk returns a tuple with the StandAloneForm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandAloneForm + +`func (o *CreateFormInstanceRequest) SetStandAloneForm(v bool)` + +SetStandAloneForm sets StandAloneForm field to given value. + +### HasStandAloneForm + +`func (o *CreateFormInstanceRequest) HasStandAloneForm() bool` + +HasStandAloneForm returns a boolean if a field has been set. + +### GetState + +`func (o *CreateFormInstanceRequest) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *CreateFormInstanceRequest) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *CreateFormInstanceRequest) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *CreateFormInstanceRequest) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetTtl + +`func (o *CreateFormInstanceRequest) GetTtl() int64` + +GetTtl returns the Ttl field if non-nil, zero value otherwise. + +### GetTtlOk + +`func (o *CreateFormInstanceRequest) GetTtlOk() (*int64, bool)` + +GetTtlOk returns a tuple with the Ttl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTtl + +`func (o *CreateFormInstanceRequest) SetTtl(v int64)` + +SetTtl sets Ttl field to given value. + +### HasTtl + +`func (o *CreateFormInstanceRequest) HasTtl() bool` + +HasTtl returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CreateOAuthClientRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/CreateOAuthClientRequest.md new file mode 100644 index 000000000..cf6dd6442 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CreateOAuthClientRequest.md @@ -0,0 +1,468 @@ +--- +id: v2024-create-o-auth-client-request +title: CreateOAuthClientRequest +pagination_label: CreateOAuthClientRequest +sidebar_label: CreateOAuthClientRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateOAuthClientRequest', 'V2024CreateOAuthClientRequest'] +slug: /tools/sdk/go/v2024/models/create-o-auth-client-request +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientRequest', 'V2024CreateOAuthClientRequest'] +--- + +# CreateOAuthClientRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BusinessName** | Pointer to **NullableString** | The name of the business the API Client should belong to | [optional] +**HomepageUrl** | Pointer to **NullableString** | The homepage URL associated with the owner of the API Client | [optional] +**Name** | **NullableString** | A human-readable name for the API Client | +**Description** | **NullableString** | A description of the API Client | +**AccessTokenValiditySeconds** | **int32** | The number of seconds an access token generated for this API Client is valid for | +**RefreshTokenValiditySeconds** | Pointer to **int32** | The number of seconds a refresh token generated for this API Client is valid for | [optional] +**RedirectUris** | Pointer to **[]string** | A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. | [optional] +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | +**AccessType** | [**AccessType**](access-type) | | +**Type** | Pointer to [**ClientType**](client-type) | | [optional] +**Internal** | Pointer to **bool** | An indicator of whether the API Client can be used for requests internal within the product. | [optional] +**Enabled** | **bool** | An indicator of whether the API Client is enabled for use | +**StrongAuthSupported** | Pointer to **bool** | An indicator of whether the API Client supports strong authentication | [optional] +**ClaimsSupported** | Pointer to **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [optional] +**Scope** | Pointer to **[]string** | Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it. | [optional] + +## Methods + +### NewCreateOAuthClientRequest + +`func NewCreateOAuthClientRequest(name NullableString, description NullableString, accessTokenValiditySeconds int32, grantTypes []GrantType, accessType AccessType, enabled bool, ) *CreateOAuthClientRequest` + +NewCreateOAuthClientRequest instantiates a new CreateOAuthClientRequest 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 + +### NewCreateOAuthClientRequestWithDefaults + +`func NewCreateOAuthClientRequestWithDefaults() *CreateOAuthClientRequest` + +NewCreateOAuthClientRequestWithDefaults instantiates a new CreateOAuthClientRequest 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 + +### GetBusinessName + +`func (o *CreateOAuthClientRequest) GetBusinessName() string` + +GetBusinessName returns the BusinessName field if non-nil, zero value otherwise. + +### GetBusinessNameOk + +`func (o *CreateOAuthClientRequest) GetBusinessNameOk() (*string, bool)` + +GetBusinessNameOk returns a tuple with the BusinessName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBusinessName + +`func (o *CreateOAuthClientRequest) SetBusinessName(v string)` + +SetBusinessName sets BusinessName field to given value. + +### HasBusinessName + +`func (o *CreateOAuthClientRequest) HasBusinessName() bool` + +HasBusinessName returns a boolean if a field has been set. + +### SetBusinessNameNil + +`func (o *CreateOAuthClientRequest) SetBusinessNameNil(b bool)` + + SetBusinessNameNil sets the value for BusinessName to be an explicit nil + +### UnsetBusinessName +`func (o *CreateOAuthClientRequest) UnsetBusinessName()` + +UnsetBusinessName ensures that no value is present for BusinessName, not even an explicit nil +### GetHomepageUrl + +`func (o *CreateOAuthClientRequest) GetHomepageUrl() string` + +GetHomepageUrl returns the HomepageUrl field if non-nil, zero value otherwise. + +### GetHomepageUrlOk + +`func (o *CreateOAuthClientRequest) GetHomepageUrlOk() (*string, bool)` + +GetHomepageUrlOk returns a tuple with the HomepageUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHomepageUrl + +`func (o *CreateOAuthClientRequest) SetHomepageUrl(v string)` + +SetHomepageUrl sets HomepageUrl field to given value. + +### HasHomepageUrl + +`func (o *CreateOAuthClientRequest) HasHomepageUrl() bool` + +HasHomepageUrl returns a boolean if a field has been set. + +### SetHomepageUrlNil + +`func (o *CreateOAuthClientRequest) SetHomepageUrlNil(b bool)` + + SetHomepageUrlNil sets the value for HomepageUrl to be an explicit nil + +### UnsetHomepageUrl +`func (o *CreateOAuthClientRequest) UnsetHomepageUrl()` + +UnsetHomepageUrl ensures that no value is present for HomepageUrl, not even an explicit nil +### GetName + +`func (o *CreateOAuthClientRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateOAuthClientRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateOAuthClientRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *CreateOAuthClientRequest) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *CreateOAuthClientRequest) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *CreateOAuthClientRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateOAuthClientRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateOAuthClientRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *CreateOAuthClientRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CreateOAuthClientRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAccessTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *CreateOAuthClientRequest) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + + +### GetRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) GetRefreshTokenValiditySeconds() int32` + +GetRefreshTokenValiditySeconds returns the RefreshTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetRefreshTokenValiditySecondsOk + +`func (o *CreateOAuthClientRequest) GetRefreshTokenValiditySecondsOk() (*int32, bool)` + +GetRefreshTokenValiditySecondsOk returns a tuple with the RefreshTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) SetRefreshTokenValiditySeconds(v int32)` + +SetRefreshTokenValiditySeconds sets RefreshTokenValiditySeconds field to given value. + +### HasRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) HasRefreshTokenValiditySeconds() bool` + +HasRefreshTokenValiditySeconds returns a boolean if a field has been set. + +### GetRedirectUris + +`func (o *CreateOAuthClientRequest) GetRedirectUris() []string` + +GetRedirectUris returns the RedirectUris field if non-nil, zero value otherwise. + +### GetRedirectUrisOk + +`func (o *CreateOAuthClientRequest) GetRedirectUrisOk() (*[]string, bool)` + +GetRedirectUrisOk returns a tuple with the RedirectUris field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedirectUris + +`func (o *CreateOAuthClientRequest) SetRedirectUris(v []string)` + +SetRedirectUris sets RedirectUris field to given value. + +### HasRedirectUris + +`func (o *CreateOAuthClientRequest) HasRedirectUris() bool` + +HasRedirectUris returns a boolean if a field has been set. + +### SetRedirectUrisNil + +`func (o *CreateOAuthClientRequest) SetRedirectUrisNil(b bool)` + + SetRedirectUrisNil sets the value for RedirectUris to be an explicit nil + +### UnsetRedirectUris +`func (o *CreateOAuthClientRequest) UnsetRedirectUris()` + +UnsetRedirectUris ensures that no value is present for RedirectUris, not even an explicit nil +### GetGrantTypes + +`func (o *CreateOAuthClientRequest) GetGrantTypes() []GrantType` + +GetGrantTypes returns the GrantTypes field if non-nil, zero value otherwise. + +### GetGrantTypesOk + +`func (o *CreateOAuthClientRequest) GetGrantTypesOk() (*[]GrantType, bool)` + +GetGrantTypesOk returns a tuple with the GrantTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantTypes + +`func (o *CreateOAuthClientRequest) SetGrantTypes(v []GrantType)` + +SetGrantTypes sets GrantTypes field to given value. + + +### SetGrantTypesNil + +`func (o *CreateOAuthClientRequest) SetGrantTypesNil(b bool)` + + SetGrantTypesNil sets the value for GrantTypes to be an explicit nil + +### UnsetGrantTypes +`func (o *CreateOAuthClientRequest) UnsetGrantTypes()` + +UnsetGrantTypes ensures that no value is present for GrantTypes, not even an explicit nil +### GetAccessType + +`func (o *CreateOAuthClientRequest) GetAccessType() AccessType` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *CreateOAuthClientRequest) GetAccessTypeOk() (*AccessType, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *CreateOAuthClientRequest) SetAccessType(v AccessType)` + +SetAccessType sets AccessType field to given value. + + +### GetType + +`func (o *CreateOAuthClientRequest) GetType() ClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CreateOAuthClientRequest) GetTypeOk() (*ClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CreateOAuthClientRequest) SetType(v ClientType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CreateOAuthClientRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetInternal + +`func (o *CreateOAuthClientRequest) GetInternal() bool` + +GetInternal returns the Internal field if non-nil, zero value otherwise. + +### GetInternalOk + +`func (o *CreateOAuthClientRequest) GetInternalOk() (*bool, bool)` + +GetInternalOk returns a tuple with the Internal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternal + +`func (o *CreateOAuthClientRequest) SetInternal(v bool)` + +SetInternal sets Internal field to given value. + +### HasInternal + +`func (o *CreateOAuthClientRequest) HasInternal() bool` + +HasInternal returns a boolean if a field has been set. + +### GetEnabled + +`func (o *CreateOAuthClientRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CreateOAuthClientRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *CreateOAuthClientRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetStrongAuthSupported + +`func (o *CreateOAuthClientRequest) GetStrongAuthSupported() bool` + +GetStrongAuthSupported returns the StrongAuthSupported field if non-nil, zero value otherwise. + +### GetStrongAuthSupportedOk + +`func (o *CreateOAuthClientRequest) GetStrongAuthSupportedOk() (*bool, bool)` + +GetStrongAuthSupportedOk returns a tuple with the StrongAuthSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStrongAuthSupported + +`func (o *CreateOAuthClientRequest) SetStrongAuthSupported(v bool)` + +SetStrongAuthSupported sets StrongAuthSupported field to given value. + +### HasStrongAuthSupported + +`func (o *CreateOAuthClientRequest) HasStrongAuthSupported() bool` + +HasStrongAuthSupported returns a boolean if a field has been set. + +### GetClaimsSupported + +`func (o *CreateOAuthClientRequest) GetClaimsSupported() bool` + +GetClaimsSupported returns the ClaimsSupported field if non-nil, zero value otherwise. + +### GetClaimsSupportedOk + +`func (o *CreateOAuthClientRequest) GetClaimsSupportedOk() (*bool, bool)` + +GetClaimsSupportedOk returns a tuple with the ClaimsSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClaimsSupported + +`func (o *CreateOAuthClientRequest) SetClaimsSupported(v bool)` + +SetClaimsSupported sets ClaimsSupported field to given value. + +### HasClaimsSupported + +`func (o *CreateOAuthClientRequest) HasClaimsSupported() bool` + +HasClaimsSupported returns a boolean if a field has been set. + +### GetScope + +`func (o *CreateOAuthClientRequest) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *CreateOAuthClientRequest) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *CreateOAuthClientRequest) SetScope(v []string)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *CreateOAuthClientRequest) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### SetScopeNil + +`func (o *CreateOAuthClientRequest) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *CreateOAuthClientRequest) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CreateOAuthClientResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/CreateOAuthClientResponse.md new file mode 100644 index 000000000..81fbcf533 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CreateOAuthClientResponse.md @@ -0,0 +1,447 @@ +--- +id: v2024-create-o-auth-client-response +title: CreateOAuthClientResponse +pagination_label: CreateOAuthClientResponse +sidebar_label: CreateOAuthClientResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateOAuthClientResponse', 'V2024CreateOAuthClientResponse'] +slug: /tools/sdk/go/v2024/models/create-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientResponse', 'V2024CreateOAuthClientResponse'] +--- + +# CreateOAuthClientResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the OAuth client | +**Secret** | **string** | Secret of the OAuth client (This field is only returned on the intial create call.) | +**BusinessName** | **string** | The name of the business the API Client should belong to | +**HomepageUrl** | **string** | The homepage URL associated with the owner of the API Client | +**Name** | **string** | A human-readable name for the API Client | +**Description** | **string** | A description of the API Client | +**AccessTokenValiditySeconds** | **int32** | The number of seconds an access token generated for this API Client is valid for | +**RefreshTokenValiditySeconds** | **int32** | The number of seconds a refresh token generated for this API Client is valid for | +**RedirectUris** | **[]string** | A list of the approved redirect URIs used with the authorization_code flow | +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | +**AccessType** | [**AccessType**](access-type) | | +**Type** | [**ClientType**](client-type) | | +**Internal** | **bool** | An indicator of whether the API Client can be used for requests internal to IDN | +**Enabled** | **bool** | An indicator of whether the API Client is enabled for use | +**StrongAuthSupported** | **bool** | An indicator of whether the API Client supports strong authentication | +**ClaimsSupported** | **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | +**Created** | **SailPointTime** | The date and time, down to the millisecond, when the API Client was created | +**Modified** | **SailPointTime** | The date and time, down to the millisecond, when the API Client was last updated | +**Scope** | **[]string** | Scopes of the API Client. | + +## Methods + +### NewCreateOAuthClientResponse + +`func NewCreateOAuthClientResponse(id string, secret string, businessName string, homepageUrl string, name string, description string, accessTokenValiditySeconds int32, refreshTokenValiditySeconds int32, redirectUris []string, grantTypes []GrantType, accessType AccessType, type_ ClientType, internal bool, enabled bool, strongAuthSupported bool, claimsSupported bool, created SailPointTime, modified SailPointTime, scope []string, ) *CreateOAuthClientResponse` + +NewCreateOAuthClientResponse instantiates a new CreateOAuthClientResponse 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 + +### NewCreateOAuthClientResponseWithDefaults + +`func NewCreateOAuthClientResponseWithDefaults() *CreateOAuthClientResponse` + +NewCreateOAuthClientResponseWithDefaults instantiates a new CreateOAuthClientResponse 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 + +### GetId + +`func (o *CreateOAuthClientResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CreateOAuthClientResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CreateOAuthClientResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetSecret + +`func (o *CreateOAuthClientResponse) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *CreateOAuthClientResponse) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *CreateOAuthClientResponse) SetSecret(v string)` + +SetSecret sets Secret field to given value. + + +### GetBusinessName + +`func (o *CreateOAuthClientResponse) GetBusinessName() string` + +GetBusinessName returns the BusinessName field if non-nil, zero value otherwise. + +### GetBusinessNameOk + +`func (o *CreateOAuthClientResponse) GetBusinessNameOk() (*string, bool)` + +GetBusinessNameOk returns a tuple with the BusinessName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBusinessName + +`func (o *CreateOAuthClientResponse) SetBusinessName(v string)` + +SetBusinessName sets BusinessName field to given value. + + +### GetHomepageUrl + +`func (o *CreateOAuthClientResponse) GetHomepageUrl() string` + +GetHomepageUrl returns the HomepageUrl field if non-nil, zero value otherwise. + +### GetHomepageUrlOk + +`func (o *CreateOAuthClientResponse) GetHomepageUrlOk() (*string, bool)` + +GetHomepageUrlOk returns a tuple with the HomepageUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHomepageUrl + +`func (o *CreateOAuthClientResponse) SetHomepageUrl(v string)` + +SetHomepageUrl sets HomepageUrl field to given value. + + +### GetName + +`func (o *CreateOAuthClientResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateOAuthClientResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateOAuthClientResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CreateOAuthClientResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateOAuthClientResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateOAuthClientResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetAccessTokenValiditySeconds + +`func (o *CreateOAuthClientResponse) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *CreateOAuthClientResponse) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *CreateOAuthClientResponse) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + + +### GetRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientResponse) GetRefreshTokenValiditySeconds() int32` + +GetRefreshTokenValiditySeconds returns the RefreshTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetRefreshTokenValiditySecondsOk + +`func (o *CreateOAuthClientResponse) GetRefreshTokenValiditySecondsOk() (*int32, bool)` + +GetRefreshTokenValiditySecondsOk returns a tuple with the RefreshTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientResponse) SetRefreshTokenValiditySeconds(v int32)` + +SetRefreshTokenValiditySeconds sets RefreshTokenValiditySeconds field to given value. + + +### GetRedirectUris + +`func (o *CreateOAuthClientResponse) GetRedirectUris() []string` + +GetRedirectUris returns the RedirectUris field if non-nil, zero value otherwise. + +### GetRedirectUrisOk + +`func (o *CreateOAuthClientResponse) GetRedirectUrisOk() (*[]string, bool)` + +GetRedirectUrisOk returns a tuple with the RedirectUris field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedirectUris + +`func (o *CreateOAuthClientResponse) SetRedirectUris(v []string)` + +SetRedirectUris sets RedirectUris field to given value. + + +### GetGrantTypes + +`func (o *CreateOAuthClientResponse) GetGrantTypes() []GrantType` + +GetGrantTypes returns the GrantTypes field if non-nil, zero value otherwise. + +### GetGrantTypesOk + +`func (o *CreateOAuthClientResponse) GetGrantTypesOk() (*[]GrantType, bool)` + +GetGrantTypesOk returns a tuple with the GrantTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantTypes + +`func (o *CreateOAuthClientResponse) SetGrantTypes(v []GrantType)` + +SetGrantTypes sets GrantTypes field to given value. + + +### GetAccessType + +`func (o *CreateOAuthClientResponse) GetAccessType() AccessType` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *CreateOAuthClientResponse) GetAccessTypeOk() (*AccessType, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *CreateOAuthClientResponse) SetAccessType(v AccessType)` + +SetAccessType sets AccessType field to given value. + + +### GetType + +`func (o *CreateOAuthClientResponse) GetType() ClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CreateOAuthClientResponse) GetTypeOk() (*ClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CreateOAuthClientResponse) SetType(v ClientType)` + +SetType sets Type field to given value. + + +### GetInternal + +`func (o *CreateOAuthClientResponse) GetInternal() bool` + +GetInternal returns the Internal field if non-nil, zero value otherwise. + +### GetInternalOk + +`func (o *CreateOAuthClientResponse) GetInternalOk() (*bool, bool)` + +GetInternalOk returns a tuple with the Internal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternal + +`func (o *CreateOAuthClientResponse) SetInternal(v bool)` + +SetInternal sets Internal field to given value. + + +### GetEnabled + +`func (o *CreateOAuthClientResponse) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CreateOAuthClientResponse) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *CreateOAuthClientResponse) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetStrongAuthSupported + +`func (o *CreateOAuthClientResponse) GetStrongAuthSupported() bool` + +GetStrongAuthSupported returns the StrongAuthSupported field if non-nil, zero value otherwise. + +### GetStrongAuthSupportedOk + +`func (o *CreateOAuthClientResponse) GetStrongAuthSupportedOk() (*bool, bool)` + +GetStrongAuthSupportedOk returns a tuple with the StrongAuthSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStrongAuthSupported + +`func (o *CreateOAuthClientResponse) SetStrongAuthSupported(v bool)` + +SetStrongAuthSupported sets StrongAuthSupported field to given value. + + +### GetClaimsSupported + +`func (o *CreateOAuthClientResponse) GetClaimsSupported() bool` + +GetClaimsSupported returns the ClaimsSupported field if non-nil, zero value otherwise. + +### GetClaimsSupportedOk + +`func (o *CreateOAuthClientResponse) GetClaimsSupportedOk() (*bool, bool)` + +GetClaimsSupportedOk returns a tuple with the ClaimsSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClaimsSupported + +`func (o *CreateOAuthClientResponse) SetClaimsSupported(v bool)` + +SetClaimsSupported sets ClaimsSupported field to given value. + + +### GetCreated + +`func (o *CreateOAuthClientResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CreateOAuthClientResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CreateOAuthClientResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CreateOAuthClientResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CreateOAuthClientResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CreateOAuthClientResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetScope + +`func (o *CreateOAuthClientResponse) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *CreateOAuthClientResponse) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *CreateOAuthClientResponse) SetScope(v []string)` + +SetScope sets Scope field to given value. + + +### SetScopeNil + +`func (o *CreateOAuthClientResponse) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *CreateOAuthClientResponse) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CreatePersonalAccessTokenRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/CreatePersonalAccessTokenRequest.md new file mode 100644 index 000000000..57f61e511 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CreatePersonalAccessTokenRequest.md @@ -0,0 +1,121 @@ +--- +id: v2024-create-personal-access-token-request +title: CreatePersonalAccessTokenRequest +pagination_label: CreatePersonalAccessTokenRequest +sidebar_label: CreatePersonalAccessTokenRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreatePersonalAccessTokenRequest', 'V2024CreatePersonalAccessTokenRequest'] +slug: /tools/sdk/go/v2024/models/create-personal-access-token-request +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenRequest', 'V2024CreatePersonalAccessTokenRequest'] +--- + +# CreatePersonalAccessTokenRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | +**Scope** | Pointer to **[]string** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it. | [optional] +**AccessTokenValiditySeconds** | Pointer to **int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] + +## Methods + +### NewCreatePersonalAccessTokenRequest + +`func NewCreatePersonalAccessTokenRequest(name string, ) *CreatePersonalAccessTokenRequest` + +NewCreatePersonalAccessTokenRequest instantiates a new CreatePersonalAccessTokenRequest 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 + +### NewCreatePersonalAccessTokenRequestWithDefaults + +`func NewCreatePersonalAccessTokenRequestWithDefaults() *CreatePersonalAccessTokenRequest` + +NewCreatePersonalAccessTokenRequestWithDefaults instantiates a new CreatePersonalAccessTokenRequest 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 + +### GetName + +`func (o *CreatePersonalAccessTokenRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreatePersonalAccessTokenRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreatePersonalAccessTokenRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetScope + +`func (o *CreatePersonalAccessTokenRequest) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *CreatePersonalAccessTokenRequest) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *CreatePersonalAccessTokenRequest) SetScope(v []string)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *CreatePersonalAccessTokenRequest) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### SetScopeNil + +`func (o *CreatePersonalAccessTokenRequest) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *CreatePersonalAccessTokenRequest) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil +### GetAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenRequest) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *CreatePersonalAccessTokenRequest) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenRequest) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + +### HasAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenRequest) HasAccessTokenValiditySeconds() bool` + +HasAccessTokenValiditySeconds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CreatePersonalAccessTokenResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/CreatePersonalAccessTokenResponse.md new file mode 100644 index 000000000..52ea1f892 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CreatePersonalAccessTokenResponse.md @@ -0,0 +1,195 @@ +--- +id: v2024-create-personal-access-token-response +title: CreatePersonalAccessTokenResponse +pagination_label: CreatePersonalAccessTokenResponse +sidebar_label: CreatePersonalAccessTokenResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreatePersonalAccessTokenResponse', 'V2024CreatePersonalAccessTokenResponse'] +slug: /tools/sdk/go/v2024/models/create-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenResponse', 'V2024CreatePersonalAccessTokenResponse'] +--- + +# CreatePersonalAccessTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The ID of the personal access token (to be used as the username for Basic Auth). | +**Secret** | **string** | The secret of the personal access token (to be used as the password for Basic Auth). | +**Scope** | **[]string** | Scopes of the personal access token. | +**Name** | **string** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | +**Owner** | [**PatOwner**](pat-owner) | | +**Created** | **SailPointTime** | The date and time, down to the millisecond, when this personal access token was created. | +**AccessTokenValiditySeconds** | **int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | + +## Methods + +### NewCreatePersonalAccessTokenResponse + +`func NewCreatePersonalAccessTokenResponse(id string, secret string, scope []string, name string, owner PatOwner, created SailPointTime, accessTokenValiditySeconds int32, ) *CreatePersonalAccessTokenResponse` + +NewCreatePersonalAccessTokenResponse instantiates a new CreatePersonalAccessTokenResponse 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 + +### NewCreatePersonalAccessTokenResponseWithDefaults + +`func NewCreatePersonalAccessTokenResponseWithDefaults() *CreatePersonalAccessTokenResponse` + +NewCreatePersonalAccessTokenResponseWithDefaults instantiates a new CreatePersonalAccessTokenResponse 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 + +### GetId + +`func (o *CreatePersonalAccessTokenResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CreatePersonalAccessTokenResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CreatePersonalAccessTokenResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetSecret + +`func (o *CreatePersonalAccessTokenResponse) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *CreatePersonalAccessTokenResponse) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *CreatePersonalAccessTokenResponse) SetSecret(v string)` + +SetSecret sets Secret field to given value. + + +### GetScope + +`func (o *CreatePersonalAccessTokenResponse) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *CreatePersonalAccessTokenResponse) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *CreatePersonalAccessTokenResponse) SetScope(v []string)` + +SetScope sets Scope field to given value. + + +### SetScopeNil + +`func (o *CreatePersonalAccessTokenResponse) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *CreatePersonalAccessTokenResponse) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil +### GetName + +`func (o *CreatePersonalAccessTokenResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreatePersonalAccessTokenResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreatePersonalAccessTokenResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetOwner + +`func (o *CreatePersonalAccessTokenResponse) GetOwner() PatOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CreatePersonalAccessTokenResponse) GetOwnerOk() (*PatOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CreatePersonalAccessTokenResponse) SetOwner(v PatOwner)` + +SetOwner sets Owner field to given value. + + +### GetCreated + +`func (o *CreatePersonalAccessTokenResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CreatePersonalAccessTokenResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CreatePersonalAccessTokenResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenResponse) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *CreatePersonalAccessTokenResponse) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenResponse) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CreateSavedSearchRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/CreateSavedSearchRequest.md new file mode 100644 index 000000000..8a6b3b65d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CreateSavedSearchRequest.md @@ -0,0 +1,384 @@ +--- +id: v2024-create-saved-search-request +title: CreateSavedSearchRequest +pagination_label: CreateSavedSearchRequest +sidebar_label: CreateSavedSearchRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateSavedSearchRequest', 'V2024CreateSavedSearchRequest'] +slug: /tools/sdk/go/v2024/models/create-saved-search-request +tags: ['SDK', 'Software Development Kit', 'CreateSavedSearchRequest', 'V2024CreateSavedSearchRequest'] +--- + +# CreateSavedSearchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the saved search. | [optional] +**Description** | Pointer to **NullableString** | The description of the saved search. | [optional] +**Created** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | +**Columns** | Pointer to [**map[string][]Column**](https://go.dev/tour/moretypes/6) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**Query** | **string** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | +**Fields** | Pointer to **[]string** | The fields to be searched against in a multi-field query. | [optional] +**OrderBy** | Pointer to **map[string][]string** | Sort by index. This takes precedence over the `sort` property. | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. | [optional] +**Filters** | Pointer to [**NullableSavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] + +## Methods + +### NewCreateSavedSearchRequest + +`func NewCreateSavedSearchRequest(indices []Index, query string, ) *CreateSavedSearchRequest` + +NewCreateSavedSearchRequest instantiates a new CreateSavedSearchRequest 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 + +### NewCreateSavedSearchRequestWithDefaults + +`func NewCreateSavedSearchRequestWithDefaults() *CreateSavedSearchRequest` + +NewCreateSavedSearchRequestWithDefaults instantiates a new CreateSavedSearchRequest 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 + +### GetName + +`func (o *CreateSavedSearchRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateSavedSearchRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateSavedSearchRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CreateSavedSearchRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *CreateSavedSearchRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateSavedSearchRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateSavedSearchRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CreateSavedSearchRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *CreateSavedSearchRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CreateSavedSearchRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCreated + +`func (o *CreateSavedSearchRequest) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CreateSavedSearchRequest) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CreateSavedSearchRequest) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CreateSavedSearchRequest) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *CreateSavedSearchRequest) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *CreateSavedSearchRequest) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *CreateSavedSearchRequest) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CreateSavedSearchRequest) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CreateSavedSearchRequest) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CreateSavedSearchRequest) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CreateSavedSearchRequest) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CreateSavedSearchRequest) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetIndices + +`func (o *CreateSavedSearchRequest) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *CreateSavedSearchRequest) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *CreateSavedSearchRequest) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + + +### GetColumns + +`func (o *CreateSavedSearchRequest) GetColumns() map[string][]Column` + +GetColumns returns the Columns field if non-nil, zero value otherwise. + +### GetColumnsOk + +`func (o *CreateSavedSearchRequest) GetColumnsOk() (*map[string][]Column, bool)` + +GetColumnsOk returns a tuple with the Columns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumns + +`func (o *CreateSavedSearchRequest) SetColumns(v map[string][]Column)` + +SetColumns sets Columns field to given value. + +### HasColumns + +`func (o *CreateSavedSearchRequest) HasColumns() bool` + +HasColumns returns a boolean if a field has been set. + +### GetQuery + +`func (o *CreateSavedSearchRequest) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *CreateSavedSearchRequest) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *CreateSavedSearchRequest) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetFields + +`func (o *CreateSavedSearchRequest) GetFields() []string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *CreateSavedSearchRequest) GetFieldsOk() (*[]string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *CreateSavedSearchRequest) SetFields(v []string)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *CreateSavedSearchRequest) HasFields() bool` + +HasFields returns a boolean if a field has been set. + +### SetFieldsNil + +`func (o *CreateSavedSearchRequest) SetFieldsNil(b bool)` + + SetFieldsNil sets the value for Fields to be an explicit nil + +### UnsetFields +`func (o *CreateSavedSearchRequest) UnsetFields()` + +UnsetFields ensures that no value is present for Fields, not even an explicit nil +### GetOrderBy + +`func (o *CreateSavedSearchRequest) GetOrderBy() map[string][]string` + +GetOrderBy returns the OrderBy field if non-nil, zero value otherwise. + +### GetOrderByOk + +`func (o *CreateSavedSearchRequest) GetOrderByOk() (*map[string][]string, bool)` + +GetOrderByOk returns a tuple with the OrderBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderBy + +`func (o *CreateSavedSearchRequest) SetOrderBy(v map[string][]string)` + +SetOrderBy sets OrderBy field to given value. + +### HasOrderBy + +`func (o *CreateSavedSearchRequest) HasOrderBy() bool` + +HasOrderBy returns a boolean if a field has been set. + +### SetOrderByNil + +`func (o *CreateSavedSearchRequest) SetOrderByNil(b bool)` + + SetOrderByNil sets the value for OrderBy to be an explicit nil + +### UnsetOrderBy +`func (o *CreateSavedSearchRequest) UnsetOrderBy()` + +UnsetOrderBy ensures that no value is present for OrderBy, not even an explicit nil +### GetSort + +`func (o *CreateSavedSearchRequest) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *CreateSavedSearchRequest) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *CreateSavedSearchRequest) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *CreateSavedSearchRequest) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### SetSortNil + +`func (o *CreateSavedSearchRequest) SetSortNil(b bool)` + + SetSortNil sets the value for Sort to be an explicit nil + +### UnsetSort +`func (o *CreateSavedSearchRequest) UnsetSort()` + +UnsetSort ensures that no value is present for Sort, not even an explicit nil +### GetFilters + +`func (o *CreateSavedSearchRequest) GetFilters() SavedSearchDetailFilters` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *CreateSavedSearchRequest) GetFiltersOk() (*SavedSearchDetailFilters, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *CreateSavedSearchRequest) SetFilters(v SavedSearchDetailFilters)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *CreateSavedSearchRequest) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### SetFiltersNil + +`func (o *CreateSavedSearchRequest) SetFiltersNil(b bool)` + + SetFiltersNil sets the value for Filters to be an explicit nil + +### UnsetFilters +`func (o *CreateSavedSearchRequest) UnsetFilters()` + +UnsetFilters ensures that no value is present for Filters, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CreateScheduledSearchRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/CreateScheduledSearchRequest.md new file mode 100644 index 000000000..ddde3e27b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CreateScheduledSearchRequest.md @@ -0,0 +1,323 @@ +--- +id: v2024-create-scheduled-search-request +title: CreateScheduledSearchRequest +pagination_label: CreateScheduledSearchRequest +sidebar_label: CreateScheduledSearchRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateScheduledSearchRequest', 'V2024CreateScheduledSearchRequest'] +slug: /tools/sdk/go/v2024/models/create-scheduled-search-request +tags: ['SDK', 'Software Development Kit', 'CreateScheduledSearchRequest', 'V2024CreateScheduledSearchRequest'] +--- + +# CreateScheduledSearchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **NullableString** | The name of the scheduled search. | [optional] +**Description** | Pointer to **NullableString** | The description of the scheduled search. | [optional] +**SavedSearchId** | **string** | The ID of the saved search that will be executed. | +**Created** | Pointer to **NullableTime** | The date the scheduled search was initially created. | [optional] [readonly] +**Modified** | Pointer to **NullableTime** | The last date the scheduled search was modified. | [optional] [readonly] +**Schedule** | [**Schedule2**](schedule2) | | +**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | +**Enabled** | Pointer to **bool** | Indicates if the scheduled search is enabled. | [optional] [default to false] +**EmailEmptyResults** | Pointer to **bool** | Indicates if email generation should occur when search returns no results. | [optional] [default to false] +**DisplayQueryDetails** | Pointer to **bool** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to false] + +## Methods + +### NewCreateScheduledSearchRequest + +`func NewCreateScheduledSearchRequest(savedSearchId string, schedule Schedule2, recipients []SearchScheduleRecipientsInner, ) *CreateScheduledSearchRequest` + +NewCreateScheduledSearchRequest instantiates a new CreateScheduledSearchRequest 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 + +### NewCreateScheduledSearchRequestWithDefaults + +`func NewCreateScheduledSearchRequestWithDefaults() *CreateScheduledSearchRequest` + +NewCreateScheduledSearchRequestWithDefaults instantiates a new CreateScheduledSearchRequest 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 + +### GetName + +`func (o *CreateScheduledSearchRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateScheduledSearchRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateScheduledSearchRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CreateScheduledSearchRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *CreateScheduledSearchRequest) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *CreateScheduledSearchRequest) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *CreateScheduledSearchRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateScheduledSearchRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateScheduledSearchRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CreateScheduledSearchRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *CreateScheduledSearchRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CreateScheduledSearchRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSavedSearchId + +`func (o *CreateScheduledSearchRequest) GetSavedSearchId() string` + +GetSavedSearchId returns the SavedSearchId field if non-nil, zero value otherwise. + +### GetSavedSearchIdOk + +`func (o *CreateScheduledSearchRequest) GetSavedSearchIdOk() (*string, bool)` + +GetSavedSearchIdOk returns a tuple with the SavedSearchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSavedSearchId + +`func (o *CreateScheduledSearchRequest) SetSavedSearchId(v string)` + +SetSavedSearchId sets SavedSearchId field to given value. + + +### GetCreated + +`func (o *CreateScheduledSearchRequest) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CreateScheduledSearchRequest) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CreateScheduledSearchRequest) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CreateScheduledSearchRequest) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *CreateScheduledSearchRequest) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *CreateScheduledSearchRequest) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *CreateScheduledSearchRequest) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CreateScheduledSearchRequest) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CreateScheduledSearchRequest) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CreateScheduledSearchRequest) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CreateScheduledSearchRequest) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CreateScheduledSearchRequest) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSchedule + +`func (o *CreateScheduledSearchRequest) GetSchedule() Schedule2` + +GetSchedule returns the Schedule field if non-nil, zero value otherwise. + +### GetScheduleOk + +`func (o *CreateScheduledSearchRequest) GetScheduleOk() (*Schedule2, bool)` + +GetScheduleOk returns a tuple with the Schedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchedule + +`func (o *CreateScheduledSearchRequest) SetSchedule(v Schedule2)` + +SetSchedule sets Schedule field to given value. + + +### GetRecipients + +`func (o *CreateScheduledSearchRequest) GetRecipients() []SearchScheduleRecipientsInner` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *CreateScheduledSearchRequest) GetRecipientsOk() (*[]SearchScheduleRecipientsInner, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *CreateScheduledSearchRequest) SetRecipients(v []SearchScheduleRecipientsInner)` + +SetRecipients sets Recipients field to given value. + + +### GetEnabled + +`func (o *CreateScheduledSearchRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CreateScheduledSearchRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *CreateScheduledSearchRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *CreateScheduledSearchRequest) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEmailEmptyResults + +`func (o *CreateScheduledSearchRequest) GetEmailEmptyResults() bool` + +GetEmailEmptyResults returns the EmailEmptyResults field if non-nil, zero value otherwise. + +### GetEmailEmptyResultsOk + +`func (o *CreateScheduledSearchRequest) GetEmailEmptyResultsOk() (*bool, bool)` + +GetEmailEmptyResultsOk returns a tuple with the EmailEmptyResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEmptyResults + +`func (o *CreateScheduledSearchRequest) SetEmailEmptyResults(v bool)` + +SetEmailEmptyResults sets EmailEmptyResults field to given value. + +### HasEmailEmptyResults + +`func (o *CreateScheduledSearchRequest) HasEmailEmptyResults() bool` + +HasEmailEmptyResults returns a boolean if a field has been set. + +### GetDisplayQueryDetails + +`func (o *CreateScheduledSearchRequest) GetDisplayQueryDetails() bool` + +GetDisplayQueryDetails returns the DisplayQueryDetails field if non-nil, zero value otherwise. + +### GetDisplayQueryDetailsOk + +`func (o *CreateScheduledSearchRequest) GetDisplayQueryDetailsOk() (*bool, bool)` + +GetDisplayQueryDetailsOk returns a tuple with the DisplayQueryDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayQueryDetails + +`func (o *CreateScheduledSearchRequest) SetDisplayQueryDetails(v bool)` + +SetDisplayQueryDetails sets DisplayQueryDetails field to given value. + +### HasDisplayQueryDetails + +`func (o *CreateScheduledSearchRequest) HasDisplayQueryDetails() bool` + +HasDisplayQueryDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CreateUploadedConfigurationRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/CreateUploadedConfigurationRequest.md new file mode 100644 index 000000000..f2edb8243 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CreateUploadedConfigurationRequest.md @@ -0,0 +1,80 @@ +--- +id: v2024-create-uploaded-configuration-request +title: CreateUploadedConfigurationRequest +pagination_label: CreateUploadedConfigurationRequest +sidebar_label: CreateUploadedConfigurationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateUploadedConfigurationRequest', 'V2024CreateUploadedConfigurationRequest'] +slug: /tools/sdk/go/v2024/models/create-uploaded-configuration-request +tags: ['SDK', 'Software Development Kit', 'CreateUploadedConfigurationRequest', 'V2024CreateUploadedConfigurationRequest'] +--- + +# CreateUploadedConfigurationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | ***os.File** | JSON file containing the objects to be imported. | +**Name** | **string** | Name that will be assigned to the uploaded configuration file. | + +## Methods + +### NewCreateUploadedConfigurationRequest + +`func NewCreateUploadedConfigurationRequest(data *os.File, name string, ) *CreateUploadedConfigurationRequest` + +NewCreateUploadedConfigurationRequest instantiates a new CreateUploadedConfigurationRequest 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 + +### NewCreateUploadedConfigurationRequestWithDefaults + +`func NewCreateUploadedConfigurationRequestWithDefaults() *CreateUploadedConfigurationRequest` + +NewCreateUploadedConfigurationRequestWithDefaults instantiates a new CreateUploadedConfigurationRequest 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 + +### GetData + +`func (o *CreateUploadedConfigurationRequest) GetData() *os.File` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *CreateUploadedConfigurationRequest) GetDataOk() (**os.File, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *CreateUploadedConfigurationRequest) SetData(v *os.File)` + +SetData sets Data field to given value. + + +### GetName + +`func (o *CreateUploadedConfigurationRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateUploadedConfigurationRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateUploadedConfigurationRequest) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CreateWorkflowRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/CreateWorkflowRequest.md new file mode 100644 index 000000000..19b5e26a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CreateWorkflowRequest.md @@ -0,0 +1,189 @@ +--- +id: v2024-create-workflow-request +title: CreateWorkflowRequest +pagination_label: CreateWorkflowRequest +sidebar_label: CreateWorkflowRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateWorkflowRequest', 'V2024CreateWorkflowRequest'] +slug: /tools/sdk/go/v2024/models/create-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateWorkflowRequest', 'V2024CreateWorkflowRequest'] +--- + +# CreateWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the workflow | +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **string** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **bool** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] + +## Methods + +### NewCreateWorkflowRequest + +`func NewCreateWorkflowRequest(name string, ) *CreateWorkflowRequest` + +NewCreateWorkflowRequest instantiates a new CreateWorkflowRequest 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 + +### NewCreateWorkflowRequestWithDefaults + +`func NewCreateWorkflowRequestWithDefaults() *CreateWorkflowRequest` + +NewCreateWorkflowRequestWithDefaults instantiates a new CreateWorkflowRequest 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 + +### GetName + +`func (o *CreateWorkflowRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateWorkflowRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateWorkflowRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetOwner + +`func (o *CreateWorkflowRequest) GetOwner() WorkflowBodyOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CreateWorkflowRequest) GetOwnerOk() (*WorkflowBodyOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CreateWorkflowRequest) SetOwner(v WorkflowBodyOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *CreateWorkflowRequest) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDescription + +`func (o *CreateWorkflowRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateWorkflowRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateWorkflowRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CreateWorkflowRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDefinition + +`func (o *CreateWorkflowRequest) GetDefinition() WorkflowDefinition` + +GetDefinition returns the Definition field if non-nil, zero value otherwise. + +### GetDefinitionOk + +`func (o *CreateWorkflowRequest) GetDefinitionOk() (*WorkflowDefinition, bool)` + +GetDefinitionOk returns a tuple with the Definition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefinition + +`func (o *CreateWorkflowRequest) SetDefinition(v WorkflowDefinition)` + +SetDefinition sets Definition field to given value. + +### HasDefinition + +`func (o *CreateWorkflowRequest) HasDefinition() bool` + +HasDefinition returns a boolean if a field has been set. + +### GetEnabled + +`func (o *CreateWorkflowRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CreateWorkflowRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *CreateWorkflowRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *CreateWorkflowRequest) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetTrigger + +`func (o *CreateWorkflowRequest) GetTrigger() WorkflowTrigger` + +GetTrigger returns the Trigger field if non-nil, zero value otherwise. + +### GetTriggerOk + +`func (o *CreateWorkflowRequest) GetTriggerOk() (*WorkflowTrigger, bool)` + +GetTriggerOk returns a tuple with the Trigger field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrigger + +`func (o *CreateWorkflowRequest) SetTrigger(v WorkflowTrigger)` + +SetTrigger sets Trigger field to given value. + +### HasTrigger + +`func (o *CreateWorkflowRequest) HasTrigger() bool` + +HasTrigger returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CriteriaType.md b/docs/tools/sdk/go/Reference/V2024/Models/CriteriaType.md new file mode 100644 index 000000000..54b4d7527 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CriteriaType.md @@ -0,0 +1,39 @@ +--- +id: v2024-criteria-type +title: CriteriaType +pagination_label: CriteriaType +sidebar_label: CriteriaType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CriteriaType', 'V2024CriteriaType'] +slug: /tools/sdk/go/v2024/models/criteria-type +tags: ['SDK', 'Software Development Kit', 'CriteriaType', 'V2024CriteriaType'] +--- + +# CriteriaType + +## Enum + + +* `COMPOSITE` (value: `"COMPOSITE"`) + +* `ROLE` (value: `"ROLE"`) + +* `IDENTITY` (value: `"IDENTITY"`) + +* `IDENTITY_ATTRIBUTE` (value: `"IDENTITY_ATTRIBUTE"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `SOURCE` (value: `"SOURCE"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `AGGREGATED_ENTITLEMENT` (value: `"AGGREGATED_ENTITLEMENT"`) + +* `INVALID_CERTIFIABLE_ENTITY` (value: `"INVALID_CERTIFIABLE_ENTITY"`) + +* `INVALID_CERTIFIABLE_BUNDLE` (value: `"INVALID_CERTIFIABLE_BUNDLE"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/CustomPasswordInstruction.md b/docs/tools/sdk/go/Reference/V2024/Models/CustomPasswordInstruction.md new file mode 100644 index 000000000..d7efed065 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/CustomPasswordInstruction.md @@ -0,0 +1,116 @@ +--- +id: v2024-custom-password-instruction +title: CustomPasswordInstruction +pagination_label: CustomPasswordInstruction +sidebar_label: CustomPasswordInstruction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CustomPasswordInstruction', 'V2024CustomPasswordInstruction'] +slug: /tools/sdk/go/v2024/models/custom-password-instruction +tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstruction', 'V2024CustomPasswordInstruction'] +--- + +# CustomPasswordInstruction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PageId** | Pointer to **string** | The page ID that represents the page for forget user name, reset password and unlock account flow. | [optional] +**PageContent** | Pointer to **string** | The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like `...` clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: `link`. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target. | [optional] +**Locale** | Pointer to **string** | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". | [optional] + +## Methods + +### NewCustomPasswordInstruction + +`func NewCustomPasswordInstruction() *CustomPasswordInstruction` + +NewCustomPasswordInstruction instantiates a new CustomPasswordInstruction 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 + +### NewCustomPasswordInstructionWithDefaults + +`func NewCustomPasswordInstructionWithDefaults() *CustomPasswordInstruction` + +NewCustomPasswordInstructionWithDefaults instantiates a new CustomPasswordInstruction 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 + +### GetPageId + +`func (o *CustomPasswordInstruction) GetPageId() string` + +GetPageId returns the PageId field if non-nil, zero value otherwise. + +### GetPageIdOk + +`func (o *CustomPasswordInstruction) GetPageIdOk() (*string, bool)` + +GetPageIdOk returns a tuple with the PageId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPageId + +`func (o *CustomPasswordInstruction) SetPageId(v string)` + +SetPageId sets PageId field to given value. + +### HasPageId + +`func (o *CustomPasswordInstruction) HasPageId() bool` + +HasPageId returns a boolean if a field has been set. + +### GetPageContent + +`func (o *CustomPasswordInstruction) GetPageContent() string` + +GetPageContent returns the PageContent field if non-nil, zero value otherwise. + +### GetPageContentOk + +`func (o *CustomPasswordInstruction) GetPageContentOk() (*string, bool)` + +GetPageContentOk returns a tuple with the PageContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPageContent + +`func (o *CustomPasswordInstruction) SetPageContent(v string)` + +SetPageContent sets PageContent field to given value. + +### HasPageContent + +`func (o *CustomPasswordInstruction) HasPageContent() bool` + +HasPageContent returns a boolean if a field has been set. + +### GetLocale + +`func (o *CustomPasswordInstruction) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *CustomPasswordInstruction) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *CustomPasswordInstruction) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *CustomPasswordInstruction) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DataAccess.md b/docs/tools/sdk/go/Reference/V2024/Models/DataAccess.md new file mode 100644 index 000000000..df7268f42 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DataAccess.md @@ -0,0 +1,116 @@ +--- +id: v2024-data-access +title: DataAccess +pagination_label: DataAccess +sidebar_label: DataAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DataAccess', 'V2024DataAccess'] +slug: /tools/sdk/go/v2024/models/data-access +tags: ['SDK', 'Software Development Kit', 'DataAccess', 'V2024DataAccess'] +--- + +# DataAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policies** | Pointer to [**[]DataAccessPoliciesInner**](data-access-policies-inner) | List of classification policies that apply to resources the entitlement \\ groups has access to | [optional] +**Categories** | Pointer to [**[]DataAccessCategoriesInner**](data-access-categories-inner) | List of classification categories that apply to resources the entitlement \\ groups has access to | [optional] +**ImpactScore** | Pointer to [**DataAccessImpactScore**](data-access-impact-score) | | [optional] + +## Methods + +### NewDataAccess + +`func NewDataAccess() *DataAccess` + +NewDataAccess instantiates a new DataAccess 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 + +### NewDataAccessWithDefaults + +`func NewDataAccessWithDefaults() *DataAccess` + +NewDataAccessWithDefaults instantiates a new DataAccess 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 + +### GetPolicies + +`func (o *DataAccess) GetPolicies() []DataAccessPoliciesInner` + +GetPolicies returns the Policies field if non-nil, zero value otherwise. + +### GetPoliciesOk + +`func (o *DataAccess) GetPoliciesOk() (*[]DataAccessPoliciesInner, bool)` + +GetPoliciesOk returns a tuple with the Policies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicies + +`func (o *DataAccess) SetPolicies(v []DataAccessPoliciesInner)` + +SetPolicies sets Policies field to given value. + +### HasPolicies + +`func (o *DataAccess) HasPolicies() bool` + +HasPolicies returns a boolean if a field has been set. + +### GetCategories + +`func (o *DataAccess) GetCategories() []DataAccessCategoriesInner` + +GetCategories returns the Categories field if non-nil, zero value otherwise. + +### GetCategoriesOk + +`func (o *DataAccess) GetCategoriesOk() (*[]DataAccessCategoriesInner, bool)` + +GetCategoriesOk returns a tuple with the Categories field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCategories + +`func (o *DataAccess) SetCategories(v []DataAccessCategoriesInner)` + +SetCategories sets Categories field to given value. + +### HasCategories + +`func (o *DataAccess) HasCategories() bool` + +HasCategories returns a boolean if a field has been set. + +### GetImpactScore + +`func (o *DataAccess) GetImpactScore() DataAccessImpactScore` + +GetImpactScore returns the ImpactScore field if non-nil, zero value otherwise. + +### GetImpactScoreOk + +`func (o *DataAccess) GetImpactScoreOk() (*DataAccessImpactScore, bool)` + +GetImpactScoreOk returns a tuple with the ImpactScore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImpactScore + +`func (o *DataAccess) SetImpactScore(v DataAccessImpactScore)` + +SetImpactScore sets ImpactScore field to given value. + +### HasImpactScore + +`func (o *DataAccess) HasImpactScore() bool` + +HasImpactScore returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DataAccessCategoriesInner.md b/docs/tools/sdk/go/Reference/V2024/Models/DataAccessCategoriesInner.md new file mode 100644 index 000000000..638654949 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DataAccessCategoriesInner.md @@ -0,0 +1,90 @@ +--- +id: v2024-data-access-categories-inner +title: DataAccessCategoriesInner +pagination_label: DataAccessCategoriesInner +sidebar_label: DataAccessCategoriesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DataAccessCategoriesInner', 'V2024DataAccessCategoriesInner'] +slug: /tools/sdk/go/v2024/models/data-access-categories-inner +tags: ['SDK', 'Software Development Kit', 'DataAccessCategoriesInner', 'V2024DataAccessCategoriesInner'] +--- + +# DataAccessCategoriesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | Value of the category | [optional] +**MatchCount** | Pointer to **int32** | Number of matched for each category | [optional] + +## Methods + +### NewDataAccessCategoriesInner + +`func NewDataAccessCategoriesInner() *DataAccessCategoriesInner` + +NewDataAccessCategoriesInner instantiates a new DataAccessCategoriesInner 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 + +### NewDataAccessCategoriesInnerWithDefaults + +`func NewDataAccessCategoriesInnerWithDefaults() *DataAccessCategoriesInner` + +NewDataAccessCategoriesInnerWithDefaults instantiates a new DataAccessCategoriesInner 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 + +### GetValue + +`func (o *DataAccessCategoriesInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *DataAccessCategoriesInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *DataAccessCategoriesInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *DataAccessCategoriesInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetMatchCount + +`func (o *DataAccessCategoriesInner) GetMatchCount() int32` + +GetMatchCount returns the MatchCount field if non-nil, zero value otherwise. + +### GetMatchCountOk + +`func (o *DataAccessCategoriesInner) GetMatchCountOk() (*int32, bool)` + +GetMatchCountOk returns a tuple with the MatchCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchCount + +`func (o *DataAccessCategoriesInner) SetMatchCount(v int32)` + +SetMatchCount sets MatchCount field to given value. + +### HasMatchCount + +`func (o *DataAccessCategoriesInner) HasMatchCount() bool` + +HasMatchCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DataAccessImpactScore.md b/docs/tools/sdk/go/Reference/V2024/Models/DataAccessImpactScore.md new file mode 100644 index 000000000..e57b1d1c9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DataAccessImpactScore.md @@ -0,0 +1,64 @@ +--- +id: v2024-data-access-impact-score +title: DataAccessImpactScore +pagination_label: DataAccessImpactScore +sidebar_label: DataAccessImpactScore +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DataAccessImpactScore', 'V2024DataAccessImpactScore'] +slug: /tools/sdk/go/v2024/models/data-access-impact-score +tags: ['SDK', 'Software Development Kit', 'DataAccessImpactScore', 'V2024DataAccessImpactScore'] +--- + +# DataAccessImpactScore + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | Impact Score for this data | [optional] + +## Methods + +### NewDataAccessImpactScore + +`func NewDataAccessImpactScore() *DataAccessImpactScore` + +NewDataAccessImpactScore instantiates a new DataAccessImpactScore 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 + +### NewDataAccessImpactScoreWithDefaults + +`func NewDataAccessImpactScoreWithDefaults() *DataAccessImpactScore` + +NewDataAccessImpactScoreWithDefaults instantiates a new DataAccessImpactScore 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 + +### GetValue + +`func (o *DataAccessImpactScore) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *DataAccessImpactScore) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *DataAccessImpactScore) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *DataAccessImpactScore) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DataAccessPoliciesInner.md b/docs/tools/sdk/go/Reference/V2024/Models/DataAccessPoliciesInner.md new file mode 100644 index 000000000..f6272b561 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DataAccessPoliciesInner.md @@ -0,0 +1,64 @@ +--- +id: v2024-data-access-policies-inner +title: DataAccessPoliciesInner +pagination_label: DataAccessPoliciesInner +sidebar_label: DataAccessPoliciesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DataAccessPoliciesInner', 'V2024DataAccessPoliciesInner'] +slug: /tools/sdk/go/v2024/models/data-access-policies-inner +tags: ['SDK', 'Software Development Kit', 'DataAccessPoliciesInner', 'V2024DataAccessPoliciesInner'] +--- + +# DataAccessPoliciesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | Value of the policy | [optional] + +## Methods + +### NewDataAccessPoliciesInner + +`func NewDataAccessPoliciesInner() *DataAccessPoliciesInner` + +NewDataAccessPoliciesInner instantiates a new DataAccessPoliciesInner 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 + +### NewDataAccessPoliciesInnerWithDefaults + +`func NewDataAccessPoliciesInnerWithDefaults() *DataAccessPoliciesInner` + +NewDataAccessPoliciesInnerWithDefaults instantiates a new DataAccessPoliciesInner 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 + +### GetValue + +`func (o *DataAccessPoliciesInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *DataAccessPoliciesInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *DataAccessPoliciesInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *DataAccessPoliciesInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DataSegment.md b/docs/tools/sdk/go/Reference/V2024/Models/DataSegment.md new file mode 100644 index 000000000..843f11c8e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DataSegment.md @@ -0,0 +1,324 @@ +--- +id: v2024-data-segment +title: DataSegment +pagination_label: DataSegment +sidebar_label: DataSegment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DataSegment', 'V2024DataSegment'] +slug: /tools/sdk/go/v2024/models/data-segment +tags: ['SDK', 'Software Development Kit', 'DataSegment', 'V2024DataSegment'] +--- + +# DataSegment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The segment's ID. | [optional] +**Name** | Pointer to **string** | The segment's business name. | [optional] +**Created** | Pointer to **SailPointTime** | The time when the segment is created. | [optional] +**Modified** | Pointer to **SailPointTime** | The time when the segment is modified. | [optional] +**Description** | Pointer to **string** | The segment's optional description. | [optional] +**Scopes** | Pointer to [**[]Scope**](scope) | List of Scopes that are assigned to the segment | [optional] +**MemberSelection** | Pointer to [**[]Ref**](ref) | List of Identities that are assigned to the segment | [optional] +**MemberFilter** | Pointer to [**VisibilityCriteria**](visibility-criteria) | | [optional] +**Membership** | Pointer to [**MembershipType**](membership-type) | | [optional] +**Enabled** | Pointer to **bool** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to false] +**Published** | Pointer to **bool** | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified to until published | [optional] [default to false] + +## Methods + +### NewDataSegment + +`func NewDataSegment() *DataSegment` + +NewDataSegment instantiates a new DataSegment 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 + +### NewDataSegmentWithDefaults + +`func NewDataSegmentWithDefaults() *DataSegment` + +NewDataSegmentWithDefaults instantiates a new DataSegment 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 + +### GetId + +`func (o *DataSegment) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DataSegment) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DataSegment) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DataSegment) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *DataSegment) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DataSegment) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DataSegment) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DataSegment) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *DataSegment) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *DataSegment) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *DataSegment) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *DataSegment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *DataSegment) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *DataSegment) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *DataSegment) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *DataSegment) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *DataSegment) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *DataSegment) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *DataSegment) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *DataSegment) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetScopes + +`func (o *DataSegment) GetScopes() []Scope` + +GetScopes returns the Scopes field if non-nil, zero value otherwise. + +### GetScopesOk + +`func (o *DataSegment) GetScopesOk() (*[]Scope, bool)` + +GetScopesOk returns a tuple with the Scopes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScopes + +`func (o *DataSegment) SetScopes(v []Scope)` + +SetScopes sets Scopes field to given value. + +### HasScopes + +`func (o *DataSegment) HasScopes() bool` + +HasScopes returns a boolean if a field has been set. + +### GetMemberSelection + +`func (o *DataSegment) GetMemberSelection() []Ref` + +GetMemberSelection returns the MemberSelection field if non-nil, zero value otherwise. + +### GetMemberSelectionOk + +`func (o *DataSegment) GetMemberSelectionOk() (*[]Ref, bool)` + +GetMemberSelectionOk returns a tuple with the MemberSelection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMemberSelection + +`func (o *DataSegment) SetMemberSelection(v []Ref)` + +SetMemberSelection sets MemberSelection field to given value. + +### HasMemberSelection + +`func (o *DataSegment) HasMemberSelection() bool` + +HasMemberSelection returns a boolean if a field has been set. + +### GetMemberFilter + +`func (o *DataSegment) GetMemberFilter() VisibilityCriteria` + +GetMemberFilter returns the MemberFilter field if non-nil, zero value otherwise. + +### GetMemberFilterOk + +`func (o *DataSegment) GetMemberFilterOk() (*VisibilityCriteria, bool)` + +GetMemberFilterOk returns a tuple with the MemberFilter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMemberFilter + +`func (o *DataSegment) SetMemberFilter(v VisibilityCriteria)` + +SetMemberFilter sets MemberFilter field to given value. + +### HasMemberFilter + +`func (o *DataSegment) HasMemberFilter() bool` + +HasMemberFilter returns a boolean if a field has been set. + +### GetMembership + +`func (o *DataSegment) GetMembership() MembershipType` + +GetMembership returns the Membership field if non-nil, zero value otherwise. + +### GetMembershipOk + +`func (o *DataSegment) GetMembershipOk() (*MembershipType, bool)` + +GetMembershipOk returns a tuple with the Membership field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMembership + +`func (o *DataSegment) SetMembership(v MembershipType)` + +SetMembership sets Membership field to given value. + +### HasMembership + +`func (o *DataSegment) HasMembership() bool` + +HasMembership returns a boolean if a field has been set. + +### GetEnabled + +`func (o *DataSegment) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *DataSegment) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *DataSegment) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *DataSegment) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetPublished + +`func (o *DataSegment) GetPublished() bool` + +GetPublished returns the Published field if non-nil, zero value otherwise. + +### GetPublishedOk + +`func (o *DataSegment) GetPublishedOk() (*bool, bool)` + +GetPublishedOk returns a tuple with the Published field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublished + +`func (o *DataSegment) SetPublished(v bool)` + +SetPublished sets Published field to given value. + +### HasPublished + +`func (o *DataSegment) HasPublished() bool` + +HasPublished returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DeleteNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/DeleteNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..15213b432 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DeleteNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,59 @@ +--- +id: v2024-delete-non-employee-records-in-bulk-request +title: DeleteNonEmployeeRecordsInBulkRequest +pagination_label: DeleteNonEmployeeRecordsInBulkRequest +sidebar_label: DeleteNonEmployeeRecordsInBulkRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DeleteNonEmployeeRecordsInBulkRequest', 'V2024DeleteNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/go/v2024/models/delete-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'DeleteNonEmployeeRecordsInBulkRequest', 'V2024DeleteNonEmployeeRecordsInBulkRequest'] +--- + +# DeleteNonEmployeeRecordsInBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | **[]string** | List of non-employee ids. | + +## Methods + +### NewDeleteNonEmployeeRecordsInBulkRequest + +`func NewDeleteNonEmployeeRecordsInBulkRequest(ids []string, ) *DeleteNonEmployeeRecordsInBulkRequest` + +NewDeleteNonEmployeeRecordsInBulkRequest instantiates a new DeleteNonEmployeeRecordsInBulkRequest 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 + +### NewDeleteNonEmployeeRecordsInBulkRequestWithDefaults + +`func NewDeleteNonEmployeeRecordsInBulkRequestWithDefaults() *DeleteNonEmployeeRecordsInBulkRequest` + +NewDeleteNonEmployeeRecordsInBulkRequestWithDefaults instantiates a new DeleteNonEmployeeRecordsInBulkRequest 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 + +### GetIds + +`func (o *DeleteNonEmployeeRecordsInBulkRequest) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *DeleteNonEmployeeRecordsInBulkRequest) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *DeleteNonEmployeeRecordsInBulkRequest) SetIds(v []string)` + +SetIds sets Ids field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DeleteSource202Response.md b/docs/tools/sdk/go/Reference/V2024/Models/DeleteSource202Response.md new file mode 100644 index 000000000..2d036497c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DeleteSource202Response.md @@ -0,0 +1,116 @@ +--- +id: v2024-delete-source202-response +title: DeleteSource202Response +pagination_label: DeleteSource202Response +sidebar_label: DeleteSource202Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DeleteSource202Response', 'V2024DeleteSource202Response'] +slug: /tools/sdk/go/v2024/models/delete-source202-response +tags: ['SDK', 'Software Development Kit', 'DeleteSource202Response', 'V2024DeleteSource202Response'] +--- + +# DeleteSource202Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Task result ID. | [optional] +**Name** | Pointer to **string** | Task result's human-readable display name (this should be null/empty). | [optional] + +## Methods + +### NewDeleteSource202Response + +`func NewDeleteSource202Response() *DeleteSource202Response` + +NewDeleteSource202Response instantiates a new DeleteSource202Response 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 + +### NewDeleteSource202ResponseWithDefaults + +`func NewDeleteSource202ResponseWithDefaults() *DeleteSource202Response` + +NewDeleteSource202ResponseWithDefaults instantiates a new DeleteSource202Response 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 + +### GetType + +`func (o *DeleteSource202Response) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DeleteSource202Response) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DeleteSource202Response) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DeleteSource202Response) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *DeleteSource202Response) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DeleteSource202Response) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DeleteSource202Response) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DeleteSource202Response) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *DeleteSource202Response) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DeleteSource202Response) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DeleteSource202Response) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DeleteSource202Response) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DeleteVendorConnectorMapping200Response.md b/docs/tools/sdk/go/Reference/V2024/Models/DeleteVendorConnectorMapping200Response.md new file mode 100644 index 000000000..906404e72 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DeleteVendorConnectorMapping200Response.md @@ -0,0 +1,64 @@ +--- +id: v2024-delete-vendor-connector-mapping200-response +title: DeleteVendorConnectorMapping200Response +pagination_label: DeleteVendorConnectorMapping200Response +sidebar_label: DeleteVendorConnectorMapping200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DeleteVendorConnectorMapping200Response', 'V2024DeleteVendorConnectorMapping200Response'] +slug: /tools/sdk/go/v2024/models/delete-vendor-connector-mapping200-response +tags: ['SDK', 'Software Development Kit', 'DeleteVendorConnectorMapping200Response', 'V2024DeleteVendorConnectorMapping200Response'] +--- + +# DeleteVendorConnectorMapping200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **int32** | The number of vendor connector mappings successfully deleted. | [optional] + +## Methods + +### NewDeleteVendorConnectorMapping200Response + +`func NewDeleteVendorConnectorMapping200Response() *DeleteVendorConnectorMapping200Response` + +NewDeleteVendorConnectorMapping200Response instantiates a new DeleteVendorConnectorMapping200Response 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 + +### NewDeleteVendorConnectorMapping200ResponseWithDefaults + +`func NewDeleteVendorConnectorMapping200ResponseWithDefaults() *DeleteVendorConnectorMapping200Response` + +NewDeleteVendorConnectorMapping200ResponseWithDefaults instantiates a new DeleteVendorConnectorMapping200Response 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 + +### GetCount + +`func (o *DeleteVendorConnectorMapping200Response) GetCount() int32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *DeleteVendorConnectorMapping200Response) GetCountOk() (*int32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *DeleteVendorConnectorMapping200Response) SetCount(v int32)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *DeleteVendorConnectorMapping200Response) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DependantAppConnections.md b/docs/tools/sdk/go/Reference/V2024/Models/DependantAppConnections.md new file mode 100644 index 000000000..87b27372c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DependantAppConnections.md @@ -0,0 +1,272 @@ +--- +id: v2024-dependant-app-connections +title: DependantAppConnections +pagination_label: DependantAppConnections +sidebar_label: DependantAppConnections +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DependantAppConnections', 'V2024DependantAppConnections'] +slug: /tools/sdk/go/v2024/models/dependant-app-connections +tags: ['SDK', 'Software Development Kit', 'DependantAppConnections', 'V2024DependantAppConnections'] +--- + +# DependantAppConnections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CloudAppId** | Pointer to **string** | Id of the connected Application | [optional] +**Description** | Pointer to **string** | Description of the connected Application | [optional] +**Enabled** | Pointer to **bool** | Is the Application enabled | [optional] [default to true] +**ProvisionRequestEnabled** | Pointer to **bool** | Is Provisioning enabled for connected Application | [optional] [default to true] +**AccountSource** | Pointer to [**DependantAppConnectionsAccountSource**](dependant-app-connections-account-source) | | [optional] +**LauncherCount** | Pointer to **int64** | The amount of launchers for connected Application (long type) | [optional] +**MatchAllAccount** | Pointer to **bool** | Is Provisioning enabled for connected Application | [optional] [default to false] +**Owner** | Pointer to [**[]BaseReferenceDto**](base-reference-dto) | The owner of the connected Application | [optional] +**AppCenterEnabled** | Pointer to **bool** | Is App Center enabled for connected Application | [optional] [default to false] + +## Methods + +### NewDependantAppConnections + +`func NewDependantAppConnections() *DependantAppConnections` + +NewDependantAppConnections instantiates a new DependantAppConnections 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 + +### NewDependantAppConnectionsWithDefaults + +`func NewDependantAppConnectionsWithDefaults() *DependantAppConnections` + +NewDependantAppConnectionsWithDefaults instantiates a new DependantAppConnections 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 + +### GetCloudAppId + +`func (o *DependantAppConnections) GetCloudAppId() string` + +GetCloudAppId returns the CloudAppId field if non-nil, zero value otherwise. + +### GetCloudAppIdOk + +`func (o *DependantAppConnections) GetCloudAppIdOk() (*string, bool)` + +GetCloudAppIdOk returns a tuple with the CloudAppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudAppId + +`func (o *DependantAppConnections) SetCloudAppId(v string)` + +SetCloudAppId sets CloudAppId field to given value. + +### HasCloudAppId + +`func (o *DependantAppConnections) HasCloudAppId() bool` + +HasCloudAppId returns a boolean if a field has been set. + +### GetDescription + +`func (o *DependantAppConnections) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *DependantAppConnections) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *DependantAppConnections) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *DependantAppConnections) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetEnabled + +`func (o *DependantAppConnections) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *DependantAppConnections) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *DependantAppConnections) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *DependantAppConnections) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetProvisionRequestEnabled + +`func (o *DependantAppConnections) GetProvisionRequestEnabled() bool` + +GetProvisionRequestEnabled returns the ProvisionRequestEnabled field if non-nil, zero value otherwise. + +### GetProvisionRequestEnabledOk + +`func (o *DependantAppConnections) GetProvisionRequestEnabledOk() (*bool, bool)` + +GetProvisionRequestEnabledOk returns a tuple with the ProvisionRequestEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionRequestEnabled + +`func (o *DependantAppConnections) SetProvisionRequestEnabled(v bool)` + +SetProvisionRequestEnabled sets ProvisionRequestEnabled field to given value. + +### HasProvisionRequestEnabled + +`func (o *DependantAppConnections) HasProvisionRequestEnabled() bool` + +HasProvisionRequestEnabled returns a boolean if a field has been set. + +### GetAccountSource + +`func (o *DependantAppConnections) GetAccountSource() DependantAppConnectionsAccountSource` + +GetAccountSource returns the AccountSource field if non-nil, zero value otherwise. + +### GetAccountSourceOk + +`func (o *DependantAppConnections) GetAccountSourceOk() (*DependantAppConnectionsAccountSource, bool)` + +GetAccountSourceOk returns a tuple with the AccountSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSource + +`func (o *DependantAppConnections) SetAccountSource(v DependantAppConnectionsAccountSource)` + +SetAccountSource sets AccountSource field to given value. + +### HasAccountSource + +`func (o *DependantAppConnections) HasAccountSource() bool` + +HasAccountSource returns a boolean if a field has been set. + +### GetLauncherCount + +`func (o *DependantAppConnections) GetLauncherCount() int64` + +GetLauncherCount returns the LauncherCount field if non-nil, zero value otherwise. + +### GetLauncherCountOk + +`func (o *DependantAppConnections) GetLauncherCountOk() (*int64, bool)` + +GetLauncherCountOk returns a tuple with the LauncherCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncherCount + +`func (o *DependantAppConnections) SetLauncherCount(v int64)` + +SetLauncherCount sets LauncherCount field to given value. + +### HasLauncherCount + +`func (o *DependantAppConnections) HasLauncherCount() bool` + +HasLauncherCount returns a boolean if a field has been set. + +### GetMatchAllAccount + +`func (o *DependantAppConnections) GetMatchAllAccount() bool` + +GetMatchAllAccount returns the MatchAllAccount field if non-nil, zero value otherwise. + +### GetMatchAllAccountOk + +`func (o *DependantAppConnections) GetMatchAllAccountOk() (*bool, bool)` + +GetMatchAllAccountOk returns a tuple with the MatchAllAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAllAccount + +`func (o *DependantAppConnections) SetMatchAllAccount(v bool)` + +SetMatchAllAccount sets MatchAllAccount field to given value. + +### HasMatchAllAccount + +`func (o *DependantAppConnections) HasMatchAllAccount() bool` + +HasMatchAllAccount returns a boolean if a field has been set. + +### GetOwner + +`func (o *DependantAppConnections) GetOwner() []BaseReferenceDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *DependantAppConnections) GetOwnerOk() (*[]BaseReferenceDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *DependantAppConnections) SetOwner(v []BaseReferenceDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *DependantAppConnections) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetAppCenterEnabled + +`func (o *DependantAppConnections) GetAppCenterEnabled() bool` + +GetAppCenterEnabled returns the AppCenterEnabled field if non-nil, zero value otherwise. + +### GetAppCenterEnabledOk + +`func (o *DependantAppConnections) GetAppCenterEnabledOk() (*bool, bool)` + +GetAppCenterEnabledOk returns a tuple with the AppCenterEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppCenterEnabled + +`func (o *DependantAppConnections) SetAppCenterEnabled(v bool)` + +SetAppCenterEnabled sets AppCenterEnabled field to given value. + +### HasAppCenterEnabled + +`func (o *DependantAppConnections) HasAppCenterEnabled() bool` + +HasAppCenterEnabled returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DependantAppConnectionsAccountSource.md b/docs/tools/sdk/go/Reference/V2024/Models/DependantAppConnectionsAccountSource.md new file mode 100644 index 000000000..468bda4fe --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DependantAppConnectionsAccountSource.md @@ -0,0 +1,90 @@ +--- +id: v2024-dependant-app-connections-account-source +title: DependantAppConnectionsAccountSource +pagination_label: DependantAppConnectionsAccountSource +sidebar_label: DependantAppConnectionsAccountSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DependantAppConnectionsAccountSource', 'V2024DependantAppConnectionsAccountSource'] +slug: /tools/sdk/go/v2024/models/dependant-app-connections-account-source +tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSource', 'V2024DependantAppConnectionsAccountSource'] +--- + +# DependantAppConnectionsAccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UseForPasswordManagement** | Pointer to **bool** | Use this Account Source for password management | [optional] [default to false] +**PasswordPolicies** | Pointer to [**[]DependantAppConnectionsAccountSourcePasswordPoliciesInner**](dependant-app-connections-account-source-password-policies-inner) | A list of Password Policies for this Account Source | [optional] + +## Methods + +### NewDependantAppConnectionsAccountSource + +`func NewDependantAppConnectionsAccountSource() *DependantAppConnectionsAccountSource` + +NewDependantAppConnectionsAccountSource instantiates a new DependantAppConnectionsAccountSource 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 + +### NewDependantAppConnectionsAccountSourceWithDefaults + +`func NewDependantAppConnectionsAccountSourceWithDefaults() *DependantAppConnectionsAccountSource` + +NewDependantAppConnectionsAccountSourceWithDefaults instantiates a new DependantAppConnectionsAccountSource 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 + +### GetUseForPasswordManagement + +`func (o *DependantAppConnectionsAccountSource) GetUseForPasswordManagement() bool` + +GetUseForPasswordManagement returns the UseForPasswordManagement field if non-nil, zero value otherwise. + +### GetUseForPasswordManagementOk + +`func (o *DependantAppConnectionsAccountSource) GetUseForPasswordManagementOk() (*bool, bool)` + +GetUseForPasswordManagementOk returns a tuple with the UseForPasswordManagement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseForPasswordManagement + +`func (o *DependantAppConnectionsAccountSource) SetUseForPasswordManagement(v bool)` + +SetUseForPasswordManagement sets UseForPasswordManagement field to given value. + +### HasUseForPasswordManagement + +`func (o *DependantAppConnectionsAccountSource) HasUseForPasswordManagement() bool` + +HasUseForPasswordManagement returns a boolean if a field has been set. + +### GetPasswordPolicies + +`func (o *DependantAppConnectionsAccountSource) GetPasswordPolicies() []DependantAppConnectionsAccountSourcePasswordPoliciesInner` + +GetPasswordPolicies returns the PasswordPolicies field if non-nil, zero value otherwise. + +### GetPasswordPoliciesOk + +`func (o *DependantAppConnectionsAccountSource) GetPasswordPoliciesOk() (*[]DependantAppConnectionsAccountSourcePasswordPoliciesInner, bool)` + +GetPasswordPoliciesOk returns a tuple with the PasswordPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicies + +`func (o *DependantAppConnectionsAccountSource) SetPasswordPolicies(v []DependantAppConnectionsAccountSourcePasswordPoliciesInner)` + +SetPasswordPolicies sets PasswordPolicies field to given value. + +### HasPasswordPolicies + +`func (o *DependantAppConnectionsAccountSource) HasPasswordPolicies() bool` + +HasPasswordPolicies returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md b/docs/tools/sdk/go/Reference/V2024/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md new file mode 100644 index 000000000..7caa7f5cb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md @@ -0,0 +1,116 @@ +--- +id: v2024-dependant-app-connections-account-source-password-policies-inner +title: DependantAppConnectionsAccountSourcePasswordPoliciesInner +pagination_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner +sidebar_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner', 'V2024DependantAppConnectionsAccountSourcePasswordPoliciesInner'] +slug: /tools/sdk/go/v2024/models/dependant-app-connections-account-source-password-policies-inner +tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner', 'V2024DependantAppConnectionsAccountSourcePasswordPoliciesInner'] +--- + +# DependantAppConnectionsAccountSourcePasswordPoliciesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewDependantAppConnectionsAccountSourcePasswordPoliciesInner + +`func NewDependantAppConnectionsAccountSourcePasswordPoliciesInner() *DependantAppConnectionsAccountSourcePasswordPoliciesInner` + +NewDependantAppConnectionsAccountSourcePasswordPoliciesInner instantiates a new DependantAppConnectionsAccountSourcePasswordPoliciesInner 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 + +### NewDependantAppConnectionsAccountSourcePasswordPoliciesInnerWithDefaults + +`func NewDependantAppConnectionsAccountSourcePasswordPoliciesInnerWithDefaults() *DependantAppConnectionsAccountSourcePasswordPoliciesInner` + +NewDependantAppConnectionsAccountSourcePasswordPoliciesInnerWithDefaults instantiates a new DependantAppConnectionsAccountSourcePasswordPoliciesInner 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 + +### GetType + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DependantConnectionsMissingDto.md b/docs/tools/sdk/go/Reference/V2024/Models/DependantConnectionsMissingDto.md new file mode 100644 index 000000000..b1b346220 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DependantConnectionsMissingDto.md @@ -0,0 +1,90 @@ +--- +id: v2024-dependant-connections-missing-dto +title: DependantConnectionsMissingDto +pagination_label: DependantConnectionsMissingDto +sidebar_label: DependantConnectionsMissingDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DependantConnectionsMissingDto', 'V2024DependantConnectionsMissingDto'] +slug: /tools/sdk/go/v2024/models/dependant-connections-missing-dto +tags: ['SDK', 'Software Development Kit', 'DependantConnectionsMissingDto', 'V2024DependantConnectionsMissingDto'] +--- + +# DependantConnectionsMissingDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DependencyType** | Pointer to **string** | The type of dependency type that is missing in the SourceConnections | [optional] +**Reason** | Pointer to **string** | The reason why this dependency is missing | [optional] + +## Methods + +### NewDependantConnectionsMissingDto + +`func NewDependantConnectionsMissingDto() *DependantConnectionsMissingDto` + +NewDependantConnectionsMissingDto instantiates a new DependantConnectionsMissingDto 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 + +### NewDependantConnectionsMissingDtoWithDefaults + +`func NewDependantConnectionsMissingDtoWithDefaults() *DependantConnectionsMissingDto` + +NewDependantConnectionsMissingDtoWithDefaults instantiates a new DependantConnectionsMissingDto 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 + +### GetDependencyType + +`func (o *DependantConnectionsMissingDto) GetDependencyType() string` + +GetDependencyType returns the DependencyType field if non-nil, zero value otherwise. + +### GetDependencyTypeOk + +`func (o *DependantConnectionsMissingDto) GetDependencyTypeOk() (*string, bool)` + +GetDependencyTypeOk returns a tuple with the DependencyType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDependencyType + +`func (o *DependantConnectionsMissingDto) SetDependencyType(v string)` + +SetDependencyType sets DependencyType field to given value. + +### HasDependencyType + +`func (o *DependantConnectionsMissingDto) HasDependencyType() bool` + +HasDependencyType returns a boolean if a field has been set. + +### GetReason + +`func (o *DependantConnectionsMissingDto) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *DependantConnectionsMissingDto) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *DependantConnectionsMissingDto) SetReason(v string)` + +SetReason sets Reason field to given value. + +### HasReason + +`func (o *DependantConnectionsMissingDto) HasReason() bool` + +HasReason returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DeployRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/DeployRequest.md new file mode 100644 index 000000000..389c2a6cf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DeployRequest.md @@ -0,0 +1,59 @@ +--- +id: v2024-deploy-request +title: DeployRequest +pagination_label: DeployRequest +sidebar_label: DeployRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DeployRequest', 'V2024DeployRequest'] +slug: /tools/sdk/go/v2024/models/deploy-request +tags: ['SDK', 'Software Development Kit', 'DeployRequest', 'V2024DeployRequest'] +--- + +# DeployRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DraftId** | **string** | The id of the draft to be used by this deploy. | + +## Methods + +### NewDeployRequest + +`func NewDeployRequest(draftId string, ) *DeployRequest` + +NewDeployRequest instantiates a new DeployRequest 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 + +### NewDeployRequestWithDefaults + +`func NewDeployRequestWithDefaults() *DeployRequest` + +NewDeployRequestWithDefaults instantiates a new DeployRequest 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 + +### GetDraftId + +`func (o *DeployRequest) GetDraftId() string` + +GetDraftId returns the DraftId field if non-nil, zero value otherwise. + +### GetDraftIdOk + +`func (o *DeployRequest) GetDraftIdOk() (*string, bool)` + +GetDraftIdOk returns a tuple with the DraftId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDraftId + +`func (o *DeployRequest) SetDraftId(v string)` + +SetDraftId sets DraftId field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DeployResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/DeployResponse.md new file mode 100644 index 000000000..24ff58299 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DeployResponse.md @@ -0,0 +1,350 @@ +--- +id: v2024-deploy-response +title: DeployResponse +pagination_label: DeployResponse +sidebar_label: DeployResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DeployResponse', 'V2024DeployResponse'] +slug: /tools/sdk/go/v2024/models/deploy-response +tags: ['SDK', 'Software Development Kit', 'DeployResponse', 'V2024DeployResponse'] +--- + +# DeployResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | Pointer to **string** | Unique id assigned to this job. | [optional] +**Status** | Pointer to **string** | Status of the job. | [optional] +**Type** | Pointer to **string** | Type of the job, will always be CONFIG_DEPLOY_DRAFT for this type of job. | [optional] +**Message** | Pointer to **string** | Message providing information about the outcome of the deploy process. | [optional] +**RequesterName** | Pointer to **string** | The name of the user that initiated the deploy process. | [optional] +**FileExists** | Pointer to **bool** | Whether or not a results file was created and stored for this deploy. | [optional] [default to true] +**Created** | Pointer to **SailPointTime** | The time the job was started. | [optional] +**Modified** | Pointer to **SailPointTime** | The time of the last update to the job. | [optional] +**Completed** | Pointer to **SailPointTime** | The time the job was completed. | [optional] +**DraftId** | Pointer to **string** | The id of the draft that was used for this deploy. | [optional] +**DraftName** | Pointer to **string** | The name of the draft that was used for this deploy. | [optional] +**CloudStorageStatus** | Pointer to **string** | Whether this deploy results file has been transferred to a customer storage location. | [optional] + +## Methods + +### NewDeployResponse + +`func NewDeployResponse() *DeployResponse` + +NewDeployResponse instantiates a new DeployResponse 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 + +### NewDeployResponseWithDefaults + +`func NewDeployResponseWithDefaults() *DeployResponse` + +NewDeployResponseWithDefaults instantiates a new DeployResponse 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 + +### GetJobId + +`func (o *DeployResponse) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *DeployResponse) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *DeployResponse) SetJobId(v string)` + +SetJobId sets JobId field to given value. + +### HasJobId + +`func (o *DeployResponse) HasJobId() bool` + +HasJobId returns a boolean if a field has been set. + +### GetStatus + +`func (o *DeployResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *DeployResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *DeployResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *DeployResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetType + +`func (o *DeployResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DeployResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DeployResponse) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DeployResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetMessage + +`func (o *DeployResponse) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *DeployResponse) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *DeployResponse) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *DeployResponse) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetRequesterName + +`func (o *DeployResponse) GetRequesterName() string` + +GetRequesterName returns the RequesterName field if non-nil, zero value otherwise. + +### GetRequesterNameOk + +`func (o *DeployResponse) GetRequesterNameOk() (*string, bool)` + +GetRequesterNameOk returns a tuple with the RequesterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterName + +`func (o *DeployResponse) SetRequesterName(v string)` + +SetRequesterName sets RequesterName field to given value. + +### HasRequesterName + +`func (o *DeployResponse) HasRequesterName() bool` + +HasRequesterName returns a boolean if a field has been set. + +### GetFileExists + +`func (o *DeployResponse) GetFileExists() bool` + +GetFileExists returns the FileExists field if non-nil, zero value otherwise. + +### GetFileExistsOk + +`func (o *DeployResponse) GetFileExistsOk() (*bool, bool)` + +GetFileExistsOk returns a tuple with the FileExists field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileExists + +`func (o *DeployResponse) SetFileExists(v bool)` + +SetFileExists sets FileExists field to given value. + +### HasFileExists + +`func (o *DeployResponse) HasFileExists() bool` + +HasFileExists returns a boolean if a field has been set. + +### GetCreated + +`func (o *DeployResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *DeployResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *DeployResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *DeployResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *DeployResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *DeployResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *DeployResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *DeployResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCompleted + +`func (o *DeployResponse) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *DeployResponse) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *DeployResponse) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *DeployResponse) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetDraftId + +`func (o *DeployResponse) GetDraftId() string` + +GetDraftId returns the DraftId field if non-nil, zero value otherwise. + +### GetDraftIdOk + +`func (o *DeployResponse) GetDraftIdOk() (*string, bool)` + +GetDraftIdOk returns a tuple with the DraftId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDraftId + +`func (o *DeployResponse) SetDraftId(v string)` + +SetDraftId sets DraftId field to given value. + +### HasDraftId + +`func (o *DeployResponse) HasDraftId() bool` + +HasDraftId returns a boolean if a field has been set. + +### GetDraftName + +`func (o *DeployResponse) GetDraftName() string` + +GetDraftName returns the DraftName field if non-nil, zero value otherwise. + +### GetDraftNameOk + +`func (o *DeployResponse) GetDraftNameOk() (*string, bool)` + +GetDraftNameOk returns a tuple with the DraftName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDraftName + +`func (o *DeployResponse) SetDraftName(v string)` + +SetDraftName sets DraftName field to given value. + +### HasDraftName + +`func (o *DeployResponse) HasDraftName() bool` + +HasDraftName returns a boolean if a field has been set. + +### GetCloudStorageStatus + +`func (o *DeployResponse) GetCloudStorageStatus() string` + +GetCloudStorageStatus returns the CloudStorageStatus field if non-nil, zero value otherwise. + +### GetCloudStorageStatusOk + +`func (o *DeployResponse) GetCloudStorageStatusOk() (*string, bool)` + +GetCloudStorageStatusOk returns a tuple with the CloudStorageStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudStorageStatus + +`func (o *DeployResponse) SetCloudStorageStatus(v string)` + +SetCloudStorageStatus sets CloudStorageStatus field to given value. + +### HasCloudStorageStatus + +`func (o *DeployResponse) HasCloudStorageStatus() bool` + +HasCloudStorageStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Dimension.md b/docs/tools/sdk/go/Reference/V2024/Models/Dimension.md new file mode 100644 index 000000000..739e19da1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Dimension.md @@ -0,0 +1,328 @@ +--- +id: v2024-dimension +title: Dimension +pagination_label: Dimension +sidebar_label: Dimension +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Dimension', 'V2024Dimension'] +slug: /tools/sdk/go/v2024/models/dimension +tags: ['SDK', 'Software Development Kit', 'Dimension', 'V2024Dimension'] +--- + +# Dimension + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the Dimension. This field must be left null when creating a dimension, otherwise a 400 Bad Request error will result. | [optional] +**Name** | **string** | The human-readable display name of the Dimension | +**Created** | Pointer to **SailPointTime** | Date the Dimension was created | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Date the Dimension was last modified. | [optional] [readonly] +**Description** | Pointer to **NullableString** | A human-readable description of the Dimension | [optional] +**Owner** | [**OwnerReference**](owner-reference) | | +**AccessProfiles** | Pointer to [**[]AccessProfileRef**](access-profile-ref) | | [optional] +**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | | [optional] +**Membership** | Pointer to [**NullableDimensionMembershipSelector**](dimension-membership-selector) | | [optional] +**ParentId** | Pointer to **NullableString** | The ID of the parent role. This field can be left null when creating a dimension, but if provided, it must match the role ID specified in the path variable of the API call. | [optional] + +## Methods + +### NewDimension + +`func NewDimension(name string, owner OwnerReference, ) *Dimension` + +NewDimension instantiates a new Dimension 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 + +### NewDimensionWithDefaults + +`func NewDimensionWithDefaults() *Dimension` + +NewDimensionWithDefaults instantiates a new Dimension 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 + +### GetId + +`func (o *Dimension) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Dimension) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Dimension) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Dimension) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Dimension) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Dimension) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Dimension) SetName(v string)` + +SetName sets Name field to given value. + + +### GetCreated + +`func (o *Dimension) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Dimension) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Dimension) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Dimension) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Dimension) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Dimension) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Dimension) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Dimension) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *Dimension) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Dimension) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Dimension) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Dimension) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Dimension) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Dimension) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwner + +`func (o *Dimension) GetOwner() OwnerReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Dimension) GetOwnerOk() (*OwnerReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Dimension) SetOwner(v OwnerReference)` + +SetOwner sets Owner field to given value. + + +### GetAccessProfiles + +`func (o *Dimension) GetAccessProfiles() []AccessProfileRef` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *Dimension) GetAccessProfilesOk() (*[]AccessProfileRef, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *Dimension) SetAccessProfiles(v []AccessProfileRef)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *Dimension) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### SetAccessProfilesNil + +`func (o *Dimension) SetAccessProfilesNil(b bool)` + + SetAccessProfilesNil sets the value for AccessProfiles to be an explicit nil + +### UnsetAccessProfiles +`func (o *Dimension) UnsetAccessProfiles()` + +UnsetAccessProfiles ensures that no value is present for AccessProfiles, not even an explicit nil +### GetEntitlements + +`func (o *Dimension) GetEntitlements() []EntitlementRef` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *Dimension) GetEntitlementsOk() (*[]EntitlementRef, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *Dimension) SetEntitlements(v []EntitlementRef)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *Dimension) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetMembership + +`func (o *Dimension) GetMembership() DimensionMembershipSelector` + +GetMembership returns the Membership field if non-nil, zero value otherwise. + +### GetMembershipOk + +`func (o *Dimension) GetMembershipOk() (*DimensionMembershipSelector, bool)` + +GetMembershipOk returns a tuple with the Membership field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMembership + +`func (o *Dimension) SetMembership(v DimensionMembershipSelector)` + +SetMembership sets Membership field to given value. + +### HasMembership + +`func (o *Dimension) HasMembership() bool` + +HasMembership returns a boolean if a field has been set. + +### SetMembershipNil + +`func (o *Dimension) SetMembershipNil(b bool)` + + SetMembershipNil sets the value for Membership to be an explicit nil + +### UnsetMembership +`func (o *Dimension) UnsetMembership()` + +UnsetMembership ensures that no value is present for Membership, not even an explicit nil +### GetParentId + +`func (o *Dimension) GetParentId() string` + +GetParentId returns the ParentId field if non-nil, zero value otherwise. + +### GetParentIdOk + +`func (o *Dimension) GetParentIdOk() (*string, bool)` + +GetParentIdOk returns a tuple with the ParentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentId + +`func (o *Dimension) SetParentId(v string)` + +SetParentId sets ParentId field to given value. + +### HasParentId + +`func (o *Dimension) HasParentId() bool` + +HasParentId returns a boolean if a field has been set. + +### SetParentIdNil + +`func (o *Dimension) SetParentIdNil(b bool)` + + SetParentIdNil sets the value for ParentId to be an explicit nil + +### UnsetParentId +`func (o *Dimension) UnsetParentId()` + +UnsetParentId ensures that no value is present for ParentId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DimensionBulkDeleteRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/DimensionBulkDeleteRequest.md new file mode 100644 index 000000000..a4589adcd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DimensionBulkDeleteRequest.md @@ -0,0 +1,59 @@ +--- +id: v2024-dimension-bulk-delete-request +title: DimensionBulkDeleteRequest +pagination_label: DimensionBulkDeleteRequest +sidebar_label: DimensionBulkDeleteRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionBulkDeleteRequest', 'V2024DimensionBulkDeleteRequest'] +slug: /tools/sdk/go/v2024/models/dimension-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'DimensionBulkDeleteRequest', 'V2024DimensionBulkDeleteRequest'] +--- + +# DimensionBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DimensionIds** | **[]string** | List of IDs of Dimensions to be deleted. | + +## Methods + +### NewDimensionBulkDeleteRequest + +`func NewDimensionBulkDeleteRequest(dimensionIds []string, ) *DimensionBulkDeleteRequest` + +NewDimensionBulkDeleteRequest instantiates a new DimensionBulkDeleteRequest 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 + +### NewDimensionBulkDeleteRequestWithDefaults + +`func NewDimensionBulkDeleteRequestWithDefaults() *DimensionBulkDeleteRequest` + +NewDimensionBulkDeleteRequestWithDefaults instantiates a new DimensionBulkDeleteRequest 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 + +### GetDimensionIds + +`func (o *DimensionBulkDeleteRequest) GetDimensionIds() []string` + +GetDimensionIds returns the DimensionIds field if non-nil, zero value otherwise. + +### GetDimensionIdsOk + +`func (o *DimensionBulkDeleteRequest) GetDimensionIdsOk() (*[]string, bool)` + +GetDimensionIdsOk returns a tuple with the DimensionIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensionIds + +`func (o *DimensionBulkDeleteRequest) SetDimensionIds(v []string)` + +SetDimensionIds sets DimensionIds field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaKey.md b/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaKey.md new file mode 100644 index 000000000..b921d5ee7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaKey.md @@ -0,0 +1,80 @@ +--- +id: v2024-dimension-criteria-key +title: DimensionCriteriaKey +pagination_label: DimensionCriteriaKey +sidebar_label: DimensionCriteriaKey +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionCriteriaKey', 'V2024DimensionCriteriaKey'] +slug: /tools/sdk/go/v2024/models/dimension-criteria-key +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaKey', 'V2024DimensionCriteriaKey'] +--- + +# DimensionCriteriaKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**DimensionCriteriaKeyType**](dimension-criteria-key-type) | | +**Property** | **string** | The name of the identity attribute to which the associated criteria applies. | + +## Methods + +### NewDimensionCriteriaKey + +`func NewDimensionCriteriaKey(type_ DimensionCriteriaKeyType, property string, ) *DimensionCriteriaKey` + +NewDimensionCriteriaKey instantiates a new DimensionCriteriaKey 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 + +### NewDimensionCriteriaKeyWithDefaults + +`func NewDimensionCriteriaKeyWithDefaults() *DimensionCriteriaKey` + +NewDimensionCriteriaKeyWithDefaults instantiates a new DimensionCriteriaKey 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 + +### GetType + +`func (o *DimensionCriteriaKey) GetType() DimensionCriteriaKeyType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DimensionCriteriaKey) GetTypeOk() (*DimensionCriteriaKeyType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DimensionCriteriaKey) SetType(v DimensionCriteriaKeyType)` + +SetType sets Type field to given value. + + +### GetProperty + +`func (o *DimensionCriteriaKey) GetProperty() string` + +GetProperty returns the Property field if non-nil, zero value otherwise. + +### GetPropertyOk + +`func (o *DimensionCriteriaKey) GetPropertyOk() (*string, bool)` + +GetPropertyOk returns a tuple with the Property field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperty + +`func (o *DimensionCriteriaKey) SetProperty(v string)` + +SetProperty sets Property field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaKeyType.md b/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaKeyType.md new file mode 100644 index 000000000..a814bf0b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaKeyType.md @@ -0,0 +1,19 @@ +--- +id: v2024-dimension-criteria-key-type +title: DimensionCriteriaKeyType +pagination_label: DimensionCriteriaKeyType +sidebar_label: DimensionCriteriaKeyType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionCriteriaKeyType', 'V2024DimensionCriteriaKeyType'] +slug: /tools/sdk/go/v2024/models/dimension-criteria-key-type +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaKeyType', 'V2024DimensionCriteriaKeyType'] +--- + +# DimensionCriteriaKeyType + +## Enum + + +* `IDENTITY` (value: `"IDENTITY"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaLevel1.md b/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaLevel1.md new file mode 100644 index 000000000..400d097c7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaLevel1.md @@ -0,0 +1,172 @@ +--- +id: v2024-dimension-criteria-level1 +title: DimensionCriteriaLevel1 +pagination_label: DimensionCriteriaLevel1 +sidebar_label: DimensionCriteriaLevel1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionCriteriaLevel1', 'V2024DimensionCriteriaLevel1'] +slug: /tools/sdk/go/v2024/models/dimension-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaLevel1', 'V2024DimensionCriteriaLevel1'] +--- + +# DimensionCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**DimensionCriteriaOperation**](dimension-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableDimensionCriteriaKey**](dimension-criteria-key) | | [optional] +**StringValue** | Pointer to **NullableString** | String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is EQUALS, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]DimensionCriteriaLevel2**](dimension-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Methods + +### NewDimensionCriteriaLevel1 + +`func NewDimensionCriteriaLevel1() *DimensionCriteriaLevel1` + +NewDimensionCriteriaLevel1 instantiates a new DimensionCriteriaLevel1 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 + +### NewDimensionCriteriaLevel1WithDefaults + +`func NewDimensionCriteriaLevel1WithDefaults() *DimensionCriteriaLevel1` + +NewDimensionCriteriaLevel1WithDefaults instantiates a new DimensionCriteriaLevel1 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 + +### GetOperation + +`func (o *DimensionCriteriaLevel1) GetOperation() DimensionCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *DimensionCriteriaLevel1) GetOperationOk() (*DimensionCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *DimensionCriteriaLevel1) SetOperation(v DimensionCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *DimensionCriteriaLevel1) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *DimensionCriteriaLevel1) GetKey() DimensionCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *DimensionCriteriaLevel1) GetKeyOk() (*DimensionCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *DimensionCriteriaLevel1) SetKey(v DimensionCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *DimensionCriteriaLevel1) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *DimensionCriteriaLevel1) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *DimensionCriteriaLevel1) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *DimensionCriteriaLevel1) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *DimensionCriteriaLevel1) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *DimensionCriteriaLevel1) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *DimensionCriteriaLevel1) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + +### SetStringValueNil + +`func (o *DimensionCriteriaLevel1) SetStringValueNil(b bool)` + + SetStringValueNil sets the value for StringValue to be an explicit nil + +### UnsetStringValue +`func (o *DimensionCriteriaLevel1) UnsetStringValue()` + +UnsetStringValue ensures that no value is present for StringValue, not even an explicit nil +### GetChildren + +`func (o *DimensionCriteriaLevel1) GetChildren() []DimensionCriteriaLevel2` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *DimensionCriteriaLevel1) GetChildrenOk() (*[]DimensionCriteriaLevel2, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *DimensionCriteriaLevel1) SetChildren(v []DimensionCriteriaLevel2)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *DimensionCriteriaLevel1) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *DimensionCriteriaLevel1) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *DimensionCriteriaLevel1) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaLevel2.md b/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaLevel2.md new file mode 100644 index 000000000..aa7e7fe72 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaLevel2.md @@ -0,0 +1,172 @@ +--- +id: v2024-dimension-criteria-level2 +title: DimensionCriteriaLevel2 +pagination_label: DimensionCriteriaLevel2 +sidebar_label: DimensionCriteriaLevel2 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionCriteriaLevel2', 'V2024DimensionCriteriaLevel2'] +slug: /tools/sdk/go/v2024/models/dimension-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaLevel2', 'V2024DimensionCriteriaLevel2'] +--- + +# DimensionCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**DimensionCriteriaOperation**](dimension-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableDimensionCriteriaKey**](dimension-criteria-key) | | [optional] +**StringValue** | Pointer to **NullableString** | String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]DimensionCriteriaLevel3**](dimension-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Methods + +### NewDimensionCriteriaLevel2 + +`func NewDimensionCriteriaLevel2() *DimensionCriteriaLevel2` + +NewDimensionCriteriaLevel2 instantiates a new DimensionCriteriaLevel2 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 + +### NewDimensionCriteriaLevel2WithDefaults + +`func NewDimensionCriteriaLevel2WithDefaults() *DimensionCriteriaLevel2` + +NewDimensionCriteriaLevel2WithDefaults instantiates a new DimensionCriteriaLevel2 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 + +### GetOperation + +`func (o *DimensionCriteriaLevel2) GetOperation() DimensionCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *DimensionCriteriaLevel2) GetOperationOk() (*DimensionCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *DimensionCriteriaLevel2) SetOperation(v DimensionCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *DimensionCriteriaLevel2) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *DimensionCriteriaLevel2) GetKey() DimensionCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *DimensionCriteriaLevel2) GetKeyOk() (*DimensionCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *DimensionCriteriaLevel2) SetKey(v DimensionCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *DimensionCriteriaLevel2) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *DimensionCriteriaLevel2) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *DimensionCriteriaLevel2) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *DimensionCriteriaLevel2) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *DimensionCriteriaLevel2) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *DimensionCriteriaLevel2) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *DimensionCriteriaLevel2) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + +### SetStringValueNil + +`func (o *DimensionCriteriaLevel2) SetStringValueNil(b bool)` + + SetStringValueNil sets the value for StringValue to be an explicit nil + +### UnsetStringValue +`func (o *DimensionCriteriaLevel2) UnsetStringValue()` + +UnsetStringValue ensures that no value is present for StringValue, not even an explicit nil +### GetChildren + +`func (o *DimensionCriteriaLevel2) GetChildren() []DimensionCriteriaLevel3` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *DimensionCriteriaLevel2) GetChildrenOk() (*[]DimensionCriteriaLevel3, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *DimensionCriteriaLevel2) SetChildren(v []DimensionCriteriaLevel3)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *DimensionCriteriaLevel2) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *DimensionCriteriaLevel2) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *DimensionCriteriaLevel2) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaLevel3.md b/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaLevel3.md new file mode 100644 index 000000000..e86da3b7f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaLevel3.md @@ -0,0 +1,126 @@ +--- +id: v2024-dimension-criteria-level3 +title: DimensionCriteriaLevel3 +pagination_label: DimensionCriteriaLevel3 +sidebar_label: DimensionCriteriaLevel3 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionCriteriaLevel3', 'V2024DimensionCriteriaLevel3'] +slug: /tools/sdk/go/v2024/models/dimension-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaLevel3', 'V2024DimensionCriteriaLevel3'] +--- + +# DimensionCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**DimensionCriteriaOperation**](dimension-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableDimensionCriteriaKey**](dimension-criteria-key) | | [optional] +**StringValue** | Pointer to **string** | String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. | [optional] + +## Methods + +### NewDimensionCriteriaLevel3 + +`func NewDimensionCriteriaLevel3() *DimensionCriteriaLevel3` + +NewDimensionCriteriaLevel3 instantiates a new DimensionCriteriaLevel3 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 + +### NewDimensionCriteriaLevel3WithDefaults + +`func NewDimensionCriteriaLevel3WithDefaults() *DimensionCriteriaLevel3` + +NewDimensionCriteriaLevel3WithDefaults instantiates a new DimensionCriteriaLevel3 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 + +### GetOperation + +`func (o *DimensionCriteriaLevel3) GetOperation() DimensionCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *DimensionCriteriaLevel3) GetOperationOk() (*DimensionCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *DimensionCriteriaLevel3) SetOperation(v DimensionCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *DimensionCriteriaLevel3) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *DimensionCriteriaLevel3) GetKey() DimensionCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *DimensionCriteriaLevel3) GetKeyOk() (*DimensionCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *DimensionCriteriaLevel3) SetKey(v DimensionCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *DimensionCriteriaLevel3) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *DimensionCriteriaLevel3) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *DimensionCriteriaLevel3) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *DimensionCriteriaLevel3) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *DimensionCriteriaLevel3) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *DimensionCriteriaLevel3) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *DimensionCriteriaLevel3) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaOperation.md b/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaOperation.md new file mode 100644 index 000000000..b8dec1571 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DimensionCriteriaOperation.md @@ -0,0 +1,23 @@ +--- +id: v2024-dimension-criteria-operation +title: DimensionCriteriaOperation +pagination_label: DimensionCriteriaOperation +sidebar_label: DimensionCriteriaOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionCriteriaOperation', 'V2024DimensionCriteriaOperation'] +slug: /tools/sdk/go/v2024/models/dimension-criteria-operation +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaOperation', 'V2024DimensionCriteriaOperation'] +--- + +# DimensionCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DimensionMembershipSelector.md b/docs/tools/sdk/go/Reference/V2024/Models/DimensionMembershipSelector.md new file mode 100644 index 000000000..c7089a5dd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DimensionMembershipSelector.md @@ -0,0 +1,100 @@ +--- +id: v2024-dimension-membership-selector +title: DimensionMembershipSelector +pagination_label: DimensionMembershipSelector +sidebar_label: DimensionMembershipSelector +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionMembershipSelector', 'V2024DimensionMembershipSelector'] +slug: /tools/sdk/go/v2024/models/dimension-membership-selector +tags: ['SDK', 'Software Development Kit', 'DimensionMembershipSelector', 'V2024DimensionMembershipSelector'] +--- + +# DimensionMembershipSelector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DimensionMembershipSelectorType**](dimension-membership-selector-type) | | [optional] +**Criteria** | Pointer to [**NullableDimensionCriteriaLevel1**](dimension-criteria-level1) | | [optional] + +## Methods + +### NewDimensionMembershipSelector + +`func NewDimensionMembershipSelector() *DimensionMembershipSelector` + +NewDimensionMembershipSelector instantiates a new DimensionMembershipSelector 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 + +### NewDimensionMembershipSelectorWithDefaults + +`func NewDimensionMembershipSelectorWithDefaults() *DimensionMembershipSelector` + +NewDimensionMembershipSelectorWithDefaults instantiates a new DimensionMembershipSelector 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 + +### GetType + +`func (o *DimensionMembershipSelector) GetType() DimensionMembershipSelectorType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DimensionMembershipSelector) GetTypeOk() (*DimensionMembershipSelectorType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DimensionMembershipSelector) SetType(v DimensionMembershipSelectorType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DimensionMembershipSelector) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetCriteria + +`func (o *DimensionMembershipSelector) GetCriteria() DimensionCriteriaLevel1` + +GetCriteria returns the Criteria field if non-nil, zero value otherwise. + +### GetCriteriaOk + +`func (o *DimensionMembershipSelector) GetCriteriaOk() (*DimensionCriteriaLevel1, bool)` + +GetCriteriaOk returns a tuple with the Criteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteria + +`func (o *DimensionMembershipSelector) SetCriteria(v DimensionCriteriaLevel1)` + +SetCriteria sets Criteria field to given value. + +### HasCriteria + +`func (o *DimensionMembershipSelector) HasCriteria() bool` + +HasCriteria returns a boolean if a field has been set. + +### SetCriteriaNil + +`func (o *DimensionMembershipSelector) SetCriteriaNil(b bool)` + + SetCriteriaNil sets the value for Criteria to be an explicit nil + +### UnsetCriteria +`func (o *DimensionMembershipSelector) UnsetCriteria()` + +UnsetCriteria ensures that no value is present for Criteria, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DimensionMembershipSelectorType.md b/docs/tools/sdk/go/Reference/V2024/Models/DimensionMembershipSelectorType.md new file mode 100644 index 000000000..0eb215c00 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DimensionMembershipSelectorType.md @@ -0,0 +1,19 @@ +--- +id: v2024-dimension-membership-selector-type +title: DimensionMembershipSelectorType +pagination_label: DimensionMembershipSelectorType +sidebar_label: DimensionMembershipSelectorType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionMembershipSelectorType', 'V2024DimensionMembershipSelectorType'] +slug: /tools/sdk/go/v2024/models/dimension-membership-selector-type +tags: ['SDK', 'Software Development Kit', 'DimensionMembershipSelectorType', 'V2024DimensionMembershipSelectorType'] +--- + +# DimensionMembershipSelectorType + +## Enum + + +* `STANDARD` (value: `"STANDARD"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DimensionRef.md b/docs/tools/sdk/go/Reference/V2024/Models/DimensionRef.md new file mode 100644 index 000000000..94c464ea6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DimensionRef.md @@ -0,0 +1,116 @@ +--- +id: v2024-dimension-ref +title: DimensionRef +pagination_label: DimensionRef +sidebar_label: DimensionRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionRef', 'V2024DimensionRef'] +slug: /tools/sdk/go/v2024/models/dimension-ref +tags: ['SDK', 'Software Development Kit', 'DimensionRef', 'V2024DimensionRef'] +--- + +# DimensionRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of the object to which this reference applies | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewDimensionRef + +`func NewDimensionRef() *DimensionRef` + +NewDimensionRef instantiates a new DimensionRef 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 + +### NewDimensionRefWithDefaults + +`func NewDimensionRefWithDefaults() *DimensionRef` + +NewDimensionRefWithDefaults instantiates a new DimensionRef 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 + +### GetType + +`func (o *DimensionRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DimensionRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DimensionRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DimensionRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *DimensionRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DimensionRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DimensionRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DimensionRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *DimensionRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DimensionRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DimensionRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DimensionRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DisplayReference.md b/docs/tools/sdk/go/Reference/V2024/Models/DisplayReference.md new file mode 100644 index 000000000..1c264d6eb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DisplayReference.md @@ -0,0 +1,116 @@ +--- +id: v2024-display-reference +title: DisplayReference +pagination_label: DisplayReference +sidebar_label: DisplayReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DisplayReference', 'V2024DisplayReference'] +slug: /tools/sdk/go/v2024/models/display-reference +tags: ['SDK', 'Software Development Kit', 'DisplayReference', 'V2024DisplayReference'] +--- + +# DisplayReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] + +## Methods + +### NewDisplayReference + +`func NewDisplayReference() *DisplayReference` + +NewDisplayReference instantiates a new DisplayReference 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 + +### NewDisplayReferenceWithDefaults + +`func NewDisplayReferenceWithDefaults() *DisplayReference` + +NewDisplayReferenceWithDefaults instantiates a new DisplayReference 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 + +### GetId + +`func (o *DisplayReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DisplayReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DisplayReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DisplayReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *DisplayReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DisplayReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DisplayReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DisplayReference) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *DisplayReference) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *DisplayReference) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *DisplayReference) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *DisplayReference) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DkimAttributes.md b/docs/tools/sdk/go/Reference/V2024/Models/DkimAttributes.md new file mode 100644 index 000000000..cc4efa10b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DkimAttributes.md @@ -0,0 +1,168 @@ +--- +id: v2024-dkim-attributes +title: DkimAttributes +pagination_label: DkimAttributes +sidebar_label: DkimAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DkimAttributes', 'V2024DkimAttributes'] +slug: /tools/sdk/go/v2024/models/dkim-attributes +tags: ['SDK', 'Software Development Kit', 'DkimAttributes', 'V2024DkimAttributes'] +--- + +# DkimAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | UUID associated with domain to be verified | [optional] +**Address** | Pointer to **string** | The identity or domain address | [optional] +**DkimEnabled** | Pointer to **bool** | Whether or not DKIM has been enabled for this domain / identity | [optional] [default to false] +**DkimTokens** | Pointer to **[]string** | The tokens to be added to a DNS for verification | [optional] +**DkimVerificationStatus** | Pointer to **string** | The current status if the domain /identity has been verified. Ie Success, Failed, Pending | [optional] + +## Methods + +### NewDkimAttributes + +`func NewDkimAttributes() *DkimAttributes` + +NewDkimAttributes instantiates a new DkimAttributes 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 + +### NewDkimAttributesWithDefaults + +`func NewDkimAttributesWithDefaults() *DkimAttributes` + +NewDkimAttributesWithDefaults instantiates a new DkimAttributes 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 + +### GetId + +`func (o *DkimAttributes) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DkimAttributes) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DkimAttributes) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DkimAttributes) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAddress + +`func (o *DkimAttributes) GetAddress() string` + +GetAddress returns the Address field if non-nil, zero value otherwise. + +### GetAddressOk + +`func (o *DkimAttributes) GetAddressOk() (*string, bool)` + +GetAddressOk returns a tuple with the Address field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAddress + +`func (o *DkimAttributes) SetAddress(v string)` + +SetAddress sets Address field to given value. + +### HasAddress + +`func (o *DkimAttributes) HasAddress() bool` + +HasAddress returns a boolean if a field has been set. + +### GetDkimEnabled + +`func (o *DkimAttributes) GetDkimEnabled() bool` + +GetDkimEnabled returns the DkimEnabled field if non-nil, zero value otherwise. + +### GetDkimEnabledOk + +`func (o *DkimAttributes) GetDkimEnabledOk() (*bool, bool)` + +GetDkimEnabledOk returns a tuple with the DkimEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimEnabled + +`func (o *DkimAttributes) SetDkimEnabled(v bool)` + +SetDkimEnabled sets DkimEnabled field to given value. + +### HasDkimEnabled + +`func (o *DkimAttributes) HasDkimEnabled() bool` + +HasDkimEnabled returns a boolean if a field has been set. + +### GetDkimTokens + +`func (o *DkimAttributes) GetDkimTokens() []string` + +GetDkimTokens returns the DkimTokens field if non-nil, zero value otherwise. + +### GetDkimTokensOk + +`func (o *DkimAttributes) GetDkimTokensOk() (*[]string, bool)` + +GetDkimTokensOk returns a tuple with the DkimTokens field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimTokens + +`func (o *DkimAttributes) SetDkimTokens(v []string)` + +SetDkimTokens sets DkimTokens field to given value. + +### HasDkimTokens + +`func (o *DkimAttributes) HasDkimTokens() bool` + +HasDkimTokens returns a boolean if a field has been set. + +### GetDkimVerificationStatus + +`func (o *DkimAttributes) GetDkimVerificationStatus() string` + +GetDkimVerificationStatus returns the DkimVerificationStatus field if non-nil, zero value otherwise. + +### GetDkimVerificationStatusOk + +`func (o *DkimAttributes) GetDkimVerificationStatusOk() (*string, bool)` + +GetDkimVerificationStatusOk returns a tuple with the DkimVerificationStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimVerificationStatus + +`func (o *DkimAttributes) SetDkimVerificationStatus(v string)` + +SetDkimVerificationStatus sets DkimVerificationStatus field to given value. + +### HasDkimVerificationStatus + +`func (o *DkimAttributes) HasDkimVerificationStatus() bool` + +HasDkimVerificationStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DomainAddress.md b/docs/tools/sdk/go/Reference/V2024/Models/DomainAddress.md new file mode 100644 index 000000000..0dc55cefc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DomainAddress.md @@ -0,0 +1,64 @@ +--- +id: v2024-domain-address +title: DomainAddress +pagination_label: DomainAddress +sidebar_label: DomainAddress +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DomainAddress', 'V2024DomainAddress'] +slug: /tools/sdk/go/v2024/models/domain-address +tags: ['SDK', 'Software Development Kit', 'DomainAddress', 'V2024DomainAddress'] +--- + +# DomainAddress + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Domain** | Pointer to **string** | A domain address | [optional] + +## Methods + +### NewDomainAddress + +`func NewDomainAddress() *DomainAddress` + +NewDomainAddress instantiates a new DomainAddress 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 + +### NewDomainAddressWithDefaults + +`func NewDomainAddressWithDefaults() *DomainAddress` + +NewDomainAddressWithDefaults instantiates a new DomainAddress 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 + +### GetDomain + +`func (o *DomainAddress) GetDomain() string` + +GetDomain returns the Domain field if non-nil, zero value otherwise. + +### GetDomainOk + +`func (o *DomainAddress) GetDomainOk() (*string, bool)` + +GetDomainOk returns a tuple with the Domain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDomain + +`func (o *DomainAddress) SetDomain(v string)` + +SetDomain sets Domain field to given value. + +### HasDomain + +`func (o *DomainAddress) HasDomain() bool` + +HasDomain returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DomainStatusDto.md b/docs/tools/sdk/go/Reference/V2024/Models/DomainStatusDto.md new file mode 100644 index 000000000..aee0acac6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DomainStatusDto.md @@ -0,0 +1,168 @@ +--- +id: v2024-domain-status-dto +title: DomainStatusDto +pagination_label: DomainStatusDto +sidebar_label: DomainStatusDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DomainStatusDto', 'V2024DomainStatusDto'] +slug: /tools/sdk/go/v2024/models/domain-status-dto +tags: ['SDK', 'Software Development Kit', 'DomainStatusDto', 'V2024DomainStatusDto'] +--- + +# DomainStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | New UUID associated with domain to be verified | [optional] +**Domain** | Pointer to **string** | A domain address | [optional] +**DkimEnabled** | Pointer to **map[string]interface{}** | DKIM is enabled for this domain | [optional] [default to false] +**DkimTokens** | Pointer to **[]string** | DKIM tokens required for authentication | [optional] +**DkimVerificationStatus** | Pointer to **string** | Status of DKIM authentication | [optional] + +## Methods + +### NewDomainStatusDto + +`func NewDomainStatusDto() *DomainStatusDto` + +NewDomainStatusDto instantiates a new DomainStatusDto 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 + +### NewDomainStatusDtoWithDefaults + +`func NewDomainStatusDtoWithDefaults() *DomainStatusDto` + +NewDomainStatusDtoWithDefaults instantiates a new DomainStatusDto 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 + +### GetId + +`func (o *DomainStatusDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DomainStatusDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DomainStatusDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DomainStatusDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDomain + +`func (o *DomainStatusDto) GetDomain() string` + +GetDomain returns the Domain field if non-nil, zero value otherwise. + +### GetDomainOk + +`func (o *DomainStatusDto) GetDomainOk() (*string, bool)` + +GetDomainOk returns a tuple with the Domain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDomain + +`func (o *DomainStatusDto) SetDomain(v string)` + +SetDomain sets Domain field to given value. + +### HasDomain + +`func (o *DomainStatusDto) HasDomain() bool` + +HasDomain returns a boolean if a field has been set. + +### GetDkimEnabled + +`func (o *DomainStatusDto) GetDkimEnabled() map[string]interface{}` + +GetDkimEnabled returns the DkimEnabled field if non-nil, zero value otherwise. + +### GetDkimEnabledOk + +`func (o *DomainStatusDto) GetDkimEnabledOk() (*map[string]interface{}, bool)` + +GetDkimEnabledOk returns a tuple with the DkimEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimEnabled + +`func (o *DomainStatusDto) SetDkimEnabled(v map[string]interface{})` + +SetDkimEnabled sets DkimEnabled field to given value. + +### HasDkimEnabled + +`func (o *DomainStatusDto) HasDkimEnabled() bool` + +HasDkimEnabled returns a boolean if a field has been set. + +### GetDkimTokens + +`func (o *DomainStatusDto) GetDkimTokens() []string` + +GetDkimTokens returns the DkimTokens field if non-nil, zero value otherwise. + +### GetDkimTokensOk + +`func (o *DomainStatusDto) GetDkimTokensOk() (*[]string, bool)` + +GetDkimTokensOk returns a tuple with the DkimTokens field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimTokens + +`func (o *DomainStatusDto) SetDkimTokens(v []string)` + +SetDkimTokens sets DkimTokens field to given value. + +### HasDkimTokens + +`func (o *DomainStatusDto) HasDkimTokens() bool` + +HasDkimTokens returns a boolean if a field has been set. + +### GetDkimVerificationStatus + +`func (o *DomainStatusDto) GetDkimVerificationStatus() string` + +GetDkimVerificationStatus returns the DkimVerificationStatus field if non-nil, zero value otherwise. + +### GetDkimVerificationStatusOk + +`func (o *DomainStatusDto) GetDkimVerificationStatusOk() (*string, bool)` + +GetDkimVerificationStatusOk returns a tuple with the DkimVerificationStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimVerificationStatus + +`func (o *DomainStatusDto) SetDkimVerificationStatus(v string)` + +SetDkimVerificationStatus sets DkimVerificationStatus field to given value. + +### HasDkimVerificationStatus + +`func (o *DomainStatusDto) HasDkimVerificationStatus() bool` + +HasDkimVerificationStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DraftResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/DraftResponse.md new file mode 100644 index 000000000..c88dc5238 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DraftResponse.md @@ -0,0 +1,454 @@ +--- +id: v2024-draft-response +title: DraftResponse +pagination_label: DraftResponse +sidebar_label: DraftResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DraftResponse', 'V2024DraftResponse'] +slug: /tools/sdk/go/v2024/models/draft-response +tags: ['SDK', 'Software Development Kit', 'DraftResponse', 'V2024DraftResponse'] +--- + +# DraftResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | Pointer to **string** | Unique id assigned to this job. | [optional] +**Status** | Pointer to **string** | Status of the job. | [optional] +**Type** | Pointer to **string** | Type of the job, will always be CREATE_DRAFT for this type of job. | [optional] +**Message** | Pointer to **string** | Message providing information about the outcome of the draft process. | [optional] +**RequesterName** | Pointer to **string** | The name of user that that initiated the draft process. | [optional] +**FileExists** | Pointer to **bool** | Whether or not a file was generated for this draft. | [optional] [default to true] +**Created** | Pointer to **SailPointTime** | The time the job was started. | [optional] +**Modified** | Pointer to **SailPointTime** | The time of the last update to the job. | [optional] +**Completed** | Pointer to **SailPointTime** | The time the job was completed. | [optional] +**Name** | Pointer to **string** | Name of the draft. | [optional] +**SourceTenant** | Pointer to **string** | Tenant owner of the backup from which the draft was generated. | [optional] +**SourceBackupId** | Pointer to **string** | Id of the backup from which the draft was generated. | [optional] +**SourceBackupName** | Pointer to **string** | Name of the backup from which the draft was generated. | [optional] +**Mode** | Pointer to **string** | Denotes the origin of the source backup from which the draft was generated. - RESTORE - Same tenant. - PROMOTE - Different tenant. - UPLOAD - Uploaded configuration. | [optional] +**ApprovalStatus** | Pointer to **string** | Approval status of the draft used to determine whether or not the draft can be deployed. | [optional] +**ApprovalComment** | Pointer to [**[]ApprovalComment**](approval-comment) | List of comments that have been exchanged between an approval requester and an approver. | [optional] + +## Methods + +### NewDraftResponse + +`func NewDraftResponse() *DraftResponse` + +NewDraftResponse instantiates a new DraftResponse 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 + +### NewDraftResponseWithDefaults + +`func NewDraftResponseWithDefaults() *DraftResponse` + +NewDraftResponseWithDefaults instantiates a new DraftResponse 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 + +### GetJobId + +`func (o *DraftResponse) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *DraftResponse) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *DraftResponse) SetJobId(v string)` + +SetJobId sets JobId field to given value. + +### HasJobId + +`func (o *DraftResponse) HasJobId() bool` + +HasJobId returns a boolean if a field has been set. + +### GetStatus + +`func (o *DraftResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *DraftResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *DraftResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *DraftResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetType + +`func (o *DraftResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DraftResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DraftResponse) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DraftResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetMessage + +`func (o *DraftResponse) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *DraftResponse) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *DraftResponse) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *DraftResponse) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetRequesterName + +`func (o *DraftResponse) GetRequesterName() string` + +GetRequesterName returns the RequesterName field if non-nil, zero value otherwise. + +### GetRequesterNameOk + +`func (o *DraftResponse) GetRequesterNameOk() (*string, bool)` + +GetRequesterNameOk returns a tuple with the RequesterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterName + +`func (o *DraftResponse) SetRequesterName(v string)` + +SetRequesterName sets RequesterName field to given value. + +### HasRequesterName + +`func (o *DraftResponse) HasRequesterName() bool` + +HasRequesterName returns a boolean if a field has been set. + +### GetFileExists + +`func (o *DraftResponse) GetFileExists() bool` + +GetFileExists returns the FileExists field if non-nil, zero value otherwise. + +### GetFileExistsOk + +`func (o *DraftResponse) GetFileExistsOk() (*bool, bool)` + +GetFileExistsOk returns a tuple with the FileExists field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileExists + +`func (o *DraftResponse) SetFileExists(v bool)` + +SetFileExists sets FileExists field to given value. + +### HasFileExists + +`func (o *DraftResponse) HasFileExists() bool` + +HasFileExists returns a boolean if a field has been set. + +### GetCreated + +`func (o *DraftResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *DraftResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *DraftResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *DraftResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *DraftResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *DraftResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *DraftResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *DraftResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCompleted + +`func (o *DraftResponse) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *DraftResponse) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *DraftResponse) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *DraftResponse) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetName + +`func (o *DraftResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DraftResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DraftResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DraftResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceTenant + +`func (o *DraftResponse) GetSourceTenant() string` + +GetSourceTenant returns the SourceTenant field if non-nil, zero value otherwise. + +### GetSourceTenantOk + +`func (o *DraftResponse) GetSourceTenantOk() (*string, bool)` + +GetSourceTenantOk returns a tuple with the SourceTenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceTenant + +`func (o *DraftResponse) SetSourceTenant(v string)` + +SetSourceTenant sets SourceTenant field to given value. + +### HasSourceTenant + +`func (o *DraftResponse) HasSourceTenant() bool` + +HasSourceTenant returns a boolean if a field has been set. + +### GetSourceBackupId + +`func (o *DraftResponse) GetSourceBackupId() string` + +GetSourceBackupId returns the SourceBackupId field if non-nil, zero value otherwise. + +### GetSourceBackupIdOk + +`func (o *DraftResponse) GetSourceBackupIdOk() (*string, bool)` + +GetSourceBackupIdOk returns a tuple with the SourceBackupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceBackupId + +`func (o *DraftResponse) SetSourceBackupId(v string)` + +SetSourceBackupId sets SourceBackupId field to given value. + +### HasSourceBackupId + +`func (o *DraftResponse) HasSourceBackupId() bool` + +HasSourceBackupId returns a boolean if a field has been set. + +### GetSourceBackupName + +`func (o *DraftResponse) GetSourceBackupName() string` + +GetSourceBackupName returns the SourceBackupName field if non-nil, zero value otherwise. + +### GetSourceBackupNameOk + +`func (o *DraftResponse) GetSourceBackupNameOk() (*string, bool)` + +GetSourceBackupNameOk returns a tuple with the SourceBackupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceBackupName + +`func (o *DraftResponse) SetSourceBackupName(v string)` + +SetSourceBackupName sets SourceBackupName field to given value. + +### HasSourceBackupName + +`func (o *DraftResponse) HasSourceBackupName() bool` + +HasSourceBackupName returns a boolean if a field has been set. + +### GetMode + +`func (o *DraftResponse) GetMode() string` + +GetMode returns the Mode field if non-nil, zero value otherwise. + +### GetModeOk + +`func (o *DraftResponse) GetModeOk() (*string, bool)` + +GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMode + +`func (o *DraftResponse) SetMode(v string)` + +SetMode sets Mode field to given value. + +### HasMode + +`func (o *DraftResponse) HasMode() bool` + +HasMode returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *DraftResponse) GetApprovalStatus() string` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *DraftResponse) GetApprovalStatusOk() (*string, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *DraftResponse) SetApprovalStatus(v string)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *DraftResponse) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetApprovalComment + +`func (o *DraftResponse) GetApprovalComment() []ApprovalComment` + +GetApprovalComment returns the ApprovalComment field if non-nil, zero value otherwise. + +### GetApprovalCommentOk + +`func (o *DraftResponse) GetApprovalCommentOk() (*[]ApprovalComment, bool)` + +GetApprovalCommentOk returns a tuple with the ApprovalComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalComment + +`func (o *DraftResponse) SetApprovalComment(v []ApprovalComment)` + +SetApprovalComment sets ApprovalComment field to given value. + +### HasApprovalComment + +`func (o *DraftResponse) HasApprovalComment() bool` + +HasApprovalComment returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/DtoType.md b/docs/tools/sdk/go/Reference/V2024/Models/DtoType.md new file mode 100644 index 000000000..63618568d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/DtoType.md @@ -0,0 +1,75 @@ +--- +id: v2024-dto-type +title: DtoType +pagination_label: DtoType +sidebar_label: DtoType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DtoType', 'V2024DtoType'] +slug: /tools/sdk/go/v2024/models/dto-type +tags: ['SDK', 'Software Development Kit', 'DtoType', 'V2024DtoType'] +--- + +# DtoType + +## Enum + + +* `ACCOUNT_CORRELATION_CONFIG` (value: `"ACCOUNT_CORRELATION_CONFIG"`) + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ACCESS_REQUEST_APPROVAL` (value: `"ACCESS_REQUEST_APPROVAL"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `APPLICATION` (value: `"APPLICATION"`) + +* `CAMPAIGN` (value: `"CAMPAIGN"`) + +* `CAMPAIGN_FILTER` (value: `"CAMPAIGN_FILTER"`) + +* `CERTIFICATION` (value: `"CERTIFICATION"`) + +* `CLUSTER` (value: `"CLUSTER"`) + +* `CONNECTOR_SCHEMA` (value: `"CONNECTOR_SCHEMA"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + +* `IDENTITY` (value: `"IDENTITY"`) + +* `IDENTITY_PROFILE` (value: `"IDENTITY_PROFILE"`) + +* `IDENTITY_REQUEST` (value: `"IDENTITY_REQUEST"`) + +* `MACHINE_IDENTITY` (value: `"MACHINE_IDENTITY"`) + +* `LIFECYCLE_STATE` (value: `"LIFECYCLE_STATE"`) + +* `PASSWORD_POLICY` (value: `"PASSWORD_POLICY"`) + +* `ROLE` (value: `"ROLE"`) + +* `RULE` (value: `"RULE"`) + +* `SOD_POLICY` (value: `"SOD_POLICY"`) + +* `SOURCE` (value: `"SOURCE"`) + +* `TAG` (value: `"TAG"`) + +* `TAG_CATEGORY` (value: `"TAG_CATEGORY"`) + +* `TASK_RESULT` (value: `"TASK_RESULT"`) + +* `REPORT_RESULT` (value: `"REPORT_RESULT"`) + +* `SOD_VIOLATION` (value: `"SOD_VIOLATION"`) + +* `ACCOUNT_ACTIVITY` (value: `"ACCOUNT_ACTIVITY"`) + +* `WORKGROUP` (value: `"WORKGROUP"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EmailNotificationOption.md b/docs/tools/sdk/go/Reference/V2024/Models/EmailNotificationOption.md new file mode 100644 index 000000000..4e8c9fdec --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EmailNotificationOption.md @@ -0,0 +1,142 @@ +--- +id: v2024-email-notification-option +title: EmailNotificationOption +pagination_label: EmailNotificationOption +sidebar_label: EmailNotificationOption +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EmailNotificationOption', 'V2024EmailNotificationOption'] +slug: /tools/sdk/go/v2024/models/email-notification-option +tags: ['SDK', 'Software Development Kit', 'EmailNotificationOption', 'V2024EmailNotificationOption'] +--- + +# EmailNotificationOption + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NotifyManagers** | Pointer to **bool** | If true, then the manager is notified of the lifecycle state change. | [optional] [default to false] +**NotifyAllAdmins** | Pointer to **bool** | If true, then all the admins are notified of the lifecycle state change. | [optional] [default to false] +**NotifySpecificUsers** | Pointer to **bool** | If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change. | [optional] [default to false] +**EmailAddressList** | Pointer to **[]string** | List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change. | [optional] + +## Methods + +### NewEmailNotificationOption + +`func NewEmailNotificationOption() *EmailNotificationOption` + +NewEmailNotificationOption instantiates a new EmailNotificationOption 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 + +### NewEmailNotificationOptionWithDefaults + +`func NewEmailNotificationOptionWithDefaults() *EmailNotificationOption` + +NewEmailNotificationOptionWithDefaults instantiates a new EmailNotificationOption 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 + +### GetNotifyManagers + +`func (o *EmailNotificationOption) GetNotifyManagers() bool` + +GetNotifyManagers returns the NotifyManagers field if non-nil, zero value otherwise. + +### GetNotifyManagersOk + +`func (o *EmailNotificationOption) GetNotifyManagersOk() (*bool, bool)` + +GetNotifyManagersOk returns a tuple with the NotifyManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifyManagers + +`func (o *EmailNotificationOption) SetNotifyManagers(v bool)` + +SetNotifyManagers sets NotifyManagers field to given value. + +### HasNotifyManagers + +`func (o *EmailNotificationOption) HasNotifyManagers() bool` + +HasNotifyManagers returns a boolean if a field has been set. + +### GetNotifyAllAdmins + +`func (o *EmailNotificationOption) GetNotifyAllAdmins() bool` + +GetNotifyAllAdmins returns the NotifyAllAdmins field if non-nil, zero value otherwise. + +### GetNotifyAllAdminsOk + +`func (o *EmailNotificationOption) GetNotifyAllAdminsOk() (*bool, bool)` + +GetNotifyAllAdminsOk returns a tuple with the NotifyAllAdmins field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifyAllAdmins + +`func (o *EmailNotificationOption) SetNotifyAllAdmins(v bool)` + +SetNotifyAllAdmins sets NotifyAllAdmins field to given value. + +### HasNotifyAllAdmins + +`func (o *EmailNotificationOption) HasNotifyAllAdmins() bool` + +HasNotifyAllAdmins returns a boolean if a field has been set. + +### GetNotifySpecificUsers + +`func (o *EmailNotificationOption) GetNotifySpecificUsers() bool` + +GetNotifySpecificUsers returns the NotifySpecificUsers field if non-nil, zero value otherwise. + +### GetNotifySpecificUsersOk + +`func (o *EmailNotificationOption) GetNotifySpecificUsersOk() (*bool, bool)` + +GetNotifySpecificUsersOk returns a tuple with the NotifySpecificUsers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifySpecificUsers + +`func (o *EmailNotificationOption) SetNotifySpecificUsers(v bool)` + +SetNotifySpecificUsers sets NotifySpecificUsers field to given value. + +### HasNotifySpecificUsers + +`func (o *EmailNotificationOption) HasNotifySpecificUsers() bool` + +HasNotifySpecificUsers returns a boolean if a field has been set. + +### GetEmailAddressList + +`func (o *EmailNotificationOption) GetEmailAddressList() []string` + +GetEmailAddressList returns the EmailAddressList field if non-nil, zero value otherwise. + +### GetEmailAddressListOk + +`func (o *EmailNotificationOption) GetEmailAddressListOk() (*[]string, bool)` + +GetEmailAddressListOk returns a tuple with the EmailAddressList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailAddressList + +`func (o *EmailNotificationOption) SetEmailAddressList(v []string)` + +SetEmailAddressList sets EmailAddressList field to given value. + +### HasEmailAddressList + +`func (o *EmailNotificationOption) HasEmailAddressList() bool` + +HasEmailAddressList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EmailStatusDto.md b/docs/tools/sdk/go/Reference/V2024/Models/EmailStatusDto.md new file mode 100644 index 000000000..fa1c7b0e9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EmailStatusDto.md @@ -0,0 +1,152 @@ +--- +id: v2024-email-status-dto +title: EmailStatusDto +pagination_label: EmailStatusDto +sidebar_label: EmailStatusDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EmailStatusDto', 'V2024EmailStatusDto'] +slug: /tools/sdk/go/v2024/models/email-status-dto +tags: ['SDK', 'Software Development Kit', 'EmailStatusDto', 'V2024EmailStatusDto'] +--- + +# EmailStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | | [optional] +**Email** | Pointer to **string** | | [optional] +**IsVerifiedByDomain** | Pointer to **bool** | | [optional] +**VerificationStatus** | Pointer to **string** | | [optional] + +## Methods + +### NewEmailStatusDto + +`func NewEmailStatusDto() *EmailStatusDto` + +NewEmailStatusDto instantiates a new EmailStatusDto 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 + +### NewEmailStatusDtoWithDefaults + +`func NewEmailStatusDtoWithDefaults() *EmailStatusDto` + +NewEmailStatusDtoWithDefaults instantiates a new EmailStatusDto 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 + +### GetId + +`func (o *EmailStatusDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EmailStatusDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EmailStatusDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EmailStatusDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *EmailStatusDto) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *EmailStatusDto) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetEmail + +`func (o *EmailStatusDto) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *EmailStatusDto) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *EmailStatusDto) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *EmailStatusDto) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetIsVerifiedByDomain + +`func (o *EmailStatusDto) GetIsVerifiedByDomain() bool` + +GetIsVerifiedByDomain returns the IsVerifiedByDomain field if non-nil, zero value otherwise. + +### GetIsVerifiedByDomainOk + +`func (o *EmailStatusDto) GetIsVerifiedByDomainOk() (*bool, bool)` + +GetIsVerifiedByDomainOk returns a tuple with the IsVerifiedByDomain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsVerifiedByDomain + +`func (o *EmailStatusDto) SetIsVerifiedByDomain(v bool)` + +SetIsVerifiedByDomain sets IsVerifiedByDomain field to given value. + +### HasIsVerifiedByDomain + +`func (o *EmailStatusDto) HasIsVerifiedByDomain() bool` + +HasIsVerifiedByDomain returns a boolean if a field has been set. + +### GetVerificationStatus + +`func (o *EmailStatusDto) GetVerificationStatus() string` + +GetVerificationStatus returns the VerificationStatus field if non-nil, zero value otherwise. + +### GetVerificationStatusOk + +`func (o *EmailStatusDto) GetVerificationStatusOk() (*string, bool)` + +GetVerificationStatusOk returns a tuple with the VerificationStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVerificationStatus + +`func (o *EmailStatusDto) SetVerificationStatus(v string)` + +SetVerificationStatus sets VerificationStatus field to given value. + +### HasVerificationStatus + +`func (o *EmailStatusDto) HasVerificationStatus() bool` + +HasVerificationStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Entitlement.md b/docs/tools/sdk/go/Reference/V2024/Models/Entitlement.md new file mode 100644 index 000000000..82d9f928d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Entitlement.md @@ -0,0 +1,546 @@ +--- +id: v2024-entitlement +title: Entitlement +pagination_label: Entitlement +sidebar_label: Entitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Entitlement', 'V2024Entitlement'] +slug: /tools/sdk/go/v2024/models/entitlement +tags: ['SDK', 'Software Development Kit', 'Entitlement', 'V2024Entitlement'] +--- + +# Entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The entitlement id | [optional] +**Name** | Pointer to **string** | The entitlement name | [optional] +**Attribute** | Pointer to **string** | The entitlement attribute name | [optional] +**Value** | Pointer to **string** | The value of the entitlement | [optional] +**SourceSchemaObjectType** | Pointer to **string** | The object type of the entitlement from the source schema | [optional] +**Description** | Pointer to **NullableString** | The description of the entitlement | [optional] +**Privileged** | Pointer to **bool** | True if the entitlement is privileged | [optional] +**CloudGoverned** | Pointer to **bool** | True if the entitlement is cloud governed | [optional] +**Requestable** | Pointer to **bool** | True if the entitlement is able to be directly requested | [optional] [default to false] +**Owner** | Pointer to [**NullableEntitlementOwner**](entitlement-owner) | | [optional] +**ManuallyUpdatedFields** | Pointer to **map[string]interface{}** | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [optional] +**AccessModelMetadata** | Pointer to [**EntitlementAccessModelMetadata**](entitlement-access-model-metadata) | | [optional] +**Created** | Pointer to **SailPointTime** | Time when the entitlement was created | [optional] +**Modified** | Pointer to **SailPointTime** | Time when the entitlement was last modified | [optional] +**Source** | Pointer to [**EntitlementSource**](entitlement-source) | | [optional] +**Attributes** | Pointer to **map[string]interface{}** | A map of free-form key-value pairs from the source system | [optional] +**Segments** | Pointer to **[]string** | List of IDs of segments, if any, to which this Entitlement is assigned. | [optional] +**DirectPermissions** | Pointer to [**[]PermissionDto**](permission-dto) | | [optional] + +## Methods + +### NewEntitlement + +`func NewEntitlement() *Entitlement` + +NewEntitlement instantiates a new Entitlement 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 + +### NewEntitlementWithDefaults + +`func NewEntitlementWithDefaults() *Entitlement` + +NewEntitlementWithDefaults instantiates a new Entitlement 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 + +### GetId + +`func (o *Entitlement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Entitlement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Entitlement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Entitlement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Entitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Entitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Entitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Entitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAttribute + +`func (o *Entitlement) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *Entitlement) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *Entitlement) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *Entitlement) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *Entitlement) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Entitlement) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Entitlement) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Entitlement) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSourceSchemaObjectType + +`func (o *Entitlement) GetSourceSchemaObjectType() string` + +GetSourceSchemaObjectType returns the SourceSchemaObjectType field if non-nil, zero value otherwise. + +### GetSourceSchemaObjectTypeOk + +`func (o *Entitlement) GetSourceSchemaObjectTypeOk() (*string, bool)` + +GetSourceSchemaObjectTypeOk returns a tuple with the SourceSchemaObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceSchemaObjectType + +`func (o *Entitlement) SetSourceSchemaObjectType(v string)` + +SetSourceSchemaObjectType sets SourceSchemaObjectType field to given value. + +### HasSourceSchemaObjectType + +`func (o *Entitlement) HasSourceSchemaObjectType() bool` + +HasSourceSchemaObjectType returns a boolean if a field has been set. + +### GetDescription + +`func (o *Entitlement) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Entitlement) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Entitlement) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Entitlement) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Entitlement) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Entitlement) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetPrivileged + +`func (o *Entitlement) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *Entitlement) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *Entitlement) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *Entitlement) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetCloudGoverned + +`func (o *Entitlement) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *Entitlement) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *Entitlement) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + +### HasCloudGoverned + +`func (o *Entitlement) HasCloudGoverned() bool` + +HasCloudGoverned returns a boolean if a field has been set. + +### GetRequestable + +`func (o *Entitlement) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *Entitlement) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *Entitlement) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *Entitlement) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetOwner + +`func (o *Entitlement) GetOwner() EntitlementOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Entitlement) GetOwnerOk() (*EntitlementOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Entitlement) SetOwner(v EntitlementOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *Entitlement) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *Entitlement) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *Entitlement) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetManuallyUpdatedFields + +`func (o *Entitlement) GetManuallyUpdatedFields() map[string]interface{}` + +GetManuallyUpdatedFields returns the ManuallyUpdatedFields field if non-nil, zero value otherwise. + +### GetManuallyUpdatedFieldsOk + +`func (o *Entitlement) GetManuallyUpdatedFieldsOk() (*map[string]interface{}, bool)` + +GetManuallyUpdatedFieldsOk returns a tuple with the ManuallyUpdatedFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyUpdatedFields + +`func (o *Entitlement) SetManuallyUpdatedFields(v map[string]interface{})` + +SetManuallyUpdatedFields sets ManuallyUpdatedFields field to given value. + +### HasManuallyUpdatedFields + +`func (o *Entitlement) HasManuallyUpdatedFields() bool` + +HasManuallyUpdatedFields returns a boolean if a field has been set. + +### SetManuallyUpdatedFieldsNil + +`func (o *Entitlement) SetManuallyUpdatedFieldsNil(b bool)` + + SetManuallyUpdatedFieldsNil sets the value for ManuallyUpdatedFields to be an explicit nil + +### UnsetManuallyUpdatedFields +`func (o *Entitlement) UnsetManuallyUpdatedFields()` + +UnsetManuallyUpdatedFields ensures that no value is present for ManuallyUpdatedFields, not even an explicit nil +### GetAccessModelMetadata + +`func (o *Entitlement) GetAccessModelMetadata() EntitlementAccessModelMetadata` + +GetAccessModelMetadata returns the AccessModelMetadata field if non-nil, zero value otherwise. + +### GetAccessModelMetadataOk + +`func (o *Entitlement) GetAccessModelMetadataOk() (*EntitlementAccessModelMetadata, bool)` + +GetAccessModelMetadataOk returns a tuple with the AccessModelMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessModelMetadata + +`func (o *Entitlement) SetAccessModelMetadata(v EntitlementAccessModelMetadata)` + +SetAccessModelMetadata sets AccessModelMetadata field to given value. + +### HasAccessModelMetadata + +`func (o *Entitlement) HasAccessModelMetadata() bool` + +HasAccessModelMetadata returns a boolean if a field has been set. + +### GetCreated + +`func (o *Entitlement) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Entitlement) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Entitlement) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Entitlement) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Entitlement) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Entitlement) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Entitlement) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Entitlement) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetSource + +`func (o *Entitlement) GetSource() EntitlementSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *Entitlement) GetSourceOk() (*EntitlementSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *Entitlement) SetSource(v EntitlementSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *Entitlement) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Entitlement) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Entitlement) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Entitlement) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Entitlement) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetSegments + +`func (o *Entitlement) GetSegments() []string` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *Entitlement) GetSegmentsOk() (*[]string, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *Entitlement) SetSegments(v []string)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *Entitlement) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### SetSegmentsNil + +`func (o *Entitlement) SetSegmentsNil(b bool)` + + SetSegmentsNil sets the value for Segments to be an explicit nil + +### UnsetSegments +`func (o *Entitlement) UnsetSegments()` + +UnsetSegments ensures that no value is present for Segments, not even an explicit nil +### GetDirectPermissions + +`func (o *Entitlement) GetDirectPermissions() []PermissionDto` + +GetDirectPermissions returns the DirectPermissions field if non-nil, zero value otherwise. + +### GetDirectPermissionsOk + +`func (o *Entitlement) GetDirectPermissionsOk() (*[]PermissionDto, bool)` + +GetDirectPermissionsOk returns a tuple with the DirectPermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectPermissions + +`func (o *Entitlement) SetDirectPermissions(v []PermissionDto)` + +SetDirectPermissions sets DirectPermissions field to given value. + +### HasDirectPermissions + +`func (o *Entitlement) HasDirectPermissions() bool` + +HasDirectPermissions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EntitlementAccessModelMetadata.md b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementAccessModelMetadata.md new file mode 100644 index 000000000..64dc7b47d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementAccessModelMetadata.md @@ -0,0 +1,64 @@ +--- +id: v2024-entitlement-access-model-metadata +title: EntitlementAccessModelMetadata +pagination_label: EntitlementAccessModelMetadata +sidebar_label: EntitlementAccessModelMetadata +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementAccessModelMetadata', 'V2024EntitlementAccessModelMetadata'] +slug: /tools/sdk/go/v2024/models/entitlement-access-model-metadata +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadata', 'V2024EntitlementAccessModelMetadata'] +--- + +# EntitlementAccessModelMetadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]AccessModelMetadata**](access-model-metadata) | | [optional] + +## Methods + +### NewEntitlementAccessModelMetadata + +`func NewEntitlementAccessModelMetadata() *EntitlementAccessModelMetadata` + +NewEntitlementAccessModelMetadata instantiates a new EntitlementAccessModelMetadata 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 + +### NewEntitlementAccessModelMetadataWithDefaults + +`func NewEntitlementAccessModelMetadataWithDefaults() *EntitlementAccessModelMetadata` + +NewEntitlementAccessModelMetadataWithDefaults instantiates a new EntitlementAccessModelMetadata 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 + +### GetAttributes + +`func (o *EntitlementAccessModelMetadata) GetAttributes() []AccessModelMetadata` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *EntitlementAccessModelMetadata) GetAttributesOk() (*[]AccessModelMetadata, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *EntitlementAccessModelMetadata) SetAttributes(v []AccessModelMetadata)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *EntitlementAccessModelMetadata) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EntitlementAccessRequestConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementAccessRequestConfig.md new file mode 100644 index 000000000..1d3087a58 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementAccessRequestConfig.md @@ -0,0 +1,116 @@ +--- +id: v2024-entitlement-access-request-config +title: EntitlementAccessRequestConfig +pagination_label: EntitlementAccessRequestConfig +sidebar_label: EntitlementAccessRequestConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementAccessRequestConfig', 'V2024EntitlementAccessRequestConfig'] +slug: /tools/sdk/go/v2024/models/entitlement-access-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessRequestConfig', 'V2024EntitlementAccessRequestConfig'] +--- + +# EntitlementAccessRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalSchemes** | Pointer to [**[]EntitlementApprovalScheme**](entitlement-approval-scheme) | Ordered list of approval steps for the access request. Empty when no approval is required. | [optional] +**RequestCommentRequired** | Pointer to **bool** | If the requester must provide a comment during access request. | [optional] [default to false] +**DenialCommentRequired** | Pointer to **bool** | If the reviewer must provide a comment when denying the access request. | [optional] [default to false] + +## Methods + +### NewEntitlementAccessRequestConfig + +`func NewEntitlementAccessRequestConfig() *EntitlementAccessRequestConfig` + +NewEntitlementAccessRequestConfig instantiates a new EntitlementAccessRequestConfig 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 + +### NewEntitlementAccessRequestConfigWithDefaults + +`func NewEntitlementAccessRequestConfigWithDefaults() *EntitlementAccessRequestConfig` + +NewEntitlementAccessRequestConfigWithDefaults instantiates a new EntitlementAccessRequestConfig 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 + +### GetApprovalSchemes + +`func (o *EntitlementAccessRequestConfig) GetApprovalSchemes() []EntitlementApprovalScheme` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *EntitlementAccessRequestConfig) GetApprovalSchemesOk() (*[]EntitlementApprovalScheme, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *EntitlementAccessRequestConfig) SetApprovalSchemes(v []EntitlementApprovalScheme)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *EntitlementAccessRequestConfig) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + +### GetRequestCommentRequired + +`func (o *EntitlementAccessRequestConfig) GetRequestCommentRequired() bool` + +GetRequestCommentRequired returns the RequestCommentRequired field if non-nil, zero value otherwise. + +### GetRequestCommentRequiredOk + +`func (o *EntitlementAccessRequestConfig) GetRequestCommentRequiredOk() (*bool, bool)` + +GetRequestCommentRequiredOk returns a tuple with the RequestCommentRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentRequired + +`func (o *EntitlementAccessRequestConfig) SetRequestCommentRequired(v bool)` + +SetRequestCommentRequired sets RequestCommentRequired field to given value. + +### HasRequestCommentRequired + +`func (o *EntitlementAccessRequestConfig) HasRequestCommentRequired() bool` + +HasRequestCommentRequired returns a boolean if a field has been set. + +### GetDenialCommentRequired + +`func (o *EntitlementAccessRequestConfig) GetDenialCommentRequired() bool` + +GetDenialCommentRequired returns the DenialCommentRequired field if non-nil, zero value otherwise. + +### GetDenialCommentRequiredOk + +`func (o *EntitlementAccessRequestConfig) GetDenialCommentRequiredOk() (*bool, bool)` + +GetDenialCommentRequiredOk returns a tuple with the DenialCommentRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenialCommentRequired + +`func (o *EntitlementAccessRequestConfig) SetDenialCommentRequired(v bool)` + +SetDenialCommentRequired sets DenialCommentRequired field to given value. + +### HasDenialCommentRequired + +`func (o *EntitlementAccessRequestConfig) HasDenialCommentRequired() bool` + +HasDenialCommentRequired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EntitlementApprovalScheme.md b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementApprovalScheme.md new file mode 100644 index 000000000..f78cffb96 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementApprovalScheme.md @@ -0,0 +1,100 @@ +--- +id: v2024-entitlement-approval-scheme +title: EntitlementApprovalScheme +pagination_label: EntitlementApprovalScheme +sidebar_label: EntitlementApprovalScheme +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementApprovalScheme', 'V2024EntitlementApprovalScheme'] +slug: /tools/sdk/go/v2024/models/entitlement-approval-scheme +tags: ['SDK', 'Software Development Kit', 'EntitlementApprovalScheme', 'V2024EntitlementApprovalScheme'] +--- + +# EntitlementApprovalScheme + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApproverType** | Pointer to **string** | Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | Pointer to **NullableString** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] + +## Methods + +### NewEntitlementApprovalScheme + +`func NewEntitlementApprovalScheme() *EntitlementApprovalScheme` + +NewEntitlementApprovalScheme instantiates a new EntitlementApprovalScheme 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 + +### NewEntitlementApprovalSchemeWithDefaults + +`func NewEntitlementApprovalSchemeWithDefaults() *EntitlementApprovalScheme` + +NewEntitlementApprovalSchemeWithDefaults instantiates a new EntitlementApprovalScheme 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 + +### GetApproverType + +`func (o *EntitlementApprovalScheme) GetApproverType() string` + +GetApproverType returns the ApproverType field if non-nil, zero value otherwise. + +### GetApproverTypeOk + +`func (o *EntitlementApprovalScheme) GetApproverTypeOk() (*string, bool)` + +GetApproverTypeOk returns a tuple with the ApproverType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverType + +`func (o *EntitlementApprovalScheme) SetApproverType(v string)` + +SetApproverType sets ApproverType field to given value. + +### HasApproverType + +`func (o *EntitlementApprovalScheme) HasApproverType() bool` + +HasApproverType returns a boolean if a field has been set. + +### GetApproverId + +`func (o *EntitlementApprovalScheme) GetApproverId() string` + +GetApproverId returns the ApproverId field if non-nil, zero value otherwise. + +### GetApproverIdOk + +`func (o *EntitlementApprovalScheme) GetApproverIdOk() (*string, bool)` + +GetApproverIdOk returns a tuple with the ApproverId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverId + +`func (o *EntitlementApprovalScheme) SetApproverId(v string)` + +SetApproverId sets ApproverId field to given value. + +### HasApproverId + +`func (o *EntitlementApprovalScheme) HasApproverId() bool` + +HasApproverId returns a boolean if a field has been set. + +### SetApproverIdNil + +`func (o *EntitlementApprovalScheme) SetApproverIdNil(b bool)` + + SetApproverIdNil sets the value for ApproverId to be an explicit nil + +### UnsetApproverId +`func (o *EntitlementApprovalScheme) UnsetApproverId()` + +UnsetApproverId ensures that no value is present for ApproverId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EntitlementBulkUpdateRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementBulkUpdateRequest.md new file mode 100644 index 000000000..5bda3ed1d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementBulkUpdateRequest.md @@ -0,0 +1,80 @@ +--- +id: v2024-entitlement-bulk-update-request +title: EntitlementBulkUpdateRequest +pagination_label: EntitlementBulkUpdateRequest +sidebar_label: EntitlementBulkUpdateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementBulkUpdateRequest', 'V2024EntitlementBulkUpdateRequest'] +slug: /tools/sdk/go/v2024/models/entitlement-bulk-update-request +tags: ['SDK', 'Software Development Kit', 'EntitlementBulkUpdateRequest', 'V2024EntitlementBulkUpdateRequest'] +--- + +# EntitlementBulkUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EntitlementIds** | **[]string** | List of entitlement ids to update | +**JsonPatch** | [**[]JsonPatchOperation**](json-patch-operation) | | + +## Methods + +### NewEntitlementBulkUpdateRequest + +`func NewEntitlementBulkUpdateRequest(entitlementIds []string, jsonPatch []JsonPatchOperation, ) *EntitlementBulkUpdateRequest` + +NewEntitlementBulkUpdateRequest instantiates a new EntitlementBulkUpdateRequest 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 + +### NewEntitlementBulkUpdateRequestWithDefaults + +`func NewEntitlementBulkUpdateRequestWithDefaults() *EntitlementBulkUpdateRequest` + +NewEntitlementBulkUpdateRequestWithDefaults instantiates a new EntitlementBulkUpdateRequest 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 + +### GetEntitlementIds + +`func (o *EntitlementBulkUpdateRequest) GetEntitlementIds() []string` + +GetEntitlementIds returns the EntitlementIds field if non-nil, zero value otherwise. + +### GetEntitlementIdsOk + +`func (o *EntitlementBulkUpdateRequest) GetEntitlementIdsOk() (*[]string, bool)` + +GetEntitlementIdsOk returns a tuple with the EntitlementIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementIds + +`func (o *EntitlementBulkUpdateRequest) SetEntitlementIds(v []string)` + +SetEntitlementIds sets EntitlementIds field to given value. + + +### GetJsonPatch + +`func (o *EntitlementBulkUpdateRequest) GetJsonPatch() []JsonPatchOperation` + +GetJsonPatch returns the JsonPatch field if non-nil, zero value otherwise. + +### GetJsonPatchOk + +`func (o *EntitlementBulkUpdateRequest) GetJsonPatchOk() (*[]JsonPatchOperation, bool)` + +GetJsonPatchOk returns a tuple with the JsonPatch field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJsonPatch + +`func (o *EntitlementBulkUpdateRequest) SetJsonPatch(v []JsonPatchOperation)` + +SetJsonPatch sets JsonPatch field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EntitlementDocument.md b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementDocument.md new file mode 100644 index 000000000..5652a3c1e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementDocument.md @@ -0,0 +1,656 @@ +--- +id: v2024-entitlement-document +title: EntitlementDocument +pagination_label: EntitlementDocument +sidebar_label: EntitlementDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementDocument', 'V2024EntitlementDocument'] +slug: /tools/sdk/go/v2024/models/entitlement-document +tags: ['SDK', 'Software Development Kit', 'EntitlementDocument', 'V2024EntitlementDocument'] +--- + +# EntitlementDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the referenced object. | +**Name** | **string** | The human readable name of the referenced object. | +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**DisplayName** | Pointer to **string** | Entitlement's display name. | [optional] +**Source** | Pointer to [**EntitlementDocumentAllOfSource**](entitlement-document-all-of-source) | | [optional] +**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the entitlement. | [optional] +**SegmentCount** | Pointer to **int32** | Number of segments with the role. | [optional] +**Requestable** | Pointer to **bool** | Indicates whether the entitlement is requestable. | [optional] [default to false] +**CloudGoverned** | Pointer to **bool** | Indicates whether the entitlement is cloud governed. | [optional] [default to false] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Privileged** | Pointer to **bool** | Indicates whether the entitlement is privileged. | [optional] [default to false] +**Tags** | Pointer to **[]string** | Tags that have been applied to the object. | [optional] +**Attribute** | Pointer to **string** | Attribute information for the entitlement. | [optional] +**Value** | Pointer to **string** | Value of the entitlement. | [optional] +**SourceSchemaObjectType** | Pointer to **string** | Source schema object type of the entitlement. | [optional] +**Schema** | Pointer to **string** | Schema type of the entitlement. | [optional] +**Hash** | Pointer to **string** | Read-only calculated hash value of an entitlement. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Attributes of the entitlement. | [optional] +**TruncatedAttributes** | Pointer to **[]string** | Truncated attributes of the entitlement. | [optional] +**ContainsDataAccess** | Pointer to **bool** | Indicates whether the entitlement contains data access. | [optional] [default to false] +**ManuallyUpdatedFields** | Pointer to [**NullableEntitlementDocumentAllOfManuallyUpdatedFields**](entitlement-document-all-of-manually-updated-fields) | | [optional] +**Permissions** | Pointer to [**[]EntitlementDocumentAllOfPermissions**](entitlement-document-all-of-permissions) | | [optional] + +## Methods + +### NewEntitlementDocument + +`func NewEntitlementDocument(id string, name string, ) *EntitlementDocument` + +NewEntitlementDocument instantiates a new EntitlementDocument 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 + +### NewEntitlementDocumentWithDefaults + +`func NewEntitlementDocumentWithDefaults() *EntitlementDocument` + +NewEntitlementDocumentWithDefaults instantiates a new EntitlementDocument 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 + +### GetId + +`func (o *EntitlementDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementDocument) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *EntitlementDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementDocument) SetName(v string)` + +SetName sets Name field to given value. + + +### GetModified + +`func (o *EntitlementDocument) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *EntitlementDocument) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *EntitlementDocument) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *EntitlementDocument) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *EntitlementDocument) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *EntitlementDocument) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *EntitlementDocument) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *EntitlementDocument) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *EntitlementDocument) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *EntitlementDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *EntitlementDocument) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *EntitlementDocument) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *EntitlementDocument) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *EntitlementDocument) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSource + +`func (o *EntitlementDocument) GetSource() EntitlementDocumentAllOfSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *EntitlementDocument) GetSourceOk() (*EntitlementDocumentAllOfSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *EntitlementDocument) SetSource(v EntitlementDocumentAllOfSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *EntitlementDocument) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetSegments + +`func (o *EntitlementDocument) GetSegments() []BaseSegment` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *EntitlementDocument) GetSegmentsOk() (*[]BaseSegment, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *EntitlementDocument) SetSegments(v []BaseSegment)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *EntitlementDocument) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### GetSegmentCount + +`func (o *EntitlementDocument) GetSegmentCount() int32` + +GetSegmentCount returns the SegmentCount field if non-nil, zero value otherwise. + +### GetSegmentCountOk + +`func (o *EntitlementDocument) GetSegmentCountOk() (*int32, bool)` + +GetSegmentCountOk returns a tuple with the SegmentCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegmentCount + +`func (o *EntitlementDocument) SetSegmentCount(v int32)` + +SetSegmentCount sets SegmentCount field to given value. + +### HasSegmentCount + +`func (o *EntitlementDocument) HasSegmentCount() bool` + +HasSegmentCount returns a boolean if a field has been set. + +### GetRequestable + +`func (o *EntitlementDocument) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *EntitlementDocument) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *EntitlementDocument) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *EntitlementDocument) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetCloudGoverned + +`func (o *EntitlementDocument) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *EntitlementDocument) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *EntitlementDocument) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + +### HasCloudGoverned + +`func (o *EntitlementDocument) HasCloudGoverned() bool` + +HasCloudGoverned returns a boolean if a field has been set. + +### GetCreated + +`func (o *EntitlementDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *EntitlementDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *EntitlementDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *EntitlementDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *EntitlementDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *EntitlementDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetPrivileged + +`func (o *EntitlementDocument) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *EntitlementDocument) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *EntitlementDocument) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *EntitlementDocument) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetTags + +`func (o *EntitlementDocument) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *EntitlementDocument) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *EntitlementDocument) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *EntitlementDocument) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetAttribute + +`func (o *EntitlementDocument) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *EntitlementDocument) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *EntitlementDocument) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *EntitlementDocument) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *EntitlementDocument) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *EntitlementDocument) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *EntitlementDocument) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *EntitlementDocument) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSourceSchemaObjectType + +`func (o *EntitlementDocument) GetSourceSchemaObjectType() string` + +GetSourceSchemaObjectType returns the SourceSchemaObjectType field if non-nil, zero value otherwise. + +### GetSourceSchemaObjectTypeOk + +`func (o *EntitlementDocument) GetSourceSchemaObjectTypeOk() (*string, bool)` + +GetSourceSchemaObjectTypeOk returns a tuple with the SourceSchemaObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceSchemaObjectType + +`func (o *EntitlementDocument) SetSourceSchemaObjectType(v string)` + +SetSourceSchemaObjectType sets SourceSchemaObjectType field to given value. + +### HasSourceSchemaObjectType + +`func (o *EntitlementDocument) HasSourceSchemaObjectType() bool` + +HasSourceSchemaObjectType returns a boolean if a field has been set. + +### GetSchema + +`func (o *EntitlementDocument) GetSchema() string` + +GetSchema returns the Schema field if non-nil, zero value otherwise. + +### GetSchemaOk + +`func (o *EntitlementDocument) GetSchemaOk() (*string, bool)` + +GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchema + +`func (o *EntitlementDocument) SetSchema(v string)` + +SetSchema sets Schema field to given value. + +### HasSchema + +`func (o *EntitlementDocument) HasSchema() bool` + +HasSchema returns a boolean if a field has been set. + +### GetHash + +`func (o *EntitlementDocument) GetHash() string` + +GetHash returns the Hash field if non-nil, zero value otherwise. + +### GetHashOk + +`func (o *EntitlementDocument) GetHashOk() (*string, bool)` + +GetHashOk returns a tuple with the Hash field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHash + +`func (o *EntitlementDocument) SetHash(v string)` + +SetHash sets Hash field to given value. + +### HasHash + +`func (o *EntitlementDocument) HasHash() bool` + +HasHash returns a boolean if a field has been set. + +### GetAttributes + +`func (o *EntitlementDocument) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *EntitlementDocument) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *EntitlementDocument) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *EntitlementDocument) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetTruncatedAttributes + +`func (o *EntitlementDocument) GetTruncatedAttributes() []string` + +GetTruncatedAttributes returns the TruncatedAttributes field if non-nil, zero value otherwise. + +### GetTruncatedAttributesOk + +`func (o *EntitlementDocument) GetTruncatedAttributesOk() (*[]string, bool)` + +GetTruncatedAttributesOk returns a tuple with the TruncatedAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTruncatedAttributes + +`func (o *EntitlementDocument) SetTruncatedAttributes(v []string)` + +SetTruncatedAttributes sets TruncatedAttributes field to given value. + +### HasTruncatedAttributes + +`func (o *EntitlementDocument) HasTruncatedAttributes() bool` + +HasTruncatedAttributes returns a boolean if a field has been set. + +### GetContainsDataAccess + +`func (o *EntitlementDocument) GetContainsDataAccess() bool` + +GetContainsDataAccess returns the ContainsDataAccess field if non-nil, zero value otherwise. + +### GetContainsDataAccessOk + +`func (o *EntitlementDocument) GetContainsDataAccessOk() (*bool, bool)` + +GetContainsDataAccessOk returns a tuple with the ContainsDataAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainsDataAccess + +`func (o *EntitlementDocument) SetContainsDataAccess(v bool)` + +SetContainsDataAccess sets ContainsDataAccess field to given value. + +### HasContainsDataAccess + +`func (o *EntitlementDocument) HasContainsDataAccess() bool` + +HasContainsDataAccess returns a boolean if a field has been set. + +### GetManuallyUpdatedFields + +`func (o *EntitlementDocument) GetManuallyUpdatedFields() EntitlementDocumentAllOfManuallyUpdatedFields` + +GetManuallyUpdatedFields returns the ManuallyUpdatedFields field if non-nil, zero value otherwise. + +### GetManuallyUpdatedFieldsOk + +`func (o *EntitlementDocument) GetManuallyUpdatedFieldsOk() (*EntitlementDocumentAllOfManuallyUpdatedFields, bool)` + +GetManuallyUpdatedFieldsOk returns a tuple with the ManuallyUpdatedFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyUpdatedFields + +`func (o *EntitlementDocument) SetManuallyUpdatedFields(v EntitlementDocumentAllOfManuallyUpdatedFields)` + +SetManuallyUpdatedFields sets ManuallyUpdatedFields field to given value. + +### HasManuallyUpdatedFields + +`func (o *EntitlementDocument) HasManuallyUpdatedFields() bool` + +HasManuallyUpdatedFields returns a boolean if a field has been set. + +### SetManuallyUpdatedFieldsNil + +`func (o *EntitlementDocument) SetManuallyUpdatedFieldsNil(b bool)` + + SetManuallyUpdatedFieldsNil sets the value for ManuallyUpdatedFields to be an explicit nil + +### UnsetManuallyUpdatedFields +`func (o *EntitlementDocument) UnsetManuallyUpdatedFields()` + +UnsetManuallyUpdatedFields ensures that no value is present for ManuallyUpdatedFields, not even an explicit nil +### GetPermissions + +`func (o *EntitlementDocument) GetPermissions() []EntitlementDocumentAllOfPermissions` + +GetPermissions returns the Permissions field if non-nil, zero value otherwise. + +### GetPermissionsOk + +`func (o *EntitlementDocument) GetPermissionsOk() (*[]EntitlementDocumentAllOfPermissions, bool)` + +GetPermissionsOk returns a tuple with the Permissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPermissions + +`func (o *EntitlementDocument) SetPermissions(v []EntitlementDocumentAllOfPermissions)` + +SetPermissions sets Permissions field to given value. + +### HasPermissions + +`func (o *EntitlementDocument) HasPermissions() bool` + +HasPermissions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md new file mode 100644 index 000000000..d98a90e2d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md @@ -0,0 +1,90 @@ +--- +id: v2024-entitlement-document-all-of-manually-updated-fields +title: EntitlementDocumentAllOfManuallyUpdatedFields +pagination_label: EntitlementDocumentAllOfManuallyUpdatedFields +sidebar_label: EntitlementDocumentAllOfManuallyUpdatedFields +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'V2024EntitlementDocumentAllOfManuallyUpdatedFields'] +slug: /tools/sdk/go/v2024/models/entitlement-document-all-of-manually-updated-fields +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'V2024EntitlementDocumentAllOfManuallyUpdatedFields'] +--- + +# EntitlementDocumentAllOfManuallyUpdatedFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DESCRIPTION** | Pointer to **bool** | | [optional] [default to false] +**DISPLAY_NAME** | Pointer to **bool** | | [optional] [default to false] + +## Methods + +### NewEntitlementDocumentAllOfManuallyUpdatedFields + +`func NewEntitlementDocumentAllOfManuallyUpdatedFields() *EntitlementDocumentAllOfManuallyUpdatedFields` + +NewEntitlementDocumentAllOfManuallyUpdatedFields instantiates a new EntitlementDocumentAllOfManuallyUpdatedFields 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 + +### NewEntitlementDocumentAllOfManuallyUpdatedFieldsWithDefaults + +`func NewEntitlementDocumentAllOfManuallyUpdatedFieldsWithDefaults() *EntitlementDocumentAllOfManuallyUpdatedFields` + +NewEntitlementDocumentAllOfManuallyUpdatedFieldsWithDefaults instantiates a new EntitlementDocumentAllOfManuallyUpdatedFields 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 + +### GetDESCRIPTION + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) GetDESCRIPTION() bool` + +GetDESCRIPTION returns the DESCRIPTION field if non-nil, zero value otherwise. + +### GetDESCRIPTIONOk + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) GetDESCRIPTIONOk() (*bool, bool)` + +GetDESCRIPTIONOk returns a tuple with the DESCRIPTION field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDESCRIPTION + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) SetDESCRIPTION(v bool)` + +SetDESCRIPTION sets DESCRIPTION field to given value. + +### HasDESCRIPTION + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) HasDESCRIPTION() bool` + +HasDESCRIPTION returns a boolean if a field has been set. + +### GetDISPLAY_NAME + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) GetDISPLAY_NAME() bool` + +GetDISPLAY_NAME returns the DISPLAY_NAME field if non-nil, zero value otherwise. + +### GetDISPLAY_NAMEOk + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) GetDISPLAY_NAMEOk() (*bool, bool)` + +GetDISPLAY_NAMEOk returns a tuple with the DISPLAY_NAME field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDISPLAY_NAME + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) SetDISPLAY_NAME(v bool)` + +SetDISPLAY_NAME sets DISPLAY_NAME field to given value. + +### HasDISPLAY_NAME + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) HasDISPLAY_NAME() bool` + +HasDISPLAY_NAME returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EntitlementDocumentAllOfPermissions.md b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementDocumentAllOfPermissions.md new file mode 100644 index 000000000..b464a8734 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementDocumentAllOfPermissions.md @@ -0,0 +1,90 @@ +--- +id: v2024-entitlement-document-all-of-permissions +title: EntitlementDocumentAllOfPermissions +pagination_label: EntitlementDocumentAllOfPermissions +sidebar_label: EntitlementDocumentAllOfPermissions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementDocumentAllOfPermissions', 'V2024EntitlementDocumentAllOfPermissions'] +slug: /tools/sdk/go/v2024/models/entitlement-document-all-of-permissions +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfPermissions', 'V2024EntitlementDocumentAllOfPermissions'] +--- + +# EntitlementDocumentAllOfPermissions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Target** | Pointer to **string** | The target the permission would grants rights on. | [optional] +**Rights** | Pointer to **[]string** | All the rights (e.g. actions) that this permission allows on the target | [optional] + +## Methods + +### NewEntitlementDocumentAllOfPermissions + +`func NewEntitlementDocumentAllOfPermissions() *EntitlementDocumentAllOfPermissions` + +NewEntitlementDocumentAllOfPermissions instantiates a new EntitlementDocumentAllOfPermissions 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 + +### NewEntitlementDocumentAllOfPermissionsWithDefaults + +`func NewEntitlementDocumentAllOfPermissionsWithDefaults() *EntitlementDocumentAllOfPermissions` + +NewEntitlementDocumentAllOfPermissionsWithDefaults instantiates a new EntitlementDocumentAllOfPermissions 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 + +### GetTarget + +`func (o *EntitlementDocumentAllOfPermissions) GetTarget() string` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *EntitlementDocumentAllOfPermissions) GetTargetOk() (*string, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *EntitlementDocumentAllOfPermissions) SetTarget(v string)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *EntitlementDocumentAllOfPermissions) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + +### GetRights + +`func (o *EntitlementDocumentAllOfPermissions) GetRights() []string` + +GetRights returns the Rights field if non-nil, zero value otherwise. + +### GetRightsOk + +`func (o *EntitlementDocumentAllOfPermissions) GetRightsOk() (*[]string, bool)` + +GetRightsOk returns a tuple with the Rights field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRights + +`func (o *EntitlementDocumentAllOfPermissions) SetRights(v []string)` + +SetRights sets Rights field to given value. + +### HasRights + +`func (o *EntitlementDocumentAllOfPermissions) HasRights() bool` + +HasRights returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EntitlementDocumentAllOfSource.md b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementDocumentAllOfSource.md new file mode 100644 index 000000000..bb20ab870 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementDocumentAllOfSource.md @@ -0,0 +1,116 @@ +--- +id: v2024-entitlement-document-all-of-source +title: EntitlementDocumentAllOfSource +pagination_label: EntitlementDocumentAllOfSource +sidebar_label: EntitlementDocumentAllOfSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementDocumentAllOfSource', 'V2024EntitlementDocumentAllOfSource'] +slug: /tools/sdk/go/v2024/models/entitlement-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfSource', 'V2024EntitlementDocumentAllOfSource'] +--- + +# EntitlementDocumentAllOfSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of entitlement's source. | [optional] +**Name** | Pointer to **string** | Display name of entitlement's source. | [optional] +**Type** | Pointer to **string** | Type of object. | [optional] + +## Methods + +### NewEntitlementDocumentAllOfSource + +`func NewEntitlementDocumentAllOfSource() *EntitlementDocumentAllOfSource` + +NewEntitlementDocumentAllOfSource instantiates a new EntitlementDocumentAllOfSource 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 + +### NewEntitlementDocumentAllOfSourceWithDefaults + +`func NewEntitlementDocumentAllOfSourceWithDefaults() *EntitlementDocumentAllOfSource` + +NewEntitlementDocumentAllOfSourceWithDefaults instantiates a new EntitlementDocumentAllOfSource 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 + +### GetId + +`func (o *EntitlementDocumentAllOfSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementDocumentAllOfSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementDocumentAllOfSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementDocumentAllOfSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementDocumentAllOfSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementDocumentAllOfSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementDocumentAllOfSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementDocumentAllOfSource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *EntitlementDocumentAllOfSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementDocumentAllOfSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementDocumentAllOfSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementDocumentAllOfSource) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EntitlementOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementOwner.md new file mode 100644 index 000000000..ff8634e0f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementOwner.md @@ -0,0 +1,116 @@ +--- +id: v2024-entitlement-owner +title: EntitlementOwner +pagination_label: EntitlementOwner +sidebar_label: EntitlementOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementOwner', 'V2024EntitlementOwner'] +slug: /tools/sdk/go/v2024/models/entitlement-owner +tags: ['SDK', 'Software Development Kit', 'EntitlementOwner', 'V2024EntitlementOwner'] +--- + +# EntitlementOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity ID | [optional] +**Type** | Pointer to **string** | The type of object | [optional] +**Name** | Pointer to **string** | The display name of the identity | [optional] + +## Methods + +### NewEntitlementOwner + +`func NewEntitlementOwner() *EntitlementOwner` + +NewEntitlementOwner instantiates a new EntitlementOwner 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 + +### NewEntitlementOwnerWithDefaults + +`func NewEntitlementOwnerWithDefaults() *EntitlementOwner` + +NewEntitlementOwnerWithDefaults instantiates a new EntitlementOwner 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 + +### GetId + +`func (o *EntitlementOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *EntitlementOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EntitlementRef.md b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementRef.md new file mode 100644 index 000000000..c90770100 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementRef.md @@ -0,0 +1,126 @@ +--- +id: v2024-entitlement-ref +title: EntitlementRef +pagination_label: EntitlementRef +sidebar_label: EntitlementRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementRef', 'V2024EntitlementRef'] +slug: /tools/sdk/go/v2024/models/entitlement-ref +tags: ['SDK', 'Software Development Kit', 'EntitlementRef', 'V2024EntitlementRef'] +--- + +# EntitlementRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Entitlement's DTO type. | [optional] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **NullableString** | Entitlement's display name. | [optional] + +## Methods + +### NewEntitlementRef + +`func NewEntitlementRef() *EntitlementRef` + +NewEntitlementRef instantiates a new EntitlementRef 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 + +### NewEntitlementRefWithDefaults + +`func NewEntitlementRefWithDefaults() *EntitlementRef` + +NewEntitlementRefWithDefaults instantiates a new EntitlementRef 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 + +### GetType + +`func (o *EntitlementRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *EntitlementRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementRef) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *EntitlementRef) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *EntitlementRef) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EntitlementRef1.md b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementRef1.md new file mode 100644 index 000000000..c75def9a0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementRef1.md @@ -0,0 +1,116 @@ +--- +id: v2024-entitlement-ref1 +title: EntitlementRef1 +pagination_label: EntitlementRef1 +sidebar_label: EntitlementRef1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementRef1', 'V2024EntitlementRef1'] +slug: /tools/sdk/go/v2024/models/entitlement-ref1 +tags: ['SDK', 'Software Development Kit', 'EntitlementRef1', 'V2024EntitlementRef1'] +--- + +# EntitlementRef1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Entitlement's DTO type. | [optional] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **string** | Entitlement's display name. | [optional] + +## Methods + +### NewEntitlementRef1 + +`func NewEntitlementRef1() *EntitlementRef1` + +NewEntitlementRef1 instantiates a new EntitlementRef1 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 + +### NewEntitlementRef1WithDefaults + +`func NewEntitlementRef1WithDefaults() *EntitlementRef1` + +NewEntitlementRef1WithDefaults instantiates a new EntitlementRef1 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 + +### GetType + +`func (o *EntitlementRef1) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementRef1) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementRef1) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementRef1) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *EntitlementRef1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementRef1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementRef1) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementRef1) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementRef1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementRef1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementRef1) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementRef1) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EntitlementRequestConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementRequestConfig.md new file mode 100644 index 000000000..f5b716fbd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementRequestConfig.md @@ -0,0 +1,64 @@ +--- +id: v2024-entitlement-request-config +title: EntitlementRequestConfig +pagination_label: EntitlementRequestConfig +sidebar_label: EntitlementRequestConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementRequestConfig', 'V2024EntitlementRequestConfig'] +slug: /tools/sdk/go/v2024/models/entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig', 'V2024EntitlementRequestConfig'] +--- + +# EntitlementRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestConfig** | Pointer to [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] + +## Methods + +### NewEntitlementRequestConfig + +`func NewEntitlementRequestConfig() *EntitlementRequestConfig` + +NewEntitlementRequestConfig instantiates a new EntitlementRequestConfig 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 + +### NewEntitlementRequestConfigWithDefaults + +`func NewEntitlementRequestConfigWithDefaults() *EntitlementRequestConfig` + +NewEntitlementRequestConfigWithDefaults instantiates a new EntitlementRequestConfig 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 + +### GetAccessRequestConfig + +`func (o *EntitlementRequestConfig) GetAccessRequestConfig() EntitlementAccessRequestConfig` + +GetAccessRequestConfig returns the AccessRequestConfig field if non-nil, zero value otherwise. + +### GetAccessRequestConfigOk + +`func (o *EntitlementRequestConfig) GetAccessRequestConfigOk() (*EntitlementAccessRequestConfig, bool)` + +GetAccessRequestConfigOk returns a tuple with the AccessRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestConfig + +`func (o *EntitlementRequestConfig) SetAccessRequestConfig(v EntitlementAccessRequestConfig)` + +SetAccessRequestConfig sets AccessRequestConfig field to given value. + +### HasAccessRequestConfig + +`func (o *EntitlementRequestConfig) HasAccessRequestConfig() bool` + +HasAccessRequestConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EntitlementSource.md b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementSource.md new file mode 100644 index 000000000..d20692d5b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementSource.md @@ -0,0 +1,116 @@ +--- +id: v2024-entitlement-source +title: EntitlementSource +pagination_label: EntitlementSource +sidebar_label: EntitlementSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementSource', 'V2024EntitlementSource'] +slug: /tools/sdk/go/v2024/models/entitlement-source +tags: ['SDK', 'Software Development Kit', 'EntitlementSource', 'V2024EntitlementSource'] +--- + +# EntitlementSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The source ID | [optional] +**Type** | Pointer to **string** | The source type, will always be \"SOURCE\" | [optional] +**Name** | Pointer to **string** | The source name | [optional] + +## Methods + +### NewEntitlementSource + +`func NewEntitlementSource() *EntitlementSource` + +NewEntitlementSource instantiates a new EntitlementSource 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 + +### NewEntitlementSourceWithDefaults + +`func NewEntitlementSourceWithDefaults() *EntitlementSource` + +NewEntitlementSourceWithDefaults instantiates a new EntitlementSource 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 + +### GetId + +`func (o *EntitlementSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *EntitlementSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EntitlementSourceResetBaseReferenceDto.md b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementSourceResetBaseReferenceDto.md new file mode 100644 index 000000000..391a9a5d4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementSourceResetBaseReferenceDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-entitlement-source-reset-base-reference-dto +title: EntitlementSourceResetBaseReferenceDto +pagination_label: EntitlementSourceResetBaseReferenceDto +sidebar_label: EntitlementSourceResetBaseReferenceDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementSourceResetBaseReferenceDto', 'V2024EntitlementSourceResetBaseReferenceDto'] +slug: /tools/sdk/go/v2024/models/entitlement-source-reset-base-reference-dto +tags: ['SDK', 'Software Development Kit', 'EntitlementSourceResetBaseReferenceDto', 'V2024EntitlementSourceResetBaseReferenceDto'] +--- + +# EntitlementSourceResetBaseReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The DTO type | [optional] +**Id** | Pointer to **string** | The task ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewEntitlementSourceResetBaseReferenceDto + +`func NewEntitlementSourceResetBaseReferenceDto() *EntitlementSourceResetBaseReferenceDto` + +NewEntitlementSourceResetBaseReferenceDto instantiates a new EntitlementSourceResetBaseReferenceDto 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 + +### NewEntitlementSourceResetBaseReferenceDtoWithDefaults + +`func NewEntitlementSourceResetBaseReferenceDtoWithDefaults() *EntitlementSourceResetBaseReferenceDto` + +NewEntitlementSourceResetBaseReferenceDtoWithDefaults instantiates a new EntitlementSourceResetBaseReferenceDto 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 + +### GetType + +`func (o *EntitlementSourceResetBaseReferenceDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementSourceResetBaseReferenceDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementSourceResetBaseReferenceDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementSourceResetBaseReferenceDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *EntitlementSourceResetBaseReferenceDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementSourceResetBaseReferenceDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementSourceResetBaseReferenceDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementSourceResetBaseReferenceDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementSourceResetBaseReferenceDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementSourceResetBaseReferenceDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementSourceResetBaseReferenceDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementSourceResetBaseReferenceDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EntitlementSummary.md b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementSummary.md new file mode 100644 index 000000000..847f93caa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EntitlementSummary.md @@ -0,0 +1,308 @@ +--- +id: v2024-entitlement-summary +title: EntitlementSummary +pagination_label: EntitlementSummary +sidebar_label: EntitlementSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementSummary', 'V2024EntitlementSummary'] +slug: /tools/sdk/go/v2024/models/entitlement-summary +tags: ['SDK', 'Software Development Kit', 'EntitlementSummary', 'V2024EntitlementSummary'] +--- + +# EntitlementSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Source** | Pointer to [**Reference**](reference) | | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Privileged** | Pointer to **bool** | | [optional] +**Attribute** | Pointer to **string** | | [optional] +**Value** | Pointer to **string** | | [optional] +**Standalone** | Pointer to **bool** | | [optional] + +## Methods + +### NewEntitlementSummary + +`func NewEntitlementSummary() *EntitlementSummary` + +NewEntitlementSummary instantiates a new EntitlementSummary 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 + +### NewEntitlementSummaryWithDefaults + +`func NewEntitlementSummaryWithDefaults() *EntitlementSummary` + +NewEntitlementSummaryWithDefaults instantiates a new EntitlementSummary 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 + +### GetId + +`func (o *EntitlementSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementSummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementSummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementSummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementSummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementSummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementSummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *EntitlementSummary) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *EntitlementSummary) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *EntitlementSummary) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *EntitlementSummary) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *EntitlementSummary) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *EntitlementSummary) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *EntitlementSummary) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *EntitlementSummary) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *EntitlementSummary) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *EntitlementSummary) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSource + +`func (o *EntitlementSummary) GetSource() Reference` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *EntitlementSummary) GetSourceOk() (*Reference, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *EntitlementSummary) SetSource(v Reference)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *EntitlementSummary) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetType + +`func (o *EntitlementSummary) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementSummary) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementSummary) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *EntitlementSummary) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *EntitlementSummary) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *EntitlementSummary) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *EntitlementSummary) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetAttribute + +`func (o *EntitlementSummary) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *EntitlementSummary) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *EntitlementSummary) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *EntitlementSummary) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *EntitlementSummary) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *EntitlementSummary) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *EntitlementSummary) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *EntitlementSummary) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetStandalone + +`func (o *EntitlementSummary) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *EntitlementSummary) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *EntitlementSummary) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + +### HasStandalone + +`func (o *EntitlementSummary) HasStandalone() bool` + +HasStandalone returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EntityCreatedByDTO.md b/docs/tools/sdk/go/Reference/V2024/Models/EntityCreatedByDTO.md new file mode 100644 index 000000000..4ac421d36 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EntityCreatedByDTO.md @@ -0,0 +1,90 @@ +--- +id: v2024-entity-created-by-dto +title: EntityCreatedByDTO +pagination_label: EntityCreatedByDTO +sidebar_label: EntityCreatedByDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntityCreatedByDTO', 'V2024EntityCreatedByDTO'] +slug: /tools/sdk/go/v2024/models/entity-created-by-dto +tags: ['SDK', 'Software Development Kit', 'EntityCreatedByDTO', 'V2024EntityCreatedByDTO'] +--- + +# EntityCreatedByDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the creator | [optional] +**DisplayName** | Pointer to **string** | The display name of the creator | [optional] + +## Methods + +### NewEntityCreatedByDTO + +`func NewEntityCreatedByDTO() *EntityCreatedByDTO` + +NewEntityCreatedByDTO instantiates a new EntityCreatedByDTO 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 + +### NewEntityCreatedByDTOWithDefaults + +`func NewEntityCreatedByDTOWithDefaults() *EntityCreatedByDTO` + +NewEntityCreatedByDTOWithDefaults instantiates a new EntityCreatedByDTO 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 + +### GetId + +`func (o *EntityCreatedByDTO) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntityCreatedByDTO) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntityCreatedByDTO) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntityCreatedByDTO) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *EntityCreatedByDTO) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *EntityCreatedByDTO) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *EntityCreatedByDTO) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *EntityCreatedByDTO) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Error.md b/docs/tools/sdk/go/Reference/V2024/Models/Error.md new file mode 100644 index 000000000..fb80ab20a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Error.md @@ -0,0 +1,116 @@ +--- +id: v2024-error +title: Error +pagination_label: Error +sidebar_label: Error +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Error', 'V2024Error'] +slug: /tools/sdk/go/v2024/models/error +tags: ['SDK', 'Software Development Kit', 'Error', 'V2024Error'] +--- + +# Error + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **string** | DetailCode is the text of the status code returned | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | | [optional] +**TrackingId** | Pointer to **string** | TrackingID is the request tracking unique identifier | [optional] + +## Methods + +### NewError + +`func NewError() *Error` + +NewError instantiates a new Error 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 + +### NewErrorWithDefaults + +`func NewErrorWithDefaults() *Error` + +NewErrorWithDefaults instantiates a new Error 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 + +### GetDetailCode + +`func (o *Error) GetDetailCode() string` + +GetDetailCode returns the DetailCode field if non-nil, zero value otherwise. + +### GetDetailCodeOk + +`func (o *Error) GetDetailCodeOk() (*string, bool)` + +GetDetailCodeOk returns a tuple with the DetailCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetailCode + +`func (o *Error) SetDetailCode(v string)` + +SetDetailCode sets DetailCode field to given value. + +### HasDetailCode + +`func (o *Error) HasDetailCode() bool` + +HasDetailCode returns a boolean if a field has been set. + +### GetMessages + +`func (o *Error) GetMessages() []ErrorMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *Error) GetMessagesOk() (*[]ErrorMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *Error) SetMessages(v []ErrorMessage)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *Error) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetTrackingId + +`func (o *Error) GetTrackingId() string` + +GetTrackingId returns the TrackingId field if non-nil, zero value otherwise. + +### GetTrackingIdOk + +`func (o *Error) GetTrackingIdOk() (*string, bool)` + +GetTrackingIdOk returns a tuple with the TrackingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingId + +`func (o *Error) SetTrackingId(v string)` + +SetTrackingId sets TrackingId field to given value. + +### HasTrackingId + +`func (o *Error) HasTrackingId() bool` + +HasTrackingId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ErrorMessage.md b/docs/tools/sdk/go/Reference/V2024/Models/ErrorMessage.md new file mode 100644 index 000000000..05efa8d6d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ErrorMessage.md @@ -0,0 +1,116 @@ +--- +id: v2024-error-message +title: ErrorMessage +pagination_label: ErrorMessage +sidebar_label: ErrorMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ErrorMessage', 'V2024ErrorMessage'] +slug: /tools/sdk/go/v2024/models/error-message +tags: ['SDK', 'Software Development Kit', 'ErrorMessage', 'V2024ErrorMessage'] +--- + +# ErrorMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | Pointer to **string** | Locale is the current Locale | [optional] +**LocaleOrigin** | Pointer to **string** | LocaleOrigin holds possible values of how the locale was selected | [optional] +**Text** | Pointer to **string** | Text is the actual text of the error message | [optional] + +## Methods + +### NewErrorMessage + +`func NewErrorMessage() *ErrorMessage` + +NewErrorMessage instantiates a new ErrorMessage 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 + +### NewErrorMessageWithDefaults + +`func NewErrorMessageWithDefaults() *ErrorMessage` + +NewErrorMessageWithDefaults instantiates a new ErrorMessage 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 + +### GetLocale + +`func (o *ErrorMessage) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *ErrorMessage) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *ErrorMessage) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *ErrorMessage) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + +### GetLocaleOrigin + +`func (o *ErrorMessage) GetLocaleOrigin() string` + +GetLocaleOrigin returns the LocaleOrigin field if non-nil, zero value otherwise. + +### GetLocaleOriginOk + +`func (o *ErrorMessage) GetLocaleOriginOk() (*string, bool)` + +GetLocaleOriginOk returns a tuple with the LocaleOrigin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocaleOrigin + +`func (o *ErrorMessage) SetLocaleOrigin(v string)` + +SetLocaleOrigin sets LocaleOrigin field to given value. + +### HasLocaleOrigin + +`func (o *ErrorMessage) HasLocaleOrigin() bool` + +HasLocaleOrigin returns a boolean if a field has been set. + +### GetText + +`func (o *ErrorMessage) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *ErrorMessage) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *ErrorMessage) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *ErrorMessage) HasText() bool` + +HasText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ErrorMessageDto.md b/docs/tools/sdk/go/Reference/V2024/Models/ErrorMessageDto.md new file mode 100644 index 000000000..99ed938a7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ErrorMessageDto.md @@ -0,0 +1,136 @@ +--- +id: v2024-error-message-dto +title: ErrorMessageDto +pagination_label: ErrorMessageDto +sidebar_label: ErrorMessageDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ErrorMessageDto', 'V2024ErrorMessageDto'] +slug: /tools/sdk/go/v2024/models/error-message-dto +tags: ['SDK', 'Software Development Kit', 'ErrorMessageDto', 'V2024ErrorMessageDto'] +--- + +# ErrorMessageDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | Pointer to **NullableString** | The locale for the message text, a BCP 47 language tag. | [optional] +**LocaleOrigin** | Pointer to [**NullableLocaleOrigin**](locale-origin) | | [optional] +**Text** | Pointer to **string** | Actual text of the error message in the indicated locale. | [optional] + +## Methods + +### NewErrorMessageDto + +`func NewErrorMessageDto() *ErrorMessageDto` + +NewErrorMessageDto instantiates a new ErrorMessageDto 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 + +### NewErrorMessageDtoWithDefaults + +`func NewErrorMessageDtoWithDefaults() *ErrorMessageDto` + +NewErrorMessageDtoWithDefaults instantiates a new ErrorMessageDto 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 + +### GetLocale + +`func (o *ErrorMessageDto) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *ErrorMessageDto) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *ErrorMessageDto) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *ErrorMessageDto) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + +### SetLocaleNil + +`func (o *ErrorMessageDto) SetLocaleNil(b bool)` + + SetLocaleNil sets the value for Locale to be an explicit nil + +### UnsetLocale +`func (o *ErrorMessageDto) UnsetLocale()` + +UnsetLocale ensures that no value is present for Locale, not even an explicit nil +### GetLocaleOrigin + +`func (o *ErrorMessageDto) GetLocaleOrigin() LocaleOrigin` + +GetLocaleOrigin returns the LocaleOrigin field if non-nil, zero value otherwise. + +### GetLocaleOriginOk + +`func (o *ErrorMessageDto) GetLocaleOriginOk() (*LocaleOrigin, bool)` + +GetLocaleOriginOk returns a tuple with the LocaleOrigin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocaleOrigin + +`func (o *ErrorMessageDto) SetLocaleOrigin(v LocaleOrigin)` + +SetLocaleOrigin sets LocaleOrigin field to given value. + +### HasLocaleOrigin + +`func (o *ErrorMessageDto) HasLocaleOrigin() bool` + +HasLocaleOrigin returns a boolean if a field has been set. + +### SetLocaleOriginNil + +`func (o *ErrorMessageDto) SetLocaleOriginNil(b bool)` + + SetLocaleOriginNil sets the value for LocaleOrigin to be an explicit nil + +### UnsetLocaleOrigin +`func (o *ErrorMessageDto) UnsetLocaleOrigin()` + +UnsetLocaleOrigin ensures that no value is present for LocaleOrigin, not even an explicit nil +### GetText + +`func (o *ErrorMessageDto) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *ErrorMessageDto) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *ErrorMessageDto) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *ErrorMessageDto) HasText() bool` + +HasText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ErrorResponseDto.md b/docs/tools/sdk/go/Reference/V2024/Models/ErrorResponseDto.md new file mode 100644 index 000000000..19f3ccf52 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ErrorResponseDto.md @@ -0,0 +1,142 @@ +--- +id: v2024-error-response-dto +title: ErrorResponseDto +pagination_label: ErrorResponseDto +sidebar_label: ErrorResponseDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ErrorResponseDto', 'V2024ErrorResponseDto'] +slug: /tools/sdk/go/v2024/models/error-response-dto +tags: ['SDK', 'Software Development Kit', 'ErrorResponseDto', 'V2024ErrorResponseDto'] +--- + +# ErrorResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **string** | Fine-grained error code providing more detail of the error. | [optional] +**TrackingId** | Pointer to **string** | Unique tracking id for the error. | [optional] +**Messages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Generic localized reason for error | [optional] +**Causes** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [optional] + +## Methods + +### NewErrorResponseDto + +`func NewErrorResponseDto() *ErrorResponseDto` + +NewErrorResponseDto instantiates a new ErrorResponseDto 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 + +### NewErrorResponseDtoWithDefaults + +`func NewErrorResponseDtoWithDefaults() *ErrorResponseDto` + +NewErrorResponseDtoWithDefaults instantiates a new ErrorResponseDto 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 + +### GetDetailCode + +`func (o *ErrorResponseDto) GetDetailCode() string` + +GetDetailCode returns the DetailCode field if non-nil, zero value otherwise. + +### GetDetailCodeOk + +`func (o *ErrorResponseDto) GetDetailCodeOk() (*string, bool)` + +GetDetailCodeOk returns a tuple with the DetailCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetailCode + +`func (o *ErrorResponseDto) SetDetailCode(v string)` + +SetDetailCode sets DetailCode field to given value. + +### HasDetailCode + +`func (o *ErrorResponseDto) HasDetailCode() bool` + +HasDetailCode returns a boolean if a field has been set. + +### GetTrackingId + +`func (o *ErrorResponseDto) GetTrackingId() string` + +GetTrackingId returns the TrackingId field if non-nil, zero value otherwise. + +### GetTrackingIdOk + +`func (o *ErrorResponseDto) GetTrackingIdOk() (*string, bool)` + +GetTrackingIdOk returns a tuple with the TrackingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingId + +`func (o *ErrorResponseDto) SetTrackingId(v string)` + +SetTrackingId sets TrackingId field to given value. + +### HasTrackingId + +`func (o *ErrorResponseDto) HasTrackingId() bool` + +HasTrackingId returns a boolean if a field has been set. + +### GetMessages + +`func (o *ErrorResponseDto) GetMessages() []ErrorMessageDto` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *ErrorResponseDto) GetMessagesOk() (*[]ErrorMessageDto, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *ErrorResponseDto) SetMessages(v []ErrorMessageDto)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *ErrorResponseDto) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetCauses + +`func (o *ErrorResponseDto) GetCauses() []ErrorMessageDto` + +GetCauses returns the Causes field if non-nil, zero value otherwise. + +### GetCausesOk + +`func (o *ErrorResponseDto) GetCausesOk() (*[]ErrorMessageDto, bool)` + +GetCausesOk returns a tuple with the Causes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCauses + +`func (o *ErrorResponseDto) SetCauses(v []ErrorMessageDto)` + +SetCauses sets Causes field to given value. + +### HasCauses + +`func (o *ErrorResponseDto) HasCauses() bool` + +HasCauses returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EvaluateResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/EvaluateResponse.md new file mode 100644 index 000000000..f3d08937a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EvaluateResponse.md @@ -0,0 +1,90 @@ +--- +id: v2024-evaluate-response +title: EvaluateResponse +pagination_label: EvaluateResponse +sidebar_label: EvaluateResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EvaluateResponse', 'V2024EvaluateResponse'] +slug: /tools/sdk/go/v2024/models/evaluate-response +tags: ['SDK', 'Software Development Kit', 'EvaluateResponse', 'V2024EvaluateResponse'] +--- + +# EvaluateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReassignToId** | Pointer to **string** | The Identity ID which should be the recipient of any work items sent to a specific identity & work type | [optional] +**LookupTrail** | Pointer to [**[]LookupStep**](lookup-step) | List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration | [optional] + +## Methods + +### NewEvaluateResponse + +`func NewEvaluateResponse() *EvaluateResponse` + +NewEvaluateResponse instantiates a new EvaluateResponse 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 + +### NewEvaluateResponseWithDefaults + +`func NewEvaluateResponseWithDefaults() *EvaluateResponse` + +NewEvaluateResponseWithDefaults instantiates a new EvaluateResponse 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 + +### GetReassignToId + +`func (o *EvaluateResponse) GetReassignToId() string` + +GetReassignToId returns the ReassignToId field if non-nil, zero value otherwise. + +### GetReassignToIdOk + +`func (o *EvaluateResponse) GetReassignToIdOk() (*string, bool)` + +GetReassignToIdOk returns a tuple with the ReassignToId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignToId + +`func (o *EvaluateResponse) SetReassignToId(v string)` + +SetReassignToId sets ReassignToId field to given value. + +### HasReassignToId + +`func (o *EvaluateResponse) HasReassignToId() bool` + +HasReassignToId returns a boolean if a field has been set. + +### GetLookupTrail + +`func (o *EvaluateResponse) GetLookupTrail() []LookupStep` + +GetLookupTrail returns the LookupTrail field if non-nil, zero value otherwise. + +### GetLookupTrailOk + +`func (o *EvaluateResponse) GetLookupTrailOk() (*[]LookupStep, bool)` + +GetLookupTrailOk returns a tuple with the LookupTrail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLookupTrail + +`func (o *EvaluateResponse) SetLookupTrail(v []LookupStep)` + +SetLookupTrail sets LookupTrail field to given value. + +### HasLookupTrail + +`func (o *EvaluateResponse) HasLookupTrail() bool` + +HasLookupTrail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Event.md b/docs/tools/sdk/go/Reference/V2024/Models/Event.md new file mode 100644 index 000000000..20767ee69 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Event.md @@ -0,0 +1,490 @@ +--- +id: v2024-event +title: Event +pagination_label: Event +sidebar_label: Event +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Event', 'V2024Event'] +slug: /tools/sdk/go/v2024/models/event +tags: ['SDK', 'Software Development Kit', 'Event', 'V2024Event'] +--- + +# Event + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the entitlement. | [optional] +**Name** | Pointer to **string** | Name of the entitlement. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Action** | Pointer to **string** | Name of the event as it's displayed in audit reports. | [optional] +**Type** | Pointer to **string** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**Actor** | Pointer to [**EventActor**](event-actor) | | [optional] +**Target** | Pointer to [**EventTarget**](event-target) | | [optional] +**Stack** | Pointer to **string** | The event's stack. | [optional] +**TrackingNumber** | Pointer to **string** | ID of the group of events. | [optional] +**IpAddress** | Pointer to **string** | Target system's IP address. | [optional] +**Details** | Pointer to **string** | ID of event's details. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Attributes involved in the event. | [optional] +**Objects** | Pointer to **[]string** | Objects the event is happening to. | [optional] +**Operation** | Pointer to **string** | Operation, or action, performed during the event. | [optional] +**Status** | Pointer to **string** | Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. | [optional] +**TechnicalName** | Pointer to **string** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] + +## Methods + +### NewEvent + +`func NewEvent() *Event` + +NewEvent instantiates a new Event 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 + +### NewEventWithDefaults + +`func NewEventWithDefaults() *Event` + +NewEventWithDefaults instantiates a new Event 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 + +### GetId + +`func (o *Event) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Event) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Event) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Event) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Event) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Event) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Event) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Event) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *Event) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Event) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Event) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Event) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *Event) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *Event) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetSynced + +`func (o *Event) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *Event) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *Event) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *Event) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetAction + +`func (o *Event) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *Event) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *Event) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *Event) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetType + +`func (o *Event) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Event) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Event) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Event) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetActor + +`func (o *Event) GetActor() EventActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *Event) GetActorOk() (*EventActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *Event) SetActor(v EventActor)` + +SetActor sets Actor field to given value. + +### HasActor + +`func (o *Event) HasActor() bool` + +HasActor returns a boolean if a field has been set. + +### GetTarget + +`func (o *Event) GetTarget() EventTarget` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *Event) GetTargetOk() (*EventTarget, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *Event) SetTarget(v EventTarget)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *Event) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + +### GetStack + +`func (o *Event) GetStack() string` + +GetStack returns the Stack field if non-nil, zero value otherwise. + +### GetStackOk + +`func (o *Event) GetStackOk() (*string, bool)` + +GetStackOk returns a tuple with the Stack field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStack + +`func (o *Event) SetStack(v string)` + +SetStack sets Stack field to given value. + +### HasStack + +`func (o *Event) HasStack() bool` + +HasStack returns a boolean if a field has been set. + +### GetTrackingNumber + +`func (o *Event) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *Event) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *Event) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + +### HasTrackingNumber + +`func (o *Event) HasTrackingNumber() bool` + +HasTrackingNumber returns a boolean if a field has been set. + +### GetIpAddress + +`func (o *Event) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *Event) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *Event) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + +### HasIpAddress + +`func (o *Event) HasIpAddress() bool` + +HasIpAddress returns a boolean if a field has been set. + +### GetDetails + +`func (o *Event) GetDetails() string` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *Event) GetDetailsOk() (*string, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *Event) SetDetails(v string)` + +SetDetails sets Details field to given value. + +### HasDetails + +`func (o *Event) HasDetails() bool` + +HasDetails returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Event) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Event) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Event) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Event) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetObjects + +`func (o *Event) GetObjects() []string` + +GetObjects returns the Objects field if non-nil, zero value otherwise. + +### GetObjectsOk + +`func (o *Event) GetObjectsOk() (*[]string, bool)` + +GetObjectsOk returns a tuple with the Objects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjects + +`func (o *Event) SetObjects(v []string)` + +SetObjects sets Objects field to given value. + +### HasObjects + +`func (o *Event) HasObjects() bool` + +HasObjects returns a boolean if a field has been set. + +### GetOperation + +`func (o *Event) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *Event) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *Event) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *Event) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetStatus + +`func (o *Event) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Event) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Event) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Event) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetTechnicalName + +`func (o *Event) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *Event) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *Event) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + +### HasTechnicalName + +`func (o *Event) HasTechnicalName() bool` + +HasTechnicalName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EventActor.md b/docs/tools/sdk/go/Reference/V2024/Models/EventActor.md new file mode 100644 index 000000000..2176be0fd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EventActor.md @@ -0,0 +1,64 @@ +--- +id: v2024-event-actor +title: EventActor +pagination_label: EventActor +sidebar_label: EventActor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EventActor', 'V2024EventActor'] +slug: /tools/sdk/go/v2024/models/event-actor +tags: ['SDK', 'Software Development Kit', 'EventActor', 'V2024EventActor'] +--- + +# EventActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the actor that generated the event. | [optional] + +## Methods + +### NewEventActor + +`func NewEventActor() *EventActor` + +NewEventActor instantiates a new EventActor 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 + +### NewEventActorWithDefaults + +`func NewEventActorWithDefaults() *EventActor` + +NewEventActorWithDefaults instantiates a new EventActor 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 + +### GetName + +`func (o *EventActor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EventActor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EventActor) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EventActor) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EventBridgeConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/EventBridgeConfig.md new file mode 100644 index 000000000..448e7211f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EventBridgeConfig.md @@ -0,0 +1,80 @@ +--- +id: v2024-event-bridge-config +title: EventBridgeConfig +pagination_label: EventBridgeConfig +sidebar_label: EventBridgeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EventBridgeConfig', 'V2024EventBridgeConfig'] +slug: /tools/sdk/go/v2024/models/event-bridge-config +tags: ['SDK', 'Software Development Kit', 'EventBridgeConfig', 'V2024EventBridgeConfig'] +--- + +# EventBridgeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AwsAccount** | **string** | AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource. | +**AwsRegion** | **string** | AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values. | + +## Methods + +### NewEventBridgeConfig + +`func NewEventBridgeConfig(awsAccount string, awsRegion string, ) *EventBridgeConfig` + +NewEventBridgeConfig instantiates a new EventBridgeConfig 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 + +### NewEventBridgeConfigWithDefaults + +`func NewEventBridgeConfigWithDefaults() *EventBridgeConfig` + +NewEventBridgeConfigWithDefaults instantiates a new EventBridgeConfig 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 + +### GetAwsAccount + +`func (o *EventBridgeConfig) GetAwsAccount() string` + +GetAwsAccount returns the AwsAccount field if non-nil, zero value otherwise. + +### GetAwsAccountOk + +`func (o *EventBridgeConfig) GetAwsAccountOk() (*string, bool)` + +GetAwsAccountOk returns a tuple with the AwsAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsAccount + +`func (o *EventBridgeConfig) SetAwsAccount(v string)` + +SetAwsAccount sets AwsAccount field to given value. + + +### GetAwsRegion + +`func (o *EventBridgeConfig) GetAwsRegion() string` + +GetAwsRegion returns the AwsRegion field if non-nil, zero value otherwise. + +### GetAwsRegionOk + +`func (o *EventBridgeConfig) GetAwsRegionOk() (*string, bool)` + +GetAwsRegionOk returns a tuple with the AwsRegion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsRegion + +`func (o *EventBridgeConfig) SetAwsRegion(v string)` + +SetAwsRegion sets AwsRegion field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EventDocument.md b/docs/tools/sdk/go/Reference/V2024/Models/EventDocument.md new file mode 100644 index 000000000..c947274fa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EventDocument.md @@ -0,0 +1,490 @@ +--- +id: v2024-event-document +title: EventDocument +pagination_label: EventDocument +sidebar_label: EventDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EventDocument', 'V2024EventDocument'] +slug: /tools/sdk/go/v2024/models/event-document +tags: ['SDK', 'Software Development Kit', 'EventDocument', 'V2024EventDocument'] +--- + +# EventDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the entitlement. | [optional] +**Name** | Pointer to **string** | Name of the entitlement. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Action** | Pointer to **string** | Name of the event as it's displayed in audit reports. | [optional] +**Type** | Pointer to **string** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**Actor** | Pointer to [**EventActor**](event-actor) | | [optional] +**Target** | Pointer to [**EventTarget**](event-target) | | [optional] +**Stack** | Pointer to **string** | The event's stack. | [optional] +**TrackingNumber** | Pointer to **string** | ID of the group of events. | [optional] +**IpAddress** | Pointer to **string** | Target system's IP address. | [optional] +**Details** | Pointer to **string** | ID of event's details. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Attributes involved in the event. | [optional] +**Objects** | Pointer to **[]string** | Objects the event is happening to. | [optional] +**Operation** | Pointer to **string** | Operation, or action, performed during the event. | [optional] +**Status** | Pointer to **string** | Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. | [optional] +**TechnicalName** | Pointer to **string** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] + +## Methods + +### NewEventDocument + +`func NewEventDocument() *EventDocument` + +NewEventDocument instantiates a new EventDocument 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 + +### NewEventDocumentWithDefaults + +`func NewEventDocumentWithDefaults() *EventDocument` + +NewEventDocumentWithDefaults instantiates a new EventDocument 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 + +### GetId + +`func (o *EventDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EventDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EventDocument) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EventDocument) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EventDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EventDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EventDocument) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EventDocument) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *EventDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *EventDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *EventDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *EventDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *EventDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *EventDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetSynced + +`func (o *EventDocument) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *EventDocument) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *EventDocument) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *EventDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetAction + +`func (o *EventDocument) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *EventDocument) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *EventDocument) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *EventDocument) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetType + +`func (o *EventDocument) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EventDocument) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EventDocument) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EventDocument) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetActor + +`func (o *EventDocument) GetActor() EventActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *EventDocument) GetActorOk() (*EventActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *EventDocument) SetActor(v EventActor)` + +SetActor sets Actor field to given value. + +### HasActor + +`func (o *EventDocument) HasActor() bool` + +HasActor returns a boolean if a field has been set. + +### GetTarget + +`func (o *EventDocument) GetTarget() EventTarget` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *EventDocument) GetTargetOk() (*EventTarget, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *EventDocument) SetTarget(v EventTarget)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *EventDocument) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + +### GetStack + +`func (o *EventDocument) GetStack() string` + +GetStack returns the Stack field if non-nil, zero value otherwise. + +### GetStackOk + +`func (o *EventDocument) GetStackOk() (*string, bool)` + +GetStackOk returns a tuple with the Stack field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStack + +`func (o *EventDocument) SetStack(v string)` + +SetStack sets Stack field to given value. + +### HasStack + +`func (o *EventDocument) HasStack() bool` + +HasStack returns a boolean if a field has been set. + +### GetTrackingNumber + +`func (o *EventDocument) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *EventDocument) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *EventDocument) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + +### HasTrackingNumber + +`func (o *EventDocument) HasTrackingNumber() bool` + +HasTrackingNumber returns a boolean if a field has been set. + +### GetIpAddress + +`func (o *EventDocument) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *EventDocument) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *EventDocument) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + +### HasIpAddress + +`func (o *EventDocument) HasIpAddress() bool` + +HasIpAddress returns a boolean if a field has been set. + +### GetDetails + +`func (o *EventDocument) GetDetails() string` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *EventDocument) GetDetailsOk() (*string, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *EventDocument) SetDetails(v string)` + +SetDetails sets Details field to given value. + +### HasDetails + +`func (o *EventDocument) HasDetails() bool` + +HasDetails returns a boolean if a field has been set. + +### GetAttributes + +`func (o *EventDocument) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *EventDocument) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *EventDocument) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *EventDocument) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetObjects + +`func (o *EventDocument) GetObjects() []string` + +GetObjects returns the Objects field if non-nil, zero value otherwise. + +### GetObjectsOk + +`func (o *EventDocument) GetObjectsOk() (*[]string, bool)` + +GetObjectsOk returns a tuple with the Objects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjects + +`func (o *EventDocument) SetObjects(v []string)` + +SetObjects sets Objects field to given value. + +### HasObjects + +`func (o *EventDocument) HasObjects() bool` + +HasObjects returns a boolean if a field has been set. + +### GetOperation + +`func (o *EventDocument) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *EventDocument) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *EventDocument) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *EventDocument) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetStatus + +`func (o *EventDocument) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *EventDocument) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *EventDocument) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *EventDocument) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetTechnicalName + +`func (o *EventDocument) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *EventDocument) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *EventDocument) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + +### HasTechnicalName + +`func (o *EventDocument) HasTechnicalName() bool` + +HasTechnicalName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/EventTarget.md b/docs/tools/sdk/go/Reference/V2024/Models/EventTarget.md new file mode 100644 index 000000000..f6b06e22f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/EventTarget.md @@ -0,0 +1,64 @@ +--- +id: v2024-event-target +title: EventTarget +pagination_label: EventTarget +sidebar_label: EventTarget +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EventTarget', 'V2024EventTarget'] +slug: /tools/sdk/go/v2024/models/event-target +tags: ['SDK', 'Software Development Kit', 'EventTarget', 'V2024EventTarget'] +--- + +# EventTarget + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the target, or recipient, of the event. | [optional] + +## Methods + +### NewEventTarget + +`func NewEventTarget() *EventTarget` + +NewEventTarget instantiates a new EventTarget 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 + +### NewEventTargetWithDefaults + +`func NewEventTargetWithDefaults() *EventTarget` + +NewEventTargetWithDefaults instantiates a new EventTarget 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 + +### GetName + +`func (o *EventTarget) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EventTarget) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EventTarget) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EventTarget) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ExceptionAccessCriteria.md b/docs/tools/sdk/go/Reference/V2024/Models/ExceptionAccessCriteria.md new file mode 100644 index 000000000..7c8522d90 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ExceptionAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: v2024-exception-access-criteria +title: ExceptionAccessCriteria +pagination_label: ExceptionAccessCriteria +sidebar_label: ExceptionAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExceptionAccessCriteria', 'V2024ExceptionAccessCriteria'] +slug: /tools/sdk/go/v2024/models/exception-access-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionAccessCriteria', 'V2024ExceptionAccessCriteria'] +--- + +# ExceptionAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] +**RightCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] + +## Methods + +### NewExceptionAccessCriteria + +`func NewExceptionAccessCriteria() *ExceptionAccessCriteria` + +NewExceptionAccessCriteria instantiates a new ExceptionAccessCriteria 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 + +### NewExceptionAccessCriteriaWithDefaults + +`func NewExceptionAccessCriteriaWithDefaults() *ExceptionAccessCriteria` + +NewExceptionAccessCriteriaWithDefaults instantiates a new ExceptionAccessCriteria 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 + +### GetLeftCriteria + +`func (o *ExceptionAccessCriteria) GetLeftCriteria() ExceptionCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *ExceptionAccessCriteria) GetLeftCriteriaOk() (*ExceptionCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *ExceptionAccessCriteria) SetLeftCriteria(v ExceptionCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *ExceptionAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *ExceptionAccessCriteria) GetRightCriteria() ExceptionCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *ExceptionAccessCriteria) GetRightCriteriaOk() (*ExceptionCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *ExceptionAccessCriteria) SetRightCriteria(v ExceptionCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *ExceptionAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ExceptionCriteria.md b/docs/tools/sdk/go/Reference/V2024/Models/ExceptionCriteria.md new file mode 100644 index 000000000..478920244 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ExceptionCriteria.md @@ -0,0 +1,64 @@ +--- +id: v2024-exception-criteria +title: ExceptionCriteria +pagination_label: ExceptionCriteria +sidebar_label: ExceptionCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExceptionCriteria', 'V2024ExceptionCriteria'] +slug: /tools/sdk/go/v2024/models/exception-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteria', 'V2024ExceptionCriteria'] +--- + +# ExceptionCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]ExceptionCriteriaCriteriaListInner**](exception-criteria-criteria-list-inner) | List of exception criteria. There is a min of 1 and max of 50 items in the list. | [optional] + +## Methods + +### NewExceptionCriteria + +`func NewExceptionCriteria() *ExceptionCriteria` + +NewExceptionCriteria instantiates a new ExceptionCriteria 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 + +### NewExceptionCriteriaWithDefaults + +`func NewExceptionCriteriaWithDefaults() *ExceptionCriteria` + +NewExceptionCriteriaWithDefaults instantiates a new ExceptionCriteria 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 + +### GetCriteriaList + +`func (o *ExceptionCriteria) GetCriteriaList() []ExceptionCriteriaCriteriaListInner` + +GetCriteriaList returns the CriteriaList field if non-nil, zero value otherwise. + +### GetCriteriaListOk + +`func (o *ExceptionCriteria) GetCriteriaListOk() (*[]ExceptionCriteriaCriteriaListInner, bool)` + +GetCriteriaListOk returns a tuple with the CriteriaList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteriaList + +`func (o *ExceptionCriteria) SetCriteriaList(v []ExceptionCriteriaCriteriaListInner)` + +SetCriteriaList sets CriteriaList field to given value. + +### HasCriteriaList + +`func (o *ExceptionCriteria) HasCriteriaList() bool` + +HasCriteriaList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ExceptionCriteriaAccess.md b/docs/tools/sdk/go/Reference/V2024/Models/ExceptionCriteriaAccess.md new file mode 100644 index 000000000..def4619c2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ExceptionCriteriaAccess.md @@ -0,0 +1,142 @@ +--- +id: v2024-exception-criteria-access +title: ExceptionCriteriaAccess +pagination_label: ExceptionCriteriaAccess +sidebar_label: ExceptionCriteriaAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExceptionCriteriaAccess', 'V2024ExceptionCriteriaAccess'] +slug: /tools/sdk/go/v2024/models/exception-criteria-access +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaAccess', 'V2024ExceptionCriteriaAccess'] +--- + +# ExceptionCriteriaAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] +**Existing** | Pointer to **bool** | Whether the subject identity already had that access or not | [optional] [default to false] + +## Methods + +### NewExceptionCriteriaAccess + +`func NewExceptionCriteriaAccess() *ExceptionCriteriaAccess` + +NewExceptionCriteriaAccess instantiates a new ExceptionCriteriaAccess 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 + +### NewExceptionCriteriaAccessWithDefaults + +`func NewExceptionCriteriaAccessWithDefaults() *ExceptionCriteriaAccess` + +NewExceptionCriteriaAccessWithDefaults instantiates a new ExceptionCriteriaAccess 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 + +### GetType + +`func (o *ExceptionCriteriaAccess) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ExceptionCriteriaAccess) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ExceptionCriteriaAccess) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ExceptionCriteriaAccess) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ExceptionCriteriaAccess) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ExceptionCriteriaAccess) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ExceptionCriteriaAccess) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ExceptionCriteriaAccess) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ExceptionCriteriaAccess) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ExceptionCriteriaAccess) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ExceptionCriteriaAccess) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ExceptionCriteriaAccess) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetExisting + +`func (o *ExceptionCriteriaAccess) GetExisting() bool` + +GetExisting returns the Existing field if non-nil, zero value otherwise. + +### GetExistingOk + +`func (o *ExceptionCriteriaAccess) GetExistingOk() (*bool, bool)` + +GetExistingOk returns a tuple with the Existing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExisting + +`func (o *ExceptionCriteriaAccess) SetExisting(v bool)` + +SetExisting sets Existing field to given value. + +### HasExisting + +`func (o *ExceptionCriteriaAccess) HasExisting() bool` + +HasExisting returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ExceptionCriteriaCriteriaListInner.md b/docs/tools/sdk/go/Reference/V2024/Models/ExceptionCriteriaCriteriaListInner.md new file mode 100644 index 000000000..c0436880a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ExceptionCriteriaCriteriaListInner.md @@ -0,0 +1,142 @@ +--- +id: v2024-exception-criteria-criteria-list-inner +title: ExceptionCriteriaCriteriaListInner +pagination_label: ExceptionCriteriaCriteriaListInner +sidebar_label: ExceptionCriteriaCriteriaListInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExceptionCriteriaCriteriaListInner', 'V2024ExceptionCriteriaCriteriaListInner'] +slug: /tools/sdk/go/v2024/models/exception-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaCriteriaListInner', 'V2024ExceptionCriteriaCriteriaListInner'] +--- + +# ExceptionCriteriaCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **map[string]interface{}** | The type of object that is referenced | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] +**Existing** | Pointer to **bool** | Whether the subject identity already had that access or not | [optional] [default to false] + +## Methods + +### NewExceptionCriteriaCriteriaListInner + +`func NewExceptionCriteriaCriteriaListInner() *ExceptionCriteriaCriteriaListInner` + +NewExceptionCriteriaCriteriaListInner instantiates a new ExceptionCriteriaCriteriaListInner 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 + +### NewExceptionCriteriaCriteriaListInnerWithDefaults + +`func NewExceptionCriteriaCriteriaListInnerWithDefaults() *ExceptionCriteriaCriteriaListInner` + +NewExceptionCriteriaCriteriaListInnerWithDefaults instantiates a new ExceptionCriteriaCriteriaListInner 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 + +### GetType + +`func (o *ExceptionCriteriaCriteriaListInner) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ExceptionCriteriaCriteriaListInner) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ExceptionCriteriaCriteriaListInner) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + +### HasType + +`func (o *ExceptionCriteriaCriteriaListInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ExceptionCriteriaCriteriaListInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ExceptionCriteriaCriteriaListInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ExceptionCriteriaCriteriaListInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ExceptionCriteriaCriteriaListInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ExceptionCriteriaCriteriaListInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ExceptionCriteriaCriteriaListInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ExceptionCriteriaCriteriaListInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ExceptionCriteriaCriteriaListInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetExisting + +`func (o *ExceptionCriteriaCriteriaListInner) GetExisting() bool` + +GetExisting returns the Existing field if non-nil, zero value otherwise. + +### GetExistingOk + +`func (o *ExceptionCriteriaCriteriaListInner) GetExistingOk() (*bool, bool)` + +GetExistingOk returns a tuple with the Existing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExisting + +`func (o *ExceptionCriteriaCriteriaListInner) SetExisting(v bool)` + +SetExisting sets Existing field to given value. + +### HasExisting + +`func (o *ExceptionCriteriaCriteriaListInner) HasExisting() bool` + +HasExisting returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ExecutionStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/ExecutionStatus.md new file mode 100644 index 000000000..14e031442 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ExecutionStatus.md @@ -0,0 +1,25 @@ +--- +id: v2024-execution-status +title: ExecutionStatus +pagination_label: ExecutionStatus +sidebar_label: ExecutionStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExecutionStatus', 'V2024ExecutionStatus'] +slug: /tools/sdk/go/v2024/models/execution-status +tags: ['SDK', 'Software Development Kit', 'ExecutionStatus', 'V2024ExecutionStatus'] +--- + +# ExecutionStatus + +## Enum + + +* `EXECUTING` (value: `"EXECUTING"`) + +* `VERIFYING` (value: `"VERIFYING"`) + +* `TERMINATED` (value: `"TERMINATED"`) + +* `COMPLETED` (value: `"COMPLETED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ExpansionItem.md b/docs/tools/sdk/go/Reference/V2024/Models/ExpansionItem.md new file mode 100644 index 000000000..a0c7cf1f9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ExpansionItem.md @@ -0,0 +1,220 @@ +--- +id: v2024-expansion-item +title: ExpansionItem +pagination_label: ExpansionItem +sidebar_label: ExpansionItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExpansionItem', 'V2024ExpansionItem'] +slug: /tools/sdk/go/v2024/models/expansion-item +tags: ['SDK', 'Software Development Kit', 'ExpansionItem', 'V2024ExpansionItem'] +--- + +# ExpansionItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **string** | The ID of the account | [optional] +**Cause** | Pointer to **string** | Cause of the expansion item. | [optional] +**Name** | Pointer to **string** | The name of the item | [optional] +**AttributeRequest** | Pointer to [**AttributeRequest**](attribute-request) | | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] +**Id** | Pointer to **string** | ID of the expansion item | [optional] +**State** | Pointer to **string** | State of the expansion item | [optional] + +## Methods + +### NewExpansionItem + +`func NewExpansionItem() *ExpansionItem` + +NewExpansionItem instantiates a new ExpansionItem 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 + +### NewExpansionItemWithDefaults + +`func NewExpansionItemWithDefaults() *ExpansionItem` + +NewExpansionItemWithDefaults instantiates a new ExpansionItem 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 + +### GetAccountId + +`func (o *ExpansionItem) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *ExpansionItem) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *ExpansionItem) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *ExpansionItem) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetCause + +`func (o *ExpansionItem) GetCause() string` + +GetCause returns the Cause field if non-nil, zero value otherwise. + +### GetCauseOk + +`func (o *ExpansionItem) GetCauseOk() (*string, bool)` + +GetCauseOk returns a tuple with the Cause field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCause + +`func (o *ExpansionItem) SetCause(v string)` + +SetCause sets Cause field to given value. + +### HasCause + +`func (o *ExpansionItem) HasCause() bool` + +HasCause returns a boolean if a field has been set. + +### GetName + +`func (o *ExpansionItem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ExpansionItem) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ExpansionItem) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ExpansionItem) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAttributeRequest + +`func (o *ExpansionItem) GetAttributeRequest() AttributeRequest` + +GetAttributeRequest returns the AttributeRequest field if non-nil, zero value otherwise. + +### GetAttributeRequestOk + +`func (o *ExpansionItem) GetAttributeRequestOk() (*AttributeRequest, bool)` + +GetAttributeRequestOk returns a tuple with the AttributeRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeRequest + +`func (o *ExpansionItem) SetAttributeRequest(v AttributeRequest)` + +SetAttributeRequest sets AttributeRequest field to given value. + +### HasAttributeRequest + +`func (o *ExpansionItem) HasAttributeRequest() bool` + +HasAttributeRequest returns a boolean if a field has been set. + +### GetSource + +`func (o *ExpansionItem) GetSource() AccountSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *ExpansionItem) GetSourceOk() (*AccountSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *ExpansionItem) SetSource(v AccountSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *ExpansionItem) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetId + +`func (o *ExpansionItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ExpansionItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ExpansionItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ExpansionItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetState + +`func (o *ExpansionItem) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ExpansionItem) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ExpansionItem) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *ExpansionItem) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ExportFormDefinitionsByTenant200ResponseInner.md b/docs/tools/sdk/go/Reference/V2024/Models/ExportFormDefinitionsByTenant200ResponseInner.md new file mode 100644 index 000000000..3afd085af --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ExportFormDefinitionsByTenant200ResponseInner.md @@ -0,0 +1,116 @@ +--- +id: v2024-export-form-definitions-by-tenant200-response-inner +title: ExportFormDefinitionsByTenant200ResponseInner +pagination_label: ExportFormDefinitionsByTenant200ResponseInner +sidebar_label: ExportFormDefinitionsByTenant200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExportFormDefinitionsByTenant200ResponseInner', 'V2024ExportFormDefinitionsByTenant200ResponseInner'] +slug: /tools/sdk/go/v2024/models/export-form-definitions-by-tenant200-response-inner +tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenant200ResponseInner', 'V2024ExportFormDefinitionsByTenant200ResponseInner'] +--- + +# ExportFormDefinitionsByTenant200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Object** | Pointer to [**FormDefinitionResponse**](form-definition-response) | | [optional] +**Self** | Pointer to [**ExportFormDefinitionsByTenant200ResponseInnerSelf**](export-form-definitions-by-tenant200-response-inner-self) | | [optional] +**Version** | Pointer to **int32** | | [optional] + +## Methods + +### NewExportFormDefinitionsByTenant200ResponseInner + +`func NewExportFormDefinitionsByTenant200ResponseInner() *ExportFormDefinitionsByTenant200ResponseInner` + +NewExportFormDefinitionsByTenant200ResponseInner instantiates a new ExportFormDefinitionsByTenant200ResponseInner 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 + +### NewExportFormDefinitionsByTenant200ResponseInnerWithDefaults + +`func NewExportFormDefinitionsByTenant200ResponseInnerWithDefaults() *ExportFormDefinitionsByTenant200ResponseInner` + +NewExportFormDefinitionsByTenant200ResponseInnerWithDefaults instantiates a new ExportFormDefinitionsByTenant200ResponseInner 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 + +### GetObject + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetObject() FormDefinitionResponse` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetObjectOk() (*FormDefinitionResponse, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) SetObject(v FormDefinitionResponse)` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) HasObject() bool` + +HasObject returns a boolean if a field has been set. + +### GetSelf + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetSelf() ExportFormDefinitionsByTenant200ResponseInnerSelf` + +GetSelf returns the Self field if non-nil, zero value otherwise. + +### GetSelfOk + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetSelfOk() (*ExportFormDefinitionsByTenant200ResponseInnerSelf, bool)` + +GetSelfOk returns a tuple with the Self field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelf + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) SetSelf(v ExportFormDefinitionsByTenant200ResponseInnerSelf)` + +SetSelf sets Self field to given value. + +### HasSelf + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) HasSelf() bool` + +HasSelf returns a boolean if a field has been set. + +### GetVersion + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ExportFormDefinitionsByTenant200ResponseInnerSelf.md b/docs/tools/sdk/go/Reference/V2024/Models/ExportFormDefinitionsByTenant200ResponseInnerSelf.md new file mode 100644 index 000000000..52179b08e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ExportFormDefinitionsByTenant200ResponseInnerSelf.md @@ -0,0 +1,64 @@ +--- +id: v2024-export-form-definitions-by-tenant200-response-inner-self +title: ExportFormDefinitionsByTenant200ResponseInnerSelf +pagination_label: ExportFormDefinitionsByTenant200ResponseInnerSelf +sidebar_label: ExportFormDefinitionsByTenant200ResponseInnerSelf +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExportFormDefinitionsByTenant200ResponseInnerSelf', 'V2024ExportFormDefinitionsByTenant200ResponseInnerSelf'] +slug: /tools/sdk/go/v2024/models/export-form-definitions-by-tenant200-response-inner-self +tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenant200ResponseInnerSelf', 'V2024ExportFormDefinitionsByTenant200ResponseInnerSelf'] +--- + +# ExportFormDefinitionsByTenant200ResponseInnerSelf + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Object** | Pointer to [**FormDefinitionSelfImportExportDto**](form-definition-self-import-export-dto) | | [optional] + +## Methods + +### NewExportFormDefinitionsByTenant200ResponseInnerSelf + +`func NewExportFormDefinitionsByTenant200ResponseInnerSelf() *ExportFormDefinitionsByTenant200ResponseInnerSelf` + +NewExportFormDefinitionsByTenant200ResponseInnerSelf instantiates a new ExportFormDefinitionsByTenant200ResponseInnerSelf 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 + +### NewExportFormDefinitionsByTenant200ResponseInnerSelfWithDefaults + +`func NewExportFormDefinitionsByTenant200ResponseInnerSelfWithDefaults() *ExportFormDefinitionsByTenant200ResponseInnerSelf` + +NewExportFormDefinitionsByTenant200ResponseInnerSelfWithDefaults instantiates a new ExportFormDefinitionsByTenant200ResponseInnerSelf 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 + +### GetObject + +`func (o *ExportFormDefinitionsByTenant200ResponseInnerSelf) GetObject() FormDefinitionSelfImportExportDto` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *ExportFormDefinitionsByTenant200ResponseInnerSelf) GetObjectOk() (*FormDefinitionSelfImportExportDto, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *ExportFormDefinitionsByTenant200ResponseInnerSelf) SetObject(v FormDefinitionSelfImportExportDto)` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *ExportFormDefinitionsByTenant200ResponseInnerSelf) HasObject() bool` + +HasObject returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ExportOptions.md b/docs/tools/sdk/go/Reference/V2024/Models/ExportOptions.md new file mode 100644 index 000000000..55248fd3e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ExportOptions.md @@ -0,0 +1,116 @@ +--- +id: v2024-export-options +title: ExportOptions +pagination_label: ExportOptions +sidebar_label: ExportOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExportOptions', 'V2024ExportOptions'] +slug: /tools/sdk/go/v2024/models/export-options +tags: ['SDK', 'Software Development Kit', 'ExportOptions', 'V2024ExportOptions'] +--- + +# ExportOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExcludeTypes** | Pointer to **[]string** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]string** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] + +## Methods + +### NewExportOptions + +`func NewExportOptions() *ExportOptions` + +NewExportOptions instantiates a new ExportOptions 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 + +### NewExportOptionsWithDefaults + +`func NewExportOptionsWithDefaults() *ExportOptions` + +NewExportOptionsWithDefaults instantiates a new ExportOptions 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 + +### GetExcludeTypes + +`func (o *ExportOptions) GetExcludeTypes() []string` + +GetExcludeTypes returns the ExcludeTypes field if non-nil, zero value otherwise. + +### GetExcludeTypesOk + +`func (o *ExportOptions) GetExcludeTypesOk() (*[]string, bool)` + +GetExcludeTypesOk returns a tuple with the ExcludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeTypes + +`func (o *ExportOptions) SetExcludeTypes(v []string)` + +SetExcludeTypes sets ExcludeTypes field to given value. + +### HasExcludeTypes + +`func (o *ExportOptions) HasExcludeTypes() bool` + +HasExcludeTypes returns a boolean if a field has been set. + +### GetIncludeTypes + +`func (o *ExportOptions) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *ExportOptions) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *ExportOptions) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *ExportOptions) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *ExportOptions) GetObjectOptions() map[string]ObjectExportImportOptions` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *ExportOptions) GetObjectOptionsOk() (*map[string]ObjectExportImportOptions, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *ExportOptions) SetObjectOptions(v map[string]ObjectExportImportOptions)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *ExportOptions) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ExportOptions1.md b/docs/tools/sdk/go/Reference/V2024/Models/ExportOptions1.md new file mode 100644 index 000000000..06c929093 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ExportOptions1.md @@ -0,0 +1,116 @@ +--- +id: v2024-export-options1 +title: ExportOptions1 +pagination_label: ExportOptions1 +sidebar_label: ExportOptions1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExportOptions1', 'V2024ExportOptions1'] +slug: /tools/sdk/go/v2024/models/export-options1 +tags: ['SDK', 'Software Development Kit', 'ExportOptions1', 'V2024ExportOptions1'] +--- + +# ExportOptions1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExcludeTypes** | Pointer to **[]string** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]string** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] + +## Methods + +### NewExportOptions1 + +`func NewExportOptions1() *ExportOptions1` + +NewExportOptions1 instantiates a new ExportOptions1 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 + +### NewExportOptions1WithDefaults + +`func NewExportOptions1WithDefaults() *ExportOptions1` + +NewExportOptions1WithDefaults instantiates a new ExportOptions1 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 + +### GetExcludeTypes + +`func (o *ExportOptions1) GetExcludeTypes() []string` + +GetExcludeTypes returns the ExcludeTypes field if non-nil, zero value otherwise. + +### GetExcludeTypesOk + +`func (o *ExportOptions1) GetExcludeTypesOk() (*[]string, bool)` + +GetExcludeTypesOk returns a tuple with the ExcludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeTypes + +`func (o *ExportOptions1) SetExcludeTypes(v []string)` + +SetExcludeTypes sets ExcludeTypes field to given value. + +### HasExcludeTypes + +`func (o *ExportOptions1) HasExcludeTypes() bool` + +HasExcludeTypes returns a boolean if a field has been set. + +### GetIncludeTypes + +`func (o *ExportOptions1) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *ExportOptions1) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *ExportOptions1) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *ExportOptions1) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *ExportOptions1) GetObjectOptions() map[string]ObjectExportImportOptions` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *ExportOptions1) GetObjectOptionsOk() (*map[string]ObjectExportImportOptions, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *ExportOptions1) SetObjectOptions(v map[string]ObjectExportImportOptions)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *ExportOptions1) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ExportPayload.md b/docs/tools/sdk/go/Reference/V2024/Models/ExportPayload.md new file mode 100644 index 000000000..2e9b6ecfe --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ExportPayload.md @@ -0,0 +1,142 @@ +--- +id: v2024-export-payload +title: ExportPayload +pagination_label: ExportPayload +sidebar_label: ExportPayload +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExportPayload', 'V2024ExportPayload'] +slug: /tools/sdk/go/v2024/models/export-payload +tags: ['SDK', 'Software Development Kit', 'ExportPayload', 'V2024ExportPayload'] +--- + +# ExportPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Optional user defined description/name for export job. | [optional] +**ExcludeTypes** | Pointer to **[]string** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]string** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] + +## Methods + +### NewExportPayload + +`func NewExportPayload() *ExportPayload` + +NewExportPayload instantiates a new ExportPayload 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 + +### NewExportPayloadWithDefaults + +`func NewExportPayloadWithDefaults() *ExportPayload` + +NewExportPayloadWithDefaults instantiates a new ExportPayload 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 + +### GetDescription + +`func (o *ExportPayload) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ExportPayload) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ExportPayload) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ExportPayload) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetExcludeTypes + +`func (o *ExportPayload) GetExcludeTypes() []string` + +GetExcludeTypes returns the ExcludeTypes field if non-nil, zero value otherwise. + +### GetExcludeTypesOk + +`func (o *ExportPayload) GetExcludeTypesOk() (*[]string, bool)` + +GetExcludeTypesOk returns a tuple with the ExcludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeTypes + +`func (o *ExportPayload) SetExcludeTypes(v []string)` + +SetExcludeTypes sets ExcludeTypes field to given value. + +### HasExcludeTypes + +`func (o *ExportPayload) HasExcludeTypes() bool` + +HasExcludeTypes returns a boolean if a field has been set. + +### GetIncludeTypes + +`func (o *ExportPayload) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *ExportPayload) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *ExportPayload) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *ExportPayload) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *ExportPayload) GetObjectOptions() map[string]ObjectExportImportOptions` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *ExportPayload) GetObjectOptionsOk() (*map[string]ObjectExportImportOptions, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *ExportPayload) SetObjectOptions(v map[string]ObjectExportImportOptions)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *ExportPayload) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Expression.md b/docs/tools/sdk/go/Reference/V2024/Models/Expression.md new file mode 100644 index 000000000..926ca5df5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Expression.md @@ -0,0 +1,172 @@ +--- +id: v2024-expression +title: Expression +pagination_label: Expression +sidebar_label: Expression +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Expression', 'V2024Expression'] +slug: /tools/sdk/go/v2024/models/expression +tags: ['SDK', 'Software Development Kit', 'Expression', 'V2024Expression'] +--- + +# Expression + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **string** | Operator for the expression | [optional] +**Attribute** | Pointer to **NullableString** | Name for the attribute | [optional] +**Value** | Pointer to [**NullableValue**](value) | | [optional] +**Children** | Pointer to [**[]ExpressionChildrenInner**](expression-children-inner) | List of expressions | [optional] + +## Methods + +### NewExpression + +`func NewExpression() *Expression` + +NewExpression instantiates a new Expression 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 + +### NewExpressionWithDefaults + +`func NewExpressionWithDefaults() *Expression` + +NewExpressionWithDefaults instantiates a new Expression 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 + +### GetOperator + +`func (o *Expression) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *Expression) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *Expression) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *Expression) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetAttribute + +`func (o *Expression) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *Expression) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *Expression) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *Expression) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *Expression) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *Expression) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *Expression) GetValue() Value` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Expression) GetValueOk() (*Value, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Expression) SetValue(v Value)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Expression) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *Expression) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *Expression) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *Expression) GetChildren() []ExpressionChildrenInner` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *Expression) GetChildrenOk() (*[]ExpressionChildrenInner, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *Expression) SetChildren(v []ExpressionChildrenInner)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *Expression) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *Expression) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *Expression) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ExpressionChildrenInner.md b/docs/tools/sdk/go/Reference/V2024/Models/ExpressionChildrenInner.md new file mode 100644 index 000000000..e3eec5fa6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ExpressionChildrenInner.md @@ -0,0 +1,172 @@ +--- +id: v2024-expression-children-inner +title: ExpressionChildrenInner +pagination_label: ExpressionChildrenInner +sidebar_label: ExpressionChildrenInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExpressionChildrenInner', 'V2024ExpressionChildrenInner'] +slug: /tools/sdk/go/v2024/models/expression-children-inner +tags: ['SDK', 'Software Development Kit', 'ExpressionChildrenInner', 'V2024ExpressionChildrenInner'] +--- + +# ExpressionChildrenInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **string** | Operator for the expression | [optional] +**Attribute** | Pointer to **NullableString** | Name for the attribute | [optional] +**Value** | Pointer to [**NullableValue**](value) | | [optional] +**Children** | Pointer to **NullableString** | There cannot be anymore nested children. This will always be null. | [optional] + +## Methods + +### NewExpressionChildrenInner + +`func NewExpressionChildrenInner() *ExpressionChildrenInner` + +NewExpressionChildrenInner instantiates a new ExpressionChildrenInner 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 + +### NewExpressionChildrenInnerWithDefaults + +`func NewExpressionChildrenInnerWithDefaults() *ExpressionChildrenInner` + +NewExpressionChildrenInnerWithDefaults instantiates a new ExpressionChildrenInner 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 + +### GetOperator + +`func (o *ExpressionChildrenInner) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *ExpressionChildrenInner) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *ExpressionChildrenInner) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *ExpressionChildrenInner) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ExpressionChildrenInner) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ExpressionChildrenInner) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ExpressionChildrenInner) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ExpressionChildrenInner) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *ExpressionChildrenInner) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *ExpressionChildrenInner) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *ExpressionChildrenInner) GetValue() Value` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ExpressionChildrenInner) GetValueOk() (*Value, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ExpressionChildrenInner) SetValue(v Value)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ExpressionChildrenInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ExpressionChildrenInner) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ExpressionChildrenInner) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *ExpressionChildrenInner) GetChildren() string` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *ExpressionChildrenInner) GetChildrenOk() (*string, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *ExpressionChildrenInner) SetChildren(v string)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *ExpressionChildrenInner) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *ExpressionChildrenInner) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *ExpressionChildrenInner) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FeatureValueDto.md b/docs/tools/sdk/go/Reference/V2024/Models/FeatureValueDto.md new file mode 100644 index 000000000..df76a0a2e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FeatureValueDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-feature-value-dto +title: FeatureValueDto +pagination_label: FeatureValueDto +sidebar_label: FeatureValueDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FeatureValueDto', 'V2024FeatureValueDto'] +slug: /tools/sdk/go/v2024/models/feature-value-dto +tags: ['SDK', 'Software Development Kit', 'FeatureValueDto', 'V2024FeatureValueDto'] +--- + +# FeatureValueDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Feature** | Pointer to **string** | The type of feature | [optional] +**Numerator** | Pointer to **int32** | The number of identities that have access to the feature | [optional] +**Denominator** | Pointer to **int32** | The number of identities with the corresponding feature | [optional] + +## Methods + +### NewFeatureValueDto + +`func NewFeatureValueDto() *FeatureValueDto` + +NewFeatureValueDto instantiates a new FeatureValueDto 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 + +### NewFeatureValueDtoWithDefaults + +`func NewFeatureValueDtoWithDefaults() *FeatureValueDto` + +NewFeatureValueDtoWithDefaults instantiates a new FeatureValueDto 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 + +### GetFeature + +`func (o *FeatureValueDto) GetFeature() string` + +GetFeature returns the Feature field if non-nil, zero value otherwise. + +### GetFeatureOk + +`func (o *FeatureValueDto) GetFeatureOk() (*string, bool)` + +GetFeatureOk returns a tuple with the Feature field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeature + +`func (o *FeatureValueDto) SetFeature(v string)` + +SetFeature sets Feature field to given value. + +### HasFeature + +`func (o *FeatureValueDto) HasFeature() bool` + +HasFeature returns a boolean if a field has been set. + +### GetNumerator + +`func (o *FeatureValueDto) GetNumerator() int32` + +GetNumerator returns the Numerator field if non-nil, zero value otherwise. + +### GetNumeratorOk + +`func (o *FeatureValueDto) GetNumeratorOk() (*int32, bool)` + +GetNumeratorOk returns a tuple with the Numerator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumerator + +`func (o *FeatureValueDto) SetNumerator(v int32)` + +SetNumerator sets Numerator field to given value. + +### HasNumerator + +`func (o *FeatureValueDto) HasNumerator() bool` + +HasNumerator returns a boolean if a field has been set. + +### GetDenominator + +`func (o *FeatureValueDto) GetDenominator() int32` + +GetDenominator returns the Denominator field if non-nil, zero value otherwise. + +### GetDenominatorOk + +`func (o *FeatureValueDto) GetDenominatorOk() (*int32, bool)` + +GetDenominatorOk returns a tuple with the Denominator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenominator + +`func (o *FeatureValueDto) SetDenominator(v int32)` + +SetDenominator sets Denominator field to given value. + +### HasDenominator + +`func (o *FeatureValueDto) HasDenominator() bool` + +HasDenominator returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FederationProtocolDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/FederationProtocolDetails.md new file mode 100644 index 000000000..b7d4ea11e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FederationProtocolDetails.md @@ -0,0 +1,90 @@ +--- +id: v2024-federation-protocol-details +title: FederationProtocolDetails +pagination_label: FederationProtocolDetails +sidebar_label: FederationProtocolDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FederationProtocolDetails', 'V2024FederationProtocolDetails'] +slug: /tools/sdk/go/v2024/models/federation-protocol-details +tags: ['SDK', 'Software Development Kit', 'FederationProtocolDetails', 'V2024FederationProtocolDetails'] +--- + +# FederationProtocolDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | Pointer to **string** | Federation protocol role | [optional] +**EntityId** | Pointer to **string** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] + +## Methods + +### NewFederationProtocolDetails + +`func NewFederationProtocolDetails() *FederationProtocolDetails` + +NewFederationProtocolDetails instantiates a new FederationProtocolDetails 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 + +### NewFederationProtocolDetailsWithDefaults + +`func NewFederationProtocolDetailsWithDefaults() *FederationProtocolDetails` + +NewFederationProtocolDetailsWithDefaults instantiates a new FederationProtocolDetails 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 + +### GetRole + +`func (o *FederationProtocolDetails) GetRole() string` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *FederationProtocolDetails) GetRoleOk() (*string, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *FederationProtocolDetails) SetRole(v string)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *FederationProtocolDetails) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetEntityId + +`func (o *FederationProtocolDetails) GetEntityId() string` + +GetEntityId returns the EntityId field if non-nil, zero value otherwise. + +### GetEntityIdOk + +`func (o *FederationProtocolDetails) GetEntityIdOk() (*string, bool)` + +GetEntityIdOk returns a tuple with the EntityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntityId + +`func (o *FederationProtocolDetails) SetEntityId(v string)` + +SetEntityId sets EntityId field to given value. + +### HasEntityId + +`func (o *FederationProtocolDetails) HasEntityId() bool` + +HasEntityId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FieldDetailsDto.md b/docs/tools/sdk/go/Reference/V2024/Models/FieldDetailsDto.md new file mode 100644 index 000000000..5757055c9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FieldDetailsDto.md @@ -0,0 +1,194 @@ +--- +id: v2024-field-details-dto +title: FieldDetailsDto +pagination_label: FieldDetailsDto +sidebar_label: FieldDetailsDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FieldDetailsDto', 'V2024FieldDetailsDto'] +slug: /tools/sdk/go/v2024/models/field-details-dto +tags: ['SDK', 'Software Development Kit', 'FieldDetailsDto', 'V2024FieldDetailsDto'] +--- + +# FieldDetailsDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the attribute. | [optional] +**Transform** | Pointer to **map[string]interface{}** | The transform to apply to the field | [optional] [default to {}] +**Attributes** | Pointer to **map[string]interface{}** | Attributes required for the transform | [optional] +**IsRequired** | Pointer to **bool** | Flag indicating whether or not the attribute is required. | [optional] [readonly] [default to false] +**Type** | Pointer to **string** | The type of the attribute. | [optional] +**IsMultiValued** | Pointer to **bool** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to false] + +## Methods + +### NewFieldDetailsDto + +`func NewFieldDetailsDto() *FieldDetailsDto` + +NewFieldDetailsDto instantiates a new FieldDetailsDto 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 + +### NewFieldDetailsDtoWithDefaults + +`func NewFieldDetailsDtoWithDefaults() *FieldDetailsDto` + +NewFieldDetailsDtoWithDefaults instantiates a new FieldDetailsDto 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 + +### GetName + +`func (o *FieldDetailsDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FieldDetailsDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FieldDetailsDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FieldDetailsDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetTransform + +`func (o *FieldDetailsDto) GetTransform() map[string]interface{}` + +GetTransform returns the Transform field if non-nil, zero value otherwise. + +### GetTransformOk + +`func (o *FieldDetailsDto) GetTransformOk() (*map[string]interface{}, bool)` + +GetTransformOk returns a tuple with the Transform field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTransform + +`func (o *FieldDetailsDto) SetTransform(v map[string]interface{})` + +SetTransform sets Transform field to given value. + +### HasTransform + +`func (o *FieldDetailsDto) HasTransform() bool` + +HasTransform returns a boolean if a field has been set. + +### GetAttributes + +`func (o *FieldDetailsDto) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *FieldDetailsDto) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *FieldDetailsDto) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *FieldDetailsDto) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetIsRequired + +`func (o *FieldDetailsDto) GetIsRequired() bool` + +GetIsRequired returns the IsRequired field if non-nil, zero value otherwise. + +### GetIsRequiredOk + +`func (o *FieldDetailsDto) GetIsRequiredOk() (*bool, bool)` + +GetIsRequiredOk returns a tuple with the IsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsRequired + +`func (o *FieldDetailsDto) SetIsRequired(v bool)` + +SetIsRequired sets IsRequired field to given value. + +### HasIsRequired + +`func (o *FieldDetailsDto) HasIsRequired() bool` + +HasIsRequired returns a boolean if a field has been set. + +### GetType + +`func (o *FieldDetailsDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FieldDetailsDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FieldDetailsDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FieldDetailsDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetIsMultiValued + +`func (o *FieldDetailsDto) GetIsMultiValued() bool` + +GetIsMultiValued returns the IsMultiValued field if non-nil, zero value otherwise. + +### GetIsMultiValuedOk + +`func (o *FieldDetailsDto) GetIsMultiValuedOk() (*bool, bool)` + +GetIsMultiValuedOk returns a tuple with the IsMultiValued field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsMultiValued + +`func (o *FieldDetailsDto) SetIsMultiValued(v bool)` + +SetIsMultiValued sets IsMultiValued field to given value. + +### HasIsMultiValued + +`func (o *FieldDetailsDto) HasIsMultiValued() bool` + +HasIsMultiValued returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Filter.md b/docs/tools/sdk/go/Reference/V2024/Models/Filter.md new file mode 100644 index 000000000..22823da71 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Filter.md @@ -0,0 +1,142 @@ +--- +id: v2024-filter +title: Filter +pagination_label: Filter +sidebar_label: Filter +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Filter', 'V2024Filter'] +slug: /tools/sdk/go/v2024/models/filter +tags: ['SDK', 'Software Development Kit', 'Filter', 'V2024Filter'] +--- + +# Filter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**FilterType**](filter-type) | | [optional] +**Range** | Pointer to [**Range**](range) | | [optional] +**Terms** | Pointer to **[]string** | The terms to be filtered. | [optional] +**Exclude** | Pointer to **bool** | Indicates if the filter excludes results. | [optional] [default to false] + +## Methods + +### NewFilter + +`func NewFilter() *Filter` + +NewFilter instantiates a new Filter 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 + +### NewFilterWithDefaults + +`func NewFilterWithDefaults() *Filter` + +NewFilterWithDefaults instantiates a new Filter 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 + +### GetType + +`func (o *Filter) GetType() FilterType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Filter) GetTypeOk() (*FilterType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Filter) SetType(v FilterType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Filter) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRange + +`func (o *Filter) GetRange() Range` + +GetRange returns the Range field if non-nil, zero value otherwise. + +### GetRangeOk + +`func (o *Filter) GetRangeOk() (*Range, bool)` + +GetRangeOk returns a tuple with the Range field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRange + +`func (o *Filter) SetRange(v Range)` + +SetRange sets Range field to given value. + +### HasRange + +`func (o *Filter) HasRange() bool` + +HasRange returns a boolean if a field has been set. + +### GetTerms + +`func (o *Filter) GetTerms() []string` + +GetTerms returns the Terms field if non-nil, zero value otherwise. + +### GetTermsOk + +`func (o *Filter) GetTermsOk() (*[]string, bool)` + +GetTermsOk returns a tuple with the Terms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerms + +`func (o *Filter) SetTerms(v []string)` + +SetTerms sets Terms field to given value. + +### HasTerms + +`func (o *Filter) HasTerms() bool` + +HasTerms returns a boolean if a field has been set. + +### GetExclude + +`func (o *Filter) GetExclude() bool` + +GetExclude returns the Exclude field if non-nil, zero value otherwise. + +### GetExcludeOk + +`func (o *Filter) GetExcludeOk() (*bool, bool)` + +GetExcludeOk returns a tuple with the Exclude field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExclude + +`func (o *Filter) SetExclude(v bool)` + +SetExclude sets Exclude field to given value. + +### HasExclude + +`func (o *Filter) HasExclude() bool` + +HasExclude returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FilterAggregation.md b/docs/tools/sdk/go/Reference/V2024/Models/FilterAggregation.md new file mode 100644 index 000000000..b7e59b16f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FilterAggregation.md @@ -0,0 +1,127 @@ +--- +id: v2024-filter-aggregation +title: FilterAggregation +pagination_label: FilterAggregation +sidebar_label: FilterAggregation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FilterAggregation', 'V2024FilterAggregation'] +slug: /tools/sdk/go/v2024/models/filter-aggregation +tags: ['SDK', 'Software Development Kit', 'FilterAggregation', 'V2024FilterAggregation'] +--- + +# FilterAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the filter aggregate to be included in the result. | +**Type** | Pointer to [**SearchFilterType**](search-filter-type) | | [optional] [default to SEARCHFILTERTYPE_TERM] +**Field** | **string** | The search field to apply the filter to. Prefix the field name with '@' to reference a nested object. | +**Value** | **string** | The value to filter on. | + +## Methods + +### NewFilterAggregation + +`func NewFilterAggregation(name string, field string, value string, ) *FilterAggregation` + +NewFilterAggregation instantiates a new FilterAggregation 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 + +### NewFilterAggregationWithDefaults + +`func NewFilterAggregationWithDefaults() *FilterAggregation` + +NewFilterAggregationWithDefaults instantiates a new FilterAggregation 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 + +### GetName + +`func (o *FilterAggregation) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FilterAggregation) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FilterAggregation) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *FilterAggregation) GetType() SearchFilterType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FilterAggregation) GetTypeOk() (*SearchFilterType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FilterAggregation) SetType(v SearchFilterType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FilterAggregation) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetField + +`func (o *FilterAggregation) GetField() string` + +GetField returns the Field field if non-nil, zero value otherwise. + +### GetFieldOk + +`func (o *FilterAggregation) GetFieldOk() (*string, bool)` + +GetFieldOk returns a tuple with the Field field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetField + +`func (o *FilterAggregation) SetField(v string)` + +SetField sets Field field to given value. + + +### GetValue + +`func (o *FilterAggregation) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *FilterAggregation) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *FilterAggregation) SetValue(v string)` + +SetValue sets Value field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FilterType.md b/docs/tools/sdk/go/Reference/V2024/Models/FilterType.md new file mode 100644 index 000000000..0732f1d94 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FilterType.md @@ -0,0 +1,23 @@ +--- +id: v2024-filter-type +title: FilterType +pagination_label: FilterType +sidebar_label: FilterType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FilterType', 'V2024FilterType'] +slug: /tools/sdk/go/v2024/models/filter-type +tags: ['SDK', 'Software Development Kit', 'FilterType', 'V2024FilterType'] +--- + +# FilterType + +## Enum + + +* `EXISTS` (value: `"EXISTS"`) + +* `RANGE` (value: `"RANGE"`) + +* `TERMS` (value: `"TERMS"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormCondition.md b/docs/tools/sdk/go/Reference/V2024/Models/FormCondition.md new file mode 100644 index 000000000..e378f3945 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormCondition.md @@ -0,0 +1,116 @@ +--- +id: v2024-form-condition +title: FormCondition +pagination_label: FormCondition +sidebar_label: FormCondition +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormCondition', 'V2024FormCondition'] +slug: /tools/sdk/go/v2024/models/form-condition +tags: ['SDK', 'Software Development Kit', 'FormCondition', 'V2024FormCondition'] +--- + +# FormCondition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RuleOperator** | Pointer to **string** | ConditionRuleLogicalOperatorType value. AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr | [optional] +**Rules** | Pointer to [**[]ConditionRule**](condition-rule) | List of rules. | [optional] +**Effects** | Pointer to [**[]ConditionEffect**](condition-effect) | List of effects. | [optional] + +## Methods + +### NewFormCondition + +`func NewFormCondition() *FormCondition` + +NewFormCondition instantiates a new FormCondition 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 + +### NewFormConditionWithDefaults + +`func NewFormConditionWithDefaults() *FormCondition` + +NewFormConditionWithDefaults instantiates a new FormCondition 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 + +### GetRuleOperator + +`func (o *FormCondition) GetRuleOperator() string` + +GetRuleOperator returns the RuleOperator field if non-nil, zero value otherwise. + +### GetRuleOperatorOk + +`func (o *FormCondition) GetRuleOperatorOk() (*string, bool)` + +GetRuleOperatorOk returns a tuple with the RuleOperator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRuleOperator + +`func (o *FormCondition) SetRuleOperator(v string)` + +SetRuleOperator sets RuleOperator field to given value. + +### HasRuleOperator + +`func (o *FormCondition) HasRuleOperator() bool` + +HasRuleOperator returns a boolean if a field has been set. + +### GetRules + +`func (o *FormCondition) GetRules() []ConditionRule` + +GetRules returns the Rules field if non-nil, zero value otherwise. + +### GetRulesOk + +`func (o *FormCondition) GetRulesOk() (*[]ConditionRule, bool)` + +GetRulesOk returns a tuple with the Rules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRules + +`func (o *FormCondition) SetRules(v []ConditionRule)` + +SetRules sets Rules field to given value. + +### HasRules + +`func (o *FormCondition) HasRules() bool` + +HasRules returns a boolean if a field has been set. + +### GetEffects + +`func (o *FormCondition) GetEffects() []ConditionEffect` + +GetEffects returns the Effects field if non-nil, zero value otherwise. + +### GetEffectsOk + +`func (o *FormCondition) GetEffectsOk() (*[]ConditionEffect, bool)` + +GetEffectsOk returns a tuple with the Effects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEffects + +`func (o *FormCondition) SetEffects(v []ConditionEffect)` + +SetEffects sets Effects field to given value. + +### HasEffects + +`func (o *FormCondition) HasEffects() bool` + +HasEffects returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionDynamicSchemaRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionDynamicSchemaRequest.md new file mode 100644 index 000000000..735754223 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionDynamicSchemaRequest.md @@ -0,0 +1,168 @@ +--- +id: v2024-form-definition-dynamic-schema-request +title: FormDefinitionDynamicSchemaRequest +pagination_label: FormDefinitionDynamicSchemaRequest +sidebar_label: FormDefinitionDynamicSchemaRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionDynamicSchemaRequest', 'V2024FormDefinitionDynamicSchemaRequest'] +slug: /tools/sdk/go/v2024/models/form-definition-dynamic-schema-request +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaRequest', 'V2024FormDefinitionDynamicSchemaRequest'] +--- + +# FormDefinitionDynamicSchemaRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**FormDefinitionDynamicSchemaRequestAttributes**](form-definition-dynamic-schema-request-attributes) | | [optional] +**Description** | Pointer to **string** | Description is the form definition dynamic schema description text | [optional] +**Id** | Pointer to **string** | ID is a unique identifier | [optional] +**Type** | Pointer to **string** | Type is the form definition dynamic schema type | [optional] +**VersionNumber** | Pointer to **int64** | VersionNumber is the form definition dynamic schema version number | [optional] + +## Methods + +### NewFormDefinitionDynamicSchemaRequest + +`func NewFormDefinitionDynamicSchemaRequest() *FormDefinitionDynamicSchemaRequest` + +NewFormDefinitionDynamicSchemaRequest instantiates a new FormDefinitionDynamicSchemaRequest 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 + +### NewFormDefinitionDynamicSchemaRequestWithDefaults + +`func NewFormDefinitionDynamicSchemaRequestWithDefaults() *FormDefinitionDynamicSchemaRequest` + +NewFormDefinitionDynamicSchemaRequestWithDefaults instantiates a new FormDefinitionDynamicSchemaRequest 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 + +### GetAttributes + +`func (o *FormDefinitionDynamicSchemaRequest) GetAttributes() FormDefinitionDynamicSchemaRequestAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *FormDefinitionDynamicSchemaRequest) GetAttributesOk() (*FormDefinitionDynamicSchemaRequestAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *FormDefinitionDynamicSchemaRequest) SetAttributes(v FormDefinitionDynamicSchemaRequestAttributes)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *FormDefinitionDynamicSchemaRequest) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetDescription + +`func (o *FormDefinitionDynamicSchemaRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *FormDefinitionDynamicSchemaRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *FormDefinitionDynamicSchemaRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *FormDefinitionDynamicSchemaRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetId + +`func (o *FormDefinitionDynamicSchemaRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormDefinitionDynamicSchemaRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormDefinitionDynamicSchemaRequest) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormDefinitionDynamicSchemaRequest) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *FormDefinitionDynamicSchemaRequest) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormDefinitionDynamicSchemaRequest) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormDefinitionDynamicSchemaRequest) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormDefinitionDynamicSchemaRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetVersionNumber + +`func (o *FormDefinitionDynamicSchemaRequest) GetVersionNumber() int64` + +GetVersionNumber returns the VersionNumber field if non-nil, zero value otherwise. + +### GetVersionNumberOk + +`func (o *FormDefinitionDynamicSchemaRequest) GetVersionNumberOk() (*int64, bool)` + +GetVersionNumberOk returns a tuple with the VersionNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionNumber + +`func (o *FormDefinitionDynamicSchemaRequest) SetVersionNumber(v int64)` + +SetVersionNumber sets VersionNumber field to given value. + +### HasVersionNumber + +`func (o *FormDefinitionDynamicSchemaRequest) HasVersionNumber() bool` + +HasVersionNumber returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionDynamicSchemaRequestAttributes.md b/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionDynamicSchemaRequestAttributes.md new file mode 100644 index 000000000..3d25117c1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionDynamicSchemaRequestAttributes.md @@ -0,0 +1,64 @@ +--- +id: v2024-form-definition-dynamic-schema-request-attributes +title: FormDefinitionDynamicSchemaRequestAttributes +pagination_label: FormDefinitionDynamicSchemaRequestAttributes +sidebar_label: FormDefinitionDynamicSchemaRequestAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionDynamicSchemaRequestAttributes', 'V2024FormDefinitionDynamicSchemaRequestAttributes'] +slug: /tools/sdk/go/v2024/models/form-definition-dynamic-schema-request-attributes +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaRequestAttributes', 'V2024FormDefinitionDynamicSchemaRequestAttributes'] +--- + +# FormDefinitionDynamicSchemaRequestAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FormDefinitionId** | Pointer to **string** | FormDefinitionID is a unique guid identifying this form definition | [optional] + +## Methods + +### NewFormDefinitionDynamicSchemaRequestAttributes + +`func NewFormDefinitionDynamicSchemaRequestAttributes() *FormDefinitionDynamicSchemaRequestAttributes` + +NewFormDefinitionDynamicSchemaRequestAttributes instantiates a new FormDefinitionDynamicSchemaRequestAttributes 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 + +### NewFormDefinitionDynamicSchemaRequestAttributesWithDefaults + +`func NewFormDefinitionDynamicSchemaRequestAttributesWithDefaults() *FormDefinitionDynamicSchemaRequestAttributes` + +NewFormDefinitionDynamicSchemaRequestAttributesWithDefaults instantiates a new FormDefinitionDynamicSchemaRequestAttributes 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 + +### GetFormDefinitionId + +`func (o *FormDefinitionDynamicSchemaRequestAttributes) GetFormDefinitionId() string` + +GetFormDefinitionId returns the FormDefinitionId field if non-nil, zero value otherwise. + +### GetFormDefinitionIdOk + +`func (o *FormDefinitionDynamicSchemaRequestAttributes) GetFormDefinitionIdOk() (*string, bool)` + +GetFormDefinitionIdOk returns a tuple with the FormDefinitionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormDefinitionId + +`func (o *FormDefinitionDynamicSchemaRequestAttributes) SetFormDefinitionId(v string)` + +SetFormDefinitionId sets FormDefinitionId field to given value. + +### HasFormDefinitionId + +`func (o *FormDefinitionDynamicSchemaRequestAttributes) HasFormDefinitionId() bool` + +HasFormDefinitionId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionDynamicSchemaResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionDynamicSchemaResponse.md new file mode 100644 index 000000000..afe42cf87 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionDynamicSchemaResponse.md @@ -0,0 +1,64 @@ +--- +id: v2024-form-definition-dynamic-schema-response +title: FormDefinitionDynamicSchemaResponse +pagination_label: FormDefinitionDynamicSchemaResponse +sidebar_label: FormDefinitionDynamicSchemaResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionDynamicSchemaResponse', 'V2024FormDefinitionDynamicSchemaResponse'] +slug: /tools/sdk/go/v2024/models/form-definition-dynamic-schema-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaResponse', 'V2024FormDefinitionDynamicSchemaResponse'] +--- + +# FormDefinitionDynamicSchemaResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OutputSchema** | Pointer to **map[string]map[string]interface{}** | OutputSchema holds a JSON schema generated dynamically | [optional] + +## Methods + +### NewFormDefinitionDynamicSchemaResponse + +`func NewFormDefinitionDynamicSchemaResponse() *FormDefinitionDynamicSchemaResponse` + +NewFormDefinitionDynamicSchemaResponse instantiates a new FormDefinitionDynamicSchemaResponse 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 + +### NewFormDefinitionDynamicSchemaResponseWithDefaults + +`func NewFormDefinitionDynamicSchemaResponseWithDefaults() *FormDefinitionDynamicSchemaResponse` + +NewFormDefinitionDynamicSchemaResponseWithDefaults instantiates a new FormDefinitionDynamicSchemaResponse 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 + +### GetOutputSchema + +`func (o *FormDefinitionDynamicSchemaResponse) GetOutputSchema() map[string]map[string]interface{}` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *FormDefinitionDynamicSchemaResponse) GetOutputSchemaOk() (*map[string]map[string]interface{}, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *FormDefinitionDynamicSchemaResponse) SetOutputSchema(v map[string]map[string]interface{})` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *FormDefinitionDynamicSchemaResponse) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionFileUploadResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionFileUploadResponse.md new file mode 100644 index 000000000..ca4e8ff66 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionFileUploadResponse.md @@ -0,0 +1,116 @@ +--- +id: v2024-form-definition-file-upload-response +title: FormDefinitionFileUploadResponse +pagination_label: FormDefinitionFileUploadResponse +sidebar_label: FormDefinitionFileUploadResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionFileUploadResponse', 'V2024FormDefinitionFileUploadResponse'] +slug: /tools/sdk/go/v2024/models/form-definition-file-upload-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionFileUploadResponse', 'V2024FormDefinitionFileUploadResponse'] +--- + +# FormDefinitionFileUploadResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **string** | Created is the date the file was uploaded | [optional] +**FileId** | Pointer to **string** | fileId is a unique ULID that serves as an identifier for the form definition file | [optional] +**FormDefinitionId** | Pointer to **string** | FormDefinitionID is a unique guid identifying this form definition | [optional] + +## Methods + +### NewFormDefinitionFileUploadResponse + +`func NewFormDefinitionFileUploadResponse() *FormDefinitionFileUploadResponse` + +NewFormDefinitionFileUploadResponse instantiates a new FormDefinitionFileUploadResponse 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 + +### NewFormDefinitionFileUploadResponseWithDefaults + +`func NewFormDefinitionFileUploadResponseWithDefaults() *FormDefinitionFileUploadResponse` + +NewFormDefinitionFileUploadResponseWithDefaults instantiates a new FormDefinitionFileUploadResponse 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 + +### GetCreated + +`func (o *FormDefinitionFileUploadResponse) GetCreated() string` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *FormDefinitionFileUploadResponse) GetCreatedOk() (*string, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *FormDefinitionFileUploadResponse) SetCreated(v string)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *FormDefinitionFileUploadResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetFileId + +`func (o *FormDefinitionFileUploadResponse) GetFileId() string` + +GetFileId returns the FileId field if non-nil, zero value otherwise. + +### GetFileIdOk + +`func (o *FormDefinitionFileUploadResponse) GetFileIdOk() (*string, bool)` + +GetFileIdOk returns a tuple with the FileId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileId + +`func (o *FormDefinitionFileUploadResponse) SetFileId(v string)` + +SetFileId sets FileId field to given value. + +### HasFileId + +`func (o *FormDefinitionFileUploadResponse) HasFileId() bool` + +HasFileId returns a boolean if a field has been set. + +### GetFormDefinitionId + +`func (o *FormDefinitionFileUploadResponse) GetFormDefinitionId() string` + +GetFormDefinitionId returns the FormDefinitionId field if non-nil, zero value otherwise. + +### GetFormDefinitionIdOk + +`func (o *FormDefinitionFileUploadResponse) GetFormDefinitionIdOk() (*string, bool)` + +GetFormDefinitionIdOk returns a tuple with the FormDefinitionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormDefinitionId + +`func (o *FormDefinitionFileUploadResponse) SetFormDefinitionId(v string)` + +SetFormDefinitionId sets FormDefinitionId field to given value. + +### HasFormDefinitionId + +`func (o *FormDefinitionFileUploadResponse) HasFormDefinitionId() bool` + +HasFormDefinitionId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionInput.md b/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionInput.md new file mode 100644 index 000000000..cd0ae65d5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionInput.md @@ -0,0 +1,142 @@ +--- +id: v2024-form-definition-input +title: FormDefinitionInput +pagination_label: FormDefinitionInput +sidebar_label: FormDefinitionInput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionInput', 'V2024FormDefinitionInput'] +slug: /tools/sdk/go/v2024/models/form-definition-input +tags: ['SDK', 'Software Development Kit', 'FormDefinitionInput', 'V2024FormDefinitionInput'] +--- + +# FormDefinitionInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the form input. | [optional] +**Type** | Pointer to **string** | FormDefinitionInputType value. STRING FormDefinitionInputTypeString | [optional] +**Label** | Pointer to **string** | Name for the form input. | [optional] +**Description** | Pointer to **string** | Form input's description. | [optional] + +## Methods + +### NewFormDefinitionInput + +`func NewFormDefinitionInput() *FormDefinitionInput` + +NewFormDefinitionInput instantiates a new FormDefinitionInput 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 + +### NewFormDefinitionInputWithDefaults + +`func NewFormDefinitionInputWithDefaults() *FormDefinitionInput` + +NewFormDefinitionInputWithDefaults instantiates a new FormDefinitionInput 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 + +### GetId + +`func (o *FormDefinitionInput) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormDefinitionInput) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormDefinitionInput) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormDefinitionInput) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *FormDefinitionInput) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormDefinitionInput) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormDefinitionInput) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormDefinitionInput) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetLabel + +`func (o *FormDefinitionInput) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *FormDefinitionInput) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *FormDefinitionInput) SetLabel(v string)` + +SetLabel sets Label field to given value. + +### HasLabel + +`func (o *FormDefinitionInput) HasLabel() bool` + +HasLabel returns a boolean if a field has been set. + +### GetDescription + +`func (o *FormDefinitionInput) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *FormDefinitionInput) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *FormDefinitionInput) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *FormDefinitionInput) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionResponse.md new file mode 100644 index 000000000..bcd932c78 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionResponse.md @@ -0,0 +1,298 @@ +--- +id: v2024-form-definition-response +title: FormDefinitionResponse +pagination_label: FormDefinitionResponse +sidebar_label: FormDefinitionResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionResponse', 'V2024FormDefinitionResponse'] +slug: /tools/sdk/go/v2024/models/form-definition-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionResponse', 'V2024FormDefinitionResponse'] +--- + +# FormDefinitionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique guid identifying the form definition. | [optional] +**Name** | Pointer to **string** | Name of the form definition. | [optional] +**Description** | Pointer to **string** | Form definition's description. | [optional] +**Owner** | Pointer to [**FormOwner**](form-owner) | | [optional] +**UsedBy** | Pointer to [**[]FormUsedBy**](form-used-by) | List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. | [optional] +**FormInput** | Pointer to [**[]FormDefinitionInput**](form-definition-input) | List of form inputs required to create a form-instance object. | [optional] +**FormElements** | Pointer to [**[]FormElement**](form-element) | List of nested form elements. | [optional] +**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | Conditional logic that can dynamically modify the form as the recipient is interacting with it. | [optional] +**Created** | Pointer to **SailPointTime** | Created is the date the form definition was created | [optional] +**Modified** | Pointer to **SailPointTime** | Modified is the last date the form definition was modified | [optional] + +## Methods + +### NewFormDefinitionResponse + +`func NewFormDefinitionResponse() *FormDefinitionResponse` + +NewFormDefinitionResponse instantiates a new FormDefinitionResponse 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 + +### NewFormDefinitionResponseWithDefaults + +`func NewFormDefinitionResponseWithDefaults() *FormDefinitionResponse` + +NewFormDefinitionResponseWithDefaults instantiates a new FormDefinitionResponse 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 + +### GetId + +`func (o *FormDefinitionResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormDefinitionResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormDefinitionResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormDefinitionResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FormDefinitionResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormDefinitionResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormDefinitionResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormDefinitionResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *FormDefinitionResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *FormDefinitionResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *FormDefinitionResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *FormDefinitionResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *FormDefinitionResponse) GetOwner() FormOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *FormDefinitionResponse) GetOwnerOk() (*FormOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *FormDefinitionResponse) SetOwner(v FormOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *FormDefinitionResponse) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetUsedBy + +`func (o *FormDefinitionResponse) GetUsedBy() []FormUsedBy` + +GetUsedBy returns the UsedBy field if non-nil, zero value otherwise. + +### GetUsedByOk + +`func (o *FormDefinitionResponse) GetUsedByOk() (*[]FormUsedBy, bool)` + +GetUsedByOk returns a tuple with the UsedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsedBy + +`func (o *FormDefinitionResponse) SetUsedBy(v []FormUsedBy)` + +SetUsedBy sets UsedBy field to given value. + +### HasUsedBy + +`func (o *FormDefinitionResponse) HasUsedBy() bool` + +HasUsedBy returns a boolean if a field has been set. + +### GetFormInput + +`func (o *FormDefinitionResponse) GetFormInput() []FormDefinitionInput` + +GetFormInput returns the FormInput field if non-nil, zero value otherwise. + +### GetFormInputOk + +`func (o *FormDefinitionResponse) GetFormInputOk() (*[]FormDefinitionInput, bool)` + +GetFormInputOk returns a tuple with the FormInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormInput + +`func (o *FormDefinitionResponse) SetFormInput(v []FormDefinitionInput)` + +SetFormInput sets FormInput field to given value. + +### HasFormInput + +`func (o *FormDefinitionResponse) HasFormInput() bool` + +HasFormInput returns a boolean if a field has been set. + +### GetFormElements + +`func (o *FormDefinitionResponse) GetFormElements() []FormElement` + +GetFormElements returns the FormElements field if non-nil, zero value otherwise. + +### GetFormElementsOk + +`func (o *FormDefinitionResponse) GetFormElementsOk() (*[]FormElement, bool)` + +GetFormElementsOk returns a tuple with the FormElements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormElements + +`func (o *FormDefinitionResponse) SetFormElements(v []FormElement)` + +SetFormElements sets FormElements field to given value. + +### HasFormElements + +`func (o *FormDefinitionResponse) HasFormElements() bool` + +HasFormElements returns a boolean if a field has been set. + +### GetFormConditions + +`func (o *FormDefinitionResponse) GetFormConditions() []FormCondition` + +GetFormConditions returns the FormConditions field if non-nil, zero value otherwise. + +### GetFormConditionsOk + +`func (o *FormDefinitionResponse) GetFormConditionsOk() (*[]FormCondition, bool)` + +GetFormConditionsOk returns a tuple with the FormConditions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormConditions + +`func (o *FormDefinitionResponse) SetFormConditions(v []FormCondition)` + +SetFormConditions sets FormConditions field to given value. + +### HasFormConditions + +`func (o *FormDefinitionResponse) HasFormConditions() bool` + +HasFormConditions returns a boolean if a field has been set. + +### GetCreated + +`func (o *FormDefinitionResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *FormDefinitionResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *FormDefinitionResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *FormDefinitionResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *FormDefinitionResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *FormDefinitionResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *FormDefinitionResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *FormDefinitionResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionSelfImportExportDto.md b/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionSelfImportExportDto.md new file mode 100644 index 000000000..c3d29aad3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormDefinitionSelfImportExportDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-form-definition-self-import-export-dto +title: FormDefinitionSelfImportExportDto +pagination_label: FormDefinitionSelfImportExportDto +sidebar_label: FormDefinitionSelfImportExportDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionSelfImportExportDto', 'V2024FormDefinitionSelfImportExportDto'] +slug: /tools/sdk/go/v2024/models/form-definition-self-import-export-dto +tags: ['SDK', 'Software Development Kit', 'FormDefinitionSelfImportExportDto', 'V2024FormDefinitionSelfImportExportDto'] +--- + +# FormDefinitionSelfImportExportDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Imported/exported object's DTO type. | [optional] +**Id** | Pointer to **string** | Imported/exported object's ID. | [optional] +**Name** | Pointer to **string** | Imported/exported object's display name. | [optional] + +## Methods + +### NewFormDefinitionSelfImportExportDto + +`func NewFormDefinitionSelfImportExportDto() *FormDefinitionSelfImportExportDto` + +NewFormDefinitionSelfImportExportDto instantiates a new FormDefinitionSelfImportExportDto 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 + +### NewFormDefinitionSelfImportExportDtoWithDefaults + +`func NewFormDefinitionSelfImportExportDtoWithDefaults() *FormDefinitionSelfImportExportDto` + +NewFormDefinitionSelfImportExportDtoWithDefaults instantiates a new FormDefinitionSelfImportExportDto 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 + +### GetType + +`func (o *FormDefinitionSelfImportExportDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormDefinitionSelfImportExportDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormDefinitionSelfImportExportDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormDefinitionSelfImportExportDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *FormDefinitionSelfImportExportDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormDefinitionSelfImportExportDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormDefinitionSelfImportExportDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormDefinitionSelfImportExportDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FormDefinitionSelfImportExportDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormDefinitionSelfImportExportDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormDefinitionSelfImportExportDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormDefinitionSelfImportExportDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/FormDetails.md new file mode 100644 index 000000000..d686e4527 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormDetails.md @@ -0,0 +1,234 @@ +--- +id: v2024-form-details +title: FormDetails +pagination_label: FormDetails +sidebar_label: FormDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDetails', 'V2024FormDetails'] +slug: /tools/sdk/go/v2024/models/form-details +tags: ['SDK', 'Software Development Kit', 'FormDetails', 'V2024FormDetails'] +--- + +# FormDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | ID of the form | [optional] +**Name** | Pointer to **NullableString** | Name of the form | [optional] +**Title** | Pointer to **NullableString** | The form title | [optional] +**Subtitle** | Pointer to **NullableString** | The form subtitle. | [optional] +**TargetUser** | Pointer to **string** | The name of the user that should be shown this form | [optional] +**Sections** | Pointer to [**[]SectionDetails**](section-details) | Sections of the form | [optional] + +## Methods + +### NewFormDetails + +`func NewFormDetails() *FormDetails` + +NewFormDetails instantiates a new FormDetails 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 + +### NewFormDetailsWithDefaults + +`func NewFormDetailsWithDefaults() *FormDetails` + +NewFormDetailsWithDefaults instantiates a new FormDetails 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 + +### GetId + +`func (o *FormDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *FormDetails) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *FormDetails) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *FormDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *FormDetails) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *FormDetails) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetTitle + +`func (o *FormDetails) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *FormDetails) GetTitleOk() (*string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTitle + +`func (o *FormDetails) SetTitle(v string)` + +SetTitle sets Title field to given value. + +### HasTitle + +`func (o *FormDetails) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### SetTitleNil + +`func (o *FormDetails) SetTitleNil(b bool)` + + SetTitleNil sets the value for Title to be an explicit nil + +### UnsetTitle +`func (o *FormDetails) UnsetTitle()` + +UnsetTitle ensures that no value is present for Title, not even an explicit nil +### GetSubtitle + +`func (o *FormDetails) GetSubtitle() string` + +GetSubtitle returns the Subtitle field if non-nil, zero value otherwise. + +### GetSubtitleOk + +`func (o *FormDetails) GetSubtitleOk() (*string, bool)` + +GetSubtitleOk returns a tuple with the Subtitle field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubtitle + +`func (o *FormDetails) SetSubtitle(v string)` + +SetSubtitle sets Subtitle field to given value. + +### HasSubtitle + +`func (o *FormDetails) HasSubtitle() bool` + +HasSubtitle returns a boolean if a field has been set. + +### SetSubtitleNil + +`func (o *FormDetails) SetSubtitleNil(b bool)` + + SetSubtitleNil sets the value for Subtitle to be an explicit nil + +### UnsetSubtitle +`func (o *FormDetails) UnsetSubtitle()` + +UnsetSubtitle ensures that no value is present for Subtitle, not even an explicit nil +### GetTargetUser + +`func (o *FormDetails) GetTargetUser() string` + +GetTargetUser returns the TargetUser field if non-nil, zero value otherwise. + +### GetTargetUserOk + +`func (o *FormDetails) GetTargetUserOk() (*string, bool)` + +GetTargetUserOk returns a tuple with the TargetUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetUser + +`func (o *FormDetails) SetTargetUser(v string)` + +SetTargetUser sets TargetUser field to given value. + +### HasTargetUser + +`func (o *FormDetails) HasTargetUser() bool` + +HasTargetUser returns a boolean if a field has been set. + +### GetSections + +`func (o *FormDetails) GetSections() []SectionDetails` + +GetSections returns the Sections field if non-nil, zero value otherwise. + +### GetSectionsOk + +`func (o *FormDetails) GetSectionsOk() (*[]SectionDetails, bool)` + +GetSectionsOk returns a tuple with the Sections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSections + +`func (o *FormDetails) SetSections(v []SectionDetails)` + +SetSections sets Sections field to given value. + +### HasSections + +`func (o *FormDetails) HasSections() bool` + +HasSections returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormElement.md b/docs/tools/sdk/go/Reference/V2024/Models/FormElement.md new file mode 100644 index 000000000..602718ad8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormElement.md @@ -0,0 +1,178 @@ +--- +id: v2024-form-element +title: FormElement +pagination_label: FormElement +sidebar_label: FormElement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElement', 'V2024FormElement'] +slug: /tools/sdk/go/v2024/models/form-element +tags: ['SDK', 'Software Development Kit', 'FormElement', 'V2024FormElement'] +--- + +# FormElement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Form element identifier. | [optional] +**ElementType** | Pointer to **string** | FormElementType value. TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMN_SET FormElementTypeColumns IMAGE FormElementTypeImage DESCRIPTION FormElementTypeDescription | [optional] +**Config** | Pointer to **map[string]interface{}** | Config object. | [optional] +**Key** | Pointer to **string** | Technical key. | [optional] +**Validations** | Pointer to [**[]FormElementValidationsSet**](form-element-validations-set) | | [optional] + +## Methods + +### NewFormElement + +`func NewFormElement() *FormElement` + +NewFormElement instantiates a new FormElement 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 + +### NewFormElementWithDefaults + +`func NewFormElementWithDefaults() *FormElement` + +NewFormElementWithDefaults instantiates a new FormElement 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 + +### GetId + +`func (o *FormElement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormElement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormElement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormElement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetElementType + +`func (o *FormElement) GetElementType() string` + +GetElementType returns the ElementType field if non-nil, zero value otherwise. + +### GetElementTypeOk + +`func (o *FormElement) GetElementTypeOk() (*string, bool)` + +GetElementTypeOk returns a tuple with the ElementType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElementType + +`func (o *FormElement) SetElementType(v string)` + +SetElementType sets ElementType field to given value. + +### HasElementType + +`func (o *FormElement) HasElementType() bool` + +HasElementType returns a boolean if a field has been set. + +### GetConfig + +`func (o *FormElement) GetConfig() map[string]interface{}` + +GetConfig returns the Config field if non-nil, zero value otherwise. + +### GetConfigOk + +`func (o *FormElement) GetConfigOk() (*map[string]interface{}, bool)` + +GetConfigOk returns a tuple with the Config field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfig + +`func (o *FormElement) SetConfig(v map[string]interface{})` + +SetConfig sets Config field to given value. + +### HasConfig + +`func (o *FormElement) HasConfig() bool` + +HasConfig returns a boolean if a field has been set. + +### GetKey + +`func (o *FormElement) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *FormElement) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *FormElement) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *FormElement) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetValidations + +`func (o *FormElement) GetValidations() []FormElementValidationsSet` + +GetValidations returns the Validations field if non-nil, zero value otherwise. + +### GetValidationsOk + +`func (o *FormElement) GetValidationsOk() (*[]FormElementValidationsSet, bool)` + +GetValidationsOk returns a tuple with the Validations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValidations + +`func (o *FormElement) SetValidations(v []FormElementValidationsSet)` + +SetValidations sets Validations field to given value. + +### HasValidations + +`func (o *FormElement) HasValidations() bool` + +HasValidations returns a boolean if a field has been set. + +### SetValidationsNil + +`func (o *FormElement) SetValidationsNil(b bool)` + + SetValidationsNil sets the value for Validations to be an explicit nil + +### UnsetValidations +`func (o *FormElement) UnsetValidations()` + +UnsetValidations ensures that no value is present for Validations, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormElementDataSourceConfigOptions.md b/docs/tools/sdk/go/Reference/V2024/Models/FormElementDataSourceConfigOptions.md new file mode 100644 index 000000000..d38de2dc8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormElementDataSourceConfigOptions.md @@ -0,0 +1,116 @@ +--- +id: v2024-form-element-data-source-config-options +title: FormElementDataSourceConfigOptions +pagination_label: FormElementDataSourceConfigOptions +sidebar_label: FormElementDataSourceConfigOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElementDataSourceConfigOptions', 'V2024FormElementDataSourceConfigOptions'] +slug: /tools/sdk/go/v2024/models/form-element-data-source-config-options +tags: ['SDK', 'Software Development Kit', 'FormElementDataSourceConfigOptions', 'V2024FormElementDataSourceConfigOptions'] +--- + +# FormElementDataSourceConfigOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Label** | Pointer to **string** | Label is the main label to display to the user when selecting this option | [optional] +**SubLabel** | Pointer to **string** | SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option | [optional] +**Value** | Pointer to **string** | Value is the value to save as an entry when the user selects this option | [optional] + +## Methods + +### NewFormElementDataSourceConfigOptions + +`func NewFormElementDataSourceConfigOptions() *FormElementDataSourceConfigOptions` + +NewFormElementDataSourceConfigOptions instantiates a new FormElementDataSourceConfigOptions 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 + +### NewFormElementDataSourceConfigOptionsWithDefaults + +`func NewFormElementDataSourceConfigOptionsWithDefaults() *FormElementDataSourceConfigOptions` + +NewFormElementDataSourceConfigOptionsWithDefaults instantiates a new FormElementDataSourceConfigOptions 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 + +### GetLabel + +`func (o *FormElementDataSourceConfigOptions) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *FormElementDataSourceConfigOptions) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *FormElementDataSourceConfigOptions) SetLabel(v string)` + +SetLabel sets Label field to given value. + +### HasLabel + +`func (o *FormElementDataSourceConfigOptions) HasLabel() bool` + +HasLabel returns a boolean if a field has been set. + +### GetSubLabel + +`func (o *FormElementDataSourceConfigOptions) GetSubLabel() string` + +GetSubLabel returns the SubLabel field if non-nil, zero value otherwise. + +### GetSubLabelOk + +`func (o *FormElementDataSourceConfigOptions) GetSubLabelOk() (*string, bool)` + +GetSubLabelOk returns a tuple with the SubLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubLabel + +`func (o *FormElementDataSourceConfigOptions) SetSubLabel(v string)` + +SetSubLabel sets SubLabel field to given value. + +### HasSubLabel + +`func (o *FormElementDataSourceConfigOptions) HasSubLabel() bool` + +HasSubLabel returns a boolean if a field has been set. + +### GetValue + +`func (o *FormElementDataSourceConfigOptions) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *FormElementDataSourceConfigOptions) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *FormElementDataSourceConfigOptions) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *FormElementDataSourceConfigOptions) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormElementDynamicDataSource.md b/docs/tools/sdk/go/Reference/V2024/Models/FormElementDynamicDataSource.md new file mode 100644 index 000000000..5d096231c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormElementDynamicDataSource.md @@ -0,0 +1,90 @@ +--- +id: v2024-form-element-dynamic-data-source +title: FormElementDynamicDataSource +pagination_label: FormElementDynamicDataSource +sidebar_label: FormElementDynamicDataSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElementDynamicDataSource', 'V2024FormElementDynamicDataSource'] +slug: /tools/sdk/go/v2024/models/form-element-dynamic-data-source +tags: ['SDK', 'Software Development Kit', 'FormElementDynamicDataSource', 'V2024FormElementDynamicDataSource'] +--- + +# FormElementDynamicDataSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Config** | Pointer to [**FormElementDynamicDataSourceConfig**](form-element-dynamic-data-source-config) | | [optional] +**DataSourceType** | Pointer to **string** | DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch FORM_INPUT FormElementDataSourceTypeFormInput | [optional] + +## Methods + +### NewFormElementDynamicDataSource + +`func NewFormElementDynamicDataSource() *FormElementDynamicDataSource` + +NewFormElementDynamicDataSource instantiates a new FormElementDynamicDataSource 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 + +### NewFormElementDynamicDataSourceWithDefaults + +`func NewFormElementDynamicDataSourceWithDefaults() *FormElementDynamicDataSource` + +NewFormElementDynamicDataSourceWithDefaults instantiates a new FormElementDynamicDataSource 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 + +### GetConfig + +`func (o *FormElementDynamicDataSource) GetConfig() FormElementDynamicDataSourceConfig` + +GetConfig returns the Config field if non-nil, zero value otherwise. + +### GetConfigOk + +`func (o *FormElementDynamicDataSource) GetConfigOk() (*FormElementDynamicDataSourceConfig, bool)` + +GetConfigOk returns a tuple with the Config field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfig + +`func (o *FormElementDynamicDataSource) SetConfig(v FormElementDynamicDataSourceConfig)` + +SetConfig sets Config field to given value. + +### HasConfig + +`func (o *FormElementDynamicDataSource) HasConfig() bool` + +HasConfig returns a boolean if a field has been set. + +### GetDataSourceType + +`func (o *FormElementDynamicDataSource) GetDataSourceType() string` + +GetDataSourceType returns the DataSourceType field if non-nil, zero value otherwise. + +### GetDataSourceTypeOk + +`func (o *FormElementDynamicDataSource) GetDataSourceTypeOk() (*string, bool)` + +GetDataSourceTypeOk returns a tuple with the DataSourceType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataSourceType + +`func (o *FormElementDynamicDataSource) SetDataSourceType(v string)` + +SetDataSourceType sets DataSourceType field to given value. + +### HasDataSourceType + +`func (o *FormElementDynamicDataSource) HasDataSourceType() bool` + +HasDataSourceType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormElementDynamicDataSourceConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/FormElementDynamicDataSourceConfig.md new file mode 100644 index 000000000..d08e9fc9b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormElementDynamicDataSourceConfig.md @@ -0,0 +1,142 @@ +--- +id: v2024-form-element-dynamic-data-source-config +title: FormElementDynamicDataSourceConfig +pagination_label: FormElementDynamicDataSourceConfig +sidebar_label: FormElementDynamicDataSourceConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElementDynamicDataSourceConfig', 'V2024FormElementDynamicDataSourceConfig'] +slug: /tools/sdk/go/v2024/models/form-element-dynamic-data-source-config +tags: ['SDK', 'Software Development Kit', 'FormElementDynamicDataSourceConfig', 'V2024FormElementDynamicDataSourceConfig'] +--- + +# FormElementDynamicDataSourceConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AggregationBucketField** | Pointer to **string** | AggregationBucketField is the aggregation bucket field name | [optional] +**Indices** | Pointer to **[]string** | Indices is a list of indices to use | [optional] +**ObjectType** | Pointer to **string** | ObjectType is a PreDefinedSelectOption value IDENTITY PreDefinedSelectOptionIdentity ACCESS_PROFILE PreDefinedSelectOptionAccessProfile SOURCES PreDefinedSelectOptionSources ROLE PreDefinedSelectOptionRole ENTITLEMENT PreDefinedSelectOptionEntitlement | [optional] +**Query** | Pointer to **string** | Query is a text | [optional] + +## Methods + +### NewFormElementDynamicDataSourceConfig + +`func NewFormElementDynamicDataSourceConfig() *FormElementDynamicDataSourceConfig` + +NewFormElementDynamicDataSourceConfig instantiates a new FormElementDynamicDataSourceConfig 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 + +### NewFormElementDynamicDataSourceConfigWithDefaults + +`func NewFormElementDynamicDataSourceConfigWithDefaults() *FormElementDynamicDataSourceConfig` + +NewFormElementDynamicDataSourceConfigWithDefaults instantiates a new FormElementDynamicDataSourceConfig 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 + +### GetAggregationBucketField + +`func (o *FormElementDynamicDataSourceConfig) GetAggregationBucketField() string` + +GetAggregationBucketField returns the AggregationBucketField field if non-nil, zero value otherwise. + +### GetAggregationBucketFieldOk + +`func (o *FormElementDynamicDataSourceConfig) GetAggregationBucketFieldOk() (*string, bool)` + +GetAggregationBucketFieldOk returns a tuple with the AggregationBucketField field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationBucketField + +`func (o *FormElementDynamicDataSourceConfig) SetAggregationBucketField(v string)` + +SetAggregationBucketField sets AggregationBucketField field to given value. + +### HasAggregationBucketField + +`func (o *FormElementDynamicDataSourceConfig) HasAggregationBucketField() bool` + +HasAggregationBucketField returns a boolean if a field has been set. + +### GetIndices + +`func (o *FormElementDynamicDataSourceConfig) GetIndices() []string` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *FormElementDynamicDataSourceConfig) GetIndicesOk() (*[]string, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *FormElementDynamicDataSourceConfig) SetIndices(v []string)` + +SetIndices sets Indices field to given value. + +### HasIndices + +`func (o *FormElementDynamicDataSourceConfig) HasIndices() bool` + +HasIndices returns a boolean if a field has been set. + +### GetObjectType + +`func (o *FormElementDynamicDataSourceConfig) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *FormElementDynamicDataSourceConfig) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *FormElementDynamicDataSourceConfig) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + +### HasObjectType + +`func (o *FormElementDynamicDataSourceConfig) HasObjectType() bool` + +HasObjectType returns a boolean if a field has been set. + +### GetQuery + +`func (o *FormElementDynamicDataSourceConfig) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *FormElementDynamicDataSourceConfig) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *FormElementDynamicDataSourceConfig) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *FormElementDynamicDataSourceConfig) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormElementPreviewRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/FormElementPreviewRequest.md new file mode 100644 index 000000000..d8f413264 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormElementPreviewRequest.md @@ -0,0 +1,64 @@ +--- +id: v2024-form-element-preview-request +title: FormElementPreviewRequest +pagination_label: FormElementPreviewRequest +sidebar_label: FormElementPreviewRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElementPreviewRequest', 'V2024FormElementPreviewRequest'] +slug: /tools/sdk/go/v2024/models/form-element-preview-request +tags: ['SDK', 'Software Development Kit', 'FormElementPreviewRequest', 'V2024FormElementPreviewRequest'] +--- + +# FormElementPreviewRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DataSource** | Pointer to [**FormElementDynamicDataSource**](form-element-dynamic-data-source) | | [optional] + +## Methods + +### NewFormElementPreviewRequest + +`func NewFormElementPreviewRequest() *FormElementPreviewRequest` + +NewFormElementPreviewRequest instantiates a new FormElementPreviewRequest 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 + +### NewFormElementPreviewRequestWithDefaults + +`func NewFormElementPreviewRequestWithDefaults() *FormElementPreviewRequest` + +NewFormElementPreviewRequestWithDefaults instantiates a new FormElementPreviewRequest 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 + +### GetDataSource + +`func (o *FormElementPreviewRequest) GetDataSource() FormElementDynamicDataSource` + +GetDataSource returns the DataSource field if non-nil, zero value otherwise. + +### GetDataSourceOk + +`func (o *FormElementPreviewRequest) GetDataSourceOk() (*FormElementDynamicDataSource, bool)` + +GetDataSourceOk returns a tuple with the DataSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataSource + +`func (o *FormElementPreviewRequest) SetDataSource(v FormElementDynamicDataSource)` + +SetDataSource sets DataSource field to given value. + +### HasDataSource + +`func (o *FormElementPreviewRequest) HasDataSource() bool` + +HasDataSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormElementValidationsSet.md b/docs/tools/sdk/go/Reference/V2024/Models/FormElementValidationsSet.md new file mode 100644 index 000000000..0b72fe948 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormElementValidationsSet.md @@ -0,0 +1,64 @@ +--- +id: v2024-form-element-validations-set +title: FormElementValidationsSet +pagination_label: FormElementValidationsSet +sidebar_label: FormElementValidationsSet +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElementValidationsSet', 'V2024FormElementValidationsSet'] +slug: /tools/sdk/go/v2024/models/form-element-validations-set +tags: ['SDK', 'Software Development Kit', 'FormElementValidationsSet', 'V2024FormElementValidationsSet'] +--- + +# FormElementValidationsSet + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ValidationType** | Pointer to **string** | The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. | [optional] + +## Methods + +### NewFormElementValidationsSet + +`func NewFormElementValidationsSet() *FormElementValidationsSet` + +NewFormElementValidationsSet instantiates a new FormElementValidationsSet 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 + +### NewFormElementValidationsSetWithDefaults + +`func NewFormElementValidationsSetWithDefaults() *FormElementValidationsSet` + +NewFormElementValidationsSetWithDefaults instantiates a new FormElementValidationsSet 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 + +### GetValidationType + +`func (o *FormElementValidationsSet) GetValidationType() string` + +GetValidationType returns the ValidationType field if non-nil, zero value otherwise. + +### GetValidationTypeOk + +`func (o *FormElementValidationsSet) GetValidationTypeOk() (*string, bool)` + +GetValidationTypeOk returns a tuple with the ValidationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValidationType + +`func (o *FormElementValidationsSet) SetValidationType(v string)` + +SetValidationType sets ValidationType field to given value. + +### HasValidationType + +`func (o *FormElementValidationsSet) HasValidationType() bool` + +HasValidationType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormError.md b/docs/tools/sdk/go/Reference/V2024/Models/FormError.md new file mode 100644 index 000000000..4834a02d4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormError.md @@ -0,0 +1,116 @@ +--- +id: v2024-form-error +title: FormError +pagination_label: FormError +sidebar_label: FormError +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormError', 'V2024FormError'] +slug: /tools/sdk/go/v2024/models/form-error +tags: ['SDK', 'Software Development Kit', 'FormError', 'V2024FormError'] +--- + +# FormError + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | Key is the technical key | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | Messages is a list of web.ErrorMessage items | [optional] +**Value** | Pointer to **map[string]interface{}** | Value is the value associated with a Key | [optional] + +## Methods + +### NewFormError + +`func NewFormError() *FormError` + +NewFormError instantiates a new FormError 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 + +### NewFormErrorWithDefaults + +`func NewFormErrorWithDefaults() *FormError` + +NewFormErrorWithDefaults instantiates a new FormError 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 + +### GetKey + +`func (o *FormError) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *FormError) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *FormError) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *FormError) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetMessages + +`func (o *FormError) GetMessages() []ErrorMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *FormError) GetMessagesOk() (*[]ErrorMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *FormError) SetMessages(v []ErrorMessage)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *FormError) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetValue + +`func (o *FormError) GetValue() map[string]interface{}` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *FormError) GetValueOk() (*map[string]interface{}, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *FormError) SetValue(v map[string]interface{})` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *FormError) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormInstanceCreatedBy.md b/docs/tools/sdk/go/Reference/V2024/Models/FormInstanceCreatedBy.md new file mode 100644 index 000000000..a9f824d54 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormInstanceCreatedBy.md @@ -0,0 +1,90 @@ +--- +id: v2024-form-instance-created-by +title: FormInstanceCreatedBy +pagination_label: FormInstanceCreatedBy +sidebar_label: FormInstanceCreatedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormInstanceCreatedBy', 'V2024FormInstanceCreatedBy'] +slug: /tools/sdk/go/v2024/models/form-instance-created-by +tags: ['SDK', 'Software Development Kit', 'FormInstanceCreatedBy', 'V2024FormInstanceCreatedBy'] +--- + +# FormInstanceCreatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID is a unique identifier | [optional] +**Type** | Pointer to **string** | Type is a form instance created by type enum value WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution SOURCE FormInstanceCreatedByTypeSource | [optional] + +## Methods + +### NewFormInstanceCreatedBy + +`func NewFormInstanceCreatedBy() *FormInstanceCreatedBy` + +NewFormInstanceCreatedBy instantiates a new FormInstanceCreatedBy 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 + +### NewFormInstanceCreatedByWithDefaults + +`func NewFormInstanceCreatedByWithDefaults() *FormInstanceCreatedBy` + +NewFormInstanceCreatedByWithDefaults instantiates a new FormInstanceCreatedBy 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 + +### GetId + +`func (o *FormInstanceCreatedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormInstanceCreatedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormInstanceCreatedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormInstanceCreatedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *FormInstanceCreatedBy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormInstanceCreatedBy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormInstanceCreatedBy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormInstanceCreatedBy) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormInstanceRecipient.md b/docs/tools/sdk/go/Reference/V2024/Models/FormInstanceRecipient.md new file mode 100644 index 000000000..79fcb26bc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormInstanceRecipient.md @@ -0,0 +1,90 @@ +--- +id: v2024-form-instance-recipient +title: FormInstanceRecipient +pagination_label: FormInstanceRecipient +sidebar_label: FormInstanceRecipient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormInstanceRecipient', 'V2024FormInstanceRecipient'] +slug: /tools/sdk/go/v2024/models/form-instance-recipient +tags: ['SDK', 'Software Development Kit', 'FormInstanceRecipient', 'V2024FormInstanceRecipient'] +--- + +# FormInstanceRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID is a unique identifier | [optional] +**Type** | Pointer to **string** | Type is a FormInstanceRecipientType value IDENTITY FormInstanceRecipientIdentity | [optional] + +## Methods + +### NewFormInstanceRecipient + +`func NewFormInstanceRecipient() *FormInstanceRecipient` + +NewFormInstanceRecipient instantiates a new FormInstanceRecipient 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 + +### NewFormInstanceRecipientWithDefaults + +`func NewFormInstanceRecipientWithDefaults() *FormInstanceRecipient` + +NewFormInstanceRecipientWithDefaults instantiates a new FormInstanceRecipient 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 + +### GetId + +`func (o *FormInstanceRecipient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormInstanceRecipient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormInstanceRecipient) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormInstanceRecipient) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *FormInstanceRecipient) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormInstanceRecipient) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormInstanceRecipient) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormInstanceRecipient) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormInstanceResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/FormInstanceResponse.md new file mode 100644 index 000000000..d22c5964a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormInstanceResponse.md @@ -0,0 +1,448 @@ +--- +id: v2024-form-instance-response +title: FormInstanceResponse +pagination_label: FormInstanceResponse +sidebar_label: FormInstanceResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormInstanceResponse', 'V2024FormInstanceResponse'] +slug: /tools/sdk/go/v2024/models/form-instance-response +tags: ['SDK', 'Software Development Kit', 'FormInstanceResponse', 'V2024FormInstanceResponse'] +--- + +# FormInstanceResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **SailPointTime** | Created is the date the form instance was assigned | [optional] +**CreatedBy** | Pointer to [**FormInstanceCreatedBy**](form-instance-created-by) | | [optional] +**Expire** | Pointer to **string** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [optional] +**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**FormData** | Pointer to **map[string]interface{}** | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] +**FormDefinitionId** | Pointer to **string** | FormDefinitionID is the id of the form definition that created this form | [optional] +**FormElements** | Pointer to [**[]FormElement**](form-element) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] +**FormErrors** | Pointer to [**[]FormError**](form-error) | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [optional] +**FormInput** | Pointer to **map[string]map[string]interface{}** | FormInput is an object of form input labels to value | [optional] +**Id** | Pointer to **string** | Unique guid identifying this form instance | [optional] +**Modified** | Pointer to **SailPointTime** | Modified is the last date the form instance was modified | [optional] +**Recipients** | Pointer to [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [optional] +**StandAloneForm** | Pointer to **bool** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to false] +**StandAloneFormUrl** | Pointer to **string** | StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI | [optional] +**State** | Pointer to **string** | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] + +## Methods + +### NewFormInstanceResponse + +`func NewFormInstanceResponse() *FormInstanceResponse` + +NewFormInstanceResponse instantiates a new FormInstanceResponse 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 + +### NewFormInstanceResponseWithDefaults + +`func NewFormInstanceResponseWithDefaults() *FormInstanceResponse` + +NewFormInstanceResponseWithDefaults instantiates a new FormInstanceResponse 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 + +### GetCreated + +`func (o *FormInstanceResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *FormInstanceResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *FormInstanceResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *FormInstanceResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetCreatedBy + +`func (o *FormInstanceResponse) GetCreatedBy() FormInstanceCreatedBy` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *FormInstanceResponse) GetCreatedByOk() (*FormInstanceCreatedBy, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *FormInstanceResponse) SetCreatedBy(v FormInstanceCreatedBy)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *FormInstanceResponse) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetExpire + +`func (o *FormInstanceResponse) GetExpire() string` + +GetExpire returns the Expire field if non-nil, zero value otherwise. + +### GetExpireOk + +`func (o *FormInstanceResponse) GetExpireOk() (*string, bool)` + +GetExpireOk returns a tuple with the Expire field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpire + +`func (o *FormInstanceResponse) SetExpire(v string)` + +SetExpire sets Expire field to given value. + +### HasExpire + +`func (o *FormInstanceResponse) HasExpire() bool` + +HasExpire returns a boolean if a field has been set. + +### GetFormConditions + +`func (o *FormInstanceResponse) GetFormConditions() []FormCondition` + +GetFormConditions returns the FormConditions field if non-nil, zero value otherwise. + +### GetFormConditionsOk + +`func (o *FormInstanceResponse) GetFormConditionsOk() (*[]FormCondition, bool)` + +GetFormConditionsOk returns a tuple with the FormConditions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormConditions + +`func (o *FormInstanceResponse) SetFormConditions(v []FormCondition)` + +SetFormConditions sets FormConditions field to given value. + +### HasFormConditions + +`func (o *FormInstanceResponse) HasFormConditions() bool` + +HasFormConditions returns a boolean if a field has been set. + +### GetFormData + +`func (o *FormInstanceResponse) GetFormData() map[string]interface{}` + +GetFormData returns the FormData field if non-nil, zero value otherwise. + +### GetFormDataOk + +`func (o *FormInstanceResponse) GetFormDataOk() (*map[string]interface{}, bool)` + +GetFormDataOk returns a tuple with the FormData field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormData + +`func (o *FormInstanceResponse) SetFormData(v map[string]interface{})` + +SetFormData sets FormData field to given value. + +### HasFormData + +`func (o *FormInstanceResponse) HasFormData() bool` + +HasFormData returns a boolean if a field has been set. + +### SetFormDataNil + +`func (o *FormInstanceResponse) SetFormDataNil(b bool)` + + SetFormDataNil sets the value for FormData to be an explicit nil + +### UnsetFormData +`func (o *FormInstanceResponse) UnsetFormData()` + +UnsetFormData ensures that no value is present for FormData, not even an explicit nil +### GetFormDefinitionId + +`func (o *FormInstanceResponse) GetFormDefinitionId() string` + +GetFormDefinitionId returns the FormDefinitionId field if non-nil, zero value otherwise. + +### GetFormDefinitionIdOk + +`func (o *FormInstanceResponse) GetFormDefinitionIdOk() (*string, bool)` + +GetFormDefinitionIdOk returns a tuple with the FormDefinitionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormDefinitionId + +`func (o *FormInstanceResponse) SetFormDefinitionId(v string)` + +SetFormDefinitionId sets FormDefinitionId field to given value. + +### HasFormDefinitionId + +`func (o *FormInstanceResponse) HasFormDefinitionId() bool` + +HasFormDefinitionId returns a boolean if a field has been set. + +### GetFormElements + +`func (o *FormInstanceResponse) GetFormElements() []FormElement` + +GetFormElements returns the FormElements field if non-nil, zero value otherwise. + +### GetFormElementsOk + +`func (o *FormInstanceResponse) GetFormElementsOk() (*[]FormElement, bool)` + +GetFormElementsOk returns a tuple with the FormElements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormElements + +`func (o *FormInstanceResponse) SetFormElements(v []FormElement)` + +SetFormElements sets FormElements field to given value. + +### HasFormElements + +`func (o *FormInstanceResponse) HasFormElements() bool` + +HasFormElements returns a boolean if a field has been set. + +### GetFormErrors + +`func (o *FormInstanceResponse) GetFormErrors() []FormError` + +GetFormErrors returns the FormErrors field if non-nil, zero value otherwise. + +### GetFormErrorsOk + +`func (o *FormInstanceResponse) GetFormErrorsOk() (*[]FormError, bool)` + +GetFormErrorsOk returns a tuple with the FormErrors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormErrors + +`func (o *FormInstanceResponse) SetFormErrors(v []FormError)` + +SetFormErrors sets FormErrors field to given value. + +### HasFormErrors + +`func (o *FormInstanceResponse) HasFormErrors() bool` + +HasFormErrors returns a boolean if a field has been set. + +### GetFormInput + +`func (o *FormInstanceResponse) GetFormInput() map[string]map[string]interface{}` + +GetFormInput returns the FormInput field if non-nil, zero value otherwise. + +### GetFormInputOk + +`func (o *FormInstanceResponse) GetFormInputOk() (*map[string]map[string]interface{}, bool)` + +GetFormInputOk returns a tuple with the FormInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormInput + +`func (o *FormInstanceResponse) SetFormInput(v map[string]map[string]interface{})` + +SetFormInput sets FormInput field to given value. + +### HasFormInput + +`func (o *FormInstanceResponse) HasFormInput() bool` + +HasFormInput returns a boolean if a field has been set. + +### SetFormInputNil + +`func (o *FormInstanceResponse) SetFormInputNil(b bool)` + + SetFormInputNil sets the value for FormInput to be an explicit nil + +### UnsetFormInput +`func (o *FormInstanceResponse) UnsetFormInput()` + +UnsetFormInput ensures that no value is present for FormInput, not even an explicit nil +### GetId + +`func (o *FormInstanceResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormInstanceResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormInstanceResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormInstanceResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetModified + +`func (o *FormInstanceResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *FormInstanceResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *FormInstanceResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *FormInstanceResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetRecipients + +`func (o *FormInstanceResponse) GetRecipients() []FormInstanceRecipient` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *FormInstanceResponse) GetRecipientsOk() (*[]FormInstanceRecipient, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *FormInstanceResponse) SetRecipients(v []FormInstanceRecipient)` + +SetRecipients sets Recipients field to given value. + +### HasRecipients + +`func (o *FormInstanceResponse) HasRecipients() bool` + +HasRecipients returns a boolean if a field has been set. + +### GetStandAloneForm + +`func (o *FormInstanceResponse) GetStandAloneForm() bool` + +GetStandAloneForm returns the StandAloneForm field if non-nil, zero value otherwise. + +### GetStandAloneFormOk + +`func (o *FormInstanceResponse) GetStandAloneFormOk() (*bool, bool)` + +GetStandAloneFormOk returns a tuple with the StandAloneForm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandAloneForm + +`func (o *FormInstanceResponse) SetStandAloneForm(v bool)` + +SetStandAloneForm sets StandAloneForm field to given value. + +### HasStandAloneForm + +`func (o *FormInstanceResponse) HasStandAloneForm() bool` + +HasStandAloneForm returns a boolean if a field has been set. + +### GetStandAloneFormUrl + +`func (o *FormInstanceResponse) GetStandAloneFormUrl() string` + +GetStandAloneFormUrl returns the StandAloneFormUrl field if non-nil, zero value otherwise. + +### GetStandAloneFormUrlOk + +`func (o *FormInstanceResponse) GetStandAloneFormUrlOk() (*string, bool)` + +GetStandAloneFormUrlOk returns a tuple with the StandAloneFormUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandAloneFormUrl + +`func (o *FormInstanceResponse) SetStandAloneFormUrl(v string)` + +SetStandAloneFormUrl sets StandAloneFormUrl field to given value. + +### HasStandAloneFormUrl + +`func (o *FormInstanceResponse) HasStandAloneFormUrl() bool` + +HasStandAloneFormUrl returns a boolean if a field has been set. + +### GetState + +`func (o *FormInstanceResponse) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *FormInstanceResponse) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *FormInstanceResponse) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *FormInstanceResponse) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormItemDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/FormItemDetails.md new file mode 100644 index 000000000..4eb833d8f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormItemDetails.md @@ -0,0 +1,74 @@ +--- +id: v2024-form-item-details +title: FormItemDetails +pagination_label: FormItemDetails +sidebar_label: FormItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormItemDetails', 'V2024FormItemDetails'] +slug: /tools/sdk/go/v2024/models/form-item-details +tags: ['SDK', 'Software Development Kit', 'FormItemDetails', 'V2024FormItemDetails'] +--- + +# FormItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **NullableString** | Name of the FormItem | [optional] + +## Methods + +### NewFormItemDetails + +`func NewFormItemDetails() *FormItemDetails` + +NewFormItemDetails instantiates a new FormItemDetails 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 + +### NewFormItemDetailsWithDefaults + +`func NewFormItemDetailsWithDefaults() *FormItemDetails` + +NewFormItemDetailsWithDefaults instantiates a new FormItemDetails 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 + +### GetName + +`func (o *FormItemDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormItemDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormItemDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormItemDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *FormItemDetails) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *FormItemDetails) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/FormOwner.md new file mode 100644 index 000000000..eabd2b74b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormOwner.md @@ -0,0 +1,116 @@ +--- +id: v2024-form-owner +title: FormOwner +pagination_label: FormOwner +sidebar_label: FormOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormOwner', 'V2024FormOwner'] +slug: /tools/sdk/go/v2024/models/form-owner +tags: ['SDK', 'Software Development Kit', 'FormOwner', 'V2024FormOwner'] +--- + +# FormOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | FormOwnerType value. IDENTITY FormOwnerTypeIdentity | [optional] +**Id** | Pointer to **string** | Unique identifier of the form's owner. | [optional] +**Name** | Pointer to **string** | Name of the form's owner. | [optional] + +## Methods + +### NewFormOwner + +`func NewFormOwner() *FormOwner` + +NewFormOwner instantiates a new FormOwner 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 + +### NewFormOwnerWithDefaults + +`func NewFormOwnerWithDefaults() *FormOwner` + +NewFormOwnerWithDefaults instantiates a new FormOwner 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 + +### GetType + +`func (o *FormOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *FormOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FormOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FormUsedBy.md b/docs/tools/sdk/go/Reference/V2024/Models/FormUsedBy.md new file mode 100644 index 000000000..262db0ae7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FormUsedBy.md @@ -0,0 +1,116 @@ +--- +id: v2024-form-used-by +title: FormUsedBy +pagination_label: FormUsedBy +sidebar_label: FormUsedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormUsedBy', 'V2024FormUsedBy'] +slug: /tools/sdk/go/v2024/models/form-used-by +tags: ['SDK', 'Software Development Kit', 'FormUsedBy', 'V2024FormUsedBy'] +--- + +# FormUsedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | FormUsedByType value. WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource MySailPoint FormUsedByType | [optional] +**Id** | Pointer to **string** | Unique identifier of the system using the form. | [optional] +**Name** | Pointer to **string** | Name of the system using the form. | [optional] + +## Methods + +### NewFormUsedBy + +`func NewFormUsedBy() *FormUsedBy` + +NewFormUsedBy instantiates a new FormUsedBy 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 + +### NewFormUsedByWithDefaults + +`func NewFormUsedByWithDefaults() *FormUsedBy` + +NewFormUsedByWithDefaults instantiates a new FormUsedBy 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 + +### GetType + +`func (o *FormUsedBy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormUsedBy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormUsedBy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormUsedBy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *FormUsedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormUsedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormUsedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormUsedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FormUsedBy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormUsedBy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormUsedBy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormUsedBy) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ForwardApprovalDto.md b/docs/tools/sdk/go/Reference/V2024/Models/ForwardApprovalDto.md new file mode 100644 index 000000000..bc4e32468 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ForwardApprovalDto.md @@ -0,0 +1,80 @@ +--- +id: v2024-forward-approval-dto +title: ForwardApprovalDto +pagination_label: ForwardApprovalDto +sidebar_label: ForwardApprovalDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ForwardApprovalDto', 'V2024ForwardApprovalDto'] +slug: /tools/sdk/go/v2024/models/forward-approval-dto +tags: ['SDK', 'Software Development Kit', 'ForwardApprovalDto', 'V2024ForwardApprovalDto'] +--- + +# ForwardApprovalDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewOwnerId** | **string** | The Id of the new owner | +**Comment** | **string** | The comment provided by the forwarder | + +## Methods + +### NewForwardApprovalDto + +`func NewForwardApprovalDto(newOwnerId string, comment string, ) *ForwardApprovalDto` + +NewForwardApprovalDto instantiates a new ForwardApprovalDto 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 + +### NewForwardApprovalDtoWithDefaults + +`func NewForwardApprovalDtoWithDefaults() *ForwardApprovalDto` + +NewForwardApprovalDtoWithDefaults instantiates a new ForwardApprovalDto 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 + +### GetNewOwnerId + +`func (o *ForwardApprovalDto) GetNewOwnerId() string` + +GetNewOwnerId returns the NewOwnerId field if non-nil, zero value otherwise. + +### GetNewOwnerIdOk + +`func (o *ForwardApprovalDto) GetNewOwnerIdOk() (*string, bool)` + +GetNewOwnerIdOk returns a tuple with the NewOwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewOwnerId + +`func (o *ForwardApprovalDto) SetNewOwnerId(v string)` + +SetNewOwnerId sets NewOwnerId field to given value. + + +### GetComment + +`func (o *ForwardApprovalDto) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ForwardApprovalDto) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ForwardApprovalDto) SetComment(v string)` + +SetComment sets Comment field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/FullDiscoveredApplications.md b/docs/tools/sdk/go/Reference/V2024/Models/FullDiscoveredApplications.md new file mode 100644 index 000000000..0a20388a4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/FullDiscoveredApplications.md @@ -0,0 +1,298 @@ +--- +id: v2024-full-discovered-applications +title: FullDiscoveredApplications +pagination_label: FullDiscoveredApplications +sidebar_label: FullDiscoveredApplications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FullDiscoveredApplications', 'V2024FullDiscoveredApplications'] +slug: /tools/sdk/go/v2024/models/full-discovered-applications +tags: ['SDK', 'Software Development Kit', 'FullDiscoveredApplications', 'V2024FullDiscoveredApplications'] +--- + +# FullDiscoveredApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **string** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **string** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **string** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **string** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]string** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **SailPointTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **string** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [optional] +**AssociatedSources** | Pointer to **[]string** | List of associated sources related to this discovered application. | [optional] + +## Methods + +### NewFullDiscoveredApplications + +`func NewFullDiscoveredApplications() *FullDiscoveredApplications` + +NewFullDiscoveredApplications instantiates a new FullDiscoveredApplications 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 + +### NewFullDiscoveredApplicationsWithDefaults + +`func NewFullDiscoveredApplicationsWithDefaults() *FullDiscoveredApplications` + +NewFullDiscoveredApplicationsWithDefaults instantiates a new FullDiscoveredApplications 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 + +### GetId + +`func (o *FullDiscoveredApplications) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FullDiscoveredApplications) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FullDiscoveredApplications) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FullDiscoveredApplications) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FullDiscoveredApplications) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FullDiscoveredApplications) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FullDiscoveredApplications) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FullDiscoveredApplications) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDiscoverySource + +`func (o *FullDiscoveredApplications) GetDiscoverySource() string` + +GetDiscoverySource returns the DiscoverySource field if non-nil, zero value otherwise. + +### GetDiscoverySourceOk + +`func (o *FullDiscoveredApplications) GetDiscoverySourceOk() (*string, bool)` + +GetDiscoverySourceOk returns a tuple with the DiscoverySource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoverySource + +`func (o *FullDiscoveredApplications) SetDiscoverySource(v string)` + +SetDiscoverySource sets DiscoverySource field to given value. + +### HasDiscoverySource + +`func (o *FullDiscoveredApplications) HasDiscoverySource() bool` + +HasDiscoverySource returns a boolean if a field has been set. + +### GetDiscoveredVendor + +`func (o *FullDiscoveredApplications) GetDiscoveredVendor() string` + +GetDiscoveredVendor returns the DiscoveredVendor field if non-nil, zero value otherwise. + +### GetDiscoveredVendorOk + +`func (o *FullDiscoveredApplications) GetDiscoveredVendorOk() (*string, bool)` + +GetDiscoveredVendorOk returns a tuple with the DiscoveredVendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredVendor + +`func (o *FullDiscoveredApplications) SetDiscoveredVendor(v string)` + +SetDiscoveredVendor sets DiscoveredVendor field to given value. + +### HasDiscoveredVendor + +`func (o *FullDiscoveredApplications) HasDiscoveredVendor() bool` + +HasDiscoveredVendor returns a boolean if a field has been set. + +### GetDescription + +`func (o *FullDiscoveredApplications) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *FullDiscoveredApplications) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *FullDiscoveredApplications) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *FullDiscoveredApplications) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetRecommendedConnectors + +`func (o *FullDiscoveredApplications) GetRecommendedConnectors() []string` + +GetRecommendedConnectors returns the RecommendedConnectors field if non-nil, zero value otherwise. + +### GetRecommendedConnectorsOk + +`func (o *FullDiscoveredApplications) GetRecommendedConnectorsOk() (*[]string, bool)` + +GetRecommendedConnectorsOk returns a tuple with the RecommendedConnectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendedConnectors + +`func (o *FullDiscoveredApplications) SetRecommendedConnectors(v []string)` + +SetRecommendedConnectors sets RecommendedConnectors field to given value. + +### HasRecommendedConnectors + +`func (o *FullDiscoveredApplications) HasRecommendedConnectors() bool` + +HasRecommendedConnectors returns a boolean if a field has been set. + +### GetDiscoveredAt + +`func (o *FullDiscoveredApplications) GetDiscoveredAt() SailPointTime` + +GetDiscoveredAt returns the DiscoveredAt field if non-nil, zero value otherwise. + +### GetDiscoveredAtOk + +`func (o *FullDiscoveredApplications) GetDiscoveredAtOk() (*SailPointTime, bool)` + +GetDiscoveredAtOk returns a tuple with the DiscoveredAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredAt + +`func (o *FullDiscoveredApplications) SetDiscoveredAt(v SailPointTime)` + +SetDiscoveredAt sets DiscoveredAt field to given value. + +### HasDiscoveredAt + +`func (o *FullDiscoveredApplications) HasDiscoveredAt() bool` + +HasDiscoveredAt returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *FullDiscoveredApplications) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *FullDiscoveredApplications) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *FullDiscoveredApplications) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *FullDiscoveredApplications) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetStatus + +`func (o *FullDiscoveredApplications) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *FullDiscoveredApplications) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *FullDiscoveredApplications) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *FullDiscoveredApplications) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetAssociatedSources + +`func (o *FullDiscoveredApplications) GetAssociatedSources() []string` + +GetAssociatedSources returns the AssociatedSources field if non-nil, zero value otherwise. + +### GetAssociatedSourcesOk + +`func (o *FullDiscoveredApplications) GetAssociatedSourcesOk() (*[]string, bool)` + +GetAssociatedSourcesOk returns a tuple with the AssociatedSources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociatedSources + +`func (o *FullDiscoveredApplications) SetAssociatedSources(v []string)` + +SetAssociatedSources sets AssociatedSources field to given value. + +### HasAssociatedSources + +`func (o *FullDiscoveredApplications) HasAssociatedSources() bool` + +HasAssociatedSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/GetActiveCampaigns200ResponseInner.md b/docs/tools/sdk/go/Reference/V2024/Models/GetActiveCampaigns200ResponseInner.md new file mode 100644 index 000000000..bffbbff5e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/GetActiveCampaigns200ResponseInner.md @@ -0,0 +1,771 @@ +--- +id: v2024-get-active-campaigns200-response-inner +title: GetActiveCampaigns200ResponseInner +pagination_label: GetActiveCampaigns200ResponseInner +sidebar_label: GetActiveCampaigns200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetActiveCampaigns200ResponseInner', 'V2024GetActiveCampaigns200ResponseInner'] +slug: /tools/sdk/go/v2024/models/get-active-campaigns200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetActiveCampaigns200ResponseInner', 'V2024GetActiveCampaigns200ResponseInner'] +--- + +# GetActiveCampaigns200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | Id of the campaign | [optional] [readonly] +**Name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Description** | **NullableString** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Deadline** | Pointer to **NullableTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **string** | The type of campaign. Could be extended in the future. | +**EmailNotificationEnabled** | Pointer to **bool** | Enables email notification for this campaign | [optional] [default to false] +**AutoRevokeAllowed** | Pointer to **bool** | Allows auto revoke for this campaign | [optional] [default to false] +**RecommendationsEnabled** | Pointer to **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to false] +**Status** | Pointer to **NullableString** | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **NullableTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **NullableInt32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **NullableInt32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **NullableTime** | Modified time of the campaign | [optional] [readonly] +**Filter** | Pointer to [**NullableCampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **bool** | Determines if comments on sunset date changes are required. | [optional] [default to true] +**SourceOwnerCampaignInfo** | Pointer to [**NullableCampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**NullableCampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**NullableCampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**NullableCampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Methods + +### NewGetActiveCampaigns200ResponseInner + +`func NewGetActiveCampaigns200ResponseInner(name string, description NullableString, type_ string, ) *GetActiveCampaigns200ResponseInner` + +NewGetActiveCampaigns200ResponseInner instantiates a new GetActiveCampaigns200ResponseInner 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 + +### NewGetActiveCampaigns200ResponseInnerWithDefaults + +`func NewGetActiveCampaigns200ResponseInnerWithDefaults() *GetActiveCampaigns200ResponseInner` + +NewGetActiveCampaigns200ResponseInnerWithDefaults instantiates a new GetActiveCampaigns200ResponseInner 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 + +### GetId + +`func (o *GetActiveCampaigns200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetActiveCampaigns200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetActiveCampaigns200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetActiveCampaigns200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *GetActiveCampaigns200ResponseInner) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *GetActiveCampaigns200ResponseInner) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *GetActiveCampaigns200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetActiveCampaigns200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetActiveCampaigns200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *GetActiveCampaigns200ResponseInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *GetActiveCampaigns200ResponseInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *GetActiveCampaigns200ResponseInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *GetActiveCampaigns200ResponseInner) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *GetActiveCampaigns200ResponseInner) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetDeadline + +`func (o *GetActiveCampaigns200ResponseInner) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *GetActiveCampaigns200ResponseInner) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *GetActiveCampaigns200ResponseInner) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *GetActiveCampaigns200ResponseInner) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### SetDeadlineNil + +`func (o *GetActiveCampaigns200ResponseInner) SetDeadlineNil(b bool)` + + SetDeadlineNil sets the value for Deadline to be an explicit nil + +### UnsetDeadline +`func (o *GetActiveCampaigns200ResponseInner) UnsetDeadline()` + +UnsetDeadline ensures that no value is present for Deadline, not even an explicit nil +### GetType + +`func (o *GetActiveCampaigns200ResponseInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *GetActiveCampaigns200ResponseInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *GetActiveCampaigns200ResponseInner) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEmailNotificationEnabled + +`func (o *GetActiveCampaigns200ResponseInner) GetEmailNotificationEnabled() bool` + +GetEmailNotificationEnabled returns the EmailNotificationEnabled field if non-nil, zero value otherwise. + +### GetEmailNotificationEnabledOk + +`func (o *GetActiveCampaigns200ResponseInner) GetEmailNotificationEnabledOk() (*bool, bool)` + +GetEmailNotificationEnabledOk returns a tuple with the EmailNotificationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationEnabled + +`func (o *GetActiveCampaigns200ResponseInner) SetEmailNotificationEnabled(v bool)` + +SetEmailNotificationEnabled sets EmailNotificationEnabled field to given value. + +### HasEmailNotificationEnabled + +`func (o *GetActiveCampaigns200ResponseInner) HasEmailNotificationEnabled() bool` + +HasEmailNotificationEnabled returns a boolean if a field has been set. + +### GetAutoRevokeAllowed + +`func (o *GetActiveCampaigns200ResponseInner) GetAutoRevokeAllowed() bool` + +GetAutoRevokeAllowed returns the AutoRevokeAllowed field if non-nil, zero value otherwise. + +### GetAutoRevokeAllowedOk + +`func (o *GetActiveCampaigns200ResponseInner) GetAutoRevokeAllowedOk() (*bool, bool)` + +GetAutoRevokeAllowedOk returns a tuple with the AutoRevokeAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoRevokeAllowed + +`func (o *GetActiveCampaigns200ResponseInner) SetAutoRevokeAllowed(v bool)` + +SetAutoRevokeAllowed sets AutoRevokeAllowed field to given value. + +### HasAutoRevokeAllowed + +`func (o *GetActiveCampaigns200ResponseInner) HasAutoRevokeAllowed() bool` + +HasAutoRevokeAllowed returns a boolean if a field has been set. + +### GetRecommendationsEnabled + +`func (o *GetActiveCampaigns200ResponseInner) GetRecommendationsEnabled() bool` + +GetRecommendationsEnabled returns the RecommendationsEnabled field if non-nil, zero value otherwise. + +### GetRecommendationsEnabledOk + +`func (o *GetActiveCampaigns200ResponseInner) GetRecommendationsEnabledOk() (*bool, bool)` + +GetRecommendationsEnabledOk returns a tuple with the RecommendationsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendationsEnabled + +`func (o *GetActiveCampaigns200ResponseInner) SetRecommendationsEnabled(v bool)` + +SetRecommendationsEnabled sets RecommendationsEnabled field to given value. + +### HasRecommendationsEnabled + +`func (o *GetActiveCampaigns200ResponseInner) HasRecommendationsEnabled() bool` + +HasRecommendationsEnabled returns a boolean if a field has been set. + +### GetStatus + +`func (o *GetActiveCampaigns200ResponseInner) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GetActiveCampaigns200ResponseInner) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GetActiveCampaigns200ResponseInner) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GetActiveCampaigns200ResponseInner) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatusNil + +`func (o *GetActiveCampaigns200ResponseInner) SetStatusNil(b bool)` + + SetStatusNil sets the value for Status to be an explicit nil + +### UnsetStatus +`func (o *GetActiveCampaigns200ResponseInner) UnsetStatus()` + +UnsetStatus ensures that no value is present for Status, not even an explicit nil +### GetCorrelatedStatus + +`func (o *GetActiveCampaigns200ResponseInner) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *GetActiveCampaigns200ResponseInner) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *GetActiveCampaigns200ResponseInner) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + +### HasCorrelatedStatus + +`func (o *GetActiveCampaigns200ResponseInner) HasCorrelatedStatus() bool` + +HasCorrelatedStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *GetActiveCampaigns200ResponseInner) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GetActiveCampaigns200ResponseInner) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *GetActiveCampaigns200ResponseInner) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *GetActiveCampaigns200ResponseInner) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *GetActiveCampaigns200ResponseInner) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *GetActiveCampaigns200ResponseInner) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetTotalCertifications + +`func (o *GetActiveCampaigns200ResponseInner) GetTotalCertifications() int32` + +GetTotalCertifications returns the TotalCertifications field if non-nil, zero value otherwise. + +### GetTotalCertificationsOk + +`func (o *GetActiveCampaigns200ResponseInner) GetTotalCertificationsOk() (*int32, bool)` + +GetTotalCertificationsOk returns a tuple with the TotalCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCertifications + +`func (o *GetActiveCampaigns200ResponseInner) SetTotalCertifications(v int32)` + +SetTotalCertifications sets TotalCertifications field to given value. + +### HasTotalCertifications + +`func (o *GetActiveCampaigns200ResponseInner) HasTotalCertifications() bool` + +HasTotalCertifications returns a boolean if a field has been set. + +### SetTotalCertificationsNil + +`func (o *GetActiveCampaigns200ResponseInner) SetTotalCertificationsNil(b bool)` + + SetTotalCertificationsNil sets the value for TotalCertifications to be an explicit nil + +### UnsetTotalCertifications +`func (o *GetActiveCampaigns200ResponseInner) UnsetTotalCertifications()` + +UnsetTotalCertifications ensures that no value is present for TotalCertifications, not even an explicit nil +### GetCompletedCertifications + +`func (o *GetActiveCampaigns200ResponseInner) GetCompletedCertifications() int32` + +GetCompletedCertifications returns the CompletedCertifications field if non-nil, zero value otherwise. + +### GetCompletedCertificationsOk + +`func (o *GetActiveCampaigns200ResponseInner) GetCompletedCertificationsOk() (*int32, bool)` + +GetCompletedCertificationsOk returns a tuple with the CompletedCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedCertifications + +`func (o *GetActiveCampaigns200ResponseInner) SetCompletedCertifications(v int32)` + +SetCompletedCertifications sets CompletedCertifications field to given value. + +### HasCompletedCertifications + +`func (o *GetActiveCampaigns200ResponseInner) HasCompletedCertifications() bool` + +HasCompletedCertifications returns a boolean if a field has been set. + +### SetCompletedCertificationsNil + +`func (o *GetActiveCampaigns200ResponseInner) SetCompletedCertificationsNil(b bool)` + + SetCompletedCertificationsNil sets the value for CompletedCertifications to be an explicit nil + +### UnsetCompletedCertifications +`func (o *GetActiveCampaigns200ResponseInner) UnsetCompletedCertifications()` + +UnsetCompletedCertifications ensures that no value is present for CompletedCertifications, not even an explicit nil +### GetAlerts + +`func (o *GetActiveCampaigns200ResponseInner) GetAlerts() []CampaignAlert` + +GetAlerts returns the Alerts field if non-nil, zero value otherwise. + +### GetAlertsOk + +`func (o *GetActiveCampaigns200ResponseInner) GetAlertsOk() (*[]CampaignAlert, bool)` + +GetAlertsOk returns a tuple with the Alerts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlerts + +`func (o *GetActiveCampaigns200ResponseInner) SetAlerts(v []CampaignAlert)` + +SetAlerts sets Alerts field to given value. + +### HasAlerts + +`func (o *GetActiveCampaigns200ResponseInner) HasAlerts() bool` + +HasAlerts returns a boolean if a field has been set. + +### SetAlertsNil + +`func (o *GetActiveCampaigns200ResponseInner) SetAlertsNil(b bool)` + + SetAlertsNil sets the value for Alerts to be an explicit nil + +### UnsetAlerts +`func (o *GetActiveCampaigns200ResponseInner) UnsetAlerts()` + +UnsetAlerts ensures that no value is present for Alerts, not even an explicit nil +### GetModified + +`func (o *GetActiveCampaigns200ResponseInner) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *GetActiveCampaigns200ResponseInner) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *GetActiveCampaigns200ResponseInner) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *GetActiveCampaigns200ResponseInner) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *GetActiveCampaigns200ResponseInner) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *GetActiveCampaigns200ResponseInner) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetFilter + +`func (o *GetActiveCampaigns200ResponseInner) GetFilter() CampaignAllOfFilter` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *GetActiveCampaigns200ResponseInner) GetFilterOk() (*CampaignAllOfFilter, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *GetActiveCampaigns200ResponseInner) SetFilter(v CampaignAllOfFilter)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *GetActiveCampaigns200ResponseInner) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### SetFilterNil + +`func (o *GetActiveCampaigns200ResponseInner) SetFilterNil(b bool)` + + SetFilterNil sets the value for Filter to be an explicit nil + +### UnsetFilter +`func (o *GetActiveCampaigns200ResponseInner) UnsetFilter()` + +UnsetFilter ensures that no value is present for Filter, not even an explicit nil +### GetSunsetCommentsRequired + +`func (o *GetActiveCampaigns200ResponseInner) GetSunsetCommentsRequired() bool` + +GetSunsetCommentsRequired returns the SunsetCommentsRequired field if non-nil, zero value otherwise. + +### GetSunsetCommentsRequiredOk + +`func (o *GetActiveCampaigns200ResponseInner) GetSunsetCommentsRequiredOk() (*bool, bool)` + +GetSunsetCommentsRequiredOk returns a tuple with the SunsetCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSunsetCommentsRequired + +`func (o *GetActiveCampaigns200ResponseInner) SetSunsetCommentsRequired(v bool)` + +SetSunsetCommentsRequired sets SunsetCommentsRequired field to given value. + +### HasSunsetCommentsRequired + +`func (o *GetActiveCampaigns200ResponseInner) HasSunsetCommentsRequired() bool` + +HasSunsetCommentsRequired returns a boolean if a field has been set. + +### GetSourceOwnerCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) GetSourceOwnerCampaignInfo() CampaignAllOfSourceOwnerCampaignInfo` + +GetSourceOwnerCampaignInfo returns the SourceOwnerCampaignInfo field if non-nil, zero value otherwise. + +### GetSourceOwnerCampaignInfoOk + +`func (o *GetActiveCampaigns200ResponseInner) GetSourceOwnerCampaignInfoOk() (*CampaignAllOfSourceOwnerCampaignInfo, bool)` + +GetSourceOwnerCampaignInfoOk returns a tuple with the SourceOwnerCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceOwnerCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) SetSourceOwnerCampaignInfo(v CampaignAllOfSourceOwnerCampaignInfo)` + +SetSourceOwnerCampaignInfo sets SourceOwnerCampaignInfo field to given value. + +### HasSourceOwnerCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) HasSourceOwnerCampaignInfo() bool` + +HasSourceOwnerCampaignInfo returns a boolean if a field has been set. + +### SetSourceOwnerCampaignInfoNil + +`func (o *GetActiveCampaigns200ResponseInner) SetSourceOwnerCampaignInfoNil(b bool)` + + SetSourceOwnerCampaignInfoNil sets the value for SourceOwnerCampaignInfo to be an explicit nil + +### UnsetSourceOwnerCampaignInfo +`func (o *GetActiveCampaigns200ResponseInner) UnsetSourceOwnerCampaignInfo()` + +UnsetSourceOwnerCampaignInfo ensures that no value is present for SourceOwnerCampaignInfo, not even an explicit nil +### GetSearchCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) GetSearchCampaignInfo() CampaignAllOfSearchCampaignInfo` + +GetSearchCampaignInfo returns the SearchCampaignInfo field if non-nil, zero value otherwise. + +### GetSearchCampaignInfoOk + +`func (o *GetActiveCampaigns200ResponseInner) GetSearchCampaignInfoOk() (*CampaignAllOfSearchCampaignInfo, bool)` + +GetSearchCampaignInfoOk returns a tuple with the SearchCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) SetSearchCampaignInfo(v CampaignAllOfSearchCampaignInfo)` + +SetSearchCampaignInfo sets SearchCampaignInfo field to given value. + +### HasSearchCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) HasSearchCampaignInfo() bool` + +HasSearchCampaignInfo returns a boolean if a field has been set. + +### SetSearchCampaignInfoNil + +`func (o *GetActiveCampaigns200ResponseInner) SetSearchCampaignInfoNil(b bool)` + + SetSearchCampaignInfoNil sets the value for SearchCampaignInfo to be an explicit nil + +### UnsetSearchCampaignInfo +`func (o *GetActiveCampaigns200ResponseInner) UnsetSearchCampaignInfo()` + +UnsetSearchCampaignInfo ensures that no value is present for SearchCampaignInfo, not even an explicit nil +### GetRoleCompositionCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) GetRoleCompositionCampaignInfo() CampaignAllOfRoleCompositionCampaignInfo` + +GetRoleCompositionCampaignInfo returns the RoleCompositionCampaignInfo field if non-nil, zero value otherwise. + +### GetRoleCompositionCampaignInfoOk + +`func (o *GetActiveCampaigns200ResponseInner) GetRoleCompositionCampaignInfoOk() (*CampaignAllOfRoleCompositionCampaignInfo, bool)` + +GetRoleCompositionCampaignInfoOk returns a tuple with the RoleCompositionCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleCompositionCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) SetRoleCompositionCampaignInfo(v CampaignAllOfRoleCompositionCampaignInfo)` + +SetRoleCompositionCampaignInfo sets RoleCompositionCampaignInfo field to given value. + +### HasRoleCompositionCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) HasRoleCompositionCampaignInfo() bool` + +HasRoleCompositionCampaignInfo returns a boolean if a field has been set. + +### SetRoleCompositionCampaignInfoNil + +`func (o *GetActiveCampaigns200ResponseInner) SetRoleCompositionCampaignInfoNil(b bool)` + + SetRoleCompositionCampaignInfoNil sets the value for RoleCompositionCampaignInfo to be an explicit nil + +### UnsetRoleCompositionCampaignInfo +`func (o *GetActiveCampaigns200ResponseInner) UnsetRoleCompositionCampaignInfo()` + +UnsetRoleCompositionCampaignInfo ensures that no value is present for RoleCompositionCampaignInfo, not even an explicit nil +### GetMachineAccountCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) GetMachineAccountCampaignInfo() CampaignAllOfMachineAccountCampaignInfo` + +GetMachineAccountCampaignInfo returns the MachineAccountCampaignInfo field if non-nil, zero value otherwise. + +### GetMachineAccountCampaignInfoOk + +`func (o *GetActiveCampaigns200ResponseInner) GetMachineAccountCampaignInfoOk() (*CampaignAllOfMachineAccountCampaignInfo, bool)` + +GetMachineAccountCampaignInfoOk returns a tuple with the MachineAccountCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMachineAccountCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) SetMachineAccountCampaignInfo(v CampaignAllOfMachineAccountCampaignInfo)` + +SetMachineAccountCampaignInfo sets MachineAccountCampaignInfo field to given value. + +### HasMachineAccountCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) HasMachineAccountCampaignInfo() bool` + +HasMachineAccountCampaignInfo returns a boolean if a field has been set. + +### SetMachineAccountCampaignInfoNil + +`func (o *GetActiveCampaigns200ResponseInner) SetMachineAccountCampaignInfoNil(b bool)` + + SetMachineAccountCampaignInfoNil sets the value for MachineAccountCampaignInfo to be an explicit nil + +### UnsetMachineAccountCampaignInfo +`func (o *GetActiveCampaigns200ResponseInner) UnsetMachineAccountCampaignInfo()` + +UnsetMachineAccountCampaignInfo ensures that no value is present for MachineAccountCampaignInfo, not even an explicit nil +### GetSourcesWithOrphanEntitlements + +`func (o *GetActiveCampaigns200ResponseInner) GetSourcesWithOrphanEntitlements() []CampaignAllOfSourcesWithOrphanEntitlements` + +GetSourcesWithOrphanEntitlements returns the SourcesWithOrphanEntitlements field if non-nil, zero value otherwise. + +### GetSourcesWithOrphanEntitlementsOk + +`func (o *GetActiveCampaigns200ResponseInner) GetSourcesWithOrphanEntitlementsOk() (*[]CampaignAllOfSourcesWithOrphanEntitlements, bool)` + +GetSourcesWithOrphanEntitlementsOk returns a tuple with the SourcesWithOrphanEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourcesWithOrphanEntitlements + +`func (o *GetActiveCampaigns200ResponseInner) SetSourcesWithOrphanEntitlements(v []CampaignAllOfSourcesWithOrphanEntitlements)` + +SetSourcesWithOrphanEntitlements sets SourcesWithOrphanEntitlements field to given value. + +### HasSourcesWithOrphanEntitlements + +`func (o *GetActiveCampaigns200ResponseInner) HasSourcesWithOrphanEntitlements() bool` + +HasSourcesWithOrphanEntitlements returns a boolean if a field has been set. + +### SetSourcesWithOrphanEntitlementsNil + +`func (o *GetActiveCampaigns200ResponseInner) SetSourcesWithOrphanEntitlementsNil(b bool)` + + SetSourcesWithOrphanEntitlementsNil sets the value for SourcesWithOrphanEntitlements to be an explicit nil + +### UnsetSourcesWithOrphanEntitlements +`func (o *GetActiveCampaigns200ResponseInner) UnsetSourcesWithOrphanEntitlements()` + +UnsetSourcesWithOrphanEntitlements ensures that no value is present for SourcesWithOrphanEntitlements, not even an explicit nil +### GetMandatoryCommentRequirement + +`func (o *GetActiveCampaigns200ResponseInner) GetMandatoryCommentRequirement() string` + +GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise. + +### GetMandatoryCommentRequirementOk + +`func (o *GetActiveCampaigns200ResponseInner) GetMandatoryCommentRequirementOk() (*string, bool)` + +GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMandatoryCommentRequirement + +`func (o *GetActiveCampaigns200ResponseInner) SetMandatoryCommentRequirement(v string)` + +SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value. + +### HasMandatoryCommentRequirement + +`func (o *GetActiveCampaigns200ResponseInner) HasMandatoryCommentRequirement() bool` + +HasMandatoryCommentRequirement returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/GetCampaign200Response.md b/docs/tools/sdk/go/Reference/V2024/Models/GetCampaign200Response.md new file mode 100644 index 000000000..305035eab --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/GetCampaign200Response.md @@ -0,0 +1,771 @@ +--- +id: v2024-get-campaign200-response +title: GetCampaign200Response +pagination_label: GetCampaign200Response +sidebar_label: GetCampaign200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetCampaign200Response', 'V2024GetCampaign200Response'] +slug: /tools/sdk/go/v2024/models/get-campaign200-response +tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'V2024GetCampaign200Response'] +--- + +# GetCampaign200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | Id of the campaign | [optional] [readonly] +**Name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Description** | **NullableString** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Deadline** | Pointer to **NullableTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **string** | The type of campaign. Could be extended in the future. | +**EmailNotificationEnabled** | Pointer to **bool** | Enables email notification for this campaign | [optional] [default to false] +**AutoRevokeAllowed** | Pointer to **bool** | Allows auto revoke for this campaign | [optional] [default to false] +**RecommendationsEnabled** | Pointer to **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to false] +**Status** | Pointer to **NullableString** | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **NullableTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **NullableInt32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **NullableInt32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **NullableTime** | Modified time of the campaign | [optional] [readonly] +**Filter** | Pointer to [**NullableCampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **bool** | Determines if comments on sunset date changes are required. | [optional] [default to true] +**SourceOwnerCampaignInfo** | Pointer to [**NullableCampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**NullableCampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**NullableCampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**NullableCampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Methods + +### NewGetCampaign200Response + +`func NewGetCampaign200Response(name string, description NullableString, type_ string, ) *GetCampaign200Response` + +NewGetCampaign200Response instantiates a new GetCampaign200Response 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 + +### NewGetCampaign200ResponseWithDefaults + +`func NewGetCampaign200ResponseWithDefaults() *GetCampaign200Response` + +NewGetCampaign200ResponseWithDefaults instantiates a new GetCampaign200Response 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 + +### GetId + +`func (o *GetCampaign200Response) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetCampaign200Response) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetCampaign200Response) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetCampaign200Response) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *GetCampaign200Response) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *GetCampaign200Response) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *GetCampaign200Response) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetCampaign200Response) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetCampaign200Response) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *GetCampaign200Response) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *GetCampaign200Response) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *GetCampaign200Response) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *GetCampaign200Response) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *GetCampaign200Response) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetDeadline + +`func (o *GetCampaign200Response) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *GetCampaign200Response) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *GetCampaign200Response) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *GetCampaign200Response) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### SetDeadlineNil + +`func (o *GetCampaign200Response) SetDeadlineNil(b bool)` + + SetDeadlineNil sets the value for Deadline to be an explicit nil + +### UnsetDeadline +`func (o *GetCampaign200Response) UnsetDeadline()` + +UnsetDeadline ensures that no value is present for Deadline, not even an explicit nil +### GetType + +`func (o *GetCampaign200Response) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *GetCampaign200Response) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *GetCampaign200Response) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEmailNotificationEnabled + +`func (o *GetCampaign200Response) GetEmailNotificationEnabled() bool` + +GetEmailNotificationEnabled returns the EmailNotificationEnabled field if non-nil, zero value otherwise. + +### GetEmailNotificationEnabledOk + +`func (o *GetCampaign200Response) GetEmailNotificationEnabledOk() (*bool, bool)` + +GetEmailNotificationEnabledOk returns a tuple with the EmailNotificationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationEnabled + +`func (o *GetCampaign200Response) SetEmailNotificationEnabled(v bool)` + +SetEmailNotificationEnabled sets EmailNotificationEnabled field to given value. + +### HasEmailNotificationEnabled + +`func (o *GetCampaign200Response) HasEmailNotificationEnabled() bool` + +HasEmailNotificationEnabled returns a boolean if a field has been set. + +### GetAutoRevokeAllowed + +`func (o *GetCampaign200Response) GetAutoRevokeAllowed() bool` + +GetAutoRevokeAllowed returns the AutoRevokeAllowed field if non-nil, zero value otherwise. + +### GetAutoRevokeAllowedOk + +`func (o *GetCampaign200Response) GetAutoRevokeAllowedOk() (*bool, bool)` + +GetAutoRevokeAllowedOk returns a tuple with the AutoRevokeAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoRevokeAllowed + +`func (o *GetCampaign200Response) SetAutoRevokeAllowed(v bool)` + +SetAutoRevokeAllowed sets AutoRevokeAllowed field to given value. + +### HasAutoRevokeAllowed + +`func (o *GetCampaign200Response) HasAutoRevokeAllowed() bool` + +HasAutoRevokeAllowed returns a boolean if a field has been set. + +### GetRecommendationsEnabled + +`func (o *GetCampaign200Response) GetRecommendationsEnabled() bool` + +GetRecommendationsEnabled returns the RecommendationsEnabled field if non-nil, zero value otherwise. + +### GetRecommendationsEnabledOk + +`func (o *GetCampaign200Response) GetRecommendationsEnabledOk() (*bool, bool)` + +GetRecommendationsEnabledOk returns a tuple with the RecommendationsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendationsEnabled + +`func (o *GetCampaign200Response) SetRecommendationsEnabled(v bool)` + +SetRecommendationsEnabled sets RecommendationsEnabled field to given value. + +### HasRecommendationsEnabled + +`func (o *GetCampaign200Response) HasRecommendationsEnabled() bool` + +HasRecommendationsEnabled returns a boolean if a field has been set. + +### GetStatus + +`func (o *GetCampaign200Response) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GetCampaign200Response) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GetCampaign200Response) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GetCampaign200Response) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatusNil + +`func (o *GetCampaign200Response) SetStatusNil(b bool)` + + SetStatusNil sets the value for Status to be an explicit nil + +### UnsetStatus +`func (o *GetCampaign200Response) UnsetStatus()` + +UnsetStatus ensures that no value is present for Status, not even an explicit nil +### GetCorrelatedStatus + +`func (o *GetCampaign200Response) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *GetCampaign200Response) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *GetCampaign200Response) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + +### HasCorrelatedStatus + +`func (o *GetCampaign200Response) HasCorrelatedStatus() bool` + +HasCorrelatedStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *GetCampaign200Response) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GetCampaign200Response) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *GetCampaign200Response) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *GetCampaign200Response) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *GetCampaign200Response) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *GetCampaign200Response) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetTotalCertifications + +`func (o *GetCampaign200Response) GetTotalCertifications() int32` + +GetTotalCertifications returns the TotalCertifications field if non-nil, zero value otherwise. + +### GetTotalCertificationsOk + +`func (o *GetCampaign200Response) GetTotalCertificationsOk() (*int32, bool)` + +GetTotalCertificationsOk returns a tuple with the TotalCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCertifications + +`func (o *GetCampaign200Response) SetTotalCertifications(v int32)` + +SetTotalCertifications sets TotalCertifications field to given value. + +### HasTotalCertifications + +`func (o *GetCampaign200Response) HasTotalCertifications() bool` + +HasTotalCertifications returns a boolean if a field has been set. + +### SetTotalCertificationsNil + +`func (o *GetCampaign200Response) SetTotalCertificationsNil(b bool)` + + SetTotalCertificationsNil sets the value for TotalCertifications to be an explicit nil + +### UnsetTotalCertifications +`func (o *GetCampaign200Response) UnsetTotalCertifications()` + +UnsetTotalCertifications ensures that no value is present for TotalCertifications, not even an explicit nil +### GetCompletedCertifications + +`func (o *GetCampaign200Response) GetCompletedCertifications() int32` + +GetCompletedCertifications returns the CompletedCertifications field if non-nil, zero value otherwise. + +### GetCompletedCertificationsOk + +`func (o *GetCampaign200Response) GetCompletedCertificationsOk() (*int32, bool)` + +GetCompletedCertificationsOk returns a tuple with the CompletedCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedCertifications + +`func (o *GetCampaign200Response) SetCompletedCertifications(v int32)` + +SetCompletedCertifications sets CompletedCertifications field to given value. + +### HasCompletedCertifications + +`func (o *GetCampaign200Response) HasCompletedCertifications() bool` + +HasCompletedCertifications returns a boolean if a field has been set. + +### SetCompletedCertificationsNil + +`func (o *GetCampaign200Response) SetCompletedCertificationsNil(b bool)` + + SetCompletedCertificationsNil sets the value for CompletedCertifications to be an explicit nil + +### UnsetCompletedCertifications +`func (o *GetCampaign200Response) UnsetCompletedCertifications()` + +UnsetCompletedCertifications ensures that no value is present for CompletedCertifications, not even an explicit nil +### GetAlerts + +`func (o *GetCampaign200Response) GetAlerts() []CampaignAlert` + +GetAlerts returns the Alerts field if non-nil, zero value otherwise. + +### GetAlertsOk + +`func (o *GetCampaign200Response) GetAlertsOk() (*[]CampaignAlert, bool)` + +GetAlertsOk returns a tuple with the Alerts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlerts + +`func (o *GetCampaign200Response) SetAlerts(v []CampaignAlert)` + +SetAlerts sets Alerts field to given value. + +### HasAlerts + +`func (o *GetCampaign200Response) HasAlerts() bool` + +HasAlerts returns a boolean if a field has been set. + +### SetAlertsNil + +`func (o *GetCampaign200Response) SetAlertsNil(b bool)` + + SetAlertsNil sets the value for Alerts to be an explicit nil + +### UnsetAlerts +`func (o *GetCampaign200Response) UnsetAlerts()` + +UnsetAlerts ensures that no value is present for Alerts, not even an explicit nil +### GetModified + +`func (o *GetCampaign200Response) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *GetCampaign200Response) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *GetCampaign200Response) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *GetCampaign200Response) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *GetCampaign200Response) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *GetCampaign200Response) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetFilter + +`func (o *GetCampaign200Response) GetFilter() CampaignAllOfFilter` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *GetCampaign200Response) GetFilterOk() (*CampaignAllOfFilter, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *GetCampaign200Response) SetFilter(v CampaignAllOfFilter)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *GetCampaign200Response) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### SetFilterNil + +`func (o *GetCampaign200Response) SetFilterNil(b bool)` + + SetFilterNil sets the value for Filter to be an explicit nil + +### UnsetFilter +`func (o *GetCampaign200Response) UnsetFilter()` + +UnsetFilter ensures that no value is present for Filter, not even an explicit nil +### GetSunsetCommentsRequired + +`func (o *GetCampaign200Response) GetSunsetCommentsRequired() bool` + +GetSunsetCommentsRequired returns the SunsetCommentsRequired field if non-nil, zero value otherwise. + +### GetSunsetCommentsRequiredOk + +`func (o *GetCampaign200Response) GetSunsetCommentsRequiredOk() (*bool, bool)` + +GetSunsetCommentsRequiredOk returns a tuple with the SunsetCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSunsetCommentsRequired + +`func (o *GetCampaign200Response) SetSunsetCommentsRequired(v bool)` + +SetSunsetCommentsRequired sets SunsetCommentsRequired field to given value. + +### HasSunsetCommentsRequired + +`func (o *GetCampaign200Response) HasSunsetCommentsRequired() bool` + +HasSunsetCommentsRequired returns a boolean if a field has been set. + +### GetSourceOwnerCampaignInfo + +`func (o *GetCampaign200Response) GetSourceOwnerCampaignInfo() CampaignAllOfSourceOwnerCampaignInfo` + +GetSourceOwnerCampaignInfo returns the SourceOwnerCampaignInfo field if non-nil, zero value otherwise. + +### GetSourceOwnerCampaignInfoOk + +`func (o *GetCampaign200Response) GetSourceOwnerCampaignInfoOk() (*CampaignAllOfSourceOwnerCampaignInfo, bool)` + +GetSourceOwnerCampaignInfoOk returns a tuple with the SourceOwnerCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceOwnerCampaignInfo + +`func (o *GetCampaign200Response) SetSourceOwnerCampaignInfo(v CampaignAllOfSourceOwnerCampaignInfo)` + +SetSourceOwnerCampaignInfo sets SourceOwnerCampaignInfo field to given value. + +### HasSourceOwnerCampaignInfo + +`func (o *GetCampaign200Response) HasSourceOwnerCampaignInfo() bool` + +HasSourceOwnerCampaignInfo returns a boolean if a field has been set. + +### SetSourceOwnerCampaignInfoNil + +`func (o *GetCampaign200Response) SetSourceOwnerCampaignInfoNil(b bool)` + + SetSourceOwnerCampaignInfoNil sets the value for SourceOwnerCampaignInfo to be an explicit nil + +### UnsetSourceOwnerCampaignInfo +`func (o *GetCampaign200Response) UnsetSourceOwnerCampaignInfo()` + +UnsetSourceOwnerCampaignInfo ensures that no value is present for SourceOwnerCampaignInfo, not even an explicit nil +### GetSearchCampaignInfo + +`func (o *GetCampaign200Response) GetSearchCampaignInfo() CampaignAllOfSearchCampaignInfo` + +GetSearchCampaignInfo returns the SearchCampaignInfo field if non-nil, zero value otherwise. + +### GetSearchCampaignInfoOk + +`func (o *GetCampaign200Response) GetSearchCampaignInfoOk() (*CampaignAllOfSearchCampaignInfo, bool)` + +GetSearchCampaignInfoOk returns a tuple with the SearchCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchCampaignInfo + +`func (o *GetCampaign200Response) SetSearchCampaignInfo(v CampaignAllOfSearchCampaignInfo)` + +SetSearchCampaignInfo sets SearchCampaignInfo field to given value. + +### HasSearchCampaignInfo + +`func (o *GetCampaign200Response) HasSearchCampaignInfo() bool` + +HasSearchCampaignInfo returns a boolean if a field has been set. + +### SetSearchCampaignInfoNil + +`func (o *GetCampaign200Response) SetSearchCampaignInfoNil(b bool)` + + SetSearchCampaignInfoNil sets the value for SearchCampaignInfo to be an explicit nil + +### UnsetSearchCampaignInfo +`func (o *GetCampaign200Response) UnsetSearchCampaignInfo()` + +UnsetSearchCampaignInfo ensures that no value is present for SearchCampaignInfo, not even an explicit nil +### GetRoleCompositionCampaignInfo + +`func (o *GetCampaign200Response) GetRoleCompositionCampaignInfo() CampaignAllOfRoleCompositionCampaignInfo` + +GetRoleCompositionCampaignInfo returns the RoleCompositionCampaignInfo field if non-nil, zero value otherwise. + +### GetRoleCompositionCampaignInfoOk + +`func (o *GetCampaign200Response) GetRoleCompositionCampaignInfoOk() (*CampaignAllOfRoleCompositionCampaignInfo, bool)` + +GetRoleCompositionCampaignInfoOk returns a tuple with the RoleCompositionCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleCompositionCampaignInfo + +`func (o *GetCampaign200Response) SetRoleCompositionCampaignInfo(v CampaignAllOfRoleCompositionCampaignInfo)` + +SetRoleCompositionCampaignInfo sets RoleCompositionCampaignInfo field to given value. + +### HasRoleCompositionCampaignInfo + +`func (o *GetCampaign200Response) HasRoleCompositionCampaignInfo() bool` + +HasRoleCompositionCampaignInfo returns a boolean if a field has been set. + +### SetRoleCompositionCampaignInfoNil + +`func (o *GetCampaign200Response) SetRoleCompositionCampaignInfoNil(b bool)` + + SetRoleCompositionCampaignInfoNil sets the value for RoleCompositionCampaignInfo to be an explicit nil + +### UnsetRoleCompositionCampaignInfo +`func (o *GetCampaign200Response) UnsetRoleCompositionCampaignInfo()` + +UnsetRoleCompositionCampaignInfo ensures that no value is present for RoleCompositionCampaignInfo, not even an explicit nil +### GetMachineAccountCampaignInfo + +`func (o *GetCampaign200Response) GetMachineAccountCampaignInfo() CampaignAllOfMachineAccountCampaignInfo` + +GetMachineAccountCampaignInfo returns the MachineAccountCampaignInfo field if non-nil, zero value otherwise. + +### GetMachineAccountCampaignInfoOk + +`func (o *GetCampaign200Response) GetMachineAccountCampaignInfoOk() (*CampaignAllOfMachineAccountCampaignInfo, bool)` + +GetMachineAccountCampaignInfoOk returns a tuple with the MachineAccountCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMachineAccountCampaignInfo + +`func (o *GetCampaign200Response) SetMachineAccountCampaignInfo(v CampaignAllOfMachineAccountCampaignInfo)` + +SetMachineAccountCampaignInfo sets MachineAccountCampaignInfo field to given value. + +### HasMachineAccountCampaignInfo + +`func (o *GetCampaign200Response) HasMachineAccountCampaignInfo() bool` + +HasMachineAccountCampaignInfo returns a boolean if a field has been set. + +### SetMachineAccountCampaignInfoNil + +`func (o *GetCampaign200Response) SetMachineAccountCampaignInfoNil(b bool)` + + SetMachineAccountCampaignInfoNil sets the value for MachineAccountCampaignInfo to be an explicit nil + +### UnsetMachineAccountCampaignInfo +`func (o *GetCampaign200Response) UnsetMachineAccountCampaignInfo()` + +UnsetMachineAccountCampaignInfo ensures that no value is present for MachineAccountCampaignInfo, not even an explicit nil +### GetSourcesWithOrphanEntitlements + +`func (o *GetCampaign200Response) GetSourcesWithOrphanEntitlements() []CampaignAllOfSourcesWithOrphanEntitlements` + +GetSourcesWithOrphanEntitlements returns the SourcesWithOrphanEntitlements field if non-nil, zero value otherwise. + +### GetSourcesWithOrphanEntitlementsOk + +`func (o *GetCampaign200Response) GetSourcesWithOrphanEntitlementsOk() (*[]CampaignAllOfSourcesWithOrphanEntitlements, bool)` + +GetSourcesWithOrphanEntitlementsOk returns a tuple with the SourcesWithOrphanEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourcesWithOrphanEntitlements + +`func (o *GetCampaign200Response) SetSourcesWithOrphanEntitlements(v []CampaignAllOfSourcesWithOrphanEntitlements)` + +SetSourcesWithOrphanEntitlements sets SourcesWithOrphanEntitlements field to given value. + +### HasSourcesWithOrphanEntitlements + +`func (o *GetCampaign200Response) HasSourcesWithOrphanEntitlements() bool` + +HasSourcesWithOrphanEntitlements returns a boolean if a field has been set. + +### SetSourcesWithOrphanEntitlementsNil + +`func (o *GetCampaign200Response) SetSourcesWithOrphanEntitlementsNil(b bool)` + + SetSourcesWithOrphanEntitlementsNil sets the value for SourcesWithOrphanEntitlements to be an explicit nil + +### UnsetSourcesWithOrphanEntitlements +`func (o *GetCampaign200Response) UnsetSourcesWithOrphanEntitlements()` + +UnsetSourcesWithOrphanEntitlements ensures that no value is present for SourcesWithOrphanEntitlements, not even an explicit nil +### GetMandatoryCommentRequirement + +`func (o *GetCampaign200Response) GetMandatoryCommentRequirement() string` + +GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise. + +### GetMandatoryCommentRequirementOk + +`func (o *GetCampaign200Response) GetMandatoryCommentRequirementOk() (*string, bool)` + +GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMandatoryCommentRequirement + +`func (o *GetCampaign200Response) SetMandatoryCommentRequirement(v string)` + +SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value. + +### HasMandatoryCommentRequirement + +`func (o *GetCampaign200Response) HasMandatoryCommentRequirement() bool` + +HasMandatoryCommentRequirement returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/GetDiscoveredApplications200ResponseInner.md b/docs/tools/sdk/go/Reference/V2024/Models/GetDiscoveredApplications200ResponseInner.md new file mode 100644 index 000000000..1fb6e89fe --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/GetDiscoveredApplications200ResponseInner.md @@ -0,0 +1,298 @@ +--- +id: v2024-get-discovered-applications200-response-inner +title: GetDiscoveredApplications200ResponseInner +pagination_label: GetDiscoveredApplications200ResponseInner +sidebar_label: GetDiscoveredApplications200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetDiscoveredApplications200ResponseInner', 'V2024GetDiscoveredApplications200ResponseInner'] +slug: /tools/sdk/go/v2024/models/get-discovered-applications200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetDiscoveredApplications200ResponseInner', 'V2024GetDiscoveredApplications200ResponseInner'] +--- + +# GetDiscoveredApplications200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **string** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **string** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **string** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **string** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]string** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **SailPointTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **string** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [optional] +**AssociatedSources** | Pointer to **[]string** | List of associated sources related to this discovered application. | [optional] + +## Methods + +### NewGetDiscoveredApplications200ResponseInner + +`func NewGetDiscoveredApplications200ResponseInner() *GetDiscoveredApplications200ResponseInner` + +NewGetDiscoveredApplications200ResponseInner instantiates a new GetDiscoveredApplications200ResponseInner 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 + +### NewGetDiscoveredApplications200ResponseInnerWithDefaults + +`func NewGetDiscoveredApplications200ResponseInnerWithDefaults() *GetDiscoveredApplications200ResponseInner` + +NewGetDiscoveredApplications200ResponseInnerWithDefaults instantiates a new GetDiscoveredApplications200ResponseInner 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 + +### GetId + +`func (o *GetDiscoveredApplications200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetDiscoveredApplications200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetDiscoveredApplications200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *GetDiscoveredApplications200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetDiscoveredApplications200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *GetDiscoveredApplications200ResponseInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDiscoverySource + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoverySource() string` + +GetDiscoverySource returns the DiscoverySource field if non-nil, zero value otherwise. + +### GetDiscoverySourceOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoverySourceOk() (*string, bool)` + +GetDiscoverySourceOk returns a tuple with the DiscoverySource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoverySource + +`func (o *GetDiscoveredApplications200ResponseInner) SetDiscoverySource(v string)` + +SetDiscoverySource sets DiscoverySource field to given value. + +### HasDiscoverySource + +`func (o *GetDiscoveredApplications200ResponseInner) HasDiscoverySource() bool` + +HasDiscoverySource returns a boolean if a field has been set. + +### GetDiscoveredVendor + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoveredVendor() string` + +GetDiscoveredVendor returns the DiscoveredVendor field if non-nil, zero value otherwise. + +### GetDiscoveredVendorOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoveredVendorOk() (*string, bool)` + +GetDiscoveredVendorOk returns a tuple with the DiscoveredVendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredVendor + +`func (o *GetDiscoveredApplications200ResponseInner) SetDiscoveredVendor(v string)` + +SetDiscoveredVendor sets DiscoveredVendor field to given value. + +### HasDiscoveredVendor + +`func (o *GetDiscoveredApplications200ResponseInner) HasDiscoveredVendor() bool` + +HasDiscoveredVendor returns a boolean if a field has been set. + +### GetDescription + +`func (o *GetDiscoveredApplications200ResponseInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *GetDiscoveredApplications200ResponseInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *GetDiscoveredApplications200ResponseInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetRecommendedConnectors + +`func (o *GetDiscoveredApplications200ResponseInner) GetRecommendedConnectors() []string` + +GetRecommendedConnectors returns the RecommendedConnectors field if non-nil, zero value otherwise. + +### GetRecommendedConnectorsOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetRecommendedConnectorsOk() (*[]string, bool)` + +GetRecommendedConnectorsOk returns a tuple with the RecommendedConnectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendedConnectors + +`func (o *GetDiscoveredApplications200ResponseInner) SetRecommendedConnectors(v []string)` + +SetRecommendedConnectors sets RecommendedConnectors field to given value. + +### HasRecommendedConnectors + +`func (o *GetDiscoveredApplications200ResponseInner) HasRecommendedConnectors() bool` + +HasRecommendedConnectors returns a boolean if a field has been set. + +### GetDiscoveredAt + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoveredAt() SailPointTime` + +GetDiscoveredAt returns the DiscoveredAt field if non-nil, zero value otherwise. + +### GetDiscoveredAtOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoveredAtOk() (*SailPointTime, bool)` + +GetDiscoveredAtOk returns a tuple with the DiscoveredAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredAt + +`func (o *GetDiscoveredApplications200ResponseInner) SetDiscoveredAt(v SailPointTime)` + +SetDiscoveredAt sets DiscoveredAt field to given value. + +### HasDiscoveredAt + +`func (o *GetDiscoveredApplications200ResponseInner) HasDiscoveredAt() bool` + +HasDiscoveredAt returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *GetDiscoveredApplications200ResponseInner) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *GetDiscoveredApplications200ResponseInner) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *GetDiscoveredApplications200ResponseInner) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetStatus + +`func (o *GetDiscoveredApplications200ResponseInner) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GetDiscoveredApplications200ResponseInner) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GetDiscoveredApplications200ResponseInner) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetAssociatedSources + +`func (o *GetDiscoveredApplications200ResponseInner) GetAssociatedSources() []string` + +GetAssociatedSources returns the AssociatedSources field if non-nil, zero value otherwise. + +### GetAssociatedSourcesOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetAssociatedSourcesOk() (*[]string, bool)` + +GetAssociatedSourcesOk returns a tuple with the AssociatedSources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociatedSources + +`func (o *GetDiscoveredApplications200ResponseInner) SetAssociatedSources(v []string)` + +SetAssociatedSources sets AssociatedSources field to given value. + +### HasAssociatedSources + +`func (o *GetDiscoveredApplications200ResponseInner) HasAssociatedSources() bool` + +HasAssociatedSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/GetHistoricalIdentityEvents200ResponseInner.md b/docs/tools/sdk/go/Reference/V2024/Models/GetHistoricalIdentityEvents200ResponseInner.md new file mode 100644 index 000000000..656825257 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/GetHistoricalIdentityEvents200ResponseInner.md @@ -0,0 +1,428 @@ +--- +id: v2024-get-historical-identity-events200-response-inner +title: GetHistoricalIdentityEvents200ResponseInner +pagination_label: GetHistoricalIdentityEvents200ResponseInner +sidebar_label: GetHistoricalIdentityEvents200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetHistoricalIdentityEvents200ResponseInner', 'V2024GetHistoricalIdentityEvents200ResponseInner'] +slug: /tools/sdk/go/v2024/models/get-historical-identity-events200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetHistoricalIdentityEvents200ResponseInner', 'V2024GetHistoricalIdentityEvents200ResponseInner'] +--- + +# GetHistoricalIdentityEvents200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] +**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] +**Changes** | Pointer to [**[]AttributeChange**](attribute-change) | | [optional] +**AccessRequest** | Pointer to [**AccessRequestResponse1**](access-request-response1) | | [optional] +**CertificationId** | Pointer to **string** | the id of the certification item | [optional] +**CertificationName** | Pointer to **string** | the certification item name | [optional] +**SignedDate** | Pointer to **string** | the date ceritification was signed | [optional] +**Certifiers** | Pointer to [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional] +**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional] +**Signer** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] +**Account** | Pointer to [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] +**StatusChange** | Pointer to [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional] + +## Methods + +### NewGetHistoricalIdentityEvents200ResponseInner + +`func NewGetHistoricalIdentityEvents200ResponseInner() *GetHistoricalIdentityEvents200ResponseInner` + +NewGetHistoricalIdentityEvents200ResponseInner instantiates a new GetHistoricalIdentityEvents200ResponseInner 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 + +### NewGetHistoricalIdentityEvents200ResponseInnerWithDefaults + +`func NewGetHistoricalIdentityEvents200ResponseInnerWithDefaults() *GetHistoricalIdentityEvents200ResponseInner` + +NewGetHistoricalIdentityEvents200ResponseInnerWithDefaults instantiates a new GetHistoricalIdentityEvents200ResponseInner 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 + +### GetAccessItem + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccessItem() AccessItemAssociatedAccessItem` + +GetAccessItem returns the AccessItem field if non-nil, zero value otherwise. + +### GetAccessItemOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccessItemOk() (*AccessItemAssociatedAccessItem, bool)` + +GetAccessItemOk returns a tuple with the AccessItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItem + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetAccessItem(v AccessItemAssociatedAccessItem)` + +SetAccessItem sets AccessItem field to given value. + +### HasAccessItem + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasAccessItem() bool` + +HasAccessItem returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEventType + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDt + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasDt() bool` + +HasDt returns a boolean if a field has been set. + +### GetGovernanceEvent + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetGovernanceEvent() CorrelatedGovernanceEvent` + +GetGovernanceEvent returns the GovernanceEvent field if non-nil, zero value otherwise. + +### GetGovernanceEventOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetGovernanceEventOk() (*CorrelatedGovernanceEvent, bool)` + +GetGovernanceEventOk returns a tuple with the GovernanceEvent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceEvent + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetGovernanceEvent(v CorrelatedGovernanceEvent)` + +SetGovernanceEvent sets GovernanceEvent field to given value. + +### HasGovernanceEvent + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasGovernanceEvent() bool` + +HasGovernanceEvent returns a boolean if a field has been set. + +### GetChanges + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetChanges() []AttributeChange` + +GetChanges returns the Changes field if non-nil, zero value otherwise. + +### GetChangesOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetChangesOk() (*[]AttributeChange, bool)` + +GetChangesOk returns a tuple with the Changes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanges + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetChanges(v []AttributeChange)` + +SetChanges sets Changes field to given value. + +### HasChanges + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasChanges() bool` + +HasChanges returns a boolean if a field has been set. + +### GetAccessRequest + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccessRequest() AccessRequestResponse1` + +GetAccessRequest returns the AccessRequest field if non-nil, zero value otherwise. + +### GetAccessRequestOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccessRequestOk() (*AccessRequestResponse1, bool)` + +GetAccessRequestOk returns a tuple with the AccessRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequest + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetAccessRequest(v AccessRequestResponse1)` + +SetAccessRequest sets AccessRequest field to given value. + +### HasAccessRequest + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasAccessRequest() bool` + +HasAccessRequest returns a boolean if a field has been set. + +### GetCertificationId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertificationId() string` + +GetCertificationId returns the CertificationId field if non-nil, zero value otherwise. + +### GetCertificationIdOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertificationIdOk() (*string, bool)` + +GetCertificationIdOk returns a tuple with the CertificationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetCertificationId(v string)` + +SetCertificationId sets CertificationId field to given value. + +### HasCertificationId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasCertificationId() bool` + +HasCertificationId returns a boolean if a field has been set. + +### GetCertificationName + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertificationName() string` + +GetCertificationName returns the CertificationName field if non-nil, zero value otherwise. + +### GetCertificationNameOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertificationNameOk() (*string, bool)` + +GetCertificationNameOk returns a tuple with the CertificationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationName + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetCertificationName(v string)` + +SetCertificationName sets CertificationName field to given value. + +### HasCertificationName + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasCertificationName() bool` + +HasCertificationName returns a boolean if a field has been set. + +### GetSignedDate + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetSignedDate() string` + +GetSignedDate returns the SignedDate field if non-nil, zero value otherwise. + +### GetSignedDateOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetSignedDateOk() (*string, bool)` + +GetSignedDateOk returns a tuple with the SignedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignedDate + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetSignedDate(v string)` + +SetSignedDate sets SignedDate field to given value. + +### HasSignedDate + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasSignedDate() bool` + +HasSignedDate returns a boolean if a field has been set. + +### GetCertifiers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertifiers() []CertifierResponse` + +GetCertifiers returns the Certifiers field if non-nil, zero value otherwise. + +### GetCertifiersOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertifiersOk() (*[]CertifierResponse, bool)` + +GetCertifiersOk returns a tuple with the Certifiers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertifiers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetCertifiers(v []CertifierResponse)` + +SetCertifiers sets Certifiers field to given value. + +### HasCertifiers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasCertifiers() bool` + +HasCertifiers returns a boolean if a field has been set. + +### GetReviewers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetReviewers() []CertifierResponse` + +GetReviewers returns the Reviewers field if non-nil, zero value otherwise. + +### GetReviewersOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetReviewersOk() (*[]CertifierResponse, bool)` + +GetReviewersOk returns a tuple with the Reviewers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetReviewers(v []CertifierResponse)` + +SetReviewers sets Reviewers field to given value. + +### HasReviewers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasReviewers() bool` + +HasReviewers returns a boolean if a field has been set. + +### GetSigner + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetSigner() CertifierResponse` + +GetSigner returns the Signer field if non-nil, zero value otherwise. + +### GetSignerOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetSignerOk() (*CertifierResponse, bool)` + +GetSignerOk returns a tuple with the Signer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigner + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetSigner(v CertifierResponse)` + +SetSigner sets Signer field to given value. + +### HasSigner + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasSigner() bool` + +HasSigner returns a boolean if a field has been set. + +### GetAccount + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccount() AccountStatusChangedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccountOk() (*AccountStatusChangedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetAccount(v AccountStatusChangedAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### GetStatusChange + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetStatusChange() AccountStatusChangedStatusChange` + +GetStatusChange returns the StatusChange field if non-nil, zero value otherwise. + +### GetStatusChangeOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetStatusChangeOk() (*AccountStatusChangedStatusChange, bool)` + +GetStatusChangeOk returns a tuple with the StatusChange field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusChange + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetStatusChange(v AccountStatusChangedStatusChange)` + +SetStatusChange sets StatusChange field to given value. + +### HasStatusChange + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasStatusChange() bool` + +HasStatusChange returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/GetOAuthClientResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/GetOAuthClientResponse.md new file mode 100644 index 000000000..63bdbbcb6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/GetOAuthClientResponse.md @@ -0,0 +1,574 @@ +--- +id: v2024-get-o-auth-client-response +title: GetOAuthClientResponse +pagination_label: GetOAuthClientResponse +sidebar_label: GetOAuthClientResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetOAuthClientResponse', 'V2024GetOAuthClientResponse'] +slug: /tools/sdk/go/v2024/models/get-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'GetOAuthClientResponse', 'V2024GetOAuthClientResponse'] +--- + +# GetOAuthClientResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the OAuth client | +**BusinessName** | **NullableString** | The name of the business the API Client should belong to | +**HomepageUrl** | **NullableString** | The homepage URL associated with the owner of the API Client | +**Name** | **string** | A human-readable name for the API Client | +**Description** | **NullableString** | A description of the API Client | +**AccessTokenValiditySeconds** | **int32** | The number of seconds an access token generated for this API Client is valid for | +**RefreshTokenValiditySeconds** | **int32** | The number of seconds a refresh token generated for this API Client is valid for | +**RedirectUris** | **[]string** | A list of the approved redirect URIs used with the authorization_code flow | +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | +**AccessType** | [**AccessType**](access-type) | | +**Type** | [**ClientType**](client-type) | | +**Internal** | **bool** | An indicator of whether the API Client can be used for requests internal to IDN | +**Enabled** | **bool** | An indicator of whether the API Client is enabled for use | +**StrongAuthSupported** | **bool** | An indicator of whether the API Client supports strong authentication | +**ClaimsSupported** | **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | +**Created** | **SailPointTime** | The date and time, down to the millisecond, when the API Client was created | +**Modified** | **SailPointTime** | The date and time, down to the millisecond, when the API Client was last updated | +**Secret** | Pointer to **NullableString** | | [optional] +**Metadata** | Pointer to **NullableString** | | [optional] +**LastUsed** | Pointer to **NullableTime** | The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. | [optional] +**Scope** | **[]string** | Scopes of the API Client. | + +## Methods + +### NewGetOAuthClientResponse + +`func NewGetOAuthClientResponse(id string, businessName NullableString, homepageUrl NullableString, name string, description NullableString, accessTokenValiditySeconds int32, refreshTokenValiditySeconds int32, redirectUris []string, grantTypes []GrantType, accessType AccessType, type_ ClientType, internal bool, enabled bool, strongAuthSupported bool, claimsSupported bool, created SailPointTime, modified SailPointTime, scope []string, ) *GetOAuthClientResponse` + +NewGetOAuthClientResponse instantiates a new GetOAuthClientResponse 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 + +### NewGetOAuthClientResponseWithDefaults + +`func NewGetOAuthClientResponseWithDefaults() *GetOAuthClientResponse` + +NewGetOAuthClientResponseWithDefaults instantiates a new GetOAuthClientResponse 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 + +### GetId + +`func (o *GetOAuthClientResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetOAuthClientResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetOAuthClientResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetBusinessName + +`func (o *GetOAuthClientResponse) GetBusinessName() string` + +GetBusinessName returns the BusinessName field if non-nil, zero value otherwise. + +### GetBusinessNameOk + +`func (o *GetOAuthClientResponse) GetBusinessNameOk() (*string, bool)` + +GetBusinessNameOk returns a tuple with the BusinessName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBusinessName + +`func (o *GetOAuthClientResponse) SetBusinessName(v string)` + +SetBusinessName sets BusinessName field to given value. + + +### SetBusinessNameNil + +`func (o *GetOAuthClientResponse) SetBusinessNameNil(b bool)` + + SetBusinessNameNil sets the value for BusinessName to be an explicit nil + +### UnsetBusinessName +`func (o *GetOAuthClientResponse) UnsetBusinessName()` + +UnsetBusinessName ensures that no value is present for BusinessName, not even an explicit nil +### GetHomepageUrl + +`func (o *GetOAuthClientResponse) GetHomepageUrl() string` + +GetHomepageUrl returns the HomepageUrl field if non-nil, zero value otherwise. + +### GetHomepageUrlOk + +`func (o *GetOAuthClientResponse) GetHomepageUrlOk() (*string, bool)` + +GetHomepageUrlOk returns a tuple with the HomepageUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHomepageUrl + +`func (o *GetOAuthClientResponse) SetHomepageUrl(v string)` + +SetHomepageUrl sets HomepageUrl field to given value. + + +### SetHomepageUrlNil + +`func (o *GetOAuthClientResponse) SetHomepageUrlNil(b bool)` + + SetHomepageUrlNil sets the value for HomepageUrl to be an explicit nil + +### UnsetHomepageUrl +`func (o *GetOAuthClientResponse) UnsetHomepageUrl()` + +UnsetHomepageUrl ensures that no value is present for HomepageUrl, not even an explicit nil +### GetName + +`func (o *GetOAuthClientResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetOAuthClientResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetOAuthClientResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *GetOAuthClientResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *GetOAuthClientResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *GetOAuthClientResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *GetOAuthClientResponse) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *GetOAuthClientResponse) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAccessTokenValiditySeconds + +`func (o *GetOAuthClientResponse) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *GetOAuthClientResponse) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *GetOAuthClientResponse) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + + +### GetRefreshTokenValiditySeconds + +`func (o *GetOAuthClientResponse) GetRefreshTokenValiditySeconds() int32` + +GetRefreshTokenValiditySeconds returns the RefreshTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetRefreshTokenValiditySecondsOk + +`func (o *GetOAuthClientResponse) GetRefreshTokenValiditySecondsOk() (*int32, bool)` + +GetRefreshTokenValiditySecondsOk returns a tuple with the RefreshTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenValiditySeconds + +`func (o *GetOAuthClientResponse) SetRefreshTokenValiditySeconds(v int32)` + +SetRefreshTokenValiditySeconds sets RefreshTokenValiditySeconds field to given value. + + +### GetRedirectUris + +`func (o *GetOAuthClientResponse) GetRedirectUris() []string` + +GetRedirectUris returns the RedirectUris field if non-nil, zero value otherwise. + +### GetRedirectUrisOk + +`func (o *GetOAuthClientResponse) GetRedirectUrisOk() (*[]string, bool)` + +GetRedirectUrisOk returns a tuple with the RedirectUris field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedirectUris + +`func (o *GetOAuthClientResponse) SetRedirectUris(v []string)` + +SetRedirectUris sets RedirectUris field to given value. + + +### SetRedirectUrisNil + +`func (o *GetOAuthClientResponse) SetRedirectUrisNil(b bool)` + + SetRedirectUrisNil sets the value for RedirectUris to be an explicit nil + +### UnsetRedirectUris +`func (o *GetOAuthClientResponse) UnsetRedirectUris()` + +UnsetRedirectUris ensures that no value is present for RedirectUris, not even an explicit nil +### GetGrantTypes + +`func (o *GetOAuthClientResponse) GetGrantTypes() []GrantType` + +GetGrantTypes returns the GrantTypes field if non-nil, zero value otherwise. + +### GetGrantTypesOk + +`func (o *GetOAuthClientResponse) GetGrantTypesOk() (*[]GrantType, bool)` + +GetGrantTypesOk returns a tuple with the GrantTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantTypes + +`func (o *GetOAuthClientResponse) SetGrantTypes(v []GrantType)` + +SetGrantTypes sets GrantTypes field to given value. + + +### GetAccessType + +`func (o *GetOAuthClientResponse) GetAccessType() AccessType` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *GetOAuthClientResponse) GetAccessTypeOk() (*AccessType, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *GetOAuthClientResponse) SetAccessType(v AccessType)` + +SetAccessType sets AccessType field to given value. + + +### GetType + +`func (o *GetOAuthClientResponse) GetType() ClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *GetOAuthClientResponse) GetTypeOk() (*ClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *GetOAuthClientResponse) SetType(v ClientType)` + +SetType sets Type field to given value. + + +### GetInternal + +`func (o *GetOAuthClientResponse) GetInternal() bool` + +GetInternal returns the Internal field if non-nil, zero value otherwise. + +### GetInternalOk + +`func (o *GetOAuthClientResponse) GetInternalOk() (*bool, bool)` + +GetInternalOk returns a tuple with the Internal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternal + +`func (o *GetOAuthClientResponse) SetInternal(v bool)` + +SetInternal sets Internal field to given value. + + +### GetEnabled + +`func (o *GetOAuthClientResponse) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *GetOAuthClientResponse) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *GetOAuthClientResponse) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetStrongAuthSupported + +`func (o *GetOAuthClientResponse) GetStrongAuthSupported() bool` + +GetStrongAuthSupported returns the StrongAuthSupported field if non-nil, zero value otherwise. + +### GetStrongAuthSupportedOk + +`func (o *GetOAuthClientResponse) GetStrongAuthSupportedOk() (*bool, bool)` + +GetStrongAuthSupportedOk returns a tuple with the StrongAuthSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStrongAuthSupported + +`func (o *GetOAuthClientResponse) SetStrongAuthSupported(v bool)` + +SetStrongAuthSupported sets StrongAuthSupported field to given value. + + +### GetClaimsSupported + +`func (o *GetOAuthClientResponse) GetClaimsSupported() bool` + +GetClaimsSupported returns the ClaimsSupported field if non-nil, zero value otherwise. + +### GetClaimsSupportedOk + +`func (o *GetOAuthClientResponse) GetClaimsSupportedOk() (*bool, bool)` + +GetClaimsSupportedOk returns a tuple with the ClaimsSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClaimsSupported + +`func (o *GetOAuthClientResponse) SetClaimsSupported(v bool)` + +SetClaimsSupported sets ClaimsSupported field to given value. + + +### GetCreated + +`func (o *GetOAuthClientResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GetOAuthClientResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *GetOAuthClientResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *GetOAuthClientResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *GetOAuthClientResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *GetOAuthClientResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetSecret + +`func (o *GetOAuthClientResponse) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *GetOAuthClientResponse) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *GetOAuthClientResponse) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *GetOAuthClientResponse) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### SetSecretNil + +`func (o *GetOAuthClientResponse) SetSecretNil(b bool)` + + SetSecretNil sets the value for Secret to be an explicit nil + +### UnsetSecret +`func (o *GetOAuthClientResponse) UnsetSecret()` + +UnsetSecret ensures that no value is present for Secret, not even an explicit nil +### GetMetadata + +`func (o *GetOAuthClientResponse) GetMetadata() string` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetOAuthClientResponse) GetMetadataOk() (*string, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetOAuthClientResponse) SetMetadata(v string)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetOAuthClientResponse) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### SetMetadataNil + +`func (o *GetOAuthClientResponse) SetMetadataNil(b bool)` + + SetMetadataNil sets the value for Metadata to be an explicit nil + +### UnsetMetadata +`func (o *GetOAuthClientResponse) UnsetMetadata()` + +UnsetMetadata ensures that no value is present for Metadata, not even an explicit nil +### GetLastUsed + +`func (o *GetOAuthClientResponse) GetLastUsed() SailPointTime` + +GetLastUsed returns the LastUsed field if non-nil, zero value otherwise. + +### GetLastUsedOk + +`func (o *GetOAuthClientResponse) GetLastUsedOk() (*SailPointTime, bool)` + +GetLastUsedOk returns a tuple with the LastUsed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUsed + +`func (o *GetOAuthClientResponse) SetLastUsed(v SailPointTime)` + +SetLastUsed sets LastUsed field to given value. + +### HasLastUsed + +`func (o *GetOAuthClientResponse) HasLastUsed() bool` + +HasLastUsed returns a boolean if a field has been set. + +### SetLastUsedNil + +`func (o *GetOAuthClientResponse) SetLastUsedNil(b bool)` + + SetLastUsedNil sets the value for LastUsed to be an explicit nil + +### UnsetLastUsed +`func (o *GetOAuthClientResponse) UnsetLastUsed()` + +UnsetLastUsed ensures that no value is present for LastUsed, not even an explicit nil +### GetScope + +`func (o *GetOAuthClientResponse) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *GetOAuthClientResponse) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *GetOAuthClientResponse) SetScope(v []string)` + +SetScope sets Scope field to given value. + + +### SetScopeNil + +`func (o *GetOAuthClientResponse) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *GetOAuthClientResponse) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/GetPersonalAccessTokenResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/GetPersonalAccessTokenResponse.md new file mode 100644 index 000000000..fb59e7ed3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/GetPersonalAccessTokenResponse.md @@ -0,0 +1,215 @@ +--- +id: v2024-get-personal-access-token-response +title: GetPersonalAccessTokenResponse +pagination_label: GetPersonalAccessTokenResponse +sidebar_label: GetPersonalAccessTokenResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetPersonalAccessTokenResponse', 'V2024GetPersonalAccessTokenResponse'] +slug: /tools/sdk/go/v2024/models/get-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'GetPersonalAccessTokenResponse', 'V2024GetPersonalAccessTokenResponse'] +--- + +# GetPersonalAccessTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The ID of the personal access token (to be used as the username for Basic Auth). | +**Name** | **string** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | +**Scope** | **[]string** | Scopes of the personal access token. | +**Owner** | [**PatOwner**](pat-owner) | | +**Created** | **SailPointTime** | The date and time, down to the millisecond, when this personal access token was created. | +**LastUsed** | Pointer to **NullableTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional] +**Managed** | Pointer to **bool** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to false] + +## Methods + +### NewGetPersonalAccessTokenResponse + +`func NewGetPersonalAccessTokenResponse(id string, name string, scope []string, owner PatOwner, created SailPointTime, ) *GetPersonalAccessTokenResponse` + +NewGetPersonalAccessTokenResponse instantiates a new GetPersonalAccessTokenResponse 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 + +### NewGetPersonalAccessTokenResponseWithDefaults + +`func NewGetPersonalAccessTokenResponseWithDefaults() *GetPersonalAccessTokenResponse` + +NewGetPersonalAccessTokenResponseWithDefaults instantiates a new GetPersonalAccessTokenResponse 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 + +### GetId + +`func (o *GetPersonalAccessTokenResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetPersonalAccessTokenResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetPersonalAccessTokenResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *GetPersonalAccessTokenResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetPersonalAccessTokenResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetPersonalAccessTokenResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetScope + +`func (o *GetPersonalAccessTokenResponse) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *GetPersonalAccessTokenResponse) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *GetPersonalAccessTokenResponse) SetScope(v []string)` + +SetScope sets Scope field to given value. + + +### SetScopeNil + +`func (o *GetPersonalAccessTokenResponse) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *GetPersonalAccessTokenResponse) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil +### GetOwner + +`func (o *GetPersonalAccessTokenResponse) GetOwner() PatOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *GetPersonalAccessTokenResponse) GetOwnerOk() (*PatOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *GetPersonalAccessTokenResponse) SetOwner(v PatOwner)` + +SetOwner sets Owner field to given value. + + +### GetCreated + +`func (o *GetPersonalAccessTokenResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GetPersonalAccessTokenResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *GetPersonalAccessTokenResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetLastUsed + +`func (o *GetPersonalAccessTokenResponse) GetLastUsed() SailPointTime` + +GetLastUsed returns the LastUsed field if non-nil, zero value otherwise. + +### GetLastUsedOk + +`func (o *GetPersonalAccessTokenResponse) GetLastUsedOk() (*SailPointTime, bool)` + +GetLastUsedOk returns a tuple with the LastUsed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUsed + +`func (o *GetPersonalAccessTokenResponse) SetLastUsed(v SailPointTime)` + +SetLastUsed sets LastUsed field to given value. + +### HasLastUsed + +`func (o *GetPersonalAccessTokenResponse) HasLastUsed() bool` + +HasLastUsed returns a boolean if a field has been set. + +### SetLastUsedNil + +`func (o *GetPersonalAccessTokenResponse) SetLastUsedNil(b bool)` + + SetLastUsedNil sets the value for LastUsed to be an explicit nil + +### UnsetLastUsed +`func (o *GetPersonalAccessTokenResponse) UnsetLastUsed()` + +UnsetLastUsed ensures that no value is present for LastUsed, not even an explicit nil +### GetManaged + +`func (o *GetPersonalAccessTokenResponse) GetManaged() bool` + +GetManaged returns the Managed field if non-nil, zero value otherwise. + +### GetManagedOk + +`func (o *GetPersonalAccessTokenResponse) GetManagedOk() (*bool, bool)` + +GetManagedOk returns a tuple with the Managed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManaged + +`func (o *GetPersonalAccessTokenResponse) SetManaged(v bool)` + +SetManaged sets Managed field to given value. + +### HasManaged + +`func (o *GetPersonalAccessTokenResponse) HasManaged() bool` + +HasManaged returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/GetRoleAssignments200ResponseInner.md b/docs/tools/sdk/go/Reference/V2024/Models/GetRoleAssignments200ResponseInner.md new file mode 100644 index 000000000..63b2052aa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/GetRoleAssignments200ResponseInner.md @@ -0,0 +1,292 @@ +--- +id: v2024-get-role-assignments200-response-inner +title: GetRoleAssignments200ResponseInner +pagination_label: GetRoleAssignments200ResponseInner +sidebar_label: GetRoleAssignments200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetRoleAssignments200ResponseInner', 'V2024GetRoleAssignments200ResponseInner'] +slug: /tools/sdk/go/v2024/models/get-role-assignments200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetRoleAssignments200ResponseInner', 'V2024GetRoleAssignments200ResponseInner'] +--- + +# GetRoleAssignments200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Assignment Id | [optional] +**Role** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] +**Comments** | Pointer to **NullableString** | Comments added by the user when the assignment was made | [optional] +**AssignmentSource** | Pointer to **string** | Source describing how this assignment was made | [optional] +**Assigner** | Pointer to [**RoleAssignmentDtoAssigner**](role-assignment-dto-assigner) | | [optional] +**AssignedDimensions** | Pointer to [**[]BaseReferenceDto**](base-reference-dto) | Dimensions assigned related to this role | [optional] +**AssignmentContext** | Pointer to [**RoleAssignmentDtoAssignmentContext**](role-assignment-dto-assignment-context) | | [optional] +**AccountTargets** | Pointer to [**[]RoleTargetDto**](role-target-dto) | | [optional] +**RemoveDate** | Pointer to **NullableString** | Date that the assignment will be removed | [optional] + +## Methods + +### NewGetRoleAssignments200ResponseInner + +`func NewGetRoleAssignments200ResponseInner() *GetRoleAssignments200ResponseInner` + +NewGetRoleAssignments200ResponseInner instantiates a new GetRoleAssignments200ResponseInner 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 + +### NewGetRoleAssignments200ResponseInnerWithDefaults + +`func NewGetRoleAssignments200ResponseInnerWithDefaults() *GetRoleAssignments200ResponseInner` + +NewGetRoleAssignments200ResponseInnerWithDefaults instantiates a new GetRoleAssignments200ResponseInner 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 + +### GetId + +`func (o *GetRoleAssignments200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetRoleAssignments200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetRoleAssignments200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetRoleAssignments200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRole + +`func (o *GetRoleAssignments200ResponseInner) GetRole() BaseReferenceDto` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *GetRoleAssignments200ResponseInner) GetRoleOk() (*BaseReferenceDto, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *GetRoleAssignments200ResponseInner) SetRole(v BaseReferenceDto)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *GetRoleAssignments200ResponseInner) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetComments + +`func (o *GetRoleAssignments200ResponseInner) GetComments() string` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *GetRoleAssignments200ResponseInner) GetCommentsOk() (*string, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *GetRoleAssignments200ResponseInner) SetComments(v string)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *GetRoleAssignments200ResponseInner) HasComments() bool` + +HasComments returns a boolean if a field has been set. + +### SetCommentsNil + +`func (o *GetRoleAssignments200ResponseInner) SetCommentsNil(b bool)` + + SetCommentsNil sets the value for Comments to be an explicit nil + +### UnsetComments +`func (o *GetRoleAssignments200ResponseInner) UnsetComments()` + +UnsetComments ensures that no value is present for Comments, not even an explicit nil +### GetAssignmentSource + +`func (o *GetRoleAssignments200ResponseInner) GetAssignmentSource() string` + +GetAssignmentSource returns the AssignmentSource field if non-nil, zero value otherwise. + +### GetAssignmentSourceOk + +`func (o *GetRoleAssignments200ResponseInner) GetAssignmentSourceOk() (*string, bool)` + +GetAssignmentSourceOk returns a tuple with the AssignmentSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentSource + +`func (o *GetRoleAssignments200ResponseInner) SetAssignmentSource(v string)` + +SetAssignmentSource sets AssignmentSource field to given value. + +### HasAssignmentSource + +`func (o *GetRoleAssignments200ResponseInner) HasAssignmentSource() bool` + +HasAssignmentSource returns a boolean if a field has been set. + +### GetAssigner + +`func (o *GetRoleAssignments200ResponseInner) GetAssigner() RoleAssignmentDtoAssigner` + +GetAssigner returns the Assigner field if non-nil, zero value otherwise. + +### GetAssignerOk + +`func (o *GetRoleAssignments200ResponseInner) GetAssignerOk() (*RoleAssignmentDtoAssigner, bool)` + +GetAssignerOk returns a tuple with the Assigner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssigner + +`func (o *GetRoleAssignments200ResponseInner) SetAssigner(v RoleAssignmentDtoAssigner)` + +SetAssigner sets Assigner field to given value. + +### HasAssigner + +`func (o *GetRoleAssignments200ResponseInner) HasAssigner() bool` + +HasAssigner returns a boolean if a field has been set. + +### GetAssignedDimensions + +`func (o *GetRoleAssignments200ResponseInner) GetAssignedDimensions() []BaseReferenceDto` + +GetAssignedDimensions returns the AssignedDimensions field if non-nil, zero value otherwise. + +### GetAssignedDimensionsOk + +`func (o *GetRoleAssignments200ResponseInner) GetAssignedDimensionsOk() (*[]BaseReferenceDto, bool)` + +GetAssignedDimensionsOk returns a tuple with the AssignedDimensions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignedDimensions + +`func (o *GetRoleAssignments200ResponseInner) SetAssignedDimensions(v []BaseReferenceDto)` + +SetAssignedDimensions sets AssignedDimensions field to given value. + +### HasAssignedDimensions + +`func (o *GetRoleAssignments200ResponseInner) HasAssignedDimensions() bool` + +HasAssignedDimensions returns a boolean if a field has been set. + +### GetAssignmentContext + +`func (o *GetRoleAssignments200ResponseInner) GetAssignmentContext() RoleAssignmentDtoAssignmentContext` + +GetAssignmentContext returns the AssignmentContext field if non-nil, zero value otherwise. + +### GetAssignmentContextOk + +`func (o *GetRoleAssignments200ResponseInner) GetAssignmentContextOk() (*RoleAssignmentDtoAssignmentContext, bool)` + +GetAssignmentContextOk returns a tuple with the AssignmentContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentContext + +`func (o *GetRoleAssignments200ResponseInner) SetAssignmentContext(v RoleAssignmentDtoAssignmentContext)` + +SetAssignmentContext sets AssignmentContext field to given value. + +### HasAssignmentContext + +`func (o *GetRoleAssignments200ResponseInner) HasAssignmentContext() bool` + +HasAssignmentContext returns a boolean if a field has been set. + +### GetAccountTargets + +`func (o *GetRoleAssignments200ResponseInner) GetAccountTargets() []RoleTargetDto` + +GetAccountTargets returns the AccountTargets field if non-nil, zero value otherwise. + +### GetAccountTargetsOk + +`func (o *GetRoleAssignments200ResponseInner) GetAccountTargetsOk() (*[]RoleTargetDto, bool)` + +GetAccountTargetsOk returns a tuple with the AccountTargets field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountTargets + +`func (o *GetRoleAssignments200ResponseInner) SetAccountTargets(v []RoleTargetDto)` + +SetAccountTargets sets AccountTargets field to given value. + +### HasAccountTargets + +`func (o *GetRoleAssignments200ResponseInner) HasAccountTargets() bool` + +HasAccountTargets returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *GetRoleAssignments200ResponseInner) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *GetRoleAssignments200ResponseInner) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *GetRoleAssignments200ResponseInner) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *GetRoleAssignments200ResponseInner) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *GetRoleAssignments200ResponseInner) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *GetRoleAssignments200ResponseInner) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/GetTenantContext200ResponseInner.md b/docs/tools/sdk/go/Reference/V2024/Models/GetTenantContext200ResponseInner.md new file mode 100644 index 000000000..ab15aa3da --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/GetTenantContext200ResponseInner.md @@ -0,0 +1,90 @@ +--- +id: v2024-get-tenant-context200-response-inner +title: GetTenantContext200ResponseInner +pagination_label: GetTenantContext200ResponseInner +sidebar_label: GetTenantContext200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetTenantContext200ResponseInner', 'V2024GetTenantContext200ResponseInner'] +slug: /tools/sdk/go/v2024/models/get-tenant-context200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetTenantContext200ResponseInner', 'V2024GetTenantContext200ResponseInner'] +--- + +# GetTenantContext200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | | [optional] +**Value** | Pointer to **string** | | [optional] + +## Methods + +### NewGetTenantContext200ResponseInner + +`func NewGetTenantContext200ResponseInner() *GetTenantContext200ResponseInner` + +NewGetTenantContext200ResponseInner instantiates a new GetTenantContext200ResponseInner 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 + +### NewGetTenantContext200ResponseInnerWithDefaults + +`func NewGetTenantContext200ResponseInnerWithDefaults() *GetTenantContext200ResponseInner` + +NewGetTenantContext200ResponseInnerWithDefaults instantiates a new GetTenantContext200ResponseInner 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 + +### GetKey + +`func (o *GetTenantContext200ResponseInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *GetTenantContext200ResponseInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *GetTenantContext200ResponseInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *GetTenantContext200ResponseInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetValue + +`func (o *GetTenantContext200ResponseInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *GetTenantContext200ResponseInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *GetTenantContext200ResponseInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *GetTenantContext200ResponseInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/GrantType.md b/docs/tools/sdk/go/Reference/V2024/Models/GrantType.md new file mode 100644 index 000000000..d070e843f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/GrantType.md @@ -0,0 +1,23 @@ +--- +id: v2024-grant-type +title: GrantType +pagination_label: GrantType +sidebar_label: GrantType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GrantType', 'V2024GrantType'] +slug: /tools/sdk/go/v2024/models/grant-type +tags: ['SDK', 'Software Development Kit', 'GrantType', 'V2024GrantType'] +--- + +# GrantType + +## Enum + + +* `CLIENT_CREDENTIALS` (value: `"CLIENT_CREDENTIALS"`) + +* `AUTHORIZATION_CODE` (value: `"AUTHORIZATION_CODE"`) + +* `REFRESH_TOKEN` (value: `"REFRESH_TOKEN"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/HttpAuthenticationType.md b/docs/tools/sdk/go/Reference/V2024/Models/HttpAuthenticationType.md new file mode 100644 index 000000000..87874cfb4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/HttpAuthenticationType.md @@ -0,0 +1,23 @@ +--- +id: v2024-http-authentication-type +title: HttpAuthenticationType +pagination_label: HttpAuthenticationType +sidebar_label: HttpAuthenticationType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'HttpAuthenticationType', 'V2024HttpAuthenticationType'] +slug: /tools/sdk/go/v2024/models/http-authentication-type +tags: ['SDK', 'Software Development Kit', 'HttpAuthenticationType', 'V2024HttpAuthenticationType'] +--- + +# HttpAuthenticationType + +## Enum + + +* `NO_AUTH` (value: `"NO_AUTH"`) + +* `BASIC_AUTH` (value: `"BASIC_AUTH"`) + +* `BEARER_TOKEN` (value: `"BEARER_TOKEN"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/HttpConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/HttpConfig.md new file mode 100644 index 000000000..cd38fac08 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/HttpConfig.md @@ -0,0 +1,178 @@ +--- +id: v2024-http-config +title: HttpConfig +pagination_label: HttpConfig +sidebar_label: HttpConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'HttpConfig', 'V2024HttpConfig'] +slug: /tools/sdk/go/v2024/models/http-config +tags: ['SDK', 'Software Development Kit', 'HttpConfig', 'V2024HttpConfig'] +--- + +# HttpConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Url** | **string** | URL of the external/custom integration. | +**HttpDispatchMode** | [**HttpDispatchMode**](http-dispatch-mode) | | +**HttpAuthenticationType** | Pointer to [**HttpAuthenticationType**](http-authentication-type) | | [optional] [default to HTTPAUTHENTICATIONTYPE_NO_AUTH] +**BasicAuthConfig** | Pointer to [**NullableBasicAuthConfig**](basic-auth-config) | | [optional] +**BearerTokenAuthConfig** | Pointer to [**NullableBearerTokenAuthConfig**](bearer-token-auth-config) | | [optional] + +## Methods + +### NewHttpConfig + +`func NewHttpConfig(url string, httpDispatchMode HttpDispatchMode, ) *HttpConfig` + +NewHttpConfig instantiates a new HttpConfig 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 + +### NewHttpConfigWithDefaults + +`func NewHttpConfigWithDefaults() *HttpConfig` + +NewHttpConfigWithDefaults instantiates a new HttpConfig 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 + +### GetUrl + +`func (o *HttpConfig) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *HttpConfig) GetUrlOk() (*string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrl + +`func (o *HttpConfig) SetUrl(v string)` + +SetUrl sets Url field to given value. + + +### GetHttpDispatchMode + +`func (o *HttpConfig) GetHttpDispatchMode() HttpDispatchMode` + +GetHttpDispatchMode returns the HttpDispatchMode field if non-nil, zero value otherwise. + +### GetHttpDispatchModeOk + +`func (o *HttpConfig) GetHttpDispatchModeOk() (*HttpDispatchMode, bool)` + +GetHttpDispatchModeOk returns a tuple with the HttpDispatchMode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHttpDispatchMode + +`func (o *HttpConfig) SetHttpDispatchMode(v HttpDispatchMode)` + +SetHttpDispatchMode sets HttpDispatchMode field to given value. + + +### GetHttpAuthenticationType + +`func (o *HttpConfig) GetHttpAuthenticationType() HttpAuthenticationType` + +GetHttpAuthenticationType returns the HttpAuthenticationType field if non-nil, zero value otherwise. + +### GetHttpAuthenticationTypeOk + +`func (o *HttpConfig) GetHttpAuthenticationTypeOk() (*HttpAuthenticationType, bool)` + +GetHttpAuthenticationTypeOk returns a tuple with the HttpAuthenticationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHttpAuthenticationType + +`func (o *HttpConfig) SetHttpAuthenticationType(v HttpAuthenticationType)` + +SetHttpAuthenticationType sets HttpAuthenticationType field to given value. + +### HasHttpAuthenticationType + +`func (o *HttpConfig) HasHttpAuthenticationType() bool` + +HasHttpAuthenticationType returns a boolean if a field has been set. + +### GetBasicAuthConfig + +`func (o *HttpConfig) GetBasicAuthConfig() BasicAuthConfig` + +GetBasicAuthConfig returns the BasicAuthConfig field if non-nil, zero value otherwise. + +### GetBasicAuthConfigOk + +`func (o *HttpConfig) GetBasicAuthConfigOk() (*BasicAuthConfig, bool)` + +GetBasicAuthConfigOk returns a tuple with the BasicAuthConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBasicAuthConfig + +`func (o *HttpConfig) SetBasicAuthConfig(v BasicAuthConfig)` + +SetBasicAuthConfig sets BasicAuthConfig field to given value. + +### HasBasicAuthConfig + +`func (o *HttpConfig) HasBasicAuthConfig() bool` + +HasBasicAuthConfig returns a boolean if a field has been set. + +### SetBasicAuthConfigNil + +`func (o *HttpConfig) SetBasicAuthConfigNil(b bool)` + + SetBasicAuthConfigNil sets the value for BasicAuthConfig to be an explicit nil + +### UnsetBasicAuthConfig +`func (o *HttpConfig) UnsetBasicAuthConfig()` + +UnsetBasicAuthConfig ensures that no value is present for BasicAuthConfig, not even an explicit nil +### GetBearerTokenAuthConfig + +`func (o *HttpConfig) GetBearerTokenAuthConfig() BearerTokenAuthConfig` + +GetBearerTokenAuthConfig returns the BearerTokenAuthConfig field if non-nil, zero value otherwise. + +### GetBearerTokenAuthConfigOk + +`func (o *HttpConfig) GetBearerTokenAuthConfigOk() (*BearerTokenAuthConfig, bool)` + +GetBearerTokenAuthConfigOk returns a tuple with the BearerTokenAuthConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBearerTokenAuthConfig + +`func (o *HttpConfig) SetBearerTokenAuthConfig(v BearerTokenAuthConfig)` + +SetBearerTokenAuthConfig sets BearerTokenAuthConfig field to given value. + +### HasBearerTokenAuthConfig + +`func (o *HttpConfig) HasBearerTokenAuthConfig() bool` + +HasBearerTokenAuthConfig returns a boolean if a field has been set. + +### SetBearerTokenAuthConfigNil + +`func (o *HttpConfig) SetBearerTokenAuthConfigNil(b bool)` + + SetBearerTokenAuthConfigNil sets the value for BearerTokenAuthConfig to be an explicit nil + +### UnsetBearerTokenAuthConfig +`func (o *HttpConfig) UnsetBearerTokenAuthConfig()` + +UnsetBearerTokenAuthConfig ensures that no value is present for BearerTokenAuthConfig, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/HttpDispatchMode.md b/docs/tools/sdk/go/Reference/V2024/Models/HttpDispatchMode.md new file mode 100644 index 000000000..605677105 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/HttpDispatchMode.md @@ -0,0 +1,23 @@ +--- +id: v2024-http-dispatch-mode +title: HttpDispatchMode +pagination_label: HttpDispatchMode +sidebar_label: HttpDispatchMode +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'HttpDispatchMode', 'V2024HttpDispatchMode'] +slug: /tools/sdk/go/v2024/models/http-dispatch-mode +tags: ['SDK', 'Software Development Kit', 'HttpDispatchMode', 'V2024HttpDispatchMode'] +--- + +# HttpDispatchMode + +## Enum + + +* `SYNC` (value: `"SYNC"`) + +* `ASYNC` (value: `"ASYNC"`) + +* `DYNAMIC` (value: `"DYNAMIC"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentitiesAccountsBulkRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentitiesAccountsBulkRequest.md new file mode 100644 index 000000000..0cd635183 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentitiesAccountsBulkRequest.md @@ -0,0 +1,64 @@ +--- +id: v2024-identities-accounts-bulk-request +title: IdentitiesAccountsBulkRequest +pagination_label: IdentitiesAccountsBulkRequest +sidebar_label: IdentitiesAccountsBulkRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitiesAccountsBulkRequest', 'V2024IdentitiesAccountsBulkRequest'] +slug: /tools/sdk/go/v2024/models/identities-accounts-bulk-request +tags: ['SDK', 'Software Development Kit', 'IdentitiesAccountsBulkRequest', 'V2024IdentitiesAccountsBulkRequest'] +--- + +# IdentitiesAccountsBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityIds** | Pointer to **[]string** | The ids of the identities for which enable/disable accounts. | [optional] + +## Methods + +### NewIdentitiesAccountsBulkRequest + +`func NewIdentitiesAccountsBulkRequest() *IdentitiesAccountsBulkRequest` + +NewIdentitiesAccountsBulkRequest instantiates a new IdentitiesAccountsBulkRequest 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 + +### NewIdentitiesAccountsBulkRequestWithDefaults + +`func NewIdentitiesAccountsBulkRequestWithDefaults() *IdentitiesAccountsBulkRequest` + +NewIdentitiesAccountsBulkRequestWithDefaults instantiates a new IdentitiesAccountsBulkRequest 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 + +### GetIdentityIds + +`func (o *IdentitiesAccountsBulkRequest) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *IdentitiesAccountsBulkRequest) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *IdentitiesAccountsBulkRequest) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *IdentitiesAccountsBulkRequest) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentitiesDetailsReportArguments.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentitiesDetailsReportArguments.md new file mode 100644 index 000000000..a5721078a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentitiesDetailsReportArguments.md @@ -0,0 +1,59 @@ +--- +id: v2024-identities-details-report-arguments +title: IdentitiesDetailsReportArguments +pagination_label: IdentitiesDetailsReportArguments +sidebar_label: IdentitiesDetailsReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitiesDetailsReportArguments', 'V2024IdentitiesDetailsReportArguments'] +slug: /tools/sdk/go/v2024/models/identities-details-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentitiesDetailsReportArguments', 'V2024IdentitiesDetailsReportArguments'] +--- + +# IdentitiesDetailsReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelatedOnly** | **bool** | Flag to specify if only correlated identities are included in report. | [default to false] + +## Methods + +### NewIdentitiesDetailsReportArguments + +`func NewIdentitiesDetailsReportArguments(correlatedOnly bool, ) *IdentitiesDetailsReportArguments` + +NewIdentitiesDetailsReportArguments instantiates a new IdentitiesDetailsReportArguments 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 + +### NewIdentitiesDetailsReportArgumentsWithDefaults + +`func NewIdentitiesDetailsReportArgumentsWithDefaults() *IdentitiesDetailsReportArguments` + +NewIdentitiesDetailsReportArgumentsWithDefaults instantiates a new IdentitiesDetailsReportArguments 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 + +### GetCorrelatedOnly + +`func (o *IdentitiesDetailsReportArguments) GetCorrelatedOnly() bool` + +GetCorrelatedOnly returns the CorrelatedOnly field if non-nil, zero value otherwise. + +### GetCorrelatedOnlyOk + +`func (o *IdentitiesDetailsReportArguments) GetCorrelatedOnlyOk() (*bool, bool)` + +GetCorrelatedOnlyOk returns a tuple with the CorrelatedOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedOnly + +`func (o *IdentitiesDetailsReportArguments) SetCorrelatedOnly(v bool)` + +SetCorrelatedOnly sets CorrelatedOnly field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentitiesReportArguments.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentitiesReportArguments.md new file mode 100644 index 000000000..c8b455b20 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentitiesReportArguments.md @@ -0,0 +1,64 @@ +--- +id: v2024-identities-report-arguments +title: IdentitiesReportArguments +pagination_label: IdentitiesReportArguments +sidebar_label: IdentitiesReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitiesReportArguments', 'V2024IdentitiesReportArguments'] +slug: /tools/sdk/go/v2024/models/identities-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentitiesReportArguments', 'V2024IdentitiesReportArguments'] +--- + +# IdentitiesReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelatedOnly** | Pointer to **bool** | Flag to specify if only correlated identities are included in report. | [optional] [default to false] + +## Methods + +### NewIdentitiesReportArguments + +`func NewIdentitiesReportArguments() *IdentitiesReportArguments` + +NewIdentitiesReportArguments instantiates a new IdentitiesReportArguments 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 + +### NewIdentitiesReportArgumentsWithDefaults + +`func NewIdentitiesReportArgumentsWithDefaults() *IdentitiesReportArguments` + +NewIdentitiesReportArgumentsWithDefaults instantiates a new IdentitiesReportArguments 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 + +### GetCorrelatedOnly + +`func (o *IdentitiesReportArguments) GetCorrelatedOnly() bool` + +GetCorrelatedOnly returns the CorrelatedOnly field if non-nil, zero value otherwise. + +### GetCorrelatedOnlyOk + +`func (o *IdentitiesReportArguments) GetCorrelatedOnlyOk() (*bool, bool)` + +GetCorrelatedOnlyOk returns a tuple with the CorrelatedOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedOnly + +`func (o *IdentitiesReportArguments) SetCorrelatedOnly(v bool)` + +SetCorrelatedOnly sets CorrelatedOnly field to given value. + +### HasCorrelatedOnly + +`func (o *IdentitiesReportArguments) HasCorrelatedOnly() bool` + +HasCorrelatedOnly returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Identity.md b/docs/tools/sdk/go/Reference/V2024/Models/Identity.md new file mode 100644 index 000000000..eaf65e8c7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Identity.md @@ -0,0 +1,401 @@ +--- +id: v2024-identity +title: Identity +pagination_label: Identity +sidebar_label: Identity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Identity', 'V2024Identity'] +slug: /tools/sdk/go/v2024/models/identity +tags: ['SDK', 'Software Development Kit', 'Identity', 'V2024Identity'] +--- + +# Identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the identity | [optional] [readonly] +**Name** | **string** | The identity's name is equivalent to its Display Name attribute. | +**Created** | Pointer to **SailPointTime** | Creation date of the identity | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the identity | [optional] [readonly] +**Alias** | Pointer to **string** | The identity's alternate unique identifier is equivalent to its Account Name on the authoritative source account schema. | [optional] +**EmailAddress** | Pointer to **NullableString** | The email address of the identity | [optional] +**ProcessingState** | Pointer to **NullableString** | The processing state of the identity | [optional] +**IdentityStatus** | Pointer to **string** | The identity's status in the system | [optional] +**ManagerRef** | Pointer to [**NullableIdentityManagerRef**](identity-manager-ref) | | [optional] +**IsManager** | Pointer to **bool** | Whether this identity is a manager of another identity | [optional] [default to false] +**LastRefresh** | Pointer to **SailPointTime** | The last time the identity was refreshed by the system | [optional] +**Attributes** | Pointer to **map[string]interface{}** | A map with the identity attributes for the identity | [optional] +**LifecycleState** | Pointer to [**IdentityLifecycleState**](identity-lifecycle-state) | | [optional] + +## Methods + +### NewIdentity + +`func NewIdentity(name string, ) *Identity` + +NewIdentity instantiates a new Identity 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 + +### NewIdentityWithDefaults + +`func NewIdentityWithDefaults() *Identity` + +NewIdentityWithDefaults instantiates a new Identity 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 + +### GetId + +`func (o *Identity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Identity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Identity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Identity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Identity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Identity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Identity) SetName(v string)` + +SetName sets Name field to given value. + + +### GetCreated + +`func (o *Identity) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Identity) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Identity) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Identity) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Identity) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Identity) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Identity) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Identity) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetAlias + +`func (o *Identity) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *Identity) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *Identity) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *Identity) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + +### GetEmailAddress + +`func (o *Identity) GetEmailAddress() string` + +GetEmailAddress returns the EmailAddress field if non-nil, zero value otherwise. + +### GetEmailAddressOk + +`func (o *Identity) GetEmailAddressOk() (*string, bool)` + +GetEmailAddressOk returns a tuple with the EmailAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailAddress + +`func (o *Identity) SetEmailAddress(v string)` + +SetEmailAddress sets EmailAddress field to given value. + +### HasEmailAddress + +`func (o *Identity) HasEmailAddress() bool` + +HasEmailAddress returns a boolean if a field has been set. + +### SetEmailAddressNil + +`func (o *Identity) SetEmailAddressNil(b bool)` + + SetEmailAddressNil sets the value for EmailAddress to be an explicit nil + +### UnsetEmailAddress +`func (o *Identity) UnsetEmailAddress()` + +UnsetEmailAddress ensures that no value is present for EmailAddress, not even an explicit nil +### GetProcessingState + +`func (o *Identity) GetProcessingState() string` + +GetProcessingState returns the ProcessingState field if non-nil, zero value otherwise. + +### GetProcessingStateOk + +`func (o *Identity) GetProcessingStateOk() (*string, bool)` + +GetProcessingStateOk returns a tuple with the ProcessingState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessingState + +`func (o *Identity) SetProcessingState(v string)` + +SetProcessingState sets ProcessingState field to given value. + +### HasProcessingState + +`func (o *Identity) HasProcessingState() bool` + +HasProcessingState returns a boolean if a field has been set. + +### SetProcessingStateNil + +`func (o *Identity) SetProcessingStateNil(b bool)` + + SetProcessingStateNil sets the value for ProcessingState to be an explicit nil + +### UnsetProcessingState +`func (o *Identity) UnsetProcessingState()` + +UnsetProcessingState ensures that no value is present for ProcessingState, not even an explicit nil +### GetIdentityStatus + +`func (o *Identity) GetIdentityStatus() string` + +GetIdentityStatus returns the IdentityStatus field if non-nil, zero value otherwise. + +### GetIdentityStatusOk + +`func (o *Identity) GetIdentityStatusOk() (*string, bool)` + +GetIdentityStatusOk returns a tuple with the IdentityStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityStatus + +`func (o *Identity) SetIdentityStatus(v string)` + +SetIdentityStatus sets IdentityStatus field to given value. + +### HasIdentityStatus + +`func (o *Identity) HasIdentityStatus() bool` + +HasIdentityStatus returns a boolean if a field has been set. + +### GetManagerRef + +`func (o *Identity) GetManagerRef() IdentityManagerRef` + +GetManagerRef returns the ManagerRef field if non-nil, zero value otherwise. + +### GetManagerRefOk + +`func (o *Identity) GetManagerRefOk() (*IdentityManagerRef, bool)` + +GetManagerRefOk returns a tuple with the ManagerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerRef + +`func (o *Identity) SetManagerRef(v IdentityManagerRef)` + +SetManagerRef sets ManagerRef field to given value. + +### HasManagerRef + +`func (o *Identity) HasManagerRef() bool` + +HasManagerRef returns a boolean if a field has been set. + +### SetManagerRefNil + +`func (o *Identity) SetManagerRefNil(b bool)` + + SetManagerRefNil sets the value for ManagerRef to be an explicit nil + +### UnsetManagerRef +`func (o *Identity) UnsetManagerRef()` + +UnsetManagerRef ensures that no value is present for ManagerRef, not even an explicit nil +### GetIsManager + +`func (o *Identity) GetIsManager() bool` + +GetIsManager returns the IsManager field if non-nil, zero value otherwise. + +### GetIsManagerOk + +`func (o *Identity) GetIsManagerOk() (*bool, bool)` + +GetIsManagerOk returns a tuple with the IsManager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsManager + +`func (o *Identity) SetIsManager(v bool)` + +SetIsManager sets IsManager field to given value. + +### HasIsManager + +`func (o *Identity) HasIsManager() bool` + +HasIsManager returns a boolean if a field has been set. + +### GetLastRefresh + +`func (o *Identity) GetLastRefresh() SailPointTime` + +GetLastRefresh returns the LastRefresh field if non-nil, zero value otherwise. + +### GetLastRefreshOk + +`func (o *Identity) GetLastRefreshOk() (*SailPointTime, bool)` + +GetLastRefreshOk returns a tuple with the LastRefresh field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastRefresh + +`func (o *Identity) SetLastRefresh(v SailPointTime)` + +SetLastRefresh sets LastRefresh field to given value. + +### HasLastRefresh + +`func (o *Identity) HasLastRefresh() bool` + +HasLastRefresh returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Identity) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Identity) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Identity) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Identity) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetLifecycleState + +`func (o *Identity) GetLifecycleState() IdentityLifecycleState` + +GetLifecycleState returns the LifecycleState field if non-nil, zero value otherwise. + +### GetLifecycleStateOk + +`func (o *Identity) GetLifecycleStateOk() (*IdentityLifecycleState, bool)` + +GetLifecycleStateOk returns a tuple with the LifecycleState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLifecycleState + +`func (o *Identity) SetLifecycleState(v IdentityLifecycleState)` + +SetLifecycleState sets LifecycleState field to given value. + +### HasLifecycleState + +`func (o *Identity) HasLifecycleState() bool` + +HasLifecycleState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Identity1.md b/docs/tools/sdk/go/Reference/V2024/Models/Identity1.md new file mode 100644 index 000000000..722181b60 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Identity1.md @@ -0,0 +1,90 @@ +--- +id: v2024-identity1 +title: Identity1 +pagination_label: Identity1 +sidebar_label: Identity1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Identity1', 'V2024Identity1'] +slug: /tools/sdk/go/v2024/models/identity1 +tags: ['SDK', 'Software Development Kit', 'Identity1', 'V2024Identity1'] +--- + +# Identity1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the object | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object | [optional] + +## Methods + +### NewIdentity1 + +`func NewIdentity1() *Identity1` + +NewIdentity1 instantiates a new Identity1 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 + +### NewIdentity1WithDefaults + +`func NewIdentity1WithDefaults() *Identity1` + +NewIdentity1WithDefaults instantiates a new Identity1 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 + +### GetId + +`func (o *Identity1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Identity1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Identity1) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Identity1) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Identity1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Identity1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Identity1) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Identity1) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityAccess.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAccess.md new file mode 100644 index 000000000..461ced94c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAccess.md @@ -0,0 +1,386 @@ +--- +id: v2024-identity-access +title: IdentityAccess +pagination_label: IdentityAccess +sidebar_label: IdentityAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAccess', 'V2024IdentityAccess'] +slug: /tools/sdk/go/v2024/models/identity-access +tags: ['SDK', 'Software Development Kit', 'IdentityAccess', 'V2024IdentityAccess'] +--- + +# IdentityAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Source** | Pointer to [**Reference**](reference) | | [optional] +**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional] +**Revocable** | Pointer to **bool** | | [optional] +**Privileged** | Pointer to **bool** | | [optional] +**Attribute** | Pointer to **string** | | [optional] +**Value** | Pointer to **string** | | [optional] +**Standalone** | Pointer to **bool** | | [optional] +**Disabled** | Pointer to **bool** | | [optional] + +## Methods + +### NewIdentityAccess + +`func NewIdentityAccess() *IdentityAccess` + +NewIdentityAccess instantiates a new IdentityAccess 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 + +### NewIdentityAccessWithDefaults + +`func NewIdentityAccessWithDefaults() *IdentityAccess` + +NewIdentityAccessWithDefaults instantiates a new IdentityAccess 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 + +### GetId + +`func (o *IdentityAccess) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityAccess) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityAccess) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityAccess) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityAccess) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityAccess) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityAccess) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityAccess) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *IdentityAccess) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityAccess) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityAccess) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityAccess) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *IdentityAccess) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *IdentityAccess) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *IdentityAccess) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *IdentityAccess) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *IdentityAccess) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *IdentityAccess) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *IdentityAccess) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityAccess) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityAccess) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityAccess) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSource + +`func (o *IdentityAccess) GetSource() Reference` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *IdentityAccess) GetSourceOk() (*Reference, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *IdentityAccess) SetSource(v Reference)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *IdentityAccess) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetOwner + +`func (o *IdentityAccess) GetOwner() DisplayReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *IdentityAccess) GetOwnerOk() (*DisplayReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *IdentityAccess) SetOwner(v DisplayReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *IdentityAccess) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRevocable + +`func (o *IdentityAccess) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *IdentityAccess) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *IdentityAccess) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *IdentityAccess) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *IdentityAccess) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *IdentityAccess) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *IdentityAccess) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *IdentityAccess) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetAttribute + +`func (o *IdentityAccess) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *IdentityAccess) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *IdentityAccess) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *IdentityAccess) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *IdentityAccess) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *IdentityAccess) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *IdentityAccess) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *IdentityAccess) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetStandalone + +`func (o *IdentityAccess) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *IdentityAccess) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *IdentityAccess) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + +### HasStandalone + +`func (o *IdentityAccess) HasStandalone() bool` + +HasStandalone returns a boolean if a field has been set. + +### GetDisabled + +`func (o *IdentityAccess) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *IdentityAccess) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *IdentityAccess) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *IdentityAccess) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityAccountSelections.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAccountSelections.md new file mode 100644 index 000000000..b1e0768eb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAccountSelections.md @@ -0,0 +1,168 @@ +--- +id: v2024-identity-account-selections +title: IdentityAccountSelections +pagination_label: IdentityAccountSelections +sidebar_label: IdentityAccountSelections +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAccountSelections', 'V2024IdentityAccountSelections'] +slug: /tools/sdk/go/v2024/models/identity-account-selections +tags: ['SDK', 'Software Development Kit', 'IdentityAccountSelections', 'V2024IdentityAccountSelections'] +--- + +# IdentityAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedItems** | Pointer to [**[]RequestedItemAccountSelections**](requested-item-account-selections) | Available account selections for the identity, per requested item | [optional] +**AccountsSelectionRequired** | Pointer to **bool** | A boolean indicating whether any account selections will be required for the user to raise an access request | [optional] [default to false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | The identity id for the user | [optional] +**Name** | Pointer to **string** | The name of the identity | [optional] + +## Methods + +### NewIdentityAccountSelections + +`func NewIdentityAccountSelections() *IdentityAccountSelections` + +NewIdentityAccountSelections instantiates a new IdentityAccountSelections 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 + +### NewIdentityAccountSelectionsWithDefaults + +`func NewIdentityAccountSelectionsWithDefaults() *IdentityAccountSelections` + +NewIdentityAccountSelectionsWithDefaults instantiates a new IdentityAccountSelections 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 + +### GetRequestedItems + +`func (o *IdentityAccountSelections) GetRequestedItems() []RequestedItemAccountSelections` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *IdentityAccountSelections) GetRequestedItemsOk() (*[]RequestedItemAccountSelections, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *IdentityAccountSelections) SetRequestedItems(v []RequestedItemAccountSelections)` + +SetRequestedItems sets RequestedItems field to given value. + +### HasRequestedItems + +`func (o *IdentityAccountSelections) HasRequestedItems() bool` + +HasRequestedItems returns a boolean if a field has been set. + +### GetAccountsSelectionRequired + +`func (o *IdentityAccountSelections) GetAccountsSelectionRequired() bool` + +GetAccountsSelectionRequired returns the AccountsSelectionRequired field if non-nil, zero value otherwise. + +### GetAccountsSelectionRequiredOk + +`func (o *IdentityAccountSelections) GetAccountsSelectionRequiredOk() (*bool, bool)` + +GetAccountsSelectionRequiredOk returns a tuple with the AccountsSelectionRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountsSelectionRequired + +`func (o *IdentityAccountSelections) SetAccountsSelectionRequired(v bool)` + +SetAccountsSelectionRequired sets AccountsSelectionRequired field to given value. + +### HasAccountsSelectionRequired + +`func (o *IdentityAccountSelections) HasAccountsSelectionRequired() bool` + +HasAccountsSelectionRequired returns a boolean if a field has been set. + +### GetType + +`func (o *IdentityAccountSelections) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityAccountSelections) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityAccountSelections) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityAccountSelections) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityAccountSelections) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityAccountSelections) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityAccountSelections) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityAccountSelections) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityAccountSelections) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityAccountSelections) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityAccountSelections) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityAccountSelections) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityAssociationDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAssociationDetails.md new file mode 100644 index 000000000..789946c96 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAssociationDetails.md @@ -0,0 +1,90 @@ +--- +id: v2024-identity-association-details +title: IdentityAssociationDetails +pagination_label: IdentityAssociationDetails +sidebar_label: IdentityAssociationDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAssociationDetails', 'V2024IdentityAssociationDetails'] +slug: /tools/sdk/go/v2024/models/identity-association-details +tags: ['SDK', 'Software Development Kit', 'IdentityAssociationDetails', 'V2024IdentityAssociationDetails'] +--- + +# IdentityAssociationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **string** | any additional context information of the http call result | [optional] +**AssociationDetails** | Pointer to [**[]IdentityAssociationDetailsAssociationDetailsInner**](identity-association-details-association-details-inner) | list of all the resource associations for the identity | [optional] + +## Methods + +### NewIdentityAssociationDetails + +`func NewIdentityAssociationDetails() *IdentityAssociationDetails` + +NewIdentityAssociationDetails instantiates a new IdentityAssociationDetails 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 + +### NewIdentityAssociationDetailsWithDefaults + +`func NewIdentityAssociationDetailsWithDefaults() *IdentityAssociationDetails` + +NewIdentityAssociationDetailsWithDefaults instantiates a new IdentityAssociationDetails 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 + +### GetMessage + +`func (o *IdentityAssociationDetails) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *IdentityAssociationDetails) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *IdentityAssociationDetails) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *IdentityAssociationDetails) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetAssociationDetails + +`func (o *IdentityAssociationDetails) GetAssociationDetails() []IdentityAssociationDetailsAssociationDetailsInner` + +GetAssociationDetails returns the AssociationDetails field if non-nil, zero value otherwise. + +### GetAssociationDetailsOk + +`func (o *IdentityAssociationDetails) GetAssociationDetailsOk() (*[]IdentityAssociationDetailsAssociationDetailsInner, bool)` + +GetAssociationDetailsOk returns a tuple with the AssociationDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociationDetails + +`func (o *IdentityAssociationDetails) SetAssociationDetails(v []IdentityAssociationDetailsAssociationDetailsInner)` + +SetAssociationDetails sets AssociationDetails field to given value. + +### HasAssociationDetails + +`func (o *IdentityAssociationDetails) HasAssociationDetails() bool` + +HasAssociationDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAssociationDetailsAssociationDetailsInner.md new file mode 100644 index 000000000..602c74977 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAssociationDetailsAssociationDetailsInner.md @@ -0,0 +1,90 @@ +--- +id: v2024-identity-association-details-association-details-inner +title: IdentityAssociationDetailsAssociationDetailsInner +pagination_label: IdentityAssociationDetailsAssociationDetailsInner +sidebar_label: IdentityAssociationDetailsAssociationDetailsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAssociationDetailsAssociationDetailsInner', 'V2024IdentityAssociationDetailsAssociationDetailsInner'] +slug: /tools/sdk/go/v2024/models/identity-association-details-association-details-inner +tags: ['SDK', 'Software Development Kit', 'IdentityAssociationDetailsAssociationDetailsInner', 'V2024IdentityAssociationDetailsAssociationDetailsInner'] +--- + +# IdentityAssociationDetailsAssociationDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssociationType** | Pointer to **string** | association type with the identity | [optional] +**Entities** | Pointer to [**[]IdentityEntities**](identity-entities) | the specific resource this identity has ownership on | [optional] + +## Methods + +### NewIdentityAssociationDetailsAssociationDetailsInner + +`func NewIdentityAssociationDetailsAssociationDetailsInner() *IdentityAssociationDetailsAssociationDetailsInner` + +NewIdentityAssociationDetailsAssociationDetailsInner instantiates a new IdentityAssociationDetailsAssociationDetailsInner 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 + +### NewIdentityAssociationDetailsAssociationDetailsInnerWithDefaults + +`func NewIdentityAssociationDetailsAssociationDetailsInnerWithDefaults() *IdentityAssociationDetailsAssociationDetailsInner` + +NewIdentityAssociationDetailsAssociationDetailsInnerWithDefaults instantiates a new IdentityAssociationDetailsAssociationDetailsInner 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 + +### GetAssociationType + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) GetAssociationType() string` + +GetAssociationType returns the AssociationType field if non-nil, zero value otherwise. + +### GetAssociationTypeOk + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) GetAssociationTypeOk() (*string, bool)` + +GetAssociationTypeOk returns a tuple with the AssociationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociationType + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) SetAssociationType(v string)` + +SetAssociationType sets AssociationType field to given value. + +### HasAssociationType + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) HasAssociationType() bool` + +HasAssociationType returns a boolean if a field has been set. + +### GetEntities + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) GetEntities() []IdentityEntities` + +GetEntities returns the Entities field if non-nil, zero value otherwise. + +### GetEntitiesOk + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) GetEntitiesOk() (*[]IdentityEntities, bool)` + +GetEntitiesOk returns a tuple with the Entities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntities + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) SetEntities(v []IdentityEntities)` + +SetEntities sets Entities field to given value. + +### HasEntities + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) HasEntities() bool` + +HasEntities returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttribute.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttribute.md new file mode 100644 index 000000000..23f75392f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttribute.md @@ -0,0 +1,251 @@ +--- +id: v2024-identity-attribute +title: IdentityAttribute +pagination_label: IdentityAttribute +sidebar_label: IdentityAttribute +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttribute', 'V2024IdentityAttribute'] +slug: /tools/sdk/go/v2024/models/identity-attribute +tags: ['SDK', 'Software Development Kit', 'IdentityAttribute', 'V2024IdentityAttribute'] +--- + +# IdentityAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Identity attribute's technical name. | +**DisplayName** | Pointer to **string** | Identity attribute's business-friendly name. | [optional] +**Standard** | Pointer to **bool** | Indicates whether the attribute is 'standard' or 'default'. | [optional] [default to false] +**Type** | Pointer to **NullableString** | Identity attribute's type. | [optional] +**Multi** | Pointer to **bool** | Indicates whether the identity attribute is multi-valued. | [optional] [default to false] +**Searchable** | Pointer to **bool** | Indicates whether the identity attribute is searchable. | [optional] [default to false] +**System** | Pointer to **bool** | Indicates whether the identity attribute is 'system', meaning that it doesn't have a source and isn't configurable. | [optional] [default to false] +**Sources** | Pointer to [**[]Source1**](source1) | Identity attribute's list of sources - this specifies how the rule's value is derived. | [optional] + +## Methods + +### NewIdentityAttribute + +`func NewIdentityAttribute(name string, ) *IdentityAttribute` + +NewIdentityAttribute instantiates a new IdentityAttribute 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 + +### NewIdentityAttributeWithDefaults + +`func NewIdentityAttributeWithDefaults() *IdentityAttribute` + +NewIdentityAttributeWithDefaults instantiates a new IdentityAttribute 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 + +### GetName + +`func (o *IdentityAttribute) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityAttribute) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityAttribute) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDisplayName + +`func (o *IdentityAttribute) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityAttribute) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityAttribute) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityAttribute) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetStandard + +`func (o *IdentityAttribute) GetStandard() bool` + +GetStandard returns the Standard field if non-nil, zero value otherwise. + +### GetStandardOk + +`func (o *IdentityAttribute) GetStandardOk() (*bool, bool)` + +GetStandardOk returns a tuple with the Standard field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandard + +`func (o *IdentityAttribute) SetStandard(v bool)` + +SetStandard sets Standard field to given value. + +### HasStandard + +`func (o *IdentityAttribute) HasStandard() bool` + +HasStandard returns a boolean if a field has been set. + +### GetType + +`func (o *IdentityAttribute) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityAttribute) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityAttribute) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityAttribute) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *IdentityAttribute) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *IdentityAttribute) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetMulti + +`func (o *IdentityAttribute) GetMulti() bool` + +GetMulti returns the Multi field if non-nil, zero value otherwise. + +### GetMultiOk + +`func (o *IdentityAttribute) GetMultiOk() (*bool, bool)` + +GetMultiOk returns a tuple with the Multi field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMulti + +`func (o *IdentityAttribute) SetMulti(v bool)` + +SetMulti sets Multi field to given value. + +### HasMulti + +`func (o *IdentityAttribute) HasMulti() bool` + +HasMulti returns a boolean if a field has been set. + +### GetSearchable + +`func (o *IdentityAttribute) GetSearchable() bool` + +GetSearchable returns the Searchable field if non-nil, zero value otherwise. + +### GetSearchableOk + +`func (o *IdentityAttribute) GetSearchableOk() (*bool, bool)` + +GetSearchableOk returns a tuple with the Searchable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchable + +`func (o *IdentityAttribute) SetSearchable(v bool)` + +SetSearchable sets Searchable field to given value. + +### HasSearchable + +`func (o *IdentityAttribute) HasSearchable() bool` + +HasSearchable returns a boolean if a field has been set. + +### GetSystem + +`func (o *IdentityAttribute) GetSystem() bool` + +GetSystem returns the System field if non-nil, zero value otherwise. + +### GetSystemOk + +`func (o *IdentityAttribute) GetSystemOk() (*bool, bool)` + +GetSystemOk returns a tuple with the System field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSystem + +`func (o *IdentityAttribute) SetSystem(v bool)` + +SetSystem sets System field to given value. + +### HasSystem + +`func (o *IdentityAttribute) HasSystem() bool` + +HasSystem returns a boolean if a field has been set. + +### GetSources + +`func (o *IdentityAttribute) GetSources() []Source1` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *IdentityAttribute) GetSourcesOk() (*[]Source1, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *IdentityAttribute) SetSources(v []Source1)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *IdentityAttribute) HasSources() bool` + +HasSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributeConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributeConfig.md new file mode 100644 index 000000000..5978b5a19 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributeConfig.md @@ -0,0 +1,90 @@ +--- +id: v2024-identity-attribute-config +title: IdentityAttributeConfig +pagination_label: IdentityAttributeConfig +sidebar_label: IdentityAttributeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributeConfig', 'V2024IdentityAttributeConfig'] +slug: /tools/sdk/go/v2024/models/identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'V2024IdentityAttributeConfig'] +--- + +# IdentityAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to false] +**AttributeTransforms** | Pointer to [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] + +## Methods + +### NewIdentityAttributeConfig + +`func NewIdentityAttributeConfig() *IdentityAttributeConfig` + +NewIdentityAttributeConfig instantiates a new IdentityAttributeConfig 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 + +### NewIdentityAttributeConfigWithDefaults + +`func NewIdentityAttributeConfigWithDefaults() *IdentityAttributeConfig` + +NewIdentityAttributeConfigWithDefaults instantiates a new IdentityAttributeConfig 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 + +### GetEnabled + +`func (o *IdentityAttributeConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *IdentityAttributeConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *IdentityAttributeConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *IdentityAttributeConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetAttributeTransforms + +`func (o *IdentityAttributeConfig) GetAttributeTransforms() []IdentityAttributeTransform` + +GetAttributeTransforms returns the AttributeTransforms field if non-nil, zero value otherwise. + +### GetAttributeTransformsOk + +`func (o *IdentityAttributeConfig) GetAttributeTransformsOk() (*[]IdentityAttributeTransform, bool)` + +GetAttributeTransformsOk returns a tuple with the AttributeTransforms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeTransforms + +`func (o *IdentityAttributeConfig) SetAttributeTransforms(v []IdentityAttributeTransform)` + +SetAttributeTransforms sets AttributeTransforms field to given value. + +### HasAttributeTransforms + +`func (o *IdentityAttributeConfig) HasAttributeTransforms() bool` + +HasAttributeTransforms returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributeNames.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributeNames.md new file mode 100644 index 000000000..c3de85ea7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributeNames.md @@ -0,0 +1,64 @@ +--- +id: v2024-identity-attribute-names +title: IdentityAttributeNames +pagination_label: IdentityAttributeNames +sidebar_label: IdentityAttributeNames +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributeNames', 'V2024IdentityAttributeNames'] +slug: /tools/sdk/go/v2024/models/identity-attribute-names +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeNames', 'V2024IdentityAttributeNames'] +--- + +# IdentityAttributeNames + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]string** | List of identity attributes' technical names. | [optional] + +## Methods + +### NewIdentityAttributeNames + +`func NewIdentityAttributeNames() *IdentityAttributeNames` + +NewIdentityAttributeNames instantiates a new IdentityAttributeNames 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 + +### NewIdentityAttributeNamesWithDefaults + +`func NewIdentityAttributeNamesWithDefaults() *IdentityAttributeNames` + +NewIdentityAttributeNamesWithDefaults instantiates a new IdentityAttributeNames 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 + +### GetIds + +`func (o *IdentityAttributeNames) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *IdentityAttributeNames) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *IdentityAttributeNames) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *IdentityAttributeNames) HasIds() bool` + +HasIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributePreview.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributePreview.md new file mode 100644 index 000000000..5e19547ce --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributePreview.md @@ -0,0 +1,142 @@ +--- +id: v2024-identity-attribute-preview +title: IdentityAttributePreview +pagination_label: IdentityAttributePreview +sidebar_label: IdentityAttributePreview +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributePreview', 'V2024IdentityAttributePreview'] +slug: /tools/sdk/go/v2024/models/identity-attribute-preview +tags: ['SDK', 'Software Development Kit', 'IdentityAttributePreview', 'V2024IdentityAttributePreview'] +--- + +# IdentityAttributePreview + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the attribute that is being previewed. | [optional] +**Value** | Pointer to **string** | Value that was derived during the preview. | [optional] +**PreviousValue** | Pointer to **string** | The value of the attribute before the preview. | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | List of error messages | [optional] + +## Methods + +### NewIdentityAttributePreview + +`func NewIdentityAttributePreview() *IdentityAttributePreview` + +NewIdentityAttributePreview instantiates a new IdentityAttributePreview 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 + +### NewIdentityAttributePreviewWithDefaults + +`func NewIdentityAttributePreviewWithDefaults() *IdentityAttributePreview` + +NewIdentityAttributePreviewWithDefaults instantiates a new IdentityAttributePreview 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 + +### GetName + +`func (o *IdentityAttributePreview) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityAttributePreview) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityAttributePreview) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityAttributePreview) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValue + +`func (o *IdentityAttributePreview) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *IdentityAttributePreview) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *IdentityAttributePreview) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *IdentityAttributePreview) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetPreviousValue + +`func (o *IdentityAttributePreview) GetPreviousValue() string` + +GetPreviousValue returns the PreviousValue field if non-nil, zero value otherwise. + +### GetPreviousValueOk + +`func (o *IdentityAttributePreview) GetPreviousValueOk() (*string, bool)` + +GetPreviousValueOk returns a tuple with the PreviousValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousValue + +`func (o *IdentityAttributePreview) SetPreviousValue(v string)` + +SetPreviousValue sets PreviousValue field to given value. + +### HasPreviousValue + +`func (o *IdentityAttributePreview) HasPreviousValue() bool` + +HasPreviousValue returns a boolean if a field has been set. + +### GetErrorMessages + +`func (o *IdentityAttributePreview) GetErrorMessages() []ErrorMessageDto` + +GetErrorMessages returns the ErrorMessages field if non-nil, zero value otherwise. + +### GetErrorMessagesOk + +`func (o *IdentityAttributePreview) GetErrorMessagesOk() (*[]ErrorMessageDto, bool)` + +GetErrorMessagesOk returns a tuple with the ErrorMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessages + +`func (o *IdentityAttributePreview) SetErrorMessages(v []ErrorMessageDto)` + +SetErrorMessages sets ErrorMessages field to given value. + +### HasErrorMessages + +`func (o *IdentityAttributePreview) HasErrorMessages() bool` + +HasErrorMessages returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributeTransform.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributeTransform.md new file mode 100644 index 000000000..16b7efe54 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributeTransform.md @@ -0,0 +1,90 @@ +--- +id: v2024-identity-attribute-transform +title: IdentityAttributeTransform +pagination_label: IdentityAttributeTransform +sidebar_label: IdentityAttributeTransform +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributeTransform', 'V2024IdentityAttributeTransform'] +slug: /tools/sdk/go/v2024/models/identity-attribute-transform +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'V2024IdentityAttributeTransform'] +--- + +# IdentityAttributeTransform + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttributeName** | Pointer to **string** | Identity attribute's name. | [optional] +**TransformDefinition** | Pointer to [**TransformDefinition**](transform-definition) | | [optional] + +## Methods + +### NewIdentityAttributeTransform + +`func NewIdentityAttributeTransform() *IdentityAttributeTransform` + +NewIdentityAttributeTransform instantiates a new IdentityAttributeTransform 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 + +### NewIdentityAttributeTransformWithDefaults + +`func NewIdentityAttributeTransformWithDefaults() *IdentityAttributeTransform` + +NewIdentityAttributeTransformWithDefaults instantiates a new IdentityAttributeTransform 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 + +### GetIdentityAttributeName + +`func (o *IdentityAttributeTransform) GetIdentityAttributeName() string` + +GetIdentityAttributeName returns the IdentityAttributeName field if non-nil, zero value otherwise. + +### GetIdentityAttributeNameOk + +`func (o *IdentityAttributeTransform) GetIdentityAttributeNameOk() (*string, bool)` + +GetIdentityAttributeNameOk returns a tuple with the IdentityAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeName + +`func (o *IdentityAttributeTransform) SetIdentityAttributeName(v string)` + +SetIdentityAttributeName sets IdentityAttributeName field to given value. + +### HasIdentityAttributeName + +`func (o *IdentityAttributeTransform) HasIdentityAttributeName() bool` + +HasIdentityAttributeName returns a boolean if a field has been set. + +### GetTransformDefinition + +`func (o *IdentityAttributeTransform) GetTransformDefinition() TransformDefinition` + +GetTransformDefinition returns the TransformDefinition field if non-nil, zero value otherwise. + +### GetTransformDefinitionOk + +`func (o *IdentityAttributeTransform) GetTransformDefinitionOk() (*TransformDefinition, bool)` + +GetTransformDefinitionOk returns a tuple with the TransformDefinition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTransformDefinition + +`func (o *IdentityAttributeTransform) SetTransformDefinition(v TransformDefinition)` + +SetTransformDefinition sets TransformDefinition field to given value. + +### HasTransformDefinition + +`func (o *IdentityAttributeTransform) HasTransformDefinition() bool` + +HasTransformDefinition returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChanged.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChanged.md new file mode 100644 index 000000000..58465cd92 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChanged.md @@ -0,0 +1,80 @@ +--- +id: v2024-identity-attributes-changed +title: IdentityAttributesChanged +pagination_label: IdentityAttributesChanged +sidebar_label: IdentityAttributesChanged +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChanged', 'V2024IdentityAttributesChanged'] +slug: /tools/sdk/go/v2024/models/identity-attributes-changed +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChanged', 'V2024IdentityAttributesChanged'] +--- + +# IdentityAttributesChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**IdentityAttributesChangedIdentity**](identity-attributes-changed-identity) | | +**Changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | + +## Methods + +### NewIdentityAttributesChanged + +`func NewIdentityAttributesChanged(identity IdentityAttributesChangedIdentity, changes []IdentityAttributesChangedChangesInner, ) *IdentityAttributesChanged` + +NewIdentityAttributesChanged instantiates a new IdentityAttributesChanged 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 + +### NewIdentityAttributesChangedWithDefaults + +`func NewIdentityAttributesChangedWithDefaults() *IdentityAttributesChanged` + +NewIdentityAttributesChangedWithDefaults instantiates a new IdentityAttributesChanged 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 + +### GetIdentity + +`func (o *IdentityAttributesChanged) GetIdentity() IdentityAttributesChangedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *IdentityAttributesChanged) GetIdentityOk() (*IdentityAttributesChangedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *IdentityAttributesChanged) SetIdentity(v IdentityAttributesChangedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetChanges + +`func (o *IdentityAttributesChanged) GetChanges() []IdentityAttributesChangedChangesInner` + +GetChanges returns the Changes field if non-nil, zero value otherwise. + +### GetChangesOk + +`func (o *IdentityAttributesChanged) GetChangesOk() (*[]IdentityAttributesChangedChangesInner, bool)` + +GetChangesOk returns a tuple with the Changes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanges + +`func (o *IdentityAttributesChanged) SetChanges(v []IdentityAttributesChangedChangesInner)` + +SetChanges sets Changes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChangedChangesInner.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChangedChangesInner.md new file mode 100644 index 000000000..afb9f1a74 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChangedChangesInner.md @@ -0,0 +1,121 @@ +--- +id: v2024-identity-attributes-changed-changes-inner +title: IdentityAttributesChangedChangesInner +pagination_label: IdentityAttributesChangedChangesInner +sidebar_label: IdentityAttributesChangedChangesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChangedChangesInner', 'V2024IdentityAttributesChangedChangesInner'] +slug: /tools/sdk/go/v2024/models/identity-attributes-changed-changes-inner +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInner', 'V2024IdentityAttributesChangedChangesInner'] +--- + +# IdentityAttributesChangedChangesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | **string** | The name of the identity attribute that changed. | +**OldValue** | Pointer to [**NullableIdentityAttributesChangedChangesInnerOldValue**](identity-attributes-changed-changes-inner-old-value) | | [optional] +**NewValue** | Pointer to [**IdentityAttributesChangedChangesInnerNewValue**](identity-attributes-changed-changes-inner-new-value) | | [optional] + +## Methods + +### NewIdentityAttributesChangedChangesInner + +`func NewIdentityAttributesChangedChangesInner(attribute string, ) *IdentityAttributesChangedChangesInner` + +NewIdentityAttributesChangedChangesInner instantiates a new IdentityAttributesChangedChangesInner 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 + +### NewIdentityAttributesChangedChangesInnerWithDefaults + +`func NewIdentityAttributesChangedChangesInnerWithDefaults() *IdentityAttributesChangedChangesInner` + +NewIdentityAttributesChangedChangesInnerWithDefaults instantiates a new IdentityAttributesChangedChangesInner 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 + +### GetAttribute + +`func (o *IdentityAttributesChangedChangesInner) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *IdentityAttributesChangedChangesInner) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *IdentityAttributesChangedChangesInner) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + + +### GetOldValue + +`func (o *IdentityAttributesChangedChangesInner) GetOldValue() IdentityAttributesChangedChangesInnerOldValue` + +GetOldValue returns the OldValue field if non-nil, zero value otherwise. + +### GetOldValueOk + +`func (o *IdentityAttributesChangedChangesInner) GetOldValueOk() (*IdentityAttributesChangedChangesInnerOldValue, bool)` + +GetOldValueOk returns a tuple with the OldValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOldValue + +`func (o *IdentityAttributesChangedChangesInner) SetOldValue(v IdentityAttributesChangedChangesInnerOldValue)` + +SetOldValue sets OldValue field to given value. + +### HasOldValue + +`func (o *IdentityAttributesChangedChangesInner) HasOldValue() bool` + +HasOldValue returns a boolean if a field has been set. + +### SetOldValueNil + +`func (o *IdentityAttributesChangedChangesInner) SetOldValueNil(b bool)` + + SetOldValueNil sets the value for OldValue to be an explicit nil + +### UnsetOldValue +`func (o *IdentityAttributesChangedChangesInner) UnsetOldValue()` + +UnsetOldValue ensures that no value is present for OldValue, not even an explicit nil +### GetNewValue + +`func (o *IdentityAttributesChangedChangesInner) GetNewValue() IdentityAttributesChangedChangesInnerNewValue` + +GetNewValue returns the NewValue field if non-nil, zero value otherwise. + +### GetNewValueOk + +`func (o *IdentityAttributesChangedChangesInner) GetNewValueOk() (*IdentityAttributesChangedChangesInnerNewValue, bool)` + +GetNewValueOk returns a tuple with the NewValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewValue + +`func (o *IdentityAttributesChangedChangesInner) SetNewValue(v IdentityAttributesChangedChangesInnerNewValue)` + +SetNewValue sets NewValue field to given value. + +### HasNewValue + +`func (o *IdentityAttributesChangedChangesInner) HasNewValue() bool` + +HasNewValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChangedChangesInnerNewValue.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChangedChangesInnerNewValue.md new file mode 100644 index 000000000..88cadecfd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChangedChangesInnerNewValue.md @@ -0,0 +1,38 @@ +--- +id: v2024-identity-attributes-changed-changes-inner-new-value +title: IdentityAttributesChangedChangesInnerNewValue +pagination_label: IdentityAttributesChangedChangesInnerNewValue +sidebar_label: IdentityAttributesChangedChangesInnerNewValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChangedChangesInnerNewValue', 'V2024IdentityAttributesChangedChangesInnerNewValue'] +slug: /tools/sdk/go/v2024/models/identity-attributes-changed-changes-inner-new-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerNewValue', 'V2024IdentityAttributesChangedChangesInnerNewValue'] +--- + +# IdentityAttributesChangedChangesInnerNewValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewIdentityAttributesChangedChangesInnerNewValue + +`func NewIdentityAttributesChangedChangesInnerNewValue() *IdentityAttributesChangedChangesInnerNewValue` + +NewIdentityAttributesChangedChangesInnerNewValue instantiates a new IdentityAttributesChangedChangesInnerNewValue 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 + +### NewIdentityAttributesChangedChangesInnerNewValueWithDefaults + +`func NewIdentityAttributesChangedChangesInnerNewValueWithDefaults() *IdentityAttributesChangedChangesInnerNewValue` + +NewIdentityAttributesChangedChangesInnerNewValueWithDefaults instantiates a new IdentityAttributesChangedChangesInnerNewValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChangedChangesInnerOldValue.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChangedChangesInnerOldValue.md new file mode 100644 index 000000000..3f1473333 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChangedChangesInnerOldValue.md @@ -0,0 +1,38 @@ +--- +id: v2024-identity-attributes-changed-changes-inner-old-value +title: IdentityAttributesChangedChangesInnerOldValue +pagination_label: IdentityAttributesChangedChangesInnerOldValue +sidebar_label: IdentityAttributesChangedChangesInnerOldValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChangedChangesInnerOldValue', 'V2024IdentityAttributesChangedChangesInnerOldValue'] +slug: /tools/sdk/go/v2024/models/identity-attributes-changed-changes-inner-old-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerOldValue', 'V2024IdentityAttributesChangedChangesInnerOldValue'] +--- + +# IdentityAttributesChangedChangesInnerOldValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewIdentityAttributesChangedChangesInnerOldValue + +`func NewIdentityAttributesChangedChangesInnerOldValue() *IdentityAttributesChangedChangesInnerOldValue` + +NewIdentityAttributesChangedChangesInnerOldValue instantiates a new IdentityAttributesChangedChangesInnerOldValue 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 + +### NewIdentityAttributesChangedChangesInnerOldValueWithDefaults + +`func NewIdentityAttributesChangedChangesInnerOldValueWithDefaults() *IdentityAttributesChangedChangesInnerOldValue` + +NewIdentityAttributesChangedChangesInnerOldValueWithDefaults instantiates a new IdentityAttributesChangedChangesInnerOldValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md new file mode 100644 index 000000000..ca1715c32 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md @@ -0,0 +1,38 @@ +--- +id: v2024-identity-attributes-changed-changes-inner-old-value-one-of-value +title: IdentityAttributesChangedChangesInnerOldValueOneOfValue +pagination_label: IdentityAttributesChangedChangesInnerOldValueOneOfValue +sidebar_label: IdentityAttributesChangedChangesInnerOldValueOneOfValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChangedChangesInnerOldValueOneOfValue', 'V2024IdentityAttributesChangedChangesInnerOldValueOneOfValue'] +slug: /tools/sdk/go/v2024/models/identity-attributes-changed-changes-inner-old-value-one-of-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerOldValueOneOfValue', 'V2024IdentityAttributesChangedChangesInnerOldValueOneOfValue'] +--- + +# IdentityAttributesChangedChangesInnerOldValueOneOfValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewIdentityAttributesChangedChangesInnerOldValueOneOfValue + +`func NewIdentityAttributesChangedChangesInnerOldValueOneOfValue() *IdentityAttributesChangedChangesInnerOldValueOneOfValue` + +NewIdentityAttributesChangedChangesInnerOldValueOneOfValue instantiates a new IdentityAttributesChangedChangesInnerOldValueOneOfValue 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 + +### NewIdentityAttributesChangedChangesInnerOldValueOneOfValueWithDefaults + +`func NewIdentityAttributesChangedChangesInnerOldValueOneOfValueWithDefaults() *IdentityAttributesChangedChangesInnerOldValueOneOfValue` + +NewIdentityAttributesChangedChangesInnerOldValueOneOfValueWithDefaults instantiates a new IdentityAttributesChangedChangesInnerOldValueOneOfValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChangedIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChangedIdentity.md new file mode 100644 index 000000000..92ea45827 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityAttributesChangedIdentity.md @@ -0,0 +1,101 @@ +--- +id: v2024-identity-attributes-changed-identity +title: IdentityAttributesChangedIdentity +pagination_label: IdentityAttributesChangedIdentity +sidebar_label: IdentityAttributesChangedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChangedIdentity', 'V2024IdentityAttributesChangedIdentity'] +slug: /tools/sdk/go/v2024/models/identity-attributes-changed-identity +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedIdentity', 'V2024IdentityAttributesChangedIdentity'] +--- + +# IdentityAttributesChangedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of identity whose attributes changed. | +**Id** | **string** | ID of identity whose attributes changed. | +**Name** | **string** | Display name of identity whose attributes changed. | + +## Methods + +### NewIdentityAttributesChangedIdentity + +`func NewIdentityAttributesChangedIdentity(type_ string, id string, name string, ) *IdentityAttributesChangedIdentity` + +NewIdentityAttributesChangedIdentity instantiates a new IdentityAttributesChangedIdentity 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 + +### NewIdentityAttributesChangedIdentityWithDefaults + +`func NewIdentityAttributesChangedIdentityWithDefaults() *IdentityAttributesChangedIdentity` + +NewIdentityAttributesChangedIdentityWithDefaults instantiates a new IdentityAttributesChangedIdentity 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 + +### GetType + +`func (o *IdentityAttributesChangedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityAttributesChangedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityAttributesChangedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *IdentityAttributesChangedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityAttributesChangedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityAttributesChangedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *IdentityAttributesChangedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityAttributesChangedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityAttributesChangedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityCertDecisionSummary.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityCertDecisionSummary.md new file mode 100644 index 000000000..54b6ba13d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityCertDecisionSummary.md @@ -0,0 +1,454 @@ +--- +id: v2024-identity-cert-decision-summary +title: IdentityCertDecisionSummary +pagination_label: IdentityCertDecisionSummary +sidebar_label: IdentityCertDecisionSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCertDecisionSummary', 'V2024IdentityCertDecisionSummary'] +slug: /tools/sdk/go/v2024/models/identity-cert-decision-summary +tags: ['SDK', 'Software Development Kit', 'IdentityCertDecisionSummary', 'V2024IdentityCertDecisionSummary'] +--- + +# IdentityCertDecisionSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EntitlementDecisionsMade** | Pointer to **int32** | Number of entitlement decisions that have been made | [optional] +**AccessProfileDecisionsMade** | Pointer to **int32** | Number of access profile decisions that have been made | [optional] +**RoleDecisionsMade** | Pointer to **int32** | Number of role decisions that have been made | [optional] +**AccountDecisionsMade** | Pointer to **int32** | Number of account decisions that have been made | [optional] +**EntitlementDecisionsTotal** | Pointer to **int32** | The total number of entitlement decisions on the certification, both complete and incomplete | [optional] +**AccessProfileDecisionsTotal** | Pointer to **int32** | The total number of access profile decisions on the certification, both complete and incomplete | [optional] +**RoleDecisionsTotal** | Pointer to **int32** | The total number of role decisions on the certification, both complete and incomplete | [optional] +**AccountDecisionsTotal** | Pointer to **int32** | The total number of account decisions on the certification, both complete and incomplete | [optional] +**EntitlementsApproved** | Pointer to **int32** | The number of entitlement decisions that have been made which were approved | [optional] +**EntitlementsRevoked** | Pointer to **int32** | The number of entitlement decisions that have been made which were revoked | [optional] +**AccessProfilesApproved** | Pointer to **int32** | The number of access profile decisions that have been made which were approved | [optional] +**AccessProfilesRevoked** | Pointer to **int32** | The number of access profile decisions that have been made which were revoked | [optional] +**RolesApproved** | Pointer to **int32** | The number of role decisions that have been made which were approved | [optional] +**RolesRevoked** | Pointer to **int32** | The number of role decisions that have been made which were revoked | [optional] +**AccountsApproved** | Pointer to **int32** | The number of account decisions that have been made which were approved | [optional] +**AccountsRevoked** | Pointer to **int32** | The number of account decisions that have been made which were revoked | [optional] + +## Methods + +### NewIdentityCertDecisionSummary + +`func NewIdentityCertDecisionSummary() *IdentityCertDecisionSummary` + +NewIdentityCertDecisionSummary instantiates a new IdentityCertDecisionSummary 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 + +### NewIdentityCertDecisionSummaryWithDefaults + +`func NewIdentityCertDecisionSummaryWithDefaults() *IdentityCertDecisionSummary` + +NewIdentityCertDecisionSummaryWithDefaults instantiates a new IdentityCertDecisionSummary 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 + +### GetEntitlementDecisionsMade + +`func (o *IdentityCertDecisionSummary) GetEntitlementDecisionsMade() int32` + +GetEntitlementDecisionsMade returns the EntitlementDecisionsMade field if non-nil, zero value otherwise. + +### GetEntitlementDecisionsMadeOk + +`func (o *IdentityCertDecisionSummary) GetEntitlementDecisionsMadeOk() (*int32, bool)` + +GetEntitlementDecisionsMadeOk returns a tuple with the EntitlementDecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementDecisionsMade + +`func (o *IdentityCertDecisionSummary) SetEntitlementDecisionsMade(v int32)` + +SetEntitlementDecisionsMade sets EntitlementDecisionsMade field to given value. + +### HasEntitlementDecisionsMade + +`func (o *IdentityCertDecisionSummary) HasEntitlementDecisionsMade() bool` + +HasEntitlementDecisionsMade returns a boolean if a field has been set. + +### GetAccessProfileDecisionsMade + +`func (o *IdentityCertDecisionSummary) GetAccessProfileDecisionsMade() int32` + +GetAccessProfileDecisionsMade returns the AccessProfileDecisionsMade field if non-nil, zero value otherwise. + +### GetAccessProfileDecisionsMadeOk + +`func (o *IdentityCertDecisionSummary) GetAccessProfileDecisionsMadeOk() (*int32, bool)` + +GetAccessProfileDecisionsMadeOk returns a tuple with the AccessProfileDecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileDecisionsMade + +`func (o *IdentityCertDecisionSummary) SetAccessProfileDecisionsMade(v int32)` + +SetAccessProfileDecisionsMade sets AccessProfileDecisionsMade field to given value. + +### HasAccessProfileDecisionsMade + +`func (o *IdentityCertDecisionSummary) HasAccessProfileDecisionsMade() bool` + +HasAccessProfileDecisionsMade returns a boolean if a field has been set. + +### GetRoleDecisionsMade + +`func (o *IdentityCertDecisionSummary) GetRoleDecisionsMade() int32` + +GetRoleDecisionsMade returns the RoleDecisionsMade field if non-nil, zero value otherwise. + +### GetRoleDecisionsMadeOk + +`func (o *IdentityCertDecisionSummary) GetRoleDecisionsMadeOk() (*int32, bool)` + +GetRoleDecisionsMadeOk returns a tuple with the RoleDecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleDecisionsMade + +`func (o *IdentityCertDecisionSummary) SetRoleDecisionsMade(v int32)` + +SetRoleDecisionsMade sets RoleDecisionsMade field to given value. + +### HasRoleDecisionsMade + +`func (o *IdentityCertDecisionSummary) HasRoleDecisionsMade() bool` + +HasRoleDecisionsMade returns a boolean if a field has been set. + +### GetAccountDecisionsMade + +`func (o *IdentityCertDecisionSummary) GetAccountDecisionsMade() int32` + +GetAccountDecisionsMade returns the AccountDecisionsMade field if non-nil, zero value otherwise. + +### GetAccountDecisionsMadeOk + +`func (o *IdentityCertDecisionSummary) GetAccountDecisionsMadeOk() (*int32, bool)` + +GetAccountDecisionsMadeOk returns a tuple with the AccountDecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountDecisionsMade + +`func (o *IdentityCertDecisionSummary) SetAccountDecisionsMade(v int32)` + +SetAccountDecisionsMade sets AccountDecisionsMade field to given value. + +### HasAccountDecisionsMade + +`func (o *IdentityCertDecisionSummary) HasAccountDecisionsMade() bool` + +HasAccountDecisionsMade returns a boolean if a field has been set. + +### GetEntitlementDecisionsTotal + +`func (o *IdentityCertDecisionSummary) GetEntitlementDecisionsTotal() int32` + +GetEntitlementDecisionsTotal returns the EntitlementDecisionsTotal field if non-nil, zero value otherwise. + +### GetEntitlementDecisionsTotalOk + +`func (o *IdentityCertDecisionSummary) GetEntitlementDecisionsTotalOk() (*int32, bool)` + +GetEntitlementDecisionsTotalOk returns a tuple with the EntitlementDecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementDecisionsTotal + +`func (o *IdentityCertDecisionSummary) SetEntitlementDecisionsTotal(v int32)` + +SetEntitlementDecisionsTotal sets EntitlementDecisionsTotal field to given value. + +### HasEntitlementDecisionsTotal + +`func (o *IdentityCertDecisionSummary) HasEntitlementDecisionsTotal() bool` + +HasEntitlementDecisionsTotal returns a boolean if a field has been set. + +### GetAccessProfileDecisionsTotal + +`func (o *IdentityCertDecisionSummary) GetAccessProfileDecisionsTotal() int32` + +GetAccessProfileDecisionsTotal returns the AccessProfileDecisionsTotal field if non-nil, zero value otherwise. + +### GetAccessProfileDecisionsTotalOk + +`func (o *IdentityCertDecisionSummary) GetAccessProfileDecisionsTotalOk() (*int32, bool)` + +GetAccessProfileDecisionsTotalOk returns a tuple with the AccessProfileDecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileDecisionsTotal + +`func (o *IdentityCertDecisionSummary) SetAccessProfileDecisionsTotal(v int32)` + +SetAccessProfileDecisionsTotal sets AccessProfileDecisionsTotal field to given value. + +### HasAccessProfileDecisionsTotal + +`func (o *IdentityCertDecisionSummary) HasAccessProfileDecisionsTotal() bool` + +HasAccessProfileDecisionsTotal returns a boolean if a field has been set. + +### GetRoleDecisionsTotal + +`func (o *IdentityCertDecisionSummary) GetRoleDecisionsTotal() int32` + +GetRoleDecisionsTotal returns the RoleDecisionsTotal field if non-nil, zero value otherwise. + +### GetRoleDecisionsTotalOk + +`func (o *IdentityCertDecisionSummary) GetRoleDecisionsTotalOk() (*int32, bool)` + +GetRoleDecisionsTotalOk returns a tuple with the RoleDecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleDecisionsTotal + +`func (o *IdentityCertDecisionSummary) SetRoleDecisionsTotal(v int32)` + +SetRoleDecisionsTotal sets RoleDecisionsTotal field to given value. + +### HasRoleDecisionsTotal + +`func (o *IdentityCertDecisionSummary) HasRoleDecisionsTotal() bool` + +HasRoleDecisionsTotal returns a boolean if a field has been set. + +### GetAccountDecisionsTotal + +`func (o *IdentityCertDecisionSummary) GetAccountDecisionsTotal() int32` + +GetAccountDecisionsTotal returns the AccountDecisionsTotal field if non-nil, zero value otherwise. + +### GetAccountDecisionsTotalOk + +`func (o *IdentityCertDecisionSummary) GetAccountDecisionsTotalOk() (*int32, bool)` + +GetAccountDecisionsTotalOk returns a tuple with the AccountDecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountDecisionsTotal + +`func (o *IdentityCertDecisionSummary) SetAccountDecisionsTotal(v int32)` + +SetAccountDecisionsTotal sets AccountDecisionsTotal field to given value. + +### HasAccountDecisionsTotal + +`func (o *IdentityCertDecisionSummary) HasAccountDecisionsTotal() bool` + +HasAccountDecisionsTotal returns a boolean if a field has been set. + +### GetEntitlementsApproved + +`func (o *IdentityCertDecisionSummary) GetEntitlementsApproved() int32` + +GetEntitlementsApproved returns the EntitlementsApproved field if non-nil, zero value otherwise. + +### GetEntitlementsApprovedOk + +`func (o *IdentityCertDecisionSummary) GetEntitlementsApprovedOk() (*int32, bool)` + +GetEntitlementsApprovedOk returns a tuple with the EntitlementsApproved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementsApproved + +`func (o *IdentityCertDecisionSummary) SetEntitlementsApproved(v int32)` + +SetEntitlementsApproved sets EntitlementsApproved field to given value. + +### HasEntitlementsApproved + +`func (o *IdentityCertDecisionSummary) HasEntitlementsApproved() bool` + +HasEntitlementsApproved returns a boolean if a field has been set. + +### GetEntitlementsRevoked + +`func (o *IdentityCertDecisionSummary) GetEntitlementsRevoked() int32` + +GetEntitlementsRevoked returns the EntitlementsRevoked field if non-nil, zero value otherwise. + +### GetEntitlementsRevokedOk + +`func (o *IdentityCertDecisionSummary) GetEntitlementsRevokedOk() (*int32, bool)` + +GetEntitlementsRevokedOk returns a tuple with the EntitlementsRevoked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementsRevoked + +`func (o *IdentityCertDecisionSummary) SetEntitlementsRevoked(v int32)` + +SetEntitlementsRevoked sets EntitlementsRevoked field to given value. + +### HasEntitlementsRevoked + +`func (o *IdentityCertDecisionSummary) HasEntitlementsRevoked() bool` + +HasEntitlementsRevoked returns a boolean if a field has been set. + +### GetAccessProfilesApproved + +`func (o *IdentityCertDecisionSummary) GetAccessProfilesApproved() int32` + +GetAccessProfilesApproved returns the AccessProfilesApproved field if non-nil, zero value otherwise. + +### GetAccessProfilesApprovedOk + +`func (o *IdentityCertDecisionSummary) GetAccessProfilesApprovedOk() (*int32, bool)` + +GetAccessProfilesApprovedOk returns a tuple with the AccessProfilesApproved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfilesApproved + +`func (o *IdentityCertDecisionSummary) SetAccessProfilesApproved(v int32)` + +SetAccessProfilesApproved sets AccessProfilesApproved field to given value. + +### HasAccessProfilesApproved + +`func (o *IdentityCertDecisionSummary) HasAccessProfilesApproved() bool` + +HasAccessProfilesApproved returns a boolean if a field has been set. + +### GetAccessProfilesRevoked + +`func (o *IdentityCertDecisionSummary) GetAccessProfilesRevoked() int32` + +GetAccessProfilesRevoked returns the AccessProfilesRevoked field if non-nil, zero value otherwise. + +### GetAccessProfilesRevokedOk + +`func (o *IdentityCertDecisionSummary) GetAccessProfilesRevokedOk() (*int32, bool)` + +GetAccessProfilesRevokedOk returns a tuple with the AccessProfilesRevoked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfilesRevoked + +`func (o *IdentityCertDecisionSummary) SetAccessProfilesRevoked(v int32)` + +SetAccessProfilesRevoked sets AccessProfilesRevoked field to given value. + +### HasAccessProfilesRevoked + +`func (o *IdentityCertDecisionSummary) HasAccessProfilesRevoked() bool` + +HasAccessProfilesRevoked returns a boolean if a field has been set. + +### GetRolesApproved + +`func (o *IdentityCertDecisionSummary) GetRolesApproved() int32` + +GetRolesApproved returns the RolesApproved field if non-nil, zero value otherwise. + +### GetRolesApprovedOk + +`func (o *IdentityCertDecisionSummary) GetRolesApprovedOk() (*int32, bool)` + +GetRolesApprovedOk returns a tuple with the RolesApproved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRolesApproved + +`func (o *IdentityCertDecisionSummary) SetRolesApproved(v int32)` + +SetRolesApproved sets RolesApproved field to given value. + +### HasRolesApproved + +`func (o *IdentityCertDecisionSummary) HasRolesApproved() bool` + +HasRolesApproved returns a boolean if a field has been set. + +### GetRolesRevoked + +`func (o *IdentityCertDecisionSummary) GetRolesRevoked() int32` + +GetRolesRevoked returns the RolesRevoked field if non-nil, zero value otherwise. + +### GetRolesRevokedOk + +`func (o *IdentityCertDecisionSummary) GetRolesRevokedOk() (*int32, bool)` + +GetRolesRevokedOk returns a tuple with the RolesRevoked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRolesRevoked + +`func (o *IdentityCertDecisionSummary) SetRolesRevoked(v int32)` + +SetRolesRevoked sets RolesRevoked field to given value. + +### HasRolesRevoked + +`func (o *IdentityCertDecisionSummary) HasRolesRevoked() bool` + +HasRolesRevoked returns a boolean if a field has been set. + +### GetAccountsApproved + +`func (o *IdentityCertDecisionSummary) GetAccountsApproved() int32` + +GetAccountsApproved returns the AccountsApproved field if non-nil, zero value otherwise. + +### GetAccountsApprovedOk + +`func (o *IdentityCertDecisionSummary) GetAccountsApprovedOk() (*int32, bool)` + +GetAccountsApprovedOk returns a tuple with the AccountsApproved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountsApproved + +`func (o *IdentityCertDecisionSummary) SetAccountsApproved(v int32)` + +SetAccountsApproved sets AccountsApproved field to given value. + +### HasAccountsApproved + +`func (o *IdentityCertDecisionSummary) HasAccountsApproved() bool` + +HasAccountsApproved returns a boolean if a field has been set. + +### GetAccountsRevoked + +`func (o *IdentityCertDecisionSummary) GetAccountsRevoked() int32` + +GetAccountsRevoked returns the AccountsRevoked field if non-nil, zero value otherwise. + +### GetAccountsRevokedOk + +`func (o *IdentityCertDecisionSummary) GetAccountsRevokedOk() (*int32, bool)` + +GetAccountsRevokedOk returns a tuple with the AccountsRevoked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountsRevoked + +`func (o *IdentityCertDecisionSummary) SetAccountsRevoked(v int32)` + +SetAccountsRevoked sets AccountsRevoked field to given value. + +### HasAccountsRevoked + +`func (o *IdentityCertDecisionSummary) HasAccountsRevoked() bool` + +HasAccountsRevoked returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityCertificationDto.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityCertificationDto.md new file mode 100644 index 000000000..547107787 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityCertificationDto.md @@ -0,0 +1,520 @@ +--- +id: v2024-identity-certification-dto +title: IdentityCertificationDto +pagination_label: IdentityCertificationDto +sidebar_label: IdentityCertificationDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCertificationDto', 'V2024IdentityCertificationDto'] +slug: /tools/sdk/go/v2024/models/identity-certification-dto +tags: ['SDK', 'Software Development Kit', 'IdentityCertificationDto', 'V2024IdentityCertificationDto'] +--- + +# IdentityCertificationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | id of the certification | [optional] +**Name** | Pointer to **string** | name of the certification | [optional] +**Campaign** | Pointer to [**CampaignReference**](campaign-reference) | | [optional] +**Completed** | Pointer to **bool** | Have all decisions been made? | [optional] +**IdentitiesCompleted** | Pointer to **int32** | The number of identities for whom all decisions have been made and are complete. | [optional] +**IdentitiesTotal** | Pointer to **int32** | The total number of identities in the Certification, both complete and incomplete. | [optional] +**Created** | Pointer to **SailPointTime** | created date | [optional] +**Modified** | Pointer to **SailPointTime** | modified date | [optional] +**DecisionsMade** | Pointer to **int32** | The number of approve/revoke/acknowledge decisions that have been made. | [optional] +**DecisionsTotal** | Pointer to **int32** | The total number of approve/revoke/acknowledge decisions. | [optional] +**Due** | Pointer to **NullableTime** | The due date of the certification. | [optional] +**Signed** | Pointer to **NullableTime** | The date the reviewer signed off on the Certification. | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] +**Reassignment** | Pointer to [**NullableReassignment**](reassignment) | | [optional] +**HasErrors** | Pointer to **bool** | Identifies if the certification has an error | [optional] +**ErrorMessage** | Pointer to **NullableString** | Description of the certification error | [optional] +**Phase** | Pointer to [**CertificationPhase**](certification-phase) | | [optional] + +## Methods + +### NewIdentityCertificationDto + +`func NewIdentityCertificationDto() *IdentityCertificationDto` + +NewIdentityCertificationDto instantiates a new IdentityCertificationDto 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 + +### NewIdentityCertificationDtoWithDefaults + +`func NewIdentityCertificationDtoWithDefaults() *IdentityCertificationDto` + +NewIdentityCertificationDtoWithDefaults instantiates a new IdentityCertificationDto 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 + +### GetId + +`func (o *IdentityCertificationDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityCertificationDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityCertificationDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityCertificationDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityCertificationDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityCertificationDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityCertificationDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityCertificationDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCampaign + +`func (o *IdentityCertificationDto) GetCampaign() CampaignReference` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *IdentityCertificationDto) GetCampaignOk() (*CampaignReference, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *IdentityCertificationDto) SetCampaign(v CampaignReference)` + +SetCampaign sets Campaign field to given value. + +### HasCampaign + +`func (o *IdentityCertificationDto) HasCampaign() bool` + +HasCampaign returns a boolean if a field has been set. + +### GetCompleted + +`func (o *IdentityCertificationDto) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *IdentityCertificationDto) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *IdentityCertificationDto) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *IdentityCertificationDto) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetIdentitiesCompleted + +`func (o *IdentityCertificationDto) GetIdentitiesCompleted() int32` + +GetIdentitiesCompleted returns the IdentitiesCompleted field if non-nil, zero value otherwise. + +### GetIdentitiesCompletedOk + +`func (o *IdentityCertificationDto) GetIdentitiesCompletedOk() (*int32, bool)` + +GetIdentitiesCompletedOk returns a tuple with the IdentitiesCompleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesCompleted + +`func (o *IdentityCertificationDto) SetIdentitiesCompleted(v int32)` + +SetIdentitiesCompleted sets IdentitiesCompleted field to given value. + +### HasIdentitiesCompleted + +`func (o *IdentityCertificationDto) HasIdentitiesCompleted() bool` + +HasIdentitiesCompleted returns a boolean if a field has been set. + +### GetIdentitiesTotal + +`func (o *IdentityCertificationDto) GetIdentitiesTotal() int32` + +GetIdentitiesTotal returns the IdentitiesTotal field if non-nil, zero value otherwise. + +### GetIdentitiesTotalOk + +`func (o *IdentityCertificationDto) GetIdentitiesTotalOk() (*int32, bool)` + +GetIdentitiesTotalOk returns a tuple with the IdentitiesTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesTotal + +`func (o *IdentityCertificationDto) SetIdentitiesTotal(v int32)` + +SetIdentitiesTotal sets IdentitiesTotal field to given value. + +### HasIdentitiesTotal + +`func (o *IdentityCertificationDto) HasIdentitiesTotal() bool` + +HasIdentitiesTotal returns a boolean if a field has been set. + +### GetCreated + +`func (o *IdentityCertificationDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *IdentityCertificationDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *IdentityCertificationDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *IdentityCertificationDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *IdentityCertificationDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *IdentityCertificationDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *IdentityCertificationDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *IdentityCertificationDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDecisionsMade + +`func (o *IdentityCertificationDto) GetDecisionsMade() int32` + +GetDecisionsMade returns the DecisionsMade field if non-nil, zero value otherwise. + +### GetDecisionsMadeOk + +`func (o *IdentityCertificationDto) GetDecisionsMadeOk() (*int32, bool)` + +GetDecisionsMadeOk returns a tuple with the DecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsMade + +`func (o *IdentityCertificationDto) SetDecisionsMade(v int32)` + +SetDecisionsMade sets DecisionsMade field to given value. + +### HasDecisionsMade + +`func (o *IdentityCertificationDto) HasDecisionsMade() bool` + +HasDecisionsMade returns a boolean if a field has been set. + +### GetDecisionsTotal + +`func (o *IdentityCertificationDto) GetDecisionsTotal() int32` + +GetDecisionsTotal returns the DecisionsTotal field if non-nil, zero value otherwise. + +### GetDecisionsTotalOk + +`func (o *IdentityCertificationDto) GetDecisionsTotalOk() (*int32, bool)` + +GetDecisionsTotalOk returns a tuple with the DecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsTotal + +`func (o *IdentityCertificationDto) SetDecisionsTotal(v int32)` + +SetDecisionsTotal sets DecisionsTotal field to given value. + +### HasDecisionsTotal + +`func (o *IdentityCertificationDto) HasDecisionsTotal() bool` + +HasDecisionsTotal returns a boolean if a field has been set. + +### GetDue + +`func (o *IdentityCertificationDto) GetDue() SailPointTime` + +GetDue returns the Due field if non-nil, zero value otherwise. + +### GetDueOk + +`func (o *IdentityCertificationDto) GetDueOk() (*SailPointTime, bool)` + +GetDueOk returns a tuple with the Due field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDue + +`func (o *IdentityCertificationDto) SetDue(v SailPointTime)` + +SetDue sets Due field to given value. + +### HasDue + +`func (o *IdentityCertificationDto) HasDue() bool` + +HasDue returns a boolean if a field has been set. + +### SetDueNil + +`func (o *IdentityCertificationDto) SetDueNil(b bool)` + + SetDueNil sets the value for Due to be an explicit nil + +### UnsetDue +`func (o *IdentityCertificationDto) UnsetDue()` + +UnsetDue ensures that no value is present for Due, not even an explicit nil +### GetSigned + +`func (o *IdentityCertificationDto) GetSigned() SailPointTime` + +GetSigned returns the Signed field if non-nil, zero value otherwise. + +### GetSignedOk + +`func (o *IdentityCertificationDto) GetSignedOk() (*SailPointTime, bool)` + +GetSignedOk returns a tuple with the Signed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigned + +`func (o *IdentityCertificationDto) SetSigned(v SailPointTime)` + +SetSigned sets Signed field to given value. + +### HasSigned + +`func (o *IdentityCertificationDto) HasSigned() bool` + +HasSigned returns a boolean if a field has been set. + +### SetSignedNil + +`func (o *IdentityCertificationDto) SetSignedNil(b bool)` + + SetSignedNil sets the value for Signed to be an explicit nil + +### UnsetSigned +`func (o *IdentityCertificationDto) UnsetSigned()` + +UnsetSigned ensures that no value is present for Signed, not even an explicit nil +### GetReviewer + +`func (o *IdentityCertificationDto) GetReviewer() Reviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *IdentityCertificationDto) GetReviewerOk() (*Reviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *IdentityCertificationDto) SetReviewer(v Reviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *IdentityCertificationDto) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetReassignment + +`func (o *IdentityCertificationDto) GetReassignment() Reassignment` + +GetReassignment returns the Reassignment field if non-nil, zero value otherwise. + +### GetReassignmentOk + +`func (o *IdentityCertificationDto) GetReassignmentOk() (*Reassignment, bool)` + +GetReassignmentOk returns a tuple with the Reassignment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignment + +`func (o *IdentityCertificationDto) SetReassignment(v Reassignment)` + +SetReassignment sets Reassignment field to given value. + +### HasReassignment + +`func (o *IdentityCertificationDto) HasReassignment() bool` + +HasReassignment returns a boolean if a field has been set. + +### SetReassignmentNil + +`func (o *IdentityCertificationDto) SetReassignmentNil(b bool)` + + SetReassignmentNil sets the value for Reassignment to be an explicit nil + +### UnsetReassignment +`func (o *IdentityCertificationDto) UnsetReassignment()` + +UnsetReassignment ensures that no value is present for Reassignment, not even an explicit nil +### GetHasErrors + +`func (o *IdentityCertificationDto) GetHasErrors() bool` + +GetHasErrors returns the HasErrors field if non-nil, zero value otherwise. + +### GetHasErrorsOk + +`func (o *IdentityCertificationDto) GetHasErrorsOk() (*bool, bool)` + +GetHasErrorsOk returns a tuple with the HasErrors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasErrors + +`func (o *IdentityCertificationDto) SetHasErrors(v bool)` + +SetHasErrors sets HasErrors field to given value. + +### HasHasErrors + +`func (o *IdentityCertificationDto) HasHasErrors() bool` + +HasHasErrors returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *IdentityCertificationDto) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *IdentityCertificationDto) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *IdentityCertificationDto) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *IdentityCertificationDto) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### SetErrorMessageNil + +`func (o *IdentityCertificationDto) SetErrorMessageNil(b bool)` + + SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil + +### UnsetErrorMessage +`func (o *IdentityCertificationDto) UnsetErrorMessage()` + +UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil +### GetPhase + +`func (o *IdentityCertificationDto) GetPhase() CertificationPhase` + +GetPhase returns the Phase field if non-nil, zero value otherwise. + +### GetPhaseOk + +`func (o *IdentityCertificationDto) GetPhaseOk() (*CertificationPhase, bool)` + +GetPhaseOk returns a tuple with the Phase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhase + +`func (o *IdentityCertificationDto) SetPhase(v CertificationPhase)` + +SetPhase sets Phase field to given value. + +### HasPhase + +`func (o *IdentityCertificationDto) HasPhase() bool` + +HasPhase returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityCertified.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityCertified.md new file mode 100644 index 000000000..fa2828fbe --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityCertified.md @@ -0,0 +1,246 @@ +--- +id: v2024-identity-certified +title: IdentityCertified +pagination_label: IdentityCertified +sidebar_label: IdentityCertified +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCertified', 'V2024IdentityCertified'] +slug: /tools/sdk/go/v2024/models/identity-certified +tags: ['SDK', 'Software Development Kit', 'IdentityCertified', 'V2024IdentityCertified'] +--- + +# IdentityCertified + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CertificationId** | Pointer to **string** | the id of the certification item | [optional] +**CertificationName** | Pointer to **string** | the certification item name | [optional] +**SignedDate** | Pointer to **string** | the date ceritification was signed | [optional] +**Certifiers** | Pointer to [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional] +**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional] +**Signer** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] + +## Methods + +### NewIdentityCertified + +`func NewIdentityCertified() *IdentityCertified` + +NewIdentityCertified instantiates a new IdentityCertified 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 + +### NewIdentityCertifiedWithDefaults + +`func NewIdentityCertifiedWithDefaults() *IdentityCertified` + +NewIdentityCertifiedWithDefaults instantiates a new IdentityCertified 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 + +### GetCertificationId + +`func (o *IdentityCertified) GetCertificationId() string` + +GetCertificationId returns the CertificationId field if non-nil, zero value otherwise. + +### GetCertificationIdOk + +`func (o *IdentityCertified) GetCertificationIdOk() (*string, bool)` + +GetCertificationIdOk returns a tuple with the CertificationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationId + +`func (o *IdentityCertified) SetCertificationId(v string)` + +SetCertificationId sets CertificationId field to given value. + +### HasCertificationId + +`func (o *IdentityCertified) HasCertificationId() bool` + +HasCertificationId returns a boolean if a field has been set. + +### GetCertificationName + +`func (o *IdentityCertified) GetCertificationName() string` + +GetCertificationName returns the CertificationName field if non-nil, zero value otherwise. + +### GetCertificationNameOk + +`func (o *IdentityCertified) GetCertificationNameOk() (*string, bool)` + +GetCertificationNameOk returns a tuple with the CertificationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationName + +`func (o *IdentityCertified) SetCertificationName(v string)` + +SetCertificationName sets CertificationName field to given value. + +### HasCertificationName + +`func (o *IdentityCertified) HasCertificationName() bool` + +HasCertificationName returns a boolean if a field has been set. + +### GetSignedDate + +`func (o *IdentityCertified) GetSignedDate() string` + +GetSignedDate returns the SignedDate field if non-nil, zero value otherwise. + +### GetSignedDateOk + +`func (o *IdentityCertified) GetSignedDateOk() (*string, bool)` + +GetSignedDateOk returns a tuple with the SignedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignedDate + +`func (o *IdentityCertified) SetSignedDate(v string)` + +SetSignedDate sets SignedDate field to given value. + +### HasSignedDate + +`func (o *IdentityCertified) HasSignedDate() bool` + +HasSignedDate returns a boolean if a field has been set. + +### GetCertifiers + +`func (o *IdentityCertified) GetCertifiers() []CertifierResponse` + +GetCertifiers returns the Certifiers field if non-nil, zero value otherwise. + +### GetCertifiersOk + +`func (o *IdentityCertified) GetCertifiersOk() (*[]CertifierResponse, bool)` + +GetCertifiersOk returns a tuple with the Certifiers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertifiers + +`func (o *IdentityCertified) SetCertifiers(v []CertifierResponse)` + +SetCertifiers sets Certifiers field to given value. + +### HasCertifiers + +`func (o *IdentityCertified) HasCertifiers() bool` + +HasCertifiers returns a boolean if a field has been set. + +### GetReviewers + +`func (o *IdentityCertified) GetReviewers() []CertifierResponse` + +GetReviewers returns the Reviewers field if non-nil, zero value otherwise. + +### GetReviewersOk + +`func (o *IdentityCertified) GetReviewersOk() (*[]CertifierResponse, bool)` + +GetReviewersOk returns a tuple with the Reviewers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewers + +`func (o *IdentityCertified) SetReviewers(v []CertifierResponse)` + +SetReviewers sets Reviewers field to given value. + +### HasReviewers + +`func (o *IdentityCertified) HasReviewers() bool` + +HasReviewers returns a boolean if a field has been set. + +### GetSigner + +`func (o *IdentityCertified) GetSigner() CertifierResponse` + +GetSigner returns the Signer field if non-nil, zero value otherwise. + +### GetSignerOk + +`func (o *IdentityCertified) GetSignerOk() (*CertifierResponse, bool)` + +GetSignerOk returns a tuple with the Signer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigner + +`func (o *IdentityCertified) SetSigner(v CertifierResponse)` + +SetSigner sets Signer field to given value. + +### HasSigner + +`func (o *IdentityCertified) HasSigner() bool` + +HasSigner returns a boolean if a field has been set. + +### GetEventType + +`func (o *IdentityCertified) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *IdentityCertified) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *IdentityCertified) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *IdentityCertified) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDt + +`func (o *IdentityCertified) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *IdentityCertified) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *IdentityCertified) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *IdentityCertified) HasDt() bool` + +HasDt returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityCompareResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityCompareResponse.md new file mode 100644 index 000000000..77d2f1a72 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityCompareResponse.md @@ -0,0 +1,64 @@ +--- +id: v2024-identity-compare-response +title: IdentityCompareResponse +pagination_label: IdentityCompareResponse +sidebar_label: IdentityCompareResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCompareResponse', 'V2024IdentityCompareResponse'] +slug: /tools/sdk/go/v2024/models/identity-compare-response +tags: ['SDK', 'Software Development Kit', 'IdentityCompareResponse', 'V2024IdentityCompareResponse'] +--- + +# IdentityCompareResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItemDiff** | Pointer to **map[string]map[string]interface{}** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] + +## Methods + +### NewIdentityCompareResponse + +`func NewIdentityCompareResponse() *IdentityCompareResponse` + +NewIdentityCompareResponse instantiates a new IdentityCompareResponse 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 + +### NewIdentityCompareResponseWithDefaults + +`func NewIdentityCompareResponseWithDefaults() *IdentityCompareResponse` + +NewIdentityCompareResponseWithDefaults instantiates a new IdentityCompareResponse 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 + +### GetAccessItemDiff + +`func (o *IdentityCompareResponse) GetAccessItemDiff() map[string]map[string]interface{}` + +GetAccessItemDiff returns the AccessItemDiff field if non-nil, zero value otherwise. + +### GetAccessItemDiffOk + +`func (o *IdentityCompareResponse) GetAccessItemDiffOk() (*map[string]map[string]interface{}, bool)` + +GetAccessItemDiffOk returns a tuple with the AccessItemDiff field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItemDiff + +`func (o *IdentityCompareResponse) SetAccessItemDiff(v map[string]map[string]interface{})` + +SetAccessItemDiff sets AccessItemDiff field to given value. + +### HasAccessItemDiff + +`func (o *IdentityCompareResponse) HasAccessItemDiff() bool` + +HasAccessItemDiff returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityCreated.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityCreated.md new file mode 100644 index 000000000..30845bfd0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityCreated.md @@ -0,0 +1,80 @@ +--- +id: v2024-identity-created +title: IdentityCreated +pagination_label: IdentityCreated +sidebar_label: IdentityCreated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCreated', 'V2024IdentityCreated'] +slug: /tools/sdk/go/v2024/models/identity-created +tags: ['SDK', 'Software Development Kit', 'IdentityCreated', 'V2024IdentityCreated'] +--- + +# IdentityCreated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**IdentityCreatedIdentity**](identity-created-identity) | | +**Attributes** | **map[string]interface{}** | The attributes assigned to the identity. Attributes are determined by the identity profile. | + +## Methods + +### NewIdentityCreated + +`func NewIdentityCreated(identity IdentityCreatedIdentity, attributes map[string]interface{}, ) *IdentityCreated` + +NewIdentityCreated instantiates a new IdentityCreated 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 + +### NewIdentityCreatedWithDefaults + +`func NewIdentityCreatedWithDefaults() *IdentityCreated` + +NewIdentityCreatedWithDefaults instantiates a new IdentityCreated 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 + +### GetIdentity + +`func (o *IdentityCreated) GetIdentity() IdentityCreatedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *IdentityCreated) GetIdentityOk() (*IdentityCreatedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *IdentityCreated) SetIdentity(v IdentityCreatedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetAttributes + +`func (o *IdentityCreated) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *IdentityCreated) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *IdentityCreated) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityCreatedIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityCreatedIdentity.md new file mode 100644 index 000000000..7652cd2e4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityCreatedIdentity.md @@ -0,0 +1,101 @@ +--- +id: v2024-identity-created-identity +title: IdentityCreatedIdentity +pagination_label: IdentityCreatedIdentity +sidebar_label: IdentityCreatedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCreatedIdentity', 'V2024IdentityCreatedIdentity'] +slug: /tools/sdk/go/v2024/models/identity-created-identity +tags: ['SDK', 'Software Development Kit', 'IdentityCreatedIdentity', 'V2024IdentityCreatedIdentity'] +--- + +# IdentityCreatedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Created identity's DTO type. | +**Id** | **string** | Created identity ID. | +**Name** | **string** | Created identity's display name. | + +## Methods + +### NewIdentityCreatedIdentity + +`func NewIdentityCreatedIdentity(type_ string, id string, name string, ) *IdentityCreatedIdentity` + +NewIdentityCreatedIdentity instantiates a new IdentityCreatedIdentity 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 + +### NewIdentityCreatedIdentityWithDefaults + +`func NewIdentityCreatedIdentityWithDefaults() *IdentityCreatedIdentity` + +NewIdentityCreatedIdentityWithDefaults instantiates a new IdentityCreatedIdentity 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 + +### GetType + +`func (o *IdentityCreatedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityCreatedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityCreatedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *IdentityCreatedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityCreatedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityCreatedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *IdentityCreatedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityCreatedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityCreatedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityDeleted.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityDeleted.md new file mode 100644 index 000000000..cef135203 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityDeleted.md @@ -0,0 +1,80 @@ +--- +id: v2024-identity-deleted +title: IdentityDeleted +pagination_label: IdentityDeleted +sidebar_label: IdentityDeleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDeleted', 'V2024IdentityDeleted'] +slug: /tools/sdk/go/v2024/models/identity-deleted +tags: ['SDK', 'Software Development Kit', 'IdentityDeleted', 'V2024IdentityDeleted'] +--- + +# IdentityDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | +**Attributes** | **map[string]interface{}** | The attributes assigned to the identity. Attributes are determined by the identity profile. | + +## Methods + +### NewIdentityDeleted + +`func NewIdentityDeleted(identity IdentityDeletedIdentity, attributes map[string]interface{}, ) *IdentityDeleted` + +NewIdentityDeleted instantiates a new IdentityDeleted 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 + +### NewIdentityDeletedWithDefaults + +`func NewIdentityDeletedWithDefaults() *IdentityDeleted` + +NewIdentityDeletedWithDefaults instantiates a new IdentityDeleted 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 + +### GetIdentity + +`func (o *IdentityDeleted) GetIdentity() IdentityDeletedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *IdentityDeleted) GetIdentityOk() (*IdentityDeletedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *IdentityDeleted) SetIdentity(v IdentityDeletedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetAttributes + +`func (o *IdentityDeleted) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *IdentityDeleted) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *IdentityDeleted) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityDeletedIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityDeletedIdentity.md new file mode 100644 index 000000000..9fb8ace6f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityDeletedIdentity.md @@ -0,0 +1,101 @@ +--- +id: v2024-identity-deleted-identity +title: IdentityDeletedIdentity +pagination_label: IdentityDeletedIdentity +sidebar_label: IdentityDeletedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDeletedIdentity', 'V2024IdentityDeletedIdentity'] +slug: /tools/sdk/go/v2024/models/identity-deleted-identity +tags: ['SDK', 'Software Development Kit', 'IdentityDeletedIdentity', 'V2024IdentityDeletedIdentity'] +--- + +# IdentityDeletedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Deleted identity's DTO type. | +**Id** | **string** | Deleted identity ID. | +**Name** | **string** | Deleted identity's display name. | + +## Methods + +### NewIdentityDeletedIdentity + +`func NewIdentityDeletedIdentity(type_ string, id string, name string, ) *IdentityDeletedIdentity` + +NewIdentityDeletedIdentity instantiates a new IdentityDeletedIdentity 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 + +### NewIdentityDeletedIdentityWithDefaults + +`func NewIdentityDeletedIdentityWithDefaults() *IdentityDeletedIdentity` + +NewIdentityDeletedIdentityWithDefaults instantiates a new IdentityDeletedIdentity 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 + +### GetType + +`func (o *IdentityDeletedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityDeletedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityDeletedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *IdentityDeletedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityDeletedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityDeletedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *IdentityDeletedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityDeletedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityDeletedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityDocument.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityDocument.md new file mode 100644 index 000000000..1c8d4bb97 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityDocument.md @@ -0,0 +1,1066 @@ +--- +id: v2024-identity-document +title: IdentityDocument +pagination_label: IdentityDocument +sidebar_label: IdentityDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDocument', 'V2024IdentityDocument'] +slug: /tools/sdk/go/v2024/models/identity-document +tags: ['SDK', 'Software Development Kit', 'IdentityDocument', 'V2024IdentityDocument'] +--- + +# IdentityDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the referenced object. | +**Name** | **string** | The human readable name of the referenced object. | +**DisplayName** | Pointer to **string** | Identity's display name. | [optional] +**FirstName** | Pointer to **string** | Identity's first name. | [optional] +**LastName** | Pointer to **string** | Identity's last name. | [optional] +**Email** | Pointer to **string** | Identity's primary email address. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Phone** | Pointer to **string** | Identity's phone number. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Inactive** | Pointer to **bool** | Indicates whether the identity is inactive. | [optional] [default to false] +**Protected** | Pointer to **bool** | Indicates whether the identity is protected. | [optional] [default to false] +**Status** | Pointer to **string** | Identity's status in SailPoint. | [optional] +**EmployeeNumber** | Pointer to **string** | Identity's employee number. | [optional] +**Manager** | Pointer to [**NullableIdentityDocumentAllOfManager**](identity-document-all-of-manager) | | [optional] +**IsManager** | Pointer to **bool** | Indicates whether the identity is a manager of other identities. | [optional] +**IdentityProfile** | Pointer to [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional] +**Source** | Pointer to [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Map or dictionary of key/value pairs. | [optional] +**Disabled** | Pointer to **bool** | Indicates whether the identity is disabled. | [optional] [default to false] +**Locked** | Pointer to **bool** | Indicates whether the identity is locked. | [optional] [default to false] +**ProcessingState** | Pointer to **NullableString** | Identity's processing state. | [optional] +**ProcessingDetails** | Pointer to [**ProcessingDetails**](processing-details) | | [optional] +**Accounts** | Pointer to [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional] +**AccountCount** | Pointer to **int32** | Number of accounts associated with the identity. | [optional] +**Apps** | Pointer to [**[]App**](app) | List of applications the identity has access to. | [optional] +**AppCount** | Pointer to **int32** | Number of applications the identity has access to. | [optional] +**Access** | Pointer to [**[]IdentityAccess**](identity-access) | List of access items assigned to the identity. | [optional] +**AccessCount** | Pointer to **int32** | Number of access items assigned to the identity. | [optional] +**EntitlementCount** | Pointer to **int32** | Number of entitlements assigned to the identity. | [optional] +**RoleCount** | Pointer to **int32** | Number of roles assigned to the identity. | [optional] +**AccessProfileCount** | Pointer to **int32** | Number of access profiles assigned to the identity. | [optional] +**Owns** | Pointer to [**[]Owns**](owns) | Access items the identity owns. | [optional] +**OwnsCount** | Pointer to **int32** | Number of access items the identity owns. | [optional] +**Tags** | Pointer to **[]string** | Tags that have been applied to the object. | [optional] +**TagsCount** | Pointer to **int32** | Number of tags on the identity. | [optional] +**VisibleSegments** | Pointer to **[]string** | List of segments that the identity is in. | [optional] +**VisibleSegmentCount** | Pointer to **int32** | Number of segments the identity is in. | [optional] + +## Methods + +### NewIdentityDocument + +`func NewIdentityDocument(id string, name string, ) *IdentityDocument` + +NewIdentityDocument instantiates a new IdentityDocument 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 + +### NewIdentityDocumentWithDefaults + +`func NewIdentityDocumentWithDefaults() *IdentityDocument` + +NewIdentityDocumentWithDefaults instantiates a new IdentityDocument 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 + +### GetId + +`func (o *IdentityDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityDocument) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *IdentityDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityDocument) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDisplayName + +`func (o *IdentityDocument) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityDocument) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityDocument) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityDocument) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *IdentityDocument) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *IdentityDocument) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *IdentityDocument) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *IdentityDocument) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### GetLastName + +`func (o *IdentityDocument) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *IdentityDocument) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *IdentityDocument) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *IdentityDocument) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### GetEmail + +`func (o *IdentityDocument) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *IdentityDocument) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *IdentityDocument) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *IdentityDocument) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetCreated + +`func (o *IdentityDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *IdentityDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *IdentityDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *IdentityDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *IdentityDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *IdentityDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *IdentityDocument) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *IdentityDocument) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *IdentityDocument) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *IdentityDocument) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *IdentityDocument) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *IdentityDocument) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetPhone + +`func (o *IdentityDocument) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *IdentityDocument) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *IdentityDocument) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *IdentityDocument) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### GetSynced + +`func (o *IdentityDocument) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *IdentityDocument) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *IdentityDocument) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *IdentityDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetInactive + +`func (o *IdentityDocument) GetInactive() bool` + +GetInactive returns the Inactive field if non-nil, zero value otherwise. + +### GetInactiveOk + +`func (o *IdentityDocument) GetInactiveOk() (*bool, bool)` + +GetInactiveOk returns a tuple with the Inactive field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInactive + +`func (o *IdentityDocument) SetInactive(v bool)` + +SetInactive sets Inactive field to given value. + +### HasInactive + +`func (o *IdentityDocument) HasInactive() bool` + +HasInactive returns a boolean if a field has been set. + +### GetProtected + +`func (o *IdentityDocument) GetProtected() bool` + +GetProtected returns the Protected field if non-nil, zero value otherwise. + +### GetProtectedOk + +`func (o *IdentityDocument) GetProtectedOk() (*bool, bool)` + +GetProtectedOk returns a tuple with the Protected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProtected + +`func (o *IdentityDocument) SetProtected(v bool)` + +SetProtected sets Protected field to given value. + +### HasProtected + +`func (o *IdentityDocument) HasProtected() bool` + +HasProtected returns a boolean if a field has been set. + +### GetStatus + +`func (o *IdentityDocument) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *IdentityDocument) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *IdentityDocument) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *IdentityDocument) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetEmployeeNumber + +`func (o *IdentityDocument) GetEmployeeNumber() string` + +GetEmployeeNumber returns the EmployeeNumber field if non-nil, zero value otherwise. + +### GetEmployeeNumberOk + +`func (o *IdentityDocument) GetEmployeeNumberOk() (*string, bool)` + +GetEmployeeNumberOk returns a tuple with the EmployeeNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmployeeNumber + +`func (o *IdentityDocument) SetEmployeeNumber(v string)` + +SetEmployeeNumber sets EmployeeNumber field to given value. + +### HasEmployeeNumber + +`func (o *IdentityDocument) HasEmployeeNumber() bool` + +HasEmployeeNumber returns a boolean if a field has been set. + +### GetManager + +`func (o *IdentityDocument) GetManager() IdentityDocumentAllOfManager` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *IdentityDocument) GetManagerOk() (*IdentityDocumentAllOfManager, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *IdentityDocument) SetManager(v IdentityDocumentAllOfManager)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *IdentityDocument) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### SetManagerNil + +`func (o *IdentityDocument) SetManagerNil(b bool)` + + SetManagerNil sets the value for Manager to be an explicit nil + +### UnsetManager +`func (o *IdentityDocument) UnsetManager()` + +UnsetManager ensures that no value is present for Manager, not even an explicit nil +### GetIsManager + +`func (o *IdentityDocument) GetIsManager() bool` + +GetIsManager returns the IsManager field if non-nil, zero value otherwise. + +### GetIsManagerOk + +`func (o *IdentityDocument) GetIsManagerOk() (*bool, bool)` + +GetIsManagerOk returns a tuple with the IsManager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsManager + +`func (o *IdentityDocument) SetIsManager(v bool)` + +SetIsManager sets IsManager field to given value. + +### HasIsManager + +`func (o *IdentityDocument) HasIsManager() bool` + +HasIsManager returns a boolean if a field has been set. + +### GetIdentityProfile + +`func (o *IdentityDocument) GetIdentityProfile() IdentityDocumentAllOfIdentityProfile` + +GetIdentityProfile returns the IdentityProfile field if non-nil, zero value otherwise. + +### GetIdentityProfileOk + +`func (o *IdentityDocument) GetIdentityProfileOk() (*IdentityDocumentAllOfIdentityProfile, bool)` + +GetIdentityProfileOk returns a tuple with the IdentityProfile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityProfile + +`func (o *IdentityDocument) SetIdentityProfile(v IdentityDocumentAllOfIdentityProfile)` + +SetIdentityProfile sets IdentityProfile field to given value. + +### HasIdentityProfile + +`func (o *IdentityDocument) HasIdentityProfile() bool` + +HasIdentityProfile returns a boolean if a field has been set. + +### GetSource + +`func (o *IdentityDocument) GetSource() IdentityDocumentAllOfSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *IdentityDocument) GetSourceOk() (*IdentityDocumentAllOfSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *IdentityDocument) SetSource(v IdentityDocumentAllOfSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *IdentityDocument) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAttributes + +`func (o *IdentityDocument) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *IdentityDocument) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *IdentityDocument) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *IdentityDocument) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetDisabled + +`func (o *IdentityDocument) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *IdentityDocument) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *IdentityDocument) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *IdentityDocument) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetLocked + +`func (o *IdentityDocument) GetLocked() bool` + +GetLocked returns the Locked field if non-nil, zero value otherwise. + +### GetLockedOk + +`func (o *IdentityDocument) GetLockedOk() (*bool, bool)` + +GetLockedOk returns a tuple with the Locked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocked + +`func (o *IdentityDocument) SetLocked(v bool)` + +SetLocked sets Locked field to given value. + +### HasLocked + +`func (o *IdentityDocument) HasLocked() bool` + +HasLocked returns a boolean if a field has been set. + +### GetProcessingState + +`func (o *IdentityDocument) GetProcessingState() string` + +GetProcessingState returns the ProcessingState field if non-nil, zero value otherwise. + +### GetProcessingStateOk + +`func (o *IdentityDocument) GetProcessingStateOk() (*string, bool)` + +GetProcessingStateOk returns a tuple with the ProcessingState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessingState + +`func (o *IdentityDocument) SetProcessingState(v string)` + +SetProcessingState sets ProcessingState field to given value. + +### HasProcessingState + +`func (o *IdentityDocument) HasProcessingState() bool` + +HasProcessingState returns a boolean if a field has been set. + +### SetProcessingStateNil + +`func (o *IdentityDocument) SetProcessingStateNil(b bool)` + + SetProcessingStateNil sets the value for ProcessingState to be an explicit nil + +### UnsetProcessingState +`func (o *IdentityDocument) UnsetProcessingState()` + +UnsetProcessingState ensures that no value is present for ProcessingState, not even an explicit nil +### GetProcessingDetails + +`func (o *IdentityDocument) GetProcessingDetails() ProcessingDetails` + +GetProcessingDetails returns the ProcessingDetails field if non-nil, zero value otherwise. + +### GetProcessingDetailsOk + +`func (o *IdentityDocument) GetProcessingDetailsOk() (*ProcessingDetails, bool)` + +GetProcessingDetailsOk returns a tuple with the ProcessingDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessingDetails + +`func (o *IdentityDocument) SetProcessingDetails(v ProcessingDetails)` + +SetProcessingDetails sets ProcessingDetails field to given value. + +### HasProcessingDetails + +`func (o *IdentityDocument) HasProcessingDetails() bool` + +HasProcessingDetails returns a boolean if a field has been set. + +### GetAccounts + +`func (o *IdentityDocument) GetAccounts() []BaseAccount` + +GetAccounts returns the Accounts field if non-nil, zero value otherwise. + +### GetAccountsOk + +`func (o *IdentityDocument) GetAccountsOk() (*[]BaseAccount, bool)` + +GetAccountsOk returns a tuple with the Accounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccounts + +`func (o *IdentityDocument) SetAccounts(v []BaseAccount)` + +SetAccounts sets Accounts field to given value. + +### HasAccounts + +`func (o *IdentityDocument) HasAccounts() bool` + +HasAccounts returns a boolean if a field has been set. + +### GetAccountCount + +`func (o *IdentityDocument) GetAccountCount() int32` + +GetAccountCount returns the AccountCount field if non-nil, zero value otherwise. + +### GetAccountCountOk + +`func (o *IdentityDocument) GetAccountCountOk() (*int32, bool)` + +GetAccountCountOk returns a tuple with the AccountCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCount + +`func (o *IdentityDocument) SetAccountCount(v int32)` + +SetAccountCount sets AccountCount field to given value. + +### HasAccountCount + +`func (o *IdentityDocument) HasAccountCount() bool` + +HasAccountCount returns a boolean if a field has been set. + +### GetApps + +`func (o *IdentityDocument) GetApps() []App` + +GetApps returns the Apps field if non-nil, zero value otherwise. + +### GetAppsOk + +`func (o *IdentityDocument) GetAppsOk() (*[]App, bool)` + +GetAppsOk returns a tuple with the Apps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApps + +`func (o *IdentityDocument) SetApps(v []App)` + +SetApps sets Apps field to given value. + +### HasApps + +`func (o *IdentityDocument) HasApps() bool` + +HasApps returns a boolean if a field has been set. + +### GetAppCount + +`func (o *IdentityDocument) GetAppCount() int32` + +GetAppCount returns the AppCount field if non-nil, zero value otherwise. + +### GetAppCountOk + +`func (o *IdentityDocument) GetAppCountOk() (*int32, bool)` + +GetAppCountOk returns a tuple with the AppCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppCount + +`func (o *IdentityDocument) SetAppCount(v int32)` + +SetAppCount sets AppCount field to given value. + +### HasAppCount + +`func (o *IdentityDocument) HasAppCount() bool` + +HasAppCount returns a boolean if a field has been set. + +### GetAccess + +`func (o *IdentityDocument) GetAccess() []IdentityAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *IdentityDocument) GetAccessOk() (*[]IdentityAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *IdentityDocument) SetAccess(v []IdentityAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *IdentityDocument) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetAccessCount + +`func (o *IdentityDocument) GetAccessCount() int32` + +GetAccessCount returns the AccessCount field if non-nil, zero value otherwise. + +### GetAccessCountOk + +`func (o *IdentityDocument) GetAccessCountOk() (*int32, bool)` + +GetAccessCountOk returns a tuple with the AccessCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessCount + +`func (o *IdentityDocument) SetAccessCount(v int32)` + +SetAccessCount sets AccessCount field to given value. + +### HasAccessCount + +`func (o *IdentityDocument) HasAccessCount() bool` + +HasAccessCount returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *IdentityDocument) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *IdentityDocument) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *IdentityDocument) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *IdentityDocument) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetRoleCount + +`func (o *IdentityDocument) GetRoleCount() int32` + +GetRoleCount returns the RoleCount field if non-nil, zero value otherwise. + +### GetRoleCountOk + +`func (o *IdentityDocument) GetRoleCountOk() (*int32, bool)` + +GetRoleCountOk returns a tuple with the RoleCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleCount + +`func (o *IdentityDocument) SetRoleCount(v int32)` + +SetRoleCount sets RoleCount field to given value. + +### HasRoleCount + +`func (o *IdentityDocument) HasRoleCount() bool` + +HasRoleCount returns a boolean if a field has been set. + +### GetAccessProfileCount + +`func (o *IdentityDocument) GetAccessProfileCount() int32` + +GetAccessProfileCount returns the AccessProfileCount field if non-nil, zero value otherwise. + +### GetAccessProfileCountOk + +`func (o *IdentityDocument) GetAccessProfileCountOk() (*int32, bool)` + +GetAccessProfileCountOk returns a tuple with the AccessProfileCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileCount + +`func (o *IdentityDocument) SetAccessProfileCount(v int32)` + +SetAccessProfileCount sets AccessProfileCount field to given value. + +### HasAccessProfileCount + +`func (o *IdentityDocument) HasAccessProfileCount() bool` + +HasAccessProfileCount returns a boolean if a field has been set. + +### GetOwns + +`func (o *IdentityDocument) GetOwns() []Owns` + +GetOwns returns the Owns field if non-nil, zero value otherwise. + +### GetOwnsOk + +`func (o *IdentityDocument) GetOwnsOk() (*[]Owns, bool)` + +GetOwnsOk returns a tuple with the Owns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwns + +`func (o *IdentityDocument) SetOwns(v []Owns)` + +SetOwns sets Owns field to given value. + +### HasOwns + +`func (o *IdentityDocument) HasOwns() bool` + +HasOwns returns a boolean if a field has been set. + +### GetOwnsCount + +`func (o *IdentityDocument) GetOwnsCount() int32` + +GetOwnsCount returns the OwnsCount field if non-nil, zero value otherwise. + +### GetOwnsCountOk + +`func (o *IdentityDocument) GetOwnsCountOk() (*int32, bool)` + +GetOwnsCountOk returns a tuple with the OwnsCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnsCount + +`func (o *IdentityDocument) SetOwnsCount(v int32)` + +SetOwnsCount sets OwnsCount field to given value. + +### HasOwnsCount + +`func (o *IdentityDocument) HasOwnsCount() bool` + +HasOwnsCount returns a boolean if a field has been set. + +### GetTags + +`func (o *IdentityDocument) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *IdentityDocument) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *IdentityDocument) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *IdentityDocument) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetTagsCount + +`func (o *IdentityDocument) GetTagsCount() int32` + +GetTagsCount returns the TagsCount field if non-nil, zero value otherwise. + +### GetTagsCountOk + +`func (o *IdentityDocument) GetTagsCountOk() (*int32, bool)` + +GetTagsCountOk returns a tuple with the TagsCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTagsCount + +`func (o *IdentityDocument) SetTagsCount(v int32)` + +SetTagsCount sets TagsCount field to given value. + +### HasTagsCount + +`func (o *IdentityDocument) HasTagsCount() bool` + +HasTagsCount returns a boolean if a field has been set. + +### GetVisibleSegments + +`func (o *IdentityDocument) GetVisibleSegments() []string` + +GetVisibleSegments returns the VisibleSegments field if non-nil, zero value otherwise. + +### GetVisibleSegmentsOk + +`func (o *IdentityDocument) GetVisibleSegmentsOk() (*[]string, bool)` + +GetVisibleSegmentsOk returns a tuple with the VisibleSegments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVisibleSegments + +`func (o *IdentityDocument) SetVisibleSegments(v []string)` + +SetVisibleSegments sets VisibleSegments field to given value. + +### HasVisibleSegments + +`func (o *IdentityDocument) HasVisibleSegments() bool` + +HasVisibleSegments returns a boolean if a field has been set. + +### SetVisibleSegmentsNil + +`func (o *IdentityDocument) SetVisibleSegmentsNil(b bool)` + + SetVisibleSegmentsNil sets the value for VisibleSegments to be an explicit nil + +### UnsetVisibleSegments +`func (o *IdentityDocument) UnsetVisibleSegments()` + +UnsetVisibleSegments ensures that no value is present for VisibleSegments, not even an explicit nil +### GetVisibleSegmentCount + +`func (o *IdentityDocument) GetVisibleSegmentCount() int32` + +GetVisibleSegmentCount returns the VisibleSegmentCount field if non-nil, zero value otherwise. + +### GetVisibleSegmentCountOk + +`func (o *IdentityDocument) GetVisibleSegmentCountOk() (*int32, bool)` + +GetVisibleSegmentCountOk returns a tuple with the VisibleSegmentCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVisibleSegmentCount + +`func (o *IdentityDocument) SetVisibleSegmentCount(v int32)` + +SetVisibleSegmentCount sets VisibleSegmentCount field to given value. + +### HasVisibleSegmentCount + +`func (o *IdentityDocument) HasVisibleSegmentCount() bool` + +HasVisibleSegmentCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityDocumentAllOfIdentityProfile.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityDocumentAllOfIdentityProfile.md new file mode 100644 index 000000000..4252953c8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityDocumentAllOfIdentityProfile.md @@ -0,0 +1,90 @@ +--- +id: v2024-identity-document-all-of-identity-profile +title: IdentityDocumentAllOfIdentityProfile +pagination_label: IdentityDocumentAllOfIdentityProfile +sidebar_label: IdentityDocumentAllOfIdentityProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDocumentAllOfIdentityProfile', 'V2024IdentityDocumentAllOfIdentityProfile'] +slug: /tools/sdk/go/v2024/models/identity-document-all-of-identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfIdentityProfile', 'V2024IdentityDocumentAllOfIdentityProfile'] +--- + +# IdentityDocumentAllOfIdentityProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Identity profile's ID. | [optional] +**Name** | Pointer to **string** | Identity profile's name. | [optional] + +## Methods + +### NewIdentityDocumentAllOfIdentityProfile + +`func NewIdentityDocumentAllOfIdentityProfile() *IdentityDocumentAllOfIdentityProfile` + +NewIdentityDocumentAllOfIdentityProfile instantiates a new IdentityDocumentAllOfIdentityProfile 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 + +### NewIdentityDocumentAllOfIdentityProfileWithDefaults + +`func NewIdentityDocumentAllOfIdentityProfileWithDefaults() *IdentityDocumentAllOfIdentityProfile` + +NewIdentityDocumentAllOfIdentityProfileWithDefaults instantiates a new IdentityDocumentAllOfIdentityProfile 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 + +### GetId + +`func (o *IdentityDocumentAllOfIdentityProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityDocumentAllOfIdentityProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityDocumentAllOfIdentityProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityDocumentAllOfIdentityProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityDocumentAllOfIdentityProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityDocumentAllOfIdentityProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityDocumentAllOfIdentityProfile) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityDocumentAllOfIdentityProfile) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityDocumentAllOfManager.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityDocumentAllOfManager.md new file mode 100644 index 000000000..0084dd857 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityDocumentAllOfManager.md @@ -0,0 +1,116 @@ +--- +id: v2024-identity-document-all-of-manager +title: IdentityDocumentAllOfManager +pagination_label: IdentityDocumentAllOfManager +sidebar_label: IdentityDocumentAllOfManager +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDocumentAllOfManager', 'V2024IdentityDocumentAllOfManager'] +slug: /tools/sdk/go/v2024/models/identity-document-all-of-manager +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfManager', 'V2024IdentityDocumentAllOfManager'] +--- + +# IdentityDocumentAllOfManager + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of identity's manager. | [optional] +**Name** | Pointer to **string** | Name of identity's manager. | [optional] +**DisplayName** | Pointer to **string** | Display name of identity's manager. | [optional] + +## Methods + +### NewIdentityDocumentAllOfManager + +`func NewIdentityDocumentAllOfManager() *IdentityDocumentAllOfManager` + +NewIdentityDocumentAllOfManager instantiates a new IdentityDocumentAllOfManager 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 + +### NewIdentityDocumentAllOfManagerWithDefaults + +`func NewIdentityDocumentAllOfManagerWithDefaults() *IdentityDocumentAllOfManager` + +NewIdentityDocumentAllOfManagerWithDefaults instantiates a new IdentityDocumentAllOfManager 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 + +### GetId + +`func (o *IdentityDocumentAllOfManager) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityDocumentAllOfManager) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityDocumentAllOfManager) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityDocumentAllOfManager) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityDocumentAllOfManager) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityDocumentAllOfManager) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityDocumentAllOfManager) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityDocumentAllOfManager) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *IdentityDocumentAllOfManager) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityDocumentAllOfManager) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityDocumentAllOfManager) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityDocumentAllOfManager) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityDocumentAllOfSource.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityDocumentAllOfSource.md new file mode 100644 index 000000000..0d8404c22 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityDocumentAllOfSource.md @@ -0,0 +1,90 @@ +--- +id: v2024-identity-document-all-of-source +title: IdentityDocumentAllOfSource +pagination_label: IdentityDocumentAllOfSource +sidebar_label: IdentityDocumentAllOfSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDocumentAllOfSource', 'V2024IdentityDocumentAllOfSource'] +slug: /tools/sdk/go/v2024/models/identity-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfSource', 'V2024IdentityDocumentAllOfSource'] +--- + +# IdentityDocumentAllOfSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of identity's source. | [optional] +**Name** | Pointer to **string** | Display name of identity's source. | [optional] + +## Methods + +### NewIdentityDocumentAllOfSource + +`func NewIdentityDocumentAllOfSource() *IdentityDocumentAllOfSource` + +NewIdentityDocumentAllOfSource instantiates a new IdentityDocumentAllOfSource 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 + +### NewIdentityDocumentAllOfSourceWithDefaults + +`func NewIdentityDocumentAllOfSourceWithDefaults() *IdentityDocumentAllOfSource` + +NewIdentityDocumentAllOfSourceWithDefaults instantiates a new IdentityDocumentAllOfSource 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 + +### GetId + +`func (o *IdentityDocumentAllOfSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityDocumentAllOfSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityDocumentAllOfSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityDocumentAllOfSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityDocumentAllOfSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityDocumentAllOfSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityDocumentAllOfSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityDocumentAllOfSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityEntities.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityEntities.md new file mode 100644 index 000000000..c4f5bc8db --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityEntities.md @@ -0,0 +1,64 @@ +--- +id: v2024-identity-entities +title: IdentityEntities +pagination_label: IdentityEntities +sidebar_label: IdentityEntities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityEntities', 'V2024IdentityEntities'] +slug: /tools/sdk/go/v2024/models/identity-entities +tags: ['SDK', 'Software Development Kit', 'IdentityEntities', 'V2024IdentityEntities'] +--- + +# IdentityEntities + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityEntity** | Pointer to [**IdentityEntitiesIdentityEntity**](identity-entities-identity-entity) | | [optional] + +## Methods + +### NewIdentityEntities + +`func NewIdentityEntities() *IdentityEntities` + +NewIdentityEntities instantiates a new IdentityEntities 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 + +### NewIdentityEntitiesWithDefaults + +`func NewIdentityEntitiesWithDefaults() *IdentityEntities` + +NewIdentityEntitiesWithDefaults instantiates a new IdentityEntities 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 + +### GetIdentityEntity + +`func (o *IdentityEntities) GetIdentityEntity() IdentityEntitiesIdentityEntity` + +GetIdentityEntity returns the IdentityEntity field if non-nil, zero value otherwise. + +### GetIdentityEntityOk + +`func (o *IdentityEntities) GetIdentityEntityOk() (*IdentityEntitiesIdentityEntity, bool)` + +GetIdentityEntityOk returns a tuple with the IdentityEntity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityEntity + +`func (o *IdentityEntities) SetIdentityEntity(v IdentityEntitiesIdentityEntity)` + +SetIdentityEntity sets IdentityEntity field to given value. + +### HasIdentityEntity + +`func (o *IdentityEntities) HasIdentityEntity() bool` + +HasIdentityEntity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityEntitiesIdentityEntity.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityEntitiesIdentityEntity.md new file mode 100644 index 000000000..ae319f1a2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityEntitiesIdentityEntity.md @@ -0,0 +1,116 @@ +--- +id: v2024-identity-entities-identity-entity +title: IdentityEntitiesIdentityEntity +pagination_label: IdentityEntitiesIdentityEntity +sidebar_label: IdentityEntitiesIdentityEntity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityEntitiesIdentityEntity', 'V2024IdentityEntitiesIdentityEntity'] +slug: /tools/sdk/go/v2024/models/identity-entities-identity-entity +tags: ['SDK', 'Software Development Kit', 'IdentityEntitiesIdentityEntity', 'V2024IdentityEntitiesIdentityEntity'] +--- + +# IdentityEntitiesIdentityEntity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | id of the resource to which the identity is associated | [optional] +**Name** | Pointer to **string** | name of the resource to which the identity is associated | [optional] +**Type** | Pointer to **string** | type of the resource to which the identity is associated | [optional] + +## Methods + +### NewIdentityEntitiesIdentityEntity + +`func NewIdentityEntitiesIdentityEntity() *IdentityEntitiesIdentityEntity` + +NewIdentityEntitiesIdentityEntity instantiates a new IdentityEntitiesIdentityEntity 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 + +### NewIdentityEntitiesIdentityEntityWithDefaults + +`func NewIdentityEntitiesIdentityEntityWithDefaults() *IdentityEntitiesIdentityEntity` + +NewIdentityEntitiesIdentityEntityWithDefaults instantiates a new IdentityEntitiesIdentityEntity 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 + +### GetId + +`func (o *IdentityEntitiesIdentityEntity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityEntitiesIdentityEntity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityEntitiesIdentityEntity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityEntitiesIdentityEntity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityEntitiesIdentityEntity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityEntitiesIdentityEntity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityEntitiesIdentityEntity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityEntitiesIdentityEntity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *IdentityEntitiesIdentityEntity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityEntitiesIdentityEntity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityEntitiesIdentityEntity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityEntitiesIdentityEntity) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityExceptionReportReference.md new file mode 100644 index 000000000..90ac73b92 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityExceptionReportReference.md @@ -0,0 +1,90 @@ +--- +id: v2024-identity-exception-report-reference +title: IdentityExceptionReportReference +pagination_label: IdentityExceptionReportReference +sidebar_label: IdentityExceptionReportReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityExceptionReportReference', 'V2024IdentityExceptionReportReference'] +slug: /tools/sdk/go/v2024/models/identity-exception-report-reference +tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'V2024IdentityExceptionReportReference'] +--- + +# IdentityExceptionReportReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TaskResultId** | Pointer to **string** | Task result ID. | [optional] +**ReportName** | Pointer to **string** | Report name. | [optional] + +## Methods + +### NewIdentityExceptionReportReference + +`func NewIdentityExceptionReportReference() *IdentityExceptionReportReference` + +NewIdentityExceptionReportReference instantiates a new IdentityExceptionReportReference 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 + +### NewIdentityExceptionReportReferenceWithDefaults + +`func NewIdentityExceptionReportReferenceWithDefaults() *IdentityExceptionReportReference` + +NewIdentityExceptionReportReferenceWithDefaults instantiates a new IdentityExceptionReportReference 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 + +### GetTaskResultId + +`func (o *IdentityExceptionReportReference) GetTaskResultId() string` + +GetTaskResultId returns the TaskResultId field if non-nil, zero value otherwise. + +### GetTaskResultIdOk + +`func (o *IdentityExceptionReportReference) GetTaskResultIdOk() (*string, bool)` + +GetTaskResultIdOk returns a tuple with the TaskResultId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskResultId + +`func (o *IdentityExceptionReportReference) SetTaskResultId(v string)` + +SetTaskResultId sets TaskResultId field to given value. + +### HasTaskResultId + +`func (o *IdentityExceptionReportReference) HasTaskResultId() bool` + +HasTaskResultId returns a boolean if a field has been set. + +### GetReportName + +`func (o *IdentityExceptionReportReference) GetReportName() string` + +GetReportName returns the ReportName field if non-nil, zero value otherwise. + +### GetReportNameOk + +`func (o *IdentityExceptionReportReference) GetReportNameOk() (*string, bool)` + +GetReportNameOk returns a tuple with the ReportName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportName + +`func (o *IdentityExceptionReportReference) SetReportName(v string)` + +SetReportName sets ReportName field to given value. + +### HasReportName + +`func (o *IdentityExceptionReportReference) HasReportName() bool` + +HasReportName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityHistoryResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityHistoryResponse.md new file mode 100644 index 000000000..419565e97 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityHistoryResponse.md @@ -0,0 +1,194 @@ +--- +id: v2024-identity-history-response +title: IdentityHistoryResponse +pagination_label: IdentityHistoryResponse +sidebar_label: IdentityHistoryResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityHistoryResponse', 'V2024IdentityHistoryResponse'] +slug: /tools/sdk/go/v2024/models/identity-history-response +tags: ['SDK', 'Software Development Kit', 'IdentityHistoryResponse', 'V2024IdentityHistoryResponse'] +--- + +# IdentityHistoryResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the identity ID | [optional] +**DisplayName** | Pointer to **string** | the display name of the identity | [optional] +**Snapshot** | Pointer to **string** | the date when the identity record was created | [optional] +**DeletedDate** | Pointer to **string** | the date when the identity was deleted | [optional] +**AccessItemCount** | Pointer to **map[string]int32** | A map containing the count of each access item | [optional] +**Attributes** | Pointer to **map[string]interface{}** | A map containing the identity attributes | [optional] + +## Methods + +### NewIdentityHistoryResponse + +`func NewIdentityHistoryResponse() *IdentityHistoryResponse` + +NewIdentityHistoryResponse instantiates a new IdentityHistoryResponse 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 + +### NewIdentityHistoryResponseWithDefaults + +`func NewIdentityHistoryResponseWithDefaults() *IdentityHistoryResponse` + +NewIdentityHistoryResponseWithDefaults instantiates a new IdentityHistoryResponse 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 + +### GetId + +`func (o *IdentityHistoryResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityHistoryResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityHistoryResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityHistoryResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *IdentityHistoryResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityHistoryResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityHistoryResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityHistoryResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSnapshot + +`func (o *IdentityHistoryResponse) GetSnapshot() string` + +GetSnapshot returns the Snapshot field if non-nil, zero value otherwise. + +### GetSnapshotOk + +`func (o *IdentityHistoryResponse) GetSnapshotOk() (*string, bool)` + +GetSnapshotOk returns a tuple with the Snapshot field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshot + +`func (o *IdentityHistoryResponse) SetSnapshot(v string)` + +SetSnapshot sets Snapshot field to given value. + +### HasSnapshot + +`func (o *IdentityHistoryResponse) HasSnapshot() bool` + +HasSnapshot returns a boolean if a field has been set. + +### GetDeletedDate + +`func (o *IdentityHistoryResponse) GetDeletedDate() string` + +GetDeletedDate returns the DeletedDate field if non-nil, zero value otherwise. + +### GetDeletedDateOk + +`func (o *IdentityHistoryResponse) GetDeletedDateOk() (*string, bool)` + +GetDeletedDateOk returns a tuple with the DeletedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeletedDate + +`func (o *IdentityHistoryResponse) SetDeletedDate(v string)` + +SetDeletedDate sets DeletedDate field to given value. + +### HasDeletedDate + +`func (o *IdentityHistoryResponse) HasDeletedDate() bool` + +HasDeletedDate returns a boolean if a field has been set. + +### GetAccessItemCount + +`func (o *IdentityHistoryResponse) GetAccessItemCount() map[string]int32` + +GetAccessItemCount returns the AccessItemCount field if non-nil, zero value otherwise. + +### GetAccessItemCountOk + +`func (o *IdentityHistoryResponse) GetAccessItemCountOk() (*map[string]int32, bool)` + +GetAccessItemCountOk returns a tuple with the AccessItemCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItemCount + +`func (o *IdentityHistoryResponse) SetAccessItemCount(v map[string]int32)` + +SetAccessItemCount sets AccessItemCount field to given value. + +### HasAccessItemCount + +`func (o *IdentityHistoryResponse) HasAccessItemCount() bool` + +HasAccessItemCount returns a boolean if a field has been set. + +### GetAttributes + +`func (o *IdentityHistoryResponse) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *IdentityHistoryResponse) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *IdentityHistoryResponse) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *IdentityHistoryResponse) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityLifecycleState.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityLifecycleState.md new file mode 100644 index 000000000..11ecd5aca --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityLifecycleState.md @@ -0,0 +1,80 @@ +--- +id: v2024-identity-lifecycle-state +title: IdentityLifecycleState +pagination_label: IdentityLifecycleState +sidebar_label: IdentityLifecycleState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityLifecycleState', 'V2024IdentityLifecycleState'] +slug: /tools/sdk/go/v2024/models/identity-lifecycle-state +tags: ['SDK', 'Software Development Kit', 'IdentityLifecycleState', 'V2024IdentityLifecycleState'] +--- + +# IdentityLifecycleState + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**StateName** | **string** | The name of the lifecycle state | +**ManuallyUpdated** | **bool** | Whether the lifecycle state has been manually or automatically set | + +## Methods + +### NewIdentityLifecycleState + +`func NewIdentityLifecycleState(stateName string, manuallyUpdated bool, ) *IdentityLifecycleState` + +NewIdentityLifecycleState instantiates a new IdentityLifecycleState 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 + +### NewIdentityLifecycleStateWithDefaults + +`func NewIdentityLifecycleStateWithDefaults() *IdentityLifecycleState` + +NewIdentityLifecycleStateWithDefaults instantiates a new IdentityLifecycleState 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 + +### GetStateName + +`func (o *IdentityLifecycleState) GetStateName() string` + +GetStateName returns the StateName field if non-nil, zero value otherwise. + +### GetStateNameOk + +`func (o *IdentityLifecycleState) GetStateNameOk() (*string, bool)` + +GetStateNameOk returns a tuple with the StateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStateName + +`func (o *IdentityLifecycleState) SetStateName(v string)` + +SetStateName sets StateName field to given value. + + +### GetManuallyUpdated + +`func (o *IdentityLifecycleState) GetManuallyUpdated() bool` + +GetManuallyUpdated returns the ManuallyUpdated field if non-nil, zero value otherwise. + +### GetManuallyUpdatedOk + +`func (o *IdentityLifecycleState) GetManuallyUpdatedOk() (*bool, bool)` + +GetManuallyUpdatedOk returns a tuple with the ManuallyUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyUpdated + +`func (o *IdentityLifecycleState) SetManuallyUpdated(v bool)` + +SetManuallyUpdated sets ManuallyUpdated field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityListItem.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityListItem.md new file mode 100644 index 000000000..71c4c3485 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityListItem.md @@ -0,0 +1,224 @@ +--- +id: v2024-identity-list-item +title: IdentityListItem +pagination_label: IdentityListItem +sidebar_label: IdentityListItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityListItem', 'V2024IdentityListItem'] +slug: /tools/sdk/go/v2024/models/identity-list-item +tags: ['SDK', 'Software Development Kit', 'IdentityListItem', 'V2024IdentityListItem'] +--- + +# IdentityListItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the identity ID | [optional] +**DisplayName** | Pointer to **string** | the display name of the identity | [optional] +**FirstName** | Pointer to **NullableString** | the first name of the identity | [optional] +**LastName** | Pointer to **NullableString** | the last name of the identity | [optional] +**Active** | Pointer to **bool** | indicates if an identity is active or not | [optional] [default to true] +**DeletedDate** | Pointer to **NullableString** | the date when the identity was deleted | [optional] + +## Methods + +### NewIdentityListItem + +`func NewIdentityListItem() *IdentityListItem` + +NewIdentityListItem instantiates a new IdentityListItem 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 + +### NewIdentityListItemWithDefaults + +`func NewIdentityListItemWithDefaults() *IdentityListItem` + +NewIdentityListItemWithDefaults instantiates a new IdentityListItem 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 + +### GetId + +`func (o *IdentityListItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityListItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityListItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityListItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *IdentityListItem) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityListItem) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityListItem) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityListItem) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *IdentityListItem) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *IdentityListItem) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *IdentityListItem) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *IdentityListItem) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### SetFirstNameNil + +`func (o *IdentityListItem) SetFirstNameNil(b bool)` + + SetFirstNameNil sets the value for FirstName to be an explicit nil + +### UnsetFirstName +`func (o *IdentityListItem) UnsetFirstName()` + +UnsetFirstName ensures that no value is present for FirstName, not even an explicit nil +### GetLastName + +`func (o *IdentityListItem) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *IdentityListItem) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *IdentityListItem) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *IdentityListItem) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### SetLastNameNil + +`func (o *IdentityListItem) SetLastNameNil(b bool)` + + SetLastNameNil sets the value for LastName to be an explicit nil + +### UnsetLastName +`func (o *IdentityListItem) UnsetLastName()` + +UnsetLastName ensures that no value is present for LastName, not even an explicit nil +### GetActive + +`func (o *IdentityListItem) GetActive() bool` + +GetActive returns the Active field if non-nil, zero value otherwise. + +### GetActiveOk + +`func (o *IdentityListItem) GetActiveOk() (*bool, bool)` + +GetActiveOk returns a tuple with the Active field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActive + +`func (o *IdentityListItem) SetActive(v bool)` + +SetActive sets Active field to given value. + +### HasActive + +`func (o *IdentityListItem) HasActive() bool` + +HasActive returns a boolean if a field has been set. + +### GetDeletedDate + +`func (o *IdentityListItem) GetDeletedDate() string` + +GetDeletedDate returns the DeletedDate field if non-nil, zero value otherwise. + +### GetDeletedDateOk + +`func (o *IdentityListItem) GetDeletedDateOk() (*string, bool)` + +GetDeletedDateOk returns a tuple with the DeletedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeletedDate + +`func (o *IdentityListItem) SetDeletedDate(v string)` + +SetDeletedDate sets DeletedDate field to given value. + +### HasDeletedDate + +`func (o *IdentityListItem) HasDeletedDate() bool` + +HasDeletedDate returns a boolean if a field has been set. + +### SetDeletedDateNil + +`func (o *IdentityListItem) SetDeletedDateNil(b bool)` + + SetDeletedDateNil sets the value for DeletedDate to be an explicit nil + +### UnsetDeletedDate +`func (o *IdentityListItem) UnsetDeletedDate()` + +UnsetDeletedDate ensures that no value is present for DeletedDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityManagerRef.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityManagerRef.md new file mode 100644 index 000000000..5533c3b72 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityManagerRef.md @@ -0,0 +1,116 @@ +--- +id: v2024-identity-manager-ref +title: IdentityManagerRef +pagination_label: IdentityManagerRef +sidebar_label: IdentityManagerRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityManagerRef', 'V2024IdentityManagerRef'] +slug: /tools/sdk/go/v2024/models/identity-manager-ref +tags: ['SDK', 'Software Development Kit', 'IdentityManagerRef', 'V2024IdentityManagerRef'] +--- + +# IdentityManagerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity's manager | [optional] +**Id** | Pointer to **string** | ID of identity's manager | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity's manager | [optional] + +## Methods + +### NewIdentityManagerRef + +`func NewIdentityManagerRef() *IdentityManagerRef` + +NewIdentityManagerRef instantiates a new IdentityManagerRef 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 + +### NewIdentityManagerRefWithDefaults + +`func NewIdentityManagerRefWithDefaults() *IdentityManagerRef` + +NewIdentityManagerRefWithDefaults instantiates a new IdentityManagerRef 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 + +### GetType + +`func (o *IdentityManagerRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityManagerRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityManagerRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityManagerRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityManagerRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityManagerRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityManagerRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityManagerRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityManagerRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityManagerRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityManagerRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityManagerRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityOwnershipAssociationDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityOwnershipAssociationDetails.md new file mode 100644 index 000000000..7495516b5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityOwnershipAssociationDetails.md @@ -0,0 +1,64 @@ +--- +id: v2024-identity-ownership-association-details +title: IdentityOwnershipAssociationDetails +pagination_label: IdentityOwnershipAssociationDetails +sidebar_label: IdentityOwnershipAssociationDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityOwnershipAssociationDetails', 'V2024IdentityOwnershipAssociationDetails'] +slug: /tools/sdk/go/v2024/models/identity-ownership-association-details +tags: ['SDK', 'Software Development Kit', 'IdentityOwnershipAssociationDetails', 'V2024IdentityOwnershipAssociationDetails'] +--- + +# IdentityOwnershipAssociationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssociationDetails** | Pointer to [**[]IdentityOwnershipAssociationDetailsAssociationDetailsInner**](identity-ownership-association-details-association-details-inner) | list of all the resource associations for the identity | [optional] + +## Methods + +### NewIdentityOwnershipAssociationDetails + +`func NewIdentityOwnershipAssociationDetails() *IdentityOwnershipAssociationDetails` + +NewIdentityOwnershipAssociationDetails instantiates a new IdentityOwnershipAssociationDetails 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 + +### NewIdentityOwnershipAssociationDetailsWithDefaults + +`func NewIdentityOwnershipAssociationDetailsWithDefaults() *IdentityOwnershipAssociationDetails` + +NewIdentityOwnershipAssociationDetailsWithDefaults instantiates a new IdentityOwnershipAssociationDetails 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 + +### GetAssociationDetails + +`func (o *IdentityOwnershipAssociationDetails) GetAssociationDetails() []IdentityOwnershipAssociationDetailsAssociationDetailsInner` + +GetAssociationDetails returns the AssociationDetails field if non-nil, zero value otherwise. + +### GetAssociationDetailsOk + +`func (o *IdentityOwnershipAssociationDetails) GetAssociationDetailsOk() (*[]IdentityOwnershipAssociationDetailsAssociationDetailsInner, bool)` + +GetAssociationDetailsOk returns a tuple with the AssociationDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociationDetails + +`func (o *IdentityOwnershipAssociationDetails) SetAssociationDetails(v []IdentityOwnershipAssociationDetailsAssociationDetailsInner)` + +SetAssociationDetails sets AssociationDetails field to given value. + +### HasAssociationDetails + +`func (o *IdentityOwnershipAssociationDetails) HasAssociationDetails() bool` + +HasAssociationDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md new file mode 100644 index 000000000..a376a87cc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md @@ -0,0 +1,90 @@ +--- +id: v2024-identity-ownership-association-details-association-details-inner +title: IdentityOwnershipAssociationDetailsAssociationDetailsInner +pagination_label: IdentityOwnershipAssociationDetailsAssociationDetailsInner +sidebar_label: IdentityOwnershipAssociationDetailsAssociationDetailsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityOwnershipAssociationDetailsAssociationDetailsInner', 'V2024IdentityOwnershipAssociationDetailsAssociationDetailsInner'] +slug: /tools/sdk/go/v2024/models/identity-ownership-association-details-association-details-inner +tags: ['SDK', 'Software Development Kit', 'IdentityOwnershipAssociationDetailsAssociationDetailsInner', 'V2024IdentityOwnershipAssociationDetailsAssociationDetailsInner'] +--- + +# IdentityOwnershipAssociationDetailsAssociationDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssociationType** | Pointer to **string** | association type with the identity | [optional] +**Entities** | Pointer to [**[]IdentityEntities**](identity-entities) | the specific resource this identity has ownership on | [optional] + +## Methods + +### NewIdentityOwnershipAssociationDetailsAssociationDetailsInner + +`func NewIdentityOwnershipAssociationDetailsAssociationDetailsInner() *IdentityOwnershipAssociationDetailsAssociationDetailsInner` + +NewIdentityOwnershipAssociationDetailsAssociationDetailsInner instantiates a new IdentityOwnershipAssociationDetailsAssociationDetailsInner 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 + +### NewIdentityOwnershipAssociationDetailsAssociationDetailsInnerWithDefaults + +`func NewIdentityOwnershipAssociationDetailsAssociationDetailsInnerWithDefaults() *IdentityOwnershipAssociationDetailsAssociationDetailsInner` + +NewIdentityOwnershipAssociationDetailsAssociationDetailsInnerWithDefaults instantiates a new IdentityOwnershipAssociationDetailsAssociationDetailsInner 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 + +### GetAssociationType + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) GetAssociationType() string` + +GetAssociationType returns the AssociationType field if non-nil, zero value otherwise. + +### GetAssociationTypeOk + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) GetAssociationTypeOk() (*string, bool)` + +GetAssociationTypeOk returns a tuple with the AssociationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociationType + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) SetAssociationType(v string)` + +SetAssociationType sets AssociationType field to given value. + +### HasAssociationType + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) HasAssociationType() bool` + +HasAssociationType returns a boolean if a field has been set. + +### GetEntities + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) GetEntities() []IdentityEntities` + +GetEntities returns the Entities field if non-nil, zero value otherwise. + +### GetEntitiesOk + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) GetEntitiesOk() (*[]IdentityEntities, bool)` + +GetEntitiesOk returns a tuple with the Entities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntities + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) SetEntities(v []IdentityEntities)` + +SetEntities sets Entities field to given value. + +### HasEntities + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) HasEntities() bool` + +HasEntities returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityPreviewRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityPreviewRequest.md new file mode 100644 index 000000000..02fc66d65 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityPreviewRequest.md @@ -0,0 +1,90 @@ +--- +id: v2024-identity-preview-request +title: IdentityPreviewRequest +pagination_label: IdentityPreviewRequest +sidebar_label: IdentityPreviewRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityPreviewRequest', 'V2024IdentityPreviewRequest'] +slug: /tools/sdk/go/v2024/models/identity-preview-request +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewRequest', 'V2024IdentityPreviewRequest'] +--- + +# IdentityPreviewRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | The Identity id | [optional] +**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] + +## Methods + +### NewIdentityPreviewRequest + +`func NewIdentityPreviewRequest() *IdentityPreviewRequest` + +NewIdentityPreviewRequest instantiates a new IdentityPreviewRequest 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 + +### NewIdentityPreviewRequestWithDefaults + +`func NewIdentityPreviewRequestWithDefaults() *IdentityPreviewRequest` + +NewIdentityPreviewRequestWithDefaults instantiates a new IdentityPreviewRequest 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 + +### GetIdentityId + +`func (o *IdentityPreviewRequest) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *IdentityPreviewRequest) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *IdentityPreviewRequest) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *IdentityPreviewRequest) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetIdentityAttributeConfig + +`func (o *IdentityPreviewRequest) GetIdentityAttributeConfig() IdentityAttributeConfig` + +GetIdentityAttributeConfig returns the IdentityAttributeConfig field if non-nil, zero value otherwise. + +### GetIdentityAttributeConfigOk + +`func (o *IdentityPreviewRequest) GetIdentityAttributeConfigOk() (*IdentityAttributeConfig, bool)` + +GetIdentityAttributeConfigOk returns a tuple with the IdentityAttributeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeConfig + +`func (o *IdentityPreviewRequest) SetIdentityAttributeConfig(v IdentityAttributeConfig)` + +SetIdentityAttributeConfig sets IdentityAttributeConfig field to given value. + +### HasIdentityAttributeConfig + +`func (o *IdentityPreviewRequest) HasIdentityAttributeConfig() bool` + +HasIdentityAttributeConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityPreviewResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityPreviewResponse.md new file mode 100644 index 000000000..11ae4396a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityPreviewResponse.md @@ -0,0 +1,90 @@ +--- +id: v2024-identity-preview-response +title: IdentityPreviewResponse +pagination_label: IdentityPreviewResponse +sidebar_label: IdentityPreviewResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityPreviewResponse', 'V2024IdentityPreviewResponse'] +slug: /tools/sdk/go/v2024/models/identity-preview-response +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponse', 'V2024IdentityPreviewResponse'] +--- + +# IdentityPreviewResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**IdentityPreviewResponseIdentity**](identity-preview-response-identity) | | [optional] +**PreviewAttributes** | Pointer to [**[]IdentityAttributePreview**](identity-attribute-preview) | | [optional] + +## Methods + +### NewIdentityPreviewResponse + +`func NewIdentityPreviewResponse() *IdentityPreviewResponse` + +NewIdentityPreviewResponse instantiates a new IdentityPreviewResponse 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 + +### NewIdentityPreviewResponseWithDefaults + +`func NewIdentityPreviewResponseWithDefaults() *IdentityPreviewResponse` + +NewIdentityPreviewResponseWithDefaults instantiates a new IdentityPreviewResponse 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 + +### GetIdentity + +`func (o *IdentityPreviewResponse) GetIdentity() IdentityPreviewResponseIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *IdentityPreviewResponse) GetIdentityOk() (*IdentityPreviewResponseIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *IdentityPreviewResponse) SetIdentity(v IdentityPreviewResponseIdentity)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *IdentityPreviewResponse) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetPreviewAttributes + +`func (o *IdentityPreviewResponse) GetPreviewAttributes() []IdentityAttributePreview` + +GetPreviewAttributes returns the PreviewAttributes field if non-nil, zero value otherwise. + +### GetPreviewAttributesOk + +`func (o *IdentityPreviewResponse) GetPreviewAttributesOk() (*[]IdentityAttributePreview, bool)` + +GetPreviewAttributesOk returns a tuple with the PreviewAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviewAttributes + +`func (o *IdentityPreviewResponse) SetPreviewAttributes(v []IdentityAttributePreview)` + +SetPreviewAttributes sets PreviewAttributes field to given value. + +### HasPreviewAttributes + +`func (o *IdentityPreviewResponse) HasPreviewAttributes() bool` + +HasPreviewAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityPreviewResponseIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityPreviewResponseIdentity.md new file mode 100644 index 000000000..80830e615 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityPreviewResponseIdentity.md @@ -0,0 +1,116 @@ +--- +id: v2024-identity-preview-response-identity +title: IdentityPreviewResponseIdentity +pagination_label: IdentityPreviewResponseIdentity +sidebar_label: IdentityPreviewResponseIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityPreviewResponseIdentity', 'V2024IdentityPreviewResponseIdentity'] +slug: /tools/sdk/go/v2024/models/identity-preview-response-identity +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponseIdentity', 'V2024IdentityPreviewResponseIdentity'] +--- + +# IdentityPreviewResponseIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Identity's DTO type. | [optional] +**Id** | Pointer to **string** | Identity ID. | [optional] +**Name** | Pointer to **string** | Identity's display name. | [optional] + +## Methods + +### NewIdentityPreviewResponseIdentity + +`func NewIdentityPreviewResponseIdentity() *IdentityPreviewResponseIdentity` + +NewIdentityPreviewResponseIdentity instantiates a new IdentityPreviewResponseIdentity 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 + +### NewIdentityPreviewResponseIdentityWithDefaults + +`func NewIdentityPreviewResponseIdentityWithDefaults() *IdentityPreviewResponseIdentity` + +NewIdentityPreviewResponseIdentityWithDefaults instantiates a new IdentityPreviewResponseIdentity 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 + +### GetType + +`func (o *IdentityPreviewResponseIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityPreviewResponseIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityPreviewResponseIdentity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityPreviewResponseIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityPreviewResponseIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityPreviewResponseIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityPreviewResponseIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityPreviewResponseIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityPreviewResponseIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityPreviewResponseIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityPreviewResponseIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityPreviewResponseIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfile.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfile.md new file mode 100644 index 000000000..c29dee5f6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfile.md @@ -0,0 +1,406 @@ +--- +id: v2024-identity-profile +title: IdentityProfile +pagination_label: IdentityProfile +sidebar_label: IdentityProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfile', 'V2024IdentityProfile'] +slug: /tools/sdk/go/v2024/models/identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityProfile', 'V2024IdentityProfile'] +--- + +# IdentityProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Description** | Pointer to **NullableString** | Identity profile's description. | [optional] +**Owner** | Pointer to [**NullableIdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] +**Priority** | Pointer to **int64** | Identity profile's priority. | [optional] +**AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | +**IdentityRefreshRequired** | Pointer to **bool** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to false] +**IdentityCount** | Pointer to **int32** | Number of identities belonging to the identity profile. | [optional] +**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] +**IdentityExceptionReportReference** | Pointer to [**NullableIdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] +**HasTimeBasedAttr** | Pointer to **bool** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to false] + +## Methods + +### NewIdentityProfile + +`func NewIdentityProfile(name NullableString, authoritativeSource IdentityProfileAllOfAuthoritativeSource, ) *IdentityProfile` + +NewIdentityProfile instantiates a new IdentityProfile 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 + +### NewIdentityProfileWithDefaults + +`func NewIdentityProfileWithDefaults() *IdentityProfile` + +NewIdentityProfileWithDefaults instantiates a new IdentityProfile 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 + +### GetId + +`func (o *IdentityProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfile) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *IdentityProfile) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *IdentityProfile) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *IdentityProfile) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *IdentityProfile) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *IdentityProfile) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *IdentityProfile) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *IdentityProfile) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *IdentityProfile) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *IdentityProfile) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *IdentityProfile) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *IdentityProfile) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *IdentityProfile) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *IdentityProfile) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *IdentityProfile) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *IdentityProfile) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *IdentityProfile) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwner + +`func (o *IdentityProfile) GetOwner() IdentityProfileAllOfOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *IdentityProfile) GetOwnerOk() (*IdentityProfileAllOfOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *IdentityProfile) SetOwner(v IdentityProfileAllOfOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *IdentityProfile) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *IdentityProfile) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *IdentityProfile) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetPriority + +`func (o *IdentityProfile) GetPriority() int64` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *IdentityProfile) GetPriorityOk() (*int64, 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 *IdentityProfile) SetPriority(v int64)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *IdentityProfile) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetAuthoritativeSource + +`func (o *IdentityProfile) GetAuthoritativeSource() IdentityProfileAllOfAuthoritativeSource` + +GetAuthoritativeSource returns the AuthoritativeSource field if non-nil, zero value otherwise. + +### GetAuthoritativeSourceOk + +`func (o *IdentityProfile) GetAuthoritativeSourceOk() (*IdentityProfileAllOfAuthoritativeSource, bool)` + +GetAuthoritativeSourceOk returns a tuple with the AuthoritativeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritativeSource + +`func (o *IdentityProfile) SetAuthoritativeSource(v IdentityProfileAllOfAuthoritativeSource)` + +SetAuthoritativeSource sets AuthoritativeSource field to given value. + + +### GetIdentityRefreshRequired + +`func (o *IdentityProfile) GetIdentityRefreshRequired() bool` + +GetIdentityRefreshRequired returns the IdentityRefreshRequired field if non-nil, zero value otherwise. + +### GetIdentityRefreshRequiredOk + +`func (o *IdentityProfile) GetIdentityRefreshRequiredOk() (*bool, bool)` + +GetIdentityRefreshRequiredOk returns a tuple with the IdentityRefreshRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityRefreshRequired + +`func (o *IdentityProfile) SetIdentityRefreshRequired(v bool)` + +SetIdentityRefreshRequired sets IdentityRefreshRequired field to given value. + +### HasIdentityRefreshRequired + +`func (o *IdentityProfile) HasIdentityRefreshRequired() bool` + +HasIdentityRefreshRequired returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *IdentityProfile) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *IdentityProfile) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *IdentityProfile) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *IdentityProfile) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetIdentityAttributeConfig + +`func (o *IdentityProfile) GetIdentityAttributeConfig() IdentityAttributeConfig` + +GetIdentityAttributeConfig returns the IdentityAttributeConfig field if non-nil, zero value otherwise. + +### GetIdentityAttributeConfigOk + +`func (o *IdentityProfile) GetIdentityAttributeConfigOk() (*IdentityAttributeConfig, bool)` + +GetIdentityAttributeConfigOk returns a tuple with the IdentityAttributeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeConfig + +`func (o *IdentityProfile) SetIdentityAttributeConfig(v IdentityAttributeConfig)` + +SetIdentityAttributeConfig sets IdentityAttributeConfig field to given value. + +### HasIdentityAttributeConfig + +`func (o *IdentityProfile) HasIdentityAttributeConfig() bool` + +HasIdentityAttributeConfig returns a boolean if a field has been set. + +### GetIdentityExceptionReportReference + +`func (o *IdentityProfile) GetIdentityExceptionReportReference() IdentityExceptionReportReference` + +GetIdentityExceptionReportReference returns the IdentityExceptionReportReference field if non-nil, zero value otherwise. + +### GetIdentityExceptionReportReferenceOk + +`func (o *IdentityProfile) GetIdentityExceptionReportReferenceOk() (*IdentityExceptionReportReference, bool)` + +GetIdentityExceptionReportReferenceOk returns a tuple with the IdentityExceptionReportReference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityExceptionReportReference + +`func (o *IdentityProfile) SetIdentityExceptionReportReference(v IdentityExceptionReportReference)` + +SetIdentityExceptionReportReference sets IdentityExceptionReportReference field to given value. + +### HasIdentityExceptionReportReference + +`func (o *IdentityProfile) HasIdentityExceptionReportReference() bool` + +HasIdentityExceptionReportReference returns a boolean if a field has been set. + +### SetIdentityExceptionReportReferenceNil + +`func (o *IdentityProfile) SetIdentityExceptionReportReferenceNil(b bool)` + + SetIdentityExceptionReportReferenceNil sets the value for IdentityExceptionReportReference to be an explicit nil + +### UnsetIdentityExceptionReportReference +`func (o *IdentityProfile) UnsetIdentityExceptionReportReference()` + +UnsetIdentityExceptionReportReference ensures that no value is present for IdentityExceptionReportReference, not even an explicit nil +### GetHasTimeBasedAttr + +`func (o *IdentityProfile) GetHasTimeBasedAttr() bool` + +GetHasTimeBasedAttr returns the HasTimeBasedAttr field if non-nil, zero value otherwise. + +### GetHasTimeBasedAttrOk + +`func (o *IdentityProfile) GetHasTimeBasedAttrOk() (*bool, bool)` + +GetHasTimeBasedAttrOk returns a tuple with the HasTimeBasedAttr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasTimeBasedAttr + +`func (o *IdentityProfile) SetHasTimeBasedAttr(v bool)` + +SetHasTimeBasedAttr sets HasTimeBasedAttr field to given value. + +### HasHasTimeBasedAttr + +`func (o *IdentityProfile) HasHasTimeBasedAttr() bool` + +HasHasTimeBasedAttr returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md new file mode 100644 index 000000000..afd9c0094 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -0,0 +1,116 @@ +--- +id: v2024-identity-profile-all-of-authoritative-source +title: IdentityProfileAllOfAuthoritativeSource +pagination_label: IdentityProfileAllOfAuthoritativeSource +sidebar_label: IdentityProfileAllOfAuthoritativeSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileAllOfAuthoritativeSource', 'V2024IdentityProfileAllOfAuthoritativeSource'] +slug: /tools/sdk/go/v2024/models/identity-profile-all-of-authoritative-source +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSource', 'V2024IdentityProfileAllOfAuthoritativeSource'] +--- + +# IdentityProfileAllOfAuthoritativeSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Authoritative source's object type. | [optional] +**Id** | Pointer to **string** | Authoritative source's ID. | [optional] +**Name** | Pointer to **string** | Authoritative source's name. | [optional] + +## Methods + +### NewIdentityProfileAllOfAuthoritativeSource + +`func NewIdentityProfileAllOfAuthoritativeSource() *IdentityProfileAllOfAuthoritativeSource` + +NewIdentityProfileAllOfAuthoritativeSource instantiates a new IdentityProfileAllOfAuthoritativeSource 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 + +### NewIdentityProfileAllOfAuthoritativeSourceWithDefaults + +`func NewIdentityProfileAllOfAuthoritativeSourceWithDefaults() *IdentityProfileAllOfAuthoritativeSource` + +NewIdentityProfileAllOfAuthoritativeSourceWithDefaults instantiates a new IdentityProfileAllOfAuthoritativeSource 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 + +### GetType + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityProfileAllOfAuthoritativeSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityProfileAllOfAuthoritativeSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfileAllOfAuthoritativeSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfileAllOfAuthoritativeSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfileAllOfAuthoritativeSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityProfileAllOfAuthoritativeSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfileAllOfOwner.md new file mode 100644 index 000000000..2f41de48c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfileAllOfOwner.md @@ -0,0 +1,116 @@ +--- +id: v2024-identity-profile-all-of-owner +title: IdentityProfileAllOfOwner +pagination_label: IdentityProfileAllOfOwner +sidebar_label: IdentityProfileAllOfOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileAllOfOwner', 'V2024IdentityProfileAllOfOwner'] +slug: /tools/sdk/go/v2024/models/identity-profile-all-of-owner +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'V2024IdentityProfileAllOfOwner'] +--- + +# IdentityProfileAllOfOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's object type. | [optional] +**Id** | Pointer to **string** | Owner's ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] + +## Methods + +### NewIdentityProfileAllOfOwner + +`func NewIdentityProfileAllOfOwner() *IdentityProfileAllOfOwner` + +NewIdentityProfileAllOfOwner instantiates a new IdentityProfileAllOfOwner 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 + +### NewIdentityProfileAllOfOwnerWithDefaults + +`func NewIdentityProfileAllOfOwnerWithDefaults() *IdentityProfileAllOfOwner` + +NewIdentityProfileAllOfOwnerWithDefaults instantiates a new IdentityProfileAllOfOwner 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 + +### GetType + +`func (o *IdentityProfileAllOfOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityProfileAllOfOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityProfileAllOfOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityProfileAllOfOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityProfileAllOfOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfileAllOfOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfileAllOfOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfileAllOfOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfileAllOfOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfileAllOfOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfileAllOfOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityProfileAllOfOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfileExportedObject.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfileExportedObject.md new file mode 100644 index 000000000..288971696 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfileExportedObject.md @@ -0,0 +1,116 @@ +--- +id: v2024-identity-profile-exported-object +title: IdentityProfileExportedObject +pagination_label: IdentityProfileExportedObject +sidebar_label: IdentityProfileExportedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileExportedObject', 'V2024IdentityProfileExportedObject'] +slug: /tools/sdk/go/v2024/models/identity-profile-exported-object +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObject', 'V2024IdentityProfileExportedObject'] +--- + +# IdentityProfileExportedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **int32** | Version or object from the target service. | [optional] +**Self** | Pointer to [**IdentityProfileExportedObjectSelf**](identity-profile-exported-object-self) | | [optional] +**Object** | Pointer to [**IdentityProfile**](identity-profile) | | [optional] + +## Methods + +### NewIdentityProfileExportedObject + +`func NewIdentityProfileExportedObject() *IdentityProfileExportedObject` + +NewIdentityProfileExportedObject instantiates a new IdentityProfileExportedObject 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 + +### NewIdentityProfileExportedObjectWithDefaults + +`func NewIdentityProfileExportedObjectWithDefaults() *IdentityProfileExportedObject` + +NewIdentityProfileExportedObjectWithDefaults instantiates a new IdentityProfileExportedObject 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 + +### GetVersion + +`func (o *IdentityProfileExportedObject) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *IdentityProfileExportedObject) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *IdentityProfileExportedObject) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *IdentityProfileExportedObject) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### GetSelf + +`func (o *IdentityProfileExportedObject) GetSelf() IdentityProfileExportedObjectSelf` + +GetSelf returns the Self field if non-nil, zero value otherwise. + +### GetSelfOk + +`func (o *IdentityProfileExportedObject) GetSelfOk() (*IdentityProfileExportedObjectSelf, bool)` + +GetSelfOk returns a tuple with the Self field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelf + +`func (o *IdentityProfileExportedObject) SetSelf(v IdentityProfileExportedObjectSelf)` + +SetSelf sets Self field to given value. + +### HasSelf + +`func (o *IdentityProfileExportedObject) HasSelf() bool` + +HasSelf returns a boolean if a field has been set. + +### GetObject + +`func (o *IdentityProfileExportedObject) GetObject() IdentityProfile` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *IdentityProfileExportedObject) GetObjectOk() (*IdentityProfile, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *IdentityProfileExportedObject) SetObject(v IdentityProfile)` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *IdentityProfileExportedObject) HasObject() bool` + +HasObject returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfileExportedObjectSelf.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfileExportedObjectSelf.md new file mode 100644 index 000000000..6e1e8bcb2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfileExportedObjectSelf.md @@ -0,0 +1,116 @@ +--- +id: v2024-identity-profile-exported-object-self +title: IdentityProfileExportedObjectSelf +pagination_label: IdentityProfileExportedObjectSelf +sidebar_label: IdentityProfileExportedObjectSelf +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileExportedObjectSelf', 'V2024IdentityProfileExportedObjectSelf'] +slug: /tools/sdk/go/v2024/models/identity-profile-exported-object-self +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObjectSelf', 'V2024IdentityProfileExportedObjectSelf'] +--- + +# IdentityProfileExportedObjectSelf + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Exported object's DTO type. | [optional] +**Id** | Pointer to **string** | Exported object's ID. | [optional] +**Name** | Pointer to **string** | Exported object's display name. | [optional] + +## Methods + +### NewIdentityProfileExportedObjectSelf + +`func NewIdentityProfileExportedObjectSelf() *IdentityProfileExportedObjectSelf` + +NewIdentityProfileExportedObjectSelf instantiates a new IdentityProfileExportedObjectSelf 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 + +### NewIdentityProfileExportedObjectSelfWithDefaults + +`func NewIdentityProfileExportedObjectSelfWithDefaults() *IdentityProfileExportedObjectSelf` + +NewIdentityProfileExportedObjectSelfWithDefaults instantiates a new IdentityProfileExportedObjectSelf 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 + +### GetType + +`func (o *IdentityProfileExportedObjectSelf) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityProfileExportedObjectSelf) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityProfileExportedObjectSelf) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityProfileExportedObjectSelf) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityProfileExportedObjectSelf) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfileExportedObjectSelf) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfileExportedObjectSelf) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfileExportedObjectSelf) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfileExportedObjectSelf) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfileExportedObjectSelf) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfileExportedObjectSelf) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityProfileExportedObjectSelf) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfileIdentityErrorReportArguments.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfileIdentityErrorReportArguments.md new file mode 100644 index 000000000..e05e8256b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfileIdentityErrorReportArguments.md @@ -0,0 +1,59 @@ +--- +id: v2024-identity-profile-identity-error-report-arguments +title: IdentityProfileIdentityErrorReportArguments +pagination_label: IdentityProfileIdentityErrorReportArguments +sidebar_label: IdentityProfileIdentityErrorReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileIdentityErrorReportArguments', 'V2024IdentityProfileIdentityErrorReportArguments'] +slug: /tools/sdk/go/v2024/models/identity-profile-identity-error-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentityProfileIdentityErrorReportArguments', 'V2024IdentityProfileIdentityErrorReportArguments'] +--- + +# IdentityProfileIdentityErrorReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuthoritativeSource** | **string** | Source ID. | + +## Methods + +### NewIdentityProfileIdentityErrorReportArguments + +`func NewIdentityProfileIdentityErrorReportArguments(authoritativeSource string, ) *IdentityProfileIdentityErrorReportArguments` + +NewIdentityProfileIdentityErrorReportArguments instantiates a new IdentityProfileIdentityErrorReportArguments 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 + +### NewIdentityProfileIdentityErrorReportArgumentsWithDefaults + +`func NewIdentityProfileIdentityErrorReportArgumentsWithDefaults() *IdentityProfileIdentityErrorReportArguments` + +NewIdentityProfileIdentityErrorReportArgumentsWithDefaults instantiates a new IdentityProfileIdentityErrorReportArguments 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 + +### GetAuthoritativeSource + +`func (o *IdentityProfileIdentityErrorReportArguments) GetAuthoritativeSource() string` + +GetAuthoritativeSource returns the AuthoritativeSource field if non-nil, zero value otherwise. + +### GetAuthoritativeSourceOk + +`func (o *IdentityProfileIdentityErrorReportArguments) GetAuthoritativeSourceOk() (*string, bool)` + +GetAuthoritativeSourceOk returns a tuple with the AuthoritativeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritativeSource + +`func (o *IdentityProfileIdentityErrorReportArguments) SetAuthoritativeSource(v string)` + +SetAuthoritativeSource sets AuthoritativeSource field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfilesConnections.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfilesConnections.md new file mode 100644 index 000000000..f1118d4d2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityProfilesConnections.md @@ -0,0 +1,116 @@ +--- +id: v2024-identity-profiles-connections +title: IdentityProfilesConnections +pagination_label: IdentityProfilesConnections +sidebar_label: IdentityProfilesConnections +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfilesConnections', 'V2024IdentityProfilesConnections'] +slug: /tools/sdk/go/v2024/models/identity-profiles-connections +tags: ['SDK', 'Software Development Kit', 'IdentityProfilesConnections', 'V2024IdentityProfilesConnections'] +--- + +# IdentityProfilesConnections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the IdentityProfile this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the IdentityProfile to which this reference applies | [optional] +**IdentityCount** | Pointer to **int64** | The Number of Identities managed by this IdentityProfile | [optional] + +## Methods + +### NewIdentityProfilesConnections + +`func NewIdentityProfilesConnections() *IdentityProfilesConnections` + +NewIdentityProfilesConnections instantiates a new IdentityProfilesConnections 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 + +### NewIdentityProfilesConnectionsWithDefaults + +`func NewIdentityProfilesConnectionsWithDefaults() *IdentityProfilesConnections` + +NewIdentityProfilesConnectionsWithDefaults instantiates a new IdentityProfilesConnections 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 + +### GetId + +`func (o *IdentityProfilesConnections) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfilesConnections) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfilesConnections) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfilesConnections) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfilesConnections) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfilesConnections) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfilesConnections) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityProfilesConnections) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *IdentityProfilesConnections) GetIdentityCount() int64` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *IdentityProfilesConnections) GetIdentityCountOk() (*int64, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *IdentityProfilesConnections) SetIdentityCount(v int64)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *IdentityProfilesConnections) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityReference.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityReference.md new file mode 100644 index 000000000..7af651eb0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityReference.md @@ -0,0 +1,116 @@ +--- +id: v2024-identity-reference +title: IdentityReference +pagination_label: IdentityReference +sidebar_label: IdentityReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityReference', 'V2024IdentityReference'] +slug: /tools/sdk/go/v2024/models/identity-reference +tags: ['SDK', 'Software Development Kit', 'IdentityReference', 'V2024IdentityReference'] +--- + +# IdentityReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | Identity id | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity. | [optional] + +## Methods + +### NewIdentityReference + +`func NewIdentityReference() *IdentityReference` + +NewIdentityReference instantiates a new IdentityReference 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 + +### NewIdentityReferenceWithDefaults + +`func NewIdentityReferenceWithDefaults() *IdentityReference` + +NewIdentityReferenceWithDefaults instantiates a new IdentityReference 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 + +### GetType + +`func (o *IdentityReference) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityReference) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityReference) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityReference) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityReferenceWithNameAndEmail.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityReferenceWithNameAndEmail.md new file mode 100644 index 000000000..13ab891ac --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityReferenceWithNameAndEmail.md @@ -0,0 +1,152 @@ +--- +id: v2024-identity-reference-with-name-and-email +title: IdentityReferenceWithNameAndEmail +pagination_label: IdentityReferenceWithNameAndEmail +sidebar_label: IdentityReferenceWithNameAndEmail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityReferenceWithNameAndEmail', 'V2024IdentityReferenceWithNameAndEmail'] +slug: /tools/sdk/go/v2024/models/identity-reference-with-name-and-email +tags: ['SDK', 'Software Development Kit', 'IdentityReferenceWithNameAndEmail', 'V2024IdentityReferenceWithNameAndEmail'] +--- + +# IdentityReferenceWithNameAndEmail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type can only be IDENTITY. This is read-only. | [optional] +**Id** | Pointer to **string** | Identity ID. | [optional] +**Name** | Pointer to **string** | Identity's human-readable display name. This is read-only. | [optional] +**Email** | Pointer to **NullableString** | Identity's email address. This is read-only. | [optional] + +## Methods + +### NewIdentityReferenceWithNameAndEmail + +`func NewIdentityReferenceWithNameAndEmail() *IdentityReferenceWithNameAndEmail` + +NewIdentityReferenceWithNameAndEmail instantiates a new IdentityReferenceWithNameAndEmail 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 + +### NewIdentityReferenceWithNameAndEmailWithDefaults + +`func NewIdentityReferenceWithNameAndEmailWithDefaults() *IdentityReferenceWithNameAndEmail` + +NewIdentityReferenceWithNameAndEmailWithDefaults instantiates a new IdentityReferenceWithNameAndEmail 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 + +### GetType + +`func (o *IdentityReferenceWithNameAndEmail) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityReferenceWithNameAndEmail) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityReferenceWithNameAndEmail) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityReferenceWithNameAndEmail) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityReferenceWithNameAndEmail) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityReferenceWithNameAndEmail) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityReferenceWithNameAndEmail) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityReferenceWithNameAndEmail) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityReferenceWithNameAndEmail) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityReferenceWithNameAndEmail) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityReferenceWithNameAndEmail) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityReferenceWithNameAndEmail) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *IdentityReferenceWithNameAndEmail) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *IdentityReferenceWithNameAndEmail) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *IdentityReferenceWithNameAndEmail) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *IdentityReferenceWithNameAndEmail) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### SetEmailNil + +`func (o *IdentityReferenceWithNameAndEmail) SetEmailNil(b bool)` + + SetEmailNil sets the value for Email to be an explicit nil + +### UnsetEmail +`func (o *IdentityReferenceWithNameAndEmail) UnsetEmail()` + +UnsetEmail ensures that no value is present for Email, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentitySnapshotSummaryResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentitySnapshotSummaryResponse.md new file mode 100644 index 000000000..dd9cb3b50 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentitySnapshotSummaryResponse.md @@ -0,0 +1,64 @@ +--- +id: v2024-identity-snapshot-summary-response +title: IdentitySnapshotSummaryResponse +pagination_label: IdentitySnapshotSummaryResponse +sidebar_label: IdentitySnapshotSummaryResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitySnapshotSummaryResponse', 'V2024IdentitySnapshotSummaryResponse'] +slug: /tools/sdk/go/v2024/models/identity-snapshot-summary-response +tags: ['SDK', 'Software Development Kit', 'IdentitySnapshotSummaryResponse', 'V2024IdentitySnapshotSummaryResponse'] +--- + +# IdentitySnapshotSummaryResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Snapshot** | Pointer to **string** | the date when the identity record was created | [optional] + +## Methods + +### NewIdentitySnapshotSummaryResponse + +`func NewIdentitySnapshotSummaryResponse() *IdentitySnapshotSummaryResponse` + +NewIdentitySnapshotSummaryResponse instantiates a new IdentitySnapshotSummaryResponse 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 + +### NewIdentitySnapshotSummaryResponseWithDefaults + +`func NewIdentitySnapshotSummaryResponseWithDefaults() *IdentitySnapshotSummaryResponse` + +NewIdentitySnapshotSummaryResponseWithDefaults instantiates a new IdentitySnapshotSummaryResponse 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 + +### GetSnapshot + +`func (o *IdentitySnapshotSummaryResponse) GetSnapshot() string` + +GetSnapshot returns the Snapshot field if non-nil, zero value otherwise. + +### GetSnapshotOk + +`func (o *IdentitySnapshotSummaryResponse) GetSnapshotOk() (*string, bool)` + +GetSnapshotOk returns a tuple with the Snapshot field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshot + +`func (o *IdentitySnapshotSummaryResponse) SetSnapshot(v string)` + +SetSnapshot sets Snapshot field to given value. + +### HasSnapshot + +`func (o *IdentitySnapshotSummaryResponse) HasSnapshot() bool` + +HasSnapshot returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentitySummary.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentitySummary.md new file mode 100644 index 000000000..f4a20762d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentitySummary.md @@ -0,0 +1,142 @@ +--- +id: v2024-identity-summary +title: IdentitySummary +pagination_label: IdentitySummary +sidebar_label: IdentitySummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitySummary', 'V2024IdentitySummary'] +slug: /tools/sdk/go/v2024/models/identity-summary +tags: ['SDK', 'Software Development Kit', 'IdentitySummary', 'V2024IdentitySummary'] +--- + +# IdentitySummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of this identity summary | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity | [optional] +**IdentityId** | Pointer to **string** | ID of the identity that this summary represents | [optional] +**Completed** | Pointer to **bool** | Indicates if all access items for this summary have been decided on | [optional] [default to false] + +## Methods + +### NewIdentitySummary + +`func NewIdentitySummary() *IdentitySummary` + +NewIdentitySummary instantiates a new IdentitySummary 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 + +### NewIdentitySummaryWithDefaults + +`func NewIdentitySummaryWithDefaults() *IdentitySummary` + +NewIdentitySummaryWithDefaults instantiates a new IdentitySummary 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 + +### GetId + +`func (o *IdentitySummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentitySummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentitySummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentitySummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentitySummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentitySummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentitySummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentitySummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *IdentitySummary) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *IdentitySummary) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *IdentitySummary) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *IdentitySummary) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetCompleted + +`func (o *IdentitySummary) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *IdentitySummary) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *IdentitySummary) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *IdentitySummary) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentitySyncJob.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentitySyncJob.md new file mode 100644 index 000000000..9004df986 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentitySyncJob.md @@ -0,0 +1,101 @@ +--- +id: v2024-identity-sync-job +title: IdentitySyncJob +pagination_label: IdentitySyncJob +sidebar_label: IdentitySyncJob +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitySyncJob', 'V2024IdentitySyncJob'] +slug: /tools/sdk/go/v2024/models/identity-sync-job +tags: ['SDK', 'Software Development Kit', 'IdentitySyncJob', 'V2024IdentitySyncJob'] +--- + +# IdentitySyncJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Job ID. | +**Status** | **string** | The job status. | +**Payload** | [**IdentitySyncPayload**](identity-sync-payload) | | + +## Methods + +### NewIdentitySyncJob + +`func NewIdentitySyncJob(id string, status string, payload IdentitySyncPayload, ) *IdentitySyncJob` + +NewIdentitySyncJob instantiates a new IdentitySyncJob 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 + +### NewIdentitySyncJobWithDefaults + +`func NewIdentitySyncJobWithDefaults() *IdentitySyncJob` + +NewIdentitySyncJobWithDefaults instantiates a new IdentitySyncJob 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 + +### GetId + +`func (o *IdentitySyncJob) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentitySyncJob) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentitySyncJob) SetId(v string)` + +SetId sets Id field to given value. + + +### GetStatus + +`func (o *IdentitySyncJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *IdentitySyncJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *IdentitySyncJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetPayload + +`func (o *IdentitySyncJob) GetPayload() IdentitySyncPayload` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *IdentitySyncJob) GetPayloadOk() (*IdentitySyncPayload, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPayload + +`func (o *IdentitySyncJob) SetPayload(v IdentitySyncPayload)` + +SetPayload sets Payload field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentitySyncPayload.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentitySyncPayload.md new file mode 100644 index 000000000..029193c7d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentitySyncPayload.md @@ -0,0 +1,80 @@ +--- +id: v2024-identity-sync-payload +title: IdentitySyncPayload +pagination_label: IdentitySyncPayload +sidebar_label: IdentitySyncPayload +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitySyncPayload', 'V2024IdentitySyncPayload'] +slug: /tools/sdk/go/v2024/models/identity-sync-payload +tags: ['SDK', 'Software Development Kit', 'IdentitySyncPayload', 'V2024IdentitySyncPayload'] +--- + +# IdentitySyncPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Payload type. | +**DataJson** | **string** | Payload type. | + +## Methods + +### NewIdentitySyncPayload + +`func NewIdentitySyncPayload(type_ string, dataJson string, ) *IdentitySyncPayload` + +NewIdentitySyncPayload instantiates a new IdentitySyncPayload 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 + +### NewIdentitySyncPayloadWithDefaults + +`func NewIdentitySyncPayloadWithDefaults() *IdentitySyncPayload` + +NewIdentitySyncPayloadWithDefaults instantiates a new IdentitySyncPayload 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 + +### GetType + +`func (o *IdentitySyncPayload) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentitySyncPayload) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentitySyncPayload) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDataJson + +`func (o *IdentitySyncPayload) GetDataJson() string` + +GetDataJson returns the DataJson field if non-nil, zero value otherwise. + +### GetDataJsonOk + +`func (o *IdentitySyncPayload) GetDataJsonOk() (*string, bool)` + +GetDataJsonOk returns a tuple with the DataJson field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataJson + +`func (o *IdentitySyncPayload) SetDataJson(v string)` + +SetDataJson sets DataJson field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityWithNewAccess.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityWithNewAccess.md new file mode 100644 index 000000000..b1d8e67b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityWithNewAccess.md @@ -0,0 +1,80 @@ +--- +id: v2024-identity-with-new-access +title: IdentityWithNewAccess +pagination_label: IdentityWithNewAccess +sidebar_label: IdentityWithNewAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityWithNewAccess', 'V2024IdentityWithNewAccess'] +slug: /tools/sdk/go/v2024/models/identity-with-new-access +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess', 'V2024IdentityWithNewAccess'] +--- + +# IdentityWithNewAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **string** | Identity id to be checked. | +**AccessRefs** | [**[]IdentityWithNewAccessAccessRefsInner**](identity-with-new-access-access-refs-inner) | The list of entitlements to consider for possible violations in a preventive check. | + +## Methods + +### NewIdentityWithNewAccess + +`func NewIdentityWithNewAccess(identityId string, accessRefs []IdentityWithNewAccessAccessRefsInner, ) *IdentityWithNewAccess` + +NewIdentityWithNewAccess instantiates a new IdentityWithNewAccess 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 + +### NewIdentityWithNewAccessWithDefaults + +`func NewIdentityWithNewAccessWithDefaults() *IdentityWithNewAccess` + +NewIdentityWithNewAccessWithDefaults instantiates a new IdentityWithNewAccess 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 + +### GetIdentityId + +`func (o *IdentityWithNewAccess) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *IdentityWithNewAccess) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *IdentityWithNewAccess) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetAccessRefs + +`func (o *IdentityWithNewAccess) GetAccessRefs() []IdentityWithNewAccessAccessRefsInner` + +GetAccessRefs returns the AccessRefs field if non-nil, zero value otherwise. + +### GetAccessRefsOk + +`func (o *IdentityWithNewAccess) GetAccessRefsOk() (*[]IdentityWithNewAccessAccessRefsInner, bool)` + +GetAccessRefsOk returns a tuple with the AccessRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRefs + +`func (o *IdentityWithNewAccess) SetAccessRefs(v []IdentityWithNewAccessAccessRefsInner)` + +SetAccessRefs sets AccessRefs field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityWithNewAccess1.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityWithNewAccess1.md new file mode 100644 index 000000000..0f85a3feb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityWithNewAccess1.md @@ -0,0 +1,106 @@ +--- +id: v2024-identity-with-new-access1 +title: IdentityWithNewAccess1 +pagination_label: IdentityWithNewAccess1 +sidebar_label: IdentityWithNewAccess1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityWithNewAccess1', 'V2024IdentityWithNewAccess1'] +slug: /tools/sdk/go/v2024/models/identity-with-new-access1 +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess1', 'V2024IdentityWithNewAccess1'] +--- + +# IdentityWithNewAccess1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **string** | Set of identity IDs to be checked. | +**AccessRefs** | [**[]EntitlementRef1**](entitlement-ref1) | The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. | +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] + +## Methods + +### NewIdentityWithNewAccess1 + +`func NewIdentityWithNewAccess1(identityId string, accessRefs []EntitlementRef1, ) *IdentityWithNewAccess1` + +NewIdentityWithNewAccess1 instantiates a new IdentityWithNewAccess1 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 + +### NewIdentityWithNewAccess1WithDefaults + +`func NewIdentityWithNewAccess1WithDefaults() *IdentityWithNewAccess1` + +NewIdentityWithNewAccess1WithDefaults instantiates a new IdentityWithNewAccess1 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 + +### GetIdentityId + +`func (o *IdentityWithNewAccess1) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *IdentityWithNewAccess1) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *IdentityWithNewAccess1) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetAccessRefs + +`func (o *IdentityWithNewAccess1) GetAccessRefs() []EntitlementRef1` + +GetAccessRefs returns the AccessRefs field if non-nil, zero value otherwise. + +### GetAccessRefsOk + +`func (o *IdentityWithNewAccess1) GetAccessRefsOk() (*[]EntitlementRef1, bool)` + +GetAccessRefsOk returns a tuple with the AccessRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRefs + +`func (o *IdentityWithNewAccess1) SetAccessRefs(v []EntitlementRef1)` + +SetAccessRefs sets AccessRefs field to given value. + + +### GetClientMetadata + +`func (o *IdentityWithNewAccess1) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *IdentityWithNewAccess1) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *IdentityWithNewAccess1) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *IdentityWithNewAccess1) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/go/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md new file mode 100644 index 000000000..1890782ba --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md @@ -0,0 +1,116 @@ +--- +id: v2024-identity-with-new-access-access-refs-inner +title: IdentityWithNewAccessAccessRefsInner +pagination_label: IdentityWithNewAccessAccessRefsInner +sidebar_label: IdentityWithNewAccessAccessRefsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityWithNewAccessAccessRefsInner', 'V2024IdentityWithNewAccessAccessRefsInner'] +slug: /tools/sdk/go/v2024/models/identity-with-new-access-access-refs-inner +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccessAccessRefsInner', 'V2024IdentityWithNewAccessAccessRefsInner'] +--- + +# IdentityWithNewAccessAccessRefsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Entitlement's DTO type. | [optional] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **string** | Entitlement's display name. | [optional] + +## Methods + +### NewIdentityWithNewAccessAccessRefsInner + +`func NewIdentityWithNewAccessAccessRefsInner() *IdentityWithNewAccessAccessRefsInner` + +NewIdentityWithNewAccessAccessRefsInner instantiates a new IdentityWithNewAccessAccessRefsInner 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 + +### NewIdentityWithNewAccessAccessRefsInnerWithDefaults + +`func NewIdentityWithNewAccessAccessRefsInnerWithDefaults() *IdentityWithNewAccessAccessRefsInner` + +NewIdentityWithNewAccessAccessRefsInnerWithDefaults instantiates a new IdentityWithNewAccessAccessRefsInner 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 + +### GetType + +`func (o *IdentityWithNewAccessAccessRefsInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityWithNewAccessAccessRefsInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityWithNewAccessAccessRefsInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityWithNewAccessAccessRefsInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityWithNewAccessAccessRefsInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityWithNewAccessAccessRefsInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityWithNewAccessAccessRefsInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityWithNewAccessAccessRefsInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityWithNewAccessAccessRefsInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityWithNewAccessAccessRefsInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityWithNewAccessAccessRefsInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityWithNewAccessAccessRefsInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/IdpDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/IdpDetails.md new file mode 100644 index 000000000..bac4b836a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/IdpDetails.md @@ -0,0 +1,397 @@ +--- +id: v2024-idp-details +title: IdpDetails +pagination_label: IdpDetails +sidebar_label: IdpDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdpDetails', 'V2024IdpDetails'] +slug: /tools/sdk/go/v2024/models/idp-details +tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'V2024IdpDetails'] +--- + +# IdpDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | Pointer to **string** | Federation protocol role | [optional] +**EntityId** | Pointer to **string** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Binding** | Pointer to **string** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**AuthnContext** | Pointer to **string** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**LogoutUrl** | Pointer to **string** | The IDP logout URL. Used with IDP configurations. | [optional] +**IncludeAuthnContext** | Pointer to **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to false] +**NameId** | Pointer to **string** | The name id format to use. Used with IDP configurations. | [optional] +**JitConfiguration** | Pointer to [**JITConfiguration**](jit-configuration) | | [optional] +**Cert** | Pointer to **string** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**LoginUrlPost** | Pointer to **string** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**LoginUrlRedirect** | Pointer to **string** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**MappingAttribute** | **string** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | +**CertificateExpirationDate** | Pointer to **string** | The expiration date extracted from the certificate. | [optional] +**CertificateName** | Pointer to **string** | The name extracted from the certificate. | [optional] + +## Methods + +### NewIdpDetails + +`func NewIdpDetails(mappingAttribute string, ) *IdpDetails` + +NewIdpDetails instantiates a new IdpDetails 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 + +### NewIdpDetailsWithDefaults + +`func NewIdpDetailsWithDefaults() *IdpDetails` + +NewIdpDetailsWithDefaults instantiates a new IdpDetails 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 + +### GetRole + +`func (o *IdpDetails) GetRole() string` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *IdpDetails) GetRoleOk() (*string, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *IdpDetails) SetRole(v string)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *IdpDetails) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetEntityId + +`func (o *IdpDetails) GetEntityId() string` + +GetEntityId returns the EntityId field if non-nil, zero value otherwise. + +### GetEntityIdOk + +`func (o *IdpDetails) GetEntityIdOk() (*string, bool)` + +GetEntityIdOk returns a tuple with the EntityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntityId + +`func (o *IdpDetails) SetEntityId(v string)` + +SetEntityId sets EntityId field to given value. + +### HasEntityId + +`func (o *IdpDetails) HasEntityId() bool` + +HasEntityId returns a boolean if a field has been set. + +### GetBinding + +`func (o *IdpDetails) GetBinding() string` + +GetBinding returns the Binding field if non-nil, zero value otherwise. + +### GetBindingOk + +`func (o *IdpDetails) GetBindingOk() (*string, bool)` + +GetBindingOk returns a tuple with the Binding field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBinding + +`func (o *IdpDetails) SetBinding(v string)` + +SetBinding sets Binding field to given value. + +### HasBinding + +`func (o *IdpDetails) HasBinding() bool` + +HasBinding returns a boolean if a field has been set. + +### GetAuthnContext + +`func (o *IdpDetails) GetAuthnContext() string` + +GetAuthnContext returns the AuthnContext field if non-nil, zero value otherwise. + +### GetAuthnContextOk + +`func (o *IdpDetails) GetAuthnContextOk() (*string, bool)` + +GetAuthnContextOk returns a tuple with the AuthnContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthnContext + +`func (o *IdpDetails) SetAuthnContext(v string)` + +SetAuthnContext sets AuthnContext field to given value. + +### HasAuthnContext + +`func (o *IdpDetails) HasAuthnContext() bool` + +HasAuthnContext returns a boolean if a field has been set. + +### GetLogoutUrl + +`func (o *IdpDetails) GetLogoutUrl() string` + +GetLogoutUrl returns the LogoutUrl field if non-nil, zero value otherwise. + +### GetLogoutUrlOk + +`func (o *IdpDetails) GetLogoutUrlOk() (*string, bool)` + +GetLogoutUrlOk returns a tuple with the LogoutUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogoutUrl + +`func (o *IdpDetails) SetLogoutUrl(v string)` + +SetLogoutUrl sets LogoutUrl field to given value. + +### HasLogoutUrl + +`func (o *IdpDetails) HasLogoutUrl() bool` + +HasLogoutUrl returns a boolean if a field has been set. + +### GetIncludeAuthnContext + +`func (o *IdpDetails) GetIncludeAuthnContext() bool` + +GetIncludeAuthnContext returns the IncludeAuthnContext field if non-nil, zero value otherwise. + +### GetIncludeAuthnContextOk + +`func (o *IdpDetails) GetIncludeAuthnContextOk() (*bool, bool)` + +GetIncludeAuthnContextOk returns a tuple with the IncludeAuthnContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeAuthnContext + +`func (o *IdpDetails) SetIncludeAuthnContext(v bool)` + +SetIncludeAuthnContext sets IncludeAuthnContext field to given value. + +### HasIncludeAuthnContext + +`func (o *IdpDetails) HasIncludeAuthnContext() bool` + +HasIncludeAuthnContext returns a boolean if a field has been set. + +### GetNameId + +`func (o *IdpDetails) GetNameId() string` + +GetNameId returns the NameId field if non-nil, zero value otherwise. + +### GetNameIdOk + +`func (o *IdpDetails) GetNameIdOk() (*string, bool)` + +GetNameIdOk returns a tuple with the NameId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNameId + +`func (o *IdpDetails) SetNameId(v string)` + +SetNameId sets NameId field to given value. + +### HasNameId + +`func (o *IdpDetails) HasNameId() bool` + +HasNameId returns a boolean if a field has been set. + +### GetJitConfiguration + +`func (o *IdpDetails) GetJitConfiguration() JITConfiguration` + +GetJitConfiguration returns the JitConfiguration field if non-nil, zero value otherwise. + +### GetJitConfigurationOk + +`func (o *IdpDetails) GetJitConfigurationOk() (*JITConfiguration, bool)` + +GetJitConfigurationOk returns a tuple with the JitConfiguration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJitConfiguration + +`func (o *IdpDetails) SetJitConfiguration(v JITConfiguration)` + +SetJitConfiguration sets JitConfiguration field to given value. + +### HasJitConfiguration + +`func (o *IdpDetails) HasJitConfiguration() bool` + +HasJitConfiguration returns a boolean if a field has been set. + +### GetCert + +`func (o *IdpDetails) GetCert() string` + +GetCert returns the Cert field if non-nil, zero value otherwise. + +### GetCertOk + +`func (o *IdpDetails) GetCertOk() (*string, bool)` + +GetCertOk returns a tuple with the Cert field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCert + +`func (o *IdpDetails) SetCert(v string)` + +SetCert sets Cert field to given value. + +### HasCert + +`func (o *IdpDetails) HasCert() bool` + +HasCert returns a boolean if a field has been set. + +### GetLoginUrlPost + +`func (o *IdpDetails) GetLoginUrlPost() string` + +GetLoginUrlPost returns the LoginUrlPost field if non-nil, zero value otherwise. + +### GetLoginUrlPostOk + +`func (o *IdpDetails) GetLoginUrlPostOk() (*string, bool)` + +GetLoginUrlPostOk returns a tuple with the LoginUrlPost field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginUrlPost + +`func (o *IdpDetails) SetLoginUrlPost(v string)` + +SetLoginUrlPost sets LoginUrlPost field to given value. + +### HasLoginUrlPost + +`func (o *IdpDetails) HasLoginUrlPost() bool` + +HasLoginUrlPost returns a boolean if a field has been set. + +### GetLoginUrlRedirect + +`func (o *IdpDetails) GetLoginUrlRedirect() string` + +GetLoginUrlRedirect returns the LoginUrlRedirect field if non-nil, zero value otherwise. + +### GetLoginUrlRedirectOk + +`func (o *IdpDetails) GetLoginUrlRedirectOk() (*string, bool)` + +GetLoginUrlRedirectOk returns a tuple with the LoginUrlRedirect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginUrlRedirect + +`func (o *IdpDetails) SetLoginUrlRedirect(v string)` + +SetLoginUrlRedirect sets LoginUrlRedirect field to given value. + +### HasLoginUrlRedirect + +`func (o *IdpDetails) HasLoginUrlRedirect() bool` + +HasLoginUrlRedirect returns a boolean if a field has been set. + +### GetMappingAttribute + +`func (o *IdpDetails) GetMappingAttribute() string` + +GetMappingAttribute returns the MappingAttribute field if non-nil, zero value otherwise. + +### GetMappingAttributeOk + +`func (o *IdpDetails) GetMappingAttributeOk() (*string, bool)` + +GetMappingAttributeOk returns a tuple with the MappingAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMappingAttribute + +`func (o *IdpDetails) SetMappingAttribute(v string)` + +SetMappingAttribute sets MappingAttribute field to given value. + + +### GetCertificateExpirationDate + +`func (o *IdpDetails) GetCertificateExpirationDate() string` + +GetCertificateExpirationDate returns the CertificateExpirationDate field if non-nil, zero value otherwise. + +### GetCertificateExpirationDateOk + +`func (o *IdpDetails) GetCertificateExpirationDateOk() (*string, bool)` + +GetCertificateExpirationDateOk returns a tuple with the CertificateExpirationDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificateExpirationDate + +`func (o *IdpDetails) SetCertificateExpirationDate(v string)` + +SetCertificateExpirationDate sets CertificateExpirationDate field to given value. + +### HasCertificateExpirationDate + +`func (o *IdpDetails) HasCertificateExpirationDate() bool` + +HasCertificateExpirationDate returns a boolean if a field has been set. + +### GetCertificateName + +`func (o *IdpDetails) GetCertificateName() string` + +GetCertificateName returns the CertificateName field if non-nil, zero value otherwise. + +### GetCertificateNameOk + +`func (o *IdpDetails) GetCertificateNameOk() (*string, bool)` + +GetCertificateNameOk returns a tuple with the CertificateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificateName + +`func (o *IdpDetails) SetCertificateName(v string)` + +SetCertificateName sets CertificateName field to given value. + +### HasCertificateName + +`func (o *IdpDetails) HasCertificateName() bool` + +HasCertificateName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ImportAccountsRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/ImportAccountsRequest.md new file mode 100644 index 000000000..bcd4b0ad0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ImportAccountsRequest.md @@ -0,0 +1,90 @@ +--- +id: v2024-import-accounts-request +title: ImportAccountsRequest +pagination_label: ImportAccountsRequest +sidebar_label: ImportAccountsRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportAccountsRequest', 'V2024ImportAccountsRequest'] +slug: /tools/sdk/go/v2024/models/import-accounts-request +tags: ['SDK', 'Software Development Kit', 'ImportAccountsRequest', 'V2024ImportAccountsRequest'] +--- + +# ImportAccountsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | Pointer to ***os.File** | The CSV file containing the source accounts to aggregate. | [optional] +**DisableOptimization** | Pointer to **string** | Use this flag to reprocess every account whether or not the data has changed. | [optional] + +## Methods + +### NewImportAccountsRequest + +`func NewImportAccountsRequest() *ImportAccountsRequest` + +NewImportAccountsRequest instantiates a new ImportAccountsRequest 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 + +### NewImportAccountsRequestWithDefaults + +`func NewImportAccountsRequestWithDefaults() *ImportAccountsRequest` + +NewImportAccountsRequestWithDefaults instantiates a new ImportAccountsRequest 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 + +### GetFile + +`func (o *ImportAccountsRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *ImportAccountsRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *ImportAccountsRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + +### HasFile + +`func (o *ImportAccountsRequest) HasFile() bool` + +HasFile returns a boolean if a field has been set. + +### GetDisableOptimization + +`func (o *ImportAccountsRequest) GetDisableOptimization() string` + +GetDisableOptimization returns the DisableOptimization field if non-nil, zero value otherwise. + +### GetDisableOptimizationOk + +`func (o *ImportAccountsRequest) GetDisableOptimizationOk() (*string, bool)` + +GetDisableOptimizationOk returns a tuple with the DisableOptimization field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisableOptimization + +`func (o *ImportAccountsRequest) SetDisableOptimization(v string)` + +SetDisableOptimization sets DisableOptimization field to given value. + +### HasDisableOptimization + +`func (o *ImportAccountsRequest) HasDisableOptimization() bool` + +HasDisableOptimization returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ImportEntitlementsBySourceRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/ImportEntitlementsBySourceRequest.md new file mode 100644 index 000000000..6751e7f95 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ImportEntitlementsBySourceRequest.md @@ -0,0 +1,64 @@ +--- +id: v2024-import-entitlements-by-source-request +title: ImportEntitlementsBySourceRequest +pagination_label: ImportEntitlementsBySourceRequest +sidebar_label: ImportEntitlementsBySourceRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportEntitlementsBySourceRequest', 'V2024ImportEntitlementsBySourceRequest'] +slug: /tools/sdk/go/v2024/models/import-entitlements-by-source-request +tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsBySourceRequest', 'V2024ImportEntitlementsBySourceRequest'] +--- + +# ImportEntitlementsBySourceRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CsvFile** | Pointer to ***os.File** | The CSV file containing the source entitlements to aggregate. | [optional] + +## Methods + +### NewImportEntitlementsBySourceRequest + +`func NewImportEntitlementsBySourceRequest() *ImportEntitlementsBySourceRequest` + +NewImportEntitlementsBySourceRequest instantiates a new ImportEntitlementsBySourceRequest 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 + +### NewImportEntitlementsBySourceRequestWithDefaults + +`func NewImportEntitlementsBySourceRequestWithDefaults() *ImportEntitlementsBySourceRequest` + +NewImportEntitlementsBySourceRequestWithDefaults instantiates a new ImportEntitlementsBySourceRequest 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 + +### GetCsvFile + +`func (o *ImportEntitlementsBySourceRequest) GetCsvFile() *os.File` + +GetCsvFile returns the CsvFile field if non-nil, zero value otherwise. + +### GetCsvFileOk + +`func (o *ImportEntitlementsBySourceRequest) GetCsvFileOk() (**os.File, bool)` + +GetCsvFileOk returns a tuple with the CsvFile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCsvFile + +`func (o *ImportEntitlementsBySourceRequest) SetCsvFile(v *os.File)` + +SetCsvFile sets CsvFile field to given value. + +### HasCsvFile + +`func (o *ImportEntitlementsBySourceRequest) HasCsvFile() bool` + +HasCsvFile returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ImportFormDefinitions202Response.md b/docs/tools/sdk/go/Reference/V2024/Models/ImportFormDefinitions202Response.md new file mode 100644 index 000000000..bfe4480cb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ImportFormDefinitions202Response.md @@ -0,0 +1,142 @@ +--- +id: v2024-import-form-definitions202-response +title: ImportFormDefinitions202Response +pagination_label: ImportFormDefinitions202Response +sidebar_label: ImportFormDefinitions202Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportFormDefinitions202Response', 'V2024ImportFormDefinitions202Response'] +slug: /tools/sdk/go/v2024/models/import-form-definitions202-response +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202Response', 'V2024ImportFormDefinitions202Response'] +--- + +# ImportFormDefinitions202Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] +**ImportedObjects** | Pointer to [**[]ImportFormDefinitionsRequestInner**](import-form-definitions-request-inner) | | [optional] +**Infos** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] +**Warnings** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] + +## Methods + +### NewImportFormDefinitions202Response + +`func NewImportFormDefinitions202Response() *ImportFormDefinitions202Response` + +NewImportFormDefinitions202Response instantiates a new ImportFormDefinitions202Response 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 + +### NewImportFormDefinitions202ResponseWithDefaults + +`func NewImportFormDefinitions202ResponseWithDefaults() *ImportFormDefinitions202Response` + +NewImportFormDefinitions202ResponseWithDefaults instantiates a new ImportFormDefinitions202Response 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 + +### GetErrors + +`func (o *ImportFormDefinitions202Response) GetErrors() []ImportFormDefinitions202ResponseErrorsInner` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *ImportFormDefinitions202Response) GetErrorsOk() (*[]ImportFormDefinitions202ResponseErrorsInner, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *ImportFormDefinitions202Response) SetErrors(v []ImportFormDefinitions202ResponseErrorsInner)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *ImportFormDefinitions202Response) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### GetImportedObjects + +`func (o *ImportFormDefinitions202Response) GetImportedObjects() []ImportFormDefinitionsRequestInner` + +GetImportedObjects returns the ImportedObjects field if non-nil, zero value otherwise. + +### GetImportedObjectsOk + +`func (o *ImportFormDefinitions202Response) GetImportedObjectsOk() (*[]ImportFormDefinitionsRequestInner, bool)` + +GetImportedObjectsOk returns a tuple with the ImportedObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImportedObjects + +`func (o *ImportFormDefinitions202Response) SetImportedObjects(v []ImportFormDefinitionsRequestInner)` + +SetImportedObjects sets ImportedObjects field to given value. + +### HasImportedObjects + +`func (o *ImportFormDefinitions202Response) HasImportedObjects() bool` + +HasImportedObjects returns a boolean if a field has been set. + +### GetInfos + +`func (o *ImportFormDefinitions202Response) GetInfos() []ImportFormDefinitions202ResponseErrorsInner` + +GetInfos returns the Infos field if non-nil, zero value otherwise. + +### GetInfosOk + +`func (o *ImportFormDefinitions202Response) GetInfosOk() (*[]ImportFormDefinitions202ResponseErrorsInner, bool)` + +GetInfosOk returns a tuple with the Infos field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfos + +`func (o *ImportFormDefinitions202Response) SetInfos(v []ImportFormDefinitions202ResponseErrorsInner)` + +SetInfos sets Infos field to given value. + +### HasInfos + +`func (o *ImportFormDefinitions202Response) HasInfos() bool` + +HasInfos returns a boolean if a field has been set. + +### GetWarnings + +`func (o *ImportFormDefinitions202Response) GetWarnings() []ImportFormDefinitions202ResponseErrorsInner` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *ImportFormDefinitions202Response) GetWarningsOk() (*[]ImportFormDefinitions202ResponseErrorsInner, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *ImportFormDefinitions202Response) SetWarnings(v []ImportFormDefinitions202ResponseErrorsInner)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *ImportFormDefinitions202Response) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ImportFormDefinitions202ResponseErrorsInner.md b/docs/tools/sdk/go/Reference/V2024/Models/ImportFormDefinitions202ResponseErrorsInner.md new file mode 100644 index 000000000..e0e1b1a71 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ImportFormDefinitions202ResponseErrorsInner.md @@ -0,0 +1,116 @@ +--- +id: v2024-import-form-definitions202-response-errors-inner +title: ImportFormDefinitions202ResponseErrorsInner +pagination_label: ImportFormDefinitions202ResponseErrorsInner +sidebar_label: ImportFormDefinitions202ResponseErrorsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportFormDefinitions202ResponseErrorsInner', 'V2024ImportFormDefinitions202ResponseErrorsInner'] +slug: /tools/sdk/go/v2024/models/import-form-definitions202-response-errors-inner +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202ResponseErrorsInner', 'V2024ImportFormDefinitions202ResponseErrorsInner'] +--- + +# ImportFormDefinitions202ResponseErrorsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Detail** | Pointer to **map[string]map[string]interface{}** | | [optional] +**Key** | Pointer to **string** | | [optional] +**Text** | Pointer to **string** | | [optional] + +## Methods + +### NewImportFormDefinitions202ResponseErrorsInner + +`func NewImportFormDefinitions202ResponseErrorsInner() *ImportFormDefinitions202ResponseErrorsInner` + +NewImportFormDefinitions202ResponseErrorsInner instantiates a new ImportFormDefinitions202ResponseErrorsInner 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 + +### NewImportFormDefinitions202ResponseErrorsInnerWithDefaults + +`func NewImportFormDefinitions202ResponseErrorsInnerWithDefaults() *ImportFormDefinitions202ResponseErrorsInner` + +NewImportFormDefinitions202ResponseErrorsInnerWithDefaults instantiates a new ImportFormDefinitions202ResponseErrorsInner 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 + +### GetDetail + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetDetail() map[string]map[string]interface{}` + +GetDetail returns the Detail field if non-nil, zero value otherwise. + +### GetDetailOk + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetDetailOk() (*map[string]map[string]interface{}, bool)` + +GetDetailOk returns a tuple with the Detail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetail + +`func (o *ImportFormDefinitions202ResponseErrorsInner) SetDetail(v map[string]map[string]interface{})` + +SetDetail sets Detail field to given value. + +### HasDetail + +`func (o *ImportFormDefinitions202ResponseErrorsInner) HasDetail() bool` + +HasDetail returns a boolean if a field has been set. + +### GetKey + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *ImportFormDefinitions202ResponseErrorsInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *ImportFormDefinitions202ResponseErrorsInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetText + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *ImportFormDefinitions202ResponseErrorsInner) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *ImportFormDefinitions202ResponseErrorsInner) HasText() bool` + +HasText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ImportFormDefinitionsRequestInner.md b/docs/tools/sdk/go/Reference/V2024/Models/ImportFormDefinitionsRequestInner.md new file mode 100644 index 000000000..787f6842f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ImportFormDefinitionsRequestInner.md @@ -0,0 +1,116 @@ +--- +id: v2024-import-form-definitions-request-inner +title: ImportFormDefinitionsRequestInner +pagination_label: ImportFormDefinitionsRequestInner +sidebar_label: ImportFormDefinitionsRequestInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportFormDefinitionsRequestInner', 'V2024ImportFormDefinitionsRequestInner'] +slug: /tools/sdk/go/v2024/models/import-form-definitions-request-inner +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitionsRequestInner', 'V2024ImportFormDefinitionsRequestInner'] +--- + +# ImportFormDefinitionsRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Object** | Pointer to [**FormDefinitionResponse**](form-definition-response) | | [optional] +**Self** | Pointer to **string** | | [optional] +**Version** | Pointer to **int32** | | [optional] + +## Methods + +### NewImportFormDefinitionsRequestInner + +`func NewImportFormDefinitionsRequestInner() *ImportFormDefinitionsRequestInner` + +NewImportFormDefinitionsRequestInner instantiates a new ImportFormDefinitionsRequestInner 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 + +### NewImportFormDefinitionsRequestInnerWithDefaults + +`func NewImportFormDefinitionsRequestInnerWithDefaults() *ImportFormDefinitionsRequestInner` + +NewImportFormDefinitionsRequestInnerWithDefaults instantiates a new ImportFormDefinitionsRequestInner 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 + +### GetObject + +`func (o *ImportFormDefinitionsRequestInner) GetObject() FormDefinitionResponse` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *ImportFormDefinitionsRequestInner) GetObjectOk() (*FormDefinitionResponse, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *ImportFormDefinitionsRequestInner) SetObject(v FormDefinitionResponse)` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *ImportFormDefinitionsRequestInner) HasObject() bool` + +HasObject returns a boolean if a field has been set. + +### GetSelf + +`func (o *ImportFormDefinitionsRequestInner) GetSelf() string` + +GetSelf returns the Self field if non-nil, zero value otherwise. + +### GetSelfOk + +`func (o *ImportFormDefinitionsRequestInner) GetSelfOk() (*string, bool)` + +GetSelfOk returns a tuple with the Self field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelf + +`func (o *ImportFormDefinitionsRequestInner) SetSelf(v string)` + +SetSelf sets Self field to given value. + +### HasSelf + +`func (o *ImportFormDefinitionsRequestInner) HasSelf() bool` + +HasSelf returns a boolean if a field has been set. + +### GetVersion + +`func (o *ImportFormDefinitionsRequestInner) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ImportFormDefinitionsRequestInner) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ImportFormDefinitionsRequestInner) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *ImportFormDefinitionsRequestInner) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ImportNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/ImportNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..4f51e7b94 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ImportNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,59 @@ +--- +id: v2024-import-non-employee-records-in-bulk-request +title: ImportNonEmployeeRecordsInBulkRequest +pagination_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportNonEmployeeRecordsInBulkRequest', 'V2024ImportNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/go/v2024/models/import-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'ImportNonEmployeeRecordsInBulkRequest', 'V2024ImportNonEmployeeRecordsInBulkRequest'] +--- + +# ImportNonEmployeeRecordsInBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | ***os.File** | | + +## Methods + +### NewImportNonEmployeeRecordsInBulkRequest + +`func NewImportNonEmployeeRecordsInBulkRequest(data *os.File, ) *ImportNonEmployeeRecordsInBulkRequest` + +NewImportNonEmployeeRecordsInBulkRequest instantiates a new ImportNonEmployeeRecordsInBulkRequest 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 + +### NewImportNonEmployeeRecordsInBulkRequestWithDefaults + +`func NewImportNonEmployeeRecordsInBulkRequestWithDefaults() *ImportNonEmployeeRecordsInBulkRequest` + +NewImportNonEmployeeRecordsInBulkRequestWithDefaults instantiates a new ImportNonEmployeeRecordsInBulkRequest 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 + +### GetData + +`func (o *ImportNonEmployeeRecordsInBulkRequest) GetData() *os.File` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *ImportNonEmployeeRecordsInBulkRequest) GetDataOk() (**os.File, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *ImportNonEmployeeRecordsInBulkRequest) SetData(v *os.File)` + +SetData sets Data field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ImportObject.md b/docs/tools/sdk/go/Reference/V2024/Models/ImportObject.md new file mode 100644 index 000000000..e6d56b98e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ImportObject.md @@ -0,0 +1,116 @@ +--- +id: v2024-import-object +title: ImportObject +pagination_label: ImportObject +sidebar_label: ImportObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportObject', 'V2024ImportObject'] +slug: /tools/sdk/go/v2024/models/import-object +tags: ['SDK', 'Software Development Kit', 'ImportObject', 'V2024ImportObject'] +--- + +# ImportObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of object created or updated by import. | [optional] +**Id** | Pointer to **string** | ID of object created or updated by import. | [optional] +**Name** | Pointer to **string** | Display name of object created or updated by import. | [optional] + +## Methods + +### NewImportObject + +`func NewImportObject() *ImportObject` + +NewImportObject instantiates a new ImportObject 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 + +### NewImportObjectWithDefaults + +`func NewImportObjectWithDefaults() *ImportObject` + +NewImportObjectWithDefaults instantiates a new ImportObject 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 + +### GetType + +`func (o *ImportObject) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ImportObject) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ImportObject) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ImportObject) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ImportObject) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ImportObject) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ImportObject) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ImportObject) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ImportObject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ImportObject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ImportObject) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ImportObject) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ImportOptions.md b/docs/tools/sdk/go/Reference/V2024/Models/ImportOptions.md new file mode 100644 index 000000000..c5042caa8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ImportOptions.md @@ -0,0 +1,168 @@ +--- +id: v2024-import-options +title: ImportOptions +pagination_label: ImportOptions +sidebar_label: ImportOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportOptions', 'V2024ImportOptions'] +slug: /tools/sdk/go/v2024/models/import-options +tags: ['SDK', 'Software Development Kit', 'ImportOptions', 'V2024ImportOptions'] +--- + +# ImportOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExcludeTypes** | Pointer to **[]string** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]string** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] +**DefaultReferences** | Pointer to **[]string** | List of object types that can be used to resolve references on import. | [optional] +**ExcludeBackup** | Pointer to **bool** | By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed. | [optional] [default to false] + +## Methods + +### NewImportOptions + +`func NewImportOptions() *ImportOptions` + +NewImportOptions instantiates a new ImportOptions 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 + +### NewImportOptionsWithDefaults + +`func NewImportOptionsWithDefaults() *ImportOptions` + +NewImportOptionsWithDefaults instantiates a new ImportOptions 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 + +### GetExcludeTypes + +`func (o *ImportOptions) GetExcludeTypes() []string` + +GetExcludeTypes returns the ExcludeTypes field if non-nil, zero value otherwise. + +### GetExcludeTypesOk + +`func (o *ImportOptions) GetExcludeTypesOk() (*[]string, bool)` + +GetExcludeTypesOk returns a tuple with the ExcludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeTypes + +`func (o *ImportOptions) SetExcludeTypes(v []string)` + +SetExcludeTypes sets ExcludeTypes field to given value. + +### HasExcludeTypes + +`func (o *ImportOptions) HasExcludeTypes() bool` + +HasExcludeTypes returns a boolean if a field has been set. + +### GetIncludeTypes + +`func (o *ImportOptions) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *ImportOptions) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *ImportOptions) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *ImportOptions) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *ImportOptions) GetObjectOptions() map[string]ObjectExportImportOptions` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *ImportOptions) GetObjectOptionsOk() (*map[string]ObjectExportImportOptions, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *ImportOptions) SetObjectOptions(v map[string]ObjectExportImportOptions)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *ImportOptions) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + +### GetDefaultReferences + +`func (o *ImportOptions) GetDefaultReferences() []string` + +GetDefaultReferences returns the DefaultReferences field if non-nil, zero value otherwise. + +### GetDefaultReferencesOk + +`func (o *ImportOptions) GetDefaultReferencesOk() (*[]string, bool)` + +GetDefaultReferencesOk returns a tuple with the DefaultReferences field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultReferences + +`func (o *ImportOptions) SetDefaultReferences(v []string)` + +SetDefaultReferences sets DefaultReferences field to given value. + +### HasDefaultReferences + +`func (o *ImportOptions) HasDefaultReferences() bool` + +HasDefaultReferences returns a boolean if a field has been set. + +### GetExcludeBackup + +`func (o *ImportOptions) GetExcludeBackup() bool` + +GetExcludeBackup returns the ExcludeBackup field if non-nil, zero value otherwise. + +### GetExcludeBackupOk + +`func (o *ImportOptions) GetExcludeBackupOk() (*bool, bool)` + +GetExcludeBackupOk returns a tuple with the ExcludeBackup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeBackup + +`func (o *ImportOptions) SetExcludeBackup(v bool)` + +SetExcludeBackup sets ExcludeBackup field to given value. + +### HasExcludeBackup + +`func (o *ImportOptions) HasExcludeBackup() bool` + +HasExcludeBackup returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ImportSpConfigRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/ImportSpConfigRequest.md new file mode 100644 index 000000000..bb64339f4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ImportSpConfigRequest.md @@ -0,0 +1,85 @@ +--- +id: v2024-import-sp-config-request +title: ImportSpConfigRequest +pagination_label: ImportSpConfigRequest +sidebar_label: ImportSpConfigRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportSpConfigRequest', 'V2024ImportSpConfigRequest'] +slug: /tools/sdk/go/v2024/models/import-sp-config-request +tags: ['SDK', 'Software Development Kit', 'ImportSpConfigRequest', 'V2024ImportSpConfigRequest'] +--- + +# ImportSpConfigRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | ***os.File** | JSON file containing the objects to be imported. | +**Options** | Pointer to [**ImportOptions**](import-options) | | [optional] + +## Methods + +### NewImportSpConfigRequest + +`func NewImportSpConfigRequest(data *os.File, ) *ImportSpConfigRequest` + +NewImportSpConfigRequest instantiates a new ImportSpConfigRequest 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 + +### NewImportSpConfigRequestWithDefaults + +`func NewImportSpConfigRequestWithDefaults() *ImportSpConfigRequest` + +NewImportSpConfigRequestWithDefaults instantiates a new ImportSpConfigRequest 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 + +### GetData + +`func (o *ImportSpConfigRequest) GetData() *os.File` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *ImportSpConfigRequest) GetDataOk() (**os.File, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *ImportSpConfigRequest) SetData(v *os.File)` + +SetData sets Data field to given value. + + +### GetOptions + +`func (o *ImportSpConfigRequest) GetOptions() ImportOptions` + +GetOptions returns the Options field if non-nil, zero value otherwise. + +### GetOptionsOk + +`func (o *ImportSpConfigRequest) GetOptionsOk() (*ImportOptions, bool)` + +GetOptionsOk returns a tuple with the Options field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOptions + +`func (o *ImportSpConfigRequest) SetOptions(v ImportOptions)` + +SetOptions sets Options field to given value. + +### HasOptions + +`func (o *ImportSpConfigRequest) HasOptions() bool` + +HasOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Index.md b/docs/tools/sdk/go/Reference/V2024/Models/Index.md new file mode 100644 index 000000000..ec8815b3f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Index.md @@ -0,0 +1,18 @@ +--- +id: models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 3 +sidebar_class_name: models +keywords: ['go', 'Golang', 'sdk', 'models'] +slug: /tools/sdk/go/v2024/models +tags: ['SDK', 'Software Development Kit', 'v2024', 'models'] +--- + +The Python SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. \ No newline at end of file diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Indices.md b/docs/tools/sdk/go/Reference/V2024/Models/Indices.md new file mode 100644 index 000000000..e5ffc238e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Indices.md @@ -0,0 +1,31 @@ +--- +id: v2024-index +title: Index +pagination_label: Index +sidebar_label: Index +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Index', 'V2024Index'] +slug: /tools/sdk/go/v2024/models/index +tags: ['SDK', 'Software Development Kit', 'Index', 'V2024Index'] +--- + +# Index + +## Enum + + +* `ACCESSPROFILES` (value: `"accessprofiles"`) + +* `ACCOUNTACTIVITIES` (value: `"accountactivities"`) + +* `ENTITLEMENTS` (value: `"entitlements"`) + +* `EVENTS` (value: `"events"`) + +* `IDENTITIES` (value: `"identities"`) + +* `ROLES` (value: `"roles"`) + +* `STAR` (value: `"*"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/InnerHit.md b/docs/tools/sdk/go/Reference/V2024/Models/InnerHit.md new file mode 100644 index 000000000..78b7840ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/InnerHit.md @@ -0,0 +1,80 @@ +--- +id: v2024-inner-hit +title: InnerHit +pagination_label: InnerHit +sidebar_label: InnerHit +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'InnerHit', 'V2024InnerHit'] +slug: /tools/sdk/go/v2024/models/inner-hit +tags: ['SDK', 'Software Development Kit', 'InnerHit', 'V2024InnerHit'] +--- + +# InnerHit + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **string** | The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | +**Type** | **string** | The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps. | + +## Methods + +### NewInnerHit + +`func NewInnerHit(query string, type_ string, ) *InnerHit` + +NewInnerHit instantiates a new InnerHit 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 + +### NewInnerHitWithDefaults + +`func NewInnerHitWithDefaults() *InnerHit` + +NewInnerHitWithDefaults instantiates a new InnerHit 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 + +### GetQuery + +`func (o *InnerHit) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *InnerHit) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *InnerHit) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetType + +`func (o *InnerHit) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *InnerHit) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *InnerHit) SetType(v string)` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/InviteIdentitiesRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/InviteIdentitiesRequest.md new file mode 100644 index 000000000..6e87fb228 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/InviteIdentitiesRequest.md @@ -0,0 +1,100 @@ +--- +id: v2024-invite-identities-request +title: InviteIdentitiesRequest +pagination_label: InviteIdentitiesRequest +sidebar_label: InviteIdentitiesRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'InviteIdentitiesRequest', 'V2024InviteIdentitiesRequest'] +slug: /tools/sdk/go/v2024/models/invite-identities-request +tags: ['SDK', 'Software Development Kit', 'InviteIdentitiesRequest', 'V2024InviteIdentitiesRequest'] +--- + +# InviteIdentitiesRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]string** | The list of Identities IDs to invite - required when 'uninvited' is false | [optional] +**Uninvited** | Pointer to **bool** | indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when 'ids' is empty. | [optional] [default to false] + +## Methods + +### NewInviteIdentitiesRequest + +`func NewInviteIdentitiesRequest() *InviteIdentitiesRequest` + +NewInviteIdentitiesRequest instantiates a new InviteIdentitiesRequest 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 + +### NewInviteIdentitiesRequestWithDefaults + +`func NewInviteIdentitiesRequestWithDefaults() *InviteIdentitiesRequest` + +NewInviteIdentitiesRequestWithDefaults instantiates a new InviteIdentitiesRequest 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 + +### GetIds + +`func (o *InviteIdentitiesRequest) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *InviteIdentitiesRequest) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *InviteIdentitiesRequest) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *InviteIdentitiesRequest) HasIds() bool` + +HasIds returns a boolean if a field has been set. + +### SetIdsNil + +`func (o *InviteIdentitiesRequest) SetIdsNil(b bool)` + + SetIdsNil sets the value for Ids to be an explicit nil + +### UnsetIds +`func (o *InviteIdentitiesRequest) UnsetIds()` + +UnsetIds ensures that no value is present for Ids, not even an explicit nil +### GetUninvited + +`func (o *InviteIdentitiesRequest) GetUninvited() bool` + +GetUninvited returns the Uninvited field if non-nil, zero value otherwise. + +### GetUninvitedOk + +`func (o *InviteIdentitiesRequest) GetUninvitedOk() (*bool, bool)` + +GetUninvitedOk returns a tuple with the Uninvited field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUninvited + +`func (o *InviteIdentitiesRequest) SetUninvited(v bool)` + +SetUninvited sets Uninvited field to given value. + +### HasUninvited + +`func (o *InviteIdentitiesRequest) HasUninvited() bool` + +HasUninvited returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Invocation.md b/docs/tools/sdk/go/Reference/V2024/Models/Invocation.md new file mode 100644 index 000000000..e3d0bf61e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Invocation.md @@ -0,0 +1,142 @@ +--- +id: v2024-invocation +title: Invocation +pagination_label: Invocation +sidebar_label: Invocation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Invocation', 'V2024Invocation'] +slug: /tools/sdk/go/v2024/models/invocation +tags: ['SDK', 'Software Development Kit', 'Invocation', 'V2024Invocation'] +--- + +# Invocation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Invocation ID | [optional] +**TriggerId** | Pointer to **string** | Trigger ID | [optional] +**Secret** | Pointer to **string** | Unique invocation secret. | [optional] +**ContentJson** | Pointer to **map[string]interface{}** | JSON map of invocation metadata. | [optional] + +## Methods + +### NewInvocation + +`func NewInvocation() *Invocation` + +NewInvocation instantiates a new Invocation 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 + +### NewInvocationWithDefaults + +`func NewInvocationWithDefaults() *Invocation` + +NewInvocationWithDefaults instantiates a new Invocation 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 + +### GetId + +`func (o *Invocation) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Invocation) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Invocation) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Invocation) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetTriggerId + +`func (o *Invocation) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *Invocation) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *Invocation) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + +### HasTriggerId + +`func (o *Invocation) HasTriggerId() bool` + +HasTriggerId returns a boolean if a field has been set. + +### GetSecret + +`func (o *Invocation) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *Invocation) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *Invocation) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *Invocation) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### GetContentJson + +`func (o *Invocation) GetContentJson() map[string]interface{}` + +GetContentJson returns the ContentJson field if non-nil, zero value otherwise. + +### GetContentJsonOk + +`func (o *Invocation) GetContentJsonOk() (*map[string]interface{}, bool)` + +GetContentJsonOk returns a tuple with the ContentJson field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContentJson + +`func (o *Invocation) SetContentJson(v map[string]interface{})` + +SetContentJson sets ContentJson field to given value. + +### HasContentJson + +`func (o *Invocation) HasContentJson() bool` + +HasContentJson returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/InvocationStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/InvocationStatus.md new file mode 100644 index 000000000..f69817848 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/InvocationStatus.md @@ -0,0 +1,237 @@ +--- +id: v2024-invocation-status +title: InvocationStatus +pagination_label: InvocationStatus +sidebar_label: InvocationStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'InvocationStatus', 'V2024InvocationStatus'] +slug: /tools/sdk/go/v2024/models/invocation-status +tags: ['SDK', 'Software Development Kit', 'InvocationStatus', 'V2024InvocationStatus'] +--- + +# InvocationStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Invocation ID | +**TriggerId** | **string** | Trigger ID | +**SubscriptionName** | **string** | Subscription name | +**SubscriptionId** | **string** | Subscription ID | +**Type** | [**InvocationStatusType**](invocation-status-type) | | +**Created** | **SailPointTime** | Invocation created timestamp. ISO-8601 in UTC. | +**Completed** | Pointer to **SailPointTime** | Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC. | [optional] +**StartInvocationInput** | [**StartInvocationInput**](start-invocation-input) | | +**CompleteInvocationInput** | Pointer to [**CompleteInvocationInput**](complete-invocation-input) | | [optional] + +## Methods + +### NewInvocationStatus + +`func NewInvocationStatus(id string, triggerId string, subscriptionName string, subscriptionId string, type_ InvocationStatusType, created SailPointTime, startInvocationInput StartInvocationInput, ) *InvocationStatus` + +NewInvocationStatus instantiates a new InvocationStatus 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 + +### NewInvocationStatusWithDefaults + +`func NewInvocationStatusWithDefaults() *InvocationStatus` + +NewInvocationStatusWithDefaults instantiates a new InvocationStatus 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 + +### GetId + +`func (o *InvocationStatus) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *InvocationStatus) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *InvocationStatus) SetId(v string)` + +SetId sets Id field to given value. + + +### GetTriggerId + +`func (o *InvocationStatus) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *InvocationStatus) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *InvocationStatus) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + + +### GetSubscriptionName + +`func (o *InvocationStatus) GetSubscriptionName() string` + +GetSubscriptionName returns the SubscriptionName field if non-nil, zero value otherwise. + +### GetSubscriptionNameOk + +`func (o *InvocationStatus) GetSubscriptionNameOk() (*string, bool)` + +GetSubscriptionNameOk returns a tuple with the SubscriptionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubscriptionName + +`func (o *InvocationStatus) SetSubscriptionName(v string)` + +SetSubscriptionName sets SubscriptionName field to given value. + + +### GetSubscriptionId + +`func (o *InvocationStatus) GetSubscriptionId() string` + +GetSubscriptionId returns the SubscriptionId field if non-nil, zero value otherwise. + +### GetSubscriptionIdOk + +`func (o *InvocationStatus) GetSubscriptionIdOk() (*string, bool)` + +GetSubscriptionIdOk returns a tuple with the SubscriptionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubscriptionId + +`func (o *InvocationStatus) SetSubscriptionId(v string)` + +SetSubscriptionId sets SubscriptionId field to given value. + + +### GetType + +`func (o *InvocationStatus) GetType() InvocationStatusType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *InvocationStatus) GetTypeOk() (*InvocationStatusType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *InvocationStatus) SetType(v InvocationStatusType)` + +SetType sets Type field to given value. + + +### GetCreated + +`func (o *InvocationStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *InvocationStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *InvocationStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetCompleted + +`func (o *InvocationStatus) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *InvocationStatus) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *InvocationStatus) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *InvocationStatus) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetStartInvocationInput + +`func (o *InvocationStatus) GetStartInvocationInput() StartInvocationInput` + +GetStartInvocationInput returns the StartInvocationInput field if non-nil, zero value otherwise. + +### GetStartInvocationInputOk + +`func (o *InvocationStatus) GetStartInvocationInputOk() (*StartInvocationInput, bool)` + +GetStartInvocationInputOk returns a tuple with the StartInvocationInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartInvocationInput + +`func (o *InvocationStatus) SetStartInvocationInput(v StartInvocationInput)` + +SetStartInvocationInput sets StartInvocationInput field to given value. + + +### GetCompleteInvocationInput + +`func (o *InvocationStatus) GetCompleteInvocationInput() CompleteInvocationInput` + +GetCompleteInvocationInput returns the CompleteInvocationInput field if non-nil, zero value otherwise. + +### GetCompleteInvocationInputOk + +`func (o *InvocationStatus) GetCompleteInvocationInputOk() (*CompleteInvocationInput, bool)` + +GetCompleteInvocationInputOk returns a tuple with the CompleteInvocationInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleteInvocationInput + +`func (o *InvocationStatus) SetCompleteInvocationInput(v CompleteInvocationInput)` + +SetCompleteInvocationInput sets CompleteInvocationInput field to given value. + +### HasCompleteInvocationInput + +`func (o *InvocationStatus) HasCompleteInvocationInput() bool` + +HasCompleteInvocationInput returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/InvocationStatusType.md b/docs/tools/sdk/go/Reference/V2024/Models/InvocationStatusType.md new file mode 100644 index 000000000..c7c06f222 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/InvocationStatusType.md @@ -0,0 +1,21 @@ +--- +id: v2024-invocation-status-type +title: InvocationStatusType +pagination_label: InvocationStatusType +sidebar_label: InvocationStatusType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'InvocationStatusType', 'V2024InvocationStatusType'] +slug: /tools/sdk/go/v2024/models/invocation-status-type +tags: ['SDK', 'Software Development Kit', 'InvocationStatusType', 'V2024InvocationStatusType'] +--- + +# InvocationStatusType + +## Enum + + +* `TEST` (value: `"TEST"`) + +* `REAL_TIME` (value: `"REAL_TIME"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/JITConfiguration.md b/docs/tools/sdk/go/Reference/V2024/Models/JITConfiguration.md new file mode 100644 index 000000000..76baf76aa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/JITConfiguration.md @@ -0,0 +1,116 @@ +--- +id: v2024-jit-configuration +title: JITConfiguration +pagination_label: JITConfiguration +sidebar_label: JITConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'JITConfiguration', 'V2024JITConfiguration'] +slug: /tools/sdk/go/v2024/models/jit-configuration +tags: ['SDK', 'Software Development Kit', 'JITConfiguration', 'V2024JITConfiguration'] +--- + +# JITConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | The indicator for just-in-time provisioning enabled | [optional] [default to false] +**SourceId** | Pointer to **string** | the sourceId that mapped to just-in-time provisioning configuration | [optional] +**SourceAttributeMappings** | Pointer to **map[string]string** | A mapping of identity profile attribute names to SAML assertion attribute names | [optional] + +## Methods + +### NewJITConfiguration + +`func NewJITConfiguration() *JITConfiguration` + +NewJITConfiguration instantiates a new JITConfiguration 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 + +### NewJITConfigurationWithDefaults + +`func NewJITConfigurationWithDefaults() *JITConfiguration` + +NewJITConfigurationWithDefaults instantiates a new JITConfiguration 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 + +### GetEnabled + +`func (o *JITConfiguration) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *JITConfiguration) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *JITConfiguration) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *JITConfiguration) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetSourceId + +`func (o *JITConfiguration) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *JITConfiguration) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *JITConfiguration) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *JITConfiguration) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceAttributeMappings + +`func (o *JITConfiguration) GetSourceAttributeMappings() map[string]string` + +GetSourceAttributeMappings returns the SourceAttributeMappings field if non-nil, zero value otherwise. + +### GetSourceAttributeMappingsOk + +`func (o *JITConfiguration) GetSourceAttributeMappingsOk() (*map[string]string, bool)` + +GetSourceAttributeMappingsOk returns a tuple with the SourceAttributeMappings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceAttributeMappings + +`func (o *JITConfiguration) SetSourceAttributeMappings(v map[string]string)` + +SetSourceAttributeMappings sets SourceAttributeMappings field to given value. + +### HasSourceAttributeMappings + +`func (o *JITConfiguration) HasSourceAttributeMappings() bool` + +HasSourceAttributeMappings returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/JsonPatch.md b/docs/tools/sdk/go/Reference/V2024/Models/JsonPatch.md new file mode 100644 index 000000000..1e440a75b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/JsonPatch.md @@ -0,0 +1,64 @@ +--- +id: v2024-json-patch +title: JsonPatch +pagination_label: JsonPatch +sidebar_label: JsonPatch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'JsonPatch', 'V2024JsonPatch'] +slug: /tools/sdk/go/v2024/models/json-patch +tags: ['SDK', 'Software Development Kit', 'JsonPatch', 'V2024JsonPatch'] +--- + +# JsonPatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operations** | Pointer to [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] + +## Methods + +### NewJsonPatch + +`func NewJsonPatch() *JsonPatch` + +NewJsonPatch instantiates a new JsonPatch 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 + +### NewJsonPatchWithDefaults + +`func NewJsonPatchWithDefaults() *JsonPatch` + +NewJsonPatchWithDefaults instantiates a new JsonPatch 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 + +### GetOperations + +`func (o *JsonPatch) GetOperations() []JsonPatchOperation` + +GetOperations returns the Operations field if non-nil, zero value otherwise. + +### GetOperationsOk + +`func (o *JsonPatch) GetOperationsOk() (*[]JsonPatchOperation, bool)` + +GetOperationsOk returns a tuple with the Operations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperations + +`func (o *JsonPatch) SetOperations(v []JsonPatchOperation)` + +SetOperations sets Operations field to given value. + +### HasOperations + +`func (o *JsonPatch) HasOperations() bool` + +HasOperations returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/JsonPatchOperation.md b/docs/tools/sdk/go/Reference/V2024/Models/JsonPatchOperation.md new file mode 100644 index 000000000..46254b881 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/JsonPatchOperation.md @@ -0,0 +1,106 @@ +--- +id: v2024-json-patch-operation +title: JsonPatchOperation +pagination_label: JsonPatchOperation +sidebar_label: JsonPatchOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'JsonPatchOperation', 'V2024JsonPatchOperation'] +slug: /tools/sdk/go/v2024/models/json-patch-operation +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperation', 'V2024JsonPatchOperation'] +--- + +# JsonPatchOperation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **string** | The operation to be performed | +**Path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | +**Value** | Pointer to [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] + +## Methods + +### NewJsonPatchOperation + +`func NewJsonPatchOperation(op string, path string, ) *JsonPatchOperation` + +NewJsonPatchOperation instantiates a new JsonPatchOperation 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 + +### NewJsonPatchOperationWithDefaults + +`func NewJsonPatchOperationWithDefaults() *JsonPatchOperation` + +NewJsonPatchOperationWithDefaults instantiates a new JsonPatchOperation 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 + +### GetOp + +`func (o *JsonPatchOperation) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *JsonPatchOperation) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *JsonPatchOperation) SetOp(v string)` + +SetOp sets Op field to given value. + + +### GetPath + +`func (o *JsonPatchOperation) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *JsonPatchOperation) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *JsonPatchOperation) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetValue + +`func (o *JsonPatchOperation) GetValue() UpdateMultiHostSourcesRequestInnerValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *JsonPatchOperation) GetValueOk() (*UpdateMultiHostSourcesRequestInnerValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *JsonPatchOperation) SetValue(v UpdateMultiHostSourcesRequestInnerValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *JsonPatchOperation) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/KbaAnswerRequestItem.md b/docs/tools/sdk/go/Reference/V2024/Models/KbaAnswerRequestItem.md new file mode 100644 index 000000000..ed0fd6852 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/KbaAnswerRequestItem.md @@ -0,0 +1,80 @@ +--- +id: v2024-kba-answer-request-item +title: KbaAnswerRequestItem +pagination_label: KbaAnswerRequestItem +sidebar_label: KbaAnswerRequestItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'KbaAnswerRequestItem', 'V2024KbaAnswerRequestItem'] +slug: /tools/sdk/go/v2024/models/kba-answer-request-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerRequestItem', 'V2024KbaAnswerRequestItem'] +--- + +# KbaAnswerRequestItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Question Id | +**Answer** | **string** | An answer for the KBA question | + +## Methods + +### NewKbaAnswerRequestItem + +`func NewKbaAnswerRequestItem(id string, answer string, ) *KbaAnswerRequestItem` + +NewKbaAnswerRequestItem instantiates a new KbaAnswerRequestItem 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 + +### NewKbaAnswerRequestItemWithDefaults + +`func NewKbaAnswerRequestItemWithDefaults() *KbaAnswerRequestItem` + +NewKbaAnswerRequestItemWithDefaults instantiates a new KbaAnswerRequestItem 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 + +### GetId + +`func (o *KbaAnswerRequestItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *KbaAnswerRequestItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *KbaAnswerRequestItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetAnswer + +`func (o *KbaAnswerRequestItem) GetAnswer() string` + +GetAnswer returns the Answer field if non-nil, zero value otherwise. + +### GetAnswerOk + +`func (o *KbaAnswerRequestItem) GetAnswerOk() (*string, bool)` + +GetAnswerOk returns a tuple with the Answer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnswer + +`func (o *KbaAnswerRequestItem) SetAnswer(v string)` + +SetAnswer sets Answer field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/KbaAnswerResponseItem.md b/docs/tools/sdk/go/Reference/V2024/Models/KbaAnswerResponseItem.md new file mode 100644 index 000000000..b1ec04cd8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/KbaAnswerResponseItem.md @@ -0,0 +1,101 @@ +--- +id: v2024-kba-answer-response-item +title: KbaAnswerResponseItem +pagination_label: KbaAnswerResponseItem +sidebar_label: KbaAnswerResponseItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'KbaAnswerResponseItem', 'V2024KbaAnswerResponseItem'] +slug: /tools/sdk/go/v2024/models/kba-answer-response-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerResponseItem', 'V2024KbaAnswerResponseItem'] +--- + +# KbaAnswerResponseItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Question Id | +**Question** | **string** | Question description | +**HasAnswer** | **bool** | Denotes whether the KBA question has an answer configured for the current user | + +## Methods + +### NewKbaAnswerResponseItem + +`func NewKbaAnswerResponseItem(id string, question string, hasAnswer bool, ) *KbaAnswerResponseItem` + +NewKbaAnswerResponseItem instantiates a new KbaAnswerResponseItem 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 + +### NewKbaAnswerResponseItemWithDefaults + +`func NewKbaAnswerResponseItemWithDefaults() *KbaAnswerResponseItem` + +NewKbaAnswerResponseItemWithDefaults instantiates a new KbaAnswerResponseItem 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 + +### GetId + +`func (o *KbaAnswerResponseItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *KbaAnswerResponseItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *KbaAnswerResponseItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetQuestion + +`func (o *KbaAnswerResponseItem) GetQuestion() string` + +GetQuestion returns the Question field if non-nil, zero value otherwise. + +### GetQuestionOk + +`func (o *KbaAnswerResponseItem) GetQuestionOk() (*string, bool)` + +GetQuestionOk returns a tuple with the Question field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuestion + +`func (o *KbaAnswerResponseItem) SetQuestion(v string)` + +SetQuestion sets Question field to given value. + + +### GetHasAnswer + +`func (o *KbaAnswerResponseItem) GetHasAnswer() bool` + +GetHasAnswer returns the HasAnswer field if non-nil, zero value otherwise. + +### GetHasAnswerOk + +`func (o *KbaAnswerResponseItem) GetHasAnswerOk() (*bool, bool)` + +GetHasAnswerOk returns a tuple with the HasAnswer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasAnswer + +`func (o *KbaAnswerResponseItem) SetHasAnswer(v bool)` + +SetHasAnswer sets HasAnswer field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/KbaQuestion.md b/docs/tools/sdk/go/Reference/V2024/Models/KbaQuestion.md new file mode 100644 index 000000000..cafe0bedc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/KbaQuestion.md @@ -0,0 +1,122 @@ +--- +id: v2024-kba-question +title: KbaQuestion +pagination_label: KbaQuestion +sidebar_label: KbaQuestion +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'KbaQuestion', 'V2024KbaQuestion'] +slug: /tools/sdk/go/v2024/models/kba-question +tags: ['SDK', 'Software Development Kit', 'KbaQuestion', 'V2024KbaQuestion'] +--- + +# KbaQuestion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | KBA Question Id | +**Text** | **string** | KBA Question description | +**HasAnswer** | **bool** | Denotes whether the KBA question has an answer configured for any user in the tenant | +**NumAnswers** | **int32** | Denotes the number of KBA configurations for this question | + +## Methods + +### NewKbaQuestion + +`func NewKbaQuestion(id string, text string, hasAnswer bool, numAnswers int32, ) *KbaQuestion` + +NewKbaQuestion instantiates a new KbaQuestion 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 + +### NewKbaQuestionWithDefaults + +`func NewKbaQuestionWithDefaults() *KbaQuestion` + +NewKbaQuestionWithDefaults instantiates a new KbaQuestion 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 + +### GetId + +`func (o *KbaQuestion) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *KbaQuestion) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *KbaQuestion) SetId(v string)` + +SetId sets Id field to given value. + + +### GetText + +`func (o *KbaQuestion) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *KbaQuestion) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *KbaQuestion) SetText(v string)` + +SetText sets Text field to given value. + + +### GetHasAnswer + +`func (o *KbaQuestion) GetHasAnswer() bool` + +GetHasAnswer returns the HasAnswer field if non-nil, zero value otherwise. + +### GetHasAnswerOk + +`func (o *KbaQuestion) GetHasAnswerOk() (*bool, bool)` + +GetHasAnswerOk returns a tuple with the HasAnswer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasAnswer + +`func (o *KbaQuestion) SetHasAnswer(v bool)` + +SetHasAnswer sets HasAnswer field to given value. + + +### GetNumAnswers + +`func (o *KbaQuestion) GetNumAnswers() int32` + +GetNumAnswers returns the NumAnswers field if non-nil, zero value otherwise. + +### GetNumAnswersOk + +`func (o *KbaQuestion) GetNumAnswersOk() (*int32, bool)` + +GetNumAnswersOk returns a tuple with the NumAnswers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumAnswers + +`func (o *KbaQuestion) SetNumAnswers(v int32)` + +SetNumAnswers sets NumAnswers field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LatestOutlierSummary.md b/docs/tools/sdk/go/Reference/V2024/Models/LatestOutlierSummary.md new file mode 100644 index 000000000..2e9e4931a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LatestOutlierSummary.md @@ -0,0 +1,168 @@ +--- +id: v2024-latest-outlier-summary +title: LatestOutlierSummary +pagination_label: LatestOutlierSummary +sidebar_label: LatestOutlierSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LatestOutlierSummary', 'V2024LatestOutlierSummary'] +slug: /tools/sdk/go/v2024/models/latest-outlier-summary +tags: ['SDK', 'Software Development Kit', 'LatestOutlierSummary', 'V2024LatestOutlierSummary'] +--- + +# LatestOutlierSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of outlier summary | [optional] +**SnapshotDate** | Pointer to **SailPointTime** | The date the bulk outlier detection ran/snapshot was created | [optional] +**TotalOutliers** | Pointer to **int32** | Total number of outliers for the customer making the request | [optional] +**TotalIdentities** | Pointer to **int32** | Total number of identities for the customer making the request | [optional] +**TotalIgnored** | Pointer to **int32** | Total number of ignored outliers | [optional] + +## Methods + +### NewLatestOutlierSummary + +`func NewLatestOutlierSummary() *LatestOutlierSummary` + +NewLatestOutlierSummary instantiates a new LatestOutlierSummary 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 + +### NewLatestOutlierSummaryWithDefaults + +`func NewLatestOutlierSummaryWithDefaults() *LatestOutlierSummary` + +NewLatestOutlierSummaryWithDefaults instantiates a new LatestOutlierSummary 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 + +### GetType + +`func (o *LatestOutlierSummary) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LatestOutlierSummary) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LatestOutlierSummary) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LatestOutlierSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSnapshotDate + +`func (o *LatestOutlierSummary) GetSnapshotDate() SailPointTime` + +GetSnapshotDate returns the SnapshotDate field if non-nil, zero value otherwise. + +### GetSnapshotDateOk + +`func (o *LatestOutlierSummary) GetSnapshotDateOk() (*SailPointTime, bool)` + +GetSnapshotDateOk returns a tuple with the SnapshotDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotDate + +`func (o *LatestOutlierSummary) SetSnapshotDate(v SailPointTime)` + +SetSnapshotDate sets SnapshotDate field to given value. + +### HasSnapshotDate + +`func (o *LatestOutlierSummary) HasSnapshotDate() bool` + +HasSnapshotDate returns a boolean if a field has been set. + +### GetTotalOutliers + +`func (o *LatestOutlierSummary) GetTotalOutliers() int32` + +GetTotalOutliers returns the TotalOutliers field if non-nil, zero value otherwise. + +### GetTotalOutliersOk + +`func (o *LatestOutlierSummary) GetTotalOutliersOk() (*int32, bool)` + +GetTotalOutliersOk returns a tuple with the TotalOutliers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalOutliers + +`func (o *LatestOutlierSummary) SetTotalOutliers(v int32)` + +SetTotalOutliers sets TotalOutliers field to given value. + +### HasTotalOutliers + +`func (o *LatestOutlierSummary) HasTotalOutliers() bool` + +HasTotalOutliers returns a boolean if a field has been set. + +### GetTotalIdentities + +`func (o *LatestOutlierSummary) GetTotalIdentities() int32` + +GetTotalIdentities returns the TotalIdentities field if non-nil, zero value otherwise. + +### GetTotalIdentitiesOk + +`func (o *LatestOutlierSummary) 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 *LatestOutlierSummary) SetTotalIdentities(v int32)` + +SetTotalIdentities sets TotalIdentities field to given value. + +### HasTotalIdentities + +`func (o *LatestOutlierSummary) HasTotalIdentities() bool` + +HasTotalIdentities returns a boolean if a field has been set. + +### GetTotalIgnored + +`func (o *LatestOutlierSummary) GetTotalIgnored() int32` + +GetTotalIgnored returns the TotalIgnored field if non-nil, zero value otherwise. + +### GetTotalIgnoredOk + +`func (o *LatestOutlierSummary) GetTotalIgnoredOk() (*int32, bool)` + +GetTotalIgnoredOk returns a tuple with the TotalIgnored field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalIgnored + +`func (o *LatestOutlierSummary) SetTotalIgnored(v int32)` + +SetTotalIgnored sets TotalIgnored field to given value. + +### HasTotalIgnored + +`func (o *LatestOutlierSummary) HasTotalIgnored() bool` + +HasTotalIgnored returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/License.md b/docs/tools/sdk/go/Reference/V2024/Models/License.md new file mode 100644 index 000000000..6d038379a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/License.md @@ -0,0 +1,90 @@ +--- +id: v2024-license +title: License +pagination_label: License +sidebar_label: License +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'License', 'V2024License'] +slug: /tools/sdk/go/v2024/models/license +tags: ['SDK', 'Software Development Kit', 'License', 'V2024License'] +--- + +# License + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LicenseId** | Pointer to **string** | Name of the license | [optional] +**LegacyFeatureName** | Pointer to **string** | Legacy name of the license | [optional] + +## Methods + +### NewLicense + +`func NewLicense() *License` + +NewLicense instantiates a new License 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 + +### NewLicenseWithDefaults + +`func NewLicenseWithDefaults() *License` + +NewLicenseWithDefaults instantiates a new License 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 + +### GetLicenseId + +`func (o *License) GetLicenseId() string` + +GetLicenseId returns the LicenseId field if non-nil, zero value otherwise. + +### GetLicenseIdOk + +`func (o *License) GetLicenseIdOk() (*string, bool)` + +GetLicenseIdOk returns a tuple with the LicenseId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLicenseId + +`func (o *License) SetLicenseId(v string)` + +SetLicenseId sets LicenseId field to given value. + +### HasLicenseId + +`func (o *License) HasLicenseId() bool` + +HasLicenseId returns a boolean if a field has been set. + +### GetLegacyFeatureName + +`func (o *License) GetLegacyFeatureName() string` + +GetLegacyFeatureName returns the LegacyFeatureName field if non-nil, zero value otherwise. + +### GetLegacyFeatureNameOk + +`func (o *License) GetLegacyFeatureNameOk() (*string, bool)` + +GetLegacyFeatureNameOk returns a tuple with the LegacyFeatureName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyFeatureName + +`func (o *License) SetLegacyFeatureName(v string)` + +SetLegacyFeatureName sets LegacyFeatureName field to given value. + +### HasLegacyFeatureName + +`func (o *License) HasLegacyFeatureName() bool` + +HasLegacyFeatureName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LifecycleState.md b/docs/tools/sdk/go/Reference/V2024/Models/LifecycleState.md new file mode 100644 index 000000000..06d5bb849 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LifecycleState.md @@ -0,0 +1,370 @@ +--- +id: v2024-lifecycle-state +title: LifecycleState +pagination_label: LifecycleState +sidebar_label: LifecycleState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LifecycleState', 'V2024LifecycleState'] +slug: /tools/sdk/go/v2024/models/lifecycle-state +tags: ['SDK', 'Software Development Kit', 'LifecycleState', 'V2024LifecycleState'] +--- + +# LifecycleState + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Enabled** | Pointer to **bool** | Indicates whether the lifecycle state is enabled or disabled. | [optional] [default to false] +**TechnicalName** | **string** | The lifecycle state's technical name. This is for internal use. | +**Description** | Pointer to **NullableString** | Lifecycle state's description. | [optional] +**IdentityCount** | Pointer to **int32** | Number of identities that have the lifecycle state. | [optional] [readonly] +**EmailNotificationOption** | Pointer to [**EmailNotificationOption**](email-notification-option) | | [optional] +**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] + +## Methods + +### NewLifecycleState + +`func NewLifecycleState(name NullableString, technicalName string, ) *LifecycleState` + +NewLifecycleState instantiates a new LifecycleState 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 + +### NewLifecycleStateWithDefaults + +`func NewLifecycleStateWithDefaults() *LifecycleState` + +NewLifecycleStateWithDefaults instantiates a new LifecycleState 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 + +### GetId + +`func (o *LifecycleState) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LifecycleState) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LifecycleState) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LifecycleState) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *LifecycleState) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LifecycleState) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *LifecycleState) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *LifecycleState) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *LifecycleState) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *LifecycleState) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LifecycleState) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *LifecycleState) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *LifecycleState) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *LifecycleState) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *LifecycleState) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *LifecycleState) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *LifecycleState) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetEnabled + +`func (o *LifecycleState) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *LifecycleState) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *LifecycleState) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *LifecycleState) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetTechnicalName + +`func (o *LifecycleState) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *LifecycleState) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *LifecycleState) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + + +### GetDescription + +`func (o *LifecycleState) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *LifecycleState) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *LifecycleState) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *LifecycleState) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *LifecycleState) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *LifecycleState) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetIdentityCount + +`func (o *LifecycleState) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *LifecycleState) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *LifecycleState) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *LifecycleState) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetEmailNotificationOption + +`func (o *LifecycleState) GetEmailNotificationOption() EmailNotificationOption` + +GetEmailNotificationOption returns the EmailNotificationOption field if non-nil, zero value otherwise. + +### GetEmailNotificationOptionOk + +`func (o *LifecycleState) GetEmailNotificationOptionOk() (*EmailNotificationOption, bool)` + +GetEmailNotificationOptionOk returns a tuple with the EmailNotificationOption field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationOption + +`func (o *LifecycleState) SetEmailNotificationOption(v EmailNotificationOption)` + +SetEmailNotificationOption sets EmailNotificationOption field to given value. + +### HasEmailNotificationOption + +`func (o *LifecycleState) HasEmailNotificationOption() bool` + +HasEmailNotificationOption returns a boolean if a field has been set. + +### GetAccountActions + +`func (o *LifecycleState) GetAccountActions() []AccountAction` + +GetAccountActions returns the AccountActions field if non-nil, zero value otherwise. + +### GetAccountActionsOk + +`func (o *LifecycleState) GetAccountActionsOk() (*[]AccountAction, bool)` + +GetAccountActionsOk returns a tuple with the AccountActions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActions + +`func (o *LifecycleState) SetAccountActions(v []AccountAction)` + +SetAccountActions sets AccountActions field to given value. + +### HasAccountActions + +`func (o *LifecycleState) HasAccountActions() bool` + +HasAccountActions returns a boolean if a field has been set. + +### GetAccessProfileIds + +`func (o *LifecycleState) GetAccessProfileIds() []string` + +GetAccessProfileIds returns the AccessProfileIds field if non-nil, zero value otherwise. + +### GetAccessProfileIdsOk + +`func (o *LifecycleState) GetAccessProfileIdsOk() (*[]string, bool)` + +GetAccessProfileIdsOk returns a tuple with the AccessProfileIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileIds + +`func (o *LifecycleState) SetAccessProfileIds(v []string)` + +SetAccessProfileIds sets AccessProfileIds field to given value. + +### HasAccessProfileIds + +`func (o *LifecycleState) HasAccessProfileIds() bool` + +HasAccessProfileIds returns a boolean if a field has been set. + +### GetIdentityState + +`func (o *LifecycleState) GetIdentityState() string` + +GetIdentityState returns the IdentityState field if non-nil, zero value otherwise. + +### GetIdentityStateOk + +`func (o *LifecycleState) GetIdentityStateOk() (*string, bool)` + +GetIdentityStateOk returns a tuple with the IdentityState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityState + +`func (o *LifecycleState) SetIdentityState(v string)` + +SetIdentityState sets IdentityState field to given value. + +### HasIdentityState + +`func (o *LifecycleState) HasIdentityState() bool` + +HasIdentityState returns a boolean if a field has been set. + +### SetIdentityStateNil + +`func (o *LifecycleState) SetIdentityStateNil(b bool)` + + SetIdentityStateNil sets the value for IdentityState to be an explicit nil + +### UnsetIdentityState +`func (o *LifecycleState) UnsetIdentityState()` + +UnsetIdentityState ensures that no value is present for IdentityState, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LifecycleStateDto.md b/docs/tools/sdk/go/Reference/V2024/Models/LifecycleStateDto.md new file mode 100644 index 000000000..4ace16a8b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LifecycleStateDto.md @@ -0,0 +1,80 @@ +--- +id: v2024-lifecycle-state-dto +title: LifecycleStateDto +pagination_label: LifecycleStateDto +sidebar_label: LifecycleStateDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LifecycleStateDto', 'V2024LifecycleStateDto'] +slug: /tools/sdk/go/v2024/models/lifecycle-state-dto +tags: ['SDK', 'Software Development Kit', 'LifecycleStateDto', 'V2024LifecycleStateDto'] +--- + +# LifecycleStateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**StateName** | **string** | The name of the lifecycle state | +**ManuallyUpdated** | **bool** | Whether the lifecycle state has been manually or automatically set | + +## Methods + +### NewLifecycleStateDto + +`func NewLifecycleStateDto(stateName string, manuallyUpdated bool, ) *LifecycleStateDto` + +NewLifecycleStateDto instantiates a new LifecycleStateDto 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 + +### NewLifecycleStateDtoWithDefaults + +`func NewLifecycleStateDtoWithDefaults() *LifecycleStateDto` + +NewLifecycleStateDtoWithDefaults instantiates a new LifecycleStateDto 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 + +### GetStateName + +`func (o *LifecycleStateDto) GetStateName() string` + +GetStateName returns the StateName field if non-nil, zero value otherwise. + +### GetStateNameOk + +`func (o *LifecycleStateDto) GetStateNameOk() (*string, bool)` + +GetStateNameOk returns a tuple with the StateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStateName + +`func (o *LifecycleStateDto) SetStateName(v string)` + +SetStateName sets StateName field to given value. + + +### GetManuallyUpdated + +`func (o *LifecycleStateDto) GetManuallyUpdated() bool` + +GetManuallyUpdated returns the ManuallyUpdated field if non-nil, zero value otherwise. + +### GetManuallyUpdatedOk + +`func (o *LifecycleStateDto) GetManuallyUpdatedOk() (*bool, bool)` + +GetManuallyUpdatedOk returns a tuple with the ManuallyUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyUpdated + +`func (o *LifecycleStateDto) SetManuallyUpdated(v bool)` + +SetManuallyUpdated sets ManuallyUpdated field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LifecyclestateDeleted.md b/docs/tools/sdk/go/Reference/V2024/Models/LifecyclestateDeleted.md new file mode 100644 index 000000000..5e1e86166 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LifecyclestateDeleted.md @@ -0,0 +1,116 @@ +--- +id: v2024-lifecyclestate-deleted +title: LifecyclestateDeleted +pagination_label: LifecyclestateDeleted +sidebar_label: LifecyclestateDeleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LifecyclestateDeleted', 'V2024LifecyclestateDeleted'] +slug: /tools/sdk/go/v2024/models/lifecyclestate-deleted +tags: ['SDK', 'Software Development Kit', 'LifecyclestateDeleted', 'V2024LifecyclestateDeleted'] +--- + +# LifecyclestateDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Deleted lifecycle state's DTO type. | [optional] +**Id** | Pointer to **string** | Deleted lifecycle state ID. | [optional] +**Name** | Pointer to **string** | Deleted lifecycle state's display name. | [optional] + +## Methods + +### NewLifecyclestateDeleted + +`func NewLifecyclestateDeleted() *LifecyclestateDeleted` + +NewLifecyclestateDeleted instantiates a new LifecyclestateDeleted 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 + +### NewLifecyclestateDeletedWithDefaults + +`func NewLifecyclestateDeletedWithDefaults() *LifecyclestateDeleted` + +NewLifecyclestateDeletedWithDefaults instantiates a new LifecyclestateDeleted 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 + +### GetType + +`func (o *LifecyclestateDeleted) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LifecyclestateDeleted) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LifecyclestateDeleted) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LifecyclestateDeleted) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *LifecyclestateDeleted) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LifecyclestateDeleted) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LifecyclestateDeleted) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LifecyclestateDeleted) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *LifecyclestateDeleted) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LifecyclestateDeleted) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *LifecyclestateDeleted) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *LifecyclestateDeleted) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ListAccessProfiles401Response.md b/docs/tools/sdk/go/Reference/V2024/Models/ListAccessProfiles401Response.md new file mode 100644 index 000000000..f900cb9c6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ListAccessProfiles401Response.md @@ -0,0 +1,64 @@ +--- +id: v2024-list-access-profiles401-response +title: ListAccessProfiles401Response +pagination_label: ListAccessProfiles401Response +sidebar_label: ListAccessProfiles401Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListAccessProfiles401Response', 'V2024ListAccessProfiles401Response'] +slug: /tools/sdk/go/v2024/models/list-access-profiles401-response +tags: ['SDK', 'Software Development Kit', 'ListAccessProfiles401Response', 'V2024ListAccessProfiles401Response'] +--- + +# ListAccessProfiles401Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Error** | Pointer to **map[string]interface{}** | A message describing the error | [optional] + +## Methods + +### NewListAccessProfiles401Response + +`func NewListAccessProfiles401Response() *ListAccessProfiles401Response` + +NewListAccessProfiles401Response instantiates a new ListAccessProfiles401Response 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 + +### NewListAccessProfiles401ResponseWithDefaults + +`func NewListAccessProfiles401ResponseWithDefaults() *ListAccessProfiles401Response` + +NewListAccessProfiles401ResponseWithDefaults instantiates a new ListAccessProfiles401Response 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 + +### GetError + +`func (o *ListAccessProfiles401Response) GetError() map[string]interface{}` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *ListAccessProfiles401Response) GetErrorOk() (*map[string]interface{}, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *ListAccessProfiles401Response) SetError(v map[string]interface{})` + +SetError sets Error field to given value. + +### HasError + +`func (o *ListAccessProfiles401Response) HasError() bool` + +HasError returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ListAccessProfiles429Response.md b/docs/tools/sdk/go/Reference/V2024/Models/ListAccessProfiles429Response.md new file mode 100644 index 000000000..981c05420 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ListAccessProfiles429Response.md @@ -0,0 +1,64 @@ +--- +id: v2024-list-access-profiles429-response +title: ListAccessProfiles429Response +pagination_label: ListAccessProfiles429Response +sidebar_label: ListAccessProfiles429Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListAccessProfiles429Response', 'V2024ListAccessProfiles429Response'] +slug: /tools/sdk/go/v2024/models/list-access-profiles429-response +tags: ['SDK', 'Software Development Kit', 'ListAccessProfiles429Response', 'V2024ListAccessProfiles429Response'] +--- + +# ListAccessProfiles429Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **map[string]interface{}** | A message describing the error | [optional] + +## Methods + +### NewListAccessProfiles429Response + +`func NewListAccessProfiles429Response() *ListAccessProfiles429Response` + +NewListAccessProfiles429Response instantiates a new ListAccessProfiles429Response 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 + +### NewListAccessProfiles429ResponseWithDefaults + +`func NewListAccessProfiles429ResponseWithDefaults() *ListAccessProfiles429Response` + +NewListAccessProfiles429ResponseWithDefaults instantiates a new ListAccessProfiles429Response 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 + +### GetMessage + +`func (o *ListAccessProfiles429Response) GetMessage() map[string]interface{}` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *ListAccessProfiles429Response) GetMessageOk() (*map[string]interface{}, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *ListAccessProfiles429Response) SetMessage(v map[string]interface{})` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *ListAccessProfiles429Response) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ListCampaignFilters200Response.md b/docs/tools/sdk/go/Reference/V2024/Models/ListCampaignFilters200Response.md new file mode 100644 index 000000000..c65e55deb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ListCampaignFilters200Response.md @@ -0,0 +1,90 @@ +--- +id: v2024-list-campaign-filters200-response +title: ListCampaignFilters200Response +pagination_label: ListCampaignFilters200Response +sidebar_label: ListCampaignFilters200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListCampaignFilters200Response', 'V2024ListCampaignFilters200Response'] +slug: /tools/sdk/go/v2024/models/list-campaign-filters200-response +tags: ['SDK', 'Software Development Kit', 'ListCampaignFilters200Response', 'V2024ListCampaignFilters200Response'] +--- + +# ListCampaignFilters200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Items** | Pointer to [**[]CampaignFilterDetails**](campaign-filter-details) | List of campaign filters. | [optional] +**Count** | Pointer to **int32** | Number of filters returned. | [optional] + +## Methods + +### NewListCampaignFilters200Response + +`func NewListCampaignFilters200Response() *ListCampaignFilters200Response` + +NewListCampaignFilters200Response instantiates a new ListCampaignFilters200Response 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 + +### NewListCampaignFilters200ResponseWithDefaults + +`func NewListCampaignFilters200ResponseWithDefaults() *ListCampaignFilters200Response` + +NewListCampaignFilters200ResponseWithDefaults instantiates a new ListCampaignFilters200Response 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 + +### GetItems + +`func (o *ListCampaignFilters200Response) GetItems() []CampaignFilterDetails` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *ListCampaignFilters200Response) GetItemsOk() (*[]CampaignFilterDetails, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *ListCampaignFilters200Response) SetItems(v []CampaignFilterDetails)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *ListCampaignFilters200Response) HasItems() bool` + +HasItems returns a boolean if a field has been set. + +### GetCount + +`func (o *ListCampaignFilters200Response) GetCount() int32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *ListCampaignFilters200Response) GetCountOk() (*int32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *ListCampaignFilters200Response) SetCount(v int32)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *ListCampaignFilters200Response) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ListCompleteWorkflowLibrary200ResponseInner.md b/docs/tools/sdk/go/Reference/V2024/Models/ListCompleteWorkflowLibrary200ResponseInner.md new file mode 100644 index 000000000..4a4cd7613 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ListCompleteWorkflowLibrary200ResponseInner.md @@ -0,0 +1,396 @@ +--- +id: v2024-list-complete-workflow-library200-response-inner +title: ListCompleteWorkflowLibrary200ResponseInner +pagination_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListCompleteWorkflowLibrary200ResponseInner', 'V2024ListCompleteWorkflowLibrary200ResponseInner'] +slug: /tools/sdk/go/v2024/models/list-complete-workflow-library200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListCompleteWorkflowLibrary200ResponseInner', 'V2024ListCompleteWorkflowLibrary200ResponseInner'] +--- + +# ListCompleteWorkflowLibrary200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Operator ID. | [optional] +**Name** | Pointer to **string** | Operator friendly name | [optional] +**Type** | Pointer to **string** | Operator type | [optional] +**Description** | Pointer to **string** | Description of the operator | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] +**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**Deprecated** | Pointer to **bool** | | [optional] +**DeprecatedBy** | Pointer to **SailPointTime** | | [optional] +**VersionNumber** | Pointer to **int32** | Version number | [optional] +**IsSimulationEnabled** | Pointer to **bool** | | [optional] +**IsDynamicSchema** | Pointer to **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**OutputSchema** | Pointer to **map[string]interface{}** | Example output schema | [optional] +**InputExample** | Pointer to **map[string]interface{}** | Example trigger payload if applicable | [optional] + +## Methods + +### NewListCompleteWorkflowLibrary200ResponseInner + +`func NewListCompleteWorkflowLibrary200ResponseInner() *ListCompleteWorkflowLibrary200ResponseInner` + +NewListCompleteWorkflowLibrary200ResponseInner instantiates a new ListCompleteWorkflowLibrary200ResponseInner 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 + +### NewListCompleteWorkflowLibrary200ResponseInnerWithDefaults + +`func NewListCompleteWorkflowLibrary200ResponseInnerWithDefaults() *ListCompleteWorkflowLibrary200ResponseInner` + +NewListCompleteWorkflowLibrary200ResponseInnerWithDefaults instantiates a new ListCompleteWorkflowLibrary200ResponseInner 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 + +### GetId + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDescription + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetFormFields + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetFormFields() []WorkflowLibraryFormFields` + +GetFormFields returns the FormFields field if non-nil, zero value otherwise. + +### GetFormFieldsOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetFormFieldsOk() (*[]WorkflowLibraryFormFields, bool)` + +GetFormFieldsOk returns a tuple with the FormFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormFields + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetFormFields(v []WorkflowLibraryFormFields)` + +SetFormFields sets FormFields field to given value. + +### HasFormFields + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasFormFields() bool` + +HasFormFields returns a boolean if a field has been set. + +### SetFormFieldsNil + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetFormFieldsNil(b bool)` + + SetFormFieldsNil sets the value for FormFields to be an explicit nil + +### UnsetFormFields +`func (o *ListCompleteWorkflowLibrary200ResponseInner) UnsetFormFields()` + +UnsetFormFields ensures that no value is present for FormFields, not even an explicit nil +### GetExampleOutput + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetExampleOutput() WorkflowLibraryActionExampleOutput` + +GetExampleOutput returns the ExampleOutput field if non-nil, zero value otherwise. + +### GetExampleOutputOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetExampleOutputOk() (*WorkflowLibraryActionExampleOutput, bool)` + +GetExampleOutputOk returns a tuple with the ExampleOutput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExampleOutput + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetExampleOutput(v WorkflowLibraryActionExampleOutput)` + +SetExampleOutput sets ExampleOutput field to given value. + +### HasExampleOutput + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasExampleOutput() bool` + +HasExampleOutput returns a boolean if a field has been set. + +### GetDeprecated + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDeprecated() bool` + +GetDeprecated returns the Deprecated field if non-nil, zero value otherwise. + +### GetDeprecatedOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDeprecatedOk() (*bool, bool)` + +GetDeprecatedOk returns a tuple with the Deprecated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecated + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetDeprecated(v bool)` + +SetDeprecated sets Deprecated field to given value. + +### HasDeprecated + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasDeprecated() bool` + +HasDeprecated returns a boolean if a field has been set. + +### GetDeprecatedBy + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDeprecatedBy() SailPointTime` + +GetDeprecatedBy returns the DeprecatedBy field if non-nil, zero value otherwise. + +### GetDeprecatedByOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDeprecatedByOk() (*SailPointTime, bool)` + +GetDeprecatedByOk returns a tuple with the DeprecatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecatedBy + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetDeprecatedBy(v SailPointTime)` + +SetDeprecatedBy sets DeprecatedBy field to given value. + +### HasDeprecatedBy + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasDeprecatedBy() bool` + +HasDeprecatedBy returns a boolean if a field has been set. + +### GetVersionNumber + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetVersionNumber() int32` + +GetVersionNumber returns the VersionNumber field if non-nil, zero value otherwise. + +### GetVersionNumberOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetVersionNumberOk() (*int32, bool)` + +GetVersionNumberOk returns a tuple with the VersionNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionNumber + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetVersionNumber(v int32)` + +SetVersionNumber sets VersionNumber field to given value. + +### HasVersionNumber + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasVersionNumber() bool` + +HasVersionNumber returns a boolean if a field has been set. + +### GetIsSimulationEnabled + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIsSimulationEnabled() bool` + +GetIsSimulationEnabled returns the IsSimulationEnabled field if non-nil, zero value otherwise. + +### GetIsSimulationEnabledOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIsSimulationEnabledOk() (*bool, bool)` + +GetIsSimulationEnabledOk returns a tuple with the IsSimulationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSimulationEnabled + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetIsSimulationEnabled(v bool)` + +SetIsSimulationEnabled sets IsSimulationEnabled field to given value. + +### HasIsSimulationEnabled + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasIsSimulationEnabled() bool` + +HasIsSimulationEnabled returns a boolean if a field has been set. + +### GetIsDynamicSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIsDynamicSchema() bool` + +GetIsDynamicSchema returns the IsDynamicSchema field if non-nil, zero value otherwise. + +### GetIsDynamicSchemaOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIsDynamicSchemaOk() (*bool, bool)` + +GetIsDynamicSchemaOk returns a tuple with the IsDynamicSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDynamicSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetIsDynamicSchema(v bool)` + +SetIsDynamicSchema sets IsDynamicSchema field to given value. + +### HasIsDynamicSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasIsDynamicSchema() bool` + +HasIsDynamicSchema returns a boolean if a field has been set. + +### GetOutputSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetOutputSchema() map[string]interface{}` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetOutputSchemaOk() (*map[string]interface{}, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetOutputSchema(v map[string]interface{})` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + +### GetInputExample + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetInputExample() map[string]interface{}` + +GetInputExample returns the InputExample field if non-nil, zero value otherwise. + +### GetInputExampleOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetInputExampleOk() (*map[string]interface{}, bool)` + +GetInputExampleOk returns a tuple with the InputExample field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInputExample + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetInputExample(v map[string]interface{})` + +SetInputExample sets InputExample field to given value. + +### HasInputExample + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasInputExample() bool` + +HasInputExample returns a boolean if a field has been set. + +### SetInputExampleNil + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetInputExampleNil(b bool)` + + SetInputExampleNil sets the value for InputExample to be an explicit nil + +### UnsetInputExample +`func (o *ListCompleteWorkflowLibrary200ResponseInner) UnsetInputExample()` + +UnsetInputExample ensures that no value is present for InputExample, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ListDeploys200Response.md b/docs/tools/sdk/go/Reference/V2024/Models/ListDeploys200Response.md new file mode 100644 index 000000000..6730c7c46 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ListDeploys200Response.md @@ -0,0 +1,64 @@ +--- +id: v2024-list-deploys200-response +title: ListDeploys200Response +pagination_label: ListDeploys200Response +sidebar_label: ListDeploys200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListDeploys200Response', 'V2024ListDeploys200Response'] +slug: /tools/sdk/go/v2024/models/list-deploys200-response +tags: ['SDK', 'Software Development Kit', 'ListDeploys200Response', 'V2024ListDeploys200Response'] +--- + +# ListDeploys200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Items** | Pointer to [**[]DeployResponse**](deploy-response) | list of deployments | [optional] + +## Methods + +### NewListDeploys200Response + +`func NewListDeploys200Response() *ListDeploys200Response` + +NewListDeploys200Response instantiates a new ListDeploys200Response 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 + +### NewListDeploys200ResponseWithDefaults + +`func NewListDeploys200ResponseWithDefaults() *ListDeploys200Response` + +NewListDeploys200ResponseWithDefaults instantiates a new ListDeploys200Response 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 + +### GetItems + +`func (o *ListDeploys200Response) GetItems() []DeployResponse` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *ListDeploys200Response) GetItemsOk() (*[]DeployResponse, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *ListDeploys200Response) SetItems(v []DeployResponse)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *ListDeploys200Response) HasItems() bool` + +HasItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ListFormDefinitionsByTenantResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ListFormDefinitionsByTenantResponse.md new file mode 100644 index 000000000..36f9a4386 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ListFormDefinitionsByTenantResponse.md @@ -0,0 +1,90 @@ +--- +id: v2024-list-form-definitions-by-tenant-response +title: ListFormDefinitionsByTenantResponse +pagination_label: ListFormDefinitionsByTenantResponse +sidebar_label: ListFormDefinitionsByTenantResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListFormDefinitionsByTenantResponse', 'V2024ListFormDefinitionsByTenantResponse'] +slug: /tools/sdk/go/v2024/models/list-form-definitions-by-tenant-response +tags: ['SDK', 'Software Development Kit', 'ListFormDefinitionsByTenantResponse', 'V2024ListFormDefinitionsByTenantResponse'] +--- + +# ListFormDefinitionsByTenantResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **int64** | Count number of results. | [optional] +**Results** | Pointer to [**[]FormDefinitionResponse**](form-definition-response) | List of FormDefinitionResponse items. | [optional] + +## Methods + +### NewListFormDefinitionsByTenantResponse + +`func NewListFormDefinitionsByTenantResponse() *ListFormDefinitionsByTenantResponse` + +NewListFormDefinitionsByTenantResponse instantiates a new ListFormDefinitionsByTenantResponse 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 + +### NewListFormDefinitionsByTenantResponseWithDefaults + +`func NewListFormDefinitionsByTenantResponseWithDefaults() *ListFormDefinitionsByTenantResponse` + +NewListFormDefinitionsByTenantResponseWithDefaults instantiates a new ListFormDefinitionsByTenantResponse 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 + +### GetCount + +`func (o *ListFormDefinitionsByTenantResponse) GetCount() int64` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *ListFormDefinitionsByTenantResponse) GetCountOk() (*int64, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *ListFormDefinitionsByTenantResponse) SetCount(v int64)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *ListFormDefinitionsByTenantResponse) HasCount() bool` + +HasCount returns a boolean if a field has been set. + +### GetResults + +`func (o *ListFormDefinitionsByTenantResponse) GetResults() []FormDefinitionResponse` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *ListFormDefinitionsByTenantResponse) GetResultsOk() (*[]FormDefinitionResponse, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *ListFormDefinitionsByTenantResponse) SetResults(v []FormDefinitionResponse)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *ListFormDefinitionsByTenantResponse) HasResults() bool` + +HasResults returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ListFormElementDataByElementIDResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ListFormElementDataByElementIDResponse.md new file mode 100644 index 000000000..1943a75ce --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ListFormElementDataByElementIDResponse.md @@ -0,0 +1,64 @@ +--- +id: v2024-list-form-element-data-by-element-id-response +title: ListFormElementDataByElementIDResponse +pagination_label: ListFormElementDataByElementIDResponse +sidebar_label: ListFormElementDataByElementIDResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListFormElementDataByElementIDResponse', 'V2024ListFormElementDataByElementIDResponse'] +slug: /tools/sdk/go/v2024/models/list-form-element-data-by-element-id-response +tags: ['SDK', 'Software Development Kit', 'ListFormElementDataByElementIDResponse', 'V2024ListFormElementDataByElementIDResponse'] +--- + +# ListFormElementDataByElementIDResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | Pointer to [**[]FormElementDataSourceConfigOptions**](form-element-data-source-config-options) | Results holds a list of FormElementDataSourceConfigOptions items | [optional] + +## Methods + +### NewListFormElementDataByElementIDResponse + +`func NewListFormElementDataByElementIDResponse() *ListFormElementDataByElementIDResponse` + +NewListFormElementDataByElementIDResponse instantiates a new ListFormElementDataByElementIDResponse 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 + +### NewListFormElementDataByElementIDResponseWithDefaults + +`func NewListFormElementDataByElementIDResponseWithDefaults() *ListFormElementDataByElementIDResponse` + +NewListFormElementDataByElementIDResponseWithDefaults instantiates a new ListFormElementDataByElementIDResponse 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 + +### GetResults + +`func (o *ListFormElementDataByElementIDResponse) GetResults() []FormElementDataSourceConfigOptions` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *ListFormElementDataByElementIDResponse) GetResultsOk() (*[]FormElementDataSourceConfigOptions, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *ListFormElementDataByElementIDResponse) SetResults(v []FormElementDataSourceConfigOptions)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *ListFormElementDataByElementIDResponse) HasResults() bool` + +HasResults returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ListFormInstancesByTenantResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ListFormInstancesByTenantResponse.md new file mode 100644 index 000000000..163baeb6a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ListFormInstancesByTenantResponse.md @@ -0,0 +1,90 @@ +--- +id: v2024-list-form-instances-by-tenant-response +title: ListFormInstancesByTenantResponse +pagination_label: ListFormInstancesByTenantResponse +sidebar_label: ListFormInstancesByTenantResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListFormInstancesByTenantResponse', 'V2024ListFormInstancesByTenantResponse'] +slug: /tools/sdk/go/v2024/models/list-form-instances-by-tenant-response +tags: ['SDK', 'Software Development Kit', 'ListFormInstancesByTenantResponse', 'V2024ListFormInstancesByTenantResponse'] +--- + +# ListFormInstancesByTenantResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **int64** | Count number of Results | [optional] +**Results** | Pointer to [**[]FormInstanceResponse**](form-instance-response) | Results holds a list of FormInstanceResponse items | [optional] + +## Methods + +### NewListFormInstancesByTenantResponse + +`func NewListFormInstancesByTenantResponse() *ListFormInstancesByTenantResponse` + +NewListFormInstancesByTenantResponse instantiates a new ListFormInstancesByTenantResponse 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 + +### NewListFormInstancesByTenantResponseWithDefaults + +`func NewListFormInstancesByTenantResponseWithDefaults() *ListFormInstancesByTenantResponse` + +NewListFormInstancesByTenantResponseWithDefaults instantiates a new ListFormInstancesByTenantResponse 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 + +### GetCount + +`func (o *ListFormInstancesByTenantResponse) GetCount() int64` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *ListFormInstancesByTenantResponse) GetCountOk() (*int64, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *ListFormInstancesByTenantResponse) SetCount(v int64)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *ListFormInstancesByTenantResponse) HasCount() bool` + +HasCount returns a boolean if a field has been set. + +### GetResults + +`func (o *ListFormInstancesByTenantResponse) GetResults() []FormInstanceResponse` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *ListFormInstancesByTenantResponse) GetResultsOk() (*[]FormInstanceResponse, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *ListFormInstancesByTenantResponse) SetResults(v []FormInstanceResponse)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *ListFormInstancesByTenantResponse) HasResults() bool` + +HasResults returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ListIdentityAccessItems200ResponseInner.md b/docs/tools/sdk/go/Reference/V2024/Models/ListIdentityAccessItems200ResponseInner.md new file mode 100644 index 000000000..4809d4bfa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ListIdentityAccessItems200ResponseInner.md @@ -0,0 +1,512 @@ +--- +id: v2024-list-identity-access-items200-response-inner +title: ListIdentityAccessItems200ResponseInner +pagination_label: ListIdentityAccessItems200ResponseInner +sidebar_label: ListIdentityAccessItems200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListIdentityAccessItems200ResponseInner', 'V2024ListIdentityAccessItems200ResponseInner'] +slug: /tools/sdk/go/v2024/models/list-identity-access-items200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListIdentityAccessItems200ResponseInner', 'V2024ListIdentityAccessItems200ResponseInner'] +--- + +# ListIdentityAccessItems200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. role in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**Name** | Pointer to **string** | the access profile name | [optional] +**SourceName** | Pointer to **string** | the associated source name if it exists | [optional] +**SourceId** | Pointer to **string** | the id of the source | [optional] +**Description** | Pointer to **string** | the description for the role | [optional] +**DisplayName** | Pointer to **string** | the role display name | [optional] +**EntitlementCount** | Pointer to **string** | the number of entitlements the account will create | [optional] +**AppDisplayName** | Pointer to **string** | the name of | [optional] +**RemoveDate** | Pointer to **string** | the date the role is no longer assigned to the specified identity | [optional] +**Standalone** | **bool** | indicates whether the entitlement is standalone | +**Revocable** | **bool** | indicates whether the role is revocable | +**NativeIdentity** | Pointer to **string** | the native identifier used to uniquely identify an acccount | [optional] +**AppRoleId** | Pointer to **string** | the app role id | [optional] +**Attribute** | Pointer to **string** | the entitlement attribute | [optional] +**Value** | Pointer to **string** | the associated value | [optional] +**EntitlementType** | Pointer to **string** | the type of entitlement | [optional] +**Privileged** | **bool** | indicates whether the entitlement is privileged | +**CloudGoverned** | **bool** | indicates whether the entitlement is cloud governed | + +## Methods + +### NewListIdentityAccessItems200ResponseInner + +`func NewListIdentityAccessItems200ResponseInner(standalone bool, revocable bool, privileged bool, cloudGoverned bool, ) *ListIdentityAccessItems200ResponseInner` + +NewListIdentityAccessItems200ResponseInner instantiates a new ListIdentityAccessItems200ResponseInner 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 + +### NewListIdentityAccessItems200ResponseInnerWithDefaults + +`func NewListIdentityAccessItems200ResponseInnerWithDefaults() *ListIdentityAccessItems200ResponseInner` + +NewListIdentityAccessItems200ResponseInnerWithDefaults instantiates a new ListIdentityAccessItems200ResponseInner 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 + +### GetAccessType + +`func (o *ListIdentityAccessItems200ResponseInner) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *ListIdentityAccessItems200ResponseInner) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *ListIdentityAccessItems200ResponseInner) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *ListIdentityAccessItems200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ListIdentityAccessItems200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ListIdentityAccessItems200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ListIdentityAccessItems200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ListIdentityAccessItems200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ListIdentityAccessItems200ResponseInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *ListIdentityAccessItems200ResponseInner) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *ListIdentityAccessItems200ResponseInner) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *ListIdentityAccessItems200ResponseInner) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *ListIdentityAccessItems200ResponseInner) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *ListIdentityAccessItems200ResponseInner) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *ListIdentityAccessItems200ResponseInner) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetDescription + +`func (o *ListIdentityAccessItems200ResponseInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ListIdentityAccessItems200ResponseInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ListIdentityAccessItems200ResponseInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *ListIdentityAccessItems200ResponseInner) GetEntitlementCount() string` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetEntitlementCountOk() (*string, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *ListIdentityAccessItems200ResponseInner) SetEntitlementCount(v string)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *ListIdentityAccessItems200ResponseInner) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetAppDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) GetAppDisplayName() string` + +GetAppDisplayName returns the AppDisplayName field if non-nil, zero value otherwise. + +### GetAppDisplayNameOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetAppDisplayNameOk() (*string, bool)` + +GetAppDisplayNameOk returns a tuple with the AppDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) SetAppDisplayName(v string)` + +SetAppDisplayName sets AppDisplayName field to given value. + +### HasAppDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) HasAppDisplayName() bool` + +HasAppDisplayName returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *ListIdentityAccessItems200ResponseInner) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *ListIdentityAccessItems200ResponseInner) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *ListIdentityAccessItems200ResponseInner) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetStandalone + +`func (o *ListIdentityAccessItems200ResponseInner) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *ListIdentityAccessItems200ResponseInner) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + + +### GetRevocable + +`func (o *ListIdentityAccessItems200ResponseInner) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *ListIdentityAccessItems200ResponseInner) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + + +### GetNativeIdentity + +`func (o *ListIdentityAccessItems200ResponseInner) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *ListIdentityAccessItems200ResponseInner) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *ListIdentityAccessItems200ResponseInner) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetAppRoleId + +`func (o *ListIdentityAccessItems200ResponseInner) GetAppRoleId() string` + +GetAppRoleId returns the AppRoleId field if non-nil, zero value otherwise. + +### GetAppRoleIdOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetAppRoleIdOk() (*string, bool)` + +GetAppRoleIdOk returns a tuple with the AppRoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppRoleId + +`func (o *ListIdentityAccessItems200ResponseInner) SetAppRoleId(v string)` + +SetAppRoleId sets AppRoleId field to given value. + +### HasAppRoleId + +`func (o *ListIdentityAccessItems200ResponseInner) HasAppRoleId() bool` + +HasAppRoleId returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ListIdentityAccessItems200ResponseInner) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ListIdentityAccessItems200ResponseInner) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ListIdentityAccessItems200ResponseInner) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *ListIdentityAccessItems200ResponseInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ListIdentityAccessItems200ResponseInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ListIdentityAccessItems200ResponseInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetEntitlementType + +`func (o *ListIdentityAccessItems200ResponseInner) GetEntitlementType() string` + +GetEntitlementType returns the EntitlementType field if non-nil, zero value otherwise. + +### GetEntitlementTypeOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetEntitlementTypeOk() (*string, bool)` + +GetEntitlementTypeOk returns a tuple with the EntitlementType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementType + +`func (o *ListIdentityAccessItems200ResponseInner) SetEntitlementType(v string)` + +SetEntitlementType sets EntitlementType field to given value. + +### HasEntitlementType + +`func (o *ListIdentityAccessItems200ResponseInner) HasEntitlementType() bool` + +HasEntitlementType returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *ListIdentityAccessItems200ResponseInner) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *ListIdentityAccessItems200ResponseInner) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + + +### GetCloudGoverned + +`func (o *ListIdentityAccessItems200ResponseInner) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *ListIdentityAccessItems200ResponseInner) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ListPredefinedSelectOptionsResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ListPredefinedSelectOptionsResponse.md new file mode 100644 index 000000000..0278d72ce --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ListPredefinedSelectOptionsResponse.md @@ -0,0 +1,64 @@ +--- +id: v2024-list-predefined-select-options-response +title: ListPredefinedSelectOptionsResponse +pagination_label: ListPredefinedSelectOptionsResponse +sidebar_label: ListPredefinedSelectOptionsResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListPredefinedSelectOptionsResponse', 'V2024ListPredefinedSelectOptionsResponse'] +slug: /tools/sdk/go/v2024/models/list-predefined-select-options-response +tags: ['SDK', 'Software Development Kit', 'ListPredefinedSelectOptionsResponse', 'V2024ListPredefinedSelectOptionsResponse'] +--- + +# ListPredefinedSelectOptionsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | Pointer to **[]string** | Results holds a list of PreDefinedSelectOption items | [optional] + +## Methods + +### NewListPredefinedSelectOptionsResponse + +`func NewListPredefinedSelectOptionsResponse() *ListPredefinedSelectOptionsResponse` + +NewListPredefinedSelectOptionsResponse instantiates a new ListPredefinedSelectOptionsResponse 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 + +### NewListPredefinedSelectOptionsResponseWithDefaults + +`func NewListPredefinedSelectOptionsResponseWithDefaults() *ListPredefinedSelectOptionsResponse` + +NewListPredefinedSelectOptionsResponseWithDefaults instantiates a new ListPredefinedSelectOptionsResponse 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 + +### GetResults + +`func (o *ListPredefinedSelectOptionsResponse) GetResults() []string` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *ListPredefinedSelectOptionsResponse) GetResultsOk() (*[]string, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *ListPredefinedSelectOptionsResponse) SetResults(v []string)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *ListPredefinedSelectOptionsResponse) HasResults() bool` + +HasResults returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ListWorkgroupMembers200ResponseInner.md b/docs/tools/sdk/go/Reference/V2024/Models/ListWorkgroupMembers200ResponseInner.md new file mode 100644 index 000000000..bbcf2b84f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ListWorkgroupMembers200ResponseInner.md @@ -0,0 +1,142 @@ +--- +id: v2024-list-workgroup-members200-response-inner +title: ListWorkgroupMembers200ResponseInner +pagination_label: ListWorkgroupMembers200ResponseInner +sidebar_label: ListWorkgroupMembers200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListWorkgroupMembers200ResponseInner', 'V2024ListWorkgroupMembers200ResponseInner'] +slug: /tools/sdk/go/v2024/models/list-workgroup-members200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListWorkgroupMembers200ResponseInner', 'V2024ListWorkgroupMembers200ResponseInner'] +--- + +# ListWorkgroupMembers200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Workgroup member identity DTO type. | [optional] +**Id** | Pointer to **string** | Workgroup member identity ID. | [optional] +**Name** | Pointer to **string** | Workgroup member identity display name. | [optional] +**Email** | Pointer to **string** | Workgroup member identity email. | [optional] + +## Methods + +### NewListWorkgroupMembers200ResponseInner + +`func NewListWorkgroupMembers200ResponseInner() *ListWorkgroupMembers200ResponseInner` + +NewListWorkgroupMembers200ResponseInner instantiates a new ListWorkgroupMembers200ResponseInner 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 + +### NewListWorkgroupMembers200ResponseInnerWithDefaults + +`func NewListWorkgroupMembers200ResponseInnerWithDefaults() *ListWorkgroupMembers200ResponseInner` + +NewListWorkgroupMembers200ResponseInnerWithDefaults instantiates a new ListWorkgroupMembers200ResponseInner 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 + +### GetType + +`func (o *ListWorkgroupMembers200ResponseInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ListWorkgroupMembers200ResponseInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ListWorkgroupMembers200ResponseInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ListWorkgroupMembers200ResponseInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ListWorkgroupMembers200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ListWorkgroupMembers200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ListWorkgroupMembers200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ListWorkgroupMembers200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ListWorkgroupMembers200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ListWorkgroupMembers200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ListWorkgroupMembers200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ListWorkgroupMembers200ResponseInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *ListWorkgroupMembers200ResponseInner) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *ListWorkgroupMembers200ResponseInner) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *ListWorkgroupMembers200ResponseInner) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *ListWorkgroupMembers200ResponseInner) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LoadAccountsTask.md b/docs/tools/sdk/go/Reference/V2024/Models/LoadAccountsTask.md new file mode 100644 index 000000000..df5f9b202 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LoadAccountsTask.md @@ -0,0 +1,90 @@ +--- +id: v2024-load-accounts-task +title: LoadAccountsTask +pagination_label: LoadAccountsTask +sidebar_label: LoadAccountsTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadAccountsTask', 'V2024LoadAccountsTask'] +slug: /tools/sdk/go/v2024/models/load-accounts-task +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTask', 'V2024LoadAccountsTask'] +--- + +# LoadAccountsTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Success** | Pointer to **bool** | The status of the result | [optional] [default to true] +**Task** | Pointer to [**LoadAccountsTaskTask**](load-accounts-task-task) | | [optional] + +## Methods + +### NewLoadAccountsTask + +`func NewLoadAccountsTask() *LoadAccountsTask` + +NewLoadAccountsTask instantiates a new LoadAccountsTask 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 + +### NewLoadAccountsTaskWithDefaults + +`func NewLoadAccountsTaskWithDefaults() *LoadAccountsTask` + +NewLoadAccountsTaskWithDefaults instantiates a new LoadAccountsTask 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 + +### GetSuccess + +`func (o *LoadAccountsTask) GetSuccess() bool` + +GetSuccess returns the Success field if non-nil, zero value otherwise. + +### GetSuccessOk + +`func (o *LoadAccountsTask) GetSuccessOk() (*bool, bool)` + +GetSuccessOk returns a tuple with the Success field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSuccess + +`func (o *LoadAccountsTask) SetSuccess(v bool)` + +SetSuccess sets Success field to given value. + +### HasSuccess + +`func (o *LoadAccountsTask) HasSuccess() bool` + +HasSuccess returns a boolean if a field has been set. + +### GetTask + +`func (o *LoadAccountsTask) GetTask() LoadAccountsTaskTask` + +GetTask returns the Task field if non-nil, zero value otherwise. + +### GetTaskOk + +`func (o *LoadAccountsTask) GetTaskOk() (*LoadAccountsTaskTask, bool)` + +GetTaskOk returns a tuple with the Task field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTask + +`func (o *LoadAccountsTask) SetTask(v LoadAccountsTaskTask)` + +SetTask sets Task field to given value. + +### HasTask + +`func (o *LoadAccountsTask) HasTask() bool` + +HasTask returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LoadAccountsTaskTask.md b/docs/tools/sdk/go/Reference/V2024/Models/LoadAccountsTaskTask.md new file mode 100644 index 000000000..34b5c6c70 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LoadAccountsTaskTask.md @@ -0,0 +1,452 @@ +--- +id: v2024-load-accounts-task-task +title: LoadAccountsTaskTask +pagination_label: LoadAccountsTaskTask +sidebar_label: LoadAccountsTaskTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadAccountsTaskTask', 'V2024LoadAccountsTaskTask'] +slug: /tools/sdk/go/v2024/models/load-accounts-task-task +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTask', 'V2024LoadAccountsTaskTask'] +--- + +# LoadAccountsTaskTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the task this taskStatus represents | [optional] +**Type** | Pointer to **string** | Type of task this task represents | [optional] +**Name** | Pointer to **string** | The name of the aggregation process | [optional] +**Description** | Pointer to **string** | The description of the task | [optional] +**Launcher** | Pointer to **string** | The user who initiated the task | [optional] +**Created** | Pointer to **SailPointTime** | The Task creation date | [optional] +**Launched** | Pointer to **NullableTime** | The task start date | [optional] +**Completed** | Pointer to **NullableTime** | The task completion date | [optional] +**CompletionStatus** | Pointer to **NullableString** | Task completion status. | [optional] +**ParentName** | Pointer to **NullableString** | Name of the parent task if exists. | [optional] +**Messages** | Pointer to [**[]LoadAccountsTaskTaskMessagesInner**](load-accounts-task-task-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**Progress** | Pointer to **NullableString** | Current task state. | [optional] +**Attributes** | Pointer to [**LoadAccountsTaskTaskAttributes**](load-accounts-task-task-attributes) | | [optional] +**Returns** | Pointer to [**[]LoadAccountsTaskTaskReturnsInner**](load-accounts-task-task-returns-inner) | Return values from the task | [optional] + +## Methods + +### NewLoadAccountsTaskTask + +`func NewLoadAccountsTaskTask() *LoadAccountsTaskTask` + +NewLoadAccountsTaskTask instantiates a new LoadAccountsTaskTask 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 + +### NewLoadAccountsTaskTaskWithDefaults + +`func NewLoadAccountsTaskTaskWithDefaults() *LoadAccountsTaskTask` + +NewLoadAccountsTaskTaskWithDefaults instantiates a new LoadAccountsTaskTask 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 + +### GetId + +`func (o *LoadAccountsTaskTask) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LoadAccountsTaskTask) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LoadAccountsTaskTask) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LoadAccountsTaskTask) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *LoadAccountsTaskTask) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LoadAccountsTaskTask) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LoadAccountsTaskTask) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LoadAccountsTaskTask) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *LoadAccountsTaskTask) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LoadAccountsTaskTask) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *LoadAccountsTaskTask) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *LoadAccountsTaskTask) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *LoadAccountsTaskTask) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *LoadAccountsTaskTask) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *LoadAccountsTaskTask) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *LoadAccountsTaskTask) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetLauncher + +`func (o *LoadAccountsTaskTask) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *LoadAccountsTaskTask) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *LoadAccountsTaskTask) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + +### HasLauncher + +`func (o *LoadAccountsTaskTask) HasLauncher() bool` + +HasLauncher returns a boolean if a field has been set. + +### GetCreated + +`func (o *LoadAccountsTaskTask) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LoadAccountsTaskTask) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *LoadAccountsTaskTask) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *LoadAccountsTaskTask) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetLaunched + +`func (o *LoadAccountsTaskTask) GetLaunched() SailPointTime` + +GetLaunched returns the Launched field if non-nil, zero value otherwise. + +### GetLaunchedOk + +`func (o *LoadAccountsTaskTask) GetLaunchedOk() (*SailPointTime, bool)` + +GetLaunchedOk returns a tuple with the Launched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunched + +`func (o *LoadAccountsTaskTask) SetLaunched(v SailPointTime)` + +SetLaunched sets Launched field to given value. + +### HasLaunched + +`func (o *LoadAccountsTaskTask) HasLaunched() bool` + +HasLaunched returns a boolean if a field has been set. + +### SetLaunchedNil + +`func (o *LoadAccountsTaskTask) SetLaunchedNil(b bool)` + + SetLaunchedNil sets the value for Launched to be an explicit nil + +### UnsetLaunched +`func (o *LoadAccountsTaskTask) UnsetLaunched()` + +UnsetLaunched ensures that no value is present for Launched, not even an explicit nil +### GetCompleted + +`func (o *LoadAccountsTaskTask) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *LoadAccountsTaskTask) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *LoadAccountsTaskTask) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *LoadAccountsTaskTask) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *LoadAccountsTaskTask) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *LoadAccountsTaskTask) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetCompletionStatus + +`func (o *LoadAccountsTaskTask) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *LoadAccountsTaskTask) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *LoadAccountsTaskTask) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *LoadAccountsTaskTask) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + +### SetCompletionStatusNil + +`func (o *LoadAccountsTaskTask) SetCompletionStatusNil(b bool)` + + SetCompletionStatusNil sets the value for CompletionStatus to be an explicit nil + +### UnsetCompletionStatus +`func (o *LoadAccountsTaskTask) UnsetCompletionStatus()` + +UnsetCompletionStatus ensures that no value is present for CompletionStatus, not even an explicit nil +### GetParentName + +`func (o *LoadAccountsTaskTask) GetParentName() string` + +GetParentName returns the ParentName field if non-nil, zero value otherwise. + +### GetParentNameOk + +`func (o *LoadAccountsTaskTask) GetParentNameOk() (*string, bool)` + +GetParentNameOk returns a tuple with the ParentName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentName + +`func (o *LoadAccountsTaskTask) SetParentName(v string)` + +SetParentName sets ParentName field to given value. + +### HasParentName + +`func (o *LoadAccountsTaskTask) HasParentName() bool` + +HasParentName returns a boolean if a field has been set. + +### SetParentNameNil + +`func (o *LoadAccountsTaskTask) SetParentNameNil(b bool)` + + SetParentNameNil sets the value for ParentName to be an explicit nil + +### UnsetParentName +`func (o *LoadAccountsTaskTask) UnsetParentName()` + +UnsetParentName ensures that no value is present for ParentName, not even an explicit nil +### GetMessages + +`func (o *LoadAccountsTaskTask) GetMessages() []LoadAccountsTaskTaskMessagesInner` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *LoadAccountsTaskTask) GetMessagesOk() (*[]LoadAccountsTaskTaskMessagesInner, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *LoadAccountsTaskTask) SetMessages(v []LoadAccountsTaskTaskMessagesInner)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *LoadAccountsTaskTask) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetProgress + +`func (o *LoadAccountsTaskTask) GetProgress() string` + +GetProgress returns the Progress field if non-nil, zero value otherwise. + +### GetProgressOk + +`func (o *LoadAccountsTaskTask) GetProgressOk() (*string, bool)` + +GetProgressOk returns a tuple with the Progress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProgress + +`func (o *LoadAccountsTaskTask) SetProgress(v string)` + +SetProgress sets Progress field to given value. + +### HasProgress + +`func (o *LoadAccountsTaskTask) HasProgress() bool` + +HasProgress returns a boolean if a field has been set. + +### SetProgressNil + +`func (o *LoadAccountsTaskTask) SetProgressNil(b bool)` + + SetProgressNil sets the value for Progress to be an explicit nil + +### UnsetProgress +`func (o *LoadAccountsTaskTask) UnsetProgress()` + +UnsetProgress ensures that no value is present for Progress, not even an explicit nil +### GetAttributes + +`func (o *LoadAccountsTaskTask) GetAttributes() LoadAccountsTaskTaskAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *LoadAccountsTaskTask) GetAttributesOk() (*LoadAccountsTaskTaskAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *LoadAccountsTaskTask) SetAttributes(v LoadAccountsTaskTaskAttributes)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *LoadAccountsTaskTask) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetReturns + +`func (o *LoadAccountsTaskTask) GetReturns() []LoadAccountsTaskTaskReturnsInner` + +GetReturns returns the Returns field if non-nil, zero value otherwise. + +### GetReturnsOk + +`func (o *LoadAccountsTaskTask) GetReturnsOk() (*[]LoadAccountsTaskTaskReturnsInner, bool)` + +GetReturnsOk returns a tuple with the Returns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReturns + +`func (o *LoadAccountsTaskTask) SetReturns(v []LoadAccountsTaskTaskReturnsInner)` + +SetReturns sets Returns field to given value. + +### HasReturns + +`func (o *LoadAccountsTaskTask) HasReturns() bool` + +HasReturns returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LoadAccountsTaskTaskAttributes.md b/docs/tools/sdk/go/Reference/V2024/Models/LoadAccountsTaskTaskAttributes.md new file mode 100644 index 000000000..9cc52ae19 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LoadAccountsTaskTaskAttributes.md @@ -0,0 +1,90 @@ +--- +id: v2024-load-accounts-task-task-attributes +title: LoadAccountsTaskTaskAttributes +pagination_label: LoadAccountsTaskTaskAttributes +sidebar_label: LoadAccountsTaskTaskAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadAccountsTaskTaskAttributes', 'V2024LoadAccountsTaskTaskAttributes'] +slug: /tools/sdk/go/v2024/models/load-accounts-task-task-attributes +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskAttributes', 'V2024LoadAccountsTaskTaskAttributes'] +--- + +# LoadAccountsTaskTaskAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AppId** | Pointer to **string** | The id of the source | [optional] +**OptimizedAggregation** | Pointer to **string** | The indicator if the aggregation process was enabled/disabled for the aggregation job | [optional] + +## Methods + +### NewLoadAccountsTaskTaskAttributes + +`func NewLoadAccountsTaskTaskAttributes() *LoadAccountsTaskTaskAttributes` + +NewLoadAccountsTaskTaskAttributes instantiates a new LoadAccountsTaskTaskAttributes 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 + +### NewLoadAccountsTaskTaskAttributesWithDefaults + +`func NewLoadAccountsTaskTaskAttributesWithDefaults() *LoadAccountsTaskTaskAttributes` + +NewLoadAccountsTaskTaskAttributesWithDefaults instantiates a new LoadAccountsTaskTaskAttributes 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 + +### GetAppId + +`func (o *LoadAccountsTaskTaskAttributes) GetAppId() string` + +GetAppId returns the AppId field if non-nil, zero value otherwise. + +### GetAppIdOk + +`func (o *LoadAccountsTaskTaskAttributes) GetAppIdOk() (*string, bool)` + +GetAppIdOk returns a tuple with the AppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppId + +`func (o *LoadAccountsTaskTaskAttributes) SetAppId(v string)` + +SetAppId sets AppId field to given value. + +### HasAppId + +`func (o *LoadAccountsTaskTaskAttributes) HasAppId() bool` + +HasAppId returns a boolean if a field has been set. + +### GetOptimizedAggregation + +`func (o *LoadAccountsTaskTaskAttributes) GetOptimizedAggregation() string` + +GetOptimizedAggregation returns the OptimizedAggregation field if non-nil, zero value otherwise. + +### GetOptimizedAggregationOk + +`func (o *LoadAccountsTaskTaskAttributes) GetOptimizedAggregationOk() (*string, bool)` + +GetOptimizedAggregationOk returns a tuple with the OptimizedAggregation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOptimizedAggregation + +`func (o *LoadAccountsTaskTaskAttributes) SetOptimizedAggregation(v string)` + +SetOptimizedAggregation sets OptimizedAggregation field to given value. + +### HasOptimizedAggregation + +`func (o *LoadAccountsTaskTaskAttributes) HasOptimizedAggregation() bool` + +HasOptimizedAggregation returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LoadAccountsTaskTaskMessagesInner.md b/docs/tools/sdk/go/Reference/V2024/Models/LoadAccountsTaskTaskMessagesInner.md new file mode 100644 index 000000000..067e330b5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LoadAccountsTaskTaskMessagesInner.md @@ -0,0 +1,168 @@ +--- +id: v2024-load-accounts-task-task-messages-inner +title: LoadAccountsTaskTaskMessagesInner +pagination_label: LoadAccountsTaskTaskMessagesInner +sidebar_label: LoadAccountsTaskTaskMessagesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadAccountsTaskTaskMessagesInner', 'V2024LoadAccountsTaskTaskMessagesInner'] +slug: /tools/sdk/go/v2024/models/load-accounts-task-task-messages-inner +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskMessagesInner', 'V2024LoadAccountsTaskTaskMessagesInner'] +--- + +# LoadAccountsTaskTaskMessagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the message. | [optional] +**Error** | Pointer to **bool** | Flag whether message is an error. | [optional] [default to false] +**Warning** | Pointer to **bool** | Flag whether message is a warning. | [optional] [default to false] +**Key** | Pointer to **string** | Message string identifier. | [optional] +**LocalizedText** | Pointer to **string** | Message context with the locale based language. | [optional] + +## Methods + +### NewLoadAccountsTaskTaskMessagesInner + +`func NewLoadAccountsTaskTaskMessagesInner() *LoadAccountsTaskTaskMessagesInner` + +NewLoadAccountsTaskTaskMessagesInner instantiates a new LoadAccountsTaskTaskMessagesInner 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 + +### NewLoadAccountsTaskTaskMessagesInnerWithDefaults + +`func NewLoadAccountsTaskTaskMessagesInnerWithDefaults() *LoadAccountsTaskTaskMessagesInner` + +NewLoadAccountsTaskTaskMessagesInnerWithDefaults instantiates a new LoadAccountsTaskTaskMessagesInner 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 + +### GetType + +`func (o *LoadAccountsTaskTaskMessagesInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LoadAccountsTaskTaskMessagesInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LoadAccountsTaskTaskMessagesInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LoadAccountsTaskTaskMessagesInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetError + +`func (o *LoadAccountsTaskTaskMessagesInner) GetError() bool` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *LoadAccountsTaskTaskMessagesInner) GetErrorOk() (*bool, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *LoadAccountsTaskTaskMessagesInner) SetError(v bool)` + +SetError sets Error field to given value. + +### HasError + +`func (o *LoadAccountsTaskTaskMessagesInner) HasError() bool` + +HasError returns a boolean if a field has been set. + +### GetWarning + +`func (o *LoadAccountsTaskTaskMessagesInner) GetWarning() bool` + +GetWarning returns the Warning field if non-nil, zero value otherwise. + +### GetWarningOk + +`func (o *LoadAccountsTaskTaskMessagesInner) GetWarningOk() (*bool, bool)` + +GetWarningOk returns a tuple with the Warning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarning + +`func (o *LoadAccountsTaskTaskMessagesInner) SetWarning(v bool)` + +SetWarning sets Warning field to given value. + +### HasWarning + +`func (o *LoadAccountsTaskTaskMessagesInner) HasWarning() bool` + +HasWarning returns a boolean if a field has been set. + +### GetKey + +`func (o *LoadAccountsTaskTaskMessagesInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *LoadAccountsTaskTaskMessagesInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *LoadAccountsTaskTaskMessagesInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *LoadAccountsTaskTaskMessagesInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetLocalizedText + +`func (o *LoadAccountsTaskTaskMessagesInner) GetLocalizedText() string` + +GetLocalizedText returns the LocalizedText field if non-nil, zero value otherwise. + +### GetLocalizedTextOk + +`func (o *LoadAccountsTaskTaskMessagesInner) GetLocalizedTextOk() (*string, bool)` + +GetLocalizedTextOk returns a tuple with the LocalizedText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizedText + +`func (o *LoadAccountsTaskTaskMessagesInner) SetLocalizedText(v string)` + +SetLocalizedText sets LocalizedText field to given value. + +### HasLocalizedText + +`func (o *LoadAccountsTaskTaskMessagesInner) HasLocalizedText() bool` + +HasLocalizedText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LoadAccountsTaskTaskReturnsInner.md b/docs/tools/sdk/go/Reference/V2024/Models/LoadAccountsTaskTaskReturnsInner.md new file mode 100644 index 000000000..d0733c8e0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LoadAccountsTaskTaskReturnsInner.md @@ -0,0 +1,90 @@ +--- +id: v2024-load-accounts-task-task-returns-inner +title: LoadAccountsTaskTaskReturnsInner +pagination_label: LoadAccountsTaskTaskReturnsInner +sidebar_label: LoadAccountsTaskTaskReturnsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadAccountsTaskTaskReturnsInner', 'V2024LoadAccountsTaskTaskReturnsInner'] +slug: /tools/sdk/go/v2024/models/load-accounts-task-task-returns-inner +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskReturnsInner', 'V2024LoadAccountsTaskTaskReturnsInner'] +--- + +# LoadAccountsTaskTaskReturnsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayLabel** | Pointer to **string** | The display label of the return value | [optional] +**AttributeName** | Pointer to **string** | The attribute name of the return value | [optional] + +## Methods + +### NewLoadAccountsTaskTaskReturnsInner + +`func NewLoadAccountsTaskTaskReturnsInner() *LoadAccountsTaskTaskReturnsInner` + +NewLoadAccountsTaskTaskReturnsInner instantiates a new LoadAccountsTaskTaskReturnsInner 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 + +### NewLoadAccountsTaskTaskReturnsInnerWithDefaults + +`func NewLoadAccountsTaskTaskReturnsInnerWithDefaults() *LoadAccountsTaskTaskReturnsInner` + +NewLoadAccountsTaskTaskReturnsInnerWithDefaults instantiates a new LoadAccountsTaskTaskReturnsInner 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 + +### GetDisplayLabel + +`func (o *LoadAccountsTaskTaskReturnsInner) GetDisplayLabel() string` + +GetDisplayLabel returns the DisplayLabel field if non-nil, zero value otherwise. + +### GetDisplayLabelOk + +`func (o *LoadAccountsTaskTaskReturnsInner) GetDisplayLabelOk() (*string, bool)` + +GetDisplayLabelOk returns a tuple with the DisplayLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayLabel + +`func (o *LoadAccountsTaskTaskReturnsInner) SetDisplayLabel(v string)` + +SetDisplayLabel sets DisplayLabel field to given value. + +### HasDisplayLabel + +`func (o *LoadAccountsTaskTaskReturnsInner) HasDisplayLabel() bool` + +HasDisplayLabel returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *LoadAccountsTaskTaskReturnsInner) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *LoadAccountsTaskTaskReturnsInner) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *LoadAccountsTaskTaskReturnsInner) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *LoadAccountsTaskTaskReturnsInner) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LoadEntitlementTask.md b/docs/tools/sdk/go/Reference/V2024/Models/LoadEntitlementTask.md new file mode 100644 index 000000000..eac5fd888 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LoadEntitlementTask.md @@ -0,0 +1,220 @@ +--- +id: v2024-load-entitlement-task +title: LoadEntitlementTask +pagination_label: LoadEntitlementTask +sidebar_label: LoadEntitlementTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadEntitlementTask', 'V2024LoadEntitlementTask'] +slug: /tools/sdk/go/v2024/models/load-entitlement-task +tags: ['SDK', 'Software Development Kit', 'LoadEntitlementTask', 'V2024LoadEntitlementTask'] +--- + +# LoadEntitlementTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the task this taskStatus represents | [optional] +**Type** | Pointer to **string** | Type of task this task represents | [optional] +**UniqueName** | Pointer to **string** | The name of the task | [optional] +**Description** | Pointer to **string** | The description of the task | [optional] +**Launcher** | Pointer to **string** | The user who initiated the task | [optional] +**Created** | Pointer to **SailPointTime** | The creation date of the task | [optional] +**Returns** | Pointer to [**[]LoadEntitlementTaskReturnsInner**](load-entitlement-task-returns-inner) | Return values from the task | [optional] + +## Methods + +### NewLoadEntitlementTask + +`func NewLoadEntitlementTask() *LoadEntitlementTask` + +NewLoadEntitlementTask instantiates a new LoadEntitlementTask 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 + +### NewLoadEntitlementTaskWithDefaults + +`func NewLoadEntitlementTaskWithDefaults() *LoadEntitlementTask` + +NewLoadEntitlementTaskWithDefaults instantiates a new LoadEntitlementTask 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 + +### GetId + +`func (o *LoadEntitlementTask) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LoadEntitlementTask) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LoadEntitlementTask) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LoadEntitlementTask) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *LoadEntitlementTask) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LoadEntitlementTask) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LoadEntitlementTask) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LoadEntitlementTask) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetUniqueName + +`func (o *LoadEntitlementTask) GetUniqueName() string` + +GetUniqueName returns the UniqueName field if non-nil, zero value otherwise. + +### GetUniqueNameOk + +`func (o *LoadEntitlementTask) GetUniqueNameOk() (*string, bool)` + +GetUniqueNameOk returns a tuple with the UniqueName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUniqueName + +`func (o *LoadEntitlementTask) SetUniqueName(v string)` + +SetUniqueName sets UniqueName field to given value. + +### HasUniqueName + +`func (o *LoadEntitlementTask) HasUniqueName() bool` + +HasUniqueName returns a boolean if a field has been set. + +### GetDescription + +`func (o *LoadEntitlementTask) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *LoadEntitlementTask) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *LoadEntitlementTask) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *LoadEntitlementTask) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetLauncher + +`func (o *LoadEntitlementTask) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *LoadEntitlementTask) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *LoadEntitlementTask) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + +### HasLauncher + +`func (o *LoadEntitlementTask) HasLauncher() bool` + +HasLauncher returns a boolean if a field has been set. + +### GetCreated + +`func (o *LoadEntitlementTask) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LoadEntitlementTask) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *LoadEntitlementTask) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *LoadEntitlementTask) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetReturns + +`func (o *LoadEntitlementTask) GetReturns() []LoadEntitlementTaskReturnsInner` + +GetReturns returns the Returns field if non-nil, zero value otherwise. + +### GetReturnsOk + +`func (o *LoadEntitlementTask) GetReturnsOk() (*[]LoadEntitlementTaskReturnsInner, bool)` + +GetReturnsOk returns a tuple with the Returns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReturns + +`func (o *LoadEntitlementTask) SetReturns(v []LoadEntitlementTaskReturnsInner)` + +SetReturns sets Returns field to given value. + +### HasReturns + +`func (o *LoadEntitlementTask) HasReturns() bool` + +HasReturns returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LoadEntitlementTaskReturnsInner.md b/docs/tools/sdk/go/Reference/V2024/Models/LoadEntitlementTaskReturnsInner.md new file mode 100644 index 000000000..67cf09a96 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LoadEntitlementTaskReturnsInner.md @@ -0,0 +1,90 @@ +--- +id: v2024-load-entitlement-task-returns-inner +title: LoadEntitlementTaskReturnsInner +pagination_label: LoadEntitlementTaskReturnsInner +sidebar_label: LoadEntitlementTaskReturnsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadEntitlementTaskReturnsInner', 'V2024LoadEntitlementTaskReturnsInner'] +slug: /tools/sdk/go/v2024/models/load-entitlement-task-returns-inner +tags: ['SDK', 'Software Development Kit', 'LoadEntitlementTaskReturnsInner', 'V2024LoadEntitlementTaskReturnsInner'] +--- + +# LoadEntitlementTaskReturnsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayLabel** | Pointer to **string** | The display label for the return value | [optional] +**AttributeName** | Pointer to **string** | The attribute name for the return value | [optional] + +## Methods + +### NewLoadEntitlementTaskReturnsInner + +`func NewLoadEntitlementTaskReturnsInner() *LoadEntitlementTaskReturnsInner` + +NewLoadEntitlementTaskReturnsInner instantiates a new LoadEntitlementTaskReturnsInner 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 + +### NewLoadEntitlementTaskReturnsInnerWithDefaults + +`func NewLoadEntitlementTaskReturnsInnerWithDefaults() *LoadEntitlementTaskReturnsInner` + +NewLoadEntitlementTaskReturnsInnerWithDefaults instantiates a new LoadEntitlementTaskReturnsInner 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 + +### GetDisplayLabel + +`func (o *LoadEntitlementTaskReturnsInner) GetDisplayLabel() string` + +GetDisplayLabel returns the DisplayLabel field if non-nil, zero value otherwise. + +### GetDisplayLabelOk + +`func (o *LoadEntitlementTaskReturnsInner) GetDisplayLabelOk() (*string, bool)` + +GetDisplayLabelOk returns a tuple with the DisplayLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayLabel + +`func (o *LoadEntitlementTaskReturnsInner) SetDisplayLabel(v string)` + +SetDisplayLabel sets DisplayLabel field to given value. + +### HasDisplayLabel + +`func (o *LoadEntitlementTaskReturnsInner) HasDisplayLabel() bool` + +HasDisplayLabel returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *LoadEntitlementTaskReturnsInner) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *LoadEntitlementTaskReturnsInner) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *LoadEntitlementTaskReturnsInner) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *LoadEntitlementTaskReturnsInner) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LoadUncorrelatedAccountsTask.md b/docs/tools/sdk/go/Reference/V2024/Models/LoadUncorrelatedAccountsTask.md new file mode 100644 index 000000000..5f8417241 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LoadUncorrelatedAccountsTask.md @@ -0,0 +1,90 @@ +--- +id: v2024-load-uncorrelated-accounts-task +title: LoadUncorrelatedAccountsTask +pagination_label: LoadUncorrelatedAccountsTask +sidebar_label: LoadUncorrelatedAccountsTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadUncorrelatedAccountsTask', 'V2024LoadUncorrelatedAccountsTask'] +slug: /tools/sdk/go/v2024/models/load-uncorrelated-accounts-task +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTask', 'V2024LoadUncorrelatedAccountsTask'] +--- + +# LoadUncorrelatedAccountsTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Success** | Pointer to **bool** | The status of the result | [optional] [default to true] +**Task** | Pointer to [**LoadUncorrelatedAccountsTaskTask**](load-uncorrelated-accounts-task-task) | | [optional] + +## Methods + +### NewLoadUncorrelatedAccountsTask + +`func NewLoadUncorrelatedAccountsTask() *LoadUncorrelatedAccountsTask` + +NewLoadUncorrelatedAccountsTask instantiates a new LoadUncorrelatedAccountsTask 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 + +### NewLoadUncorrelatedAccountsTaskWithDefaults + +`func NewLoadUncorrelatedAccountsTaskWithDefaults() *LoadUncorrelatedAccountsTask` + +NewLoadUncorrelatedAccountsTaskWithDefaults instantiates a new LoadUncorrelatedAccountsTask 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 + +### GetSuccess + +`func (o *LoadUncorrelatedAccountsTask) GetSuccess() bool` + +GetSuccess returns the Success field if non-nil, zero value otherwise. + +### GetSuccessOk + +`func (o *LoadUncorrelatedAccountsTask) GetSuccessOk() (*bool, bool)` + +GetSuccessOk returns a tuple with the Success field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSuccess + +`func (o *LoadUncorrelatedAccountsTask) SetSuccess(v bool)` + +SetSuccess sets Success field to given value. + +### HasSuccess + +`func (o *LoadUncorrelatedAccountsTask) HasSuccess() bool` + +HasSuccess returns a boolean if a field has been set. + +### GetTask + +`func (o *LoadUncorrelatedAccountsTask) GetTask() LoadUncorrelatedAccountsTaskTask` + +GetTask returns the Task field if non-nil, zero value otherwise. + +### GetTaskOk + +`func (o *LoadUncorrelatedAccountsTask) GetTaskOk() (*LoadUncorrelatedAccountsTaskTask, bool)` + +GetTaskOk returns a tuple with the Task field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTask + +`func (o *LoadUncorrelatedAccountsTask) SetTask(v LoadUncorrelatedAccountsTaskTask)` + +SetTask sets Task field to given value. + +### HasTask + +`func (o *LoadUncorrelatedAccountsTask) HasTask() bool` + +HasTask returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTask.md b/docs/tools/sdk/go/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTask.md new file mode 100644 index 000000000..20b3456e5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTask.md @@ -0,0 +1,452 @@ +--- +id: v2024-load-uncorrelated-accounts-task-task +title: LoadUncorrelatedAccountsTaskTask +pagination_label: LoadUncorrelatedAccountsTaskTask +sidebar_label: LoadUncorrelatedAccountsTaskTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadUncorrelatedAccountsTaskTask', 'V2024LoadUncorrelatedAccountsTaskTask'] +slug: /tools/sdk/go/v2024/models/load-uncorrelated-accounts-task-task +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTask', 'V2024LoadUncorrelatedAccountsTaskTask'] +--- + +# LoadUncorrelatedAccountsTaskTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the task this taskStatus represents | [optional] +**Type** | Pointer to **string** | Type of task this task represents | [optional] +**Name** | Pointer to **string** | The name of uncorrelated accounts process | [optional] +**Description** | Pointer to **string** | The description of the task | [optional] +**Launcher** | Pointer to **string** | The user who initiated the task | [optional] +**Created** | Pointer to **SailPointTime** | The Task creation date | [optional] +**Launched** | Pointer to **NullableTime** | The task start date | [optional] +**Completed** | Pointer to **NullableTime** | The task completion date | [optional] +**CompletionStatus** | Pointer to **NullableString** | Task completion status. | [optional] +**ParentName** | Pointer to **NullableString** | Name of the parent task if exists. | [optional] +**Messages** | Pointer to [**[]LoadUncorrelatedAccountsTaskTaskMessagesInner**](load-uncorrelated-accounts-task-task-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**Progress** | Pointer to **NullableString** | Current task state. | [optional] +**Attributes** | Pointer to [**LoadUncorrelatedAccountsTaskTaskAttributes**](load-uncorrelated-accounts-task-task-attributes) | | [optional] +**Returns** | Pointer to **map[string]interface{}** | Return values from the task | [optional] + +## Methods + +### NewLoadUncorrelatedAccountsTaskTask + +`func NewLoadUncorrelatedAccountsTaskTask() *LoadUncorrelatedAccountsTaskTask` + +NewLoadUncorrelatedAccountsTaskTask instantiates a new LoadUncorrelatedAccountsTaskTask 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 + +### NewLoadUncorrelatedAccountsTaskTaskWithDefaults + +`func NewLoadUncorrelatedAccountsTaskTaskWithDefaults() *LoadUncorrelatedAccountsTaskTask` + +NewLoadUncorrelatedAccountsTaskTaskWithDefaults instantiates a new LoadUncorrelatedAccountsTaskTask 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 + +### GetId + +`func (o *LoadUncorrelatedAccountsTaskTask) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LoadUncorrelatedAccountsTaskTask) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LoadUncorrelatedAccountsTaskTask) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *LoadUncorrelatedAccountsTaskTask) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LoadUncorrelatedAccountsTaskTask) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LoadUncorrelatedAccountsTaskTask) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *LoadUncorrelatedAccountsTaskTask) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *LoadUncorrelatedAccountsTaskTask) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *LoadUncorrelatedAccountsTaskTask) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *LoadUncorrelatedAccountsTaskTask) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *LoadUncorrelatedAccountsTaskTask) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *LoadUncorrelatedAccountsTaskTask) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetLauncher + +`func (o *LoadUncorrelatedAccountsTaskTask) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *LoadUncorrelatedAccountsTaskTask) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + +### HasLauncher + +`func (o *LoadUncorrelatedAccountsTaskTask) HasLauncher() bool` + +HasLauncher returns a boolean if a field has been set. + +### GetCreated + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *LoadUncorrelatedAccountsTaskTask) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *LoadUncorrelatedAccountsTaskTask) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetLaunched + +`func (o *LoadUncorrelatedAccountsTaskTask) GetLaunched() SailPointTime` + +GetLaunched returns the Launched field if non-nil, zero value otherwise. + +### GetLaunchedOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetLaunchedOk() (*SailPointTime, bool)` + +GetLaunchedOk returns a tuple with the Launched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunched + +`func (o *LoadUncorrelatedAccountsTaskTask) SetLaunched(v SailPointTime)` + +SetLaunched sets Launched field to given value. + +### HasLaunched + +`func (o *LoadUncorrelatedAccountsTaskTask) HasLaunched() bool` + +HasLaunched returns a boolean if a field has been set. + +### SetLaunchedNil + +`func (o *LoadUncorrelatedAccountsTaskTask) SetLaunchedNil(b bool)` + + SetLaunchedNil sets the value for Launched to be an explicit nil + +### UnsetLaunched +`func (o *LoadUncorrelatedAccountsTaskTask) UnsetLaunched()` + +UnsetLaunched ensures that no value is present for Launched, not even an explicit nil +### GetCompleted + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *LoadUncorrelatedAccountsTaskTask) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *LoadUncorrelatedAccountsTaskTask) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *LoadUncorrelatedAccountsTaskTask) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *LoadUncorrelatedAccountsTaskTask) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetCompletionStatus + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *LoadUncorrelatedAccountsTaskTask) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *LoadUncorrelatedAccountsTaskTask) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + +### SetCompletionStatusNil + +`func (o *LoadUncorrelatedAccountsTaskTask) SetCompletionStatusNil(b bool)` + + SetCompletionStatusNil sets the value for CompletionStatus to be an explicit nil + +### UnsetCompletionStatus +`func (o *LoadUncorrelatedAccountsTaskTask) UnsetCompletionStatus()` + +UnsetCompletionStatus ensures that no value is present for CompletionStatus, not even an explicit nil +### GetParentName + +`func (o *LoadUncorrelatedAccountsTaskTask) GetParentName() string` + +GetParentName returns the ParentName field if non-nil, zero value otherwise. + +### GetParentNameOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetParentNameOk() (*string, bool)` + +GetParentNameOk returns a tuple with the ParentName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentName + +`func (o *LoadUncorrelatedAccountsTaskTask) SetParentName(v string)` + +SetParentName sets ParentName field to given value. + +### HasParentName + +`func (o *LoadUncorrelatedAccountsTaskTask) HasParentName() bool` + +HasParentName returns a boolean if a field has been set. + +### SetParentNameNil + +`func (o *LoadUncorrelatedAccountsTaskTask) SetParentNameNil(b bool)` + + SetParentNameNil sets the value for ParentName to be an explicit nil + +### UnsetParentName +`func (o *LoadUncorrelatedAccountsTaskTask) UnsetParentName()` + +UnsetParentName ensures that no value is present for ParentName, not even an explicit nil +### GetMessages + +`func (o *LoadUncorrelatedAccountsTaskTask) GetMessages() []LoadUncorrelatedAccountsTaskTaskMessagesInner` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetMessagesOk() (*[]LoadUncorrelatedAccountsTaskTaskMessagesInner, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *LoadUncorrelatedAccountsTaskTask) SetMessages(v []LoadUncorrelatedAccountsTaskTaskMessagesInner)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *LoadUncorrelatedAccountsTaskTask) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetProgress + +`func (o *LoadUncorrelatedAccountsTaskTask) GetProgress() string` + +GetProgress returns the Progress field if non-nil, zero value otherwise. + +### GetProgressOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetProgressOk() (*string, bool)` + +GetProgressOk returns a tuple with the Progress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProgress + +`func (o *LoadUncorrelatedAccountsTaskTask) SetProgress(v string)` + +SetProgress sets Progress field to given value. + +### HasProgress + +`func (o *LoadUncorrelatedAccountsTaskTask) HasProgress() bool` + +HasProgress returns a boolean if a field has been set. + +### SetProgressNil + +`func (o *LoadUncorrelatedAccountsTaskTask) SetProgressNil(b bool)` + + SetProgressNil sets the value for Progress to be an explicit nil + +### UnsetProgress +`func (o *LoadUncorrelatedAccountsTaskTask) UnsetProgress()` + +UnsetProgress ensures that no value is present for Progress, not even an explicit nil +### GetAttributes + +`func (o *LoadUncorrelatedAccountsTaskTask) GetAttributes() LoadUncorrelatedAccountsTaskTaskAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetAttributesOk() (*LoadUncorrelatedAccountsTaskTaskAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *LoadUncorrelatedAccountsTaskTask) SetAttributes(v LoadUncorrelatedAccountsTaskTaskAttributes)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *LoadUncorrelatedAccountsTaskTask) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetReturns + +`func (o *LoadUncorrelatedAccountsTaskTask) GetReturns() map[string]interface{}` + +GetReturns returns the Returns field if non-nil, zero value otherwise. + +### GetReturnsOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetReturnsOk() (*map[string]interface{}, bool)` + +GetReturnsOk returns a tuple with the Returns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReturns + +`func (o *LoadUncorrelatedAccountsTaskTask) SetReturns(v map[string]interface{})` + +SetReturns sets Returns field to given value. + +### HasReturns + +`func (o *LoadUncorrelatedAccountsTaskTask) HasReturns() bool` + +HasReturns returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md b/docs/tools/sdk/go/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md new file mode 100644 index 000000000..f34e85c28 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md @@ -0,0 +1,90 @@ +--- +id: v2024-load-uncorrelated-accounts-task-task-attributes +title: LoadUncorrelatedAccountsTaskTaskAttributes +pagination_label: LoadUncorrelatedAccountsTaskTaskAttributes +sidebar_label: LoadUncorrelatedAccountsTaskTaskAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadUncorrelatedAccountsTaskTaskAttributes', 'V2024LoadUncorrelatedAccountsTaskTaskAttributes'] +slug: /tools/sdk/go/v2024/models/load-uncorrelated-accounts-task-task-attributes +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTaskAttributes', 'V2024LoadUncorrelatedAccountsTaskTaskAttributes'] +--- + +# LoadUncorrelatedAccountsTaskTaskAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**QpocJobId** | Pointer to **string** | The id of qpoc job | [optional] +**TaskStartDelay** | Pointer to **map[string]interface{}** | the task start delay value | [optional] + +## Methods + +### NewLoadUncorrelatedAccountsTaskTaskAttributes + +`func NewLoadUncorrelatedAccountsTaskTaskAttributes() *LoadUncorrelatedAccountsTaskTaskAttributes` + +NewLoadUncorrelatedAccountsTaskTaskAttributes instantiates a new LoadUncorrelatedAccountsTaskTaskAttributes 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 + +### NewLoadUncorrelatedAccountsTaskTaskAttributesWithDefaults + +`func NewLoadUncorrelatedAccountsTaskTaskAttributesWithDefaults() *LoadUncorrelatedAccountsTaskTaskAttributes` + +NewLoadUncorrelatedAccountsTaskTaskAttributesWithDefaults instantiates a new LoadUncorrelatedAccountsTaskTaskAttributes 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 + +### GetQpocJobId + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) GetQpocJobId() string` + +GetQpocJobId returns the QpocJobId field if non-nil, zero value otherwise. + +### GetQpocJobIdOk + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) GetQpocJobIdOk() (*string, bool)` + +GetQpocJobIdOk returns a tuple with the QpocJobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQpocJobId + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) SetQpocJobId(v string)` + +SetQpocJobId sets QpocJobId field to given value. + +### HasQpocJobId + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) HasQpocJobId() bool` + +HasQpocJobId returns a boolean if a field has been set. + +### GetTaskStartDelay + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) GetTaskStartDelay() map[string]interface{}` + +GetTaskStartDelay returns the TaskStartDelay field if non-nil, zero value otherwise. + +### GetTaskStartDelayOk + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) GetTaskStartDelayOk() (*map[string]interface{}, bool)` + +GetTaskStartDelayOk returns a tuple with the TaskStartDelay field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskStartDelay + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) SetTaskStartDelay(v map[string]interface{})` + +SetTaskStartDelay sets TaskStartDelay field to given value. + +### HasTaskStartDelay + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) HasTaskStartDelay() bool` + +HasTaskStartDelay returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md b/docs/tools/sdk/go/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md new file mode 100644 index 000000000..a630d86ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md @@ -0,0 +1,168 @@ +--- +id: v2024-load-uncorrelated-accounts-task-task-messages-inner +title: LoadUncorrelatedAccountsTaskTaskMessagesInner +pagination_label: LoadUncorrelatedAccountsTaskTaskMessagesInner +sidebar_label: LoadUncorrelatedAccountsTaskTaskMessagesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadUncorrelatedAccountsTaskTaskMessagesInner', 'V2024LoadUncorrelatedAccountsTaskTaskMessagesInner'] +slug: /tools/sdk/go/v2024/models/load-uncorrelated-accounts-task-task-messages-inner +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTaskMessagesInner', 'V2024LoadUncorrelatedAccountsTaskTaskMessagesInner'] +--- + +# LoadUncorrelatedAccountsTaskTaskMessagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the message. | [optional] +**Error** | Pointer to **bool** | Flag whether message is an error. | [optional] [default to false] +**Warning** | Pointer to **bool** | Flag whether message is a warning. | [optional] [default to false] +**Key** | Pointer to **string** | Message string identifier. | [optional] +**LocalizedText** | Pointer to **string** | Message context with the locale based language. | [optional] + +## Methods + +### NewLoadUncorrelatedAccountsTaskTaskMessagesInner + +`func NewLoadUncorrelatedAccountsTaskTaskMessagesInner() *LoadUncorrelatedAccountsTaskTaskMessagesInner` + +NewLoadUncorrelatedAccountsTaskTaskMessagesInner instantiates a new LoadUncorrelatedAccountsTaskTaskMessagesInner 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 + +### NewLoadUncorrelatedAccountsTaskTaskMessagesInnerWithDefaults + +`func NewLoadUncorrelatedAccountsTaskTaskMessagesInnerWithDefaults() *LoadUncorrelatedAccountsTaskTaskMessagesInner` + +NewLoadUncorrelatedAccountsTaskTaskMessagesInnerWithDefaults instantiates a new LoadUncorrelatedAccountsTaskTaskMessagesInner 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 + +### GetType + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetError + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetError() bool` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetErrorOk() (*bool, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) SetError(v bool)` + +SetError sets Error field to given value. + +### HasError + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) HasError() bool` + +HasError returns a boolean if a field has been set. + +### GetWarning + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetWarning() bool` + +GetWarning returns the Warning field if non-nil, zero value otherwise. + +### GetWarningOk + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetWarningOk() (*bool, bool)` + +GetWarningOk returns a tuple with the Warning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarning + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) SetWarning(v bool)` + +SetWarning sets Warning field to given value. + +### HasWarning + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) HasWarning() bool` + +HasWarning returns a boolean if a field has been set. + +### GetKey + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetLocalizedText + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetLocalizedText() string` + +GetLocalizedText returns the LocalizedText field if non-nil, zero value otherwise. + +### GetLocalizedTextOk + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetLocalizedTextOk() (*string, bool)` + +GetLocalizedTextOk returns a tuple with the LocalizedText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizedText + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) SetLocalizedText(v string)` + +SetLocalizedText sets LocalizedText field to given value. + +### HasLocalizedText + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) HasLocalizedText() bool` + +HasLocalizedText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LocaleOrigin.md b/docs/tools/sdk/go/Reference/V2024/Models/LocaleOrigin.md new file mode 100644 index 000000000..e22c08e00 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LocaleOrigin.md @@ -0,0 +1,21 @@ +--- +id: v2024-locale-origin +title: LocaleOrigin +pagination_label: LocaleOrigin +sidebar_label: LocaleOrigin +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LocaleOrigin', 'V2024LocaleOrigin'] +slug: /tools/sdk/go/v2024/models/locale-origin +tags: ['SDK', 'Software Development Kit', 'LocaleOrigin', 'V2024LocaleOrigin'] +--- + +# LocaleOrigin + +## Enum + + +* `DEFAULT` (value: `"DEFAULT"`) + +* `REQUEST` (value: `"REQUEST"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LocalizedMessage.md b/docs/tools/sdk/go/Reference/V2024/Models/LocalizedMessage.md new file mode 100644 index 000000000..405fa0815 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LocalizedMessage.md @@ -0,0 +1,80 @@ +--- +id: v2024-localized-message +title: LocalizedMessage +pagination_label: LocalizedMessage +sidebar_label: LocalizedMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LocalizedMessage', 'V2024LocalizedMessage'] +slug: /tools/sdk/go/v2024/models/localized-message +tags: ['SDK', 'Software Development Kit', 'LocalizedMessage', 'V2024LocalizedMessage'] +--- + +# LocalizedMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | **string** | Message locale | +**Message** | **string** | Message text | + +## Methods + +### NewLocalizedMessage + +`func NewLocalizedMessage(locale string, message string, ) *LocalizedMessage` + +NewLocalizedMessage instantiates a new LocalizedMessage 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 + +### NewLocalizedMessageWithDefaults + +`func NewLocalizedMessageWithDefaults() *LocalizedMessage` + +NewLocalizedMessageWithDefaults instantiates a new LocalizedMessage 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 + +### GetLocale + +`func (o *LocalizedMessage) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *LocalizedMessage) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *LocalizedMessage) SetLocale(v string)` + +SetLocale sets Locale field to given value. + + +### GetMessage + +`func (o *LocalizedMessage) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *LocalizedMessage) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *LocalizedMessage) SetMessage(v string)` + +SetMessage sets Message field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LockoutConfiguration.md b/docs/tools/sdk/go/Reference/V2024/Models/LockoutConfiguration.md new file mode 100644 index 000000000..b4235f88f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LockoutConfiguration.md @@ -0,0 +1,116 @@ +--- +id: v2024-lockout-configuration +title: LockoutConfiguration +pagination_label: LockoutConfiguration +sidebar_label: LockoutConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LockoutConfiguration', 'V2024LockoutConfiguration'] +slug: /tools/sdk/go/v2024/models/lockout-configuration +tags: ['SDK', 'Software Development Kit', 'LockoutConfiguration', 'V2024LockoutConfiguration'] +--- + +# LockoutConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaximumAttempts** | Pointer to **int32** | The maximum attempts allowed before lockout occurs. | [optional] +**LockoutDuration** | Pointer to **int32** | The total time in minutes a user will be locked out. | [optional] +**LockoutWindow** | Pointer to **int32** | A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. | [optional] + +## Methods + +### NewLockoutConfiguration + +`func NewLockoutConfiguration() *LockoutConfiguration` + +NewLockoutConfiguration instantiates a new LockoutConfiguration 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 + +### NewLockoutConfigurationWithDefaults + +`func NewLockoutConfigurationWithDefaults() *LockoutConfiguration` + +NewLockoutConfigurationWithDefaults instantiates a new LockoutConfiguration 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 + +### GetMaximumAttempts + +`func (o *LockoutConfiguration) GetMaximumAttempts() int32` + +GetMaximumAttempts returns the MaximumAttempts field if non-nil, zero value otherwise. + +### GetMaximumAttemptsOk + +`func (o *LockoutConfiguration) GetMaximumAttemptsOk() (*int32, bool)` + +GetMaximumAttemptsOk returns a tuple with the MaximumAttempts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaximumAttempts + +`func (o *LockoutConfiguration) SetMaximumAttempts(v int32)` + +SetMaximumAttempts sets MaximumAttempts field to given value. + +### HasMaximumAttempts + +`func (o *LockoutConfiguration) HasMaximumAttempts() bool` + +HasMaximumAttempts returns a boolean if a field has been set. + +### GetLockoutDuration + +`func (o *LockoutConfiguration) GetLockoutDuration() int32` + +GetLockoutDuration returns the LockoutDuration field if non-nil, zero value otherwise. + +### GetLockoutDurationOk + +`func (o *LockoutConfiguration) GetLockoutDurationOk() (*int32, bool)` + +GetLockoutDurationOk returns a tuple with the LockoutDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLockoutDuration + +`func (o *LockoutConfiguration) SetLockoutDuration(v int32)` + +SetLockoutDuration sets LockoutDuration field to given value. + +### HasLockoutDuration + +`func (o *LockoutConfiguration) HasLockoutDuration() bool` + +HasLockoutDuration returns a boolean if a field has been set. + +### GetLockoutWindow + +`func (o *LockoutConfiguration) GetLockoutWindow() int32` + +GetLockoutWindow returns the LockoutWindow field if non-nil, zero value otherwise. + +### GetLockoutWindowOk + +`func (o *LockoutConfiguration) GetLockoutWindowOk() (*int32, bool)` + +GetLockoutWindowOk returns a tuple with the LockoutWindow field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLockoutWindow + +`func (o *LockoutConfiguration) SetLockoutWindow(v int32)` + +SetLockoutWindow sets LockoutWindow field to given value. + +### HasLockoutWindow + +`func (o *LockoutConfiguration) HasLockoutWindow() bool` + +HasLockoutWindow returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/LookupStep.md b/docs/tools/sdk/go/Reference/V2024/Models/LookupStep.md new file mode 100644 index 000000000..90a27e1a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/LookupStep.md @@ -0,0 +1,116 @@ +--- +id: v2024-lookup-step +title: LookupStep +pagination_label: LookupStep +sidebar_label: LookupStep +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LookupStep', 'V2024LookupStep'] +slug: /tools/sdk/go/v2024/models/lookup-step +tags: ['SDK', 'Software Development Kit', 'LookupStep', 'V2024LookupStep'] +--- + +# LookupStep + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReassignedToId** | Pointer to **string** | The ID of the Identity who work is reassigned to | [optional] +**ReassignedFromId** | Pointer to **string** | The ID of the Identity who work is reassigned from | [optional] +**ReassignmentType** | Pointer to [**ReassignmentTypeEnum**](reassignment-type-enum) | | [optional] + +## Methods + +### NewLookupStep + +`func NewLookupStep() *LookupStep` + +NewLookupStep instantiates a new LookupStep 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 + +### NewLookupStepWithDefaults + +`func NewLookupStepWithDefaults() *LookupStep` + +NewLookupStepWithDefaults instantiates a new LookupStep 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 + +### GetReassignedToId + +`func (o *LookupStep) GetReassignedToId() string` + +GetReassignedToId returns the ReassignedToId field if non-nil, zero value otherwise. + +### GetReassignedToIdOk + +`func (o *LookupStep) GetReassignedToIdOk() (*string, bool)` + +GetReassignedToIdOk returns a tuple with the ReassignedToId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignedToId + +`func (o *LookupStep) SetReassignedToId(v string)` + +SetReassignedToId sets ReassignedToId field to given value. + +### HasReassignedToId + +`func (o *LookupStep) HasReassignedToId() bool` + +HasReassignedToId returns a boolean if a field has been set. + +### GetReassignedFromId + +`func (o *LookupStep) GetReassignedFromId() string` + +GetReassignedFromId returns the ReassignedFromId field if non-nil, zero value otherwise. + +### GetReassignedFromIdOk + +`func (o *LookupStep) GetReassignedFromIdOk() (*string, bool)` + +GetReassignedFromIdOk returns a tuple with the ReassignedFromId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignedFromId + +`func (o *LookupStep) SetReassignedFromId(v string)` + +SetReassignedFromId sets ReassignedFromId field to given value. + +### HasReassignedFromId + +`func (o *LookupStep) HasReassignedFromId() bool` + +HasReassignedFromId returns a boolean if a field has been set. + +### GetReassignmentType + +`func (o *LookupStep) GetReassignmentType() ReassignmentTypeEnum` + +GetReassignmentType returns the ReassignmentType field if non-nil, zero value otherwise. + +### GetReassignmentTypeOk + +`func (o *LookupStep) GetReassignmentTypeOk() (*ReassignmentTypeEnum, bool)` + +GetReassignmentTypeOk returns a tuple with the ReassignmentType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignmentType + +`func (o *LookupStep) SetReassignmentType(v ReassignmentTypeEnum)` + +SetReassignmentType sets ReassignmentType field to given value. + +### HasReassignmentType + +`func (o *LookupStep) HasReassignmentType() bool` + +HasReassignmentType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MachineAccount.md b/docs/tools/sdk/go/Reference/V2024/Models/MachineAccount.md new file mode 100644 index 000000000..751c1a3b3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MachineAccount.md @@ -0,0 +1,619 @@ +--- +id: v2024-machine-account +title: MachineAccount +pagination_label: MachineAccount +sidebar_label: MachineAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MachineAccount', 'V2024MachineAccount'] +slug: /tools/sdk/go/v2024/models/machine-account +tags: ['SDK', 'Software Development Kit', 'MachineAccount', 'V2024MachineAccount'] +--- + +# MachineAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Description** | Pointer to **NullableString** | A description of the machine account | [optional] +**NativeIdentity** | **string** | The unique ID of the machine account generated by the source system | +**Uuid** | Pointer to **NullableString** | The unique ID of the account as determined by the account schema | [optional] +**ClassificationMethod** | **string** | Classification Method | +**MachineIdentity** | Pointer to **map[string]interface{}** | The machine identity this account is associated with | [optional] +**OwnerIdentity** | Pointer to **map[string]interface{}** | The identity who owns this account. | [optional] +**AccessType** | Pointer to **string** | The connection type of the source this account is from | [optional] +**Subtype** | Pointer to **NullableString** | The sub-type | [optional] +**Environment** | Pointer to **NullableString** | Environment | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Custom attributes specific to the machine account | [optional] +**ConnectorAttributes** | **map[string]interface{}** | The connector attributes for the account | +**ManuallyCorrelated** | Pointer to **bool** | Indicates if the account has been manually correlated to an identity | [optional] [default to false] +**ManuallyEdited** | **bool** | Indicates if the account has been manually edited | [default to false] +**Locked** | **bool** | Indicates if the account is currently locked | +**Enabled** | **bool** | Indicates if the account is enabled | [default to false] +**HasEntitlements** | **bool** | Indicates if the account has entitlements | [default to true] +**Source** | **map[string]interface{}** | The source this machine account belongs to. | + +## Methods + +### NewMachineAccount + +`func NewMachineAccount(name NullableString, nativeIdentity string, classificationMethod string, connectorAttributes map[string]interface{}, manuallyEdited bool, locked bool, enabled bool, hasEntitlements bool, source map[string]interface{}, ) *MachineAccount` + +NewMachineAccount instantiates a new MachineAccount 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 + +### NewMachineAccountWithDefaults + +`func NewMachineAccountWithDefaults() *MachineAccount` + +NewMachineAccountWithDefaults instantiates a new MachineAccount 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 + +### GetId + +`func (o *MachineAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MachineAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MachineAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *MachineAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *MachineAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MachineAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MachineAccount) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *MachineAccount) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *MachineAccount) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *MachineAccount) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MachineAccount) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MachineAccount) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MachineAccount) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MachineAccount) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MachineAccount) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MachineAccount) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MachineAccount) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *MachineAccount) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *MachineAccount) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *MachineAccount) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *MachineAccount) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *MachineAccount) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *MachineAccount) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetNativeIdentity + +`func (o *MachineAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *MachineAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *MachineAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + + +### GetUuid + +`func (o *MachineAccount) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *MachineAccount) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *MachineAccount) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *MachineAccount) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *MachineAccount) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *MachineAccount) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetClassificationMethod + +`func (o *MachineAccount) GetClassificationMethod() string` + +GetClassificationMethod returns the ClassificationMethod field if non-nil, zero value otherwise. + +### GetClassificationMethodOk + +`func (o *MachineAccount) GetClassificationMethodOk() (*string, bool)` + +GetClassificationMethodOk returns a tuple with the ClassificationMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClassificationMethod + +`func (o *MachineAccount) SetClassificationMethod(v string)` + +SetClassificationMethod sets ClassificationMethod field to given value. + + +### GetMachineIdentity + +`func (o *MachineAccount) GetMachineIdentity() map[string]interface{}` + +GetMachineIdentity returns the MachineIdentity field if non-nil, zero value otherwise. + +### GetMachineIdentityOk + +`func (o *MachineAccount) GetMachineIdentityOk() (*map[string]interface{}, bool)` + +GetMachineIdentityOk returns a tuple with the MachineIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMachineIdentity + +`func (o *MachineAccount) SetMachineIdentity(v map[string]interface{})` + +SetMachineIdentity sets MachineIdentity field to given value. + +### HasMachineIdentity + +`func (o *MachineAccount) HasMachineIdentity() bool` + +HasMachineIdentity returns a boolean if a field has been set. + +### GetOwnerIdentity + +`func (o *MachineAccount) GetOwnerIdentity() map[string]interface{}` + +GetOwnerIdentity returns the OwnerIdentity field if non-nil, zero value otherwise. + +### GetOwnerIdentityOk + +`func (o *MachineAccount) GetOwnerIdentityOk() (*map[string]interface{}, bool)` + +GetOwnerIdentityOk returns a tuple with the OwnerIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerIdentity + +`func (o *MachineAccount) SetOwnerIdentity(v map[string]interface{})` + +SetOwnerIdentity sets OwnerIdentity field to given value. + +### HasOwnerIdentity + +`func (o *MachineAccount) HasOwnerIdentity() bool` + +HasOwnerIdentity returns a boolean if a field has been set. + +### SetOwnerIdentityNil + +`func (o *MachineAccount) SetOwnerIdentityNil(b bool)` + + SetOwnerIdentityNil sets the value for OwnerIdentity to be an explicit nil + +### UnsetOwnerIdentity +`func (o *MachineAccount) UnsetOwnerIdentity()` + +UnsetOwnerIdentity ensures that no value is present for OwnerIdentity, not even an explicit nil +### GetAccessType + +`func (o *MachineAccount) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *MachineAccount) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *MachineAccount) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *MachineAccount) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetSubtype + +`func (o *MachineAccount) GetSubtype() string` + +GetSubtype returns the Subtype field if non-nil, zero value otherwise. + +### GetSubtypeOk + +`func (o *MachineAccount) GetSubtypeOk() (*string, bool)` + +GetSubtypeOk returns a tuple with the Subtype field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubtype + +`func (o *MachineAccount) SetSubtype(v string)` + +SetSubtype sets Subtype field to given value. + +### HasSubtype + +`func (o *MachineAccount) HasSubtype() bool` + +HasSubtype returns a boolean if a field has been set. + +### SetSubtypeNil + +`func (o *MachineAccount) SetSubtypeNil(b bool)` + + SetSubtypeNil sets the value for Subtype to be an explicit nil + +### UnsetSubtype +`func (o *MachineAccount) UnsetSubtype()` + +UnsetSubtype ensures that no value is present for Subtype, not even an explicit nil +### GetEnvironment + +`func (o *MachineAccount) GetEnvironment() string` + +GetEnvironment returns the Environment field if non-nil, zero value otherwise. + +### GetEnvironmentOk + +`func (o *MachineAccount) GetEnvironmentOk() (*string, bool)` + +GetEnvironmentOk returns a tuple with the Environment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnvironment + +`func (o *MachineAccount) SetEnvironment(v string)` + +SetEnvironment sets Environment field to given value. + +### HasEnvironment + +`func (o *MachineAccount) HasEnvironment() bool` + +HasEnvironment returns a boolean if a field has been set. + +### SetEnvironmentNil + +`func (o *MachineAccount) SetEnvironmentNil(b bool)` + + SetEnvironmentNil sets the value for Environment to be an explicit nil + +### UnsetEnvironment +`func (o *MachineAccount) UnsetEnvironment()` + +UnsetEnvironment ensures that no value is present for Environment, not even an explicit nil +### GetAttributes + +`func (o *MachineAccount) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *MachineAccount) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *MachineAccount) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *MachineAccount) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *MachineAccount) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *MachineAccount) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetConnectorAttributes + +`func (o *MachineAccount) GetConnectorAttributes() map[string]interface{}` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *MachineAccount) GetConnectorAttributesOk() (*map[string]interface{}, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *MachineAccount) SetConnectorAttributes(v map[string]interface{})` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + + +### SetConnectorAttributesNil + +`func (o *MachineAccount) SetConnectorAttributesNil(b bool)` + + SetConnectorAttributesNil sets the value for ConnectorAttributes to be an explicit nil + +### UnsetConnectorAttributes +`func (o *MachineAccount) UnsetConnectorAttributes()` + +UnsetConnectorAttributes ensures that no value is present for ConnectorAttributes, not even an explicit nil +### GetManuallyCorrelated + +`func (o *MachineAccount) GetManuallyCorrelated() bool` + +GetManuallyCorrelated returns the ManuallyCorrelated field if non-nil, zero value otherwise. + +### GetManuallyCorrelatedOk + +`func (o *MachineAccount) GetManuallyCorrelatedOk() (*bool, bool)` + +GetManuallyCorrelatedOk returns a tuple with the ManuallyCorrelated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyCorrelated + +`func (o *MachineAccount) SetManuallyCorrelated(v bool)` + +SetManuallyCorrelated sets ManuallyCorrelated field to given value. + +### HasManuallyCorrelated + +`func (o *MachineAccount) HasManuallyCorrelated() bool` + +HasManuallyCorrelated returns a boolean if a field has been set. + +### GetManuallyEdited + +`func (o *MachineAccount) GetManuallyEdited() bool` + +GetManuallyEdited returns the ManuallyEdited field if non-nil, zero value otherwise. + +### GetManuallyEditedOk + +`func (o *MachineAccount) GetManuallyEditedOk() (*bool, bool)` + +GetManuallyEditedOk returns a tuple with the ManuallyEdited field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyEdited + +`func (o *MachineAccount) SetManuallyEdited(v bool)` + +SetManuallyEdited sets ManuallyEdited field to given value. + + +### GetLocked + +`func (o *MachineAccount) GetLocked() bool` + +GetLocked returns the Locked field if non-nil, zero value otherwise. + +### GetLockedOk + +`func (o *MachineAccount) GetLockedOk() (*bool, bool)` + +GetLockedOk returns a tuple with the Locked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocked + +`func (o *MachineAccount) SetLocked(v bool)` + +SetLocked sets Locked field to given value. + + +### GetEnabled + +`func (o *MachineAccount) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *MachineAccount) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *MachineAccount) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetHasEntitlements + +`func (o *MachineAccount) GetHasEntitlements() bool` + +GetHasEntitlements returns the HasEntitlements field if non-nil, zero value otherwise. + +### GetHasEntitlementsOk + +`func (o *MachineAccount) GetHasEntitlementsOk() (*bool, bool)` + +GetHasEntitlementsOk returns a tuple with the HasEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasEntitlements + +`func (o *MachineAccount) SetHasEntitlements(v bool)` + +SetHasEntitlements sets HasEntitlements field to given value. + + +### GetSource + +`func (o *MachineAccount) GetSource() map[string]interface{}` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *MachineAccount) GetSourceOk() (*map[string]interface{}, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *MachineAccount) SetSource(v map[string]interface{})` + +SetSource sets Source field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MachineClassificationConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/MachineClassificationConfig.md new file mode 100644 index 000000000..61e376e5d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MachineClassificationConfig.md @@ -0,0 +1,188 @@ +--- +id: v2024-machine-classification-config +title: MachineClassificationConfig +pagination_label: MachineClassificationConfig +sidebar_label: MachineClassificationConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MachineClassificationConfig', 'V2024MachineClassificationConfig'] +slug: /tools/sdk/go/v2024/models/machine-classification-config +tags: ['SDK', 'Software Development Kit', 'MachineClassificationConfig', 'V2024MachineClassificationConfig'] +--- + +# MachineClassificationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | Indicates if the Classification is enabled for a Source | [optional] [default to false] +**ClassificationMethod** | Pointer to **string** | Classification Method | [optional] +**Criteria** | Pointer to **NullableString** | A classification criteria object | [optional] +**Created** | Pointer to **SailPointTime** | Time when the config was created | [optional] +**Modified** | Pointer to **NullableTime** | Time when the config was last updated | [optional] + +## Methods + +### NewMachineClassificationConfig + +`func NewMachineClassificationConfig() *MachineClassificationConfig` + +NewMachineClassificationConfig instantiates a new MachineClassificationConfig 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 + +### NewMachineClassificationConfigWithDefaults + +`func NewMachineClassificationConfigWithDefaults() *MachineClassificationConfig` + +NewMachineClassificationConfigWithDefaults instantiates a new MachineClassificationConfig 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 + +### GetEnabled + +`func (o *MachineClassificationConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *MachineClassificationConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *MachineClassificationConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *MachineClassificationConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetClassificationMethod + +`func (o *MachineClassificationConfig) GetClassificationMethod() string` + +GetClassificationMethod returns the ClassificationMethod field if non-nil, zero value otherwise. + +### GetClassificationMethodOk + +`func (o *MachineClassificationConfig) GetClassificationMethodOk() (*string, bool)` + +GetClassificationMethodOk returns a tuple with the ClassificationMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClassificationMethod + +`func (o *MachineClassificationConfig) SetClassificationMethod(v string)` + +SetClassificationMethod sets ClassificationMethod field to given value. + +### HasClassificationMethod + +`func (o *MachineClassificationConfig) HasClassificationMethod() bool` + +HasClassificationMethod returns a boolean if a field has been set. + +### GetCriteria + +`func (o *MachineClassificationConfig) GetCriteria() string` + +GetCriteria returns the Criteria field if non-nil, zero value otherwise. + +### GetCriteriaOk + +`func (o *MachineClassificationConfig) GetCriteriaOk() (*string, bool)` + +GetCriteriaOk returns a tuple with the Criteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteria + +`func (o *MachineClassificationConfig) SetCriteria(v string)` + +SetCriteria sets Criteria field to given value. + +### HasCriteria + +`func (o *MachineClassificationConfig) HasCriteria() bool` + +HasCriteria returns a boolean if a field has been set. + +### SetCriteriaNil + +`func (o *MachineClassificationConfig) SetCriteriaNil(b bool)` + + SetCriteriaNil sets the value for Criteria to be an explicit nil + +### UnsetCriteria +`func (o *MachineClassificationConfig) UnsetCriteria()` + +UnsetCriteria ensures that no value is present for Criteria, not even an explicit nil +### GetCreated + +`func (o *MachineClassificationConfig) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MachineClassificationConfig) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MachineClassificationConfig) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MachineClassificationConfig) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MachineClassificationConfig) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MachineClassificationConfig) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MachineClassificationConfig) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MachineClassificationConfig) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *MachineClassificationConfig) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *MachineClassificationConfig) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MachineIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/MachineIdentity.md new file mode 100644 index 000000000..6e96370f5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MachineIdentity.md @@ -0,0 +1,246 @@ +--- +id: v2024-machine-identity +title: MachineIdentity +pagination_label: MachineIdentity +sidebar_label: MachineIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MachineIdentity', 'V2024MachineIdentity'] +slug: /tools/sdk/go/v2024/models/machine-identity +tags: ['SDK', 'Software Development Kit', 'MachineIdentity', 'V2024MachineIdentity'] +--- + +# MachineIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**BusinessApplication** | **string** | The business application that the identity represents | +**Description** | Pointer to **string** | Description of machine identity | [optional] +**ManuallyEdited** | Pointer to **bool** | Indicates if the machine identity has been manually edited | [optional] [default to false] +**Attributes** | Pointer to **map[string]interface{}** | A map of custom machine identity attributes | [optional] + +## Methods + +### NewMachineIdentity + +`func NewMachineIdentity(name NullableString, businessApplication string, ) *MachineIdentity` + +NewMachineIdentity instantiates a new MachineIdentity 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 + +### NewMachineIdentityWithDefaults + +`func NewMachineIdentityWithDefaults() *MachineIdentity` + +NewMachineIdentityWithDefaults instantiates a new MachineIdentity 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 + +### GetId + +`func (o *MachineIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MachineIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MachineIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *MachineIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *MachineIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MachineIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MachineIdentity) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *MachineIdentity) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *MachineIdentity) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *MachineIdentity) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MachineIdentity) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MachineIdentity) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MachineIdentity) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MachineIdentity) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MachineIdentity) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MachineIdentity) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MachineIdentity) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetBusinessApplication + +`func (o *MachineIdentity) GetBusinessApplication() string` + +GetBusinessApplication returns the BusinessApplication field if non-nil, zero value otherwise. + +### GetBusinessApplicationOk + +`func (o *MachineIdentity) GetBusinessApplicationOk() (*string, bool)` + +GetBusinessApplicationOk returns a tuple with the BusinessApplication field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBusinessApplication + +`func (o *MachineIdentity) SetBusinessApplication(v string)` + +SetBusinessApplication sets BusinessApplication field to given value. + + +### GetDescription + +`func (o *MachineIdentity) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *MachineIdentity) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *MachineIdentity) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *MachineIdentity) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetManuallyEdited + +`func (o *MachineIdentity) GetManuallyEdited() bool` + +GetManuallyEdited returns the ManuallyEdited field if non-nil, zero value otherwise. + +### GetManuallyEditedOk + +`func (o *MachineIdentity) GetManuallyEditedOk() (*bool, bool)` + +GetManuallyEditedOk returns a tuple with the ManuallyEdited field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyEdited + +`func (o *MachineIdentity) SetManuallyEdited(v bool)` + +SetManuallyEdited sets ManuallyEdited field to given value. + +### HasManuallyEdited + +`func (o *MachineIdentity) HasManuallyEdited() bool` + +HasManuallyEdited returns a boolean if a field has been set. + +### GetAttributes + +`func (o *MachineIdentity) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *MachineIdentity) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *MachineIdentity) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *MachineIdentity) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MailFromAttributes.md b/docs/tools/sdk/go/Reference/V2024/Models/MailFromAttributes.md new file mode 100644 index 000000000..f7ee316de --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MailFromAttributes.md @@ -0,0 +1,168 @@ +--- +id: v2024-mail-from-attributes +title: MailFromAttributes +pagination_label: MailFromAttributes +sidebar_label: MailFromAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MailFromAttributes', 'V2024MailFromAttributes'] +slug: /tools/sdk/go/v2024/models/mail-from-attributes +tags: ['SDK', 'Software Development Kit', 'MailFromAttributes', 'V2024MailFromAttributes'] +--- + +# MailFromAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to **string** | The email identity | [optional] +**MailFromDomain** | Pointer to **string** | The name of a domain that an email identity uses as a custom MAIL FROM domain | [optional] +**MxRecord** | Pointer to **string** | MX record that is required in customer's DNS to allow the domain to receive bounce and complaint notifications that email providers send you | [optional] +**TxtRecord** | Pointer to **string** | TXT record that is required in customer's DNS in order to prove that Amazon SES is authorized to send email from your domain | [optional] +**MailFromDomainStatus** | Pointer to **string** | The current status of the MAIL FROM verification | [optional] + +## Methods + +### NewMailFromAttributes + +`func NewMailFromAttributes() *MailFromAttributes` + +NewMailFromAttributes instantiates a new MailFromAttributes 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 + +### NewMailFromAttributesWithDefaults + +`func NewMailFromAttributesWithDefaults() *MailFromAttributes` + +NewMailFromAttributesWithDefaults instantiates a new MailFromAttributes 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 + +### GetIdentity + +`func (o *MailFromAttributes) GetIdentity() string` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *MailFromAttributes) GetIdentityOk() (*string, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *MailFromAttributes) SetIdentity(v string)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *MailFromAttributes) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetMailFromDomain + +`func (o *MailFromAttributes) GetMailFromDomain() string` + +GetMailFromDomain returns the MailFromDomain field if non-nil, zero value otherwise. + +### GetMailFromDomainOk + +`func (o *MailFromAttributes) GetMailFromDomainOk() (*string, bool)` + +GetMailFromDomainOk returns a tuple with the MailFromDomain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMailFromDomain + +`func (o *MailFromAttributes) SetMailFromDomain(v string)` + +SetMailFromDomain sets MailFromDomain field to given value. + +### HasMailFromDomain + +`func (o *MailFromAttributes) HasMailFromDomain() bool` + +HasMailFromDomain returns a boolean if a field has been set. + +### GetMxRecord + +`func (o *MailFromAttributes) GetMxRecord() string` + +GetMxRecord returns the MxRecord field if non-nil, zero value otherwise. + +### GetMxRecordOk + +`func (o *MailFromAttributes) GetMxRecordOk() (*string, bool)` + +GetMxRecordOk returns a tuple with the MxRecord field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMxRecord + +`func (o *MailFromAttributes) SetMxRecord(v string)` + +SetMxRecord sets MxRecord field to given value. + +### HasMxRecord + +`func (o *MailFromAttributes) HasMxRecord() bool` + +HasMxRecord returns a boolean if a field has been set. + +### GetTxtRecord + +`func (o *MailFromAttributes) GetTxtRecord() string` + +GetTxtRecord returns the TxtRecord field if non-nil, zero value otherwise. + +### GetTxtRecordOk + +`func (o *MailFromAttributes) GetTxtRecordOk() (*string, bool)` + +GetTxtRecordOk returns a tuple with the TxtRecord field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTxtRecord + +`func (o *MailFromAttributes) SetTxtRecord(v string)` + +SetTxtRecord sets TxtRecord field to given value. + +### HasTxtRecord + +`func (o *MailFromAttributes) HasTxtRecord() bool` + +HasTxtRecord returns a boolean if a field has been set. + +### GetMailFromDomainStatus + +`func (o *MailFromAttributes) GetMailFromDomainStatus() string` + +GetMailFromDomainStatus returns the MailFromDomainStatus field if non-nil, zero value otherwise. + +### GetMailFromDomainStatusOk + +`func (o *MailFromAttributes) GetMailFromDomainStatusOk() (*string, bool)` + +GetMailFromDomainStatusOk returns a tuple with the MailFromDomainStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMailFromDomainStatus + +`func (o *MailFromAttributes) SetMailFromDomainStatus(v string)` + +SetMailFromDomainStatus sets MailFromDomainStatus field to given value. + +### HasMailFromDomainStatus + +`func (o *MailFromAttributes) HasMailFromDomainStatus() bool` + +HasMailFromDomainStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MailFromAttributesDto.md b/docs/tools/sdk/go/Reference/V2024/Models/MailFromAttributesDto.md new file mode 100644 index 000000000..f399b250a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MailFromAttributesDto.md @@ -0,0 +1,90 @@ +--- +id: v2024-mail-from-attributes-dto +title: MailFromAttributesDto +pagination_label: MailFromAttributesDto +sidebar_label: MailFromAttributesDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MailFromAttributesDto', 'V2024MailFromAttributesDto'] +slug: /tools/sdk/go/v2024/models/mail-from-attributes-dto +tags: ['SDK', 'Software Development Kit', 'MailFromAttributesDto', 'V2024MailFromAttributesDto'] +--- + +# MailFromAttributesDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to **string** | The identity or domain address | [optional] +**MailFromDomain** | Pointer to **string** | The new MAIL FROM domain of the identity. Must be a subdomain of the identity. | [optional] + +## Methods + +### NewMailFromAttributesDto + +`func NewMailFromAttributesDto() *MailFromAttributesDto` + +NewMailFromAttributesDto instantiates a new MailFromAttributesDto 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 + +### NewMailFromAttributesDtoWithDefaults + +`func NewMailFromAttributesDtoWithDefaults() *MailFromAttributesDto` + +NewMailFromAttributesDtoWithDefaults instantiates a new MailFromAttributesDto 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 + +### GetIdentity + +`func (o *MailFromAttributesDto) GetIdentity() string` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *MailFromAttributesDto) GetIdentityOk() (*string, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *MailFromAttributesDto) SetIdentity(v string)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *MailFromAttributesDto) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetMailFromDomain + +`func (o *MailFromAttributesDto) GetMailFromDomain() string` + +GetMailFromDomain returns the MailFromDomain field if non-nil, zero value otherwise. + +### GetMailFromDomainOk + +`func (o *MailFromAttributesDto) GetMailFromDomainOk() (*string, bool)` + +GetMailFromDomainOk returns a tuple with the MailFromDomain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMailFromDomain + +`func (o *MailFromAttributesDto) SetMailFromDomain(v string)` + +SetMailFromDomain sets MailFromDomain field to given value. + +### HasMailFromDomain + +`func (o *MailFromAttributesDto) HasMailFromDomain() bool` + +HasMailFromDomain returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManagedClient.md b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClient.md new file mode 100644 index 000000000..97824f6a4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClient.md @@ -0,0 +1,770 @@ +--- +id: v2024-managed-client +title: ManagedClient +pagination_label: ManagedClient +sidebar_label: ManagedClient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClient', 'V2024ManagedClient'] +slug: /tools/sdk/go/v2024/models/managed-client +tags: ['SDK', 'Software Development Kit', 'ManagedClient', 'V2024ManagedClient'] +--- + +# ManagedClient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | ManagedClient ID | [optional] [readonly] +**AlertKey** | Pointer to **NullableString** | ManagedClient alert key | [optional] [readonly] +**ApiGatewayBaseUrl** | Pointer to **NullableString** | apiGatewayBaseUrl for the Managed client | [optional] +**Cookbook** | Pointer to **NullableString** | cookbook id for the Managed client | [optional] +**CcId** | Pointer to **NullableInt64** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] +**ClientId** | **string** | The client ID used in API management | +**ClusterId** | **string** | Cluster ID that the ManagedClient is linked to | +**Description** | **string** | ManagedClient description | [default to ""] +**IpAddress** | Pointer to **NullableString** | The public IP address of the ManagedClient | [optional] [readonly] +**LastSeen** | Pointer to **NullableTime** | When the ManagedClient was last seen by the server | [optional] [readonly] +**Name** | Pointer to **NullableString** | ManagedClient name | [optional] [default to "VA-$clientId"] +**SinceLastSeen** | Pointer to **NullableString** | Milliseconds since the ManagedClient has polled the server | [optional] [readonly] +**Status** | Pointer to **NullableString** | Status of the ManagedClient | [optional] [readonly] +**Type** | **string** | Type of the ManagedClient (VA, CCG) | +**ClusterType** | Pointer to **NullableString** | Cluster Type of the ManagedClient | [optional] [readonly] +**VaDownloadUrl** | Pointer to **NullableString** | ManagedClient VA download URL | [optional] [readonly] +**VaVersion** | Pointer to **NullableString** | Version that the ManagedClient's VA is running | [optional] [readonly] +**Secret** | Pointer to **NullableString** | Client's apiKey | [optional] +**CreatedAt** | Pointer to **NullableTime** | The date/time this ManagedClient was created | [optional] +**UpdatedAt** | Pointer to **NullableTime** | The date/time this ManagedClient was last updated | [optional] +**ProvisionStatus** | Pointer to **NullableString** | The provisioning status of the ManagedClient | [optional] [readonly] +**HealthIndicators** | Pointer to **map[string]interface{}** | The health indicators of the ManagedClient | [optional] + +## Methods + +### NewManagedClient + +`func NewManagedClient(clientId string, clusterId string, description string, type_ string, ) *ManagedClient` + +NewManagedClient instantiates a new ManagedClient 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 + +### NewManagedClientWithDefaults + +`func NewManagedClientWithDefaults() *ManagedClient` + +NewManagedClientWithDefaults instantiates a new ManagedClient 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 + +### GetId + +`func (o *ManagedClient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManagedClient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManagedClient) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ManagedClient) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *ManagedClient) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *ManagedClient) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetAlertKey + +`func (o *ManagedClient) GetAlertKey() string` + +GetAlertKey returns the AlertKey field if non-nil, zero value otherwise. + +### GetAlertKeyOk + +`func (o *ManagedClient) GetAlertKeyOk() (*string, bool)` + +GetAlertKeyOk returns a tuple with the AlertKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertKey + +`func (o *ManagedClient) SetAlertKey(v string)` + +SetAlertKey sets AlertKey field to given value. + +### HasAlertKey + +`func (o *ManagedClient) HasAlertKey() bool` + +HasAlertKey returns a boolean if a field has been set. + +### SetAlertKeyNil + +`func (o *ManagedClient) SetAlertKeyNil(b bool)` + + SetAlertKeyNil sets the value for AlertKey to be an explicit nil + +### UnsetAlertKey +`func (o *ManagedClient) UnsetAlertKey()` + +UnsetAlertKey ensures that no value is present for AlertKey, not even an explicit nil +### GetApiGatewayBaseUrl + +`func (o *ManagedClient) GetApiGatewayBaseUrl() string` + +GetApiGatewayBaseUrl returns the ApiGatewayBaseUrl field if non-nil, zero value otherwise. + +### GetApiGatewayBaseUrlOk + +`func (o *ManagedClient) GetApiGatewayBaseUrlOk() (*string, bool)` + +GetApiGatewayBaseUrlOk returns a tuple with the ApiGatewayBaseUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiGatewayBaseUrl + +`func (o *ManagedClient) SetApiGatewayBaseUrl(v string)` + +SetApiGatewayBaseUrl sets ApiGatewayBaseUrl field to given value. + +### HasApiGatewayBaseUrl + +`func (o *ManagedClient) HasApiGatewayBaseUrl() bool` + +HasApiGatewayBaseUrl returns a boolean if a field has been set. + +### SetApiGatewayBaseUrlNil + +`func (o *ManagedClient) SetApiGatewayBaseUrlNil(b bool)` + + SetApiGatewayBaseUrlNil sets the value for ApiGatewayBaseUrl to be an explicit nil + +### UnsetApiGatewayBaseUrl +`func (o *ManagedClient) UnsetApiGatewayBaseUrl()` + +UnsetApiGatewayBaseUrl ensures that no value is present for ApiGatewayBaseUrl, not even an explicit nil +### GetCookbook + +`func (o *ManagedClient) GetCookbook() string` + +GetCookbook returns the Cookbook field if non-nil, zero value otherwise. + +### GetCookbookOk + +`func (o *ManagedClient) GetCookbookOk() (*string, bool)` + +GetCookbookOk returns a tuple with the Cookbook field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCookbook + +`func (o *ManagedClient) SetCookbook(v string)` + +SetCookbook sets Cookbook field to given value. + +### HasCookbook + +`func (o *ManagedClient) HasCookbook() bool` + +HasCookbook returns a boolean if a field has been set. + +### SetCookbookNil + +`func (o *ManagedClient) SetCookbookNil(b bool)` + + SetCookbookNil sets the value for Cookbook to be an explicit nil + +### UnsetCookbook +`func (o *ManagedClient) UnsetCookbook()` + +UnsetCookbook ensures that no value is present for Cookbook, not even an explicit nil +### GetCcId + +`func (o *ManagedClient) GetCcId() int64` + +GetCcId returns the CcId field if non-nil, zero value otherwise. + +### GetCcIdOk + +`func (o *ManagedClient) GetCcIdOk() (*int64, bool)` + +GetCcIdOk returns a tuple with the CcId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCcId + +`func (o *ManagedClient) SetCcId(v int64)` + +SetCcId sets CcId field to given value. + +### HasCcId + +`func (o *ManagedClient) HasCcId() bool` + +HasCcId returns a boolean if a field has been set. + +### SetCcIdNil + +`func (o *ManagedClient) SetCcIdNil(b bool)` + + SetCcIdNil sets the value for CcId to be an explicit nil + +### UnsetCcId +`func (o *ManagedClient) UnsetCcId()` + +UnsetCcId ensures that no value is present for CcId, not even an explicit nil +### GetClientId + +`func (o *ManagedClient) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ManagedClient) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ManagedClient) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + + +### GetClusterId + +`func (o *ManagedClient) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *ManagedClient) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *ManagedClient) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + + +### GetDescription + +`func (o *ManagedClient) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManagedClient) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManagedClient) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetIpAddress + +`func (o *ManagedClient) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *ManagedClient) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *ManagedClient) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + +### HasIpAddress + +`func (o *ManagedClient) HasIpAddress() bool` + +HasIpAddress returns a boolean if a field has been set. + +### SetIpAddressNil + +`func (o *ManagedClient) SetIpAddressNil(b bool)` + + SetIpAddressNil sets the value for IpAddress to be an explicit nil + +### UnsetIpAddress +`func (o *ManagedClient) UnsetIpAddress()` + +UnsetIpAddress ensures that no value is present for IpAddress, not even an explicit nil +### GetLastSeen + +`func (o *ManagedClient) GetLastSeen() SailPointTime` + +GetLastSeen returns the LastSeen field if non-nil, zero value otherwise. + +### GetLastSeenOk + +`func (o *ManagedClient) GetLastSeenOk() (*SailPointTime, bool)` + +GetLastSeenOk returns a tuple with the LastSeen field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastSeen + +`func (o *ManagedClient) SetLastSeen(v SailPointTime)` + +SetLastSeen sets LastSeen field to given value. + +### HasLastSeen + +`func (o *ManagedClient) HasLastSeen() bool` + +HasLastSeen returns a boolean if a field has been set. + +### SetLastSeenNil + +`func (o *ManagedClient) SetLastSeenNil(b bool)` + + SetLastSeenNil sets the value for LastSeen to be an explicit nil + +### UnsetLastSeen +`func (o *ManagedClient) UnsetLastSeen()` + +UnsetLastSeen ensures that no value is present for LastSeen, not even an explicit nil +### GetName + +`func (o *ManagedClient) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedClient) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedClient) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManagedClient) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ManagedClient) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ManagedClient) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetSinceLastSeen + +`func (o *ManagedClient) GetSinceLastSeen() string` + +GetSinceLastSeen returns the SinceLastSeen field if non-nil, zero value otherwise. + +### GetSinceLastSeenOk + +`func (o *ManagedClient) GetSinceLastSeenOk() (*string, bool)` + +GetSinceLastSeenOk returns a tuple with the SinceLastSeen field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSinceLastSeen + +`func (o *ManagedClient) SetSinceLastSeen(v string)` + +SetSinceLastSeen sets SinceLastSeen field to given value. + +### HasSinceLastSeen + +`func (o *ManagedClient) HasSinceLastSeen() bool` + +HasSinceLastSeen returns a boolean if a field has been set. + +### SetSinceLastSeenNil + +`func (o *ManagedClient) SetSinceLastSeenNil(b bool)` + + SetSinceLastSeenNil sets the value for SinceLastSeen to be an explicit nil + +### UnsetSinceLastSeen +`func (o *ManagedClient) UnsetSinceLastSeen()` + +UnsetSinceLastSeen ensures that no value is present for SinceLastSeen, not even an explicit nil +### GetStatus + +`func (o *ManagedClient) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManagedClient) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManagedClient) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ManagedClient) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatusNil + +`func (o *ManagedClient) SetStatusNil(b bool)` + + SetStatusNil sets the value for Status to be an explicit nil + +### UnsetStatus +`func (o *ManagedClient) UnsetStatus()` + +UnsetStatus ensures that no value is present for Status, not even an explicit nil +### GetType + +`func (o *ManagedClient) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClient) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClient) SetType(v string)` + +SetType sets Type field to given value. + + +### GetClusterType + +`func (o *ManagedClient) GetClusterType() string` + +GetClusterType returns the ClusterType field if non-nil, zero value otherwise. + +### GetClusterTypeOk + +`func (o *ManagedClient) GetClusterTypeOk() (*string, bool)` + +GetClusterTypeOk returns a tuple with the ClusterType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterType + +`func (o *ManagedClient) SetClusterType(v string)` + +SetClusterType sets ClusterType field to given value. + +### HasClusterType + +`func (o *ManagedClient) HasClusterType() bool` + +HasClusterType returns a boolean if a field has been set. + +### SetClusterTypeNil + +`func (o *ManagedClient) SetClusterTypeNil(b bool)` + + SetClusterTypeNil sets the value for ClusterType to be an explicit nil + +### UnsetClusterType +`func (o *ManagedClient) UnsetClusterType()` + +UnsetClusterType ensures that no value is present for ClusterType, not even an explicit nil +### GetVaDownloadUrl + +`func (o *ManagedClient) GetVaDownloadUrl() string` + +GetVaDownloadUrl returns the VaDownloadUrl field if non-nil, zero value otherwise. + +### GetVaDownloadUrlOk + +`func (o *ManagedClient) GetVaDownloadUrlOk() (*string, bool)` + +GetVaDownloadUrlOk returns a tuple with the VaDownloadUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVaDownloadUrl + +`func (o *ManagedClient) SetVaDownloadUrl(v string)` + +SetVaDownloadUrl sets VaDownloadUrl field to given value. + +### HasVaDownloadUrl + +`func (o *ManagedClient) HasVaDownloadUrl() bool` + +HasVaDownloadUrl returns a boolean if a field has been set. + +### SetVaDownloadUrlNil + +`func (o *ManagedClient) SetVaDownloadUrlNil(b bool)` + + SetVaDownloadUrlNil sets the value for VaDownloadUrl to be an explicit nil + +### UnsetVaDownloadUrl +`func (o *ManagedClient) UnsetVaDownloadUrl()` + +UnsetVaDownloadUrl ensures that no value is present for VaDownloadUrl, not even an explicit nil +### GetVaVersion + +`func (o *ManagedClient) GetVaVersion() string` + +GetVaVersion returns the VaVersion field if non-nil, zero value otherwise. + +### GetVaVersionOk + +`func (o *ManagedClient) GetVaVersionOk() (*string, bool)` + +GetVaVersionOk returns a tuple with the VaVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVaVersion + +`func (o *ManagedClient) SetVaVersion(v string)` + +SetVaVersion sets VaVersion field to given value. + +### HasVaVersion + +`func (o *ManagedClient) HasVaVersion() bool` + +HasVaVersion returns a boolean if a field has been set. + +### SetVaVersionNil + +`func (o *ManagedClient) SetVaVersionNil(b bool)` + + SetVaVersionNil sets the value for VaVersion to be an explicit nil + +### UnsetVaVersion +`func (o *ManagedClient) UnsetVaVersion()` + +UnsetVaVersion ensures that no value is present for VaVersion, not even an explicit nil +### GetSecret + +`func (o *ManagedClient) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *ManagedClient) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *ManagedClient) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *ManagedClient) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### SetSecretNil + +`func (o *ManagedClient) SetSecretNil(b bool)` + + SetSecretNil sets the value for Secret to be an explicit nil + +### UnsetSecret +`func (o *ManagedClient) UnsetSecret()` + +UnsetSecret ensures that no value is present for Secret, not even an explicit nil +### GetCreatedAt + +`func (o *ManagedClient) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *ManagedClient) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *ManagedClient) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *ManagedClient) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### SetCreatedAtNil + +`func (o *ManagedClient) SetCreatedAtNil(b bool)` + + SetCreatedAtNil sets the value for CreatedAt to be an explicit nil + +### UnsetCreatedAt +`func (o *ManagedClient) UnsetCreatedAt()` + +UnsetCreatedAt ensures that no value is present for CreatedAt, not even an explicit nil +### GetUpdatedAt + +`func (o *ManagedClient) GetUpdatedAt() SailPointTime` + +GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise. + +### GetUpdatedAtOk + +`func (o *ManagedClient) GetUpdatedAtOk() (*SailPointTime, bool)` + +GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedAt + +`func (o *ManagedClient) SetUpdatedAt(v SailPointTime)` + +SetUpdatedAt sets UpdatedAt field to given value. + +### HasUpdatedAt + +`func (o *ManagedClient) HasUpdatedAt() bool` + +HasUpdatedAt returns a boolean if a field has been set. + +### SetUpdatedAtNil + +`func (o *ManagedClient) SetUpdatedAtNil(b bool)` + + SetUpdatedAtNil sets the value for UpdatedAt to be an explicit nil + +### UnsetUpdatedAt +`func (o *ManagedClient) UnsetUpdatedAt()` + +UnsetUpdatedAt ensures that no value is present for UpdatedAt, not even an explicit nil +### GetProvisionStatus + +`func (o *ManagedClient) GetProvisionStatus() string` + +GetProvisionStatus returns the ProvisionStatus field if non-nil, zero value otherwise. + +### GetProvisionStatusOk + +`func (o *ManagedClient) GetProvisionStatusOk() (*string, bool)` + +GetProvisionStatusOk returns a tuple with the ProvisionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionStatus + +`func (o *ManagedClient) SetProvisionStatus(v string)` + +SetProvisionStatus sets ProvisionStatus field to given value. + +### HasProvisionStatus + +`func (o *ManagedClient) HasProvisionStatus() bool` + +HasProvisionStatus returns a boolean if a field has been set. + +### SetProvisionStatusNil + +`func (o *ManagedClient) SetProvisionStatusNil(b bool)` + + SetProvisionStatusNil sets the value for ProvisionStatus to be an explicit nil + +### UnsetProvisionStatus +`func (o *ManagedClient) UnsetProvisionStatus()` + +UnsetProvisionStatus ensures that no value is present for ProvisionStatus, not even an explicit nil +### GetHealthIndicators + +`func (o *ManagedClient) GetHealthIndicators() map[string]interface{}` + +GetHealthIndicators returns the HealthIndicators field if non-nil, zero value otherwise. + +### GetHealthIndicatorsOk + +`func (o *ManagedClient) GetHealthIndicatorsOk() (*map[string]interface{}, bool)` + +GetHealthIndicatorsOk returns a tuple with the HealthIndicators field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthIndicators + +`func (o *ManagedClient) SetHealthIndicators(v map[string]interface{})` + +SetHealthIndicators sets HealthIndicators field to given value. + +### HasHealthIndicators + +`func (o *ManagedClient) HasHealthIndicators() bool` + +HasHealthIndicators returns a boolean if a field has been set. + +### SetHealthIndicatorsNil + +`func (o *ManagedClient) SetHealthIndicatorsNil(b bool)` + + SetHealthIndicatorsNil sets the value for HealthIndicators to be an explicit nil + +### UnsetHealthIndicators +`func (o *ManagedClient) UnsetHealthIndicators()` + +UnsetHealthIndicators ensures that no value is present for HealthIndicators, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManagedClientRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClientRequest.md new file mode 100644 index 000000000..5631865c3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClientRequest.md @@ -0,0 +1,167 @@ +--- +id: v2024-managed-client-request +title: ManagedClientRequest +pagination_label: ManagedClientRequest +sidebar_label: ManagedClientRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClientRequest', 'V2024ManagedClientRequest'] +slug: /tools/sdk/go/v2024/models/managed-client-request +tags: ['SDK', 'Software Development Kit', 'ManagedClientRequest', 'V2024ManagedClientRequest'] +--- + +# ManagedClientRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterId** | **string** | Cluster ID that the ManagedClient is linked to | +**Description** | Pointer to **NullableString** | description for the ManagedClient to create | [optional] +**Name** | Pointer to **NullableString** | name for the ManagedClient to create | [optional] +**Type** | Pointer to **NullableString** | Type of the ManagedClient (VA, CCG) to create | [optional] + +## Methods + +### NewManagedClientRequest + +`func NewManagedClientRequest(clusterId string, ) *ManagedClientRequest` + +NewManagedClientRequest instantiates a new ManagedClientRequest 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 + +### NewManagedClientRequestWithDefaults + +`func NewManagedClientRequestWithDefaults() *ManagedClientRequest` + +NewManagedClientRequestWithDefaults instantiates a new ManagedClientRequest 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 + +### GetClusterId + +`func (o *ManagedClientRequest) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *ManagedClientRequest) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *ManagedClientRequest) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + + +### GetDescription + +`func (o *ManagedClientRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManagedClientRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManagedClientRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ManagedClientRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ManagedClientRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ManagedClientRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetName + +`func (o *ManagedClientRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedClientRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedClientRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManagedClientRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ManagedClientRequest) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ManagedClientRequest) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetType + +`func (o *ManagedClientRequest) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClientRequest) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClientRequest) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManagedClientRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *ManagedClientRequest) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *ManagedClientRequest) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManagedClientStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClientStatus.md new file mode 100644 index 000000000..0c2c21613 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClientStatus.md @@ -0,0 +1,132 @@ +--- +id: v2024-managed-client-status +title: ManagedClientStatus +pagination_label: ManagedClientStatus +sidebar_label: ManagedClientStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClientStatus', 'V2024ManagedClientStatus'] +slug: /tools/sdk/go/v2024/models/managed-client-status +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatus', 'V2024ManagedClientStatus'] +--- + +# ManagedClientStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Body** | **map[string]interface{}** | ManagedClientStatus body information | +**Status** | [**ManagedClientStatusCode**](managed-client-status-code) | | +**Type** | [**NullableManagedClientType**](managed-client-type) | | +**Timestamp** | **SailPointTime** | timestamp on the Client Status update | + +## Methods + +### NewManagedClientStatus + +`func NewManagedClientStatus(body map[string]interface{}, status ManagedClientStatusCode, type_ NullableManagedClientType, timestamp SailPointTime, ) *ManagedClientStatus` + +NewManagedClientStatus instantiates a new ManagedClientStatus 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 + +### NewManagedClientStatusWithDefaults + +`func NewManagedClientStatusWithDefaults() *ManagedClientStatus` + +NewManagedClientStatusWithDefaults instantiates a new ManagedClientStatus 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 + +### GetBody + +`func (o *ManagedClientStatus) GetBody() map[string]interface{}` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *ManagedClientStatus) GetBodyOk() (*map[string]interface{}, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBody + +`func (o *ManagedClientStatus) SetBody(v map[string]interface{})` + +SetBody sets Body field to given value. + + +### GetStatus + +`func (o *ManagedClientStatus) GetStatus() ManagedClientStatusCode` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManagedClientStatus) GetStatusOk() (*ManagedClientStatusCode, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManagedClientStatus) SetStatus(v ManagedClientStatusCode)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *ManagedClientStatus) GetType() ManagedClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClientStatus) GetTypeOk() (*ManagedClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClientStatus) SetType(v ManagedClientType)` + +SetType sets Type field to given value. + + +### SetTypeNil + +`func (o *ManagedClientStatus) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *ManagedClientStatus) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetTimestamp + +`func (o *ManagedClientStatus) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *ManagedClientStatus) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *ManagedClientStatus) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManagedClientStatusCode.md b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClientStatusCode.md new file mode 100644 index 000000000..1100f3973 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClientStatusCode.md @@ -0,0 +1,31 @@ +--- +id: v2024-managed-client-status-code +title: ManagedClientStatusCode +pagination_label: ManagedClientStatusCode +sidebar_label: ManagedClientStatusCode +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClientStatusCode', 'V2024ManagedClientStatusCode'] +slug: /tools/sdk/go/v2024/models/managed-client-status-code +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatusCode', 'V2024ManagedClientStatusCode'] +--- + +# ManagedClientStatusCode + +## Enum + + +* `NORMAL` (value: `"NORMAL"`) + +* `UNDEFINED` (value: `"UNDEFINED"`) + +* `NOT_CONFIGURED` (value: `"NOT_CONFIGURED"`) + +* `CONFIGURING` (value: `"CONFIGURING"`) + +* `WARNING` (value: `"WARNING"`) + +* `ERROR` (value: `"ERROR"`) + +* `FAILED` (value: `"FAILED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManagedClientType.md b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClientType.md new file mode 100644 index 000000000..b51f6ae47 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClientType.md @@ -0,0 +1,25 @@ +--- +id: v2024-managed-client-type +title: ManagedClientType +pagination_label: ManagedClientType +sidebar_label: ManagedClientType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClientType', 'V2024ManagedClientType'] +slug: /tools/sdk/go/v2024/models/managed-client-type +tags: ['SDK', 'Software Development Kit', 'ManagedClientType', 'V2024ManagedClientType'] +--- + +# ManagedClientType + +## Enum + + +* `CCG` (value: `"CCG"`) + +* `VA` (value: `"VA"`) + +* `INTERNAL` (value: `"INTERNAL"`) + +* `IIQ_HARVESTER` (value: `"IIQ_HARVESTER"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManagedCluster.md b/docs/tools/sdk/go/Reference/V2024/Models/ManagedCluster.md new file mode 100644 index 000000000..b3b2fba31 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManagedCluster.md @@ -0,0 +1,949 @@ +--- +id: v2024-managed-cluster +title: ManagedCluster +pagination_label: ManagedCluster +sidebar_label: ManagedCluster +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedCluster', 'V2024ManagedCluster'] +slug: /tools/sdk/go/v2024/models/managed-cluster +tags: ['SDK', 'Software Development Kit', 'ManagedCluster', 'V2024ManagedCluster'] +--- + +# ManagedCluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ManagedCluster ID | +**Name** | Pointer to **string** | ManagedCluster name | [optional] +**Pod** | Pointer to **string** | ManagedCluster pod | [optional] +**Org** | Pointer to **string** | ManagedCluster org | [optional] +**Type** | Pointer to [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**Configuration** | Pointer to **map[string]string** | ManagedProcess configuration map | [optional] +**KeyPair** | Pointer to [**ManagedClusterKeyPair**](managed-cluster-key-pair) | | [optional] +**Attributes** | Pointer to [**ManagedClusterAttributes**](managed-cluster-attributes) | | [optional] +**Description** | Pointer to **string** | ManagedCluster description | [optional] [default to "q"] +**Redis** | Pointer to [**ManagedClusterRedis**](managed-cluster-redis) | | [optional] +**ClientType** | [**NullableManagedClientType**](managed-client-type) | | +**CcgVersion** | **string** | CCG version used by the ManagedCluster | +**PinnedConfig** | Pointer to **bool** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to false] +**LogConfiguration** | Pointer to [**NullableClientLogConfiguration**](client-log-configuration) | | [optional] +**Operational** | Pointer to **bool** | Whether or not the cluster is operational or not | [optional] [default to false] +**Status** | Pointer to **string** | Cluster status | [optional] +**PublicKeyCertificate** | Pointer to **NullableString** | Public key certificate | [optional] +**PublicKeyThumbprint** | Pointer to **NullableString** | Public key thumbprint | [optional] +**PublicKey** | Pointer to **NullableString** | Public key | [optional] +**AlertKey** | Pointer to **string** | Key describing any immediate cluster alerts | [optional] +**ClientIds** | Pointer to **[]string** | List of clients in a cluster | [optional] +**ServiceCount** | Pointer to **int32** | Number of services bound to a cluster | [optional] [default to 0] +**CcId** | Pointer to **string** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to "0"] +**CreatedAt** | Pointer to **NullableTime** | The date/time this cluster was created | [optional] +**UpdatedAt** | Pointer to **NullableTime** | The date/time this cluster was last updated | [optional] +**LastReleaseNotifiedAt** | Pointer to **NullableTime** | The date/time this cluster was notified for the last release | [optional] +**UpdatePreferences** | Pointer to [**ManagedClusterUpdatePreferences**](managed-cluster-update-preferences) | | [optional] +**CurrentInstalledReleaseVersion** | Pointer to **NullableString** | The current installed release on the Managed cluster | [optional] +**UpdatePackage** | Pointer to **NullableString** | New available updates for the Managed cluster | [optional] +**IsOutOfDateNotifiedAt** | Pointer to **NullableTime** | The time at which out of date notification was sent for the Managed cluster | [optional] +**ConsolidatedHealthIndicatorsStatus** | Pointer to **NullableString** | The consolidated Health Status for the Managed cluster | [optional] + +## Methods + +### NewManagedCluster + +`func NewManagedCluster(id string, clientType NullableManagedClientType, ccgVersion string, ) *ManagedCluster` + +NewManagedCluster instantiates a new ManagedCluster 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 + +### NewManagedClusterWithDefaults + +`func NewManagedClusterWithDefaults() *ManagedCluster` + +NewManagedClusterWithDefaults instantiates a new ManagedCluster 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 + +### GetId + +`func (o *ManagedCluster) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManagedCluster) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManagedCluster) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *ManagedCluster) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedCluster) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedCluster) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManagedCluster) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPod + +`func (o *ManagedCluster) GetPod() string` + +GetPod returns the Pod field if non-nil, zero value otherwise. + +### GetPodOk + +`func (o *ManagedCluster) GetPodOk() (*string, bool)` + +GetPodOk returns a tuple with the Pod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPod + +`func (o *ManagedCluster) SetPod(v string)` + +SetPod sets Pod field to given value. + +### HasPod + +`func (o *ManagedCluster) HasPod() bool` + +HasPod returns a boolean if a field has been set. + +### GetOrg + +`func (o *ManagedCluster) GetOrg() string` + +GetOrg returns the Org field if non-nil, zero value otherwise. + +### GetOrgOk + +`func (o *ManagedCluster) GetOrgOk() (*string, bool)` + +GetOrgOk returns a tuple with the Org field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrg + +`func (o *ManagedCluster) SetOrg(v string)` + +SetOrg sets Org field to given value. + +### HasOrg + +`func (o *ManagedCluster) HasOrg() bool` + +HasOrg returns a boolean if a field has been set. + +### GetType + +`func (o *ManagedCluster) GetType() ManagedClusterTypes` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedCluster) GetTypeOk() (*ManagedClusterTypes, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedCluster) SetType(v ManagedClusterTypes)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManagedCluster) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConfiguration + +`func (o *ManagedCluster) GetConfiguration() map[string]string` + +GetConfiguration returns the Configuration field if non-nil, zero value otherwise. + +### GetConfigurationOk + +`func (o *ManagedCluster) GetConfigurationOk() (*map[string]string, bool)` + +GetConfigurationOk returns a tuple with the Configuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfiguration + +`func (o *ManagedCluster) SetConfiguration(v map[string]string)` + +SetConfiguration sets Configuration field to given value. + +### HasConfiguration + +`func (o *ManagedCluster) HasConfiguration() bool` + +HasConfiguration returns a boolean if a field has been set. + +### GetKeyPair + +`func (o *ManagedCluster) GetKeyPair() ManagedClusterKeyPair` + +GetKeyPair returns the KeyPair field if non-nil, zero value otherwise. + +### GetKeyPairOk + +`func (o *ManagedCluster) GetKeyPairOk() (*ManagedClusterKeyPair, bool)` + +GetKeyPairOk returns a tuple with the KeyPair field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKeyPair + +`func (o *ManagedCluster) SetKeyPair(v ManagedClusterKeyPair)` + +SetKeyPair sets KeyPair field to given value. + +### HasKeyPair + +`func (o *ManagedCluster) HasKeyPair() bool` + +HasKeyPair returns a boolean if a field has been set. + +### GetAttributes + +`func (o *ManagedCluster) GetAttributes() ManagedClusterAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ManagedCluster) GetAttributesOk() (*ManagedClusterAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ManagedCluster) SetAttributes(v ManagedClusterAttributes)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ManagedCluster) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetDescription + +`func (o *ManagedCluster) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManagedCluster) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManagedCluster) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ManagedCluster) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetRedis + +`func (o *ManagedCluster) GetRedis() ManagedClusterRedis` + +GetRedis returns the Redis field if non-nil, zero value otherwise. + +### GetRedisOk + +`func (o *ManagedCluster) GetRedisOk() (*ManagedClusterRedis, bool)` + +GetRedisOk returns a tuple with the Redis field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedis + +`func (o *ManagedCluster) SetRedis(v ManagedClusterRedis)` + +SetRedis sets Redis field to given value. + +### HasRedis + +`func (o *ManagedCluster) HasRedis() bool` + +HasRedis returns a boolean if a field has been set. + +### GetClientType + +`func (o *ManagedCluster) GetClientType() ManagedClientType` + +GetClientType returns the ClientType field if non-nil, zero value otherwise. + +### GetClientTypeOk + +`func (o *ManagedCluster) GetClientTypeOk() (*ManagedClientType, bool)` + +GetClientTypeOk returns a tuple with the ClientType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientType + +`func (o *ManagedCluster) SetClientType(v ManagedClientType)` + +SetClientType sets ClientType field to given value. + + +### SetClientTypeNil + +`func (o *ManagedCluster) SetClientTypeNil(b bool)` + + SetClientTypeNil sets the value for ClientType to be an explicit nil + +### UnsetClientType +`func (o *ManagedCluster) UnsetClientType()` + +UnsetClientType ensures that no value is present for ClientType, not even an explicit nil +### GetCcgVersion + +`func (o *ManagedCluster) GetCcgVersion() string` + +GetCcgVersion returns the CcgVersion field if non-nil, zero value otherwise. + +### GetCcgVersionOk + +`func (o *ManagedCluster) GetCcgVersionOk() (*string, bool)` + +GetCcgVersionOk returns a tuple with the CcgVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCcgVersion + +`func (o *ManagedCluster) SetCcgVersion(v string)` + +SetCcgVersion sets CcgVersion field to given value. + + +### GetPinnedConfig + +`func (o *ManagedCluster) GetPinnedConfig() bool` + +GetPinnedConfig returns the PinnedConfig field if non-nil, zero value otherwise. + +### GetPinnedConfigOk + +`func (o *ManagedCluster) GetPinnedConfigOk() (*bool, bool)` + +GetPinnedConfigOk returns a tuple with the PinnedConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPinnedConfig + +`func (o *ManagedCluster) SetPinnedConfig(v bool)` + +SetPinnedConfig sets PinnedConfig field to given value. + +### HasPinnedConfig + +`func (o *ManagedCluster) HasPinnedConfig() bool` + +HasPinnedConfig returns a boolean if a field has been set. + +### GetLogConfiguration + +`func (o *ManagedCluster) GetLogConfiguration() ClientLogConfiguration` + +GetLogConfiguration returns the LogConfiguration field if non-nil, zero value otherwise. + +### GetLogConfigurationOk + +`func (o *ManagedCluster) GetLogConfigurationOk() (*ClientLogConfiguration, bool)` + +GetLogConfigurationOk returns a tuple with the LogConfiguration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogConfiguration + +`func (o *ManagedCluster) SetLogConfiguration(v ClientLogConfiguration)` + +SetLogConfiguration sets LogConfiguration field to given value. + +### HasLogConfiguration + +`func (o *ManagedCluster) HasLogConfiguration() bool` + +HasLogConfiguration returns a boolean if a field has been set. + +### SetLogConfigurationNil + +`func (o *ManagedCluster) SetLogConfigurationNil(b bool)` + + SetLogConfigurationNil sets the value for LogConfiguration to be an explicit nil + +### UnsetLogConfiguration +`func (o *ManagedCluster) UnsetLogConfiguration()` + +UnsetLogConfiguration ensures that no value is present for LogConfiguration, not even an explicit nil +### GetOperational + +`func (o *ManagedCluster) GetOperational() bool` + +GetOperational returns the Operational field if non-nil, zero value otherwise. + +### GetOperationalOk + +`func (o *ManagedCluster) GetOperationalOk() (*bool, bool)` + +GetOperationalOk returns a tuple with the Operational field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperational + +`func (o *ManagedCluster) SetOperational(v bool)` + +SetOperational sets Operational field to given value. + +### HasOperational + +`func (o *ManagedCluster) HasOperational() bool` + +HasOperational returns a boolean if a field has been set. + +### GetStatus + +`func (o *ManagedCluster) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManagedCluster) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManagedCluster) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ManagedCluster) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetPublicKeyCertificate + +`func (o *ManagedCluster) GetPublicKeyCertificate() string` + +GetPublicKeyCertificate returns the PublicKeyCertificate field if non-nil, zero value otherwise. + +### GetPublicKeyCertificateOk + +`func (o *ManagedCluster) GetPublicKeyCertificateOk() (*string, bool)` + +GetPublicKeyCertificateOk returns a tuple with the PublicKeyCertificate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyCertificate + +`func (o *ManagedCluster) SetPublicKeyCertificate(v string)` + +SetPublicKeyCertificate sets PublicKeyCertificate field to given value. + +### HasPublicKeyCertificate + +`func (o *ManagedCluster) HasPublicKeyCertificate() bool` + +HasPublicKeyCertificate returns a boolean if a field has been set. + +### SetPublicKeyCertificateNil + +`func (o *ManagedCluster) SetPublicKeyCertificateNil(b bool)` + + SetPublicKeyCertificateNil sets the value for PublicKeyCertificate to be an explicit nil + +### UnsetPublicKeyCertificate +`func (o *ManagedCluster) UnsetPublicKeyCertificate()` + +UnsetPublicKeyCertificate ensures that no value is present for PublicKeyCertificate, not even an explicit nil +### GetPublicKeyThumbprint + +`func (o *ManagedCluster) GetPublicKeyThumbprint() string` + +GetPublicKeyThumbprint returns the PublicKeyThumbprint field if non-nil, zero value otherwise. + +### GetPublicKeyThumbprintOk + +`func (o *ManagedCluster) GetPublicKeyThumbprintOk() (*string, bool)` + +GetPublicKeyThumbprintOk returns a tuple with the PublicKeyThumbprint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyThumbprint + +`func (o *ManagedCluster) SetPublicKeyThumbprint(v string)` + +SetPublicKeyThumbprint sets PublicKeyThumbprint field to given value. + +### HasPublicKeyThumbprint + +`func (o *ManagedCluster) HasPublicKeyThumbprint() bool` + +HasPublicKeyThumbprint returns a boolean if a field has been set. + +### SetPublicKeyThumbprintNil + +`func (o *ManagedCluster) SetPublicKeyThumbprintNil(b bool)` + + SetPublicKeyThumbprintNil sets the value for PublicKeyThumbprint to be an explicit nil + +### UnsetPublicKeyThumbprint +`func (o *ManagedCluster) UnsetPublicKeyThumbprint()` + +UnsetPublicKeyThumbprint ensures that no value is present for PublicKeyThumbprint, not even an explicit nil +### GetPublicKey + +`func (o *ManagedCluster) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *ManagedCluster) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *ManagedCluster) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *ManagedCluster) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### SetPublicKeyNil + +`func (o *ManagedCluster) SetPublicKeyNil(b bool)` + + SetPublicKeyNil sets the value for PublicKey to be an explicit nil + +### UnsetPublicKey +`func (o *ManagedCluster) UnsetPublicKey()` + +UnsetPublicKey ensures that no value is present for PublicKey, not even an explicit nil +### GetAlertKey + +`func (o *ManagedCluster) GetAlertKey() string` + +GetAlertKey returns the AlertKey field if non-nil, zero value otherwise. + +### GetAlertKeyOk + +`func (o *ManagedCluster) GetAlertKeyOk() (*string, bool)` + +GetAlertKeyOk returns a tuple with the AlertKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertKey + +`func (o *ManagedCluster) SetAlertKey(v string)` + +SetAlertKey sets AlertKey field to given value. + +### HasAlertKey + +`func (o *ManagedCluster) HasAlertKey() bool` + +HasAlertKey returns a boolean if a field has been set. + +### GetClientIds + +`func (o *ManagedCluster) GetClientIds() []string` + +GetClientIds returns the ClientIds field if non-nil, zero value otherwise. + +### GetClientIdsOk + +`func (o *ManagedCluster) GetClientIdsOk() (*[]string, bool)` + +GetClientIdsOk returns a tuple with the ClientIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientIds + +`func (o *ManagedCluster) SetClientIds(v []string)` + +SetClientIds sets ClientIds field to given value. + +### HasClientIds + +`func (o *ManagedCluster) HasClientIds() bool` + +HasClientIds returns a boolean if a field has been set. + +### GetServiceCount + +`func (o *ManagedCluster) GetServiceCount() int32` + +GetServiceCount returns the ServiceCount field if non-nil, zero value otherwise. + +### GetServiceCountOk + +`func (o *ManagedCluster) GetServiceCountOk() (*int32, bool)` + +GetServiceCountOk returns a tuple with the ServiceCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceCount + +`func (o *ManagedCluster) SetServiceCount(v int32)` + +SetServiceCount sets ServiceCount field to given value. + +### HasServiceCount + +`func (o *ManagedCluster) HasServiceCount() bool` + +HasServiceCount returns a boolean if a field has been set. + +### GetCcId + +`func (o *ManagedCluster) GetCcId() string` + +GetCcId returns the CcId field if non-nil, zero value otherwise. + +### GetCcIdOk + +`func (o *ManagedCluster) GetCcIdOk() (*string, bool)` + +GetCcIdOk returns a tuple with the CcId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCcId + +`func (o *ManagedCluster) SetCcId(v string)` + +SetCcId sets CcId field to given value. + +### HasCcId + +`func (o *ManagedCluster) HasCcId() bool` + +HasCcId returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *ManagedCluster) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *ManagedCluster) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *ManagedCluster) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *ManagedCluster) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### SetCreatedAtNil + +`func (o *ManagedCluster) SetCreatedAtNil(b bool)` + + SetCreatedAtNil sets the value for CreatedAt to be an explicit nil + +### UnsetCreatedAt +`func (o *ManagedCluster) UnsetCreatedAt()` + +UnsetCreatedAt ensures that no value is present for CreatedAt, not even an explicit nil +### GetUpdatedAt + +`func (o *ManagedCluster) GetUpdatedAt() SailPointTime` + +GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise. + +### GetUpdatedAtOk + +`func (o *ManagedCluster) GetUpdatedAtOk() (*SailPointTime, bool)` + +GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedAt + +`func (o *ManagedCluster) SetUpdatedAt(v SailPointTime)` + +SetUpdatedAt sets UpdatedAt field to given value. + +### HasUpdatedAt + +`func (o *ManagedCluster) HasUpdatedAt() bool` + +HasUpdatedAt returns a boolean if a field has been set. + +### SetUpdatedAtNil + +`func (o *ManagedCluster) SetUpdatedAtNil(b bool)` + + SetUpdatedAtNil sets the value for UpdatedAt to be an explicit nil + +### UnsetUpdatedAt +`func (o *ManagedCluster) UnsetUpdatedAt()` + +UnsetUpdatedAt ensures that no value is present for UpdatedAt, not even an explicit nil +### GetLastReleaseNotifiedAt + +`func (o *ManagedCluster) GetLastReleaseNotifiedAt() SailPointTime` + +GetLastReleaseNotifiedAt returns the LastReleaseNotifiedAt field if non-nil, zero value otherwise. + +### GetLastReleaseNotifiedAtOk + +`func (o *ManagedCluster) GetLastReleaseNotifiedAtOk() (*SailPointTime, bool)` + +GetLastReleaseNotifiedAtOk returns a tuple with the LastReleaseNotifiedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastReleaseNotifiedAt + +`func (o *ManagedCluster) SetLastReleaseNotifiedAt(v SailPointTime)` + +SetLastReleaseNotifiedAt sets LastReleaseNotifiedAt field to given value. + +### HasLastReleaseNotifiedAt + +`func (o *ManagedCluster) HasLastReleaseNotifiedAt() bool` + +HasLastReleaseNotifiedAt returns a boolean if a field has been set. + +### SetLastReleaseNotifiedAtNil + +`func (o *ManagedCluster) SetLastReleaseNotifiedAtNil(b bool)` + + SetLastReleaseNotifiedAtNil sets the value for LastReleaseNotifiedAt to be an explicit nil + +### UnsetLastReleaseNotifiedAt +`func (o *ManagedCluster) UnsetLastReleaseNotifiedAt()` + +UnsetLastReleaseNotifiedAt ensures that no value is present for LastReleaseNotifiedAt, not even an explicit nil +### GetUpdatePreferences + +`func (o *ManagedCluster) GetUpdatePreferences() ManagedClusterUpdatePreferences` + +GetUpdatePreferences returns the UpdatePreferences field if non-nil, zero value otherwise. + +### GetUpdatePreferencesOk + +`func (o *ManagedCluster) GetUpdatePreferencesOk() (*ManagedClusterUpdatePreferences, bool)` + +GetUpdatePreferencesOk returns a tuple with the UpdatePreferences field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatePreferences + +`func (o *ManagedCluster) SetUpdatePreferences(v ManagedClusterUpdatePreferences)` + +SetUpdatePreferences sets UpdatePreferences field to given value. + +### HasUpdatePreferences + +`func (o *ManagedCluster) HasUpdatePreferences() bool` + +HasUpdatePreferences returns a boolean if a field has been set. + +### GetCurrentInstalledReleaseVersion + +`func (o *ManagedCluster) GetCurrentInstalledReleaseVersion() string` + +GetCurrentInstalledReleaseVersion returns the CurrentInstalledReleaseVersion field if non-nil, zero value otherwise. + +### GetCurrentInstalledReleaseVersionOk + +`func (o *ManagedCluster) GetCurrentInstalledReleaseVersionOk() (*string, bool)` + +GetCurrentInstalledReleaseVersionOk returns a tuple with the CurrentInstalledReleaseVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentInstalledReleaseVersion + +`func (o *ManagedCluster) SetCurrentInstalledReleaseVersion(v string)` + +SetCurrentInstalledReleaseVersion sets CurrentInstalledReleaseVersion field to given value. + +### HasCurrentInstalledReleaseVersion + +`func (o *ManagedCluster) HasCurrentInstalledReleaseVersion() bool` + +HasCurrentInstalledReleaseVersion returns a boolean if a field has been set. + +### SetCurrentInstalledReleaseVersionNil + +`func (o *ManagedCluster) SetCurrentInstalledReleaseVersionNil(b bool)` + + SetCurrentInstalledReleaseVersionNil sets the value for CurrentInstalledReleaseVersion to be an explicit nil + +### UnsetCurrentInstalledReleaseVersion +`func (o *ManagedCluster) UnsetCurrentInstalledReleaseVersion()` + +UnsetCurrentInstalledReleaseVersion ensures that no value is present for CurrentInstalledReleaseVersion, not even an explicit nil +### GetUpdatePackage + +`func (o *ManagedCluster) GetUpdatePackage() string` + +GetUpdatePackage returns the UpdatePackage field if non-nil, zero value otherwise. + +### GetUpdatePackageOk + +`func (o *ManagedCluster) GetUpdatePackageOk() (*string, bool)` + +GetUpdatePackageOk returns a tuple with the UpdatePackage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatePackage + +`func (o *ManagedCluster) SetUpdatePackage(v string)` + +SetUpdatePackage sets UpdatePackage field to given value. + +### HasUpdatePackage + +`func (o *ManagedCluster) HasUpdatePackage() bool` + +HasUpdatePackage returns a boolean if a field has been set. + +### SetUpdatePackageNil + +`func (o *ManagedCluster) SetUpdatePackageNil(b bool)` + + SetUpdatePackageNil sets the value for UpdatePackage to be an explicit nil + +### UnsetUpdatePackage +`func (o *ManagedCluster) UnsetUpdatePackage()` + +UnsetUpdatePackage ensures that no value is present for UpdatePackage, not even an explicit nil +### GetIsOutOfDateNotifiedAt + +`func (o *ManagedCluster) GetIsOutOfDateNotifiedAt() SailPointTime` + +GetIsOutOfDateNotifiedAt returns the IsOutOfDateNotifiedAt field if non-nil, zero value otherwise. + +### GetIsOutOfDateNotifiedAtOk + +`func (o *ManagedCluster) GetIsOutOfDateNotifiedAtOk() (*SailPointTime, bool)` + +GetIsOutOfDateNotifiedAtOk returns a tuple with the IsOutOfDateNotifiedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsOutOfDateNotifiedAt + +`func (o *ManagedCluster) SetIsOutOfDateNotifiedAt(v SailPointTime)` + +SetIsOutOfDateNotifiedAt sets IsOutOfDateNotifiedAt field to given value. + +### HasIsOutOfDateNotifiedAt + +`func (o *ManagedCluster) HasIsOutOfDateNotifiedAt() bool` + +HasIsOutOfDateNotifiedAt returns a boolean if a field has been set. + +### SetIsOutOfDateNotifiedAtNil + +`func (o *ManagedCluster) SetIsOutOfDateNotifiedAtNil(b bool)` + + SetIsOutOfDateNotifiedAtNil sets the value for IsOutOfDateNotifiedAt to be an explicit nil + +### UnsetIsOutOfDateNotifiedAt +`func (o *ManagedCluster) UnsetIsOutOfDateNotifiedAt()` + +UnsetIsOutOfDateNotifiedAt ensures that no value is present for IsOutOfDateNotifiedAt, not even an explicit nil +### GetConsolidatedHealthIndicatorsStatus + +`func (o *ManagedCluster) GetConsolidatedHealthIndicatorsStatus() string` + +GetConsolidatedHealthIndicatorsStatus returns the ConsolidatedHealthIndicatorsStatus field if non-nil, zero value otherwise. + +### GetConsolidatedHealthIndicatorsStatusOk + +`func (o *ManagedCluster) GetConsolidatedHealthIndicatorsStatusOk() (*string, bool)` + +GetConsolidatedHealthIndicatorsStatusOk returns a tuple with the ConsolidatedHealthIndicatorsStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConsolidatedHealthIndicatorsStatus + +`func (o *ManagedCluster) SetConsolidatedHealthIndicatorsStatus(v string)` + +SetConsolidatedHealthIndicatorsStatus sets ConsolidatedHealthIndicatorsStatus field to given value. + +### HasConsolidatedHealthIndicatorsStatus + +`func (o *ManagedCluster) HasConsolidatedHealthIndicatorsStatus() bool` + +HasConsolidatedHealthIndicatorsStatus returns a boolean if a field has been set. + +### SetConsolidatedHealthIndicatorsStatusNil + +`func (o *ManagedCluster) SetConsolidatedHealthIndicatorsStatusNil(b bool)` + + SetConsolidatedHealthIndicatorsStatusNil sets the value for ConsolidatedHealthIndicatorsStatus to be an explicit nil + +### UnsetConsolidatedHealthIndicatorsStatus +`func (o *ManagedCluster) UnsetConsolidatedHealthIndicatorsStatus()` + +UnsetConsolidatedHealthIndicatorsStatus ensures that no value is present for ConsolidatedHealthIndicatorsStatus, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterAttributes.md b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterAttributes.md new file mode 100644 index 000000000..cfaa5bb01 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterAttributes.md @@ -0,0 +1,100 @@ +--- +id: v2024-managed-cluster-attributes +title: ManagedClusterAttributes +pagination_label: ManagedClusterAttributes +sidebar_label: ManagedClusterAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterAttributes', 'V2024ManagedClusterAttributes'] +slug: /tools/sdk/go/v2024/models/managed-cluster-attributes +tags: ['SDK', 'Software Development Kit', 'ManagedClusterAttributes', 'V2024ManagedClusterAttributes'] +--- + +# ManagedClusterAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Queue** | Pointer to [**ManagedClusterQueue**](managed-cluster-queue) | | [optional] +**Keystore** | Pointer to **NullableString** | ManagedCluster keystore for spConnectCluster type | [optional] + +## Methods + +### NewManagedClusterAttributes + +`func NewManagedClusterAttributes() *ManagedClusterAttributes` + +NewManagedClusterAttributes instantiates a new ManagedClusterAttributes 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 + +### NewManagedClusterAttributesWithDefaults + +`func NewManagedClusterAttributesWithDefaults() *ManagedClusterAttributes` + +NewManagedClusterAttributesWithDefaults instantiates a new ManagedClusterAttributes 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 + +### GetQueue + +`func (o *ManagedClusterAttributes) GetQueue() ManagedClusterQueue` + +GetQueue returns the Queue field if non-nil, zero value otherwise. + +### GetQueueOk + +`func (o *ManagedClusterAttributes) GetQueueOk() (*ManagedClusterQueue, bool)` + +GetQueueOk returns a tuple with the Queue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueue + +`func (o *ManagedClusterAttributes) SetQueue(v ManagedClusterQueue)` + +SetQueue sets Queue field to given value. + +### HasQueue + +`func (o *ManagedClusterAttributes) HasQueue() bool` + +HasQueue returns a boolean if a field has been set. + +### GetKeystore + +`func (o *ManagedClusterAttributes) GetKeystore() string` + +GetKeystore returns the Keystore field if non-nil, zero value otherwise. + +### GetKeystoreOk + +`func (o *ManagedClusterAttributes) GetKeystoreOk() (*string, bool)` + +GetKeystoreOk returns a tuple with the Keystore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKeystore + +`func (o *ManagedClusterAttributes) SetKeystore(v string)` + +SetKeystore sets Keystore field to given value. + +### HasKeystore + +`func (o *ManagedClusterAttributes) HasKeystore() bool` + +HasKeystore returns a boolean if a field has been set. + +### SetKeystoreNil + +`func (o *ManagedClusterAttributes) SetKeystoreNil(b bool)` + + SetKeystoreNil sets the value for Keystore to be an explicit nil + +### UnsetKeystore +`func (o *ManagedClusterAttributes) UnsetKeystore()` + +UnsetKeystore ensures that no value is present for Keystore, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterKeyPair.md b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterKeyPair.md new file mode 100644 index 000000000..5c331d288 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterKeyPair.md @@ -0,0 +1,146 @@ +--- +id: v2024-managed-cluster-key-pair +title: ManagedClusterKeyPair +pagination_label: ManagedClusterKeyPair +sidebar_label: ManagedClusterKeyPair +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterKeyPair', 'V2024ManagedClusterKeyPair'] +slug: /tools/sdk/go/v2024/models/managed-cluster-key-pair +tags: ['SDK', 'Software Development Kit', 'ManagedClusterKeyPair', 'V2024ManagedClusterKeyPair'] +--- + +# ManagedClusterKeyPair + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PublicKey** | Pointer to **NullableString** | ManagedCluster publicKey | [optional] +**PublicKeyThumbprint** | Pointer to **NullableString** | ManagedCluster publicKeyThumbprint | [optional] +**PublicKeyCertificate** | Pointer to **NullableString** | ManagedCluster publicKeyCertificate | [optional] + +## Methods + +### NewManagedClusterKeyPair + +`func NewManagedClusterKeyPair() *ManagedClusterKeyPair` + +NewManagedClusterKeyPair instantiates a new ManagedClusterKeyPair 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 + +### NewManagedClusterKeyPairWithDefaults + +`func NewManagedClusterKeyPairWithDefaults() *ManagedClusterKeyPair` + +NewManagedClusterKeyPairWithDefaults instantiates a new ManagedClusterKeyPair 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 + +### GetPublicKey + +`func (o *ManagedClusterKeyPair) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *ManagedClusterKeyPair) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *ManagedClusterKeyPair) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *ManagedClusterKeyPair) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### SetPublicKeyNil + +`func (o *ManagedClusterKeyPair) SetPublicKeyNil(b bool)` + + SetPublicKeyNil sets the value for PublicKey to be an explicit nil + +### UnsetPublicKey +`func (o *ManagedClusterKeyPair) UnsetPublicKey()` + +UnsetPublicKey ensures that no value is present for PublicKey, not even an explicit nil +### GetPublicKeyThumbprint + +`func (o *ManagedClusterKeyPair) GetPublicKeyThumbprint() string` + +GetPublicKeyThumbprint returns the PublicKeyThumbprint field if non-nil, zero value otherwise. + +### GetPublicKeyThumbprintOk + +`func (o *ManagedClusterKeyPair) GetPublicKeyThumbprintOk() (*string, bool)` + +GetPublicKeyThumbprintOk returns a tuple with the PublicKeyThumbprint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyThumbprint + +`func (o *ManagedClusterKeyPair) SetPublicKeyThumbprint(v string)` + +SetPublicKeyThumbprint sets PublicKeyThumbprint field to given value. + +### HasPublicKeyThumbprint + +`func (o *ManagedClusterKeyPair) HasPublicKeyThumbprint() bool` + +HasPublicKeyThumbprint returns a boolean if a field has been set. + +### SetPublicKeyThumbprintNil + +`func (o *ManagedClusterKeyPair) SetPublicKeyThumbprintNil(b bool)` + + SetPublicKeyThumbprintNil sets the value for PublicKeyThumbprint to be an explicit nil + +### UnsetPublicKeyThumbprint +`func (o *ManagedClusterKeyPair) UnsetPublicKeyThumbprint()` + +UnsetPublicKeyThumbprint ensures that no value is present for PublicKeyThumbprint, not even an explicit nil +### GetPublicKeyCertificate + +`func (o *ManagedClusterKeyPair) GetPublicKeyCertificate() string` + +GetPublicKeyCertificate returns the PublicKeyCertificate field if non-nil, zero value otherwise. + +### GetPublicKeyCertificateOk + +`func (o *ManagedClusterKeyPair) GetPublicKeyCertificateOk() (*string, bool)` + +GetPublicKeyCertificateOk returns a tuple with the PublicKeyCertificate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyCertificate + +`func (o *ManagedClusterKeyPair) SetPublicKeyCertificate(v string)` + +SetPublicKeyCertificate sets PublicKeyCertificate field to given value. + +### HasPublicKeyCertificate + +`func (o *ManagedClusterKeyPair) HasPublicKeyCertificate() bool` + +HasPublicKeyCertificate returns a boolean if a field has been set. + +### SetPublicKeyCertificateNil + +`func (o *ManagedClusterKeyPair) SetPublicKeyCertificateNil(b bool)` + + SetPublicKeyCertificateNil sets the value for PublicKeyCertificate to be an explicit nil + +### UnsetPublicKeyCertificate +`func (o *ManagedClusterKeyPair) UnsetPublicKeyCertificate()` + +UnsetPublicKeyCertificate ensures that no value is present for PublicKeyCertificate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterQueue.md b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterQueue.md new file mode 100644 index 000000000..3971027e5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterQueue.md @@ -0,0 +1,90 @@ +--- +id: v2024-managed-cluster-queue +title: ManagedClusterQueue +pagination_label: ManagedClusterQueue +sidebar_label: ManagedClusterQueue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterQueue', 'V2024ManagedClusterQueue'] +slug: /tools/sdk/go/v2024/models/managed-cluster-queue +tags: ['SDK', 'Software Development Kit', 'ManagedClusterQueue', 'V2024ManagedClusterQueue'] +--- + +# ManagedClusterQueue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | ManagedCluster queue name | [optional] +**Region** | Pointer to **string** | ManagedCluster queue aws region | [optional] + +## Methods + +### NewManagedClusterQueue + +`func NewManagedClusterQueue() *ManagedClusterQueue` + +NewManagedClusterQueue instantiates a new ManagedClusterQueue 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 + +### NewManagedClusterQueueWithDefaults + +`func NewManagedClusterQueueWithDefaults() *ManagedClusterQueue` + +NewManagedClusterQueueWithDefaults instantiates a new ManagedClusterQueue 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 + +### GetName + +`func (o *ManagedClusterQueue) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedClusterQueue) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedClusterQueue) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManagedClusterQueue) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetRegion + +`func (o *ManagedClusterQueue) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *ManagedClusterQueue) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *ManagedClusterQueue) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *ManagedClusterQueue) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterRedis.md b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterRedis.md new file mode 100644 index 000000000..b1e062935 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterRedis.md @@ -0,0 +1,90 @@ +--- +id: v2024-managed-cluster-redis +title: ManagedClusterRedis +pagination_label: ManagedClusterRedis +sidebar_label: ManagedClusterRedis +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterRedis', 'V2024ManagedClusterRedis'] +slug: /tools/sdk/go/v2024/models/managed-cluster-redis +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRedis', 'V2024ManagedClusterRedis'] +--- + +# ManagedClusterRedis + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RedisHost** | Pointer to **string** | ManagedCluster redisHost | [optional] +**RedisPort** | Pointer to **int32** | ManagedCluster redisPort | [optional] + +## Methods + +### NewManagedClusterRedis + +`func NewManagedClusterRedis() *ManagedClusterRedis` + +NewManagedClusterRedis instantiates a new ManagedClusterRedis 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 + +### NewManagedClusterRedisWithDefaults + +`func NewManagedClusterRedisWithDefaults() *ManagedClusterRedis` + +NewManagedClusterRedisWithDefaults instantiates a new ManagedClusterRedis 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 + +### GetRedisHost + +`func (o *ManagedClusterRedis) GetRedisHost() string` + +GetRedisHost returns the RedisHost field if non-nil, zero value otherwise. + +### GetRedisHostOk + +`func (o *ManagedClusterRedis) GetRedisHostOk() (*string, bool)` + +GetRedisHostOk returns a tuple with the RedisHost field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedisHost + +`func (o *ManagedClusterRedis) SetRedisHost(v string)` + +SetRedisHost sets RedisHost field to given value. + +### HasRedisHost + +`func (o *ManagedClusterRedis) HasRedisHost() bool` + +HasRedisHost returns a boolean if a field has been set. + +### GetRedisPort + +`func (o *ManagedClusterRedis) GetRedisPort() int32` + +GetRedisPort returns the RedisPort field if non-nil, zero value otherwise. + +### GetRedisPortOk + +`func (o *ManagedClusterRedis) GetRedisPortOk() (*int32, bool)` + +GetRedisPortOk returns a tuple with the RedisPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedisPort + +`func (o *ManagedClusterRedis) SetRedisPort(v int32)` + +SetRedisPort sets RedisPort field to given value. + +### HasRedisPort + +`func (o *ManagedClusterRedis) HasRedisPort() bool` + +HasRedisPort returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterRequest.md new file mode 100644 index 000000000..5d2629856 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterRequest.md @@ -0,0 +1,147 @@ +--- +id: v2024-managed-cluster-request +title: ManagedClusterRequest +pagination_label: ManagedClusterRequest +sidebar_label: ManagedClusterRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterRequest', 'V2024ManagedClusterRequest'] +slug: /tools/sdk/go/v2024/models/managed-cluster-request +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRequest', 'V2024ManagedClusterRequest'] +--- + +# ManagedClusterRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | ManagedCluster name | +**Type** | Pointer to [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**Configuration** | Pointer to **map[string]string** | ManagedProcess configuration map | [optional] +**Description** | Pointer to **NullableString** | ManagedCluster description | [optional] + +## Methods + +### NewManagedClusterRequest + +`func NewManagedClusterRequest(name string, ) *ManagedClusterRequest` + +NewManagedClusterRequest instantiates a new ManagedClusterRequest 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 + +### NewManagedClusterRequestWithDefaults + +`func NewManagedClusterRequestWithDefaults() *ManagedClusterRequest` + +NewManagedClusterRequestWithDefaults instantiates a new ManagedClusterRequest 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 + +### GetName + +`func (o *ManagedClusterRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedClusterRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedClusterRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *ManagedClusterRequest) GetType() ManagedClusterTypes` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClusterRequest) GetTypeOk() (*ManagedClusterTypes, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClusterRequest) SetType(v ManagedClusterTypes)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManagedClusterRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConfiguration + +`func (o *ManagedClusterRequest) GetConfiguration() map[string]string` + +GetConfiguration returns the Configuration field if non-nil, zero value otherwise. + +### GetConfigurationOk + +`func (o *ManagedClusterRequest) GetConfigurationOk() (*map[string]string, bool)` + +GetConfigurationOk returns a tuple with the Configuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfiguration + +`func (o *ManagedClusterRequest) SetConfiguration(v map[string]string)` + +SetConfiguration sets Configuration field to given value. + +### HasConfiguration + +`func (o *ManagedClusterRequest) HasConfiguration() bool` + +HasConfiguration returns a boolean if a field has been set. + +### GetDescription + +`func (o *ManagedClusterRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManagedClusterRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManagedClusterRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ManagedClusterRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ManagedClusterRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ManagedClusterRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterType.md b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterType.md new file mode 100644 index 000000000..7772887d3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterType.md @@ -0,0 +1,153 @@ +--- +id: v2024-managed-cluster-type +title: ManagedClusterType +pagination_label: ManagedClusterType +sidebar_label: ManagedClusterType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterType', 'V2024ManagedClusterType'] +slug: /tools/sdk/go/v2024/models/managed-cluster-type +tags: ['SDK', 'Software Development Kit', 'ManagedClusterType', 'V2024ManagedClusterType'] +--- + +# ManagedClusterType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ManagedClusterType ID | [optional] [readonly] +**Type** | **string** | ManagedClusterType type name | +**Pod** | **string** | ManagedClusterType pod | +**Org** | **string** | ManagedClusterType org | +**ManagedProcessIds** | Pointer to **[]string** | List of processes for the cluster type | [optional] + +## Methods + +### NewManagedClusterType + +`func NewManagedClusterType(type_ string, pod string, org string, ) *ManagedClusterType` + +NewManagedClusterType instantiates a new ManagedClusterType 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 + +### NewManagedClusterTypeWithDefaults + +`func NewManagedClusterTypeWithDefaults() *ManagedClusterType` + +NewManagedClusterTypeWithDefaults instantiates a new ManagedClusterType 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 + +### GetId + +`func (o *ManagedClusterType) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManagedClusterType) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManagedClusterType) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ManagedClusterType) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *ManagedClusterType) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClusterType) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClusterType) SetType(v string)` + +SetType sets Type field to given value. + + +### GetPod + +`func (o *ManagedClusterType) GetPod() string` + +GetPod returns the Pod field if non-nil, zero value otherwise. + +### GetPodOk + +`func (o *ManagedClusterType) GetPodOk() (*string, bool)` + +GetPodOk returns a tuple with the Pod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPod + +`func (o *ManagedClusterType) SetPod(v string)` + +SetPod sets Pod field to given value. + + +### GetOrg + +`func (o *ManagedClusterType) GetOrg() string` + +GetOrg returns the Org field if non-nil, zero value otherwise. + +### GetOrgOk + +`func (o *ManagedClusterType) GetOrgOk() (*string, bool)` + +GetOrgOk returns a tuple with the Org field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrg + +`func (o *ManagedClusterType) SetOrg(v string)` + +SetOrg sets Org field to given value. + + +### GetManagedProcessIds + +`func (o *ManagedClusterType) GetManagedProcessIds() []string` + +GetManagedProcessIds returns the ManagedProcessIds field if non-nil, zero value otherwise. + +### GetManagedProcessIdsOk + +`func (o *ManagedClusterType) GetManagedProcessIdsOk() (*[]string, bool)` + +GetManagedProcessIdsOk returns a tuple with the ManagedProcessIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagedProcessIds + +`func (o *ManagedClusterType) SetManagedProcessIds(v []string)` + +SetManagedProcessIds sets ManagedProcessIds field to given value. + +### HasManagedProcessIds + +`func (o *ManagedClusterType) HasManagedProcessIds() bool` + +HasManagedProcessIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterTypes.md b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterTypes.md new file mode 100644 index 000000000..e9059105b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterTypes.md @@ -0,0 +1,21 @@ +--- +id: v2024-managed-cluster-types +title: ManagedClusterTypes +pagination_label: ManagedClusterTypes +sidebar_label: ManagedClusterTypes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterTypes', 'V2024ManagedClusterTypes'] +slug: /tools/sdk/go/v2024/models/managed-cluster-types +tags: ['SDK', 'Software Development Kit', 'ManagedClusterTypes', 'V2024ManagedClusterTypes'] +--- + +# ManagedClusterTypes + +## Enum + + +* `IDN` (value: `"idn"`) + +* `IAI` (value: `"iai"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterUpdatePreferences.md b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterUpdatePreferences.md new file mode 100644 index 000000000..25866766b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManagedClusterUpdatePreferences.md @@ -0,0 +1,146 @@ +--- +id: v2024-managed-cluster-update-preferences +title: ManagedClusterUpdatePreferences +pagination_label: ManagedClusterUpdatePreferences +sidebar_label: ManagedClusterUpdatePreferences +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterUpdatePreferences', 'V2024ManagedClusterUpdatePreferences'] +slug: /tools/sdk/go/v2024/models/managed-cluster-update-preferences +tags: ['SDK', 'Software Development Kit', 'ManagedClusterUpdatePreferences', 'V2024ManagedClusterUpdatePreferences'] +--- + +# ManagedClusterUpdatePreferences + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProcessGroups** | Pointer to **NullableString** | The processGroups for updatePreferences | [optional] +**UpdateState** | Pointer to **NullableString** | The current updateState for the cluster | [optional] +**NotificationEmail** | Pointer to **NullableString** | The mail id to which new releases will be notified | [optional] + +## Methods + +### NewManagedClusterUpdatePreferences + +`func NewManagedClusterUpdatePreferences() *ManagedClusterUpdatePreferences` + +NewManagedClusterUpdatePreferences instantiates a new ManagedClusterUpdatePreferences 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 + +### NewManagedClusterUpdatePreferencesWithDefaults + +`func NewManagedClusterUpdatePreferencesWithDefaults() *ManagedClusterUpdatePreferences` + +NewManagedClusterUpdatePreferencesWithDefaults instantiates a new ManagedClusterUpdatePreferences 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 + +### GetProcessGroups + +`func (o *ManagedClusterUpdatePreferences) GetProcessGroups() string` + +GetProcessGroups returns the ProcessGroups field if non-nil, zero value otherwise. + +### GetProcessGroupsOk + +`func (o *ManagedClusterUpdatePreferences) GetProcessGroupsOk() (*string, bool)` + +GetProcessGroupsOk returns a tuple with the ProcessGroups field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessGroups + +`func (o *ManagedClusterUpdatePreferences) SetProcessGroups(v string)` + +SetProcessGroups sets ProcessGroups field to given value. + +### HasProcessGroups + +`func (o *ManagedClusterUpdatePreferences) HasProcessGroups() bool` + +HasProcessGroups returns a boolean if a field has been set. + +### SetProcessGroupsNil + +`func (o *ManagedClusterUpdatePreferences) SetProcessGroupsNil(b bool)` + + SetProcessGroupsNil sets the value for ProcessGroups to be an explicit nil + +### UnsetProcessGroups +`func (o *ManagedClusterUpdatePreferences) UnsetProcessGroups()` + +UnsetProcessGroups ensures that no value is present for ProcessGroups, not even an explicit nil +### GetUpdateState + +`func (o *ManagedClusterUpdatePreferences) GetUpdateState() string` + +GetUpdateState returns the UpdateState field if non-nil, zero value otherwise. + +### GetUpdateStateOk + +`func (o *ManagedClusterUpdatePreferences) GetUpdateStateOk() (*string, bool)` + +GetUpdateStateOk returns a tuple with the UpdateState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdateState + +`func (o *ManagedClusterUpdatePreferences) SetUpdateState(v string)` + +SetUpdateState sets UpdateState field to given value. + +### HasUpdateState + +`func (o *ManagedClusterUpdatePreferences) HasUpdateState() bool` + +HasUpdateState returns a boolean if a field has been set. + +### SetUpdateStateNil + +`func (o *ManagedClusterUpdatePreferences) SetUpdateStateNil(b bool)` + + SetUpdateStateNil sets the value for UpdateState to be an explicit nil + +### UnsetUpdateState +`func (o *ManagedClusterUpdatePreferences) UnsetUpdateState()` + +UnsetUpdateState ensures that no value is present for UpdateState, not even an explicit nil +### GetNotificationEmail + +`func (o *ManagedClusterUpdatePreferences) GetNotificationEmail() string` + +GetNotificationEmail returns the NotificationEmail field if non-nil, zero value otherwise. + +### GetNotificationEmailOk + +`func (o *ManagedClusterUpdatePreferences) GetNotificationEmailOk() (*string, bool)` + +GetNotificationEmailOk returns a tuple with the NotificationEmail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotificationEmail + +`func (o *ManagedClusterUpdatePreferences) SetNotificationEmail(v string)` + +SetNotificationEmail sets NotificationEmail field to given value. + +### HasNotificationEmail + +`func (o *ManagedClusterUpdatePreferences) HasNotificationEmail() bool` + +HasNotificationEmail returns a boolean if a field has been set. + +### SetNotificationEmailNil + +`func (o *ManagedClusterUpdatePreferences) SetNotificationEmailNil(b bool)` + + SetNotificationEmailNil sets the value for NotificationEmail to be an explicit nil + +### UnsetNotificationEmail +`func (o *ManagedClusterUpdatePreferences) UnsetNotificationEmail()` + +UnsetNotificationEmail ensures that no value is present for NotificationEmail, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManagerCorrelationMapping.md b/docs/tools/sdk/go/Reference/V2024/Models/ManagerCorrelationMapping.md new file mode 100644 index 000000000..d2701cd96 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManagerCorrelationMapping.md @@ -0,0 +1,90 @@ +--- +id: v2024-manager-correlation-mapping +title: ManagerCorrelationMapping +pagination_label: ManagerCorrelationMapping +sidebar_label: ManagerCorrelationMapping +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagerCorrelationMapping', 'V2024ManagerCorrelationMapping'] +slug: /tools/sdk/go/v2024/models/manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'ManagerCorrelationMapping', 'V2024ManagerCorrelationMapping'] +--- + +# ManagerCorrelationMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountAttributeName** | Pointer to **string** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**IdentityAttributeName** | Pointer to **string** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] + +## Methods + +### NewManagerCorrelationMapping + +`func NewManagerCorrelationMapping() *ManagerCorrelationMapping` + +NewManagerCorrelationMapping instantiates a new ManagerCorrelationMapping 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 + +### NewManagerCorrelationMappingWithDefaults + +`func NewManagerCorrelationMappingWithDefaults() *ManagerCorrelationMapping` + +NewManagerCorrelationMappingWithDefaults instantiates a new ManagerCorrelationMapping 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 + +### GetAccountAttributeName + +`func (o *ManagerCorrelationMapping) GetAccountAttributeName() string` + +GetAccountAttributeName returns the AccountAttributeName field if non-nil, zero value otherwise. + +### GetAccountAttributeNameOk + +`func (o *ManagerCorrelationMapping) GetAccountAttributeNameOk() (*string, bool)` + +GetAccountAttributeNameOk returns a tuple with the AccountAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountAttributeName + +`func (o *ManagerCorrelationMapping) SetAccountAttributeName(v string)` + +SetAccountAttributeName sets AccountAttributeName field to given value. + +### HasAccountAttributeName + +`func (o *ManagerCorrelationMapping) HasAccountAttributeName() bool` + +HasAccountAttributeName returns a boolean if a field has been set. + +### GetIdentityAttributeName + +`func (o *ManagerCorrelationMapping) GetIdentityAttributeName() string` + +GetIdentityAttributeName returns the IdentityAttributeName field if non-nil, zero value otherwise. + +### GetIdentityAttributeNameOk + +`func (o *ManagerCorrelationMapping) GetIdentityAttributeNameOk() (*string, bool)` + +GetIdentityAttributeNameOk returns a tuple with the IdentityAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeName + +`func (o *ManagerCorrelationMapping) SetIdentityAttributeName(v string)` + +SetIdentityAttributeName sets IdentityAttributeName field to given value. + +### HasIdentityAttributeName + +`func (o *ManagerCorrelationMapping) HasIdentityAttributeName() bool` + +HasIdentityAttributeName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManualDiscoverApplications.md b/docs/tools/sdk/go/Reference/V2024/Models/ManualDiscoverApplications.md new file mode 100644 index 000000000..5960e02a7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManualDiscoverApplications.md @@ -0,0 +1,59 @@ +--- +id: v2024-manual-discover-applications +title: ManualDiscoverApplications +pagination_label: ManualDiscoverApplications +sidebar_label: ManualDiscoverApplications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualDiscoverApplications', 'V2024ManualDiscoverApplications'] +slug: /tools/sdk/go/v2024/models/manual-discover-applications +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplications', 'V2024ManualDiscoverApplications'] +--- + +# ManualDiscoverApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | ***os.File** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | + +## Methods + +### NewManualDiscoverApplications + +`func NewManualDiscoverApplications(file *os.File, ) *ManualDiscoverApplications` + +NewManualDiscoverApplications instantiates a new ManualDiscoverApplications 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 + +### NewManualDiscoverApplicationsWithDefaults + +`func NewManualDiscoverApplicationsWithDefaults() *ManualDiscoverApplications` + +NewManualDiscoverApplicationsWithDefaults instantiates a new ManualDiscoverApplications 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 + +### GetFile + +`func (o *ManualDiscoverApplications) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *ManualDiscoverApplications) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *ManualDiscoverApplications) SetFile(v *os.File)` + +SetFile sets File field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManualDiscoverApplicationsTemplate.md b/docs/tools/sdk/go/Reference/V2024/Models/ManualDiscoverApplicationsTemplate.md new file mode 100644 index 000000000..2a2da4a99 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManualDiscoverApplicationsTemplate.md @@ -0,0 +1,90 @@ +--- +id: v2024-manual-discover-applications-template +title: ManualDiscoverApplicationsTemplate +pagination_label: ManualDiscoverApplicationsTemplate +sidebar_label: ManualDiscoverApplicationsTemplate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualDiscoverApplicationsTemplate', 'V2024ManualDiscoverApplicationsTemplate'] +slug: /tools/sdk/go/v2024/models/manual-discover-applications-template +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplicationsTemplate', 'V2024ManualDiscoverApplicationsTemplate'] +--- + +# ManualDiscoverApplicationsTemplate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationName** | Pointer to **string** | Name of the application. | [optional] +**Description** | Pointer to **string** | Description of the application. | [optional] + +## Methods + +### NewManualDiscoverApplicationsTemplate + +`func NewManualDiscoverApplicationsTemplate() *ManualDiscoverApplicationsTemplate` + +NewManualDiscoverApplicationsTemplate instantiates a new ManualDiscoverApplicationsTemplate 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 + +### NewManualDiscoverApplicationsTemplateWithDefaults + +`func NewManualDiscoverApplicationsTemplateWithDefaults() *ManualDiscoverApplicationsTemplate` + +NewManualDiscoverApplicationsTemplateWithDefaults instantiates a new ManualDiscoverApplicationsTemplate 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 + +### GetApplicationName + +`func (o *ManualDiscoverApplicationsTemplate) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *ManualDiscoverApplicationsTemplate) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *ManualDiscoverApplicationsTemplate) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *ManualDiscoverApplicationsTemplate) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ManualDiscoverApplicationsTemplate) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManualDiscoverApplicationsTemplate) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManualDiscoverApplicationsTemplate) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ManualDiscoverApplicationsTemplate) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManualWorkItemDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/ManualWorkItemDetails.md new file mode 100644 index 000000000..1d54710d2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManualWorkItemDetails.md @@ -0,0 +1,224 @@ +--- +id: v2024-manual-work-item-details +title: ManualWorkItemDetails +pagination_label: ManualWorkItemDetails +sidebar_label: ManualWorkItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualWorkItemDetails', 'V2024ManualWorkItemDetails'] +slug: /tools/sdk/go/v2024/models/manual-work-item-details +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetails', 'V2024ManualWorkItemDetails'] +--- + +# ManualWorkItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Forwarded** | Pointer to **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to false] +**OriginalOwner** | Pointer to [**NullableManualWorkItemDetailsOriginalOwner**](manual-work-item-details-original-owner) | | [optional] +**CurrentOwner** | Pointer to [**NullableManualWorkItemDetailsCurrentOwner**](manual-work-item-details-current-owner) | | [optional] +**Modified** | Pointer to **SailPointTime** | Time at which item was modified. | [optional] +**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] + +## Methods + +### NewManualWorkItemDetails + +`func NewManualWorkItemDetails() *ManualWorkItemDetails` + +NewManualWorkItemDetails instantiates a new ManualWorkItemDetails 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 + +### NewManualWorkItemDetailsWithDefaults + +`func NewManualWorkItemDetailsWithDefaults() *ManualWorkItemDetails` + +NewManualWorkItemDetailsWithDefaults instantiates a new ManualWorkItemDetails 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 + +### GetForwarded + +`func (o *ManualWorkItemDetails) GetForwarded() bool` + +GetForwarded returns the Forwarded field if non-nil, zero value otherwise. + +### GetForwardedOk + +`func (o *ManualWorkItemDetails) GetForwardedOk() (*bool, bool)` + +GetForwardedOk returns a tuple with the Forwarded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwarded + +`func (o *ManualWorkItemDetails) SetForwarded(v bool)` + +SetForwarded sets Forwarded field to given value. + +### HasForwarded + +`func (o *ManualWorkItemDetails) HasForwarded() bool` + +HasForwarded returns a boolean if a field has been set. + +### GetOriginalOwner + +`func (o *ManualWorkItemDetails) GetOriginalOwner() ManualWorkItemDetailsOriginalOwner` + +GetOriginalOwner returns the OriginalOwner field if non-nil, zero value otherwise. + +### GetOriginalOwnerOk + +`func (o *ManualWorkItemDetails) GetOriginalOwnerOk() (*ManualWorkItemDetailsOriginalOwner, bool)` + +GetOriginalOwnerOk returns a tuple with the OriginalOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalOwner + +`func (o *ManualWorkItemDetails) SetOriginalOwner(v ManualWorkItemDetailsOriginalOwner)` + +SetOriginalOwner sets OriginalOwner field to given value. + +### HasOriginalOwner + +`func (o *ManualWorkItemDetails) HasOriginalOwner() bool` + +HasOriginalOwner returns a boolean if a field has been set. + +### SetOriginalOwnerNil + +`func (o *ManualWorkItemDetails) SetOriginalOwnerNil(b bool)` + + SetOriginalOwnerNil sets the value for OriginalOwner to be an explicit nil + +### UnsetOriginalOwner +`func (o *ManualWorkItemDetails) UnsetOriginalOwner()` + +UnsetOriginalOwner ensures that no value is present for OriginalOwner, not even an explicit nil +### GetCurrentOwner + +`func (o *ManualWorkItemDetails) GetCurrentOwner() ManualWorkItemDetailsCurrentOwner` + +GetCurrentOwner returns the CurrentOwner field if non-nil, zero value otherwise. + +### GetCurrentOwnerOk + +`func (o *ManualWorkItemDetails) GetCurrentOwnerOk() (*ManualWorkItemDetailsCurrentOwner, bool)` + +GetCurrentOwnerOk returns a tuple with the CurrentOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentOwner + +`func (o *ManualWorkItemDetails) SetCurrentOwner(v ManualWorkItemDetailsCurrentOwner)` + +SetCurrentOwner sets CurrentOwner field to given value. + +### HasCurrentOwner + +`func (o *ManualWorkItemDetails) HasCurrentOwner() bool` + +HasCurrentOwner returns a boolean if a field has been set. + +### SetCurrentOwnerNil + +`func (o *ManualWorkItemDetails) SetCurrentOwnerNil(b bool)` + + SetCurrentOwnerNil sets the value for CurrentOwner to be an explicit nil + +### UnsetCurrentOwner +`func (o *ManualWorkItemDetails) UnsetCurrentOwner()` + +UnsetCurrentOwner ensures that no value is present for CurrentOwner, not even an explicit nil +### GetModified + +`func (o *ManualWorkItemDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ManualWorkItemDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ManualWorkItemDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ManualWorkItemDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetStatus + +`func (o *ManualWorkItemDetails) GetStatus() ManualWorkItemState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManualWorkItemDetails) GetStatusOk() (*ManualWorkItemState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManualWorkItemDetails) SetStatus(v ManualWorkItemState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ManualWorkItemDetails) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetForwardHistory + +`func (o *ManualWorkItemDetails) GetForwardHistory() []ApprovalForwardHistory` + +GetForwardHistory returns the ForwardHistory field if non-nil, zero value otherwise. + +### GetForwardHistoryOk + +`func (o *ManualWorkItemDetails) GetForwardHistoryOk() (*[]ApprovalForwardHistory, bool)` + +GetForwardHistoryOk returns a tuple with the ForwardHistory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwardHistory + +`func (o *ManualWorkItemDetails) SetForwardHistory(v []ApprovalForwardHistory)` + +SetForwardHistory sets ForwardHistory field to given value. + +### HasForwardHistory + +`func (o *ManualWorkItemDetails) HasForwardHistory() bool` + +HasForwardHistory returns a boolean if a field has been set. + +### SetForwardHistoryNil + +`func (o *ManualWorkItemDetails) SetForwardHistoryNil(b bool)` + + SetForwardHistoryNil sets the value for ForwardHistory to be an explicit nil + +### UnsetForwardHistory +`func (o *ManualWorkItemDetails) UnsetForwardHistory()` + +UnsetForwardHistory ensures that no value is present for ForwardHistory, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManualWorkItemDetailsCurrentOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/ManualWorkItemDetailsCurrentOwner.md new file mode 100644 index 000000000..f07ef7c31 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManualWorkItemDetailsCurrentOwner.md @@ -0,0 +1,116 @@ +--- +id: v2024-manual-work-item-details-current-owner +title: ManualWorkItemDetailsCurrentOwner +pagination_label: ManualWorkItemDetailsCurrentOwner +sidebar_label: ManualWorkItemDetailsCurrentOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualWorkItemDetailsCurrentOwner', 'V2024ManualWorkItemDetailsCurrentOwner'] +slug: /tools/sdk/go/v2024/models/manual-work-item-details-current-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsCurrentOwner', 'V2024ManualWorkItemDetailsCurrentOwner'] +--- + +# ManualWorkItemDetailsCurrentOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of current work item owner's identity. | [optional] +**Id** | Pointer to **string** | ID of current work item owner's identity. | [optional] +**Name** | Pointer to **string** | Display name of current work item owner. | [optional] + +## Methods + +### NewManualWorkItemDetailsCurrentOwner + +`func NewManualWorkItemDetailsCurrentOwner() *ManualWorkItemDetailsCurrentOwner` + +NewManualWorkItemDetailsCurrentOwner instantiates a new ManualWorkItemDetailsCurrentOwner 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 + +### NewManualWorkItemDetailsCurrentOwnerWithDefaults + +`func NewManualWorkItemDetailsCurrentOwnerWithDefaults() *ManualWorkItemDetailsCurrentOwner` + +NewManualWorkItemDetailsCurrentOwnerWithDefaults instantiates a new ManualWorkItemDetailsCurrentOwner 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 + +### GetType + +`func (o *ManualWorkItemDetailsCurrentOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManualWorkItemDetailsCurrentOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManualWorkItemDetailsCurrentOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManualWorkItemDetailsCurrentOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ManualWorkItemDetailsCurrentOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManualWorkItemDetailsCurrentOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManualWorkItemDetailsCurrentOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ManualWorkItemDetailsCurrentOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ManualWorkItemDetailsCurrentOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManualWorkItemDetailsCurrentOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManualWorkItemDetailsCurrentOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManualWorkItemDetailsCurrentOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManualWorkItemDetailsOriginalOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/ManualWorkItemDetailsOriginalOwner.md new file mode 100644 index 000000000..c2a8077d4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManualWorkItemDetailsOriginalOwner.md @@ -0,0 +1,116 @@ +--- +id: v2024-manual-work-item-details-original-owner +title: ManualWorkItemDetailsOriginalOwner +pagination_label: ManualWorkItemDetailsOriginalOwner +sidebar_label: ManualWorkItemDetailsOriginalOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualWorkItemDetailsOriginalOwner', 'V2024ManualWorkItemDetailsOriginalOwner'] +slug: /tools/sdk/go/v2024/models/manual-work-item-details-original-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsOriginalOwner', 'V2024ManualWorkItemDetailsOriginalOwner'] +--- + +# ManualWorkItemDetailsOriginalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of original work item owner's identity. | [optional] +**Id** | Pointer to **string** | ID of original work item owner's identity. | [optional] +**Name** | Pointer to **string** | Display name of original work item owner. | [optional] + +## Methods + +### NewManualWorkItemDetailsOriginalOwner + +`func NewManualWorkItemDetailsOriginalOwner() *ManualWorkItemDetailsOriginalOwner` + +NewManualWorkItemDetailsOriginalOwner instantiates a new ManualWorkItemDetailsOriginalOwner 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 + +### NewManualWorkItemDetailsOriginalOwnerWithDefaults + +`func NewManualWorkItemDetailsOriginalOwnerWithDefaults() *ManualWorkItemDetailsOriginalOwner` + +NewManualWorkItemDetailsOriginalOwnerWithDefaults instantiates a new ManualWorkItemDetailsOriginalOwner 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 + +### GetType + +`func (o *ManualWorkItemDetailsOriginalOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManualWorkItemDetailsOriginalOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManualWorkItemDetailsOriginalOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManualWorkItemDetailsOriginalOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ManualWorkItemDetailsOriginalOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManualWorkItemDetailsOriginalOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManualWorkItemDetailsOriginalOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ManualWorkItemDetailsOriginalOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ManualWorkItemDetailsOriginalOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManualWorkItemDetailsOriginalOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManualWorkItemDetailsOriginalOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManualWorkItemDetailsOriginalOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ManualWorkItemState.md b/docs/tools/sdk/go/Reference/V2024/Models/ManualWorkItemState.md new file mode 100644 index 000000000..fd6fd33c2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ManualWorkItemState.md @@ -0,0 +1,29 @@ +--- +id: v2024-manual-work-item-state +title: ManualWorkItemState +pagination_label: ManualWorkItemState +sidebar_label: ManualWorkItemState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualWorkItemState', 'V2024ManualWorkItemState'] +slug: /tools/sdk/go/v2024/models/manual-work-item-state +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemState', 'V2024ManualWorkItemState'] +--- + +# ManualWorkItemState + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `EXPIRED` (value: `"EXPIRED"`) + +* `CANCELLED` (value: `"CANCELLED"`) + +* `ARCHIVED` (value: `"ARCHIVED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MatchTerm.md b/docs/tools/sdk/go/Reference/V2024/Models/MatchTerm.md new file mode 100644 index 000000000..b04967e23 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MatchTerm.md @@ -0,0 +1,204 @@ +--- +id: v2024-match-term +title: MatchTerm +pagination_label: MatchTerm +sidebar_label: MatchTerm +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MatchTerm', 'V2024MatchTerm'] +slug: /tools/sdk/go/v2024/models/match-term +tags: ['SDK', 'Software Development Kit', 'MatchTerm', 'V2024MatchTerm'] +--- + +# MatchTerm + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The attribute name | [optional] +**Value** | Pointer to **string** | The attribute value | [optional] +**Op** | Pointer to **string** | The operator between name and value | [optional] +**Container** | Pointer to **bool** | If it is a container or a real match term | [optional] [default to false] +**And** | Pointer to **bool** | If it is AND logical operator for the children match terms | [optional] [default to false] +**Children** | Pointer to **[]map[string]interface{}** | The children under this match term | [optional] + +## Methods + +### NewMatchTerm + +`func NewMatchTerm() *MatchTerm` + +NewMatchTerm instantiates a new MatchTerm 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 + +### NewMatchTermWithDefaults + +`func NewMatchTermWithDefaults() *MatchTerm` + +NewMatchTermWithDefaults instantiates a new MatchTerm 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 + +### GetName + +`func (o *MatchTerm) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MatchTerm) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MatchTerm) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MatchTerm) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValue + +`func (o *MatchTerm) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *MatchTerm) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *MatchTerm) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *MatchTerm) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetOp + +`func (o *MatchTerm) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *MatchTerm) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *MatchTerm) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *MatchTerm) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetContainer + +`func (o *MatchTerm) GetContainer() bool` + +GetContainer returns the Container field if non-nil, zero value otherwise. + +### GetContainerOk + +`func (o *MatchTerm) GetContainerOk() (*bool, bool)` + +GetContainerOk returns a tuple with the Container field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainer + +`func (o *MatchTerm) SetContainer(v bool)` + +SetContainer sets Container field to given value. + +### HasContainer + +`func (o *MatchTerm) HasContainer() bool` + +HasContainer returns a boolean if a field has been set. + +### GetAnd + +`func (o *MatchTerm) GetAnd() bool` + +GetAnd returns the And field if non-nil, zero value otherwise. + +### GetAndOk + +`func (o *MatchTerm) GetAndOk() (*bool, bool)` + +GetAndOk returns a tuple with the And field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnd + +`func (o *MatchTerm) SetAnd(v bool)` + +SetAnd sets And field to given value. + +### HasAnd + +`func (o *MatchTerm) HasAnd() bool` + +HasAnd returns a boolean if a field has been set. + +### GetChildren + +`func (o *MatchTerm) GetChildren() []map[string]interface{}` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *MatchTerm) GetChildrenOk() (*[]map[string]interface{}, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *MatchTerm) SetChildren(v []map[string]interface{})` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *MatchTerm) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *MatchTerm) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *MatchTerm) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Medium.md b/docs/tools/sdk/go/Reference/V2024/Models/Medium.md new file mode 100644 index 000000000..5519cd81a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Medium.md @@ -0,0 +1,27 @@ +--- +id: v2024-medium +title: Medium +pagination_label: Medium +sidebar_label: Medium +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Medium', 'V2024Medium'] +slug: /tools/sdk/go/v2024/models/medium +tags: ['SDK', 'Software Development Kit', 'Medium', 'V2024Medium'] +--- + +# Medium + +## Enum + + +* `EMAIL` (value: `"EMAIL"`) + +* `SMS` (value: `"SMS"`) + +* `PHONE` (value: `"PHONE"`) + +* `SLACK` (value: `"SLACK"`) + +* `TEAMS` (value: `"TEAMS"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MembershipType.md b/docs/tools/sdk/go/Reference/V2024/Models/MembershipType.md new file mode 100644 index 000000000..a54f6e1f2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MembershipType.md @@ -0,0 +1,23 @@ +--- +id: v2024-membership-type +title: MembershipType +pagination_label: MembershipType +sidebar_label: MembershipType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MembershipType', 'V2024MembershipType'] +slug: /tools/sdk/go/v2024/models/membership-type +tags: ['SDK', 'Software Development Kit', 'MembershipType', 'V2024MembershipType'] +--- + +# MembershipType + +## Enum + + +* `ALL` (value: `"ALL"`) + +* `FILTER` (value: `"FILTER"`) + +* `SELECTION` (value: `"SELECTION"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MetricAggregation.md b/docs/tools/sdk/go/Reference/V2024/Models/MetricAggregation.md new file mode 100644 index 000000000..d29b23eb0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MetricAggregation.md @@ -0,0 +1,106 @@ +--- +id: v2024-metric-aggregation +title: MetricAggregation +pagination_label: MetricAggregation +sidebar_label: MetricAggregation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MetricAggregation', 'V2024MetricAggregation'] +slug: /tools/sdk/go/v2024/models/metric-aggregation +tags: ['SDK', 'Software Development Kit', 'MetricAggregation', 'V2024MetricAggregation'] +--- + +# MetricAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the metric aggregate to be included in the result. If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. | +**Type** | Pointer to [**MetricType**](metric-type) | | [optional] [default to METRICTYPE_UNIQUE_COUNT] +**Field** | **string** | The field the calculation is performed on. Prefix the field name with '@' to reference a nested object. | + +## Methods + +### NewMetricAggregation + +`func NewMetricAggregation(name string, field string, ) *MetricAggregation` + +NewMetricAggregation instantiates a new MetricAggregation 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 + +### NewMetricAggregationWithDefaults + +`func NewMetricAggregationWithDefaults() *MetricAggregation` + +NewMetricAggregationWithDefaults instantiates a new MetricAggregation 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 + +### GetName + +`func (o *MetricAggregation) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MetricAggregation) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MetricAggregation) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *MetricAggregation) GetType() MetricType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MetricAggregation) GetTypeOk() (*MetricType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MetricAggregation) SetType(v MetricType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MetricAggregation) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetField + +`func (o *MetricAggregation) GetField() string` + +GetField returns the Field field if non-nil, zero value otherwise. + +### GetFieldOk + +`func (o *MetricAggregation) GetFieldOk() (*string, bool)` + +GetFieldOk returns a tuple with the Field field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetField + +`func (o *MetricAggregation) SetField(v string)` + +SetField sets Field field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MetricResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/MetricResponse.md new file mode 100644 index 000000000..5d3fd774d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MetricResponse.md @@ -0,0 +1,90 @@ +--- +id: v2024-metric-response +title: MetricResponse +pagination_label: MetricResponse +sidebar_label: MetricResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MetricResponse', 'V2024MetricResponse'] +slug: /tools/sdk/go/v2024/models/metric-response +tags: ['SDK', 'Software Development Kit', 'MetricResponse', 'V2024MetricResponse'] +--- + +# MetricResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | the name of metric | [optional] +**Value** | Pointer to **float32** | the value associated to the metric | [optional] + +## Methods + +### NewMetricResponse + +`func NewMetricResponse() *MetricResponse` + +NewMetricResponse instantiates a new MetricResponse 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 + +### NewMetricResponseWithDefaults + +`func NewMetricResponseWithDefaults() *MetricResponse` + +NewMetricResponseWithDefaults instantiates a new MetricResponse 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 + +### GetName + +`func (o *MetricResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MetricResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MetricResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MetricResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValue + +`func (o *MetricResponse) GetValue() float32` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *MetricResponse) GetValueOk() (*float32, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *MetricResponse) SetValue(v float32)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *MetricResponse) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MetricType.md b/docs/tools/sdk/go/Reference/V2024/Models/MetricType.md new file mode 100644 index 000000000..573e033aa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MetricType.md @@ -0,0 +1,31 @@ +--- +id: v2024-metric-type +title: MetricType +pagination_label: MetricType +sidebar_label: MetricType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MetricType', 'V2024MetricType'] +slug: /tools/sdk/go/v2024/models/metric-type +tags: ['SDK', 'Software Development Kit', 'MetricType', 'V2024MetricType'] +--- + +# MetricType + +## Enum + + +* `COUNT` (value: `"COUNT"`) + +* `UNIQUE_COUNT` (value: `"UNIQUE_COUNT"`) + +* `AVG` (value: `"AVG"`) + +* `SUM` (value: `"SUM"`) + +* `MEDIAN` (value: `"MEDIAN"`) + +* `MIN` (value: `"MIN"`) + +* `MAX` (value: `"MAX"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MfaConfigTestResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/MfaConfigTestResponse.md new file mode 100644 index 000000000..e5d77b441 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MfaConfigTestResponse.md @@ -0,0 +1,90 @@ +--- +id: v2024-mfa-config-test-response +title: MfaConfigTestResponse +pagination_label: MfaConfigTestResponse +sidebar_label: MfaConfigTestResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MfaConfigTestResponse', 'V2024MfaConfigTestResponse'] +slug: /tools/sdk/go/v2024/models/mfa-config-test-response +tags: ['SDK', 'Software Development Kit', 'MfaConfigTestResponse', 'V2024MfaConfigTestResponse'] +--- + +# MfaConfigTestResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **string** | The configuration test result. | [optional] [readonly] +**Error** | Pointer to **string** | The error message to indicate the failure of configuration test. | [optional] [readonly] + +## Methods + +### NewMfaConfigTestResponse + +`func NewMfaConfigTestResponse() *MfaConfigTestResponse` + +NewMfaConfigTestResponse instantiates a new MfaConfigTestResponse 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 + +### NewMfaConfigTestResponseWithDefaults + +`func NewMfaConfigTestResponseWithDefaults() *MfaConfigTestResponse` + +NewMfaConfigTestResponseWithDefaults instantiates a new MfaConfigTestResponse 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 + +### GetState + +`func (o *MfaConfigTestResponse) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *MfaConfigTestResponse) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *MfaConfigTestResponse) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *MfaConfigTestResponse) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetError + +`func (o *MfaConfigTestResponse) GetError() string` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *MfaConfigTestResponse) GetErrorOk() (*string, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *MfaConfigTestResponse) SetError(v string)` + +SetError sets Error field to given value. + +### HasError + +`func (o *MfaConfigTestResponse) HasError() bool` + +HasError returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MfaDuoConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/MfaDuoConfig.md new file mode 100644 index 000000000..070e77eff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MfaDuoConfig.md @@ -0,0 +1,244 @@ +--- +id: v2024-mfa-duo-config +title: MfaDuoConfig +pagination_label: MfaDuoConfig +sidebar_label: MfaDuoConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MfaDuoConfig', 'V2024MfaDuoConfig'] +slug: /tools/sdk/go/v2024/models/mfa-duo-config +tags: ['SDK', 'Software Development Kit', 'MfaDuoConfig', 'V2024MfaDuoConfig'] +--- + +# MfaDuoConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MfaMethod** | Pointer to **NullableString** | Mfa method name | [optional] +**Enabled** | Pointer to **bool** | If MFA method is enabled. | [optional] [default to false] +**Host** | Pointer to **NullableString** | The server host name or IP address of the MFA provider. | [optional] +**AccessKey** | Pointer to **NullableString** | The secret key for authenticating requests to the MFA provider. | [optional] +**IdentityAttribute** | Pointer to **NullableString** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] +**ConfigProperties** | Pointer to **map[string]interface{}** | A map with additional config properties for the given MFA method - duo-web. | [optional] + +## Methods + +### NewMfaDuoConfig + +`func NewMfaDuoConfig() *MfaDuoConfig` + +NewMfaDuoConfig instantiates a new MfaDuoConfig 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 + +### NewMfaDuoConfigWithDefaults + +`func NewMfaDuoConfigWithDefaults() *MfaDuoConfig` + +NewMfaDuoConfigWithDefaults instantiates a new MfaDuoConfig 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 + +### GetMfaMethod + +`func (o *MfaDuoConfig) GetMfaMethod() string` + +GetMfaMethod returns the MfaMethod field if non-nil, zero value otherwise. + +### GetMfaMethodOk + +`func (o *MfaDuoConfig) GetMfaMethodOk() (*string, bool)` + +GetMfaMethodOk returns a tuple with the MfaMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMfaMethod + +`func (o *MfaDuoConfig) SetMfaMethod(v string)` + +SetMfaMethod sets MfaMethod field to given value. + +### HasMfaMethod + +`func (o *MfaDuoConfig) HasMfaMethod() bool` + +HasMfaMethod returns a boolean if a field has been set. + +### SetMfaMethodNil + +`func (o *MfaDuoConfig) SetMfaMethodNil(b bool)` + + SetMfaMethodNil sets the value for MfaMethod to be an explicit nil + +### UnsetMfaMethod +`func (o *MfaDuoConfig) UnsetMfaMethod()` + +UnsetMfaMethod ensures that no value is present for MfaMethod, not even an explicit nil +### GetEnabled + +`func (o *MfaDuoConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *MfaDuoConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *MfaDuoConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *MfaDuoConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetHost + +`func (o *MfaDuoConfig) GetHost() string` + +GetHost returns the Host field if non-nil, zero value otherwise. + +### GetHostOk + +`func (o *MfaDuoConfig) GetHostOk() (*string, bool)` + +GetHostOk returns a tuple with the Host field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHost + +`func (o *MfaDuoConfig) SetHost(v string)` + +SetHost sets Host field to given value. + +### HasHost + +`func (o *MfaDuoConfig) HasHost() bool` + +HasHost returns a boolean if a field has been set. + +### SetHostNil + +`func (o *MfaDuoConfig) SetHostNil(b bool)` + + SetHostNil sets the value for Host to be an explicit nil + +### UnsetHost +`func (o *MfaDuoConfig) UnsetHost()` + +UnsetHost ensures that no value is present for Host, not even an explicit nil +### GetAccessKey + +`func (o *MfaDuoConfig) GetAccessKey() string` + +GetAccessKey returns the AccessKey field if non-nil, zero value otherwise. + +### GetAccessKeyOk + +`func (o *MfaDuoConfig) GetAccessKeyOk() (*string, bool)` + +GetAccessKeyOk returns a tuple with the AccessKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessKey + +`func (o *MfaDuoConfig) SetAccessKey(v string)` + +SetAccessKey sets AccessKey field to given value. + +### HasAccessKey + +`func (o *MfaDuoConfig) HasAccessKey() bool` + +HasAccessKey returns a boolean if a field has been set. + +### SetAccessKeyNil + +`func (o *MfaDuoConfig) SetAccessKeyNil(b bool)` + + SetAccessKeyNil sets the value for AccessKey to be an explicit nil + +### UnsetAccessKey +`func (o *MfaDuoConfig) UnsetAccessKey()` + +UnsetAccessKey ensures that no value is present for AccessKey, not even an explicit nil +### GetIdentityAttribute + +`func (o *MfaDuoConfig) GetIdentityAttribute() string` + +GetIdentityAttribute returns the IdentityAttribute field if non-nil, zero value otherwise. + +### GetIdentityAttributeOk + +`func (o *MfaDuoConfig) GetIdentityAttributeOk() (*string, bool)` + +GetIdentityAttributeOk returns a tuple with the IdentityAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttribute + +`func (o *MfaDuoConfig) SetIdentityAttribute(v string)` + +SetIdentityAttribute sets IdentityAttribute field to given value. + +### HasIdentityAttribute + +`func (o *MfaDuoConfig) HasIdentityAttribute() bool` + +HasIdentityAttribute returns a boolean if a field has been set. + +### SetIdentityAttributeNil + +`func (o *MfaDuoConfig) SetIdentityAttributeNil(b bool)` + + SetIdentityAttributeNil sets the value for IdentityAttribute to be an explicit nil + +### UnsetIdentityAttribute +`func (o *MfaDuoConfig) UnsetIdentityAttribute()` + +UnsetIdentityAttribute ensures that no value is present for IdentityAttribute, not even an explicit nil +### GetConfigProperties + +`func (o *MfaDuoConfig) GetConfigProperties() map[string]interface{}` + +GetConfigProperties returns the ConfigProperties field if non-nil, zero value otherwise. + +### GetConfigPropertiesOk + +`func (o *MfaDuoConfig) GetConfigPropertiesOk() (*map[string]interface{}, bool)` + +GetConfigPropertiesOk returns a tuple with the ConfigProperties field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigProperties + +`func (o *MfaDuoConfig) SetConfigProperties(v map[string]interface{})` + +SetConfigProperties sets ConfigProperties field to given value. + +### HasConfigProperties + +`func (o *MfaDuoConfig) HasConfigProperties() bool` + +HasConfigProperties returns a boolean if a field has been set. + +### SetConfigPropertiesNil + +`func (o *MfaDuoConfig) SetConfigPropertiesNil(b bool)` + + SetConfigPropertiesNil sets the value for ConfigProperties to be an explicit nil + +### UnsetConfigProperties +`func (o *MfaDuoConfig) UnsetConfigProperties()` + +UnsetConfigProperties ensures that no value is present for ConfigProperties, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MfaOktaConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/MfaOktaConfig.md new file mode 100644 index 000000000..ff2ab78b1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MfaOktaConfig.md @@ -0,0 +1,208 @@ +--- +id: v2024-mfa-okta-config +title: MfaOktaConfig +pagination_label: MfaOktaConfig +sidebar_label: MfaOktaConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MfaOktaConfig', 'V2024MfaOktaConfig'] +slug: /tools/sdk/go/v2024/models/mfa-okta-config +tags: ['SDK', 'Software Development Kit', 'MfaOktaConfig', 'V2024MfaOktaConfig'] +--- + +# MfaOktaConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MfaMethod** | Pointer to **NullableString** | Mfa method name | [optional] +**Enabled** | Pointer to **bool** | If MFA method is enabled. | [optional] [default to false] +**Host** | Pointer to **NullableString** | The server host name or IP address of the MFA provider. | [optional] +**AccessKey** | Pointer to **NullableString** | The secret key for authenticating requests to the MFA provider. | [optional] +**IdentityAttribute** | Pointer to **NullableString** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] + +## Methods + +### NewMfaOktaConfig + +`func NewMfaOktaConfig() *MfaOktaConfig` + +NewMfaOktaConfig instantiates a new MfaOktaConfig 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 + +### NewMfaOktaConfigWithDefaults + +`func NewMfaOktaConfigWithDefaults() *MfaOktaConfig` + +NewMfaOktaConfigWithDefaults instantiates a new MfaOktaConfig 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 + +### GetMfaMethod + +`func (o *MfaOktaConfig) GetMfaMethod() string` + +GetMfaMethod returns the MfaMethod field if non-nil, zero value otherwise. + +### GetMfaMethodOk + +`func (o *MfaOktaConfig) GetMfaMethodOk() (*string, bool)` + +GetMfaMethodOk returns a tuple with the MfaMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMfaMethod + +`func (o *MfaOktaConfig) SetMfaMethod(v string)` + +SetMfaMethod sets MfaMethod field to given value. + +### HasMfaMethod + +`func (o *MfaOktaConfig) HasMfaMethod() bool` + +HasMfaMethod returns a boolean if a field has been set. + +### SetMfaMethodNil + +`func (o *MfaOktaConfig) SetMfaMethodNil(b bool)` + + SetMfaMethodNil sets the value for MfaMethod to be an explicit nil + +### UnsetMfaMethod +`func (o *MfaOktaConfig) UnsetMfaMethod()` + +UnsetMfaMethod ensures that no value is present for MfaMethod, not even an explicit nil +### GetEnabled + +`func (o *MfaOktaConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *MfaOktaConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *MfaOktaConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *MfaOktaConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetHost + +`func (o *MfaOktaConfig) GetHost() string` + +GetHost returns the Host field if non-nil, zero value otherwise. + +### GetHostOk + +`func (o *MfaOktaConfig) GetHostOk() (*string, bool)` + +GetHostOk returns a tuple with the Host field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHost + +`func (o *MfaOktaConfig) SetHost(v string)` + +SetHost sets Host field to given value. + +### HasHost + +`func (o *MfaOktaConfig) HasHost() bool` + +HasHost returns a boolean if a field has been set. + +### SetHostNil + +`func (o *MfaOktaConfig) SetHostNil(b bool)` + + SetHostNil sets the value for Host to be an explicit nil + +### UnsetHost +`func (o *MfaOktaConfig) UnsetHost()` + +UnsetHost ensures that no value is present for Host, not even an explicit nil +### GetAccessKey + +`func (o *MfaOktaConfig) GetAccessKey() string` + +GetAccessKey returns the AccessKey field if non-nil, zero value otherwise. + +### GetAccessKeyOk + +`func (o *MfaOktaConfig) GetAccessKeyOk() (*string, bool)` + +GetAccessKeyOk returns a tuple with the AccessKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessKey + +`func (o *MfaOktaConfig) SetAccessKey(v string)` + +SetAccessKey sets AccessKey field to given value. + +### HasAccessKey + +`func (o *MfaOktaConfig) HasAccessKey() bool` + +HasAccessKey returns a boolean if a field has been set. + +### SetAccessKeyNil + +`func (o *MfaOktaConfig) SetAccessKeyNil(b bool)` + + SetAccessKeyNil sets the value for AccessKey to be an explicit nil + +### UnsetAccessKey +`func (o *MfaOktaConfig) UnsetAccessKey()` + +UnsetAccessKey ensures that no value is present for AccessKey, not even an explicit nil +### GetIdentityAttribute + +`func (o *MfaOktaConfig) GetIdentityAttribute() string` + +GetIdentityAttribute returns the IdentityAttribute field if non-nil, zero value otherwise. + +### GetIdentityAttributeOk + +`func (o *MfaOktaConfig) GetIdentityAttributeOk() (*string, bool)` + +GetIdentityAttributeOk returns a tuple with the IdentityAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttribute + +`func (o *MfaOktaConfig) SetIdentityAttribute(v string)` + +SetIdentityAttribute sets IdentityAttribute field to given value. + +### HasIdentityAttribute + +`func (o *MfaOktaConfig) HasIdentityAttribute() bool` + +HasIdentityAttribute returns a boolean if a field has been set. + +### SetIdentityAttributeNil + +`func (o *MfaOktaConfig) SetIdentityAttributeNil(b bool)` + + SetIdentityAttributeNil sets the value for IdentityAttribute to be an explicit nil + +### UnsetIdentityAttribute +`func (o *MfaOktaConfig) UnsetIdentityAttribute()` + +UnsetIdentityAttribute ensures that no value is present for IdentityAttribute, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationTemplateType.md b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationTemplateType.md new file mode 100644 index 000000000..89b3aab3b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationTemplateType.md @@ -0,0 +1,106 @@ +--- +id: v2024-multi-host-integration-template-type +title: MultiHostIntegrationTemplateType +pagination_label: MultiHostIntegrationTemplateType +sidebar_label: MultiHostIntegrationTemplateType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationTemplateType', 'V2024MultiHostIntegrationTemplateType'] +slug: /tools/sdk/go/v2024/models/multi-host-integration-template-type +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationTemplateType', 'V2024MultiHostIntegrationTemplateType'] +--- + +# MultiHostIntegrationTemplateType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | This is the name of the type. | [optional] +**Type** | **string** | This is the type value for the type. | +**ScriptName** | **string** | This is the scriptName attribute value for the type. | + +## Methods + +### NewMultiHostIntegrationTemplateType + +`func NewMultiHostIntegrationTemplateType(type_ string, scriptName string, ) *MultiHostIntegrationTemplateType` + +NewMultiHostIntegrationTemplateType instantiates a new MultiHostIntegrationTemplateType 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 + +### NewMultiHostIntegrationTemplateTypeWithDefaults + +`func NewMultiHostIntegrationTemplateTypeWithDefaults() *MultiHostIntegrationTemplateType` + +NewMultiHostIntegrationTemplateTypeWithDefaults instantiates a new MultiHostIntegrationTemplateType 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 + +### GetName + +`func (o *MultiHostIntegrationTemplateType) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrationTemplateType) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrationTemplateType) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MultiHostIntegrationTemplateType) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *MultiHostIntegrationTemplateType) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostIntegrationTemplateType) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostIntegrationTemplateType) SetType(v string)` + +SetType sets Type field to given value. + + +### GetScriptName + +`func (o *MultiHostIntegrationTemplateType) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *MultiHostIntegrationTemplateType) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *MultiHostIntegrationTemplateType) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrations.md b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrations.md new file mode 100644 index 000000000..42e4a1568 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrations.md @@ -0,0 +1,935 @@ +--- +id: v2024-multi-host-integrations +title: MultiHostIntegrations +pagination_label: MultiHostIntegrations +sidebar_label: MultiHostIntegrations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrations', 'V2024MultiHostIntegrations'] +slug: /tools/sdk/go/v2024/models/multi-host-integrations +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrations', 'V2024MultiHostIntegrations'] +--- + +# MultiHostIntegrations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Multi-Host Integration ID. | [readonly] +**Name** | **string** | Multi-Host Integration's human-readable name. | +**Description** | **string** | Multi-Host Integration's human-readable description. | +**Owner** | [**SourceOwner**](source-owner) | | +**Cluster** | Pointer to [**NullableSourceCluster**](source-cluster) | | [optional] +**AccountCorrelationConfig** | Pointer to [**NullableSourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional] +**AccountCorrelationRule** | Pointer to [**NullableSourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional] +**ManagerCorrelationMapping** | Pointer to [**SourceManagerCorrelationMapping**](source-manager-correlation-mapping) | | [optional] +**ManagerCorrelationRule** | Pointer to [**NullableSourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional] +**BeforeProvisioningRule** | Pointer to [**NullableMultiHostIntegrationsBeforeProvisioningRule**](multi-host-integrations-before-provisioning-rule) | | [optional] +**Schemas** | Pointer to [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional] +**PasswordPolicies** | Pointer to [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**Features** | Pointer to **[]string** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Type** | Pointer to **string** | Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Connector** | **string** | Connector script name. | +**ConnectorClass** | Pointer to **string** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**ConnectorAttributes** | Pointer to [**MultiHostIntegrationsConnectorAttributes**](multi-host-integrations-connector-attributes) | | [optional] +**DeleteThreshold** | Pointer to **int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**Authoritative** | Pointer to **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to false] +**ManagementWorkgroup** | Pointer to [**NullableSourceManagementWorkgroup**](source-management-workgroup) | | [optional] +**Healthy** | Pointer to **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to false] +**Status** | Pointer to **string** | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**Since** | Pointer to **SailPointTime** | Timestamp that shows when a source health check was last performed. | [optional] +**ConnectorId** | Pointer to **string** | Connector ID | [optional] +**ConnectorName** | Pointer to **string** | Name of the connector that was chosen during source creation. | [optional] +**ConnectionType** | Pointer to **string** | Type of connection (direct or file). | [optional] +**ConnectorImplementationId** | Pointer to **string** | Connector implementation ID. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date-time when the source was last modified. | [optional] +**CredentialProviderEnabled** | Pointer to **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to false] +**Category** | Pointer to **NullableString** | Source category (e.g. null, CredentialProvider). | [optional] +**AccountsFile** | Pointer to [**NullableMultiHostIntegrationsAccountsFile**](multi-host-integrations-accounts-file) | | [optional] + +## Methods + +### NewMultiHostIntegrations + +`func NewMultiHostIntegrations(id string, name string, description string, owner SourceOwner, connector string, ) *MultiHostIntegrations` + +NewMultiHostIntegrations instantiates a new MultiHostIntegrations 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 + +### NewMultiHostIntegrationsWithDefaults + +`func NewMultiHostIntegrationsWithDefaults() *MultiHostIntegrations` + +NewMultiHostIntegrationsWithDefaults instantiates a new MultiHostIntegrations 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 + +### GetId + +`func (o *MultiHostIntegrations) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostIntegrations) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostIntegrations) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *MultiHostIntegrations) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrations) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrations) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *MultiHostIntegrations) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *MultiHostIntegrations) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *MultiHostIntegrations) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetOwner + +`func (o *MultiHostIntegrations) GetOwner() SourceOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *MultiHostIntegrations) GetOwnerOk() (*SourceOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *MultiHostIntegrations) SetOwner(v SourceOwner)` + +SetOwner sets Owner field to given value. + + +### GetCluster + +`func (o *MultiHostIntegrations) GetCluster() SourceCluster` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *MultiHostIntegrations) GetClusterOk() (*SourceCluster, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *MultiHostIntegrations) SetCluster(v SourceCluster)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *MultiHostIntegrations) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### SetClusterNil + +`func (o *MultiHostIntegrations) SetClusterNil(b bool)` + + SetClusterNil sets the value for Cluster to be an explicit nil + +### UnsetCluster +`func (o *MultiHostIntegrations) UnsetCluster()` + +UnsetCluster ensures that no value is present for Cluster, not even an explicit nil +### GetAccountCorrelationConfig + +`func (o *MultiHostIntegrations) GetAccountCorrelationConfig() SourceAccountCorrelationConfig` + +GetAccountCorrelationConfig returns the AccountCorrelationConfig field if non-nil, zero value otherwise. + +### GetAccountCorrelationConfigOk + +`func (o *MultiHostIntegrations) GetAccountCorrelationConfigOk() (*SourceAccountCorrelationConfig, bool)` + +GetAccountCorrelationConfigOk returns a tuple with the AccountCorrelationConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationConfig + +`func (o *MultiHostIntegrations) SetAccountCorrelationConfig(v SourceAccountCorrelationConfig)` + +SetAccountCorrelationConfig sets AccountCorrelationConfig field to given value. + +### HasAccountCorrelationConfig + +`func (o *MultiHostIntegrations) HasAccountCorrelationConfig() bool` + +HasAccountCorrelationConfig returns a boolean if a field has been set. + +### SetAccountCorrelationConfigNil + +`func (o *MultiHostIntegrations) SetAccountCorrelationConfigNil(b bool)` + + SetAccountCorrelationConfigNil sets the value for AccountCorrelationConfig to be an explicit nil + +### UnsetAccountCorrelationConfig +`func (o *MultiHostIntegrations) UnsetAccountCorrelationConfig()` + +UnsetAccountCorrelationConfig ensures that no value is present for AccountCorrelationConfig, not even an explicit nil +### GetAccountCorrelationRule + +`func (o *MultiHostIntegrations) GetAccountCorrelationRule() SourceAccountCorrelationRule` + +GetAccountCorrelationRule returns the AccountCorrelationRule field if non-nil, zero value otherwise. + +### GetAccountCorrelationRuleOk + +`func (o *MultiHostIntegrations) GetAccountCorrelationRuleOk() (*SourceAccountCorrelationRule, bool)` + +GetAccountCorrelationRuleOk returns a tuple with the AccountCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationRule + +`func (o *MultiHostIntegrations) SetAccountCorrelationRule(v SourceAccountCorrelationRule)` + +SetAccountCorrelationRule sets AccountCorrelationRule field to given value. + +### HasAccountCorrelationRule + +`func (o *MultiHostIntegrations) HasAccountCorrelationRule() bool` + +HasAccountCorrelationRule returns a boolean if a field has been set. + +### SetAccountCorrelationRuleNil + +`func (o *MultiHostIntegrations) SetAccountCorrelationRuleNil(b bool)` + + SetAccountCorrelationRuleNil sets the value for AccountCorrelationRule to be an explicit nil + +### UnsetAccountCorrelationRule +`func (o *MultiHostIntegrations) UnsetAccountCorrelationRule()` + +UnsetAccountCorrelationRule ensures that no value is present for AccountCorrelationRule, not even an explicit nil +### GetManagerCorrelationMapping + +`func (o *MultiHostIntegrations) GetManagerCorrelationMapping() SourceManagerCorrelationMapping` + +GetManagerCorrelationMapping returns the ManagerCorrelationMapping field if non-nil, zero value otherwise. + +### GetManagerCorrelationMappingOk + +`func (o *MultiHostIntegrations) GetManagerCorrelationMappingOk() (*SourceManagerCorrelationMapping, bool)` + +GetManagerCorrelationMappingOk returns a tuple with the ManagerCorrelationMapping field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationMapping + +`func (o *MultiHostIntegrations) SetManagerCorrelationMapping(v SourceManagerCorrelationMapping)` + +SetManagerCorrelationMapping sets ManagerCorrelationMapping field to given value. + +### HasManagerCorrelationMapping + +`func (o *MultiHostIntegrations) HasManagerCorrelationMapping() bool` + +HasManagerCorrelationMapping returns a boolean if a field has been set. + +### GetManagerCorrelationRule + +`func (o *MultiHostIntegrations) GetManagerCorrelationRule() SourceManagerCorrelationRule` + +GetManagerCorrelationRule returns the ManagerCorrelationRule field if non-nil, zero value otherwise. + +### GetManagerCorrelationRuleOk + +`func (o *MultiHostIntegrations) GetManagerCorrelationRuleOk() (*SourceManagerCorrelationRule, bool)` + +GetManagerCorrelationRuleOk returns a tuple with the ManagerCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationRule + +`func (o *MultiHostIntegrations) SetManagerCorrelationRule(v SourceManagerCorrelationRule)` + +SetManagerCorrelationRule sets ManagerCorrelationRule field to given value. + +### HasManagerCorrelationRule + +`func (o *MultiHostIntegrations) HasManagerCorrelationRule() bool` + +HasManagerCorrelationRule returns a boolean if a field has been set. + +### SetManagerCorrelationRuleNil + +`func (o *MultiHostIntegrations) SetManagerCorrelationRuleNil(b bool)` + + SetManagerCorrelationRuleNil sets the value for ManagerCorrelationRule to be an explicit nil + +### UnsetManagerCorrelationRule +`func (o *MultiHostIntegrations) UnsetManagerCorrelationRule()` + +UnsetManagerCorrelationRule ensures that no value is present for ManagerCorrelationRule, not even an explicit nil +### GetBeforeProvisioningRule + +`func (o *MultiHostIntegrations) GetBeforeProvisioningRule() MultiHostIntegrationsBeforeProvisioningRule` + +GetBeforeProvisioningRule returns the BeforeProvisioningRule field if non-nil, zero value otherwise. + +### GetBeforeProvisioningRuleOk + +`func (o *MultiHostIntegrations) GetBeforeProvisioningRuleOk() (*MultiHostIntegrationsBeforeProvisioningRule, bool)` + +GetBeforeProvisioningRuleOk returns a tuple with the BeforeProvisioningRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBeforeProvisioningRule + +`func (o *MultiHostIntegrations) SetBeforeProvisioningRule(v MultiHostIntegrationsBeforeProvisioningRule)` + +SetBeforeProvisioningRule sets BeforeProvisioningRule field to given value. + +### HasBeforeProvisioningRule + +`func (o *MultiHostIntegrations) HasBeforeProvisioningRule() bool` + +HasBeforeProvisioningRule returns a boolean if a field has been set. + +### SetBeforeProvisioningRuleNil + +`func (o *MultiHostIntegrations) SetBeforeProvisioningRuleNil(b bool)` + + SetBeforeProvisioningRuleNil sets the value for BeforeProvisioningRule to be an explicit nil + +### UnsetBeforeProvisioningRule +`func (o *MultiHostIntegrations) UnsetBeforeProvisioningRule()` + +UnsetBeforeProvisioningRule ensures that no value is present for BeforeProvisioningRule, not even an explicit nil +### GetSchemas + +`func (o *MultiHostIntegrations) GetSchemas() []SourceSchemasInner` + +GetSchemas returns the Schemas field if non-nil, zero value otherwise. + +### GetSchemasOk + +`func (o *MultiHostIntegrations) GetSchemasOk() (*[]SourceSchemasInner, bool)` + +GetSchemasOk returns a tuple with the Schemas field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchemas + +`func (o *MultiHostIntegrations) SetSchemas(v []SourceSchemasInner)` + +SetSchemas sets Schemas field to given value. + +### HasSchemas + +`func (o *MultiHostIntegrations) HasSchemas() bool` + +HasSchemas returns a boolean if a field has been set. + +### GetPasswordPolicies + +`func (o *MultiHostIntegrations) GetPasswordPolicies() []SourcePasswordPoliciesInner` + +GetPasswordPolicies returns the PasswordPolicies field if non-nil, zero value otherwise. + +### GetPasswordPoliciesOk + +`func (o *MultiHostIntegrations) GetPasswordPoliciesOk() (*[]SourcePasswordPoliciesInner, bool)` + +GetPasswordPoliciesOk returns a tuple with the PasswordPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicies + +`func (o *MultiHostIntegrations) SetPasswordPolicies(v []SourcePasswordPoliciesInner)` + +SetPasswordPolicies sets PasswordPolicies field to given value. + +### HasPasswordPolicies + +`func (o *MultiHostIntegrations) HasPasswordPolicies() bool` + +HasPasswordPolicies returns a boolean if a field has been set. + +### SetPasswordPoliciesNil + +`func (o *MultiHostIntegrations) SetPasswordPoliciesNil(b bool)` + + SetPasswordPoliciesNil sets the value for PasswordPolicies to be an explicit nil + +### UnsetPasswordPolicies +`func (o *MultiHostIntegrations) UnsetPasswordPolicies()` + +UnsetPasswordPolicies ensures that no value is present for PasswordPolicies, not even an explicit nil +### GetFeatures + +`func (o *MultiHostIntegrations) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *MultiHostIntegrations) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *MultiHostIntegrations) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *MultiHostIntegrations) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### GetType + +`func (o *MultiHostIntegrations) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostIntegrations) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostIntegrations) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MultiHostIntegrations) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConnector + +`func (o *MultiHostIntegrations) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *MultiHostIntegrations) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *MultiHostIntegrations) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetConnectorClass + +`func (o *MultiHostIntegrations) GetConnectorClass() string` + +GetConnectorClass returns the ConnectorClass field if non-nil, zero value otherwise. + +### GetConnectorClassOk + +`func (o *MultiHostIntegrations) GetConnectorClassOk() (*string, bool)` + +GetConnectorClassOk returns a tuple with the ConnectorClass field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorClass + +`func (o *MultiHostIntegrations) SetConnectorClass(v string)` + +SetConnectorClass sets ConnectorClass field to given value. + +### HasConnectorClass + +`func (o *MultiHostIntegrations) HasConnectorClass() bool` + +HasConnectorClass returns a boolean if a field has been set. + +### GetConnectorAttributes + +`func (o *MultiHostIntegrations) GetConnectorAttributes() MultiHostIntegrationsConnectorAttributes` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *MultiHostIntegrations) GetConnectorAttributesOk() (*MultiHostIntegrationsConnectorAttributes, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *MultiHostIntegrations) SetConnectorAttributes(v MultiHostIntegrationsConnectorAttributes)` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + +### HasConnectorAttributes + +`func (o *MultiHostIntegrations) HasConnectorAttributes() bool` + +HasConnectorAttributes returns a boolean if a field has been set. + +### GetDeleteThreshold + +`func (o *MultiHostIntegrations) GetDeleteThreshold() int32` + +GetDeleteThreshold returns the DeleteThreshold field if non-nil, zero value otherwise. + +### GetDeleteThresholdOk + +`func (o *MultiHostIntegrations) GetDeleteThresholdOk() (*int32, bool)` + +GetDeleteThresholdOk returns a tuple with the DeleteThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteThreshold + +`func (o *MultiHostIntegrations) SetDeleteThreshold(v int32)` + +SetDeleteThreshold sets DeleteThreshold field to given value. + +### HasDeleteThreshold + +`func (o *MultiHostIntegrations) HasDeleteThreshold() bool` + +HasDeleteThreshold returns a boolean if a field has been set. + +### GetAuthoritative + +`func (o *MultiHostIntegrations) GetAuthoritative() bool` + +GetAuthoritative returns the Authoritative field if non-nil, zero value otherwise. + +### GetAuthoritativeOk + +`func (o *MultiHostIntegrations) GetAuthoritativeOk() (*bool, bool)` + +GetAuthoritativeOk returns a tuple with the Authoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritative + +`func (o *MultiHostIntegrations) SetAuthoritative(v bool)` + +SetAuthoritative sets Authoritative field to given value. + +### HasAuthoritative + +`func (o *MultiHostIntegrations) HasAuthoritative() bool` + +HasAuthoritative returns a boolean if a field has been set. + +### GetManagementWorkgroup + +`func (o *MultiHostIntegrations) GetManagementWorkgroup() SourceManagementWorkgroup` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *MultiHostIntegrations) GetManagementWorkgroupOk() (*SourceManagementWorkgroup, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *MultiHostIntegrations) SetManagementWorkgroup(v SourceManagementWorkgroup)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *MultiHostIntegrations) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### SetManagementWorkgroupNil + +`func (o *MultiHostIntegrations) SetManagementWorkgroupNil(b bool)` + + SetManagementWorkgroupNil sets the value for ManagementWorkgroup to be an explicit nil + +### UnsetManagementWorkgroup +`func (o *MultiHostIntegrations) UnsetManagementWorkgroup()` + +UnsetManagementWorkgroup ensures that no value is present for ManagementWorkgroup, not even an explicit nil +### GetHealthy + +`func (o *MultiHostIntegrations) GetHealthy() bool` + +GetHealthy returns the Healthy field if non-nil, zero value otherwise. + +### GetHealthyOk + +`func (o *MultiHostIntegrations) GetHealthyOk() (*bool, bool)` + +GetHealthyOk returns a tuple with the Healthy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthy + +`func (o *MultiHostIntegrations) SetHealthy(v bool)` + +SetHealthy sets Healthy field to given value. + +### HasHealthy + +`func (o *MultiHostIntegrations) HasHealthy() bool` + +HasHealthy returns a boolean if a field has been set. + +### GetStatus + +`func (o *MultiHostIntegrations) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *MultiHostIntegrations) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *MultiHostIntegrations) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *MultiHostIntegrations) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSince + +`func (o *MultiHostIntegrations) GetSince() SailPointTime` + +GetSince returns the Since field if non-nil, zero value otherwise. + +### GetSinceOk + +`func (o *MultiHostIntegrations) GetSinceOk() (*SailPointTime, bool)` + +GetSinceOk returns a tuple with the Since field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSince + +`func (o *MultiHostIntegrations) SetSince(v SailPointTime)` + +SetSince sets Since field to given value. + +### HasSince + +`func (o *MultiHostIntegrations) HasSince() bool` + +HasSince returns a boolean if a field has been set. + +### GetConnectorId + +`func (o *MultiHostIntegrations) GetConnectorId() string` + +GetConnectorId returns the ConnectorId field if non-nil, zero value otherwise. + +### GetConnectorIdOk + +`func (o *MultiHostIntegrations) GetConnectorIdOk() (*string, bool)` + +GetConnectorIdOk returns a tuple with the ConnectorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorId + +`func (o *MultiHostIntegrations) SetConnectorId(v string)` + +SetConnectorId sets ConnectorId field to given value. + +### HasConnectorId + +`func (o *MultiHostIntegrations) HasConnectorId() bool` + +HasConnectorId returns a boolean if a field has been set. + +### GetConnectorName + +`func (o *MultiHostIntegrations) GetConnectorName() string` + +GetConnectorName returns the ConnectorName field if non-nil, zero value otherwise. + +### GetConnectorNameOk + +`func (o *MultiHostIntegrations) GetConnectorNameOk() (*string, bool)` + +GetConnectorNameOk returns a tuple with the ConnectorName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorName + +`func (o *MultiHostIntegrations) SetConnectorName(v string)` + +SetConnectorName sets ConnectorName field to given value. + +### HasConnectorName + +`func (o *MultiHostIntegrations) HasConnectorName() bool` + +HasConnectorName returns a boolean if a field has been set. + +### GetConnectionType + +`func (o *MultiHostIntegrations) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *MultiHostIntegrations) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *MultiHostIntegrations) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *MultiHostIntegrations) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + +### GetConnectorImplementationId + +`func (o *MultiHostIntegrations) GetConnectorImplementationId() string` + +GetConnectorImplementationId returns the ConnectorImplementationId field if non-nil, zero value otherwise. + +### GetConnectorImplementationIdOk + +`func (o *MultiHostIntegrations) GetConnectorImplementationIdOk() (*string, bool)` + +GetConnectorImplementationIdOk returns a tuple with the ConnectorImplementationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorImplementationId + +`func (o *MultiHostIntegrations) SetConnectorImplementationId(v string)` + +SetConnectorImplementationId sets ConnectorImplementationId field to given value. + +### HasConnectorImplementationId + +`func (o *MultiHostIntegrations) HasConnectorImplementationId() bool` + +HasConnectorImplementationId returns a boolean if a field has been set. + +### GetCreated + +`func (o *MultiHostIntegrations) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MultiHostIntegrations) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MultiHostIntegrations) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MultiHostIntegrations) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MultiHostIntegrations) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MultiHostIntegrations) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MultiHostIntegrations) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MultiHostIntegrations) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCredentialProviderEnabled + +`func (o *MultiHostIntegrations) GetCredentialProviderEnabled() bool` + +GetCredentialProviderEnabled returns the CredentialProviderEnabled field if non-nil, zero value otherwise. + +### GetCredentialProviderEnabledOk + +`func (o *MultiHostIntegrations) GetCredentialProviderEnabledOk() (*bool, bool)` + +GetCredentialProviderEnabledOk returns a tuple with the CredentialProviderEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialProviderEnabled + +`func (o *MultiHostIntegrations) SetCredentialProviderEnabled(v bool)` + +SetCredentialProviderEnabled sets CredentialProviderEnabled field to given value. + +### HasCredentialProviderEnabled + +`func (o *MultiHostIntegrations) HasCredentialProviderEnabled() bool` + +HasCredentialProviderEnabled returns a boolean if a field has been set. + +### GetCategory + +`func (o *MultiHostIntegrations) GetCategory() string` + +GetCategory returns the Category field if non-nil, zero value otherwise. + +### GetCategoryOk + +`func (o *MultiHostIntegrations) GetCategoryOk() (*string, bool)` + +GetCategoryOk returns a tuple with the Category field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCategory + +`func (o *MultiHostIntegrations) SetCategory(v string)` + +SetCategory sets Category field to given value. + +### HasCategory + +`func (o *MultiHostIntegrations) HasCategory() bool` + +HasCategory returns a boolean if a field has been set. + +### SetCategoryNil + +`func (o *MultiHostIntegrations) SetCategoryNil(b bool)` + + SetCategoryNil sets the value for Category to be an explicit nil + +### UnsetCategory +`func (o *MultiHostIntegrations) UnsetCategory()` + +UnsetCategory ensures that no value is present for Category, not even an explicit nil +### GetAccountsFile + +`func (o *MultiHostIntegrations) GetAccountsFile() MultiHostIntegrationsAccountsFile` + +GetAccountsFile returns the AccountsFile field if non-nil, zero value otherwise. + +### GetAccountsFileOk + +`func (o *MultiHostIntegrations) GetAccountsFileOk() (*MultiHostIntegrationsAccountsFile, bool)` + +GetAccountsFileOk returns a tuple with the AccountsFile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountsFile + +`func (o *MultiHostIntegrations) SetAccountsFile(v MultiHostIntegrationsAccountsFile)` + +SetAccountsFile sets AccountsFile field to given value. + +### HasAccountsFile + +`func (o *MultiHostIntegrations) HasAccountsFile() bool` + +HasAccountsFile returns a boolean if a field has been set. + +### SetAccountsFileNil + +`func (o *MultiHostIntegrations) SetAccountsFileNil(b bool)` + + SetAccountsFileNil sets the value for AccountsFile to be an explicit nil + +### UnsetAccountsFile +`func (o *MultiHostIntegrations) UnsetAccountsFile()` + +UnsetAccountsFile ensures that no value is present for AccountsFile, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsAccountsFile.md b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsAccountsFile.md new file mode 100644 index 000000000..73d4089de --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsAccountsFile.md @@ -0,0 +1,168 @@ +--- +id: v2024-multi-host-integrations-accounts-file +title: MultiHostIntegrationsAccountsFile +pagination_label: MultiHostIntegrationsAccountsFile +sidebar_label: MultiHostIntegrationsAccountsFile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsAccountsFile', 'V2024MultiHostIntegrationsAccountsFile'] +slug: /tools/sdk/go/v2024/models/multi-host-integrations-accounts-file +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsAccountsFile', 'V2024MultiHostIntegrationsAccountsFile'] +--- + +# MultiHostIntegrationsAccountsFile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the accounts file. | [optional] +**Key** | Pointer to **string** | The accounts file key. | [optional] +**UploadTime** | Pointer to **SailPointTime** | Date-time when the file was uploaded | [optional] +**Expiry** | Pointer to **SailPointTime** | Date-time when the accounts file expired. | [optional] +**Expired** | Pointer to **bool** | If this is true, it indicates that the accounts file has expired. | [optional] [default to false] + +## Methods + +### NewMultiHostIntegrationsAccountsFile + +`func NewMultiHostIntegrationsAccountsFile() *MultiHostIntegrationsAccountsFile` + +NewMultiHostIntegrationsAccountsFile instantiates a new MultiHostIntegrationsAccountsFile 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 + +### NewMultiHostIntegrationsAccountsFileWithDefaults + +`func NewMultiHostIntegrationsAccountsFileWithDefaults() *MultiHostIntegrationsAccountsFile` + +NewMultiHostIntegrationsAccountsFileWithDefaults instantiates a new MultiHostIntegrationsAccountsFile 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 + +### GetName + +`func (o *MultiHostIntegrationsAccountsFile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrationsAccountsFile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrationsAccountsFile) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MultiHostIntegrationsAccountsFile) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetKey + +`func (o *MultiHostIntegrationsAccountsFile) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *MultiHostIntegrationsAccountsFile) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *MultiHostIntegrationsAccountsFile) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *MultiHostIntegrationsAccountsFile) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetUploadTime + +`func (o *MultiHostIntegrationsAccountsFile) GetUploadTime() SailPointTime` + +GetUploadTime returns the UploadTime field if non-nil, zero value otherwise. + +### GetUploadTimeOk + +`func (o *MultiHostIntegrationsAccountsFile) GetUploadTimeOk() (*SailPointTime, bool)` + +GetUploadTimeOk returns a tuple with the UploadTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUploadTime + +`func (o *MultiHostIntegrationsAccountsFile) SetUploadTime(v SailPointTime)` + +SetUploadTime sets UploadTime field to given value. + +### HasUploadTime + +`func (o *MultiHostIntegrationsAccountsFile) HasUploadTime() bool` + +HasUploadTime returns a boolean if a field has been set. + +### GetExpiry + +`func (o *MultiHostIntegrationsAccountsFile) GetExpiry() SailPointTime` + +GetExpiry returns the Expiry field if non-nil, zero value otherwise. + +### GetExpiryOk + +`func (o *MultiHostIntegrationsAccountsFile) GetExpiryOk() (*SailPointTime, bool)` + +GetExpiryOk returns a tuple with the Expiry field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiry + +`func (o *MultiHostIntegrationsAccountsFile) SetExpiry(v SailPointTime)` + +SetExpiry sets Expiry field to given value. + +### HasExpiry + +`func (o *MultiHostIntegrationsAccountsFile) HasExpiry() bool` + +HasExpiry returns a boolean if a field has been set. + +### GetExpired + +`func (o *MultiHostIntegrationsAccountsFile) GetExpired() bool` + +GetExpired returns the Expired field if non-nil, zero value otherwise. + +### GetExpiredOk + +`func (o *MultiHostIntegrationsAccountsFile) GetExpiredOk() (*bool, bool)` + +GetExpiredOk returns a tuple with the Expired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpired + +`func (o *MultiHostIntegrationsAccountsFile) SetExpired(v bool)` + +SetExpired sets Expired field to given value. + +### HasExpired + +`func (o *MultiHostIntegrationsAccountsFile) HasExpired() bool` + +HasExpired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsAggScheduleUpdate.md b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsAggScheduleUpdate.md new file mode 100644 index 000000000..4cd3418b2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsAggScheduleUpdate.md @@ -0,0 +1,216 @@ +--- +id: v2024-multi-host-integrations-agg-schedule-update +title: MultiHostIntegrationsAggScheduleUpdate +pagination_label: MultiHostIntegrationsAggScheduleUpdate +sidebar_label: MultiHostIntegrationsAggScheduleUpdate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsAggScheduleUpdate', 'V2024MultiHostIntegrationsAggScheduleUpdate'] +slug: /tools/sdk/go/v2024/models/multi-host-integrations-agg-schedule-update +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsAggScheduleUpdate', 'V2024MultiHostIntegrationsAggScheduleUpdate'] +--- + +# MultiHostIntegrationsAggScheduleUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MultihostId** | **string** | Multi-Host Integration ID. The ID must be unique | +**AggregationGrpId** | **string** | Multi-Host Integration aggregation group ID | +**AggregationGrpName** | **string** | Multi-Host Integration name | +**AggregationCronSchedule** | **string** | Cron expression to schedule aggregation | +**EnableSchedule** | **bool** | Boolean value for Multi-Host Integration aggregation schedule. This specifies if scheduled aggregation is enabled or disabled. | [default to false] +**SourceIdList** | **[]string** | Source IDs of the Multi-Host Integration | +**Created** | Pointer to **SailPointTime** | Created date of Multi-Host Integration aggregation schedule | [optional] +**Modified** | Pointer to **SailPointTime** | Modified date of Multi-Host Integration aggregation schedule | [optional] + +## Methods + +### NewMultiHostIntegrationsAggScheduleUpdate + +`func NewMultiHostIntegrationsAggScheduleUpdate(multihostId string, aggregationGrpId string, aggregationGrpName string, aggregationCronSchedule string, enableSchedule bool, sourceIdList []string, ) *MultiHostIntegrationsAggScheduleUpdate` + +NewMultiHostIntegrationsAggScheduleUpdate instantiates a new MultiHostIntegrationsAggScheduleUpdate 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 + +### NewMultiHostIntegrationsAggScheduleUpdateWithDefaults + +`func NewMultiHostIntegrationsAggScheduleUpdateWithDefaults() *MultiHostIntegrationsAggScheduleUpdate` + +NewMultiHostIntegrationsAggScheduleUpdateWithDefaults instantiates a new MultiHostIntegrationsAggScheduleUpdate 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 + +### GetMultihostId + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetMultihostId() string` + +GetMultihostId returns the MultihostId field if non-nil, zero value otherwise. + +### GetMultihostIdOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetMultihostIdOk() (*string, bool)` + +GetMultihostIdOk returns a tuple with the MultihostId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultihostId + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetMultihostId(v string)` + +SetMultihostId sets MultihostId field to given value. + + +### GetAggregationGrpId + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationGrpId() string` + +GetAggregationGrpId returns the AggregationGrpId field if non-nil, zero value otherwise. + +### GetAggregationGrpIdOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationGrpIdOk() (*string, bool)` + +GetAggregationGrpIdOk returns a tuple with the AggregationGrpId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationGrpId + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetAggregationGrpId(v string)` + +SetAggregationGrpId sets AggregationGrpId field to given value. + + +### GetAggregationGrpName + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationGrpName() string` + +GetAggregationGrpName returns the AggregationGrpName field if non-nil, zero value otherwise. + +### GetAggregationGrpNameOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationGrpNameOk() (*string, bool)` + +GetAggregationGrpNameOk returns a tuple with the AggregationGrpName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationGrpName + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetAggregationGrpName(v string)` + +SetAggregationGrpName sets AggregationGrpName field to given value. + + +### GetAggregationCronSchedule + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationCronSchedule() string` + +GetAggregationCronSchedule returns the AggregationCronSchedule field if non-nil, zero value otherwise. + +### GetAggregationCronScheduleOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationCronScheduleOk() (*string, bool)` + +GetAggregationCronScheduleOk returns a tuple with the AggregationCronSchedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationCronSchedule + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetAggregationCronSchedule(v string)` + +SetAggregationCronSchedule sets AggregationCronSchedule field to given value. + + +### GetEnableSchedule + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetEnableSchedule() bool` + +GetEnableSchedule returns the EnableSchedule field if non-nil, zero value otherwise. + +### GetEnableScheduleOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetEnableScheduleOk() (*bool, bool)` + +GetEnableScheduleOk returns a tuple with the EnableSchedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnableSchedule + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetEnableSchedule(v bool)` + +SetEnableSchedule sets EnableSchedule field to given value. + + +### GetSourceIdList + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetSourceIdList() []string` + +GetSourceIdList returns the SourceIdList field if non-nil, zero value otherwise. + +### GetSourceIdListOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetSourceIdListOk() (*[]string, bool)` + +GetSourceIdListOk returns a tuple with the SourceIdList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIdList + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetSourceIdList(v []string)` + +SetSourceIdList sets SourceIdList field to given value. + + +### GetCreated + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MultiHostIntegrationsAggScheduleUpdate) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MultiHostIntegrationsAggScheduleUpdate) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsBeforeProvisioningRule.md b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsBeforeProvisioningRule.md new file mode 100644 index 000000000..a21e30d05 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsBeforeProvisioningRule.md @@ -0,0 +1,116 @@ +--- +id: v2024-multi-host-integrations-before-provisioning-rule +title: MultiHostIntegrationsBeforeProvisioningRule +pagination_label: MultiHostIntegrationsBeforeProvisioningRule +sidebar_label: MultiHostIntegrationsBeforeProvisioningRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsBeforeProvisioningRule', 'V2024MultiHostIntegrationsBeforeProvisioningRule'] +slug: /tools/sdk/go/v2024/models/multi-host-integrations-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsBeforeProvisioningRule', 'V2024MultiHostIntegrationsBeforeProvisioningRule'] +--- + +# MultiHostIntegrationsBeforeProvisioningRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Rule ID. | [optional] +**Name** | Pointer to **string** | Rule's human-readable display name. | [optional] + +## Methods + +### NewMultiHostIntegrationsBeforeProvisioningRule + +`func NewMultiHostIntegrationsBeforeProvisioningRule() *MultiHostIntegrationsBeforeProvisioningRule` + +NewMultiHostIntegrationsBeforeProvisioningRule instantiates a new MultiHostIntegrationsBeforeProvisioningRule 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 + +### NewMultiHostIntegrationsBeforeProvisioningRuleWithDefaults + +`func NewMultiHostIntegrationsBeforeProvisioningRuleWithDefaults() *MultiHostIntegrationsBeforeProvisioningRule` + +NewMultiHostIntegrationsBeforeProvisioningRuleWithDefaults instantiates a new MultiHostIntegrationsBeforeProvisioningRule 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 + +### GetType + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsConnectorAttributes.md b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsConnectorAttributes.md new file mode 100644 index 000000000..db2d53c86 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsConnectorAttributes.md @@ -0,0 +1,220 @@ +--- +id: v2024-multi-host-integrations-connector-attributes +title: MultiHostIntegrationsConnectorAttributes +pagination_label: MultiHostIntegrationsConnectorAttributes +sidebar_label: MultiHostIntegrationsConnectorAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsConnectorAttributes', 'V2024MultiHostIntegrationsConnectorAttributes'] +slug: /tools/sdk/go/v2024/models/multi-host-integrations-connector-attributes +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributes', 'V2024MultiHostIntegrationsConnectorAttributes'] +--- + +# MultiHostIntegrationsConnectorAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxAllowedSources** | Pointer to **int32** | Maximum sources allowed count of a Multi-Host Integration | [optional] +**LastSourceUploadCount** | Pointer to **int32** | Last upload sources count of a Multi-Host Integration | [optional] +**ConnectorFileUploadHistory** | Pointer to [**MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory**](multi-host-integrations-connector-attributes-connector-file-upload-history) | | [optional] +**MultihostStatus** | Pointer to **string** | Multi-Host integration status. | [optional] +**ShowAccountSchema** | Pointer to **bool** | Show account schema | [optional] [default to true] +**ShowEntitlementSchema** | Pointer to **bool** | Show entitlement schema | [optional] [default to true] +**MultiHostAttributes** | Pointer to [**MultiHostIntegrationsConnectorAttributesMultiHostAttributes**](multi-host-integrations-connector-attributes-multi-host-attributes) | | [optional] + +## Methods + +### NewMultiHostIntegrationsConnectorAttributes + +`func NewMultiHostIntegrationsConnectorAttributes() *MultiHostIntegrationsConnectorAttributes` + +NewMultiHostIntegrationsConnectorAttributes instantiates a new MultiHostIntegrationsConnectorAttributes 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 + +### NewMultiHostIntegrationsConnectorAttributesWithDefaults + +`func NewMultiHostIntegrationsConnectorAttributesWithDefaults() *MultiHostIntegrationsConnectorAttributes` + +NewMultiHostIntegrationsConnectorAttributesWithDefaults instantiates a new MultiHostIntegrationsConnectorAttributes 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 + +### GetMaxAllowedSources + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMaxAllowedSources() int32` + +GetMaxAllowedSources returns the MaxAllowedSources field if non-nil, zero value otherwise. + +### GetMaxAllowedSourcesOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMaxAllowedSourcesOk() (*int32, bool)` + +GetMaxAllowedSourcesOk returns a tuple with the MaxAllowedSources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxAllowedSources + +`func (o *MultiHostIntegrationsConnectorAttributes) SetMaxAllowedSources(v int32)` + +SetMaxAllowedSources sets MaxAllowedSources field to given value. + +### HasMaxAllowedSources + +`func (o *MultiHostIntegrationsConnectorAttributes) HasMaxAllowedSources() bool` + +HasMaxAllowedSources returns a boolean if a field has been set. + +### GetLastSourceUploadCount + +`func (o *MultiHostIntegrationsConnectorAttributes) GetLastSourceUploadCount() int32` + +GetLastSourceUploadCount returns the LastSourceUploadCount field if non-nil, zero value otherwise. + +### GetLastSourceUploadCountOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetLastSourceUploadCountOk() (*int32, bool)` + +GetLastSourceUploadCountOk returns a tuple with the LastSourceUploadCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastSourceUploadCount + +`func (o *MultiHostIntegrationsConnectorAttributes) SetLastSourceUploadCount(v int32)` + +SetLastSourceUploadCount sets LastSourceUploadCount field to given value. + +### HasLastSourceUploadCount + +`func (o *MultiHostIntegrationsConnectorAttributes) HasLastSourceUploadCount() bool` + +HasLastSourceUploadCount returns a boolean if a field has been set. + +### GetConnectorFileUploadHistory + +`func (o *MultiHostIntegrationsConnectorAttributes) GetConnectorFileUploadHistory() MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory` + +GetConnectorFileUploadHistory returns the ConnectorFileUploadHistory field if non-nil, zero value otherwise. + +### GetConnectorFileUploadHistoryOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetConnectorFileUploadHistoryOk() (*MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory, bool)` + +GetConnectorFileUploadHistoryOk returns a tuple with the ConnectorFileUploadHistory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorFileUploadHistory + +`func (o *MultiHostIntegrationsConnectorAttributes) SetConnectorFileUploadHistory(v MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory)` + +SetConnectorFileUploadHistory sets ConnectorFileUploadHistory field to given value. + +### HasConnectorFileUploadHistory + +`func (o *MultiHostIntegrationsConnectorAttributes) HasConnectorFileUploadHistory() bool` + +HasConnectorFileUploadHistory returns a boolean if a field has been set. + +### GetMultihostStatus + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMultihostStatus() string` + +GetMultihostStatus returns the MultihostStatus field if non-nil, zero value otherwise. + +### GetMultihostStatusOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMultihostStatusOk() (*string, bool)` + +GetMultihostStatusOk returns a tuple with the MultihostStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultihostStatus + +`func (o *MultiHostIntegrationsConnectorAttributes) SetMultihostStatus(v string)` + +SetMultihostStatus sets MultihostStatus field to given value. + +### HasMultihostStatus + +`func (o *MultiHostIntegrationsConnectorAttributes) HasMultihostStatus() bool` + +HasMultihostStatus returns a boolean if a field has been set. + +### GetShowAccountSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) GetShowAccountSchema() bool` + +GetShowAccountSchema returns the ShowAccountSchema field if non-nil, zero value otherwise. + +### GetShowAccountSchemaOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetShowAccountSchemaOk() (*bool, bool)` + +GetShowAccountSchemaOk returns a tuple with the ShowAccountSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShowAccountSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) SetShowAccountSchema(v bool)` + +SetShowAccountSchema sets ShowAccountSchema field to given value. + +### HasShowAccountSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) HasShowAccountSchema() bool` + +HasShowAccountSchema returns a boolean if a field has been set. + +### GetShowEntitlementSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) GetShowEntitlementSchema() bool` + +GetShowEntitlementSchema returns the ShowEntitlementSchema field if non-nil, zero value otherwise. + +### GetShowEntitlementSchemaOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetShowEntitlementSchemaOk() (*bool, bool)` + +GetShowEntitlementSchemaOk returns a tuple with the ShowEntitlementSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShowEntitlementSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) SetShowEntitlementSchema(v bool)` + +SetShowEntitlementSchema sets ShowEntitlementSchema field to given value. + +### HasShowEntitlementSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) HasShowEntitlementSchema() bool` + +HasShowEntitlementSchema returns a boolean if a field has been set. + +### GetMultiHostAttributes + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMultiHostAttributes() MultiHostIntegrationsConnectorAttributesMultiHostAttributes` + +GetMultiHostAttributes returns the MultiHostAttributes field if non-nil, zero value otherwise. + +### GetMultiHostAttributesOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMultiHostAttributesOk() (*MultiHostIntegrationsConnectorAttributesMultiHostAttributes, bool)` + +GetMultiHostAttributesOk returns a tuple with the MultiHostAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultiHostAttributes + +`func (o *MultiHostIntegrationsConnectorAttributes) SetMultiHostAttributes(v MultiHostIntegrationsConnectorAttributesMultiHostAttributes)` + +SetMultiHostAttributes sets MultiHostAttributes field to given value. + +### HasMultiHostAttributes + +`func (o *MultiHostIntegrationsConnectorAttributes) HasMultiHostAttributes() bool` + +HasMultiHostAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md new file mode 100644 index 000000000..685fc7a6f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md @@ -0,0 +1,64 @@ +--- +id: v2024-multi-host-integrations-connector-attributes-connector-file-upload-history +title: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory +pagination_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory +sidebar_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory', 'V2024MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory'] +slug: /tools/sdk/go/v2024/models/multi-host-integrations-connector-attributes-connector-file-upload-history +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory', 'V2024MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory'] +--- + +# MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConnectorFileNameUploadedDate** | Pointer to **string** | File name of the connector JAR | [optional] + +## Methods + +### NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory + +`func NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory() *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory` + +NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory instantiates a new MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory 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 + +### NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryWithDefaults + +`func NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryWithDefaults() *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory` + +NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryWithDefaults instantiates a new MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory 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 + +### GetConnectorFileNameUploadedDate + +`func (o *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory) GetConnectorFileNameUploadedDate() string` + +GetConnectorFileNameUploadedDate returns the ConnectorFileNameUploadedDate field if non-nil, zero value otherwise. + +### GetConnectorFileNameUploadedDateOk + +`func (o *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory) GetConnectorFileNameUploadedDateOk() (*string, bool)` + +GetConnectorFileNameUploadedDateOk returns a tuple with the ConnectorFileNameUploadedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorFileNameUploadedDate + +`func (o *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory) SetConnectorFileNameUploadedDate(v string)` + +SetConnectorFileNameUploadedDate sets ConnectorFileNameUploadedDate field to given value. + +### HasConnectorFileNameUploadedDate + +`func (o *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory) HasConnectorFileNameUploadedDate() bool` + +HasConnectorFileNameUploadedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md new file mode 100644 index 000000000..628189e4c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md @@ -0,0 +1,142 @@ +--- +id: v2024-multi-host-integrations-connector-attributes-multi-host-attributes +title: MultiHostIntegrationsConnectorAttributesMultiHostAttributes +pagination_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes +sidebar_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes', 'V2024MultiHostIntegrationsConnectorAttributesMultiHostAttributes'] +slug: /tools/sdk/go/v2024/models/multi-host-integrations-connector-attributes-multi-host-attributes +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes', 'V2024MultiHostIntegrationsConnectorAttributesMultiHostAttributes'] +--- + +# MultiHostIntegrationsConnectorAttributesMultiHostAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Password** | Pointer to **string** | Password. | [optional] +**ConnectorFiles** | Pointer to **string** | Connector file. | [optional] +**AuthType** | Pointer to **string** | Authentication type. | [optional] +**User** | Pointer to **string** | Username. | [optional] + +## Methods + +### NewMultiHostIntegrationsConnectorAttributesMultiHostAttributes + +`func NewMultiHostIntegrationsConnectorAttributesMultiHostAttributes() *MultiHostIntegrationsConnectorAttributesMultiHostAttributes` + +NewMultiHostIntegrationsConnectorAttributesMultiHostAttributes instantiates a new MultiHostIntegrationsConnectorAttributesMultiHostAttributes 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 + +### NewMultiHostIntegrationsConnectorAttributesMultiHostAttributesWithDefaults + +`func NewMultiHostIntegrationsConnectorAttributesMultiHostAttributesWithDefaults() *MultiHostIntegrationsConnectorAttributesMultiHostAttributes` + +NewMultiHostIntegrationsConnectorAttributesMultiHostAttributesWithDefaults instantiates a new MultiHostIntegrationsConnectorAttributesMultiHostAttributes 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 + +### GetPassword + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) SetPassword(v string)` + +SetPassword sets Password field to given value. + +### HasPassword + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) HasPassword() bool` + +HasPassword returns a boolean if a field has been set. + +### GetConnectorFiles + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetConnectorFiles() string` + +GetConnectorFiles returns the ConnectorFiles field if non-nil, zero value otherwise. + +### GetConnectorFilesOk + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetConnectorFilesOk() (*string, bool)` + +GetConnectorFilesOk returns a tuple with the ConnectorFiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorFiles + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) SetConnectorFiles(v string)` + +SetConnectorFiles sets ConnectorFiles field to given value. + +### HasConnectorFiles + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) HasConnectorFiles() bool` + +HasConnectorFiles returns a boolean if a field has been set. + +### GetAuthType + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetAuthType() string` + +GetAuthType returns the AuthType field if non-nil, zero value otherwise. + +### GetAuthTypeOk + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetAuthTypeOk() (*string, bool)` + +GetAuthTypeOk returns a tuple with the AuthType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthType + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) SetAuthType(v string)` + +SetAuthType sets AuthType field to given value. + +### HasAuthType + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) HasAuthType() bool` + +HasAuthType returns a boolean if a field has been set. + +### GetUser + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetUser() string` + +GetUser returns the User field if non-nil, zero value otherwise. + +### GetUserOk + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetUserOk() (*string, bool)` + +GetUserOk returns a tuple with the User field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUser + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) SetUser(v string)` + +SetUser sets User field to given value. + +### HasUser + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) HasUser() bool` + +HasUser returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsCreate.md b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsCreate.md new file mode 100644 index 000000000..4d6c359a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsCreate.md @@ -0,0 +1,272 @@ +--- +id: v2024-multi-host-integrations-create +title: MultiHostIntegrationsCreate +pagination_label: MultiHostIntegrationsCreate +sidebar_label: MultiHostIntegrationsCreate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsCreate', 'V2024MultiHostIntegrationsCreate'] +slug: /tools/sdk/go/v2024/models/multi-host-integrations-create +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreate', 'V2024MultiHostIntegrationsCreate'] +--- + +# MultiHostIntegrationsCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Multi-Host Integration's human-readable name. | +**Description** | **string** | Multi-Host Integration's human-readable description. | +**Owner** | [**SourceOwner**](source-owner) | | +**Cluster** | Pointer to [**NullableSourceCluster**](source-cluster) | | [optional] +**Connector** | **string** | Connector script name. | +**ConnectorAttributes** | Pointer to **map[string]interface{}** | Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc. | [optional] +**ManagementWorkgroup** | Pointer to [**NullableSourceManagementWorkgroup**](source-management-workgroup) | | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date-time when the source was last modified. | [optional] + +## Methods + +### NewMultiHostIntegrationsCreate + +`func NewMultiHostIntegrationsCreate(name string, description string, owner SourceOwner, connector string, ) *MultiHostIntegrationsCreate` + +NewMultiHostIntegrationsCreate instantiates a new MultiHostIntegrationsCreate 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 + +### NewMultiHostIntegrationsCreateWithDefaults + +`func NewMultiHostIntegrationsCreateWithDefaults() *MultiHostIntegrationsCreate` + +NewMultiHostIntegrationsCreateWithDefaults instantiates a new MultiHostIntegrationsCreate 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 + +### GetName + +`func (o *MultiHostIntegrationsCreate) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrationsCreate) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrationsCreate) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *MultiHostIntegrationsCreate) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *MultiHostIntegrationsCreate) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *MultiHostIntegrationsCreate) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetOwner + +`func (o *MultiHostIntegrationsCreate) GetOwner() SourceOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *MultiHostIntegrationsCreate) GetOwnerOk() (*SourceOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *MultiHostIntegrationsCreate) SetOwner(v SourceOwner)` + +SetOwner sets Owner field to given value. + + +### GetCluster + +`func (o *MultiHostIntegrationsCreate) GetCluster() SourceCluster` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *MultiHostIntegrationsCreate) GetClusterOk() (*SourceCluster, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *MultiHostIntegrationsCreate) SetCluster(v SourceCluster)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *MultiHostIntegrationsCreate) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### SetClusterNil + +`func (o *MultiHostIntegrationsCreate) SetClusterNil(b bool)` + + SetClusterNil sets the value for Cluster to be an explicit nil + +### UnsetCluster +`func (o *MultiHostIntegrationsCreate) UnsetCluster()` + +UnsetCluster ensures that no value is present for Cluster, not even an explicit nil +### GetConnector + +`func (o *MultiHostIntegrationsCreate) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *MultiHostIntegrationsCreate) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *MultiHostIntegrationsCreate) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetConnectorAttributes + +`func (o *MultiHostIntegrationsCreate) GetConnectorAttributes() map[string]interface{}` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *MultiHostIntegrationsCreate) GetConnectorAttributesOk() (*map[string]interface{}, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *MultiHostIntegrationsCreate) SetConnectorAttributes(v map[string]interface{})` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + +### HasConnectorAttributes + +`func (o *MultiHostIntegrationsCreate) HasConnectorAttributes() bool` + +HasConnectorAttributes returns a boolean if a field has been set. + +### GetManagementWorkgroup + +`func (o *MultiHostIntegrationsCreate) GetManagementWorkgroup() SourceManagementWorkgroup` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *MultiHostIntegrationsCreate) GetManagementWorkgroupOk() (*SourceManagementWorkgroup, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *MultiHostIntegrationsCreate) SetManagementWorkgroup(v SourceManagementWorkgroup)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *MultiHostIntegrationsCreate) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### SetManagementWorkgroupNil + +`func (o *MultiHostIntegrationsCreate) SetManagementWorkgroupNil(b bool)` + + SetManagementWorkgroupNil sets the value for ManagementWorkgroup to be an explicit nil + +### UnsetManagementWorkgroup +`func (o *MultiHostIntegrationsCreate) UnsetManagementWorkgroup()` + +UnsetManagementWorkgroup ensures that no value is present for ManagementWorkgroup, not even an explicit nil +### GetCreated + +`func (o *MultiHostIntegrationsCreate) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MultiHostIntegrationsCreate) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MultiHostIntegrationsCreate) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MultiHostIntegrationsCreate) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MultiHostIntegrationsCreate) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MultiHostIntegrationsCreate) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MultiHostIntegrationsCreate) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MultiHostIntegrationsCreate) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsCreateSources.md b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsCreateSources.md new file mode 100644 index 000000000..c23e847e8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostIntegrationsCreateSources.md @@ -0,0 +1,111 @@ +--- +id: v2024-multi-host-integrations-create-sources +title: MultiHostIntegrationsCreateSources +pagination_label: MultiHostIntegrationsCreateSources +sidebar_label: MultiHostIntegrationsCreateSources +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsCreateSources', 'V2024MultiHostIntegrationsCreateSources'] +slug: /tools/sdk/go/v2024/models/multi-host-integrations-create-sources +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreateSources', 'V2024MultiHostIntegrationsCreateSources'] +--- + +# MultiHostIntegrationsCreateSources + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Source's human-readable name. | +**Description** | Pointer to **string** | Source's human-readable description. | [optional] +**ConnectorAttributes** | Pointer to **map[string]interface{}** | Connector specific configuration. This configuration will differ from type to type. | [optional] + +## Methods + +### NewMultiHostIntegrationsCreateSources + +`func NewMultiHostIntegrationsCreateSources(name string, ) *MultiHostIntegrationsCreateSources` + +NewMultiHostIntegrationsCreateSources instantiates a new MultiHostIntegrationsCreateSources 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 + +### NewMultiHostIntegrationsCreateSourcesWithDefaults + +`func NewMultiHostIntegrationsCreateSourcesWithDefaults() *MultiHostIntegrationsCreateSources` + +NewMultiHostIntegrationsCreateSourcesWithDefaults instantiates a new MultiHostIntegrationsCreateSources 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 + +### GetName + +`func (o *MultiHostIntegrationsCreateSources) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrationsCreateSources) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrationsCreateSources) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *MultiHostIntegrationsCreateSources) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *MultiHostIntegrationsCreateSources) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *MultiHostIntegrationsCreateSources) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *MultiHostIntegrationsCreateSources) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetConnectorAttributes + +`func (o *MultiHostIntegrationsCreateSources) GetConnectorAttributes() map[string]interface{}` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *MultiHostIntegrationsCreateSources) GetConnectorAttributesOk() (*map[string]interface{}, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *MultiHostIntegrationsCreateSources) SetConnectorAttributes(v map[string]interface{})` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + +### HasConnectorAttributes + +`func (o *MultiHostIntegrationsCreateSources) HasConnectorAttributes() bool` + +HasConnectorAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MultiHostSources.md b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostSources.md new file mode 100644 index 000000000..04b5c6399 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MultiHostSources.md @@ -0,0 +1,899 @@ +--- +id: v2024-multi-host-sources +title: MultiHostSources +pagination_label: MultiHostSources +sidebar_label: MultiHostSources +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostSources', 'V2024MultiHostSources'] +slug: /tools/sdk/go/v2024/models/multi-host-sources +tags: ['SDK', 'Software Development Kit', 'MultiHostSources', 'V2024MultiHostSources'] +--- + +# MultiHostSources + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Source ID. | [readonly] +**Name** | **string** | Source's human-readable name. | +**Description** | Pointer to **string** | Source's human-readable description. | [optional] +**Owner** | [**SourceOwner**](source-owner) | | +**Cluster** | Pointer to [**NullableSourceCluster**](source-cluster) | | [optional] +**AccountCorrelationConfig** | Pointer to [**NullableSourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional] +**AccountCorrelationRule** | Pointer to [**NullableSourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional] +**ManagerCorrelationMapping** | Pointer to [**ManagerCorrelationMapping**](manager-correlation-mapping) | | [optional] +**ManagerCorrelationRule** | Pointer to [**NullableSourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional] +**BeforeProvisioningRule** | Pointer to [**NullableSourceBeforeProvisioningRule**](source-before-provisioning-rule) | | [optional] +**Schemas** | Pointer to [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional] +**PasswordPolicies** | Pointer to [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**Features** | Pointer to **[]string** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Type** | Pointer to **string** | Specifies the type of system being managed e.g. Multi-Host - Microsoft SQL Server, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Connector** | **string** | Connector script name. | +**ConnectorClass** | Pointer to **string** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**ConnectorAttributes** | Pointer to **map[string]interface{}** | Connector specific configuration. This configuration will differ from type to type. | [optional] +**DeleteThreshold** | Pointer to **int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**Authoritative** | Pointer to **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to false] +**ManagementWorkgroup** | Pointer to [**NullableSourceManagementWorkgroup**](source-management-workgroup) | | [optional] +**Healthy** | Pointer to **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to false] +**Status** | Pointer to **string** | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**Since** | Pointer to **SailPointTime** | Timestamp that shows when a source health check was last performed. | [optional] +**ConnectorId** | Pointer to **string** | Connector ID | [optional] +**ConnectorName** | **string** | Name of the connector that was chosen during source creation. | +**ConnectionType** | Pointer to **string** | Type of connection (direct or file). | [optional] +**ConnectorImplementationId** | Pointer to **string** | Connector implementation ID. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date-time when the source was last modified. | [optional] +**CredentialProviderEnabled** | Pointer to **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to false] +**Category** | Pointer to **NullableString** | Source category (e.g. null, CredentialProvider). | [optional] + +## Methods + +### NewMultiHostSources + +`func NewMultiHostSources(id string, name string, owner SourceOwner, connector string, connectorName string, ) *MultiHostSources` + +NewMultiHostSources instantiates a new MultiHostSources 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 + +### NewMultiHostSourcesWithDefaults + +`func NewMultiHostSourcesWithDefaults() *MultiHostSources` + +NewMultiHostSourcesWithDefaults instantiates a new MultiHostSources 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 + +### GetId + +`func (o *MultiHostSources) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostSources) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostSources) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *MultiHostSources) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostSources) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostSources) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *MultiHostSources) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *MultiHostSources) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *MultiHostSources) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *MultiHostSources) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *MultiHostSources) GetOwner() SourceOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *MultiHostSources) GetOwnerOk() (*SourceOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *MultiHostSources) SetOwner(v SourceOwner)` + +SetOwner sets Owner field to given value. + + +### GetCluster + +`func (o *MultiHostSources) GetCluster() SourceCluster` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *MultiHostSources) GetClusterOk() (*SourceCluster, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *MultiHostSources) SetCluster(v SourceCluster)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *MultiHostSources) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### SetClusterNil + +`func (o *MultiHostSources) SetClusterNil(b bool)` + + SetClusterNil sets the value for Cluster to be an explicit nil + +### UnsetCluster +`func (o *MultiHostSources) UnsetCluster()` + +UnsetCluster ensures that no value is present for Cluster, not even an explicit nil +### GetAccountCorrelationConfig + +`func (o *MultiHostSources) GetAccountCorrelationConfig() SourceAccountCorrelationConfig` + +GetAccountCorrelationConfig returns the AccountCorrelationConfig field if non-nil, zero value otherwise. + +### GetAccountCorrelationConfigOk + +`func (o *MultiHostSources) GetAccountCorrelationConfigOk() (*SourceAccountCorrelationConfig, bool)` + +GetAccountCorrelationConfigOk returns a tuple with the AccountCorrelationConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationConfig + +`func (o *MultiHostSources) SetAccountCorrelationConfig(v SourceAccountCorrelationConfig)` + +SetAccountCorrelationConfig sets AccountCorrelationConfig field to given value. + +### HasAccountCorrelationConfig + +`func (o *MultiHostSources) HasAccountCorrelationConfig() bool` + +HasAccountCorrelationConfig returns a boolean if a field has been set. + +### SetAccountCorrelationConfigNil + +`func (o *MultiHostSources) SetAccountCorrelationConfigNil(b bool)` + + SetAccountCorrelationConfigNil sets the value for AccountCorrelationConfig to be an explicit nil + +### UnsetAccountCorrelationConfig +`func (o *MultiHostSources) UnsetAccountCorrelationConfig()` + +UnsetAccountCorrelationConfig ensures that no value is present for AccountCorrelationConfig, not even an explicit nil +### GetAccountCorrelationRule + +`func (o *MultiHostSources) GetAccountCorrelationRule() SourceAccountCorrelationRule` + +GetAccountCorrelationRule returns the AccountCorrelationRule field if non-nil, zero value otherwise. + +### GetAccountCorrelationRuleOk + +`func (o *MultiHostSources) GetAccountCorrelationRuleOk() (*SourceAccountCorrelationRule, bool)` + +GetAccountCorrelationRuleOk returns a tuple with the AccountCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationRule + +`func (o *MultiHostSources) SetAccountCorrelationRule(v SourceAccountCorrelationRule)` + +SetAccountCorrelationRule sets AccountCorrelationRule field to given value. + +### HasAccountCorrelationRule + +`func (o *MultiHostSources) HasAccountCorrelationRule() bool` + +HasAccountCorrelationRule returns a boolean if a field has been set. + +### SetAccountCorrelationRuleNil + +`func (o *MultiHostSources) SetAccountCorrelationRuleNil(b bool)` + + SetAccountCorrelationRuleNil sets the value for AccountCorrelationRule to be an explicit nil + +### UnsetAccountCorrelationRule +`func (o *MultiHostSources) UnsetAccountCorrelationRule()` + +UnsetAccountCorrelationRule ensures that no value is present for AccountCorrelationRule, not even an explicit nil +### GetManagerCorrelationMapping + +`func (o *MultiHostSources) GetManagerCorrelationMapping() ManagerCorrelationMapping` + +GetManagerCorrelationMapping returns the ManagerCorrelationMapping field if non-nil, zero value otherwise. + +### GetManagerCorrelationMappingOk + +`func (o *MultiHostSources) GetManagerCorrelationMappingOk() (*ManagerCorrelationMapping, bool)` + +GetManagerCorrelationMappingOk returns a tuple with the ManagerCorrelationMapping field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationMapping + +`func (o *MultiHostSources) SetManagerCorrelationMapping(v ManagerCorrelationMapping)` + +SetManagerCorrelationMapping sets ManagerCorrelationMapping field to given value. + +### HasManagerCorrelationMapping + +`func (o *MultiHostSources) HasManagerCorrelationMapping() bool` + +HasManagerCorrelationMapping returns a boolean if a field has been set. + +### GetManagerCorrelationRule + +`func (o *MultiHostSources) GetManagerCorrelationRule() SourceManagerCorrelationRule` + +GetManagerCorrelationRule returns the ManagerCorrelationRule field if non-nil, zero value otherwise. + +### GetManagerCorrelationRuleOk + +`func (o *MultiHostSources) GetManagerCorrelationRuleOk() (*SourceManagerCorrelationRule, bool)` + +GetManagerCorrelationRuleOk returns a tuple with the ManagerCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationRule + +`func (o *MultiHostSources) SetManagerCorrelationRule(v SourceManagerCorrelationRule)` + +SetManagerCorrelationRule sets ManagerCorrelationRule field to given value. + +### HasManagerCorrelationRule + +`func (o *MultiHostSources) HasManagerCorrelationRule() bool` + +HasManagerCorrelationRule returns a boolean if a field has been set. + +### SetManagerCorrelationRuleNil + +`func (o *MultiHostSources) SetManagerCorrelationRuleNil(b bool)` + + SetManagerCorrelationRuleNil sets the value for ManagerCorrelationRule to be an explicit nil + +### UnsetManagerCorrelationRule +`func (o *MultiHostSources) UnsetManagerCorrelationRule()` + +UnsetManagerCorrelationRule ensures that no value is present for ManagerCorrelationRule, not even an explicit nil +### GetBeforeProvisioningRule + +`func (o *MultiHostSources) GetBeforeProvisioningRule() SourceBeforeProvisioningRule` + +GetBeforeProvisioningRule returns the BeforeProvisioningRule field if non-nil, zero value otherwise. + +### GetBeforeProvisioningRuleOk + +`func (o *MultiHostSources) GetBeforeProvisioningRuleOk() (*SourceBeforeProvisioningRule, bool)` + +GetBeforeProvisioningRuleOk returns a tuple with the BeforeProvisioningRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBeforeProvisioningRule + +`func (o *MultiHostSources) SetBeforeProvisioningRule(v SourceBeforeProvisioningRule)` + +SetBeforeProvisioningRule sets BeforeProvisioningRule field to given value. + +### HasBeforeProvisioningRule + +`func (o *MultiHostSources) HasBeforeProvisioningRule() bool` + +HasBeforeProvisioningRule returns a boolean if a field has been set. + +### SetBeforeProvisioningRuleNil + +`func (o *MultiHostSources) SetBeforeProvisioningRuleNil(b bool)` + + SetBeforeProvisioningRuleNil sets the value for BeforeProvisioningRule to be an explicit nil + +### UnsetBeforeProvisioningRule +`func (o *MultiHostSources) UnsetBeforeProvisioningRule()` + +UnsetBeforeProvisioningRule ensures that no value is present for BeforeProvisioningRule, not even an explicit nil +### GetSchemas + +`func (o *MultiHostSources) GetSchemas() []SourceSchemasInner` + +GetSchemas returns the Schemas field if non-nil, zero value otherwise. + +### GetSchemasOk + +`func (o *MultiHostSources) GetSchemasOk() (*[]SourceSchemasInner, bool)` + +GetSchemasOk returns a tuple with the Schemas field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchemas + +`func (o *MultiHostSources) SetSchemas(v []SourceSchemasInner)` + +SetSchemas sets Schemas field to given value. + +### HasSchemas + +`func (o *MultiHostSources) HasSchemas() bool` + +HasSchemas returns a boolean if a field has been set. + +### GetPasswordPolicies + +`func (o *MultiHostSources) GetPasswordPolicies() []SourcePasswordPoliciesInner` + +GetPasswordPolicies returns the PasswordPolicies field if non-nil, zero value otherwise. + +### GetPasswordPoliciesOk + +`func (o *MultiHostSources) GetPasswordPoliciesOk() (*[]SourcePasswordPoliciesInner, bool)` + +GetPasswordPoliciesOk returns a tuple with the PasswordPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicies + +`func (o *MultiHostSources) SetPasswordPolicies(v []SourcePasswordPoliciesInner)` + +SetPasswordPolicies sets PasswordPolicies field to given value. + +### HasPasswordPolicies + +`func (o *MultiHostSources) HasPasswordPolicies() bool` + +HasPasswordPolicies returns a boolean if a field has been set. + +### SetPasswordPoliciesNil + +`func (o *MultiHostSources) SetPasswordPoliciesNil(b bool)` + + SetPasswordPoliciesNil sets the value for PasswordPolicies to be an explicit nil + +### UnsetPasswordPolicies +`func (o *MultiHostSources) UnsetPasswordPolicies()` + +UnsetPasswordPolicies ensures that no value is present for PasswordPolicies, not even an explicit nil +### GetFeatures + +`func (o *MultiHostSources) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *MultiHostSources) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *MultiHostSources) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *MultiHostSources) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### GetType + +`func (o *MultiHostSources) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostSources) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostSources) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MultiHostSources) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConnector + +`func (o *MultiHostSources) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *MultiHostSources) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *MultiHostSources) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetConnectorClass + +`func (o *MultiHostSources) GetConnectorClass() string` + +GetConnectorClass returns the ConnectorClass field if non-nil, zero value otherwise. + +### GetConnectorClassOk + +`func (o *MultiHostSources) GetConnectorClassOk() (*string, bool)` + +GetConnectorClassOk returns a tuple with the ConnectorClass field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorClass + +`func (o *MultiHostSources) SetConnectorClass(v string)` + +SetConnectorClass sets ConnectorClass field to given value. + +### HasConnectorClass + +`func (o *MultiHostSources) HasConnectorClass() bool` + +HasConnectorClass returns a boolean if a field has been set. + +### GetConnectorAttributes + +`func (o *MultiHostSources) GetConnectorAttributes() map[string]interface{}` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *MultiHostSources) GetConnectorAttributesOk() (*map[string]interface{}, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *MultiHostSources) SetConnectorAttributes(v map[string]interface{})` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + +### HasConnectorAttributes + +`func (o *MultiHostSources) HasConnectorAttributes() bool` + +HasConnectorAttributes returns a boolean if a field has been set. + +### GetDeleteThreshold + +`func (o *MultiHostSources) GetDeleteThreshold() int32` + +GetDeleteThreshold returns the DeleteThreshold field if non-nil, zero value otherwise. + +### GetDeleteThresholdOk + +`func (o *MultiHostSources) GetDeleteThresholdOk() (*int32, bool)` + +GetDeleteThresholdOk returns a tuple with the DeleteThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteThreshold + +`func (o *MultiHostSources) SetDeleteThreshold(v int32)` + +SetDeleteThreshold sets DeleteThreshold field to given value. + +### HasDeleteThreshold + +`func (o *MultiHostSources) HasDeleteThreshold() bool` + +HasDeleteThreshold returns a boolean if a field has been set. + +### GetAuthoritative + +`func (o *MultiHostSources) GetAuthoritative() bool` + +GetAuthoritative returns the Authoritative field if non-nil, zero value otherwise. + +### GetAuthoritativeOk + +`func (o *MultiHostSources) GetAuthoritativeOk() (*bool, bool)` + +GetAuthoritativeOk returns a tuple with the Authoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritative + +`func (o *MultiHostSources) SetAuthoritative(v bool)` + +SetAuthoritative sets Authoritative field to given value. + +### HasAuthoritative + +`func (o *MultiHostSources) HasAuthoritative() bool` + +HasAuthoritative returns a boolean if a field has been set. + +### GetManagementWorkgroup + +`func (o *MultiHostSources) GetManagementWorkgroup() SourceManagementWorkgroup` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *MultiHostSources) GetManagementWorkgroupOk() (*SourceManagementWorkgroup, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *MultiHostSources) SetManagementWorkgroup(v SourceManagementWorkgroup)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *MultiHostSources) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### SetManagementWorkgroupNil + +`func (o *MultiHostSources) SetManagementWorkgroupNil(b bool)` + + SetManagementWorkgroupNil sets the value for ManagementWorkgroup to be an explicit nil + +### UnsetManagementWorkgroup +`func (o *MultiHostSources) UnsetManagementWorkgroup()` + +UnsetManagementWorkgroup ensures that no value is present for ManagementWorkgroup, not even an explicit nil +### GetHealthy + +`func (o *MultiHostSources) GetHealthy() bool` + +GetHealthy returns the Healthy field if non-nil, zero value otherwise. + +### GetHealthyOk + +`func (o *MultiHostSources) GetHealthyOk() (*bool, bool)` + +GetHealthyOk returns a tuple with the Healthy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthy + +`func (o *MultiHostSources) SetHealthy(v bool)` + +SetHealthy sets Healthy field to given value. + +### HasHealthy + +`func (o *MultiHostSources) HasHealthy() bool` + +HasHealthy returns a boolean if a field has been set. + +### GetStatus + +`func (o *MultiHostSources) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *MultiHostSources) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *MultiHostSources) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *MultiHostSources) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSince + +`func (o *MultiHostSources) GetSince() SailPointTime` + +GetSince returns the Since field if non-nil, zero value otherwise. + +### GetSinceOk + +`func (o *MultiHostSources) GetSinceOk() (*SailPointTime, bool)` + +GetSinceOk returns a tuple with the Since field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSince + +`func (o *MultiHostSources) SetSince(v SailPointTime)` + +SetSince sets Since field to given value. + +### HasSince + +`func (o *MultiHostSources) HasSince() bool` + +HasSince returns a boolean if a field has been set. + +### GetConnectorId + +`func (o *MultiHostSources) GetConnectorId() string` + +GetConnectorId returns the ConnectorId field if non-nil, zero value otherwise. + +### GetConnectorIdOk + +`func (o *MultiHostSources) GetConnectorIdOk() (*string, bool)` + +GetConnectorIdOk returns a tuple with the ConnectorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorId + +`func (o *MultiHostSources) SetConnectorId(v string)` + +SetConnectorId sets ConnectorId field to given value. + +### HasConnectorId + +`func (o *MultiHostSources) HasConnectorId() bool` + +HasConnectorId returns a boolean if a field has been set. + +### GetConnectorName + +`func (o *MultiHostSources) GetConnectorName() string` + +GetConnectorName returns the ConnectorName field if non-nil, zero value otherwise. + +### GetConnectorNameOk + +`func (o *MultiHostSources) GetConnectorNameOk() (*string, bool)` + +GetConnectorNameOk returns a tuple with the ConnectorName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorName + +`func (o *MultiHostSources) SetConnectorName(v string)` + +SetConnectorName sets ConnectorName field to given value. + + +### GetConnectionType + +`func (o *MultiHostSources) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *MultiHostSources) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *MultiHostSources) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *MultiHostSources) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + +### GetConnectorImplementationId + +`func (o *MultiHostSources) GetConnectorImplementationId() string` + +GetConnectorImplementationId returns the ConnectorImplementationId field if non-nil, zero value otherwise. + +### GetConnectorImplementationIdOk + +`func (o *MultiHostSources) GetConnectorImplementationIdOk() (*string, bool)` + +GetConnectorImplementationIdOk returns a tuple with the ConnectorImplementationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorImplementationId + +`func (o *MultiHostSources) SetConnectorImplementationId(v string)` + +SetConnectorImplementationId sets ConnectorImplementationId field to given value. + +### HasConnectorImplementationId + +`func (o *MultiHostSources) HasConnectorImplementationId() bool` + +HasConnectorImplementationId returns a boolean if a field has been set. + +### GetCreated + +`func (o *MultiHostSources) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MultiHostSources) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MultiHostSources) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MultiHostSources) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MultiHostSources) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MultiHostSources) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MultiHostSources) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MultiHostSources) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCredentialProviderEnabled + +`func (o *MultiHostSources) GetCredentialProviderEnabled() bool` + +GetCredentialProviderEnabled returns the CredentialProviderEnabled field if non-nil, zero value otherwise. + +### GetCredentialProviderEnabledOk + +`func (o *MultiHostSources) GetCredentialProviderEnabledOk() (*bool, bool)` + +GetCredentialProviderEnabledOk returns a tuple with the CredentialProviderEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialProviderEnabled + +`func (o *MultiHostSources) SetCredentialProviderEnabled(v bool)` + +SetCredentialProviderEnabled sets CredentialProviderEnabled field to given value. + +### HasCredentialProviderEnabled + +`func (o *MultiHostSources) HasCredentialProviderEnabled() bool` + +HasCredentialProviderEnabled returns a boolean if a field has been set. + +### GetCategory + +`func (o *MultiHostSources) GetCategory() string` + +GetCategory returns the Category field if non-nil, zero value otherwise. + +### GetCategoryOk + +`func (o *MultiHostSources) GetCategoryOk() (*string, bool)` + +GetCategoryOk returns a tuple with the Category field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCategory + +`func (o *MultiHostSources) SetCategory(v string)` + +SetCategory sets Category field to given value. + +### HasCategory + +`func (o *MultiHostSources) HasCategory() bool` + +HasCategory returns a boolean if a field has been set. + +### SetCategoryNil + +`func (o *MultiHostSources) SetCategoryNil(b bool)` + + SetCategoryNil sets the value for Category to be an explicit nil + +### UnsetCategory +`func (o *MultiHostSources) UnsetCategory()` + +UnsetCategory ensures that no value is present for Category, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/MultiPolicyRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/MultiPolicyRequest.md new file mode 100644 index 000000000..a7c38766e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/MultiPolicyRequest.md @@ -0,0 +1,64 @@ +--- +id: v2024-multi-policy-request +title: MultiPolicyRequest +pagination_label: MultiPolicyRequest +sidebar_label: MultiPolicyRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiPolicyRequest', 'V2024MultiPolicyRequest'] +slug: /tools/sdk/go/v2024/models/multi-policy-request +tags: ['SDK', 'Software Development Kit', 'MultiPolicyRequest', 'V2024MultiPolicyRequest'] +--- + +# MultiPolicyRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FilteredPolicyList** | Pointer to **[]string** | Multi-policy report will be run for this list of ids | [optional] + +## Methods + +### NewMultiPolicyRequest + +`func NewMultiPolicyRequest() *MultiPolicyRequest` + +NewMultiPolicyRequest instantiates a new MultiPolicyRequest 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 + +### NewMultiPolicyRequestWithDefaults + +`func NewMultiPolicyRequestWithDefaults() *MultiPolicyRequest` + +NewMultiPolicyRequestWithDefaults instantiates a new MultiPolicyRequest 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 + +### GetFilteredPolicyList + +`func (o *MultiPolicyRequest) GetFilteredPolicyList() []string` + +GetFilteredPolicyList returns the FilteredPolicyList field if non-nil, zero value otherwise. + +### GetFilteredPolicyListOk + +`func (o *MultiPolicyRequest) GetFilteredPolicyListOk() (*[]string, bool)` + +GetFilteredPolicyListOk returns a tuple with the FilteredPolicyList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilteredPolicyList + +`func (o *MultiPolicyRequest) SetFilteredPolicyList(v []string)` + +SetFilteredPolicyList sets FilteredPolicyList field to given value. + +### HasFilteredPolicyList + +`func (o *MultiPolicyRequest) HasFilteredPolicyList() bool` + +HasFilteredPolicyList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NativeChangeDetectionConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/NativeChangeDetectionConfig.md new file mode 100644 index 000000000..4c2d95d8c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NativeChangeDetectionConfig.md @@ -0,0 +1,194 @@ +--- +id: v2024-native-change-detection-config +title: NativeChangeDetectionConfig +pagination_label: NativeChangeDetectionConfig +sidebar_label: NativeChangeDetectionConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NativeChangeDetectionConfig', 'V2024NativeChangeDetectionConfig'] +slug: /tools/sdk/go/v2024/models/native-change-detection-config +tags: ['SDK', 'Software Development Kit', 'NativeChangeDetectionConfig', 'V2024NativeChangeDetectionConfig'] +--- + +# NativeChangeDetectionConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | A flag indicating if Native Change Detection is enabled for a source. | [optional] [default to false] +**Operations** | Pointer to **[]string** | Operation types for which Native Change Detection is enabled for a source. | [optional] +**AllEntitlements** | Pointer to **bool** | A flag indicating that all entitlements participate in Native Change Detection. | [optional] [default to false] +**AllNonEntitlementAttributes** | Pointer to **bool** | A flag indicating that all non-entitlement account attributes participate in Native Change Detection. | [optional] [default to false] +**SelectedEntitlements** | Pointer to **[]string** | If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection. | [optional] +**SelectedNonEntitlementAttributes** | Pointer to **[]string** | If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection. | [optional] + +## Methods + +### NewNativeChangeDetectionConfig + +`func NewNativeChangeDetectionConfig() *NativeChangeDetectionConfig` + +NewNativeChangeDetectionConfig instantiates a new NativeChangeDetectionConfig 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 + +### NewNativeChangeDetectionConfigWithDefaults + +`func NewNativeChangeDetectionConfigWithDefaults() *NativeChangeDetectionConfig` + +NewNativeChangeDetectionConfigWithDefaults instantiates a new NativeChangeDetectionConfig 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 + +### GetEnabled + +`func (o *NativeChangeDetectionConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *NativeChangeDetectionConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *NativeChangeDetectionConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *NativeChangeDetectionConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetOperations + +`func (o *NativeChangeDetectionConfig) GetOperations() []string` + +GetOperations returns the Operations field if non-nil, zero value otherwise. + +### GetOperationsOk + +`func (o *NativeChangeDetectionConfig) GetOperationsOk() (*[]string, bool)` + +GetOperationsOk returns a tuple with the Operations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperations + +`func (o *NativeChangeDetectionConfig) SetOperations(v []string)` + +SetOperations sets Operations field to given value. + +### HasOperations + +`func (o *NativeChangeDetectionConfig) HasOperations() bool` + +HasOperations returns a boolean if a field has been set. + +### GetAllEntitlements + +`func (o *NativeChangeDetectionConfig) GetAllEntitlements() bool` + +GetAllEntitlements returns the AllEntitlements field if non-nil, zero value otherwise. + +### GetAllEntitlementsOk + +`func (o *NativeChangeDetectionConfig) GetAllEntitlementsOk() (*bool, bool)` + +GetAllEntitlementsOk returns a tuple with the AllEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllEntitlements + +`func (o *NativeChangeDetectionConfig) SetAllEntitlements(v bool)` + +SetAllEntitlements sets AllEntitlements field to given value. + +### HasAllEntitlements + +`func (o *NativeChangeDetectionConfig) HasAllEntitlements() bool` + +HasAllEntitlements returns a boolean if a field has been set. + +### GetAllNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) GetAllNonEntitlementAttributes() bool` + +GetAllNonEntitlementAttributes returns the AllNonEntitlementAttributes field if non-nil, zero value otherwise. + +### GetAllNonEntitlementAttributesOk + +`func (o *NativeChangeDetectionConfig) GetAllNonEntitlementAttributesOk() (*bool, bool)` + +GetAllNonEntitlementAttributesOk returns a tuple with the AllNonEntitlementAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) SetAllNonEntitlementAttributes(v bool)` + +SetAllNonEntitlementAttributes sets AllNonEntitlementAttributes field to given value. + +### HasAllNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) HasAllNonEntitlementAttributes() bool` + +HasAllNonEntitlementAttributes returns a boolean if a field has been set. + +### GetSelectedEntitlements + +`func (o *NativeChangeDetectionConfig) GetSelectedEntitlements() []string` + +GetSelectedEntitlements returns the SelectedEntitlements field if non-nil, zero value otherwise. + +### GetSelectedEntitlementsOk + +`func (o *NativeChangeDetectionConfig) GetSelectedEntitlementsOk() (*[]string, bool)` + +GetSelectedEntitlementsOk returns a tuple with the SelectedEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectedEntitlements + +`func (o *NativeChangeDetectionConfig) SetSelectedEntitlements(v []string)` + +SetSelectedEntitlements sets SelectedEntitlements field to given value. + +### HasSelectedEntitlements + +`func (o *NativeChangeDetectionConfig) HasSelectedEntitlements() bool` + +HasSelectedEntitlements returns a boolean if a field has been set. + +### GetSelectedNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) GetSelectedNonEntitlementAttributes() []string` + +GetSelectedNonEntitlementAttributes returns the SelectedNonEntitlementAttributes field if non-nil, zero value otherwise. + +### GetSelectedNonEntitlementAttributesOk + +`func (o *NativeChangeDetectionConfig) GetSelectedNonEntitlementAttributesOk() (*[]string, bool)` + +GetSelectedNonEntitlementAttributesOk returns a tuple with the SelectedNonEntitlementAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectedNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) SetSelectedNonEntitlementAttributes(v []string)` + +SetSelectedNonEntitlementAttributes sets SelectedNonEntitlementAttributes field to given value. + +### HasSelectedNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) HasSelectedNonEntitlementAttributes() bool` + +HasSelectedNonEntitlementAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NestedAggregation.md b/docs/tools/sdk/go/Reference/V2024/Models/NestedAggregation.md new file mode 100644 index 000000000..d16dff98a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NestedAggregation.md @@ -0,0 +1,80 @@ +--- +id: v2024-nested-aggregation +title: NestedAggregation +pagination_label: NestedAggregation +sidebar_label: NestedAggregation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NestedAggregation', 'V2024NestedAggregation'] +slug: /tools/sdk/go/v2024/models/nested-aggregation +tags: ['SDK', 'Software Development Kit', 'NestedAggregation', 'V2024NestedAggregation'] +--- + +# NestedAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the nested aggregate to be included in the result. | +**Type** | **string** | The type of the nested object. | + +## Methods + +### NewNestedAggregation + +`func NewNestedAggregation(name string, type_ string, ) *NestedAggregation` + +NewNestedAggregation instantiates a new NestedAggregation 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 + +### NewNestedAggregationWithDefaults + +`func NewNestedAggregationWithDefaults() *NestedAggregation` + +NewNestedAggregationWithDefaults instantiates a new NestedAggregation 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 + +### GetName + +`func (o *NestedAggregation) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NestedAggregation) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NestedAggregation) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *NestedAggregation) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NestedAggregation) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NestedAggregation) SetType(v string)` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NetworkConfiguration.md b/docs/tools/sdk/go/Reference/V2024/Models/NetworkConfiguration.md new file mode 100644 index 000000000..558b4ae53 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NetworkConfiguration.md @@ -0,0 +1,136 @@ +--- +id: v2024-network-configuration +title: NetworkConfiguration +pagination_label: NetworkConfiguration +sidebar_label: NetworkConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NetworkConfiguration', 'V2024NetworkConfiguration'] +slug: /tools/sdk/go/v2024/models/network-configuration +tags: ['SDK', 'Software Development Kit', 'NetworkConfiguration', 'V2024NetworkConfiguration'] +--- + +# NetworkConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Range** | Pointer to **[]string** | The collection of ip ranges. | [optional] +**Geolocation** | Pointer to **[]string** | The collection of country codes. | [optional] +**Whitelisted** | Pointer to **bool** | Denotes whether the provided lists are whitelisted or blacklisted for geo location. | [optional] [default to false] + +## Methods + +### NewNetworkConfiguration + +`func NewNetworkConfiguration() *NetworkConfiguration` + +NewNetworkConfiguration instantiates a new NetworkConfiguration 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 + +### NewNetworkConfigurationWithDefaults + +`func NewNetworkConfigurationWithDefaults() *NetworkConfiguration` + +NewNetworkConfigurationWithDefaults instantiates a new NetworkConfiguration 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 + +### GetRange + +`func (o *NetworkConfiguration) GetRange() []string` + +GetRange returns the Range field if non-nil, zero value otherwise. + +### GetRangeOk + +`func (o *NetworkConfiguration) GetRangeOk() (*[]string, bool)` + +GetRangeOk returns a tuple with the Range field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRange + +`func (o *NetworkConfiguration) SetRange(v []string)` + +SetRange sets Range field to given value. + +### HasRange + +`func (o *NetworkConfiguration) HasRange() bool` + +HasRange returns a boolean if a field has been set. + +### SetRangeNil + +`func (o *NetworkConfiguration) SetRangeNil(b bool)` + + SetRangeNil sets the value for Range to be an explicit nil + +### UnsetRange +`func (o *NetworkConfiguration) UnsetRange()` + +UnsetRange ensures that no value is present for Range, not even an explicit nil +### GetGeolocation + +`func (o *NetworkConfiguration) GetGeolocation() []string` + +GetGeolocation returns the Geolocation field if non-nil, zero value otherwise. + +### GetGeolocationOk + +`func (o *NetworkConfiguration) GetGeolocationOk() (*[]string, bool)` + +GetGeolocationOk returns a tuple with the Geolocation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGeolocation + +`func (o *NetworkConfiguration) SetGeolocation(v []string)` + +SetGeolocation sets Geolocation field to given value. + +### HasGeolocation + +`func (o *NetworkConfiguration) HasGeolocation() bool` + +HasGeolocation returns a boolean if a field has been set. + +### SetGeolocationNil + +`func (o *NetworkConfiguration) SetGeolocationNil(b bool)` + + SetGeolocationNil sets the value for Geolocation to be an explicit nil + +### UnsetGeolocation +`func (o *NetworkConfiguration) UnsetGeolocation()` + +UnsetGeolocation ensures that no value is present for Geolocation, not even an explicit nil +### GetWhitelisted + +`func (o *NetworkConfiguration) GetWhitelisted() bool` + +GetWhitelisted returns the Whitelisted field if non-nil, zero value otherwise. + +### GetWhitelistedOk + +`func (o *NetworkConfiguration) GetWhitelistedOk() (*bool, bool)` + +GetWhitelistedOk returns a tuple with the Whitelisted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWhitelisted + +`func (o *NetworkConfiguration) SetWhitelisted(v bool)` + +SetWhitelisted sets Whitelisted field to given value. + +### HasWhitelisted + +`func (o *NetworkConfiguration) HasWhitelisted() bool` + +HasWhitelisted returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeApprovalDecision.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeApprovalDecision.md new file mode 100644 index 000000000..aa0ccf2af --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeApprovalDecision.md @@ -0,0 +1,64 @@ +--- +id: v2024-non-employee-approval-decision +title: NonEmployeeApprovalDecision +pagination_label: NonEmployeeApprovalDecision +sidebar_label: NonEmployeeApprovalDecision +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalDecision', 'V2024NonEmployeeApprovalDecision'] +slug: /tools/sdk/go/v2024/models/non-employee-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalDecision', 'V2024NonEmployeeApprovalDecision'] +--- + +# NonEmployeeApprovalDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment on the approval item. | [optional] + +## Methods + +### NewNonEmployeeApprovalDecision + +`func NewNonEmployeeApprovalDecision() *NonEmployeeApprovalDecision` + +NewNonEmployeeApprovalDecision instantiates a new NonEmployeeApprovalDecision 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 + +### NewNonEmployeeApprovalDecisionWithDefaults + +`func NewNonEmployeeApprovalDecisionWithDefaults() *NonEmployeeApprovalDecision` + +NewNonEmployeeApprovalDecisionWithDefaults instantiates a new NonEmployeeApprovalDecision 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 + +### GetComment + +`func (o *NonEmployeeApprovalDecision) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeApprovalDecision) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeApprovalDecision) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeApprovalDecision) HasComment() bool` + +HasComment returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeApprovalItem.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeApprovalItem.md new file mode 100644 index 000000000..613da5c55 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeApprovalItem.md @@ -0,0 +1,272 @@ +--- +id: v2024-non-employee-approval-item +title: NonEmployeeApprovalItem +pagination_label: NonEmployeeApprovalItem +sidebar_label: NonEmployeeApprovalItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalItem', 'V2024NonEmployeeApprovalItem'] +slug: /tools/sdk/go/v2024/models/non-employee-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItem', 'V2024NonEmployeeApprovalItem'] +--- + +# NonEmployeeApprovalItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **string** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **float32** | Approval order | [optional] +**Comment** | Pointer to **string** | comment of approver | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestLite**](non-employee-request-lite) | | [optional] + +## Methods + +### NewNonEmployeeApprovalItem + +`func NewNonEmployeeApprovalItem() *NonEmployeeApprovalItem` + +NewNonEmployeeApprovalItem instantiates a new NonEmployeeApprovalItem 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 + +### NewNonEmployeeApprovalItemWithDefaults + +`func NewNonEmployeeApprovalItemWithDefaults() *NonEmployeeApprovalItem` + +NewNonEmployeeApprovalItemWithDefaults instantiates a new NonEmployeeApprovalItem 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 + +### GetId + +`func (o *NonEmployeeApprovalItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeApprovalItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeApprovalItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeApprovalItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetApprover + +`func (o *NonEmployeeApprovalItem) GetApprover() NonEmployeeIdentityReferenceWithId` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *NonEmployeeApprovalItem) GetApproverOk() (*NonEmployeeIdentityReferenceWithId, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *NonEmployeeApprovalItem) SetApprover(v NonEmployeeIdentityReferenceWithId)` + +SetApprover sets Approver field to given value. + +### HasApprover + +`func (o *NonEmployeeApprovalItem) HasApprover() bool` + +HasApprover returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeApprovalItem) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeApprovalItem) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeApprovalItem) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeApprovalItem) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeApprovalItem) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeApprovalItem) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeApprovalItem) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeApprovalItem) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetApprovalOrder + +`func (o *NonEmployeeApprovalItem) GetApprovalOrder() float32` + +GetApprovalOrder returns the ApprovalOrder field if non-nil, zero value otherwise. + +### GetApprovalOrderOk + +`func (o *NonEmployeeApprovalItem) GetApprovalOrderOk() (*float32, bool)` + +GetApprovalOrderOk returns a tuple with the ApprovalOrder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalOrder + +`func (o *NonEmployeeApprovalItem) SetApprovalOrder(v float32)` + +SetApprovalOrder sets ApprovalOrder field to given value. + +### HasApprovalOrder + +`func (o *NonEmployeeApprovalItem) HasApprovalOrder() bool` + +HasApprovalOrder returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeApprovalItem) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeApprovalItem) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeApprovalItem) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeApprovalItem) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeApprovalItem) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeApprovalItem) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeApprovalItem) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeApprovalItem) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeApprovalItem) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeApprovalItem) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeApprovalItem) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeApprovalItem) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetNonEmployeeRequest + +`func (o *NonEmployeeApprovalItem) GetNonEmployeeRequest() NonEmployeeRequestLite` + +GetNonEmployeeRequest returns the NonEmployeeRequest field if non-nil, zero value otherwise. + +### GetNonEmployeeRequestOk + +`func (o *NonEmployeeApprovalItem) GetNonEmployeeRequestOk() (*NonEmployeeRequestLite, bool)` + +GetNonEmployeeRequestOk returns a tuple with the NonEmployeeRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeRequest + +`func (o *NonEmployeeApprovalItem) SetNonEmployeeRequest(v NonEmployeeRequestLite)` + +SetNonEmployeeRequest sets NonEmployeeRequest field to given value. + +### HasNonEmployeeRequest + +`func (o *NonEmployeeApprovalItem) HasNonEmployeeRequest() bool` + +HasNonEmployeeRequest returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeApprovalItemBase.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeApprovalItemBase.md new file mode 100644 index 000000000..95a8cc505 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeApprovalItemBase.md @@ -0,0 +1,246 @@ +--- +id: v2024-non-employee-approval-item-base +title: NonEmployeeApprovalItemBase +pagination_label: NonEmployeeApprovalItemBase +sidebar_label: NonEmployeeApprovalItemBase +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalItemBase', 'V2024NonEmployeeApprovalItemBase'] +slug: /tools/sdk/go/v2024/models/non-employee-approval-item-base +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemBase', 'V2024NonEmployeeApprovalItemBase'] +--- + +# NonEmployeeApprovalItemBase + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **string** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **float32** | Approval order | [optional] +**Comment** | Pointer to **string** | comment of approver | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeApprovalItemBase + +`func NewNonEmployeeApprovalItemBase() *NonEmployeeApprovalItemBase` + +NewNonEmployeeApprovalItemBase instantiates a new NonEmployeeApprovalItemBase 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 + +### NewNonEmployeeApprovalItemBaseWithDefaults + +`func NewNonEmployeeApprovalItemBaseWithDefaults() *NonEmployeeApprovalItemBase` + +NewNonEmployeeApprovalItemBaseWithDefaults instantiates a new NonEmployeeApprovalItemBase 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 + +### GetId + +`func (o *NonEmployeeApprovalItemBase) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeApprovalItemBase) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeApprovalItemBase) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeApprovalItemBase) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetApprover + +`func (o *NonEmployeeApprovalItemBase) GetApprover() NonEmployeeIdentityReferenceWithId` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *NonEmployeeApprovalItemBase) GetApproverOk() (*NonEmployeeIdentityReferenceWithId, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *NonEmployeeApprovalItemBase) SetApprover(v NonEmployeeIdentityReferenceWithId)` + +SetApprover sets Approver field to given value. + +### HasApprover + +`func (o *NonEmployeeApprovalItemBase) HasApprover() bool` + +HasApprover returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeApprovalItemBase) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeApprovalItemBase) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeApprovalItemBase) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeApprovalItemBase) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeApprovalItemBase) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeApprovalItemBase) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeApprovalItemBase) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeApprovalItemBase) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetApprovalOrder + +`func (o *NonEmployeeApprovalItemBase) GetApprovalOrder() float32` + +GetApprovalOrder returns the ApprovalOrder field if non-nil, zero value otherwise. + +### GetApprovalOrderOk + +`func (o *NonEmployeeApprovalItemBase) GetApprovalOrderOk() (*float32, bool)` + +GetApprovalOrderOk returns a tuple with the ApprovalOrder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalOrder + +`func (o *NonEmployeeApprovalItemBase) SetApprovalOrder(v float32)` + +SetApprovalOrder sets ApprovalOrder field to given value. + +### HasApprovalOrder + +`func (o *NonEmployeeApprovalItemBase) HasApprovalOrder() bool` + +HasApprovalOrder returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeApprovalItemBase) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeApprovalItemBase) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeApprovalItemBase) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeApprovalItemBase) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeApprovalItemBase) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeApprovalItemBase) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeApprovalItemBase) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeApprovalItemBase) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeApprovalItemBase) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeApprovalItemBase) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeApprovalItemBase) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeApprovalItemBase) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeApprovalItemDetail.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeApprovalItemDetail.md new file mode 100644 index 000000000..6081a8b31 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeApprovalItemDetail.md @@ -0,0 +1,272 @@ +--- +id: v2024-non-employee-approval-item-detail +title: NonEmployeeApprovalItemDetail +pagination_label: NonEmployeeApprovalItemDetail +sidebar_label: NonEmployeeApprovalItemDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalItemDetail', 'V2024NonEmployeeApprovalItemDetail'] +slug: /tools/sdk/go/v2024/models/non-employee-approval-item-detail +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemDetail', 'V2024NonEmployeeApprovalItemDetail'] +--- + +# NonEmployeeApprovalItemDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **string** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **float32** | Approval order | [optional] +**Comment** | Pointer to **string** | comment of approver | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestWithoutApprovalItem**](non-employee-request-without-approval-item) | | [optional] + +## Methods + +### NewNonEmployeeApprovalItemDetail + +`func NewNonEmployeeApprovalItemDetail() *NonEmployeeApprovalItemDetail` + +NewNonEmployeeApprovalItemDetail instantiates a new NonEmployeeApprovalItemDetail 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 + +### NewNonEmployeeApprovalItemDetailWithDefaults + +`func NewNonEmployeeApprovalItemDetailWithDefaults() *NonEmployeeApprovalItemDetail` + +NewNonEmployeeApprovalItemDetailWithDefaults instantiates a new NonEmployeeApprovalItemDetail 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 + +### GetId + +`func (o *NonEmployeeApprovalItemDetail) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeApprovalItemDetail) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeApprovalItemDetail) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeApprovalItemDetail) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetApprover + +`func (o *NonEmployeeApprovalItemDetail) GetApprover() NonEmployeeIdentityReferenceWithId` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *NonEmployeeApprovalItemDetail) GetApproverOk() (*NonEmployeeIdentityReferenceWithId, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *NonEmployeeApprovalItemDetail) SetApprover(v NonEmployeeIdentityReferenceWithId)` + +SetApprover sets Approver field to given value. + +### HasApprover + +`func (o *NonEmployeeApprovalItemDetail) HasApprover() bool` + +HasApprover returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeApprovalItemDetail) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeApprovalItemDetail) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeApprovalItemDetail) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeApprovalItemDetail) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeApprovalItemDetail) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeApprovalItemDetail) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeApprovalItemDetail) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeApprovalItemDetail) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetApprovalOrder + +`func (o *NonEmployeeApprovalItemDetail) GetApprovalOrder() float32` + +GetApprovalOrder returns the ApprovalOrder field if non-nil, zero value otherwise. + +### GetApprovalOrderOk + +`func (o *NonEmployeeApprovalItemDetail) GetApprovalOrderOk() (*float32, bool)` + +GetApprovalOrderOk returns a tuple with the ApprovalOrder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalOrder + +`func (o *NonEmployeeApprovalItemDetail) SetApprovalOrder(v float32)` + +SetApprovalOrder sets ApprovalOrder field to given value. + +### HasApprovalOrder + +`func (o *NonEmployeeApprovalItemDetail) HasApprovalOrder() bool` + +HasApprovalOrder returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeApprovalItemDetail) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeApprovalItemDetail) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeApprovalItemDetail) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeApprovalItemDetail) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeApprovalItemDetail) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeApprovalItemDetail) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeApprovalItemDetail) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeApprovalItemDetail) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeApprovalItemDetail) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeApprovalItemDetail) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeApprovalItemDetail) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeApprovalItemDetail) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetNonEmployeeRequest + +`func (o *NonEmployeeApprovalItemDetail) GetNonEmployeeRequest() NonEmployeeRequestWithoutApprovalItem` + +GetNonEmployeeRequest returns the NonEmployeeRequest field if non-nil, zero value otherwise. + +### GetNonEmployeeRequestOk + +`func (o *NonEmployeeApprovalItemDetail) GetNonEmployeeRequestOk() (*NonEmployeeRequestWithoutApprovalItem, bool)` + +GetNonEmployeeRequestOk returns a tuple with the NonEmployeeRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeRequest + +`func (o *NonEmployeeApprovalItemDetail) SetNonEmployeeRequest(v NonEmployeeRequestWithoutApprovalItem)` + +SetNonEmployeeRequest sets NonEmployeeRequest field to given value. + +### HasNonEmployeeRequest + +`func (o *NonEmployeeApprovalItemDetail) HasNonEmployeeRequest() bool` + +HasNonEmployeeRequest returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeApprovalSummary.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeApprovalSummary.md new file mode 100644 index 000000000..60d1f6f86 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeApprovalSummary.md @@ -0,0 +1,116 @@ +--- +id: v2024-non-employee-approval-summary +title: NonEmployeeApprovalSummary +pagination_label: NonEmployeeApprovalSummary +sidebar_label: NonEmployeeApprovalSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalSummary', 'V2024NonEmployeeApprovalSummary'] +slug: /tools/sdk/go/v2024/models/non-employee-approval-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalSummary', 'V2024NonEmployeeApprovalSummary'] +--- + +# NonEmployeeApprovalSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | Pointer to **int32** | The number of approved non-employee approval requests. | [optional] +**Pending** | Pointer to **int32** | The number of pending non-employee approval requests. | [optional] +**Rejected** | Pointer to **int32** | The number of rejected non-employee approval requests. | [optional] + +## Methods + +### NewNonEmployeeApprovalSummary + +`func NewNonEmployeeApprovalSummary() *NonEmployeeApprovalSummary` + +NewNonEmployeeApprovalSummary instantiates a new NonEmployeeApprovalSummary 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 + +### NewNonEmployeeApprovalSummaryWithDefaults + +`func NewNonEmployeeApprovalSummaryWithDefaults() *NonEmployeeApprovalSummary` + +NewNonEmployeeApprovalSummaryWithDefaults instantiates a new NonEmployeeApprovalSummary 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 + +### GetApproved + +`func (o *NonEmployeeApprovalSummary) GetApproved() int32` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *NonEmployeeApprovalSummary) GetApprovedOk() (*int32, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *NonEmployeeApprovalSummary) SetApproved(v int32)` + +SetApproved sets Approved field to given value. + +### HasApproved + +`func (o *NonEmployeeApprovalSummary) HasApproved() bool` + +HasApproved returns a boolean if a field has been set. + +### GetPending + +`func (o *NonEmployeeApprovalSummary) GetPending() int32` + +GetPending returns the Pending field if non-nil, zero value otherwise. + +### GetPendingOk + +`func (o *NonEmployeeApprovalSummary) GetPendingOk() (*int32, bool)` + +GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPending + +`func (o *NonEmployeeApprovalSummary) SetPending(v int32)` + +SetPending sets Pending field to given value. + +### HasPending + +`func (o *NonEmployeeApprovalSummary) HasPending() bool` + +HasPending returns a boolean if a field has been set. + +### GetRejected + +`func (o *NonEmployeeApprovalSummary) GetRejected() int32` + +GetRejected returns the Rejected field if non-nil, zero value otherwise. + +### GetRejectedOk + +`func (o *NonEmployeeApprovalSummary) GetRejectedOk() (*int32, bool)` + +GetRejectedOk returns a tuple with the Rejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRejected + +`func (o *NonEmployeeApprovalSummary) SetRejected(v int32)` + +SetRejected sets Rejected field to given value. + +### HasRejected + +`func (o *NonEmployeeApprovalSummary) HasRejected() bool` + +HasRejected returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeBulkUploadJob.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeBulkUploadJob.md new file mode 100644 index 000000000..98328019e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeBulkUploadJob.md @@ -0,0 +1,168 @@ +--- +id: v2024-non-employee-bulk-upload-job +title: NonEmployeeBulkUploadJob +pagination_label: NonEmployeeBulkUploadJob +sidebar_label: NonEmployeeBulkUploadJob +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeBulkUploadJob', 'V2024NonEmployeeBulkUploadJob'] +slug: /tools/sdk/go/v2024/models/non-employee-bulk-upload-job +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadJob', 'V2024NonEmployeeBulkUploadJob'] +--- + +# NonEmployeeBulkUploadJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The bulk upload job's ID. (UUID) | [optional] +**SourceId** | Pointer to **string** | The ID of the source to bulk-upload non-employees to. (UUID) | [optional] +**Created** | Pointer to **SailPointTime** | The date-time the job was submitted. | [optional] +**Modified** | Pointer to **SailPointTime** | The date-time that the job was last updated. | [optional] +**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. | [optional] + +## Methods + +### NewNonEmployeeBulkUploadJob + +`func NewNonEmployeeBulkUploadJob() *NonEmployeeBulkUploadJob` + +NewNonEmployeeBulkUploadJob instantiates a new NonEmployeeBulkUploadJob 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 + +### NewNonEmployeeBulkUploadJobWithDefaults + +`func NewNonEmployeeBulkUploadJobWithDefaults() *NonEmployeeBulkUploadJob` + +NewNonEmployeeBulkUploadJobWithDefaults instantiates a new NonEmployeeBulkUploadJob 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 + +### GetId + +`func (o *NonEmployeeBulkUploadJob) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeBulkUploadJob) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeBulkUploadJob) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeBulkUploadJob) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeBulkUploadJob) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeBulkUploadJob) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeBulkUploadJob) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeBulkUploadJob) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeBulkUploadJob) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeBulkUploadJob) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeBulkUploadJob) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeBulkUploadJob) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeBulkUploadJob) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeBulkUploadJob) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeBulkUploadJob) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeBulkUploadJob) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetStatus + +`func (o *NonEmployeeBulkUploadJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *NonEmployeeBulkUploadJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *NonEmployeeBulkUploadJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *NonEmployeeBulkUploadJob) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeBulkUploadStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeBulkUploadStatus.md new file mode 100644 index 000000000..ad5a54afe --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeBulkUploadStatus.md @@ -0,0 +1,64 @@ +--- +id: v2024-non-employee-bulk-upload-status +title: NonEmployeeBulkUploadStatus +pagination_label: NonEmployeeBulkUploadStatus +sidebar_label: NonEmployeeBulkUploadStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeBulkUploadStatus', 'V2024NonEmployeeBulkUploadStatus'] +slug: /tools/sdk/go/v2024/models/non-employee-bulk-upload-status +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadStatus', 'V2024NonEmployeeBulkUploadStatus'] +--- + +# NonEmployeeBulkUploadStatus + +## Properties + +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] + +## Methods + +### NewNonEmployeeBulkUploadStatus + +`func NewNonEmployeeBulkUploadStatus() *NonEmployeeBulkUploadStatus` + +NewNonEmployeeBulkUploadStatus instantiates a new NonEmployeeBulkUploadStatus 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 + +### NewNonEmployeeBulkUploadStatusWithDefaults + +`func NewNonEmployeeBulkUploadStatusWithDefaults() *NonEmployeeBulkUploadStatus` + +NewNonEmployeeBulkUploadStatusWithDefaults instantiates a new NonEmployeeBulkUploadStatus 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 + +### GetStatus + +`func (o *NonEmployeeBulkUploadStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *NonEmployeeBulkUploadStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *NonEmployeeBulkUploadStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *NonEmployeeBulkUploadStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeIdentityDtoType.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeIdentityDtoType.md new file mode 100644 index 000000000..39d2d5430 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeIdentityDtoType.md @@ -0,0 +1,21 @@ +--- +id: v2024-non-employee-identity-dto-type +title: NonEmployeeIdentityDtoType +pagination_label: NonEmployeeIdentityDtoType +sidebar_label: NonEmployeeIdentityDtoType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeIdentityDtoType', 'V2024NonEmployeeIdentityDtoType'] +slug: /tools/sdk/go/v2024/models/non-employee-identity-dto-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdentityDtoType', 'V2024NonEmployeeIdentityDtoType'] +--- + +# NonEmployeeIdentityDtoType + +## Enum + + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + +* `IDENTITY` (value: `"IDENTITY"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeIdentityReferenceWithId.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeIdentityReferenceWithId.md new file mode 100644 index 000000000..06452887b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeIdentityReferenceWithId.md @@ -0,0 +1,90 @@ +--- +id: v2024-non-employee-identity-reference-with-id +title: NonEmployeeIdentityReferenceWithId +pagination_label: NonEmployeeIdentityReferenceWithId +sidebar_label: NonEmployeeIdentityReferenceWithId +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeIdentityReferenceWithId', 'V2024NonEmployeeIdentityReferenceWithId'] +slug: /tools/sdk/go/v2024/models/non-employee-identity-reference-with-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdentityReferenceWithId', 'V2024NonEmployeeIdentityReferenceWithId'] +--- + +# NonEmployeeIdentityReferenceWithId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**NonEmployeeIdentityDtoType**](non-employee-identity-dto-type) | | [optional] +**Id** | Pointer to **string** | Identity id | [optional] + +## Methods + +### NewNonEmployeeIdentityReferenceWithId + +`func NewNonEmployeeIdentityReferenceWithId() *NonEmployeeIdentityReferenceWithId` + +NewNonEmployeeIdentityReferenceWithId instantiates a new NonEmployeeIdentityReferenceWithId 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 + +### NewNonEmployeeIdentityReferenceWithIdWithDefaults + +`func NewNonEmployeeIdentityReferenceWithIdWithDefaults() *NonEmployeeIdentityReferenceWithId` + +NewNonEmployeeIdentityReferenceWithIdWithDefaults instantiates a new NonEmployeeIdentityReferenceWithId 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 + +### GetType + +`func (o *NonEmployeeIdentityReferenceWithId) GetType() NonEmployeeIdentityDtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NonEmployeeIdentityReferenceWithId) GetTypeOk() (*NonEmployeeIdentityDtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NonEmployeeIdentityReferenceWithId) SetType(v NonEmployeeIdentityDtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *NonEmployeeIdentityReferenceWithId) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *NonEmployeeIdentityReferenceWithId) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeIdentityReferenceWithId) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeIdentityReferenceWithId) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeIdentityReferenceWithId) HasId() bool` + +HasId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeIdnUserRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeIdnUserRequest.md new file mode 100644 index 000000000..aefb07bc0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeIdnUserRequest.md @@ -0,0 +1,59 @@ +--- +id: v2024-non-employee-idn-user-request +title: NonEmployeeIdnUserRequest +pagination_label: NonEmployeeIdnUserRequest +sidebar_label: NonEmployeeIdnUserRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeIdnUserRequest', 'V2024NonEmployeeIdnUserRequest'] +slug: /tools/sdk/go/v2024/models/non-employee-idn-user-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdnUserRequest', 'V2024NonEmployeeIdnUserRequest'] +--- + +# NonEmployeeIdnUserRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Identity id. | + +## Methods + +### NewNonEmployeeIdnUserRequest + +`func NewNonEmployeeIdnUserRequest(id string, ) *NonEmployeeIdnUserRequest` + +NewNonEmployeeIdnUserRequest instantiates a new NonEmployeeIdnUserRequest 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 + +### NewNonEmployeeIdnUserRequestWithDefaults + +`func NewNonEmployeeIdnUserRequestWithDefaults() *NonEmployeeIdnUserRequest` + +NewNonEmployeeIdnUserRequestWithDefaults instantiates a new NonEmployeeIdnUserRequest 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 + +### GetId + +`func (o *NonEmployeeIdnUserRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeIdnUserRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeIdnUserRequest) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRecord.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRecord.md new file mode 100644 index 000000000..0100732ff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRecord.md @@ -0,0 +1,376 @@ +--- +id: v2024-non-employee-record +title: NonEmployeeRecord +pagination_label: NonEmployeeRecord +sidebar_label: NonEmployeeRecord +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRecord', 'V2024NonEmployeeRecord'] +slug: /tools/sdk/go/v2024/models/non-employee-record +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRecord', 'V2024NonEmployeeRecord'] +--- + +# NonEmployeeRecord + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee record id. | [optional] +**AccountName** | Pointer to **string** | Requested identity account name. | [optional] +**FirstName** | Pointer to **string** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **string** | Non-Employee's last name. | [optional] +**Email** | Pointer to **string** | Non-Employee's email. | [optional] +**Phone** | Pointer to **string** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **string** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**SourceId** | Pointer to **string** | Non-Employee's source id. | [optional] +**Data** | Pointer to **map[string]string** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**StartDate** | Pointer to **SailPointTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **SailPointTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeRecord + +`func NewNonEmployeeRecord() *NonEmployeeRecord` + +NewNonEmployeeRecord instantiates a new NonEmployeeRecord 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 + +### NewNonEmployeeRecordWithDefaults + +`func NewNonEmployeeRecordWithDefaults() *NonEmployeeRecord` + +NewNonEmployeeRecordWithDefaults instantiates a new NonEmployeeRecord 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 + +### GetId + +`func (o *NonEmployeeRecord) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeRecord) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeRecord) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeRecord) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeRecord) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeRecord) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeRecord) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeRecord) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *NonEmployeeRecord) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *NonEmployeeRecord) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *NonEmployeeRecord) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *NonEmployeeRecord) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### GetLastName + +`func (o *NonEmployeeRecord) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *NonEmployeeRecord) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *NonEmployeeRecord) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *NonEmployeeRecord) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### GetEmail + +`func (o *NonEmployeeRecord) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *NonEmployeeRecord) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *NonEmployeeRecord) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *NonEmployeeRecord) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetPhone + +`func (o *NonEmployeeRecord) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *NonEmployeeRecord) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *NonEmployeeRecord) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *NonEmployeeRecord) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### GetManager + +`func (o *NonEmployeeRecord) GetManager() string` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *NonEmployeeRecord) GetManagerOk() (*string, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *NonEmployeeRecord) SetManager(v string)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *NonEmployeeRecord) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeRecord) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeRecord) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeRecord) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeRecord) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetData + +`func (o *NonEmployeeRecord) GetData() map[string]string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *NonEmployeeRecord) GetDataOk() (*map[string]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *NonEmployeeRecord) SetData(v map[string]string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *NonEmployeeRecord) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetStartDate + +`func (o *NonEmployeeRecord) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NonEmployeeRecord) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *NonEmployeeRecord) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *NonEmployeeRecord) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *NonEmployeeRecord) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *NonEmployeeRecord) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *NonEmployeeRecord) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *NonEmployeeRecord) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeRecord) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeRecord) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeRecord) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeRecord) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeRecord) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeRecord) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeRecord) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeRecord) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRejectApprovalDecision.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRejectApprovalDecision.md new file mode 100644 index 000000000..5ea377ee0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRejectApprovalDecision.md @@ -0,0 +1,59 @@ +--- +id: v2024-non-employee-reject-approval-decision +title: NonEmployeeRejectApprovalDecision +pagination_label: NonEmployeeRejectApprovalDecision +sidebar_label: NonEmployeeRejectApprovalDecision +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRejectApprovalDecision', 'V2024NonEmployeeRejectApprovalDecision'] +slug: /tools/sdk/go/v2024/models/non-employee-reject-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRejectApprovalDecision', 'V2024NonEmployeeRejectApprovalDecision'] +--- + +# NonEmployeeRejectApprovalDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | **string** | Comment on the approval item. | + +## Methods + +### NewNonEmployeeRejectApprovalDecision + +`func NewNonEmployeeRejectApprovalDecision(comment string, ) *NonEmployeeRejectApprovalDecision` + +NewNonEmployeeRejectApprovalDecision instantiates a new NonEmployeeRejectApprovalDecision 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 + +### NewNonEmployeeRejectApprovalDecisionWithDefaults + +`func NewNonEmployeeRejectApprovalDecisionWithDefaults() *NonEmployeeRejectApprovalDecision` + +NewNonEmployeeRejectApprovalDecisionWithDefaults instantiates a new NonEmployeeRejectApprovalDecision 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 + +### GetComment + +`func (o *NonEmployeeRejectApprovalDecision) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeRejectApprovalDecision) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeRejectApprovalDecision) SetComment(v string)` + +SetComment sets Comment field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRequest.md new file mode 100644 index 000000000..fabbe7076 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRequest.md @@ -0,0 +1,558 @@ +--- +id: v2024-non-employee-request +title: NonEmployeeRequest +pagination_label: NonEmployeeRequest +sidebar_label: NonEmployeeRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequest', 'V2024NonEmployeeRequest'] +slug: /tools/sdk/go/v2024/models/non-employee-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequest', 'V2024NonEmployeeRequest'] +--- + +# NonEmployeeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**AccountName** | Pointer to **string** | Requested identity account name. | [optional] +**FirstName** | Pointer to **string** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **string** | Non-Employee's last name. | [optional] +**Email** | Pointer to **string** | Non-Employee's email. | [optional] +**Phone** | Pointer to **string** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **string** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLite**](non-employee-source-lite) | | [optional] +**Data** | Pointer to **map[string]string** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**ApprovalItems** | Pointer to [**[]NonEmployeeApprovalItemBase**](non-employee-approval-item-base) | List of approval item for the request | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**Comment** | Pointer to **string** | Comment of requester | [optional] +**CompletionDate** | Pointer to **SailPointTime** | When the request was completely approved. | [optional] +**StartDate** | Pointer to **SailPointTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **SailPointTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeRequest + +`func NewNonEmployeeRequest() *NonEmployeeRequest` + +NewNonEmployeeRequest instantiates a new NonEmployeeRequest 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 + +### NewNonEmployeeRequestWithDefaults + +`func NewNonEmployeeRequestWithDefaults() *NonEmployeeRequest` + +NewNonEmployeeRequestWithDefaults instantiates a new NonEmployeeRequest 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 + +### GetId + +`func (o *NonEmployeeRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeRequest) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeRequest) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeRequest) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeRequest) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeRequest) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeRequest) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeRequest) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeRequest) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeRequest) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeRequest) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *NonEmployeeRequest) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *NonEmployeeRequest) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *NonEmployeeRequest) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *NonEmployeeRequest) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### GetLastName + +`func (o *NonEmployeeRequest) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *NonEmployeeRequest) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *NonEmployeeRequest) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *NonEmployeeRequest) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### GetEmail + +`func (o *NonEmployeeRequest) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *NonEmployeeRequest) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *NonEmployeeRequest) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *NonEmployeeRequest) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetPhone + +`func (o *NonEmployeeRequest) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *NonEmployeeRequest) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *NonEmployeeRequest) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *NonEmployeeRequest) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### GetManager + +`func (o *NonEmployeeRequest) GetManager() string` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *NonEmployeeRequest) GetManagerOk() (*string, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *NonEmployeeRequest) SetManager(v string)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *NonEmployeeRequest) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### GetNonEmployeeSource + +`func (o *NonEmployeeRequest) GetNonEmployeeSource() NonEmployeeSourceLite` + +GetNonEmployeeSource returns the NonEmployeeSource field if non-nil, zero value otherwise. + +### GetNonEmployeeSourceOk + +`func (o *NonEmployeeRequest) GetNonEmployeeSourceOk() (*NonEmployeeSourceLite, bool)` + +GetNonEmployeeSourceOk returns a tuple with the NonEmployeeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeSource + +`func (o *NonEmployeeRequest) SetNonEmployeeSource(v NonEmployeeSourceLite)` + +SetNonEmployeeSource sets NonEmployeeSource field to given value. + +### HasNonEmployeeSource + +`func (o *NonEmployeeRequest) HasNonEmployeeSource() bool` + +HasNonEmployeeSource returns a boolean if a field has been set. + +### GetData + +`func (o *NonEmployeeRequest) GetData() map[string]string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *NonEmployeeRequest) GetDataOk() (*map[string]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *NonEmployeeRequest) SetData(v map[string]string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *NonEmployeeRequest) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetApprovalItems + +`func (o *NonEmployeeRequest) GetApprovalItems() []NonEmployeeApprovalItemBase` + +GetApprovalItems returns the ApprovalItems field if non-nil, zero value otherwise. + +### GetApprovalItemsOk + +`func (o *NonEmployeeRequest) GetApprovalItemsOk() (*[]NonEmployeeApprovalItemBase, bool)` + +GetApprovalItemsOk returns a tuple with the ApprovalItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalItems + +`func (o *NonEmployeeRequest) SetApprovalItems(v []NonEmployeeApprovalItemBase)` + +SetApprovalItems sets ApprovalItems field to given value. + +### HasApprovalItems + +`func (o *NonEmployeeRequest) HasApprovalItems() bool` + +HasApprovalItems returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeRequest) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeRequest) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeRequest) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeRequest) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeRequest) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeRequest) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeRequest) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeRequest) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetCompletionDate + +`func (o *NonEmployeeRequest) GetCompletionDate() SailPointTime` + +GetCompletionDate returns the CompletionDate field if non-nil, zero value otherwise. + +### GetCompletionDateOk + +`func (o *NonEmployeeRequest) GetCompletionDateOk() (*SailPointTime, bool)` + +GetCompletionDateOk returns a tuple with the CompletionDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionDate + +`func (o *NonEmployeeRequest) SetCompletionDate(v SailPointTime)` + +SetCompletionDate sets CompletionDate field to given value. + +### HasCompletionDate + +`func (o *NonEmployeeRequest) HasCompletionDate() bool` + +HasCompletionDate returns a boolean if a field has been set. + +### GetStartDate + +`func (o *NonEmployeeRequest) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NonEmployeeRequest) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *NonEmployeeRequest) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *NonEmployeeRequest) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *NonEmployeeRequest) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *NonEmployeeRequest) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *NonEmployeeRequest) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *NonEmployeeRequest) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeRequest) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeRequest) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeRequest) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeRequest) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeRequest) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeRequest) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeRequest) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeRequest) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRequestBody.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRequestBody.md new file mode 100644 index 000000000..9d5ed08d2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRequestBody.md @@ -0,0 +1,253 @@ +--- +id: v2024-non-employee-request-body +title: NonEmployeeRequestBody +pagination_label: NonEmployeeRequestBody +sidebar_label: NonEmployeeRequestBody +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequestBody', 'V2024NonEmployeeRequestBody'] +slug: /tools/sdk/go/v2024/models/non-employee-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestBody', 'V2024NonEmployeeRequestBody'] +--- + +# NonEmployeeRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountName** | **string** | Requested identity account name. | +**FirstName** | **string** | Non-Employee's first name. | +**LastName** | **string** | Non-Employee's last name. | +**Email** | **string** | Non-Employee's email. | +**Phone** | **string** | Non-Employee's phone. | +**Manager** | **string** | The account ID of a valid identity to serve as this non-employee's manager. | +**SourceId** | **string** | Non-Employee's source id. | +**Data** | Pointer to **map[string]string** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**StartDate** | **SailPointTime** | Non-Employee employment start date. | +**EndDate** | **SailPointTime** | Non-Employee employment end date. | + +## Methods + +### NewNonEmployeeRequestBody + +`func NewNonEmployeeRequestBody(accountName string, firstName string, lastName string, email string, phone string, manager string, sourceId string, startDate SailPointTime, endDate SailPointTime, ) *NonEmployeeRequestBody` + +NewNonEmployeeRequestBody instantiates a new NonEmployeeRequestBody 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 + +### NewNonEmployeeRequestBodyWithDefaults + +`func NewNonEmployeeRequestBodyWithDefaults() *NonEmployeeRequestBody` + +NewNonEmployeeRequestBodyWithDefaults instantiates a new NonEmployeeRequestBody 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 + +### GetAccountName + +`func (o *NonEmployeeRequestBody) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeRequestBody) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeRequestBody) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + + +### GetFirstName + +`func (o *NonEmployeeRequestBody) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *NonEmployeeRequestBody) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *NonEmployeeRequestBody) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + + +### GetLastName + +`func (o *NonEmployeeRequestBody) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *NonEmployeeRequestBody) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *NonEmployeeRequestBody) SetLastName(v string)` + +SetLastName sets LastName field to given value. + + +### GetEmail + +`func (o *NonEmployeeRequestBody) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *NonEmployeeRequestBody) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *NonEmployeeRequestBody) SetEmail(v string)` + +SetEmail sets Email field to given value. + + +### GetPhone + +`func (o *NonEmployeeRequestBody) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *NonEmployeeRequestBody) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *NonEmployeeRequestBody) SetPhone(v string)` + +SetPhone sets Phone field to given value. + + +### GetManager + +`func (o *NonEmployeeRequestBody) GetManager() string` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *NonEmployeeRequestBody) GetManagerOk() (*string, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *NonEmployeeRequestBody) SetManager(v string)` + +SetManager sets Manager field to given value. + + +### GetSourceId + +`func (o *NonEmployeeRequestBody) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeRequestBody) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeRequestBody) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetData + +`func (o *NonEmployeeRequestBody) GetData() map[string]string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *NonEmployeeRequestBody) GetDataOk() (*map[string]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *NonEmployeeRequestBody) SetData(v map[string]string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *NonEmployeeRequestBody) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetStartDate + +`func (o *NonEmployeeRequestBody) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NonEmployeeRequestBody) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *NonEmployeeRequestBody) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + + +### GetEndDate + +`func (o *NonEmployeeRequestBody) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *NonEmployeeRequestBody) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *NonEmployeeRequestBody) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRequestLite.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRequestLite.md new file mode 100644 index 000000000..e93b3ecbc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRequestLite.md @@ -0,0 +1,90 @@ +--- +id: v2024-non-employee-request-lite +title: NonEmployeeRequestLite +pagination_label: NonEmployeeRequestLite +sidebar_label: NonEmployeeRequestLite +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequestLite', 'V2024NonEmployeeRequestLite'] +slug: /tools/sdk/go/v2024/models/non-employee-request-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestLite', 'V2024NonEmployeeRequestLite'] +--- + +# NonEmployeeRequestLite + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee request id. | [optional] +**Requester** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] + +## Methods + +### NewNonEmployeeRequestLite + +`func NewNonEmployeeRequestLite() *NonEmployeeRequestLite` + +NewNonEmployeeRequestLite instantiates a new NonEmployeeRequestLite 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 + +### NewNonEmployeeRequestLiteWithDefaults + +`func NewNonEmployeeRequestLiteWithDefaults() *NonEmployeeRequestLite` + +NewNonEmployeeRequestLiteWithDefaults instantiates a new NonEmployeeRequestLite 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 + +### GetId + +`func (o *NonEmployeeRequestLite) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeRequestLite) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeRequestLite) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeRequestLite) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRequester + +`func (o *NonEmployeeRequestLite) GetRequester() NonEmployeeIdentityReferenceWithId` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *NonEmployeeRequestLite) GetRequesterOk() (*NonEmployeeIdentityReferenceWithId, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *NonEmployeeRequestLite) SetRequester(v NonEmployeeIdentityReferenceWithId)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *NonEmployeeRequestLite) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRequestSummary.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRequestSummary.md new file mode 100644 index 000000000..ba5523b15 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRequestSummary.md @@ -0,0 +1,142 @@ +--- +id: v2024-non-employee-request-summary +title: NonEmployeeRequestSummary +pagination_label: NonEmployeeRequestSummary +sidebar_label: NonEmployeeRequestSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequestSummary', 'V2024NonEmployeeRequestSummary'] +slug: /tools/sdk/go/v2024/models/non-employee-request-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestSummary', 'V2024NonEmployeeRequestSummary'] +--- + +# NonEmployeeRequestSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | Pointer to **int32** | The number of approved non-employee requests on all sources that *requested-for* user manages. | [optional] +**Rejected** | Pointer to **int32** | The number of rejected non-employee requests on all sources that *requested-for* user manages. | [optional] +**Pending** | Pointer to **int32** | The number of pending non-employee requests on all sources that *requested-for* user manages. | [optional] +**NonEmployeeCount** | Pointer to **int32** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] + +## Methods + +### NewNonEmployeeRequestSummary + +`func NewNonEmployeeRequestSummary() *NonEmployeeRequestSummary` + +NewNonEmployeeRequestSummary instantiates a new NonEmployeeRequestSummary 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 + +### NewNonEmployeeRequestSummaryWithDefaults + +`func NewNonEmployeeRequestSummaryWithDefaults() *NonEmployeeRequestSummary` + +NewNonEmployeeRequestSummaryWithDefaults instantiates a new NonEmployeeRequestSummary 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 + +### GetApproved + +`func (o *NonEmployeeRequestSummary) GetApproved() int32` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *NonEmployeeRequestSummary) GetApprovedOk() (*int32, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *NonEmployeeRequestSummary) SetApproved(v int32)` + +SetApproved sets Approved field to given value. + +### HasApproved + +`func (o *NonEmployeeRequestSummary) HasApproved() bool` + +HasApproved returns a boolean if a field has been set. + +### GetRejected + +`func (o *NonEmployeeRequestSummary) GetRejected() int32` + +GetRejected returns the Rejected field if non-nil, zero value otherwise. + +### GetRejectedOk + +`func (o *NonEmployeeRequestSummary) GetRejectedOk() (*int32, bool)` + +GetRejectedOk returns a tuple with the Rejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRejected + +`func (o *NonEmployeeRequestSummary) SetRejected(v int32)` + +SetRejected sets Rejected field to given value. + +### HasRejected + +`func (o *NonEmployeeRequestSummary) HasRejected() bool` + +HasRejected returns a boolean if a field has been set. + +### GetPending + +`func (o *NonEmployeeRequestSummary) GetPending() int32` + +GetPending returns the Pending field if non-nil, zero value otherwise. + +### GetPendingOk + +`func (o *NonEmployeeRequestSummary) GetPendingOk() (*int32, bool)` + +GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPending + +`func (o *NonEmployeeRequestSummary) SetPending(v int32)` + +SetPending sets Pending field to given value. + +### HasPending + +`func (o *NonEmployeeRequestSummary) HasPending() bool` + +HasPending returns a boolean if a field has been set. + +### GetNonEmployeeCount + +`func (o *NonEmployeeRequestSummary) GetNonEmployeeCount() int32` + +GetNonEmployeeCount returns the NonEmployeeCount field if non-nil, zero value otherwise. + +### GetNonEmployeeCountOk + +`func (o *NonEmployeeRequestSummary) GetNonEmployeeCountOk() (*int32, bool)` + +GetNonEmployeeCountOk returns a tuple with the NonEmployeeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeCount + +`func (o *NonEmployeeRequestSummary) SetNonEmployeeCount(v int32)` + +SetNonEmployeeCount sets NonEmployeeCount field to given value. + +### HasNonEmployeeCount + +`func (o *NonEmployeeRequestSummary) HasNonEmployeeCount() bool` + +HasNonEmployeeCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md new file mode 100644 index 000000000..ad10f2e05 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -0,0 +1,480 @@ +--- +id: v2024-non-employee-request-without-approval-item +title: NonEmployeeRequestWithoutApprovalItem +pagination_label: NonEmployeeRequestWithoutApprovalItem +sidebar_label: NonEmployeeRequestWithoutApprovalItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequestWithoutApprovalItem', 'V2024NonEmployeeRequestWithoutApprovalItem'] +slug: /tools/sdk/go/v2024/models/non-employee-request-without-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestWithoutApprovalItem', 'V2024NonEmployeeRequestWithoutApprovalItem'] +--- + +# NonEmployeeRequestWithoutApprovalItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee request id. | [optional] +**Requester** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **string** | Requested identity account name. | [optional] +**FirstName** | Pointer to **string** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **string** | Non-Employee's last name. | [optional] +**Email** | Pointer to **string** | Non-Employee's email. | [optional] +**Phone** | Pointer to **string** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **string** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLiteWithSchemaAttributes**](non-employee-source-lite-with-schema-attributes) | | [optional] +**Data** | Pointer to **map[string]string** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**Comment** | Pointer to **string** | Comment of requester | [optional] +**CompletionDate** | Pointer to **SailPointTime** | When the request was completely approved. | [optional] +**StartDate** | Pointer to **string** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **string** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeRequestWithoutApprovalItem + +`func NewNonEmployeeRequestWithoutApprovalItem() *NonEmployeeRequestWithoutApprovalItem` + +NewNonEmployeeRequestWithoutApprovalItem instantiates a new NonEmployeeRequestWithoutApprovalItem 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 + +### NewNonEmployeeRequestWithoutApprovalItemWithDefaults + +`func NewNonEmployeeRequestWithoutApprovalItemWithDefaults() *NonEmployeeRequestWithoutApprovalItem` + +NewNonEmployeeRequestWithoutApprovalItemWithDefaults instantiates a new NonEmployeeRequestWithoutApprovalItem 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 + +### GetId + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRequester + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetRequester() NonEmployeeIdentityReferenceWithId` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetRequesterOk() (*NonEmployeeIdentityReferenceWithId, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetRequester(v NonEmployeeIdentityReferenceWithId)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### GetLastName + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### GetEmail + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetPhone + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### GetManager + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetManager() string` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetManagerOk() (*string, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetManager(v string)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### GetNonEmployeeSource + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetNonEmployeeSource() NonEmployeeSourceLiteWithSchemaAttributes` + +GetNonEmployeeSource returns the NonEmployeeSource field if non-nil, zero value otherwise. + +### GetNonEmployeeSourceOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetNonEmployeeSourceOk() (*NonEmployeeSourceLiteWithSchemaAttributes, bool)` + +GetNonEmployeeSourceOk returns a tuple with the NonEmployeeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeSource + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetNonEmployeeSource(v NonEmployeeSourceLiteWithSchemaAttributes)` + +SetNonEmployeeSource sets NonEmployeeSource field to given value. + +### HasNonEmployeeSource + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasNonEmployeeSource() bool` + +HasNonEmployeeSource returns a boolean if a field has been set. + +### GetData + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetData() map[string]string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetDataOk() (*map[string]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetData(v map[string]string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetCompletionDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCompletionDate() SailPointTime` + +GetCompletionDate returns the CompletionDate field if non-nil, zero value otherwise. + +### GetCompletionDateOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCompletionDateOk() (*SailPointTime, bool)` + +GetCompletionDateOk returns a tuple with the CompletionDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetCompletionDate(v SailPointTime)` + +SetCompletionDate sets CompletionDate field to given value. + +### HasCompletionDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasCompletionDate() bool` + +HasCompletionDate returns a boolean if a field has been set. + +### GetStartDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetStartDate() string` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetStartDateOk() (*string, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetStartDate(v string)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetEndDate() string` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetEndDateOk() (*string, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetEndDate(v string)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSchemaAttribute.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSchemaAttribute.md new file mode 100644 index 000000000..91a7f6d8b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSchemaAttribute.md @@ -0,0 +1,283 @@ +--- +id: v2024-non-employee-schema-attribute +title: NonEmployeeSchemaAttribute +pagination_label: NonEmployeeSchemaAttribute +sidebar_label: NonEmployeeSchemaAttribute +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSchemaAttribute', 'V2024NonEmployeeSchemaAttribute'] +slug: /tools/sdk/go/v2024/models/non-employee-schema-attribute +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttribute', 'V2024NonEmployeeSchemaAttribute'] +--- + +# NonEmployeeSchemaAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Schema Attribute Id | [optional] +**System** | Pointer to **bool** | True if this schema attribute is mandatory on all non-employees sources. | [optional] [default to false] +**Modified** | Pointer to **SailPointTime** | When the schema attribute was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the schema attribute was created. | [optional] +**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] +**Required** | Pointer to **bool** | If true, the schema attribute is required for all non-employees in the source | [optional] [default to false] + +## Methods + +### NewNonEmployeeSchemaAttribute + +`func NewNonEmployeeSchemaAttribute(type_ NonEmployeeSchemaAttributeType, label string, technicalName string, ) *NonEmployeeSchemaAttribute` + +NewNonEmployeeSchemaAttribute instantiates a new NonEmployeeSchemaAttribute 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 + +### NewNonEmployeeSchemaAttributeWithDefaults + +`func NewNonEmployeeSchemaAttributeWithDefaults() *NonEmployeeSchemaAttribute` + +NewNonEmployeeSchemaAttributeWithDefaults instantiates a new NonEmployeeSchemaAttribute 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 + +### GetId + +`func (o *NonEmployeeSchemaAttribute) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSchemaAttribute) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSchemaAttribute) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSchemaAttribute) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSystem + +`func (o *NonEmployeeSchemaAttribute) GetSystem() bool` + +GetSystem returns the System field if non-nil, zero value otherwise. + +### GetSystemOk + +`func (o *NonEmployeeSchemaAttribute) GetSystemOk() (*bool, bool)` + +GetSystemOk returns a tuple with the System field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSystem + +`func (o *NonEmployeeSchemaAttribute) SetSystem(v bool)` + +SetSystem sets System field to given value. + +### HasSystem + +`func (o *NonEmployeeSchemaAttribute) HasSystem() bool` + +HasSystem returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeSchemaAttribute) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeSchemaAttribute) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeSchemaAttribute) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeSchemaAttribute) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeSchemaAttribute) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeSchemaAttribute) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeSchemaAttribute) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeSchemaAttribute) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetType + +`func (o *NonEmployeeSchemaAttribute) GetType() NonEmployeeSchemaAttributeType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NonEmployeeSchemaAttribute) GetTypeOk() (*NonEmployeeSchemaAttributeType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NonEmployeeSchemaAttribute) SetType(v NonEmployeeSchemaAttributeType)` + +SetType sets Type field to given value. + + +### GetLabel + +`func (o *NonEmployeeSchemaAttribute) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *NonEmployeeSchemaAttribute) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *NonEmployeeSchemaAttribute) SetLabel(v string)` + +SetLabel sets Label field to given value. + + +### GetTechnicalName + +`func (o *NonEmployeeSchemaAttribute) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *NonEmployeeSchemaAttribute) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *NonEmployeeSchemaAttribute) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + + +### GetHelpText + +`func (o *NonEmployeeSchemaAttribute) GetHelpText() string` + +GetHelpText returns the HelpText field if non-nil, zero value otherwise. + +### GetHelpTextOk + +`func (o *NonEmployeeSchemaAttribute) GetHelpTextOk() (*string, bool)` + +GetHelpTextOk returns a tuple with the HelpText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHelpText + +`func (o *NonEmployeeSchemaAttribute) SetHelpText(v string)` + +SetHelpText sets HelpText field to given value. + +### HasHelpText + +`func (o *NonEmployeeSchemaAttribute) HasHelpText() bool` + +HasHelpText returns a boolean if a field has been set. + +### GetPlaceholder + +`func (o *NonEmployeeSchemaAttribute) GetPlaceholder() string` + +GetPlaceholder returns the Placeholder field if non-nil, zero value otherwise. + +### GetPlaceholderOk + +`func (o *NonEmployeeSchemaAttribute) GetPlaceholderOk() (*string, bool)` + +GetPlaceholderOk returns a tuple with the Placeholder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPlaceholder + +`func (o *NonEmployeeSchemaAttribute) SetPlaceholder(v string)` + +SetPlaceholder sets Placeholder field to given value. + +### HasPlaceholder + +`func (o *NonEmployeeSchemaAttribute) HasPlaceholder() bool` + +HasPlaceholder returns a boolean if a field has been set. + +### GetRequired + +`func (o *NonEmployeeSchemaAttribute) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *NonEmployeeSchemaAttribute) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *NonEmployeeSchemaAttribute) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *NonEmployeeSchemaAttribute) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSchemaAttributeBody.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSchemaAttributeBody.md new file mode 100644 index 000000000..8c17bcffb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSchemaAttributeBody.md @@ -0,0 +1,179 @@ +--- +id: v2024-non-employee-schema-attribute-body +title: NonEmployeeSchemaAttributeBody +pagination_label: NonEmployeeSchemaAttributeBody +sidebar_label: NonEmployeeSchemaAttributeBody +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSchemaAttributeBody', 'V2024NonEmployeeSchemaAttributeBody'] +slug: /tools/sdk/go/v2024/models/non-employee-schema-attribute-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeBody', 'V2024NonEmployeeSchemaAttributeBody'] +--- + +# NonEmployeeSchemaAttributeBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of the attribute. Only type 'TEXT' is supported for custom attributes. | +**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] +**Required** | Pointer to **bool** | If true, the schema attribute is required for all non-employees in the source | [optional] + +## Methods + +### NewNonEmployeeSchemaAttributeBody + +`func NewNonEmployeeSchemaAttributeBody(type_ string, label string, technicalName string, ) *NonEmployeeSchemaAttributeBody` + +NewNonEmployeeSchemaAttributeBody instantiates a new NonEmployeeSchemaAttributeBody 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 + +### NewNonEmployeeSchemaAttributeBodyWithDefaults + +`func NewNonEmployeeSchemaAttributeBodyWithDefaults() *NonEmployeeSchemaAttributeBody` + +NewNonEmployeeSchemaAttributeBodyWithDefaults instantiates a new NonEmployeeSchemaAttributeBody 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 + +### GetType + +`func (o *NonEmployeeSchemaAttributeBody) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NonEmployeeSchemaAttributeBody) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NonEmployeeSchemaAttributeBody) SetType(v string)` + +SetType sets Type field to given value. + + +### GetLabel + +`func (o *NonEmployeeSchemaAttributeBody) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *NonEmployeeSchemaAttributeBody) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *NonEmployeeSchemaAttributeBody) SetLabel(v string)` + +SetLabel sets Label field to given value. + + +### GetTechnicalName + +`func (o *NonEmployeeSchemaAttributeBody) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *NonEmployeeSchemaAttributeBody) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *NonEmployeeSchemaAttributeBody) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + + +### GetHelpText + +`func (o *NonEmployeeSchemaAttributeBody) GetHelpText() string` + +GetHelpText returns the HelpText field if non-nil, zero value otherwise. + +### GetHelpTextOk + +`func (o *NonEmployeeSchemaAttributeBody) GetHelpTextOk() (*string, bool)` + +GetHelpTextOk returns a tuple with the HelpText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHelpText + +`func (o *NonEmployeeSchemaAttributeBody) SetHelpText(v string)` + +SetHelpText sets HelpText field to given value. + +### HasHelpText + +`func (o *NonEmployeeSchemaAttributeBody) HasHelpText() bool` + +HasHelpText returns a boolean if a field has been set. + +### GetPlaceholder + +`func (o *NonEmployeeSchemaAttributeBody) GetPlaceholder() string` + +GetPlaceholder returns the Placeholder field if non-nil, zero value otherwise. + +### GetPlaceholderOk + +`func (o *NonEmployeeSchemaAttributeBody) GetPlaceholderOk() (*string, bool)` + +GetPlaceholderOk returns a tuple with the Placeholder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPlaceholder + +`func (o *NonEmployeeSchemaAttributeBody) SetPlaceholder(v string)` + +SetPlaceholder sets Placeholder field to given value. + +### HasPlaceholder + +`func (o *NonEmployeeSchemaAttributeBody) HasPlaceholder() bool` + +HasPlaceholder returns a boolean if a field has been set. + +### GetRequired + +`func (o *NonEmployeeSchemaAttributeBody) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *NonEmployeeSchemaAttributeBody) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *NonEmployeeSchemaAttributeBody) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *NonEmployeeSchemaAttributeBody) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSchemaAttributeType.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSchemaAttributeType.md new file mode 100644 index 000000000..7f9b9b142 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSchemaAttributeType.md @@ -0,0 +1,23 @@ +--- +id: v2024-non-employee-schema-attribute-type +title: NonEmployeeSchemaAttributeType +pagination_label: NonEmployeeSchemaAttributeType +sidebar_label: NonEmployeeSchemaAttributeType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSchemaAttributeType', 'V2024NonEmployeeSchemaAttributeType'] +slug: /tools/sdk/go/v2024/models/non-employee-schema-attribute-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeType', 'V2024NonEmployeeSchemaAttributeType'] +--- + +# NonEmployeeSchemaAttributeType + +## Enum + + +* `TEXT` (value: `"TEXT"`) + +* `DATE` (value: `"DATE"`) + +* `IDENTITY` (value: `"IDENTITY"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSource.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSource.md new file mode 100644 index 000000000..b85843424 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSource.md @@ -0,0 +1,246 @@ +--- +id: v2024-non-employee-source +title: NonEmployeeSource +pagination_label: NonEmployeeSource +sidebar_label: NonEmployeeSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSource', 'V2024NonEmployeeSource'] +slug: /tools/sdk/go/v2024/models/non-employee-source +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSource', 'V2024NonEmployeeSource'] +--- + +# NonEmployeeSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeSource + +`func NewNonEmployeeSource() *NonEmployeeSource` + +NewNonEmployeeSource instantiates a new NonEmployeeSource 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 + +### NewNonEmployeeSourceWithDefaults + +`func NewNonEmployeeSourceWithDefaults() *NonEmployeeSource` + +NewNonEmployeeSourceWithDefaults instantiates a new NonEmployeeSource 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 + +### GetId + +`func (o *NonEmployeeSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSource) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSource) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSource) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSource) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSource) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSource) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSource) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSource) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetApprovers + +`func (o *NonEmployeeSource) GetApprovers() []NonEmployeeIdentityReferenceWithId` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *NonEmployeeSource) GetApproversOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *NonEmployeeSource) SetApprovers(v []NonEmployeeIdentityReferenceWithId)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *NonEmployeeSource) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetAccountManagers + +`func (o *NonEmployeeSource) GetAccountManagers() []NonEmployeeIdentityReferenceWithId` + +GetAccountManagers returns the AccountManagers field if non-nil, zero value otherwise. + +### GetAccountManagersOk + +`func (o *NonEmployeeSource) GetAccountManagersOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetAccountManagersOk returns a tuple with the AccountManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountManagers + +`func (o *NonEmployeeSource) SetAccountManagers(v []NonEmployeeIdentityReferenceWithId)` + +SetAccountManagers sets AccountManagers field to given value. + +### HasAccountManagers + +`func (o *NonEmployeeSource) HasAccountManagers() bool` + +HasAccountManagers returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeSource) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeSource) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeSource) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeSource) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeSource) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeSource) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeSource) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeSource) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSourceLite.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSourceLite.md new file mode 100644 index 000000000..e69383b49 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSourceLite.md @@ -0,0 +1,142 @@ +--- +id: v2024-non-employee-source-lite +title: NonEmployeeSourceLite +pagination_label: NonEmployeeSourceLite +sidebar_label: NonEmployeeSourceLite +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceLite', 'V2024NonEmployeeSourceLite'] +slug: /tools/sdk/go/v2024/models/non-employee-source-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLite', 'V2024NonEmployeeSourceLite'] +--- + +# NonEmployeeSourceLite + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] + +## Methods + +### NewNonEmployeeSourceLite + +`func NewNonEmployeeSourceLite() *NonEmployeeSourceLite` + +NewNonEmployeeSourceLite instantiates a new NonEmployeeSourceLite 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 + +### NewNonEmployeeSourceLiteWithDefaults + +`func NewNonEmployeeSourceLiteWithDefaults() *NonEmployeeSourceLite` + +NewNonEmployeeSourceLiteWithDefaults instantiates a new NonEmployeeSourceLite 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 + +### GetId + +`func (o *NonEmployeeSourceLite) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSourceLite) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSourceLite) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSourceLite) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSourceLite) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSourceLite) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSourceLite) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSourceLite) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSourceLite) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceLite) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceLite) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSourceLite) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSourceLite) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceLite) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceLite) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSourceLite) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSourceLiteWithSchemaAttributes.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSourceLiteWithSchemaAttributes.md new file mode 100644 index 000000000..b4f60030d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSourceLiteWithSchemaAttributes.md @@ -0,0 +1,168 @@ +--- +id: v2024-non-employee-source-lite-with-schema-attributes +title: NonEmployeeSourceLiteWithSchemaAttributes +pagination_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceLiteWithSchemaAttributes', 'V2024NonEmployeeSourceLiteWithSchemaAttributes'] +slug: /tools/sdk/go/v2024/models/non-employee-source-lite-with-schema-attributes +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLiteWithSchemaAttributes', 'V2024NonEmployeeSourceLiteWithSchemaAttributes'] +--- + +# NonEmployeeSourceLiteWithSchemaAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**SchemaAttributes** | Pointer to [**[]NonEmployeeSchemaAttribute**](non-employee-schema-attribute) | List of schema attributes associated with this non-employee source. | [optional] + +## Methods + +### NewNonEmployeeSourceLiteWithSchemaAttributes + +`func NewNonEmployeeSourceLiteWithSchemaAttributes() *NonEmployeeSourceLiteWithSchemaAttributes` + +NewNonEmployeeSourceLiteWithSchemaAttributes instantiates a new NonEmployeeSourceLiteWithSchemaAttributes 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 + +### NewNonEmployeeSourceLiteWithSchemaAttributesWithDefaults + +`func NewNonEmployeeSourceLiteWithSchemaAttributesWithDefaults() *NonEmployeeSourceLiteWithSchemaAttributes` + +NewNonEmployeeSourceLiteWithSchemaAttributesWithDefaults instantiates a new NonEmployeeSourceLiteWithSchemaAttributes 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 + +### GetId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetSchemaAttributes + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetSchemaAttributes() []NonEmployeeSchemaAttribute` + +GetSchemaAttributes returns the SchemaAttributes field if non-nil, zero value otherwise. + +### GetSchemaAttributesOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetSchemaAttributesOk() (*[]NonEmployeeSchemaAttribute, bool)` + +GetSchemaAttributesOk returns a tuple with the SchemaAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchemaAttributes + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetSchemaAttributes(v []NonEmployeeSchemaAttribute)` + +SetSchemaAttributes sets SchemaAttributes field to given value. + +### HasSchemaAttributes + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasSchemaAttributes() bool` + +HasSchemaAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSourceRequestBody.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSourceRequestBody.md new file mode 100644 index 000000000..2a98e01a6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSourceRequestBody.md @@ -0,0 +1,179 @@ +--- +id: v2024-non-employee-source-request-body +title: NonEmployeeSourceRequestBody +pagination_label: NonEmployeeSourceRequestBody +sidebar_label: NonEmployeeSourceRequestBody +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceRequestBody', 'V2024NonEmployeeSourceRequestBody'] +slug: /tools/sdk/go/v2024/models/non-employee-source-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceRequestBody', 'V2024NonEmployeeSourceRequestBody'] +--- + +# NonEmployeeSourceRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Name of non-employee source. | +**Description** | **string** | Description of non-employee source. | +**Owner** | [**NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | | +**ManagementWorkgroup** | Pointer to **string** | The ID for the management workgroup that contains source sub-admins | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of approvers. | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of account managers. | [optional] + +## Methods + +### NewNonEmployeeSourceRequestBody + +`func NewNonEmployeeSourceRequestBody(name string, description string, owner NonEmployeeIdnUserRequest, ) *NonEmployeeSourceRequestBody` + +NewNonEmployeeSourceRequestBody instantiates a new NonEmployeeSourceRequestBody 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 + +### NewNonEmployeeSourceRequestBodyWithDefaults + +`func NewNonEmployeeSourceRequestBodyWithDefaults() *NonEmployeeSourceRequestBody` + +NewNonEmployeeSourceRequestBodyWithDefaults instantiates a new NonEmployeeSourceRequestBody 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 + +### GetName + +`func (o *NonEmployeeSourceRequestBody) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceRequestBody) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceRequestBody) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *NonEmployeeSourceRequestBody) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceRequestBody) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceRequestBody) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetOwner + +`func (o *NonEmployeeSourceRequestBody) GetOwner() NonEmployeeIdnUserRequest` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *NonEmployeeSourceRequestBody) GetOwnerOk() (*NonEmployeeIdnUserRequest, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *NonEmployeeSourceRequestBody) SetOwner(v NonEmployeeIdnUserRequest)` + +SetOwner sets Owner field to given value. + + +### GetManagementWorkgroup + +`func (o *NonEmployeeSourceRequestBody) GetManagementWorkgroup() string` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *NonEmployeeSourceRequestBody) GetManagementWorkgroupOk() (*string, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *NonEmployeeSourceRequestBody) SetManagementWorkgroup(v string)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *NonEmployeeSourceRequestBody) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### GetApprovers + +`func (o *NonEmployeeSourceRequestBody) GetApprovers() []NonEmployeeIdnUserRequest` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *NonEmployeeSourceRequestBody) GetApproversOk() (*[]NonEmployeeIdnUserRequest, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *NonEmployeeSourceRequestBody) SetApprovers(v []NonEmployeeIdnUserRequest)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *NonEmployeeSourceRequestBody) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetAccountManagers + +`func (o *NonEmployeeSourceRequestBody) GetAccountManagers() []NonEmployeeIdnUserRequest` + +GetAccountManagers returns the AccountManagers field if non-nil, zero value otherwise. + +### GetAccountManagersOk + +`func (o *NonEmployeeSourceRequestBody) GetAccountManagersOk() (*[]NonEmployeeIdnUserRequest, bool)` + +GetAccountManagersOk returns a tuple with the AccountManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountManagers + +`func (o *NonEmployeeSourceRequestBody) SetAccountManagers(v []NonEmployeeIdnUserRequest)` + +SetAccountManagers sets AccountManagers field to given value. + +### HasAccountManagers + +`func (o *NonEmployeeSourceRequestBody) HasAccountManagers() bool` + +HasAccountManagers returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSourceWithCloudExternalId.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSourceWithCloudExternalId.md new file mode 100644 index 000000000..c72a1a457 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSourceWithCloudExternalId.md @@ -0,0 +1,272 @@ +--- +id: v2024-non-employee-source-with-cloud-external-id +title: NonEmployeeSourceWithCloudExternalId +pagination_label: NonEmployeeSourceWithCloudExternalId +sidebar_label: NonEmployeeSourceWithCloudExternalId +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceWithCloudExternalId', 'V2024NonEmployeeSourceWithCloudExternalId'] +slug: /tools/sdk/go/v2024/models/non-employee-source-with-cloud-external-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithCloudExternalId', 'V2024NonEmployeeSourceWithCloudExternalId'] +--- + +# NonEmployeeSourceWithCloudExternalId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**CloudExternalId** | Pointer to **string** | Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. | [optional] + +## Methods + +### NewNonEmployeeSourceWithCloudExternalId + +`func NewNonEmployeeSourceWithCloudExternalId() *NonEmployeeSourceWithCloudExternalId` + +NewNonEmployeeSourceWithCloudExternalId instantiates a new NonEmployeeSourceWithCloudExternalId 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 + +### NewNonEmployeeSourceWithCloudExternalIdWithDefaults + +`func NewNonEmployeeSourceWithCloudExternalIdWithDefaults() *NonEmployeeSourceWithCloudExternalId` + +NewNonEmployeeSourceWithCloudExternalIdWithDefaults instantiates a new NonEmployeeSourceWithCloudExternalId 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 + +### GetId + +`func (o *NonEmployeeSourceWithCloudExternalId) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSourceWithCloudExternalId) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSourceWithCloudExternalId) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSourceWithCloudExternalId) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSourceWithCloudExternalId) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSourceWithCloudExternalId) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSourceWithCloudExternalId) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceWithCloudExternalId) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSourceWithCloudExternalId) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSourceWithCloudExternalId) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceWithCloudExternalId) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSourceWithCloudExternalId) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetApprovers + +`func (o *NonEmployeeSourceWithCloudExternalId) GetApprovers() []NonEmployeeIdentityReferenceWithId` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetApproversOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *NonEmployeeSourceWithCloudExternalId) SetApprovers(v []NonEmployeeIdentityReferenceWithId)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *NonEmployeeSourceWithCloudExternalId) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetAccountManagers + +`func (o *NonEmployeeSourceWithCloudExternalId) GetAccountManagers() []NonEmployeeIdentityReferenceWithId` + +GetAccountManagers returns the AccountManagers field if non-nil, zero value otherwise. + +### GetAccountManagersOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetAccountManagersOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetAccountManagersOk returns a tuple with the AccountManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountManagers + +`func (o *NonEmployeeSourceWithCloudExternalId) SetAccountManagers(v []NonEmployeeIdentityReferenceWithId)` + +SetAccountManagers sets AccountManagers field to given value. + +### HasAccountManagers + +`func (o *NonEmployeeSourceWithCloudExternalId) HasAccountManagers() bool` + +HasAccountManagers returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeSourceWithCloudExternalId) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeSourceWithCloudExternalId) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeSourceWithCloudExternalId) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeSourceWithCloudExternalId) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeSourceWithCloudExternalId) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeSourceWithCloudExternalId) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetCloudExternalId + +`func (o *NonEmployeeSourceWithCloudExternalId) GetCloudExternalId() string` + +GetCloudExternalId returns the CloudExternalId field if non-nil, zero value otherwise. + +### GetCloudExternalIdOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetCloudExternalIdOk() (*string, bool)` + +GetCloudExternalIdOk returns a tuple with the CloudExternalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudExternalId + +`func (o *NonEmployeeSourceWithCloudExternalId) SetCloudExternalId(v string)` + +SetCloudExternalId sets CloudExternalId field to given value. + +### HasCloudExternalId + +`func (o *NonEmployeeSourceWithCloudExternalId) HasCloudExternalId() bool` + +HasCloudExternalId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSourceWithNECount.md new file mode 100644 index 000000000..f5bf8ea35 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NonEmployeeSourceWithNECount.md @@ -0,0 +1,282 @@ +--- +id: v2024-non-employee-source-with-ne-count +title: NonEmployeeSourceWithNECount +pagination_label: NonEmployeeSourceWithNECount +sidebar_label: NonEmployeeSourceWithNECount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceWithNECount', 'V2024NonEmployeeSourceWithNECount'] +slug: /tools/sdk/go/v2024/models/non-employee-source-with-ne-count +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithNECount', 'V2024NonEmployeeSourceWithNECount'] +--- + +# NonEmployeeSourceWithNECount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**NonEmployeeCount** | Pointer to **NullableInt32** | Number of non-employee records associated with this source. This value is 'NULL' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional] + +## Methods + +### NewNonEmployeeSourceWithNECount + +`func NewNonEmployeeSourceWithNECount() *NonEmployeeSourceWithNECount` + +NewNonEmployeeSourceWithNECount instantiates a new NonEmployeeSourceWithNECount 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 + +### NewNonEmployeeSourceWithNECountWithDefaults + +`func NewNonEmployeeSourceWithNECountWithDefaults() *NonEmployeeSourceWithNECount` + +NewNonEmployeeSourceWithNECountWithDefaults instantiates a new NonEmployeeSourceWithNECount 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 + +### GetId + +`func (o *NonEmployeeSourceWithNECount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSourceWithNECount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSourceWithNECount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSourceWithNECount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSourceWithNECount) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSourceWithNECount) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSourceWithNECount) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSourceWithNECount) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSourceWithNECount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceWithNECount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceWithNECount) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSourceWithNECount) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSourceWithNECount) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceWithNECount) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceWithNECount) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSourceWithNECount) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetApprovers + +`func (o *NonEmployeeSourceWithNECount) GetApprovers() []NonEmployeeIdentityReferenceWithId` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *NonEmployeeSourceWithNECount) GetApproversOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *NonEmployeeSourceWithNECount) SetApprovers(v []NonEmployeeIdentityReferenceWithId)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *NonEmployeeSourceWithNECount) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetAccountManagers + +`func (o *NonEmployeeSourceWithNECount) GetAccountManagers() []NonEmployeeIdentityReferenceWithId` + +GetAccountManagers returns the AccountManagers field if non-nil, zero value otherwise. + +### GetAccountManagersOk + +`func (o *NonEmployeeSourceWithNECount) GetAccountManagersOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetAccountManagersOk returns a tuple with the AccountManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountManagers + +`func (o *NonEmployeeSourceWithNECount) SetAccountManagers(v []NonEmployeeIdentityReferenceWithId)` + +SetAccountManagers sets AccountManagers field to given value. + +### HasAccountManagers + +`func (o *NonEmployeeSourceWithNECount) HasAccountManagers() bool` + +HasAccountManagers returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeSourceWithNECount) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeSourceWithNECount) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeSourceWithNECount) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeSourceWithNECount) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeSourceWithNECount) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeSourceWithNECount) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeSourceWithNECount) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeSourceWithNECount) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetNonEmployeeCount + +`func (o *NonEmployeeSourceWithNECount) GetNonEmployeeCount() int32` + +GetNonEmployeeCount returns the NonEmployeeCount field if non-nil, zero value otherwise. + +### GetNonEmployeeCountOk + +`func (o *NonEmployeeSourceWithNECount) GetNonEmployeeCountOk() (*int32, bool)` + +GetNonEmployeeCountOk returns a tuple with the NonEmployeeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeCount + +`func (o *NonEmployeeSourceWithNECount) SetNonEmployeeCount(v int32)` + +SetNonEmployeeCount sets NonEmployeeCount field to given value. + +### HasNonEmployeeCount + +`func (o *NonEmployeeSourceWithNECount) HasNonEmployeeCount() bool` + +HasNonEmployeeCount returns a boolean if a field has been set. + +### SetNonEmployeeCountNil + +`func (o *NonEmployeeSourceWithNECount) SetNonEmployeeCountNil(b bool)` + + SetNonEmployeeCountNil sets the value for NonEmployeeCount to be an explicit nil + +### UnsetNonEmployeeCount +`func (o *NonEmployeeSourceWithNECount) UnsetNonEmployeeCount()` + +UnsetNonEmployeeCount ensures that no value is present for NonEmployeeCount, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/NotificationTemplateContext.md b/docs/tools/sdk/go/Reference/V2024/Models/NotificationTemplateContext.md new file mode 100644 index 000000000..839d4592b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/NotificationTemplateContext.md @@ -0,0 +1,116 @@ +--- +id: v2024-notification-template-context +title: NotificationTemplateContext +pagination_label: NotificationTemplateContext +sidebar_label: NotificationTemplateContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NotificationTemplateContext', 'V2024NotificationTemplateContext'] +slug: /tools/sdk/go/v2024/models/notification-template-context +tags: ['SDK', 'Software Development Kit', 'NotificationTemplateContext', 'V2024NotificationTemplateContext'] +--- + +# NotificationTemplateContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to **map[string]interface{}** | A JSON object that stores the context. | [optional] +**Created** | Pointer to **SailPointTime** | When the global context was created | [optional] +**Modified** | Pointer to **SailPointTime** | When the global context was last modified | [optional] + +## Methods + +### NewNotificationTemplateContext + +`func NewNotificationTemplateContext() *NotificationTemplateContext` + +NewNotificationTemplateContext instantiates a new NotificationTemplateContext 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 + +### NewNotificationTemplateContextWithDefaults + +`func NewNotificationTemplateContextWithDefaults() *NotificationTemplateContext` + +NewNotificationTemplateContextWithDefaults instantiates a new NotificationTemplateContext 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 + +### GetAttributes + +`func (o *NotificationTemplateContext) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *NotificationTemplateContext) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *NotificationTemplateContext) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *NotificationTemplateContext) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetCreated + +`func (o *NotificationTemplateContext) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NotificationTemplateContext) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NotificationTemplateContext) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NotificationTemplateContext) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *NotificationTemplateContext) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NotificationTemplateContext) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NotificationTemplateContext) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NotificationTemplateContext) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ObjectExportImportNames.md b/docs/tools/sdk/go/Reference/V2024/Models/ObjectExportImportNames.md new file mode 100644 index 000000000..516178c3c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ObjectExportImportNames.md @@ -0,0 +1,64 @@ +--- +id: v2024-object-export-import-names +title: ObjectExportImportNames +pagination_label: ObjectExportImportNames +sidebar_label: ObjectExportImportNames +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectExportImportNames', 'V2024ObjectExportImportNames'] +slug: /tools/sdk/go/v2024/models/object-export-import-names +tags: ['SDK', 'Software Development Kit', 'ObjectExportImportNames', 'V2024ObjectExportImportNames'] +--- + +# ObjectExportImportNames + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludedNames** | Pointer to **[]string** | Object names to be included in a backup. | [optional] + +## Methods + +### NewObjectExportImportNames + +`func NewObjectExportImportNames() *ObjectExportImportNames` + +NewObjectExportImportNames instantiates a new ObjectExportImportNames 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 + +### NewObjectExportImportNamesWithDefaults + +`func NewObjectExportImportNamesWithDefaults() *ObjectExportImportNames` + +NewObjectExportImportNamesWithDefaults instantiates a new ObjectExportImportNames 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 + +### GetIncludedNames + +`func (o *ObjectExportImportNames) GetIncludedNames() []string` + +GetIncludedNames returns the IncludedNames field if non-nil, zero value otherwise. + +### GetIncludedNamesOk + +`func (o *ObjectExportImportNames) GetIncludedNamesOk() (*[]string, bool)` + +GetIncludedNamesOk returns a tuple with the IncludedNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludedNames + +`func (o *ObjectExportImportNames) SetIncludedNames(v []string)` + +SetIncludedNames sets IncludedNames field to given value. + +### HasIncludedNames + +`func (o *ObjectExportImportNames) HasIncludedNames() bool` + +HasIncludedNames returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ObjectExportImportOptions.md b/docs/tools/sdk/go/Reference/V2024/Models/ObjectExportImportOptions.md new file mode 100644 index 000000000..a90536918 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ObjectExportImportOptions.md @@ -0,0 +1,90 @@ +--- +id: v2024-object-export-import-options +title: ObjectExportImportOptions +pagination_label: ObjectExportImportOptions +sidebar_label: ObjectExportImportOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectExportImportOptions', 'V2024ObjectExportImportOptions'] +slug: /tools/sdk/go/v2024/models/object-export-import-options +tags: ['SDK', 'Software Development Kit', 'ObjectExportImportOptions', 'V2024ObjectExportImportOptions'] +--- + +# ObjectExportImportOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludedIds** | Pointer to **[]string** | Object ids to be included in an import or export. | [optional] +**IncludedNames** | Pointer to **[]string** | Object names to be included in an import or export. | [optional] + +## Methods + +### NewObjectExportImportOptions + +`func NewObjectExportImportOptions() *ObjectExportImportOptions` + +NewObjectExportImportOptions instantiates a new ObjectExportImportOptions 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 + +### NewObjectExportImportOptionsWithDefaults + +`func NewObjectExportImportOptionsWithDefaults() *ObjectExportImportOptions` + +NewObjectExportImportOptionsWithDefaults instantiates a new ObjectExportImportOptions 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 + +### GetIncludedIds + +`func (o *ObjectExportImportOptions) GetIncludedIds() []string` + +GetIncludedIds returns the IncludedIds field if non-nil, zero value otherwise. + +### GetIncludedIdsOk + +`func (o *ObjectExportImportOptions) GetIncludedIdsOk() (*[]string, bool)` + +GetIncludedIdsOk returns a tuple with the IncludedIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludedIds + +`func (o *ObjectExportImportOptions) SetIncludedIds(v []string)` + +SetIncludedIds sets IncludedIds field to given value. + +### HasIncludedIds + +`func (o *ObjectExportImportOptions) HasIncludedIds() bool` + +HasIncludedIds returns a boolean if a field has been set. + +### GetIncludedNames + +`func (o *ObjectExportImportOptions) GetIncludedNames() []string` + +GetIncludedNames returns the IncludedNames field if non-nil, zero value otherwise. + +### GetIncludedNamesOk + +`func (o *ObjectExportImportOptions) GetIncludedNamesOk() (*[]string, bool)` + +GetIncludedNamesOk returns a tuple with the IncludedNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludedNames + +`func (o *ObjectExportImportOptions) SetIncludedNames(v []string)` + +SetIncludedNames sets IncludedNames field to given value. + +### HasIncludedNames + +`func (o *ObjectExportImportOptions) HasIncludedNames() bool` + +HasIncludedNames returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ObjectImportResult.md b/docs/tools/sdk/go/Reference/V2024/Models/ObjectImportResult.md new file mode 100644 index 000000000..964e9641f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ObjectImportResult.md @@ -0,0 +1,122 @@ +--- +id: v2024-object-import-result +title: ObjectImportResult +pagination_label: ObjectImportResult +sidebar_label: ObjectImportResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectImportResult', 'V2024ObjectImportResult'] +slug: /tools/sdk/go/v2024/models/object-import-result +tags: ['SDK', 'Software Development Kit', 'ObjectImportResult', 'V2024ObjectImportResult'] +--- + +# ObjectImportResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Infos** | [**[]SpConfigMessage**](sp-config-message) | Informational messages returned from the target service on import. | +**Warnings** | [**[]SpConfigMessage**](sp-config-message) | Warning messages returned from the target service on import. | +**Errors** | [**[]SpConfigMessage**](sp-config-message) | Error messages returned from the target service on import. | +**ImportedObjects** | [**[]ImportObject**](import-object) | References to objects that were created or updated by the import. | + +## Methods + +### NewObjectImportResult + +`func NewObjectImportResult(infos []SpConfigMessage, warnings []SpConfigMessage, errors []SpConfigMessage, importedObjects []ImportObject, ) *ObjectImportResult` + +NewObjectImportResult instantiates a new ObjectImportResult 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 + +### NewObjectImportResultWithDefaults + +`func NewObjectImportResultWithDefaults() *ObjectImportResult` + +NewObjectImportResultWithDefaults instantiates a new ObjectImportResult 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 + +### GetInfos + +`func (o *ObjectImportResult) GetInfos() []SpConfigMessage` + +GetInfos returns the Infos field if non-nil, zero value otherwise. + +### GetInfosOk + +`func (o *ObjectImportResult) GetInfosOk() (*[]SpConfigMessage, bool)` + +GetInfosOk returns a tuple with the Infos field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfos + +`func (o *ObjectImportResult) SetInfos(v []SpConfigMessage)` + +SetInfos sets Infos field to given value. + + +### GetWarnings + +`func (o *ObjectImportResult) GetWarnings() []SpConfigMessage` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *ObjectImportResult) GetWarningsOk() (*[]SpConfigMessage, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *ObjectImportResult) SetWarnings(v []SpConfigMessage)` + +SetWarnings sets Warnings field to given value. + + +### GetErrors + +`func (o *ObjectImportResult) GetErrors() []SpConfigMessage` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *ObjectImportResult) GetErrorsOk() (*[]SpConfigMessage, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *ObjectImportResult) SetErrors(v []SpConfigMessage)` + +SetErrors sets Errors field to given value. + + +### GetImportedObjects + +`func (o *ObjectImportResult) GetImportedObjects() []ImportObject` + +GetImportedObjects returns the ImportedObjects field if non-nil, zero value otherwise. + +### GetImportedObjectsOk + +`func (o *ObjectImportResult) GetImportedObjectsOk() (*[]ImportObject, bool)` + +GetImportedObjectsOk returns a tuple with the ImportedObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImportedObjects + +`func (o *ObjectImportResult) SetImportedObjects(v []ImportObject)` + +SetImportedObjects sets ImportedObjects field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ObjectImportResult1.md b/docs/tools/sdk/go/Reference/V2024/Models/ObjectImportResult1.md new file mode 100644 index 000000000..7bfc6f11f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ObjectImportResult1.md @@ -0,0 +1,122 @@ +--- +id: v2024-object-import-result1 +title: ObjectImportResult1 +pagination_label: ObjectImportResult1 +sidebar_label: ObjectImportResult1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectImportResult1', 'V2024ObjectImportResult1'] +slug: /tools/sdk/go/v2024/models/object-import-result1 +tags: ['SDK', 'Software Development Kit', 'ObjectImportResult1', 'V2024ObjectImportResult1'] +--- + +# ObjectImportResult1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Infos** | [**[]SpConfigMessage1**](sp-config-message1) | Informational messages returned from the target service on import. | +**Warnings** | [**[]SpConfigMessage1**](sp-config-message1) | Warning messages returned from the target service on import. | +**Errors** | [**[]SpConfigMessage1**](sp-config-message1) | Error messages returned from the target service on import. | +**ImportedObjects** | [**[]ImportObject**](import-object) | References to objects that were created or updated by the import. | + +## Methods + +### NewObjectImportResult1 + +`func NewObjectImportResult1(infos []SpConfigMessage1, warnings []SpConfigMessage1, errors []SpConfigMessage1, importedObjects []ImportObject, ) *ObjectImportResult1` + +NewObjectImportResult1 instantiates a new ObjectImportResult1 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 + +### NewObjectImportResult1WithDefaults + +`func NewObjectImportResult1WithDefaults() *ObjectImportResult1` + +NewObjectImportResult1WithDefaults instantiates a new ObjectImportResult1 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 + +### GetInfos + +`func (o *ObjectImportResult1) GetInfos() []SpConfigMessage1` + +GetInfos returns the Infos field if non-nil, zero value otherwise. + +### GetInfosOk + +`func (o *ObjectImportResult1) GetInfosOk() (*[]SpConfigMessage1, bool)` + +GetInfosOk returns a tuple with the Infos field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfos + +`func (o *ObjectImportResult1) SetInfos(v []SpConfigMessage1)` + +SetInfos sets Infos field to given value. + + +### GetWarnings + +`func (o *ObjectImportResult1) GetWarnings() []SpConfigMessage1` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *ObjectImportResult1) GetWarningsOk() (*[]SpConfigMessage1, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *ObjectImportResult1) SetWarnings(v []SpConfigMessage1)` + +SetWarnings sets Warnings field to given value. + + +### GetErrors + +`func (o *ObjectImportResult1) GetErrors() []SpConfigMessage1` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *ObjectImportResult1) GetErrorsOk() (*[]SpConfigMessage1, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *ObjectImportResult1) SetErrors(v []SpConfigMessage1)` + +SetErrors sets Errors field to given value. + + +### GetImportedObjects + +`func (o *ObjectImportResult1) GetImportedObjects() []ImportObject` + +GetImportedObjects returns the ImportedObjects field if non-nil, zero value otherwise. + +### GetImportedObjectsOk + +`func (o *ObjectImportResult1) GetImportedObjectsOk() (*[]ImportObject, bool)` + +GetImportedObjectsOk returns a tuple with the ImportedObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImportedObjects + +`func (o *ObjectImportResult1) SetImportedObjects(v []ImportObject)` + +SetImportedObjects sets ImportedObjects field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingBulkCreateRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingBulkCreateRequest.md new file mode 100644 index 000000000..45490e46f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingBulkCreateRequest.md @@ -0,0 +1,59 @@ +--- +id: v2024-object-mapping-bulk-create-request +title: ObjectMappingBulkCreateRequest +pagination_label: ObjectMappingBulkCreateRequest +sidebar_label: ObjectMappingBulkCreateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingBulkCreateRequest', 'V2024ObjectMappingBulkCreateRequest'] +slug: /tools/sdk/go/v2024/models/object-mapping-bulk-create-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkCreateRequest', 'V2024ObjectMappingBulkCreateRequest'] +--- + +# ObjectMappingBulkCreateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewObjectsMappings** | [**[]ObjectMappingRequest**](object-mapping-request) | | + +## Methods + +### NewObjectMappingBulkCreateRequest + +`func NewObjectMappingBulkCreateRequest(newObjectsMappings []ObjectMappingRequest, ) *ObjectMappingBulkCreateRequest` + +NewObjectMappingBulkCreateRequest instantiates a new ObjectMappingBulkCreateRequest 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 + +### NewObjectMappingBulkCreateRequestWithDefaults + +`func NewObjectMappingBulkCreateRequestWithDefaults() *ObjectMappingBulkCreateRequest` + +NewObjectMappingBulkCreateRequestWithDefaults instantiates a new ObjectMappingBulkCreateRequest 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 + +### GetNewObjectsMappings + +`func (o *ObjectMappingBulkCreateRequest) GetNewObjectsMappings() []ObjectMappingRequest` + +GetNewObjectsMappings returns the NewObjectsMappings field if non-nil, zero value otherwise. + +### GetNewObjectsMappingsOk + +`func (o *ObjectMappingBulkCreateRequest) GetNewObjectsMappingsOk() (*[]ObjectMappingRequest, bool)` + +GetNewObjectsMappingsOk returns a tuple with the NewObjectsMappings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewObjectsMappings + +`func (o *ObjectMappingBulkCreateRequest) SetNewObjectsMappings(v []ObjectMappingRequest)` + +SetNewObjectsMappings sets NewObjectsMappings field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingBulkCreateResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingBulkCreateResponse.md new file mode 100644 index 000000000..1e8d33021 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingBulkCreateResponse.md @@ -0,0 +1,64 @@ +--- +id: v2024-object-mapping-bulk-create-response +title: ObjectMappingBulkCreateResponse +pagination_label: ObjectMappingBulkCreateResponse +sidebar_label: ObjectMappingBulkCreateResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingBulkCreateResponse', 'V2024ObjectMappingBulkCreateResponse'] +slug: /tools/sdk/go/v2024/models/object-mapping-bulk-create-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkCreateResponse', 'V2024ObjectMappingBulkCreateResponse'] +--- + +# ObjectMappingBulkCreateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddedObjects** | Pointer to [**[]ObjectMappingResponse**](object-mapping-response) | | [optional] + +## Methods + +### NewObjectMappingBulkCreateResponse + +`func NewObjectMappingBulkCreateResponse() *ObjectMappingBulkCreateResponse` + +NewObjectMappingBulkCreateResponse instantiates a new ObjectMappingBulkCreateResponse 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 + +### NewObjectMappingBulkCreateResponseWithDefaults + +`func NewObjectMappingBulkCreateResponseWithDefaults() *ObjectMappingBulkCreateResponse` + +NewObjectMappingBulkCreateResponseWithDefaults instantiates a new ObjectMappingBulkCreateResponse 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 + +### GetAddedObjects + +`func (o *ObjectMappingBulkCreateResponse) GetAddedObjects() []ObjectMappingResponse` + +GetAddedObjects returns the AddedObjects field if non-nil, zero value otherwise. + +### GetAddedObjectsOk + +`func (o *ObjectMappingBulkCreateResponse) GetAddedObjectsOk() (*[]ObjectMappingResponse, bool)` + +GetAddedObjectsOk returns a tuple with the AddedObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAddedObjects + +`func (o *ObjectMappingBulkCreateResponse) SetAddedObjects(v []ObjectMappingResponse)` + +SetAddedObjects sets AddedObjects field to given value. + +### HasAddedObjects + +`func (o *ObjectMappingBulkCreateResponse) HasAddedObjects() bool` + +HasAddedObjects returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingBulkPatchRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingBulkPatchRequest.md new file mode 100644 index 000000000..1fa274fa2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingBulkPatchRequest.md @@ -0,0 +1,59 @@ +--- +id: v2024-object-mapping-bulk-patch-request +title: ObjectMappingBulkPatchRequest +pagination_label: ObjectMappingBulkPatchRequest +sidebar_label: ObjectMappingBulkPatchRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingBulkPatchRequest', 'V2024ObjectMappingBulkPatchRequest'] +slug: /tools/sdk/go/v2024/models/object-mapping-bulk-patch-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchRequest', 'V2024ObjectMappingBulkPatchRequest'] +--- + +# ObjectMappingBulkPatchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Patches** | [**map[string][]JsonPatchOperation**](https://go.dev/tour/moretypes/6) | Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. | + +## Methods + +### NewObjectMappingBulkPatchRequest + +`func NewObjectMappingBulkPatchRequest(patches map[string][]JsonPatchOperation, ) *ObjectMappingBulkPatchRequest` + +NewObjectMappingBulkPatchRequest instantiates a new ObjectMappingBulkPatchRequest 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 + +### NewObjectMappingBulkPatchRequestWithDefaults + +`func NewObjectMappingBulkPatchRequestWithDefaults() *ObjectMappingBulkPatchRequest` + +NewObjectMappingBulkPatchRequestWithDefaults instantiates a new ObjectMappingBulkPatchRequest 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 + +### GetPatches + +`func (o *ObjectMappingBulkPatchRequest) GetPatches() map[string][]JsonPatchOperation` + +GetPatches returns the Patches field if non-nil, zero value otherwise. + +### GetPatchesOk + +`func (o *ObjectMappingBulkPatchRequest) GetPatchesOk() (*map[string][]JsonPatchOperation, bool)` + +GetPatchesOk returns a tuple with the Patches field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPatches + +`func (o *ObjectMappingBulkPatchRequest) SetPatches(v map[string][]JsonPatchOperation)` + +SetPatches sets Patches field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingBulkPatchResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingBulkPatchResponse.md new file mode 100644 index 000000000..b5d5f2bfc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingBulkPatchResponse.md @@ -0,0 +1,64 @@ +--- +id: v2024-object-mapping-bulk-patch-response +title: ObjectMappingBulkPatchResponse +pagination_label: ObjectMappingBulkPatchResponse +sidebar_label: ObjectMappingBulkPatchResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingBulkPatchResponse', 'V2024ObjectMappingBulkPatchResponse'] +slug: /tools/sdk/go/v2024/models/object-mapping-bulk-patch-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchResponse', 'V2024ObjectMappingBulkPatchResponse'] +--- + +# ObjectMappingBulkPatchResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PatchedObjects** | Pointer to [**[]ObjectMappingResponse**](object-mapping-response) | | [optional] + +## Methods + +### NewObjectMappingBulkPatchResponse + +`func NewObjectMappingBulkPatchResponse() *ObjectMappingBulkPatchResponse` + +NewObjectMappingBulkPatchResponse instantiates a new ObjectMappingBulkPatchResponse 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 + +### NewObjectMappingBulkPatchResponseWithDefaults + +`func NewObjectMappingBulkPatchResponseWithDefaults() *ObjectMappingBulkPatchResponse` + +NewObjectMappingBulkPatchResponseWithDefaults instantiates a new ObjectMappingBulkPatchResponse 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 + +### GetPatchedObjects + +`func (o *ObjectMappingBulkPatchResponse) GetPatchedObjects() []ObjectMappingResponse` + +GetPatchedObjects returns the PatchedObjects field if non-nil, zero value otherwise. + +### GetPatchedObjectsOk + +`func (o *ObjectMappingBulkPatchResponse) GetPatchedObjectsOk() (*[]ObjectMappingResponse, bool)` + +GetPatchedObjectsOk returns a tuple with the PatchedObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPatchedObjects + +`func (o *ObjectMappingBulkPatchResponse) SetPatchedObjects(v []ObjectMappingResponse)` + +SetPatchedObjects sets PatchedObjects field to given value. + +### HasPatchedObjects + +`func (o *ObjectMappingBulkPatchResponse) HasPatchedObjects() bool` + +HasPatchedObjects returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingRequest.md new file mode 100644 index 000000000..00042d62e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingRequest.md @@ -0,0 +1,148 @@ +--- +id: v2024-object-mapping-request +title: ObjectMappingRequest +pagination_label: ObjectMappingRequest +sidebar_label: ObjectMappingRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingRequest', 'V2024ObjectMappingRequest'] +slug: /tools/sdk/go/v2024/models/object-mapping-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingRequest', 'V2024ObjectMappingRequest'] +--- + +# ObjectMappingRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectType** | **string** | Type of the object the mapping value applies to, must be one from enum | +**JsonPath** | **string** | JSONPath expression denoting the path within the object where the mapping value should be applied | +**SourceValue** | **string** | Original value at the jsonPath location within the object | +**TargetValue** | **string** | Value to be assigned at the jsonPath location within the object | +**Enabled** | Pointer to **bool** | Whether or not this object mapping is enabled | [optional] [default to false] + +## Methods + +### NewObjectMappingRequest + +`func NewObjectMappingRequest(objectType string, jsonPath string, sourceValue string, targetValue string, ) *ObjectMappingRequest` + +NewObjectMappingRequest instantiates a new ObjectMappingRequest 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 + +### NewObjectMappingRequestWithDefaults + +`func NewObjectMappingRequestWithDefaults() *ObjectMappingRequest` + +NewObjectMappingRequestWithDefaults instantiates a new ObjectMappingRequest 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 + +### GetObjectType + +`func (o *ObjectMappingRequest) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *ObjectMappingRequest) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *ObjectMappingRequest) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + + +### GetJsonPath + +`func (o *ObjectMappingRequest) GetJsonPath() string` + +GetJsonPath returns the JsonPath field if non-nil, zero value otherwise. + +### GetJsonPathOk + +`func (o *ObjectMappingRequest) GetJsonPathOk() (*string, bool)` + +GetJsonPathOk returns a tuple with the JsonPath field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJsonPath + +`func (o *ObjectMappingRequest) SetJsonPath(v string)` + +SetJsonPath sets JsonPath field to given value. + + +### GetSourceValue + +`func (o *ObjectMappingRequest) GetSourceValue() string` + +GetSourceValue returns the SourceValue field if non-nil, zero value otherwise. + +### GetSourceValueOk + +`func (o *ObjectMappingRequest) GetSourceValueOk() (*string, bool)` + +GetSourceValueOk returns a tuple with the SourceValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceValue + +`func (o *ObjectMappingRequest) SetSourceValue(v string)` + +SetSourceValue sets SourceValue field to given value. + + +### GetTargetValue + +`func (o *ObjectMappingRequest) GetTargetValue() string` + +GetTargetValue returns the TargetValue field if non-nil, zero value otherwise. + +### GetTargetValueOk + +`func (o *ObjectMappingRequest) GetTargetValueOk() (*string, bool)` + +GetTargetValueOk returns a tuple with the TargetValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetValue + +`func (o *ObjectMappingRequest) SetTargetValue(v string)` + +SetTargetValue sets TargetValue field to given value. + + +### GetEnabled + +`func (o *ObjectMappingRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ObjectMappingRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ObjectMappingRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ObjectMappingRequest) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingResponse.md new file mode 100644 index 000000000..f340db0a0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ObjectMappingResponse.md @@ -0,0 +1,246 @@ +--- +id: v2024-object-mapping-response +title: ObjectMappingResponse +pagination_label: ObjectMappingResponse +sidebar_label: ObjectMappingResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingResponse', 'V2024ObjectMappingResponse'] +slug: /tools/sdk/go/v2024/models/object-mapping-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingResponse', 'V2024ObjectMappingResponse'] +--- + +# ObjectMappingResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectMappingId** | Pointer to **string** | Id of the object mapping | [optional] +**ObjectType** | Pointer to **string** | Type of the object the mapping value applies to | [optional] +**JsonPath** | Pointer to **string** | JSONPath expression denoting the path within the object where the mapping value should be applied | [optional] +**SourceValue** | Pointer to **string** | Original value at the jsonPath location within the object | [optional] +**TargetValue** | Pointer to **string** | Value to be assigned at the jsonPath location within the object | [optional] +**Enabled** | Pointer to **bool** | Whether or not this object mapping is enabled | [optional] [default to false] +**Created** | Pointer to **string** | Object mapping creation timestamp | [optional] +**Modified** | Pointer to **string** | Object mapping latest update timestamp | [optional] + +## Methods + +### NewObjectMappingResponse + +`func NewObjectMappingResponse() *ObjectMappingResponse` + +NewObjectMappingResponse instantiates a new ObjectMappingResponse 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 + +### NewObjectMappingResponseWithDefaults + +`func NewObjectMappingResponseWithDefaults() *ObjectMappingResponse` + +NewObjectMappingResponseWithDefaults instantiates a new ObjectMappingResponse 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 + +### GetObjectMappingId + +`func (o *ObjectMappingResponse) GetObjectMappingId() string` + +GetObjectMappingId returns the ObjectMappingId field if non-nil, zero value otherwise. + +### GetObjectMappingIdOk + +`func (o *ObjectMappingResponse) GetObjectMappingIdOk() (*string, bool)` + +GetObjectMappingIdOk returns a tuple with the ObjectMappingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectMappingId + +`func (o *ObjectMappingResponse) SetObjectMappingId(v string)` + +SetObjectMappingId sets ObjectMappingId field to given value. + +### HasObjectMappingId + +`func (o *ObjectMappingResponse) HasObjectMappingId() bool` + +HasObjectMappingId returns a boolean if a field has been set. + +### GetObjectType + +`func (o *ObjectMappingResponse) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *ObjectMappingResponse) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *ObjectMappingResponse) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + +### HasObjectType + +`func (o *ObjectMappingResponse) HasObjectType() bool` + +HasObjectType returns a boolean if a field has been set. + +### GetJsonPath + +`func (o *ObjectMappingResponse) GetJsonPath() string` + +GetJsonPath returns the JsonPath field if non-nil, zero value otherwise. + +### GetJsonPathOk + +`func (o *ObjectMappingResponse) GetJsonPathOk() (*string, bool)` + +GetJsonPathOk returns a tuple with the JsonPath field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJsonPath + +`func (o *ObjectMappingResponse) SetJsonPath(v string)` + +SetJsonPath sets JsonPath field to given value. + +### HasJsonPath + +`func (o *ObjectMappingResponse) HasJsonPath() bool` + +HasJsonPath returns a boolean if a field has been set. + +### GetSourceValue + +`func (o *ObjectMappingResponse) GetSourceValue() string` + +GetSourceValue returns the SourceValue field if non-nil, zero value otherwise. + +### GetSourceValueOk + +`func (o *ObjectMappingResponse) GetSourceValueOk() (*string, bool)` + +GetSourceValueOk returns a tuple with the SourceValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceValue + +`func (o *ObjectMappingResponse) SetSourceValue(v string)` + +SetSourceValue sets SourceValue field to given value. + +### HasSourceValue + +`func (o *ObjectMappingResponse) HasSourceValue() bool` + +HasSourceValue returns a boolean if a field has been set. + +### GetTargetValue + +`func (o *ObjectMappingResponse) GetTargetValue() string` + +GetTargetValue returns the TargetValue field if non-nil, zero value otherwise. + +### GetTargetValueOk + +`func (o *ObjectMappingResponse) GetTargetValueOk() (*string, bool)` + +GetTargetValueOk returns a tuple with the TargetValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetValue + +`func (o *ObjectMappingResponse) SetTargetValue(v string)` + +SetTargetValue sets TargetValue field to given value. + +### HasTargetValue + +`func (o *ObjectMappingResponse) HasTargetValue() bool` + +HasTargetValue returns a boolean if a field has been set. + +### GetEnabled + +`func (o *ObjectMappingResponse) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ObjectMappingResponse) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ObjectMappingResponse) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ObjectMappingResponse) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetCreated + +`func (o *ObjectMappingResponse) GetCreated() string` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ObjectMappingResponse) GetCreatedOk() (*string, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ObjectMappingResponse) SetCreated(v string)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ObjectMappingResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *ObjectMappingResponse) GetModified() string` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ObjectMappingResponse) GetModifiedOk() (*string, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ObjectMappingResponse) SetModified(v string)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ObjectMappingResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Operation.md b/docs/tools/sdk/go/Reference/V2024/Models/Operation.md new file mode 100644 index 000000000..320d914c6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Operation.md @@ -0,0 +1,31 @@ +--- +id: v2024-operation +title: Operation +pagination_label: Operation +sidebar_label: Operation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Operation', 'V2024Operation'] +slug: /tools/sdk/go/v2024/models/operation +tags: ['SDK', 'Software Development Kit', 'Operation', 'V2024Operation'] +--- + +# Operation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `STARTS_WITH` (value: `"STARTS_WITH"`) + +* `ENDS_WITH` (value: `"ENDS_WITH"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/OrgConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/OrgConfig.md new file mode 100644 index 000000000..9fc4f351c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/OrgConfig.md @@ -0,0 +1,348 @@ +--- +id: v2024-org-config +title: OrgConfig +pagination_label: OrgConfig +sidebar_label: OrgConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OrgConfig', 'V2024OrgConfig'] +slug: /tools/sdk/go/v2024/models/org-config +tags: ['SDK', 'Software Development Kit', 'OrgConfig', 'V2024OrgConfig'] +--- + +# OrgConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrgName** | Pointer to **string** | The name of the org. | [optional] +**TimeZone** | Pointer to **string** | The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones | [optional] +**LcsChangeHonorsSourceEnableFeature** | Pointer to **bool** | Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org. | [optional] +**ArmCustomerId** | Pointer to **NullableString** | ARM Customer ID | [optional] +**ArmSapSystemIdMappings** | Pointer to **NullableString** | A list of IDN::sourceId to ARM::systemId mappings. | [optional] +**ArmAuth** | Pointer to **NullableString** | ARM authentication string | [optional] +**ArmDb** | Pointer to **NullableString** | ARM database name | [optional] +**ArmSsoUrl** | Pointer to **NullableString** | ARM SSO URL | [optional] +**IaiEnableCertificationRecommendations** | Pointer to **bool** | Flag to determine whether IAI Certification Recommendations are enabled for the current org | [optional] +**SodReportConfigs** | Pointer to [**[]ReportConfigDTO**](report-config-dto) | | [optional] + +## Methods + +### NewOrgConfig + +`func NewOrgConfig() *OrgConfig` + +NewOrgConfig instantiates a new OrgConfig 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 + +### NewOrgConfigWithDefaults + +`func NewOrgConfigWithDefaults() *OrgConfig` + +NewOrgConfigWithDefaults instantiates a new OrgConfig 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 + +### GetOrgName + +`func (o *OrgConfig) GetOrgName() string` + +GetOrgName returns the OrgName field if non-nil, zero value otherwise. + +### GetOrgNameOk + +`func (o *OrgConfig) GetOrgNameOk() (*string, bool)` + +GetOrgNameOk returns a tuple with the OrgName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgName + +`func (o *OrgConfig) SetOrgName(v string)` + +SetOrgName sets OrgName field to given value. + +### HasOrgName + +`func (o *OrgConfig) HasOrgName() bool` + +HasOrgName returns a boolean if a field has been set. + +### GetTimeZone + +`func (o *OrgConfig) GetTimeZone() string` + +GetTimeZone returns the TimeZone field if non-nil, zero value otherwise. + +### GetTimeZoneOk + +`func (o *OrgConfig) GetTimeZoneOk() (*string, bool)` + +GetTimeZoneOk returns a tuple with the TimeZone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZone + +`func (o *OrgConfig) SetTimeZone(v string)` + +SetTimeZone sets TimeZone field to given value. + +### HasTimeZone + +`func (o *OrgConfig) HasTimeZone() bool` + +HasTimeZone returns a boolean if a field has been set. + +### GetLcsChangeHonorsSourceEnableFeature + +`func (o *OrgConfig) GetLcsChangeHonorsSourceEnableFeature() bool` + +GetLcsChangeHonorsSourceEnableFeature returns the LcsChangeHonorsSourceEnableFeature field if non-nil, zero value otherwise. + +### GetLcsChangeHonorsSourceEnableFeatureOk + +`func (o *OrgConfig) GetLcsChangeHonorsSourceEnableFeatureOk() (*bool, bool)` + +GetLcsChangeHonorsSourceEnableFeatureOk returns a tuple with the LcsChangeHonorsSourceEnableFeature field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLcsChangeHonorsSourceEnableFeature + +`func (o *OrgConfig) SetLcsChangeHonorsSourceEnableFeature(v bool)` + +SetLcsChangeHonorsSourceEnableFeature sets LcsChangeHonorsSourceEnableFeature field to given value. + +### HasLcsChangeHonorsSourceEnableFeature + +`func (o *OrgConfig) HasLcsChangeHonorsSourceEnableFeature() bool` + +HasLcsChangeHonorsSourceEnableFeature returns a boolean if a field has been set. + +### GetArmCustomerId + +`func (o *OrgConfig) GetArmCustomerId() string` + +GetArmCustomerId returns the ArmCustomerId field if non-nil, zero value otherwise. + +### GetArmCustomerIdOk + +`func (o *OrgConfig) GetArmCustomerIdOk() (*string, bool)` + +GetArmCustomerIdOk returns a tuple with the ArmCustomerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArmCustomerId + +`func (o *OrgConfig) SetArmCustomerId(v string)` + +SetArmCustomerId sets ArmCustomerId field to given value. + +### HasArmCustomerId + +`func (o *OrgConfig) HasArmCustomerId() bool` + +HasArmCustomerId returns a boolean if a field has been set. + +### SetArmCustomerIdNil + +`func (o *OrgConfig) SetArmCustomerIdNil(b bool)` + + SetArmCustomerIdNil sets the value for ArmCustomerId to be an explicit nil + +### UnsetArmCustomerId +`func (o *OrgConfig) UnsetArmCustomerId()` + +UnsetArmCustomerId ensures that no value is present for ArmCustomerId, not even an explicit nil +### GetArmSapSystemIdMappings + +`func (o *OrgConfig) GetArmSapSystemIdMappings() string` + +GetArmSapSystemIdMappings returns the ArmSapSystemIdMappings field if non-nil, zero value otherwise. + +### GetArmSapSystemIdMappingsOk + +`func (o *OrgConfig) GetArmSapSystemIdMappingsOk() (*string, bool)` + +GetArmSapSystemIdMappingsOk returns a tuple with the ArmSapSystemIdMappings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArmSapSystemIdMappings + +`func (o *OrgConfig) SetArmSapSystemIdMappings(v string)` + +SetArmSapSystemIdMappings sets ArmSapSystemIdMappings field to given value. + +### HasArmSapSystemIdMappings + +`func (o *OrgConfig) HasArmSapSystemIdMappings() bool` + +HasArmSapSystemIdMappings returns a boolean if a field has been set. + +### SetArmSapSystemIdMappingsNil + +`func (o *OrgConfig) SetArmSapSystemIdMappingsNil(b bool)` + + SetArmSapSystemIdMappingsNil sets the value for ArmSapSystemIdMappings to be an explicit nil + +### UnsetArmSapSystemIdMappings +`func (o *OrgConfig) UnsetArmSapSystemIdMappings()` + +UnsetArmSapSystemIdMappings ensures that no value is present for ArmSapSystemIdMappings, not even an explicit nil +### GetArmAuth + +`func (o *OrgConfig) GetArmAuth() string` + +GetArmAuth returns the ArmAuth field if non-nil, zero value otherwise. + +### GetArmAuthOk + +`func (o *OrgConfig) GetArmAuthOk() (*string, bool)` + +GetArmAuthOk returns a tuple with the ArmAuth field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArmAuth + +`func (o *OrgConfig) SetArmAuth(v string)` + +SetArmAuth sets ArmAuth field to given value. + +### HasArmAuth + +`func (o *OrgConfig) HasArmAuth() bool` + +HasArmAuth returns a boolean if a field has been set. + +### SetArmAuthNil + +`func (o *OrgConfig) SetArmAuthNil(b bool)` + + SetArmAuthNil sets the value for ArmAuth to be an explicit nil + +### UnsetArmAuth +`func (o *OrgConfig) UnsetArmAuth()` + +UnsetArmAuth ensures that no value is present for ArmAuth, not even an explicit nil +### GetArmDb + +`func (o *OrgConfig) GetArmDb() string` + +GetArmDb returns the ArmDb field if non-nil, zero value otherwise. + +### GetArmDbOk + +`func (o *OrgConfig) GetArmDbOk() (*string, bool)` + +GetArmDbOk returns a tuple with the ArmDb field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArmDb + +`func (o *OrgConfig) SetArmDb(v string)` + +SetArmDb sets ArmDb field to given value. + +### HasArmDb + +`func (o *OrgConfig) HasArmDb() bool` + +HasArmDb returns a boolean if a field has been set. + +### SetArmDbNil + +`func (o *OrgConfig) SetArmDbNil(b bool)` + + SetArmDbNil sets the value for ArmDb to be an explicit nil + +### UnsetArmDb +`func (o *OrgConfig) UnsetArmDb()` + +UnsetArmDb ensures that no value is present for ArmDb, not even an explicit nil +### GetArmSsoUrl + +`func (o *OrgConfig) GetArmSsoUrl() string` + +GetArmSsoUrl returns the ArmSsoUrl field if non-nil, zero value otherwise. + +### GetArmSsoUrlOk + +`func (o *OrgConfig) GetArmSsoUrlOk() (*string, bool)` + +GetArmSsoUrlOk returns a tuple with the ArmSsoUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArmSsoUrl + +`func (o *OrgConfig) SetArmSsoUrl(v string)` + +SetArmSsoUrl sets ArmSsoUrl field to given value. + +### HasArmSsoUrl + +`func (o *OrgConfig) HasArmSsoUrl() bool` + +HasArmSsoUrl returns a boolean if a field has been set. + +### SetArmSsoUrlNil + +`func (o *OrgConfig) SetArmSsoUrlNil(b bool)` + + SetArmSsoUrlNil sets the value for ArmSsoUrl to be an explicit nil + +### UnsetArmSsoUrl +`func (o *OrgConfig) UnsetArmSsoUrl()` + +UnsetArmSsoUrl ensures that no value is present for ArmSsoUrl, not even an explicit nil +### GetIaiEnableCertificationRecommendations + +`func (o *OrgConfig) GetIaiEnableCertificationRecommendations() bool` + +GetIaiEnableCertificationRecommendations returns the IaiEnableCertificationRecommendations field if non-nil, zero value otherwise. + +### GetIaiEnableCertificationRecommendationsOk + +`func (o *OrgConfig) GetIaiEnableCertificationRecommendationsOk() (*bool, bool)` + +GetIaiEnableCertificationRecommendationsOk returns a tuple with the IaiEnableCertificationRecommendations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIaiEnableCertificationRecommendations + +`func (o *OrgConfig) SetIaiEnableCertificationRecommendations(v bool)` + +SetIaiEnableCertificationRecommendations sets IaiEnableCertificationRecommendations field to given value. + +### HasIaiEnableCertificationRecommendations + +`func (o *OrgConfig) HasIaiEnableCertificationRecommendations() bool` + +HasIaiEnableCertificationRecommendations returns a boolean if a field has been set. + +### GetSodReportConfigs + +`func (o *OrgConfig) GetSodReportConfigs() []ReportConfigDTO` + +GetSodReportConfigs returns the SodReportConfigs field if non-nil, zero value otherwise. + +### GetSodReportConfigsOk + +`func (o *OrgConfig) GetSodReportConfigsOk() (*[]ReportConfigDTO, bool)` + +GetSodReportConfigsOk returns a tuple with the SodReportConfigs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodReportConfigs + +`func (o *OrgConfig) SetSodReportConfigs(v []ReportConfigDTO)` + +SetSodReportConfigs sets SodReportConfigs field to given value. + +### HasSodReportConfigs + +`func (o *OrgConfig) HasSodReportConfigs() bool` + +HasSodReportConfigs returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/OriginalRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/OriginalRequest.md new file mode 100644 index 000000000..4f918b458 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/OriginalRequest.md @@ -0,0 +1,168 @@ +--- +id: v2024-original-request +title: OriginalRequest +pagination_label: OriginalRequest +sidebar_label: OriginalRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OriginalRequest', 'V2024OriginalRequest'] +slug: /tools/sdk/go/v2024/models/original-request +tags: ['SDK', 'Software Development Kit', 'OriginalRequest', 'V2024OriginalRequest'] +--- + +# OriginalRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **string** | Account ID. | [optional] +**Result** | Pointer to [**Result**](result) | | [optional] +**AttributeRequests** | Pointer to [**[]AttributeRequest**](attribute-request) | Attribute changes requested for account. | [optional] +**Op** | Pointer to **string** | Operation used. | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] + +## Methods + +### NewOriginalRequest + +`func NewOriginalRequest() *OriginalRequest` + +NewOriginalRequest instantiates a new OriginalRequest 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 + +### NewOriginalRequestWithDefaults + +`func NewOriginalRequestWithDefaults() *OriginalRequest` + +NewOriginalRequestWithDefaults instantiates a new OriginalRequest 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 + +### GetAccountId + +`func (o *OriginalRequest) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *OriginalRequest) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *OriginalRequest) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *OriginalRequest) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetResult + +`func (o *OriginalRequest) GetResult() Result` + +GetResult returns the Result field if non-nil, zero value otherwise. + +### GetResultOk + +`func (o *OriginalRequest) GetResultOk() (*Result, bool)` + +GetResultOk returns a tuple with the Result field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResult + +`func (o *OriginalRequest) SetResult(v Result)` + +SetResult sets Result field to given value. + +### HasResult + +`func (o *OriginalRequest) HasResult() bool` + +HasResult returns a boolean if a field has been set. + +### GetAttributeRequests + +`func (o *OriginalRequest) GetAttributeRequests() []AttributeRequest` + +GetAttributeRequests returns the AttributeRequests field if non-nil, zero value otherwise. + +### GetAttributeRequestsOk + +`func (o *OriginalRequest) GetAttributeRequestsOk() (*[]AttributeRequest, bool)` + +GetAttributeRequestsOk returns a tuple with the AttributeRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeRequests + +`func (o *OriginalRequest) SetAttributeRequests(v []AttributeRequest)` + +SetAttributeRequests sets AttributeRequests field to given value. + +### HasAttributeRequests + +`func (o *OriginalRequest) HasAttributeRequests() bool` + +HasAttributeRequests returns a boolean if a field has been set. + +### GetOp + +`func (o *OriginalRequest) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *OriginalRequest) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *OriginalRequest) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *OriginalRequest) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetSource + +`func (o *OriginalRequest) GetSource() AccountSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *OriginalRequest) GetSourceOk() (*AccountSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *OriginalRequest) SetSource(v AccountSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *OriginalRequest) HasSource() bool` + +HasSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/OrphanIdentitiesReportArguments.md b/docs/tools/sdk/go/Reference/V2024/Models/OrphanIdentitiesReportArguments.md new file mode 100644 index 000000000..de6e1218b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/OrphanIdentitiesReportArguments.md @@ -0,0 +1,64 @@ +--- +id: v2024-orphan-identities-report-arguments +title: OrphanIdentitiesReportArguments +pagination_label: OrphanIdentitiesReportArguments +sidebar_label: OrphanIdentitiesReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OrphanIdentitiesReportArguments', 'V2024OrphanIdentitiesReportArguments'] +slug: /tools/sdk/go/v2024/models/orphan-identities-report-arguments +tags: ['SDK', 'Software Development Kit', 'OrphanIdentitiesReportArguments', 'V2024OrphanIdentitiesReportArguments'] +--- + +# OrphanIdentitiesReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SelectedFormats** | Pointer to **[]string** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] + +## Methods + +### NewOrphanIdentitiesReportArguments + +`func NewOrphanIdentitiesReportArguments() *OrphanIdentitiesReportArguments` + +NewOrphanIdentitiesReportArguments instantiates a new OrphanIdentitiesReportArguments 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 + +### NewOrphanIdentitiesReportArgumentsWithDefaults + +`func NewOrphanIdentitiesReportArgumentsWithDefaults() *OrphanIdentitiesReportArguments` + +NewOrphanIdentitiesReportArgumentsWithDefaults instantiates a new OrphanIdentitiesReportArguments 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 + +### GetSelectedFormats + +`func (o *OrphanIdentitiesReportArguments) GetSelectedFormats() []string` + +GetSelectedFormats returns the SelectedFormats field if non-nil, zero value otherwise. + +### GetSelectedFormatsOk + +`func (o *OrphanIdentitiesReportArguments) GetSelectedFormatsOk() (*[]string, bool)` + +GetSelectedFormatsOk returns a tuple with the SelectedFormats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectedFormats + +`func (o *OrphanIdentitiesReportArguments) SetSelectedFormats(v []string)` + +SetSelectedFormats sets SelectedFormats field to given value. + +### HasSelectedFormats + +`func (o *OrphanIdentitiesReportArguments) HasSelectedFormats() bool` + +HasSelectedFormats returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Outlier.md b/docs/tools/sdk/go/Reference/V2024/Models/Outlier.md new file mode 100644 index 000000000..e5bbc2acc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Outlier.md @@ -0,0 +1,354 @@ +--- +id: v2024-outlier +title: Outlier +pagination_label: Outlier +sidebar_label: Outlier +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Outlier', 'V2024Outlier'] +slug: /tools/sdk/go/v2024/models/outlier +tags: ['SDK', 'Software Development Kit', 'Outlier', 'V2024Outlier'] +--- + +# Outlier + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity's unique identifier for the outlier record | [optional] +**IdentityId** | Pointer to **string** | The ID of the identity that is detected as an outlier | [optional] +**Type** | Pointer to **string** | The type of outlier summary | [optional] +**FirstDetectionDate** | Pointer to **SailPointTime** | The first date the outlier was detected | [optional] +**LatestDetectionDate** | Pointer to **SailPointTime** | The most recent date the outlier was detected | [optional] +**Ignored** | Pointer to **bool** | Flag whether or not the outlier has been ignored | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Object containing mapped identity attributes | [optional] +**Score** | Pointer to **float32** | The outlier score determined by the detection engine ranging from 0..1 | [optional] +**UnignoreType** | Pointer to **NullableString** | Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored | [optional] +**UnignoreDate** | Pointer to **NullableTime** | shows date when last time has been unignored outlier | [optional] +**IgnoreDate** | Pointer to **NullableTime** | shows date when last time has been ignored outlier | [optional] + +## Methods + +### NewOutlier + +`func NewOutlier() *Outlier` + +NewOutlier instantiates a new Outlier 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 + +### NewOutlierWithDefaults + +`func NewOutlierWithDefaults() *Outlier` + +NewOutlierWithDefaults instantiates a new Outlier 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 + +### GetId + +`func (o *Outlier) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Outlier) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Outlier) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Outlier) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *Outlier) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *Outlier) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *Outlier) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *Outlier) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetType + +`func (o *Outlier) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Outlier) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Outlier) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Outlier) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetFirstDetectionDate + +`func (o *Outlier) GetFirstDetectionDate() SailPointTime` + +GetFirstDetectionDate returns the FirstDetectionDate field if non-nil, zero value otherwise. + +### GetFirstDetectionDateOk + +`func (o *Outlier) GetFirstDetectionDateOk() (*SailPointTime, bool)` + +GetFirstDetectionDateOk returns a tuple with the FirstDetectionDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstDetectionDate + +`func (o *Outlier) SetFirstDetectionDate(v SailPointTime)` + +SetFirstDetectionDate sets FirstDetectionDate field to given value. + +### HasFirstDetectionDate + +`func (o *Outlier) HasFirstDetectionDate() bool` + +HasFirstDetectionDate returns a boolean if a field has been set. + +### GetLatestDetectionDate + +`func (o *Outlier) GetLatestDetectionDate() SailPointTime` + +GetLatestDetectionDate returns the LatestDetectionDate field if non-nil, zero value otherwise. + +### GetLatestDetectionDateOk + +`func (o *Outlier) GetLatestDetectionDateOk() (*SailPointTime, bool)` + +GetLatestDetectionDateOk returns a tuple with the LatestDetectionDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLatestDetectionDate + +`func (o *Outlier) SetLatestDetectionDate(v SailPointTime)` + +SetLatestDetectionDate sets LatestDetectionDate field to given value. + +### HasLatestDetectionDate + +`func (o *Outlier) HasLatestDetectionDate() bool` + +HasLatestDetectionDate returns a boolean if a field has been set. + +### GetIgnored + +`func (o *Outlier) GetIgnored() bool` + +GetIgnored returns the Ignored field if non-nil, zero value otherwise. + +### GetIgnoredOk + +`func (o *Outlier) GetIgnoredOk() (*bool, bool)` + +GetIgnoredOk returns a tuple with the Ignored field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIgnored + +`func (o *Outlier) SetIgnored(v bool)` + +SetIgnored sets Ignored field to given value. + +### HasIgnored + +`func (o *Outlier) HasIgnored() bool` + +HasIgnored returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Outlier) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Outlier) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Outlier) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Outlier) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetScore + +`func (o *Outlier) GetScore() float32` + +GetScore returns the Score field if non-nil, zero value otherwise. + +### GetScoreOk + +`func (o *Outlier) GetScoreOk() (*float32, bool)` + +GetScoreOk returns a tuple with the Score field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScore + +`func (o *Outlier) SetScore(v float32)` + +SetScore sets Score field to given value. + +### HasScore + +`func (o *Outlier) HasScore() bool` + +HasScore returns a boolean if a field has been set. + +### GetUnignoreType + +`func (o *Outlier) GetUnignoreType() string` + +GetUnignoreType returns the UnignoreType field if non-nil, zero value otherwise. + +### GetUnignoreTypeOk + +`func (o *Outlier) GetUnignoreTypeOk() (*string, bool)` + +GetUnignoreTypeOk returns a tuple with the UnignoreType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnignoreType + +`func (o *Outlier) SetUnignoreType(v string)` + +SetUnignoreType sets UnignoreType field to given value. + +### HasUnignoreType + +`func (o *Outlier) HasUnignoreType() bool` + +HasUnignoreType returns a boolean if a field has been set. + +### SetUnignoreTypeNil + +`func (o *Outlier) SetUnignoreTypeNil(b bool)` + + SetUnignoreTypeNil sets the value for UnignoreType to be an explicit nil + +### UnsetUnignoreType +`func (o *Outlier) UnsetUnignoreType()` + +UnsetUnignoreType ensures that no value is present for UnignoreType, not even an explicit nil +### GetUnignoreDate + +`func (o *Outlier) GetUnignoreDate() SailPointTime` + +GetUnignoreDate returns the UnignoreDate field if non-nil, zero value otherwise. + +### GetUnignoreDateOk + +`func (o *Outlier) GetUnignoreDateOk() (*SailPointTime, bool)` + +GetUnignoreDateOk returns a tuple with the UnignoreDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnignoreDate + +`func (o *Outlier) SetUnignoreDate(v SailPointTime)` + +SetUnignoreDate sets UnignoreDate field to given value. + +### HasUnignoreDate + +`func (o *Outlier) HasUnignoreDate() bool` + +HasUnignoreDate returns a boolean if a field has been set. + +### SetUnignoreDateNil + +`func (o *Outlier) SetUnignoreDateNil(b bool)` + + SetUnignoreDateNil sets the value for UnignoreDate to be an explicit nil + +### UnsetUnignoreDate +`func (o *Outlier) UnsetUnignoreDate()` + +UnsetUnignoreDate ensures that no value is present for UnignoreDate, not even an explicit nil +### GetIgnoreDate + +`func (o *Outlier) GetIgnoreDate() SailPointTime` + +GetIgnoreDate returns the IgnoreDate field if non-nil, zero value otherwise. + +### GetIgnoreDateOk + +`func (o *Outlier) GetIgnoreDateOk() (*SailPointTime, bool)` + +GetIgnoreDateOk returns a tuple with the IgnoreDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIgnoreDate + +`func (o *Outlier) SetIgnoreDate(v SailPointTime)` + +SetIgnoreDate sets IgnoreDate field to given value. + +### HasIgnoreDate + +`func (o *Outlier) HasIgnoreDate() bool` + +HasIgnoreDate returns a boolean if a field has been set. + +### SetIgnoreDateNil + +`func (o *Outlier) SetIgnoreDateNil(b bool)` + + SetIgnoreDateNil sets the value for IgnoreDate to be an explicit nil + +### UnsetIgnoreDate +`func (o *Outlier) UnsetIgnoreDate()` + +UnsetIgnoreDate ensures that no value is present for IgnoreDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/OutlierContributingFeature.md b/docs/tools/sdk/go/Reference/V2024/Models/OutlierContributingFeature.md new file mode 100644 index 000000000..ea27e2e0b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/OutlierContributingFeature.md @@ -0,0 +1,256 @@ +--- +id: v2024-outlier-contributing-feature +title: OutlierContributingFeature +pagination_label: OutlierContributingFeature +sidebar_label: OutlierContributingFeature +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierContributingFeature', 'V2024OutlierContributingFeature'] +slug: /tools/sdk/go/v2024/models/outlier-contributing-feature +tags: ['SDK', 'Software Development Kit', 'OutlierContributingFeature', 'V2024OutlierContributingFeature'] +--- + +# OutlierContributingFeature + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Contributing feature id | [optional] +**Name** | Pointer to **string** | The name of the feature | [optional] +**ValueType** | Pointer to [**OutlierValueType**](outlier-value-type) | | [optional] +**Value** | Pointer to **float32** | The feature value | [optional] +**Importance** | Pointer to **float32** | The importance of the feature. This can also be a negative value | [optional] +**DisplayName** | Pointer to **string** | The (translated if header is passed) displayName for the feature | [optional] +**Description** | Pointer to **string** | The (translated if header is passed) description for the feature | [optional] +**TranslationMessages** | Pointer to [**NullableOutlierFeatureTranslation**](outlier-feature-translation) | | [optional] + +## Methods + +### NewOutlierContributingFeature + +`func NewOutlierContributingFeature() *OutlierContributingFeature` + +NewOutlierContributingFeature instantiates a new OutlierContributingFeature 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 + +### NewOutlierContributingFeatureWithDefaults + +`func NewOutlierContributingFeatureWithDefaults() *OutlierContributingFeature` + +NewOutlierContributingFeatureWithDefaults instantiates a new OutlierContributingFeature 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 + +### GetId + +`func (o *OutlierContributingFeature) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OutlierContributingFeature) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OutlierContributingFeature) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OutlierContributingFeature) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OutlierContributingFeature) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OutlierContributingFeature) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OutlierContributingFeature) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OutlierContributingFeature) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValueType + +`func (o *OutlierContributingFeature) GetValueType() OutlierValueType` + +GetValueType returns the ValueType field if non-nil, zero value otherwise. + +### GetValueTypeOk + +`func (o *OutlierContributingFeature) GetValueTypeOk() (*OutlierValueType, bool)` + +GetValueTypeOk returns a tuple with the ValueType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValueType + +`func (o *OutlierContributingFeature) SetValueType(v OutlierValueType)` + +SetValueType sets ValueType field to given value. + +### HasValueType + +`func (o *OutlierContributingFeature) HasValueType() bool` + +HasValueType returns a boolean if a field has been set. + +### GetValue + +`func (o *OutlierContributingFeature) GetValue() float32` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *OutlierContributingFeature) GetValueOk() (*float32, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *OutlierContributingFeature) SetValue(v float32)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *OutlierContributingFeature) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetImportance + +`func (o *OutlierContributingFeature) GetImportance() float32` + +GetImportance returns the Importance field if non-nil, zero value otherwise. + +### GetImportanceOk + +`func (o *OutlierContributingFeature) GetImportanceOk() (*float32, bool)` + +GetImportanceOk returns a tuple with the Importance field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImportance + +`func (o *OutlierContributingFeature) SetImportance(v float32)` + +SetImportance sets Importance field to given value. + +### HasImportance + +`func (o *OutlierContributingFeature) HasImportance() bool` + +HasImportance returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *OutlierContributingFeature) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *OutlierContributingFeature) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *OutlierContributingFeature) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *OutlierContributingFeature) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *OutlierContributingFeature) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *OutlierContributingFeature) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *OutlierContributingFeature) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *OutlierContributingFeature) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetTranslationMessages + +`func (o *OutlierContributingFeature) GetTranslationMessages() OutlierFeatureTranslation` + +GetTranslationMessages returns the TranslationMessages field if non-nil, zero value otherwise. + +### GetTranslationMessagesOk + +`func (o *OutlierContributingFeature) GetTranslationMessagesOk() (*OutlierFeatureTranslation, bool)` + +GetTranslationMessagesOk returns a tuple with the TranslationMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslationMessages + +`func (o *OutlierContributingFeature) SetTranslationMessages(v OutlierFeatureTranslation)` + +SetTranslationMessages sets TranslationMessages field to given value. + +### HasTranslationMessages + +`func (o *OutlierContributingFeature) HasTranslationMessages() bool` + +HasTranslationMessages returns a boolean if a field has been set. + +### SetTranslationMessagesNil + +`func (o *OutlierContributingFeature) SetTranslationMessagesNil(b bool)` + + SetTranslationMessagesNil sets the value for TranslationMessages to be an explicit nil + +### UnsetTranslationMessages +`func (o *OutlierContributingFeature) UnsetTranslationMessages()` + +UnsetTranslationMessages ensures that no value is present for TranslationMessages, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/OutlierFeatureSummary.md b/docs/tools/sdk/go/Reference/V2024/Models/OutlierFeatureSummary.md new file mode 100644 index 000000000..a6ca2ae20 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/OutlierFeatureSummary.md @@ -0,0 +1,266 @@ +--- +id: v2024-outlier-feature-summary +title: OutlierFeatureSummary +pagination_label: OutlierFeatureSummary +sidebar_label: OutlierFeatureSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierFeatureSummary', 'V2024OutlierFeatureSummary'] +slug: /tools/sdk/go/v2024/models/outlier-feature-summary +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureSummary', 'V2024OutlierFeatureSummary'] +--- + +# OutlierFeatureSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContributingFeatureName** | Pointer to **string** | Contributing feature name | [optional] +**IdentityOutlierDisplayName** | Pointer to **string** | Identity display name | [optional] +**OutlierFeatureDisplayValues** | Pointer to [**[]OutlierFeatureSummaryOutlierFeatureDisplayValuesInner**](outlier-feature-summary-outlier-feature-display-values-inner) | | [optional] +**FeatureDefinition** | Pointer to **string** | Definition of the feature | [optional] +**FeatureExplanation** | Pointer to **string** | Detailed explanation of the feature | [optional] +**PeerDisplayName** | Pointer to **NullableString** | outlier's peer identity display name | [optional] +**PeerIdentityId** | Pointer to **NullableString** | outlier's peer identity id | [optional] +**AccessItemReference** | Pointer to **map[string]interface{}** | Access Item reference | [optional] + +## Methods + +### NewOutlierFeatureSummary + +`func NewOutlierFeatureSummary() *OutlierFeatureSummary` + +NewOutlierFeatureSummary instantiates a new OutlierFeatureSummary 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 + +### NewOutlierFeatureSummaryWithDefaults + +`func NewOutlierFeatureSummaryWithDefaults() *OutlierFeatureSummary` + +NewOutlierFeatureSummaryWithDefaults instantiates a new OutlierFeatureSummary 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 + +### GetContributingFeatureName + +`func (o *OutlierFeatureSummary) GetContributingFeatureName() string` + +GetContributingFeatureName returns the ContributingFeatureName field if non-nil, zero value otherwise. + +### GetContributingFeatureNameOk + +`func (o *OutlierFeatureSummary) GetContributingFeatureNameOk() (*string, bool)` + +GetContributingFeatureNameOk returns a tuple with the ContributingFeatureName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContributingFeatureName + +`func (o *OutlierFeatureSummary) SetContributingFeatureName(v string)` + +SetContributingFeatureName sets ContributingFeatureName field to given value. + +### HasContributingFeatureName + +`func (o *OutlierFeatureSummary) HasContributingFeatureName() bool` + +HasContributingFeatureName returns a boolean if a field has been set. + +### GetIdentityOutlierDisplayName + +`func (o *OutlierFeatureSummary) GetIdentityOutlierDisplayName() string` + +GetIdentityOutlierDisplayName returns the IdentityOutlierDisplayName field if non-nil, zero value otherwise. + +### GetIdentityOutlierDisplayNameOk + +`func (o *OutlierFeatureSummary) GetIdentityOutlierDisplayNameOk() (*string, bool)` + +GetIdentityOutlierDisplayNameOk returns a tuple with the IdentityOutlierDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityOutlierDisplayName + +`func (o *OutlierFeatureSummary) SetIdentityOutlierDisplayName(v string)` + +SetIdentityOutlierDisplayName sets IdentityOutlierDisplayName field to given value. + +### HasIdentityOutlierDisplayName + +`func (o *OutlierFeatureSummary) HasIdentityOutlierDisplayName() bool` + +HasIdentityOutlierDisplayName returns a boolean if a field has been set. + +### GetOutlierFeatureDisplayValues + +`func (o *OutlierFeatureSummary) GetOutlierFeatureDisplayValues() []OutlierFeatureSummaryOutlierFeatureDisplayValuesInner` + +GetOutlierFeatureDisplayValues returns the OutlierFeatureDisplayValues field if non-nil, zero value otherwise. + +### GetOutlierFeatureDisplayValuesOk + +`func (o *OutlierFeatureSummary) GetOutlierFeatureDisplayValuesOk() (*[]OutlierFeatureSummaryOutlierFeatureDisplayValuesInner, bool)` + +GetOutlierFeatureDisplayValuesOk returns a tuple with the OutlierFeatureDisplayValues field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutlierFeatureDisplayValues + +`func (o *OutlierFeatureSummary) SetOutlierFeatureDisplayValues(v []OutlierFeatureSummaryOutlierFeatureDisplayValuesInner)` + +SetOutlierFeatureDisplayValues sets OutlierFeatureDisplayValues field to given value. + +### HasOutlierFeatureDisplayValues + +`func (o *OutlierFeatureSummary) HasOutlierFeatureDisplayValues() bool` + +HasOutlierFeatureDisplayValues returns a boolean if a field has been set. + +### GetFeatureDefinition + +`func (o *OutlierFeatureSummary) GetFeatureDefinition() string` + +GetFeatureDefinition returns the FeatureDefinition field if non-nil, zero value otherwise. + +### GetFeatureDefinitionOk + +`func (o *OutlierFeatureSummary) GetFeatureDefinitionOk() (*string, bool)` + +GetFeatureDefinitionOk returns a tuple with the FeatureDefinition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureDefinition + +`func (o *OutlierFeatureSummary) SetFeatureDefinition(v string)` + +SetFeatureDefinition sets FeatureDefinition field to given value. + +### HasFeatureDefinition + +`func (o *OutlierFeatureSummary) HasFeatureDefinition() bool` + +HasFeatureDefinition returns a boolean if a field has been set. + +### GetFeatureExplanation + +`func (o *OutlierFeatureSummary) GetFeatureExplanation() string` + +GetFeatureExplanation returns the FeatureExplanation field if non-nil, zero value otherwise. + +### GetFeatureExplanationOk + +`func (o *OutlierFeatureSummary) GetFeatureExplanationOk() (*string, bool)` + +GetFeatureExplanationOk returns a tuple with the FeatureExplanation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureExplanation + +`func (o *OutlierFeatureSummary) SetFeatureExplanation(v string)` + +SetFeatureExplanation sets FeatureExplanation field to given value. + +### HasFeatureExplanation + +`func (o *OutlierFeatureSummary) HasFeatureExplanation() bool` + +HasFeatureExplanation returns a boolean if a field has been set. + +### GetPeerDisplayName + +`func (o *OutlierFeatureSummary) GetPeerDisplayName() string` + +GetPeerDisplayName returns the PeerDisplayName field if non-nil, zero value otherwise. + +### GetPeerDisplayNameOk + +`func (o *OutlierFeatureSummary) GetPeerDisplayNameOk() (*string, bool)` + +GetPeerDisplayNameOk returns a tuple with the PeerDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPeerDisplayName + +`func (o *OutlierFeatureSummary) SetPeerDisplayName(v string)` + +SetPeerDisplayName sets PeerDisplayName field to given value. + +### HasPeerDisplayName + +`func (o *OutlierFeatureSummary) HasPeerDisplayName() bool` + +HasPeerDisplayName returns a boolean if a field has been set. + +### SetPeerDisplayNameNil + +`func (o *OutlierFeatureSummary) SetPeerDisplayNameNil(b bool)` + + SetPeerDisplayNameNil sets the value for PeerDisplayName to be an explicit nil + +### UnsetPeerDisplayName +`func (o *OutlierFeatureSummary) UnsetPeerDisplayName()` + +UnsetPeerDisplayName ensures that no value is present for PeerDisplayName, not even an explicit nil +### GetPeerIdentityId + +`func (o *OutlierFeatureSummary) GetPeerIdentityId() string` + +GetPeerIdentityId returns the PeerIdentityId field if non-nil, zero value otherwise. + +### GetPeerIdentityIdOk + +`func (o *OutlierFeatureSummary) GetPeerIdentityIdOk() (*string, bool)` + +GetPeerIdentityIdOk returns a tuple with the PeerIdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPeerIdentityId + +`func (o *OutlierFeatureSummary) SetPeerIdentityId(v string)` + +SetPeerIdentityId sets PeerIdentityId field to given value. + +### HasPeerIdentityId + +`func (o *OutlierFeatureSummary) HasPeerIdentityId() bool` + +HasPeerIdentityId returns a boolean if a field has been set. + +### SetPeerIdentityIdNil + +`func (o *OutlierFeatureSummary) SetPeerIdentityIdNil(b bool)` + + SetPeerIdentityIdNil sets the value for PeerIdentityId to be an explicit nil + +### UnsetPeerIdentityId +`func (o *OutlierFeatureSummary) UnsetPeerIdentityId()` + +UnsetPeerIdentityId ensures that no value is present for PeerIdentityId, not even an explicit nil +### GetAccessItemReference + +`func (o *OutlierFeatureSummary) GetAccessItemReference() map[string]interface{}` + +GetAccessItemReference returns the AccessItemReference field if non-nil, zero value otherwise. + +### GetAccessItemReferenceOk + +`func (o *OutlierFeatureSummary) GetAccessItemReferenceOk() (*map[string]interface{}, bool)` + +GetAccessItemReferenceOk returns a tuple with the AccessItemReference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItemReference + +`func (o *OutlierFeatureSummary) SetAccessItemReference(v map[string]interface{})` + +SetAccessItemReference sets AccessItemReference field to given value. + +### HasAccessItemReference + +`func (o *OutlierFeatureSummary) HasAccessItemReference() bool` + +HasAccessItemReference returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md b/docs/tools/sdk/go/Reference/V2024/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md new file mode 100644 index 000000000..7154b52a7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md @@ -0,0 +1,116 @@ +--- +id: v2024-outlier-feature-summary-outlier-feature-display-values-inner +title: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +pagination_label: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +sidebar_label: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierFeatureSummaryOutlierFeatureDisplayValuesInner', 'V2024OutlierFeatureSummaryOutlierFeatureDisplayValuesInner'] +slug: /tools/sdk/go/v2024/models/outlier-feature-summary-outlier-feature-display-values-inner +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureSummaryOutlierFeatureDisplayValuesInner', 'V2024OutlierFeatureSummaryOutlierFeatureDisplayValuesInner'] +--- + +# OutlierFeatureSummaryOutlierFeatureDisplayValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayName** | Pointer to **string** | display name | [optional] +**Value** | Pointer to **string** | value | [optional] +**ValueType** | Pointer to [**OutlierValueType**](outlier-value-type) | | [optional] + +## Methods + +### NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInner + +`func NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInner() *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner` + +NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInner instantiates a new OutlierFeatureSummaryOutlierFeatureDisplayValuesInner 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 + +### NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInnerWithDefaults + +`func NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInnerWithDefaults() *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner` + +NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInnerWithDefaults instantiates a new OutlierFeatureSummaryOutlierFeatureDisplayValuesInner 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 + +### GetDisplayName + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetValue + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetValueType + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetValueType() OutlierValueType` + +GetValueType returns the ValueType field if non-nil, zero value otherwise. + +### GetValueTypeOk + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetValueTypeOk() (*OutlierValueType, bool)` + +GetValueTypeOk returns a tuple with the ValueType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValueType + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) SetValueType(v OutlierValueType)` + +SetValueType sets ValueType field to given value. + +### HasValueType + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) HasValueType() bool` + +HasValueType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/OutlierFeatureTranslation.md b/docs/tools/sdk/go/Reference/V2024/Models/OutlierFeatureTranslation.md new file mode 100644 index 000000000..80d507e32 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/OutlierFeatureTranslation.md @@ -0,0 +1,90 @@ +--- +id: v2024-outlier-feature-translation +title: OutlierFeatureTranslation +pagination_label: OutlierFeatureTranslation +sidebar_label: OutlierFeatureTranslation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierFeatureTranslation', 'V2024OutlierFeatureTranslation'] +slug: /tools/sdk/go/v2024/models/outlier-feature-translation +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureTranslation', 'V2024OutlierFeatureTranslation'] +--- + +# OutlierFeatureTranslation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayName** | Pointer to [**TranslationMessage**](translation-message) | | [optional] +**Description** | Pointer to [**TranslationMessage**](translation-message) | | [optional] + +## Methods + +### NewOutlierFeatureTranslation + +`func NewOutlierFeatureTranslation() *OutlierFeatureTranslation` + +NewOutlierFeatureTranslation instantiates a new OutlierFeatureTranslation 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 + +### NewOutlierFeatureTranslationWithDefaults + +`func NewOutlierFeatureTranslationWithDefaults() *OutlierFeatureTranslation` + +NewOutlierFeatureTranslationWithDefaults instantiates a new OutlierFeatureTranslation 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 + +### GetDisplayName + +`func (o *OutlierFeatureTranslation) GetDisplayName() TranslationMessage` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *OutlierFeatureTranslation) GetDisplayNameOk() (*TranslationMessage, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *OutlierFeatureTranslation) SetDisplayName(v TranslationMessage)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *OutlierFeatureTranslation) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *OutlierFeatureTranslation) GetDescription() TranslationMessage` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *OutlierFeatureTranslation) GetDescriptionOk() (*TranslationMessage, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *OutlierFeatureTranslation) SetDescription(v TranslationMessage)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *OutlierFeatureTranslation) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/OutlierSummary.md b/docs/tools/sdk/go/Reference/V2024/Models/OutlierSummary.md new file mode 100644 index 000000000..f2da60212 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/OutlierSummary.md @@ -0,0 +1,168 @@ +--- +id: v2024-outlier-summary +title: OutlierSummary +pagination_label: OutlierSummary +sidebar_label: OutlierSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierSummary', 'V2024OutlierSummary'] +slug: /tools/sdk/go/v2024/models/outlier-summary +tags: ['SDK', 'Software Development Kit', 'OutlierSummary', 'V2024OutlierSummary'] +--- + +# OutlierSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of outlier summary | [optional] +**SnapshotDate** | Pointer to **SailPointTime** | The date the bulk outlier detection ran/snapshot was created | [optional] +**TotalOutliers** | Pointer to **int32** | Total number of outliers for the customer making the request | [optional] +**TotalIdentities** | Pointer to **int32** | Total number of identities for the customer making the request | [optional] +**TotalIgnored** | Pointer to **int32** | | [optional] [default to 0] + +## Methods + +### NewOutlierSummary + +`func NewOutlierSummary() *OutlierSummary` + +NewOutlierSummary instantiates a new OutlierSummary 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 + +### NewOutlierSummaryWithDefaults + +`func NewOutlierSummaryWithDefaults() *OutlierSummary` + +NewOutlierSummaryWithDefaults instantiates a new OutlierSummary 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 + +### GetType + +`func (o *OutlierSummary) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OutlierSummary) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OutlierSummary) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OutlierSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSnapshotDate + +`func (o *OutlierSummary) GetSnapshotDate() SailPointTime` + +GetSnapshotDate returns the SnapshotDate field if non-nil, zero value otherwise. + +### GetSnapshotDateOk + +`func (o *OutlierSummary) GetSnapshotDateOk() (*SailPointTime, bool)` + +GetSnapshotDateOk returns a tuple with the SnapshotDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotDate + +`func (o *OutlierSummary) SetSnapshotDate(v SailPointTime)` + +SetSnapshotDate sets SnapshotDate field to given value. + +### HasSnapshotDate + +`func (o *OutlierSummary) HasSnapshotDate() bool` + +HasSnapshotDate returns a boolean if a field has been set. + +### GetTotalOutliers + +`func (o *OutlierSummary) GetTotalOutliers() int32` + +GetTotalOutliers returns the TotalOutliers field if non-nil, zero value otherwise. + +### GetTotalOutliersOk + +`func (o *OutlierSummary) GetTotalOutliersOk() (*int32, bool)` + +GetTotalOutliersOk returns a tuple with the TotalOutliers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalOutliers + +`func (o *OutlierSummary) SetTotalOutliers(v int32)` + +SetTotalOutliers sets TotalOutliers field to given value. + +### HasTotalOutliers + +`func (o *OutlierSummary) HasTotalOutliers() bool` + +HasTotalOutliers returns a boolean if a field has been set. + +### GetTotalIdentities + +`func (o *OutlierSummary) GetTotalIdentities() int32` + +GetTotalIdentities returns the TotalIdentities field if non-nil, zero value otherwise. + +### GetTotalIdentitiesOk + +`func (o *OutlierSummary) 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 *OutlierSummary) SetTotalIdentities(v int32)` + +SetTotalIdentities sets TotalIdentities field to given value. + +### HasTotalIdentities + +`func (o *OutlierSummary) HasTotalIdentities() bool` + +HasTotalIdentities returns a boolean if a field has been set. + +### GetTotalIgnored + +`func (o *OutlierSummary) GetTotalIgnored() int32` + +GetTotalIgnored returns the TotalIgnored field if non-nil, zero value otherwise. + +### GetTotalIgnoredOk + +`func (o *OutlierSummary) GetTotalIgnoredOk() (*int32, bool)` + +GetTotalIgnoredOk returns a tuple with the TotalIgnored field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalIgnored + +`func (o *OutlierSummary) SetTotalIgnored(v int32)` + +SetTotalIgnored sets TotalIgnored field to given value. + +### HasTotalIgnored + +`func (o *OutlierSummary) HasTotalIgnored() bool` + +HasTotalIgnored returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/OutlierValueType.md b/docs/tools/sdk/go/Reference/V2024/Models/OutlierValueType.md new file mode 100644 index 000000000..bd60a5976 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/OutlierValueType.md @@ -0,0 +1,90 @@ +--- +id: v2024-outlier-value-type +title: OutlierValueType +pagination_label: OutlierValueType +sidebar_label: OutlierValueType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierValueType', 'V2024OutlierValueType'] +slug: /tools/sdk/go/v2024/models/outlier-value-type +tags: ['SDK', 'Software Development Kit', 'OutlierValueType', 'V2024OutlierValueType'] +--- + +# OutlierValueType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The data type of the value field | [optional] +**Ordinal** | Pointer to **int32** | The position of the value type | [optional] + +## Methods + +### NewOutlierValueType + +`func NewOutlierValueType() *OutlierValueType` + +NewOutlierValueType instantiates a new OutlierValueType 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 + +### NewOutlierValueTypeWithDefaults + +`func NewOutlierValueTypeWithDefaults() *OutlierValueType` + +NewOutlierValueTypeWithDefaults instantiates a new OutlierValueType 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 + +### GetName + +`func (o *OutlierValueType) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OutlierValueType) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OutlierValueType) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OutlierValueType) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOrdinal + +`func (o *OutlierValueType) GetOrdinal() int32` + +GetOrdinal returns the Ordinal field if non-nil, zero value otherwise. + +### GetOrdinalOk + +`func (o *OutlierValueType) GetOrdinalOk() (*int32, bool)` + +GetOrdinalOk returns a tuple with the Ordinal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrdinal + +`func (o *OutlierValueType) SetOrdinal(v int32)` + +SetOrdinal sets Ordinal field to given value. + +### HasOrdinal + +`func (o *OutlierValueType) HasOrdinal() bool` + +HasOrdinal returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/OutliersContributingFeatureAccessItems.md b/docs/tools/sdk/go/Reference/V2024/Models/OutliersContributingFeatureAccessItems.md new file mode 100644 index 000000000..ddb651d6d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/OutliersContributingFeatureAccessItems.md @@ -0,0 +1,204 @@ +--- +id: v2024-outliers-contributing-feature-access-items +title: OutliersContributingFeatureAccessItems +pagination_label: OutliersContributingFeatureAccessItems +sidebar_label: OutliersContributingFeatureAccessItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutliersContributingFeatureAccessItems', 'V2024OutliersContributingFeatureAccessItems'] +slug: /tools/sdk/go/v2024/models/outliers-contributing-feature-access-items +tags: ['SDK', 'Software Development Kit', 'OutliersContributingFeatureAccessItems', 'V2024OutliersContributingFeatureAccessItems'] +--- + +# OutliersContributingFeatureAccessItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the access item | [optional] +**DisplayName** | Pointer to **string** | the display name of the access item | [optional] +**Description** | Pointer to **NullableString** | Description of the access item. | [optional] +**AccessType** | Pointer to **string** | The type of the access item. | [optional] +**SourceName** | Pointer to **string** | the associated source name if it exists | [optional] +**ExtremelyRare** | Pointer to **bool** | rarest access | [optional] [default to false] + +## Methods + +### NewOutliersContributingFeatureAccessItems + +`func NewOutliersContributingFeatureAccessItems() *OutliersContributingFeatureAccessItems` + +NewOutliersContributingFeatureAccessItems instantiates a new OutliersContributingFeatureAccessItems 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 + +### NewOutliersContributingFeatureAccessItemsWithDefaults + +`func NewOutliersContributingFeatureAccessItemsWithDefaults() *OutliersContributingFeatureAccessItems` + +NewOutliersContributingFeatureAccessItemsWithDefaults instantiates a new OutliersContributingFeatureAccessItems 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 + +### GetId + +`func (o *OutliersContributingFeatureAccessItems) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OutliersContributingFeatureAccessItems) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OutliersContributingFeatureAccessItems) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OutliersContributingFeatureAccessItems) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *OutliersContributingFeatureAccessItems) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *OutliersContributingFeatureAccessItems) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *OutliersContributingFeatureAccessItems) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *OutliersContributingFeatureAccessItems) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *OutliersContributingFeatureAccessItems) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *OutliersContributingFeatureAccessItems) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *OutliersContributingFeatureAccessItems) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *OutliersContributingFeatureAccessItems) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *OutliersContributingFeatureAccessItems) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *OutliersContributingFeatureAccessItems) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAccessType + +`func (o *OutliersContributingFeatureAccessItems) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *OutliersContributingFeatureAccessItems) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *OutliersContributingFeatureAccessItems) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *OutliersContributingFeatureAccessItems) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetSourceName + +`func (o *OutliersContributingFeatureAccessItems) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *OutliersContributingFeatureAccessItems) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *OutliersContributingFeatureAccessItems) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *OutliersContributingFeatureAccessItems) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetExtremelyRare + +`func (o *OutliersContributingFeatureAccessItems) GetExtremelyRare() bool` + +GetExtremelyRare returns the ExtremelyRare field if non-nil, zero value otherwise. + +### GetExtremelyRareOk + +`func (o *OutliersContributingFeatureAccessItems) GetExtremelyRareOk() (*bool, bool)` + +GetExtremelyRareOk returns a tuple with the ExtremelyRare field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExtremelyRare + +`func (o *OutliersContributingFeatureAccessItems) SetExtremelyRare(v bool)` + +SetExtremelyRare sets ExtremelyRare field to given value. + +### HasExtremelyRare + +`func (o *OutliersContributingFeatureAccessItems) HasExtremelyRare() bool` + +HasExtremelyRare returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/OwnerDto.md b/docs/tools/sdk/go/Reference/V2024/Models/OwnerDto.md new file mode 100644 index 000000000..58f7c2326 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/OwnerDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-owner-dto +title: OwnerDto +pagination_label: OwnerDto +sidebar_label: OwnerDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OwnerDto', 'V2024OwnerDto'] +slug: /tools/sdk/go/v2024/models/owner-dto +tags: ['SDK', 'Software Development Kit', 'OwnerDto', 'V2024OwnerDto'] +--- + +# OwnerDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's DTO type. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] + +## Methods + +### NewOwnerDto + +`func NewOwnerDto() *OwnerDto` + +NewOwnerDto instantiates a new OwnerDto 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 + +### NewOwnerDtoWithDefaults + +`func NewOwnerDtoWithDefaults() *OwnerDto` + +NewOwnerDtoWithDefaults instantiates a new OwnerDto 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 + +### GetType + +`func (o *OwnerDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OwnerDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OwnerDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OwnerDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *OwnerDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OwnerDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OwnerDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OwnerDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OwnerDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OwnerDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OwnerDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OwnerDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/OwnerReference.md b/docs/tools/sdk/go/Reference/V2024/Models/OwnerReference.md new file mode 100644 index 000000000..426475403 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/OwnerReference.md @@ -0,0 +1,116 @@ +--- +id: v2024-owner-reference +title: OwnerReference +pagination_label: OwnerReference +sidebar_label: OwnerReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OwnerReference', 'V2024OwnerReference'] +slug: /tools/sdk/go/v2024/models/owner-reference +tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'V2024OwnerReference'] +--- + +# OwnerReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] + +## Methods + +### NewOwnerReference + +`func NewOwnerReference() *OwnerReference` + +NewOwnerReference instantiates a new OwnerReference 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 + +### NewOwnerReferenceWithDefaults + +`func NewOwnerReferenceWithDefaults() *OwnerReference` + +NewOwnerReferenceWithDefaults instantiates a new OwnerReference 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 + +### GetType + +`func (o *OwnerReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OwnerReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OwnerReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OwnerReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *OwnerReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OwnerReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OwnerReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OwnerReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OwnerReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OwnerReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OwnerReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OwnerReference) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/OwnerReferenceSegments.md b/docs/tools/sdk/go/Reference/V2024/Models/OwnerReferenceSegments.md new file mode 100644 index 000000000..130f2f279 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/OwnerReferenceSegments.md @@ -0,0 +1,116 @@ +--- +id: v2024-owner-reference-segments +title: OwnerReferenceSegments +pagination_label: OwnerReferenceSegments +sidebar_label: OwnerReferenceSegments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OwnerReferenceSegments', 'V2024OwnerReferenceSegments'] +slug: /tools/sdk/go/v2024/models/owner-reference-segments +tags: ['SDK', 'Software Development Kit', 'OwnerReferenceSegments', 'V2024OwnerReferenceSegments'] +--- + +# OwnerReferenceSegments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**Id** | Pointer to **string** | Identity id | [optional] +**Name** | Pointer to **string** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] + +## Methods + +### NewOwnerReferenceSegments + +`func NewOwnerReferenceSegments() *OwnerReferenceSegments` + +NewOwnerReferenceSegments instantiates a new OwnerReferenceSegments 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 + +### NewOwnerReferenceSegmentsWithDefaults + +`func NewOwnerReferenceSegmentsWithDefaults() *OwnerReferenceSegments` + +NewOwnerReferenceSegmentsWithDefaults instantiates a new OwnerReferenceSegments 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 + +### GetType + +`func (o *OwnerReferenceSegments) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OwnerReferenceSegments) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OwnerReferenceSegments) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OwnerReferenceSegments) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *OwnerReferenceSegments) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OwnerReferenceSegments) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OwnerReferenceSegments) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OwnerReferenceSegments) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OwnerReferenceSegments) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OwnerReferenceSegments) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OwnerReferenceSegments) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OwnerReferenceSegments) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Owns.md b/docs/tools/sdk/go/Reference/V2024/Models/Owns.md new file mode 100644 index 000000000..24b4b90da --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Owns.md @@ -0,0 +1,220 @@ +--- +id: v2024-owns +title: Owns +pagination_label: Owns +sidebar_label: Owns +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Owns', 'V2024Owns'] +slug: /tools/sdk/go/v2024/models/owns +tags: ['SDK', 'Software Development Kit', 'Owns', 'V2024Owns'] +--- + +# Owns + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Sources** | Pointer to [**[]Reference**](reference) | | [optional] +**Entitlements** | Pointer to [**[]Reference**](reference) | | [optional] +**AccessProfiles** | Pointer to [**[]Reference**](reference) | | [optional] +**Roles** | Pointer to [**[]Reference**](reference) | | [optional] +**Apps** | Pointer to [**[]Reference**](reference) | | [optional] +**GovernanceGroups** | Pointer to [**[]Reference**](reference) | | [optional] +**FallbackApprover** | Pointer to **bool** | | [optional] + +## Methods + +### NewOwns + +`func NewOwns() *Owns` + +NewOwns instantiates a new Owns 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 + +### NewOwnsWithDefaults + +`func NewOwnsWithDefaults() *Owns` + +NewOwnsWithDefaults instantiates a new Owns 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 + +### GetSources + +`func (o *Owns) GetSources() []Reference` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *Owns) GetSourcesOk() (*[]Reference, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *Owns) SetSources(v []Reference)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *Owns) HasSources() bool` + +HasSources returns a boolean if a field has been set. + +### GetEntitlements + +`func (o *Owns) GetEntitlements() []Reference` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *Owns) GetEntitlementsOk() (*[]Reference, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *Owns) SetEntitlements(v []Reference)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *Owns) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetAccessProfiles + +`func (o *Owns) GetAccessProfiles() []Reference` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *Owns) GetAccessProfilesOk() (*[]Reference, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *Owns) SetAccessProfiles(v []Reference)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *Owns) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### GetRoles + +`func (o *Owns) GetRoles() []Reference` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *Owns) GetRolesOk() (*[]Reference, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *Owns) SetRoles(v []Reference)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *Owns) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + +### GetApps + +`func (o *Owns) GetApps() []Reference` + +GetApps returns the Apps field if non-nil, zero value otherwise. + +### GetAppsOk + +`func (o *Owns) GetAppsOk() (*[]Reference, bool)` + +GetAppsOk returns a tuple with the Apps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApps + +`func (o *Owns) SetApps(v []Reference)` + +SetApps sets Apps field to given value. + +### HasApps + +`func (o *Owns) HasApps() bool` + +HasApps returns a boolean if a field has been set. + +### GetGovernanceGroups + +`func (o *Owns) GetGovernanceGroups() []Reference` + +GetGovernanceGroups returns the GovernanceGroups field if non-nil, zero value otherwise. + +### GetGovernanceGroupsOk + +`func (o *Owns) GetGovernanceGroupsOk() (*[]Reference, bool)` + +GetGovernanceGroupsOk returns a tuple with the GovernanceGroups field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceGroups + +`func (o *Owns) SetGovernanceGroups(v []Reference)` + +SetGovernanceGroups sets GovernanceGroups field to given value. + +### HasGovernanceGroups + +`func (o *Owns) HasGovernanceGroups() bool` + +HasGovernanceGroups returns a boolean if a field has been set. + +### GetFallbackApprover + +`func (o *Owns) GetFallbackApprover() bool` + +GetFallbackApprover returns the FallbackApprover field if non-nil, zero value otherwise. + +### GetFallbackApproverOk + +`func (o *Owns) GetFallbackApproverOk() (*bool, bool)` + +GetFallbackApproverOk returns a tuple with the FallbackApprover field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFallbackApprover + +`func (o *Owns) SetFallbackApprover(v bool)` + +SetFallbackApprover sets FallbackApprover field to given value. + +### HasFallbackApprover + +`func (o *Owns) HasFallbackApprover() bool` + +HasFallbackApprover returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PasswordChangeRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/PasswordChangeRequest.md new file mode 100644 index 000000000..015b62882 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PasswordChangeRequest.md @@ -0,0 +1,168 @@ +--- +id: v2024-password-change-request +title: PasswordChangeRequest +pagination_label: PasswordChangeRequest +sidebar_label: PasswordChangeRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordChangeRequest', 'V2024PasswordChangeRequest'] +slug: /tools/sdk/go/v2024/models/password-change-request +tags: ['SDK', 'Software Development Kit', 'PasswordChangeRequest', 'V2024PasswordChangeRequest'] +--- + +# PasswordChangeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | The identity ID that requested the password change | [optional] +**EncryptedPassword** | Pointer to **string** | The RSA encrypted password | [optional] +**PublicKeyId** | Pointer to **string** | The encryption key ID | [optional] +**AccountId** | Pointer to **string** | Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**SourceId** | Pointer to **string** | The ID of the source for which identity is requesting the password change | [optional] + +## Methods + +### NewPasswordChangeRequest + +`func NewPasswordChangeRequest() *PasswordChangeRequest` + +NewPasswordChangeRequest instantiates a new PasswordChangeRequest 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 + +### NewPasswordChangeRequestWithDefaults + +`func NewPasswordChangeRequestWithDefaults() *PasswordChangeRequest` + +NewPasswordChangeRequestWithDefaults instantiates a new PasswordChangeRequest 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 + +### GetIdentityId + +`func (o *PasswordChangeRequest) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *PasswordChangeRequest) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *PasswordChangeRequest) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *PasswordChangeRequest) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEncryptedPassword + +`func (o *PasswordChangeRequest) GetEncryptedPassword() string` + +GetEncryptedPassword returns the EncryptedPassword field if non-nil, zero value otherwise. + +### GetEncryptedPasswordOk + +`func (o *PasswordChangeRequest) GetEncryptedPasswordOk() (*string, bool)` + +GetEncryptedPasswordOk returns a tuple with the EncryptedPassword field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEncryptedPassword + +`func (o *PasswordChangeRequest) SetEncryptedPassword(v string)` + +SetEncryptedPassword sets EncryptedPassword field to given value. + +### HasEncryptedPassword + +`func (o *PasswordChangeRequest) HasEncryptedPassword() bool` + +HasEncryptedPassword returns a boolean if a field has been set. + +### GetPublicKeyId + +`func (o *PasswordChangeRequest) GetPublicKeyId() string` + +GetPublicKeyId returns the PublicKeyId field if non-nil, zero value otherwise. + +### GetPublicKeyIdOk + +`func (o *PasswordChangeRequest) GetPublicKeyIdOk() (*string, bool)` + +GetPublicKeyIdOk returns a tuple with the PublicKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyId + +`func (o *PasswordChangeRequest) SetPublicKeyId(v string)` + +SetPublicKeyId sets PublicKeyId field to given value. + +### HasPublicKeyId + +`func (o *PasswordChangeRequest) HasPublicKeyId() bool` + +HasPublicKeyId returns a boolean if a field has been set. + +### GetAccountId + +`func (o *PasswordChangeRequest) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *PasswordChangeRequest) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *PasswordChangeRequest) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *PasswordChangeRequest) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *PasswordChangeRequest) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *PasswordChangeRequest) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *PasswordChangeRequest) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *PasswordChangeRequest) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PasswordChangeResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/PasswordChangeResponse.md new file mode 100644 index 000000000..48dc780da --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PasswordChangeResponse.md @@ -0,0 +1,100 @@ +--- +id: v2024-password-change-response +title: PasswordChangeResponse +pagination_label: PasswordChangeResponse +sidebar_label: PasswordChangeResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordChangeResponse', 'V2024PasswordChangeResponse'] +slug: /tools/sdk/go/v2024/models/password-change-response +tags: ['SDK', 'Software Development Kit', 'PasswordChangeResponse', 'V2024PasswordChangeResponse'] +--- + +# PasswordChangeResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **NullableString** | The password change request ID | [optional] +**State** | Pointer to **string** | Password change state | [optional] + +## Methods + +### NewPasswordChangeResponse + +`func NewPasswordChangeResponse() *PasswordChangeResponse` + +NewPasswordChangeResponse instantiates a new PasswordChangeResponse 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 + +### NewPasswordChangeResponseWithDefaults + +`func NewPasswordChangeResponseWithDefaults() *PasswordChangeResponse` + +NewPasswordChangeResponseWithDefaults instantiates a new PasswordChangeResponse 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 + +### GetRequestId + +`func (o *PasswordChangeResponse) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *PasswordChangeResponse) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *PasswordChangeResponse) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *PasswordChangeResponse) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *PasswordChangeResponse) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *PasswordChangeResponse) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetState + +`func (o *PasswordChangeResponse) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *PasswordChangeResponse) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *PasswordChangeResponse) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *PasswordChangeResponse) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PasswordDigitToken.md b/docs/tools/sdk/go/Reference/V2024/Models/PasswordDigitToken.md new file mode 100644 index 000000000..d92b20219 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PasswordDigitToken.md @@ -0,0 +1,90 @@ +--- +id: v2024-password-digit-token +title: PasswordDigitToken +pagination_label: PasswordDigitToken +sidebar_label: PasswordDigitToken +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordDigitToken', 'V2024PasswordDigitToken'] +slug: /tools/sdk/go/v2024/models/password-digit-token +tags: ['SDK', 'Software Development Kit', 'PasswordDigitToken', 'V2024PasswordDigitToken'] +--- + +# PasswordDigitToken + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DigitToken** | Pointer to **string** | The digit token for password management | [optional] +**RequestId** | Pointer to **string** | The reference ID of the digit token generation request | [optional] + +## Methods + +### NewPasswordDigitToken + +`func NewPasswordDigitToken() *PasswordDigitToken` + +NewPasswordDigitToken instantiates a new PasswordDigitToken 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 + +### NewPasswordDigitTokenWithDefaults + +`func NewPasswordDigitTokenWithDefaults() *PasswordDigitToken` + +NewPasswordDigitTokenWithDefaults instantiates a new PasswordDigitToken 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 + +### GetDigitToken + +`func (o *PasswordDigitToken) GetDigitToken() string` + +GetDigitToken returns the DigitToken field if non-nil, zero value otherwise. + +### GetDigitTokenOk + +`func (o *PasswordDigitToken) GetDigitTokenOk() (*string, bool)` + +GetDigitTokenOk returns a tuple with the DigitToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDigitToken + +`func (o *PasswordDigitToken) SetDigitToken(v string)` + +SetDigitToken sets DigitToken field to given value. + +### HasDigitToken + +`func (o *PasswordDigitToken) HasDigitToken() bool` + +HasDigitToken returns a boolean if a field has been set. + +### GetRequestId + +`func (o *PasswordDigitToken) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *PasswordDigitToken) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *PasswordDigitToken) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *PasswordDigitToken) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PasswordDigitTokenReset.md b/docs/tools/sdk/go/Reference/V2024/Models/PasswordDigitTokenReset.md new file mode 100644 index 000000000..e5ba5e682 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PasswordDigitTokenReset.md @@ -0,0 +1,111 @@ +--- +id: v2024-password-digit-token-reset +title: PasswordDigitTokenReset +pagination_label: PasswordDigitTokenReset +sidebar_label: PasswordDigitTokenReset +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordDigitTokenReset', 'V2024PasswordDigitTokenReset'] +slug: /tools/sdk/go/v2024/models/password-digit-token-reset +tags: ['SDK', 'Software Development Kit', 'PasswordDigitTokenReset', 'V2024PasswordDigitTokenReset'] +--- + +# PasswordDigitTokenReset + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **string** | The uid of the user requested for digit token | +**Length** | Pointer to **int32** | The length of digit token. It should be from 6 to 18, inclusive. The default value is 6. | [optional] +**DurationMinutes** | Pointer to **int32** | The time to live for the digit token in minutes. The default value is 5 minutes. | [optional] + +## Methods + +### NewPasswordDigitTokenReset + +`func NewPasswordDigitTokenReset(userId string, ) *PasswordDigitTokenReset` + +NewPasswordDigitTokenReset instantiates a new PasswordDigitTokenReset 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 + +### NewPasswordDigitTokenResetWithDefaults + +`func NewPasswordDigitTokenResetWithDefaults() *PasswordDigitTokenReset` + +NewPasswordDigitTokenResetWithDefaults instantiates a new PasswordDigitTokenReset 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 + +### GetUserId + +`func (o *PasswordDigitTokenReset) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *PasswordDigitTokenReset) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *PasswordDigitTokenReset) SetUserId(v string)` + +SetUserId sets UserId field to given value. + + +### GetLength + +`func (o *PasswordDigitTokenReset) GetLength() int32` + +GetLength returns the Length field if non-nil, zero value otherwise. + +### GetLengthOk + +`func (o *PasswordDigitTokenReset) GetLengthOk() (*int32, bool)` + +GetLengthOk returns a tuple with the Length field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLength + +`func (o *PasswordDigitTokenReset) SetLength(v int32)` + +SetLength sets Length field to given value. + +### HasLength + +`func (o *PasswordDigitTokenReset) HasLength() bool` + +HasLength returns a boolean if a field has been set. + +### GetDurationMinutes + +`func (o *PasswordDigitTokenReset) GetDurationMinutes() int32` + +GetDurationMinutes returns the DurationMinutes field if non-nil, zero value otherwise. + +### GetDurationMinutesOk + +`func (o *PasswordDigitTokenReset) GetDurationMinutesOk() (*int32, bool)` + +GetDurationMinutesOk returns a tuple with the DurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDurationMinutes + +`func (o *PasswordDigitTokenReset) SetDurationMinutes(v int32)` + +SetDurationMinutes sets DurationMinutes field to given value. + +### HasDurationMinutes + +`func (o *PasswordDigitTokenReset) HasDurationMinutes() bool` + +HasDurationMinutes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PasswordInfo.md b/docs/tools/sdk/go/Reference/V2024/Models/PasswordInfo.md new file mode 100644 index 000000000..946819e4d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PasswordInfo.md @@ -0,0 +1,194 @@ +--- +id: v2024-password-info +title: PasswordInfo +pagination_label: PasswordInfo +sidebar_label: PasswordInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordInfo', 'V2024PasswordInfo'] +slug: /tools/sdk/go/v2024/models/password-info +tags: ['SDK', 'Software Development Kit', 'PasswordInfo', 'V2024PasswordInfo'] +--- + +# PasswordInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | Identity ID | [optional] +**SourceId** | Pointer to **string** | source ID | [optional] +**PublicKeyId** | Pointer to **string** | public key ID | [optional] +**PublicKey** | Pointer to **string** | User's public key with Base64 encoding | [optional] +**Accounts** | Pointer to [**[]PasswordInfoAccount**](password-info-account) | Account info related to queried identity and source | [optional] +**Policies** | Pointer to **[]string** | Password constraints | [optional] + +## Methods + +### NewPasswordInfo + +`func NewPasswordInfo() *PasswordInfo` + +NewPasswordInfo instantiates a new PasswordInfo 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 + +### NewPasswordInfoWithDefaults + +`func NewPasswordInfoWithDefaults() *PasswordInfo` + +NewPasswordInfoWithDefaults instantiates a new PasswordInfo 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 + +### GetIdentityId + +`func (o *PasswordInfo) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *PasswordInfo) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *PasswordInfo) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *PasswordInfo) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *PasswordInfo) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *PasswordInfo) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *PasswordInfo) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *PasswordInfo) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetPublicKeyId + +`func (o *PasswordInfo) GetPublicKeyId() string` + +GetPublicKeyId returns the PublicKeyId field if non-nil, zero value otherwise. + +### GetPublicKeyIdOk + +`func (o *PasswordInfo) GetPublicKeyIdOk() (*string, bool)` + +GetPublicKeyIdOk returns a tuple with the PublicKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyId + +`func (o *PasswordInfo) SetPublicKeyId(v string)` + +SetPublicKeyId sets PublicKeyId field to given value. + +### HasPublicKeyId + +`func (o *PasswordInfo) HasPublicKeyId() bool` + +HasPublicKeyId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *PasswordInfo) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *PasswordInfo) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *PasswordInfo) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *PasswordInfo) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetAccounts + +`func (o *PasswordInfo) GetAccounts() []PasswordInfoAccount` + +GetAccounts returns the Accounts field if non-nil, zero value otherwise. + +### GetAccountsOk + +`func (o *PasswordInfo) GetAccountsOk() (*[]PasswordInfoAccount, bool)` + +GetAccountsOk returns a tuple with the Accounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccounts + +`func (o *PasswordInfo) SetAccounts(v []PasswordInfoAccount)` + +SetAccounts sets Accounts field to given value. + +### HasAccounts + +`func (o *PasswordInfo) HasAccounts() bool` + +HasAccounts returns a boolean if a field has been set. + +### GetPolicies + +`func (o *PasswordInfo) GetPolicies() []string` + +GetPolicies returns the Policies field if non-nil, zero value otherwise. + +### GetPoliciesOk + +`func (o *PasswordInfo) GetPoliciesOk() (*[]string, bool)` + +GetPoliciesOk returns a tuple with the Policies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicies + +`func (o *PasswordInfo) SetPolicies(v []string)` + +SetPolicies sets Policies field to given value. + +### HasPolicies + +`func (o *PasswordInfo) HasPolicies() bool` + +HasPolicies returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PasswordInfoAccount.md b/docs/tools/sdk/go/Reference/V2024/Models/PasswordInfoAccount.md new file mode 100644 index 000000000..1dbe5afd3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PasswordInfoAccount.md @@ -0,0 +1,90 @@ +--- +id: v2024-password-info-account +title: PasswordInfoAccount +pagination_label: PasswordInfoAccount +sidebar_label: PasswordInfoAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordInfoAccount', 'V2024PasswordInfoAccount'] +slug: /tools/sdk/go/v2024/models/password-info-account +tags: ['SDK', 'Software Development Kit', 'PasswordInfoAccount', 'V2024PasswordInfoAccount'] +--- + +# PasswordInfoAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **string** | Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**AccountName** | Pointer to **string** | Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 | [optional] + +## Methods + +### NewPasswordInfoAccount + +`func NewPasswordInfoAccount() *PasswordInfoAccount` + +NewPasswordInfoAccount instantiates a new PasswordInfoAccount 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 + +### NewPasswordInfoAccountWithDefaults + +`func NewPasswordInfoAccountWithDefaults() *PasswordInfoAccount` + +NewPasswordInfoAccountWithDefaults instantiates a new PasswordInfoAccount 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 + +### GetAccountId + +`func (o *PasswordInfoAccount) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *PasswordInfoAccount) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *PasswordInfoAccount) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *PasswordInfoAccount) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetAccountName + +`func (o *PasswordInfoAccount) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *PasswordInfoAccount) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *PasswordInfoAccount) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *PasswordInfoAccount) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PasswordInfoQueryDTO.md b/docs/tools/sdk/go/Reference/V2024/Models/PasswordInfoQueryDTO.md new file mode 100644 index 000000000..2b2b11296 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PasswordInfoQueryDTO.md @@ -0,0 +1,90 @@ +--- +id: v2024-password-info-query-dto +title: PasswordInfoQueryDTO +pagination_label: PasswordInfoQueryDTO +sidebar_label: PasswordInfoQueryDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordInfoQueryDTO', 'V2024PasswordInfoQueryDTO'] +slug: /tools/sdk/go/v2024/models/password-info-query-dto +tags: ['SDK', 'Software Development Kit', 'PasswordInfoQueryDTO', 'V2024PasswordInfoQueryDTO'] +--- + +# PasswordInfoQueryDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserName** | Pointer to **string** | The login name of the user | [optional] +**SourceName** | Pointer to **string** | The display name of the source | [optional] + +## Methods + +### NewPasswordInfoQueryDTO + +`func NewPasswordInfoQueryDTO() *PasswordInfoQueryDTO` + +NewPasswordInfoQueryDTO instantiates a new PasswordInfoQueryDTO 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 + +### NewPasswordInfoQueryDTOWithDefaults + +`func NewPasswordInfoQueryDTOWithDefaults() *PasswordInfoQueryDTO` + +NewPasswordInfoQueryDTOWithDefaults instantiates a new PasswordInfoQueryDTO 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 + +### GetUserName + +`func (o *PasswordInfoQueryDTO) GetUserName() string` + +GetUserName returns the UserName field if non-nil, zero value otherwise. + +### GetUserNameOk + +`func (o *PasswordInfoQueryDTO) GetUserNameOk() (*string, bool)` + +GetUserNameOk returns a tuple with the UserName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserName + +`func (o *PasswordInfoQueryDTO) SetUserName(v string)` + +SetUserName sets UserName field to given value. + +### HasUserName + +`func (o *PasswordInfoQueryDTO) HasUserName() bool` + +HasUserName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *PasswordInfoQueryDTO) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *PasswordInfoQueryDTO) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *PasswordInfoQueryDTO) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *PasswordInfoQueryDTO) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PasswordOrgConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/PasswordOrgConfig.md new file mode 100644 index 000000000..9d2bf23c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PasswordOrgConfig.md @@ -0,0 +1,142 @@ +--- +id: v2024-password-org-config +title: PasswordOrgConfig +pagination_label: PasswordOrgConfig +sidebar_label: PasswordOrgConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordOrgConfig', 'V2024PasswordOrgConfig'] +slug: /tools/sdk/go/v2024/models/password-org-config +tags: ['SDK', 'Software Development Kit', 'PasswordOrgConfig', 'V2024PasswordOrgConfig'] +--- + +# PasswordOrgConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomInstructionsEnabled** | Pointer to **bool** | Indicator whether custom password instructions feature is enabled. The default value is false. | [optional] [default to false] +**DigitTokenEnabled** | Pointer to **bool** | Indicator whether \"digit token\" feature is enabled. The default value is false. | [optional] [default to false] +**DigitTokenDurationMinutes** | Pointer to **int32** | The duration of \"digit token\" in minutes. The default value is 5. | [optional] [default to 5] +**DigitTokenLength** | Pointer to **int32** | The length of \"digit token\". The default value is 6. | [optional] [default to 6] + +## Methods + +### NewPasswordOrgConfig + +`func NewPasswordOrgConfig() *PasswordOrgConfig` + +NewPasswordOrgConfig instantiates a new PasswordOrgConfig 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 + +### NewPasswordOrgConfigWithDefaults + +`func NewPasswordOrgConfigWithDefaults() *PasswordOrgConfig` + +NewPasswordOrgConfigWithDefaults instantiates a new PasswordOrgConfig 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 + +### GetCustomInstructionsEnabled + +`func (o *PasswordOrgConfig) GetCustomInstructionsEnabled() bool` + +GetCustomInstructionsEnabled returns the CustomInstructionsEnabled field if non-nil, zero value otherwise. + +### GetCustomInstructionsEnabledOk + +`func (o *PasswordOrgConfig) GetCustomInstructionsEnabledOk() (*bool, bool)` + +GetCustomInstructionsEnabledOk returns a tuple with the CustomInstructionsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomInstructionsEnabled + +`func (o *PasswordOrgConfig) SetCustomInstructionsEnabled(v bool)` + +SetCustomInstructionsEnabled sets CustomInstructionsEnabled field to given value. + +### HasCustomInstructionsEnabled + +`func (o *PasswordOrgConfig) HasCustomInstructionsEnabled() bool` + +HasCustomInstructionsEnabled returns a boolean if a field has been set. + +### GetDigitTokenEnabled + +`func (o *PasswordOrgConfig) GetDigitTokenEnabled() bool` + +GetDigitTokenEnabled returns the DigitTokenEnabled field if non-nil, zero value otherwise. + +### GetDigitTokenEnabledOk + +`func (o *PasswordOrgConfig) GetDigitTokenEnabledOk() (*bool, bool)` + +GetDigitTokenEnabledOk returns a tuple with the DigitTokenEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDigitTokenEnabled + +`func (o *PasswordOrgConfig) SetDigitTokenEnabled(v bool)` + +SetDigitTokenEnabled sets DigitTokenEnabled field to given value. + +### HasDigitTokenEnabled + +`func (o *PasswordOrgConfig) HasDigitTokenEnabled() bool` + +HasDigitTokenEnabled returns a boolean if a field has been set. + +### GetDigitTokenDurationMinutes + +`func (o *PasswordOrgConfig) GetDigitTokenDurationMinutes() int32` + +GetDigitTokenDurationMinutes returns the DigitTokenDurationMinutes field if non-nil, zero value otherwise. + +### GetDigitTokenDurationMinutesOk + +`func (o *PasswordOrgConfig) GetDigitTokenDurationMinutesOk() (*int32, bool)` + +GetDigitTokenDurationMinutesOk returns a tuple with the DigitTokenDurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDigitTokenDurationMinutes + +`func (o *PasswordOrgConfig) SetDigitTokenDurationMinutes(v int32)` + +SetDigitTokenDurationMinutes sets DigitTokenDurationMinutes field to given value. + +### HasDigitTokenDurationMinutes + +`func (o *PasswordOrgConfig) HasDigitTokenDurationMinutes() bool` + +HasDigitTokenDurationMinutes returns a boolean if a field has been set. + +### GetDigitTokenLength + +`func (o *PasswordOrgConfig) GetDigitTokenLength() int32` + +GetDigitTokenLength returns the DigitTokenLength field if non-nil, zero value otherwise. + +### GetDigitTokenLengthOk + +`func (o *PasswordOrgConfig) GetDigitTokenLengthOk() (*int32, bool)` + +GetDigitTokenLengthOk returns a tuple with the DigitTokenLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDigitTokenLength + +`func (o *PasswordOrgConfig) SetDigitTokenLength(v int32)` + +SetDigitTokenLength sets DigitTokenLength field to given value. + +### HasDigitTokenLength + +`func (o *PasswordOrgConfig) HasDigitTokenLength() bool` + +HasDigitTokenLength returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PasswordPolicyHoldersDtoAttributes.md b/docs/tools/sdk/go/Reference/V2024/Models/PasswordPolicyHoldersDtoAttributes.md new file mode 100644 index 000000000..2e04e3b9f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PasswordPolicyHoldersDtoAttributes.md @@ -0,0 +1,64 @@ +--- +id: v2024-password-policy-holders-dto-attributes +title: PasswordPolicyHoldersDtoAttributes +pagination_label: PasswordPolicyHoldersDtoAttributes +sidebar_label: PasswordPolicyHoldersDtoAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordPolicyHoldersDtoAttributes', 'V2024PasswordPolicyHoldersDtoAttributes'] +slug: /tools/sdk/go/v2024/models/password-policy-holders-dto-attributes +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyHoldersDtoAttributes', 'V2024PasswordPolicyHoldersDtoAttributes'] +--- + +# PasswordPolicyHoldersDtoAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttr** | Pointer to [**[]PasswordPolicyHoldersDtoAttributesIdentityAttrInner**](password-policy-holders-dto-attributes-identity-attr-inner) | Attributes of PasswordPolicyHoldersDto | [optional] + +## Methods + +### NewPasswordPolicyHoldersDtoAttributes + +`func NewPasswordPolicyHoldersDtoAttributes() *PasswordPolicyHoldersDtoAttributes` + +NewPasswordPolicyHoldersDtoAttributes instantiates a new PasswordPolicyHoldersDtoAttributes 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 + +### NewPasswordPolicyHoldersDtoAttributesWithDefaults + +`func NewPasswordPolicyHoldersDtoAttributesWithDefaults() *PasswordPolicyHoldersDtoAttributes` + +NewPasswordPolicyHoldersDtoAttributesWithDefaults instantiates a new PasswordPolicyHoldersDtoAttributes 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 + +### GetIdentityAttr + +`func (o *PasswordPolicyHoldersDtoAttributes) GetIdentityAttr() []PasswordPolicyHoldersDtoAttributesIdentityAttrInner` + +GetIdentityAttr returns the IdentityAttr field if non-nil, zero value otherwise. + +### GetIdentityAttrOk + +`func (o *PasswordPolicyHoldersDtoAttributes) GetIdentityAttrOk() (*[]PasswordPolicyHoldersDtoAttributesIdentityAttrInner, bool)` + +GetIdentityAttrOk returns a tuple with the IdentityAttr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttr + +`func (o *PasswordPolicyHoldersDtoAttributes) SetIdentityAttr(v []PasswordPolicyHoldersDtoAttributesIdentityAttrInner)` + +SetIdentityAttr sets IdentityAttr field to given value. + +### HasIdentityAttr + +`func (o *PasswordPolicyHoldersDtoAttributes) HasIdentityAttr() bool` + +HasIdentityAttr returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PasswordPolicyHoldersDtoAttributesIdentityAttrInner.md b/docs/tools/sdk/go/Reference/V2024/Models/PasswordPolicyHoldersDtoAttributesIdentityAttrInner.md new file mode 100644 index 000000000..31ae95b3c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PasswordPolicyHoldersDtoAttributesIdentityAttrInner.md @@ -0,0 +1,90 @@ +--- +id: v2024-password-policy-holders-dto-attributes-identity-attr-inner +title: PasswordPolicyHoldersDtoAttributesIdentityAttrInner +pagination_label: PasswordPolicyHoldersDtoAttributesIdentityAttrInner +sidebar_label: PasswordPolicyHoldersDtoAttributesIdentityAttrInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordPolicyHoldersDtoAttributesIdentityAttrInner', 'V2024PasswordPolicyHoldersDtoAttributesIdentityAttrInner'] +slug: /tools/sdk/go/v2024/models/password-policy-holders-dto-attributes-identity-attr-inner +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyHoldersDtoAttributesIdentityAttrInner', 'V2024PasswordPolicyHoldersDtoAttributesIdentityAttrInner'] +--- + +# PasswordPolicyHoldersDtoAttributesIdentityAttrInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Attribute's name | [optional] +**Value** | Pointer to **string** | Attribute's value | [optional] + +## Methods + +### NewPasswordPolicyHoldersDtoAttributesIdentityAttrInner + +`func NewPasswordPolicyHoldersDtoAttributesIdentityAttrInner() *PasswordPolicyHoldersDtoAttributesIdentityAttrInner` + +NewPasswordPolicyHoldersDtoAttributesIdentityAttrInner instantiates a new PasswordPolicyHoldersDtoAttributesIdentityAttrInner 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 + +### NewPasswordPolicyHoldersDtoAttributesIdentityAttrInnerWithDefaults + +`func NewPasswordPolicyHoldersDtoAttributesIdentityAttrInnerWithDefaults() *PasswordPolicyHoldersDtoAttributesIdentityAttrInner` + +NewPasswordPolicyHoldersDtoAttributesIdentityAttrInnerWithDefaults instantiates a new PasswordPolicyHoldersDtoAttributesIdentityAttrInner 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 + +### GetName + +`func (o *PasswordPolicyHoldersDtoAttributesIdentityAttrInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PasswordPolicyHoldersDtoAttributesIdentityAttrInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PasswordPolicyHoldersDtoAttributesIdentityAttrInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PasswordPolicyHoldersDtoAttributesIdentityAttrInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValue + +`func (o *PasswordPolicyHoldersDtoAttributesIdentityAttrInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *PasswordPolicyHoldersDtoAttributesIdentityAttrInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *PasswordPolicyHoldersDtoAttributesIdentityAttrInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *PasswordPolicyHoldersDtoAttributesIdentityAttrInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PasswordPolicyHoldersDtoInner.md b/docs/tools/sdk/go/Reference/V2024/Models/PasswordPolicyHoldersDtoInner.md new file mode 100644 index 000000000..7585dee3a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PasswordPolicyHoldersDtoInner.md @@ -0,0 +1,116 @@ +--- +id: v2024-password-policy-holders-dto-inner +title: PasswordPolicyHoldersDtoInner +pagination_label: PasswordPolicyHoldersDtoInner +sidebar_label: PasswordPolicyHoldersDtoInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordPolicyHoldersDtoInner', 'V2024PasswordPolicyHoldersDtoInner'] +slug: /tools/sdk/go/v2024/models/password-policy-holders-dto-inner +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyHoldersDtoInner', 'V2024PasswordPolicyHoldersDtoInner'] +--- + +# PasswordPolicyHoldersDtoInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PolicyId** | Pointer to **string** | The password policy Id. | [optional] +**PolicyName** | Pointer to **string** | The name of the password policy. | [optional] +**Selectors** | Pointer to [**PasswordPolicyHoldersDtoAttributes**](password-policy-holders-dto-attributes) | | [optional] + +## Methods + +### NewPasswordPolicyHoldersDtoInner + +`func NewPasswordPolicyHoldersDtoInner() *PasswordPolicyHoldersDtoInner` + +NewPasswordPolicyHoldersDtoInner instantiates a new PasswordPolicyHoldersDtoInner 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 + +### NewPasswordPolicyHoldersDtoInnerWithDefaults + +`func NewPasswordPolicyHoldersDtoInnerWithDefaults() *PasswordPolicyHoldersDtoInner` + +NewPasswordPolicyHoldersDtoInnerWithDefaults instantiates a new PasswordPolicyHoldersDtoInner 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 + +### GetPolicyId + +`func (o *PasswordPolicyHoldersDtoInner) GetPolicyId() string` + +GetPolicyId returns the PolicyId field if non-nil, zero value otherwise. + +### GetPolicyIdOk + +`func (o *PasswordPolicyHoldersDtoInner) GetPolicyIdOk() (*string, bool)` + +GetPolicyIdOk returns a tuple with the PolicyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyId + +`func (o *PasswordPolicyHoldersDtoInner) SetPolicyId(v string)` + +SetPolicyId sets PolicyId field to given value. + +### HasPolicyId + +`func (o *PasswordPolicyHoldersDtoInner) HasPolicyId() bool` + +HasPolicyId returns a boolean if a field has been set. + +### GetPolicyName + +`func (o *PasswordPolicyHoldersDtoInner) GetPolicyName() string` + +GetPolicyName returns the PolicyName field if non-nil, zero value otherwise. + +### GetPolicyNameOk + +`func (o *PasswordPolicyHoldersDtoInner) GetPolicyNameOk() (*string, bool)` + +GetPolicyNameOk returns a tuple with the PolicyName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyName + +`func (o *PasswordPolicyHoldersDtoInner) SetPolicyName(v string)` + +SetPolicyName sets PolicyName field to given value. + +### HasPolicyName + +`func (o *PasswordPolicyHoldersDtoInner) HasPolicyName() bool` + +HasPolicyName returns a boolean if a field has been set. + +### GetSelectors + +`func (o *PasswordPolicyHoldersDtoInner) GetSelectors() PasswordPolicyHoldersDtoAttributes` + +GetSelectors returns the Selectors field if non-nil, zero value otherwise. + +### GetSelectorsOk + +`func (o *PasswordPolicyHoldersDtoInner) GetSelectorsOk() (*PasswordPolicyHoldersDtoAttributes, bool)` + +GetSelectorsOk returns a tuple with the Selectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectors + +`func (o *PasswordPolicyHoldersDtoInner) SetSelectors(v PasswordPolicyHoldersDtoAttributes)` + +SetSelectors sets Selectors field to given value. + +### HasSelectors + +`func (o *PasswordPolicyHoldersDtoInner) HasSelectors() bool` + +HasSelectors returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PasswordPolicyV3Dto.md b/docs/tools/sdk/go/Reference/V2024/Models/PasswordPolicyV3Dto.md new file mode 100644 index 000000000..c2889815f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PasswordPolicyV3Dto.md @@ -0,0 +1,884 @@ +--- +id: v2024-password-policy-v3-dto +title: PasswordPolicyV3Dto +pagination_label: PasswordPolicyV3Dto +sidebar_label: PasswordPolicyV3Dto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordPolicyV3Dto', 'V2024PasswordPolicyV3Dto'] +slug: /tools/sdk/go/v2024/models/password-policy-v3-dto +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyV3Dto', 'V2024PasswordPolicyV3Dto'] +--- + +# PasswordPolicyV3Dto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The password policy Id. | [optional] +**Description** | Pointer to **NullableString** | Description for current password policy. | [optional] +**Name** | Pointer to **string** | The name of the password policy. | [optional] +**DateCreated** | Pointer to **int64** | Date the Password Policy was created. | [optional] +**LastUpdated** | Pointer to **NullableInt64** | Date the Password Policy was updated. | [optional] +**FirstExpirationReminder** | Pointer to **int64** | The number of days before expiration remaninder. | [optional] +**AccountIdMinWordLength** | Pointer to **int64** | The minimun length of account Id. By default is equals to -1. | [optional] +**AccountNameMinWordLength** | Pointer to **int64** | The minimun length of account name. By default is equals to -1. | [optional] +**MinAlpha** | Pointer to **int64** | Maximum alpha. By default is equals to 0. | [optional] +**MinCharacterTypes** | Pointer to **int64** | MinCharacterTypes. By default is equals to -1. | [optional] +**MaxLength** | Pointer to **int64** | Maximum length of the password. | [optional] +**MinLength** | Pointer to **int64** | Minimum length of the password. By default is equals to 0. | [optional] +**MaxRepeatedChars** | Pointer to **int64** | Maximum repetition of the same character in the password. By default is equals to -1. | [optional] +**MinLower** | Pointer to **int64** | Minimum amount of lower case character in the password. By default is equals to 0. | [optional] +**MinNumeric** | Pointer to **int64** | Minimum amount of numeric characters in the password. By default is equals to 0. | [optional] +**MinSpecial** | Pointer to **int64** | Minimum amount of special symbols in the password. By default is equals to 0. | [optional] +**MinUpper** | Pointer to **int64** | Minimum amount of upper case symbols in the password. By default is equals to 0. | [optional] +**PasswordExpiration** | Pointer to **int64** | Number of days before current password expires. By default is equals to 90. | [optional] +**DefaultPolicy** | Pointer to **bool** | Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. | [optional] [default to false] +**EnablePasswdExpiration** | Pointer to **bool** | Defines whether this policy is enabled to expire or not. This field is false by default. | [optional] [default to false] +**RequireStrongAuthn** | Pointer to **bool** | Defines whether this policy require strong Auth or not. This field is false by default. | [optional] [default to false] +**RequireStrongAuthOffNetwork** | Pointer to **bool** | Defines whether this policy require strong Auth of network or not. This field is false by default. | [optional] [default to false] +**RequireStrongAuthUntrustedGeographies** | Pointer to **bool** | Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. | [optional] [default to false] +**UseAccountAttributes** | Pointer to **bool** | Defines whether this policy uses account attributes or not. This field is false by default. | [optional] [default to false] +**UseDictionary** | Pointer to **bool** | Defines whether this policy uses dictionary or not. This field is false by default. | [optional] [default to false] +**UseIdentityAttributes** | Pointer to **bool** | Defines whether this policy uses identity attributes or not. This field is false by default. | [optional] [default to false] +**ValidateAgainstAccountId** | Pointer to **bool** | Defines whether this policy validate against account id or not. This field is false by default. | [optional] [default to false] +**ValidateAgainstAccountName** | Pointer to **bool** | Defines whether this policy validate against account name or not. This field is false by default. | [optional] [default to false] +**Created** | Pointer to **NullableString** | | [optional] +**Modified** | Pointer to **NullableString** | | [optional] +**SourceIds** | Pointer to **[]string** | List of sources IDs managed by this password policy. | [optional] + +## Methods + +### NewPasswordPolicyV3Dto + +`func NewPasswordPolicyV3Dto() *PasswordPolicyV3Dto` + +NewPasswordPolicyV3Dto instantiates a new PasswordPolicyV3Dto 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 + +### NewPasswordPolicyV3DtoWithDefaults + +`func NewPasswordPolicyV3DtoWithDefaults() *PasswordPolicyV3Dto` + +NewPasswordPolicyV3DtoWithDefaults instantiates a new PasswordPolicyV3Dto 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 + +### GetId + +`func (o *PasswordPolicyV3Dto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PasswordPolicyV3Dto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PasswordPolicyV3Dto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PasswordPolicyV3Dto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDescription + +`func (o *PasswordPolicyV3Dto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *PasswordPolicyV3Dto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *PasswordPolicyV3Dto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *PasswordPolicyV3Dto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *PasswordPolicyV3Dto) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *PasswordPolicyV3Dto) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetName + +`func (o *PasswordPolicyV3Dto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PasswordPolicyV3Dto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PasswordPolicyV3Dto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PasswordPolicyV3Dto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDateCreated + +`func (o *PasswordPolicyV3Dto) GetDateCreated() int64` + +GetDateCreated returns the DateCreated field if non-nil, zero value otherwise. + +### GetDateCreatedOk + +`func (o *PasswordPolicyV3Dto) GetDateCreatedOk() (*int64, bool)` + +GetDateCreatedOk returns a tuple with the DateCreated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDateCreated + +`func (o *PasswordPolicyV3Dto) SetDateCreated(v int64)` + +SetDateCreated sets DateCreated field to given value. + +### HasDateCreated + +`func (o *PasswordPolicyV3Dto) HasDateCreated() bool` + +HasDateCreated returns a boolean if a field has been set. + +### GetLastUpdated + +`func (o *PasswordPolicyV3Dto) GetLastUpdated() int64` + +GetLastUpdated returns the LastUpdated field if non-nil, zero value otherwise. + +### GetLastUpdatedOk + +`func (o *PasswordPolicyV3Dto) GetLastUpdatedOk() (*int64, bool)` + +GetLastUpdatedOk returns a tuple with the LastUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdated + +`func (o *PasswordPolicyV3Dto) SetLastUpdated(v int64)` + +SetLastUpdated sets LastUpdated field to given value. + +### HasLastUpdated + +`func (o *PasswordPolicyV3Dto) HasLastUpdated() bool` + +HasLastUpdated returns a boolean if a field has been set. + +### SetLastUpdatedNil + +`func (o *PasswordPolicyV3Dto) SetLastUpdatedNil(b bool)` + + SetLastUpdatedNil sets the value for LastUpdated to be an explicit nil + +### UnsetLastUpdated +`func (o *PasswordPolicyV3Dto) UnsetLastUpdated()` + +UnsetLastUpdated ensures that no value is present for LastUpdated, not even an explicit nil +### GetFirstExpirationReminder + +`func (o *PasswordPolicyV3Dto) GetFirstExpirationReminder() int64` + +GetFirstExpirationReminder returns the FirstExpirationReminder field if non-nil, zero value otherwise. + +### GetFirstExpirationReminderOk + +`func (o *PasswordPolicyV3Dto) GetFirstExpirationReminderOk() (*int64, bool)` + +GetFirstExpirationReminderOk returns a tuple with the FirstExpirationReminder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstExpirationReminder + +`func (o *PasswordPolicyV3Dto) SetFirstExpirationReminder(v int64)` + +SetFirstExpirationReminder sets FirstExpirationReminder field to given value. + +### HasFirstExpirationReminder + +`func (o *PasswordPolicyV3Dto) HasFirstExpirationReminder() bool` + +HasFirstExpirationReminder returns a boolean if a field has been set. + +### GetAccountIdMinWordLength + +`func (o *PasswordPolicyV3Dto) GetAccountIdMinWordLength() int64` + +GetAccountIdMinWordLength returns the AccountIdMinWordLength field if non-nil, zero value otherwise. + +### GetAccountIdMinWordLengthOk + +`func (o *PasswordPolicyV3Dto) GetAccountIdMinWordLengthOk() (*int64, bool)` + +GetAccountIdMinWordLengthOk returns a tuple with the AccountIdMinWordLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountIdMinWordLength + +`func (o *PasswordPolicyV3Dto) SetAccountIdMinWordLength(v int64)` + +SetAccountIdMinWordLength sets AccountIdMinWordLength field to given value. + +### HasAccountIdMinWordLength + +`func (o *PasswordPolicyV3Dto) HasAccountIdMinWordLength() bool` + +HasAccountIdMinWordLength returns a boolean if a field has been set. + +### GetAccountNameMinWordLength + +`func (o *PasswordPolicyV3Dto) GetAccountNameMinWordLength() int64` + +GetAccountNameMinWordLength returns the AccountNameMinWordLength field if non-nil, zero value otherwise. + +### GetAccountNameMinWordLengthOk + +`func (o *PasswordPolicyV3Dto) GetAccountNameMinWordLengthOk() (*int64, bool)` + +GetAccountNameMinWordLengthOk returns a tuple with the AccountNameMinWordLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountNameMinWordLength + +`func (o *PasswordPolicyV3Dto) SetAccountNameMinWordLength(v int64)` + +SetAccountNameMinWordLength sets AccountNameMinWordLength field to given value. + +### HasAccountNameMinWordLength + +`func (o *PasswordPolicyV3Dto) HasAccountNameMinWordLength() bool` + +HasAccountNameMinWordLength returns a boolean if a field has been set. + +### GetMinAlpha + +`func (o *PasswordPolicyV3Dto) GetMinAlpha() int64` + +GetMinAlpha returns the MinAlpha field if non-nil, zero value otherwise. + +### GetMinAlphaOk + +`func (o *PasswordPolicyV3Dto) GetMinAlphaOk() (*int64, bool)` + +GetMinAlphaOk returns a tuple with the MinAlpha field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinAlpha + +`func (o *PasswordPolicyV3Dto) SetMinAlpha(v int64)` + +SetMinAlpha sets MinAlpha field to given value. + +### HasMinAlpha + +`func (o *PasswordPolicyV3Dto) HasMinAlpha() bool` + +HasMinAlpha returns a boolean if a field has been set. + +### GetMinCharacterTypes + +`func (o *PasswordPolicyV3Dto) GetMinCharacterTypes() int64` + +GetMinCharacterTypes returns the MinCharacterTypes field if non-nil, zero value otherwise. + +### GetMinCharacterTypesOk + +`func (o *PasswordPolicyV3Dto) GetMinCharacterTypesOk() (*int64, bool)` + +GetMinCharacterTypesOk returns a tuple with the MinCharacterTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinCharacterTypes + +`func (o *PasswordPolicyV3Dto) SetMinCharacterTypes(v int64)` + +SetMinCharacterTypes sets MinCharacterTypes field to given value. + +### HasMinCharacterTypes + +`func (o *PasswordPolicyV3Dto) HasMinCharacterTypes() bool` + +HasMinCharacterTypes returns a boolean if a field has been set. + +### GetMaxLength + +`func (o *PasswordPolicyV3Dto) GetMaxLength() int64` + +GetMaxLength returns the MaxLength field if non-nil, zero value otherwise. + +### GetMaxLengthOk + +`func (o *PasswordPolicyV3Dto) GetMaxLengthOk() (*int64, bool)` + +GetMaxLengthOk returns a tuple with the MaxLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxLength + +`func (o *PasswordPolicyV3Dto) SetMaxLength(v int64)` + +SetMaxLength sets MaxLength field to given value. + +### HasMaxLength + +`func (o *PasswordPolicyV3Dto) HasMaxLength() bool` + +HasMaxLength returns a boolean if a field has been set. + +### GetMinLength + +`func (o *PasswordPolicyV3Dto) GetMinLength() int64` + +GetMinLength returns the MinLength field if non-nil, zero value otherwise. + +### GetMinLengthOk + +`func (o *PasswordPolicyV3Dto) GetMinLengthOk() (*int64, bool)` + +GetMinLengthOk returns a tuple with the MinLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinLength + +`func (o *PasswordPolicyV3Dto) SetMinLength(v int64)` + +SetMinLength sets MinLength field to given value. + +### HasMinLength + +`func (o *PasswordPolicyV3Dto) HasMinLength() bool` + +HasMinLength returns a boolean if a field has been set. + +### GetMaxRepeatedChars + +`func (o *PasswordPolicyV3Dto) GetMaxRepeatedChars() int64` + +GetMaxRepeatedChars returns the MaxRepeatedChars field if non-nil, zero value otherwise. + +### GetMaxRepeatedCharsOk + +`func (o *PasswordPolicyV3Dto) GetMaxRepeatedCharsOk() (*int64, bool)` + +GetMaxRepeatedCharsOk returns a tuple with the MaxRepeatedChars field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxRepeatedChars + +`func (o *PasswordPolicyV3Dto) SetMaxRepeatedChars(v int64)` + +SetMaxRepeatedChars sets MaxRepeatedChars field to given value. + +### HasMaxRepeatedChars + +`func (o *PasswordPolicyV3Dto) HasMaxRepeatedChars() bool` + +HasMaxRepeatedChars returns a boolean if a field has been set. + +### GetMinLower + +`func (o *PasswordPolicyV3Dto) GetMinLower() int64` + +GetMinLower returns the MinLower field if non-nil, zero value otherwise. + +### GetMinLowerOk + +`func (o *PasswordPolicyV3Dto) GetMinLowerOk() (*int64, bool)` + +GetMinLowerOk returns a tuple with the MinLower field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinLower + +`func (o *PasswordPolicyV3Dto) SetMinLower(v int64)` + +SetMinLower sets MinLower field to given value. + +### HasMinLower + +`func (o *PasswordPolicyV3Dto) HasMinLower() bool` + +HasMinLower returns a boolean if a field has been set. + +### GetMinNumeric + +`func (o *PasswordPolicyV3Dto) GetMinNumeric() int64` + +GetMinNumeric returns the MinNumeric field if non-nil, zero value otherwise. + +### GetMinNumericOk + +`func (o *PasswordPolicyV3Dto) GetMinNumericOk() (*int64, bool)` + +GetMinNumericOk returns a tuple with the MinNumeric field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinNumeric + +`func (o *PasswordPolicyV3Dto) SetMinNumeric(v int64)` + +SetMinNumeric sets MinNumeric field to given value. + +### HasMinNumeric + +`func (o *PasswordPolicyV3Dto) HasMinNumeric() bool` + +HasMinNumeric returns a boolean if a field has been set. + +### GetMinSpecial + +`func (o *PasswordPolicyV3Dto) GetMinSpecial() int64` + +GetMinSpecial returns the MinSpecial field if non-nil, zero value otherwise. + +### GetMinSpecialOk + +`func (o *PasswordPolicyV3Dto) GetMinSpecialOk() (*int64, bool)` + +GetMinSpecialOk returns a tuple with the MinSpecial field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinSpecial + +`func (o *PasswordPolicyV3Dto) SetMinSpecial(v int64)` + +SetMinSpecial sets MinSpecial field to given value. + +### HasMinSpecial + +`func (o *PasswordPolicyV3Dto) HasMinSpecial() bool` + +HasMinSpecial returns a boolean if a field has been set. + +### GetMinUpper + +`func (o *PasswordPolicyV3Dto) GetMinUpper() int64` + +GetMinUpper returns the MinUpper field if non-nil, zero value otherwise. + +### GetMinUpperOk + +`func (o *PasswordPolicyV3Dto) GetMinUpperOk() (*int64, bool)` + +GetMinUpperOk returns a tuple with the MinUpper field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinUpper + +`func (o *PasswordPolicyV3Dto) SetMinUpper(v int64)` + +SetMinUpper sets MinUpper field to given value. + +### HasMinUpper + +`func (o *PasswordPolicyV3Dto) HasMinUpper() bool` + +HasMinUpper returns a boolean if a field has been set. + +### GetPasswordExpiration + +`func (o *PasswordPolicyV3Dto) GetPasswordExpiration() int64` + +GetPasswordExpiration returns the PasswordExpiration field if non-nil, zero value otherwise. + +### GetPasswordExpirationOk + +`func (o *PasswordPolicyV3Dto) GetPasswordExpirationOk() (*int64, bool)` + +GetPasswordExpirationOk returns a tuple with the PasswordExpiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordExpiration + +`func (o *PasswordPolicyV3Dto) SetPasswordExpiration(v int64)` + +SetPasswordExpiration sets PasswordExpiration field to given value. + +### HasPasswordExpiration + +`func (o *PasswordPolicyV3Dto) HasPasswordExpiration() bool` + +HasPasswordExpiration returns a boolean if a field has been set. + +### GetDefaultPolicy + +`func (o *PasswordPolicyV3Dto) GetDefaultPolicy() bool` + +GetDefaultPolicy returns the DefaultPolicy field if non-nil, zero value otherwise. + +### GetDefaultPolicyOk + +`func (o *PasswordPolicyV3Dto) GetDefaultPolicyOk() (*bool, bool)` + +GetDefaultPolicyOk returns a tuple with the DefaultPolicy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultPolicy + +`func (o *PasswordPolicyV3Dto) SetDefaultPolicy(v bool)` + +SetDefaultPolicy sets DefaultPolicy field to given value. + +### HasDefaultPolicy + +`func (o *PasswordPolicyV3Dto) HasDefaultPolicy() bool` + +HasDefaultPolicy returns a boolean if a field has been set. + +### GetEnablePasswdExpiration + +`func (o *PasswordPolicyV3Dto) GetEnablePasswdExpiration() bool` + +GetEnablePasswdExpiration returns the EnablePasswdExpiration field if non-nil, zero value otherwise. + +### GetEnablePasswdExpirationOk + +`func (o *PasswordPolicyV3Dto) GetEnablePasswdExpirationOk() (*bool, bool)` + +GetEnablePasswdExpirationOk returns a tuple with the EnablePasswdExpiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnablePasswdExpiration + +`func (o *PasswordPolicyV3Dto) SetEnablePasswdExpiration(v bool)` + +SetEnablePasswdExpiration sets EnablePasswdExpiration field to given value. + +### HasEnablePasswdExpiration + +`func (o *PasswordPolicyV3Dto) HasEnablePasswdExpiration() bool` + +HasEnablePasswdExpiration returns a boolean if a field has been set. + +### GetRequireStrongAuthn + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthn() bool` + +GetRequireStrongAuthn returns the RequireStrongAuthn field if non-nil, zero value otherwise. + +### GetRequireStrongAuthnOk + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthnOk() (*bool, bool)` + +GetRequireStrongAuthnOk returns a tuple with the RequireStrongAuthn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequireStrongAuthn + +`func (o *PasswordPolicyV3Dto) SetRequireStrongAuthn(v bool)` + +SetRequireStrongAuthn sets RequireStrongAuthn field to given value. + +### HasRequireStrongAuthn + +`func (o *PasswordPolicyV3Dto) HasRequireStrongAuthn() bool` + +HasRequireStrongAuthn returns a boolean if a field has been set. + +### GetRequireStrongAuthOffNetwork + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthOffNetwork() bool` + +GetRequireStrongAuthOffNetwork returns the RequireStrongAuthOffNetwork field if non-nil, zero value otherwise. + +### GetRequireStrongAuthOffNetworkOk + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthOffNetworkOk() (*bool, bool)` + +GetRequireStrongAuthOffNetworkOk returns a tuple with the RequireStrongAuthOffNetwork field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequireStrongAuthOffNetwork + +`func (o *PasswordPolicyV3Dto) SetRequireStrongAuthOffNetwork(v bool)` + +SetRequireStrongAuthOffNetwork sets RequireStrongAuthOffNetwork field to given value. + +### HasRequireStrongAuthOffNetwork + +`func (o *PasswordPolicyV3Dto) HasRequireStrongAuthOffNetwork() bool` + +HasRequireStrongAuthOffNetwork returns a boolean if a field has been set. + +### GetRequireStrongAuthUntrustedGeographies + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthUntrustedGeographies() bool` + +GetRequireStrongAuthUntrustedGeographies returns the RequireStrongAuthUntrustedGeographies field if non-nil, zero value otherwise. + +### GetRequireStrongAuthUntrustedGeographiesOk + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthUntrustedGeographiesOk() (*bool, bool)` + +GetRequireStrongAuthUntrustedGeographiesOk returns a tuple with the RequireStrongAuthUntrustedGeographies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequireStrongAuthUntrustedGeographies + +`func (o *PasswordPolicyV3Dto) SetRequireStrongAuthUntrustedGeographies(v bool)` + +SetRequireStrongAuthUntrustedGeographies sets RequireStrongAuthUntrustedGeographies field to given value. + +### HasRequireStrongAuthUntrustedGeographies + +`func (o *PasswordPolicyV3Dto) HasRequireStrongAuthUntrustedGeographies() bool` + +HasRequireStrongAuthUntrustedGeographies returns a boolean if a field has been set. + +### GetUseAccountAttributes + +`func (o *PasswordPolicyV3Dto) GetUseAccountAttributes() bool` + +GetUseAccountAttributes returns the UseAccountAttributes field if non-nil, zero value otherwise. + +### GetUseAccountAttributesOk + +`func (o *PasswordPolicyV3Dto) GetUseAccountAttributesOk() (*bool, bool)` + +GetUseAccountAttributesOk returns a tuple with the UseAccountAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseAccountAttributes + +`func (o *PasswordPolicyV3Dto) SetUseAccountAttributes(v bool)` + +SetUseAccountAttributes sets UseAccountAttributes field to given value. + +### HasUseAccountAttributes + +`func (o *PasswordPolicyV3Dto) HasUseAccountAttributes() bool` + +HasUseAccountAttributes returns a boolean if a field has been set. + +### GetUseDictionary + +`func (o *PasswordPolicyV3Dto) GetUseDictionary() bool` + +GetUseDictionary returns the UseDictionary field if non-nil, zero value otherwise. + +### GetUseDictionaryOk + +`func (o *PasswordPolicyV3Dto) GetUseDictionaryOk() (*bool, bool)` + +GetUseDictionaryOk returns a tuple with the UseDictionary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseDictionary + +`func (o *PasswordPolicyV3Dto) SetUseDictionary(v bool)` + +SetUseDictionary sets UseDictionary field to given value. + +### HasUseDictionary + +`func (o *PasswordPolicyV3Dto) HasUseDictionary() bool` + +HasUseDictionary returns a boolean if a field has been set. + +### GetUseIdentityAttributes + +`func (o *PasswordPolicyV3Dto) GetUseIdentityAttributes() bool` + +GetUseIdentityAttributes returns the UseIdentityAttributes field if non-nil, zero value otherwise. + +### GetUseIdentityAttributesOk + +`func (o *PasswordPolicyV3Dto) GetUseIdentityAttributesOk() (*bool, bool)` + +GetUseIdentityAttributesOk returns a tuple with the UseIdentityAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseIdentityAttributes + +`func (o *PasswordPolicyV3Dto) SetUseIdentityAttributes(v bool)` + +SetUseIdentityAttributes sets UseIdentityAttributes field to given value. + +### HasUseIdentityAttributes + +`func (o *PasswordPolicyV3Dto) HasUseIdentityAttributes() bool` + +HasUseIdentityAttributes returns a boolean if a field has been set. + +### GetValidateAgainstAccountId + +`func (o *PasswordPolicyV3Dto) GetValidateAgainstAccountId() bool` + +GetValidateAgainstAccountId returns the ValidateAgainstAccountId field if non-nil, zero value otherwise. + +### GetValidateAgainstAccountIdOk + +`func (o *PasswordPolicyV3Dto) GetValidateAgainstAccountIdOk() (*bool, bool)` + +GetValidateAgainstAccountIdOk returns a tuple with the ValidateAgainstAccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValidateAgainstAccountId + +`func (o *PasswordPolicyV3Dto) SetValidateAgainstAccountId(v bool)` + +SetValidateAgainstAccountId sets ValidateAgainstAccountId field to given value. + +### HasValidateAgainstAccountId + +`func (o *PasswordPolicyV3Dto) HasValidateAgainstAccountId() bool` + +HasValidateAgainstAccountId returns a boolean if a field has been set. + +### GetValidateAgainstAccountName + +`func (o *PasswordPolicyV3Dto) GetValidateAgainstAccountName() bool` + +GetValidateAgainstAccountName returns the ValidateAgainstAccountName field if non-nil, zero value otherwise. + +### GetValidateAgainstAccountNameOk + +`func (o *PasswordPolicyV3Dto) GetValidateAgainstAccountNameOk() (*bool, bool)` + +GetValidateAgainstAccountNameOk returns a tuple with the ValidateAgainstAccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValidateAgainstAccountName + +`func (o *PasswordPolicyV3Dto) SetValidateAgainstAccountName(v bool)` + +SetValidateAgainstAccountName sets ValidateAgainstAccountName field to given value. + +### HasValidateAgainstAccountName + +`func (o *PasswordPolicyV3Dto) HasValidateAgainstAccountName() bool` + +HasValidateAgainstAccountName returns a boolean if a field has been set. + +### GetCreated + +`func (o *PasswordPolicyV3Dto) GetCreated() string` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *PasswordPolicyV3Dto) GetCreatedOk() (*string, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *PasswordPolicyV3Dto) SetCreated(v string)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *PasswordPolicyV3Dto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *PasswordPolicyV3Dto) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *PasswordPolicyV3Dto) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *PasswordPolicyV3Dto) GetModified() string` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PasswordPolicyV3Dto) GetModifiedOk() (*string, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PasswordPolicyV3Dto) SetModified(v string)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PasswordPolicyV3Dto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *PasswordPolicyV3Dto) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *PasswordPolicyV3Dto) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSourceIds + +`func (o *PasswordPolicyV3Dto) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *PasswordPolicyV3Dto) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *PasswordPolicyV3Dto) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *PasswordPolicyV3Dto) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PasswordStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/PasswordStatus.md new file mode 100644 index 000000000..078efe456 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PasswordStatus.md @@ -0,0 +1,152 @@ +--- +id: v2024-password-status +title: PasswordStatus +pagination_label: PasswordStatus +sidebar_label: PasswordStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordStatus', 'V2024PasswordStatus'] +slug: /tools/sdk/go/v2024/models/password-status +tags: ['SDK', 'Software Development Kit', 'PasswordStatus', 'V2024PasswordStatus'] +--- + +# PasswordStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **NullableString** | The password change request ID | [optional] +**State** | Pointer to **string** | Password change state | [optional] +**Errors** | Pointer to **[]string** | The errors during the password change request | [optional] +**SourceIds** | Pointer to **[]string** | List of source IDs in the password change request | [optional] + +## Methods + +### NewPasswordStatus + +`func NewPasswordStatus() *PasswordStatus` + +NewPasswordStatus instantiates a new PasswordStatus 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 + +### NewPasswordStatusWithDefaults + +`func NewPasswordStatusWithDefaults() *PasswordStatus` + +NewPasswordStatusWithDefaults instantiates a new PasswordStatus 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 + +### GetRequestId + +`func (o *PasswordStatus) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *PasswordStatus) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *PasswordStatus) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *PasswordStatus) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *PasswordStatus) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *PasswordStatus) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetState + +`func (o *PasswordStatus) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *PasswordStatus) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *PasswordStatus) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *PasswordStatus) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetErrors + +`func (o *PasswordStatus) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *PasswordStatus) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *PasswordStatus) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *PasswordStatus) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### GetSourceIds + +`func (o *PasswordStatus) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *PasswordStatus) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *PasswordStatus) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *PasswordStatus) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PasswordSyncGroup.md b/docs/tools/sdk/go/Reference/V2024/Models/PasswordSyncGroup.md new file mode 100644 index 000000000..e6a6d1710 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PasswordSyncGroup.md @@ -0,0 +1,214 @@ +--- +id: v2024-password-sync-group +title: PasswordSyncGroup +pagination_label: PasswordSyncGroup +sidebar_label: PasswordSyncGroup +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordSyncGroup', 'V2024PasswordSyncGroup'] +slug: /tools/sdk/go/v2024/models/password-sync-group +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroup', 'V2024PasswordSyncGroup'] +--- + +# PasswordSyncGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the sync group | [optional] +**Name** | Pointer to **string** | Name of the sync group | [optional] +**PasswordPolicyId** | Pointer to **string** | ID of the password policy | [optional] +**SourceIds** | Pointer to **[]string** | List of password managed sources IDs | [optional] +**Created** | Pointer to **NullableTime** | The date and time this sync group was created | [optional] +**Modified** | Pointer to **NullableTime** | The date and time this sync group was last modified | [optional] + +## Methods + +### NewPasswordSyncGroup + +`func NewPasswordSyncGroup() *PasswordSyncGroup` + +NewPasswordSyncGroup instantiates a new PasswordSyncGroup 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 + +### NewPasswordSyncGroupWithDefaults + +`func NewPasswordSyncGroupWithDefaults() *PasswordSyncGroup` + +NewPasswordSyncGroupWithDefaults instantiates a new PasswordSyncGroup 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 + +### GetId + +`func (o *PasswordSyncGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PasswordSyncGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PasswordSyncGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PasswordSyncGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *PasswordSyncGroup) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PasswordSyncGroup) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PasswordSyncGroup) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PasswordSyncGroup) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPasswordPolicyId + +`func (o *PasswordSyncGroup) GetPasswordPolicyId() string` + +GetPasswordPolicyId returns the PasswordPolicyId field if non-nil, zero value otherwise. + +### GetPasswordPolicyIdOk + +`func (o *PasswordSyncGroup) GetPasswordPolicyIdOk() (*string, bool)` + +GetPasswordPolicyIdOk returns a tuple with the PasswordPolicyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicyId + +`func (o *PasswordSyncGroup) SetPasswordPolicyId(v string)` + +SetPasswordPolicyId sets PasswordPolicyId field to given value. + +### HasPasswordPolicyId + +`func (o *PasswordSyncGroup) HasPasswordPolicyId() bool` + +HasPasswordPolicyId returns a boolean if a field has been set. + +### GetSourceIds + +`func (o *PasswordSyncGroup) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *PasswordSyncGroup) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *PasswordSyncGroup) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *PasswordSyncGroup) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + +### GetCreated + +`func (o *PasswordSyncGroup) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *PasswordSyncGroup) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *PasswordSyncGroup) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *PasswordSyncGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *PasswordSyncGroup) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *PasswordSyncGroup) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *PasswordSyncGroup) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PasswordSyncGroup) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PasswordSyncGroup) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PasswordSyncGroup) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *PasswordSyncGroup) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *PasswordSyncGroup) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PatOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/PatOwner.md new file mode 100644 index 000000000..33aeea0ff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PatOwner.md @@ -0,0 +1,116 @@ +--- +id: v2024-pat-owner +title: PatOwner +pagination_label: PatOwner +sidebar_label: PatOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PatOwner', 'V2024PatOwner'] +slug: /tools/sdk/go/v2024/models/pat-owner +tags: ['SDK', 'Software Development Kit', 'PatOwner', 'V2024PatOwner'] +--- + +# PatOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Personal access token owner's DTO type. | [optional] +**Id** | Pointer to **string** | Personal access token owner's identity ID. | [optional] +**Name** | Pointer to **string** | Personal access token owner's human-readable display name. | [optional] + +## Methods + +### NewPatOwner + +`func NewPatOwner() *PatOwner` + +NewPatOwner instantiates a new PatOwner 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 + +### NewPatOwnerWithDefaults + +`func NewPatOwnerWithDefaults() *PatOwner` + +NewPatOwnerWithDefaults instantiates a new PatOwner 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 + +### GetType + +`func (o *PatOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *PatOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *PatOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *PatOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *PatOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PatOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PatOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PatOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *PatOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PatOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PatOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PatOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PatchPotentialRoleRequestInner.md b/docs/tools/sdk/go/Reference/V2024/Models/PatchPotentialRoleRequestInner.md new file mode 100644 index 000000000..1a494e7d1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PatchPotentialRoleRequestInner.md @@ -0,0 +1,111 @@ +--- +id: v2024-patch-potential-role-request-inner +title: PatchPotentialRoleRequestInner +pagination_label: PatchPotentialRoleRequestInner +sidebar_label: PatchPotentialRoleRequestInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PatchPotentialRoleRequestInner', 'V2024PatchPotentialRoleRequestInner'] +slug: /tools/sdk/go/v2024/models/patch-potential-role-request-inner +tags: ['SDK', 'Software Development Kit', 'PatchPotentialRoleRequestInner', 'V2024PatchPotentialRoleRequestInner'] +--- + +# PatchPotentialRoleRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | Pointer to **string** | The operation to be performed | [optional] +**Path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | +**Value** | Pointer to [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] + +## Methods + +### NewPatchPotentialRoleRequestInner + +`func NewPatchPotentialRoleRequestInner(path string, ) *PatchPotentialRoleRequestInner` + +NewPatchPotentialRoleRequestInner instantiates a new PatchPotentialRoleRequestInner 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 + +### NewPatchPotentialRoleRequestInnerWithDefaults + +`func NewPatchPotentialRoleRequestInnerWithDefaults() *PatchPotentialRoleRequestInner` + +NewPatchPotentialRoleRequestInnerWithDefaults instantiates a new PatchPotentialRoleRequestInner 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 + +### GetOp + +`func (o *PatchPotentialRoleRequestInner) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *PatchPotentialRoleRequestInner) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *PatchPotentialRoleRequestInner) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *PatchPotentialRoleRequestInner) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetPath + +`func (o *PatchPotentialRoleRequestInner) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *PatchPotentialRoleRequestInner) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *PatchPotentialRoleRequestInner) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetValue + +`func (o *PatchPotentialRoleRequestInner) GetValue() UpdateMultiHostSourcesRequestInnerValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *PatchPotentialRoleRequestInner) GetValueOk() (*UpdateMultiHostSourcesRequestInnerValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *PatchPotentialRoleRequestInner) SetValue(v UpdateMultiHostSourcesRequestInnerValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *PatchPotentialRoleRequestInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PeerGroupMember.md b/docs/tools/sdk/go/Reference/V2024/Models/PeerGroupMember.md new file mode 100644 index 000000000..4ab75c0db --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PeerGroupMember.md @@ -0,0 +1,142 @@ +--- +id: v2024-peer-group-member +title: PeerGroupMember +pagination_label: PeerGroupMember +sidebar_label: PeerGroupMember +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PeerGroupMember', 'V2024PeerGroupMember'] +slug: /tools/sdk/go/v2024/models/peer-group-member +tags: ['SDK', 'Software Development Kit', 'PeerGroupMember', 'V2024PeerGroupMember'] +--- + +# PeerGroupMember + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | A unique identifier for the peer group member. | [optional] +**Type** | Pointer to **string** | The type of the peer group member. | [optional] +**PeerGroupId** | Pointer to **string** | The ID of the peer group. | [optional] +**Attributes** | Pointer to **map[string]map[string]interface{}** | Arbitrary key-value pairs, belonging to the peer group member. | [optional] + +## Methods + +### NewPeerGroupMember + +`func NewPeerGroupMember() *PeerGroupMember` + +NewPeerGroupMember instantiates a new PeerGroupMember 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 + +### NewPeerGroupMemberWithDefaults + +`func NewPeerGroupMemberWithDefaults() *PeerGroupMember` + +NewPeerGroupMemberWithDefaults instantiates a new PeerGroupMember 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 + +### GetId + +`func (o *PeerGroupMember) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PeerGroupMember) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PeerGroupMember) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PeerGroupMember) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *PeerGroupMember) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *PeerGroupMember) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *PeerGroupMember) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *PeerGroupMember) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetPeerGroupId + +`func (o *PeerGroupMember) GetPeerGroupId() string` + +GetPeerGroupId returns the PeerGroupId field if non-nil, zero value otherwise. + +### GetPeerGroupIdOk + +`func (o *PeerGroupMember) GetPeerGroupIdOk() (*string, bool)` + +GetPeerGroupIdOk returns a tuple with the PeerGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPeerGroupId + +`func (o *PeerGroupMember) SetPeerGroupId(v string)` + +SetPeerGroupId sets PeerGroupId field to given value. + +### HasPeerGroupId + +`func (o *PeerGroupMember) HasPeerGroupId() bool` + +HasPeerGroupId returns a boolean if a field has been set. + +### GetAttributes + +`func (o *PeerGroupMember) GetAttributes() map[string]map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *PeerGroupMember) GetAttributesOk() (*map[string]map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *PeerGroupMember) SetAttributes(v map[string]map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *PeerGroupMember) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PendingApproval.md b/docs/tools/sdk/go/Reference/V2024/Models/PendingApproval.md new file mode 100644 index 000000000..9d78e5ce0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PendingApproval.md @@ -0,0 +1,650 @@ +--- +id: v2024-pending-approval +title: PendingApproval +pagination_label: PendingApproval +sidebar_label: PendingApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PendingApproval', 'V2024PendingApproval'] +slug: /tools/sdk/go/v2024/models/pending-approval +tags: ['SDK', 'Software Development Kit', 'PendingApproval', 'V2024PendingApproval'] +--- + +# PendingApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The approval id. | [optional] +**AccessRequestId** | Pointer to **string** | This is the access request id. | [optional] +**Name** | Pointer to **string** | The name of the approval. | [optional] +**Created** | Pointer to **SailPointTime** | When the approval was created. | [optional] +**Modified** | Pointer to **SailPointTime** | When the approval was modified last time. | [optional] +**RequestCreated** | Pointer to **SailPointTime** | When the access-request was created. | [optional] +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**AccessItemRequestedFor**](access-item-requested-for) | | [optional] +**Owner** | Pointer to [**PendingApprovalOwner**](pending-approval-owner) | | [optional] +**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**RequesterComment** | Pointer to [**CommentDto**](comment-dto) | | [optional] +**PreviousReviewersComments** | Pointer to [**[]CommentDto**](comment-dto) | The history of the previous reviewers comments. | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**CommentRequiredWhenRejected** | Pointer to **bool** | When true the rejector has to provide comments when rejecting | [optional] [default to false] +**ActionInProcess** | Pointer to [**PendingApprovalAction**](pending-approval-action) | | [optional] +**RemoveDate** | Pointer to **SailPointTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**RemoveDateUpdateRequested** | Pointer to **bool** | If true, then the request is to change the remove date or sunset date. | [optional] [default to false] +**CurrentRemoveDate** | Pointer to **SailPointTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**SodViolationContext** | Pointer to [**NullableSodViolationContextCheckCompleted**](sod-violation-context-check-completed) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional] +**RequestedAccounts** | Pointer to [**[]RequestedAccountRef**](requested-account-ref) | The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. | [optional] + +## Methods + +### NewPendingApproval + +`func NewPendingApproval() *PendingApproval` + +NewPendingApproval instantiates a new PendingApproval 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 + +### NewPendingApprovalWithDefaults + +`func NewPendingApprovalWithDefaults() *PendingApproval` + +NewPendingApprovalWithDefaults instantiates a new PendingApproval 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 + +### GetId + +`func (o *PendingApproval) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PendingApproval) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PendingApproval) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PendingApproval) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccessRequestId + +`func (o *PendingApproval) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *PendingApproval) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *PendingApproval) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + +### HasAccessRequestId + +`func (o *PendingApproval) HasAccessRequestId() bool` + +HasAccessRequestId returns a boolean if a field has been set. + +### GetName + +`func (o *PendingApproval) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PendingApproval) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PendingApproval) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PendingApproval) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *PendingApproval) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *PendingApproval) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *PendingApproval) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *PendingApproval) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *PendingApproval) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PendingApproval) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PendingApproval) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PendingApproval) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetRequestCreated + +`func (o *PendingApproval) GetRequestCreated() SailPointTime` + +GetRequestCreated returns the RequestCreated field if non-nil, zero value otherwise. + +### GetRequestCreatedOk + +`func (o *PendingApproval) GetRequestCreatedOk() (*SailPointTime, bool)` + +GetRequestCreatedOk returns a tuple with the RequestCreated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCreated + +`func (o *PendingApproval) SetRequestCreated(v SailPointTime)` + +SetRequestCreated sets RequestCreated field to given value. + +### HasRequestCreated + +`func (o *PendingApproval) HasRequestCreated() bool` + +HasRequestCreated returns a boolean if a field has been set. + +### GetRequestType + +`func (o *PendingApproval) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *PendingApproval) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *PendingApproval) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *PendingApproval) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *PendingApproval) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *PendingApproval) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetRequester + +`func (o *PendingApproval) GetRequester() AccessItemRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *PendingApproval) GetRequesterOk() (*AccessItemRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *PendingApproval) SetRequester(v AccessItemRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *PendingApproval) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRequestedFor + +`func (o *PendingApproval) GetRequestedFor() AccessItemRequestedFor` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *PendingApproval) GetRequestedForOk() (*AccessItemRequestedFor, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *PendingApproval) SetRequestedFor(v AccessItemRequestedFor)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *PendingApproval) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetOwner + +`func (o *PendingApproval) GetOwner() PendingApprovalOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *PendingApproval) GetOwnerOk() (*PendingApprovalOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *PendingApproval) SetOwner(v PendingApprovalOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *PendingApproval) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRequestedObject + +`func (o *PendingApproval) GetRequestedObject() RequestableObjectReference` + +GetRequestedObject returns the RequestedObject field if non-nil, zero value otherwise. + +### GetRequestedObjectOk + +`func (o *PendingApproval) GetRequestedObjectOk() (*RequestableObjectReference, bool)` + +GetRequestedObjectOk returns a tuple with the RequestedObject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObject + +`func (o *PendingApproval) SetRequestedObject(v RequestableObjectReference)` + +SetRequestedObject sets RequestedObject field to given value. + +### HasRequestedObject + +`func (o *PendingApproval) HasRequestedObject() bool` + +HasRequestedObject returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *PendingApproval) GetRequesterComment() CommentDto` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *PendingApproval) GetRequesterCommentOk() (*CommentDto, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *PendingApproval) SetRequesterComment(v CommentDto)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *PendingApproval) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### GetPreviousReviewersComments + +`func (o *PendingApproval) GetPreviousReviewersComments() []CommentDto` + +GetPreviousReviewersComments returns the PreviousReviewersComments field if non-nil, zero value otherwise. + +### GetPreviousReviewersCommentsOk + +`func (o *PendingApproval) GetPreviousReviewersCommentsOk() (*[]CommentDto, bool)` + +GetPreviousReviewersCommentsOk returns a tuple with the PreviousReviewersComments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousReviewersComments + +`func (o *PendingApproval) SetPreviousReviewersComments(v []CommentDto)` + +SetPreviousReviewersComments sets PreviousReviewersComments field to given value. + +### HasPreviousReviewersComments + +`func (o *PendingApproval) HasPreviousReviewersComments() bool` + +HasPreviousReviewersComments returns a boolean if a field has been set. + +### GetForwardHistory + +`func (o *PendingApproval) GetForwardHistory() []ApprovalForwardHistory` + +GetForwardHistory returns the ForwardHistory field if non-nil, zero value otherwise. + +### GetForwardHistoryOk + +`func (o *PendingApproval) GetForwardHistoryOk() (*[]ApprovalForwardHistory, bool)` + +GetForwardHistoryOk returns a tuple with the ForwardHistory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwardHistory + +`func (o *PendingApproval) SetForwardHistory(v []ApprovalForwardHistory)` + +SetForwardHistory sets ForwardHistory field to given value. + +### HasForwardHistory + +`func (o *PendingApproval) HasForwardHistory() bool` + +HasForwardHistory returns a boolean if a field has been set. + +### GetCommentRequiredWhenRejected + +`func (o *PendingApproval) GetCommentRequiredWhenRejected() bool` + +GetCommentRequiredWhenRejected returns the CommentRequiredWhenRejected field if non-nil, zero value otherwise. + +### GetCommentRequiredWhenRejectedOk + +`func (o *PendingApproval) GetCommentRequiredWhenRejectedOk() (*bool, bool)` + +GetCommentRequiredWhenRejectedOk returns a tuple with the CommentRequiredWhenRejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentRequiredWhenRejected + +`func (o *PendingApproval) SetCommentRequiredWhenRejected(v bool)` + +SetCommentRequiredWhenRejected sets CommentRequiredWhenRejected field to given value. + +### HasCommentRequiredWhenRejected + +`func (o *PendingApproval) HasCommentRequiredWhenRejected() bool` + +HasCommentRequiredWhenRejected returns a boolean if a field has been set. + +### GetActionInProcess + +`func (o *PendingApproval) GetActionInProcess() PendingApprovalAction` + +GetActionInProcess returns the ActionInProcess field if non-nil, zero value otherwise. + +### GetActionInProcessOk + +`func (o *PendingApproval) GetActionInProcessOk() (*PendingApprovalAction, bool)` + +GetActionInProcessOk returns a tuple with the ActionInProcess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActionInProcess + +`func (o *PendingApproval) SetActionInProcess(v PendingApprovalAction)` + +SetActionInProcess sets ActionInProcess field to given value. + +### HasActionInProcess + +`func (o *PendingApproval) HasActionInProcess() bool` + +HasActionInProcess returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *PendingApproval) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *PendingApproval) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *PendingApproval) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *PendingApproval) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetRemoveDateUpdateRequested + +`func (o *PendingApproval) GetRemoveDateUpdateRequested() bool` + +GetRemoveDateUpdateRequested returns the RemoveDateUpdateRequested field if non-nil, zero value otherwise. + +### GetRemoveDateUpdateRequestedOk + +`func (o *PendingApproval) GetRemoveDateUpdateRequestedOk() (*bool, bool)` + +GetRemoveDateUpdateRequestedOk returns a tuple with the RemoveDateUpdateRequested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDateUpdateRequested + +`func (o *PendingApproval) SetRemoveDateUpdateRequested(v bool)` + +SetRemoveDateUpdateRequested sets RemoveDateUpdateRequested field to given value. + +### HasRemoveDateUpdateRequested + +`func (o *PendingApproval) HasRemoveDateUpdateRequested() bool` + +HasRemoveDateUpdateRequested returns a boolean if a field has been set. + +### GetCurrentRemoveDate + +`func (o *PendingApproval) GetCurrentRemoveDate() SailPointTime` + +GetCurrentRemoveDate returns the CurrentRemoveDate field if non-nil, zero value otherwise. + +### GetCurrentRemoveDateOk + +`func (o *PendingApproval) GetCurrentRemoveDateOk() (*SailPointTime, bool)` + +GetCurrentRemoveDateOk returns a tuple with the CurrentRemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentRemoveDate + +`func (o *PendingApproval) SetCurrentRemoveDate(v SailPointTime)` + +SetCurrentRemoveDate sets CurrentRemoveDate field to given value. + +### HasCurrentRemoveDate + +`func (o *PendingApproval) HasCurrentRemoveDate() bool` + +HasCurrentRemoveDate returns a boolean if a field has been set. + +### GetSodViolationContext + +`func (o *PendingApproval) GetSodViolationContext() SodViolationContextCheckCompleted` + +GetSodViolationContext returns the SodViolationContext field if non-nil, zero value otherwise. + +### GetSodViolationContextOk + +`func (o *PendingApproval) GetSodViolationContextOk() (*SodViolationContextCheckCompleted, bool)` + +GetSodViolationContextOk returns a tuple with the SodViolationContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodViolationContext + +`func (o *PendingApproval) SetSodViolationContext(v SodViolationContextCheckCompleted)` + +SetSodViolationContext sets SodViolationContext field to given value. + +### HasSodViolationContext + +`func (o *PendingApproval) HasSodViolationContext() bool` + +HasSodViolationContext returns a boolean if a field has been set. + +### SetSodViolationContextNil + +`func (o *PendingApproval) SetSodViolationContextNil(b bool)` + + SetSodViolationContextNil sets the value for SodViolationContext to be an explicit nil + +### UnsetSodViolationContext +`func (o *PendingApproval) UnsetSodViolationContext()` + +UnsetSodViolationContext ensures that no value is present for SodViolationContext, not even an explicit nil +### GetClientMetadata + +`func (o *PendingApproval) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *PendingApproval) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *PendingApproval) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *PendingApproval) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *PendingApproval) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *PendingApproval) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetRequestedAccounts + +`func (o *PendingApproval) GetRequestedAccounts() []RequestedAccountRef` + +GetRequestedAccounts returns the RequestedAccounts field if non-nil, zero value otherwise. + +### GetRequestedAccountsOk + +`func (o *PendingApproval) GetRequestedAccountsOk() (*[]RequestedAccountRef, bool)` + +GetRequestedAccountsOk returns a tuple with the RequestedAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedAccounts + +`func (o *PendingApproval) SetRequestedAccounts(v []RequestedAccountRef)` + +SetRequestedAccounts sets RequestedAccounts field to given value. + +### HasRequestedAccounts + +`func (o *PendingApproval) HasRequestedAccounts() bool` + +HasRequestedAccounts returns a boolean if a field has been set. + +### SetRequestedAccountsNil + +`func (o *PendingApproval) SetRequestedAccountsNil(b bool)` + + SetRequestedAccountsNil sets the value for RequestedAccounts to be an explicit nil + +### UnsetRequestedAccounts +`func (o *PendingApproval) UnsetRequestedAccounts()` + +UnsetRequestedAccounts ensures that no value is present for RequestedAccounts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PendingApprovalAction.md b/docs/tools/sdk/go/Reference/V2024/Models/PendingApprovalAction.md new file mode 100644 index 000000000..ce696693e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PendingApprovalAction.md @@ -0,0 +1,23 @@ +--- +id: v2024-pending-approval-action +title: PendingApprovalAction +pagination_label: PendingApprovalAction +sidebar_label: PendingApprovalAction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PendingApprovalAction', 'V2024PendingApprovalAction'] +slug: /tools/sdk/go/v2024/models/pending-approval-action +tags: ['SDK', 'Software Development Kit', 'PendingApprovalAction', 'V2024PendingApprovalAction'] +--- + +# PendingApprovalAction + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `FORWARDED` (value: `"FORWARDED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PendingApprovalOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/PendingApprovalOwner.md new file mode 100644 index 000000000..a514b40e0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PendingApprovalOwner.md @@ -0,0 +1,116 @@ +--- +id: v2024-pending-approval-owner +title: PendingApprovalOwner +pagination_label: PendingApprovalOwner +sidebar_label: PendingApprovalOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PendingApprovalOwner', 'V2024PendingApprovalOwner'] +slug: /tools/sdk/go/v2024/models/pending-approval-owner +tags: ['SDK', 'Software Development Kit', 'PendingApprovalOwner', 'V2024PendingApprovalOwner'] +--- + +# PendingApprovalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Access item owner's DTO type. | [optional] +**Id** | Pointer to **string** | Access item owner's identity ID. | [optional] +**Name** | Pointer to **string** | Access item owner's human-readable display name. | [optional] + +## Methods + +### NewPendingApprovalOwner + +`func NewPendingApprovalOwner() *PendingApprovalOwner` + +NewPendingApprovalOwner instantiates a new PendingApprovalOwner 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 + +### NewPendingApprovalOwnerWithDefaults + +`func NewPendingApprovalOwnerWithDefaults() *PendingApprovalOwner` + +NewPendingApprovalOwnerWithDefaults instantiates a new PendingApprovalOwner 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 + +### GetType + +`func (o *PendingApprovalOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *PendingApprovalOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *PendingApprovalOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *PendingApprovalOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *PendingApprovalOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PendingApprovalOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PendingApprovalOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PendingApprovalOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *PendingApprovalOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PendingApprovalOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PendingApprovalOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PendingApprovalOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PermissionDto.md b/docs/tools/sdk/go/Reference/V2024/Models/PermissionDto.md new file mode 100644 index 000000000..0a6b04e1c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PermissionDto.md @@ -0,0 +1,90 @@ +--- +id: v2024-permission-dto +title: PermissionDto +pagination_label: PermissionDto +sidebar_label: PermissionDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PermissionDto', 'V2024PermissionDto'] +slug: /tools/sdk/go/v2024/models/permission-dto +tags: ['SDK', 'Software Development Kit', 'PermissionDto', 'V2024PermissionDto'] +--- + +# PermissionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Rights** | Pointer to **[]string** | All the rights (e.g. actions) that this permission allows on the target | [optional] [readonly] +**Target** | Pointer to **string** | The target the permission would grants rights on. | [optional] [readonly] + +## Methods + +### NewPermissionDto + +`func NewPermissionDto() *PermissionDto` + +NewPermissionDto instantiates a new PermissionDto 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 + +### NewPermissionDtoWithDefaults + +`func NewPermissionDtoWithDefaults() *PermissionDto` + +NewPermissionDtoWithDefaults instantiates a new PermissionDto 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 + +### GetRights + +`func (o *PermissionDto) GetRights() []string` + +GetRights returns the Rights field if non-nil, zero value otherwise. + +### GetRightsOk + +`func (o *PermissionDto) GetRightsOk() (*[]string, bool)` + +GetRightsOk returns a tuple with the Rights field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRights + +`func (o *PermissionDto) SetRights(v []string)` + +SetRights sets Rights field to given value. + +### HasRights + +`func (o *PermissionDto) HasRights() bool` + +HasRights returns a boolean if a field has been set. + +### GetTarget + +`func (o *PermissionDto) GetTarget() string` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *PermissionDto) GetTargetOk() (*string, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *PermissionDto) SetTarget(v string)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *PermissionDto) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PreApprovalTriggerDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/PreApprovalTriggerDetails.md new file mode 100644 index 000000000..9161ca450 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PreApprovalTriggerDetails.md @@ -0,0 +1,116 @@ +--- +id: v2024-pre-approval-trigger-details +title: PreApprovalTriggerDetails +pagination_label: PreApprovalTriggerDetails +sidebar_label: PreApprovalTriggerDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PreApprovalTriggerDetails', 'V2024PreApprovalTriggerDetails'] +slug: /tools/sdk/go/v2024/models/pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'PreApprovalTriggerDetails', 'V2024PreApprovalTriggerDetails'] +--- + +# PreApprovalTriggerDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment left for the pre-approval decision | [optional] +**Reviewer** | Pointer to **string** | The reviewer of the pre-approval decision | [optional] +**Decision** | Pointer to **string** | The decision of the pre-approval trigger | [optional] + +## Methods + +### NewPreApprovalTriggerDetails + +`func NewPreApprovalTriggerDetails() *PreApprovalTriggerDetails` + +NewPreApprovalTriggerDetails instantiates a new PreApprovalTriggerDetails 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 + +### NewPreApprovalTriggerDetailsWithDefaults + +`func NewPreApprovalTriggerDetailsWithDefaults() *PreApprovalTriggerDetails` + +NewPreApprovalTriggerDetailsWithDefaults instantiates a new PreApprovalTriggerDetails 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 + +### GetComment + +`func (o *PreApprovalTriggerDetails) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *PreApprovalTriggerDetails) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *PreApprovalTriggerDetails) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *PreApprovalTriggerDetails) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetReviewer + +`func (o *PreApprovalTriggerDetails) GetReviewer() string` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *PreApprovalTriggerDetails) GetReviewerOk() (*string, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *PreApprovalTriggerDetails) SetReviewer(v string)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *PreApprovalTriggerDetails) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetDecision + +`func (o *PreApprovalTriggerDetails) GetDecision() string` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *PreApprovalTriggerDetails) GetDecisionOk() (*string, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *PreApprovalTriggerDetails) SetDecision(v string)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *PreApprovalTriggerDetails) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PreferencesDto.md b/docs/tools/sdk/go/Reference/V2024/Models/PreferencesDto.md new file mode 100644 index 000000000..dce64c2b1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PreferencesDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-preferences-dto +title: PreferencesDto +pagination_label: PreferencesDto +sidebar_label: PreferencesDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PreferencesDto', 'V2024PreferencesDto'] +slug: /tools/sdk/go/v2024/models/preferences-dto +tags: ['SDK', 'Software Development Kit', 'PreferencesDto', 'V2024PreferencesDto'] +--- + +# PreferencesDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The template notification key. | [optional] +**Mediums** | Pointer to [**[]Medium**](medium) | List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. | [optional] +**Modified** | Pointer to **SailPointTime** | Modified date of preference | [optional] + +## Methods + +### NewPreferencesDto + +`func NewPreferencesDto() *PreferencesDto` + +NewPreferencesDto instantiates a new PreferencesDto 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 + +### NewPreferencesDtoWithDefaults + +`func NewPreferencesDtoWithDefaults() *PreferencesDto` + +NewPreferencesDtoWithDefaults instantiates a new PreferencesDto 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 + +### GetKey + +`func (o *PreferencesDto) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *PreferencesDto) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *PreferencesDto) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *PreferencesDto) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetMediums + +`func (o *PreferencesDto) GetMediums() []Medium` + +GetMediums returns the Mediums field if non-nil, zero value otherwise. + +### GetMediumsOk + +`func (o *PreferencesDto) GetMediumsOk() (*[]Medium, bool)` + +GetMediumsOk returns a tuple with the Mediums field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMediums + +`func (o *PreferencesDto) SetMediums(v []Medium)` + +SetMediums sets Mediums field to given value. + +### HasMediums + +`func (o *PreferencesDto) HasMediums() bool` + +HasMediums returns a boolean if a field has been set. + +### GetModified + +`func (o *PreferencesDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PreferencesDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PreferencesDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PreferencesDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PreviewDataSourceResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/PreviewDataSourceResponse.md new file mode 100644 index 000000000..4aef85e47 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PreviewDataSourceResponse.md @@ -0,0 +1,64 @@ +--- +id: v2024-preview-data-source-response +title: PreviewDataSourceResponse +pagination_label: PreviewDataSourceResponse +sidebar_label: PreviewDataSourceResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PreviewDataSourceResponse', 'V2024PreviewDataSourceResponse'] +slug: /tools/sdk/go/v2024/models/preview-data-source-response +tags: ['SDK', 'Software Development Kit', 'PreviewDataSourceResponse', 'V2024PreviewDataSourceResponse'] +--- + +# PreviewDataSourceResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | Pointer to [**[]FormElementDataSourceConfigOptions**](form-element-data-source-config-options) | Results holds a list of FormElementDataSourceConfigOptions items | [optional] + +## Methods + +### NewPreviewDataSourceResponse + +`func NewPreviewDataSourceResponse() *PreviewDataSourceResponse` + +NewPreviewDataSourceResponse instantiates a new PreviewDataSourceResponse 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 + +### NewPreviewDataSourceResponseWithDefaults + +`func NewPreviewDataSourceResponseWithDefaults() *PreviewDataSourceResponse` + +NewPreviewDataSourceResponseWithDefaults instantiates a new PreviewDataSourceResponse 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 + +### GetResults + +`func (o *PreviewDataSourceResponse) GetResults() []FormElementDataSourceConfigOptions` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PreviewDataSourceResponse) GetResultsOk() (*[]FormElementDataSourceConfigOptions, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PreviewDataSourceResponse) SetResults(v []FormElementDataSourceConfigOptions)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PreviewDataSourceResponse) HasResults() bool` + +HasResults returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProcessIdentitiesRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/ProcessIdentitiesRequest.md new file mode 100644 index 000000000..9714b56b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProcessIdentitiesRequest.md @@ -0,0 +1,64 @@ +--- +id: v2024-process-identities-request +title: ProcessIdentitiesRequest +pagination_label: ProcessIdentitiesRequest +sidebar_label: ProcessIdentitiesRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProcessIdentitiesRequest', 'V2024ProcessIdentitiesRequest'] +slug: /tools/sdk/go/v2024/models/process-identities-request +tags: ['SDK', 'Software Development Kit', 'ProcessIdentitiesRequest', 'V2024ProcessIdentitiesRequest'] +--- + +# ProcessIdentitiesRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityIds** | Pointer to **[]string** | List of up to 250 identity IDs to process. | [optional] + +## Methods + +### NewProcessIdentitiesRequest + +`func NewProcessIdentitiesRequest() *ProcessIdentitiesRequest` + +NewProcessIdentitiesRequest instantiates a new ProcessIdentitiesRequest 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 + +### NewProcessIdentitiesRequestWithDefaults + +`func NewProcessIdentitiesRequestWithDefaults() *ProcessIdentitiesRequest` + +NewProcessIdentitiesRequestWithDefaults instantiates a new ProcessIdentitiesRequest 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 + +### GetIdentityIds + +`func (o *ProcessIdentitiesRequest) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *ProcessIdentitiesRequest) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *ProcessIdentitiesRequest) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *ProcessIdentitiesRequest) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProcessingDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/ProcessingDetails.md new file mode 100644 index 000000000..05ae45e42 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProcessingDetails.md @@ -0,0 +1,178 @@ +--- +id: v2024-processing-details +title: ProcessingDetails +pagination_label: ProcessingDetails +sidebar_label: ProcessingDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProcessingDetails', 'V2024ProcessingDetails'] +slug: /tools/sdk/go/v2024/models/processing-details +tags: ['SDK', 'Software Development Kit', 'ProcessingDetails', 'V2024ProcessingDetails'] +--- + +# ProcessingDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Stage** | Pointer to **string** | | [optional] +**RetryCount** | Pointer to **int32** | | [optional] +**StackTrace** | Pointer to **string** | | [optional] +**Message** | Pointer to **string** | | [optional] + +## Methods + +### NewProcessingDetails + +`func NewProcessingDetails() *ProcessingDetails` + +NewProcessingDetails instantiates a new ProcessingDetails 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 + +### NewProcessingDetailsWithDefaults + +`func NewProcessingDetailsWithDefaults() *ProcessingDetails` + +NewProcessingDetailsWithDefaults instantiates a new ProcessingDetails 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 + +### GetDate + +`func (o *ProcessingDetails) GetDate() SailPointTime` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *ProcessingDetails) GetDateOk() (*SailPointTime, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *ProcessingDetails) SetDate(v SailPointTime)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *ProcessingDetails) HasDate() bool` + +HasDate returns a boolean if a field has been set. + +### SetDateNil + +`func (o *ProcessingDetails) SetDateNil(b bool)` + + SetDateNil sets the value for Date to be an explicit nil + +### UnsetDate +`func (o *ProcessingDetails) UnsetDate()` + +UnsetDate ensures that no value is present for Date, not even an explicit nil +### GetStage + +`func (o *ProcessingDetails) GetStage() string` + +GetStage returns the Stage field if non-nil, zero value otherwise. + +### GetStageOk + +`func (o *ProcessingDetails) GetStageOk() (*string, bool)` + +GetStageOk returns a tuple with the Stage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStage + +`func (o *ProcessingDetails) SetStage(v string)` + +SetStage sets Stage field to given value. + +### HasStage + +`func (o *ProcessingDetails) HasStage() bool` + +HasStage returns a boolean if a field has been set. + +### GetRetryCount + +`func (o *ProcessingDetails) GetRetryCount() int32` + +GetRetryCount returns the RetryCount field if non-nil, zero value otherwise. + +### GetRetryCountOk + +`func (o *ProcessingDetails) GetRetryCountOk() (*int32, bool)` + +GetRetryCountOk returns a tuple with the RetryCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRetryCount + +`func (o *ProcessingDetails) SetRetryCount(v int32)` + +SetRetryCount sets RetryCount field to given value. + +### HasRetryCount + +`func (o *ProcessingDetails) HasRetryCount() bool` + +HasRetryCount returns a boolean if a field has been set. + +### GetStackTrace + +`func (o *ProcessingDetails) GetStackTrace() string` + +GetStackTrace returns the StackTrace field if non-nil, zero value otherwise. + +### GetStackTraceOk + +`func (o *ProcessingDetails) GetStackTraceOk() (*string, bool)` + +GetStackTraceOk returns a tuple with the StackTrace field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStackTrace + +`func (o *ProcessingDetails) SetStackTrace(v string)` + +SetStackTrace sets StackTrace field to given value. + +### HasStackTrace + +`func (o *ProcessingDetails) HasStackTrace() bool` + +HasStackTrace returns a boolean if a field has been set. + +### GetMessage + +`func (o *ProcessingDetails) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *ProcessingDetails) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *ProcessingDetails) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *ProcessingDetails) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Product.md b/docs/tools/sdk/go/Reference/V2024/Models/Product.md new file mode 100644 index 000000000..51aebb003 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Product.md @@ -0,0 +1,494 @@ +--- +id: v2024-product +title: Product +pagination_label: Product +sidebar_label: Product +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Product', 'V2024Product'] +slug: /tools/sdk/go/v2024/models/product +tags: ['SDK', 'Software Development Kit', 'Product', 'V2024Product'] +--- + +# Product + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProductName** | Pointer to **string** | Name of the Product | [optional] +**Url** | Pointer to **string** | URL of the Product | [optional] +**ProductTenantId** | Pointer to **string** | An identifier for a specific product-tenant combination | [optional] +**ProductRegion** | Pointer to **string** | Product region | [optional] +**ProductRight** | Pointer to **string** | Right needed for the Product | [optional] +**ApiUrl** | Pointer to **NullableString** | API URL of the Product | [optional] +**Licenses** | Pointer to [**[]License**](license) | | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Additional attributes for a product | [optional] +**Zone** | Pointer to **string** | Zone | [optional] +**Status** | Pointer to **string** | Status of the product | [optional] +**StatusDateTime** | Pointer to **SailPointTime** | Status datetime | [optional] +**Reason** | Pointer to **string** | If there's a tenant provisioning failure then reason will have the description of error | [optional] +**Notes** | Pointer to **string** | Product could have additional notes added during tenant provisioning. | [optional] +**DateCreated** | Pointer to **NullableTime** | Date when the product was created | [optional] +**LastUpdated** | Pointer to **NullableTime** | Date when the product was last updated | [optional] +**OrgType** | Pointer to **NullableString** | Type of org | [optional] + +## Methods + +### NewProduct + +`func NewProduct() *Product` + +NewProduct instantiates a new Product 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 + +### NewProductWithDefaults + +`func NewProductWithDefaults() *Product` + +NewProductWithDefaults instantiates a new Product 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 + +### GetProductName + +`func (o *Product) GetProductName() string` + +GetProductName returns the ProductName field if non-nil, zero value otherwise. + +### GetProductNameOk + +`func (o *Product) GetProductNameOk() (*string, bool)` + +GetProductNameOk returns a tuple with the ProductName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductName + +`func (o *Product) SetProductName(v string)` + +SetProductName sets ProductName field to given value. + +### HasProductName + +`func (o *Product) HasProductName() bool` + +HasProductName returns a boolean if a field has been set. + +### GetUrl + +`func (o *Product) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *Product) GetUrlOk() (*string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrl + +`func (o *Product) SetUrl(v string)` + +SetUrl sets Url field to given value. + +### HasUrl + +`func (o *Product) HasUrl() bool` + +HasUrl returns a boolean if a field has been set. + +### GetProductTenantId + +`func (o *Product) GetProductTenantId() string` + +GetProductTenantId returns the ProductTenantId field if non-nil, zero value otherwise. + +### GetProductTenantIdOk + +`func (o *Product) GetProductTenantIdOk() (*string, bool)` + +GetProductTenantIdOk returns a tuple with the ProductTenantId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductTenantId + +`func (o *Product) SetProductTenantId(v string)` + +SetProductTenantId sets ProductTenantId field to given value. + +### HasProductTenantId + +`func (o *Product) HasProductTenantId() bool` + +HasProductTenantId returns a boolean if a field has been set. + +### GetProductRegion + +`func (o *Product) GetProductRegion() string` + +GetProductRegion returns the ProductRegion field if non-nil, zero value otherwise. + +### GetProductRegionOk + +`func (o *Product) GetProductRegionOk() (*string, bool)` + +GetProductRegionOk returns a tuple with the ProductRegion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductRegion + +`func (o *Product) SetProductRegion(v string)` + +SetProductRegion sets ProductRegion field to given value. + +### HasProductRegion + +`func (o *Product) HasProductRegion() bool` + +HasProductRegion returns a boolean if a field has been set. + +### GetProductRight + +`func (o *Product) GetProductRight() string` + +GetProductRight returns the ProductRight field if non-nil, zero value otherwise. + +### GetProductRightOk + +`func (o *Product) GetProductRightOk() (*string, bool)` + +GetProductRightOk returns a tuple with the ProductRight field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductRight + +`func (o *Product) SetProductRight(v string)` + +SetProductRight sets ProductRight field to given value. + +### HasProductRight + +`func (o *Product) HasProductRight() bool` + +HasProductRight returns a boolean if a field has been set. + +### GetApiUrl + +`func (o *Product) GetApiUrl() string` + +GetApiUrl returns the ApiUrl field if non-nil, zero value otherwise. + +### GetApiUrlOk + +`func (o *Product) GetApiUrlOk() (*string, bool)` + +GetApiUrlOk returns a tuple with the ApiUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiUrl + +`func (o *Product) SetApiUrl(v string)` + +SetApiUrl sets ApiUrl field to given value. + +### HasApiUrl + +`func (o *Product) HasApiUrl() bool` + +HasApiUrl returns a boolean if a field has been set. + +### SetApiUrlNil + +`func (o *Product) SetApiUrlNil(b bool)` + + SetApiUrlNil sets the value for ApiUrl to be an explicit nil + +### UnsetApiUrl +`func (o *Product) UnsetApiUrl()` + +UnsetApiUrl ensures that no value is present for ApiUrl, not even an explicit nil +### GetLicenses + +`func (o *Product) GetLicenses() []License` + +GetLicenses returns the Licenses field if non-nil, zero value otherwise. + +### GetLicensesOk + +`func (o *Product) GetLicensesOk() (*[]License, bool)` + +GetLicensesOk returns a tuple with the Licenses field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLicenses + +`func (o *Product) SetLicenses(v []License)` + +SetLicenses sets Licenses field to given value. + +### HasLicenses + +`func (o *Product) HasLicenses() bool` + +HasLicenses returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Product) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Product) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Product) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Product) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetZone + +`func (o *Product) GetZone() string` + +GetZone returns the Zone field if non-nil, zero value otherwise. + +### GetZoneOk + +`func (o *Product) GetZoneOk() (*string, bool)` + +GetZoneOk returns a tuple with the Zone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetZone + +`func (o *Product) SetZone(v string)` + +SetZone sets Zone field to given value. + +### HasZone + +`func (o *Product) HasZone() bool` + +HasZone returns a boolean if a field has been set. + +### GetStatus + +`func (o *Product) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Product) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Product) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Product) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetStatusDateTime + +`func (o *Product) GetStatusDateTime() SailPointTime` + +GetStatusDateTime returns the StatusDateTime field if non-nil, zero value otherwise. + +### GetStatusDateTimeOk + +`func (o *Product) GetStatusDateTimeOk() (*SailPointTime, bool)` + +GetStatusDateTimeOk returns a tuple with the StatusDateTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusDateTime + +`func (o *Product) SetStatusDateTime(v SailPointTime)` + +SetStatusDateTime sets StatusDateTime field to given value. + +### HasStatusDateTime + +`func (o *Product) HasStatusDateTime() bool` + +HasStatusDateTime returns a boolean if a field has been set. + +### GetReason + +`func (o *Product) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *Product) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *Product) SetReason(v string)` + +SetReason sets Reason field to given value. + +### HasReason + +`func (o *Product) HasReason() bool` + +HasReason returns a boolean if a field has been set. + +### GetNotes + +`func (o *Product) GetNotes() string` + +GetNotes returns the Notes field if non-nil, zero value otherwise. + +### GetNotesOk + +`func (o *Product) GetNotesOk() (*string, bool)` + +GetNotesOk returns a tuple with the Notes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotes + +`func (o *Product) SetNotes(v string)` + +SetNotes sets Notes field to given value. + +### HasNotes + +`func (o *Product) HasNotes() bool` + +HasNotes returns a boolean if a field has been set. + +### GetDateCreated + +`func (o *Product) GetDateCreated() SailPointTime` + +GetDateCreated returns the DateCreated field if non-nil, zero value otherwise. + +### GetDateCreatedOk + +`func (o *Product) GetDateCreatedOk() (*SailPointTime, bool)` + +GetDateCreatedOk returns a tuple with the DateCreated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDateCreated + +`func (o *Product) SetDateCreated(v SailPointTime)` + +SetDateCreated sets DateCreated field to given value. + +### HasDateCreated + +`func (o *Product) HasDateCreated() bool` + +HasDateCreated returns a boolean if a field has been set. + +### SetDateCreatedNil + +`func (o *Product) SetDateCreatedNil(b bool)` + + SetDateCreatedNil sets the value for DateCreated to be an explicit nil + +### UnsetDateCreated +`func (o *Product) UnsetDateCreated()` + +UnsetDateCreated ensures that no value is present for DateCreated, not even an explicit nil +### GetLastUpdated + +`func (o *Product) GetLastUpdated() SailPointTime` + +GetLastUpdated returns the LastUpdated field if non-nil, zero value otherwise. + +### GetLastUpdatedOk + +`func (o *Product) GetLastUpdatedOk() (*SailPointTime, bool)` + +GetLastUpdatedOk returns a tuple with the LastUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdated + +`func (o *Product) SetLastUpdated(v SailPointTime)` + +SetLastUpdated sets LastUpdated field to given value. + +### HasLastUpdated + +`func (o *Product) HasLastUpdated() bool` + +HasLastUpdated returns a boolean if a field has been set. + +### SetLastUpdatedNil + +`func (o *Product) SetLastUpdatedNil(b bool)` + + SetLastUpdatedNil sets the value for LastUpdated to be an explicit nil + +### UnsetLastUpdated +`func (o *Product) UnsetLastUpdated()` + +UnsetLastUpdated ensures that no value is present for LastUpdated, not even an explicit nil +### GetOrgType + +`func (o *Product) GetOrgType() string` + +GetOrgType returns the OrgType field if non-nil, zero value otherwise. + +### GetOrgTypeOk + +`func (o *Product) GetOrgTypeOk() (*string, bool)` + +GetOrgTypeOk returns a tuple with the OrgType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgType + +`func (o *Product) SetOrgType(v string)` + +SetOrgType sets OrgType field to given value. + +### HasOrgType + +`func (o *Product) HasOrgType() bool` + +HasOrgType returns a boolean if a field has been set. + +### SetOrgTypeNil + +`func (o *Product) SetOrgTypeNil(b bool)` + + SetOrgTypeNil sets the value for OrgType to be an explicit nil + +### UnsetOrgType +`func (o *Product) UnsetOrgType()` + +UnsetOrgType ensures that no value is present for OrgType, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompleted.md b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompleted.md new file mode 100644 index 000000000..5aeadb52b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompleted.md @@ -0,0 +1,266 @@ +--- +id: v2024-provisioning-completed +title: ProvisioningCompleted +pagination_label: ProvisioningCompleted +sidebar_label: ProvisioningCompleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompleted', 'V2024ProvisioningCompleted'] +slug: /tools/sdk/go/v2024/models/provisioning-completed +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompleted', 'V2024ProvisioningCompleted'] +--- + +# ProvisioningCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TrackingNumber** | **string** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | +**Sources** | **string** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | +**Action** | Pointer to **NullableString** | Origin of where the provisioning request came from. | [optional] +**Errors** | Pointer to **[]string** | A list of any accumulated error messages that occurred during provisioning. | [optional] +**Warnings** | Pointer to **[]string** | A list of any accumulated warning messages that occurred during provisioning. | [optional] +**Recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | +**Requester** | Pointer to [**NullableProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional] +**AccountRequests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | + +## Methods + +### NewProvisioningCompleted + +`func NewProvisioningCompleted(trackingNumber string, sources string, recipient ProvisioningCompletedRecipient, accountRequests []ProvisioningCompletedAccountRequestsInner, ) *ProvisioningCompleted` + +NewProvisioningCompleted instantiates a new ProvisioningCompleted 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 + +### NewProvisioningCompletedWithDefaults + +`func NewProvisioningCompletedWithDefaults() *ProvisioningCompleted` + +NewProvisioningCompletedWithDefaults instantiates a new ProvisioningCompleted 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 + +### GetTrackingNumber + +`func (o *ProvisioningCompleted) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *ProvisioningCompleted) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *ProvisioningCompleted) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + + +### GetSources + +`func (o *ProvisioningCompleted) GetSources() string` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *ProvisioningCompleted) GetSourcesOk() (*string, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *ProvisioningCompleted) SetSources(v string)` + +SetSources sets Sources field to given value. + + +### GetAction + +`func (o *ProvisioningCompleted) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *ProvisioningCompleted) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *ProvisioningCompleted) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *ProvisioningCompleted) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### SetActionNil + +`func (o *ProvisioningCompleted) SetActionNil(b bool)` + + SetActionNil sets the value for Action to be an explicit nil + +### UnsetAction +`func (o *ProvisioningCompleted) UnsetAction()` + +UnsetAction ensures that no value is present for Action, not even an explicit nil +### GetErrors + +`func (o *ProvisioningCompleted) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *ProvisioningCompleted) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *ProvisioningCompleted) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *ProvisioningCompleted) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### SetErrorsNil + +`func (o *ProvisioningCompleted) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *ProvisioningCompleted) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *ProvisioningCompleted) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *ProvisioningCompleted) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *ProvisioningCompleted) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *ProvisioningCompleted) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + +### SetWarningsNil + +`func (o *ProvisioningCompleted) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *ProvisioningCompleted) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetRecipient + +`func (o *ProvisioningCompleted) GetRecipient() ProvisioningCompletedRecipient` + +GetRecipient returns the Recipient field if non-nil, zero value otherwise. + +### GetRecipientOk + +`func (o *ProvisioningCompleted) GetRecipientOk() (*ProvisioningCompletedRecipient, bool)` + +GetRecipientOk returns a tuple with the Recipient field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipient + +`func (o *ProvisioningCompleted) SetRecipient(v ProvisioningCompletedRecipient)` + +SetRecipient sets Recipient field to given value. + + +### GetRequester + +`func (o *ProvisioningCompleted) GetRequester() ProvisioningCompletedRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *ProvisioningCompleted) GetRequesterOk() (*ProvisioningCompletedRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *ProvisioningCompleted) SetRequester(v ProvisioningCompletedRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *ProvisioningCompleted) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### SetRequesterNil + +`func (o *ProvisioningCompleted) SetRequesterNil(b bool)` + + SetRequesterNil sets the value for Requester to be an explicit nil + +### UnsetRequester +`func (o *ProvisioningCompleted) UnsetRequester()` + +UnsetRequester ensures that no value is present for Requester, not even an explicit nil +### GetAccountRequests + +`func (o *ProvisioningCompleted) GetAccountRequests() []ProvisioningCompletedAccountRequestsInner` + +GetAccountRequests returns the AccountRequests field if non-nil, zero value otherwise. + +### GetAccountRequestsOk + +`func (o *ProvisioningCompleted) GetAccountRequestsOk() (*[]ProvisioningCompletedAccountRequestsInner, bool)` + +GetAccountRequestsOk returns a tuple with the AccountRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountRequests + +`func (o *ProvisioningCompleted) SetAccountRequests(v []ProvisioningCompletedAccountRequestsInner)` + +SetAccountRequests sets AccountRequests field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInner.md b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInner.md new file mode 100644 index 000000000..1e2f13f6b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInner.md @@ -0,0 +1,220 @@ +--- +id: v2024-provisioning-completed-account-requests-inner +title: ProvisioningCompletedAccountRequestsInner +pagination_label: ProvisioningCompletedAccountRequestsInner +sidebar_label: ProvisioningCompletedAccountRequestsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompletedAccountRequestsInner', 'V2024ProvisioningCompletedAccountRequestsInner'] +slug: /tools/sdk/go/v2024/models/provisioning-completed-account-requests-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInner', 'V2024ProvisioningCompletedAccountRequestsInner'] +--- + +# ProvisioningCompletedAccountRequestsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**ProvisioningCompletedAccountRequestsInnerSource**](provisioning-completed-account-requests-inner-source) | | +**AccountId** | Pointer to **string** | The unique idenfier of the account being provisioned. | [optional] +**AccountOperation** | **string** | The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. | +**ProvisioningResult** | **map[string]interface{}** | The overall result of the provisioning transaction; this could be success, pending, failed, etc. | +**ProvisioningTarget** | **string** | The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). | +**TicketId** | Pointer to **NullableString** | A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). | [optional] +**AttributeRequests** | Pointer to [**[]ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner**](provisioning-completed-account-requests-inner-attribute-requests-inner) | A list of attributes as part of the provisioning transaction. | [optional] + +## Methods + +### NewProvisioningCompletedAccountRequestsInner + +`func NewProvisioningCompletedAccountRequestsInner(source ProvisioningCompletedAccountRequestsInnerSource, accountOperation string, provisioningResult map[string]interface{}, provisioningTarget string, ) *ProvisioningCompletedAccountRequestsInner` + +NewProvisioningCompletedAccountRequestsInner instantiates a new ProvisioningCompletedAccountRequestsInner 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 + +### NewProvisioningCompletedAccountRequestsInnerWithDefaults + +`func NewProvisioningCompletedAccountRequestsInnerWithDefaults() *ProvisioningCompletedAccountRequestsInner` + +NewProvisioningCompletedAccountRequestsInnerWithDefaults instantiates a new ProvisioningCompletedAccountRequestsInner 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 + +### GetSource + +`func (o *ProvisioningCompletedAccountRequestsInner) GetSource() ProvisioningCompletedAccountRequestsInnerSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetSourceOk() (*ProvisioningCompletedAccountRequestsInnerSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *ProvisioningCompletedAccountRequestsInner) SetSource(v ProvisioningCompletedAccountRequestsInnerSource)` + +SetSource sets Source field to given value. + + +### GetAccountId + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *ProvisioningCompletedAccountRequestsInner) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *ProvisioningCompletedAccountRequestsInner) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetAccountOperation + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAccountOperation() string` + +GetAccountOperation returns the AccountOperation field if non-nil, zero value otherwise. + +### GetAccountOperationOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAccountOperationOk() (*string, bool)` + +GetAccountOperationOk returns a tuple with the AccountOperation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountOperation + +`func (o *ProvisioningCompletedAccountRequestsInner) SetAccountOperation(v string)` + +SetAccountOperation sets AccountOperation field to given value. + + +### GetProvisioningResult + +`func (o *ProvisioningCompletedAccountRequestsInner) GetProvisioningResult() map[string]interface{}` + +GetProvisioningResult returns the ProvisioningResult field if non-nil, zero value otherwise. + +### GetProvisioningResultOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetProvisioningResultOk() (*map[string]interface{}, bool)` + +GetProvisioningResultOk returns a tuple with the ProvisioningResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningResult + +`func (o *ProvisioningCompletedAccountRequestsInner) SetProvisioningResult(v map[string]interface{})` + +SetProvisioningResult sets ProvisioningResult field to given value. + + +### GetProvisioningTarget + +`func (o *ProvisioningCompletedAccountRequestsInner) GetProvisioningTarget() string` + +GetProvisioningTarget returns the ProvisioningTarget field if non-nil, zero value otherwise. + +### GetProvisioningTargetOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetProvisioningTargetOk() (*string, bool)` + +GetProvisioningTargetOk returns a tuple with the ProvisioningTarget field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningTarget + +`func (o *ProvisioningCompletedAccountRequestsInner) SetProvisioningTarget(v string)` + +SetProvisioningTarget sets ProvisioningTarget field to given value. + + +### GetTicketId + +`func (o *ProvisioningCompletedAccountRequestsInner) GetTicketId() string` + +GetTicketId returns the TicketId field if non-nil, zero value otherwise. + +### GetTicketIdOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetTicketIdOk() (*string, bool)` + +GetTicketIdOk returns a tuple with the TicketId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTicketId + +`func (o *ProvisioningCompletedAccountRequestsInner) SetTicketId(v string)` + +SetTicketId sets TicketId field to given value. + +### HasTicketId + +`func (o *ProvisioningCompletedAccountRequestsInner) HasTicketId() bool` + +HasTicketId returns a boolean if a field has been set. + +### SetTicketIdNil + +`func (o *ProvisioningCompletedAccountRequestsInner) SetTicketIdNil(b bool)` + + SetTicketIdNil sets the value for TicketId to be an explicit nil + +### UnsetTicketId +`func (o *ProvisioningCompletedAccountRequestsInner) UnsetTicketId()` + +UnsetTicketId ensures that no value is present for TicketId, not even an explicit nil +### GetAttributeRequests + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAttributeRequests() []ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner` + +GetAttributeRequests returns the AttributeRequests field if non-nil, zero value otherwise. + +### GetAttributeRequestsOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAttributeRequestsOk() (*[]ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner, bool)` + +GetAttributeRequestsOk returns a tuple with the AttributeRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeRequests + +`func (o *ProvisioningCompletedAccountRequestsInner) SetAttributeRequests(v []ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner)` + +SetAttributeRequests sets AttributeRequests field to given value. + +### HasAttributeRequests + +`func (o *ProvisioningCompletedAccountRequestsInner) HasAttributeRequests() bool` + +HasAttributeRequests returns a boolean if a field has been set. + +### SetAttributeRequestsNil + +`func (o *ProvisioningCompletedAccountRequestsInner) SetAttributeRequestsNil(b bool)` + + SetAttributeRequestsNil sets the value for AttributeRequests to be an explicit nil + +### UnsetAttributeRequests +`func (o *ProvisioningCompletedAccountRequestsInner) UnsetAttributeRequests()` + +UnsetAttributeRequests ensures that no value is present for AttributeRequests, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md new file mode 100644 index 000000000..70d6abd35 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md @@ -0,0 +1,116 @@ +--- +id: v2024-provisioning-completed-account-requests-inner-attribute-requests-inner +title: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +pagination_label: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +sidebar_label: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner', 'V2024ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner'] +slug: /tools/sdk/go/v2024/models/provisioning-completed-account-requests-inner-attribute-requests-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner', 'V2024ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner'] +--- + +# ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeName** | **string** | The name of the attribute being provisioned. | +**AttributeValue** | Pointer to **NullableString** | The value of the attribute being provisioned. | [optional] +**Operation** | **map[string]interface{}** | The operation to handle the attribute. | + +## Methods + +### NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInner + +`func NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInner(attributeName string, operation map[string]interface{}, ) *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner` + +NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInner instantiates a new ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner 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 + +### NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerWithDefaults + +`func NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerWithDefaults() *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner` + +NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerWithDefaults instantiates a new ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner 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 + +### GetAttributeName + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + + +### GetAttributeValue + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetAttributeValue() string` + +GetAttributeValue returns the AttributeValue field if non-nil, zero value otherwise. + +### GetAttributeValueOk + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetAttributeValueOk() (*string, bool)` + +GetAttributeValueOk returns a tuple with the AttributeValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeValue + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) SetAttributeValue(v string)` + +SetAttributeValue sets AttributeValue field to given value. + +### HasAttributeValue + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) HasAttributeValue() bool` + +HasAttributeValue returns a boolean if a field has been set. + +### SetAttributeValueNil + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) SetAttributeValueNil(b bool)` + + SetAttributeValueNil sets the value for AttributeValue to be an explicit nil + +### UnsetAttributeValue +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) UnsetAttributeValue()` + +UnsetAttributeValue ensures that no value is present for AttributeValue, not even an explicit nil +### GetOperation + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetOperation() map[string]interface{}` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetOperationOk() (*map[string]interface{}, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) SetOperation(v map[string]interface{})` + +SetOperation sets Operation field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInnerSource.md b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInnerSource.md new file mode 100644 index 000000000..b0cb5fc2a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInnerSource.md @@ -0,0 +1,101 @@ +--- +id: v2024-provisioning-completed-account-requests-inner-source +title: ProvisioningCompletedAccountRequestsInnerSource +pagination_label: ProvisioningCompletedAccountRequestsInnerSource +sidebar_label: ProvisioningCompletedAccountRequestsInnerSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompletedAccountRequestsInnerSource', 'V2024ProvisioningCompletedAccountRequestsInnerSource'] +slug: /tools/sdk/go/v2024/models/provisioning-completed-account-requests-inner-source +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInnerSource', 'V2024ProvisioningCompletedAccountRequestsInnerSource'] +--- + +# ProvisioningCompletedAccountRequestsInnerSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the object to which this reference applies | +**Type** | **string** | The type of object that is referenced | +**Name** | **string** | Human-readable display name of the object to which this reference applies | + +## Methods + +### NewProvisioningCompletedAccountRequestsInnerSource + +`func NewProvisioningCompletedAccountRequestsInnerSource(id string, type_ string, name string, ) *ProvisioningCompletedAccountRequestsInnerSource` + +NewProvisioningCompletedAccountRequestsInnerSource instantiates a new ProvisioningCompletedAccountRequestsInnerSource 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 + +### NewProvisioningCompletedAccountRequestsInnerSourceWithDefaults + +`func NewProvisioningCompletedAccountRequestsInnerSourceWithDefaults() *ProvisioningCompletedAccountRequestsInnerSource` + +NewProvisioningCompletedAccountRequestsInnerSourceWithDefaults instantiates a new ProvisioningCompletedAccountRequestsInnerSource 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 + +### GetId + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetName + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompletedRecipient.md b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompletedRecipient.md new file mode 100644 index 000000000..8e55f4173 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompletedRecipient.md @@ -0,0 +1,101 @@ +--- +id: v2024-provisioning-completed-recipient +title: ProvisioningCompletedRecipient +pagination_label: ProvisioningCompletedRecipient +sidebar_label: ProvisioningCompletedRecipient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompletedRecipient', 'V2024ProvisioningCompletedRecipient'] +slug: /tools/sdk/go/v2024/models/provisioning-completed-recipient +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedRecipient', 'V2024ProvisioningCompletedRecipient'] +--- + +# ProvisioningCompletedRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Provisioning recipient DTO type. | +**Id** | **string** | Provisioning recipient's identity ID. | +**Name** | **string** | Provisioning recipient's display name. | + +## Methods + +### NewProvisioningCompletedRecipient + +`func NewProvisioningCompletedRecipient(type_ string, id string, name string, ) *ProvisioningCompletedRecipient` + +NewProvisioningCompletedRecipient instantiates a new ProvisioningCompletedRecipient 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 + +### NewProvisioningCompletedRecipientWithDefaults + +`func NewProvisioningCompletedRecipientWithDefaults() *ProvisioningCompletedRecipient` + +NewProvisioningCompletedRecipientWithDefaults instantiates a new ProvisioningCompletedRecipient 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 + +### GetType + +`func (o *ProvisioningCompletedRecipient) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ProvisioningCompletedRecipient) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ProvisioningCompletedRecipient) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *ProvisioningCompletedRecipient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ProvisioningCompletedRecipient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ProvisioningCompletedRecipient) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *ProvisioningCompletedRecipient) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningCompletedRecipient) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningCompletedRecipient) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompletedRequester.md b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompletedRequester.md new file mode 100644 index 000000000..20b8883ae --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCompletedRequester.md @@ -0,0 +1,101 @@ +--- +id: v2024-provisioning-completed-requester +title: ProvisioningCompletedRequester +pagination_label: ProvisioningCompletedRequester +sidebar_label: ProvisioningCompletedRequester +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompletedRequester', 'V2024ProvisioningCompletedRequester'] +slug: /tools/sdk/go/v2024/models/provisioning-completed-requester +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedRequester', 'V2024ProvisioningCompletedRequester'] +--- + +# ProvisioningCompletedRequester + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Provisioning requester's DTO type. | +**Id** | **string** | Provisioning requester's identity ID. | +**Name** | **string** | Provisioning owner's human-readable display name. | + +## Methods + +### NewProvisioningCompletedRequester + +`func NewProvisioningCompletedRequester(type_ string, id string, name string, ) *ProvisioningCompletedRequester` + +NewProvisioningCompletedRequester instantiates a new ProvisioningCompletedRequester 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 + +### NewProvisioningCompletedRequesterWithDefaults + +`func NewProvisioningCompletedRequesterWithDefaults() *ProvisioningCompletedRequester` + +NewProvisioningCompletedRequesterWithDefaults instantiates a new ProvisioningCompletedRequester 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 + +### GetType + +`func (o *ProvisioningCompletedRequester) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ProvisioningCompletedRequester) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ProvisioningCompletedRequester) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *ProvisioningCompletedRequester) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ProvisioningCompletedRequester) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ProvisioningCompletedRequester) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *ProvisioningCompletedRequester) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningCompletedRequester) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningCompletedRequester) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningConfig.md new file mode 100644 index 000000000..456283e25 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningConfig.md @@ -0,0 +1,178 @@ +--- +id: v2024-provisioning-config +title: ProvisioningConfig +pagination_label: ProvisioningConfig +sidebar_label: ProvisioningConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningConfig', 'V2024ProvisioningConfig'] +slug: /tools/sdk/go/v2024/models/provisioning-config +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig', 'V2024ProvisioningConfig'] +--- + +# ProvisioningConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UniversalManager** | Pointer to **bool** | Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. | [optional] [readonly] [default to false] +**ManagedResourceRefs** | Pointer to [**[]ServiceDeskSource**](service-desk-source) | References to sources for the Service Desk integration template. May only be specified if universalManager is false. | [optional] +**PlanInitializerScript** | Pointer to [**NullableProvisioningConfigPlanInitializerScript**](provisioning-config-plan-initializer-script) | | [optional] +**NoProvisioningRequests** | Pointer to **bool** | Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. | [optional] [default to false] +**ProvisioningRequestExpiration** | Pointer to **int32** | When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. | [optional] + +## Methods + +### NewProvisioningConfig + +`func NewProvisioningConfig() *ProvisioningConfig` + +NewProvisioningConfig instantiates a new ProvisioningConfig 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 + +### NewProvisioningConfigWithDefaults + +`func NewProvisioningConfigWithDefaults() *ProvisioningConfig` + +NewProvisioningConfigWithDefaults instantiates a new ProvisioningConfig 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 + +### GetUniversalManager + +`func (o *ProvisioningConfig) GetUniversalManager() bool` + +GetUniversalManager returns the UniversalManager field if non-nil, zero value otherwise. + +### GetUniversalManagerOk + +`func (o *ProvisioningConfig) GetUniversalManagerOk() (*bool, bool)` + +GetUniversalManagerOk returns a tuple with the UniversalManager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUniversalManager + +`func (o *ProvisioningConfig) SetUniversalManager(v bool)` + +SetUniversalManager sets UniversalManager field to given value. + +### HasUniversalManager + +`func (o *ProvisioningConfig) HasUniversalManager() bool` + +HasUniversalManager returns a boolean if a field has been set. + +### GetManagedResourceRefs + +`func (o *ProvisioningConfig) GetManagedResourceRefs() []ServiceDeskSource` + +GetManagedResourceRefs returns the ManagedResourceRefs field if non-nil, zero value otherwise. + +### GetManagedResourceRefsOk + +`func (o *ProvisioningConfig) GetManagedResourceRefsOk() (*[]ServiceDeskSource, bool)` + +GetManagedResourceRefsOk returns a tuple with the ManagedResourceRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagedResourceRefs + +`func (o *ProvisioningConfig) SetManagedResourceRefs(v []ServiceDeskSource)` + +SetManagedResourceRefs sets ManagedResourceRefs field to given value. + +### HasManagedResourceRefs + +`func (o *ProvisioningConfig) HasManagedResourceRefs() bool` + +HasManagedResourceRefs returns a boolean if a field has been set. + +### GetPlanInitializerScript + +`func (o *ProvisioningConfig) GetPlanInitializerScript() ProvisioningConfigPlanInitializerScript` + +GetPlanInitializerScript returns the PlanInitializerScript field if non-nil, zero value otherwise. + +### GetPlanInitializerScriptOk + +`func (o *ProvisioningConfig) GetPlanInitializerScriptOk() (*ProvisioningConfigPlanInitializerScript, bool)` + +GetPlanInitializerScriptOk returns a tuple with the PlanInitializerScript field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPlanInitializerScript + +`func (o *ProvisioningConfig) SetPlanInitializerScript(v ProvisioningConfigPlanInitializerScript)` + +SetPlanInitializerScript sets PlanInitializerScript field to given value. + +### HasPlanInitializerScript + +`func (o *ProvisioningConfig) HasPlanInitializerScript() bool` + +HasPlanInitializerScript returns a boolean if a field has been set. + +### SetPlanInitializerScriptNil + +`func (o *ProvisioningConfig) SetPlanInitializerScriptNil(b bool)` + + SetPlanInitializerScriptNil sets the value for PlanInitializerScript to be an explicit nil + +### UnsetPlanInitializerScript +`func (o *ProvisioningConfig) UnsetPlanInitializerScript()` + +UnsetPlanInitializerScript ensures that no value is present for PlanInitializerScript, not even an explicit nil +### GetNoProvisioningRequests + +`func (o *ProvisioningConfig) GetNoProvisioningRequests() bool` + +GetNoProvisioningRequests returns the NoProvisioningRequests field if non-nil, zero value otherwise. + +### GetNoProvisioningRequestsOk + +`func (o *ProvisioningConfig) GetNoProvisioningRequestsOk() (*bool, bool)` + +GetNoProvisioningRequestsOk returns a tuple with the NoProvisioningRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNoProvisioningRequests + +`func (o *ProvisioningConfig) SetNoProvisioningRequests(v bool)` + +SetNoProvisioningRequests sets NoProvisioningRequests field to given value. + +### HasNoProvisioningRequests + +`func (o *ProvisioningConfig) HasNoProvisioningRequests() bool` + +HasNoProvisioningRequests returns a boolean if a field has been set. + +### GetProvisioningRequestExpiration + +`func (o *ProvisioningConfig) GetProvisioningRequestExpiration() int32` + +GetProvisioningRequestExpiration returns the ProvisioningRequestExpiration field if non-nil, zero value otherwise. + +### GetProvisioningRequestExpirationOk + +`func (o *ProvisioningConfig) GetProvisioningRequestExpirationOk() (*int32, bool)` + +GetProvisioningRequestExpirationOk returns a tuple with the ProvisioningRequestExpiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningRequestExpiration + +`func (o *ProvisioningConfig) SetProvisioningRequestExpiration(v int32)` + +SetProvisioningRequestExpiration sets ProvisioningRequestExpiration field to given value. + +### HasProvisioningRequestExpiration + +`func (o *ProvisioningConfig) HasProvisioningRequestExpiration() bool` + +HasProvisioningRequestExpiration returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningConfigPlanInitializerScript.md b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningConfigPlanInitializerScript.md new file mode 100644 index 000000000..8c5629f03 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningConfigPlanInitializerScript.md @@ -0,0 +1,64 @@ +--- +id: v2024-provisioning-config-plan-initializer-script +title: ProvisioningConfigPlanInitializerScript +pagination_label: ProvisioningConfigPlanInitializerScript +sidebar_label: ProvisioningConfigPlanInitializerScript +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningConfigPlanInitializerScript', 'V2024ProvisioningConfigPlanInitializerScript'] +slug: /tools/sdk/go/v2024/models/provisioning-config-plan-initializer-script +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfigPlanInitializerScript', 'V2024ProvisioningConfigPlanInitializerScript'] +--- + +# ProvisioningConfigPlanInitializerScript + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | Pointer to **string** | This is a Rule that allows provisioning instruction changes. | [optional] + +## Methods + +### NewProvisioningConfigPlanInitializerScript + +`func NewProvisioningConfigPlanInitializerScript() *ProvisioningConfigPlanInitializerScript` + +NewProvisioningConfigPlanInitializerScript instantiates a new ProvisioningConfigPlanInitializerScript 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 + +### NewProvisioningConfigPlanInitializerScriptWithDefaults + +`func NewProvisioningConfigPlanInitializerScriptWithDefaults() *ProvisioningConfigPlanInitializerScript` + +NewProvisioningConfigPlanInitializerScriptWithDefaults instantiates a new ProvisioningConfigPlanInitializerScript 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 + +### GetSource + +`func (o *ProvisioningConfigPlanInitializerScript) GetSource() string` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *ProvisioningConfigPlanInitializerScript) GetSourceOk() (*string, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *ProvisioningConfigPlanInitializerScript) SetSource(v string)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *ProvisioningConfigPlanInitializerScript) HasSource() bool` + +HasSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCriteriaLevel1.md new file mode 100644 index 000000000..526d93fda --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCriteriaLevel1.md @@ -0,0 +1,172 @@ +--- +id: v2024-provisioning-criteria-level1 +title: ProvisioningCriteriaLevel1 +pagination_label: ProvisioningCriteriaLevel1 +sidebar_label: ProvisioningCriteriaLevel1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCriteriaLevel1', 'V2024ProvisioningCriteriaLevel1'] +slug: /tools/sdk/go/v2024/models/provisioning-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'V2024ProvisioningCriteriaLevel1'] +--- + +# ProvisioningCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **NullableString** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | Pointer to **NullableString** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | Pointer to [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Methods + +### NewProvisioningCriteriaLevel1 + +`func NewProvisioningCriteriaLevel1() *ProvisioningCriteriaLevel1` + +NewProvisioningCriteriaLevel1 instantiates a new ProvisioningCriteriaLevel1 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 + +### NewProvisioningCriteriaLevel1WithDefaults + +`func NewProvisioningCriteriaLevel1WithDefaults() *ProvisioningCriteriaLevel1` + +NewProvisioningCriteriaLevel1WithDefaults instantiates a new ProvisioningCriteriaLevel1 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 + +### GetOperation + +`func (o *ProvisioningCriteriaLevel1) GetOperation() ProvisioningCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ProvisioningCriteriaLevel1) GetOperationOk() (*ProvisioningCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ProvisioningCriteriaLevel1) SetOperation(v ProvisioningCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ProvisioningCriteriaLevel1) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ProvisioningCriteriaLevel1) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ProvisioningCriteriaLevel1) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ProvisioningCriteriaLevel1) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ProvisioningCriteriaLevel1) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *ProvisioningCriteriaLevel1) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *ProvisioningCriteriaLevel1) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *ProvisioningCriteriaLevel1) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ProvisioningCriteriaLevel1) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ProvisioningCriteriaLevel1) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ProvisioningCriteriaLevel1) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ProvisioningCriteriaLevel1) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ProvisioningCriteriaLevel1) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *ProvisioningCriteriaLevel1) GetChildren() []ProvisioningCriteriaLevel2` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *ProvisioningCriteriaLevel1) GetChildrenOk() (*[]ProvisioningCriteriaLevel2, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *ProvisioningCriteriaLevel1) SetChildren(v []ProvisioningCriteriaLevel2)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *ProvisioningCriteriaLevel1) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *ProvisioningCriteriaLevel1) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *ProvisioningCriteriaLevel1) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCriteriaLevel2.md new file mode 100644 index 000000000..23129c005 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCriteriaLevel2.md @@ -0,0 +1,172 @@ +--- +id: v2024-provisioning-criteria-level2 +title: ProvisioningCriteriaLevel2 +pagination_label: ProvisioningCriteriaLevel2 +sidebar_label: ProvisioningCriteriaLevel2 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCriteriaLevel2', 'V2024ProvisioningCriteriaLevel2'] +slug: /tools/sdk/go/v2024/models/provisioning-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'V2024ProvisioningCriteriaLevel2'] +--- + +# ProvisioningCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **NullableString** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | Pointer to **NullableString** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | Pointer to [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Methods + +### NewProvisioningCriteriaLevel2 + +`func NewProvisioningCriteriaLevel2() *ProvisioningCriteriaLevel2` + +NewProvisioningCriteriaLevel2 instantiates a new ProvisioningCriteriaLevel2 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 + +### NewProvisioningCriteriaLevel2WithDefaults + +`func NewProvisioningCriteriaLevel2WithDefaults() *ProvisioningCriteriaLevel2` + +NewProvisioningCriteriaLevel2WithDefaults instantiates a new ProvisioningCriteriaLevel2 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 + +### GetOperation + +`func (o *ProvisioningCriteriaLevel2) GetOperation() ProvisioningCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ProvisioningCriteriaLevel2) GetOperationOk() (*ProvisioningCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ProvisioningCriteriaLevel2) SetOperation(v ProvisioningCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ProvisioningCriteriaLevel2) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ProvisioningCriteriaLevel2) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ProvisioningCriteriaLevel2) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ProvisioningCriteriaLevel2) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ProvisioningCriteriaLevel2) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *ProvisioningCriteriaLevel2) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *ProvisioningCriteriaLevel2) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *ProvisioningCriteriaLevel2) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ProvisioningCriteriaLevel2) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ProvisioningCriteriaLevel2) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ProvisioningCriteriaLevel2) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ProvisioningCriteriaLevel2) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ProvisioningCriteriaLevel2) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *ProvisioningCriteriaLevel2) GetChildren() []ProvisioningCriteriaLevel3` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *ProvisioningCriteriaLevel2) GetChildrenOk() (*[]ProvisioningCriteriaLevel3, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *ProvisioningCriteriaLevel2) SetChildren(v []ProvisioningCriteriaLevel3)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *ProvisioningCriteriaLevel2) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *ProvisioningCriteriaLevel2) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *ProvisioningCriteriaLevel2) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCriteriaLevel3.md new file mode 100644 index 000000000..1f8095c69 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCriteriaLevel3.md @@ -0,0 +1,172 @@ +--- +id: v2024-provisioning-criteria-level3 +title: ProvisioningCriteriaLevel3 +pagination_label: ProvisioningCriteriaLevel3 +sidebar_label: ProvisioningCriteriaLevel3 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCriteriaLevel3', 'V2024ProvisioningCriteriaLevel3'] +slug: /tools/sdk/go/v2024/models/provisioning-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'V2024ProvisioningCriteriaLevel3'] +--- + +# ProvisioningCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **NullableString** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | Pointer to **NullableString** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | Pointer to **NullableString** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Methods + +### NewProvisioningCriteriaLevel3 + +`func NewProvisioningCriteriaLevel3() *ProvisioningCriteriaLevel3` + +NewProvisioningCriteriaLevel3 instantiates a new ProvisioningCriteriaLevel3 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 + +### NewProvisioningCriteriaLevel3WithDefaults + +`func NewProvisioningCriteriaLevel3WithDefaults() *ProvisioningCriteriaLevel3` + +NewProvisioningCriteriaLevel3WithDefaults instantiates a new ProvisioningCriteriaLevel3 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 + +### GetOperation + +`func (o *ProvisioningCriteriaLevel3) GetOperation() ProvisioningCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ProvisioningCriteriaLevel3) GetOperationOk() (*ProvisioningCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ProvisioningCriteriaLevel3) SetOperation(v ProvisioningCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ProvisioningCriteriaLevel3) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ProvisioningCriteriaLevel3) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ProvisioningCriteriaLevel3) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ProvisioningCriteriaLevel3) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ProvisioningCriteriaLevel3) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *ProvisioningCriteriaLevel3) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *ProvisioningCriteriaLevel3) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *ProvisioningCriteriaLevel3) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ProvisioningCriteriaLevel3) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ProvisioningCriteriaLevel3) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ProvisioningCriteriaLevel3) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ProvisioningCriteriaLevel3) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ProvisioningCriteriaLevel3) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *ProvisioningCriteriaLevel3) GetChildren() string` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *ProvisioningCriteriaLevel3) GetChildrenOk() (*string, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *ProvisioningCriteriaLevel3) SetChildren(v string)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *ProvisioningCriteriaLevel3) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *ProvisioningCriteriaLevel3) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *ProvisioningCriteriaLevel3) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCriteriaOperation.md new file mode 100644 index 000000000..fa193a1c1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningCriteriaOperation.md @@ -0,0 +1,29 @@ +--- +id: v2024-provisioning-criteria-operation +title: ProvisioningCriteriaOperation +pagination_label: ProvisioningCriteriaOperation +sidebar_label: ProvisioningCriteriaOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCriteriaOperation', 'V2024ProvisioningCriteriaOperation'] +slug: /tools/sdk/go/v2024/models/provisioning-criteria-operation +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'V2024ProvisioningCriteriaOperation'] +--- + +# ProvisioningCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `HAS` (value: `"HAS"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningDetails.md new file mode 100644 index 000000000..57b9f26f2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningDetails.md @@ -0,0 +1,64 @@ +--- +id: v2024-provisioning-details +title: ProvisioningDetails +pagination_label: ProvisioningDetails +sidebar_label: ProvisioningDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningDetails', 'V2024ProvisioningDetails'] +slug: /tools/sdk/go/v2024/models/provisioning-details +tags: ['SDK', 'Software Development Kit', 'ProvisioningDetails', 'V2024ProvisioningDetails'] +--- + +# ProvisioningDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrderedSubPhaseReferences** | Pointer to **string** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. | [optional] + +## Methods + +### NewProvisioningDetails + +`func NewProvisioningDetails() *ProvisioningDetails` + +NewProvisioningDetails instantiates a new ProvisioningDetails 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 + +### NewProvisioningDetailsWithDefaults + +`func NewProvisioningDetailsWithDefaults() *ProvisioningDetails` + +NewProvisioningDetailsWithDefaults instantiates a new ProvisioningDetails 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 + +### GetOrderedSubPhaseReferences + +`func (o *ProvisioningDetails) GetOrderedSubPhaseReferences() string` + +GetOrderedSubPhaseReferences returns the OrderedSubPhaseReferences field if non-nil, zero value otherwise. + +### GetOrderedSubPhaseReferencesOk + +`func (o *ProvisioningDetails) GetOrderedSubPhaseReferencesOk() (*string, bool)` + +GetOrderedSubPhaseReferencesOk returns a tuple with the OrderedSubPhaseReferences field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderedSubPhaseReferences + +`func (o *ProvisioningDetails) SetOrderedSubPhaseReferences(v string)` + +SetOrderedSubPhaseReferences sets OrderedSubPhaseReferences field to given value. + +### HasOrderedSubPhaseReferences + +`func (o *ProvisioningDetails) HasOrderedSubPhaseReferences() bool` + +HasOrderedSubPhaseReferences returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningPolicy.md b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningPolicy.md new file mode 100644 index 000000000..9f7376b6f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningPolicy.md @@ -0,0 +1,147 @@ +--- +id: v2024-provisioning-policy +title: ProvisioningPolicy +pagination_label: ProvisioningPolicy +sidebar_label: ProvisioningPolicy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningPolicy', 'V2024ProvisioningPolicy'] +slug: /tools/sdk/go/v2024/models/provisioning-policy +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicy', 'V2024ProvisioningPolicy'] +--- + +# ProvisioningPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **NullableString** | the provisioning policy name | +**Description** | Pointer to **string** | the description of the provisioning policy | [optional] +**UsageType** | Pointer to [**UsageType**](usage-type) | | [optional] +**Fields** | Pointer to [**[]FieldDetailsDto**](field-details-dto) | | [optional] + +## Methods + +### NewProvisioningPolicy + +`func NewProvisioningPolicy(name NullableString, ) *ProvisioningPolicy` + +NewProvisioningPolicy instantiates a new ProvisioningPolicy 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 + +### NewProvisioningPolicyWithDefaults + +`func NewProvisioningPolicyWithDefaults() *ProvisioningPolicy` + +NewProvisioningPolicyWithDefaults instantiates a new ProvisioningPolicy 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 + +### GetName + +`func (o *ProvisioningPolicy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningPolicy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningPolicy) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *ProvisioningPolicy) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ProvisioningPolicy) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *ProvisioningPolicy) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ProvisioningPolicy) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ProvisioningPolicy) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ProvisioningPolicy) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetUsageType + +`func (o *ProvisioningPolicy) GetUsageType() UsageType` + +GetUsageType returns the UsageType field if non-nil, zero value otherwise. + +### GetUsageTypeOk + +`func (o *ProvisioningPolicy) GetUsageTypeOk() (*UsageType, bool)` + +GetUsageTypeOk returns a tuple with the UsageType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsageType + +`func (o *ProvisioningPolicy) SetUsageType(v UsageType)` + +SetUsageType sets UsageType field to given value. + +### HasUsageType + +`func (o *ProvisioningPolicy) HasUsageType() bool` + +HasUsageType returns a boolean if a field has been set. + +### GetFields + +`func (o *ProvisioningPolicy) GetFields() []FieldDetailsDto` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *ProvisioningPolicy) GetFieldsOk() (*[]FieldDetailsDto, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *ProvisioningPolicy) SetFields(v []FieldDetailsDto)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *ProvisioningPolicy) HasFields() bool` + +HasFields returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningPolicyDto.md b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningPolicyDto.md new file mode 100644 index 000000000..bce520db9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningPolicyDto.md @@ -0,0 +1,147 @@ +--- +id: v2024-provisioning-policy-dto +title: ProvisioningPolicyDto +pagination_label: ProvisioningPolicyDto +sidebar_label: ProvisioningPolicyDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningPolicyDto', 'V2024ProvisioningPolicyDto'] +slug: /tools/sdk/go/v2024/models/provisioning-policy-dto +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicyDto', 'V2024ProvisioningPolicyDto'] +--- + +# ProvisioningPolicyDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **NullableString** | the provisioning policy name | +**Description** | Pointer to **string** | the description of the provisioning policy | [optional] +**UsageType** | Pointer to [**UsageType**](usage-type) | | [optional] +**Fields** | Pointer to [**[]FieldDetailsDto**](field-details-dto) | | [optional] + +## Methods + +### NewProvisioningPolicyDto + +`func NewProvisioningPolicyDto(name NullableString, ) *ProvisioningPolicyDto` + +NewProvisioningPolicyDto instantiates a new ProvisioningPolicyDto 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 + +### NewProvisioningPolicyDtoWithDefaults + +`func NewProvisioningPolicyDtoWithDefaults() *ProvisioningPolicyDto` + +NewProvisioningPolicyDtoWithDefaults instantiates a new ProvisioningPolicyDto 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 + +### GetName + +`func (o *ProvisioningPolicyDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningPolicyDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningPolicyDto) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *ProvisioningPolicyDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ProvisioningPolicyDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *ProvisioningPolicyDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ProvisioningPolicyDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ProvisioningPolicyDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ProvisioningPolicyDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetUsageType + +`func (o *ProvisioningPolicyDto) GetUsageType() UsageType` + +GetUsageType returns the UsageType field if non-nil, zero value otherwise. + +### GetUsageTypeOk + +`func (o *ProvisioningPolicyDto) GetUsageTypeOk() (*UsageType, bool)` + +GetUsageTypeOk returns a tuple with the UsageType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsageType + +`func (o *ProvisioningPolicyDto) SetUsageType(v UsageType)` + +SetUsageType sets UsageType field to given value. + +### HasUsageType + +`func (o *ProvisioningPolicyDto) HasUsageType() bool` + +HasUsageType returns a boolean if a field has been set. + +### GetFields + +`func (o *ProvisioningPolicyDto) GetFields() []FieldDetailsDto` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *ProvisioningPolicyDto) GetFieldsOk() (*[]FieldDetailsDto, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *ProvisioningPolicyDto) SetFields(v []FieldDetailsDto)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *ProvisioningPolicyDto) HasFields() bool` + +HasFields returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningState.md b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningState.md new file mode 100644 index 000000000..b7baa5943 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ProvisioningState.md @@ -0,0 +1,29 @@ +--- +id: v2024-provisioning-state +title: ProvisioningState +pagination_label: ProvisioningState +sidebar_label: ProvisioningState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningState', 'V2024ProvisioningState'] +slug: /tools/sdk/go/v2024/models/provisioning-state +tags: ['SDK', 'Software Development Kit', 'ProvisioningState', 'V2024ProvisioningState'] +--- + +# ProvisioningState + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `FINISHED` (value: `"FINISHED"`) + +* `UNVERIFIABLE` (value: `"UNVERIFIABLE"`) + +* `COMMITED` (value: `"COMMITED"`) + +* `FAILED` (value: `"FAILED"`) + +* `RETRY` (value: `"RETRY"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PublicIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/PublicIdentity.md new file mode 100644 index 000000000..19e20bac6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PublicIdentity.md @@ -0,0 +1,286 @@ +--- +id: v2024-public-identity +title: PublicIdentity +pagination_label: PublicIdentity +sidebar_label: PublicIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentity', 'V2024PublicIdentity'] +slug: /tools/sdk/go/v2024/models/public-identity +tags: ['SDK', 'Software Development Kit', 'PublicIdentity', 'V2024PublicIdentity'] +--- + +# PublicIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Identity id | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity. | [optional] +**Alias** | Pointer to **string** | Alternate unique identifier for the identity. | [optional] +**Email** | Pointer to **NullableString** | Email address of identity. | [optional] +**Status** | Pointer to **NullableString** | The lifecycle status for the identity | [optional] +**IdentityState** | Pointer to **NullableString** | The current state of the identity, which determines how Identity Security Cloud interacts with the identity. An identity that is Active will be included identity picklists in Request Center, identity processing, and more. Identities that are Inactive will be excluded from these features. | [optional] +**Manager** | Pointer to [**NullableIdentityReference**](identity-reference) | | [optional] +**Attributes** | Pointer to [**[]PublicIdentityAttributesInner**](public-identity-attributes-inner) | The public identity attributes of the identity | [optional] + +## Methods + +### NewPublicIdentity + +`func NewPublicIdentity() *PublicIdentity` + +NewPublicIdentity instantiates a new PublicIdentity 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 + +### NewPublicIdentityWithDefaults + +`func NewPublicIdentityWithDefaults() *PublicIdentity` + +NewPublicIdentityWithDefaults instantiates a new PublicIdentity 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 + +### GetId + +`func (o *PublicIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PublicIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PublicIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PublicIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *PublicIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PublicIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PublicIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PublicIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAlias + +`func (o *PublicIdentity) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *PublicIdentity) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *PublicIdentity) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *PublicIdentity) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + +### GetEmail + +`func (o *PublicIdentity) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *PublicIdentity) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *PublicIdentity) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *PublicIdentity) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### SetEmailNil + +`func (o *PublicIdentity) SetEmailNil(b bool)` + + SetEmailNil sets the value for Email to be an explicit nil + +### UnsetEmail +`func (o *PublicIdentity) UnsetEmail()` + +UnsetEmail ensures that no value is present for Email, not even an explicit nil +### GetStatus + +`func (o *PublicIdentity) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *PublicIdentity) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *PublicIdentity) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *PublicIdentity) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatusNil + +`func (o *PublicIdentity) SetStatusNil(b bool)` + + SetStatusNil sets the value for Status to be an explicit nil + +### UnsetStatus +`func (o *PublicIdentity) UnsetStatus()` + +UnsetStatus ensures that no value is present for Status, not even an explicit nil +### GetIdentityState + +`func (o *PublicIdentity) GetIdentityState() string` + +GetIdentityState returns the IdentityState field if non-nil, zero value otherwise. + +### GetIdentityStateOk + +`func (o *PublicIdentity) GetIdentityStateOk() (*string, bool)` + +GetIdentityStateOk returns a tuple with the IdentityState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityState + +`func (o *PublicIdentity) SetIdentityState(v string)` + +SetIdentityState sets IdentityState field to given value. + +### HasIdentityState + +`func (o *PublicIdentity) HasIdentityState() bool` + +HasIdentityState returns a boolean if a field has been set. + +### SetIdentityStateNil + +`func (o *PublicIdentity) SetIdentityStateNil(b bool)` + + SetIdentityStateNil sets the value for IdentityState to be an explicit nil + +### UnsetIdentityState +`func (o *PublicIdentity) UnsetIdentityState()` + +UnsetIdentityState ensures that no value is present for IdentityState, not even an explicit nil +### GetManager + +`func (o *PublicIdentity) GetManager() IdentityReference` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *PublicIdentity) GetManagerOk() (*IdentityReference, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *PublicIdentity) SetManager(v IdentityReference)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *PublicIdentity) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### SetManagerNil + +`func (o *PublicIdentity) SetManagerNil(b bool)` + + SetManagerNil sets the value for Manager to be an explicit nil + +### UnsetManager +`func (o *PublicIdentity) UnsetManager()` + +UnsetManager ensures that no value is present for Manager, not even an explicit nil +### GetAttributes + +`func (o *PublicIdentity) GetAttributes() []PublicIdentityAttributesInner` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *PublicIdentity) GetAttributesOk() (*[]PublicIdentityAttributesInner, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *PublicIdentity) SetAttributes(v []PublicIdentityAttributesInner)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *PublicIdentity) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PublicIdentityAttributeConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/PublicIdentityAttributeConfig.md new file mode 100644 index 000000000..ef4c7ff8d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PublicIdentityAttributeConfig.md @@ -0,0 +1,90 @@ +--- +id: v2024-public-identity-attribute-config +title: PublicIdentityAttributeConfig +pagination_label: PublicIdentityAttributeConfig +sidebar_label: PublicIdentityAttributeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentityAttributeConfig', 'V2024PublicIdentityAttributeConfig'] +slug: /tools/sdk/go/v2024/models/public-identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributeConfig', 'V2024PublicIdentityAttributeConfig'] +--- + +# PublicIdentityAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The attribute key | [optional] +**Name** | Pointer to **string** | The attribute display name | [optional] + +## Methods + +### NewPublicIdentityAttributeConfig + +`func NewPublicIdentityAttributeConfig() *PublicIdentityAttributeConfig` + +NewPublicIdentityAttributeConfig instantiates a new PublicIdentityAttributeConfig 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 + +### NewPublicIdentityAttributeConfigWithDefaults + +`func NewPublicIdentityAttributeConfigWithDefaults() *PublicIdentityAttributeConfig` + +NewPublicIdentityAttributeConfigWithDefaults instantiates a new PublicIdentityAttributeConfig 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 + +### GetKey + +`func (o *PublicIdentityAttributeConfig) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *PublicIdentityAttributeConfig) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *PublicIdentityAttributeConfig) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *PublicIdentityAttributeConfig) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *PublicIdentityAttributeConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PublicIdentityAttributeConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PublicIdentityAttributeConfig) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PublicIdentityAttributeConfig) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PublicIdentityAttributesInner.md b/docs/tools/sdk/go/Reference/V2024/Models/PublicIdentityAttributesInner.md new file mode 100644 index 000000000..c7fbd401b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PublicIdentityAttributesInner.md @@ -0,0 +1,126 @@ +--- +id: v2024-public-identity-attributes-inner +title: PublicIdentityAttributesInner +pagination_label: PublicIdentityAttributesInner +sidebar_label: PublicIdentityAttributesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentityAttributesInner', 'V2024PublicIdentityAttributesInner'] +slug: /tools/sdk/go/v2024/models/public-identity-attributes-inner +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributesInner', 'V2024PublicIdentityAttributesInner'] +--- + +# PublicIdentityAttributesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The attribute key | [optional] +**Name** | Pointer to **string** | Human-readable display name of the attribute | [optional] +**Value** | Pointer to **NullableString** | The attribute value | [optional] + +## Methods + +### NewPublicIdentityAttributesInner + +`func NewPublicIdentityAttributesInner() *PublicIdentityAttributesInner` + +NewPublicIdentityAttributesInner instantiates a new PublicIdentityAttributesInner 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 + +### NewPublicIdentityAttributesInnerWithDefaults + +`func NewPublicIdentityAttributesInnerWithDefaults() *PublicIdentityAttributesInner` + +NewPublicIdentityAttributesInnerWithDefaults instantiates a new PublicIdentityAttributesInner 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 + +### GetKey + +`func (o *PublicIdentityAttributesInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *PublicIdentityAttributesInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *PublicIdentityAttributesInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *PublicIdentityAttributesInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *PublicIdentityAttributesInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PublicIdentityAttributesInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PublicIdentityAttributesInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PublicIdentityAttributesInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValue + +`func (o *PublicIdentityAttributesInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *PublicIdentityAttributesInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *PublicIdentityAttributesInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *PublicIdentityAttributesInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *PublicIdentityAttributesInner) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *PublicIdentityAttributesInner) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PublicIdentityConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/PublicIdentityConfig.md new file mode 100644 index 000000000..d0ab52140 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PublicIdentityConfig.md @@ -0,0 +1,136 @@ +--- +id: v2024-public-identity-config +title: PublicIdentityConfig +pagination_label: PublicIdentityConfig +sidebar_label: PublicIdentityConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentityConfig', 'V2024PublicIdentityConfig'] +slug: /tools/sdk/go/v2024/models/public-identity-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityConfig', 'V2024PublicIdentityConfig'] +--- + +# PublicIdentityConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]PublicIdentityAttributeConfig**](public-identity-attribute-config) | Up to 5 identity attributes that will be available to everyone in the org for all users in the org. | [optional] +**Modified** | Pointer to **NullableTime** | When this configuration was last modified. | [optional] +**ModifiedBy** | Pointer to [**NullableIdentityReference**](identity-reference) | | [optional] + +## Methods + +### NewPublicIdentityConfig + +`func NewPublicIdentityConfig() *PublicIdentityConfig` + +NewPublicIdentityConfig instantiates a new PublicIdentityConfig 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 + +### NewPublicIdentityConfigWithDefaults + +`func NewPublicIdentityConfigWithDefaults() *PublicIdentityConfig` + +NewPublicIdentityConfigWithDefaults instantiates a new PublicIdentityConfig 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 + +### GetAttributes + +`func (o *PublicIdentityConfig) GetAttributes() []PublicIdentityAttributeConfig` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *PublicIdentityConfig) GetAttributesOk() (*[]PublicIdentityAttributeConfig, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *PublicIdentityConfig) SetAttributes(v []PublicIdentityAttributeConfig)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *PublicIdentityConfig) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetModified + +`func (o *PublicIdentityConfig) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PublicIdentityConfig) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PublicIdentityConfig) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PublicIdentityConfig) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *PublicIdentityConfig) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *PublicIdentityConfig) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetModifiedBy + +`func (o *PublicIdentityConfig) GetModifiedBy() IdentityReference` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *PublicIdentityConfig) GetModifiedByOk() (*IdentityReference, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedBy + +`func (o *PublicIdentityConfig) SetModifiedBy(v IdentityReference)` + +SetModifiedBy sets ModifiedBy field to given value. + +### HasModifiedBy + +`func (o *PublicIdentityConfig) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### SetModifiedByNil + +`func (o *PublicIdentityConfig) SetModifiedByNil(b bool)` + + SetModifiedByNil sets the value for ModifiedBy to be an explicit nil + +### UnsetModifiedBy +`func (o *PublicIdentityConfig) UnsetModifiedBy()` + +UnsetModifiedBy ensures that no value is present for ModifiedBy, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PutClientLogConfigurationRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/PutClientLogConfigurationRequest.md new file mode 100644 index 000000000..9812545d0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PutClientLogConfigurationRequest.md @@ -0,0 +1,163 @@ +--- +id: v2024-put-client-log-configuration-request +title: PutClientLogConfigurationRequest +pagination_label: PutClientLogConfigurationRequest +sidebar_label: PutClientLogConfigurationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PutClientLogConfigurationRequest', 'V2024PutClientLogConfigurationRequest'] +slug: /tools/sdk/go/v2024/models/put-client-log-configuration-request +tags: ['SDK', 'Software Development Kit', 'PutClientLogConfigurationRequest', 'V2024PutClientLogConfigurationRequest'] +--- + +# PutClientLogConfigurationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **string** | Log configuration's client ID | [optional] +**DurationMinutes** | Pointer to **int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**RootLevel** | [**StandardLevel**](standard-level) | | +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] +**Expiration** | Pointer to **SailPointTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] + +## Methods + +### NewPutClientLogConfigurationRequest + +`func NewPutClientLogConfigurationRequest(rootLevel StandardLevel, ) *PutClientLogConfigurationRequest` + +NewPutClientLogConfigurationRequest instantiates a new PutClientLogConfigurationRequest 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 + +### NewPutClientLogConfigurationRequestWithDefaults + +`func NewPutClientLogConfigurationRequestWithDefaults() *PutClientLogConfigurationRequest` + +NewPutClientLogConfigurationRequestWithDefaults instantiates a new PutClientLogConfigurationRequest 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 + +### GetClientId + +`func (o *PutClientLogConfigurationRequest) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *PutClientLogConfigurationRequest) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *PutClientLogConfigurationRequest) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + +### HasClientId + +`func (o *PutClientLogConfigurationRequest) HasClientId() bool` + +HasClientId returns a boolean if a field has been set. + +### GetDurationMinutes + +`func (o *PutClientLogConfigurationRequest) GetDurationMinutes() int32` + +GetDurationMinutes returns the DurationMinutes field if non-nil, zero value otherwise. + +### GetDurationMinutesOk + +`func (o *PutClientLogConfigurationRequest) GetDurationMinutesOk() (*int32, bool)` + +GetDurationMinutesOk returns a tuple with the DurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDurationMinutes + +`func (o *PutClientLogConfigurationRequest) SetDurationMinutes(v int32)` + +SetDurationMinutes sets DurationMinutes field to given value. + +### HasDurationMinutes + +`func (o *PutClientLogConfigurationRequest) HasDurationMinutes() bool` + +HasDurationMinutes returns a boolean if a field has been set. + +### GetRootLevel + +`func (o *PutClientLogConfigurationRequest) GetRootLevel() StandardLevel` + +GetRootLevel returns the RootLevel field if non-nil, zero value otherwise. + +### GetRootLevelOk + +`func (o *PutClientLogConfigurationRequest) GetRootLevelOk() (*StandardLevel, bool)` + +GetRootLevelOk returns a tuple with the RootLevel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootLevel + +`func (o *PutClientLogConfigurationRequest) SetRootLevel(v StandardLevel)` + +SetRootLevel sets RootLevel field to given value. + + +### GetLogLevels + +`func (o *PutClientLogConfigurationRequest) GetLogLevels() map[string]StandardLevel` + +GetLogLevels returns the LogLevels field if non-nil, zero value otherwise. + +### GetLogLevelsOk + +`func (o *PutClientLogConfigurationRequest) GetLogLevelsOk() (*map[string]StandardLevel, bool)` + +GetLogLevelsOk returns a tuple with the LogLevels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogLevels + +`func (o *PutClientLogConfigurationRequest) SetLogLevels(v map[string]StandardLevel)` + +SetLogLevels sets LogLevels field to given value. + +### HasLogLevels + +`func (o *PutClientLogConfigurationRequest) HasLogLevels() bool` + +HasLogLevels returns a boolean if a field has been set. + +### GetExpiration + +`func (o *PutClientLogConfigurationRequest) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *PutClientLogConfigurationRequest) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *PutClientLogConfigurationRequest) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *PutClientLogConfigurationRequest) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PutConnectorCorrelationConfigRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/PutConnectorCorrelationConfigRequest.md new file mode 100644 index 000000000..69a01c2f3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PutConnectorCorrelationConfigRequest.md @@ -0,0 +1,59 @@ +--- +id: v2024-put-connector-correlation-config-request +title: PutConnectorCorrelationConfigRequest +pagination_label: PutConnectorCorrelationConfigRequest +sidebar_label: PutConnectorCorrelationConfigRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PutConnectorCorrelationConfigRequest', 'V2024PutConnectorCorrelationConfigRequest'] +slug: /tools/sdk/go/v2024/models/put-connector-correlation-config-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorCorrelationConfigRequest', 'V2024PutConnectorCorrelationConfigRequest'] +--- + +# PutConnectorCorrelationConfigRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | ***os.File** | connector correlation config xml file | + +## Methods + +### NewPutConnectorCorrelationConfigRequest + +`func NewPutConnectorCorrelationConfigRequest(file *os.File, ) *PutConnectorCorrelationConfigRequest` + +NewPutConnectorCorrelationConfigRequest instantiates a new PutConnectorCorrelationConfigRequest 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 + +### NewPutConnectorCorrelationConfigRequestWithDefaults + +`func NewPutConnectorCorrelationConfigRequestWithDefaults() *PutConnectorCorrelationConfigRequest` + +NewPutConnectorCorrelationConfigRequestWithDefaults instantiates a new PutConnectorCorrelationConfigRequest 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 + +### GetFile + +`func (o *PutConnectorCorrelationConfigRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *PutConnectorCorrelationConfigRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *PutConnectorCorrelationConfigRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PutConnectorSourceConfigRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/PutConnectorSourceConfigRequest.md new file mode 100644 index 000000000..4814658fe --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PutConnectorSourceConfigRequest.md @@ -0,0 +1,59 @@ +--- +id: v2024-put-connector-source-config-request +title: PutConnectorSourceConfigRequest +pagination_label: PutConnectorSourceConfigRequest +sidebar_label: PutConnectorSourceConfigRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PutConnectorSourceConfigRequest', 'V2024PutConnectorSourceConfigRequest'] +slug: /tools/sdk/go/v2024/models/put-connector-source-config-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceConfigRequest', 'V2024PutConnectorSourceConfigRequest'] +--- + +# PutConnectorSourceConfigRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | ***os.File** | connector source config xml file | + +## Methods + +### NewPutConnectorSourceConfigRequest + +`func NewPutConnectorSourceConfigRequest(file *os.File, ) *PutConnectorSourceConfigRequest` + +NewPutConnectorSourceConfigRequest instantiates a new PutConnectorSourceConfigRequest 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 + +### NewPutConnectorSourceConfigRequestWithDefaults + +`func NewPutConnectorSourceConfigRequestWithDefaults() *PutConnectorSourceConfigRequest` + +NewPutConnectorSourceConfigRequestWithDefaults instantiates a new PutConnectorSourceConfigRequest 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 + +### GetFile + +`func (o *PutConnectorSourceConfigRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *PutConnectorSourceConfigRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *PutConnectorSourceConfigRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PutConnectorSourceTemplateRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/PutConnectorSourceTemplateRequest.md new file mode 100644 index 000000000..2eac9663a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PutConnectorSourceTemplateRequest.md @@ -0,0 +1,59 @@ +--- +id: v2024-put-connector-source-template-request +title: PutConnectorSourceTemplateRequest +pagination_label: PutConnectorSourceTemplateRequest +sidebar_label: PutConnectorSourceTemplateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PutConnectorSourceTemplateRequest', 'V2024PutConnectorSourceTemplateRequest'] +slug: /tools/sdk/go/v2024/models/put-connector-source-template-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceTemplateRequest', 'V2024PutConnectorSourceTemplateRequest'] +--- + +# PutConnectorSourceTemplateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | ***os.File** | connector source template xml file | + +## Methods + +### NewPutConnectorSourceTemplateRequest + +`func NewPutConnectorSourceTemplateRequest(file *os.File, ) *PutConnectorSourceTemplateRequest` + +NewPutConnectorSourceTemplateRequest instantiates a new PutConnectorSourceTemplateRequest 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 + +### NewPutConnectorSourceTemplateRequestWithDefaults + +`func NewPutConnectorSourceTemplateRequestWithDefaults() *PutConnectorSourceTemplateRequest` + +NewPutConnectorSourceTemplateRequestWithDefaults instantiates a new PutConnectorSourceTemplateRequest 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 + +### GetFile + +`func (o *PutConnectorSourceTemplateRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *PutConnectorSourceTemplateRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *PutConnectorSourceTemplateRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/PutPasswordDictionaryRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/PutPasswordDictionaryRequest.md new file mode 100644 index 000000000..265f35425 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/PutPasswordDictionaryRequest.md @@ -0,0 +1,64 @@ +--- +id: v2024-put-password-dictionary-request +title: PutPasswordDictionaryRequest +pagination_label: PutPasswordDictionaryRequest +sidebar_label: PutPasswordDictionaryRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PutPasswordDictionaryRequest', 'V2024PutPasswordDictionaryRequest'] +slug: /tools/sdk/go/v2024/models/put-password-dictionary-request +tags: ['SDK', 'Software Development Kit', 'PutPasswordDictionaryRequest', 'V2024PutPasswordDictionaryRequest'] +--- + +# PutPasswordDictionaryRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | Pointer to ***os.File** | | [optional] + +## Methods + +### NewPutPasswordDictionaryRequest + +`func NewPutPasswordDictionaryRequest() *PutPasswordDictionaryRequest` + +NewPutPasswordDictionaryRequest instantiates a new PutPasswordDictionaryRequest 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 + +### NewPutPasswordDictionaryRequestWithDefaults + +`func NewPutPasswordDictionaryRequestWithDefaults() *PutPasswordDictionaryRequest` + +NewPutPasswordDictionaryRequestWithDefaults instantiates a new PutPasswordDictionaryRequest 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 + +### GetFile + +`func (o *PutPasswordDictionaryRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *PutPasswordDictionaryRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *PutPasswordDictionaryRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + +### HasFile + +`func (o *PutPasswordDictionaryRequest) HasFile() bool` + +HasFile returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Query.md b/docs/tools/sdk/go/Reference/V2024/Models/Query.md new file mode 100644 index 000000000..454b6a172 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Query.md @@ -0,0 +1,142 @@ +--- +id: v2024-query +title: Query +pagination_label: Query +sidebar_label: Query +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Query', 'V2024Query'] +slug: /tools/sdk/go/v2024/models/query +tags: ['SDK', 'Software Development Kit', 'Query', 'V2024Query'] +--- + +# Query + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | Pointer to **string** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [optional] +**Fields** | Pointer to **string** | The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of \"a*\" to be applied to \"name\", \"firstName\", and the \"source.name\". The response will include all results matching the \"a*\" query found in those three fields. A field's availability depends on the indices being searched. For example, if you are searching \"identities\", you can apply your search to the \"firstName\" field, but you couldn't use \"firstName\" with a search on \"access profiles\". Refer to the response schema for the respective lists of available fields. | [optional] +**TimeZone** | Pointer to **string** | The time zone to be applied to any range query related to dates. | [optional] +**InnerHit** | Pointer to [**InnerHit**](inner-hit) | | [optional] + +## Methods + +### NewQuery + +`func NewQuery() *Query` + +NewQuery instantiates a new Query 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 + +### NewQueryWithDefaults + +`func NewQueryWithDefaults() *Query` + +NewQueryWithDefaults instantiates a new Query 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 + +### GetQuery + +`func (o *Query) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *Query) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *Query) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *Query) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### GetFields + +`func (o *Query) GetFields() string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *Query) GetFieldsOk() (*string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *Query) SetFields(v string)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *Query) HasFields() bool` + +HasFields returns a boolean if a field has been set. + +### GetTimeZone + +`func (o *Query) GetTimeZone() string` + +GetTimeZone returns the TimeZone field if non-nil, zero value otherwise. + +### GetTimeZoneOk + +`func (o *Query) GetTimeZoneOk() (*string, bool)` + +GetTimeZoneOk returns a tuple with the TimeZone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZone + +`func (o *Query) SetTimeZone(v string)` + +SetTimeZone sets TimeZone field to given value. + +### HasTimeZone + +`func (o *Query) HasTimeZone() bool` + +HasTimeZone returns a boolean if a field has been set. + +### GetInnerHit + +`func (o *Query) GetInnerHit() InnerHit` + +GetInnerHit returns the InnerHit field if non-nil, zero value otherwise. + +### GetInnerHitOk + +`func (o *Query) GetInnerHitOk() (*InnerHit, bool)` + +GetInnerHitOk returns a tuple with the InnerHit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInnerHit + +`func (o *Query) SetInnerHit(v InnerHit)` + +SetInnerHit sets InnerHit field to given value. + +### HasInnerHit + +`func (o *Query) HasInnerHit() bool` + +HasInnerHit returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/QueryResultFilter.md b/docs/tools/sdk/go/Reference/V2024/Models/QueryResultFilter.md new file mode 100644 index 000000000..abde0e8eb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/QueryResultFilter.md @@ -0,0 +1,90 @@ +--- +id: v2024-query-result-filter +title: QueryResultFilter +pagination_label: QueryResultFilter +sidebar_label: QueryResultFilter +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'QueryResultFilter', 'V2024QueryResultFilter'] +slug: /tools/sdk/go/v2024/models/query-result-filter +tags: ['SDK', 'Software Development Kit', 'QueryResultFilter', 'V2024QueryResultFilter'] +--- + +# QueryResultFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Includes** | Pointer to **[]string** | The list of field names to include in the result documents. | [optional] +**Excludes** | Pointer to **[]string** | The list of field names to exclude from the result documents. | [optional] + +## Methods + +### NewQueryResultFilter + +`func NewQueryResultFilter() *QueryResultFilter` + +NewQueryResultFilter instantiates a new QueryResultFilter 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 + +### NewQueryResultFilterWithDefaults + +`func NewQueryResultFilterWithDefaults() *QueryResultFilter` + +NewQueryResultFilterWithDefaults instantiates a new QueryResultFilter 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 + +### GetIncludes + +`func (o *QueryResultFilter) GetIncludes() []string` + +GetIncludes returns the Includes field if non-nil, zero value otherwise. + +### GetIncludesOk + +`func (o *QueryResultFilter) GetIncludesOk() (*[]string, bool)` + +GetIncludesOk returns a tuple with the Includes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludes + +`func (o *QueryResultFilter) SetIncludes(v []string)` + +SetIncludes sets Includes field to given value. + +### HasIncludes + +`func (o *QueryResultFilter) HasIncludes() bool` + +HasIncludes returns a boolean if a field has been set. + +### GetExcludes + +`func (o *QueryResultFilter) GetExcludes() []string` + +GetExcludes returns the Excludes field if non-nil, zero value otherwise. + +### GetExcludesOk + +`func (o *QueryResultFilter) GetExcludesOk() (*[]string, bool)` + +GetExcludesOk returns a tuple with the Excludes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludes + +`func (o *QueryResultFilter) SetExcludes(v []string)` + +SetExcludes sets Excludes field to given value. + +### HasExcludes + +`func (o *QueryResultFilter) HasExcludes() bool` + +HasExcludes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/QueryType.md b/docs/tools/sdk/go/Reference/V2024/Models/QueryType.md new file mode 100644 index 000000000..927e18a4b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/QueryType.md @@ -0,0 +1,25 @@ +--- +id: v2024-query-type +title: QueryType +pagination_label: QueryType +sidebar_label: QueryType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'QueryType', 'V2024QueryType'] +slug: /tools/sdk/go/v2024/models/query-type +tags: ['SDK', 'Software Development Kit', 'QueryType', 'V2024QueryType'] +--- + +# QueryType + +## Enum + + +* `DSL` (value: `"DSL"`) + +* `SAILPOINT` (value: `"SAILPOINT"`) + +* `TEXT` (value: `"TEXT"`) + +* `TYPEAHEAD` (value: `"TYPEAHEAD"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/QueuedCheckConfigDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/QueuedCheckConfigDetails.md new file mode 100644 index 000000000..515612316 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/QueuedCheckConfigDetails.md @@ -0,0 +1,80 @@ +--- +id: v2024-queued-check-config-details +title: QueuedCheckConfigDetails +pagination_label: QueuedCheckConfigDetails +sidebar_label: QueuedCheckConfigDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'QueuedCheckConfigDetails', 'V2024QueuedCheckConfigDetails'] +slug: /tools/sdk/go/v2024/models/queued-check-config-details +tags: ['SDK', 'Software Development Kit', 'QueuedCheckConfigDetails', 'V2024QueuedCheckConfigDetails'] +--- + +# QueuedCheckConfigDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProvisioningStatusCheckIntervalMinutes** | **string** | Interval in minutes between status checks | +**ProvisioningMaxStatusCheckDays** | **string** | Maximum number of days to check | + +## Methods + +### NewQueuedCheckConfigDetails + +`func NewQueuedCheckConfigDetails(provisioningStatusCheckIntervalMinutes string, provisioningMaxStatusCheckDays string, ) *QueuedCheckConfigDetails` + +NewQueuedCheckConfigDetails instantiates a new QueuedCheckConfigDetails 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 + +### NewQueuedCheckConfigDetailsWithDefaults + +`func NewQueuedCheckConfigDetailsWithDefaults() *QueuedCheckConfigDetails` + +NewQueuedCheckConfigDetailsWithDefaults instantiates a new QueuedCheckConfigDetails 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 + +### GetProvisioningStatusCheckIntervalMinutes + +`func (o *QueuedCheckConfigDetails) GetProvisioningStatusCheckIntervalMinutes() string` + +GetProvisioningStatusCheckIntervalMinutes returns the ProvisioningStatusCheckIntervalMinutes field if non-nil, zero value otherwise. + +### GetProvisioningStatusCheckIntervalMinutesOk + +`func (o *QueuedCheckConfigDetails) GetProvisioningStatusCheckIntervalMinutesOk() (*string, bool)` + +GetProvisioningStatusCheckIntervalMinutesOk returns a tuple with the ProvisioningStatusCheckIntervalMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningStatusCheckIntervalMinutes + +`func (o *QueuedCheckConfigDetails) SetProvisioningStatusCheckIntervalMinutes(v string)` + +SetProvisioningStatusCheckIntervalMinutes sets ProvisioningStatusCheckIntervalMinutes field to given value. + + +### GetProvisioningMaxStatusCheckDays + +`func (o *QueuedCheckConfigDetails) GetProvisioningMaxStatusCheckDays() string` + +GetProvisioningMaxStatusCheckDays returns the ProvisioningMaxStatusCheckDays field if non-nil, zero value otherwise. + +### GetProvisioningMaxStatusCheckDaysOk + +`func (o *QueuedCheckConfigDetails) GetProvisioningMaxStatusCheckDaysOk() (*string, bool)` + +GetProvisioningMaxStatusCheckDaysOk returns a tuple with the ProvisioningMaxStatusCheckDays field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningMaxStatusCheckDays + +`func (o *QueuedCheckConfigDetails) SetProvisioningMaxStatusCheckDays(v string)` + +SetProvisioningMaxStatusCheckDays sets ProvisioningMaxStatusCheckDays field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Range.md b/docs/tools/sdk/go/Reference/V2024/Models/Range.md new file mode 100644 index 000000000..66dfd16c4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Range.md @@ -0,0 +1,90 @@ +--- +id: v2024-range +title: Range +pagination_label: Range +sidebar_label: Range +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Range', 'V2024Range'] +slug: /tools/sdk/go/v2024/models/range +tags: ['SDK', 'Software Development Kit', 'Range', 'V2024Range'] +--- + +# Range + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Lower** | Pointer to [**Bound**](bound) | | [optional] +**Upper** | Pointer to [**Bound**](bound) | | [optional] + +## Methods + +### NewRange + +`func NewRange() *Range` + +NewRange instantiates a new Range 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 + +### NewRangeWithDefaults + +`func NewRangeWithDefaults() *Range` + +NewRangeWithDefaults instantiates a new Range 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 + +### GetLower + +`func (o *Range) GetLower() Bound` + +GetLower returns the Lower field if non-nil, zero value otherwise. + +### GetLowerOk + +`func (o *Range) GetLowerOk() (*Bound, bool)` + +GetLowerOk returns a tuple with the Lower field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLower + +`func (o *Range) SetLower(v Bound)` + +SetLower sets Lower field to given value. + +### HasLower + +`func (o *Range) HasLower() bool` + +HasLower returns a boolean if a field has been set. + +### GetUpper + +`func (o *Range) GetUpper() Bound` + +GetUpper returns the Upper field if non-nil, zero value otherwise. + +### GetUpperOk + +`func (o *Range) GetUpperOk() (*Bound, bool)` + +GetUpperOk returns a tuple with the Upper field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpper + +`func (o *Range) SetUpper(v Bound)` + +SetUpper sets Upper field to given value. + +### HasUpper + +`func (o *Range) HasUpper() bool` + +HasUpper returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReassignReference.md b/docs/tools/sdk/go/Reference/V2024/Models/ReassignReference.md new file mode 100644 index 000000000..82c787b3b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReassignReference.md @@ -0,0 +1,80 @@ +--- +id: v2024-reassign-reference +title: ReassignReference +pagination_label: ReassignReference +sidebar_label: ReassignReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignReference', 'V2024ReassignReference'] +slug: /tools/sdk/go/v2024/models/reassign-reference +tags: ['SDK', 'Software Development Kit', 'ReassignReference', 'V2024ReassignReference'] +--- + +# ReassignReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The ID of item or identity being reassigned. | +**Type** | **string** | The type of item or identity being reassigned. | + +## Methods + +### NewReassignReference + +`func NewReassignReference(id string, type_ string, ) *ReassignReference` + +NewReassignReference instantiates a new ReassignReference 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 + +### NewReassignReferenceWithDefaults + +`func NewReassignReferenceWithDefaults() *ReassignReference` + +NewReassignReferenceWithDefaults instantiates a new ReassignReference 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 + +### GetId + +`func (o *ReassignReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReassignReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReassignReference) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *ReassignReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReassignReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReassignReference) SetType(v string)` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Reassignment.md b/docs/tools/sdk/go/Reference/V2024/Models/Reassignment.md new file mode 100644 index 000000000..a9792a8ec --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Reassignment.md @@ -0,0 +1,90 @@ +--- +id: v2024-reassignment +title: Reassignment +pagination_label: Reassignment +sidebar_label: Reassignment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Reassignment', 'V2024Reassignment'] +slug: /tools/sdk/go/v2024/models/reassignment +tags: ['SDK', 'Software Development Kit', 'Reassignment', 'V2024Reassignment'] +--- + +# Reassignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**From** | Pointer to [**CertificationReference**](certification-reference) | | [optional] +**Comment** | Pointer to **string** | The comment entered when the Certification was reassigned | [optional] + +## Methods + +### NewReassignment + +`func NewReassignment() *Reassignment` + +NewReassignment instantiates a new Reassignment 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 + +### NewReassignmentWithDefaults + +`func NewReassignmentWithDefaults() *Reassignment` + +NewReassignmentWithDefaults instantiates a new Reassignment 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 + +### GetFrom + +`func (o *Reassignment) GetFrom() CertificationReference` + +GetFrom returns the From field if non-nil, zero value otherwise. + +### GetFromOk + +`func (o *Reassignment) GetFromOk() (*CertificationReference, bool)` + +GetFromOk returns a tuple with the From field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrom + +`func (o *Reassignment) SetFrom(v CertificationReference)` + +SetFrom sets From field to given value. + +### HasFrom + +`func (o *Reassignment) HasFrom() bool` + +HasFrom returns a boolean if a field has been set. + +### GetComment + +`func (o *Reassignment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *Reassignment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *Reassignment) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *Reassignment) HasComment() bool` + +HasComment returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReassignmentReference.md b/docs/tools/sdk/go/Reference/V2024/Models/ReassignmentReference.md new file mode 100644 index 000000000..76ffccc19 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReassignmentReference.md @@ -0,0 +1,80 @@ +--- +id: v2024-reassignment-reference +title: ReassignmentReference +pagination_label: ReassignmentReference +sidebar_label: ReassignmentReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignmentReference', 'V2024ReassignmentReference'] +slug: /tools/sdk/go/v2024/models/reassignment-reference +tags: ['SDK', 'Software Development Kit', 'ReassignmentReference', 'V2024ReassignmentReference'] +--- + +# ReassignmentReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The ID of item or identity being reassigned. | +**Type** | **string** | The type of item or identity being reassigned. | + +## Methods + +### NewReassignmentReference + +`func NewReassignmentReference(id string, type_ string, ) *ReassignmentReference` + +NewReassignmentReference instantiates a new ReassignmentReference 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 + +### NewReassignmentReferenceWithDefaults + +`func NewReassignmentReferenceWithDefaults() *ReassignmentReference` + +NewReassignmentReferenceWithDefaults instantiates a new ReassignmentReference 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 + +### GetId + +`func (o *ReassignmentReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReassignmentReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReassignmentReference) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *ReassignmentReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReassignmentReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReassignmentReference) SetType(v string)` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReassignmentTrailDTO.md b/docs/tools/sdk/go/Reference/V2024/Models/ReassignmentTrailDTO.md new file mode 100644 index 000000000..87f5d4082 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReassignmentTrailDTO.md @@ -0,0 +1,116 @@ +--- +id: v2024-reassignment-trail-dto +title: ReassignmentTrailDTO +pagination_label: ReassignmentTrailDTO +sidebar_label: ReassignmentTrailDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignmentTrailDTO', 'V2024ReassignmentTrailDTO'] +slug: /tools/sdk/go/v2024/models/reassignment-trail-dto +tags: ['SDK', 'Software Development Kit', 'ReassignmentTrailDTO', 'V2024ReassignmentTrailDTO'] +--- + +# ReassignmentTrailDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PreviousOwner** | Pointer to **string** | The ID of previous owner identity. | [optional] +**NewOwner** | Pointer to **string** | The ID of new owner identity. | [optional] +**ReassignmentType** | Pointer to **string** | The type of reassignment. | [optional] + +## Methods + +### NewReassignmentTrailDTO + +`func NewReassignmentTrailDTO() *ReassignmentTrailDTO` + +NewReassignmentTrailDTO instantiates a new ReassignmentTrailDTO 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 + +### NewReassignmentTrailDTOWithDefaults + +`func NewReassignmentTrailDTOWithDefaults() *ReassignmentTrailDTO` + +NewReassignmentTrailDTOWithDefaults instantiates a new ReassignmentTrailDTO 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 + +### GetPreviousOwner + +`func (o *ReassignmentTrailDTO) GetPreviousOwner() string` + +GetPreviousOwner returns the PreviousOwner field if non-nil, zero value otherwise. + +### GetPreviousOwnerOk + +`func (o *ReassignmentTrailDTO) GetPreviousOwnerOk() (*string, bool)` + +GetPreviousOwnerOk returns a tuple with the PreviousOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousOwner + +`func (o *ReassignmentTrailDTO) SetPreviousOwner(v string)` + +SetPreviousOwner sets PreviousOwner field to given value. + +### HasPreviousOwner + +`func (o *ReassignmentTrailDTO) HasPreviousOwner() bool` + +HasPreviousOwner returns a boolean if a field has been set. + +### GetNewOwner + +`func (o *ReassignmentTrailDTO) GetNewOwner() string` + +GetNewOwner returns the NewOwner field if non-nil, zero value otherwise. + +### GetNewOwnerOk + +`func (o *ReassignmentTrailDTO) GetNewOwnerOk() (*string, bool)` + +GetNewOwnerOk returns a tuple with the NewOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewOwner + +`func (o *ReassignmentTrailDTO) SetNewOwner(v string)` + +SetNewOwner sets NewOwner field to given value. + +### HasNewOwner + +`func (o *ReassignmentTrailDTO) HasNewOwner() bool` + +HasNewOwner returns a boolean if a field has been set. + +### GetReassignmentType + +`func (o *ReassignmentTrailDTO) GetReassignmentType() string` + +GetReassignmentType returns the ReassignmentType field if non-nil, zero value otherwise. + +### GetReassignmentTypeOk + +`func (o *ReassignmentTrailDTO) GetReassignmentTypeOk() (*string, bool)` + +GetReassignmentTypeOk returns a tuple with the ReassignmentType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignmentType + +`func (o *ReassignmentTrailDTO) SetReassignmentType(v string)` + +SetReassignmentType sets ReassignmentType field to given value. + +### HasReassignmentType + +`func (o *ReassignmentTrailDTO) HasReassignmentType() bool` + +HasReassignmentType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReassignmentType.md b/docs/tools/sdk/go/Reference/V2024/Models/ReassignmentType.md new file mode 100644 index 000000000..7aecdb261 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReassignmentType.md @@ -0,0 +1,25 @@ +--- +id: v2024-reassignment-type +title: ReassignmentType +pagination_label: ReassignmentType +sidebar_label: ReassignmentType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignmentType', 'V2024ReassignmentType'] +slug: /tools/sdk/go/v2024/models/reassignment-type +tags: ['SDK', 'Software Development Kit', 'ReassignmentType', 'V2024ReassignmentType'] +--- + +# ReassignmentType + +## Enum + + +* `MANUAL_REASSIGNMENT` (value: `"MANUAL_REASSIGNMENT"`) + +* `AUTOMATIC_REASSIGNMENT` (value: `"AUTOMATIC_REASSIGNMENT"`) + +* `AUTO_ESCALATION` (value: `"AUTO_ESCALATION"`) + +* `SELF_REVIEW_DELEGATION` (value: `"SELF_REVIEW_DELEGATION"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReassignmentTypeEnum.md b/docs/tools/sdk/go/Reference/V2024/Models/ReassignmentTypeEnum.md new file mode 100644 index 000000000..f600c356b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReassignmentTypeEnum.md @@ -0,0 +1,25 @@ +--- +id: v2024-reassignment-type-enum +title: ReassignmentTypeEnum +pagination_label: ReassignmentTypeEnum +sidebar_label: ReassignmentTypeEnum +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignmentTypeEnum', 'V2024ReassignmentTypeEnum'] +slug: /tools/sdk/go/v2024/models/reassignment-type-enum +tags: ['SDK', 'Software Development Kit', 'ReassignmentTypeEnum', 'V2024ReassignmentTypeEnum'] +--- + +# ReassignmentTypeEnum + +## Enum + + +* `MANUAL_REASSIGNMENT` (value: `"MANUAL_REASSIGNMENT,"`) + +* `AUTOMATIC_REASSIGNMENT` (value: `"AUTOMATIC_REASSIGNMENT,"`) + +* `AUTO_ESCALATION` (value: `"AUTO_ESCALATION,"`) + +* `SELF_REVIEW_DELEGATION` (value: `"SELF_REVIEW_DELEGATION"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Recommendation.md b/docs/tools/sdk/go/Reference/V2024/Models/Recommendation.md new file mode 100644 index 000000000..868512ec2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Recommendation.md @@ -0,0 +1,80 @@ +--- +id: v2024-recommendation +title: Recommendation +pagination_label: Recommendation +sidebar_label: Recommendation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Recommendation', 'V2024Recommendation'] +slug: /tools/sdk/go/v2024/models/recommendation +tags: ['SDK', 'Software Development Kit', 'Recommendation', 'V2024Recommendation'] +--- + +# Recommendation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Recommended type of account. | +**Method** | **string** | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | + +## Methods + +### NewRecommendation + +`func NewRecommendation(type_ string, method string, ) *Recommendation` + +NewRecommendation instantiates a new Recommendation 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 + +### NewRecommendationWithDefaults + +`func NewRecommendationWithDefaults() *Recommendation` + +NewRecommendationWithDefaults instantiates a new Recommendation 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 + +### GetType + +`func (o *Recommendation) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Recommendation) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Recommendation) SetType(v string)` + +SetType sets Type field to given value. + + +### GetMethod + +`func (o *Recommendation) GetMethod() string` + +GetMethod returns the Method field if non-nil, zero value otherwise. + +### GetMethodOk + +`func (o *Recommendation) GetMethodOk() (*string, bool)` + +GetMethodOk returns a tuple with the Method field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMethod + +`func (o *Recommendation) SetMethod(v string)` + +SetMethod sets Method field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RecommendationConfigDto.md b/docs/tools/sdk/go/Reference/V2024/Models/RecommendationConfigDto.md new file mode 100644 index 000000000..b3983efbb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RecommendationConfigDto.md @@ -0,0 +1,142 @@ +--- +id: v2024-recommendation-config-dto +title: RecommendationConfigDto +pagination_label: RecommendationConfigDto +sidebar_label: RecommendationConfigDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommendationConfigDto', 'V2024RecommendationConfigDto'] +slug: /tools/sdk/go/v2024/models/recommendation-config-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationConfigDto', 'V2024RecommendationConfigDto'] +--- + +# RecommendationConfigDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RecommenderFeatures** | Pointer to **[]string** | List of identity attributes to use for calculating certification recommendations | [optional] +**PeerGroupPercentageThreshold** | Pointer to **float32** | The percent value that the recommendation calculation must surpass to produce a YES recommendation | [optional] +**RunAutoSelectOnce** | Pointer to **bool** | If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run | [optional] [default to false] +**OnlyTuneThreshold** | Pointer to **bool** | If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run | [optional] [default to false] + +## Methods + +### NewRecommendationConfigDto + +`func NewRecommendationConfigDto() *RecommendationConfigDto` + +NewRecommendationConfigDto instantiates a new RecommendationConfigDto 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 + +### NewRecommendationConfigDtoWithDefaults + +`func NewRecommendationConfigDtoWithDefaults() *RecommendationConfigDto` + +NewRecommendationConfigDtoWithDefaults instantiates a new RecommendationConfigDto 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 + +### GetRecommenderFeatures + +`func (o *RecommendationConfigDto) GetRecommenderFeatures() []string` + +GetRecommenderFeatures returns the RecommenderFeatures field if non-nil, zero value otherwise. + +### GetRecommenderFeaturesOk + +`func (o *RecommendationConfigDto) GetRecommenderFeaturesOk() (*[]string, bool)` + +GetRecommenderFeaturesOk returns a tuple with the RecommenderFeatures field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommenderFeatures + +`func (o *RecommendationConfigDto) SetRecommenderFeatures(v []string)` + +SetRecommenderFeatures sets RecommenderFeatures field to given value. + +### HasRecommenderFeatures + +`func (o *RecommendationConfigDto) HasRecommenderFeatures() bool` + +HasRecommenderFeatures returns a boolean if a field has been set. + +### GetPeerGroupPercentageThreshold + +`func (o *RecommendationConfigDto) GetPeerGroupPercentageThreshold() float32` + +GetPeerGroupPercentageThreshold returns the PeerGroupPercentageThreshold field if non-nil, zero value otherwise. + +### GetPeerGroupPercentageThresholdOk + +`func (o *RecommendationConfigDto) GetPeerGroupPercentageThresholdOk() (*float32, bool)` + +GetPeerGroupPercentageThresholdOk returns a tuple with the PeerGroupPercentageThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPeerGroupPercentageThreshold + +`func (o *RecommendationConfigDto) SetPeerGroupPercentageThreshold(v float32)` + +SetPeerGroupPercentageThreshold sets PeerGroupPercentageThreshold field to given value. + +### HasPeerGroupPercentageThreshold + +`func (o *RecommendationConfigDto) HasPeerGroupPercentageThreshold() bool` + +HasPeerGroupPercentageThreshold returns a boolean if a field has been set. + +### GetRunAutoSelectOnce + +`func (o *RecommendationConfigDto) GetRunAutoSelectOnce() bool` + +GetRunAutoSelectOnce returns the RunAutoSelectOnce field if non-nil, zero value otherwise. + +### GetRunAutoSelectOnceOk + +`func (o *RecommendationConfigDto) GetRunAutoSelectOnceOk() (*bool, bool)` + +GetRunAutoSelectOnceOk returns a tuple with the RunAutoSelectOnce field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRunAutoSelectOnce + +`func (o *RecommendationConfigDto) SetRunAutoSelectOnce(v bool)` + +SetRunAutoSelectOnce sets RunAutoSelectOnce field to given value. + +### HasRunAutoSelectOnce + +`func (o *RecommendationConfigDto) HasRunAutoSelectOnce() bool` + +HasRunAutoSelectOnce returns a boolean if a field has been set. + +### GetOnlyTuneThreshold + +`func (o *RecommendationConfigDto) GetOnlyTuneThreshold() bool` + +GetOnlyTuneThreshold returns the OnlyTuneThreshold field if non-nil, zero value otherwise. + +### GetOnlyTuneThresholdOk + +`func (o *RecommendationConfigDto) GetOnlyTuneThresholdOk() (*bool, bool)` + +GetOnlyTuneThresholdOk returns a tuple with the OnlyTuneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOnlyTuneThreshold + +`func (o *RecommendationConfigDto) SetOnlyTuneThreshold(v bool)` + +SetOnlyTuneThreshold sets OnlyTuneThreshold field to given value. + +### HasOnlyTuneThreshold + +`func (o *RecommendationConfigDto) HasOnlyTuneThreshold() bool` + +HasOnlyTuneThreshold returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RecommendationRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/RecommendationRequest.md new file mode 100644 index 000000000..d1bafe1e1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RecommendationRequest.md @@ -0,0 +1,90 @@ +--- +id: v2024-recommendation-request +title: RecommendationRequest +pagination_label: RecommendationRequest +sidebar_label: RecommendationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommendationRequest', 'V2024RecommendationRequest'] +slug: /tools/sdk/go/v2024/models/recommendation-request +tags: ['SDK', 'Software Development Kit', 'RecommendationRequest', 'V2024RecommendationRequest'] +--- + +# RecommendationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | The identity ID | [optional] +**Item** | Pointer to [**AccessItemRef**](access-item-ref) | | [optional] + +## Methods + +### NewRecommendationRequest + +`func NewRecommendationRequest() *RecommendationRequest` + +NewRecommendationRequest instantiates a new RecommendationRequest 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 + +### NewRecommendationRequestWithDefaults + +`func NewRecommendationRequestWithDefaults() *RecommendationRequest` + +NewRecommendationRequestWithDefaults instantiates a new RecommendationRequest 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 + +### GetIdentityId + +`func (o *RecommendationRequest) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *RecommendationRequest) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *RecommendationRequest) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *RecommendationRequest) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetItem + +`func (o *RecommendationRequest) GetItem() AccessItemRef` + +GetItem returns the Item field if non-nil, zero value otherwise. + +### GetItemOk + +`func (o *RecommendationRequest) GetItemOk() (*AccessItemRef, bool)` + +GetItemOk returns a tuple with the Item field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItem + +`func (o *RecommendationRequest) SetItem(v AccessItemRef)` + +SetItem sets Item field to given value. + +### HasItem + +`func (o *RecommendationRequest) HasItem() bool` + +HasItem returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RecommendationRequestDto.md b/docs/tools/sdk/go/Reference/V2024/Models/RecommendationRequestDto.md new file mode 100644 index 000000000..559aaa5d9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RecommendationRequestDto.md @@ -0,0 +1,168 @@ +--- +id: v2024-recommendation-request-dto +title: RecommendationRequestDto +pagination_label: RecommendationRequestDto +sidebar_label: RecommendationRequestDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommendationRequestDto', 'V2024RecommendationRequestDto'] +slug: /tools/sdk/go/v2024/models/recommendation-request-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationRequestDto', 'V2024RecommendationRequestDto'] +--- + +# RecommendationRequestDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Requests** | Pointer to [**[]RecommendationRequest**](recommendation-request) | | [optional] +**ExcludeInterpretations** | Pointer to **bool** | Exclude interpretations in the response if \"true\". Return interpretations in the response if this attribute is not specified. | [optional] [default to false] +**IncludeTranslationMessages** | Pointer to **bool** | When set to true, the calling system uses the translated messages for the specified language | [optional] [default to false] +**IncludeDebugInformation** | Pointer to **bool** | Returns the recommender calculations if set to true | [optional] [default to false] +**PrescribeMode** | Pointer to **bool** | When set to true, uses prescribedRulesRecommenderConfig to get identity attributes and peer group threshold instead of standard config. | [optional] [default to false] + +## Methods + +### NewRecommendationRequestDto + +`func NewRecommendationRequestDto() *RecommendationRequestDto` + +NewRecommendationRequestDto instantiates a new RecommendationRequestDto 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 + +### NewRecommendationRequestDtoWithDefaults + +`func NewRecommendationRequestDtoWithDefaults() *RecommendationRequestDto` + +NewRecommendationRequestDtoWithDefaults instantiates a new RecommendationRequestDto 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 + +### GetRequests + +`func (o *RecommendationRequestDto) GetRequests() []RecommendationRequest` + +GetRequests returns the Requests field if non-nil, zero value otherwise. + +### GetRequestsOk + +`func (o *RecommendationRequestDto) GetRequestsOk() (*[]RecommendationRequest, bool)` + +GetRequestsOk returns a tuple with the Requests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequests + +`func (o *RecommendationRequestDto) SetRequests(v []RecommendationRequest)` + +SetRequests sets Requests field to given value. + +### HasRequests + +`func (o *RecommendationRequestDto) HasRequests() bool` + +HasRequests returns a boolean if a field has been set. + +### GetExcludeInterpretations + +`func (o *RecommendationRequestDto) GetExcludeInterpretations() bool` + +GetExcludeInterpretations returns the ExcludeInterpretations field if non-nil, zero value otherwise. + +### GetExcludeInterpretationsOk + +`func (o *RecommendationRequestDto) GetExcludeInterpretationsOk() (*bool, bool)` + +GetExcludeInterpretationsOk returns a tuple with the ExcludeInterpretations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeInterpretations + +`func (o *RecommendationRequestDto) SetExcludeInterpretations(v bool)` + +SetExcludeInterpretations sets ExcludeInterpretations field to given value. + +### HasExcludeInterpretations + +`func (o *RecommendationRequestDto) HasExcludeInterpretations() bool` + +HasExcludeInterpretations returns a boolean if a field has been set. + +### GetIncludeTranslationMessages + +`func (o *RecommendationRequestDto) GetIncludeTranslationMessages() bool` + +GetIncludeTranslationMessages returns the IncludeTranslationMessages field if non-nil, zero value otherwise. + +### GetIncludeTranslationMessagesOk + +`func (o *RecommendationRequestDto) GetIncludeTranslationMessagesOk() (*bool, bool)` + +GetIncludeTranslationMessagesOk returns a tuple with the IncludeTranslationMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTranslationMessages + +`func (o *RecommendationRequestDto) SetIncludeTranslationMessages(v bool)` + +SetIncludeTranslationMessages sets IncludeTranslationMessages field to given value. + +### HasIncludeTranslationMessages + +`func (o *RecommendationRequestDto) HasIncludeTranslationMessages() bool` + +HasIncludeTranslationMessages returns a boolean if a field has been set. + +### GetIncludeDebugInformation + +`func (o *RecommendationRequestDto) GetIncludeDebugInformation() bool` + +GetIncludeDebugInformation returns the IncludeDebugInformation field if non-nil, zero value otherwise. + +### GetIncludeDebugInformationOk + +`func (o *RecommendationRequestDto) GetIncludeDebugInformationOk() (*bool, bool)` + +GetIncludeDebugInformationOk returns a tuple with the IncludeDebugInformation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeDebugInformation + +`func (o *RecommendationRequestDto) SetIncludeDebugInformation(v bool)` + +SetIncludeDebugInformation sets IncludeDebugInformation field to given value. + +### HasIncludeDebugInformation + +`func (o *RecommendationRequestDto) HasIncludeDebugInformation() bool` + +HasIncludeDebugInformation returns a boolean if a field has been set. + +### GetPrescribeMode + +`func (o *RecommendationRequestDto) GetPrescribeMode() bool` + +GetPrescribeMode returns the PrescribeMode field if non-nil, zero value otherwise. + +### GetPrescribeModeOk + +`func (o *RecommendationRequestDto) GetPrescribeModeOk() (*bool, bool)` + +GetPrescribeModeOk returns a tuple with the PrescribeMode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrescribeMode + +`func (o *RecommendationRequestDto) SetPrescribeMode(v bool)` + +SetPrescribeMode sets PrescribeMode field to given value. + +### HasPrescribeMode + +`func (o *RecommendationRequestDto) HasPrescribeMode() bool` + +HasPrescribeMode returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RecommendationResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/RecommendationResponse.md new file mode 100644 index 000000000..b1535d767 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RecommendationResponse.md @@ -0,0 +1,168 @@ +--- +id: v2024-recommendation-response +title: RecommendationResponse +pagination_label: RecommendationResponse +sidebar_label: RecommendationResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommendationResponse', 'V2024RecommendationResponse'] +slug: /tools/sdk/go/v2024/models/recommendation-response +tags: ['SDK', 'Software Development Kit', 'RecommendationResponse', 'V2024RecommendationResponse'] +--- + +# RecommendationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Request** | Pointer to [**RecommendationRequest**](recommendation-request) | | [optional] +**Recommendation** | Pointer to **string** | The recommendation - YES if the access is recommended, NO if not recommended, MAYBE if there is not enough information to make a recommendation, NOT_FOUND if the identity is not found in the system | [optional] +**Interpretations** | Pointer to **[]string** | The list of interpretations explaining the recommendation. The array is empty if includeInterpretations is false or not present in the request. e.g. - [ \"Not approved in the last 6 months.\" ]. Interpretations will be translated using the client's locale as found in the Accept-Language header. If a translation for the client's locale cannot be found, the US English translation will be returned. | [optional] +**TranslationMessages** | Pointer to [**[]TranslationMessage**](translation-message) | The list of translation messages, if they have been requested. | [optional] +**RecommenderCalculations** | Pointer to [**RecommenderCalculations**](recommender-calculations) | | [optional] + +## Methods + +### NewRecommendationResponse + +`func NewRecommendationResponse() *RecommendationResponse` + +NewRecommendationResponse instantiates a new RecommendationResponse 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 + +### NewRecommendationResponseWithDefaults + +`func NewRecommendationResponseWithDefaults() *RecommendationResponse` + +NewRecommendationResponseWithDefaults instantiates a new RecommendationResponse 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 + +### GetRequest + +`func (o *RecommendationResponse) GetRequest() RecommendationRequest` + +GetRequest returns the Request field if non-nil, zero value otherwise. + +### GetRequestOk + +`func (o *RecommendationResponse) GetRequestOk() (*RecommendationRequest, bool)` + +GetRequestOk returns a tuple with the Request field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequest + +`func (o *RecommendationResponse) SetRequest(v RecommendationRequest)` + +SetRequest sets Request field to given value. + +### HasRequest + +`func (o *RecommendationResponse) HasRequest() bool` + +HasRequest returns a boolean if a field has been set. + +### GetRecommendation + +`func (o *RecommendationResponse) GetRecommendation() string` + +GetRecommendation returns the Recommendation field if non-nil, zero value otherwise. + +### GetRecommendationOk + +`func (o *RecommendationResponse) GetRecommendationOk() (*string, bool)` + +GetRecommendationOk returns a tuple with the Recommendation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendation + +`func (o *RecommendationResponse) SetRecommendation(v string)` + +SetRecommendation sets Recommendation field to given value. + +### HasRecommendation + +`func (o *RecommendationResponse) HasRecommendation() bool` + +HasRecommendation returns a boolean if a field has been set. + +### GetInterpretations + +`func (o *RecommendationResponse) GetInterpretations() []string` + +GetInterpretations returns the Interpretations field if non-nil, zero value otherwise. + +### GetInterpretationsOk + +`func (o *RecommendationResponse) GetInterpretationsOk() (*[]string, bool)` + +GetInterpretationsOk returns a tuple with the Interpretations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterpretations + +`func (o *RecommendationResponse) SetInterpretations(v []string)` + +SetInterpretations sets Interpretations field to given value. + +### HasInterpretations + +`func (o *RecommendationResponse) HasInterpretations() bool` + +HasInterpretations returns a boolean if a field has been set. + +### GetTranslationMessages + +`func (o *RecommendationResponse) GetTranslationMessages() []TranslationMessage` + +GetTranslationMessages returns the TranslationMessages field if non-nil, zero value otherwise. + +### GetTranslationMessagesOk + +`func (o *RecommendationResponse) GetTranslationMessagesOk() (*[]TranslationMessage, bool)` + +GetTranslationMessagesOk returns a tuple with the TranslationMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslationMessages + +`func (o *RecommendationResponse) SetTranslationMessages(v []TranslationMessage)` + +SetTranslationMessages sets TranslationMessages field to given value. + +### HasTranslationMessages + +`func (o *RecommendationResponse) HasTranslationMessages() bool` + +HasTranslationMessages returns a boolean if a field has been set. + +### GetRecommenderCalculations + +`func (o *RecommendationResponse) GetRecommenderCalculations() RecommenderCalculations` + +GetRecommenderCalculations returns the RecommenderCalculations field if non-nil, zero value otherwise. + +### GetRecommenderCalculationsOk + +`func (o *RecommendationResponse) GetRecommenderCalculationsOk() (*RecommenderCalculations, bool)` + +GetRecommenderCalculationsOk returns a tuple with the RecommenderCalculations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommenderCalculations + +`func (o *RecommendationResponse) SetRecommenderCalculations(v RecommenderCalculations)` + +SetRecommenderCalculations sets RecommenderCalculations field to given value. + +### HasRecommenderCalculations + +`func (o *RecommendationResponse) HasRecommenderCalculations() bool` + +HasRecommenderCalculations returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RecommendationResponseDto.md b/docs/tools/sdk/go/Reference/V2024/Models/RecommendationResponseDto.md new file mode 100644 index 000000000..22c45f822 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RecommendationResponseDto.md @@ -0,0 +1,64 @@ +--- +id: v2024-recommendation-response-dto +title: RecommendationResponseDto +pagination_label: RecommendationResponseDto +sidebar_label: RecommendationResponseDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommendationResponseDto', 'V2024RecommendationResponseDto'] +slug: /tools/sdk/go/v2024/models/recommendation-response-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationResponseDto', 'V2024RecommendationResponseDto'] +--- + +# RecommendationResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Response** | Pointer to [**[]RecommendationResponse**](recommendation-response) | | [optional] + +## Methods + +### NewRecommendationResponseDto + +`func NewRecommendationResponseDto() *RecommendationResponseDto` + +NewRecommendationResponseDto instantiates a new RecommendationResponseDto 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 + +### NewRecommendationResponseDtoWithDefaults + +`func NewRecommendationResponseDtoWithDefaults() *RecommendationResponseDto` + +NewRecommendationResponseDtoWithDefaults instantiates a new RecommendationResponseDto 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 + +### GetResponse + +`func (o *RecommendationResponseDto) GetResponse() []RecommendationResponse` + +GetResponse returns the Response field if non-nil, zero value otherwise. + +### GetResponseOk + +`func (o *RecommendationResponseDto) GetResponseOk() (*[]RecommendationResponse, bool)` + +GetResponseOk returns a tuple with the Response field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponse + +`func (o *RecommendationResponseDto) SetResponse(v []RecommendationResponse)` + +SetResponse sets Response field to given value. + +### HasResponse + +`func (o *RecommendationResponseDto) HasResponse() bool` + +HasResponse returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RecommenderCalculations.md b/docs/tools/sdk/go/Reference/V2024/Models/RecommenderCalculations.md new file mode 100644 index 000000000..d05326dc6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RecommenderCalculations.md @@ -0,0 +1,246 @@ +--- +id: v2024-recommender-calculations +title: RecommenderCalculations +pagination_label: RecommenderCalculations +sidebar_label: RecommenderCalculations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommenderCalculations', 'V2024RecommenderCalculations'] +slug: /tools/sdk/go/v2024/models/recommender-calculations +tags: ['SDK', 'Software Development Kit', 'RecommenderCalculations', 'V2024RecommenderCalculations'] +--- + +# RecommenderCalculations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | The ID of the identity | [optional] +**EntitlementId** | Pointer to **string** | The entitlement ID | [optional] +**Recommendation** | Pointer to **string** | The actual recommendation | [optional] +**OverallWeightedScore** | Pointer to **float32** | The overall weighted score | [optional] +**FeatureWeightedScores** | Pointer to **map[string]float32** | The weighted score of each individual feature | [optional] +**Threshold** | Pointer to **float32** | The configured value against which the overallWeightedScore is compared | [optional] +**IdentityAttributes** | Pointer to [**map[string]RecommenderCalculationsIdentityAttributesValue**](recommender-calculations-identity-attributes-value) | The values for your configured features | [optional] +**FeatureValues** | Pointer to [**FeatureValueDto**](feature-value-dto) | | [optional] + +## Methods + +### NewRecommenderCalculations + +`func NewRecommenderCalculations() *RecommenderCalculations` + +NewRecommenderCalculations instantiates a new RecommenderCalculations 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 + +### NewRecommenderCalculationsWithDefaults + +`func NewRecommenderCalculationsWithDefaults() *RecommenderCalculations` + +NewRecommenderCalculationsWithDefaults instantiates a new RecommenderCalculations 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 + +### GetIdentityId + +`func (o *RecommenderCalculations) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *RecommenderCalculations) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *RecommenderCalculations) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *RecommenderCalculations) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEntitlementId + +`func (o *RecommenderCalculations) GetEntitlementId() string` + +GetEntitlementId returns the EntitlementId field if non-nil, zero value otherwise. + +### GetEntitlementIdOk + +`func (o *RecommenderCalculations) GetEntitlementIdOk() (*string, bool)` + +GetEntitlementIdOk returns a tuple with the EntitlementId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementId + +`func (o *RecommenderCalculations) SetEntitlementId(v string)` + +SetEntitlementId sets EntitlementId field to given value. + +### HasEntitlementId + +`func (o *RecommenderCalculations) HasEntitlementId() bool` + +HasEntitlementId returns a boolean if a field has been set. + +### GetRecommendation + +`func (o *RecommenderCalculations) GetRecommendation() string` + +GetRecommendation returns the Recommendation field if non-nil, zero value otherwise. + +### GetRecommendationOk + +`func (o *RecommenderCalculations) GetRecommendationOk() (*string, bool)` + +GetRecommendationOk returns a tuple with the Recommendation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendation + +`func (o *RecommenderCalculations) SetRecommendation(v string)` + +SetRecommendation sets Recommendation field to given value. + +### HasRecommendation + +`func (o *RecommenderCalculations) HasRecommendation() bool` + +HasRecommendation returns a boolean if a field has been set. + +### GetOverallWeightedScore + +`func (o *RecommenderCalculations) GetOverallWeightedScore() float32` + +GetOverallWeightedScore returns the OverallWeightedScore field if non-nil, zero value otherwise. + +### GetOverallWeightedScoreOk + +`func (o *RecommenderCalculations) GetOverallWeightedScoreOk() (*float32, bool)` + +GetOverallWeightedScoreOk returns a tuple with the OverallWeightedScore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOverallWeightedScore + +`func (o *RecommenderCalculations) SetOverallWeightedScore(v float32)` + +SetOverallWeightedScore sets OverallWeightedScore field to given value. + +### HasOverallWeightedScore + +`func (o *RecommenderCalculations) HasOverallWeightedScore() bool` + +HasOverallWeightedScore returns a boolean if a field has been set. + +### GetFeatureWeightedScores + +`func (o *RecommenderCalculations) GetFeatureWeightedScores() map[string]float32` + +GetFeatureWeightedScores returns the FeatureWeightedScores field if non-nil, zero value otherwise. + +### GetFeatureWeightedScoresOk + +`func (o *RecommenderCalculations) GetFeatureWeightedScoresOk() (*map[string]float32, bool)` + +GetFeatureWeightedScoresOk returns a tuple with the FeatureWeightedScores field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureWeightedScores + +`func (o *RecommenderCalculations) SetFeatureWeightedScores(v map[string]float32)` + +SetFeatureWeightedScores sets FeatureWeightedScores field to given value. + +### HasFeatureWeightedScores + +`func (o *RecommenderCalculations) HasFeatureWeightedScores() bool` + +HasFeatureWeightedScores returns a boolean if a field has been set. + +### GetThreshold + +`func (o *RecommenderCalculations) GetThreshold() float32` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *RecommenderCalculations) GetThresholdOk() (*float32, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *RecommenderCalculations) SetThreshold(v float32)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *RecommenderCalculations) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetIdentityAttributes + +`func (o *RecommenderCalculations) GetIdentityAttributes() map[string]RecommenderCalculationsIdentityAttributesValue` + +GetIdentityAttributes returns the IdentityAttributes field if non-nil, zero value otherwise. + +### GetIdentityAttributesOk + +`func (o *RecommenderCalculations) GetIdentityAttributesOk() (*map[string]RecommenderCalculationsIdentityAttributesValue, bool)` + +GetIdentityAttributesOk returns a tuple with the IdentityAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributes + +`func (o *RecommenderCalculations) SetIdentityAttributes(v map[string]RecommenderCalculationsIdentityAttributesValue)` + +SetIdentityAttributes sets IdentityAttributes field to given value. + +### HasIdentityAttributes + +`func (o *RecommenderCalculations) HasIdentityAttributes() bool` + +HasIdentityAttributes returns a boolean if a field has been set. + +### GetFeatureValues + +`func (o *RecommenderCalculations) GetFeatureValues() FeatureValueDto` + +GetFeatureValues returns the FeatureValues field if non-nil, zero value otherwise. + +### GetFeatureValuesOk + +`func (o *RecommenderCalculations) GetFeatureValuesOk() (*FeatureValueDto, bool)` + +GetFeatureValuesOk returns a tuple with the FeatureValues field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureValues + +`func (o *RecommenderCalculations) SetFeatureValues(v FeatureValueDto)` + +SetFeatureValues sets FeatureValues field to given value. + +### HasFeatureValues + +`func (o *RecommenderCalculations) HasFeatureValues() bool` + +HasFeatureValues returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RecommenderCalculationsIdentityAttributesValue.md b/docs/tools/sdk/go/Reference/V2024/Models/RecommenderCalculationsIdentityAttributesValue.md new file mode 100644 index 000000000..64c359bae --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RecommenderCalculationsIdentityAttributesValue.md @@ -0,0 +1,64 @@ +--- +id: v2024-recommender-calculations-identity-attributes-value +title: RecommenderCalculationsIdentityAttributesValue +pagination_label: RecommenderCalculationsIdentityAttributesValue +sidebar_label: RecommenderCalculationsIdentityAttributesValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommenderCalculationsIdentityAttributesValue', 'V2024RecommenderCalculationsIdentityAttributesValue'] +slug: /tools/sdk/go/v2024/models/recommender-calculations-identity-attributes-value +tags: ['SDK', 'Software Development Kit', 'RecommenderCalculationsIdentityAttributesValue', 'V2024RecommenderCalculationsIdentityAttributesValue'] +--- + +# RecommenderCalculationsIdentityAttributesValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | | [optional] + +## Methods + +### NewRecommenderCalculationsIdentityAttributesValue + +`func NewRecommenderCalculationsIdentityAttributesValue() *RecommenderCalculationsIdentityAttributesValue` + +NewRecommenderCalculationsIdentityAttributesValue instantiates a new RecommenderCalculationsIdentityAttributesValue 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 + +### NewRecommenderCalculationsIdentityAttributesValueWithDefaults + +`func NewRecommenderCalculationsIdentityAttributesValueWithDefaults() *RecommenderCalculationsIdentityAttributesValue` + +NewRecommenderCalculationsIdentityAttributesValueWithDefaults instantiates a new RecommenderCalculationsIdentityAttributesValue 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 + +### GetValue + +`func (o *RecommenderCalculationsIdentityAttributesValue) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *RecommenderCalculationsIdentityAttributesValue) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *RecommenderCalculationsIdentityAttributesValue) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *RecommenderCalculationsIdentityAttributesValue) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Ref.md b/docs/tools/sdk/go/Reference/V2024/Models/Ref.md new file mode 100644 index 000000000..c44619929 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Ref.md @@ -0,0 +1,90 @@ +--- +id: v2024-ref +title: Ref +pagination_label: Ref +sidebar_label: Ref +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Ref', 'V2024Ref'] +slug: /tools/sdk/go/v2024/models/ref +tags: ['SDK', 'Software Development Kit', 'Ref', 'V2024Ref'] +--- + +# Ref + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] + +## Methods + +### NewRef + +`func NewRef() *Ref` + +NewRef instantiates a new Ref 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 + +### NewRefWithDefaults + +`func NewRefWithDefaults() *Ref` + +NewRefWithDefaults instantiates a new Ref 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 + +### GetType + +`func (o *Ref) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Ref) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Ref) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Ref) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *Ref) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Ref) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Ref) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Ref) HasId() bool` + +HasId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Reference.md b/docs/tools/sdk/go/Reference/V2024/Models/Reference.md new file mode 100644 index 000000000..b863b8f90 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Reference.md @@ -0,0 +1,90 @@ +--- +id: v2024-reference +title: Reference +pagination_label: Reference +sidebar_label: Reference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Reference', 'V2024Reference'] +slug: /tools/sdk/go/v2024/models/reference +tags: ['SDK', 'Software Development Kit', 'Reference', 'V2024Reference'] +--- + +# Reference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] + +## Methods + +### NewReference + +`func NewReference() *Reference` + +NewReference instantiates a new Reference 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 + +### NewReferenceWithDefaults + +`func NewReferenceWithDefaults() *Reference` + +NewReferenceWithDefaults instantiates a new Reference 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 + +### GetId + +`func (o *Reference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Reference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Reference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Reference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Reference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Reference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Reference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Reference) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RemediationItemDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/RemediationItemDetails.md new file mode 100644 index 000000000..3ef9fef90 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RemediationItemDetails.md @@ -0,0 +1,272 @@ +--- +id: v2024-remediation-item-details +title: RemediationItemDetails +pagination_label: RemediationItemDetails +sidebar_label: RemediationItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RemediationItemDetails', 'V2024RemediationItemDetails'] +slug: /tools/sdk/go/v2024/models/remediation-item-details +tags: ['SDK', 'Software Development Kit', 'RemediationItemDetails', 'V2024RemediationItemDetails'] +--- + +# RemediationItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the certification | [optional] +**TargetId** | Pointer to **string** | The ID of the certification target | [optional] +**TargetName** | Pointer to **string** | The name of the certification target | [optional] +**TargetDisplayName** | Pointer to **string** | The display name of the certification target | [optional] +**ApplicationName** | Pointer to **string** | The name of the application/source | [optional] +**AttributeName** | Pointer to **string** | The name of the attribute being certified | [optional] +**AttributeOperation** | Pointer to **string** | The operation of the certification on the attribute | [optional] +**AttributeValue** | Pointer to **string** | The value of the attribute being certified | [optional] +**NativeIdentity** | Pointer to **string** | The native identity of the target | [optional] + +## Methods + +### NewRemediationItemDetails + +`func NewRemediationItemDetails() *RemediationItemDetails` + +NewRemediationItemDetails instantiates a new RemediationItemDetails 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 + +### NewRemediationItemDetailsWithDefaults + +`func NewRemediationItemDetailsWithDefaults() *RemediationItemDetails` + +NewRemediationItemDetailsWithDefaults instantiates a new RemediationItemDetails 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 + +### GetId + +`func (o *RemediationItemDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RemediationItemDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RemediationItemDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RemediationItemDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetTargetId + +`func (o *RemediationItemDetails) GetTargetId() string` + +GetTargetId returns the TargetId field if non-nil, zero value otherwise. + +### GetTargetIdOk + +`func (o *RemediationItemDetails) GetTargetIdOk() (*string, bool)` + +GetTargetIdOk returns a tuple with the TargetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetId + +`func (o *RemediationItemDetails) SetTargetId(v string)` + +SetTargetId sets TargetId field to given value. + +### HasTargetId + +`func (o *RemediationItemDetails) HasTargetId() bool` + +HasTargetId returns a boolean if a field has been set. + +### GetTargetName + +`func (o *RemediationItemDetails) GetTargetName() string` + +GetTargetName returns the TargetName field if non-nil, zero value otherwise. + +### GetTargetNameOk + +`func (o *RemediationItemDetails) GetTargetNameOk() (*string, bool)` + +GetTargetNameOk returns a tuple with the TargetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetName + +`func (o *RemediationItemDetails) SetTargetName(v string)` + +SetTargetName sets TargetName field to given value. + +### HasTargetName + +`func (o *RemediationItemDetails) HasTargetName() bool` + +HasTargetName returns a boolean if a field has been set. + +### GetTargetDisplayName + +`func (o *RemediationItemDetails) GetTargetDisplayName() string` + +GetTargetDisplayName returns the TargetDisplayName field if non-nil, zero value otherwise. + +### GetTargetDisplayNameOk + +`func (o *RemediationItemDetails) GetTargetDisplayNameOk() (*string, bool)` + +GetTargetDisplayNameOk returns a tuple with the TargetDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetDisplayName + +`func (o *RemediationItemDetails) SetTargetDisplayName(v string)` + +SetTargetDisplayName sets TargetDisplayName field to given value. + +### HasTargetDisplayName + +`func (o *RemediationItemDetails) HasTargetDisplayName() bool` + +HasTargetDisplayName returns a boolean if a field has been set. + +### GetApplicationName + +`func (o *RemediationItemDetails) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *RemediationItemDetails) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *RemediationItemDetails) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *RemediationItemDetails) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *RemediationItemDetails) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *RemediationItemDetails) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *RemediationItemDetails) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *RemediationItemDetails) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + +### GetAttributeOperation + +`func (o *RemediationItemDetails) GetAttributeOperation() string` + +GetAttributeOperation returns the AttributeOperation field if non-nil, zero value otherwise. + +### GetAttributeOperationOk + +`func (o *RemediationItemDetails) GetAttributeOperationOk() (*string, bool)` + +GetAttributeOperationOk returns a tuple with the AttributeOperation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeOperation + +`func (o *RemediationItemDetails) SetAttributeOperation(v string)` + +SetAttributeOperation sets AttributeOperation field to given value. + +### HasAttributeOperation + +`func (o *RemediationItemDetails) HasAttributeOperation() bool` + +HasAttributeOperation returns a boolean if a field has been set. + +### GetAttributeValue + +`func (o *RemediationItemDetails) GetAttributeValue() string` + +GetAttributeValue returns the AttributeValue field if non-nil, zero value otherwise. + +### GetAttributeValueOk + +`func (o *RemediationItemDetails) GetAttributeValueOk() (*string, bool)` + +GetAttributeValueOk returns a tuple with the AttributeValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeValue + +`func (o *RemediationItemDetails) SetAttributeValue(v string)` + +SetAttributeValue sets AttributeValue field to given value. + +### HasAttributeValue + +`func (o *RemediationItemDetails) HasAttributeValue() bool` + +HasAttributeValue returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *RemediationItemDetails) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *RemediationItemDetails) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *RemediationItemDetails) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *RemediationItemDetails) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RemediationItems.md b/docs/tools/sdk/go/Reference/V2024/Models/RemediationItems.md new file mode 100644 index 000000000..1615fcfb2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RemediationItems.md @@ -0,0 +1,272 @@ +--- +id: v2024-remediation-items +title: RemediationItems +pagination_label: RemediationItems +sidebar_label: RemediationItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RemediationItems', 'V2024RemediationItems'] +slug: /tools/sdk/go/v2024/models/remediation-items +tags: ['SDK', 'Software Development Kit', 'RemediationItems', 'V2024RemediationItems'] +--- + +# RemediationItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the certification | [optional] +**TargetId** | Pointer to **string** | The ID of the certification target | [optional] +**TargetName** | Pointer to **string** | The name of the certification target | [optional] +**TargetDisplayName** | Pointer to **string** | The display name of the certification target | [optional] +**ApplicationName** | Pointer to **string** | The name of the application/source | [optional] +**AttributeName** | Pointer to **string** | The name of the attribute being certified | [optional] +**AttributeOperation** | Pointer to **string** | The operation of the certification on the attribute | [optional] +**AttributeValue** | Pointer to **string** | The value of the attribute being certified | [optional] +**NativeIdentity** | Pointer to **string** | The native identity of the target | [optional] + +## Methods + +### NewRemediationItems + +`func NewRemediationItems() *RemediationItems` + +NewRemediationItems instantiates a new RemediationItems 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 + +### NewRemediationItemsWithDefaults + +`func NewRemediationItemsWithDefaults() *RemediationItems` + +NewRemediationItemsWithDefaults instantiates a new RemediationItems 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 + +### GetId + +`func (o *RemediationItems) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RemediationItems) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RemediationItems) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RemediationItems) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetTargetId + +`func (o *RemediationItems) GetTargetId() string` + +GetTargetId returns the TargetId field if non-nil, zero value otherwise. + +### GetTargetIdOk + +`func (o *RemediationItems) GetTargetIdOk() (*string, bool)` + +GetTargetIdOk returns a tuple with the TargetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetId + +`func (o *RemediationItems) SetTargetId(v string)` + +SetTargetId sets TargetId field to given value. + +### HasTargetId + +`func (o *RemediationItems) HasTargetId() bool` + +HasTargetId returns a boolean if a field has been set. + +### GetTargetName + +`func (o *RemediationItems) GetTargetName() string` + +GetTargetName returns the TargetName field if non-nil, zero value otherwise. + +### GetTargetNameOk + +`func (o *RemediationItems) GetTargetNameOk() (*string, bool)` + +GetTargetNameOk returns a tuple with the TargetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetName + +`func (o *RemediationItems) SetTargetName(v string)` + +SetTargetName sets TargetName field to given value. + +### HasTargetName + +`func (o *RemediationItems) HasTargetName() bool` + +HasTargetName returns a boolean if a field has been set. + +### GetTargetDisplayName + +`func (o *RemediationItems) GetTargetDisplayName() string` + +GetTargetDisplayName returns the TargetDisplayName field if non-nil, zero value otherwise. + +### GetTargetDisplayNameOk + +`func (o *RemediationItems) GetTargetDisplayNameOk() (*string, bool)` + +GetTargetDisplayNameOk returns a tuple with the TargetDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetDisplayName + +`func (o *RemediationItems) SetTargetDisplayName(v string)` + +SetTargetDisplayName sets TargetDisplayName field to given value. + +### HasTargetDisplayName + +`func (o *RemediationItems) HasTargetDisplayName() bool` + +HasTargetDisplayName returns a boolean if a field has been set. + +### GetApplicationName + +`func (o *RemediationItems) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *RemediationItems) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *RemediationItems) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *RemediationItems) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *RemediationItems) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *RemediationItems) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *RemediationItems) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *RemediationItems) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + +### GetAttributeOperation + +`func (o *RemediationItems) GetAttributeOperation() string` + +GetAttributeOperation returns the AttributeOperation field if non-nil, zero value otherwise. + +### GetAttributeOperationOk + +`func (o *RemediationItems) GetAttributeOperationOk() (*string, bool)` + +GetAttributeOperationOk returns a tuple with the AttributeOperation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeOperation + +`func (o *RemediationItems) SetAttributeOperation(v string)` + +SetAttributeOperation sets AttributeOperation field to given value. + +### HasAttributeOperation + +`func (o *RemediationItems) HasAttributeOperation() bool` + +HasAttributeOperation returns a boolean if a field has been set. + +### GetAttributeValue + +`func (o *RemediationItems) GetAttributeValue() string` + +GetAttributeValue returns the AttributeValue field if non-nil, zero value otherwise. + +### GetAttributeValueOk + +`func (o *RemediationItems) GetAttributeValueOk() (*string, bool)` + +GetAttributeValueOk returns a tuple with the AttributeValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeValue + +`func (o *RemediationItems) SetAttributeValue(v string)` + +SetAttributeValue sets AttributeValue field to given value. + +### HasAttributeValue + +`func (o *RemediationItems) HasAttributeValue() bool` + +HasAttributeValue returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *RemediationItems) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *RemediationItems) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *RemediationItems) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *RemediationItems) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReportConfigDTO.md b/docs/tools/sdk/go/Reference/V2024/Models/ReportConfigDTO.md new file mode 100644 index 000000000..57abd46aa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReportConfigDTO.md @@ -0,0 +1,142 @@ +--- +id: v2024-report-config-dto +title: ReportConfigDTO +pagination_label: ReportConfigDTO +sidebar_label: ReportConfigDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportConfigDTO', 'V2024ReportConfigDTO'] +slug: /tools/sdk/go/v2024/models/report-config-dto +tags: ['SDK', 'Software Development Kit', 'ReportConfigDTO', 'V2024ReportConfigDTO'] +--- + +# ReportConfigDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ColumnName** | Pointer to **string** | Name of column in report | [optional] +**Required** | Pointer to **bool** | If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column's definition. | [optional] [default to false] +**Included** | Pointer to **bool** | If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true. | [optional] [default to false] +**Order** | Pointer to **int32** | Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order. | [optional] + +## Methods + +### NewReportConfigDTO + +`func NewReportConfigDTO() *ReportConfigDTO` + +NewReportConfigDTO instantiates a new ReportConfigDTO 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 + +### NewReportConfigDTOWithDefaults + +`func NewReportConfigDTOWithDefaults() *ReportConfigDTO` + +NewReportConfigDTOWithDefaults instantiates a new ReportConfigDTO 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 + +### GetColumnName + +`func (o *ReportConfigDTO) GetColumnName() string` + +GetColumnName returns the ColumnName field if non-nil, zero value otherwise. + +### GetColumnNameOk + +`func (o *ReportConfigDTO) GetColumnNameOk() (*string, bool)` + +GetColumnNameOk returns a tuple with the ColumnName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumnName + +`func (o *ReportConfigDTO) SetColumnName(v string)` + +SetColumnName sets ColumnName field to given value. + +### HasColumnName + +`func (o *ReportConfigDTO) HasColumnName() bool` + +HasColumnName returns a boolean if a field has been set. + +### GetRequired + +`func (o *ReportConfigDTO) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *ReportConfigDTO) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *ReportConfigDTO) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *ReportConfigDTO) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + +### GetIncluded + +`func (o *ReportConfigDTO) GetIncluded() bool` + +GetIncluded returns the Included field if non-nil, zero value otherwise. + +### GetIncludedOk + +`func (o *ReportConfigDTO) GetIncludedOk() (*bool, bool)` + +GetIncludedOk returns a tuple with the Included field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncluded + +`func (o *ReportConfigDTO) SetIncluded(v bool)` + +SetIncluded sets Included field to given value. + +### HasIncluded + +`func (o *ReportConfigDTO) HasIncluded() bool` + +HasIncluded returns a boolean if a field has been set. + +### GetOrder + +`func (o *ReportConfigDTO) GetOrder() int32` + +GetOrder returns the Order field if non-nil, zero value otherwise. + +### GetOrderOk + +`func (o *ReportConfigDTO) GetOrderOk() (*int32, bool)` + +GetOrderOk returns a tuple with the Order field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrder + +`func (o *ReportConfigDTO) SetOrder(v int32)` + +SetOrder sets Order field to given value. + +### HasOrder + +`func (o *ReportConfigDTO) HasOrder() bool` + +HasOrder returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReportDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/ReportDetails.md new file mode 100644 index 000000000..80c7491b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReportDetails.md @@ -0,0 +1,90 @@ +--- +id: v2024-report-details +title: ReportDetails +pagination_label: ReportDetails +sidebar_label: ReportDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportDetails', 'V2024ReportDetails'] +slug: /tools/sdk/go/v2024/models/report-details +tags: ['SDK', 'Software Development Kit', 'ReportDetails', 'V2024ReportDetails'] +--- + +# ReportDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReportType** | Pointer to **string** | Use this property to define what report should be processed in the RDE service. | [optional] +**Arguments** | Pointer to [**ReportDetailsArguments**](report-details-arguments) | | [optional] + +## Methods + +### NewReportDetails + +`func NewReportDetails() *ReportDetails` + +NewReportDetails instantiates a new ReportDetails 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 + +### NewReportDetailsWithDefaults + +`func NewReportDetailsWithDefaults() *ReportDetails` + +NewReportDetailsWithDefaults instantiates a new ReportDetails 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 + +### GetReportType + +`func (o *ReportDetails) GetReportType() string` + +GetReportType returns the ReportType field if non-nil, zero value otherwise. + +### GetReportTypeOk + +`func (o *ReportDetails) GetReportTypeOk() (*string, bool)` + +GetReportTypeOk returns a tuple with the ReportType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportType + +`func (o *ReportDetails) SetReportType(v string)` + +SetReportType sets ReportType field to given value. + +### HasReportType + +`func (o *ReportDetails) HasReportType() bool` + +HasReportType returns a boolean if a field has been set. + +### GetArguments + +`func (o *ReportDetails) GetArguments() ReportDetailsArguments` + +GetArguments returns the Arguments field if non-nil, zero value otherwise. + +### GetArgumentsOk + +`func (o *ReportDetails) GetArgumentsOk() (*ReportDetailsArguments, bool)` + +GetArgumentsOk returns a tuple with the Arguments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArguments + +`func (o *ReportDetails) SetArguments(v ReportDetailsArguments)` + +SetArguments sets Arguments field to given value. + +### HasArguments + +`func (o *ReportDetails) HasArguments() bool` + +HasArguments returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReportDetailsArguments.md b/docs/tools/sdk/go/Reference/V2024/Models/ReportDetailsArguments.md new file mode 100644 index 000000000..9eb26e930 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReportDetailsArguments.md @@ -0,0 +1,247 @@ +--- +id: v2024-report-details-arguments +title: ReportDetailsArguments +pagination_label: ReportDetailsArguments +sidebar_label: ReportDetailsArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportDetailsArguments', 'V2024ReportDetailsArguments'] +slug: /tools/sdk/go/v2024/models/report-details-arguments +tags: ['SDK', 'Software Development Kit', 'ReportDetailsArguments', 'V2024ReportDetailsArguments'] +--- + +# ReportDetailsArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Application** | **string** | Source ID. | +**SourceName** | **string** | Source name. | +**CorrelatedOnly** | **bool** | Flag to specify if only correlated identities are included in report. | [default to false] +**AuthoritativeSource** | **string** | Source ID. | +**SelectedFormats** | Pointer to **[]string** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] +**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**Query** | **string** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | +**Columns** | Pointer to **string** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] + +## Methods + +### NewReportDetailsArguments + +`func NewReportDetailsArguments(application string, sourceName string, correlatedOnly bool, authoritativeSource string, query string, ) *ReportDetailsArguments` + +NewReportDetailsArguments instantiates a new ReportDetailsArguments 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 + +### NewReportDetailsArgumentsWithDefaults + +`func NewReportDetailsArgumentsWithDefaults() *ReportDetailsArguments` + +NewReportDetailsArgumentsWithDefaults instantiates a new ReportDetailsArguments 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 + +### GetApplication + +`func (o *ReportDetailsArguments) GetApplication() string` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *ReportDetailsArguments) GetApplicationOk() (*string, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *ReportDetailsArguments) SetApplication(v string)` + +SetApplication sets Application field to given value. + + +### GetSourceName + +`func (o *ReportDetailsArguments) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *ReportDetailsArguments) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *ReportDetailsArguments) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### GetCorrelatedOnly + +`func (o *ReportDetailsArguments) GetCorrelatedOnly() bool` + +GetCorrelatedOnly returns the CorrelatedOnly field if non-nil, zero value otherwise. + +### GetCorrelatedOnlyOk + +`func (o *ReportDetailsArguments) GetCorrelatedOnlyOk() (*bool, bool)` + +GetCorrelatedOnlyOk returns a tuple with the CorrelatedOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedOnly + +`func (o *ReportDetailsArguments) SetCorrelatedOnly(v bool)` + +SetCorrelatedOnly sets CorrelatedOnly field to given value. + + +### GetAuthoritativeSource + +`func (o *ReportDetailsArguments) GetAuthoritativeSource() string` + +GetAuthoritativeSource returns the AuthoritativeSource field if non-nil, zero value otherwise. + +### GetAuthoritativeSourceOk + +`func (o *ReportDetailsArguments) GetAuthoritativeSourceOk() (*string, bool)` + +GetAuthoritativeSourceOk returns a tuple with the AuthoritativeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritativeSource + +`func (o *ReportDetailsArguments) SetAuthoritativeSource(v string)` + +SetAuthoritativeSource sets AuthoritativeSource field to given value. + + +### GetSelectedFormats + +`func (o *ReportDetailsArguments) GetSelectedFormats() []string` + +GetSelectedFormats returns the SelectedFormats field if non-nil, zero value otherwise. + +### GetSelectedFormatsOk + +`func (o *ReportDetailsArguments) GetSelectedFormatsOk() (*[]string, bool)` + +GetSelectedFormatsOk returns a tuple with the SelectedFormats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectedFormats + +`func (o *ReportDetailsArguments) SetSelectedFormats(v []string)` + +SetSelectedFormats sets SelectedFormats field to given value. + +### HasSelectedFormats + +`func (o *ReportDetailsArguments) HasSelectedFormats() bool` + +HasSelectedFormats returns a boolean if a field has been set. + +### GetIndices + +`func (o *ReportDetailsArguments) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *ReportDetailsArguments) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *ReportDetailsArguments) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + +### HasIndices + +`func (o *ReportDetailsArguments) HasIndices() bool` + +HasIndices returns a boolean if a field has been set. + +### GetQuery + +`func (o *ReportDetailsArguments) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *ReportDetailsArguments) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *ReportDetailsArguments) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetColumns + +`func (o *ReportDetailsArguments) GetColumns() string` + +GetColumns returns the Columns field if non-nil, zero value otherwise. + +### GetColumnsOk + +`func (o *ReportDetailsArguments) GetColumnsOk() (*string, bool)` + +GetColumnsOk returns a tuple with the Columns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumns + +`func (o *ReportDetailsArguments) SetColumns(v string)` + +SetColumns sets Columns field to given value. + +### HasColumns + +`func (o *ReportDetailsArguments) HasColumns() bool` + +HasColumns returns a boolean if a field has been set. + +### GetSort + +`func (o *ReportDetailsArguments) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *ReportDetailsArguments) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *ReportDetailsArguments) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *ReportDetailsArguments) HasSort() bool` + +HasSort returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReportResultReference.md b/docs/tools/sdk/go/Reference/V2024/Models/ReportResultReference.md new file mode 100644 index 000000000..1f9af4f3c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReportResultReference.md @@ -0,0 +1,142 @@ +--- +id: v2024-report-result-reference +title: ReportResultReference +pagination_label: ReportResultReference +sidebar_label: ReportResultReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportResultReference', 'V2024ReportResultReference'] +slug: /tools/sdk/go/v2024/models/report-result-reference +tags: ['SDK', 'Software Development Kit', 'ReportResultReference', 'V2024ReportResultReference'] +--- + +# ReportResultReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **string** | Human-readable name of the SOD policy violation report result. | [optional] +**Status** | Pointer to **string** | Status of a SOD policy violation report. | [optional] + +## Methods + +### NewReportResultReference + +`func NewReportResultReference() *ReportResultReference` + +NewReportResultReference instantiates a new ReportResultReference 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 + +### NewReportResultReferenceWithDefaults + +`func NewReportResultReferenceWithDefaults() *ReportResultReference` + +NewReportResultReferenceWithDefaults instantiates a new ReportResultReference 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 + +### GetType + +`func (o *ReportResultReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReportResultReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReportResultReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ReportResultReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ReportResultReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReportResultReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReportResultReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReportResultReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ReportResultReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ReportResultReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ReportResultReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ReportResultReference) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *ReportResultReference) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ReportResultReference) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ReportResultReference) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ReportResultReference) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReportResults.md b/docs/tools/sdk/go/Reference/V2024/Models/ReportResults.md new file mode 100644 index 000000000..4eb0e53c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReportResults.md @@ -0,0 +1,246 @@ +--- +id: v2024-report-results +title: ReportResults +pagination_label: ReportResults +sidebar_label: ReportResults +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportResults', 'V2024ReportResults'] +slug: /tools/sdk/go/v2024/models/report-results +tags: ['SDK', 'Software Development Kit', 'ReportResults', 'V2024ReportResults'] +--- + +# ReportResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReportType** | Pointer to **string** | Use this property to define what report should be processed in the RDE service. | [optional] +**TaskDefName** | Pointer to **string** | Name of the task definition which is started to process requesting report. Usually the same as report name | [optional] +**Id** | Pointer to **string** | Unique task definition identifier. | [optional] +**Created** | Pointer to **SailPointTime** | Report processing start date | [optional] +**Status** | Pointer to **string** | Report current state or result status. | [optional] +**Duration** | Pointer to **int64** | Report processing time in ms. | [optional] +**Rows** | Pointer to **int64** | Report size in rows. | [optional] +**AvailableFormats** | Pointer to **[]string** | Output report file formats. This are formats for calling get endpoint as a query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] + +## Methods + +### NewReportResults + +`func NewReportResults() *ReportResults` + +NewReportResults instantiates a new ReportResults 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 + +### NewReportResultsWithDefaults + +`func NewReportResultsWithDefaults() *ReportResults` + +NewReportResultsWithDefaults instantiates a new ReportResults 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 + +### GetReportType + +`func (o *ReportResults) GetReportType() string` + +GetReportType returns the ReportType field if non-nil, zero value otherwise. + +### GetReportTypeOk + +`func (o *ReportResults) GetReportTypeOk() (*string, bool)` + +GetReportTypeOk returns a tuple with the ReportType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportType + +`func (o *ReportResults) SetReportType(v string)` + +SetReportType sets ReportType field to given value. + +### HasReportType + +`func (o *ReportResults) HasReportType() bool` + +HasReportType returns a boolean if a field has been set. + +### GetTaskDefName + +`func (o *ReportResults) GetTaskDefName() string` + +GetTaskDefName returns the TaskDefName field if non-nil, zero value otherwise. + +### GetTaskDefNameOk + +`func (o *ReportResults) GetTaskDefNameOk() (*string, bool)` + +GetTaskDefNameOk returns a tuple with the TaskDefName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskDefName + +`func (o *ReportResults) SetTaskDefName(v string)` + +SetTaskDefName sets TaskDefName field to given value. + +### HasTaskDefName + +`func (o *ReportResults) HasTaskDefName() bool` + +HasTaskDefName returns a boolean if a field has been set. + +### GetId + +`func (o *ReportResults) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReportResults) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReportResults) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReportResults) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreated + +`func (o *ReportResults) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ReportResults) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ReportResults) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ReportResults) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetStatus + +`func (o *ReportResults) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ReportResults) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ReportResults) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ReportResults) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetDuration + +`func (o *ReportResults) GetDuration() int64` + +GetDuration returns the Duration field if non-nil, zero value otherwise. + +### GetDurationOk + +`func (o *ReportResults) GetDurationOk() (*int64, bool)` + +GetDurationOk returns a tuple with the Duration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDuration + +`func (o *ReportResults) SetDuration(v int64)` + +SetDuration sets Duration field to given value. + +### HasDuration + +`func (o *ReportResults) HasDuration() bool` + +HasDuration returns a boolean if a field has been set. + +### GetRows + +`func (o *ReportResults) GetRows() int64` + +GetRows returns the Rows field if non-nil, zero value otherwise. + +### GetRowsOk + +`func (o *ReportResults) GetRowsOk() (*int64, bool)` + +GetRowsOk returns a tuple with the Rows field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRows + +`func (o *ReportResults) SetRows(v int64)` + +SetRows sets Rows field to given value. + +### HasRows + +`func (o *ReportResults) HasRows() bool` + +HasRows returns a boolean if a field has been set. + +### GetAvailableFormats + +`func (o *ReportResults) GetAvailableFormats() []string` + +GetAvailableFormats returns the AvailableFormats field if non-nil, zero value otherwise. + +### GetAvailableFormatsOk + +`func (o *ReportResults) GetAvailableFormatsOk() (*[]string, bool)` + +GetAvailableFormatsOk returns a tuple with the AvailableFormats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAvailableFormats + +`func (o *ReportResults) SetAvailableFormats(v []string)` + +SetAvailableFormats sets AvailableFormats field to given value. + +### HasAvailableFormats + +`func (o *ReportResults) HasAvailableFormats() bool` + +HasAvailableFormats returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReportType.md b/docs/tools/sdk/go/Reference/V2024/Models/ReportType.md new file mode 100644 index 000000000..e4a680113 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReportType.md @@ -0,0 +1,25 @@ +--- +id: v2024-report-type +title: ReportType +pagination_label: ReportType +sidebar_label: ReportType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportType', 'V2024ReportType'] +slug: /tools/sdk/go/v2024/models/report-type +tags: ['SDK', 'Software Development Kit', 'ReportType', 'V2024ReportType'] +--- + +# ReportType + +## Enum + + +* `CAMPAIGN_COMPOSITION_REPORT` (value: `"CAMPAIGN_COMPOSITION_REPORT"`) + +* `CAMPAIGN_REMEDIATION_STATUS_REPORT` (value: `"CAMPAIGN_REMEDIATION_STATUS_REPORT"`) + +* `CAMPAIGN_STATUS_REPORT` (value: `"CAMPAIGN_STATUS_REPORT"`) + +* `CERTIFICATION_SIGNOFF_REPORT` (value: `"CERTIFICATION_SIGNOFF_REPORT"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestOnBehalfOfConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestOnBehalfOfConfig.md new file mode 100644 index 000000000..a8aaf0fa7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestOnBehalfOfConfig.md @@ -0,0 +1,90 @@ +--- +id: v2024-request-on-behalf-of-config +title: RequestOnBehalfOfConfig +pagination_label: RequestOnBehalfOfConfig +sidebar_label: RequestOnBehalfOfConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestOnBehalfOfConfig', 'V2024RequestOnBehalfOfConfig'] +slug: /tools/sdk/go/v2024/models/request-on-behalf-of-config +tags: ['SDK', 'Software Development Kit', 'RequestOnBehalfOfConfig', 'V2024RequestOnBehalfOfConfig'] +--- + +# RequestOnBehalfOfConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AllowRequestOnBehalfOfAnyoneByAnyone** | Pointer to **bool** | If this is true, anyone can request access for anyone. | [optional] [default to false] +**AllowRequestOnBehalfOfEmployeeByManager** | Pointer to **bool** | If this is true, a manager can request access for his or her direct reports. | [optional] [default to false] + +## Methods + +### NewRequestOnBehalfOfConfig + +`func NewRequestOnBehalfOfConfig() *RequestOnBehalfOfConfig` + +NewRequestOnBehalfOfConfig instantiates a new RequestOnBehalfOfConfig 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 + +### NewRequestOnBehalfOfConfigWithDefaults + +`func NewRequestOnBehalfOfConfigWithDefaults() *RequestOnBehalfOfConfig` + +NewRequestOnBehalfOfConfigWithDefaults instantiates a new RequestOnBehalfOfConfig 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 + +### GetAllowRequestOnBehalfOfAnyoneByAnyone + +`func (o *RequestOnBehalfOfConfig) GetAllowRequestOnBehalfOfAnyoneByAnyone() bool` + +GetAllowRequestOnBehalfOfAnyoneByAnyone returns the AllowRequestOnBehalfOfAnyoneByAnyone field if non-nil, zero value otherwise. + +### GetAllowRequestOnBehalfOfAnyoneByAnyoneOk + +`func (o *RequestOnBehalfOfConfig) GetAllowRequestOnBehalfOfAnyoneByAnyoneOk() (*bool, bool)` + +GetAllowRequestOnBehalfOfAnyoneByAnyoneOk returns a tuple with the AllowRequestOnBehalfOfAnyoneByAnyone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllowRequestOnBehalfOfAnyoneByAnyone + +`func (o *RequestOnBehalfOfConfig) SetAllowRequestOnBehalfOfAnyoneByAnyone(v bool)` + +SetAllowRequestOnBehalfOfAnyoneByAnyone sets AllowRequestOnBehalfOfAnyoneByAnyone field to given value. + +### HasAllowRequestOnBehalfOfAnyoneByAnyone + +`func (o *RequestOnBehalfOfConfig) HasAllowRequestOnBehalfOfAnyoneByAnyone() bool` + +HasAllowRequestOnBehalfOfAnyoneByAnyone returns a boolean if a field has been set. + +### GetAllowRequestOnBehalfOfEmployeeByManager + +`func (o *RequestOnBehalfOfConfig) GetAllowRequestOnBehalfOfEmployeeByManager() bool` + +GetAllowRequestOnBehalfOfEmployeeByManager returns the AllowRequestOnBehalfOfEmployeeByManager field if non-nil, zero value otherwise. + +### GetAllowRequestOnBehalfOfEmployeeByManagerOk + +`func (o *RequestOnBehalfOfConfig) GetAllowRequestOnBehalfOfEmployeeByManagerOk() (*bool, bool)` + +GetAllowRequestOnBehalfOfEmployeeByManagerOk returns a tuple with the AllowRequestOnBehalfOfEmployeeByManager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllowRequestOnBehalfOfEmployeeByManager + +`func (o *RequestOnBehalfOfConfig) SetAllowRequestOnBehalfOfEmployeeByManager(v bool)` + +SetAllowRequestOnBehalfOfEmployeeByManager sets AllowRequestOnBehalfOfEmployeeByManager field to given value. + +### HasAllowRequestOnBehalfOfEmployeeByManager + +`func (o *RequestOnBehalfOfConfig) HasAllowRequestOnBehalfOfEmployeeByManager() bool` + +HasAllowRequestOnBehalfOfEmployeeByManager returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Requestability.md b/docs/tools/sdk/go/Reference/V2024/Models/Requestability.md new file mode 100644 index 000000000..4f026a0f9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Requestability.md @@ -0,0 +1,182 @@ +--- +id: v2024-requestability +title: Requestability +pagination_label: Requestability +sidebar_label: Requestability +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Requestability', 'V2024Requestability'] +slug: /tools/sdk/go/v2024/models/requestability +tags: ['SDK', 'Software Development Kit', 'Requestability', 'V2024Requestability'] +--- + +# Requestability + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **NullableBool** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to false] +**DenialCommentsRequired** | Pointer to **NullableBool** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to false] +**ReauthorizationRequired** | Pointer to **NullableBool** | Indicates whether reauthorization is required for the request. | [optional] [default to false] +**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] + +## Methods + +### NewRequestability + +`func NewRequestability() *Requestability` + +NewRequestability instantiates a new Requestability 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 + +### NewRequestabilityWithDefaults + +`func NewRequestabilityWithDefaults() *Requestability` + +NewRequestabilityWithDefaults instantiates a new Requestability 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 + +### GetCommentsRequired + +`func (o *Requestability) GetCommentsRequired() bool` + +GetCommentsRequired returns the CommentsRequired field if non-nil, zero value otherwise. + +### GetCommentsRequiredOk + +`func (o *Requestability) GetCommentsRequiredOk() (*bool, bool)` + +GetCommentsRequiredOk returns a tuple with the CommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentsRequired + +`func (o *Requestability) SetCommentsRequired(v bool)` + +SetCommentsRequired sets CommentsRequired field to given value. + +### HasCommentsRequired + +`func (o *Requestability) HasCommentsRequired() bool` + +HasCommentsRequired returns a boolean if a field has been set. + +### SetCommentsRequiredNil + +`func (o *Requestability) SetCommentsRequiredNil(b bool)` + + SetCommentsRequiredNil sets the value for CommentsRequired to be an explicit nil + +### UnsetCommentsRequired +`func (o *Requestability) UnsetCommentsRequired()` + +UnsetCommentsRequired ensures that no value is present for CommentsRequired, not even an explicit nil +### GetDenialCommentsRequired + +`func (o *Requestability) GetDenialCommentsRequired() bool` + +GetDenialCommentsRequired returns the DenialCommentsRequired field if non-nil, zero value otherwise. + +### GetDenialCommentsRequiredOk + +`func (o *Requestability) GetDenialCommentsRequiredOk() (*bool, bool)` + +GetDenialCommentsRequiredOk returns a tuple with the DenialCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenialCommentsRequired + +`func (o *Requestability) SetDenialCommentsRequired(v bool)` + +SetDenialCommentsRequired sets DenialCommentsRequired field to given value. + +### HasDenialCommentsRequired + +`func (o *Requestability) HasDenialCommentsRequired() bool` + +HasDenialCommentsRequired returns a boolean if a field has been set. + +### SetDenialCommentsRequiredNil + +`func (o *Requestability) SetDenialCommentsRequiredNil(b bool)` + + SetDenialCommentsRequiredNil sets the value for DenialCommentsRequired to be an explicit nil + +### UnsetDenialCommentsRequired +`func (o *Requestability) UnsetDenialCommentsRequired()` + +UnsetDenialCommentsRequired ensures that no value is present for DenialCommentsRequired, not even an explicit nil +### GetReauthorizationRequired + +`func (o *Requestability) GetReauthorizationRequired() bool` + +GetReauthorizationRequired returns the ReauthorizationRequired field if non-nil, zero value otherwise. + +### GetReauthorizationRequiredOk + +`func (o *Requestability) GetReauthorizationRequiredOk() (*bool, bool)` + +GetReauthorizationRequiredOk returns a tuple with the ReauthorizationRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReauthorizationRequired + +`func (o *Requestability) SetReauthorizationRequired(v bool)` + +SetReauthorizationRequired sets ReauthorizationRequired field to given value. + +### HasReauthorizationRequired + +`func (o *Requestability) HasReauthorizationRequired() bool` + +HasReauthorizationRequired returns a boolean if a field has been set. + +### SetReauthorizationRequiredNil + +`func (o *Requestability) SetReauthorizationRequiredNil(b bool)` + + SetReauthorizationRequiredNil sets the value for ReauthorizationRequired to be an explicit nil + +### UnsetReauthorizationRequired +`func (o *Requestability) UnsetReauthorizationRequired()` + +UnsetReauthorizationRequired ensures that no value is present for ReauthorizationRequired, not even an explicit nil +### GetApprovalSchemes + +`func (o *Requestability) GetApprovalSchemes() []AccessProfileApprovalScheme` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *Requestability) GetApprovalSchemesOk() (*[]AccessProfileApprovalScheme, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *Requestability) SetApprovalSchemes(v []AccessProfileApprovalScheme)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *Requestability) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + +### SetApprovalSchemesNil + +`func (o *Requestability) SetApprovalSchemesNil(b bool)` + + SetApprovalSchemesNil sets the value for ApprovalSchemes to be an explicit nil + +### UnsetApprovalSchemes +`func (o *Requestability) UnsetApprovalSchemes()` + +UnsetApprovalSchemes ensures that no value is present for ApprovalSchemes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestabilityForRole.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestabilityForRole.md new file mode 100644 index 000000000..c0f82067f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestabilityForRole.md @@ -0,0 +1,172 @@ +--- +id: v2024-requestability-for-role +title: RequestabilityForRole +pagination_label: RequestabilityForRole +sidebar_label: RequestabilityForRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestabilityForRole', 'V2024RequestabilityForRole'] +slug: /tools/sdk/go/v2024/models/requestability-for-role +tags: ['SDK', 'Software Development Kit', 'RequestabilityForRole', 'V2024RequestabilityForRole'] +--- + +# RequestabilityForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **NullableBool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to false] +**DenialCommentsRequired** | Pointer to **NullableBool** | Whether an approver must provide comments when denying the request | [optional] [default to false] +**ReauthorizationRequired** | Pointer to **NullableBool** | Indicates whether reauthorization is required for the request. | [optional] [default to false] +**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] + +## Methods + +### NewRequestabilityForRole + +`func NewRequestabilityForRole() *RequestabilityForRole` + +NewRequestabilityForRole instantiates a new RequestabilityForRole 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 + +### NewRequestabilityForRoleWithDefaults + +`func NewRequestabilityForRoleWithDefaults() *RequestabilityForRole` + +NewRequestabilityForRoleWithDefaults instantiates a new RequestabilityForRole 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 + +### GetCommentsRequired + +`func (o *RequestabilityForRole) GetCommentsRequired() bool` + +GetCommentsRequired returns the CommentsRequired field if non-nil, zero value otherwise. + +### GetCommentsRequiredOk + +`func (o *RequestabilityForRole) GetCommentsRequiredOk() (*bool, bool)` + +GetCommentsRequiredOk returns a tuple with the CommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentsRequired + +`func (o *RequestabilityForRole) SetCommentsRequired(v bool)` + +SetCommentsRequired sets CommentsRequired field to given value. + +### HasCommentsRequired + +`func (o *RequestabilityForRole) HasCommentsRequired() bool` + +HasCommentsRequired returns a boolean if a field has been set. + +### SetCommentsRequiredNil + +`func (o *RequestabilityForRole) SetCommentsRequiredNil(b bool)` + + SetCommentsRequiredNil sets the value for CommentsRequired to be an explicit nil + +### UnsetCommentsRequired +`func (o *RequestabilityForRole) UnsetCommentsRequired()` + +UnsetCommentsRequired ensures that no value is present for CommentsRequired, not even an explicit nil +### GetDenialCommentsRequired + +`func (o *RequestabilityForRole) GetDenialCommentsRequired() bool` + +GetDenialCommentsRequired returns the DenialCommentsRequired field if non-nil, zero value otherwise. + +### GetDenialCommentsRequiredOk + +`func (o *RequestabilityForRole) GetDenialCommentsRequiredOk() (*bool, bool)` + +GetDenialCommentsRequiredOk returns a tuple with the DenialCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenialCommentsRequired + +`func (o *RequestabilityForRole) SetDenialCommentsRequired(v bool)` + +SetDenialCommentsRequired sets DenialCommentsRequired field to given value. + +### HasDenialCommentsRequired + +`func (o *RequestabilityForRole) HasDenialCommentsRequired() bool` + +HasDenialCommentsRequired returns a boolean if a field has been set. + +### SetDenialCommentsRequiredNil + +`func (o *RequestabilityForRole) SetDenialCommentsRequiredNil(b bool)` + + SetDenialCommentsRequiredNil sets the value for DenialCommentsRequired to be an explicit nil + +### UnsetDenialCommentsRequired +`func (o *RequestabilityForRole) UnsetDenialCommentsRequired()` + +UnsetDenialCommentsRequired ensures that no value is present for DenialCommentsRequired, not even an explicit nil +### GetReauthorizationRequired + +`func (o *RequestabilityForRole) GetReauthorizationRequired() bool` + +GetReauthorizationRequired returns the ReauthorizationRequired field if non-nil, zero value otherwise. + +### GetReauthorizationRequiredOk + +`func (o *RequestabilityForRole) GetReauthorizationRequiredOk() (*bool, bool)` + +GetReauthorizationRequiredOk returns a tuple with the ReauthorizationRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReauthorizationRequired + +`func (o *RequestabilityForRole) SetReauthorizationRequired(v bool)` + +SetReauthorizationRequired sets ReauthorizationRequired field to given value. + +### HasReauthorizationRequired + +`func (o *RequestabilityForRole) HasReauthorizationRequired() bool` + +HasReauthorizationRequired returns a boolean if a field has been set. + +### SetReauthorizationRequiredNil + +`func (o *RequestabilityForRole) SetReauthorizationRequiredNil(b bool)` + + SetReauthorizationRequiredNil sets the value for ReauthorizationRequired to be an explicit nil + +### UnsetReauthorizationRequired +`func (o *RequestabilityForRole) UnsetReauthorizationRequired()` + +UnsetReauthorizationRequired ensures that no value is present for ReauthorizationRequired, not even an explicit nil +### GetApprovalSchemes + +`func (o *RequestabilityForRole) GetApprovalSchemes() []ApprovalSchemeForRole` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *RequestabilityForRole) GetApprovalSchemesOk() (*[]ApprovalSchemeForRole, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *RequestabilityForRole) SetApprovalSchemes(v []ApprovalSchemeForRole)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *RequestabilityForRole) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestableObject.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestableObject.md new file mode 100644 index 000000000..db83b7d1d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestableObject.md @@ -0,0 +1,338 @@ +--- +id: v2024-requestable-object +title: RequestableObject +pagination_label: RequestableObject +sidebar_label: RequestableObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObject', 'V2024RequestableObject'] +slug: /tools/sdk/go/v2024/models/requestable-object +tags: ['SDK', 'Software Development Kit', 'RequestableObject', 'V2024RequestableObject'] +--- + +# RequestableObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the requestable object itself | [optional] +**Name** | Pointer to **string** | Human-readable display name of the requestable object | [optional] +**Created** | Pointer to **SailPointTime** | The time when the requestable object was created | [optional] +**Modified** | Pointer to **NullableTime** | The time when the requestable object was last modified | [optional] +**Description** | Pointer to **NullableString** | Description of the requestable object. | [optional] +**Type** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional] +**RequestStatus** | Pointer to [**RequestableObjectRequestStatus**](requestable-object-request-status) | | [optional] +**IdentityRequestId** | Pointer to **NullableString** | If *requestStatus* is *PENDING*, indicates the id of the associated account activity. | [optional] +**OwnerRef** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**RequestCommentsRequired** | Pointer to **bool** | Whether the requester must provide comments when requesting the object. | [optional] + +## Methods + +### NewRequestableObject + +`func NewRequestableObject() *RequestableObject` + +NewRequestableObject instantiates a new RequestableObject 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 + +### NewRequestableObjectWithDefaults + +`func NewRequestableObjectWithDefaults() *RequestableObject` + +NewRequestableObjectWithDefaults instantiates a new RequestableObject 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 + +### GetId + +`func (o *RequestableObject) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestableObject) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestableObject) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestableObject) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RequestableObject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestableObject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestableObject) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestableObject) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *RequestableObject) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RequestableObject) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RequestableObject) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RequestableObject) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *RequestableObject) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RequestableObject) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RequestableObject) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RequestableObject) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *RequestableObject) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *RequestableObject) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDescription + +`func (o *RequestableObject) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RequestableObject) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RequestableObject) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RequestableObject) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RequestableObject) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RequestableObject) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *RequestableObject) GetType() RequestableObjectType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestableObject) GetTypeOk() (*RequestableObjectType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestableObject) SetType(v RequestableObjectType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestableObject) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRequestStatus + +`func (o *RequestableObject) GetRequestStatus() RequestableObjectRequestStatus` + +GetRequestStatus returns the RequestStatus field if non-nil, zero value otherwise. + +### GetRequestStatusOk + +`func (o *RequestableObject) GetRequestStatusOk() (*RequestableObjectRequestStatus, bool)` + +GetRequestStatusOk returns a tuple with the RequestStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestStatus + +`func (o *RequestableObject) SetRequestStatus(v RequestableObjectRequestStatus)` + +SetRequestStatus sets RequestStatus field to given value. + +### HasRequestStatus + +`func (o *RequestableObject) HasRequestStatus() bool` + +HasRequestStatus returns a boolean if a field has been set. + +### GetIdentityRequestId + +`func (o *RequestableObject) GetIdentityRequestId() string` + +GetIdentityRequestId returns the IdentityRequestId field if non-nil, zero value otherwise. + +### GetIdentityRequestIdOk + +`func (o *RequestableObject) GetIdentityRequestIdOk() (*string, bool)` + +GetIdentityRequestIdOk returns a tuple with the IdentityRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityRequestId + +`func (o *RequestableObject) SetIdentityRequestId(v string)` + +SetIdentityRequestId sets IdentityRequestId field to given value. + +### HasIdentityRequestId + +`func (o *RequestableObject) HasIdentityRequestId() bool` + +HasIdentityRequestId returns a boolean if a field has been set. + +### SetIdentityRequestIdNil + +`func (o *RequestableObject) SetIdentityRequestIdNil(b bool)` + + SetIdentityRequestIdNil sets the value for IdentityRequestId to be an explicit nil + +### UnsetIdentityRequestId +`func (o *RequestableObject) UnsetIdentityRequestId()` + +UnsetIdentityRequestId ensures that no value is present for IdentityRequestId, not even an explicit nil +### GetOwnerRef + +`func (o *RequestableObject) GetOwnerRef() IdentityReferenceWithNameAndEmail` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *RequestableObject) GetOwnerRefOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *RequestableObject) SetOwnerRef(v IdentityReferenceWithNameAndEmail)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *RequestableObject) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### SetOwnerRefNil + +`func (o *RequestableObject) SetOwnerRefNil(b bool)` + + SetOwnerRefNil sets the value for OwnerRef to be an explicit nil + +### UnsetOwnerRef +`func (o *RequestableObject) UnsetOwnerRef()` + +UnsetOwnerRef ensures that no value is present for OwnerRef, not even an explicit nil +### GetRequestCommentsRequired + +`func (o *RequestableObject) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *RequestableObject) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *RequestableObject) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *RequestableObject) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestableObjectReference.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestableObjectReference.md new file mode 100644 index 000000000..c1507dd74 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestableObjectReference.md @@ -0,0 +1,142 @@ +--- +id: v2024-requestable-object-reference +title: RequestableObjectReference +pagination_label: RequestableObjectReference +sidebar_label: RequestableObjectReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObjectReference', 'V2024RequestableObjectReference'] +slug: /tools/sdk/go/v2024/models/requestable-object-reference +tags: ['SDK', 'Software Development Kit', 'RequestableObjectReference', 'V2024RequestableObjectReference'] +--- + +# RequestableObjectReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the object. | [optional] +**Name** | Pointer to **string** | Name of the object. | [optional] +**Description** | Pointer to **string** | Description of the object. | [optional] +**Type** | Pointer to **string** | Type of the object. | [optional] + +## Methods + +### NewRequestableObjectReference + +`func NewRequestableObjectReference() *RequestableObjectReference` + +NewRequestableObjectReference instantiates a new RequestableObjectReference 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 + +### NewRequestableObjectReferenceWithDefaults + +`func NewRequestableObjectReferenceWithDefaults() *RequestableObjectReference` + +NewRequestableObjectReferenceWithDefaults instantiates a new RequestableObjectReference 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 + +### GetId + +`func (o *RequestableObjectReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestableObjectReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestableObjectReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestableObjectReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RequestableObjectReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestableObjectReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestableObjectReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestableObjectReference) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RequestableObjectReference) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RequestableObjectReference) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RequestableObjectReference) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RequestableObjectReference) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetType + +`func (o *RequestableObjectReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestableObjectReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestableObjectReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestableObjectReference) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestableObjectRequestStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestableObjectRequestStatus.md new file mode 100644 index 000000000..552517b2a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestableObjectRequestStatus.md @@ -0,0 +1,23 @@ +--- +id: v2024-requestable-object-request-status +title: RequestableObjectRequestStatus +pagination_label: RequestableObjectRequestStatus +sidebar_label: RequestableObjectRequestStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObjectRequestStatus', 'V2024RequestableObjectRequestStatus'] +slug: /tools/sdk/go/v2024/models/requestable-object-request-status +tags: ['SDK', 'Software Development Kit', 'RequestableObjectRequestStatus', 'V2024RequestableObjectRequestStatus'] +--- + +# RequestableObjectRequestStatus + +## Enum + + +* `AVAILABLE` (value: `"AVAILABLE"`) + +* `PENDING` (value: `"PENDING"`) + +* `ASSIGNED` (value: `"ASSIGNED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestableObjectType.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestableObjectType.md new file mode 100644 index 000000000..dbcf08375 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestableObjectType.md @@ -0,0 +1,23 @@ +--- +id: v2024-requestable-object-type +title: RequestableObjectType +pagination_label: RequestableObjectType +sidebar_label: RequestableObjectType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObjectType', 'V2024RequestableObjectType'] +slug: /tools/sdk/go/v2024/models/requestable-object-type +tags: ['SDK', 'Software Development Kit', 'RequestableObjectType', 'V2024RequestableObjectType'] +--- + +# RequestableObjectType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestedAccountRef.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestedAccountRef.md new file mode 100644 index 000000000..89f2e7d55 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestedAccountRef.md @@ -0,0 +1,188 @@ +--- +id: v2024-requested-account-ref +title: RequestedAccountRef +pagination_label: RequestedAccountRef +sidebar_label: RequestedAccountRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedAccountRef', 'V2024RequestedAccountRef'] +slug: /tools/sdk/go/v2024/models/requested-account-ref +tags: ['SDK', 'Software Development Kit', 'RequestedAccountRef', 'V2024RequestedAccountRef'] +--- + +# RequestedAccountRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Display name of the account for the user | [optional] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**AccountUuid** | Pointer to **NullableString** | The uuid for the account | [optional] +**AccountId** | Pointer to **NullableString** | The native identity for the account | [optional] +**SourceName** | Pointer to **string** | Display name of the source for the account | [optional] + +## Methods + +### NewRequestedAccountRef + +`func NewRequestedAccountRef() *RequestedAccountRef` + +NewRequestedAccountRef instantiates a new RequestedAccountRef 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 + +### NewRequestedAccountRefWithDefaults + +`func NewRequestedAccountRefWithDefaults() *RequestedAccountRef` + +NewRequestedAccountRefWithDefaults instantiates a new RequestedAccountRef 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 + +### GetName + +`func (o *RequestedAccountRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestedAccountRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestedAccountRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestedAccountRef) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *RequestedAccountRef) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedAccountRef) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedAccountRef) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedAccountRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetAccountUuid + +`func (o *RequestedAccountRef) GetAccountUuid() string` + +GetAccountUuid returns the AccountUuid field if non-nil, zero value otherwise. + +### GetAccountUuidOk + +`func (o *RequestedAccountRef) GetAccountUuidOk() (*string, bool)` + +GetAccountUuidOk returns a tuple with the AccountUuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountUuid + +`func (o *RequestedAccountRef) SetAccountUuid(v string)` + +SetAccountUuid sets AccountUuid field to given value. + +### HasAccountUuid + +`func (o *RequestedAccountRef) HasAccountUuid() bool` + +HasAccountUuid returns a boolean if a field has been set. + +### SetAccountUuidNil + +`func (o *RequestedAccountRef) SetAccountUuidNil(b bool)` + + SetAccountUuidNil sets the value for AccountUuid to be an explicit nil + +### UnsetAccountUuid +`func (o *RequestedAccountRef) UnsetAccountUuid()` + +UnsetAccountUuid ensures that no value is present for AccountUuid, not even an explicit nil +### GetAccountId + +`func (o *RequestedAccountRef) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *RequestedAccountRef) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *RequestedAccountRef) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *RequestedAccountRef) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountIdNil + +`func (o *RequestedAccountRef) SetAccountIdNil(b bool)` + + SetAccountIdNil sets the value for AccountId to be an explicit nil + +### UnsetAccountId +`func (o *RequestedAccountRef) UnsetAccountId()` + +UnsetAccountId ensures that no value is present for AccountId, not even an explicit nil +### GetSourceName + +`func (o *RequestedAccountRef) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *RequestedAccountRef) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *RequestedAccountRef) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *RequestedAccountRef) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestedForDtoRef.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..ea9b275fc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestedForDtoRef.md @@ -0,0 +1,80 @@ +--- +id: v2024-requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedForDtoRef', 'V2024RequestedForDtoRef'] +slug: /tools/sdk/go/v2024/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'V2024RequestedForDtoRef'] +--- + +# RequestedForDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **string** | The identity id for which the access is requested | +**RequestedItems** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | + +## Methods + +### NewRequestedForDtoRef + +`func NewRequestedForDtoRef(identityId string, requestedItems []RequestedItemDtoRef, ) *RequestedForDtoRef` + +NewRequestedForDtoRef instantiates a new RequestedForDtoRef 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 + +### NewRequestedForDtoRefWithDefaults + +`func NewRequestedForDtoRefWithDefaults() *RequestedForDtoRef` + +NewRequestedForDtoRefWithDefaults instantiates a new RequestedForDtoRef 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 + +### GetIdentityId + +`func (o *RequestedForDtoRef) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *RequestedForDtoRef) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *RequestedForDtoRef) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetRequestedItems + +`func (o *RequestedForDtoRef) GetRequestedItems() []RequestedItemDtoRef` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *RequestedForDtoRef) GetRequestedItemsOk() (*[]RequestedItemDtoRef, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *RequestedForDtoRef) SetRequestedItems(v []RequestedItemDtoRef)` + +SetRequestedItems sets RequestedItems field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemAccountSelections.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemAccountSelections.md new file mode 100644 index 000000000..e9aec56b2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemAccountSelections.md @@ -0,0 +1,230 @@ +--- +id: v2024-requested-item-account-selections +title: RequestedItemAccountSelections +pagination_label: RequestedItemAccountSelections +sidebar_label: RequestedItemAccountSelections +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemAccountSelections', 'V2024RequestedItemAccountSelections'] +slug: /tools/sdk/go/v2024/models/requested-item-account-selections +tags: ['SDK', 'Software Development Kit', 'RequestedItemAccountSelections', 'V2024RequestedItemAccountSelections'] +--- + +# RequestedItemAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | The description for this requested item | [optional] +**AccountsSelectionBlocked** | Pointer to **bool** | This field indicates if account selections are not allowed for this requested item. * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. * An example is where a user is requesting an access profile that is already assigned to one of their accounts. | [optional] [default to false] +**AccountsSelectionBlockedReason** | Pointer to **NullableString** | If account selections are not allowed for an item, this field will denote the reason. | [optional] +**Type** | Pointer to **string** | The type of the item being requested. | [optional] +**Id** | Pointer to **string** | The id of the requested item | [optional] +**Name** | Pointer to **string** | The name of the requested item | [optional] +**Sources** | Pointer to [**[]SourceAccountSelections**](source-account-selections) | The details for the sources and accounts for the requested item and identity combination | [optional] + +## Methods + +### NewRequestedItemAccountSelections + +`func NewRequestedItemAccountSelections() *RequestedItemAccountSelections` + +NewRequestedItemAccountSelections instantiates a new RequestedItemAccountSelections 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 + +### NewRequestedItemAccountSelectionsWithDefaults + +`func NewRequestedItemAccountSelectionsWithDefaults() *RequestedItemAccountSelections` + +NewRequestedItemAccountSelectionsWithDefaults instantiates a new RequestedItemAccountSelections 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 + +### GetDescription + +`func (o *RequestedItemAccountSelections) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RequestedItemAccountSelections) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RequestedItemAccountSelections) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RequestedItemAccountSelections) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetAccountsSelectionBlocked + +`func (o *RequestedItemAccountSelections) GetAccountsSelectionBlocked() bool` + +GetAccountsSelectionBlocked returns the AccountsSelectionBlocked field if non-nil, zero value otherwise. + +### GetAccountsSelectionBlockedOk + +`func (o *RequestedItemAccountSelections) GetAccountsSelectionBlockedOk() (*bool, bool)` + +GetAccountsSelectionBlockedOk returns a tuple with the AccountsSelectionBlocked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountsSelectionBlocked + +`func (o *RequestedItemAccountSelections) SetAccountsSelectionBlocked(v bool)` + +SetAccountsSelectionBlocked sets AccountsSelectionBlocked field to given value. + +### HasAccountsSelectionBlocked + +`func (o *RequestedItemAccountSelections) HasAccountsSelectionBlocked() bool` + +HasAccountsSelectionBlocked returns a boolean if a field has been set. + +### GetAccountsSelectionBlockedReason + +`func (o *RequestedItemAccountSelections) GetAccountsSelectionBlockedReason() string` + +GetAccountsSelectionBlockedReason returns the AccountsSelectionBlockedReason field if non-nil, zero value otherwise. + +### GetAccountsSelectionBlockedReasonOk + +`func (o *RequestedItemAccountSelections) GetAccountsSelectionBlockedReasonOk() (*string, bool)` + +GetAccountsSelectionBlockedReasonOk returns a tuple with the AccountsSelectionBlockedReason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountsSelectionBlockedReason + +`func (o *RequestedItemAccountSelections) SetAccountsSelectionBlockedReason(v string)` + +SetAccountsSelectionBlockedReason sets AccountsSelectionBlockedReason field to given value. + +### HasAccountsSelectionBlockedReason + +`func (o *RequestedItemAccountSelections) HasAccountsSelectionBlockedReason() bool` + +HasAccountsSelectionBlockedReason returns a boolean if a field has been set. + +### SetAccountsSelectionBlockedReasonNil + +`func (o *RequestedItemAccountSelections) SetAccountsSelectionBlockedReasonNil(b bool)` + + SetAccountsSelectionBlockedReasonNil sets the value for AccountsSelectionBlockedReason to be an explicit nil + +### UnsetAccountsSelectionBlockedReason +`func (o *RequestedItemAccountSelections) UnsetAccountsSelectionBlockedReason()` + +UnsetAccountsSelectionBlockedReason ensures that no value is present for AccountsSelectionBlockedReason, not even an explicit nil +### GetType + +`func (o *RequestedItemAccountSelections) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemAccountSelections) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemAccountSelections) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedItemAccountSelections) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RequestedItemAccountSelections) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemAccountSelections) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemAccountSelections) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestedItemAccountSelections) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RequestedItemAccountSelections) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestedItemAccountSelections) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestedItemAccountSelections) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestedItemAccountSelections) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSources + +`func (o *RequestedItemAccountSelections) GetSources() []SourceAccountSelections` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *RequestedItemAccountSelections) GetSourcesOk() (*[]SourceAccountSelections, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *RequestedItemAccountSelections) SetSources(v []SourceAccountSelections)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *RequestedItemAccountSelections) HasSources() bool` + +HasSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemDetails.md new file mode 100644 index 000000000..2bcad250e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemDetails.md @@ -0,0 +1,90 @@ +--- +id: v2024-requested-item-details +title: RequestedItemDetails +pagination_label: RequestedItemDetails +sidebar_label: RequestedItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemDetails', 'V2024RequestedItemDetails'] +slug: /tools/sdk/go/v2024/models/requested-item-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemDetails', 'V2024RequestedItemDetails'] +--- + +# RequestedItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of access item requested. | [optional] +**Id** | Pointer to **string** | The id of the access item requested. | [optional] + +## Methods + +### NewRequestedItemDetails + +`func NewRequestedItemDetails() *RequestedItemDetails` + +NewRequestedItemDetails instantiates a new RequestedItemDetails 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 + +### NewRequestedItemDetailsWithDefaults + +`func NewRequestedItemDetailsWithDefaults() *RequestedItemDetails` + +NewRequestedItemDetailsWithDefaults instantiates a new RequestedItemDetails 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 + +### GetType + +`func (o *RequestedItemDetails) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemDetails) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemDetails) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedItemDetails) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RequestedItemDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestedItemDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemDtoRef.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..d3013c808 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemDtoRef.md @@ -0,0 +1,266 @@ +--- +id: v2024-requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemDtoRef', 'V2024RequestedItemDtoRef'] +slug: /tools/sdk/go/v2024/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'V2024RequestedItemDtoRef'] +--- + +# RequestedItemDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of the item being requested. | +**Id** | **string** | ID of Role, Access Profile or Entitlement being requested. | +**Comment** | Pointer to **string** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | Pointer to **SailPointTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | Pointer to **NullableString** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | Pointer to **NullableString** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**AccountSelection** | Pointer to [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] + +## Methods + +### NewRequestedItemDtoRef + +`func NewRequestedItemDtoRef(type_ string, id string, ) *RequestedItemDtoRef` + +NewRequestedItemDtoRef instantiates a new RequestedItemDtoRef 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 + +### NewRequestedItemDtoRefWithDefaults + +`func NewRequestedItemDtoRefWithDefaults() *RequestedItemDtoRef` + +NewRequestedItemDtoRefWithDefaults instantiates a new RequestedItemDtoRef 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 + +### GetType + +`func (o *RequestedItemDtoRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemDtoRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemDtoRef) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *RequestedItemDtoRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemDtoRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemDtoRef) SetId(v string)` + +SetId sets Id field to given value. + + +### GetComment + +`func (o *RequestedItemDtoRef) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *RequestedItemDtoRef) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *RequestedItemDtoRef) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *RequestedItemDtoRef) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *RequestedItemDtoRef) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *RequestedItemDtoRef) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *RequestedItemDtoRef) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *RequestedItemDtoRef) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *RequestedItemDtoRef) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *RequestedItemDtoRef) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *RequestedItemDtoRef) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *RequestedItemDtoRef) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetAssignmentId + +`func (o *RequestedItemDtoRef) GetAssignmentId() string` + +GetAssignmentId returns the AssignmentId field if non-nil, zero value otherwise. + +### GetAssignmentIdOk + +`func (o *RequestedItemDtoRef) GetAssignmentIdOk() (*string, bool)` + +GetAssignmentIdOk returns a tuple with the AssignmentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentId + +`func (o *RequestedItemDtoRef) SetAssignmentId(v string)` + +SetAssignmentId sets AssignmentId field to given value. + +### HasAssignmentId + +`func (o *RequestedItemDtoRef) HasAssignmentId() bool` + +HasAssignmentId returns a boolean if a field has been set. + +### SetAssignmentIdNil + +`func (o *RequestedItemDtoRef) SetAssignmentIdNil(b bool)` + + SetAssignmentIdNil sets the value for AssignmentId to be an explicit nil + +### UnsetAssignmentId +`func (o *RequestedItemDtoRef) UnsetAssignmentId()` + +UnsetAssignmentId ensures that no value is present for AssignmentId, not even an explicit nil +### GetNativeIdentity + +`func (o *RequestedItemDtoRef) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *RequestedItemDtoRef) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *RequestedItemDtoRef) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *RequestedItemDtoRef) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### SetNativeIdentityNil + +`func (o *RequestedItemDtoRef) SetNativeIdentityNil(b bool)` + + SetNativeIdentityNil sets the value for NativeIdentity to be an explicit nil + +### UnsetNativeIdentity +`func (o *RequestedItemDtoRef) UnsetNativeIdentity()` + +UnsetNativeIdentity ensures that no value is present for NativeIdentity, not even an explicit nil +### GetAccountSelection + +`func (o *RequestedItemDtoRef) GetAccountSelection() []SourceItemRef` + +GetAccountSelection returns the AccountSelection field if non-nil, zero value otherwise. + +### GetAccountSelectionOk + +`func (o *RequestedItemDtoRef) GetAccountSelectionOk() (*[]SourceItemRef, bool)` + +GetAccountSelectionOk returns a tuple with the AccountSelection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSelection + +`func (o *RequestedItemDtoRef) SetAccountSelection(v []SourceItemRef)` + +SetAccountSelection sets AccountSelection field to given value. + +### HasAccountSelection + +`func (o *RequestedItemDtoRef) HasAccountSelection() bool` + +HasAccountSelection returns a boolean if a field has been set. + +### SetAccountSelectionNil + +`func (o *RequestedItemDtoRef) SetAccountSelectionNil(b bool)` + + SetAccountSelectionNil sets the value for AccountSelection to be an explicit nil + +### UnsetAccountSelection +`func (o *RequestedItemDtoRef) UnsetAccountSelection()` + +UnsetAccountSelection ensures that no value is present for AccountSelection, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatus.md new file mode 100644 index 000000000..323eff9ff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatus.md @@ -0,0 +1,844 @@ +--- +id: v2024-requested-item-status +title: RequestedItemStatus +pagination_label: RequestedItemStatus +sidebar_label: RequestedItemStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatus', 'V2024RequestedItemStatus'] +slug: /tools/sdk/go/v2024/models/requested-item-status +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'V2024RequestedItemStatus'] +--- + +# RequestedItemStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | The ID of the access request. As of 2025, this is a new property. Older access requests might not have an ID. | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the item being requested. | [optional] +**Type** | Pointer to **NullableString** | Type of requested object. | [optional] +**CancelledRequestDetails** | Pointer to [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional] +**ErrorMessages** | Pointer to [**[][]ErrorMessageDto**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional] +**State** | Pointer to [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional] +**ApprovalDetails** | Pointer to [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional] +**ApprovalIds** | Pointer to **[]string** | List of approval IDs associated with the request. | [optional] +**ManualWorkItemDetails** | Pointer to [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional] +**AccountActivityItemId** | Pointer to **string** | Id of associated account activity item. | [optional] +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**Modified** | Pointer to **NullableTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**RequesterComment** | Pointer to [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional] +**SodViolationContext** | Pointer to [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional] +**ProvisioningDetails** | Pointer to [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional] +**PreApprovalTriggerDetails** | Pointer to [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional] +**AccessRequestPhases** | Pointer to [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional] +**Description** | Pointer to **NullableString** | Description associated to the requested object. | [optional] +**RemoveDate** | Pointer to **NullableTime** | When the role access is scheduled for removal. | [optional] +**Cancelable** | Pointer to **bool** | True if the request can be canceled. | [optional] [default to false] +**AccessRequestId** | Pointer to **string** | This is the account activity id. | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] +**RequestedAccounts** | Pointer to [**[]RequestedAccountRef**](requested-account-ref) | The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. | [optional] + +## Methods + +### NewRequestedItemStatus + +`func NewRequestedItemStatus() *RequestedItemStatus` + +NewRequestedItemStatus instantiates a new RequestedItemStatus 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 + +### NewRequestedItemStatusWithDefaults + +`func NewRequestedItemStatusWithDefaults() *RequestedItemStatus` + +NewRequestedItemStatusWithDefaults instantiates a new RequestedItemStatus 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 + +### GetId + +`func (o *RequestedItemStatus) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemStatus) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemStatus) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestedItemStatus) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *RequestedItemStatus) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *RequestedItemStatus) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *RequestedItemStatus) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestedItemStatus) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestedItemStatus) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestedItemStatus) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RequestedItemStatus) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RequestedItemStatus) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetType + +`func (o *RequestedItemStatus) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemStatus) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemStatus) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedItemStatus) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *RequestedItemStatus) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *RequestedItemStatus) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetCancelledRequestDetails + +`func (o *RequestedItemStatus) GetCancelledRequestDetails() RequestedItemStatusCancelledRequestDetails` + +GetCancelledRequestDetails returns the CancelledRequestDetails field if non-nil, zero value otherwise. + +### GetCancelledRequestDetailsOk + +`func (o *RequestedItemStatus) GetCancelledRequestDetailsOk() (*RequestedItemStatusCancelledRequestDetails, bool)` + +GetCancelledRequestDetailsOk returns a tuple with the CancelledRequestDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCancelledRequestDetails + +`func (o *RequestedItemStatus) SetCancelledRequestDetails(v RequestedItemStatusCancelledRequestDetails)` + +SetCancelledRequestDetails sets CancelledRequestDetails field to given value. + +### HasCancelledRequestDetails + +`func (o *RequestedItemStatus) HasCancelledRequestDetails() bool` + +HasCancelledRequestDetails returns a boolean if a field has been set. + +### GetErrorMessages + +`func (o *RequestedItemStatus) GetErrorMessages() [][]ErrorMessageDto` + +GetErrorMessages returns the ErrorMessages field if non-nil, zero value otherwise. + +### GetErrorMessagesOk + +`func (o *RequestedItemStatus) GetErrorMessagesOk() (*[][]ErrorMessageDto, bool)` + +GetErrorMessagesOk returns a tuple with the ErrorMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessages + +`func (o *RequestedItemStatus) SetErrorMessages(v [][]ErrorMessageDto)` + +SetErrorMessages sets ErrorMessages field to given value. + +### HasErrorMessages + +`func (o *RequestedItemStatus) HasErrorMessages() bool` + +HasErrorMessages returns a boolean if a field has been set. + +### SetErrorMessagesNil + +`func (o *RequestedItemStatus) SetErrorMessagesNil(b bool)` + + SetErrorMessagesNil sets the value for ErrorMessages to be an explicit nil + +### UnsetErrorMessages +`func (o *RequestedItemStatus) UnsetErrorMessages()` + +UnsetErrorMessages ensures that no value is present for ErrorMessages, not even an explicit nil +### GetState + +`func (o *RequestedItemStatus) GetState() RequestedItemStatusRequestState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *RequestedItemStatus) GetStateOk() (*RequestedItemStatusRequestState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *RequestedItemStatus) SetState(v RequestedItemStatusRequestState)` + +SetState sets State field to given value. + +### HasState + +`func (o *RequestedItemStatus) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetApprovalDetails + +`func (o *RequestedItemStatus) GetApprovalDetails() []ApprovalStatusDto` + +GetApprovalDetails returns the ApprovalDetails field if non-nil, zero value otherwise. + +### GetApprovalDetailsOk + +`func (o *RequestedItemStatus) GetApprovalDetailsOk() (*[]ApprovalStatusDto, bool)` + +GetApprovalDetailsOk returns a tuple with the ApprovalDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalDetails + +`func (o *RequestedItemStatus) SetApprovalDetails(v []ApprovalStatusDto)` + +SetApprovalDetails sets ApprovalDetails field to given value. + +### HasApprovalDetails + +`func (o *RequestedItemStatus) HasApprovalDetails() bool` + +HasApprovalDetails returns a boolean if a field has been set. + +### GetApprovalIds + +`func (o *RequestedItemStatus) GetApprovalIds() []string` + +GetApprovalIds returns the ApprovalIds field if non-nil, zero value otherwise. + +### GetApprovalIdsOk + +`func (o *RequestedItemStatus) GetApprovalIdsOk() (*[]string, bool)` + +GetApprovalIdsOk returns a tuple with the ApprovalIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalIds + +`func (o *RequestedItemStatus) SetApprovalIds(v []string)` + +SetApprovalIds sets ApprovalIds field to given value. + +### HasApprovalIds + +`func (o *RequestedItemStatus) HasApprovalIds() bool` + +HasApprovalIds returns a boolean if a field has been set. + +### SetApprovalIdsNil + +`func (o *RequestedItemStatus) SetApprovalIdsNil(b bool)` + + SetApprovalIdsNil sets the value for ApprovalIds to be an explicit nil + +### UnsetApprovalIds +`func (o *RequestedItemStatus) UnsetApprovalIds()` + +UnsetApprovalIds ensures that no value is present for ApprovalIds, not even an explicit nil +### GetManualWorkItemDetails + +`func (o *RequestedItemStatus) GetManualWorkItemDetails() []ManualWorkItemDetails` + +GetManualWorkItemDetails returns the ManualWorkItemDetails field if non-nil, zero value otherwise. + +### GetManualWorkItemDetailsOk + +`func (o *RequestedItemStatus) GetManualWorkItemDetailsOk() (*[]ManualWorkItemDetails, bool)` + +GetManualWorkItemDetailsOk returns a tuple with the ManualWorkItemDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManualWorkItemDetails + +`func (o *RequestedItemStatus) SetManualWorkItemDetails(v []ManualWorkItemDetails)` + +SetManualWorkItemDetails sets ManualWorkItemDetails field to given value. + +### HasManualWorkItemDetails + +`func (o *RequestedItemStatus) HasManualWorkItemDetails() bool` + +HasManualWorkItemDetails returns a boolean if a field has been set. + +### SetManualWorkItemDetailsNil + +`func (o *RequestedItemStatus) SetManualWorkItemDetailsNil(b bool)` + + SetManualWorkItemDetailsNil sets the value for ManualWorkItemDetails to be an explicit nil + +### UnsetManualWorkItemDetails +`func (o *RequestedItemStatus) UnsetManualWorkItemDetails()` + +UnsetManualWorkItemDetails ensures that no value is present for ManualWorkItemDetails, not even an explicit nil +### GetAccountActivityItemId + +`func (o *RequestedItemStatus) GetAccountActivityItemId() string` + +GetAccountActivityItemId returns the AccountActivityItemId field if non-nil, zero value otherwise. + +### GetAccountActivityItemIdOk + +`func (o *RequestedItemStatus) GetAccountActivityItemIdOk() (*string, bool)` + +GetAccountActivityItemIdOk returns a tuple with the AccountActivityItemId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActivityItemId + +`func (o *RequestedItemStatus) SetAccountActivityItemId(v string)` + +SetAccountActivityItemId sets AccountActivityItemId field to given value. + +### HasAccountActivityItemId + +`func (o *RequestedItemStatus) HasAccountActivityItemId() bool` + +HasAccountActivityItemId returns a boolean if a field has been set. + +### GetRequestType + +`func (o *RequestedItemStatus) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *RequestedItemStatus) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *RequestedItemStatus) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *RequestedItemStatus) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *RequestedItemStatus) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *RequestedItemStatus) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetModified + +`func (o *RequestedItemStatus) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RequestedItemStatus) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RequestedItemStatus) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RequestedItemStatus) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *RequestedItemStatus) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *RequestedItemStatus) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetCreated + +`func (o *RequestedItemStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RequestedItemStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RequestedItemStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RequestedItemStatus) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetRequester + +`func (o *RequestedItemStatus) GetRequester() AccessItemRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *RequestedItemStatus) GetRequesterOk() (*AccessItemRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *RequestedItemStatus) SetRequester(v AccessItemRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *RequestedItemStatus) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRequestedFor + +`func (o *RequestedItemStatus) GetRequestedFor() RequestedItemStatusRequestedFor` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *RequestedItemStatus) GetRequestedForOk() (*RequestedItemStatusRequestedFor, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *RequestedItemStatus) SetRequestedFor(v RequestedItemStatusRequestedFor)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *RequestedItemStatus) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *RequestedItemStatus) GetRequesterComment() RequestedItemStatusRequesterComment` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *RequestedItemStatus) GetRequesterCommentOk() (*RequestedItemStatusRequesterComment, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *RequestedItemStatus) SetRequesterComment(v RequestedItemStatusRequesterComment)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *RequestedItemStatus) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### GetSodViolationContext + +`func (o *RequestedItemStatus) GetSodViolationContext() RequestedItemStatusSodViolationContext` + +GetSodViolationContext returns the SodViolationContext field if non-nil, zero value otherwise. + +### GetSodViolationContextOk + +`func (o *RequestedItemStatus) GetSodViolationContextOk() (*RequestedItemStatusSodViolationContext, bool)` + +GetSodViolationContextOk returns a tuple with the SodViolationContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodViolationContext + +`func (o *RequestedItemStatus) SetSodViolationContext(v RequestedItemStatusSodViolationContext)` + +SetSodViolationContext sets SodViolationContext field to given value. + +### HasSodViolationContext + +`func (o *RequestedItemStatus) HasSodViolationContext() bool` + +HasSodViolationContext returns a boolean if a field has been set. + +### GetProvisioningDetails + +`func (o *RequestedItemStatus) GetProvisioningDetails() RequestedItemStatusProvisioningDetails` + +GetProvisioningDetails returns the ProvisioningDetails field if non-nil, zero value otherwise. + +### GetProvisioningDetailsOk + +`func (o *RequestedItemStatus) GetProvisioningDetailsOk() (*RequestedItemStatusProvisioningDetails, bool)` + +GetProvisioningDetailsOk returns a tuple with the ProvisioningDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningDetails + +`func (o *RequestedItemStatus) SetProvisioningDetails(v RequestedItemStatusProvisioningDetails)` + +SetProvisioningDetails sets ProvisioningDetails field to given value. + +### HasProvisioningDetails + +`func (o *RequestedItemStatus) HasProvisioningDetails() bool` + +HasProvisioningDetails returns a boolean if a field has been set. + +### GetPreApprovalTriggerDetails + +`func (o *RequestedItemStatus) GetPreApprovalTriggerDetails() RequestedItemStatusPreApprovalTriggerDetails` + +GetPreApprovalTriggerDetails returns the PreApprovalTriggerDetails field if non-nil, zero value otherwise. + +### GetPreApprovalTriggerDetailsOk + +`func (o *RequestedItemStatus) GetPreApprovalTriggerDetailsOk() (*RequestedItemStatusPreApprovalTriggerDetails, bool)` + +GetPreApprovalTriggerDetailsOk returns a tuple with the PreApprovalTriggerDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreApprovalTriggerDetails + +`func (o *RequestedItemStatus) SetPreApprovalTriggerDetails(v RequestedItemStatusPreApprovalTriggerDetails)` + +SetPreApprovalTriggerDetails sets PreApprovalTriggerDetails field to given value. + +### HasPreApprovalTriggerDetails + +`func (o *RequestedItemStatus) HasPreApprovalTriggerDetails() bool` + +HasPreApprovalTriggerDetails returns a boolean if a field has been set. + +### GetAccessRequestPhases + +`func (o *RequestedItemStatus) GetAccessRequestPhases() []AccessRequestPhases` + +GetAccessRequestPhases returns the AccessRequestPhases field if non-nil, zero value otherwise. + +### GetAccessRequestPhasesOk + +`func (o *RequestedItemStatus) GetAccessRequestPhasesOk() (*[]AccessRequestPhases, bool)` + +GetAccessRequestPhasesOk returns a tuple with the AccessRequestPhases field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestPhases + +`func (o *RequestedItemStatus) SetAccessRequestPhases(v []AccessRequestPhases)` + +SetAccessRequestPhases sets AccessRequestPhases field to given value. + +### HasAccessRequestPhases + +`func (o *RequestedItemStatus) HasAccessRequestPhases() bool` + +HasAccessRequestPhases returns a boolean if a field has been set. + +### SetAccessRequestPhasesNil + +`func (o *RequestedItemStatus) SetAccessRequestPhasesNil(b bool)` + + SetAccessRequestPhasesNil sets the value for AccessRequestPhases to be an explicit nil + +### UnsetAccessRequestPhases +`func (o *RequestedItemStatus) UnsetAccessRequestPhases()` + +UnsetAccessRequestPhases ensures that no value is present for AccessRequestPhases, not even an explicit nil +### GetDescription + +`func (o *RequestedItemStatus) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RequestedItemStatus) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RequestedItemStatus) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RequestedItemStatus) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RequestedItemStatus) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RequestedItemStatus) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetRemoveDate + +`func (o *RequestedItemStatus) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *RequestedItemStatus) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *RequestedItemStatus) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *RequestedItemStatus) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *RequestedItemStatus) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *RequestedItemStatus) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil +### GetCancelable + +`func (o *RequestedItemStatus) GetCancelable() bool` + +GetCancelable returns the Cancelable field if non-nil, zero value otherwise. + +### GetCancelableOk + +`func (o *RequestedItemStatus) GetCancelableOk() (*bool, bool)` + +GetCancelableOk returns a tuple with the Cancelable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCancelable + +`func (o *RequestedItemStatus) SetCancelable(v bool)` + +SetCancelable sets Cancelable field to given value. + +### HasCancelable + +`func (o *RequestedItemStatus) HasCancelable() bool` + +HasCancelable returns a boolean if a field has been set. + +### GetAccessRequestId + +`func (o *RequestedItemStatus) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *RequestedItemStatus) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *RequestedItemStatus) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + +### HasAccessRequestId + +`func (o *RequestedItemStatus) HasAccessRequestId() bool` + +HasAccessRequestId returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *RequestedItemStatus) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *RequestedItemStatus) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *RequestedItemStatus) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *RequestedItemStatus) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *RequestedItemStatus) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *RequestedItemStatus) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetRequestedAccounts + +`func (o *RequestedItemStatus) GetRequestedAccounts() []RequestedAccountRef` + +GetRequestedAccounts returns the RequestedAccounts field if non-nil, zero value otherwise. + +### GetRequestedAccountsOk + +`func (o *RequestedItemStatus) GetRequestedAccountsOk() (*[]RequestedAccountRef, bool)` + +GetRequestedAccountsOk returns a tuple with the RequestedAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedAccounts + +`func (o *RequestedItemStatus) SetRequestedAccounts(v []RequestedAccountRef)` + +SetRequestedAccounts sets RequestedAccounts field to given value. + +### HasRequestedAccounts + +`func (o *RequestedItemStatus) HasRequestedAccounts() bool` + +HasRequestedAccounts returns a boolean if a field has been set. + +### SetRequestedAccountsNil + +`func (o *RequestedItemStatus) SetRequestedAccountsNil(b bool)` + + SetRequestedAccountsNil sets the value for RequestedAccounts to be an explicit nil + +### UnsetRequestedAccounts +`func (o *RequestedItemStatus) UnsetRequestedAccounts()` + +UnsetRequestedAccounts ensures that no value is present for RequestedAccounts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusCancelledRequestDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusCancelledRequestDetails.md new file mode 100644 index 000000000..fa207bb98 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusCancelledRequestDetails.md @@ -0,0 +1,116 @@ +--- +id: v2024-requested-item-status-cancelled-request-details +title: RequestedItemStatusCancelledRequestDetails +pagination_label: RequestedItemStatusCancelledRequestDetails +sidebar_label: RequestedItemStatusCancelledRequestDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusCancelledRequestDetails', 'V2024RequestedItemStatusCancelledRequestDetails'] +slug: /tools/sdk/go/v2024/models/requested-item-status-cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusCancelledRequestDetails', 'V2024RequestedItemStatusCancelledRequestDetails'] +--- + +# RequestedItemStatusCancelledRequestDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment made by the owner when cancelling the associated request. | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Modified** | Pointer to **SailPointTime** | Date comment was added by the owner when cancelling the associated request. | [optional] + +## Methods + +### NewRequestedItemStatusCancelledRequestDetails + +`func NewRequestedItemStatusCancelledRequestDetails() *RequestedItemStatusCancelledRequestDetails` + +NewRequestedItemStatusCancelledRequestDetails instantiates a new RequestedItemStatusCancelledRequestDetails 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 + +### NewRequestedItemStatusCancelledRequestDetailsWithDefaults + +`func NewRequestedItemStatusCancelledRequestDetailsWithDefaults() *RequestedItemStatusCancelledRequestDetails` + +NewRequestedItemStatusCancelledRequestDetailsWithDefaults instantiates a new RequestedItemStatusCancelledRequestDetails 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 + +### GetComment + +`func (o *RequestedItemStatusCancelledRequestDetails) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *RequestedItemStatusCancelledRequestDetails) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *RequestedItemStatusCancelledRequestDetails) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *RequestedItemStatusCancelledRequestDetails) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetOwner + +`func (o *RequestedItemStatusCancelledRequestDetails) GetOwner() OwnerDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *RequestedItemStatusCancelledRequestDetails) GetOwnerOk() (*OwnerDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *RequestedItemStatusCancelledRequestDetails) SetOwner(v OwnerDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *RequestedItemStatusCancelledRequestDetails) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetModified + +`func (o *RequestedItemStatusCancelledRequestDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RequestedItemStatusCancelledRequestDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RequestedItemStatusCancelledRequestDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RequestedItemStatusCancelledRequestDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusPreApprovalTriggerDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusPreApprovalTriggerDetails.md new file mode 100644 index 000000000..2f1bb21da --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusPreApprovalTriggerDetails.md @@ -0,0 +1,116 @@ +--- +id: v2024-requested-item-status-pre-approval-trigger-details +title: RequestedItemStatusPreApprovalTriggerDetails +pagination_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusPreApprovalTriggerDetails', 'V2024RequestedItemStatusPreApprovalTriggerDetails'] +slug: /tools/sdk/go/v2024/models/requested-item-status-pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusPreApprovalTriggerDetails', 'V2024RequestedItemStatusPreApprovalTriggerDetails'] +--- + +# RequestedItemStatusPreApprovalTriggerDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment left for the pre-approval decision | [optional] +**Reviewer** | Pointer to **string** | The reviewer of the pre-approval decision | [optional] +**Decision** | Pointer to **string** | The decision of the pre-approval trigger | [optional] + +## Methods + +### NewRequestedItemStatusPreApprovalTriggerDetails + +`func NewRequestedItemStatusPreApprovalTriggerDetails() *RequestedItemStatusPreApprovalTriggerDetails` + +NewRequestedItemStatusPreApprovalTriggerDetails instantiates a new RequestedItemStatusPreApprovalTriggerDetails 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 + +### NewRequestedItemStatusPreApprovalTriggerDetailsWithDefaults + +`func NewRequestedItemStatusPreApprovalTriggerDetailsWithDefaults() *RequestedItemStatusPreApprovalTriggerDetails` + +NewRequestedItemStatusPreApprovalTriggerDetailsWithDefaults instantiates a new RequestedItemStatusPreApprovalTriggerDetails 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 + +### GetComment + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetReviewer + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetReviewer() string` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetReviewerOk() (*string, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) SetReviewer(v string)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetDecision + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetDecision() string` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetDecisionOk() (*string, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) SetDecision(v string)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusProvisioningDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusProvisioningDetails.md new file mode 100644 index 000000000..cccd023dd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusProvisioningDetails.md @@ -0,0 +1,64 @@ +--- +id: v2024-requested-item-status-provisioning-details +title: RequestedItemStatusProvisioningDetails +pagination_label: RequestedItemStatusProvisioningDetails +sidebar_label: RequestedItemStatusProvisioningDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusProvisioningDetails', 'V2024RequestedItemStatusProvisioningDetails'] +slug: /tools/sdk/go/v2024/models/requested-item-status-provisioning-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusProvisioningDetails', 'V2024RequestedItemStatusProvisioningDetails'] +--- + +# RequestedItemStatusProvisioningDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrderedSubPhaseReferences** | Pointer to **string** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. | [optional] + +## Methods + +### NewRequestedItemStatusProvisioningDetails + +`func NewRequestedItemStatusProvisioningDetails() *RequestedItemStatusProvisioningDetails` + +NewRequestedItemStatusProvisioningDetails instantiates a new RequestedItemStatusProvisioningDetails 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 + +### NewRequestedItemStatusProvisioningDetailsWithDefaults + +`func NewRequestedItemStatusProvisioningDetailsWithDefaults() *RequestedItemStatusProvisioningDetails` + +NewRequestedItemStatusProvisioningDetailsWithDefaults instantiates a new RequestedItemStatusProvisioningDetails 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 + +### GetOrderedSubPhaseReferences + +`func (o *RequestedItemStatusProvisioningDetails) GetOrderedSubPhaseReferences() string` + +GetOrderedSubPhaseReferences returns the OrderedSubPhaseReferences field if non-nil, zero value otherwise. + +### GetOrderedSubPhaseReferencesOk + +`func (o *RequestedItemStatusProvisioningDetails) GetOrderedSubPhaseReferencesOk() (*string, bool)` + +GetOrderedSubPhaseReferencesOk returns a tuple with the OrderedSubPhaseReferences field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderedSubPhaseReferences + +`func (o *RequestedItemStatusProvisioningDetails) SetOrderedSubPhaseReferences(v string)` + +SetOrderedSubPhaseReferences sets OrderedSubPhaseReferences field to given value. + +### HasOrderedSubPhaseReferences + +`func (o *RequestedItemStatusProvisioningDetails) HasOrderedSubPhaseReferences() bool` + +HasOrderedSubPhaseReferences returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusRequestState.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusRequestState.md new file mode 100644 index 000000000..fcc75d340 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusRequestState.md @@ -0,0 +1,35 @@ +--- +id: v2024-requested-item-status-request-state +title: RequestedItemStatusRequestState +pagination_label: RequestedItemStatusRequestState +sidebar_label: RequestedItemStatusRequestState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusRequestState', 'V2024RequestedItemStatusRequestState'] +slug: /tools/sdk/go/v2024/models/requested-item-status-request-state +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestState', 'V2024RequestedItemStatusRequestState'] +--- + +# RequestedItemStatusRequestState + +## Enum + + +* `EXECUTING` (value: `"EXECUTING"`) + +* `REQUEST_COMPLETED` (value: `"REQUEST_COMPLETED"`) + +* `CANCELLED` (value: `"CANCELLED"`) + +* `TERMINATED` (value: `"TERMINATED"`) + +* `PROVISIONING_VERIFICATION_PENDING` (value: `"PROVISIONING_VERIFICATION_PENDING"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `PROVISIONING_FAILED` (value: `"PROVISIONING_FAILED"`) + +* `NOT_ALL_ITEMS_PROVISIONED` (value: `"NOT_ALL_ITEMS_PROVISIONED"`) + +* `ERROR` (value: `"ERROR"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusRequestedFor.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusRequestedFor.md new file mode 100644 index 000000000..97a3b85ec --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusRequestedFor.md @@ -0,0 +1,116 @@ +--- +id: v2024-requested-item-status-requested-for +title: RequestedItemStatusRequestedFor +pagination_label: RequestedItemStatusRequestedFor +sidebar_label: RequestedItemStatusRequestedFor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusRequestedFor', 'V2024RequestedItemStatusRequestedFor'] +slug: /tools/sdk/go/v2024/models/requested-item-status-requested-for +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestedFor', 'V2024RequestedItemStatusRequestedFor'] +--- + +# RequestedItemStatusRequestedFor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the object to which this reference applies | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewRequestedItemStatusRequestedFor + +`func NewRequestedItemStatusRequestedFor() *RequestedItemStatusRequestedFor` + +NewRequestedItemStatusRequestedFor instantiates a new RequestedItemStatusRequestedFor 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 + +### NewRequestedItemStatusRequestedForWithDefaults + +`func NewRequestedItemStatusRequestedForWithDefaults() *RequestedItemStatusRequestedFor` + +NewRequestedItemStatusRequestedForWithDefaults instantiates a new RequestedItemStatusRequestedFor 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 + +### GetType + +`func (o *RequestedItemStatusRequestedFor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemStatusRequestedFor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemStatusRequestedFor) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedItemStatusRequestedFor) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RequestedItemStatusRequestedFor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemStatusRequestedFor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemStatusRequestedFor) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestedItemStatusRequestedFor) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RequestedItemStatusRequestedFor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestedItemStatusRequestedFor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestedItemStatusRequestedFor) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestedItemStatusRequestedFor) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusRequesterComment.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusRequesterComment.md new file mode 100644 index 000000000..7cbb60b61 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusRequesterComment.md @@ -0,0 +1,126 @@ +--- +id: v2024-requested-item-status-requester-comment +title: RequestedItemStatusRequesterComment +pagination_label: RequestedItemStatusRequesterComment +sidebar_label: RequestedItemStatusRequesterComment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusRequesterComment', 'V2024RequestedItemStatusRequesterComment'] +slug: /tools/sdk/go/v2024/models/requested-item-status-requester-comment +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequesterComment', 'V2024RequestedItemStatusRequesterComment'] +--- + +# RequestedItemStatusRequesterComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **NullableString** | Comment content. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Methods + +### NewRequestedItemStatusRequesterComment + +`func NewRequestedItemStatusRequesterComment() *RequestedItemStatusRequesterComment` + +NewRequestedItemStatusRequesterComment instantiates a new RequestedItemStatusRequesterComment 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 + +### NewRequestedItemStatusRequesterCommentWithDefaults + +`func NewRequestedItemStatusRequesterCommentWithDefaults() *RequestedItemStatusRequesterComment` + +NewRequestedItemStatusRequesterCommentWithDefaults instantiates a new RequestedItemStatusRequesterComment 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 + +### GetComment + +`func (o *RequestedItemStatusRequesterComment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *RequestedItemStatusRequesterComment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *RequestedItemStatusRequesterComment) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *RequestedItemStatusRequesterComment) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *RequestedItemStatusRequesterComment) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *RequestedItemStatusRequesterComment) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetCreated + +`func (o *RequestedItemStatusRequesterComment) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RequestedItemStatusRequesterComment) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RequestedItemStatusRequesterComment) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RequestedItemStatusRequesterComment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetAuthor + +`func (o *RequestedItemStatusRequesterComment) GetAuthor() CommentDtoAuthor` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *RequestedItemStatusRequesterComment) GetAuthorOk() (*CommentDtoAuthor, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *RequestedItemStatusRequesterComment) SetAuthor(v CommentDtoAuthor)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *RequestedItemStatusRequesterComment) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusSodViolationContext.md b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusSodViolationContext.md new file mode 100644 index 000000000..bf7c65ed5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RequestedItemStatusSodViolationContext.md @@ -0,0 +1,136 @@ +--- +id: v2024-requested-item-status-sod-violation-context +title: RequestedItemStatusSodViolationContext +pagination_label: RequestedItemStatusSodViolationContext +sidebar_label: RequestedItemStatusSodViolationContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusSodViolationContext', 'V2024RequestedItemStatusSodViolationContext'] +slug: /tools/sdk/go/v2024/models/requested-item-status-sod-violation-context +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusSodViolationContext', 'V2024RequestedItemStatusSodViolationContext'] +--- + +# RequestedItemStatusSodViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **NullableString** | The status of SOD violation check | [optional] +**Uuid** | Pointer to **NullableString** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] + +## Methods + +### NewRequestedItemStatusSodViolationContext + +`func NewRequestedItemStatusSodViolationContext() *RequestedItemStatusSodViolationContext` + +NewRequestedItemStatusSodViolationContext instantiates a new RequestedItemStatusSodViolationContext 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 + +### NewRequestedItemStatusSodViolationContextWithDefaults + +`func NewRequestedItemStatusSodViolationContextWithDefaults() *RequestedItemStatusSodViolationContext` + +NewRequestedItemStatusSodViolationContextWithDefaults instantiates a new RequestedItemStatusSodViolationContext 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 + +### GetState + +`func (o *RequestedItemStatusSodViolationContext) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *RequestedItemStatusSodViolationContext) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *RequestedItemStatusSodViolationContext) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *RequestedItemStatusSodViolationContext) HasState() bool` + +HasState returns a boolean if a field has been set. + +### SetStateNil + +`func (o *RequestedItemStatusSodViolationContext) SetStateNil(b bool)` + + SetStateNil sets the value for State to be an explicit nil + +### UnsetState +`func (o *RequestedItemStatusSodViolationContext) UnsetState()` + +UnsetState ensures that no value is present for State, not even an explicit nil +### GetUuid + +`func (o *RequestedItemStatusSodViolationContext) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *RequestedItemStatusSodViolationContext) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *RequestedItemStatusSodViolationContext) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *RequestedItemStatusSodViolationContext) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *RequestedItemStatusSodViolationContext) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *RequestedItemStatusSodViolationContext) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetViolationCheckResult + +`func (o *RequestedItemStatusSodViolationContext) GetViolationCheckResult() SodViolationCheckResult` + +GetViolationCheckResult returns the ViolationCheckResult field if non-nil, zero value otherwise. + +### GetViolationCheckResultOk + +`func (o *RequestedItemStatusSodViolationContext) GetViolationCheckResultOk() (*SodViolationCheckResult, bool)` + +GetViolationCheckResultOk returns a tuple with the ViolationCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationCheckResult + +`func (o *RequestedItemStatusSodViolationContext) SetViolationCheckResult(v SodViolationCheckResult)` + +SetViolationCheckResult sets ViolationCheckResult field to given value. + +### HasViolationCheckResult + +`func (o *RequestedItemStatusSodViolationContext) HasViolationCheckResult() bool` + +HasViolationCheckResult returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ResourceObject.md b/docs/tools/sdk/go/Reference/V2024/Models/ResourceObject.md new file mode 100644 index 000000000..031e2f034 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ResourceObject.md @@ -0,0 +1,376 @@ +--- +id: v2024-resource-object +title: ResourceObject +pagination_label: ResourceObject +sidebar_label: ResourceObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ResourceObject', 'V2024ResourceObject'] +slug: /tools/sdk/go/v2024/models/resource-object +tags: ['SDK', 'Software Development Kit', 'ResourceObject', 'V2024ResourceObject'] +--- + +# ResourceObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Instance** | Pointer to **string** | Identifier of the specific instance where this object resides. | [optional] [readonly] +**Identity** | Pointer to **string** | Native identity of the object in the Source. | [optional] [readonly] +**Uuid** | Pointer to **string** | Universal unique identifier of the object in the Source. | [optional] [readonly] +**PreviousIdentity** | Pointer to **string** | Native identity that the object has previously. | [optional] [readonly] +**Name** | Pointer to **string** | Display name for this object. | [optional] [readonly] +**ObjectType** | Pointer to **string** | Type of object. | [optional] [readonly] +**Incomplete** | Pointer to **bool** | A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. | [optional] [readonly] +**Incremental** | Pointer to **bool** | A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. | [optional] [readonly] +**Delete** | Pointer to **bool** | A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. | [optional] [readonly] +**Remove** | Pointer to **bool** | A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. | [optional] [readonly] +**Missing** | Pointer to **[]string** | A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain \"groups\". | [optional] [readonly] +**Attributes** | Pointer to **map[string]interface{}** | Attributes of this ResourceObject. | [optional] [readonly] +**FinalUpdate** | Pointer to **bool** | In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. | [optional] [readonly] + +## Methods + +### NewResourceObject + +`func NewResourceObject() *ResourceObject` + +NewResourceObject instantiates a new ResourceObject 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 + +### NewResourceObjectWithDefaults + +`func NewResourceObjectWithDefaults() *ResourceObject` + +NewResourceObjectWithDefaults instantiates a new ResourceObject 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 + +### GetInstance + +`func (o *ResourceObject) GetInstance() string` + +GetInstance returns the Instance field if non-nil, zero value otherwise. + +### GetInstanceOk + +`func (o *ResourceObject) GetInstanceOk() (*string, bool)` + +GetInstanceOk returns a tuple with the Instance field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstance + +`func (o *ResourceObject) SetInstance(v string)` + +SetInstance sets Instance field to given value. + +### HasInstance + +`func (o *ResourceObject) HasInstance() bool` + +HasInstance returns a boolean if a field has been set. + +### GetIdentity + +`func (o *ResourceObject) GetIdentity() string` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *ResourceObject) GetIdentityOk() (*string, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *ResourceObject) SetIdentity(v string)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *ResourceObject) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetUuid + +`func (o *ResourceObject) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *ResourceObject) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *ResourceObject) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *ResourceObject) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### GetPreviousIdentity + +`func (o *ResourceObject) GetPreviousIdentity() string` + +GetPreviousIdentity returns the PreviousIdentity field if non-nil, zero value otherwise. + +### GetPreviousIdentityOk + +`func (o *ResourceObject) GetPreviousIdentityOk() (*string, bool)` + +GetPreviousIdentityOk returns a tuple with the PreviousIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousIdentity + +`func (o *ResourceObject) SetPreviousIdentity(v string)` + +SetPreviousIdentity sets PreviousIdentity field to given value. + +### HasPreviousIdentity + +`func (o *ResourceObject) HasPreviousIdentity() bool` + +HasPreviousIdentity returns a boolean if a field has been set. + +### GetName + +`func (o *ResourceObject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ResourceObject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ResourceObject) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ResourceObject) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetObjectType + +`func (o *ResourceObject) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *ResourceObject) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *ResourceObject) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + +### HasObjectType + +`func (o *ResourceObject) HasObjectType() bool` + +HasObjectType returns a boolean if a field has been set. + +### GetIncomplete + +`func (o *ResourceObject) GetIncomplete() bool` + +GetIncomplete returns the Incomplete field if non-nil, zero value otherwise. + +### GetIncompleteOk + +`func (o *ResourceObject) GetIncompleteOk() (*bool, bool)` + +GetIncompleteOk returns a tuple with the Incomplete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncomplete + +`func (o *ResourceObject) SetIncomplete(v bool)` + +SetIncomplete sets Incomplete field to given value. + +### HasIncomplete + +`func (o *ResourceObject) HasIncomplete() bool` + +HasIncomplete returns a boolean if a field has been set. + +### GetIncremental + +`func (o *ResourceObject) GetIncremental() bool` + +GetIncremental returns the Incremental field if non-nil, zero value otherwise. + +### GetIncrementalOk + +`func (o *ResourceObject) GetIncrementalOk() (*bool, bool)` + +GetIncrementalOk returns a tuple with the Incremental field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncremental + +`func (o *ResourceObject) SetIncremental(v bool)` + +SetIncremental sets Incremental field to given value. + +### HasIncremental + +`func (o *ResourceObject) HasIncremental() bool` + +HasIncremental returns a boolean if a field has been set. + +### GetDelete + +`func (o *ResourceObject) GetDelete() bool` + +GetDelete returns the Delete field if non-nil, zero value otherwise. + +### GetDeleteOk + +`func (o *ResourceObject) GetDeleteOk() (*bool, bool)` + +GetDeleteOk returns a tuple with the Delete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelete + +`func (o *ResourceObject) SetDelete(v bool)` + +SetDelete sets Delete field to given value. + +### HasDelete + +`func (o *ResourceObject) HasDelete() bool` + +HasDelete returns a boolean if a field has been set. + +### GetRemove + +`func (o *ResourceObject) GetRemove() bool` + +GetRemove returns the Remove field if non-nil, zero value otherwise. + +### GetRemoveOk + +`func (o *ResourceObject) GetRemoveOk() (*bool, bool)` + +GetRemoveOk returns a tuple with the Remove field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemove + +`func (o *ResourceObject) SetRemove(v bool)` + +SetRemove sets Remove field to given value. + +### HasRemove + +`func (o *ResourceObject) HasRemove() bool` + +HasRemove returns a boolean if a field has been set. + +### GetMissing + +`func (o *ResourceObject) GetMissing() []string` + +GetMissing returns the Missing field if non-nil, zero value otherwise. + +### GetMissingOk + +`func (o *ResourceObject) GetMissingOk() (*[]string, bool)` + +GetMissingOk returns a tuple with the Missing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMissing + +`func (o *ResourceObject) SetMissing(v []string)` + +SetMissing sets Missing field to given value. + +### HasMissing + +`func (o *ResourceObject) HasMissing() bool` + +HasMissing returns a boolean if a field has been set. + +### GetAttributes + +`func (o *ResourceObject) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ResourceObject) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ResourceObject) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ResourceObject) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetFinalUpdate + +`func (o *ResourceObject) GetFinalUpdate() bool` + +GetFinalUpdate returns the FinalUpdate field if non-nil, zero value otherwise. + +### GetFinalUpdateOk + +`func (o *ResourceObject) GetFinalUpdateOk() (*bool, bool)` + +GetFinalUpdateOk returns a tuple with the FinalUpdate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFinalUpdate + +`func (o *ResourceObject) SetFinalUpdate(v bool)` + +SetFinalUpdate sets FinalUpdate field to given value. + +### HasFinalUpdate + +`func (o *ResourceObject) HasFinalUpdate() bool` + +HasFinalUpdate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ResourceObjectsRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/ResourceObjectsRequest.md new file mode 100644 index 000000000..eebac10ad --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ResourceObjectsRequest.md @@ -0,0 +1,90 @@ +--- +id: v2024-resource-objects-request +title: ResourceObjectsRequest +pagination_label: ResourceObjectsRequest +sidebar_label: ResourceObjectsRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ResourceObjectsRequest', 'V2024ResourceObjectsRequest'] +slug: /tools/sdk/go/v2024/models/resource-objects-request +tags: ['SDK', 'Software Development Kit', 'ResourceObjectsRequest', 'V2024ResourceObjectsRequest'] +--- + +# ResourceObjectsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectType** | Pointer to **string** | The type of resource objects to iterate over. | [optional] [default to "account"] +**MaxCount** | Pointer to **int32** | The maximum number of resource objects to iterate over and return. | [optional] [default to 25] + +## Methods + +### NewResourceObjectsRequest + +`func NewResourceObjectsRequest() *ResourceObjectsRequest` + +NewResourceObjectsRequest instantiates a new ResourceObjectsRequest 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 + +### NewResourceObjectsRequestWithDefaults + +`func NewResourceObjectsRequestWithDefaults() *ResourceObjectsRequest` + +NewResourceObjectsRequestWithDefaults instantiates a new ResourceObjectsRequest 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 + +### GetObjectType + +`func (o *ResourceObjectsRequest) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *ResourceObjectsRequest) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *ResourceObjectsRequest) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + +### HasObjectType + +`func (o *ResourceObjectsRequest) HasObjectType() bool` + +HasObjectType returns a boolean if a field has been set. + +### GetMaxCount + +`func (o *ResourceObjectsRequest) GetMaxCount() int32` + +GetMaxCount returns the MaxCount field if non-nil, zero value otherwise. + +### GetMaxCountOk + +`func (o *ResourceObjectsRequest) GetMaxCountOk() (*int32, bool)` + +GetMaxCountOk returns a tuple with the MaxCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxCount + +`func (o *ResourceObjectsRequest) SetMaxCount(v int32)` + +SetMaxCount sets MaxCount field to given value. + +### HasMaxCount + +`func (o *ResourceObjectsRequest) HasMaxCount() bool` + +HasMaxCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ResourceObjectsResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ResourceObjectsResponse.md new file mode 100644 index 000000000..ef4a0139d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ResourceObjectsResponse.md @@ -0,0 +1,168 @@ +--- +id: v2024-resource-objects-response +title: ResourceObjectsResponse +pagination_label: ResourceObjectsResponse +sidebar_label: ResourceObjectsResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ResourceObjectsResponse', 'V2024ResourceObjectsResponse'] +slug: /tools/sdk/go/v2024/models/resource-objects-response +tags: ['SDK', 'Software Development Kit', 'ResourceObjectsResponse', 'V2024ResourceObjectsResponse'] +--- + +# ResourceObjectsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the source | [optional] [readonly] +**Name** | Pointer to **string** | Name of the source | [optional] [readonly] +**ObjectCount** | Pointer to **int32** | The number of objects that were fetched by the connector. | [optional] [readonly] +**ElapsedMillis** | Pointer to **int32** | The number of milliseconds spent on the entire request. | [optional] [readonly] +**ResourceObjects** | Pointer to [**[]ResourceObject**](resource-object) | Fetched objects from the source connector. | [optional] [readonly] + +## Methods + +### NewResourceObjectsResponse + +`func NewResourceObjectsResponse() *ResourceObjectsResponse` + +NewResourceObjectsResponse instantiates a new ResourceObjectsResponse 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 + +### NewResourceObjectsResponseWithDefaults + +`func NewResourceObjectsResponseWithDefaults() *ResourceObjectsResponse` + +NewResourceObjectsResponseWithDefaults instantiates a new ResourceObjectsResponse 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 + +### GetId + +`func (o *ResourceObjectsResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ResourceObjectsResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ResourceObjectsResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ResourceObjectsResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ResourceObjectsResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ResourceObjectsResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ResourceObjectsResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ResourceObjectsResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetObjectCount + +`func (o *ResourceObjectsResponse) GetObjectCount() int32` + +GetObjectCount returns the ObjectCount field if non-nil, zero value otherwise. + +### GetObjectCountOk + +`func (o *ResourceObjectsResponse) GetObjectCountOk() (*int32, bool)` + +GetObjectCountOk returns a tuple with the ObjectCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectCount + +`func (o *ResourceObjectsResponse) SetObjectCount(v int32)` + +SetObjectCount sets ObjectCount field to given value. + +### HasObjectCount + +`func (o *ResourceObjectsResponse) HasObjectCount() bool` + +HasObjectCount returns a boolean if a field has been set. + +### GetElapsedMillis + +`func (o *ResourceObjectsResponse) GetElapsedMillis() int32` + +GetElapsedMillis returns the ElapsedMillis field if non-nil, zero value otherwise. + +### GetElapsedMillisOk + +`func (o *ResourceObjectsResponse) GetElapsedMillisOk() (*int32, bool)` + +GetElapsedMillisOk returns a tuple with the ElapsedMillis field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElapsedMillis + +`func (o *ResourceObjectsResponse) SetElapsedMillis(v int32)` + +SetElapsedMillis sets ElapsedMillis field to given value. + +### HasElapsedMillis + +`func (o *ResourceObjectsResponse) HasElapsedMillis() bool` + +HasElapsedMillis returns a boolean if a field has been set. + +### GetResourceObjects + +`func (o *ResourceObjectsResponse) GetResourceObjects() []ResourceObject` + +GetResourceObjects returns the ResourceObjects field if non-nil, zero value otherwise. + +### GetResourceObjectsOk + +`func (o *ResourceObjectsResponse) GetResourceObjectsOk() (*[]ResourceObject, bool)` + +GetResourceObjectsOk returns a tuple with the ResourceObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResourceObjects + +`func (o *ResourceObjectsResponse) SetResourceObjects(v []ResourceObject)` + +SetResourceObjects sets ResourceObjects field to given value. + +### HasResourceObjects + +`func (o *ResourceObjectsResponse) HasResourceObjects() bool` + +HasResourceObjects returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Result.md b/docs/tools/sdk/go/Reference/V2024/Models/Result.md new file mode 100644 index 000000000..451e17b84 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Result.md @@ -0,0 +1,64 @@ +--- +id: v2024-result +title: Result +pagination_label: Result +sidebar_label: Result +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Result', 'V2024Result'] +slug: /tools/sdk/go/v2024/models/result +tags: ['SDK', 'Software Development Kit', 'Result', 'V2024Result'] +--- + +# Result + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | Request result status | [optional] + +## Methods + +### NewResult + +`func NewResult() *Result` + +NewResult instantiates a new Result 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 + +### NewResultWithDefaults + +`func NewResultWithDefaults() *Result` + +NewResultWithDefaults instantiates a new Result 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 + +### GetStatus + +`func (o *Result) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Result) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Result) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Result) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReviewDecision.md b/docs/tools/sdk/go/Reference/V2024/Models/ReviewDecision.md new file mode 100644 index 000000000..72f453bf0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReviewDecision.md @@ -0,0 +1,179 @@ +--- +id: v2024-review-decision +title: ReviewDecision +pagination_label: ReviewDecision +sidebar_label: ReviewDecision +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewDecision', 'V2024ReviewDecision'] +slug: /tools/sdk/go/v2024/models/review-decision +tags: ['SDK', 'Software Development Kit', 'ReviewDecision', 'V2024ReviewDecision'] +--- + +# ReviewDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The id of the review decision | +**Decision** | [**CertificationDecision**](certification-decision) | | +**ProposedEndDate** | Pointer to **SailPointTime** | The date at which a user's access should be taken away. Should only be set for `REVOKE` decisions. | [optional] +**Bulk** | **bool** | Indicates whether decision should be marked as part of a larger bulk decision | +**Recommendation** | Pointer to [**ReviewRecommendation**](review-recommendation) | | [optional] +**Comments** | Pointer to **string** | Comments recorded when the decision was made | [optional] + +## Methods + +### NewReviewDecision + +`func NewReviewDecision(id string, decision CertificationDecision, bulk bool, ) *ReviewDecision` + +NewReviewDecision instantiates a new ReviewDecision 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 + +### NewReviewDecisionWithDefaults + +`func NewReviewDecisionWithDefaults() *ReviewDecision` + +NewReviewDecisionWithDefaults instantiates a new ReviewDecision 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 + +### GetId + +`func (o *ReviewDecision) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewDecision) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewDecision) SetId(v string)` + +SetId sets Id field to given value. + + +### GetDecision + +`func (o *ReviewDecision) GetDecision() CertificationDecision` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *ReviewDecision) GetDecisionOk() (*CertificationDecision, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *ReviewDecision) SetDecision(v CertificationDecision)` + +SetDecision sets Decision field to given value. + + +### GetProposedEndDate + +`func (o *ReviewDecision) GetProposedEndDate() SailPointTime` + +GetProposedEndDate returns the ProposedEndDate field if non-nil, zero value otherwise. + +### GetProposedEndDateOk + +`func (o *ReviewDecision) GetProposedEndDateOk() (*SailPointTime, bool)` + +GetProposedEndDateOk returns a tuple with the ProposedEndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProposedEndDate + +`func (o *ReviewDecision) SetProposedEndDate(v SailPointTime)` + +SetProposedEndDate sets ProposedEndDate field to given value. + +### HasProposedEndDate + +`func (o *ReviewDecision) HasProposedEndDate() bool` + +HasProposedEndDate returns a boolean if a field has been set. + +### GetBulk + +`func (o *ReviewDecision) GetBulk() bool` + +GetBulk returns the Bulk field if non-nil, zero value otherwise. + +### GetBulkOk + +`func (o *ReviewDecision) GetBulkOk() (*bool, bool)` + +GetBulkOk returns a tuple with the Bulk field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBulk + +`func (o *ReviewDecision) SetBulk(v bool)` + +SetBulk sets Bulk field to given value. + + +### GetRecommendation + +`func (o *ReviewDecision) GetRecommendation() ReviewRecommendation` + +GetRecommendation returns the Recommendation field if non-nil, zero value otherwise. + +### GetRecommendationOk + +`func (o *ReviewDecision) GetRecommendationOk() (*ReviewRecommendation, bool)` + +GetRecommendationOk returns a tuple with the Recommendation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendation + +`func (o *ReviewDecision) SetRecommendation(v ReviewRecommendation)` + +SetRecommendation sets Recommendation field to given value. + +### HasRecommendation + +`func (o *ReviewDecision) HasRecommendation() bool` + +HasRecommendation returns a boolean if a field has been set. + +### GetComments + +`func (o *ReviewDecision) GetComments() string` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *ReviewDecision) GetCommentsOk() (*string, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *ReviewDecision) SetComments(v string)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *ReviewDecision) HasComments() bool` + +HasComments returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReviewReassign.md b/docs/tools/sdk/go/Reference/V2024/Models/ReviewReassign.md new file mode 100644 index 000000000..138ab1745 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReviewReassign.md @@ -0,0 +1,101 @@ +--- +id: v2024-review-reassign +title: ReviewReassign +pagination_label: ReviewReassign +sidebar_label: ReviewReassign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewReassign', 'V2024ReviewReassign'] +slug: /tools/sdk/go/v2024/models/review-reassign +tags: ['SDK', 'Software Development Kit', 'ReviewReassign', 'V2024ReviewReassign'] +--- + +# ReviewReassign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Reassign** | [**[]ReassignReference**](reassign-reference) | | +**ReassignTo** | **string** | The ID of the identity to which the certification is reassigned | +**Reason** | **string** | The reason comment for why the reassign was made | + +## Methods + +### NewReviewReassign + +`func NewReviewReassign(reassign []ReassignReference, reassignTo string, reason string, ) *ReviewReassign` + +NewReviewReassign instantiates a new ReviewReassign 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 + +### NewReviewReassignWithDefaults + +`func NewReviewReassignWithDefaults() *ReviewReassign` + +NewReviewReassignWithDefaults instantiates a new ReviewReassign 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 + +### GetReassign + +`func (o *ReviewReassign) GetReassign() []ReassignReference` + +GetReassign returns the Reassign field if non-nil, zero value otherwise. + +### GetReassignOk + +`func (o *ReviewReassign) GetReassignOk() (*[]ReassignReference, bool)` + +GetReassignOk returns a tuple with the Reassign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassign + +`func (o *ReviewReassign) SetReassign(v []ReassignReference)` + +SetReassign sets Reassign field to given value. + + +### GetReassignTo + +`func (o *ReviewReassign) GetReassignTo() string` + +GetReassignTo returns the ReassignTo field if non-nil, zero value otherwise. + +### GetReassignToOk + +`func (o *ReviewReassign) GetReassignToOk() (*string, bool)` + +GetReassignToOk returns a tuple with the ReassignTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignTo + +`func (o *ReviewReassign) SetReassignTo(v string)` + +SetReassignTo sets ReassignTo field to given value. + + +### GetReason + +`func (o *ReviewReassign) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *ReviewReassign) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *ReviewReassign) SetReason(v string)` + +SetReason sets Reason field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReviewRecommendation.md b/docs/tools/sdk/go/Reference/V2024/Models/ReviewRecommendation.md new file mode 100644 index 000000000..e51de0072 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReviewRecommendation.md @@ -0,0 +1,126 @@ +--- +id: v2024-review-recommendation +title: ReviewRecommendation +pagination_label: ReviewRecommendation +sidebar_label: ReviewRecommendation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewRecommendation', 'V2024ReviewRecommendation'] +slug: /tools/sdk/go/v2024/models/review-recommendation +tags: ['SDK', 'Software Development Kit', 'ReviewRecommendation', 'V2024ReviewRecommendation'] +--- + +# ReviewRecommendation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Recommendation** | Pointer to **NullableString** | The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. | [optional] +**Reasons** | Pointer to **[]string** | A list of reasons for the recommendation. | [optional] +**Timestamp** | Pointer to **SailPointTime** | The time at which the recommendation was recorded. | [optional] + +## Methods + +### NewReviewRecommendation + +`func NewReviewRecommendation() *ReviewRecommendation` + +NewReviewRecommendation instantiates a new ReviewRecommendation 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 + +### NewReviewRecommendationWithDefaults + +`func NewReviewRecommendationWithDefaults() *ReviewRecommendation` + +NewReviewRecommendationWithDefaults instantiates a new ReviewRecommendation 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 + +### GetRecommendation + +`func (o *ReviewRecommendation) GetRecommendation() string` + +GetRecommendation returns the Recommendation field if non-nil, zero value otherwise. + +### GetRecommendationOk + +`func (o *ReviewRecommendation) GetRecommendationOk() (*string, bool)` + +GetRecommendationOk returns a tuple with the Recommendation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendation + +`func (o *ReviewRecommendation) SetRecommendation(v string)` + +SetRecommendation sets Recommendation field to given value. + +### HasRecommendation + +`func (o *ReviewRecommendation) HasRecommendation() bool` + +HasRecommendation returns a boolean if a field has been set. + +### SetRecommendationNil + +`func (o *ReviewRecommendation) SetRecommendationNil(b bool)` + + SetRecommendationNil sets the value for Recommendation to be an explicit nil + +### UnsetRecommendation +`func (o *ReviewRecommendation) UnsetRecommendation()` + +UnsetRecommendation ensures that no value is present for Recommendation, not even an explicit nil +### GetReasons + +`func (o *ReviewRecommendation) GetReasons() []string` + +GetReasons returns the Reasons field if non-nil, zero value otherwise. + +### GetReasonsOk + +`func (o *ReviewRecommendation) GetReasonsOk() (*[]string, bool)` + +GetReasonsOk returns a tuple with the Reasons field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReasons + +`func (o *ReviewRecommendation) SetReasons(v []string)` + +SetReasons sets Reasons field to given value. + +### HasReasons + +`func (o *ReviewRecommendation) HasReasons() bool` + +HasReasons returns a boolean if a field has been set. + +### GetTimestamp + +`func (o *ReviewRecommendation) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *ReviewRecommendation) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *ReviewRecommendation) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *ReviewRecommendation) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReviewableAccessProfile.md b/docs/tools/sdk/go/Reference/V2024/Models/ReviewableAccessProfile.md new file mode 100644 index 000000000..cc6fc90d0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReviewableAccessProfile.md @@ -0,0 +1,318 @@ +--- +id: v2024-reviewable-access-profile +title: ReviewableAccessProfile +pagination_label: ReviewableAccessProfile +sidebar_label: ReviewableAccessProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewableAccessProfile', 'V2024ReviewableAccessProfile'] +slug: /tools/sdk/go/v2024/models/reviewable-access-profile +tags: ['SDK', 'Software Development Kit', 'ReviewableAccessProfile', 'V2024ReviewableAccessProfile'] +--- + +# ReviewableAccessProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the Access Profile | [optional] +**Name** | Pointer to **string** | Name of the Access Profile | [optional] +**Description** | Pointer to **string** | Information about the Access Profile | [optional] +**Privileged** | Pointer to **bool** | Indicates if the entitlement is a privileged entitlement | [optional] +**CloudGoverned** | Pointer to **bool** | True if the entitlement is cloud governed | [optional] +**EndDate** | Pointer to **NullableTime** | The date at which a user's access expires | [optional] +**Owner** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**Entitlements** | Pointer to [**[]ReviewableEntitlement**](reviewable-entitlement) | A list of entitlements associated with this Access Profile | [optional] +**Created** | Pointer to **SailPointTime** | Date the Access Profile was created. | [optional] +**Modified** | Pointer to **SailPointTime** | Date the Access Profile was last modified. | [optional] + +## Methods + +### NewReviewableAccessProfile + +`func NewReviewableAccessProfile() *ReviewableAccessProfile` + +NewReviewableAccessProfile instantiates a new ReviewableAccessProfile 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 + +### NewReviewableAccessProfileWithDefaults + +`func NewReviewableAccessProfileWithDefaults() *ReviewableAccessProfile` + +NewReviewableAccessProfileWithDefaults instantiates a new ReviewableAccessProfile 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 + +### GetId + +`func (o *ReviewableAccessProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewableAccessProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewableAccessProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReviewableAccessProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ReviewableAccessProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ReviewableAccessProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ReviewableAccessProfile) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ReviewableAccessProfile) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ReviewableAccessProfile) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ReviewableAccessProfile) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ReviewableAccessProfile) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ReviewableAccessProfile) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *ReviewableAccessProfile) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *ReviewableAccessProfile) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *ReviewableAccessProfile) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *ReviewableAccessProfile) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetCloudGoverned + +`func (o *ReviewableAccessProfile) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *ReviewableAccessProfile) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *ReviewableAccessProfile) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + +### HasCloudGoverned + +`func (o *ReviewableAccessProfile) HasCloudGoverned() bool` + +HasCloudGoverned returns a boolean if a field has been set. + +### GetEndDate + +`func (o *ReviewableAccessProfile) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *ReviewableAccessProfile) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *ReviewableAccessProfile) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *ReviewableAccessProfile) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### SetEndDateNil + +`func (o *ReviewableAccessProfile) SetEndDateNil(b bool)` + + SetEndDateNil sets the value for EndDate to be an explicit nil + +### UnsetEndDate +`func (o *ReviewableAccessProfile) UnsetEndDate()` + +UnsetEndDate ensures that no value is present for EndDate, not even an explicit nil +### GetOwner + +`func (o *ReviewableAccessProfile) GetOwner() IdentityReferenceWithNameAndEmail` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *ReviewableAccessProfile) GetOwnerOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *ReviewableAccessProfile) SetOwner(v IdentityReferenceWithNameAndEmail)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *ReviewableAccessProfile) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *ReviewableAccessProfile) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *ReviewableAccessProfile) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetEntitlements + +`func (o *ReviewableAccessProfile) GetEntitlements() []ReviewableEntitlement` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *ReviewableAccessProfile) GetEntitlementsOk() (*[]ReviewableEntitlement, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *ReviewableAccessProfile) SetEntitlements(v []ReviewableEntitlement)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *ReviewableAccessProfile) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetCreated + +`func (o *ReviewableAccessProfile) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ReviewableAccessProfile) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ReviewableAccessProfile) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ReviewableAccessProfile) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *ReviewableAccessProfile) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ReviewableAccessProfile) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ReviewableAccessProfile) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ReviewableAccessProfile) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReviewableEntitlement.md b/docs/tools/sdk/go/Reference/V2024/Models/ReviewableEntitlement.md new file mode 100644 index 000000000..99fb2e73b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReviewableEntitlement.md @@ -0,0 +1,546 @@ +--- +id: v2024-reviewable-entitlement +title: ReviewableEntitlement +pagination_label: ReviewableEntitlement +sidebar_label: ReviewableEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewableEntitlement', 'V2024ReviewableEntitlement'] +slug: /tools/sdk/go/v2024/models/reviewable-entitlement +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlement', 'V2024ReviewableEntitlement'] +--- + +# ReviewableEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id for the entitlement | [optional] +**Name** | Pointer to **string** | The name of the entitlement | [optional] +**Description** | Pointer to **NullableString** | Information about the entitlement | [optional] +**Privileged** | Pointer to **bool** | Indicates if the entitlement is a privileged entitlement | [optional] [default to false] +**Owner** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**AttributeName** | Pointer to **string** | The name of the attribute on the source | [optional] +**AttributeValue** | Pointer to **string** | The value of the attribute on the source | [optional] +**SourceSchemaObjectType** | Pointer to **string** | The schema object type on the source used to represent the entitlement and its attributes | [optional] +**SourceName** | Pointer to **string** | The name of the source for which this entitlement belongs | [optional] +**SourceType** | Pointer to **string** | The type of the source for which the entitlement belongs | [optional] +**SourceId** | Pointer to **string** | The ID of the source for which the entitlement belongs | [optional] +**HasPermissions** | Pointer to **bool** | Indicates if the entitlement has permissions | [optional] [default to false] +**IsPermission** | Pointer to **bool** | Indicates if the entitlement is a representation of an account permission | [optional] [default to false] +**Revocable** | Pointer to **bool** | Indicates whether the entitlement can be revoked | [optional] [default to false] +**CloudGoverned** | Pointer to **bool** | True if the entitlement is cloud governed | [optional] [default to false] +**ContainsDataAccess** | Pointer to **bool** | True if the entitlement has DAS data | [optional] [default to false] +**DataAccess** | Pointer to [**NullableDataAccess**](data-access) | | [optional] +**Account** | Pointer to [**NullableReviewableEntitlementAccount**](reviewable-entitlement-account) | | [optional] + +## Methods + +### NewReviewableEntitlement + +`func NewReviewableEntitlement() *ReviewableEntitlement` + +NewReviewableEntitlement instantiates a new ReviewableEntitlement 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 + +### NewReviewableEntitlementWithDefaults + +`func NewReviewableEntitlementWithDefaults() *ReviewableEntitlement` + +NewReviewableEntitlementWithDefaults instantiates a new ReviewableEntitlement 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 + +### GetId + +`func (o *ReviewableEntitlement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewableEntitlement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewableEntitlement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReviewableEntitlement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ReviewableEntitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ReviewableEntitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ReviewableEntitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ReviewableEntitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ReviewableEntitlement) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ReviewableEntitlement) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ReviewableEntitlement) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ReviewableEntitlement) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ReviewableEntitlement) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ReviewableEntitlement) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetPrivileged + +`func (o *ReviewableEntitlement) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *ReviewableEntitlement) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *ReviewableEntitlement) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *ReviewableEntitlement) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetOwner + +`func (o *ReviewableEntitlement) GetOwner() IdentityReferenceWithNameAndEmail` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *ReviewableEntitlement) GetOwnerOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *ReviewableEntitlement) SetOwner(v IdentityReferenceWithNameAndEmail)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *ReviewableEntitlement) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *ReviewableEntitlement) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *ReviewableEntitlement) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetAttributeName + +`func (o *ReviewableEntitlement) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *ReviewableEntitlement) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *ReviewableEntitlement) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *ReviewableEntitlement) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + +### GetAttributeValue + +`func (o *ReviewableEntitlement) GetAttributeValue() string` + +GetAttributeValue returns the AttributeValue field if non-nil, zero value otherwise. + +### GetAttributeValueOk + +`func (o *ReviewableEntitlement) GetAttributeValueOk() (*string, bool)` + +GetAttributeValueOk returns a tuple with the AttributeValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeValue + +`func (o *ReviewableEntitlement) SetAttributeValue(v string)` + +SetAttributeValue sets AttributeValue field to given value. + +### HasAttributeValue + +`func (o *ReviewableEntitlement) HasAttributeValue() bool` + +HasAttributeValue returns a boolean if a field has been set. + +### GetSourceSchemaObjectType + +`func (o *ReviewableEntitlement) GetSourceSchemaObjectType() string` + +GetSourceSchemaObjectType returns the SourceSchemaObjectType field if non-nil, zero value otherwise. + +### GetSourceSchemaObjectTypeOk + +`func (o *ReviewableEntitlement) GetSourceSchemaObjectTypeOk() (*string, bool)` + +GetSourceSchemaObjectTypeOk returns a tuple with the SourceSchemaObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceSchemaObjectType + +`func (o *ReviewableEntitlement) SetSourceSchemaObjectType(v string)` + +SetSourceSchemaObjectType sets SourceSchemaObjectType field to given value. + +### HasSourceSchemaObjectType + +`func (o *ReviewableEntitlement) HasSourceSchemaObjectType() bool` + +HasSourceSchemaObjectType returns a boolean if a field has been set. + +### GetSourceName + +`func (o *ReviewableEntitlement) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *ReviewableEntitlement) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *ReviewableEntitlement) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *ReviewableEntitlement) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceType + +`func (o *ReviewableEntitlement) GetSourceType() string` + +GetSourceType returns the SourceType field if non-nil, zero value otherwise. + +### GetSourceTypeOk + +`func (o *ReviewableEntitlement) GetSourceTypeOk() (*string, bool)` + +GetSourceTypeOk returns a tuple with the SourceType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceType + +`func (o *ReviewableEntitlement) SetSourceType(v string)` + +SetSourceType sets SourceType field to given value. + +### HasSourceType + +`func (o *ReviewableEntitlement) HasSourceType() bool` + +HasSourceType returns a boolean if a field has been set. + +### GetSourceId + +`func (o *ReviewableEntitlement) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *ReviewableEntitlement) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *ReviewableEntitlement) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *ReviewableEntitlement) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetHasPermissions + +`func (o *ReviewableEntitlement) GetHasPermissions() bool` + +GetHasPermissions returns the HasPermissions field if non-nil, zero value otherwise. + +### GetHasPermissionsOk + +`func (o *ReviewableEntitlement) GetHasPermissionsOk() (*bool, bool)` + +GetHasPermissionsOk returns a tuple with the HasPermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasPermissions + +`func (o *ReviewableEntitlement) SetHasPermissions(v bool)` + +SetHasPermissions sets HasPermissions field to given value. + +### HasHasPermissions + +`func (o *ReviewableEntitlement) HasHasPermissions() bool` + +HasHasPermissions returns a boolean if a field has been set. + +### GetIsPermission + +`func (o *ReviewableEntitlement) GetIsPermission() bool` + +GetIsPermission returns the IsPermission field if non-nil, zero value otherwise. + +### GetIsPermissionOk + +`func (o *ReviewableEntitlement) GetIsPermissionOk() (*bool, bool)` + +GetIsPermissionOk returns a tuple with the IsPermission field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsPermission + +`func (o *ReviewableEntitlement) SetIsPermission(v bool)` + +SetIsPermission sets IsPermission field to given value. + +### HasIsPermission + +`func (o *ReviewableEntitlement) HasIsPermission() bool` + +HasIsPermission returns a boolean if a field has been set. + +### GetRevocable + +`func (o *ReviewableEntitlement) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *ReviewableEntitlement) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *ReviewableEntitlement) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *ReviewableEntitlement) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + +### GetCloudGoverned + +`func (o *ReviewableEntitlement) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *ReviewableEntitlement) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *ReviewableEntitlement) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + +### HasCloudGoverned + +`func (o *ReviewableEntitlement) HasCloudGoverned() bool` + +HasCloudGoverned returns a boolean if a field has been set. + +### GetContainsDataAccess + +`func (o *ReviewableEntitlement) GetContainsDataAccess() bool` + +GetContainsDataAccess returns the ContainsDataAccess field if non-nil, zero value otherwise. + +### GetContainsDataAccessOk + +`func (o *ReviewableEntitlement) GetContainsDataAccessOk() (*bool, bool)` + +GetContainsDataAccessOk returns a tuple with the ContainsDataAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainsDataAccess + +`func (o *ReviewableEntitlement) SetContainsDataAccess(v bool)` + +SetContainsDataAccess sets ContainsDataAccess field to given value. + +### HasContainsDataAccess + +`func (o *ReviewableEntitlement) HasContainsDataAccess() bool` + +HasContainsDataAccess returns a boolean if a field has been set. + +### GetDataAccess + +`func (o *ReviewableEntitlement) GetDataAccess() DataAccess` + +GetDataAccess returns the DataAccess field if non-nil, zero value otherwise. + +### GetDataAccessOk + +`func (o *ReviewableEntitlement) GetDataAccessOk() (*DataAccess, bool)` + +GetDataAccessOk returns a tuple with the DataAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataAccess + +`func (o *ReviewableEntitlement) SetDataAccess(v DataAccess)` + +SetDataAccess sets DataAccess field to given value. + +### HasDataAccess + +`func (o *ReviewableEntitlement) HasDataAccess() bool` + +HasDataAccess returns a boolean if a field has been set. + +### SetDataAccessNil + +`func (o *ReviewableEntitlement) SetDataAccessNil(b bool)` + + SetDataAccessNil sets the value for DataAccess to be an explicit nil + +### UnsetDataAccess +`func (o *ReviewableEntitlement) UnsetDataAccess()` + +UnsetDataAccess ensures that no value is present for DataAccess, not even an explicit nil +### GetAccount + +`func (o *ReviewableEntitlement) GetAccount() ReviewableEntitlementAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *ReviewableEntitlement) GetAccountOk() (*ReviewableEntitlementAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *ReviewableEntitlement) SetAccount(v ReviewableEntitlementAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *ReviewableEntitlement) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### SetAccountNil + +`func (o *ReviewableEntitlement) SetAccountNil(b bool)` + + SetAccountNil sets the value for Account to be an explicit nil + +### UnsetAccount +`func (o *ReviewableEntitlement) UnsetAccount()` + +UnsetAccount ensures that no value is present for Account, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReviewableEntitlementAccount.md b/docs/tools/sdk/go/Reference/V2024/Models/ReviewableEntitlementAccount.md new file mode 100644 index 000000000..a0214a2c6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReviewableEntitlementAccount.md @@ -0,0 +1,420 @@ +--- +id: v2024-reviewable-entitlement-account +title: ReviewableEntitlementAccount +pagination_label: ReviewableEntitlementAccount +sidebar_label: ReviewableEntitlementAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewableEntitlementAccount', 'V2024ReviewableEntitlementAccount'] +slug: /tools/sdk/go/v2024/models/reviewable-entitlement-account +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlementAccount', 'V2024ReviewableEntitlementAccount'] +--- + +# ReviewableEntitlementAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NativeIdentity** | Pointer to **string** | The native identity for this account | [optional] +**Disabled** | Pointer to **bool** | Indicates whether this account is currently disabled | [optional] [default to false] +**Locked** | Pointer to **bool** | Indicates whether this account is currently locked | [optional] [default to false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **NullableString** | The id associated with the account | [optional] +**Name** | Pointer to **NullableString** | The account name | [optional] +**Created** | Pointer to **NullableTime** | When the account was created | [optional] +**Modified** | Pointer to **NullableTime** | When the account was last modified | [optional] +**ActivityInsights** | Pointer to [**ActivityInsights**](activity-insights) | | [optional] +**Description** | Pointer to **NullableString** | Information about the account | [optional] +**GovernanceGroupId** | Pointer to **NullableString** | The id associated with the machine Account Governance Group | [optional] +**Owner** | Pointer to [**NullableReviewableEntitlementAccountOwner**](reviewable-entitlement-account-owner) | | [optional] + +## Methods + +### NewReviewableEntitlementAccount + +`func NewReviewableEntitlementAccount() *ReviewableEntitlementAccount` + +NewReviewableEntitlementAccount instantiates a new ReviewableEntitlementAccount 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 + +### NewReviewableEntitlementAccountWithDefaults + +`func NewReviewableEntitlementAccountWithDefaults() *ReviewableEntitlementAccount` + +NewReviewableEntitlementAccountWithDefaults instantiates a new ReviewableEntitlementAccount 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 + +### GetNativeIdentity + +`func (o *ReviewableEntitlementAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *ReviewableEntitlementAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *ReviewableEntitlementAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *ReviewableEntitlementAccount) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetDisabled + +`func (o *ReviewableEntitlementAccount) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *ReviewableEntitlementAccount) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *ReviewableEntitlementAccount) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *ReviewableEntitlementAccount) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetLocked + +`func (o *ReviewableEntitlementAccount) GetLocked() bool` + +GetLocked returns the Locked field if non-nil, zero value otherwise. + +### GetLockedOk + +`func (o *ReviewableEntitlementAccount) GetLockedOk() (*bool, bool)` + +GetLockedOk returns a tuple with the Locked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocked + +`func (o *ReviewableEntitlementAccount) SetLocked(v bool)` + +SetLocked sets Locked field to given value. + +### HasLocked + +`func (o *ReviewableEntitlementAccount) HasLocked() bool` + +HasLocked returns a boolean if a field has been set. + +### GetType + +`func (o *ReviewableEntitlementAccount) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReviewableEntitlementAccount) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReviewableEntitlementAccount) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ReviewableEntitlementAccount) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ReviewableEntitlementAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewableEntitlementAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewableEntitlementAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReviewableEntitlementAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *ReviewableEntitlementAccount) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *ReviewableEntitlementAccount) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *ReviewableEntitlementAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ReviewableEntitlementAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ReviewableEntitlementAccount) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ReviewableEntitlementAccount) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ReviewableEntitlementAccount) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ReviewableEntitlementAccount) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *ReviewableEntitlementAccount) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ReviewableEntitlementAccount) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ReviewableEntitlementAccount) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ReviewableEntitlementAccount) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *ReviewableEntitlementAccount) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *ReviewableEntitlementAccount) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *ReviewableEntitlementAccount) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ReviewableEntitlementAccount) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ReviewableEntitlementAccount) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ReviewableEntitlementAccount) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *ReviewableEntitlementAccount) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *ReviewableEntitlementAccount) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetActivityInsights + +`func (o *ReviewableEntitlementAccount) GetActivityInsights() ActivityInsights` + +GetActivityInsights returns the ActivityInsights field if non-nil, zero value otherwise. + +### GetActivityInsightsOk + +`func (o *ReviewableEntitlementAccount) GetActivityInsightsOk() (*ActivityInsights, bool)` + +GetActivityInsightsOk returns a tuple with the ActivityInsights field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActivityInsights + +`func (o *ReviewableEntitlementAccount) SetActivityInsights(v ActivityInsights)` + +SetActivityInsights sets ActivityInsights field to given value. + +### HasActivityInsights + +`func (o *ReviewableEntitlementAccount) HasActivityInsights() bool` + +HasActivityInsights returns a boolean if a field has been set. + +### GetDescription + +`func (o *ReviewableEntitlementAccount) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ReviewableEntitlementAccount) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ReviewableEntitlementAccount) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ReviewableEntitlementAccount) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ReviewableEntitlementAccount) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ReviewableEntitlementAccount) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetGovernanceGroupId + +`func (o *ReviewableEntitlementAccount) GetGovernanceGroupId() string` + +GetGovernanceGroupId returns the GovernanceGroupId field if non-nil, zero value otherwise. + +### GetGovernanceGroupIdOk + +`func (o *ReviewableEntitlementAccount) GetGovernanceGroupIdOk() (*string, bool)` + +GetGovernanceGroupIdOk returns a tuple with the GovernanceGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceGroupId + +`func (o *ReviewableEntitlementAccount) SetGovernanceGroupId(v string)` + +SetGovernanceGroupId sets GovernanceGroupId field to given value. + +### HasGovernanceGroupId + +`func (o *ReviewableEntitlementAccount) HasGovernanceGroupId() bool` + +HasGovernanceGroupId returns a boolean if a field has been set. + +### SetGovernanceGroupIdNil + +`func (o *ReviewableEntitlementAccount) SetGovernanceGroupIdNil(b bool)` + + SetGovernanceGroupIdNil sets the value for GovernanceGroupId to be an explicit nil + +### UnsetGovernanceGroupId +`func (o *ReviewableEntitlementAccount) UnsetGovernanceGroupId()` + +UnsetGovernanceGroupId ensures that no value is present for GovernanceGroupId, not even an explicit nil +### GetOwner + +`func (o *ReviewableEntitlementAccount) GetOwner() ReviewableEntitlementAccountOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *ReviewableEntitlementAccount) GetOwnerOk() (*ReviewableEntitlementAccountOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *ReviewableEntitlementAccount) SetOwner(v ReviewableEntitlementAccountOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *ReviewableEntitlementAccount) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *ReviewableEntitlementAccount) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *ReviewableEntitlementAccount) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReviewableEntitlementAccountOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/ReviewableEntitlementAccountOwner.md new file mode 100644 index 000000000..0d289b1cb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReviewableEntitlementAccountOwner.md @@ -0,0 +1,136 @@ +--- +id: v2024-reviewable-entitlement-account-owner +title: ReviewableEntitlementAccountOwner +pagination_label: ReviewableEntitlementAccountOwner +sidebar_label: ReviewableEntitlementAccountOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewableEntitlementAccountOwner', 'V2024ReviewableEntitlementAccountOwner'] +slug: /tools/sdk/go/v2024/models/reviewable-entitlement-account-owner +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlementAccountOwner', 'V2024ReviewableEntitlementAccountOwner'] +--- + +# ReviewableEntitlementAccountOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | The id associated with the machine account owner | [optional] +**Type** | Pointer to **string** | An enumeration of the types of Owner supported within the IdentityNow infrastructure. | [optional] +**DisplayName** | Pointer to **NullableString** | The machine account owner's display name | [optional] + +## Methods + +### NewReviewableEntitlementAccountOwner + +`func NewReviewableEntitlementAccountOwner() *ReviewableEntitlementAccountOwner` + +NewReviewableEntitlementAccountOwner instantiates a new ReviewableEntitlementAccountOwner 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 + +### NewReviewableEntitlementAccountOwnerWithDefaults + +`func NewReviewableEntitlementAccountOwnerWithDefaults() *ReviewableEntitlementAccountOwner` + +NewReviewableEntitlementAccountOwnerWithDefaults instantiates a new ReviewableEntitlementAccountOwner 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 + +### GetId + +`func (o *ReviewableEntitlementAccountOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewableEntitlementAccountOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewableEntitlementAccountOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReviewableEntitlementAccountOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *ReviewableEntitlementAccountOwner) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *ReviewableEntitlementAccountOwner) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetType + +`func (o *ReviewableEntitlementAccountOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReviewableEntitlementAccountOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReviewableEntitlementAccountOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ReviewableEntitlementAccountOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *ReviewableEntitlementAccountOwner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *ReviewableEntitlementAccountOwner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *ReviewableEntitlementAccountOwner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *ReviewableEntitlementAccountOwner) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### SetDisplayNameNil + +`func (o *ReviewableEntitlementAccountOwner) SetDisplayNameNil(b bool)` + + SetDisplayNameNil sets the value for DisplayName to be an explicit nil + +### UnsetDisplayName +`func (o *ReviewableEntitlementAccountOwner) UnsetDisplayName()` + +UnsetDisplayName ensures that no value is present for DisplayName, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ReviewableRole.md b/docs/tools/sdk/go/Reference/V2024/Models/ReviewableRole.md new file mode 100644 index 000000000..3ff88fb93 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ReviewableRole.md @@ -0,0 +1,282 @@ +--- +id: v2024-reviewable-role +title: ReviewableRole +pagination_label: ReviewableRole +sidebar_label: ReviewableRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewableRole', 'V2024ReviewableRole'] +slug: /tools/sdk/go/v2024/models/reviewable-role +tags: ['SDK', 'Software Development Kit', 'ReviewableRole', 'V2024ReviewableRole'] +--- + +# ReviewableRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id for the Role | [optional] +**Name** | Pointer to **string** | The name of the Role | [optional] +**Description** | Pointer to **string** | Information about the Role | [optional] +**Privileged** | Pointer to **bool** | Indicates if the entitlement is a privileged entitlement | [optional] +**Owner** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**Revocable** | Pointer to **bool** | Indicates whether the Role can be revoked or requested | [optional] +**EndDate** | Pointer to **SailPointTime** | The date when a user's access expires. | [optional] +**AccessProfiles** | Pointer to [**[]ReviewableAccessProfile**](reviewable-access-profile) | The list of Access Profiles associated with this Role | [optional] +**Entitlements** | Pointer to [**[]ReviewableEntitlement**](reviewable-entitlement) | The list of entitlements associated with this Role | [optional] + +## Methods + +### NewReviewableRole + +`func NewReviewableRole() *ReviewableRole` + +NewReviewableRole instantiates a new ReviewableRole 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 + +### NewReviewableRoleWithDefaults + +`func NewReviewableRoleWithDefaults() *ReviewableRole` + +NewReviewableRoleWithDefaults instantiates a new ReviewableRole 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 + +### GetId + +`func (o *ReviewableRole) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewableRole) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewableRole) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReviewableRole) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ReviewableRole) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ReviewableRole) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ReviewableRole) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ReviewableRole) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ReviewableRole) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ReviewableRole) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ReviewableRole) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ReviewableRole) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *ReviewableRole) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *ReviewableRole) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *ReviewableRole) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *ReviewableRole) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetOwner + +`func (o *ReviewableRole) GetOwner() IdentityReferenceWithNameAndEmail` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *ReviewableRole) GetOwnerOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *ReviewableRole) SetOwner(v IdentityReferenceWithNameAndEmail)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *ReviewableRole) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *ReviewableRole) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *ReviewableRole) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetRevocable + +`func (o *ReviewableRole) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *ReviewableRole) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *ReviewableRole) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *ReviewableRole) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + +### GetEndDate + +`func (o *ReviewableRole) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *ReviewableRole) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *ReviewableRole) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *ReviewableRole) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetAccessProfiles + +`func (o *ReviewableRole) GetAccessProfiles() []ReviewableAccessProfile` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *ReviewableRole) GetAccessProfilesOk() (*[]ReviewableAccessProfile, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *ReviewableRole) SetAccessProfiles(v []ReviewableAccessProfile)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *ReviewableRole) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### GetEntitlements + +`func (o *ReviewableRole) GetEntitlements() []ReviewableEntitlement` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *ReviewableRole) GetEntitlementsOk() (*[]ReviewableEntitlement, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *ReviewableRole) SetEntitlements(v []ReviewableEntitlement)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *ReviewableRole) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Reviewer.md b/docs/tools/sdk/go/Reference/V2024/Models/Reviewer.md new file mode 100644 index 000000000..6ff7c6a7c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Reviewer.md @@ -0,0 +1,214 @@ +--- +id: v2024-reviewer +title: Reviewer +pagination_label: Reviewer +sidebar_label: Reviewer +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Reviewer', 'V2024Reviewer'] +slug: /tools/sdk/go/v2024/models/reviewer +tags: ['SDK', 'Software Development Kit', 'Reviewer', 'V2024Reviewer'] +--- + +# Reviewer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the reviewer. | [optional] +**Name** | Pointer to **string** | The name of the reviewer. | [optional] +**Email** | Pointer to **string** | The email of the reviewing identity. | [optional] +**Type** | Pointer to **string** | The type of the reviewing identity. | [optional] +**Created** | Pointer to **NullableTime** | The created date of the reviewing identity. | [optional] +**Modified** | Pointer to **NullableTime** | The modified date of the reviewing identity. | [optional] + +## Methods + +### NewReviewer + +`func NewReviewer() *Reviewer` + +NewReviewer instantiates a new Reviewer 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 + +### NewReviewerWithDefaults + +`func NewReviewerWithDefaults() *Reviewer` + +NewReviewerWithDefaults instantiates a new Reviewer 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 + +### GetId + +`func (o *Reviewer) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Reviewer) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Reviewer) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Reviewer) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Reviewer) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Reviewer) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Reviewer) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Reviewer) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *Reviewer) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *Reviewer) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *Reviewer) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *Reviewer) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetType + +`func (o *Reviewer) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Reviewer) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Reviewer) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Reviewer) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetCreated + +`func (o *Reviewer) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Reviewer) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Reviewer) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Reviewer) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *Reviewer) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *Reviewer) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *Reviewer) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Reviewer) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Reviewer) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Reviewer) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *Reviewer) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *Reviewer) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Revocability.md b/docs/tools/sdk/go/Reference/V2024/Models/Revocability.md new file mode 100644 index 000000000..4cabce733 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Revocability.md @@ -0,0 +1,74 @@ +--- +id: v2024-revocability +title: Revocability +pagination_label: Revocability +sidebar_label: Revocability +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Revocability', 'V2024Revocability'] +slug: /tools/sdk/go/v2024/models/revocability +tags: ['SDK', 'Software Development Kit', 'Revocability', 'V2024Revocability'] +--- + +# Revocability + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] + +## Methods + +### NewRevocability + +`func NewRevocability() *Revocability` + +NewRevocability instantiates a new Revocability 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 + +### NewRevocabilityWithDefaults + +`func NewRevocabilityWithDefaults() *Revocability` + +NewRevocabilityWithDefaults instantiates a new Revocability 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 + +### GetApprovalSchemes + +`func (o *Revocability) GetApprovalSchemes() []AccessProfileApprovalScheme` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *Revocability) GetApprovalSchemesOk() (*[]AccessProfileApprovalScheme, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *Revocability) SetApprovalSchemes(v []AccessProfileApprovalScheme)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *Revocability) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + +### SetApprovalSchemesNil + +`func (o *Revocability) SetApprovalSchemesNil(b bool)` + + SetApprovalSchemesNil sets the value for ApprovalSchemes to be an explicit nil + +### UnsetApprovalSchemes +`func (o *Revocability) UnsetApprovalSchemes()` + +UnsetApprovalSchemes ensures that no value is present for ApprovalSchemes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RevocabilityForRole.md b/docs/tools/sdk/go/Reference/V2024/Models/RevocabilityForRole.md new file mode 100644 index 000000000..da6074629 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RevocabilityForRole.md @@ -0,0 +1,136 @@ +--- +id: v2024-revocability-for-role +title: RevocabilityForRole +pagination_label: RevocabilityForRole +sidebar_label: RevocabilityForRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RevocabilityForRole', 'V2024RevocabilityForRole'] +slug: /tools/sdk/go/v2024/models/revocability-for-role +tags: ['SDK', 'Software Development Kit', 'RevocabilityForRole', 'V2024RevocabilityForRole'] +--- + +# RevocabilityForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **NullableBool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to false] +**DenialCommentsRequired** | Pointer to **NullableBool** | Whether an approver must provide comments when denying the request | [optional] [default to false] +**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the revocation request | [optional] + +## Methods + +### NewRevocabilityForRole + +`func NewRevocabilityForRole() *RevocabilityForRole` + +NewRevocabilityForRole instantiates a new RevocabilityForRole 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 + +### NewRevocabilityForRoleWithDefaults + +`func NewRevocabilityForRoleWithDefaults() *RevocabilityForRole` + +NewRevocabilityForRoleWithDefaults instantiates a new RevocabilityForRole 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 + +### GetCommentsRequired + +`func (o *RevocabilityForRole) GetCommentsRequired() bool` + +GetCommentsRequired returns the CommentsRequired field if non-nil, zero value otherwise. + +### GetCommentsRequiredOk + +`func (o *RevocabilityForRole) GetCommentsRequiredOk() (*bool, bool)` + +GetCommentsRequiredOk returns a tuple with the CommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentsRequired + +`func (o *RevocabilityForRole) SetCommentsRequired(v bool)` + +SetCommentsRequired sets CommentsRequired field to given value. + +### HasCommentsRequired + +`func (o *RevocabilityForRole) HasCommentsRequired() bool` + +HasCommentsRequired returns a boolean if a field has been set. + +### SetCommentsRequiredNil + +`func (o *RevocabilityForRole) SetCommentsRequiredNil(b bool)` + + SetCommentsRequiredNil sets the value for CommentsRequired to be an explicit nil + +### UnsetCommentsRequired +`func (o *RevocabilityForRole) UnsetCommentsRequired()` + +UnsetCommentsRequired ensures that no value is present for CommentsRequired, not even an explicit nil +### GetDenialCommentsRequired + +`func (o *RevocabilityForRole) GetDenialCommentsRequired() bool` + +GetDenialCommentsRequired returns the DenialCommentsRequired field if non-nil, zero value otherwise. + +### GetDenialCommentsRequiredOk + +`func (o *RevocabilityForRole) GetDenialCommentsRequiredOk() (*bool, bool)` + +GetDenialCommentsRequiredOk returns a tuple with the DenialCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenialCommentsRequired + +`func (o *RevocabilityForRole) SetDenialCommentsRequired(v bool)` + +SetDenialCommentsRequired sets DenialCommentsRequired field to given value. + +### HasDenialCommentsRequired + +`func (o *RevocabilityForRole) HasDenialCommentsRequired() bool` + +HasDenialCommentsRequired returns a boolean if a field has been set. + +### SetDenialCommentsRequiredNil + +`func (o *RevocabilityForRole) SetDenialCommentsRequiredNil(b bool)` + + SetDenialCommentsRequiredNil sets the value for DenialCommentsRequired to be an explicit nil + +### UnsetDenialCommentsRequired +`func (o *RevocabilityForRole) UnsetDenialCommentsRequired()` + +UnsetDenialCommentsRequired ensures that no value is present for DenialCommentsRequired, not even an explicit nil +### GetApprovalSchemes + +`func (o *RevocabilityForRole) GetApprovalSchemes() []ApprovalSchemeForRole` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *RevocabilityForRole) GetApprovalSchemesOk() (*[]ApprovalSchemeForRole, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *RevocabilityForRole) SetApprovalSchemes(v []ApprovalSchemeForRole)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *RevocabilityForRole) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Role.md b/docs/tools/sdk/go/Reference/V2024/Models/Role.md new file mode 100644 index 000000000..7fbc042f2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Role.md @@ -0,0 +1,566 @@ +--- +id: v2024-role +title: Role +pagination_label: Role +sidebar_label: Role +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Role', 'V2024Role'] +slug: /tools/sdk/go/v2024/models/role +tags: ['SDK', 'Software Development Kit', 'Role', 'V2024Role'] +--- + +# Role + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. | [optional] +**Name** | **string** | The human-readable display name of the Role | +**Created** | Pointer to **SailPointTime** | Date the Role was created | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Date the Role was last modified. | [optional] [readonly] +**Description** | Pointer to **NullableString** | A human-readable description of the Role | [optional] +**Owner** | [**OwnerReference**](owner-reference) | | +**AccessProfiles** | Pointer to [**[]AccessProfileRef**](access-profile-ref) | | [optional] +**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | | [optional] +**Membership** | Pointer to [**NullableRoleMembershipSelector**](role-membership-selector) | | [optional] +**LegacyMembershipInfo** | Pointer to **map[string]interface{}** | This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. | [optional] +**Enabled** | Pointer to **bool** | Whether the Role is enabled or not. | [optional] [default to false] +**Requestable** | Pointer to **bool** | Whether the Role can be the target of access requests. | [optional] [default to false] +**AccessRequestConfig** | Pointer to [**RequestabilityForRole**](requestability-for-role) | | [optional] +**RevocationRequestConfig** | Pointer to [**RevocabilityForRole**](revocability-for-role) | | [optional] +**Segments** | Pointer to **[]string** | List of IDs of segments, if any, to which this Role is assigned. | [optional] +**Dimensional** | Pointer to **NullableBool** | Whether the Role is dimensional. | [optional] [default to false] +**DimensionRefs** | Pointer to [**[]DimensionRef**](dimension-ref) | List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. | [optional] +**AccessModelMetadata** | Pointer to [**AttributeDTOList**](attribute-dto-list) | | [optional] + +## Methods + +### NewRole + +`func NewRole(name string, owner OwnerReference, ) *Role` + +NewRole instantiates a new Role 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 + +### NewRoleWithDefaults + +`func NewRoleWithDefaults() *Role` + +NewRoleWithDefaults instantiates a new Role 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 + +### GetId + +`func (o *Role) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Role) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Role) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Role) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Role) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Role) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Role) SetName(v string)` + +SetName sets Name field to given value. + + +### GetCreated + +`func (o *Role) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Role) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Role) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Role) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Role) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Role) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Role) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Role) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *Role) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Role) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Role) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Role) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Role) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Role) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwner + +`func (o *Role) GetOwner() OwnerReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Role) GetOwnerOk() (*OwnerReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Role) SetOwner(v OwnerReference)` + +SetOwner sets Owner field to given value. + + +### GetAccessProfiles + +`func (o *Role) GetAccessProfiles() []AccessProfileRef` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *Role) GetAccessProfilesOk() (*[]AccessProfileRef, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *Role) SetAccessProfiles(v []AccessProfileRef)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *Role) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### SetAccessProfilesNil + +`func (o *Role) SetAccessProfilesNil(b bool)` + + SetAccessProfilesNil sets the value for AccessProfiles to be an explicit nil + +### UnsetAccessProfiles +`func (o *Role) UnsetAccessProfiles()` + +UnsetAccessProfiles ensures that no value is present for AccessProfiles, not even an explicit nil +### GetEntitlements + +`func (o *Role) GetEntitlements() []EntitlementRef` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *Role) GetEntitlementsOk() (*[]EntitlementRef, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *Role) SetEntitlements(v []EntitlementRef)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *Role) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetMembership + +`func (o *Role) GetMembership() RoleMembershipSelector` + +GetMembership returns the Membership field if non-nil, zero value otherwise. + +### GetMembershipOk + +`func (o *Role) GetMembershipOk() (*RoleMembershipSelector, bool)` + +GetMembershipOk returns a tuple with the Membership field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMembership + +`func (o *Role) SetMembership(v RoleMembershipSelector)` + +SetMembership sets Membership field to given value. + +### HasMembership + +`func (o *Role) HasMembership() bool` + +HasMembership returns a boolean if a field has been set. + +### SetMembershipNil + +`func (o *Role) SetMembershipNil(b bool)` + + SetMembershipNil sets the value for Membership to be an explicit nil + +### UnsetMembership +`func (o *Role) UnsetMembership()` + +UnsetMembership ensures that no value is present for Membership, not even an explicit nil +### GetLegacyMembershipInfo + +`func (o *Role) GetLegacyMembershipInfo() map[string]interface{}` + +GetLegacyMembershipInfo returns the LegacyMembershipInfo field if non-nil, zero value otherwise. + +### GetLegacyMembershipInfoOk + +`func (o *Role) GetLegacyMembershipInfoOk() (*map[string]interface{}, bool)` + +GetLegacyMembershipInfoOk returns a tuple with the LegacyMembershipInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyMembershipInfo + +`func (o *Role) SetLegacyMembershipInfo(v map[string]interface{})` + +SetLegacyMembershipInfo sets LegacyMembershipInfo field to given value. + +### HasLegacyMembershipInfo + +`func (o *Role) HasLegacyMembershipInfo() bool` + +HasLegacyMembershipInfo returns a boolean if a field has been set. + +### SetLegacyMembershipInfoNil + +`func (o *Role) SetLegacyMembershipInfoNil(b bool)` + + SetLegacyMembershipInfoNil sets the value for LegacyMembershipInfo to be an explicit nil + +### UnsetLegacyMembershipInfo +`func (o *Role) UnsetLegacyMembershipInfo()` + +UnsetLegacyMembershipInfo ensures that no value is present for LegacyMembershipInfo, not even an explicit nil +### GetEnabled + +`func (o *Role) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *Role) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *Role) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *Role) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetRequestable + +`func (o *Role) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *Role) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *Role) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *Role) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetAccessRequestConfig + +`func (o *Role) GetAccessRequestConfig() RequestabilityForRole` + +GetAccessRequestConfig returns the AccessRequestConfig field if non-nil, zero value otherwise. + +### GetAccessRequestConfigOk + +`func (o *Role) GetAccessRequestConfigOk() (*RequestabilityForRole, bool)` + +GetAccessRequestConfigOk returns a tuple with the AccessRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestConfig + +`func (o *Role) SetAccessRequestConfig(v RequestabilityForRole)` + +SetAccessRequestConfig sets AccessRequestConfig field to given value. + +### HasAccessRequestConfig + +`func (o *Role) HasAccessRequestConfig() bool` + +HasAccessRequestConfig returns a boolean if a field has been set. + +### GetRevocationRequestConfig + +`func (o *Role) GetRevocationRequestConfig() RevocabilityForRole` + +GetRevocationRequestConfig returns the RevocationRequestConfig field if non-nil, zero value otherwise. + +### GetRevocationRequestConfigOk + +`func (o *Role) GetRevocationRequestConfigOk() (*RevocabilityForRole, bool)` + +GetRevocationRequestConfigOk returns a tuple with the RevocationRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocationRequestConfig + +`func (o *Role) SetRevocationRequestConfig(v RevocabilityForRole)` + +SetRevocationRequestConfig sets RevocationRequestConfig field to given value. + +### HasRevocationRequestConfig + +`func (o *Role) HasRevocationRequestConfig() bool` + +HasRevocationRequestConfig returns a boolean if a field has been set. + +### GetSegments + +`func (o *Role) GetSegments() []string` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *Role) GetSegmentsOk() (*[]string, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *Role) SetSegments(v []string)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *Role) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### SetSegmentsNil + +`func (o *Role) SetSegmentsNil(b bool)` + + SetSegmentsNil sets the value for Segments to be an explicit nil + +### UnsetSegments +`func (o *Role) UnsetSegments()` + +UnsetSegments ensures that no value is present for Segments, not even an explicit nil +### GetDimensional + +`func (o *Role) GetDimensional() bool` + +GetDimensional returns the Dimensional field if non-nil, zero value otherwise. + +### GetDimensionalOk + +`func (o *Role) GetDimensionalOk() (*bool, bool)` + +GetDimensionalOk returns a tuple with the Dimensional field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensional + +`func (o *Role) SetDimensional(v bool)` + +SetDimensional sets Dimensional field to given value. + +### HasDimensional + +`func (o *Role) HasDimensional() bool` + +HasDimensional returns a boolean if a field has been set. + +### SetDimensionalNil + +`func (o *Role) SetDimensionalNil(b bool)` + + SetDimensionalNil sets the value for Dimensional to be an explicit nil + +### UnsetDimensional +`func (o *Role) UnsetDimensional()` + +UnsetDimensional ensures that no value is present for Dimensional, not even an explicit nil +### GetDimensionRefs + +`func (o *Role) GetDimensionRefs() []DimensionRef` + +GetDimensionRefs returns the DimensionRefs field if non-nil, zero value otherwise. + +### GetDimensionRefsOk + +`func (o *Role) GetDimensionRefsOk() (*[]DimensionRef, bool)` + +GetDimensionRefsOk returns a tuple with the DimensionRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensionRefs + +`func (o *Role) SetDimensionRefs(v []DimensionRef)` + +SetDimensionRefs sets DimensionRefs field to given value. + +### HasDimensionRefs + +`func (o *Role) HasDimensionRefs() bool` + +HasDimensionRefs returns a boolean if a field has been set. + +### SetDimensionRefsNil + +`func (o *Role) SetDimensionRefsNil(b bool)` + + SetDimensionRefsNil sets the value for DimensionRefs to be an explicit nil + +### UnsetDimensionRefs +`func (o *Role) UnsetDimensionRefs()` + +UnsetDimensionRefs ensures that no value is present for DimensionRefs, not even an explicit nil +### GetAccessModelMetadata + +`func (o *Role) GetAccessModelMetadata() AttributeDTOList` + +GetAccessModelMetadata returns the AccessModelMetadata field if non-nil, zero value otherwise. + +### GetAccessModelMetadataOk + +`func (o *Role) GetAccessModelMetadataOk() (*AttributeDTOList, bool)` + +GetAccessModelMetadataOk returns a tuple with the AccessModelMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessModelMetadata + +`func (o *Role) SetAccessModelMetadata(v AttributeDTOList)` + +SetAccessModelMetadata sets AccessModelMetadata field to given value. + +### HasAccessModelMetadata + +`func (o *Role) HasAccessModelMetadata() bool` + +HasAccessModelMetadata returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleAssignmentDto.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleAssignmentDto.md new file mode 100644 index 000000000..c61dfe4b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleAssignmentDto.md @@ -0,0 +1,292 @@ +--- +id: v2024-role-assignment-dto +title: RoleAssignmentDto +pagination_label: RoleAssignmentDto +sidebar_label: RoleAssignmentDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleAssignmentDto', 'V2024RoleAssignmentDto'] +slug: /tools/sdk/go/v2024/models/role-assignment-dto +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentDto', 'V2024RoleAssignmentDto'] +--- + +# RoleAssignmentDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Assignment Id | [optional] +**Role** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] +**Comments** | Pointer to **NullableString** | Comments added by the user when the assignment was made | [optional] +**AssignmentSource** | Pointer to **string** | Source describing how this assignment was made | [optional] +**Assigner** | Pointer to [**RoleAssignmentDtoAssigner**](role-assignment-dto-assigner) | | [optional] +**AssignedDimensions** | Pointer to [**[]BaseReferenceDto**](base-reference-dto) | Dimensions assigned related to this role | [optional] +**AssignmentContext** | Pointer to [**RoleAssignmentDtoAssignmentContext**](role-assignment-dto-assignment-context) | | [optional] +**AccountTargets** | Pointer to [**[]RoleTargetDto**](role-target-dto) | | [optional] +**RemoveDate** | Pointer to **NullableString** | Date that the assignment will be removed | [optional] + +## Methods + +### NewRoleAssignmentDto + +`func NewRoleAssignmentDto() *RoleAssignmentDto` + +NewRoleAssignmentDto instantiates a new RoleAssignmentDto 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 + +### NewRoleAssignmentDtoWithDefaults + +`func NewRoleAssignmentDtoWithDefaults() *RoleAssignmentDto` + +NewRoleAssignmentDtoWithDefaults instantiates a new RoleAssignmentDto 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 + +### GetId + +`func (o *RoleAssignmentDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleAssignmentDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleAssignmentDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleAssignmentDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRole + +`func (o *RoleAssignmentDto) GetRole() BaseReferenceDto` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *RoleAssignmentDto) GetRoleOk() (*BaseReferenceDto, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *RoleAssignmentDto) SetRole(v BaseReferenceDto)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *RoleAssignmentDto) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetComments + +`func (o *RoleAssignmentDto) GetComments() string` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *RoleAssignmentDto) GetCommentsOk() (*string, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *RoleAssignmentDto) SetComments(v string)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *RoleAssignmentDto) HasComments() bool` + +HasComments returns a boolean if a field has been set. + +### SetCommentsNil + +`func (o *RoleAssignmentDto) SetCommentsNil(b bool)` + + SetCommentsNil sets the value for Comments to be an explicit nil + +### UnsetComments +`func (o *RoleAssignmentDto) UnsetComments()` + +UnsetComments ensures that no value is present for Comments, not even an explicit nil +### GetAssignmentSource + +`func (o *RoleAssignmentDto) GetAssignmentSource() string` + +GetAssignmentSource returns the AssignmentSource field if non-nil, zero value otherwise. + +### GetAssignmentSourceOk + +`func (o *RoleAssignmentDto) GetAssignmentSourceOk() (*string, bool)` + +GetAssignmentSourceOk returns a tuple with the AssignmentSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentSource + +`func (o *RoleAssignmentDto) SetAssignmentSource(v string)` + +SetAssignmentSource sets AssignmentSource field to given value. + +### HasAssignmentSource + +`func (o *RoleAssignmentDto) HasAssignmentSource() bool` + +HasAssignmentSource returns a boolean if a field has been set. + +### GetAssigner + +`func (o *RoleAssignmentDto) GetAssigner() RoleAssignmentDtoAssigner` + +GetAssigner returns the Assigner field if non-nil, zero value otherwise. + +### GetAssignerOk + +`func (o *RoleAssignmentDto) GetAssignerOk() (*RoleAssignmentDtoAssigner, bool)` + +GetAssignerOk returns a tuple with the Assigner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssigner + +`func (o *RoleAssignmentDto) SetAssigner(v RoleAssignmentDtoAssigner)` + +SetAssigner sets Assigner field to given value. + +### HasAssigner + +`func (o *RoleAssignmentDto) HasAssigner() bool` + +HasAssigner returns a boolean if a field has been set. + +### GetAssignedDimensions + +`func (o *RoleAssignmentDto) GetAssignedDimensions() []BaseReferenceDto` + +GetAssignedDimensions returns the AssignedDimensions field if non-nil, zero value otherwise. + +### GetAssignedDimensionsOk + +`func (o *RoleAssignmentDto) GetAssignedDimensionsOk() (*[]BaseReferenceDto, bool)` + +GetAssignedDimensionsOk returns a tuple with the AssignedDimensions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignedDimensions + +`func (o *RoleAssignmentDto) SetAssignedDimensions(v []BaseReferenceDto)` + +SetAssignedDimensions sets AssignedDimensions field to given value. + +### HasAssignedDimensions + +`func (o *RoleAssignmentDto) HasAssignedDimensions() bool` + +HasAssignedDimensions returns a boolean if a field has been set. + +### GetAssignmentContext + +`func (o *RoleAssignmentDto) GetAssignmentContext() RoleAssignmentDtoAssignmentContext` + +GetAssignmentContext returns the AssignmentContext field if non-nil, zero value otherwise. + +### GetAssignmentContextOk + +`func (o *RoleAssignmentDto) GetAssignmentContextOk() (*RoleAssignmentDtoAssignmentContext, bool)` + +GetAssignmentContextOk returns a tuple with the AssignmentContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentContext + +`func (o *RoleAssignmentDto) SetAssignmentContext(v RoleAssignmentDtoAssignmentContext)` + +SetAssignmentContext sets AssignmentContext field to given value. + +### HasAssignmentContext + +`func (o *RoleAssignmentDto) HasAssignmentContext() bool` + +HasAssignmentContext returns a boolean if a field has been set. + +### GetAccountTargets + +`func (o *RoleAssignmentDto) GetAccountTargets() []RoleTargetDto` + +GetAccountTargets returns the AccountTargets field if non-nil, zero value otherwise. + +### GetAccountTargetsOk + +`func (o *RoleAssignmentDto) GetAccountTargetsOk() (*[]RoleTargetDto, bool)` + +GetAccountTargetsOk returns a tuple with the AccountTargets field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountTargets + +`func (o *RoleAssignmentDto) SetAccountTargets(v []RoleTargetDto)` + +SetAccountTargets sets AccountTargets field to given value. + +### HasAccountTargets + +`func (o *RoleAssignmentDto) HasAccountTargets() bool` + +HasAccountTargets returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *RoleAssignmentDto) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *RoleAssignmentDto) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *RoleAssignmentDto) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *RoleAssignmentDto) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *RoleAssignmentDto) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *RoleAssignmentDto) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleAssignmentDtoAssigner.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleAssignmentDtoAssigner.md new file mode 100644 index 000000000..6326078cd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleAssignmentDtoAssigner.md @@ -0,0 +1,126 @@ +--- +id: v2024-role-assignment-dto-assigner +title: RoleAssignmentDtoAssigner +pagination_label: RoleAssignmentDtoAssigner +sidebar_label: RoleAssignmentDtoAssigner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleAssignmentDtoAssigner', 'V2024RoleAssignmentDtoAssigner'] +slug: /tools/sdk/go/v2024/models/role-assignment-dto-assigner +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentDtoAssigner', 'V2024RoleAssignmentDtoAssigner'] +--- + +# RoleAssignmentDtoAssigner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Object type | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewRoleAssignmentDtoAssigner + +`func NewRoleAssignmentDtoAssigner() *RoleAssignmentDtoAssigner` + +NewRoleAssignmentDtoAssigner instantiates a new RoleAssignmentDtoAssigner 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 + +### NewRoleAssignmentDtoAssignerWithDefaults + +`func NewRoleAssignmentDtoAssignerWithDefaults() *RoleAssignmentDtoAssigner` + +NewRoleAssignmentDtoAssignerWithDefaults instantiates a new RoleAssignmentDtoAssigner 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 + +### GetType + +`func (o *RoleAssignmentDtoAssigner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleAssignmentDtoAssigner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleAssignmentDtoAssigner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleAssignmentDtoAssigner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RoleAssignmentDtoAssigner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleAssignmentDtoAssigner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleAssignmentDtoAssigner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleAssignmentDtoAssigner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleAssignmentDtoAssigner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleAssignmentDtoAssigner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleAssignmentDtoAssigner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleAssignmentDtoAssigner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RoleAssignmentDtoAssigner) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RoleAssignmentDtoAssigner) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleAssignmentDtoAssignmentContext.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleAssignmentDtoAssignmentContext.md new file mode 100644 index 000000000..7b883697e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleAssignmentDtoAssignmentContext.md @@ -0,0 +1,116 @@ +--- +id: v2024-role-assignment-dto-assignment-context +title: RoleAssignmentDtoAssignmentContext +pagination_label: RoleAssignmentDtoAssignmentContext +sidebar_label: RoleAssignmentDtoAssignmentContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleAssignmentDtoAssignmentContext', 'V2024RoleAssignmentDtoAssignmentContext'] +slug: /tools/sdk/go/v2024/models/role-assignment-dto-assignment-context +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentDtoAssignmentContext', 'V2024RoleAssignmentDtoAssignmentContext'] +--- + +# RoleAssignmentDtoAssignmentContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Requested** | Pointer to [**AccessRequestContext**](access-request-context) | | [optional] +**Matched** | Pointer to [**[]RoleMatchDto**](role-match-dto) | | [optional] +**ComputedDate** | Pointer to **string** | Date that the assignment will was evaluated | [optional] + +## Methods + +### NewRoleAssignmentDtoAssignmentContext + +`func NewRoleAssignmentDtoAssignmentContext() *RoleAssignmentDtoAssignmentContext` + +NewRoleAssignmentDtoAssignmentContext instantiates a new RoleAssignmentDtoAssignmentContext 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 + +### NewRoleAssignmentDtoAssignmentContextWithDefaults + +`func NewRoleAssignmentDtoAssignmentContextWithDefaults() *RoleAssignmentDtoAssignmentContext` + +NewRoleAssignmentDtoAssignmentContextWithDefaults instantiates a new RoleAssignmentDtoAssignmentContext 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 + +### GetRequested + +`func (o *RoleAssignmentDtoAssignmentContext) GetRequested() AccessRequestContext` + +GetRequested returns the Requested field if non-nil, zero value otherwise. + +### GetRequestedOk + +`func (o *RoleAssignmentDtoAssignmentContext) GetRequestedOk() (*AccessRequestContext, bool)` + +GetRequestedOk returns a tuple with the Requested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequested + +`func (o *RoleAssignmentDtoAssignmentContext) SetRequested(v AccessRequestContext)` + +SetRequested sets Requested field to given value. + +### HasRequested + +`func (o *RoleAssignmentDtoAssignmentContext) HasRequested() bool` + +HasRequested returns a boolean if a field has been set. + +### GetMatched + +`func (o *RoleAssignmentDtoAssignmentContext) GetMatched() []RoleMatchDto` + +GetMatched returns the Matched field if non-nil, zero value otherwise. + +### GetMatchedOk + +`func (o *RoleAssignmentDtoAssignmentContext) GetMatchedOk() (*[]RoleMatchDto, bool)` + +GetMatchedOk returns a tuple with the Matched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatched + +`func (o *RoleAssignmentDtoAssignmentContext) SetMatched(v []RoleMatchDto)` + +SetMatched sets Matched field to given value. + +### HasMatched + +`func (o *RoleAssignmentDtoAssignmentContext) HasMatched() bool` + +HasMatched returns a boolean if a field has been set. + +### GetComputedDate + +`func (o *RoleAssignmentDtoAssignmentContext) GetComputedDate() string` + +GetComputedDate returns the ComputedDate field if non-nil, zero value otherwise. + +### GetComputedDateOk + +`func (o *RoleAssignmentDtoAssignmentContext) GetComputedDateOk() (*string, bool)` + +GetComputedDateOk returns a tuple with the ComputedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComputedDate + +`func (o *RoleAssignmentDtoAssignmentContext) SetComputedDate(v string)` + +SetComputedDate sets ComputedDate field to given value. + +### HasComputedDate + +`func (o *RoleAssignmentDtoAssignmentContext) HasComputedDate() bool` + +HasComputedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleAssignmentRef.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleAssignmentRef.md new file mode 100644 index 000000000..c4f1529c6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleAssignmentRef.md @@ -0,0 +1,90 @@ +--- +id: v2024-role-assignment-ref +title: RoleAssignmentRef +pagination_label: RoleAssignmentRef +sidebar_label: RoleAssignmentRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleAssignmentRef', 'V2024RoleAssignmentRef'] +slug: /tools/sdk/go/v2024/models/role-assignment-ref +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentRef', 'V2024RoleAssignmentRef'] +--- + +# RoleAssignmentRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Assignment Id | [optional] +**Role** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] + +## Methods + +### NewRoleAssignmentRef + +`func NewRoleAssignmentRef() *RoleAssignmentRef` + +NewRoleAssignmentRef instantiates a new RoleAssignmentRef 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 + +### NewRoleAssignmentRefWithDefaults + +`func NewRoleAssignmentRefWithDefaults() *RoleAssignmentRef` + +NewRoleAssignmentRefWithDefaults instantiates a new RoleAssignmentRef 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 + +### GetId + +`func (o *RoleAssignmentRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleAssignmentRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleAssignmentRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleAssignmentRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRole + +`func (o *RoleAssignmentRef) GetRole() BaseReferenceDto` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *RoleAssignmentRef) GetRoleOk() (*BaseReferenceDto, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *RoleAssignmentRef) SetRole(v BaseReferenceDto)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *RoleAssignmentRef) HasRole() bool` + +HasRole returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleAssignmentSourceType.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleAssignmentSourceType.md new file mode 100644 index 000000000..83d40f9d0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleAssignmentSourceType.md @@ -0,0 +1,21 @@ +--- +id: v2024-role-assignment-source-type +title: RoleAssignmentSourceType +pagination_label: RoleAssignmentSourceType +sidebar_label: RoleAssignmentSourceType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleAssignmentSourceType', 'V2024RoleAssignmentSourceType'] +slug: /tools/sdk/go/v2024/models/role-assignment-source-type +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentSourceType', 'V2024RoleAssignmentSourceType'] +--- + +# RoleAssignmentSourceType + +## Enum + + +* `ACCESS_REQUEST` (value: `"ACCESS_REQUEST"`) + +* `ROLE_MEMBERSHIP` (value: `"ROLE_MEMBERSHIP"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleBulkDeleteRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleBulkDeleteRequest.md new file mode 100644 index 000000000..679bb9881 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleBulkDeleteRequest.md @@ -0,0 +1,59 @@ +--- +id: v2024-role-bulk-delete-request +title: RoleBulkDeleteRequest +pagination_label: RoleBulkDeleteRequest +sidebar_label: RoleBulkDeleteRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleBulkDeleteRequest', 'V2024RoleBulkDeleteRequest'] +slug: /tools/sdk/go/v2024/models/role-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'RoleBulkDeleteRequest', 'V2024RoleBulkDeleteRequest'] +--- + +# RoleBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleIds** | **[]string** | List of IDs of Roles to be deleted. | + +## Methods + +### NewRoleBulkDeleteRequest + +`func NewRoleBulkDeleteRequest(roleIds []string, ) *RoleBulkDeleteRequest` + +NewRoleBulkDeleteRequest instantiates a new RoleBulkDeleteRequest 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 + +### NewRoleBulkDeleteRequestWithDefaults + +`func NewRoleBulkDeleteRequestWithDefaults() *RoleBulkDeleteRequest` + +NewRoleBulkDeleteRequestWithDefaults instantiates a new RoleBulkDeleteRequest 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 + +### GetRoleIds + +`func (o *RoleBulkDeleteRequest) GetRoleIds() []string` + +GetRoleIds returns the RoleIds field if non-nil, zero value otherwise. + +### GetRoleIdsOk + +`func (o *RoleBulkDeleteRequest) GetRoleIdsOk() (*[]string, bool)` + +GetRoleIdsOk returns a tuple with the RoleIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleIds + +`func (o *RoleBulkDeleteRequest) SetRoleIds(v []string)` + +SetRoleIds sets RoleIds field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleBulkUpdateResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleBulkUpdateResponse.md new file mode 100644 index 000000000..fd598be08 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleBulkUpdateResponse.md @@ -0,0 +1,142 @@ +--- +id: v2024-role-bulk-update-response +title: RoleBulkUpdateResponse +pagination_label: RoleBulkUpdateResponse +sidebar_label: RoleBulkUpdateResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleBulkUpdateResponse', 'V2024RoleBulkUpdateResponse'] +slug: /tools/sdk/go/v2024/models/role-bulk-update-response +tags: ['SDK', 'Software Development Kit', 'RoleBulkUpdateResponse', 'V2024RoleBulkUpdateResponse'] +--- + +# RoleBulkUpdateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the task which is executing the bulk update. This also used in to the bulk-update/_** API to track status. | [optional] +**Type** | Pointer to **string** | Type of the bulk update object. | [optional] +**Status** | Pointer to **string** | The status of the bulk update request, could also checked by getBulkUpdateStatus API | [optional] +**Created** | Pointer to **SailPointTime** | Time when the bulk update request was created | [optional] + +## Methods + +### NewRoleBulkUpdateResponse + +`func NewRoleBulkUpdateResponse() *RoleBulkUpdateResponse` + +NewRoleBulkUpdateResponse instantiates a new RoleBulkUpdateResponse 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 + +### NewRoleBulkUpdateResponseWithDefaults + +`func NewRoleBulkUpdateResponseWithDefaults() *RoleBulkUpdateResponse` + +NewRoleBulkUpdateResponseWithDefaults instantiates a new RoleBulkUpdateResponse 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 + +### GetId + +`func (o *RoleBulkUpdateResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleBulkUpdateResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleBulkUpdateResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleBulkUpdateResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *RoleBulkUpdateResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleBulkUpdateResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleBulkUpdateResponse) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleBulkUpdateResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetStatus + +`func (o *RoleBulkUpdateResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *RoleBulkUpdateResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *RoleBulkUpdateResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *RoleBulkUpdateResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *RoleBulkUpdateResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RoleBulkUpdateResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RoleBulkUpdateResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RoleBulkUpdateResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaKey.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaKey.md new file mode 100644 index 000000000..a369a58e2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaKey.md @@ -0,0 +1,116 @@ +--- +id: v2024-role-criteria-key +title: RoleCriteriaKey +pagination_label: RoleCriteriaKey +sidebar_label: RoleCriteriaKey +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaKey', 'V2024RoleCriteriaKey'] +slug: /tools/sdk/go/v2024/models/role-criteria-key +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKey', 'V2024RoleCriteriaKey'] +--- + +# RoleCriteriaKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**RoleCriteriaKeyType**](role-criteria-key-type) | | +**Property** | **string** | The name of the attribute or entitlement to which the associated criteria applies. | +**SourceId** | Pointer to **NullableString** | ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT | [optional] + +## Methods + +### NewRoleCriteriaKey + +`func NewRoleCriteriaKey(type_ RoleCriteriaKeyType, property string, ) *RoleCriteriaKey` + +NewRoleCriteriaKey instantiates a new RoleCriteriaKey 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 + +### NewRoleCriteriaKeyWithDefaults + +`func NewRoleCriteriaKeyWithDefaults() *RoleCriteriaKey` + +NewRoleCriteriaKeyWithDefaults instantiates a new RoleCriteriaKey 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 + +### GetType + +`func (o *RoleCriteriaKey) GetType() RoleCriteriaKeyType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleCriteriaKey) GetTypeOk() (*RoleCriteriaKeyType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleCriteriaKey) SetType(v RoleCriteriaKeyType)` + +SetType sets Type field to given value. + + +### GetProperty + +`func (o *RoleCriteriaKey) GetProperty() string` + +GetProperty returns the Property field if non-nil, zero value otherwise. + +### GetPropertyOk + +`func (o *RoleCriteriaKey) GetPropertyOk() (*string, bool)` + +GetPropertyOk returns a tuple with the Property field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperty + +`func (o *RoleCriteriaKey) SetProperty(v string)` + +SetProperty sets Property field to given value. + + +### GetSourceId + +`func (o *RoleCriteriaKey) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *RoleCriteriaKey) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *RoleCriteriaKey) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *RoleCriteriaKey) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### SetSourceIdNil + +`func (o *RoleCriteriaKey) SetSourceIdNil(b bool)` + + SetSourceIdNil sets the value for SourceId to be an explicit nil + +### UnsetSourceId +`func (o *RoleCriteriaKey) UnsetSourceId()` + +UnsetSourceId ensures that no value is present for SourceId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaKeyType.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaKeyType.md new file mode 100644 index 000000000..93fe4d535 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaKeyType.md @@ -0,0 +1,23 @@ +--- +id: v2024-role-criteria-key-type +title: RoleCriteriaKeyType +pagination_label: RoleCriteriaKeyType +sidebar_label: RoleCriteriaKeyType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaKeyType', 'V2024RoleCriteriaKeyType'] +slug: /tools/sdk/go/v2024/models/role-criteria-key-type +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKeyType', 'V2024RoleCriteriaKeyType'] +--- + +# RoleCriteriaKeyType + +## Enum + + +* `IDENTITY` (value: `"IDENTITY"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaLevel1.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaLevel1.md new file mode 100644 index 000000000..26903f539 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaLevel1.md @@ -0,0 +1,172 @@ +--- +id: v2024-role-criteria-level1 +title: RoleCriteriaLevel1 +pagination_label: RoleCriteriaLevel1 +sidebar_label: RoleCriteriaLevel1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaLevel1', 'V2024RoleCriteriaLevel1'] +slug: /tools/sdk/go/v2024/models/role-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel1', 'V2024RoleCriteriaLevel1'] +--- + +# RoleCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableRoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **NullableString** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]RoleCriteriaLevel2**](role-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Methods + +### NewRoleCriteriaLevel1 + +`func NewRoleCriteriaLevel1() *RoleCriteriaLevel1` + +NewRoleCriteriaLevel1 instantiates a new RoleCriteriaLevel1 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 + +### NewRoleCriteriaLevel1WithDefaults + +`func NewRoleCriteriaLevel1WithDefaults() *RoleCriteriaLevel1` + +NewRoleCriteriaLevel1WithDefaults instantiates a new RoleCriteriaLevel1 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 + +### GetOperation + +`func (o *RoleCriteriaLevel1) GetOperation() RoleCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleCriteriaLevel1) GetOperationOk() (*RoleCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleCriteriaLevel1) SetOperation(v RoleCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *RoleCriteriaLevel1) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *RoleCriteriaLevel1) GetKey() RoleCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *RoleCriteriaLevel1) GetKeyOk() (*RoleCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *RoleCriteriaLevel1) SetKey(v RoleCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *RoleCriteriaLevel1) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *RoleCriteriaLevel1) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *RoleCriteriaLevel1) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *RoleCriteriaLevel1) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *RoleCriteriaLevel1) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *RoleCriteriaLevel1) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *RoleCriteriaLevel1) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + +### SetStringValueNil + +`func (o *RoleCriteriaLevel1) SetStringValueNil(b bool)` + + SetStringValueNil sets the value for StringValue to be an explicit nil + +### UnsetStringValue +`func (o *RoleCriteriaLevel1) UnsetStringValue()` + +UnsetStringValue ensures that no value is present for StringValue, not even an explicit nil +### GetChildren + +`func (o *RoleCriteriaLevel1) GetChildren() []RoleCriteriaLevel2` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *RoleCriteriaLevel1) GetChildrenOk() (*[]RoleCriteriaLevel2, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *RoleCriteriaLevel1) SetChildren(v []RoleCriteriaLevel2)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *RoleCriteriaLevel1) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *RoleCriteriaLevel1) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *RoleCriteriaLevel1) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaLevel2.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaLevel2.md new file mode 100644 index 000000000..90cf1e08b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaLevel2.md @@ -0,0 +1,172 @@ +--- +id: v2024-role-criteria-level2 +title: RoleCriteriaLevel2 +pagination_label: RoleCriteriaLevel2 +sidebar_label: RoleCriteriaLevel2 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaLevel2', 'V2024RoleCriteriaLevel2'] +slug: /tools/sdk/go/v2024/models/role-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel2', 'V2024RoleCriteriaLevel2'] +--- + +# RoleCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableRoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **NullableString** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]RoleCriteriaLevel3**](role-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Methods + +### NewRoleCriteriaLevel2 + +`func NewRoleCriteriaLevel2() *RoleCriteriaLevel2` + +NewRoleCriteriaLevel2 instantiates a new RoleCriteriaLevel2 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 + +### NewRoleCriteriaLevel2WithDefaults + +`func NewRoleCriteriaLevel2WithDefaults() *RoleCriteriaLevel2` + +NewRoleCriteriaLevel2WithDefaults instantiates a new RoleCriteriaLevel2 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 + +### GetOperation + +`func (o *RoleCriteriaLevel2) GetOperation() RoleCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleCriteriaLevel2) GetOperationOk() (*RoleCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleCriteriaLevel2) SetOperation(v RoleCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *RoleCriteriaLevel2) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *RoleCriteriaLevel2) GetKey() RoleCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *RoleCriteriaLevel2) GetKeyOk() (*RoleCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *RoleCriteriaLevel2) SetKey(v RoleCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *RoleCriteriaLevel2) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *RoleCriteriaLevel2) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *RoleCriteriaLevel2) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *RoleCriteriaLevel2) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *RoleCriteriaLevel2) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *RoleCriteriaLevel2) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *RoleCriteriaLevel2) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + +### SetStringValueNil + +`func (o *RoleCriteriaLevel2) SetStringValueNil(b bool)` + + SetStringValueNil sets the value for StringValue to be an explicit nil + +### UnsetStringValue +`func (o *RoleCriteriaLevel2) UnsetStringValue()` + +UnsetStringValue ensures that no value is present for StringValue, not even an explicit nil +### GetChildren + +`func (o *RoleCriteriaLevel2) GetChildren() []RoleCriteriaLevel3` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *RoleCriteriaLevel2) GetChildrenOk() (*[]RoleCriteriaLevel3, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *RoleCriteriaLevel2) SetChildren(v []RoleCriteriaLevel3)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *RoleCriteriaLevel2) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *RoleCriteriaLevel2) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *RoleCriteriaLevel2) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaLevel3.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaLevel3.md new file mode 100644 index 000000000..be8914d08 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaLevel3.md @@ -0,0 +1,126 @@ +--- +id: v2024-role-criteria-level3 +title: RoleCriteriaLevel3 +pagination_label: RoleCriteriaLevel3 +sidebar_label: RoleCriteriaLevel3 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaLevel3', 'V2024RoleCriteriaLevel3'] +slug: /tools/sdk/go/v2024/models/role-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel3', 'V2024RoleCriteriaLevel3'] +--- + +# RoleCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableRoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **string** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] + +## Methods + +### NewRoleCriteriaLevel3 + +`func NewRoleCriteriaLevel3() *RoleCriteriaLevel3` + +NewRoleCriteriaLevel3 instantiates a new RoleCriteriaLevel3 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 + +### NewRoleCriteriaLevel3WithDefaults + +`func NewRoleCriteriaLevel3WithDefaults() *RoleCriteriaLevel3` + +NewRoleCriteriaLevel3WithDefaults instantiates a new RoleCriteriaLevel3 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 + +### GetOperation + +`func (o *RoleCriteriaLevel3) GetOperation() RoleCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleCriteriaLevel3) GetOperationOk() (*RoleCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleCriteriaLevel3) SetOperation(v RoleCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *RoleCriteriaLevel3) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *RoleCriteriaLevel3) GetKey() RoleCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *RoleCriteriaLevel3) GetKeyOk() (*RoleCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *RoleCriteriaLevel3) SetKey(v RoleCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *RoleCriteriaLevel3) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *RoleCriteriaLevel3) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *RoleCriteriaLevel3) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *RoleCriteriaLevel3) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *RoleCriteriaLevel3) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *RoleCriteriaLevel3) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *RoleCriteriaLevel3) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaOperation.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaOperation.md new file mode 100644 index 000000000..e50da1010 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleCriteriaOperation.md @@ -0,0 +1,31 @@ +--- +id: v2024-role-criteria-operation +title: RoleCriteriaOperation +pagination_label: RoleCriteriaOperation +sidebar_label: RoleCriteriaOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaOperation', 'V2024RoleCriteriaOperation'] +slug: /tools/sdk/go/v2024/models/role-criteria-operation +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaOperation', 'V2024RoleCriteriaOperation'] +--- + +# RoleCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `STARTS_WITH` (value: `"STARTS_WITH"`) + +* `ENDS_WITH` (value: `"ENDS_WITH"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleDocument.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleDocument.md new file mode 100644 index 000000000..063005df0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleDocument.md @@ -0,0 +1,694 @@ +--- +id: v2024-role-document +title: RoleDocument +pagination_label: RoleDocument +sidebar_label: RoleDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleDocument', 'V2024RoleDocument'] +slug: /tools/sdk/go/v2024/models/role-document +tags: ['SDK', 'Software Development Kit', 'RoleDocument', 'V2024RoleDocument'] +--- + +# RoleDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Access item's description. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **NullableTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Enabled** | Pointer to **bool** | Indicates whether the access item is currently enabled. | [optional] [default to false] +**Requestable** | Pointer to **bool** | Indicates whether the access item can be requested. | [optional] [default to true] +**RequestCommentsRequired** | Pointer to **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to false] +**Owner** | Pointer to [**BaseAccessOwner**](base-access-owner) | | [optional] +**Id** | **string** | ID of the role. | +**Name** | **string** | Name of the role. | +**AccessProfiles** | Pointer to [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional] +**AccessProfileCount** | Pointer to **NullableInt32** | Number of access profiles included with the role. | [optional] +**Tags** | Pointer to **[]string** | Tags that have been applied to the object. | [optional] +**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] +**SegmentCount** | Pointer to **NullableInt32** | Number of segments with the role. | [optional] +**Entitlements** | Pointer to [**[]RoleDocumentAllOfEntitlements**](role-document-all-of-entitlements) | Entitlements included with the role. | [optional] +**EntitlementCount** | Pointer to **NullableInt32** | Number of entitlements included with the role. | [optional] +**Dimensional** | Pointer to **bool** | | [optional] [default to false] +**DimensionSchemaAttributeCount** | Pointer to **NullableInt32** | Number of dimension attributes included with the role. | [optional] +**DimensionSchemaAttributes** | Pointer to [**[]RoleDocumentAllOfDimensionSchemaAttributes**](role-document-all-of-dimension-schema-attributes) | Dimension attributes included with the role. | [optional] +**Dimensions** | Pointer to [**[]RoleDocumentAllOfDimensions**](role-document-all-of-dimensions) | | [optional] + +## Methods + +### NewRoleDocument + +`func NewRoleDocument(id string, name string, ) *RoleDocument` + +NewRoleDocument instantiates a new RoleDocument 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 + +### NewRoleDocumentWithDefaults + +`func NewRoleDocumentWithDefaults() *RoleDocument` + +NewRoleDocumentWithDefaults instantiates a new RoleDocument 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 + +### GetDescription + +`func (o *RoleDocument) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleDocument) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleDocument) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleDocument) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetCreated + +`func (o *RoleDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RoleDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RoleDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RoleDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *RoleDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *RoleDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *RoleDocument) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RoleDocument) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RoleDocument) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RoleDocument) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *RoleDocument) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *RoleDocument) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *RoleDocument) GetSynced() SailPointTime` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *RoleDocument) GetSyncedOk() (*SailPointTime, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *RoleDocument) SetSynced(v SailPointTime)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *RoleDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### SetSyncedNil + +`func (o *RoleDocument) SetSyncedNil(b bool)` + + SetSyncedNil sets the value for Synced to be an explicit nil + +### UnsetSynced +`func (o *RoleDocument) UnsetSynced()` + +UnsetSynced ensures that no value is present for Synced, not even an explicit nil +### GetEnabled + +`func (o *RoleDocument) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *RoleDocument) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *RoleDocument) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *RoleDocument) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetRequestable + +`func (o *RoleDocument) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *RoleDocument) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *RoleDocument) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *RoleDocument) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetRequestCommentsRequired + +`func (o *RoleDocument) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *RoleDocument) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *RoleDocument) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *RoleDocument) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + +### GetOwner + +`func (o *RoleDocument) GetOwner() BaseAccessOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *RoleDocument) GetOwnerOk() (*BaseAccessOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *RoleDocument) SetOwner(v BaseAccessOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *RoleDocument) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetId + +`func (o *RoleDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleDocument) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *RoleDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleDocument) SetName(v string)` + +SetName sets Name field to given value. + + +### GetAccessProfiles + +`func (o *RoleDocument) GetAccessProfiles() []BaseAccessProfile` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *RoleDocument) GetAccessProfilesOk() (*[]BaseAccessProfile, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *RoleDocument) SetAccessProfiles(v []BaseAccessProfile)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *RoleDocument) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### SetAccessProfilesNil + +`func (o *RoleDocument) SetAccessProfilesNil(b bool)` + + SetAccessProfilesNil sets the value for AccessProfiles to be an explicit nil + +### UnsetAccessProfiles +`func (o *RoleDocument) UnsetAccessProfiles()` + +UnsetAccessProfiles ensures that no value is present for AccessProfiles, not even an explicit nil +### GetAccessProfileCount + +`func (o *RoleDocument) GetAccessProfileCount() int32` + +GetAccessProfileCount returns the AccessProfileCount field if non-nil, zero value otherwise. + +### GetAccessProfileCountOk + +`func (o *RoleDocument) GetAccessProfileCountOk() (*int32, bool)` + +GetAccessProfileCountOk returns a tuple with the AccessProfileCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileCount + +`func (o *RoleDocument) SetAccessProfileCount(v int32)` + +SetAccessProfileCount sets AccessProfileCount field to given value. + +### HasAccessProfileCount + +`func (o *RoleDocument) HasAccessProfileCount() bool` + +HasAccessProfileCount returns a boolean if a field has been set. + +### SetAccessProfileCountNil + +`func (o *RoleDocument) SetAccessProfileCountNil(b bool)` + + SetAccessProfileCountNil sets the value for AccessProfileCount to be an explicit nil + +### UnsetAccessProfileCount +`func (o *RoleDocument) UnsetAccessProfileCount()` + +UnsetAccessProfileCount ensures that no value is present for AccessProfileCount, not even an explicit nil +### GetTags + +`func (o *RoleDocument) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *RoleDocument) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *RoleDocument) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *RoleDocument) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetSegments + +`func (o *RoleDocument) GetSegments() []BaseSegment` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *RoleDocument) GetSegmentsOk() (*[]BaseSegment, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *RoleDocument) SetSegments(v []BaseSegment)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *RoleDocument) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### SetSegmentsNil + +`func (o *RoleDocument) SetSegmentsNil(b bool)` + + SetSegmentsNil sets the value for Segments to be an explicit nil + +### UnsetSegments +`func (o *RoleDocument) UnsetSegments()` + +UnsetSegments ensures that no value is present for Segments, not even an explicit nil +### GetSegmentCount + +`func (o *RoleDocument) GetSegmentCount() int32` + +GetSegmentCount returns the SegmentCount field if non-nil, zero value otherwise. + +### GetSegmentCountOk + +`func (o *RoleDocument) GetSegmentCountOk() (*int32, bool)` + +GetSegmentCountOk returns a tuple with the SegmentCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegmentCount + +`func (o *RoleDocument) SetSegmentCount(v int32)` + +SetSegmentCount sets SegmentCount field to given value. + +### HasSegmentCount + +`func (o *RoleDocument) HasSegmentCount() bool` + +HasSegmentCount returns a boolean if a field has been set. + +### SetSegmentCountNil + +`func (o *RoleDocument) SetSegmentCountNil(b bool)` + + SetSegmentCountNil sets the value for SegmentCount to be an explicit nil + +### UnsetSegmentCount +`func (o *RoleDocument) UnsetSegmentCount()` + +UnsetSegmentCount ensures that no value is present for SegmentCount, not even an explicit nil +### GetEntitlements + +`func (o *RoleDocument) GetEntitlements() []RoleDocumentAllOfEntitlements` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *RoleDocument) GetEntitlementsOk() (*[]RoleDocumentAllOfEntitlements, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *RoleDocument) SetEntitlements(v []RoleDocumentAllOfEntitlements)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *RoleDocument) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### SetEntitlementsNil + +`func (o *RoleDocument) SetEntitlementsNil(b bool)` + + SetEntitlementsNil sets the value for Entitlements to be an explicit nil + +### UnsetEntitlements +`func (o *RoleDocument) UnsetEntitlements()` + +UnsetEntitlements ensures that no value is present for Entitlements, not even an explicit nil +### GetEntitlementCount + +`func (o *RoleDocument) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *RoleDocument) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *RoleDocument) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *RoleDocument) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### SetEntitlementCountNil + +`func (o *RoleDocument) SetEntitlementCountNil(b bool)` + + SetEntitlementCountNil sets the value for EntitlementCount to be an explicit nil + +### UnsetEntitlementCount +`func (o *RoleDocument) UnsetEntitlementCount()` + +UnsetEntitlementCount ensures that no value is present for EntitlementCount, not even an explicit nil +### GetDimensional + +`func (o *RoleDocument) GetDimensional() bool` + +GetDimensional returns the Dimensional field if non-nil, zero value otherwise. + +### GetDimensionalOk + +`func (o *RoleDocument) GetDimensionalOk() (*bool, bool)` + +GetDimensionalOk returns a tuple with the Dimensional field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensional + +`func (o *RoleDocument) SetDimensional(v bool)` + +SetDimensional sets Dimensional field to given value. + +### HasDimensional + +`func (o *RoleDocument) HasDimensional() bool` + +HasDimensional returns a boolean if a field has been set. + +### GetDimensionSchemaAttributeCount + +`func (o *RoleDocument) GetDimensionSchemaAttributeCount() int32` + +GetDimensionSchemaAttributeCount returns the DimensionSchemaAttributeCount field if non-nil, zero value otherwise. + +### GetDimensionSchemaAttributeCountOk + +`func (o *RoleDocument) GetDimensionSchemaAttributeCountOk() (*int32, bool)` + +GetDimensionSchemaAttributeCountOk returns a tuple with the DimensionSchemaAttributeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensionSchemaAttributeCount + +`func (o *RoleDocument) SetDimensionSchemaAttributeCount(v int32)` + +SetDimensionSchemaAttributeCount sets DimensionSchemaAttributeCount field to given value. + +### HasDimensionSchemaAttributeCount + +`func (o *RoleDocument) HasDimensionSchemaAttributeCount() bool` + +HasDimensionSchemaAttributeCount returns a boolean if a field has been set. + +### SetDimensionSchemaAttributeCountNil + +`func (o *RoleDocument) SetDimensionSchemaAttributeCountNil(b bool)` + + SetDimensionSchemaAttributeCountNil sets the value for DimensionSchemaAttributeCount to be an explicit nil + +### UnsetDimensionSchemaAttributeCount +`func (o *RoleDocument) UnsetDimensionSchemaAttributeCount()` + +UnsetDimensionSchemaAttributeCount ensures that no value is present for DimensionSchemaAttributeCount, not even an explicit nil +### GetDimensionSchemaAttributes + +`func (o *RoleDocument) GetDimensionSchemaAttributes() []RoleDocumentAllOfDimensionSchemaAttributes` + +GetDimensionSchemaAttributes returns the DimensionSchemaAttributes field if non-nil, zero value otherwise. + +### GetDimensionSchemaAttributesOk + +`func (o *RoleDocument) GetDimensionSchemaAttributesOk() (*[]RoleDocumentAllOfDimensionSchemaAttributes, bool)` + +GetDimensionSchemaAttributesOk returns a tuple with the DimensionSchemaAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensionSchemaAttributes + +`func (o *RoleDocument) SetDimensionSchemaAttributes(v []RoleDocumentAllOfDimensionSchemaAttributes)` + +SetDimensionSchemaAttributes sets DimensionSchemaAttributes field to given value. + +### HasDimensionSchemaAttributes + +`func (o *RoleDocument) HasDimensionSchemaAttributes() bool` + +HasDimensionSchemaAttributes returns a boolean if a field has been set. + +### SetDimensionSchemaAttributesNil + +`func (o *RoleDocument) SetDimensionSchemaAttributesNil(b bool)` + + SetDimensionSchemaAttributesNil sets the value for DimensionSchemaAttributes to be an explicit nil + +### UnsetDimensionSchemaAttributes +`func (o *RoleDocument) UnsetDimensionSchemaAttributes()` + +UnsetDimensionSchemaAttributes ensures that no value is present for DimensionSchemaAttributes, not even an explicit nil +### GetDimensions + +`func (o *RoleDocument) GetDimensions() []RoleDocumentAllOfDimensions` + +GetDimensions returns the Dimensions field if non-nil, zero value otherwise. + +### GetDimensionsOk + +`func (o *RoleDocument) GetDimensionsOk() (*[]RoleDocumentAllOfDimensions, bool)` + +GetDimensionsOk returns a tuple with the Dimensions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensions + +`func (o *RoleDocument) SetDimensions(v []RoleDocumentAllOfDimensions)` + +SetDimensions sets Dimensions field to given value. + +### HasDimensions + +`func (o *RoleDocument) HasDimensions() bool` + +HasDimensions returns a boolean if a field has been set. + +### SetDimensionsNil + +`func (o *RoleDocument) SetDimensionsNil(b bool)` + + SetDimensionsNil sets the value for Dimensions to be an explicit nil + +### UnsetDimensions +`func (o *RoleDocument) UnsetDimensions()` + +UnsetDimensions ensures that no value is present for Dimensions, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleDocumentAllOfDimensionSchemaAttributes.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleDocumentAllOfDimensionSchemaAttributes.md new file mode 100644 index 000000000..b6f20d8bc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleDocumentAllOfDimensionSchemaAttributes.md @@ -0,0 +1,116 @@ +--- +id: v2024-role-document-all-of-dimension-schema-attributes +title: RoleDocumentAllOfDimensionSchemaAttributes +pagination_label: RoleDocumentAllOfDimensionSchemaAttributes +sidebar_label: RoleDocumentAllOfDimensionSchemaAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleDocumentAllOfDimensionSchemaAttributes', 'V2024RoleDocumentAllOfDimensionSchemaAttributes'] +slug: /tools/sdk/go/v2024/models/role-document-all-of-dimension-schema-attributes +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfDimensionSchemaAttributes', 'V2024RoleDocumentAllOfDimensionSchemaAttributes'] +--- + +# RoleDocumentAllOfDimensionSchemaAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Derived** | Pointer to **bool** | | [optional] [default to true] +**DisplayName** | Pointer to **string** | Displayname of the dimension attribute. | [optional] +**Name** | Pointer to **string** | Name of the dimension attribute. | [optional] + +## Methods + +### NewRoleDocumentAllOfDimensionSchemaAttributes + +`func NewRoleDocumentAllOfDimensionSchemaAttributes() *RoleDocumentAllOfDimensionSchemaAttributes` + +NewRoleDocumentAllOfDimensionSchemaAttributes instantiates a new RoleDocumentAllOfDimensionSchemaAttributes 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 + +### NewRoleDocumentAllOfDimensionSchemaAttributesWithDefaults + +`func NewRoleDocumentAllOfDimensionSchemaAttributesWithDefaults() *RoleDocumentAllOfDimensionSchemaAttributes` + +NewRoleDocumentAllOfDimensionSchemaAttributesWithDefaults instantiates a new RoleDocumentAllOfDimensionSchemaAttributes 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 + +### GetDerived + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetDerived() bool` + +GetDerived returns the Derived field if non-nil, zero value otherwise. + +### GetDerivedOk + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetDerivedOk() (*bool, bool)` + +GetDerivedOk returns a tuple with the Derived field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDerived + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) SetDerived(v bool)` + +SetDerived sets Derived field to given value. + +### HasDerived + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) HasDerived() bool` + +HasDerived returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleDocumentAllOfDimensions.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleDocumentAllOfDimensions.md new file mode 100644 index 000000000..8dc574d09 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleDocumentAllOfDimensions.md @@ -0,0 +1,198 @@ +--- +id: v2024-role-document-all-of-dimensions +title: RoleDocumentAllOfDimensions +pagination_label: RoleDocumentAllOfDimensions +sidebar_label: RoleDocumentAllOfDimensions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleDocumentAllOfDimensions', 'V2024RoleDocumentAllOfDimensions'] +slug: /tools/sdk/go/v2024/models/role-document-all-of-dimensions +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfDimensions', 'V2024RoleDocumentAllOfDimensions'] +--- + +# RoleDocumentAllOfDimensions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique ID of the dimension. | [optional] +**Name** | Pointer to **string** | Name of the dimension. | [optional] +**Description** | Pointer to **NullableString** | Description of the dimension. | [optional] +**Entitlements** | Pointer to [**[]RoleDocumentAllOfEntitlements1**](role-document-all-of-entitlements1) | Entitlements included with the role. | [optional] +**AccessProfiles** | Pointer to [**[]BaseAccessProfile**](base-access-profile) | Access profiles included in the dimension. | [optional] + +## Methods + +### NewRoleDocumentAllOfDimensions + +`func NewRoleDocumentAllOfDimensions() *RoleDocumentAllOfDimensions` + +NewRoleDocumentAllOfDimensions instantiates a new RoleDocumentAllOfDimensions 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 + +### NewRoleDocumentAllOfDimensionsWithDefaults + +`func NewRoleDocumentAllOfDimensionsWithDefaults() *RoleDocumentAllOfDimensions` + +NewRoleDocumentAllOfDimensionsWithDefaults instantiates a new RoleDocumentAllOfDimensions 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 + +### GetId + +`func (o *RoleDocumentAllOfDimensions) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleDocumentAllOfDimensions) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleDocumentAllOfDimensions) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleDocumentAllOfDimensions) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleDocumentAllOfDimensions) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleDocumentAllOfDimensions) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleDocumentAllOfDimensions) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleDocumentAllOfDimensions) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleDocumentAllOfDimensions) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleDocumentAllOfDimensions) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleDocumentAllOfDimensions) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleDocumentAllOfDimensions) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleDocumentAllOfDimensions) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleDocumentAllOfDimensions) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetEntitlements + +`func (o *RoleDocumentAllOfDimensions) GetEntitlements() []RoleDocumentAllOfEntitlements1` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *RoleDocumentAllOfDimensions) GetEntitlementsOk() (*[]RoleDocumentAllOfEntitlements1, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *RoleDocumentAllOfDimensions) SetEntitlements(v []RoleDocumentAllOfEntitlements1)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *RoleDocumentAllOfDimensions) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### SetEntitlementsNil + +`func (o *RoleDocumentAllOfDimensions) SetEntitlementsNil(b bool)` + + SetEntitlementsNil sets the value for Entitlements to be an explicit nil + +### UnsetEntitlements +`func (o *RoleDocumentAllOfDimensions) UnsetEntitlements()` + +UnsetEntitlements ensures that no value is present for Entitlements, not even an explicit nil +### GetAccessProfiles + +`func (o *RoleDocumentAllOfDimensions) GetAccessProfiles() []BaseAccessProfile` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *RoleDocumentAllOfDimensions) GetAccessProfilesOk() (*[]BaseAccessProfile, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *RoleDocumentAllOfDimensions) SetAccessProfiles(v []BaseAccessProfile)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *RoleDocumentAllOfDimensions) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### SetAccessProfilesNil + +`func (o *RoleDocumentAllOfDimensions) SetAccessProfilesNil(b bool)` + + SetAccessProfilesNil sets the value for AccessProfiles to be an explicit nil + +### UnsetAccessProfiles +`func (o *RoleDocumentAllOfDimensions) UnsetAccessProfiles()` + +UnsetAccessProfiles ensures that no value is present for AccessProfiles, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleDocumentAllOfEntitlements.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleDocumentAllOfEntitlements.md new file mode 100644 index 000000000..a03152903 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleDocumentAllOfEntitlements.md @@ -0,0 +1,308 @@ +--- +id: v2024-role-document-all-of-entitlements +title: RoleDocumentAllOfEntitlements +pagination_label: RoleDocumentAllOfEntitlements +sidebar_label: RoleDocumentAllOfEntitlements +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleDocumentAllOfEntitlements', 'V2024RoleDocumentAllOfEntitlements'] +slug: /tools/sdk/go/v2024/models/role-document-all-of-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfEntitlements', 'V2024RoleDocumentAllOfEntitlements'] +--- + +# RoleDocumentAllOfEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasPermissions** | Pointer to **bool** | Indicates whether the entitlement has permissions. | [optional] [default to false] +**Description** | Pointer to **NullableString** | Entitlement's description. | [optional] +**Attribute** | Pointer to **string** | Entitlement attribute's name. | [optional] +**Value** | Pointer to **string** | Entitlement's value. | [optional] +**Schema** | Pointer to **string** | Entitlement's schema. | [optional] +**Privileged** | Pointer to **bool** | Indicates whether the entitlement is privileged. | [optional] [default to false] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **string** | Entitlement's name. | [optional] +**SourceSchemaObjectType** | Pointer to **string** | Schema objectType. | [optional] +**Hash** | Pointer to **string** | Read-only calculated hash value of an entitlement. | [optional] + +## Methods + +### NewRoleDocumentAllOfEntitlements + +`func NewRoleDocumentAllOfEntitlements() *RoleDocumentAllOfEntitlements` + +NewRoleDocumentAllOfEntitlements instantiates a new RoleDocumentAllOfEntitlements 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 + +### NewRoleDocumentAllOfEntitlementsWithDefaults + +`func NewRoleDocumentAllOfEntitlementsWithDefaults() *RoleDocumentAllOfEntitlements` + +NewRoleDocumentAllOfEntitlementsWithDefaults instantiates a new RoleDocumentAllOfEntitlements 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 + +### GetHasPermissions + +`func (o *RoleDocumentAllOfEntitlements) GetHasPermissions() bool` + +GetHasPermissions returns the HasPermissions field if non-nil, zero value otherwise. + +### GetHasPermissionsOk + +`func (o *RoleDocumentAllOfEntitlements) GetHasPermissionsOk() (*bool, bool)` + +GetHasPermissionsOk returns a tuple with the HasPermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasPermissions + +`func (o *RoleDocumentAllOfEntitlements) SetHasPermissions(v bool)` + +SetHasPermissions sets HasPermissions field to given value. + +### HasHasPermissions + +`func (o *RoleDocumentAllOfEntitlements) HasHasPermissions() bool` + +HasHasPermissions returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleDocumentAllOfEntitlements) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleDocumentAllOfEntitlements) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleDocumentAllOfEntitlements) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleDocumentAllOfEntitlements) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleDocumentAllOfEntitlements) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleDocumentAllOfEntitlements) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAttribute + +`func (o *RoleDocumentAllOfEntitlements) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleDocumentAllOfEntitlements) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleDocumentAllOfEntitlements) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleDocumentAllOfEntitlements) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *RoleDocumentAllOfEntitlements) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *RoleDocumentAllOfEntitlements) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *RoleDocumentAllOfEntitlements) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *RoleDocumentAllOfEntitlements) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSchema + +`func (o *RoleDocumentAllOfEntitlements) GetSchema() string` + +GetSchema returns the Schema field if non-nil, zero value otherwise. + +### GetSchemaOk + +`func (o *RoleDocumentAllOfEntitlements) GetSchemaOk() (*string, bool)` + +GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchema + +`func (o *RoleDocumentAllOfEntitlements) SetSchema(v string)` + +SetSchema sets Schema field to given value. + +### HasSchema + +`func (o *RoleDocumentAllOfEntitlements) HasSchema() bool` + +HasSchema returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *RoleDocumentAllOfEntitlements) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *RoleDocumentAllOfEntitlements) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *RoleDocumentAllOfEntitlements) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *RoleDocumentAllOfEntitlements) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetId + +`func (o *RoleDocumentAllOfEntitlements) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleDocumentAllOfEntitlements) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleDocumentAllOfEntitlements) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleDocumentAllOfEntitlements) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleDocumentAllOfEntitlements) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleDocumentAllOfEntitlements) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleDocumentAllOfEntitlements) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleDocumentAllOfEntitlements) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements) GetSourceSchemaObjectType() string` + +GetSourceSchemaObjectType returns the SourceSchemaObjectType field if non-nil, zero value otherwise. + +### GetSourceSchemaObjectTypeOk + +`func (o *RoleDocumentAllOfEntitlements) GetSourceSchemaObjectTypeOk() (*string, bool)` + +GetSourceSchemaObjectTypeOk returns a tuple with the SourceSchemaObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements) SetSourceSchemaObjectType(v string)` + +SetSourceSchemaObjectType sets SourceSchemaObjectType field to given value. + +### HasSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements) HasSourceSchemaObjectType() bool` + +HasSourceSchemaObjectType returns a boolean if a field has been set. + +### GetHash + +`func (o *RoleDocumentAllOfEntitlements) GetHash() string` + +GetHash returns the Hash field if non-nil, zero value otherwise. + +### GetHashOk + +`func (o *RoleDocumentAllOfEntitlements) GetHashOk() (*string, bool)` + +GetHashOk returns a tuple with the Hash field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHash + +`func (o *RoleDocumentAllOfEntitlements) SetHash(v string)` + +SetHash sets Hash field to given value. + +### HasHash + +`func (o *RoleDocumentAllOfEntitlements) HasHash() bool` + +HasHash returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleDocumentAllOfEntitlements1.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleDocumentAllOfEntitlements1.md new file mode 100644 index 000000000..0506f3101 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleDocumentAllOfEntitlements1.md @@ -0,0 +1,308 @@ +--- +id: v2024-role-document-all-of-entitlements1 +title: RoleDocumentAllOfEntitlements1 +pagination_label: RoleDocumentAllOfEntitlements1 +sidebar_label: RoleDocumentAllOfEntitlements1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleDocumentAllOfEntitlements1', 'V2024RoleDocumentAllOfEntitlements1'] +slug: /tools/sdk/go/v2024/models/role-document-all-of-entitlements1 +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfEntitlements1', 'V2024RoleDocumentAllOfEntitlements1'] +--- + +# RoleDocumentAllOfEntitlements1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasPermissions** | Pointer to **bool** | Indicates whether the entitlement has permissions. | [optional] [default to false] +**Description** | Pointer to **NullableString** | Entitlement's description. | [optional] +**Attribute** | Pointer to **string** | Entitlement attribute's name. | [optional] +**Value** | Pointer to **string** | Entitlement's value. | [optional] +**Schema** | Pointer to **string** | Entitlement's schema. | [optional] +**Privileged** | Pointer to **bool** | Indicates whether the entitlement is privileged. | [optional] [default to false] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **string** | Entitlement's name. | [optional] +**SourceSchemaObjectType** | Pointer to **string** | Schema objectType. | [optional] +**Hash** | Pointer to **string** | Read-only calculated hash value of an entitlement. | [optional] + +## Methods + +### NewRoleDocumentAllOfEntitlements1 + +`func NewRoleDocumentAllOfEntitlements1() *RoleDocumentAllOfEntitlements1` + +NewRoleDocumentAllOfEntitlements1 instantiates a new RoleDocumentAllOfEntitlements1 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 + +### NewRoleDocumentAllOfEntitlements1WithDefaults + +`func NewRoleDocumentAllOfEntitlements1WithDefaults() *RoleDocumentAllOfEntitlements1` + +NewRoleDocumentAllOfEntitlements1WithDefaults instantiates a new RoleDocumentAllOfEntitlements1 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 + +### GetHasPermissions + +`func (o *RoleDocumentAllOfEntitlements1) GetHasPermissions() bool` + +GetHasPermissions returns the HasPermissions field if non-nil, zero value otherwise. + +### GetHasPermissionsOk + +`func (o *RoleDocumentAllOfEntitlements1) GetHasPermissionsOk() (*bool, bool)` + +GetHasPermissionsOk returns a tuple with the HasPermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasPermissions + +`func (o *RoleDocumentAllOfEntitlements1) SetHasPermissions(v bool)` + +SetHasPermissions sets HasPermissions field to given value. + +### HasHasPermissions + +`func (o *RoleDocumentAllOfEntitlements1) HasHasPermissions() bool` + +HasHasPermissions returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleDocumentAllOfEntitlements1) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleDocumentAllOfEntitlements1) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleDocumentAllOfEntitlements1) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleDocumentAllOfEntitlements1) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleDocumentAllOfEntitlements1) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleDocumentAllOfEntitlements1) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAttribute + +`func (o *RoleDocumentAllOfEntitlements1) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleDocumentAllOfEntitlements1) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleDocumentAllOfEntitlements1) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleDocumentAllOfEntitlements1) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *RoleDocumentAllOfEntitlements1) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *RoleDocumentAllOfEntitlements1) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *RoleDocumentAllOfEntitlements1) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *RoleDocumentAllOfEntitlements1) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSchema + +`func (o *RoleDocumentAllOfEntitlements1) GetSchema() string` + +GetSchema returns the Schema field if non-nil, zero value otherwise. + +### GetSchemaOk + +`func (o *RoleDocumentAllOfEntitlements1) GetSchemaOk() (*string, bool)` + +GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchema + +`func (o *RoleDocumentAllOfEntitlements1) SetSchema(v string)` + +SetSchema sets Schema field to given value. + +### HasSchema + +`func (o *RoleDocumentAllOfEntitlements1) HasSchema() bool` + +HasSchema returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *RoleDocumentAllOfEntitlements1) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *RoleDocumentAllOfEntitlements1) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *RoleDocumentAllOfEntitlements1) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *RoleDocumentAllOfEntitlements1) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetId + +`func (o *RoleDocumentAllOfEntitlements1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleDocumentAllOfEntitlements1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleDocumentAllOfEntitlements1) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleDocumentAllOfEntitlements1) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleDocumentAllOfEntitlements1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleDocumentAllOfEntitlements1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleDocumentAllOfEntitlements1) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleDocumentAllOfEntitlements1) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements1) GetSourceSchemaObjectType() string` + +GetSourceSchemaObjectType returns the SourceSchemaObjectType field if non-nil, zero value otherwise. + +### GetSourceSchemaObjectTypeOk + +`func (o *RoleDocumentAllOfEntitlements1) GetSourceSchemaObjectTypeOk() (*string, bool)` + +GetSourceSchemaObjectTypeOk returns a tuple with the SourceSchemaObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements1) SetSourceSchemaObjectType(v string)` + +SetSourceSchemaObjectType sets SourceSchemaObjectType field to given value. + +### HasSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements1) HasSourceSchemaObjectType() bool` + +HasSourceSchemaObjectType returns a boolean if a field has been set. + +### GetHash + +`func (o *RoleDocumentAllOfEntitlements1) GetHash() string` + +GetHash returns the Hash field if non-nil, zero value otherwise. + +### GetHashOk + +`func (o *RoleDocumentAllOfEntitlements1) GetHashOk() (*string, bool)` + +GetHashOk returns a tuple with the Hash field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHash + +`func (o *RoleDocumentAllOfEntitlements1) SetHash(v string)` + +SetHash sets Hash field to given value. + +### HasHash + +`func (o *RoleDocumentAllOfEntitlements1) HasHash() bool` + +HasHash returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleGetAllBulkUpdateResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleGetAllBulkUpdateResponse.md new file mode 100644 index 000000000..3e7a66cba --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleGetAllBulkUpdateResponse.md @@ -0,0 +1,142 @@ +--- +id: v2024-role-get-all-bulk-update-response +title: RoleGetAllBulkUpdateResponse +pagination_label: RoleGetAllBulkUpdateResponse +sidebar_label: RoleGetAllBulkUpdateResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleGetAllBulkUpdateResponse', 'V2024RoleGetAllBulkUpdateResponse'] +slug: /tools/sdk/go/v2024/models/role-get-all-bulk-update-response +tags: ['SDK', 'Software Development Kit', 'RoleGetAllBulkUpdateResponse', 'V2024RoleGetAllBulkUpdateResponse'] +--- + +# RoleGetAllBulkUpdateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the task which is executing the bulk update. This also used in to the bulk-update/_** API to track status. | [optional] +**Type** | Pointer to **string** | Type of the bulk update object. | [optional] +**Status** | Pointer to **string** | The status of the bulk update request, only list unfinished request's status, the status could also checked by getBulkUpdateStatus API | [optional] +**Created** | Pointer to **SailPointTime** | Time when the bulk update request was created | [optional] + +## Methods + +### NewRoleGetAllBulkUpdateResponse + +`func NewRoleGetAllBulkUpdateResponse() *RoleGetAllBulkUpdateResponse` + +NewRoleGetAllBulkUpdateResponse instantiates a new RoleGetAllBulkUpdateResponse 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 + +### NewRoleGetAllBulkUpdateResponseWithDefaults + +`func NewRoleGetAllBulkUpdateResponseWithDefaults() *RoleGetAllBulkUpdateResponse` + +NewRoleGetAllBulkUpdateResponseWithDefaults instantiates a new RoleGetAllBulkUpdateResponse 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 + +### GetId + +`func (o *RoleGetAllBulkUpdateResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleGetAllBulkUpdateResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleGetAllBulkUpdateResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleGetAllBulkUpdateResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *RoleGetAllBulkUpdateResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleGetAllBulkUpdateResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleGetAllBulkUpdateResponse) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleGetAllBulkUpdateResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetStatus + +`func (o *RoleGetAllBulkUpdateResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *RoleGetAllBulkUpdateResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *RoleGetAllBulkUpdateResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *RoleGetAllBulkUpdateResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *RoleGetAllBulkUpdateResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RoleGetAllBulkUpdateResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RoleGetAllBulkUpdateResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RoleGetAllBulkUpdateResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleIdentity.md new file mode 100644 index 000000000..cbeb3e793 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleIdentity.md @@ -0,0 +1,168 @@ +--- +id: v2024-role-identity +title: RoleIdentity +pagination_label: RoleIdentity +sidebar_label: RoleIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleIdentity', 'V2024RoleIdentity'] +slug: /tools/sdk/go/v2024/models/role-identity +tags: ['SDK', 'Software Development Kit', 'RoleIdentity', 'V2024RoleIdentity'] +--- + +# RoleIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the Identity | [optional] +**AliasName** | Pointer to **string** | The alias / username of the Identity | [optional] +**Name** | Pointer to **string** | The human-readable display name of the Identity | [optional] +**Email** | Pointer to **string** | Email address of the Identity | [optional] +**RoleAssignmentSource** | Pointer to [**RoleAssignmentSourceType**](role-assignment-source-type) | | [optional] + +## Methods + +### NewRoleIdentity + +`func NewRoleIdentity() *RoleIdentity` + +NewRoleIdentity instantiates a new RoleIdentity 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 + +### NewRoleIdentityWithDefaults + +`func NewRoleIdentityWithDefaults() *RoleIdentity` + +NewRoleIdentityWithDefaults instantiates a new RoleIdentity 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 + +### GetId + +`func (o *RoleIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAliasName + +`func (o *RoleIdentity) GetAliasName() string` + +GetAliasName returns the AliasName field if non-nil, zero value otherwise. + +### GetAliasNameOk + +`func (o *RoleIdentity) GetAliasNameOk() (*string, bool)` + +GetAliasNameOk returns a tuple with the AliasName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAliasName + +`func (o *RoleIdentity) SetAliasName(v string)` + +SetAliasName sets AliasName field to given value. + +### HasAliasName + +`func (o *RoleIdentity) HasAliasName() bool` + +HasAliasName returns a boolean if a field has been set. + +### GetName + +`func (o *RoleIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *RoleIdentity) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *RoleIdentity) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *RoleIdentity) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *RoleIdentity) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetRoleAssignmentSource + +`func (o *RoleIdentity) GetRoleAssignmentSource() RoleAssignmentSourceType` + +GetRoleAssignmentSource returns the RoleAssignmentSource field if non-nil, zero value otherwise. + +### GetRoleAssignmentSourceOk + +`func (o *RoleIdentity) GetRoleAssignmentSourceOk() (*RoleAssignmentSourceType, bool)` + +GetRoleAssignmentSourceOk returns a tuple with the RoleAssignmentSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleAssignmentSource + +`func (o *RoleIdentity) SetRoleAssignmentSource(v RoleAssignmentSourceType)` + +SetRoleAssignmentSource sets RoleAssignmentSource field to given value. + +### HasRoleAssignmentSource + +`func (o *RoleIdentity) HasRoleAssignmentSource() bool` + +HasRoleAssignmentSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleInsight.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleInsight.md new file mode 100644 index 000000000..41b6d385d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleInsight.md @@ -0,0 +1,204 @@ +--- +id: v2024-role-insight +title: RoleInsight +pagination_label: RoleInsight +sidebar_label: RoleInsight +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsight', 'V2024RoleInsight'] +slug: /tools/sdk/go/v2024/models/role-insight +tags: ['SDK', 'Software Development Kit', 'RoleInsight', 'V2024RoleInsight'] +--- + +# RoleInsight + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Insight id | [optional] +**NumberOfUpdates** | Pointer to **int32** | Total number of updates for this role | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time insights were last created for this role. | [optional] +**ModifiedDate** | Pointer to **NullableTime** | The date-time insights were last modified for this role. | [optional] +**Role** | Pointer to [**RoleInsightsRole**](role-insights-role) | | [optional] +**Insight** | Pointer to [**RoleInsightsInsight**](role-insights-insight) | | [optional] + +## Methods + +### NewRoleInsight + +`func NewRoleInsight() *RoleInsight` + +NewRoleInsight instantiates a new RoleInsight 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 + +### NewRoleInsightWithDefaults + +`func NewRoleInsightWithDefaults() *RoleInsight` + +NewRoleInsightWithDefaults instantiates a new RoleInsight 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 + +### GetId + +`func (o *RoleInsight) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsight) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsight) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsight) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetNumberOfUpdates + +`func (o *RoleInsight) GetNumberOfUpdates() int32` + +GetNumberOfUpdates returns the NumberOfUpdates field if non-nil, zero value otherwise. + +### GetNumberOfUpdatesOk + +`func (o *RoleInsight) GetNumberOfUpdatesOk() (*int32, bool)` + +GetNumberOfUpdatesOk returns a tuple with the NumberOfUpdates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumberOfUpdates + +`func (o *RoleInsight) SetNumberOfUpdates(v int32)` + +SetNumberOfUpdates sets NumberOfUpdates field to given value. + +### HasNumberOfUpdates + +`func (o *RoleInsight) HasNumberOfUpdates() bool` + +HasNumberOfUpdates returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleInsight) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleInsight) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleInsight) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleInsight) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetModifiedDate + +`func (o *RoleInsight) GetModifiedDate() SailPointTime` + +GetModifiedDate returns the ModifiedDate field if non-nil, zero value otherwise. + +### GetModifiedDateOk + +`func (o *RoleInsight) GetModifiedDateOk() (*SailPointTime, bool)` + +GetModifiedDateOk returns a tuple with the ModifiedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedDate + +`func (o *RoleInsight) SetModifiedDate(v SailPointTime)` + +SetModifiedDate sets ModifiedDate field to given value. + +### HasModifiedDate + +`func (o *RoleInsight) HasModifiedDate() bool` + +HasModifiedDate returns a boolean if a field has been set. + +### SetModifiedDateNil + +`func (o *RoleInsight) SetModifiedDateNil(b bool)` + + SetModifiedDateNil sets the value for ModifiedDate to be an explicit nil + +### UnsetModifiedDate +`func (o *RoleInsight) UnsetModifiedDate()` + +UnsetModifiedDate ensures that no value is present for ModifiedDate, not even an explicit nil +### GetRole + +`func (o *RoleInsight) GetRole() RoleInsightsRole` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *RoleInsight) GetRoleOk() (*RoleInsightsRole, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *RoleInsight) SetRole(v RoleInsightsRole)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *RoleInsight) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetInsight + +`func (o *RoleInsight) GetInsight() RoleInsightsInsight` + +GetInsight returns the Insight field if non-nil, zero value otherwise. + +### GetInsightOk + +`func (o *RoleInsight) GetInsightOk() (*RoleInsightsInsight, bool)` + +GetInsightOk returns a tuple with the Insight field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInsight + +`func (o *RoleInsight) SetInsight(v RoleInsightsInsight)` + +SetInsight sets Insight field to given value. + +### HasInsight + +`func (o *RoleInsight) HasInsight() bool` + +HasInsight returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsEntitlement.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsEntitlement.md new file mode 100644 index 000000000..e89294e41 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsEntitlement.md @@ -0,0 +1,204 @@ +--- +id: v2024-role-insights-entitlement +title: RoleInsightsEntitlement +pagination_label: RoleInsightsEntitlement +sidebar_label: RoleInsightsEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsEntitlement', 'V2024RoleInsightsEntitlement'] +slug: /tools/sdk/go/v2024/models/role-insights-entitlement +tags: ['SDK', 'Software Development Kit', 'RoleInsightsEntitlement', 'V2024RoleInsightsEntitlement'] +--- + +# RoleInsightsEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the entitlement | [optional] +**Id** | Pointer to **string** | Id of the entitlement | [optional] +**Description** | Pointer to **NullableString** | Description for the entitlement | [optional] +**Source** | Pointer to **string** | Source or the application for the entitlement | [optional] +**Attribute** | Pointer to **string** | Attribute for the entitlement | [optional] +**Value** | Pointer to **string** | Attribute value for the entitlement | [optional] + +## Methods + +### NewRoleInsightsEntitlement + +`func NewRoleInsightsEntitlement() *RoleInsightsEntitlement` + +NewRoleInsightsEntitlement instantiates a new RoleInsightsEntitlement 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 + +### NewRoleInsightsEntitlementWithDefaults + +`func NewRoleInsightsEntitlementWithDefaults() *RoleInsightsEntitlement` + +NewRoleInsightsEntitlementWithDefaults instantiates a new RoleInsightsEntitlement 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 + +### GetName + +`func (o *RoleInsightsEntitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleInsightsEntitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleInsightsEntitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleInsightsEntitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetId + +`func (o *RoleInsightsEntitlement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsightsEntitlement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsightsEntitlement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsightsEntitlement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleInsightsEntitlement) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleInsightsEntitlement) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleInsightsEntitlement) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleInsightsEntitlement) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleInsightsEntitlement) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleInsightsEntitlement) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSource + +`func (o *RoleInsightsEntitlement) GetSource() string` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *RoleInsightsEntitlement) GetSourceOk() (*string, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *RoleInsightsEntitlement) SetSource(v string)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *RoleInsightsEntitlement) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAttribute + +`func (o *RoleInsightsEntitlement) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleInsightsEntitlement) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleInsightsEntitlement) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleInsightsEntitlement) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *RoleInsightsEntitlement) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *RoleInsightsEntitlement) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *RoleInsightsEntitlement) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *RoleInsightsEntitlement) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsEntitlementChanges.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsEntitlementChanges.md new file mode 100644 index 000000000..8dbaf7020 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsEntitlementChanges.md @@ -0,0 +1,230 @@ +--- +id: v2024-role-insights-entitlement-changes +title: RoleInsightsEntitlementChanges +pagination_label: RoleInsightsEntitlementChanges +sidebar_label: RoleInsightsEntitlementChanges +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsEntitlementChanges', 'V2024RoleInsightsEntitlementChanges'] +slug: /tools/sdk/go/v2024/models/role-insights-entitlement-changes +tags: ['SDK', 'Software Development Kit', 'RoleInsightsEntitlementChanges', 'V2024RoleInsightsEntitlementChanges'] +--- + +# RoleInsightsEntitlementChanges + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the entitlement | [optional] +**Id** | Pointer to **string** | Id of the entitlement | [optional] +**Description** | Pointer to **NullableString** | Description for the entitlement | [optional] +**Attribute** | Pointer to **string** | Attribute for the entitlement | [optional] +**Value** | Pointer to **string** | Attribute value for the entitlement | [optional] +**Source** | Pointer to **string** | Source or the application for the entitlement | [optional] +**Insight** | Pointer to [**RoleInsightsInsight**](role-insights-insight) | | [optional] + +## Methods + +### NewRoleInsightsEntitlementChanges + +`func NewRoleInsightsEntitlementChanges() *RoleInsightsEntitlementChanges` + +NewRoleInsightsEntitlementChanges instantiates a new RoleInsightsEntitlementChanges 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 + +### NewRoleInsightsEntitlementChangesWithDefaults + +`func NewRoleInsightsEntitlementChangesWithDefaults() *RoleInsightsEntitlementChanges` + +NewRoleInsightsEntitlementChangesWithDefaults instantiates a new RoleInsightsEntitlementChanges 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 + +### GetName + +`func (o *RoleInsightsEntitlementChanges) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleInsightsEntitlementChanges) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleInsightsEntitlementChanges) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleInsightsEntitlementChanges) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetId + +`func (o *RoleInsightsEntitlementChanges) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsightsEntitlementChanges) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsightsEntitlementChanges) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsightsEntitlementChanges) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleInsightsEntitlementChanges) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleInsightsEntitlementChanges) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleInsightsEntitlementChanges) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleInsightsEntitlementChanges) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleInsightsEntitlementChanges) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleInsightsEntitlementChanges) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAttribute + +`func (o *RoleInsightsEntitlementChanges) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleInsightsEntitlementChanges) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleInsightsEntitlementChanges) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleInsightsEntitlementChanges) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *RoleInsightsEntitlementChanges) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *RoleInsightsEntitlementChanges) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *RoleInsightsEntitlementChanges) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *RoleInsightsEntitlementChanges) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSource + +`func (o *RoleInsightsEntitlementChanges) GetSource() string` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *RoleInsightsEntitlementChanges) GetSourceOk() (*string, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *RoleInsightsEntitlementChanges) SetSource(v string)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *RoleInsightsEntitlementChanges) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetInsight + +`func (o *RoleInsightsEntitlementChanges) GetInsight() RoleInsightsInsight` + +GetInsight returns the Insight field if non-nil, zero value otherwise. + +### GetInsightOk + +`func (o *RoleInsightsEntitlementChanges) GetInsightOk() (*RoleInsightsInsight, bool)` + +GetInsightOk returns a tuple with the Insight field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInsight + +`func (o *RoleInsightsEntitlementChanges) SetInsight(v RoleInsightsInsight)` + +SetInsight sets Insight field to given value. + +### HasInsight + +`func (o *RoleInsightsEntitlementChanges) HasInsight() bool` + +HasInsight returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsIdentities.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsIdentities.md new file mode 100644 index 000000000..ccdc979e1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsIdentities.md @@ -0,0 +1,116 @@ +--- +id: v2024-role-insights-identities +title: RoleInsightsIdentities +pagination_label: RoleInsightsIdentities +sidebar_label: RoleInsightsIdentities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsIdentities', 'V2024RoleInsightsIdentities'] +slug: /tools/sdk/go/v2024/models/role-insights-identities +tags: ['SDK', 'Software Development Kit', 'RoleInsightsIdentities', 'V2024RoleInsightsIdentities'] +--- + +# RoleInsightsIdentities + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id for identity | [optional] +**Name** | Pointer to **string** | Name for identity | [optional] +**Attributes** | Pointer to **map[string]string** | | [optional] + +## Methods + +### NewRoleInsightsIdentities + +`func NewRoleInsightsIdentities() *RoleInsightsIdentities` + +NewRoleInsightsIdentities instantiates a new RoleInsightsIdentities 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 + +### NewRoleInsightsIdentitiesWithDefaults + +`func NewRoleInsightsIdentitiesWithDefaults() *RoleInsightsIdentities` + +NewRoleInsightsIdentitiesWithDefaults instantiates a new RoleInsightsIdentities 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 + +### GetId + +`func (o *RoleInsightsIdentities) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsightsIdentities) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsightsIdentities) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsightsIdentities) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleInsightsIdentities) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleInsightsIdentities) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleInsightsIdentities) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleInsightsIdentities) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAttributes + +`func (o *RoleInsightsIdentities) GetAttributes() map[string]string` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *RoleInsightsIdentities) GetAttributesOk() (*map[string]string, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *RoleInsightsIdentities) SetAttributes(v map[string]string)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *RoleInsightsIdentities) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsInsight.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsInsight.md new file mode 100644 index 000000000..775845622 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsInsight.md @@ -0,0 +1,178 @@ +--- +id: v2024-role-insights-insight +title: RoleInsightsInsight +pagination_label: RoleInsightsInsight +sidebar_label: RoleInsightsInsight +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsInsight', 'V2024RoleInsightsInsight'] +slug: /tools/sdk/go/v2024/models/role-insights-insight +tags: ['SDK', 'Software Development Kit', 'RoleInsightsInsight', 'V2024RoleInsightsInsight'] +--- + +# RoleInsightsInsight + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The number of identities in this role with the entitlement. | [optional] +**IdentitiesWithAccess** | Pointer to **int32** | The number of identities in this role with the entitlement. | [optional] +**IdentitiesImpacted** | Pointer to **int32** | The number of identities in this role that do not have the specified entitlement. | [optional] +**TotalNumberOfIdentities** | Pointer to **int32** | The total number of identities. | [optional] +**ImpactedIdentityNames** | Pointer to **NullableString** | | [optional] + +## Methods + +### NewRoleInsightsInsight + +`func NewRoleInsightsInsight() *RoleInsightsInsight` + +NewRoleInsightsInsight instantiates a new RoleInsightsInsight 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 + +### NewRoleInsightsInsightWithDefaults + +`func NewRoleInsightsInsightWithDefaults() *RoleInsightsInsight` + +NewRoleInsightsInsightWithDefaults instantiates a new RoleInsightsInsight 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 + +### GetType + +`func (o *RoleInsightsInsight) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleInsightsInsight) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleInsightsInsight) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleInsightsInsight) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetIdentitiesWithAccess + +`func (o *RoleInsightsInsight) GetIdentitiesWithAccess() int32` + +GetIdentitiesWithAccess returns the IdentitiesWithAccess field if non-nil, zero value otherwise. + +### GetIdentitiesWithAccessOk + +`func (o *RoleInsightsInsight) GetIdentitiesWithAccessOk() (*int32, bool)` + +GetIdentitiesWithAccessOk returns a tuple with the IdentitiesWithAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesWithAccess + +`func (o *RoleInsightsInsight) SetIdentitiesWithAccess(v int32)` + +SetIdentitiesWithAccess sets IdentitiesWithAccess field to given value. + +### HasIdentitiesWithAccess + +`func (o *RoleInsightsInsight) HasIdentitiesWithAccess() bool` + +HasIdentitiesWithAccess returns a boolean if a field has been set. + +### GetIdentitiesImpacted + +`func (o *RoleInsightsInsight) GetIdentitiesImpacted() int32` + +GetIdentitiesImpacted returns the IdentitiesImpacted field if non-nil, zero value otherwise. + +### GetIdentitiesImpactedOk + +`func (o *RoleInsightsInsight) GetIdentitiesImpactedOk() (*int32, bool)` + +GetIdentitiesImpactedOk returns a tuple with the IdentitiesImpacted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesImpacted + +`func (o *RoleInsightsInsight) SetIdentitiesImpacted(v int32)` + +SetIdentitiesImpacted sets IdentitiesImpacted field to given value. + +### HasIdentitiesImpacted + +`func (o *RoleInsightsInsight) HasIdentitiesImpacted() bool` + +HasIdentitiesImpacted returns a boolean if a field has been set. + +### GetTotalNumberOfIdentities + +`func (o *RoleInsightsInsight) GetTotalNumberOfIdentities() int32` + +GetTotalNumberOfIdentities returns the TotalNumberOfIdentities field if non-nil, zero value otherwise. + +### GetTotalNumberOfIdentitiesOk + +`func (o *RoleInsightsInsight) GetTotalNumberOfIdentitiesOk() (*int32, bool)` + +GetTotalNumberOfIdentitiesOk returns a tuple with the TotalNumberOfIdentities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalNumberOfIdentities + +`func (o *RoleInsightsInsight) SetTotalNumberOfIdentities(v int32)` + +SetTotalNumberOfIdentities sets TotalNumberOfIdentities field to given value. + +### HasTotalNumberOfIdentities + +`func (o *RoleInsightsInsight) HasTotalNumberOfIdentities() bool` + +HasTotalNumberOfIdentities returns a boolean if a field has been set. + +### GetImpactedIdentityNames + +`func (o *RoleInsightsInsight) GetImpactedIdentityNames() string` + +GetImpactedIdentityNames returns the ImpactedIdentityNames field if non-nil, zero value otherwise. + +### GetImpactedIdentityNamesOk + +`func (o *RoleInsightsInsight) GetImpactedIdentityNamesOk() (*string, bool)` + +GetImpactedIdentityNamesOk returns a tuple with the ImpactedIdentityNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImpactedIdentityNames + +`func (o *RoleInsightsInsight) SetImpactedIdentityNames(v string)` + +SetImpactedIdentityNames sets ImpactedIdentityNames field to given value. + +### HasImpactedIdentityNames + +`func (o *RoleInsightsInsight) HasImpactedIdentityNames() bool` + +HasImpactedIdentityNames returns a boolean if a field has been set. + +### SetImpactedIdentityNamesNil + +`func (o *RoleInsightsInsight) SetImpactedIdentityNamesNil(b bool)` + + SetImpactedIdentityNamesNil sets the value for ImpactedIdentityNames to be an explicit nil + +### UnsetImpactedIdentityNames +`func (o *RoleInsightsInsight) UnsetImpactedIdentityNames()` + +UnsetImpactedIdentityNames ensures that no value is present for ImpactedIdentityNames, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsResponse.md new file mode 100644 index 000000000..b32328722 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsResponse.md @@ -0,0 +1,194 @@ +--- +id: v2024-role-insights-response +title: RoleInsightsResponse +pagination_label: RoleInsightsResponse +sidebar_label: RoleInsightsResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsResponse', 'V2024RoleInsightsResponse'] +slug: /tools/sdk/go/v2024/models/role-insights-response +tags: ['SDK', 'Software Development Kit', 'RoleInsightsResponse', 'V2024RoleInsightsResponse'] +--- + +# RoleInsightsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Request Id for a role insight generation request | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time role insights request was created. | [optional] +**LastGenerated** | Pointer to **SailPointTime** | The date-time role insights request was completed. | [optional] +**NumberOfUpdates** | Pointer to **int32** | Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED. | [optional] +**RoleIds** | Pointer to **[]string** | The role IDs that are in this request. | [optional] +**Status** | Pointer to **string** | Request status | [optional] + +## Methods + +### NewRoleInsightsResponse + +`func NewRoleInsightsResponse() *RoleInsightsResponse` + +NewRoleInsightsResponse instantiates a new RoleInsightsResponse 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 + +### NewRoleInsightsResponseWithDefaults + +`func NewRoleInsightsResponseWithDefaults() *RoleInsightsResponse` + +NewRoleInsightsResponseWithDefaults instantiates a new RoleInsightsResponse 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 + +### GetId + +`func (o *RoleInsightsResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsightsResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsightsResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsightsResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleInsightsResponse) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleInsightsResponse) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleInsightsResponse) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleInsightsResponse) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetLastGenerated + +`func (o *RoleInsightsResponse) GetLastGenerated() SailPointTime` + +GetLastGenerated returns the LastGenerated field if non-nil, zero value otherwise. + +### GetLastGeneratedOk + +`func (o *RoleInsightsResponse) GetLastGeneratedOk() (*SailPointTime, bool)` + +GetLastGeneratedOk returns a tuple with the LastGenerated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastGenerated + +`func (o *RoleInsightsResponse) SetLastGenerated(v SailPointTime)` + +SetLastGenerated sets LastGenerated field to given value. + +### HasLastGenerated + +`func (o *RoleInsightsResponse) HasLastGenerated() bool` + +HasLastGenerated returns a boolean if a field has been set. + +### GetNumberOfUpdates + +`func (o *RoleInsightsResponse) GetNumberOfUpdates() int32` + +GetNumberOfUpdates returns the NumberOfUpdates field if non-nil, zero value otherwise. + +### GetNumberOfUpdatesOk + +`func (o *RoleInsightsResponse) GetNumberOfUpdatesOk() (*int32, bool)` + +GetNumberOfUpdatesOk returns a tuple with the NumberOfUpdates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumberOfUpdates + +`func (o *RoleInsightsResponse) SetNumberOfUpdates(v int32)` + +SetNumberOfUpdates sets NumberOfUpdates field to given value. + +### HasNumberOfUpdates + +`func (o *RoleInsightsResponse) HasNumberOfUpdates() bool` + +HasNumberOfUpdates returns a boolean if a field has been set. + +### GetRoleIds + +`func (o *RoleInsightsResponse) GetRoleIds() []string` + +GetRoleIds returns the RoleIds field if non-nil, zero value otherwise. + +### GetRoleIdsOk + +`func (o *RoleInsightsResponse) GetRoleIdsOk() (*[]string, bool)` + +GetRoleIdsOk returns a tuple with the RoleIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleIds + +`func (o *RoleInsightsResponse) SetRoleIds(v []string)` + +SetRoleIds sets RoleIds field to given value. + +### HasRoleIds + +`func (o *RoleInsightsResponse) HasRoleIds() bool` + +HasRoleIds returns a boolean if a field has been set. + +### GetStatus + +`func (o *RoleInsightsResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *RoleInsightsResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *RoleInsightsResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *RoleInsightsResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsRole.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsRole.md new file mode 100644 index 000000000..2f299eb29 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsRole.md @@ -0,0 +1,168 @@ +--- +id: v2024-role-insights-role +title: RoleInsightsRole +pagination_label: RoleInsightsRole +sidebar_label: RoleInsightsRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsRole', 'V2024RoleInsightsRole'] +slug: /tools/sdk/go/v2024/models/role-insights-role +tags: ['SDK', 'Software Development Kit', 'RoleInsightsRole', 'V2024RoleInsightsRole'] +--- + +# RoleInsightsRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Role name | [optional] +**Id** | Pointer to **string** | Role id | [optional] +**Description** | Pointer to **string** | Role description | [optional] +**OwnerName** | Pointer to **string** | Role owner name | [optional] +**OwnerId** | Pointer to **string** | Role owner id | [optional] + +## Methods + +### NewRoleInsightsRole + +`func NewRoleInsightsRole() *RoleInsightsRole` + +NewRoleInsightsRole instantiates a new RoleInsightsRole 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 + +### NewRoleInsightsRoleWithDefaults + +`func NewRoleInsightsRoleWithDefaults() *RoleInsightsRole` + +NewRoleInsightsRoleWithDefaults instantiates a new RoleInsightsRole 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 + +### GetName + +`func (o *RoleInsightsRole) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleInsightsRole) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleInsightsRole) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleInsightsRole) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetId + +`func (o *RoleInsightsRole) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsightsRole) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsightsRole) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsightsRole) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleInsightsRole) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleInsightsRole) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleInsightsRole) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleInsightsRole) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwnerName + +`func (o *RoleInsightsRole) GetOwnerName() string` + +GetOwnerName returns the OwnerName field if non-nil, zero value otherwise. + +### GetOwnerNameOk + +`func (o *RoleInsightsRole) GetOwnerNameOk() (*string, bool)` + +GetOwnerNameOk returns a tuple with the OwnerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerName + +`func (o *RoleInsightsRole) SetOwnerName(v string)` + +SetOwnerName sets OwnerName field to given value. + +### HasOwnerName + +`func (o *RoleInsightsRole) HasOwnerName() bool` + +HasOwnerName returns a boolean if a field has been set. + +### GetOwnerId + +`func (o *RoleInsightsRole) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *RoleInsightsRole) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *RoleInsightsRole) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *RoleInsightsRole) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsSummary.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsSummary.md new file mode 100644 index 000000000..5d7c89418 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleInsightsSummary.md @@ -0,0 +1,194 @@ +--- +id: v2024-role-insights-summary +title: RoleInsightsSummary +pagination_label: RoleInsightsSummary +sidebar_label: RoleInsightsSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsSummary', 'V2024RoleInsightsSummary'] +slug: /tools/sdk/go/v2024/models/role-insights-summary +tags: ['SDK', 'Software Development Kit', 'RoleInsightsSummary', 'V2024RoleInsightsSummary'] +--- + +# RoleInsightsSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NumberOfUpdates** | Pointer to **int32** | Total number of roles with updates | [optional] +**LastGenerated** | Pointer to **SailPointTime** | The date-time role insights were last found. | [optional] +**EntitlementsIncludedInRoles** | Pointer to **int32** | The number of entitlements included in roles (vs free radicals). | [optional] +**TotalNumberOfEntitlements** | Pointer to **int32** | The total number of entitlements. | [optional] +**IdentitiesWithAccessViaRoles** | Pointer to **int32** | The number of identities in roles vs. identities with just entitlements and not in roles. | [optional] +**TotalNumberOfIdentities** | Pointer to **int32** | The total number of identities. | [optional] + +## Methods + +### NewRoleInsightsSummary + +`func NewRoleInsightsSummary() *RoleInsightsSummary` + +NewRoleInsightsSummary instantiates a new RoleInsightsSummary 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 + +### NewRoleInsightsSummaryWithDefaults + +`func NewRoleInsightsSummaryWithDefaults() *RoleInsightsSummary` + +NewRoleInsightsSummaryWithDefaults instantiates a new RoleInsightsSummary 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 + +### GetNumberOfUpdates + +`func (o *RoleInsightsSummary) GetNumberOfUpdates() int32` + +GetNumberOfUpdates returns the NumberOfUpdates field if non-nil, zero value otherwise. + +### GetNumberOfUpdatesOk + +`func (o *RoleInsightsSummary) GetNumberOfUpdatesOk() (*int32, bool)` + +GetNumberOfUpdatesOk returns a tuple with the NumberOfUpdates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumberOfUpdates + +`func (o *RoleInsightsSummary) SetNumberOfUpdates(v int32)` + +SetNumberOfUpdates sets NumberOfUpdates field to given value. + +### HasNumberOfUpdates + +`func (o *RoleInsightsSummary) HasNumberOfUpdates() bool` + +HasNumberOfUpdates returns a boolean if a field has been set. + +### GetLastGenerated + +`func (o *RoleInsightsSummary) GetLastGenerated() SailPointTime` + +GetLastGenerated returns the LastGenerated field if non-nil, zero value otherwise. + +### GetLastGeneratedOk + +`func (o *RoleInsightsSummary) GetLastGeneratedOk() (*SailPointTime, bool)` + +GetLastGeneratedOk returns a tuple with the LastGenerated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastGenerated + +`func (o *RoleInsightsSummary) SetLastGenerated(v SailPointTime)` + +SetLastGenerated sets LastGenerated field to given value. + +### HasLastGenerated + +`func (o *RoleInsightsSummary) HasLastGenerated() bool` + +HasLastGenerated returns a boolean if a field has been set. + +### GetEntitlementsIncludedInRoles + +`func (o *RoleInsightsSummary) GetEntitlementsIncludedInRoles() int32` + +GetEntitlementsIncludedInRoles returns the EntitlementsIncludedInRoles field if non-nil, zero value otherwise. + +### GetEntitlementsIncludedInRolesOk + +`func (o *RoleInsightsSummary) GetEntitlementsIncludedInRolesOk() (*int32, bool)` + +GetEntitlementsIncludedInRolesOk returns a tuple with the EntitlementsIncludedInRoles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementsIncludedInRoles + +`func (o *RoleInsightsSummary) SetEntitlementsIncludedInRoles(v int32)` + +SetEntitlementsIncludedInRoles sets EntitlementsIncludedInRoles field to given value. + +### HasEntitlementsIncludedInRoles + +`func (o *RoleInsightsSummary) HasEntitlementsIncludedInRoles() bool` + +HasEntitlementsIncludedInRoles returns a boolean if a field has been set. + +### GetTotalNumberOfEntitlements + +`func (o *RoleInsightsSummary) GetTotalNumberOfEntitlements() int32` + +GetTotalNumberOfEntitlements returns the TotalNumberOfEntitlements field if non-nil, zero value otherwise. + +### GetTotalNumberOfEntitlementsOk + +`func (o *RoleInsightsSummary) GetTotalNumberOfEntitlementsOk() (*int32, bool)` + +GetTotalNumberOfEntitlementsOk returns a tuple with the TotalNumberOfEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalNumberOfEntitlements + +`func (o *RoleInsightsSummary) SetTotalNumberOfEntitlements(v int32)` + +SetTotalNumberOfEntitlements sets TotalNumberOfEntitlements field to given value. + +### HasTotalNumberOfEntitlements + +`func (o *RoleInsightsSummary) HasTotalNumberOfEntitlements() bool` + +HasTotalNumberOfEntitlements returns a boolean if a field has been set. + +### GetIdentitiesWithAccessViaRoles + +`func (o *RoleInsightsSummary) GetIdentitiesWithAccessViaRoles() int32` + +GetIdentitiesWithAccessViaRoles returns the IdentitiesWithAccessViaRoles field if non-nil, zero value otherwise. + +### GetIdentitiesWithAccessViaRolesOk + +`func (o *RoleInsightsSummary) GetIdentitiesWithAccessViaRolesOk() (*int32, bool)` + +GetIdentitiesWithAccessViaRolesOk returns a tuple with the IdentitiesWithAccessViaRoles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesWithAccessViaRoles + +`func (o *RoleInsightsSummary) SetIdentitiesWithAccessViaRoles(v int32)` + +SetIdentitiesWithAccessViaRoles sets IdentitiesWithAccessViaRoles field to given value. + +### HasIdentitiesWithAccessViaRoles + +`func (o *RoleInsightsSummary) HasIdentitiesWithAccessViaRoles() bool` + +HasIdentitiesWithAccessViaRoles returns a boolean if a field has been set. + +### GetTotalNumberOfIdentities + +`func (o *RoleInsightsSummary) GetTotalNumberOfIdentities() int32` + +GetTotalNumberOfIdentities returns the TotalNumberOfIdentities field if non-nil, zero value otherwise. + +### GetTotalNumberOfIdentitiesOk + +`func (o *RoleInsightsSummary) GetTotalNumberOfIdentitiesOk() (*int32, bool)` + +GetTotalNumberOfIdentitiesOk returns a tuple with the TotalNumberOfIdentities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalNumberOfIdentities + +`func (o *RoleInsightsSummary) SetTotalNumberOfIdentities(v int32)` + +SetTotalNumberOfIdentities sets TotalNumberOfIdentities field to given value. + +### HasTotalNumberOfIdentities + +`func (o *RoleInsightsSummary) HasTotalNumberOfIdentities() bool` + +HasTotalNumberOfIdentities returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleListFilterDTO.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleListFilterDTO.md new file mode 100644 index 000000000..13f0973a8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleListFilterDTO.md @@ -0,0 +1,110 @@ +--- +id: v2024-role-list-filter-dto +title: RoleListFilterDTO +pagination_label: RoleListFilterDTO +sidebar_label: RoleListFilterDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleListFilterDTO', 'V2024RoleListFilterDTO'] +slug: /tools/sdk/go/v2024/models/role-list-filter-dto +tags: ['SDK', 'Software Development Kit', 'RoleListFilterDTO', 'V2024RoleListFilterDTO'] +--- + +# RoleListFilterDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Filters** | Pointer to **NullableString** | 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* | [optional] +**AmmKeyValues** | Pointer to [**[]RoleListFilterDTOAmmKeyValuesInner**](role-list-filter-dto-amm-key-values-inner) | | [optional] + +## Methods + +### NewRoleListFilterDTO + +`func NewRoleListFilterDTO() *RoleListFilterDTO` + +NewRoleListFilterDTO instantiates a new RoleListFilterDTO 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 + +### NewRoleListFilterDTOWithDefaults + +`func NewRoleListFilterDTOWithDefaults() *RoleListFilterDTO` + +NewRoleListFilterDTOWithDefaults instantiates a new RoleListFilterDTO 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 + +### GetFilters + +`func (o *RoleListFilterDTO) GetFilters() string` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *RoleListFilterDTO) GetFiltersOk() (*string, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *RoleListFilterDTO) SetFilters(v string)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *RoleListFilterDTO) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### SetFiltersNil + +`func (o *RoleListFilterDTO) SetFiltersNil(b bool)` + + SetFiltersNil sets the value for Filters to be an explicit nil + +### UnsetFilters +`func (o *RoleListFilterDTO) UnsetFilters()` + +UnsetFilters ensures that no value is present for Filters, not even an explicit nil +### GetAmmKeyValues + +`func (o *RoleListFilterDTO) GetAmmKeyValues() []RoleListFilterDTOAmmKeyValuesInner` + +GetAmmKeyValues returns the AmmKeyValues field if non-nil, zero value otherwise. + +### GetAmmKeyValuesOk + +`func (o *RoleListFilterDTO) GetAmmKeyValuesOk() (*[]RoleListFilterDTOAmmKeyValuesInner, bool)` + +GetAmmKeyValuesOk returns a tuple with the AmmKeyValues field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAmmKeyValues + +`func (o *RoleListFilterDTO) SetAmmKeyValues(v []RoleListFilterDTOAmmKeyValuesInner)` + +SetAmmKeyValues sets AmmKeyValues field to given value. + +### HasAmmKeyValues + +`func (o *RoleListFilterDTO) HasAmmKeyValues() bool` + +HasAmmKeyValues returns a boolean if a field has been set. + +### SetAmmKeyValuesNil + +`func (o *RoleListFilterDTO) SetAmmKeyValuesNil(b bool)` + + SetAmmKeyValuesNil sets the value for AmmKeyValues to be an explicit nil + +### UnsetAmmKeyValues +`func (o *RoleListFilterDTO) UnsetAmmKeyValues()` + +UnsetAmmKeyValues ensures that no value is present for AmmKeyValues, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleListFilterDTOAmmKeyValuesInner.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleListFilterDTOAmmKeyValuesInner.md new file mode 100644 index 000000000..3c050eb5e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleListFilterDTOAmmKeyValuesInner.md @@ -0,0 +1,90 @@ +--- +id: v2024-role-list-filter-dto-amm-key-values-inner +title: RoleListFilterDTOAmmKeyValuesInner +pagination_label: RoleListFilterDTOAmmKeyValuesInner +sidebar_label: RoleListFilterDTOAmmKeyValuesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleListFilterDTOAmmKeyValuesInner', 'V2024RoleListFilterDTOAmmKeyValuesInner'] +slug: /tools/sdk/go/v2024/models/role-list-filter-dto-amm-key-values-inner +tags: ['SDK', 'Software Development Kit', 'RoleListFilterDTOAmmKeyValuesInner', 'V2024RoleListFilterDTOAmmKeyValuesInner'] +--- + +# RoleListFilterDTOAmmKeyValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | Pointer to **string** | attribute key of a metadata. | [optional] +**Values** | Pointer to **[]string** | A list of attribute key names to filter roles. If the values is empty, will only filter by attribute key. | [optional] + +## Methods + +### NewRoleListFilterDTOAmmKeyValuesInner + +`func NewRoleListFilterDTOAmmKeyValuesInner() *RoleListFilterDTOAmmKeyValuesInner` + +NewRoleListFilterDTOAmmKeyValuesInner instantiates a new RoleListFilterDTOAmmKeyValuesInner 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 + +### NewRoleListFilterDTOAmmKeyValuesInnerWithDefaults + +`func NewRoleListFilterDTOAmmKeyValuesInnerWithDefaults() *RoleListFilterDTOAmmKeyValuesInner` + +NewRoleListFilterDTOAmmKeyValuesInnerWithDefaults instantiates a new RoleListFilterDTOAmmKeyValuesInner 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 + +### GetAttribute + +`func (o *RoleListFilterDTOAmmKeyValuesInner) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleListFilterDTOAmmKeyValuesInner) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleListFilterDTOAmmKeyValuesInner) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleListFilterDTOAmmKeyValuesInner) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValues + +`func (o *RoleListFilterDTOAmmKeyValuesInner) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *RoleListFilterDTOAmmKeyValuesInner) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *RoleListFilterDTOAmmKeyValuesInner) SetValues(v []string)` + +SetValues sets Values field to given value. + +### HasValues + +`func (o *RoleListFilterDTOAmmKeyValuesInner) HasValues() bool` + +HasValues returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMatchDto.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMatchDto.md new file mode 100644 index 000000000..db48c9caf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMatchDto.md @@ -0,0 +1,90 @@ +--- +id: v2024-role-match-dto +title: RoleMatchDto +pagination_label: RoleMatchDto +sidebar_label: RoleMatchDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMatchDto', 'V2024RoleMatchDto'] +slug: /tools/sdk/go/v2024/models/role-match-dto +tags: ['SDK', 'Software Development Kit', 'RoleMatchDto', 'V2024RoleMatchDto'] +--- + +# RoleMatchDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleRef** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] +**MatchedAttributes** | Pointer to [**[]ContextAttributeDto**](context-attribute-dto) | | [optional] + +## Methods + +### NewRoleMatchDto + +`func NewRoleMatchDto() *RoleMatchDto` + +NewRoleMatchDto instantiates a new RoleMatchDto 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 + +### NewRoleMatchDtoWithDefaults + +`func NewRoleMatchDtoWithDefaults() *RoleMatchDto` + +NewRoleMatchDtoWithDefaults instantiates a new RoleMatchDto 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 + +### GetRoleRef + +`func (o *RoleMatchDto) GetRoleRef() BaseReferenceDto` + +GetRoleRef returns the RoleRef field if non-nil, zero value otherwise. + +### GetRoleRefOk + +`func (o *RoleMatchDto) GetRoleRefOk() (*BaseReferenceDto, bool)` + +GetRoleRefOk returns a tuple with the RoleRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleRef + +`func (o *RoleMatchDto) SetRoleRef(v BaseReferenceDto)` + +SetRoleRef sets RoleRef field to given value. + +### HasRoleRef + +`func (o *RoleMatchDto) HasRoleRef() bool` + +HasRoleRef returns a boolean if a field has been set. + +### GetMatchedAttributes + +`func (o *RoleMatchDto) GetMatchedAttributes() []ContextAttributeDto` + +GetMatchedAttributes returns the MatchedAttributes field if non-nil, zero value otherwise. + +### GetMatchedAttributesOk + +`func (o *RoleMatchDto) GetMatchedAttributesOk() (*[]ContextAttributeDto, bool)` + +GetMatchedAttributesOk returns a tuple with the MatchedAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchedAttributes + +`func (o *RoleMatchDto) SetMatchedAttributes(v []ContextAttributeDto)` + +SetMatchedAttributes sets MatchedAttributes field to given value. + +### HasMatchedAttributes + +`func (o *RoleMatchDto) HasMatchedAttributes() bool` + +HasMatchedAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMembershipIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMembershipIdentity.md new file mode 100644 index 000000000..e81fa29ba --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMembershipIdentity.md @@ -0,0 +1,162 @@ +--- +id: v2024-role-membership-identity +title: RoleMembershipIdentity +pagination_label: RoleMembershipIdentity +sidebar_label: RoleMembershipIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMembershipIdentity', 'V2024RoleMembershipIdentity'] +slug: /tools/sdk/go/v2024/models/role-membership-identity +tags: ['SDK', 'Software Development Kit', 'RoleMembershipIdentity', 'V2024RoleMembershipIdentity'] +--- + +# RoleMembershipIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | Identity id | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the Identity. | [optional] +**AliasName** | Pointer to **NullableString** | User name of the Identity | [optional] + +## Methods + +### NewRoleMembershipIdentity + +`func NewRoleMembershipIdentity() *RoleMembershipIdentity` + +NewRoleMembershipIdentity instantiates a new RoleMembershipIdentity 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 + +### NewRoleMembershipIdentityWithDefaults + +`func NewRoleMembershipIdentityWithDefaults() *RoleMembershipIdentity` + +NewRoleMembershipIdentityWithDefaults instantiates a new RoleMembershipIdentity 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 + +### GetType + +`func (o *RoleMembershipIdentity) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMembershipIdentity) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMembershipIdentity) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMembershipIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RoleMembershipIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMembershipIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMembershipIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMembershipIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMembershipIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMembershipIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMembershipIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMembershipIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RoleMembershipIdentity) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RoleMembershipIdentity) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetAliasName + +`func (o *RoleMembershipIdentity) GetAliasName() string` + +GetAliasName returns the AliasName field if non-nil, zero value otherwise. + +### GetAliasNameOk + +`func (o *RoleMembershipIdentity) GetAliasNameOk() (*string, bool)` + +GetAliasNameOk returns a tuple with the AliasName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAliasName + +`func (o *RoleMembershipIdentity) SetAliasName(v string)` + +SetAliasName sets AliasName field to given value. + +### HasAliasName + +`func (o *RoleMembershipIdentity) HasAliasName() bool` + +HasAliasName returns a boolean if a field has been set. + +### SetAliasNameNil + +`func (o *RoleMembershipIdentity) SetAliasNameNil(b bool)` + + SetAliasNameNil sets the value for AliasName to be an explicit nil + +### UnsetAliasName +`func (o *RoleMembershipIdentity) UnsetAliasName()` + +UnsetAliasName ensures that no value is present for AliasName, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMembershipSelector.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMembershipSelector.md new file mode 100644 index 000000000..e0d3598bc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMembershipSelector.md @@ -0,0 +1,136 @@ +--- +id: v2024-role-membership-selector +title: RoleMembershipSelector +pagination_label: RoleMembershipSelector +sidebar_label: RoleMembershipSelector +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMembershipSelector', 'V2024RoleMembershipSelector'] +slug: /tools/sdk/go/v2024/models/role-membership-selector +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelector', 'V2024RoleMembershipSelector'] +--- + +# RoleMembershipSelector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**RoleMembershipSelectorType**](role-membership-selector-type) | | [optional] +**Criteria** | Pointer to [**NullableRoleCriteriaLevel1**](role-criteria-level1) | | [optional] +**Identities** | Pointer to [**[]RoleMembershipIdentity**](role-membership-identity) | Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. | [optional] + +## Methods + +### NewRoleMembershipSelector + +`func NewRoleMembershipSelector() *RoleMembershipSelector` + +NewRoleMembershipSelector instantiates a new RoleMembershipSelector 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 + +### NewRoleMembershipSelectorWithDefaults + +`func NewRoleMembershipSelectorWithDefaults() *RoleMembershipSelector` + +NewRoleMembershipSelectorWithDefaults instantiates a new RoleMembershipSelector 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 + +### GetType + +`func (o *RoleMembershipSelector) GetType() RoleMembershipSelectorType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMembershipSelector) GetTypeOk() (*RoleMembershipSelectorType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMembershipSelector) SetType(v RoleMembershipSelectorType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMembershipSelector) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetCriteria + +`func (o *RoleMembershipSelector) GetCriteria() RoleCriteriaLevel1` + +GetCriteria returns the Criteria field if non-nil, zero value otherwise. + +### GetCriteriaOk + +`func (o *RoleMembershipSelector) GetCriteriaOk() (*RoleCriteriaLevel1, bool)` + +GetCriteriaOk returns a tuple with the Criteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteria + +`func (o *RoleMembershipSelector) SetCriteria(v RoleCriteriaLevel1)` + +SetCriteria sets Criteria field to given value. + +### HasCriteria + +`func (o *RoleMembershipSelector) HasCriteria() bool` + +HasCriteria returns a boolean if a field has been set. + +### SetCriteriaNil + +`func (o *RoleMembershipSelector) SetCriteriaNil(b bool)` + + SetCriteriaNil sets the value for Criteria to be an explicit nil + +### UnsetCriteria +`func (o *RoleMembershipSelector) UnsetCriteria()` + +UnsetCriteria ensures that no value is present for Criteria, not even an explicit nil +### GetIdentities + +`func (o *RoleMembershipSelector) GetIdentities() []RoleMembershipIdentity` + +GetIdentities returns the Identities field if non-nil, zero value otherwise. + +### GetIdentitiesOk + +`func (o *RoleMembershipSelector) GetIdentitiesOk() (*[]RoleMembershipIdentity, bool)` + +GetIdentitiesOk returns a tuple with the Identities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentities + +`func (o *RoleMembershipSelector) SetIdentities(v []RoleMembershipIdentity)` + +SetIdentities sets Identities field to given value. + +### HasIdentities + +`func (o *RoleMembershipSelector) HasIdentities() bool` + +HasIdentities returns a boolean if a field has been set. + +### SetIdentitiesNil + +`func (o *RoleMembershipSelector) SetIdentitiesNil(b bool)` + + SetIdentitiesNil sets the value for Identities to be an explicit nil + +### UnsetIdentities +`func (o *RoleMembershipSelector) UnsetIdentities()` + +UnsetIdentities ensures that no value is present for Identities, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMembershipSelectorType.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMembershipSelectorType.md new file mode 100644 index 000000000..757a2819d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMembershipSelectorType.md @@ -0,0 +1,21 @@ +--- +id: v2024-role-membership-selector-type +title: RoleMembershipSelectorType +pagination_label: RoleMembershipSelectorType +sidebar_label: RoleMembershipSelectorType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMembershipSelectorType', 'V2024RoleMembershipSelectorType'] +slug: /tools/sdk/go/v2024/models/role-membership-selector-type +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelectorType', 'V2024RoleMembershipSelectorType'] +--- + +# RoleMembershipSelectorType + +## Enum + + +* `STANDARD` (value: `"STANDARD"`) + +* `IDENTITY_LIST` (value: `"IDENTITY_LIST"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByFilterRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByFilterRequest.md new file mode 100644 index 000000000..0413855dc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByFilterRequest.md @@ -0,0 +1,127 @@ +--- +id: v2024-role-metadata-bulk-update-by-filter-request +title: RoleMetadataBulkUpdateByFilterRequest +pagination_label: RoleMetadataBulkUpdateByFilterRequest +sidebar_label: RoleMetadataBulkUpdateByFilterRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMetadataBulkUpdateByFilterRequest', 'V2024RoleMetadataBulkUpdateByFilterRequest'] +slug: /tools/sdk/go/v2024/models/role-metadata-bulk-update-by-filter-request +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByFilterRequest', 'V2024RoleMetadataBulkUpdateByFilterRequest'] +--- + +# RoleMetadataBulkUpdateByFilterRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Filters** | **string** | Filtering is supported for the following fields and operators: **id** : *eq, in* **name** : *eq, sw* **created** : *gt, lt, ge, le* **modified** : *gt, lt, ge, le* **owner.id** : *eq, in* **requestable** : *eq* | +**Operation** | **string** | The operation to be performed | +**ReplaceScope** | Pointer to **string** | The choice of update scope. | [optional] +**Values** | [**[]RoleMetadataBulkUpdateByFilterRequestValuesInner**](role-metadata-bulk-update-by-filter-request-values-inner) | The metadata to be updated, including attribute key and value. | + +## Methods + +### NewRoleMetadataBulkUpdateByFilterRequest + +`func NewRoleMetadataBulkUpdateByFilterRequest(filters string, operation string, values []RoleMetadataBulkUpdateByFilterRequestValuesInner, ) *RoleMetadataBulkUpdateByFilterRequest` + +NewRoleMetadataBulkUpdateByFilterRequest instantiates a new RoleMetadataBulkUpdateByFilterRequest 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 + +### NewRoleMetadataBulkUpdateByFilterRequestWithDefaults + +`func NewRoleMetadataBulkUpdateByFilterRequestWithDefaults() *RoleMetadataBulkUpdateByFilterRequest` + +NewRoleMetadataBulkUpdateByFilterRequestWithDefaults instantiates a new RoleMetadataBulkUpdateByFilterRequest 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 + +### GetFilters + +`func (o *RoleMetadataBulkUpdateByFilterRequest) GetFilters() string` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *RoleMetadataBulkUpdateByFilterRequest) GetFiltersOk() (*string, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *RoleMetadataBulkUpdateByFilterRequest) SetFilters(v string)` + +SetFilters sets Filters field to given value. + + +### GetOperation + +`func (o *RoleMetadataBulkUpdateByFilterRequest) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleMetadataBulkUpdateByFilterRequest) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleMetadataBulkUpdateByFilterRequest) SetOperation(v string)` + +SetOperation sets Operation field to given value. + + +### GetReplaceScope + +`func (o *RoleMetadataBulkUpdateByFilterRequest) GetReplaceScope() string` + +GetReplaceScope returns the ReplaceScope field if non-nil, zero value otherwise. + +### GetReplaceScopeOk + +`func (o *RoleMetadataBulkUpdateByFilterRequest) GetReplaceScopeOk() (*string, bool)` + +GetReplaceScopeOk returns a tuple with the ReplaceScope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplaceScope + +`func (o *RoleMetadataBulkUpdateByFilterRequest) SetReplaceScope(v string)` + +SetReplaceScope sets ReplaceScope field to given value. + +### HasReplaceScope + +`func (o *RoleMetadataBulkUpdateByFilterRequest) HasReplaceScope() bool` + +HasReplaceScope returns a boolean if a field has been set. + +### GetValues + +`func (o *RoleMetadataBulkUpdateByFilterRequest) GetValues() []RoleMetadataBulkUpdateByFilterRequestValuesInner` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *RoleMetadataBulkUpdateByFilterRequest) GetValuesOk() (*[]RoleMetadataBulkUpdateByFilterRequestValuesInner, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *RoleMetadataBulkUpdateByFilterRequest) SetValues(v []RoleMetadataBulkUpdateByFilterRequestValuesInner)` + +SetValues sets Values field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByFilterRequestValuesInner.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByFilterRequestValuesInner.md new file mode 100644 index 000000000..ac9524432 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByFilterRequestValuesInner.md @@ -0,0 +1,95 @@ +--- +id: v2024-role-metadata-bulk-update-by-filter-request-values-inner +title: RoleMetadataBulkUpdateByFilterRequestValuesInner +pagination_label: RoleMetadataBulkUpdateByFilterRequestValuesInner +sidebar_label: RoleMetadataBulkUpdateByFilterRequestValuesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMetadataBulkUpdateByFilterRequestValuesInner', 'V2024RoleMetadataBulkUpdateByFilterRequestValuesInner'] +slug: /tools/sdk/go/v2024/models/role-metadata-bulk-update-by-filter-request-values-inner +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByFilterRequestValuesInner', 'V2024RoleMetadataBulkUpdateByFilterRequestValuesInner'] +--- + +# RoleMetadataBulkUpdateByFilterRequestValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeKey** | Pointer to **string** | the key of metadata attribute | [optional] +**Values** | **[]string** | the values of attribute to be updated | + +## Methods + +### NewRoleMetadataBulkUpdateByFilterRequestValuesInner + +`func NewRoleMetadataBulkUpdateByFilterRequestValuesInner(values []string, ) *RoleMetadataBulkUpdateByFilterRequestValuesInner` + +NewRoleMetadataBulkUpdateByFilterRequestValuesInner instantiates a new RoleMetadataBulkUpdateByFilterRequestValuesInner 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 + +### NewRoleMetadataBulkUpdateByFilterRequestValuesInnerWithDefaults + +`func NewRoleMetadataBulkUpdateByFilterRequestValuesInnerWithDefaults() *RoleMetadataBulkUpdateByFilterRequestValuesInner` + +NewRoleMetadataBulkUpdateByFilterRequestValuesInnerWithDefaults instantiates a new RoleMetadataBulkUpdateByFilterRequestValuesInner 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 + +### GetAttributeKey + +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) GetAttributeKey() string` + +GetAttributeKey returns the AttributeKey field if non-nil, zero value otherwise. + +### GetAttributeKeyOk + +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) GetAttributeKeyOk() (*string, bool)` + +GetAttributeKeyOk returns a tuple with the AttributeKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeKey + +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) SetAttributeKey(v string)` + +SetAttributeKey sets AttributeKey field to given value. + +### HasAttributeKey + +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) HasAttributeKey() bool` + +HasAttributeKey returns a boolean if a field has been set. + +### GetValues + +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### SetValuesNil + +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) SetValuesNil(b bool)` + + SetValuesNil sets the value for Values to be an explicit nil + +### UnsetValues +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) UnsetValues()` + +UnsetValues ensures that no value is present for Values, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByIdRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByIdRequest.md new file mode 100644 index 000000000..d66a9e1ef --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByIdRequest.md @@ -0,0 +1,127 @@ +--- +id: v2024-role-metadata-bulk-update-by-id-request +title: RoleMetadataBulkUpdateByIdRequest +pagination_label: RoleMetadataBulkUpdateByIdRequest +sidebar_label: RoleMetadataBulkUpdateByIdRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMetadataBulkUpdateByIdRequest', 'V2024RoleMetadataBulkUpdateByIdRequest'] +slug: /tools/sdk/go/v2024/models/role-metadata-bulk-update-by-id-request +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByIdRequest', 'V2024RoleMetadataBulkUpdateByIdRequest'] +--- + +# RoleMetadataBulkUpdateByIdRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Roles** | **[]string** | Roles' Id to be updated | +**Operation** | **string** | The operation to be performed | +**ReplaceScope** | Pointer to **string** | The choice of update scope. | [optional] +**Values** | [**[]RoleMetadataBulkUpdateByIdRequestValuesInner**](role-metadata-bulk-update-by-id-request-values-inner) | The metadata to be updated, including attribute key and value. | + +## Methods + +### NewRoleMetadataBulkUpdateByIdRequest + +`func NewRoleMetadataBulkUpdateByIdRequest(roles []string, operation string, values []RoleMetadataBulkUpdateByIdRequestValuesInner, ) *RoleMetadataBulkUpdateByIdRequest` + +NewRoleMetadataBulkUpdateByIdRequest instantiates a new RoleMetadataBulkUpdateByIdRequest 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 + +### NewRoleMetadataBulkUpdateByIdRequestWithDefaults + +`func NewRoleMetadataBulkUpdateByIdRequestWithDefaults() *RoleMetadataBulkUpdateByIdRequest` + +NewRoleMetadataBulkUpdateByIdRequestWithDefaults instantiates a new RoleMetadataBulkUpdateByIdRequest 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 + +### GetRoles + +`func (o *RoleMetadataBulkUpdateByIdRequest) GetRoles() []string` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *RoleMetadataBulkUpdateByIdRequest) GetRolesOk() (*[]string, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *RoleMetadataBulkUpdateByIdRequest) SetRoles(v []string)` + +SetRoles sets Roles field to given value. + + +### GetOperation + +`func (o *RoleMetadataBulkUpdateByIdRequest) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleMetadataBulkUpdateByIdRequest) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleMetadataBulkUpdateByIdRequest) SetOperation(v string)` + +SetOperation sets Operation field to given value. + + +### GetReplaceScope + +`func (o *RoleMetadataBulkUpdateByIdRequest) GetReplaceScope() string` + +GetReplaceScope returns the ReplaceScope field if non-nil, zero value otherwise. + +### GetReplaceScopeOk + +`func (o *RoleMetadataBulkUpdateByIdRequest) GetReplaceScopeOk() (*string, bool)` + +GetReplaceScopeOk returns a tuple with the ReplaceScope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplaceScope + +`func (o *RoleMetadataBulkUpdateByIdRequest) SetReplaceScope(v string)` + +SetReplaceScope sets ReplaceScope field to given value. + +### HasReplaceScope + +`func (o *RoleMetadataBulkUpdateByIdRequest) HasReplaceScope() bool` + +HasReplaceScope returns a boolean if a field has been set. + +### GetValues + +`func (o *RoleMetadataBulkUpdateByIdRequest) GetValues() []RoleMetadataBulkUpdateByIdRequestValuesInner` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *RoleMetadataBulkUpdateByIdRequest) GetValuesOk() (*[]RoleMetadataBulkUpdateByIdRequestValuesInner, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *RoleMetadataBulkUpdateByIdRequest) SetValues(v []RoleMetadataBulkUpdateByIdRequestValuesInner)` + +SetValues sets Values field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByIdRequestValuesInner.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByIdRequestValuesInner.md new file mode 100644 index 000000000..e1d238262 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByIdRequestValuesInner.md @@ -0,0 +1,90 @@ +--- +id: v2024-role-metadata-bulk-update-by-id-request-values-inner +title: RoleMetadataBulkUpdateByIdRequestValuesInner +pagination_label: RoleMetadataBulkUpdateByIdRequestValuesInner +sidebar_label: RoleMetadataBulkUpdateByIdRequestValuesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMetadataBulkUpdateByIdRequestValuesInner', 'V2024RoleMetadataBulkUpdateByIdRequestValuesInner'] +slug: /tools/sdk/go/v2024/models/role-metadata-bulk-update-by-id-request-values-inner +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByIdRequestValuesInner', 'V2024RoleMetadataBulkUpdateByIdRequestValuesInner'] +--- + +# RoleMetadataBulkUpdateByIdRequestValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | **string** | the key of metadata attribute | +**Values** | **[]string** | the values of attribute to be updated | + +## Methods + +### NewRoleMetadataBulkUpdateByIdRequestValuesInner + +`func NewRoleMetadataBulkUpdateByIdRequestValuesInner(attribute string, values []string, ) *RoleMetadataBulkUpdateByIdRequestValuesInner` + +NewRoleMetadataBulkUpdateByIdRequestValuesInner instantiates a new RoleMetadataBulkUpdateByIdRequestValuesInner 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 + +### NewRoleMetadataBulkUpdateByIdRequestValuesInnerWithDefaults + +`func NewRoleMetadataBulkUpdateByIdRequestValuesInnerWithDefaults() *RoleMetadataBulkUpdateByIdRequestValuesInner` + +NewRoleMetadataBulkUpdateByIdRequestValuesInnerWithDefaults instantiates a new RoleMetadataBulkUpdateByIdRequestValuesInner 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 + +### GetAttribute + +`func (o *RoleMetadataBulkUpdateByIdRequestValuesInner) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleMetadataBulkUpdateByIdRequestValuesInner) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleMetadataBulkUpdateByIdRequestValuesInner) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + + +### GetValues + +`func (o *RoleMetadataBulkUpdateByIdRequestValuesInner) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *RoleMetadataBulkUpdateByIdRequestValuesInner) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *RoleMetadataBulkUpdateByIdRequestValuesInner) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### SetValuesNil + +`func (o *RoleMetadataBulkUpdateByIdRequestValuesInner) SetValuesNil(b bool)` + + SetValuesNil sets the value for Values to be an explicit nil + +### UnsetValues +`func (o *RoleMetadataBulkUpdateByIdRequestValuesInner) UnsetValues()` + +UnsetValues ensures that no value is present for Values, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByQueryRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByQueryRequest.md new file mode 100644 index 000000000..f3d2f408d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByQueryRequest.md @@ -0,0 +1,127 @@ +--- +id: v2024-role-metadata-bulk-update-by-query-request +title: RoleMetadataBulkUpdateByQueryRequest +pagination_label: RoleMetadataBulkUpdateByQueryRequest +sidebar_label: RoleMetadataBulkUpdateByQueryRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMetadataBulkUpdateByQueryRequest', 'V2024RoleMetadataBulkUpdateByQueryRequest'] +slug: /tools/sdk/go/v2024/models/role-metadata-bulk-update-by-query-request +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByQueryRequest', 'V2024RoleMetadataBulkUpdateByQueryRequest'] +--- + +# RoleMetadataBulkUpdateByQueryRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **map[string]interface{}** | query the identities to be updated | +**Operation** | **string** | The operation to be performed | +**ReplaceScope** | Pointer to **string** | The choice of update scope. | [optional] +**Values** | [**[]RoleMetadataBulkUpdateByQueryRequestValuesInner**](role-metadata-bulk-update-by-query-request-values-inner) | The metadata to be updated, including attribute key and value. | + +## Methods + +### NewRoleMetadataBulkUpdateByQueryRequest + +`func NewRoleMetadataBulkUpdateByQueryRequest(query map[string]interface{}, operation string, values []RoleMetadataBulkUpdateByQueryRequestValuesInner, ) *RoleMetadataBulkUpdateByQueryRequest` + +NewRoleMetadataBulkUpdateByQueryRequest instantiates a new RoleMetadataBulkUpdateByQueryRequest 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 + +### NewRoleMetadataBulkUpdateByQueryRequestWithDefaults + +`func NewRoleMetadataBulkUpdateByQueryRequestWithDefaults() *RoleMetadataBulkUpdateByQueryRequest` + +NewRoleMetadataBulkUpdateByQueryRequestWithDefaults instantiates a new RoleMetadataBulkUpdateByQueryRequest 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 + +### GetQuery + +`func (o *RoleMetadataBulkUpdateByQueryRequest) GetQuery() map[string]interface{}` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *RoleMetadataBulkUpdateByQueryRequest) GetQueryOk() (*map[string]interface{}, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *RoleMetadataBulkUpdateByQueryRequest) SetQuery(v map[string]interface{})` + +SetQuery sets Query field to given value. + + +### GetOperation + +`func (o *RoleMetadataBulkUpdateByQueryRequest) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleMetadataBulkUpdateByQueryRequest) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleMetadataBulkUpdateByQueryRequest) SetOperation(v string)` + +SetOperation sets Operation field to given value. + + +### GetReplaceScope + +`func (o *RoleMetadataBulkUpdateByQueryRequest) GetReplaceScope() string` + +GetReplaceScope returns the ReplaceScope field if non-nil, zero value otherwise. + +### GetReplaceScopeOk + +`func (o *RoleMetadataBulkUpdateByQueryRequest) GetReplaceScopeOk() (*string, bool)` + +GetReplaceScopeOk returns a tuple with the ReplaceScope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplaceScope + +`func (o *RoleMetadataBulkUpdateByQueryRequest) SetReplaceScope(v string)` + +SetReplaceScope sets ReplaceScope field to given value. + +### HasReplaceScope + +`func (o *RoleMetadataBulkUpdateByQueryRequest) HasReplaceScope() bool` + +HasReplaceScope returns a boolean if a field has been set. + +### GetValues + +`func (o *RoleMetadataBulkUpdateByQueryRequest) GetValues() []RoleMetadataBulkUpdateByQueryRequestValuesInner` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *RoleMetadataBulkUpdateByQueryRequest) GetValuesOk() (*[]RoleMetadataBulkUpdateByQueryRequestValuesInner, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *RoleMetadataBulkUpdateByQueryRequest) SetValues(v []RoleMetadataBulkUpdateByQueryRequestValuesInner)` + +SetValues sets Values field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByQueryRequestValuesInner.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByQueryRequestValuesInner.md new file mode 100644 index 000000000..1566e9f03 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMetadataBulkUpdateByQueryRequestValuesInner.md @@ -0,0 +1,90 @@ +--- +id: v2024-role-metadata-bulk-update-by-query-request-values-inner +title: RoleMetadataBulkUpdateByQueryRequestValuesInner +pagination_label: RoleMetadataBulkUpdateByQueryRequestValuesInner +sidebar_label: RoleMetadataBulkUpdateByQueryRequestValuesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMetadataBulkUpdateByQueryRequestValuesInner', 'V2024RoleMetadataBulkUpdateByQueryRequestValuesInner'] +slug: /tools/sdk/go/v2024/models/role-metadata-bulk-update-by-query-request-values-inner +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByQueryRequestValuesInner', 'V2024RoleMetadataBulkUpdateByQueryRequestValuesInner'] +--- + +# RoleMetadataBulkUpdateByQueryRequestValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeKey** | Pointer to **string** | the key of metadata attribute | [optional] +**AttributeValue** | Pointer to **[]string** | the values of attribute to be updated | [optional] + +## Methods + +### NewRoleMetadataBulkUpdateByQueryRequestValuesInner + +`func NewRoleMetadataBulkUpdateByQueryRequestValuesInner() *RoleMetadataBulkUpdateByQueryRequestValuesInner` + +NewRoleMetadataBulkUpdateByQueryRequestValuesInner instantiates a new RoleMetadataBulkUpdateByQueryRequestValuesInner 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 + +### NewRoleMetadataBulkUpdateByQueryRequestValuesInnerWithDefaults + +`func NewRoleMetadataBulkUpdateByQueryRequestValuesInnerWithDefaults() *RoleMetadataBulkUpdateByQueryRequestValuesInner` + +NewRoleMetadataBulkUpdateByQueryRequestValuesInnerWithDefaults instantiates a new RoleMetadataBulkUpdateByQueryRequestValuesInner 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 + +### GetAttributeKey + +`func (o *RoleMetadataBulkUpdateByQueryRequestValuesInner) GetAttributeKey() string` + +GetAttributeKey returns the AttributeKey field if non-nil, zero value otherwise. + +### GetAttributeKeyOk + +`func (o *RoleMetadataBulkUpdateByQueryRequestValuesInner) GetAttributeKeyOk() (*string, bool)` + +GetAttributeKeyOk returns a tuple with the AttributeKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeKey + +`func (o *RoleMetadataBulkUpdateByQueryRequestValuesInner) SetAttributeKey(v string)` + +SetAttributeKey sets AttributeKey field to given value. + +### HasAttributeKey + +`func (o *RoleMetadataBulkUpdateByQueryRequestValuesInner) HasAttributeKey() bool` + +HasAttributeKey returns a boolean if a field has been set. + +### GetAttributeValue + +`func (o *RoleMetadataBulkUpdateByQueryRequestValuesInner) GetAttributeValue() []string` + +GetAttributeValue returns the AttributeValue field if non-nil, zero value otherwise. + +### GetAttributeValueOk + +`func (o *RoleMetadataBulkUpdateByQueryRequestValuesInner) GetAttributeValueOk() (*[]string, bool)` + +GetAttributeValueOk returns a tuple with the AttributeValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeValue + +`func (o *RoleMetadataBulkUpdateByQueryRequestValuesInner) SetAttributeValue(v []string)` + +SetAttributeValue sets AttributeValue field to given value. + +### HasAttributeValue + +`func (o *RoleMetadataBulkUpdateByQueryRequestValuesInner) HasAttributeValue() bool` + +HasAttributeValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningEntitlement.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningEntitlement.md new file mode 100644 index 000000000..665bead40 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningEntitlement.md @@ -0,0 +1,292 @@ +--- +id: v2024-role-mining-entitlement +title: RoleMiningEntitlement +pagination_label: RoleMiningEntitlement +sidebar_label: RoleMiningEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningEntitlement', 'V2024RoleMiningEntitlement'] +slug: /tools/sdk/go/v2024/models/role-mining-entitlement +tags: ['SDK', 'Software Development Kit', 'RoleMiningEntitlement', 'V2024RoleMiningEntitlement'] +--- + +# RoleMiningEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EntitlementRef** | Pointer to [**RoleMiningEntitlementRef**](role-mining-entitlement-ref) | | [optional] +**Name** | Pointer to **string** | Name of the entitlement | [optional] +**ApplicationName** | Pointer to **string** | Application name of the entitlement | [optional] +**IdentityCount** | Pointer to **int32** | The number of identities with this entitlement in a role. | [optional] +**Popularity** | Pointer to **float32** | The % popularity of this entitlement in a role. | [optional] +**PopularityInOrg** | Pointer to **float32** | The % popularity of this entitlement in the org. | [optional] +**SourceId** | Pointer to **string** | The ID of the source/application. | [optional] +**ActivitySourceState** | Pointer to **NullableString** | The status of activity data for the source. Value is complete or notComplete. | [optional] +**SourceUsagePercent** | Pointer to **NullableFloat32** | The percentage of identities in the potential role that have usage of the source/application of this entitlement. | [optional] + +## Methods + +### NewRoleMiningEntitlement + +`func NewRoleMiningEntitlement() *RoleMiningEntitlement` + +NewRoleMiningEntitlement instantiates a new RoleMiningEntitlement 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 + +### NewRoleMiningEntitlementWithDefaults + +`func NewRoleMiningEntitlementWithDefaults() *RoleMiningEntitlement` + +NewRoleMiningEntitlementWithDefaults instantiates a new RoleMiningEntitlement 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 + +### GetEntitlementRef + +`func (o *RoleMiningEntitlement) GetEntitlementRef() RoleMiningEntitlementRef` + +GetEntitlementRef returns the EntitlementRef field if non-nil, zero value otherwise. + +### GetEntitlementRefOk + +`func (o *RoleMiningEntitlement) GetEntitlementRefOk() (*RoleMiningEntitlementRef, bool)` + +GetEntitlementRefOk returns a tuple with the EntitlementRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementRef + +`func (o *RoleMiningEntitlement) SetEntitlementRef(v RoleMiningEntitlementRef)` + +SetEntitlementRef sets EntitlementRef field to given value. + +### HasEntitlementRef + +`func (o *RoleMiningEntitlement) HasEntitlementRef() bool` + +HasEntitlementRef returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningEntitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningEntitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningEntitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningEntitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetApplicationName + +`func (o *RoleMiningEntitlement) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *RoleMiningEntitlement) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *RoleMiningEntitlement) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *RoleMiningEntitlement) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *RoleMiningEntitlement) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *RoleMiningEntitlement) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *RoleMiningEntitlement) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *RoleMiningEntitlement) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetPopularity + +`func (o *RoleMiningEntitlement) GetPopularity() float32` + +GetPopularity returns the Popularity field if non-nil, zero value otherwise. + +### GetPopularityOk + +`func (o *RoleMiningEntitlement) GetPopularityOk() (*float32, bool)` + +GetPopularityOk returns a tuple with the Popularity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPopularity + +`func (o *RoleMiningEntitlement) SetPopularity(v float32)` + +SetPopularity sets Popularity field to given value. + +### HasPopularity + +`func (o *RoleMiningEntitlement) HasPopularity() bool` + +HasPopularity returns a boolean if a field has been set. + +### GetPopularityInOrg + +`func (o *RoleMiningEntitlement) GetPopularityInOrg() float32` + +GetPopularityInOrg returns the PopularityInOrg field if non-nil, zero value otherwise. + +### GetPopularityInOrgOk + +`func (o *RoleMiningEntitlement) GetPopularityInOrgOk() (*float32, bool)` + +GetPopularityInOrgOk returns a tuple with the PopularityInOrg field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPopularityInOrg + +`func (o *RoleMiningEntitlement) SetPopularityInOrg(v float32)` + +SetPopularityInOrg sets PopularityInOrg field to given value. + +### HasPopularityInOrg + +`func (o *RoleMiningEntitlement) HasPopularityInOrg() bool` + +HasPopularityInOrg returns a boolean if a field has been set. + +### GetSourceId + +`func (o *RoleMiningEntitlement) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *RoleMiningEntitlement) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *RoleMiningEntitlement) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *RoleMiningEntitlement) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetActivitySourceState + +`func (o *RoleMiningEntitlement) GetActivitySourceState() string` + +GetActivitySourceState returns the ActivitySourceState field if non-nil, zero value otherwise. + +### GetActivitySourceStateOk + +`func (o *RoleMiningEntitlement) GetActivitySourceStateOk() (*string, bool)` + +GetActivitySourceStateOk returns a tuple with the ActivitySourceState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActivitySourceState + +`func (o *RoleMiningEntitlement) SetActivitySourceState(v string)` + +SetActivitySourceState sets ActivitySourceState field to given value. + +### HasActivitySourceState + +`func (o *RoleMiningEntitlement) HasActivitySourceState() bool` + +HasActivitySourceState returns a boolean if a field has been set. + +### SetActivitySourceStateNil + +`func (o *RoleMiningEntitlement) SetActivitySourceStateNil(b bool)` + + SetActivitySourceStateNil sets the value for ActivitySourceState to be an explicit nil + +### UnsetActivitySourceState +`func (o *RoleMiningEntitlement) UnsetActivitySourceState()` + +UnsetActivitySourceState ensures that no value is present for ActivitySourceState, not even an explicit nil +### GetSourceUsagePercent + +`func (o *RoleMiningEntitlement) GetSourceUsagePercent() float32` + +GetSourceUsagePercent returns the SourceUsagePercent field if non-nil, zero value otherwise. + +### GetSourceUsagePercentOk + +`func (o *RoleMiningEntitlement) GetSourceUsagePercentOk() (*float32, bool)` + +GetSourceUsagePercentOk returns a tuple with the SourceUsagePercent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceUsagePercent + +`func (o *RoleMiningEntitlement) SetSourceUsagePercent(v float32)` + +SetSourceUsagePercent sets SourceUsagePercent field to given value. + +### HasSourceUsagePercent + +`func (o *RoleMiningEntitlement) HasSourceUsagePercent() bool` + +HasSourceUsagePercent returns a boolean if a field has been set. + +### SetSourceUsagePercentNil + +`func (o *RoleMiningEntitlement) SetSourceUsagePercentNil(b bool)` + + SetSourceUsagePercentNil sets the value for SourceUsagePercent to be an explicit nil + +### UnsetSourceUsagePercent +`func (o *RoleMiningEntitlement) UnsetSourceUsagePercent()` + +UnsetSourceUsagePercent ensures that no value is present for SourceUsagePercent, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningEntitlementRef.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningEntitlementRef.md new file mode 100644 index 000000000..8e58ad560 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningEntitlementRef.md @@ -0,0 +1,152 @@ +--- +id: v2024-role-mining-entitlement-ref +title: RoleMiningEntitlementRef +pagination_label: RoleMiningEntitlementRef +sidebar_label: RoleMiningEntitlementRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningEntitlementRef', 'V2024RoleMiningEntitlementRef'] +slug: /tools/sdk/go/v2024/models/role-mining-entitlement-ref +tags: ['SDK', 'Software Development Kit', 'RoleMiningEntitlementRef', 'V2024RoleMiningEntitlementRef'] +--- + +# RoleMiningEntitlementRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the entitlement | [optional] +**Name** | Pointer to **string** | Name of the entitlement | [optional] +**Description** | Pointer to **NullableString** | Description forthe entitlement | [optional] +**Attribute** | Pointer to **string** | The entitlement attribute | [optional] + +## Methods + +### NewRoleMiningEntitlementRef + +`func NewRoleMiningEntitlementRef() *RoleMiningEntitlementRef` + +NewRoleMiningEntitlementRef instantiates a new RoleMiningEntitlementRef 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 + +### NewRoleMiningEntitlementRefWithDefaults + +`func NewRoleMiningEntitlementRefWithDefaults() *RoleMiningEntitlementRef` + +NewRoleMiningEntitlementRefWithDefaults instantiates a new RoleMiningEntitlementRef 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 + +### GetId + +`func (o *RoleMiningEntitlementRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningEntitlementRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningEntitlementRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningEntitlementRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningEntitlementRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningEntitlementRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningEntitlementRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningEntitlementRef) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleMiningEntitlementRef) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleMiningEntitlementRef) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleMiningEntitlementRef) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleMiningEntitlementRef) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleMiningEntitlementRef) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleMiningEntitlementRef) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAttribute + +`func (o *RoleMiningEntitlementRef) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleMiningEntitlementRef) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleMiningEntitlementRef) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleMiningEntitlementRef) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningIdentity.md new file mode 100644 index 000000000..914c7ed82 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningIdentity.md @@ -0,0 +1,116 @@ +--- +id: v2024-role-mining-identity +title: RoleMiningIdentity +pagination_label: RoleMiningIdentity +sidebar_label: RoleMiningIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningIdentity', 'V2024RoleMiningIdentity'] +slug: /tools/sdk/go/v2024/models/role-mining-identity +tags: ['SDK', 'Software Development Kit', 'RoleMiningIdentity', 'V2024RoleMiningIdentity'] +--- + +# RoleMiningIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the identity | [optional] +**Name** | Pointer to **string** | Name of the identity | [optional] +**Attributes** | Pointer to **map[string]string** | | [optional] + +## Methods + +### NewRoleMiningIdentity + +`func NewRoleMiningIdentity() *RoleMiningIdentity` + +NewRoleMiningIdentity instantiates a new RoleMiningIdentity 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 + +### NewRoleMiningIdentityWithDefaults + +`func NewRoleMiningIdentityWithDefaults() *RoleMiningIdentity` + +NewRoleMiningIdentityWithDefaults instantiates a new RoleMiningIdentity 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 + +### GetId + +`func (o *RoleMiningIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAttributes + +`func (o *RoleMiningIdentity) GetAttributes() map[string]string` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *RoleMiningIdentity) GetAttributesOk() (*map[string]string, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *RoleMiningIdentity) SetAttributes(v map[string]string)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *RoleMiningIdentity) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningIdentityDistribution.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningIdentityDistribution.md new file mode 100644 index 000000000..f57ce42ff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningIdentityDistribution.md @@ -0,0 +1,90 @@ +--- +id: v2024-role-mining-identity-distribution +title: RoleMiningIdentityDistribution +pagination_label: RoleMiningIdentityDistribution +sidebar_label: RoleMiningIdentityDistribution +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningIdentityDistribution', 'V2024RoleMiningIdentityDistribution'] +slug: /tools/sdk/go/v2024/models/role-mining-identity-distribution +tags: ['SDK', 'Software Development Kit', 'RoleMiningIdentityDistribution', 'V2024RoleMiningIdentityDistribution'] +--- + +# RoleMiningIdentityDistribution + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeName** | Pointer to **string** | Id of the potential role | [optional] +**Distribution** | Pointer to **[]map[string]interface{}** | | [optional] + +## Methods + +### NewRoleMiningIdentityDistribution + +`func NewRoleMiningIdentityDistribution() *RoleMiningIdentityDistribution` + +NewRoleMiningIdentityDistribution instantiates a new RoleMiningIdentityDistribution 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 + +### NewRoleMiningIdentityDistributionWithDefaults + +`func NewRoleMiningIdentityDistributionWithDefaults() *RoleMiningIdentityDistribution` + +NewRoleMiningIdentityDistributionWithDefaults instantiates a new RoleMiningIdentityDistribution 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 + +### GetAttributeName + +`func (o *RoleMiningIdentityDistribution) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *RoleMiningIdentityDistribution) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *RoleMiningIdentityDistribution) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *RoleMiningIdentityDistribution) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + +### GetDistribution + +`func (o *RoleMiningIdentityDistribution) GetDistribution() []map[string]interface{}` + +GetDistribution returns the Distribution field if non-nil, zero value otherwise. + +### GetDistributionOk + +`func (o *RoleMiningIdentityDistribution) GetDistributionOk() (*[]map[string]interface{}, bool)` + +GetDistributionOk returns a tuple with the Distribution field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDistribution + +`func (o *RoleMiningIdentityDistribution) SetDistribution(v []map[string]interface{})` + +SetDistribution sets Distribution field to given value. + +### HasDistribution + +`func (o *RoleMiningIdentityDistribution) HasDistribution() bool` + +HasDistribution returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRole.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRole.md new file mode 100644 index 000000000..0a0ce9521 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRole.md @@ -0,0 +1,572 @@ +--- +id: v2024-role-mining-potential-role +title: RoleMiningPotentialRole +pagination_label: RoleMiningPotentialRole +sidebar_label: RoleMiningPotentialRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRole', 'V2024RoleMiningPotentialRole'] +slug: /tools/sdk/go/v2024/models/role-mining-potential-role +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRole', 'V2024RoleMiningPotentialRole'] +--- + +# RoleMiningPotentialRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedBy** | Pointer to [**RoleMiningSessionResponseCreatedBy**](role-mining-session-response-created-by) | | [optional] +**Density** | Pointer to **int32** | The density of a potential role. | [optional] +**Description** | Pointer to **NullableString** | The description of a potential role. | [optional] +**EntitlementCount** | Pointer to **int32** | The number of entitlements in a potential role. | [optional] +**ExcludedEntitlements** | Pointer to **[]string** | The list of entitlement ids to be excluded. | [optional] +**Freshness** | Pointer to **int32** | The freshness of a potential role. | [optional] +**IdentityCount** | Pointer to **int32** | The number of identities in a potential role. | [optional] +**IdentityDistribution** | Pointer to [**[]RoleMiningIdentityDistribution**](role-mining-identity-distribution) | Identity attribute distribution. | [optional] +**IdentityIds** | Pointer to **[]string** | The list of ids in a potential role. | [optional] +**Name** | Pointer to **string** | Name of the potential role. | [optional] +**ProvisionState** | Pointer to [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional] +**Quality** | Pointer to **int32** | The quality of a potential role. | [optional] +**RoleId** | Pointer to **NullableString** | The roleId of a potential role. | [optional] +**Saved** | Pointer to **bool** | The potential role's saved status. | [optional] +**Session** | Pointer to [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**Id** | Pointer to **string** | Id of the potential role | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time when this potential role was created. | [optional] +**ModifiedDate** | Pointer to **SailPointTime** | The date-time when this potential role was modified. | [optional] + +## Methods + +### NewRoleMiningPotentialRole + +`func NewRoleMiningPotentialRole() *RoleMiningPotentialRole` + +NewRoleMiningPotentialRole instantiates a new RoleMiningPotentialRole 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 + +### NewRoleMiningPotentialRoleWithDefaults + +`func NewRoleMiningPotentialRoleWithDefaults() *RoleMiningPotentialRole` + +NewRoleMiningPotentialRoleWithDefaults instantiates a new RoleMiningPotentialRole 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 + +### GetCreatedBy + +`func (o *RoleMiningPotentialRole) GetCreatedBy() RoleMiningSessionResponseCreatedBy` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *RoleMiningPotentialRole) GetCreatedByOk() (*RoleMiningSessionResponseCreatedBy, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *RoleMiningPotentialRole) SetCreatedBy(v RoleMiningSessionResponseCreatedBy)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *RoleMiningPotentialRole) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetDensity + +`func (o *RoleMiningPotentialRole) GetDensity() int32` + +GetDensity returns the Density field if non-nil, zero value otherwise. + +### GetDensityOk + +`func (o *RoleMiningPotentialRole) GetDensityOk() (*int32, bool)` + +GetDensityOk returns a tuple with the Density field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDensity + +`func (o *RoleMiningPotentialRole) SetDensity(v int32)` + +SetDensity sets Density field to given value. + +### HasDensity + +`func (o *RoleMiningPotentialRole) HasDensity() bool` + +HasDensity returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleMiningPotentialRole) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleMiningPotentialRole) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleMiningPotentialRole) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleMiningPotentialRole) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleMiningPotentialRole) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleMiningPotentialRole) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetEntitlementCount + +`func (o *RoleMiningPotentialRole) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *RoleMiningPotentialRole) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *RoleMiningPotentialRole) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *RoleMiningPotentialRole) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetExcludedEntitlements + +`func (o *RoleMiningPotentialRole) GetExcludedEntitlements() []string` + +GetExcludedEntitlements returns the ExcludedEntitlements field if non-nil, zero value otherwise. + +### GetExcludedEntitlementsOk + +`func (o *RoleMiningPotentialRole) GetExcludedEntitlementsOk() (*[]string, bool)` + +GetExcludedEntitlementsOk returns a tuple with the ExcludedEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludedEntitlements + +`func (o *RoleMiningPotentialRole) SetExcludedEntitlements(v []string)` + +SetExcludedEntitlements sets ExcludedEntitlements field to given value. + +### HasExcludedEntitlements + +`func (o *RoleMiningPotentialRole) HasExcludedEntitlements() bool` + +HasExcludedEntitlements returns a boolean if a field has been set. + +### SetExcludedEntitlementsNil + +`func (o *RoleMiningPotentialRole) SetExcludedEntitlementsNil(b bool)` + + SetExcludedEntitlementsNil sets the value for ExcludedEntitlements to be an explicit nil + +### UnsetExcludedEntitlements +`func (o *RoleMiningPotentialRole) UnsetExcludedEntitlements()` + +UnsetExcludedEntitlements ensures that no value is present for ExcludedEntitlements, not even an explicit nil +### GetFreshness + +`func (o *RoleMiningPotentialRole) GetFreshness() int32` + +GetFreshness returns the Freshness field if non-nil, zero value otherwise. + +### GetFreshnessOk + +`func (o *RoleMiningPotentialRole) GetFreshnessOk() (*int32, bool)` + +GetFreshnessOk returns a tuple with the Freshness field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFreshness + +`func (o *RoleMiningPotentialRole) SetFreshness(v int32)` + +SetFreshness sets Freshness field to given value. + +### HasFreshness + +`func (o *RoleMiningPotentialRole) HasFreshness() bool` + +HasFreshness returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *RoleMiningPotentialRole) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *RoleMiningPotentialRole) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *RoleMiningPotentialRole) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *RoleMiningPotentialRole) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetIdentityDistribution + +`func (o *RoleMiningPotentialRole) GetIdentityDistribution() []RoleMiningIdentityDistribution` + +GetIdentityDistribution returns the IdentityDistribution field if non-nil, zero value otherwise. + +### GetIdentityDistributionOk + +`func (o *RoleMiningPotentialRole) GetIdentityDistributionOk() (*[]RoleMiningIdentityDistribution, bool)` + +GetIdentityDistributionOk returns a tuple with the IdentityDistribution field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityDistribution + +`func (o *RoleMiningPotentialRole) SetIdentityDistribution(v []RoleMiningIdentityDistribution)` + +SetIdentityDistribution sets IdentityDistribution field to given value. + +### HasIdentityDistribution + +`func (o *RoleMiningPotentialRole) HasIdentityDistribution() bool` + +HasIdentityDistribution returns a boolean if a field has been set. + +### SetIdentityDistributionNil + +`func (o *RoleMiningPotentialRole) SetIdentityDistributionNil(b bool)` + + SetIdentityDistributionNil sets the value for IdentityDistribution to be an explicit nil + +### UnsetIdentityDistribution +`func (o *RoleMiningPotentialRole) UnsetIdentityDistribution()` + +UnsetIdentityDistribution ensures that no value is present for IdentityDistribution, not even an explicit nil +### GetIdentityIds + +`func (o *RoleMiningPotentialRole) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *RoleMiningPotentialRole) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *RoleMiningPotentialRole) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *RoleMiningPotentialRole) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningPotentialRole) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningPotentialRole) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningPotentialRole) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningPotentialRole) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetProvisionState + +`func (o *RoleMiningPotentialRole) GetProvisionState() RoleMiningPotentialRoleProvisionState` + +GetProvisionState returns the ProvisionState field if non-nil, zero value otherwise. + +### GetProvisionStateOk + +`func (o *RoleMiningPotentialRole) GetProvisionStateOk() (*RoleMiningPotentialRoleProvisionState, bool)` + +GetProvisionStateOk returns a tuple with the ProvisionState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionState + +`func (o *RoleMiningPotentialRole) SetProvisionState(v RoleMiningPotentialRoleProvisionState)` + +SetProvisionState sets ProvisionState field to given value. + +### HasProvisionState + +`func (o *RoleMiningPotentialRole) HasProvisionState() bool` + +HasProvisionState returns a boolean if a field has been set. + +### GetQuality + +`func (o *RoleMiningPotentialRole) GetQuality() int32` + +GetQuality returns the Quality field if non-nil, zero value otherwise. + +### GetQualityOk + +`func (o *RoleMiningPotentialRole) GetQualityOk() (*int32, bool)` + +GetQualityOk returns a tuple with the Quality field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuality + +`func (o *RoleMiningPotentialRole) SetQuality(v int32)` + +SetQuality sets Quality field to given value. + +### HasQuality + +`func (o *RoleMiningPotentialRole) HasQuality() bool` + +HasQuality returns a boolean if a field has been set. + +### GetRoleId + +`func (o *RoleMiningPotentialRole) GetRoleId() string` + +GetRoleId returns the RoleId field if non-nil, zero value otherwise. + +### GetRoleIdOk + +`func (o *RoleMiningPotentialRole) GetRoleIdOk() (*string, bool)` + +GetRoleIdOk returns a tuple with the RoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleId + +`func (o *RoleMiningPotentialRole) SetRoleId(v string)` + +SetRoleId sets RoleId field to given value. + +### HasRoleId + +`func (o *RoleMiningPotentialRole) HasRoleId() bool` + +HasRoleId returns a boolean if a field has been set. + +### SetRoleIdNil + +`func (o *RoleMiningPotentialRole) SetRoleIdNil(b bool)` + + SetRoleIdNil sets the value for RoleId to be an explicit nil + +### UnsetRoleId +`func (o *RoleMiningPotentialRole) UnsetRoleId()` + +UnsetRoleId ensures that no value is present for RoleId, not even an explicit nil +### GetSaved + +`func (o *RoleMiningPotentialRole) GetSaved() bool` + +GetSaved returns the Saved field if non-nil, zero value otherwise. + +### GetSavedOk + +`func (o *RoleMiningPotentialRole) GetSavedOk() (*bool, bool)` + +GetSavedOk returns a tuple with the Saved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSaved + +`func (o *RoleMiningPotentialRole) SetSaved(v bool)` + +SetSaved sets Saved field to given value. + +### HasSaved + +`func (o *RoleMiningPotentialRole) HasSaved() bool` + +HasSaved returns a boolean if a field has been set. + +### GetSession + +`func (o *RoleMiningPotentialRole) GetSession() RoleMiningSessionParametersDto` + +GetSession returns the Session field if non-nil, zero value otherwise. + +### GetSessionOk + +`func (o *RoleMiningPotentialRole) GetSessionOk() (*RoleMiningSessionParametersDto, bool)` + +GetSessionOk returns a tuple with the Session field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSession + +`func (o *RoleMiningPotentialRole) SetSession(v RoleMiningSessionParametersDto)` + +SetSession sets Session field to given value. + +### HasSession + +`func (o *RoleMiningPotentialRole) HasSession() bool` + +HasSession returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningPotentialRole) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningPotentialRole) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningPotentialRole) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningPotentialRole) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RoleMiningPotentialRole) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRole) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRole) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRole) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleMiningPotentialRole) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleMiningPotentialRole) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleMiningPotentialRole) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleMiningPotentialRole) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetModifiedDate + +`func (o *RoleMiningPotentialRole) GetModifiedDate() SailPointTime` + +GetModifiedDate returns the ModifiedDate field if non-nil, zero value otherwise. + +### GetModifiedDateOk + +`func (o *RoleMiningPotentialRole) GetModifiedDateOk() (*SailPointTime, bool)` + +GetModifiedDateOk returns a tuple with the ModifiedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedDate + +`func (o *RoleMiningPotentialRole) SetModifiedDate(v SailPointTime)` + +SetModifiedDate sets ModifiedDate field to given value. + +### HasModifiedDate + +`func (o *RoleMiningPotentialRole) HasModifiedDate() bool` + +HasModifiedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleApplication.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleApplication.md new file mode 100644 index 000000000..f8a457870 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleApplication.md @@ -0,0 +1,90 @@ +--- +id: v2024-role-mining-potential-role-application +title: RoleMiningPotentialRoleApplication +pagination_label: RoleMiningPotentialRoleApplication +sidebar_label: RoleMiningPotentialRoleApplication +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleApplication', 'V2024RoleMiningPotentialRoleApplication'] +slug: /tools/sdk/go/v2024/models/role-mining-potential-role-application +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleApplication', 'V2024RoleMiningPotentialRoleApplication'] +--- + +# RoleMiningPotentialRoleApplication + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the application | [optional] +**Name** | Pointer to **string** | Name of the application | [optional] + +## Methods + +### NewRoleMiningPotentialRoleApplication + +`func NewRoleMiningPotentialRoleApplication() *RoleMiningPotentialRoleApplication` + +NewRoleMiningPotentialRoleApplication instantiates a new RoleMiningPotentialRoleApplication 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 + +### NewRoleMiningPotentialRoleApplicationWithDefaults + +`func NewRoleMiningPotentialRoleApplicationWithDefaults() *RoleMiningPotentialRoleApplication` + +NewRoleMiningPotentialRoleApplicationWithDefaults instantiates a new RoleMiningPotentialRoleApplication 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 + +### GetId + +`func (o *RoleMiningPotentialRoleApplication) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleApplication) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleApplication) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleApplication) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningPotentialRoleApplication) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningPotentialRoleApplication) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningPotentialRoleApplication) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningPotentialRoleApplication) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleEditEntitlements.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleEditEntitlements.md new file mode 100644 index 000000000..c5df57fd5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleEditEntitlements.md @@ -0,0 +1,90 @@ +--- +id: v2024-role-mining-potential-role-edit-entitlements +title: RoleMiningPotentialRoleEditEntitlements +pagination_label: RoleMiningPotentialRoleEditEntitlements +sidebar_label: RoleMiningPotentialRoleEditEntitlements +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleEditEntitlements', 'V2024RoleMiningPotentialRoleEditEntitlements'] +slug: /tools/sdk/go/v2024/models/role-mining-potential-role-edit-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleEditEntitlements', 'V2024RoleMiningPotentialRoleEditEntitlements'] +--- + +# RoleMiningPotentialRoleEditEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]string** | The list of entitlement ids to be edited | [optional] +**Exclude** | Pointer to **bool** | If true, add ids to be exclusion list. If false, remove ids from the exclusion list. | [optional] + +## Methods + +### NewRoleMiningPotentialRoleEditEntitlements + +`func NewRoleMiningPotentialRoleEditEntitlements() *RoleMiningPotentialRoleEditEntitlements` + +NewRoleMiningPotentialRoleEditEntitlements instantiates a new RoleMiningPotentialRoleEditEntitlements 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 + +### NewRoleMiningPotentialRoleEditEntitlementsWithDefaults + +`func NewRoleMiningPotentialRoleEditEntitlementsWithDefaults() *RoleMiningPotentialRoleEditEntitlements` + +NewRoleMiningPotentialRoleEditEntitlementsWithDefaults instantiates a new RoleMiningPotentialRoleEditEntitlements 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 + +### GetIds + +`func (o *RoleMiningPotentialRoleEditEntitlements) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *RoleMiningPotentialRoleEditEntitlements) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *RoleMiningPotentialRoleEditEntitlements) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *RoleMiningPotentialRoleEditEntitlements) HasIds() bool` + +HasIds returns a boolean if a field has been set. + +### GetExclude + +`func (o *RoleMiningPotentialRoleEditEntitlements) GetExclude() bool` + +GetExclude returns the Exclude field if non-nil, zero value otherwise. + +### GetExcludeOk + +`func (o *RoleMiningPotentialRoleEditEntitlements) GetExcludeOk() (*bool, bool)` + +GetExcludeOk returns a tuple with the Exclude field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExclude + +`func (o *RoleMiningPotentialRoleEditEntitlements) SetExclude(v bool)` + +SetExclude sets Exclude field to given value. + +### HasExclude + +`func (o *RoleMiningPotentialRoleEditEntitlements) HasExclude() bool` + +HasExclude returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleEntitlements.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleEntitlements.md new file mode 100644 index 000000000..f1511ea94 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleEntitlements.md @@ -0,0 +1,90 @@ +--- +id: v2024-role-mining-potential-role-entitlements +title: RoleMiningPotentialRoleEntitlements +pagination_label: RoleMiningPotentialRoleEntitlements +sidebar_label: RoleMiningPotentialRoleEntitlements +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleEntitlements', 'V2024RoleMiningPotentialRoleEntitlements'] +slug: /tools/sdk/go/v2024/models/role-mining-potential-role-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleEntitlements', 'V2024RoleMiningPotentialRoleEntitlements'] +--- + +# RoleMiningPotentialRoleEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the entitlement | [optional] +**Name** | Pointer to **string** | Name of the entitlement | [optional] + +## Methods + +### NewRoleMiningPotentialRoleEntitlements + +`func NewRoleMiningPotentialRoleEntitlements() *RoleMiningPotentialRoleEntitlements` + +NewRoleMiningPotentialRoleEntitlements instantiates a new RoleMiningPotentialRoleEntitlements 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 + +### NewRoleMiningPotentialRoleEntitlementsWithDefaults + +`func NewRoleMiningPotentialRoleEntitlementsWithDefaults() *RoleMiningPotentialRoleEntitlements` + +NewRoleMiningPotentialRoleEntitlementsWithDefaults instantiates a new RoleMiningPotentialRoleEntitlements 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 + +### GetId + +`func (o *RoleMiningPotentialRoleEntitlements) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleEntitlements) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleEntitlements) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleEntitlements) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningPotentialRoleEntitlements) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningPotentialRoleEntitlements) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningPotentialRoleEntitlements) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningPotentialRoleEntitlements) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleExportRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleExportRequest.md new file mode 100644 index 000000000..3fa524d01 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleExportRequest.md @@ -0,0 +1,90 @@ +--- +id: v2024-role-mining-potential-role-export-request +title: RoleMiningPotentialRoleExportRequest +pagination_label: RoleMiningPotentialRoleExportRequest +sidebar_label: RoleMiningPotentialRoleExportRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleExportRequest', 'V2024RoleMiningPotentialRoleExportRequest'] +slug: /tools/sdk/go/v2024/models/role-mining-potential-role-export-request +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportRequest', 'V2024RoleMiningPotentialRoleExportRequest'] +--- + +# RoleMiningPotentialRoleExportRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MinEntitlementPopularity** | Pointer to **int32** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [optional] +**IncludeCommonAccess** | Pointer to **bool** | If false, do not include entitlements that are highly popular among the entire orginization | [optional] + +## Methods + +### NewRoleMiningPotentialRoleExportRequest + +`func NewRoleMiningPotentialRoleExportRequest() *RoleMiningPotentialRoleExportRequest` + +NewRoleMiningPotentialRoleExportRequest instantiates a new RoleMiningPotentialRoleExportRequest 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 + +### NewRoleMiningPotentialRoleExportRequestWithDefaults + +`func NewRoleMiningPotentialRoleExportRequestWithDefaults() *RoleMiningPotentialRoleExportRequest` + +NewRoleMiningPotentialRoleExportRequestWithDefaults instantiates a new RoleMiningPotentialRoleExportRequest 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 + +### GetMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportRequest) GetMinEntitlementPopularity() int32` + +GetMinEntitlementPopularity returns the MinEntitlementPopularity field if non-nil, zero value otherwise. + +### GetMinEntitlementPopularityOk + +`func (o *RoleMiningPotentialRoleExportRequest) GetMinEntitlementPopularityOk() (*int32, bool)` + +GetMinEntitlementPopularityOk returns a tuple with the MinEntitlementPopularity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportRequest) SetMinEntitlementPopularity(v int32)` + +SetMinEntitlementPopularity sets MinEntitlementPopularity field to given value. + +### HasMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportRequest) HasMinEntitlementPopularity() bool` + +HasMinEntitlementPopularity returns a boolean if a field has been set. + +### GetIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportRequest) GetIncludeCommonAccess() bool` + +GetIncludeCommonAccess returns the IncludeCommonAccess field if non-nil, zero value otherwise. + +### GetIncludeCommonAccessOk + +`func (o *RoleMiningPotentialRoleExportRequest) GetIncludeCommonAccessOk() (*bool, bool)` + +GetIncludeCommonAccessOk returns a tuple with the IncludeCommonAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportRequest) SetIncludeCommonAccess(v bool)` + +SetIncludeCommonAccess sets IncludeCommonAccess field to given value. + +### HasIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportRequest) HasIncludeCommonAccess() bool` + +HasIncludeCommonAccess returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleExportResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleExportResponse.md new file mode 100644 index 000000000..a13a14152 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleExportResponse.md @@ -0,0 +1,142 @@ +--- +id: v2024-role-mining-potential-role-export-response +title: RoleMiningPotentialRoleExportResponse +pagination_label: RoleMiningPotentialRoleExportResponse +sidebar_label: RoleMiningPotentialRoleExportResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleExportResponse', 'V2024RoleMiningPotentialRoleExportResponse'] +slug: /tools/sdk/go/v2024/models/role-mining-potential-role-export-response +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportResponse', 'V2024RoleMiningPotentialRoleExportResponse'] +--- + +# RoleMiningPotentialRoleExportResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MinEntitlementPopularity** | Pointer to **int32** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [optional] +**IncludeCommonAccess** | Pointer to **bool** | If false, do not include entitlements that are highly popular among the entire orginization | [optional] +**ExportId** | Pointer to **string** | ID used to reference this export | [optional] +**Status** | Pointer to [**RoleMiningPotentialRoleExportState**](role-mining-potential-role-export-state) | | [optional] + +## Methods + +### NewRoleMiningPotentialRoleExportResponse + +`func NewRoleMiningPotentialRoleExportResponse() *RoleMiningPotentialRoleExportResponse` + +NewRoleMiningPotentialRoleExportResponse instantiates a new RoleMiningPotentialRoleExportResponse 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 + +### NewRoleMiningPotentialRoleExportResponseWithDefaults + +`func NewRoleMiningPotentialRoleExportResponseWithDefaults() *RoleMiningPotentialRoleExportResponse` + +NewRoleMiningPotentialRoleExportResponseWithDefaults instantiates a new RoleMiningPotentialRoleExportResponse 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 + +### GetMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportResponse) GetMinEntitlementPopularity() int32` + +GetMinEntitlementPopularity returns the MinEntitlementPopularity field if non-nil, zero value otherwise. + +### GetMinEntitlementPopularityOk + +`func (o *RoleMiningPotentialRoleExportResponse) GetMinEntitlementPopularityOk() (*int32, bool)` + +GetMinEntitlementPopularityOk returns a tuple with the MinEntitlementPopularity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportResponse) SetMinEntitlementPopularity(v int32)` + +SetMinEntitlementPopularity sets MinEntitlementPopularity field to given value. + +### HasMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportResponse) HasMinEntitlementPopularity() bool` + +HasMinEntitlementPopularity returns a boolean if a field has been set. + +### GetIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportResponse) GetIncludeCommonAccess() bool` + +GetIncludeCommonAccess returns the IncludeCommonAccess field if non-nil, zero value otherwise. + +### GetIncludeCommonAccessOk + +`func (o *RoleMiningPotentialRoleExportResponse) GetIncludeCommonAccessOk() (*bool, bool)` + +GetIncludeCommonAccessOk returns a tuple with the IncludeCommonAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportResponse) SetIncludeCommonAccess(v bool)` + +SetIncludeCommonAccess sets IncludeCommonAccess field to given value. + +### HasIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportResponse) HasIncludeCommonAccess() bool` + +HasIncludeCommonAccess returns a boolean if a field has been set. + +### GetExportId + +`func (o *RoleMiningPotentialRoleExportResponse) GetExportId() string` + +GetExportId returns the ExportId field if non-nil, zero value otherwise. + +### GetExportIdOk + +`func (o *RoleMiningPotentialRoleExportResponse) GetExportIdOk() (*string, bool)` + +GetExportIdOk returns a tuple with the ExportId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExportId + +`func (o *RoleMiningPotentialRoleExportResponse) SetExportId(v string)` + +SetExportId sets ExportId field to given value. + +### HasExportId + +`func (o *RoleMiningPotentialRoleExportResponse) HasExportId() bool` + +HasExportId returns a boolean if a field has been set. + +### GetStatus + +`func (o *RoleMiningPotentialRoleExportResponse) GetStatus() RoleMiningPotentialRoleExportState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *RoleMiningPotentialRoleExportResponse) GetStatusOk() (*RoleMiningPotentialRoleExportState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *RoleMiningPotentialRoleExportResponse) SetStatus(v RoleMiningPotentialRoleExportState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *RoleMiningPotentialRoleExportResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleExportState.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleExportState.md new file mode 100644 index 000000000..0d670f323 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleExportState.md @@ -0,0 +1,25 @@ +--- +id: v2024-role-mining-potential-role-export-state +title: RoleMiningPotentialRoleExportState +pagination_label: RoleMiningPotentialRoleExportState +sidebar_label: RoleMiningPotentialRoleExportState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleExportState', 'V2024RoleMiningPotentialRoleExportState'] +slug: /tools/sdk/go/v2024/models/role-mining-potential-role-export-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportState', 'V2024RoleMiningPotentialRoleExportState'] +--- + +# RoleMiningPotentialRoleExportState + +## Enum + + +* `QUEUED` (value: `"QUEUED"`) + +* `IN_PROGRESS` (value: `"IN_PROGRESS"`) + +* `SUCCESS` (value: `"SUCCESS"`) + +* `ERROR` (value: `"ERROR"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleProvisionRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleProvisionRequest.md new file mode 100644 index 000000000..e615a42f0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleProvisionRequest.md @@ -0,0 +1,168 @@ +--- +id: v2024-role-mining-potential-role-provision-request +title: RoleMiningPotentialRoleProvisionRequest +pagination_label: RoleMiningPotentialRoleProvisionRequest +sidebar_label: RoleMiningPotentialRoleProvisionRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleProvisionRequest', 'V2024RoleMiningPotentialRoleProvisionRequest'] +slug: /tools/sdk/go/v2024/models/role-mining-potential-role-provision-request +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleProvisionRequest', 'V2024RoleMiningPotentialRoleProvisionRequest'] +--- + +# RoleMiningPotentialRoleProvisionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleName** | Pointer to **string** | Name of the new role being created | [optional] +**RoleDescription** | Pointer to **string** | Short description of the new role being created | [optional] +**OwnerId** | Pointer to **string** | ID of the identity that will own this role | [optional] +**IncludeIdentities** | Pointer to **bool** | When true, create access requests for the identities associated with the potential role | [optional] [default to false] +**DirectlyAssignedEntitlements** | Pointer to **bool** | When true, assign entitlements directly to the role; otherwise, create access profiles containing the entitlements | [optional] [default to false] + +## Methods + +### NewRoleMiningPotentialRoleProvisionRequest + +`func NewRoleMiningPotentialRoleProvisionRequest() *RoleMiningPotentialRoleProvisionRequest` + +NewRoleMiningPotentialRoleProvisionRequest instantiates a new RoleMiningPotentialRoleProvisionRequest 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 + +### NewRoleMiningPotentialRoleProvisionRequestWithDefaults + +`func NewRoleMiningPotentialRoleProvisionRequestWithDefaults() *RoleMiningPotentialRoleProvisionRequest` + +NewRoleMiningPotentialRoleProvisionRequestWithDefaults instantiates a new RoleMiningPotentialRoleProvisionRequest 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 + +### GetRoleName + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetRoleName() string` + +GetRoleName returns the RoleName field if non-nil, zero value otherwise. + +### GetRoleNameOk + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetRoleNameOk() (*string, bool)` + +GetRoleNameOk returns a tuple with the RoleName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleName + +`func (o *RoleMiningPotentialRoleProvisionRequest) SetRoleName(v string)` + +SetRoleName sets RoleName field to given value. + +### HasRoleName + +`func (o *RoleMiningPotentialRoleProvisionRequest) HasRoleName() bool` + +HasRoleName returns a boolean if a field has been set. + +### GetRoleDescription + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetRoleDescription() string` + +GetRoleDescription returns the RoleDescription field if non-nil, zero value otherwise. + +### GetRoleDescriptionOk + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetRoleDescriptionOk() (*string, bool)` + +GetRoleDescriptionOk returns a tuple with the RoleDescription field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleDescription + +`func (o *RoleMiningPotentialRoleProvisionRequest) SetRoleDescription(v string)` + +SetRoleDescription sets RoleDescription field to given value. + +### HasRoleDescription + +`func (o *RoleMiningPotentialRoleProvisionRequest) HasRoleDescription() bool` + +HasRoleDescription returns a boolean if a field has been set. + +### GetOwnerId + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *RoleMiningPotentialRoleProvisionRequest) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *RoleMiningPotentialRoleProvisionRequest) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + +### GetIncludeIdentities + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetIncludeIdentities() bool` + +GetIncludeIdentities returns the IncludeIdentities field if non-nil, zero value otherwise. + +### GetIncludeIdentitiesOk + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetIncludeIdentitiesOk() (*bool, bool)` + +GetIncludeIdentitiesOk returns a tuple with the IncludeIdentities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeIdentities + +`func (o *RoleMiningPotentialRoleProvisionRequest) SetIncludeIdentities(v bool)` + +SetIncludeIdentities sets IncludeIdentities field to given value. + +### HasIncludeIdentities + +`func (o *RoleMiningPotentialRoleProvisionRequest) HasIncludeIdentities() bool` + +HasIncludeIdentities returns a boolean if a field has been set. + +### GetDirectlyAssignedEntitlements + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetDirectlyAssignedEntitlements() bool` + +GetDirectlyAssignedEntitlements returns the DirectlyAssignedEntitlements field if non-nil, zero value otherwise. + +### GetDirectlyAssignedEntitlementsOk + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetDirectlyAssignedEntitlementsOk() (*bool, bool)` + +GetDirectlyAssignedEntitlementsOk returns a tuple with the DirectlyAssignedEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectlyAssignedEntitlements + +`func (o *RoleMiningPotentialRoleProvisionRequest) SetDirectlyAssignedEntitlements(v bool)` + +SetDirectlyAssignedEntitlements sets DirectlyAssignedEntitlements field to given value. + +### HasDirectlyAssignedEntitlements + +`func (o *RoleMiningPotentialRoleProvisionRequest) HasDirectlyAssignedEntitlements() bool` + +HasDirectlyAssignedEntitlements returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleProvisionState.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleProvisionState.md new file mode 100644 index 000000000..dfec40257 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleProvisionState.md @@ -0,0 +1,25 @@ +--- +id: v2024-role-mining-potential-role-provision-state +title: RoleMiningPotentialRoleProvisionState +pagination_label: RoleMiningPotentialRoleProvisionState +sidebar_label: RoleMiningPotentialRoleProvisionState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleProvisionState', 'V2024RoleMiningPotentialRoleProvisionState'] +slug: /tools/sdk/go/v2024/models/role-mining-potential-role-provision-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleProvisionState', 'V2024RoleMiningPotentialRoleProvisionState'] +--- + +# RoleMiningPotentialRoleProvisionState + +## Enum + + +* `POTENTIAL` (value: `"POTENTIAL"`) + +* `PENDING` (value: `"PENDING"`) + +* `COMPLETE` (value: `"COMPLETE"`) + +* `FAILED` (value: `"FAILED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleRef.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleRef.md new file mode 100644 index 000000000..dfcb75cfc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleRef.md @@ -0,0 +1,90 @@ +--- +id: v2024-role-mining-potential-role-ref +title: RoleMiningPotentialRoleRef +pagination_label: RoleMiningPotentialRoleRef +sidebar_label: RoleMiningPotentialRoleRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleRef', 'V2024RoleMiningPotentialRoleRef'] +slug: /tools/sdk/go/v2024/models/role-mining-potential-role-ref +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleRef', 'V2024RoleMiningPotentialRoleRef'] +--- + +# RoleMiningPotentialRoleRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the potential role | [optional] +**Name** | Pointer to **string** | Name of the potential role | [optional] + +## Methods + +### NewRoleMiningPotentialRoleRef + +`func NewRoleMiningPotentialRoleRef() *RoleMiningPotentialRoleRef` + +NewRoleMiningPotentialRoleRef instantiates a new RoleMiningPotentialRoleRef 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 + +### NewRoleMiningPotentialRoleRefWithDefaults + +`func NewRoleMiningPotentialRoleRefWithDefaults() *RoleMiningPotentialRoleRef` + +NewRoleMiningPotentialRoleRefWithDefaults instantiates a new RoleMiningPotentialRoleRef 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 + +### GetId + +`func (o *RoleMiningPotentialRoleRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningPotentialRoleRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningPotentialRoleRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningPotentialRoleRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningPotentialRoleRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleSourceUsage.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleSourceUsage.md new file mode 100644 index 000000000..03485fa03 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleSourceUsage.md @@ -0,0 +1,142 @@ +--- +id: v2024-role-mining-potential-role-source-usage +title: RoleMiningPotentialRoleSourceUsage +pagination_label: RoleMiningPotentialRoleSourceUsage +sidebar_label: RoleMiningPotentialRoleSourceUsage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleSourceUsage', 'V2024RoleMiningPotentialRoleSourceUsage'] +slug: /tools/sdk/go/v2024/models/role-mining-potential-role-source-usage +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSourceUsage', 'V2024RoleMiningPotentialRoleSourceUsage'] +--- + +# RoleMiningPotentialRoleSourceUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity ID | [optional] +**DisplayName** | Pointer to **string** | Display name for the identity | [optional] +**Email** | Pointer to **string** | Email address for the identity | [optional] +**UsageCount** | Pointer to **int32** | The number of days there has been usage of the source by the identity. | [optional] + +## Methods + +### NewRoleMiningPotentialRoleSourceUsage + +`func NewRoleMiningPotentialRoleSourceUsage() *RoleMiningPotentialRoleSourceUsage` + +NewRoleMiningPotentialRoleSourceUsage instantiates a new RoleMiningPotentialRoleSourceUsage 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 + +### NewRoleMiningPotentialRoleSourceUsageWithDefaults + +`func NewRoleMiningPotentialRoleSourceUsageWithDefaults() *RoleMiningPotentialRoleSourceUsage` + +NewRoleMiningPotentialRoleSourceUsageWithDefaults instantiates a new RoleMiningPotentialRoleSourceUsage 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 + +### GetId + +`func (o *RoleMiningPotentialRoleSourceUsage) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleSourceUsage) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleSourceUsage) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleSourceUsage) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *RoleMiningPotentialRoleSourceUsage) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *RoleMiningPotentialRoleSourceUsage) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *RoleMiningPotentialRoleSourceUsage) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *RoleMiningPotentialRoleSourceUsage) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetEmail + +`func (o *RoleMiningPotentialRoleSourceUsage) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *RoleMiningPotentialRoleSourceUsage) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *RoleMiningPotentialRoleSourceUsage) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *RoleMiningPotentialRoleSourceUsage) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetUsageCount + +`func (o *RoleMiningPotentialRoleSourceUsage) GetUsageCount() int32` + +GetUsageCount returns the UsageCount field if non-nil, zero value otherwise. + +### GetUsageCountOk + +`func (o *RoleMiningPotentialRoleSourceUsage) GetUsageCountOk() (*int32, bool)` + +GetUsageCountOk returns a tuple with the UsageCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsageCount + +`func (o *RoleMiningPotentialRoleSourceUsage) SetUsageCount(v int32)` + +SetUsageCount sets UsageCount field to given value. + +### HasUsageCount + +`func (o *RoleMiningPotentialRoleSourceUsage) HasUsageCount() bool` + +HasUsageCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleSummary.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleSummary.md new file mode 100644 index 000000000..bae7e9657 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleSummary.md @@ -0,0 +1,500 @@ +--- +id: v2024-role-mining-potential-role-summary +title: RoleMiningPotentialRoleSummary +pagination_label: RoleMiningPotentialRoleSummary +sidebar_label: RoleMiningPotentialRoleSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleSummary', 'V2024RoleMiningPotentialRoleSummary'] +slug: /tools/sdk/go/v2024/models/role-mining-potential-role-summary +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummary', 'V2024RoleMiningPotentialRoleSummary'] +--- + +# RoleMiningPotentialRoleSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the potential role | [optional] +**Name** | Pointer to **string** | Name of the potential role | [optional] +**PotentialRoleRef** | Pointer to [**RoleMiningPotentialRoleRef**](role-mining-potential-role-ref) | | [optional] +**IdentityCount** | Pointer to **int32** | The number of identities in a potential role. | [optional] +**EntitlementCount** | Pointer to **int32** | The number of entitlements in a potential role. | [optional] +**IdentityGroupStatus** | Pointer to **string** | The status for this identity group which can be \"REQUESTED\" or \"OBTAINED\" | [optional] +**ProvisionState** | Pointer to [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional] +**RoleId** | Pointer to **NullableString** | ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. | [optional] +**Density** | Pointer to **int32** | The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. | [optional] +**Freshness** | Pointer to **int32** | The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. | [optional] +**Quality** | Pointer to **int32** | The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**CreatedBy** | Pointer to [**RoleMiningPotentialRoleSummaryCreatedBy**](role-mining-potential-role-summary-created-by) | | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time when this potential role was created. | [optional] +**Saved** | Pointer to **bool** | The potential role's saved status | [optional] [default to false] +**Description** | Pointer to **NullableString** | Description of the potential role | [optional] +**Session** | Pointer to [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional] + +## Methods + +### NewRoleMiningPotentialRoleSummary + +`func NewRoleMiningPotentialRoleSummary() *RoleMiningPotentialRoleSummary` + +NewRoleMiningPotentialRoleSummary instantiates a new RoleMiningPotentialRoleSummary 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 + +### NewRoleMiningPotentialRoleSummaryWithDefaults + +`func NewRoleMiningPotentialRoleSummaryWithDefaults() *RoleMiningPotentialRoleSummary` + +NewRoleMiningPotentialRoleSummaryWithDefaults instantiates a new RoleMiningPotentialRoleSummary 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 + +### GetId + +`func (o *RoleMiningPotentialRoleSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleSummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleSummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningPotentialRoleSummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningPotentialRoleSummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningPotentialRoleSummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningPotentialRoleSummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPotentialRoleRef + +`func (o *RoleMiningPotentialRoleSummary) GetPotentialRoleRef() RoleMiningPotentialRoleRef` + +GetPotentialRoleRef returns the PotentialRoleRef field if non-nil, zero value otherwise. + +### GetPotentialRoleRefOk + +`func (o *RoleMiningPotentialRoleSummary) GetPotentialRoleRefOk() (*RoleMiningPotentialRoleRef, bool)` + +GetPotentialRoleRefOk returns a tuple with the PotentialRoleRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPotentialRoleRef + +`func (o *RoleMiningPotentialRoleSummary) SetPotentialRoleRef(v RoleMiningPotentialRoleRef)` + +SetPotentialRoleRef sets PotentialRoleRef field to given value. + +### HasPotentialRoleRef + +`func (o *RoleMiningPotentialRoleSummary) HasPotentialRoleRef() bool` + +HasPotentialRoleRef returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *RoleMiningPotentialRoleSummary) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *RoleMiningPotentialRoleSummary) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *RoleMiningPotentialRoleSummary) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *RoleMiningPotentialRoleSummary) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *RoleMiningPotentialRoleSummary) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *RoleMiningPotentialRoleSummary) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *RoleMiningPotentialRoleSummary) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *RoleMiningPotentialRoleSummary) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetIdentityGroupStatus + +`func (o *RoleMiningPotentialRoleSummary) GetIdentityGroupStatus() string` + +GetIdentityGroupStatus returns the IdentityGroupStatus field if non-nil, zero value otherwise. + +### GetIdentityGroupStatusOk + +`func (o *RoleMiningPotentialRoleSummary) GetIdentityGroupStatusOk() (*string, bool)` + +GetIdentityGroupStatusOk returns a tuple with the IdentityGroupStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityGroupStatus + +`func (o *RoleMiningPotentialRoleSummary) SetIdentityGroupStatus(v string)` + +SetIdentityGroupStatus sets IdentityGroupStatus field to given value. + +### HasIdentityGroupStatus + +`func (o *RoleMiningPotentialRoleSummary) HasIdentityGroupStatus() bool` + +HasIdentityGroupStatus returns a boolean if a field has been set. + +### GetProvisionState + +`func (o *RoleMiningPotentialRoleSummary) GetProvisionState() RoleMiningPotentialRoleProvisionState` + +GetProvisionState returns the ProvisionState field if non-nil, zero value otherwise. + +### GetProvisionStateOk + +`func (o *RoleMiningPotentialRoleSummary) GetProvisionStateOk() (*RoleMiningPotentialRoleProvisionState, bool)` + +GetProvisionStateOk returns a tuple with the ProvisionState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionState + +`func (o *RoleMiningPotentialRoleSummary) SetProvisionState(v RoleMiningPotentialRoleProvisionState)` + +SetProvisionState sets ProvisionState field to given value. + +### HasProvisionState + +`func (o *RoleMiningPotentialRoleSummary) HasProvisionState() bool` + +HasProvisionState returns a boolean if a field has been set. + +### GetRoleId + +`func (o *RoleMiningPotentialRoleSummary) GetRoleId() string` + +GetRoleId returns the RoleId field if non-nil, zero value otherwise. + +### GetRoleIdOk + +`func (o *RoleMiningPotentialRoleSummary) GetRoleIdOk() (*string, bool)` + +GetRoleIdOk returns a tuple with the RoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleId + +`func (o *RoleMiningPotentialRoleSummary) SetRoleId(v string)` + +SetRoleId sets RoleId field to given value. + +### HasRoleId + +`func (o *RoleMiningPotentialRoleSummary) HasRoleId() bool` + +HasRoleId returns a boolean if a field has been set. + +### SetRoleIdNil + +`func (o *RoleMiningPotentialRoleSummary) SetRoleIdNil(b bool)` + + SetRoleIdNil sets the value for RoleId to be an explicit nil + +### UnsetRoleId +`func (o *RoleMiningPotentialRoleSummary) UnsetRoleId()` + +UnsetRoleId ensures that no value is present for RoleId, not even an explicit nil +### GetDensity + +`func (o *RoleMiningPotentialRoleSummary) GetDensity() int32` + +GetDensity returns the Density field if non-nil, zero value otherwise. + +### GetDensityOk + +`func (o *RoleMiningPotentialRoleSummary) GetDensityOk() (*int32, bool)` + +GetDensityOk returns a tuple with the Density field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDensity + +`func (o *RoleMiningPotentialRoleSummary) SetDensity(v int32)` + +SetDensity sets Density field to given value. + +### HasDensity + +`func (o *RoleMiningPotentialRoleSummary) HasDensity() bool` + +HasDensity returns a boolean if a field has been set. + +### GetFreshness + +`func (o *RoleMiningPotentialRoleSummary) GetFreshness() int32` + +GetFreshness returns the Freshness field if non-nil, zero value otherwise. + +### GetFreshnessOk + +`func (o *RoleMiningPotentialRoleSummary) GetFreshnessOk() (*int32, bool)` + +GetFreshnessOk returns a tuple with the Freshness field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFreshness + +`func (o *RoleMiningPotentialRoleSummary) SetFreshness(v int32)` + +SetFreshness sets Freshness field to given value. + +### HasFreshness + +`func (o *RoleMiningPotentialRoleSummary) HasFreshness() bool` + +HasFreshness returns a boolean if a field has been set. + +### GetQuality + +`func (o *RoleMiningPotentialRoleSummary) GetQuality() int32` + +GetQuality returns the Quality field if non-nil, zero value otherwise. + +### GetQualityOk + +`func (o *RoleMiningPotentialRoleSummary) GetQualityOk() (*int32, bool)` + +GetQualityOk returns a tuple with the Quality field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuality + +`func (o *RoleMiningPotentialRoleSummary) SetQuality(v int32)` + +SetQuality sets Quality field to given value. + +### HasQuality + +`func (o *RoleMiningPotentialRoleSummary) HasQuality() bool` + +HasQuality returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningPotentialRoleSummary) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningPotentialRoleSummary) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningPotentialRoleSummary) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningPotentialRoleSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetCreatedBy + +`func (o *RoleMiningPotentialRoleSummary) GetCreatedBy() RoleMiningPotentialRoleSummaryCreatedBy` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *RoleMiningPotentialRoleSummary) GetCreatedByOk() (*RoleMiningPotentialRoleSummaryCreatedBy, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *RoleMiningPotentialRoleSummary) SetCreatedBy(v RoleMiningPotentialRoleSummaryCreatedBy)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *RoleMiningPotentialRoleSummary) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleMiningPotentialRoleSummary) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleMiningPotentialRoleSummary) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleMiningPotentialRoleSummary) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleMiningPotentialRoleSummary) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetSaved + +`func (o *RoleMiningPotentialRoleSummary) GetSaved() bool` + +GetSaved returns the Saved field if non-nil, zero value otherwise. + +### GetSavedOk + +`func (o *RoleMiningPotentialRoleSummary) GetSavedOk() (*bool, bool)` + +GetSavedOk returns a tuple with the Saved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSaved + +`func (o *RoleMiningPotentialRoleSummary) SetSaved(v bool)` + +SetSaved sets Saved field to given value. + +### HasSaved + +`func (o *RoleMiningPotentialRoleSummary) HasSaved() bool` + +HasSaved returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleMiningPotentialRoleSummary) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleMiningPotentialRoleSummary) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleMiningPotentialRoleSummary) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleMiningPotentialRoleSummary) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleMiningPotentialRoleSummary) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleMiningPotentialRoleSummary) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSession + +`func (o *RoleMiningPotentialRoleSummary) GetSession() RoleMiningSessionParametersDto` + +GetSession returns the Session field if non-nil, zero value otherwise. + +### GetSessionOk + +`func (o *RoleMiningPotentialRoleSummary) GetSessionOk() (*RoleMiningSessionParametersDto, bool)` + +GetSessionOk returns a tuple with the Session field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSession + +`func (o *RoleMiningPotentialRoleSummary) SetSession(v RoleMiningSessionParametersDto)` + +SetSession sets Session field to given value. + +### HasSession + +`func (o *RoleMiningPotentialRoleSummary) HasSession() bool` + +HasSession returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleSummaryCreatedBy.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleSummaryCreatedBy.md new file mode 100644 index 000000000..1fe73e038 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningPotentialRoleSummaryCreatedBy.md @@ -0,0 +1,90 @@ +--- +id: v2024-role-mining-potential-role-summary-created-by +title: RoleMiningPotentialRoleSummaryCreatedBy +pagination_label: RoleMiningPotentialRoleSummaryCreatedBy +sidebar_label: RoleMiningPotentialRoleSummaryCreatedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleSummaryCreatedBy', 'V2024RoleMiningPotentialRoleSummaryCreatedBy'] +slug: /tools/sdk/go/v2024/models/role-mining-potential-role-summary-created-by +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummaryCreatedBy', 'V2024RoleMiningPotentialRoleSummaryCreatedBy'] +--- + +# RoleMiningPotentialRoleSummaryCreatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the creator | [optional] +**DisplayName** | Pointer to **string** | The display name of the creator | [optional] + +## Methods + +### NewRoleMiningPotentialRoleSummaryCreatedBy + +`func NewRoleMiningPotentialRoleSummaryCreatedBy() *RoleMiningPotentialRoleSummaryCreatedBy` + +NewRoleMiningPotentialRoleSummaryCreatedBy instantiates a new RoleMiningPotentialRoleSummaryCreatedBy 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 + +### NewRoleMiningPotentialRoleSummaryCreatedByWithDefaults + +`func NewRoleMiningPotentialRoleSummaryCreatedByWithDefaults() *RoleMiningPotentialRoleSummaryCreatedBy` + +NewRoleMiningPotentialRoleSummaryCreatedByWithDefaults instantiates a new RoleMiningPotentialRoleSummaryCreatedBy 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 + +### GetId + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningRoleType.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningRoleType.md new file mode 100644 index 000000000..7644c0607 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningRoleType.md @@ -0,0 +1,21 @@ +--- +id: v2024-role-mining-role-type +title: RoleMiningRoleType +pagination_label: RoleMiningRoleType +sidebar_label: RoleMiningRoleType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningRoleType', 'V2024RoleMiningRoleType'] +slug: /tools/sdk/go/v2024/models/role-mining-role-type +tags: ['SDK', 'Software Development Kit', 'RoleMiningRoleType', 'V2024RoleMiningRoleType'] +--- + +# RoleMiningRoleType + +## Enum + + +* `SPECIALIZED` (value: `"SPECIALIZED"`) + +* `COMMON` (value: `"COMMON"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionDraftRoleDto.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionDraftRoleDto.md new file mode 100644 index 000000000..d3931a8cd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionDraftRoleDto.md @@ -0,0 +1,298 @@ +--- +id: v2024-role-mining-session-draft-role-dto +title: RoleMiningSessionDraftRoleDto +pagination_label: RoleMiningSessionDraftRoleDto +sidebar_label: RoleMiningSessionDraftRoleDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionDraftRoleDto', 'V2024RoleMiningSessionDraftRoleDto'] +slug: /tools/sdk/go/v2024/models/role-mining-session-draft-role-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionDraftRoleDto', 'V2024RoleMiningSessionDraftRoleDto'] +--- + +# RoleMiningSessionDraftRoleDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the draft role | [optional] +**Description** | Pointer to **string** | Draft role description | [optional] +**IdentityIds** | Pointer to **[]string** | The list of identities for this role mining session. | [optional] +**EntitlementIds** | Pointer to **[]string** | The list of entitlement ids for this role mining session. | [optional] +**ExcludedEntitlements** | Pointer to **[]string** | The list of excluded entitlement ids. | [optional] +**Modified** | Pointer to **SailPointTime** | Last modified date | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**Id** | Pointer to **string** | Id of the potential draft role | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time when this potential draft role was created. | [optional] +**ModifiedDate** | Pointer to **SailPointTime** | The date-time when this potential draft role was modified. | [optional] + +## Methods + +### NewRoleMiningSessionDraftRoleDto + +`func NewRoleMiningSessionDraftRoleDto() *RoleMiningSessionDraftRoleDto` + +NewRoleMiningSessionDraftRoleDto instantiates a new RoleMiningSessionDraftRoleDto 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 + +### NewRoleMiningSessionDraftRoleDtoWithDefaults + +`func NewRoleMiningSessionDraftRoleDtoWithDefaults() *RoleMiningSessionDraftRoleDto` + +NewRoleMiningSessionDraftRoleDtoWithDefaults instantiates a new RoleMiningSessionDraftRoleDto 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 + +### GetName + +`func (o *RoleMiningSessionDraftRoleDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningSessionDraftRoleDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningSessionDraftRoleDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningSessionDraftRoleDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleMiningSessionDraftRoleDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleMiningSessionDraftRoleDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleMiningSessionDraftRoleDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleMiningSessionDraftRoleDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIdentityIds + +`func (o *RoleMiningSessionDraftRoleDto) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *RoleMiningSessionDraftRoleDto) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *RoleMiningSessionDraftRoleDto) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *RoleMiningSessionDraftRoleDto) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + +### GetEntitlementIds + +`func (o *RoleMiningSessionDraftRoleDto) GetEntitlementIds() []string` + +GetEntitlementIds returns the EntitlementIds field if non-nil, zero value otherwise. + +### GetEntitlementIdsOk + +`func (o *RoleMiningSessionDraftRoleDto) GetEntitlementIdsOk() (*[]string, bool)` + +GetEntitlementIdsOk returns a tuple with the EntitlementIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementIds + +`func (o *RoleMiningSessionDraftRoleDto) SetEntitlementIds(v []string)` + +SetEntitlementIds sets EntitlementIds field to given value. + +### HasEntitlementIds + +`func (o *RoleMiningSessionDraftRoleDto) HasEntitlementIds() bool` + +HasEntitlementIds returns a boolean if a field has been set. + +### GetExcludedEntitlements + +`func (o *RoleMiningSessionDraftRoleDto) GetExcludedEntitlements() []string` + +GetExcludedEntitlements returns the ExcludedEntitlements field if non-nil, zero value otherwise. + +### GetExcludedEntitlementsOk + +`func (o *RoleMiningSessionDraftRoleDto) GetExcludedEntitlementsOk() (*[]string, bool)` + +GetExcludedEntitlementsOk returns a tuple with the ExcludedEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludedEntitlements + +`func (o *RoleMiningSessionDraftRoleDto) SetExcludedEntitlements(v []string)` + +SetExcludedEntitlements sets ExcludedEntitlements field to given value. + +### HasExcludedEntitlements + +`func (o *RoleMiningSessionDraftRoleDto) HasExcludedEntitlements() bool` + +HasExcludedEntitlements returns a boolean if a field has been set. + +### GetModified + +`func (o *RoleMiningSessionDraftRoleDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RoleMiningSessionDraftRoleDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RoleMiningSessionDraftRoleDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RoleMiningSessionDraftRoleDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningSessionDraftRoleDto) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningSessionDraftRoleDto) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningSessionDraftRoleDto) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningSessionDraftRoleDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RoleMiningSessionDraftRoleDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningSessionDraftRoleDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningSessionDraftRoleDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningSessionDraftRoleDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleMiningSessionDraftRoleDto) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleMiningSessionDraftRoleDto) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleMiningSessionDraftRoleDto) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleMiningSessionDraftRoleDto) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetModifiedDate + +`func (o *RoleMiningSessionDraftRoleDto) GetModifiedDate() SailPointTime` + +GetModifiedDate returns the ModifiedDate field if non-nil, zero value otherwise. + +### GetModifiedDateOk + +`func (o *RoleMiningSessionDraftRoleDto) GetModifiedDateOk() (*SailPointTime, bool)` + +GetModifiedDateOk returns a tuple with the ModifiedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedDate + +`func (o *RoleMiningSessionDraftRoleDto) SetModifiedDate(v SailPointTime)` + +SetModifiedDate sets ModifiedDate field to given value. + +### HasModifiedDate + +`func (o *RoleMiningSessionDraftRoleDto) HasModifiedDate() bool` + +HasModifiedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionDto.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionDto.md new file mode 100644 index 000000000..9acd6cb88 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionDto.md @@ -0,0 +1,374 @@ +--- +id: v2024-role-mining-session-dto +title: RoleMiningSessionDto +pagination_label: RoleMiningSessionDto +sidebar_label: RoleMiningSessionDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionDto', 'V2024RoleMiningSessionDto'] +slug: /tools/sdk/go/v2024/models/role-mining-session-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionDto', 'V2024RoleMiningSessionDto'] +--- + +# RoleMiningSessionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**PruneThreshold** | Pointer to **NullableInt32** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [optional] +**PrescribedPruneThreshold** | Pointer to **NullableInt32** | The calculated prescribedPruneThreshold | [optional] +**MinNumIdentitiesInPotentialRole** | Pointer to **NullableInt32** | Minimum number of identities in a potential role | [optional] +**PotentialRoleCount** | Pointer to **int32** | Number of potential roles | [optional] +**PotentialRolesReadyCount** | Pointer to **int32** | Number of potential roles ready | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**EmailRecipientId** | Pointer to **NullableString** | The id of the user who will receive an email about the role mining session | [optional] +**IdentityCount** | Pointer to **int32** | Number of identities in the population which meet the search criteria or identity list provided | [optional] +**Saved** | Pointer to **bool** | The session's saved status | [optional] [default to false] +**Name** | Pointer to **NullableString** | The session's saved name | [optional] + +## Methods + +### NewRoleMiningSessionDto + +`func NewRoleMiningSessionDto() *RoleMiningSessionDto` + +NewRoleMiningSessionDto instantiates a new RoleMiningSessionDto 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 + +### NewRoleMiningSessionDtoWithDefaults + +`func NewRoleMiningSessionDtoWithDefaults() *RoleMiningSessionDto` + +NewRoleMiningSessionDtoWithDefaults instantiates a new RoleMiningSessionDto 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 + +### GetScope + +`func (o *RoleMiningSessionDto) GetScope() RoleMiningSessionScope` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *RoleMiningSessionDto) GetScopeOk() (*RoleMiningSessionScope, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *RoleMiningSessionDto) SetScope(v RoleMiningSessionScope)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *RoleMiningSessionDto) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### GetPruneThreshold + +`func (o *RoleMiningSessionDto) GetPruneThreshold() int32` + +GetPruneThreshold returns the PruneThreshold field if non-nil, zero value otherwise. + +### GetPruneThresholdOk + +`func (o *RoleMiningSessionDto) GetPruneThresholdOk() (*int32, bool)` + +GetPruneThresholdOk returns a tuple with the PruneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPruneThreshold + +`func (o *RoleMiningSessionDto) SetPruneThreshold(v int32)` + +SetPruneThreshold sets PruneThreshold field to given value. + +### HasPruneThreshold + +`func (o *RoleMiningSessionDto) HasPruneThreshold() bool` + +HasPruneThreshold returns a boolean if a field has been set. + +### SetPruneThresholdNil + +`func (o *RoleMiningSessionDto) SetPruneThresholdNil(b bool)` + + SetPruneThresholdNil sets the value for PruneThreshold to be an explicit nil + +### UnsetPruneThreshold +`func (o *RoleMiningSessionDto) UnsetPruneThreshold()` + +UnsetPruneThreshold ensures that no value is present for PruneThreshold, not even an explicit nil +### GetPrescribedPruneThreshold + +`func (o *RoleMiningSessionDto) GetPrescribedPruneThreshold() int32` + +GetPrescribedPruneThreshold returns the PrescribedPruneThreshold field if non-nil, zero value otherwise. + +### GetPrescribedPruneThresholdOk + +`func (o *RoleMiningSessionDto) GetPrescribedPruneThresholdOk() (*int32, bool)` + +GetPrescribedPruneThresholdOk returns a tuple with the PrescribedPruneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrescribedPruneThreshold + +`func (o *RoleMiningSessionDto) SetPrescribedPruneThreshold(v int32)` + +SetPrescribedPruneThreshold sets PrescribedPruneThreshold field to given value. + +### HasPrescribedPruneThreshold + +`func (o *RoleMiningSessionDto) HasPrescribedPruneThreshold() bool` + +HasPrescribedPruneThreshold returns a boolean if a field has been set. + +### SetPrescribedPruneThresholdNil + +`func (o *RoleMiningSessionDto) SetPrescribedPruneThresholdNil(b bool)` + + SetPrescribedPruneThresholdNil sets the value for PrescribedPruneThreshold to be an explicit nil + +### UnsetPrescribedPruneThreshold +`func (o *RoleMiningSessionDto) UnsetPrescribedPruneThreshold()` + +UnsetPrescribedPruneThreshold ensures that no value is present for PrescribedPruneThreshold, not even an explicit nil +### GetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionDto) GetMinNumIdentitiesInPotentialRole() int32` + +GetMinNumIdentitiesInPotentialRole returns the MinNumIdentitiesInPotentialRole field if non-nil, zero value otherwise. + +### GetMinNumIdentitiesInPotentialRoleOk + +`func (o *RoleMiningSessionDto) GetMinNumIdentitiesInPotentialRoleOk() (*int32, bool)` + +GetMinNumIdentitiesInPotentialRoleOk returns a tuple with the MinNumIdentitiesInPotentialRole field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionDto) SetMinNumIdentitiesInPotentialRole(v int32)` + +SetMinNumIdentitiesInPotentialRole sets MinNumIdentitiesInPotentialRole field to given value. + +### HasMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionDto) HasMinNumIdentitiesInPotentialRole() bool` + +HasMinNumIdentitiesInPotentialRole returns a boolean if a field has been set. + +### SetMinNumIdentitiesInPotentialRoleNil + +`func (o *RoleMiningSessionDto) SetMinNumIdentitiesInPotentialRoleNil(b bool)` + + SetMinNumIdentitiesInPotentialRoleNil sets the value for MinNumIdentitiesInPotentialRole to be an explicit nil + +### UnsetMinNumIdentitiesInPotentialRole +`func (o *RoleMiningSessionDto) UnsetMinNumIdentitiesInPotentialRole()` + +UnsetMinNumIdentitiesInPotentialRole ensures that no value is present for MinNumIdentitiesInPotentialRole, not even an explicit nil +### GetPotentialRoleCount + +`func (o *RoleMiningSessionDto) GetPotentialRoleCount() int32` + +GetPotentialRoleCount returns the PotentialRoleCount field if non-nil, zero value otherwise. + +### GetPotentialRoleCountOk + +`func (o *RoleMiningSessionDto) GetPotentialRoleCountOk() (*int32, bool)` + +GetPotentialRoleCountOk returns a tuple with the PotentialRoleCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPotentialRoleCount + +`func (o *RoleMiningSessionDto) SetPotentialRoleCount(v int32)` + +SetPotentialRoleCount sets PotentialRoleCount field to given value. + +### HasPotentialRoleCount + +`func (o *RoleMiningSessionDto) HasPotentialRoleCount() bool` + +HasPotentialRoleCount returns a boolean if a field has been set. + +### GetPotentialRolesReadyCount + +`func (o *RoleMiningSessionDto) GetPotentialRolesReadyCount() int32` + +GetPotentialRolesReadyCount returns the PotentialRolesReadyCount field if non-nil, zero value otherwise. + +### GetPotentialRolesReadyCountOk + +`func (o *RoleMiningSessionDto) GetPotentialRolesReadyCountOk() (*int32, bool)` + +GetPotentialRolesReadyCountOk returns a tuple with the PotentialRolesReadyCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPotentialRolesReadyCount + +`func (o *RoleMiningSessionDto) SetPotentialRolesReadyCount(v int32)` + +SetPotentialRolesReadyCount sets PotentialRolesReadyCount field to given value. + +### HasPotentialRolesReadyCount + +`func (o *RoleMiningSessionDto) HasPotentialRolesReadyCount() bool` + +HasPotentialRolesReadyCount returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningSessionDto) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningSessionDto) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningSessionDto) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningSessionDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetEmailRecipientId + +`func (o *RoleMiningSessionDto) GetEmailRecipientId() string` + +GetEmailRecipientId returns the EmailRecipientId field if non-nil, zero value otherwise. + +### GetEmailRecipientIdOk + +`func (o *RoleMiningSessionDto) GetEmailRecipientIdOk() (*string, bool)` + +GetEmailRecipientIdOk returns a tuple with the EmailRecipientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailRecipientId + +`func (o *RoleMiningSessionDto) SetEmailRecipientId(v string)` + +SetEmailRecipientId sets EmailRecipientId field to given value. + +### HasEmailRecipientId + +`func (o *RoleMiningSessionDto) HasEmailRecipientId() bool` + +HasEmailRecipientId returns a boolean if a field has been set. + +### SetEmailRecipientIdNil + +`func (o *RoleMiningSessionDto) SetEmailRecipientIdNil(b bool)` + + SetEmailRecipientIdNil sets the value for EmailRecipientId to be an explicit nil + +### UnsetEmailRecipientId +`func (o *RoleMiningSessionDto) UnsetEmailRecipientId()` + +UnsetEmailRecipientId ensures that no value is present for EmailRecipientId, not even an explicit nil +### GetIdentityCount + +`func (o *RoleMiningSessionDto) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *RoleMiningSessionDto) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *RoleMiningSessionDto) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *RoleMiningSessionDto) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetSaved + +`func (o *RoleMiningSessionDto) GetSaved() bool` + +GetSaved returns the Saved field if non-nil, zero value otherwise. + +### GetSavedOk + +`func (o *RoleMiningSessionDto) GetSavedOk() (*bool, bool)` + +GetSavedOk returns a tuple with the Saved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSaved + +`func (o *RoleMiningSessionDto) SetSaved(v bool)` + +SetSaved sets Saved field to given value. + +### HasSaved + +`func (o *RoleMiningSessionDto) HasSaved() bool` + +HasSaved returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningSessionDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningSessionDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningSessionDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningSessionDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RoleMiningSessionDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RoleMiningSessionDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionParametersDto.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionParametersDto.md new file mode 100644 index 000000000..1d3841e91 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionParametersDto.md @@ -0,0 +1,302 @@ +--- +id: v2024-role-mining-session-parameters-dto +title: RoleMiningSessionParametersDto +pagination_label: RoleMiningSessionParametersDto +sidebar_label: RoleMiningSessionParametersDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionParametersDto', 'V2024RoleMiningSessionParametersDto'] +slug: /tools/sdk/go/v2024/models/role-mining-session-parameters-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionParametersDto', 'V2024RoleMiningSessionParametersDto'] +--- + +# RoleMiningSessionParametersDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the role mining session | [optional] +**Name** | Pointer to **NullableString** | The session's saved name | [optional] +**MinNumIdentitiesInPotentialRole** | Pointer to **NullableInt32** | Minimum number of identities in a potential role | [optional] +**PruneThreshold** | Pointer to **NullableInt32** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [optional] +**Saved** | Pointer to **bool** | The session's saved status | [optional] [default to true] +**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**State** | Pointer to [**RoleMiningSessionState**](role-mining-session-state) | | [optional] +**ScopingMethod** | Pointer to [**RoleMiningSessionScopingMethod**](role-mining-session-scoping-method) | | [optional] + +## Methods + +### NewRoleMiningSessionParametersDto + +`func NewRoleMiningSessionParametersDto() *RoleMiningSessionParametersDto` + +NewRoleMiningSessionParametersDto instantiates a new RoleMiningSessionParametersDto 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 + +### NewRoleMiningSessionParametersDtoWithDefaults + +`func NewRoleMiningSessionParametersDtoWithDefaults() *RoleMiningSessionParametersDto` + +NewRoleMiningSessionParametersDtoWithDefaults instantiates a new RoleMiningSessionParametersDto 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 + +### GetId + +`func (o *RoleMiningSessionParametersDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningSessionParametersDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningSessionParametersDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningSessionParametersDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningSessionParametersDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningSessionParametersDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningSessionParametersDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningSessionParametersDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RoleMiningSessionParametersDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RoleMiningSessionParametersDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionParametersDto) GetMinNumIdentitiesInPotentialRole() int32` + +GetMinNumIdentitiesInPotentialRole returns the MinNumIdentitiesInPotentialRole field if non-nil, zero value otherwise. + +### GetMinNumIdentitiesInPotentialRoleOk + +`func (o *RoleMiningSessionParametersDto) GetMinNumIdentitiesInPotentialRoleOk() (*int32, bool)` + +GetMinNumIdentitiesInPotentialRoleOk returns a tuple with the MinNumIdentitiesInPotentialRole field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionParametersDto) SetMinNumIdentitiesInPotentialRole(v int32)` + +SetMinNumIdentitiesInPotentialRole sets MinNumIdentitiesInPotentialRole field to given value. + +### HasMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionParametersDto) HasMinNumIdentitiesInPotentialRole() bool` + +HasMinNumIdentitiesInPotentialRole returns a boolean if a field has been set. + +### SetMinNumIdentitiesInPotentialRoleNil + +`func (o *RoleMiningSessionParametersDto) SetMinNumIdentitiesInPotentialRoleNil(b bool)` + + SetMinNumIdentitiesInPotentialRoleNil sets the value for MinNumIdentitiesInPotentialRole to be an explicit nil + +### UnsetMinNumIdentitiesInPotentialRole +`func (o *RoleMiningSessionParametersDto) UnsetMinNumIdentitiesInPotentialRole()` + +UnsetMinNumIdentitiesInPotentialRole ensures that no value is present for MinNumIdentitiesInPotentialRole, not even an explicit nil +### GetPruneThreshold + +`func (o *RoleMiningSessionParametersDto) GetPruneThreshold() int32` + +GetPruneThreshold returns the PruneThreshold field if non-nil, zero value otherwise. + +### GetPruneThresholdOk + +`func (o *RoleMiningSessionParametersDto) GetPruneThresholdOk() (*int32, bool)` + +GetPruneThresholdOk returns a tuple with the PruneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPruneThreshold + +`func (o *RoleMiningSessionParametersDto) SetPruneThreshold(v int32)` + +SetPruneThreshold sets PruneThreshold field to given value. + +### HasPruneThreshold + +`func (o *RoleMiningSessionParametersDto) HasPruneThreshold() bool` + +HasPruneThreshold returns a boolean if a field has been set. + +### SetPruneThresholdNil + +`func (o *RoleMiningSessionParametersDto) SetPruneThresholdNil(b bool)` + + SetPruneThresholdNil sets the value for PruneThreshold to be an explicit nil + +### UnsetPruneThreshold +`func (o *RoleMiningSessionParametersDto) UnsetPruneThreshold()` + +UnsetPruneThreshold ensures that no value is present for PruneThreshold, not even an explicit nil +### GetSaved + +`func (o *RoleMiningSessionParametersDto) GetSaved() bool` + +GetSaved returns the Saved field if non-nil, zero value otherwise. + +### GetSavedOk + +`func (o *RoleMiningSessionParametersDto) GetSavedOk() (*bool, bool)` + +GetSavedOk returns a tuple with the Saved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSaved + +`func (o *RoleMiningSessionParametersDto) SetSaved(v bool)` + +SetSaved sets Saved field to given value. + +### HasSaved + +`func (o *RoleMiningSessionParametersDto) HasSaved() bool` + +HasSaved returns a boolean if a field has been set. + +### GetScope + +`func (o *RoleMiningSessionParametersDto) GetScope() RoleMiningSessionScope` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *RoleMiningSessionParametersDto) GetScopeOk() (*RoleMiningSessionScope, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *RoleMiningSessionParametersDto) SetScope(v RoleMiningSessionScope)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *RoleMiningSessionParametersDto) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningSessionParametersDto) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningSessionParametersDto) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningSessionParametersDto) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningSessionParametersDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetState + +`func (o *RoleMiningSessionParametersDto) GetState() RoleMiningSessionState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *RoleMiningSessionParametersDto) GetStateOk() (*RoleMiningSessionState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *RoleMiningSessionParametersDto) SetState(v RoleMiningSessionState)` + +SetState sets State field to given value. + +### HasState + +`func (o *RoleMiningSessionParametersDto) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetScopingMethod + +`func (o *RoleMiningSessionParametersDto) GetScopingMethod() RoleMiningSessionScopingMethod` + +GetScopingMethod returns the ScopingMethod field if non-nil, zero value otherwise. + +### GetScopingMethodOk + +`func (o *RoleMiningSessionParametersDto) GetScopingMethodOk() (*RoleMiningSessionScopingMethod, bool)` + +GetScopingMethodOk returns a tuple with the ScopingMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScopingMethod + +`func (o *RoleMiningSessionParametersDto) SetScopingMethod(v RoleMiningSessionScopingMethod)` + +SetScopingMethod sets ScopingMethod field to given value. + +### HasScopingMethod + +`func (o *RoleMiningSessionParametersDto) HasScopingMethod() bool` + +HasScopingMethod returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionResponse.md new file mode 100644 index 000000000..0ccdaf343 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionResponse.md @@ -0,0 +1,576 @@ +--- +id: v2024-role-mining-session-response +title: RoleMiningSessionResponse +pagination_label: RoleMiningSessionResponse +sidebar_label: RoleMiningSessionResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionResponse', 'V2024RoleMiningSessionResponse'] +slug: /tools/sdk/go/v2024/models/role-mining-session-response +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionResponse', 'V2024RoleMiningSessionResponse'] +--- + +# RoleMiningSessionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**MinNumIdentitiesInPotentialRole** | Pointer to **NullableInt32** | Minimum number of identities in a potential role | [optional] +**ScopingMethod** | Pointer to **NullableString** | The scoping method of the role mining session | [optional] +**PrescribedPruneThreshold** | Pointer to **NullableInt32** | The computed (or prescribed) prune threshold for this session | [optional] +**PruneThreshold** | Pointer to **NullableInt32** | The prune threshold to be used for this role mining session | [optional] +**PotentialRoleCount** | Pointer to **int32** | The number of potential roles | [optional] +**PotentialRolesReadyCount** | Pointer to **int32** | The number of potential roles which have completed processing | [optional] +**Status** | Pointer to [**RoleMiningSessionStatus**](role-mining-session-status) | | [optional] +**EmailRecipientId** | Pointer to **NullableString** | The id of the user who will receive an email about the role mining session | [optional] +**CreatedBy** | Pointer to [**RoleMiningSessionResponseCreatedBy**](role-mining-session-response-created-by) | | [optional] +**IdentityCount** | Pointer to **int32** | The number of identities | [optional] +**Saved** | Pointer to **bool** | The session's saved status | [optional] [default to false] +**Name** | Pointer to **NullableString** | The session's saved name | [optional] +**DataFilePath** | Pointer to **NullableString** | The data file path of the role mining session | [optional] +**Id** | Pointer to **string** | Session Id for this role mining session | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time when this role mining session was created. | [optional] +**ModifiedDate** | Pointer to **SailPointTime** | The date-time when this role mining session was completed. | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] + +## Methods + +### NewRoleMiningSessionResponse + +`func NewRoleMiningSessionResponse() *RoleMiningSessionResponse` + +NewRoleMiningSessionResponse instantiates a new RoleMiningSessionResponse 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 + +### NewRoleMiningSessionResponseWithDefaults + +`func NewRoleMiningSessionResponseWithDefaults() *RoleMiningSessionResponse` + +NewRoleMiningSessionResponseWithDefaults instantiates a new RoleMiningSessionResponse 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 + +### GetScope + +`func (o *RoleMiningSessionResponse) GetScope() RoleMiningSessionScope` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *RoleMiningSessionResponse) GetScopeOk() (*RoleMiningSessionScope, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *RoleMiningSessionResponse) SetScope(v RoleMiningSessionScope)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *RoleMiningSessionResponse) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### GetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionResponse) GetMinNumIdentitiesInPotentialRole() int32` + +GetMinNumIdentitiesInPotentialRole returns the MinNumIdentitiesInPotentialRole field if non-nil, zero value otherwise. + +### GetMinNumIdentitiesInPotentialRoleOk + +`func (o *RoleMiningSessionResponse) GetMinNumIdentitiesInPotentialRoleOk() (*int32, bool)` + +GetMinNumIdentitiesInPotentialRoleOk returns a tuple with the MinNumIdentitiesInPotentialRole field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionResponse) SetMinNumIdentitiesInPotentialRole(v int32)` + +SetMinNumIdentitiesInPotentialRole sets MinNumIdentitiesInPotentialRole field to given value. + +### HasMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionResponse) HasMinNumIdentitiesInPotentialRole() bool` + +HasMinNumIdentitiesInPotentialRole returns a boolean if a field has been set. + +### SetMinNumIdentitiesInPotentialRoleNil + +`func (o *RoleMiningSessionResponse) SetMinNumIdentitiesInPotentialRoleNil(b bool)` + + SetMinNumIdentitiesInPotentialRoleNil sets the value for MinNumIdentitiesInPotentialRole to be an explicit nil + +### UnsetMinNumIdentitiesInPotentialRole +`func (o *RoleMiningSessionResponse) UnsetMinNumIdentitiesInPotentialRole()` + +UnsetMinNumIdentitiesInPotentialRole ensures that no value is present for MinNumIdentitiesInPotentialRole, not even an explicit nil +### GetScopingMethod + +`func (o *RoleMiningSessionResponse) GetScopingMethod() string` + +GetScopingMethod returns the ScopingMethod field if non-nil, zero value otherwise. + +### GetScopingMethodOk + +`func (o *RoleMiningSessionResponse) GetScopingMethodOk() (*string, bool)` + +GetScopingMethodOk returns a tuple with the ScopingMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScopingMethod + +`func (o *RoleMiningSessionResponse) SetScopingMethod(v string)` + +SetScopingMethod sets ScopingMethod field to given value. + +### HasScopingMethod + +`func (o *RoleMiningSessionResponse) HasScopingMethod() bool` + +HasScopingMethod returns a boolean if a field has been set. + +### SetScopingMethodNil + +`func (o *RoleMiningSessionResponse) SetScopingMethodNil(b bool)` + + SetScopingMethodNil sets the value for ScopingMethod to be an explicit nil + +### UnsetScopingMethod +`func (o *RoleMiningSessionResponse) UnsetScopingMethod()` + +UnsetScopingMethod ensures that no value is present for ScopingMethod, not even an explicit nil +### GetPrescribedPruneThreshold + +`func (o *RoleMiningSessionResponse) GetPrescribedPruneThreshold() int32` + +GetPrescribedPruneThreshold returns the PrescribedPruneThreshold field if non-nil, zero value otherwise. + +### GetPrescribedPruneThresholdOk + +`func (o *RoleMiningSessionResponse) GetPrescribedPruneThresholdOk() (*int32, bool)` + +GetPrescribedPruneThresholdOk returns a tuple with the PrescribedPruneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrescribedPruneThreshold + +`func (o *RoleMiningSessionResponse) SetPrescribedPruneThreshold(v int32)` + +SetPrescribedPruneThreshold sets PrescribedPruneThreshold field to given value. + +### HasPrescribedPruneThreshold + +`func (o *RoleMiningSessionResponse) HasPrescribedPruneThreshold() bool` + +HasPrescribedPruneThreshold returns a boolean if a field has been set. + +### SetPrescribedPruneThresholdNil + +`func (o *RoleMiningSessionResponse) SetPrescribedPruneThresholdNil(b bool)` + + SetPrescribedPruneThresholdNil sets the value for PrescribedPruneThreshold to be an explicit nil + +### UnsetPrescribedPruneThreshold +`func (o *RoleMiningSessionResponse) UnsetPrescribedPruneThreshold()` + +UnsetPrescribedPruneThreshold ensures that no value is present for PrescribedPruneThreshold, not even an explicit nil +### GetPruneThreshold + +`func (o *RoleMiningSessionResponse) GetPruneThreshold() int32` + +GetPruneThreshold returns the PruneThreshold field if non-nil, zero value otherwise. + +### GetPruneThresholdOk + +`func (o *RoleMiningSessionResponse) GetPruneThresholdOk() (*int32, bool)` + +GetPruneThresholdOk returns a tuple with the PruneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPruneThreshold + +`func (o *RoleMiningSessionResponse) SetPruneThreshold(v int32)` + +SetPruneThreshold sets PruneThreshold field to given value. + +### HasPruneThreshold + +`func (o *RoleMiningSessionResponse) HasPruneThreshold() bool` + +HasPruneThreshold returns a boolean if a field has been set. + +### SetPruneThresholdNil + +`func (o *RoleMiningSessionResponse) SetPruneThresholdNil(b bool)` + + SetPruneThresholdNil sets the value for PruneThreshold to be an explicit nil + +### UnsetPruneThreshold +`func (o *RoleMiningSessionResponse) UnsetPruneThreshold()` + +UnsetPruneThreshold ensures that no value is present for PruneThreshold, not even an explicit nil +### GetPotentialRoleCount + +`func (o *RoleMiningSessionResponse) GetPotentialRoleCount() int32` + +GetPotentialRoleCount returns the PotentialRoleCount field if non-nil, zero value otherwise. + +### GetPotentialRoleCountOk + +`func (o *RoleMiningSessionResponse) GetPotentialRoleCountOk() (*int32, bool)` + +GetPotentialRoleCountOk returns a tuple with the PotentialRoleCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPotentialRoleCount + +`func (o *RoleMiningSessionResponse) SetPotentialRoleCount(v int32)` + +SetPotentialRoleCount sets PotentialRoleCount field to given value. + +### HasPotentialRoleCount + +`func (o *RoleMiningSessionResponse) HasPotentialRoleCount() bool` + +HasPotentialRoleCount returns a boolean if a field has been set. + +### GetPotentialRolesReadyCount + +`func (o *RoleMiningSessionResponse) GetPotentialRolesReadyCount() int32` + +GetPotentialRolesReadyCount returns the PotentialRolesReadyCount field if non-nil, zero value otherwise. + +### GetPotentialRolesReadyCountOk + +`func (o *RoleMiningSessionResponse) GetPotentialRolesReadyCountOk() (*int32, bool)` + +GetPotentialRolesReadyCountOk returns a tuple with the PotentialRolesReadyCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPotentialRolesReadyCount + +`func (o *RoleMiningSessionResponse) SetPotentialRolesReadyCount(v int32)` + +SetPotentialRolesReadyCount sets PotentialRolesReadyCount field to given value. + +### HasPotentialRolesReadyCount + +`func (o *RoleMiningSessionResponse) HasPotentialRolesReadyCount() bool` + +HasPotentialRolesReadyCount returns a boolean if a field has been set. + +### GetStatus + +`func (o *RoleMiningSessionResponse) GetStatus() RoleMiningSessionStatus` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *RoleMiningSessionResponse) GetStatusOk() (*RoleMiningSessionStatus, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *RoleMiningSessionResponse) SetStatus(v RoleMiningSessionStatus)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *RoleMiningSessionResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetEmailRecipientId + +`func (o *RoleMiningSessionResponse) GetEmailRecipientId() string` + +GetEmailRecipientId returns the EmailRecipientId field if non-nil, zero value otherwise. + +### GetEmailRecipientIdOk + +`func (o *RoleMiningSessionResponse) GetEmailRecipientIdOk() (*string, bool)` + +GetEmailRecipientIdOk returns a tuple with the EmailRecipientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailRecipientId + +`func (o *RoleMiningSessionResponse) SetEmailRecipientId(v string)` + +SetEmailRecipientId sets EmailRecipientId field to given value. + +### HasEmailRecipientId + +`func (o *RoleMiningSessionResponse) HasEmailRecipientId() bool` + +HasEmailRecipientId returns a boolean if a field has been set. + +### SetEmailRecipientIdNil + +`func (o *RoleMiningSessionResponse) SetEmailRecipientIdNil(b bool)` + + SetEmailRecipientIdNil sets the value for EmailRecipientId to be an explicit nil + +### UnsetEmailRecipientId +`func (o *RoleMiningSessionResponse) UnsetEmailRecipientId()` + +UnsetEmailRecipientId ensures that no value is present for EmailRecipientId, not even an explicit nil +### GetCreatedBy + +`func (o *RoleMiningSessionResponse) GetCreatedBy() RoleMiningSessionResponseCreatedBy` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *RoleMiningSessionResponse) GetCreatedByOk() (*RoleMiningSessionResponseCreatedBy, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *RoleMiningSessionResponse) SetCreatedBy(v RoleMiningSessionResponseCreatedBy)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *RoleMiningSessionResponse) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *RoleMiningSessionResponse) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *RoleMiningSessionResponse) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *RoleMiningSessionResponse) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *RoleMiningSessionResponse) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetSaved + +`func (o *RoleMiningSessionResponse) GetSaved() bool` + +GetSaved returns the Saved field if non-nil, zero value otherwise. + +### GetSavedOk + +`func (o *RoleMiningSessionResponse) GetSavedOk() (*bool, bool)` + +GetSavedOk returns a tuple with the Saved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSaved + +`func (o *RoleMiningSessionResponse) SetSaved(v bool)` + +SetSaved sets Saved field to given value. + +### HasSaved + +`func (o *RoleMiningSessionResponse) HasSaved() bool` + +HasSaved returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningSessionResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningSessionResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningSessionResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningSessionResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RoleMiningSessionResponse) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RoleMiningSessionResponse) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDataFilePath + +`func (o *RoleMiningSessionResponse) GetDataFilePath() string` + +GetDataFilePath returns the DataFilePath field if non-nil, zero value otherwise. + +### GetDataFilePathOk + +`func (o *RoleMiningSessionResponse) GetDataFilePathOk() (*string, bool)` + +GetDataFilePathOk returns a tuple with the DataFilePath field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataFilePath + +`func (o *RoleMiningSessionResponse) SetDataFilePath(v string)` + +SetDataFilePath sets DataFilePath field to given value. + +### HasDataFilePath + +`func (o *RoleMiningSessionResponse) HasDataFilePath() bool` + +HasDataFilePath returns a boolean if a field has been set. + +### SetDataFilePathNil + +`func (o *RoleMiningSessionResponse) SetDataFilePathNil(b bool)` + + SetDataFilePathNil sets the value for DataFilePath to be an explicit nil + +### UnsetDataFilePath +`func (o *RoleMiningSessionResponse) UnsetDataFilePath()` + +UnsetDataFilePath ensures that no value is present for DataFilePath, not even an explicit nil +### GetId + +`func (o *RoleMiningSessionResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningSessionResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningSessionResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningSessionResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleMiningSessionResponse) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleMiningSessionResponse) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleMiningSessionResponse) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleMiningSessionResponse) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetModifiedDate + +`func (o *RoleMiningSessionResponse) GetModifiedDate() SailPointTime` + +GetModifiedDate returns the ModifiedDate field if non-nil, zero value otherwise. + +### GetModifiedDateOk + +`func (o *RoleMiningSessionResponse) GetModifiedDateOk() (*SailPointTime, bool)` + +GetModifiedDateOk returns a tuple with the ModifiedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedDate + +`func (o *RoleMiningSessionResponse) SetModifiedDate(v SailPointTime)` + +SetModifiedDate sets ModifiedDate field to given value. + +### HasModifiedDate + +`func (o *RoleMiningSessionResponse) HasModifiedDate() bool` + +HasModifiedDate returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningSessionResponse) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningSessionResponse) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningSessionResponse) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningSessionResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionResponseCreatedBy.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionResponseCreatedBy.md new file mode 100644 index 000000000..68f7d89ed --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionResponseCreatedBy.md @@ -0,0 +1,90 @@ +--- +id: v2024-role-mining-session-response-created-by +title: RoleMiningSessionResponseCreatedBy +pagination_label: RoleMiningSessionResponseCreatedBy +sidebar_label: RoleMiningSessionResponseCreatedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionResponseCreatedBy', 'V2024RoleMiningSessionResponseCreatedBy'] +slug: /tools/sdk/go/v2024/models/role-mining-session-response-created-by +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionResponseCreatedBy', 'V2024RoleMiningSessionResponseCreatedBy'] +--- + +# RoleMiningSessionResponseCreatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the creator | [optional] +**DisplayName** | Pointer to **string** | The display name of the creator | [optional] + +## Methods + +### NewRoleMiningSessionResponseCreatedBy + +`func NewRoleMiningSessionResponseCreatedBy() *RoleMiningSessionResponseCreatedBy` + +NewRoleMiningSessionResponseCreatedBy instantiates a new RoleMiningSessionResponseCreatedBy 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 + +### NewRoleMiningSessionResponseCreatedByWithDefaults + +`func NewRoleMiningSessionResponseCreatedByWithDefaults() *RoleMiningSessionResponseCreatedBy` + +NewRoleMiningSessionResponseCreatedByWithDefaults instantiates a new RoleMiningSessionResponseCreatedBy 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 + +### GetId + +`func (o *RoleMiningSessionResponseCreatedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningSessionResponseCreatedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningSessionResponseCreatedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningSessionResponseCreatedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *RoleMiningSessionResponseCreatedBy) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *RoleMiningSessionResponseCreatedBy) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *RoleMiningSessionResponseCreatedBy) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *RoleMiningSessionResponseCreatedBy) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionScope.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionScope.md new file mode 100644 index 000000000..20f42742f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionScope.md @@ -0,0 +1,136 @@ +--- +id: v2024-role-mining-session-scope +title: RoleMiningSessionScope +pagination_label: RoleMiningSessionScope +sidebar_label: RoleMiningSessionScope +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionScope', 'V2024RoleMiningSessionScope'] +slug: /tools/sdk/go/v2024/models/role-mining-session-scope +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionScope', 'V2024RoleMiningSessionScope'] +--- + +# RoleMiningSessionScope + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityIds** | Pointer to **[]string** | The list of identities for this role mining session. | [optional] +**Criteria** | Pointer to **NullableString** | The \"search\" criteria that produces the list of identities for this role mining session. | [optional] +**AttributeFilterCriteria** | Pointer to **[]map[string]interface{}** | The filter criteria for this role mining session. | [optional] + +## Methods + +### NewRoleMiningSessionScope + +`func NewRoleMiningSessionScope() *RoleMiningSessionScope` + +NewRoleMiningSessionScope instantiates a new RoleMiningSessionScope 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 + +### NewRoleMiningSessionScopeWithDefaults + +`func NewRoleMiningSessionScopeWithDefaults() *RoleMiningSessionScope` + +NewRoleMiningSessionScopeWithDefaults instantiates a new RoleMiningSessionScope 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 + +### GetIdentityIds + +`func (o *RoleMiningSessionScope) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *RoleMiningSessionScope) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *RoleMiningSessionScope) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *RoleMiningSessionScope) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + +### GetCriteria + +`func (o *RoleMiningSessionScope) GetCriteria() string` + +GetCriteria returns the Criteria field if non-nil, zero value otherwise. + +### GetCriteriaOk + +`func (o *RoleMiningSessionScope) GetCriteriaOk() (*string, bool)` + +GetCriteriaOk returns a tuple with the Criteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteria + +`func (o *RoleMiningSessionScope) SetCriteria(v string)` + +SetCriteria sets Criteria field to given value. + +### HasCriteria + +`func (o *RoleMiningSessionScope) HasCriteria() bool` + +HasCriteria returns a boolean if a field has been set. + +### SetCriteriaNil + +`func (o *RoleMiningSessionScope) SetCriteriaNil(b bool)` + + SetCriteriaNil sets the value for Criteria to be an explicit nil + +### UnsetCriteria +`func (o *RoleMiningSessionScope) UnsetCriteria()` + +UnsetCriteria ensures that no value is present for Criteria, not even an explicit nil +### GetAttributeFilterCriteria + +`func (o *RoleMiningSessionScope) GetAttributeFilterCriteria() []map[string]interface{}` + +GetAttributeFilterCriteria returns the AttributeFilterCriteria field if non-nil, zero value otherwise. + +### GetAttributeFilterCriteriaOk + +`func (o *RoleMiningSessionScope) GetAttributeFilterCriteriaOk() (*[]map[string]interface{}, bool)` + +GetAttributeFilterCriteriaOk returns a tuple with the AttributeFilterCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeFilterCriteria + +`func (o *RoleMiningSessionScope) SetAttributeFilterCriteria(v []map[string]interface{})` + +SetAttributeFilterCriteria sets AttributeFilterCriteria field to given value. + +### HasAttributeFilterCriteria + +`func (o *RoleMiningSessionScope) HasAttributeFilterCriteria() bool` + +HasAttributeFilterCriteria returns a boolean if a field has been set. + +### SetAttributeFilterCriteriaNil + +`func (o *RoleMiningSessionScope) SetAttributeFilterCriteriaNil(b bool)` + + SetAttributeFilterCriteriaNil sets the value for AttributeFilterCriteria to be an explicit nil + +### UnsetAttributeFilterCriteria +`func (o *RoleMiningSessionScope) UnsetAttributeFilterCriteria()` + +UnsetAttributeFilterCriteria ensures that no value is present for AttributeFilterCriteria, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionScopingMethod.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionScopingMethod.md new file mode 100644 index 000000000..4c14a7373 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionScopingMethod.md @@ -0,0 +1,21 @@ +--- +id: v2024-role-mining-session-scoping-method +title: RoleMiningSessionScopingMethod +pagination_label: RoleMiningSessionScopingMethod +sidebar_label: RoleMiningSessionScopingMethod +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionScopingMethod', 'V2024RoleMiningSessionScopingMethod'] +slug: /tools/sdk/go/v2024/models/role-mining-session-scoping-method +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionScopingMethod', 'V2024RoleMiningSessionScopingMethod'] +--- + +# RoleMiningSessionScopingMethod + +## Enum + + +* `MANUAL` (value: `"MANUAL"`) + +* `AUTO_RM` (value: `"AUTO_RM"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionState.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionState.md new file mode 100644 index 000000000..0ef21618f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionState.md @@ -0,0 +1,29 @@ +--- +id: v2024-role-mining-session-state +title: RoleMiningSessionState +pagination_label: RoleMiningSessionState +sidebar_label: RoleMiningSessionState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionState', 'V2024RoleMiningSessionState'] +slug: /tools/sdk/go/v2024/models/role-mining-session-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionState', 'V2024RoleMiningSessionState'] +--- + +# RoleMiningSessionState + +## Enum + + +* `CREATED` (value: `"CREATED"`) + +* `UPDATED` (value: `"UPDATED"`) + +* `IDENTITIES_OBTAINED` (value: `"IDENTITIES_OBTAINED"`) + +* `PRUNE_THRESHOLD_OBTAINED` (value: `"PRUNE_THRESHOLD_OBTAINED"`) + +* `POTENTIAL_ROLES_PROCESSING` (value: `"POTENTIAL_ROLES_PROCESSING"`) + +* `POTENTIAL_ROLES_CREATED` (value: `"POTENTIAL_ROLES_CREATED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionStatus.md new file mode 100644 index 000000000..3c590b7c3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleMiningSessionStatus.md @@ -0,0 +1,64 @@ +--- +id: v2024-role-mining-session-status +title: RoleMiningSessionStatus +pagination_label: RoleMiningSessionStatus +sidebar_label: RoleMiningSessionStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionStatus', 'V2024RoleMiningSessionStatus'] +slug: /tools/sdk/go/v2024/models/role-mining-session-status +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionStatus', 'V2024RoleMiningSessionStatus'] +--- + +# RoleMiningSessionStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to [**RoleMiningSessionState**](role-mining-session-state) | | [optional] + +## Methods + +### NewRoleMiningSessionStatus + +`func NewRoleMiningSessionStatus() *RoleMiningSessionStatus` + +NewRoleMiningSessionStatus instantiates a new RoleMiningSessionStatus 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 + +### NewRoleMiningSessionStatusWithDefaults + +`func NewRoleMiningSessionStatusWithDefaults() *RoleMiningSessionStatus` + +NewRoleMiningSessionStatusWithDefaults instantiates a new RoleMiningSessionStatus 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 + +### GetState + +`func (o *RoleMiningSessionStatus) GetState() RoleMiningSessionState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *RoleMiningSessionStatus) GetStateOk() (*RoleMiningSessionState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *RoleMiningSessionStatus) SetState(v RoleMiningSessionState)` + +SetState sets State field to given value. + +### HasState + +`func (o *RoleMiningSessionStatus) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleSummary.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleSummary.md new file mode 100644 index 000000000..9a6029478 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleSummary.md @@ -0,0 +1,256 @@ +--- +id: v2024-role-summary +title: RoleSummary +pagination_label: RoleSummary +sidebar_label: RoleSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleSummary', 'V2024RoleSummary'] +slug: /tools/sdk/go/v2024/models/role-summary +tags: ['SDK', 'Software Development Kit', 'RoleSummary', 'V2024RoleSummary'] +--- + +# RoleSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional] +**Disabled** | Pointer to **bool** | | [optional] +**Revocable** | Pointer to **bool** | | [optional] + +## Methods + +### NewRoleSummary + +`func NewRoleSummary() *RoleSummary` + +NewRoleSummary instantiates a new RoleSummary 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 + +### NewRoleSummaryWithDefaults + +`func NewRoleSummaryWithDefaults() *RoleSummary` + +NewRoleSummaryWithDefaults instantiates a new RoleSummary 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 + +### GetId + +`func (o *RoleSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleSummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleSummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleSummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleSummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleSummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleSummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *RoleSummary) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *RoleSummary) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *RoleSummary) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *RoleSummary) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleSummary) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleSummary) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleSummary) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleSummary) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleSummary) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleSummary) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *RoleSummary) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleSummary) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleSummary) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetOwner + +`func (o *RoleSummary) GetOwner() DisplayReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *RoleSummary) GetOwnerOk() (*DisplayReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *RoleSummary) SetOwner(v DisplayReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *RoleSummary) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDisabled + +`func (o *RoleSummary) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *RoleSummary) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *RoleSummary) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *RoleSummary) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetRevocable + +`func (o *RoleSummary) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *RoleSummary) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *RoleSummary) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *RoleSummary) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/RoleTargetDto.md b/docs/tools/sdk/go/Reference/V2024/Models/RoleTargetDto.md new file mode 100644 index 000000000..7a7d94265 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/RoleTargetDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-role-target-dto +title: RoleTargetDto +pagination_label: RoleTargetDto +sidebar_label: RoleTargetDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleTargetDto', 'V2024RoleTargetDto'] +slug: /tools/sdk/go/v2024/models/role-target-dto +tags: ['SDK', 'Software Development Kit', 'RoleTargetDto', 'V2024RoleTargetDto'] +--- + +# RoleTargetDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] +**AccountInfo** | Pointer to [**AccountInfoDto**](account-info-dto) | | [optional] +**RoleName** | Pointer to **string** | Specific role name for this target if using multiple accounts | [optional] + +## Methods + +### NewRoleTargetDto + +`func NewRoleTargetDto() *RoleTargetDto` + +NewRoleTargetDto instantiates a new RoleTargetDto 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 + +### NewRoleTargetDtoWithDefaults + +`func NewRoleTargetDtoWithDefaults() *RoleTargetDto` + +NewRoleTargetDtoWithDefaults instantiates a new RoleTargetDto 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 + +### GetSource + +`func (o *RoleTargetDto) GetSource() BaseReferenceDto` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *RoleTargetDto) GetSourceOk() (*BaseReferenceDto, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *RoleTargetDto) SetSource(v BaseReferenceDto)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *RoleTargetDto) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAccountInfo + +`func (o *RoleTargetDto) GetAccountInfo() AccountInfoDto` + +GetAccountInfo returns the AccountInfo field if non-nil, zero value otherwise. + +### GetAccountInfoOk + +`func (o *RoleTargetDto) GetAccountInfoOk() (*AccountInfoDto, bool)` + +GetAccountInfoOk returns a tuple with the AccountInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountInfo + +`func (o *RoleTargetDto) SetAccountInfo(v AccountInfoDto)` + +SetAccountInfo sets AccountInfo field to given value. + +### HasAccountInfo + +`func (o *RoleTargetDto) HasAccountInfo() bool` + +HasAccountInfo returns a boolean if a field has been set. + +### GetRoleName + +`func (o *RoleTargetDto) GetRoleName() string` + +GetRoleName returns the RoleName field if non-nil, zero value otherwise. + +### GetRoleNameOk + +`func (o *RoleTargetDto) GetRoleNameOk() (*string, bool)` + +GetRoleNameOk returns a tuple with the RoleName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleName + +`func (o *RoleTargetDto) SetRoleName(v string)` + +SetRoleName sets RoleName field to given value. + +### HasRoleName + +`func (o *RoleTargetDto) HasRoleName() bool` + +HasRoleName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SavedSearch.md b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearch.md new file mode 100644 index 000000000..531f86e6e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearch.md @@ -0,0 +1,488 @@ +--- +id: v2024-saved-search +title: SavedSearch +pagination_label: SavedSearch +sidebar_label: SavedSearch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearch', 'V2024SavedSearch'] +slug: /tools/sdk/go/v2024/models/saved-search +tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'V2024SavedSearch'] +--- + +# SavedSearch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the saved search. | [optional] +**Description** | Pointer to **NullableString** | The description of the saved search. | [optional] +**Created** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | +**Columns** | Pointer to [**map[string][]Column**](https://go.dev/tour/moretypes/6) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**Query** | **string** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | +**Fields** | Pointer to **[]string** | The fields to be searched against in a multi-field query. | [optional] +**OrderBy** | Pointer to **map[string][]string** | Sort by index. This takes precedence over the `sort` property. | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. | [optional] +**Filters** | Pointer to [**NullableSavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] +**Id** | Pointer to **string** | The saved search ID. | [optional] +**Owner** | Pointer to [**TypedReference**](typed-reference) | | [optional] +**OwnerId** | Pointer to **string** | The ID of the identity that owns this saved search. | [optional] +**Public** | Pointer to **bool** | Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. | [optional] [default to false] + +## Methods + +### NewSavedSearch + +`func NewSavedSearch(indices []Index, query string, ) *SavedSearch` + +NewSavedSearch instantiates a new SavedSearch 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 + +### NewSavedSearchWithDefaults + +`func NewSavedSearchWithDefaults() *SavedSearch` + +NewSavedSearchWithDefaults instantiates a new SavedSearch 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 + +### GetName + +`func (o *SavedSearch) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SavedSearch) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SavedSearch) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SavedSearch) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *SavedSearch) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SavedSearch) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SavedSearch) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SavedSearch) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *SavedSearch) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *SavedSearch) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCreated + +`func (o *SavedSearch) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SavedSearch) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SavedSearch) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SavedSearch) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *SavedSearch) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *SavedSearch) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *SavedSearch) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SavedSearch) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SavedSearch) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SavedSearch) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *SavedSearch) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *SavedSearch) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetIndices + +`func (o *SavedSearch) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *SavedSearch) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *SavedSearch) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + + +### GetColumns + +`func (o *SavedSearch) GetColumns() map[string][]Column` + +GetColumns returns the Columns field if non-nil, zero value otherwise. + +### GetColumnsOk + +`func (o *SavedSearch) GetColumnsOk() (*map[string][]Column, bool)` + +GetColumnsOk returns a tuple with the Columns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumns + +`func (o *SavedSearch) SetColumns(v map[string][]Column)` + +SetColumns sets Columns field to given value. + +### HasColumns + +`func (o *SavedSearch) HasColumns() bool` + +HasColumns returns a boolean if a field has been set. + +### GetQuery + +`func (o *SavedSearch) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SavedSearch) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SavedSearch) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetFields + +`func (o *SavedSearch) GetFields() []string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *SavedSearch) GetFieldsOk() (*[]string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *SavedSearch) SetFields(v []string)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *SavedSearch) HasFields() bool` + +HasFields returns a boolean if a field has been set. + +### SetFieldsNil + +`func (o *SavedSearch) SetFieldsNil(b bool)` + + SetFieldsNil sets the value for Fields to be an explicit nil + +### UnsetFields +`func (o *SavedSearch) UnsetFields()` + +UnsetFields ensures that no value is present for Fields, not even an explicit nil +### GetOrderBy + +`func (o *SavedSearch) GetOrderBy() map[string][]string` + +GetOrderBy returns the OrderBy field if non-nil, zero value otherwise. + +### GetOrderByOk + +`func (o *SavedSearch) GetOrderByOk() (*map[string][]string, bool)` + +GetOrderByOk returns a tuple with the OrderBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderBy + +`func (o *SavedSearch) SetOrderBy(v map[string][]string)` + +SetOrderBy sets OrderBy field to given value. + +### HasOrderBy + +`func (o *SavedSearch) HasOrderBy() bool` + +HasOrderBy returns a boolean if a field has been set. + +### SetOrderByNil + +`func (o *SavedSearch) SetOrderByNil(b bool)` + + SetOrderByNil sets the value for OrderBy to be an explicit nil + +### UnsetOrderBy +`func (o *SavedSearch) UnsetOrderBy()` + +UnsetOrderBy ensures that no value is present for OrderBy, not even an explicit nil +### GetSort + +`func (o *SavedSearch) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *SavedSearch) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *SavedSearch) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *SavedSearch) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### SetSortNil + +`func (o *SavedSearch) SetSortNil(b bool)` + + SetSortNil sets the value for Sort to be an explicit nil + +### UnsetSort +`func (o *SavedSearch) UnsetSort()` + +UnsetSort ensures that no value is present for Sort, not even an explicit nil +### GetFilters + +`func (o *SavedSearch) GetFilters() SavedSearchDetailFilters` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *SavedSearch) GetFiltersOk() (*SavedSearchDetailFilters, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *SavedSearch) SetFilters(v SavedSearchDetailFilters)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *SavedSearch) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### SetFiltersNil + +`func (o *SavedSearch) SetFiltersNil(b bool)` + + SetFiltersNil sets the value for Filters to be an explicit nil + +### UnsetFilters +`func (o *SavedSearch) UnsetFilters()` + +UnsetFilters ensures that no value is present for Filters, not even an explicit nil +### GetId + +`func (o *SavedSearch) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SavedSearch) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SavedSearch) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SavedSearch) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetOwner + +`func (o *SavedSearch) GetOwner() TypedReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *SavedSearch) GetOwnerOk() (*TypedReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *SavedSearch) SetOwner(v TypedReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *SavedSearch) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetOwnerId + +`func (o *SavedSearch) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *SavedSearch) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *SavedSearch) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *SavedSearch) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + +### GetPublic + +`func (o *SavedSearch) GetPublic() bool` + +GetPublic returns the Public field if non-nil, zero value otherwise. + +### GetPublicOk + +`func (o *SavedSearch) GetPublicOk() (*bool, bool)` + +GetPublicOk returns a tuple with the Public field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublic + +`func (o *SavedSearch) SetPublic(v bool)` + +SetPublic sets Public field to given value. + +### HasPublic + +`func (o *SavedSearch) HasPublic() bool` + +HasPublic returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchComplete.md b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchComplete.md new file mode 100644 index 000000000..39e6315e7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchComplete.md @@ -0,0 +1,185 @@ +--- +id: v2024-saved-search-complete +title: SavedSearchComplete +pagination_label: SavedSearchComplete +sidebar_label: SavedSearchComplete +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchComplete', 'V2024SavedSearchComplete'] +slug: /tools/sdk/go/v2024/models/saved-search-complete +tags: ['SDK', 'Software Development Kit', 'SavedSearchComplete', 'V2024SavedSearchComplete'] +--- + +# SavedSearchComplete + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FileName** | **string** | A name for the report file. | +**OwnerEmail** | **string** | The email address of the identity that owns the saved search. | +**OwnerName** | **string** | The name of the identity that owns the saved search. | +**Query** | **string** | The search query that was used to generate the report. | +**SearchName** | **string** | The name of the saved search. | +**SearchResults** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | +**SignedS3Url** | **string** | The Amazon S3 URL to download the report from. | + +## Methods + +### NewSavedSearchComplete + +`func NewSavedSearchComplete(fileName string, ownerEmail string, ownerName string, query string, searchName string, searchResults SavedSearchCompleteSearchResults, signedS3Url string, ) *SavedSearchComplete` + +NewSavedSearchComplete instantiates a new SavedSearchComplete 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 + +### NewSavedSearchCompleteWithDefaults + +`func NewSavedSearchCompleteWithDefaults() *SavedSearchComplete` + +NewSavedSearchCompleteWithDefaults instantiates a new SavedSearchComplete 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 + +### GetFileName + +`func (o *SavedSearchComplete) GetFileName() string` + +GetFileName returns the FileName field if non-nil, zero value otherwise. + +### GetFileNameOk + +`func (o *SavedSearchComplete) GetFileNameOk() (*string, bool)` + +GetFileNameOk returns a tuple with the FileName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileName + +`func (o *SavedSearchComplete) SetFileName(v string)` + +SetFileName sets FileName field to given value. + + +### GetOwnerEmail + +`func (o *SavedSearchComplete) GetOwnerEmail() string` + +GetOwnerEmail returns the OwnerEmail field if non-nil, zero value otherwise. + +### GetOwnerEmailOk + +`func (o *SavedSearchComplete) GetOwnerEmailOk() (*string, bool)` + +GetOwnerEmailOk returns a tuple with the OwnerEmail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerEmail + +`func (o *SavedSearchComplete) SetOwnerEmail(v string)` + +SetOwnerEmail sets OwnerEmail field to given value. + + +### GetOwnerName + +`func (o *SavedSearchComplete) GetOwnerName() string` + +GetOwnerName returns the OwnerName field if non-nil, zero value otherwise. + +### GetOwnerNameOk + +`func (o *SavedSearchComplete) GetOwnerNameOk() (*string, bool)` + +GetOwnerNameOk returns a tuple with the OwnerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerName + +`func (o *SavedSearchComplete) SetOwnerName(v string)` + +SetOwnerName sets OwnerName field to given value. + + +### GetQuery + +`func (o *SavedSearchComplete) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SavedSearchComplete) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SavedSearchComplete) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetSearchName + +`func (o *SavedSearchComplete) GetSearchName() string` + +GetSearchName returns the SearchName field if non-nil, zero value otherwise. + +### GetSearchNameOk + +`func (o *SavedSearchComplete) GetSearchNameOk() (*string, bool)` + +GetSearchNameOk returns a tuple with the SearchName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchName + +`func (o *SavedSearchComplete) SetSearchName(v string)` + +SetSearchName sets SearchName field to given value. + + +### GetSearchResults + +`func (o *SavedSearchComplete) GetSearchResults() SavedSearchCompleteSearchResults` + +GetSearchResults returns the SearchResults field if non-nil, zero value otherwise. + +### GetSearchResultsOk + +`func (o *SavedSearchComplete) GetSearchResultsOk() (*SavedSearchCompleteSearchResults, bool)` + +GetSearchResultsOk returns a tuple with the SearchResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchResults + +`func (o *SavedSearchComplete) SetSearchResults(v SavedSearchCompleteSearchResults)` + +SetSearchResults sets SearchResults field to given value. + + +### GetSignedS3Url + +`func (o *SavedSearchComplete) GetSignedS3Url() string` + +GetSignedS3Url returns the SignedS3Url field if non-nil, zero value otherwise. + +### GetSignedS3UrlOk + +`func (o *SavedSearchComplete) GetSignedS3UrlOk() (*string, bool)` + +GetSignedS3UrlOk returns a tuple with the SignedS3Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignedS3Url + +`func (o *SavedSearchComplete) SetSignedS3Url(v string)` + +SetSignedS3Url sets SignedS3Url field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchCompleteSearchResults.md b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchCompleteSearchResults.md new file mode 100644 index 000000000..e949a50d3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchCompleteSearchResults.md @@ -0,0 +1,146 @@ +--- +id: v2024-saved-search-complete-search-results +title: SavedSearchCompleteSearchResults +pagination_label: SavedSearchCompleteSearchResults +sidebar_label: SavedSearchCompleteSearchResults +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchCompleteSearchResults', 'V2024SavedSearchCompleteSearchResults'] +slug: /tools/sdk/go/v2024/models/saved-search-complete-search-results +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResults', 'V2024SavedSearchCompleteSearchResults'] +--- + +# SavedSearchCompleteSearchResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Account** | Pointer to [**NullableSavedSearchCompleteSearchResultsAccount**](saved-search-complete-search-results-account) | | [optional] +**Entitlement** | Pointer to [**NullableSavedSearchCompleteSearchResultsEntitlement**](saved-search-complete-search-results-entitlement) | | [optional] +**Identity** | Pointer to [**NullableSavedSearchCompleteSearchResultsIdentity**](saved-search-complete-search-results-identity) | | [optional] + +## Methods + +### NewSavedSearchCompleteSearchResults + +`func NewSavedSearchCompleteSearchResults() *SavedSearchCompleteSearchResults` + +NewSavedSearchCompleteSearchResults instantiates a new SavedSearchCompleteSearchResults 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 + +### NewSavedSearchCompleteSearchResultsWithDefaults + +`func NewSavedSearchCompleteSearchResultsWithDefaults() *SavedSearchCompleteSearchResults` + +NewSavedSearchCompleteSearchResultsWithDefaults instantiates a new SavedSearchCompleteSearchResults 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 + +### GetAccount + +`func (o *SavedSearchCompleteSearchResults) GetAccount() SavedSearchCompleteSearchResultsAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *SavedSearchCompleteSearchResults) GetAccountOk() (*SavedSearchCompleteSearchResultsAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *SavedSearchCompleteSearchResults) SetAccount(v SavedSearchCompleteSearchResultsAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *SavedSearchCompleteSearchResults) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### SetAccountNil + +`func (o *SavedSearchCompleteSearchResults) SetAccountNil(b bool)` + + SetAccountNil sets the value for Account to be an explicit nil + +### UnsetAccount +`func (o *SavedSearchCompleteSearchResults) UnsetAccount()` + +UnsetAccount ensures that no value is present for Account, not even an explicit nil +### GetEntitlement + +`func (o *SavedSearchCompleteSearchResults) GetEntitlement() SavedSearchCompleteSearchResultsEntitlement` + +GetEntitlement returns the Entitlement field if non-nil, zero value otherwise. + +### GetEntitlementOk + +`func (o *SavedSearchCompleteSearchResults) GetEntitlementOk() (*SavedSearchCompleteSearchResultsEntitlement, bool)` + +GetEntitlementOk returns a tuple with the Entitlement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlement + +`func (o *SavedSearchCompleteSearchResults) SetEntitlement(v SavedSearchCompleteSearchResultsEntitlement)` + +SetEntitlement sets Entitlement field to given value. + +### HasEntitlement + +`func (o *SavedSearchCompleteSearchResults) HasEntitlement() bool` + +HasEntitlement returns a boolean if a field has been set. + +### SetEntitlementNil + +`func (o *SavedSearchCompleteSearchResults) SetEntitlementNil(b bool)` + + SetEntitlementNil sets the value for Entitlement to be an explicit nil + +### UnsetEntitlement +`func (o *SavedSearchCompleteSearchResults) UnsetEntitlement()` + +UnsetEntitlement ensures that no value is present for Entitlement, not even an explicit nil +### GetIdentity + +`func (o *SavedSearchCompleteSearchResults) GetIdentity() SavedSearchCompleteSearchResultsIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *SavedSearchCompleteSearchResults) GetIdentityOk() (*SavedSearchCompleteSearchResultsIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *SavedSearchCompleteSearchResults) SetIdentity(v SavedSearchCompleteSearchResultsIdentity)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *SavedSearchCompleteSearchResults) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### SetIdentityNil + +`func (o *SavedSearchCompleteSearchResults) SetIdentityNil(b bool)` + + SetIdentityNil sets the value for Identity to be an explicit nil + +### UnsetIdentity +`func (o *SavedSearchCompleteSearchResults) UnsetIdentity()` + +UnsetIdentity ensures that no value is present for Identity, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchCompleteSearchResultsAccount.md b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchCompleteSearchResultsAccount.md new file mode 100644 index 000000000..a8fc61697 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchCompleteSearchResultsAccount.md @@ -0,0 +1,101 @@ +--- +id: v2024-saved-search-complete-search-results-account +title: SavedSearchCompleteSearchResultsAccount +pagination_label: SavedSearchCompleteSearchResultsAccount +sidebar_label: SavedSearchCompleteSearchResultsAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchCompleteSearchResultsAccount', 'V2024SavedSearchCompleteSearchResultsAccount'] +slug: /tools/sdk/go/v2024/models/saved-search-complete-search-results-account +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsAccount', 'V2024SavedSearchCompleteSearchResultsAccount'] +--- + +# SavedSearchCompleteSearchResultsAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **string** | The number of rows in the table. | +**Noun** | **string** | The type of object represented in the table. | +**Preview** | **[][]string** | A sample of the data in the table. | + +## Methods + +### NewSavedSearchCompleteSearchResultsAccount + +`func NewSavedSearchCompleteSearchResultsAccount(count string, noun string, preview [][]string, ) *SavedSearchCompleteSearchResultsAccount` + +NewSavedSearchCompleteSearchResultsAccount instantiates a new SavedSearchCompleteSearchResultsAccount 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 + +### NewSavedSearchCompleteSearchResultsAccountWithDefaults + +`func NewSavedSearchCompleteSearchResultsAccountWithDefaults() *SavedSearchCompleteSearchResultsAccount` + +NewSavedSearchCompleteSearchResultsAccountWithDefaults instantiates a new SavedSearchCompleteSearchResultsAccount 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 + +### GetCount + +`func (o *SavedSearchCompleteSearchResultsAccount) GetCount() string` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *SavedSearchCompleteSearchResultsAccount) GetCountOk() (*string, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *SavedSearchCompleteSearchResultsAccount) SetCount(v string)` + +SetCount sets Count field to given value. + + +### GetNoun + +`func (o *SavedSearchCompleteSearchResultsAccount) GetNoun() string` + +GetNoun returns the Noun field if non-nil, zero value otherwise. + +### GetNounOk + +`func (o *SavedSearchCompleteSearchResultsAccount) GetNounOk() (*string, bool)` + +GetNounOk returns a tuple with the Noun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNoun + +`func (o *SavedSearchCompleteSearchResultsAccount) SetNoun(v string)` + +SetNoun sets Noun field to given value. + + +### GetPreview + +`func (o *SavedSearchCompleteSearchResultsAccount) GetPreview() [][]string` + +GetPreview returns the Preview field if non-nil, zero value otherwise. + +### GetPreviewOk + +`func (o *SavedSearchCompleteSearchResultsAccount) GetPreviewOk() (*[][]string, bool)` + +GetPreviewOk returns a tuple with the Preview field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreview + +`func (o *SavedSearchCompleteSearchResultsAccount) SetPreview(v [][]string)` + +SetPreview sets Preview field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchCompleteSearchResultsEntitlement.md b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchCompleteSearchResultsEntitlement.md new file mode 100644 index 000000000..0b2e21040 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchCompleteSearchResultsEntitlement.md @@ -0,0 +1,101 @@ +--- +id: v2024-saved-search-complete-search-results-entitlement +title: SavedSearchCompleteSearchResultsEntitlement +pagination_label: SavedSearchCompleteSearchResultsEntitlement +sidebar_label: SavedSearchCompleteSearchResultsEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchCompleteSearchResultsEntitlement', 'V2024SavedSearchCompleteSearchResultsEntitlement'] +slug: /tools/sdk/go/v2024/models/saved-search-complete-search-results-entitlement +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsEntitlement', 'V2024SavedSearchCompleteSearchResultsEntitlement'] +--- + +# SavedSearchCompleteSearchResultsEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **string** | The number of rows in the table. | +**Noun** | **string** | The type of object represented in the table. | +**Preview** | **[][]string** | A sample of the data in the table. | + +## Methods + +### NewSavedSearchCompleteSearchResultsEntitlement + +`func NewSavedSearchCompleteSearchResultsEntitlement(count string, noun string, preview [][]string, ) *SavedSearchCompleteSearchResultsEntitlement` + +NewSavedSearchCompleteSearchResultsEntitlement instantiates a new SavedSearchCompleteSearchResultsEntitlement 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 + +### NewSavedSearchCompleteSearchResultsEntitlementWithDefaults + +`func NewSavedSearchCompleteSearchResultsEntitlementWithDefaults() *SavedSearchCompleteSearchResultsEntitlement` + +NewSavedSearchCompleteSearchResultsEntitlementWithDefaults instantiates a new SavedSearchCompleteSearchResultsEntitlement 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 + +### GetCount + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetCount() string` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetCountOk() (*string, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *SavedSearchCompleteSearchResultsEntitlement) SetCount(v string)` + +SetCount sets Count field to given value. + + +### GetNoun + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetNoun() string` + +GetNoun returns the Noun field if non-nil, zero value otherwise. + +### GetNounOk + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetNounOk() (*string, bool)` + +GetNounOk returns a tuple with the Noun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNoun + +`func (o *SavedSearchCompleteSearchResultsEntitlement) SetNoun(v string)` + +SetNoun sets Noun field to given value. + + +### GetPreview + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetPreview() [][]string` + +GetPreview returns the Preview field if non-nil, zero value otherwise. + +### GetPreviewOk + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetPreviewOk() (*[][]string, bool)` + +GetPreviewOk returns a tuple with the Preview field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreview + +`func (o *SavedSearchCompleteSearchResultsEntitlement) SetPreview(v [][]string)` + +SetPreview sets Preview field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchCompleteSearchResultsIdentity.md b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchCompleteSearchResultsIdentity.md new file mode 100644 index 000000000..50dba2f83 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchCompleteSearchResultsIdentity.md @@ -0,0 +1,101 @@ +--- +id: v2024-saved-search-complete-search-results-identity +title: SavedSearchCompleteSearchResultsIdentity +pagination_label: SavedSearchCompleteSearchResultsIdentity +sidebar_label: SavedSearchCompleteSearchResultsIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchCompleteSearchResultsIdentity', 'V2024SavedSearchCompleteSearchResultsIdentity'] +slug: /tools/sdk/go/v2024/models/saved-search-complete-search-results-identity +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsIdentity', 'V2024SavedSearchCompleteSearchResultsIdentity'] +--- + +# SavedSearchCompleteSearchResultsIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **string** | The number of rows in the table. | +**Noun** | **string** | The type of object represented in the table. | +**Preview** | **[][]string** | A sample of the data in the table. | + +## Methods + +### NewSavedSearchCompleteSearchResultsIdentity + +`func NewSavedSearchCompleteSearchResultsIdentity(count string, noun string, preview [][]string, ) *SavedSearchCompleteSearchResultsIdentity` + +NewSavedSearchCompleteSearchResultsIdentity instantiates a new SavedSearchCompleteSearchResultsIdentity 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 + +### NewSavedSearchCompleteSearchResultsIdentityWithDefaults + +`func NewSavedSearchCompleteSearchResultsIdentityWithDefaults() *SavedSearchCompleteSearchResultsIdentity` + +NewSavedSearchCompleteSearchResultsIdentityWithDefaults instantiates a new SavedSearchCompleteSearchResultsIdentity 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 + +### GetCount + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetCount() string` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetCountOk() (*string, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *SavedSearchCompleteSearchResultsIdentity) SetCount(v string)` + +SetCount sets Count field to given value. + + +### GetNoun + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetNoun() string` + +GetNoun returns the Noun field if non-nil, zero value otherwise. + +### GetNounOk + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetNounOk() (*string, bool)` + +GetNounOk returns a tuple with the Noun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNoun + +`func (o *SavedSearchCompleteSearchResultsIdentity) SetNoun(v string)` + +SetNoun sets Noun field to given value. + + +### GetPreview + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetPreview() [][]string` + +GetPreview returns the Preview field if non-nil, zero value otherwise. + +### GetPreviewOk + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetPreviewOk() (*[][]string, bool)` + +GetPreviewOk returns a tuple with the Preview field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreview + +`func (o *SavedSearchCompleteSearchResultsIdentity) SetPreview(v [][]string)` + +SetPreview sets Preview field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchDetail.md b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchDetail.md new file mode 100644 index 000000000..c07bd2787 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchDetail.md @@ -0,0 +1,322 @@ +--- +id: v2024-saved-search-detail +title: SavedSearchDetail +pagination_label: SavedSearchDetail +sidebar_label: SavedSearchDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchDetail', 'V2024SavedSearchDetail'] +slug: /tools/sdk/go/v2024/models/saved-search-detail +tags: ['SDK', 'Software Development Kit', 'SavedSearchDetail', 'V2024SavedSearchDetail'] +--- + +# SavedSearchDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | +**Columns** | Pointer to [**map[string][]Column**](https://go.dev/tour/moretypes/6) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**Query** | **string** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | +**Fields** | Pointer to **[]string** | The fields to be searched against in a multi-field query. | [optional] +**OrderBy** | Pointer to **map[string][]string** | Sort by index. This takes precedence over the `sort` property. | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. | [optional] +**Filters** | Pointer to [**NullableSavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] + +## Methods + +### NewSavedSearchDetail + +`func NewSavedSearchDetail(indices []Index, query string, ) *SavedSearchDetail` + +NewSavedSearchDetail instantiates a new SavedSearchDetail 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 + +### NewSavedSearchDetailWithDefaults + +`func NewSavedSearchDetailWithDefaults() *SavedSearchDetail` + +NewSavedSearchDetailWithDefaults instantiates a new SavedSearchDetail 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 + +### GetCreated + +`func (o *SavedSearchDetail) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SavedSearchDetail) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SavedSearchDetail) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SavedSearchDetail) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *SavedSearchDetail) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *SavedSearchDetail) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *SavedSearchDetail) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SavedSearchDetail) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SavedSearchDetail) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SavedSearchDetail) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *SavedSearchDetail) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *SavedSearchDetail) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetIndices + +`func (o *SavedSearchDetail) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *SavedSearchDetail) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *SavedSearchDetail) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + + +### GetColumns + +`func (o *SavedSearchDetail) GetColumns() map[string][]Column` + +GetColumns returns the Columns field if non-nil, zero value otherwise. + +### GetColumnsOk + +`func (o *SavedSearchDetail) GetColumnsOk() (*map[string][]Column, bool)` + +GetColumnsOk returns a tuple with the Columns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumns + +`func (o *SavedSearchDetail) SetColumns(v map[string][]Column)` + +SetColumns sets Columns field to given value. + +### HasColumns + +`func (o *SavedSearchDetail) HasColumns() bool` + +HasColumns returns a boolean if a field has been set. + +### GetQuery + +`func (o *SavedSearchDetail) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SavedSearchDetail) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SavedSearchDetail) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetFields + +`func (o *SavedSearchDetail) GetFields() []string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *SavedSearchDetail) GetFieldsOk() (*[]string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *SavedSearchDetail) SetFields(v []string)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *SavedSearchDetail) HasFields() bool` + +HasFields returns a boolean if a field has been set. + +### SetFieldsNil + +`func (o *SavedSearchDetail) SetFieldsNil(b bool)` + + SetFieldsNil sets the value for Fields to be an explicit nil + +### UnsetFields +`func (o *SavedSearchDetail) UnsetFields()` + +UnsetFields ensures that no value is present for Fields, not even an explicit nil +### GetOrderBy + +`func (o *SavedSearchDetail) GetOrderBy() map[string][]string` + +GetOrderBy returns the OrderBy field if non-nil, zero value otherwise. + +### GetOrderByOk + +`func (o *SavedSearchDetail) GetOrderByOk() (*map[string][]string, bool)` + +GetOrderByOk returns a tuple with the OrderBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderBy + +`func (o *SavedSearchDetail) SetOrderBy(v map[string][]string)` + +SetOrderBy sets OrderBy field to given value. + +### HasOrderBy + +`func (o *SavedSearchDetail) HasOrderBy() bool` + +HasOrderBy returns a boolean if a field has been set. + +### SetOrderByNil + +`func (o *SavedSearchDetail) SetOrderByNil(b bool)` + + SetOrderByNil sets the value for OrderBy to be an explicit nil + +### UnsetOrderBy +`func (o *SavedSearchDetail) UnsetOrderBy()` + +UnsetOrderBy ensures that no value is present for OrderBy, not even an explicit nil +### GetSort + +`func (o *SavedSearchDetail) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *SavedSearchDetail) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *SavedSearchDetail) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *SavedSearchDetail) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### SetSortNil + +`func (o *SavedSearchDetail) SetSortNil(b bool)` + + SetSortNil sets the value for Sort to be an explicit nil + +### UnsetSort +`func (o *SavedSearchDetail) UnsetSort()` + +UnsetSort ensures that no value is present for Sort, not even an explicit nil +### GetFilters + +`func (o *SavedSearchDetail) GetFilters() SavedSearchDetailFilters` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *SavedSearchDetail) GetFiltersOk() (*SavedSearchDetailFilters, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *SavedSearchDetail) SetFilters(v SavedSearchDetailFilters)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *SavedSearchDetail) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### SetFiltersNil + +`func (o *SavedSearchDetail) SetFiltersNil(b bool)` + + SetFiltersNil sets the value for Filters to be an explicit nil + +### UnsetFilters +`func (o *SavedSearchDetail) UnsetFilters()` + +UnsetFilters ensures that no value is present for Filters, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchDetailFilters.md b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchDetailFilters.md new file mode 100644 index 000000000..9b345e262 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchDetailFilters.md @@ -0,0 +1,142 @@ +--- +id: v2024-saved-search-detail-filters +title: SavedSearchDetailFilters +pagination_label: SavedSearchDetailFilters +sidebar_label: SavedSearchDetailFilters +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchDetailFilters', 'V2024SavedSearchDetailFilters'] +slug: /tools/sdk/go/v2024/models/saved-search-detail-filters +tags: ['SDK', 'Software Development Kit', 'SavedSearchDetailFilters', 'V2024SavedSearchDetailFilters'] +--- + +# SavedSearchDetailFilters + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**FilterType**](filter-type) | | [optional] +**Range** | Pointer to [**Range**](range) | | [optional] +**Terms** | Pointer to **[]string** | The terms to be filtered. | [optional] +**Exclude** | Pointer to **bool** | Indicates if the filter excludes results. | [optional] [default to false] + +## Methods + +### NewSavedSearchDetailFilters + +`func NewSavedSearchDetailFilters() *SavedSearchDetailFilters` + +NewSavedSearchDetailFilters instantiates a new SavedSearchDetailFilters 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 + +### NewSavedSearchDetailFiltersWithDefaults + +`func NewSavedSearchDetailFiltersWithDefaults() *SavedSearchDetailFilters` + +NewSavedSearchDetailFiltersWithDefaults instantiates a new SavedSearchDetailFilters 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 + +### GetType + +`func (o *SavedSearchDetailFilters) GetType() FilterType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SavedSearchDetailFilters) GetTypeOk() (*FilterType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SavedSearchDetailFilters) SetType(v FilterType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SavedSearchDetailFilters) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRange + +`func (o *SavedSearchDetailFilters) GetRange() Range` + +GetRange returns the Range field if non-nil, zero value otherwise. + +### GetRangeOk + +`func (o *SavedSearchDetailFilters) GetRangeOk() (*Range, bool)` + +GetRangeOk returns a tuple with the Range field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRange + +`func (o *SavedSearchDetailFilters) SetRange(v Range)` + +SetRange sets Range field to given value. + +### HasRange + +`func (o *SavedSearchDetailFilters) HasRange() bool` + +HasRange returns a boolean if a field has been set. + +### GetTerms + +`func (o *SavedSearchDetailFilters) GetTerms() []string` + +GetTerms returns the Terms field if non-nil, zero value otherwise. + +### GetTermsOk + +`func (o *SavedSearchDetailFilters) GetTermsOk() (*[]string, bool)` + +GetTermsOk returns a tuple with the Terms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerms + +`func (o *SavedSearchDetailFilters) SetTerms(v []string)` + +SetTerms sets Terms field to given value. + +### HasTerms + +`func (o *SavedSearchDetailFilters) HasTerms() bool` + +HasTerms returns a boolean if a field has been set. + +### GetExclude + +`func (o *SavedSearchDetailFilters) GetExclude() bool` + +GetExclude returns the Exclude field if non-nil, zero value otherwise. + +### GetExcludeOk + +`func (o *SavedSearchDetailFilters) GetExcludeOk() (*bool, bool)` + +GetExcludeOk returns a tuple with the Exclude field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExclude + +`func (o *SavedSearchDetailFilters) SetExclude(v bool)` + +SetExclude sets Exclude field to given value. + +### HasExclude + +`func (o *SavedSearchDetailFilters) HasExclude() bool` + +HasExclude returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchName.md b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchName.md new file mode 100644 index 000000000..f4b98c2a1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SavedSearchName.md @@ -0,0 +1,100 @@ +--- +id: v2024-saved-search-name +title: SavedSearchName +pagination_label: SavedSearchName +sidebar_label: SavedSearchName +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchName', 'V2024SavedSearchName'] +slug: /tools/sdk/go/v2024/models/saved-search-name +tags: ['SDK', 'Software Development Kit', 'SavedSearchName', 'V2024SavedSearchName'] +--- + +# SavedSearchName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the saved search. | [optional] +**Description** | Pointer to **NullableString** | The description of the saved search. | [optional] + +## Methods + +### NewSavedSearchName + +`func NewSavedSearchName() *SavedSearchName` + +NewSavedSearchName instantiates a new SavedSearchName 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 + +### NewSavedSearchNameWithDefaults + +`func NewSavedSearchNameWithDefaults() *SavedSearchName` + +NewSavedSearchNameWithDefaults instantiates a new SavedSearchName 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 + +### GetName + +`func (o *SavedSearchName) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SavedSearchName) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SavedSearchName) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SavedSearchName) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *SavedSearchName) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SavedSearchName) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SavedSearchName) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SavedSearchName) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *SavedSearchName) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *SavedSearchName) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Schedule.md b/docs/tools/sdk/go/Reference/V2024/Models/Schedule.md new file mode 100644 index 000000000..abc9cc463 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Schedule.md @@ -0,0 +1,204 @@ +--- +id: v2024-schedule +title: Schedule +pagination_label: Schedule +sidebar_label: Schedule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule', 'V2024Schedule'] +slug: /tools/sdk/go/v2024/models/schedule +tags: ['SDK', 'Software Development Kit', 'Schedule', 'V2024Schedule'] +--- + +# Schedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set. | +**Months** | Pointer to [**NullableScheduleMonths**](schedule-months) | | [optional] +**Days** | Pointer to [**ScheduleDays**](schedule-days) | | [optional] +**Hours** | [**ScheduleHours**](schedule-hours) | | +**Expiration** | Pointer to **NullableTime** | Specifies the time after which this schedule will no longer occur. | [optional] +**TimeZoneId** | Pointer to **string** | The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST. | [optional] + +## Methods + +### NewSchedule + +`func NewSchedule(type_ string, hours ScheduleHours, ) *Schedule` + +NewSchedule instantiates a new Schedule 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 + +### NewScheduleWithDefaults + +`func NewScheduleWithDefaults() *Schedule` + +NewScheduleWithDefaults instantiates a new Schedule 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 + +### GetType + +`func (o *Schedule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Schedule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Schedule) SetType(v string)` + +SetType sets Type field to given value. + + +### GetMonths + +`func (o *Schedule) GetMonths() ScheduleMonths` + +GetMonths returns the Months field if non-nil, zero value otherwise. + +### GetMonthsOk + +`func (o *Schedule) GetMonthsOk() (*ScheduleMonths, bool)` + +GetMonthsOk returns a tuple with the Months field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMonths + +`func (o *Schedule) SetMonths(v ScheduleMonths)` + +SetMonths sets Months field to given value. + +### HasMonths + +`func (o *Schedule) HasMonths() bool` + +HasMonths returns a boolean if a field has been set. + +### SetMonthsNil + +`func (o *Schedule) SetMonthsNil(b bool)` + + SetMonthsNil sets the value for Months to be an explicit nil + +### UnsetMonths +`func (o *Schedule) UnsetMonths()` + +UnsetMonths ensures that no value is present for Months, not even an explicit nil +### GetDays + +`func (o *Schedule) GetDays() ScheduleDays` + +GetDays returns the Days field if non-nil, zero value otherwise. + +### GetDaysOk + +`func (o *Schedule) GetDaysOk() (*ScheduleDays, bool)` + +GetDaysOk returns a tuple with the Days field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDays + +`func (o *Schedule) SetDays(v ScheduleDays)` + +SetDays sets Days field to given value. + +### HasDays + +`func (o *Schedule) HasDays() bool` + +HasDays returns a boolean if a field has been set. + +### GetHours + +`func (o *Schedule) GetHours() ScheduleHours` + +GetHours returns the Hours field if non-nil, zero value otherwise. + +### GetHoursOk + +`func (o *Schedule) GetHoursOk() (*ScheduleHours, bool)` + +GetHoursOk returns a tuple with the Hours field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHours + +`func (o *Schedule) SetHours(v ScheduleHours)` + +SetHours sets Hours field to given value. + + +### GetExpiration + +`func (o *Schedule) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *Schedule) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *Schedule) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *Schedule) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + +### SetExpirationNil + +`func (o *Schedule) SetExpirationNil(b bool)` + + SetExpirationNil sets the value for Expiration to be an explicit nil + +### UnsetExpiration +`func (o *Schedule) UnsetExpiration()` + +UnsetExpiration ensures that no value is present for Expiration, not even an explicit nil +### GetTimeZoneId + +`func (o *Schedule) GetTimeZoneId() string` + +GetTimeZoneId returns the TimeZoneId field if non-nil, zero value otherwise. + +### GetTimeZoneIdOk + +`func (o *Schedule) GetTimeZoneIdOk() (*string, bool)` + +GetTimeZoneIdOk returns a tuple with the TimeZoneId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZoneId + +`func (o *Schedule) SetTimeZoneId(v string)` + +SetTimeZoneId sets TimeZoneId field to given value. + +### HasTimeZoneId + +`func (o *Schedule) HasTimeZoneId() bool` + +HasTimeZoneId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Schedule1.md b/docs/tools/sdk/go/Reference/V2024/Models/Schedule1.md new file mode 100644 index 000000000..4e6b129d4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Schedule1.md @@ -0,0 +1,80 @@ +--- +id: v2024-schedule1 +title: Schedule1 +pagination_label: Schedule1 +sidebar_label: Schedule1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule1', 'V2024Schedule1'] +slug: /tools/sdk/go/v2024/models/schedule1 +tags: ['SDK', 'Software Development Kit', 'Schedule1', 'V2024Schedule1'] +--- + +# Schedule1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of the Schedule. | +**CronExpression** | **string** | The cron expression of the schedule. | + +## Methods + +### NewSchedule1 + +`func NewSchedule1(type_ string, cronExpression string, ) *Schedule1` + +NewSchedule1 instantiates a new Schedule1 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 + +### NewSchedule1WithDefaults + +`func NewSchedule1WithDefaults() *Schedule1` + +NewSchedule1WithDefaults instantiates a new Schedule1 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 + +### GetType + +`func (o *Schedule1) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Schedule1) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Schedule1) SetType(v string)` + +SetType sets Type field to given value. + + +### GetCronExpression + +`func (o *Schedule1) GetCronExpression() string` + +GetCronExpression returns the CronExpression field if non-nil, zero value otherwise. + +### GetCronExpressionOk + +`func (o *Schedule1) GetCronExpressionOk() (*string, bool)` + +GetCronExpressionOk returns a tuple with the CronExpression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCronExpression + +`func (o *Schedule1) SetCronExpression(v string)` + +SetCronExpression sets CronExpression field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Schedule2.md b/docs/tools/sdk/go/Reference/V2024/Models/Schedule2.md new file mode 100644 index 000000000..d829dbf70 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Schedule2.md @@ -0,0 +1,204 @@ +--- +id: v2024-schedule2 +title: Schedule2 +pagination_label: Schedule2 +sidebar_label: Schedule2 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule2', 'V2024Schedule2'] +slug: /tools/sdk/go/v2024/models/schedule2 +tags: ['SDK', 'Software Development Kit', 'Schedule2', 'V2024Schedule2'] +--- + +# Schedule2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**ScheduleType**](schedule-type) | | +**Months** | Pointer to [**Schedule2Months**](schedule2-months) | | [optional] +**Days** | Pointer to [**Schedule2Days**](schedule2-days) | | [optional] +**Hours** | [**Schedule2Hours**](schedule2-hours) | | +**Expiration** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**TimeZoneId** | Pointer to **NullableString** | The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used. | [optional] + +## Methods + +### NewSchedule2 + +`func NewSchedule2(type_ ScheduleType, hours Schedule2Hours, ) *Schedule2` + +NewSchedule2 instantiates a new Schedule2 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 + +### NewSchedule2WithDefaults + +`func NewSchedule2WithDefaults() *Schedule2` + +NewSchedule2WithDefaults instantiates a new Schedule2 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 + +### GetType + +`func (o *Schedule2) GetType() ScheduleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Schedule2) GetTypeOk() (*ScheduleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Schedule2) SetType(v ScheduleType)` + +SetType sets Type field to given value. + + +### GetMonths + +`func (o *Schedule2) GetMonths() Schedule2Months` + +GetMonths returns the Months field if non-nil, zero value otherwise. + +### GetMonthsOk + +`func (o *Schedule2) GetMonthsOk() (*Schedule2Months, bool)` + +GetMonthsOk returns a tuple with the Months field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMonths + +`func (o *Schedule2) SetMonths(v Schedule2Months)` + +SetMonths sets Months field to given value. + +### HasMonths + +`func (o *Schedule2) HasMonths() bool` + +HasMonths returns a boolean if a field has been set. + +### GetDays + +`func (o *Schedule2) GetDays() Schedule2Days` + +GetDays returns the Days field if non-nil, zero value otherwise. + +### GetDaysOk + +`func (o *Schedule2) GetDaysOk() (*Schedule2Days, bool)` + +GetDaysOk returns a tuple with the Days field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDays + +`func (o *Schedule2) SetDays(v Schedule2Days)` + +SetDays sets Days field to given value. + +### HasDays + +`func (o *Schedule2) HasDays() bool` + +HasDays returns a boolean if a field has been set. + +### GetHours + +`func (o *Schedule2) GetHours() Schedule2Hours` + +GetHours returns the Hours field if non-nil, zero value otherwise. + +### GetHoursOk + +`func (o *Schedule2) GetHoursOk() (*Schedule2Hours, bool)` + +GetHoursOk returns a tuple with the Hours field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHours + +`func (o *Schedule2) SetHours(v Schedule2Hours)` + +SetHours sets Hours field to given value. + + +### GetExpiration + +`func (o *Schedule2) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *Schedule2) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *Schedule2) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *Schedule2) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + +### SetExpirationNil + +`func (o *Schedule2) SetExpirationNil(b bool)` + + SetExpirationNil sets the value for Expiration to be an explicit nil + +### UnsetExpiration +`func (o *Schedule2) UnsetExpiration()` + +UnsetExpiration ensures that no value is present for Expiration, not even an explicit nil +### GetTimeZoneId + +`func (o *Schedule2) GetTimeZoneId() string` + +GetTimeZoneId returns the TimeZoneId field if non-nil, zero value otherwise. + +### GetTimeZoneIdOk + +`func (o *Schedule2) GetTimeZoneIdOk() (*string, bool)` + +GetTimeZoneIdOk returns a tuple with the TimeZoneId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZoneId + +`func (o *Schedule2) SetTimeZoneId(v string)` + +SetTimeZoneId sets TimeZoneId field to given value. + +### HasTimeZoneId + +`func (o *Schedule2) HasTimeZoneId() bool` + +HasTimeZoneId returns a boolean if a field has been set. + +### SetTimeZoneIdNil + +`func (o *Schedule2) SetTimeZoneIdNil(b bool)` + + SetTimeZoneIdNil sets the value for TimeZoneId to be an explicit nil + +### UnsetTimeZoneId +`func (o *Schedule2) UnsetTimeZoneId()` + +UnsetTimeZoneId ensures that no value is present for TimeZoneId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Schedule2Days.md b/docs/tools/sdk/go/Reference/V2024/Models/Schedule2Days.md new file mode 100644 index 000000000..b3dce7cdf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Schedule2Days.md @@ -0,0 +1,90 @@ +--- +id: v2024-schedule2-days +title: Schedule2Days +pagination_label: Schedule2Days +sidebar_label: Schedule2Days +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule2Days', 'V2024Schedule2Days'] +slug: /tools/sdk/go/v2024/models/schedule2-days +tags: ['SDK', 'Software Development Kit', 'Schedule2Days', 'V2024Schedule2Days'] +--- + +# Schedule2Days + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **string** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Methods + +### NewSchedule2Days + +`func NewSchedule2Days() *Schedule2Days` + +NewSchedule2Days instantiates a new Schedule2Days 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 + +### NewSchedule2DaysWithDefaults + +`func NewSchedule2DaysWithDefaults() *Schedule2Days` + +NewSchedule2DaysWithDefaults instantiates a new Schedule2Days 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 + +### GetApplicationId + +`func (o *Schedule2Days) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *Schedule2Days) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *Schedule2Days) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *Schedule2Days) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### GetAccountMatchConfig + +`func (o *Schedule2Days) GetAccountMatchConfig() SelectorAccountMatchConfig` + +GetAccountMatchConfig returns the AccountMatchConfig field if non-nil, zero value otherwise. + +### GetAccountMatchConfigOk + +`func (o *Schedule2Days) GetAccountMatchConfigOk() (*SelectorAccountMatchConfig, bool)` + +GetAccountMatchConfigOk returns a tuple with the AccountMatchConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountMatchConfig + +`func (o *Schedule2Days) SetAccountMatchConfig(v SelectorAccountMatchConfig)` + +SetAccountMatchConfig sets AccountMatchConfig field to given value. + +### HasAccountMatchConfig + +`func (o *Schedule2Days) HasAccountMatchConfig() bool` + +HasAccountMatchConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Schedule2Hours.md b/docs/tools/sdk/go/Reference/V2024/Models/Schedule2Hours.md new file mode 100644 index 000000000..cd6f40bd3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Schedule2Hours.md @@ -0,0 +1,90 @@ +--- +id: v2024-schedule2-hours +title: Schedule2Hours +pagination_label: Schedule2Hours +sidebar_label: Schedule2Hours +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule2Hours', 'V2024Schedule2Hours'] +slug: /tools/sdk/go/v2024/models/schedule2-hours +tags: ['SDK', 'Software Development Kit', 'Schedule2Hours', 'V2024Schedule2Hours'] +--- + +# Schedule2Hours + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **string** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Methods + +### NewSchedule2Hours + +`func NewSchedule2Hours() *Schedule2Hours` + +NewSchedule2Hours instantiates a new Schedule2Hours 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 + +### NewSchedule2HoursWithDefaults + +`func NewSchedule2HoursWithDefaults() *Schedule2Hours` + +NewSchedule2HoursWithDefaults instantiates a new Schedule2Hours 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 + +### GetApplicationId + +`func (o *Schedule2Hours) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *Schedule2Hours) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *Schedule2Hours) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *Schedule2Hours) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### GetAccountMatchConfig + +`func (o *Schedule2Hours) GetAccountMatchConfig() SelectorAccountMatchConfig` + +GetAccountMatchConfig returns the AccountMatchConfig field if non-nil, zero value otherwise. + +### GetAccountMatchConfigOk + +`func (o *Schedule2Hours) GetAccountMatchConfigOk() (*SelectorAccountMatchConfig, bool)` + +GetAccountMatchConfigOk returns a tuple with the AccountMatchConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountMatchConfig + +`func (o *Schedule2Hours) SetAccountMatchConfig(v SelectorAccountMatchConfig)` + +SetAccountMatchConfig sets AccountMatchConfig field to given value. + +### HasAccountMatchConfig + +`func (o *Schedule2Hours) HasAccountMatchConfig() bool` + +HasAccountMatchConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Schedule2Months.md b/docs/tools/sdk/go/Reference/V2024/Models/Schedule2Months.md new file mode 100644 index 000000000..1da7c87e1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Schedule2Months.md @@ -0,0 +1,90 @@ +--- +id: v2024-schedule2-months +title: Schedule2Months +pagination_label: Schedule2Months +sidebar_label: Schedule2Months +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule2Months', 'V2024Schedule2Months'] +slug: /tools/sdk/go/v2024/models/schedule2-months +tags: ['SDK', 'Software Development Kit', 'Schedule2Months', 'V2024Schedule2Months'] +--- + +# Schedule2Months + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **string** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Methods + +### NewSchedule2Months + +`func NewSchedule2Months() *Schedule2Months` + +NewSchedule2Months instantiates a new Schedule2Months 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 + +### NewSchedule2MonthsWithDefaults + +`func NewSchedule2MonthsWithDefaults() *Schedule2Months` + +NewSchedule2MonthsWithDefaults instantiates a new Schedule2Months 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 + +### GetApplicationId + +`func (o *Schedule2Months) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *Schedule2Months) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *Schedule2Months) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *Schedule2Months) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### GetAccountMatchConfig + +`func (o *Schedule2Months) GetAccountMatchConfig() SelectorAccountMatchConfig` + +GetAccountMatchConfig returns the AccountMatchConfig field if non-nil, zero value otherwise. + +### GetAccountMatchConfigOk + +`func (o *Schedule2Months) GetAccountMatchConfigOk() (*SelectorAccountMatchConfig, bool)` + +GetAccountMatchConfigOk returns a tuple with the AccountMatchConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountMatchConfig + +`func (o *Schedule2Months) SetAccountMatchConfig(v SelectorAccountMatchConfig)` + +SetAccountMatchConfig sets AccountMatchConfig field to given value. + +### HasAccountMatchConfig + +`func (o *Schedule2Months) HasAccountMatchConfig() bool` + +HasAccountMatchConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ScheduleDays.md b/docs/tools/sdk/go/Reference/V2024/Models/ScheduleDays.md new file mode 100644 index 000000000..de3d186df --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ScheduleDays.md @@ -0,0 +1,116 @@ +--- +id: v2024-schedule-days +title: ScheduleDays +pagination_label: ScheduleDays +sidebar_label: ScheduleDays +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduleDays', 'V2024ScheduleDays'] +slug: /tools/sdk/go/v2024/models/schedule-days +tags: ['SDK', 'Software Development Kit', 'ScheduleDays', 'V2024ScheduleDays'] +--- + +# ScheduleDays + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Enum type to specify days value | +**Values** | **[]string** | Values of the days based on the enum type mentioned above | +**Interval** | Pointer to **NullableInt64** | Interval between the cert generations | [optional] + +## Methods + +### NewScheduleDays + +`func NewScheduleDays(type_ string, values []string, ) *ScheduleDays` + +NewScheduleDays instantiates a new ScheduleDays 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 + +### NewScheduleDaysWithDefaults + +`func NewScheduleDaysWithDefaults() *ScheduleDays` + +NewScheduleDaysWithDefaults instantiates a new ScheduleDays 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 + +### GetType + +`func (o *ScheduleDays) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ScheduleDays) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ScheduleDays) SetType(v string)` + +SetType sets Type field to given value. + + +### GetValues + +`func (o *ScheduleDays) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *ScheduleDays) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *ScheduleDays) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### GetInterval + +`func (o *ScheduleDays) GetInterval() int64` + +GetInterval returns the Interval field if non-nil, zero value otherwise. + +### GetIntervalOk + +`func (o *ScheduleDays) GetIntervalOk() (*int64, bool)` + +GetIntervalOk returns a tuple with the Interval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterval + +`func (o *ScheduleDays) SetInterval(v int64)` + +SetInterval sets Interval field to given value. + +### HasInterval + +`func (o *ScheduleDays) HasInterval() bool` + +HasInterval returns a boolean if a field has been set. + +### SetIntervalNil + +`func (o *ScheduleDays) SetIntervalNil(b bool)` + + SetIntervalNil sets the value for Interval to be an explicit nil + +### UnsetInterval +`func (o *ScheduleDays) UnsetInterval()` + +UnsetInterval ensures that no value is present for Interval, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ScheduleHours.md b/docs/tools/sdk/go/Reference/V2024/Models/ScheduleHours.md new file mode 100644 index 000000000..09ace5fbe --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ScheduleHours.md @@ -0,0 +1,116 @@ +--- +id: v2024-schedule-hours +title: ScheduleHours +pagination_label: ScheduleHours +sidebar_label: ScheduleHours +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduleHours', 'V2024ScheduleHours'] +slug: /tools/sdk/go/v2024/models/schedule-hours +tags: ['SDK', 'Software Development Kit', 'ScheduleHours', 'V2024ScheduleHours'] +--- + +# ScheduleHours + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Enum type to specify hours value | +**Values** | **[]string** | Values of the days based on the enum type mentioned above | +**Interval** | Pointer to **NullableInt64** | Interval between the cert generations | [optional] + +## Methods + +### NewScheduleHours + +`func NewScheduleHours(type_ string, values []string, ) *ScheduleHours` + +NewScheduleHours instantiates a new ScheduleHours 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 + +### NewScheduleHoursWithDefaults + +`func NewScheduleHoursWithDefaults() *ScheduleHours` + +NewScheduleHoursWithDefaults instantiates a new ScheduleHours 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 + +### GetType + +`func (o *ScheduleHours) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ScheduleHours) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ScheduleHours) SetType(v string)` + +SetType sets Type field to given value. + + +### GetValues + +`func (o *ScheduleHours) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *ScheduleHours) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *ScheduleHours) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### GetInterval + +`func (o *ScheduleHours) GetInterval() int64` + +GetInterval returns the Interval field if non-nil, zero value otherwise. + +### GetIntervalOk + +`func (o *ScheduleHours) GetIntervalOk() (*int64, bool)` + +GetIntervalOk returns a tuple with the Interval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterval + +`func (o *ScheduleHours) SetInterval(v int64)` + +SetInterval sets Interval field to given value. + +### HasInterval + +`func (o *ScheduleHours) HasInterval() bool` + +HasInterval returns a boolean if a field has been set. + +### SetIntervalNil + +`func (o *ScheduleHours) SetIntervalNil(b bool)` + + SetIntervalNil sets the value for Interval to be an explicit nil + +### UnsetInterval +`func (o *ScheduleHours) UnsetInterval()` + +UnsetInterval ensures that no value is present for Interval, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ScheduleMonths.md b/docs/tools/sdk/go/Reference/V2024/Models/ScheduleMonths.md new file mode 100644 index 000000000..3626f115f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ScheduleMonths.md @@ -0,0 +1,106 @@ +--- +id: v2024-schedule-months +title: ScheduleMonths +pagination_label: ScheduleMonths +sidebar_label: ScheduleMonths +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduleMonths', 'V2024ScheduleMonths'] +slug: /tools/sdk/go/v2024/models/schedule-months +tags: ['SDK', 'Software Development Kit', 'ScheduleMonths', 'V2024ScheduleMonths'] +--- + +# ScheduleMonths + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Enum type to specify months value | +**Values** | **[]string** | Values of the months based on the enum type mentioned above | +**Interval** | Pointer to **int64** | Interval between the cert generations | [optional] + +## Methods + +### NewScheduleMonths + +`func NewScheduleMonths(type_ string, values []string, ) *ScheduleMonths` + +NewScheduleMonths instantiates a new ScheduleMonths 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 + +### NewScheduleMonthsWithDefaults + +`func NewScheduleMonthsWithDefaults() *ScheduleMonths` + +NewScheduleMonthsWithDefaults instantiates a new ScheduleMonths 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 + +### GetType + +`func (o *ScheduleMonths) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ScheduleMonths) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ScheduleMonths) SetType(v string)` + +SetType sets Type field to given value. + + +### GetValues + +`func (o *ScheduleMonths) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *ScheduleMonths) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *ScheduleMonths) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### GetInterval + +`func (o *ScheduleMonths) GetInterval() int64` + +GetInterval returns the Interval field if non-nil, zero value otherwise. + +### GetIntervalOk + +`func (o *ScheduleMonths) GetIntervalOk() (*int64, bool)` + +GetIntervalOk returns a tuple with the Interval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterval + +`func (o *ScheduleMonths) SetInterval(v int64)` + +SetInterval sets Interval field to given value. + +### HasInterval + +`func (o *ScheduleMonths) HasInterval() bool` + +HasInterval returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ScheduleType.md b/docs/tools/sdk/go/Reference/V2024/Models/ScheduleType.md new file mode 100644 index 000000000..4c52a6501 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ScheduleType.md @@ -0,0 +1,27 @@ +--- +id: v2024-schedule-type +title: ScheduleType +pagination_label: ScheduleType +sidebar_label: ScheduleType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduleType', 'V2024ScheduleType'] +slug: /tools/sdk/go/v2024/models/schedule-type +tags: ['SDK', 'Software Development Kit', 'ScheduleType', 'V2024ScheduleType'] +--- + +# ScheduleType + +## Enum + + +* `DAILY` (value: `"DAILY"`) + +* `WEEKLY` (value: `"WEEKLY"`) + +* `MONTHLY` (value: `"MONTHLY"`) + +* `CALENDAR` (value: `"CALENDAR"`) + +* `ANNUALLY` (value: `"ANNUALLY"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionPayload.md b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionPayload.md new file mode 100644 index 000000000..5ca711474 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionPayload.md @@ -0,0 +1,158 @@ +--- +id: v2024-scheduled-action-payload +title: ScheduledActionPayload +pagination_label: ScheduledActionPayload +sidebar_label: ScheduledActionPayload +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledActionPayload', 'V2024ScheduledActionPayload'] +slug: /tools/sdk/go/v2024/models/scheduled-action-payload +tags: ['SDK', 'Software Development Kit', 'ScheduledActionPayload', 'V2024ScheduledActionPayload'] +--- + +# ScheduledActionPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobType** | **string** | Type of the scheduled job. | +**StartTime** | Pointer to **SailPointTime** | The time when this scheduled action should start. Optional. | [optional] +**CronString** | Pointer to **string** | Cron expression defining the schedule for this action. Optional for repeated events. | [optional] +**TimeZoneId** | Pointer to **string** | Time zone ID for interpreting the cron expression. Optional, will default to current time zone. | [optional] +**Content** | [**ScheduledActionPayloadContent**](scheduled-action-payload-content) | | + +## Methods + +### NewScheduledActionPayload + +`func NewScheduledActionPayload(jobType string, content ScheduledActionPayloadContent, ) *ScheduledActionPayload` + +NewScheduledActionPayload instantiates a new ScheduledActionPayload 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 + +### NewScheduledActionPayloadWithDefaults + +`func NewScheduledActionPayloadWithDefaults() *ScheduledActionPayload` + +NewScheduledActionPayloadWithDefaults instantiates a new ScheduledActionPayload 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 + +### GetJobType + +`func (o *ScheduledActionPayload) GetJobType() string` + +GetJobType returns the JobType field if non-nil, zero value otherwise. + +### GetJobTypeOk + +`func (o *ScheduledActionPayload) GetJobTypeOk() (*string, bool)` + +GetJobTypeOk returns a tuple with the JobType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobType + +`func (o *ScheduledActionPayload) SetJobType(v string)` + +SetJobType sets JobType field to given value. + + +### GetStartTime + +`func (o *ScheduledActionPayload) GetStartTime() SailPointTime` + +GetStartTime returns the StartTime field if non-nil, zero value otherwise. + +### GetStartTimeOk + +`func (o *ScheduledActionPayload) GetStartTimeOk() (*SailPointTime, bool)` + +GetStartTimeOk returns a tuple with the StartTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartTime + +`func (o *ScheduledActionPayload) SetStartTime(v SailPointTime)` + +SetStartTime sets StartTime field to given value. + +### HasStartTime + +`func (o *ScheduledActionPayload) HasStartTime() bool` + +HasStartTime returns a boolean if a field has been set. + +### GetCronString + +`func (o *ScheduledActionPayload) GetCronString() string` + +GetCronString returns the CronString field if non-nil, zero value otherwise. + +### GetCronStringOk + +`func (o *ScheduledActionPayload) GetCronStringOk() (*string, bool)` + +GetCronStringOk returns a tuple with the CronString field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCronString + +`func (o *ScheduledActionPayload) SetCronString(v string)` + +SetCronString sets CronString field to given value. + +### HasCronString + +`func (o *ScheduledActionPayload) HasCronString() bool` + +HasCronString returns a boolean if a field has been set. + +### GetTimeZoneId + +`func (o *ScheduledActionPayload) GetTimeZoneId() string` + +GetTimeZoneId returns the TimeZoneId field if non-nil, zero value otherwise. + +### GetTimeZoneIdOk + +`func (o *ScheduledActionPayload) GetTimeZoneIdOk() (*string, bool)` + +GetTimeZoneIdOk returns a tuple with the TimeZoneId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZoneId + +`func (o *ScheduledActionPayload) SetTimeZoneId(v string)` + +SetTimeZoneId sets TimeZoneId field to given value. + +### HasTimeZoneId + +`func (o *ScheduledActionPayload) HasTimeZoneId() bool` + +HasTimeZoneId returns a boolean if a field has been set. + +### GetContent + +`func (o *ScheduledActionPayload) GetContent() ScheduledActionPayloadContent` + +GetContent returns the Content field if non-nil, zero value otherwise. + +### GetContentOk + +`func (o *ScheduledActionPayload) GetContentOk() (*ScheduledActionPayloadContent, bool)` + +GetContentOk returns a tuple with the Content field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContent + +`func (o *ScheduledActionPayload) SetContent(v ScheduledActionPayloadContent)` + +SetContent sets Content field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionPayloadContent.md b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionPayloadContent.md new file mode 100644 index 000000000..116f61c60 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionPayloadContent.md @@ -0,0 +1,163 @@ +--- +id: v2024-scheduled-action-payload-content +title: ScheduledActionPayloadContent +pagination_label: ScheduledActionPayloadContent +sidebar_label: ScheduledActionPayloadContent +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledActionPayloadContent', 'V2024ScheduledActionPayloadContent'] +slug: /tools/sdk/go/v2024/models/scheduled-action-payload-content +tags: ['SDK', 'Software Development Kit', 'ScheduledActionPayloadContent', 'V2024ScheduledActionPayloadContent'] +--- + +# ScheduledActionPayloadContent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Name of the scheduled action (maximum 50 characters). | +**BackupOptions** | Pointer to [**ScheduledActionPayloadContentBackupOptions**](scheduled-action-payload-content-backup-options) | | [optional] +**SourceBackupId** | Pointer to **string** | ID of the source backup. Required for CREATE_DRAFT jobs. | [optional] +**SourceTenant** | Pointer to **string** | Source tenant identifier. Required for CREATE_DRAFT jobs. | [optional] +**DraftId** | Pointer to **string** | ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs. | [optional] + +## Methods + +### NewScheduledActionPayloadContent + +`func NewScheduledActionPayloadContent(name string, ) *ScheduledActionPayloadContent` + +NewScheduledActionPayloadContent instantiates a new ScheduledActionPayloadContent 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 + +### NewScheduledActionPayloadContentWithDefaults + +`func NewScheduledActionPayloadContentWithDefaults() *ScheduledActionPayloadContent` + +NewScheduledActionPayloadContentWithDefaults instantiates a new ScheduledActionPayloadContent 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 + +### GetName + +`func (o *ScheduledActionPayloadContent) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ScheduledActionPayloadContent) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ScheduledActionPayloadContent) SetName(v string)` + +SetName sets Name field to given value. + + +### GetBackupOptions + +`func (o *ScheduledActionPayloadContent) GetBackupOptions() ScheduledActionPayloadContentBackupOptions` + +GetBackupOptions returns the BackupOptions field if non-nil, zero value otherwise. + +### GetBackupOptionsOk + +`func (o *ScheduledActionPayloadContent) GetBackupOptionsOk() (*ScheduledActionPayloadContentBackupOptions, bool)` + +GetBackupOptionsOk returns a tuple with the BackupOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackupOptions + +`func (o *ScheduledActionPayloadContent) SetBackupOptions(v ScheduledActionPayloadContentBackupOptions)` + +SetBackupOptions sets BackupOptions field to given value. + +### HasBackupOptions + +`func (o *ScheduledActionPayloadContent) HasBackupOptions() bool` + +HasBackupOptions returns a boolean if a field has been set. + +### GetSourceBackupId + +`func (o *ScheduledActionPayloadContent) GetSourceBackupId() string` + +GetSourceBackupId returns the SourceBackupId field if non-nil, zero value otherwise. + +### GetSourceBackupIdOk + +`func (o *ScheduledActionPayloadContent) GetSourceBackupIdOk() (*string, bool)` + +GetSourceBackupIdOk returns a tuple with the SourceBackupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceBackupId + +`func (o *ScheduledActionPayloadContent) SetSourceBackupId(v string)` + +SetSourceBackupId sets SourceBackupId field to given value. + +### HasSourceBackupId + +`func (o *ScheduledActionPayloadContent) HasSourceBackupId() bool` + +HasSourceBackupId returns a boolean if a field has been set. + +### GetSourceTenant + +`func (o *ScheduledActionPayloadContent) GetSourceTenant() string` + +GetSourceTenant returns the SourceTenant field if non-nil, zero value otherwise. + +### GetSourceTenantOk + +`func (o *ScheduledActionPayloadContent) GetSourceTenantOk() (*string, bool)` + +GetSourceTenantOk returns a tuple with the SourceTenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceTenant + +`func (o *ScheduledActionPayloadContent) SetSourceTenant(v string)` + +SetSourceTenant sets SourceTenant field to given value. + +### HasSourceTenant + +`func (o *ScheduledActionPayloadContent) HasSourceTenant() bool` + +HasSourceTenant returns a boolean if a field has been set. + +### GetDraftId + +`func (o *ScheduledActionPayloadContent) GetDraftId() string` + +GetDraftId returns the DraftId field if non-nil, zero value otherwise. + +### GetDraftIdOk + +`func (o *ScheduledActionPayloadContent) GetDraftIdOk() (*string, bool)` + +GetDraftIdOk returns a tuple with the DraftId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDraftId + +`func (o *ScheduledActionPayloadContent) SetDraftId(v string)` + +SetDraftId sets DraftId field to given value. + +### HasDraftId + +`func (o *ScheduledActionPayloadContent) HasDraftId() bool` + +HasDraftId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionPayloadContentBackupOptions.md b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionPayloadContentBackupOptions.md new file mode 100644 index 000000000..89167414b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionPayloadContentBackupOptions.md @@ -0,0 +1,90 @@ +--- +id: v2024-scheduled-action-payload-content-backup-options +title: ScheduledActionPayloadContentBackupOptions +pagination_label: ScheduledActionPayloadContentBackupOptions +sidebar_label: ScheduledActionPayloadContentBackupOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledActionPayloadContentBackupOptions', 'V2024ScheduledActionPayloadContentBackupOptions'] +slug: /tools/sdk/go/v2024/models/scheduled-action-payload-content-backup-options +tags: ['SDK', 'Software Development Kit', 'ScheduledActionPayloadContentBackupOptions', 'V2024ScheduledActionPayloadContentBackupOptions'] +--- + +# ScheduledActionPayloadContentBackupOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludeTypes** | Pointer to **[]string** | Object types that are to be included in the backup. | [optional] +**ObjectOptions** | Pointer to [**map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue**](scheduled-action-response-content-backup-options-object-options-value) | Map of objectType string to the options to be passed to the target service for that objectType. | [optional] + +## Methods + +### NewScheduledActionPayloadContentBackupOptions + +`func NewScheduledActionPayloadContentBackupOptions() *ScheduledActionPayloadContentBackupOptions` + +NewScheduledActionPayloadContentBackupOptions instantiates a new ScheduledActionPayloadContentBackupOptions 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 + +### NewScheduledActionPayloadContentBackupOptionsWithDefaults + +`func NewScheduledActionPayloadContentBackupOptionsWithDefaults() *ScheduledActionPayloadContentBackupOptions` + +NewScheduledActionPayloadContentBackupOptionsWithDefaults instantiates a new ScheduledActionPayloadContentBackupOptions 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 + +### GetIncludeTypes + +`func (o *ScheduledActionPayloadContentBackupOptions) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *ScheduledActionPayloadContentBackupOptions) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *ScheduledActionPayloadContentBackupOptions) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *ScheduledActionPayloadContentBackupOptions) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *ScheduledActionPayloadContentBackupOptions) GetObjectOptions() map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *ScheduledActionPayloadContentBackupOptions) GetObjectOptionsOk() (*map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *ScheduledActionPayloadContentBackupOptions) SetObjectOptions(v map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *ScheduledActionPayloadContentBackupOptions) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionResponse.md new file mode 100644 index 000000000..1f5cfb778 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionResponse.md @@ -0,0 +1,220 @@ +--- +id: v2024-scheduled-action-response +title: ScheduledActionResponse +pagination_label: ScheduledActionResponse +sidebar_label: ScheduledActionResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledActionResponse', 'V2024ScheduledActionResponse'] +slug: /tools/sdk/go/v2024/models/scheduled-action-response +tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponse', 'V2024ScheduledActionResponse'] +--- + +# ScheduledActionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for this scheduled action. | [optional] +**Created** | Pointer to **SailPointTime** | The time when this scheduled action was created. | [optional] +**JobType** | Pointer to **string** | Type of the scheduled job. | [optional] +**Content** | Pointer to [**ScheduledActionResponseContent**](scheduled-action-response-content) | | [optional] +**StartTime** | Pointer to **SailPointTime** | The time when this scheduled action should start. | [optional] +**CronString** | Pointer to **string** | Cron expression defining the schedule for this action. | [optional] +**TimeZoneId** | Pointer to **string** | Time zone ID for interpreting the cron expression. | [optional] + +## Methods + +### NewScheduledActionResponse + +`func NewScheduledActionResponse() *ScheduledActionResponse` + +NewScheduledActionResponse instantiates a new ScheduledActionResponse 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 + +### NewScheduledActionResponseWithDefaults + +`func NewScheduledActionResponseWithDefaults() *ScheduledActionResponse` + +NewScheduledActionResponseWithDefaults instantiates a new ScheduledActionResponse 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 + +### GetId + +`func (o *ScheduledActionResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ScheduledActionResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ScheduledActionResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ScheduledActionResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreated + +`func (o *ScheduledActionResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ScheduledActionResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ScheduledActionResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ScheduledActionResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetJobType + +`func (o *ScheduledActionResponse) GetJobType() string` + +GetJobType returns the JobType field if non-nil, zero value otherwise. + +### GetJobTypeOk + +`func (o *ScheduledActionResponse) GetJobTypeOk() (*string, bool)` + +GetJobTypeOk returns a tuple with the JobType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobType + +`func (o *ScheduledActionResponse) SetJobType(v string)` + +SetJobType sets JobType field to given value. + +### HasJobType + +`func (o *ScheduledActionResponse) HasJobType() bool` + +HasJobType returns a boolean if a field has been set. + +### GetContent + +`func (o *ScheduledActionResponse) GetContent() ScheduledActionResponseContent` + +GetContent returns the Content field if non-nil, zero value otherwise. + +### GetContentOk + +`func (o *ScheduledActionResponse) GetContentOk() (*ScheduledActionResponseContent, bool)` + +GetContentOk returns a tuple with the Content field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContent + +`func (o *ScheduledActionResponse) SetContent(v ScheduledActionResponseContent)` + +SetContent sets Content field to given value. + +### HasContent + +`func (o *ScheduledActionResponse) HasContent() bool` + +HasContent returns a boolean if a field has been set. + +### GetStartTime + +`func (o *ScheduledActionResponse) GetStartTime() SailPointTime` + +GetStartTime returns the StartTime field if non-nil, zero value otherwise. + +### GetStartTimeOk + +`func (o *ScheduledActionResponse) GetStartTimeOk() (*SailPointTime, bool)` + +GetStartTimeOk returns a tuple with the StartTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartTime + +`func (o *ScheduledActionResponse) SetStartTime(v SailPointTime)` + +SetStartTime sets StartTime field to given value. + +### HasStartTime + +`func (o *ScheduledActionResponse) HasStartTime() bool` + +HasStartTime returns a boolean if a field has been set. + +### GetCronString + +`func (o *ScheduledActionResponse) GetCronString() string` + +GetCronString returns the CronString field if non-nil, zero value otherwise. + +### GetCronStringOk + +`func (o *ScheduledActionResponse) GetCronStringOk() (*string, bool)` + +GetCronStringOk returns a tuple with the CronString field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCronString + +`func (o *ScheduledActionResponse) SetCronString(v string)` + +SetCronString sets CronString field to given value. + +### HasCronString + +`func (o *ScheduledActionResponse) HasCronString() bool` + +HasCronString returns a boolean if a field has been set. + +### GetTimeZoneId + +`func (o *ScheduledActionResponse) GetTimeZoneId() string` + +GetTimeZoneId returns the TimeZoneId field if non-nil, zero value otherwise. + +### GetTimeZoneIdOk + +`func (o *ScheduledActionResponse) GetTimeZoneIdOk() (*string, bool)` + +GetTimeZoneIdOk returns a tuple with the TimeZoneId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZoneId + +`func (o *ScheduledActionResponse) SetTimeZoneId(v string)` + +SetTimeZoneId sets TimeZoneId field to given value. + +### HasTimeZoneId + +`func (o *ScheduledActionResponse) HasTimeZoneId() bool` + +HasTimeZoneId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionResponseContent.md b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionResponseContent.md new file mode 100644 index 000000000..7fba79a85 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionResponseContent.md @@ -0,0 +1,168 @@ +--- +id: v2024-scheduled-action-response-content +title: ScheduledActionResponseContent +pagination_label: ScheduledActionResponseContent +sidebar_label: ScheduledActionResponseContent +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledActionResponseContent', 'V2024ScheduledActionResponseContent'] +slug: /tools/sdk/go/v2024/models/scheduled-action-response-content +tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponseContent', 'V2024ScheduledActionResponseContent'] +--- + +# ScheduledActionResponseContent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the scheduled action (maximum 50 characters). | [optional] +**BackupOptions** | Pointer to [**ScheduledActionResponseContentBackupOptions**](scheduled-action-response-content-backup-options) | | [optional] +**SourceBackupId** | Pointer to **string** | ID of the source backup. Required for CREATE_DRAFT jobs only. | [optional] +**SourceTenant** | Pointer to **string** | Source tenant identifier. Required for CREATE_DRAFT jobs only. | [optional] +**DraftId** | Pointer to **string** | ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs only. | [optional] + +## Methods + +### NewScheduledActionResponseContent + +`func NewScheduledActionResponseContent() *ScheduledActionResponseContent` + +NewScheduledActionResponseContent instantiates a new ScheduledActionResponseContent 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 + +### NewScheduledActionResponseContentWithDefaults + +`func NewScheduledActionResponseContentWithDefaults() *ScheduledActionResponseContent` + +NewScheduledActionResponseContentWithDefaults instantiates a new ScheduledActionResponseContent 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 + +### GetName + +`func (o *ScheduledActionResponseContent) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ScheduledActionResponseContent) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ScheduledActionResponseContent) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ScheduledActionResponseContent) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetBackupOptions + +`func (o *ScheduledActionResponseContent) GetBackupOptions() ScheduledActionResponseContentBackupOptions` + +GetBackupOptions returns the BackupOptions field if non-nil, zero value otherwise. + +### GetBackupOptionsOk + +`func (o *ScheduledActionResponseContent) GetBackupOptionsOk() (*ScheduledActionResponseContentBackupOptions, bool)` + +GetBackupOptionsOk returns a tuple with the BackupOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackupOptions + +`func (o *ScheduledActionResponseContent) SetBackupOptions(v ScheduledActionResponseContentBackupOptions)` + +SetBackupOptions sets BackupOptions field to given value. + +### HasBackupOptions + +`func (o *ScheduledActionResponseContent) HasBackupOptions() bool` + +HasBackupOptions returns a boolean if a field has been set. + +### GetSourceBackupId + +`func (o *ScheduledActionResponseContent) GetSourceBackupId() string` + +GetSourceBackupId returns the SourceBackupId field if non-nil, zero value otherwise. + +### GetSourceBackupIdOk + +`func (o *ScheduledActionResponseContent) GetSourceBackupIdOk() (*string, bool)` + +GetSourceBackupIdOk returns a tuple with the SourceBackupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceBackupId + +`func (o *ScheduledActionResponseContent) SetSourceBackupId(v string)` + +SetSourceBackupId sets SourceBackupId field to given value. + +### HasSourceBackupId + +`func (o *ScheduledActionResponseContent) HasSourceBackupId() bool` + +HasSourceBackupId returns a boolean if a field has been set. + +### GetSourceTenant + +`func (o *ScheduledActionResponseContent) GetSourceTenant() string` + +GetSourceTenant returns the SourceTenant field if non-nil, zero value otherwise. + +### GetSourceTenantOk + +`func (o *ScheduledActionResponseContent) GetSourceTenantOk() (*string, bool)` + +GetSourceTenantOk returns a tuple with the SourceTenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceTenant + +`func (o *ScheduledActionResponseContent) SetSourceTenant(v string)` + +SetSourceTenant sets SourceTenant field to given value. + +### HasSourceTenant + +`func (o *ScheduledActionResponseContent) HasSourceTenant() bool` + +HasSourceTenant returns a boolean if a field has been set. + +### GetDraftId + +`func (o *ScheduledActionResponseContent) GetDraftId() string` + +GetDraftId returns the DraftId field if non-nil, zero value otherwise. + +### GetDraftIdOk + +`func (o *ScheduledActionResponseContent) GetDraftIdOk() (*string, bool)` + +GetDraftIdOk returns a tuple with the DraftId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDraftId + +`func (o *ScheduledActionResponseContent) SetDraftId(v string)` + +SetDraftId sets DraftId field to given value. + +### HasDraftId + +`func (o *ScheduledActionResponseContent) HasDraftId() bool` + +HasDraftId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionResponseContentBackupOptions.md b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionResponseContentBackupOptions.md new file mode 100644 index 000000000..72ae3eb98 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionResponseContentBackupOptions.md @@ -0,0 +1,90 @@ +--- +id: v2024-scheduled-action-response-content-backup-options +title: ScheduledActionResponseContentBackupOptions +pagination_label: ScheduledActionResponseContentBackupOptions +sidebar_label: ScheduledActionResponseContentBackupOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledActionResponseContentBackupOptions', 'V2024ScheduledActionResponseContentBackupOptions'] +slug: /tools/sdk/go/v2024/models/scheduled-action-response-content-backup-options +tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponseContentBackupOptions', 'V2024ScheduledActionResponseContentBackupOptions'] +--- + +# ScheduledActionResponseContentBackupOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludeTypes** | Pointer to **[]string** | Object types that are to be included in the backup. | [optional] +**ObjectOptions** | Pointer to [**map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue**](scheduled-action-response-content-backup-options-object-options-value) | Map of objectType string to the options to be passed to the target service for that objectType. | [optional] + +## Methods + +### NewScheduledActionResponseContentBackupOptions + +`func NewScheduledActionResponseContentBackupOptions() *ScheduledActionResponseContentBackupOptions` + +NewScheduledActionResponseContentBackupOptions instantiates a new ScheduledActionResponseContentBackupOptions 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 + +### NewScheduledActionResponseContentBackupOptionsWithDefaults + +`func NewScheduledActionResponseContentBackupOptionsWithDefaults() *ScheduledActionResponseContentBackupOptions` + +NewScheduledActionResponseContentBackupOptionsWithDefaults instantiates a new ScheduledActionResponseContentBackupOptions 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 + +### GetIncludeTypes + +`func (o *ScheduledActionResponseContentBackupOptions) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *ScheduledActionResponseContentBackupOptions) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *ScheduledActionResponseContentBackupOptions) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *ScheduledActionResponseContentBackupOptions) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *ScheduledActionResponseContentBackupOptions) GetObjectOptions() map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *ScheduledActionResponseContentBackupOptions) GetObjectOptionsOk() (*map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *ScheduledActionResponseContentBackupOptions) SetObjectOptions(v map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *ScheduledActionResponseContentBackupOptions) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionResponseContentBackupOptionsObjectOptionsValue.md b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionResponseContentBackupOptionsObjectOptionsValue.md new file mode 100644 index 000000000..e60c2e638 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledActionResponseContentBackupOptionsObjectOptionsValue.md @@ -0,0 +1,64 @@ +--- +id: v2024-scheduled-action-response-content-backup-options-object-options-value +title: ScheduledActionResponseContentBackupOptionsObjectOptionsValue +pagination_label: ScheduledActionResponseContentBackupOptionsObjectOptionsValue +sidebar_label: ScheduledActionResponseContentBackupOptionsObjectOptionsValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledActionResponseContentBackupOptionsObjectOptionsValue', 'V2024ScheduledActionResponseContentBackupOptionsObjectOptionsValue'] +slug: /tools/sdk/go/v2024/models/scheduled-action-response-content-backup-options-object-options-value +tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponseContentBackupOptionsObjectOptionsValue', 'V2024ScheduledActionResponseContentBackupOptionsObjectOptionsValue'] +--- + +# ScheduledActionResponseContentBackupOptionsObjectOptionsValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludedNames** | Pointer to **[]string** | Set of names to be included. | [optional] + +## Methods + +### NewScheduledActionResponseContentBackupOptionsObjectOptionsValue + +`func NewScheduledActionResponseContentBackupOptionsObjectOptionsValue() *ScheduledActionResponseContentBackupOptionsObjectOptionsValue` + +NewScheduledActionResponseContentBackupOptionsObjectOptionsValue instantiates a new ScheduledActionResponseContentBackupOptionsObjectOptionsValue 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 + +### NewScheduledActionResponseContentBackupOptionsObjectOptionsValueWithDefaults + +`func NewScheduledActionResponseContentBackupOptionsObjectOptionsValueWithDefaults() *ScheduledActionResponseContentBackupOptionsObjectOptionsValue` + +NewScheduledActionResponseContentBackupOptionsObjectOptionsValueWithDefaults instantiates a new ScheduledActionResponseContentBackupOptionsObjectOptionsValue 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 + +### GetIncludedNames + +`func (o *ScheduledActionResponseContentBackupOptionsObjectOptionsValue) GetIncludedNames() []string` + +GetIncludedNames returns the IncludedNames field if non-nil, zero value otherwise. + +### GetIncludedNamesOk + +`func (o *ScheduledActionResponseContentBackupOptionsObjectOptionsValue) GetIncludedNamesOk() (*[]string, bool)` + +GetIncludedNamesOk returns a tuple with the IncludedNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludedNames + +`func (o *ScheduledActionResponseContentBackupOptionsObjectOptionsValue) SetIncludedNames(v []string)` + +SetIncludedNames sets IncludedNames field to given value. + +### HasIncludedNames + +`func (o *ScheduledActionResponseContentBackupOptionsObjectOptionsValue) HasIncludedNames() bool` + +HasIncludedNames returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ScheduledSearch.md b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledSearch.md new file mode 100644 index 000000000..561885964 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledSearch.md @@ -0,0 +1,386 @@ +--- +id: v2024-scheduled-search +title: ScheduledSearch +pagination_label: ScheduledSearch +sidebar_label: ScheduledSearch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledSearch', 'V2024ScheduledSearch'] +slug: /tools/sdk/go/v2024/models/scheduled-search +tags: ['SDK', 'Software Development Kit', 'ScheduledSearch', 'V2024ScheduledSearch'] +--- + +# ScheduledSearch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **NullableString** | The name of the scheduled search. | [optional] +**Description** | Pointer to **NullableString** | The description of the scheduled search. | [optional] +**SavedSearchId** | **string** | The ID of the saved search that will be executed. | +**Created** | Pointer to **NullableTime** | The date the scheduled search was initially created. | [optional] [readonly] +**Modified** | Pointer to **NullableTime** | The last date the scheduled search was modified. | [optional] [readonly] +**Schedule** | [**Schedule2**](schedule2) | | +**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | +**Enabled** | Pointer to **bool** | Indicates if the scheduled search is enabled. | [optional] [default to false] +**EmailEmptyResults** | Pointer to **bool** | Indicates if email generation should occur when search returns no results. | [optional] [default to false] +**DisplayQueryDetails** | Pointer to **bool** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to false] +**Id** | **string** | The scheduled search ID. | [readonly] +**Owner** | [**ScheduledSearchAllOfOwner**](scheduled-search-all-of-owner) | | +**OwnerId** | **string** | The ID of the scheduled search owner. Please use the `id` in the `owner` object instead. | [readonly] + +## Methods + +### NewScheduledSearch + +`func NewScheduledSearch(savedSearchId string, schedule Schedule2, recipients []SearchScheduleRecipientsInner, id string, owner ScheduledSearchAllOfOwner, ownerId string, ) *ScheduledSearch` + +NewScheduledSearch instantiates a new ScheduledSearch 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 + +### NewScheduledSearchWithDefaults + +`func NewScheduledSearchWithDefaults() *ScheduledSearch` + +NewScheduledSearchWithDefaults instantiates a new ScheduledSearch 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 + +### GetName + +`func (o *ScheduledSearch) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ScheduledSearch) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ScheduledSearch) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ScheduledSearch) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ScheduledSearch) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ScheduledSearch) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *ScheduledSearch) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ScheduledSearch) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ScheduledSearch) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ScheduledSearch) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ScheduledSearch) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ScheduledSearch) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSavedSearchId + +`func (o *ScheduledSearch) GetSavedSearchId() string` + +GetSavedSearchId returns the SavedSearchId field if non-nil, zero value otherwise. + +### GetSavedSearchIdOk + +`func (o *ScheduledSearch) GetSavedSearchIdOk() (*string, bool)` + +GetSavedSearchIdOk returns a tuple with the SavedSearchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSavedSearchId + +`func (o *ScheduledSearch) SetSavedSearchId(v string)` + +SetSavedSearchId sets SavedSearchId field to given value. + + +### GetCreated + +`func (o *ScheduledSearch) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ScheduledSearch) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ScheduledSearch) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ScheduledSearch) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *ScheduledSearch) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *ScheduledSearch) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *ScheduledSearch) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ScheduledSearch) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ScheduledSearch) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ScheduledSearch) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *ScheduledSearch) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *ScheduledSearch) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSchedule + +`func (o *ScheduledSearch) GetSchedule() Schedule2` + +GetSchedule returns the Schedule field if non-nil, zero value otherwise. + +### GetScheduleOk + +`func (o *ScheduledSearch) GetScheduleOk() (*Schedule2, bool)` + +GetScheduleOk returns a tuple with the Schedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchedule + +`func (o *ScheduledSearch) SetSchedule(v Schedule2)` + +SetSchedule sets Schedule field to given value. + + +### GetRecipients + +`func (o *ScheduledSearch) GetRecipients() []SearchScheduleRecipientsInner` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *ScheduledSearch) GetRecipientsOk() (*[]SearchScheduleRecipientsInner, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *ScheduledSearch) SetRecipients(v []SearchScheduleRecipientsInner)` + +SetRecipients sets Recipients field to given value. + + +### GetEnabled + +`func (o *ScheduledSearch) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ScheduledSearch) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ScheduledSearch) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ScheduledSearch) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEmailEmptyResults + +`func (o *ScheduledSearch) GetEmailEmptyResults() bool` + +GetEmailEmptyResults returns the EmailEmptyResults field if non-nil, zero value otherwise. + +### GetEmailEmptyResultsOk + +`func (o *ScheduledSearch) GetEmailEmptyResultsOk() (*bool, bool)` + +GetEmailEmptyResultsOk returns a tuple with the EmailEmptyResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEmptyResults + +`func (o *ScheduledSearch) SetEmailEmptyResults(v bool)` + +SetEmailEmptyResults sets EmailEmptyResults field to given value. + +### HasEmailEmptyResults + +`func (o *ScheduledSearch) HasEmailEmptyResults() bool` + +HasEmailEmptyResults returns a boolean if a field has been set. + +### GetDisplayQueryDetails + +`func (o *ScheduledSearch) GetDisplayQueryDetails() bool` + +GetDisplayQueryDetails returns the DisplayQueryDetails field if non-nil, zero value otherwise. + +### GetDisplayQueryDetailsOk + +`func (o *ScheduledSearch) GetDisplayQueryDetailsOk() (*bool, bool)` + +GetDisplayQueryDetailsOk returns a tuple with the DisplayQueryDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayQueryDetails + +`func (o *ScheduledSearch) SetDisplayQueryDetails(v bool)` + +SetDisplayQueryDetails sets DisplayQueryDetails field to given value. + +### HasDisplayQueryDetails + +`func (o *ScheduledSearch) HasDisplayQueryDetails() bool` + +HasDisplayQueryDetails returns a boolean if a field has been set. + +### GetId + +`func (o *ScheduledSearch) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ScheduledSearch) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ScheduledSearch) SetId(v string)` + +SetId sets Id field to given value. + + +### GetOwner + +`func (o *ScheduledSearch) GetOwner() ScheduledSearchAllOfOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *ScheduledSearch) GetOwnerOk() (*ScheduledSearchAllOfOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *ScheduledSearch) SetOwner(v ScheduledSearchAllOfOwner)` + +SetOwner sets Owner field to given value. + + +### GetOwnerId + +`func (o *ScheduledSearch) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *ScheduledSearch) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *ScheduledSearch) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ScheduledSearchAllOfOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledSearchAllOfOwner.md new file mode 100644 index 000000000..4133c5f7f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledSearchAllOfOwner.md @@ -0,0 +1,80 @@ +--- +id: v2024-scheduled-search-all-of-owner +title: ScheduledSearchAllOfOwner +pagination_label: ScheduledSearchAllOfOwner +sidebar_label: ScheduledSearchAllOfOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledSearchAllOfOwner', 'V2024ScheduledSearchAllOfOwner'] +slug: /tools/sdk/go/v2024/models/scheduled-search-all-of-owner +tags: ['SDK', 'Software Development Kit', 'ScheduledSearchAllOfOwner', 'V2024ScheduledSearchAllOfOwner'] +--- + +# ScheduledSearchAllOfOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of object being referenced | +**Id** | **string** | The ID of the referenced object | + +## Methods + +### NewScheduledSearchAllOfOwner + +`func NewScheduledSearchAllOfOwner(type_ string, id string, ) *ScheduledSearchAllOfOwner` + +NewScheduledSearchAllOfOwner instantiates a new ScheduledSearchAllOfOwner 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 + +### NewScheduledSearchAllOfOwnerWithDefaults + +`func NewScheduledSearchAllOfOwnerWithDefaults() *ScheduledSearchAllOfOwner` + +NewScheduledSearchAllOfOwnerWithDefaults instantiates a new ScheduledSearchAllOfOwner 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 + +### GetType + +`func (o *ScheduledSearchAllOfOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ScheduledSearchAllOfOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ScheduledSearchAllOfOwner) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *ScheduledSearchAllOfOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ScheduledSearchAllOfOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ScheduledSearchAllOfOwner) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ScheduledSearchName.md b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledSearchName.md new file mode 100644 index 000000000..2e264c51d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ScheduledSearchName.md @@ -0,0 +1,110 @@ +--- +id: v2024-scheduled-search-name +title: ScheduledSearchName +pagination_label: ScheduledSearchName +sidebar_label: ScheduledSearchName +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledSearchName', 'V2024ScheduledSearchName'] +slug: /tools/sdk/go/v2024/models/scheduled-search-name +tags: ['SDK', 'Software Development Kit', 'ScheduledSearchName', 'V2024ScheduledSearchName'] +--- + +# ScheduledSearchName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **NullableString** | The name of the scheduled search. | [optional] +**Description** | Pointer to **NullableString** | The description of the scheduled search. | [optional] + +## Methods + +### NewScheduledSearchName + +`func NewScheduledSearchName() *ScheduledSearchName` + +NewScheduledSearchName instantiates a new ScheduledSearchName 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 + +### NewScheduledSearchNameWithDefaults + +`func NewScheduledSearchNameWithDefaults() *ScheduledSearchName` + +NewScheduledSearchNameWithDefaults instantiates a new ScheduledSearchName 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 + +### GetName + +`func (o *ScheduledSearchName) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ScheduledSearchName) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ScheduledSearchName) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ScheduledSearchName) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ScheduledSearchName) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ScheduledSearchName) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *ScheduledSearchName) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ScheduledSearchName) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ScheduledSearchName) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ScheduledSearchName) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ScheduledSearchName) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ScheduledSearchName) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Schema.md b/docs/tools/sdk/go/Reference/V2024/Models/Schema.md new file mode 100644 index 000000000..8031bd5da --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Schema.md @@ -0,0 +1,370 @@ +--- +id: v2024-schema +title: Schema +pagination_label: Schema +sidebar_label: Schema +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schema', 'V2024Schema'] +slug: /tools/sdk/go/v2024/models/schema +tags: ['SDK', 'Software Development Kit', 'Schema', 'V2024Schema'] +--- + +# Schema + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the Schema. | [optional] +**Name** | Pointer to **string** | The name of the Schema. | [optional] +**NativeObjectType** | Pointer to **string** | The name of the object type on the native system that the schema represents. | [optional] +**IdentityAttribute** | Pointer to **string** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional] +**DisplayAttribute** | Pointer to **string** | The name of the attribute used to calculate the display value for an object in the schema. | [optional] +**HierarchyAttribute** | Pointer to **NullableString** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional] +**IncludePermissions** | Pointer to **bool** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] +**Features** | Pointer to **[]string** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Configuration** | Pointer to **map[string]interface{}** | Holds any extra configuration data that the schema may require. | [optional] +**Attributes** | Pointer to [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional] +**Created** | Pointer to **SailPointTime** | The date the Schema was created. | [optional] +**Modified** | Pointer to **NullableTime** | The date the Schema was last modified. | [optional] + +## Methods + +### NewSchema + +`func NewSchema() *Schema` + +NewSchema instantiates a new Schema 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 + +### NewSchemaWithDefaults + +`func NewSchemaWithDefaults() *Schema` + +NewSchemaWithDefaults instantiates a new Schema 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 + +### GetId + +`func (o *Schema) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Schema) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Schema) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Schema) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Schema) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Schema) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Schema) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Schema) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetNativeObjectType + +`func (o *Schema) GetNativeObjectType() string` + +GetNativeObjectType returns the NativeObjectType field if non-nil, zero value otherwise. + +### GetNativeObjectTypeOk + +`func (o *Schema) GetNativeObjectTypeOk() (*string, bool)` + +GetNativeObjectTypeOk returns a tuple with the NativeObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeObjectType + +`func (o *Schema) SetNativeObjectType(v string)` + +SetNativeObjectType sets NativeObjectType field to given value. + +### HasNativeObjectType + +`func (o *Schema) HasNativeObjectType() bool` + +HasNativeObjectType returns a boolean if a field has been set. + +### GetIdentityAttribute + +`func (o *Schema) GetIdentityAttribute() string` + +GetIdentityAttribute returns the IdentityAttribute field if non-nil, zero value otherwise. + +### GetIdentityAttributeOk + +`func (o *Schema) GetIdentityAttributeOk() (*string, bool)` + +GetIdentityAttributeOk returns a tuple with the IdentityAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttribute + +`func (o *Schema) SetIdentityAttribute(v string)` + +SetIdentityAttribute sets IdentityAttribute field to given value. + +### HasIdentityAttribute + +`func (o *Schema) HasIdentityAttribute() bool` + +HasIdentityAttribute returns a boolean if a field has been set. + +### GetDisplayAttribute + +`func (o *Schema) GetDisplayAttribute() string` + +GetDisplayAttribute returns the DisplayAttribute field if non-nil, zero value otherwise. + +### GetDisplayAttributeOk + +`func (o *Schema) GetDisplayAttributeOk() (*string, bool)` + +GetDisplayAttributeOk returns a tuple with the DisplayAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayAttribute + +`func (o *Schema) SetDisplayAttribute(v string)` + +SetDisplayAttribute sets DisplayAttribute field to given value. + +### HasDisplayAttribute + +`func (o *Schema) HasDisplayAttribute() bool` + +HasDisplayAttribute returns a boolean if a field has been set. + +### GetHierarchyAttribute + +`func (o *Schema) GetHierarchyAttribute() string` + +GetHierarchyAttribute returns the HierarchyAttribute field if non-nil, zero value otherwise. + +### GetHierarchyAttributeOk + +`func (o *Schema) GetHierarchyAttributeOk() (*string, bool)` + +GetHierarchyAttributeOk returns a tuple with the HierarchyAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHierarchyAttribute + +`func (o *Schema) SetHierarchyAttribute(v string)` + +SetHierarchyAttribute sets HierarchyAttribute field to given value. + +### HasHierarchyAttribute + +`func (o *Schema) HasHierarchyAttribute() bool` + +HasHierarchyAttribute returns a boolean if a field has been set. + +### SetHierarchyAttributeNil + +`func (o *Schema) SetHierarchyAttributeNil(b bool)` + + SetHierarchyAttributeNil sets the value for HierarchyAttribute to be an explicit nil + +### UnsetHierarchyAttribute +`func (o *Schema) UnsetHierarchyAttribute()` + +UnsetHierarchyAttribute ensures that no value is present for HierarchyAttribute, not even an explicit nil +### GetIncludePermissions + +`func (o *Schema) GetIncludePermissions() bool` + +GetIncludePermissions returns the IncludePermissions field if non-nil, zero value otherwise. + +### GetIncludePermissionsOk + +`func (o *Schema) GetIncludePermissionsOk() (*bool, bool)` + +GetIncludePermissionsOk returns a tuple with the IncludePermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludePermissions + +`func (o *Schema) SetIncludePermissions(v bool)` + +SetIncludePermissions sets IncludePermissions field to given value. + +### HasIncludePermissions + +`func (o *Schema) HasIncludePermissions() bool` + +HasIncludePermissions returns a boolean if a field has been set. + +### GetFeatures + +`func (o *Schema) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *Schema) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *Schema) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *Schema) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### GetConfiguration + +`func (o *Schema) GetConfiguration() map[string]interface{}` + +GetConfiguration returns the Configuration field if non-nil, zero value otherwise. + +### GetConfigurationOk + +`func (o *Schema) GetConfigurationOk() (*map[string]interface{}, bool)` + +GetConfigurationOk returns a tuple with the Configuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfiguration + +`func (o *Schema) SetConfiguration(v map[string]interface{})` + +SetConfiguration sets Configuration field to given value. + +### HasConfiguration + +`func (o *Schema) HasConfiguration() bool` + +HasConfiguration returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Schema) GetAttributes() []AttributeDefinition` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Schema) GetAttributesOk() (*[]AttributeDefinition, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Schema) SetAttributes(v []AttributeDefinition)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Schema) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetCreated + +`func (o *Schema) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Schema) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Schema) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Schema) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Schema) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Schema) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Schema) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Schema) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *Schema) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *Schema) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Scope.md b/docs/tools/sdk/go/Reference/V2024/Models/Scope.md new file mode 100644 index 000000000..bb373a3f3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Scope.md @@ -0,0 +1,142 @@ +--- +id: v2024-scope +title: Scope +pagination_label: Scope +sidebar_label: Scope +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Scope', 'V2024Scope'] +slug: /tools/sdk/go/v2024/models/scope +tags: ['SDK', 'Software Development Kit', 'Scope', 'V2024Scope'] +--- + +# Scope + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scope** | Pointer to [**ScopeType**](scope-type) | | [optional] +**Visibility** | Pointer to [**ScopeVisibilityType**](scope-visibility-type) | | [optional] +**ScopeFilter** | Pointer to [**VisibilityCriteria**](visibility-criteria) | | [optional] +**ScopeSelection** | Pointer to [**[]Ref**](ref) | List of Identities that are assigned to the segment | [optional] + +## Methods + +### NewScope + +`func NewScope() *Scope` + +NewScope instantiates a new Scope 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 + +### NewScopeWithDefaults + +`func NewScopeWithDefaults() *Scope` + +NewScopeWithDefaults instantiates a new Scope 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 + +### GetScope + +`func (o *Scope) GetScope() ScopeType` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *Scope) GetScopeOk() (*ScopeType, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *Scope) SetScope(v ScopeType)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *Scope) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### GetVisibility + +`func (o *Scope) GetVisibility() ScopeVisibilityType` + +GetVisibility returns the Visibility field if non-nil, zero value otherwise. + +### GetVisibilityOk + +`func (o *Scope) GetVisibilityOk() (*ScopeVisibilityType, bool)` + +GetVisibilityOk returns a tuple with the Visibility field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVisibility + +`func (o *Scope) SetVisibility(v ScopeVisibilityType)` + +SetVisibility sets Visibility field to given value. + +### HasVisibility + +`func (o *Scope) HasVisibility() bool` + +HasVisibility returns a boolean if a field has been set. + +### GetScopeFilter + +`func (o *Scope) GetScopeFilter() VisibilityCriteria` + +GetScopeFilter returns the ScopeFilter field if non-nil, zero value otherwise. + +### GetScopeFilterOk + +`func (o *Scope) GetScopeFilterOk() (*VisibilityCriteria, bool)` + +GetScopeFilterOk returns a tuple with the ScopeFilter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScopeFilter + +`func (o *Scope) SetScopeFilter(v VisibilityCriteria)` + +SetScopeFilter sets ScopeFilter field to given value. + +### HasScopeFilter + +`func (o *Scope) HasScopeFilter() bool` + +HasScopeFilter returns a boolean if a field has been set. + +### GetScopeSelection + +`func (o *Scope) GetScopeSelection() []Ref` + +GetScopeSelection returns the ScopeSelection field if non-nil, zero value otherwise. + +### GetScopeSelectionOk + +`func (o *Scope) GetScopeSelectionOk() (*[]Ref, bool)` + +GetScopeSelectionOk returns a tuple with the ScopeSelection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScopeSelection + +`func (o *Scope) SetScopeSelection(v []Ref)` + +SetScopeSelection sets ScopeSelection field to given value. + +### HasScopeSelection + +`func (o *Scope) HasScopeSelection() bool` + +HasScopeSelection returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ScopeType.md b/docs/tools/sdk/go/Reference/V2024/Models/ScopeType.md new file mode 100644 index 000000000..e1c8b594d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ScopeType.md @@ -0,0 +1,25 @@ +--- +id: v2024-scope-type +title: ScopeType +pagination_label: ScopeType +sidebar_label: ScopeType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScopeType', 'V2024ScopeType'] +slug: /tools/sdk/go/v2024/models/scope-type +tags: ['SDK', 'Software Development Kit', 'ScopeType', 'V2024ScopeType'] +--- + +# ScopeType + +## Enum + + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + +* `CERTIFICATION` (value: `"CERTIFICATION"`) + +* `IDENTITY` (value: `"IDENTITY"`) + +* `ENTITLEMENTREQUEST` (value: `"ENTITLEMENTREQUEST"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ScopeVisibilityType.md b/docs/tools/sdk/go/Reference/V2024/Models/ScopeVisibilityType.md new file mode 100644 index 000000000..3dc028544 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ScopeVisibilityType.md @@ -0,0 +1,25 @@ +--- +id: v2024-scope-visibility-type +title: ScopeVisibilityType +pagination_label: ScopeVisibilityType +sidebar_label: ScopeVisibilityType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScopeVisibilityType', 'V2024ScopeVisibilityType'] +slug: /tools/sdk/go/v2024/models/scope-visibility-type +tags: ['SDK', 'Software Development Kit', 'ScopeVisibilityType', 'V2024ScopeVisibilityType'] +--- + +# ScopeVisibilityType + +## Enum + + +* `ALL` (value: `"ALL"`) + +* `FILTER` (value: `"FILTER"`) + +* `SELECTION` (value: `"SELECTION"`) + +* `UNSEGMENTED` (value: `"UNSEGMENTED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Search.md b/docs/tools/sdk/go/Reference/V2024/Models/Search.md new file mode 100644 index 000000000..613e3049d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Search.md @@ -0,0 +1,454 @@ +--- +id: v2024-search +title: Search +pagination_label: Search +sidebar_label: Search +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Search', 'V2024Search'] +slug: /tools/sdk/go/v2024/models/search +tags: ['SDK', 'Software Development Kit', 'Search', 'V2024Search'] +--- + +# Search + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**QueryType** | Pointer to [**QueryType**](query-type) | | [optional] [default to QUERYTYPE_SAILPOINT] +**QueryVersion** | Pointer to **string** | | [optional] +**Query** | Pointer to [**Query**](query) | | [optional] +**QueryDsl** | Pointer to **map[string]interface{}** | The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. | [optional] +**TextQuery** | Pointer to [**TextQuery**](text-query) | | [optional] +**TypeAheadQuery** | Pointer to [**TypeAheadQuery**](type-ahead-query) | | [optional] +**IncludeNested** | Pointer to **bool** | Indicates whether nested objects from returned search results should be included. | [optional] [default to true] +**QueryResultFilter** | Pointer to [**QueryResultFilter**](query-result-filter) | | [optional] +**AggregationType** | Pointer to [**AggregationType**](aggregation-type) | | [optional] [default to AGGREGATIONTYPE_DSL] +**AggregationsVersion** | Pointer to **string** | | [optional] +**AggregationsDsl** | Pointer to **map[string]interface{}** | The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. | [optional] +**Aggregations** | Pointer to [**SearchAggregationSpecification**](search-aggregation-specification) | | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] +**SearchAfter** | Pointer to **[]string** | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [\"displayName\", \"id\"]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is \"John Doe\", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like [\"John Doe\",\"2c91808375d8e80a0175e1f88a575221\"] | [optional] +**Filters** | Pointer to [**map[string]Filter**](filter) | The filters to be applied for each filtered field name. | [optional] + +## Methods + +### NewSearch + +`func NewSearch() *Search` + +NewSearch instantiates a new Search 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 + +### NewSearchWithDefaults + +`func NewSearchWithDefaults() *Search` + +NewSearchWithDefaults instantiates a new Search 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 + +### GetIndices + +`func (o *Search) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *Search) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *Search) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + +### HasIndices + +`func (o *Search) HasIndices() bool` + +HasIndices returns a boolean if a field has been set. + +### GetQueryType + +`func (o *Search) GetQueryType() QueryType` + +GetQueryType returns the QueryType field if non-nil, zero value otherwise. + +### GetQueryTypeOk + +`func (o *Search) GetQueryTypeOk() (*QueryType, bool)` + +GetQueryTypeOk returns a tuple with the QueryType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueryType + +`func (o *Search) SetQueryType(v QueryType)` + +SetQueryType sets QueryType field to given value. + +### HasQueryType + +`func (o *Search) HasQueryType() bool` + +HasQueryType returns a boolean if a field has been set. + +### GetQueryVersion + +`func (o *Search) GetQueryVersion() string` + +GetQueryVersion returns the QueryVersion field if non-nil, zero value otherwise. + +### GetQueryVersionOk + +`func (o *Search) GetQueryVersionOk() (*string, bool)` + +GetQueryVersionOk returns a tuple with the QueryVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueryVersion + +`func (o *Search) SetQueryVersion(v string)` + +SetQueryVersion sets QueryVersion field to given value. + +### HasQueryVersion + +`func (o *Search) HasQueryVersion() bool` + +HasQueryVersion returns a boolean if a field has been set. + +### GetQuery + +`func (o *Search) GetQuery() Query` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *Search) GetQueryOk() (*Query, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *Search) SetQuery(v Query)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *Search) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### GetQueryDsl + +`func (o *Search) GetQueryDsl() map[string]interface{}` + +GetQueryDsl returns the QueryDsl field if non-nil, zero value otherwise. + +### GetQueryDslOk + +`func (o *Search) GetQueryDslOk() (*map[string]interface{}, bool)` + +GetQueryDslOk returns a tuple with the QueryDsl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueryDsl + +`func (o *Search) SetQueryDsl(v map[string]interface{})` + +SetQueryDsl sets QueryDsl field to given value. + +### HasQueryDsl + +`func (o *Search) HasQueryDsl() bool` + +HasQueryDsl returns a boolean if a field has been set. + +### GetTextQuery + +`func (o *Search) GetTextQuery() TextQuery` + +GetTextQuery returns the TextQuery field if non-nil, zero value otherwise. + +### GetTextQueryOk + +`func (o *Search) GetTextQueryOk() (*TextQuery, bool)` + +GetTextQueryOk returns a tuple with the TextQuery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTextQuery + +`func (o *Search) SetTextQuery(v TextQuery)` + +SetTextQuery sets TextQuery field to given value. + +### HasTextQuery + +`func (o *Search) HasTextQuery() bool` + +HasTextQuery returns a boolean if a field has been set. + +### GetTypeAheadQuery + +`func (o *Search) GetTypeAheadQuery() TypeAheadQuery` + +GetTypeAheadQuery returns the TypeAheadQuery field if non-nil, zero value otherwise. + +### GetTypeAheadQueryOk + +`func (o *Search) GetTypeAheadQueryOk() (*TypeAheadQuery, bool)` + +GetTypeAheadQueryOk returns a tuple with the TypeAheadQuery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeAheadQuery + +`func (o *Search) SetTypeAheadQuery(v TypeAheadQuery)` + +SetTypeAheadQuery sets TypeAheadQuery field to given value. + +### HasTypeAheadQuery + +`func (o *Search) HasTypeAheadQuery() bool` + +HasTypeAheadQuery returns a boolean if a field has been set. + +### GetIncludeNested + +`func (o *Search) GetIncludeNested() bool` + +GetIncludeNested returns the IncludeNested field if non-nil, zero value otherwise. + +### GetIncludeNestedOk + +`func (o *Search) GetIncludeNestedOk() (*bool, bool)` + +GetIncludeNestedOk returns a tuple with the IncludeNested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeNested + +`func (o *Search) SetIncludeNested(v bool)` + +SetIncludeNested sets IncludeNested field to given value. + +### HasIncludeNested + +`func (o *Search) HasIncludeNested() bool` + +HasIncludeNested returns a boolean if a field has been set. + +### GetQueryResultFilter + +`func (o *Search) GetQueryResultFilter() QueryResultFilter` + +GetQueryResultFilter returns the QueryResultFilter field if non-nil, zero value otherwise. + +### GetQueryResultFilterOk + +`func (o *Search) GetQueryResultFilterOk() (*QueryResultFilter, bool)` + +GetQueryResultFilterOk returns a tuple with the QueryResultFilter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueryResultFilter + +`func (o *Search) SetQueryResultFilter(v QueryResultFilter)` + +SetQueryResultFilter sets QueryResultFilter field to given value. + +### HasQueryResultFilter + +`func (o *Search) HasQueryResultFilter() bool` + +HasQueryResultFilter returns a boolean if a field has been set. + +### GetAggregationType + +`func (o *Search) GetAggregationType() AggregationType` + +GetAggregationType returns the AggregationType field if non-nil, zero value otherwise. + +### GetAggregationTypeOk + +`func (o *Search) GetAggregationTypeOk() (*AggregationType, bool)` + +GetAggregationTypeOk returns a tuple with the AggregationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationType + +`func (o *Search) SetAggregationType(v AggregationType)` + +SetAggregationType sets AggregationType field to given value. + +### HasAggregationType + +`func (o *Search) HasAggregationType() bool` + +HasAggregationType returns a boolean if a field has been set. + +### GetAggregationsVersion + +`func (o *Search) GetAggregationsVersion() string` + +GetAggregationsVersion returns the AggregationsVersion field if non-nil, zero value otherwise. + +### GetAggregationsVersionOk + +`func (o *Search) GetAggregationsVersionOk() (*string, bool)` + +GetAggregationsVersionOk returns a tuple with the AggregationsVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationsVersion + +`func (o *Search) SetAggregationsVersion(v string)` + +SetAggregationsVersion sets AggregationsVersion field to given value. + +### HasAggregationsVersion + +`func (o *Search) HasAggregationsVersion() bool` + +HasAggregationsVersion returns a boolean if a field has been set. + +### GetAggregationsDsl + +`func (o *Search) GetAggregationsDsl() map[string]interface{}` + +GetAggregationsDsl returns the AggregationsDsl field if non-nil, zero value otherwise. + +### GetAggregationsDslOk + +`func (o *Search) GetAggregationsDslOk() (*map[string]interface{}, bool)` + +GetAggregationsDslOk returns a tuple with the AggregationsDsl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationsDsl + +`func (o *Search) SetAggregationsDsl(v map[string]interface{})` + +SetAggregationsDsl sets AggregationsDsl field to given value. + +### HasAggregationsDsl + +`func (o *Search) HasAggregationsDsl() bool` + +HasAggregationsDsl returns a boolean if a field has been set. + +### GetAggregations + +`func (o *Search) GetAggregations() SearchAggregationSpecification` + +GetAggregations returns the Aggregations field if non-nil, zero value otherwise. + +### GetAggregationsOk + +`func (o *Search) GetAggregationsOk() (*SearchAggregationSpecification, bool)` + +GetAggregationsOk returns a tuple with the Aggregations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregations + +`func (o *Search) SetAggregations(v SearchAggregationSpecification)` + +SetAggregations sets Aggregations field to given value. + +### HasAggregations + +`func (o *Search) HasAggregations() bool` + +HasAggregations returns a boolean if a field has been set. + +### GetSort + +`func (o *Search) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *Search) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *Search) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *Search) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### GetSearchAfter + +`func (o *Search) GetSearchAfter() []string` + +GetSearchAfter returns the SearchAfter field if non-nil, zero value otherwise. + +### GetSearchAfterOk + +`func (o *Search) GetSearchAfterOk() (*[]string, bool)` + +GetSearchAfterOk returns a tuple with the SearchAfter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchAfter + +`func (o *Search) SetSearchAfter(v []string)` + +SetSearchAfter sets SearchAfter field to given value. + +### HasSearchAfter + +`func (o *Search) HasSearchAfter() bool` + +HasSearchAfter returns a boolean if a field has been set. + +### GetFilters + +`func (o *Search) GetFilters() map[string]Filter` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *Search) GetFiltersOk() (*map[string]Filter, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *Search) SetFilters(v map[string]Filter)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *Search) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SearchAggregationSpecification.md b/docs/tools/sdk/go/Reference/V2024/Models/SearchAggregationSpecification.md new file mode 100644 index 000000000..c41fe0914 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SearchAggregationSpecification.md @@ -0,0 +1,168 @@ +--- +id: v2024-search-aggregation-specification +title: SearchAggregationSpecification +pagination_label: SearchAggregationSpecification +sidebar_label: SearchAggregationSpecification +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchAggregationSpecification', 'V2024SearchAggregationSpecification'] +slug: /tools/sdk/go/v2024/models/search-aggregation-specification +tags: ['SDK', 'Software Development Kit', 'SearchAggregationSpecification', 'V2024SearchAggregationSpecification'] +--- + +# SearchAggregationSpecification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional] +**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional] +**Filter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional] +**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional] +**SubAggregation** | Pointer to [**SubSearchAggregationSpecification**](sub-search-aggregation-specification) | | [optional] + +## Methods + +### NewSearchAggregationSpecification + +`func NewSearchAggregationSpecification() *SearchAggregationSpecification` + +NewSearchAggregationSpecification instantiates a new SearchAggregationSpecification 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 + +### NewSearchAggregationSpecificationWithDefaults + +`func NewSearchAggregationSpecificationWithDefaults() *SearchAggregationSpecification` + +NewSearchAggregationSpecificationWithDefaults instantiates a new SearchAggregationSpecification 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 + +### GetNested + +`func (o *SearchAggregationSpecification) GetNested() NestedAggregation` + +GetNested returns the Nested field if non-nil, zero value otherwise. + +### GetNestedOk + +`func (o *SearchAggregationSpecification) GetNestedOk() (*NestedAggregation, bool)` + +GetNestedOk returns a tuple with the Nested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNested + +`func (o *SearchAggregationSpecification) SetNested(v NestedAggregation)` + +SetNested sets Nested field to given value. + +### HasNested + +`func (o *SearchAggregationSpecification) HasNested() bool` + +HasNested returns a boolean if a field has been set. + +### GetMetric + +`func (o *SearchAggregationSpecification) GetMetric() MetricAggregation` + +GetMetric returns the Metric field if non-nil, zero value otherwise. + +### GetMetricOk + +`func (o *SearchAggregationSpecification) GetMetricOk() (*MetricAggregation, bool)` + +GetMetricOk returns a tuple with the Metric field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetric + +`func (o *SearchAggregationSpecification) SetMetric(v MetricAggregation)` + +SetMetric sets Metric field to given value. + +### HasMetric + +`func (o *SearchAggregationSpecification) HasMetric() bool` + +HasMetric returns a boolean if a field has been set. + +### GetFilter + +`func (o *SearchAggregationSpecification) GetFilter() FilterAggregation` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *SearchAggregationSpecification) GetFilterOk() (*FilterAggregation, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *SearchAggregationSpecification) SetFilter(v FilterAggregation)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *SearchAggregationSpecification) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### GetBucket + +`func (o *SearchAggregationSpecification) GetBucket() BucketAggregation` + +GetBucket returns the Bucket field if non-nil, zero value otherwise. + +### GetBucketOk + +`func (o *SearchAggregationSpecification) GetBucketOk() (*BucketAggregation, bool)` + +GetBucketOk returns a tuple with the Bucket field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBucket + +`func (o *SearchAggregationSpecification) SetBucket(v BucketAggregation)` + +SetBucket sets Bucket field to given value. + +### HasBucket + +`func (o *SearchAggregationSpecification) HasBucket() bool` + +HasBucket returns a boolean if a field has been set. + +### GetSubAggregation + +`func (o *SearchAggregationSpecification) GetSubAggregation() SubSearchAggregationSpecification` + +GetSubAggregation returns the SubAggregation field if non-nil, zero value otherwise. + +### GetSubAggregationOk + +`func (o *SearchAggregationSpecification) GetSubAggregationOk() (*SubSearchAggregationSpecification, bool)` + +GetSubAggregationOk returns a tuple with the SubAggregation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubAggregation + +`func (o *SearchAggregationSpecification) SetSubAggregation(v SubSearchAggregationSpecification)` + +SetSubAggregation sets SubAggregation field to given value. + +### HasSubAggregation + +`func (o *SearchAggregationSpecification) HasSubAggregation() bool` + +HasSubAggregation returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SearchArguments.md b/docs/tools/sdk/go/Reference/V2024/Models/SearchArguments.md new file mode 100644 index 000000000..956ff3eb2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SearchArguments.md @@ -0,0 +1,116 @@ +--- +id: v2024-search-arguments +title: SearchArguments +pagination_label: SearchArguments +sidebar_label: SearchArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchArguments', 'V2024SearchArguments'] +slug: /tools/sdk/go/v2024/models/search-arguments +tags: ['SDK', 'Software Development Kit', 'SearchArguments', 'V2024SearchArguments'] +--- + +# SearchArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ScheduleId** | Pointer to **string** | The ID of the scheduled search that triggered the saved search execution. | [optional] +**Owner** | Pointer to [**TypedReference**](typed-reference) | The owner of the scheduled search being tested. | [optional] +**Recipients** | Pointer to [**[]TypedReference**](typed-reference) | The email recipients of the scheduled search being tested. | [optional] + +## Methods + +### NewSearchArguments + +`func NewSearchArguments() *SearchArguments` + +NewSearchArguments instantiates a new SearchArguments 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 + +### NewSearchArgumentsWithDefaults + +`func NewSearchArgumentsWithDefaults() *SearchArguments` + +NewSearchArgumentsWithDefaults instantiates a new SearchArguments 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 + +### GetScheduleId + +`func (o *SearchArguments) GetScheduleId() string` + +GetScheduleId returns the ScheduleId field if non-nil, zero value otherwise. + +### GetScheduleIdOk + +`func (o *SearchArguments) GetScheduleIdOk() (*string, bool)` + +GetScheduleIdOk returns a tuple with the ScheduleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheduleId + +`func (o *SearchArguments) SetScheduleId(v string)` + +SetScheduleId sets ScheduleId field to given value. + +### HasScheduleId + +`func (o *SearchArguments) HasScheduleId() bool` + +HasScheduleId returns a boolean if a field has been set. + +### GetOwner + +`func (o *SearchArguments) GetOwner() TypedReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *SearchArguments) GetOwnerOk() (*TypedReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *SearchArguments) SetOwner(v TypedReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *SearchArguments) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRecipients + +`func (o *SearchArguments) GetRecipients() []TypedReference` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *SearchArguments) GetRecipientsOk() (*[]TypedReference, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *SearchArguments) SetRecipients(v []TypedReference)` + +SetRecipients sets Recipients field to given value. + +### HasRecipients + +`func (o *SearchArguments) HasRecipients() bool` + +HasRecipients returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SearchAttributeConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/SearchAttributeConfig.md new file mode 100644 index 000000000..49fa20d56 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SearchAttributeConfig.md @@ -0,0 +1,116 @@ +--- +id: v2024-search-attribute-config +title: SearchAttributeConfig +pagination_label: SearchAttributeConfig +sidebar_label: SearchAttributeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchAttributeConfig', 'V2024SearchAttributeConfig'] +slug: /tools/sdk/go/v2024/models/search-attribute-config +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfig', 'V2024SearchAttributeConfig'] +--- + +# SearchAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the new attribute | [optional] +**DisplayName** | Pointer to **string** | The display name of the new attribute | [optional] +**ApplicationAttributes** | Pointer to **map[string]interface{}** | Map of application id and their associated attribute. | [optional] + +## Methods + +### NewSearchAttributeConfig + +`func NewSearchAttributeConfig() *SearchAttributeConfig` + +NewSearchAttributeConfig instantiates a new SearchAttributeConfig 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 + +### NewSearchAttributeConfigWithDefaults + +`func NewSearchAttributeConfigWithDefaults() *SearchAttributeConfig` + +NewSearchAttributeConfigWithDefaults instantiates a new SearchAttributeConfig 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 + +### GetName + +`func (o *SearchAttributeConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SearchAttributeConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SearchAttributeConfig) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SearchAttributeConfig) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *SearchAttributeConfig) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *SearchAttributeConfig) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *SearchAttributeConfig) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *SearchAttributeConfig) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetApplicationAttributes + +`func (o *SearchAttributeConfig) GetApplicationAttributes() map[string]interface{}` + +GetApplicationAttributes returns the ApplicationAttributes field if non-nil, zero value otherwise. + +### GetApplicationAttributesOk + +`func (o *SearchAttributeConfig) GetApplicationAttributesOk() (*map[string]interface{}, bool)` + +GetApplicationAttributesOk returns a tuple with the ApplicationAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationAttributes + +`func (o *SearchAttributeConfig) SetApplicationAttributes(v map[string]interface{})` + +SetApplicationAttributes sets ApplicationAttributes field to given value. + +### HasApplicationAttributes + +`func (o *SearchAttributeConfig) HasApplicationAttributes() bool` + +HasApplicationAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SearchExportReportArguments.md b/docs/tools/sdk/go/Reference/V2024/Models/SearchExportReportArguments.md new file mode 100644 index 000000000..34e8600ce --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SearchExportReportArguments.md @@ -0,0 +1,137 @@ +--- +id: v2024-search-export-report-arguments +title: SearchExportReportArguments +pagination_label: SearchExportReportArguments +sidebar_label: SearchExportReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchExportReportArguments', 'V2024SearchExportReportArguments'] +slug: /tools/sdk/go/v2024/models/search-export-report-arguments +tags: ['SDK', 'Software Development Kit', 'SearchExportReportArguments', 'V2024SearchExportReportArguments'] +--- + +# SearchExportReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**Query** | **string** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | +**Columns** | Pointer to **string** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] + +## Methods + +### NewSearchExportReportArguments + +`func NewSearchExportReportArguments(query string, ) *SearchExportReportArguments` + +NewSearchExportReportArguments instantiates a new SearchExportReportArguments 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 + +### NewSearchExportReportArgumentsWithDefaults + +`func NewSearchExportReportArgumentsWithDefaults() *SearchExportReportArguments` + +NewSearchExportReportArgumentsWithDefaults instantiates a new SearchExportReportArguments 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 + +### GetIndices + +`func (o *SearchExportReportArguments) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *SearchExportReportArguments) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *SearchExportReportArguments) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + +### HasIndices + +`func (o *SearchExportReportArguments) HasIndices() bool` + +HasIndices returns a boolean if a field has been set. + +### GetQuery + +`func (o *SearchExportReportArguments) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SearchExportReportArguments) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SearchExportReportArguments) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetColumns + +`func (o *SearchExportReportArguments) GetColumns() string` + +GetColumns returns the Columns field if non-nil, zero value otherwise. + +### GetColumnsOk + +`func (o *SearchExportReportArguments) GetColumnsOk() (*string, bool)` + +GetColumnsOk returns a tuple with the Columns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumns + +`func (o *SearchExportReportArguments) SetColumns(v string)` + +SetColumns sets Columns field to given value. + +### HasColumns + +`func (o *SearchExportReportArguments) HasColumns() bool` + +HasColumns returns a boolean if a field has been set. + +### GetSort + +`func (o *SearchExportReportArguments) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *SearchExportReportArguments) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *SearchExportReportArguments) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *SearchExportReportArguments) HasSort() bool` + +HasSort returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SearchFilterType.md b/docs/tools/sdk/go/Reference/V2024/Models/SearchFilterType.md new file mode 100644 index 000000000..bea6cdc14 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SearchFilterType.md @@ -0,0 +1,19 @@ +--- +id: v2024-search-filter-type +title: SearchFilterType +pagination_label: SearchFilterType +sidebar_label: SearchFilterType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchFilterType', 'V2024SearchFilterType'] +slug: /tools/sdk/go/v2024/models/search-filter-type +tags: ['SDK', 'Software Development Kit', 'SearchFilterType', 'V2024SearchFilterType'] +--- + +# SearchFilterType + +## Enum + + +* `TERM` (value: `"TERM"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SearchFormDefinitionsByTenant400Response.md b/docs/tools/sdk/go/Reference/V2024/Models/SearchFormDefinitionsByTenant400Response.md new file mode 100644 index 000000000..348ce33e1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SearchFormDefinitionsByTenant400Response.md @@ -0,0 +1,142 @@ +--- +id: v2024-search-form-definitions-by-tenant400-response +title: SearchFormDefinitionsByTenant400Response +pagination_label: SearchFormDefinitionsByTenant400Response +sidebar_label: SearchFormDefinitionsByTenant400Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchFormDefinitionsByTenant400Response', 'V2024SearchFormDefinitionsByTenant400Response'] +slug: /tools/sdk/go/v2024/models/search-form-definitions-by-tenant400-response +tags: ['SDK', 'Software Development Kit', 'SearchFormDefinitionsByTenant400Response', 'V2024SearchFormDefinitionsByTenant400Response'] +--- + +# SearchFormDefinitionsByTenant400Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **string** | | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | | [optional] +**StatusCode** | Pointer to **int64** | | [optional] +**TrackingId** | Pointer to **string** | | [optional] + +## Methods + +### NewSearchFormDefinitionsByTenant400Response + +`func NewSearchFormDefinitionsByTenant400Response() *SearchFormDefinitionsByTenant400Response` + +NewSearchFormDefinitionsByTenant400Response instantiates a new SearchFormDefinitionsByTenant400Response 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 + +### NewSearchFormDefinitionsByTenant400ResponseWithDefaults + +`func NewSearchFormDefinitionsByTenant400ResponseWithDefaults() *SearchFormDefinitionsByTenant400Response` + +NewSearchFormDefinitionsByTenant400ResponseWithDefaults instantiates a new SearchFormDefinitionsByTenant400Response 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 + +### GetDetailCode + +`func (o *SearchFormDefinitionsByTenant400Response) GetDetailCode() string` + +GetDetailCode returns the DetailCode field if non-nil, zero value otherwise. + +### GetDetailCodeOk + +`func (o *SearchFormDefinitionsByTenant400Response) GetDetailCodeOk() (*string, bool)` + +GetDetailCodeOk returns a tuple with the DetailCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetailCode + +`func (o *SearchFormDefinitionsByTenant400Response) SetDetailCode(v string)` + +SetDetailCode sets DetailCode field to given value. + +### HasDetailCode + +`func (o *SearchFormDefinitionsByTenant400Response) HasDetailCode() bool` + +HasDetailCode returns a boolean if a field has been set. + +### GetMessages + +`func (o *SearchFormDefinitionsByTenant400Response) GetMessages() []ErrorMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *SearchFormDefinitionsByTenant400Response) GetMessagesOk() (*[]ErrorMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *SearchFormDefinitionsByTenant400Response) SetMessages(v []ErrorMessage)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *SearchFormDefinitionsByTenant400Response) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetStatusCode + +`func (o *SearchFormDefinitionsByTenant400Response) GetStatusCode() int64` + +GetStatusCode returns the StatusCode field if non-nil, zero value otherwise. + +### GetStatusCodeOk + +`func (o *SearchFormDefinitionsByTenant400Response) GetStatusCodeOk() (*int64, bool)` + +GetStatusCodeOk returns a tuple with the StatusCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusCode + +`func (o *SearchFormDefinitionsByTenant400Response) SetStatusCode(v int64)` + +SetStatusCode sets StatusCode field to given value. + +### HasStatusCode + +`func (o *SearchFormDefinitionsByTenant400Response) HasStatusCode() bool` + +HasStatusCode returns a boolean if a field has been set. + +### GetTrackingId + +`func (o *SearchFormDefinitionsByTenant400Response) GetTrackingId() string` + +GetTrackingId returns the TrackingId field if non-nil, zero value otherwise. + +### GetTrackingIdOk + +`func (o *SearchFormDefinitionsByTenant400Response) GetTrackingIdOk() (*string, bool)` + +GetTrackingIdOk returns a tuple with the TrackingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingId + +`func (o *SearchFormDefinitionsByTenant400Response) SetTrackingId(v string)` + +SetTrackingId sets TrackingId field to given value. + +### HasTrackingId + +`func (o *SearchFormDefinitionsByTenant400Response) HasTrackingId() bool` + +HasTrackingId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SearchSchedule.md b/docs/tools/sdk/go/Reference/V2024/Models/SearchSchedule.md new file mode 100644 index 000000000..4cf23283b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SearchSchedule.md @@ -0,0 +1,251 @@ +--- +id: v2024-search-schedule +title: SearchSchedule +pagination_label: SearchSchedule +sidebar_label: SearchSchedule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchSchedule', 'V2024SearchSchedule'] +slug: /tools/sdk/go/v2024/models/search-schedule +tags: ['SDK', 'Software Development Kit', 'SearchSchedule', 'V2024SearchSchedule'] +--- + +# SearchSchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SavedSearchId** | **string** | The ID of the saved search that will be executed. | +**Created** | Pointer to **NullableTime** | The date the scheduled search was initially created. | [optional] [readonly] +**Modified** | Pointer to **NullableTime** | The last date the scheduled search was modified. | [optional] [readonly] +**Schedule** | [**Schedule2**](schedule2) | | +**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | +**Enabled** | Pointer to **bool** | Indicates if the scheduled search is enabled. | [optional] [default to false] +**EmailEmptyResults** | Pointer to **bool** | Indicates if email generation should occur when search returns no results. | [optional] [default to false] +**DisplayQueryDetails** | Pointer to **bool** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to false] + +## Methods + +### NewSearchSchedule + +`func NewSearchSchedule(savedSearchId string, schedule Schedule2, recipients []SearchScheduleRecipientsInner, ) *SearchSchedule` + +NewSearchSchedule instantiates a new SearchSchedule 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 + +### NewSearchScheduleWithDefaults + +`func NewSearchScheduleWithDefaults() *SearchSchedule` + +NewSearchScheduleWithDefaults instantiates a new SearchSchedule 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 + +### GetSavedSearchId + +`func (o *SearchSchedule) GetSavedSearchId() string` + +GetSavedSearchId returns the SavedSearchId field if non-nil, zero value otherwise. + +### GetSavedSearchIdOk + +`func (o *SearchSchedule) GetSavedSearchIdOk() (*string, bool)` + +GetSavedSearchIdOk returns a tuple with the SavedSearchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSavedSearchId + +`func (o *SearchSchedule) SetSavedSearchId(v string)` + +SetSavedSearchId sets SavedSearchId field to given value. + + +### GetCreated + +`func (o *SearchSchedule) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SearchSchedule) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SearchSchedule) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SearchSchedule) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *SearchSchedule) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *SearchSchedule) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *SearchSchedule) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SearchSchedule) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SearchSchedule) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SearchSchedule) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *SearchSchedule) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *SearchSchedule) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSchedule + +`func (o *SearchSchedule) GetSchedule() Schedule2` + +GetSchedule returns the Schedule field if non-nil, zero value otherwise. + +### GetScheduleOk + +`func (o *SearchSchedule) GetScheduleOk() (*Schedule2, bool)` + +GetScheduleOk returns a tuple with the Schedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchedule + +`func (o *SearchSchedule) SetSchedule(v Schedule2)` + +SetSchedule sets Schedule field to given value. + + +### GetRecipients + +`func (o *SearchSchedule) GetRecipients() []SearchScheduleRecipientsInner` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *SearchSchedule) GetRecipientsOk() (*[]SearchScheduleRecipientsInner, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *SearchSchedule) SetRecipients(v []SearchScheduleRecipientsInner)` + +SetRecipients sets Recipients field to given value. + + +### GetEnabled + +`func (o *SearchSchedule) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *SearchSchedule) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *SearchSchedule) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *SearchSchedule) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEmailEmptyResults + +`func (o *SearchSchedule) GetEmailEmptyResults() bool` + +GetEmailEmptyResults returns the EmailEmptyResults field if non-nil, zero value otherwise. + +### GetEmailEmptyResultsOk + +`func (o *SearchSchedule) GetEmailEmptyResultsOk() (*bool, bool)` + +GetEmailEmptyResultsOk returns a tuple with the EmailEmptyResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEmptyResults + +`func (o *SearchSchedule) SetEmailEmptyResults(v bool)` + +SetEmailEmptyResults sets EmailEmptyResults field to given value. + +### HasEmailEmptyResults + +`func (o *SearchSchedule) HasEmailEmptyResults() bool` + +HasEmailEmptyResults returns a boolean if a field has been set. + +### GetDisplayQueryDetails + +`func (o *SearchSchedule) GetDisplayQueryDetails() bool` + +GetDisplayQueryDetails returns the DisplayQueryDetails field if non-nil, zero value otherwise. + +### GetDisplayQueryDetailsOk + +`func (o *SearchSchedule) GetDisplayQueryDetailsOk() (*bool, bool)` + +GetDisplayQueryDetailsOk returns a tuple with the DisplayQueryDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayQueryDetails + +`func (o *SearchSchedule) SetDisplayQueryDetails(v bool)` + +SetDisplayQueryDetails sets DisplayQueryDetails field to given value. + +### HasDisplayQueryDetails + +`func (o *SearchSchedule) HasDisplayQueryDetails() bool` + +HasDisplayQueryDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SearchScheduleRecipientsInner.md b/docs/tools/sdk/go/Reference/V2024/Models/SearchScheduleRecipientsInner.md new file mode 100644 index 000000000..ec2aa7ae4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SearchScheduleRecipientsInner.md @@ -0,0 +1,80 @@ +--- +id: v2024-search-schedule-recipients-inner +title: SearchScheduleRecipientsInner +pagination_label: SearchScheduleRecipientsInner +sidebar_label: SearchScheduleRecipientsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchScheduleRecipientsInner', 'V2024SearchScheduleRecipientsInner'] +slug: /tools/sdk/go/v2024/models/search-schedule-recipients-inner +tags: ['SDK', 'Software Development Kit', 'SearchScheduleRecipientsInner', 'V2024SearchScheduleRecipientsInner'] +--- + +# SearchScheduleRecipientsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of object being referenced | +**Id** | **string** | The ID of the referenced object | + +## Methods + +### NewSearchScheduleRecipientsInner + +`func NewSearchScheduleRecipientsInner(type_ string, id string, ) *SearchScheduleRecipientsInner` + +NewSearchScheduleRecipientsInner instantiates a new SearchScheduleRecipientsInner 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 + +### NewSearchScheduleRecipientsInnerWithDefaults + +`func NewSearchScheduleRecipientsInnerWithDefaults() *SearchScheduleRecipientsInner` + +NewSearchScheduleRecipientsInnerWithDefaults instantiates a new SearchScheduleRecipientsInner 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 + +### GetType + +`func (o *SearchScheduleRecipientsInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SearchScheduleRecipientsInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SearchScheduleRecipientsInner) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *SearchScheduleRecipientsInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SearchScheduleRecipientsInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SearchScheduleRecipientsInner) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SectionDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/SectionDetails.md new file mode 100644 index 000000000..f48ad8edf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SectionDetails.md @@ -0,0 +1,136 @@ +--- +id: v2024-section-details +title: SectionDetails +pagination_label: SectionDetails +sidebar_label: SectionDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SectionDetails', 'V2024SectionDetails'] +slug: /tools/sdk/go/v2024/models/section-details +tags: ['SDK', 'Software Development Kit', 'SectionDetails', 'V2024SectionDetails'] +--- + +# SectionDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **NullableString** | Name of the FormItem | [optional] +**Label** | Pointer to **NullableString** | Label of the section | [optional] +**FormItems** | Pointer to **[]map[string]interface{}** | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [optional] + +## Methods + +### NewSectionDetails + +`func NewSectionDetails() *SectionDetails` + +NewSectionDetails instantiates a new SectionDetails 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 + +### NewSectionDetailsWithDefaults + +`func NewSectionDetailsWithDefaults() *SectionDetails` + +NewSectionDetailsWithDefaults instantiates a new SectionDetails 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 + +### GetName + +`func (o *SectionDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SectionDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SectionDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SectionDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *SectionDetails) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *SectionDetails) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetLabel + +`func (o *SectionDetails) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *SectionDetails) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *SectionDetails) SetLabel(v string)` + +SetLabel sets Label field to given value. + +### HasLabel + +`func (o *SectionDetails) HasLabel() bool` + +HasLabel returns a boolean if a field has been set. + +### SetLabelNil + +`func (o *SectionDetails) SetLabelNil(b bool)` + + SetLabelNil sets the value for Label to be an explicit nil + +### UnsetLabel +`func (o *SectionDetails) UnsetLabel()` + +UnsetLabel ensures that no value is present for Label, not even an explicit nil +### GetFormItems + +`func (o *SectionDetails) GetFormItems() []map[string]interface{}` + +GetFormItems returns the FormItems field if non-nil, zero value otherwise. + +### GetFormItemsOk + +`func (o *SectionDetails) GetFormItemsOk() (*[]map[string]interface{}, bool)` + +GetFormItemsOk returns a tuple with the FormItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormItems + +`func (o *SectionDetails) SetFormItems(v []map[string]interface{})` + +SetFormItems sets FormItems field to given value. + +### HasFormItems + +`func (o *SectionDetails) HasFormItems() bool` + +HasFormItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Sed.md b/docs/tools/sdk/go/Reference/V2024/Models/Sed.md new file mode 100644 index 000000000..2a602c896 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Sed.md @@ -0,0 +1,402 @@ +--- +id: v2024-sed +title: Sed +pagination_label: Sed +sidebar_label: Sed +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Sed', 'V2024Sed'] +slug: /tools/sdk/go/v2024/models/sed +tags: ['SDK', 'Software Development Kit', 'Sed', 'V2024Sed'] +--- + +# Sed + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | name of the entitlement | [optional] +**ApprovedBy** | Pointer to **string** | entitlement approved by | [optional] +**ApprovedType** | Pointer to **string** | entitlement approved type | [optional] +**ApprovedWhen** | Pointer to **SailPointTime** | entitlement approved then | [optional] +**Attribute** | Pointer to **string** | entitlement attribute | [optional] +**Description** | Pointer to **string** | description of entitlement | [optional] +**DisplayName** | Pointer to **string** | entitlement display name | [optional] +**Id** | Pointer to **string** | sed id | [optional] +**SourceId** | Pointer to **string** | entitlement source id | [optional] +**SourceName** | Pointer to **string** | entitlement source name | [optional] +**Status** | Pointer to **string** | entitlement status | [optional] +**SuggestedDescription** | Pointer to **string** | llm suggested entitlement description | [optional] +**Type** | Pointer to **string** | entitlement type | [optional] +**Value** | Pointer to **string** | entitlement value | [optional] + +## Methods + +### NewSed + +`func NewSed() *Sed` + +NewSed instantiates a new Sed 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 + +### NewSedWithDefaults + +`func NewSedWithDefaults() *Sed` + +NewSedWithDefaults instantiates a new Sed 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 + +### GetName + +`func (o *Sed) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Sed) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Sed) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Sed) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetApprovedBy + +`func (o *Sed) GetApprovedBy() string` + +GetApprovedBy returns the ApprovedBy field if non-nil, zero value otherwise. + +### GetApprovedByOk + +`func (o *Sed) GetApprovedByOk() (*string, bool)` + +GetApprovedByOk returns a tuple with the ApprovedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovedBy + +`func (o *Sed) SetApprovedBy(v string)` + +SetApprovedBy sets ApprovedBy field to given value. + +### HasApprovedBy + +`func (o *Sed) HasApprovedBy() bool` + +HasApprovedBy returns a boolean if a field has been set. + +### GetApprovedType + +`func (o *Sed) GetApprovedType() string` + +GetApprovedType returns the ApprovedType field if non-nil, zero value otherwise. + +### GetApprovedTypeOk + +`func (o *Sed) GetApprovedTypeOk() (*string, bool)` + +GetApprovedTypeOk returns a tuple with the ApprovedType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovedType + +`func (o *Sed) SetApprovedType(v string)` + +SetApprovedType sets ApprovedType field to given value. + +### HasApprovedType + +`func (o *Sed) HasApprovedType() bool` + +HasApprovedType returns a boolean if a field has been set. + +### GetApprovedWhen + +`func (o *Sed) GetApprovedWhen() SailPointTime` + +GetApprovedWhen returns the ApprovedWhen field if non-nil, zero value otherwise. + +### GetApprovedWhenOk + +`func (o *Sed) GetApprovedWhenOk() (*SailPointTime, bool)` + +GetApprovedWhenOk returns a tuple with the ApprovedWhen field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovedWhen + +`func (o *Sed) SetApprovedWhen(v SailPointTime)` + +SetApprovedWhen sets ApprovedWhen field to given value. + +### HasApprovedWhen + +`func (o *Sed) HasApprovedWhen() bool` + +HasApprovedWhen returns a boolean if a field has been set. + +### GetAttribute + +`func (o *Sed) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *Sed) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *Sed) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *Sed) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetDescription + +`func (o *Sed) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Sed) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Sed) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Sed) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *Sed) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *Sed) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *Sed) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *Sed) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetId + +`func (o *Sed) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Sed) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Sed) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Sed) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *Sed) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *Sed) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *Sed) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *Sed) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceName + +`func (o *Sed) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *Sed) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *Sed) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *Sed) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetStatus + +`func (o *Sed) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Sed) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Sed) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Sed) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSuggestedDescription + +`func (o *Sed) GetSuggestedDescription() string` + +GetSuggestedDescription returns the SuggestedDescription field if non-nil, zero value otherwise. + +### GetSuggestedDescriptionOk + +`func (o *Sed) GetSuggestedDescriptionOk() (*string, bool)` + +GetSuggestedDescriptionOk returns a tuple with the SuggestedDescription field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSuggestedDescription + +`func (o *Sed) SetSuggestedDescription(v string)` + +SetSuggestedDescription sets SuggestedDescription field to given value. + +### HasSuggestedDescription + +`func (o *Sed) HasSuggestedDescription() bool` + +HasSuggestedDescription returns a boolean if a field has been set. + +### GetType + +`func (o *Sed) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Sed) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Sed) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Sed) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetValue + +`func (o *Sed) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Sed) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Sed) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Sed) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SedApproval.md b/docs/tools/sdk/go/Reference/V2024/Models/SedApproval.md new file mode 100644 index 000000000..b80191116 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SedApproval.md @@ -0,0 +1,64 @@ +--- +id: v2024-sed-approval +title: SedApproval +pagination_label: SedApproval +sidebar_label: SedApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedApproval', 'V2024SedApproval'] +slug: /tools/sdk/go/v2024/models/sed-approval +tags: ['SDK', 'Software Development Kit', 'SedApproval', 'V2024SedApproval'] +--- + +# SedApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Items** | Pointer to **[]string** | List of SED id's | [optional] + +## Methods + +### NewSedApproval + +`func NewSedApproval() *SedApproval` + +NewSedApproval instantiates a new SedApproval 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 + +### NewSedApprovalWithDefaults + +`func NewSedApprovalWithDefaults() *SedApproval` + +NewSedApprovalWithDefaults instantiates a new SedApproval 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 + +### GetItems + +`func (o *SedApproval) GetItems() []string` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *SedApproval) GetItemsOk() (*[]string, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *SedApproval) SetItems(v []string)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *SedApproval) HasItems() bool` + +HasItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SedApprovalStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/SedApprovalStatus.md new file mode 100644 index 000000000..896681038 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SedApprovalStatus.md @@ -0,0 +1,116 @@ +--- +id: v2024-sed-approval-status +title: SedApprovalStatus +pagination_label: SedApprovalStatus +sidebar_label: SedApprovalStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedApprovalStatus', 'V2024SedApprovalStatus'] +slug: /tools/sdk/go/v2024/models/sed-approval-status +tags: ['SDK', 'Software Development Kit', 'SedApprovalStatus', 'V2024SedApprovalStatus'] +--- + +# SedApprovalStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FailedReason** | Pointer to **string** | failed reason will be display if status is failed | [optional] +**Id** | Pointer to **string** | Sed id | [optional] +**Status** | Pointer to **string** | SUCCESS | FAILED | [optional] + +## Methods + +### NewSedApprovalStatus + +`func NewSedApprovalStatus() *SedApprovalStatus` + +NewSedApprovalStatus instantiates a new SedApprovalStatus 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 + +### NewSedApprovalStatusWithDefaults + +`func NewSedApprovalStatusWithDefaults() *SedApprovalStatus` + +NewSedApprovalStatusWithDefaults instantiates a new SedApprovalStatus 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 + +### GetFailedReason + +`func (o *SedApprovalStatus) GetFailedReason() string` + +GetFailedReason returns the FailedReason field if non-nil, zero value otherwise. + +### GetFailedReasonOk + +`func (o *SedApprovalStatus) GetFailedReasonOk() (*string, bool)` + +GetFailedReasonOk returns a tuple with the FailedReason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFailedReason + +`func (o *SedApprovalStatus) SetFailedReason(v string)` + +SetFailedReason sets FailedReason field to given value. + +### HasFailedReason + +`func (o *SedApprovalStatus) HasFailedReason() bool` + +HasFailedReason returns a boolean if a field has been set. + +### GetId + +`func (o *SedApprovalStatus) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SedApprovalStatus) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SedApprovalStatus) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SedApprovalStatus) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetStatus + +`func (o *SedApprovalStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SedApprovalStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SedApprovalStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SedApprovalStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SedAssignee.md b/docs/tools/sdk/go/Reference/V2024/Models/SedAssignee.md new file mode 100644 index 000000000..c237c9c19 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SedAssignee.md @@ -0,0 +1,85 @@ +--- +id: v2024-sed-assignee +title: SedAssignee +pagination_label: SedAssignee +sidebar_label: SedAssignee +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedAssignee', 'V2024SedAssignee'] +slug: /tools/sdk/go/v2024/models/sed-assignee +tags: ['SDK', 'Software Development Kit', 'SedAssignee', 'V2024SedAssignee'] +--- + +# SedAssignee + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of assignment When value is PERSONA, the value MUST be SOURCE_OWNER or ENTITLEMENT_OWNER IDENTITY SED_ASSIGNEE_IDENTITY_TYPE GROUP SED_ASSIGNEE_GROUP_TYPE SOURCE_OWNER SED_ASSIGNEE_SOURCE_OWNER_TYPE ENTITLEMENT_OWNER SED_ASSIGNEE_ENTITLEMENT_OWNER_TYPE | +**Value** | Pointer to **string** | Identity or Group identifier Empty when using source/entitlement owner personas | [optional] + +## Methods + +### NewSedAssignee + +`func NewSedAssignee(type_ string, ) *SedAssignee` + +NewSedAssignee instantiates a new SedAssignee 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 + +### NewSedAssigneeWithDefaults + +`func NewSedAssigneeWithDefaults() *SedAssignee` + +NewSedAssigneeWithDefaults instantiates a new SedAssignee 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 + +### GetType + +`func (o *SedAssignee) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SedAssignee) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SedAssignee) SetType(v string)` + +SetType sets Type field to given value. + + +### GetValue + +`func (o *SedAssignee) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SedAssignee) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SedAssignee) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SedAssignee) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SedAssignment.md b/docs/tools/sdk/go/Reference/V2024/Models/SedAssignment.md new file mode 100644 index 000000000..cd798725e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SedAssignment.md @@ -0,0 +1,90 @@ +--- +id: v2024-sed-assignment +title: SedAssignment +pagination_label: SedAssignment +sidebar_label: SedAssignment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedAssignment', 'V2024SedAssignment'] +slug: /tools/sdk/go/v2024/models/sed-assignment +tags: ['SDK', 'Software Development Kit', 'SedAssignment', 'V2024SedAssignment'] +--- + +# SedAssignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Assignee** | Pointer to [**SedAssignee**](sed-assignee) | | [optional] +**Items** | Pointer to **[]string** | List of SED id's | [optional] + +## Methods + +### NewSedAssignment + +`func NewSedAssignment() *SedAssignment` + +NewSedAssignment instantiates a new SedAssignment 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 + +### NewSedAssignmentWithDefaults + +`func NewSedAssignmentWithDefaults() *SedAssignment` + +NewSedAssignmentWithDefaults instantiates a new SedAssignment 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 + +### GetAssignee + +`func (o *SedAssignment) GetAssignee() SedAssignee` + +GetAssignee returns the Assignee field if non-nil, zero value otherwise. + +### GetAssigneeOk + +`func (o *SedAssignment) GetAssigneeOk() (*SedAssignee, bool)` + +GetAssigneeOk returns a tuple with the Assignee field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignee + +`func (o *SedAssignment) SetAssignee(v SedAssignee)` + +SetAssignee sets Assignee field to given value. + +### HasAssignee + +`func (o *SedAssignment) HasAssignee() bool` + +HasAssignee returns a boolean if a field has been set. + +### GetItems + +`func (o *SedAssignment) GetItems() []string` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *SedAssignment) GetItemsOk() (*[]string, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *SedAssignment) SetItems(v []string)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *SedAssignment) HasItems() bool` + +HasItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SedAssignmentResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/SedAssignmentResponse.md new file mode 100644 index 000000000..8563b9130 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SedAssignmentResponse.md @@ -0,0 +1,64 @@ +--- +id: v2024-sed-assignment-response +title: SedAssignmentResponse +pagination_label: SedAssignmentResponse +sidebar_label: SedAssignmentResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedAssignmentResponse', 'V2024SedAssignmentResponse'] +slug: /tools/sdk/go/v2024/models/sed-assignment-response +tags: ['SDK', 'Software Development Kit', 'SedAssignmentResponse', 'V2024SedAssignmentResponse'] +--- + +# SedAssignmentResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **string** | BatchId that groups all the ids together | [optional] + +## Methods + +### NewSedAssignmentResponse + +`func NewSedAssignmentResponse() *SedAssignmentResponse` + +NewSedAssignmentResponse instantiates a new SedAssignmentResponse 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 + +### NewSedAssignmentResponseWithDefaults + +`func NewSedAssignmentResponseWithDefaults() *SedAssignmentResponse` + +NewSedAssignmentResponseWithDefaults instantiates a new SedAssignmentResponse 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 + +### GetBatchId + +`func (o *SedAssignmentResponse) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *SedAssignmentResponse) GetBatchIdOk() (*string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchId + +`func (o *SedAssignmentResponse) SetBatchId(v string)` + +SetBatchId sets BatchId field to given value. + +### HasBatchId + +`func (o *SedAssignmentResponse) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SedBatchRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/SedBatchRequest.md new file mode 100644 index 000000000..0174957bf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SedBatchRequest.md @@ -0,0 +1,90 @@ +--- +id: v2024-sed-batch-request +title: SedBatchRequest +pagination_label: SedBatchRequest +sidebar_label: SedBatchRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedBatchRequest', 'V2024SedBatchRequest'] +slug: /tools/sdk/go/v2024/models/sed-batch-request +tags: ['SDK', 'Software Development Kit', 'SedBatchRequest', 'V2024SedBatchRequest'] +--- + +# SedBatchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Entitlements** | Pointer to **[]string** | list of entitlement ids | [optional] +**Seds** | Pointer to **[]string** | list of sed ids | [optional] + +## Methods + +### NewSedBatchRequest + +`func NewSedBatchRequest() *SedBatchRequest` + +NewSedBatchRequest instantiates a new SedBatchRequest 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 + +### NewSedBatchRequestWithDefaults + +`func NewSedBatchRequestWithDefaults() *SedBatchRequest` + +NewSedBatchRequestWithDefaults instantiates a new SedBatchRequest 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 + +### GetEntitlements + +`func (o *SedBatchRequest) GetEntitlements() []string` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *SedBatchRequest) GetEntitlementsOk() (*[]string, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *SedBatchRequest) SetEntitlements(v []string)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *SedBatchRequest) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetSeds + +`func (o *SedBatchRequest) GetSeds() []string` + +GetSeds returns the Seds field if non-nil, zero value otherwise. + +### GetSedsOk + +`func (o *SedBatchRequest) GetSedsOk() (*[]string, bool)` + +GetSedsOk returns a tuple with the Seds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSeds + +`func (o *SedBatchRequest) SetSeds(v []string)` + +SetSeds sets Seds field to given value. + +### HasSeds + +`func (o *SedBatchRequest) HasSeds() bool` + +HasSeds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SedBatchResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/SedBatchResponse.md new file mode 100644 index 000000000..2cb435b29 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SedBatchResponse.md @@ -0,0 +1,64 @@ +--- +id: v2024-sed-batch-response +title: SedBatchResponse +pagination_label: SedBatchResponse +sidebar_label: SedBatchResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedBatchResponse', 'V2024SedBatchResponse'] +slug: /tools/sdk/go/v2024/models/sed-batch-response +tags: ['SDK', 'Software Development Kit', 'SedBatchResponse', 'V2024SedBatchResponse'] +--- + +# SedBatchResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **string** | BatchId that groups all the ids together | [optional] + +## Methods + +### NewSedBatchResponse + +`func NewSedBatchResponse() *SedBatchResponse` + +NewSedBatchResponse instantiates a new SedBatchResponse 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 + +### NewSedBatchResponseWithDefaults + +`func NewSedBatchResponseWithDefaults() *SedBatchResponse` + +NewSedBatchResponseWithDefaults instantiates a new SedBatchResponse 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 + +### GetBatchId + +`func (o *SedBatchResponse) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *SedBatchResponse) GetBatchIdOk() (*string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchId + +`func (o *SedBatchResponse) SetBatchId(v string)` + +SetBatchId sets BatchId field to given value. + +### HasBatchId + +`func (o *SedBatchResponse) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SedBatchStats.md b/docs/tools/sdk/go/Reference/V2024/Models/SedBatchStats.md new file mode 100644 index 000000000..b9a4c3896 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SedBatchStats.md @@ -0,0 +1,168 @@ +--- +id: v2024-sed-batch-stats +title: SedBatchStats +pagination_label: SedBatchStats +sidebar_label: SedBatchStats +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedBatchStats', 'V2024SedBatchStats'] +slug: /tools/sdk/go/v2024/models/sed-batch-stats +tags: ['SDK', 'Software Development Kit', 'SedBatchStats', 'V2024SedBatchStats'] +--- + +# SedBatchStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchComplete** | Pointer to **bool** | batch complete | [optional] [default to false] +**BatchId** | Pointer to **string** | batch Id | [optional] +**DiscoveredCount** | Pointer to **int64** | discovered count | [optional] +**DiscoveryComplete** | Pointer to **bool** | discovery complete | [optional] [default to false] +**ProcessedCount** | Pointer to **int64** | processed count | [optional] + +## Methods + +### NewSedBatchStats + +`func NewSedBatchStats() *SedBatchStats` + +NewSedBatchStats instantiates a new SedBatchStats 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 + +### NewSedBatchStatsWithDefaults + +`func NewSedBatchStatsWithDefaults() *SedBatchStats` + +NewSedBatchStatsWithDefaults instantiates a new SedBatchStats 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 + +### GetBatchComplete + +`func (o *SedBatchStats) GetBatchComplete() bool` + +GetBatchComplete returns the BatchComplete field if non-nil, zero value otherwise. + +### GetBatchCompleteOk + +`func (o *SedBatchStats) GetBatchCompleteOk() (*bool, bool)` + +GetBatchCompleteOk returns a tuple with the BatchComplete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchComplete + +`func (o *SedBatchStats) SetBatchComplete(v bool)` + +SetBatchComplete sets BatchComplete field to given value. + +### HasBatchComplete + +`func (o *SedBatchStats) HasBatchComplete() bool` + +HasBatchComplete returns a boolean if a field has been set. + +### GetBatchId + +`func (o *SedBatchStats) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *SedBatchStats) GetBatchIdOk() (*string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchId + +`func (o *SedBatchStats) SetBatchId(v string)` + +SetBatchId sets BatchId field to given value. + +### HasBatchId + +`func (o *SedBatchStats) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### GetDiscoveredCount + +`func (o *SedBatchStats) GetDiscoveredCount() int64` + +GetDiscoveredCount returns the DiscoveredCount field if non-nil, zero value otherwise. + +### GetDiscoveredCountOk + +`func (o *SedBatchStats) GetDiscoveredCountOk() (*int64, bool)` + +GetDiscoveredCountOk returns a tuple with the DiscoveredCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredCount + +`func (o *SedBatchStats) SetDiscoveredCount(v int64)` + +SetDiscoveredCount sets DiscoveredCount field to given value. + +### HasDiscoveredCount + +`func (o *SedBatchStats) HasDiscoveredCount() bool` + +HasDiscoveredCount returns a boolean if a field has been set. + +### GetDiscoveryComplete + +`func (o *SedBatchStats) GetDiscoveryComplete() bool` + +GetDiscoveryComplete returns the DiscoveryComplete field if non-nil, zero value otherwise. + +### GetDiscoveryCompleteOk + +`func (o *SedBatchStats) GetDiscoveryCompleteOk() (*bool, bool)` + +GetDiscoveryCompleteOk returns a tuple with the DiscoveryComplete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveryComplete + +`func (o *SedBatchStats) SetDiscoveryComplete(v bool)` + +SetDiscoveryComplete sets DiscoveryComplete field to given value. + +### HasDiscoveryComplete + +`func (o *SedBatchStats) HasDiscoveryComplete() bool` + +HasDiscoveryComplete returns a boolean if a field has been set. + +### GetProcessedCount + +`func (o *SedBatchStats) GetProcessedCount() int64` + +GetProcessedCount returns the ProcessedCount field if non-nil, zero value otherwise. + +### GetProcessedCountOk + +`func (o *SedBatchStats) GetProcessedCountOk() (*int64, bool)` + +GetProcessedCountOk returns a tuple with the ProcessedCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessedCount + +`func (o *SedBatchStats) SetProcessedCount(v int64)` + +SetProcessedCount sets ProcessedCount field to given value. + +### HasProcessedCount + +`func (o *SedBatchStats) HasProcessedCount() bool` + +HasProcessedCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SedBatchStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/SedBatchStatus.md new file mode 100644 index 000000000..8bc414aad --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SedBatchStatus.md @@ -0,0 +1,64 @@ +--- +id: v2024-sed-batch-status +title: SedBatchStatus +pagination_label: SedBatchStatus +sidebar_label: SedBatchStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedBatchStatus', 'V2024SedBatchStatus'] +slug: /tools/sdk/go/v2024/models/sed-batch-status +tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'V2024SedBatchStatus'] +--- + +# SedBatchStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | status of batch | [optional] + +## Methods + +### NewSedBatchStatus + +`func NewSedBatchStatus() *SedBatchStatus` + +NewSedBatchStatus instantiates a new SedBatchStatus 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 + +### NewSedBatchStatusWithDefaults + +`func NewSedBatchStatusWithDefaults() *SedBatchStatus` + +NewSedBatchStatusWithDefaults instantiates a new SedBatchStatus 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 + +### GetStatus + +`func (o *SedBatchStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SedBatchStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SedBatchStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SedBatchStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SedPatch.md b/docs/tools/sdk/go/Reference/V2024/Models/SedPatch.md new file mode 100644 index 000000000..7afaeca14 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SedPatch.md @@ -0,0 +1,116 @@ +--- +id: v2024-sed-patch +title: SedPatch +pagination_label: SedPatch +sidebar_label: SedPatch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedPatch', 'V2024SedPatch'] +slug: /tools/sdk/go/v2024/models/sed-patch +tags: ['SDK', 'Software Development Kit', 'SedPatch', 'V2024SedPatch'] +--- + +# SedPatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | Pointer to **string** | desired operation | [optional] +**Path** | Pointer to **string** | field to be patched | [optional] +**Value** | Pointer to **map[string]interface{}** | value to replace with | [optional] + +## Methods + +### NewSedPatch + +`func NewSedPatch() *SedPatch` + +NewSedPatch instantiates a new SedPatch 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 + +### NewSedPatchWithDefaults + +`func NewSedPatchWithDefaults() *SedPatch` + +NewSedPatchWithDefaults instantiates a new SedPatch 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 + +### GetOp + +`func (o *SedPatch) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *SedPatch) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *SedPatch) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *SedPatch) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetPath + +`func (o *SedPatch) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *SedPatch) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *SedPatch) SetPath(v string)` + +SetPath sets Path field to given value. + +### HasPath + +`func (o *SedPatch) HasPath() bool` + +HasPath returns a boolean if a field has been set. + +### GetValue + +`func (o *SedPatch) GetValue() map[string]interface{}` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SedPatch) GetValueOk() (*map[string]interface{}, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SedPatch) SetValue(v map[string]interface{})` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SedPatch) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Segment.md b/docs/tools/sdk/go/Reference/V2024/Models/Segment.md new file mode 100644 index 000000000..ab62e6ea8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Segment.md @@ -0,0 +1,256 @@ +--- +id: v2024-segment +title: Segment +pagination_label: Segment +sidebar_label: Segment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Segment', 'V2024Segment'] +slug: /tools/sdk/go/v2024/models/segment +tags: ['SDK', 'Software Development Kit', 'Segment', 'V2024Segment'] +--- + +# Segment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The segment's ID. | [optional] +**Name** | Pointer to **string** | The segment's business name. | [optional] +**Created** | Pointer to **SailPointTime** | The time when the segment is created. | [optional] +**Modified** | Pointer to **SailPointTime** | The time when the segment is modified. | [optional] +**Description** | Pointer to **string** | The segment's optional description. | [optional] +**Owner** | Pointer to [**NullableOwnerReferenceSegments**](owner-reference-segments) | | [optional] +**VisibilityCriteria** | Pointer to [**SegmentVisibilityCriteria**](segment-visibility-criteria) | | [optional] +**Active** | Pointer to **bool** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to false] + +## Methods + +### NewSegment + +`func NewSegment() *Segment` + +NewSegment instantiates a new Segment 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 + +### NewSegmentWithDefaults + +`func NewSegmentWithDefaults() *Segment` + +NewSegmentWithDefaults instantiates a new Segment 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 + +### GetId + +`func (o *Segment) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Segment) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Segment) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Segment) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Segment) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Segment) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Segment) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Segment) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *Segment) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Segment) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Segment) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Segment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Segment) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Segment) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Segment) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Segment) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *Segment) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Segment) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Segment) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Segment) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *Segment) GetOwner() OwnerReferenceSegments` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Segment) GetOwnerOk() (*OwnerReferenceSegments, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Segment) SetOwner(v OwnerReferenceSegments)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *Segment) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *Segment) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *Segment) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetVisibilityCriteria + +`func (o *Segment) GetVisibilityCriteria() SegmentVisibilityCriteria` + +GetVisibilityCriteria returns the VisibilityCriteria field if non-nil, zero value otherwise. + +### GetVisibilityCriteriaOk + +`func (o *Segment) GetVisibilityCriteriaOk() (*SegmentVisibilityCriteria, bool)` + +GetVisibilityCriteriaOk returns a tuple with the VisibilityCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVisibilityCriteria + +`func (o *Segment) SetVisibilityCriteria(v SegmentVisibilityCriteria)` + +SetVisibilityCriteria sets VisibilityCriteria field to given value. + +### HasVisibilityCriteria + +`func (o *Segment) HasVisibilityCriteria() bool` + +HasVisibilityCriteria returns a boolean if a field has been set. + +### GetActive + +`func (o *Segment) GetActive() bool` + +GetActive returns the Active field if non-nil, zero value otherwise. + +### GetActiveOk + +`func (o *Segment) GetActiveOk() (*bool, bool)` + +GetActiveOk returns a tuple with the Active field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActive + +`func (o *Segment) SetActive(v bool)` + +SetActive sets Active field to given value. + +### HasActive + +`func (o *Segment) HasActive() bool` + +HasActive returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SegmentVisibilityCriteria.md b/docs/tools/sdk/go/Reference/V2024/Models/SegmentVisibilityCriteria.md new file mode 100644 index 000000000..edbaa1a10 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SegmentVisibilityCriteria.md @@ -0,0 +1,64 @@ +--- +id: v2024-segment-visibility-criteria +title: SegmentVisibilityCriteria +pagination_label: SegmentVisibilityCriteria +sidebar_label: SegmentVisibilityCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SegmentVisibilityCriteria', 'V2024SegmentVisibilityCriteria'] +slug: /tools/sdk/go/v2024/models/segment-visibility-criteria +tags: ['SDK', 'Software Development Kit', 'SegmentVisibilityCriteria', 'V2024SegmentVisibilityCriteria'] +--- + +# SegmentVisibilityCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | Pointer to [**Expression**](expression) | | [optional] + +## Methods + +### NewSegmentVisibilityCriteria + +`func NewSegmentVisibilityCriteria() *SegmentVisibilityCriteria` + +NewSegmentVisibilityCriteria instantiates a new SegmentVisibilityCriteria 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 + +### NewSegmentVisibilityCriteriaWithDefaults + +`func NewSegmentVisibilityCriteriaWithDefaults() *SegmentVisibilityCriteria` + +NewSegmentVisibilityCriteriaWithDefaults instantiates a new SegmentVisibilityCriteria 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 + +### GetExpression + +`func (o *SegmentVisibilityCriteria) GetExpression() Expression` + +GetExpression returns the Expression field if non-nil, zero value otherwise. + +### GetExpressionOk + +`func (o *SegmentVisibilityCriteria) GetExpressionOk() (*Expression, bool)` + +GetExpressionOk returns a tuple with the Expression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpression + +`func (o *SegmentVisibilityCriteria) SetExpression(v Expression)` + +SetExpression sets Expression field to given value. + +### HasExpression + +`func (o *SegmentVisibilityCriteria) HasExpression() bool` + +HasExpression returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Selector.md b/docs/tools/sdk/go/Reference/V2024/Models/Selector.md new file mode 100644 index 000000000..1c21b4562 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Selector.md @@ -0,0 +1,90 @@ +--- +id: v2024-selector +title: Selector +pagination_label: Selector +sidebar_label: Selector +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Selector', 'V2024Selector'] +slug: /tools/sdk/go/v2024/models/selector +tags: ['SDK', 'Software Development Kit', 'Selector', 'V2024Selector'] +--- + +# Selector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **string** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Methods + +### NewSelector + +`func NewSelector() *Selector` + +NewSelector instantiates a new Selector 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 + +### NewSelectorWithDefaults + +`func NewSelectorWithDefaults() *Selector` + +NewSelectorWithDefaults instantiates a new Selector 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 + +### GetApplicationId + +`func (o *Selector) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *Selector) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *Selector) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *Selector) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### GetAccountMatchConfig + +`func (o *Selector) GetAccountMatchConfig() SelectorAccountMatchConfig` + +GetAccountMatchConfig returns the AccountMatchConfig field if non-nil, zero value otherwise. + +### GetAccountMatchConfigOk + +`func (o *Selector) GetAccountMatchConfigOk() (*SelectorAccountMatchConfig, bool)` + +GetAccountMatchConfigOk returns a tuple with the AccountMatchConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountMatchConfig + +`func (o *Selector) SetAccountMatchConfig(v SelectorAccountMatchConfig)` + +SetAccountMatchConfig sets AccountMatchConfig field to given value. + +### HasAccountMatchConfig + +`func (o *Selector) HasAccountMatchConfig() bool` + +HasAccountMatchConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SelectorAccountMatchConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/SelectorAccountMatchConfig.md new file mode 100644 index 000000000..5a0c36b42 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SelectorAccountMatchConfig.md @@ -0,0 +1,64 @@ +--- +id: v2024-selector-account-match-config +title: SelectorAccountMatchConfig +pagination_label: SelectorAccountMatchConfig +sidebar_label: SelectorAccountMatchConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SelectorAccountMatchConfig', 'V2024SelectorAccountMatchConfig'] +slug: /tools/sdk/go/v2024/models/selector-account-match-config +tags: ['SDK', 'Software Development Kit', 'SelectorAccountMatchConfig', 'V2024SelectorAccountMatchConfig'] +--- + +# SelectorAccountMatchConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MatchExpression** | Pointer to [**SelectorAccountMatchConfigMatchExpression**](selector-account-match-config-match-expression) | | [optional] + +## Methods + +### NewSelectorAccountMatchConfig + +`func NewSelectorAccountMatchConfig() *SelectorAccountMatchConfig` + +NewSelectorAccountMatchConfig instantiates a new SelectorAccountMatchConfig 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 + +### NewSelectorAccountMatchConfigWithDefaults + +`func NewSelectorAccountMatchConfigWithDefaults() *SelectorAccountMatchConfig` + +NewSelectorAccountMatchConfigWithDefaults instantiates a new SelectorAccountMatchConfig 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 + +### GetMatchExpression + +`func (o *SelectorAccountMatchConfig) GetMatchExpression() SelectorAccountMatchConfigMatchExpression` + +GetMatchExpression returns the MatchExpression field if non-nil, zero value otherwise. + +### GetMatchExpressionOk + +`func (o *SelectorAccountMatchConfig) GetMatchExpressionOk() (*SelectorAccountMatchConfigMatchExpression, bool)` + +GetMatchExpressionOk returns a tuple with the MatchExpression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchExpression + +`func (o *SelectorAccountMatchConfig) SetMatchExpression(v SelectorAccountMatchConfigMatchExpression)` + +SetMatchExpression sets MatchExpression field to given value. + +### HasMatchExpression + +`func (o *SelectorAccountMatchConfig) HasMatchExpression() bool` + +HasMatchExpression returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SelectorAccountMatchConfigMatchExpression.md b/docs/tools/sdk/go/Reference/V2024/Models/SelectorAccountMatchConfigMatchExpression.md new file mode 100644 index 000000000..9de11f588 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SelectorAccountMatchConfigMatchExpression.md @@ -0,0 +1,90 @@ +--- +id: v2024-selector-account-match-config-match-expression +title: SelectorAccountMatchConfigMatchExpression +pagination_label: SelectorAccountMatchConfigMatchExpression +sidebar_label: SelectorAccountMatchConfigMatchExpression +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SelectorAccountMatchConfigMatchExpression', 'V2024SelectorAccountMatchConfigMatchExpression'] +slug: /tools/sdk/go/v2024/models/selector-account-match-config-match-expression +tags: ['SDK', 'Software Development Kit', 'SelectorAccountMatchConfigMatchExpression', 'V2024SelectorAccountMatchConfigMatchExpression'] +--- + +# SelectorAccountMatchConfigMatchExpression + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MatchTerms** | Pointer to [**[]MatchTerm**](match-term) | | [optional] +**And** | Pointer to **bool** | If it is AND operators for match terms | [optional] [default to true] + +## Methods + +### NewSelectorAccountMatchConfigMatchExpression + +`func NewSelectorAccountMatchConfigMatchExpression() *SelectorAccountMatchConfigMatchExpression` + +NewSelectorAccountMatchConfigMatchExpression instantiates a new SelectorAccountMatchConfigMatchExpression 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 + +### NewSelectorAccountMatchConfigMatchExpressionWithDefaults + +`func NewSelectorAccountMatchConfigMatchExpressionWithDefaults() *SelectorAccountMatchConfigMatchExpression` + +NewSelectorAccountMatchConfigMatchExpressionWithDefaults instantiates a new SelectorAccountMatchConfigMatchExpression 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 + +### GetMatchTerms + +`func (o *SelectorAccountMatchConfigMatchExpression) GetMatchTerms() []MatchTerm` + +GetMatchTerms returns the MatchTerms field if non-nil, zero value otherwise. + +### GetMatchTermsOk + +`func (o *SelectorAccountMatchConfigMatchExpression) GetMatchTermsOk() (*[]MatchTerm, bool)` + +GetMatchTermsOk returns a tuple with the MatchTerms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchTerms + +`func (o *SelectorAccountMatchConfigMatchExpression) SetMatchTerms(v []MatchTerm)` + +SetMatchTerms sets MatchTerms field to given value. + +### HasMatchTerms + +`func (o *SelectorAccountMatchConfigMatchExpression) HasMatchTerms() bool` + +HasMatchTerms returns a boolean if a field has been set. + +### GetAnd + +`func (o *SelectorAccountMatchConfigMatchExpression) GetAnd() bool` + +GetAnd returns the And field if non-nil, zero value otherwise. + +### GetAndOk + +`func (o *SelectorAccountMatchConfigMatchExpression) GetAndOk() (*bool, bool)` + +GetAndOk returns a tuple with the And field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnd + +`func (o *SelectorAccountMatchConfigMatchExpression) SetAnd(v bool)` + +SetAnd sets And field to given value. + +### HasAnd + +`func (o *SelectorAccountMatchConfigMatchExpression) HasAnd() bool` + +HasAnd returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SelfImportExportDto.md b/docs/tools/sdk/go/Reference/V2024/Models/SelfImportExportDto.md new file mode 100644 index 000000000..c113033ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SelfImportExportDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-self-import-export-dto +title: SelfImportExportDto +pagination_label: SelfImportExportDto +sidebar_label: SelfImportExportDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SelfImportExportDto', 'V2024SelfImportExportDto'] +slug: /tools/sdk/go/v2024/models/self-import-export-dto +tags: ['SDK', 'Software Development Kit', 'SelfImportExportDto', 'V2024SelfImportExportDto'] +--- + +# SelfImportExportDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Imported/exported object's DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [optional] +**Id** | Pointer to **string** | Imported/exported object's ID. | [optional] +**Name** | Pointer to **string** | Imported/exported object's display name. | [optional] + +## Methods + +### NewSelfImportExportDto + +`func NewSelfImportExportDto() *SelfImportExportDto` + +NewSelfImportExportDto instantiates a new SelfImportExportDto 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 + +### NewSelfImportExportDtoWithDefaults + +`func NewSelfImportExportDtoWithDefaults() *SelfImportExportDto` + +NewSelfImportExportDtoWithDefaults instantiates a new SelfImportExportDto 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 + +### GetType + +`func (o *SelfImportExportDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SelfImportExportDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SelfImportExportDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SelfImportExportDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SelfImportExportDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SelfImportExportDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SelfImportExportDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SelfImportExportDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SelfImportExportDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SelfImportExportDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SelfImportExportDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SelfImportExportDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SendAccountVerificationRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/SendAccountVerificationRequest.md new file mode 100644 index 000000000..eda447dd1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SendAccountVerificationRequest.md @@ -0,0 +1,95 @@ +--- +id: v2024-send-account-verification-request +title: SendAccountVerificationRequest +pagination_label: SendAccountVerificationRequest +sidebar_label: SendAccountVerificationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SendAccountVerificationRequest', 'V2024SendAccountVerificationRequest'] +slug: /tools/sdk/go/v2024/models/send-account-verification-request +tags: ['SDK', 'Software Development Kit', 'SendAccountVerificationRequest', 'V2024SendAccountVerificationRequest'] +--- + +# SendAccountVerificationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceName** | Pointer to **NullableString** | The source name where identity account password should be reset | [optional] +**Via** | **string** | The method to send notification | + +## Methods + +### NewSendAccountVerificationRequest + +`func NewSendAccountVerificationRequest(via string, ) *SendAccountVerificationRequest` + +NewSendAccountVerificationRequest instantiates a new SendAccountVerificationRequest 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 + +### NewSendAccountVerificationRequestWithDefaults + +`func NewSendAccountVerificationRequestWithDefaults() *SendAccountVerificationRequest` + +NewSendAccountVerificationRequestWithDefaults instantiates a new SendAccountVerificationRequest 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 + +### GetSourceName + +`func (o *SendAccountVerificationRequest) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *SendAccountVerificationRequest) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *SendAccountVerificationRequest) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *SendAccountVerificationRequest) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### SetSourceNameNil + +`func (o *SendAccountVerificationRequest) SetSourceNameNil(b bool)` + + SetSourceNameNil sets the value for SourceName to be an explicit nil + +### UnsetSourceName +`func (o *SendAccountVerificationRequest) UnsetSourceName()` + +UnsetSourceName ensures that no value is present for SourceName, not even an explicit nil +### GetVia + +`func (o *SendAccountVerificationRequest) GetVia() string` + +GetVia returns the Via field if non-nil, zero value otherwise. + +### GetViaOk + +`func (o *SendAccountVerificationRequest) GetViaOk() (*string, bool)` + +GetViaOk returns a tuple with the Via field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVia + +`func (o *SendAccountVerificationRequest) SetVia(v string)` + +SetVia sets Via field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SendClassifyMachineAccount200Response.md b/docs/tools/sdk/go/Reference/V2024/Models/SendClassifyMachineAccount200Response.md new file mode 100644 index 000000000..ae471669f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SendClassifyMachineAccount200Response.md @@ -0,0 +1,64 @@ +--- +id: v2024-send-classify-machine-account200-response +title: SendClassifyMachineAccount200Response +pagination_label: SendClassifyMachineAccount200Response +sidebar_label: SendClassifyMachineAccount200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SendClassifyMachineAccount200Response', 'V2024SendClassifyMachineAccount200Response'] +slug: /tools/sdk/go/v2024/models/send-classify-machine-account200-response +tags: ['SDK', 'Software Development Kit', 'SendClassifyMachineAccount200Response', 'V2024SendClassifyMachineAccount200Response'] +--- + +# SendClassifyMachineAccount200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsMachine** | Pointer to **bool** | Indicates if account is classified as machine | [optional] [default to false] + +## Methods + +### NewSendClassifyMachineAccount200Response + +`func NewSendClassifyMachineAccount200Response() *SendClassifyMachineAccount200Response` + +NewSendClassifyMachineAccount200Response instantiates a new SendClassifyMachineAccount200Response 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 + +### NewSendClassifyMachineAccount200ResponseWithDefaults + +`func NewSendClassifyMachineAccount200ResponseWithDefaults() *SendClassifyMachineAccount200Response` + +NewSendClassifyMachineAccount200ResponseWithDefaults instantiates a new SendClassifyMachineAccount200Response 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 + +### GetIsMachine + +`func (o *SendClassifyMachineAccount200Response) GetIsMachine() bool` + +GetIsMachine returns the IsMachine field if non-nil, zero value otherwise. + +### GetIsMachineOk + +`func (o *SendClassifyMachineAccount200Response) GetIsMachineOk() (*bool, bool)` + +GetIsMachineOk returns a tuple with the IsMachine field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsMachine + +`func (o *SendClassifyMachineAccount200Response) SetIsMachine(v bool)` + +SetIsMachine sets IsMachine field to given value. + +### HasIsMachine + +`func (o *SendClassifyMachineAccount200Response) HasIsMachine() bool` + +HasIsMachine returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SendTestNotificationRequestDto.md b/docs/tools/sdk/go/Reference/V2024/Models/SendTestNotificationRequestDto.md new file mode 100644 index 000000000..826ddc87c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SendTestNotificationRequestDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-send-test-notification-request-dto +title: SendTestNotificationRequestDto +pagination_label: SendTestNotificationRequestDto +sidebar_label: SendTestNotificationRequestDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SendTestNotificationRequestDto', 'V2024SendTestNotificationRequestDto'] +slug: /tools/sdk/go/v2024/models/send-test-notification-request-dto +tags: ['SDK', 'Software Development Kit', 'SendTestNotificationRequestDto', 'V2024SendTestNotificationRequestDto'] +--- + +# SendTestNotificationRequestDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The template notification key. | [optional] +**Medium** | Pointer to **string** | The notification medium. Has to be one of the following enum values. | [optional] +**Context** | Pointer to **map[string]interface{}** | A Json object that denotes the context specific to the template. | [optional] + +## Methods + +### NewSendTestNotificationRequestDto + +`func NewSendTestNotificationRequestDto() *SendTestNotificationRequestDto` + +NewSendTestNotificationRequestDto instantiates a new SendTestNotificationRequestDto 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 + +### NewSendTestNotificationRequestDtoWithDefaults + +`func NewSendTestNotificationRequestDtoWithDefaults() *SendTestNotificationRequestDto` + +NewSendTestNotificationRequestDtoWithDefaults instantiates a new SendTestNotificationRequestDto 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 + +### GetKey + +`func (o *SendTestNotificationRequestDto) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *SendTestNotificationRequestDto) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *SendTestNotificationRequestDto) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *SendTestNotificationRequestDto) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetMedium + +`func (o *SendTestNotificationRequestDto) GetMedium() string` + +GetMedium returns the Medium field if non-nil, zero value otherwise. + +### GetMediumOk + +`func (o *SendTestNotificationRequestDto) GetMediumOk() (*string, bool)` + +GetMediumOk returns a tuple with the Medium field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMedium + +`func (o *SendTestNotificationRequestDto) SetMedium(v string)` + +SetMedium sets Medium field to given value. + +### HasMedium + +`func (o *SendTestNotificationRequestDto) HasMedium() bool` + +HasMedium returns a boolean if a field has been set. + +### GetContext + +`func (o *SendTestNotificationRequestDto) GetContext() map[string]interface{}` + +GetContext returns the Context field if non-nil, zero value otherwise. + +### GetContextOk + +`func (o *SendTestNotificationRequestDto) GetContextOk() (*map[string]interface{}, bool)` + +GetContextOk returns a tuple with the Context field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContext + +`func (o *SendTestNotificationRequestDto) SetContext(v map[string]interface{})` + +SetContext sets Context field to given value. + +### HasContext + +`func (o *SendTestNotificationRequestDto) HasContext() bool` + +HasContext returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ServiceDeskIntegrationDto.md b/docs/tools/sdk/go/Reference/V2024/Models/ServiceDeskIntegrationDto.md new file mode 100644 index 000000000..25c2f3ea9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ServiceDeskIntegrationDto.md @@ -0,0 +1,366 @@ +--- +id: v2024-service-desk-integration-dto +title: ServiceDeskIntegrationDto +pagination_label: ServiceDeskIntegrationDto +sidebar_label: ServiceDeskIntegrationDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskIntegrationDto', 'V2024ServiceDeskIntegrationDto'] +slug: /tools/sdk/go/v2024/models/service-desk-integration-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationDto', 'V2024ServiceDeskIntegrationDto'] +--- + +# ServiceDeskIntegrationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the Service Desk integration | [optional] +**Name** | **string** | Service Desk integration's name. The name must be unique. | +**Created** | Pointer to **SailPointTime** | The date and time the Service Desk integration was created | [optional] +**Modified** | Pointer to **SailPointTime** | The date and time the Service Desk integration was last modified | [optional] +**Description** | **string** | Service Desk integration's description. | +**Type** | **string** | Service Desk integration types: - ServiceNowSDIM - ServiceNow | [default to "ServiceNowSDIM"] +**OwnerRef** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**ClusterRef** | Pointer to [**SourceClusterDto**](source-cluster-dto) | | [optional] +**Cluster** | Pointer to **NullableString** | Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). | [optional] +**ManagedSources** | Pointer to **[]string** | Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). | [optional] +**ProvisioningConfig** | Pointer to [**ProvisioningConfig**](provisioning-config) | | [optional] +**Attributes** | **map[string]interface{}** | Service Desk integration's attributes. Validation constraints enforced by the implementation. | +**BeforeProvisioningRule** | Pointer to [**BeforeProvisioningRuleDto**](before-provisioning-rule-dto) | | [optional] + +## Methods + +### NewServiceDeskIntegrationDto + +`func NewServiceDeskIntegrationDto(name string, description string, type_ string, attributes map[string]interface{}, ) *ServiceDeskIntegrationDto` + +NewServiceDeskIntegrationDto instantiates a new ServiceDeskIntegrationDto 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 + +### NewServiceDeskIntegrationDtoWithDefaults + +`func NewServiceDeskIntegrationDtoWithDefaults() *ServiceDeskIntegrationDto` + +NewServiceDeskIntegrationDtoWithDefaults instantiates a new ServiceDeskIntegrationDto 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 + +### GetId + +`func (o *ServiceDeskIntegrationDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServiceDeskIntegrationDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServiceDeskIntegrationDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServiceDeskIntegrationDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ServiceDeskIntegrationDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServiceDeskIntegrationDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServiceDeskIntegrationDto) SetName(v string)` + +SetName sets Name field to given value. + + +### GetCreated + +`func (o *ServiceDeskIntegrationDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ServiceDeskIntegrationDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ServiceDeskIntegrationDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ServiceDeskIntegrationDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *ServiceDeskIntegrationDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ServiceDeskIntegrationDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ServiceDeskIntegrationDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ServiceDeskIntegrationDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *ServiceDeskIntegrationDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ServiceDeskIntegrationDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ServiceDeskIntegrationDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetType + +`func (o *ServiceDeskIntegrationDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServiceDeskIntegrationDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServiceDeskIntegrationDto) SetType(v string)` + +SetType sets Type field to given value. + + +### GetOwnerRef + +`func (o *ServiceDeskIntegrationDto) GetOwnerRef() OwnerDto` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *ServiceDeskIntegrationDto) GetOwnerRefOk() (*OwnerDto, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *ServiceDeskIntegrationDto) SetOwnerRef(v OwnerDto)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *ServiceDeskIntegrationDto) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### GetClusterRef + +`func (o *ServiceDeskIntegrationDto) GetClusterRef() SourceClusterDto` + +GetClusterRef returns the ClusterRef field if non-nil, zero value otherwise. + +### GetClusterRefOk + +`func (o *ServiceDeskIntegrationDto) GetClusterRefOk() (*SourceClusterDto, bool)` + +GetClusterRefOk returns a tuple with the ClusterRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterRef + +`func (o *ServiceDeskIntegrationDto) SetClusterRef(v SourceClusterDto)` + +SetClusterRef sets ClusterRef field to given value. + +### HasClusterRef + +`func (o *ServiceDeskIntegrationDto) HasClusterRef() bool` + +HasClusterRef returns a boolean if a field has been set. + +### GetCluster + +`func (o *ServiceDeskIntegrationDto) GetCluster() string` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *ServiceDeskIntegrationDto) GetClusterOk() (*string, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *ServiceDeskIntegrationDto) SetCluster(v string)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *ServiceDeskIntegrationDto) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### SetClusterNil + +`func (o *ServiceDeskIntegrationDto) SetClusterNil(b bool)` + + SetClusterNil sets the value for Cluster to be an explicit nil + +### UnsetCluster +`func (o *ServiceDeskIntegrationDto) UnsetCluster()` + +UnsetCluster ensures that no value is present for Cluster, not even an explicit nil +### GetManagedSources + +`func (o *ServiceDeskIntegrationDto) GetManagedSources() []string` + +GetManagedSources returns the ManagedSources field if non-nil, zero value otherwise. + +### GetManagedSourcesOk + +`func (o *ServiceDeskIntegrationDto) GetManagedSourcesOk() (*[]string, bool)` + +GetManagedSourcesOk returns a tuple with the ManagedSources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagedSources + +`func (o *ServiceDeskIntegrationDto) SetManagedSources(v []string)` + +SetManagedSources sets ManagedSources field to given value. + +### HasManagedSources + +`func (o *ServiceDeskIntegrationDto) HasManagedSources() bool` + +HasManagedSources returns a boolean if a field has been set. + +### GetProvisioningConfig + +`func (o *ServiceDeskIntegrationDto) GetProvisioningConfig() ProvisioningConfig` + +GetProvisioningConfig returns the ProvisioningConfig field if non-nil, zero value otherwise. + +### GetProvisioningConfigOk + +`func (o *ServiceDeskIntegrationDto) GetProvisioningConfigOk() (*ProvisioningConfig, bool)` + +GetProvisioningConfigOk returns a tuple with the ProvisioningConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningConfig + +`func (o *ServiceDeskIntegrationDto) SetProvisioningConfig(v ProvisioningConfig)` + +SetProvisioningConfig sets ProvisioningConfig field to given value. + +### HasProvisioningConfig + +`func (o *ServiceDeskIntegrationDto) HasProvisioningConfig() bool` + +HasProvisioningConfig returns a boolean if a field has been set. + +### GetAttributes + +`func (o *ServiceDeskIntegrationDto) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ServiceDeskIntegrationDto) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ServiceDeskIntegrationDto) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetBeforeProvisioningRule + +`func (o *ServiceDeskIntegrationDto) GetBeforeProvisioningRule() BeforeProvisioningRuleDto` + +GetBeforeProvisioningRule returns the BeforeProvisioningRule field if non-nil, zero value otherwise. + +### GetBeforeProvisioningRuleOk + +`func (o *ServiceDeskIntegrationDto) GetBeforeProvisioningRuleOk() (*BeforeProvisioningRuleDto, bool)` + +GetBeforeProvisioningRuleOk returns a tuple with the BeforeProvisioningRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBeforeProvisioningRule + +`func (o *ServiceDeskIntegrationDto) SetBeforeProvisioningRule(v BeforeProvisioningRuleDto)` + +SetBeforeProvisioningRule sets BeforeProvisioningRule field to given value. + +### HasBeforeProvisioningRule + +`func (o *ServiceDeskIntegrationDto) HasBeforeProvisioningRule() bool` + +HasBeforeProvisioningRule returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ServiceDeskIntegrationTemplateDto.md b/docs/tools/sdk/go/Reference/V2024/Models/ServiceDeskIntegrationTemplateDto.md new file mode 100644 index 000000000..fe3f250f8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ServiceDeskIntegrationTemplateDto.md @@ -0,0 +1,210 @@ +--- +id: v2024-service-desk-integration-template-dto +title: ServiceDeskIntegrationTemplateDto +pagination_label: ServiceDeskIntegrationTemplateDto +sidebar_label: ServiceDeskIntegrationTemplateDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskIntegrationTemplateDto', 'V2024ServiceDeskIntegrationTemplateDto'] +slug: /tools/sdk/go/v2024/models/service-desk-integration-template-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateDto', 'V2024ServiceDeskIntegrationTemplateDto'] +--- + +# ServiceDeskIntegrationTemplateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Type** | **string** | The 'type' property specifies the type of the Service Desk integration template. | [default to "Web Service SDIM"] +**Attributes** | **map[string]interface{}** | The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. | +**ProvisioningConfig** | [**ProvisioningConfig**](provisioning-config) | | + +## Methods + +### NewServiceDeskIntegrationTemplateDto + +`func NewServiceDeskIntegrationTemplateDto(name NullableString, type_ string, attributes map[string]interface{}, provisioningConfig ProvisioningConfig, ) *ServiceDeskIntegrationTemplateDto` + +NewServiceDeskIntegrationTemplateDto instantiates a new ServiceDeskIntegrationTemplateDto 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 + +### NewServiceDeskIntegrationTemplateDtoWithDefaults + +`func NewServiceDeskIntegrationTemplateDtoWithDefaults() *ServiceDeskIntegrationTemplateDto` + +NewServiceDeskIntegrationTemplateDtoWithDefaults instantiates a new ServiceDeskIntegrationTemplateDto 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 + +### GetId + +`func (o *ServiceDeskIntegrationTemplateDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServiceDeskIntegrationTemplateDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServiceDeskIntegrationTemplateDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ServiceDeskIntegrationTemplateDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServiceDeskIntegrationTemplateDto) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *ServiceDeskIntegrationTemplateDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ServiceDeskIntegrationTemplateDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *ServiceDeskIntegrationTemplateDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ServiceDeskIntegrationTemplateDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ServiceDeskIntegrationTemplateDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *ServiceDeskIntegrationTemplateDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ServiceDeskIntegrationTemplateDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ServiceDeskIntegrationTemplateDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetType + +`func (o *ServiceDeskIntegrationTemplateDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServiceDeskIntegrationTemplateDto) SetType(v string)` + +SetType sets Type field to given value. + + +### GetAttributes + +`func (o *ServiceDeskIntegrationTemplateDto) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ServiceDeskIntegrationTemplateDto) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetProvisioningConfig + +`func (o *ServiceDeskIntegrationTemplateDto) GetProvisioningConfig() ProvisioningConfig` + +GetProvisioningConfig returns the ProvisioningConfig field if non-nil, zero value otherwise. + +### GetProvisioningConfigOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetProvisioningConfigOk() (*ProvisioningConfig, bool)` + +GetProvisioningConfigOk returns a tuple with the ProvisioningConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningConfig + +`func (o *ServiceDeskIntegrationTemplateDto) SetProvisioningConfig(v ProvisioningConfig)` + +SetProvisioningConfig sets ProvisioningConfig field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ServiceDeskIntegrationTemplateType.md b/docs/tools/sdk/go/Reference/V2024/Models/ServiceDeskIntegrationTemplateType.md new file mode 100644 index 000000000..2e8ffb190 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ServiceDeskIntegrationTemplateType.md @@ -0,0 +1,106 @@ +--- +id: v2024-service-desk-integration-template-type +title: ServiceDeskIntegrationTemplateType +pagination_label: ServiceDeskIntegrationTemplateType +sidebar_label: ServiceDeskIntegrationTemplateType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskIntegrationTemplateType', 'V2024ServiceDeskIntegrationTemplateType'] +slug: /tools/sdk/go/v2024/models/service-desk-integration-template-type +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateType', 'V2024ServiceDeskIntegrationTemplateType'] +--- + +# ServiceDeskIntegrationTemplateType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | This is the name of the type. | [optional] +**Type** | **string** | This is the type value for the type. | +**ScriptName** | **string** | This is the scriptName attribute value for the type. | + +## Methods + +### NewServiceDeskIntegrationTemplateType + +`func NewServiceDeskIntegrationTemplateType(type_ string, scriptName string, ) *ServiceDeskIntegrationTemplateType` + +NewServiceDeskIntegrationTemplateType instantiates a new ServiceDeskIntegrationTemplateType 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 + +### NewServiceDeskIntegrationTemplateTypeWithDefaults + +`func NewServiceDeskIntegrationTemplateTypeWithDefaults() *ServiceDeskIntegrationTemplateType` + +NewServiceDeskIntegrationTemplateTypeWithDefaults instantiates a new ServiceDeskIntegrationTemplateType 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 + +### GetName + +`func (o *ServiceDeskIntegrationTemplateType) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServiceDeskIntegrationTemplateType) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServiceDeskIntegrationTemplateType) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ServiceDeskIntegrationTemplateType) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *ServiceDeskIntegrationTemplateType) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServiceDeskIntegrationTemplateType) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServiceDeskIntegrationTemplateType) SetType(v string)` + +SetType sets Type field to given value. + + +### GetScriptName + +`func (o *ServiceDeskIntegrationTemplateType) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *ServiceDeskIntegrationTemplateType) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *ServiceDeskIntegrationTemplateType) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ServiceDeskSource.md b/docs/tools/sdk/go/Reference/V2024/Models/ServiceDeskSource.md new file mode 100644 index 000000000..f135fa9c9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ServiceDeskSource.md @@ -0,0 +1,116 @@ +--- +id: v2024-service-desk-source +title: ServiceDeskSource +pagination_label: ServiceDeskSource +sidebar_label: ServiceDeskSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskSource', 'V2024ServiceDeskSource'] +slug: /tools/sdk/go/v2024/models/service-desk-source +tags: ['SDK', 'Software Development Kit', 'ServiceDeskSource', 'V2024ServiceDeskSource'] +--- + +# ServiceDeskSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of source for service desk integration template. | [optional] +**Id** | Pointer to **string** | ID of source for service desk integration template. | [optional] +**Name** | Pointer to **string** | Human-readable name of source for service desk integration template. | [optional] + +## Methods + +### NewServiceDeskSource + +`func NewServiceDeskSource() *ServiceDeskSource` + +NewServiceDeskSource instantiates a new ServiceDeskSource 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 + +### NewServiceDeskSourceWithDefaults + +`func NewServiceDeskSourceWithDefaults() *ServiceDeskSource` + +NewServiceDeskSourceWithDefaults instantiates a new ServiceDeskSource 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 + +### GetType + +`func (o *ServiceDeskSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServiceDeskSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServiceDeskSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ServiceDeskSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ServiceDeskSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServiceDeskSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServiceDeskSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServiceDeskSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ServiceDeskSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServiceDeskSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServiceDeskSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ServiceDeskSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ServiceProviderConfiguration.md b/docs/tools/sdk/go/Reference/V2024/Models/ServiceProviderConfiguration.md new file mode 100644 index 000000000..4ff66b868 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ServiceProviderConfiguration.md @@ -0,0 +1,142 @@ +--- +id: v2024-service-provider-configuration +title: ServiceProviderConfiguration +pagination_label: ServiceProviderConfiguration +sidebar_label: ServiceProviderConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceProviderConfiguration', 'V2024ServiceProviderConfiguration'] +slug: /tools/sdk/go/v2024/models/service-provider-configuration +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfiguration', 'V2024ServiceProviderConfiguration'] +--- + +# ServiceProviderConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | This determines whether or not the SAML authentication flow is enabled for an org | [optional] [default to false] +**BypassIdp** | Pointer to **bool** | This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. | [optional] [default to false] +**SamlConfigurationValid** | Pointer to **bool** | This indicates whether or not the SAML configuration is valid. | [optional] [default to false] +**FederationProtocolDetails** | Pointer to [**[]ServiceProviderConfigurationFederationProtocolDetailsInner**](service-provider-configuration-federation-protocol-details-inner) | A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer's identity provider and a customer's SailPoint instance (i.e., the service provider). | [optional] + +## Methods + +### NewServiceProviderConfiguration + +`func NewServiceProviderConfiguration() *ServiceProviderConfiguration` + +NewServiceProviderConfiguration instantiates a new ServiceProviderConfiguration 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 + +### NewServiceProviderConfigurationWithDefaults + +`func NewServiceProviderConfigurationWithDefaults() *ServiceProviderConfiguration` + +NewServiceProviderConfigurationWithDefaults instantiates a new ServiceProviderConfiguration 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 + +### GetEnabled + +`func (o *ServiceProviderConfiguration) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ServiceProviderConfiguration) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ServiceProviderConfiguration) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ServiceProviderConfiguration) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetBypassIdp + +`func (o *ServiceProviderConfiguration) GetBypassIdp() bool` + +GetBypassIdp returns the BypassIdp field if non-nil, zero value otherwise. + +### GetBypassIdpOk + +`func (o *ServiceProviderConfiguration) GetBypassIdpOk() (*bool, bool)` + +GetBypassIdpOk returns a tuple with the BypassIdp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBypassIdp + +`func (o *ServiceProviderConfiguration) SetBypassIdp(v bool)` + +SetBypassIdp sets BypassIdp field to given value. + +### HasBypassIdp + +`func (o *ServiceProviderConfiguration) HasBypassIdp() bool` + +HasBypassIdp returns a boolean if a field has been set. + +### GetSamlConfigurationValid + +`func (o *ServiceProviderConfiguration) GetSamlConfigurationValid() bool` + +GetSamlConfigurationValid returns the SamlConfigurationValid field if non-nil, zero value otherwise. + +### GetSamlConfigurationValidOk + +`func (o *ServiceProviderConfiguration) GetSamlConfigurationValidOk() (*bool, bool)` + +GetSamlConfigurationValidOk returns a tuple with the SamlConfigurationValid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSamlConfigurationValid + +`func (o *ServiceProviderConfiguration) SetSamlConfigurationValid(v bool)` + +SetSamlConfigurationValid sets SamlConfigurationValid field to given value. + +### HasSamlConfigurationValid + +`func (o *ServiceProviderConfiguration) HasSamlConfigurationValid() bool` + +HasSamlConfigurationValid returns a boolean if a field has been set. + +### GetFederationProtocolDetails + +`func (o *ServiceProviderConfiguration) GetFederationProtocolDetails() []ServiceProviderConfigurationFederationProtocolDetailsInner` + +GetFederationProtocolDetails returns the FederationProtocolDetails field if non-nil, zero value otherwise. + +### GetFederationProtocolDetailsOk + +`func (o *ServiceProviderConfiguration) GetFederationProtocolDetailsOk() (*[]ServiceProviderConfigurationFederationProtocolDetailsInner, bool)` + +GetFederationProtocolDetailsOk returns a tuple with the FederationProtocolDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFederationProtocolDetails + +`func (o *ServiceProviderConfiguration) SetFederationProtocolDetails(v []ServiceProviderConfigurationFederationProtocolDetailsInner)` + +SetFederationProtocolDetails sets FederationProtocolDetails field to given value. + +### HasFederationProtocolDetails + +`func (o *ServiceProviderConfiguration) HasFederationProtocolDetails() bool` + +HasFederationProtocolDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/go/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md new file mode 100644 index 000000000..337a03f77 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -0,0 +1,470 @@ +--- +id: v2024-service-provider-configuration-federation-protocol-details-inner +title: ServiceProviderConfigurationFederationProtocolDetailsInner +pagination_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2024ServiceProviderConfigurationFederationProtocolDetailsInner'] +slug: /tools/sdk/go/v2024/models/service-provider-configuration-federation-protocol-details-inner +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2024ServiceProviderConfigurationFederationProtocolDetailsInner'] +--- + +# ServiceProviderConfigurationFederationProtocolDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | Pointer to **string** | Federation protocol role | [optional] +**EntityId** | Pointer to **string** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Binding** | Pointer to **string** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**AuthnContext** | Pointer to **string** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**LogoutUrl** | Pointer to **string** | The IDP logout URL. Used with IDP configurations. | [optional] +**IncludeAuthnContext** | Pointer to **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to false] +**NameId** | Pointer to **string** | The name id format to use. Used with IDP configurations. | [optional] +**JitConfiguration** | Pointer to [**JITConfiguration**](jit-configuration) | | [optional] +**Cert** | Pointer to **string** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**LoginUrlPost** | Pointer to **string** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**LoginUrlRedirect** | Pointer to **string** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**MappingAttribute** | **string** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | +**CertificateExpirationDate** | Pointer to **string** | The expiration date extracted from the certificate. | [optional] +**CertificateName** | Pointer to **string** | The name extracted from the certificate. | [optional] +**Alias** | Pointer to **string** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**CallbackUrl** | **string** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | +**LegacyAcsUrl** | Pointer to **string** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] + +## Methods + +### NewServiceProviderConfigurationFederationProtocolDetailsInner + +`func NewServiceProviderConfigurationFederationProtocolDetailsInner(mappingAttribute string, callbackUrl string, ) *ServiceProviderConfigurationFederationProtocolDetailsInner` + +NewServiceProviderConfigurationFederationProtocolDetailsInner instantiates a new ServiceProviderConfigurationFederationProtocolDetailsInner 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 + +### NewServiceProviderConfigurationFederationProtocolDetailsInnerWithDefaults + +`func NewServiceProviderConfigurationFederationProtocolDetailsInnerWithDefaults() *ServiceProviderConfigurationFederationProtocolDetailsInner` + +NewServiceProviderConfigurationFederationProtocolDetailsInnerWithDefaults instantiates a new ServiceProviderConfigurationFederationProtocolDetailsInner 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 + +### GetRole + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetRole() string` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetRoleOk() (*string, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetRole(v string)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetEntityId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetEntityId() string` + +GetEntityId returns the EntityId field if non-nil, zero value otherwise. + +### GetEntityIdOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetEntityIdOk() (*string, bool)` + +GetEntityIdOk returns a tuple with the EntityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntityId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetEntityId(v string)` + +SetEntityId sets EntityId field to given value. + +### HasEntityId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasEntityId() bool` + +HasEntityId returns a boolean if a field has been set. + +### GetBinding + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetBinding() string` + +GetBinding returns the Binding field if non-nil, zero value otherwise. + +### GetBindingOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetBindingOk() (*string, bool)` + +GetBindingOk returns a tuple with the Binding field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBinding + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetBinding(v string)` + +SetBinding sets Binding field to given value. + +### HasBinding + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasBinding() bool` + +HasBinding returns a boolean if a field has been set. + +### GetAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetAuthnContext() string` + +GetAuthnContext returns the AuthnContext field if non-nil, zero value otherwise. + +### GetAuthnContextOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetAuthnContextOk() (*string, bool)` + +GetAuthnContextOk returns a tuple with the AuthnContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetAuthnContext(v string)` + +SetAuthnContext sets AuthnContext field to given value. + +### HasAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasAuthnContext() bool` + +HasAuthnContext returns a boolean if a field has been set. + +### GetLogoutUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLogoutUrl() string` + +GetLogoutUrl returns the LogoutUrl field if non-nil, zero value otherwise. + +### GetLogoutUrlOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLogoutUrlOk() (*string, bool)` + +GetLogoutUrlOk returns a tuple with the LogoutUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogoutUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetLogoutUrl(v string)` + +SetLogoutUrl sets LogoutUrl field to given value. + +### HasLogoutUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasLogoutUrl() bool` + +HasLogoutUrl returns a boolean if a field has been set. + +### GetIncludeAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetIncludeAuthnContext() bool` + +GetIncludeAuthnContext returns the IncludeAuthnContext field if non-nil, zero value otherwise. + +### GetIncludeAuthnContextOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetIncludeAuthnContextOk() (*bool, bool)` + +GetIncludeAuthnContextOk returns a tuple with the IncludeAuthnContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetIncludeAuthnContext(v bool)` + +SetIncludeAuthnContext sets IncludeAuthnContext field to given value. + +### HasIncludeAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasIncludeAuthnContext() bool` + +HasIncludeAuthnContext returns a boolean if a field has been set. + +### GetNameId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetNameId() string` + +GetNameId returns the NameId field if non-nil, zero value otherwise. + +### GetNameIdOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetNameIdOk() (*string, bool)` + +GetNameIdOk returns a tuple with the NameId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNameId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetNameId(v string)` + +SetNameId sets NameId field to given value. + +### HasNameId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasNameId() bool` + +HasNameId returns a boolean if a field has been set. + +### GetJitConfiguration + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetJitConfiguration() JITConfiguration` + +GetJitConfiguration returns the JitConfiguration field if non-nil, zero value otherwise. + +### GetJitConfigurationOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetJitConfigurationOk() (*JITConfiguration, bool)` + +GetJitConfigurationOk returns a tuple with the JitConfiguration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJitConfiguration + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetJitConfiguration(v JITConfiguration)` + +SetJitConfiguration sets JitConfiguration field to given value. + +### HasJitConfiguration + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasJitConfiguration() bool` + +HasJitConfiguration returns a boolean if a field has been set. + +### GetCert + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCert() string` + +GetCert returns the Cert field if non-nil, zero value otherwise. + +### GetCertOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCertOk() (*string, bool)` + +GetCertOk returns a tuple with the Cert field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCert + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetCert(v string)` + +SetCert sets Cert field to given value. + +### HasCert + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasCert() bool` + +HasCert returns a boolean if a field has been set. + +### GetLoginUrlPost + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLoginUrlPost() string` + +GetLoginUrlPost returns the LoginUrlPost field if non-nil, zero value otherwise. + +### GetLoginUrlPostOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLoginUrlPostOk() (*string, bool)` + +GetLoginUrlPostOk returns a tuple with the LoginUrlPost field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginUrlPost + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetLoginUrlPost(v string)` + +SetLoginUrlPost sets LoginUrlPost field to given value. + +### HasLoginUrlPost + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasLoginUrlPost() bool` + +HasLoginUrlPost returns a boolean if a field has been set. + +### GetLoginUrlRedirect + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLoginUrlRedirect() string` + +GetLoginUrlRedirect returns the LoginUrlRedirect field if non-nil, zero value otherwise. + +### GetLoginUrlRedirectOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLoginUrlRedirectOk() (*string, bool)` + +GetLoginUrlRedirectOk returns a tuple with the LoginUrlRedirect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginUrlRedirect + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetLoginUrlRedirect(v string)` + +SetLoginUrlRedirect sets LoginUrlRedirect field to given value. + +### HasLoginUrlRedirect + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasLoginUrlRedirect() bool` + +HasLoginUrlRedirect returns a boolean if a field has been set. + +### GetMappingAttribute + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetMappingAttribute() string` + +GetMappingAttribute returns the MappingAttribute field if non-nil, zero value otherwise. + +### GetMappingAttributeOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetMappingAttributeOk() (*string, bool)` + +GetMappingAttributeOk returns a tuple with the MappingAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMappingAttribute + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetMappingAttribute(v string)` + +SetMappingAttribute sets MappingAttribute field to given value. + + +### GetCertificateExpirationDate + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCertificateExpirationDate() string` + +GetCertificateExpirationDate returns the CertificateExpirationDate field if non-nil, zero value otherwise. + +### GetCertificateExpirationDateOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCertificateExpirationDateOk() (*string, bool)` + +GetCertificateExpirationDateOk returns a tuple with the CertificateExpirationDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificateExpirationDate + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetCertificateExpirationDate(v string)` + +SetCertificateExpirationDate sets CertificateExpirationDate field to given value. + +### HasCertificateExpirationDate + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasCertificateExpirationDate() bool` + +HasCertificateExpirationDate returns a boolean if a field has been set. + +### GetCertificateName + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCertificateName() string` + +GetCertificateName returns the CertificateName field if non-nil, zero value otherwise. + +### GetCertificateNameOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCertificateNameOk() (*string, bool)` + +GetCertificateNameOk returns a tuple with the CertificateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificateName + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetCertificateName(v string)` + +SetCertificateName sets CertificateName field to given value. + +### HasCertificateName + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasCertificateName() bool` + +HasCertificateName returns a boolean if a field has been set. + +### GetAlias + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + +### GetCallbackUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCallbackUrl() string` + +GetCallbackUrl returns the CallbackUrl field if non-nil, zero value otherwise. + +### GetCallbackUrlOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCallbackUrlOk() (*string, bool)` + +GetCallbackUrlOk returns a tuple with the CallbackUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCallbackUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetCallbackUrl(v string)` + +SetCallbackUrl sets CallbackUrl field to given value. + + +### GetLegacyAcsUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLegacyAcsUrl() string` + +GetLegacyAcsUrl returns the LegacyAcsUrl field if non-nil, zero value otherwise. + +### GetLegacyAcsUrlOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLegacyAcsUrlOk() (*string, bool)` + +GetLegacyAcsUrlOk returns a tuple with the LegacyAcsUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyAcsUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetLegacyAcsUrl(v string)` + +SetLegacyAcsUrl sets LegacyAcsUrl field to given value. + +### HasLegacyAcsUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasLegacyAcsUrl() bool` + +HasLegacyAcsUrl returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SessionConfiguration.md b/docs/tools/sdk/go/Reference/V2024/Models/SessionConfiguration.md new file mode 100644 index 000000000..de7c991bd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SessionConfiguration.md @@ -0,0 +1,116 @@ +--- +id: v2024-session-configuration +title: SessionConfiguration +pagination_label: SessionConfiguration +sidebar_label: SessionConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SessionConfiguration', 'V2024SessionConfiguration'] +slug: /tools/sdk/go/v2024/models/session-configuration +tags: ['SDK', 'Software Development Kit', 'SessionConfiguration', 'V2024SessionConfiguration'] +--- + +# SessionConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxIdleTime** | Pointer to **int32** | The maximum time in minutes a session can be idle. | [optional] +**RememberMe** | Pointer to **bool** | Denotes if 'remember me' is enabled. | [optional] [default to false] +**MaxSessionTime** | Pointer to **int32** | The maximum allowable session time in minutes. | [optional] + +## Methods + +### NewSessionConfiguration + +`func NewSessionConfiguration() *SessionConfiguration` + +NewSessionConfiguration instantiates a new SessionConfiguration 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 + +### NewSessionConfigurationWithDefaults + +`func NewSessionConfigurationWithDefaults() *SessionConfiguration` + +NewSessionConfigurationWithDefaults instantiates a new SessionConfiguration 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 + +### GetMaxIdleTime + +`func (o *SessionConfiguration) GetMaxIdleTime() int32` + +GetMaxIdleTime returns the MaxIdleTime field if non-nil, zero value otherwise. + +### GetMaxIdleTimeOk + +`func (o *SessionConfiguration) GetMaxIdleTimeOk() (*int32, bool)` + +GetMaxIdleTimeOk returns a tuple with the MaxIdleTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxIdleTime + +`func (o *SessionConfiguration) SetMaxIdleTime(v int32)` + +SetMaxIdleTime sets MaxIdleTime field to given value. + +### HasMaxIdleTime + +`func (o *SessionConfiguration) HasMaxIdleTime() bool` + +HasMaxIdleTime returns a boolean if a field has been set. + +### GetRememberMe + +`func (o *SessionConfiguration) GetRememberMe() bool` + +GetRememberMe returns the RememberMe field if non-nil, zero value otherwise. + +### GetRememberMeOk + +`func (o *SessionConfiguration) GetRememberMeOk() (*bool, bool)` + +GetRememberMeOk returns a tuple with the RememberMe field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRememberMe + +`func (o *SessionConfiguration) SetRememberMe(v bool)` + +SetRememberMe sets RememberMe field to given value. + +### HasRememberMe + +`func (o *SessionConfiguration) HasRememberMe() bool` + +HasRememberMe returns a boolean if a field has been set. + +### GetMaxSessionTime + +`func (o *SessionConfiguration) GetMaxSessionTime() int32` + +GetMaxSessionTime returns the MaxSessionTime field if non-nil, zero value otherwise. + +### GetMaxSessionTimeOk + +`func (o *SessionConfiguration) GetMaxSessionTimeOk() (*int32, bool)` + +GetMaxSessionTimeOk returns a tuple with the MaxSessionTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxSessionTime + +`func (o *SessionConfiguration) SetMaxSessionTime(v int32)` + +SetMaxSessionTime sets MaxSessionTime field to given value. + +### HasMaxSessionTime + +`func (o *SessionConfiguration) HasMaxSessionTime() bool` + +HasMaxSessionTime returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SetIcon200Response.md b/docs/tools/sdk/go/Reference/V2024/Models/SetIcon200Response.md new file mode 100644 index 000000000..60e22f3d2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SetIcon200Response.md @@ -0,0 +1,64 @@ +--- +id: v2024-set-icon200-response +title: SetIcon200Response +pagination_label: SetIcon200Response +sidebar_label: SetIcon200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SetIcon200Response', 'V2024SetIcon200Response'] +slug: /tools/sdk/go/v2024/models/set-icon200-response +tags: ['SDK', 'Software Development Kit', 'SetIcon200Response', 'V2024SetIcon200Response'] +--- + +# SetIcon200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Icon** | Pointer to **string** | url to file with icon | [optional] + +## Methods + +### NewSetIcon200Response + +`func NewSetIcon200Response() *SetIcon200Response` + +NewSetIcon200Response instantiates a new SetIcon200Response 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 + +### NewSetIcon200ResponseWithDefaults + +`func NewSetIcon200ResponseWithDefaults() *SetIcon200Response` + +NewSetIcon200ResponseWithDefaults instantiates a new SetIcon200Response 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 + +### GetIcon + +`func (o *SetIcon200Response) GetIcon() string` + +GetIcon returns the Icon field if non-nil, zero value otherwise. + +### GetIconOk + +`func (o *SetIcon200Response) GetIconOk() (*string, bool)` + +GetIconOk returns a tuple with the Icon field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIcon + +`func (o *SetIcon200Response) SetIcon(v string)` + +SetIcon sets Icon field to given value. + +### HasIcon + +`func (o *SetIcon200Response) HasIcon() bool` + +HasIcon returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SetIconRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/SetIconRequest.md new file mode 100644 index 000000000..e830eeea2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SetIconRequest.md @@ -0,0 +1,59 @@ +--- +id: v2024-set-icon-request +title: SetIconRequest +pagination_label: SetIconRequest +sidebar_label: SetIconRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SetIconRequest', 'V2024SetIconRequest'] +slug: /tools/sdk/go/v2024/models/set-icon-request +tags: ['SDK', 'Software Development Kit', 'SetIconRequest', 'V2024SetIconRequest'] +--- + +# SetIconRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Image** | ***os.File** | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] | + +## Methods + +### NewSetIconRequest + +`func NewSetIconRequest(image *os.File, ) *SetIconRequest` + +NewSetIconRequest instantiates a new SetIconRequest 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 + +### NewSetIconRequestWithDefaults + +`func NewSetIconRequestWithDefaults() *SetIconRequest` + +NewSetIconRequestWithDefaults instantiates a new SetIconRequest 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 + +### GetImage + +`func (o *SetIconRequest) GetImage() *os.File` + +GetImage returns the Image field if non-nil, zero value otherwise. + +### GetImageOk + +`func (o *SetIconRequest) GetImageOk() (**os.File, bool)` + +GetImageOk returns a tuple with the Image field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImage + +`func (o *SetIconRequest) SetImage(v *os.File)` + +SetImage sets Image field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SetLifecycleState200Response.md b/docs/tools/sdk/go/Reference/V2024/Models/SetLifecycleState200Response.md new file mode 100644 index 000000000..272e02a39 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SetLifecycleState200Response.md @@ -0,0 +1,64 @@ +--- +id: v2024-set-lifecycle-state200-response +title: SetLifecycleState200Response +pagination_label: SetLifecycleState200Response +sidebar_label: SetLifecycleState200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SetLifecycleState200Response', 'V2024SetLifecycleState200Response'] +slug: /tools/sdk/go/v2024/models/set-lifecycle-state200-response +tags: ['SDK', 'Software Development Kit', 'SetLifecycleState200Response', 'V2024SetLifecycleState200Response'] +--- + +# SetLifecycleState200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountActivityId** | Pointer to **string** | ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/v3/get-account-activity/). The response will contain relevant information about the IdentityRequest, such as its status. | [optional] + +## Methods + +### NewSetLifecycleState200Response + +`func NewSetLifecycleState200Response() *SetLifecycleState200Response` + +NewSetLifecycleState200Response instantiates a new SetLifecycleState200Response 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 + +### NewSetLifecycleState200ResponseWithDefaults + +`func NewSetLifecycleState200ResponseWithDefaults() *SetLifecycleState200Response` + +NewSetLifecycleState200ResponseWithDefaults instantiates a new SetLifecycleState200Response 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 + +### GetAccountActivityId + +`func (o *SetLifecycleState200Response) GetAccountActivityId() string` + +GetAccountActivityId returns the AccountActivityId field if non-nil, zero value otherwise. + +### GetAccountActivityIdOk + +`func (o *SetLifecycleState200Response) GetAccountActivityIdOk() (*string, bool)` + +GetAccountActivityIdOk returns a tuple with the AccountActivityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActivityId + +`func (o *SetLifecycleState200Response) SetAccountActivityId(v string)` + +SetAccountActivityId sets AccountActivityId field to given value. + +### HasAccountActivityId + +`func (o *SetLifecycleState200Response) HasAccountActivityId() bool` + +HasAccountActivityId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SetLifecycleStateRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/SetLifecycleStateRequest.md new file mode 100644 index 000000000..b3d3f9004 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SetLifecycleStateRequest.md @@ -0,0 +1,64 @@ +--- +id: v2024-set-lifecycle-state-request +title: SetLifecycleStateRequest +pagination_label: SetLifecycleStateRequest +sidebar_label: SetLifecycleStateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SetLifecycleStateRequest', 'V2024SetLifecycleStateRequest'] +slug: /tools/sdk/go/v2024/models/set-lifecycle-state-request +tags: ['SDK', 'Software Development Kit', 'SetLifecycleStateRequest', 'V2024SetLifecycleStateRequest'] +--- + +# SetLifecycleStateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LifecycleStateId** | Pointer to **string** | ID of the lifecycle state to set. | [optional] + +## Methods + +### NewSetLifecycleStateRequest + +`func NewSetLifecycleStateRequest() *SetLifecycleStateRequest` + +NewSetLifecycleStateRequest instantiates a new SetLifecycleStateRequest 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 + +### NewSetLifecycleStateRequestWithDefaults + +`func NewSetLifecycleStateRequestWithDefaults() *SetLifecycleStateRequest` + +NewSetLifecycleStateRequestWithDefaults instantiates a new SetLifecycleStateRequest 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 + +### GetLifecycleStateId + +`func (o *SetLifecycleStateRequest) GetLifecycleStateId() string` + +GetLifecycleStateId returns the LifecycleStateId field if non-nil, zero value otherwise. + +### GetLifecycleStateIdOk + +`func (o *SetLifecycleStateRequest) GetLifecycleStateIdOk() (*string, bool)` + +GetLifecycleStateIdOk returns a tuple with the LifecycleStateId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLifecycleStateId + +`func (o *SetLifecycleStateRequest) SetLifecycleStateId(v string)` + +SetLifecycleStateId sets LifecycleStateId field to given value. + +### HasLifecycleStateId + +`func (o *SetLifecycleStateRequest) HasLifecycleStateId() bool` + +HasLifecycleStateId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SimIntegrationDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/SimIntegrationDetails.md new file mode 100644 index 000000000..e9b89411a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SimIntegrationDetails.md @@ -0,0 +1,365 @@ +--- +id: v2024-sim-integration-details +title: SimIntegrationDetails +pagination_label: SimIntegrationDetails +sidebar_label: SimIntegrationDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SimIntegrationDetails', 'V2024SimIntegrationDetails'] +slug: /tools/sdk/go/v2024/models/sim-integration-details +tags: ['SDK', 'Software Development Kit', 'SimIntegrationDetails', 'V2024SimIntegrationDetails'] +--- + +# SimIntegrationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Description** | Pointer to **string** | The description of the integration | [optional] +**Type** | Pointer to **string** | The integration type | [optional] +**Attributes** | Pointer to **map[string]interface{}** | The attributes map containing the credentials used to configure the integration. | [optional] +**Sources** | Pointer to **[]string** | The list of sources (managed resources) | [optional] +**Cluster** | Pointer to **string** | The cluster/proxy | [optional] +**StatusMap** | Pointer to **map[string]interface{}** | Custom mapping between the integration result and the provisioning result | [optional] +**Request** | Pointer to **map[string]interface{}** | Request data to customize desc and body of the created ticket | [optional] +**BeforeProvisioningRule** | Pointer to [**SimIntegrationDetailsAllOfBeforeProvisioningRule**](sim-integration-details-all-of-before-provisioning-rule) | | [optional] + +## Methods + +### NewSimIntegrationDetails + +`func NewSimIntegrationDetails(name NullableString, ) *SimIntegrationDetails` + +NewSimIntegrationDetails instantiates a new SimIntegrationDetails 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 + +### NewSimIntegrationDetailsWithDefaults + +`func NewSimIntegrationDetailsWithDefaults() *SimIntegrationDetails` + +NewSimIntegrationDetailsWithDefaults instantiates a new SimIntegrationDetails 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 + +### GetId + +`func (o *SimIntegrationDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SimIntegrationDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SimIntegrationDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SimIntegrationDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SimIntegrationDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SimIntegrationDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SimIntegrationDetails) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *SimIntegrationDetails) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *SimIntegrationDetails) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *SimIntegrationDetails) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SimIntegrationDetails) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SimIntegrationDetails) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SimIntegrationDetails) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SimIntegrationDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SimIntegrationDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SimIntegrationDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SimIntegrationDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *SimIntegrationDetails) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SimIntegrationDetails) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SimIntegrationDetails) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SimIntegrationDetails) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetType + +`func (o *SimIntegrationDetails) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SimIntegrationDetails) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SimIntegrationDetails) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SimIntegrationDetails) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetAttributes + +`func (o *SimIntegrationDetails) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *SimIntegrationDetails) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *SimIntegrationDetails) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *SimIntegrationDetails) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *SimIntegrationDetails) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *SimIntegrationDetails) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetSources + +`func (o *SimIntegrationDetails) GetSources() []string` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *SimIntegrationDetails) GetSourcesOk() (*[]string, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *SimIntegrationDetails) SetSources(v []string)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *SimIntegrationDetails) HasSources() bool` + +HasSources returns a boolean if a field has been set. + +### GetCluster + +`func (o *SimIntegrationDetails) GetCluster() string` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *SimIntegrationDetails) GetClusterOk() (*string, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *SimIntegrationDetails) SetCluster(v string)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *SimIntegrationDetails) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### GetStatusMap + +`func (o *SimIntegrationDetails) GetStatusMap() map[string]interface{}` + +GetStatusMap returns the StatusMap field if non-nil, zero value otherwise. + +### GetStatusMapOk + +`func (o *SimIntegrationDetails) GetStatusMapOk() (*map[string]interface{}, bool)` + +GetStatusMapOk returns a tuple with the StatusMap field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusMap + +`func (o *SimIntegrationDetails) SetStatusMap(v map[string]interface{})` + +SetStatusMap sets StatusMap field to given value. + +### HasStatusMap + +`func (o *SimIntegrationDetails) HasStatusMap() bool` + +HasStatusMap returns a boolean if a field has been set. + +### GetRequest + +`func (o *SimIntegrationDetails) GetRequest() map[string]interface{}` + +GetRequest returns the Request field if non-nil, zero value otherwise. + +### GetRequestOk + +`func (o *SimIntegrationDetails) GetRequestOk() (*map[string]interface{}, bool)` + +GetRequestOk returns a tuple with the Request field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequest + +`func (o *SimIntegrationDetails) SetRequest(v map[string]interface{})` + +SetRequest sets Request field to given value. + +### HasRequest + +`func (o *SimIntegrationDetails) HasRequest() bool` + +HasRequest returns a boolean if a field has been set. + +### GetBeforeProvisioningRule + +`func (o *SimIntegrationDetails) GetBeforeProvisioningRule() SimIntegrationDetailsAllOfBeforeProvisioningRule` + +GetBeforeProvisioningRule returns the BeforeProvisioningRule field if non-nil, zero value otherwise. + +### GetBeforeProvisioningRuleOk + +`func (o *SimIntegrationDetails) GetBeforeProvisioningRuleOk() (*SimIntegrationDetailsAllOfBeforeProvisioningRule, bool)` + +GetBeforeProvisioningRuleOk returns a tuple with the BeforeProvisioningRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBeforeProvisioningRule + +`func (o *SimIntegrationDetails) SetBeforeProvisioningRule(v SimIntegrationDetailsAllOfBeforeProvisioningRule)` + +SetBeforeProvisioningRule sets BeforeProvisioningRule field to given value. + +### HasBeforeProvisioningRule + +`func (o *SimIntegrationDetails) HasBeforeProvisioningRule() bool` + +HasBeforeProvisioningRule returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md b/docs/tools/sdk/go/Reference/V2024/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md new file mode 100644 index 000000000..a2f6bd07a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md @@ -0,0 +1,116 @@ +--- +id: v2024-sim-integration-details-all-of-before-provisioning-rule +title: SimIntegrationDetailsAllOfBeforeProvisioningRule +pagination_label: SimIntegrationDetailsAllOfBeforeProvisioningRule +sidebar_label: SimIntegrationDetailsAllOfBeforeProvisioningRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SimIntegrationDetailsAllOfBeforeProvisioningRule', 'V2024SimIntegrationDetailsAllOfBeforeProvisioningRule'] +slug: /tools/sdk/go/v2024/models/sim-integration-details-all-of-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'SimIntegrationDetailsAllOfBeforeProvisioningRule', 'V2024SimIntegrationDetailsAllOfBeforeProvisioningRule'] +--- + +# SimIntegrationDetailsAllOfBeforeProvisioningRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | ID of the rule | [optional] +**Name** | Pointer to **string** | Human-readable display name of the rule | [optional] + +## Methods + +### NewSimIntegrationDetailsAllOfBeforeProvisioningRule + +`func NewSimIntegrationDetailsAllOfBeforeProvisioningRule() *SimIntegrationDetailsAllOfBeforeProvisioningRule` + +NewSimIntegrationDetailsAllOfBeforeProvisioningRule instantiates a new SimIntegrationDetailsAllOfBeforeProvisioningRule 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 + +### NewSimIntegrationDetailsAllOfBeforeProvisioningRuleWithDefaults + +`func NewSimIntegrationDetailsAllOfBeforeProvisioningRuleWithDefaults() *SimIntegrationDetailsAllOfBeforeProvisioningRule` + +NewSimIntegrationDetailsAllOfBeforeProvisioningRuleWithDefaults instantiates a new SimIntegrationDetailsAllOfBeforeProvisioningRule 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 + +### GetType + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SlimCampaign.md b/docs/tools/sdk/go/Reference/V2024/Models/SlimCampaign.md new file mode 100644 index 000000000..dd3bac9a4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SlimCampaign.md @@ -0,0 +1,467 @@ +--- +id: v2024-slim-campaign +title: SlimCampaign +pagination_label: SlimCampaign +sidebar_label: SlimCampaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SlimCampaign', 'V2024SlimCampaign'] +slug: /tools/sdk/go/v2024/models/slim-campaign +tags: ['SDK', 'Software Development Kit', 'SlimCampaign', 'V2024SlimCampaign'] +--- + +# SlimCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | Id of the campaign | [optional] [readonly] +**Name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Description** | **NullableString** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Deadline** | Pointer to **NullableTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **string** | The type of campaign. Could be extended in the future. | +**EmailNotificationEnabled** | Pointer to **bool** | Enables email notification for this campaign | [optional] [default to false] +**AutoRevokeAllowed** | Pointer to **bool** | Allows auto revoke for this campaign | [optional] [default to false] +**RecommendationsEnabled** | Pointer to **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to false] +**Status** | Pointer to **NullableString** | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **NullableTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **NullableInt32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **NullableInt32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] + +## Methods + +### NewSlimCampaign + +`func NewSlimCampaign(name string, description NullableString, type_ string, ) *SlimCampaign` + +NewSlimCampaign instantiates a new SlimCampaign 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 + +### NewSlimCampaignWithDefaults + +`func NewSlimCampaignWithDefaults() *SlimCampaign` + +NewSlimCampaignWithDefaults instantiates a new SlimCampaign 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 + +### GetId + +`func (o *SlimCampaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SlimCampaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SlimCampaign) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SlimCampaign) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *SlimCampaign) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *SlimCampaign) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *SlimCampaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SlimCampaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SlimCampaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *SlimCampaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SlimCampaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SlimCampaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *SlimCampaign) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *SlimCampaign) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetDeadline + +`func (o *SlimCampaign) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *SlimCampaign) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *SlimCampaign) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *SlimCampaign) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### SetDeadlineNil + +`func (o *SlimCampaign) SetDeadlineNil(b bool)` + + SetDeadlineNil sets the value for Deadline to be an explicit nil + +### UnsetDeadline +`func (o *SlimCampaign) UnsetDeadline()` + +UnsetDeadline ensures that no value is present for Deadline, not even an explicit nil +### GetType + +`func (o *SlimCampaign) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SlimCampaign) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SlimCampaign) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEmailNotificationEnabled + +`func (o *SlimCampaign) GetEmailNotificationEnabled() bool` + +GetEmailNotificationEnabled returns the EmailNotificationEnabled field if non-nil, zero value otherwise. + +### GetEmailNotificationEnabledOk + +`func (o *SlimCampaign) GetEmailNotificationEnabledOk() (*bool, bool)` + +GetEmailNotificationEnabledOk returns a tuple with the EmailNotificationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationEnabled + +`func (o *SlimCampaign) SetEmailNotificationEnabled(v bool)` + +SetEmailNotificationEnabled sets EmailNotificationEnabled field to given value. + +### HasEmailNotificationEnabled + +`func (o *SlimCampaign) HasEmailNotificationEnabled() bool` + +HasEmailNotificationEnabled returns a boolean if a field has been set. + +### GetAutoRevokeAllowed + +`func (o *SlimCampaign) GetAutoRevokeAllowed() bool` + +GetAutoRevokeAllowed returns the AutoRevokeAllowed field if non-nil, zero value otherwise. + +### GetAutoRevokeAllowedOk + +`func (o *SlimCampaign) GetAutoRevokeAllowedOk() (*bool, bool)` + +GetAutoRevokeAllowedOk returns a tuple with the AutoRevokeAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoRevokeAllowed + +`func (o *SlimCampaign) SetAutoRevokeAllowed(v bool)` + +SetAutoRevokeAllowed sets AutoRevokeAllowed field to given value. + +### HasAutoRevokeAllowed + +`func (o *SlimCampaign) HasAutoRevokeAllowed() bool` + +HasAutoRevokeAllowed returns a boolean if a field has been set. + +### GetRecommendationsEnabled + +`func (o *SlimCampaign) GetRecommendationsEnabled() bool` + +GetRecommendationsEnabled returns the RecommendationsEnabled field if non-nil, zero value otherwise. + +### GetRecommendationsEnabledOk + +`func (o *SlimCampaign) GetRecommendationsEnabledOk() (*bool, bool)` + +GetRecommendationsEnabledOk returns a tuple with the RecommendationsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendationsEnabled + +`func (o *SlimCampaign) SetRecommendationsEnabled(v bool)` + +SetRecommendationsEnabled sets RecommendationsEnabled field to given value. + +### HasRecommendationsEnabled + +`func (o *SlimCampaign) HasRecommendationsEnabled() bool` + +HasRecommendationsEnabled returns a boolean if a field has been set. + +### GetStatus + +`func (o *SlimCampaign) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SlimCampaign) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SlimCampaign) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SlimCampaign) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatusNil + +`func (o *SlimCampaign) SetStatusNil(b bool)` + + SetStatusNil sets the value for Status to be an explicit nil + +### UnsetStatus +`func (o *SlimCampaign) UnsetStatus()` + +UnsetStatus ensures that no value is present for Status, not even an explicit nil +### GetCorrelatedStatus + +`func (o *SlimCampaign) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *SlimCampaign) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *SlimCampaign) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + +### HasCorrelatedStatus + +`func (o *SlimCampaign) HasCorrelatedStatus() bool` + +HasCorrelatedStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *SlimCampaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SlimCampaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SlimCampaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SlimCampaign) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *SlimCampaign) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *SlimCampaign) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetTotalCertifications + +`func (o *SlimCampaign) GetTotalCertifications() int32` + +GetTotalCertifications returns the TotalCertifications field if non-nil, zero value otherwise. + +### GetTotalCertificationsOk + +`func (o *SlimCampaign) GetTotalCertificationsOk() (*int32, bool)` + +GetTotalCertificationsOk returns a tuple with the TotalCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCertifications + +`func (o *SlimCampaign) SetTotalCertifications(v int32)` + +SetTotalCertifications sets TotalCertifications field to given value. + +### HasTotalCertifications + +`func (o *SlimCampaign) HasTotalCertifications() bool` + +HasTotalCertifications returns a boolean if a field has been set. + +### SetTotalCertificationsNil + +`func (o *SlimCampaign) SetTotalCertificationsNil(b bool)` + + SetTotalCertificationsNil sets the value for TotalCertifications to be an explicit nil + +### UnsetTotalCertifications +`func (o *SlimCampaign) UnsetTotalCertifications()` + +UnsetTotalCertifications ensures that no value is present for TotalCertifications, not even an explicit nil +### GetCompletedCertifications + +`func (o *SlimCampaign) GetCompletedCertifications() int32` + +GetCompletedCertifications returns the CompletedCertifications field if non-nil, zero value otherwise. + +### GetCompletedCertificationsOk + +`func (o *SlimCampaign) GetCompletedCertificationsOk() (*int32, bool)` + +GetCompletedCertificationsOk returns a tuple with the CompletedCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedCertifications + +`func (o *SlimCampaign) SetCompletedCertifications(v int32)` + +SetCompletedCertifications sets CompletedCertifications field to given value. + +### HasCompletedCertifications + +`func (o *SlimCampaign) HasCompletedCertifications() bool` + +HasCompletedCertifications returns a boolean if a field has been set. + +### SetCompletedCertificationsNil + +`func (o *SlimCampaign) SetCompletedCertificationsNil(b bool)` + + SetCompletedCertificationsNil sets the value for CompletedCertifications to be an explicit nil + +### UnsetCompletedCertifications +`func (o *SlimCampaign) UnsetCompletedCertifications()` + +UnsetCompletedCertifications ensures that no value is present for CompletedCertifications, not even an explicit nil +### GetAlerts + +`func (o *SlimCampaign) GetAlerts() []CampaignAlert` + +GetAlerts returns the Alerts field if non-nil, zero value otherwise. + +### GetAlertsOk + +`func (o *SlimCampaign) GetAlertsOk() (*[]CampaignAlert, bool)` + +GetAlertsOk returns a tuple with the Alerts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlerts + +`func (o *SlimCampaign) SetAlerts(v []CampaignAlert)` + +SetAlerts sets Alerts field to given value. + +### HasAlerts + +`func (o *SlimCampaign) HasAlerts() bool` + +HasAlerts returns a boolean if a field has been set. + +### SetAlertsNil + +`func (o *SlimCampaign) SetAlertsNil(b bool)` + + SetAlertsNil sets the value for Alerts to be an explicit nil + +### UnsetAlerts +`func (o *SlimCampaign) UnsetAlerts()` + +UnsetAlerts ensures that no value is present for Alerts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SlimDiscoveredApplications.md b/docs/tools/sdk/go/Reference/V2024/Models/SlimDiscoveredApplications.md new file mode 100644 index 000000000..219390cc8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SlimDiscoveredApplications.md @@ -0,0 +1,272 @@ +--- +id: v2024-slim-discovered-applications +title: SlimDiscoveredApplications +pagination_label: SlimDiscoveredApplications +sidebar_label: SlimDiscoveredApplications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SlimDiscoveredApplications', 'V2024SlimDiscoveredApplications'] +slug: /tools/sdk/go/v2024/models/slim-discovered-applications +tags: ['SDK', 'Software Development Kit', 'SlimDiscoveredApplications', 'V2024SlimDiscoveredApplications'] +--- + +# SlimDiscoveredApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **string** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **string** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **string** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **string** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]string** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **SailPointTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **string** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [optional] + +## Methods + +### NewSlimDiscoveredApplications + +`func NewSlimDiscoveredApplications() *SlimDiscoveredApplications` + +NewSlimDiscoveredApplications instantiates a new SlimDiscoveredApplications 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 + +### NewSlimDiscoveredApplicationsWithDefaults + +`func NewSlimDiscoveredApplicationsWithDefaults() *SlimDiscoveredApplications` + +NewSlimDiscoveredApplicationsWithDefaults instantiates a new SlimDiscoveredApplications 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 + +### GetId + +`func (o *SlimDiscoveredApplications) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SlimDiscoveredApplications) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SlimDiscoveredApplications) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SlimDiscoveredApplications) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SlimDiscoveredApplications) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SlimDiscoveredApplications) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SlimDiscoveredApplications) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SlimDiscoveredApplications) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDiscoverySource + +`func (o *SlimDiscoveredApplications) GetDiscoverySource() string` + +GetDiscoverySource returns the DiscoverySource field if non-nil, zero value otherwise. + +### GetDiscoverySourceOk + +`func (o *SlimDiscoveredApplications) GetDiscoverySourceOk() (*string, bool)` + +GetDiscoverySourceOk returns a tuple with the DiscoverySource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoverySource + +`func (o *SlimDiscoveredApplications) SetDiscoverySource(v string)` + +SetDiscoverySource sets DiscoverySource field to given value. + +### HasDiscoverySource + +`func (o *SlimDiscoveredApplications) HasDiscoverySource() bool` + +HasDiscoverySource returns a boolean if a field has been set. + +### GetDiscoveredVendor + +`func (o *SlimDiscoveredApplications) GetDiscoveredVendor() string` + +GetDiscoveredVendor returns the DiscoveredVendor field if non-nil, zero value otherwise. + +### GetDiscoveredVendorOk + +`func (o *SlimDiscoveredApplications) GetDiscoveredVendorOk() (*string, bool)` + +GetDiscoveredVendorOk returns a tuple with the DiscoveredVendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredVendor + +`func (o *SlimDiscoveredApplications) SetDiscoveredVendor(v string)` + +SetDiscoveredVendor sets DiscoveredVendor field to given value. + +### HasDiscoveredVendor + +`func (o *SlimDiscoveredApplications) HasDiscoveredVendor() bool` + +HasDiscoveredVendor returns a boolean if a field has been set. + +### GetDescription + +`func (o *SlimDiscoveredApplications) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SlimDiscoveredApplications) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SlimDiscoveredApplications) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SlimDiscoveredApplications) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetRecommendedConnectors + +`func (o *SlimDiscoveredApplications) GetRecommendedConnectors() []string` + +GetRecommendedConnectors returns the RecommendedConnectors field if non-nil, zero value otherwise. + +### GetRecommendedConnectorsOk + +`func (o *SlimDiscoveredApplications) GetRecommendedConnectorsOk() (*[]string, bool)` + +GetRecommendedConnectorsOk returns a tuple with the RecommendedConnectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendedConnectors + +`func (o *SlimDiscoveredApplications) SetRecommendedConnectors(v []string)` + +SetRecommendedConnectors sets RecommendedConnectors field to given value. + +### HasRecommendedConnectors + +`func (o *SlimDiscoveredApplications) HasRecommendedConnectors() bool` + +HasRecommendedConnectors returns a boolean if a field has been set. + +### GetDiscoveredAt + +`func (o *SlimDiscoveredApplications) GetDiscoveredAt() SailPointTime` + +GetDiscoveredAt returns the DiscoveredAt field if non-nil, zero value otherwise. + +### GetDiscoveredAtOk + +`func (o *SlimDiscoveredApplications) GetDiscoveredAtOk() (*SailPointTime, bool)` + +GetDiscoveredAtOk returns a tuple with the DiscoveredAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredAt + +`func (o *SlimDiscoveredApplications) SetDiscoveredAt(v SailPointTime)` + +SetDiscoveredAt sets DiscoveredAt field to given value. + +### HasDiscoveredAt + +`func (o *SlimDiscoveredApplications) HasDiscoveredAt() bool` + +HasDiscoveredAt returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *SlimDiscoveredApplications) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *SlimDiscoveredApplications) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *SlimDiscoveredApplications) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *SlimDiscoveredApplications) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetStatus + +`func (o *SlimDiscoveredApplications) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SlimDiscoveredApplications) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SlimDiscoveredApplications) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SlimDiscoveredApplications) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SodExemptCriteria.md b/docs/tools/sdk/go/Reference/V2024/Models/SodExemptCriteria.md new file mode 100644 index 000000000..a9ecaae84 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SodExemptCriteria.md @@ -0,0 +1,142 @@ +--- +id: v2024-sod-exempt-criteria +title: SodExemptCriteria +pagination_label: SodExemptCriteria +sidebar_label: SodExemptCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodExemptCriteria', 'V2024SodExemptCriteria'] +slug: /tools/sdk/go/v2024/models/sod-exempt-criteria +tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria', 'V2024SodExemptCriteria'] +--- + +# SodExemptCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Existing** | Pointer to **bool** | If the entitlement already belonged to the user or not. | [optional] [default to false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | Entitlement ID | [optional] +**Name** | Pointer to **string** | Entitlement name | [optional] + +## Methods + +### NewSodExemptCriteria + +`func NewSodExemptCriteria() *SodExemptCriteria` + +NewSodExemptCriteria instantiates a new SodExemptCriteria 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 + +### NewSodExemptCriteriaWithDefaults + +`func NewSodExemptCriteriaWithDefaults() *SodExemptCriteria` + +NewSodExemptCriteriaWithDefaults instantiates a new SodExemptCriteria 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 + +### GetExisting + +`func (o *SodExemptCriteria) GetExisting() bool` + +GetExisting returns the Existing field if non-nil, zero value otherwise. + +### GetExistingOk + +`func (o *SodExemptCriteria) GetExistingOk() (*bool, bool)` + +GetExistingOk returns a tuple with the Existing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExisting + +`func (o *SodExemptCriteria) SetExisting(v bool)` + +SetExisting sets Existing field to given value. + +### HasExisting + +`func (o *SodExemptCriteria) HasExisting() bool` + +HasExisting returns a boolean if a field has been set. + +### GetType + +`func (o *SodExemptCriteria) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodExemptCriteria) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodExemptCriteria) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodExemptCriteria) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodExemptCriteria) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodExemptCriteria) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodExemptCriteria) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodExemptCriteria) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodExemptCriteria) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodExemptCriteria) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodExemptCriteria) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodExemptCriteria) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SodPolicy.md b/docs/tools/sdk/go/Reference/V2024/Models/SodPolicy.md new file mode 100644 index 000000000..6a801cef9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SodPolicy.md @@ -0,0 +1,556 @@ +--- +id: v2024-sod-policy +title: SodPolicy +pagination_label: SodPolicy +sidebar_label: SodPolicy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicy', 'V2024SodPolicy'] +slug: /tools/sdk/go/v2024/models/sod-policy +tags: ['SDK', 'Software Development Kit', 'SodPolicy', 'V2024SodPolicy'] +--- + +# SodPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Policy id | [optional] [readonly] +**Name** | Pointer to **string** | Policy Business Name | [optional] +**Created** | Pointer to **SailPointTime** | The time when this SOD policy is created. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | The time when this SOD policy is modified. | [optional] [readonly] +**Description** | Pointer to **NullableString** | Optional description of the SOD policy | [optional] +**OwnerRef** | Pointer to [**SodPolicyOwnerRef**](sod-policy-owner-ref) | | [optional] +**ExternalPolicyReference** | Pointer to **NullableString** | Optional External Policy Reference | [optional] +**PolicyQuery** | Pointer to **string** | Search query of the SOD policy | [optional] +**CompensatingControls** | Pointer to **NullableString** | Optional compensating controls(Mitigating Controls) | [optional] +**CorrectionAdvice** | Pointer to **NullableString** | Optional correction advice | [optional] +**State** | Pointer to **string** | whether the policy is enforced or not | [optional] +**Tags** | Pointer to **[]string** | tags for this policy object | [optional] +**CreatorId** | Pointer to **string** | Policy's creator ID | [optional] [readonly] +**ModifierId** | Pointer to **NullableString** | Policy's modifier ID | [optional] [readonly] +**ViolationOwnerAssignmentConfig** | Pointer to [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional] +**Scheduled** | Pointer to **bool** | defines whether a policy has been scheduled or not | [optional] [default to false] +**Type** | Pointer to **string** | whether a policy is query based or conflicting access based | [optional] [default to "GENERAL"] +**ConflictingAccessCriteria** | Pointer to [**SodPolicyConflictingAccessCriteria**](sod-policy-conflicting-access-criteria) | | [optional] + +## Methods + +### NewSodPolicy + +`func NewSodPolicy() *SodPolicy` + +NewSodPolicy instantiates a new SodPolicy 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 + +### NewSodPolicyWithDefaults + +`func NewSodPolicyWithDefaults() *SodPolicy` + +NewSodPolicyWithDefaults instantiates a new SodPolicy 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 + +### GetId + +`func (o *SodPolicy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodPolicy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodPolicy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodPolicy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodPolicy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodPolicy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodPolicy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodPolicy) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *SodPolicy) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SodPolicy) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SodPolicy) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SodPolicy) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SodPolicy) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SodPolicy) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SodPolicy) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SodPolicy) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *SodPolicy) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SodPolicy) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SodPolicy) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SodPolicy) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *SodPolicy) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *SodPolicy) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwnerRef + +`func (o *SodPolicy) GetOwnerRef() SodPolicyOwnerRef` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *SodPolicy) GetOwnerRefOk() (*SodPolicyOwnerRef, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *SodPolicy) SetOwnerRef(v SodPolicyOwnerRef)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *SodPolicy) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### GetExternalPolicyReference + +`func (o *SodPolicy) GetExternalPolicyReference() string` + +GetExternalPolicyReference returns the ExternalPolicyReference field if non-nil, zero value otherwise. + +### GetExternalPolicyReferenceOk + +`func (o *SodPolicy) GetExternalPolicyReferenceOk() (*string, bool)` + +GetExternalPolicyReferenceOk returns a tuple with the ExternalPolicyReference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExternalPolicyReference + +`func (o *SodPolicy) SetExternalPolicyReference(v string)` + +SetExternalPolicyReference sets ExternalPolicyReference field to given value. + +### HasExternalPolicyReference + +`func (o *SodPolicy) HasExternalPolicyReference() bool` + +HasExternalPolicyReference returns a boolean if a field has been set. + +### SetExternalPolicyReferenceNil + +`func (o *SodPolicy) SetExternalPolicyReferenceNil(b bool)` + + SetExternalPolicyReferenceNil sets the value for ExternalPolicyReference to be an explicit nil + +### UnsetExternalPolicyReference +`func (o *SodPolicy) UnsetExternalPolicyReference()` + +UnsetExternalPolicyReference ensures that no value is present for ExternalPolicyReference, not even an explicit nil +### GetPolicyQuery + +`func (o *SodPolicy) GetPolicyQuery() string` + +GetPolicyQuery returns the PolicyQuery field if non-nil, zero value otherwise. + +### GetPolicyQueryOk + +`func (o *SodPolicy) GetPolicyQueryOk() (*string, bool)` + +GetPolicyQueryOk returns a tuple with the PolicyQuery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyQuery + +`func (o *SodPolicy) SetPolicyQuery(v string)` + +SetPolicyQuery sets PolicyQuery field to given value. + +### HasPolicyQuery + +`func (o *SodPolicy) HasPolicyQuery() bool` + +HasPolicyQuery returns a boolean if a field has been set. + +### GetCompensatingControls + +`func (o *SodPolicy) GetCompensatingControls() string` + +GetCompensatingControls returns the CompensatingControls field if non-nil, zero value otherwise. + +### GetCompensatingControlsOk + +`func (o *SodPolicy) GetCompensatingControlsOk() (*string, bool)` + +GetCompensatingControlsOk returns a tuple with the CompensatingControls field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompensatingControls + +`func (o *SodPolicy) SetCompensatingControls(v string)` + +SetCompensatingControls sets CompensatingControls field to given value. + +### HasCompensatingControls + +`func (o *SodPolicy) HasCompensatingControls() bool` + +HasCompensatingControls returns a boolean if a field has been set. + +### SetCompensatingControlsNil + +`func (o *SodPolicy) SetCompensatingControlsNil(b bool)` + + SetCompensatingControlsNil sets the value for CompensatingControls to be an explicit nil + +### UnsetCompensatingControls +`func (o *SodPolicy) UnsetCompensatingControls()` + +UnsetCompensatingControls ensures that no value is present for CompensatingControls, not even an explicit nil +### GetCorrectionAdvice + +`func (o *SodPolicy) GetCorrectionAdvice() string` + +GetCorrectionAdvice returns the CorrectionAdvice field if non-nil, zero value otherwise. + +### GetCorrectionAdviceOk + +`func (o *SodPolicy) GetCorrectionAdviceOk() (*string, bool)` + +GetCorrectionAdviceOk returns a tuple with the CorrectionAdvice field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrectionAdvice + +`func (o *SodPolicy) SetCorrectionAdvice(v string)` + +SetCorrectionAdvice sets CorrectionAdvice field to given value. + +### HasCorrectionAdvice + +`func (o *SodPolicy) HasCorrectionAdvice() bool` + +HasCorrectionAdvice returns a boolean if a field has been set. + +### SetCorrectionAdviceNil + +`func (o *SodPolicy) SetCorrectionAdviceNil(b bool)` + + SetCorrectionAdviceNil sets the value for CorrectionAdvice to be an explicit nil + +### UnsetCorrectionAdvice +`func (o *SodPolicy) UnsetCorrectionAdvice()` + +UnsetCorrectionAdvice ensures that no value is present for CorrectionAdvice, not even an explicit nil +### GetState + +`func (o *SodPolicy) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *SodPolicy) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *SodPolicy) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *SodPolicy) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetTags + +`func (o *SodPolicy) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *SodPolicy) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *SodPolicy) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *SodPolicy) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetCreatorId + +`func (o *SodPolicy) GetCreatorId() string` + +GetCreatorId returns the CreatorId field if non-nil, zero value otherwise. + +### GetCreatorIdOk + +`func (o *SodPolicy) GetCreatorIdOk() (*string, bool)` + +GetCreatorIdOk returns a tuple with the CreatorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatorId + +`func (o *SodPolicy) SetCreatorId(v string)` + +SetCreatorId sets CreatorId field to given value. + +### HasCreatorId + +`func (o *SodPolicy) HasCreatorId() bool` + +HasCreatorId returns a boolean if a field has been set. + +### GetModifierId + +`func (o *SodPolicy) GetModifierId() string` + +GetModifierId returns the ModifierId field if non-nil, zero value otherwise. + +### GetModifierIdOk + +`func (o *SodPolicy) GetModifierIdOk() (*string, bool)` + +GetModifierIdOk returns a tuple with the ModifierId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifierId + +`func (o *SodPolicy) SetModifierId(v string)` + +SetModifierId sets ModifierId field to given value. + +### HasModifierId + +`func (o *SodPolicy) HasModifierId() bool` + +HasModifierId returns a boolean if a field has been set. + +### SetModifierIdNil + +`func (o *SodPolicy) SetModifierIdNil(b bool)` + + SetModifierIdNil sets the value for ModifierId to be an explicit nil + +### UnsetModifierId +`func (o *SodPolicy) UnsetModifierId()` + +UnsetModifierId ensures that no value is present for ModifierId, not even an explicit nil +### GetViolationOwnerAssignmentConfig + +`func (o *SodPolicy) GetViolationOwnerAssignmentConfig() ViolationOwnerAssignmentConfig` + +GetViolationOwnerAssignmentConfig returns the ViolationOwnerAssignmentConfig field if non-nil, zero value otherwise. + +### GetViolationOwnerAssignmentConfigOk + +`func (o *SodPolicy) GetViolationOwnerAssignmentConfigOk() (*ViolationOwnerAssignmentConfig, bool)` + +GetViolationOwnerAssignmentConfigOk returns a tuple with the ViolationOwnerAssignmentConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationOwnerAssignmentConfig + +`func (o *SodPolicy) SetViolationOwnerAssignmentConfig(v ViolationOwnerAssignmentConfig)` + +SetViolationOwnerAssignmentConfig sets ViolationOwnerAssignmentConfig field to given value. + +### HasViolationOwnerAssignmentConfig + +`func (o *SodPolicy) HasViolationOwnerAssignmentConfig() bool` + +HasViolationOwnerAssignmentConfig returns a boolean if a field has been set. + +### GetScheduled + +`func (o *SodPolicy) GetScheduled() bool` + +GetScheduled returns the Scheduled field if non-nil, zero value otherwise. + +### GetScheduledOk + +`func (o *SodPolicy) GetScheduledOk() (*bool, bool)` + +GetScheduledOk returns a tuple with the Scheduled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheduled + +`func (o *SodPolicy) SetScheduled(v bool)` + +SetScheduled sets Scheduled field to given value. + +### HasScheduled + +`func (o *SodPolicy) HasScheduled() bool` + +HasScheduled returns a boolean if a field has been set. + +### GetType + +`func (o *SodPolicy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodPolicy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodPolicy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodPolicy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConflictingAccessCriteria + +`func (o *SodPolicy) GetConflictingAccessCriteria() SodPolicyConflictingAccessCriteria` + +GetConflictingAccessCriteria returns the ConflictingAccessCriteria field if non-nil, zero value otherwise. + +### GetConflictingAccessCriteriaOk + +`func (o *SodPolicy) GetConflictingAccessCriteriaOk() (*SodPolicyConflictingAccessCriteria, bool)` + +GetConflictingAccessCriteriaOk returns a tuple with the ConflictingAccessCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConflictingAccessCriteria + +`func (o *SodPolicy) SetConflictingAccessCriteria(v SodPolicyConflictingAccessCriteria)` + +SetConflictingAccessCriteria sets ConflictingAccessCriteria field to given value. + +### HasConflictingAccessCriteria + +`func (o *SodPolicy) HasConflictingAccessCriteria() bool` + +HasConflictingAccessCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SodPolicyConflictingAccessCriteria.md b/docs/tools/sdk/go/Reference/V2024/Models/SodPolicyConflictingAccessCriteria.md new file mode 100644 index 000000000..78655e0ab --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SodPolicyConflictingAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: v2024-sod-policy-conflicting-access-criteria +title: SodPolicyConflictingAccessCriteria +pagination_label: SodPolicyConflictingAccessCriteria +sidebar_label: SodPolicyConflictingAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicyConflictingAccessCriteria', 'V2024SodPolicyConflictingAccessCriteria'] +slug: /tools/sdk/go/v2024/models/sod-policy-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodPolicyConflictingAccessCriteria', 'V2024SodPolicyConflictingAccessCriteria'] +--- + +# SodPolicyConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] +**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] + +## Methods + +### NewSodPolicyConflictingAccessCriteria + +`func NewSodPolicyConflictingAccessCriteria() *SodPolicyConflictingAccessCriteria` + +NewSodPolicyConflictingAccessCriteria instantiates a new SodPolicyConflictingAccessCriteria 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 + +### NewSodPolicyConflictingAccessCriteriaWithDefaults + +`func NewSodPolicyConflictingAccessCriteriaWithDefaults() *SodPolicyConflictingAccessCriteria` + +NewSodPolicyConflictingAccessCriteriaWithDefaults instantiates a new SodPolicyConflictingAccessCriteria 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 + +### GetLeftCriteria + +`func (o *SodPolicyConflictingAccessCriteria) GetLeftCriteria() AccessCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *SodPolicyConflictingAccessCriteria) GetLeftCriteriaOk() (*AccessCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *SodPolicyConflictingAccessCriteria) SetLeftCriteria(v AccessCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *SodPolicyConflictingAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *SodPolicyConflictingAccessCriteria) GetRightCriteria() AccessCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *SodPolicyConflictingAccessCriteria) GetRightCriteriaOk() (*AccessCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *SodPolicyConflictingAccessCriteria) SetRightCriteria(v AccessCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *SodPolicyConflictingAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SodPolicyDto.md b/docs/tools/sdk/go/Reference/V2024/Models/SodPolicyDto.md new file mode 100644 index 000000000..1306654fd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SodPolicyDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-sod-policy-dto +title: SodPolicyDto +pagination_label: SodPolicyDto +sidebar_label: SodPolicyDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicyDto', 'V2024SodPolicyDto'] +slug: /tools/sdk/go/v2024/models/sod-policy-dto +tags: ['SDK', 'Software Development Kit', 'SodPolicyDto', 'V2024SodPolicyDto'] +--- + +# SodPolicyDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy ID. | [optional] +**Name** | Pointer to **string** | SOD policy display name. | [optional] + +## Methods + +### NewSodPolicyDto + +`func NewSodPolicyDto() *SodPolicyDto` + +NewSodPolicyDto instantiates a new SodPolicyDto 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 + +### NewSodPolicyDtoWithDefaults + +`func NewSodPolicyDtoWithDefaults() *SodPolicyDto` + +NewSodPolicyDtoWithDefaults instantiates a new SodPolicyDto 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 + +### GetType + +`func (o *SodPolicyDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodPolicyDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodPolicyDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodPolicyDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodPolicyDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodPolicyDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodPolicyDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodPolicyDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodPolicyDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodPolicyDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodPolicyDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodPolicyDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SodPolicyOwnerRef.md b/docs/tools/sdk/go/Reference/V2024/Models/SodPolicyOwnerRef.md new file mode 100644 index 000000000..b35aa43b1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SodPolicyOwnerRef.md @@ -0,0 +1,116 @@ +--- +id: v2024-sod-policy-owner-ref +title: SodPolicyOwnerRef +pagination_label: SodPolicyOwnerRef +sidebar_label: SodPolicyOwnerRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicyOwnerRef', 'V2024SodPolicyOwnerRef'] +slug: /tools/sdk/go/v2024/models/sod-policy-owner-ref +tags: ['SDK', 'Software Development Kit', 'SodPolicyOwnerRef', 'V2024SodPolicyOwnerRef'] +--- + +# SodPolicyOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner type. | [optional] +**Id** | Pointer to **string** | Owner's ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] + +## Methods + +### NewSodPolicyOwnerRef + +`func NewSodPolicyOwnerRef() *SodPolicyOwnerRef` + +NewSodPolicyOwnerRef instantiates a new SodPolicyOwnerRef 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 + +### NewSodPolicyOwnerRefWithDefaults + +`func NewSodPolicyOwnerRefWithDefaults() *SodPolicyOwnerRef` + +NewSodPolicyOwnerRefWithDefaults instantiates a new SodPolicyOwnerRef 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 + +### GetType + +`func (o *SodPolicyOwnerRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodPolicyOwnerRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodPolicyOwnerRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodPolicyOwnerRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodPolicyOwnerRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodPolicyOwnerRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodPolicyOwnerRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodPolicyOwnerRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodPolicyOwnerRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodPolicyOwnerRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodPolicyOwnerRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodPolicyOwnerRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SodPolicySchedule.md b/docs/tools/sdk/go/Reference/V2024/Models/SodPolicySchedule.md new file mode 100644 index 000000000..b977775b1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SodPolicySchedule.md @@ -0,0 +1,272 @@ +--- +id: v2024-sod-policy-schedule +title: SodPolicySchedule +pagination_label: SodPolicySchedule +sidebar_label: SodPolicySchedule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicySchedule', 'V2024SodPolicySchedule'] +slug: /tools/sdk/go/v2024/models/sod-policy-schedule +tags: ['SDK', 'Software Development Kit', 'SodPolicySchedule', 'V2024SodPolicySchedule'] +--- + +# SodPolicySchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | SOD Policy schedule name | [optional] +**Created** | Pointer to **SailPointTime** | The time when this SOD policy schedule is created. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | The time when this SOD policy schedule is modified. | [optional] [readonly] +**Description** | Pointer to **string** | SOD Policy schedule description | [optional] +**Schedule** | Pointer to [**Schedule2**](schedule2) | | [optional] +**Recipients** | Pointer to [**[]SodRecipient**](sod-recipient) | | [optional] +**EmailEmptyResults** | Pointer to **bool** | Indicates if empty results need to be emailed | [optional] [default to false] +**CreatorId** | Pointer to **string** | Policy's creator ID | [optional] [readonly] +**ModifierId** | Pointer to **string** | Policy's modifier ID | [optional] [readonly] + +## Methods + +### NewSodPolicySchedule + +`func NewSodPolicySchedule() *SodPolicySchedule` + +NewSodPolicySchedule instantiates a new SodPolicySchedule 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 + +### NewSodPolicyScheduleWithDefaults + +`func NewSodPolicyScheduleWithDefaults() *SodPolicySchedule` + +NewSodPolicyScheduleWithDefaults instantiates a new SodPolicySchedule 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 + +### GetName + +`func (o *SodPolicySchedule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodPolicySchedule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodPolicySchedule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodPolicySchedule) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *SodPolicySchedule) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SodPolicySchedule) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SodPolicySchedule) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SodPolicySchedule) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SodPolicySchedule) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SodPolicySchedule) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SodPolicySchedule) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SodPolicySchedule) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *SodPolicySchedule) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SodPolicySchedule) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SodPolicySchedule) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SodPolicySchedule) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetSchedule + +`func (o *SodPolicySchedule) GetSchedule() Schedule2` + +GetSchedule returns the Schedule field if non-nil, zero value otherwise. + +### GetScheduleOk + +`func (o *SodPolicySchedule) GetScheduleOk() (*Schedule2, bool)` + +GetScheduleOk returns a tuple with the Schedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchedule + +`func (o *SodPolicySchedule) SetSchedule(v Schedule2)` + +SetSchedule sets Schedule field to given value. + +### HasSchedule + +`func (o *SodPolicySchedule) HasSchedule() bool` + +HasSchedule returns a boolean if a field has been set. + +### GetRecipients + +`func (o *SodPolicySchedule) GetRecipients() []SodRecipient` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *SodPolicySchedule) GetRecipientsOk() (*[]SodRecipient, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *SodPolicySchedule) SetRecipients(v []SodRecipient)` + +SetRecipients sets Recipients field to given value. + +### HasRecipients + +`func (o *SodPolicySchedule) HasRecipients() bool` + +HasRecipients returns a boolean if a field has been set. + +### GetEmailEmptyResults + +`func (o *SodPolicySchedule) GetEmailEmptyResults() bool` + +GetEmailEmptyResults returns the EmailEmptyResults field if non-nil, zero value otherwise. + +### GetEmailEmptyResultsOk + +`func (o *SodPolicySchedule) GetEmailEmptyResultsOk() (*bool, bool)` + +GetEmailEmptyResultsOk returns a tuple with the EmailEmptyResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEmptyResults + +`func (o *SodPolicySchedule) SetEmailEmptyResults(v bool)` + +SetEmailEmptyResults sets EmailEmptyResults field to given value. + +### HasEmailEmptyResults + +`func (o *SodPolicySchedule) HasEmailEmptyResults() bool` + +HasEmailEmptyResults returns a boolean if a field has been set. + +### GetCreatorId + +`func (o *SodPolicySchedule) GetCreatorId() string` + +GetCreatorId returns the CreatorId field if non-nil, zero value otherwise. + +### GetCreatorIdOk + +`func (o *SodPolicySchedule) GetCreatorIdOk() (*string, bool)` + +GetCreatorIdOk returns a tuple with the CreatorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatorId + +`func (o *SodPolicySchedule) SetCreatorId(v string)` + +SetCreatorId sets CreatorId field to given value. + +### HasCreatorId + +`func (o *SodPolicySchedule) HasCreatorId() bool` + +HasCreatorId returns a boolean if a field has been set. + +### GetModifierId + +`func (o *SodPolicySchedule) GetModifierId() string` + +GetModifierId returns the ModifierId field if non-nil, zero value otherwise. + +### GetModifierIdOk + +`func (o *SodPolicySchedule) GetModifierIdOk() (*string, bool)` + +GetModifierIdOk returns a tuple with the ModifierId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifierId + +`func (o *SodPolicySchedule) SetModifierId(v string)` + +SetModifierId sets ModifierId field to given value. + +### HasModifierId + +`func (o *SodPolicySchedule) HasModifierId() bool` + +HasModifierId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SodRecipient.md b/docs/tools/sdk/go/Reference/V2024/Models/SodRecipient.md new file mode 100644 index 000000000..b24fe5480 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SodRecipient.md @@ -0,0 +1,116 @@ +--- +id: v2024-sod-recipient +title: SodRecipient +pagination_label: SodRecipient +sidebar_label: SodRecipient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodRecipient', 'V2024SodRecipient'] +slug: /tools/sdk/go/v2024/models/sod-recipient +tags: ['SDK', 'Software Development Kit', 'SodRecipient', 'V2024SodRecipient'] +--- + +# SodRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy recipient DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy recipient's identity ID. | [optional] +**Name** | Pointer to **string** | SOD policy recipient's display name. | [optional] + +## Methods + +### NewSodRecipient + +`func NewSodRecipient() *SodRecipient` + +NewSodRecipient instantiates a new SodRecipient 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 + +### NewSodRecipientWithDefaults + +`func NewSodRecipientWithDefaults() *SodRecipient` + +NewSodRecipientWithDefaults instantiates a new SodRecipient 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 + +### GetType + +`func (o *SodRecipient) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodRecipient) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodRecipient) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodRecipient) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodRecipient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodRecipient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodRecipient) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodRecipient) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodRecipient) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodRecipient) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodRecipient) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodRecipient) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SodReportResultDto.md b/docs/tools/sdk/go/Reference/V2024/Models/SodReportResultDto.md new file mode 100644 index 000000000..b2b8b7fbd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SodReportResultDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-sod-report-result-dto +title: SodReportResultDto +pagination_label: SodReportResultDto +sidebar_label: SodReportResultDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodReportResultDto', 'V2024SodReportResultDto'] +slug: /tools/sdk/go/v2024/models/sod-report-result-dto +tags: ['SDK', 'Software Development Kit', 'SodReportResultDto', 'V2024SodReportResultDto'] +--- + +# SodReportResultDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **string** | Human-readable name of the SOD policy violation report result. | [optional] + +## Methods + +### NewSodReportResultDto + +`func NewSodReportResultDto() *SodReportResultDto` + +NewSodReportResultDto instantiates a new SodReportResultDto 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 + +### NewSodReportResultDtoWithDefaults + +`func NewSodReportResultDtoWithDefaults() *SodReportResultDto` + +NewSodReportResultDtoWithDefaults instantiates a new SodReportResultDto 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 + +### GetType + +`func (o *SodReportResultDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodReportResultDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodReportResultDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodReportResultDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodReportResultDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodReportResultDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodReportResultDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodReportResultDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodReportResultDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodReportResultDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodReportResultDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodReportResultDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SodViolationCheck.md b/docs/tools/sdk/go/Reference/V2024/Models/SodViolationCheck.md new file mode 100644 index 000000000..56a394c0a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SodViolationCheck.md @@ -0,0 +1,85 @@ +--- +id: v2024-sod-violation-check +title: SodViolationCheck +pagination_label: SodViolationCheck +sidebar_label: SodViolationCheck +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationCheck', 'V2024SodViolationCheck'] +slug: /tools/sdk/go/v2024/models/sod-violation-check +tags: ['SDK', 'Software Development Kit', 'SodViolationCheck', 'V2024SodViolationCheck'] +--- + +# SodViolationCheck + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | **string** | The id of the original request | +**Created** | Pointer to **SailPointTime** | The date-time when this request was created. | [optional] [readonly] + +## Methods + +### NewSodViolationCheck + +`func NewSodViolationCheck(requestId string, ) *SodViolationCheck` + +NewSodViolationCheck instantiates a new SodViolationCheck 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 + +### NewSodViolationCheckWithDefaults + +`func NewSodViolationCheckWithDefaults() *SodViolationCheck` + +NewSodViolationCheckWithDefaults instantiates a new SodViolationCheck 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 + +### GetRequestId + +`func (o *SodViolationCheck) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *SodViolationCheck) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *SodViolationCheck) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + + +### GetCreated + +`func (o *SodViolationCheck) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SodViolationCheck) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SodViolationCheck) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SodViolationCheck) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SodViolationCheckResult.md b/docs/tools/sdk/go/Reference/V2024/Models/SodViolationCheckResult.md new file mode 100644 index 000000000..a5c9ab0bd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SodViolationCheckResult.md @@ -0,0 +1,172 @@ +--- +id: v2024-sod-violation-check-result +title: SodViolationCheckResult +pagination_label: SodViolationCheckResult +sidebar_label: SodViolationCheckResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationCheckResult', 'V2024SodViolationCheckResult'] +slug: /tools/sdk/go/v2024/models/sod-violation-check-result +tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult', 'V2024SodViolationCheckResult'] +--- + +# SodViolationCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to [**ErrorMessageDto**](error-message-dto) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] +**ViolationContexts** | Pointer to [**[]SodViolationContext**](sod-violation-context) | | [optional] +**ViolatedPolicies** | Pointer to [**[]SodPolicyDto**](sod-policy-dto) | A list of the SOD policies that were violated. | [optional] + +## Methods + +### NewSodViolationCheckResult + +`func NewSodViolationCheckResult() *SodViolationCheckResult` + +NewSodViolationCheckResult instantiates a new SodViolationCheckResult 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 + +### NewSodViolationCheckResultWithDefaults + +`func NewSodViolationCheckResultWithDefaults() *SodViolationCheckResult` + +NewSodViolationCheckResultWithDefaults instantiates a new SodViolationCheckResult 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 + +### GetMessage + +`func (o *SodViolationCheckResult) GetMessage() ErrorMessageDto` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *SodViolationCheckResult) GetMessageOk() (*ErrorMessageDto, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *SodViolationCheckResult) SetMessage(v ErrorMessageDto)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *SodViolationCheckResult) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *SodViolationCheckResult) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *SodViolationCheckResult) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *SodViolationCheckResult) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *SodViolationCheckResult) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *SodViolationCheckResult) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *SodViolationCheckResult) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetViolationContexts + +`func (o *SodViolationCheckResult) GetViolationContexts() []SodViolationContext` + +GetViolationContexts returns the ViolationContexts field if non-nil, zero value otherwise. + +### GetViolationContextsOk + +`func (o *SodViolationCheckResult) GetViolationContextsOk() (*[]SodViolationContext, bool)` + +GetViolationContextsOk returns a tuple with the ViolationContexts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationContexts + +`func (o *SodViolationCheckResult) SetViolationContexts(v []SodViolationContext)` + +SetViolationContexts sets ViolationContexts field to given value. + +### HasViolationContexts + +`func (o *SodViolationCheckResult) HasViolationContexts() bool` + +HasViolationContexts returns a boolean if a field has been set. + +### SetViolationContextsNil + +`func (o *SodViolationCheckResult) SetViolationContextsNil(b bool)` + + SetViolationContextsNil sets the value for ViolationContexts to be an explicit nil + +### UnsetViolationContexts +`func (o *SodViolationCheckResult) UnsetViolationContexts()` + +UnsetViolationContexts ensures that no value is present for ViolationContexts, not even an explicit nil +### GetViolatedPolicies + +`func (o *SodViolationCheckResult) GetViolatedPolicies() []SodPolicyDto` + +GetViolatedPolicies returns the ViolatedPolicies field if non-nil, zero value otherwise. + +### GetViolatedPoliciesOk + +`func (o *SodViolationCheckResult) GetViolatedPoliciesOk() (*[]SodPolicyDto, bool)` + +GetViolatedPoliciesOk returns a tuple with the ViolatedPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolatedPolicies + +`func (o *SodViolationCheckResult) SetViolatedPolicies(v []SodPolicyDto)` + +SetViolatedPolicies sets ViolatedPolicies field to given value. + +### HasViolatedPolicies + +`func (o *SodViolationCheckResult) HasViolatedPolicies() bool` + +HasViolatedPolicies returns a boolean if a field has been set. + +### SetViolatedPoliciesNil + +`func (o *SodViolationCheckResult) SetViolatedPoliciesNil(b bool)` + + SetViolatedPoliciesNil sets the value for ViolatedPolicies to be an explicit nil + +### UnsetViolatedPolicies +`func (o *SodViolationCheckResult) UnsetViolatedPolicies()` + +UnsetViolatedPolicies ensures that no value is present for ViolatedPolicies, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SodViolationContext.md b/docs/tools/sdk/go/Reference/V2024/Models/SodViolationContext.md new file mode 100644 index 000000000..79b25a408 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SodViolationContext.md @@ -0,0 +1,90 @@ +--- +id: v2024-sod-violation-context +title: SodViolationContext +pagination_label: SodViolationContext +sidebar_label: SodViolationContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContext', 'V2024SodViolationContext'] +slug: /tools/sdk/go/v2024/models/sod-violation-context +tags: ['SDK', 'Software Development Kit', 'SodViolationContext', 'V2024SodViolationContext'] +--- + +# SodViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**SodPolicyDto**](sod-policy-dto) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteria**](sod-violation-context-conflicting-access-criteria) | | [optional] + +## Methods + +### NewSodViolationContext + +`func NewSodViolationContext() *SodViolationContext` + +NewSodViolationContext instantiates a new SodViolationContext 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 + +### NewSodViolationContextWithDefaults + +`func NewSodViolationContextWithDefaults() *SodViolationContext` + +NewSodViolationContextWithDefaults instantiates a new SodViolationContext 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 + +### GetPolicy + +`func (o *SodViolationContext) GetPolicy() SodPolicyDto` + +GetPolicy returns the Policy field if non-nil, zero value otherwise. + +### GetPolicyOk + +`func (o *SodViolationContext) GetPolicyOk() (*SodPolicyDto, bool)` + +GetPolicyOk returns a tuple with the Policy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicy + +`func (o *SodViolationContext) SetPolicy(v SodPolicyDto)` + +SetPolicy sets Policy field to given value. + +### HasPolicy + +`func (o *SodViolationContext) HasPolicy() bool` + +HasPolicy returns a boolean if a field has been set. + +### GetConflictingAccessCriteria + +`func (o *SodViolationContext) GetConflictingAccessCriteria() SodViolationContextConflictingAccessCriteria` + +GetConflictingAccessCriteria returns the ConflictingAccessCriteria field if non-nil, zero value otherwise. + +### GetConflictingAccessCriteriaOk + +`func (o *SodViolationContext) GetConflictingAccessCriteriaOk() (*SodViolationContextConflictingAccessCriteria, bool)` + +GetConflictingAccessCriteriaOk returns a tuple with the ConflictingAccessCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConflictingAccessCriteria + +`func (o *SodViolationContext) SetConflictingAccessCriteria(v SodViolationContextConflictingAccessCriteria)` + +SetConflictingAccessCriteria sets ConflictingAccessCriteria field to given value. + +### HasConflictingAccessCriteria + +`func (o *SodViolationContext) HasConflictingAccessCriteria() bool` + +HasConflictingAccessCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SodViolationContextCheckCompleted.md b/docs/tools/sdk/go/Reference/V2024/Models/SodViolationContextCheckCompleted.md new file mode 100644 index 000000000..1dfc8291a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SodViolationContextCheckCompleted.md @@ -0,0 +1,136 @@ +--- +id: v2024-sod-violation-context-check-completed +title: SodViolationContextCheckCompleted +pagination_label: SodViolationContextCheckCompleted +sidebar_label: SodViolationContextCheckCompleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContextCheckCompleted', 'V2024SodViolationContextCheckCompleted'] +slug: /tools/sdk/go/v2024/models/sod-violation-context-check-completed +tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted', 'V2024SodViolationContextCheckCompleted'] +--- + +# SodViolationContextCheckCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **NullableString** | The status of SOD violation check | [optional] +**Uuid** | Pointer to **NullableString** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] + +## Methods + +### NewSodViolationContextCheckCompleted + +`func NewSodViolationContextCheckCompleted() *SodViolationContextCheckCompleted` + +NewSodViolationContextCheckCompleted instantiates a new SodViolationContextCheckCompleted 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 + +### NewSodViolationContextCheckCompletedWithDefaults + +`func NewSodViolationContextCheckCompletedWithDefaults() *SodViolationContextCheckCompleted` + +NewSodViolationContextCheckCompletedWithDefaults instantiates a new SodViolationContextCheckCompleted 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 + +### GetState + +`func (o *SodViolationContextCheckCompleted) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *SodViolationContextCheckCompleted) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *SodViolationContextCheckCompleted) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *SodViolationContextCheckCompleted) HasState() bool` + +HasState returns a boolean if a field has been set. + +### SetStateNil + +`func (o *SodViolationContextCheckCompleted) SetStateNil(b bool)` + + SetStateNil sets the value for State to be an explicit nil + +### UnsetState +`func (o *SodViolationContextCheckCompleted) UnsetState()` + +UnsetState ensures that no value is present for State, not even an explicit nil +### GetUuid + +`func (o *SodViolationContextCheckCompleted) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *SodViolationContextCheckCompleted) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *SodViolationContextCheckCompleted) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *SodViolationContextCheckCompleted) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *SodViolationContextCheckCompleted) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *SodViolationContextCheckCompleted) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetViolationCheckResult + +`func (o *SodViolationContextCheckCompleted) GetViolationCheckResult() SodViolationCheckResult` + +GetViolationCheckResult returns the ViolationCheckResult field if non-nil, zero value otherwise. + +### GetViolationCheckResultOk + +`func (o *SodViolationContextCheckCompleted) GetViolationCheckResultOk() (*SodViolationCheckResult, bool)` + +GetViolationCheckResultOk returns a tuple with the ViolationCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationCheckResult + +`func (o *SodViolationContextCheckCompleted) SetViolationCheckResult(v SodViolationCheckResult)` + +SetViolationCheckResult sets ViolationCheckResult field to given value. + +### HasViolationCheckResult + +`func (o *SodViolationContextCheckCompleted) HasViolationCheckResult() bool` + +HasViolationCheckResult returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SodViolationContextConflictingAccessCriteria.md b/docs/tools/sdk/go/Reference/V2024/Models/SodViolationContextConflictingAccessCriteria.md new file mode 100644 index 000000000..f8a9a6b47 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SodViolationContextConflictingAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: v2024-sod-violation-context-conflicting-access-criteria +title: SodViolationContextConflictingAccessCriteria +pagination_label: SodViolationContextConflictingAccessCriteria +sidebar_label: SodViolationContextConflictingAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContextConflictingAccessCriteria', 'V2024SodViolationContextConflictingAccessCriteria'] +slug: /tools/sdk/go/v2024/models/sod-violation-context-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteria', 'V2024SodViolationContextConflictingAccessCriteria'] +--- + +# SodViolationContextConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] +**RightCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] + +## Methods + +### NewSodViolationContextConflictingAccessCriteria + +`func NewSodViolationContextConflictingAccessCriteria() *SodViolationContextConflictingAccessCriteria` + +NewSodViolationContextConflictingAccessCriteria instantiates a new SodViolationContextConflictingAccessCriteria 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 + +### NewSodViolationContextConflictingAccessCriteriaWithDefaults + +`func NewSodViolationContextConflictingAccessCriteriaWithDefaults() *SodViolationContextConflictingAccessCriteria` + +NewSodViolationContextConflictingAccessCriteriaWithDefaults instantiates a new SodViolationContextConflictingAccessCriteria 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 + +### GetLeftCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) GetLeftCriteria() SodViolationContextConflictingAccessCriteriaLeftCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *SodViolationContextConflictingAccessCriteria) GetLeftCriteriaOk() (*SodViolationContextConflictingAccessCriteriaLeftCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) SetLeftCriteria(v SodViolationContextConflictingAccessCriteriaLeftCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) GetRightCriteria() SodViolationContextConflictingAccessCriteriaLeftCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *SodViolationContextConflictingAccessCriteria) GetRightCriteriaOk() (*SodViolationContextConflictingAccessCriteriaLeftCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) SetRightCriteria(v SodViolationContextConflictingAccessCriteriaLeftCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/go/Reference/V2024/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md new file mode 100644 index 000000000..f83229184 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md @@ -0,0 +1,64 @@ +--- +id: v2024-sod-violation-context-conflicting-access-criteria-left-criteria +title: SodViolationContextConflictingAccessCriteriaLeftCriteria +pagination_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'V2024SodViolationContextConflictingAccessCriteriaLeftCriteria'] +slug: /tools/sdk/go/v2024/models/sod-violation-context-conflicting-access-criteria-left-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'V2024SodViolationContextConflictingAccessCriteriaLeftCriteria'] +--- + +# SodViolationContextConflictingAccessCriteriaLeftCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]SodExemptCriteria**](sod-exempt-criteria) | | [optional] + +## Methods + +### NewSodViolationContextConflictingAccessCriteriaLeftCriteria + +`func NewSodViolationContextConflictingAccessCriteriaLeftCriteria() *SodViolationContextConflictingAccessCriteriaLeftCriteria` + +NewSodViolationContextConflictingAccessCriteriaLeftCriteria instantiates a new SodViolationContextConflictingAccessCriteriaLeftCriteria 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 + +### NewSodViolationContextConflictingAccessCriteriaLeftCriteriaWithDefaults + +`func NewSodViolationContextConflictingAccessCriteriaLeftCriteriaWithDefaults() *SodViolationContextConflictingAccessCriteriaLeftCriteria` + +NewSodViolationContextConflictingAccessCriteriaLeftCriteriaWithDefaults instantiates a new SodViolationContextConflictingAccessCriteriaLeftCriteria 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 + +### GetCriteriaList + +`func (o *SodViolationContextConflictingAccessCriteriaLeftCriteria) GetCriteriaList() []SodExemptCriteria` + +GetCriteriaList returns the CriteriaList field if non-nil, zero value otherwise. + +### GetCriteriaListOk + +`func (o *SodViolationContextConflictingAccessCriteriaLeftCriteria) GetCriteriaListOk() (*[]SodExemptCriteria, bool)` + +GetCriteriaListOk returns a tuple with the CriteriaList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteriaList + +`func (o *SodViolationContextConflictingAccessCriteriaLeftCriteria) SetCriteriaList(v []SodExemptCriteria)` + +SetCriteriaList sets CriteriaList field to given value. + +### HasCriteriaList + +`func (o *SodViolationContextConflictingAccessCriteriaLeftCriteria) HasCriteriaList() bool` + +HasCriteriaList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Source.md b/docs/tools/sdk/go/Reference/V2024/Models/Source.md new file mode 100644 index 000000000..533c95c99 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Source.md @@ -0,0 +1,909 @@ +--- +id: v2024-source +title: Source +pagination_label: Source +sidebar_label: Source +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Source', 'V2024Source'] +slug: /tools/sdk/go/v2024/models/source +tags: ['SDK', 'Software Development Kit', 'Source', 'V2024Source'] +--- + +# Source + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Source ID. | [optional] [readonly] +**Name** | **string** | Source's human-readable name. | +**Description** | Pointer to **string** | Source's human-readable description. | [optional] +**Owner** | [**SourceOwner**](source-owner) | | +**Cluster** | Pointer to [**NullableSourceCluster**](source-cluster) | | [optional] +**AccountCorrelationConfig** | Pointer to [**NullableSourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional] +**AccountCorrelationRule** | Pointer to [**NullableSourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional] +**ManagerCorrelationMapping** | Pointer to [**SourceManagerCorrelationMapping**](source-manager-correlation-mapping) | | [optional] +**ManagerCorrelationRule** | Pointer to [**NullableSourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional] +**BeforeProvisioningRule** | Pointer to [**NullableSourceBeforeProvisioningRule**](source-before-provisioning-rule) | | [optional] +**Schemas** | Pointer to [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional] +**PasswordPolicies** | Pointer to [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**Features** | Pointer to **[]string** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Type** | Pointer to **string** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Connector** | **string** | Connector script name. | +**ConnectorClass** | Pointer to **string** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**ConnectorAttributes** | Pointer to **map[string]interface{}** | Connector specific configuration. This configuration will differ from type to type. | [optional] +**DeleteThreshold** | Pointer to **int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**Authoritative** | Pointer to **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to false] +**ManagementWorkgroup** | Pointer to [**NullableSourceManagementWorkgroup**](source-management-workgroup) | | [optional] +**Healthy** | Pointer to **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to false] +**Status** | Pointer to **string** | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**Since** | Pointer to **string** | Timestamp that shows when a source health check was last performed. | [optional] +**ConnectorId** | Pointer to **string** | Connector ID | [optional] +**ConnectorName** | Pointer to **string** | Name of the connector that was chosen during source creation. | [optional] +**ConnectionType** | Pointer to **string** | Type of connection (direct or file). | [optional] +**ConnectorImplementationId** | Pointer to **string** | Connector implementation ID. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date-time when the source was last modified. | [optional] +**CredentialProviderEnabled** | Pointer to **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to false] +**Category** | Pointer to **NullableString** | Source category (e.g. null, CredentialProvider). | [optional] + +## Methods + +### NewSource + +`func NewSource(name string, owner SourceOwner, connector string, ) *Source` + +NewSource instantiates a new Source 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 + +### NewSourceWithDefaults + +`func NewSourceWithDefaults() *Source` + +NewSourceWithDefaults instantiates a new Source 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 + +### GetId + +`func (o *Source) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Source) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Source) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Source) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Source) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Source) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Source) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Source) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Source) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Source) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Source) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *Source) GetOwner() SourceOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Source) GetOwnerOk() (*SourceOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Source) SetOwner(v SourceOwner)` + +SetOwner sets Owner field to given value. + + +### GetCluster + +`func (o *Source) GetCluster() SourceCluster` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *Source) GetClusterOk() (*SourceCluster, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *Source) SetCluster(v SourceCluster)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *Source) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### SetClusterNil + +`func (o *Source) SetClusterNil(b bool)` + + SetClusterNil sets the value for Cluster to be an explicit nil + +### UnsetCluster +`func (o *Source) UnsetCluster()` + +UnsetCluster ensures that no value is present for Cluster, not even an explicit nil +### GetAccountCorrelationConfig + +`func (o *Source) GetAccountCorrelationConfig() SourceAccountCorrelationConfig` + +GetAccountCorrelationConfig returns the AccountCorrelationConfig field if non-nil, zero value otherwise. + +### GetAccountCorrelationConfigOk + +`func (o *Source) GetAccountCorrelationConfigOk() (*SourceAccountCorrelationConfig, bool)` + +GetAccountCorrelationConfigOk returns a tuple with the AccountCorrelationConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationConfig + +`func (o *Source) SetAccountCorrelationConfig(v SourceAccountCorrelationConfig)` + +SetAccountCorrelationConfig sets AccountCorrelationConfig field to given value. + +### HasAccountCorrelationConfig + +`func (o *Source) HasAccountCorrelationConfig() bool` + +HasAccountCorrelationConfig returns a boolean if a field has been set. + +### SetAccountCorrelationConfigNil + +`func (o *Source) SetAccountCorrelationConfigNil(b bool)` + + SetAccountCorrelationConfigNil sets the value for AccountCorrelationConfig to be an explicit nil + +### UnsetAccountCorrelationConfig +`func (o *Source) UnsetAccountCorrelationConfig()` + +UnsetAccountCorrelationConfig ensures that no value is present for AccountCorrelationConfig, not even an explicit nil +### GetAccountCorrelationRule + +`func (o *Source) GetAccountCorrelationRule() SourceAccountCorrelationRule` + +GetAccountCorrelationRule returns the AccountCorrelationRule field if non-nil, zero value otherwise. + +### GetAccountCorrelationRuleOk + +`func (o *Source) GetAccountCorrelationRuleOk() (*SourceAccountCorrelationRule, bool)` + +GetAccountCorrelationRuleOk returns a tuple with the AccountCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationRule + +`func (o *Source) SetAccountCorrelationRule(v SourceAccountCorrelationRule)` + +SetAccountCorrelationRule sets AccountCorrelationRule field to given value. + +### HasAccountCorrelationRule + +`func (o *Source) HasAccountCorrelationRule() bool` + +HasAccountCorrelationRule returns a boolean if a field has been set. + +### SetAccountCorrelationRuleNil + +`func (o *Source) SetAccountCorrelationRuleNil(b bool)` + + SetAccountCorrelationRuleNil sets the value for AccountCorrelationRule to be an explicit nil + +### UnsetAccountCorrelationRule +`func (o *Source) UnsetAccountCorrelationRule()` + +UnsetAccountCorrelationRule ensures that no value is present for AccountCorrelationRule, not even an explicit nil +### GetManagerCorrelationMapping + +`func (o *Source) GetManagerCorrelationMapping() SourceManagerCorrelationMapping` + +GetManagerCorrelationMapping returns the ManagerCorrelationMapping field if non-nil, zero value otherwise. + +### GetManagerCorrelationMappingOk + +`func (o *Source) GetManagerCorrelationMappingOk() (*SourceManagerCorrelationMapping, bool)` + +GetManagerCorrelationMappingOk returns a tuple with the ManagerCorrelationMapping field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationMapping + +`func (o *Source) SetManagerCorrelationMapping(v SourceManagerCorrelationMapping)` + +SetManagerCorrelationMapping sets ManagerCorrelationMapping field to given value. + +### HasManagerCorrelationMapping + +`func (o *Source) HasManagerCorrelationMapping() bool` + +HasManagerCorrelationMapping returns a boolean if a field has been set. + +### GetManagerCorrelationRule + +`func (o *Source) GetManagerCorrelationRule() SourceManagerCorrelationRule` + +GetManagerCorrelationRule returns the ManagerCorrelationRule field if non-nil, zero value otherwise. + +### GetManagerCorrelationRuleOk + +`func (o *Source) GetManagerCorrelationRuleOk() (*SourceManagerCorrelationRule, bool)` + +GetManagerCorrelationRuleOk returns a tuple with the ManagerCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationRule + +`func (o *Source) SetManagerCorrelationRule(v SourceManagerCorrelationRule)` + +SetManagerCorrelationRule sets ManagerCorrelationRule field to given value. + +### HasManagerCorrelationRule + +`func (o *Source) HasManagerCorrelationRule() bool` + +HasManagerCorrelationRule returns a boolean if a field has been set. + +### SetManagerCorrelationRuleNil + +`func (o *Source) SetManagerCorrelationRuleNil(b bool)` + + SetManagerCorrelationRuleNil sets the value for ManagerCorrelationRule to be an explicit nil + +### UnsetManagerCorrelationRule +`func (o *Source) UnsetManagerCorrelationRule()` + +UnsetManagerCorrelationRule ensures that no value is present for ManagerCorrelationRule, not even an explicit nil +### GetBeforeProvisioningRule + +`func (o *Source) GetBeforeProvisioningRule() SourceBeforeProvisioningRule` + +GetBeforeProvisioningRule returns the BeforeProvisioningRule field if non-nil, zero value otherwise. + +### GetBeforeProvisioningRuleOk + +`func (o *Source) GetBeforeProvisioningRuleOk() (*SourceBeforeProvisioningRule, bool)` + +GetBeforeProvisioningRuleOk returns a tuple with the BeforeProvisioningRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBeforeProvisioningRule + +`func (o *Source) SetBeforeProvisioningRule(v SourceBeforeProvisioningRule)` + +SetBeforeProvisioningRule sets BeforeProvisioningRule field to given value. + +### HasBeforeProvisioningRule + +`func (o *Source) HasBeforeProvisioningRule() bool` + +HasBeforeProvisioningRule returns a boolean if a field has been set. + +### SetBeforeProvisioningRuleNil + +`func (o *Source) SetBeforeProvisioningRuleNil(b bool)` + + SetBeforeProvisioningRuleNil sets the value for BeforeProvisioningRule to be an explicit nil + +### UnsetBeforeProvisioningRule +`func (o *Source) UnsetBeforeProvisioningRule()` + +UnsetBeforeProvisioningRule ensures that no value is present for BeforeProvisioningRule, not even an explicit nil +### GetSchemas + +`func (o *Source) GetSchemas() []SourceSchemasInner` + +GetSchemas returns the Schemas field if non-nil, zero value otherwise. + +### GetSchemasOk + +`func (o *Source) GetSchemasOk() (*[]SourceSchemasInner, bool)` + +GetSchemasOk returns a tuple with the Schemas field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchemas + +`func (o *Source) SetSchemas(v []SourceSchemasInner)` + +SetSchemas sets Schemas field to given value. + +### HasSchemas + +`func (o *Source) HasSchemas() bool` + +HasSchemas returns a boolean if a field has been set. + +### GetPasswordPolicies + +`func (o *Source) GetPasswordPolicies() []SourcePasswordPoliciesInner` + +GetPasswordPolicies returns the PasswordPolicies field if non-nil, zero value otherwise. + +### GetPasswordPoliciesOk + +`func (o *Source) GetPasswordPoliciesOk() (*[]SourcePasswordPoliciesInner, bool)` + +GetPasswordPoliciesOk returns a tuple with the PasswordPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicies + +`func (o *Source) SetPasswordPolicies(v []SourcePasswordPoliciesInner)` + +SetPasswordPolicies sets PasswordPolicies field to given value. + +### HasPasswordPolicies + +`func (o *Source) HasPasswordPolicies() bool` + +HasPasswordPolicies returns a boolean if a field has been set. + +### SetPasswordPoliciesNil + +`func (o *Source) SetPasswordPoliciesNil(b bool)` + + SetPasswordPoliciesNil sets the value for PasswordPolicies to be an explicit nil + +### UnsetPasswordPolicies +`func (o *Source) UnsetPasswordPolicies()` + +UnsetPasswordPolicies ensures that no value is present for PasswordPolicies, not even an explicit nil +### GetFeatures + +`func (o *Source) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *Source) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *Source) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *Source) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### GetType + +`func (o *Source) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Source) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Source) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Source) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConnector + +`func (o *Source) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *Source) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *Source) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetConnectorClass + +`func (o *Source) GetConnectorClass() string` + +GetConnectorClass returns the ConnectorClass field if non-nil, zero value otherwise. + +### GetConnectorClassOk + +`func (o *Source) GetConnectorClassOk() (*string, bool)` + +GetConnectorClassOk returns a tuple with the ConnectorClass field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorClass + +`func (o *Source) SetConnectorClass(v string)` + +SetConnectorClass sets ConnectorClass field to given value. + +### HasConnectorClass + +`func (o *Source) HasConnectorClass() bool` + +HasConnectorClass returns a boolean if a field has been set. + +### GetConnectorAttributes + +`func (o *Source) GetConnectorAttributes() map[string]interface{}` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *Source) GetConnectorAttributesOk() (*map[string]interface{}, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *Source) SetConnectorAttributes(v map[string]interface{})` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + +### HasConnectorAttributes + +`func (o *Source) HasConnectorAttributes() bool` + +HasConnectorAttributes returns a boolean if a field has been set. + +### GetDeleteThreshold + +`func (o *Source) GetDeleteThreshold() int32` + +GetDeleteThreshold returns the DeleteThreshold field if non-nil, zero value otherwise. + +### GetDeleteThresholdOk + +`func (o *Source) GetDeleteThresholdOk() (*int32, bool)` + +GetDeleteThresholdOk returns a tuple with the DeleteThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteThreshold + +`func (o *Source) SetDeleteThreshold(v int32)` + +SetDeleteThreshold sets DeleteThreshold field to given value. + +### HasDeleteThreshold + +`func (o *Source) HasDeleteThreshold() bool` + +HasDeleteThreshold returns a boolean if a field has been set. + +### GetAuthoritative + +`func (o *Source) GetAuthoritative() bool` + +GetAuthoritative returns the Authoritative field if non-nil, zero value otherwise. + +### GetAuthoritativeOk + +`func (o *Source) GetAuthoritativeOk() (*bool, bool)` + +GetAuthoritativeOk returns a tuple with the Authoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritative + +`func (o *Source) SetAuthoritative(v bool)` + +SetAuthoritative sets Authoritative field to given value. + +### HasAuthoritative + +`func (o *Source) HasAuthoritative() bool` + +HasAuthoritative returns a boolean if a field has been set. + +### GetManagementWorkgroup + +`func (o *Source) GetManagementWorkgroup() SourceManagementWorkgroup` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *Source) GetManagementWorkgroupOk() (*SourceManagementWorkgroup, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *Source) SetManagementWorkgroup(v SourceManagementWorkgroup)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *Source) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### SetManagementWorkgroupNil + +`func (o *Source) SetManagementWorkgroupNil(b bool)` + + SetManagementWorkgroupNil sets the value for ManagementWorkgroup to be an explicit nil + +### UnsetManagementWorkgroup +`func (o *Source) UnsetManagementWorkgroup()` + +UnsetManagementWorkgroup ensures that no value is present for ManagementWorkgroup, not even an explicit nil +### GetHealthy + +`func (o *Source) GetHealthy() bool` + +GetHealthy returns the Healthy field if non-nil, zero value otherwise. + +### GetHealthyOk + +`func (o *Source) GetHealthyOk() (*bool, bool)` + +GetHealthyOk returns a tuple with the Healthy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthy + +`func (o *Source) SetHealthy(v bool)` + +SetHealthy sets Healthy field to given value. + +### HasHealthy + +`func (o *Source) HasHealthy() bool` + +HasHealthy returns a boolean if a field has been set. + +### GetStatus + +`func (o *Source) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Source) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Source) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Source) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSince + +`func (o *Source) GetSince() string` + +GetSince returns the Since field if non-nil, zero value otherwise. + +### GetSinceOk + +`func (o *Source) GetSinceOk() (*string, bool)` + +GetSinceOk returns a tuple with the Since field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSince + +`func (o *Source) SetSince(v string)` + +SetSince sets Since field to given value. + +### HasSince + +`func (o *Source) HasSince() bool` + +HasSince returns a boolean if a field has been set. + +### GetConnectorId + +`func (o *Source) GetConnectorId() string` + +GetConnectorId returns the ConnectorId field if non-nil, zero value otherwise. + +### GetConnectorIdOk + +`func (o *Source) GetConnectorIdOk() (*string, bool)` + +GetConnectorIdOk returns a tuple with the ConnectorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorId + +`func (o *Source) SetConnectorId(v string)` + +SetConnectorId sets ConnectorId field to given value. + +### HasConnectorId + +`func (o *Source) HasConnectorId() bool` + +HasConnectorId returns a boolean if a field has been set. + +### GetConnectorName + +`func (o *Source) GetConnectorName() string` + +GetConnectorName returns the ConnectorName field if non-nil, zero value otherwise. + +### GetConnectorNameOk + +`func (o *Source) GetConnectorNameOk() (*string, bool)` + +GetConnectorNameOk returns a tuple with the ConnectorName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorName + +`func (o *Source) SetConnectorName(v string)` + +SetConnectorName sets ConnectorName field to given value. + +### HasConnectorName + +`func (o *Source) HasConnectorName() bool` + +HasConnectorName returns a boolean if a field has been set. + +### GetConnectionType + +`func (o *Source) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *Source) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *Source) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *Source) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + +### GetConnectorImplementationId + +`func (o *Source) GetConnectorImplementationId() string` + +GetConnectorImplementationId returns the ConnectorImplementationId field if non-nil, zero value otherwise. + +### GetConnectorImplementationIdOk + +`func (o *Source) GetConnectorImplementationIdOk() (*string, bool)` + +GetConnectorImplementationIdOk returns a tuple with the ConnectorImplementationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorImplementationId + +`func (o *Source) SetConnectorImplementationId(v string)` + +SetConnectorImplementationId sets ConnectorImplementationId field to given value. + +### HasConnectorImplementationId + +`func (o *Source) HasConnectorImplementationId() bool` + +HasConnectorImplementationId returns a boolean if a field has been set. + +### GetCreated + +`func (o *Source) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Source) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Source) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Source) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Source) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Source) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Source) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Source) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCredentialProviderEnabled + +`func (o *Source) GetCredentialProviderEnabled() bool` + +GetCredentialProviderEnabled returns the CredentialProviderEnabled field if non-nil, zero value otherwise. + +### GetCredentialProviderEnabledOk + +`func (o *Source) GetCredentialProviderEnabledOk() (*bool, bool)` + +GetCredentialProviderEnabledOk returns a tuple with the CredentialProviderEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialProviderEnabled + +`func (o *Source) SetCredentialProviderEnabled(v bool)` + +SetCredentialProviderEnabled sets CredentialProviderEnabled field to given value. + +### HasCredentialProviderEnabled + +`func (o *Source) HasCredentialProviderEnabled() bool` + +HasCredentialProviderEnabled returns a boolean if a field has been set. + +### GetCategory + +`func (o *Source) GetCategory() string` + +GetCategory returns the Category field if non-nil, zero value otherwise. + +### GetCategoryOk + +`func (o *Source) GetCategoryOk() (*string, bool)` + +GetCategoryOk returns a tuple with the Category field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCategory + +`func (o *Source) SetCategory(v string)` + +SetCategory sets Category field to given value. + +### HasCategory + +`func (o *Source) HasCategory() bool` + +HasCategory returns a boolean if a field has been set. + +### SetCategoryNil + +`func (o *Source) SetCategoryNil(b bool)` + + SetCategoryNil sets the value for Category to be an explicit nil + +### UnsetCategory +`func (o *Source) UnsetCategory()` + +UnsetCategory ensures that no value is present for Category, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Source1.md b/docs/tools/sdk/go/Reference/V2024/Models/Source1.md new file mode 100644 index 000000000..67bdb5681 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Source1.md @@ -0,0 +1,90 @@ +--- +id: v2024-source1 +title: Source1 +pagination_label: Source1 +sidebar_label: Source1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Source1', 'V2024Source1'] +slug: /tools/sdk/go/v2024/models/source1 +tags: ['SDK', 'Software Development Kit', 'Source1', 'V2024Source1'] +--- + +# Source1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Attribute mapping type. | [optional] +**Properties** | Pointer to **map[string]interface{}** | Attribute mapping properties. | [optional] + +## Methods + +### NewSource1 + +`func NewSource1() *Source1` + +NewSource1 instantiates a new Source1 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 + +### NewSource1WithDefaults + +`func NewSource1WithDefaults() *Source1` + +NewSource1WithDefaults instantiates a new Source1 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 + +### GetType + +`func (o *Source1) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Source1) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Source1) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Source1) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetProperties + +`func (o *Source1) GetProperties() map[string]interface{}` + +GetProperties returns the Properties field if non-nil, zero value otherwise. + +### GetPropertiesOk + +`func (o *Source1) GetPropertiesOk() (*map[string]interface{}, bool)` + +GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperties + +`func (o *Source1) SetProperties(v map[string]interface{})` + +SetProperties sets Properties field to given value. + +### HasProperties + +`func (o *Source1) HasProperties() bool` + +HasProperties returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountCorrelationConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountCorrelationConfig.md new file mode 100644 index 000000000..a2ba51897 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountCorrelationConfig.md @@ -0,0 +1,116 @@ +--- +id: v2024-source-account-correlation-config +title: SourceAccountCorrelationConfig +pagination_label: SourceAccountCorrelationConfig +sidebar_label: SourceAccountCorrelationConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountCorrelationConfig', 'V2024SourceAccountCorrelationConfig'] +slug: /tools/sdk/go/v2024/models/source-account-correlation-config +tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationConfig', 'V2024SourceAccountCorrelationConfig'] +--- + +# SourceAccountCorrelationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Account correlation config ID. | [optional] +**Name** | Pointer to **string** | Account correlation config's human-readable display name. | [optional] + +## Methods + +### NewSourceAccountCorrelationConfig + +`func NewSourceAccountCorrelationConfig() *SourceAccountCorrelationConfig` + +NewSourceAccountCorrelationConfig instantiates a new SourceAccountCorrelationConfig 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 + +### NewSourceAccountCorrelationConfigWithDefaults + +`func NewSourceAccountCorrelationConfigWithDefaults() *SourceAccountCorrelationConfig` + +NewSourceAccountCorrelationConfigWithDefaults instantiates a new SourceAccountCorrelationConfig 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 + +### GetType + +`func (o *SourceAccountCorrelationConfig) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceAccountCorrelationConfig) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceAccountCorrelationConfig) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceAccountCorrelationConfig) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceAccountCorrelationConfig) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountCorrelationConfig) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountCorrelationConfig) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceAccountCorrelationConfig) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAccountCorrelationConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAccountCorrelationConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAccountCorrelationConfig) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAccountCorrelationConfig) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountCorrelationRule.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountCorrelationRule.md new file mode 100644 index 000000000..6e0e75e17 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountCorrelationRule.md @@ -0,0 +1,116 @@ +--- +id: v2024-source-account-correlation-rule +title: SourceAccountCorrelationRule +pagination_label: SourceAccountCorrelationRule +sidebar_label: SourceAccountCorrelationRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountCorrelationRule', 'V2024SourceAccountCorrelationRule'] +slug: /tools/sdk/go/v2024/models/source-account-correlation-rule +tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationRule', 'V2024SourceAccountCorrelationRule'] +--- + +# SourceAccountCorrelationRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Rule ID. | [optional] +**Name** | Pointer to **string** | Rule's human-readable display name. | [optional] + +## Methods + +### NewSourceAccountCorrelationRule + +`func NewSourceAccountCorrelationRule() *SourceAccountCorrelationRule` + +NewSourceAccountCorrelationRule instantiates a new SourceAccountCorrelationRule 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 + +### NewSourceAccountCorrelationRuleWithDefaults + +`func NewSourceAccountCorrelationRuleWithDefaults() *SourceAccountCorrelationRule` + +NewSourceAccountCorrelationRuleWithDefaults instantiates a new SourceAccountCorrelationRule 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 + +### GetType + +`func (o *SourceAccountCorrelationRule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceAccountCorrelationRule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceAccountCorrelationRule) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceAccountCorrelationRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceAccountCorrelationRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountCorrelationRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountCorrelationRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceAccountCorrelationRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAccountCorrelationRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAccountCorrelationRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAccountCorrelationRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAccountCorrelationRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountCreated.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountCreated.md new file mode 100644 index 000000000..a8c3ca825 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountCreated.md @@ -0,0 +1,211 @@ +--- +id: v2024-source-account-created +title: SourceAccountCreated +pagination_label: SourceAccountCreated +sidebar_label: SourceAccountCreated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountCreated', 'V2024SourceAccountCreated'] +slug: /tools/sdk/go/v2024/models/source-account-created +tags: ['SDK', 'Software Development Kit', 'SourceAccountCreated', 'V2024SourceAccountCreated'] +--- + +# SourceAccountCreated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | Pointer to **string** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**Id** | **string** | SailPoint generated unique identifier. | +**NativeIdentifier** | **string** | Unique ID of the account on the source. | +**SourceId** | **string** | The ID of the source. | +**SourceName** | **string** | The name of the source. | +**IdentityId** | **string** | The ID of the identity that is correlated with this account. | +**IdentityName** | **string** | The name of the identity that is correlated with this account. | +**Attributes** | **map[string]interface{}** | The attributes of the account. The contents of attributes depends on the account schema for the source. | + +## Methods + +### NewSourceAccountCreated + +`func NewSourceAccountCreated(id string, nativeIdentifier string, sourceId string, sourceName string, identityId string, identityName string, attributes map[string]interface{}, ) *SourceAccountCreated` + +NewSourceAccountCreated instantiates a new SourceAccountCreated 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 + +### NewSourceAccountCreatedWithDefaults + +`func NewSourceAccountCreatedWithDefaults() *SourceAccountCreated` + +NewSourceAccountCreatedWithDefaults instantiates a new SourceAccountCreated 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 + +### GetUuid + +`func (o *SourceAccountCreated) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *SourceAccountCreated) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *SourceAccountCreated) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *SourceAccountCreated) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### GetId + +`func (o *SourceAccountCreated) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountCreated) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountCreated) SetId(v string)` + +SetId sets Id field to given value. + + +### GetNativeIdentifier + +`func (o *SourceAccountCreated) GetNativeIdentifier() string` + +GetNativeIdentifier returns the NativeIdentifier field if non-nil, zero value otherwise. + +### GetNativeIdentifierOk + +`func (o *SourceAccountCreated) GetNativeIdentifierOk() (*string, bool)` + +GetNativeIdentifierOk returns a tuple with the NativeIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentifier + +`func (o *SourceAccountCreated) SetNativeIdentifier(v string)` + +SetNativeIdentifier sets NativeIdentifier field to given value. + + +### GetSourceId + +`func (o *SourceAccountCreated) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *SourceAccountCreated) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *SourceAccountCreated) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetSourceName + +`func (o *SourceAccountCreated) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *SourceAccountCreated) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *SourceAccountCreated) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### GetIdentityId + +`func (o *SourceAccountCreated) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *SourceAccountCreated) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *SourceAccountCreated) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetIdentityName + +`func (o *SourceAccountCreated) GetIdentityName() string` + +GetIdentityName returns the IdentityName field if non-nil, zero value otherwise. + +### GetIdentityNameOk + +`func (o *SourceAccountCreated) GetIdentityNameOk() (*string, bool)` + +GetIdentityNameOk returns a tuple with the IdentityName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityName + +`func (o *SourceAccountCreated) SetIdentityName(v string)` + +SetIdentityName sets IdentityName field to given value. + + +### GetAttributes + +`func (o *SourceAccountCreated) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *SourceAccountCreated) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *SourceAccountCreated) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountDeleted.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountDeleted.md new file mode 100644 index 000000000..cb7c03ab6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountDeleted.md @@ -0,0 +1,211 @@ +--- +id: v2024-source-account-deleted +title: SourceAccountDeleted +pagination_label: SourceAccountDeleted +sidebar_label: SourceAccountDeleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountDeleted', 'V2024SourceAccountDeleted'] +slug: /tools/sdk/go/v2024/models/source-account-deleted +tags: ['SDK', 'Software Development Kit', 'SourceAccountDeleted', 'V2024SourceAccountDeleted'] +--- + +# SourceAccountDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | Pointer to **string** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**Id** | **string** | SailPoint generated unique identifier. | +**NativeIdentifier** | **string** | Unique ID of the account on the source. | +**SourceId** | **string** | The ID of the source. | +**SourceName** | **string** | The name of the source. | +**IdentityId** | **string** | The ID of the identity that is correlated with this account. | +**IdentityName** | **string** | The name of the identity that is correlated with this account. | +**Attributes** | **map[string]interface{}** | The attributes of the account. The contents of attributes depends on the account schema for the source. | + +## Methods + +### NewSourceAccountDeleted + +`func NewSourceAccountDeleted(id string, nativeIdentifier string, sourceId string, sourceName string, identityId string, identityName string, attributes map[string]interface{}, ) *SourceAccountDeleted` + +NewSourceAccountDeleted instantiates a new SourceAccountDeleted 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 + +### NewSourceAccountDeletedWithDefaults + +`func NewSourceAccountDeletedWithDefaults() *SourceAccountDeleted` + +NewSourceAccountDeletedWithDefaults instantiates a new SourceAccountDeleted 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 + +### GetUuid + +`func (o *SourceAccountDeleted) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *SourceAccountDeleted) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *SourceAccountDeleted) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *SourceAccountDeleted) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### GetId + +`func (o *SourceAccountDeleted) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountDeleted) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountDeleted) SetId(v string)` + +SetId sets Id field to given value. + + +### GetNativeIdentifier + +`func (o *SourceAccountDeleted) GetNativeIdentifier() string` + +GetNativeIdentifier returns the NativeIdentifier field if non-nil, zero value otherwise. + +### GetNativeIdentifierOk + +`func (o *SourceAccountDeleted) GetNativeIdentifierOk() (*string, bool)` + +GetNativeIdentifierOk returns a tuple with the NativeIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentifier + +`func (o *SourceAccountDeleted) SetNativeIdentifier(v string)` + +SetNativeIdentifier sets NativeIdentifier field to given value. + + +### GetSourceId + +`func (o *SourceAccountDeleted) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *SourceAccountDeleted) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *SourceAccountDeleted) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetSourceName + +`func (o *SourceAccountDeleted) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *SourceAccountDeleted) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *SourceAccountDeleted) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### GetIdentityId + +`func (o *SourceAccountDeleted) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *SourceAccountDeleted) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *SourceAccountDeleted) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetIdentityName + +`func (o *SourceAccountDeleted) GetIdentityName() string` + +GetIdentityName returns the IdentityName field if non-nil, zero value otherwise. + +### GetIdentityNameOk + +`func (o *SourceAccountDeleted) GetIdentityNameOk() (*string, bool)` + +GetIdentityNameOk returns a tuple with the IdentityName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityName + +`func (o *SourceAccountDeleted) SetIdentityName(v string)` + +SetIdentityName sets IdentityName field to given value. + + +### GetAttributes + +`func (o *SourceAccountDeleted) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *SourceAccountDeleted) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *SourceAccountDeleted) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountSelections.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountSelections.md new file mode 100644 index 000000000..307f17e90 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountSelections.md @@ -0,0 +1,142 @@ +--- +id: v2024-source-account-selections +title: SourceAccountSelections +pagination_label: SourceAccountSelections +sidebar_label: SourceAccountSelections +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountSelections', 'V2024SourceAccountSelections'] +slug: /tools/sdk/go/v2024/models/source-account-selections +tags: ['SDK', 'Software Development Kit', 'SourceAccountSelections', 'V2024SourceAccountSelections'] +--- + +# SourceAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | The source id | [optional] +**Name** | Pointer to **string** | The source name | [optional] +**Accounts** | Pointer to [**[]AccountInfoRef**](account-info-ref) | The accounts information for a particular source in the requested item | [optional] + +## Methods + +### NewSourceAccountSelections + +`func NewSourceAccountSelections() *SourceAccountSelections` + +NewSourceAccountSelections instantiates a new SourceAccountSelections 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 + +### NewSourceAccountSelectionsWithDefaults + +`func NewSourceAccountSelectionsWithDefaults() *SourceAccountSelections` + +NewSourceAccountSelectionsWithDefaults instantiates a new SourceAccountSelections 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 + +### GetType + +`func (o *SourceAccountSelections) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceAccountSelections) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceAccountSelections) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceAccountSelections) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceAccountSelections) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountSelections) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountSelections) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceAccountSelections) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAccountSelections) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAccountSelections) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAccountSelections) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAccountSelections) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAccounts + +`func (o *SourceAccountSelections) GetAccounts() []AccountInfoRef` + +GetAccounts returns the Accounts field if non-nil, zero value otherwise. + +### GetAccountsOk + +`func (o *SourceAccountSelections) GetAccountsOk() (*[]AccountInfoRef, bool)` + +GetAccountsOk returns a tuple with the Accounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccounts + +`func (o *SourceAccountSelections) SetAccounts(v []AccountInfoRef)` + +SetAccounts sets Accounts field to given value. + +### HasAccounts + +`func (o *SourceAccountSelections) HasAccounts() bool` + +HasAccounts returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountUpdated.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountUpdated.md new file mode 100644 index 000000000..ead7e33ae --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceAccountUpdated.md @@ -0,0 +1,211 @@ +--- +id: v2024-source-account-updated +title: SourceAccountUpdated +pagination_label: SourceAccountUpdated +sidebar_label: SourceAccountUpdated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountUpdated', 'V2024SourceAccountUpdated'] +slug: /tools/sdk/go/v2024/models/source-account-updated +tags: ['SDK', 'Software Development Kit', 'SourceAccountUpdated', 'V2024SourceAccountUpdated'] +--- + +# SourceAccountUpdated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | Pointer to **string** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**Id** | **string** | SailPoint generated unique identifier. | +**NativeIdentifier** | **string** | Unique ID of the account on the source. | +**SourceId** | **string** | The ID of the source. | +**SourceName** | **string** | The name of the source. | +**IdentityId** | **string** | The ID of the identity that is correlated with this account. | +**IdentityName** | **string** | The name of the identity that is correlated with this account. | +**Attributes** | **map[string]interface{}** | The attributes of the account. The contents of attributes depends on the account schema for the source. | + +## Methods + +### NewSourceAccountUpdated + +`func NewSourceAccountUpdated(id string, nativeIdentifier string, sourceId string, sourceName string, identityId string, identityName string, attributes map[string]interface{}, ) *SourceAccountUpdated` + +NewSourceAccountUpdated instantiates a new SourceAccountUpdated 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 + +### NewSourceAccountUpdatedWithDefaults + +`func NewSourceAccountUpdatedWithDefaults() *SourceAccountUpdated` + +NewSourceAccountUpdatedWithDefaults instantiates a new SourceAccountUpdated 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 + +### GetUuid + +`func (o *SourceAccountUpdated) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *SourceAccountUpdated) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *SourceAccountUpdated) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *SourceAccountUpdated) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### GetId + +`func (o *SourceAccountUpdated) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountUpdated) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountUpdated) SetId(v string)` + +SetId sets Id field to given value. + + +### GetNativeIdentifier + +`func (o *SourceAccountUpdated) GetNativeIdentifier() string` + +GetNativeIdentifier returns the NativeIdentifier field if non-nil, zero value otherwise. + +### GetNativeIdentifierOk + +`func (o *SourceAccountUpdated) GetNativeIdentifierOk() (*string, bool)` + +GetNativeIdentifierOk returns a tuple with the NativeIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentifier + +`func (o *SourceAccountUpdated) SetNativeIdentifier(v string)` + +SetNativeIdentifier sets NativeIdentifier field to given value. + + +### GetSourceId + +`func (o *SourceAccountUpdated) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *SourceAccountUpdated) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *SourceAccountUpdated) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetSourceName + +`func (o *SourceAccountUpdated) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *SourceAccountUpdated) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *SourceAccountUpdated) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### GetIdentityId + +`func (o *SourceAccountUpdated) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *SourceAccountUpdated) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *SourceAccountUpdated) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetIdentityName + +`func (o *SourceAccountUpdated) GetIdentityName() string` + +GetIdentityName returns the IdentityName field if non-nil, zero value otherwise. + +### GetIdentityNameOk + +`func (o *SourceAccountUpdated) GetIdentityNameOk() (*string, bool)` + +GetIdentityNameOk returns a tuple with the IdentityName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityName + +`func (o *SourceAccountUpdated) SetIdentityName(v string)` + +SetIdentityName sets IdentityName field to given value. + + +### GetAttributes + +`func (o *SourceAccountUpdated) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *SourceAccountUpdated) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *SourceAccountUpdated) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceApp.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceApp.md new file mode 100644 index 000000000..7a972e53c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceApp.md @@ -0,0 +1,370 @@ +--- +id: v2024-source-app +title: SourceApp +pagination_label: SourceApp +sidebar_label: SourceApp +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceApp', 'V2024SourceApp'] +slug: /tools/sdk/go/v2024/models/source-app +tags: ['SDK', 'Software Development Kit', 'SourceApp', 'V2024SourceApp'] +--- + +# SourceApp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The source app id | [optional] +**CloudAppId** | Pointer to **string** | The deprecated source app id | [optional] +**Name** | Pointer to **string** | The source app name | [optional] +**Created** | Pointer to **SailPointTime** | Time when the source app was created | [optional] +**Modified** | Pointer to **SailPointTime** | Time when the source app was last modified | [optional] +**Enabled** | Pointer to **bool** | True if the source app is enabled | [optional] [default to false] +**ProvisionRequestEnabled** | Pointer to **bool** | True if the source app is provision request enabled | [optional] [default to false] +**Description** | Pointer to **string** | The description of the source app | [optional] +**MatchAllAccounts** | Pointer to **bool** | True if the source app match all accounts | [optional] [default to false] +**AppCenterEnabled** | Pointer to **bool** | True if the source app is shown in the app center | [optional] [default to true] +**AccountSource** | Pointer to [**NullableSourceAppAccountSource**](source-app-account-source) | | [optional] +**Owner** | Pointer to [**NullableBaseReferenceDto**](base-reference-dto) | The owner of source app | [optional] + +## Methods + +### NewSourceApp + +`func NewSourceApp() *SourceApp` + +NewSourceApp instantiates a new SourceApp 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 + +### NewSourceAppWithDefaults + +`func NewSourceAppWithDefaults() *SourceApp` + +NewSourceAppWithDefaults instantiates a new SourceApp 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 + +### GetId + +`func (o *SourceApp) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceApp) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceApp) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceApp) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCloudAppId + +`func (o *SourceApp) GetCloudAppId() string` + +GetCloudAppId returns the CloudAppId field if non-nil, zero value otherwise. + +### GetCloudAppIdOk + +`func (o *SourceApp) GetCloudAppIdOk() (*string, bool)` + +GetCloudAppIdOk returns a tuple with the CloudAppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudAppId + +`func (o *SourceApp) SetCloudAppId(v string)` + +SetCloudAppId sets CloudAppId field to given value. + +### HasCloudAppId + +`func (o *SourceApp) HasCloudAppId() bool` + +HasCloudAppId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceApp) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceApp) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceApp) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceApp) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *SourceApp) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SourceApp) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SourceApp) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SourceApp) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SourceApp) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SourceApp) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SourceApp) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SourceApp) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetEnabled + +`func (o *SourceApp) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *SourceApp) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *SourceApp) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *SourceApp) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetProvisionRequestEnabled + +`func (o *SourceApp) GetProvisionRequestEnabled() bool` + +GetProvisionRequestEnabled returns the ProvisionRequestEnabled field if non-nil, zero value otherwise. + +### GetProvisionRequestEnabledOk + +`func (o *SourceApp) GetProvisionRequestEnabledOk() (*bool, bool)` + +GetProvisionRequestEnabledOk returns a tuple with the ProvisionRequestEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionRequestEnabled + +`func (o *SourceApp) SetProvisionRequestEnabled(v bool)` + +SetProvisionRequestEnabled sets ProvisionRequestEnabled field to given value. + +### HasProvisionRequestEnabled + +`func (o *SourceApp) HasProvisionRequestEnabled() bool` + +HasProvisionRequestEnabled returns a boolean if a field has been set. + +### GetDescription + +`func (o *SourceApp) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SourceApp) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SourceApp) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SourceApp) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetMatchAllAccounts + +`func (o *SourceApp) GetMatchAllAccounts() bool` + +GetMatchAllAccounts returns the MatchAllAccounts field if non-nil, zero value otherwise. + +### GetMatchAllAccountsOk + +`func (o *SourceApp) GetMatchAllAccountsOk() (*bool, bool)` + +GetMatchAllAccountsOk returns a tuple with the MatchAllAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAllAccounts + +`func (o *SourceApp) SetMatchAllAccounts(v bool)` + +SetMatchAllAccounts sets MatchAllAccounts field to given value. + +### HasMatchAllAccounts + +`func (o *SourceApp) HasMatchAllAccounts() bool` + +HasMatchAllAccounts returns a boolean if a field has been set. + +### GetAppCenterEnabled + +`func (o *SourceApp) GetAppCenterEnabled() bool` + +GetAppCenterEnabled returns the AppCenterEnabled field if non-nil, zero value otherwise. + +### GetAppCenterEnabledOk + +`func (o *SourceApp) GetAppCenterEnabledOk() (*bool, bool)` + +GetAppCenterEnabledOk returns a tuple with the AppCenterEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppCenterEnabled + +`func (o *SourceApp) SetAppCenterEnabled(v bool)` + +SetAppCenterEnabled sets AppCenterEnabled field to given value. + +### HasAppCenterEnabled + +`func (o *SourceApp) HasAppCenterEnabled() bool` + +HasAppCenterEnabled returns a boolean if a field has been set. + +### GetAccountSource + +`func (o *SourceApp) GetAccountSource() SourceAppAccountSource` + +GetAccountSource returns the AccountSource field if non-nil, zero value otherwise. + +### GetAccountSourceOk + +`func (o *SourceApp) GetAccountSourceOk() (*SourceAppAccountSource, bool)` + +GetAccountSourceOk returns a tuple with the AccountSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSource + +`func (o *SourceApp) SetAccountSource(v SourceAppAccountSource)` + +SetAccountSource sets AccountSource field to given value. + +### HasAccountSource + +`func (o *SourceApp) HasAccountSource() bool` + +HasAccountSource returns a boolean if a field has been set. + +### SetAccountSourceNil + +`func (o *SourceApp) SetAccountSourceNil(b bool)` + + SetAccountSourceNil sets the value for AccountSource to be an explicit nil + +### UnsetAccountSource +`func (o *SourceApp) UnsetAccountSource()` + +UnsetAccountSource ensures that no value is present for AccountSource, not even an explicit nil +### GetOwner + +`func (o *SourceApp) GetOwner() BaseReferenceDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *SourceApp) GetOwnerOk() (*BaseReferenceDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *SourceApp) SetOwner(v BaseReferenceDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *SourceApp) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *SourceApp) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *SourceApp) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceAppAccountSource.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceAppAccountSource.md new file mode 100644 index 000000000..dc6d9812d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceAppAccountSource.md @@ -0,0 +1,178 @@ +--- +id: v2024-source-app-account-source +title: SourceAppAccountSource +pagination_label: SourceAppAccountSource +sidebar_label: SourceAppAccountSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAppAccountSource', 'V2024SourceAppAccountSource'] +slug: /tools/sdk/go/v2024/models/source-app-account-source +tags: ['SDK', 'Software Development Kit', 'SourceAppAccountSource', 'V2024SourceAppAccountSource'] +--- + +# SourceAppAccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The source ID | [optional] +**Type** | Pointer to **string** | The source type, will always be \"SOURCE\" | [optional] +**Name** | Pointer to **string** | The source name | [optional] +**UseForPasswordManagement** | Pointer to **bool** | If the source is used for password management | [optional] [default to false] +**PasswordPolicies** | Pointer to [**[]BaseReferenceDto**](base-reference-dto) | The password policies for the source | [optional] + +## Methods + +### NewSourceAppAccountSource + +`func NewSourceAppAccountSource() *SourceAppAccountSource` + +NewSourceAppAccountSource instantiates a new SourceAppAccountSource 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 + +### NewSourceAppAccountSourceWithDefaults + +`func NewSourceAppAccountSourceWithDefaults() *SourceAppAccountSource` + +NewSourceAppAccountSourceWithDefaults instantiates a new SourceAppAccountSource 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 + +### GetId + +`func (o *SourceAppAccountSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAppAccountSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAppAccountSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceAppAccountSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *SourceAppAccountSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceAppAccountSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceAppAccountSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceAppAccountSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAppAccountSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAppAccountSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAppAccountSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAppAccountSource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetUseForPasswordManagement + +`func (o *SourceAppAccountSource) GetUseForPasswordManagement() bool` + +GetUseForPasswordManagement returns the UseForPasswordManagement field if non-nil, zero value otherwise. + +### GetUseForPasswordManagementOk + +`func (o *SourceAppAccountSource) GetUseForPasswordManagementOk() (*bool, bool)` + +GetUseForPasswordManagementOk returns a tuple with the UseForPasswordManagement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseForPasswordManagement + +`func (o *SourceAppAccountSource) SetUseForPasswordManagement(v bool)` + +SetUseForPasswordManagement sets UseForPasswordManagement field to given value. + +### HasUseForPasswordManagement + +`func (o *SourceAppAccountSource) HasUseForPasswordManagement() bool` + +HasUseForPasswordManagement returns a boolean if a field has been set. + +### GetPasswordPolicies + +`func (o *SourceAppAccountSource) GetPasswordPolicies() []BaseReferenceDto` + +GetPasswordPolicies returns the PasswordPolicies field if non-nil, zero value otherwise. + +### GetPasswordPoliciesOk + +`func (o *SourceAppAccountSource) GetPasswordPoliciesOk() (*[]BaseReferenceDto, bool)` + +GetPasswordPoliciesOk returns a tuple with the PasswordPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicies + +`func (o *SourceAppAccountSource) SetPasswordPolicies(v []BaseReferenceDto)` + +SetPasswordPolicies sets PasswordPolicies field to given value. + +### HasPasswordPolicies + +`func (o *SourceAppAccountSource) HasPasswordPolicies() bool` + +HasPasswordPolicies returns a boolean if a field has been set. + +### SetPasswordPoliciesNil + +`func (o *SourceAppAccountSource) SetPasswordPoliciesNil(b bool)` + + SetPasswordPoliciesNil sets the value for PasswordPolicies to be an explicit nil + +### UnsetPasswordPolicies +`func (o *SourceAppAccountSource) UnsetPasswordPolicies()` + +UnsetPasswordPolicies ensures that no value is present for PasswordPolicies, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceAppBulkUpdateRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceAppBulkUpdateRequest.md new file mode 100644 index 000000000..4e4ad49f8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceAppBulkUpdateRequest.md @@ -0,0 +1,80 @@ +--- +id: v2024-source-app-bulk-update-request +title: SourceAppBulkUpdateRequest +pagination_label: SourceAppBulkUpdateRequest +sidebar_label: SourceAppBulkUpdateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAppBulkUpdateRequest', 'V2024SourceAppBulkUpdateRequest'] +slug: /tools/sdk/go/v2024/models/source-app-bulk-update-request +tags: ['SDK', 'Software Development Kit', 'SourceAppBulkUpdateRequest', 'V2024SourceAppBulkUpdateRequest'] +--- + +# SourceAppBulkUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AppIds** | **[]string** | List of source app ids to update | +**JsonPatch** | [**[]JsonPatchOperation**](json-patch-operation) | The JSONPatch payload used to update the source app. | + +## Methods + +### NewSourceAppBulkUpdateRequest + +`func NewSourceAppBulkUpdateRequest(appIds []string, jsonPatch []JsonPatchOperation, ) *SourceAppBulkUpdateRequest` + +NewSourceAppBulkUpdateRequest instantiates a new SourceAppBulkUpdateRequest 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 + +### NewSourceAppBulkUpdateRequestWithDefaults + +`func NewSourceAppBulkUpdateRequestWithDefaults() *SourceAppBulkUpdateRequest` + +NewSourceAppBulkUpdateRequestWithDefaults instantiates a new SourceAppBulkUpdateRequest 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 + +### GetAppIds + +`func (o *SourceAppBulkUpdateRequest) GetAppIds() []string` + +GetAppIds returns the AppIds field if non-nil, zero value otherwise. + +### GetAppIdsOk + +`func (o *SourceAppBulkUpdateRequest) GetAppIdsOk() (*[]string, bool)` + +GetAppIdsOk returns a tuple with the AppIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppIds + +`func (o *SourceAppBulkUpdateRequest) SetAppIds(v []string)` + +SetAppIds sets AppIds field to given value. + + +### GetJsonPatch + +`func (o *SourceAppBulkUpdateRequest) GetJsonPatch() []JsonPatchOperation` + +GetJsonPatch returns the JsonPatch field if non-nil, zero value otherwise. + +### GetJsonPatchOk + +`func (o *SourceAppBulkUpdateRequest) GetJsonPatchOk() (*[]JsonPatchOperation, bool)` + +GetJsonPatchOk returns a tuple with the JsonPatch field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJsonPatch + +`func (o *SourceAppBulkUpdateRequest) SetJsonPatch(v []JsonPatchOperation)` + +SetJsonPatch sets JsonPatch field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceAppCreateDto.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceAppCreateDto.md new file mode 100644 index 000000000..7a71cff41 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceAppCreateDto.md @@ -0,0 +1,127 @@ +--- +id: v2024-source-app-create-dto +title: SourceAppCreateDto +pagination_label: SourceAppCreateDto +sidebar_label: SourceAppCreateDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAppCreateDto', 'V2024SourceAppCreateDto'] +slug: /tools/sdk/go/v2024/models/source-app-create-dto +tags: ['SDK', 'Software Development Kit', 'SourceAppCreateDto', 'V2024SourceAppCreateDto'] +--- + +# SourceAppCreateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The source app name | +**Description** | **string** | The description of the source app | +**MatchAllAccounts** | Pointer to **bool** | True if the source app match all accounts | [optional] [default to false] +**AccountSource** | [**SourceAppCreateDtoAccountSource**](source-app-create-dto-account-source) | | + +## Methods + +### NewSourceAppCreateDto + +`func NewSourceAppCreateDto(name string, description string, accountSource SourceAppCreateDtoAccountSource, ) *SourceAppCreateDto` + +NewSourceAppCreateDto instantiates a new SourceAppCreateDto 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 + +### NewSourceAppCreateDtoWithDefaults + +`func NewSourceAppCreateDtoWithDefaults() *SourceAppCreateDto` + +NewSourceAppCreateDtoWithDefaults instantiates a new SourceAppCreateDto 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 + +### GetName + +`func (o *SourceAppCreateDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAppCreateDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAppCreateDto) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *SourceAppCreateDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SourceAppCreateDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SourceAppCreateDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetMatchAllAccounts + +`func (o *SourceAppCreateDto) GetMatchAllAccounts() bool` + +GetMatchAllAccounts returns the MatchAllAccounts field if non-nil, zero value otherwise. + +### GetMatchAllAccountsOk + +`func (o *SourceAppCreateDto) GetMatchAllAccountsOk() (*bool, bool)` + +GetMatchAllAccountsOk returns a tuple with the MatchAllAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAllAccounts + +`func (o *SourceAppCreateDto) SetMatchAllAccounts(v bool)` + +SetMatchAllAccounts sets MatchAllAccounts field to given value. + +### HasMatchAllAccounts + +`func (o *SourceAppCreateDto) HasMatchAllAccounts() bool` + +HasMatchAllAccounts returns a boolean if a field has been set. + +### GetAccountSource + +`func (o *SourceAppCreateDto) GetAccountSource() SourceAppCreateDtoAccountSource` + +GetAccountSource returns the AccountSource field if non-nil, zero value otherwise. + +### GetAccountSourceOk + +`func (o *SourceAppCreateDto) GetAccountSourceOk() (*SourceAppCreateDtoAccountSource, bool)` + +GetAccountSourceOk returns a tuple with the AccountSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSource + +`func (o *SourceAppCreateDto) SetAccountSource(v SourceAppCreateDtoAccountSource)` + +SetAccountSource sets AccountSource field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceAppCreateDtoAccountSource.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceAppCreateDtoAccountSource.md new file mode 100644 index 000000000..ccae04a1b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceAppCreateDtoAccountSource.md @@ -0,0 +1,111 @@ +--- +id: v2024-source-app-create-dto-account-source +title: SourceAppCreateDtoAccountSource +pagination_label: SourceAppCreateDtoAccountSource +sidebar_label: SourceAppCreateDtoAccountSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAppCreateDtoAccountSource', 'V2024SourceAppCreateDtoAccountSource'] +slug: /tools/sdk/go/v2024/models/source-app-create-dto-account-source +tags: ['SDK', 'Software Development Kit', 'SourceAppCreateDtoAccountSource', 'V2024SourceAppCreateDtoAccountSource'] +--- + +# SourceAppCreateDtoAccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The source ID | +**Type** | Pointer to **string** | The source type, will always be \"SOURCE\" | [optional] +**Name** | Pointer to **string** | The source name | [optional] + +## Methods + +### NewSourceAppCreateDtoAccountSource + +`func NewSourceAppCreateDtoAccountSource(id string, ) *SourceAppCreateDtoAccountSource` + +NewSourceAppCreateDtoAccountSource instantiates a new SourceAppCreateDtoAccountSource 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 + +### NewSourceAppCreateDtoAccountSourceWithDefaults + +`func NewSourceAppCreateDtoAccountSourceWithDefaults() *SourceAppCreateDtoAccountSource` + +NewSourceAppCreateDtoAccountSourceWithDefaults instantiates a new SourceAppCreateDtoAccountSource 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 + +### GetId + +`func (o *SourceAppCreateDtoAccountSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAppCreateDtoAccountSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAppCreateDtoAccountSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *SourceAppCreateDtoAccountSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceAppCreateDtoAccountSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceAppCreateDtoAccountSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceAppCreateDtoAccountSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAppCreateDtoAccountSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAppCreateDtoAccountSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAppCreateDtoAccountSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAppCreateDtoAccountSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceAppPatchDto.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceAppPatchDto.md new file mode 100644 index 000000000..e835514f0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceAppPatchDto.md @@ -0,0 +1,406 @@ +--- +id: v2024-source-app-patch-dto +title: SourceAppPatchDto +pagination_label: SourceAppPatchDto +sidebar_label: SourceAppPatchDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAppPatchDto', 'V2024SourceAppPatchDto'] +slug: /tools/sdk/go/v2024/models/source-app-patch-dto +tags: ['SDK', 'Software Development Kit', 'SourceAppPatchDto', 'V2024SourceAppPatchDto'] +--- + +# SourceAppPatchDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The source app id | [optional] +**CloudAppId** | Pointer to **string** | The deprecated source app id | [optional] +**Name** | Pointer to **string** | The source app name | [optional] +**Created** | Pointer to **SailPointTime** | Time when the source app was created | [optional] +**Modified** | Pointer to **SailPointTime** | Time when the source app was last modified | [optional] +**Enabled** | Pointer to **bool** | True if the source app is enabled | [optional] [default to false] +**ProvisionRequestEnabled** | Pointer to **bool** | True if the source app is provision request enabled | [optional] [default to false] +**Description** | Pointer to **string** | The description of the source app | [optional] +**MatchAllAccounts** | Pointer to **bool** | True if the source app match all accounts | [optional] [default to false] +**AppCenterEnabled** | Pointer to **bool** | True if the source app is shown in the app center | [optional] [default to true] +**AccessProfiles** | Pointer to **[]string** | List of IDs of access profiles | [optional] +**AccountSource** | Pointer to [**NullableSourceAppAccountSource**](source-app-account-source) | | [optional] +**Owner** | Pointer to [**NullableBaseReferenceDto**](base-reference-dto) | The owner of source app | [optional] + +## Methods + +### NewSourceAppPatchDto + +`func NewSourceAppPatchDto() *SourceAppPatchDto` + +NewSourceAppPatchDto instantiates a new SourceAppPatchDto 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 + +### NewSourceAppPatchDtoWithDefaults + +`func NewSourceAppPatchDtoWithDefaults() *SourceAppPatchDto` + +NewSourceAppPatchDtoWithDefaults instantiates a new SourceAppPatchDto 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 + +### GetId + +`func (o *SourceAppPatchDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAppPatchDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAppPatchDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceAppPatchDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCloudAppId + +`func (o *SourceAppPatchDto) GetCloudAppId() string` + +GetCloudAppId returns the CloudAppId field if non-nil, zero value otherwise. + +### GetCloudAppIdOk + +`func (o *SourceAppPatchDto) GetCloudAppIdOk() (*string, bool)` + +GetCloudAppIdOk returns a tuple with the CloudAppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudAppId + +`func (o *SourceAppPatchDto) SetCloudAppId(v string)` + +SetCloudAppId sets CloudAppId field to given value. + +### HasCloudAppId + +`func (o *SourceAppPatchDto) HasCloudAppId() bool` + +HasCloudAppId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAppPatchDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAppPatchDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAppPatchDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAppPatchDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *SourceAppPatchDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SourceAppPatchDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SourceAppPatchDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SourceAppPatchDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SourceAppPatchDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SourceAppPatchDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SourceAppPatchDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SourceAppPatchDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetEnabled + +`func (o *SourceAppPatchDto) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *SourceAppPatchDto) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *SourceAppPatchDto) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *SourceAppPatchDto) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetProvisionRequestEnabled + +`func (o *SourceAppPatchDto) GetProvisionRequestEnabled() bool` + +GetProvisionRequestEnabled returns the ProvisionRequestEnabled field if non-nil, zero value otherwise. + +### GetProvisionRequestEnabledOk + +`func (o *SourceAppPatchDto) GetProvisionRequestEnabledOk() (*bool, bool)` + +GetProvisionRequestEnabledOk returns a tuple with the ProvisionRequestEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionRequestEnabled + +`func (o *SourceAppPatchDto) SetProvisionRequestEnabled(v bool)` + +SetProvisionRequestEnabled sets ProvisionRequestEnabled field to given value. + +### HasProvisionRequestEnabled + +`func (o *SourceAppPatchDto) HasProvisionRequestEnabled() bool` + +HasProvisionRequestEnabled returns a boolean if a field has been set. + +### GetDescription + +`func (o *SourceAppPatchDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SourceAppPatchDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SourceAppPatchDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SourceAppPatchDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetMatchAllAccounts + +`func (o *SourceAppPatchDto) GetMatchAllAccounts() bool` + +GetMatchAllAccounts returns the MatchAllAccounts field if non-nil, zero value otherwise. + +### GetMatchAllAccountsOk + +`func (o *SourceAppPatchDto) GetMatchAllAccountsOk() (*bool, bool)` + +GetMatchAllAccountsOk returns a tuple with the MatchAllAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAllAccounts + +`func (o *SourceAppPatchDto) SetMatchAllAccounts(v bool)` + +SetMatchAllAccounts sets MatchAllAccounts field to given value. + +### HasMatchAllAccounts + +`func (o *SourceAppPatchDto) HasMatchAllAccounts() bool` + +HasMatchAllAccounts returns a boolean if a field has been set. + +### GetAppCenterEnabled + +`func (o *SourceAppPatchDto) GetAppCenterEnabled() bool` + +GetAppCenterEnabled returns the AppCenterEnabled field if non-nil, zero value otherwise. + +### GetAppCenterEnabledOk + +`func (o *SourceAppPatchDto) GetAppCenterEnabledOk() (*bool, bool)` + +GetAppCenterEnabledOk returns a tuple with the AppCenterEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppCenterEnabled + +`func (o *SourceAppPatchDto) SetAppCenterEnabled(v bool)` + +SetAppCenterEnabled sets AppCenterEnabled field to given value. + +### HasAppCenterEnabled + +`func (o *SourceAppPatchDto) HasAppCenterEnabled() bool` + +HasAppCenterEnabled returns a boolean if a field has been set. + +### GetAccessProfiles + +`func (o *SourceAppPatchDto) GetAccessProfiles() []string` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *SourceAppPatchDto) GetAccessProfilesOk() (*[]string, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *SourceAppPatchDto) SetAccessProfiles(v []string)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *SourceAppPatchDto) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### SetAccessProfilesNil + +`func (o *SourceAppPatchDto) SetAccessProfilesNil(b bool)` + + SetAccessProfilesNil sets the value for AccessProfiles to be an explicit nil + +### UnsetAccessProfiles +`func (o *SourceAppPatchDto) UnsetAccessProfiles()` + +UnsetAccessProfiles ensures that no value is present for AccessProfiles, not even an explicit nil +### GetAccountSource + +`func (o *SourceAppPatchDto) GetAccountSource() SourceAppAccountSource` + +GetAccountSource returns the AccountSource field if non-nil, zero value otherwise. + +### GetAccountSourceOk + +`func (o *SourceAppPatchDto) GetAccountSourceOk() (*SourceAppAccountSource, bool)` + +GetAccountSourceOk returns a tuple with the AccountSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSource + +`func (o *SourceAppPatchDto) SetAccountSource(v SourceAppAccountSource)` + +SetAccountSource sets AccountSource field to given value. + +### HasAccountSource + +`func (o *SourceAppPatchDto) HasAccountSource() bool` + +HasAccountSource returns a boolean if a field has been set. + +### SetAccountSourceNil + +`func (o *SourceAppPatchDto) SetAccountSourceNil(b bool)` + + SetAccountSourceNil sets the value for AccountSource to be an explicit nil + +### UnsetAccountSource +`func (o *SourceAppPatchDto) UnsetAccountSource()` + +UnsetAccountSource ensures that no value is present for AccountSource, not even an explicit nil +### GetOwner + +`func (o *SourceAppPatchDto) GetOwner() BaseReferenceDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *SourceAppPatchDto) GetOwnerOk() (*BaseReferenceDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *SourceAppPatchDto) SetOwner(v BaseReferenceDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *SourceAppPatchDto) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *SourceAppPatchDto) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *SourceAppPatchDto) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceBeforeProvisioningRule.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceBeforeProvisioningRule.md new file mode 100644 index 000000000..f20988c49 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceBeforeProvisioningRule.md @@ -0,0 +1,116 @@ +--- +id: v2024-source-before-provisioning-rule +title: SourceBeforeProvisioningRule +pagination_label: SourceBeforeProvisioningRule +sidebar_label: SourceBeforeProvisioningRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceBeforeProvisioningRule', 'V2024SourceBeforeProvisioningRule'] +slug: /tools/sdk/go/v2024/models/source-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'SourceBeforeProvisioningRule', 'V2024SourceBeforeProvisioningRule'] +--- + +# SourceBeforeProvisioningRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Rule ID. | [optional] +**Name** | Pointer to **string** | Rule's human-readable display name. | [optional] + +## Methods + +### NewSourceBeforeProvisioningRule + +`func NewSourceBeforeProvisioningRule() *SourceBeforeProvisioningRule` + +NewSourceBeforeProvisioningRule instantiates a new SourceBeforeProvisioningRule 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 + +### NewSourceBeforeProvisioningRuleWithDefaults + +`func NewSourceBeforeProvisioningRuleWithDefaults() *SourceBeforeProvisioningRule` + +NewSourceBeforeProvisioningRuleWithDefaults instantiates a new SourceBeforeProvisioningRule 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 + +### GetType + +`func (o *SourceBeforeProvisioningRule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceBeforeProvisioningRule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceBeforeProvisioningRule) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceBeforeProvisioningRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceBeforeProvisioningRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceBeforeProvisioningRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceBeforeProvisioningRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceBeforeProvisioningRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceBeforeProvisioningRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceBeforeProvisioningRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceBeforeProvisioningRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceBeforeProvisioningRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceCluster.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceCluster.md new file mode 100644 index 000000000..6c41439cd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceCluster.md @@ -0,0 +1,101 @@ +--- +id: v2024-source-cluster +title: SourceCluster +pagination_label: SourceCluster +sidebar_label: SourceCluster +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceCluster', 'V2024SourceCluster'] +slug: /tools/sdk/go/v2024/models/source-cluster +tags: ['SDK', 'Software Development Kit', 'SourceCluster', 'V2024SourceCluster'] +--- + +# SourceCluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of object being referenced. | +**Id** | **string** | Cluster ID. | +**Name** | **string** | Cluster's human-readable display name. | + +## Methods + +### NewSourceCluster + +`func NewSourceCluster(type_ string, id string, name string, ) *SourceCluster` + +NewSourceCluster instantiates a new SourceCluster 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 + +### NewSourceClusterWithDefaults + +`func NewSourceClusterWithDefaults() *SourceCluster` + +NewSourceClusterWithDefaults instantiates a new SourceCluster 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 + +### GetType + +`func (o *SourceCluster) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceCluster) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceCluster) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *SourceCluster) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceCluster) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceCluster) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceCluster) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceCluster) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceCluster) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceClusterDto.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceClusterDto.md new file mode 100644 index 000000000..95b7a4fa7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceClusterDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-source-cluster-dto +title: SourceClusterDto +pagination_label: SourceClusterDto +sidebar_label: SourceClusterDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceClusterDto', 'V2024SourceClusterDto'] +slug: /tools/sdk/go/v2024/models/source-cluster-dto +tags: ['SDK', 'Software Development Kit', 'SourceClusterDto', 'V2024SourceClusterDto'] +--- + +# SourceClusterDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Source cluster DTO type. | [optional] +**Id** | Pointer to **string** | Source cluster ID. | [optional] +**Name** | Pointer to **string** | Source cluster display name. | [optional] + +## Methods + +### NewSourceClusterDto + +`func NewSourceClusterDto() *SourceClusterDto` + +NewSourceClusterDto instantiates a new SourceClusterDto 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 + +### NewSourceClusterDtoWithDefaults + +`func NewSourceClusterDtoWithDefaults() *SourceClusterDto` + +NewSourceClusterDtoWithDefaults instantiates a new SourceClusterDto 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 + +### GetType + +`func (o *SourceClusterDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceClusterDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceClusterDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceClusterDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceClusterDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceClusterDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceClusterDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceClusterDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceClusterDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceClusterDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceClusterDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceClusterDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceCode.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceCode.md new file mode 100644 index 000000000..8679ee169 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceCode.md @@ -0,0 +1,80 @@ +--- +id: v2024-source-code +title: SourceCode +pagination_label: SourceCode +sidebar_label: SourceCode +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceCode', 'V2024SourceCode'] +slug: /tools/sdk/go/v2024/models/source-code +tags: ['SDK', 'Software Development Kit', 'SourceCode', 'V2024SourceCode'] +--- + +# SourceCode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | **string** | the version of the code | +**Script** | **string** | The code | + +## Methods + +### NewSourceCode + +`func NewSourceCode(version string, script string, ) *SourceCode` + +NewSourceCode instantiates a new SourceCode 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 + +### NewSourceCodeWithDefaults + +`func NewSourceCodeWithDefaults() *SourceCode` + +NewSourceCodeWithDefaults instantiates a new SourceCode 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 + +### GetVersion + +`func (o *SourceCode) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *SourceCode) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *SourceCode) SetVersion(v string)` + +SetVersion sets Version field to given value. + + +### GetScript + +`func (o *SourceCode) GetScript() string` + +GetScript returns the Script field if non-nil, zero value otherwise. + +### GetScriptOk + +`func (o *SourceCode) GetScriptOk() (*string, bool)` + +GetScriptOk returns a tuple with the Script field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScript + +`func (o *SourceCode) SetScript(v string)` + +SetScript sets Script field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceConnectionsDto.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceConnectionsDto.md new file mode 100644 index 000000000..a7f9acf99 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceConnectionsDto.md @@ -0,0 +1,220 @@ +--- +id: v2024-source-connections-dto +title: SourceConnectionsDto +pagination_label: SourceConnectionsDto +sidebar_label: SourceConnectionsDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceConnectionsDto', 'V2024SourceConnectionsDto'] +slug: /tools/sdk/go/v2024/models/source-connections-dto +tags: ['SDK', 'Software Development Kit', 'SourceConnectionsDto', 'V2024SourceConnectionsDto'] +--- + +# SourceConnectionsDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityProfiles** | Pointer to [**[]IdentityProfilesConnections**](identity-profiles-connections) | The IdentityProfile attached to this source | [optional] +**CredentialProfiles** | Pointer to **[]string** | Name of the CredentialProfile attached to this source | [optional] +**SourceAttributes** | Pointer to **[]string** | The attributes attached to this source | [optional] +**MappingProfiles** | Pointer to **[]string** | The profiles attached to this source | [optional] +**DependentCustomTransforms** | Pointer to [**[]TransformRead**](transform-read) | A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName. | [optional] +**DependentApps** | Pointer to [**[]DependantAppConnections**](dependant-app-connections) | | [optional] +**MissingDependents** | Pointer to [**[]DependantConnectionsMissingDto**](dependant-connections-missing-dto) | | [optional] + +## Methods + +### NewSourceConnectionsDto + +`func NewSourceConnectionsDto() *SourceConnectionsDto` + +NewSourceConnectionsDto instantiates a new SourceConnectionsDto 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 + +### NewSourceConnectionsDtoWithDefaults + +`func NewSourceConnectionsDtoWithDefaults() *SourceConnectionsDto` + +NewSourceConnectionsDtoWithDefaults instantiates a new SourceConnectionsDto 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 + +### GetIdentityProfiles + +`func (o *SourceConnectionsDto) GetIdentityProfiles() []IdentityProfilesConnections` + +GetIdentityProfiles returns the IdentityProfiles field if non-nil, zero value otherwise. + +### GetIdentityProfilesOk + +`func (o *SourceConnectionsDto) GetIdentityProfilesOk() (*[]IdentityProfilesConnections, bool)` + +GetIdentityProfilesOk returns a tuple with the IdentityProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityProfiles + +`func (o *SourceConnectionsDto) SetIdentityProfiles(v []IdentityProfilesConnections)` + +SetIdentityProfiles sets IdentityProfiles field to given value. + +### HasIdentityProfiles + +`func (o *SourceConnectionsDto) HasIdentityProfiles() bool` + +HasIdentityProfiles returns a boolean if a field has been set. + +### GetCredentialProfiles + +`func (o *SourceConnectionsDto) GetCredentialProfiles() []string` + +GetCredentialProfiles returns the CredentialProfiles field if non-nil, zero value otherwise. + +### GetCredentialProfilesOk + +`func (o *SourceConnectionsDto) GetCredentialProfilesOk() (*[]string, bool)` + +GetCredentialProfilesOk returns a tuple with the CredentialProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialProfiles + +`func (o *SourceConnectionsDto) SetCredentialProfiles(v []string)` + +SetCredentialProfiles sets CredentialProfiles field to given value. + +### HasCredentialProfiles + +`func (o *SourceConnectionsDto) HasCredentialProfiles() bool` + +HasCredentialProfiles returns a boolean if a field has been set. + +### GetSourceAttributes + +`func (o *SourceConnectionsDto) GetSourceAttributes() []string` + +GetSourceAttributes returns the SourceAttributes field if non-nil, zero value otherwise. + +### GetSourceAttributesOk + +`func (o *SourceConnectionsDto) GetSourceAttributesOk() (*[]string, bool)` + +GetSourceAttributesOk returns a tuple with the SourceAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceAttributes + +`func (o *SourceConnectionsDto) SetSourceAttributes(v []string)` + +SetSourceAttributes sets SourceAttributes field to given value. + +### HasSourceAttributes + +`func (o *SourceConnectionsDto) HasSourceAttributes() bool` + +HasSourceAttributes returns a boolean if a field has been set. + +### GetMappingProfiles + +`func (o *SourceConnectionsDto) GetMappingProfiles() []string` + +GetMappingProfiles returns the MappingProfiles field if non-nil, zero value otherwise. + +### GetMappingProfilesOk + +`func (o *SourceConnectionsDto) GetMappingProfilesOk() (*[]string, bool)` + +GetMappingProfilesOk returns a tuple with the MappingProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMappingProfiles + +`func (o *SourceConnectionsDto) SetMappingProfiles(v []string)` + +SetMappingProfiles sets MappingProfiles field to given value. + +### HasMappingProfiles + +`func (o *SourceConnectionsDto) HasMappingProfiles() bool` + +HasMappingProfiles returns a boolean if a field has been set. + +### GetDependentCustomTransforms + +`func (o *SourceConnectionsDto) GetDependentCustomTransforms() []TransformRead` + +GetDependentCustomTransforms returns the DependentCustomTransforms field if non-nil, zero value otherwise. + +### GetDependentCustomTransformsOk + +`func (o *SourceConnectionsDto) GetDependentCustomTransformsOk() (*[]TransformRead, bool)` + +GetDependentCustomTransformsOk returns a tuple with the DependentCustomTransforms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDependentCustomTransforms + +`func (o *SourceConnectionsDto) SetDependentCustomTransforms(v []TransformRead)` + +SetDependentCustomTransforms sets DependentCustomTransforms field to given value. + +### HasDependentCustomTransforms + +`func (o *SourceConnectionsDto) HasDependentCustomTransforms() bool` + +HasDependentCustomTransforms returns a boolean if a field has been set. + +### GetDependentApps + +`func (o *SourceConnectionsDto) GetDependentApps() []DependantAppConnections` + +GetDependentApps returns the DependentApps field if non-nil, zero value otherwise. + +### GetDependentAppsOk + +`func (o *SourceConnectionsDto) GetDependentAppsOk() (*[]DependantAppConnections, bool)` + +GetDependentAppsOk returns a tuple with the DependentApps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDependentApps + +`func (o *SourceConnectionsDto) SetDependentApps(v []DependantAppConnections)` + +SetDependentApps sets DependentApps field to given value. + +### HasDependentApps + +`func (o *SourceConnectionsDto) HasDependentApps() bool` + +HasDependentApps returns a boolean if a field has been set. + +### GetMissingDependents + +`func (o *SourceConnectionsDto) GetMissingDependents() []DependantConnectionsMissingDto` + +GetMissingDependents returns the MissingDependents field if non-nil, zero value otherwise. + +### GetMissingDependentsOk + +`func (o *SourceConnectionsDto) GetMissingDependentsOk() (*[]DependantConnectionsMissingDto, bool)` + +GetMissingDependentsOk returns a tuple with the MissingDependents field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMissingDependents + +`func (o *SourceConnectionsDto) SetMissingDependents(v []DependantConnectionsMissingDto)` + +SetMissingDependents sets MissingDependents field to given value. + +### HasMissingDependents + +`func (o *SourceConnectionsDto) HasMissingDependents() bool` + +HasMissingDependents returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceCreated.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceCreated.md new file mode 100644 index 000000000..37c285945 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceCreated.md @@ -0,0 +1,164 @@ +--- +id: v2024-source-created +title: SourceCreated +pagination_label: SourceCreated +sidebar_label: SourceCreated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceCreated', 'V2024SourceCreated'] +slug: /tools/sdk/go/v2024/models/source-created +tags: ['SDK', 'Software Development Kit', 'SourceCreated', 'V2024SourceCreated'] +--- + +# SourceCreated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the source. | +**Name** | **string** | Human friendly name of the source. | +**Type** | **string** | The connection type. | +**Created** | **SailPointTime** | The date and time the source was created. | +**Connector** | **string** | The connector type used to connect to the source. | +**Actor** | [**SourceCreatedActor**](source-created-actor) | | + +## Methods + +### NewSourceCreated + +`func NewSourceCreated(id string, name string, type_ string, created SailPointTime, connector string, actor SourceCreatedActor, ) *SourceCreated` + +NewSourceCreated instantiates a new SourceCreated 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 + +### NewSourceCreatedWithDefaults + +`func NewSourceCreatedWithDefaults() *SourceCreated` + +NewSourceCreatedWithDefaults instantiates a new SourceCreated 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 + +### GetId + +`func (o *SourceCreated) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceCreated) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceCreated) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceCreated) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceCreated) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceCreated) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *SourceCreated) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceCreated) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceCreated) SetType(v string)` + +SetType sets Type field to given value. + + +### GetCreated + +`func (o *SourceCreated) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SourceCreated) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SourceCreated) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetConnector + +`func (o *SourceCreated) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *SourceCreated) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *SourceCreated) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetActor + +`func (o *SourceCreated) GetActor() SourceCreatedActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *SourceCreated) GetActorOk() (*SourceCreatedActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *SourceCreated) SetActor(v SourceCreatedActor)` + +SetActor sets Actor field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceCreatedActor.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceCreatedActor.md new file mode 100644 index 000000000..32eabd38e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceCreatedActor.md @@ -0,0 +1,101 @@ +--- +id: v2024-source-created-actor +title: SourceCreatedActor +pagination_label: SourceCreatedActor +sidebar_label: SourceCreatedActor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceCreatedActor', 'V2024SourceCreatedActor'] +slug: /tools/sdk/go/v2024/models/source-created-actor +tags: ['SDK', 'Software Development Kit', 'SourceCreatedActor', 'V2024SourceCreatedActor'] +--- + +# SourceCreatedActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of identity who created the source. | +**Id** | **string** | ID of identity who created the source. | +**Name** | **string** | Display name of identity who created the source. | + +## Methods + +### NewSourceCreatedActor + +`func NewSourceCreatedActor(type_ string, id string, name string, ) *SourceCreatedActor` + +NewSourceCreatedActor instantiates a new SourceCreatedActor 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 + +### NewSourceCreatedActorWithDefaults + +`func NewSourceCreatedActorWithDefaults() *SourceCreatedActor` + +NewSourceCreatedActorWithDefaults instantiates a new SourceCreatedActor 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 + +### GetType + +`func (o *SourceCreatedActor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceCreatedActor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceCreatedActor) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *SourceCreatedActor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceCreatedActor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceCreatedActor) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceCreatedActor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceCreatedActor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceCreatedActor) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceCreationErrors.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceCreationErrors.md new file mode 100644 index 000000000..a7e8c1005 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceCreationErrors.md @@ -0,0 +1,204 @@ +--- +id: v2024-source-creation-errors +title: SourceCreationErrors +pagination_label: SourceCreationErrors +sidebar_label: SourceCreationErrors +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceCreationErrors', 'V2024SourceCreationErrors'] +slug: /tools/sdk/go/v2024/models/source-creation-errors +tags: ['SDK', 'Software Development Kit', 'SourceCreationErrors', 'V2024SourceCreationErrors'] +--- + +# SourceCreationErrors + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MultihostId** | Pointer to **string** | Multi-Host Integration ID. | [optional] [readonly] +**SourceName** | Pointer to **string** | Source's human-readable name. | [optional] +**SourceError** | Pointer to **string** | Source's human-readable description. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date-time when the source was last modified. | [optional] +**Operation** | Pointer to **NullableString** | operation category (e.g. DELETE). | [optional] + +## Methods + +### NewSourceCreationErrors + +`func NewSourceCreationErrors() *SourceCreationErrors` + +NewSourceCreationErrors instantiates a new SourceCreationErrors 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 + +### NewSourceCreationErrorsWithDefaults + +`func NewSourceCreationErrorsWithDefaults() *SourceCreationErrors` + +NewSourceCreationErrorsWithDefaults instantiates a new SourceCreationErrors 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 + +### GetMultihostId + +`func (o *SourceCreationErrors) GetMultihostId() string` + +GetMultihostId returns the MultihostId field if non-nil, zero value otherwise. + +### GetMultihostIdOk + +`func (o *SourceCreationErrors) GetMultihostIdOk() (*string, bool)` + +GetMultihostIdOk returns a tuple with the MultihostId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultihostId + +`func (o *SourceCreationErrors) SetMultihostId(v string)` + +SetMultihostId sets MultihostId field to given value. + +### HasMultihostId + +`func (o *SourceCreationErrors) HasMultihostId() bool` + +HasMultihostId returns a boolean if a field has been set. + +### GetSourceName + +`func (o *SourceCreationErrors) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *SourceCreationErrors) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *SourceCreationErrors) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *SourceCreationErrors) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceError + +`func (o *SourceCreationErrors) GetSourceError() string` + +GetSourceError returns the SourceError field if non-nil, zero value otherwise. + +### GetSourceErrorOk + +`func (o *SourceCreationErrors) GetSourceErrorOk() (*string, bool)` + +GetSourceErrorOk returns a tuple with the SourceError field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceError + +`func (o *SourceCreationErrors) SetSourceError(v string)` + +SetSourceError sets SourceError field to given value. + +### HasSourceError + +`func (o *SourceCreationErrors) HasSourceError() bool` + +HasSourceError returns a boolean if a field has been set. + +### GetCreated + +`func (o *SourceCreationErrors) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SourceCreationErrors) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SourceCreationErrors) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SourceCreationErrors) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SourceCreationErrors) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SourceCreationErrors) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SourceCreationErrors) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SourceCreationErrors) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetOperation + +`func (o *SourceCreationErrors) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *SourceCreationErrors) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *SourceCreationErrors) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *SourceCreationErrors) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### SetOperationNil + +`func (o *SourceCreationErrors) SetOperationNil(b bool)` + + SetOperationNil sets the value for Operation to be an explicit nil + +### UnsetOperation +`func (o *SourceCreationErrors) UnsetOperation()` + +UnsetOperation ensures that no value is present for Operation, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceDeleted.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceDeleted.md new file mode 100644 index 000000000..535a4a40e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceDeleted.md @@ -0,0 +1,164 @@ +--- +id: v2024-source-deleted +title: SourceDeleted +pagination_label: SourceDeleted +sidebar_label: SourceDeleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceDeleted', 'V2024SourceDeleted'] +slug: /tools/sdk/go/v2024/models/source-deleted +tags: ['SDK', 'Software Development Kit', 'SourceDeleted', 'V2024SourceDeleted'] +--- + +# SourceDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the source. | +**Name** | **string** | Human friendly name of the source. | +**Type** | **string** | The connection type. | +**Deleted** | **SailPointTime** | The date and time the source was deleted. | +**Connector** | **string** | The connector type used to connect to the source. | +**Actor** | [**SourceDeletedActor**](source-deleted-actor) | | + +## Methods + +### NewSourceDeleted + +`func NewSourceDeleted(id string, name string, type_ string, deleted SailPointTime, connector string, actor SourceDeletedActor, ) *SourceDeleted` + +NewSourceDeleted instantiates a new SourceDeleted 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 + +### NewSourceDeletedWithDefaults + +`func NewSourceDeletedWithDefaults() *SourceDeleted` + +NewSourceDeletedWithDefaults instantiates a new SourceDeleted 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 + +### GetId + +`func (o *SourceDeleted) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceDeleted) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceDeleted) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceDeleted) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceDeleted) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceDeleted) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *SourceDeleted) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceDeleted) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceDeleted) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDeleted + +`func (o *SourceDeleted) GetDeleted() SailPointTime` + +GetDeleted returns the Deleted field if non-nil, zero value otherwise. + +### GetDeletedOk + +`func (o *SourceDeleted) GetDeletedOk() (*SailPointTime, bool)` + +GetDeletedOk returns a tuple with the Deleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleted + +`func (o *SourceDeleted) SetDeleted(v SailPointTime)` + +SetDeleted sets Deleted field to given value. + + +### GetConnector + +`func (o *SourceDeleted) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *SourceDeleted) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *SourceDeleted) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetActor + +`func (o *SourceDeleted) GetActor() SourceDeletedActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *SourceDeleted) GetActorOk() (*SourceDeletedActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *SourceDeleted) SetActor(v SourceDeletedActor)` + +SetActor sets Actor field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceDeletedActor.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceDeletedActor.md new file mode 100644 index 000000000..22b0b2947 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceDeletedActor.md @@ -0,0 +1,101 @@ +--- +id: v2024-source-deleted-actor +title: SourceDeletedActor +pagination_label: SourceDeletedActor +sidebar_label: SourceDeletedActor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceDeletedActor', 'V2024SourceDeletedActor'] +slug: /tools/sdk/go/v2024/models/source-deleted-actor +tags: ['SDK', 'Software Development Kit', 'SourceDeletedActor', 'V2024SourceDeletedActor'] +--- + +# SourceDeletedActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of identity who deleted the source. | +**Id** | **string** | ID of identity who deleted the source. | +**Name** | **string** | Display name of identity who deleted the source. | + +## Methods + +### NewSourceDeletedActor + +`func NewSourceDeletedActor(type_ string, id string, name string, ) *SourceDeletedActor` + +NewSourceDeletedActor instantiates a new SourceDeletedActor 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 + +### NewSourceDeletedActorWithDefaults + +`func NewSourceDeletedActorWithDefaults() *SourceDeletedActor` + +NewSourceDeletedActorWithDefaults instantiates a new SourceDeletedActor 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 + +### GetType + +`func (o *SourceDeletedActor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceDeletedActor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceDeletedActor) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *SourceDeletedActor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceDeletedActor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceDeletedActor) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceDeletedActor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceDeletedActor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceDeletedActor) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceEntitlementRequestConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceEntitlementRequestConfig.md new file mode 100644 index 000000000..c94fca30f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceEntitlementRequestConfig.md @@ -0,0 +1,64 @@ +--- +id: v2024-source-entitlement-request-config +title: SourceEntitlementRequestConfig +pagination_label: SourceEntitlementRequestConfig +sidebar_label: SourceEntitlementRequestConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceEntitlementRequestConfig', 'V2024SourceEntitlementRequestConfig'] +slug: /tools/sdk/go/v2024/models/source-entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'SourceEntitlementRequestConfig', 'V2024SourceEntitlementRequestConfig'] +--- + +# SourceEntitlementRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestConfig** | Pointer to [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] + +## Methods + +### NewSourceEntitlementRequestConfig + +`func NewSourceEntitlementRequestConfig() *SourceEntitlementRequestConfig` + +NewSourceEntitlementRequestConfig instantiates a new SourceEntitlementRequestConfig 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 + +### NewSourceEntitlementRequestConfigWithDefaults + +`func NewSourceEntitlementRequestConfigWithDefaults() *SourceEntitlementRequestConfig` + +NewSourceEntitlementRequestConfigWithDefaults instantiates a new SourceEntitlementRequestConfig 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 + +### GetAccessRequestConfig + +`func (o *SourceEntitlementRequestConfig) GetAccessRequestConfig() EntitlementAccessRequestConfig` + +GetAccessRequestConfig returns the AccessRequestConfig field if non-nil, zero value otherwise. + +### GetAccessRequestConfigOk + +`func (o *SourceEntitlementRequestConfig) GetAccessRequestConfigOk() (*EntitlementAccessRequestConfig, bool)` + +GetAccessRequestConfigOk returns a tuple with the AccessRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestConfig + +`func (o *SourceEntitlementRequestConfig) SetAccessRequestConfig(v EntitlementAccessRequestConfig)` + +SetAccessRequestConfig sets AccessRequestConfig field to given value. + +### HasAccessRequestConfig + +`func (o *SourceEntitlementRequestConfig) HasAccessRequestConfig() bool` + +HasAccessRequestConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceHealthDto.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceHealthDto.md new file mode 100644 index 000000000..28898ac4d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceHealthDto.md @@ -0,0 +1,308 @@ +--- +id: v2024-source-health-dto +title: SourceHealthDto +pagination_label: SourceHealthDto +sidebar_label: SourceHealthDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceHealthDto', 'V2024SourceHealthDto'] +slug: /tools/sdk/go/v2024/models/source-health-dto +tags: ['SDK', 'Software Development Kit', 'SourceHealthDto', 'V2024SourceHealthDto'] +--- + +# SourceHealthDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the id of the Source | [optional] [readonly] +**Type** | Pointer to **string** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Name** | Pointer to **string** | the name of the source | [optional] +**Org** | Pointer to **string** | source's org | [optional] +**IsAuthoritative** | Pointer to **bool** | Is the source authoritative | [optional] +**IsCluster** | Pointer to **bool** | Is the source in a cluster | [optional] +**Hostname** | Pointer to **string** | source's hostname | [optional] +**Pod** | Pointer to **string** | source's pod | [optional] +**IqServiceVersion** | Pointer to **NullableString** | The version of the iqService | [optional] +**Status** | Pointer to **string** | connection test result | [optional] + +## Methods + +### NewSourceHealthDto + +`func NewSourceHealthDto() *SourceHealthDto` + +NewSourceHealthDto instantiates a new SourceHealthDto 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 + +### NewSourceHealthDtoWithDefaults + +`func NewSourceHealthDtoWithDefaults() *SourceHealthDto` + +NewSourceHealthDtoWithDefaults instantiates a new SourceHealthDto 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 + +### GetId + +`func (o *SourceHealthDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceHealthDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceHealthDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceHealthDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *SourceHealthDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceHealthDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceHealthDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceHealthDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *SourceHealthDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceHealthDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceHealthDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceHealthDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOrg + +`func (o *SourceHealthDto) GetOrg() string` + +GetOrg returns the Org field if non-nil, zero value otherwise. + +### GetOrgOk + +`func (o *SourceHealthDto) GetOrgOk() (*string, bool)` + +GetOrgOk returns a tuple with the Org field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrg + +`func (o *SourceHealthDto) SetOrg(v string)` + +SetOrg sets Org field to given value. + +### HasOrg + +`func (o *SourceHealthDto) HasOrg() bool` + +HasOrg returns a boolean if a field has been set. + +### GetIsAuthoritative + +`func (o *SourceHealthDto) GetIsAuthoritative() bool` + +GetIsAuthoritative returns the IsAuthoritative field if non-nil, zero value otherwise. + +### GetIsAuthoritativeOk + +`func (o *SourceHealthDto) GetIsAuthoritativeOk() (*bool, bool)` + +GetIsAuthoritativeOk returns a tuple with the IsAuthoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsAuthoritative + +`func (o *SourceHealthDto) SetIsAuthoritative(v bool)` + +SetIsAuthoritative sets IsAuthoritative field to given value. + +### HasIsAuthoritative + +`func (o *SourceHealthDto) HasIsAuthoritative() bool` + +HasIsAuthoritative returns a boolean if a field has been set. + +### GetIsCluster + +`func (o *SourceHealthDto) GetIsCluster() bool` + +GetIsCluster returns the IsCluster field if non-nil, zero value otherwise. + +### GetIsClusterOk + +`func (o *SourceHealthDto) GetIsClusterOk() (*bool, bool)` + +GetIsClusterOk returns a tuple with the IsCluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsCluster + +`func (o *SourceHealthDto) SetIsCluster(v bool)` + +SetIsCluster sets IsCluster field to given value. + +### HasIsCluster + +`func (o *SourceHealthDto) HasIsCluster() bool` + +HasIsCluster returns a boolean if a field has been set. + +### GetHostname + +`func (o *SourceHealthDto) GetHostname() string` + +GetHostname returns the Hostname field if non-nil, zero value otherwise. + +### GetHostnameOk + +`func (o *SourceHealthDto) GetHostnameOk() (*string, bool)` + +GetHostnameOk returns a tuple with the Hostname field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostname + +`func (o *SourceHealthDto) SetHostname(v string)` + +SetHostname sets Hostname field to given value. + +### HasHostname + +`func (o *SourceHealthDto) HasHostname() bool` + +HasHostname returns a boolean if a field has been set. + +### GetPod + +`func (o *SourceHealthDto) GetPod() string` + +GetPod returns the Pod field if non-nil, zero value otherwise. + +### GetPodOk + +`func (o *SourceHealthDto) GetPodOk() (*string, bool)` + +GetPodOk returns a tuple with the Pod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPod + +`func (o *SourceHealthDto) SetPod(v string)` + +SetPod sets Pod field to given value. + +### HasPod + +`func (o *SourceHealthDto) HasPod() bool` + +HasPod returns a boolean if a field has been set. + +### GetIqServiceVersion + +`func (o *SourceHealthDto) GetIqServiceVersion() string` + +GetIqServiceVersion returns the IqServiceVersion field if non-nil, zero value otherwise. + +### GetIqServiceVersionOk + +`func (o *SourceHealthDto) GetIqServiceVersionOk() (*string, bool)` + +GetIqServiceVersionOk returns a tuple with the IqServiceVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIqServiceVersion + +`func (o *SourceHealthDto) SetIqServiceVersion(v string)` + +SetIqServiceVersion sets IqServiceVersion field to given value. + +### HasIqServiceVersion + +`func (o *SourceHealthDto) HasIqServiceVersion() bool` + +HasIqServiceVersion returns a boolean if a field has been set. + +### SetIqServiceVersionNil + +`func (o *SourceHealthDto) SetIqServiceVersionNil(b bool)` + + SetIqServiceVersionNil sets the value for IqServiceVersion to be an explicit nil + +### UnsetIqServiceVersion +`func (o *SourceHealthDto) UnsetIqServiceVersion()` + +UnsetIqServiceVersion ensures that no value is present for IqServiceVersion, not even an explicit nil +### GetStatus + +`func (o *SourceHealthDto) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SourceHealthDto) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SourceHealthDto) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SourceHealthDto) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceItemRef.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceItemRef.md new file mode 100644 index 000000000..64ed4c244 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceItemRef.md @@ -0,0 +1,110 @@ +--- +id: v2024-source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceItemRef', 'V2024SourceItemRef'] +slug: /tools/sdk/go/v2024/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'V2024SourceItemRef'] +--- + +# SourceItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | Pointer to **NullableString** | The id for the source on which account selections are made | [optional] +**Accounts** | Pointer to [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] + +## Methods + +### NewSourceItemRef + +`func NewSourceItemRef() *SourceItemRef` + +NewSourceItemRef instantiates a new SourceItemRef 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 + +### NewSourceItemRefWithDefaults + +`func NewSourceItemRefWithDefaults() *SourceItemRef` + +NewSourceItemRefWithDefaults instantiates a new SourceItemRef 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 + +### GetSourceId + +`func (o *SourceItemRef) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *SourceItemRef) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *SourceItemRef) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *SourceItemRef) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### SetSourceIdNil + +`func (o *SourceItemRef) SetSourceIdNil(b bool)` + + SetSourceIdNil sets the value for SourceId to be an explicit nil + +### UnsetSourceId +`func (o *SourceItemRef) UnsetSourceId()` + +UnsetSourceId ensures that no value is present for SourceId, not even an explicit nil +### GetAccounts + +`func (o *SourceItemRef) GetAccounts() []AccountItemRef` + +GetAccounts returns the Accounts field if non-nil, zero value otherwise. + +### GetAccountsOk + +`func (o *SourceItemRef) GetAccountsOk() (*[]AccountItemRef, bool)` + +GetAccountsOk returns a tuple with the Accounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccounts + +`func (o *SourceItemRef) SetAccounts(v []AccountItemRef)` + +SetAccounts sets Accounts field to given value. + +### HasAccounts + +`func (o *SourceItemRef) HasAccounts() bool` + +HasAccounts returns a boolean if a field has been set. + +### SetAccountsNil + +`func (o *SourceItemRef) SetAccountsNil(b bool)` + + SetAccountsNil sets the value for Accounts to be an explicit nil + +### UnsetAccounts +`func (o *SourceItemRef) UnsetAccounts()` + +UnsetAccounts ensures that no value is present for Accounts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceManagementWorkgroup.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceManagementWorkgroup.md new file mode 100644 index 000000000..6a5fc325a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceManagementWorkgroup.md @@ -0,0 +1,116 @@ +--- +id: v2024-source-management-workgroup +title: SourceManagementWorkgroup +pagination_label: SourceManagementWorkgroup +sidebar_label: SourceManagementWorkgroup +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceManagementWorkgroup', 'V2024SourceManagementWorkgroup'] +slug: /tools/sdk/go/v2024/models/source-management-workgroup +tags: ['SDK', 'Software Development Kit', 'SourceManagementWorkgroup', 'V2024SourceManagementWorkgroup'] +--- + +# SourceManagementWorkgroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Management workgroup ID. | [optional] +**Name** | Pointer to **string** | Management workgroup's human-readable display name. | [optional] + +## Methods + +### NewSourceManagementWorkgroup + +`func NewSourceManagementWorkgroup() *SourceManagementWorkgroup` + +NewSourceManagementWorkgroup instantiates a new SourceManagementWorkgroup 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 + +### NewSourceManagementWorkgroupWithDefaults + +`func NewSourceManagementWorkgroupWithDefaults() *SourceManagementWorkgroup` + +NewSourceManagementWorkgroupWithDefaults instantiates a new SourceManagementWorkgroup 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 + +### GetType + +`func (o *SourceManagementWorkgroup) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceManagementWorkgroup) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceManagementWorkgroup) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceManagementWorkgroup) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceManagementWorkgroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceManagementWorkgroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceManagementWorkgroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceManagementWorkgroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceManagementWorkgroup) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceManagementWorkgroup) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceManagementWorkgroup) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceManagementWorkgroup) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceManagerCorrelationMapping.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceManagerCorrelationMapping.md new file mode 100644 index 000000000..3b3196d95 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceManagerCorrelationMapping.md @@ -0,0 +1,90 @@ +--- +id: v2024-source-manager-correlation-mapping +title: SourceManagerCorrelationMapping +pagination_label: SourceManagerCorrelationMapping +sidebar_label: SourceManagerCorrelationMapping +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceManagerCorrelationMapping', 'V2024SourceManagerCorrelationMapping'] +slug: /tools/sdk/go/v2024/models/source-manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationMapping', 'V2024SourceManagerCorrelationMapping'] +--- + +# SourceManagerCorrelationMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountAttributeName** | Pointer to **string** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**IdentityAttributeName** | Pointer to **string** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] + +## Methods + +### NewSourceManagerCorrelationMapping + +`func NewSourceManagerCorrelationMapping() *SourceManagerCorrelationMapping` + +NewSourceManagerCorrelationMapping instantiates a new SourceManagerCorrelationMapping 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 + +### NewSourceManagerCorrelationMappingWithDefaults + +`func NewSourceManagerCorrelationMappingWithDefaults() *SourceManagerCorrelationMapping` + +NewSourceManagerCorrelationMappingWithDefaults instantiates a new SourceManagerCorrelationMapping 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 + +### GetAccountAttributeName + +`func (o *SourceManagerCorrelationMapping) GetAccountAttributeName() string` + +GetAccountAttributeName returns the AccountAttributeName field if non-nil, zero value otherwise. + +### GetAccountAttributeNameOk + +`func (o *SourceManagerCorrelationMapping) GetAccountAttributeNameOk() (*string, bool)` + +GetAccountAttributeNameOk returns a tuple with the AccountAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountAttributeName + +`func (o *SourceManagerCorrelationMapping) SetAccountAttributeName(v string)` + +SetAccountAttributeName sets AccountAttributeName field to given value. + +### HasAccountAttributeName + +`func (o *SourceManagerCorrelationMapping) HasAccountAttributeName() bool` + +HasAccountAttributeName returns a boolean if a field has been set. + +### GetIdentityAttributeName + +`func (o *SourceManagerCorrelationMapping) GetIdentityAttributeName() string` + +GetIdentityAttributeName returns the IdentityAttributeName field if non-nil, zero value otherwise. + +### GetIdentityAttributeNameOk + +`func (o *SourceManagerCorrelationMapping) GetIdentityAttributeNameOk() (*string, bool)` + +GetIdentityAttributeNameOk returns a tuple with the IdentityAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeName + +`func (o *SourceManagerCorrelationMapping) SetIdentityAttributeName(v string)` + +SetIdentityAttributeName sets IdentityAttributeName field to given value. + +### HasIdentityAttributeName + +`func (o *SourceManagerCorrelationMapping) HasIdentityAttributeName() bool` + +HasIdentityAttributeName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceManagerCorrelationRule.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceManagerCorrelationRule.md new file mode 100644 index 000000000..ffe0e180b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceManagerCorrelationRule.md @@ -0,0 +1,116 @@ +--- +id: v2024-source-manager-correlation-rule +title: SourceManagerCorrelationRule +pagination_label: SourceManagerCorrelationRule +sidebar_label: SourceManagerCorrelationRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceManagerCorrelationRule', 'V2024SourceManagerCorrelationRule'] +slug: /tools/sdk/go/v2024/models/source-manager-correlation-rule +tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationRule', 'V2024SourceManagerCorrelationRule'] +--- + +# SourceManagerCorrelationRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Rule ID. | [optional] +**Name** | Pointer to **string** | Rule's human-readable display name. | [optional] + +## Methods + +### NewSourceManagerCorrelationRule + +`func NewSourceManagerCorrelationRule() *SourceManagerCorrelationRule` + +NewSourceManagerCorrelationRule instantiates a new SourceManagerCorrelationRule 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 + +### NewSourceManagerCorrelationRuleWithDefaults + +`func NewSourceManagerCorrelationRuleWithDefaults() *SourceManagerCorrelationRule` + +NewSourceManagerCorrelationRuleWithDefaults instantiates a new SourceManagerCorrelationRule 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 + +### GetType + +`func (o *SourceManagerCorrelationRule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceManagerCorrelationRule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceManagerCorrelationRule) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceManagerCorrelationRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceManagerCorrelationRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceManagerCorrelationRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceManagerCorrelationRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceManagerCorrelationRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceManagerCorrelationRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceManagerCorrelationRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceManagerCorrelationRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceManagerCorrelationRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceOwner.md new file mode 100644 index 000000000..74b7a368b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceOwner.md @@ -0,0 +1,116 @@ +--- +id: v2024-source-owner +title: SourceOwner +pagination_label: SourceOwner +sidebar_label: SourceOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceOwner', 'V2024SourceOwner'] +slug: /tools/sdk/go/v2024/models/source-owner +tags: ['SDK', 'Software Development Kit', 'SourceOwner', 'V2024SourceOwner'] +--- + +# SourceOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Owner identity's ID. | [optional] +**Name** | Pointer to **string** | Owner identity's human-readable display name. | [optional] + +## Methods + +### NewSourceOwner + +`func NewSourceOwner() *SourceOwner` + +NewSourceOwner instantiates a new SourceOwner 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 + +### NewSourceOwnerWithDefaults + +`func NewSourceOwnerWithDefaults() *SourceOwner` + +NewSourceOwnerWithDefaults instantiates a new SourceOwner 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 + +### GetType + +`func (o *SourceOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourcePasswordPoliciesInner.md b/docs/tools/sdk/go/Reference/V2024/Models/SourcePasswordPoliciesInner.md new file mode 100644 index 000000000..60eef2f7e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourcePasswordPoliciesInner.md @@ -0,0 +1,116 @@ +--- +id: v2024-source-password-policies-inner +title: SourcePasswordPoliciesInner +pagination_label: SourcePasswordPoliciesInner +sidebar_label: SourcePasswordPoliciesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourcePasswordPoliciesInner', 'V2024SourcePasswordPoliciesInner'] +slug: /tools/sdk/go/v2024/models/source-password-policies-inner +tags: ['SDK', 'Software Development Kit', 'SourcePasswordPoliciesInner', 'V2024SourcePasswordPoliciesInner'] +--- + +# SourcePasswordPoliciesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Policy ID. | [optional] +**Name** | Pointer to **string** | Policy's human-readable display name. | [optional] + +## Methods + +### NewSourcePasswordPoliciesInner + +`func NewSourcePasswordPoliciesInner() *SourcePasswordPoliciesInner` + +NewSourcePasswordPoliciesInner instantiates a new SourcePasswordPoliciesInner 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 + +### NewSourcePasswordPoliciesInnerWithDefaults + +`func NewSourcePasswordPoliciesInnerWithDefaults() *SourcePasswordPoliciesInner` + +NewSourcePasswordPoliciesInnerWithDefaults instantiates a new SourcePasswordPoliciesInner 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 + +### GetType + +`func (o *SourcePasswordPoliciesInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourcePasswordPoliciesInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourcePasswordPoliciesInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourcePasswordPoliciesInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourcePasswordPoliciesInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourcePasswordPoliciesInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourcePasswordPoliciesInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourcePasswordPoliciesInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourcePasswordPoliciesInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourcePasswordPoliciesInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourcePasswordPoliciesInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourcePasswordPoliciesInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceSchedule.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceSchedule.md new file mode 100644 index 000000000..4036ee3ed --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceSchedule.md @@ -0,0 +1,80 @@ +--- +id: v2024-source-schedule +title: SourceSchedule +pagination_label: SourceSchedule +sidebar_label: SourceSchedule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceSchedule', 'V2024SourceSchedule'] +slug: /tools/sdk/go/v2024/models/source-schedule +tags: ['SDK', 'Software Development Kit', 'SourceSchedule', 'V2024SourceSchedule'] +--- + +# SourceSchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of the Schedule. | +**CronExpression** | **string** | The cron expression of the schedule. | + +## Methods + +### NewSourceSchedule + +`func NewSourceSchedule(type_ string, cronExpression string, ) *SourceSchedule` + +NewSourceSchedule instantiates a new SourceSchedule 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 + +### NewSourceScheduleWithDefaults + +`func NewSourceScheduleWithDefaults() *SourceSchedule` + +NewSourceScheduleWithDefaults instantiates a new SourceSchedule 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 + +### GetType + +`func (o *SourceSchedule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceSchedule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceSchedule) SetType(v string)` + +SetType sets Type field to given value. + + +### GetCronExpression + +`func (o *SourceSchedule) GetCronExpression() string` + +GetCronExpression returns the CronExpression field if non-nil, zero value otherwise. + +### GetCronExpressionOk + +`func (o *SourceSchedule) GetCronExpressionOk() (*string, bool)` + +GetCronExpressionOk returns a tuple with the CronExpression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCronExpression + +`func (o *SourceSchedule) SetCronExpression(v string)` + +SetCronExpression sets CronExpression field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceSchemasInner.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceSchemasInner.md new file mode 100644 index 000000000..238556309 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceSchemasInner.md @@ -0,0 +1,116 @@ +--- +id: v2024-source-schemas-inner +title: SourceSchemasInner +pagination_label: SourceSchemasInner +sidebar_label: SourceSchemasInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceSchemasInner', 'V2024SourceSchemasInner'] +slug: /tools/sdk/go/v2024/models/source-schemas-inner +tags: ['SDK', 'Software Development Kit', 'SourceSchemasInner', 'V2024SourceSchemasInner'] +--- + +# SourceSchemasInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Schema ID. | [optional] +**Name** | Pointer to **string** | Schema's human-readable display name. | [optional] + +## Methods + +### NewSourceSchemasInner + +`func NewSourceSchemasInner() *SourceSchemasInner` + +NewSourceSchemasInner instantiates a new SourceSchemasInner 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 + +### NewSourceSchemasInnerWithDefaults + +`func NewSourceSchemasInnerWithDefaults() *SourceSchemasInner` + +NewSourceSchemasInnerWithDefaults instantiates a new SourceSchemasInner 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 + +### GetType + +`func (o *SourceSchemasInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceSchemasInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceSchemasInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceSchemasInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceSchemasInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceSchemasInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceSchemasInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceSchemasInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceSchemasInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceSchemasInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceSchemasInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceSchemasInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceSyncJob.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceSyncJob.md new file mode 100644 index 000000000..cdf9c45f0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceSyncJob.md @@ -0,0 +1,101 @@ +--- +id: v2024-source-sync-job +title: SourceSyncJob +pagination_label: SourceSyncJob +sidebar_label: SourceSyncJob +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceSyncJob', 'V2024SourceSyncJob'] +slug: /tools/sdk/go/v2024/models/source-sync-job +tags: ['SDK', 'Software Development Kit', 'SourceSyncJob', 'V2024SourceSyncJob'] +--- + +# SourceSyncJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Job ID. | +**Status** | **string** | The job status. | +**Payload** | [**SourceSyncPayload**](source-sync-payload) | | + +## Methods + +### NewSourceSyncJob + +`func NewSourceSyncJob(id string, status string, payload SourceSyncPayload, ) *SourceSyncJob` + +NewSourceSyncJob instantiates a new SourceSyncJob 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 + +### NewSourceSyncJobWithDefaults + +`func NewSourceSyncJobWithDefaults() *SourceSyncJob` + +NewSourceSyncJobWithDefaults instantiates a new SourceSyncJob 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 + +### GetId + +`func (o *SourceSyncJob) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceSyncJob) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceSyncJob) SetId(v string)` + +SetId sets Id field to given value. + + +### GetStatus + +`func (o *SourceSyncJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SourceSyncJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SourceSyncJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetPayload + +`func (o *SourceSyncJob) GetPayload() SourceSyncPayload` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *SourceSyncJob) GetPayloadOk() (*SourceSyncPayload, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPayload + +`func (o *SourceSyncJob) SetPayload(v SourceSyncPayload)` + +SetPayload sets Payload field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceSyncPayload.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceSyncPayload.md new file mode 100644 index 000000000..6cafd5d05 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceSyncPayload.md @@ -0,0 +1,80 @@ +--- +id: v2024-source-sync-payload +title: SourceSyncPayload +pagination_label: SourceSyncPayload +sidebar_label: SourceSyncPayload +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceSyncPayload', 'V2024SourceSyncPayload'] +slug: /tools/sdk/go/v2024/models/source-sync-payload +tags: ['SDK', 'Software Development Kit', 'SourceSyncPayload', 'V2024SourceSyncPayload'] +--- + +# SourceSyncPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Payload type. | +**DataJson** | **string** | Payload type. | + +## Methods + +### NewSourceSyncPayload + +`func NewSourceSyncPayload(type_ string, dataJson string, ) *SourceSyncPayload` + +NewSourceSyncPayload instantiates a new SourceSyncPayload 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 + +### NewSourceSyncPayloadWithDefaults + +`func NewSourceSyncPayloadWithDefaults() *SourceSyncPayload` + +NewSourceSyncPayloadWithDefaults instantiates a new SourceSyncPayload 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 + +### GetType + +`func (o *SourceSyncPayload) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceSyncPayload) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceSyncPayload) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDataJson + +`func (o *SourceSyncPayload) GetDataJson() string` + +GetDataJson returns the DataJson field if non-nil, zero value otherwise. + +### GetDataJsonOk + +`func (o *SourceSyncPayload) GetDataJsonOk() (*string, bool)` + +GetDataJsonOk returns a tuple with the DataJson field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataJson + +`func (o *SourceSyncPayload) SetDataJson(v string)` + +SetDataJson sets DataJson field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceUpdated.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceUpdated.md new file mode 100644 index 000000000..d82a15279 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceUpdated.md @@ -0,0 +1,164 @@ +--- +id: v2024-source-updated +title: SourceUpdated +pagination_label: SourceUpdated +sidebar_label: SourceUpdated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUpdated', 'V2024SourceUpdated'] +slug: /tools/sdk/go/v2024/models/source-updated +tags: ['SDK', 'Software Development Kit', 'SourceUpdated', 'V2024SourceUpdated'] +--- + +# SourceUpdated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the source. | +**Name** | **string** | The user friendly name of the source. | +**Type** | **string** | The connection type of the source. | +**Modified** | **SailPointTime** | The date and time the source was modified. | +**Connector** | **string** | The connector type used to connect to the source. | +**Actor** | [**SourceUpdatedActor**](source-updated-actor) | | + +## Methods + +### NewSourceUpdated + +`func NewSourceUpdated(id string, name string, type_ string, modified SailPointTime, connector string, actor SourceUpdatedActor, ) *SourceUpdated` + +NewSourceUpdated instantiates a new SourceUpdated 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 + +### NewSourceUpdatedWithDefaults + +`func NewSourceUpdatedWithDefaults() *SourceUpdated` + +NewSourceUpdatedWithDefaults instantiates a new SourceUpdated 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 + +### GetId + +`func (o *SourceUpdated) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceUpdated) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceUpdated) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceUpdated) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceUpdated) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceUpdated) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *SourceUpdated) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceUpdated) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceUpdated) SetType(v string)` + +SetType sets Type field to given value. + + +### GetModified + +`func (o *SourceUpdated) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SourceUpdated) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SourceUpdated) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetConnector + +`func (o *SourceUpdated) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *SourceUpdated) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *SourceUpdated) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetActor + +`func (o *SourceUpdated) GetActor() SourceUpdatedActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *SourceUpdated) GetActorOk() (*SourceUpdatedActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *SourceUpdated) SetActor(v SourceUpdatedActor)` + +SetActor sets Actor field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceUpdatedActor.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceUpdatedActor.md new file mode 100644 index 000000000..6f7833316 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceUpdatedActor.md @@ -0,0 +1,106 @@ +--- +id: v2024-source-updated-actor +title: SourceUpdatedActor +pagination_label: SourceUpdatedActor +sidebar_label: SourceUpdatedActor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUpdatedActor', 'V2024SourceUpdatedActor'] +slug: /tools/sdk/go/v2024/models/source-updated-actor +tags: ['SDK', 'Software Development Kit', 'SourceUpdatedActor', 'V2024SourceUpdatedActor'] +--- + +# SourceUpdatedActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of identity who updated the source. | +**Id** | Pointer to **string** | ID of identity who updated the source. | [optional] +**Name** | **string** | Display name of identity who updated the source. | + +## Methods + +### NewSourceUpdatedActor + +`func NewSourceUpdatedActor(type_ string, name string, ) *SourceUpdatedActor` + +NewSourceUpdatedActor instantiates a new SourceUpdatedActor 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 + +### NewSourceUpdatedActorWithDefaults + +`func NewSourceUpdatedActorWithDefaults() *SourceUpdatedActor` + +NewSourceUpdatedActorWithDefaults instantiates a new SourceUpdatedActor 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 + +### GetType + +`func (o *SourceUpdatedActor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceUpdatedActor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceUpdatedActor) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *SourceUpdatedActor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceUpdatedActor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceUpdatedActor) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceUpdatedActor) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceUpdatedActor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceUpdatedActor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceUpdatedActor) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceUsage.md new file mode 100644 index 000000000..a071f0687 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceUsage.md @@ -0,0 +1,90 @@ +--- +id: v2024-source-usage +title: SourceUsage +pagination_label: SourceUsage +sidebar_label: SourceUsage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUsage', 'V2024SourceUsage'] +slug: /tools/sdk/go/v2024/models/source-usage +tags: ['SDK', 'Software Development Kit', 'SourceUsage', 'V2024SourceUsage'] +--- + +# SourceUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **string** | The first day of the month for which activity is aggregated. | [optional] +**Count** | Pointer to **float32** | The average number of days that accounts were active within this source, for the month. | [optional] + +## Methods + +### NewSourceUsage + +`func NewSourceUsage() *SourceUsage` + +NewSourceUsage instantiates a new SourceUsage 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 + +### NewSourceUsageWithDefaults + +`func NewSourceUsageWithDefaults() *SourceUsage` + +NewSourceUsageWithDefaults instantiates a new SourceUsage 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 + +### GetDate + +`func (o *SourceUsage) GetDate() string` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *SourceUsage) GetDateOk() (*string, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *SourceUsage) SetDate(v string)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *SourceUsage) HasDate() bool` + +HasDate returns a boolean if a field has been set. + +### GetCount + +`func (o *SourceUsage) GetCount() float32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *SourceUsage) GetCountOk() (*float32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *SourceUsage) SetCount(v float32)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *SourceUsage) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SourceUsageStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/SourceUsageStatus.md new file mode 100644 index 000000000..ea8d41e4b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SourceUsageStatus.md @@ -0,0 +1,64 @@ +--- +id: v2024-source-usage-status +title: SourceUsageStatus +pagination_label: SourceUsageStatus +sidebar_label: SourceUsageStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUsageStatus', 'V2024SourceUsageStatus'] +slug: /tools/sdk/go/v2024/models/source-usage-status +tags: ['SDK', 'Software Development Kit', 'SourceUsageStatus', 'V2024SourceUsageStatus'] +--- + +# SourceUsageStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. | [optional] + +## Methods + +### NewSourceUsageStatus + +`func NewSourceUsageStatus() *SourceUsageStatus` + +NewSourceUsageStatus instantiates a new SourceUsageStatus 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 + +### NewSourceUsageStatusWithDefaults + +`func NewSourceUsageStatusWithDefaults() *SourceUsageStatus` + +NewSourceUsageStatusWithDefaults instantiates a new SourceUsageStatus 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 + +### GetStatus + +`func (o *SourceUsageStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SourceUsageStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SourceUsageStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SourceUsageStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SpConfigExportJob.md b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigExportJob.md new file mode 100644 index 000000000..32baa7838 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigExportJob.md @@ -0,0 +1,190 @@ +--- +id: v2024-sp-config-export-job +title: SpConfigExportJob +pagination_label: SpConfigExportJob +sidebar_label: SpConfigExportJob +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigExportJob', 'V2024SpConfigExportJob'] +slug: /tools/sdk/go/v2024/models/sp-config-export-job +tags: ['SDK', 'Software Development Kit', 'SpConfigExportJob', 'V2024SpConfigExportJob'] +--- + +# SpConfigExportJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **string** | Unique id assigned to this job. | +**Status** | **string** | Status of the job. | +**Type** | **string** | Type of the job, either export or import. | +**Expiration** | **SailPointTime** | The time until which the artifacts will be available for download. | +**Created** | **SailPointTime** | The time the job was started. | +**Modified** | **SailPointTime** | The time of the last update to the job. | +**Description** | Pointer to **string** | Optional user defined description/name for export job. | [optional] + +## Methods + +### NewSpConfigExportJob + +`func NewSpConfigExportJob(jobId string, status string, type_ string, expiration SailPointTime, created SailPointTime, modified SailPointTime, ) *SpConfigExportJob` + +NewSpConfigExportJob instantiates a new SpConfigExportJob 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 + +### NewSpConfigExportJobWithDefaults + +`func NewSpConfigExportJobWithDefaults() *SpConfigExportJob` + +NewSpConfigExportJobWithDefaults instantiates a new SpConfigExportJob 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 + +### GetJobId + +`func (o *SpConfigExportJob) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *SpConfigExportJob) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *SpConfigExportJob) SetJobId(v string)` + +SetJobId sets JobId field to given value. + + +### GetStatus + +`func (o *SpConfigExportJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SpConfigExportJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SpConfigExportJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *SpConfigExportJob) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SpConfigExportJob) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SpConfigExportJob) SetType(v string)` + +SetType sets Type field to given value. + + +### GetExpiration + +`func (o *SpConfigExportJob) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *SpConfigExportJob) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *SpConfigExportJob) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + + +### GetCreated + +`func (o *SpConfigExportJob) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SpConfigExportJob) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SpConfigExportJob) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *SpConfigExportJob) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SpConfigExportJob) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SpConfigExportJob) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetDescription + +`func (o *SpConfigExportJob) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SpConfigExportJob) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SpConfigExportJob) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SpConfigExportJob) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SpConfigExportJobStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigExportJobStatus.md new file mode 100644 index 000000000..58a0d118b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigExportJobStatus.md @@ -0,0 +1,216 @@ +--- +id: v2024-sp-config-export-job-status +title: SpConfigExportJobStatus +pagination_label: SpConfigExportJobStatus +sidebar_label: SpConfigExportJobStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigExportJobStatus', 'V2024SpConfigExportJobStatus'] +slug: /tools/sdk/go/v2024/models/sp-config-export-job-status +tags: ['SDK', 'Software Development Kit', 'SpConfigExportJobStatus', 'V2024SpConfigExportJobStatus'] +--- + +# SpConfigExportJobStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **string** | Unique id assigned to this job. | +**Status** | **string** | Status of the job. | +**Type** | **string** | Type of the job, either export or import. | +**Expiration** | **SailPointTime** | The time until which the artifacts will be available for download. | +**Created** | **SailPointTime** | The time the job was started. | +**Modified** | **SailPointTime** | The time of the last update to the job. | +**Description** | Pointer to **string** | Optional user defined description/name for export job. | [optional] +**Completed** | Pointer to **SailPointTime** | The time the job was completed. | [optional] + +## Methods + +### NewSpConfigExportJobStatus + +`func NewSpConfigExportJobStatus(jobId string, status string, type_ string, expiration SailPointTime, created SailPointTime, modified SailPointTime, ) *SpConfigExportJobStatus` + +NewSpConfigExportJobStatus instantiates a new SpConfigExportJobStatus 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 + +### NewSpConfigExportJobStatusWithDefaults + +`func NewSpConfigExportJobStatusWithDefaults() *SpConfigExportJobStatus` + +NewSpConfigExportJobStatusWithDefaults instantiates a new SpConfigExportJobStatus 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 + +### GetJobId + +`func (o *SpConfigExportJobStatus) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *SpConfigExportJobStatus) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *SpConfigExportJobStatus) SetJobId(v string)` + +SetJobId sets JobId field to given value. + + +### GetStatus + +`func (o *SpConfigExportJobStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SpConfigExportJobStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SpConfigExportJobStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *SpConfigExportJobStatus) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SpConfigExportJobStatus) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SpConfigExportJobStatus) SetType(v string)` + +SetType sets Type field to given value. + + +### GetExpiration + +`func (o *SpConfigExportJobStatus) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *SpConfigExportJobStatus) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *SpConfigExportJobStatus) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + + +### GetCreated + +`func (o *SpConfigExportJobStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SpConfigExportJobStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SpConfigExportJobStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *SpConfigExportJobStatus) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SpConfigExportJobStatus) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SpConfigExportJobStatus) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetDescription + +`func (o *SpConfigExportJobStatus) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SpConfigExportJobStatus) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SpConfigExportJobStatus) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SpConfigExportJobStatus) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetCompleted + +`func (o *SpConfigExportJobStatus) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *SpConfigExportJobStatus) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *SpConfigExportJobStatus) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *SpConfigExportJobStatus) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SpConfigExportResults.md b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigExportResults.md new file mode 100644 index 000000000..05e378504 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigExportResults.md @@ -0,0 +1,194 @@ +--- +id: v2024-sp-config-export-results +title: SpConfigExportResults +pagination_label: SpConfigExportResults +sidebar_label: SpConfigExportResults +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigExportResults', 'V2024SpConfigExportResults'] +slug: /tools/sdk/go/v2024/models/sp-config-export-results +tags: ['SDK', 'Software Development Kit', 'SpConfigExportResults', 'V2024SpConfigExportResults'] +--- + +# SpConfigExportResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **int32** | Current version of the export results object. | [optional] +**Timestamp** | Pointer to **SailPointTime** | Time the export was completed. | [optional] +**Tenant** | Pointer to **string** | Name of the tenant where this export originated. | [optional] +**Description** | Pointer to **string** | Optional user defined description/name for export job. | [optional] +**Options** | Pointer to [**ExportOptions1**](export-options1) | | [optional] +**Objects** | Pointer to [**[]ConfigObject**](config-object) | | [optional] + +## Methods + +### NewSpConfigExportResults + +`func NewSpConfigExportResults() *SpConfigExportResults` + +NewSpConfigExportResults instantiates a new SpConfigExportResults 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 + +### NewSpConfigExportResultsWithDefaults + +`func NewSpConfigExportResultsWithDefaults() *SpConfigExportResults` + +NewSpConfigExportResultsWithDefaults instantiates a new SpConfigExportResults 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 + +### GetVersion + +`func (o *SpConfigExportResults) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *SpConfigExportResults) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *SpConfigExportResults) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *SpConfigExportResults) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### GetTimestamp + +`func (o *SpConfigExportResults) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *SpConfigExportResults) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *SpConfigExportResults) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *SpConfigExportResults) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + +### GetTenant + +`func (o *SpConfigExportResults) GetTenant() string` + +GetTenant returns the Tenant field if non-nil, zero value otherwise. + +### GetTenantOk + +`func (o *SpConfigExportResults) GetTenantOk() (*string, bool)` + +GetTenantOk returns a tuple with the Tenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenant + +`func (o *SpConfigExportResults) SetTenant(v string)` + +SetTenant sets Tenant field to given value. + +### HasTenant + +`func (o *SpConfigExportResults) HasTenant() bool` + +HasTenant returns a boolean if a field has been set. + +### GetDescription + +`func (o *SpConfigExportResults) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SpConfigExportResults) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SpConfigExportResults) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SpConfigExportResults) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOptions + +`func (o *SpConfigExportResults) GetOptions() ExportOptions1` + +GetOptions returns the Options field if non-nil, zero value otherwise. + +### GetOptionsOk + +`func (o *SpConfigExportResults) GetOptionsOk() (*ExportOptions1, bool)` + +GetOptionsOk returns a tuple with the Options field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOptions + +`func (o *SpConfigExportResults) SetOptions(v ExportOptions1)` + +SetOptions sets Options field to given value. + +### HasOptions + +`func (o *SpConfigExportResults) HasOptions() bool` + +HasOptions returns a boolean if a field has been set. + +### GetObjects + +`func (o *SpConfigExportResults) GetObjects() []ConfigObject` + +GetObjects returns the Objects field if non-nil, zero value otherwise. + +### GetObjectsOk + +`func (o *SpConfigExportResults) GetObjectsOk() (*[]ConfigObject, bool)` + +GetObjectsOk returns a tuple with the Objects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjects + +`func (o *SpConfigExportResults) SetObjects(v []ConfigObject)` + +SetObjects sets Objects field to given value. + +### HasObjects + +`func (o *SpConfigExportResults) HasObjects() bool` + +HasObjects returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SpConfigImportJobStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigImportJobStatus.md new file mode 100644 index 000000000..36c1305d8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigImportJobStatus.md @@ -0,0 +1,216 @@ +--- +id: v2024-sp-config-import-job-status +title: SpConfigImportJobStatus +pagination_label: SpConfigImportJobStatus +sidebar_label: SpConfigImportJobStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigImportJobStatus', 'V2024SpConfigImportJobStatus'] +slug: /tools/sdk/go/v2024/models/sp-config-import-job-status +tags: ['SDK', 'Software Development Kit', 'SpConfigImportJobStatus', 'V2024SpConfigImportJobStatus'] +--- + +# SpConfigImportJobStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **string** | Unique id assigned to this job. | +**Status** | **string** | Status of the job. | +**Type** | **string** | Type of the job, either export or import. | +**Expiration** | **SailPointTime** | The time until which the artifacts will be available for download. | +**Created** | **SailPointTime** | The time the job was started. | +**Modified** | **SailPointTime** | The time of the last update to the job. | +**Message** | Pointer to **string** | This message contains additional information about the overall status of the job. | [optional] +**Completed** | Pointer to **SailPointTime** | The time the job was completed. | [optional] + +## Methods + +### NewSpConfigImportJobStatus + +`func NewSpConfigImportJobStatus(jobId string, status string, type_ string, expiration SailPointTime, created SailPointTime, modified SailPointTime, ) *SpConfigImportJobStatus` + +NewSpConfigImportJobStatus instantiates a new SpConfigImportJobStatus 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 + +### NewSpConfigImportJobStatusWithDefaults + +`func NewSpConfigImportJobStatusWithDefaults() *SpConfigImportJobStatus` + +NewSpConfigImportJobStatusWithDefaults instantiates a new SpConfigImportJobStatus 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 + +### GetJobId + +`func (o *SpConfigImportJobStatus) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *SpConfigImportJobStatus) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *SpConfigImportJobStatus) SetJobId(v string)` + +SetJobId sets JobId field to given value. + + +### GetStatus + +`func (o *SpConfigImportJobStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SpConfigImportJobStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SpConfigImportJobStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *SpConfigImportJobStatus) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SpConfigImportJobStatus) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SpConfigImportJobStatus) SetType(v string)` + +SetType sets Type field to given value. + + +### GetExpiration + +`func (o *SpConfigImportJobStatus) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *SpConfigImportJobStatus) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *SpConfigImportJobStatus) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + + +### GetCreated + +`func (o *SpConfigImportJobStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SpConfigImportJobStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SpConfigImportJobStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *SpConfigImportJobStatus) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SpConfigImportJobStatus) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SpConfigImportJobStatus) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetMessage + +`func (o *SpConfigImportJobStatus) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *SpConfigImportJobStatus) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *SpConfigImportJobStatus) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *SpConfigImportJobStatus) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetCompleted + +`func (o *SpConfigImportJobStatus) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *SpConfigImportJobStatus) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *SpConfigImportJobStatus) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *SpConfigImportJobStatus) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SpConfigImportResults.md b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigImportResults.md new file mode 100644 index 000000000..aa2edccef --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigImportResults.md @@ -0,0 +1,85 @@ +--- +id: v2024-sp-config-import-results +title: SpConfigImportResults +pagination_label: SpConfigImportResults +sidebar_label: SpConfigImportResults +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigImportResults', 'V2024SpConfigImportResults'] +slug: /tools/sdk/go/v2024/models/sp-config-import-results +tags: ['SDK', 'Software Development Kit', 'SpConfigImportResults', 'V2024SpConfigImportResults'] +--- + +# SpConfigImportResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | [**map[string]ObjectImportResult1**](object-import-result1) | The results of an object configuration import job. | +**ExportJobId** | Pointer to **string** | If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export. | [optional] + +## Methods + +### NewSpConfigImportResults + +`func NewSpConfigImportResults(results map[string]ObjectImportResult1, ) *SpConfigImportResults` + +NewSpConfigImportResults instantiates a new SpConfigImportResults 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 + +### NewSpConfigImportResultsWithDefaults + +`func NewSpConfigImportResultsWithDefaults() *SpConfigImportResults` + +NewSpConfigImportResultsWithDefaults instantiates a new SpConfigImportResults 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 + +### GetResults + +`func (o *SpConfigImportResults) GetResults() map[string]ObjectImportResult1` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *SpConfigImportResults) GetResultsOk() (*map[string]ObjectImportResult1, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *SpConfigImportResults) SetResults(v map[string]ObjectImportResult1)` + +SetResults sets Results field to given value. + + +### GetExportJobId + +`func (o *SpConfigImportResults) GetExportJobId() string` + +GetExportJobId returns the ExportJobId field if non-nil, zero value otherwise. + +### GetExportJobIdOk + +`func (o *SpConfigImportResults) GetExportJobIdOk() (*string, bool)` + +GetExportJobIdOk returns a tuple with the ExportJobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExportJobId + +`func (o *SpConfigImportResults) SetExportJobId(v string)` + +SetExportJobId sets ExportJobId field to given value. + +### HasExportJobId + +`func (o *SpConfigImportResults) HasExportJobId() bool` + +HasExportJobId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SpConfigJob.md b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigJob.md new file mode 100644 index 000000000..82095e541 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigJob.md @@ -0,0 +1,164 @@ +--- +id: v2024-sp-config-job +title: SpConfigJob +pagination_label: SpConfigJob +sidebar_label: SpConfigJob +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigJob', 'V2024SpConfigJob'] +slug: /tools/sdk/go/v2024/models/sp-config-job +tags: ['SDK', 'Software Development Kit', 'SpConfigJob', 'V2024SpConfigJob'] +--- + +# SpConfigJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **string** | Unique id assigned to this job. | +**Status** | **string** | Status of the job. | +**Type** | **string** | Type of the job, either export or import. | +**Expiration** | **SailPointTime** | The time until which the artifacts will be available for download. | +**Created** | **SailPointTime** | The time the job was started. | +**Modified** | **SailPointTime** | The time of the last update to the job. | + +## Methods + +### NewSpConfigJob + +`func NewSpConfigJob(jobId string, status string, type_ string, expiration SailPointTime, created SailPointTime, modified SailPointTime, ) *SpConfigJob` + +NewSpConfigJob instantiates a new SpConfigJob 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 + +### NewSpConfigJobWithDefaults + +`func NewSpConfigJobWithDefaults() *SpConfigJob` + +NewSpConfigJobWithDefaults instantiates a new SpConfigJob 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 + +### GetJobId + +`func (o *SpConfigJob) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *SpConfigJob) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *SpConfigJob) SetJobId(v string)` + +SetJobId sets JobId field to given value. + + +### GetStatus + +`func (o *SpConfigJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SpConfigJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SpConfigJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *SpConfigJob) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SpConfigJob) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SpConfigJob) SetType(v string)` + +SetType sets Type field to given value. + + +### GetExpiration + +`func (o *SpConfigJob) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *SpConfigJob) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *SpConfigJob) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + + +### GetCreated + +`func (o *SpConfigJob) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SpConfigJob) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SpConfigJob) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *SpConfigJob) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SpConfigJob) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SpConfigJob) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SpConfigMessage.md b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigMessage.md new file mode 100644 index 000000000..823d2bc76 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigMessage.md @@ -0,0 +1,101 @@ +--- +id: v2024-sp-config-message +title: SpConfigMessage +pagination_label: SpConfigMessage +sidebar_label: SpConfigMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigMessage', 'V2024SpConfigMessage'] +slug: /tools/sdk/go/v2024/models/sp-config-message +tags: ['SDK', 'Software Development Kit', 'SpConfigMessage', 'V2024SpConfigMessage'] +--- + +# SpConfigMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **string** | Message key. | +**Text** | **string** | Message text. | +**Details** | **map[string]interface{}** | Message details if any, in key:value pairs. | + +## Methods + +### NewSpConfigMessage + +`func NewSpConfigMessage(key string, text string, details map[string]interface{}, ) *SpConfigMessage` + +NewSpConfigMessage instantiates a new SpConfigMessage 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 + +### NewSpConfigMessageWithDefaults + +`func NewSpConfigMessageWithDefaults() *SpConfigMessage` + +NewSpConfigMessageWithDefaults instantiates a new SpConfigMessage 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 + +### GetKey + +`func (o *SpConfigMessage) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *SpConfigMessage) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *SpConfigMessage) SetKey(v string)` + +SetKey sets Key field to given value. + + +### GetText + +`func (o *SpConfigMessage) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *SpConfigMessage) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *SpConfigMessage) SetText(v string)` + +SetText sets Text field to given value. + + +### GetDetails + +`func (o *SpConfigMessage) GetDetails() map[string]interface{}` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *SpConfigMessage) GetDetailsOk() (*map[string]interface{}, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *SpConfigMessage) SetDetails(v map[string]interface{})` + +SetDetails sets Details field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SpConfigMessage1.md b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigMessage1.md new file mode 100644 index 000000000..8b3588e48 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigMessage1.md @@ -0,0 +1,101 @@ +--- +id: v2024-sp-config-message1 +title: SpConfigMessage1 +pagination_label: SpConfigMessage1 +sidebar_label: SpConfigMessage1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigMessage1', 'V2024SpConfigMessage1'] +slug: /tools/sdk/go/v2024/models/sp-config-message1 +tags: ['SDK', 'Software Development Kit', 'SpConfigMessage1', 'V2024SpConfigMessage1'] +--- + +# SpConfigMessage1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **string** | Message key. | +**Text** | **string** | Message text. | +**Details** | **map[string]map[string]interface{}** | Message details if any, in key:value pairs. | + +## Methods + +### NewSpConfigMessage1 + +`func NewSpConfigMessage1(key string, text string, details map[string]map[string]interface{}, ) *SpConfigMessage1` + +NewSpConfigMessage1 instantiates a new SpConfigMessage1 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 + +### NewSpConfigMessage1WithDefaults + +`func NewSpConfigMessage1WithDefaults() *SpConfigMessage1` + +NewSpConfigMessage1WithDefaults instantiates a new SpConfigMessage1 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 + +### GetKey + +`func (o *SpConfigMessage1) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *SpConfigMessage1) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *SpConfigMessage1) SetKey(v string)` + +SetKey sets Key field to given value. + + +### GetText + +`func (o *SpConfigMessage1) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *SpConfigMessage1) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *SpConfigMessage1) SetText(v string)` + +SetText sets Text field to given value. + + +### GetDetails + +`func (o *SpConfigMessage1) GetDetails() map[string]map[string]interface{}` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *SpConfigMessage1) GetDetailsOk() (*map[string]map[string]interface{}, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *SpConfigMessage1) SetDetails(v map[string]map[string]interface{})` + +SetDetails sets Details field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SpConfigObject.md b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigObject.md new file mode 100644 index 000000000..0d033acff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigObject.md @@ -0,0 +1,256 @@ +--- +id: v2024-sp-config-object +title: SpConfigObject +pagination_label: SpConfigObject +sidebar_label: SpConfigObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigObject', 'V2024SpConfigObject'] +slug: /tools/sdk/go/v2024/models/sp-config-object +tags: ['SDK', 'Software Development Kit', 'SpConfigObject', 'V2024SpConfigObject'] +--- + +# SpConfigObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectType** | Pointer to **string** | Object type the configuration is for. | [optional] +**ReferenceExtractors** | Pointer to **[]string** | List of JSON paths within an exported object of this type, representing references that must be resolved. | [optional] +**SignatureRequired** | Pointer to **bool** | Indicates whether this type of object will be JWS signed and cannot be modified before import. | [optional] [default to false] +**AlwaysResolveById** | Pointer to **bool** | Indicates whether this object type must be always be resolved by ID. | [optional] [default to false] +**LegacyObject** | Pointer to **bool** | Indicates whether this is a legacy object. | [optional] [default to false] +**OnePerTenant** | Pointer to **bool** | Indicates whether there is only one object of this type. | [optional] [default to false] +**Exportable** | Pointer to **bool** | Indicates whether the object can be exported or is just a reference object. | [optional] [default to false] +**Rules** | Pointer to [**SpConfigRules**](sp-config-rules) | | [optional] + +## Methods + +### NewSpConfigObject + +`func NewSpConfigObject() *SpConfigObject` + +NewSpConfigObject instantiates a new SpConfigObject 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 + +### NewSpConfigObjectWithDefaults + +`func NewSpConfigObjectWithDefaults() *SpConfigObject` + +NewSpConfigObjectWithDefaults instantiates a new SpConfigObject 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 + +### GetObjectType + +`func (o *SpConfigObject) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *SpConfigObject) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *SpConfigObject) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + +### HasObjectType + +`func (o *SpConfigObject) HasObjectType() bool` + +HasObjectType returns a boolean if a field has been set. + +### GetReferenceExtractors + +`func (o *SpConfigObject) GetReferenceExtractors() []string` + +GetReferenceExtractors returns the ReferenceExtractors field if non-nil, zero value otherwise. + +### GetReferenceExtractorsOk + +`func (o *SpConfigObject) GetReferenceExtractorsOk() (*[]string, bool)` + +GetReferenceExtractorsOk returns a tuple with the ReferenceExtractors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReferenceExtractors + +`func (o *SpConfigObject) SetReferenceExtractors(v []string)` + +SetReferenceExtractors sets ReferenceExtractors field to given value. + +### HasReferenceExtractors + +`func (o *SpConfigObject) HasReferenceExtractors() bool` + +HasReferenceExtractors returns a boolean if a field has been set. + +### SetReferenceExtractorsNil + +`func (o *SpConfigObject) SetReferenceExtractorsNil(b bool)` + + SetReferenceExtractorsNil sets the value for ReferenceExtractors to be an explicit nil + +### UnsetReferenceExtractors +`func (o *SpConfigObject) UnsetReferenceExtractors()` + +UnsetReferenceExtractors ensures that no value is present for ReferenceExtractors, not even an explicit nil +### GetSignatureRequired + +`func (o *SpConfigObject) GetSignatureRequired() bool` + +GetSignatureRequired returns the SignatureRequired field if non-nil, zero value otherwise. + +### GetSignatureRequiredOk + +`func (o *SpConfigObject) GetSignatureRequiredOk() (*bool, bool)` + +GetSignatureRequiredOk returns a tuple with the SignatureRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignatureRequired + +`func (o *SpConfigObject) SetSignatureRequired(v bool)` + +SetSignatureRequired sets SignatureRequired field to given value. + +### HasSignatureRequired + +`func (o *SpConfigObject) HasSignatureRequired() bool` + +HasSignatureRequired returns a boolean if a field has been set. + +### GetAlwaysResolveById + +`func (o *SpConfigObject) GetAlwaysResolveById() bool` + +GetAlwaysResolveById returns the AlwaysResolveById field if non-nil, zero value otherwise. + +### GetAlwaysResolveByIdOk + +`func (o *SpConfigObject) GetAlwaysResolveByIdOk() (*bool, bool)` + +GetAlwaysResolveByIdOk returns a tuple with the AlwaysResolveById field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlwaysResolveById + +`func (o *SpConfigObject) SetAlwaysResolveById(v bool)` + +SetAlwaysResolveById sets AlwaysResolveById field to given value. + +### HasAlwaysResolveById + +`func (o *SpConfigObject) HasAlwaysResolveById() bool` + +HasAlwaysResolveById returns a boolean if a field has been set. + +### GetLegacyObject + +`func (o *SpConfigObject) GetLegacyObject() bool` + +GetLegacyObject returns the LegacyObject field if non-nil, zero value otherwise. + +### GetLegacyObjectOk + +`func (o *SpConfigObject) GetLegacyObjectOk() (*bool, bool)` + +GetLegacyObjectOk returns a tuple with the LegacyObject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyObject + +`func (o *SpConfigObject) SetLegacyObject(v bool)` + +SetLegacyObject sets LegacyObject field to given value. + +### HasLegacyObject + +`func (o *SpConfigObject) HasLegacyObject() bool` + +HasLegacyObject returns a boolean if a field has been set. + +### GetOnePerTenant + +`func (o *SpConfigObject) GetOnePerTenant() bool` + +GetOnePerTenant returns the OnePerTenant field if non-nil, zero value otherwise. + +### GetOnePerTenantOk + +`func (o *SpConfigObject) GetOnePerTenantOk() (*bool, bool)` + +GetOnePerTenantOk returns a tuple with the OnePerTenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOnePerTenant + +`func (o *SpConfigObject) SetOnePerTenant(v bool)` + +SetOnePerTenant sets OnePerTenant field to given value. + +### HasOnePerTenant + +`func (o *SpConfigObject) HasOnePerTenant() bool` + +HasOnePerTenant returns a boolean if a field has been set. + +### GetExportable + +`func (o *SpConfigObject) GetExportable() bool` + +GetExportable returns the Exportable field if non-nil, zero value otherwise. + +### GetExportableOk + +`func (o *SpConfigObject) GetExportableOk() (*bool, bool)` + +GetExportableOk returns a tuple with the Exportable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExportable + +`func (o *SpConfigObject) SetExportable(v bool)` + +SetExportable sets Exportable field to given value. + +### HasExportable + +`func (o *SpConfigObject) HasExportable() bool` + +HasExportable returns a boolean if a field has been set. + +### GetRules + +`func (o *SpConfigObject) GetRules() SpConfigRules` + +GetRules returns the Rules field if non-nil, zero value otherwise. + +### GetRulesOk + +`func (o *SpConfigObject) GetRulesOk() (*SpConfigRules, bool)` + +GetRulesOk returns a tuple with the Rules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRules + +`func (o *SpConfigObject) SetRules(v SpConfigRules)` + +SetRules sets Rules field to given value. + +### HasRules + +`func (o *SpConfigObject) HasRules() bool` + +HasRules returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SpConfigRule.md b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigRule.md new file mode 100644 index 000000000..56062ed47 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigRule.md @@ -0,0 +1,126 @@ +--- +id: v2024-sp-config-rule +title: SpConfigRule +pagination_label: SpConfigRule +sidebar_label: SpConfigRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigRule', 'V2024SpConfigRule'] +slug: /tools/sdk/go/v2024/models/sp-config-rule +tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'V2024SpConfigRule'] +--- + +# SpConfigRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Path** | Pointer to **string** | JSONPath expression denoting the path within the object where a value substitution should be applied. | [optional] +**Value** | Pointer to [**NullableSpConfigRuleValue**](sp-config-rule-value) | | [optional] +**Modes** | Pointer to **[]string** | Draft modes the rule will apply to. | [optional] + +## Methods + +### NewSpConfigRule + +`func NewSpConfigRule() *SpConfigRule` + +NewSpConfigRule instantiates a new SpConfigRule 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 + +### NewSpConfigRuleWithDefaults + +`func NewSpConfigRuleWithDefaults() *SpConfigRule` + +NewSpConfigRuleWithDefaults instantiates a new SpConfigRule 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 + +### GetPath + +`func (o *SpConfigRule) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *SpConfigRule) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *SpConfigRule) SetPath(v string)` + +SetPath sets Path field to given value. + +### HasPath + +`func (o *SpConfigRule) HasPath() bool` + +HasPath returns a boolean if a field has been set. + +### GetValue + +`func (o *SpConfigRule) GetValue() SpConfigRuleValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SpConfigRule) GetValueOk() (*SpConfigRuleValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SpConfigRule) SetValue(v SpConfigRuleValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SpConfigRule) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *SpConfigRule) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *SpConfigRule) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetModes + +`func (o *SpConfigRule) GetModes() []string` + +GetModes returns the Modes field if non-nil, zero value otherwise. + +### GetModesOk + +`func (o *SpConfigRule) GetModesOk() (*[]string, bool)` + +GetModesOk returns a tuple with the Modes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModes + +`func (o *SpConfigRule) SetModes(v []string)` + +SetModes sets Modes field to given value. + +### HasModes + +`func (o *SpConfigRule) HasModes() bool` + +HasModes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SpConfigRuleValue.md b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigRuleValue.md new file mode 100644 index 000000000..aa1ed3d04 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigRuleValue.md @@ -0,0 +1,38 @@ +--- +id: v2024-sp-config-rule-value +title: SpConfigRuleValue +pagination_label: SpConfigRuleValue +sidebar_label: SpConfigRuleValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigRuleValue', 'V2024SpConfigRuleValue'] +slug: /tools/sdk/go/v2024/models/sp-config-rule-value +tags: ['SDK', 'Software Development Kit', 'SpConfigRuleValue', 'V2024SpConfigRuleValue'] +--- + +# SpConfigRuleValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewSpConfigRuleValue + +`func NewSpConfigRuleValue() *SpConfigRuleValue` + +NewSpConfigRuleValue instantiates a new SpConfigRuleValue 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 + +### NewSpConfigRuleValueWithDefaults + +`func NewSpConfigRuleValueWithDefaults() *SpConfigRuleValue` + +NewSpConfigRuleValueWithDefaults instantiates a new SpConfigRuleValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SpConfigRules.md b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigRules.md new file mode 100644 index 000000000..dce915720 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SpConfigRules.md @@ -0,0 +1,116 @@ +--- +id: v2024-sp-config-rules +title: SpConfigRules +pagination_label: SpConfigRules +sidebar_label: SpConfigRules +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigRules', 'V2024SpConfigRules'] +slug: /tools/sdk/go/v2024/models/sp-config-rules +tags: ['SDK', 'Software Development Kit', 'SpConfigRules', 'V2024SpConfigRules'] +--- + +# SpConfigRules + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TakeFromTargetRules** | Pointer to [**[]SpConfigRule**](sp-config-rule) | | [optional] +**DefaultRules** | Pointer to [**[]SpConfigRule**](sp-config-rule) | | [optional] +**Editable** | Pointer to **bool** | Indicates whether the object can be edited. | [optional] [default to false] + +## Methods + +### NewSpConfigRules + +`func NewSpConfigRules() *SpConfigRules` + +NewSpConfigRules instantiates a new SpConfigRules 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 + +### NewSpConfigRulesWithDefaults + +`func NewSpConfigRulesWithDefaults() *SpConfigRules` + +NewSpConfigRulesWithDefaults instantiates a new SpConfigRules 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 + +### GetTakeFromTargetRules + +`func (o *SpConfigRules) GetTakeFromTargetRules() []SpConfigRule` + +GetTakeFromTargetRules returns the TakeFromTargetRules field if non-nil, zero value otherwise. + +### GetTakeFromTargetRulesOk + +`func (o *SpConfigRules) GetTakeFromTargetRulesOk() (*[]SpConfigRule, bool)` + +GetTakeFromTargetRulesOk returns a tuple with the TakeFromTargetRules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTakeFromTargetRules + +`func (o *SpConfigRules) SetTakeFromTargetRules(v []SpConfigRule)` + +SetTakeFromTargetRules sets TakeFromTargetRules field to given value. + +### HasTakeFromTargetRules + +`func (o *SpConfigRules) HasTakeFromTargetRules() bool` + +HasTakeFromTargetRules returns a boolean if a field has been set. + +### GetDefaultRules + +`func (o *SpConfigRules) GetDefaultRules() []SpConfigRule` + +GetDefaultRules returns the DefaultRules field if non-nil, zero value otherwise. + +### GetDefaultRulesOk + +`func (o *SpConfigRules) GetDefaultRulesOk() (*[]SpConfigRule, bool)` + +GetDefaultRulesOk returns a tuple with the DefaultRules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultRules + +`func (o *SpConfigRules) SetDefaultRules(v []SpConfigRule)` + +SetDefaultRules sets DefaultRules field to given value. + +### HasDefaultRules + +`func (o *SpConfigRules) HasDefaultRules() bool` + +HasDefaultRules returns a boolean if a field has been set. + +### GetEditable + +`func (o *SpConfigRules) GetEditable() bool` + +GetEditable returns the Editable field if non-nil, zero value otherwise. + +### GetEditableOk + +`func (o *SpConfigRules) GetEditableOk() (*bool, bool)` + +GetEditableOk returns a tuple with the Editable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEditable + +`func (o *SpConfigRules) SetEditable(v bool)` + +SetEditable sets Editable field to given value. + +### HasEditable + +`func (o *SpConfigRules) HasEditable() bool` + +HasEditable returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SpDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/SpDetails.md new file mode 100644 index 000000000..782a62d46 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SpDetails.md @@ -0,0 +1,163 @@ +--- +id: v2024-sp-details +title: SpDetails +pagination_label: SpDetails +sidebar_label: SpDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpDetails', 'V2024SpDetails'] +slug: /tools/sdk/go/v2024/models/sp-details +tags: ['SDK', 'Software Development Kit', 'SpDetails', 'V2024SpDetails'] +--- + +# SpDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | Pointer to **string** | Federation protocol role | [optional] +**EntityId** | Pointer to **string** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Alias** | Pointer to **string** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**CallbackUrl** | **string** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | +**LegacyAcsUrl** | Pointer to **string** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] + +## Methods + +### NewSpDetails + +`func NewSpDetails(callbackUrl string, ) *SpDetails` + +NewSpDetails instantiates a new SpDetails 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 + +### NewSpDetailsWithDefaults + +`func NewSpDetailsWithDefaults() *SpDetails` + +NewSpDetailsWithDefaults instantiates a new SpDetails 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 + +### GetRole + +`func (o *SpDetails) GetRole() string` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *SpDetails) GetRoleOk() (*string, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *SpDetails) SetRole(v string)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *SpDetails) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetEntityId + +`func (o *SpDetails) GetEntityId() string` + +GetEntityId returns the EntityId field if non-nil, zero value otherwise. + +### GetEntityIdOk + +`func (o *SpDetails) GetEntityIdOk() (*string, bool)` + +GetEntityIdOk returns a tuple with the EntityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntityId + +`func (o *SpDetails) SetEntityId(v string)` + +SetEntityId sets EntityId field to given value. + +### HasEntityId + +`func (o *SpDetails) HasEntityId() bool` + +HasEntityId returns a boolean if a field has been set. + +### GetAlias + +`func (o *SpDetails) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *SpDetails) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *SpDetails) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *SpDetails) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + +### GetCallbackUrl + +`func (o *SpDetails) GetCallbackUrl() string` + +GetCallbackUrl returns the CallbackUrl field if non-nil, zero value otherwise. + +### GetCallbackUrlOk + +`func (o *SpDetails) GetCallbackUrlOk() (*string, bool)` + +GetCallbackUrlOk returns a tuple with the CallbackUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCallbackUrl + +`func (o *SpDetails) SetCallbackUrl(v string)` + +SetCallbackUrl sets CallbackUrl field to given value. + + +### GetLegacyAcsUrl + +`func (o *SpDetails) GetLegacyAcsUrl() string` + +GetLegacyAcsUrl returns the LegacyAcsUrl field if non-nil, zero value otherwise. + +### GetLegacyAcsUrlOk + +`func (o *SpDetails) GetLegacyAcsUrlOk() (*string, bool)` + +GetLegacyAcsUrlOk returns a tuple with the LegacyAcsUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyAcsUrl + +`func (o *SpDetails) SetLegacyAcsUrl(v string)` + +SetLegacyAcsUrl sets LegacyAcsUrl field to given value. + +### HasLegacyAcsUrl + +`func (o *SpDetails) HasLegacyAcsUrl() bool` + +HasLegacyAcsUrl returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/StandardLevel.md b/docs/tools/sdk/go/Reference/V2024/Models/StandardLevel.md new file mode 100644 index 000000000..04b89b60e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/StandardLevel.md @@ -0,0 +1,31 @@ +--- +id: v2024-standard-level +title: StandardLevel +pagination_label: StandardLevel +sidebar_label: StandardLevel +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'StandardLevel', 'V2024StandardLevel'] +slug: /tools/sdk/go/v2024/models/standard-level +tags: ['SDK', 'Software Development Kit', 'StandardLevel', 'V2024StandardLevel'] +--- + +# StandardLevel + +## Enum + + +* `FALSE` (value: `"false"`) + +* `FATAL` (value: `"FATAL"`) + +* `ERROR` (value: `"ERROR"`) + +* `WARN` (value: `"WARN"`) + +* `INFO` (value: `"INFO"`) + +* `DEBUG` (value: `"DEBUG"`) + +* `TRACE` (value: `"TRACE"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/StartInvocationInput.md b/docs/tools/sdk/go/Reference/V2024/Models/StartInvocationInput.md new file mode 100644 index 000000000..cfb2dace8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/StartInvocationInput.md @@ -0,0 +1,116 @@ +--- +id: v2024-start-invocation-input +title: StartInvocationInput +pagination_label: StartInvocationInput +sidebar_label: StartInvocationInput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'StartInvocationInput', 'V2024StartInvocationInput'] +slug: /tools/sdk/go/v2024/models/start-invocation-input +tags: ['SDK', 'Software Development Kit', 'StartInvocationInput', 'V2024StartInvocationInput'] +--- + +# StartInvocationInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TriggerId** | Pointer to **string** | Trigger ID | [optional] +**Input** | Pointer to **map[string]interface{}** | Trigger input payload. Its schema is defined in the trigger definition. | [optional] +**ContentJson** | Pointer to **map[string]interface{}** | JSON map of invocation metadata | [optional] + +## Methods + +### NewStartInvocationInput + +`func NewStartInvocationInput() *StartInvocationInput` + +NewStartInvocationInput instantiates a new StartInvocationInput 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 + +### NewStartInvocationInputWithDefaults + +`func NewStartInvocationInputWithDefaults() *StartInvocationInput` + +NewStartInvocationInputWithDefaults instantiates a new StartInvocationInput 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 + +### GetTriggerId + +`func (o *StartInvocationInput) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *StartInvocationInput) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *StartInvocationInput) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + +### HasTriggerId + +`func (o *StartInvocationInput) HasTriggerId() bool` + +HasTriggerId returns a boolean if a field has been set. + +### GetInput + +`func (o *StartInvocationInput) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *StartInvocationInput) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *StartInvocationInput) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + +### HasInput + +`func (o *StartInvocationInput) HasInput() bool` + +HasInput returns a boolean if a field has been set. + +### GetContentJson + +`func (o *StartInvocationInput) GetContentJson() map[string]interface{}` + +GetContentJson returns the ContentJson field if non-nil, zero value otherwise. + +### GetContentJsonOk + +`func (o *StartInvocationInput) GetContentJsonOk() (*map[string]interface{}, bool)` + +GetContentJsonOk returns a tuple with the ContentJson field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContentJson + +`func (o *StartInvocationInput) SetContentJson(v map[string]interface{})` + +SetContentJson sets ContentJson field to given value. + +### HasContentJson + +`func (o *StartInvocationInput) HasContentJson() bool` + +HasContentJson returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/StatusResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/StatusResponse.md new file mode 100644 index 000000000..c58d8fbf9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/StatusResponse.md @@ -0,0 +1,168 @@ +--- +id: v2024-status-response +title: StatusResponse +pagination_label: StatusResponse +sidebar_label: StatusResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'StatusResponse', 'V2024StatusResponse'] +slug: /tools/sdk/go/v2024/models/status-response +tags: ['SDK', 'Software Development Kit', 'StatusResponse', 'V2024StatusResponse'] +--- + +# StatusResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the source | [optional] [readonly] +**Name** | Pointer to **string** | Name of the source | [optional] [readonly] +**Status** | Pointer to **string** | The status of the health check. | [optional] [readonly] +**ElapsedMillis** | Pointer to **int32** | The number of milliseconds spent on the entire request. | [optional] [readonly] +**Details** | Pointer to **map[string]interface{}** | The document contains the results of the health check. The schema of this document depends on the type of source used. | [optional] [readonly] + +## Methods + +### NewStatusResponse + +`func NewStatusResponse() *StatusResponse` + +NewStatusResponse instantiates a new StatusResponse 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 + +### NewStatusResponseWithDefaults + +`func NewStatusResponseWithDefaults() *StatusResponse` + +NewStatusResponseWithDefaults instantiates a new StatusResponse 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 + +### GetId + +`func (o *StatusResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *StatusResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *StatusResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *StatusResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *StatusResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *StatusResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *StatusResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *StatusResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *StatusResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *StatusResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *StatusResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *StatusResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetElapsedMillis + +`func (o *StatusResponse) GetElapsedMillis() int32` + +GetElapsedMillis returns the ElapsedMillis field if non-nil, zero value otherwise. + +### GetElapsedMillisOk + +`func (o *StatusResponse) GetElapsedMillisOk() (*int32, bool)` + +GetElapsedMillisOk returns a tuple with the ElapsedMillis field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElapsedMillis + +`func (o *StatusResponse) SetElapsedMillis(v int32)` + +SetElapsedMillis sets ElapsedMillis field to given value. + +### HasElapsedMillis + +`func (o *StatusResponse) HasElapsedMillis() bool` + +HasElapsedMillis returns a boolean if a field has been set. + +### GetDetails + +`func (o *StatusResponse) GetDetails() map[string]interface{}` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *StatusResponse) GetDetailsOk() (*map[string]interface{}, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *StatusResponse) SetDetails(v map[string]interface{})` + +SetDetails sets Details field to given value. + +### HasDetails + +`func (o *StatusResponse) HasDetails() bool` + +HasDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SubSearchAggregationSpecification.md b/docs/tools/sdk/go/Reference/V2024/Models/SubSearchAggregationSpecification.md new file mode 100644 index 000000000..957fec3f5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SubSearchAggregationSpecification.md @@ -0,0 +1,168 @@ +--- +id: v2024-sub-search-aggregation-specification +title: SubSearchAggregationSpecification +pagination_label: SubSearchAggregationSpecification +sidebar_label: SubSearchAggregationSpecification +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubSearchAggregationSpecification', 'V2024SubSearchAggregationSpecification'] +slug: /tools/sdk/go/v2024/models/sub-search-aggregation-specification +tags: ['SDK', 'Software Development Kit', 'SubSearchAggregationSpecification', 'V2024SubSearchAggregationSpecification'] +--- + +# SubSearchAggregationSpecification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional] +**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional] +**Filter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional] +**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional] +**SubAggregation** | Pointer to [**Aggregations**](aggregations) | | [optional] + +## Methods + +### NewSubSearchAggregationSpecification + +`func NewSubSearchAggregationSpecification() *SubSearchAggregationSpecification` + +NewSubSearchAggregationSpecification instantiates a new SubSearchAggregationSpecification 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 + +### NewSubSearchAggregationSpecificationWithDefaults + +`func NewSubSearchAggregationSpecificationWithDefaults() *SubSearchAggregationSpecification` + +NewSubSearchAggregationSpecificationWithDefaults instantiates a new SubSearchAggregationSpecification 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 + +### GetNested + +`func (o *SubSearchAggregationSpecification) GetNested() NestedAggregation` + +GetNested returns the Nested field if non-nil, zero value otherwise. + +### GetNestedOk + +`func (o *SubSearchAggregationSpecification) GetNestedOk() (*NestedAggregation, bool)` + +GetNestedOk returns a tuple with the Nested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNested + +`func (o *SubSearchAggregationSpecification) SetNested(v NestedAggregation)` + +SetNested sets Nested field to given value. + +### HasNested + +`func (o *SubSearchAggregationSpecification) HasNested() bool` + +HasNested returns a boolean if a field has been set. + +### GetMetric + +`func (o *SubSearchAggregationSpecification) GetMetric() MetricAggregation` + +GetMetric returns the Metric field if non-nil, zero value otherwise. + +### GetMetricOk + +`func (o *SubSearchAggregationSpecification) GetMetricOk() (*MetricAggregation, bool)` + +GetMetricOk returns a tuple with the Metric field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetric + +`func (o *SubSearchAggregationSpecification) SetMetric(v MetricAggregation)` + +SetMetric sets Metric field to given value. + +### HasMetric + +`func (o *SubSearchAggregationSpecification) HasMetric() bool` + +HasMetric returns a boolean if a field has been set. + +### GetFilter + +`func (o *SubSearchAggregationSpecification) GetFilter() FilterAggregation` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *SubSearchAggregationSpecification) GetFilterOk() (*FilterAggregation, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *SubSearchAggregationSpecification) SetFilter(v FilterAggregation)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *SubSearchAggregationSpecification) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### GetBucket + +`func (o *SubSearchAggregationSpecification) GetBucket() BucketAggregation` + +GetBucket returns the Bucket field if non-nil, zero value otherwise. + +### GetBucketOk + +`func (o *SubSearchAggregationSpecification) GetBucketOk() (*BucketAggregation, bool)` + +GetBucketOk returns a tuple with the Bucket field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBucket + +`func (o *SubSearchAggregationSpecification) SetBucket(v BucketAggregation)` + +SetBucket sets Bucket field to given value. + +### HasBucket + +`func (o *SubSearchAggregationSpecification) HasBucket() bool` + +HasBucket returns a boolean if a field has been set. + +### GetSubAggregation + +`func (o *SubSearchAggregationSpecification) GetSubAggregation() Aggregations` + +GetSubAggregation returns the SubAggregation field if non-nil, zero value otherwise. + +### GetSubAggregationOk + +`func (o *SubSearchAggregationSpecification) GetSubAggregationOk() (*Aggregations, bool)` + +GetSubAggregationOk returns a tuple with the SubAggregation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubAggregation + +`func (o *SubSearchAggregationSpecification) SetSubAggregation(v Aggregations)` + +SetSubAggregation sets SubAggregation field to given value. + +### HasSubAggregation + +`func (o *SubSearchAggregationSpecification) HasSubAggregation() bool` + +HasSubAggregation returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Subscription.md b/docs/tools/sdk/go/Reference/V2024/Models/Subscription.md new file mode 100644 index 000000000..06f9b18ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Subscription.md @@ -0,0 +1,294 @@ +--- +id: v2024-subscription +title: Subscription +pagination_label: Subscription +sidebar_label: Subscription +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Subscription', 'V2024Subscription'] +slug: /tools/sdk/go/v2024/models/subscription +tags: ['SDK', 'Software Development Kit', 'Subscription', 'V2024Subscription'] +--- + +# Subscription + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Subscription ID. | +**Name** | **string** | Subscription name. | +**Description** | Pointer to **string** | Subscription description. | [optional] +**TriggerId** | **string** | ID of trigger subscribed to. | +**TriggerName** | **string** | Trigger name of trigger subscribed to. | +**Type** | [**SubscriptionType**](subscription-type) | | +**ResponseDeadline** | Pointer to **string** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] +**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] +**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] +**Enabled** | **bool** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [default to true] +**Filter** | Pointer to **string** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] + +## Methods + +### NewSubscription + +`func NewSubscription(id string, name string, triggerId string, triggerName string, type_ SubscriptionType, enabled bool, ) *Subscription` + +NewSubscription instantiates a new Subscription 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 + +### NewSubscriptionWithDefaults + +`func NewSubscriptionWithDefaults() *Subscription` + +NewSubscriptionWithDefaults instantiates a new Subscription 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 + +### GetId + +`func (o *Subscription) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Subscription) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Subscription) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *Subscription) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Subscription) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Subscription) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Subscription) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Subscription) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Subscription) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Subscription) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetTriggerId + +`func (o *Subscription) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *Subscription) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *Subscription) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + + +### GetTriggerName + +`func (o *Subscription) GetTriggerName() string` + +GetTriggerName returns the TriggerName field if non-nil, zero value otherwise. + +### GetTriggerNameOk + +`func (o *Subscription) GetTriggerNameOk() (*string, bool)` + +GetTriggerNameOk returns a tuple with the TriggerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerName + +`func (o *Subscription) SetTriggerName(v string)` + +SetTriggerName sets TriggerName field to given value. + + +### GetType + +`func (o *Subscription) GetType() SubscriptionType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Subscription) GetTypeOk() (*SubscriptionType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Subscription) SetType(v SubscriptionType)` + +SetType sets Type field to given value. + + +### GetResponseDeadline + +`func (o *Subscription) GetResponseDeadline() string` + +GetResponseDeadline returns the ResponseDeadline field if non-nil, zero value otherwise. + +### GetResponseDeadlineOk + +`func (o *Subscription) GetResponseDeadlineOk() (*string, bool)` + +GetResponseDeadlineOk returns a tuple with the ResponseDeadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseDeadline + +`func (o *Subscription) SetResponseDeadline(v string)` + +SetResponseDeadline sets ResponseDeadline field to given value. + +### HasResponseDeadline + +`func (o *Subscription) HasResponseDeadline() bool` + +HasResponseDeadline returns a boolean if a field has been set. + +### GetHttpConfig + +`func (o *Subscription) GetHttpConfig() HttpConfig` + +GetHttpConfig returns the HttpConfig field if non-nil, zero value otherwise. + +### GetHttpConfigOk + +`func (o *Subscription) GetHttpConfigOk() (*HttpConfig, bool)` + +GetHttpConfigOk returns a tuple with the HttpConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHttpConfig + +`func (o *Subscription) SetHttpConfig(v HttpConfig)` + +SetHttpConfig sets HttpConfig field to given value. + +### HasHttpConfig + +`func (o *Subscription) HasHttpConfig() bool` + +HasHttpConfig returns a boolean if a field has been set. + +### GetEventBridgeConfig + +`func (o *Subscription) GetEventBridgeConfig() EventBridgeConfig` + +GetEventBridgeConfig returns the EventBridgeConfig field if non-nil, zero value otherwise. + +### GetEventBridgeConfigOk + +`func (o *Subscription) GetEventBridgeConfigOk() (*EventBridgeConfig, bool)` + +GetEventBridgeConfigOk returns a tuple with the EventBridgeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventBridgeConfig + +`func (o *Subscription) SetEventBridgeConfig(v EventBridgeConfig)` + +SetEventBridgeConfig sets EventBridgeConfig field to given value. + +### HasEventBridgeConfig + +`func (o *Subscription) HasEventBridgeConfig() bool` + +HasEventBridgeConfig returns a boolean if a field has been set. + +### GetEnabled + +`func (o *Subscription) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *Subscription) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *Subscription) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetFilter + +`func (o *Subscription) GetFilter() string` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *Subscription) GetFilterOk() (*string, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *Subscription) SetFilter(v string)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *Subscription) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionPatchRequestInner.md b/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionPatchRequestInner.md new file mode 100644 index 000000000..b4111286e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionPatchRequestInner.md @@ -0,0 +1,106 @@ +--- +id: v2024-subscription-patch-request-inner +title: SubscriptionPatchRequestInner +pagination_label: SubscriptionPatchRequestInner +sidebar_label: SubscriptionPatchRequestInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionPatchRequestInner', 'V2024SubscriptionPatchRequestInner'] +slug: /tools/sdk/go/v2024/models/subscription-patch-request-inner +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInner', 'V2024SubscriptionPatchRequestInner'] +--- + +# SubscriptionPatchRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **string** | The operation to be performed | +**Path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | +**Value** | Pointer to [**SubscriptionPatchRequestInnerValue**](subscription-patch-request-inner-value) | | [optional] + +## Methods + +### NewSubscriptionPatchRequestInner + +`func NewSubscriptionPatchRequestInner(op string, path string, ) *SubscriptionPatchRequestInner` + +NewSubscriptionPatchRequestInner instantiates a new SubscriptionPatchRequestInner 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 + +### NewSubscriptionPatchRequestInnerWithDefaults + +`func NewSubscriptionPatchRequestInnerWithDefaults() *SubscriptionPatchRequestInner` + +NewSubscriptionPatchRequestInnerWithDefaults instantiates a new SubscriptionPatchRequestInner 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 + +### GetOp + +`func (o *SubscriptionPatchRequestInner) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *SubscriptionPatchRequestInner) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *SubscriptionPatchRequestInner) SetOp(v string)` + +SetOp sets Op field to given value. + + +### GetPath + +`func (o *SubscriptionPatchRequestInner) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *SubscriptionPatchRequestInner) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *SubscriptionPatchRequestInner) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetValue + +`func (o *SubscriptionPatchRequestInner) GetValue() SubscriptionPatchRequestInnerValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SubscriptionPatchRequestInner) GetValueOk() (*SubscriptionPatchRequestInnerValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SubscriptionPatchRequestInner) SetValue(v SubscriptionPatchRequestInnerValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SubscriptionPatchRequestInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionPatchRequestInnerValue.md b/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionPatchRequestInnerValue.md new file mode 100644 index 000000000..681e3a4cc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionPatchRequestInnerValue.md @@ -0,0 +1,38 @@ +--- +id: v2024-subscription-patch-request-inner-value +title: SubscriptionPatchRequestInnerValue +pagination_label: SubscriptionPatchRequestInnerValue +sidebar_label: SubscriptionPatchRequestInnerValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionPatchRequestInnerValue', 'V2024SubscriptionPatchRequestInnerValue'] +slug: /tools/sdk/go/v2024/models/subscription-patch-request-inner-value +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInnerValue', 'V2024SubscriptionPatchRequestInnerValue'] +--- + +# SubscriptionPatchRequestInnerValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewSubscriptionPatchRequestInnerValue + +`func NewSubscriptionPatchRequestInnerValue() *SubscriptionPatchRequestInnerValue` + +NewSubscriptionPatchRequestInnerValue instantiates a new SubscriptionPatchRequestInnerValue 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 + +### NewSubscriptionPatchRequestInnerValueWithDefaults + +`func NewSubscriptionPatchRequestInnerValueWithDefaults() *SubscriptionPatchRequestInnerValue` + +NewSubscriptionPatchRequestInnerValueWithDefaults instantiates a new SubscriptionPatchRequestInnerValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md b/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md new file mode 100644 index 000000000..3d415047b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md @@ -0,0 +1,38 @@ +--- +id: v2024-subscription-patch-request-inner-value-any-of-inner +title: SubscriptionPatchRequestInnerValueAnyOfInner +pagination_label: SubscriptionPatchRequestInnerValueAnyOfInner +sidebar_label: SubscriptionPatchRequestInnerValueAnyOfInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionPatchRequestInnerValueAnyOfInner', 'V2024SubscriptionPatchRequestInnerValueAnyOfInner'] +slug: /tools/sdk/go/v2024/models/subscription-patch-request-inner-value-any-of-inner +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInnerValueAnyOfInner', 'V2024SubscriptionPatchRequestInnerValueAnyOfInner'] +--- + +# SubscriptionPatchRequestInnerValueAnyOfInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewSubscriptionPatchRequestInnerValueAnyOfInner + +`func NewSubscriptionPatchRequestInnerValueAnyOfInner() *SubscriptionPatchRequestInnerValueAnyOfInner` + +NewSubscriptionPatchRequestInnerValueAnyOfInner instantiates a new SubscriptionPatchRequestInnerValueAnyOfInner 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 + +### NewSubscriptionPatchRequestInnerValueAnyOfInnerWithDefaults + +`func NewSubscriptionPatchRequestInnerValueAnyOfInnerWithDefaults() *SubscriptionPatchRequestInnerValueAnyOfInner` + +NewSubscriptionPatchRequestInnerValueAnyOfInnerWithDefaults instantiates a new SubscriptionPatchRequestInnerValueAnyOfInner 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 + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionPostRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionPostRequest.md new file mode 100644 index 000000000..abba9bc2a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionPostRequest.md @@ -0,0 +1,257 @@ +--- +id: v2024-subscription-post-request +title: SubscriptionPostRequest +pagination_label: SubscriptionPostRequest +sidebar_label: SubscriptionPostRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionPostRequest', 'V2024SubscriptionPostRequest'] +slug: /tools/sdk/go/v2024/models/subscription-post-request +tags: ['SDK', 'Software Development Kit', 'SubscriptionPostRequest', 'V2024SubscriptionPostRequest'] +--- + +# SubscriptionPostRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Subscription name. | +**Description** | Pointer to **string** | Subscription description. | [optional] +**TriggerId** | **string** | ID of trigger subscribed to. | +**Type** | [**SubscriptionType**](subscription-type) | | +**ResponseDeadline** | Pointer to **string** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] +**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] +**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] +**Enabled** | Pointer to **bool** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [optional] [default to true] +**Filter** | Pointer to **string** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] + +## Methods + +### NewSubscriptionPostRequest + +`func NewSubscriptionPostRequest(name string, triggerId string, type_ SubscriptionType, ) *SubscriptionPostRequest` + +NewSubscriptionPostRequest instantiates a new SubscriptionPostRequest 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 + +### NewSubscriptionPostRequestWithDefaults + +`func NewSubscriptionPostRequestWithDefaults() *SubscriptionPostRequest` + +NewSubscriptionPostRequestWithDefaults instantiates a new SubscriptionPostRequest 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 + +### GetName + +`func (o *SubscriptionPostRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SubscriptionPostRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SubscriptionPostRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *SubscriptionPostRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SubscriptionPostRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SubscriptionPostRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SubscriptionPostRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetTriggerId + +`func (o *SubscriptionPostRequest) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *SubscriptionPostRequest) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *SubscriptionPostRequest) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + + +### GetType + +`func (o *SubscriptionPostRequest) GetType() SubscriptionType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SubscriptionPostRequest) GetTypeOk() (*SubscriptionType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SubscriptionPostRequest) SetType(v SubscriptionType)` + +SetType sets Type field to given value. + + +### GetResponseDeadline + +`func (o *SubscriptionPostRequest) GetResponseDeadline() string` + +GetResponseDeadline returns the ResponseDeadline field if non-nil, zero value otherwise. + +### GetResponseDeadlineOk + +`func (o *SubscriptionPostRequest) GetResponseDeadlineOk() (*string, bool)` + +GetResponseDeadlineOk returns a tuple with the ResponseDeadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseDeadline + +`func (o *SubscriptionPostRequest) SetResponseDeadline(v string)` + +SetResponseDeadline sets ResponseDeadline field to given value. + +### HasResponseDeadline + +`func (o *SubscriptionPostRequest) HasResponseDeadline() bool` + +HasResponseDeadline returns a boolean if a field has been set. + +### GetHttpConfig + +`func (o *SubscriptionPostRequest) GetHttpConfig() HttpConfig` + +GetHttpConfig returns the HttpConfig field if non-nil, zero value otherwise. + +### GetHttpConfigOk + +`func (o *SubscriptionPostRequest) GetHttpConfigOk() (*HttpConfig, bool)` + +GetHttpConfigOk returns a tuple with the HttpConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHttpConfig + +`func (o *SubscriptionPostRequest) SetHttpConfig(v HttpConfig)` + +SetHttpConfig sets HttpConfig field to given value. + +### HasHttpConfig + +`func (o *SubscriptionPostRequest) HasHttpConfig() bool` + +HasHttpConfig returns a boolean if a field has been set. + +### GetEventBridgeConfig + +`func (o *SubscriptionPostRequest) GetEventBridgeConfig() EventBridgeConfig` + +GetEventBridgeConfig returns the EventBridgeConfig field if non-nil, zero value otherwise. + +### GetEventBridgeConfigOk + +`func (o *SubscriptionPostRequest) GetEventBridgeConfigOk() (*EventBridgeConfig, bool)` + +GetEventBridgeConfigOk returns a tuple with the EventBridgeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventBridgeConfig + +`func (o *SubscriptionPostRequest) SetEventBridgeConfig(v EventBridgeConfig)` + +SetEventBridgeConfig sets EventBridgeConfig field to given value. + +### HasEventBridgeConfig + +`func (o *SubscriptionPostRequest) HasEventBridgeConfig() bool` + +HasEventBridgeConfig returns a boolean if a field has been set. + +### GetEnabled + +`func (o *SubscriptionPostRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *SubscriptionPostRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *SubscriptionPostRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *SubscriptionPostRequest) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetFilter + +`func (o *SubscriptionPostRequest) GetFilter() string` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *SubscriptionPostRequest) GetFilterOk() (*string, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *SubscriptionPostRequest) SetFilter(v string)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *SubscriptionPostRequest) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionPutRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionPutRequest.md new file mode 100644 index 000000000..8b53de5fa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionPutRequest.md @@ -0,0 +1,246 @@ +--- +id: v2024-subscription-put-request +title: SubscriptionPutRequest +pagination_label: SubscriptionPutRequest +sidebar_label: SubscriptionPutRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionPutRequest', 'V2024SubscriptionPutRequest'] +slug: /tools/sdk/go/v2024/models/subscription-put-request +tags: ['SDK', 'Software Development Kit', 'SubscriptionPutRequest', 'V2024SubscriptionPutRequest'] +--- + +# SubscriptionPutRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Subscription name. | [optional] +**Description** | Pointer to **string** | Subscription description. | [optional] +**Type** | Pointer to [**SubscriptionType**](subscription-type) | | [optional] +**ResponseDeadline** | Pointer to **string** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] +**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] +**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] +**Enabled** | Pointer to **bool** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [optional] [default to true] +**Filter** | Pointer to **string** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] + +## Methods + +### NewSubscriptionPutRequest + +`func NewSubscriptionPutRequest() *SubscriptionPutRequest` + +NewSubscriptionPutRequest instantiates a new SubscriptionPutRequest 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 + +### NewSubscriptionPutRequestWithDefaults + +`func NewSubscriptionPutRequestWithDefaults() *SubscriptionPutRequest` + +NewSubscriptionPutRequestWithDefaults instantiates a new SubscriptionPutRequest 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 + +### GetName + +`func (o *SubscriptionPutRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SubscriptionPutRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SubscriptionPutRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SubscriptionPutRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *SubscriptionPutRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SubscriptionPutRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SubscriptionPutRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SubscriptionPutRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetType + +`func (o *SubscriptionPutRequest) GetType() SubscriptionType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SubscriptionPutRequest) GetTypeOk() (*SubscriptionType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SubscriptionPutRequest) SetType(v SubscriptionType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SubscriptionPutRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetResponseDeadline + +`func (o *SubscriptionPutRequest) GetResponseDeadline() string` + +GetResponseDeadline returns the ResponseDeadline field if non-nil, zero value otherwise. + +### GetResponseDeadlineOk + +`func (o *SubscriptionPutRequest) GetResponseDeadlineOk() (*string, bool)` + +GetResponseDeadlineOk returns a tuple with the ResponseDeadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseDeadline + +`func (o *SubscriptionPutRequest) SetResponseDeadline(v string)` + +SetResponseDeadline sets ResponseDeadline field to given value. + +### HasResponseDeadline + +`func (o *SubscriptionPutRequest) HasResponseDeadline() bool` + +HasResponseDeadline returns a boolean if a field has been set. + +### GetHttpConfig + +`func (o *SubscriptionPutRequest) GetHttpConfig() HttpConfig` + +GetHttpConfig returns the HttpConfig field if non-nil, zero value otherwise. + +### GetHttpConfigOk + +`func (o *SubscriptionPutRequest) GetHttpConfigOk() (*HttpConfig, bool)` + +GetHttpConfigOk returns a tuple with the HttpConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHttpConfig + +`func (o *SubscriptionPutRequest) SetHttpConfig(v HttpConfig)` + +SetHttpConfig sets HttpConfig field to given value. + +### HasHttpConfig + +`func (o *SubscriptionPutRequest) HasHttpConfig() bool` + +HasHttpConfig returns a boolean if a field has been set. + +### GetEventBridgeConfig + +`func (o *SubscriptionPutRequest) GetEventBridgeConfig() EventBridgeConfig` + +GetEventBridgeConfig returns the EventBridgeConfig field if non-nil, zero value otherwise. + +### GetEventBridgeConfigOk + +`func (o *SubscriptionPutRequest) GetEventBridgeConfigOk() (*EventBridgeConfig, bool)` + +GetEventBridgeConfigOk returns a tuple with the EventBridgeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventBridgeConfig + +`func (o *SubscriptionPutRequest) SetEventBridgeConfig(v EventBridgeConfig)` + +SetEventBridgeConfig sets EventBridgeConfig field to given value. + +### HasEventBridgeConfig + +`func (o *SubscriptionPutRequest) HasEventBridgeConfig() bool` + +HasEventBridgeConfig returns a boolean if a field has been set. + +### GetEnabled + +`func (o *SubscriptionPutRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *SubscriptionPutRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *SubscriptionPutRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *SubscriptionPutRequest) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetFilter + +`func (o *SubscriptionPutRequest) GetFilter() string` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *SubscriptionPutRequest) GetFilterOk() (*string, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *SubscriptionPutRequest) SetFilter(v string)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *SubscriptionPutRequest) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionType.md b/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionType.md new file mode 100644 index 000000000..856201cc5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SubscriptionType.md @@ -0,0 +1,27 @@ +--- +id: v2024-subscription-type +title: SubscriptionType +pagination_label: SubscriptionType +sidebar_label: SubscriptionType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionType', 'V2024SubscriptionType'] +slug: /tools/sdk/go/v2024/models/subscription-type +tags: ['SDK', 'Software Development Kit', 'SubscriptionType', 'V2024SubscriptionType'] +--- + +# SubscriptionType + +## Enum + + +* `HTTP` (value: `"HTTP"`) + +* `EVENTBRIDGE` (value: `"EVENTBRIDGE"`) + +* `INLINE` (value: `"INLINE"`) + +* `SCRIPT` (value: `"SCRIPT"`) + +* `WORKFLOW` (value: `"WORKFLOW"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TaggedObject.md b/docs/tools/sdk/go/Reference/V2024/Models/TaggedObject.md new file mode 100644 index 000000000..790221125 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TaggedObject.md @@ -0,0 +1,90 @@ +--- +id: v2024-tagged-object +title: TaggedObject +pagination_label: TaggedObject +sidebar_label: TaggedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaggedObject', 'V2024TaggedObject'] +slug: /tools/sdk/go/v2024/models/tagged-object +tags: ['SDK', 'Software Development Kit', 'TaggedObject', 'V2024TaggedObject'] +--- + +# TaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRef** | Pointer to [**TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]string** | Labels to be applied to an Object | [optional] + +## Methods + +### NewTaggedObject + +`func NewTaggedObject() *TaggedObject` + +NewTaggedObject instantiates a new TaggedObject 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 + +### NewTaggedObjectWithDefaults + +`func NewTaggedObjectWithDefaults() *TaggedObject` + +NewTaggedObjectWithDefaults instantiates a new TaggedObject 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 + +### GetObjectRef + +`func (o *TaggedObject) GetObjectRef() TaggedObjectDto` + +GetObjectRef returns the ObjectRef field if non-nil, zero value otherwise. + +### GetObjectRefOk + +`func (o *TaggedObject) GetObjectRefOk() (*TaggedObjectDto, bool)` + +GetObjectRefOk returns a tuple with the ObjectRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectRef + +`func (o *TaggedObject) SetObjectRef(v TaggedObjectDto)` + +SetObjectRef sets ObjectRef field to given value. + +### HasObjectRef + +`func (o *TaggedObject) HasObjectRef() bool` + +HasObjectRef returns a boolean if a field has been set. + +### GetTags + +`func (o *TaggedObject) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *TaggedObject) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *TaggedObject) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *TaggedObject) HasTags() bool` + +HasTags returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TaggedObjectDto.md b/docs/tools/sdk/go/Reference/V2024/Models/TaggedObjectDto.md new file mode 100644 index 000000000..8285d9240 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TaggedObjectDto.md @@ -0,0 +1,126 @@ +--- +id: v2024-tagged-object-dto +title: TaggedObjectDto +pagination_label: TaggedObjectDto +sidebar_label: TaggedObjectDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaggedObjectDto', 'V2024TaggedObjectDto'] +slug: /tools/sdk/go/v2024/models/tagged-object-dto +tags: ['SDK', 'Software Development Kit', 'TaggedObjectDto', 'V2024TaggedObjectDto'] +--- + +# TaggedObjectDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type | [optional] +**Id** | Pointer to **string** | ID of the object this reference applies to | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the object this reference applies to | [optional] + +## Methods + +### NewTaggedObjectDto + +`func NewTaggedObjectDto() *TaggedObjectDto` + +NewTaggedObjectDto instantiates a new TaggedObjectDto 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 + +### NewTaggedObjectDtoWithDefaults + +`func NewTaggedObjectDtoWithDefaults() *TaggedObjectDto` + +NewTaggedObjectDtoWithDefaults instantiates a new TaggedObjectDto 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 + +### GetType + +`func (o *TaggedObjectDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaggedObjectDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaggedObjectDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaggedObjectDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *TaggedObjectDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaggedObjectDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaggedObjectDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaggedObjectDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TaggedObjectDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaggedObjectDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaggedObjectDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TaggedObjectDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *TaggedObjectDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *TaggedObjectDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Target.md b/docs/tools/sdk/go/Reference/V2024/Models/Target.md new file mode 100644 index 000000000..9078001e4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Target.md @@ -0,0 +1,126 @@ +--- +id: v2024-target +title: Target +pagination_label: Target +sidebar_label: Target +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Target', 'V2024Target'] +slug: /tools/sdk/go/v2024/models/target +tags: ['SDK', 'Software Development Kit', 'Target', 'V2024Target'] +--- + +# Target + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Target ID | [optional] +**Type** | Pointer to **NullableString** | Target type | [optional] +**Name** | Pointer to **string** | Target name | [optional] + +## Methods + +### NewTarget + +`func NewTarget() *Target` + +NewTarget instantiates a new Target 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 + +### NewTargetWithDefaults + +`func NewTargetWithDefaults() *Target` + +NewTargetWithDefaults instantiates a new Target 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 + +### GetId + +`func (o *Target) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Target) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Target) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Target) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *Target) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Target) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Target) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Target) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *Target) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *Target) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetName + +`func (o *Target) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Target) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Target) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Target) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TaskDefinitionSummary.md b/docs/tools/sdk/go/Reference/V2024/Models/TaskDefinitionSummary.md new file mode 100644 index 000000000..d4e1c7744 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TaskDefinitionSummary.md @@ -0,0 +1,184 @@ +--- +id: v2024-task-definition-summary +title: TaskDefinitionSummary +pagination_label: TaskDefinitionSummary +sidebar_label: TaskDefinitionSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskDefinitionSummary', 'V2024TaskDefinitionSummary'] +slug: /tools/sdk/go/v2024/models/task-definition-summary +tags: ['SDK', 'Software Development Kit', 'TaskDefinitionSummary', 'V2024TaskDefinitionSummary'] +--- + +# TaskDefinitionSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | System-generated unique ID of the TaskDefinition | +**UniqueName** | **string** | Name of the TaskDefinition | +**Description** | **NullableString** | Description of the TaskDefinition | +**ParentName** | **string** | Name of the parent of the TaskDefinition | +**Executor** | **NullableString** | Executor of the TaskDefinition | +**Arguments** | **map[string]interface{}** | Formal parameters of the TaskDefinition, without values | + +## Methods + +### NewTaskDefinitionSummary + +`func NewTaskDefinitionSummary(id string, uniqueName string, description NullableString, parentName string, executor NullableString, arguments map[string]interface{}, ) *TaskDefinitionSummary` + +NewTaskDefinitionSummary instantiates a new TaskDefinitionSummary 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 + +### NewTaskDefinitionSummaryWithDefaults + +`func NewTaskDefinitionSummaryWithDefaults() *TaskDefinitionSummary` + +NewTaskDefinitionSummaryWithDefaults instantiates a new TaskDefinitionSummary 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 + +### GetId + +`func (o *TaskDefinitionSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskDefinitionSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskDefinitionSummary) SetId(v string)` + +SetId sets Id field to given value. + + +### GetUniqueName + +`func (o *TaskDefinitionSummary) GetUniqueName() string` + +GetUniqueName returns the UniqueName field if non-nil, zero value otherwise. + +### GetUniqueNameOk + +`func (o *TaskDefinitionSummary) GetUniqueNameOk() (*string, bool)` + +GetUniqueNameOk returns a tuple with the UniqueName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUniqueName + +`func (o *TaskDefinitionSummary) SetUniqueName(v string)` + +SetUniqueName sets UniqueName field to given value. + + +### GetDescription + +`func (o *TaskDefinitionSummary) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TaskDefinitionSummary) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TaskDefinitionSummary) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *TaskDefinitionSummary) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *TaskDefinitionSummary) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetParentName + +`func (o *TaskDefinitionSummary) GetParentName() string` + +GetParentName returns the ParentName field if non-nil, zero value otherwise. + +### GetParentNameOk + +`func (o *TaskDefinitionSummary) GetParentNameOk() (*string, bool)` + +GetParentNameOk returns a tuple with the ParentName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentName + +`func (o *TaskDefinitionSummary) SetParentName(v string)` + +SetParentName sets ParentName field to given value. + + +### GetExecutor + +`func (o *TaskDefinitionSummary) GetExecutor() string` + +GetExecutor returns the Executor field if non-nil, zero value otherwise. + +### GetExecutorOk + +`func (o *TaskDefinitionSummary) GetExecutorOk() (*string, bool)` + +GetExecutorOk returns a tuple with the Executor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExecutor + +`func (o *TaskDefinitionSummary) SetExecutor(v string)` + +SetExecutor sets Executor field to given value. + + +### SetExecutorNil + +`func (o *TaskDefinitionSummary) SetExecutorNil(b bool)` + + SetExecutorNil sets the value for Executor to be an explicit nil + +### UnsetExecutor +`func (o *TaskDefinitionSummary) UnsetExecutor()` + +UnsetExecutor ensures that no value is present for Executor, not even an explicit nil +### GetArguments + +`func (o *TaskDefinitionSummary) GetArguments() map[string]interface{}` + +GetArguments returns the Arguments field if non-nil, zero value otherwise. + +### GetArgumentsOk + +`func (o *TaskDefinitionSummary) GetArgumentsOk() (*map[string]interface{}, bool)` + +GetArgumentsOk returns a tuple with the Arguments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArguments + +`func (o *TaskDefinitionSummary) SetArguments(v map[string]interface{})` + +SetArguments sets Arguments field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TaskResultDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/TaskResultDetails.md new file mode 100644 index 000000000..2f2ba5039 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TaskResultDetails.md @@ -0,0 +1,452 @@ +--- +id: v2024-task-result-details +title: TaskResultDetails +pagination_label: TaskResultDetails +sidebar_label: TaskResultDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultDetails', 'V2024TaskResultDetails'] +slug: /tools/sdk/go/v2024/models/task-result-details +tags: ['SDK', 'Software Development Kit', 'TaskResultDetails', 'V2024TaskResultDetails'] +--- + +# TaskResultDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task. | [optional] +**Id** | Pointer to **string** | Unique task definition identifier. | [optional] +**ReportType** | Pointer to **string** | Use this property to define what report should be processed in the RDE service. | [optional] +**Description** | Pointer to **string** | Description of the report purpose and/or contents. | [optional] +**ParentName** | Pointer to **NullableString** | Name of the parent task/report if exists. | [optional] +**Launcher** | Pointer to **string** | Name of the report processing initiator. | [optional] +**Created** | Pointer to **SailPointTime** | Report creation date | [optional] +**Launched** | Pointer to **NullableTime** | Report start date | [optional] +**Completed** | Pointer to **NullableTime** | Report completion date | [optional] +**CompletionStatus** | Pointer to **NullableString** | Report completion status. | [optional] +**Messages** | Pointer to [**[]TaskResultDetailsMessagesInner**](task-result-details-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**Returns** | Pointer to [**[]TaskResultDetailsReturnsInner**](task-result-details-returns-inner) | Task definition results, if necessary. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Extra attributes map(dictionary) needed for the report. | [optional] +**Progress** | Pointer to **NullableString** | Current report state. | [optional] + +## Methods + +### NewTaskResultDetails + +`func NewTaskResultDetails() *TaskResultDetails` + +NewTaskResultDetails instantiates a new TaskResultDetails 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 + +### NewTaskResultDetailsWithDefaults + +`func NewTaskResultDetailsWithDefaults() *TaskResultDetails` + +NewTaskResultDetailsWithDefaults instantiates a new TaskResultDetails 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 + +### GetType + +`func (o *TaskResultDetails) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskResultDetails) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskResultDetails) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaskResultDetails) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *TaskResultDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskResultDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskResultDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaskResultDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetReportType + +`func (o *TaskResultDetails) GetReportType() string` + +GetReportType returns the ReportType field if non-nil, zero value otherwise. + +### GetReportTypeOk + +`func (o *TaskResultDetails) GetReportTypeOk() (*string, bool)` + +GetReportTypeOk returns a tuple with the ReportType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportType + +`func (o *TaskResultDetails) SetReportType(v string)` + +SetReportType sets ReportType field to given value. + +### HasReportType + +`func (o *TaskResultDetails) HasReportType() bool` + +HasReportType returns a boolean if a field has been set. + +### GetDescription + +`func (o *TaskResultDetails) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TaskResultDetails) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TaskResultDetails) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *TaskResultDetails) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetParentName + +`func (o *TaskResultDetails) GetParentName() string` + +GetParentName returns the ParentName field if non-nil, zero value otherwise. + +### GetParentNameOk + +`func (o *TaskResultDetails) GetParentNameOk() (*string, bool)` + +GetParentNameOk returns a tuple with the ParentName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentName + +`func (o *TaskResultDetails) SetParentName(v string)` + +SetParentName sets ParentName field to given value. + +### HasParentName + +`func (o *TaskResultDetails) HasParentName() bool` + +HasParentName returns a boolean if a field has been set. + +### SetParentNameNil + +`func (o *TaskResultDetails) SetParentNameNil(b bool)` + + SetParentNameNil sets the value for ParentName to be an explicit nil + +### UnsetParentName +`func (o *TaskResultDetails) UnsetParentName()` + +UnsetParentName ensures that no value is present for ParentName, not even an explicit nil +### GetLauncher + +`func (o *TaskResultDetails) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *TaskResultDetails) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *TaskResultDetails) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + +### HasLauncher + +`func (o *TaskResultDetails) HasLauncher() bool` + +HasLauncher returns a boolean if a field has been set. + +### GetCreated + +`func (o *TaskResultDetails) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *TaskResultDetails) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *TaskResultDetails) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *TaskResultDetails) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetLaunched + +`func (o *TaskResultDetails) GetLaunched() SailPointTime` + +GetLaunched returns the Launched field if non-nil, zero value otherwise. + +### GetLaunchedOk + +`func (o *TaskResultDetails) GetLaunchedOk() (*SailPointTime, bool)` + +GetLaunchedOk returns a tuple with the Launched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunched + +`func (o *TaskResultDetails) SetLaunched(v SailPointTime)` + +SetLaunched sets Launched field to given value. + +### HasLaunched + +`func (o *TaskResultDetails) HasLaunched() bool` + +HasLaunched returns a boolean if a field has been set. + +### SetLaunchedNil + +`func (o *TaskResultDetails) SetLaunchedNil(b bool)` + + SetLaunchedNil sets the value for Launched to be an explicit nil + +### UnsetLaunched +`func (o *TaskResultDetails) UnsetLaunched()` + +UnsetLaunched ensures that no value is present for Launched, not even an explicit nil +### GetCompleted + +`func (o *TaskResultDetails) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *TaskResultDetails) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *TaskResultDetails) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *TaskResultDetails) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *TaskResultDetails) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *TaskResultDetails) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetCompletionStatus + +`func (o *TaskResultDetails) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *TaskResultDetails) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *TaskResultDetails) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *TaskResultDetails) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + +### SetCompletionStatusNil + +`func (o *TaskResultDetails) SetCompletionStatusNil(b bool)` + + SetCompletionStatusNil sets the value for CompletionStatus to be an explicit nil + +### UnsetCompletionStatus +`func (o *TaskResultDetails) UnsetCompletionStatus()` + +UnsetCompletionStatus ensures that no value is present for CompletionStatus, not even an explicit nil +### GetMessages + +`func (o *TaskResultDetails) GetMessages() []TaskResultDetailsMessagesInner` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *TaskResultDetails) GetMessagesOk() (*[]TaskResultDetailsMessagesInner, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *TaskResultDetails) SetMessages(v []TaskResultDetailsMessagesInner)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *TaskResultDetails) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetReturns + +`func (o *TaskResultDetails) GetReturns() []TaskResultDetailsReturnsInner` + +GetReturns returns the Returns field if non-nil, zero value otherwise. + +### GetReturnsOk + +`func (o *TaskResultDetails) GetReturnsOk() (*[]TaskResultDetailsReturnsInner, bool)` + +GetReturnsOk returns a tuple with the Returns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReturns + +`func (o *TaskResultDetails) SetReturns(v []TaskResultDetailsReturnsInner)` + +SetReturns sets Returns field to given value. + +### HasReturns + +`func (o *TaskResultDetails) HasReturns() bool` + +HasReturns returns a boolean if a field has been set. + +### GetAttributes + +`func (o *TaskResultDetails) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TaskResultDetails) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TaskResultDetails) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *TaskResultDetails) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetProgress + +`func (o *TaskResultDetails) GetProgress() string` + +GetProgress returns the Progress field if non-nil, zero value otherwise. + +### GetProgressOk + +`func (o *TaskResultDetails) GetProgressOk() (*string, bool)` + +GetProgressOk returns a tuple with the Progress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProgress + +`func (o *TaskResultDetails) SetProgress(v string)` + +SetProgress sets Progress field to given value. + +### HasProgress + +`func (o *TaskResultDetails) HasProgress() bool` + +HasProgress returns a boolean if a field has been set. + +### SetProgressNil + +`func (o *TaskResultDetails) SetProgressNil(b bool)` + + SetProgressNil sets the value for Progress to be an explicit nil + +### UnsetProgress +`func (o *TaskResultDetails) UnsetProgress()` + +UnsetProgress ensures that no value is present for Progress, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TaskResultDetailsMessagesInner.md b/docs/tools/sdk/go/Reference/V2024/Models/TaskResultDetailsMessagesInner.md new file mode 100644 index 000000000..1135d2e0d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TaskResultDetailsMessagesInner.md @@ -0,0 +1,168 @@ +--- +id: v2024-task-result-details-messages-inner +title: TaskResultDetailsMessagesInner +pagination_label: TaskResultDetailsMessagesInner +sidebar_label: TaskResultDetailsMessagesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultDetailsMessagesInner', 'V2024TaskResultDetailsMessagesInner'] +slug: /tools/sdk/go/v2024/models/task-result-details-messages-inner +tags: ['SDK', 'Software Development Kit', 'TaskResultDetailsMessagesInner', 'V2024TaskResultDetailsMessagesInner'] +--- + +# TaskResultDetailsMessagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the message. | [optional] +**Error** | Pointer to **bool** | Flag whether message is an error. | [optional] [default to false] +**Warning** | Pointer to **bool** | Flag whether message is a warning. | [optional] [default to false] +**Key** | Pointer to **string** | Message string identifier. | [optional] +**LocalizedText** | Pointer to **string** | Message context with the locale based language. | [optional] + +## Methods + +### NewTaskResultDetailsMessagesInner + +`func NewTaskResultDetailsMessagesInner() *TaskResultDetailsMessagesInner` + +NewTaskResultDetailsMessagesInner instantiates a new TaskResultDetailsMessagesInner 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 + +### NewTaskResultDetailsMessagesInnerWithDefaults + +`func NewTaskResultDetailsMessagesInnerWithDefaults() *TaskResultDetailsMessagesInner` + +NewTaskResultDetailsMessagesInnerWithDefaults instantiates a new TaskResultDetailsMessagesInner 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 + +### GetType + +`func (o *TaskResultDetailsMessagesInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskResultDetailsMessagesInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskResultDetailsMessagesInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaskResultDetailsMessagesInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetError + +`func (o *TaskResultDetailsMessagesInner) GetError() bool` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *TaskResultDetailsMessagesInner) GetErrorOk() (*bool, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *TaskResultDetailsMessagesInner) SetError(v bool)` + +SetError sets Error field to given value. + +### HasError + +`func (o *TaskResultDetailsMessagesInner) HasError() bool` + +HasError returns a boolean if a field has been set. + +### GetWarning + +`func (o *TaskResultDetailsMessagesInner) GetWarning() bool` + +GetWarning returns the Warning field if non-nil, zero value otherwise. + +### GetWarningOk + +`func (o *TaskResultDetailsMessagesInner) GetWarningOk() (*bool, bool)` + +GetWarningOk returns a tuple with the Warning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarning + +`func (o *TaskResultDetailsMessagesInner) SetWarning(v bool)` + +SetWarning sets Warning field to given value. + +### HasWarning + +`func (o *TaskResultDetailsMessagesInner) HasWarning() bool` + +HasWarning returns a boolean if a field has been set. + +### GetKey + +`func (o *TaskResultDetailsMessagesInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TaskResultDetailsMessagesInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TaskResultDetailsMessagesInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *TaskResultDetailsMessagesInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetLocalizedText + +`func (o *TaskResultDetailsMessagesInner) GetLocalizedText() string` + +GetLocalizedText returns the LocalizedText field if non-nil, zero value otherwise. + +### GetLocalizedTextOk + +`func (o *TaskResultDetailsMessagesInner) GetLocalizedTextOk() (*string, bool)` + +GetLocalizedTextOk returns a tuple with the LocalizedText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizedText + +`func (o *TaskResultDetailsMessagesInner) SetLocalizedText(v string)` + +SetLocalizedText sets LocalizedText field to given value. + +### HasLocalizedText + +`func (o *TaskResultDetailsMessagesInner) HasLocalizedText() bool` + +HasLocalizedText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TaskResultDetailsReturnsInner.md b/docs/tools/sdk/go/Reference/V2024/Models/TaskResultDetailsReturnsInner.md new file mode 100644 index 000000000..d39f0199e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TaskResultDetailsReturnsInner.md @@ -0,0 +1,90 @@ +--- +id: v2024-task-result-details-returns-inner +title: TaskResultDetailsReturnsInner +pagination_label: TaskResultDetailsReturnsInner +sidebar_label: TaskResultDetailsReturnsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultDetailsReturnsInner', 'V2024TaskResultDetailsReturnsInner'] +slug: /tools/sdk/go/v2024/models/task-result-details-returns-inner +tags: ['SDK', 'Software Development Kit', 'TaskResultDetailsReturnsInner', 'V2024TaskResultDetailsReturnsInner'] +--- + +# TaskResultDetailsReturnsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayLabel** | Pointer to **string** | Attribute description. | [optional] +**AttributeName** | Pointer to **string** | System or database attribute name. | [optional] + +## Methods + +### NewTaskResultDetailsReturnsInner + +`func NewTaskResultDetailsReturnsInner() *TaskResultDetailsReturnsInner` + +NewTaskResultDetailsReturnsInner instantiates a new TaskResultDetailsReturnsInner 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 + +### NewTaskResultDetailsReturnsInnerWithDefaults + +`func NewTaskResultDetailsReturnsInnerWithDefaults() *TaskResultDetailsReturnsInner` + +NewTaskResultDetailsReturnsInnerWithDefaults instantiates a new TaskResultDetailsReturnsInner 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 + +### GetDisplayLabel + +`func (o *TaskResultDetailsReturnsInner) GetDisplayLabel() string` + +GetDisplayLabel returns the DisplayLabel field if non-nil, zero value otherwise. + +### GetDisplayLabelOk + +`func (o *TaskResultDetailsReturnsInner) GetDisplayLabelOk() (*string, bool)` + +GetDisplayLabelOk returns a tuple with the DisplayLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayLabel + +`func (o *TaskResultDetailsReturnsInner) SetDisplayLabel(v string)` + +SetDisplayLabel sets DisplayLabel field to given value. + +### HasDisplayLabel + +`func (o *TaskResultDetailsReturnsInner) HasDisplayLabel() bool` + +HasDisplayLabel returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *TaskResultDetailsReturnsInner) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *TaskResultDetailsReturnsInner) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *TaskResultDetailsReturnsInner) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *TaskResultDetailsReturnsInner) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TaskResultDto.md b/docs/tools/sdk/go/Reference/V2024/Models/TaskResultDto.md new file mode 100644 index 000000000..3689b176e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TaskResultDto.md @@ -0,0 +1,126 @@ +--- +id: v2024-task-result-dto +title: TaskResultDto +pagination_label: TaskResultDto +sidebar_label: TaskResultDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultDto', 'V2024TaskResultDto'] +slug: /tools/sdk/go/v2024/models/task-result-dto +tags: ['SDK', 'Software Development Kit', 'TaskResultDto', 'V2024TaskResultDto'] +--- + +# TaskResultDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Task result DTO type. | [optional] +**Id** | Pointer to **string** | Task result ID. | [optional] +**Name** | Pointer to **NullableString** | Task result display name. | [optional] + +## Methods + +### NewTaskResultDto + +`func NewTaskResultDto() *TaskResultDto` + +NewTaskResultDto instantiates a new TaskResultDto 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 + +### NewTaskResultDtoWithDefaults + +`func NewTaskResultDtoWithDefaults() *TaskResultDto` + +NewTaskResultDtoWithDefaults instantiates a new TaskResultDto 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 + +### GetType + +`func (o *TaskResultDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskResultDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskResultDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaskResultDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *TaskResultDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskResultDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskResultDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaskResultDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TaskResultDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaskResultDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaskResultDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TaskResultDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *TaskResultDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *TaskResultDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TaskResultResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/TaskResultResponse.md new file mode 100644 index 000000000..0891652dd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TaskResultResponse.md @@ -0,0 +1,116 @@ +--- +id: v2024-task-result-response +title: TaskResultResponse +pagination_label: TaskResultResponse +sidebar_label: TaskResultResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultResponse', 'V2024TaskResultResponse'] +slug: /tools/sdk/go/v2024/models/task-result-response +tags: ['SDK', 'Software Development Kit', 'TaskResultResponse', 'V2024TaskResultResponse'] +--- + +# TaskResultResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | the type of response reference | [optional] +**Id** | Pointer to **string** | the task ID | [optional] +**Name** | Pointer to **string** | the task name (not used in this endpoint, always null) | [optional] + +## Methods + +### NewTaskResultResponse + +`func NewTaskResultResponse() *TaskResultResponse` + +NewTaskResultResponse instantiates a new TaskResultResponse 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 + +### NewTaskResultResponseWithDefaults + +`func NewTaskResultResponseWithDefaults() *TaskResultResponse` + +NewTaskResultResponseWithDefaults instantiates a new TaskResultResponse 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 + +### GetType + +`func (o *TaskResultResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskResultResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskResultResponse) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaskResultResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *TaskResultResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskResultResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskResultResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaskResultResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TaskResultResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaskResultResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaskResultResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TaskResultResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TaskResultSimplified.md b/docs/tools/sdk/go/Reference/V2024/Models/TaskResultSimplified.md new file mode 100644 index 000000000..e44759133 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TaskResultSimplified.md @@ -0,0 +1,220 @@ +--- +id: v2024-task-result-simplified +title: TaskResultSimplified +pagination_label: TaskResultSimplified +sidebar_label: TaskResultSimplified +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultSimplified', 'V2024TaskResultSimplified'] +slug: /tools/sdk/go/v2024/models/task-result-simplified +tags: ['SDK', 'Software Development Kit', 'TaskResultSimplified', 'V2024TaskResultSimplified'] +--- + +# TaskResultSimplified + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Task identifier | [optional] +**Name** | Pointer to **string** | Task name | [optional] +**Description** | Pointer to **string** | Task description | [optional] +**Launcher** | Pointer to **string** | User or process who launched the task | [optional] +**Completed** | Pointer to **SailPointTime** | Date time of completion | [optional] +**Launched** | Pointer to **SailPointTime** | Date time when the task was launched | [optional] +**CompletionStatus** | Pointer to **string** | Task result status | [optional] + +## Methods + +### NewTaskResultSimplified + +`func NewTaskResultSimplified() *TaskResultSimplified` + +NewTaskResultSimplified instantiates a new TaskResultSimplified 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 + +### NewTaskResultSimplifiedWithDefaults + +`func NewTaskResultSimplifiedWithDefaults() *TaskResultSimplified` + +NewTaskResultSimplifiedWithDefaults instantiates a new TaskResultSimplified 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 + +### GetId + +`func (o *TaskResultSimplified) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskResultSimplified) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskResultSimplified) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaskResultSimplified) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TaskResultSimplified) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaskResultSimplified) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaskResultSimplified) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TaskResultSimplified) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *TaskResultSimplified) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TaskResultSimplified) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TaskResultSimplified) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *TaskResultSimplified) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetLauncher + +`func (o *TaskResultSimplified) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *TaskResultSimplified) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *TaskResultSimplified) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + +### HasLauncher + +`func (o *TaskResultSimplified) HasLauncher() bool` + +HasLauncher returns a boolean if a field has been set. + +### GetCompleted + +`func (o *TaskResultSimplified) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *TaskResultSimplified) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *TaskResultSimplified) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *TaskResultSimplified) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetLaunched + +`func (o *TaskResultSimplified) GetLaunched() SailPointTime` + +GetLaunched returns the Launched field if non-nil, zero value otherwise. + +### GetLaunchedOk + +`func (o *TaskResultSimplified) GetLaunchedOk() (*SailPointTime, bool)` + +GetLaunchedOk returns a tuple with the Launched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunched + +`func (o *TaskResultSimplified) SetLaunched(v SailPointTime)` + +SetLaunched sets Launched field to given value. + +### HasLaunched + +`func (o *TaskResultSimplified) HasLaunched() bool` + +HasLaunched returns a boolean if a field has been set. + +### GetCompletionStatus + +`func (o *TaskResultSimplified) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *TaskResultSimplified) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *TaskResultSimplified) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *TaskResultSimplified) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TaskReturnDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/TaskReturnDetails.md new file mode 100644 index 000000000..b9b6cd805 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TaskReturnDetails.md @@ -0,0 +1,80 @@ +--- +id: v2024-task-return-details +title: TaskReturnDetails +pagination_label: TaskReturnDetails +sidebar_label: TaskReturnDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskReturnDetails', 'V2024TaskReturnDetails'] +slug: /tools/sdk/go/v2024/models/task-return-details +tags: ['SDK', 'Software Development Kit', 'TaskReturnDetails', 'V2024TaskReturnDetails'] +--- + +# TaskReturnDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Display name of the TaskReturnDetails | +**AttributeName** | **string** | Attribute the TaskReturnDetails is for | + +## Methods + +### NewTaskReturnDetails + +`func NewTaskReturnDetails(name string, attributeName string, ) *TaskReturnDetails` + +NewTaskReturnDetails instantiates a new TaskReturnDetails 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 + +### NewTaskReturnDetailsWithDefaults + +`func NewTaskReturnDetailsWithDefaults() *TaskReturnDetails` + +NewTaskReturnDetailsWithDefaults instantiates a new TaskReturnDetails 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 + +### GetName + +`func (o *TaskReturnDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaskReturnDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaskReturnDetails) SetName(v string)` + +SetName sets Name field to given value. + + +### GetAttributeName + +`func (o *TaskReturnDetails) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *TaskReturnDetails) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *TaskReturnDetails) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TaskStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/TaskStatus.md new file mode 100644 index 000000000..29033d838 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TaskStatus.md @@ -0,0 +1,486 @@ +--- +id: v2024-task-status +title: TaskStatus +pagination_label: TaskStatus +sidebar_label: TaskStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskStatus', 'V2024TaskStatus'] +slug: /tools/sdk/go/v2024/models/task-status +tags: ['SDK', 'Software Development Kit', 'TaskStatus', 'V2024TaskStatus'] +--- + +# TaskStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | System-generated unique ID of the task this TaskStatus represents | +**Type** | **string** | Type of task this TaskStatus represents | +**UniqueName** | **string** | Name of the task this TaskStatus represents | +**Description** | **string** | Description of the task this TaskStatus represents | +**ParentName** | **NullableString** | Name of the parent of the task this TaskStatus represents | +**Launcher** | **string** | Service to execute the task this TaskStatus represents | +**Target** | Pointer to [**NullableTarget**](target) | | [optional] +**Created** | **SailPointTime** | Creation date of the task this TaskStatus represents | +**Modified** | **SailPointTime** | Last modification date of the task this TaskStatus represents | +**Launched** | **NullableTime** | Launch date of the task this TaskStatus represents | +**Completed** | **NullableTime** | Completion date of the task this TaskStatus represents | +**CompletionStatus** | **NullableString** | Completion status of the task this TaskStatus represents | +**Messages** | [**[]TaskStatusMessage**](task-status-message) | Messages associated with the task this TaskStatus represents | +**Returns** | [**[]TaskReturnDetails**](task-return-details) | Return values from the task this TaskStatus represents | +**Attributes** | **map[string]interface{}** | Attributes of the task this TaskStatus represents | +**Progress** | **NullableString** | Current progress of the task this TaskStatus represents | +**PercentComplete** | **int32** | Current percentage completion of the task this TaskStatus represents | +**TaskDefinitionSummary** | Pointer to [**TaskDefinitionSummary**](task-definition-summary) | | [optional] + +## Methods + +### NewTaskStatus + +`func NewTaskStatus(id string, type_ string, uniqueName string, description string, parentName NullableString, launcher string, created SailPointTime, modified SailPointTime, launched NullableTime, completed NullableTime, completionStatus NullableString, messages []TaskStatusMessage, returns []TaskReturnDetails, attributes map[string]interface{}, progress NullableString, percentComplete int32, ) *TaskStatus` + +NewTaskStatus instantiates a new TaskStatus 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 + +### NewTaskStatusWithDefaults + +`func NewTaskStatusWithDefaults() *TaskStatus` + +NewTaskStatusWithDefaults instantiates a new TaskStatus 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 + +### GetId + +`func (o *TaskStatus) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskStatus) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskStatus) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *TaskStatus) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskStatus) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskStatus) SetType(v string)` + +SetType sets Type field to given value. + + +### GetUniqueName + +`func (o *TaskStatus) GetUniqueName() string` + +GetUniqueName returns the UniqueName field if non-nil, zero value otherwise. + +### GetUniqueNameOk + +`func (o *TaskStatus) GetUniqueNameOk() (*string, bool)` + +GetUniqueNameOk returns a tuple with the UniqueName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUniqueName + +`func (o *TaskStatus) SetUniqueName(v string)` + +SetUniqueName sets UniqueName field to given value. + + +### GetDescription + +`func (o *TaskStatus) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TaskStatus) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TaskStatus) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetParentName + +`func (o *TaskStatus) GetParentName() string` + +GetParentName returns the ParentName field if non-nil, zero value otherwise. + +### GetParentNameOk + +`func (o *TaskStatus) GetParentNameOk() (*string, bool)` + +GetParentNameOk returns a tuple with the ParentName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentName + +`func (o *TaskStatus) SetParentName(v string)` + +SetParentName sets ParentName field to given value. + + +### SetParentNameNil + +`func (o *TaskStatus) SetParentNameNil(b bool)` + + SetParentNameNil sets the value for ParentName to be an explicit nil + +### UnsetParentName +`func (o *TaskStatus) UnsetParentName()` + +UnsetParentName ensures that no value is present for ParentName, not even an explicit nil +### GetLauncher + +`func (o *TaskStatus) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *TaskStatus) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *TaskStatus) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + + +### GetTarget + +`func (o *TaskStatus) GetTarget() Target` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *TaskStatus) GetTargetOk() (*Target, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *TaskStatus) SetTarget(v Target)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *TaskStatus) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + +### SetTargetNil + +`func (o *TaskStatus) SetTargetNil(b bool)` + + SetTargetNil sets the value for Target to be an explicit nil + +### UnsetTarget +`func (o *TaskStatus) UnsetTarget()` + +UnsetTarget ensures that no value is present for Target, not even an explicit nil +### GetCreated + +`func (o *TaskStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *TaskStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *TaskStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *TaskStatus) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *TaskStatus) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *TaskStatus) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetLaunched + +`func (o *TaskStatus) GetLaunched() SailPointTime` + +GetLaunched returns the Launched field if non-nil, zero value otherwise. + +### GetLaunchedOk + +`func (o *TaskStatus) GetLaunchedOk() (*SailPointTime, bool)` + +GetLaunchedOk returns a tuple with the Launched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunched + +`func (o *TaskStatus) SetLaunched(v SailPointTime)` + +SetLaunched sets Launched field to given value. + + +### SetLaunchedNil + +`func (o *TaskStatus) SetLaunchedNil(b bool)` + + SetLaunchedNil sets the value for Launched to be an explicit nil + +### UnsetLaunched +`func (o *TaskStatus) UnsetLaunched()` + +UnsetLaunched ensures that no value is present for Launched, not even an explicit nil +### GetCompleted + +`func (o *TaskStatus) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *TaskStatus) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *TaskStatus) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + + +### SetCompletedNil + +`func (o *TaskStatus) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *TaskStatus) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetCompletionStatus + +`func (o *TaskStatus) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *TaskStatus) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *TaskStatus) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + + +### SetCompletionStatusNil + +`func (o *TaskStatus) SetCompletionStatusNil(b bool)` + + SetCompletionStatusNil sets the value for CompletionStatus to be an explicit nil + +### UnsetCompletionStatus +`func (o *TaskStatus) UnsetCompletionStatus()` + +UnsetCompletionStatus ensures that no value is present for CompletionStatus, not even an explicit nil +### GetMessages + +`func (o *TaskStatus) GetMessages() []TaskStatusMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *TaskStatus) GetMessagesOk() (*[]TaskStatusMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *TaskStatus) SetMessages(v []TaskStatusMessage)` + +SetMessages sets Messages field to given value. + + +### GetReturns + +`func (o *TaskStatus) GetReturns() []TaskReturnDetails` + +GetReturns returns the Returns field if non-nil, zero value otherwise. + +### GetReturnsOk + +`func (o *TaskStatus) GetReturnsOk() (*[]TaskReturnDetails, bool)` + +GetReturnsOk returns a tuple with the Returns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReturns + +`func (o *TaskStatus) SetReturns(v []TaskReturnDetails)` + +SetReturns sets Returns field to given value. + + +### GetAttributes + +`func (o *TaskStatus) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TaskStatus) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TaskStatus) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetProgress + +`func (o *TaskStatus) GetProgress() string` + +GetProgress returns the Progress field if non-nil, zero value otherwise. + +### GetProgressOk + +`func (o *TaskStatus) GetProgressOk() (*string, bool)` + +GetProgressOk returns a tuple with the Progress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProgress + +`func (o *TaskStatus) SetProgress(v string)` + +SetProgress sets Progress field to given value. + + +### SetProgressNil + +`func (o *TaskStatus) SetProgressNil(b bool)` + + SetProgressNil sets the value for Progress to be an explicit nil + +### UnsetProgress +`func (o *TaskStatus) UnsetProgress()` + +UnsetProgress ensures that no value is present for Progress, not even an explicit nil +### GetPercentComplete + +`func (o *TaskStatus) GetPercentComplete() int32` + +GetPercentComplete returns the PercentComplete field if non-nil, zero value otherwise. + +### GetPercentCompleteOk + +`func (o *TaskStatus) GetPercentCompleteOk() (*int32, bool)` + +GetPercentCompleteOk returns a tuple with the PercentComplete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPercentComplete + +`func (o *TaskStatus) SetPercentComplete(v int32)` + +SetPercentComplete sets PercentComplete field to given value. + + +### GetTaskDefinitionSummary + +`func (o *TaskStatus) GetTaskDefinitionSummary() TaskDefinitionSummary` + +GetTaskDefinitionSummary returns the TaskDefinitionSummary field if non-nil, zero value otherwise. + +### GetTaskDefinitionSummaryOk + +`func (o *TaskStatus) GetTaskDefinitionSummaryOk() (*TaskDefinitionSummary, bool)` + +GetTaskDefinitionSummaryOk returns a tuple with the TaskDefinitionSummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskDefinitionSummary + +`func (o *TaskStatus) SetTaskDefinitionSummary(v TaskDefinitionSummary)` + +SetTaskDefinitionSummary sets TaskDefinitionSummary field to given value. + +### HasTaskDefinitionSummary + +`func (o *TaskStatus) HasTaskDefinitionSummary() bool` + +HasTaskDefinitionSummary returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TaskStatusMessage.md b/docs/tools/sdk/go/Reference/V2024/Models/TaskStatusMessage.md new file mode 100644 index 000000000..46a4583eb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TaskStatusMessage.md @@ -0,0 +1,142 @@ +--- +id: v2024-task-status-message +title: TaskStatusMessage +pagination_label: TaskStatusMessage +sidebar_label: TaskStatusMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskStatusMessage', 'V2024TaskStatusMessage'] +slug: /tools/sdk/go/v2024/models/task-status-message +tags: ['SDK', 'Software Development Kit', 'TaskStatusMessage', 'V2024TaskStatusMessage'] +--- + +# TaskStatusMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of the message | +**LocalizedText** | [**NullableLocalizedMessage**](localized-message) | | +**Key** | **string** | Key of the message | +**Parameters** | [**[]TaskStatusMessageParametersInner**](task-status-message-parameters-inner) | Message parameters for internationalization | + +## Methods + +### NewTaskStatusMessage + +`func NewTaskStatusMessage(type_ string, localizedText NullableLocalizedMessage, key string, parameters []TaskStatusMessageParametersInner, ) *TaskStatusMessage` + +NewTaskStatusMessage instantiates a new TaskStatusMessage 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 + +### NewTaskStatusMessageWithDefaults + +`func NewTaskStatusMessageWithDefaults() *TaskStatusMessage` + +NewTaskStatusMessageWithDefaults instantiates a new TaskStatusMessage 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 + +### GetType + +`func (o *TaskStatusMessage) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskStatusMessage) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskStatusMessage) SetType(v string)` + +SetType sets Type field to given value. + + +### GetLocalizedText + +`func (o *TaskStatusMessage) GetLocalizedText() LocalizedMessage` + +GetLocalizedText returns the LocalizedText field if non-nil, zero value otherwise. + +### GetLocalizedTextOk + +`func (o *TaskStatusMessage) GetLocalizedTextOk() (*LocalizedMessage, bool)` + +GetLocalizedTextOk returns a tuple with the LocalizedText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizedText + +`func (o *TaskStatusMessage) SetLocalizedText(v LocalizedMessage)` + +SetLocalizedText sets LocalizedText field to given value. + + +### SetLocalizedTextNil + +`func (o *TaskStatusMessage) SetLocalizedTextNil(b bool)` + + SetLocalizedTextNil sets the value for LocalizedText to be an explicit nil + +### UnsetLocalizedText +`func (o *TaskStatusMessage) UnsetLocalizedText()` + +UnsetLocalizedText ensures that no value is present for LocalizedText, not even an explicit nil +### GetKey + +`func (o *TaskStatusMessage) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TaskStatusMessage) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TaskStatusMessage) SetKey(v string)` + +SetKey sets Key field to given value. + + +### GetParameters + +`func (o *TaskStatusMessage) GetParameters() []TaskStatusMessageParametersInner` + +GetParameters returns the Parameters field if non-nil, zero value otherwise. + +### GetParametersOk + +`func (o *TaskStatusMessage) GetParametersOk() (*[]TaskStatusMessageParametersInner, bool)` + +GetParametersOk returns a tuple with the Parameters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParameters + +`func (o *TaskStatusMessage) SetParameters(v []TaskStatusMessageParametersInner)` + +SetParameters sets Parameters field to given value. + + +### SetParametersNil + +`func (o *TaskStatusMessage) SetParametersNil(b bool)` + + SetParametersNil sets the value for Parameters to be an explicit nil + +### UnsetParameters +`func (o *TaskStatusMessage) UnsetParameters()` + +UnsetParameters ensures that no value is present for Parameters, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TaskStatusMessageParametersInner.md b/docs/tools/sdk/go/Reference/V2024/Models/TaskStatusMessageParametersInner.md new file mode 100644 index 000000000..c9bbd5fa6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TaskStatusMessageParametersInner.md @@ -0,0 +1,38 @@ +--- +id: v2024-task-status-message-parameters-inner +title: TaskStatusMessageParametersInner +pagination_label: TaskStatusMessageParametersInner +sidebar_label: TaskStatusMessageParametersInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskStatusMessageParametersInner', 'V2024TaskStatusMessageParametersInner'] +slug: /tools/sdk/go/v2024/models/task-status-message-parameters-inner +tags: ['SDK', 'Software Development Kit', 'TaskStatusMessageParametersInner', 'V2024TaskStatusMessageParametersInner'] +--- + +# TaskStatusMessageParametersInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewTaskStatusMessageParametersInner + +`func NewTaskStatusMessageParametersInner() *TaskStatusMessageParametersInner` + +NewTaskStatusMessageParametersInner instantiates a new TaskStatusMessageParametersInner 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 + +### NewTaskStatusMessageParametersInnerWithDefaults + +`func NewTaskStatusMessageParametersInnerWithDefaults() *TaskStatusMessageParametersInner` + +NewTaskStatusMessageParametersInnerWithDefaults instantiates a new TaskStatusMessageParametersInner 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 + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TemplateBulkDeleteDto.md b/docs/tools/sdk/go/Reference/V2024/Models/TemplateBulkDeleteDto.md new file mode 100644 index 000000000..9473a4164 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TemplateBulkDeleteDto.md @@ -0,0 +1,111 @@ +--- +id: v2024-template-bulk-delete-dto +title: TemplateBulkDeleteDto +pagination_label: TemplateBulkDeleteDto +sidebar_label: TemplateBulkDeleteDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateBulkDeleteDto', 'V2024TemplateBulkDeleteDto'] +slug: /tools/sdk/go/v2024/models/template-bulk-delete-dto +tags: ['SDK', 'Software Development Kit', 'TemplateBulkDeleteDto', 'V2024TemplateBulkDeleteDto'] +--- + +# TemplateBulkDeleteDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **string** | | +**Medium** | Pointer to **string** | | [optional] +**Locale** | Pointer to **string** | The locale for the message text, a BCP 47 language tag. | [optional] + +## Methods + +### NewTemplateBulkDeleteDto + +`func NewTemplateBulkDeleteDto(key string, ) *TemplateBulkDeleteDto` + +NewTemplateBulkDeleteDto instantiates a new TemplateBulkDeleteDto 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 + +### NewTemplateBulkDeleteDtoWithDefaults + +`func NewTemplateBulkDeleteDtoWithDefaults() *TemplateBulkDeleteDto` + +NewTemplateBulkDeleteDtoWithDefaults instantiates a new TemplateBulkDeleteDto 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 + +### GetKey + +`func (o *TemplateBulkDeleteDto) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TemplateBulkDeleteDto) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TemplateBulkDeleteDto) SetKey(v string)` + +SetKey sets Key field to given value. + + +### GetMedium + +`func (o *TemplateBulkDeleteDto) GetMedium() string` + +GetMedium returns the Medium field if non-nil, zero value otherwise. + +### GetMediumOk + +`func (o *TemplateBulkDeleteDto) GetMediumOk() (*string, bool)` + +GetMediumOk returns a tuple with the Medium field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMedium + +`func (o *TemplateBulkDeleteDto) SetMedium(v string)` + +SetMedium sets Medium field to given value. + +### HasMedium + +`func (o *TemplateBulkDeleteDto) HasMedium() bool` + +HasMedium returns a boolean if a field has been set. + +### GetLocale + +`func (o *TemplateBulkDeleteDto) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *TemplateBulkDeleteDto) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *TemplateBulkDeleteDto) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *TemplateBulkDeleteDto) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TemplateDto.md b/docs/tools/sdk/go/Reference/V2024/Models/TemplateDto.md new file mode 100644 index 000000000..7f63d9eee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TemplateDto.md @@ -0,0 +1,479 @@ +--- +id: v2024-template-dto +title: TemplateDto +pagination_label: TemplateDto +sidebar_label: TemplateDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateDto', 'V2024TemplateDto'] +slug: /tools/sdk/go/v2024/models/template-dto +tags: ['SDK', 'Software Development Kit', 'TemplateDto', 'V2024TemplateDto'] +--- + +# TemplateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **string** | The key of the template | +**Name** | Pointer to **string** | The name of the Task Manager Subscription | [optional] +**Medium** | **string** | The message medium. More mediums may be added in the future. | +**Locale** | **string** | The locale for the message text, a BCP 47 language tag. | +**Subject** | Pointer to **string** | The subject line in the template | [optional] +**Header** | Pointer to **NullableString** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**Body** | Pointer to **string** | The body in the template | [optional] +**Footer** | Pointer to **NullableString** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**From** | Pointer to **string** | The \"From:\" address in the template | [optional] +**ReplyTo** | Pointer to **string** | The \"Reply To\" line in the template | [optional] +**Description** | Pointer to **string** | The description in the template | [optional] +**Id** | Pointer to **string** | This is auto-generated. | [optional] +**Created** | Pointer to **SailPointTime** | The time when this template is created. This is auto-generated. | [optional] +**Modified** | Pointer to **SailPointTime** | The time when this template was last modified. This is auto-generated. | [optional] +**SlackTemplate** | Pointer to **NullableString** | | [optional] +**TeamsTemplate** | Pointer to **NullableString** | | [optional] + +## Methods + +### NewTemplateDto + +`func NewTemplateDto(key string, medium string, locale string, ) *TemplateDto` + +NewTemplateDto instantiates a new TemplateDto 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 + +### NewTemplateDtoWithDefaults + +`func NewTemplateDtoWithDefaults() *TemplateDto` + +NewTemplateDtoWithDefaults instantiates a new TemplateDto 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 + +### GetKey + +`func (o *TemplateDto) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TemplateDto) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TemplateDto) SetKey(v string)` + +SetKey sets Key field to given value. + + +### GetName + +`func (o *TemplateDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TemplateDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TemplateDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TemplateDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetMedium + +`func (o *TemplateDto) GetMedium() string` + +GetMedium returns the Medium field if non-nil, zero value otherwise. + +### GetMediumOk + +`func (o *TemplateDto) GetMediumOk() (*string, bool)` + +GetMediumOk returns a tuple with the Medium field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMedium + +`func (o *TemplateDto) SetMedium(v string)` + +SetMedium sets Medium field to given value. + + +### GetLocale + +`func (o *TemplateDto) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *TemplateDto) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *TemplateDto) SetLocale(v string)` + +SetLocale sets Locale field to given value. + + +### GetSubject + +`func (o *TemplateDto) GetSubject() string` + +GetSubject returns the Subject field if non-nil, zero value otherwise. + +### GetSubjectOk + +`func (o *TemplateDto) GetSubjectOk() (*string, bool)` + +GetSubjectOk returns a tuple with the Subject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubject + +`func (o *TemplateDto) SetSubject(v string)` + +SetSubject sets Subject field to given value. + +### HasSubject + +`func (o *TemplateDto) HasSubject() bool` + +HasSubject returns a boolean if a field has been set. + +### GetHeader + +`func (o *TemplateDto) GetHeader() string` + +GetHeader returns the Header field if non-nil, zero value otherwise. + +### GetHeaderOk + +`func (o *TemplateDto) GetHeaderOk() (*string, bool)` + +GetHeaderOk returns a tuple with the Header field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHeader + +`func (o *TemplateDto) SetHeader(v string)` + +SetHeader sets Header field to given value. + +### HasHeader + +`func (o *TemplateDto) HasHeader() bool` + +HasHeader returns a boolean if a field has been set. + +### SetHeaderNil + +`func (o *TemplateDto) SetHeaderNil(b bool)` + + SetHeaderNil sets the value for Header to be an explicit nil + +### UnsetHeader +`func (o *TemplateDto) UnsetHeader()` + +UnsetHeader ensures that no value is present for Header, not even an explicit nil +### GetBody + +`func (o *TemplateDto) GetBody() string` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *TemplateDto) GetBodyOk() (*string, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBody + +`func (o *TemplateDto) SetBody(v string)` + +SetBody sets Body field to given value. + +### HasBody + +`func (o *TemplateDto) HasBody() bool` + +HasBody returns a boolean if a field has been set. + +### GetFooter + +`func (o *TemplateDto) GetFooter() string` + +GetFooter returns the Footer field if non-nil, zero value otherwise. + +### GetFooterOk + +`func (o *TemplateDto) GetFooterOk() (*string, bool)` + +GetFooterOk returns a tuple with the Footer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFooter + +`func (o *TemplateDto) SetFooter(v string)` + +SetFooter sets Footer field to given value. + +### HasFooter + +`func (o *TemplateDto) HasFooter() bool` + +HasFooter returns a boolean if a field has been set. + +### SetFooterNil + +`func (o *TemplateDto) SetFooterNil(b bool)` + + SetFooterNil sets the value for Footer to be an explicit nil + +### UnsetFooter +`func (o *TemplateDto) UnsetFooter()` + +UnsetFooter ensures that no value is present for Footer, not even an explicit nil +### GetFrom + +`func (o *TemplateDto) GetFrom() string` + +GetFrom returns the From field if non-nil, zero value otherwise. + +### GetFromOk + +`func (o *TemplateDto) GetFromOk() (*string, bool)` + +GetFromOk returns a tuple with the From field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrom + +`func (o *TemplateDto) SetFrom(v string)` + +SetFrom sets From field to given value. + +### HasFrom + +`func (o *TemplateDto) HasFrom() bool` + +HasFrom returns a boolean if a field has been set. + +### GetReplyTo + +`func (o *TemplateDto) GetReplyTo() string` + +GetReplyTo returns the ReplyTo field if non-nil, zero value otherwise. + +### GetReplyToOk + +`func (o *TemplateDto) GetReplyToOk() (*string, bool)` + +GetReplyToOk returns a tuple with the ReplyTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplyTo + +`func (o *TemplateDto) SetReplyTo(v string)` + +SetReplyTo sets ReplyTo field to given value. + +### HasReplyTo + +`func (o *TemplateDto) HasReplyTo() bool` + +HasReplyTo returns a boolean if a field has been set. + +### GetDescription + +`func (o *TemplateDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TemplateDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TemplateDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *TemplateDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetId + +`func (o *TemplateDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TemplateDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TemplateDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TemplateDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreated + +`func (o *TemplateDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *TemplateDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *TemplateDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *TemplateDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *TemplateDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *TemplateDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *TemplateDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *TemplateDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetSlackTemplate + +`func (o *TemplateDto) GetSlackTemplate() string` + +GetSlackTemplate returns the SlackTemplate field if non-nil, zero value otherwise. + +### GetSlackTemplateOk + +`func (o *TemplateDto) GetSlackTemplateOk() (*string, bool)` + +GetSlackTemplateOk returns a tuple with the SlackTemplate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSlackTemplate + +`func (o *TemplateDto) SetSlackTemplate(v string)` + +SetSlackTemplate sets SlackTemplate field to given value. + +### HasSlackTemplate + +`func (o *TemplateDto) HasSlackTemplate() bool` + +HasSlackTemplate returns a boolean if a field has been set. + +### SetSlackTemplateNil + +`func (o *TemplateDto) SetSlackTemplateNil(b bool)` + + SetSlackTemplateNil sets the value for SlackTemplate to be an explicit nil + +### UnsetSlackTemplate +`func (o *TemplateDto) UnsetSlackTemplate()` + +UnsetSlackTemplate ensures that no value is present for SlackTemplate, not even an explicit nil +### GetTeamsTemplate + +`func (o *TemplateDto) GetTeamsTemplate() string` + +GetTeamsTemplate returns the TeamsTemplate field if non-nil, zero value otherwise. + +### GetTeamsTemplateOk + +`func (o *TemplateDto) GetTeamsTemplateOk() (*string, bool)` + +GetTeamsTemplateOk returns a tuple with the TeamsTemplate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamsTemplate + +`func (o *TemplateDto) SetTeamsTemplate(v string)` + +SetTeamsTemplate sets TeamsTemplate field to given value. + +### HasTeamsTemplate + +`func (o *TemplateDto) HasTeamsTemplate() bool` + +HasTeamsTemplate returns a boolean if a field has been set. + +### SetTeamsTemplateNil + +`func (o *TemplateDto) SetTeamsTemplateNil(b bool)` + + SetTeamsTemplateNil sets the value for TeamsTemplate to be an explicit nil + +### UnsetTeamsTemplate +`func (o *TemplateDto) UnsetTeamsTemplate()` + +UnsetTeamsTemplate ensures that no value is present for TeamsTemplate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TemplateDtoDefault.md b/docs/tools/sdk/go/Reference/V2024/Models/TemplateDtoDefault.md new file mode 100644 index 000000000..55493cd11 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TemplateDtoDefault.md @@ -0,0 +1,456 @@ +--- +id: v2024-template-dto-default +title: TemplateDtoDefault +pagination_label: TemplateDtoDefault +sidebar_label: TemplateDtoDefault +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateDtoDefault', 'V2024TemplateDtoDefault'] +slug: /tools/sdk/go/v2024/models/template-dto-default +tags: ['SDK', 'Software Development Kit', 'TemplateDtoDefault', 'V2024TemplateDtoDefault'] +--- + +# TemplateDtoDefault + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The key of the default template | [optional] +**Name** | Pointer to **string** | The name of the default template | [optional] +**Medium** | Pointer to **string** | The message medium. More mediums may be added in the future. | [optional] +**Locale** | Pointer to **string** | The locale for the message text, a BCP 47 language tag. | [optional] +**Subject** | Pointer to **NullableString** | The subject of the default template | [optional] +**Header** | Pointer to **NullableString** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**Body** | Pointer to **string** | The body of the default template | [optional] +**Footer** | Pointer to **NullableString** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**From** | Pointer to **NullableString** | The \"From:\" address of the default template | [optional] +**ReplyTo** | Pointer to **NullableString** | The \"Reply To\" field of the default template | [optional] +**Description** | Pointer to **NullableString** | The description of the default template | [optional] +**SlackTemplate** | Pointer to [**NullableTemplateSlack**](template-slack) | | [optional] +**TeamsTemplate** | Pointer to [**NullableTemplateTeams**](template-teams) | | [optional] + +## Methods + +### NewTemplateDtoDefault + +`func NewTemplateDtoDefault() *TemplateDtoDefault` + +NewTemplateDtoDefault instantiates a new TemplateDtoDefault 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 + +### NewTemplateDtoDefaultWithDefaults + +`func NewTemplateDtoDefaultWithDefaults() *TemplateDtoDefault` + +NewTemplateDtoDefaultWithDefaults instantiates a new TemplateDtoDefault 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 + +### GetKey + +`func (o *TemplateDtoDefault) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TemplateDtoDefault) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TemplateDtoDefault) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *TemplateDtoDefault) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *TemplateDtoDefault) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TemplateDtoDefault) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TemplateDtoDefault) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TemplateDtoDefault) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetMedium + +`func (o *TemplateDtoDefault) GetMedium() string` + +GetMedium returns the Medium field if non-nil, zero value otherwise. + +### GetMediumOk + +`func (o *TemplateDtoDefault) GetMediumOk() (*string, bool)` + +GetMediumOk returns a tuple with the Medium field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMedium + +`func (o *TemplateDtoDefault) SetMedium(v string)` + +SetMedium sets Medium field to given value. + +### HasMedium + +`func (o *TemplateDtoDefault) HasMedium() bool` + +HasMedium returns a boolean if a field has been set. + +### GetLocale + +`func (o *TemplateDtoDefault) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *TemplateDtoDefault) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *TemplateDtoDefault) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *TemplateDtoDefault) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + +### GetSubject + +`func (o *TemplateDtoDefault) GetSubject() string` + +GetSubject returns the Subject field if non-nil, zero value otherwise. + +### GetSubjectOk + +`func (o *TemplateDtoDefault) GetSubjectOk() (*string, bool)` + +GetSubjectOk returns a tuple with the Subject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubject + +`func (o *TemplateDtoDefault) SetSubject(v string)` + +SetSubject sets Subject field to given value. + +### HasSubject + +`func (o *TemplateDtoDefault) HasSubject() bool` + +HasSubject returns a boolean if a field has been set. + +### SetSubjectNil + +`func (o *TemplateDtoDefault) SetSubjectNil(b bool)` + + SetSubjectNil sets the value for Subject to be an explicit nil + +### UnsetSubject +`func (o *TemplateDtoDefault) UnsetSubject()` + +UnsetSubject ensures that no value is present for Subject, not even an explicit nil +### GetHeader + +`func (o *TemplateDtoDefault) GetHeader() string` + +GetHeader returns the Header field if non-nil, zero value otherwise. + +### GetHeaderOk + +`func (o *TemplateDtoDefault) GetHeaderOk() (*string, bool)` + +GetHeaderOk returns a tuple with the Header field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHeader + +`func (o *TemplateDtoDefault) SetHeader(v string)` + +SetHeader sets Header field to given value. + +### HasHeader + +`func (o *TemplateDtoDefault) HasHeader() bool` + +HasHeader returns a boolean if a field has been set. + +### SetHeaderNil + +`func (o *TemplateDtoDefault) SetHeaderNil(b bool)` + + SetHeaderNil sets the value for Header to be an explicit nil + +### UnsetHeader +`func (o *TemplateDtoDefault) UnsetHeader()` + +UnsetHeader ensures that no value is present for Header, not even an explicit nil +### GetBody + +`func (o *TemplateDtoDefault) GetBody() string` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *TemplateDtoDefault) GetBodyOk() (*string, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBody + +`func (o *TemplateDtoDefault) SetBody(v string)` + +SetBody sets Body field to given value. + +### HasBody + +`func (o *TemplateDtoDefault) HasBody() bool` + +HasBody returns a boolean if a field has been set. + +### GetFooter + +`func (o *TemplateDtoDefault) GetFooter() string` + +GetFooter returns the Footer field if non-nil, zero value otherwise. + +### GetFooterOk + +`func (o *TemplateDtoDefault) GetFooterOk() (*string, bool)` + +GetFooterOk returns a tuple with the Footer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFooter + +`func (o *TemplateDtoDefault) SetFooter(v string)` + +SetFooter sets Footer field to given value. + +### HasFooter + +`func (o *TemplateDtoDefault) HasFooter() bool` + +HasFooter returns a boolean if a field has been set. + +### SetFooterNil + +`func (o *TemplateDtoDefault) SetFooterNil(b bool)` + + SetFooterNil sets the value for Footer to be an explicit nil + +### UnsetFooter +`func (o *TemplateDtoDefault) UnsetFooter()` + +UnsetFooter ensures that no value is present for Footer, not even an explicit nil +### GetFrom + +`func (o *TemplateDtoDefault) GetFrom() string` + +GetFrom returns the From field if non-nil, zero value otherwise. + +### GetFromOk + +`func (o *TemplateDtoDefault) GetFromOk() (*string, bool)` + +GetFromOk returns a tuple with the From field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrom + +`func (o *TemplateDtoDefault) SetFrom(v string)` + +SetFrom sets From field to given value. + +### HasFrom + +`func (o *TemplateDtoDefault) HasFrom() bool` + +HasFrom returns a boolean if a field has been set. + +### SetFromNil + +`func (o *TemplateDtoDefault) SetFromNil(b bool)` + + SetFromNil sets the value for From to be an explicit nil + +### UnsetFrom +`func (o *TemplateDtoDefault) UnsetFrom()` + +UnsetFrom ensures that no value is present for From, not even an explicit nil +### GetReplyTo + +`func (o *TemplateDtoDefault) GetReplyTo() string` + +GetReplyTo returns the ReplyTo field if non-nil, zero value otherwise. + +### GetReplyToOk + +`func (o *TemplateDtoDefault) GetReplyToOk() (*string, bool)` + +GetReplyToOk returns a tuple with the ReplyTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplyTo + +`func (o *TemplateDtoDefault) SetReplyTo(v string)` + +SetReplyTo sets ReplyTo field to given value. + +### HasReplyTo + +`func (o *TemplateDtoDefault) HasReplyTo() bool` + +HasReplyTo returns a boolean if a field has been set. + +### SetReplyToNil + +`func (o *TemplateDtoDefault) SetReplyToNil(b bool)` + + SetReplyToNil sets the value for ReplyTo to be an explicit nil + +### UnsetReplyTo +`func (o *TemplateDtoDefault) UnsetReplyTo()` + +UnsetReplyTo ensures that no value is present for ReplyTo, not even an explicit nil +### GetDescription + +`func (o *TemplateDtoDefault) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TemplateDtoDefault) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TemplateDtoDefault) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *TemplateDtoDefault) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *TemplateDtoDefault) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *TemplateDtoDefault) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSlackTemplate + +`func (o *TemplateDtoDefault) GetSlackTemplate() TemplateSlack` + +GetSlackTemplate returns the SlackTemplate field if non-nil, zero value otherwise. + +### GetSlackTemplateOk + +`func (o *TemplateDtoDefault) GetSlackTemplateOk() (*TemplateSlack, bool)` + +GetSlackTemplateOk returns a tuple with the SlackTemplate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSlackTemplate + +`func (o *TemplateDtoDefault) SetSlackTemplate(v TemplateSlack)` + +SetSlackTemplate sets SlackTemplate field to given value. + +### HasSlackTemplate + +`func (o *TemplateDtoDefault) HasSlackTemplate() bool` + +HasSlackTemplate returns a boolean if a field has been set. + +### SetSlackTemplateNil + +`func (o *TemplateDtoDefault) SetSlackTemplateNil(b bool)` + + SetSlackTemplateNil sets the value for SlackTemplate to be an explicit nil + +### UnsetSlackTemplate +`func (o *TemplateDtoDefault) UnsetSlackTemplate()` + +UnsetSlackTemplate ensures that no value is present for SlackTemplate, not even an explicit nil +### GetTeamsTemplate + +`func (o *TemplateDtoDefault) GetTeamsTemplate() TemplateTeams` + +GetTeamsTemplate returns the TeamsTemplate field if non-nil, zero value otherwise. + +### GetTeamsTemplateOk + +`func (o *TemplateDtoDefault) GetTeamsTemplateOk() (*TemplateTeams, bool)` + +GetTeamsTemplateOk returns a tuple with the TeamsTemplate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamsTemplate + +`func (o *TemplateDtoDefault) SetTeamsTemplate(v TemplateTeams)` + +SetTeamsTemplate sets TeamsTemplate field to given value. + +### HasTeamsTemplate + +`func (o *TemplateDtoDefault) HasTeamsTemplate() bool` + +HasTeamsTemplate returns a boolean if a field has been set. + +### SetTeamsTemplateNil + +`func (o *TemplateDtoDefault) SetTeamsTemplateNil(b bool)` + + SetTeamsTemplateNil sets the value for TeamsTemplate to be an explicit nil + +### UnsetTeamsTemplate +`func (o *TemplateDtoDefault) UnsetTeamsTemplate()` + +UnsetTeamsTemplate ensures that no value is present for TeamsTemplate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TemplateSlack.md b/docs/tools/sdk/go/Reference/V2024/Models/TemplateSlack.md new file mode 100644 index 000000000..a31a1b694 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TemplateSlack.md @@ -0,0 +1,414 @@ +--- +id: v2024-template-slack +title: TemplateSlack +pagination_label: TemplateSlack +sidebar_label: TemplateSlack +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateSlack', 'V2024TemplateSlack'] +slug: /tools/sdk/go/v2024/models/template-slack +tags: ['SDK', 'Software Development Kit', 'TemplateSlack', 'V2024TemplateSlack'] +--- + +# TemplateSlack + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **NullableString** | | [optional] +**Text** | Pointer to **string** | | [optional] +**Blocks** | Pointer to **NullableString** | | [optional] +**Attachments** | Pointer to **string** | | [optional] +**NotificationType** | Pointer to **NullableString** | | [optional] +**ApprovalId** | Pointer to **NullableString** | | [optional] +**RequestId** | Pointer to **NullableString** | | [optional] +**RequestedById** | Pointer to **NullableString** | | [optional] +**IsSubscription** | Pointer to **NullableBool** | | [optional] +**AutoApprovalData** | Pointer to [**NullableTemplateSlackAutoApprovalData**](template-slack-auto-approval-data) | | [optional] +**CustomFields** | Pointer to [**NullableTemplateSlackCustomFields**](template-slack-custom-fields) | | [optional] + +## Methods + +### NewTemplateSlack + +`func NewTemplateSlack() *TemplateSlack` + +NewTemplateSlack instantiates a new TemplateSlack 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 + +### NewTemplateSlackWithDefaults + +`func NewTemplateSlackWithDefaults() *TemplateSlack` + +NewTemplateSlackWithDefaults instantiates a new TemplateSlack 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 + +### GetKey + +`func (o *TemplateSlack) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TemplateSlack) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TemplateSlack) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *TemplateSlack) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *TemplateSlack) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *TemplateSlack) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetText + +`func (o *TemplateSlack) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *TemplateSlack) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *TemplateSlack) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *TemplateSlack) HasText() bool` + +HasText returns a boolean if a field has been set. + +### GetBlocks + +`func (o *TemplateSlack) GetBlocks() string` + +GetBlocks returns the Blocks field if non-nil, zero value otherwise. + +### GetBlocksOk + +`func (o *TemplateSlack) GetBlocksOk() (*string, bool)` + +GetBlocksOk returns a tuple with the Blocks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBlocks + +`func (o *TemplateSlack) SetBlocks(v string)` + +SetBlocks sets Blocks field to given value. + +### HasBlocks + +`func (o *TemplateSlack) HasBlocks() bool` + +HasBlocks returns a boolean if a field has been set. + +### SetBlocksNil + +`func (o *TemplateSlack) SetBlocksNil(b bool)` + + SetBlocksNil sets the value for Blocks to be an explicit nil + +### UnsetBlocks +`func (o *TemplateSlack) UnsetBlocks()` + +UnsetBlocks ensures that no value is present for Blocks, not even an explicit nil +### GetAttachments + +`func (o *TemplateSlack) GetAttachments() string` + +GetAttachments returns the Attachments field if non-nil, zero value otherwise. + +### GetAttachmentsOk + +`func (o *TemplateSlack) GetAttachmentsOk() (*string, bool)` + +GetAttachmentsOk returns a tuple with the Attachments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttachments + +`func (o *TemplateSlack) SetAttachments(v string)` + +SetAttachments sets Attachments field to given value. + +### HasAttachments + +`func (o *TemplateSlack) HasAttachments() bool` + +HasAttachments returns a boolean if a field has been set. + +### GetNotificationType + +`func (o *TemplateSlack) GetNotificationType() string` + +GetNotificationType returns the NotificationType field if non-nil, zero value otherwise. + +### GetNotificationTypeOk + +`func (o *TemplateSlack) GetNotificationTypeOk() (*string, bool)` + +GetNotificationTypeOk returns a tuple with the NotificationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotificationType + +`func (o *TemplateSlack) SetNotificationType(v string)` + +SetNotificationType sets NotificationType field to given value. + +### HasNotificationType + +`func (o *TemplateSlack) HasNotificationType() bool` + +HasNotificationType returns a boolean if a field has been set. + +### SetNotificationTypeNil + +`func (o *TemplateSlack) SetNotificationTypeNil(b bool)` + + SetNotificationTypeNil sets the value for NotificationType to be an explicit nil + +### UnsetNotificationType +`func (o *TemplateSlack) UnsetNotificationType()` + +UnsetNotificationType ensures that no value is present for NotificationType, not even an explicit nil +### GetApprovalId + +`func (o *TemplateSlack) GetApprovalId() string` + +GetApprovalId returns the ApprovalId field if non-nil, zero value otherwise. + +### GetApprovalIdOk + +`func (o *TemplateSlack) GetApprovalIdOk() (*string, bool)` + +GetApprovalIdOk returns a tuple with the ApprovalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalId + +`func (o *TemplateSlack) SetApprovalId(v string)` + +SetApprovalId sets ApprovalId field to given value. + +### HasApprovalId + +`func (o *TemplateSlack) HasApprovalId() bool` + +HasApprovalId returns a boolean if a field has been set. + +### SetApprovalIdNil + +`func (o *TemplateSlack) SetApprovalIdNil(b bool)` + + SetApprovalIdNil sets the value for ApprovalId to be an explicit nil + +### UnsetApprovalId +`func (o *TemplateSlack) UnsetApprovalId()` + +UnsetApprovalId ensures that no value is present for ApprovalId, not even an explicit nil +### GetRequestId + +`func (o *TemplateSlack) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *TemplateSlack) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *TemplateSlack) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *TemplateSlack) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *TemplateSlack) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *TemplateSlack) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetRequestedById + +`func (o *TemplateSlack) GetRequestedById() string` + +GetRequestedById returns the RequestedById field if non-nil, zero value otherwise. + +### GetRequestedByIdOk + +`func (o *TemplateSlack) GetRequestedByIdOk() (*string, bool)` + +GetRequestedByIdOk returns a tuple with the RequestedById field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedById + +`func (o *TemplateSlack) SetRequestedById(v string)` + +SetRequestedById sets RequestedById field to given value. + +### HasRequestedById + +`func (o *TemplateSlack) HasRequestedById() bool` + +HasRequestedById returns a boolean if a field has been set. + +### SetRequestedByIdNil + +`func (o *TemplateSlack) SetRequestedByIdNil(b bool)` + + SetRequestedByIdNil sets the value for RequestedById to be an explicit nil + +### UnsetRequestedById +`func (o *TemplateSlack) UnsetRequestedById()` + +UnsetRequestedById ensures that no value is present for RequestedById, not even an explicit nil +### GetIsSubscription + +`func (o *TemplateSlack) GetIsSubscription() bool` + +GetIsSubscription returns the IsSubscription field if non-nil, zero value otherwise. + +### GetIsSubscriptionOk + +`func (o *TemplateSlack) GetIsSubscriptionOk() (*bool, bool)` + +GetIsSubscriptionOk returns a tuple with the IsSubscription field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSubscription + +`func (o *TemplateSlack) SetIsSubscription(v bool)` + +SetIsSubscription sets IsSubscription field to given value. + +### HasIsSubscription + +`func (o *TemplateSlack) HasIsSubscription() bool` + +HasIsSubscription returns a boolean if a field has been set. + +### SetIsSubscriptionNil + +`func (o *TemplateSlack) SetIsSubscriptionNil(b bool)` + + SetIsSubscriptionNil sets the value for IsSubscription to be an explicit nil + +### UnsetIsSubscription +`func (o *TemplateSlack) UnsetIsSubscription()` + +UnsetIsSubscription ensures that no value is present for IsSubscription, not even an explicit nil +### GetAutoApprovalData + +`func (o *TemplateSlack) GetAutoApprovalData() TemplateSlackAutoApprovalData` + +GetAutoApprovalData returns the AutoApprovalData field if non-nil, zero value otherwise. + +### GetAutoApprovalDataOk + +`func (o *TemplateSlack) GetAutoApprovalDataOk() (*TemplateSlackAutoApprovalData, bool)` + +GetAutoApprovalDataOk returns a tuple with the AutoApprovalData field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoApprovalData + +`func (o *TemplateSlack) SetAutoApprovalData(v TemplateSlackAutoApprovalData)` + +SetAutoApprovalData sets AutoApprovalData field to given value. + +### HasAutoApprovalData + +`func (o *TemplateSlack) HasAutoApprovalData() bool` + +HasAutoApprovalData returns a boolean if a field has been set. + +### SetAutoApprovalDataNil + +`func (o *TemplateSlack) SetAutoApprovalDataNil(b bool)` + + SetAutoApprovalDataNil sets the value for AutoApprovalData to be an explicit nil + +### UnsetAutoApprovalData +`func (o *TemplateSlack) UnsetAutoApprovalData()` + +UnsetAutoApprovalData ensures that no value is present for AutoApprovalData, not even an explicit nil +### GetCustomFields + +`func (o *TemplateSlack) GetCustomFields() TemplateSlackCustomFields` + +GetCustomFields returns the CustomFields field if non-nil, zero value otherwise. + +### GetCustomFieldsOk + +`func (o *TemplateSlack) GetCustomFieldsOk() (*TemplateSlackCustomFields, bool)` + +GetCustomFieldsOk returns a tuple with the CustomFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomFields + +`func (o *TemplateSlack) SetCustomFields(v TemplateSlackCustomFields)` + +SetCustomFields sets CustomFields field to given value. + +### HasCustomFields + +`func (o *TemplateSlack) HasCustomFields() bool` + +HasCustomFields returns a boolean if a field has been set. + +### SetCustomFieldsNil + +`func (o *TemplateSlack) SetCustomFieldsNil(b bool)` + + SetCustomFieldsNil sets the value for CustomFields to be an explicit nil + +### UnsetCustomFields +`func (o *TemplateSlack) UnsetCustomFields()` + +UnsetCustomFields ensures that no value is present for CustomFields, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TemplateSlackAutoApprovalData.md b/docs/tools/sdk/go/Reference/V2024/Models/TemplateSlackAutoApprovalData.md new file mode 100644 index 000000000..89a61a764 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TemplateSlackAutoApprovalData.md @@ -0,0 +1,218 @@ +--- +id: v2024-template-slack-auto-approval-data +title: TemplateSlackAutoApprovalData +pagination_label: TemplateSlackAutoApprovalData +sidebar_label: TemplateSlackAutoApprovalData +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateSlackAutoApprovalData', 'V2024TemplateSlackAutoApprovalData'] +slug: /tools/sdk/go/v2024/models/template-slack-auto-approval-data +tags: ['SDK', 'Software Development Kit', 'TemplateSlackAutoApprovalData', 'V2024TemplateSlackAutoApprovalData'] +--- + +# TemplateSlackAutoApprovalData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsAutoApproved** | Pointer to **NullableString** | | [optional] +**ItemId** | Pointer to **NullableString** | | [optional] +**ItemType** | Pointer to **NullableString** | | [optional] +**AutoApprovalMessageJSON** | Pointer to **NullableString** | | [optional] +**AutoApprovalTitle** | Pointer to **NullableString** | | [optional] + +## Methods + +### NewTemplateSlackAutoApprovalData + +`func NewTemplateSlackAutoApprovalData() *TemplateSlackAutoApprovalData` + +NewTemplateSlackAutoApprovalData instantiates a new TemplateSlackAutoApprovalData 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 + +### NewTemplateSlackAutoApprovalDataWithDefaults + +`func NewTemplateSlackAutoApprovalDataWithDefaults() *TemplateSlackAutoApprovalData` + +NewTemplateSlackAutoApprovalDataWithDefaults instantiates a new TemplateSlackAutoApprovalData 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 + +### GetIsAutoApproved + +`func (o *TemplateSlackAutoApprovalData) GetIsAutoApproved() string` + +GetIsAutoApproved returns the IsAutoApproved field if non-nil, zero value otherwise. + +### GetIsAutoApprovedOk + +`func (o *TemplateSlackAutoApprovalData) GetIsAutoApprovedOk() (*string, bool)` + +GetIsAutoApprovedOk returns a tuple with the IsAutoApproved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsAutoApproved + +`func (o *TemplateSlackAutoApprovalData) SetIsAutoApproved(v string)` + +SetIsAutoApproved sets IsAutoApproved field to given value. + +### HasIsAutoApproved + +`func (o *TemplateSlackAutoApprovalData) HasIsAutoApproved() bool` + +HasIsAutoApproved returns a boolean if a field has been set. + +### SetIsAutoApprovedNil + +`func (o *TemplateSlackAutoApprovalData) SetIsAutoApprovedNil(b bool)` + + SetIsAutoApprovedNil sets the value for IsAutoApproved to be an explicit nil + +### UnsetIsAutoApproved +`func (o *TemplateSlackAutoApprovalData) UnsetIsAutoApproved()` + +UnsetIsAutoApproved ensures that no value is present for IsAutoApproved, not even an explicit nil +### GetItemId + +`func (o *TemplateSlackAutoApprovalData) GetItemId() string` + +GetItemId returns the ItemId field if non-nil, zero value otherwise. + +### GetItemIdOk + +`func (o *TemplateSlackAutoApprovalData) GetItemIdOk() (*string, bool)` + +GetItemIdOk returns a tuple with the ItemId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItemId + +`func (o *TemplateSlackAutoApprovalData) SetItemId(v string)` + +SetItemId sets ItemId field to given value. + +### HasItemId + +`func (o *TemplateSlackAutoApprovalData) HasItemId() bool` + +HasItemId returns a boolean if a field has been set. + +### SetItemIdNil + +`func (o *TemplateSlackAutoApprovalData) SetItemIdNil(b bool)` + + SetItemIdNil sets the value for ItemId to be an explicit nil + +### UnsetItemId +`func (o *TemplateSlackAutoApprovalData) UnsetItemId()` + +UnsetItemId ensures that no value is present for ItemId, not even an explicit nil +### GetItemType + +`func (o *TemplateSlackAutoApprovalData) GetItemType() string` + +GetItemType returns the ItemType field if non-nil, zero value otherwise. + +### GetItemTypeOk + +`func (o *TemplateSlackAutoApprovalData) GetItemTypeOk() (*string, bool)` + +GetItemTypeOk returns a tuple with the ItemType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItemType + +`func (o *TemplateSlackAutoApprovalData) SetItemType(v string)` + +SetItemType sets ItemType field to given value. + +### HasItemType + +`func (o *TemplateSlackAutoApprovalData) HasItemType() bool` + +HasItemType returns a boolean if a field has been set. + +### SetItemTypeNil + +`func (o *TemplateSlackAutoApprovalData) SetItemTypeNil(b bool)` + + SetItemTypeNil sets the value for ItemType to be an explicit nil + +### UnsetItemType +`func (o *TemplateSlackAutoApprovalData) UnsetItemType()` + +UnsetItemType ensures that no value is present for ItemType, not even an explicit nil +### GetAutoApprovalMessageJSON + +`func (o *TemplateSlackAutoApprovalData) GetAutoApprovalMessageJSON() string` + +GetAutoApprovalMessageJSON returns the AutoApprovalMessageJSON field if non-nil, zero value otherwise. + +### GetAutoApprovalMessageJSONOk + +`func (o *TemplateSlackAutoApprovalData) GetAutoApprovalMessageJSONOk() (*string, bool)` + +GetAutoApprovalMessageJSONOk returns a tuple with the AutoApprovalMessageJSON field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoApprovalMessageJSON + +`func (o *TemplateSlackAutoApprovalData) SetAutoApprovalMessageJSON(v string)` + +SetAutoApprovalMessageJSON sets AutoApprovalMessageJSON field to given value. + +### HasAutoApprovalMessageJSON + +`func (o *TemplateSlackAutoApprovalData) HasAutoApprovalMessageJSON() bool` + +HasAutoApprovalMessageJSON returns a boolean if a field has been set. + +### SetAutoApprovalMessageJSONNil + +`func (o *TemplateSlackAutoApprovalData) SetAutoApprovalMessageJSONNil(b bool)` + + SetAutoApprovalMessageJSONNil sets the value for AutoApprovalMessageJSON to be an explicit nil + +### UnsetAutoApprovalMessageJSON +`func (o *TemplateSlackAutoApprovalData) UnsetAutoApprovalMessageJSON()` + +UnsetAutoApprovalMessageJSON ensures that no value is present for AutoApprovalMessageJSON, not even an explicit nil +### GetAutoApprovalTitle + +`func (o *TemplateSlackAutoApprovalData) GetAutoApprovalTitle() string` + +GetAutoApprovalTitle returns the AutoApprovalTitle field if non-nil, zero value otherwise. + +### GetAutoApprovalTitleOk + +`func (o *TemplateSlackAutoApprovalData) GetAutoApprovalTitleOk() (*string, bool)` + +GetAutoApprovalTitleOk returns a tuple with the AutoApprovalTitle field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoApprovalTitle + +`func (o *TemplateSlackAutoApprovalData) SetAutoApprovalTitle(v string)` + +SetAutoApprovalTitle sets AutoApprovalTitle field to given value. + +### HasAutoApprovalTitle + +`func (o *TemplateSlackAutoApprovalData) HasAutoApprovalTitle() bool` + +HasAutoApprovalTitle returns a boolean if a field has been set. + +### SetAutoApprovalTitleNil + +`func (o *TemplateSlackAutoApprovalData) SetAutoApprovalTitleNil(b bool)` + + SetAutoApprovalTitleNil sets the value for AutoApprovalTitle to be an explicit nil + +### UnsetAutoApprovalTitle +`func (o *TemplateSlackAutoApprovalData) UnsetAutoApprovalTitle()` + +UnsetAutoApprovalTitle ensures that no value is present for AutoApprovalTitle, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TemplateSlackCustomFields.md b/docs/tools/sdk/go/Reference/V2024/Models/TemplateSlackCustomFields.md new file mode 100644 index 000000000..cee266c59 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TemplateSlackCustomFields.md @@ -0,0 +1,182 @@ +--- +id: v2024-template-slack-custom-fields +title: TemplateSlackCustomFields +pagination_label: TemplateSlackCustomFields +sidebar_label: TemplateSlackCustomFields +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateSlackCustomFields', 'V2024TemplateSlackCustomFields'] +slug: /tools/sdk/go/v2024/models/template-slack-custom-fields +tags: ['SDK', 'Software Development Kit', 'TemplateSlackCustomFields', 'V2024TemplateSlackCustomFields'] +--- + +# TemplateSlackCustomFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestType** | Pointer to **NullableString** | | [optional] +**ContainsDeny** | Pointer to **NullableString** | | [optional] +**CampaignId** | Pointer to **NullableString** | | [optional] +**CampaignStatus** | Pointer to **NullableString** | | [optional] + +## Methods + +### NewTemplateSlackCustomFields + +`func NewTemplateSlackCustomFields() *TemplateSlackCustomFields` + +NewTemplateSlackCustomFields instantiates a new TemplateSlackCustomFields 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 + +### NewTemplateSlackCustomFieldsWithDefaults + +`func NewTemplateSlackCustomFieldsWithDefaults() *TemplateSlackCustomFields` + +NewTemplateSlackCustomFieldsWithDefaults instantiates a new TemplateSlackCustomFields 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 + +### GetRequestType + +`func (o *TemplateSlackCustomFields) GetRequestType() string` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *TemplateSlackCustomFields) GetRequestTypeOk() (*string, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *TemplateSlackCustomFields) SetRequestType(v string)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *TemplateSlackCustomFields) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *TemplateSlackCustomFields) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *TemplateSlackCustomFields) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetContainsDeny + +`func (o *TemplateSlackCustomFields) GetContainsDeny() string` + +GetContainsDeny returns the ContainsDeny field if non-nil, zero value otherwise. + +### GetContainsDenyOk + +`func (o *TemplateSlackCustomFields) GetContainsDenyOk() (*string, bool)` + +GetContainsDenyOk returns a tuple with the ContainsDeny field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainsDeny + +`func (o *TemplateSlackCustomFields) SetContainsDeny(v string)` + +SetContainsDeny sets ContainsDeny field to given value. + +### HasContainsDeny + +`func (o *TemplateSlackCustomFields) HasContainsDeny() bool` + +HasContainsDeny returns a boolean if a field has been set. + +### SetContainsDenyNil + +`func (o *TemplateSlackCustomFields) SetContainsDenyNil(b bool)` + + SetContainsDenyNil sets the value for ContainsDeny to be an explicit nil + +### UnsetContainsDeny +`func (o *TemplateSlackCustomFields) UnsetContainsDeny()` + +UnsetContainsDeny ensures that no value is present for ContainsDeny, not even an explicit nil +### GetCampaignId + +`func (o *TemplateSlackCustomFields) GetCampaignId() string` + +GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. + +### GetCampaignIdOk + +`func (o *TemplateSlackCustomFields) GetCampaignIdOk() (*string, bool)` + +GetCampaignIdOk returns a tuple with the CampaignId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignId + +`func (o *TemplateSlackCustomFields) SetCampaignId(v string)` + +SetCampaignId sets CampaignId field to given value. + +### HasCampaignId + +`func (o *TemplateSlackCustomFields) HasCampaignId() bool` + +HasCampaignId returns a boolean if a field has been set. + +### SetCampaignIdNil + +`func (o *TemplateSlackCustomFields) SetCampaignIdNil(b bool)` + + SetCampaignIdNil sets the value for CampaignId to be an explicit nil + +### UnsetCampaignId +`func (o *TemplateSlackCustomFields) UnsetCampaignId()` + +UnsetCampaignId ensures that no value is present for CampaignId, not even an explicit nil +### GetCampaignStatus + +`func (o *TemplateSlackCustomFields) GetCampaignStatus() string` + +GetCampaignStatus returns the CampaignStatus field if non-nil, zero value otherwise. + +### GetCampaignStatusOk + +`func (o *TemplateSlackCustomFields) GetCampaignStatusOk() (*string, bool)` + +GetCampaignStatusOk returns a tuple with the CampaignStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignStatus + +`func (o *TemplateSlackCustomFields) SetCampaignStatus(v string)` + +SetCampaignStatus sets CampaignStatus field to given value. + +### HasCampaignStatus + +`func (o *TemplateSlackCustomFields) HasCampaignStatus() bool` + +HasCampaignStatus returns a boolean if a field has been set. + +### SetCampaignStatusNil + +`func (o *TemplateSlackCustomFields) SetCampaignStatusNil(b bool)` + + SetCampaignStatusNil sets the value for CampaignStatus to be an explicit nil + +### UnsetCampaignStatus +`func (o *TemplateSlackCustomFields) UnsetCampaignStatus()` + +UnsetCampaignStatus ensures that no value is present for CampaignStatus, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TemplateTeams.md b/docs/tools/sdk/go/Reference/V2024/Models/TemplateTeams.md new file mode 100644 index 000000000..c351efd3a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TemplateTeams.md @@ -0,0 +1,424 @@ +--- +id: v2024-template-teams +title: TemplateTeams +pagination_label: TemplateTeams +sidebar_label: TemplateTeams +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateTeams', 'V2024TemplateTeams'] +slug: /tools/sdk/go/v2024/models/template-teams +tags: ['SDK', 'Software Development Kit', 'TemplateTeams', 'V2024TemplateTeams'] +--- + +# TemplateTeams + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **NullableString** | | [optional] +**Title** | Pointer to **NullableString** | | [optional] +**Text** | Pointer to **string** | | [optional] +**MessageJSON** | Pointer to **NullableString** | | [optional] +**IsSubscription** | Pointer to **NullableBool** | | [optional] +**ApprovalId** | Pointer to **NullableString** | | [optional] +**RequestId** | Pointer to **NullableString** | | [optional] +**RequestedById** | Pointer to **NullableString** | | [optional] +**NotificationType** | Pointer to **NullableString** | | [optional] +**AutoApprovalData** | Pointer to [**NullableTemplateSlackAutoApprovalData**](template-slack-auto-approval-data) | | [optional] +**CustomFields** | Pointer to [**NullableTemplateSlackCustomFields**](template-slack-custom-fields) | | [optional] + +## Methods + +### NewTemplateTeams + +`func NewTemplateTeams() *TemplateTeams` + +NewTemplateTeams instantiates a new TemplateTeams 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 + +### NewTemplateTeamsWithDefaults + +`func NewTemplateTeamsWithDefaults() *TemplateTeams` + +NewTemplateTeamsWithDefaults instantiates a new TemplateTeams 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 + +### GetKey + +`func (o *TemplateTeams) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TemplateTeams) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TemplateTeams) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *TemplateTeams) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *TemplateTeams) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *TemplateTeams) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetTitle + +`func (o *TemplateTeams) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *TemplateTeams) GetTitleOk() (*string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTitle + +`func (o *TemplateTeams) SetTitle(v string)` + +SetTitle sets Title field to given value. + +### HasTitle + +`func (o *TemplateTeams) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### SetTitleNil + +`func (o *TemplateTeams) SetTitleNil(b bool)` + + SetTitleNil sets the value for Title to be an explicit nil + +### UnsetTitle +`func (o *TemplateTeams) UnsetTitle()` + +UnsetTitle ensures that no value is present for Title, not even an explicit nil +### GetText + +`func (o *TemplateTeams) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *TemplateTeams) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *TemplateTeams) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *TemplateTeams) HasText() bool` + +HasText returns a boolean if a field has been set. + +### GetMessageJSON + +`func (o *TemplateTeams) GetMessageJSON() string` + +GetMessageJSON returns the MessageJSON field if non-nil, zero value otherwise. + +### GetMessageJSONOk + +`func (o *TemplateTeams) GetMessageJSONOk() (*string, bool)` + +GetMessageJSONOk returns a tuple with the MessageJSON field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessageJSON + +`func (o *TemplateTeams) SetMessageJSON(v string)` + +SetMessageJSON sets MessageJSON field to given value. + +### HasMessageJSON + +`func (o *TemplateTeams) HasMessageJSON() bool` + +HasMessageJSON returns a boolean if a field has been set. + +### SetMessageJSONNil + +`func (o *TemplateTeams) SetMessageJSONNil(b bool)` + + SetMessageJSONNil sets the value for MessageJSON to be an explicit nil + +### UnsetMessageJSON +`func (o *TemplateTeams) UnsetMessageJSON()` + +UnsetMessageJSON ensures that no value is present for MessageJSON, not even an explicit nil +### GetIsSubscription + +`func (o *TemplateTeams) GetIsSubscription() bool` + +GetIsSubscription returns the IsSubscription field if non-nil, zero value otherwise. + +### GetIsSubscriptionOk + +`func (o *TemplateTeams) GetIsSubscriptionOk() (*bool, bool)` + +GetIsSubscriptionOk returns a tuple with the IsSubscription field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSubscription + +`func (o *TemplateTeams) SetIsSubscription(v bool)` + +SetIsSubscription sets IsSubscription field to given value. + +### HasIsSubscription + +`func (o *TemplateTeams) HasIsSubscription() bool` + +HasIsSubscription returns a boolean if a field has been set. + +### SetIsSubscriptionNil + +`func (o *TemplateTeams) SetIsSubscriptionNil(b bool)` + + SetIsSubscriptionNil sets the value for IsSubscription to be an explicit nil + +### UnsetIsSubscription +`func (o *TemplateTeams) UnsetIsSubscription()` + +UnsetIsSubscription ensures that no value is present for IsSubscription, not even an explicit nil +### GetApprovalId + +`func (o *TemplateTeams) GetApprovalId() string` + +GetApprovalId returns the ApprovalId field if non-nil, zero value otherwise. + +### GetApprovalIdOk + +`func (o *TemplateTeams) GetApprovalIdOk() (*string, bool)` + +GetApprovalIdOk returns a tuple with the ApprovalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalId + +`func (o *TemplateTeams) SetApprovalId(v string)` + +SetApprovalId sets ApprovalId field to given value. + +### HasApprovalId + +`func (o *TemplateTeams) HasApprovalId() bool` + +HasApprovalId returns a boolean if a field has been set. + +### SetApprovalIdNil + +`func (o *TemplateTeams) SetApprovalIdNil(b bool)` + + SetApprovalIdNil sets the value for ApprovalId to be an explicit nil + +### UnsetApprovalId +`func (o *TemplateTeams) UnsetApprovalId()` + +UnsetApprovalId ensures that no value is present for ApprovalId, not even an explicit nil +### GetRequestId + +`func (o *TemplateTeams) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *TemplateTeams) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *TemplateTeams) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *TemplateTeams) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *TemplateTeams) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *TemplateTeams) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetRequestedById + +`func (o *TemplateTeams) GetRequestedById() string` + +GetRequestedById returns the RequestedById field if non-nil, zero value otherwise. + +### GetRequestedByIdOk + +`func (o *TemplateTeams) GetRequestedByIdOk() (*string, bool)` + +GetRequestedByIdOk returns a tuple with the RequestedById field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedById + +`func (o *TemplateTeams) SetRequestedById(v string)` + +SetRequestedById sets RequestedById field to given value. + +### HasRequestedById + +`func (o *TemplateTeams) HasRequestedById() bool` + +HasRequestedById returns a boolean if a field has been set. + +### SetRequestedByIdNil + +`func (o *TemplateTeams) SetRequestedByIdNil(b bool)` + + SetRequestedByIdNil sets the value for RequestedById to be an explicit nil + +### UnsetRequestedById +`func (o *TemplateTeams) UnsetRequestedById()` + +UnsetRequestedById ensures that no value is present for RequestedById, not even an explicit nil +### GetNotificationType + +`func (o *TemplateTeams) GetNotificationType() string` + +GetNotificationType returns the NotificationType field if non-nil, zero value otherwise. + +### GetNotificationTypeOk + +`func (o *TemplateTeams) GetNotificationTypeOk() (*string, bool)` + +GetNotificationTypeOk returns a tuple with the NotificationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotificationType + +`func (o *TemplateTeams) SetNotificationType(v string)` + +SetNotificationType sets NotificationType field to given value. + +### HasNotificationType + +`func (o *TemplateTeams) HasNotificationType() bool` + +HasNotificationType returns a boolean if a field has been set. + +### SetNotificationTypeNil + +`func (o *TemplateTeams) SetNotificationTypeNil(b bool)` + + SetNotificationTypeNil sets the value for NotificationType to be an explicit nil + +### UnsetNotificationType +`func (o *TemplateTeams) UnsetNotificationType()` + +UnsetNotificationType ensures that no value is present for NotificationType, not even an explicit nil +### GetAutoApprovalData + +`func (o *TemplateTeams) GetAutoApprovalData() TemplateSlackAutoApprovalData` + +GetAutoApprovalData returns the AutoApprovalData field if non-nil, zero value otherwise. + +### GetAutoApprovalDataOk + +`func (o *TemplateTeams) GetAutoApprovalDataOk() (*TemplateSlackAutoApprovalData, bool)` + +GetAutoApprovalDataOk returns a tuple with the AutoApprovalData field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoApprovalData + +`func (o *TemplateTeams) SetAutoApprovalData(v TemplateSlackAutoApprovalData)` + +SetAutoApprovalData sets AutoApprovalData field to given value. + +### HasAutoApprovalData + +`func (o *TemplateTeams) HasAutoApprovalData() bool` + +HasAutoApprovalData returns a boolean if a field has been set. + +### SetAutoApprovalDataNil + +`func (o *TemplateTeams) SetAutoApprovalDataNil(b bool)` + + SetAutoApprovalDataNil sets the value for AutoApprovalData to be an explicit nil + +### UnsetAutoApprovalData +`func (o *TemplateTeams) UnsetAutoApprovalData()` + +UnsetAutoApprovalData ensures that no value is present for AutoApprovalData, not even an explicit nil +### GetCustomFields + +`func (o *TemplateTeams) GetCustomFields() TemplateSlackCustomFields` + +GetCustomFields returns the CustomFields field if non-nil, zero value otherwise. + +### GetCustomFieldsOk + +`func (o *TemplateTeams) GetCustomFieldsOk() (*TemplateSlackCustomFields, bool)` + +GetCustomFieldsOk returns a tuple with the CustomFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomFields + +`func (o *TemplateTeams) SetCustomFields(v TemplateSlackCustomFields)` + +SetCustomFields sets CustomFields field to given value. + +### HasCustomFields + +`func (o *TemplateTeams) HasCustomFields() bool` + +HasCustomFields returns a boolean if a field has been set. + +### SetCustomFieldsNil + +`func (o *TemplateTeams) SetCustomFieldsNil(b bool)` + + SetCustomFieldsNil sets the value for CustomFields to be an explicit nil + +### UnsetCustomFields +`func (o *TemplateTeams) UnsetCustomFields()` + +UnsetCustomFields ensures that no value is present for CustomFields, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Tenant.md b/docs/tools/sdk/go/Reference/V2024/Models/Tenant.md new file mode 100644 index 000000000..d3f711a81 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Tenant.md @@ -0,0 +1,220 @@ +--- +id: v2024-tenant +title: Tenant +pagination_label: Tenant +sidebar_label: Tenant +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Tenant', 'V2024Tenant'] +slug: /tools/sdk/go/v2024/models/tenant +tags: ['SDK', 'Software Development Kit', 'Tenant', 'V2024Tenant'] +--- + +# Tenant + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique identifier for the Tenant | [optional] [readonly] +**Name** | Pointer to **string** | Abbreviated name of the Tenant | [optional] +**FullName** | Pointer to **string** | Human-readable name of the Tenant | [optional] +**Pod** | Pointer to **string** | Deployment pod for the Tenant | [optional] +**Region** | Pointer to **string** | Deployment region for the Tenant | [optional] +**Description** | Pointer to **string** | Description of the Tenant | [optional] +**Products** | Pointer to [**[]Product**](product) | | [optional] + +## Methods + +### NewTenant + +`func NewTenant() *Tenant` + +NewTenant instantiates a new Tenant 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 + +### NewTenantWithDefaults + +`func NewTenantWithDefaults() *Tenant` + +NewTenantWithDefaults instantiates a new Tenant 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 + +### GetId + +`func (o *Tenant) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Tenant) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Tenant) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Tenant) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Tenant) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Tenant) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Tenant) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Tenant) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetFullName + +`func (o *Tenant) GetFullName() string` + +GetFullName returns the FullName field if non-nil, zero value otherwise. + +### GetFullNameOk + +`func (o *Tenant) GetFullNameOk() (*string, bool)` + +GetFullNameOk returns a tuple with the FullName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFullName + +`func (o *Tenant) SetFullName(v string)` + +SetFullName sets FullName field to given value. + +### HasFullName + +`func (o *Tenant) HasFullName() bool` + +HasFullName returns a boolean if a field has been set. + +### GetPod + +`func (o *Tenant) GetPod() string` + +GetPod returns the Pod field if non-nil, zero value otherwise. + +### GetPodOk + +`func (o *Tenant) GetPodOk() (*string, bool)` + +GetPodOk returns a tuple with the Pod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPod + +`func (o *Tenant) SetPod(v string)` + +SetPod sets Pod field to given value. + +### HasPod + +`func (o *Tenant) HasPod() bool` + +HasPod returns a boolean if a field has been set. + +### GetRegion + +`func (o *Tenant) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *Tenant) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *Tenant) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *Tenant) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetDescription + +`func (o *Tenant) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Tenant) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Tenant) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Tenant) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetProducts + +`func (o *Tenant) GetProducts() []Product` + +GetProducts returns the Products field if non-nil, zero value otherwise. + +### GetProductsOk + +`func (o *Tenant) GetProductsOk() (*[]Product, bool)` + +GetProductsOk returns a tuple with the Products field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProducts + +`func (o *Tenant) SetProducts(v []Product)` + +SetProducts sets Products field to given value. + +### HasProducts + +`func (o *Tenant) HasProducts() bool` + +HasProducts returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TenantConfigurationDetails.md b/docs/tools/sdk/go/Reference/V2024/Models/TenantConfigurationDetails.md new file mode 100644 index 000000000..c8bc53738 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TenantConfigurationDetails.md @@ -0,0 +1,74 @@ +--- +id: v2024-tenant-configuration-details +title: TenantConfigurationDetails +pagination_label: TenantConfigurationDetails +sidebar_label: TenantConfigurationDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantConfigurationDetails', 'V2024TenantConfigurationDetails'] +slug: /tools/sdk/go/v2024/models/tenant-configuration-details +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationDetails', 'V2024TenantConfigurationDetails'] +--- + +# TenantConfigurationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Disabled** | Pointer to **NullableBool** | Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled. | [optional] [default to false] + +## Methods + +### NewTenantConfigurationDetails + +`func NewTenantConfigurationDetails() *TenantConfigurationDetails` + +NewTenantConfigurationDetails instantiates a new TenantConfigurationDetails 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 + +### NewTenantConfigurationDetailsWithDefaults + +`func NewTenantConfigurationDetailsWithDefaults() *TenantConfigurationDetails` + +NewTenantConfigurationDetailsWithDefaults instantiates a new TenantConfigurationDetails 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 + +### GetDisabled + +`func (o *TenantConfigurationDetails) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *TenantConfigurationDetails) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *TenantConfigurationDetails) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *TenantConfigurationDetails) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### SetDisabledNil + +`func (o *TenantConfigurationDetails) SetDisabledNil(b bool)` + + SetDisabledNil sets the value for Disabled to be an explicit nil + +### UnsetDisabled +`func (o *TenantConfigurationDetails) UnsetDisabled()` + +UnsetDisabled ensures that no value is present for Disabled, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TenantConfigurationRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/TenantConfigurationRequest.md new file mode 100644 index 000000000..6d8f1c472 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TenantConfigurationRequest.md @@ -0,0 +1,64 @@ +--- +id: v2024-tenant-configuration-request +title: TenantConfigurationRequest +pagination_label: TenantConfigurationRequest +sidebar_label: TenantConfigurationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantConfigurationRequest', 'V2024TenantConfigurationRequest'] +slug: /tools/sdk/go/v2024/models/tenant-configuration-request +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationRequest', 'V2024TenantConfigurationRequest'] +--- + +# TenantConfigurationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConfigDetails** | Pointer to [**TenantConfigurationDetails**](tenant-configuration-details) | | [optional] + +## Methods + +### NewTenantConfigurationRequest + +`func NewTenantConfigurationRequest() *TenantConfigurationRequest` + +NewTenantConfigurationRequest instantiates a new TenantConfigurationRequest 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 + +### NewTenantConfigurationRequestWithDefaults + +`func NewTenantConfigurationRequestWithDefaults() *TenantConfigurationRequest` + +NewTenantConfigurationRequestWithDefaults instantiates a new TenantConfigurationRequest 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 + +### GetConfigDetails + +`func (o *TenantConfigurationRequest) GetConfigDetails() TenantConfigurationDetails` + +GetConfigDetails returns the ConfigDetails field if non-nil, zero value otherwise. + +### GetConfigDetailsOk + +`func (o *TenantConfigurationRequest) GetConfigDetailsOk() (*TenantConfigurationDetails, bool)` + +GetConfigDetailsOk returns a tuple with the ConfigDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigDetails + +`func (o *TenantConfigurationRequest) SetConfigDetails(v TenantConfigurationDetails)` + +SetConfigDetails sets ConfigDetails field to given value. + +### HasConfigDetails + +`func (o *TenantConfigurationRequest) HasConfigDetails() bool` + +HasConfigDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TenantConfigurationResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/TenantConfigurationResponse.md new file mode 100644 index 000000000..97a6c01ab --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TenantConfigurationResponse.md @@ -0,0 +1,90 @@ +--- +id: v2024-tenant-configuration-response +title: TenantConfigurationResponse +pagination_label: TenantConfigurationResponse +sidebar_label: TenantConfigurationResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantConfigurationResponse', 'V2024TenantConfigurationResponse'] +slug: /tools/sdk/go/v2024/models/tenant-configuration-response +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationResponse', 'V2024TenantConfigurationResponse'] +--- + +# TenantConfigurationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuditDetails** | Pointer to [**AuditDetails**](audit-details) | | [optional] +**ConfigDetails** | Pointer to [**TenantConfigurationDetails**](tenant-configuration-details) | | [optional] + +## Methods + +### NewTenantConfigurationResponse + +`func NewTenantConfigurationResponse() *TenantConfigurationResponse` + +NewTenantConfigurationResponse instantiates a new TenantConfigurationResponse 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 + +### NewTenantConfigurationResponseWithDefaults + +`func NewTenantConfigurationResponseWithDefaults() *TenantConfigurationResponse` + +NewTenantConfigurationResponseWithDefaults instantiates a new TenantConfigurationResponse 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 + +### GetAuditDetails + +`func (o *TenantConfigurationResponse) GetAuditDetails() AuditDetails` + +GetAuditDetails returns the AuditDetails field if non-nil, zero value otherwise. + +### GetAuditDetailsOk + +`func (o *TenantConfigurationResponse) GetAuditDetailsOk() (*AuditDetails, bool)` + +GetAuditDetailsOk returns a tuple with the AuditDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuditDetails + +`func (o *TenantConfigurationResponse) SetAuditDetails(v AuditDetails)` + +SetAuditDetails sets AuditDetails field to given value. + +### HasAuditDetails + +`func (o *TenantConfigurationResponse) HasAuditDetails() bool` + +HasAuditDetails returns a boolean if a field has been set. + +### GetConfigDetails + +`func (o *TenantConfigurationResponse) GetConfigDetails() TenantConfigurationDetails` + +GetConfigDetails returns the ConfigDetails field if non-nil, zero value otherwise. + +### GetConfigDetailsOk + +`func (o *TenantConfigurationResponse) GetConfigDetailsOk() (*TenantConfigurationDetails, bool)` + +GetConfigDetailsOk returns a tuple with the ConfigDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigDetails + +`func (o *TenantConfigurationResponse) SetConfigDetails(v TenantConfigurationDetails)` + +SetConfigDetails sets ConfigDetails field to given value. + +### HasConfigDetails + +`func (o *TenantConfigurationResponse) HasConfigDetails() bool` + +HasConfigDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TenantUiMetadataItemResponse.md b/docs/tools/sdk/go/Reference/V2024/Models/TenantUiMetadataItemResponse.md new file mode 100644 index 000000000..a70ef0378 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TenantUiMetadataItemResponse.md @@ -0,0 +1,146 @@ +--- +id: v2024-tenant-ui-metadata-item-response +title: TenantUiMetadataItemResponse +pagination_label: TenantUiMetadataItemResponse +sidebar_label: TenantUiMetadataItemResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantUiMetadataItemResponse', 'V2024TenantUiMetadataItemResponse'] +slug: /tools/sdk/go/v2024/models/tenant-ui-metadata-item-response +tags: ['SDK', 'Software Development Kit', 'TenantUiMetadataItemResponse', 'V2024TenantUiMetadataItemResponse'] +--- + +# TenantUiMetadataItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IframeWhiteList** | Pointer to **NullableString** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [optional] +**UsernameLabel** | Pointer to **NullableString** | Descriptor for the username input field. If you would like to reset the value use \"null\". | [optional] +**UsernameEmptyText** | Pointer to **NullableString** | Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". | [optional] + +## Methods + +### NewTenantUiMetadataItemResponse + +`func NewTenantUiMetadataItemResponse() *TenantUiMetadataItemResponse` + +NewTenantUiMetadataItemResponse instantiates a new TenantUiMetadataItemResponse 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 + +### NewTenantUiMetadataItemResponseWithDefaults + +`func NewTenantUiMetadataItemResponseWithDefaults() *TenantUiMetadataItemResponse` + +NewTenantUiMetadataItemResponseWithDefaults instantiates a new TenantUiMetadataItemResponse 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 + +### GetIframeWhiteList + +`func (o *TenantUiMetadataItemResponse) GetIframeWhiteList() string` + +GetIframeWhiteList returns the IframeWhiteList field if non-nil, zero value otherwise. + +### GetIframeWhiteListOk + +`func (o *TenantUiMetadataItemResponse) GetIframeWhiteListOk() (*string, bool)` + +GetIframeWhiteListOk returns a tuple with the IframeWhiteList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIframeWhiteList + +`func (o *TenantUiMetadataItemResponse) SetIframeWhiteList(v string)` + +SetIframeWhiteList sets IframeWhiteList field to given value. + +### HasIframeWhiteList + +`func (o *TenantUiMetadataItemResponse) HasIframeWhiteList() bool` + +HasIframeWhiteList returns a boolean if a field has been set. + +### SetIframeWhiteListNil + +`func (o *TenantUiMetadataItemResponse) SetIframeWhiteListNil(b bool)` + + SetIframeWhiteListNil sets the value for IframeWhiteList to be an explicit nil + +### UnsetIframeWhiteList +`func (o *TenantUiMetadataItemResponse) UnsetIframeWhiteList()` + +UnsetIframeWhiteList ensures that no value is present for IframeWhiteList, not even an explicit nil +### GetUsernameLabel + +`func (o *TenantUiMetadataItemResponse) GetUsernameLabel() string` + +GetUsernameLabel returns the UsernameLabel field if non-nil, zero value otherwise. + +### GetUsernameLabelOk + +`func (o *TenantUiMetadataItemResponse) GetUsernameLabelOk() (*string, bool)` + +GetUsernameLabelOk returns a tuple with the UsernameLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsernameLabel + +`func (o *TenantUiMetadataItemResponse) SetUsernameLabel(v string)` + +SetUsernameLabel sets UsernameLabel field to given value. + +### HasUsernameLabel + +`func (o *TenantUiMetadataItemResponse) HasUsernameLabel() bool` + +HasUsernameLabel returns a boolean if a field has been set. + +### SetUsernameLabelNil + +`func (o *TenantUiMetadataItemResponse) SetUsernameLabelNil(b bool)` + + SetUsernameLabelNil sets the value for UsernameLabel to be an explicit nil + +### UnsetUsernameLabel +`func (o *TenantUiMetadataItemResponse) UnsetUsernameLabel()` + +UnsetUsernameLabel ensures that no value is present for UsernameLabel, not even an explicit nil +### GetUsernameEmptyText + +`func (o *TenantUiMetadataItemResponse) GetUsernameEmptyText() string` + +GetUsernameEmptyText returns the UsernameEmptyText field if non-nil, zero value otherwise. + +### GetUsernameEmptyTextOk + +`func (o *TenantUiMetadataItemResponse) GetUsernameEmptyTextOk() (*string, bool)` + +GetUsernameEmptyTextOk returns a tuple with the UsernameEmptyText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsernameEmptyText + +`func (o *TenantUiMetadataItemResponse) SetUsernameEmptyText(v string)` + +SetUsernameEmptyText sets UsernameEmptyText field to given value. + +### HasUsernameEmptyText + +`func (o *TenantUiMetadataItemResponse) HasUsernameEmptyText() bool` + +HasUsernameEmptyText returns a boolean if a field has been set. + +### SetUsernameEmptyTextNil + +`func (o *TenantUiMetadataItemResponse) SetUsernameEmptyTextNil(b bool)` + + SetUsernameEmptyTextNil sets the value for UsernameEmptyText to be an explicit nil + +### UnsetUsernameEmptyText +`func (o *TenantUiMetadataItemResponse) UnsetUsernameEmptyText()` + +UnsetUsernameEmptyText ensures that no value is present for UsernameEmptyText, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TenantUiMetadataItemUpdateRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/TenantUiMetadataItemUpdateRequest.md new file mode 100644 index 000000000..04550485e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TenantUiMetadataItemUpdateRequest.md @@ -0,0 +1,146 @@ +--- +id: v2024-tenant-ui-metadata-item-update-request +title: TenantUiMetadataItemUpdateRequest +pagination_label: TenantUiMetadataItemUpdateRequest +sidebar_label: TenantUiMetadataItemUpdateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantUiMetadataItemUpdateRequest', 'V2024TenantUiMetadataItemUpdateRequest'] +slug: /tools/sdk/go/v2024/models/tenant-ui-metadata-item-update-request +tags: ['SDK', 'Software Development Kit', 'TenantUiMetadataItemUpdateRequest', 'V2024TenantUiMetadataItemUpdateRequest'] +--- + +# TenantUiMetadataItemUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IframeWhiteList** | Pointer to **NullableString** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [optional] +**UsernameLabel** | Pointer to **NullableString** | Descriptor for the username input field. If you would like to reset the value use \"null\". | [optional] +**UsernameEmptyText** | Pointer to **NullableString** | Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". | [optional] + +## Methods + +### NewTenantUiMetadataItemUpdateRequest + +`func NewTenantUiMetadataItemUpdateRequest() *TenantUiMetadataItemUpdateRequest` + +NewTenantUiMetadataItemUpdateRequest instantiates a new TenantUiMetadataItemUpdateRequest 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 + +### NewTenantUiMetadataItemUpdateRequestWithDefaults + +`func NewTenantUiMetadataItemUpdateRequestWithDefaults() *TenantUiMetadataItemUpdateRequest` + +NewTenantUiMetadataItemUpdateRequestWithDefaults instantiates a new TenantUiMetadataItemUpdateRequest 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 + +### GetIframeWhiteList + +`func (o *TenantUiMetadataItemUpdateRequest) GetIframeWhiteList() string` + +GetIframeWhiteList returns the IframeWhiteList field if non-nil, zero value otherwise. + +### GetIframeWhiteListOk + +`func (o *TenantUiMetadataItemUpdateRequest) GetIframeWhiteListOk() (*string, bool)` + +GetIframeWhiteListOk returns a tuple with the IframeWhiteList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIframeWhiteList + +`func (o *TenantUiMetadataItemUpdateRequest) SetIframeWhiteList(v string)` + +SetIframeWhiteList sets IframeWhiteList field to given value. + +### HasIframeWhiteList + +`func (o *TenantUiMetadataItemUpdateRequest) HasIframeWhiteList() bool` + +HasIframeWhiteList returns a boolean if a field has been set. + +### SetIframeWhiteListNil + +`func (o *TenantUiMetadataItemUpdateRequest) SetIframeWhiteListNil(b bool)` + + SetIframeWhiteListNil sets the value for IframeWhiteList to be an explicit nil + +### UnsetIframeWhiteList +`func (o *TenantUiMetadataItemUpdateRequest) UnsetIframeWhiteList()` + +UnsetIframeWhiteList ensures that no value is present for IframeWhiteList, not even an explicit nil +### GetUsernameLabel + +`func (o *TenantUiMetadataItemUpdateRequest) GetUsernameLabel() string` + +GetUsernameLabel returns the UsernameLabel field if non-nil, zero value otherwise. + +### GetUsernameLabelOk + +`func (o *TenantUiMetadataItemUpdateRequest) GetUsernameLabelOk() (*string, bool)` + +GetUsernameLabelOk returns a tuple with the UsernameLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsernameLabel + +`func (o *TenantUiMetadataItemUpdateRequest) SetUsernameLabel(v string)` + +SetUsernameLabel sets UsernameLabel field to given value. + +### HasUsernameLabel + +`func (o *TenantUiMetadataItemUpdateRequest) HasUsernameLabel() bool` + +HasUsernameLabel returns a boolean if a field has been set. + +### SetUsernameLabelNil + +`func (o *TenantUiMetadataItemUpdateRequest) SetUsernameLabelNil(b bool)` + + SetUsernameLabelNil sets the value for UsernameLabel to be an explicit nil + +### UnsetUsernameLabel +`func (o *TenantUiMetadataItemUpdateRequest) UnsetUsernameLabel()` + +UnsetUsernameLabel ensures that no value is present for UsernameLabel, not even an explicit nil +### GetUsernameEmptyText + +`func (o *TenantUiMetadataItemUpdateRequest) GetUsernameEmptyText() string` + +GetUsernameEmptyText returns the UsernameEmptyText field if non-nil, zero value otherwise. + +### GetUsernameEmptyTextOk + +`func (o *TenantUiMetadataItemUpdateRequest) GetUsernameEmptyTextOk() (*string, bool)` + +GetUsernameEmptyTextOk returns a tuple with the UsernameEmptyText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsernameEmptyText + +`func (o *TenantUiMetadataItemUpdateRequest) SetUsernameEmptyText(v string)` + +SetUsernameEmptyText sets UsernameEmptyText field to given value. + +### HasUsernameEmptyText + +`func (o *TenantUiMetadataItemUpdateRequest) HasUsernameEmptyText() bool` + +HasUsernameEmptyText returns a boolean if a field has been set. + +### SetUsernameEmptyTextNil + +`func (o *TenantUiMetadataItemUpdateRequest) SetUsernameEmptyTextNil(b bool)` + + SetUsernameEmptyTextNil sets the value for UsernameEmptyText to be an explicit nil + +### UnsetUsernameEmptyText +`func (o *TenantUiMetadataItemUpdateRequest) UnsetUsernameEmptyText()` + +UnsetUsernameEmptyText ensures that no value is present for UsernameEmptyText, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TestExternalExecuteWorkflow200Response.md b/docs/tools/sdk/go/Reference/V2024/Models/TestExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..51ac95548 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TestExternalExecuteWorkflow200Response.md @@ -0,0 +1,64 @@ +--- +id: v2024-test-external-execute-workflow200-response +title: TestExternalExecuteWorkflow200Response +pagination_label: TestExternalExecuteWorkflow200Response +sidebar_label: TestExternalExecuteWorkflow200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestExternalExecuteWorkflow200Response', 'V2024TestExternalExecuteWorkflow200Response'] +slug: /tools/sdk/go/v2024/models/test-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflow200Response', 'V2024TestExternalExecuteWorkflow200Response'] +--- + +# TestExternalExecuteWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Payload** | Pointer to **map[string]interface{}** | The input that was received | [optional] + +## Methods + +### NewTestExternalExecuteWorkflow200Response + +`func NewTestExternalExecuteWorkflow200Response() *TestExternalExecuteWorkflow200Response` + +NewTestExternalExecuteWorkflow200Response instantiates a new TestExternalExecuteWorkflow200Response 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 + +### NewTestExternalExecuteWorkflow200ResponseWithDefaults + +`func NewTestExternalExecuteWorkflow200ResponseWithDefaults() *TestExternalExecuteWorkflow200Response` + +NewTestExternalExecuteWorkflow200ResponseWithDefaults instantiates a new TestExternalExecuteWorkflow200Response 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 + +### GetPayload + +`func (o *TestExternalExecuteWorkflow200Response) GetPayload() map[string]interface{}` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *TestExternalExecuteWorkflow200Response) GetPayloadOk() (*map[string]interface{}, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPayload + +`func (o *TestExternalExecuteWorkflow200Response) SetPayload(v map[string]interface{})` + +SetPayload sets Payload field to given value. + +### HasPayload + +`func (o *TestExternalExecuteWorkflow200Response) HasPayload() bool` + +HasPayload returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TestExternalExecuteWorkflowRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/TestExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..818bcba78 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TestExternalExecuteWorkflowRequest.md @@ -0,0 +1,64 @@ +--- +id: v2024-test-external-execute-workflow-request +title: TestExternalExecuteWorkflowRequest +pagination_label: TestExternalExecuteWorkflowRequest +sidebar_label: TestExternalExecuteWorkflowRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestExternalExecuteWorkflowRequest', 'V2024TestExternalExecuteWorkflowRequest'] +slug: /tools/sdk/go/v2024/models/test-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflowRequest', 'V2024TestExternalExecuteWorkflowRequest'] +--- + +# TestExternalExecuteWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | Pointer to **map[string]interface{}** | The test input for the workflow | [optional] + +## Methods + +### NewTestExternalExecuteWorkflowRequest + +`func NewTestExternalExecuteWorkflowRequest() *TestExternalExecuteWorkflowRequest` + +NewTestExternalExecuteWorkflowRequest instantiates a new TestExternalExecuteWorkflowRequest 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 + +### NewTestExternalExecuteWorkflowRequestWithDefaults + +`func NewTestExternalExecuteWorkflowRequestWithDefaults() *TestExternalExecuteWorkflowRequest` + +NewTestExternalExecuteWorkflowRequestWithDefaults instantiates a new TestExternalExecuteWorkflowRequest 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 + +### GetInput + +`func (o *TestExternalExecuteWorkflowRequest) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *TestExternalExecuteWorkflowRequest) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *TestExternalExecuteWorkflowRequest) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + +### HasInput + +`func (o *TestExternalExecuteWorkflowRequest) HasInput() bool` + +HasInput returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TestInvocation.md b/docs/tools/sdk/go/Reference/V2024/Models/TestInvocation.md new file mode 100644 index 000000000..a32bb9b86 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TestInvocation.md @@ -0,0 +1,132 @@ +--- +id: v2024-test-invocation +title: TestInvocation +pagination_label: TestInvocation +sidebar_label: TestInvocation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestInvocation', 'V2024TestInvocation'] +slug: /tools/sdk/go/v2024/models/test-invocation +tags: ['SDK', 'Software Development Kit', 'TestInvocation', 'V2024TestInvocation'] +--- + +# TestInvocation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TriggerId** | **string** | Trigger ID | +**Input** | Pointer to **map[string]interface{}** | Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent. | [optional] +**ContentJson** | **map[string]interface{}** | JSON map of invocation metadata. | +**SubscriptionIds** | Pointer to **[]string** | Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers. | [optional] + +## Methods + +### NewTestInvocation + +`func NewTestInvocation(triggerId string, contentJson map[string]interface{}, ) *TestInvocation` + +NewTestInvocation instantiates a new TestInvocation 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 + +### NewTestInvocationWithDefaults + +`func NewTestInvocationWithDefaults() *TestInvocation` + +NewTestInvocationWithDefaults instantiates a new TestInvocation 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 + +### GetTriggerId + +`func (o *TestInvocation) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *TestInvocation) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *TestInvocation) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + + +### GetInput + +`func (o *TestInvocation) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *TestInvocation) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *TestInvocation) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + +### HasInput + +`func (o *TestInvocation) HasInput() bool` + +HasInput returns a boolean if a field has been set. + +### GetContentJson + +`func (o *TestInvocation) GetContentJson() map[string]interface{}` + +GetContentJson returns the ContentJson field if non-nil, zero value otherwise. + +### GetContentJsonOk + +`func (o *TestInvocation) GetContentJsonOk() (*map[string]interface{}, bool)` + +GetContentJsonOk returns a tuple with the ContentJson field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContentJson + +`func (o *TestInvocation) SetContentJson(v map[string]interface{})` + +SetContentJson sets ContentJson field to given value. + + +### GetSubscriptionIds + +`func (o *TestInvocation) GetSubscriptionIds() []string` + +GetSubscriptionIds returns the SubscriptionIds field if non-nil, zero value otherwise. + +### GetSubscriptionIdsOk + +`func (o *TestInvocation) GetSubscriptionIdsOk() (*[]string, bool)` + +GetSubscriptionIdsOk returns a tuple with the SubscriptionIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubscriptionIds + +`func (o *TestInvocation) SetSubscriptionIds(v []string)` + +SetSubscriptionIds sets SubscriptionIds field to given value. + +### HasSubscriptionIds + +`func (o *TestInvocation) HasSubscriptionIds() bool` + +HasSubscriptionIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TestSourceConnectionMultihost200Response.md b/docs/tools/sdk/go/Reference/V2024/Models/TestSourceConnectionMultihost200Response.md new file mode 100644 index 000000000..6f8910d1a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TestSourceConnectionMultihost200Response.md @@ -0,0 +1,168 @@ +--- +id: v2024-test-source-connection-multihost200-response +title: TestSourceConnectionMultihost200Response +pagination_label: TestSourceConnectionMultihost200Response +sidebar_label: TestSourceConnectionMultihost200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestSourceConnectionMultihost200Response', 'V2024TestSourceConnectionMultihost200Response'] +slug: /tools/sdk/go/v2024/models/test-source-connection-multihost200-response +tags: ['SDK', 'Software Development Kit', 'TestSourceConnectionMultihost200Response', 'V2024TestSourceConnectionMultihost200Response'] +--- + +# TestSourceConnectionMultihost200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Success** | Pointer to **bool** | Source's test connection status. | [optional] +**Message** | Pointer to **string** | Source's test connection message. | [optional] +**Timing** | Pointer to **int32** | Source's test connection timing. | [optional] +**ResultType** | Pointer to **map[string]interface{}** | Source's human-readable result type. | [optional] +**TestConnectionDetails** | Pointer to **string** | Source's human-readable test connection details. | [optional] + +## Methods + +### NewTestSourceConnectionMultihost200Response + +`func NewTestSourceConnectionMultihost200Response() *TestSourceConnectionMultihost200Response` + +NewTestSourceConnectionMultihost200Response instantiates a new TestSourceConnectionMultihost200Response 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 + +### NewTestSourceConnectionMultihost200ResponseWithDefaults + +`func NewTestSourceConnectionMultihost200ResponseWithDefaults() *TestSourceConnectionMultihost200Response` + +NewTestSourceConnectionMultihost200ResponseWithDefaults instantiates a new TestSourceConnectionMultihost200Response 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 + +### GetSuccess + +`func (o *TestSourceConnectionMultihost200Response) GetSuccess() bool` + +GetSuccess returns the Success field if non-nil, zero value otherwise. + +### GetSuccessOk + +`func (o *TestSourceConnectionMultihost200Response) GetSuccessOk() (*bool, bool)` + +GetSuccessOk returns a tuple with the Success field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSuccess + +`func (o *TestSourceConnectionMultihost200Response) SetSuccess(v bool)` + +SetSuccess sets Success field to given value. + +### HasSuccess + +`func (o *TestSourceConnectionMultihost200Response) HasSuccess() bool` + +HasSuccess returns a boolean if a field has been set. + +### GetMessage + +`func (o *TestSourceConnectionMultihost200Response) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *TestSourceConnectionMultihost200Response) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *TestSourceConnectionMultihost200Response) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *TestSourceConnectionMultihost200Response) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetTiming + +`func (o *TestSourceConnectionMultihost200Response) GetTiming() int32` + +GetTiming returns the Timing field if non-nil, zero value otherwise. + +### GetTimingOk + +`func (o *TestSourceConnectionMultihost200Response) GetTimingOk() (*int32, bool)` + +GetTimingOk returns a tuple with the Timing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTiming + +`func (o *TestSourceConnectionMultihost200Response) SetTiming(v int32)` + +SetTiming sets Timing field to given value. + +### HasTiming + +`func (o *TestSourceConnectionMultihost200Response) HasTiming() bool` + +HasTiming returns a boolean if a field has been set. + +### GetResultType + +`func (o *TestSourceConnectionMultihost200Response) GetResultType() map[string]interface{}` + +GetResultType returns the ResultType field if non-nil, zero value otherwise. + +### GetResultTypeOk + +`func (o *TestSourceConnectionMultihost200Response) GetResultTypeOk() (*map[string]interface{}, bool)` + +GetResultTypeOk returns a tuple with the ResultType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultType + +`func (o *TestSourceConnectionMultihost200Response) SetResultType(v map[string]interface{})` + +SetResultType sets ResultType field to given value. + +### HasResultType + +`func (o *TestSourceConnectionMultihost200Response) HasResultType() bool` + +HasResultType returns a boolean if a field has been set. + +### GetTestConnectionDetails + +`func (o *TestSourceConnectionMultihost200Response) GetTestConnectionDetails() string` + +GetTestConnectionDetails returns the TestConnectionDetails field if non-nil, zero value otherwise. + +### GetTestConnectionDetailsOk + +`func (o *TestSourceConnectionMultihost200Response) GetTestConnectionDetailsOk() (*string, bool)` + +GetTestConnectionDetailsOk returns a tuple with the TestConnectionDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTestConnectionDetails + +`func (o *TestSourceConnectionMultihost200Response) SetTestConnectionDetails(v string)` + +SetTestConnectionDetails sets TestConnectionDetails field to given value. + +### HasTestConnectionDetails + +`func (o *TestSourceConnectionMultihost200Response) HasTestConnectionDetails() bool` + +HasTestConnectionDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TestWorkflow200Response.md b/docs/tools/sdk/go/Reference/V2024/Models/TestWorkflow200Response.md new file mode 100644 index 000000000..9bc33f450 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TestWorkflow200Response.md @@ -0,0 +1,64 @@ +--- +id: v2024-test-workflow200-response +title: TestWorkflow200Response +pagination_label: TestWorkflow200Response +sidebar_label: TestWorkflow200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestWorkflow200Response', 'V2024TestWorkflow200Response'] +slug: /tools/sdk/go/v2024/models/test-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestWorkflow200Response', 'V2024TestWorkflow200Response'] +--- + +# TestWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**WorkflowExecutionId** | Pointer to **string** | The workflow execution id | [optional] + +## Methods + +### NewTestWorkflow200Response + +`func NewTestWorkflow200Response() *TestWorkflow200Response` + +NewTestWorkflow200Response instantiates a new TestWorkflow200Response 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 + +### NewTestWorkflow200ResponseWithDefaults + +`func NewTestWorkflow200ResponseWithDefaults() *TestWorkflow200Response` + +NewTestWorkflow200ResponseWithDefaults instantiates a new TestWorkflow200Response 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 + +### GetWorkflowExecutionId + +`func (o *TestWorkflow200Response) GetWorkflowExecutionId() string` + +GetWorkflowExecutionId returns the WorkflowExecutionId field if non-nil, zero value otherwise. + +### GetWorkflowExecutionIdOk + +`func (o *TestWorkflow200Response) GetWorkflowExecutionIdOk() (*string, bool)` + +GetWorkflowExecutionIdOk returns a tuple with the WorkflowExecutionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWorkflowExecutionId + +`func (o *TestWorkflow200Response) SetWorkflowExecutionId(v string)` + +SetWorkflowExecutionId sets WorkflowExecutionId field to given value. + +### HasWorkflowExecutionId + +`func (o *TestWorkflow200Response) HasWorkflowExecutionId() bool` + +HasWorkflowExecutionId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TestWorkflowRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/TestWorkflowRequest.md new file mode 100644 index 000000000..609cf6079 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TestWorkflowRequest.md @@ -0,0 +1,59 @@ +--- +id: v2024-test-workflow-request +title: TestWorkflowRequest +pagination_label: TestWorkflowRequest +sidebar_label: TestWorkflowRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestWorkflowRequest', 'V2024TestWorkflowRequest'] +slug: /tools/sdk/go/v2024/models/test-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestWorkflowRequest', 'V2024TestWorkflowRequest'] +--- + +# TestWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | **map[string]interface{}** | The test input for the workflow. | + +## Methods + +### NewTestWorkflowRequest + +`func NewTestWorkflowRequest(input map[string]interface{}, ) *TestWorkflowRequest` + +NewTestWorkflowRequest instantiates a new TestWorkflowRequest 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 + +### NewTestWorkflowRequestWithDefaults + +`func NewTestWorkflowRequestWithDefaults() *TestWorkflowRequest` + +NewTestWorkflowRequestWithDefaults instantiates a new TestWorkflowRequest 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 + +### GetInput + +`func (o *TestWorkflowRequest) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *TestWorkflowRequest) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *TestWorkflowRequest) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TextQuery.md b/docs/tools/sdk/go/Reference/V2024/Models/TextQuery.md new file mode 100644 index 000000000..f752a4316 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TextQuery.md @@ -0,0 +1,132 @@ +--- +id: v2024-text-query +title: TextQuery +pagination_label: TextQuery +sidebar_label: TextQuery +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TextQuery', 'V2024TextQuery'] +slug: /tools/sdk/go/v2024/models/text-query +tags: ['SDK', 'Software Development Kit', 'TextQuery', 'V2024TextQuery'] +--- + +# TextQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Terms** | **[]string** | Words or characters that specify a particular thing to be searched for. | +**Fields** | **[]string** | The fields to be searched. | +**MatchAny** | Pointer to **bool** | Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. | [optional] [default to false] +**Contains** | Pointer to **bool** | Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. | [optional] [default to false] + +## Methods + +### NewTextQuery + +`func NewTextQuery(terms []string, fields []string, ) *TextQuery` + +NewTextQuery instantiates a new TextQuery 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 + +### NewTextQueryWithDefaults + +`func NewTextQueryWithDefaults() *TextQuery` + +NewTextQueryWithDefaults instantiates a new TextQuery 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 + +### GetTerms + +`func (o *TextQuery) GetTerms() []string` + +GetTerms returns the Terms field if non-nil, zero value otherwise. + +### GetTermsOk + +`func (o *TextQuery) GetTermsOk() (*[]string, bool)` + +GetTermsOk returns a tuple with the Terms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerms + +`func (o *TextQuery) SetTerms(v []string)` + +SetTerms sets Terms field to given value. + + +### GetFields + +`func (o *TextQuery) GetFields() []string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *TextQuery) GetFieldsOk() (*[]string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *TextQuery) SetFields(v []string)` + +SetFields sets Fields field to given value. + + +### GetMatchAny + +`func (o *TextQuery) GetMatchAny() bool` + +GetMatchAny returns the MatchAny field if non-nil, zero value otherwise. + +### GetMatchAnyOk + +`func (o *TextQuery) GetMatchAnyOk() (*bool, bool)` + +GetMatchAnyOk returns a tuple with the MatchAny field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAny + +`func (o *TextQuery) SetMatchAny(v bool)` + +SetMatchAny sets MatchAny field to given value. + +### HasMatchAny + +`func (o *TextQuery) HasMatchAny() bool` + +HasMatchAny returns a boolean if a field has been set. + +### GetContains + +`func (o *TextQuery) GetContains() bool` + +GetContains returns the Contains field if non-nil, zero value otherwise. + +### GetContainsOk + +`func (o *TextQuery) GetContainsOk() (*bool, bool)` + +GetContainsOk returns a tuple with the Contains field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContains + +`func (o *TextQuery) SetContains(v bool)` + +SetContains sets Contains field to given value. + +### HasContains + +`func (o *TextQuery) HasContains() bool` + +HasContains returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Transform.md b/docs/tools/sdk/go/Reference/V2024/Models/Transform.md new file mode 100644 index 000000000..725131b9d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Transform.md @@ -0,0 +1,111 @@ +--- +id: v2024-transform +title: Transform +pagination_label: Transform +sidebar_label: Transform +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Transform', 'V2024Transform'] +slug: /tools/sdk/go/v2024/models/transform +tags: ['SDK', 'Software Development Kit', 'Transform', 'V2024Transform'] +--- + +# Transform + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Unique name of this transform | +**Type** | **string** | The type of transform operation | +**Attributes** | **map[string]interface{}** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | + +## Methods + +### NewTransform + +`func NewTransform(name string, type_ string, attributes map[string]interface{}, ) *Transform` + +NewTransform instantiates a new Transform 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 + +### NewTransformWithDefaults + +`func NewTransformWithDefaults() *Transform` + +NewTransformWithDefaults instantiates a new Transform 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 + +### GetName + +`func (o *Transform) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Transform) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Transform) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *Transform) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Transform) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Transform) SetType(v string)` + +SetType sets Type field to given value. + + +### GetAttributes + +`func (o *Transform) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Transform) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Transform) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *Transform) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *Transform) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TransformDefinition.md b/docs/tools/sdk/go/Reference/V2024/Models/TransformDefinition.md new file mode 100644 index 000000000..80b4868d4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TransformDefinition.md @@ -0,0 +1,90 @@ +--- +id: v2024-transform-definition +title: TransformDefinition +pagination_label: TransformDefinition +sidebar_label: TransformDefinition +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TransformDefinition', 'V2024TransformDefinition'] +slug: /tools/sdk/go/v2024/models/transform-definition +tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'V2024TransformDefinition'] +--- + +# TransformDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Transform definition type. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Arbitrary key-value pairs to store any metadata for the object | [optional] + +## Methods + +### NewTransformDefinition + +`func NewTransformDefinition() *TransformDefinition` + +NewTransformDefinition instantiates a new TransformDefinition 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 + +### NewTransformDefinitionWithDefaults + +`func NewTransformDefinitionWithDefaults() *TransformDefinition` + +NewTransformDefinitionWithDefaults instantiates a new TransformDefinition 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 + +### GetType + +`func (o *TransformDefinition) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TransformDefinition) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TransformDefinition) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TransformDefinition) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetAttributes + +`func (o *TransformDefinition) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TransformDefinition) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TransformDefinition) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *TransformDefinition) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TransformRead.md b/docs/tools/sdk/go/Reference/V2024/Models/TransformRead.md new file mode 100644 index 000000000..77883b7a5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TransformRead.md @@ -0,0 +1,153 @@ +--- +id: v2024-transform-read +title: TransformRead +pagination_label: TransformRead +sidebar_label: TransformRead +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TransformRead', 'V2024TransformRead'] +slug: /tools/sdk/go/v2024/models/transform-read +tags: ['SDK', 'Software Development Kit', 'TransformRead', 'V2024TransformRead'] +--- + +# TransformRead + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Unique name of this transform | +**Type** | **string** | The type of transform operation | +**Attributes** | **map[string]interface{}** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | +**Id** | **string** | Unique ID of this transform | +**Internal** | **bool** | Indicates whether this is an internal SailPoint-created transform or a customer-created transform | [default to false] + +## Methods + +### NewTransformRead + +`func NewTransformRead(name string, type_ string, attributes map[string]interface{}, id string, internal bool, ) *TransformRead` + +NewTransformRead instantiates a new TransformRead 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 + +### NewTransformReadWithDefaults + +`func NewTransformReadWithDefaults() *TransformRead` + +NewTransformReadWithDefaults instantiates a new TransformRead 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 + +### GetName + +`func (o *TransformRead) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TransformRead) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TransformRead) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *TransformRead) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TransformRead) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TransformRead) SetType(v string)` + +SetType sets Type field to given value. + + +### GetAttributes + +`func (o *TransformRead) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TransformRead) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TransformRead) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *TransformRead) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *TransformRead) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetId + +`func (o *TransformRead) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TransformRead) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TransformRead) SetId(v string)` + +SetId sets Id field to given value. + + +### GetInternal + +`func (o *TransformRead) GetInternal() bool` + +GetInternal returns the Internal field if non-nil, zero value otherwise. + +### GetInternalOk + +`func (o *TransformRead) GetInternalOk() (*bool, bool)` + +GetInternalOk returns a tuple with the Internal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternal + +`func (o *TransformRead) SetInternal(v bool)` + +SetInternal sets Internal field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TranslationMessage.md b/docs/tools/sdk/go/Reference/V2024/Models/TranslationMessage.md new file mode 100644 index 000000000..f5cdcbd29 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TranslationMessage.md @@ -0,0 +1,90 @@ +--- +id: v2024-translation-message +title: TranslationMessage +pagination_label: TranslationMessage +sidebar_label: TranslationMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TranslationMessage', 'V2024TranslationMessage'] +slug: /tools/sdk/go/v2024/models/translation-message +tags: ['SDK', 'Software Development Kit', 'TranslationMessage', 'V2024TranslationMessage'] +--- + +# TranslationMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The key of the translation message | [optional] +**Values** | Pointer to **[]string** | The values corresponding to the translation messages | [optional] + +## Methods + +### NewTranslationMessage + +`func NewTranslationMessage() *TranslationMessage` + +NewTranslationMessage instantiates a new TranslationMessage 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 + +### NewTranslationMessageWithDefaults + +`func NewTranslationMessageWithDefaults() *TranslationMessage` + +NewTranslationMessageWithDefaults instantiates a new TranslationMessage 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 + +### GetKey + +`func (o *TranslationMessage) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TranslationMessage) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TranslationMessage) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *TranslationMessage) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetValues + +`func (o *TranslationMessage) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *TranslationMessage) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *TranslationMessage) SetValues(v []string)` + +SetValues sets Values field to given value. + +### HasValues + +`func (o *TranslationMessage) HasValues() bool` + +HasValues returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Trigger.md b/docs/tools/sdk/go/Reference/V2024/Models/Trigger.md new file mode 100644 index 000000000..22cc4939a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Trigger.md @@ -0,0 +1,241 @@ +--- +id: v2024-trigger +title: Trigger +pagination_label: Trigger +sidebar_label: Trigger +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Trigger', 'V2024Trigger'] +slug: /tools/sdk/go/v2024/models/trigger +tags: ['SDK', 'Software Development Kit', 'Trigger', 'V2024Trigger'] +--- + +# Trigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier of the trigger. | +**Name** | **string** | Trigger Name. | +**Type** | [**TriggerType**](trigger-type) | | +**Description** | Pointer to **string** | Trigger Description. | [optional] +**InputSchema** | **string** | The JSON schema of the payload that will be sent by the trigger to the subscribed service. | +**ExampleInput** | [**TriggerExampleInput**](trigger-example-input) | | +**OutputSchema** | Pointer to **NullableString** | The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`. | [optional] +**ExampleOutput** | Pointer to [**NullableTriggerExampleOutput**](trigger-example-output) | | [optional] + +## Methods + +### NewTrigger + +`func NewTrigger(id string, name string, type_ TriggerType, inputSchema string, exampleInput TriggerExampleInput, ) *Trigger` + +NewTrigger instantiates a new Trigger 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 + +### NewTriggerWithDefaults + +`func NewTriggerWithDefaults() *Trigger` + +NewTriggerWithDefaults instantiates a new Trigger 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 + +### GetId + +`func (o *Trigger) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Trigger) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Trigger) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *Trigger) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Trigger) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Trigger) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *Trigger) GetType() TriggerType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Trigger) GetTypeOk() (*TriggerType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Trigger) SetType(v TriggerType)` + +SetType sets Type field to given value. + + +### GetDescription + +`func (o *Trigger) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Trigger) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Trigger) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Trigger) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetInputSchema + +`func (o *Trigger) GetInputSchema() string` + +GetInputSchema returns the InputSchema field if non-nil, zero value otherwise. + +### GetInputSchemaOk + +`func (o *Trigger) GetInputSchemaOk() (*string, bool)` + +GetInputSchemaOk returns a tuple with the InputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInputSchema + +`func (o *Trigger) SetInputSchema(v string)` + +SetInputSchema sets InputSchema field to given value. + + +### GetExampleInput + +`func (o *Trigger) GetExampleInput() TriggerExampleInput` + +GetExampleInput returns the ExampleInput field if non-nil, zero value otherwise. + +### GetExampleInputOk + +`func (o *Trigger) GetExampleInputOk() (*TriggerExampleInput, bool)` + +GetExampleInputOk returns a tuple with the ExampleInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExampleInput + +`func (o *Trigger) SetExampleInput(v TriggerExampleInput)` + +SetExampleInput sets ExampleInput field to given value. + + +### GetOutputSchema + +`func (o *Trigger) GetOutputSchema() string` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *Trigger) GetOutputSchemaOk() (*string, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *Trigger) SetOutputSchema(v string)` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *Trigger) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + +### SetOutputSchemaNil + +`func (o *Trigger) SetOutputSchemaNil(b bool)` + + SetOutputSchemaNil sets the value for OutputSchema to be an explicit nil + +### UnsetOutputSchema +`func (o *Trigger) UnsetOutputSchema()` + +UnsetOutputSchema ensures that no value is present for OutputSchema, not even an explicit nil +### GetExampleOutput + +`func (o *Trigger) GetExampleOutput() TriggerExampleOutput` + +GetExampleOutput returns the ExampleOutput field if non-nil, zero value otherwise. + +### GetExampleOutputOk + +`func (o *Trigger) GetExampleOutputOk() (*TriggerExampleOutput, bool)` + +GetExampleOutputOk returns a tuple with the ExampleOutput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExampleOutput + +`func (o *Trigger) SetExampleOutput(v TriggerExampleOutput)` + +SetExampleOutput sets ExampleOutput field to given value. + +### HasExampleOutput + +`func (o *Trigger) HasExampleOutput() bool` + +HasExampleOutput returns a boolean if a field has been set. + +### SetExampleOutputNil + +`func (o *Trigger) SetExampleOutputNil(b bool)` + + SetExampleOutputNil sets the value for ExampleOutput to be an explicit nil + +### UnsetExampleOutput +`func (o *Trigger) UnsetExampleOutput()` + +UnsetExampleOutput ensures that no value is present for ExampleOutput, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TriggerExampleInput.md b/docs/tools/sdk/go/Reference/V2024/Models/TriggerExampleInput.md new file mode 100644 index 000000000..7fcfacaea --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TriggerExampleInput.md @@ -0,0 +1,1127 @@ +--- +id: v2024-trigger-example-input +title: TriggerExampleInput +pagination_label: TriggerExampleInput +sidebar_label: TriggerExampleInput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TriggerExampleInput', 'V2024TriggerExampleInput'] +slug: /tools/sdk/go/v2024/models/trigger-example-input +tags: ['SDK', 'Software Development Kit', 'TriggerExampleInput', 'V2024TriggerExampleInput'] +--- + +# TriggerExampleInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **string** | The unique ID of the access request. | +**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | +**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | +**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | +**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | +**Source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | +**Status** | **map[string]interface{}** | The overall status of the collection. | +**Started** | **SailPointTime** | The date and time when the account collection started. | +**Completed** | **SailPointTime** | The date and time when the account collection finished. | +**Errors** | **[]string** | A list of any accumulated error messages that occurred during provisioning. | +**Warnings** | **[]string** | A list of any accumulated warning messages that occurred during provisioning. | +**Stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | +**Identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | +**Account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | +**Changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | +**Attributes** | **map[string]interface{}** | The attributes of the account. The contents of attributes depends on the account schema for the source. | +**EntitlementCount** | Pointer to **int32** | The number of entitlements associated with this account. | [optional] +**Campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | +**Certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | +**TrackingNumber** | **string** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | +**Sources** | **string** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | +**Action** | Pointer to **NullableString** | Origin of where the provisioning request came from. | [optional] +**Recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | +**Requester** | Pointer to [**NullableProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional] +**AccountRequests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | +**FileName** | **string** | A name for the report file. | +**OwnerEmail** | **string** | The email address of the identity that owns the saved search. | +**OwnerName** | **string** | The name of the identity that owns the saved search. | +**Query** | **string** | The search query that was used to generate the report. | +**SearchName** | **string** | The name of the saved search. | +**SearchResults** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | +**SignedS3Url** | **string** | The Amazon S3 URL to download the report from. | +**Uuid** | Pointer to **string** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**Id** | **string** | The unique ID of the source. | +**NativeIdentifier** | **string** | Unique ID of the account on the source. | +**SourceId** | **string** | The ID of the source. | +**SourceName** | **string** | The name of the source. | +**IdentityId** | **string** | The ID of the identity that is correlated with this account. | +**IdentityName** | **string** | The name of the identity that is correlated with this account. | +**Name** | **string** | The user friendly name of the source. | +**Type** | **string** | The connection type of the source. | +**Created** | **SailPointTime** | The date and time the status change occurred. | +**Connector** | **string** | The connector type used to connect to the source. | +**Actor** | [**SourceUpdatedActor**](source-updated-actor) | | +**Deleted** | **SailPointTime** | The date and time the source was deleted. | +**Modified** | **SailPointTime** | The date and time the source was modified. | +**Application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | +**HealthCheckResult** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | +**PreviousHealthCheckResult** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | + +## Methods + +### NewTriggerExampleInput + +`func NewTriggerExampleInput(accessRequestId string, requestedFor []AccessItemRequestedForDto, requestedItems []AccessRequestPreApprovalRequestedItemsInner, requestedBy AccessItemRequesterDto, requestedItemsStatus []AccessRequestPostApprovalRequestedItemsStatusInner, source AccountUncorrelatedSource, status map[string]interface{}, started SailPointTime, completed SailPointTime, errors []string, warnings []string, stats AccountsCollectedForAggregationStats, identity IdentityDeletedIdentity, account AccountUncorrelatedAccount, changes []IdentityAttributesChangedChangesInner, attributes map[string]interface{}, campaign CampaignGeneratedCampaign, certification CertificationSignedOffCertification, trackingNumber string, sources string, recipient ProvisioningCompletedRecipient, accountRequests []ProvisioningCompletedAccountRequestsInner, fileName string, ownerEmail string, ownerName string, query string, searchName string, searchResults SavedSearchCompleteSearchResults, signedS3Url string, id string, nativeIdentifier string, sourceId string, sourceName string, identityId string, identityName string, name string, type_ string, created SailPointTime, connector string, actor SourceUpdatedActor, deleted SailPointTime, modified SailPointTime, application VAClusterStatusChangeEventApplication, healthCheckResult VAClusterStatusChangeEventHealthCheckResult, previousHealthCheckResult VAClusterStatusChangeEventPreviousHealthCheckResult, ) *TriggerExampleInput` + +NewTriggerExampleInput instantiates a new TriggerExampleInput 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 + +### NewTriggerExampleInputWithDefaults + +`func NewTriggerExampleInputWithDefaults() *TriggerExampleInput` + +NewTriggerExampleInputWithDefaults instantiates a new TriggerExampleInput 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 + +### GetAccessRequestId + +`func (o *TriggerExampleInput) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *TriggerExampleInput) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *TriggerExampleInput) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + + +### GetRequestedFor + +`func (o *TriggerExampleInput) GetRequestedFor() []AccessItemRequestedForDto` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *TriggerExampleInput) GetRequestedForOk() (*[]AccessItemRequestedForDto, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *TriggerExampleInput) SetRequestedFor(v []AccessItemRequestedForDto)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestedItems + +`func (o *TriggerExampleInput) GetRequestedItems() []AccessRequestPreApprovalRequestedItemsInner` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *TriggerExampleInput) GetRequestedItemsOk() (*[]AccessRequestPreApprovalRequestedItemsInner, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *TriggerExampleInput) SetRequestedItems(v []AccessRequestPreApprovalRequestedItemsInner)` + +SetRequestedItems sets RequestedItems field to given value. + + +### GetRequestedBy + +`func (o *TriggerExampleInput) GetRequestedBy() AccessItemRequesterDto` + +GetRequestedBy returns the RequestedBy field if non-nil, zero value otherwise. + +### GetRequestedByOk + +`func (o *TriggerExampleInput) GetRequestedByOk() (*AccessItemRequesterDto, bool)` + +GetRequestedByOk returns a tuple with the RequestedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedBy + +`func (o *TriggerExampleInput) SetRequestedBy(v AccessItemRequesterDto)` + +SetRequestedBy sets RequestedBy field to given value. + + +### GetRequestedItemsStatus + +`func (o *TriggerExampleInput) GetRequestedItemsStatus() []AccessRequestPostApprovalRequestedItemsStatusInner` + +GetRequestedItemsStatus returns the RequestedItemsStatus field if non-nil, zero value otherwise. + +### GetRequestedItemsStatusOk + +`func (o *TriggerExampleInput) GetRequestedItemsStatusOk() (*[]AccessRequestPostApprovalRequestedItemsStatusInner, bool)` + +GetRequestedItemsStatusOk returns a tuple with the RequestedItemsStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItemsStatus + +`func (o *TriggerExampleInput) SetRequestedItemsStatus(v []AccessRequestPostApprovalRequestedItemsStatusInner)` + +SetRequestedItemsStatus sets RequestedItemsStatus field to given value. + + +### GetSource + +`func (o *TriggerExampleInput) GetSource() AccountUncorrelatedSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *TriggerExampleInput) GetSourceOk() (*AccountUncorrelatedSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *TriggerExampleInput) SetSource(v AccountUncorrelatedSource)` + +SetSource sets Source field to given value. + + +### GetStatus + +`func (o *TriggerExampleInput) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *TriggerExampleInput) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *TriggerExampleInput) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + +### GetStarted + +`func (o *TriggerExampleInput) GetStarted() SailPointTime` + +GetStarted returns the Started field if non-nil, zero value otherwise. + +### GetStartedOk + +`func (o *TriggerExampleInput) GetStartedOk() (*SailPointTime, bool)` + +GetStartedOk returns a tuple with the Started field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStarted + +`func (o *TriggerExampleInput) SetStarted(v SailPointTime)` + +SetStarted sets Started field to given value. + + +### GetCompleted + +`func (o *TriggerExampleInput) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *TriggerExampleInput) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *TriggerExampleInput) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + + +### GetErrors + +`func (o *TriggerExampleInput) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *TriggerExampleInput) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *TriggerExampleInput) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + + +### SetErrorsNil + +`func (o *TriggerExampleInput) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *TriggerExampleInput) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *TriggerExampleInput) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *TriggerExampleInput) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *TriggerExampleInput) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + + +### SetWarningsNil + +`func (o *TriggerExampleInput) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *TriggerExampleInput) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetStats + +`func (o *TriggerExampleInput) GetStats() AccountsCollectedForAggregationStats` + +GetStats returns the Stats field if non-nil, zero value otherwise. + +### GetStatsOk + +`func (o *TriggerExampleInput) GetStatsOk() (*AccountsCollectedForAggregationStats, bool)` + +GetStatsOk returns a tuple with the Stats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStats + +`func (o *TriggerExampleInput) SetStats(v AccountsCollectedForAggregationStats)` + +SetStats sets Stats field to given value. + + +### GetIdentity + +`func (o *TriggerExampleInput) GetIdentity() IdentityDeletedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *TriggerExampleInput) GetIdentityOk() (*IdentityDeletedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *TriggerExampleInput) SetIdentity(v IdentityDeletedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetAccount + +`func (o *TriggerExampleInput) GetAccount() AccountUncorrelatedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *TriggerExampleInput) GetAccountOk() (*AccountUncorrelatedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *TriggerExampleInput) SetAccount(v AccountUncorrelatedAccount)` + +SetAccount sets Account field to given value. + + +### GetChanges + +`func (o *TriggerExampleInput) GetChanges() []IdentityAttributesChangedChangesInner` + +GetChanges returns the Changes field if non-nil, zero value otherwise. + +### GetChangesOk + +`func (o *TriggerExampleInput) GetChangesOk() (*[]IdentityAttributesChangedChangesInner, bool)` + +GetChangesOk returns a tuple with the Changes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanges + +`func (o *TriggerExampleInput) SetChanges(v []IdentityAttributesChangedChangesInner)` + +SetChanges sets Changes field to given value. + + +### GetAttributes + +`func (o *TriggerExampleInput) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TriggerExampleInput) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TriggerExampleInput) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetEntitlementCount + +`func (o *TriggerExampleInput) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *TriggerExampleInput) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *TriggerExampleInput) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *TriggerExampleInput) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetCampaign + +`func (o *TriggerExampleInput) GetCampaign() CampaignGeneratedCampaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *TriggerExampleInput) GetCampaignOk() (*CampaignGeneratedCampaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *TriggerExampleInput) SetCampaign(v CampaignGeneratedCampaign)` + +SetCampaign sets Campaign field to given value. + + +### GetCertification + +`func (o *TriggerExampleInput) GetCertification() CertificationSignedOffCertification` + +GetCertification returns the Certification field if non-nil, zero value otherwise. + +### GetCertificationOk + +`func (o *TriggerExampleInput) GetCertificationOk() (*CertificationSignedOffCertification, bool)` + +GetCertificationOk returns a tuple with the Certification field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertification + +`func (o *TriggerExampleInput) SetCertification(v CertificationSignedOffCertification)` + +SetCertification sets Certification field to given value. + + +### GetTrackingNumber + +`func (o *TriggerExampleInput) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *TriggerExampleInput) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *TriggerExampleInput) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + + +### GetSources + +`func (o *TriggerExampleInput) GetSources() string` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *TriggerExampleInput) GetSourcesOk() (*string, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *TriggerExampleInput) SetSources(v string)` + +SetSources sets Sources field to given value. + + +### GetAction + +`func (o *TriggerExampleInput) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *TriggerExampleInput) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *TriggerExampleInput) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *TriggerExampleInput) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### SetActionNil + +`func (o *TriggerExampleInput) SetActionNil(b bool)` + + SetActionNil sets the value for Action to be an explicit nil + +### UnsetAction +`func (o *TriggerExampleInput) UnsetAction()` + +UnsetAction ensures that no value is present for Action, not even an explicit nil +### GetRecipient + +`func (o *TriggerExampleInput) GetRecipient() ProvisioningCompletedRecipient` + +GetRecipient returns the Recipient field if non-nil, zero value otherwise. + +### GetRecipientOk + +`func (o *TriggerExampleInput) GetRecipientOk() (*ProvisioningCompletedRecipient, bool)` + +GetRecipientOk returns a tuple with the Recipient field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipient + +`func (o *TriggerExampleInput) SetRecipient(v ProvisioningCompletedRecipient)` + +SetRecipient sets Recipient field to given value. + + +### GetRequester + +`func (o *TriggerExampleInput) GetRequester() ProvisioningCompletedRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *TriggerExampleInput) GetRequesterOk() (*ProvisioningCompletedRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *TriggerExampleInput) SetRequester(v ProvisioningCompletedRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *TriggerExampleInput) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### SetRequesterNil + +`func (o *TriggerExampleInput) SetRequesterNil(b bool)` + + SetRequesterNil sets the value for Requester to be an explicit nil + +### UnsetRequester +`func (o *TriggerExampleInput) UnsetRequester()` + +UnsetRequester ensures that no value is present for Requester, not even an explicit nil +### GetAccountRequests + +`func (o *TriggerExampleInput) GetAccountRequests() []ProvisioningCompletedAccountRequestsInner` + +GetAccountRequests returns the AccountRequests field if non-nil, zero value otherwise. + +### GetAccountRequestsOk + +`func (o *TriggerExampleInput) GetAccountRequestsOk() (*[]ProvisioningCompletedAccountRequestsInner, bool)` + +GetAccountRequestsOk returns a tuple with the AccountRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountRequests + +`func (o *TriggerExampleInput) SetAccountRequests(v []ProvisioningCompletedAccountRequestsInner)` + +SetAccountRequests sets AccountRequests field to given value. + + +### GetFileName + +`func (o *TriggerExampleInput) GetFileName() string` + +GetFileName returns the FileName field if non-nil, zero value otherwise. + +### GetFileNameOk + +`func (o *TriggerExampleInput) GetFileNameOk() (*string, bool)` + +GetFileNameOk returns a tuple with the FileName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileName + +`func (o *TriggerExampleInput) SetFileName(v string)` + +SetFileName sets FileName field to given value. + + +### GetOwnerEmail + +`func (o *TriggerExampleInput) GetOwnerEmail() string` + +GetOwnerEmail returns the OwnerEmail field if non-nil, zero value otherwise. + +### GetOwnerEmailOk + +`func (o *TriggerExampleInput) GetOwnerEmailOk() (*string, bool)` + +GetOwnerEmailOk returns a tuple with the OwnerEmail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerEmail + +`func (o *TriggerExampleInput) SetOwnerEmail(v string)` + +SetOwnerEmail sets OwnerEmail field to given value. + + +### GetOwnerName + +`func (o *TriggerExampleInput) GetOwnerName() string` + +GetOwnerName returns the OwnerName field if non-nil, zero value otherwise. + +### GetOwnerNameOk + +`func (o *TriggerExampleInput) GetOwnerNameOk() (*string, bool)` + +GetOwnerNameOk returns a tuple with the OwnerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerName + +`func (o *TriggerExampleInput) SetOwnerName(v string)` + +SetOwnerName sets OwnerName field to given value. + + +### GetQuery + +`func (o *TriggerExampleInput) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *TriggerExampleInput) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *TriggerExampleInput) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetSearchName + +`func (o *TriggerExampleInput) GetSearchName() string` + +GetSearchName returns the SearchName field if non-nil, zero value otherwise. + +### GetSearchNameOk + +`func (o *TriggerExampleInput) GetSearchNameOk() (*string, bool)` + +GetSearchNameOk returns a tuple with the SearchName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchName + +`func (o *TriggerExampleInput) SetSearchName(v string)` + +SetSearchName sets SearchName field to given value. + + +### GetSearchResults + +`func (o *TriggerExampleInput) GetSearchResults() SavedSearchCompleteSearchResults` + +GetSearchResults returns the SearchResults field if non-nil, zero value otherwise. + +### GetSearchResultsOk + +`func (o *TriggerExampleInput) GetSearchResultsOk() (*SavedSearchCompleteSearchResults, bool)` + +GetSearchResultsOk returns a tuple with the SearchResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchResults + +`func (o *TriggerExampleInput) SetSearchResults(v SavedSearchCompleteSearchResults)` + +SetSearchResults sets SearchResults field to given value. + + +### GetSignedS3Url + +`func (o *TriggerExampleInput) GetSignedS3Url() string` + +GetSignedS3Url returns the SignedS3Url field if non-nil, zero value otherwise. + +### GetSignedS3UrlOk + +`func (o *TriggerExampleInput) GetSignedS3UrlOk() (*string, bool)` + +GetSignedS3UrlOk returns a tuple with the SignedS3Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignedS3Url + +`func (o *TriggerExampleInput) SetSignedS3Url(v string)` + +SetSignedS3Url sets SignedS3Url field to given value. + + +### GetUuid + +`func (o *TriggerExampleInput) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *TriggerExampleInput) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *TriggerExampleInput) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *TriggerExampleInput) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### GetId + +`func (o *TriggerExampleInput) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TriggerExampleInput) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TriggerExampleInput) SetId(v string)` + +SetId sets Id field to given value. + + +### GetNativeIdentifier + +`func (o *TriggerExampleInput) GetNativeIdentifier() string` + +GetNativeIdentifier returns the NativeIdentifier field if non-nil, zero value otherwise. + +### GetNativeIdentifierOk + +`func (o *TriggerExampleInput) GetNativeIdentifierOk() (*string, bool)` + +GetNativeIdentifierOk returns a tuple with the NativeIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentifier + +`func (o *TriggerExampleInput) SetNativeIdentifier(v string)` + +SetNativeIdentifier sets NativeIdentifier field to given value. + + +### GetSourceId + +`func (o *TriggerExampleInput) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *TriggerExampleInput) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *TriggerExampleInput) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetSourceName + +`func (o *TriggerExampleInput) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *TriggerExampleInput) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *TriggerExampleInput) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### GetIdentityId + +`func (o *TriggerExampleInput) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *TriggerExampleInput) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *TriggerExampleInput) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetIdentityName + +`func (o *TriggerExampleInput) GetIdentityName() string` + +GetIdentityName returns the IdentityName field if non-nil, zero value otherwise. + +### GetIdentityNameOk + +`func (o *TriggerExampleInput) GetIdentityNameOk() (*string, bool)` + +GetIdentityNameOk returns a tuple with the IdentityName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityName + +`func (o *TriggerExampleInput) SetIdentityName(v string)` + +SetIdentityName sets IdentityName field to given value. + + +### GetName + +`func (o *TriggerExampleInput) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TriggerExampleInput) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TriggerExampleInput) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *TriggerExampleInput) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TriggerExampleInput) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TriggerExampleInput) SetType(v string)` + +SetType sets Type field to given value. + + +### GetCreated + +`func (o *TriggerExampleInput) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *TriggerExampleInput) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *TriggerExampleInput) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetConnector + +`func (o *TriggerExampleInput) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *TriggerExampleInput) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *TriggerExampleInput) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetActor + +`func (o *TriggerExampleInput) GetActor() SourceUpdatedActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *TriggerExampleInput) GetActorOk() (*SourceUpdatedActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *TriggerExampleInput) SetActor(v SourceUpdatedActor)` + +SetActor sets Actor field to given value. + + +### GetDeleted + +`func (o *TriggerExampleInput) GetDeleted() SailPointTime` + +GetDeleted returns the Deleted field if non-nil, zero value otherwise. + +### GetDeletedOk + +`func (o *TriggerExampleInput) GetDeletedOk() (*SailPointTime, bool)` + +GetDeletedOk returns a tuple with the Deleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleted + +`func (o *TriggerExampleInput) SetDeleted(v SailPointTime)` + +SetDeleted sets Deleted field to given value. + + +### GetModified + +`func (o *TriggerExampleInput) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *TriggerExampleInput) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *TriggerExampleInput) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetApplication + +`func (o *TriggerExampleInput) GetApplication() VAClusterStatusChangeEventApplication` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *TriggerExampleInput) GetApplicationOk() (*VAClusterStatusChangeEventApplication, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *TriggerExampleInput) SetApplication(v VAClusterStatusChangeEventApplication)` + +SetApplication sets Application field to given value. + + +### GetHealthCheckResult + +`func (o *TriggerExampleInput) GetHealthCheckResult() VAClusterStatusChangeEventHealthCheckResult` + +GetHealthCheckResult returns the HealthCheckResult field if non-nil, zero value otherwise. + +### GetHealthCheckResultOk + +`func (o *TriggerExampleInput) GetHealthCheckResultOk() (*VAClusterStatusChangeEventHealthCheckResult, bool)` + +GetHealthCheckResultOk returns a tuple with the HealthCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthCheckResult + +`func (o *TriggerExampleInput) SetHealthCheckResult(v VAClusterStatusChangeEventHealthCheckResult)` + +SetHealthCheckResult sets HealthCheckResult field to given value. + + +### GetPreviousHealthCheckResult + +`func (o *TriggerExampleInput) GetPreviousHealthCheckResult() VAClusterStatusChangeEventPreviousHealthCheckResult` + +GetPreviousHealthCheckResult returns the PreviousHealthCheckResult field if non-nil, zero value otherwise. + +### GetPreviousHealthCheckResultOk + +`func (o *TriggerExampleInput) GetPreviousHealthCheckResultOk() (*VAClusterStatusChangeEventPreviousHealthCheckResult, bool)` + +GetPreviousHealthCheckResultOk returns a tuple with the PreviousHealthCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousHealthCheckResult + +`func (o *TriggerExampleInput) SetPreviousHealthCheckResult(v VAClusterStatusChangeEventPreviousHealthCheckResult)` + +SetPreviousHealthCheckResult sets PreviousHealthCheckResult field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TriggerExampleOutput.md b/docs/tools/sdk/go/Reference/V2024/Models/TriggerExampleOutput.md new file mode 100644 index 000000000..22a56d29a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TriggerExampleOutput.md @@ -0,0 +1,164 @@ +--- +id: v2024-trigger-example-output +title: TriggerExampleOutput +pagination_label: TriggerExampleOutput +sidebar_label: TriggerExampleOutput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TriggerExampleOutput', 'V2024TriggerExampleOutput'] +slug: /tools/sdk/go/v2024/models/trigger-example-output +tags: ['SDK', 'Software Development Kit', 'TriggerExampleOutput', 'V2024TriggerExampleOutput'] +--- + +# TriggerExampleOutput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the identity to add to the approver list for the access request. | +**Name** | **string** | The name of the identity to add to the approver list for the access request. | +**Type** | **map[string]interface{}** | The type of object being referenced. | +**Approved** | **bool** | Whether or not to approve the access request. | +**Comment** | **string** | A comment about the decision to approve or deny the request. | +**Approver** | **string** | The name of the entity that approved or denied the request. | + +## Methods + +### NewTriggerExampleOutput + +`func NewTriggerExampleOutput(id string, name string, type_ map[string]interface{}, approved bool, comment string, approver string, ) *TriggerExampleOutput` + +NewTriggerExampleOutput instantiates a new TriggerExampleOutput 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 + +### NewTriggerExampleOutputWithDefaults + +`func NewTriggerExampleOutputWithDefaults() *TriggerExampleOutput` + +NewTriggerExampleOutputWithDefaults instantiates a new TriggerExampleOutput 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 + +### GetId + +`func (o *TriggerExampleOutput) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TriggerExampleOutput) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TriggerExampleOutput) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *TriggerExampleOutput) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TriggerExampleOutput) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TriggerExampleOutput) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *TriggerExampleOutput) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TriggerExampleOutput) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TriggerExampleOutput) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetApproved + +`func (o *TriggerExampleOutput) GetApproved() bool` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *TriggerExampleOutput) GetApprovedOk() (*bool, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *TriggerExampleOutput) SetApproved(v bool)` + +SetApproved sets Approved field to given value. + + +### GetComment + +`func (o *TriggerExampleOutput) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *TriggerExampleOutput) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *TriggerExampleOutput) SetComment(v string)` + +SetComment sets Comment field to given value. + + +### GetApprover + +`func (o *TriggerExampleOutput) GetApprover() string` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *TriggerExampleOutput) GetApproverOk() (*string, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *TriggerExampleOutput) SetApprover(v string)` + +SetApprover sets Approver field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TriggerType.md b/docs/tools/sdk/go/Reference/V2024/Models/TriggerType.md new file mode 100644 index 000000000..8aebefc5d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TriggerType.md @@ -0,0 +1,21 @@ +--- +id: v2024-trigger-type +title: TriggerType +pagination_label: TriggerType +sidebar_label: TriggerType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TriggerType', 'V2024TriggerType'] +slug: /tools/sdk/go/v2024/models/trigger-type +tags: ['SDK', 'Software Development Kit', 'TriggerType', 'V2024TriggerType'] +--- + +# TriggerType + +## Enum + + +* `REQUEST_RESPONSE` (value: `"REQUEST_RESPONSE"`) + +* `FIRE_AND_FORGET` (value: `"FIRE_AND_FORGET"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TypeAheadQuery.md b/docs/tools/sdk/go/Reference/V2024/Models/TypeAheadQuery.md new file mode 100644 index 000000000..2f01c0afc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TypeAheadQuery.md @@ -0,0 +1,210 @@ +--- +id: v2024-type-ahead-query +title: TypeAheadQuery +pagination_label: TypeAheadQuery +sidebar_label: TypeAheadQuery +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TypeAheadQuery', 'V2024TypeAheadQuery'] +slug: /tools/sdk/go/v2024/models/type-ahead-query +tags: ['SDK', 'Software Development Kit', 'TypeAheadQuery', 'V2024TypeAheadQuery'] +--- + +# TypeAheadQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **string** | The type ahead query string used to construct a phrase prefix match query. | +**Field** | **string** | The field on which to perform the type ahead search. | +**NestedType** | Pointer to **string** | The nested type. | [optional] +**MaxExpansions** | Pointer to **int32** | The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000. | [optional] [default to 10] +**Size** | Pointer to **int32** | The max amount of records the search will return. | [optional] [default to 100] +**Sort** | Pointer to **string** | The sort order of the returned records. | [optional] [default to "desc"] +**SortByValue** | Pointer to **bool** | The flag that defines the sort type, by count or value. | [optional] [default to false] + +## Methods + +### NewTypeAheadQuery + +`func NewTypeAheadQuery(query string, field string, ) *TypeAheadQuery` + +NewTypeAheadQuery instantiates a new TypeAheadQuery 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 + +### NewTypeAheadQueryWithDefaults + +`func NewTypeAheadQueryWithDefaults() *TypeAheadQuery` + +NewTypeAheadQueryWithDefaults instantiates a new TypeAheadQuery 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 + +### GetQuery + +`func (o *TypeAheadQuery) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *TypeAheadQuery) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *TypeAheadQuery) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetField + +`func (o *TypeAheadQuery) GetField() string` + +GetField returns the Field field if non-nil, zero value otherwise. + +### GetFieldOk + +`func (o *TypeAheadQuery) GetFieldOk() (*string, bool)` + +GetFieldOk returns a tuple with the Field field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetField + +`func (o *TypeAheadQuery) SetField(v string)` + +SetField sets Field field to given value. + + +### GetNestedType + +`func (o *TypeAheadQuery) GetNestedType() string` + +GetNestedType returns the NestedType field if non-nil, zero value otherwise. + +### GetNestedTypeOk + +`func (o *TypeAheadQuery) GetNestedTypeOk() (*string, bool)` + +GetNestedTypeOk returns a tuple with the NestedType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNestedType + +`func (o *TypeAheadQuery) SetNestedType(v string)` + +SetNestedType sets NestedType field to given value. + +### HasNestedType + +`func (o *TypeAheadQuery) HasNestedType() bool` + +HasNestedType returns a boolean if a field has been set. + +### GetMaxExpansions + +`func (o *TypeAheadQuery) GetMaxExpansions() int32` + +GetMaxExpansions returns the MaxExpansions field if non-nil, zero value otherwise. + +### GetMaxExpansionsOk + +`func (o *TypeAheadQuery) GetMaxExpansionsOk() (*int32, bool)` + +GetMaxExpansionsOk returns a tuple with the MaxExpansions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxExpansions + +`func (o *TypeAheadQuery) SetMaxExpansions(v int32)` + +SetMaxExpansions sets MaxExpansions field to given value. + +### HasMaxExpansions + +`func (o *TypeAheadQuery) HasMaxExpansions() bool` + +HasMaxExpansions returns a boolean if a field has been set. + +### GetSize + +`func (o *TypeAheadQuery) GetSize() int32` + +GetSize returns the Size field if non-nil, zero value otherwise. + +### GetSizeOk + +`func (o *TypeAheadQuery) GetSizeOk() (*int32, bool)` + +GetSizeOk returns a tuple with the Size field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSize + +`func (o *TypeAheadQuery) SetSize(v int32)` + +SetSize sets Size field to given value. + +### HasSize + +`func (o *TypeAheadQuery) HasSize() bool` + +HasSize returns a boolean if a field has been set. + +### GetSort + +`func (o *TypeAheadQuery) GetSort() string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *TypeAheadQuery) GetSortOk() (*string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *TypeAheadQuery) SetSort(v string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *TypeAheadQuery) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### GetSortByValue + +`func (o *TypeAheadQuery) GetSortByValue() bool` + +GetSortByValue returns the SortByValue field if non-nil, zero value otherwise. + +### GetSortByValueOk + +`func (o *TypeAheadQuery) GetSortByValueOk() (*bool, bool)` + +GetSortByValueOk returns a tuple with the SortByValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSortByValue + +`func (o *TypeAheadQuery) SetSortByValue(v bool)` + +SetSortByValue sets SortByValue field to given value. + +### HasSortByValue + +`func (o *TypeAheadQuery) HasSortByValue() bool` + +HasSortByValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/TypedReference.md b/docs/tools/sdk/go/Reference/V2024/Models/TypedReference.md new file mode 100644 index 000000000..316fa1198 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/TypedReference.md @@ -0,0 +1,80 @@ +--- +id: v2024-typed-reference +title: TypedReference +pagination_label: TypedReference +sidebar_label: TypedReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TypedReference', 'V2024TypedReference'] +slug: /tools/sdk/go/v2024/models/typed-reference +tags: ['SDK', 'Software Development Kit', 'TypedReference', 'V2024TypedReference'] +--- + +# TypedReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**DtoType**](dto-type) | | +**Id** | **string** | The id of the object. | + +## Methods + +### NewTypedReference + +`func NewTypedReference(type_ DtoType, id string, ) *TypedReference` + +NewTypedReference instantiates a new TypedReference 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 + +### NewTypedReferenceWithDefaults + +`func NewTypedReferenceWithDefaults() *TypedReference` + +NewTypedReferenceWithDefaults instantiates a new TypedReference 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 + +### GetType + +`func (o *TypedReference) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TypedReference) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TypedReference) SetType(v DtoType)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *TypedReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TypedReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TypedReference) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/UncorrelatedAccountsReportArguments.md b/docs/tools/sdk/go/Reference/V2024/Models/UncorrelatedAccountsReportArguments.md new file mode 100644 index 000000000..116515bbf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/UncorrelatedAccountsReportArguments.md @@ -0,0 +1,64 @@ +--- +id: v2024-uncorrelated-accounts-report-arguments +title: UncorrelatedAccountsReportArguments +pagination_label: UncorrelatedAccountsReportArguments +sidebar_label: UncorrelatedAccountsReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UncorrelatedAccountsReportArguments', 'V2024UncorrelatedAccountsReportArguments'] +slug: /tools/sdk/go/v2024/models/uncorrelated-accounts-report-arguments +tags: ['SDK', 'Software Development Kit', 'UncorrelatedAccountsReportArguments', 'V2024UncorrelatedAccountsReportArguments'] +--- + +# UncorrelatedAccountsReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SelectedFormats** | Pointer to **[]string** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] + +## Methods + +### NewUncorrelatedAccountsReportArguments + +`func NewUncorrelatedAccountsReportArguments() *UncorrelatedAccountsReportArguments` + +NewUncorrelatedAccountsReportArguments instantiates a new UncorrelatedAccountsReportArguments 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 + +### NewUncorrelatedAccountsReportArgumentsWithDefaults + +`func NewUncorrelatedAccountsReportArgumentsWithDefaults() *UncorrelatedAccountsReportArguments` + +NewUncorrelatedAccountsReportArgumentsWithDefaults instantiates a new UncorrelatedAccountsReportArguments 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 + +### GetSelectedFormats + +`func (o *UncorrelatedAccountsReportArguments) GetSelectedFormats() []string` + +GetSelectedFormats returns the SelectedFormats field if non-nil, zero value otherwise. + +### GetSelectedFormatsOk + +`func (o *UncorrelatedAccountsReportArguments) GetSelectedFormatsOk() (*[]string, bool)` + +GetSelectedFormatsOk returns a tuple with the SelectedFormats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectedFormats + +`func (o *UncorrelatedAccountsReportArguments) SetSelectedFormats(v []string)` + +SetSelectedFormats sets SelectedFormats field to given value. + +### HasSelectedFormats + +`func (o *UncorrelatedAccountsReportArguments) HasSelectedFormats() bool` + +HasSelectedFormats returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/UpdateAccessProfilesInBulk412Response.md b/docs/tools/sdk/go/Reference/V2024/Models/UpdateAccessProfilesInBulk412Response.md new file mode 100644 index 000000000..d4b0b8b01 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/UpdateAccessProfilesInBulk412Response.md @@ -0,0 +1,64 @@ +--- +id: v2024-update-access-profiles-in-bulk412-response +title: UpdateAccessProfilesInBulk412Response +pagination_label: UpdateAccessProfilesInBulk412Response +sidebar_label: UpdateAccessProfilesInBulk412Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UpdateAccessProfilesInBulk412Response', 'V2024UpdateAccessProfilesInBulk412Response'] +slug: /tools/sdk/go/v2024/models/update-access-profiles-in-bulk412-response +tags: ['SDK', 'Software Development Kit', 'UpdateAccessProfilesInBulk412Response', 'V2024UpdateAccessProfilesInBulk412Response'] +--- + +# UpdateAccessProfilesInBulk412Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **map[string]interface{}** | A message describing the error | [optional] + +## Methods + +### NewUpdateAccessProfilesInBulk412Response + +`func NewUpdateAccessProfilesInBulk412Response() *UpdateAccessProfilesInBulk412Response` + +NewUpdateAccessProfilesInBulk412Response instantiates a new UpdateAccessProfilesInBulk412Response 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 + +### NewUpdateAccessProfilesInBulk412ResponseWithDefaults + +`func NewUpdateAccessProfilesInBulk412ResponseWithDefaults() *UpdateAccessProfilesInBulk412Response` + +NewUpdateAccessProfilesInBulk412ResponseWithDefaults instantiates a new UpdateAccessProfilesInBulk412Response 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 + +### GetMessage + +`func (o *UpdateAccessProfilesInBulk412Response) GetMessage() map[string]interface{}` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *UpdateAccessProfilesInBulk412Response) GetMessageOk() (*map[string]interface{}, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *UpdateAccessProfilesInBulk412Response) SetMessage(v map[string]interface{})` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *UpdateAccessProfilesInBulk412Response) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/UpdateDetail.md b/docs/tools/sdk/go/Reference/V2024/Models/UpdateDetail.md new file mode 100644 index 000000000..6189f12e4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/UpdateDetail.md @@ -0,0 +1,152 @@ +--- +id: v2024-update-detail +title: UpdateDetail +pagination_label: UpdateDetail +sidebar_label: UpdateDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UpdateDetail', 'V2024UpdateDetail'] +slug: /tools/sdk/go/v2024/models/update-detail +tags: ['SDK', 'Software Development Kit', 'UpdateDetail', 'V2024UpdateDetail'] +--- + +# UpdateDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **string** | The detailed message for an update. Typically the relevent error message when status is error. | [optional] +**ScriptName** | Pointer to **string** | The connector script name | [optional] +**UpdatedFiles** | Pointer to **[]string** | The list of updated files supported by the connector | [optional] +**Status** | Pointer to **string** | The connector update status | [optional] + +## Methods + +### NewUpdateDetail + +`func NewUpdateDetail() *UpdateDetail` + +NewUpdateDetail instantiates a new UpdateDetail 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 + +### NewUpdateDetailWithDefaults + +`func NewUpdateDetailWithDefaults() *UpdateDetail` + +NewUpdateDetailWithDefaults instantiates a new UpdateDetail 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 + +### GetMessage + +`func (o *UpdateDetail) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *UpdateDetail) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *UpdateDetail) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *UpdateDetail) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetScriptName + +`func (o *UpdateDetail) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *UpdateDetail) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *UpdateDetail) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + +### HasScriptName + +`func (o *UpdateDetail) HasScriptName() bool` + +HasScriptName returns a boolean if a field has been set. + +### GetUpdatedFiles + +`func (o *UpdateDetail) GetUpdatedFiles() []string` + +GetUpdatedFiles returns the UpdatedFiles field if non-nil, zero value otherwise. + +### GetUpdatedFilesOk + +`func (o *UpdateDetail) GetUpdatedFilesOk() (*[]string, bool)` + +GetUpdatedFilesOk returns a tuple with the UpdatedFiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedFiles + +`func (o *UpdateDetail) SetUpdatedFiles(v []string)` + +SetUpdatedFiles sets UpdatedFiles field to given value. + +### HasUpdatedFiles + +`func (o *UpdateDetail) HasUpdatedFiles() bool` + +HasUpdatedFiles returns a boolean if a field has been set. + +### SetUpdatedFilesNil + +`func (o *UpdateDetail) SetUpdatedFilesNil(b bool)` + + SetUpdatedFilesNil sets the value for UpdatedFiles to be an explicit nil + +### UnsetUpdatedFiles +`func (o *UpdateDetail) UnsetUpdatedFiles()` + +UnsetUpdatedFiles ensures that no value is present for UpdatedFiles, not even an explicit nil +### GetStatus + +`func (o *UpdateDetail) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *UpdateDetail) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *UpdateDetail) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *UpdateDetail) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/UpdateMultiHostSourcesRequestInner.md b/docs/tools/sdk/go/Reference/V2024/Models/UpdateMultiHostSourcesRequestInner.md new file mode 100644 index 000000000..27e7a7481 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/UpdateMultiHostSourcesRequestInner.md @@ -0,0 +1,106 @@ +--- +id: v2024-update-multi-host-sources-request-inner +title: UpdateMultiHostSourcesRequestInner +pagination_label: UpdateMultiHostSourcesRequestInner +sidebar_label: UpdateMultiHostSourcesRequestInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UpdateMultiHostSourcesRequestInner', 'V2024UpdateMultiHostSourcesRequestInner'] +slug: /tools/sdk/go/v2024/models/update-multi-host-sources-request-inner +tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInner', 'V2024UpdateMultiHostSourcesRequestInner'] +--- + +# UpdateMultiHostSourcesRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **string** | The operation to be performed | +**Path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | +**Value** | Pointer to [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] + +## Methods + +### NewUpdateMultiHostSourcesRequestInner + +`func NewUpdateMultiHostSourcesRequestInner(op string, path string, ) *UpdateMultiHostSourcesRequestInner` + +NewUpdateMultiHostSourcesRequestInner instantiates a new UpdateMultiHostSourcesRequestInner 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 + +### NewUpdateMultiHostSourcesRequestInnerWithDefaults + +`func NewUpdateMultiHostSourcesRequestInnerWithDefaults() *UpdateMultiHostSourcesRequestInner` + +NewUpdateMultiHostSourcesRequestInnerWithDefaults instantiates a new UpdateMultiHostSourcesRequestInner 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 + +### GetOp + +`func (o *UpdateMultiHostSourcesRequestInner) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *UpdateMultiHostSourcesRequestInner) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *UpdateMultiHostSourcesRequestInner) SetOp(v string)` + +SetOp sets Op field to given value. + + +### GetPath + +`func (o *UpdateMultiHostSourcesRequestInner) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *UpdateMultiHostSourcesRequestInner) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *UpdateMultiHostSourcesRequestInner) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetValue + +`func (o *UpdateMultiHostSourcesRequestInner) GetValue() UpdateMultiHostSourcesRequestInnerValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *UpdateMultiHostSourcesRequestInner) GetValueOk() (*UpdateMultiHostSourcesRequestInnerValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *UpdateMultiHostSourcesRequestInner) SetValue(v UpdateMultiHostSourcesRequestInnerValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *UpdateMultiHostSourcesRequestInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/UpdateMultiHostSourcesRequestInnerValue.md b/docs/tools/sdk/go/Reference/V2024/Models/UpdateMultiHostSourcesRequestInnerValue.md new file mode 100644 index 000000000..55862785a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/UpdateMultiHostSourcesRequestInnerValue.md @@ -0,0 +1,38 @@ +--- +id: v2024-update-multi-host-sources-request-inner-value +title: UpdateMultiHostSourcesRequestInnerValue +pagination_label: UpdateMultiHostSourcesRequestInnerValue +sidebar_label: UpdateMultiHostSourcesRequestInnerValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UpdateMultiHostSourcesRequestInnerValue', 'V2024UpdateMultiHostSourcesRequestInnerValue'] +slug: /tools/sdk/go/v2024/models/update-multi-host-sources-request-inner-value +tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInnerValue', 'V2024UpdateMultiHostSourcesRequestInnerValue'] +--- + +# UpdateMultiHostSourcesRequestInnerValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewUpdateMultiHostSourcesRequestInnerValue + +`func NewUpdateMultiHostSourcesRequestInnerValue() *UpdateMultiHostSourcesRequestInnerValue` + +NewUpdateMultiHostSourcesRequestInnerValue instantiates a new UpdateMultiHostSourcesRequestInnerValue 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 + +### NewUpdateMultiHostSourcesRequestInnerValueWithDefaults + +`func NewUpdateMultiHostSourcesRequestInnerValueWithDefaults() *UpdateMultiHostSourcesRequestInnerValue` + +NewUpdateMultiHostSourcesRequestInnerValueWithDefaults instantiates a new UpdateMultiHostSourcesRequestInnerValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/UsageType.md b/docs/tools/sdk/go/Reference/V2024/Models/UsageType.md new file mode 100644 index 000000000..cdf2c159d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/UsageType.md @@ -0,0 +1,49 @@ +--- +id: v2024-usage-type +title: UsageType +pagination_label: UsageType +sidebar_label: UsageType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UsageType', 'V2024UsageType'] +slug: /tools/sdk/go/v2024/models/usage-type +tags: ['SDK', 'Software Development Kit', 'UsageType', 'V2024UsageType'] +--- + +# UsageType + +## Enum + + +* `CREATE` (value: `"CREATE"`) + +* `UPDATE` (value: `"UPDATE"`) + +* `ENABLE` (value: `"ENABLE"`) + +* `DISABLE` (value: `"DISABLE"`) + +* `DELETE` (value: `"DELETE"`) + +* `ASSIGN` (value: `"ASSIGN"`) + +* `UNASSIGN` (value: `"UNASSIGN"`) + +* `CREATE_GROUP` (value: `"CREATE_GROUP"`) + +* `UPDATE_GROUP` (value: `"UPDATE_GROUP"`) + +* `DELETE_GROUP` (value: `"DELETE_GROUP"`) + +* `REGISTER` (value: `"REGISTER"`) + +* `CREATE_IDENTITY` (value: `"CREATE_IDENTITY"`) + +* `UPDATE_IDENTITY` (value: `"UPDATE_IDENTITY"`) + +* `EDIT_GROUP` (value: `"EDIT_GROUP"`) + +* `UNLOCK` (value: `"UNLOCK"`) + +* `CHANGE_PASSWORD` (value: `"CHANGE_PASSWORD"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/UserApp.md b/docs/tools/sdk/go/Reference/V2024/Models/UserApp.md new file mode 100644 index 000000000..af5d60283 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/UserApp.md @@ -0,0 +1,324 @@ +--- +id: v2024-user-app +title: UserApp +pagination_label: UserApp +sidebar_label: UserApp +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserApp', 'V2024UserApp'] +slug: /tools/sdk/go/v2024/models/user-app +tags: ['SDK', 'Software Development Kit', 'UserApp', 'V2024UserApp'] +--- + +# UserApp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The user app id | [optional] +**Created** | Pointer to **SailPointTime** | Time when the user app was created | [optional] +**Modified** | Pointer to **SailPointTime** | Time when the user app was last modified | [optional] +**HasMultipleAccounts** | Pointer to **bool** | True if the owner has multiple accounts for the source | [optional] [default to false] +**UseForPasswordManagement** | Pointer to **bool** | True if the source has password feature | [optional] [default to false] +**ProvisionRequestEnabled** | Pointer to **bool** | True if the source app related to the user app is provision request enabled | [optional] [default to false] +**AppCenterEnabled** | Pointer to **bool** | True if the source app related to the user app is shown in the app center | [optional] [default to true] +**SourceApp** | Pointer to [**UserAppSourceApp**](user-app-source-app) | | [optional] +**Source** | Pointer to [**UserAppSource**](user-app-source) | | [optional] +**Account** | Pointer to [**UserAppAccount**](user-app-account) | | [optional] +**Owner** | Pointer to [**UserAppOwner**](user-app-owner) | | [optional] + +## Methods + +### NewUserApp + +`func NewUserApp() *UserApp` + +NewUserApp instantiates a new UserApp 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 + +### NewUserAppWithDefaults + +`func NewUserAppWithDefaults() *UserApp` + +NewUserAppWithDefaults instantiates a new UserApp 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 + +### GetId + +`func (o *UserApp) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserApp) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserApp) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserApp) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreated + +`func (o *UserApp) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *UserApp) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *UserApp) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *UserApp) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *UserApp) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *UserApp) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *UserApp) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *UserApp) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetHasMultipleAccounts + +`func (o *UserApp) GetHasMultipleAccounts() bool` + +GetHasMultipleAccounts returns the HasMultipleAccounts field if non-nil, zero value otherwise. + +### GetHasMultipleAccountsOk + +`func (o *UserApp) GetHasMultipleAccountsOk() (*bool, bool)` + +GetHasMultipleAccountsOk returns a tuple with the HasMultipleAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasMultipleAccounts + +`func (o *UserApp) SetHasMultipleAccounts(v bool)` + +SetHasMultipleAccounts sets HasMultipleAccounts field to given value. + +### HasHasMultipleAccounts + +`func (o *UserApp) HasHasMultipleAccounts() bool` + +HasHasMultipleAccounts returns a boolean if a field has been set. + +### GetUseForPasswordManagement + +`func (o *UserApp) GetUseForPasswordManagement() bool` + +GetUseForPasswordManagement returns the UseForPasswordManagement field if non-nil, zero value otherwise. + +### GetUseForPasswordManagementOk + +`func (o *UserApp) GetUseForPasswordManagementOk() (*bool, bool)` + +GetUseForPasswordManagementOk returns a tuple with the UseForPasswordManagement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseForPasswordManagement + +`func (o *UserApp) SetUseForPasswordManagement(v bool)` + +SetUseForPasswordManagement sets UseForPasswordManagement field to given value. + +### HasUseForPasswordManagement + +`func (o *UserApp) HasUseForPasswordManagement() bool` + +HasUseForPasswordManagement returns a boolean if a field has been set. + +### GetProvisionRequestEnabled + +`func (o *UserApp) GetProvisionRequestEnabled() bool` + +GetProvisionRequestEnabled returns the ProvisionRequestEnabled field if non-nil, zero value otherwise. + +### GetProvisionRequestEnabledOk + +`func (o *UserApp) GetProvisionRequestEnabledOk() (*bool, bool)` + +GetProvisionRequestEnabledOk returns a tuple with the ProvisionRequestEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionRequestEnabled + +`func (o *UserApp) SetProvisionRequestEnabled(v bool)` + +SetProvisionRequestEnabled sets ProvisionRequestEnabled field to given value. + +### HasProvisionRequestEnabled + +`func (o *UserApp) HasProvisionRequestEnabled() bool` + +HasProvisionRequestEnabled returns a boolean if a field has been set. + +### GetAppCenterEnabled + +`func (o *UserApp) GetAppCenterEnabled() bool` + +GetAppCenterEnabled returns the AppCenterEnabled field if non-nil, zero value otherwise. + +### GetAppCenterEnabledOk + +`func (o *UserApp) GetAppCenterEnabledOk() (*bool, bool)` + +GetAppCenterEnabledOk returns a tuple with the AppCenterEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppCenterEnabled + +`func (o *UserApp) SetAppCenterEnabled(v bool)` + +SetAppCenterEnabled sets AppCenterEnabled field to given value. + +### HasAppCenterEnabled + +`func (o *UserApp) HasAppCenterEnabled() bool` + +HasAppCenterEnabled returns a boolean if a field has been set. + +### GetSourceApp + +`func (o *UserApp) GetSourceApp() UserAppSourceApp` + +GetSourceApp returns the SourceApp field if non-nil, zero value otherwise. + +### GetSourceAppOk + +`func (o *UserApp) GetSourceAppOk() (*UserAppSourceApp, bool)` + +GetSourceAppOk returns a tuple with the SourceApp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceApp + +`func (o *UserApp) SetSourceApp(v UserAppSourceApp)` + +SetSourceApp sets SourceApp field to given value. + +### HasSourceApp + +`func (o *UserApp) HasSourceApp() bool` + +HasSourceApp returns a boolean if a field has been set. + +### GetSource + +`func (o *UserApp) GetSource() UserAppSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *UserApp) GetSourceOk() (*UserAppSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *UserApp) SetSource(v UserAppSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *UserApp) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAccount + +`func (o *UserApp) GetAccount() UserAppAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *UserApp) GetAccountOk() (*UserAppAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *UserApp) SetAccount(v UserAppAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *UserApp) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### GetOwner + +`func (o *UserApp) GetOwner() UserAppOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *UserApp) GetOwnerOk() (*UserAppOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *UserApp) SetOwner(v UserAppOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *UserApp) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/UserAppAccount.md b/docs/tools/sdk/go/Reference/V2024/Models/UserAppAccount.md new file mode 100644 index 000000000..79215e2ff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/UserAppAccount.md @@ -0,0 +1,116 @@ +--- +id: v2024-user-app-account +title: UserAppAccount +pagination_label: UserAppAccount +sidebar_label: UserAppAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserAppAccount', 'V2024UserAppAccount'] +slug: /tools/sdk/go/v2024/models/user-app-account +tags: ['SDK', 'Software Development Kit', 'UserAppAccount', 'V2024UserAppAccount'] +--- + +# UserAppAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the account ID | [optional] +**Type** | Pointer to **string** | It will always be \"ACCOUNT\" | [optional] +**Name** | Pointer to **string** | the account name | [optional] + +## Methods + +### NewUserAppAccount + +`func NewUserAppAccount() *UserAppAccount` + +NewUserAppAccount instantiates a new UserAppAccount 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 + +### NewUserAppAccountWithDefaults + +`func NewUserAppAccountWithDefaults() *UserAppAccount` + +NewUserAppAccountWithDefaults instantiates a new UserAppAccount 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 + +### GetId + +`func (o *UserAppAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserAppAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserAppAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserAppAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *UserAppAccount) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UserAppAccount) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *UserAppAccount) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *UserAppAccount) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *UserAppAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UserAppAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UserAppAccount) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *UserAppAccount) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/UserAppOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/UserAppOwner.md new file mode 100644 index 000000000..62ad24aa6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/UserAppOwner.md @@ -0,0 +1,142 @@ +--- +id: v2024-user-app-owner +title: UserAppOwner +pagination_label: UserAppOwner +sidebar_label: UserAppOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserAppOwner', 'V2024UserAppOwner'] +slug: /tools/sdk/go/v2024/models/user-app-owner +tags: ['SDK', 'Software Development Kit', 'UserAppOwner', 'V2024UserAppOwner'] +--- + +# UserAppOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity ID | [optional] +**Type** | Pointer to **string** | It will always be \"IDENTITY\" | [optional] +**Name** | Pointer to **string** | The identity name | [optional] +**Alias** | Pointer to **string** | The identity alias | [optional] + +## Methods + +### NewUserAppOwner + +`func NewUserAppOwner() *UserAppOwner` + +NewUserAppOwner instantiates a new UserAppOwner 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 + +### NewUserAppOwnerWithDefaults + +`func NewUserAppOwnerWithDefaults() *UserAppOwner` + +NewUserAppOwnerWithDefaults instantiates a new UserAppOwner 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 + +### GetId + +`func (o *UserAppOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserAppOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserAppOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserAppOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *UserAppOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UserAppOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *UserAppOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *UserAppOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *UserAppOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UserAppOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UserAppOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *UserAppOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAlias + +`func (o *UserAppOwner) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *UserAppOwner) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *UserAppOwner) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *UserAppOwner) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/UserAppSource.md b/docs/tools/sdk/go/Reference/V2024/Models/UserAppSource.md new file mode 100644 index 000000000..949794f6f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/UserAppSource.md @@ -0,0 +1,116 @@ +--- +id: v2024-user-app-source +title: UserAppSource +pagination_label: UserAppSource +sidebar_label: UserAppSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserAppSource', 'V2024UserAppSource'] +slug: /tools/sdk/go/v2024/models/user-app-source +tags: ['SDK', 'Software Development Kit', 'UserAppSource', 'V2024UserAppSource'] +--- + +# UserAppSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the source ID | [optional] +**Type** | Pointer to **string** | It will always be \"SOURCE\" | [optional] +**Name** | Pointer to **string** | the source name | [optional] + +## Methods + +### NewUserAppSource + +`func NewUserAppSource() *UserAppSource` + +NewUserAppSource instantiates a new UserAppSource 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 + +### NewUserAppSourceWithDefaults + +`func NewUserAppSourceWithDefaults() *UserAppSource` + +NewUserAppSourceWithDefaults instantiates a new UserAppSource 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 + +### GetId + +`func (o *UserAppSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserAppSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserAppSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserAppSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *UserAppSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UserAppSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *UserAppSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *UserAppSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *UserAppSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UserAppSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UserAppSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *UserAppSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/UserAppSourceApp.md b/docs/tools/sdk/go/Reference/V2024/Models/UserAppSourceApp.md new file mode 100644 index 000000000..ffdfda544 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/UserAppSourceApp.md @@ -0,0 +1,116 @@ +--- +id: v2024-user-app-source-app +title: UserAppSourceApp +pagination_label: UserAppSourceApp +sidebar_label: UserAppSourceApp +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserAppSourceApp', 'V2024UserAppSourceApp'] +slug: /tools/sdk/go/v2024/models/user-app-source-app +tags: ['SDK', 'Software Development Kit', 'UserAppSourceApp', 'V2024UserAppSourceApp'] +--- + +# UserAppSourceApp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the source app ID | [optional] +**Type** | Pointer to **string** | It will always be \"APPLICATION\" | [optional] +**Name** | Pointer to **string** | the source app name | [optional] + +## Methods + +### NewUserAppSourceApp + +`func NewUserAppSourceApp() *UserAppSourceApp` + +NewUserAppSourceApp instantiates a new UserAppSourceApp 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 + +### NewUserAppSourceAppWithDefaults + +`func NewUserAppSourceAppWithDefaults() *UserAppSourceApp` + +NewUserAppSourceAppWithDefaults instantiates a new UserAppSourceApp 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 + +### GetId + +`func (o *UserAppSourceApp) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserAppSourceApp) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserAppSourceApp) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserAppSourceApp) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *UserAppSourceApp) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UserAppSourceApp) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *UserAppSourceApp) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *UserAppSourceApp) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *UserAppSourceApp) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UserAppSourceApp) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UserAppSourceApp) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *UserAppSourceApp) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/V3ConnectorDto.md b/docs/tools/sdk/go/Reference/V2024/Models/V3ConnectorDto.md new file mode 100644 index 000000000..6a4d8cf40 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/V3ConnectorDto.md @@ -0,0 +1,266 @@ +--- +id: v2024-v3-connector-dto +title: V3ConnectorDto +pagination_label: V3ConnectorDto +sidebar_label: V3ConnectorDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'V3ConnectorDto', 'V2024V3ConnectorDto'] +slug: /tools/sdk/go/v2024/models/v3-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3ConnectorDto', 'V2024V3ConnectorDto'] +--- + +# V3ConnectorDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The connector name | [optional] +**Type** | Pointer to **string** | The connector type | [optional] +**ScriptName** | Pointer to **string** | The connector script name | [optional] +**ClassName** | Pointer to **NullableString** | The connector class name. | [optional] +**Features** | Pointer to **[]string** | The list of features supported by the connector | [optional] +**DirectConnect** | Pointer to **bool** | true if the source is a direct connect source | [optional] [default to false] +**ConnectorMetadata** | Pointer to **map[string]interface{}** | A map containing metadata pertinent to the connector | [optional] +**Status** | Pointer to **string** | The connector status | [optional] + +## Methods + +### NewV3ConnectorDto + +`func NewV3ConnectorDto() *V3ConnectorDto` + +NewV3ConnectorDto instantiates a new V3ConnectorDto 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 + +### NewV3ConnectorDtoWithDefaults + +`func NewV3ConnectorDtoWithDefaults() *V3ConnectorDto` + +NewV3ConnectorDtoWithDefaults instantiates a new V3ConnectorDto 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 + +### GetName + +`func (o *V3ConnectorDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *V3ConnectorDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *V3ConnectorDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *V3ConnectorDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *V3ConnectorDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *V3ConnectorDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *V3ConnectorDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *V3ConnectorDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetScriptName + +`func (o *V3ConnectorDto) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *V3ConnectorDto) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *V3ConnectorDto) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + +### HasScriptName + +`func (o *V3ConnectorDto) HasScriptName() bool` + +HasScriptName returns a boolean if a field has been set. + +### GetClassName + +`func (o *V3ConnectorDto) GetClassName() string` + +GetClassName returns the ClassName field if non-nil, zero value otherwise. + +### GetClassNameOk + +`func (o *V3ConnectorDto) GetClassNameOk() (*string, bool)` + +GetClassNameOk returns a tuple with the ClassName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClassName + +`func (o *V3ConnectorDto) SetClassName(v string)` + +SetClassName sets ClassName field to given value. + +### HasClassName + +`func (o *V3ConnectorDto) HasClassName() bool` + +HasClassName returns a boolean if a field has been set. + +### SetClassNameNil + +`func (o *V3ConnectorDto) SetClassNameNil(b bool)` + + SetClassNameNil sets the value for ClassName to be an explicit nil + +### UnsetClassName +`func (o *V3ConnectorDto) UnsetClassName()` + +UnsetClassName ensures that no value is present for ClassName, not even an explicit nil +### GetFeatures + +`func (o *V3ConnectorDto) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *V3ConnectorDto) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *V3ConnectorDto) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *V3ConnectorDto) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### SetFeaturesNil + +`func (o *V3ConnectorDto) SetFeaturesNil(b bool)` + + SetFeaturesNil sets the value for Features to be an explicit nil + +### UnsetFeatures +`func (o *V3ConnectorDto) UnsetFeatures()` + +UnsetFeatures ensures that no value is present for Features, not even an explicit nil +### GetDirectConnect + +`func (o *V3ConnectorDto) GetDirectConnect() bool` + +GetDirectConnect returns the DirectConnect field if non-nil, zero value otherwise. + +### GetDirectConnectOk + +`func (o *V3ConnectorDto) GetDirectConnectOk() (*bool, bool)` + +GetDirectConnectOk returns a tuple with the DirectConnect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectConnect + +`func (o *V3ConnectorDto) SetDirectConnect(v bool)` + +SetDirectConnect sets DirectConnect field to given value. + +### HasDirectConnect + +`func (o *V3ConnectorDto) HasDirectConnect() bool` + +HasDirectConnect returns a boolean if a field has been set. + +### GetConnectorMetadata + +`func (o *V3ConnectorDto) GetConnectorMetadata() map[string]interface{}` + +GetConnectorMetadata returns the ConnectorMetadata field if non-nil, zero value otherwise. + +### GetConnectorMetadataOk + +`func (o *V3ConnectorDto) GetConnectorMetadataOk() (*map[string]interface{}, bool)` + +GetConnectorMetadataOk returns a tuple with the ConnectorMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorMetadata + +`func (o *V3ConnectorDto) SetConnectorMetadata(v map[string]interface{})` + +SetConnectorMetadata sets ConnectorMetadata field to given value. + +### HasConnectorMetadata + +`func (o *V3ConnectorDto) HasConnectorMetadata() bool` + +HasConnectorMetadata returns a boolean if a field has been set. + +### GetStatus + +`func (o *V3ConnectorDto) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *V3ConnectorDto) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *V3ConnectorDto) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *V3ConnectorDto) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/V3CreateConnectorDto.md b/docs/tools/sdk/go/Reference/V2024/Models/V3CreateConnectorDto.md new file mode 100644 index 000000000..cbe5c52ff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/V3CreateConnectorDto.md @@ -0,0 +1,158 @@ +--- +id: v2024-v3-create-connector-dto +title: V3CreateConnectorDto +pagination_label: V3CreateConnectorDto +sidebar_label: V3CreateConnectorDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'V3CreateConnectorDto', 'V2024V3CreateConnectorDto'] +slug: /tools/sdk/go/v2024/models/v3-create-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3CreateConnectorDto', 'V2024V3CreateConnectorDto'] +--- + +# V3CreateConnectorDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints | +**Type** | Pointer to **string** | The connector type. If not specified will be defaulted to 'custom '+name | [optional] +**ClassName** | **string** | The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter | +**DirectConnect** | Pointer to **bool** | true if the source is a direct connect source | [optional] [default to true] +**Status** | Pointer to **string** | The connector status | [optional] + +## Methods + +### NewV3CreateConnectorDto + +`func NewV3CreateConnectorDto(name string, className string, ) *V3CreateConnectorDto` + +NewV3CreateConnectorDto instantiates a new V3CreateConnectorDto 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 + +### NewV3CreateConnectorDtoWithDefaults + +`func NewV3CreateConnectorDtoWithDefaults() *V3CreateConnectorDto` + +NewV3CreateConnectorDtoWithDefaults instantiates a new V3CreateConnectorDto 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 + +### GetName + +`func (o *V3CreateConnectorDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *V3CreateConnectorDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *V3CreateConnectorDto) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *V3CreateConnectorDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *V3CreateConnectorDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *V3CreateConnectorDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *V3CreateConnectorDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetClassName + +`func (o *V3CreateConnectorDto) GetClassName() string` + +GetClassName returns the ClassName field if non-nil, zero value otherwise. + +### GetClassNameOk + +`func (o *V3CreateConnectorDto) GetClassNameOk() (*string, bool)` + +GetClassNameOk returns a tuple with the ClassName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClassName + +`func (o *V3CreateConnectorDto) SetClassName(v string)` + +SetClassName sets ClassName field to given value. + + +### GetDirectConnect + +`func (o *V3CreateConnectorDto) GetDirectConnect() bool` + +GetDirectConnect returns the DirectConnect field if non-nil, zero value otherwise. + +### GetDirectConnectOk + +`func (o *V3CreateConnectorDto) GetDirectConnectOk() (*bool, bool)` + +GetDirectConnectOk returns a tuple with the DirectConnect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectConnect + +`func (o *V3CreateConnectorDto) SetDirectConnect(v bool)` + +SetDirectConnect sets DirectConnect field to given value. + +### HasDirectConnect + +`func (o *V3CreateConnectorDto) HasDirectConnect() bool` + +HasDirectConnect returns a boolean if a field has been set. + +### GetStatus + +`func (o *V3CreateConnectorDto) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *V3CreateConnectorDto) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *V3CreateConnectorDto) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *V3CreateConnectorDto) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/VAClusterStatusChangeEvent.md b/docs/tools/sdk/go/Reference/V2024/Models/VAClusterStatusChangeEvent.md new file mode 100644 index 000000000..fcff13082 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/VAClusterStatusChangeEvent.md @@ -0,0 +1,143 @@ +--- +id: v2024-va-cluster-status-change-event +title: VAClusterStatusChangeEvent +pagination_label: VAClusterStatusChangeEvent +sidebar_label: VAClusterStatusChangeEvent +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VAClusterStatusChangeEvent', 'V2024VAClusterStatusChangeEvent'] +slug: /tools/sdk/go/v2024/models/va-cluster-status-change-event +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEvent', 'V2024VAClusterStatusChangeEvent'] +--- + +# VAClusterStatusChangeEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | **SailPointTime** | The date and time the status change occurred. | +**Type** | **map[string]interface{}** | The type of the object that initiated this event. | +**Application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | +**HealthCheckResult** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | +**PreviousHealthCheckResult** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | + +## Methods + +### NewVAClusterStatusChangeEvent + +`func NewVAClusterStatusChangeEvent(created SailPointTime, type_ map[string]interface{}, application VAClusterStatusChangeEventApplication, healthCheckResult VAClusterStatusChangeEventHealthCheckResult, previousHealthCheckResult VAClusterStatusChangeEventPreviousHealthCheckResult, ) *VAClusterStatusChangeEvent` + +NewVAClusterStatusChangeEvent instantiates a new VAClusterStatusChangeEvent 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 + +### NewVAClusterStatusChangeEventWithDefaults + +`func NewVAClusterStatusChangeEventWithDefaults() *VAClusterStatusChangeEvent` + +NewVAClusterStatusChangeEventWithDefaults instantiates a new VAClusterStatusChangeEvent 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 + +### GetCreated + +`func (o *VAClusterStatusChangeEvent) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *VAClusterStatusChangeEvent) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *VAClusterStatusChangeEvent) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetType + +`func (o *VAClusterStatusChangeEvent) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *VAClusterStatusChangeEvent) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *VAClusterStatusChangeEvent) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetApplication + +`func (o *VAClusterStatusChangeEvent) GetApplication() VAClusterStatusChangeEventApplication` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *VAClusterStatusChangeEvent) GetApplicationOk() (*VAClusterStatusChangeEventApplication, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *VAClusterStatusChangeEvent) SetApplication(v VAClusterStatusChangeEventApplication)` + +SetApplication sets Application field to given value. + + +### GetHealthCheckResult + +`func (o *VAClusterStatusChangeEvent) GetHealthCheckResult() VAClusterStatusChangeEventHealthCheckResult` + +GetHealthCheckResult returns the HealthCheckResult field if non-nil, zero value otherwise. + +### GetHealthCheckResultOk + +`func (o *VAClusterStatusChangeEvent) GetHealthCheckResultOk() (*VAClusterStatusChangeEventHealthCheckResult, bool)` + +GetHealthCheckResultOk returns a tuple with the HealthCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthCheckResult + +`func (o *VAClusterStatusChangeEvent) SetHealthCheckResult(v VAClusterStatusChangeEventHealthCheckResult)` + +SetHealthCheckResult sets HealthCheckResult field to given value. + + +### GetPreviousHealthCheckResult + +`func (o *VAClusterStatusChangeEvent) GetPreviousHealthCheckResult() VAClusterStatusChangeEventPreviousHealthCheckResult` + +GetPreviousHealthCheckResult returns the PreviousHealthCheckResult field if non-nil, zero value otherwise. + +### GetPreviousHealthCheckResultOk + +`func (o *VAClusterStatusChangeEvent) GetPreviousHealthCheckResultOk() (*VAClusterStatusChangeEventPreviousHealthCheckResult, bool)` + +GetPreviousHealthCheckResultOk returns a tuple with the PreviousHealthCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousHealthCheckResult + +`func (o *VAClusterStatusChangeEvent) SetPreviousHealthCheckResult(v VAClusterStatusChangeEventPreviousHealthCheckResult)` + +SetPreviousHealthCheckResult sets PreviousHealthCheckResult field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/VAClusterStatusChangeEventApplication.md b/docs/tools/sdk/go/Reference/V2024/Models/VAClusterStatusChangeEventApplication.md new file mode 100644 index 000000000..157a7969c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/VAClusterStatusChangeEventApplication.md @@ -0,0 +1,111 @@ +--- +id: v2024-va-cluster-status-change-event-application +title: VAClusterStatusChangeEventApplication +pagination_label: VAClusterStatusChangeEventApplication +sidebar_label: VAClusterStatusChangeEventApplication +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VAClusterStatusChangeEventApplication', 'V2024VAClusterStatusChangeEventApplication'] +slug: /tools/sdk/go/v2024/models/va-cluster-status-change-event-application +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventApplication', 'V2024VAClusterStatusChangeEventApplication'] +--- + +# VAClusterStatusChangeEventApplication + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The GUID of the application | +**Name** | **string** | The name of the application | +**Attributes** | **map[string]interface{}** | Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. | + +## Methods + +### NewVAClusterStatusChangeEventApplication + +`func NewVAClusterStatusChangeEventApplication(id string, name string, attributes map[string]interface{}, ) *VAClusterStatusChangeEventApplication` + +NewVAClusterStatusChangeEventApplication instantiates a new VAClusterStatusChangeEventApplication 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 + +### NewVAClusterStatusChangeEventApplicationWithDefaults + +`func NewVAClusterStatusChangeEventApplicationWithDefaults() *VAClusterStatusChangeEventApplication` + +NewVAClusterStatusChangeEventApplicationWithDefaults instantiates a new VAClusterStatusChangeEventApplication 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 + +### GetId + +`func (o *VAClusterStatusChangeEventApplication) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *VAClusterStatusChangeEventApplication) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *VAClusterStatusChangeEventApplication) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *VAClusterStatusChangeEventApplication) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *VAClusterStatusChangeEventApplication) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *VAClusterStatusChangeEventApplication) SetName(v string)` + +SetName sets Name field to given value. + + +### GetAttributes + +`func (o *VAClusterStatusChangeEventApplication) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *VAClusterStatusChangeEventApplication) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *VAClusterStatusChangeEventApplication) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *VAClusterStatusChangeEventApplication) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *VAClusterStatusChangeEventApplication) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/VAClusterStatusChangeEventHealthCheckResult.md b/docs/tools/sdk/go/Reference/V2024/Models/VAClusterStatusChangeEventHealthCheckResult.md new file mode 100644 index 000000000..da0dbf9d9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/VAClusterStatusChangeEventHealthCheckResult.md @@ -0,0 +1,101 @@ +--- +id: v2024-va-cluster-status-change-event-health-check-result +title: VAClusterStatusChangeEventHealthCheckResult +pagination_label: VAClusterStatusChangeEventHealthCheckResult +sidebar_label: VAClusterStatusChangeEventHealthCheckResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VAClusterStatusChangeEventHealthCheckResult', 'V2024VAClusterStatusChangeEventHealthCheckResult'] +slug: /tools/sdk/go/v2024/models/va-cluster-status-change-event-health-check-result +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventHealthCheckResult', 'V2024VAClusterStatusChangeEventHealthCheckResult'] +--- + +# VAClusterStatusChangeEventHealthCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | **string** | Detailed message of the result of the health check. | +**ResultType** | **string** | The type of the health check result. | +**Status** | **map[string]interface{}** | The status of the health check. | + +## Methods + +### NewVAClusterStatusChangeEventHealthCheckResult + +`func NewVAClusterStatusChangeEventHealthCheckResult(message string, resultType string, status map[string]interface{}, ) *VAClusterStatusChangeEventHealthCheckResult` + +NewVAClusterStatusChangeEventHealthCheckResult instantiates a new VAClusterStatusChangeEventHealthCheckResult 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 + +### NewVAClusterStatusChangeEventHealthCheckResultWithDefaults + +`func NewVAClusterStatusChangeEventHealthCheckResultWithDefaults() *VAClusterStatusChangeEventHealthCheckResult` + +NewVAClusterStatusChangeEventHealthCheckResultWithDefaults instantiates a new VAClusterStatusChangeEventHealthCheckResult 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 + +### GetMessage + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *VAClusterStatusChangeEventHealthCheckResult) SetMessage(v string)` + +SetMessage sets Message field to given value. + + +### GetResultType + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetResultType() string` + +GetResultType returns the ResultType field if non-nil, zero value otherwise. + +### GetResultTypeOk + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetResultTypeOk() (*string, bool)` + +GetResultTypeOk returns a tuple with the ResultType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultType + +`func (o *VAClusterStatusChangeEventHealthCheckResult) SetResultType(v string)` + +SetResultType sets ResultType field to given value. + + +### GetStatus + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *VAClusterStatusChangeEventHealthCheckResult) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md b/docs/tools/sdk/go/Reference/V2024/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md new file mode 100644 index 000000000..f90c3ded5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md @@ -0,0 +1,101 @@ +--- +id: v2024-va-cluster-status-change-event-previous-health-check-result +title: VAClusterStatusChangeEventPreviousHealthCheckResult +pagination_label: VAClusterStatusChangeEventPreviousHealthCheckResult +sidebar_label: VAClusterStatusChangeEventPreviousHealthCheckResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VAClusterStatusChangeEventPreviousHealthCheckResult', 'V2024VAClusterStatusChangeEventPreviousHealthCheckResult'] +slug: /tools/sdk/go/v2024/models/va-cluster-status-change-event-previous-health-check-result +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventPreviousHealthCheckResult', 'V2024VAClusterStatusChangeEventPreviousHealthCheckResult'] +--- + +# VAClusterStatusChangeEventPreviousHealthCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | **string** | Detailed message of the result of the health check. | +**ResultType** | **string** | The type of the health check result. | +**Status** | **map[string]interface{}** | The status of the health check. | + +## Methods + +### NewVAClusterStatusChangeEventPreviousHealthCheckResult + +`func NewVAClusterStatusChangeEventPreviousHealthCheckResult(message string, resultType string, status map[string]interface{}, ) *VAClusterStatusChangeEventPreviousHealthCheckResult` + +NewVAClusterStatusChangeEventPreviousHealthCheckResult instantiates a new VAClusterStatusChangeEventPreviousHealthCheckResult 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 + +### NewVAClusterStatusChangeEventPreviousHealthCheckResultWithDefaults + +`func NewVAClusterStatusChangeEventPreviousHealthCheckResultWithDefaults() *VAClusterStatusChangeEventPreviousHealthCheckResult` + +NewVAClusterStatusChangeEventPreviousHealthCheckResultWithDefaults instantiates a new VAClusterStatusChangeEventPreviousHealthCheckResult 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 + +### GetMessage + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) SetMessage(v string)` + +SetMessage sets Message field to given value. + + +### GetResultType + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetResultType() string` + +GetResultType returns the ResultType field if non-nil, zero value otherwise. + +### GetResultTypeOk + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetResultTypeOk() (*string, bool)` + +GetResultTypeOk returns a tuple with the ResultType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultType + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) SetResultType(v string)` + +SetResultType sets ResultType field to given value. + + +### GetStatus + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ValidateFilterInputDto.md b/docs/tools/sdk/go/Reference/V2024/Models/ValidateFilterInputDto.md new file mode 100644 index 000000000..2c6c478cb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ValidateFilterInputDto.md @@ -0,0 +1,80 @@ +--- +id: v2024-validate-filter-input-dto +title: ValidateFilterInputDto +pagination_label: ValidateFilterInputDto +sidebar_label: ValidateFilterInputDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ValidateFilterInputDto', 'V2024ValidateFilterInputDto'] +slug: /tools/sdk/go/v2024/models/validate-filter-input-dto +tags: ['SDK', 'Software Development Kit', 'ValidateFilterInputDto', 'V2024ValidateFilterInputDto'] +--- + +# ValidateFilterInputDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | **map[string]interface{}** | Mock input to evaluate filter expression against. | +**Filter** | **string** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | + +## Methods + +### NewValidateFilterInputDto + +`func NewValidateFilterInputDto(input map[string]interface{}, filter string, ) *ValidateFilterInputDto` + +NewValidateFilterInputDto instantiates a new ValidateFilterInputDto 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 + +### NewValidateFilterInputDtoWithDefaults + +`func NewValidateFilterInputDtoWithDefaults() *ValidateFilterInputDto` + +NewValidateFilterInputDtoWithDefaults instantiates a new ValidateFilterInputDto 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 + +### GetInput + +`func (o *ValidateFilterInputDto) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *ValidateFilterInputDto) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *ValidateFilterInputDto) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + + +### GetFilter + +`func (o *ValidateFilterInputDto) GetFilter() string` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *ValidateFilterInputDto) GetFilterOk() (*string, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *ValidateFilterInputDto) SetFilter(v string)` + +SetFilter sets Filter field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ValidateFilterOutputDto.md b/docs/tools/sdk/go/Reference/V2024/Models/ValidateFilterOutputDto.md new file mode 100644 index 000000000..e38e297a9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ValidateFilterOutputDto.md @@ -0,0 +1,116 @@ +--- +id: v2024-validate-filter-output-dto +title: ValidateFilterOutputDto +pagination_label: ValidateFilterOutputDto +sidebar_label: ValidateFilterOutputDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ValidateFilterOutputDto', 'V2024ValidateFilterOutputDto'] +slug: /tools/sdk/go/v2024/models/validate-filter-output-dto +tags: ['SDK', 'Software Development Kit', 'ValidateFilterOutputDto', 'V2024ValidateFilterOutputDto'] +--- + +# ValidateFilterOutputDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsValid** | Pointer to **bool** | When this field is true, the filter expression is valid against the input. | [optional] [default to false] +**IsValidJSONPath** | Pointer to **bool** | When this field is true, the filter expression is using a valid JSON path. | [optional] [default to false] +**IsPathExist** | Pointer to **bool** | When this field is true, the filter expression is using an existing path. | [optional] [default to false] + +## Methods + +### NewValidateFilterOutputDto + +`func NewValidateFilterOutputDto() *ValidateFilterOutputDto` + +NewValidateFilterOutputDto instantiates a new ValidateFilterOutputDto 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 + +### NewValidateFilterOutputDtoWithDefaults + +`func NewValidateFilterOutputDtoWithDefaults() *ValidateFilterOutputDto` + +NewValidateFilterOutputDtoWithDefaults instantiates a new ValidateFilterOutputDto 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 + +### GetIsValid + +`func (o *ValidateFilterOutputDto) GetIsValid() bool` + +GetIsValid returns the IsValid field if non-nil, zero value otherwise. + +### GetIsValidOk + +`func (o *ValidateFilterOutputDto) GetIsValidOk() (*bool, bool)` + +GetIsValidOk returns a tuple with the IsValid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsValid + +`func (o *ValidateFilterOutputDto) SetIsValid(v bool)` + +SetIsValid sets IsValid field to given value. + +### HasIsValid + +`func (o *ValidateFilterOutputDto) HasIsValid() bool` + +HasIsValid returns a boolean if a field has been set. + +### GetIsValidJSONPath + +`func (o *ValidateFilterOutputDto) GetIsValidJSONPath() bool` + +GetIsValidJSONPath returns the IsValidJSONPath field if non-nil, zero value otherwise. + +### GetIsValidJSONPathOk + +`func (o *ValidateFilterOutputDto) GetIsValidJSONPathOk() (*bool, bool)` + +GetIsValidJSONPathOk returns a tuple with the IsValidJSONPath field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsValidJSONPath + +`func (o *ValidateFilterOutputDto) SetIsValidJSONPath(v bool)` + +SetIsValidJSONPath sets IsValidJSONPath field to given value. + +### HasIsValidJSONPath + +`func (o *ValidateFilterOutputDto) HasIsValidJSONPath() bool` + +HasIsValidJSONPath returns a boolean if a field has been set. + +### GetIsPathExist + +`func (o *ValidateFilterOutputDto) GetIsPathExist() bool` + +GetIsPathExist returns the IsPathExist field if non-nil, zero value otherwise. + +### GetIsPathExistOk + +`func (o *ValidateFilterOutputDto) GetIsPathExistOk() (*bool, bool)` + +GetIsPathExistOk returns a tuple with the IsPathExist field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsPathExist + +`func (o *ValidateFilterOutputDto) SetIsPathExist(v bool)` + +SetIsPathExist sets IsPathExist field to given value. + +### HasIsPathExist + +`func (o *ValidateFilterOutputDto) HasIsPathExist() bool` + +HasIsPathExist returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Value.md b/docs/tools/sdk/go/Reference/V2024/Models/Value.md new file mode 100644 index 000000000..285700295 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Value.md @@ -0,0 +1,90 @@ +--- +id: v2024-value +title: Value +pagination_label: Value +sidebar_label: Value +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Value', 'V2024Value'] +slug: /tools/sdk/go/v2024/models/value +tags: ['SDK', 'Software Development Kit', 'Value', 'V2024Value'] +--- + +# Value + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of attribute value | [optional] +**Value** | Pointer to **string** | The attribute value | [optional] + +## Methods + +### NewValue + +`func NewValue() *Value` + +NewValue instantiates a new Value 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 + +### NewValueWithDefaults + +`func NewValueWithDefaults() *Value` + +NewValueWithDefaults instantiates a new Value 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 + +### GetType + +`func (o *Value) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Value) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Value) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Value) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetValue + +`func (o *Value) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Value) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Value) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Value) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/VendorConnectorMapping.md b/docs/tools/sdk/go/Reference/V2024/Models/VendorConnectorMapping.md new file mode 100644 index 000000000..d2b1224a7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/VendorConnectorMapping.md @@ -0,0 +1,312 @@ +--- +id: v2024-vendor-connector-mapping +title: VendorConnectorMapping +pagination_label: VendorConnectorMapping +sidebar_label: VendorConnectorMapping +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMapping', 'V2024VendorConnectorMapping'] +slug: /tools/sdk/go/v2024/models/vendor-connector-mapping +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMapping', 'V2024VendorConnectorMapping'] +--- + +# VendorConnectorMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique identifier for the vendor-connector mapping. | [optional] +**Vendor** | Pointer to **string** | The name of the vendor. | [optional] +**Connector** | Pointer to **string** | The name of the connector. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The creation timestamp of the mapping. | [optional] +**CreatedBy** | Pointer to **string** | The identifier of the user who created the mapping. | [optional] +**UpdatedAt** | Pointer to [**NullableVendorConnectorMappingUpdatedAt**](vendor-connector-mapping-updated-at) | | [optional] +**UpdatedBy** | Pointer to [**NullableVendorConnectorMappingUpdatedBy**](vendor-connector-mapping-updated-by) | | [optional] +**DeletedAt** | Pointer to [**NullableVendorConnectorMappingDeletedAt**](vendor-connector-mapping-deleted-at) | | [optional] +**DeletedBy** | Pointer to [**NullableVendorConnectorMappingDeletedBy**](vendor-connector-mapping-deleted-by) | | [optional] + +## Methods + +### NewVendorConnectorMapping + +`func NewVendorConnectorMapping() *VendorConnectorMapping` + +NewVendorConnectorMapping instantiates a new VendorConnectorMapping 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 + +### NewVendorConnectorMappingWithDefaults + +`func NewVendorConnectorMappingWithDefaults() *VendorConnectorMapping` + +NewVendorConnectorMappingWithDefaults instantiates a new VendorConnectorMapping 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 + +### GetId + +`func (o *VendorConnectorMapping) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *VendorConnectorMapping) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *VendorConnectorMapping) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *VendorConnectorMapping) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetVendor + +`func (o *VendorConnectorMapping) GetVendor() string` + +GetVendor returns the Vendor field if non-nil, zero value otherwise. + +### GetVendorOk + +`func (o *VendorConnectorMapping) GetVendorOk() (*string, bool)` + +GetVendorOk returns a tuple with the Vendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVendor + +`func (o *VendorConnectorMapping) SetVendor(v string)` + +SetVendor sets Vendor field to given value. + +### HasVendor + +`func (o *VendorConnectorMapping) HasVendor() bool` + +HasVendor returns a boolean if a field has been set. + +### GetConnector + +`func (o *VendorConnectorMapping) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *VendorConnectorMapping) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *VendorConnectorMapping) SetConnector(v string)` + +SetConnector sets Connector field to given value. + +### HasConnector + +`func (o *VendorConnectorMapping) HasConnector() bool` + +HasConnector returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *VendorConnectorMapping) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *VendorConnectorMapping) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *VendorConnectorMapping) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *VendorConnectorMapping) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetCreatedBy + +`func (o *VendorConnectorMapping) GetCreatedBy() string` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *VendorConnectorMapping) GetCreatedByOk() (*string, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *VendorConnectorMapping) SetCreatedBy(v string)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *VendorConnectorMapping) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetUpdatedAt + +`func (o *VendorConnectorMapping) GetUpdatedAt() VendorConnectorMappingUpdatedAt` + +GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise. + +### GetUpdatedAtOk + +`func (o *VendorConnectorMapping) GetUpdatedAtOk() (*VendorConnectorMappingUpdatedAt, bool)` + +GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedAt + +`func (o *VendorConnectorMapping) SetUpdatedAt(v VendorConnectorMappingUpdatedAt)` + +SetUpdatedAt sets UpdatedAt field to given value. + +### HasUpdatedAt + +`func (o *VendorConnectorMapping) HasUpdatedAt() bool` + +HasUpdatedAt returns a boolean if a field has been set. + +### SetUpdatedAtNil + +`func (o *VendorConnectorMapping) SetUpdatedAtNil(b bool)` + + SetUpdatedAtNil sets the value for UpdatedAt to be an explicit nil + +### UnsetUpdatedAt +`func (o *VendorConnectorMapping) UnsetUpdatedAt()` + +UnsetUpdatedAt ensures that no value is present for UpdatedAt, not even an explicit nil +### GetUpdatedBy + +`func (o *VendorConnectorMapping) GetUpdatedBy() VendorConnectorMappingUpdatedBy` + +GetUpdatedBy returns the UpdatedBy field if non-nil, zero value otherwise. + +### GetUpdatedByOk + +`func (o *VendorConnectorMapping) GetUpdatedByOk() (*VendorConnectorMappingUpdatedBy, bool)` + +GetUpdatedByOk returns a tuple with the UpdatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedBy + +`func (o *VendorConnectorMapping) SetUpdatedBy(v VendorConnectorMappingUpdatedBy)` + +SetUpdatedBy sets UpdatedBy field to given value. + +### HasUpdatedBy + +`func (o *VendorConnectorMapping) HasUpdatedBy() bool` + +HasUpdatedBy returns a boolean if a field has been set. + +### SetUpdatedByNil + +`func (o *VendorConnectorMapping) SetUpdatedByNil(b bool)` + + SetUpdatedByNil sets the value for UpdatedBy to be an explicit nil + +### UnsetUpdatedBy +`func (o *VendorConnectorMapping) UnsetUpdatedBy()` + +UnsetUpdatedBy ensures that no value is present for UpdatedBy, not even an explicit nil +### GetDeletedAt + +`func (o *VendorConnectorMapping) GetDeletedAt() VendorConnectorMappingDeletedAt` + +GetDeletedAt returns the DeletedAt field if non-nil, zero value otherwise. + +### GetDeletedAtOk + +`func (o *VendorConnectorMapping) GetDeletedAtOk() (*VendorConnectorMappingDeletedAt, bool)` + +GetDeletedAtOk returns a tuple with the DeletedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeletedAt + +`func (o *VendorConnectorMapping) SetDeletedAt(v VendorConnectorMappingDeletedAt)` + +SetDeletedAt sets DeletedAt field to given value. + +### HasDeletedAt + +`func (o *VendorConnectorMapping) HasDeletedAt() bool` + +HasDeletedAt returns a boolean if a field has been set. + +### SetDeletedAtNil + +`func (o *VendorConnectorMapping) SetDeletedAtNil(b bool)` + + SetDeletedAtNil sets the value for DeletedAt to be an explicit nil + +### UnsetDeletedAt +`func (o *VendorConnectorMapping) UnsetDeletedAt()` + +UnsetDeletedAt ensures that no value is present for DeletedAt, not even an explicit nil +### GetDeletedBy + +`func (o *VendorConnectorMapping) GetDeletedBy() VendorConnectorMappingDeletedBy` + +GetDeletedBy returns the DeletedBy field if non-nil, zero value otherwise. + +### GetDeletedByOk + +`func (o *VendorConnectorMapping) GetDeletedByOk() (*VendorConnectorMappingDeletedBy, bool)` + +GetDeletedByOk returns a tuple with the DeletedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeletedBy + +`func (o *VendorConnectorMapping) SetDeletedBy(v VendorConnectorMappingDeletedBy)` + +SetDeletedBy sets DeletedBy field to given value. + +### HasDeletedBy + +`func (o *VendorConnectorMapping) HasDeletedBy() bool` + +HasDeletedBy returns a boolean if a field has been set. + +### SetDeletedByNil + +`func (o *VendorConnectorMapping) SetDeletedByNil(b bool)` + + SetDeletedByNil sets the value for DeletedBy to be an explicit nil + +### UnsetDeletedBy +`func (o *VendorConnectorMapping) UnsetDeletedBy()` + +UnsetDeletedBy ensures that no value is present for DeletedBy, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/VendorConnectorMappingDeletedAt.md b/docs/tools/sdk/go/Reference/V2024/Models/VendorConnectorMappingDeletedAt.md new file mode 100644 index 000000000..11390634e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/VendorConnectorMappingDeletedAt.md @@ -0,0 +1,90 @@ +--- +id: v2024-vendor-connector-mapping-deleted-at +title: VendorConnectorMappingDeletedAt +pagination_label: VendorConnectorMappingDeletedAt +sidebar_label: VendorConnectorMappingDeletedAt +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappingDeletedAt', 'V2024VendorConnectorMappingDeletedAt'] +slug: /tools/sdk/go/v2024/models/vendor-connector-mapping-deleted-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedAt', 'V2024VendorConnectorMappingDeletedAt'] +--- + +# VendorConnectorMappingDeletedAt + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Time** | Pointer to **SailPointTime** | The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable. | [optional] +**Valid** | Pointer to **bool** | A flag indicating if the 'Time' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to false] + +## Methods + +### NewVendorConnectorMappingDeletedAt + +`func NewVendorConnectorMappingDeletedAt() *VendorConnectorMappingDeletedAt` + +NewVendorConnectorMappingDeletedAt instantiates a new VendorConnectorMappingDeletedAt 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 + +### NewVendorConnectorMappingDeletedAtWithDefaults + +`func NewVendorConnectorMappingDeletedAtWithDefaults() *VendorConnectorMappingDeletedAt` + +NewVendorConnectorMappingDeletedAtWithDefaults instantiates a new VendorConnectorMappingDeletedAt 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 + +### GetTime + +`func (o *VendorConnectorMappingDeletedAt) GetTime() SailPointTime` + +GetTime returns the Time field if non-nil, zero value otherwise. + +### GetTimeOk + +`func (o *VendorConnectorMappingDeletedAt) GetTimeOk() (*SailPointTime, bool)` + +GetTimeOk returns a tuple with the Time field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTime + +`func (o *VendorConnectorMappingDeletedAt) SetTime(v SailPointTime)` + +SetTime sets Time field to given value. + +### HasTime + +`func (o *VendorConnectorMappingDeletedAt) HasTime() bool` + +HasTime returns a boolean if a field has been set. + +### GetValid + +`func (o *VendorConnectorMappingDeletedAt) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *VendorConnectorMappingDeletedAt) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *VendorConnectorMappingDeletedAt) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *VendorConnectorMappingDeletedAt) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/VendorConnectorMappingDeletedBy.md b/docs/tools/sdk/go/Reference/V2024/Models/VendorConnectorMappingDeletedBy.md new file mode 100644 index 000000000..dc59dccaf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/VendorConnectorMappingDeletedBy.md @@ -0,0 +1,90 @@ +--- +id: v2024-vendor-connector-mapping-deleted-by +title: VendorConnectorMappingDeletedBy +pagination_label: VendorConnectorMappingDeletedBy +sidebar_label: VendorConnectorMappingDeletedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappingDeletedBy', 'V2024VendorConnectorMappingDeletedBy'] +slug: /tools/sdk/go/v2024/models/vendor-connector-mapping-deleted-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedBy', 'V2024VendorConnectorMappingDeletedBy'] +--- + +# VendorConnectorMappingDeletedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**String** | Pointer to **string** | The identifier of the user who deleted the mapping, if applicable. | [optional] +**Valid** | Pointer to **bool** | A flag indicating if the 'String' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to false] + +## Methods + +### NewVendorConnectorMappingDeletedBy + +`func NewVendorConnectorMappingDeletedBy() *VendorConnectorMappingDeletedBy` + +NewVendorConnectorMappingDeletedBy instantiates a new VendorConnectorMappingDeletedBy 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 + +### NewVendorConnectorMappingDeletedByWithDefaults + +`func NewVendorConnectorMappingDeletedByWithDefaults() *VendorConnectorMappingDeletedBy` + +NewVendorConnectorMappingDeletedByWithDefaults instantiates a new VendorConnectorMappingDeletedBy 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 + +### GetString + +`func (o *VendorConnectorMappingDeletedBy) GetString() string` + +GetString returns the String field if non-nil, zero value otherwise. + +### GetStringOk + +`func (o *VendorConnectorMappingDeletedBy) GetStringOk() (*string, bool)` + +GetStringOk returns a tuple with the String field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetString + +`func (o *VendorConnectorMappingDeletedBy) SetString(v string)` + +SetString sets String field to given value. + +### HasString + +`func (o *VendorConnectorMappingDeletedBy) HasString() bool` + +HasString returns a boolean if a field has been set. + +### GetValid + +`func (o *VendorConnectorMappingDeletedBy) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *VendorConnectorMappingDeletedBy) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *VendorConnectorMappingDeletedBy) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *VendorConnectorMappingDeletedBy) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/VendorConnectorMappingUpdatedAt.md b/docs/tools/sdk/go/Reference/V2024/Models/VendorConnectorMappingUpdatedAt.md new file mode 100644 index 000000000..98b627753 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/VendorConnectorMappingUpdatedAt.md @@ -0,0 +1,90 @@ +--- +id: v2024-vendor-connector-mapping-updated-at +title: VendorConnectorMappingUpdatedAt +pagination_label: VendorConnectorMappingUpdatedAt +sidebar_label: VendorConnectorMappingUpdatedAt +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappingUpdatedAt', 'V2024VendorConnectorMappingUpdatedAt'] +slug: /tools/sdk/go/v2024/models/vendor-connector-mapping-updated-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedAt', 'V2024VendorConnectorMappingUpdatedAt'] +--- + +# VendorConnectorMappingUpdatedAt + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Time** | Pointer to **SailPointTime** | The timestamp when the mapping was last updated, represented in ISO 8601 format. | [optional] +**Valid** | Pointer to **bool** | A flag indicating if the 'Time' field is set and valid. | [optional] [default to false] + +## Methods + +### NewVendorConnectorMappingUpdatedAt + +`func NewVendorConnectorMappingUpdatedAt() *VendorConnectorMappingUpdatedAt` + +NewVendorConnectorMappingUpdatedAt instantiates a new VendorConnectorMappingUpdatedAt 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 + +### NewVendorConnectorMappingUpdatedAtWithDefaults + +`func NewVendorConnectorMappingUpdatedAtWithDefaults() *VendorConnectorMappingUpdatedAt` + +NewVendorConnectorMappingUpdatedAtWithDefaults instantiates a new VendorConnectorMappingUpdatedAt 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 + +### GetTime + +`func (o *VendorConnectorMappingUpdatedAt) GetTime() SailPointTime` + +GetTime returns the Time field if non-nil, zero value otherwise. + +### GetTimeOk + +`func (o *VendorConnectorMappingUpdatedAt) GetTimeOk() (*SailPointTime, bool)` + +GetTimeOk returns a tuple with the Time field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTime + +`func (o *VendorConnectorMappingUpdatedAt) SetTime(v SailPointTime)` + +SetTime sets Time field to given value. + +### HasTime + +`func (o *VendorConnectorMappingUpdatedAt) HasTime() bool` + +HasTime returns a boolean if a field has been set. + +### GetValid + +`func (o *VendorConnectorMappingUpdatedAt) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *VendorConnectorMappingUpdatedAt) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *VendorConnectorMappingUpdatedAt) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *VendorConnectorMappingUpdatedAt) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/VendorConnectorMappingUpdatedBy.md b/docs/tools/sdk/go/Reference/V2024/Models/VendorConnectorMappingUpdatedBy.md new file mode 100644 index 000000000..e64779158 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/VendorConnectorMappingUpdatedBy.md @@ -0,0 +1,90 @@ +--- +id: v2024-vendor-connector-mapping-updated-by +title: VendorConnectorMappingUpdatedBy +pagination_label: VendorConnectorMappingUpdatedBy +sidebar_label: VendorConnectorMappingUpdatedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappingUpdatedBy', 'V2024VendorConnectorMappingUpdatedBy'] +slug: /tools/sdk/go/v2024/models/vendor-connector-mapping-updated-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedBy', 'V2024VendorConnectorMappingUpdatedBy'] +--- + +# VendorConnectorMappingUpdatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**String** | Pointer to **string** | The identifier of the user who last updated the mapping, if available. | [optional] +**Valid** | Pointer to **bool** | A flag indicating if the 'String' field is set and valid. | [optional] [default to false] + +## Methods + +### NewVendorConnectorMappingUpdatedBy + +`func NewVendorConnectorMappingUpdatedBy() *VendorConnectorMappingUpdatedBy` + +NewVendorConnectorMappingUpdatedBy instantiates a new VendorConnectorMappingUpdatedBy 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 + +### NewVendorConnectorMappingUpdatedByWithDefaults + +`func NewVendorConnectorMappingUpdatedByWithDefaults() *VendorConnectorMappingUpdatedBy` + +NewVendorConnectorMappingUpdatedByWithDefaults instantiates a new VendorConnectorMappingUpdatedBy 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 + +### GetString + +`func (o *VendorConnectorMappingUpdatedBy) GetString() string` + +GetString returns the String field if non-nil, zero value otherwise. + +### GetStringOk + +`func (o *VendorConnectorMappingUpdatedBy) GetStringOk() (*string, bool)` + +GetStringOk returns a tuple with the String field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetString + +`func (o *VendorConnectorMappingUpdatedBy) SetString(v string)` + +SetString sets String field to given value. + +### HasString + +`func (o *VendorConnectorMappingUpdatedBy) HasString() bool` + +HasString returns a boolean if a field has been set. + +### GetValid + +`func (o *VendorConnectorMappingUpdatedBy) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *VendorConnectorMappingUpdatedBy) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *VendorConnectorMappingUpdatedBy) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *VendorConnectorMappingUpdatedBy) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ViolationContext.md b/docs/tools/sdk/go/Reference/V2024/Models/ViolationContext.md new file mode 100644 index 000000000..60c5ba17a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ViolationContext.md @@ -0,0 +1,90 @@ +--- +id: v2024-violation-context +title: ViolationContext +pagination_label: ViolationContext +sidebar_label: ViolationContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationContext', 'V2024ViolationContext'] +slug: /tools/sdk/go/v2024/models/violation-context +tags: ['SDK', 'Software Development Kit', 'ViolationContext', 'V2024ViolationContext'] +--- + +# ViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**ViolationContextPolicy**](violation-context-policy) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**ExceptionAccessCriteria**](exception-access-criteria) | | [optional] + +## Methods + +### NewViolationContext + +`func NewViolationContext() *ViolationContext` + +NewViolationContext instantiates a new ViolationContext 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 + +### NewViolationContextWithDefaults + +`func NewViolationContextWithDefaults() *ViolationContext` + +NewViolationContextWithDefaults instantiates a new ViolationContext 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 + +### GetPolicy + +`func (o *ViolationContext) GetPolicy() ViolationContextPolicy` + +GetPolicy returns the Policy field if non-nil, zero value otherwise. + +### GetPolicyOk + +`func (o *ViolationContext) GetPolicyOk() (*ViolationContextPolicy, bool)` + +GetPolicyOk returns a tuple with the Policy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicy + +`func (o *ViolationContext) SetPolicy(v ViolationContextPolicy)` + +SetPolicy sets Policy field to given value. + +### HasPolicy + +`func (o *ViolationContext) HasPolicy() bool` + +HasPolicy returns a boolean if a field has been set. + +### GetConflictingAccessCriteria + +`func (o *ViolationContext) GetConflictingAccessCriteria() ExceptionAccessCriteria` + +GetConflictingAccessCriteria returns the ConflictingAccessCriteria field if non-nil, zero value otherwise. + +### GetConflictingAccessCriteriaOk + +`func (o *ViolationContext) GetConflictingAccessCriteriaOk() (*ExceptionAccessCriteria, bool)` + +GetConflictingAccessCriteriaOk returns a tuple with the ConflictingAccessCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConflictingAccessCriteria + +`func (o *ViolationContext) SetConflictingAccessCriteria(v ExceptionAccessCriteria)` + +SetConflictingAccessCriteria sets ConflictingAccessCriteria field to given value. + +### HasConflictingAccessCriteria + +`func (o *ViolationContext) HasConflictingAccessCriteria() bool` + +HasConflictingAccessCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ViolationContextPolicy.md b/docs/tools/sdk/go/Reference/V2024/Models/ViolationContextPolicy.md new file mode 100644 index 000000000..7ae1d3ef9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ViolationContextPolicy.md @@ -0,0 +1,116 @@ +--- +id: v2024-violation-context-policy +title: ViolationContextPolicy +pagination_label: ViolationContextPolicy +sidebar_label: ViolationContextPolicy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationContextPolicy', 'V2024ViolationContextPolicy'] +slug: /tools/sdk/go/v2024/models/violation-context-policy +tags: ['SDK', 'Software Development Kit', 'ViolationContextPolicy', 'V2024ViolationContextPolicy'] +--- + +# ViolationContextPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **map[string]interface{}** | The type of object that is referenced | [optional] +**Id** | Pointer to **string** | SOD policy ID. | [optional] +**Name** | Pointer to **string** | | [optional] + +## Methods + +### NewViolationContextPolicy + +`func NewViolationContextPolicy() *ViolationContextPolicy` + +NewViolationContextPolicy instantiates a new ViolationContextPolicy 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 + +### NewViolationContextPolicyWithDefaults + +`func NewViolationContextPolicyWithDefaults() *ViolationContextPolicy` + +NewViolationContextPolicyWithDefaults instantiates a new ViolationContextPolicy 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 + +### GetType + +`func (o *ViolationContextPolicy) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ViolationContextPolicy) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ViolationContextPolicy) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + +### HasType + +`func (o *ViolationContextPolicy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ViolationContextPolicy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ViolationContextPolicy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ViolationContextPolicy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ViolationContextPolicy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ViolationContextPolicy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ViolationContextPolicy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ViolationContextPolicy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ViolationContextPolicy) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ViolationOwnerAssignmentConfig.md b/docs/tools/sdk/go/Reference/V2024/Models/ViolationOwnerAssignmentConfig.md new file mode 100644 index 000000000..ba235fb6d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ViolationOwnerAssignmentConfig.md @@ -0,0 +1,110 @@ +--- +id: v2024-violation-owner-assignment-config +title: ViolationOwnerAssignmentConfig +pagination_label: ViolationOwnerAssignmentConfig +sidebar_label: ViolationOwnerAssignmentConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationOwnerAssignmentConfig', 'V2024ViolationOwnerAssignmentConfig'] +slug: /tools/sdk/go/v2024/models/violation-owner-assignment-config +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfig', 'V2024ViolationOwnerAssignmentConfig'] +--- + +# ViolationOwnerAssignmentConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssignmentRule** | Pointer to **NullableString** | Details about the violations owner. MANAGER - identity's manager STATIC - Governance Group or Identity | [optional] +**OwnerRef** | Pointer to [**NullableViolationOwnerAssignmentConfigOwnerRef**](violation-owner-assignment-config-owner-ref) | | [optional] + +## Methods + +### NewViolationOwnerAssignmentConfig + +`func NewViolationOwnerAssignmentConfig() *ViolationOwnerAssignmentConfig` + +NewViolationOwnerAssignmentConfig instantiates a new ViolationOwnerAssignmentConfig 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 + +### NewViolationOwnerAssignmentConfigWithDefaults + +`func NewViolationOwnerAssignmentConfigWithDefaults() *ViolationOwnerAssignmentConfig` + +NewViolationOwnerAssignmentConfigWithDefaults instantiates a new ViolationOwnerAssignmentConfig 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 + +### GetAssignmentRule + +`func (o *ViolationOwnerAssignmentConfig) GetAssignmentRule() string` + +GetAssignmentRule returns the AssignmentRule field if non-nil, zero value otherwise. + +### GetAssignmentRuleOk + +`func (o *ViolationOwnerAssignmentConfig) GetAssignmentRuleOk() (*string, bool)` + +GetAssignmentRuleOk returns a tuple with the AssignmentRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentRule + +`func (o *ViolationOwnerAssignmentConfig) SetAssignmentRule(v string)` + +SetAssignmentRule sets AssignmentRule field to given value. + +### HasAssignmentRule + +`func (o *ViolationOwnerAssignmentConfig) HasAssignmentRule() bool` + +HasAssignmentRule returns a boolean if a field has been set. + +### SetAssignmentRuleNil + +`func (o *ViolationOwnerAssignmentConfig) SetAssignmentRuleNil(b bool)` + + SetAssignmentRuleNil sets the value for AssignmentRule to be an explicit nil + +### UnsetAssignmentRule +`func (o *ViolationOwnerAssignmentConfig) UnsetAssignmentRule()` + +UnsetAssignmentRule ensures that no value is present for AssignmentRule, not even an explicit nil +### GetOwnerRef + +`func (o *ViolationOwnerAssignmentConfig) GetOwnerRef() ViolationOwnerAssignmentConfigOwnerRef` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *ViolationOwnerAssignmentConfig) GetOwnerRefOk() (*ViolationOwnerAssignmentConfigOwnerRef, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *ViolationOwnerAssignmentConfig) SetOwnerRef(v ViolationOwnerAssignmentConfigOwnerRef)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *ViolationOwnerAssignmentConfig) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### SetOwnerRefNil + +`func (o *ViolationOwnerAssignmentConfig) SetOwnerRefNil(b bool)` + + SetOwnerRefNil sets the value for OwnerRef to be an explicit nil + +### UnsetOwnerRef +`func (o *ViolationOwnerAssignmentConfig) UnsetOwnerRef()` + +UnsetOwnerRef ensures that no value is present for OwnerRef, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ViolationOwnerAssignmentConfigOwnerRef.md b/docs/tools/sdk/go/Reference/V2024/Models/ViolationOwnerAssignmentConfigOwnerRef.md new file mode 100644 index 000000000..89a79cc1c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ViolationOwnerAssignmentConfigOwnerRef.md @@ -0,0 +1,126 @@ +--- +id: v2024-violation-owner-assignment-config-owner-ref +title: ViolationOwnerAssignmentConfigOwnerRef +pagination_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationOwnerAssignmentConfigOwnerRef', 'V2024ViolationOwnerAssignmentConfigOwnerRef'] +slug: /tools/sdk/go/v2024/models/violation-owner-assignment-config-owner-ref +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfigOwnerRef', 'V2024ViolationOwnerAssignmentConfigOwnerRef'] +--- + +# ViolationOwnerAssignmentConfigOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **NullableString** | Owner type. | [optional] +**Id** | Pointer to **string** | Owner's ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] + +## Methods + +### NewViolationOwnerAssignmentConfigOwnerRef + +`func NewViolationOwnerAssignmentConfigOwnerRef() *ViolationOwnerAssignmentConfigOwnerRef` + +NewViolationOwnerAssignmentConfigOwnerRef instantiates a new ViolationOwnerAssignmentConfigOwnerRef 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 + +### NewViolationOwnerAssignmentConfigOwnerRefWithDefaults + +`func NewViolationOwnerAssignmentConfigOwnerRefWithDefaults() *ViolationOwnerAssignmentConfigOwnerRef` + +NewViolationOwnerAssignmentConfigOwnerRefWithDefaults instantiates a new ViolationOwnerAssignmentConfigOwnerRef 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 + +### GetType + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *ViolationOwnerAssignmentConfigOwnerRef) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetId + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/ViolationPrediction.md b/docs/tools/sdk/go/Reference/V2024/Models/ViolationPrediction.md new file mode 100644 index 000000000..a0dffda15 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/ViolationPrediction.md @@ -0,0 +1,64 @@ +--- +id: v2024-violation-prediction +title: ViolationPrediction +pagination_label: ViolationPrediction +sidebar_label: ViolationPrediction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationPrediction', 'V2024ViolationPrediction'] +slug: /tools/sdk/go/v2024/models/violation-prediction +tags: ['SDK', 'Software Development Kit', 'ViolationPrediction', 'V2024ViolationPrediction'] +--- + +# ViolationPrediction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ViolationContexts** | Pointer to [**[]ViolationContext**](violation-context) | List of Violation Contexts | [optional] + +## Methods + +### NewViolationPrediction + +`func NewViolationPrediction() *ViolationPrediction` + +NewViolationPrediction instantiates a new ViolationPrediction 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 + +### NewViolationPredictionWithDefaults + +`func NewViolationPredictionWithDefaults() *ViolationPrediction` + +NewViolationPredictionWithDefaults instantiates a new ViolationPrediction 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 + +### GetViolationContexts + +`func (o *ViolationPrediction) GetViolationContexts() []ViolationContext` + +GetViolationContexts returns the ViolationContexts field if non-nil, zero value otherwise. + +### GetViolationContextsOk + +`func (o *ViolationPrediction) GetViolationContextsOk() (*[]ViolationContext, bool)` + +GetViolationContextsOk returns a tuple with the ViolationContexts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationContexts + +`func (o *ViolationPrediction) SetViolationContexts(v []ViolationContext)` + +SetViolationContexts sets ViolationContexts field to given value. + +### HasViolationContexts + +`func (o *ViolationPrediction) HasViolationContexts() bool` + +HasViolationContexts returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/VisibilityCriteria.md b/docs/tools/sdk/go/Reference/V2024/Models/VisibilityCriteria.md new file mode 100644 index 000000000..a5188c0d9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/VisibilityCriteria.md @@ -0,0 +1,64 @@ +--- +id: v2024-visibility-criteria +title: VisibilityCriteria +pagination_label: VisibilityCriteria +sidebar_label: VisibilityCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VisibilityCriteria', 'V2024VisibilityCriteria'] +slug: /tools/sdk/go/v2024/models/visibility-criteria +tags: ['SDK', 'Software Development Kit', 'VisibilityCriteria', 'V2024VisibilityCriteria'] +--- + +# VisibilityCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | Pointer to [**Expression**](expression) | | [optional] + +## Methods + +### NewVisibilityCriteria + +`func NewVisibilityCriteria() *VisibilityCriteria` + +NewVisibilityCriteria instantiates a new VisibilityCriteria 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 + +### NewVisibilityCriteriaWithDefaults + +`func NewVisibilityCriteriaWithDefaults() *VisibilityCriteria` + +NewVisibilityCriteriaWithDefaults instantiates a new VisibilityCriteria 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 + +### GetExpression + +`func (o *VisibilityCriteria) GetExpression() Expression` + +GetExpression returns the Expression field if non-nil, zero value otherwise. + +### GetExpressionOk + +`func (o *VisibilityCriteria) GetExpressionOk() (*Expression, bool)` + +GetExpressionOk returns a tuple with the Expression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpression + +`func (o *VisibilityCriteria) SetExpression(v Expression)` + +SetExpression sets Expression field to given value. + +### HasExpression + +`func (o *VisibilityCriteria) HasExpression() bool` + +HasExpression returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkItemForward.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkItemForward.md new file mode 100644 index 000000000..b658e9495 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkItemForward.md @@ -0,0 +1,106 @@ +--- +id: v2024-work-item-forward +title: WorkItemForward +pagination_label: WorkItemForward +sidebar_label: WorkItemForward +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemForward', 'V2024WorkItemForward'] +slug: /tools/sdk/go/v2024/models/work-item-forward +tags: ['SDK', 'Software Development Kit', 'WorkItemForward', 'V2024WorkItemForward'] +--- + +# WorkItemForward + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TargetOwnerId** | **string** | The ID of the identity to forward this work item to. | +**Comment** | **string** | Comments to send to the target owner | +**SendNotifications** | Pointer to **bool** | If true, send a notification to the target owner. | [optional] [default to true] + +## Methods + +### NewWorkItemForward + +`func NewWorkItemForward(targetOwnerId string, comment string, ) *WorkItemForward` + +NewWorkItemForward instantiates a new WorkItemForward 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 + +### NewWorkItemForwardWithDefaults + +`func NewWorkItemForwardWithDefaults() *WorkItemForward` + +NewWorkItemForwardWithDefaults instantiates a new WorkItemForward 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 + +### GetTargetOwnerId + +`func (o *WorkItemForward) GetTargetOwnerId() string` + +GetTargetOwnerId returns the TargetOwnerId field if non-nil, zero value otherwise. + +### GetTargetOwnerIdOk + +`func (o *WorkItemForward) GetTargetOwnerIdOk() (*string, bool)` + +GetTargetOwnerIdOk returns a tuple with the TargetOwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetOwnerId + +`func (o *WorkItemForward) SetTargetOwnerId(v string)` + +SetTargetOwnerId sets TargetOwnerId field to given value. + + +### GetComment + +`func (o *WorkItemForward) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *WorkItemForward) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *WorkItemForward) SetComment(v string)` + +SetComment sets Comment field to given value. + + +### GetSendNotifications + +`func (o *WorkItemForward) GetSendNotifications() bool` + +GetSendNotifications returns the SendNotifications field if non-nil, zero value otherwise. + +### GetSendNotificationsOk + +`func (o *WorkItemForward) GetSendNotificationsOk() (*bool, bool)` + +GetSendNotificationsOk returns a tuple with the SendNotifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSendNotifications + +`func (o *WorkItemForward) SetSendNotifications(v bool)` + +SetSendNotifications sets SendNotifications field to given value. + +### HasSendNotifications + +`func (o *WorkItemForward) HasSendNotifications() bool` + +HasSendNotifications returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkItemState.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkItemState.md new file mode 100644 index 000000000..0d991acb5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkItemState.md @@ -0,0 +1,29 @@ +--- +id: v2024-work-item-state +title: WorkItemState +pagination_label: WorkItemState +sidebar_label: WorkItemState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemState', 'V2024WorkItemState'] +slug: /tools/sdk/go/v2024/models/work-item-state +tags: ['SDK', 'Software Development Kit', 'WorkItemState', 'V2024WorkItemState'] +--- + +# WorkItemState + +## Enum + + +* `FINISHED` (value: `"Finished"`) + +* `REJECTED` (value: `"Rejected"`) + +* `RETURNED` (value: `"Returned"`) + +* `EXPIRED` (value: `"Expired"`) + +* `PENDING` (value: `"Pending"`) + +* `CANCELED` (value: `"Canceled"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkItemStateManualWorkItems.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkItemStateManualWorkItems.md new file mode 100644 index 000000000..0bfb1e6d1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkItemStateManualWorkItems.md @@ -0,0 +1,29 @@ +--- +id: v2024-work-item-state-manual-work-items +title: WorkItemStateManualWorkItems +pagination_label: WorkItemStateManualWorkItems +sidebar_label: WorkItemStateManualWorkItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemStateManualWorkItems', 'V2024WorkItemStateManualWorkItems'] +slug: /tools/sdk/go/v2024/models/work-item-state-manual-work-items +tags: ['SDK', 'Software Development Kit', 'WorkItemStateManualWorkItems', 'V2024WorkItemStateManualWorkItems'] +--- + +# WorkItemStateManualWorkItems + +## Enum + + +* `FINISHED` (value: `"Finished"`) + +* `REJECTED` (value: `"Rejected"`) + +* `RETURNED` (value: `"Returned"`) + +* `EXPIRED` (value: `"Expired"`) + +* `PENDING` (value: `"Pending"`) + +* `CANCELED` (value: `"Canceled"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkItemTypeManualWorkItems.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkItemTypeManualWorkItems.md new file mode 100644 index 000000000..496cfebf8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkItemTypeManualWorkItems.md @@ -0,0 +1,45 @@ +--- +id: v2024-work-item-type-manual-work-items +title: WorkItemTypeManualWorkItems +pagination_label: WorkItemTypeManualWorkItems +sidebar_label: WorkItemTypeManualWorkItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemTypeManualWorkItems', 'V2024WorkItemTypeManualWorkItems'] +slug: /tools/sdk/go/v2024/models/work-item-type-manual-work-items +tags: ['SDK', 'Software Development Kit', 'WorkItemTypeManualWorkItems', 'V2024WorkItemTypeManualWorkItems'] +--- + +# WorkItemTypeManualWorkItems + +## Enum + + +* `GENERIC` (value: `"Generic"`) + +* `CERTIFICATION` (value: `"Certification"`) + +* `REMEDIATION` (value: `"Remediation"`) + +* `DELEGATION` (value: `"Delegation"`) + +* `APPROVAL` (value: `"Approval"`) + +* `VIOLATION_REVIEW` (value: `"ViolationReview"`) + +* `FORM` (value: `"Form"`) + +* `POLICY_VIOLOATION` (value: `"PolicyVioloation"`) + +* `CHALLENGE` (value: `"Challenge"`) + +* `IMPACT_ANALYSIS` (value: `"ImpactAnalysis"`) + +* `SIGNOFF` (value: `"Signoff"`) + +* `EVENT` (value: `"Event"`) + +* `MANUAL_ACTION` (value: `"ManualAction"`) + +* `TEST` (value: `"Test"`) + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkItems.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkItems.md new file mode 100644 index 000000000..302266e4c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkItems.md @@ -0,0 +1,570 @@ +--- +id: v2024-work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItems', 'V2024WorkItems'] +slug: /tools/sdk/go/v2024/models/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'V2024WorkItems'] +--- + +# WorkItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the work item | [optional] +**RequesterId** | Pointer to **NullableString** | ID of the requester | [optional] +**RequesterDisplayName** | Pointer to **NullableString** | The displayname of the requester | [optional] +**OwnerId** | Pointer to **NullableString** | The ID of the owner | [optional] +**OwnerName** | Pointer to **string** | The name of the owner | [optional] +**Created** | Pointer to **SailPointTime** | Time when the work item was created | [optional] +**Modified** | Pointer to **NullableTime** | Time when the work item was last updated | [optional] +**Description** | Pointer to **string** | The description of the work item | [optional] +**State** | Pointer to [**WorkItemStateManualWorkItems**](work-item-state-manual-work-items) | | [optional] +**Type** | Pointer to [**WorkItemTypeManualWorkItems**](work-item-type-manual-work-items) | | [optional] +**RemediationItems** | Pointer to [**[]RemediationItemDetails**](remediation-item-details) | A list of remediation items | [optional] +**ApprovalItems** | Pointer to [**[]ApprovalItemDetails**](approval-item-details) | A list of items that need to be approved | [optional] +**Name** | Pointer to **NullableString** | The work item name | [optional] +**Completed** | Pointer to **NullableTime** | The time at which the work item completed | [optional] +**NumItems** | Pointer to **NullableInt32** | The number of items in the work item | [optional] +**Form** | Pointer to [**WorkItemsForm**](work-items-form) | | [optional] +**Errors** | Pointer to **[]string** | An array of errors that ocurred during the work item | [optional] + +## Methods + +### NewWorkItems + +`func NewWorkItems() *WorkItems` + +NewWorkItems instantiates a new WorkItems 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 + +### NewWorkItemsWithDefaults + +`func NewWorkItemsWithDefaults() *WorkItems` + +NewWorkItemsWithDefaults instantiates a new WorkItems 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 + +### GetId + +`func (o *WorkItems) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkItems) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkItems) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkItems) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRequesterId + +`func (o *WorkItems) GetRequesterId() string` + +GetRequesterId returns the RequesterId field if non-nil, zero value otherwise. + +### GetRequesterIdOk + +`func (o *WorkItems) GetRequesterIdOk() (*string, bool)` + +GetRequesterIdOk returns a tuple with the RequesterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterId + +`func (o *WorkItems) SetRequesterId(v string)` + +SetRequesterId sets RequesterId field to given value. + +### HasRequesterId + +`func (o *WorkItems) HasRequesterId() bool` + +HasRequesterId returns a boolean if a field has been set. + +### SetRequesterIdNil + +`func (o *WorkItems) SetRequesterIdNil(b bool)` + + SetRequesterIdNil sets the value for RequesterId to be an explicit nil + +### UnsetRequesterId +`func (o *WorkItems) UnsetRequesterId()` + +UnsetRequesterId ensures that no value is present for RequesterId, not even an explicit nil +### GetRequesterDisplayName + +`func (o *WorkItems) GetRequesterDisplayName() string` + +GetRequesterDisplayName returns the RequesterDisplayName field if non-nil, zero value otherwise. + +### GetRequesterDisplayNameOk + +`func (o *WorkItems) GetRequesterDisplayNameOk() (*string, bool)` + +GetRequesterDisplayNameOk returns a tuple with the RequesterDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterDisplayName + +`func (o *WorkItems) SetRequesterDisplayName(v string)` + +SetRequesterDisplayName sets RequesterDisplayName field to given value. + +### HasRequesterDisplayName + +`func (o *WorkItems) HasRequesterDisplayName() bool` + +HasRequesterDisplayName returns a boolean if a field has been set. + +### SetRequesterDisplayNameNil + +`func (o *WorkItems) SetRequesterDisplayNameNil(b bool)` + + SetRequesterDisplayNameNil sets the value for RequesterDisplayName to be an explicit nil + +### UnsetRequesterDisplayName +`func (o *WorkItems) UnsetRequesterDisplayName()` + +UnsetRequesterDisplayName ensures that no value is present for RequesterDisplayName, not even an explicit nil +### GetOwnerId + +`func (o *WorkItems) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *WorkItems) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *WorkItems) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *WorkItems) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + +### SetOwnerIdNil + +`func (o *WorkItems) SetOwnerIdNil(b bool)` + + SetOwnerIdNil sets the value for OwnerId to be an explicit nil + +### UnsetOwnerId +`func (o *WorkItems) UnsetOwnerId()` + +UnsetOwnerId ensures that no value is present for OwnerId, not even an explicit nil +### GetOwnerName + +`func (o *WorkItems) GetOwnerName() string` + +GetOwnerName returns the OwnerName field if non-nil, zero value otherwise. + +### GetOwnerNameOk + +`func (o *WorkItems) GetOwnerNameOk() (*string, bool)` + +GetOwnerNameOk returns a tuple with the OwnerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerName + +`func (o *WorkItems) SetOwnerName(v string)` + +SetOwnerName sets OwnerName field to given value. + +### HasOwnerName + +`func (o *WorkItems) HasOwnerName() bool` + +HasOwnerName returns a boolean if a field has been set. + +### GetCreated + +`func (o *WorkItems) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *WorkItems) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *WorkItems) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *WorkItems) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *WorkItems) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *WorkItems) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *WorkItems) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *WorkItems) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *WorkItems) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *WorkItems) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDescription + +`func (o *WorkItems) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkItems) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkItems) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkItems) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetState + +`func (o *WorkItems) GetState() WorkItemStateManualWorkItems` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *WorkItems) GetStateOk() (*WorkItemStateManualWorkItems, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *WorkItems) SetState(v WorkItemStateManualWorkItems)` + +SetState sets State field to given value. + +### HasState + +`func (o *WorkItems) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetType + +`func (o *WorkItems) GetType() WorkItemTypeManualWorkItems` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkItems) GetTypeOk() (*WorkItemTypeManualWorkItems, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkItems) SetType(v WorkItemTypeManualWorkItems)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkItems) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRemediationItems + +`func (o *WorkItems) GetRemediationItems() []RemediationItemDetails` + +GetRemediationItems returns the RemediationItems field if non-nil, zero value otherwise. + +### GetRemediationItemsOk + +`func (o *WorkItems) GetRemediationItemsOk() (*[]RemediationItemDetails, bool)` + +GetRemediationItemsOk returns a tuple with the RemediationItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemediationItems + +`func (o *WorkItems) SetRemediationItems(v []RemediationItemDetails)` + +SetRemediationItems sets RemediationItems field to given value. + +### HasRemediationItems + +`func (o *WorkItems) HasRemediationItems() bool` + +HasRemediationItems returns a boolean if a field has been set. + +### SetRemediationItemsNil + +`func (o *WorkItems) SetRemediationItemsNil(b bool)` + + SetRemediationItemsNil sets the value for RemediationItems to be an explicit nil + +### UnsetRemediationItems +`func (o *WorkItems) UnsetRemediationItems()` + +UnsetRemediationItems ensures that no value is present for RemediationItems, not even an explicit nil +### GetApprovalItems + +`func (o *WorkItems) GetApprovalItems() []ApprovalItemDetails` + +GetApprovalItems returns the ApprovalItems field if non-nil, zero value otherwise. + +### GetApprovalItemsOk + +`func (o *WorkItems) GetApprovalItemsOk() (*[]ApprovalItemDetails, bool)` + +GetApprovalItemsOk returns a tuple with the ApprovalItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalItems + +`func (o *WorkItems) SetApprovalItems(v []ApprovalItemDetails)` + +SetApprovalItems sets ApprovalItems field to given value. + +### HasApprovalItems + +`func (o *WorkItems) HasApprovalItems() bool` + +HasApprovalItems returns a boolean if a field has been set. + +### SetApprovalItemsNil + +`func (o *WorkItems) SetApprovalItemsNil(b bool)` + + SetApprovalItemsNil sets the value for ApprovalItems to be an explicit nil + +### UnsetApprovalItems +`func (o *WorkItems) UnsetApprovalItems()` + +UnsetApprovalItems ensures that no value is present for ApprovalItems, not even an explicit nil +### GetName + +`func (o *WorkItems) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkItems) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkItems) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkItems) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *WorkItems) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *WorkItems) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCompleted + +`func (o *WorkItems) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *WorkItems) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *WorkItems) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *WorkItems) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *WorkItems) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *WorkItems) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetNumItems + +`func (o *WorkItems) GetNumItems() int32` + +GetNumItems returns the NumItems field if non-nil, zero value otherwise. + +### GetNumItemsOk + +`func (o *WorkItems) GetNumItemsOk() (*int32, bool)` + +GetNumItemsOk returns a tuple with the NumItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumItems + +`func (o *WorkItems) SetNumItems(v int32)` + +SetNumItems sets NumItems field to given value. + +### HasNumItems + +`func (o *WorkItems) HasNumItems() bool` + +HasNumItems returns a boolean if a field has been set. + +### SetNumItemsNil + +`func (o *WorkItems) SetNumItemsNil(b bool)` + + SetNumItemsNil sets the value for NumItems to be an explicit nil + +### UnsetNumItems +`func (o *WorkItems) UnsetNumItems()` + +UnsetNumItems ensures that no value is present for NumItems, not even an explicit nil +### GetForm + +`func (o *WorkItems) GetForm() WorkItemsForm` + +GetForm returns the Form field if non-nil, zero value otherwise. + +### GetFormOk + +`func (o *WorkItems) GetFormOk() (*WorkItemsForm, bool)` + +GetFormOk returns a tuple with the Form field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForm + +`func (o *WorkItems) SetForm(v WorkItemsForm)` + +SetForm sets Form field to given value. + +### HasForm + +`func (o *WorkItems) HasForm() bool` + +HasForm returns a boolean if a field has been set. + +### GetErrors + +`func (o *WorkItems) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *WorkItems) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *WorkItems) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *WorkItems) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkItemsCount.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkItemsCount.md new file mode 100644 index 000000000..634224c26 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkItemsCount.md @@ -0,0 +1,64 @@ +--- +id: v2024-work-items-count +title: WorkItemsCount +pagination_label: WorkItemsCount +sidebar_label: WorkItemsCount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemsCount', 'V2024WorkItemsCount'] +slug: /tools/sdk/go/v2024/models/work-items-count +tags: ['SDK', 'Software Development Kit', 'WorkItemsCount', 'V2024WorkItemsCount'] +--- + +# WorkItemsCount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **int32** | The count of work items | [optional] + +## Methods + +### NewWorkItemsCount + +`func NewWorkItemsCount() *WorkItemsCount` + +NewWorkItemsCount instantiates a new WorkItemsCount 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 + +### NewWorkItemsCountWithDefaults + +`func NewWorkItemsCountWithDefaults() *WorkItemsCount` + +NewWorkItemsCountWithDefaults instantiates a new WorkItemsCount 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 + +### GetCount + +`func (o *WorkItemsCount) GetCount() int32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *WorkItemsCount) GetCountOk() (*int32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *WorkItemsCount) SetCount(v int32)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *WorkItemsCount) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkItemsForm.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkItemsForm.md new file mode 100644 index 000000000..b6c14a120 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkItemsForm.md @@ -0,0 +1,234 @@ +--- +id: v2024-work-items-form +title: WorkItemsForm +pagination_label: WorkItemsForm +sidebar_label: WorkItemsForm +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemsForm', 'V2024WorkItemsForm'] +slug: /tools/sdk/go/v2024/models/work-items-form +tags: ['SDK', 'Software Development Kit', 'WorkItemsForm', 'V2024WorkItemsForm'] +--- + +# WorkItemsForm + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | ID of the form | [optional] +**Name** | Pointer to **NullableString** | Name of the form | [optional] +**Title** | Pointer to **NullableString** | The form title | [optional] +**Subtitle** | Pointer to **NullableString** | The form subtitle. | [optional] +**TargetUser** | Pointer to **string** | The name of the user that should be shown this form | [optional] +**Sections** | Pointer to [**[]SectionDetails**](section-details) | Sections of the form | [optional] + +## Methods + +### NewWorkItemsForm + +`func NewWorkItemsForm() *WorkItemsForm` + +NewWorkItemsForm instantiates a new WorkItemsForm 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 + +### NewWorkItemsFormWithDefaults + +`func NewWorkItemsFormWithDefaults() *WorkItemsForm` + +NewWorkItemsFormWithDefaults instantiates a new WorkItemsForm 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 + +### GetId + +`func (o *WorkItemsForm) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkItemsForm) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkItemsForm) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkItemsForm) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *WorkItemsForm) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *WorkItemsForm) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *WorkItemsForm) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkItemsForm) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkItemsForm) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkItemsForm) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *WorkItemsForm) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *WorkItemsForm) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetTitle + +`func (o *WorkItemsForm) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *WorkItemsForm) GetTitleOk() (*string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTitle + +`func (o *WorkItemsForm) SetTitle(v string)` + +SetTitle sets Title field to given value. + +### HasTitle + +`func (o *WorkItemsForm) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### SetTitleNil + +`func (o *WorkItemsForm) SetTitleNil(b bool)` + + SetTitleNil sets the value for Title to be an explicit nil + +### UnsetTitle +`func (o *WorkItemsForm) UnsetTitle()` + +UnsetTitle ensures that no value is present for Title, not even an explicit nil +### GetSubtitle + +`func (o *WorkItemsForm) GetSubtitle() string` + +GetSubtitle returns the Subtitle field if non-nil, zero value otherwise. + +### GetSubtitleOk + +`func (o *WorkItemsForm) GetSubtitleOk() (*string, bool)` + +GetSubtitleOk returns a tuple with the Subtitle field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubtitle + +`func (o *WorkItemsForm) SetSubtitle(v string)` + +SetSubtitle sets Subtitle field to given value. + +### HasSubtitle + +`func (o *WorkItemsForm) HasSubtitle() bool` + +HasSubtitle returns a boolean if a field has been set. + +### SetSubtitleNil + +`func (o *WorkItemsForm) SetSubtitleNil(b bool)` + + SetSubtitleNil sets the value for Subtitle to be an explicit nil + +### UnsetSubtitle +`func (o *WorkItemsForm) UnsetSubtitle()` + +UnsetSubtitle ensures that no value is present for Subtitle, not even an explicit nil +### GetTargetUser + +`func (o *WorkItemsForm) GetTargetUser() string` + +GetTargetUser returns the TargetUser field if non-nil, zero value otherwise. + +### GetTargetUserOk + +`func (o *WorkItemsForm) GetTargetUserOk() (*string, bool)` + +GetTargetUserOk returns a tuple with the TargetUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetUser + +`func (o *WorkItemsForm) SetTargetUser(v string)` + +SetTargetUser sets TargetUser field to given value. + +### HasTargetUser + +`func (o *WorkItemsForm) HasTargetUser() bool` + +HasTargetUser returns a boolean if a field has been set. + +### GetSections + +`func (o *WorkItemsForm) GetSections() []SectionDetails` + +GetSections returns the Sections field if non-nil, zero value otherwise. + +### GetSectionsOk + +`func (o *WorkItemsForm) GetSectionsOk() (*[]SectionDetails, bool)` + +GetSectionsOk returns a tuple with the Sections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSections + +`func (o *WorkItemsForm) SetSections(v []SectionDetails)` + +SetSections sets Sections field to given value. + +### HasSections + +`func (o *WorkItemsForm) HasSections() bool` + +HasSections returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkItemsSummary.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkItemsSummary.md new file mode 100644 index 000000000..17f744256 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkItemsSummary.md @@ -0,0 +1,116 @@ +--- +id: v2024-work-items-summary +title: WorkItemsSummary +pagination_label: WorkItemsSummary +sidebar_label: WorkItemsSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemsSummary', 'V2024WorkItemsSummary'] +slug: /tools/sdk/go/v2024/models/work-items-summary +tags: ['SDK', 'Software Development Kit', 'WorkItemsSummary', 'V2024WorkItemsSummary'] +--- + +# WorkItemsSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Open** | Pointer to **int32** | The count of open work items | [optional] +**Completed** | Pointer to **int32** | The count of completed work items | [optional] +**Total** | Pointer to **int32** | The count of total work items | [optional] + +## Methods + +### NewWorkItemsSummary + +`func NewWorkItemsSummary() *WorkItemsSummary` + +NewWorkItemsSummary instantiates a new WorkItemsSummary 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 + +### NewWorkItemsSummaryWithDefaults + +`func NewWorkItemsSummaryWithDefaults() *WorkItemsSummary` + +NewWorkItemsSummaryWithDefaults instantiates a new WorkItemsSummary 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 + +### GetOpen + +`func (o *WorkItemsSummary) GetOpen() int32` + +GetOpen returns the Open field if non-nil, zero value otherwise. + +### GetOpenOk + +`func (o *WorkItemsSummary) GetOpenOk() (*int32, bool)` + +GetOpenOk returns a tuple with the Open field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOpen + +`func (o *WorkItemsSummary) SetOpen(v int32)` + +SetOpen sets Open field to given value. + +### HasOpen + +`func (o *WorkItemsSummary) HasOpen() bool` + +HasOpen returns a boolean if a field has been set. + +### GetCompleted + +`func (o *WorkItemsSummary) GetCompleted() int32` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *WorkItemsSummary) GetCompletedOk() (*int32, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *WorkItemsSummary) SetCompleted(v int32)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *WorkItemsSummary) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetTotal + +`func (o *WorkItemsSummary) GetTotal() int32` + +GetTotal returns the Total field if non-nil, zero value otherwise. + +### GetTotalOk + +`func (o *WorkItemsSummary) GetTotalOk() (*int32, bool)` + +GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotal + +`func (o *WorkItemsSummary) SetTotal(v int32)` + +SetTotal sets Total field to given value. + +### HasTotal + +`func (o *WorkItemsSummary) HasTotal() bool` + +HasTotal returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/Workflow.md b/docs/tools/sdk/go/Reference/V2024/Models/Workflow.md new file mode 100644 index 000000000..9d0acea48 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/Workflow.md @@ -0,0 +1,376 @@ +--- +id: v2024-workflow +title: Workflow +pagination_label: Workflow +sidebar_label: Workflow +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Workflow', 'V2024Workflow'] +slug: /tools/sdk/go/v2024/models/workflow +tags: ['SDK', 'Software Development Kit', 'Workflow', 'V2024Workflow'] +--- + +# Workflow + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the workflow | [optional] +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **string** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **bool** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] +**Id** | Pointer to **string** | Workflow ID. This is a UUID generated upon creation. | [optional] +**ExecutionCount** | Pointer to **int32** | The number of times this workflow has been executed. | [optional] +**FailureCount** | Pointer to **int32** | The number of times this workflow has failed during execution. | [optional] +**Created** | Pointer to **SailPointTime** | The date and time the workflow was created. | [optional] +**Modified** | Pointer to **SailPointTime** | The date and time the workflow was modified. | [optional] +**ModifiedBy** | Pointer to [**WorkflowModifiedBy**](workflow-modified-by) | | [optional] +**Creator** | Pointer to [**WorkflowAllOfCreator**](workflow-all-of-creator) | | [optional] + +## Methods + +### NewWorkflow + +`func NewWorkflow() *Workflow` + +NewWorkflow instantiates a new Workflow 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 + +### NewWorkflowWithDefaults + +`func NewWorkflowWithDefaults() *Workflow` + +NewWorkflowWithDefaults instantiates a new Workflow 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 + +### GetName + +`func (o *Workflow) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Workflow) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Workflow) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Workflow) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOwner + +`func (o *Workflow) GetOwner() WorkflowBodyOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Workflow) GetOwnerOk() (*WorkflowBodyOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Workflow) SetOwner(v WorkflowBodyOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *Workflow) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDescription + +`func (o *Workflow) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Workflow) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Workflow) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Workflow) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDefinition + +`func (o *Workflow) GetDefinition() WorkflowDefinition` + +GetDefinition returns the Definition field if non-nil, zero value otherwise. + +### GetDefinitionOk + +`func (o *Workflow) GetDefinitionOk() (*WorkflowDefinition, bool)` + +GetDefinitionOk returns a tuple with the Definition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefinition + +`func (o *Workflow) SetDefinition(v WorkflowDefinition)` + +SetDefinition sets Definition field to given value. + +### HasDefinition + +`func (o *Workflow) HasDefinition() bool` + +HasDefinition returns a boolean if a field has been set. + +### GetEnabled + +`func (o *Workflow) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *Workflow) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *Workflow) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *Workflow) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetTrigger + +`func (o *Workflow) GetTrigger() WorkflowTrigger` + +GetTrigger returns the Trigger field if non-nil, zero value otherwise. + +### GetTriggerOk + +`func (o *Workflow) GetTriggerOk() (*WorkflowTrigger, bool)` + +GetTriggerOk returns a tuple with the Trigger field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrigger + +`func (o *Workflow) SetTrigger(v WorkflowTrigger)` + +SetTrigger sets Trigger field to given value. + +### HasTrigger + +`func (o *Workflow) HasTrigger() bool` + +HasTrigger returns a boolean if a field has been set. + +### GetId + +`func (o *Workflow) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Workflow) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Workflow) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Workflow) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetExecutionCount + +`func (o *Workflow) GetExecutionCount() int32` + +GetExecutionCount returns the ExecutionCount field if non-nil, zero value otherwise. + +### GetExecutionCountOk + +`func (o *Workflow) GetExecutionCountOk() (*int32, bool)` + +GetExecutionCountOk returns a tuple with the ExecutionCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExecutionCount + +`func (o *Workflow) SetExecutionCount(v int32)` + +SetExecutionCount sets ExecutionCount field to given value. + +### HasExecutionCount + +`func (o *Workflow) HasExecutionCount() bool` + +HasExecutionCount returns a boolean if a field has been set. + +### GetFailureCount + +`func (o *Workflow) GetFailureCount() int32` + +GetFailureCount returns the FailureCount field if non-nil, zero value otherwise. + +### GetFailureCountOk + +`func (o *Workflow) GetFailureCountOk() (*int32, bool)` + +GetFailureCountOk returns a tuple with the FailureCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFailureCount + +`func (o *Workflow) SetFailureCount(v int32)` + +SetFailureCount sets FailureCount field to given value. + +### HasFailureCount + +`func (o *Workflow) HasFailureCount() bool` + +HasFailureCount returns a boolean if a field has been set. + +### GetCreated + +`func (o *Workflow) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Workflow) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Workflow) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Workflow) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Workflow) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Workflow) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Workflow) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Workflow) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetModifiedBy + +`func (o *Workflow) GetModifiedBy() WorkflowModifiedBy` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *Workflow) GetModifiedByOk() (*WorkflowModifiedBy, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedBy + +`func (o *Workflow) SetModifiedBy(v WorkflowModifiedBy)` + +SetModifiedBy sets ModifiedBy field to given value. + +### HasModifiedBy + +`func (o *Workflow) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### GetCreator + +`func (o *Workflow) GetCreator() WorkflowAllOfCreator` + +GetCreator returns the Creator field if non-nil, zero value otherwise. + +### GetCreatorOk + +`func (o *Workflow) GetCreatorOk() (*WorkflowAllOfCreator, bool)` + +GetCreatorOk returns a tuple with the Creator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreator + +`func (o *Workflow) SetCreator(v WorkflowAllOfCreator)` + +SetCreator sets Creator field to given value. + +### HasCreator + +`func (o *Workflow) HasCreator() bool` + +HasCreator returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkflowAllOfCreator.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowAllOfCreator.md new file mode 100644 index 000000000..533263a8b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowAllOfCreator.md @@ -0,0 +1,116 @@ +--- +id: v2024-workflow-all-of-creator +title: WorkflowAllOfCreator +pagination_label: WorkflowAllOfCreator +sidebar_label: WorkflowAllOfCreator +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowAllOfCreator', 'V2024WorkflowAllOfCreator'] +slug: /tools/sdk/go/v2024/models/workflow-all-of-creator +tags: ['SDK', 'Software Development Kit', 'WorkflowAllOfCreator', 'V2024WorkflowAllOfCreator'] +--- + +# WorkflowAllOfCreator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Workflow creator's DTO type. | [optional] +**Id** | Pointer to **string** | Workflow creator's identity ID. | [optional] +**Name** | Pointer to **string** | Workflow creator's display name. | [optional] + +## Methods + +### NewWorkflowAllOfCreator + +`func NewWorkflowAllOfCreator() *WorkflowAllOfCreator` + +NewWorkflowAllOfCreator instantiates a new WorkflowAllOfCreator 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 + +### NewWorkflowAllOfCreatorWithDefaults + +`func NewWorkflowAllOfCreatorWithDefaults() *WorkflowAllOfCreator` + +NewWorkflowAllOfCreatorWithDefaults instantiates a new WorkflowAllOfCreator 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 + +### GetType + +`func (o *WorkflowAllOfCreator) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowAllOfCreator) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowAllOfCreator) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowAllOfCreator) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkflowAllOfCreator) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowAllOfCreator) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowAllOfCreator) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowAllOfCreator) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowAllOfCreator) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowAllOfCreator) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowAllOfCreator) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowAllOfCreator) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkflowBody.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowBody.md new file mode 100644 index 000000000..9ee0d3e87 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowBody.md @@ -0,0 +1,194 @@ +--- +id: v2024-workflow-body +title: WorkflowBody +pagination_label: WorkflowBody +sidebar_label: WorkflowBody +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowBody', 'V2024WorkflowBody'] +slug: /tools/sdk/go/v2024/models/workflow-body +tags: ['SDK', 'Software Development Kit', 'WorkflowBody', 'V2024WorkflowBody'] +--- + +# WorkflowBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the workflow | [optional] +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **string** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **bool** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] + +## Methods + +### NewWorkflowBody + +`func NewWorkflowBody() *WorkflowBody` + +NewWorkflowBody instantiates a new WorkflowBody 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 + +### NewWorkflowBodyWithDefaults + +`func NewWorkflowBodyWithDefaults() *WorkflowBody` + +NewWorkflowBodyWithDefaults instantiates a new WorkflowBody 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 + +### GetName + +`func (o *WorkflowBody) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowBody) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowBody) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowBody) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOwner + +`func (o *WorkflowBody) GetOwner() WorkflowBodyOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *WorkflowBody) GetOwnerOk() (*WorkflowBodyOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *WorkflowBody) SetOwner(v WorkflowBodyOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *WorkflowBody) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkflowBody) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowBody) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowBody) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowBody) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDefinition + +`func (o *WorkflowBody) GetDefinition() WorkflowDefinition` + +GetDefinition returns the Definition field if non-nil, zero value otherwise. + +### GetDefinitionOk + +`func (o *WorkflowBody) GetDefinitionOk() (*WorkflowDefinition, bool)` + +GetDefinitionOk returns a tuple with the Definition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefinition + +`func (o *WorkflowBody) SetDefinition(v WorkflowDefinition)` + +SetDefinition sets Definition field to given value. + +### HasDefinition + +`func (o *WorkflowBody) HasDefinition() bool` + +HasDefinition returns a boolean if a field has been set. + +### GetEnabled + +`func (o *WorkflowBody) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *WorkflowBody) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *WorkflowBody) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *WorkflowBody) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetTrigger + +`func (o *WorkflowBody) GetTrigger() WorkflowTrigger` + +GetTrigger returns the Trigger field if non-nil, zero value otherwise. + +### GetTriggerOk + +`func (o *WorkflowBody) GetTriggerOk() (*WorkflowTrigger, bool)` + +GetTriggerOk returns a tuple with the Trigger field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrigger + +`func (o *WorkflowBody) SetTrigger(v WorkflowTrigger)` + +SetTrigger sets Trigger field to given value. + +### HasTrigger + +`func (o *WorkflowBody) HasTrigger() bool` + +HasTrigger returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkflowBodyOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowBodyOwner.md new file mode 100644 index 000000000..365fa95f7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowBodyOwner.md @@ -0,0 +1,116 @@ +--- +id: v2024-workflow-body-owner +title: WorkflowBodyOwner +pagination_label: WorkflowBodyOwner +sidebar_label: WorkflowBodyOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowBodyOwner', 'V2024WorkflowBodyOwner'] +slug: /tools/sdk/go/v2024/models/workflow-body-owner +tags: ['SDK', 'Software Development Kit', 'WorkflowBodyOwner', 'V2024WorkflowBodyOwner'] +--- + +# WorkflowBodyOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of object that is referenced | [optional] +**Id** | Pointer to **string** | The unique ID of the object | [optional] +**Name** | Pointer to **string** | The name of the object | [optional] + +## Methods + +### NewWorkflowBodyOwner + +`func NewWorkflowBodyOwner() *WorkflowBodyOwner` + +NewWorkflowBodyOwner instantiates a new WorkflowBodyOwner 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 + +### NewWorkflowBodyOwnerWithDefaults + +`func NewWorkflowBodyOwnerWithDefaults() *WorkflowBodyOwner` + +NewWorkflowBodyOwnerWithDefaults instantiates a new WorkflowBodyOwner 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 + +### GetType + +`func (o *WorkflowBodyOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowBodyOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowBodyOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowBodyOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkflowBodyOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowBodyOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowBodyOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowBodyOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowBodyOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowBodyOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowBodyOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowBodyOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkflowDefinition.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowDefinition.md new file mode 100644 index 000000000..0680a3580 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowDefinition.md @@ -0,0 +1,90 @@ +--- +id: v2024-workflow-definition +title: WorkflowDefinition +pagination_label: WorkflowDefinition +sidebar_label: WorkflowDefinition +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowDefinition', 'V2024WorkflowDefinition'] +slug: /tools/sdk/go/v2024/models/workflow-definition +tags: ['SDK', 'Software Development Kit', 'WorkflowDefinition', 'V2024WorkflowDefinition'] +--- + +# WorkflowDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **string** | The name of the starting step. | [optional] +**Steps** | Pointer to **map[string]interface{}** | One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. | [optional] + +## Methods + +### NewWorkflowDefinition + +`func NewWorkflowDefinition() *WorkflowDefinition` + +NewWorkflowDefinition instantiates a new WorkflowDefinition 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 + +### NewWorkflowDefinitionWithDefaults + +`func NewWorkflowDefinitionWithDefaults() *WorkflowDefinition` + +NewWorkflowDefinitionWithDefaults instantiates a new WorkflowDefinition 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 + +### GetStart + +`func (o *WorkflowDefinition) GetStart() string` + +GetStart returns the Start field if non-nil, zero value otherwise. + +### GetStartOk + +`func (o *WorkflowDefinition) GetStartOk() (*string, bool)` + +GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStart + +`func (o *WorkflowDefinition) SetStart(v string)` + +SetStart sets Start field to given value. + +### HasStart + +`func (o *WorkflowDefinition) HasStart() bool` + +HasStart returns a boolean if a field has been set. + +### GetSteps + +`func (o *WorkflowDefinition) GetSteps() map[string]interface{}` + +GetSteps returns the Steps field if non-nil, zero value otherwise. + +### GetStepsOk + +`func (o *WorkflowDefinition) GetStepsOk() (*map[string]interface{}, bool)` + +GetStepsOk returns a tuple with the Steps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSteps + +`func (o *WorkflowDefinition) SetSteps(v map[string]interface{})` + +SetSteps sets Steps field to given value. + +### HasSteps + +`func (o *WorkflowDefinition) HasSteps() bool` + +HasSteps returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkflowExecution.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowExecution.md new file mode 100644 index 000000000..6438b0ce9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowExecution.md @@ -0,0 +1,194 @@ +--- +id: v2024-workflow-execution +title: WorkflowExecution +pagination_label: WorkflowExecution +sidebar_label: WorkflowExecution +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowExecution', 'V2024WorkflowExecution'] +slug: /tools/sdk/go/v2024/models/workflow-execution +tags: ['SDK', 'Software Development Kit', 'WorkflowExecution', 'V2024WorkflowExecution'] +--- + +# WorkflowExecution + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Workflow execution ID. | [optional] +**WorkflowId** | Pointer to **string** | Workflow ID. | [optional] +**RequestId** | Pointer to **string** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] +**StartTime** | Pointer to **SailPointTime** | Date/time when the workflow started. | [optional] +**CloseTime** | Pointer to **SailPointTime** | Date/time when the workflow ended. | [optional] +**Status** | Pointer to **string** | Workflow execution status. | [optional] + +## Methods + +### NewWorkflowExecution + +`func NewWorkflowExecution() *WorkflowExecution` + +NewWorkflowExecution instantiates a new WorkflowExecution 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 + +### NewWorkflowExecutionWithDefaults + +`func NewWorkflowExecutionWithDefaults() *WorkflowExecution` + +NewWorkflowExecutionWithDefaults instantiates a new WorkflowExecution 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 + +### GetId + +`func (o *WorkflowExecution) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowExecution) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowExecution) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowExecution) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetWorkflowId + +`func (o *WorkflowExecution) GetWorkflowId() string` + +GetWorkflowId returns the WorkflowId field if non-nil, zero value otherwise. + +### GetWorkflowIdOk + +`func (o *WorkflowExecution) GetWorkflowIdOk() (*string, bool)` + +GetWorkflowIdOk returns a tuple with the WorkflowId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWorkflowId + +`func (o *WorkflowExecution) SetWorkflowId(v string)` + +SetWorkflowId sets WorkflowId field to given value. + +### HasWorkflowId + +`func (o *WorkflowExecution) HasWorkflowId() bool` + +HasWorkflowId returns a boolean if a field has been set. + +### GetRequestId + +`func (o *WorkflowExecution) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *WorkflowExecution) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *WorkflowExecution) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *WorkflowExecution) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### GetStartTime + +`func (o *WorkflowExecution) GetStartTime() SailPointTime` + +GetStartTime returns the StartTime field if non-nil, zero value otherwise. + +### GetStartTimeOk + +`func (o *WorkflowExecution) GetStartTimeOk() (*SailPointTime, bool)` + +GetStartTimeOk returns a tuple with the StartTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartTime + +`func (o *WorkflowExecution) SetStartTime(v SailPointTime)` + +SetStartTime sets StartTime field to given value. + +### HasStartTime + +`func (o *WorkflowExecution) HasStartTime() bool` + +HasStartTime returns a boolean if a field has been set. + +### GetCloseTime + +`func (o *WorkflowExecution) GetCloseTime() SailPointTime` + +GetCloseTime returns the CloseTime field if non-nil, zero value otherwise. + +### GetCloseTimeOk + +`func (o *WorkflowExecution) GetCloseTimeOk() (*SailPointTime, bool)` + +GetCloseTimeOk returns a tuple with the CloseTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloseTime + +`func (o *WorkflowExecution) SetCloseTime(v SailPointTime)` + +SetCloseTime sets CloseTime field to given value. + +### HasCloseTime + +`func (o *WorkflowExecution) HasCloseTime() bool` + +HasCloseTime returns a boolean if a field has been set. + +### GetStatus + +`func (o *WorkflowExecution) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *WorkflowExecution) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *WorkflowExecution) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *WorkflowExecution) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkflowExecutionEvent.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowExecutionEvent.md new file mode 100644 index 000000000..df5bdc3ac --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowExecutionEvent.md @@ -0,0 +1,116 @@ +--- +id: v2024-workflow-execution-event +title: WorkflowExecutionEvent +pagination_label: WorkflowExecutionEvent +sidebar_label: WorkflowExecutionEvent +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowExecutionEvent', 'V2024WorkflowExecutionEvent'] +slug: /tools/sdk/go/v2024/models/workflow-execution-event +tags: ['SDK', 'Software Development Kit', 'WorkflowExecutionEvent', 'V2024WorkflowExecutionEvent'] +--- + +# WorkflowExecutionEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of event | [optional] +**Timestamp** | Pointer to **SailPointTime** | The date-time when the event occurred | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Additional attributes associated with the event | [optional] + +## Methods + +### NewWorkflowExecutionEvent + +`func NewWorkflowExecutionEvent() *WorkflowExecutionEvent` + +NewWorkflowExecutionEvent instantiates a new WorkflowExecutionEvent 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 + +### NewWorkflowExecutionEventWithDefaults + +`func NewWorkflowExecutionEventWithDefaults() *WorkflowExecutionEvent` + +NewWorkflowExecutionEventWithDefaults instantiates a new WorkflowExecutionEvent 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 + +### GetType + +`func (o *WorkflowExecutionEvent) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowExecutionEvent) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowExecutionEvent) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowExecutionEvent) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetTimestamp + +`func (o *WorkflowExecutionEvent) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *WorkflowExecutionEvent) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *WorkflowExecutionEvent) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *WorkflowExecutionEvent) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + +### GetAttributes + +`func (o *WorkflowExecutionEvent) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *WorkflowExecutionEvent) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *WorkflowExecutionEvent) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *WorkflowExecutionEvent) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkflowLibraryAction.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowLibraryAction.md new file mode 100644 index 000000000..8654560f7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowLibraryAction.md @@ -0,0 +1,360 @@ +--- +id: v2024-workflow-library-action +title: WorkflowLibraryAction +pagination_label: WorkflowLibraryAction +sidebar_label: WorkflowLibraryAction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryAction', 'V2024WorkflowLibraryAction'] +slug: /tools/sdk/go/v2024/models/workflow-library-action +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryAction', 'V2024WorkflowLibraryAction'] +--- + +# WorkflowLibraryAction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Action ID. This is a static namespaced ID for the action | [optional] +**Name** | Pointer to **string** | Action Name | [optional] +**Type** | Pointer to **string** | Action type | [optional] +**Description** | Pointer to **string** | Action Description | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the action accepts | [optional] +**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**Deprecated** | Pointer to **bool** | | [optional] +**DeprecatedBy** | Pointer to **SailPointTime** | | [optional] +**VersionNumber** | Pointer to **int32** | Version number | [optional] +**IsSimulationEnabled** | Pointer to **bool** | | [optional] +**IsDynamicSchema** | Pointer to **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] [default to false] +**OutputSchema** | Pointer to **map[string]interface{}** | Defines the output schema, if any, that this action produces. | [optional] + +## Methods + +### NewWorkflowLibraryAction + +`func NewWorkflowLibraryAction() *WorkflowLibraryAction` + +NewWorkflowLibraryAction instantiates a new WorkflowLibraryAction 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 + +### NewWorkflowLibraryActionWithDefaults + +`func NewWorkflowLibraryActionWithDefaults() *WorkflowLibraryAction` + +NewWorkflowLibraryActionWithDefaults instantiates a new WorkflowLibraryAction 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 + +### GetId + +`func (o *WorkflowLibraryAction) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowLibraryAction) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowLibraryAction) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowLibraryAction) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowLibraryAction) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowLibraryAction) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowLibraryAction) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowLibraryAction) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *WorkflowLibraryAction) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowLibraryAction) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowLibraryAction) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowLibraryAction) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkflowLibraryAction) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowLibraryAction) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowLibraryAction) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowLibraryAction) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetFormFields + +`func (o *WorkflowLibraryAction) GetFormFields() []WorkflowLibraryFormFields` + +GetFormFields returns the FormFields field if non-nil, zero value otherwise. + +### GetFormFieldsOk + +`func (o *WorkflowLibraryAction) GetFormFieldsOk() (*[]WorkflowLibraryFormFields, bool)` + +GetFormFieldsOk returns a tuple with the FormFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormFields + +`func (o *WorkflowLibraryAction) SetFormFields(v []WorkflowLibraryFormFields)` + +SetFormFields sets FormFields field to given value. + +### HasFormFields + +`func (o *WorkflowLibraryAction) HasFormFields() bool` + +HasFormFields returns a boolean if a field has been set. + +### SetFormFieldsNil + +`func (o *WorkflowLibraryAction) SetFormFieldsNil(b bool)` + + SetFormFieldsNil sets the value for FormFields to be an explicit nil + +### UnsetFormFields +`func (o *WorkflowLibraryAction) UnsetFormFields()` + +UnsetFormFields ensures that no value is present for FormFields, not even an explicit nil +### GetExampleOutput + +`func (o *WorkflowLibraryAction) GetExampleOutput() WorkflowLibraryActionExampleOutput` + +GetExampleOutput returns the ExampleOutput field if non-nil, zero value otherwise. + +### GetExampleOutputOk + +`func (o *WorkflowLibraryAction) GetExampleOutputOk() (*WorkflowLibraryActionExampleOutput, bool)` + +GetExampleOutputOk returns a tuple with the ExampleOutput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExampleOutput + +`func (o *WorkflowLibraryAction) SetExampleOutput(v WorkflowLibraryActionExampleOutput)` + +SetExampleOutput sets ExampleOutput field to given value. + +### HasExampleOutput + +`func (o *WorkflowLibraryAction) HasExampleOutput() bool` + +HasExampleOutput returns a boolean if a field has been set. + +### GetDeprecated + +`func (o *WorkflowLibraryAction) GetDeprecated() bool` + +GetDeprecated returns the Deprecated field if non-nil, zero value otherwise. + +### GetDeprecatedOk + +`func (o *WorkflowLibraryAction) GetDeprecatedOk() (*bool, bool)` + +GetDeprecatedOk returns a tuple with the Deprecated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecated + +`func (o *WorkflowLibraryAction) SetDeprecated(v bool)` + +SetDeprecated sets Deprecated field to given value. + +### HasDeprecated + +`func (o *WorkflowLibraryAction) HasDeprecated() bool` + +HasDeprecated returns a boolean if a field has been set. + +### GetDeprecatedBy + +`func (o *WorkflowLibraryAction) GetDeprecatedBy() SailPointTime` + +GetDeprecatedBy returns the DeprecatedBy field if non-nil, zero value otherwise. + +### GetDeprecatedByOk + +`func (o *WorkflowLibraryAction) GetDeprecatedByOk() (*SailPointTime, bool)` + +GetDeprecatedByOk returns a tuple with the DeprecatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecatedBy + +`func (o *WorkflowLibraryAction) SetDeprecatedBy(v SailPointTime)` + +SetDeprecatedBy sets DeprecatedBy field to given value. + +### HasDeprecatedBy + +`func (o *WorkflowLibraryAction) HasDeprecatedBy() bool` + +HasDeprecatedBy returns a boolean if a field has been set. + +### GetVersionNumber + +`func (o *WorkflowLibraryAction) GetVersionNumber() int32` + +GetVersionNumber returns the VersionNumber field if non-nil, zero value otherwise. + +### GetVersionNumberOk + +`func (o *WorkflowLibraryAction) GetVersionNumberOk() (*int32, bool)` + +GetVersionNumberOk returns a tuple with the VersionNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionNumber + +`func (o *WorkflowLibraryAction) SetVersionNumber(v int32)` + +SetVersionNumber sets VersionNumber field to given value. + +### HasVersionNumber + +`func (o *WorkflowLibraryAction) HasVersionNumber() bool` + +HasVersionNumber returns a boolean if a field has been set. + +### GetIsSimulationEnabled + +`func (o *WorkflowLibraryAction) GetIsSimulationEnabled() bool` + +GetIsSimulationEnabled returns the IsSimulationEnabled field if non-nil, zero value otherwise. + +### GetIsSimulationEnabledOk + +`func (o *WorkflowLibraryAction) GetIsSimulationEnabledOk() (*bool, bool)` + +GetIsSimulationEnabledOk returns a tuple with the IsSimulationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSimulationEnabled + +`func (o *WorkflowLibraryAction) SetIsSimulationEnabled(v bool)` + +SetIsSimulationEnabled sets IsSimulationEnabled field to given value. + +### HasIsSimulationEnabled + +`func (o *WorkflowLibraryAction) HasIsSimulationEnabled() bool` + +HasIsSimulationEnabled returns a boolean if a field has been set. + +### GetIsDynamicSchema + +`func (o *WorkflowLibraryAction) GetIsDynamicSchema() bool` + +GetIsDynamicSchema returns the IsDynamicSchema field if non-nil, zero value otherwise. + +### GetIsDynamicSchemaOk + +`func (o *WorkflowLibraryAction) GetIsDynamicSchemaOk() (*bool, bool)` + +GetIsDynamicSchemaOk returns a tuple with the IsDynamicSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDynamicSchema + +`func (o *WorkflowLibraryAction) SetIsDynamicSchema(v bool)` + +SetIsDynamicSchema sets IsDynamicSchema field to given value. + +### HasIsDynamicSchema + +`func (o *WorkflowLibraryAction) HasIsDynamicSchema() bool` + +HasIsDynamicSchema returns a boolean if a field has been set. + +### GetOutputSchema + +`func (o *WorkflowLibraryAction) GetOutputSchema() map[string]interface{}` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *WorkflowLibraryAction) GetOutputSchemaOk() (*map[string]interface{}, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *WorkflowLibraryAction) SetOutputSchema(v map[string]interface{})` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *WorkflowLibraryAction) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkflowLibraryActionExampleOutput.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowLibraryActionExampleOutput.md new file mode 100644 index 000000000..84fe2f84e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowLibraryActionExampleOutput.md @@ -0,0 +1,38 @@ +--- +id: v2024-workflow-library-action-example-output +title: WorkflowLibraryActionExampleOutput +pagination_label: WorkflowLibraryActionExampleOutput +sidebar_label: WorkflowLibraryActionExampleOutput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryActionExampleOutput', 'V2024WorkflowLibraryActionExampleOutput'] +slug: /tools/sdk/go/v2024/models/workflow-library-action-example-output +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryActionExampleOutput', 'V2024WorkflowLibraryActionExampleOutput'] +--- + +# WorkflowLibraryActionExampleOutput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewWorkflowLibraryActionExampleOutput + +`func NewWorkflowLibraryActionExampleOutput() *WorkflowLibraryActionExampleOutput` + +NewWorkflowLibraryActionExampleOutput instantiates a new WorkflowLibraryActionExampleOutput 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 + +### NewWorkflowLibraryActionExampleOutputWithDefaults + +`func NewWorkflowLibraryActionExampleOutputWithDefaults() *WorkflowLibraryActionExampleOutput` + +NewWorkflowLibraryActionExampleOutputWithDefaults instantiates a new WorkflowLibraryActionExampleOutput 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 + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkflowLibraryFormFields.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowLibraryFormFields.md new file mode 100644 index 000000000..825b92a9f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowLibraryFormFields.md @@ -0,0 +1,204 @@ +--- +id: v2024-workflow-library-form-fields +title: WorkflowLibraryFormFields +pagination_label: WorkflowLibraryFormFields +sidebar_label: WorkflowLibraryFormFields +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryFormFields', 'V2024WorkflowLibraryFormFields'] +slug: /tools/sdk/go/v2024/models/workflow-library-form-fields +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryFormFields', 'V2024WorkflowLibraryFormFields'] +--- + +# WorkflowLibraryFormFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Description of the form field | [optional] +**HelpText** | Pointer to **string** | Describes the form field in the UI | [optional] +**Label** | Pointer to **string** | A human readable name for this form field in the UI | [optional] +**Name** | Pointer to **string** | The name of the input attribute | [optional] +**Required** | Pointer to **bool** | Denotes if this field is a required attribute | [optional] [default to false] +**Type** | Pointer to **NullableString** | The type of the form field | [optional] + +## Methods + +### NewWorkflowLibraryFormFields + +`func NewWorkflowLibraryFormFields() *WorkflowLibraryFormFields` + +NewWorkflowLibraryFormFields instantiates a new WorkflowLibraryFormFields 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 + +### NewWorkflowLibraryFormFieldsWithDefaults + +`func NewWorkflowLibraryFormFieldsWithDefaults() *WorkflowLibraryFormFields` + +NewWorkflowLibraryFormFieldsWithDefaults instantiates a new WorkflowLibraryFormFields 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 + +### GetDescription + +`func (o *WorkflowLibraryFormFields) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowLibraryFormFields) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowLibraryFormFields) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowLibraryFormFields) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetHelpText + +`func (o *WorkflowLibraryFormFields) GetHelpText() string` + +GetHelpText returns the HelpText field if non-nil, zero value otherwise. + +### GetHelpTextOk + +`func (o *WorkflowLibraryFormFields) GetHelpTextOk() (*string, bool)` + +GetHelpTextOk returns a tuple with the HelpText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHelpText + +`func (o *WorkflowLibraryFormFields) SetHelpText(v string)` + +SetHelpText sets HelpText field to given value. + +### HasHelpText + +`func (o *WorkflowLibraryFormFields) HasHelpText() bool` + +HasHelpText returns a boolean if a field has been set. + +### GetLabel + +`func (o *WorkflowLibraryFormFields) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *WorkflowLibraryFormFields) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *WorkflowLibraryFormFields) SetLabel(v string)` + +SetLabel sets Label field to given value. + +### HasLabel + +`func (o *WorkflowLibraryFormFields) HasLabel() bool` + +HasLabel returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowLibraryFormFields) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowLibraryFormFields) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowLibraryFormFields) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowLibraryFormFields) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetRequired + +`func (o *WorkflowLibraryFormFields) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *WorkflowLibraryFormFields) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *WorkflowLibraryFormFields) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *WorkflowLibraryFormFields) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + +### GetType + +`func (o *WorkflowLibraryFormFields) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowLibraryFormFields) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowLibraryFormFields) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowLibraryFormFields) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *WorkflowLibraryFormFields) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *WorkflowLibraryFormFields) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkflowLibraryOperator.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowLibraryOperator.md new file mode 100644 index 000000000..a235b4acb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowLibraryOperator.md @@ -0,0 +1,282 @@ +--- +id: v2024-workflow-library-operator +title: WorkflowLibraryOperator +pagination_label: WorkflowLibraryOperator +sidebar_label: WorkflowLibraryOperator +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryOperator', 'V2024WorkflowLibraryOperator'] +slug: /tools/sdk/go/v2024/models/workflow-library-operator +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryOperator', 'V2024WorkflowLibraryOperator'] +--- + +# WorkflowLibraryOperator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Operator ID. | [optional] +**Name** | Pointer to **string** | Operator friendly name | [optional] +**Type** | Pointer to **string** | Operator type | [optional] +**Description** | Pointer to **string** | Description of the operator | [optional] +**IsDynamicSchema** | Pointer to **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**Deprecated** | Pointer to **bool** | | [optional] +**DeprecatedBy** | Pointer to **SailPointTime** | | [optional] +**IsSimulationEnabled** | Pointer to **bool** | | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] + +## Methods + +### NewWorkflowLibraryOperator + +`func NewWorkflowLibraryOperator() *WorkflowLibraryOperator` + +NewWorkflowLibraryOperator instantiates a new WorkflowLibraryOperator 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 + +### NewWorkflowLibraryOperatorWithDefaults + +`func NewWorkflowLibraryOperatorWithDefaults() *WorkflowLibraryOperator` + +NewWorkflowLibraryOperatorWithDefaults instantiates a new WorkflowLibraryOperator 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 + +### GetId + +`func (o *WorkflowLibraryOperator) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowLibraryOperator) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowLibraryOperator) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowLibraryOperator) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowLibraryOperator) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowLibraryOperator) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowLibraryOperator) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowLibraryOperator) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *WorkflowLibraryOperator) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowLibraryOperator) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowLibraryOperator) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowLibraryOperator) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkflowLibraryOperator) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowLibraryOperator) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowLibraryOperator) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowLibraryOperator) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIsDynamicSchema + +`func (o *WorkflowLibraryOperator) GetIsDynamicSchema() bool` + +GetIsDynamicSchema returns the IsDynamicSchema field if non-nil, zero value otherwise. + +### GetIsDynamicSchemaOk + +`func (o *WorkflowLibraryOperator) GetIsDynamicSchemaOk() (*bool, bool)` + +GetIsDynamicSchemaOk returns a tuple with the IsDynamicSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDynamicSchema + +`func (o *WorkflowLibraryOperator) SetIsDynamicSchema(v bool)` + +SetIsDynamicSchema sets IsDynamicSchema field to given value. + +### HasIsDynamicSchema + +`func (o *WorkflowLibraryOperator) HasIsDynamicSchema() bool` + +HasIsDynamicSchema returns a boolean if a field has been set. + +### GetDeprecated + +`func (o *WorkflowLibraryOperator) GetDeprecated() bool` + +GetDeprecated returns the Deprecated field if non-nil, zero value otherwise. + +### GetDeprecatedOk + +`func (o *WorkflowLibraryOperator) GetDeprecatedOk() (*bool, bool)` + +GetDeprecatedOk returns a tuple with the Deprecated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecated + +`func (o *WorkflowLibraryOperator) SetDeprecated(v bool)` + +SetDeprecated sets Deprecated field to given value. + +### HasDeprecated + +`func (o *WorkflowLibraryOperator) HasDeprecated() bool` + +HasDeprecated returns a boolean if a field has been set. + +### GetDeprecatedBy + +`func (o *WorkflowLibraryOperator) GetDeprecatedBy() SailPointTime` + +GetDeprecatedBy returns the DeprecatedBy field if non-nil, zero value otherwise. + +### GetDeprecatedByOk + +`func (o *WorkflowLibraryOperator) GetDeprecatedByOk() (*SailPointTime, bool)` + +GetDeprecatedByOk returns a tuple with the DeprecatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecatedBy + +`func (o *WorkflowLibraryOperator) SetDeprecatedBy(v SailPointTime)` + +SetDeprecatedBy sets DeprecatedBy field to given value. + +### HasDeprecatedBy + +`func (o *WorkflowLibraryOperator) HasDeprecatedBy() bool` + +HasDeprecatedBy returns a boolean if a field has been set. + +### GetIsSimulationEnabled + +`func (o *WorkflowLibraryOperator) GetIsSimulationEnabled() bool` + +GetIsSimulationEnabled returns the IsSimulationEnabled field if non-nil, zero value otherwise. + +### GetIsSimulationEnabledOk + +`func (o *WorkflowLibraryOperator) GetIsSimulationEnabledOk() (*bool, bool)` + +GetIsSimulationEnabledOk returns a tuple with the IsSimulationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSimulationEnabled + +`func (o *WorkflowLibraryOperator) SetIsSimulationEnabled(v bool)` + +SetIsSimulationEnabled sets IsSimulationEnabled field to given value. + +### HasIsSimulationEnabled + +`func (o *WorkflowLibraryOperator) HasIsSimulationEnabled() bool` + +HasIsSimulationEnabled returns a boolean if a field has been set. + +### GetFormFields + +`func (o *WorkflowLibraryOperator) GetFormFields() []WorkflowLibraryFormFields` + +GetFormFields returns the FormFields field if non-nil, zero value otherwise. + +### GetFormFieldsOk + +`func (o *WorkflowLibraryOperator) GetFormFieldsOk() (*[]WorkflowLibraryFormFields, bool)` + +GetFormFieldsOk returns a tuple with the FormFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormFields + +`func (o *WorkflowLibraryOperator) SetFormFields(v []WorkflowLibraryFormFields)` + +SetFormFields sets FormFields field to given value. + +### HasFormFields + +`func (o *WorkflowLibraryOperator) HasFormFields() bool` + +HasFormFields returns a boolean if a field has been set. + +### SetFormFieldsNil + +`func (o *WorkflowLibraryOperator) SetFormFieldsNil(b bool)` + + SetFormFieldsNil sets the value for FormFields to be an explicit nil + +### UnsetFormFields +`func (o *WorkflowLibraryOperator) UnsetFormFields()` + +UnsetFormFields ensures that no value is present for FormFields, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkflowLibraryTrigger.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowLibraryTrigger.md new file mode 100644 index 000000000..725a76d10 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowLibraryTrigger.md @@ -0,0 +1,344 @@ +--- +id: v2024-workflow-library-trigger +title: WorkflowLibraryTrigger +pagination_label: WorkflowLibraryTrigger +sidebar_label: WorkflowLibraryTrigger +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryTrigger', 'V2024WorkflowLibraryTrigger'] +slug: /tools/sdk/go/v2024/models/workflow-library-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryTrigger', 'V2024WorkflowLibraryTrigger'] +--- + +# WorkflowLibraryTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Trigger ID. This is a static namespaced ID for the trigger. | [optional] +**Type** | Pointer to **string** | Trigger type | [optional] +**Deprecated** | Pointer to **bool** | | [optional] +**DeprecatedBy** | Pointer to **SailPointTime** | | [optional] +**IsSimulationEnabled** | Pointer to **bool** | | [optional] +**OutputSchema** | Pointer to **map[string]interface{}** | Example output schema | [optional] +**Name** | Pointer to **string** | Trigger Name | [optional] +**Description** | Pointer to **string** | Trigger Description | [optional] +**IsDynamicSchema** | Pointer to **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] [default to false] +**InputExample** | Pointer to **map[string]interface{}** | Example trigger payload if applicable | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the trigger accepts | [optional] + +## Methods + +### NewWorkflowLibraryTrigger + +`func NewWorkflowLibraryTrigger() *WorkflowLibraryTrigger` + +NewWorkflowLibraryTrigger instantiates a new WorkflowLibraryTrigger 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 + +### NewWorkflowLibraryTriggerWithDefaults + +`func NewWorkflowLibraryTriggerWithDefaults() *WorkflowLibraryTrigger` + +NewWorkflowLibraryTriggerWithDefaults instantiates a new WorkflowLibraryTrigger 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 + +### GetId + +`func (o *WorkflowLibraryTrigger) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowLibraryTrigger) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowLibraryTrigger) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowLibraryTrigger) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *WorkflowLibraryTrigger) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowLibraryTrigger) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowLibraryTrigger) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowLibraryTrigger) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDeprecated + +`func (o *WorkflowLibraryTrigger) GetDeprecated() bool` + +GetDeprecated returns the Deprecated field if non-nil, zero value otherwise. + +### GetDeprecatedOk + +`func (o *WorkflowLibraryTrigger) GetDeprecatedOk() (*bool, bool)` + +GetDeprecatedOk returns a tuple with the Deprecated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecated + +`func (o *WorkflowLibraryTrigger) SetDeprecated(v bool)` + +SetDeprecated sets Deprecated field to given value. + +### HasDeprecated + +`func (o *WorkflowLibraryTrigger) HasDeprecated() bool` + +HasDeprecated returns a boolean if a field has been set. + +### GetDeprecatedBy + +`func (o *WorkflowLibraryTrigger) GetDeprecatedBy() SailPointTime` + +GetDeprecatedBy returns the DeprecatedBy field if non-nil, zero value otherwise. + +### GetDeprecatedByOk + +`func (o *WorkflowLibraryTrigger) GetDeprecatedByOk() (*SailPointTime, bool)` + +GetDeprecatedByOk returns a tuple with the DeprecatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecatedBy + +`func (o *WorkflowLibraryTrigger) SetDeprecatedBy(v SailPointTime)` + +SetDeprecatedBy sets DeprecatedBy field to given value. + +### HasDeprecatedBy + +`func (o *WorkflowLibraryTrigger) HasDeprecatedBy() bool` + +HasDeprecatedBy returns a boolean if a field has been set. + +### GetIsSimulationEnabled + +`func (o *WorkflowLibraryTrigger) GetIsSimulationEnabled() bool` + +GetIsSimulationEnabled returns the IsSimulationEnabled field if non-nil, zero value otherwise. + +### GetIsSimulationEnabledOk + +`func (o *WorkflowLibraryTrigger) GetIsSimulationEnabledOk() (*bool, bool)` + +GetIsSimulationEnabledOk returns a tuple with the IsSimulationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSimulationEnabled + +`func (o *WorkflowLibraryTrigger) SetIsSimulationEnabled(v bool)` + +SetIsSimulationEnabled sets IsSimulationEnabled field to given value. + +### HasIsSimulationEnabled + +`func (o *WorkflowLibraryTrigger) HasIsSimulationEnabled() bool` + +HasIsSimulationEnabled returns a boolean if a field has been set. + +### GetOutputSchema + +`func (o *WorkflowLibraryTrigger) GetOutputSchema() map[string]interface{}` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *WorkflowLibraryTrigger) GetOutputSchemaOk() (*map[string]interface{}, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *WorkflowLibraryTrigger) SetOutputSchema(v map[string]interface{})` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *WorkflowLibraryTrigger) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowLibraryTrigger) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowLibraryTrigger) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowLibraryTrigger) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowLibraryTrigger) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkflowLibraryTrigger) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowLibraryTrigger) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowLibraryTrigger) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowLibraryTrigger) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIsDynamicSchema + +`func (o *WorkflowLibraryTrigger) GetIsDynamicSchema() bool` + +GetIsDynamicSchema returns the IsDynamicSchema field if non-nil, zero value otherwise. + +### GetIsDynamicSchemaOk + +`func (o *WorkflowLibraryTrigger) GetIsDynamicSchemaOk() (*bool, bool)` + +GetIsDynamicSchemaOk returns a tuple with the IsDynamicSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDynamicSchema + +`func (o *WorkflowLibraryTrigger) SetIsDynamicSchema(v bool)` + +SetIsDynamicSchema sets IsDynamicSchema field to given value. + +### HasIsDynamicSchema + +`func (o *WorkflowLibraryTrigger) HasIsDynamicSchema() bool` + +HasIsDynamicSchema returns a boolean if a field has been set. + +### GetInputExample + +`func (o *WorkflowLibraryTrigger) GetInputExample() map[string]interface{}` + +GetInputExample returns the InputExample field if non-nil, zero value otherwise. + +### GetInputExampleOk + +`func (o *WorkflowLibraryTrigger) GetInputExampleOk() (*map[string]interface{}, bool)` + +GetInputExampleOk returns a tuple with the InputExample field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInputExample + +`func (o *WorkflowLibraryTrigger) SetInputExample(v map[string]interface{})` + +SetInputExample sets InputExample field to given value. + +### HasInputExample + +`func (o *WorkflowLibraryTrigger) HasInputExample() bool` + +HasInputExample returns a boolean if a field has been set. + +### SetInputExampleNil + +`func (o *WorkflowLibraryTrigger) SetInputExampleNil(b bool)` + + SetInputExampleNil sets the value for InputExample to be an explicit nil + +### UnsetInputExample +`func (o *WorkflowLibraryTrigger) UnsetInputExample()` + +UnsetInputExample ensures that no value is present for InputExample, not even an explicit nil +### GetFormFields + +`func (o *WorkflowLibraryTrigger) GetFormFields() []WorkflowLibraryFormFields` + +GetFormFields returns the FormFields field if non-nil, zero value otherwise. + +### GetFormFieldsOk + +`func (o *WorkflowLibraryTrigger) GetFormFieldsOk() (*[]WorkflowLibraryFormFields, bool)` + +GetFormFieldsOk returns a tuple with the FormFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormFields + +`func (o *WorkflowLibraryTrigger) SetFormFields(v []WorkflowLibraryFormFields)` + +SetFormFields sets FormFields field to given value. + +### HasFormFields + +`func (o *WorkflowLibraryTrigger) HasFormFields() bool` + +HasFormFields returns a boolean if a field has been set. + +### SetFormFieldsNil + +`func (o *WorkflowLibraryTrigger) SetFormFieldsNil(b bool)` + + SetFormFieldsNil sets the value for FormFields to be an explicit nil + +### UnsetFormFields +`func (o *WorkflowLibraryTrigger) UnsetFormFields()` + +UnsetFormFields ensures that no value is present for FormFields, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkflowModifiedBy.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowModifiedBy.md new file mode 100644 index 000000000..a88f655ce --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowModifiedBy.md @@ -0,0 +1,116 @@ +--- +id: v2024-workflow-modified-by +title: WorkflowModifiedBy +pagination_label: WorkflowModifiedBy +sidebar_label: WorkflowModifiedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowModifiedBy', 'V2024WorkflowModifiedBy'] +slug: /tools/sdk/go/v2024/models/workflow-modified-by +tags: ['SDK', 'Software Development Kit', 'WorkflowModifiedBy', 'V2024WorkflowModifiedBy'] +--- + +# WorkflowModifiedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | | [optional] +**Id** | Pointer to **string** | Identity ID | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity. | [optional] + +## Methods + +### NewWorkflowModifiedBy + +`func NewWorkflowModifiedBy() *WorkflowModifiedBy` + +NewWorkflowModifiedBy instantiates a new WorkflowModifiedBy 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 + +### NewWorkflowModifiedByWithDefaults + +`func NewWorkflowModifiedByWithDefaults() *WorkflowModifiedBy` + +NewWorkflowModifiedByWithDefaults instantiates a new WorkflowModifiedBy 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 + +### GetType + +`func (o *WorkflowModifiedBy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowModifiedBy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowModifiedBy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowModifiedBy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkflowModifiedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowModifiedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowModifiedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowModifiedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowModifiedBy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowModifiedBy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowModifiedBy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowModifiedBy) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkflowOAuthClient.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowOAuthClient.md new file mode 100644 index 000000000..dd2522ae1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowOAuthClient.md @@ -0,0 +1,116 @@ +--- +id: v2024-workflow-o-auth-client +title: WorkflowOAuthClient +pagination_label: WorkflowOAuthClient +sidebar_label: WorkflowOAuthClient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowOAuthClient', 'V2024WorkflowOAuthClient'] +slug: /tools/sdk/go/v2024/models/workflow-o-auth-client +tags: ['SDK', 'Software Development Kit', 'WorkflowOAuthClient', 'V2024WorkflowOAuthClient'] +--- + +# WorkflowOAuthClient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | OAuth client ID for the trigger. This is a UUID generated upon creation. | [optional] +**Secret** | Pointer to **string** | OAuthClient secret. | [optional] +**Url** | Pointer to **string** | URL for the external trigger to invoke | [optional] + +## Methods + +### NewWorkflowOAuthClient + +`func NewWorkflowOAuthClient() *WorkflowOAuthClient` + +NewWorkflowOAuthClient instantiates a new WorkflowOAuthClient 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 + +### NewWorkflowOAuthClientWithDefaults + +`func NewWorkflowOAuthClientWithDefaults() *WorkflowOAuthClient` + +NewWorkflowOAuthClientWithDefaults instantiates a new WorkflowOAuthClient 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 + +### GetId + +`func (o *WorkflowOAuthClient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowOAuthClient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowOAuthClient) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowOAuthClient) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSecret + +`func (o *WorkflowOAuthClient) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *WorkflowOAuthClient) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *WorkflowOAuthClient) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *WorkflowOAuthClient) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### GetUrl + +`func (o *WorkflowOAuthClient) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *WorkflowOAuthClient) GetUrlOk() (*string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrl + +`func (o *WorkflowOAuthClient) SetUrl(v string)` + +SetUrl sets Url field to given value. + +### HasUrl + +`func (o *WorkflowOAuthClient) HasUrl() bool` + +HasUrl returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkflowTrigger.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowTrigger.md new file mode 100644 index 000000000..df6e82af9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkflowTrigger.md @@ -0,0 +1,126 @@ +--- +id: v2024-workflow-trigger +title: WorkflowTrigger +pagination_label: WorkflowTrigger +sidebar_label: WorkflowTrigger +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowTrigger', 'V2024WorkflowTrigger'] +slug: /tools/sdk/go/v2024/models/workflow-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowTrigger', 'V2024WorkflowTrigger'] +--- + +# WorkflowTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The trigger type | +**DisplayName** | Pointer to **NullableString** | | [optional] +**Attributes** | **map[string]interface{}** | Workflow Trigger Attributes. | + +## Methods + +### NewWorkflowTrigger + +`func NewWorkflowTrigger(type_ string, attributes map[string]interface{}, ) *WorkflowTrigger` + +NewWorkflowTrigger instantiates a new WorkflowTrigger 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 + +### NewWorkflowTriggerWithDefaults + +`func NewWorkflowTriggerWithDefaults() *WorkflowTrigger` + +NewWorkflowTriggerWithDefaults instantiates a new WorkflowTrigger 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 + +### GetType + +`func (o *WorkflowTrigger) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowTrigger) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowTrigger) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDisplayName + +`func (o *WorkflowTrigger) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *WorkflowTrigger) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *WorkflowTrigger) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *WorkflowTrigger) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### SetDisplayNameNil + +`func (o *WorkflowTrigger) SetDisplayNameNil(b bool)` + + SetDisplayNameNil sets the value for DisplayName to be an explicit nil + +### UnsetDisplayName +`func (o *WorkflowTrigger) UnsetDisplayName()` + +UnsetDisplayName ensures that no value is present for DisplayName, not even an explicit nil +### GetAttributes + +`func (o *WorkflowTrigger) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *WorkflowTrigger) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *WorkflowTrigger) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *WorkflowTrigger) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *WorkflowTrigger) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupBulkDeleteRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupBulkDeleteRequest.md new file mode 100644 index 000000000..2ed6524da --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupBulkDeleteRequest.md @@ -0,0 +1,64 @@ +--- +id: v2024-workgroup-bulk-delete-request +title: WorkgroupBulkDeleteRequest +pagination_label: WorkgroupBulkDeleteRequest +sidebar_label: WorkgroupBulkDeleteRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupBulkDeleteRequest', 'V2024WorkgroupBulkDeleteRequest'] +slug: /tools/sdk/go/v2024/models/workgroup-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'WorkgroupBulkDeleteRequest', 'V2024WorkgroupBulkDeleteRequest'] +--- + +# WorkgroupBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]string** | List of IDs of Governance Groups to be deleted. | [optional] + +## Methods + +### NewWorkgroupBulkDeleteRequest + +`func NewWorkgroupBulkDeleteRequest() *WorkgroupBulkDeleteRequest` + +NewWorkgroupBulkDeleteRequest instantiates a new WorkgroupBulkDeleteRequest 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 + +### NewWorkgroupBulkDeleteRequestWithDefaults + +`func NewWorkgroupBulkDeleteRequestWithDefaults() *WorkgroupBulkDeleteRequest` + +NewWorkgroupBulkDeleteRequestWithDefaults instantiates a new WorkgroupBulkDeleteRequest 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 + +### GetIds + +`func (o *WorkgroupBulkDeleteRequest) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *WorkgroupBulkDeleteRequest) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *WorkgroupBulkDeleteRequest) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *WorkgroupBulkDeleteRequest) HasIds() bool` + +HasIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupConnectionDto.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupConnectionDto.md new file mode 100644 index 000000000..1b4357a18 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupConnectionDto.md @@ -0,0 +1,90 @@ +--- +id: v2024-workgroup-connection-dto +title: WorkgroupConnectionDto +pagination_label: WorkgroupConnectionDto +sidebar_label: WorkgroupConnectionDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupConnectionDto', 'V2024WorkgroupConnectionDto'] +slug: /tools/sdk/go/v2024/models/workgroup-connection-dto +tags: ['SDK', 'Software Development Kit', 'WorkgroupConnectionDto', 'V2024WorkgroupConnectionDto'] +--- + +# WorkgroupConnectionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Object** | Pointer to [**WorkgroupConnectionDtoObject**](workgroup-connection-dto-object) | | [optional] +**ConnectionType** | Pointer to **string** | Connection Type. | [optional] + +## Methods + +### NewWorkgroupConnectionDto + +`func NewWorkgroupConnectionDto() *WorkgroupConnectionDto` + +NewWorkgroupConnectionDto instantiates a new WorkgroupConnectionDto 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 + +### NewWorkgroupConnectionDtoWithDefaults + +`func NewWorkgroupConnectionDtoWithDefaults() *WorkgroupConnectionDto` + +NewWorkgroupConnectionDtoWithDefaults instantiates a new WorkgroupConnectionDto 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 + +### GetObject + +`func (o *WorkgroupConnectionDto) GetObject() WorkgroupConnectionDtoObject` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *WorkgroupConnectionDto) GetObjectOk() (*WorkgroupConnectionDtoObject, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *WorkgroupConnectionDto) SetObject(v WorkgroupConnectionDtoObject)` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *WorkgroupConnectionDto) HasObject() bool` + +HasObject returns a boolean if a field has been set. + +### GetConnectionType + +`func (o *WorkgroupConnectionDto) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *WorkgroupConnectionDto) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *WorkgroupConnectionDto) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *WorkgroupConnectionDto) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupConnectionDtoObject.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupConnectionDtoObject.md new file mode 100644 index 000000000..fb7f20136 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupConnectionDtoObject.md @@ -0,0 +1,152 @@ +--- +id: v2024-workgroup-connection-dto-object +title: WorkgroupConnectionDtoObject +pagination_label: WorkgroupConnectionDtoObject +sidebar_label: WorkgroupConnectionDtoObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupConnectionDtoObject', 'V2024WorkgroupConnectionDtoObject'] +slug: /tools/sdk/go/v2024/models/workgroup-connection-dto-object +tags: ['SDK', 'Software Development Kit', 'WorkgroupConnectionDtoObject', 'V2024WorkgroupConnectionDtoObject'] +--- + +# WorkgroupConnectionDtoObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**ConnectedObjectType**](connected-object-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable name of Connected object | [optional] +**Description** | Pointer to **NullableString** | Description of the Connected object. | [optional] + +## Methods + +### NewWorkgroupConnectionDtoObject + +`func NewWorkgroupConnectionDtoObject() *WorkgroupConnectionDtoObject` + +NewWorkgroupConnectionDtoObject instantiates a new WorkgroupConnectionDtoObject 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 + +### NewWorkgroupConnectionDtoObjectWithDefaults + +`func NewWorkgroupConnectionDtoObjectWithDefaults() *WorkgroupConnectionDtoObject` + +NewWorkgroupConnectionDtoObjectWithDefaults instantiates a new WorkgroupConnectionDtoObject 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 + +### GetType + +`func (o *WorkgroupConnectionDtoObject) GetType() ConnectedObjectType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkgroupConnectionDtoObject) GetTypeOk() (*ConnectedObjectType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkgroupConnectionDtoObject) SetType(v ConnectedObjectType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkgroupConnectionDtoObject) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkgroupConnectionDtoObject) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupConnectionDtoObject) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupConnectionDtoObject) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkgroupConnectionDtoObject) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkgroupConnectionDtoObject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkgroupConnectionDtoObject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkgroupConnectionDtoObject) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkgroupConnectionDtoObject) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkgroupConnectionDtoObject) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkgroupConnectionDtoObject) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkgroupConnectionDtoObject) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkgroupConnectionDtoObject) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *WorkgroupConnectionDtoObject) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *WorkgroupConnectionDtoObject) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupDeleteItem.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupDeleteItem.md new file mode 100644 index 000000000..4098d72d9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupDeleteItem.md @@ -0,0 +1,106 @@ +--- +id: v2024-workgroup-delete-item +title: WorkgroupDeleteItem +pagination_label: WorkgroupDeleteItem +sidebar_label: WorkgroupDeleteItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupDeleteItem', 'V2024WorkgroupDeleteItem'] +slug: /tools/sdk/go/v2024/models/workgroup-delete-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupDeleteItem', 'V2024WorkgroupDeleteItem'] +--- + +# WorkgroupDeleteItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Id of the Governance Group. | +**Status** | **int32** | The HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation. > 204 - Governance Group deleted successfully. > 409 - Governance Group is in use,hence can not be deleted. > 404 - Governance Group not found. | +**Description** | Pointer to **string** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Methods + +### NewWorkgroupDeleteItem + +`func NewWorkgroupDeleteItem(id string, status int32, ) *WorkgroupDeleteItem` + +NewWorkgroupDeleteItem instantiates a new WorkgroupDeleteItem 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 + +### NewWorkgroupDeleteItemWithDefaults + +`func NewWorkgroupDeleteItemWithDefaults() *WorkgroupDeleteItem` + +NewWorkgroupDeleteItemWithDefaults instantiates a new WorkgroupDeleteItem 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 + +### GetId + +`func (o *WorkgroupDeleteItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupDeleteItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupDeleteItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetStatus + +`func (o *WorkgroupDeleteItem) GetStatus() int32` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *WorkgroupDeleteItem) GetStatusOk() (*int32, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *WorkgroupDeleteItem) SetStatus(v int32)` + +SetStatus sets Status field to given value. + + +### GetDescription + +`func (o *WorkgroupDeleteItem) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkgroupDeleteItem) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkgroupDeleteItem) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkgroupDeleteItem) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupDto.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupDto.md new file mode 100644 index 000000000..148f0d8fc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupDto.md @@ -0,0 +1,246 @@ +--- +id: v2024-workgroup-dto +title: WorkgroupDto +pagination_label: WorkgroupDto +sidebar_label: WorkgroupDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupDto', 'V2024WorkgroupDto'] +slug: /tools/sdk/go/v2024/models/workgroup-dto +tags: ['SDK', 'Software Development Kit', 'WorkgroupDto', 'V2024WorkgroupDto'] +--- + +# WorkgroupDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Owner** | Pointer to [**WorkgroupDtoOwner**](workgroup-dto-owner) | | [optional] +**Id** | Pointer to **string** | Governance group ID. | [optional] [readonly] +**Name** | Pointer to **string** | Governance group name. | [optional] +**Description** | Pointer to **string** | Governance group description. | [optional] +**MemberCount** | Pointer to **int64** | Number of members in the governance group. | [optional] [readonly] +**ConnectionCount** | Pointer to **int64** | Number of connections in the governance group. | [optional] [readonly] +**Created** | Pointer to **SailPointTime** | | [optional] +**Modified** | Pointer to **SailPointTime** | | [optional] + +## Methods + +### NewWorkgroupDto + +`func NewWorkgroupDto() *WorkgroupDto` + +NewWorkgroupDto instantiates a new WorkgroupDto 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 + +### NewWorkgroupDtoWithDefaults + +`func NewWorkgroupDtoWithDefaults() *WorkgroupDto` + +NewWorkgroupDtoWithDefaults instantiates a new WorkgroupDto 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 + +### GetOwner + +`func (o *WorkgroupDto) GetOwner() WorkgroupDtoOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *WorkgroupDto) GetOwnerOk() (*WorkgroupDtoOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *WorkgroupDto) SetOwner(v WorkgroupDtoOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *WorkgroupDto) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetId + +`func (o *WorkgroupDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkgroupDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkgroupDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkgroupDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkgroupDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkgroupDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkgroupDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkgroupDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkgroupDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkgroupDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetMemberCount + +`func (o *WorkgroupDto) GetMemberCount() int64` + +GetMemberCount returns the MemberCount field if non-nil, zero value otherwise. + +### GetMemberCountOk + +`func (o *WorkgroupDto) GetMemberCountOk() (*int64, bool)` + +GetMemberCountOk returns a tuple with the MemberCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMemberCount + +`func (o *WorkgroupDto) SetMemberCount(v int64)` + +SetMemberCount sets MemberCount field to given value. + +### HasMemberCount + +`func (o *WorkgroupDto) HasMemberCount() bool` + +HasMemberCount returns a boolean if a field has been set. + +### GetConnectionCount + +`func (o *WorkgroupDto) GetConnectionCount() int64` + +GetConnectionCount returns the ConnectionCount field if non-nil, zero value otherwise. + +### GetConnectionCountOk + +`func (o *WorkgroupDto) GetConnectionCountOk() (*int64, bool)` + +GetConnectionCountOk returns a tuple with the ConnectionCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionCount + +`func (o *WorkgroupDto) SetConnectionCount(v int64)` + +SetConnectionCount sets ConnectionCount field to given value. + +### HasConnectionCount + +`func (o *WorkgroupDto) HasConnectionCount() bool` + +HasConnectionCount returns a boolean if a field has been set. + +### GetCreated + +`func (o *WorkgroupDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *WorkgroupDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *WorkgroupDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *WorkgroupDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *WorkgroupDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *WorkgroupDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *WorkgroupDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *WorkgroupDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupDtoOwner.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupDtoOwner.md new file mode 100644 index 000000000..700be90a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupDtoOwner.md @@ -0,0 +1,168 @@ +--- +id: v2024-workgroup-dto-owner +title: WorkgroupDtoOwner +pagination_label: WorkgroupDtoOwner +sidebar_label: WorkgroupDtoOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupDtoOwner', 'V2024WorkgroupDtoOwner'] +slug: /tools/sdk/go/v2024/models/workgroup-dto-owner +tags: ['SDK', 'Software Development Kit', 'WorkgroupDtoOwner', 'V2024WorkgroupDtoOwner'] +--- + +# WorkgroupDtoOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's DTO type. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] +**DisplayName** | Pointer to **string** | The display name of the identity | [optional] [readonly] +**EmailAddress** | Pointer to **string** | The primary email address of the identity | [optional] [readonly] + +## Methods + +### NewWorkgroupDtoOwner + +`func NewWorkgroupDtoOwner() *WorkgroupDtoOwner` + +NewWorkgroupDtoOwner instantiates a new WorkgroupDtoOwner 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 + +### NewWorkgroupDtoOwnerWithDefaults + +`func NewWorkgroupDtoOwnerWithDefaults() *WorkgroupDtoOwner` + +NewWorkgroupDtoOwnerWithDefaults instantiates a new WorkgroupDtoOwner 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 + +### GetType + +`func (o *WorkgroupDtoOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkgroupDtoOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkgroupDtoOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkgroupDtoOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkgroupDtoOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupDtoOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupDtoOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkgroupDtoOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkgroupDtoOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkgroupDtoOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkgroupDtoOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkgroupDtoOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *WorkgroupDtoOwner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *WorkgroupDtoOwner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *WorkgroupDtoOwner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *WorkgroupDtoOwner) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetEmailAddress + +`func (o *WorkgroupDtoOwner) GetEmailAddress() string` + +GetEmailAddress returns the EmailAddress field if non-nil, zero value otherwise. + +### GetEmailAddressOk + +`func (o *WorkgroupDtoOwner) GetEmailAddressOk() (*string, bool)` + +GetEmailAddressOk returns a tuple with the EmailAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailAddress + +`func (o *WorkgroupDtoOwner) SetEmailAddress(v string)` + +SetEmailAddress sets EmailAddress field to given value. + +### HasEmailAddress + +`func (o *WorkgroupDtoOwner) HasEmailAddress() bool` + +HasEmailAddress returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupMemberAddItem.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupMemberAddItem.md new file mode 100644 index 000000000..9674ca204 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupMemberAddItem.md @@ -0,0 +1,106 @@ +--- +id: v2024-workgroup-member-add-item +title: WorkgroupMemberAddItem +pagination_label: WorkgroupMemberAddItem +sidebar_label: WorkgroupMemberAddItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupMemberAddItem', 'V2024WorkgroupMemberAddItem'] +slug: /tools/sdk/go/v2024/models/workgroup-member-add-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupMemberAddItem', 'V2024WorkgroupMemberAddItem'] +--- + +# WorkgroupMemberAddItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Identifier of identity in bulk member add request. | +**Status** | **int32** | The HTTP response status code returned for an individual member that is requested for addition during a bulk add operation. The HTTP response status code returned for an individual Governance Group is requested for deletion. > 201 - Identity is added into Governance Group members list. > 409 - Identity is already member of Governance Group. | +**Description** | Pointer to **string** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Methods + +### NewWorkgroupMemberAddItem + +`func NewWorkgroupMemberAddItem(id string, status int32, ) *WorkgroupMemberAddItem` + +NewWorkgroupMemberAddItem instantiates a new WorkgroupMemberAddItem 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 + +### NewWorkgroupMemberAddItemWithDefaults + +`func NewWorkgroupMemberAddItemWithDefaults() *WorkgroupMemberAddItem` + +NewWorkgroupMemberAddItemWithDefaults instantiates a new WorkgroupMemberAddItem 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 + +### GetId + +`func (o *WorkgroupMemberAddItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupMemberAddItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupMemberAddItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetStatus + +`func (o *WorkgroupMemberAddItem) GetStatus() int32` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *WorkgroupMemberAddItem) GetStatusOk() (*int32, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *WorkgroupMemberAddItem) SetStatus(v int32)` + +SetStatus sets Status field to given value. + + +### GetDescription + +`func (o *WorkgroupMemberAddItem) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkgroupMemberAddItem) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkgroupMemberAddItem) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkgroupMemberAddItem) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupMemberDeleteItem.md b/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupMemberDeleteItem.md new file mode 100644 index 000000000..2ca1e92ec --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/WorkgroupMemberDeleteItem.md @@ -0,0 +1,106 @@ +--- +id: v2024-workgroup-member-delete-item +title: WorkgroupMemberDeleteItem +pagination_label: WorkgroupMemberDeleteItem +sidebar_label: WorkgroupMemberDeleteItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupMemberDeleteItem', 'V2024WorkgroupMemberDeleteItem'] +slug: /tools/sdk/go/v2024/models/workgroup-member-delete-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupMemberDeleteItem', 'V2024WorkgroupMemberDeleteItem'] +--- + +# WorkgroupMemberDeleteItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Identifier of identity in bulk member add /remove request. | +**Status** | **int32** | The HTTP response status code returned for an individual member that is requested for deletion during a bulk delete operation. > 204 - Identity is removed from Governance Group members list. > 404 - Identity is not member of Governance Group. | +**Description** | Pointer to **string** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Methods + +### NewWorkgroupMemberDeleteItem + +`func NewWorkgroupMemberDeleteItem(id string, status int32, ) *WorkgroupMemberDeleteItem` + +NewWorkgroupMemberDeleteItem instantiates a new WorkgroupMemberDeleteItem 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 + +### NewWorkgroupMemberDeleteItemWithDefaults + +`func NewWorkgroupMemberDeleteItemWithDefaults() *WorkgroupMemberDeleteItem` + +NewWorkgroupMemberDeleteItemWithDefaults instantiates a new WorkgroupMemberDeleteItem 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 + +### GetId + +`func (o *WorkgroupMemberDeleteItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupMemberDeleteItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupMemberDeleteItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetStatus + +`func (o *WorkgroupMemberDeleteItem) GetStatus() int32` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *WorkgroupMemberDeleteItem) GetStatusOk() (*int32, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *WorkgroupMemberDeleteItem) SetStatus(v int32)` + +SetStatus sets Status field to given value. + + +### GetDescription + +`func (o *WorkgroupMemberDeleteItem) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkgroupMemberDeleteItem) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkgroupMemberDeleteItem) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkgroupMemberDeleteItem) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Index.md b/docs/tools/sdk/go/Reference/V2025/Index.md new file mode 100644 index 000000000..97e7db51a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Index.md @@ -0,0 +1,22 @@ +--- +id: v2025 +title: V2025 +pagination_label: V2025 +sidebar_label: V2025 +sidebar_position: 2 +sidebar_class_name: v2025 +keywords: ['v2025', 'Golang'] +description: Golang SDK reference V2025. +slug: /tools/go/reference/v2025 +tags: ['v2025'] +--- + +Welcome to the Golang SDK documentation for the Identity Security Cloud (ISC) V2025 API. This reference guide provides an overview of both methods and models, which will help you understand how to interact with the API effectively. + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AccessModelMetadataAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AccessModelMetadataAPI.md new file mode 100644 index 000000000..9a1168dcb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AccessModelMetadataAPI.md @@ -0,0 +1,348 @@ +--- +id: v2025-access-model-metadata +title: AccessModelMetadata +pagination_label: AccessModelMetadata +sidebar_label: AccessModelMetadata +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessModelMetadata', 'V2025AccessModelMetadata'] +slug: /tools/sdk/go/v2025/methods/access-model-metadata +tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'V2025AccessModelMetadata'] +--- + +# AccessModelMetadataAPI + Use this API to create and manage metadata attributes for your Access Model. +Access Model Metadata allows you to add contextual information to your ISC Access Model items using pre-defined metadata for risk, regulations, privacy levels, etc., or by creating your own metadata attributes to reflect the unique needs of your organization. This release of the API includes support for entitlement metadata. Support for role and access profile metadata will be introduced in a subsequent release. + +Common usages for Access Model metadata include: + +- Organizing and categorizing access items to make it easier for your users to search for and find the access rights they want to request, certify, or manage. + +- Providing richer information about access that is being acted on to allow stakeholders to make better decisions when approving, certifying, or managing access rights. + +- Identifying access that may requires additional approval requirements or be subject to more frequent review. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-access-model-metadata-attribute**](#get-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes/{key}` | Get Access Model Metadata Attribute +[**get-access-model-metadata-attribute-value**](#get-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values/{value}` | Get Access Model Metadata Value +[**list-access-model-metadata-attribute**](#list-access-model-metadata-attribute) | **Get** `/access-model-metadata/attributes` | List Access Model Metadata Attributes +[**list-access-model-metadata-attribute-value**](#list-access-model-metadata-attribute-value) | **Get** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values + + +## get-access-model-metadata-attribute +:::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 Access Model Metadata Attribute +Get single Access Model Metadata Attribute + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-model-metadata-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**key** | **string** | Technical name of the Attribute. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessModelMetadataAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**AttributeDTO**](../models/attribute-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + 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.AccessModelMetadataAPI.GetAccessModelMetadataAttribute(context.Background(), key).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AccessModelMetadataAPI.GetAccessModelMetadataAttribute(context.Background(), key).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.GetAccessModelMetadataAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessModelMetadataAttribute`: AttributeDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.GetAccessModelMetadataAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-model-metadata-attribute-value +:::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 Access Model Metadata Value +Get single Access Model Metadata Attribute Value + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-model-metadata-attribute-value) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**key** | **string** | Technical name of the Attribute. | +**value** | **string** | Technical name of the Attribute value. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessModelMetadataAttributeValueRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**AttributeValueDTO**](../models/attribute-value-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + value := `public` // string | Technical name of the Attribute value. # string | Technical name of the Attribute value. + 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.AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue(context.Background(), key, value).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue(context.Background(), key, value).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessModelMetadataAttributeValue`: AttributeValueDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-model-metadata-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 + ``` +::: +List Access Model Metadata Attributes +Get a list of Access Model Metadata Attributes + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-access-model-metadata-attribute) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessModelMetadataAttributeRequest struct via the builder pattern + + +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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* | + +### Return type + +[**[]AttributeDTO**](../models/attribute-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 := `name eq "Privacy"` // 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessModelMetadataAPI.ListAccessModelMetadataAttribute(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AccessModelMetadataAPI.ListAccessModelMetadataAttribute(context.Background()).XSailPointExperimental(xSailPointExperimental).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.ListAccessModelMetadataAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessModelMetadataAttribute`: []AttributeDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.ListAccessModelMetadataAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-model-metadata-attribute-value +:::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 Access Model Metadata Values +Get a list of Access Model Metadata Attribute Values + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-access-model-metadata-attribute-value) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**key** | **string** | Technical name of the Attribute. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessModelMetadataAttributeValueRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**[]AttributeValueDTO**](../models/attribute-value-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + 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.AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue(context.Background(), key).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue(context.Background(), key).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessModelMetadataAttributeValue`: []AttributeValueDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AccessProfilesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AccessProfilesAPI.md new file mode 100644 index 000000000..942453836 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AccessProfilesAPI.md @@ -0,0 +1,771 @@ +--- +id: v2025-access-profiles +title: AccessProfiles +pagination_label: AccessProfiles +sidebar_label: AccessProfiles +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfiles', 'V2025AccessProfiles'] +slug: /tools/sdk/go/v2025/methods/access-profiles +tags: ['SDK', 'Software Development Kit', 'AccessProfiles', 'V2025AccessProfiles'] +--- + +# AccessProfilesAPI + Use this API to implement and customize access profile functionality. +With this functionality in place, administrators can create access profiles and configure them for use throughout Identity Security Cloud, enabling users to get the access they need quickly and securely. + +Access profiles group entitlements, which represent access rights on sources. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +Identity Security Cloud uses access profiles in many features, including the following: + +- Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles. + +- Certifications: You can approve or revoke access profiles in certification campaigns, just like entitlements. + +- Access Requests: You can assign access profiles to applications, and when a user requests access to the app associated with an access profile and someone approves the request, access is granted to both the application and its associated access profile. + +- Roles: You can group one or more access profiles into a role to quickly assign access items based on an identity's role. + +In Identity Security Cloud, administrators can use the Access drop-down menu and select Access Profiles to view, configure, and delete existing access profiles, as well as create new ones. +Administrators can enable and disable an access profile, and they can also make the following configurations: + +- Manage Entitlements: Manage the profile's access by adding and removing entitlements. + +- Access Requests: Configure access profiles to be requestable and establish an approval process for any requests that the access profile be granted or revoked. +Do not configure an access profile to be requestable without first establishing a secure access request approval process for the access profile. + +- Multiple Account Options: Define the logic Identity Security Cloud uses to provision access to an identity with multiple accounts on the source. + +Refer to [Managing Access Profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) for more information about access profiles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-access-profile**](#create-access-profile) | **Post** `/access-profiles` | Create Access Profile +[**delete-access-profile**](#delete-access-profile) | **Delete** `/access-profiles/{id}` | Delete the specified Access Profile +[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-delete` | Delete Access Profile(s) +[**get-access-profile**](#get-access-profile) | **Get** `/access-profiles/{id}` | Get an Access Profile +[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **Get** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements +[**list-access-profiles**](#list-access-profiles) | **Get** `/access-profiles` | List Access Profiles +[**patch-access-profile**](#patch-access-profile) | **Patch** `/access-profiles/{id}` | Patch a specified Access Profile +[**update-access-profiles-in-bulk**](#update-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field. + + +## create-access-profile +Create Access Profile +Create an access profile. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-profile) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAccessProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessProfile** | [**AccessProfile**](../models/access-profile) | | + +### Return type + +[**AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accessprofile := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + }`) // AccessProfile | + + + var accessProfile v2025.AccessProfile + if err := json.Unmarshal(accessprofile, &accessProfile); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessProfilesAPI.CreateAccessProfile(context.Background()).AccessProfile(accessProfile).Execute() + //resp, r, err := apiClient.V2025.AccessProfilesAPI.CreateAccessProfile(context.Background()).AccessProfile(accessProfile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.CreateAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.CreateAccessProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-access-profile +Delete the specified Access Profile +This API deletes an existing Access Profile. + +The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. + +A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-access-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Access Profile to delete | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccessProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Access Profile to delete # string | ID of the Access Profile to delete + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.AccessProfilesAPI.DeleteAccessProfile(context.Background(), id).Execute() + //r, err := apiClient.V2025.AccessProfilesAPI.DeleteAccessProfile(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.DeleteAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-access-profiles-in-bulk +Delete Access Profile(s) +This endpoint initiates a bulk deletion of one or more access profiles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 access profiles per request. +By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. +A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they're able to administer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-access-profiles-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccessProfilesInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessProfileBulkDeleteRequest** | [**AccessProfileBulkDeleteRequest**](../models/access-profile-bulk-delete-request) | | + +### Return type + +[**AccessProfileBulkDeleteResponse**](../models/access-profile-bulk-delete-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accessprofilebulkdeleterequest := []byte(`{ + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + }`) // AccessProfileBulkDeleteRequest | + + + var accessProfileBulkDeleteRequest v2025.AccessProfileBulkDeleteRequest + if err := json.Unmarshal(accessprofilebulkdeleterequest, &accessProfileBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessProfilesAPI.DeleteAccessProfilesInBulk(context.Background()).AccessProfileBulkDeleteRequest(accessProfileBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V2025.AccessProfilesAPI.DeleteAccessProfilesInBulk(context.Background()).AccessProfileBulkDeleteRequest(accessProfileBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.DeleteAccessProfilesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccessProfilesInBulk`: AccessProfileBulkDeleteResponse + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.DeleteAccessProfilesInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-profile +Get an Access Profile +This API returns an Access Profile by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Access Profile | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Access Profile # string | ID of the Access Profile + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessProfilesAPI.GetAccessProfile(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.AccessProfilesAPI.GetAccessProfile(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.GetAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.GetAccessProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-profile-entitlements +List Access Profile's Entitlements +Use this API to get a list of an access profile's entitlements. +A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-profile-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the access profile containing the entitlements. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessProfileEntitlementsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. | + **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, attribute, value, created, modified** | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the access profile containing the entitlements. # string | ID of the access profile containing the entitlements. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessProfilesAPI.GetAccessProfileEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.AccessProfilesAPI.GetAccessProfileEntitlements(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.GetAccessProfileEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessProfileEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.GetAccessProfileEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-profiles +List Access Profiles +Get a list of access profiles. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-access-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessProfilesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **forSubadmin** | **string** | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. | + **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, created, modified** | + **forSegmentIds** | **string** | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. | + **includeUnsegmented** | **bool** | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. | [default to true] + +### Return type + +[**[]AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + forSubadmin := `8c190e6787aa4ed9a90bd9d5344523fb` // string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) # string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "SailPoint Support"` // 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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessProfilesAPI.ListAccessProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccessProfilesAPI.ListAccessProfiles(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.ListAccessProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessProfiles`: []AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.ListAccessProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-access-profile +Patch a specified Access Profile +This API updates an existing Access Profile. The following fields are patchable: + +**name** + +**description** + +**enabled** + +**owner** + +**requestable** + +**accessRequestConfig** + +**revokeRequestConfig** + +**segments** + +**entitlements** + +**provisioningCriteria** + +**source** (must be updated with entitlements belonging to new source in the same API call) + +If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example "Replace Source" in the examples dropdown. + +A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. +> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-access-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Access Profile to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAccessProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Access Profile to patch # string | ID of the Access Profile to patch + jsonpatchoperation := []byte(`[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessProfilesAPI.PatchAccessProfile(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.AccessProfilesAPI.PatchAccessProfile(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.PatchAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.PatchAccessProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-access-profiles-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 + ``` +::: +Update Access Profile(s) requestable field. +This API initiates a bulk update of field requestable for one or more Access Profiles. + +> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** + list of the response.Requestable field of these Access Profiles marked as **true** or **false**. + +> If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. + A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-access-profiles-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateAccessProfilesInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **accessProfileBulkUpdateRequestInner** | [**[]AccessProfileBulkUpdateRequestInner**](../models/access-profile-bulk-update-request-inner) | | + +### Return type + +[**[]AccessProfileUpdateItem**](../models/access-profile-update-item) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + accessprofilebulkupdaterequestinner := []byte(`[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]`) // []AccessProfileBulkUpdateRequestInner | + + + var accessProfileBulkUpdateRequestInner v2025.[]AccessProfileBulkUpdateRequestInner + if err := json.Unmarshal(accessprofilebulkupdaterequestinner, &accessProfileBulkUpdateRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessProfilesAPI.UpdateAccessProfilesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessProfileBulkUpdateRequestInner(accessProfileBulkUpdateRequestInner).Execute() + //resp, r, err := apiClient.V2025.AccessProfilesAPI.UpdateAccessProfilesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessProfileBulkUpdateRequestInner(accessProfileBulkUpdateRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.UpdateAccessProfilesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAccessProfilesInBulk`: []AccessProfileUpdateItem + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.UpdateAccessProfilesInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestApprovalsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestApprovalsAPI.md new file mode 100644 index 000000000..366d8380f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestApprovalsAPI.md @@ -0,0 +1,559 @@ +--- +id: v2025-access-request-approvals +title: AccessRequestApprovals +pagination_label: AccessRequestApprovals +sidebar_label: AccessRequestApprovals +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestApprovals', 'V2025AccessRequestApprovals'] +slug: /tools/sdk/go/v2025/methods/access-request-approvals +tags: ['SDK', 'Software Development Kit', 'AccessRequestApprovals', 'V2025AccessRequestApprovals'] +--- + +# AccessRequestApprovalsAPI + Use this API to implement and customize access request approval functionality. +With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. +This enables more qualified users to review access requests and the others to spend their time on other tasks. + +In Identity Security Cloud, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. +For applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. +For roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. +If the administrator designates a governance group as the required approver, any governance group member can approve the requests. + +When a user submits an access request, Identity Security Cloud sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration. + +In Approvals in Identity Security Cloud, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. +If the required approver approves the request and is the only reviewer required, Identity Security Cloud grants or revokes access, based on the request. +If multiple reviewers are required, Identity Security Cloud sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. +The required approver can then view any completed access requests under the Reviewed tab. + +Refer to [Access Requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for more information about access request approvals. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-access-request**](#approve-access-request) | **Post** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval +[**forward-access-request**](#forward-access-request) | **Post** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval +[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **Get** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number +[**list-access-request-approvers**](#list-access-request-approvers) | **Get** `/access-request-approvals/{accessRequestId}/approvers` | Access Request Approvers +[**list-completed-approvals**](#list-completed-approvals) | **Get** `/access-request-approvals/completed` | Completed Access Request Approvals List +[**list-pending-approvals**](#list-pending-approvals) | **Get** `/access-request-approvals/pending` | Pending Access Request Approvals List +[**reject-access-request**](#reject-access-request) | **Post** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval + + +## approve-access-request +Approve Access Request Approval +Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/approve-access-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**approvalId** | **string** | Approval ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiApproveAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **commentDto** | [**CommentDto**](../models/comment-dto) | Reviewer's comment. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + commentdto := []byte(`{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + }`) // CommentDto | Reviewer's comment. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ApproveAccessRequest(context.Background(), approvalId).Execute() + //resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ApproveAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ApproveAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ApproveAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## forward-access-request +Forward Access Request Approval +Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/forward-access-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**approvalId** | **string** | Approval ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiForwardAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **forwardApprovalDto** | [**ForwardApprovalDto**](../models/forward-approval-dto) | Information about the forwarded approval. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + forwardapprovaldto := []byte(`{ + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" + }`) // ForwardApprovalDto | Information about the forwarded approval. + + + var forwardApprovalDto v2025.ForwardApprovalDto + if err := json.Unmarshal(forwardapprovaldto, &forwardApprovalDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ForwardAccessRequest(context.Background(), approvalId).ForwardApprovalDto(forwardApprovalDto).Execute() + //resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ForwardAccessRequest(context.Background(), approvalId).ForwardApprovalDto(forwardApprovalDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ForwardAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ForwardAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ForwardAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-approval-summary +Get Access Requests Approvals Number +Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-request-approval-summary) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestApprovalSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. | + **fromDate** | **string** | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. | + +### Return type + +[**ApprovalSummary**](../models/approval-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + fromDate := `from-date=2020-03-19T19:59:11Z` // string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) # string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary(context.Background()).OwnerId(ownerId).FromDate(fromDate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestApprovalSummary`: ApprovalSummary + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-request-approvers +Access Request Approvers +This API endpoint returns the list of approvers for the given access request id. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-access-request-approvers) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**accessRequestId** | **string** | Access Request ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessRequestApproversRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int32** | Max number of results to return. | [default to 250] + **offset** | **int32** | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. | + **count** | **bool** | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. | [default to false] + +### Return type + +[**[]AccessRequestApproversListResponse**](../models/access-request-approvers-list-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accessRequestId := `2c91808568c529c60168cca6f90c1313` // string | Access Request ID. # string | Access Request ID. + limit := 100 // int32 | Max number of results to return. (optional) (default to 250) # int32 | Max number of results to return. (optional) (default to 250) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + count := false // bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ListAccessRequestApprovers(context.Background(), accessRequestId).Execute() + //resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ListAccessRequestApprovers(context.Background(), accessRequestId).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListAccessRequestApprovers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessRequestApprovers`: []AccessRequestApproversListResponse + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListAccessRequestApprovers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-completed-approvals +Completed Access Request Approvals List +This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-completed-approvals) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCompletedApprovalsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* | + **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: **created, modified** | + +### Return type + +[**[]CompletedApproval**](../models/completed-approval) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "2c91808568c529c60168cca6f90c1313"` // 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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + sorters := `modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ListCompletedApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ListCompletedApprovals(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListCompletedApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCompletedApprovals`: []CompletedApproval + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListCompletedApprovals`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-pending-approvals +Pending Access Request Approvals List +This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-pending-approvals) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPendingApprovalsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* | + **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: **created, modified** | + +### Return type + +[**[]PendingApproval**](../models/pending-approval) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "2c91808568c529c60168cca6f90c1313"` // 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) + sorters := `modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ListPendingApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ListPendingApprovals(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListPendingApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPendingApprovals`: []PendingApproval + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListPendingApprovals`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reject-access-request +Reject Access Request Approval +Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/reject-access-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**approvalId** | **string** | Approval ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRejectAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **commentDto** | [**CommentDto**](../models/comment-dto) | Reviewer's comment. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + commentdto := []byte(`{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + }`) // CommentDto | Reviewer's comment. + + + var commentDto v2025.CommentDto + if err := json.Unmarshal(commentdto, &commentDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.RejectAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + //resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.RejectAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.RejectAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.RejectAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestIdentityMetricsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestIdentityMetricsAPI.md new file mode 100644 index 000000000..8fefc20cf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestIdentityMetricsAPI.md @@ -0,0 +1,96 @@ +--- +id: v2025-access-request-identity-metrics +title: AccessRequestIdentityMetrics +pagination_label: AccessRequestIdentityMetrics +sidebar_label: AccessRequestIdentityMetrics +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestIdentityMetrics', 'V2025AccessRequestIdentityMetrics'] +slug: /tools/sdk/go/v2025/methods/access-request-identity-metrics +tags: ['SDK', 'Software Development Kit', 'AccessRequestIdentityMetrics', 'V2025AccessRequestIdentityMetrics'] +--- + +# AccessRequestIdentityMetricsAPI + Use this API to implement access request identity metrics functionality. +With this functionality in place, access request reviewers can see relevant details about the requested access item and associated source activity. +This allows reviewers to see how many of the identities who share a manager with the access requester have this same type of access and how many of them have had activity in the related source. +This additional context about whether the access has been granted before and how often it has been used can help those approving access requests make more informed decisions. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-access-request-identity-metrics**](#get-access-request-identity-metrics) | **Get** `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` | Return access request identity metrics + + +## get-access-request-identity-metrics +Return access request identity metrics +Use this API to return information access metrics. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-request-identity-metrics) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | Manager's identity ID. | +**requestedObjectId** | **string** | Requested access item's ID. | +**type_** | **string** | Requested access item's type. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestIdentityMetricsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `7025c863-c270-4ba6-beea-edf3cb091573` // string | Manager's identity ID. # string | Manager's identity ID. + requestedObjectId := `2db501be-f0fb-4cc5-a695-334133c52891` // string | Requested access item's ID. # string | Requested access item's ID. + type_ := `ENTITLEMENT` // string | Requested access item's type. # string | Requested access item's type. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics(context.Background(), identityId, requestedObjectId, type_).Execute() + //resp, r, err := apiClient.V2025.AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics(context.Background(), identityId, requestedObjectId, type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestIdentityMetrics`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestsAPI.md new file mode 100644 index 000000000..7867aaf58 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AccessRequestsAPI.md @@ -0,0 +1,1173 @@ +--- +id: v2025-access-requests +title: AccessRequests +pagination_label: AccessRequests +sidebar_label: AccessRequests +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequests', 'V2025AccessRequests'] +slug: /tools/sdk/go/v2025/methods/access-requests +tags: ['SDK', 'Software Development Kit', 'AccessRequests', 'V2025AccessRequests'] +--- + +# AccessRequestsAPI + Use this API to implement and customize access request functionality. +With this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked. +This allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools. + +Identity Security Cloud's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them. + +In the Request Center in Identity Security Cloud, users can view available applications, roles, and entitlements and request access to them. +If the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them. + +Users can use My Requests to track and/or cancel the requests. + +In My Team on the Identity Security Cloud Home, managers can submit requests to revoke their team members' access. +They can use the My Requests tab under Request Center to track and/or cancel the requests. + +Refer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-bulk-access-request**](#approve-bulk-access-request) | **Post** `/access-request-approvals/bulk-approve` | Bulk Approve Access Request +[**cancel-access-request**](#cancel-access-request) | **Post** `/access-requests/cancel` | Cancel Access Request +[**cancel-access-request-in-bulk**](#cancel-access-request-in-bulk) | **Post** `/access-requests/bulk-cancel` | Bulk Cancel Access Request +[**close-access-request**](#close-access-request) | **Post** `/access-requests/close` | Close Access Request +[**create-access-request**](#create-access-request) | **Post** `/access-requests` | Submit Access Request +[**get-access-request-config**](#get-access-request-config) | **Get** `/access-request-config` | Get Access Request Configuration +[**get-entitlement-details-for-identity**](#get-entitlement-details-for-identity) | **Get** `/access-requests/revocable-objects` | Identity Entitlement Details +[**list-access-request-status**](#list-access-request-status) | **Get** `/access-request-status` | Access Request Status +[**list-administrators-access-request-status**](#list-administrators-access-request-status) | **Get** `/access-request-administration` | Access Request Status for Administrators +[**load-account-selections**](#load-account-selections) | **Post** `/access-requests/accounts-selection` | Get accounts selections for identity +[**set-access-request-config**](#set-access-request-config) | **Put** `/access-request-config` | Update Access Request Configuration + + +## approve-bulk-access-request +Bulk Approve Access Request +This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights "idn:access-request-administration:write" can approve the access requests in bulk. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/approve-bulk-access-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiApproveBulkAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulkApproveAccessRequest** | [**BulkApproveAccessRequest**](../models/bulk-approve-access-request) | | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + bulkapproveaccessrequest := []byte(`{ + "comment" : "I approve these request items", + "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] + }`) // BulkApproveAccessRequest | + + + var bulkApproveAccessRequest v2025.BulkApproveAccessRequest + if err := json.Unmarshal(bulkapproveaccessrequest, &bulkApproveAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.ApproveBulkAccessRequest(context.Background()).BulkApproveAccessRequest(bulkApproveAccessRequest).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.ApproveBulkAccessRequest(context.Background()).BulkApproveAccessRequest(bulkApproveAccessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.ApproveBulkAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveBulkAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.ApproveBulkAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## cancel-access-request +Cancel Access Request +This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. +In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/cancel-access-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCancelAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cancelAccessRequest** | [**CancelAccessRequest**](../models/cancel-access-request) | | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + cancelaccessrequest := []byte(`{ + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + }`) // CancelAccessRequest | + + + var cancelAccessRequest v2025.CancelAccessRequest + if err := json.Unmarshal(cancelaccessrequest, &cancelAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.CancelAccessRequest(context.Background()).CancelAccessRequest(cancelAccessRequest).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.CancelAccessRequest(context.Background()).CancelAccessRequest(cancelAccessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CancelAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CancelAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CancelAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## cancel-access-request-in-bulk +Bulk Cancel Access Request +This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. +Only ORG_ADMIN or users with rights "idn:access-request-administration:write" can cancel the access requests in bulk. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/cancel-access-request-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCancelAccessRequestInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulkCancelAccessRequest** | [**BulkCancelAccessRequest**](../models/bulk-cancel-access-request) | | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + bulkcancelaccessrequest := []byte(`{ + "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], + "comment" : "I requested this role by mistake." + }`) // BulkCancelAccessRequest | + + + var bulkCancelAccessRequest v2025.BulkCancelAccessRequest + if err := json.Unmarshal(bulkcancelaccessrequest, &bulkCancelAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.CancelAccessRequestInBulk(context.Background()).BulkCancelAccessRequest(bulkCancelAccessRequest).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.CancelAccessRequestInBulk(context.Background()).BulkCancelAccessRequest(bulkCancelAccessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CancelAccessRequestInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CancelAccessRequestInBulk`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CancelAccessRequestInBulk`: %v\n", resp) +} +``` + +[[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/). + +To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers. + +To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). + +Input the IDs from either source. + +To track the status of endpoint requests, navigate to Search and use this query: name:"Close Identity Requests". Search will include "Close Identity Requests Started" audits when requests are initiated and "Close Identity Requests Completed" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. + +This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/) for each access request that is closed. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/close-access-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCloseAccessRequestRequest struct via the builder pattern + + +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 + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + }`) // CloseAccessRequest | + + + var closeAccessRequest v2025.CloseAccessRequest + if err := json.Unmarshal(closeaccessrequest, &closeAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + 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() + 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) + } + // response from `CloseAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CloseAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-access-request +Submit Access Request +Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. + +Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request +has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn't return an error +if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. + +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. + +There are two types of access request: + +__GRANT_ACCESS__ +* Can be requested for multiple identities in a single request. +* 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. +* 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. +* 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. +* 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. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessRequest** | [**AccessRequest**](../models/access-request) | | + +### Return type + +[**AccessRequestResponse**](../models/access-request-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accessrequest := []byte(`{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } ] + }`) // AccessRequest | + + + var accessRequest v2025.AccessRequest + if err := json.Unmarshal(accessrequest, &accessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.CreateAccessRequest(context.Background()).AccessRequest(accessRequest).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.CreateAccessRequest(context.Background()).AccessRequest(accessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CreateAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessRequest`: AccessRequestResponse + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CreateAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-config +Get Access Request Configuration +This endpoint returns the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-request-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestConfigRequest struct via the builder pattern + + +### Return type + +[**AccessRequestConfig**](../models/access-request-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.GetAccessRequestConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.GetAccessRequestConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.GetAccessRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestConfig`: AccessRequestConfig + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.GetAccessRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlement-details-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 + ``` +::: +Identity Entitlement Details +Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlement-details-for-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | The identity ID. | +**entitlementId** | **string** | The entitlement ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementDetailsForIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + + + +### Return type + +[**IdentityEntitlementDetails**](../models/identity-entitlement-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + identityId := `7025c863c2704ba6beeaedf3cb091573` // string | The identity ID. # string | The identity ID. + entitlementId := `ef38f94347e94562b5bb8424a56397d8` // string | The entitlement ID # string | The entitlement ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.GetEntitlementDetailsForIdentity(context.Background(), identityId, entitlementId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.GetEntitlementDetailsForIdentity(context.Background(), identityId, entitlementId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.GetEntitlementDetailsForIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementDetailsForIdentity`: IdentityEntitlementDetails + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.GetEntitlementDetailsForIdentity`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-request-status +Access Request Status +Use this API to return a list of access request statuses based on the specified query parameters. +If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. +Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-access-request-status) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessRequestStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **requestedBy** | **string** | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **regardingIdentity** | **string** | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. | + **assignedTo** | **string** | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. | + **count** | **bool** | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. | [default to false] + **limit** | **int32** | Max number of results to return. | [default to 250] + **offset** | **int32** | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. | + **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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* | + **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: **created, modified, accountActivityItemId, name** | + **requestState** | **string** | Filter the results by the state of the request. The only valid value is *EXECUTING*. | + +### Return type + +[**[]RequestedItemStatus**](../models/requested-item-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + assignedTo := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + count := false // bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + limit := 100 // int32 | Max number of results to return. (optional) (default to 250) # int32 | Max number of results to return. (optional) (default to 250) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + filters := `accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"` // 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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + sorters := `created` // 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: **created, modified, accountActivityItemId, name** (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: **created, modified, accountActivityItemId, name** (optional) + requestState := `request-state=EXECUTING` // string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.ListAccessRequestStatus(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.ListAccessRequestStatus(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).AssignedTo(assignedTo).Count(count).Limit(limit).Offset(offset).Filters(filters).Sorters(sorters).RequestState(requestState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.ListAccessRequestStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessRequestStatus`: []RequestedItemStatus + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.ListAccessRequestStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-administrators-access-request-status +Access Request Status for Administrators +Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. +Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-administrators-access-request-status) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAdministratorsAccessRequestStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **requestedBy** | **string** | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **regardingIdentity** | **string** | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. | + **assignedTo** | **string** | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. | + **count** | **bool** | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. | [default to false] + **limit** | **int32** | Max number of results to return. | [default to 250] + **offset** | **int32** | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. | + **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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* | + **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: **created, modified, accountActivityItemId, name, accessRequestId** | + **requestState** | **string** | Filter the results by the state of the request. The only valid value is *EXECUTING*. | + +### Return type + +[**[]AccessRequestAdminItemStatus**](../models/access-request-admin-item-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + assignedTo := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + count := false // bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + limit := 100 // int32 | Max number of results to return. (optional) (default to 250) # int32 | Max number of results to return. (optional) (default to 250) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + filters := `accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"` // 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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + sorters := `created` // 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: **created, modified, accountActivityItemId, name, accessRequestId** (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: **created, modified, accountActivityItemId, name, accessRequestId** (optional) + requestState := `request-state=EXECUTING` // string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.ListAdministratorsAccessRequestStatus(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.ListAdministratorsAccessRequestStatus(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).AssignedTo(assignedTo).Count(count).Limit(limit).Offset(offset).Filters(filters).Sorters(sorters).RequestState(requestState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.ListAdministratorsAccessRequestStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAdministratorsAccessRequestStatus`: []AccessRequestAdminItemStatus + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.ListAdministratorsAccessRequestStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## load-account-selections +Get accounts selections for identity +Use this API to fetch account information for an identity against the items in an access request. + +Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/load-account-selections) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiLoadAccountSelectionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountsSelectionRequest** | [**AccountsSelectionRequest**](../models/accounts-selection-request) | | + +### Return type + +[**AccountsSelectionResponse**](../models/accounts-selection-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accountsselectionrequest := []byte(`{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }`) // AccountsSelectionRequest | + + + var accountsSelectionRequest v2025.AccountsSelectionRequest + if err := json.Unmarshal(accountsselectionrequest, &accountsSelectionRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.LoadAccountSelections(context.Background()).AccountsSelectionRequest(accountsSelectionRequest).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.LoadAccountSelections(context.Background()).AccountsSelectionRequest(accountsSelectionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.LoadAccountSelections``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `LoadAccountSelections`: AccountsSelectionResponse + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.LoadAccountSelections`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-access-request-config +Update Access Request Configuration +This endpoint replaces the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-access-request-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetAccessRequestConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessRequestConfig** | [**AccessRequestConfig**](../models/access-request-config) | | + +### Return type + +[**AccessRequestConfig**](../models/access-request-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accessrequestconfig := []byte(`{ + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + }`) // AccessRequestConfig | + + + var accessRequestConfig v2025.AccessRequestConfig + if err := json.Unmarshal(accessrequestconfig, &accessRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.SetAccessRequestConfig(context.Background()).AccessRequestConfig(accessRequestConfig).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.SetAccessRequestConfig(context.Background()).AccessRequestConfig(accessRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.SetAccessRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetAccessRequestConfig`: AccessRequestConfig + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.SetAccessRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AccountActivitiesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AccountActivitiesAPI.md new file mode 100644 index 000000000..ec206aaae --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AccountActivitiesAPI.md @@ -0,0 +1,196 @@ +--- +id: v2025-account-activities +title: AccountActivities +pagination_label: AccountActivities +sidebar_label: AccountActivities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivities', 'V2025AccountActivities'] +slug: /tools/sdk/go/v2025/methods/account-activities +tags: ['SDK', 'Software Development Kit', 'AccountActivities', 'V2025AccountActivities'] +--- + +# AccountActivitiesAPI + Use this API to implement account activity tracking functionality. +With this functionality in place, users can track source account activity in Identity Security Cloud, which greatly improves traceability in the system. + +An account activity refers to a log of each action performed on a source account. This is useful for auditing the changes performed on an account throughout its life. +In Identity Security Cloud's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. + +Account activity includes most actions Identity Security Cloud completes on source accounts. Users can search in Identity Security Cloud for the following account action types: + +- Access Request: These include any access requests the source account is involved in. + +- Account Attribute Updates: These include updates to a single attribute on an account on a source. + +- Account State Update: These include locking or unlocking actions on an account on a source. + +- Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification. + +- Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. +Identity Security Cloud replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. + +- Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. +When you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays. +Account Activity does not include attribute updates that occur as a result of aggregation. + +- Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. +These also include refreshes that occur whenever Identity Security Cloud assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. + +- Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. + +- Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state. + +- Password Change: These include password changes on sources. + +Refer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-account-activity**](#get-account-activity) | **Get** `/account-activities/{id}` | Get an Account Activity +[**list-account-activities**](#list-account-activities) | **Get** `/account-activities` | List Account Activities + + +## get-account-activity +Get an Account Activity +This gets a single account activity by its id. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-account-activity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account activity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountActivityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccountActivity**](../models/account-activity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account activity id # string | The account activity id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountActivitiesAPI.GetAccountActivity(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.AccountActivitiesAPI.GetAccountActivity(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountActivitiesAPI.GetAccountActivity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccountActivity`: AccountActivity + fmt.Fprintf(os.Stdout, "Response from `AccountActivitiesAPI.GetAccountActivity`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-account-activities +List Account Activities +This gets a collection of account activities that satisfy the given query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-account-activities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccountActivitiesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **requestedBy** | **string** | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **regardingIdentity** | **string** | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* | + **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: **type, created, modified** | + +### Return type + +[**[]AccountActivity**](../models/account-activity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c91808568c529c60168cca6f90c1313` // string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c91808568c529c60168cca6f90c1313` // string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c91808568c529c60168cca6f90c1313` // string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `type eq "Identity Refresh"` // 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + sorters := `created` // 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: **type, created, modified** (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: **type, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountActivitiesAPI.ListAccountActivities(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccountActivitiesAPI.ListAccountActivities(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountActivitiesAPI.ListAccountActivities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccountActivities`: []AccountActivity + fmt.Fprintf(os.Stdout, "Response from `AccountActivitiesAPI.ListAccountActivities`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AccountAggregationsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AccountAggregationsAPI.md new file mode 100644 index 000000000..10526cff3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AccountAggregationsAPI.md @@ -0,0 +1,116 @@ +--- +id: v2025-account-aggregations +title: AccountAggregations +pagination_label: AccountAggregations +sidebar_label: AccountAggregations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAggregations', 'V2025AccountAggregations'] +slug: /tools/sdk/go/v2025/methods/account-aggregations +tags: ['SDK', 'Software Development Kit', 'AccountAggregations', 'V2025AccountAggregations'] +--- + +# AccountAggregationsAPI + Use this API to implement account aggregation progress tracking functionality. +With this functionality in place, administrators can view in-progress account aggregations, their statuses, and their relevant details. + +An account aggregation refers to the process Identity Security Cloud uses to gather and load account data from a source into Identity Security Cloud. + +Whenever Identity Security Cloud is in the process of aggregating a source, it adds an entry to the Aggregation Activity Log, along with its relevant details. +To view aggregation activity, administrators can select the Connections drop-down menu, select Sources, and select the relevant source, select its Import Data tab, and select Account Aggregation. +In Account Aggregation, administrators can view the account aggregations' statuses and details in the Account Activity Log. + +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about account aggregations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-account-aggregation-status**](#get-account-aggregation-status) | **Get** `/account-aggregations/{id}/status` | In-progress Account Aggregation status + + +## get-account-aggregation-status +:::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. + +Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. + +Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. + +*Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* +required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-account-aggregation-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account aggregation id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountAggregationStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**AccountAggregationStatus**](../models/account-aggregation-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } + // response from `GetAccountAggregationStatus`: AccountAggregationStatus + fmt.Fprintf(os.Stdout, "Response from `AccountAggregationsAPI.GetAccountAggregationStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AccountUsagesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AccountUsagesAPI.md new file mode 100644 index 000000000..505b73c3b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AccountUsagesAPI.md @@ -0,0 +1,97 @@ +--- +id: v2025-account-usages +title: AccountUsages +pagination_label: AccountUsages +sidebar_label: AccountUsages +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUsages', 'V2025AccountUsages'] +slug: /tools/sdk/go/v2025/methods/account-usages +tags: ['SDK', 'Software Development Kit', 'AccountUsages', 'V2025AccountUsages'] +--- + +# AccountUsagesAPI + Use this API to implement account usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used. +This allows organizations to get the information they need to start optimizing and securing source account usage. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-usages-by-account-id**](#get-usages-by-account-id) | **Get** `/account-usages/{accountId}/summaries` | Returns account usage insights + + +## get-usages-by-account-id +Returns account usage insights +This API returns a summary of account usage insights for past 12 months. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-usages-by-account-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**accountId** | **string** | ID of IDN account | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetUsagesByAccountIdRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **date** | + +### Return type + +[**[]AccountUsage**](../models/account-usage) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accountId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of IDN account # string | ID of IDN account + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `-date` // 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: **date** (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: **date** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountUsagesAPI.GetUsagesByAccountId(context.Background(), accountId).Execute() + //resp, r, err := apiClient.V2025.AccountUsagesAPI.GetUsagesByAccountId(context.Background(), accountId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountUsagesAPI.GetUsagesByAccountId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUsagesByAccountId`: []AccountUsage + fmt.Fprintf(os.Stdout, "Response from `AccountUsagesAPI.GetUsagesByAccountId`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AccountsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AccountsAPI.md new file mode 100644 index 000000000..34637371d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AccountsAPI.md @@ -0,0 +1,1308 @@ +--- +id: v2025-accounts +title: Accounts +pagination_label: Accounts +sidebar_label: Accounts +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Accounts', 'V2025Accounts'] +slug: /tools/sdk/go/v2025/methods/accounts +tags: ['SDK', 'Software Development Kit', 'Accounts', 'V2025Accounts'] +--- + +# AccountsAPI + Use this API to implement and customize account functionality. +With this functionality in place, administrators can manage users' access across sources in Identity Security Cloud. + +In Identity Security Cloud, an account refers to a user's account on a supported source. +This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. Identity Security Cloud loads accounts through the creation of sources in Identity Security Cloud. + +Administrators can correlate users' identities with the users' accounts on the different sources they use. +This allows Identity Security Cloud to govern the access of identities and all their correlated accounts securely and cohesively. + +To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. + +To view and edit source account statuses for an identity in Identity Security Cloud, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. +Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. + +Accounts can have the following statuses: + +- Enabled: The account is enabled. The user can access it. + +- Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in Identity Security Cloud. This can occur when an administrator disables the account or when the user's lifecycle state changes. + +- Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times. + +- Pending: The account is currently updating. This status typically lasts seconds. + +Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed. + +Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-account**](#create-account) | **Post** `/accounts` | Create Account +[**delete-account**](#delete-account) | **Delete** `/accounts/{id}` | Delete Account +[**delete-account-async**](#delete-account-async) | **Post** `/accounts/{id}/remove` | Remove Account +[**disable-account**](#disable-account) | **Post** `/accounts/{id}/disable` | Disable Account +[**disable-account-for-identity**](#disable-account-for-identity) | **Post** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity +[**disable-accounts-for-identities**](#disable-accounts-for-identities) | **Post** `/identities-accounts/disable` | Disable IDN Accounts for Identities +[**enable-account**](#enable-account) | **Post** `/accounts/{id}/enable` | Enable Account +[**enable-account-for-identity**](#enable-account-for-identity) | **Post** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity +[**enable-accounts-for-identities**](#enable-accounts-for-identities) | **Post** `/identities-accounts/enable` | Enable IDN Accounts for Identities +[**get-account**](#get-account) | **Get** `/accounts/{id}` | Account Details +[**get-account-entitlements**](#get-account-entitlements) | **Get** `/accounts/{id}/entitlements` | Account Entitlements +[**list-accounts**](#list-accounts) | **Get** `/accounts` | Accounts List +[**put-account**](#put-account) | **Put** `/accounts/{id}` | Update Account +[**submit-reload-account**](#submit-reload-account) | **Post** `/accounts/{id}/reload` | Reload Account +[**unlock-account**](#unlock-account) | **Post** `/accounts/{id}/unlock` | Unlock Account +[**update-account**](#update-account) | **Patch** `/accounts/{id}` | Update Account + + +## create-account +Create Account +Submit an account creation task - the API then returns the task ID. + +You must include the `sourceId` where the account will be created in the `attributes` object. + +This endpoint creates an account on the source record in your ISC tenant. +This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. + +However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. +The endpoint doesn't actually provision the account on the target source, which means that if the account doesn't also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. + +By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-account) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountAttributesCreate** | [**AccountAttributesCreate**](../models/account-attributes-create) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accountattributescreate := []byte(`{ + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }`) // AccountAttributesCreate | + + + var accountAttributesCreate v2025.AccountAttributesCreate + if err := json.Unmarshal(accountattributescreate, &accountAttributesCreate); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.CreateAccount(context.Background()).AccountAttributesCreate(accountAttributesCreate).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.CreateAccount(context.Background()).AccountAttributesCreate(accountAttributesCreate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.CreateAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.CreateAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-account +Delete Account +Use this API to delete an account. +This endpoint submits an account delete task and returns the task ID. +This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. +>**NOTE: You can only delete accounts from sources of the "DelimitedFile" type.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.DeleteAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.DeleteAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DeleteAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DeleteAccount`: %v\n", resp) +} +``` + +[[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. + +This endpoint is good for: +* Removing accounts that no longer exist on the source. +* Removing accounts that won't be aggregated following updates to the source configuration. +* Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-account-async) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccountAsyncRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**TaskResultDto**](../models/task-result-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } + // response from `DeleteAccountAsync`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DeleteAccountAsync`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## disable-account +Disable Account +This API submits a task to disable the account and returns the task ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/disable-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDisableAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **accountToggleRequest** | [**AccountToggleRequest**](../models/account-toggle-request) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + accounttogglerequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }`) // AccountToggleRequest | + + + var accountToggleRequest v2025.AccountToggleRequest + if err := json.Unmarshal(accounttogglerequest, &accountToggleRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.DisableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.DisableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DisableAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DisableAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccount`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/disable-account-for-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDisableAccountForIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } + // response from `DisableAccountForIdentity`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccountForIdentity`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/disable-accounts-for-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDisableAccountsForIdentitiesRequest struct via the builder pattern + + +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 + +[**[]BulkIdentitiesAccountsResponse**](../models/bulk-identities-accounts-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 | + + + var identitiesAccountsBulkRequest v2025.IdentitiesAccountsBulkRequest + if err := json.Unmarshal(identitiesaccountsbulkrequest, &identitiesAccountsBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + 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() + 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) + } + // response from `DisableAccountsForIdentities`: []BulkIdentitiesAccountsResponse + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccountsForIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## enable-account +Enable Account +This API submits a task to enable account and returns the task ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/enable-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiEnableAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **accountToggleRequest** | [**AccountToggleRequest**](../models/account-toggle-request) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + accounttogglerequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }`) // AccountToggleRequest | + + + var accountToggleRequest v2025.AccountToggleRequest + if err := json.Unmarshal(accounttogglerequest, &accountToggleRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.EnableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.EnableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.EnableAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `EnableAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccount`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/enable-account-for-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiEnableAccountForIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } + // response from `EnableAccountForIdentity`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccountForIdentity`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/enable-accounts-for-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiEnableAccountsForIdentitiesRequest struct via the builder pattern + + +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 + +[**[]BulkIdentitiesAccountsResponse**](../models/bulk-identities-accounts-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 | + + + var identitiesAccountsBulkRequest v2025.IdentitiesAccountsBulkRequest + if err := json.Unmarshal(identitiesaccountsbulkrequest, &identitiesAccountsBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + 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() + 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) + } + // response from `EnableAccountsForIdentities`: []BulkIdentitiesAccountsResponse + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccountsForIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-account +Account Details +Use this API to return the details for a single account by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Account**](../models/account) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.GetAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.GetAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.GetAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccount`: Account + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.GetAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-account-entitlements +Account Entitlements +This API returns entitlements of the account. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-account-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountEntitlementsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.GetAccountEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.GetAccountEntitlements(context.Background(), id).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.GetAccountEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccountEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.GetAccountEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-accounts +Accounts List +List accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-accounts) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccountsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **detailLevel** | **string** | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. | + **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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* | + **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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** | + +### Return type + +[**[]Account**](../models/account) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + detailLevel := `FULL` // string | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) # string | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + filters := `identityId eq "2c9180858082150f0180893dbaf44201"` // 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) + sorters := `id,name` // 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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.ListAccounts(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.ListAccounts(context.Background()).Limit(limit).Offset(offset).Count(count).DetailLevel(detailLevel).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.ListAccounts``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccounts`: []Account + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.ListAccounts`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-account +Update Account +Use this API to update an account with a PUT request. + +This endpoint submits an account update task and returns the task ID. + +>**Note: You can only use this PUT endpoint to update accounts from flat file sources.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **accountAttributes** | [**AccountAttributes**](../models/account-attributes) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + accountattributes := []byte(`{ + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }`) // AccountAttributes | + + + var accountAttributes v2025.AccountAttributes + if err := json.Unmarshal(accountattributes, &accountAttributes); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.PutAccount(context.Background(), id).AccountAttributes(accountAttributes).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.PutAccount(context.Background(), id).AccountAttributes(accountAttributes).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.PutAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.PutAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-reload-account +Reload Account +This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/submit-reload-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitReloadAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.SubmitReloadAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.SubmitReloadAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.SubmitReloadAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitReloadAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.SubmitReloadAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## unlock-account +Unlock Account +This API submits a task to unlock an account and returns the task ID. +To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/unlock-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUnlockAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **accountUnlockRequest** | [**AccountUnlockRequest**](../models/account-unlock-request) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account ID. # string | The account ID. + accountunlockrequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + }`) // AccountUnlockRequest | + + + var accountUnlockRequest v2025.AccountUnlockRequest + if err := json.Unmarshal(accountunlockrequest, &accountUnlockRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.UnlockAccount(context.Background(), id).AccountUnlockRequest(accountUnlockRequest).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.UnlockAccount(context.Background(), id).AccountUnlockRequest(accountUnlockRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.UnlockAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UnlockAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.UnlockAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-account +Update Account +Use this API to update account details. + +This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields. +To reassign an account from one identity to another, replace the current `identityId` with a new value. +If the account you're assigning was provisioned by Identity Security Cloud (ISC), it's possible for ISC to create a new account +for the previous identity as soon as the account is moved. If the account you're assigning is authoritative, +this causes the previous identity to become uncorrelated and can even result in its deletion. +All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. + +>**Note:** The `attributes` field can only be modified for flat file accounts. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **requestBody** | **[]map[string]interface{}** | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + requestbody := []byte(`[{op=remove, path=/identityId}]`) // []map[string]interface{} | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.UpdateAccount(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.UpdateAccount(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.UpdateAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAccount`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.UpdateAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ApplicationDiscoveryAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ApplicationDiscoveryAPI.md new file mode 100644 index 000000000..0f05c52ad --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ApplicationDiscoveryAPI.md @@ -0,0 +1,216 @@ +--- +id: v2025-application-discovery +title: ApplicationDiscovery +pagination_label: ApplicationDiscovery +sidebar_label: ApplicationDiscovery +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApplicationDiscovery', 'V2025ApplicationDiscovery'] +slug: /tools/sdk/go/v2025/methods/application-discovery +tags: ['SDK', 'Software Development Kit', 'ApplicationDiscovery', 'V2025ApplicationDiscovery'] +--- + +# ApplicationDiscoveryAPI + Use this API to implement application discovery functionality. +With this functionality in place, you can discover applications within your Okta connector and receive connector recommendations by manually uploading application names. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-discovered-applications**](#get-discovered-applications) | **Get** `/discovered-applications` | Get Discovered Applications for Tenant +[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **Get** `/manual-discover-applications-template` | Download CSV Template for Discovery +[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **Post** `/manual-discover-applications` | Upload CSV to Discover Applications + + +## get-discovered-applications +Get Discovered Applications for Tenant +Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-discovered-applications) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDiscoveredApplicationsRequest struct via the builder pattern + + +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] + **detail** | **string** | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. | + **filter** | **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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* | + **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, description, discoveredAt, discoverySource** | + +### Return type + +[**[]GetDiscoveredApplications200ResponseInner**](../models/get-discovered-applications200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + filter := `name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")` // 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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + sorters := `name` // 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, description, discoveredAt, discoverySource** (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, description, discoveredAt, discoverySource** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ApplicationDiscoveryAPI.GetDiscoveredApplications(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ApplicationDiscoveryAPI.GetDiscoveredApplications(context.Background()).Limit(limit).Offset(offset).Detail(detail).Filter(filter).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetDiscoveredApplications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDiscoveredApplications`: []GetDiscoveredApplications200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `ApplicationDiscoveryAPI.GetDiscoveredApplications`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-manual-discover-applications-csv-template +Download CSV Template for Discovery +Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. + +The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-manual-discover-applications-csv-template) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManualDiscoverApplicationsCsvTemplateRequest struct via the builder pattern + + +### Return type + +[**ManualDiscoverApplicationsTemplate**](../models/manual-discover-applications-template) + +### 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() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManualDiscoverApplicationsCsvTemplate`: ManualDiscoverApplicationsTemplate + fmt.Fprintf(os.Stdout, "Response from `ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## send-manual-discover-applications-csv-template +Upload CSV to Discover Applications +Uploading a CSV file with application data for manual correlation to specific ISC connectors. +If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/send-manual-discover-applications-csv-template) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendManualDiscoverApplicationsCsvTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file** | ***os.File** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | + +### Return type + + (empty response body) + +### 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() { + file := BINARY_DATA_HERE // *os.File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # *os.File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate(context.Background()).File(file).Execute() + //r, err := apiClient.V2025.ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate(context.Background()).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ApprovalsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ApprovalsAPI.md new file mode 100644 index 000000000..1404587f5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ApprovalsAPI.md @@ -0,0 +1,183 @@ +--- +id: v2025-approvals +title: Approvals +pagination_label: Approvals +sidebar_label: Approvals +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Approvals', 'V2025Approvals'] +slug: /tools/sdk/go/v2025/methods/approvals +tags: ['SDK', 'Software Development Kit', 'Approvals', 'V2025Approvals'] +--- + +# ApprovalsAPI + Use this API to implement approval functionality. With this functionality in place, you can get generic approvals and modify them. + +The main advantages this API has vs [Access Request Approvals](https://developer.sailpoint.com/docs/api/v2025/access-request-approvals) are that you can use it to get generic approvals individually or in batches and make changes to those approvals. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-approval**](#get-approval) | **Get** `/generic-approvals/{id}` | Get an approval +[**get-approvals**](#get-approvals) | **Get** `/generic-approvals` | Get Approvals + + +## get-approval +:::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 an approval +Retrieve a single approval for a given approval ID. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-approval) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the approval that is to be returned | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetApprovalRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**Approval**](../models/approval) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `38453251-6be2-5f8f-df93-5ce19e295837` // string | ID of the approval that is to be returned # string | ID of the approval that is to be returned + 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.ApprovalsAPI.GetApproval(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.ApprovalsAPI.GetApproval(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApprovalsAPI.GetApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetApproval`: Approval + fmt.Fprintf(os.Stdout, "Response from `ApprovalsAPI.GetApproval`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-approvals +:::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 Approvals +Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. "Mine" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. +Absence of all query parameters will will default to mine=true. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-approvals) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetApprovalsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **mine** | **bool** | Returns the list of approvals for the current caller | + **requesterId** | **string** | Returns the list of approvals for a given requester ID | + **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: **status**: *eq* **referenceType**: *eq* | + +### Return type + +[**[]Approval**](../models/approval) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + mine := true // bool | Returns the list of approvals for the current caller (optional) # bool | Returns the list of approvals for the current caller (optional) + requesterId := `17e633e7d57e481569df76323169deb6a` // string | Returns the list of approvals for a given requester ID (optional) # string | Returns the list of approvals for a given requester ID (optional) + filters := `filters=status eq PENDING` // 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: **status**: *eq* **referenceType**: *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: **status**: *eq* **referenceType**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ApprovalsAPI.GetApprovals(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.ApprovalsAPI.GetApprovals(context.Background()).XSailPointExperimental(xSailPointExperimental).Mine(mine).RequesterId(requesterId).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApprovalsAPI.GetApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetApprovals`: []Approval + fmt.Fprintf(os.Stdout, "Response from `ApprovalsAPI.GetApprovals`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AppsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AppsAPI.md new file mode 100644 index 000000000..b9926e74d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AppsAPI.md @@ -0,0 +1,1203 @@ +--- +id: v2025-apps +title: Apps +pagination_label: Apps +sidebar_label: Apps +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Apps', 'V2025Apps'] +slug: /tools/sdk/go/v2025/methods/apps +tags: ['SDK', 'Software Development Kit', 'Apps', 'V2025Apps'] +--- + +# AppsAPI + Use this API to implement source application functionality. +With this functionality in place, you can create, customize, and manage applications within sources. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-source-app**](#create-source-app) | **Post** `/source-apps` | Create source app +[**delete-access-profiles-from-source-app-by-bulk**](#delete-access-profiles-from-source-app-by-bulk) | **Post** `/source-apps/{id}/access-profiles/bulk-remove` | Bulk remove access profiles from the specified source app +[**delete-source-app**](#delete-source-app) | **Delete** `/source-apps/{id}` | Delete source app by ID +[**get-source-app**](#get-source-app) | **Get** `/source-apps/{id}` | Get source app by ID +[**list-access-profiles-for-source-app**](#list-access-profiles-for-source-app) | **Get** `/source-apps/{id}/access-profiles` | List access profiles for the specified source app +[**list-all-source-app**](#list-all-source-app) | **Get** `/source-apps/all` | List all source apps +[**list-all-user-apps**](#list-all-user-apps) | **Get** `/user-apps/all` | List all user apps +[**list-assigned-source-app**](#list-assigned-source-app) | **Get** `/source-apps/assigned` | List assigned source apps +[**list-available-accounts-for-user-app**](#list-available-accounts-for-user-app) | **Get** `/user-apps/{id}/available-accounts` | List available accounts for user app +[**list-available-source-apps**](#list-available-source-apps) | **Get** `/source-apps` | List available source apps +[**list-owned-user-apps**](#list-owned-user-apps) | **Get** `/user-apps` | List owned user apps +[**patch-source-app**](#patch-source-app) | **Patch** `/source-apps/{id}` | Patch source app by ID +[**patch-user-app**](#patch-user-app) | **Patch** `/user-apps/{id}` | Patch user app by ID +[**update-source-apps-in-bulk**](#update-source-apps-in-bulk) | **Post** `/source-apps/bulk-update` | Bulk update source apps + + +## create-source-app +:::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 source app +This endpoint creates a source app using the given source app payload + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-source-app) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **sourceAppCreateDto** | [**SourceAppCreateDto**](../models/source-app-create-dto) | | + +### Return type + +[**SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + sourceappcreatedto := []byte(`{ + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true + }`) // SourceAppCreateDto | + + + var sourceAppCreateDto v2025.SourceAppCreateDto + if err := json.Unmarshal(sourceappcreatedto, &sourceAppCreateDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.CreateSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceAppCreateDto(sourceAppCreateDto).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.CreateSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceAppCreateDto(sourceAppCreateDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.CreateSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.CreateSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-access-profiles-from-source-app-by-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 remove access profiles from the specified source app +This API returns the final list of access profiles for the specified source app after removing + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-access-profiles-from-source-app-by-bulk) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the source app | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccessProfilesFromSourceAppByBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **requestBody** | **[]string** | | + **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] + +### Return type + +[**[]AccessProfileDetails**](../models/access-profile-details) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + 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") + requestbody := []byte(`[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]`) // []string | + 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) + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.DeleteAccessProfilesFromSourceAppByBulk(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.DeleteAccessProfilesFromSourceAppByBulk(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.DeleteAccessProfilesFromSourceAppByBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccessProfilesFromSourceAppByBulk`: []AccessProfileDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.DeleteAccessProfilesFromSourceAppByBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-source-app +:::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 source app by ID +Use this API to delete a specific source app + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-source-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | source app ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | source app ID. # string | source app 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.AppsAPI.DeleteSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.DeleteSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.DeleteSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.DeleteSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-app +:::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 source app by ID +This API returns a source app by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-source-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the source app | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + 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.AppsAPI.GetSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.GetSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.GetSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.GetSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-profiles-for-source-app +:::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 access profiles for the specified source app +This API returns the list of access profiles for the specified source app + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-access-profiles-for-source-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the source app | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessProfilesForSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* | + +### Return type + +[**[]AccessProfileDetails**](../models/access-profile-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + 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") + 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) + filters := `name eq "developer access profile"` // 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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.ListAccessProfilesForSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.ListAccessProfilesForSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAccessProfilesForSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessProfilesForSourceApp`: []AccessProfileDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAccessProfilesForSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-all-source-app +:::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 all source apps +This API returns the list of all source apps for the org. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-all-source-app) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAllSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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] + **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: **id, name, created, modified, owner.id, accountSource.id** | + **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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* | + +### Return type + +[**[]SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, owner.id, accountSource.id** (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: **id, name, created, modified, owner.id, accountSource.id** (optional) + filters := `enabled eq true` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.ListAllSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.ListAllSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAllSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAllSourceApp`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAllSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-all-user-apps +:::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 all user apps +This API returns the list of all user apps with specified filters. +This API must be used with **filters** query parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-all-user-apps) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAllUserAppsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* | + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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 + +[**[]UserApp**](../models/user-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `name eq "user app name"` // 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.V2025.AppsAPI.ListAllUserApps(context.Background()).Filters(filters).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.ListAllUserApps(context.Background()).Filters(filters).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAllUserApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAllUserApps`: []UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAllUserApps`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-assigned-source-app +:::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 assigned source apps +This API returns the list of source apps assigned for logged in user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-assigned-source-app) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAssignedSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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] + **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: **id, name, created, modified, accountSource.id** | + **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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* | + +### Return type + +[**[]SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, accountSource.id** (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: **id, name, created, modified, accountSource.id** (optional) + filters := `name eq "source app name"` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.ListAssignedSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.ListAssignedSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAssignedSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAssignedSourceApp`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAssignedSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-available-accounts-for-user-app +:::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 available accounts for user app +This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-available-accounts-for-user-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the user app | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAvailableAccountsForUserAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]AppAccountDetails**](../models/app-account-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the user app # string | ID of the user app + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.ListAvailableAccountsForUserApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.ListAvailableAccountsForUserApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAvailableAccountsForUserApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAvailableAccountsForUserApp`: []AppAccountDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAvailableAccountsForUserApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-available-source-apps +:::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 available source apps +This API returns the list of source apps available for access request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-available-source-apps) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAvailableSourceAppsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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] + **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: **id, name, created, modified, owner.id, accountSource.id** | + **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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* | + +### Return type + +[**[]SourceApp**](../models/source-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, owner.id, accountSource.id** (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: **id, name, created, modified, owner.id, accountSource.id** (optional) + filters := `name eq "source app name"` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.ListAvailableSourceApps(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.ListAvailableSourceApps(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAvailableSourceApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAvailableSourceApps`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAvailableSourceApps`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-owned-user-apps +:::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 owned user apps +This API returns the list of user apps assigned to logged in user + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-owned-user-apps) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOwnedUserAppsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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] + **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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* | + +### Return type + +[**[]UserApp**](../models/user-app) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + filters := `name eq "user app name"` // 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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.ListOwnedUserApps(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.ListOwnedUserApps(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListOwnedUserApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOwnedUserApps`: []UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListOwnedUserApps`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-source-app +:::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 + ``` +::: +Patch source app by ID +This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. +Name, description and owner can't be empty or null. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-source-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the source app to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSourceAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**SourceAppPatchDto**](../models/source-app-patch-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app to patch # string | ID of the source app to patch + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]`) // []JsonPatchOperation | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.PatchSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.PatchSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.PatchSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSourceApp`: SourceAppPatchDto + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.PatchSourceApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-user-app +:::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 + ``` +::: +Patch user app by ID +This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **account** + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-user-app) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the user app to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchUserAppRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**UserApp**](../models/user-app) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the user app to patch # string | ID of the user app to patch + 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") + jsonpatchoperation := []byte(``) // []JsonPatchOperation | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.PatchUserApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.PatchUserApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.PatchUserApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchUserApp`: UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.PatchUserApp`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-source-apps-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 update source apps +This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. +The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. +Name, description and owner can't be empty or null. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-source-apps-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSourceAppsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **sourceAppBulkUpdateRequest** | [**SourceAppBulkUpdateRequest**](../models/source-app-bulk-update-request) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + sourceappbulkupdaterequest := []byte(`{ + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] + }`) // SourceAppBulkUpdateRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.AppsAPI.UpdateSourceAppsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.AppsAPI.UpdateSourceAppsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceAppBulkUpdateRequest(sourceAppBulkUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.UpdateSourceAppsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AuthProfileAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AuthProfileAPI.md new file mode 100644 index 000000000..71b7c344d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AuthProfileAPI.md @@ -0,0 +1,268 @@ +--- +id: v2025-auth-profile +title: AuthProfile +pagination_label: AuthProfile +sidebar_label: AuthProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuthProfile', 'V2025AuthProfile'] +slug: /tools/sdk/go/v2025/methods/auth-profile +tags: ['SDK', 'Software Development Kit', 'AuthProfile', 'V2025AuthProfile'] +--- + +# AuthProfileAPI + Use this API to implement Auth Profile functionality. +With this functionality in place, users can read authentication profiles and make changes to them. + +An authentication profile represents an identity profile's authentication configuration. +When the identity profile is created, its authentication profile is also created. +An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-profile-config**](#get-profile-config) | **Get** `/auth-profiles/{id}` | Get Auth Profile +[**get-profile-config-list**](#get-profile-config-list) | **Get** `/auth-profiles` | Get list of Auth Profiles +[**patch-profile-config**](#patch-profile-config) | **Patch** `/auth-profiles/{id}` | Patch a specified Auth Profile + + +## get-profile-config +:::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 Auth Profile +This API returns auth profile information. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-profile-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Auth Profile to patch. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProfileConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + + +### Return type + +[**AuthProfile**](../models/auth-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + id := `2c91808a7813090a017814121919ecca` // string | ID of the Auth Profile to patch. # string | ID of the Auth Profile to patch. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AuthProfileAPI.GetProfileConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AuthProfileAPI.GetProfileConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.GetProfileConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProfileConfig`: AuthProfile + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.GetProfileConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-profile-config-list +:::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 list of Auth Profiles +This API returns a list of auth profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-profile-config-list) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProfileConfigListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**[]AuthProfileSummary**](../models/auth-profile-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AuthProfileAPI.GetProfileConfigList(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AuthProfileAPI.GetProfileConfigList(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.GetProfileConfigList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProfileConfigList`: []AuthProfileSummary + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.GetProfileConfigList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-profile-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 + ``` +::: +Patch a specified Auth Profile +This API updates an existing Auth Profile. The following fields are patchable: +**offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-profile-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Auth Profile to patch. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchProfileConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**AuthProfile**](../models/auth-profile) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Auth Profile to patch. # string | ID of the Auth Profile to patch. + 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") + jsonpatchoperation := []byte(``) // []JsonPatchOperation | + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AuthProfileAPI.PatchProfileConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.AuthProfileAPI.PatchProfileConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.PatchProfileConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchProfileConfig`: AuthProfile + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.PatchProfileConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/AuthUsersAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/AuthUsersAPI.md new file mode 100644 index 000000000..0b2e7225e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/AuthUsersAPI.md @@ -0,0 +1,170 @@ +--- +id: v2025-auth-users +title: AuthUsers +pagination_label: AuthUsers +sidebar_label: AuthUsers +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuthUsers', 'V2025AuthUsers'] +slug: /tools/sdk/go/v2025/methods/auth-users +tags: ['SDK', 'Software Development Kit', 'AuthUsers', 'V2025AuthUsers'] +--- + +# AuthUsersAPI + Use this API to implement user authentication system functionality. +With this functionality in place, users can get a user's authentication system details, including their capabilities, and modify those capabilities. +The user's capabilities refer to their access to different systems, or authorization, within the tenant, like access to certifications (CERT_ADMIN) or reports (REPORT_ADMIN). +These capabilities also determine a user's access to the different APIs. +This API provides users with a way to determine a user's access and make quick and easy changes to that access. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-auth-user**](#get-auth-user) | **Get** `/auth-users/{id}` | Auth User Details +[**patch-auth-user**](#patch-auth-user) | **Patch** `/auth-users/{id}` | Auth User Update + + +## get-auth-user +Auth User Details +Return the specified user's authentication system details. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-user) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Identity ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAuthUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AuthUser**](../models/auth-user) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AuthUsersAPI.GetAuthUser(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.AuthUsersAPI.GetAuthUser(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthUsersAPI.GetAuthUser``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthUser`: AuthUser + fmt.Fprintf(os.Stdout, "Response from `AuthUsersAPI.GetAuthUser`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-auth-user +Auth User Update +Use a PATCH request to update an existing user in the authentication system. +Use this endpoint to modify these fields: + * `capabilities` + +A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-user) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Identity ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAuthUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +[**AuthUser**](../models/auth-user) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + jsonpatchoperation := []byte(`[{op=replace, path=/capabilities, value=[ORG_ADMIN]}]`) // []JsonPatchOperation | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AuthUsersAPI.PatchAuthUser(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.AuthUsersAPI.PatchAuthUser(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthUsersAPI.PatchAuthUser``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthUser`: AuthUser + fmt.Fprintf(os.Stdout, "Response from `AuthUsersAPI.PatchAuthUser`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/BrandingAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/BrandingAPI.md new file mode 100644 index 000000000..755af430d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/BrandingAPI.md @@ -0,0 +1,374 @@ +--- +id: v2025-branding +title: Branding +pagination_label: Branding +sidebar_label: Branding +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Branding', 'V2025Branding'] +slug: /tools/sdk/go/v2025/methods/branding +tags: ['SDK', 'Software Development Kit', 'Branding', 'V2025Branding'] +--- + +# BrandingAPI + Use this API to implement and customize branding functionality. +With this functionality in place, administrators can get and manage existing branding items, and they can also create new branding items and configure them for use throughout Identity Security Cloud. +The Branding APIs provide administrators with a way to customize branding items. +This customization includes details like their colors, logos, and other information. +Refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) for more information about certifications. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-branding-item**](#create-branding-item) | **Post** `/brandings` | Create a branding item +[**delete-branding**](#delete-branding) | **Delete** `/brandings/{name}` | Delete a branding item +[**get-branding**](#get-branding) | **Get** `/brandings/{name}` | Get a branding item +[**get-branding-list**](#get-branding-list) | **Get** `/brandings` | List of branding items +[**set-branding-item**](#set-branding-item) | **Put** `/brandings/{name}` | Update a branding item + + +## create-branding-item +Create a branding item +This API endpoint creates a branding item. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-branding-item) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateBrandingItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **string** | name of branding item | + **productName** | **string** | product name | + **actionButtonColor** | **string** | hex value of color for action button | + **activeLinkColor** | **string** | hex value of color for link | + **navigationColor** | **string** | hex value of color for navigation bar | + **emailFromAddress** | **string** | email from address | + **loginInformationalMessage** | **string** | login information message | + **fileStandard** | ***os.File** | png file with logo | + +### Return type + +[**BrandingItem**](../models/branding-item) + +### 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() { + name := `name_example` // string | name of branding item # string | name of branding item + productName := `productName_example` // string | product name # string | product name + actionButtonColor := `actionButtonColor_example` // string | hex value of color for action button (optional) # string | hex value of color for action button (optional) + activeLinkColor := `activeLinkColor_example` // string | hex value of color for link (optional) # string | hex value of color for link (optional) + navigationColor := `navigationColor_example` // string | hex value of color for navigation bar (optional) # string | hex value of color for navigation bar (optional) + emailFromAddress := `emailFromAddress_example` // string | email from address (optional) # string | email from address (optional) + loginInformationalMessage := `loginInformationalMessage_example` // string | login information message (optional) # string | login information message (optional) + fileStandard := BINARY_DATA_HERE // *os.File | png file with logo (optional) # *os.File | png file with logo (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.BrandingAPI.CreateBrandingItem(context.Background()).Name(name).ProductName(productName).Execute() + //resp, r, err := apiClient.V2025.BrandingAPI.CreateBrandingItem(context.Background()).Name(name).ProductName(productName).ActionButtonColor(actionButtonColor).ActiveLinkColor(activeLinkColor).NavigationColor(navigationColor).EmailFromAddress(emailFromAddress).LoginInformationalMessage(loginInformationalMessage).FileStandard(fileStandard).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.CreateBrandingItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateBrandingItem`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.CreateBrandingItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-branding +Delete a branding item +This API endpoint delete information for an existing branding item by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-branding) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The name of the branding item to be deleted | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteBrandingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `default` // string | The name of the branding item to be deleted # string | The name of the branding item to be deleted + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.BrandingAPI.DeleteBranding(context.Background(), name).Execute() + //r, err := apiClient.V2025.BrandingAPI.DeleteBranding(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.DeleteBranding``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-branding +Get a branding item +This API endpoint retrieves information for an existing branding item by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-branding) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The name of the branding item to be retrieved | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetBrandingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**BrandingItem**](../models/branding-item) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `default` // string | The name of the branding item to be retrieved # string | The name of the branding item to be retrieved + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.BrandingAPI.GetBranding(context.Background(), name).Execute() + //resp, r, err := apiClient.V2025.BrandingAPI.GetBranding(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.GetBranding``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBranding`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.GetBranding`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-branding-list +List of branding items +This API endpoint returns a list of branding items. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-branding-list) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetBrandingListRequest struct via the builder pattern + + +### Return type + +[**[]BrandingItem**](../models/branding-item) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.BrandingAPI.GetBrandingList(context.Background()).Execute() + //resp, r, err := apiClient.V2025.BrandingAPI.GetBrandingList(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.GetBrandingList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBrandingList`: []BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.GetBrandingList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-branding-item +Update a branding item +This API endpoint updates information for an existing branding item. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-branding-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The name of the branding item to be retrieved | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetBrandingItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **name2** | **string** | name of branding item | + **productName** | **string** | product name | + **actionButtonColor** | **string** | hex value of color for action button | + **activeLinkColor** | **string** | hex value of color for link | + **navigationColor** | **string** | hex value of color for navigation bar | + **emailFromAddress** | **string** | email from address | + **loginInformationalMessage** | **string** | login information message | + **fileStandard** | ***os.File** | png file with logo | + +### Return type + +[**BrandingItem**](../models/branding-item) + +### 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() { + name := `default` // string | The name of the branding item to be retrieved # string | The name of the branding item to be retrieved + name2 := `name_example` // string | name of branding item # string | name of branding item + productName := `productName_example` // string | product name # string | product name + actionButtonColor := `actionButtonColor_example` // string | hex value of color for action button (optional) # string | hex value of color for action button (optional) + activeLinkColor := `activeLinkColor_example` // string | hex value of color for link (optional) # string | hex value of color for link (optional) + navigationColor := `navigationColor_example` // string | hex value of color for navigation bar (optional) # string | hex value of color for navigation bar (optional) + emailFromAddress := `emailFromAddress_example` // string | email from address (optional) # string | email from address (optional) + loginInformationalMessage := `loginInformationalMessage_example` // string | login information message (optional) # string | login information message (optional) + fileStandard := BINARY_DATA_HERE // *os.File | png file with logo (optional) # *os.File | png file with logo (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.BrandingAPI.SetBrandingItem(context.Background(), name).Name2(name2).ProductName(productName).Execute() + //resp, r, err := apiClient.V2025.BrandingAPI.SetBrandingItem(context.Background(), name).Name2(name2).ProductName(productName).ActionButtonColor(actionButtonColor).ActiveLinkColor(activeLinkColor).NavigationColor(navigationColor).EmailFromAddress(emailFromAddress).LoginInformationalMessage(loginInformationalMessage).FileStandard(fileStandard).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.SetBrandingItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetBrandingItem`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.SetBrandingItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/CertificationCampaignFiltersAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/CertificationCampaignFiltersAPI.md new file mode 100644 index 000000000..b6603cfec --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/CertificationCampaignFiltersAPI.md @@ -0,0 +1,425 @@ +--- +id: v2025-certification-campaign-filters +title: CertificationCampaignFilters +pagination_label: CertificationCampaignFilters +sidebar_label: CertificationCampaignFilters +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationCampaignFilters', 'V2025CertificationCampaignFilters'] +slug: /tools/sdk/go/v2025/methods/certification-campaign-filters +tags: ['SDK', 'Software Development Kit', 'CertificationCampaignFilters', 'V2025CertificationCampaignFilters'] +--- + +# CertificationCampaignFiltersAPI + Use this API to implement the certification campaign filter functionality. These filters can be used to create a certification campaign that includes a subset of your entitlements or users to certify. + +For example, if for a certification campaign an organization wants to certify only specific users or entitlements, then those can be included/excluded on the basis of campaign filters. + +For more information about creating a campaign filter, refer to [Creating a Campaign Filter](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#creating-a-campaign-filter) + +You can create campaign filters using any of the following criteria types: + +- Access Profile : This criteria type includes or excludes access profiles from a campaign. + +- Account Attribute : This criteria type includes or excludes certification items that match a specified value in an account attribute. + +- Entitlement : This criteria type includes or excludes entitlements from a campaign. + +- Identity : This criteria type includes or excludes specific identities from your campaign. + +- Identity Attribute : This criteria type includes or excludes identities based on whether they have an identity attribute that matches criteria you've chosen. + +- Role : This criteria type includes or excludes roles, as opposed to identities. + +- Source : This criteria type includes or excludes entitlements from a source you select. + +For more information about these criteria types, refer to [Types of Campaign Filters](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#types-of-campaign-filters) + +Once the campaign filter is created, it can be linked while creating the campaign. The generated campaign will have the items to review as per the campaign filter. + +For example, An inclusion campaign filter is created with a source of Source 1, an operation of Equals, and an entitlement of Entitlement 1. When this filter is selected, only users who have Entitlement 1 are included in the campaign, and only Entitlement 1 is shown in the certification. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-campaign-filter**](#create-campaign-filter) | **Post** `/campaign-filters` | Create Campaign Filter +[**delete-campaign-filters**](#delete-campaign-filters) | **Post** `/campaign-filters/delete` | Deletes Campaign Filters +[**get-campaign-filter-by-id**](#get-campaign-filter-by-id) | **Get** `/campaign-filters/{id}` | Get Campaign Filter by ID +[**list-campaign-filters**](#list-campaign-filters) | **Get** `/campaign-filters` | List Campaign Filters +[**update-campaign-filter**](#update-campaign-filter) | **Post** `/campaign-filters/{id}` | Updates a Campaign Filter + + +## create-campaign-filter +Create Campaign Filter +Use this API to create a campaign filter based on filter details and criteria. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-campaign-filter) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCampaignFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaignFilterDetails** | [**CampaignFilterDetails**](../models/campaign-filter-details) | | + +### Return type + +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + campaignfilterdetails := []byte(`{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + }`) // CampaignFilterDetails | + + + var campaignFilterDetails v2025.CampaignFilterDetails + if err := json.Unmarshal(campaignfilterdetails, &campaignFilterDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignFiltersAPI.CreateCampaignFilter(context.Background()).CampaignFilterDetails(campaignFilterDetails).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignFiltersAPI.CreateCampaignFilter(context.Background()).CampaignFilterDetails(campaignFilterDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.CreateCampaignFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaignFilter`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.CreateCampaignFilter`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-campaign-filters +Deletes Campaign Filters +Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-campaign-filters) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCampaignFiltersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestBody** | **[]string** | A json list of IDs of campaign filters to delete. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestbody := []byte(``) // []string | A json list of IDs of campaign filters to delete. + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.CertificationCampaignFiltersAPI.DeleteCampaignFilters(context.Background()).RequestBody(requestBody).Execute() + //r, err := apiClient.V2025.CertificationCampaignFiltersAPI.DeleteCampaignFilters(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.DeleteCampaignFilters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-campaign-filter-by-id +Get Campaign Filter by ID +Retrieves information for an existing campaign filter using the filter's ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-campaign-filter-by-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the campaign filter to be retrieved. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignFilterByIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `e9f9a1397b842fd5a65842087040d3ac` // string | The ID of the campaign filter to be retrieved. # string | The ID of the campaign filter to be retrieved. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignFiltersAPI.GetCampaignFilterById(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignFiltersAPI.GetCampaignFilterById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.GetCampaignFilterById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignFilterById`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.GetCampaignFilterById`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-campaign-filters +List Campaign Filters +Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-campaign-filters) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCampaignFiltersRequest struct via the builder pattern + + +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] + **start** | **int32** | Start/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] + **includeSystemFilters** | **bool** | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. | [default to true] + +### Return type + +[**ListCampaignFilters200Response**](../models/list-campaign-filters200-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + start := 0 // int32 | Start/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 | Start/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) + includeSystemFilters := true // bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to true) # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignFiltersAPI.ListCampaignFilters(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignFiltersAPI.ListCampaignFilters(context.Background()).Limit(limit).Start(start).IncludeSystemFilters(includeSystemFilters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.ListCampaignFilters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCampaignFilters`: ListCampaignFilters200Response + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.ListCampaignFilters`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-campaign-filter +Updates a Campaign Filter +Updates an existing campaign filter using the filter's ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-campaign-filter) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**filterId** | **string** | The ID of the campaign filter being modified. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateCampaignFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **campaignFilterDetails** | [**CampaignFilterDetails**](../models/campaign-filter-details) | A campaign filter details with updated field values. | + +### Return type + +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filterId := `e9f9a1397b842fd5a65842087040d3ac` // string | The ID of the campaign filter being modified. # string | The ID of the campaign filter being modified. + campaignfilterdetails := []byte(`{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + }`) // CampaignFilterDetails | A campaign filter details with updated field values. + + + var campaignFilterDetails v2025.CampaignFilterDetails + if err := json.Unmarshal(campaignfilterdetails, &campaignFilterDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignFiltersAPI.UpdateCampaignFilter(context.Background(), filterId).CampaignFilterDetails(campaignFilterDetails).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignFiltersAPI.UpdateCampaignFilter(context.Background(), filterId).CampaignFilterDetails(campaignFilterDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.UpdateCampaignFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCampaignFilter`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.UpdateCampaignFilter`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/CertificationCampaignsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/CertificationCampaignsAPI.md new file mode 100644 index 000000000..00f75bfd3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/CertificationCampaignsAPI.md @@ -0,0 +1,1907 @@ +--- +id: v2025-certification-campaigns +title: CertificationCampaigns +pagination_label: CertificationCampaigns +sidebar_label: CertificationCampaigns +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationCampaigns', 'V2025CertificationCampaigns'] +slug: /tools/sdk/go/v2025/methods/certification-campaigns +tags: ['SDK', 'Software Development Kit', 'CertificationCampaigns', 'V2025CertificationCampaigns'] +--- + +# CertificationCampaignsAPI + Use this API to implement certification campaign functionality. +With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use. +Certification campaigns provide Identity Security Cloud users with an interactive review process they can use to identify and verify access to systems. +Campaigns help organizations reduce risk of inappropriate access and satisfy audit requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers. +Once this campaign has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Identity Security Cloud provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns: + +You can create these types of campaigns without using any search queries in Identity Security Cloud: + +- ManagerCampaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access is certified by their managers. +You only need to provide a name and description to create one. + +- Source Owner Campaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners. +You only need to provide a name and description to create one. +You can specify the sources whose owners you want involved or just run it across all sources. + +For more information about these campaign types, refer to [Starting a Manager or Source Owner Campaign](https://documentation.sailpoint.com/saas/help/certs/starting_campaign.html). + +One useful way to create certification campaigns in Identity Security Cloud is to use a specific search and then run a campaign on the results returned by that search. +This allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns. +For example, you can search for all identities who are managed by "Amanda.Ross" and also have the access to the "Accounting" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified. + +You can use Identity Security Cloud search queries to create these types of campaigns: + +- Identities: Use this campaign type to review and revoke access items for specific identities. +You can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign. + +- Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them. +You can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign. + +- Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria. +You can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign. + +- Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in Identity Security Cloud. +You can use this campaign type to view all the uncorrelated accounts for a source and certify them. + +For more information about search-based campaigns, refer to [Starting a Campaign from Search](https://documentation.sailpoint.com/saas/help/certs/starting_search_campaign.html). + +Once you have generated your campaign, it becomes available for preview. +An administrator can review the campaign and make changes, or if it's ready and accurate, activate it. + +Once the campaign is active, organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed). + +When a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review. +Reviewers can then make decisions to grant or revoke access, as well as reassign the certification to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must "Sign Off" to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. +In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +The end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision. + +For more information about certifications and certification campaigns, refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html). + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**complete-campaign**](#complete-campaign) | **Post** `/campaigns/{id}/complete` | Complete a Campaign +[**create-campaign**](#create-campaign) | **Post** `/campaigns` | Create a campaign +[**create-campaign-template**](#create-campaign-template) | **Post** `/campaign-templates` | Create a Campaign Template +[**delete-campaign-template**](#delete-campaign-template) | **Delete** `/campaign-templates/{id}` | Delete a Campaign Template +[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **Delete** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule +[**delete-campaigns**](#delete-campaigns) | **Post** `/campaigns/delete` | Delete Campaigns +[**get-active-campaigns**](#get-active-campaigns) | **Get** `/campaigns` | List Campaigns +[**get-campaign**](#get-campaign) | **Get** `/campaigns/{id}` | Get Campaign +[**get-campaign-reports**](#get-campaign-reports) | **Get** `/campaigns/{id}/reports` | Get Campaign Reports +[**get-campaign-reports-config**](#get-campaign-reports-config) | **Get** `/campaigns/reports-configuration` | Get Campaign Reports Configuration +[**get-campaign-template**](#get-campaign-template) | **Get** `/campaign-templates/{id}` | Get a Campaign Template +[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **Get** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule +[**get-campaign-templates**](#get-campaign-templates) | **Get** `/campaign-templates` | List Campaign Templates +[**move**](#move) | **Post** `/campaigns/{id}/reassign` | Reassign Certifications +[**patch-campaign-template**](#patch-campaign-template) | **Patch** `/campaign-templates/{id}` | Update a Campaign Template +[**set-campaign-reports-config**](#set-campaign-reports-config) | **Put** `/campaigns/reports-configuration` | Set Campaign Reports Configuration +[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **Put** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule +[**start-campaign**](#start-campaign) | **Post** `/campaigns/{id}/activate` | Activate a Campaign +[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **Post** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan +[**start-campaign-report**](#start-campaign-report) | **Post** `/campaigns/{id}/run-report/{type}` | Run Campaign Report +[**start-generate-campaign-template**](#start-generate-campaign-template) | **Post** `/campaign-templates/{id}/generate` | Generate a Campaign from Template +[**update-campaign**](#update-campaign) | **Patch** `/campaigns/{id}` | Update a Campaign + + +## complete-campaign +Complete a Campaign +:::caution + +This endpoint will run successfully for any campaigns that are **past due**. + +This endpoint will return a content error if the campaign is **not past due**. + +::: + +Use this API to complete a certification campaign. This functionality is provided to admins so that they +can complete a certification even if all items have not been completed. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/complete-campaign) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Campaign ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompleteCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **campaignCompleteOptions** | [**CampaignCompleteOptions**](../models/campaign-complete-options) | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Campaign ID. # string | Campaign ID. + campaigncompleteoptions := []byte(`{ + "autoCompleteAction" : "REVOKE" + }`) // CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.CompleteCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.CompleteCampaign(context.Background(), id).CampaignCompleteOptions(campaignCompleteOptions).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CompleteCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompleteCampaign`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CompleteCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-campaign +Create a campaign +Use this API to create a certification campaign with the information provided in the request body. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-campaign) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaign** | [**Campaign**](../models/campaign) | | + +### Return type + +[**Campaign**](../models/campaign) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + campaign := []byte(`{ + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }`) // Campaign | + + + var campaign v2025.Campaign + if err := json.Unmarshal(campaign, &campaign); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.CreateCampaign(context.Background()).Campaign(campaign).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.CreateCampaign(context.Background()).Campaign(campaign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CreateCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaign`: Campaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CreateCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-campaign-template +Create a Campaign Template +Use this API to create a certification campaign template based on campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-campaign-template) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaignTemplate** | [**CampaignTemplate**](../models/campaign-template) | | + +### Return type + +[**CampaignTemplate**](../models/campaign-template) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + campaigntemplate := []byte(`{ + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + }`) // CampaignTemplate | + + + var campaignTemplate v2025.CampaignTemplate + if err := json.Unmarshal(campaigntemplate, &campaignTemplate); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.CreateCampaignTemplate(context.Background()).CampaignTemplate(campaignTemplate).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.CreateCampaignTemplate(context.Background()).CampaignTemplate(campaignTemplate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CreateCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CreateCampaignTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-campaign-template +Delete a Campaign Template +Use this API to delete a certification campaign template by ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-campaign-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template being deleted. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template being deleted. # string | ID of the campaign template being deleted. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.CertificationCampaignsAPI.DeleteCampaignTemplate(context.Background(), id).Execute() + //r, err := apiClient.V2025.CertificationCampaignsAPI.DeleteCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-campaign-template-schedule +Delete Campaign Template Schedule +Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-campaign-template-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template whose schedule is being deleted. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCampaignTemplateScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template whose schedule is being deleted. # string | ID of the campaign template whose schedule is being deleted. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.CertificationCampaignsAPI.DeleteCampaignTemplateSchedule(context.Background(), id).Execute() + //r, err := apiClient.V2025.CertificationCampaignsAPI.DeleteCampaignTemplateSchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-campaigns +Delete Campaigns +Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-campaigns) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCampaignsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaignsDeleteRequest** | [**CampaignsDeleteRequest**](../models/campaigns-delete-request) | IDs of the campaigns to delete. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + campaignsdeleterequest := []byte(`{ + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + }`) // CampaignsDeleteRequest | IDs of the campaigns to delete. + + + var campaignsDeleteRequest v2025.CampaignsDeleteRequest + if err := json.Unmarshal(campaignsdeleterequest, &campaignsDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).CampaignsDeleteRequest(campaignsDeleteRequest).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).CampaignsDeleteRequest(campaignsDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaigns``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteCampaigns`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.DeleteCampaigns`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-active-campaigns +List Campaigns +Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-active-campaigns) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetActiveCampaignsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **detail** | **string** | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **status**: *eq, in* | + **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, created** | + +### Return type + +[**[]GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Manager Campaign"` // 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* **status**: *eq, in* (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* **status**: *eq, in* (optional) + sorters := `name` // 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, created** (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, created** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetActiveCampaigns(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetActiveCampaigns(context.Background()).Detail(detail).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetActiveCampaigns``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetActiveCampaigns`: []GetActiveCampaigns200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetActiveCampaigns`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign +Get Campaign +Use this API to get information for an existing certification campaign by the campaign's ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-campaign) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign to be retrieved. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **detail** | **string** | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. | + +### Return type + +[**GetCampaign200Response**](../models/get-campaign200-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign to be retrieved. # string | ID of the campaign to be retrieved. + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaign(context.Background(), id).Detail(detail).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaign`: GetCampaign200Response + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-reports +Get Campaign Reports +Use this API to fetch all reports for a certification campaign by campaign ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-campaign-reports) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign whose reports are being fetched. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignReportsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]CampaignReport**](../models/campaign-report) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign whose reports are being fetched. # string | ID of the campaign whose reports are being fetched. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignReports(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignReports(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignReports``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignReports`: []CampaignReport + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignReports`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-reports-config +Get Campaign Reports Configuration +Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-campaign-reports-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignReportsConfigRequest struct via the builder pattern + + +### Return type + +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignReportsConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignReportsConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignReportsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignReportsConfig`: CampaignReportsConfig + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignReportsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-template +Get a Campaign Template +Use this API to fetch a certification campaign template by ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-campaign-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Requested campaign template's ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CampaignTemplate**](../models/campaign-template) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Requested campaign template's ID. # string | Requested campaign template's ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-template-schedule +Get Campaign Template Schedule +Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-campaign-template-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template whose schedule is being fetched. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignTemplateScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Schedule**](../models/schedule) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template whose schedule is being fetched. # string | ID of the campaign template whose schedule is being fetched. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignTemplateSchedule(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignTemplateSchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplateSchedule`: Schedule + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplateSchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-templates +List Campaign Templates +Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. + +The API returns all campaign templates matching the query parameters. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-campaign-templates) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignTemplatesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, created, modified** | + **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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* | + +### Return type + +[**[]CampaignTemplate**](../models/campaign-template) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name` // 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, created, modified** (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, created, modified** (optional) + filters := `name eq "manager template"` // 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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignTemplates(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignTemplates(context.Background()).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplates`: []CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplates`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## move +Reassign Certifications +This API reassigns the specified certifications from one identity to another. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/move) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The certification campaign ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiMoveRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **adminReviewReassign** | [**AdminReviewReassign**](../models/admin-review-reassign) | | + +### Return type + +[**CertificationTask**](../models/certification-task) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification campaign ID # string | The certification campaign ID + adminreviewreassign := []byte(`{ + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + }`) // AdminReviewReassign | + + + var adminReviewReassign v2025.AdminReviewReassign + if err := json.Unmarshal(adminreviewreassign, &adminReviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.Move(context.Background(), id).AdminReviewReassign(adminReviewReassign).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.Move(context.Background(), id).AdminReviewReassign(adminReviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.Move``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `Move`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.Move`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-campaign-template +Update a Campaign Template +Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-campaign-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template being modified. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) | + +### Return type + +[**CampaignTemplate**](../models/campaign-template) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template being modified. # string | ID of the campaign template being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/campaign/filter/id, value=ff80818155fe8c080155fe8d925b0316}]`) // []JsonPatchOperation | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.PatchCampaignTemplate(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.PatchCampaignTemplate(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.PatchCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.PatchCampaignTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-campaign-reports-config +Set Campaign Reports Configuration +Use this API to overwrite the configuration for campaign reports. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-campaign-reports-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetCampaignReportsConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaignReportsConfig** | [**CampaignReportsConfig**](../models/campaign-reports-config) | Campaign report configuration. | + +### Return type + +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + campaignreportsconfig := []byte(`{ + "identityAttributeColumns" : [ "firstname", "lastname" ] + }`) // CampaignReportsConfig | Campaign report configuration. + + + var campaignReportsConfig v2025.CampaignReportsConfig + if err := json.Unmarshal(campaignreportsconfig, &campaignReportsConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.SetCampaignReportsConfig(context.Background()).CampaignReportsConfig(campaignReportsConfig).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.SetCampaignReportsConfig(context.Background()).CampaignReportsConfig(campaignReportsConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.SetCampaignReportsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetCampaignReportsConfig`: CampaignReportsConfig + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.SetCampaignReportsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-campaign-template-schedule +Set Campaign Template Schedule +Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-campaign-template-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template being scheduled. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetCampaignTemplateScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schedule** | [**Schedule**](../models/schedule) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template being scheduled. # string | ID of the campaign template being scheduled. + schedule := []byte(`{ + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + }`) // Schedule | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.CertificationCampaignsAPI.SetCampaignTemplateSchedule(context.Background(), id).Execute() + //r, err := apiClient.V2025.CertificationCampaignsAPI.SetCampaignTemplateSchedule(context.Background(), id).Schedule(schedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.SetCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## start-campaign +Activate a Campaign +Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-campaign) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Campaign ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **activateCampaignOptions** | [**ActivateCampaignOptions**](../models/activate-campaign-options) | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Campaign ID. # string | Campaign ID. + activatecampaignoptions := []byte(`{ + "timeZone" : "-05:00" + }`) // ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.StartCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.StartCampaign(context.Background(), id).ActivateCampaignOptions(activateCampaignOptions).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaign`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-campaign-remediation-scan +Run Campaign Remediation Scan +Use this API to run a remediation scan task for a certification campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-campaign-remediation-scan) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign the remediation scan is being run for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartCampaignRemediationScanRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign the remediation scan is being run for. # string | ID of the campaign the remediation scan is being run for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.StartCampaignRemediationScan(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.StartCampaignRemediationScan(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaignRemediationScan``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaignRemediationScan`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaignRemediationScan`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-campaign-report +Run Campaign Report +Use this API to run a report for a certification campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-campaign-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign the report is being run for. | +**type_** | [**ReportType**](../models/) | Type of the report to run. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartCampaignReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign the report is being run for. # string | ID of the campaign the report is being run for. + type_ := // ReportType | Type of the report to run. # ReportType | Type of the report to run. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.StartCampaignReport(context.Background(), id, type_).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.StartCampaignReport(context.Background(), id, type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaignReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaignReport`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaignReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-generate-campaign-template +Generate a Campaign from Template +Use this API to generate a new certification campaign from a campaign template. + +The campaign object contained in the template has special formatting applied to its name and description +fields that determine the generated campaign's name/description. Placeholders in those fields are +formatted with the current date and time upon generation. + +Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For +example, "%Y" inserts the current year, and a campaign template named "Campaign for %y" generates a +campaign called "Campaign for 2020" (assuming the year at generation time is 2020). + +Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-generate-campaign-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template to use for generation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartGenerateCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CampaignReference**](../models/campaign-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template to use for generation. # string | ID of the campaign template to use for generation. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.StartGenerateCampaignTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.StartGenerateCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartGenerateCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartGenerateCampaignTemplate`: CampaignReference + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartGenerateCampaignTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-campaign +Update a Campaign +Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-campaign) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template being modified. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline | + +### Return type + +[**SlimCampaign**](../models/slim-campaign) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign template being modified. # string | ID of the campaign template being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]`) // []JsonPatchOperation | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.UpdateCampaign(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.UpdateCampaign(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.UpdateCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCampaign`: SlimCampaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.UpdateCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/CertificationSummariesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/CertificationSummariesAPI.md new file mode 100644 index 000000000..2489edda0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/CertificationSummariesAPI.md @@ -0,0 +1,329 @@ +--- +id: v2025-certification-summaries +title: CertificationSummaries +pagination_label: CertificationSummaries +sidebar_label: CertificationSummaries +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationSummaries', 'V2025CertificationSummaries'] +slug: /tools/sdk/go/v2025/methods/certification-summaries +tags: ['SDK', 'Software Development Kit', 'CertificationSummaries', 'V2025CertificationSummaries'] +--- + +# CertificationSummariesAPI + Use this API to implement certification summary functionality. +With this functionality in place, administrators and designated certification reviewers can review summaries of identity certification campaigns and draw conclusions about the campaigns' scope, security, and effectiveness. +Implementing certification summary functionality improves organizations' ability to review their [certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) and helps them satisfy audit and regulatory requirements by enabling them to trace access changes and the decisions made in their review processes. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Certification summaries provide information about identity certification campaigns such as the identities involved, the number of decisions made, and the access changed. +For example, an administrator or designated certification reviewer can examine the Manager Certification campaign to get an overview of how many entitlement decisions are made in that campaign as opposed to role decisions, which identities would be affected by changes to the campaign, and how those identities' access would be affected. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-identity-access-summaries**](#get-identity-access-summaries) | **Get** `/certifications/{id}/access-summaries/{type}` | Access Summaries +[**get-identity-decision-summary**](#get-identity-decision-summary) | **Get** `/certifications/{id}/decision-summary` | Summary of Certification Decisions +[**get-identity-summaries**](#get-identity-summaries) | **Get** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification +[**get-identity-summary**](#get-identity-summary) | **Get** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity + + +## get-identity-access-summaries +Access Summaries +This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-access-summaries) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | +**type_** | **string** | The type of access review item to retrieve summaries for | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityAccessSummariesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* | + **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: **access.name** | + +### Return type + +[**[]AccessSummary**](../models/access-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + type_ := `ACCESS_PROFILE` // string | The type of access review item to retrieve summaries for # string | The type of access review item to retrieve summaries for + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "ef38f94347e94562b5bb8424a56397d8"` // 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters := `access.name` // 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: **access.name** (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: **access.name** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationSummariesAPI.GetIdentityAccessSummaries(context.Background(), id, type_).Execute() + //resp, r, err := apiClient.V2025.CertificationSummariesAPI.GetIdentityAccessSummaries(context.Background(), id, type_).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentityAccessSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityAccessSummaries`: []AccessSummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentityAccessSummaries`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-decision-summary +Summary of Certification Decisions +This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-decision-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityDecisionSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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: **identitySummary.id**: *eq, in* | + +### Return type + +[**IdentityCertDecisionSummary**](../models/identity-cert-decision-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification ID + filters := `identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"` // 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: **identitySummary.id**: *eq, in* (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: **identitySummary.id**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationSummariesAPI.GetIdentityDecisionSummary(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationSummariesAPI.GetIdentityDecisionSummary(context.Background(), id).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentityDecisionSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityDecisionSummary`: IdentityCertDecisionSummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentityDecisionSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-summaries +Identity Summaries for Campaign Certification +This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-summaries) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentitySummariesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **completed**: *eq, ne* **name**: *eq, sw* | + **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** | + +### Return type + +[**[]CertificationIdentitySummary**](../models/certification-identity-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **completed**: *eq, ne* **name**: *eq, sw* (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* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters := `name` // 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** (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** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationSummariesAPI.GetIdentitySummaries(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationSummariesAPI.GetIdentitySummaries(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentitySummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySummaries`: []CertificationIdentitySummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentitySummaries`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-summary +Summary for Identity +This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | +**identitySummaryId** | **string** | The identity summary ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentitySummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**CertificationIdentitySummary**](../models/certification-identity-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + identitySummaryId := `2c91808772a504f50172a9540e501ba8` // string | The identity summary ID # string | The identity summary ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationSummariesAPI.GetIdentitySummary(context.Background(), id, identitySummaryId).Execute() + //resp, r, err := apiClient.V2025.CertificationSummariesAPI.GetIdentitySummary(context.Background(), id, identitySummaryId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentitySummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySummary`: CertificationIdentitySummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentitySummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/CertificationsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/CertificationsAPI.md new file mode 100644 index 000000000..dc94930cb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/CertificationsAPI.md @@ -0,0 +1,875 @@ +--- +id: v2025-certifications +title: Certifications +pagination_label: Certifications +sidebar_label: Certifications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Certifications', 'V2025Certifications'] +slug: /tools/sdk/go/v2025/methods/certifications +tags: ['SDK', 'Software Development Kit', 'Certifications', 'V2025Certifications'] +--- + +# CertificationsAPI + Use this API to implement certification functionality. +With this functionality in place, administrators and designated certification reviewers can review users' access certifications and decide whether to approve access, revoke it, or reassign the review to another reviewer. +Implementing certifications improves organizations' data security by reducing inappropriate access through a distributed review process and helping them satisfy audit and regulatory requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can select the 'Certifications' tab to view any of the certifications they either need to review or have already reviewed under the 'Active' and 'Completed' tabs, respectively. + +When a certification campaign is in progress, certification reviewers will see certifications listed under 'Active,' where they can review the involved identities. +Under the 'Decision' column on the right, next to each access item, reviewers can select the checkmark to approve access, select the 'X' to revoke access, or they can toggle the 'More Options' menu to reassign the certification to another reviewer and provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must select 'Sign Off' to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-certification-task**](#get-certification-task) | **Get** `/certification-tasks/{id}` | Certification Task by ID +[**get-identity-certification**](#get-identity-certification) | **Get** `/certifications/{id}` | Identity Certification by ID +[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **Get** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item +[**get-pending-certification-tasks**](#get-pending-certification-tasks) | **Get** `/certification-tasks` | List of Pending Certification Tasks +[**list-certification-reviewers**](#list-certification-reviewers) | **Get** `/certifications/{id}/reviewers` | List of Reviewers for certification +[**list-identity-access-review-items**](#list-identity-access-review-items) | **Get** `/certifications/{id}/access-review-items` | List of Access Review Items +[**list-identity-certifications**](#list-identity-certifications) | **Get** `/certifications` | List Identity Campaign Certifications +[**make-identity-decision**](#make-identity-decision) | **Post** `/certifications/{id}/decide` | Decide on a Certification Item +[**reassign-identity-certifications**](#reassign-identity-certifications) | **Post** `/certifications/{id}/reassign` | Reassign Identities or Items +[**sign-off-identity-certification**](#sign-off-identity-certification) | **Post** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions +[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **Post** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously + + +## get-certification-task +Certification Task by ID +This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-certification-task) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The task ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCertificationTaskRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CertificationTask**](../models/certification-task) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `63b32151-26c0-42f4-9299-8898dc1c9daa` // string | The task ID # string | The task ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.GetCertificationTask(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.GetCertificationTask(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetCertificationTask``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCertificationTask`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetCertificationTask`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-certification +Identity Certification by ID +This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-certification) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The certification id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityCertificationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification id # string | The certification id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.GetIdentityCertification(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.GetIdentityCertification(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertification`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertification`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-certification-item-permissions +Permissions for Entitlement Certification Item +This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-certification-item-permissions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**certificationId** | **string** | The certification ID | +**itemId** | **string** | The certification item ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityCertificationItemPermissionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]PermissionDto**](../models/permission-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + certificationId := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification ID + itemId := `2c91808671bcbab40171bd945d961227` // string | The certification item ID # string | The certification item ID + filters := `target eq "SYS.OBJAUTH2"` // 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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.GetIdentityCertificationItemPermissions(context.Background(), certificationId, itemId).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.GetIdentityCertificationItemPermissions(context.Background(), certificationId, itemId).Filters(filters).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertificationItemPermissions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertificationItemPermissions`: []PermissionDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertificationItemPermissions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-pending-certification-tasks +List of Pending Certification Tasks +This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-pending-certification-tasks) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPendingCertificationTasksRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **reviewerIdentity** | **string** | The ID of reviewer identity. *me* indicates the current user. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **targetId**: *eq, in* **type**: *eq, in* | + +### Return type + +[**[]CertificationTask**](../models/certification-task) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reviewerIdentity := `Ada.1de82e55078344` // string | The ID of reviewer identity. *me* indicates the current user. (optional) # string | The ID of reviewer identity. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `type eq "ADMIN_REASSIGN"` // 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* **targetId**: *eq, in* **type**: *eq, in* (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* **targetId**: *eq, in* **type**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.GetPendingCertificationTasks(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.GetPendingCertificationTasks(context.Background()).ReviewerIdentity(reviewerIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetPendingCertificationTasks``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPendingCertificationTasks`: []CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetPendingCertificationTasks`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-certification-reviewers +List of Reviewers for certification +This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-certification-reviewers) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCertificationReviewersRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **email**: *eq, sw* | + **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, email** | + +### Return type + +[**[]IdentityReferenceWithNameAndEmail**](../models/identity-reference-with-name-and-email) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Bob"` // 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* **email**: *eq, sw* (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* **email**: *eq, sw* (optional) + sorters := `name` // 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, email** (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, email** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.ListCertificationReviewers(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.ListCertificationReviewers(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListCertificationReviewers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCertificationReviewers`: []IdentityReferenceWithNameAndEmail + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListCertificationReviewers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-access-review-items +List of Access Review Items +This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-identity-access-review-items) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityAccessReviewItemsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* | + **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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** | + **entitlements** | **string** | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. | + **accessProfiles** | **string** | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. | + **roles** | **string** | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. | + +### Return type + +[**[]AccessReviewItem**](../models/access-review-item) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters := `access.name,-accessProfile.sourceName` // 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) + entitlements := `identityEntitlement` // string | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) + accessProfiles := `accessProfile1` // string | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) + roles := `userRole` // string | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.ListIdentityAccessReviewItems(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.ListIdentityAccessReviewItems(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Entitlements(entitlements).AccessProfiles(accessProfiles).Roles(roles).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListIdentityAccessReviewItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityAccessReviewItems`: []AccessReviewItem + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListIdentityAccessReviewItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-certifications +List Identity Campaign Certifications +Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-identity-certifications) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityCertificationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **reviewerIdentity** | **string** | Reviewer's identity. *me* indicates the current user. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *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, due, signed** | + +### Return type + +[**[]IdentityCertificationDto**](../models/identity-certification-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reviewerIdentity := `me` // string | Reviewer's identity. *me* indicates the current user. (optional) # string | Reviewer's identity. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) + sorters := `name,due` // 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, due, signed** (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, due, signed** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.ListIdentityCertifications(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.ListIdentityCertifications(context.Background()).ReviewerIdentity(reviewerIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListIdentityCertifications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityCertifications`: []IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListIdentityCertifications`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## make-identity-decision +Decide on a Certification Item +The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/make-identity-decision) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the identity campaign certification on which to make decisions | + +### Other Parameters + +Other parameters are passed through a pointer to a apiMakeIdentityDecisionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **reviewDecision** | [**[]ReviewDecision**](../models/review-decision) | A non-empty array of decisions to be made. | + +### Return type + +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the identity campaign certification on which to make decisions # string | The ID of the identity campaign certification on which to make decisions + reviewdecision := []byte(`[{id=ef38f94347e94562b5bb8424a56396b5, decision=APPROVE, bulk=true, comments=This user still needs access to this source.}, {id=ef38f94347e94562b5bb8424a56397d8, decision=APPROVE, bulk=true, comments=This user still needs access to this source too.}]`) // []ReviewDecision | A non-empty array of decisions to be made. + + + var reviewDecision v2025.[]ReviewDecision + if err := json.Unmarshal(reviewdecision, &reviewDecision); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.MakeIdentityDecision(context.Background(), id).ReviewDecision(reviewDecision).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.MakeIdentityDecision(context.Background(), id).ReviewDecision(reviewDecision).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.MakeIdentityDecision``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `MakeIdentityDecision`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.MakeIdentityDecision`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reassign-identity-certifications +Reassign Identities or Items +This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/reassign-identity-certifications) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiReassignIdentityCertificationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **reviewReassign** | [**ReviewReassign**](../models/review-reassign) | | + +### Return type + +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + reviewreassign := []byte(`{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + }`) // ReviewReassign | + + + var reviewReassign v2025.ReviewReassign + if err := json.Unmarshal(reviewreassign, &reviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.ReassignIdentityCertifications(context.Background(), id).ReviewReassign(reviewReassign).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.ReassignIdentityCertifications(context.Background(), id).ReviewReassign(reviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ReassignIdentityCertifications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ReassignIdentityCertifications`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ReassignIdentityCertifications`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## sign-off-identity-certification +Finalize Identity Certification Decisions +This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/sign-off-identity-certification) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSignOffIdentityCertificationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.SignOffIdentityCertification(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.SignOffIdentityCertification(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.SignOffIdentityCertification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SignOffIdentityCertification`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.SignOffIdentityCertification`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-reassign-certs-async +Reassign Certifications Asynchronously +This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another +reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the +reassignment is complete. + +Reviewers for this certification can also call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/submit-reassign-certs-async) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitReassignCertsAsyncRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **reviewReassign** | [**ReviewReassign**](../models/review-reassign) | | + +### Return type + +[**CertificationTask**](../models/certification-task) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + reviewreassign := []byte(`{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + }`) // ReviewReassign | + + + var reviewReassign v2025.ReviewReassign + if err := json.Unmarshal(reviewreassign, &reviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.SubmitReassignCertsAsync(context.Background(), id).ReviewReassign(reviewReassign).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.SubmitReassignCertsAsync(context.Background(), id).ReviewReassign(reviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.SubmitReassignCertsAsync``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitReassignCertsAsync`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.SubmitReassignCertsAsync`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ConfigurationHubAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ConfigurationHubAPI.md new file mode 100644 index 000000000..5aeffd97a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ConfigurationHubAPI.md @@ -0,0 +1,1465 @@ +--- +id: v2025-configuration-hub +title: ConfigurationHub +pagination_label: ConfigurationHub +sidebar_label: ConfigurationHub +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigurationHub', 'V2025ConfigurationHub'] +slug: /tools/sdk/go/v2025/methods/configuration-hub +tags: ['SDK', 'Software Development Kit', 'ConfigurationHub', 'V2025ConfigurationHub'] +--- + +# ConfigurationHubAPI + Use this API to implement and customize configuration settings management. With this functionality, you can access the Configuration Hub actions and build your own automated pipeline for Identity Security Cloud configuration change delivery and deployment. + +Common usages for Configuration Hub includes: + +- Upload configuration file - Configuration files can be managed and deployed using Configuration Hub by uploading a JSON file which contains configuration data. +- Manage object mapping - Create rules to map and substitute attributes when migrating configurations. +- Manage backups for configuration settings +- Manage configuration drafts +- Upload configurations and manage object mappings between tenants. + +Refer to [Using the SailPoint Configuration Hub](https://documentation.sailpoint.com/saas/help/confighub/config_hub.html) for more information about Configuration Hub. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-deploy**](#create-deploy) | **Post** `/configuration-hub/deploys` | Create a Deploy +[**create-object-mapping**](#create-object-mapping) | **Post** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping +[**create-object-mappings**](#create-object-mappings) | **Post** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings +[**create-scheduled-action**](#create-scheduled-action) | **Post** `/configuration-hub/scheduled-actions` | Create Scheduled Action +[**create-uploaded-configuration**](#create-uploaded-configuration) | **Post** `/configuration-hub/backups/uploads` | Upload a Configuration +[**delete-backup**](#delete-backup) | **Delete** `/configuration-hub/backups/{id}` | Delete a Backup +[**delete-draft**](#delete-draft) | **Delete** `/configuration-hub/drafts/{id}` | Delete a draft +[**delete-object-mapping**](#delete-object-mapping) | **Delete** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping +[**delete-scheduled-action**](#delete-scheduled-action) | **Delete** `/configuration-hub/scheduled-actions/{id}` | Delete Scheduled Action +[**delete-uploaded-configuration**](#delete-uploaded-configuration) | **Delete** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration +[**get-deploy**](#get-deploy) | **Get** `/configuration-hub/deploys/{id}` | Get a Deploy +[**get-object-mappings**](#get-object-mappings) | **Get** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings +[**get-uploaded-configuration**](#get-uploaded-configuration) | **Get** `/configuration-hub/backups/uploads/{id}` | Get an Uploaded Configuration +[**list-backups**](#list-backups) | **Get** `/configuration-hub/backups` | List Backups +[**list-deploys**](#list-deploys) | **Get** `/configuration-hub/deploys` | List Deploys +[**list-drafts**](#list-drafts) | **Get** `/configuration-hub/drafts` | List Drafts +[**list-scheduled-actions**](#list-scheduled-actions) | **Get** `/configuration-hub/scheduled-actions` | List Scheduled Actions +[**list-uploaded-configurations**](#list-uploaded-configurations) | **Get** `/configuration-hub/backups/uploads` | List Uploaded Configurations +[**update-object-mappings**](#update-object-mappings) | **Post** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings +[**update-scheduled-action**](#update-scheduled-action) | **Patch** `/configuration-hub/scheduled-actions/{id}` | Update Scheduled Action + + +## create-deploy +Create a Deploy +This API performs a deploy based on an existing daft. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-deploy) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateDeployRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **deployRequest** | [**DeployRequest**](../models/deploy-request) | The deploy request body. | + +### Return type + +[**DeployResponse**](../models/deploy-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + deployrequest := []byte(`{ + "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" + }`) // DeployRequest | The deploy request body. + + + var deployRequest v2025.DeployRequest + if err := json.Unmarshal(deployrequest, &deployRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateDeploy(context.Background()).DeployRequest(deployRequest).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateDeploy(context.Background()).DeployRequest(deployRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateDeploy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDeploy`: DeployResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateDeploy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-object-mapping +Creates an object mapping +This creates an object mapping between current org and source org. +Source org should be "default" when creating an object mapping that is not to be associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-object-mapping) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceOrg** | **string** | The name of the source org. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateObjectMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **objectMappingRequest** | [**ObjectMappingRequest**](../models/object-mapping-request) | The object mapping request body. | + +### Return type + +[**ObjectMappingResponse**](../models/object-mapping-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingrequest := []byte(`{ + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }`) // ObjectMappingRequest | The object mapping request body. + + + var objectMappingRequest v2025.ObjectMappingRequest + if err := json.Unmarshal(objectmappingrequest, &objectMappingRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateObjectMapping(context.Background(), sourceOrg).ObjectMappingRequest(objectMappingRequest).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateObjectMapping(context.Background(), sourceOrg).ObjectMappingRequest(objectMappingRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateObjectMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateObjectMapping`: ObjectMappingResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateObjectMapping`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-object-mappings +Bulk creates object mappings +This creates a set of object mappings (Max 25) between current org and source org. +Source org should be "default" when creating object mappings that are not to be associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-object-mappings) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceOrg** | **string** | The name of the source org. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateObjectMappingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **objectMappingBulkCreateRequest** | [**ObjectMappingBulkCreateRequest**](../models/object-mapping-bulk-create-request) | The bulk create object mapping request body. | + +### Return type + +[**ObjectMappingBulkCreateResponse**](../models/object-mapping-bulk-create-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingbulkcreaterequest := []byte(`{ + "newObjectsMappings" : [ { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }, { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } ] + }`) // ObjectMappingBulkCreateRequest | The bulk create object mapping request body. + + + var objectMappingBulkCreateRequest v2025.ObjectMappingBulkCreateRequest + if err := json.Unmarshal(objectmappingbulkcreaterequest, &objectMappingBulkCreateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkCreateRequest(objectMappingBulkCreateRequest).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkCreateRequest(objectMappingBulkCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateObjectMappings`: ObjectMappingBulkCreateResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateObjectMappings`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-scheduled-action +Create Scheduled Action +This API creates a new scheduled action for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-scheduled-action) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateScheduledActionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scheduledActionPayload** | [**ScheduledActionPayload**](../models/scheduled-action-payload) | The scheduled action creation request body. | + +### Return type + +[**ScheduledActionResponse**](../models/scheduled-action-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scheduledactionpayload := []byte(`{ + "cronString" : "0 0 * * * *", + "timeZoneId" : "America/Chicago", + "startTime" : "2024-08-16T14:16:58.389Z", + "jobType" : "BACKUP", + "content" : { + "sourceTenant" : "tenant-name", + "draftId" : "9012b87d-48ca-439a-868f-2160001da8c3", + "name" : "Daily Backup", + "backupOptions" : { + "includeTypes" : [ "ROLE", "IDENTITY_PROFILE" ], + "objectOptions" : { + "SOURCE" : { + "includedNames" : [ "Source1", "Source2" ] + }, + "ROLE" : { + "includedNames" : [ "Admin Role", "User Role" ] + } + } + }, + "sourceBackupId" : "5678b87d-48ca-439a-868f-2160001da8c2" + } + }`) // ScheduledActionPayload | The scheduled action creation request body. + + + var scheduledActionPayload v2025.ScheduledActionPayload + if err := json.Unmarshal(scheduledactionpayload, &scheduledActionPayload); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateScheduledAction(context.Background()).ScheduledActionPayload(scheduledActionPayload).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateScheduledAction(context.Background()).ScheduledActionPayload(scheduledActionPayload).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateScheduledAction``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateScheduledAction`: ScheduledActionResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateScheduledAction`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-uploaded-configuration +Upload a Configuration +This API uploads a JSON configuration file into a tenant. + +Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. + +Refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects) for more information about supported objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-uploaded-configuration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateUploadedConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **data** | ***os.File** | JSON file containing the objects to be imported. | + **name** | **string** | Name that will be assigned to the uploaded configuration file. | + +### Return type + +[**BackupResponse**](../models/backup-response) + +### 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() { + data := BINARY_DATA_HERE // *os.File | JSON file containing the objects to be imported. # *os.File | JSON file containing the objects to be imported. + name := `name_example` // string | Name that will be assigned to the uploaded configuration file. # string | Name that will be assigned to the uploaded configuration file. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateUploadedConfiguration(context.Background()).Data(data).Name(name).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateUploadedConfiguration(context.Background()).Data(data).Name(name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateUploadedConfiguration`: BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateUploadedConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-backup +Delete a Backup +This API deletes an existing backup for the current tenant. + +On success, this endpoint will return an empty response. + +The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-backup) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the backup to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteBackupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `07659d7d-2cce-47c0-9e49-185787ee565a` // string | The id of the backup to delete. # string | The id of the backup to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ConfigurationHubAPI.DeleteBackup(context.Background(), id).Execute() + //r, err := apiClient.V2025.ConfigurationHubAPI.DeleteBackup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteBackup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-draft +Delete a draft +This API deletes an existing draft for the current tenant. + +On success, this endpoint will return an empty response. + +The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-draft) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the draft to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteDraftRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `07659d7d-2cce-47c0-9e49-185787ee565a` // string | The id of the draft to delete. # string | The id of the draft to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ConfigurationHubAPI.DeleteDraft(context.Background(), id).Execute() + //r, err := apiClient.V2025.ConfigurationHubAPI.DeleteDraft(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteDraft``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-object-mapping +Deletes an object mapping +This deletes an existing object mapping. +Source org should be "default" when deleting an object mapping that is not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-object-mapping) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceOrg** | **string** | The name of the source org. | +**objectMappingId** | **string** | The id of the object mapping to be deleted. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteObjectMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectMappingId := `3d6e0144-963f-4bd6-8d8d-d77b4e507ce4` // string | The id of the object mapping to be deleted. # string | The id of the object mapping to be deleted. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ConfigurationHubAPI.DeleteObjectMapping(context.Background(), sourceOrg, objectMappingId).Execute() + //r, err := apiClient.V2025.ConfigurationHubAPI.DeleteObjectMapping(context.Background(), sourceOrg, objectMappingId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteObjectMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-scheduled-action +Delete Scheduled Action +This API deletes an existing scheduled action. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-scheduled-action) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scheduledActionId** | **string** | The ID of the scheduled action. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteScheduledActionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scheduledActionId := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | The ID of the scheduled action. # string | The ID of the scheduled action. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ConfigurationHubAPI.DeleteScheduledAction(context.Background(), scheduledActionId).Execute() + //r, err := apiClient.V2025.ConfigurationHubAPI.DeleteScheduledAction(context.Background(), scheduledActionId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteScheduledAction``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-uploaded-configuration +Delete an Uploaded Configuration +This API deletes an uploaded configuration based on Id. + +On success, this endpoint will return an empty response. + +The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-uploaded-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the uploaded configuration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteUploadedConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `3d0fe04b-57df-4a46-a83b-8f04b0f9d10b` // string | The id of the uploaded configuration. # string | The id of the uploaded configuration. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ConfigurationHubAPI.DeleteUploadedConfiguration(context.Background(), id).Execute() + //r, err := apiClient.V2025.ConfigurationHubAPI.DeleteUploadedConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-deploy +Get a Deploy +This API gets an existing deploy for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-deploy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the deploy. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDeployRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**DeployResponse**](../models/deploy-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `3d0fe04b-57df-4a46-a83b-8f04b0f9d10b` // string | The id of the deploy. # string | The id of the deploy. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.GetDeploy(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.GetDeploy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.GetDeploy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDeploy`: DeployResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.GetDeploy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-object-mappings +Gets list of object mappings +This gets a list of existing object mappings between current org and source org. +Source org should be "default" when getting object mappings that are not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:read + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-object-mappings) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceOrg** | **string** | The name of the source org. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetObjectMappingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]ObjectMappingResponse**](../models/object-mapping-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.GetObjectMappings(context.Background(), sourceOrg).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.GetObjectMappings(context.Background(), sourceOrg).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.GetObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetObjectMappings`: []ObjectMappingResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.GetObjectMappings`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-uploaded-configuration +Get an Uploaded Configuration +This API gets an existing uploaded configuration for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-uploaded-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the uploaded configuration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetUploadedConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**BackupResponse**](../models/backup-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `3d0fe04b-57df-4a46-a83b-8f04b0f9d10b` // string | The id of the uploaded configuration. # string | The id of the uploaded configuration. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.GetUploadedConfiguration(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.GetUploadedConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.GetUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUploadedConfiguration`: BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.GetUploadedConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-backups +List Backups +This API gets a list of existing backups for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-backups) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListBackupsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **status**: *eq* | + +### Return type + +[**[]BackupResponse1**](../models/backup-response1) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `status eq "COMPLETE"` // 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: **status**: *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: **status**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListBackups(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListBackups(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListBackups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListBackups`: []BackupResponse1 + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListBackups`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-deploys +List Deploys +This API gets a list of deploys for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-deploys) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiListDeploysRequest struct via the builder pattern + + +### Return type + +[**ListDeploys200Response**](../models/list-deploys200-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListDeploys(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListDeploys(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListDeploys``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDeploys`: ListDeploys200Response + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListDeploys`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-drafts +List Drafts +This API gets a list of existing drafts for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-drafts) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListDraftsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **status**: *eq* **approvalStatus**: *eq* | + +### Return type + +[**[]DraftResponse**](../models/draft-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `status eq "COMPLETE"` // 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: **status**: *eq* **approvalStatus**: *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: **status**: *eq* **approvalStatus**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListDrafts(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListDrafts(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListDrafts``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDrafts`: []DraftResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListDrafts`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-scheduled-actions +List Scheduled Actions +This API gets a list of existing scheduled actions for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-scheduled-actions) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiListScheduledActionsRequest struct via the builder pattern + + +### Return type + +[**[]ScheduledActionResponse**](../models/scheduled-action-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListScheduledActions(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListScheduledActions(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListScheduledActions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListScheduledActions`: []ScheduledActionResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListScheduledActions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-uploaded-configurations +List Uploaded Configurations +This API gets a list of existing uploaded configurations for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-uploaded-configurations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListUploadedConfigurationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **status**: *eq* | + +### Return type + +[**[]BackupResponse**](../models/backup-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `status eq "COMPLETE"` // 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: **status**: *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: **status**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListUploadedConfigurations(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListUploadedConfigurations(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListUploadedConfigurations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListUploadedConfigurations`: []BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListUploadedConfigurations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-object-mappings +Bulk updates object mappings +This updates a set of object mappings, only enabled and targetValue fields can be updated. +Source org should be "default" when updating object mappings that are not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-object-mappings) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceOrg** | **string** | The name of the source org. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateObjectMappingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **objectMappingBulkPatchRequest** | [**ObjectMappingBulkPatchRequest**](../models/object-mapping-bulk-patch-request) | The object mapping request body. | + +### Return type + +[**ObjectMappingBulkPatchResponse**](../models/object-mapping-bulk-patch-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingbulkpatchrequest := []byte(`{ + "patches" : { + "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : true + } ], + "00bece34-f50d-4227-8878-76f620b5a971" : [ { + "op" : "replace", + "path" : "/targetValue", + "value" : "New Target Value" + } ] + } + }`) // ObjectMappingBulkPatchRequest | The object mapping request body. + + + var objectMappingBulkPatchRequest v2025.ObjectMappingBulkPatchRequest + if err := json.Unmarshal(objectmappingbulkpatchrequest, &objectMappingBulkPatchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.UpdateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkPatchRequest(objectMappingBulkPatchRequest).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.UpdateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkPatchRequest(objectMappingBulkPatchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.UpdateObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateObjectMappings`: ObjectMappingBulkPatchResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.UpdateObjectMappings`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-scheduled-action +Update Scheduled Action +This API updates an existing scheduled action using JSON Patch format. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-scheduled-action) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scheduledActionId** | **string** | The ID of the scheduled action. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateScheduledActionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatch** | [**JsonPatch**](../models/json-patch) | The JSON Patch document containing the changes to apply to the scheduled action. | + +### Return type + +[**ScheduledActionResponse**](../models/scheduled-action-response) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scheduledActionId := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | The ID of the scheduled action. # string | The ID of the scheduled action. + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | The JSON Patch document containing the changes to apply to the scheduled action. + + + var jsonPatch v2025.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.UpdateScheduledAction(context.Background(), scheduledActionId).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.UpdateScheduledAction(context.Background(), scheduledActionId).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.UpdateScheduledAction``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateScheduledAction`: ScheduledActionResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.UpdateScheduledAction`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorCustomizersAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorCustomizersAPI.md new file mode 100644 index 000000000..9682e2538 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorCustomizersAPI.md @@ -0,0 +1,428 @@ +--- +id: v2025-connector-customizers +title: ConnectorCustomizers +pagination_label: ConnectorCustomizers +sidebar_label: ConnectorCustomizers +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorCustomizers', 'V2025ConnectorCustomizers'] +slug: /tools/sdk/go/v2025/methods/connector-customizers +tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizers', 'V2025ConnectorCustomizers'] +--- + +# ConnectorCustomizersAPI + Saas Connectivity Customizers are cloud-based connector customizers. The customizers allow you to customize the out of the box connectors in a similar way to how you can use rules to customize VA (virtual appliance) based connectors. + +Use these APIs to implement connector customizers functionality. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-connector-customizer**](#create-connector-customizer) | **Post** `/connector-customizers` | Create Connector Customizer +[**create-connector-customizer-version**](#create-connector-customizer-version) | **Post** `/connector-customizers/{id}/versions` | Creates a connector customizer version +[**delete-connector-customizer**](#delete-connector-customizer) | **Delete** `/connector-customizers/{id}` | Delete Connector Customizer +[**get-connector-customizer**](#get-connector-customizer) | **Get** `/connector-customizers/{id}` | Get connector customizer +[**list-connector-customizers**](#list-connector-customizers) | **Get** `/connector-customizers` | List All Connector Customizers +[**put-connector-customizer**](#put-connector-customizer) | **Put** `/connector-customizers/{id}` | Update Connector Customizer + + +## create-connector-customizer +Create Connector Customizer +Create a connector customizer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-connector-customizer) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateConnectorCustomizerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **connectorCustomizerCreateRequest** | [**ConnectorCustomizerCreateRequest**](../models/connector-customizer-create-request) | Connector customizer to create. | + +### Return type + +[**ConnectorCustomizerCreateResponse**](../models/connector-customizer-create-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + connectorcustomizercreaterequest := []byte(`{ + "name" : "My Custom Connector" + }`) // ConnectorCustomizerCreateRequest | Connector customizer to create. + + + var connectorCustomizerCreateRequest v2025.ConnectorCustomizerCreateRequest + if err := json.Unmarshal(connectorcustomizercreaterequest, &connectorCustomizerCreateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.CreateConnectorCustomizer(context.Background()).ConnectorCustomizerCreateRequest(connectorCustomizerCreateRequest).Execute() + //resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.CreateConnectorCustomizer(context.Background()).ConnectorCustomizerCreateRequest(connectorCustomizerCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.CreateConnectorCustomizer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateConnectorCustomizer`: ConnectorCustomizerCreateResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.CreateConnectorCustomizer`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-connector-customizer-version +Creates a connector customizer version +Creates a new version for the customizer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-connector-customizer-version) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the connector customizer. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateConnectorCustomizerVersionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ConnectorCustomizerVersionCreateResponse**](../models/connector-customizer-version-create-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | The id of the connector customizer. # string | The id of the connector customizer. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.CreateConnectorCustomizerVersion(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.CreateConnectorCustomizerVersion(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.CreateConnectorCustomizerVersion``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateConnectorCustomizerVersion`: ConnectorCustomizerVersionCreateResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.CreateConnectorCustomizerVersion`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-connector-customizer +Delete Connector Customizer +Delete the connector customizer for the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-connector-customizer) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the connector customizer to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteConnectorCustomizerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | ID of the connector customizer to delete. # string | ID of the connector customizer to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ConnectorCustomizersAPI.DeleteConnectorCustomizer(context.Background(), id).Execute() + //r, err := apiClient.V2025.ConnectorCustomizersAPI.DeleteConnectorCustomizer(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.DeleteConnectorCustomizer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-connector-customizer +Get connector customizer +Gets connector customizer by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector-customizer) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the connector customizer to get. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorCustomizerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ConnectorCustomizersResponse**](../models/connector-customizers-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | ID of the connector customizer to get. # string | ID of the connector customizer to get. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.GetConnectorCustomizer(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.GetConnectorCustomizer(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.GetConnectorCustomizer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorCustomizer`: ConnectorCustomizersResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.GetConnectorCustomizer`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-connector-customizers +List All Connector Customizers +List all connector customizers. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-connector-customizers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListConnectorCustomizersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + +### Return type + +[**[]ConnectorCustomizersResponse**](../models/connector-customizers-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.ListConnectorCustomizers(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.ListConnectorCustomizers(context.Background()).Offset(offset).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.ListConnectorCustomizers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListConnectorCustomizers`: []ConnectorCustomizersResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.ListConnectorCustomizers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-connector-customizer +Update Connector Customizer +Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-connector-customizer) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the connector customizer to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutConnectorCustomizerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **connectorCustomizerUpdateRequest** | [**ConnectorCustomizerUpdateRequest**](../models/connector-customizer-update-request) | Connector rule with updated data. | + +### Return type + +[**ConnectorCustomizerUpdateResponse**](../models/connector-customizer-update-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | ID of the connector customizer to update. # string | ID of the connector customizer to update. + connectorcustomizerupdaterequest := []byte(`{ + "name" : "My Custom Connector" + }`) // ConnectorCustomizerUpdateRequest | Connector rule with updated data. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.PutConnectorCustomizer(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.PutConnectorCustomizer(context.Background(), id).ConnectorCustomizerUpdateRequest(connectorCustomizerUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.PutConnectorCustomizer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorCustomizer`: ConnectorCustomizerUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.PutConnectorCustomizer`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorRuleManagementAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorRuleManagementAPI.md new file mode 100644 index 000000000..695d7f47e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorRuleManagementAPI.md @@ -0,0 +1,486 @@ +--- +id: v2025-connector-rule-management +title: ConnectorRuleManagement +pagination_label: ConnectorRuleManagement +sidebar_label: ConnectorRuleManagement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleManagement', 'V2025ConnectorRuleManagement'] +slug: /tools/sdk/go/v2025/methods/connector-rule-management +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleManagement', 'V2025ConnectorRuleManagement'] +--- + +# ConnectorRuleManagementAPI + Use this API to implement connector rule management functionality. +With this functionality in place, administrators can implement connector-executed rules in a programmatic, scalable way. + +In Identity Security Cloud (ISC), [rules](https://developer.sailpoint.com/docs/extensibility/rules) serve as a flexible configuration framework you can leverage to perform complex or advanced configurations. +[Connector-executed rules](https://developer.sailpoint.com/docs/extensibility/rules/connector-rules) are rules that are executed in the ISC virtual appliance (VA), usually extensions of the [connector](https://documentation.sailpoint.com/connectors/isc/landingpages/help/landingpages/isc_landing.html) itself, the bridge between the data source and ISC. + +This API allows administrators to view existing connector-executed rules, make changes to them, delete them, and create new ones from the available types. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-connector-rule**](#create-connector-rule) | **Post** `/connector-rules` | Create Connector Rule +[**delete-connector-rule**](#delete-connector-rule) | **Delete** `/connector-rules/{id}` | Delete Connector Rule +[**get-connector-rule**](#get-connector-rule) | **Get** `/connector-rules/{id}` | Get Connector Rule +[**get-connector-rule-list**](#get-connector-rule-list) | **Get** `/connector-rules` | List Connector Rules +[**put-connector-rule**](#put-connector-rule) | **Put** `/connector-rules/{id}` | Update Connector Rule +[**test-connector-rule**](#test-connector-rule) | **Post** `/connector-rules/validate` | Validate Connector Rule + + +## create-connector-rule +Create Connector Rule +Create a connector rule from the available types. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-connector-rule) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateConnectorRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **connectorRuleCreateRequest** | [**ConnectorRuleCreateRequest**](../models/connector-rule-create-request) | Connector rule to create. | + +### Return type + +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + connectorrulecreaterequest := []byte(`{ + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "type" : "BuildMap" + }`) // ConnectorRuleCreateRequest | Connector rule to create. + + + var connectorRuleCreateRequest v2025.ConnectorRuleCreateRequest + if err := json.Unmarshal(connectorrulecreaterequest, &connectorRuleCreateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.CreateConnectorRule(context.Background()).ConnectorRuleCreateRequest(connectorRuleCreateRequest).Execute() + //resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.CreateConnectorRule(context.Background()).ConnectorRuleCreateRequest(connectorRuleCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.CreateConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.CreateConnectorRule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-connector-rule +Delete Connector Rule +Delete the connector rule for the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-connector-rule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the connector rule to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteConnectorRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to delete. # string | ID of the connector rule to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ConnectorRuleManagementAPI.DeleteConnectorRule(context.Background(), id).Execute() + //r, err := apiClient.V2025.ConnectorRuleManagementAPI.DeleteConnectorRule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.DeleteConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-connector-rule +Get Connector Rule +Get a connector rule by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector-rule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the connector rule to get. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to get. # string | ID of the connector rule to get. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.GetConnectorRule(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.GetConnectorRule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.GetConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.GetConnectorRule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-rule-list +List Connector Rules +List existing connector rules. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector-rule-list) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorRuleListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]ConnectorRuleResponse**](../models/connector-rule-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.GetConnectorRuleList(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.GetConnectorRuleList(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.GetConnectorRuleList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorRuleList`: []ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.GetConnectorRuleList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-connector-rule +Update Connector Rule +Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-connector-rule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the connector rule to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutConnectorRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **connectorRuleUpdateRequest** | [**ConnectorRuleUpdateRequest**](../models/connector-rule-update-request) | Connector rule with updated data. | + +### Return type + +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to update. # string | ID of the connector rule to update. + connectorruleupdaterequest := []byte(`{ + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", + "type" : "BuildMap" + }`) // ConnectorRuleUpdateRequest | Connector rule with updated data. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.PutConnectorRule(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.PutConnectorRule(context.Background(), id).ConnectorRuleUpdateRequest(connectorRuleUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.PutConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.PutConnectorRule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-connector-rule +Validate Connector Rule +Detect issues within the connector rule's code to fix and list them. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/test-connector-rule) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestConnectorRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sourceCode** | [**SourceCode**](../models/source-code) | Code to validate. | + +### Return type + +[**ConnectorRuleValidationResponse**](../models/connector-rule-validation-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourcecode := []byte(`{ + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }`) // SourceCode | Code to validate. + + + var sourceCode v2025.SourceCode + if err := json.Unmarshal(sourcecode, &sourceCode); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.TestConnectorRule(context.Background()).SourceCode(sourceCode).Execute() + //resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.TestConnectorRule(context.Background()).SourceCode(sourceCode).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.TestConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestConnectorRule`: ConnectorRuleValidationResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.TestConnectorRule`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorsAPI.md new file mode 100644 index 000000000..dcc0fd06c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ConnectorsAPI.md @@ -0,0 +1,948 @@ +--- +id: v2025-connectors +title: Connectors +pagination_label: Connectors +sidebar_label: Connectors +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Connectors', 'V2025Connectors'] +slug: /tools/sdk/go/v2025/methods/connectors +tags: ['SDK', 'Software Development Kit', 'Connectors', 'V2025Connectors'] +--- + +# ConnectorsAPI + Use this API to implement connector functionality. +With this functionality in place, administrators can view available connectors. + +Connectors are the bridges Identity Security Cloud uses to communicate with and aggregate data from sources. +For example, if it is necessary to set up a connection between Identity Security Cloud and the Active Directory source, a connector can bridge the two and enable Identity Security Cloud to synchronize data between the systems. +This ensures account entitlements and states are correct throughout the organization. + +In Identity Security Cloud, administrators can use the Connections drop-down menu and select Sources to view the available source connectors. + +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in Identity Security Cloud. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources. + +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about using connectors in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-custom-connector**](#create-custom-connector) | **Post** `/connectors` | Create Custom Connector +[**delete-custom-connector**](#delete-custom-connector) | **Delete** `/connectors/{scriptName}` | Delete Connector by Script Name +[**get-connector**](#get-connector) | **Get** `/connectors/{scriptName}` | Get Connector by Script Name +[**get-connector-correlation-config**](#get-connector-correlation-config) | **Get** `/connectors/{scriptName}/correlation-config` | Get Connector Correlation Configuration +[**get-connector-list**](#get-connector-list) | **Get** `/connectors` | Get Connector List +[**get-connector-source-config**](#get-connector-source-config) | **Get** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration +[**get-connector-source-template**](#get-connector-source-template) | **Get** `/connectors/{scriptName}/source-template` | Get Connector Source Template +[**get-connector-translations**](#get-connector-translations) | **Get** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations +[**put-connector-correlation-config**](#put-connector-correlation-config) | **Put** `/connectors/{scriptName}/correlation-config` | Update Connector Correlation Configuration +[**put-connector-source-config**](#put-connector-source-config) | **Put** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration +[**put-connector-source-template**](#put-connector-source-template) | **Put** `/connectors/{scriptName}/source-template` | Update Connector Source Template +[**put-connector-translations**](#put-connector-translations) | **Put** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations +[**update-connector**](#update-connector) | **Patch** `/connectors/{scriptName}` | Update Connector by Script Name + + +## create-custom-connector +Create Custom Connector +Create custom connector. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-custom-connector) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCustomConnectorRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **v3CreateConnectorDto** | [**V3CreateConnectorDto**](../models/v3-create-connector-dto) | | + +### Return type + +[**V3ConnectorDto**](../models/v3-connector-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + v3createconnectordto := []byte(`{ + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + }`) // V3CreateConnectorDto | + + + var v3CreateConnectorDto v2025.V3CreateConnectorDto + if err := json.Unmarshal(v3createconnectordto, &v3CreateConnectorDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.CreateCustomConnector(context.Background()).V3CreateConnectorDto(v3CreateConnectorDto).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.CreateCustomConnector(context.Background()).V3CreateConnectorDto(v3CreateConnectorDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.CreateCustomConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCustomConnector`: V3ConnectorDto + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.CreateCustomConnector`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-custom-connector +Delete Connector by Script Name +Delete a custom connector that using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-custom-connector) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCustomConnectorRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ConnectorsAPI.DeleteCustomConnector(context.Background(), scriptName).Execute() + //r, err := apiClient.V2025.ConnectorsAPI.DeleteCustomConnector(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.DeleteCustomConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-connector +Get Connector by Script Name +Fetches a connector that using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **locale** | **string** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | + +### Return type + +[**ConnectorDetail**](../models/connector-detail) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnector(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnector(context.Background(), scriptName).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnector`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnector`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-correlation-config +Get Connector Correlation Configuration +Fetches a connector's correlation config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector-correlation-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorCorrelationConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorCorrelationConfig(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorCorrelationConfig(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorCorrelationConfig`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorCorrelationConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-list +Get Connector List +Fetches list of connectors that have 'RELEASED' status using filtering and pagination. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector-list) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **locale** | **string** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | + +### Return type + +[**[]V3ConnectorDto**](../models/v3-connector-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `directConnect eq "true"` // 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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorList(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorList(context.Background()).Filters(filters).Limit(limit).Offset(offset).Count(count).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorList`: []V3ConnectorDto + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-source-config +Get Connector Source Configuration +Fetches a connector's source config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector-source-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorSourceConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorSourceConfig(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorSourceConfig(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorSourceConfig`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorSourceConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-source-template +Get Connector Source Template +Fetches a connector's source template using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector-source-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorSourceTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorSourceTemplate(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorSourceTemplate(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorSourceTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorSourceTemplate`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorSourceTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-translations +Get Connector Translations +Fetches a connector's translations using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-connector-translations) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. | +**locale** | **string** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorTranslationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorTranslations(context.Background(), scriptName, locale).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorTranslations(context.Background(), scriptName, locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorTranslations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorTranslations`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorTranslations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-connector-correlation-config +Update Connector Correlation Configuration +Update a connector's correlation config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-connector-correlation-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutConnectorCorrelationConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | connector correlation config xml file | + +### Return type + +[**UpdateDetail**](../models/update-detail) + +### 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() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + file := BINARY_DATA_HERE // *os.File | connector correlation config xml file # *os.File | connector correlation config xml file + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.PutConnectorCorrelationConfig(context.Background(), scriptName).File(file).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.PutConnectorCorrelationConfig(context.Background(), scriptName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorCorrelationConfig`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorCorrelationConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-connector-source-config +Update Connector Source Configuration +Update a connector's source config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-connector-source-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutConnectorSourceConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | connector source config xml file | + +### Return type + +[**UpdateDetail**](../models/update-detail) + +### 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() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + file := BINARY_DATA_HERE // *os.File | connector source config xml file # *os.File | connector source config xml file + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.PutConnectorSourceConfig(context.Background(), scriptName).File(file).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.PutConnectorSourceConfig(context.Background(), scriptName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorSourceConfig`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorSourceConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-connector-source-template +Update Connector Source Template +Update a connector's source template using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-connector-source-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutConnectorSourceTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | connector source template xml file | + +### Return type + +[**UpdateDetail**](../models/update-detail) + +### 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() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + file := BINARY_DATA_HERE // *os.File | connector source template xml file # *os.File | connector source template xml file + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.PutConnectorSourceTemplate(context.Background(), scriptName).File(file).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.PutConnectorSourceTemplate(context.Background(), scriptName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorSourceTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorSourceTemplate`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorSourceTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-connector-translations +Update Connector Translations +Update a connector's translations using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-connector-translations) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. | +**locale** | **string** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutConnectorTranslationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**UpdateDetail**](../models/update-detail) + +### 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() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.PutConnectorTranslations(context.Background(), scriptName, locale).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.PutConnectorTranslations(context.Background(), scriptName, locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorTranslations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorTranslations`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorTranslations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-connector +Update Connector by Script Name +This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: + + +* connectorMetadata + +* applicationXml + +* correlationConfigXml + +* sourceConfigXml + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-connector) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateConnectorRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of connector detail update operations | + +### Return type + +[**ConnectorDetail**](../models/connector-detail) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | A list of connector detail update operations + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.UpdateConnector(context.Background(), scriptName).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.UpdateConnector(context.Background(), scriptName).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.UpdateConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateConnector`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.UpdateConnector`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/CustomFormsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/CustomFormsAPI.md new file mode 100644 index 000000000..6dfdad4fe --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/CustomFormsAPI.md @@ -0,0 +1,1381 @@ +--- +id: v2025-custom-forms +title: CustomForms +pagination_label: CustomForms +sidebar_label: CustomForms +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CustomForms', 'V2025CustomForms'] +slug: /tools/sdk/go/v2025/methods/custom-forms +tags: ['SDK', 'Software Development Kit', 'CustomForms', 'V2025CustomForms'] +--- + +# CustomFormsAPI + Use this API to build and manage custom forms. +With this functionality in place, administrators can create and view form definitions and form instances. + +Forms are composed of sections and fields. Sections split the form into logical groups of fields and fields are the data collection points within the form. Configure conditions to modify elements of the form as the responder provides input. Create form inputs to pass information from a calling feature, like a workflow, to your form. + +Forms can be used within workflows as an action or as a trigger. The Form Action allows you to assign a form as a step in a running workflow, suspending the workflow until the form is submitted or times out, and the workflow resumes. The Form Submitted Trigger initiates a workflow when a form is submitted. The trigger can be configured to initiate on submission of a full form, a form element with any value, or a form element with a particular value. + +Refer to [Forms](https://documentation.sailpoint.com/saas/help/forms/index.html) for more information about using forms in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-form-definition**](#create-form-definition) | **Post** `/form-definitions` | Creates a form definition. +[**create-form-definition-dynamic-schema**](#create-form-definition-dynamic-schema) | **Post** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically. +[**create-form-definition-file-request**](#create-form-definition-file-request) | **Post** `/form-definitions/{formDefinitionID}/upload` | Upload new form definition file. +[**create-form-instance**](#create-form-instance) | **Post** `/form-instances` | Creates a form instance. +[**delete-form-definition**](#delete-form-definition) | **Delete** `/form-definitions/{formDefinitionID}` | Deletes a form definition. +[**export-form-definitions-by-tenant**](#export-form-definitions-by-tenant) | **Get** `/form-definitions/export` | List form definitions by tenant. +[**get-file-from-s3**](#get-file-from-s3) | **Get** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileId. +[**get-form-definition-by-key**](#get-form-definition-by-key) | **Get** `/form-definitions/{formDefinitionID}` | Return a form definition. +[**get-form-instance-by-key**](#get-form-instance-by-key) | **Get** `/form-instances/{formInstanceID}` | Returns a form instance. +[**get-form-instance-file**](#get-form-instance-file) | **Get** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileId. +[**import-form-definitions**](#import-form-definitions) | **Post** `/form-definitions/import` | Import form definitions from export. +[**patch-form-definition**](#patch-form-definition) | **Patch** `/form-definitions/{formDefinitionID}` | Patch a form definition. +[**patch-form-instance**](#patch-form-instance) | **Patch** `/form-instances/{formInstanceID}` | Patch a form instance. +[**search-form-definitions-by-tenant**](#search-form-definitions-by-tenant) | **Get** `/form-definitions` | Export form definitions by tenant. +[**search-form-element-data-by-element-id**](#search-form-element-data-by-element-id) | **Get** `/form-instances/{formInstanceID}/data-source/{formElementID}` | Retrieves dynamic data by element. +[**search-form-instances-by-tenant**](#search-form-instances-by-tenant) | **Get** `/form-instances` | List form instances by tenant. +[**search-pre-defined-select-options**](#search-pre-defined-select-options) | **Get** `/form-definitions/predefined-select-options` | List predefined select options. +[**show-preview-data-source**](#show-preview-data-source) | **Post** `/form-definitions/{formDefinitionID}/data-source` | Preview form definition data source. + + +## create-form-definition +Creates a form definition. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-form-definition) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateFormDefinitionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | Body is the request payload to create form definition request | + +### Return type + +[**FormDefinitionResponse**](../models/form-definition-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + body := []byte(`{ + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + }`) // CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.CreateFormDefinition(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.CreateFormDefinition(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinition`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinition`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-form-definition-dynamic-schema +Generate JSON Schema dynamically. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-form-definition-dynamic-schema) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateFormDefinitionDynamicSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**FormDefinitionDynamicSchemaRequest**](../models/form-definition-dynamic-schema-request) | Body is the request payload to create a form definition dynamic schema | + +### Return type + +[**FormDefinitionDynamicSchemaResponse**](../models/form-definition-dynamic-schema-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + body := []byte(`{ + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 + }`) // FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.CreateFormDefinitionDynamicSchema(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.CreateFormDefinitionDynamicSchema(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinitionDynamicSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinitionDynamicSchema`: FormDefinitionDynamicSchemaResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinitionDynamicSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-form-definition-file-request +Upload new form definition file. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-form-definition-file-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | FormDefinitionID String specifying FormDefinitionID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateFormDefinitionFileRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | File specifying the multipart | + +### Return type + +[**FormDefinitionFileUploadResponse**](../models/form-definition-file-upload-response) + +### 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() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | FormDefinitionID String specifying FormDefinitionID # string | FormDefinitionID String specifying FormDefinitionID + file := BINARY_DATA_HERE // *os.File | File specifying the multipart # *os.File | File specifying the multipart + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.CreateFormDefinitionFileRequest(context.Background(), formDefinitionID).File(file).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.CreateFormDefinitionFileRequest(context.Background(), formDefinitionID).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinitionFileRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinitionFileRequest`: FormDefinitionFileUploadResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinitionFileRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-form-instance +Creates a form instance. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-form-instance) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateFormInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateFormInstanceRequest**](../models/create-form-instance-request) | Body is the request payload to create a form instance | + +### Return type + +[**FormInstanceResponse**](../models/form-instance-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + body := []byte(`{ + "formInput" : { + "input1" : "Sales" + }, + "standAloneForm" : false, + "createdBy" : { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "WORKFLOW_EXECUTION" + }, + "recipients" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + } ], + "expire" : "2023-08-12T20:14:57.74486Z", + "formDefinitionId" : "00000000-0000-0000-0000-000000000000", + "state" : "ASSIGNED", + "ttl" : 1571827560 + }`) // CreateFormInstanceRequest | Body is the request payload to create a form instance (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.CreateFormInstance(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.CreateFormInstance(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormInstance`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormInstance`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-form-definition +Deletes a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-form-definition) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | Form definition ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteFormDefinitionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.DeleteFormDefinition(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.DeleteFormDefinition(context.Background(), formDefinitionID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.DeleteFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteFormDefinition`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.DeleteFormDefinition`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## export-form-definitions-by-tenant +List form definitions by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/export-form-definitions-by-tenant) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportFormDefinitionsByTenantRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int64** | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. | [default to 0] + **limit** | **int64** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [default to 250] + **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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* | + **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, description, created, modified** | [default to "name"] + +### Return type + +[**[]ExportFormDefinitionsByTenant200ResponseInner**](../models/export-form-definitions-by-tenant200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + offset := 0 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `name sw "my form"` // 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + sorters := `name` // 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, description, created, modified** (optional) (default to "name") # 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, description, created, modified** (optional) (default to "name") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.ExportFormDefinitionsByTenant(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.ExportFormDefinitionsByTenant(context.Background()).Offset(offset).Limit(limit).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ExportFormDefinitionsByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportFormDefinitionsByTenant`: []ExportFormDefinitionsByTenant200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ExportFormDefinitionsByTenant`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-file-from-s3 +Download definition file by fileId. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-file-from-s3) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | FormDefinitionID Form definition ID | +**fileID** | **string** | FileID String specifying the hashed name of the uploaded file we are retrieving. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetFileFromS3Request struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, image/jpeg, image/png, application/octet-stream + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | FormDefinitionID Form definition ID # string | FormDefinitionID Form definition ID + fileID := `00000031N0J7R2B57M8YG73J7M.png` // string | FileID String specifying the hashed name of the uploaded file we are retrieving. # string | FileID String specifying the hashed name of the uploaded file we are retrieving. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.GetFileFromS3(context.Background(), formDefinitionID, fileID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.GetFileFromS3(context.Background(), formDefinitionID, fileID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFileFromS3``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFileFromS3`: *os.File + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFileFromS3`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-form-definition-by-key +Return a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-form-definition-by-key) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | Form definition ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetFormDefinitionByKeyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**FormDefinitionResponse**](../models/form-definition-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.GetFormDefinitionByKey(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.GetFormDefinitionByKey(context.Background(), formDefinitionID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormDefinitionByKey``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormDefinitionByKey`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormDefinitionByKey`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-form-instance-by-key +Returns a form instance. +Parameter `{formInstanceID}` should match a form instance ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-form-instance-by-key) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formInstanceID** | **string** | Form instance ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetFormInstanceByKeyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**FormInstanceResponse**](../models/form-instance-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.GetFormInstanceByKey(context.Background(), formInstanceID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.GetFormInstanceByKey(context.Background(), formInstanceID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormInstanceByKey``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormInstanceByKey`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormInstanceByKey`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-form-instance-file +Download instance file by fileId. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-form-instance-file) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formInstanceID** | **string** | FormInstanceID Form instance ID | +**fileID** | **string** | FileID String specifying the hashed name of the uploaded file we are retrieving. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetFormInstanceFileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, image/jpeg, image/png, application/octet-stream + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | FormInstanceID Form instance ID # string | FormInstanceID Form instance ID + fileID := `00000031N0J7R2B57M8YG73J7M.png` // string | FileID String specifying the hashed name of the uploaded file we are retrieving. # string | FileID String specifying the hashed name of the uploaded file we are retrieving. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.GetFormInstanceFile(context.Background(), formInstanceID, fileID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.GetFormInstanceFile(context.Background(), formInstanceID, fileID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormInstanceFile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormInstanceFile`: *os.File + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormInstanceFile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-form-definitions +Import form definitions from export. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/import-form-definitions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportFormDefinitionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**[]ImportFormDefinitionsRequestInner**](../models/import-form-definitions-request-inner) | Body is the request payload to import form definitions | + +### Return type + +[**ImportFormDefinitions202Response**](../models/import-form-definitions202-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + body := []byte(`[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]`) // []ImportFormDefinitionsRequestInner | Body is the request payload to import form definitions (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.ImportFormDefinitions(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.ImportFormDefinitions(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ImportFormDefinitions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportFormDefinitions`: ImportFormDefinitions202Response + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ImportFormDefinitions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-form-definition +Patch a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-form-definition) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | Form definition ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchFormDefinitionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | **[]map[string]map[string]interface{}** | Body is the request payload to patch a form definition, check: https://jsonpatch.com | + +### Return type + +[**FormDefinitionResponse**](../models/form-definition-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + body := []byte(`[{op=replace, path=/description, value=test-description}]`) // []map[string]map[string]interface{} | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.PatchFormDefinition(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.PatchFormDefinition(context.Background(), formDefinitionID).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.PatchFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchFormDefinition`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.PatchFormDefinition`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-form-instance +Patch a form instance. +Parameter `{formInstanceID}` should match a form instance ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-form-instance) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formInstanceID** | **string** | Form instance ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchFormInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | **[]map[string]map[string]interface{}** | Body is the request payload to patch a form instance, check: https://jsonpatch.com | + +### Return type + +[**FormInstanceResponse**](../models/form-instance-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + body := []byte(`[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]`) // []map[string]map[string]interface{} | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.PatchFormInstance(context.Background(), formInstanceID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.PatchFormInstance(context.Background(), formInstanceID).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.PatchFormInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchFormInstance`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.PatchFormInstance`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-form-definitions-by-tenant +Export form definitions by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/search-form-definitions-by-tenant) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchFormDefinitionsByTenantRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int64** | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. | [default to 0] + **limit** | **int64** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [default to 250] + **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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* | + **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, description, created, modified** | [default to "name"] + +### Return type + +[**ListFormDefinitionsByTenantResponse**](../models/list-form-definitions-by-tenant-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + offset := 250 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `name sw "my form"` // 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + sorters := `name` // 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, description, created, modified** (optional) (default to "name") # 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, description, created, modified** (optional) (default to "name") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.SearchFormDefinitionsByTenant(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.SearchFormDefinitionsByTenant(context.Background()).Offset(offset).Limit(limit).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormDefinitionsByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormDefinitionsByTenant`: ListFormDefinitionsByTenantResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormDefinitionsByTenant`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-form-element-data-by-element-id +Retrieves dynamic data by element. +Parameter `{formInstanceID}` should match a form instance ID. +Parameter `{formElementID}` should match a form element ID at the data source configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/search-form-element-data-by-element-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formInstanceID** | **string** | Form instance ID | +**formElementID** | **string** | Form element ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchFormElementDataByElementIDRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **limit** | **int64** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [default to 250] + **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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` | + **query** | **string** | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. | + +### Return type + +[**ListFormElementDataByElementIDResponse**](../models/list-form-element-data-by-element-id-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + formElementID := `1` // string | Form element ID # string | Form element ID + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `value eq "ID01"` // 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) + query := `support` // string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.SearchFormElementDataByElementID(context.Background(), formInstanceID, formElementID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.SearchFormElementDataByElementID(context.Background(), formInstanceID, formElementID).Limit(limit).Filters(filters).Query(query).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormElementDataByElementID``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormElementDataByElementID`: ListFormElementDataByElementIDResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormElementDataByElementID`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-form-instances-by-tenant +List form instances by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/search-form-instances-by-tenant) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchFormInstancesByTenantRequest struct via the builder pattern + + +### Return type + +[**[]ListFormInstancesByTenantResponse**](../models/list-form-instances-by-tenant-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.SearchFormInstancesByTenant(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.SearchFormInstancesByTenant(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormInstancesByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormInstancesByTenant`: []ListFormInstancesByTenantResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormInstancesByTenant`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-pre-defined-select-options +List predefined select options. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/search-pre-defined-select-options) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchPreDefinedSelectOptionsRequest struct via the builder pattern + + +### Return type + +[**ListPredefinedSelectOptionsResponse**](../models/list-predefined-select-options-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.SearchPreDefinedSelectOptions(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.SearchPreDefinedSelectOptions(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchPreDefinedSelectOptions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchPreDefinedSelectOptions`: ListPredefinedSelectOptionsResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchPreDefinedSelectOptions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## show-preview-data-source +Preview form definition data source. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/show-preview-data-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**formDefinitionID** | **string** | Form definition ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiShowPreviewDataSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int64** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [default to 10] + **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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` | + **query** | **string** | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. | + **formElementPreviewRequest** | [**FormElementPreviewRequest**](../models/form-element-preview-request) | Body is the request payload to create a form definition dynamic schema | + +### Return type + +[**PreviewDataSourceResponse**](../models/preview-data-source-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + limit := 10 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) + filters := `value eq "ID01"` // 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) + query := `ac` // string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) + formelementpreviewrequest := []byte(`{ + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } + }`) // FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.ShowPreviewDataSource(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.ShowPreviewDataSource(context.Background(), formDefinitionID).Limit(limit).Filters(filters).Query(query).FormElementPreviewRequest(formElementPreviewRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ShowPreviewDataSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ShowPreviewDataSource`: PreviewDataSourceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ShowPreviewDataSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/CustomPasswordInstructionsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/CustomPasswordInstructionsAPI.md new file mode 100644 index 000000000..1cad99286 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/CustomPasswordInstructionsAPI.md @@ -0,0 +1,278 @@ +--- +id: v2025-custom-password-instructions +title: CustomPasswordInstructions +pagination_label: CustomPasswordInstructions +sidebar_label: CustomPasswordInstructions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CustomPasswordInstructions', 'V2025CustomPasswordInstructions'] +slug: /tools/sdk/go/v2025/methods/custom-password-instructions +tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstructions', 'V2025CustomPasswordInstructions'] +--- + +# CustomPasswordInstructionsAPI + Use this API to implement custom password instruction functionality. +With this functionality in place, administrators can create custom password instructions to help users reset their passwords, change them, unlock their accounts, or recover their usernames. +This allows administrators to emphasize password policies or provide organization-specific instructions. + +Administrators must first use [Update Password Org Config](https://developer.sailpoint.com/docs/api/v2025/put-password-org-config/) to set `customInstructionsEnabled` to `true`. + +Once they have enabled custom instructions, they can use [Create Custom Password Instructions](https://developer.sailpoint.com/docs/api/v2025/create-custom-password-instructions/) to create custom page content for the specific pageId they select. + +For example, an administrator can use the pageId forget-username:user-email to set the custom text for the case when users forget their usernames and must enter their emails. + +Refer to [Creating Custom Instruction Text](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html#creating-custom-instruction-text) for more information about creating custom password instructions. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-custom-password-instructions**](#create-custom-password-instructions) | **Post** `/custom-password-instructions` | Create Custom Password Instructions +[**delete-custom-password-instructions**](#delete-custom-password-instructions) | **Delete** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID +[**get-custom-password-instructions**](#get-custom-password-instructions) | **Get** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID + + +## create-custom-password-instructions +:::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 Custom Password Instructions +This API creates the custom password instructions for the specified page ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-custom-password-instructions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCustomPasswordInstructionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **customPasswordInstruction** | [**CustomPasswordInstruction**](../models/custom-password-instruction) | | + +### Return type + +[**CustomPasswordInstruction**](../models/custom-password-instruction) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + custompasswordinstruction := []byte(`{ + "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", + "pageId" : "change-password:enter-password", + "locale" : "en" + }`) // CustomPasswordInstruction | + + + var customPasswordInstruction v2025.CustomPasswordInstruction + if err := json.Unmarshal(custompasswordinstruction, &customPasswordInstruction); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions(context.Background()).XSailPointExperimental(xSailPointExperimental).CustomPasswordInstruction(customPasswordInstruction).Execute() + //resp, r, err := apiClient.V2025.CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions(context.Background()).XSailPointExperimental(xSailPointExperimental).CustomPasswordInstruction(customPasswordInstruction).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCustomPasswordInstructions`: CustomPasswordInstruction + fmt.Fprintf(os.Stdout, "Response from `CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-custom-password-instructions +:::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 Custom Password Instructions by page ID +This API delete the custom password instructions for the specified page ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-custom-password-instructions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**pageId** | **string** | The page ID of custom password instructions to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCustomPasswordInstructionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **locale** | **string** | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + pageId := `mfa:select` // string | The page ID of custom password instructions to delete. # string | The page ID of custom password instructions to delete. + 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") + locale := `locale_example` // string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions(context.Background(), pageId).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions(context.Background(), pageId).XSailPointExperimental(xSailPointExperimental).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-custom-password-instructions +:::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 Custom Password Instructions by Page ID +This API returns the custom password instructions for the specified page ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-custom-password-instructions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**pageId** | **string** | The page ID of custom password instructions to query. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCustomPasswordInstructionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **locale** | **string** | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". | + +### Return type + +[**CustomPasswordInstruction**](../models/custom-password-instruction) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + pageId := `mfa:select` // string | The page ID of custom password instructions to query. # string | The page ID of custom password instructions to query. + 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") + locale := `locale_example` // string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomPasswordInstructionsAPI.GetCustomPasswordInstructions(context.Background(), pageId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.CustomPasswordInstructionsAPI.GetCustomPasswordInstructions(context.Background(), pageId).XSailPointExperimental(xSailPointExperimental).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.GetCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCustomPasswordInstructions`: CustomPasswordInstruction + fmt.Fprintf(os.Stdout, "Response from `CustomPasswordInstructionsAPI.GetCustomPasswordInstructions`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/DataSegmentationAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/DataSegmentationAPI.md new file mode 100644 index 000000000..28118e567 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/DataSegmentationAPI.md @@ -0,0 +1,669 @@ +--- +id: v2025-data-segmentation +title: DataSegmentation +pagination_label: DataSegmentation +sidebar_label: DataSegmentation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DataSegmentation', 'V2025DataSegmentation'] +slug: /tools/sdk/go/v2025/methods/data-segmentation +tags: ['SDK', 'Software Development Kit', 'DataSegmentation', 'V2025DataSegmentation'] +--- + +# DataSegmentationAPI + This service is responsible for creating segments that will determine how access is delegated to identities +withing the organization. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-data-segment**](#create-data-segment) | **Post** `/data-segments` | Create Segment +[**delete-data-segment**](#delete-data-segment) | **Delete** `/data-segments/{segmentId}` | Delete Segment by ID +[**get-data-segment**](#get-data-segment) | **Get** `/data-segments/{segmentId}` | Get Segment by ID +[**get-data-segment-identity-membership**](#get-data-segment-identity-membership) | **Get** `/data-segments/membership/{identityId}` | Get SegmentMembership by Identity ID +[**get-data-segmentation-enabled-for-user**](#get-data-segmentation-enabled-for-user) | **Get** `/data-segments/user-enabled/{identityId}` | Is Segmentation enabled by Identity +[**list-data-segments**](#list-data-segments) | **Get** `/data-segments` | Get Segments +[**patch-data-segment**](#patch-data-segment) | **Patch** `/data-segments/{segmentId}` | Update Segment +[**publish-data-segment**](#publish-data-segment) | **Post** `/data-segments/{segmentId}` | Publish segment by ID + + +## create-data-segment +Create Segment +This API creates a segment. +>**Note:** Segment definitions may take time to propagate to all identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-data-segment) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateDataSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **dataSegment** | [**DataSegment**](../models/data-segment) | | + +### Return type + +[**DataSegment**](../models/data-segment) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + datasegment := []byte(``) // DataSegment | + + + var dataSegment v2025.DataSegment + if err := json.Unmarshal(datasegment, &dataSegment); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DataSegmentationAPI.CreateDataSegment(context.Background()).DataSegment(dataSegment).Execute() + //resp, r, err := apiClient.V2025.DataSegmentationAPI.CreateDataSegment(context.Background()).DataSegment(dataSegment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.CreateDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDataSegment`: DataSegment + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.CreateDataSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-data-segment +:::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 Segment by ID +This API deletes the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-data-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteDataSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **published** | **bool** | This determines which version of the segment to delete | [default to false] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The segment ID to delete. # string | The segment ID to delete. + 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") + published := false // bool | This determines which version of the segment to delete (optional) (default to false) # bool | This determines which version of the segment to delete (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.DataSegmentationAPI.DeleteDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.DataSegmentationAPI.DeleteDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Published(published).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.DeleteDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-data-segment +:::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 Segment by ID +This API returns the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-data-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDataSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**DataSegment**](../models/data-segment) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The segment ID to retrieve. # string | The segment ID to retrieve. + 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.DataSegmentationAPI.GetDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.DataSegmentationAPI.GetDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.GetDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDataSegment`: DataSegment + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.GetDataSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-data-segment-identity-membership +:::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 SegmentMembership by Identity ID +This API returns the segment membership specified by the given identity ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-data-segment-identity-membership) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | The identity ID to retrieve the segments they are in. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDataSegmentIdentityMembershipRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The identity ID to retrieve the segments they are in. # string | The identity ID to retrieve the segments they are in. + 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.DataSegmentationAPI.GetDataSegmentIdentityMembership(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.DataSegmentationAPI.GetDataSegmentIdentityMembership(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.GetDataSegmentIdentityMembership``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDataSegmentIdentityMembership`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.GetDataSegmentIdentityMembership`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-data-segmentation-enabled-for-user +:::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 + ``` +::: +Is Segmentation enabled by Identity +This API returns whether or not segmentation is enabled for the identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-data-segmentation-enabled-for-user) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | The identity ID to retrieve if segmentation is enabled for the identity. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDataSegmentationEnabledForUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +**bool** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The identity ID to retrieve if segmentation is enabled for the identity. # string | The identity ID to retrieve if segmentation is enabled for the identity. + 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.DataSegmentationAPI.GetDataSegmentationEnabledForUser(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.DataSegmentationAPI.GetDataSegmentationEnabledForUser(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.GetDataSegmentationEnabledForUser``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDataSegmentationEnabledForUser`: bool + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.GetDataSegmentationEnabledForUser`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-data-segments +:::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 Segments +This API returns the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-data-segments) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListDataSegmentsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **enabled** | **bool** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [default to true] + **unique** | **bool** | This returns only one record if set to true and that would be the published record if exists. | [default to false] + **published** | **bool** | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published | [default to true] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, sw* **name**: *eq, in, sw* | + +### Return type + +[**[]DataSegment**](../models/data-segment) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + enabled := true // bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to true) # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to true) + unique := false // bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to false) # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to false) + published := true // bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to true) # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to true) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq ""` // 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, sw* **name**: *eq, in, sw* (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, sw* **name**: *eq, in, sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DataSegmentationAPI.ListDataSegments(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.DataSegmentationAPI.ListDataSegments(context.Background()).XSailPointExperimental(xSailPointExperimental).Enabled(enabled).Unique(unique).Published(published).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.ListDataSegments``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDataSegments`: []DataSegment + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.ListDataSegments`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-data-segment +:::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 Segment +Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-data-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to modify. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchDataSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **requestBody** | **[]map[string]interface{}** | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled | + +### Return type + +[**DataSegment**](../models/data-segment) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The segment ID to modify. # string | The segment ID to modify. + 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") + requestbody := []byte(`[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]`) // []map[string]interface{} | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DataSegmentationAPI.PatchDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2025.DataSegmentationAPI.PatchDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.PatchDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchDataSegment`: DataSegment + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.PatchDataSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## publish-data-segment +:::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 + ``` +::: +Publish segment by ID +This will publish the segment so that it starts applying the segmentation to the desired users if enabled + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/publish-data-segment) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPublishDataSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **requestBody** | **[]string** | A list of segment ids that you wish to publish | + **publishAll** | **bool** | This flag decides whether you want to publish all unpublished or a list of specific segment ids | [default to true] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + requestbody := []byte(``) // []string | A list of segment ids that you wish to publish + publishAll := true // bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to true) # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to true) + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.DataSegmentationAPI.PublishDataSegment(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //r, err := apiClient.V2025.DataSegmentationAPI.PublishDataSegment(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).PublishAll(publishAll).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.PublishDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/DimensionsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/DimensionsAPI.md new file mode 100644 index 000000000..e879b70e8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/DimensionsAPI.md @@ -0,0 +1,732 @@ +--- +id: v2025-dimensions +title: Dimensions +pagination_label: Dimensions +sidebar_label: Dimensions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Dimensions', 'V2025Dimensions'] +slug: /tools/sdk/go/v2025/methods/dimensions +tags: ['SDK', 'Software Development Kit', 'Dimensions', 'V2025Dimensions'] +--- + +# DimensionsAPI + Use this API to implement and customize dynamic role functionality. With this functionality in place, administrators can create dimensions and configure them for use throughout Identity Security Cloud. Identity Security Cloud can use established criteria to automatically assign the dimensions to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. Entitlements represent the most granular level of access in Identity Security Cloud. +Access profiles represent the next level and often group entitlements. Dimension represent access selectively based on the evaluation of contextual information that is available or provided. Each Dimension include context attributes and access selection expressions which map criteria to access right assignments. Each dimension can contain up to 5 context attributes. Dynamic Access Roles represent the broadest level of access and often group access profiles ,entitlements and dimensions.Each Dynamic Access Role may contain one or more Dimensions. +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-dimension**](#create-dimension) | **Post** `/roles/{roleId}/dimensions` | Create a Dimension +[**delete-bulk-dimensions**](#delete-bulk-dimensions) | **Post** `/roles/{roleId}/dimensions/bulk-delete` | Delete Dimension(s) +[**delete-dimension**](#delete-dimension) | **Delete** `/roles/{roleId}/dimensions/{dimensionId}` | Delete a Dimension +[**get-dimension**](#get-dimension) | **Get** `/roles/{roleId}/dimensions/{dimensionId}` | Get a Dimension under Role. +[**get-dimension-entitlements**](#get-dimension-entitlements) | **Get** `/roles/{roleId}/dimensions/{dimensionId}/entitlements` | List Dimension's Entitlements +[**list-dimension-access-profiles**](#list-dimension-access-profiles) | **Get** `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` | List Dimension's Access Profiles +[**list-dimensions**](#list-dimensions) | **Get** `/roles/{roleId}/dimensions` | List Dimensions +[**patch-dimension**](#patch-dimension) | **Patch** `/roles/{roleId}/dimensions/{dimensionId}` | Patch a specified Dimension + + +## create-dimension +Create a Dimension +This API creates a dimension. +You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. +Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. +The maximum supported length for the description field is 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-dimension) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**roleId** | **string** | Parent Role Id of the dimension. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateDimensionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **dimension** | [**Dimension**](../models/dimension) | | + +### Return type + +[**Dimension**](../models/dimension) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimension := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "name" : "Dimension 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "id" : "2c918086749d78830174a1a40e121518", + "membership" : { + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, + "type" : "STANDARD" + }, + "parentId" : "2c918086749d78830174a1a40e121518" + }`) // Dimension | + + + var dimension v2025.Dimension + if err := json.Unmarshal(dimension, &dimension); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DimensionsAPI.CreateDimension(context.Background(), roleId).Dimension(dimension).Execute() + //resp, r, err := apiClient.V2025.DimensionsAPI.CreateDimension(context.Background(), roleId).Dimension(dimension).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.CreateDimension``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDimension`: Dimension + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.CreateDimension`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-bulk-dimensions +Delete Dimension(s) +This endpoint initiates a bulk deletion of one or more dimensions. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 roles per request. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-bulk-dimensions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**roleId** | **string** | Parent Role Id of the dimensions. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteBulkDimensionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **dimensionBulkDeleteRequest** | [**DimensionBulkDeleteRequest**](../models/dimension-bulk-delete-request) | | + +### Return type + +[**TaskResultDto**](../models/task-result-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimensions. # string | Parent Role Id of the dimensions. + dimensionbulkdeleterequest := []byte(`{ + "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + }`) // DimensionBulkDeleteRequest | + + + var dimensionBulkDeleteRequest v2025.DimensionBulkDeleteRequest + if err := json.Unmarshal(dimensionbulkdeleterequest, &dimensionBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DimensionsAPI.DeleteBulkDimensions(context.Background(), roleId).DimensionBulkDeleteRequest(dimensionBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V2025.DimensionsAPI.DeleteBulkDimensions(context.Background(), roleId).DimensionBulkDeleteRequest(dimensionBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.DeleteBulkDimensions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteBulkDimensions`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.DeleteBulkDimensions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-dimension +Delete a Dimension +This API deletes a Dimension by its ID. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-dimension) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**roleId** | **string** | Parent Role Id of the dimension. | +**dimensionId** | **string** | Id of the Dimension | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteDimensionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.DimensionsAPI.DeleteDimension(context.Background(), roleId, dimensionId).Execute() + //r, err := apiClient.V2025.DimensionsAPI.DeleteDimension(context.Background(), roleId, dimensionId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.DeleteDimension``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-dimension +Get a Dimension under Role. +This API returns a Dimension by its ID. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-dimension) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**roleId** | **string** | Parent Role Id of the dimension. | +**dimensionId** | **string** | Id of the Dimension | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDimensionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Dimension**](../models/dimension) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DimensionsAPI.GetDimension(context.Background(), roleId, dimensionId).Execute() + //resp, r, err := apiClient.V2025.DimensionsAPI.GetDimension(context.Background(), roleId, dimensionId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.GetDimension``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDimension`: Dimension + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.GetDimension`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-dimension-entitlements +List Dimension's Entitlements +This API lists the Entitlements associated with a given dimension. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-dimension-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**roleId** | **string** | Parent Role Id of the dimension. | +**dimensionId** | **string** | Id of the Dimension | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDimensionEntitlementsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* | + **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, attribute, value, created, modified** | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DimensionsAPI.GetDimensionEntitlements(context.Background(), roleId, dimensionId).Execute() + //resp, r, err := apiClient.V2025.DimensionsAPI.GetDimensionEntitlements(context.Background(), roleId, dimensionId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.GetDimensionEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDimensionEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.GetDimensionEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-dimension-access-profiles +List Dimension's Access Profiles +This API lists the Access Profiles associated with a given Dimension + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-dimension-access-profiles) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**roleId** | **string** | Parent Role Id of the dimension. | +**dimensionId** | **string** | Id of the Dimension | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListDimensionAccessProfilesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* | + **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, created, modified** | + +### Return type + +[**[]AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `source.id eq "2c91808982f979270182f99e386d00fa"` // 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DimensionsAPI.ListDimensionAccessProfiles(context.Background(), roleId, dimensionId).Execute() + //resp, r, err := apiClient.V2025.DimensionsAPI.ListDimensionAccessProfiles(context.Background(), roleId, dimensionId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.ListDimensionAccessProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDimensionAccessProfiles`: []AccessProfile + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.ListDimensionAccessProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-dimensions +List Dimensions +This API returns a list of dimensions under a specified role. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-dimensions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**roleId** | **string** | Parent Role Id of the dimension. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListDimensionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **forSubadmin** | **string** | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. | + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* | + **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, created, modified** | + +### Return type + +[**[]Dimension**](../models/dimension) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq '2c918086749d78830174a1a40e121518'` // 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DimensionsAPI.ListDimensions(context.Background(), roleId).Execute() + //resp, r, err := apiClient.V2025.DimensionsAPI.ListDimensions(context.Background(), roleId).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.ListDimensions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDimensions`: []Dimension + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.ListDimensions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-dimension +Patch a specified Dimension +This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +The maximum supported length for the description field is 2000 characters. +When you use this API to modify a dimension's membership identities, you can only modify up to a limit of 500 membership identities at a time. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-dimension) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**roleId** | **string** | Parent Role Id of the dimension. | +**dimensionId** | **string** | Id of the Dimension | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchDimensionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**Dimension**](../models/dimension) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Test Description}, {op=replace, path=/name, value=new name}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DimensionsAPI.PatchDimension(context.Background(), roleId, dimensionId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.DimensionsAPI.PatchDimension(context.Background(), roleId, dimensionId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.PatchDimension``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchDimension`: Dimension + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.PatchDimension`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/EntitlementsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/EntitlementsAPI.md new file mode 100644 index 000000000..b9f4e5fb0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/EntitlementsAPI.md @@ -0,0 +1,1127 @@ +--- +id: v2025-entitlements +title: Entitlements +pagination_label: Entitlements +sidebar_label: Entitlements +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Entitlements', 'V2025Entitlements'] +slug: /tools/sdk/go/v2025/methods/entitlements +tags: ['SDK', 'Software Development Kit', 'Entitlements', 'V2025Entitlements'] +--- + +# EntitlementsAPI + Use this API to implement and customize entitlement functionality. +With this functionality in place, administrators can view entitlements and configure them for use throughout Identity Security Cloud in certifications, access profiles, and roles. +Administrators in Identity Security Cloud can then grant users access to the entitlements or configure them so users themselves can request access to the entitlements whenever they need them. +With a good approval process, this entitlement functionality allows users to gain the specific access they need on sources quickly and securely. + +Entitlements represent access rights on sources. +Entitlements are the most granular form of access in Identity Security Cloud. +Entitlements are often grouped into access profiles, and access profiles themselves are often grouped into roles, the broadest form of access in Identity Security Cloud. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Administrators often use roles and access profiles within those roles to manage access so that users can gain access more quickly, but the hierarchy of access all starts with entitlements. + +Anywhere entitlements appear, you can select them to find more information about the following: + +- Cloud Access Details: These provide details about the cloud access entitlements on cloud-enabled sources. + +- Permissions: Permissions represent individual units of read/write/admin access to a system. + +- Relationships: These list each entitlement's parent and child relationships. + +- Type: This is the entitlement's type. Some sources support multiple types, each with a different attribute schema. + +Identity Security Cloud uses entitlements in many features, including the following: + +- Certifications: Entitlements can be revoked from an identity that no longer needs them. + +- Roles: Roles can group access profiles which themselves group entitlements. You can grant and revoke access on a broad level with roles. Role membership criteria can grant roles to identities based on whether they have certain entitlements or attributes. + +- Access Profiles: Access profiles group entitlements. +They are the most important units of access in Identity Security Cloud. +Identity Security Cloud uses them in provisioning, certifications, and access requests, and administrators can configure them to grant very broad or very granular access. + +You cannot delete entitlements directly from Identity Security Cloud. +Entitlements are deleted based on their inclusion in aggregations. + +Refer to [Deleting Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html#deleting-entitlements) more information about deleting entitlements. + +Refer to [Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html) for more information about entitlements. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-access-model-metadata-for-entitlement**](#create-access-model-metadata-for-entitlement) | **Post** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add metadata to an entitlement. +[**delete-access-model-metadata-from-entitlement**](#delete-access-model-metadata-from-entitlement) | **Delete** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove metadata from an entitlement. +[**get-entitlement**](#get-entitlement) | **Get** `/entitlements/{id}` | Get an entitlement +[**get-entitlement-request-config**](#get-entitlement-request-config) | **Get** `/entitlements/{id}/entitlement-request-config` | Get Entitlement Request Config +[**import-entitlements-by-source**](#import-entitlements-by-source) | **Post** `/entitlements/aggregate/sources/{id}` | Aggregate Entitlements +[**list-entitlement-children**](#list-entitlement-children) | **Get** `/entitlements/{id}/children` | List of entitlements children +[**list-entitlement-parents**](#list-entitlement-parents) | **Get** `/entitlements/{id}/parents` | List of entitlements parents +[**list-entitlements**](#list-entitlements) | **Get** `/entitlements` | Gets a list of entitlements. +[**patch-entitlement**](#patch-entitlement) | **Patch** `/entitlements/{id}` | Patch an entitlement +[**put-entitlement-request-config**](#put-entitlement-request-config) | **Put** `/entitlements/{id}/entitlement-request-config` | Replace Entitlement Request Config +[**reset-source-entitlements**](#reset-source-entitlements) | **Post** `/entitlements/reset/sources/{id}` | Reset Source Entitlements +[**update-entitlements-in-bulk**](#update-entitlements-in-bulk) | **Post** `/entitlements/bulk-update` | Bulk update an entitlement list + + +## create-access-model-metadata-for-entitlement +:::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 + ``` +::: +Add metadata to an entitlement. +Add single Access Model Metadata to an entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-model-metadata-for-entitlement) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The entitlement id. | +**attributeKey** | **string** | Technical name of the Attribute. | +**attributeValue** | **string** | Technical name of the Attribute Value. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAccessModelMetadataForEntitlementRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | The entitlement id. # string | The entitlement id. + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + 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.EntitlementsAPI.CreateAccessModelMetadataForEntitlement(context.Background(), id, attributeKey, attributeValue).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.CreateAccessModelMetadataForEntitlement(context.Background(), id, attributeKey, attributeValue).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.CreateAccessModelMetadataForEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessModelMetadataForEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.CreateAccessModelMetadataForEntitlement`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-access-model-metadata-from-entitlement +:::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 metadata from an entitlement. +Remove single Access Model Metadata from an entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-access-model-metadata-from-entitlement) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The entitlement id. | +**attributeKey** | **string** | Technical name of the Attribute. | +**attributeValue** | **string** | Technical name of the Attribute Value. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccessModelMetadataFromEntitlementRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | The entitlement id. # string | The entitlement id. + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + 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.V2025.EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement(context.Background(), id, attributeKey, attributeValue).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement(context.Background(), id, attributeKey, attributeValue).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-entitlement +:::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 an entitlement +This API returns an entitlement by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlement) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The entitlement ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808874ff91550175097daaec161c` // string | The entitlement ID # string | The entitlement 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.EntitlementsAPI.GetEntitlement(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.GetEntitlement(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.GetEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.GetEntitlement`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlement-request-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 + ``` +::: +Get Entitlement Request Config +This API returns the entitlement request config for a specified entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlement-request-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Entitlement Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementRequestConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**EntitlementRequestConfig**](../models/entitlement-request-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808874ff91550175097daaec161c` // string | Entitlement Id # string | Entitlement 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.EntitlementsAPI.GetEntitlementRequestConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.GetEntitlementRequestConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.GetEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementRequestConfig`: EntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.GetEntitlementRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-entitlements-by-source +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::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 + ``` +::: +Aggregate Entitlements +Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). + +If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. + +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`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/import-entitlements-by-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportEntitlementsBySourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **csvFile** | ***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() { + 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") + csvFile := 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.V2025.EntitlementsAPI.ImportEntitlementsBySource(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.ImportEntitlementsBySource(context.Background(), id).XSailPointExperimental(xSailPointExperimental).CsvFile(csvFile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ImportEntitlementsBySource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportEntitlementsBySource`: LoadEntitlementTask + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ImportEntitlementsBySource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-entitlement-children +:::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 of entitlements children +This API returns a list of all child entitlements of a given entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-entitlement-children) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Entitlement Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListEntitlementChildrenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **id, name, created, modified, type, attribute, value, source.id** | + **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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808874ff91550175097daaec161c` // string | Entitlement Id # string | Entitlement 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id** (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: **id, name, created, modified, type, attribute, value, source.id** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.EntitlementsAPI.ListEntitlementChildren(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.ListEntitlementChildren(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlementChildren``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlementChildren`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlementChildren`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-entitlement-parents +:::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 of entitlements parents +This API returns a list of all parent entitlements of a given entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-entitlement-parents) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Entitlement Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListEntitlementParentsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **id, name, created, modified, type, attribute, value, source.id** | + **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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | Entitlement Id # string | Entitlement 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id** (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: **id, name, created, modified, type, attribute, value, source.id** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.EntitlementsAPI.ListEntitlementParents(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.ListEntitlementParents(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlementParents``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlementParents`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlementParents`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-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 + ``` +::: +Gets a list of entitlements. +This API returns a list of entitlements. + +This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). + +Any authenticated token can call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListEntitlementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **accountId** | **string** | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). | + **segmentedForIdentity** | **string** | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. | + **forSegmentIds** | **string** | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). | + **includeUnsegmented** | **bool** | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. | [default to true] + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **id, name, created, modified, type, attribute, value, source.id, requestable** | + **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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + accountId := `ef38f94347e94562b5bb8424a56397d8` // string | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) # string | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) + segmentedForIdentity := `me` // string | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) # string | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) + forSegmentIds := `041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649` // string | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) # string | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) + includeUnsegmented := true // bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to true) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id, requestable** (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: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.EntitlementsAPI.ListEntitlements(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.ListEntitlements(context.Background()).XSailPointExperimental(xSailPointExperimental).AccountId(accountId).SegmentedForIdentity(segmentedForIdentity).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-entitlement +:::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 + ``` +::: +Patch an entitlement +This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** + +When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-entitlement) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the entitlement to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchEntitlementRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the entitlement to patch # string | ID of the entitlement to patch + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]`) // []JsonPatchOperation | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.EntitlementsAPI.PatchEntitlement(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.PatchEntitlement(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.PatchEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.PatchEntitlement`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-entitlement-request-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 + ``` +::: +Replace Entitlement Request Config +This API replaces the entitlement request config for a specified entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-entitlement-request-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Entitlement ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutEntitlementRequestConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **entitlementRequestConfig** | [**EntitlementRequestConfig**](../models/entitlement-request-config) | | + +### Return type + +[**EntitlementRequestConfig**](../models/entitlement-request-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | Entitlement ID # string | Entitlement 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") + entitlementrequestconfig := []byte(`{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }`) // EntitlementRequestConfig | + + + var entitlementRequestConfig v2025.EntitlementRequestConfig + if err := json.Unmarshal(entitlementrequestconfig, &entitlementRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.EntitlementsAPI.PutEntitlementRequestConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).EntitlementRequestConfig(entitlementRequestConfig).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.PutEntitlementRequestConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).EntitlementRequestConfig(entitlementRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.PutEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutEntitlementRequestConfig`: EntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.PutEntitlementRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reset-source-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 + ``` +::: +Reset Source Entitlements +Remove all entitlements from a specific source. +To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/reset-source-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of source for the entitlement reset | + +### Other Parameters + +Other parameters are passed through a pointer to a apiResetSourceEntitlementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of source for the entitlement reset # string | ID of source for the entitlement reset + 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.EntitlementsAPI.ResetSourceEntitlements(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.ResetSourceEntitlements(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ResetSourceEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ResetSourceEntitlements`: EntitlementSourceResetBaseReferenceDto + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ResetSourceEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-entitlements-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 update an entitlement list +"This API applies an update to every entitlement of the list.\n\nThe\ + \ number of entitlements to update is limited to 50 items maximum.\n\nThe JsonPatch\ + \ update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\ + \ allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"\ + value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\"\ + : boolean }**`" + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-entitlements-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateEntitlementsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **entitlementBulkUpdateRequest** | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + entitlementbulkupdaterequest := []byte(`{ + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] + }`) // EntitlementBulkUpdateRequest | + + + var entitlementBulkUpdateRequest v2025.EntitlementBulkUpdateRequest + if err := json.Unmarshal(entitlementbulkupdaterequest, &entitlementBulkUpdateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.EntitlementsAPI.UpdateEntitlementsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).EntitlementBulkUpdateRequest(entitlementBulkUpdateRequest).Execute() + //r, err := apiClient.V2025.EntitlementsAPI.UpdateEntitlementsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).EntitlementBulkUpdateRequest(entitlementBulkUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.UpdateEntitlementsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/GlobalTenantSecuritySettingsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/GlobalTenantSecuritySettingsAPI.md new file mode 100644 index 000000000..efcb02a82 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/GlobalTenantSecuritySettingsAPI.md @@ -0,0 +1,605 @@ +--- +id: v2025-global-tenant-security-settings +title: GlobalTenantSecuritySettings +pagination_label: GlobalTenantSecuritySettings +sidebar_label: GlobalTenantSecuritySettings +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GlobalTenantSecuritySettings', 'V2025GlobalTenantSecuritySettings'] +slug: /tools/sdk/go/v2025/methods/global-tenant-security-settings +tags: ['SDK', 'Software Development Kit', 'GlobalTenantSecuritySettings', 'V2025GlobalTenantSecuritySettings'] +--- + +# GlobalTenantSecuritySettingsAPI + Use this API to implement and customize global tenant security settings. +With this functionality in place, administrators can manage the global security settings that a tenant/org has. +This API can be used to configure the networks and Geographies allowed to access Identity Security Cloud URLs. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-auth-org-network-config**](#create-auth-org-network-config) | **Post** `/auth-org/network-config` | Create security network configuration. +[**get-auth-org-lockout-config**](#get-auth-org-lockout-config) | **Get** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. +[**get-auth-org-network-config**](#get-auth-org-network-config) | **Get** `/auth-org/network-config` | Get security network configuration. +[**get-auth-org-service-provider-config**](#get-auth-org-service-provider-config) | **Get** `/auth-org/service-provider-config` | Get Service Provider Configuration. +[**get-auth-org-session-config**](#get-auth-org-session-config) | **Get** `/auth-org/session-config` | Get Auth Org Session Configuration. +[**patch-auth-org-lockout-config**](#patch-auth-org-lockout-config) | **Patch** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration +[**patch-auth-org-network-config**](#patch-auth-org-network-config) | **Patch** `/auth-org/network-config` | Update security network configuration. +[**patch-auth-org-service-provider-config**](#patch-auth-org-service-provider-config) | **Patch** `/auth-org/service-provider-config` | Update Service Provider Configuration +[**patch-auth-org-session-config**](#patch-auth-org-session-config) | **Patch** `/auth-org/session-config` | Update Auth Org Session Configuration + + +## create-auth-org-network-config +Create security network configuration. +This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:manage' + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-auth-org-network-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAuthOrgNetworkConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **networkConfiguration** | [**NetworkConfiguration**](../models/network-configuration) | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. | + +### Return type + +[**NetworkConfiguration**](../models/network-configuration) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + networkconfiguration := []byte(`{ + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] + }`) // NetworkConfiguration | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + + + var networkConfiguration v2025.NetworkConfiguration + if err := json.Unmarshal(networkconfiguration, &networkConfiguration); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig(context.Background()).NetworkConfiguration(networkConfiguration).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig(context.Background()).NetworkConfiguration(networkConfiguration).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-auth-org-lockout-config +Get Auth Org Lockout Configuration. +This API returns the details of an org's lockout auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-lockout-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAuthOrgLockoutConfigRequest struct via the builder pattern + + +### Return type + +[**LockoutConfiguration**](../models/lockout-configuration) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgLockoutConfig`: LockoutConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-auth-org-network-config +Get security network configuration. +This API returns the details of an org's network auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-network-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAuthOrgNetworkConfigRequest struct via the builder pattern + + +### Return type + +[**NetworkConfiguration**](../models/network-configuration) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-auth-org-service-provider-config +Get Service Provider Configuration. +This API returns the details of an org's service provider auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-service-provider-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAuthOrgServiceProviderConfigRequest struct via the builder pattern + + +### Return type + +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgServiceProviderConfig`: ServiceProviderConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-auth-org-session-config +Get Auth Org Session Configuration. +This API returns the details of an org's session auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-session-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAuthOrgSessionConfigRequest struct via the builder pattern + + +### Return type + +[**SessionConfiguration**](../models/session-configuration) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgSessionConfig`: SessionConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-auth-org-lockout-config +Update Auth Org Lockout Configuration +This API updates an existing lockout configuration for an org using PATCH + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-lockout-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAuthOrgLockoutConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` | + +### Return type + +[**LockoutConfiguration**](../models/lockout-configuration) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}]`) // []JsonPatchOperation | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgLockoutConfig`: LockoutConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-auth-org-network-config +Update security network configuration. +This API updates an existing network configuration for an org using PATCH + Requires security scope of: 'sp:auth-org:manage' + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-network-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAuthOrgNetworkConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. | + +### Return type + +[**NetworkConfiguration**](../models/network-configuration) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/whitelisted, value=false,}, {op=add, path=/geolocation, value=[AF, HN, ES]}]`) // []JsonPatchOperation | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-auth-org-service-provider-config +Update Service Provider Configuration +This API updates an existing service provider configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-service-provider-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAuthOrgServiceProviderConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) | + +### Return type + +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}]`) // []JsonPatchOperation | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgServiceProviderConfig`: ServiceProviderConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-auth-org-session-config +Update Auth Org Session Configuration +This API updates an existing session configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-session-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAuthOrgSessionConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` | + +### Return type + +[**SessionConfiguration**](../models/session-configuration) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}]`) // []JsonPatchOperation | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgSessionConfig`: SessionConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/GovernanceGroupsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/GovernanceGroupsAPI.md new file mode 100644 index 000000000..9cd39fd98 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/GovernanceGroupsAPI.md @@ -0,0 +1,902 @@ +--- +id: v2025-governance-groups +title: GovernanceGroups +pagination_label: GovernanceGroups +sidebar_label: GovernanceGroups +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GovernanceGroups', 'V2025GovernanceGroups'] +slug: /tools/sdk/go/v2025/methods/governance-groups +tags: ['SDK', 'Software Development Kit', 'GovernanceGroups', 'V2025GovernanceGroups'] +--- + +# GovernanceGroupsAPI + Use this API to implement and customize Governance Group functionality. With this functionality in place, administrators can create Governance Groups and configure them for use throughout Identity Security Cloud. + +A governance group is a group of users that can make governance decisions about access. If your organization has the Access Request or Certifications service, you can configure governance groups to review access requests or certifications. A governance group can determine whether specific access is appropriate for a user. + +Refer to [Creating and Managing Governance Groups](https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html) for more information about how to build Governance Groups in the visual builder in the Identity Security Cloud UI. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-workgroup**](#create-workgroup) | **Post** `/workgroups` | Create a new Governance Group. +[**delete-workgroup**](#delete-workgroup) | **Delete** `/workgroups/{id}` | Delete a Governance Group +[**delete-workgroup-members**](#delete-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from Governance Group +[**delete-workgroups-in-bulk**](#delete-workgroups-in-bulk) | **Post** `/workgroups/bulk-delete` | Delete Governance Group(s) +[**get-workgroup**](#get-workgroup) | **Get** `/workgroups/{id}` | Get Governance Group by Id +[**list-connections**](#list-connections) | **Get** `/workgroups/{workgroupId}/connections` | List connections for Governance Group +[**list-workgroup-members**](#list-workgroup-members) | **Get** `/workgroups/{workgroupId}/members` | List Governance Group Members +[**list-workgroups**](#list-workgroups) | **Get** `/workgroups` | List Governance Groups +[**patch-workgroup**](#patch-workgroup) | **Patch** `/workgroups/{id}` | Patch a Governance Group +[**update-workgroup-members**](#update-workgroup-members) | **Post** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group + + +## create-workgroup +:::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 a new Governance Group. +This API creates a new Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-workgroup) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateWorkgroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **workgroupDto** | [**WorkgroupDto**](../models/workgroup-dto) | | + +### Return type + +[**WorkgroupDto**](../models/workgroup-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + workgroupdto := []byte(`{ + "owner" : { + "emailAddress" : "support@sailpoint.com", + "displayName" : "Support", + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "connectionCount" : 1641498673000, + "created" : "2022-01-06T19:51:13Z", + "memberCount" : 1641498673000, + "name" : "DB Access Governance Group", + "description" : "Description of the Governance Group", + "modified" : "2022-01-06T19:51:13Z", + "id" : "2c91808568c529c60168cca6f90c1313" + }`) // WorkgroupDto | + + + var workgroupDto v2025.WorkgroupDto + if err := json.Unmarshal(workgroupdto, &workgroupDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GovernanceGroupsAPI.CreateWorkgroup(context.Background()).XSailPointExperimental(xSailPointExperimental).WorkgroupDto(workgroupDto).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.CreateWorkgroup(context.Background()).XSailPointExperimental(xSailPointExperimental).WorkgroupDto(workgroupDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.CreateWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.CreateWorkgroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-workgroup +:::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 a Governance Group +This API deletes a Governance Group by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-workgroup) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Governance Group | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteWorkgroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + 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.V2025.GovernanceGroupsAPI.DeleteWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.GovernanceGroupsAPI.DeleteWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-workgroup-members +:::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 members from Governance Group +This API removes one or more members from a Governance Group. A +> **Following field of Identity is an optional field in the request.** + +> **name** + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-workgroup-members) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**workgroupId** | **string** | ID of the Governance Group. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteWorkgroupMembersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **identityPreviewResponseIdentity** | [**[]IdentityPreviewResponseIdentity**](../models/identity-preview-response-identity) | List of identities to be removed from a Governance Group members list. | + +### Return type + +[**[]WorkgroupMemberDeleteItem**](../models/workgroup-member-delete-item) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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") + identitypreviewresponseidentity := []byte(``) // []IdentityPreviewResponseIdentity | List of identities to be removed from a Governance Group members list. + + + var identityPreviewResponseIdentity v2025.[]IdentityPreviewResponseIdentity + if err := json.Unmarshal(identitypreviewresponseidentity, &identityPreviewResponseIdentity); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GovernanceGroupsAPI.DeleteWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).IdentityPreviewResponseIdentity(identityPreviewResponseIdentity).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.DeleteWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).IdentityPreviewResponseIdentity(identityPreviewResponseIdentity).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteWorkgroupMembers`: []WorkgroupMemberDeleteItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.DeleteWorkgroupMembers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-workgroups-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 + ``` +::: +Delete Governance Group(s) + +This API initiates a bulk deletion of one or more Governance Groups. + +> If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. + +> If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. + +> If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. + +> If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. + +> **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-workgroups-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteWorkgroupsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **workgroupBulkDeleteRequest** | [**WorkgroupBulkDeleteRequest**](../models/workgroup-bulk-delete-request) | | + +### Return type + +[**[]WorkgroupDeleteItem**](../models/workgroup-delete-item) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + workgroupbulkdeleterequest := []byte(`{ + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + }`) // WorkgroupBulkDeleteRequest | + + + var workgroupBulkDeleteRequest v2025.WorkgroupBulkDeleteRequest + if err := json.Unmarshal(workgroupbulkdeleterequest, &workgroupBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GovernanceGroupsAPI.DeleteWorkgroupsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).WorkgroupBulkDeleteRequest(workgroupBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.DeleteWorkgroupsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).WorkgroupBulkDeleteRequest(workgroupBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroupsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteWorkgroupsInBulk`: []WorkgroupDeleteItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.DeleteWorkgroupsInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-workgroup +:::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 Governance Group by Id +This API returns a Governance Groups by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-workgroup) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Governance Group | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkgroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**WorkgroupDto**](../models/workgroup-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + 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.GovernanceGroupsAPI.GetWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.GetWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.GetWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.GetWorkgroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-connections +:::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 connections for Governance Group +This API returns list of connections associated with a Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-connections) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**workgroupId** | **string** | ID of the Governance Group. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListConnectionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, created, modified** | + +### Return type + +[**[]WorkgroupConnectionDto**](../models/workgroup-connection-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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") + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GovernanceGroupsAPI.ListConnections(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.ListConnections(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListConnections``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListConnections`: []WorkgroupConnectionDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListConnections`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workgroup-members +:::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 Governance Group Members +This API returns list of members associated with a Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-workgroup-members) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**workgroupId** | **string** | ID of the Governance Group. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkgroupMembersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, created, modified** | + +### Return type + +[**[]ListWorkgroupMembers200ResponseInner**](../models/list-workgroup-members200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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") + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GovernanceGroupsAPI.ListWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.ListWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkgroupMembers`: []ListWorkgroupMembers200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListWorkgroupMembers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workgroups +:::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 Governance Groups +This API returns list of Governance Groups + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-workgroups) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkgroupsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* | + **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, created, modified, id, description** | + +### Return type + +[**[]WorkgroupDto**](../models/workgroup-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw "Test"` // 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, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (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, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) + sorters := `name,-modified` // 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, created, modified, id, description** (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, created, modified, id, description** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GovernanceGroupsAPI.ListWorkgroups(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.ListWorkgroups(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListWorkgroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkgroups`: []WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListWorkgroups`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-workgroup +:::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 + ``` +::: +Patch a Governance Group +This API updates an existing governance group by ID. The following fields and objects are patchable: +* name +* description +* owner + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-workgroup) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Governance Group | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchWorkgroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**WorkgroupDto**](../models/workgroup-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Governance Group new description.}]`) // []JsonPatchOperation | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GovernanceGroupsAPI.PatchWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.PatchWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.PatchWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.PatchWorkgroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-workgroup-members +:::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 + ``` +::: +Add members to Governance Group +This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. + +> **Following field of Identity is an optional field in the request.** + +> **name** + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-workgroup-members) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**workgroupId** | **string** | ID of the Governance Group. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateWorkgroupMembersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **identityPreviewResponseIdentity** | [**[]IdentityPreviewResponseIdentity**](../models/identity-preview-response-identity) | List of identities to be added to a Governance Group members list. | + +### Return type + +[**[]WorkgroupMemberAddItem**](../models/workgroup-member-add-item) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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") + identitypreviewresponseidentity := []byte(``) // []IdentityPreviewResponseIdentity | List of identities to be added to a Governance Group members list. + + + var identityPreviewResponseIdentity v2025.[]IdentityPreviewResponseIdentity + if err := json.Unmarshal(identitypreviewresponseidentity, &identityPreviewResponseIdentity); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GovernanceGroupsAPI.UpdateWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).IdentityPreviewResponseIdentity(identityPreviewResponseIdentity).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.UpdateWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).IdentityPreviewResponseIdentity(identityPreviewResponseIdentity).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.UpdateWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateWorkgroupMembers`: []WorkgroupMemberAddItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.UpdateWorkgroupMembers`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IAIAccessRequestRecommendationsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IAIAccessRequestRecommendationsAPI.md new file mode 100644 index 000000000..2d793c729 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IAIAccessRequestRecommendationsAPI.md @@ -0,0 +1,868 @@ +--- +id: v2025-iai-access-request-recommendations +title: IAIAccessRequestRecommendations +pagination_label: IAIAccessRequestRecommendations +sidebar_label: IAIAccessRequestRecommendations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAIAccessRequestRecommendations', 'V2025IAIAccessRequestRecommendations'] +slug: /tools/sdk/go/v2025/methods/iai-access-request-recommendations +tags: ['SDK', 'Software Development Kit', 'IAIAccessRequestRecommendations', 'V2025IAIAccessRequestRecommendations'] +--- + +# IAIAccessRequestRecommendationsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add-access-request-recommendations-ignored-item**](#add-access-request-recommendations-ignored-item) | **Post** `/ai-access-request-recommendations/ignored-items` | Ignore Access Request Recommendation +[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **Post** `/ai-access-request-recommendations/requested-items` | Accept Access Request Recommendation +[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **Post** `/ai-access-request-recommendations/viewed-items` | Mark Viewed Access Request Recommendations +[**add-access-request-recommendations-viewed-items**](#add-access-request-recommendations-viewed-items) | **Post** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk Mark Viewed Access Request Recommendations +[**get-access-request-recommendations**](#get-access-request-recommendations) | **Get** `/ai-access-request-recommendations` | Identity Access Request Recommendations +[**get-access-request-recommendations-config**](#get-access-request-recommendations-config) | **Get** `/ai-access-request-recommendations/config` | Get Access Request Recommendations config +[**get-access-request-recommendations-ignored-items**](#get-access-request-recommendations-ignored-items) | **Get** `/ai-access-request-recommendations/ignored-items` | List Ignored Access Request Recommendations +[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **Get** `/ai-access-request-recommendations/requested-items` | List Accepted Access Request Recommendations +[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **Get** `/ai-access-request-recommendations/viewed-items` | List Viewed Access Request Recommendations +[**set-access-request-recommendations-config**](#set-access-request-recommendations-config) | **Put** `/ai-access-request-recommendations/config` | Update Access Request Recommendations config + + +## add-access-request-recommendations-ignored-item +:::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 + ``` +::: +Ignore Access Request Recommendation +This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/add-access-request-recommendations-ignored-item) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddAccessRequestRecommendationsIgnoredItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **accessRequestRecommendationActionItemDto** | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | The recommended access item to ignore for an identity. | + +### Return type + +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity. + + + var accessRequestRecommendationActionItemDto v2025.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsIgnoredItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## add-access-request-recommendations-requested-item +:::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 + ``` +::: +Accept Access Request Recommendation +This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/add-access-request-recommendations-requested-item) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddAccessRequestRecommendationsRequestedItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **accessRequestRecommendationActionItemDto** | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | The recommended access item that was requested for an identity. | + +### Return type + +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity. + + + var accessRequestRecommendationActionItemDto v2025.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsRequestedItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## add-access-request-recommendations-viewed-item +:::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 + ``` +::: +Mark Viewed Access Request Recommendations +This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/add-access-request-recommendations-viewed-item) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddAccessRequestRecommendationsViewedItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **accessRequestRecommendationActionItemDto** | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | The recommended access that was viewed for an identity. | + +### Return type + +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity. + + + var accessRequestRecommendationActionItemDto v2025.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsViewedItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## add-access-request-recommendations-viewed-items +:::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 Mark Viewed Access Request Recommendations +This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/add-access-request-recommendations-viewed-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddAccessRequestRecommendationsViewedItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **accessRequestRecommendationActionItemDto** | [**[]AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | The recommended access items that were viewed for an identity. | + +### Return type + +[**[]AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + accessrequestrecommendationactionitemdto := []byte(``) // []AccessRequestRecommendationActionItemDto | The recommended access items that were viewed for an identity. + + + var accessRequestRecommendationActionItemDto v2025.[]AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsViewedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-recommendations +:::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 Access Request Recommendations +This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-request-recommendations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestRecommendationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **identityId** | **string** | Get access request recommendations for an identityId. *me* indicates the current user. | [default to "me"] + **limit** | **int32** | Max number of results to return. | [default to 15] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **includeTranslationMessages** | **bool** | If *true* it will populate a list of translation messages in the response. | [default to false] + **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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* | + **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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. | + +### Return type + +[**[]AccessRequestRecommendationItemDetail**](../models/access-request-recommendation-item-detail) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + identityId := `2c91808570313110017040b06f344ec9` // string | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") # string | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") + limit := 15 // int32 | Max number of results to return. (optional) (default to 15) # int32 | Max number of results to return. (optional) (default to 15) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + includeTranslationMessages := false // bool | If *true* it will populate a list of translation messages in the response. (optional) (default to false) # bool | If *true* it will populate a list of translation messages in the response. (optional) (default to false) + filters := `access.name co "admin"` // 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) + sorters := `access.name` // 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityId(identityId).Limit(limit).Offset(offset).Count(count).IncludeTranslationMessages(includeTranslationMessages).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendations`: []AccessRequestRecommendationItemDetail + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-recommendations-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 + ``` +::: +Get Access Request Recommendations config +This API returns the configurations for Access Request Recommender for the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-request-recommendations-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestRecommendationsConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsConfig`: AccessRequestRecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-recommendations-ignored-items +:::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 Ignored Access Request Recommendations +This API returns the list of ignored access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-request-recommendations-ignored-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestRecommendationsIgnoredItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* | + **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: **access.id, access.type, identityId, timestamp** | + +### Return type + +[**[]AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `identityId eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsIgnoredItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-recommendations-requested-items +:::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 Accepted Access Request Recommendations +This API returns a list of requested access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-request-recommendations-requested-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestRecommendationsRequestedItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* | + **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: **access.id, access.type, identityId, timestamp** | + +### Return type + +[**[]AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsRequestedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-recommendations-viewed-items +:::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 Viewed Access Request Recommendations +This API returns the list of viewed access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-access-request-recommendations-viewed-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestRecommendationsViewedItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* | + **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: **access.id, access.type, identityId, timestamp** | + +### Return type + +[**[]AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsViewedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-access-request-recommendations-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 Access Request Recommendations config +This API updates the configurations for Access Request Recommender for the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-access-request-recommendations-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetAccessRequestRecommendationsConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **accessRequestRecommendationConfigDto** | [**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) | The desired configurations for Access Request Recommender for the tenant. | + +### Return type + +[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + accessrequestrecommendationconfigdto := []byte(`{ + "scoreThreshold" : 0.5, + "startDateAttribute" : "startDate", + "restrictionAttribute" : "location", + "moverAttribute" : "isMover", + "joinerAttribute" : "isJoiner", + "useRestrictionAttribute" : true + }`) // AccessRequestRecommendationConfigDto | The desired configurations for Access Request Recommender for the tenant. + + + var accessRequestRecommendationConfigDto v2025.AccessRequestRecommendationConfigDto + if err := json.Unmarshal(accessrequestrecommendationconfigdto, &accessRequestRecommendationConfigDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.SetAccessRequestRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationConfigDto(accessRequestRecommendationConfigDto).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.SetAccessRequestRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationConfigDto(accessRequestRecommendationConfigDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.SetAccessRequestRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetAccessRequestRecommendationsConfig`: AccessRequestRecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.SetAccessRequestRecommendationsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IAICommonAccessAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IAICommonAccessAPI.md new file mode 100644 index 000000000..b0e5946fc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IAICommonAccessAPI.md @@ -0,0 +1,277 @@ +--- +id: v2025-iai-common-access +title: IAICommonAccess +pagination_label: IAICommonAccess +sidebar_label: IAICommonAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAICommonAccess', 'V2025IAICommonAccess'] +slug: /tools/sdk/go/v2025/methods/iai-common-access +tags: ['SDK', 'Software Development Kit', 'IAICommonAccess', 'V2025IAICommonAccess'] +--- + +# IAICommonAccessAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-common-access**](#create-common-access) | **Post** `/common-access` | Create common access items +[**get-common-access**](#get-common-access) | **Get** `/common-access` | Get a paginated list of common access +[**update-common-access-status-in-bulk**](#update-common-access-status-in-bulk) | **Post** `/common-access/update-status` | Bulk update common access status + + +## create-common-access +:::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 common access items +This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-common-access) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCommonAccessRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **commonAccessItemRequest** | [**CommonAccessItemRequest**](../models/common-access-item-request) | | + +### Return type + +[**CommonAccessItemResponse**](../models/common-access-item-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + commonaccessitemrequest := []byte(`{ + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" + }`) // CommonAccessItemRequest | + + + var commonAccessItemRequest v2025.CommonAccessItemRequest + if err := json.Unmarshal(commonaccessitemrequest, &commonAccessItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAICommonAccessAPI.CreateCommonAccess(context.Background()).XSailPointExperimental(xSailPointExperimental).CommonAccessItemRequest(commonAccessItemRequest).Execute() + //resp, r, err := apiClient.V2025.IAICommonAccessAPI.CreateCommonAccess(context.Background()).XSailPointExperimental(xSailPointExperimental).CommonAccessItemRequest(commonAccessItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.CreateCommonAccess``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCommonAccess`: CommonAccessItemResponse + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.CreateCommonAccess`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-common-access +:::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 a paginated list of common access +This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-common-access) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCommonAccessRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, 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: **access.name, status** By default the common access items are sorted by name, ascending. | + +### Return type + +[**[]CommonAccessResponse**](../models/common-access-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.type eq "ROLE"` // 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) + sorters := `access.name` // 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: **access.name, status** By default the common access items are sorted by name, ascending. (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: **access.name, status** By default the common access items are sorted by name, ascending. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAICommonAccessAPI.GetCommonAccess(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAICommonAccessAPI.GetCommonAccess(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.GetCommonAccess``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCommonAccess`: []CommonAccessResponse + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.GetCommonAccess`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-common-access-status-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 update common access status +This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-common-access-status-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateCommonAccessStatusInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **commonAccessIDStatus** | [**[]CommonAccessIDStatus**](../models/common-access-id-status) | Confirm or deny in bulk the common access ids that are (or aren't) common access | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + commonaccessidstatus := []byte(``) // []CommonAccessIDStatus | Confirm or deny in bulk the common access ids that are (or aren't) common access + + + var commonAccessIDStatus v2025.[]CommonAccessIDStatus + if err := json.Unmarshal(commonaccessidstatus, &commonAccessIDStatus); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAICommonAccessAPI.UpdateCommonAccessStatusInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).CommonAccessIDStatus(commonAccessIDStatus).Execute() + //resp, r, err := apiClient.V2025.IAICommonAccessAPI.UpdateCommonAccessStatusInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).CommonAccessIDStatus(commonAccessIDStatus).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.UpdateCommonAccessStatusInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCommonAccessStatusInBulk`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.UpdateCommonAccessStatusInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IAIOutliersAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IAIOutliersAPI.md new file mode 100644 index 000000000..62a62aac9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IAIOutliersAPI.md @@ -0,0 +1,776 @@ +--- +id: v2025-iai-outliers +title: IAIOutliers +pagination_label: IAIOutliers +sidebar_label: IAIOutliers +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAIOutliers', 'V2025IAIOutliers'] +slug: /tools/sdk/go/v2025/methods/iai-outliers +tags: ['SDK', 'Software Development Kit', 'IAIOutliers', 'V2025IAIOutliers'] +--- + +# IAIOutliersAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**export-outliers-zip**](#export-outliers-zip) | **Get** `/outliers/export` | IAI Identity Outliers Export +[**get-identity-outlier-snapshots**](#get-identity-outlier-snapshots) | **Get** `/outlier-summaries` | IAI Identity Outliers Summary +[**get-identity-outliers**](#get-identity-outliers) | **Get** `/outliers` | IAI Get Identity Outliers +[**get-latest-identity-outlier-snapshots**](#get-latest-identity-outlier-snapshots) | **Get** `/outlier-summaries/latest` | IAI Identity Outliers Latest Summary +[**get-outlier-contributing-feature-summary**](#get-outlier-contributing-feature-summary) | **Get** `/outlier-feature-summaries/{outlierFeatureId}` | Get identity outlier contibuting feature summary +[**get-peer-group-outliers-contributing-features**](#get-peer-group-outliers-contributing-features) | **Get** `/outliers/{outlierId}/contributing-features` | Get identity outlier's contibuting features +[**ignore-identity-outliers**](#ignore-identity-outliers) | **Post** `/outliers/ignore` | IAI Identity Outliers Ignore +[**list-outliers-contributing-feature-access-items**](#list-outliers-contributing-feature-access-items) | **Get** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature +[**un-ignore-identity-outliers**](#un-ignore-identity-outliers) | **Post** `/outliers/unignore` | IAI Identity Outliers Unignore + + +## export-outliers-zip +:::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 + ``` +::: +IAI Identity Outliers Export +This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. + +Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/export-outliers-zip) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportOutliersZipRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **type_** | **string** | Type of the identity outliers snapshot to filter on | + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIOutliersAPI.ExportOutliersZip(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIOutliersAPI.ExportOutliersZip(context.Background()).XSailPointExperimental(xSailPointExperimental).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.ExportOutliersZip``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportOutliersZip`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.ExportOutliersZip`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-outlier-snapshots +:::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 + ``` +::: +IAI Identity Outliers Summary +This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-outlier-snapshots) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityOutlierSnapshotsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **type_** | **string** | Type of the identity outliers snapshot to filter on | + **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: **snapshotDate**: *ge, le* | + **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: **snapshotDate** | + +### Return type + +[**[]OutlierSummary**](../models/outlier-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + filters := `snapshotDate ge "2022-02-07T20:13:29.356648026Z"` // 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: **snapshotDate**: *ge, le* (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: **snapshotDate**: *ge, le* (optional) + sorters := `snapshotDate` // 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: **snapshotDate** (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: **snapshotDate** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIOutliersAPI.GetIdentityOutlierSnapshots(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIOutliersAPI.GetIdentityOutlierSnapshots(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Type_(type_).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetIdentityOutlierSnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityOutlierSnapshots`: []OutlierSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetIdentityOutlierSnapshots`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-outliers +:::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 + ``` +::: +IAI Get Identity Outliers +This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-outliers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityOutliersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **type_** | **string** | Type of the identity outliers snapshot to filter on | + **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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* | + **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: **firstDetectionDate, attributes, score** | + +### Return type + +[**[]Outlier**](../models/outlier) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + filters := `attributes.displayName sw "John" and certStatus 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) + sorters := `attributes.displayName,firstDetectionDate,-score` // 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: **firstDetectionDate, attributes, score** (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: **firstDetectionDate, attributes, score** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIOutliersAPI.GetIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIOutliersAPI.GetIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Type_(type_).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityOutliers`: []Outlier + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetIdentityOutliers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-latest-identity-outlier-snapshots +:::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 + ``` +::: +IAI Identity Outliers Latest Summary +This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-latest-identity-outlier-snapshots) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLatestIdentityOutlierSnapshotsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **type_** | **string** | Type of the identity outliers snapshot to filter on | + +### Return type + +[**[]LatestOutlierSummary**](../models/latest-outlier-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIOutliersAPI.GetLatestIdentityOutlierSnapshots(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIOutliersAPI.GetLatestIdentityOutlierSnapshots(context.Background()).XSailPointExperimental(xSailPointExperimental).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetLatestIdentityOutlierSnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLatestIdentityOutlierSnapshots`: []LatestOutlierSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetLatestIdentityOutlierSnapshots`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-outlier-contributing-feature-summary +:::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 outlier contibuting feature summary +This API returns a summary of a contributing feature for an identity outlier. + +The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-outlier-contributing-feature-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**outlierFeatureId** | **string** | Contributing feature id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOutlierContributingFeatureSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**OutlierFeatureSummary**](../models/outlier-feature-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + outlierFeatureId := `04654b66-7561-4090-94f9-abee0722a1af` // string | Contributing feature id # string | Contributing feature 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.IAIOutliersAPI.GetOutlierContributingFeatureSummary(context.Background(), outlierFeatureId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIOutliersAPI.GetOutlierContributingFeatureSummary(context.Background(), outlierFeatureId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetOutlierContributingFeatureSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOutlierContributingFeatureSummary`: OutlierFeatureSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetOutlierContributingFeatureSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-peer-group-outliers-contributing-features +:::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 outlier's contibuting features +This API returns a list of contributing feature objects for a single outlier. + +The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-peer-group-outliers-contributing-features) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**outlierId** | **string** | The outlier id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPeerGroupOutliersContributingFeaturesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **includeTranslationMessages** | **string** | Whether or not to include translation messages object in returned response | + **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: **importance** | + +### Return type + +[**[]OutlierContributingFeature**](../models/outlier-contributing-feature) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + outlierId := `2c918085842e69ae018432d22ccb212f` // string | The outlier id # string | The outlier 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + includeTranslationMessages := `include-translation-messages=` // string | Whether or not to include translation messages object in returned response (optional) # string | Whether or not to include translation messages object in returned response (optional) + sorters := `importance` // 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: **importance** (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: **importance** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures(context.Background(), outlierId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures(context.Background(), outlierId).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).IncludeTranslationMessages(includeTranslationMessages).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPeerGroupOutliersContributingFeatures`: []OutlierContributingFeature + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## ignore-identity-outliers +:::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 + ``` +::: +IAI Identity Outliers Ignore +This API receives a list of identity IDs in the request, changes the outliers to be ignored. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/ignore-identity-outliers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiIgnoreIdentityOutliersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **requestBody** | **[]string** | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + requestbody := []byte(``) // []string | + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.IAIOutliersAPI.IgnoreIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //r, err := apiClient.V2025.IAIOutliersAPI.IgnoreIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.IgnoreIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## list-outliers-contributing-feature-access-items +:::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 + ``` +::: +Gets a list of access items associated with each identity outlier contributing feature +This API returns a list of the enriched access items associated with each feature filtered by the access item type. + +The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-outliers-contributing-feature-access-items) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**outlierId** | **string** | The outlier id | +**contributingFeatureName** | **string** | The name of contributing feature | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOutliersContributingFeatureAccessItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **accessType** | **string** | The type of access item for the identity outlier contributing feature. If not provided, it returns all. | + **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: **displayName** | + +### Return type + +[**[]OutliersContributingFeatureAccessItems**](../models/outliers-contributing-feature-access-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + outlierId := `2c918085842e69ae018432d22ccb212f` // string | The outlier id # string | The outlier id + contributingFeatureName := `entitlement_count` // string | The name of contributing feature # string | The name of contributing feature + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + accessType := `ENTITLEMENT` // string | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) # string | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) + sorters := `displayName` // 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: **displayName** (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: **displayName** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIOutliersAPI.ListOutliersContributingFeatureAccessItems(context.Background(), outlierId, contributingFeatureName).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIOutliersAPI.ListOutliersContributingFeatureAccessItems(context.Background(), outlierId, contributingFeatureName).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).AccessType(accessType).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.ListOutliersContributingFeatureAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOutliersContributingFeatureAccessItems`: []OutliersContributingFeatureAccessItems + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.ListOutliersContributingFeatureAccessItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## un-ignore-identity-outliers +:::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 + ``` +::: +IAI Identity Outliers Unignore +This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/un-ignore-identity-outliers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUnIgnoreIdentityOutliersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **requestBody** | **[]string** | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + requestbody := []byte(``) // []string | + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.IAIOutliersAPI.UnIgnoreIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //r, err := apiClient.V2025.IAIOutliersAPI.UnIgnoreIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.UnIgnoreIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IAIPeerGroupStrategiesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IAIPeerGroupStrategiesAPI.md new file mode 100644 index 000000000..ad6069f3e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IAIPeerGroupStrategiesAPI.md @@ -0,0 +1,108 @@ +--- +id: v2025-iai-peer-group-strategies +title: IAIPeerGroupStrategies +pagination_label: IAIPeerGroupStrategies +sidebar_label: IAIPeerGroupStrategies +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAIPeerGroupStrategies', 'V2025IAIPeerGroupStrategies'] +slug: /tools/sdk/go/v2025/methods/iai-peer-group-strategies +tags: ['SDK', 'Software Development Kit', 'IAIPeerGroupStrategies', 'V2025IAIPeerGroupStrategies'] +--- + +# IAIPeerGroupStrategiesAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-peer-group-outliers**](#get-peer-group-outliers) | **Get** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List + + +## get-peer-group-outliers +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::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 Outliers List +-- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-peer-group-outliers) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**strategy** | **string** | The strategy used to create peer groups. Currently, 'entitlement' is supported. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPeerGroupOutliersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]PeerGroupMember**](../models/peer-group-member) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + strategy := `entitlement` // string | The strategy used to create peer groups. Currently, 'entitlement' is supported. # string | The strategy used to create peer groups. Currently, 'entitlement' is supported. + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers(context.Background(), strategy).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers(context.Background(), strategy).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPeerGroupOutliers`: []PeerGroupMember + fmt.Fprintf(os.Stdout, "Response from `IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IAIRecommendationsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IAIRecommendationsAPI.md new file mode 100644 index 000000000..1ae2a2c3b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IAIRecommendationsAPI.md @@ -0,0 +1,280 @@ +--- +id: v2025-iai-recommendations +title: IAIRecommendations +pagination_label: IAIRecommendations +sidebar_label: IAIRecommendations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAIRecommendations', 'V2025IAIRecommendations'] +slug: /tools/sdk/go/v2025/methods/iai-recommendations +tags: ['SDK', 'Software Development Kit', 'IAIRecommendations', 'V2025IAIRecommendations'] +--- + +# IAIRecommendationsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-recommendations**](#get-recommendations) | **Post** `/recommendations/request` | Returns Recommendation Based on Object +[**get-recommendations-config**](#get-recommendations-config) | **Get** `/recommendations/config` | Get certification recommendation config values +[**update-recommendations-config**](#update-recommendations-config) | **Put** `/recommendations/config` | Update certification recommendation config values + + +## get-recommendations +:::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 + ``` +::: +Returns Recommendation Based on Object +The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-recommendations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRecommendationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **recommendationRequestDto** | [**RecommendationRequestDto**](../models/recommendation-request-dto) | | + +### Return type + +[**RecommendationResponseDto**](../models/recommendation-response-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + recommendationrequestdto := []byte(`{ + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true + }`) // RecommendationRequestDto | + + + var recommendationRequestDto v2025.RecommendationRequestDto + if err := json.Unmarshal(recommendationrequestdto, &recommendationRequestDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRecommendationsAPI.GetRecommendations(context.Background()).XSailPointExperimental(xSailPointExperimental).RecommendationRequestDto(recommendationRequestDto).Execute() + //resp, r, err := apiClient.V2025.IAIRecommendationsAPI.GetRecommendations(context.Background()).XSailPointExperimental(xSailPointExperimental).RecommendationRequestDto(recommendationRequestDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.GetRecommendations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRecommendations`: RecommendationResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.GetRecommendations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-recommendations-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 + ``` +::: +Get certification recommendation config values +Retrieves configuration attributes used by certification recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-recommendations-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRecommendationsConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RecommendationConfigDto**](../models/recommendation-config-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRecommendationsAPI.GetRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRecommendationsAPI.GetRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.GetRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRecommendationsConfig`: RecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.GetRecommendationsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-recommendations-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 certification recommendation config values +Updates configuration attributes used by certification recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-recommendations-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateRecommendationsConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **recommendationConfigDto** | [**RecommendationConfigDto**](../models/recommendation-config-dto) | | + +### Return type + +[**RecommendationConfigDto**](../models/recommendation-config-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + recommendationconfigdto := []byte(`{ + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + }`) // RecommendationConfigDto | + + + var recommendationConfigDto v2025.RecommendationConfigDto + if err := json.Unmarshal(recommendationconfigdto, &recommendationConfigDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRecommendationsAPI.UpdateRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).RecommendationConfigDto(recommendationConfigDto).Execute() + //resp, r, err := apiClient.V2025.IAIRecommendationsAPI.UpdateRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).RecommendationConfigDto(recommendationConfigDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.UpdateRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRecommendationsConfig`: RecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.UpdateRecommendationsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IAIRoleMiningAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IAIRoleMiningAPI.md new file mode 100644 index 000000000..b04e2470d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IAIRoleMiningAPI.md @@ -0,0 +1,2260 @@ +--- +id: v2025-iai-role-mining +title: IAIRoleMining +pagination_label: IAIRoleMining +sidebar_label: IAIRoleMining +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IAIRoleMining', 'V2025IAIRoleMining'] +slug: /tools/sdk/go/v2025/methods/iai-role-mining +tags: ['SDK', 'Software Development Kit', 'IAIRoleMining', 'V2025IAIRoleMining'] +--- + +# IAIRoleMiningAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-potential-role-provision-request**](#create-potential-role-provision-request) | **Post** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision` | Create request to provision a potential role into an actual role. +[**create-role-mining-sessions**](#create-role-mining-sessions) | **Post** `/role-mining-sessions` | Create a role mining session +[**download-role-mining-potential-role-zip**](#download-role-mining-potential-role-zip) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` | Export (download) details for a potential role in a role mining session +[**export-role-mining-potential-role**](#export-role-mining-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export` | Export (download) details for a potential role in a role mining session +[**export-role-mining-potential-role-async**](#export-role-mining-potential-role-async) | **Post** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` | Asynchronously export details for a potential role in a role mining session and upload to S3 +[**export-role-mining-potential-role-status**](#export-role-mining-potential-role-status) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` | Retrieve status of a potential role export job +[**get-all-potential-role-summaries**](#get-all-potential-role-summaries) | **Get** `/role-mining-potential-roles` | Retrieves all potential role summaries +[**get-entitlement-distribution-potential-role**](#get-entitlement-distribution-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` | Retrieves entitlement popularity distribution for a potential role in a role mining session +[**get-entitlements-potential-role**](#get-entitlements-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities` | Retrieves entitlements for a potential role in a role mining session +[**get-excluded-entitlements-potential-role**](#get-excluded-entitlements-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements` | Retrieves excluded entitlements for a potential role in a role mining session +[**get-identities-potential-role**](#get-identities-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities` | Retrieves identities for a potential role in a role mining session +[**get-potential-role**](#get-potential-role) | **Get** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` | Retrieves a specific potential role +[**get-potential-role-applications**](#get-potential-role-applications) | **Get** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications` | Retrieves the applications of a potential role for a role mining session +[**get-potential-role-entitlements**](#get-potential-role-entitlements) | **Get** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements` | Retrieves the entitlements of a potential role for a role mining session +[**get-potential-role-source-identity-usage**](#get-potential-role-source-identity-usage) | **Get** `/role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage` | Retrieves potential role source usage +[**get-potential-role-summaries**](#get-potential-role-summaries) | **Get** `/role-mining-sessions/{sessionId}/potential-role-summaries` | Retrieves all potential role summaries +[**get-role-mining-potential-role**](#get-role-mining-potential-role) | **Get** `/role-mining-potential-roles/{potentialRoleId}` | Retrieves a specific potential role +[**get-role-mining-session**](#get-role-mining-session) | **Get** `/role-mining-sessions/{sessionId}` | Get a role mining session +[**get-role-mining-session-status**](#get-role-mining-session-status) | **Get** `/role-mining-sessions/{sessionId}/status` | Get role mining session status state +[**get-role-mining-sessions**](#get-role-mining-sessions) | **Get** `/role-mining-sessions` | Retrieves all role mining sessions +[**get-saved-potential-roles**](#get-saved-potential-roles) | **Get** `/role-mining-potential-roles/saved` | Retrieves all saved potential roles +[**patch-potential-role**](#patch-potential-role) | **Patch** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` | Update a potential role +[**patch-potential-role-0**](#patch-potential-role-0) | **Patch** `/role-mining-potential-roles/{potentialRoleId}` | Update a potential role +[**patch-role-mining-session**](#patch-role-mining-session) | **Patch** `/role-mining-sessions/{sessionId}` | Patch a role mining session +[**update-entitlements-potential-role**](#update-entitlements-potential-role) | **Post** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` | Edit entitlements for a potential role to exclude some entitlements + + +## create-potential-role-provision-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 + ``` +::: +Create request to provision a potential role into an actual role. +This method starts a job to provision a potential role + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-potential-role-provision-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePotentialRoleProvisionRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **minEntitlementPopularity** | **int32** | Minimum popularity required for an entitlement to be included in the provisioned role. | [default to 0] + **includeCommonAccess** | **bool** | Boolean determining whether common access entitlements will be included in the provisioned role. | [default to true] + **roleMiningPotentialRoleProvisionRequest** | [**RoleMiningPotentialRoleProvisionRequest**](../models/role-mining-potential-role-provision-request) | Required information to create a new role | + +### Return type + +[**RoleMiningPotentialRoleSummary**](../models/role-mining-potential-role-summary) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + minEntitlementPopularity := 56 // int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) # int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to true) # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to true) + roleminingpotentialroleprovisionrequest := []byte(`{ + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false + }`) // RoleMiningPotentialRoleProvisionRequest | Required information to create a new role (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).MinEntitlementPopularity(minEntitlementPopularity).IncludeCommonAccess(includeCommonAccess).RoleMiningPotentialRoleProvisionRequest(roleMiningPotentialRoleProvisionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePotentialRoleProvisionRequest`: RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-role-mining-sessions +:::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 a role mining session +This submits a create role mining session request to the role mining application. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-role-mining-sessions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateRoleMiningSessionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **roleMiningSessionDto** | [**RoleMiningSessionDto**](../models/role-mining-session-dto) | Role mining session parameters | + +### Return type + +[**RoleMiningSessionResponse**](../models/role-mining-session-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + roleminingsessiondto := []byte(`{ + "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", + "prescribedPruneThreshold" : 10, + "pruneThreshold" : 50, + "saved" : true, + "potentialRolesReadyCount" : 0, + "scope" : { + "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], + "attributeFilterCriteria" : { + "displayName" : { + "untranslated" : "Location: Miami" + }, + "ariaLabel" : { + "untranslated" : "Location: Miami" + }, + "data" : { + "displayName" : { + "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" + }, + "name" : "location", + "operator" : "EQUALS", + "values" : [ "Miami" ] + } + }, + "criteria" : "source.name:DataScienceDataset" + }, + "potentialRoleCount" : 0, + "name" : "Saved RM Session - 07/10", + "minNumIdentitiesInPotentialRole" : 20, + "identityCount" : 0, + "type" : "SPECIALIZED" + }`) // RoleMiningSessionDto | Role mining session parameters + + + var roleMiningSessionDto v2025.RoleMiningSessionDto + if err := json.Unmarshal(roleminingsessiondto, &roleMiningSessionDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.CreateRoleMiningSessions(context.Background()).XSailPointExperimental(xSailPointExperimental).RoleMiningSessionDto(roleMiningSessionDto).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.CreateRoleMiningSessions(context.Background()).XSailPointExperimental(xSailPointExperimental).RoleMiningSessionDto(roleMiningSessionDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.CreateRoleMiningSessions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRoleMiningSessions`: RoleMiningSessionResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.CreateRoleMiningSessions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## download-role-mining-potential-role-zip +:::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 + ``` +::: +Export (download) details for a potential role in a role mining session +This endpoint downloads a completed export of information for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/download-role-mining-potential-role-zip) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | +**exportId** | **string** | The id of a previously run export job for this potential role | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDownloadRoleMiningPotentialRoleZipRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + exportId := `4940ffd4-836f-48a3-b2b0-6d498c3fdf40` // string | The id of a previously run export job for this potential role # string | The id of a previously run export job for this potential role + 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.IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip(context.Background(), sessionId, potentialRoleId, exportId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip(context.Background(), sessionId, potentialRoleId, exportId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DownloadRoleMiningPotentialRoleZip`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## export-role-mining-potential-role +:::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 + ``` +::: +Export (download) details for a potential role in a role mining session +This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/export-role-mining-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportRoleMiningPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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.IAIRoleMiningAPI.ExportRoleMiningPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.ExportRoleMiningPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRole`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## export-role-mining-potential-role-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 + ``` +::: +Asynchronously export details for a potential role in a role mining session and upload to S3 +This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/export-role-mining-potential-role-async) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportRoleMiningPotentialRoleAsyncRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **roleMiningPotentialRoleExportRequest** | [**RoleMiningPotentialRoleExportRequest**](../models/role-mining-potential-role-export-request) | | + +### Return type + +[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + roleminingpotentialroleexportrequest := []byte(`{ + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true + }`) // RoleMiningPotentialRoleExportRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).RoleMiningPotentialRoleExportRequest(roleMiningPotentialRoleExportRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRoleAsync`: RoleMiningPotentialRoleExportResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## export-role-mining-potential-role-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 + ``` +::: +Retrieve status of a potential role export job +This endpoint retrieves information about the current status of a potential role export. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/export-role-mining-potential-role-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | +**exportId** | **string** | The id of a previously run export job for this potential role | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportRoleMiningPotentialRoleStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + exportId := `4940ffd4-836f-48a3-b2b0-6d498c3fdf40` // string | The id of a previously run export job for this potential role # string | The id of a previously run export job for this potential role + 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.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus(context.Background(), sessionId, potentialRoleId, exportId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus(context.Background(), sessionId, potentialRoleId, exportId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRoleStatus`: RoleMiningPotentialRoleExportResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-all-potential-role-summaries +:::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 + ``` +::: +Retrieves all potential role summaries +Returns all potential role summaries that match the query parameters + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-all-potential-role-summaries) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAllPotentialRoleSummariesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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: **createdDate, identityCount, entitlementCount, freshness, quality** | + **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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningPotentialRoleSummary**](../models/role-mining-potential-role-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + sorters := `createdDate` // 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: **createdDate, identityCount, entitlementCount, freshness, quality** (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: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) + filters := `(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))` // 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetAllPotentialRoleSummaries(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetAllPotentialRoleSummaries(context.Background()).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetAllPotentialRoleSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAllPotentialRoleSummaries`: []RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetAllPotentialRoleSummaries`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlement-distribution-potential-role +:::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 + ``` +::: +Retrieves entitlement popularity distribution for a potential role in a role mining session +This method returns entitlement popularity distribution for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlement-distribution-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementDistributionPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **includeCommonAccess** | **bool** | Boolean determining whether common access entitlements will be included or not | + +### Return type + +**map[string]int32** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included or not (optional) # bool | Boolean determining whether common access entitlements will be included or not (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).IncludeCommonAccess(includeCommonAccess).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementDistributionPotentialRole`: map[string]int32 + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlements-potential-role +:::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 + ``` +::: +Retrieves entitlements for a potential role in a role mining session +This method returns entitlements for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlements-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementsPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **includeCommonAccess** | **bool** | Boolean determining whether common access entitlements will be included or not | [default to true] + **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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. | + **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: **applicationName**: *sw* **entitlementRef.name**: *sw* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningEntitlement**](../models/role-mining-entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included or not (optional) (default to true) # bool | Boolean determining whether common access entitlements will be included or not (optional) (default to true) + sorters := `popularity` // 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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) + filters := `applicationName sw "AD"` // 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).IncludeCommonAccess(includeCommonAccess).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementsPotentialRole`: []RoleMiningEntitlement + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetEntitlementsPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-excluded-entitlements-potential-role +:::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 + ``` +::: +Retrieves excluded entitlements for a potential role in a role mining session +This method returns excluded entitlements for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-excluded-entitlements-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetExcludedEntitlementsPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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: **popularity** | + **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: **applicationName**: *sw* **entitlementRef.name**: *sw* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningEntitlement**](../models/role-mining-entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + sorters := `populariity` // 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: **popularity** (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: **popularity** (optional) + filters := `applicationName sw "AD"` // 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetExcludedEntitlementsPotentialRole`: []RoleMiningEntitlement + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identities-potential-role +:::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 + ``` +::: +Retrieves identities for a potential role in a role mining session +This method returns identities for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identities-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentitiesPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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** | + **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: **name**: *sw* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningIdentity**](../models/role-mining-identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + sorters := `name` // 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** (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** (optional) + filters := `filters_example` // 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: **name**: *sw* (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: **name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetIdentitiesPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetIdentitiesPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetIdentitiesPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitiesPotentialRole`: []RoleMiningIdentity + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetIdentitiesPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-potential-role +:::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 + ``` +::: +Retrieves a specific potential role +This method returns a specific potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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.IAIRoleMiningAPI.GetPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-potential-role-applications +:::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 + ``` +::: +Retrieves the applications of a potential role for a role mining session +This method returns the applications of a potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-potential-role-applications) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPotentialRoleApplicationsRequest struct via the builder pattern + + +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: **applicationName**: *sw* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningPotentialRoleApplication**](../models/role-mining-potential-role-application) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `62f28d91-7d9f-4d17-be15-666d5b41d77f` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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 := `applicationName sw "test"` // 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: **applicationName**: *sw* (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: **applicationName**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRoleApplications(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRoleApplications(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleApplications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleApplications`: []RoleMiningPotentialRoleApplication + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleApplications`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-potential-role-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 + ``` +::: +Retrieves the entitlements of a potential role for a role mining session +This method returns the entitlements of a potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-potential-role-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPotentialRoleEntitlementsRequest struct via the builder pattern + + +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: **entitlementRef.name**: *sw* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningPotentialRoleEntitlements**](../models/role-mining-potential-role-entitlements) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `62f28d91-7d9f-4d17-be15-666d5b41d77f` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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 := `entitlementRef.name sw "test"` // 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: **entitlementRef.name**: *sw* (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: **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRoleEntitlements(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRoleEntitlements(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleEntitlements`: []RoleMiningPotentialRoleEntitlements + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-potential-role-source-identity-usage +:::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 + ``` +::: +Retrieves potential role source usage +This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-potential-role-source-identity-usage) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**potentialRoleId** | **string** | A potential role id | +**sourceId** | **string** | A source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPotentialRoleSourceIdentityUsageRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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 is supported for the following fields: **displayName, email, usageCount** | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningPotentialRoleSourceUsage**](../models/role-mining-potential-role-source-usage) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + potentialRoleId := `e0cc5d7d-bf7f-4f81-b2af-8885b09d9923` // string | A potential role id # string | A potential role id + sourceId := `2c9180877620c1460176267f336a106f` // string | A source id # string | A 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") + sorters := `-usageCount` // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (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 is supported for the following fields: **displayName, email, usageCount** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage(context.Background(), potentialRoleId, sourceId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage(context.Background(), potentialRoleId, sourceId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleSourceIdentityUsage`: []RoleMiningPotentialRoleSourceUsage + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-potential-role-summaries +:::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 + ``` +::: +Retrieves all potential role summaries +This method returns the potential role summaries for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-potential-role-summaries) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPotentialRoleSummariesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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: **createdDate** | + **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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningPotentialRoleSummary**](../models/role-mining-potential-role-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session 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") + sorters := `createdDate` // 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: **createdDate** (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: **createdDate** (optional) + filters := `(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))` // 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRoleSummaries(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRoleSummaries(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleSummaries`: []RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleSummaries`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-mining-potential-role +:::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 + ``` +::: +Retrieves a specific potential role +This method returns a specific potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role-mining-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**potentialRoleId** | **string** | A potential role id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleMiningPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id # string | A potential role 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.IAIRoleMiningAPI.GetRoleMiningPotentialRole(context.Background(), potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetRoleMiningPotentialRole(context.Background(), potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-mining-session +:::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 a role mining session +The method retrieves a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role-mining-session) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id to be retrieved. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleMiningSessionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleMiningSessionResponse**](../models/role-mining-session-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id to be retrieved. # string | The role mining session id to be retrieved. + 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.IAIRoleMiningAPI.GetRoleMiningSession(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetRoleMiningSession(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSession``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSession`: RoleMiningSessionResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSession`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-mining-session-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 + ``` +::: +Get role mining session status state +This method returns a role mining session status for a customer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role-mining-session-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleMiningSessionStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleMiningSessionStatus**](../models/role-mining-session-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session 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.IAIRoleMiningAPI.GetRoleMiningSessionStatus(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetRoleMiningSessionStatus(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSessionStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSessionStatus`: RoleMiningSessionStatus + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSessionStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-mining-sessions +:::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 + ``` +::: +Retrieves all role mining sessions +Returns all role mining sessions that match the query parameters + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role-mining-sessions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleMiningSessionsRequest struct via the builder pattern + + +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: **saved**: *eq* **name**: *eq, sw* | + **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: **createdBy, createdDate** | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningSessionDto**](../models/role-mining-session-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 := `saved eq "true" and name sw "RM Session"` // 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: **saved**: *eq* **name**: *eq, sw* (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: **saved**: *eq* **name**: *eq, sw* (optional) + sorters := `createdBy,createdDate` // 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: **createdBy, createdDate** (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: **createdBy, createdDate** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetRoleMiningSessions(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetRoleMiningSessions(context.Background()).XSailPointExperimental(xSailPointExperimental).Filters(filters).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSessions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSessions`: []RoleMiningSessionDto + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSessions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-saved-potential-roles +:::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 + ``` +::: +Retrieves all saved potential roles +This method returns all saved potential roles (draft roles). + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-saved-potential-roles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSavedPotentialRolesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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 is supported for the following fields: **modified** | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]RoleMiningSessionDraftRoleDto**](../models/role-mining-session-draft-role-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + sorters := `modified` // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (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 is supported for the following fields: **modified** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetSavedPotentialRoles(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetSavedPotentialRoles(context.Background()).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetSavedPotentialRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSavedPotentialRoles`: []RoleMiningSessionDraftRoleDto + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetSavedPotentialRoles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-potential-role +:::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 a potential role +The method updates an existing potential role using. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | The potential role summary id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **patchPotentialRoleRequestInner** | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The potential role summary id # string | The potential role summary 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") + patchpotentialrolerequestinner := []byte(`[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]`) // []PatchPotentialRoleRequestInner | + + + var patchPotentialRoleRequestInner v2025.[]PatchPotentialRoleRequestInner + if err := json.Unmarshal(patchpotentialrolerequestinner, &patchPotentialRoleRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.PatchPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.PatchPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPotentialRole`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-potential-role-0 +:::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 a potential role +The method updates an existing potential role using. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-potential-role-0) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | The potential role summary id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchPotentialRole_1Request struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **patchPotentialRoleRequestInner** | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The potential role summary id # string | The potential role summary 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") + patchpotentialrolerequestinner := []byte(`[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]`) // []PatchPotentialRoleRequestInner | + + + var patchPotentialRoleRequestInner v2025.[]PatchPotentialRoleRequestInner + if err := json.Unmarshal(patchpotentialrolerequestinner, &patchPotentialRoleRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.PatchPotentialRole_0(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.PatchPotentialRole_0(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchPotentialRole_0``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPotentialRole_0`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchPotentialRole_0`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-role-mining-session +:::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 + ``` +::: +Patch a role mining session +The method updates an existing role mining session using PATCH. Supports op in {"replace"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-role-mining-session) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id to be patched | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchRoleMiningSessionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id to be patched # string | The role mining session id to be patched + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/pruneThreshold, value=83}, {op=replace, path=/minNumIdentitiesInPotentialRole, value=10}, {op=replace, path=/saved, value=false}, {op=replace, path=/name, value=RM Session - 07/10/22}, {op=add, path=/name, value=RM Session - 07/10/22}]`) // []JsonPatchOperation | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.PatchRoleMiningSession(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.PatchRoleMiningSession(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchRoleMiningSession``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchRoleMiningSession`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchRoleMiningSession`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-entitlements-potential-role +:::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 + ``` +::: +Edit entitlements for a potential role to exclude some entitlements +This endpoint adds or removes entitlements from an exclusion list for a potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-entitlements-potential-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sessionId** | **string** | The role mining session id | +**potentialRoleId** | **string** | A potential role id in a role mining session | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateEntitlementsPotentialRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **roleMiningPotentialRoleEditEntitlements** | [**RoleMiningPotentialRoleEditEntitlements**](../models/role-mining-potential-role-edit-entitlements) | Role mining session parameters | + +### Return type + +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + roleminingpotentialroleeditentitlements := []byte(`{ + "ids" : [ "entId1", "entId2" ], + "exclude" : true + }`) // RoleMiningPotentialRoleEditEntitlements | Role mining session parameters + + + var roleMiningPotentialRoleEditEntitlements v2025.RoleMiningPotentialRoleEditEntitlements + if err := json.Unmarshal(roleminingpotentialroleeditentitlements, &roleMiningPotentialRoleEditEntitlements); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.UpdateEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).RoleMiningPotentialRoleEditEntitlements(roleMiningPotentialRoleEditEntitlements).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.UpdateEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).RoleMiningPotentialRoleEditEntitlements(roleMiningPotentialRoleEditEntitlements).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.UpdateEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateEntitlementsPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.UpdateEntitlementsPotentialRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IconsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IconsAPI.md new file mode 100644 index 000000000..b72be8ff8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IconsAPI.md @@ -0,0 +1,187 @@ +--- +id: v2025-icons +title: Icons +pagination_label: Icons +sidebar_label: Icons +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Icons', 'V2025Icons'] +slug: /tools/sdk/go/v2025/methods/icons +tags: ['SDK', 'Software Development Kit', 'Icons', 'V2025Icons'] +--- + +# IconsAPI + Use this API to implement functionality related to object icons (application icons for example). +With this functionality in place, administrators can set or remove an icon for specific object type for use throughout Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-icon**](#delete-icon) | **Delete** `/icons/{objectType}/{objectId}` | Delete an icon +[**set-icon**](#set-icon) | **Put** `/icons/{objectType}/{objectId}` | Update an icon + + +## delete-icon +:::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 an icon +This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-icon) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**objectType** | **string** | Object type. Available options ['application'] | +**objectId** | **string** | Object id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIconRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + objectType := `application` // string | Object type. Available options ['application'] # string | Object type. Available options ['application'] + objectId := `a291e870-48c3-4953-b656-fb5ce2a93169` // string | Object id. # string | Object 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.V2025.IconsAPI.DeleteIcon(context.Background(), objectType, objectId).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.IconsAPI.DeleteIcon(context.Background(), objectType, objectId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IconsAPI.DeleteIcon``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## set-icon +:::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 an icon +This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-icon) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**objectType** | **string** | Object type. Available options ['application'] | +**objectId** | **string** | Object id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetIconRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **image** | ***os.File** | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] | + +### Return type + +[**SetIcon200Response**](../models/set-icon200-response) + +### 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() { + objectType := `application` // string | Object type. Available options ['application'] # string | Object type. Available options ['application'] + objectId := `a291e870-48c3-4953-b656-fb5ce2a93169` // string | Object id. # string | Object 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") + image := BINARY_DATA_HERE // *os.File | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] # *os.File | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IconsAPI.SetIcon(context.Background(), objectType, objectId).XSailPointExperimental(xSailPointExperimental).Image(image).Execute() + //resp, r, err := apiClient.V2025.IconsAPI.SetIcon(context.Background(), objectType, objectId).XSailPointExperimental(xSailPointExperimental).Image(image).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IconsAPI.SetIcon``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetIcon`: SetIcon200Response + fmt.Fprintf(os.Stdout, "Response from `IconsAPI.SetIcon`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IdentitiesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IdentitiesAPI.md new file mode 100644 index 000000000..6f8bd1328 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IdentitiesAPI.md @@ -0,0 +1,956 @@ +--- +id: v2025-identities +title: Identities +pagination_label: Identities +sidebar_label: Identities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Identities', 'V2025Identities'] +slug: /tools/sdk/go/v2025/methods/identities +tags: ['SDK', 'Software Development Kit', 'Identities', 'V2025Identities'] +--- + +# IdentitiesAPI + Use this API to implement identity functionality. +With this functionality in place, administrators can synchronize an identity's attributes with its various source attributes. + +Identity Security Cloud uses identities as users' authoritative accounts. Identities can own other accounts, entitlements, and attributes. + +An identity has a variety of attributes, such as an account name, an email address, a job title, and more. +These identity attributes can be correlated with different attributes on different sources. +For example, the identity John.Smith can own an account in the GitHub source with the account name John-Smith-Org, and Identity Security Cloud knows they are the same person with the same access and attributes. + +In Identity Security Cloud, administrators often set up these synchronizations to get triggered automatically with a change or to run on a schedule. +To manually synchronize attributes for an identity, administrators can use the Identities drop-down menu and select Identity List to view the list of identities. +They can then select the identity they want to manually synchronize and use the hamburger menu to select 'Synchronize Attributes.' +Doing so immediately begins the attribute synchronization and analyzes all accounts for the selected identity. + +Refer to [Synchronizing Attributes](https://documentation.sailpoint.com/saas/help/provisioning/attr_sync.html) for more information about synchronizing attributes. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-identity**](#delete-identity) | **Delete** `/identities/{id}` | Delete identity +[**get-identity**](#get-identity) | **Get** `/identities/{id}` | Identity Details +[**get-identity-ownership-details**](#get-identity-ownership-details) | **Get** `/identities/{identityId}/ownership` | Get ownership details +[**get-role-assignment**](#get-role-assignment) | **Get** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details +[**get-role-assignments**](#get-role-assignments) | **Get** `/identities/{identityId}/role-assignments` | List role assignments +[**list-identities**](#list-identities) | **Get** `/identities` | List Identities +[**reset-identity**](#reset-identity) | **Post** `/identities/{id}/reset` | Reset an identity +[**send-identity-verification-account-token**](#send-identity-verification-account-token) | **Post** `/identities/{id}/verification/account/send` | Send password reset email +[**start-identities-invite**](#start-identities-invite) | **Post** `/identities/invite` | Invite identities to register +[**start-identity-processing**](#start-identity-processing) | **Post** `/identities/process` | Process a list of identityIds +[**synchronize-attributes-for-identity**](#synchronize-attributes-for-identity) | **Post** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity. + + +## 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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Identity Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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.V2025.IdentitiesAPI.DeleteIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.IdentitiesAPI.DeleteIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).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) + } +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Identity Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**Identity**](../models/identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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.V2025.IdentitiesAPI.GetIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentitiesAPI.GetIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `GetIdentity`: Identity + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetIdentity`: %v\n", resp) +} +``` + +[[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. +For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity's owned objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-ownership-details) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | Identity ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityOwnershipDetailsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**IdentityOwnershipAssociationDetails**](../models/identity-ownership-association-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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.V2025.IdentitiesAPI.GetIdentityOwnershipDetails(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentitiesAPI.GetIdentityOwnershipDetails(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `GetIdentityOwnershipDetails`: IdentityOwnershipAssociationDetails + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetIdentityOwnershipDetails`: %v\n", resp) +} +``` + +[[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 + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role-assignment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | Identity Id | +**assignmentId** | **string** | Assignment Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleAssignmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleAssignmentDto**](../models/role-assignment-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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.V2025.IdentitiesAPI.GetRoleAssignment(context.Background(), identityId, assignmentId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentitiesAPI.GetRoleAssignment(context.Background(), identityId, assignmentId).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `GetRoleAssignment`: RoleAssignmentDto + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetRoleAssignment`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role-assignments) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | Identity Id to get the role assignments for | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleAssignmentsRequest struct via the builder pattern + + +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 | + +### Return type + +[**[]GetRoleAssignments200ResponseInner**](../models/get-role-assignments200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentitiesAPI.GetRoleAssignments(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentitiesAPI.GetRoleAssignments(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `GetRoleAssignments`: []GetRoleAssignments200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetRoleAssignments`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentitiesRequest struct via the builder pattern + + +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"] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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 + +[**[]Identity**](../models/identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.V2025.IdentitiesAPI.ListIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentitiesAPI.ListIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `ListIdentities`: []Identity + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.ListIdentities`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/reset-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | Identity Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiResetIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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.V2025.IdentitiesAPI.ResetIdentity(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.IdentitiesAPI.ResetIdentity(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).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) + } +} +``` + +[[Back to top]](#) + +## send-identity-verification-account-token +:::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 + ``` +::: +Send password reset email +This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/send-identity-verification-account-token) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Identity ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendIdentityVerificationAccountTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + + **sendAccountVerificationRequest** | [**SendAccountVerificationRequest**](../models/send-account-verification-request) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + sendaccountverificationrequest := []byte(`{ + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" + }`) // SendAccountVerificationRequest | + + + var sendAccountVerificationRequest v2025.SendAccountVerificationRequest + if err := json.Unmarshal(sendaccountverificationrequest, &sendAccountVerificationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.IdentitiesAPI.SendIdentityVerificationAccountToken(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SendAccountVerificationRequest(sendAccountVerificationRequest).Execute() + //r, err := apiClient.V2025.IdentitiesAPI.SendIdentityVerificationAccountToken(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SendAccountVerificationRequest(sendAccountVerificationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.SendIdentityVerificationAccountToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[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. + +This task will send an invitation email only for unregistered identities. + +The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-identities-invite) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartIdentitiesInviteRequest struct via the builder pattern + + +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 + +[**TaskStatus**](../models/task-status) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 + }`) // InviteIdentitiesRequest | + + + var inviteIdentitiesRequest v2025.InviteIdentitiesRequest + if err := json.Unmarshal(inviteidentitiesrequest, &inviteIdentitiesRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentitiesAPI.StartIdentitiesInvite(context.Background()).XSailPointExperimental(xSailPointExperimental).InviteIdentitiesRequest(inviteIdentitiesRequest).Execute() + //resp, r, err := apiClient.V2025.IdentitiesAPI.StartIdentitiesInvite(context.Background()).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `StartIdentitiesInvite`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.StartIdentitiesInvite`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-identity-processing +:::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 a list of identityIds +This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. + +This endpoint will perform the following tasks: +1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change). +2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. +3. Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health). +4. Recalculate manager relationships. +5. Potentially clean-up identity processing errors, assuming the error has been resolved. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-identity-processing) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartIdentityProcessingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **processIdentitiesRequest** | [**ProcessIdentitiesRequest**](../models/process-identities-request) | | + +### Return type + +[**TaskResultResponse**](../models/task-result-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + processidentitiesrequest := []byte(`{ + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + }`) // ProcessIdentitiesRequest | + + + var processIdentitiesRequest v2025.ProcessIdentitiesRequest + if err := json.Unmarshal(processidentitiesrequest, &processIdentitiesRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentitiesAPI.StartIdentityProcessing(context.Background()).XSailPointExperimental(xSailPointExperimental).ProcessIdentitiesRequest(processIdentitiesRequest).Execute() + //resp, r, err := apiClient.V2025.IdentitiesAPI.StartIdentityProcessing(context.Background()).XSailPointExperimental(xSailPointExperimental).ProcessIdentitiesRequest(processIdentitiesRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.StartIdentityProcessing``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartIdentityProcessing`: TaskResultResponse + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.StartIdentityProcessing`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## synchronize-attributes-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 + ``` +::: +Attribute synchronization for single identity. +This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/synchronize-attributes-for-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | The Identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSynchronizeAttributesForIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**IdentitySyncJob**](../models/identity-sync-job) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `identityId_example` // 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.IdentitiesAPI.SynchronizeAttributesForIdentity(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentitiesAPI.SynchronizeAttributesForIdentity(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.SynchronizeAttributesForIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SynchronizeAttributesForIdentity`: IdentitySyncJob + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.SynchronizeAttributesForIdentity`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IdentityAttributesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IdentityAttributesAPI.md new file mode 100644 index 000000000..45e3f3eb3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IdentityAttributesAPI.md @@ -0,0 +1,553 @@ +--- +id: v2025-identity-attributes +title: IdentityAttributes +pagination_label: IdentityAttributes +sidebar_label: IdentityAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributes', 'V2025IdentityAttributes'] +slug: /tools/sdk/go/v2025/methods/identity-attributes +tags: ['SDK', 'Software Development Kit', 'IdentityAttributes', 'V2025IdentityAttributes'] +--- + +# IdentityAttributesAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-identity-attribute**](#create-identity-attribute) | **Post** `/identity-attributes` | Create Identity Attribute +[**delete-identity-attribute**](#delete-identity-attribute) | **Delete** `/identity-attributes/{name}` | Delete Identity Attribute +[**delete-identity-attributes-in-bulk**](#delete-identity-attributes-in-bulk) | **Delete** `/identity-attributes/bulk-delete` | Bulk delete Identity Attributes +[**get-identity-attribute**](#get-identity-attribute) | **Get** `/identity-attributes/{name}` | Get Identity Attribute +[**list-identity-attributes**](#list-identity-attributes) | **Get** `/identity-attributes` | List Identity Attributes +[**put-identity-attribute**](#put-identity-attribute) | **Put** `/identity-attributes/{name}` | Update Identity Attribute + + +## create-identity-attribute +:::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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-identity-attribute) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateIdentityAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **identityAttribute** | [**IdentityAttribute**](../models/identity-attribute) | | + +### Return type + +[**IdentityAttribute**](../models/identity-attribute) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + }`) // IdentityAttribute | + + + var identityAttribute v2025.IdentityAttribute + if err := json.Unmarshal(identityattribute, &identityAttribute); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityAttributesAPI.CreateIdentityAttribute(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityAttribute(identityAttribute).Execute() + //resp, r, err := apiClient.V2025.IdentityAttributesAPI.CreateIdentityAttribute(context.Background()).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `CreateIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.CreateIdentityAttribute`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-identity-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The attribute's technical name. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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.V2025.IdentityAttributesAPI.DeleteIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.IdentityAttributesAPI.DeleteIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).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) + } +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-identity-attributes-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityAttributesInBulkRequest struct via the builder pattern + + +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 + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 | + + + var identityAttributeNames v2025.IdentityAttributeNames + if err := json.Unmarshal(identityattributenames, &identityAttributeNames); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.IdentityAttributesAPI.DeleteIdentityAttributesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityAttributeNames(identityAttributeNames).Execute() + //r, err := apiClient.V2025.IdentityAttributesAPI.DeleteIdentityAttributesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).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) + } +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The attribute's technical name. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**IdentityAttribute**](../models/identity-attribute) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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.V2025.IdentityAttributesAPI.GetIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityAttributesAPI.GetIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `GetIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.GetIdentityAttribute`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-identity-attributes) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityAttributesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]IdentityAttribute**](../models/identity-attribute) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityAttributesAPI.ListIdentityAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityAttributesAPI.ListIdentityAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `ListIdentityAttributes`: []IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.ListIdentityAttributes`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-identity-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The attribute's technical name. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutIdentityAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **identityAttribute** | [**IdentityAttribute**](../models/identity-attribute) | | + +### Return type + +[**IdentityAttribute**](../models/identity-attribute) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + }`) // IdentityAttribute | + + + var identityAttribute v2025.IdentityAttribute + if err := json.Unmarshal(identityattribute, &identityAttribute); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityAttributesAPI.PutIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).IdentityAttribute(identityAttribute).Execute() + //resp, r, err := apiClient.V2025.IdentityAttributesAPI.PutIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `PutIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.PutIdentityAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IdentityHistoryAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IdentityHistoryAPI.md new file mode 100644 index 000000000..c67c5a3cd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IdentityHistoryAPI.md @@ -0,0 +1,981 @@ +--- +id: v2025-identity-history +title: IdentityHistory +pagination_label: IdentityHistory +sidebar_label: IdentityHistory +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityHistory', 'V2025IdentityHistory'] +slug: /tools/sdk/go/v2025/methods/identity-history +tags: ['SDK', 'Software Development Kit', 'IdentityHistory', 'V2025IdentityHistory'] +--- + +# IdentityHistoryAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**compare-identity-snapshots**](#compare-identity-snapshots) | **Get** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots +[**compare-identity-snapshots-access-type**](#compare-identity-snapshots-access-type) | **Get** `/historical-identities/{id}/compare/{access-type}` | Gets a list of differences of specific accessType for the given identity between 2 snapshots +[**get-historical-identity**](#get-historical-identity) | **Get** `/historical-identities/{id}` | Get latest snapshot of identity +[**get-historical-identity-events**](#get-historical-identity-events) | **Get** `/historical-identities/{id}/events` | Lists all events for the given identity +[**get-identity-snapshot**](#get-identity-snapshot) | **Get** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date +[**get-identity-snapshot-summary**](#get-identity-snapshot-summary) | **Get** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity +[**get-identity-start-date**](#get-identity-start-date) | **Get** `/historical-identities/{id}/start-date` | Gets the start date of the identity +[**list-historical-identities**](#list-historical-identities) | **Get** `/historical-identities` | Lists all the identities +[**list-identity-access-items**](#list-identity-access-items) | **Get** `/historical-identities/{id}/access-items` | List Access Items by Identity +[**list-identity-snapshot-access-items**](#list-identity-snapshot-access-items) | **Get** `/historical-identities/{id}/snapshots/{date}/access-items` | Gets the list of identity access items at a given date filterd by item type +[**list-identity-snapshots**](#list-identity-snapshots) | **Get** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity + + +## compare-identity-snapshots +:::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 + ``` +::: +Gets a difference of count for each access item types for the given identity between 2 snapshots +This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/compare-identity-snapshots) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompareIdentitySnapshotsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **snapshot1** | **string** | The snapshot 1 of identity | + **snapshot2** | **string** | The snapshot 2 of identity | + **accessItemTypes** | **[]string** | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]IdentityCompareResponse**](../models/identity-compare-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + snapshot1 := `2007-03-01T13:00:00Z` // string | The snapshot 1 of identity (optional) # string | The snapshot 1 of identity (optional) + snapshot2 := `2008-03-01T13:00:00Z` // string | The snapshot 2 of identity (optional) # string | The snapshot 2 of identity (optional) + accessitemtypes := []byte(``) // []string | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityHistoryAPI.CompareIdentitySnapshots(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.CompareIdentitySnapshots(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Snapshot1(snapshot1).Snapshot2(snapshot2).AccessItemTypes(accessItemTypes).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.CompareIdentitySnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompareIdentitySnapshots`: []IdentityCompareResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.CompareIdentitySnapshots`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## compare-identity-snapshots-access-type +:::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 + ``` +::: +Gets a list of differences of specific accessType for the given identity between 2 snapshots +This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/compare-identity-snapshots-access-type) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | +**accessType** | **string** | The specific type which needs to be compared | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompareIdentitySnapshotsAccessTypeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **accessAssociated** | **bool** | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed | + **snapshot1** | **string** | The snapshot 1 of identity | + **snapshot2** | **string** | The snapshot 2 of identity | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]AccessItemDiff**](../models/access-item-diff) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + accessType := `role` // string | The specific type which needs to be compared # string | The specific type which needs to be compared + 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") + accessAssociated := 2007-03-01T13:00:00Z // bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) # bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) + snapshot1 := `2008-03-01T13:00:00Z` // string | The snapshot 1 of identity (optional) # string | The snapshot 1 of identity (optional) + snapshot2 := `2009-03-01T13:00:00Z` // string | The snapshot 2 of identity (optional) # string | The snapshot 2 of identity (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityHistoryAPI.CompareIdentitySnapshotsAccessType(context.Background(), id, accessType).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.CompareIdentitySnapshotsAccessType(context.Background(), id, accessType).XSailPointExperimental(xSailPointExperimental).AccessAssociated(accessAssociated).Snapshot1(snapshot1).Snapshot2(snapshot2).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.CompareIdentitySnapshotsAccessType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompareIdentitySnapshotsAccessType`: []AccessItemDiff + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.CompareIdentitySnapshotsAccessType`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-historical-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 + ``` +::: +Get latest snapshot of identity +This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-historical-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetHistoricalIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**IdentityHistoryResponse**](../models/identity-history-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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.IdentityHistoryAPI.GetHistoricalIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.GetHistoricalIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetHistoricalIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetHistoricalIdentity`: IdentityHistoryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetHistoricalIdentity`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-historical-identity-events +:::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 + ``` +::: +Lists all events for the given identity +This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-historical-identity-events) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetHistoricalIdentityEventsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **from** | **string** | The optional instant until which access events are returned | + **eventTypes** | **[]string** | An optional list of event types to return. If null or empty, all events are returned | + **accessItemTypes** | **[]string** | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]GetHistoricalIdentityEvents200ResponseInner**](../models/get-historical-identity-events200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + from := `2024-03-01T13:00:00Z` // string | The optional instant until which access events are returned (optional) # string | The optional instant until which access events are returned (optional) + eventtypes := []byte(`[AccessAddedEvent, AccessRemovedEvent]`) // []string | An optional list of event types to return. If null or empty, all events are returned (optional) + accessitemtypes := []byte(`[entitlement, account]`) // []string | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityHistoryAPI.GetHistoricalIdentityEvents(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.GetHistoricalIdentityEvents(context.Background(), id).XSailPointExperimental(xSailPointExperimental).From(from).EventTypes(eventTypes).AccessItemTypes(accessItemTypes).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetHistoricalIdentityEvents``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetHistoricalIdentityEvents`: []GetHistoricalIdentityEvents200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetHistoricalIdentityEvents`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-snapshot +:::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 + ``` +::: +Gets an identity snapshot at a given date +This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-snapshot) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | +**date** | **string** | The specified date | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentitySnapshotRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**IdentityHistoryResponse**](../models/identity-history-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + date := `2007-03-01T13:00:00Z` // string | The specified date # string | The specified date + 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.IdentityHistoryAPI.GetIdentitySnapshot(context.Background(), id, date).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.GetIdentitySnapshot(context.Background(), id, date).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentitySnapshot``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySnapshot`: IdentityHistoryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentitySnapshot`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-snapshot-summary +:::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 + ``` +::: +Gets the summary for the event count for a specific identity +This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-snapshot-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentitySnapshotSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **before** | **string** | The date before which snapshot summary is required | + **interval** | **string** | The interval indicating day or month. Defaults to month if not specified | + **timeZone** | **string** | The time zone. Defaults to UTC if not provided | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]MetricResponse**](../models/metric-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + before := `2007-03-01T13:00:00Z` // string | The date before which snapshot summary is required (optional) # string | The date before which snapshot summary is required (optional) + interval := `interval_example` // string | The interval indicating day or month. Defaults to month if not specified (optional) # string | The interval indicating day or month. Defaults to month if not specified (optional) + timeZone := `UTC` // string | The time zone. Defaults to UTC if not provided (optional) # string | The time zone. Defaults to UTC if not provided (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityHistoryAPI.GetIdentitySnapshotSummary(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.GetIdentitySnapshotSummary(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Before(before).Interval(interval).TimeZone(timeZone).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentitySnapshotSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySnapshotSummary`: []MetricResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentitySnapshotSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-start-date +:::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 + ``` +::: +Gets the start date of the identity +This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-start-date) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityStartDateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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.IdentityHistoryAPI.GetIdentityStartDate(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.GetIdentityStartDate(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentityStartDate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityStartDate`: string + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentityStartDate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-historical-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 + ``` +::: +Lists all the identities +This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-historical-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListHistoricalIdentitiesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **startsWithQuery** | **string** | This param is used for starts-with search for first, last and display name of the identity | + **isDeleted** | **bool** | Indicates if we want to only list down deleted identities or not. | + **isActive** | **bool** | Indicates if we want to only list active or inactive identities. | + **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 + +[**[]IdentityListItem**](../models/identity-list-item) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + startsWithQuery := `Ada` // string | This param is used for starts-with search for first, last and display name of the identity (optional) # string | This param is used for starts-with search for first, last and display name of the identity (optional) + isDeleted := true // bool | Indicates if we want to only list down deleted identities or not. (optional) # bool | Indicates if we want to only list down deleted identities or not. (optional) + isActive := true // bool | Indicates if we want to only list active or inactive identities. (optional) # bool | Indicates if we want to only list active or inactive identities. (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) + 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.V2025.IdentityHistoryAPI.ListHistoricalIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.ListHistoricalIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).StartsWithQuery(startsWithQuery).IsDeleted(isDeleted).IsActive(isActive).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListHistoricalIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListHistoricalIdentities`: []IdentityListItem + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListHistoricalIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-access-items +:::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 Access Items by Identity +This method retrieves a list of access item for the identity filtered by the access item type + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-identity-access-items) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityAccessItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **type_** | **string** | The type of access item for the identity. If not provided, it defaults to account | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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 + +[**[]ListIdentityAccessItems200ResponseInner**](../models/list-identity-access-items200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + type_ := `account` // string | The type of access item for the identity. If not provided, it defaults to account (optional) # string | The type of access item for the identity. If not provided, it defaults to account (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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.V2025.IdentityHistoryAPI.ListIdentityAccessItems(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.ListIdentityAccessItems(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Type_(type_).Limit(limit).Count(count).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentityAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityAccessItems`: []ListIdentityAccessItems200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentityAccessItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-snapshot-access-items +:::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 + ``` +::: +Gets the list of identity access items at a given date filterd by item type +This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-identity-snapshot-access-items) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | +**date** | **string** | The specified date | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentitySnapshotAccessItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **type_** | **string** | The access item type | + +### Return type + +[**[]ListIdentityAccessItems200ResponseInner**](../models/list-identity-access-items200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + date := `2007-03-01T13:00:00Z` // string | The specified date # string | The specified date + 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") + type_ := `account` // string | The access item type (optional) # string | The access item type (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityHistoryAPI.ListIdentitySnapshotAccessItems(context.Background(), id, date).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.ListIdentitySnapshotAccessItems(context.Background(), id, date).XSailPointExperimental(xSailPointExperimental).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentitySnapshotAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentitySnapshotAccessItems`: []ListIdentityAccessItems200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentitySnapshotAccessItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-snapshots +:::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 + ``` +::: +Lists all the snapshots for the identity +This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-identity-snapshots) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentitySnapshotsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **start** | **string** | The specified start date | + **interval** | **string** | The interval indicating the range in day or month for the specified interval-name | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]IdentitySnapshotSummaryResponse**](../models/identity-snapshot-summary-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + start := `2007-03-01T13:00:00Z` // string | The specified start date (optional) # string | The specified start date (optional) + interval := `interval_example` // string | The interval indicating the range in day or month for the specified interval-name (optional) # string | The interval indicating the range in day or month for the specified interval-name (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityHistoryAPI.ListIdentitySnapshots(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.ListIdentitySnapshots(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Start(start).Interval(interval).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentitySnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentitySnapshots`: []IdentitySnapshotSummaryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentitySnapshots`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/IdentityProfilesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/IdentityProfilesAPI.md new file mode 100644 index 000000000..d23677b42 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/IdentityProfilesAPI.md @@ -0,0 +1,894 @@ +--- +id: v2025-identity-profiles +title: IdentityProfiles +pagination_label: IdentityProfiles +sidebar_label: IdentityProfiles +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfiles', 'V2025IdentityProfiles'] +slug: /tools/sdk/go/v2025/methods/identity-profiles +tags: ['SDK', 'Software Development Kit', 'IdentityProfiles', 'V2025IdentityProfiles'] +--- + +# IdentityProfilesAPI + Use this API to implement identity profile functionality. +With this functionality in place, administrators can view identity profiles and their configurations. + +Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. + +In Identity Security Cloud, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. +This list shows some details about each identity profile, along with its status. +They can select an identity profile to view its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. + +Refer to [Creating Identity Profiles](https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html) for more information about identity profiles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-identity-profile**](#create-identity-profile) | **Post** `/identity-profiles` | Create Identity Profile +[**delete-identity-profile**](#delete-identity-profile) | **Delete** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile +[**delete-identity-profiles**](#delete-identity-profiles) | **Post** `/identity-profiles/bulk-delete` | Delete Identity Profiles +[**export-identity-profiles**](#export-identity-profiles) | **Get** `/identity-profiles/export` | Export Identity Profiles +[**generate-identity-preview**](#generate-identity-preview) | **Post** `/identity-profiles/identity-preview` | Generate Identity Profile Preview +[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **Get** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config +[**get-identity-profile**](#get-identity-profile) | **Get** `/identity-profiles/{identity-profile-id}` | Get Identity Profile +[**import-identity-profiles**](#import-identity-profiles) | **Post** `/identity-profiles/import` | Import Identity Profiles +[**list-identity-profiles**](#list-identity-profiles) | **Get** `/identity-profiles` | List Identity Profiles +[**sync-identity-profile**](#sync-identity-profile) | **Post** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile +[**update-identity-profile**](#update-identity-profile) | **Patch** `/identity-profiles/{identity-profile-id}` | Update Identity Profile + + +## create-identity-profile +Create Identity Profile +Creates an identity profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-identity-profile) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityProfile** | [**IdentityProfile**](../models/identity-profile) | | + +### Return type + +[**IdentityProfile**](../models/identity-profile) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityprofile := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + }`) // IdentityProfile | + + + var identityProfile v2025.IdentityProfile + if err := json.Unmarshal(identityprofile, &identityProfile); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.CreateIdentityProfile(context.Background()).IdentityProfile(identityProfile).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.CreateIdentityProfile(context.Background()).IdentityProfile(identityProfile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.CreateIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.CreateIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-identity-profile +Delete Identity Profile +Delete an identity profile by ID. +On success, this endpoint will return a reference to the bulk delete task result. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-identity-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**TaskResultSimplified**](../models/task-result-simplified) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.DeleteIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.DeleteIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.DeleteIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteIdentityProfile`: TaskResultSimplified + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.DeleteIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-identity-profiles +Delete Identity Profiles +This deletes multiple Identity Profiles via a list of supplied IDs. + +On success, this endpoint will return a reference to the bulk delete task result. + +The following rights are required to access this endpoint: idn:identity-profile:delete + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-identity-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityProfilesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestBody** | **[]string** | Identity Profile bulk delete request body. | + +### Return type + +[**TaskResultSimplified**](../models/task-result-simplified) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestbody := []byte(``) // []string | Identity Profile bulk delete request body. + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.DeleteIdentityProfiles(context.Background()).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.DeleteIdentityProfiles(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.DeleteIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteIdentityProfiles`: TaskResultSimplified + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.DeleteIdentityProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## export-identity-profiles +Export Identity Profiles +This exports existing identity profiles in the format specified by the sp-config service. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/export-identity-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportIdentityProfilesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ne* **name**: *eq, ne* **priority**: *eq, ne* | + **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: **id, name, priority** | + +### Return type + +[**[]IdentityProfileExportedObject**](../models/identity-profile-exported-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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, ne* **name**: *eq, ne* **priority**: *eq, ne* (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, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + sorters := `id,name` // 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: **id, name, priority** (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: **id, name, priority** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.ExportIdentityProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.ExportIdentityProfiles(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ExportIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportIdentityProfiles`: []IdentityProfileExportedObject + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ExportIdentityProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## generate-identity-preview +:::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 + ``` +::: +Generate Identity Profile Preview +This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy''s attribute config is applied. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/generate-identity-preview) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGenerateIdentityPreviewRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **identityPreviewRequest** | [**IdentityPreviewRequest**](../models/identity-preview-request) | Identity Preview request body. | + +### Return type + +[**IdentityPreviewResponse**](../models/identity-preview-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + identitypreviewrequest := []byte(`{ + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + }`) // IdentityPreviewRequest | Identity Preview request body. + + + var identityPreviewRequest v2025.IdentityPreviewRequest + if err := json.Unmarshal(identitypreviewrequest, &identityPreviewRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.GenerateIdentityPreview(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityPreviewRequest(identityPreviewRequest).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.GenerateIdentityPreview(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityPreviewRequest(identityPreviewRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GenerateIdentityPreview``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GenerateIdentityPreview`: IdentityPreviewResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GenerateIdentityPreview`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-default-identity-attribute-config +Get default Identity Attribute Config +This returns the default identity attribute config. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-default-identity-attribute-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | The Identity Profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDefaultIdentityAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityAttributeConfig**](../models/identity-attribute-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | The Identity Profile ID. # string | The Identity Profile ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.GetDefaultIdentityAttributeConfig(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.GetDefaultIdentityAttributeConfig(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GetDefaultIdentityAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDefaultIdentityAttributeConfig`: IdentityAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GetDefaultIdentityAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-profile +Get Identity Profile +Get a single identity profile by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-identity-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityProfile**](../models/identity-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.GetIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.GetIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GetIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GetIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-identity-profiles +Import Identity Profiles +This imports previously exported identity profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/import-identity-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportIdentityProfilesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityProfileExportedObject** | [**[]IdentityProfileExportedObject**](../models/identity-profile-exported-object) | Previously exported Identity Profiles. | + +### Return type + +[**ObjectImportResult**](../models/object-import-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityprofileexportedobject := []byte(``) // []IdentityProfileExportedObject | Previously exported Identity Profiles. + + + var identityProfileExportedObject v2025.[]IdentityProfileExportedObject + if err := json.Unmarshal(identityprofileexportedobject, &identityProfileExportedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.ImportIdentityProfiles(context.Background()).IdentityProfileExportedObject(identityProfileExportedObject).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.ImportIdentityProfiles(context.Background()).IdentityProfileExportedObject(identityProfileExportedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ImportIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportIdentityProfiles`: ObjectImportResult + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ImportIdentityProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-profiles +List Identity Profiles +Get a list of identity profiles, based on the specified query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-identity-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityProfilesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* | + **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: **id, name, priority, created, modified, owner.id, owner.name** | + +### Return type + +[**[]IdentityProfile**](../models/identity-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) + sorters := `id,name` // 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: **id, name, priority, created, modified, owner.id, owner.name** (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: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.ListIdentityProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.ListIdentityProfiles(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ListIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityProfiles`: []IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ListIdentityProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## sync-identity-profile +Process identities under profile +Process identities under the profile +This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. +This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. +This operation will perform the following activities on all identities under the identity profile. +1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/sync-identity-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | The Identity Profile ID to be processed | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSyncIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | The Identity Profile ID to be processed # string | The Identity Profile ID to be processed + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.SyncIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.SyncIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.SyncIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SyncIdentityProfile`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.SyncIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-identity-profile +Update Identity Profile +Update a specified identity profile with this PATCH request. + +You cannot update these fields: +* id +* created +* modified +* identityCount +* identityRefreshRequired +* Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-identity-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +[**IdentityProfile**](../models/identity-profile) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + jsonpatchoperation := []byte(`[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]`) // []JsonPatchOperation | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.UpdateIdentityProfile(context.Background(), identityProfileId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.UpdateIdentityProfile(context.Background(), identityProfileId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.UpdateIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.UpdateIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/Index.md b/docs/tools/sdk/go/Reference/V2025/Methods/Index.md new file mode 100644 index 000000000..47ba7b9a4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/Index.md @@ -0,0 +1,29 @@ +--- +id: methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_class_name: methods +keywords: ['go', 'Golang', 'sdk', 'methods'] +slug: /tools/sdk/go/v2025/methods +tags: ['SDK', 'Software Development Kit', 'v2025', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the Python SDK for **V2025** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/LifecycleStatesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/LifecycleStatesAPI.md new file mode 100644 index 000000000..3667f3e01 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/LifecycleStatesAPI.md @@ -0,0 +1,524 @@ +--- +id: v2025-lifecycle-states +title: LifecycleStates +pagination_label: LifecycleStates +sidebar_label: LifecycleStates +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LifecycleStates', 'V2025LifecycleStates'] +slug: /tools/sdk/go/v2025/methods/lifecycle-states +tags: ['SDK', 'Software Development Kit', 'LifecycleStates', 'V2025LifecycleStates'] +--- + +# LifecycleStatesAPI + Use this API to implement and customize lifecycle state functionality. +With this functionality in place, administrators can create and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have. + +A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with Identity Security Cloud: 'Active' and 'Inactive.' +When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. +The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. +This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. + +Administrators can create a variety of custom lifecycle states. Refer to [Planning New Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#planning-new-lifecycle-states) for some custom lifecycle state ideas. + +Administrators must define the criteria for being in each lifecycle state, and they must define how Identity Security Cloud manages users' access to apps and sources for each lifecycle state. + +In Identity Security Cloud, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to either select the lifecycle state they want to modify or create a new lifecycle state. + +In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: + +- Enable/disable the lifecycle state for the identity profile. + +- Enable/disable source accounts for the identity profile's lifecycle state. + +- Add existing access profiles to grant to the identity profiles in that lifecycle state. + +- Create a new access profile to grant to the identity profile in that lifecycle state. + +Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. +To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. +For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states. + +During scheduled refreshes, Identity Security Cloud evaluates lifecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. +If the identities are missing access, Identity Security Cloud provisions that access. + +Administrators can also use the 'Provisioning' tab to configure email notifications for Identity Security Cloud to send whenever an identity with that identity profile has a lifecycle state change. +Refer to [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so. + +An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' +Refer to [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. + +Refer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-lifecycle-state**](#create-lifecycle-state) | **Post** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create Lifecycle State +[**delete-lifecycle-state**](#delete-lifecycle-state) | **Delete** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete Lifecycle State +[**get-lifecycle-state**](#get-lifecycle-state) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State +[**get-lifecycle-states**](#get-lifecycle-states) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists LifecycleStates +[**set-lifecycle-state**](#set-lifecycle-state) | **Post** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State +[**update-lifecycle-states**](#update-lifecycle-states) | **Patch** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State + + +## create-lifecycle-state +Create Lifecycle State +Use this endpoint to create a lifecycle state. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-lifecycle-state) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateLifecycleStateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **lifecycleState** | [**LifecycleState**](../models/lifecycle-state) | Lifecycle state to be created. | + +### Return type + +[**LifecycleState**](../models/lifecycle-state) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile ID. + lifecyclestate := []byte(`{ + "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], + "emailNotificationOption" : { + "notifyManagers" : true, + "notifySpecificUsers" : true, + "emailAddressList" : [ "test@test.com", "test2@test.com" ], + "notifyAllAdmins" : true + }, + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Lifecycle description", + "accountActions" : [ { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }, { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } ], + "id" : "id12345", + "identityCount" : 42, + "technicalName" : "Technical Name", + "identityState" : "identityState", + "enabled" : true + }`) // LifecycleState | Lifecycle state to be created. + + + var lifecycleState v2025.LifecycleState + if err := json.Unmarshal(lifecyclestate, &lifecycleState); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.LifecycleStatesAPI.CreateLifecycleState(context.Background(), identityProfileId).LifecycleState(lifecycleState).Execute() + //resp, r, err := apiClient.V2025.LifecycleStatesAPI.CreateLifecycleState(context.Background(), identityProfileId).LifecycleState(lifecycleState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.CreateLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateLifecycleState`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.CreateLifecycleState`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-lifecycle-state +Delete Lifecycle State +Use this endpoint to delete the lifecycle state by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-lifecycle-state) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | +**lifecycleStateId** | **string** | Lifecycle state ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteLifecycleStateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**LifecyclestateDeleted**](../models/lifecyclestate-deleted) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.LifecycleStatesAPI.DeleteLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + //resp, r, err := apiClient.V2025.LifecycleStatesAPI.DeleteLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.DeleteLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteLifecycleState`: LifecyclestateDeleted + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.DeleteLifecycleState`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-lifecycle-state +Get Lifecycle State +Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-lifecycle-state) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | +**lifecycleStateId** | **string** | Lifecycle state ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLifecycleStateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**LifecycleState**](../models/lifecycle-state) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.LifecycleStatesAPI.GetLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + //resp, r, err := apiClient.V2025.LifecycleStatesAPI.GetLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.GetLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLifecycleState`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.GetLifecycleState`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-lifecycle-states +Lists LifecycleStates +Use this endpoint to list all lifecycle states by their associated identity profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-lifecycle-states) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLifecycleStatesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **created, modified** | + +### Return type + +[**[]LifecycleState**](../models/lifecycle-state) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `created,modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.LifecycleStatesAPI.GetLifecycleStates(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2025.LifecycleStatesAPI.GetLifecycleStates(context.Background(), identityProfileId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.GetLifecycleStates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLifecycleStates`: []LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.GetLifecycleStates`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-lifecycle-state +Set Lifecycle State +Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-lifecycle-state) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | ID of the identity to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetLifecycleStateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **setLifecycleStateRequest** | [**SetLifecycleStateRequest**](../models/set-lifecycle-state-request) | | + +### Return type + +[**SetLifecycleState200Response**](../models/set-lifecycle-state200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `2c9180857893f1290178944561990364` // string | ID of the identity to update. # string | ID of the identity to update. + setlifecyclestaterequest := []byte(``) // SetLifecycleStateRequest | + + + var setLifecycleStateRequest v2025.SetLifecycleStateRequest + if err := json.Unmarshal(setlifecyclestaterequest, &setLifecycleStateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.LifecycleStatesAPI.SetLifecycleState(context.Background(), identityId).SetLifecycleStateRequest(setLifecycleStateRequest).Execute() + //resp, r, err := apiClient.V2025.LifecycleStatesAPI.SetLifecycleState(context.Background(), identityId).SetLifecycleStateRequest(setLifecycleStateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.SetLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetLifecycleState`: SetLifecycleState200Response + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.SetLifecycleState`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-lifecycle-states +Update Lifecycle State +Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-lifecycle-states) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | +**lifecycleStateId** | **string** | Lifecycle state ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateLifecycleStatesRequest struct via the builder pattern + + +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 | + +### Return type + +[**LifecycleState**](../models/lifecycle-state) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.LifecycleStatesAPI.UpdateLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.LifecycleStatesAPI.UpdateLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.UpdateLifecycleStates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateLifecycleStates`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.UpdateLifecycleStates`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/MFAConfigurationAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/MFAConfigurationAPI.md new file mode 100644 index 000000000..de325c09f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/MFAConfigurationAPI.md @@ -0,0 +1,488 @@ +--- +id: v2025-mfa-configuration +title: MFAConfiguration +pagination_label: MFAConfiguration +sidebar_label: MFAConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MFAConfiguration', 'V2025MFAConfiguration'] +slug: /tools/sdk/go/v2025/methods/mfa-configuration +tags: ['SDK', 'Software Development Kit', 'MFAConfiguration', 'V2025MFAConfiguration'] +--- + +# MFAConfigurationAPI + Configure and test multifactor authentication (MFA) methods +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-mfa-duo-config**](#get-mfa-duo-config) | **Get** `/mfa/duo-web/config` | Configuration of Duo MFA method +[**get-mfa-kba-config**](#get-mfa-kba-config) | **Get** `/mfa/kba/config` | Configuration of KBA MFA method +[**get-mfa-okta-config**](#get-mfa-okta-config) | **Get** `/mfa/okta-verify/config` | Configuration of Okta MFA method +[**set-mfa-duo-config**](#set-mfa-duo-config) | **Put** `/mfa/duo-web/config` | Set Duo MFA configuration +[**set-mfakba-config**](#set-mfakba-config) | **Post** `/mfa/kba/config/answers` | Set MFA KBA configuration +[**set-mfa-okta-config**](#set-mfa-okta-config) | **Put** `/mfa/okta-verify/config` | Set Okta MFA configuration +[**test-mfa-config**](#test-mfa-config) | **Get** `/mfa/{method}/test` | MFA method's test configuration + + +## get-mfa-duo-config +Configuration of Duo MFA method +This API returns the configuration of an Duo MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-mfa-duo-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMFADuoConfigRequest struct via the builder pattern + + +### Return type + +[**MfaDuoConfig**](../models/mfa-duo-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MFAConfigurationAPI.GetMFADuoConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.MFAConfigurationAPI.GetMFADuoConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFADuoConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFADuoConfig`: MfaDuoConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFADuoConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-mfa-kba-config +Configuration of KBA MFA method +This API returns the KBA configuration for MFA. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-mfa-kba-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMFAKbaConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allLanguages** | **bool** | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false | + +### Return type + +[**[]KbaQuestion**](../models/kba-question) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + allLanguages := allLanguages=true // bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MFAConfigurationAPI.GetMFAKbaConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.MFAConfigurationAPI.GetMFAKbaConfig(context.Background()).AllLanguages(allLanguages).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFAKbaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFAKbaConfig`: []KbaQuestion + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFAKbaConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-mfa-okta-config +Configuration of Okta MFA method +This API returns the configuration of an Okta MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-mfa-okta-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMFAOktaConfigRequest struct via the builder pattern + + +### Return type + +[**MfaOktaConfig**](../models/mfa-okta-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MFAConfigurationAPI.GetMFAOktaConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.MFAConfigurationAPI.GetMFAOktaConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFAOktaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFAOktaConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFAOktaConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-mfa-duo-config +Set Duo MFA configuration +This API sets the configuration of an Duo MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-mfa-duo-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetMFADuoConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mfaDuoConfig** | [**MfaDuoConfig**](../models/mfa-duo-config) | | + +### Return type + +[**MfaDuoConfig**](../models/mfa-duo-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + mfaduoconfig := []byte(`{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }`) // MfaDuoConfig | + + + var mfaDuoConfig v2025.MfaDuoConfig + if err := json.Unmarshal(mfaduoconfig, &mfaDuoConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MFAConfigurationAPI.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute() + //resp, r, err := apiClient.V2025.MFAConfigurationAPI.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFADuoConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFADuoConfig`: MfaDuoConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFADuoConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-mfakba-config +Set MFA KBA configuration +This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-mfakba-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetMFAKBAConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **kbaAnswerRequestItem** | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | | + +### Return type + +[**[]KbaAnswerResponseItem**](../models/kba-answer-response-item) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + kbaanswerrequestitem := []byte(`[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]`) // []KbaAnswerRequestItem | + + + var kbaAnswerRequestItem v2025.[]KbaAnswerRequestItem + if err := json.Unmarshal(kbaanswerrequestitem, &kbaAnswerRequestItem); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MFAConfigurationAPI.SetMFAKBAConfig(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + //resp, r, err := apiClient.V2025.MFAConfigurationAPI.SetMFAKBAConfig(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFAKBAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFAKBAConfig`: []KbaAnswerResponseItem + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFAKBAConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-mfa-okta-config +Set Okta MFA configuration +This API sets the configuration of an Okta MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-mfa-okta-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetMFAOktaConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mfaOktaConfig** | [**MfaOktaConfig**](../models/mfa-okta-config) | | + +### Return type + +[**MfaOktaConfig**](../models/mfa-okta-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + mfaoktaconfig := []byte(`{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }`) // MfaOktaConfig | + + + var mfaOktaConfig v2025.MfaOktaConfig + if err := json.Unmarshal(mfaoktaconfig, &mfaOktaConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MFAConfigurationAPI.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute() + //resp, r, err := apiClient.V2025.MFAConfigurationAPI.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFAOktaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFAOktaConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFAOktaConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-mfa-config +MFA method's test configuration +This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/test-mfa-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**method** | **string** | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestMFAConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**MfaConfigTestResponse**](../models/mfa-config-test-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + method := `okta-verify` // string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MFAConfigurationAPI.TestMFAConfig(context.Background(), method).Execute() + //resp, r, err := apiClient.V2025.MFAConfigurationAPI.TestMFAConfig(context.Background(), method).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.TestMFAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestMFAConfig`: MfaConfigTestResponse + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.TestMFAConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/MachineAccountsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/MachineAccountsAPI.md new file mode 100644 index 000000000..33119e1e5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/MachineAccountsAPI.md @@ -0,0 +1,272 @@ +--- +id: v2025-machine-accounts +title: MachineAccounts +pagination_label: MachineAccounts +sidebar_label: MachineAccounts +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MachineAccounts', 'V2025MachineAccounts'] +slug: /tools/sdk/go/v2025/methods/machine-accounts +tags: ['SDK', 'Software Development Kit', 'MachineAccounts', 'V2025MachineAccounts'] +--- + +# MachineAccountsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-machine-account**](#get-machine-account) | **Get** `/machine-accounts/{id}` | Machine Account Details +[**list-machine-accounts**](#list-machine-accounts) | **Get** `/machine-accounts` | Machine Accounts List +[**update-machine-account**](#update-machine-account) | **Patch** `/machine-accounts/{id}` | Update a Machine Account + + +## get-machine-account +:::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 + ``` +::: +Machine Account Details +Use this API to return the details for a single machine account by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-machine-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Machine Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMachineAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**MachineAccount**](../models/machine-account) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Account ID. # string | Machine 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.MachineAccountsAPI.GetMachineAccount(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.MachineAccountsAPI.GetMachineAccount(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountsAPI.GetMachineAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMachineAccount`: MachineAccount + fmt.Fprintf(os.Stdout, "Response from `MachineAccountsAPI.GetMachineAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-machine-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 + ``` +::: +Machine Accounts List +This returns a list of machine accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-machine-accounts) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListMachineAccountsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *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: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** | + +### Return type + +[**[]MachineAccount**](../models/machine-account) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `identityId eq "2c9180858082150f0180893dbaf44201"` // 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, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *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, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) + sorters := `id,name` // 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: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (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: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MachineAccountsAPI.ListMachineAccounts(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.MachineAccountsAPI.ListMachineAccounts(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountsAPI.ListMachineAccounts``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListMachineAccounts`: []MachineAccount + fmt.Fprintf(os.Stdout, "Response from `MachineAccountsAPI.ListMachineAccounts`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-machine-account +:::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 a Machine Account +Use this API to update machine accounts details. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-machine-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Machine Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateMachineAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **requestBody** | **[]map[string]interface{}** | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes | + +### Return type + +[**MachineAccount**](../models/machine-account) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Account ID. # string | Machine 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") + requestbody := []byte(`[{op=add, path=/environment, value=test}]`) // []map[string]interface{} | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MachineAccountsAPI.UpdateMachineAccount(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2025.MachineAccountsAPI.UpdateMachineAccount(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountsAPI.UpdateMachineAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateMachineAccount`: MachineAccount + fmt.Fprintf(os.Stdout, "Response from `MachineAccountsAPI.UpdateMachineAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/MachineIdentitiesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/MachineIdentitiesAPI.md new file mode 100644 index 000000000..1525c9b4c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/MachineIdentitiesAPI.md @@ -0,0 +1,442 @@ +--- +id: v2025-machine-identities +title: MachineIdentities +pagination_label: MachineIdentities +sidebar_label: MachineIdentities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MachineIdentities', 'V2025MachineIdentities'] +slug: /tools/sdk/go/v2025/methods/machine-identities +tags: ['SDK', 'Software Development Kit', 'MachineIdentities', 'V2025MachineIdentities'] +--- + +# MachineIdentitiesAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-machine-identity**](#create-machine-identity) | **Post** `/machine-identities` | Create Machine Identities +[**delete-machine-identity**](#delete-machine-identity) | **Delete** `/machine-identities/{id}` | Delete machine identity +[**get-machine-identity**](#get-machine-identity) | **Get** `/machine-identities/{id}` | Machine Identity Details +[**list-machine-identities**](#list-machine-identities) | **Get** `/machine-identities` | List Machine Identities +[**update-machine-identity**](#update-machine-identity) | **Patch** `/machine-identities/{id}` | Update a Machine Identity + + +## create-machine-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 + ``` +::: +Create Machine Identities +Use this API to create a machine identity. +The maximum supported length for the description field is 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-machine-identity) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateMachineIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **machineIdentity** | [**MachineIdentity**](../models/machine-identity) | | + +### Return type + +[**MachineIdentity**](../models/machine-identity) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + machineidentity := []byte(`{ + "created" : "2015-05-28T14:07:17Z", + "businessApplication" : "ADService", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "", + "attributes" : "{\"Region\":\"EU\"}", + "id" : "id12345", + "manuallyEdited" : true + }`) // MachineIdentity | + + + var machineIdentity v2025.MachineIdentity + if err := json.Unmarshal(machineidentity, &machineIdentity); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MachineIdentitiesAPI.CreateMachineIdentity(context.Background()).XSailPointExperimental(xSailPointExperimental).MachineIdentity(machineIdentity).Execute() + //resp, r, err := apiClient.V2025.MachineIdentitiesAPI.CreateMachineIdentity(context.Background()).XSailPointExperimental(xSailPointExperimental).MachineIdentity(machineIdentity).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.CreateMachineIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateMachineIdentity`: MachineIdentity + fmt.Fprintf(os.Stdout, "Response from `MachineIdentitiesAPI.CreateMachineIdentity`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-machine-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 machine identity +The API returns successful response if the requested machine identity was deleted. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-machine-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Machine Identity ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteMachineIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Identity ID # string | Machine 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.V2025.MachineIdentitiesAPI.DeleteMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.MachineIdentitiesAPI.DeleteMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.DeleteMachineIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-machine-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 + ``` +::: +Machine Identity Details +This API returns a single machine identity using the Machine Identity ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-machine-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Machine Identity ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMachineIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**MachineIdentity**](../models/machine-identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Identity ID # string | Machine 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.MachineIdentitiesAPI.GetMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.MachineIdentitiesAPI.GetMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.GetMachineIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMachineIdentity`: MachineIdentity + fmt.Fprintf(os.Stdout, "Response from `MachineIdentitiesAPI.GetMachineIdentity`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-machine-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 Machine Identities +This API returns a list of machine identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-machine-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListMachineIdentitiesRequest struct via the builder pattern + + +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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *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: **businessApplication, name** | + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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 + +[**[]MachineIdentity**](../models/machine-identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 := `identityId eq "2c9180858082150f0180893dbaf44201"` // 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) + sorters := `businessApplication` // 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: **businessApplication, name** (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: **businessApplication, name** (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.V2025.MachineIdentitiesAPI.ListMachineIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.MachineIdentitiesAPI.ListMachineIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).Filters(filters).Sorters(sorters).Count(count).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.ListMachineIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListMachineIdentities`: []MachineIdentity + fmt.Fprintf(os.Stdout, "Response from `MachineIdentitiesAPI.ListMachineIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-machine-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 + ``` +::: +Update a Machine Identity +Use this API to update machine identity details. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-machine-identity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Machine Identity ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateMachineIdentityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **requestBody** | **[]map[string]interface{}** | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +[**MachineIdentity**](../models/machine-identity) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Identity ID. # string | Machine 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") + requestbody := []byte(`[{op=add, path=/attributes/securityRisk, value=medium}]`) // []map[string]interface{} | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MachineIdentitiesAPI.UpdateMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2025.MachineIdentitiesAPI.UpdateMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.UpdateMachineIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateMachineIdentity`: MachineIdentity + fmt.Fprintf(os.Stdout, "Response from `MachineIdentitiesAPI.UpdateMachineIdentity`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClientsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClientsAPI.md new file mode 100644 index 000000000..72adcd9bb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClientsAPI.md @@ -0,0 +1,441 @@ +--- +id: v2025-managed-clients +title: ManagedClients +pagination_label: ManagedClients +sidebar_label: ManagedClients +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClients', 'V2025ManagedClients'] +slug: /tools/sdk/go/v2025/methods/managed-clients +tags: ['SDK', 'Software Development Kit', 'ManagedClients', 'V2025ManagedClients'] +--- + +# ManagedClientsAPI + Use this API to implement managed client functionality. +With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-managed-client**](#create-managed-client) | **Post** `/managed-clients` | Create Managed Client +[**delete-managed-client**](#delete-managed-client) | **Delete** `/managed-clients/{id}` | Delete Managed Client +[**get-managed-client**](#get-managed-client) | **Get** `/managed-clients/{id}` | Get Managed Client +[**get-managed-client-status**](#get-managed-client-status) | **Get** `/managed-clients/{id}/status` | Get Managed Client Status +[**get-managed-clients**](#get-managed-clients) | **Get** `/managed-clients` | Get Managed Clients +[**update-managed-client**](#update-managed-client) | **Patch** `/managed-clients/{id}` | Update Managed Client + + +## create-managed-client +Create Managed Client +Create a new managed client. +The API returns a result that includes the managed client ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-managed-client) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateManagedClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **managedClientRequest** | [**ManagedClientRequest**](../models/managed-client-request) | | + +### Return type + +[**ManagedClient**](../models/managed-client) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + managedclientrequest := []byte(`{ + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + }`) // ManagedClientRequest | + + + var managedClientRequest v2025.ManagedClientRequest + if err := json.Unmarshal(managedclientrequest, &managedClientRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClientsAPI.CreateManagedClient(context.Background()).ManagedClientRequest(managedClientRequest).Execute() + //resp, r, err := apiClient.V2025.ManagedClientsAPI.CreateManagedClient(context.Background()).ManagedClientRequest(managedClientRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.CreateManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.CreateManagedClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-managed-client +Delete Managed Client +Delete an existing managed client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-managed-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed client ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteManagedClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ManagedClientsAPI.DeleteManagedClient(context.Background(), id).Execute() + //r, err := apiClient.V2025.ManagedClientsAPI.DeleteManagedClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.DeleteManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-managed-client +Get Managed Client +Get managed client by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed client ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ManagedClient**](../models/managed-client) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClientsAPI.GetManagedClient(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ManagedClientsAPI.GetManagedClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-managed-client-status +Get Managed Client Status +Get a managed client's status, using its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-client-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed client ID to get status for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClientStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **type_** | [**ManagedClientType**](../models/managed-client-type) | Managed client type to get status for. | + +### Return type + +[**ManagedClientStatus**](../models/managed-client-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `aClientId` // string | Managed client ID to get status for. # string | Managed client ID to get status for. + type_ := // ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClientsAPI.GetManagedClientStatus(context.Background(), id).Type_(type_).Execute() + //resp, r, err := apiClient.V2025.ManagedClientsAPI.GetManagedClientStatus(context.Background(), id).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClientStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClientStatus`: ManagedClientStatus + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClientStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-managed-clients +Get Managed Clients +List managed clients. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-clients) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClientsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* | + +### Return type + +[**[]ManagedClient**](../models/managed-client) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "client name"` // 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* **name**: *eq* **clientId**: *eq* **clusterId**: *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* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClientsAPI.GetManagedClients(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ManagedClientsAPI.GetManagedClients(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClients``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClients`: []ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClients`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-managed-client +Update Managed Client +Update an existing managed client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-managed-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed client ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateManagedClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | JSONPatch payload used to update the object. | + +### Return type + +[**ManagedClient**](../models/managed-client) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | JSONPatch payload used to update the object. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClientsAPI.UpdateManagedClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.ManagedClientsAPI.UpdateManagedClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.UpdateManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.UpdateManagedClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClusterTypesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClusterTypesAPI.md new file mode 100644 index 000000000..37f67098a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClusterTypesAPI.md @@ -0,0 +1,386 @@ +--- +id: v2025-managed-cluster-types +title: ManagedClusterTypes +pagination_label: ManagedClusterTypes +sidebar_label: ManagedClusterTypes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterTypes', 'V2025ManagedClusterTypes'] +slug: /tools/sdk/go/v2025/methods/managed-cluster-types +tags: ['SDK', 'Software Development Kit', 'ManagedClusterTypes', 'V2025ManagedClusterTypes'] +--- + +# ManagedClusterTypesAPI + Use this API to implement managed cluster types functionality. +With this functionality in place, administrators can modify and delete existing managed cluster types and create new ones. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-managed-cluster-type**](#create-managed-cluster-type) | **Post** `/managed-cluster-types` | Create new Managed Cluster Type +[**delete-managed-cluster-type**](#delete-managed-cluster-type) | **Delete** `/managed-cluster-types/{id}` | Delete a Managed Cluster Type +[**get-managed-cluster-type**](#get-managed-cluster-type) | **Get** `/managed-cluster-types/{id}` | Get a Managed Cluster Type +[**get-managed-cluster-types**](#get-managed-cluster-types) | **Get** `/managed-cluster-types` | List Managed Cluster Types +[**update-managed-cluster-type**](#update-managed-cluster-type) | **Patch** `/managed-cluster-types/{id}` | Update a Managed Cluster Type + + +## create-managed-cluster-type +Create new Managed Cluster Type +Create a new Managed Cluster Type. + +The API returns a result that includes the Managed Cluster Type ID + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-managed-cluster-type) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateManagedClusterTypeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **managedClusterType** | [**ManagedClusterType**](../models/managed-cluster-type) | | + +### Return type + +[**ManagedClusterType**](../models/managed-cluster-type) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + managedclustertype := []byte(`{ + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + }`) // ManagedClusterType | + + + var managedClusterType v2025.ManagedClusterType + if err := json.Unmarshal(managedclustertype, &managedClusterType); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClusterTypesAPI.CreateManagedClusterType(context.Background()).ManagedClusterType(managedClusterType).Execute() + //resp, r, err := apiClient.V2025.ManagedClusterTypesAPI.CreateManagedClusterType(context.Background()).ManagedClusterType(managedClusterType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.CreateManagedClusterType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateManagedClusterType`: ManagedClusterType + fmt.Fprintf(os.Stdout, "Response from `ManagedClusterTypesAPI.CreateManagedClusterType`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-managed-cluster-type +Delete a Managed Cluster Type +Delete an existing Managed Cluster Type. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-managed-cluster-type) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Managed Cluster Type ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteManagedClusterTypeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `aClusterTypeId` // string | The Managed Cluster Type ID # string | The Managed Cluster Type ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ManagedClusterTypesAPI.DeleteManagedClusterType(context.Background(), id).Execute() + //r, err := apiClient.V2025.ManagedClusterTypesAPI.DeleteManagedClusterType(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.DeleteManagedClusterType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-managed-cluster-type +Get a Managed Cluster Type +Get a Managed Cluster Type. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-cluster-type) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Managed Cluster Type ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClusterTypeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ManagedClusterType**](../models/managed-cluster-type) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `aClusterTypeId` // string | The Managed Cluster Type ID # string | The Managed Cluster Type ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClusterTypesAPI.GetManagedClusterType(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ManagedClusterTypesAPI.GetManagedClusterType(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.GetManagedClusterType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClusterType`: ManagedClusterType + fmt.Fprintf(os.Stdout, "Response from `ManagedClusterTypesAPI.GetManagedClusterType`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-managed-cluster-types +List Managed Cluster Types +Get a list of Managed Cluster Types. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-cluster-types) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClusterTypesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type_** | **string** | Type descriptor | + **pod** | **string** | Pinned pod (or default) | + **org** | **string** | Pinned org (or default) | + **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] + **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] + +### Return type + +[**[]ManagedClusterType**](../models/managed-cluster-type) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `IDN` // string | Type descriptor (optional) # string | Type descriptor (optional) + pod := `megapod-useast1` // string | Pinned pod (or default) (optional) # string | Pinned pod (or default) (optional) + org := `denali-xyz` // string | Pinned org (or default) (optional) # string | Pinned org (or default) (optional) + 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) + 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) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClusterTypesAPI.GetManagedClusterTypes(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ManagedClusterTypesAPI.GetManagedClusterTypes(context.Background()).Type_(type_).Pod(pod).Org(org).Offset(offset).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.GetManagedClusterTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClusterTypes`: []ManagedClusterType + fmt.Fprintf(os.Stdout, "Response from `ManagedClusterTypesAPI.GetManagedClusterTypes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-managed-cluster-type +Update a Managed Cluster Type +Update an existing Managed Cluster Type. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-managed-cluster-type) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Managed Cluster Type ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateManagedClusterTypeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatch** | [**JsonPatch**](../models/json-patch) | The JSONPatch payload used to update the schema. | + +### Return type + +[**ManagedClusterType**](../models/managed-cluster-type) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `aClusterTypeId` // string | The Managed Cluster Type ID # string | The Managed Cluster Type ID + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | The JSONPatch payload used to update the schema. + + + var jsonPatch v2025.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClusterTypesAPI.UpdateManagedClusterType(context.Background(), id).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2025.ManagedClusterTypesAPI.UpdateManagedClusterType(context.Background(), id).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.UpdateManagedClusterType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedClusterType`: ManagedClusterType + fmt.Fprintf(os.Stdout, "Response from `ManagedClusterTypesAPI.UpdateManagedClusterType`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClustersAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClustersAPI.md new file mode 100644 index 000000000..ab9e87e7d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ManagedClustersAPI.md @@ -0,0 +1,587 @@ +--- +id: v2025-managed-clusters +title: ManagedClusters +pagination_label: ManagedClusters +sidebar_label: ManagedClusters +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusters', 'V2025ManagedClusters'] +slug: /tools/sdk/go/v2025/methods/managed-clusters +tags: ['SDK', 'Software Development Kit', 'ManagedClusters', 'V2025ManagedClusters'] +--- + +# ManagedClustersAPI + Use this API to implement managed cluster functionality. +With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-managed-cluster**](#create-managed-cluster) | **Post** `/managed-clusters` | Create Create Managed Cluster +[**delete-managed-cluster**](#delete-managed-cluster) | **Delete** `/managed-clusters/{id}` | Delete Managed Cluster +[**get-client-log-configuration**](#get-client-log-configuration) | **Get** `/managed-clusters/{id}/log-config` | Get Managed Cluster Log Configuration +[**get-managed-cluster**](#get-managed-cluster) | **Get** `/managed-clusters/{id}` | Get Managed Cluster +[**get-managed-clusters**](#get-managed-clusters) | **Get** `/managed-clusters` | Get Managed Clusters +[**put-client-log-configuration**](#put-client-log-configuration) | **Put** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration +[**update**](#update) | **Post** `/managed-clusters/{id}/manualUpgrade` | Trigger Manual Upgrade for Managed Cluster +[**update-managed-cluster**](#update-managed-cluster) | **Patch** `/managed-clusters/{id}` | Update Managed Cluster + + +## create-managed-cluster +Create Create Managed Cluster +Create a new Managed Cluster. +The API returns a result that includes the managed cluster ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-managed-cluster) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateManagedClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **managedClusterRequest** | [**ManagedClusterRequest**](../models/managed-cluster-request) | | + +### Return type + +[**ManagedCluster**](../models/managed-cluster) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + managedclusterrequest := []byte(`{ + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + }`) // ManagedClusterRequest | + + + var managedClusterRequest v2025.ManagedClusterRequest + if err := json.Unmarshal(managedclusterrequest, &managedClusterRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClustersAPI.CreateManagedCluster(context.Background()).ManagedClusterRequest(managedClusterRequest).Execute() + //resp, r, err := apiClient.V2025.ManagedClustersAPI.CreateManagedCluster(context.Background()).ManagedClusterRequest(managedClusterRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.CreateManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.CreateManagedCluster`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-managed-cluster +Delete Managed Cluster +Delete an existing managed cluster. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-managed-cluster) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed cluster ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteManagedClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **removeClients** | **bool** | Flag to determine the need to delete a cluster with clients. | [default to false] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + removeClients := false // bool | Flag to determine the need to delete a cluster with clients. (optional) (default to false) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ManagedClustersAPI.DeleteManagedCluster(context.Background(), id).Execute() + //r, err := apiClient.V2025.ManagedClustersAPI.DeleteManagedCluster(context.Background(), id).RemoveClients(removeClients).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.DeleteManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-client-log-configuration +Get Managed Cluster Log Configuration +Get a managed cluster's log configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-client-log-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of managed cluster to get log configuration for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetClientLogConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ClientLogConfiguration**](../models/client-log-configuration) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | ID of managed cluster to get log configuration for. # string | ID of managed cluster to get log configuration for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClustersAPI.GetClientLogConfiguration(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ManagedClustersAPI.GetClientLogConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetClientLogConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetClientLogConfiguration`: ClientLogConfiguration + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetClientLogConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-managed-cluster +Get Managed Cluster +Get a managed cluster by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-cluster) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed cluster ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ManagedCluster**](../models/managed-cluster) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClustersAPI.GetManagedCluster(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ManagedClustersAPI.GetManagedCluster(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetManagedCluster`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-managed-clusters +Get Managed Clusters +List current organization's managed clusters, based on request context. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-clusters) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClustersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **operational**: *eq* | + +### Return type + +[**[]ManagedCluster**](../models/managed-cluster) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `operational eq "operation"` // 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: **operational**: *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: **operational**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClustersAPI.GetManagedClusters(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ManagedClustersAPI.GetManagedClusters(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetManagedClusters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClusters`: []ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetManagedClusters`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-client-log-configuration +Update Managed Cluster Log Configuration +Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-client-log-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the managed cluster to update the log configuration for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutClientLogConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **putClientLogConfigurationRequest** | [**PutClientLogConfigurationRequest**](../models/put-client-log-configuration-request) | Client log configuration for the given managed cluster. | + +### Return type + +[**ClientLogConfiguration**](../models/client-log-configuration) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | ID of the managed cluster to update the log configuration for. # string | ID of the managed cluster to update the log configuration for. + putclientlogconfigurationrequest := []byte(``) // PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + + + var putClientLogConfigurationRequest v2025.PutClientLogConfigurationRequest + if err := json.Unmarshal(putclientlogconfigurationrequest, &putClientLogConfigurationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClustersAPI.PutClientLogConfiguration(context.Background(), id).PutClientLogConfigurationRequest(putClientLogConfigurationRequest).Execute() + //resp, r, err := apiClient.V2025.ManagedClustersAPI.PutClientLogConfiguration(context.Background(), id).PutClientLogConfigurationRequest(putClientLogConfigurationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.PutClientLogConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutClientLogConfiguration`: ClientLogConfiguration + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.PutClientLogConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update +Trigger Manual Upgrade for Managed Cluster +Trigger Manual Upgrade for Managed Cluster. +AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of managed cluster to trigger manual upgrade. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ClusterManualUpgrade**](../models/cluster-manual-upgrade) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | ID of managed cluster to trigger manual upgrade. # string | ID of managed cluster to trigger manual upgrade. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClustersAPI.Update(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ManagedClustersAPI.Update(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.Update``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `Update`: ClusterManualUpgrade + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.Update`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-managed-cluster +Update Managed Cluster +Update an existing managed cluster. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-managed-cluster) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed cluster ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateManagedClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | JSONPatch payload used to update the object. | + +### Return type + +[**ManagedCluster**](../models/managed-cluster) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | JSONPatch payload used to update the object. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClustersAPI.UpdateManagedCluster(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.ManagedClustersAPI.UpdateManagedCluster(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.UpdateManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.UpdateManagedCluster`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/MultiHostIntegrationAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/MultiHostIntegrationAPI.md new file mode 100644 index 000000000..109091811 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/MultiHostIntegrationAPI.md @@ -0,0 +1,971 @@ +--- +id: v2025-multi-host-integration +title: MultiHostIntegration +pagination_label: MultiHostIntegration +sidebar_label: MultiHostIntegration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegration', 'V2025MultiHostIntegration'] +slug: /tools/sdk/go/v2025/methods/multi-host-integration +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegration', 'V2025MultiHostIntegration'] +--- + +# MultiHostIntegrationAPI + Use this API to build a Multi-Host Integration. +Multi-Host Integration will help customers to configure and manage similar type of target system in Identity Security Cloud. +In Identity Security Cloud, administrators can create a Multi-Host Integration by going to Admin > Connections > Multi-Host Sources and selecting 'Create.' + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-multi-host-integration**](#create-multi-host-integration) | **Post** `/multihosts` | Create Multi-Host Integration +[**create-sources-within-multi-host**](#create-sources-within-multi-host) | **Post** `/multihosts/{multihostId}` | Create Sources Within Multi-Host Integration +[**delete-multi-host**](#delete-multi-host) | **Delete** `/multihosts/{multihostId}` | Delete Multi-Host Integration +[**get-acct-aggregation-groups**](#get-acct-aggregation-groups) | **Get** `/multihosts/{multihostId}/acctAggregationGroups` | List Account-Aggregation-Groups by Multi-Host ID +[**get-entitlement-aggregation-groups**](#get-entitlement-aggregation-groups) | **Get** `/multihosts/{multiHostId}/entitlementAggregationGroups` | List Entitlement-Aggregation-Groups by Integration ID +[**get-multi-host-integrations**](#get-multi-host-integrations) | **Get** `/multihosts/{multihostId}` | Get Multi-Host Integration By ID +[**get-multi-host-integrations-list**](#get-multi-host-integrations-list) | **Get** `/multihosts` | List All Existing Multi-Host Integrations +[**get-multi-host-source-creation-errors**](#get-multi-host-source-creation-errors) | **Get** `/multihosts/{multiHostId}/sources/errors` | List Multi-Host Source Creation Errors +[**get-multihost-integration-types**](#get-multihost-integration-types) | **Get** `/multihosts/types` | List Multi-Host Integration Types +[**get-sources-within-multi-host**](#get-sources-within-multi-host) | **Get** `/multihosts/{multihostId}/sources` | List Sources Within Multi-Host Integration +[**test-connection-multi-host-sources**](#test-connection-multi-host-sources) | **Post** `/multihosts/{multihostId}/sources/testConnection` | Test Configuration For Multi-Host Integration +[**test-source-connection-multihost**](#test-source-connection-multihost) | **Get** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source +[**update-multi-host-sources**](#update-multi-host-sources) | **Patch** `/multihosts/{multihostId}` | Update Multi-Host Integration + + +## create-multi-host-integration +Create Multi-Host Integration +This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-multi-host-integration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateMultiHostIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **multiHostIntegrationsCreate** | [**MultiHostIntegrationsCreate**](../models/multi-host-integrations-create) | The specifics of the Multi-Host Integration to create | + +### Return type + +[**MultiHostIntegrations**](../models/multi-host-integrations) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostintegrationscreate := []byte(`{ + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + }`) // MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create + + + var multiHostIntegrationsCreate v2025.MultiHostIntegrationsCreate + if err := json.Unmarshal(multihostintegrationscreate, &multiHostIntegrationsCreate); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.CreateMultiHostIntegration(context.Background()).MultiHostIntegrationsCreate(multiHostIntegrationsCreate).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.CreateMultiHostIntegration(context.Background()).MultiHostIntegrationsCreate(multiHostIntegrationsCreate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.CreateMultiHostIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateMultiHostIntegration`: MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.CreateMultiHostIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-sources-within-multi-host +Create Sources Within Multi-Host Integration +This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-sources-within-multi-host) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSourcesWithinMultiHostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **multiHostIntegrationsCreateSources** | [**[]MultiHostIntegrationsCreateSources**](../models/multi-host-integrations-create-sources) | The specifics of the sources to create within Multi-Host Integration. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration. # string | ID of the Multi-Host Integration. + multihostintegrationscreatesources := []byte(``) // []MultiHostIntegrationsCreateSources | The specifics of the sources to create within Multi-Host Integration. + + + var multiHostIntegrationsCreateSources v2025.[]MultiHostIntegrationsCreateSources + if err := json.Unmarshal(multihostintegrationscreatesources, &multiHostIntegrationsCreateSources); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.MultiHostIntegrationAPI.CreateSourcesWithinMultiHost(context.Background(), multihostId).MultiHostIntegrationsCreateSources(multiHostIntegrationsCreateSources).Execute() + //r, err := apiClient.V2025.MultiHostIntegrationAPI.CreateSourcesWithinMultiHost(context.Background(), multihostId).MultiHostIntegrationsCreateSources(multiHostIntegrationsCreateSources).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.CreateSourcesWithinMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-multi-host +Delete Multi-Host Integration +Delete an existing Multi-Host Integration by ID. + +A token with Org Admin or Multi Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-multi-host) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of Multi-Host Integration to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteMultiHostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of Multi-Host Integration to delete. # string | ID of Multi-Host Integration to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.MultiHostIntegrationAPI.DeleteMultiHost(context.Background(), multihostId).Execute() + //r, err := apiClient.V2025.MultiHostIntegrationAPI.DeleteMultiHost(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.DeleteMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-acct-aggregation-groups +List Account-Aggregation-Groups by Multi-Host ID +This API will return array of account aggregation groups within provided Multi-Host Integration ID. +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-acct-aggregation-groups) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAcctAggregationGroupsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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] + **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] + +### Return type + +[**[]MultiHostIntegrationsAggScheduleUpdate**](../models/multi-host-integrations-agg-schedule-update) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + 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) + 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) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetAcctAggregationGroups(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetAcctAggregationGroups(context.Background(), multihostId).Offset(offset).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetAcctAggregationGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAcctAggregationGroups`: []MultiHostIntegrationsAggScheduleUpdate + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetAcctAggregationGroups`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlement-aggregation-groups +List Entitlement-Aggregation-Groups by Integration ID +This API will return array of aggregation groups within provided Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlement-aggregation-groups) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multiHostId** | **string** | ID of the Multi-Host Integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementAggregationGroupsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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] + **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] + +### Return type + +[**[]MultiHostIntegrationsAggScheduleUpdate**](../models/multi-host-integrations-agg-schedule-update) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multiHostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + 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) + 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) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetEntitlementAggregationGroups(context.Background(), multiHostId).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetEntitlementAggregationGroups(context.Background(), multiHostId).Offset(offset).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetEntitlementAggregationGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementAggregationGroups`: []MultiHostIntegrationsAggScheduleUpdate + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetEntitlementAggregationGroups`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-multi-host-integrations +Get Multi-Host Integration By ID +Get an existing Multi-Host Integration. + +A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-multi-host-integrations) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMultiHostIntegrationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**MultiHostIntegrations**](../models/multi-host-integrations) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration. # string | ID of the Multi-Host Integration. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetMultiHostIntegrations(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetMultiHostIntegrations(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostIntegrations`: MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostIntegrations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-multi-host-integrations-list +List All Existing Multi-Host Integrations +Get a list of Multi-Host Integrations. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-multi-host-integrations-list) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMultiHostIntegrationsListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **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** | + **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: **type**: *in* **forSubAdminId**: *in* | + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **forSubadmin** | **string** | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. | + +### Return type + +[**[]MultiHostIntegrations**](../models/multi-host-integrations) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `id eq 2c91808b6ef1d43e016efba0ce470904` // 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: **type**: *in* **forSubAdminId**: *in* (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: **type**: *in* **forSubAdminId**: *in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetMultiHostIntegrationsList(context.Background()).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetMultiHostIntegrationsList(context.Background()).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).ForSubadmin(forSubadmin).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostIntegrationsList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostIntegrationsList`: []MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostIntegrationsList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-multi-host-source-creation-errors +List Multi-Host Source Creation Errors +Get a list of sources creation errors within Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-multi-host-source-creation-errors) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multiHostId** | **string** | ID of the Multi-Host Integration | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMultiHostSourceCreationErrorsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]SourceCreationErrors**](../models/source-creation-errors) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multiHostId := `004091cb79b04636b88662afa50a4440` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors(context.Background(), multiHostId).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors(context.Background(), multiHostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostSourceCreationErrors`: []SourceCreationErrors + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-multihost-integration-types +List Multi-Host Integration Types +This API endpoint returns the current list of supported Multi-Host Integration types. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-multihost-integration-types) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMultihostIntegrationTypesRequest struct via the builder pattern + + +### Return type + +[**[]MultiHostIntegrationTemplateType**](../models/multi-host-integration-template-type) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetMultihostIntegrationTypes(context.Background()).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetMultihostIntegrationTypes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultihostIntegrationTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultihostIntegrationTypes`: []MultiHostIntegrationTemplateType + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultihostIntegrationTypes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sources-within-multi-host +List Sources Within Multi-Host Integration +Get a list of sources within Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sources-within-multi-host) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourcesWithinMultiHostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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] + **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] + **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** | + **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**: *in* | + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]MultiHostSources**](../models/multi-host-sources) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `id eq 2c91808b6ef1d43e016efba0ce470904` // 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**: *in* (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**: *in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetSourcesWithinMultiHost(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetSourcesWithinMultiHost(context.Background(), multihostId).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetSourcesWithinMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourcesWithinMultiHost`: []MultiHostSources + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetSourcesWithinMultiHost`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-connection-multi-host-sources +Test Configuration For Multi-Host Integration +This endpoint performs a more detailed validation of the Multi-Host Integration's configuration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/test-connection-multi-host-sources) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestConnectionMultiHostSourcesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `2c91808568c529c60168cca6f90c1324` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.MultiHostIntegrationAPI.TestConnectionMultiHostSources(context.Background(), multihostId).Execute() + //r, err := apiClient.V2025.MultiHostIntegrationAPI.TestConnectionMultiHostSources(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.TestConnectionMultiHostSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## test-source-connection-multihost +Test Configuration For Multi-Host Integration's Single Source +This endpoint performs a more detailed validation of the source's configuration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/test-source-connection-multihost) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration | +**sourceId** | **string** | ID of the source within the Multi-Host Integration | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestSourceConnectionMultihostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**TestSourceConnectionMultihost200Response**](../models/test-source-connection-multihost200-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + sourceId := `2c91808568c529f60168cca6f90c1324` // string | ID of the source within the Multi-Host Integration # string | ID of the source within the Multi-Host Integration + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.TestSourceConnectionMultihost(context.Background(), multihostId, sourceId).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.TestSourceConnectionMultihost(context.Background(), multihostId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.TestSourceConnectionMultihost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConnectionMultihost`: TestSourceConnectionMultihost200Response + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.TestSourceConnectionMultihost`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-multi-host-sources +Update Multi-Host Integration +Update existing sources within Multi-Host Integration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-multi-host-sources) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**multihostId** | **string** | ID of the Multi-Host Integration to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateMultiHostSourcesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **updateMultiHostSourcesRequestInner** | [**[]UpdateMultiHostSourcesRequestInner**](../models/update-multi-host-sources-request-inner) | This endpoint allows you to update a Multi-Host Integration. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multihostId := `anId` // string | ID of the Multi-Host Integration to update. # string | ID of the Multi-Host Integration to update. + updatemultihostsourcesrequestinner := []byte(`[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]`) // []UpdateMultiHostSourcesRequestInner | This endpoint allows you to update a Multi-Host Integration. + + + var updateMultiHostSourcesRequestInner v2025.[]UpdateMultiHostSourcesRequestInner + if err := json.Unmarshal(updatemultihostsourcesrequestinner, &updateMultiHostSourcesRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.MultiHostIntegrationAPI.UpdateMultiHostSources(context.Background(), multihostId).UpdateMultiHostSourcesRequestInner(updateMultiHostSourcesRequestInner).Execute() + //r, err := apiClient.V2025.MultiHostIntegrationAPI.UpdateMultiHostSources(context.Background(), multihostId).UpdateMultiHostSourcesRequestInner(updateMultiHostSourcesRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.UpdateMultiHostSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/NonEmployeeLifecycleManagementAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/NonEmployeeLifecycleManagementAPI.md new file mode 100644 index 000000000..975298910 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/NonEmployeeLifecycleManagementAPI.md @@ -0,0 +1,2406 @@ +--- +id: v2025-non-employee-lifecycle-management +title: NonEmployeeLifecycleManagement +pagination_label: NonEmployeeLifecycleManagement +sidebar_label: NonEmployeeLifecycleManagement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeLifecycleManagement', 'V2025NonEmployeeLifecycleManagement'] +slug: /tools/sdk/go/v2025/methods/non-employee-lifecycle-management +tags: ['SDK', 'Software Development Kit', 'NonEmployeeLifecycleManagement', 'V2025NonEmployeeLifecycleManagement'] +--- + +# NonEmployeeLifecycleManagementAPI + Use this API to implement non-employee lifecycle management functionality. +With this functionality in place, administrators can create non-employee records and configure them for use in their organizations. +This allows organizations to provide secure access to non-employees and control that access. + +The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. +Organizations can track non-employees' access and activity in Identity Security Cloud by creating and maintaining non-employee sources. +Organizations can have a maximum of 50 non-employee sources. + +By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following: + +- SailPoint is not responsible for storing sensitive data. +You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in Identity Security Cloud. + +- You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts. + +To manage non-employees in Identity Security Cloud, administrators must create a non-employee source and add accounts to the source. + +To create a non-employee source in Identity Security Cloud, administrators must use the Admin panel to go to Connections > Sources. +They must then specify 'Non-Employee' in the 'Source Type' field. +Refer to [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources. + +To add accounts to a non-employee source in Identity Security Cloud, administrators can select the non-employee source and add the accounts. +They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. + +Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. +To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. +Refer to [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources. + +Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. + +Refer to [Managing Non-Employee Sources and Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html) for more information about non-employee lifecycle management. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-non-employee-request**](#approve-non-employee-request) | **Post** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request +[**create-non-employee-record**](#create-non-employee-record) | **Post** `/non-employee-records` | Create Non-Employee Record +[**create-non-employee-request**](#create-non-employee-request) | **Post** `/non-employee-requests` | Create Non-Employee Request +[**create-non-employee-source**](#create-non-employee-source) | **Post** `/non-employee-sources` | Create Non-Employee Source +[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **Post** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new Schema Attribute for Non-Employee Source +[**delete-non-employee-record**](#delete-non-employee-record) | **Delete** `/non-employee-records/{id}` | Delete Non-Employee Record +[**delete-non-employee-records-in-bulk**](#delete-non-employee-records-in-bulk) | **Post** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records +[**delete-non-employee-request**](#delete-non-employee-request) | **Delete** `/non-employee-requests/{id}` | Delete Non-Employee Request +[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a Schema Attribute for Non-Employee Source +[**delete-non-employee-source**](#delete-non-employee-source) | **Delete** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source +[**delete-non-employee-source-schema-attributes**](#delete-non-employee-source-schema-attributes) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for Non-Employee Source +[**export-non-employee-records**](#export-non-employee-records) | **Get** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV +[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **Get** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template +[**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-bulk-upload-status**](#get-non-employee-bulk-upload-status) | **Get** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Obtain the status of bulk upload on the source +[**get-non-employee-record**](#get-non-employee-record) | **Get** `/non-employee-records/{id}` | Get a Non-Employee Record +[**get-non-employee-request**](#get-non-employee-request) | **Get** `/non-employee-requests/{id}` | Get a Non-Employee Request +[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **Get** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests +[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **Get** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source +[**get-non-employee-source**](#get-non-employee-source) | **Get** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source +[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **Get** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source +[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **Post** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records +[**list-non-employee-approvals**](#list-non-employee-approvals) | **Get** `/non-employee-approvals` | Get List of Non-Employee Approval Requests +[**list-non-employee-records**](#list-non-employee-records) | **Get** `/non-employee-records` | List Non-Employee Records +[**list-non-employee-requests**](#list-non-employee-requests) | **Get** `/non-employee-requests` | List Non-Employee Requests +[**list-non-employee-sources**](#list-non-employee-sources) | **Get** `/non-employee-sources` | List Non-Employee Sources +[**patch-non-employee-record**](#patch-non-employee-record) | **Patch** `/non-employee-records/{id}` | Patch Non-Employee Record +[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **Patch** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a Schema Attribute for Non-Employee Source +[**patch-non-employee-source**](#patch-non-employee-source) | **Patch** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source +[**reject-non-employee-request**](#reject-non-employee-request) | **Post** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request +[**update-non-employee-record**](#update-non-employee-record) | **Put** `/non-employee-records/{id}` | Update Non-Employee Record + + +## approve-non-employee-request +Approve a Non-Employee Request +Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/approve-non-employee-request) + +### 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 apiApproveNonEmployeeRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **nonEmployeeApprovalDecision** | [**NonEmployeeApprovalDecision**](../models/non-employee-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" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + nonemployeeapprovaldecision := []byte(`{ + "comment" : "Approved by manager" + }`) // NonEmployeeApprovalDecision | + + + var nonEmployeeApprovalDecision v2025.NonEmployeeApprovalDecision + if err := json.Unmarshal(nonemployeeapprovaldecision, &nonEmployeeApprovalDecision); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest(context.Background(), id).NonEmployeeApprovalDecision(nonEmployeeApprovalDecision).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest(context.Background(), id).NonEmployeeApprovalDecision(nonEmployeeApprovalDecision).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveNonEmployeeRequest`: NonEmployeeApprovalItem + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-non-employee-record +Create Non-Employee Record +This request will create a non-employee record. +Requires role context of `idn:nesr:create` + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-non-employee-record) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nonEmployeeRequestBody** | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | Non-Employee record creation request body. | + +### Return type + +[**NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-Employee record creation request body. + + + var nonEmployeeRequestBody v2025.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-non-employee-request +Create Non-Employee Request +This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-non-employee-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNonEmployeeRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nonEmployeeRequestBody** | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | Non-Employee creation request body | + +### Return type + +[**NonEmployeeRequest**](../models/non-employee-request) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-Employee creation request body + + + var nonEmployeeRequestBody v2025.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeRequest`: NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-non-employee-source +Create Non-Employee Source +Create a non-employee source. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-non-employee-source) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNonEmployeeSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nonEmployeeSourceRequestBody** | [**NonEmployeeSourceRequestBody**](../models/non-employee-source-request-body) | Non-Employee source creation request body. | + +### Return type + +[**NonEmployeeSourceWithCloudExternalId**](../models/non-employee-source-with-cloud-external-id) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + nonemployeesourcerequestbody := []byte(`{ + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + }`) // NonEmployeeSourceRequestBody | Non-Employee source creation request body. + + + var nonEmployeeSourceRequestBody v2025.NonEmployeeSourceRequestBody + if err := json.Unmarshal(nonemployeesourcerequestbody, &nonEmployeeSourceRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource(context.Background()).NonEmployeeSourceRequestBody(nonEmployeeSourceRequestBody).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource(context.Background()).NonEmployeeSourceRequestBody(nonEmployeeSourceRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeSource`: NonEmployeeSourceWithCloudExternalId + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-non-employee-source-schema-attributes +Create a new Schema Attribute for Non-Employee Source +This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. +Requires role context of `idn:nesr:create` + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-non-employee-source-schema-attributes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNonEmployeeSourceSchemaAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **nonEmployeeSchemaAttributeBody** | [**NonEmployeeSchemaAttributeBody**](../models/non-employee-schema-attribute-body) | | + +### Return type + +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + nonemployeeschemaattributebody := []byte(`{ + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + }`) // NonEmployeeSchemaAttributeBody | + + + var nonEmployeeSchemaAttributeBody v2025.NonEmployeeSchemaAttributeBody + if err := json.Unmarshal(nonemployeeschemaattributebody, &nonEmployeeSchemaAttributeBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).NonEmployeeSchemaAttributeBody(nonEmployeeSchemaAttributeBody).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).NonEmployeeSchemaAttributeBody(nonEmployeeSchemaAttributeBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeSourceSchemaAttributes`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-non-employee-record +Delete Non-Employee Record +This request will delete a non-employee record. +Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-non-employee-record) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-Employee record id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-Employee record id (UUID) # string | Non-Employee record id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord(context.Background(), id).Execute() + //r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-records-in-bulk +Delete Multiple Non-Employee Records +This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-non-employee-records-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeRecordsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **deleteNonEmployeeRecordsInBulkRequest** | [**DeleteNonEmployeeRecordsInBulkRequest**](../models/delete-non-employee-records-in-bulk-request) | Non-Employee bulk delete request body. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + deletenonemployeerecordsinbulkrequest := []byte(``) // DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. + + + var deleteNonEmployeeRecordsInBulkRequest v2025.DeleteNonEmployeeRecordsInBulkRequest + if err := json.Unmarshal(deletenonemployeerecordsinbulkrequest, &deleteNonEmployeeRecordsInBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk(context.Background()).DeleteNonEmployeeRecordsInBulkRequest(deleteNonEmployeeRecordsInBulkRequest).Execute() + //r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk(context.Background()).DeleteNonEmployeeRecordsInBulkRequest(deleteNonEmployeeRecordsInBulkRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-request +Delete Non-Employee Request +This request will delete a non-employee request. +Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-non-employee-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-Employee request id in the UUID format | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ac110005-7156-1150-8171-5b292e3e0084` // string | Non-Employee request id in the UUID format # string | Non-Employee request id in the UUID format + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest(context.Background(), id).Execute() + //r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-schema-attribute +Delete a Schema Attribute for Non-Employee Source +This end-point deletes a specific schema attribute for a non-employee source. +Requires role context of `idn:nesr:delete` + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-non-employee-schema-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**attributeId** | **string** | The Schema Attribute Id (UUID) | +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeSchemaAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + //r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-source +Delete Non-Employee Source +This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-non-employee-source) + +### 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 apiDeleteNonEmployeeSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id # string | Source Id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource(context.Background(), sourceId).Execute() + //r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-source-schema-attributes +Delete all custom schema attributes for Non-Employee Source +This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-non-employee-source-schema-attributes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeSourceSchemaAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + //r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[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. Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/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 := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id (UUID) # string | Source Id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ExportNonEmployeeRecords(context.Background(), id).Execute() + //r, err := apiClient.V2025.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. Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/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 := `ef38f94347e94562b5bb8424a56397d8` // string | Source Id (UUID) # string | Source Id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ExportNonEmployeeSourceSchemaTemplate(context.Background(), id).Execute() + //r, err := apiClient.V2025.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 +Gets a non-employee approval item detail. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they +can get any approval. + 2. The user owns the requested approval. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-non-employee-approval) + +### 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 apiGetNonEmployeeApprovalRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeDetail** | **bool** | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* | + +### Return type + +[**NonEmployeeApprovalItemDetail**](../models/non-employee-approval-item-detail) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + includeDetail := true // bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval(context.Background(), id).IncludeDetail(includeDetail).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeApproval`: NonEmployeeApprovalItemDetail + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-approval-summary +Get Summary of Non-Employee Approval Requests +This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. + 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/v2025/get-non-employee-approval-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**requestedFor** | **string** | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeApprovalSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeApprovalSummary**](../models/non-employee-approval-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary(context.Background(), requestedFor).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary(context.Background(), requestedFor).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeApprovalSummary`: NonEmployeeApprovalSummary + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-bulk-upload-status +Obtain the status of bulk upload on the source +The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. +Requires role context of `idn:nesr:read` + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-non-employee-bulk-upload-status) + +### 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 apiGetNonEmployeeBulkUploadStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeBulkUploadStatus**](../models/non-employee-bulk-upload-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Source ID (UUID) # string | Source ID (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeBulkUploadStatus`: NonEmployeeBulkUploadStatus + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-record +Get a Non-Employee Record +This gets a non-employee record. +Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-non-employee-record) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-Employee record id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-Employee record id (UUID) # string | Non-Employee record id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-request +Get a Non-Employee Request +This gets a non-employee request. +There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in this case the user +can get the non-employee request for any user. + 2. The user must be the owner of the non-employee request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-non-employee-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-Employee request id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeRequest**](../models/non-employee-request) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ac110005-7156-1150-8171-5b292e3e0084` // string | Non-Employee request id (UUID) # string | Non-Employee request id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRequest`: NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-request-summary +Get Summary of Non-Employee Requests +This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. + 2. The current user is an account manager, in which case "me" should be +provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-non-employee-request-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**requestedFor** | **string** | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeRequestSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeRequestSummary**](../models/non-employee-request-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary(context.Background(), requestedFor).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary(context.Background(), requestedFor).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRequestSummary`: NonEmployeeRequestSummary + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-schema-attribute +Get Schema Attribute Non-Employee Source +This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-non-employee-schema-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**attributeId** | **string** | The Schema Attribute Id (UUID) | +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeSchemaAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeSchemaAttribute`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-source +Get a Non-Employee Source +This gets a non-employee source. There are two contextual uses for the requested-for path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request any source. + 2. The current user is an account manager, in which case the user can only +request sources that they own. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-non-employee-source) + +### 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 apiGetNonEmployeeSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeSource**](../models/non-employee-source) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c91808b7c28b350017c2a2ec5790aa1` // string | Source Id # string | Source Id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeSource`: NonEmployeeSource + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-source-schema-attributes +List Schema Attributes Non-Employee Source +This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. +Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-non-employee-source-schema-attributes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeSourceSchemaAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).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) + } + // response from `GetNonEmployeeSourceSchemaAttributes`: []NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-non-employee-records-in-bulk +Imports, or Updates, Non-Employee Records +This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/import-non-employee-records-in-bulk) + +### 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 apiImportNonEmployeeRecordsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **data** | ***os.File** | | + +### Return type + +[**NonEmployeeBulkUploadJob**](../models/non-employee-bulk-upload-job) + +### 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() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id (UUID) # string | Source Id (UUID) + data := BINARY_DATA_HERE // *os.File | # *os.File | + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk(context.Background(), id).Data(data).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk(context.Background(), id).Data(data).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportNonEmployeeRecordsInBulk`: NonEmployeeBulkUploadJob + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-non-employee-approvals +Get List of Non-Employee Approval Requests +This gets a list of non-employee approval requests. +There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they +can list the approvals for any approver. + 2. The user owns the requested approval. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-non-employee-approvals) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNonEmployeeApprovalsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | The identity for whom the request was made. *me* indicates the current user. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **approvalStatus**: *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: **created, modified** | + +### Return type + +[**[]NonEmployeeApprovalItem**](../models/non-employee-approval-item) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity for whom the request was made. *me* indicates the current user. (optional) # string | The identity for whom the request was made. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `approvalStatus eq "Pending"` // 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: **approvalStatus**: *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: **approvalStatus**: *eq* (optional) + sorters := `created` // 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: **created, modified** (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: **created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals(context.Background()).RequestedFor(requestedFor).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeApprovals`: []NonEmployeeApprovalItem + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-non-employee-records +List Non-Employee Records +This gets a list of non-employee records. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. + 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-non-employee-records) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNonEmployeeRecordsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** | + **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: **sourceId**: *eq* | + +### Return type + +[**[]NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `accountName,sourceId` // 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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + filters := `sourceId eq "2c91808568c529c60168cca6f90c1313"` // 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: **sourceId**: *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: **sourceId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords(context.Background()).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords(context.Background()).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeRecords`: []NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-non-employee-requests +List Non-Employee Requests +This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id. + 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 list of the non-employee requests in the source(s) he or she manages. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-non-employee-requests) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNonEmployeeRequestsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | The identity for whom the request was made. *me* indicates the current user. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** | + **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: **sourceId**: *eq* | + +### Return type + +[**[]NonEmployeeRequest**](../models/non-employee-request) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `e136567de87e4d029e60b3c3c55db56d` // string | The identity for whom the request was made. *me* indicates the current user. # string | The identity for whom the request was made. *me* indicates the current user. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `created,approvalStatus` // 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + filters := `sourceId eq "2c91808568c529c60168cca6f90c1313"` // 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: **sourceId**: *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: **sourceId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests(context.Background()).RequestedFor(requestedFor).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests(context.Background()).RequestedFor(requestedFor).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeRequests`: []NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-non-employee-sources +List Non-Employee Sources +Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: + 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. + 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-non-employee-sources) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNonEmployeeSourcesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **requestedFor** | **string** | Identity the request was made for. Use 'me' to indicate the current user. | + **nonEmployeeCount** | **bool** | Flag that determines whether the API will return a non-employee count associated with the source. | [default to false] + **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, created, sourceId** | + +### Return type + +[**[]NonEmployeeSourceWithNECount**](../models/non-employee-source-with-ne-count) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + requestedFor := `me` // string | Identity the request was made for. Use 'me' to indicate the current user. (optional) # string | Identity the request was made for. Use 'me' to indicate the current user. (optional) + nonEmployeeCount := true // bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) + sorters := `name,created` // 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, created, sourceId** (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, created, sourceId** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources(context.Background()).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources(context.Background()).Limit(limit).Offset(offset).Count(count).RequestedFor(requestedFor).NonEmployeeCount(nonEmployeeCount).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeSources`: []NonEmployeeSourceWithNECount + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-non-employee-record +Patch Non-Employee Record +This request will patch a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they +update all available fields. + 2. The user is owner of the source, in this case they can only update the +end date. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-non-employee-record) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-employee record id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. | + +### Return type + +[**NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-employee record id (UUID) # string | Non-employee record id (UUID) + jsonpatchoperation := []byte(`[{op=replace, path=/endDate, value=2019-08-23T18:40:35.772Z}]`) // []JsonPatchOperation | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-non-employee-schema-attribute +Patch a Schema Attribute for Non-Employee Source +This end-point patches a specific schema attribute for a non-employee SourceId. +Requires role context of `idn:nesr:update` + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-non-employee-schema-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**attributeId** | **string** | The Schema Attribute Id (UUID) | +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchNonEmployeeSchemaAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. | + +### Return type + +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + jsonpatchoperation := []byte(`[{op=replace, path=/label, value={new attribute label=null}}]`) // []JsonPatchOperation | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeSchemaAttribute`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-non-employee-source +Patch a Non-Employee Source +patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-non-employee-source) + +### 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 apiPatchNonEmployeeSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +[**NonEmployeeSource**](../models/non-employee-source) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id # string | Source Id + jsonpatchoperation := []byte(`[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}]`) // []JsonPatchOperation | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource(context.Background(), sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource(context.Background(), sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeSource`: NonEmployeeSource + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reject-non-employee-request +Reject a Non-Employee Request +This endpoint will reject an approval item request and notify user. The current user must be the requested approver. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/reject-non-employee-request) + +### 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" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + nonemployeerejectapprovaldecision := []byte(`{ + "comment" : "approved" + }`) // NonEmployeeRejectApprovalDecision | + + + var nonEmployeeRejectApprovalDecision v2025.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.V2025.NonEmployeeLifecycleManagementAPI.RejectNonEmployeeRequest(context.Background(), id).NonEmployeeRejectApprovalDecision(nonEmployeeRejectApprovalDecision).Execute() + //resp, r, err := apiClient.V2025.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 +Update Non-Employee Record +This request will update a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they +update all available fields. + 2. The user is owner of the source, in this case they can only update the +end date. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-non-employee-record) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-employee record id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **nonEmployeeRequestBody** | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. | + +### Return type + +[**NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-employee record id (UUID) # string | Non-employee record id (UUID) + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + + var nonEmployeeRequestBody v2025.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord(context.Background(), id).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord(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, "Full HTTP response: %v\n", r) + } + // response from `UpdateNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/NotificationsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/NotificationsAPI.md new file mode 100644 index 000000000..d6e515d40 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/NotificationsAPI.md @@ -0,0 +1,1241 @@ +--- +id: v2025-notifications +title: Notifications +pagination_label: Notifications +sidebar_label: Notifications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Notifications', 'V2025Notifications'] +slug: /tools/sdk/go/v2025/methods/notifications +tags: ['SDK', 'Software Development Kit', 'Notifications', 'V2025Notifications'] +--- + +# NotificationsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-domain-dkim**](#create-domain-dkim) | **Post** `/verified-domains` | Verify domain address via DKIM +[**create-notification-template**](#create-notification-template) | **Post** `/notification-templates` | Create Notification Template +[**create-verified-from-address**](#create-verified-from-address) | **Post** `/verified-from-addresses` | Create Verified From Address +[**delete-notification-templates-in-bulk**](#delete-notification-templates-in-bulk) | **Post** `/notification-templates/bulk-delete` | Bulk Delete Notification Templates +[**delete-verified-from-address**](#delete-verified-from-address) | **Delete** `/verified-from-addresses/{id}` | Delete Verified From Address +[**get-dkim-attributes**](#get-dkim-attributes) | **Get** `/verified-domains` | Get DKIM Attributes +[**get-mail-from-attributes**](#get-mail-from-attributes) | **Get** `/mail-from-attributes/{identity}` | Get MAIL FROM Attributes +[**get-notification-template**](#get-notification-template) | **Get** `/notification-templates/{id}` | Get Notification Template By Id +[**get-notifications-template-context**](#get-notifications-template-context) | **Get** `/notification-template-context` | Get Notification Template Context +[**list-from-addresses**](#list-from-addresses) | **Get** `/verified-from-addresses` | List From Addresses +[**list-notification-preferences**](#list-notification-preferences) | **Get** `/notification-preferences/{key}` | List Notification Preferences for tenant. +[**list-notification-template-defaults**](#list-notification-template-defaults) | **Get** `/notification-template-defaults` | List Notification Template Defaults +[**list-notification-templates**](#list-notification-templates) | **Get** `/notification-templates` | List Notification Templates +[**put-mail-from-attributes**](#put-mail-from-attributes) | **Put** `/mail-from-attributes` | Change MAIL FROM domain +[**send-test-notification**](#send-test-notification) | **Post** `/send-test-notification` | Send Test Notification + + +## create-domain-dkim +:::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 + ``` +::: +Verify domain address via DKIM +Create a domain to be verified via DKIM (DomainKeys Identified Mail) + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-domain-dkim) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateDomainDkimRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **domainAddress** | [**DomainAddress**](../models/domain-address) | | + +### Return type + +[**DomainStatusDto**](../models/domain-status-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + domainaddress := []byte(`{ + "domain" : "sailpoint.com" + }`) // DomainAddress | + + + var domainAddress v2025.DomainAddress + if err := json.Unmarshal(domainaddress, &domainAddress); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.CreateDomainDkim(context.Background()).XSailPointExperimental(xSailPointExperimental).DomainAddress(domainAddress).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.CreateDomainDkim(context.Background()).XSailPointExperimental(xSailPointExperimental).DomainAddress(domainAddress).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateDomainDkim``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDomainDkim`: DomainStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateDomainDkim`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-notification-template +:::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 Notification Template +This creates a template for your site. + +You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-notification-template) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNotificationTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **templateDto** | [**TemplateDto**](../models/template-dto) | | + +### Return type + +[**TemplateDto**](../models/template-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + templatedto := []byte(`{ + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" + }`) // TemplateDto | + + + var templateDto v2025.TemplateDto + if err := json.Unmarshal(templatedto, &templateDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.CreateNotificationTemplate(context.Background()).XSailPointExperimental(xSailPointExperimental).TemplateDto(templateDto).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.CreateNotificationTemplate(context.Background()).XSailPointExperimental(xSailPointExperimental).TemplateDto(templateDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateNotificationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNotificationTemplate`: TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateNotificationTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-verified-from-address +:::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 Verified From Address +Create a new sender email address and initiate verification process. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-verified-from-address) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateVerifiedFromAddressRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **emailStatusDto** | [**EmailStatusDto**](../models/email-status-dto) | | + +### Return type + +[**EmailStatusDto**](../models/email-status-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + emailstatusdto := []byte(`{ + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + }`) // EmailStatusDto | + + + var emailStatusDto v2025.EmailStatusDto + if err := json.Unmarshal(emailstatusdto, &emailStatusDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.CreateVerifiedFromAddress(context.Background()).XSailPointExperimental(xSailPointExperimental).EmailStatusDto(emailStatusDto).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.CreateVerifiedFromAddress(context.Background()).XSailPointExperimental(xSailPointExperimental).EmailStatusDto(emailStatusDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateVerifiedFromAddress``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateVerifiedFromAddress`: EmailStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateVerifiedFromAddress`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-notification-templates-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 Notification Templates +This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-notification-templates-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNotificationTemplatesInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **templateBulkDeleteDto** | [**[]TemplateBulkDeleteDto**](../models/template-bulk-delete-dto) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + templatebulkdeletedto := []byte(``) // []TemplateBulkDeleteDto | + + + var templateBulkDeleteDto v2025.[]TemplateBulkDeleteDto + if err := json.Unmarshal(templatebulkdeletedto, &templateBulkDeleteDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NotificationsAPI.DeleteNotificationTemplatesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).TemplateBulkDeleteDto(templateBulkDeleteDto).Execute() + //r, err := apiClient.V2025.NotificationsAPI.DeleteNotificationTemplatesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).TemplateBulkDeleteDto(templateBulkDeleteDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.DeleteNotificationTemplatesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-verified-from-address +:::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 Verified From Address +Delete a verified sender email address + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-verified-from-address) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteVerifiedFromAddressRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `id_example` // string | # string | + 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.V2025.NotificationsAPI.DeleteVerifiedFromAddress(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.NotificationsAPI.DeleteVerifiedFromAddress(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.DeleteVerifiedFromAddress``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-dkim-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 + ``` +::: +Get DKIM Attributes +Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-dkim-attributes) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDkimAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**[]DkimAttributes**](../models/dkim-attributes) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.GetDkimAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.GetDkimAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetDkimAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDkimAttributes`: []DkimAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetDkimAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-mail-from-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 + ``` +::: +Get MAIL FROM Attributes +Retrieve MAIL FROM attributes for a given AWS SES identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-mail-from-attributes) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMailFromAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **string** | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status | + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**MailFromAttributes**](../models/mail-from-attributes) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `bobsmith@sailpoint.com` // string | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # string | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + 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.NotificationsAPI.GetMailFromAttributes(context.Background()).Id(id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.GetMailFromAttributes(context.Background()).Id(id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetMailFromAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMailFromAttributes`: MailFromAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetMailFromAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-notification-template +:::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 Notification Template By Id +This gets a template that you have modified for your site by Id. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-notification-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the Notification Template | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNotificationTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**TemplateDto**](../models/template-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Notification Template # string | Id of the Notification Template + 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.NotificationsAPI.GetNotificationTemplate(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.GetNotificationTemplate(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetNotificationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNotificationTemplate`: TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetNotificationTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-notifications-template-context +:::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 Notification Template Context +The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes + that will be available per tenant (organization). + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-notifications-template-context) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNotificationsTemplateContextRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**NotificationTemplateContext**](../models/notification-template-context) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.GetNotificationsTemplateContext(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.GetNotificationsTemplateContext(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetNotificationsTemplateContext``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNotificationsTemplateContext`: NotificationTemplateContext + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetNotificationsTemplateContext`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-from-addresses +:::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 From Addresses +Retrieve a list of sender email addresses and their verification statuses + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-from-addresses) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListFromAddressesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **email**: *eq, ge, le, sw* | + **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: **email** | + +### Return type + +[**[]EmailStatusDto**](../models/email-status-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `email eq "john.doe@company.com"` // 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: **email**: *eq, ge, le, sw* (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: **email**: *eq, ge, le, sw* (optional) + sorters := `email` // 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: **email** (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: **email** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.ListFromAddresses(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.ListFromAddresses(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListFromAddresses``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListFromAddresses`: []EmailStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListFromAddresses`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-notification-preferences +:::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 Notification Preferences for tenant. +Returns a list of notification preferences for tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-notification-preferences) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNotificationPreferencesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**PreferencesDto**](../models/preferences-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.ListNotificationPreferences(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.ListNotificationPreferences(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationPreferences``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationPreferences`: PreferencesDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationPreferences`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-notification-template-defaults +:::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 Notification Template Defaults +This lists the default templates used for notifications, such as emails from IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-notification-template-defaults) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNotificationTemplateDefaultsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* | + +### Return type + +[**[]TemplateDtoDefault**](../models/template-dto-default) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + filters := `key eq "cloud_manual_work_item_summary"` // 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.ListNotificationTemplateDefaults(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.ListNotificationTemplateDefaults(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationTemplateDefaults``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationTemplateDefaults`: []TemplateDtoDefault + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationTemplateDefaults`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-notification-templates +:::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 Notification Templates +This lists the templates that you have modified for your site. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-notification-templates) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNotificationTemplatesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* | + +### Return type + +[**[]TemplateDto**](../models/template-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + filters := `medium eq "EMAIL"` // 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.ListNotificationTemplates(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.ListNotificationTemplates(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationTemplates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationTemplates`: []TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationTemplates`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-mail-from-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 + ``` +::: +Change MAIL FROM domain +Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-mail-from-attributes) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutMailFromAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **mailFromAttributesDto** | [**MailFromAttributesDto**](../models/mail-from-attributes-dto) | | + +### Return type + +[**MailFromAttributes**](../models/mail-from-attributes) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + mailfromattributesdto := []byte(`{ + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + }`) // MailFromAttributesDto | + + + var mailFromAttributesDto v2025.MailFromAttributesDto + if err := json.Unmarshal(mailfromattributesdto, &mailFromAttributesDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.PutMailFromAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).MailFromAttributesDto(mailFromAttributesDto).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.PutMailFromAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).MailFromAttributesDto(mailFromAttributesDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.PutMailFromAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutMailFromAttributes`: MailFromAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.PutMailFromAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## send-test-notification +:::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 + ``` +::: +Send Test Notification +Send a Test Notification + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/send-test-notification) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendTestNotificationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **sendTestNotificationRequestDto** | [**SendTestNotificationRequestDto**](../models/send-test-notification-request-dto) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + sendtestnotificationrequestdto := []byte(`{ + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + }`) // SendTestNotificationRequestDto | + + + var sendTestNotificationRequestDto v2025.SendTestNotificationRequestDto + if err := json.Unmarshal(sendtestnotificationrequestdto, &sendTestNotificationRequestDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NotificationsAPI.SendTestNotification(context.Background()).XSailPointExperimental(xSailPointExperimental).SendTestNotificationRequestDto(sendTestNotificationRequestDto).Execute() + //r, err := apiClient.V2025.NotificationsAPI.SendTestNotification(context.Background()).XSailPointExperimental(xSailPointExperimental).SendTestNotificationRequestDto(sendTestNotificationRequestDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.SendTestNotification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/OAuthClientsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/OAuthClientsAPI.md new file mode 100644 index 000000000..611774f21 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/OAuthClientsAPI.md @@ -0,0 +1,377 @@ +--- +id: v2025-o-auth-clients +title: OAuthClients +pagination_label: OAuthClients +sidebar_label: OAuthClients +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OAuthClients', 'V2025OAuthClients'] +slug: /tools/sdk/go/v2025/methods/o-auth-clients +tags: ['SDK', 'Software Development Kit', 'OAuthClients', 'V2025OAuthClients'] +--- + +# OAuthClientsAPI + Use this API to implement OAuth client functionality. +With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the Identity Security Cloud REST API. +Refer to [Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information about OAuth and how it works with the Identity Security Cloud REST API. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-oauth-client**](#create-oauth-client) | **Post** `/oauth-clients` | Create OAuth Client +[**delete-oauth-client**](#delete-oauth-client) | **Delete** `/oauth-clients/{id}` | Delete OAuth Client +[**get-oauth-client**](#get-oauth-client) | **Get** `/oauth-clients/{id}` | Get OAuth Client +[**list-oauth-clients**](#list-oauth-clients) | **Get** `/oauth-clients` | List OAuth Clients +[**patch-oauth-client**](#patch-oauth-client) | **Patch** `/oauth-clients/{id}` | Patch OAuth Client + + +## create-oauth-client +Create OAuth Client +This creates an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-oauth-client) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateOauthClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createOAuthClientRequest** | [**CreateOAuthClientRequest**](../models/create-o-auth-client-request) | | + +### Return type + +[**CreateOAuthClientResponse**](../models/create-o-auth-client-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createoauthclientrequest := []byte(`{ + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + }`) // CreateOAuthClientRequest | + + + var createOAuthClientRequest v2025.CreateOAuthClientRequest + if err := json.Unmarshal(createoauthclientrequest, &createOAuthClientRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.OAuthClientsAPI.CreateOauthClient(context.Background()).CreateOAuthClientRequest(createOAuthClientRequest).Execute() + //resp, r, err := apiClient.V2025.OAuthClientsAPI.CreateOauthClient(context.Background()).CreateOAuthClientRequest(createOAuthClientRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.CreateOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateOauthClient`: CreateOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.CreateOauthClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-oauth-client +Delete OAuth Client +This deletes an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-oauth-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The OAuth client id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteOauthClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.OAuthClientsAPI.DeleteOauthClient(context.Background(), id).Execute() + //r, err := apiClient.V2025.OAuthClientsAPI.DeleteOauthClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.DeleteOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-oauth-client +Get OAuth Client +This gets details of an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-oauth-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The OAuth client id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOauthClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.OAuthClientsAPI.GetOauthClient(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.OAuthClientsAPI.GetOauthClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.GetOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOauthClient`: GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.GetOauthClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-oauth-clients +List OAuth Clients +This gets a list of OAuth clients. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-oauth-clients) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOauthClientsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **lastUsed**: *le, isnull* | + +### Return type + +[**[]GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `lastUsed le 2023-02-05T10:59:27.214Z` // 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.OAuthClientsAPI.ListOauthClients(context.Background()).Execute() + //resp, r, err := apiClient.V2025.OAuthClientsAPI.ListOauthClients(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.ListOauthClients``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOauthClients`: []GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.ListOauthClients`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-oauth-client +Patch OAuth Client +This performs a targeted update to the field(s) of an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-oauth-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The OAuth client id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchOauthClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported | + +### Return type + +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + jsonpatchoperation := []byte(`[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}]`) // []JsonPatchOperation | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.OAuthClientsAPI.PatchOauthClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.OAuthClientsAPI.PatchOauthClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.PatchOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchOauthClient`: GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.PatchOauthClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/OrgConfigAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/OrgConfigAPI.md new file mode 100644 index 000000000..307f06672 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/OrgConfigAPI.md @@ -0,0 +1,257 @@ +--- +id: v2025-org-config +title: OrgConfig +pagination_label: OrgConfig +sidebar_label: OrgConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OrgConfig', 'V2025OrgConfig'] +slug: /tools/sdk/go/v2025/methods/org-config +tags: ['SDK', 'Software Development Kit', 'OrgConfig', 'V2025OrgConfig'] +--- + +# OrgConfigAPI + Use this API to implement organization configuration functionality. +Administrators can use this functionality to manage organization settings, such as time zones. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-org-config**](#get-org-config) | **Get** `/org-config` | Get Org Config Settings +[**get-valid-time-zones**](#get-valid-time-zones) | **Get** `/org-config/valid-time-zones` | Get Valid Time Zones +[**patch-org-config**](#patch-org-config) | **Patch** `/org-config` | Patch Org Config + + +## get-org-config +:::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 Org Config Settings +Get the current organization's configuration settings, only external accessible properties. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-org-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOrgConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**OrgConfig**](../models/org-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.OrgConfigAPI.GetOrgConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.OrgConfigAPI.GetOrgConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.GetOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOrgConfig`: OrgConfig + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.GetOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-valid-time-zones +:::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 Valid Time Zones +List the valid time zones that can be set in organization configurations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-valid-time-zones) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetValidTimeZonesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +**[]string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.OrgConfigAPI.GetValidTimeZones(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.OrgConfigAPI.GetValidTimeZones(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.GetValidTimeZones``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetValidTimeZones`: []string + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.GetValidTimeZones`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-org-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 + ``` +::: +Patch Org Config +Patch the current organization's configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization's time zone. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-org-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchOrgConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +[**OrgConfig**](../models/org-config) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + jsonpatchoperation := []byte(`[{op=replace, path=/timeZone, value=America/Toronto}]`) // []JsonPatchOperation | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.OrgConfigAPI.PatchOrgConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.OrgConfigAPI.PatchOrgConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.PatchOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchOrgConfig`: OrgConfig + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.PatchOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/PasswordConfigurationAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordConfigurationAPI.md new file mode 100644 index 000000000..53856aca2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordConfigurationAPI.md @@ -0,0 +1,235 @@ +--- +id: v2025-password-configuration +title: PasswordConfiguration +pagination_label: PasswordConfiguration +sidebar_label: PasswordConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordConfiguration', 'V2025PasswordConfiguration'] +slug: /tools/sdk/go/v2025/methods/password-configuration +tags: ['SDK', 'Software Development Kit', 'PasswordConfiguration', 'V2025PasswordConfiguration'] +--- + +# PasswordConfigurationAPI + Use this API to implement organization password configuration functionality. +With this functionality in place, organization administrators can create organization-specific password configurations. + +These configurations include details like custom password instructions, as well as digit token length and duration. + +Refer to [Configuring User Authentication for Password Resets](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html) for more information about organization password configuration functionality. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-org-config**](#create-password-org-config) | **Post** `/password-org-config` | Create Password Org Config +[**get-password-org-config**](#get-password-org-config) | **Get** `/password-org-config` | Get Password Org Config +[**put-password-org-config**](#put-password-org-config) | **Put** `/password-org-config` | Update Password Org Config + + +## create-password-org-config +Create Password Org Config +This API creates the password org config. Unspecified fields will use default value. +To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-password-org-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePasswordOrgConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordOrgConfig** | [**PasswordOrgConfig**](../models/password-org-config) | | + +### Return type + +[**PasswordOrgConfig**](../models/password-org-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordorgconfig := []byte(`{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }`) // PasswordOrgConfig | + + + var passwordOrgConfig v2025.PasswordOrgConfig + if err := json.Unmarshal(passwordorgconfig, &passwordOrgConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordConfigurationAPI.CreatePasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + //resp, r, err := apiClient.V2025.PasswordConfigurationAPI.CreatePasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.CreatePasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.CreatePasswordOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-password-org-config +Get Password Org Config +This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-password-org-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordOrgConfigRequest struct via the builder pattern + + +### Return type + +[**PasswordOrgConfig**](../models/password-org-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordConfigurationAPI.GetPasswordOrgConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.PasswordConfigurationAPI.GetPasswordOrgConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.GetPasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.GetPasswordOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-password-org-config +Update Password Org Config +This API updates the password org config for specified fields. Other fields will keep original value. +You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-password-org-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutPasswordOrgConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordOrgConfig** | [**PasswordOrgConfig**](../models/password-org-config) | | + +### Return type + +[**PasswordOrgConfig**](../models/password-org-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordorgconfig := []byte(`{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }`) // PasswordOrgConfig | + + + var passwordOrgConfig v2025.PasswordOrgConfig + if err := json.Unmarshal(passwordorgconfig, &passwordOrgConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordConfigurationAPI.PutPasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + //resp, r, err := apiClient.V2025.PasswordConfigurationAPI.PutPasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.PutPasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutPasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.PutPasswordOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/PasswordDictionaryAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordDictionaryAPI.md new file mode 100644 index 000000000..d809d7b1b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordDictionaryAPI.md @@ -0,0 +1,241 @@ +--- +id: v2025-password-dictionary +title: PasswordDictionary +pagination_label: PasswordDictionary +sidebar_label: PasswordDictionary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordDictionary', 'V2025PasswordDictionary'] +slug: /tools/sdk/go/v2025/methods/password-dictionary +tags: ['SDK', 'Software Development Kit', 'PasswordDictionary', 'V2025PasswordDictionary'] +--- + +# PasswordDictionaryAPI + Use this API to implement password dictionary functionality. +With this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords. + +A password dictionary is a list of words or characters that users are prevented from including in their passwords. +This can help protect users from themselves and force them to create passwords that are not easy to break. + +A password dictionary must meet the following requirements to for the API to handle them correctly: + +- It must be in .txt format. + +- All characters must be UTF-8 characters. + +- Each line must contain a single word or character with no spaces or whitespace characters. + +- It must contain at least one line other than the locale string. + +- Each line must not exceed 128 characters. + +- The file must not exceed 2500 lines. + +Administrators should also consider the following when they create their dictionaries: + +- Lines starting with a # represent comments. + +- All words in the password dictionary are case-insensitive. +For example, adding the word "password" to the dictionary also disallows the following: PASSWORD, Password, and PassWord. + +- The dictionary uses substring matching. +For example, adding the word "spring" to the dictionary also disallows the following: Spring124, 345SprinG, and 8spring. +Users can then select 'Change Password' to update their passwords. + +Administrators must do the following to create a password dictionary: + +- Create the text file that will contain the prohibited password values. + +- If the dictionary is not in English, they must add a locale string to the top line: locale:`languageCode`_`countryCode` + +The languageCode value refers to the language's 2-letter ISO 639-1 code. +The countryCode value refers to the country's 2-letter ISO 3166-1 code. + +Refer to this list https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html to see all the available ISO 639-1 language codes and ISO 3166-1 country codes. + +- Upload the .txt file to Identity Security Cloud with [Update Password Dictionary](https://developer.sailpoint.com/docs/api/v2025/put-password-dictionary). Uploading a new file always overwrites the previous dictionary file. + +Administrators can then specify which password policies check new passwords against the password dictionary by doing the following: In the Admin panel, they can use the Password Mgmt dropdown menu to select Policies, select the policy, and select the 'Prevent use of words in this site's password dictionary' checkbox beside it. + +Refer to [Configuring Advanced Password Management Options](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html) for more information about password dictionaries. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-password-dictionary**](#get-password-dictionary) | **Get** `/password-dictionary` | Get Password Dictionary +[**put-password-dictionary**](#put-password-dictionary) | **Put** `/password-dictionary` | Update Password Dictionary + + +## get-password-dictionary +Get Password Dictionary +This gets password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-password-dictionary) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordDictionaryRequest struct via the builder pattern + + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordDictionaryAPI.GetPasswordDictionary(context.Background()).Execute() + //resp, r, err := apiClient.V2025.PasswordDictionaryAPI.GetPasswordDictionary(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordDictionaryAPI.GetPasswordDictionary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordDictionary`: string + fmt.Fprintf(os.Stdout, "Response from `PasswordDictionaryAPI.GetPasswordDictionary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-password-dictionary +Update Password Dictionary +This updates password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-password-dictionary) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutPasswordDictionaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file** | ***os.File** | | + +### Return type + + (empty response body) + +### 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() { + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.PasswordDictionaryAPI.PutPasswordDictionary(context.Background()).Execute() + //r, err := apiClient.V2025.PasswordDictionaryAPI.PutPasswordDictionary(context.Background()).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordDictionaryAPI.PutPasswordDictionary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/PasswordManagementAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordManagementAPI.md new file mode 100644 index 000000000..24fd9b094 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordManagementAPI.md @@ -0,0 +1,363 @@ +--- +id: v2025-password-management +title: PasswordManagement +pagination_label: PasswordManagement +sidebar_label: PasswordManagement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordManagement', 'V2025PasswordManagement'] +slug: /tools/sdk/go/v2025/methods/password-management +tags: ['SDK', 'Software Development Kit', 'PasswordManagement', 'V2025PasswordManagement'] +--- + +# PasswordManagementAPI + Use this API to implement password management functionality. +With this functionality in place, users can manage their identity passwords for all their applications. + +In Identity Security Cloud, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. +Password Manager lists the user's identity's applications, possibly grouped to share passwords. +Users can then select 'Change Password' to update their passwords. + +Grouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. +Password Manager may list the applications and sources in the following groups: + +- Password Group: This refers to a group of applications that share a password. +For example, a user can use the same password for Google Drive, Google Mail, and YouTube. +Updating the password for the password group updates the password for all its included applications. + +- Multi-Application Source: This refers to a source with multiple applications that share a password. +For example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. +Updating the password for the multi-application source updates the password for all its included applications. + +- Applications: These are applications that do not share passwords with other applications. + +An organization may require some authentication for users to update their passwords. +Users may be required to answer security questions or use a third-party authenticator before they can confirm their updates. + +Refer to [Managing Passwords](https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html) for more information about password management. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-digit-token**](#create-digit-token) | **Post** `/generate-password-reset-token/digit` | Generate a digit token +[**get-password-change-status**](#get-password-change-status) | **Get** `/password-change-status/{id}` | Get Password Change Request Status +[**query-password-info**](#query-password-info) | **Post** `/query-password-info` | Query Password Info +[**set-password**](#set-password) | **Post** `/set-password` | Set Identity's Password + + +## create-digit-token +:::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 + ``` +::: +Generate a digit token +This API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create". + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-digit-token) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateDigitTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **passwordDigitTokenReset** | [**PasswordDigitTokenReset**](../models/password-digit-token-reset) | | + +### Return type + +[**PasswordDigitToken**](../models/password-digit-token) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + passworddigittokenreset := []byte(`{ + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + }`) // PasswordDigitTokenReset | + + + var passwordDigitTokenReset v2025.PasswordDigitTokenReset + if err := json.Unmarshal(passworddigittokenreset, &passwordDigitTokenReset); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordManagementAPI.CreateDigitToken(context.Background()).XSailPointExperimental(xSailPointExperimental).PasswordDigitTokenReset(passwordDigitTokenReset).Execute() + //resp, r, err := apiClient.V2025.PasswordManagementAPI.CreateDigitToken(context.Background()).XSailPointExperimental(xSailPointExperimental).PasswordDigitTokenReset(passwordDigitTokenReset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.CreateDigitToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDigitToken`: PasswordDigitToken + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.CreateDigitToken`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-password-change-status +Get Password Change Request Status +This API returns the status of a password change request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-password-change-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Password change request ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordChangeStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**PasswordStatus**](../models/password-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `089899f13a8f4da7824996191587bab9` // string | Password change request ID # string | Password change request ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordManagementAPI.GetPasswordChangeStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.PasswordManagementAPI.GetPasswordChangeStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.GetPasswordChangeStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordChangeStatus`: PasswordStatus + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.GetPasswordChangeStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## query-password-info +Query Password Info +This API is used to query password related information. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/query-password-info) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiQueryPasswordInfoRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordInfoQueryDTO** | [**PasswordInfoQueryDTO**](../models/password-info-query-dto) | | + +### Return type + +[**PasswordInfo**](../models/password-info) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordinfoquerydto := []byte(`{ + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + }`) // PasswordInfoQueryDTO | + + + var passwordInfoQueryDTO v2025.PasswordInfoQueryDTO + if err := json.Unmarshal(passwordinfoquerydto, &passwordInfoQueryDTO); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordManagementAPI.QueryPasswordInfo(context.Background()).PasswordInfoQueryDTO(passwordInfoQueryDTO).Execute() + //resp, r, err := apiClient.V2025.PasswordManagementAPI.QueryPasswordInfo(context.Background()).PasswordInfoQueryDTO(passwordInfoQueryDTO).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.QueryPasswordInfo``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `QueryPasswordInfo`: PasswordInfo + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.QueryPasswordInfo`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-password +Set Identity's Password +This API is used to set a password for an identity. + +An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). + +>**Note: If you want to set an identity's source account password, you must enable `PASSWORD` as one of the source's features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** + +To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: + +```bash +echo -n "myPassword" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 +``` + +In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. + +To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. + +If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. + +You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-password) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetPasswordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordChangeRequest** | [**PasswordChangeRequest**](../models/password-change-request) | | + +### Return type + +[**PasswordChangeResponse**](../models/password-change-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordchangerequest := []byte(`{ + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + }`) // PasswordChangeRequest | + + + var passwordChangeRequest v2025.PasswordChangeRequest + if err := json.Unmarshal(passwordchangerequest, &passwordChangeRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordManagementAPI.SetPassword(context.Background()).PasswordChangeRequest(passwordChangeRequest).Execute() + //resp, r, err := apiClient.V2025.PasswordManagementAPI.SetPassword(context.Background()).PasswordChangeRequest(passwordChangeRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.SetPassword``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetPassword`: PasswordChangeResponse + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.SetPassword`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/PasswordPoliciesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordPoliciesAPI.md new file mode 100644 index 000000000..5cbaf6a65 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordPoliciesAPI.md @@ -0,0 +1,435 @@ +--- +id: v2025-password-policies +title: PasswordPolicies +pagination_label: PasswordPolicies +sidebar_label: PasswordPolicies +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordPolicies', 'V2025PasswordPolicies'] +slug: /tools/sdk/go/v2025/methods/password-policies +tags: ['SDK', 'Software Development Kit', 'PasswordPolicies', 'V2025PasswordPolicies'] +--- + +# PasswordPoliciesAPI + Use these APIs to implement password policies functionality. +These APIs allow you to define the policy parameters for choosing passwords. + +IdentityNow comes with a default policy that you can modify to define the password requirements your users must meet to log in to IdentityNow, such as requiring a minimum password length, including special characters, and disallowing certain patterns. +If you have licensed Password Management, you can create additional password policies beyond the default one to manage passwords for supported sources in your org. + +In the Identity Security Cloud Admin panel, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/pwd_policies/pwd_policies.html) for more information about password policies. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-policy**](#create-password-policy) | **Post** `/password-policies` | Create Password Policy +[**delete-password-policy**](#delete-password-policy) | **Delete** `/password-policies/{id}` | Delete Password Policy by ID +[**get-password-policy-by-id**](#get-password-policy-by-id) | **Get** `/password-policies/{id}` | Get Password Policy by ID +[**list-password-policies**](#list-password-policies) | **Get** `/password-policies` | List Password Policies +[**set-password-policy**](#set-password-policy) | **Put** `/password-policies/{id}` | Update Password Policy by ID + + +## create-password-policy +Create Password Policy +This API creates the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-password-policy) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePasswordPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordPolicyV3Dto** | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | | + +### Return type + +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordpolicyv3dto := []byte(`{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : 1939056206564, + "validateAgainstAccountId" : false, + "dateCreated" : 1639056206564, + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }`) // PasswordPolicyV3Dto | + + + var passwordPolicyV3Dto v2025.PasswordPolicyV3Dto + if err := json.Unmarshal(passwordpolicyv3dto, &passwordPolicyV3Dto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordPoliciesAPI.CreatePasswordPolicy(context.Background()).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + //resp, r, err := apiClient.V2025.PasswordPoliciesAPI.CreatePasswordPolicy(context.Background()).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.CreatePasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordPolicy`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.CreatePasswordPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-password-policy +Delete Password Policy by ID +This API deletes the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-password-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password policy to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePasswordPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ff808081838d9e9d01838da6a03e0002` // string | The ID of password policy to delete. # string | The ID of password policy to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.PasswordPoliciesAPI.DeletePasswordPolicy(context.Background(), id).Execute() + //r, err := apiClient.V2025.PasswordPoliciesAPI.DeletePasswordPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.DeletePasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-password-policy-by-id +Get Password Policy by ID +This API returns the password policy for the specified ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-password-policy-by-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password policy to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordPolicyByIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ff808081838d9e9d01838da6a03e0005` // string | The ID of password policy to retrieve. # string | The ID of password policy to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordPoliciesAPI.GetPasswordPolicyById(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.PasswordPoliciesAPI.GetPasswordPolicyById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.GetPasswordPolicyById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordPolicyById`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.GetPasswordPolicyById`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-password-policies +List Password Policies +This gets list of all Password Policies. +Requires role of ORG_ADMIN + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-password-policies) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPasswordPoliciesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordPoliciesAPI.ListPasswordPolicies(context.Background()).Execute() + //resp, r, err := apiClient.V2025.PasswordPoliciesAPI.ListPasswordPolicies(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.ListPasswordPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPasswordPolicies`: []PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.ListPasswordPolicies`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-password-policy +Update Password Policy by ID +This API updates the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-password-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password policy to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetPasswordPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **passwordPolicyV3Dto** | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | | + +### Return type + +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ff808081838d9e9d01838da6a03e0007` // string | The ID of password policy to update. # string | The ID of password policy to update. + passwordpolicyv3dto := []byte(`{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : 1939056206564, + "validateAgainstAccountId" : false, + "dateCreated" : 1639056206564, + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }`) // PasswordPolicyV3Dto | + + + var passwordPolicyV3Dto v2025.PasswordPolicyV3Dto + if err := json.Unmarshal(passwordpolicyv3dto, &passwordPolicyV3Dto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordPoliciesAPI.SetPasswordPolicy(context.Background(), id).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + //resp, r, err := apiClient.V2025.PasswordPoliciesAPI.SetPasswordPolicy(context.Background(), id).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.SetPasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetPasswordPolicy`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.SetPasswordPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/PasswordSyncGroupsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordSyncGroupsAPI.md new file mode 100644 index 000000000..cd9d4defe --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/PasswordSyncGroupsAPI.md @@ -0,0 +1,408 @@ +--- +id: v2025-password-sync-groups +title: PasswordSyncGroups +pagination_label: PasswordSyncGroups +sidebar_label: PasswordSyncGroups +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordSyncGroups', 'V2025PasswordSyncGroups'] +slug: /tools/sdk/go/v2025/methods/password-sync-groups +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroups', 'V2025PasswordSyncGroups'] +--- + +# PasswordSyncGroupsAPI + Use this API to implement password sync group functionality. +With this functionality in place, administrators can group sources into password sync groups so that all their applications share the same password. +This allows users to update the password for all the applications in a sync group if they want, rather than updating each password individually. + +A password sync group is a group of applications that shares a password. +Administrators create these groups by grouping the applications' sources. +For example, an administrator can group the ActiveDirectory, GitHub, and G Suite sources together so that all those sources' applications can also be grouped to share a password. +A user can then update his or her password for ActiveDirectory, GitHub, Gmail, Google Drive, and Google Calendar all at once, rather then updating each one individually. + +The following are required for administrators to create a password sync group in Identity Security Cloud: + +- At least two direct connect sources connected to Identity Security Cloud and configured for Password Management. + +- Each authentication source in a sync group must have at least one application. Refer to [Adding and Resetting Application Passwords](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html#adding-and-resetting-application-passwords) for more information about adding applications to sources. + +- At least one password policy. Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/policies.html) for more information about password policies. + +In the Admin panel in Identity Security Cloud, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +To create a sync group, administrators must provide a name, choose a password policy to be enforced across the sources in the sync group, and select the sources to include in the sync group. + +Administrators can also delete sync groups in Identity Security Cloud, but they should know the following before they do: + +- Passwords related to the associated sources will become independent, so changing one will not change the others anymore. + +- Passwords for the sources' connected applications will also become independent. + +- Password policies assigned to the sync group are then assigned directly to the associated sources. +To change the password policy for a source, administrators must edit it directly. + +Once the password sync group has been created, users can update the password for the group in Password Manager. + +Refer to [Managing Password Sync Groups](https://documentation.sailpoint.com/saas/help/pwd/sync_grps.html) for more information about password sync groups. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-sync-group**](#create-password-sync-group) | **Post** `/password-sync-groups` | Create Password Sync Group +[**delete-password-sync-group**](#delete-password-sync-group) | **Delete** `/password-sync-groups/{id}` | Delete Password Sync Group by ID +[**get-password-sync-group**](#get-password-sync-group) | **Get** `/password-sync-groups/{id}` | Get Password Sync Group by ID +[**get-password-sync-groups**](#get-password-sync-groups) | **Get** `/password-sync-groups` | Get Password Sync Group List +[**update-password-sync-group**](#update-password-sync-group) | **Put** `/password-sync-groups/{id}` | Update Password Sync Group by ID + + +## create-password-sync-group +Create Password Sync Group +This API creates a password sync group based on the specifications provided. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-password-sync-group) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePasswordSyncGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordSyncGroup** | [**PasswordSyncGroup**](../models/password-sync-group) | | + +### Return type + +[**PasswordSyncGroup**](../models/password-sync-group) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordsyncgroup := []byte(`{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }`) // PasswordSyncGroup | + + + var passwordSyncGroup v2025.PasswordSyncGroup + if err := json.Unmarshal(passwordsyncgroup, &passwordSyncGroup); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordSyncGroupsAPI.CreatePasswordSyncGroup(context.Background()).PasswordSyncGroup(passwordSyncGroup).Execute() + //resp, r, err := apiClient.V2025.PasswordSyncGroupsAPI.CreatePasswordSyncGroup(context.Background()).PasswordSyncGroup(passwordSyncGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.CreatePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.CreatePasswordSyncGroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-password-sync-group +Delete Password Sync Group by ID +This API deletes the specified password sync group. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-password-sync-group) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password sync group to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePasswordSyncGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to delete. # string | The ID of password sync group to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.PasswordSyncGroupsAPI.DeletePasswordSyncGroup(context.Background(), id).Execute() + //r, err := apiClient.V2025.PasswordSyncGroupsAPI.DeletePasswordSyncGroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.DeletePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-password-sync-group +Get Password Sync Group by ID +This API returns the sync group for the specified ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-password-sync-group) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password sync group to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordSyncGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**PasswordSyncGroup**](../models/password-sync-group) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to retrieve. # string | The ID of password sync group to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordSyncGroupsAPI.GetPasswordSyncGroup(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.PasswordSyncGroupsAPI.GetPasswordSyncGroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.GetPasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.GetPasswordSyncGroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-password-sync-groups +Get Password Sync Group List +This API returns a list of password sync groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-password-sync-groups) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordSyncGroupsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]PasswordSyncGroup**](../models/password-sync-group) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordSyncGroupsAPI.GetPasswordSyncGroups(context.Background()).Execute() + //resp, r, err := apiClient.V2025.PasswordSyncGroupsAPI.GetPasswordSyncGroups(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.GetPasswordSyncGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordSyncGroups`: []PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.GetPasswordSyncGroups`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-password-sync-group +Update Password Sync Group by ID +This API updates the specified password sync group. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-password-sync-group) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password sync group to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdatePasswordSyncGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **passwordSyncGroup** | [**PasswordSyncGroup**](../models/password-sync-group) | | + +### Return type + +[**PasswordSyncGroup**](../models/password-sync-group) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to update. # string | The ID of password sync group to update. + passwordsyncgroup := []byte(`{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }`) // PasswordSyncGroup | + + + var passwordSyncGroup v2025.PasswordSyncGroup + if err := json.Unmarshal(passwordsyncgroup, &passwordSyncGroup); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordSyncGroupsAPI.UpdatePasswordSyncGroup(context.Background(), id).PasswordSyncGroup(passwordSyncGroup).Execute() + //resp, r, err := apiClient.V2025.PasswordSyncGroupsAPI.UpdatePasswordSyncGroup(context.Background(), id).PasswordSyncGroup(passwordSyncGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.UpdatePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.UpdatePasswordSyncGroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/PersonalAccessTokensAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/PersonalAccessTokensAPI.md new file mode 100644 index 000000000..aa57dd26b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/PersonalAccessTokensAPI.md @@ -0,0 +1,309 @@ +--- +id: v2025-personal-access-tokens +title: PersonalAccessTokens +pagination_label: PersonalAccessTokens +sidebar_label: PersonalAccessTokens +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PersonalAccessTokens', 'V2025PersonalAccessTokens'] +slug: /tools/sdk/go/v2025/methods/personal-access-tokens +tags: ['SDK', 'Software Development Kit', 'PersonalAccessTokens', 'V2025PersonalAccessTokens'] +--- + +# PersonalAccessTokensAPI + Use this API to implement personal access token (PAT) functionality. +With this functionality in place, users can use PATs as an alternative to passwords for authentication in Identity Security Cloud. + +PATs embed user information into the client ID and secret. +This replaces the API clients' need to store and provide a username and password to establish a connection, improving Identity Security Cloud organizations' integration security. + +In Identity Security Cloud, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens. +They must then provide a description about the token's purpose. +They can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID. + +Refer to [Managing Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/generate_tokens.html) for more information about PATs. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-personal-access-token**](#create-personal-access-token) | **Post** `/personal-access-tokens` | Create Personal Access Token +[**delete-personal-access-token**](#delete-personal-access-token) | **Delete** `/personal-access-tokens/{id}` | Delete Personal Access Token +[**list-personal-access-tokens**](#list-personal-access-tokens) | **Get** `/personal-access-tokens` | List Personal Access Tokens +[**patch-personal-access-token**](#patch-personal-access-token) | **Patch** `/personal-access-tokens/{id}` | Patch Personal Access Token + + +## create-personal-access-token +Create Personal Access Token +This creates a personal access token. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-personal-access-token) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePersonalAccessTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createPersonalAccessTokenRequest** | [**CreatePersonalAccessTokenRequest**](../models/create-personal-access-token-request) | Name and scope of personal access token. | + +### Return type + +[**CreatePersonalAccessTokenResponse**](../models/create-personal-access-token-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createpersonalaccesstokenrequest := []byte(`{ + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + }`) // CreatePersonalAccessTokenRequest | Name and scope of personal access token. + + + var createPersonalAccessTokenRequest v2025.CreatePersonalAccessTokenRequest + if err := json.Unmarshal(createpersonalaccesstokenrequest, &createPersonalAccessTokenRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PersonalAccessTokensAPI.CreatePersonalAccessToken(context.Background()).CreatePersonalAccessTokenRequest(createPersonalAccessTokenRequest).Execute() + //resp, r, err := apiClient.V2025.PersonalAccessTokensAPI.CreatePersonalAccessToken(context.Background()).CreatePersonalAccessTokenRequest(createPersonalAccessTokenRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.CreatePersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePersonalAccessToken`: CreatePersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.CreatePersonalAccessToken`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-personal-access-token +Delete Personal Access Token +This deletes a personal access token. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-personal-access-token) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The personal access token id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePersonalAccessTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The personal access token id # string | The personal access token id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.PersonalAccessTokensAPI.DeletePersonalAccessToken(context.Background(), id).Execute() + //r, err := apiClient.V2025.PersonalAccessTokensAPI.DeletePersonalAccessToken(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.DeletePersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## list-personal-access-tokens +List Personal Access Tokens +This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-personal-access-tokens) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPersonalAccessTokensRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' | + **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: **lastUsed**: *le, isnull* | + +### Return type + +[**[]GetPersonalAccessTokenResponse**](../models/get-personal-access-token-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c9180867b50d088017b554662fb281e` // string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) # string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + filters := `lastUsed le 2023-02-05T10:59:27.214Z` // 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PersonalAccessTokensAPI.ListPersonalAccessTokens(context.Background()).Execute() + //resp, r, err := apiClient.V2025.PersonalAccessTokensAPI.ListPersonalAccessTokens(context.Background()).OwnerId(ownerId).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.ListPersonalAccessTokens``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPersonalAccessTokens`: []GetPersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.ListPersonalAccessTokens`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-personal-access-token +Patch Personal Access Token +This performs a targeted update to the field(s) of a Personal Access Token. +Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-personal-access-token) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Personal Access Token id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchPersonalAccessTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope | + +### Return type + +[**GetPersonalAccessTokenResponse**](../models/get-personal-access-token-response) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The Personal Access Token id # string | The Personal Access Token id + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}]`) // []JsonPatchOperation | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PersonalAccessTokensAPI.PatchPersonalAccessToken(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.PersonalAccessTokensAPI.PatchPersonalAccessToken(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.PatchPersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPersonalAccessToken`: GetPersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.PatchPersonalAccessToken`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/PublicIdentitiesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/PublicIdentitiesAPI.md new file mode 100644 index 000000000..d10743ddc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/PublicIdentitiesAPI.md @@ -0,0 +1,95 @@ +--- +id: v2025-public-identities +title: PublicIdentities +pagination_label: PublicIdentities +sidebar_label: PublicIdentities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentities', 'V2025PublicIdentities'] +slug: /tools/sdk/go/v2025/methods/public-identities +tags: ['SDK', 'Software Development Kit', 'PublicIdentities', 'V2025PublicIdentities'] +--- + +# PublicIdentitiesAPI + Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/docs/api/v2025/public-identities-config/) to enable non-administrators to view identities' publicly visible attributes. +With this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public. +This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-public-identities**](#get-public-identities) | **Get** `/public-identities` | Get list of public identities + + +## get-public-identities +Get list of public identities +Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-public-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPublicIdentitiesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* | + **addCoreFilters** | **bool** | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. | [default to false] + **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** | + +### Return type + +[**[]PublicIdentity**](../models/public-identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `firstname eq "John"` // 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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) + addCoreFilters := false // bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to false) # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to false) + sorters := `name` // 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** (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** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PublicIdentitiesAPI.GetPublicIdentities(context.Background()).Execute() + //resp, r, err := apiClient.V2025.PublicIdentitiesAPI.GetPublicIdentities(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).AddCoreFilters(addCoreFilters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesAPI.GetPublicIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPublicIdentities`: []PublicIdentity + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesAPI.GetPublicIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/PublicIdentitiesConfigAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/PublicIdentitiesConfigAPI.md new file mode 100644 index 000000000..5ccb58565 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/PublicIdentitiesConfigAPI.md @@ -0,0 +1,170 @@ +--- +id: v2025-public-identities-config +title: PublicIdentitiesConfig +pagination_label: PublicIdentitiesConfig +sidebar_label: PublicIdentitiesConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentitiesConfig', 'V2025PublicIdentitiesConfig'] +slug: /tools/sdk/go/v2025/methods/public-identities-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentitiesConfig', 'V2025PublicIdentitiesConfig'] +--- + +# PublicIdentitiesConfigAPI + Use this API to implement public identity configuration functionality. +With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. +This can be helpful for approvers making approvals, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +By default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. +However, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc. +Administrators can use this API to make those necessary identity attributes public to non-administrators. + +For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. +If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/docs/api/v2025/update-public-identity-config/) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-public-identity-config**](#get-public-identity-config) | **Get** `/public-identities-config` | Get the Public Identities Configuration +[**update-public-identity-config**](#update-public-identity-config) | **Put** `/public-identities-config` | Update the Public Identities Configuration + + +## get-public-identity-config +Get the Public Identities Configuration +Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-public-identity-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPublicIdentityConfigRequest struct via the builder pattern + + +### Return type + +[**PublicIdentityConfig**](../models/public-identity-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PublicIdentitiesConfigAPI.GetPublicIdentityConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.PublicIdentitiesConfigAPI.GetPublicIdentityConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesConfigAPI.GetPublicIdentityConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPublicIdentityConfig`: PublicIdentityConfig + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesConfigAPI.GetPublicIdentityConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-public-identity-config +Update the Public Identities Configuration +Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-public-identity-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdatePublicIdentityConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **publicIdentityConfig** | [**PublicIdentityConfig**](../models/public-identity-config) | | + +### Return type + +[**PublicIdentityConfig**](../models/public-identity-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + publicidentityconfig := []byte(`{ + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }`) // PublicIdentityConfig | + + + var publicIdentityConfig v2025.PublicIdentityConfig + if err := json.Unmarshal(publicidentityconfig, &publicIdentityConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig(context.Background()).PublicIdentityConfig(publicIdentityConfig).Execute() + //resp, r, err := apiClient.V2025.PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig(context.Background()).PublicIdentityConfig(publicIdentityConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePublicIdentityConfig`: PublicIdentityConfig + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ReportsDataExtractionAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ReportsDataExtractionAPI.md new file mode 100644 index 000000000..7533ac9d0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ReportsDataExtractionAPI.md @@ -0,0 +1,304 @@ +--- +id: v2025-reports-data-extraction +title: ReportsDataExtraction +pagination_label: ReportsDataExtraction +sidebar_label: ReportsDataExtraction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportsDataExtraction', 'V2025ReportsDataExtraction'] +slug: /tools/sdk/go/v2025/methods/reports-data-extraction +tags: ['SDK', 'Software Development Kit', 'ReportsDataExtraction', 'V2025ReportsDataExtraction'] +--- + +# ReportsDataExtractionAPI + Use this API to implement reports lifecycle managing and monitoring. +With this functionality in place, users can run reports, view their results, and cancel reports in progress. +This can be potentially helpful for auditing purposes. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-report**](#cancel-report) | **Post** `/reports/{id}/cancel` | Cancel Report +[**get-report**](#get-report) | **Get** `/reports/{taskResultId}` | Get Report File +[**get-report-result**](#get-report-result) | **Get** `/reports/{taskResultId}/result` | Get Report Result +[**start-report**](#start-report) | **Post** `/reports/run` | Run Report + + +## cancel-report +Cancel Report +Cancels a running report. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/cancel-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the running Report to cancel | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCancelReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `a1ed223247144cc29d23c632624b4767` // string | ID of the running Report to cancel # string | ID of the running Report to cancel + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ReportsDataExtractionAPI.CancelReport(context.Background(), id).Execute() + //r, err := apiClient.V2025.ReportsDataExtractionAPI.CancelReport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.CancelReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-report +Get Report File +Gets a report in file format. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**taskResultId** | **string** | Unique identifier of the task result which handled report | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **fileFormat** | **string** | Output format of the requested report file | + **name** | **string** | preferred Report file name, by default will be used report name from task result. | + **auditable** | **bool** | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. | [default to false] + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/csv, application/pdf, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + taskResultId := `ef38f94347e94562b5bb8424a56397d8` // string | Unique identifier of the task result which handled report # string | Unique identifier of the task result which handled report + fileFormat := `csv` // string | Output format of the requested report file # string | Output format of the requested report file + name := `Identities Details Report` // string | preferred Report file name, by default will be used report name from task result. (optional) # string | preferred Report file name, by default will be used report name from task result. (optional) + auditable := true // bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to false) # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ReportsDataExtractionAPI.GetReport(context.Background(), taskResultId).FileFormat(fileFormat).Execute() + //resp, r, err := apiClient.V2025.ReportsDataExtractionAPI.GetReport(context.Background(), taskResultId).FileFormat(fileFormat).Name(name).Auditable(auditable).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.GetReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.GetReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-report-result +Get Report Result +Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-report-result) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**taskResultId** | **string** | Unique identifier of the task result which handled report | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetReportResultRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **completed** | **bool** | state of task result to apply ordering when results are fetching from the DB | [default to false] + +### Return type + +[**ReportResults**](../models/report-results) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + taskResultId := `ef38f94347e94562b5bb8424a56397d8` // string | Unique identifier of the task result which handled report # string | Unique identifier of the task result which handled report + completed := true // bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to false) # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ReportsDataExtractionAPI.GetReportResult(context.Background(), taskResultId).Execute() + //resp, r, err := apiClient.V2025.ReportsDataExtractionAPI.GetReportResult(context.Background(), taskResultId).Completed(completed).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.GetReportResult``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReportResult`: ReportResults + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.GetReportResult`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-report +Run Report +Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-report) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **reportDetails** | [**ReportDetails**](../models/report-details) | | + +### Return type + +[**TaskResultDetails**](../models/task-result-details) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reportdetails := []byte(`{ + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + }`) // ReportDetails | + + + var reportDetails v2025.ReportDetails + if err := json.Unmarshal(reportdetails, &reportDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ReportsDataExtractionAPI.StartReport(context.Background()).ReportDetails(reportDetails).Execute() + //resp, r, err := apiClient.V2025.ReportsDataExtractionAPI.StartReport(context.Background()).ReportDetails(reportDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.StartReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartReport`: TaskResultDetails + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.StartReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/RequestableObjectsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/RequestableObjectsAPI.md new file mode 100644 index 000000000..3092191a4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/RequestableObjectsAPI.md @@ -0,0 +1,102 @@ +--- +id: v2025-requestable-objects +title: RequestableObjects +pagination_label: RequestableObjects +sidebar_label: RequestableObjects +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObjects', 'V2025RequestableObjects'] +slug: /tools/sdk/go/v2025/methods/requestable-objects +tags: ['SDK', 'Software Development Kit', 'RequestableObjects', 'V2025RequestableObjects'] +--- + +# RequestableObjectsAPI + Use this API to implement requestable object functionality. +With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/docs/api/v2025/access-requests/), along with their statuses. +This can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**list-requestable-objects**](#list-requestable-objects) | **Get** `/requestable-objects` | Requestable Objects List + + +## list-requestable-objects +Requestable Objects List +Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. +Any authenticated token can call this endpoint to see their requestable access items. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-requestable-objects) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListRequestableObjectsRequest struct via the builder pattern + + +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. | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, in, sw* | + **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** | + +### Return type + +[**[]RequestableObject**](../models/requestable-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw "bob"` // 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, in, sw* (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, in, sw* (optional) + sorters := `name` // 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** (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** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RequestableObjectsAPI.ListRequestableObjects(context.Background()).Execute() + //resp, r, err := apiClient.V2025.RequestableObjectsAPI.ListRequestableObjects(context.Background()).IdentityId(identityId).Types(types).Term(term).Statuses(statuses).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RequestableObjectsAPI.ListRequestableObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListRequestableObjects`: []RequestableObject + fmt.Fprintf(os.Stdout, "Response from `RequestableObjectsAPI.ListRequestableObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/RoleInsightsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/RoleInsightsAPI.md new file mode 100644 index 000000000..784f1cec5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/RoleInsightsAPI.md @@ -0,0 +1,762 @@ +--- +id: v2025-role-insights +title: RoleInsights +pagination_label: RoleInsights +sidebar_label: RoleInsights +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsights', 'V2025RoleInsights'] +slug: /tools/sdk/go/v2025/methods/role-insights +tags: ['SDK', 'Software Development Kit', 'RoleInsights', 'V2025RoleInsights'] +--- + +# RoleInsightsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-role-insight-requests**](#create-role-insight-requests) | **Post** `/role-insights/requests` | Generate insights for roles +[**download-role-insights-entitlements-changes**](#download-role-insights-entitlements-changes) | **Get** `/role-insights/{insightId}/entitlement-changes/download` | Download entitlement insights for a role +[**get-entitlement-changes-identities**](#get-entitlement-changes-identities) | **Get** `/role-insights/{insightId}/entitlement-changes/{entitlementId}/identities` | Get identities for a suggested entitlement (for a role) +[**get-role-insight**](#get-role-insight) | **Get** `/role-insights/{insightId}` | Get a single role insight +[**get-role-insights**](#get-role-insights) | **Get** `/role-insights` | Get role insights +[**get-role-insights-current-entitlements**](#get-role-insights-current-entitlements) | **Get** `/role-insights/{insightId}/current-entitlements` | Get current entitlement for a role +[**get-role-insights-entitlements-changes**](#get-role-insights-entitlements-changes) | **Get** `/role-insights/{insightId}/entitlement-changes` | Get entitlement insights for a role +[**get-role-insights-requests**](#get-role-insights-requests) | **Get** `/role-insights/requests/{id}` | Returns metadata from prior request. +[**get-role-insights-summary**](#get-role-insights-summary) | **Get** `/role-insights/summary` | Get role insights summary information + + +## create-role-insight-requests +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::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 + ``` +::: +Generate insights for roles +Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-role-insight-requests) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateRoleInsightRequestsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleInsightsResponse**](../models/role-insights-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RoleInsightsAPI.CreateRoleInsightRequests(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.CreateRoleInsightRequests(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.CreateRoleInsightRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRoleInsightRequests`: RoleInsightsResponse + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.CreateRoleInsightRequests`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## download-role-insights-entitlements-changes +:::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 + ``` +::: +Download entitlement insights for a role +This endpoint returns the entitlement insights for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/download-role-insights-entitlements-changes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**insightId** | **string** | The role insight id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDownloadRoleInsightsEntitlementsChangesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. | + **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: **name**: *sw* **description**: *sw* | + +### Return type + +**string** + +### 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() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight 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") + sorters := `identitiesWithAccess` // 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + filters := `name sw "r"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DownloadRoleInsightsEntitlementsChanges`: string + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlement-changes-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 + ``` +::: +Get identities for a suggested entitlement (for a role) +Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlement-changes-identities) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**insightId** | **string** | The role insight id | +**entitlementId** | **string** | The entitlement id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementChangesIdentitiesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **hasEntitlement** | **bool** | Identity has this entitlement or not | [default to false] + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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** | + **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: **name**: *sw* | + +### Return type + +[**[]RoleInsightsIdentities**](../models/role-insights-identities) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight id + entitlementId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The entitlement id # string | The entitlement 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") + hasEntitlement := true // bool | Identity has this entitlement or not (optional) (default to false) # bool | Identity has this entitlement or not (optional) (default to false) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name` // 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** (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** (optional) + filters := `name sw "Jan"` // 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: **name**: *sw* (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: **name**: *sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RoleInsightsAPI.GetEntitlementChangesIdentities(context.Background(), insightId, entitlementId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.GetEntitlementChangesIdentities(context.Background(), insightId, entitlementId).XSailPointExperimental(xSailPointExperimental).HasEntitlement(hasEntitlement).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetEntitlementChangesIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementChangesIdentities`: []RoleInsightsIdentities + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetEntitlementChangesIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insight +:::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 a single role insight +This endpoint gets role insights information for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role-insight) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**insightId** | **string** | The role insight id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleInsight**](../models/role-insight) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight 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.RoleInsightsAPI.GetRoleInsight(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsight(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsight``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsight`: RoleInsight + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsight`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insights +:::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 role insights +This method returns detailed role insights for each role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role-insights) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** | + **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: **name**: *sw* **ownerName**: *sw* **description**: *sw* | + +### Return type + +[**[]RoleInsight**](../models/role-insight) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `numberOfUpdates` // 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + filters := `name sw "John"` // 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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsights(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsights(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsights``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsights`: []RoleInsight + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsights`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insights-current-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 + ``` +::: +Get current entitlement for a role +This endpoint gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role-insights-current-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**insightId** | **string** | The role insight id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightsCurrentEntitlementsRequest struct via the builder pattern + + +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: **name**: *sw* **description**: *sw* | + +### Return type + +[**[]RoleInsightsEntitlement**](../models/role-insights-entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight 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") + filters := `name sw "r"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsightsCurrentEntitlements(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsightsCurrentEntitlements(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsCurrentEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsCurrentEntitlements`: []RoleInsightsEntitlement + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsCurrentEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insights-entitlements-changes +:::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 entitlement insights for a role +This endpoint returns entitlement insights for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role-insights-entitlements-changes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**insightId** | **string** | The role insight id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightsEntitlementsChangesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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: **identitiesWithAccess, name** | + **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: **name**: *sw* **description**: *sw* | + +### Return type + +[**[]RoleInsightsEntitlementChanges**](../models/role-insights-entitlement-changes) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight 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") + sorters := `sorters_example` // 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: **identitiesWithAccess, name** (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: **identitiesWithAccess, name** (optional) + filters := `name sw "Admin"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsightsEntitlementsChanges(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsightsEntitlementsChanges(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsEntitlementsChanges``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsEntitlementsChanges`: []RoleInsightsEntitlementChanges + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsEntitlementsChanges`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insights-requests +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::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 + ``` +::: +Returns metadata from prior request. +This endpoint returns details of a prior role insights request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role-insights-requests) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The role insights request id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightsRequestsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleInsightsResponse**](../models/role-insights-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insights request id # string | The role insights request 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.RoleInsightsAPI.GetRoleInsightsRequests(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsightsRequests(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsRequests`: RoleInsightsResponse + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsRequests`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-insights-summary +:::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 role insights summary information +This method returns high level summary information for role insights for a customer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role-insights-summary) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleInsightsSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**RoleInsightsSummary**](../models/role-insights-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsightsSummary(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsightsSummary(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsSummary`: RoleInsightsSummary + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/RolesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/RolesAPI.md new file mode 100644 index 000000000..9ea01cdf9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/RolesAPI.md @@ -0,0 +1,1449 @@ +--- +id: v2025-roles +title: Roles +pagination_label: Roles +sidebar_label: Roles +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Roles', 'V2025Roles'] +slug: /tools/sdk/go/v2025/methods/roles +tags: ['SDK', 'Software Development Kit', 'Roles', 'V2025Roles'] +--- + +# RolesAPI + Use this API to implement and customize role functionality. +With this functionality in place, administrators can create roles and configure them for use throughout Identity Security Cloud. +Identity Security Cloud can use established criteria to automatically assign the roles to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. + +Entitlements represent the most granular level of access in Identity Security Cloud. +Access profiles represent the next level and often group entitlements. +Roles represent the broadest level of access and often group access profiles. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Roles often represent positions within organizations. +For example, an organization's accountant can access all the tools the organization's accountants need with the 'Accountant' role. +If the accountant switches to engineering, a qualified member of the organization can quickly revoke the accountant's 'Accountant' access and grant access to the 'Engineer' role instead, granting access to all the tools the organization's engineers need. + +In Identity Security Cloud, adminstrators can use the Access drop-down menu and select Roles to view, configure, and delete existing roles, as well as create new ones. +Administrators can enable and disable the role, and they can also make the following configurations: + +- Manage Access: Manage the role's access by adding or removing access profiles. + +- Define Assignment: Define the criteria Identity Security Cloud uses to assign the role to identities. +Use the first option, 'Standard Criteria,' to provide specific criteria for assignment like specific account attributes, entitlements, or identity attributes. +Use the second, 'Identity List,' to specify the identities for assignment. + +- Access Requests: Configure roles to be requestable and establish an approval process for any requests that the role be granted or revoked. +Do not configure a role to be requestable without establishing a secure access request approval process for that role first. + +Refer to [Working with Roles](https://documentation.sailpoint.com/saas/help/access/roles.html) for more information about roles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-role**](#create-role) | **Post** `/roles` | Create a Role +[**delete-bulk-roles**](#delete-bulk-roles) | **Post** `/roles/bulk-delete` | Delete Role(s) +[**delete-metadata-from-role-by-key-and-value**](#delete-metadata-from-role-by-key-and-value) | **Delete** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove a Metadata From Role. +[**delete-role**](#delete-role) | **Delete** `/roles/{id}` | Delete a Role +[**get-bulk-update-status**](#get-bulk-update-status) | **Get** `/roles/access-model-metadata/bulk-update` | Get Bulk-Update Statuses +[**get-bulk-update-status-by-id**](#get-bulk-update-status-by-id) | **Get** `/roles/access-model-metadata/bulk-update/id` | Get Bulk-Update Status by ID +[**get-role**](#get-role) | **Get** `/roles/{id}` | Get a Role +[**get-role-assigned-identities**](#get-role-assigned-identities) | **Get** `/roles/{id}/assigned-identities` | List Identities assigned a Role +[**get-role-entitlements**](#get-role-entitlements) | **Get** `/roles/{id}/entitlements` | List Role's Entitlements +[**list-roles**](#list-roles) | **Get** `/roles` | List Roles +[**patch-role**](#patch-role) | **Patch** `/roles/{id}` | Patch a specified Role +[**search-roles-by-filter**](#search-roles-by-filter) | **Post** `/roles/filter` | Filter Roles by Metadata +[**update-attribute-key-and-value-to-role**](#update-attribute-key-and-value-to-role) | **Post** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add a Metadata to Role. +[**update-roles-metadata-by-filter**](#update-roles-metadata-by-filter) | **Post** `/roles/access-model-metadata/bulk-update/filter` | Bulk-Update Roles' Metadata by Filters +[**update-roles-metadata-by-ids**](#update-roles-metadata-by-ids) | **Post** `/roles/access-model-metadata/bulk-update/ids` | Bulk-Update Roles' Metadata by ID +[**update-roles-metadata-by-query**](#update-roles-metadata-by-query) | **Post** `/roles/access-model-metadata/bulk-update/query` | Bulk-Update Roles' Metadata by Query + + +## create-role +Create a Role +This API creates a role. + +You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. + +In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-role) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **role** | [**Role**](../models/role) | | + +### Return type + +[**Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + role := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + }`) // Role | + + + var role v2025.Role + if err := json.Unmarshal(role, &role); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.CreateRole(context.Background()).Role(role).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.CreateRole(context.Background()).Role(role).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.CreateRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.CreateRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-bulk-roles +Delete Role(s) +This endpoint initiates a bulk deletion of one or more roles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 roles per request. +A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-bulk-roles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteBulkRolesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **roleBulkDeleteRequest** | [**RoleBulkDeleteRequest**](../models/role-bulk-delete-request) | | + +### Return type + +[**TaskResultDto**](../models/task-result-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + rolebulkdeleterequest := []byte(`{ + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + }`) // RoleBulkDeleteRequest | + + + var roleBulkDeleteRequest v2025.RoleBulkDeleteRequest + if err := json.Unmarshal(rolebulkdeleterequest, &roleBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.DeleteBulkRoles(context.Background()).RoleBulkDeleteRequest(roleBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.DeleteBulkRoles(context.Background()).RoleBulkDeleteRequest(roleBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteBulkRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteBulkRoles`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.DeleteBulkRoles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-metadata-from-role-by-key-and-value +Remove a Metadata From Role. +This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-metadata-from-role-by-key-and-value) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The role's id. | +**attributeKey** | **string** | Technical name of the Attribute. | +**attributeValue** | **string** | Technical name of the Attribute Value. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteMetadataFromRoleByKeyAndValueRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | The role's id. # string | The role's id. + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.RolesAPI.DeleteMetadataFromRoleByKeyAndValue(context.Background(), id, attributeKey, attributeValue).Execute() + //r, err := apiClient.V2025.RolesAPI.DeleteMetadataFromRoleByKeyAndValue(context.Background(), id, attributeKey, attributeValue).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteMetadataFromRoleByKeyAndValue``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-role +Delete a Role +This API deletes a Role by its ID. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Role | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role # string | ID of the Role + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.RolesAPI.DeleteRole(context.Background(), id).Execute() + //r, err := apiClient.V2025.RolesAPI.DeleteRole(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-bulk-update-status +Get Bulk-Update Statuses +This API returns a list of all unfinished bulk update process status of the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-bulk-update-status) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetBulkUpdateStatusRequest struct via the builder pattern + + +### Return type + +[**[]RoleGetAllBulkUpdateResponse**](../models/role-get-all-bulk-update-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.GetBulkUpdateStatus(context.Background()).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.GetBulkUpdateStatus(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetBulkUpdateStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBulkUpdateStatus`: []RoleGetAllBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetBulkUpdateStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-bulk-update-status-by-id +Get Bulk-Update Status by ID + +This API initial a request for one bulk update's status by bulk update Id returns the status of the bulk update process. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-bulk-update-status-by-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Id of the bulk update task. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetBulkUpdateStatusByIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**RoleBulkUpdateResponse**](../models/role-bulk-update-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c24359c389374d0fb8585698a2189e3d` // string | The Id of the bulk update task. # string | The Id of the bulk update task. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.GetBulkUpdateStatusById(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.GetBulkUpdateStatusById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetBulkUpdateStatusById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBulkUpdateStatusById`: RoleBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetBulkUpdateStatusById`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role +Get a Role +This API returns a Role by its ID. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Role | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role # string | ID of the Role + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.GetRole(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.GetRole(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-assigned-identities +List Identities assigned a Role + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role-assigned-identities) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Role for which the assigned Identities are to be listed | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleAssignedIdentitiesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* | + **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: **id, name, aliasName, email** | + +### Return type + +[**[]RoleIdentity**](../models/role-identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role for which the assigned Identities are to be listed # string | ID of the Role for which the assigned Identities are to be listed + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw Joe` // 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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + sorters := `aliasName,name` // 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: **id, name, aliasName, email** (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: **id, name, aliasName, email** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.GetRoleAssignedIdentities(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.GetRoleAssignedIdentities(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRoleAssignedIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleAssignedIdentities`: []RoleIdentity + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRoleAssignedIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-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 + ``` +::: +List Role's Entitlements +Get a list of entitlements associated with a specified role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-role-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Containing role's ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleEntitlementsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* | + **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, attribute, value, created, modified** | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | Containing role's ID. # string | Containing role's 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") + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.GetRoleEntitlements(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.GetRoleEntitlements(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRoleEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRoleEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-roles +List Roles +This API returns a list of Roles. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-roles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListRolesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **forSubadmin** | **string** | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. | + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *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, created, modified** | + **forSegmentIds** | **string** | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. | + **includeUnsegmented** | **bool** | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. | [default to true] + +### Return type + +[**[]Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `requestable 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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.ListRoles(context.Background()).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.ListRoles(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.ListRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListRoles`: []Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.ListRoles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-role +Patch a specified Role +This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: + +* name +* description +* enabled +* owner +* accessProfiles +* entitlements +* membership +* requestable +* accessRequestConfig +* revokeRequestConfig +* segments +* accessModelMetadata +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Role to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role to patch # string | ID of the Role to patch + jsonpatchoperation := []byte(`[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.PatchRole(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.PatchRole(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.PatchRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.PatchRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-roles-by-filter +Filter Roles by Metadata +This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/search-roles-by-filter) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchRolesByFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **forSubadmin** | **string** | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. | + **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 50] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, created, modified** | + **forSegmentIds** | **string** | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. | + **includeUnsegmented** | **bool** | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. | [default to true] + **roleListFilterDTO** | [**RoleListFilterDTO**](../models/role-list-filter-dto) | | + +### Return type + +**Role** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit := 50 // 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 50) # 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 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) + rolelistfilterdto := []byte(`{ + "ammKeyValues" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "secret" ] + } ], + "filters" : "dimensional eq false" + }`) // RoleListFilterDTO | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.SearchRolesByFilter(context.Background()).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.SearchRolesByFilter(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).RoleListFilterDTO(roleListFilterDTO).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.SearchRolesByFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchRolesByFilter`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.SearchRolesByFilter`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-attribute-key-and-value-to-role +Add a Metadata to Role. +This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-attribute-key-and-value-to-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Id of a role | +**attributeKey** | **string** | Technical name of the Attribute. | +**attributeValue** | **string** | Technical name of the Attribute Value. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateAttributeKeyAndValueToRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c24359c389374d0fb8585698a2189e3d` // string | The Id of a role # string | The Id of a role + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.UpdateAttributeKeyAndValueToRole(context.Background(), id, attributeKey, attributeValue).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.UpdateAttributeKeyAndValueToRole(context.Background(), id, attributeKey, attributeValue).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.UpdateAttributeKeyAndValueToRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAttributeKeyAndValueToRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.UpdateAttributeKeyAndValueToRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-roles-metadata-by-filter +Bulk-Update Roles' Metadata by Filters +This API initiates a bulk update of metadata for one or more Roles by filter. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +The maximum metadata value count for a single role is 25. +Custom metadata update, including add, replace need suit licensed. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-roles-metadata-by-filter) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateRolesMetadataByFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **roleMetadataBulkUpdateByFilterRequest** | [**RoleMetadataBulkUpdateByFilterRequest**](../models/role-metadata-bulk-update-by-filter-request) | | + +### Return type + +[**RoleBulkUpdateResponse**](../models/role-bulk-update-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + rolemetadatabulkupdatebyfilterrequest := []byte(`{ + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "filters" : " requestable eq false", + "replaceScope" : "ALL", + "operation" : "REPLACE" + }`) // RoleMetadataBulkUpdateByFilterRequest | + + + var roleMetadataBulkUpdateByFilterRequest v2025.RoleMetadataBulkUpdateByFilterRequest + if err := json.Unmarshal(rolemetadatabulkupdatebyfilterrequest, &roleMetadataBulkUpdateByFilterRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.UpdateRolesMetadataByFilter(context.Background()).RoleMetadataBulkUpdateByFilterRequest(roleMetadataBulkUpdateByFilterRequest).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.UpdateRolesMetadataByFilter(context.Background()).RoleMetadataBulkUpdateByFilterRequest(roleMetadataBulkUpdateByFilterRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.UpdateRolesMetadataByFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRolesMetadataByFilter`: RoleBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.UpdateRolesMetadataByFilter`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-roles-metadata-by-ids +Bulk-Update Roles' Metadata by ID +This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. +Custom metadata update, including add, replace need suit licensed. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-roles-metadata-by-ids) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateRolesMetadataByIdsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **roleMetadataBulkUpdateByIdRequest** | [**RoleMetadataBulkUpdateByIdRequest**](../models/role-metadata-bulk-update-by-id-request) | | + +### Return type + +[**RoleBulkUpdateResponse**](../models/role-bulk-update-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + rolemetadatabulkupdatebyidrequest := []byte(`{ + "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + }`) // RoleMetadataBulkUpdateByIdRequest | + + + var roleMetadataBulkUpdateByIdRequest v2025.RoleMetadataBulkUpdateByIdRequest + if err := json.Unmarshal(rolemetadatabulkupdatebyidrequest, &roleMetadataBulkUpdateByIdRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.UpdateRolesMetadataByIds(context.Background()).RoleMetadataBulkUpdateByIdRequest(roleMetadataBulkUpdateByIdRequest).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.UpdateRolesMetadataByIds(context.Background()).RoleMetadataBulkUpdateByIdRequest(roleMetadataBulkUpdateByIdRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.UpdateRolesMetadataByIds``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRolesMetadataByIds`: RoleBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.UpdateRolesMetadataByIds`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-roles-metadata-by-query +Bulk-Update Roles' Metadata by Query +This API initiates a bulk update of metadata for one or more Roles by query. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +The maximum metadata value count for a single role is 25. +Custom metadata update, including add, replace need suit licensed. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-roles-metadata-by-query) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateRolesMetadataByQueryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **roleMetadataBulkUpdateByQueryRequest** | [**RoleMetadataBulkUpdateByQueryRequest**](../models/role-metadata-bulk-update-by-query-request) | | + +### Return type + +[**RoleBulkUpdateResponse**](../models/role-bulk-update-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + rolemetadatabulkupdatebyqueryrequest := []byte(`{ + "query" : { + "query\"" : { + "indices" : [ "roles" ], + "queryType" : "TEXT", + "textQuery" : { + "terms" : [ "test123" ], + "fields" : [ "id" ], + "matchAny" : false, + "contains" : true + }, + "includeNested" : false + } + }, + "values" : [ { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + }, { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + }`) // RoleMetadataBulkUpdateByQueryRequest | + + + var roleMetadataBulkUpdateByQueryRequest v2025.RoleMetadataBulkUpdateByQueryRequest + if err := json.Unmarshal(rolemetadatabulkupdatebyqueryrequest, &roleMetadataBulkUpdateByQueryRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.UpdateRolesMetadataByQuery(context.Background()).RoleMetadataBulkUpdateByQueryRequest(roleMetadataBulkUpdateByQueryRequest).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.UpdateRolesMetadataByQuery(context.Background()).RoleMetadataBulkUpdateByQueryRequest(roleMetadataBulkUpdateByQueryRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.UpdateRolesMetadataByQuery``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRolesMetadataByQuery`: RoleBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.UpdateRolesMetadataByQuery`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SIMIntegrationsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SIMIntegrationsAPI.md new file mode 100644 index 000000000..b363643ef --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SIMIntegrationsAPI.md @@ -0,0 +1,658 @@ +--- +id: v2025-sim-integrations +title: SIMIntegrations +pagination_label: SIMIntegrations +sidebar_label: SIMIntegrations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SIMIntegrations', 'V2025SIMIntegrations'] +slug: /tools/sdk/go/v2025/methods/sim-integrations +tags: ['SDK', 'Software Development Kit', 'SIMIntegrations', 'V2025SIMIntegrations'] +--- + +# SIMIntegrationsAPI + Use this API to administer IdentityNow's Service Integration Module, or SIM integration with ServiceNow, so that it converts IdentityNow provisioning actions into tickets in ServiceNow. + +ServiceNow is a software platform that supports IT service management and automates common business processes for requesting and fulfilling service requests across a business enterprise. + +You must have an IdentityNow ServiceNow ServiceDesk license to use this integration. Contact your Customer Success Manager for more information. + +Service Desk integration for IdentityNow and in deprecation - not available for new implementation, as of July 21st, 2021. As per SailPoint’s [support policy](https://community.sailpoint.com/t5/Connector-Directory/SailPoint-Support-Policy-for-Connectivity/ta-p/79422), all existing SailPoint IdentityNow customers using this legacy integration will be supported until July 2022. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-sim-integration**](#create-sim-integration) | **Post** `/sim-integrations` | Create new SIM integration +[**delete-sim-integration**](#delete-sim-integration) | **Delete** `/sim-integrations/{id}` | Delete a SIM integration +[**get-sim-integration**](#get-sim-integration) | **Get** `/sim-integrations/{id}` | Get a SIM integration details. +[**get-sim-integrations**](#get-sim-integrations) | **Get** `/sim-integrations` | List the existing SIM integrations. +[**patch-before-provisioning-rule**](#patch-before-provisioning-rule) | **Patch** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a SIM beforeProvisioningRule attribute. +[**patch-sim-attributes**](#patch-sim-attributes) | **Patch** `/sim-integrations/{id}` | Patch a SIM attribute. +[**put-sim-integration**](#put-sim-integration) | **Put** `/sim-integrations/{id}` | Update an existing SIM integration + + +## create-sim-integration +:::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 new SIM integration +Create a new SIM Integrations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-sim-integration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSIMIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **simIntegrationDetails** | [**SimIntegrationDetails**](../models/sim-integration-details) | DTO containing the details of the SIM integration | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + simintegrationdetails := []byte(`{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }`) // SimIntegrationDetails | DTO containing the details of the SIM integration + + + var simIntegrationDetails v2025.SimIntegrationDetails + if err := json.Unmarshal(simintegrationdetails, &simIntegrationDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SIMIntegrationsAPI.CreateSIMIntegration(context.Background()).XSailPointExperimental(xSailPointExperimental).SimIntegrationDetails(simIntegrationDetails).Execute() + //resp, r, err := apiClient.V2025.SIMIntegrationsAPI.CreateSIMIntegration(context.Background()).XSailPointExperimental(xSailPointExperimental).SimIntegrationDetails(simIntegrationDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.CreateSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.CreateSIMIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-sim-integration +:::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 a SIM integration +Get the details of a SIM integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-sim-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the integration to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSIMIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `12345` // string | The id of the integration to delete. # string | The id of the integration to delete. + 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.V2025.SIMIntegrationsAPI.DeleteSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.SIMIntegrationsAPI.DeleteSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.DeleteSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-sim-integration +:::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 a SIM integration details. +Get the details of a SIM integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sim-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the integration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSIMIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `12345` // string | The id of the integration. # string | The id of the integration. + 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.SIMIntegrationsAPI.GetSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.SIMIntegrationsAPI.GetSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.GetSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.GetSIMIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sim-integrations +:::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 the existing SIM integrations. +List the existing SIM integrations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sim-integrations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSIMIntegrationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**[]ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SIMIntegrationsAPI.GetSIMIntegrations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.SIMIntegrationsAPI.GetSIMIntegrations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.GetSIMIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSIMIntegrations`: []ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.GetSIMIntegrations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-before-provisioning-rule +:::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 + ``` +::: +Patch a SIM beforeProvisioningRule attribute. +Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-before-provisioning-rule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | SIM integration id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchBeforeProvisioningRuleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatch** | [**JsonPatch**](../models/json-patch) | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `12345` // string | SIM integration id # string | SIM integration 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") + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + + + var jsonPatch v2025.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SIMIntegrationsAPI.PatchBeforeProvisioningRule(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2025.SIMIntegrationsAPI.PatchBeforeProvisioningRule(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PatchBeforeProvisioningRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchBeforeProvisioningRule`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PatchBeforeProvisioningRule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-sim-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 + ``` +::: +Patch a SIM attribute. +Patch a SIM attribute given a JsonPatch object. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-sim-attributes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | SIM integration id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSIMAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatch** | [**JsonPatch**](../models/json-patch) | The JsonPatch object that describes the changes of SIM | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `12345` // string | SIM integration id # string | SIM integration 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") + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | The JsonPatch object that describes the changes of SIM + + + var jsonPatch v2025.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SIMIntegrationsAPI.PatchSIMAttributes(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2025.SIMIntegrationsAPI.PatchSIMAttributes(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PatchSIMAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSIMAttributes`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PatchSIMAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-sim-integration +:::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 an existing SIM integration +Update an existing SIM integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-sim-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the integration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSIMIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **simIntegrationDetails** | [**SimIntegrationDetails**](../models/sim-integration-details) | The full DTO of the integration containing the updated model | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `12345` // string | The id of the integration. # string | The id of the integration. + 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") + simintegrationdetails := []byte(`{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }`) // SimIntegrationDetails | The full DTO of the integration containing the updated model + + + var simIntegrationDetails v2025.SimIntegrationDetails + if err := json.Unmarshal(simintegrationdetails, &simIntegrationDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SIMIntegrationsAPI.PutSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SimIntegrationDetails(simIntegrationDetails).Execute() + //resp, r, err := apiClient.V2025.SIMIntegrationsAPI.PutSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SimIntegrationDetails(simIntegrationDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PutSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PutSIMIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SODPoliciesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SODPoliciesAPI.md new file mode 100644 index 000000000..f6d57db15 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SODPoliciesAPI.md @@ -0,0 +1,1406 @@ +--- +id: v2025-sod-policies +title: SODPolicies +pagination_label: SODPolicies +sidebar_label: SODPolicies +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SODPolicies', 'V2025SODPolicies'] +slug: /tools/sdk/go/v2025/methods/sod-policies +tags: ['SDK', 'Software Development Kit', 'SODPolicies', 'V2025SODPolicies'] +--- + +# SODPoliciesAPI + Use this API to implement and manage "separation of duties" (SOD) policies. +With SOD policy functionality in place, administrators can organize the access in their tenants to prevent individuals from gaining conflicting or excessive access. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +To create SOD policies in Identity Security Cloud, administrators use 'Search' and then access 'Policies'. +To create a policy, they must configure two lists of access items. Each access item can only be added to one of the two lists. +They can search for the entitlements they want to add to these access lists. + +>Note: You can have a maximum of 500 policies of any type (including general policies) in your organization. In each access-based SOD policy, you can have a maximum of 50 entitlements in each access list. + +Once a SOD policy is in place, if an identity has access items on both lists, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +To create a subscription to a SOD policy in Identity Security Cloud, administrators use 'Search' and then access 'Layers'. +They can create a subscription to the policy and schedule it to run at a regular interval. + +Refer to [Managing Policies](https://documentation.sailpoint.com/saas/help/sod/manage-policies.html) for more information about SOD policies. + +Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-sod-policy**](#create-sod-policy) | **Post** `/sod-policies` | Create SOD policy +[**delete-sod-policy**](#delete-sod-policy) | **Delete** `/sod-policies/{id}` | Delete SOD policy by ID +[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **Delete** `/sod-policies/{id}/schedule` | Delete SOD policy schedule +[**get-custom-violation-report**](#get-custom-violation-report) | **Get** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report +[**get-default-violation-report**](#get-default-violation-report) | **Get** `/sod-violation-report/{reportResultId}/download` | Download violation report +[**get-sod-all-report-run-status**](#get-sod-all-report-run-status) | **Get** `/sod-violation-report` | Get multi-report run task status +[**get-sod-policy**](#get-sod-policy) | **Get** `/sod-policies/{id}` | Get SOD policy by ID +[**get-sod-policy-schedule**](#get-sod-policy-schedule) | **Get** `/sod-policies/{id}/schedule` | Get SOD policy schedule +[**get-sod-violation-report-run-status**](#get-sod-violation-report-run-status) | **Get** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status +[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **Get** `/sod-policies/{id}/violation-report` | Get SOD violation report status +[**list-sod-policies**](#list-sod-policies) | **Get** `/sod-policies` | List SOD policies +[**patch-sod-policy**](#patch-sod-policy) | **Patch** `/sod-policies/{id}` | Patch SOD policy by ID +[**put-policy-schedule**](#put-policy-schedule) | **Put** `/sod-policies/{id}/schedule` | Update SOD Policy schedule +[**put-sod-policy**](#put-sod-policy) | **Put** `/sod-policies/{id}` | Update SOD policy by ID +[**start-evaluate-sod-policy**](#start-evaluate-sod-policy) | **Post** `/sod-policies/{id}/evaluate` | Evaluate one policy by ID +[**start-sod-all-policies-for-org**](#start-sod-all-policies-for-org) | **Post** `/sod-violation-report/run` | Runs all policies for org +[**start-sod-policy**](#start-sod-policy) | **Post** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report + + +## create-sod-policy +Create SOD policy +This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-sod-policy) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sodPolicy** | [**SodPolicy**](../models/sod-policy) | | + +### Return type + +[**SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sodpolicy := []byte(`{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }`) // SodPolicy | + + + var sodPolicy v2025.SodPolicy + if err := json.Unmarshal(sodpolicy, &sodPolicy); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.CreateSodPolicy(context.Background()).SodPolicy(sodPolicy).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.CreateSodPolicy(context.Background()).SodPolicy(sodPolicy).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.CreateSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.CreateSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-sod-policy +Delete SOD policy by ID +This deletes a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD Policy to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **logical** | **bool** | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. | [default to true] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD Policy to delete. # string | The ID of the SOD Policy to delete. + logical := true // bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to true) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SODPoliciesAPI.DeleteSodPolicy(context.Background(), id).Execute() + //r, err := apiClient.V2025.SODPoliciesAPI.DeleteSodPolicy(context.Background(), id).Logical(logical).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.DeleteSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-sod-policy-schedule +Delete SOD policy schedule +This deletes schedule for a specified SOD policy by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-sod-policy-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy the schedule must be deleted for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSodPolicyScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy the schedule must be deleted for. # string | The ID of the SOD policy the schedule must be deleted for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SODPoliciesAPI.DeleteSodPolicySchedule(context.Background(), id).Execute() + //r, err := apiClient.V2025.SODPoliciesAPI.DeleteSodPolicySchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.DeleteSodPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-custom-violation-report +Download custom violation report +This allows to download a specified named violation report for a given report reference. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-custom-violation-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**reportResultId** | **string** | The ID of the report reference to download. | +**fileName** | **string** | Custom Name for the file. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCustomViolationReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reportResultId := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the report reference to download. # string | The ID of the report reference to download. + fileName := `custom-name` // string | Custom Name for the file. # string | Custom Name for the file. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.GetCustomViolationReport(context.Background(), reportResultId, fileName).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.GetCustomViolationReport(context.Background(), reportResultId, fileName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetCustomViolationReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCustomViolationReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetCustomViolationReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-default-violation-report +Download violation report +This allows to download a violation report for a given report reference. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-default-violation-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**reportResultId** | **string** | The ID of the report reference to download. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDefaultViolationReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reportResultId := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the report reference to download. # string | The ID of the report reference to download. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.GetDefaultViolationReport(context.Background(), reportResultId).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.GetDefaultViolationReport(context.Background(), reportResultId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetDefaultViolationReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDefaultViolationReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetDefaultViolationReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-all-report-run-status +Get multi-report run task status +This endpoint gets the status for a violation report for all policy run. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sod-all-report-run-status) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodAllReportRunStatusRequest struct via the builder pattern + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodAllReportRunStatus(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodAllReportRunStatus(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodAllReportRunStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodAllReportRunStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodAllReportRunStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-policy +Get SOD policy by ID +This gets specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD Policy to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD Policy to retrieve. # string | The ID of the SOD Policy to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-policy-schedule +Get SOD policy schedule +This endpoint gets a specified SOD policy's schedule. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sod-policy-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy schedule to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodPolicyScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy schedule to retrieve. # string | The ID of the SOD policy schedule to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodPolicySchedule(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodPolicySchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodPolicySchedule`: SodPolicySchedule + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodPolicySchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-violation-report-run-status +Get violation report run status +This gets the status for a violation report run task that has already been invoked. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sod-violation-report-run-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**reportResultId** | **string** | The ID of the report reference to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodViolationReportRunStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reportResultId := `2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | The ID of the report reference to retrieve. # string | The ID of the report reference to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodViolationReportRunStatus(context.Background(), reportResultId).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodViolationReportRunStatus(context.Background(), reportResultId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodViolationReportRunStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodViolationReportRunStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodViolationReportRunStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-violation-report-status +Get SOD violation report status +This gets the status for a violation report run task that has already been invoked. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sod-violation-report-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the violation report to retrieve status for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodViolationReportStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the violation report to retrieve status for. # string | The ID of the violation report to retrieve status for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodViolationReportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodViolationReportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodViolationReportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodViolationReportStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodViolationReportStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-sod-policies +List SOD policies +This gets list of all SOD policies. +Requires role of ORG_ADMIN + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-sod-policies) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSodPoliciesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, in* **state**: *eq, in* | + **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: **id, name, created, modified, description** | + +### Return type + +[**[]SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "bc693f07e7b645539626c25954c58554"` // 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, in* **state**: *eq, in* (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, in* **state**: *eq, in* (optional) + sorters := `id,name` // 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: **id, name, created, modified, description** (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: **id, name, created, modified, description** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.ListSodPolicies(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.ListSodPolicies(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.ListSodPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSodPolicies`: []SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.ListSodPolicies`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-sod-policy +Patch SOD policy by ID +Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Requires role of ORG_ADMIN. +This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy being modified. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria | + +### Return type + +[**SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c918083-5d19-1a86-015d-28455b4a2329` // string | The ID of the SOD policy being modified. # string | The ID of the SOD policy being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]`) // []JsonPatchOperation | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.PatchSodPolicy(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.PatchSodPolicy(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PatchSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PatchSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-policy-schedule +Update SOD Policy schedule +This updates schedule for a specified SOD policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-policy-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy to update its schedule. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutPolicyScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **sodPolicySchedule** | [**SodPolicySchedule**](../models/sod-policy-schedule) | | + +### Return type + +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy to update its schedule. # string | The ID of the SOD policy to update its schedule. + sodpolicyschedule := []byte(`{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }`) // SodPolicySchedule | + + + var sodPolicySchedule v2025.SodPolicySchedule + if err := json.Unmarshal(sodpolicyschedule, &sodPolicySchedule); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.PutPolicySchedule(context.Background(), id).SodPolicySchedule(sodPolicySchedule).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.PutPolicySchedule(context.Background(), id).SodPolicySchedule(sodPolicySchedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PutPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutPolicySchedule`: SodPolicySchedule + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PutPolicySchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-sod-policy +Update SOD policy by ID +This updates a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **sodPolicy** | [**SodPolicy**](../models/sod-policy) | | + +### Return type + +[**SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy to update. # string | The ID of the SOD policy to update. + sodpolicy := []byte(`{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }`) // SodPolicy | + + + var sodPolicy v2025.SodPolicy + if err := json.Unmarshal(sodpolicy, &sodPolicy); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.PutSodPolicy(context.Background(), id).SodPolicy(sodPolicy).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.PutSodPolicy(context.Background(), id).SodPolicy(sodPolicy).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PutSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PutSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-evaluate-sod-policy +Evaluate one policy by ID +Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-evaluate-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The SOD policy ID to run. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartEvaluateSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The SOD policy ID to run. # string | The SOD policy ID to run. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.StartEvaluateSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.StartEvaluateSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartEvaluateSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartEvaluateSodPolicy`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartEvaluateSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-sod-all-policies-for-org +Runs all policies for org +Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-sod-all-policies-for-org) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartSodAllPoliciesForOrgRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **multiPolicyRequest** | [**MultiPolicyRequest**](../models/multi-policy-request) | | + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multipolicyrequest := []byte(`{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }`) // MultiPolicyRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.StartSodAllPoliciesForOrg(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.StartSodAllPoliciesForOrg(context.Background()).MultiPolicyRequest(multiPolicyRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartSodAllPoliciesForOrg``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartSodAllPoliciesForOrg`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartSodAllPoliciesForOrg`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-sod-policy +Runs SOD policy violation report +This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The SOD policy ID to run. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The SOD policy ID to run. # string | The SOD policy ID to run. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.StartSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.StartSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartSodPolicy`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SODViolationsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SODViolationsAPI.md new file mode 100644 index 000000000..8fd7045d2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SODViolationsAPI.md @@ -0,0 +1,186 @@ +--- +id: v2025-sod-violations +title: SODViolations +pagination_label: SODViolations +sidebar_label: SODViolations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SODViolations', 'V2025SODViolations'] +slug: /tools/sdk/go/v2025/methods/sod-violations +tags: ['SDK', 'Software Development Kit', 'SODViolations', 'V2025SODViolations'] +--- + +# SODViolationsAPI + Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations. +With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +Once a SOD policy is in place, if an identity has conflicting access items, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. +This second option is a good way to prevent SOD violations from triggering at all. + +Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**start-predict-sod-violations**](#start-predict-sod-violations) | **Post** `/sod-violations/predict` | Predict SOD violations for identity. +[**start-violation-check**](#start-violation-check) | **Post** `/sod-violations/check` | Check SOD violations + + +## start-predict-sod-violations +Predict SOD violations for identity. +This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-predict-sod-violations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartPredictSodViolationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityWithNewAccess** | [**IdentityWithNewAccess**](../models/identity-with-new-access) | | + +### Return type + +[**ViolationPrediction**](../models/violation-prediction) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identitywithnewaccess := []byte(`{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }`) // IdentityWithNewAccess | + + + var identityWithNewAccess v2025.IdentityWithNewAccess + if err := json.Unmarshal(identitywithnewaccess, &identityWithNewAccess); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODViolationsAPI.StartPredictSodViolations(context.Background()).IdentityWithNewAccess(identityWithNewAccess).Execute() + //resp, r, err := apiClient.V2025.SODViolationsAPI.StartPredictSodViolations(context.Background()).IdentityWithNewAccess(identityWithNewAccess).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODViolationsAPI.StartPredictSodViolations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartPredictSodViolations`: ViolationPrediction + fmt.Fprintf(os.Stdout, "Response from `SODViolationsAPI.StartPredictSodViolations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-violation-check +Check SOD violations +This API initiates a SOD policy verification asynchronously. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-violation-check) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartViolationCheckRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityWithNewAccess1** | [**IdentityWithNewAccess1**](../models/identity-with-new-access1) | | + +### Return type + +[**SodViolationCheck**](../models/sod-violation-check) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identitywithnewaccess1 := []byte(`{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}`) // IdentityWithNewAccess1 | + + + var identityWithNewAccess1 v2025.IdentityWithNewAccess1 + if err := json.Unmarshal(identitywithnewaccess1, &identityWithNewAccess1); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODViolationsAPI.StartViolationCheck(context.Background()).IdentityWithNewAccess1(identityWithNewAccess1).Execute() + //resp, r, err := apiClient.V2025.SODViolationsAPI.StartViolationCheck(context.Background()).IdentityWithNewAccess1(identityWithNewAccess1).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODViolationsAPI.StartViolationCheck``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartViolationCheck`: SodViolationCheck + fmt.Fprintf(os.Stdout, "Response from `SODViolationsAPI.StartViolationCheck`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SPConfigAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SPConfigAPI.md new file mode 100644 index 000000000..28d273fe4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SPConfigAPI.md @@ -0,0 +1,504 @@ +--- +id: v2025-sp-config +title: SPConfig +pagination_label: SPConfig +sidebar_label: SPConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SPConfig', 'V2025SPConfig'] +slug: /tools/sdk/go/v2025/methods/sp-config +tags: ['SDK', 'Software Development Kit', 'SPConfig', 'V2025SPConfig'] +--- + +# SPConfigAPI + Import and export configuration for some objects between tenants. +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**export-sp-config**](#export-sp-config) | **Post** `/sp-config/export` | Initiates configuration objects export job +[**get-sp-config-export**](#get-sp-config-export) | **Get** `/sp-config/export/{id}/download` | Download export job result. +[**get-sp-config-export-status**](#get-sp-config-export-status) | **Get** `/sp-config/export/{id}` | Get export job status +[**get-sp-config-import**](#get-sp-config-import) | **Get** `/sp-config/import/{id}/download` | Download import job result +[**get-sp-config-import-status**](#get-sp-config-import-status) | **Get** `/sp-config/import/{id}` | Get import job status +[**import-sp-config**](#import-sp-config) | **Post** `/sp-config/import` | Initiates configuration objects import job +[**list-sp-config-objects**](#list-sp-config-objects) | **Get** `/sp-config/config-objects` | List Config Objects + + +## export-sp-config +Initiates configuration objects export job +This post will export objects from the tenant to a JSON configuration file. +For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/export-sp-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportSpConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **exportPayload** | [**ExportPayload**](../models/export-payload) | Export options control what will be included in the export. | + +### Return type + +[**SpConfigExportJob**](../models/sp-config-export-job) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + exportpayload := []byte(`{ + "description" : "Export Job 1 Test" + }`) // ExportPayload | Export options control what will be included in the export. + + + var exportPayload v2025.ExportPayload + if err := json.Unmarshal(exportpayload, &exportPayload); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SPConfigAPI.ExportSpConfig(context.Background()).ExportPayload(exportPayload).Execute() + //resp, r, err := apiClient.V2025.SPConfigAPI.ExportSpConfig(context.Background()).ExportPayload(exportPayload).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ExportSpConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportSpConfig`: SpConfigExportJob + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ExportSpConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sp-config-export +Download export job result. +This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. +The request will need one of the following security scopes: +- sp:config:read - sp:config:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sp-config-export) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the export job whose results will be downloaded. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSpConfigExportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SpConfigExportResults**](../models/sp-config-export-results) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the export job whose results will be downloaded. # string | The ID of the export job whose results will be downloaded. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SPConfigAPI.GetSpConfigExport(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SPConfigAPI.GetSpConfigExport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigExport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigExport`: SpConfigExportResults + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigExport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sp-config-export-status +Get export job status +This gets the status of the export job identified by the `id` parameter. +The request will need one of the following security scopes: +- sp:config:read - sp:config:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sp-config-export-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the export job whose status will be returned. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSpConfigExportStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SpConfigExportJobStatus**](../models/sp-config-export-job-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the export job whose status will be returned. # string | The ID of the export job whose status will be returned. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SPConfigAPI.GetSpConfigExportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SPConfigAPI.GetSpConfigExportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigExportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigExportStatus`: SpConfigExportJobStatus + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigExportStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sp-config-import +Download import job result +This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. +The request will need the following security scope: +- sp:config:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sp-config-import) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the import job whose results will be downloaded. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSpConfigImportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SpConfigImportResults**](../models/sp-config-import-results) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the import job whose results will be downloaded. # string | The ID of the import job whose results will be downloaded. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SPConfigAPI.GetSpConfigImport(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SPConfigAPI.GetSpConfigImport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigImport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigImport`: SpConfigImportResults + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigImport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sp-config-import-status +Get import job status +'This gets the status of the import job identified by the `id` parameter. + + For more information about the object types that currently support import functionality, + refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).' + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sp-config-import-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the import job whose status will be returned. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSpConfigImportStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SpConfigImportJobStatus**](../models/sp-config-import-job-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the import job whose status will be returned. # string | The ID of the import job whose status will be returned. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SPConfigAPI.GetSpConfigImportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SPConfigAPI.GetSpConfigImportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigImportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigImportStatus`: SpConfigImportJobStatus + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigImportStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-sp-config +Initiates configuration objects import job +This post will import objects from a JSON configuration file into a tenant. +By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. +The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. +The backup can be skipped by setting "excludeBackup" to true in the import options. +If a backup is performed, the id of the backup will be provided in the ImportResult as the "exportJobId". This can be downloaded +using the `/sp-config/export/{exportJobId}/download` endpoint. + +You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. + +For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/import-sp-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportSpConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **data** | ***os.File** | JSON file containing the objects to be imported. | + **preview** | **bool** | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. | [default to false] + **options** | [**ImportOptions**](../models/import-options) | | + +### Return type + +[**SpConfigJob**](../models/sp-config-job) + +### 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() { + data := BINARY_DATA_HERE // *os.File | JSON file containing the objects to be imported. # *os.File | JSON file containing the objects to be imported. + preview := true // bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to false) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to false) + options := []byte(``) // ImportOptions | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SPConfigAPI.ImportSpConfig(context.Background()).Data(data).Execute() + //resp, r, err := apiClient.V2025.SPConfigAPI.ImportSpConfig(context.Background()).Data(data).Preview(preview).Options(options).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ImportSpConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportSpConfig`: SpConfigJob + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ImportSpConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-sp-config-objects +List Config Objects +Get a list of object configurations that the tenant export/import service knows. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-sp-config-objects) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSpConfigObjectsRequest struct via the builder pattern + + +### Return type + +[**[]SpConfigObject**](../models/sp-config-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SPConfigAPI.ListSpConfigObjects(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SPConfigAPI.ListSpConfigObjects(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ListSpConfigObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSpConfigObjects`: []SpConfigObject + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ListSpConfigObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SavedSearchAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SavedSearchAPI.md new file mode 100644 index 000000000..ce353a1a7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SavedSearchAPI.md @@ -0,0 +1,509 @@ +--- +id: v2025-saved-search +title: SavedSearch +pagination_label: SavedSearch +sidebar_label: SavedSearch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearch', 'V2025SavedSearch'] +slug: /tools/sdk/go/v2025/methods/saved-search +tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'V2025SavedSearch'] +--- + +# SavedSearchAPI + Use this API to implement saved search functionality. +With saved search functionality in place, users can save search queries and then view those saved searches, as well as rerun them. + +Search queries in Identity Security Cloud can grow very long and specific, which can make reconstructing them difficult or tedious, so it can be especially helpful to save search queries. +It also opens the possibility to configure Identity Security Cloud to run the saved queries on a schedule, which is essential to detecting user information and access changes throughout an organization's tenant and across all its sources. +Refer to [Scheduled Search](https://developer.sailpoint.com/docs/api/v2025/scheduled-search/) for more information about running saved searches on a schedule. + +In Identity Security Cloud, users can save searches under a name, and then they can access that saved search and run it again when they want. + +Refer to [Managing Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html) for more information about saving searches and using them. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-saved-search**](#create-saved-search) | **Post** `/saved-searches` | Create a saved search +[**delete-saved-search**](#delete-saved-search) | **Delete** `/saved-searches/{id}` | Delete document by ID +[**execute-saved-search**](#execute-saved-search) | **Post** `/saved-searches/{id}/execute` | Execute a saved search by ID +[**get-saved-search**](#get-saved-search) | **Get** `/saved-searches/{id}` | Return saved search by ID +[**list-saved-searches**](#list-saved-searches) | **Get** `/saved-searches` | A list of Saved Searches +[**put-saved-search**](#put-saved-search) | **Put** `/saved-searches/{id}` | Updates an existing saved search + + +## create-saved-search +Create a saved search +Creates a new saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-saved-search) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSavedSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createSavedSearchRequest** | [**CreateSavedSearchRequest**](../models/create-saved-search-request) | The saved search to persist. | + +### Return type + +[**SavedSearch**](../models/saved-search) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createsavedsearchrequest := []byte(``) // CreateSavedSearchRequest | The saved search to persist. + + + var createSavedSearchRequest v2025.CreateSavedSearchRequest + if err := json.Unmarshal(createsavedsearchrequest, &createSavedSearchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SavedSearchAPI.CreateSavedSearch(context.Background()).CreateSavedSearchRequest(createSavedSearchRequest).Execute() + //resp, r, err := apiClient.V2025.SavedSearchAPI.CreateSavedSearch(context.Background()).CreateSavedSearchRequest(createSavedSearchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.CreateSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.CreateSavedSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-saved-search +Delete document by ID +Deletes the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-saved-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSavedSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SavedSearchAPI.DeleteSavedSearch(context.Background(), id).Execute() + //r, err := apiClient.V2025.SavedSearchAPI.DeleteSavedSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.DeleteSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## execute-saved-search +Execute a saved search by ID +Executes the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/execute-saved-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExecuteSavedSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **searchArguments** | [**SearchArguments**](../models/search-arguments) | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + searcharguments := []byte(`{ + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + }`) // SearchArguments | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + + + var searchArguments v2025.SearchArguments + if err := json.Unmarshal(searcharguments, &searchArguments); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SavedSearchAPI.ExecuteSavedSearch(context.Background(), id).SearchArguments(searchArguments).Execute() + //r, err := apiClient.V2025.SavedSearchAPI.ExecuteSavedSearch(context.Background(), id).SearchArguments(searchArguments).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.ExecuteSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-saved-search +Return saved search by ID +Returns the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-saved-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSavedSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SavedSearch**](../models/saved-search) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SavedSearchAPI.GetSavedSearch(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SavedSearchAPI.GetSavedSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.GetSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.GetSavedSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-saved-searches +A list of Saved Searches +Returns a list of saved searches. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-saved-searches) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSavedSearchesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **owner.id**: *eq* | + +### Return type + +[**[]SavedSearch**](../models/saved-search) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"` // 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: **owner.id**: *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: **owner.id**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SavedSearchAPI.ListSavedSearches(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SavedSearchAPI.ListSavedSearches(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.ListSavedSearches``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSavedSearches`: []SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.ListSavedSearches`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-saved-search +Updates an existing saved search +Updates an existing saved search. + +>**NOTE: You cannot update the `owner` of the saved search.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-saved-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSavedSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **savedSearch** | [**SavedSearch**](../models/saved-search) | The saved search to persist. | + +### Return type + +[**SavedSearch**](../models/saved-search) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + savedsearch := []byte(`{ + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + }`) // SavedSearch | The saved search to persist. + + + var savedSearch v2025.SavedSearch + if err := json.Unmarshal(savedsearch, &savedSearch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SavedSearchAPI.PutSavedSearch(context.Background(), id).SavedSearch(savedSearch).Execute() + //resp, r, err := apiClient.V2025.SavedSearchAPI.PutSavedSearch(context.Background(), id).SavedSearch(savedSearch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.PutSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.PutSavedSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ScheduledSearchAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ScheduledSearchAPI.md new file mode 100644 index 000000000..a049bd0a1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ScheduledSearchAPI.md @@ -0,0 +1,561 @@ +--- +id: v2025-scheduled-search +title: ScheduledSearch +pagination_label: ScheduledSearch +sidebar_label: ScheduledSearch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledSearch', 'V2025ScheduledSearch'] +slug: /tools/sdk/go/v2025/methods/scheduled-search +tags: ['SDK', 'Software Development Kit', 'ScheduledSearch', 'V2025ScheduledSearch'] +--- + +# ScheduledSearchAPI + Use this API to implement scheduled search functionality. +With scheduled search functionality in place, users can run saved search queries on their tenants on a schedule, and Identity Security Cloud emails them the search results. +Users can also share these search results with other users by email by adding those users as subscribers, or those users can subscribe themselves. + +One of the greatest benefits of saving searches is the ability to run those searches on a schedule. +This is essential for organizations to constantly detect any changes to user information or access throughout their tenants and across all their sources. +For example, the manager Amanda Ross can schedule a saved search "manager.name:amanda.ross AND attributes.location:austin" on a schedule to regularly stay aware of changes with the Austin employees reporting to her. +Identity Security Cloud emails her the search results when the search runs, so she can work on other tasks instead of actively running this search. + +In Identity Security Cloud, scheduling a search involves a subscription. +Users can create a subscription for a saved search and schedule it to run daily, weekly, or monthly (you can only use one schedule option at a time). +The user can add other identities as subscribers so when the scheduled search runs, the subscribers and the user all receive emails. + +By default, subscriptions exclude detailed results from the emails, for security purposes. +Including detailed results about user access in an email may expose sensitive information. +However, the subscription creator can choose to include the information in the emails. + +By default, Identity Security Cloud sends emails to the subscribers even when the searches do not return new results. +However, the subscription creator can choose to suppress these empty emails. + +Users can also subscribe to saved searches that already have existing subscriptions so they receive emails when the searches run. +A saved search can have up to 10 subscriptions configured at a time. + +The subscription creator can enable, disable, or delete the subscription. + +Refer to [Subscribing to Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html#subscribing-to-saved-searches) for more information about scheduling searches and subscribing to them. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-scheduled-search**](#create-scheduled-search) | **Post** `/scheduled-searches` | Create a new scheduled search +[**delete-scheduled-search**](#delete-scheduled-search) | **Delete** `/scheduled-searches/{id}` | Delete a Scheduled Search +[**get-scheduled-search**](#get-scheduled-search) | **Get** `/scheduled-searches/{id}` | Get a Scheduled Search +[**list-scheduled-search**](#list-scheduled-search) | **Get** `/scheduled-searches` | List scheduled searches +[**unsubscribe-scheduled-search**](#unsubscribe-scheduled-search) | **Post** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search +[**update-scheduled-search**](#update-scheduled-search) | **Put** `/scheduled-searches/{id}` | Update an existing Scheduled Search + + +## create-scheduled-search +Create a new scheduled search +Creates a new scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-scheduled-search) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createScheduledSearchRequest** | [**CreateScheduledSearchRequest**](../models/create-scheduled-search-request) | The scheduled search to persist. | + +### Return type + +[**ScheduledSearch**](../models/scheduled-search) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createscheduledsearchrequest := []byte(`{savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]}`) // CreateScheduledSearchRequest | The scheduled search to persist. + + + var createScheduledSearchRequest v2025.CreateScheduledSearchRequest + if err := json.Unmarshal(createscheduledsearchrequest, &createScheduledSearchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ScheduledSearchAPI.CreateScheduledSearch(context.Background()).CreateScheduledSearchRequest(createScheduledSearchRequest).Execute() + //resp, r, err := apiClient.V2025.ScheduledSearchAPI.CreateScheduledSearch(context.Background()).CreateScheduledSearchRequest(createScheduledSearchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.CreateScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.CreateScheduledSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-scheduled-search +Delete a Scheduled Search +Deletes the specified scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-scheduled-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ScheduledSearchAPI.DeleteScheduledSearch(context.Background(), id).Execute() + //r, err := apiClient.V2025.ScheduledSearchAPI.DeleteScheduledSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.DeleteScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-scheduled-search +Get a Scheduled Search +Returns the specified scheduled search. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-scheduled-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ScheduledSearch**](../models/scheduled-search) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ScheduledSearchAPI.GetScheduledSearch(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ScheduledSearchAPI.GetScheduledSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.GetScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.GetScheduledSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-scheduled-search +List scheduled searches +Returns a list of scheduled searches. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-scheduled-search) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **owner.id**: *eq* **savedSearchId**: *eq* | + +### Return type + +[**[]ScheduledSearch**](../models/scheduled-search) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"` // 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: **owner.id**: *eq* **savedSearchId**: *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: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ScheduledSearchAPI.ListScheduledSearch(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ScheduledSearchAPI.ListScheduledSearch(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.ListScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListScheduledSearch`: []ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.ListScheduledSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## unsubscribe-scheduled-search +Unsubscribe a recipient from Scheduled Search +Unsubscribes a recipient from the specified scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/unsubscribe-scheduled-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUnsubscribeScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **typedReference** | [**TypedReference**](../models/typed-reference) | The recipient to be removed from the scheduled search. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + typedreference := []byte(`{ + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }`) // TypedReference | The recipient to be removed from the scheduled search. + + + var typedReference v2025.TypedReference + if err := json.Unmarshal(typedreference, &typedReference); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ScheduledSearchAPI.UnsubscribeScheduledSearch(context.Background(), id).TypedReference(typedReference).Execute() + //r, err := apiClient.V2025.ScheduledSearchAPI.UnsubscribeScheduledSearch(context.Background(), id).TypedReference(typedReference).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.UnsubscribeScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## update-scheduled-search +Update an existing Scheduled Search +Updates an existing scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-scheduled-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **scheduledSearch** | [**ScheduledSearch**](../models/scheduled-search) | The scheduled search to persist. | + +### Return type + +[**ScheduledSearch**](../models/scheduled-search) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + scheduledsearch := []byte(`{ + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false + }`) // ScheduledSearch | The scheduled search to persist. + + + var scheduledSearch v2025.ScheduledSearch + if err := json.Unmarshal(scheduledsearch, &scheduledSearch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ScheduledSearchAPI.UpdateScheduledSearch(context.Background(), id).ScheduledSearch(scheduledSearch).Execute() + //resp, r, err := apiClient.V2025.ScheduledSearchAPI.UpdateScheduledSearch(context.Background(), id).ScheduledSearch(scheduledSearch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.UpdateScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.UpdateScheduledSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SearchAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SearchAPI.md new file mode 100644 index 000000000..78dae7b2b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SearchAPI.md @@ -0,0 +1,677 @@ +--- +id: v2025-search +title: Search +pagination_label: Search +sidebar_label: Search +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Search', 'V2025Search'] +slug: /tools/sdk/go/v2025/methods/search +tags: ['SDK', 'Software Development Kit', 'Search', 'V2025Search'] +--- + +# SearchAPI + Use this API to implement search functionality. +With search functionality in place, users can search their tenants for nearly any information from throughout their organizations. + +Identity Security Cloud enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using Identity Security Cloud's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about Identity Security Cloud's search and its different possibilities. + +The search feature uses Elasticsearch as a datastore and query engine. +The power of Elasticsearch makes this feature suitable for ad-hoc reporting. +However, data from the operational databases (ex. identities, roles, events, etc) has to be ingested into Elasticsearch. +This ingestion process introduces a latency from when the operational data is created to when it is available in search. +Depending on the system load, this can take a few seconds to a few minutes. +Please keep this latency in mind when you use search. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**search-aggregate**](#search-aggregate) | **Post** `/search/aggregate` | Perform a Search Query Aggregation +[**search-count**](#search-count) | **Post** `/search/count` | Count Documents Satisfying a Query +[**search-get**](#search-get) | **Get** `/search/{index}/{id}` | Get a Document by ID +[**search-post**](#search-post) | **Post** `/search` | Perform Search + + +## search-aggregate +Perform a Search Query Aggregation +Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/search-aggregate) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchAggregateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search** | [**Search**](../models/search) | | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**AggregationResult**](../models/aggregation-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json, text/csv + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + var search v2025.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SearchAPI.SearchAggregate(context.Background()).Search(search).Execute() + //resp, r, err := apiClient.V2025.SearchAPI.SearchAggregate(context.Background()).Search(search).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchAggregate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchAggregate`: AggregationResult + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchAggregate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-count +Count Documents Satisfying a Query +Performs a search with a provided query and returns the count of results in the X-Total-Count header. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/search-count) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchCountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search** | [**Search**](../models/search) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + + + var search v2025.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SearchAPI.SearchCount(context.Background()).Search(search).Execute() + //r, err := apiClient.V2025.SearchAPI.SearchCount(context.Background()).Search(search).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchCount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## search-get +Get a Document by ID +Fetches a single document from the specified index, using the specified document ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/search-get) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**index** | **string** | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. | +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchGetRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + index := `identities` // string | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. # string | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SearchAPI.SearchGet(context.Background(), index, id).Execute() + //resp, r, err := apiClient.V2025.SearchAPI.SearchGet(context.Background(), index, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchGet``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchGet`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchGet`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-post +Perform Search +Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/search-post) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchPostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search** | [**Search**](../models/search) | | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +**[]map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + 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) + limit := 10000 // 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + var search v2025.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SearchAPI.SearchPost(context.Background()).Search(search).Execute() + //resp, r, err := apiClient.V2025.SearchAPI.SearchPost(context.Background()).Search(search).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchPost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchPost`: []map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchPost`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SearchAttributeConfigurationAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SearchAttributeConfigurationAPI.md new file mode 100644 index 000000000..97b607f10 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SearchAttributeConfigurationAPI.md @@ -0,0 +1,453 @@ +--- +id: v2025-search-attribute-configuration +title: SearchAttributeConfiguration +pagination_label: SearchAttributeConfiguration +sidebar_label: SearchAttributeConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchAttributeConfiguration', 'V2025SearchAttributeConfiguration'] +slug: /tools/sdk/go/v2025/methods/search-attribute-configuration +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfiguration', 'V2025SearchAttributeConfiguration'] +--- + +# SearchAttributeConfigurationAPI + Use this API to implement search attribute configuration functionality, along with [Search](https://developer.sailpoint.com/docs/api/v2025/search). +With this functionality in place, administrators can create custom search attributes that and run extended searches based on those attributes to further narrow down their searches and get the information and insights they want. + +Identity Security Cloud (ISC) enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using ISC's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about ISC's search and its different possibilities. + +With Search Attribute Configuration, administrators can create, manage, and run searches based on the attributes they want to search. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-search-attribute-config**](#create-search-attribute-config) | **Post** `/accounts/search-attribute-config` | Create Extended Search Attributes +[**delete-search-attribute-config**](#delete-search-attribute-config) | **Delete** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute +[**get-search-attribute-config**](#get-search-attribute-config) | **Get** `/accounts/search-attribute-config` | List Extended Search Attributes +[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **Get** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute +[**patch-search-attribute-config**](#patch-search-attribute-config) | **Patch** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute + + +## create-search-attribute-config +:::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 Extended Search Attributes +Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. +>**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-search-attribute-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **searchAttributeConfig** | [**SearchAttributeConfig**](../models/search-attribute-config) | | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + searchattributeconfig := []byte(`{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }`) // SearchAttributeConfig | + + + var searchAttributeConfig v2025.SearchAttributeConfig + if err := json.Unmarshal(searchattributeconfig, &searchAttributeConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SearchAttributeConfigurationAPI.CreateSearchAttributeConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).SearchAttributeConfig(searchAttributeConfig).Execute() + //resp, r, err := apiClient.V2025.SearchAttributeConfigurationAPI.CreateSearchAttributeConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).SearchAttributeConfig(searchAttributeConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.CreateSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSearchAttributeConfig`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.CreateSearchAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-search-attribute-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 Extended Search Attribute +Delete an extended attribute configuration by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-search-attribute-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | Name of the extended search attribute configuration to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `newMailAttribute` // string | Name of the extended search attribute configuration to delete. # string | Name of the extended search attribute configuration to delete. + 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.V2025.SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-search-attribute-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 + ``` +::: +List Extended Search Attributes +Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-search-attribute-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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 + +[**[]SearchAttributeConfig**](../models/search-attribute-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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.V2025.SearchAttributeConfigurationAPI.GetSearchAttributeConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.SearchAttributeConfigurationAPI.GetSearchAttributeConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.GetSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSearchAttributeConfig`: []SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.GetSearchAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-single-search-attribute-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 + ``` +::: +Get Extended Search Attribute +Get an extended attribute configuration by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-single-search-attribute-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | Name of the extended search attribute configuration to get. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSingleSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**SearchAttributeConfig**](../models/search-attribute-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `newMailAttribute` // string | Name of the extended search attribute configuration to get. # string | Name of the extended search attribute configuration to get. + 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.SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSingleSearchAttributeConfig`: SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-search-attribute-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 Extended Search Attribute +Update an existing search attribute configuration. +You can patch these fields: +* name * displayName * applicationAttributes + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-search-attribute-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | Name of the search attribute configuration to patch. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**SearchAttributeConfig**](../models/search-attribute-config) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `promotedMailAttribute` // string | Name of the search attribute configuration to patch. # string | Name of the search attribute configuration to patch. + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SearchAttributeConfigurationAPI.PatchSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.SearchAttributeConfigurationAPI.PatchSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.PatchSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSearchAttributeConfig`: SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.PatchSearchAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SegmentsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SegmentsAPI.md new file mode 100644 index 000000000..2e323bcad --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SegmentsAPI.md @@ -0,0 +1,405 @@ +--- +id: v2025-segments +title: Segments +pagination_label: Segments +sidebar_label: Segments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Segments', 'V2025Segments'] +slug: /tools/sdk/go/v2025/methods/segments +tags: ['SDK', 'Software Development Kit', 'Segments', 'V2025Segments'] +--- + +# SegmentsAPI + Use this API to implement and customize access request segment functionality. +With this functionality in place, administrators can create and manage access request segments. +Segments provide organizations with a way to make the access their users have even more granular - this can simply the access request process for the organization's users and improves security by reducing the risk of overprovisoning access. + +Segments represent sets of identities, all grouped by specified identity attributes, who are only able to see and access the access items associated with their segments. +For example, administrators could group all their organization's London office employees into one segment, "London Office Employees," by their shared location. +The administrators could then define the access items the London employees would need, and the identities in the "London Office Employees" would then only be able to see and access those items. + +In Identity Security Cloud, administrators can use the 'Access' drop-down menu and select 'Segments' to reach the 'Access Requests Segments' page. +This page lists all the existing access request segments, along with their statuses, enabled or disabled. +Administrators can use this page to create, edit, enable, disable, and delete segments. +To create a segment, an administrator must provide a name, define the identities grouped in the segment, and define the items the identities in the segment can access. +These items can be access profiles, roles, or entitlements. + +When administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items. + +Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-segment**](#create-segment) | **Post** `/segments` | Create Segment +[**delete-segment**](#delete-segment) | **Delete** `/segments/{id}` | Delete Segment by ID +[**get-segment**](#get-segment) | **Get** `/segments/{id}` | Get Segment by ID +[**list-segments**](#list-segments) | **Get** `/segments` | List Segments +[**patch-segment**](#patch-segment) | **Patch** `/segments/{id}` | Update Segment + + +## create-segment +Create Segment +This API creates a segment. +>**Note:** Segment definitions may take time to propagate to all identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-segment) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **segment** | [**Segment**](../models/segment) | | + +### Return type + +[**Segment**](../models/segment) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + segment := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }`) // Segment | + + + var segment v2025.Segment + if err := json.Unmarshal(segment, &segment); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SegmentsAPI.CreateSegment(context.Background()).Segment(segment).Execute() + //resp, r, err := apiClient.V2025.SegmentsAPI.CreateSegment(context.Background()).Segment(segment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.CreateSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.CreateSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-segment +Delete Segment by ID +This API deletes the segment specified by the given ID. +>**Note:** that segment deletion may take some time to become effective. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to delete. # string | The segment ID to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SegmentsAPI.DeleteSegment(context.Background(), id).Execute() + //r, err := apiClient.V2025.SegmentsAPI.DeleteSegment(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.DeleteSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-segment +Get Segment by ID +This API returns the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Segment**](../models/segment) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to retrieve. # string | The segment ID to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SegmentsAPI.GetSegment(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SegmentsAPI.GetSegment(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.GetSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.GetSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-segments +List Segments +This API returns a list of all segments. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-segments) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSegmentsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]Segment**](../models/segment) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SegmentsAPI.ListSegments(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SegmentsAPI.ListSegments(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.ListSegments``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSegments`: []Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.ListSegments`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-segment +Update Segment +Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +>**Note:** Changes to a segment may take some time to propagate to all identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to modify. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **requestBody** | **[]map[string]interface{}** | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active | + +### Return type + +[**Segment**](../models/segment) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to modify. # string | The segment ID to modify. + requestbody := []byte(`[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]`) // []map[string]interface{} | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SegmentsAPI.PatchSegment(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2025.SegmentsAPI.PatchSegment(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.PatchSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.PatchSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/ServiceDeskIntegrationAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/ServiceDeskIntegrationAPI.md new file mode 100644 index 000000000..1270e721e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/ServiceDeskIntegrationAPI.md @@ -0,0 +1,786 @@ +--- +id: v2025-service-desk-integration +title: ServiceDeskIntegration +pagination_label: ServiceDeskIntegration +sidebar_label: ServiceDeskIntegration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskIntegration', 'V2025ServiceDeskIntegration'] +slug: /tools/sdk/go/v2025/methods/service-desk-integration +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegration', 'V2025ServiceDeskIntegration'] +--- + +# ServiceDeskIntegrationAPI + Use this API to build an integration between Identity Security Cloud and a service desk ITSM (IT service management) solution. +Once an administrator builds this integration between Identity Security Cloud and a service desk, users can use Identity Security Cloud to raise and track tickets that are synchronized between Identity Security Cloud and the service desk. + +In Identity Security Cloud, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.' + +To create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. +Refer to [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in Identity Security Cloud. + +Administrators can create various service desk integrations, all with their own nuances. +The following service desk integrations are available: + +- [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud_sd/introduction.html) + +- [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server_sd/introduction.html) + +- [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html) + +- [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html) + +- [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) + +- [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html) + +- [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html) + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-service-desk-integration**](#create-service-desk-integration) | **Post** `/service-desk-integrations` | Create new Service Desk integration +[**delete-service-desk-integration**](#delete-service-desk-integration) | **Delete** `/service-desk-integrations/{id}` | Delete a Service Desk integration +[**get-service-desk-integration**](#get-service-desk-integration) | **Get** `/service-desk-integrations/{id}` | Get a Service Desk integration +[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **Get** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName +[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **Get** `/service-desk-integrations/types` | List Service Desk integration types +[**get-service-desk-integrations**](#get-service-desk-integrations) | **Get** `/service-desk-integrations` | List existing Service Desk integrations +[**get-status-check-details**](#get-status-check-details) | **Get** `/service-desk-integrations/status-check-configuration` | Get the time check configuration +[**patch-service-desk-integration**](#patch-service-desk-integration) | **Patch** `/service-desk-integrations/{id}` | Patch a Service Desk Integration +[**put-service-desk-integration**](#put-service-desk-integration) | **Put** `/service-desk-integrations/{id}` | Update a Service Desk integration +[**update-status-check-details**](#update-status-check-details) | **Put** `/service-desk-integrations/status-check-configuration` | Update the time check configuration + + +## create-service-desk-integration +Create new Service Desk integration +Create a new Service Desk integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-service-desk-integration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **serviceDeskIntegrationDto** | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | The specifics of a new integration to create | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + servicedeskintegrationdto := []byte(`{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + }`) // ServiceDeskIntegrationDto | The specifics of a new integration to create + + + var serviceDeskIntegrationDto v2025.ServiceDeskIntegrationDto + if err := json.Unmarshal(servicedeskintegrationdto, &serviceDeskIntegrationDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.CreateServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.CreateServiceDeskIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-service-desk-integration +Delete a Service Desk integration +Delete an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-service-desk-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of Service Desk integration to delete | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `anId` // string | ID of Service Desk integration to delete # string | ID of Service Desk integration to delete + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration(context.Background(), id).Execute() + //r, err := apiClient.V2025.ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-service-desk-integration +Get a Service Desk integration +Get an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-service-desk-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Service Desk integration to get | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `anId` // string | ID of the Service Desk integration to get # string | ID of the Service Desk integration to get + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetServiceDeskIntegration(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetServiceDeskIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-service-desk-integration-template +Service Desk integration template by scriptName +This API endpoint returns an existing Service Desk integration template by scriptName. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-service-desk-integration-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the Service Desk integration template to get | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ServiceDeskIntegrationTemplateDto**](../models/service-desk-integration-template-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the Service Desk integration template to get # string | The scriptName value of the Service Desk integration template to get + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationTemplate`: ServiceDeskIntegrationTemplateDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-service-desk-integration-types +List Service Desk integration types +This API endpoint returns the current list of supported Service Desk integration types. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-service-desk-integration-types) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationTypesRequest struct via the builder pattern + + +### Return type + +[**[]ServiceDeskIntegrationTemplateType**](../models/service-desk-integration-template-type) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationTypes`: []ServiceDeskIntegrationTemplateType + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-service-desk-integrations +List existing Service Desk integrations +Get a list of Service Desk integration objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-service-desk-integrations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **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** | + **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* **type**: *eq, in* **cluster**: *eq, in* | + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `name eq "John Doe"` // 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* **type**: *eq, in* **cluster**: *eq, in* (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* **type**: *eq, in* **cluster**: *eq, in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetServiceDeskIntegrations(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetServiceDeskIntegrations(context.Background()).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrations`: []ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-status-check-details +Get the time check configuration +Get the time check configuration of queued SDIM tickets. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-status-check-details) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetStatusCheckDetailsRequest struct via the builder pattern + + +### Return type + +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetStatusCheckDetails(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetStatusCheckDetails(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetStatusCheckDetails``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetStatusCheckDetails`: QueuedCheckConfigDetails + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetStatusCheckDetails`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-service-desk-integration +Patch a Service Desk Integration +Update an existing Service Desk integration by ID with a PATCH request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-service-desk-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Service Desk integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `anId` // string | ID of the Service Desk integration to update # string | ID of the Service Desk integration to update + jsonpatchoperation := []byte(``) // []JsonPatchOperation | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.PatchServiceDeskIntegration(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.PatchServiceDeskIntegration(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.PatchServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.PatchServiceDeskIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-service-desk-integration +Update a Service Desk integration +Update an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-service-desk-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Service Desk integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **serviceDeskIntegrationDto** | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | The specifics of the integration to update | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `anId` // string | ID of the Service Desk integration to update # string | ID of the Service Desk integration to update + servicedeskintegrationdto := []byte(`{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + }`) // ServiceDeskIntegrationDto | The specifics of the integration to update + + + var serviceDeskIntegrationDto v2025.ServiceDeskIntegrationDto + if err := json.Unmarshal(servicedeskintegrationdto, &serviceDeskIntegrationDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.PutServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.PutServiceDeskIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-status-check-details +Update the time check configuration +Update the time check configuration of queued SDIM tickets. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-status-check-details) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateStatusCheckDetailsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **queuedCheckConfigDetails** | [**QueuedCheckConfigDetails**](../models/queued-check-config-details) | The modified time check configuration | + +### Return type + +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + queuedcheckconfigdetails := []byte(`{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + }`) // QueuedCheckConfigDetails | The modified time check configuration + + + var queuedCheckConfigDetails v2025.QueuedCheckConfigDetails + if err := json.Unmarshal(queuedcheckconfigdetails, &queuedCheckConfigDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.UpdateStatusCheckDetails``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateStatusCheckDetails`: QueuedCheckConfigDetails + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.UpdateStatusCheckDetails`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SourceUsagesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SourceUsagesAPI.md new file mode 100644 index 000000000..21d3c02ba --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SourceUsagesAPI.md @@ -0,0 +1,164 @@ +--- +id: v2025-source-usages +title: SourceUsages +pagination_label: SourceUsages +sidebar_label: SourceUsages +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUsages', 'V2025SourceUsages'] +slug: /tools/sdk/go/v2025/methods/source-usages +tags: ['SDK', 'Software Development Kit', 'SourceUsages', 'V2025SourceUsages'] +--- + +# SourceUsagesAPI + Use this API to implement source usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used. +This allows organizations to get the information they need to start optimizing and securing source usage. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-status-by-source-id**](#get-status-by-source-id) | **Get** `/source-usages/{sourceId}/status` | Finds status of source usage +[**get-usages-by-source-id**](#get-usages-by-source-id) | **Get** `/source-usages/{sourceId}/summaries` | Returns source usage insights + + +## get-status-by-source-id +Finds status of source usage +This API returns the status of the source usage insights setup by IDN source ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-status-by-source-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | ID of IDN source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetStatusBySourceIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SourceUsageStatus**](../models/source-usage-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | ID of IDN source # string | ID of IDN source + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourceUsagesAPI.GetStatusBySourceId(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourceUsagesAPI.GetStatusBySourceId(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourceUsagesAPI.GetStatusBySourceId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetStatusBySourceId`: SourceUsageStatus + fmt.Fprintf(os.Stdout, "Response from `SourceUsagesAPI.GetStatusBySourceId`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-usages-by-source-id +Returns source usage insights +This API returns a summary of source usage insights for past 12 months. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-usages-by-source-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | ID of IDN source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetUsagesBySourceIdRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **date** | + +### Return type + +[**[]SourceUsage**](../models/source-usage) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | ID of IDN source # string | ID of IDN source + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `-date` // 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: **date** (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: **date** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourceUsagesAPI.GetUsagesBySourceId(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourceUsagesAPI.GetUsagesBySourceId(context.Background(), sourceId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourceUsagesAPI.GetUsagesBySourceId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUsagesBySourceId`: []SourceUsage + fmt.Fprintf(os.Stdout, "Response from `SourceUsagesAPI.GetUsagesBySourceId`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SourcesAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SourcesAPI.md new file mode 100644 index 000000000..a42fc1f48 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SourcesAPI.md @@ -0,0 +1,4226 @@ +--- +id: v2025-sources +title: Sources +pagination_label: Sources +sidebar_label: Sources +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Sources', 'V2025Sources'] +slug: /tools/sdk/go/v2025/methods/sources +tags: ['SDK', 'Software Development Kit', 'Sources', 'V2025Sources'] +--- + +# SourcesAPI + Use this API to implement and customize source functionality. +With source functionality in place, organizations can use Identity Security Cloud to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way. + +[Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) refer to the Identity Security Cloud representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example. +Organizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records. +Connecting these sources to Identity Security Cloud makes it possible to manage user access across them all. +Then, if a new hire starts at an organization, Identity Security Cloud can grant the new hire access to all the sources they need. +If an employee moves to a new department and needs access to new sources but no longer needs access to others, Identity Security Cloud can grant the necessary access and revoke the unnecessary access for all the employee's various sources. +If an employee leaves the company, Identity Security Cloud can revoke access to all the employee's various source accounts immediately. +These are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure. + +In Identity Security Cloud, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so. +They can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups. +Admins go to Connections > Sources to see a list of the existing source representations in their organizations. +They can create new sources or select existing ones. + +To create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type. +Refer to [Configuring a Source](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source) for more information about the source configuration process. + +Identity Security Cloud connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in. +Different sources use different connectors to share data with Identity Security Cloud, and each connector's setup process is specific to that connector. +SailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors. +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about these SailPoint supported connectors. +Refer to the following links for more information about two useful connectors: + +- [JDBC Connector](https://documentation.sailpoint.com/connectors/jdbc/help/integrating_jdbc/introduction.html): This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity). + +- [Web Services Connector](https://documentation.sailpoint.com/connectors/webservices/help/integrating_webservices/introduction.html): This connector can directly connect to databases that support Web Services. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources. + +When admins select existing sources, they can view the following information about the source: + +- Associated connections (any associated identity profiles, apps, or references to the source in a transform). + +- Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources. + +- Associated entitlements (sets of access rights on sources). + +- Associated access profiles (groupings of entitlements). + +The user account data and the entitlements update with each data aggregation from the source. +Organizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their Identity Security Cloud tenants so an access change on a source is detected quickly in Identity Security Cloud. +Admins can view a history of these aggregations, and they can also run manual imports. +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about manual and scheduled aggregations. + +Admins can also make changes to determine which user account data Identity Security Cloud collects from the source and how it correlates that account data with identity data. +To define which account attributes the source shares with Identity Security Cloud, admins can edit the account schema on the source. +Refer to [Managing Source Account Schemas](https://documentation.sailpoint.com/saas/help/accounts/schema.html) for more information about source account schemas and how to edit them. +To define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source. +Refer to [Assigning Source Accounts to Identities](https://documentation.sailpoint.com/saas/help/accounts/correlation.html) for more information about this correlation process between source accounts and identities. + +Admins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform. +Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources. + +Well organized, mapped out connections between sources and Identity Security Cloud are essential to achieving comprehensive identity access governance across all the source systems organizations need. +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-provisioning-policy**](#create-provisioning-policy) | **Post** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy +[**create-source**](#create-source) | **Post** `/sources` | Creates a source in IdentityNow. +[**create-source-schedule**](#create-source-schedule) | **Post** `/sources/{sourceId}/schedules` | Create Schedule on Source +[**create-source-schema**](#create-source-schema) | **Post** `/sources/{sourceId}/schemas` | Create Schema on Source +[**delete-accounts-async**](#delete-accounts-async) | **Post** `/sources/{id}/remove-accounts` | Remove All Accounts in a Source +[**delete-native-change-detection-config**](#delete-native-change-detection-config) | **Delete** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration +[**delete-provisioning-policy**](#delete-provisioning-policy) | **Delete** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType +[**delete-source**](#delete-source) | **Delete** `/sources/{id}` | Delete Source by ID +[**delete-source-schedule**](#delete-source-schedule) | **Delete** `/sources/{sourceId}/schedules/{scheduleType}` | Delete Source Schedule by type. +[**delete-source-schema**](#delete-source-schema) | **Delete** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID +[**get-accounts-schema**](#get-accounts-schema) | **Get** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template +[**get-correlation-config**](#get-correlation-config) | **Get** `/sources/{id}/correlation-config` | Get Source Correlation Configuration +[**get-entitlements-schema**](#get-entitlements-schema) | **Get** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template +[**get-native-change-detection-config**](#get-native-change-detection-config) | **Get** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration +[**get-provisioning-policy**](#get-provisioning-policy) | **Get** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType +[**get-source**](#get-source) | **Get** `/sources/{id}` | Get Source by ID +[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **Get** `/sources/{id}/attribute-sync-config` | Attribute Sync Config +[**get-source-config**](#get-source-config) | **Get** `/sources/{id}/connectors/source-config` | Gets source config with language-translations +[**get-source-connections**](#get-source-connections) | **Get** `/sources/{sourceId}/connections` | Get Source Connections by ID +[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **Get** `/sources/{id}/entitlement-request-config` | Get Source Entitlement Request Configuration +[**get-source-health**](#get-source-health) | **Get** `/sources/{sourceId}/source-health` | Fetches source health by id +[**get-source-schedule**](#get-source-schedule) | **Get** `/sources/{sourceId}/schedules/{scheduleType}` | Get Source Schedule by Type +[**get-source-schedules**](#get-source-schedules) | **Get** `/sources/{sourceId}/schedules` | List Schedules on Source +[**get-source-schema**](#get-source-schema) | **Get** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID +[**get-source-schemas**](#get-source-schemas) | **Get** `/sources/{sourceId}/schemas` | List Schemas on Source +[**import-accounts**](#import-accounts) | **Post** `/sources/{id}/load-accounts` | Account Aggregation +[**import-accounts-schema**](#import-accounts-schema) | **Post** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template +[**import-connector-file**](#import-connector-file) | **Post** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source +[**import-entitlements-schema**](#import-entitlements-schema) | **Post** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template +[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **Post** `/sources/{id}/load-uncorrelated-accounts` | Process Uncorrelated Accounts +[**list-provisioning-policies**](#list-provisioning-policies) | **Get** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies +[**list-sources**](#list-sources) | **Get** `/sources` | Lists all sources in IdentityNow. +[**ping-cluster**](#ping-cluster) | **Post** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector +[**put-correlation-config**](#put-correlation-config) | **Put** `/sources/{id}/correlation-config` | Update Source Correlation Configuration +[**put-native-change-detection-config**](#put-native-change-detection-config) | **Put** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration +[**put-provisioning-policy**](#put-provisioning-policy) | **Put** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType +[**put-source**](#put-source) | **Put** `/sources/{id}` | Update Source (Full) +[**put-source-attr-sync-config**](#put-source-attr-sync-config) | **Put** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config +[**put-source-schema**](#put-source-schema) | **Put** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) +[**search-resource-objects**](#search-resource-objects) | **Post** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects +[**sync-attributes-for-source**](#sync-attributes-for-source) | **Post** `/sources/{id}/synchronize-attributes` | Synchronize single source attributes. +[**test-source-configuration**](#test-source-configuration) | **Post** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector +[**test-source-connection**](#test-source-connection) | **Post** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector. +[**update-password-policy-holders**](#update-password-policy-holders) | **Patch** `/sources/{sourceId}/password-policies` | Update Password Policy +[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **Post** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies +[**update-provisioning-policy**](#update-provisioning-policy) | **Patch** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy +[**update-source**](#update-source) | **Patch** `/sources/{id}` | Update Source (Partial) +[**update-source-entitlement-request-config**](#update-source-entitlement-request-config) | **Put** `/sources/{id}/entitlement-request-config` | Update Source Entitlement Request Configuration +[**update-source-schedule**](#update-source-schedule) | **Patch** `/sources/{sourceId}/schedules/{scheduleType}` | Update Source Schedule (Partial) +[**update-source-schema**](#update-source-schema) | **Patch** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) + + +## create-provisioning-policy +Create Provisioning Policy +This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **provisioningPolicyDto** | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | | + +### Return type + +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id # string | The Source id + provisioningpolicydto := []byte(`{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }`) // ProvisioningPolicyDto | + + + var provisioningPolicyDto v2025.ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.CreateProvisioningPolicy(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.CreateProvisioningPolicy(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateProvisioningPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-source +Creates a source in IdentityNow. +This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-source) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **source** | [**Source**](../models/source) | | + **provisionAsCsv** | **bool** | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. | + +### Return type + +[**Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + source := []byte(`{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }`) // Source | + provisionAsCsv := false // bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + + var source v2025.Source + if err := json.Unmarshal(source, &source); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.CreateSource(context.Background()).Source(source).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.CreateSource(context.Background()).Source(source).ProvisionAsCsv(provisionAsCsv).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-source-schedule +Create Schedule on Source +Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-source-schedule) + +### 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 apiCreateSourceScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schedule1** | [**Schedule1**](../models/schedule1) | | + +### Return type + +[**Schedule1**](../models/schedule1) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + schedule1 := []byte(``) // Schedule1 | + + + var schedule1 v2025.Schedule1 + if err := json.Unmarshal(schedule1, &schedule1); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.CreateSourceSchedule(context.Background(), sourceId).Schedule1(schedule1).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.CreateSourceSchedule(context.Background(), sourceId).Schedule1(schedule1).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSourceSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceSchedule`: Schedule1 + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSourceSchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-source-schema +Create Schema on Source +Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-source-schema) + +### 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 apiCreateSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schema** | [**Schema**](../models/schema) | | + +### Return type + +[**Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + schema := []byte(`{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + }`) // Schema | + + + var schema v2025.Schema + if err := json.Unmarshal(schema, &schema); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.CreateSourceSchema(context.Background(), sourceId).Schema(schema).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.CreateSourceSchema(context.Background(), sourceId).Schema(schema).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSourceSchema`: %v\n", resp) +} +``` + +[[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 +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: +* Removing accounts that no longer exist on the source. +* Removing accounts that won't be aggregated following updates to the source configuration. +* Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-accounts-async) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccountsAsyncRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**TaskResultDto**](../models/task-result-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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() + 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) + } + // response from `DeleteAccountsAsync`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.DeleteAccountsAsync`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-native-change-detection-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNativeChangeDetectionConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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.V2025.SourcesAPI.DeleteNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.SourcesAPI.DeleteNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).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) + } +} +``` + +[[Back to top]](#) + +## delete-provisioning-policy +Delete Provisioning Policy by UsageType +Deletes the provisioning policy with the specified usage on an application. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source ID. | +**usageType** | [**UsageType**](../models/) | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SourcesAPI.DeleteProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + //r, err := apiClient.V2025.SourcesAPI.DeleteProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-source +Delete Source by ID +Use this API to delete a specific source in Identity Security Cloud (ISC). +The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**DeleteSource202Response**](../models/delete-source202-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.DeleteSource(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.DeleteSource(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteSource`: DeleteSource202Response + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.DeleteSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-source-schedule +Delete Source Schedule by type. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-source-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**scheduleType** | **string** | The Schedule type. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSourceScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + scheduleType := `ACCOUNT_AGGREGATION` // string | The Schedule type. # string | The Schedule type. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SourcesAPI.DeleteSourceSchedule(context.Background(), sourceId, scheduleType).Execute() + //r, err := apiClient.V2025.SourcesAPI.DeleteSourceSchedule(context.Background(), sourceId, scheduleType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSourceSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-source-schema +Delete Source Schema by ID + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-source-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**schemaId** | **string** | The Schema id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SourcesAPI.DeleteSourceSchema(context.Background(), sourceId, schemaId).Execute() + //r, err := apiClient.V2025.SourcesAPI.DeleteSourceSchema(context.Background(), sourceId, schemaId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-accounts-schema +Downloads source accounts schema template +This API downloads the CSV schema that defines the account attributes on a source. +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-accounts-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountsSchemaRequest 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SourcesAPI.GetAccountsSchema(context.Background(), id).Execute() + //r, err := apiClient.V2025.SourcesAPI.GetAccountsSchema(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetAccountsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-correlation-config +Get Source Correlation Configuration +This API returns the existing correlation configuration for a source specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-correlation-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCorrelationConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CorrelationConfig**](../models/correlation-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetCorrelationConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetCorrelationConfig(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCorrelationConfig`: CorrelationConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetCorrelationConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-entitlements-schema +Downloads source entitlements schema template +This API downloads the CSV schema that defines the entitlement attributes on a source. + +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlements-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementsSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schemaName** | **string** | Name of entitlement schema | + +### 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + schemaName := `?schemaName=group` // string | Name of entitlement schema (optional) # string | Name of entitlement schema (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SourcesAPI.GetEntitlementsSchema(context.Background(), id).Execute() + //r, err := apiClient.V2025.SourcesAPI.GetEntitlementsSchema(context.Background(), id).SchemaName(schemaName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetEntitlementsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-native-change-detection-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNativeChangeDetectionConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**NativeChangeDetectionConfig**](../models/native-change-detection-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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.V2025.SourcesAPI.GetNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `GetNativeChangeDetectionConfig`: NativeChangeDetectionConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetNativeChangeDetectionConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-provisioning-policy +Get Provisioning Policy by UsageType +This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source ID. | +**usageType** | [**UsageType**](../models/) | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetProvisioningPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source +Get Source by ID +Use this API to get a source by a specified ID in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSource(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSource(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-attr-sync-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 + ``` +::: +Attribute Sync Config +This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-source-attr-sync-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceAttrSyncConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**AttrSyncSourceConfig**](../models/attr-sync-source-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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.V2025.SourcesAPI.GetSourceAttrSyncConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceAttrSyncConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceAttrSyncConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceAttrSyncConfig`: AttrSyncSourceConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceAttrSyncConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-config +Gets source config with language-translations +Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-source-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **locale** | **string** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | + +### Return type + +[**ConnectorDetail**](../models/connector-detail) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `cef3ee201db947c5912551015ba0c679` // string | The Source id # string | The Source id + locale := `en` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSourceConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceConfig(context.Background(), id).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceConfig`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-connections +Get Source Connections by ID +Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-source-connections) + +### 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 apiGetSourceConnectionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SourceConnectionsDto**](../models/source-connections-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSourceConnections(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceConnections(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceConnections``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceConnections`: SourceConnectionsDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceConnections`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-entitlement-request-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 + ``` +::: +Get Source Entitlement Request Configuration +This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. + +Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. +- During access request, this source-level entitlement request configuration overrides the global organization-level configuration. +- However, the entitlement-level configuration (if defined) overrides this source-level configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-source-entitlement-request-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceEntitlementRequestConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSourceEntitlementRequestConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceEntitlementRequestConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceEntitlementRequestConfig`: SourceEntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceEntitlementRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-health +Fetches source health by id +This endpoint fetches source health by source's id + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-source-health) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceHealthRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SourceHealthDto**](../models/source-health-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSourceHealth(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceHealth(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceHealth``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceHealth`: SourceHealthDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceHealth`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-schedule +Get Source Schedule by Type +Get the source schedule by type in Identity Security Cloud (ISC). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-source-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**scheduleType** | **string** | The Schedule type. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Schedule1**](../models/schedule1) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + scheduleType := `ACCOUNT_AGGREGATION` // string | The Schedule type. # string | The Schedule type. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSourceSchedule(context.Background(), sourceId, scheduleType).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceSchedule(context.Background(), sourceId, scheduleType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchedule`: Schedule1 + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-schedules +List Schedules on Source +Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). +:::info +This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. + +For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. + +**Days of the week are represented as 1-7 (Sunday-Saturday).** +::: + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-source-schedules) + +### 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 apiGetSourceSchedulesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]Schedule1**](../models/schedule1) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSourceSchedules(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceSchedules(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchedules``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchedules`: []Schedule1 + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchedules`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-schema +Get Source Schema by ID +Get the Source Schema by ID in IdentityNow. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-source-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**schemaId** | **string** | The Schema id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSourceSchema(context.Background(), sourceId, schemaId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceSchema(context.Background(), sourceId, schemaId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-schemas +List Schemas on Source +Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-source-schemas) + +### 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 apiGetSourceSchemasRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeTypes** | **string** | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. | + **includeNames** | **string** | A comma-separated list of schema names to filter result. | + +### Return type + +[**[]Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + includeTypes := `group` // string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) # string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + includeNames := `account` // string | A comma-separated list of schema names to filter result. (optional) # string | A comma-separated list of schema names to filter result. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).IncludeTypes(includeTypes).IncludeNames(includeNames).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchemas``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchemas`: []Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchemas`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-accounts +Account Aggregation +Starts an account aggregation on the specified source. +If the target source is a delimited file source, then the CSV file needs to be included in the request body. +You will also need to set the Content-Type header to `multipart/form-data`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/import-accounts) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportAccountsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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. | + +### Return type + +[**LoadAccountsTask**](../models/load-accounts-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() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source Id # string | Source Id + 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) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.ImportAccounts(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.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) + } + // response from `ImportAccounts`: LoadAccountsTask + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportAccounts`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-accounts-schema +Uploads source accounts schema template +This API uploads a source schema template file to configure a source's account attributes. + +To retrieve the file to modify and upload, log into Identity Now. + +Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** + +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/import-accounts-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportAccountsSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | | + +### Return type + +[**Schema**](../models/schema) + +### 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() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.ImportAccountsSchema(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.ImportAccountsSchema(context.Background(), id).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportAccountsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportAccountsSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportAccountsSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-connector-file +Upload connector file to source +This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/import-connector-file) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportConnectorFileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | | + +### Return type + +[**Source**](../models/source) + +### 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 := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.ImportConnectorFile(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.ImportConnectorFile(context.Background(), sourceId).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportConnectorFile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportConnectorFile`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportConnectorFile`: %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. + +To retrieve the file to modify and upload, log into Identity Now. + +Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** + +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/import-entitlements-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportEntitlementsSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schemaName** | **string** | Name of entitlement schema | + **file** | ***os.File** | | + +### Return type + +[**Schema**](../models/schema) + +### 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() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + schemaName := `?schemaName=group` // string | Name of entitlement schema (optional) # string | Name of entitlement schema (optional) + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.ImportEntitlementsSchema(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.ImportEntitlementsSchema(context.Background(), id).SchemaName(schemaName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportEntitlementsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportEntitlementsSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportEntitlementsSchema`: %v\n", resp) +} +``` + +[[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` + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/import-uncorrelated-accounts) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportUncorrelatedAccountsRequest 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** | | + +### Return type + +[**LoadUncorrelatedAccountsTask**](../models/load-uncorrelated-accounts-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() { + 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() + 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) + } + // response from `ImportUncorrelatedAccounts`: LoadUncorrelatedAccountsTask + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportUncorrelatedAccounts`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-provisioning-policies +Lists ProvisioningPolicies +This end-point lists all the ProvisioningPolicies in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-provisioning-policies) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListProvisioningPoliciesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.ListProvisioningPolicies(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.ListProvisioningPolicies(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ListProvisioningPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListProvisioningPolicies`: []ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ListProvisioningPolicies`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-sources +Lists all sources in IdentityNow. +This end-point lists all the sources in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-sources) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSourcesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* | + **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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** | + **forSubadmin** | **string** | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. | + **includeIDNSource** | **bool** | Include the IdentityNow source in the response. | [default to false] + +### Return type + +[**[]Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Employees"` // 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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + sorters := `name` // 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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + forSubadmin := `name` // string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) # string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + includeIDNSource := true // bool | Include the IdentityNow source in the response. (optional) (default to false) # bool | Include the IdentityNow source in the response. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.ListSources(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.ListSources(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSubadmin(forSubadmin).IncludeIDNSource(includeIDNSource).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ListSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSources`: []Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ListSources`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## ping-cluster +Ping cluster for source connector +This endpoint validates that the cluster being used by the source is reachable from IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/ping-cluster) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The ID of the Source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPingClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**StatusResponse**](../models/status-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.PingCluster(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.PingCluster(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PingCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PingCluster`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PingCluster`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-correlation-config +Update Source Correlation Configuration +Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-correlation-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutCorrelationConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **correlationConfig** | [**CorrelationConfig**](../models/correlation-config) | | + +### Return type + +[**CorrelationConfig**](../models/correlation-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + correlationconfig := []byte(`{ + "attributeAssignments" : [ { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + }, { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + } ], + "name" : "Source [source] Account Correlation", + "id" : "2c9180835d191a86015d28455b4a2329" + }`) // CorrelationConfig | + + + var correlationConfig v2025.CorrelationConfig + if err := json.Unmarshal(correlationconfig, &correlationConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.PutCorrelationConfig(context.Background(), id).CorrelationConfig(correlationConfig).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.PutCorrelationConfig(context.Background(), id).CorrelationConfig(correlationConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutCorrelationConfig`: CorrelationConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutCorrelationConfig`: %v\n", resp) +} +``` + +[[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. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-native-change-detection-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutNativeChangeDetectionConfigRequest struct via the builder pattern + + +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 + +[**NativeChangeDetectionConfig**](../models/native-change-detection-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true + }`) // NativeChangeDetectionConfig | + + + var nativeChangeDetectionConfig v2025.NativeChangeDetectionConfig + if err := json.Unmarshal(nativechangedetectionconfig, &nativeChangeDetectionConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.PutNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).NativeChangeDetectionConfig(nativeChangeDetectionConfig).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.PutNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `PutNativeChangeDetectionConfig`: NativeChangeDetectionConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutNativeChangeDetectionConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-provisioning-policy +Update Provisioning Policy by UsageType +This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source ID. | +**usageType** | [**UsageType**](../models/) | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **provisioningPolicyDto** | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | | + +### Return type + +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + provisioningpolicydto := []byte(`{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }`) // ProvisioningPolicyDto | + + + var provisioningPolicyDto v2025.ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.PutProvisioningPolicy(context.Background(), sourceId, usageType).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.PutProvisioningPolicy(context.Background(), sourceId, usageType).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutProvisioningPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-source +Update Source (Full) +Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. + +These fields are immutable, so they cannot be changed: + +* id +* type +* authoritative +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **source** | [**Source**](../models/source) | | + +### Return type + +[**Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + source := []byte(`{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }`) // Source | + + + var source v2025.Source + if err := json.Unmarshal(source, &source); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.PutSource(context.Background(), id).Source(source).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.PutSource(context.Background(), id).Source(source).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-source-attr-sync-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 Attribute Sync Config +Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-source-attr-sync-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSourceAttrSyncConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **attrSyncSourceConfig** | [**AttrSyncSourceConfig**](../models/attr-sync-source-config) | | + +### Return type + +[**AttrSyncSourceConfig**](../models/attr-sync-source-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + attrsyncsourceconfig := []byte(`{ + "attributes" : [ { + "name" : "email", + "displayName" : "Email", + "enabled" : true, + "target" : "mail" + }, { + "name" : "firstname", + "displayName" : "First Name", + "enabled" : false, + "target" : "givenName" + } ], + "source" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + } + }`) // AttrSyncSourceConfig | + + + var attrSyncSourceConfig v2025.AttrSyncSourceConfig + if err := json.Unmarshal(attrsyncsourceconfig, &attrSyncSourceConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.PutSourceAttrSyncConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).AttrSyncSourceConfig(attrSyncSourceConfig).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.PutSourceAttrSyncConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).AttrSyncSourceConfig(attrSyncSourceConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSourceAttrSyncConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSourceAttrSyncConfig`: AttrSyncSourceConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSourceAttrSyncConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-source-schema +Update Source Schema (Full) +This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. + +* id +* name +* created +* modified + +Any attempt to modify these fields will result in an error response with a status code of 400. + +> `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-source-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**schemaId** | **string** | The Schema id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **schema** | [**Schema**](../models/schema) | | + +### Return type + +[**Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + schema := []byte(`{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + }`) // Schema | + + + var schema v2025.Schema + if err := json.Unmarshal(schema, &schema); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.PutSourceSchema(context.Background(), sourceId, schemaId).Schema(schema).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.PutSourceSchema(context.Background(), sourceId, schemaId).Schema(schema).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSourceSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-resource-objects +Peek source connector's resource objects +Retrieves a sample of data returned from account and group aggregation requests. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/search-resource-objects) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The ID of the Source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchResourceObjectsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **resourceObjectsRequest** | [**ResourceObjectsRequest**](../models/resource-objects-request) | | + +### Return type + +[**ResourceObjectsResponse**](../models/resource-objects-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + resourceobjectsrequest := []byte(`{ + "maxCount" : 100, + "objectType" : "group" + }`) // ResourceObjectsRequest | + + + var resourceObjectsRequest v2025.ResourceObjectsRequest + if err := json.Unmarshal(resourceobjectsrequest, &resourceObjectsRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.SearchResourceObjects(context.Background(), sourceId).ResourceObjectsRequest(resourceObjectsRequest).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.SearchResourceObjects(context.Background(), sourceId).ResourceObjectsRequest(resourceObjectsRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.SearchResourceObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchResourceObjects`: ResourceObjectsResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.SearchResourceObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## sync-attributes-for-source +:::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 + ``` +::: +Synchronize single source attributes. +This end-point performs attribute synchronization for a selected source. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/sync-attributes-for-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSyncAttributesForSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**SourceSyncJob**](../models/source-sync-job) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `id_example` // 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.SyncAttributesForSource(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.SyncAttributesForSource(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.SyncAttributesForSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SyncAttributesForSource`: SourceSyncJob + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.SyncAttributesForSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-source-configuration +Test configuration for source connector +This endpoint performs a more detailed validation of the source''s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/test-source-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The ID of the Source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestSourceConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**StatusResponse**](../models/status-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.TestSourceConfiguration(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.TestSourceConfiguration(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.TestSourceConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConfiguration`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.TestSourceConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-source-connection +Check connection for source connector. +This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/test-source-connection) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The ID of the Source. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestSourceConnectionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**StatusResponse**](../models/status-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source. # string | The ID of the Source. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.TestSourceConnection(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.TestSourceConnection(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.TestSourceConnection``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConnection`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.TestSourceConnection`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-password-policy-holders +Update Password Policy +This API can be used to set up or update Password Policy in IdentityNow for the specified Source. +Source must support PASSWORD feature. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-password-policy-holders) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdatePasswordPolicyHoldersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **passwordPolicyHoldersDtoInner** | [**[]PasswordPolicyHoldersDtoInner**](../models/password-policy-holders-dto-inner) | | + +### Return type + +[**[]PasswordPolicyHoldersDtoInner**](../models/password-policy-holders-dto-inner) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + passwordpolicyholdersdtoinner := []byte(``) // []PasswordPolicyHoldersDtoInner | + + + var passwordPolicyHoldersDtoInner v2025.[]PasswordPolicyHoldersDtoInner + if err := json.Unmarshal(passwordpolicyholdersdtoinner, &passwordPolicyHoldersDtoInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.UpdatePasswordPolicyHolders(context.Background(), sourceId).PasswordPolicyHoldersDtoInner(passwordPolicyHoldersDtoInner).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.UpdatePasswordPolicyHolders(context.Background(), sourceId).PasswordPolicyHoldersDtoInner(passwordPolicyHoldersDtoInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdatePasswordPolicyHolders``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePasswordPolicyHolders`: []PasswordPolicyHoldersDtoInner + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdatePasswordPolicyHolders`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-provisioning-policies-in-bulk +Bulk Update Provisioning Policies +This end-point updates a list of provisioning policies on the specified source in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-provisioning-policies-in-bulk) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateProvisioningPoliciesInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **provisioningPolicyDto** | [**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) | | + +### Return type + +[**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + provisioningpolicydto := []byte(``) // []ProvisioningPolicyDto | + + + var provisioningPolicyDto v2025.[]ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.UpdateProvisioningPoliciesInBulk(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.UpdateProvisioningPoliciesInBulk(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateProvisioningPoliciesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateProvisioningPoliciesInBulk`: []ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateProvisioningPoliciesInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-provisioning-policy +Partial update of Provisioning Policy +This API selectively updates an existing Provisioning Policy using a JSONPatch payload. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**usageType** | [**UsageType**](../models/) | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | The JSONPatch payload used to update the schema. | + +### Return type + +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + jsonpatchoperation := []byte(`[{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schema. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.UpdateProvisioningPolicy(context.Background(), sourceId, usageType).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.UpdateProvisioningPolicy(context.Background(), sourceId, usageType).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateProvisioningPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-source +Update Source (Partial) +Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the +[JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +These fields are immutable, so they cannot be changed: + +* id +* type +* authoritative +* created +* modified +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). | + +### Return type + +[**Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=new description}]`) // []JsonPatchOperation | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.UpdateSource(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.UpdateSource(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-source-entitlement-request-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 Source Entitlement Request Configuration +This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. + +Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. +- During access request, this source-level entitlement request configuration overrides the global organization-level configuration. +- However, the entitlement-level configuration (if defined) overrides this source-level configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-source-entitlement-request-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSourceEntitlementRequestConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **sourceEntitlementRequestConfig** | [**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) | | + +### Return type + +[**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + sourceentitlementrequestconfig := []byte(`{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }`) // SourceEntitlementRequestConfig | + + + var sourceEntitlementRequestConfig v2025.SourceEntitlementRequestConfig + if err := json.Unmarshal(sourceentitlementrequestconfig, &sourceEntitlementRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.UpdateSourceEntitlementRequestConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceEntitlementRequestConfig(sourceEntitlementRequestConfig).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.UpdateSourceEntitlementRequestConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceEntitlementRequestConfig(sourceEntitlementRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceEntitlementRequestConfig`: SourceEntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceEntitlementRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-source-schedule +Update Source Schedule (Partial) +Use this API to selectively update an existing Schedule using a JSONPatch payload. + +The following schedule fields are immutable and cannot be updated: + +- type + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-source-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**scheduleType** | **string** | The Schedule type. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSourceScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | The JSONPatch payload used to update the schedule. | + +### Return type + +[**Schedule1**](../models/schedule1) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + scheduleType := `ACCOUNT_AGGREGATION` // string | The Schedule type. # string | The Schedule type. + jsonpatchoperation := []byte(`[{op=replace, path=/cronExpression, value=0 0 6 * * ?}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schedule. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.UpdateSourceSchedule(context.Background(), sourceId, scheduleType).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.UpdateSourceSchedule(context.Background(), sourceId, scheduleType).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceSchedule`: Schedule1 + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceSchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-source-schema +Update Source Schema (Partial) +Use this API to selectively update an existing Schema using a JSONPatch payload. + +The following schema fields are immutable and cannot be updated: + +- id +- name +- created +- modified + + +To switch an account attribute to a group entitlement, you need to have the following in place: + +- `isEntitlement: true` +- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: +```json +{ + "name": "groups", + "type": "STRING", + "schema": { + "type": "CONNECTOR_SCHEMA", + "id": "2c9180887671ff8c01767b4671fc7d60", + "name": "group" + }, + "description": "The groups, roles etc. that reference account group objects", + "isMulti": true, + "isEntitlement": true, + "isGroup": true +} +``` + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-source-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**schemaId** | **string** | The Schema id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | The JSONPatch payload used to update the schema. | + +### Return type + +[**Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + jsonpatchoperation := []byte(`[{op=add, path=/attributes/-, value={name=location, type=STRING, schema=null, description=Employee location, isMulti=false, isEntitlement=false, isGroup=false}}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schema. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.UpdateSourceSchema(context.Background(), sourceId, schemaId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.UpdateSourceSchema(context.Background(), sourceId, schemaId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SuggestedEntitlementDescriptionAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SuggestedEntitlementDescriptionAPI.md new file mode 100644 index 000000000..a20990dbb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SuggestedEntitlementDescriptionAPI.md @@ -0,0 +1,531 @@ +--- +id: v2025-suggested-entitlement-description +title: SuggestedEntitlementDescription +pagination_label: SuggestedEntitlementDescription +sidebar_label: SuggestedEntitlementDescription +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SuggestedEntitlementDescription', 'V2025SuggestedEntitlementDescription'] +slug: /tools/sdk/go/v2025/methods/suggested-entitlement-description +tags: ['SDK', 'Software Development Kit', 'SuggestedEntitlementDescription', 'V2025SuggestedEntitlementDescription'] +--- + +# SuggestedEntitlementDescriptionAPI + Use this API to implement Suggested Entitlement Description (SED) functionality. +SED functionality leverages the power of LLM to generate suggested entitlement descriptions. +Refer to [GenAI Entitlement Descriptions](https://documentation.sailpoint.com/saas/help/access/entitlements.html#genai-entitlement-descriptions) to learn more about SED in Identity Security Cloud (ISC). + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-sed-batch-stats**](#get-sed-batch-stats) | **Get** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit Sed Batch Stats Request +[**get-sed-batches**](#get-sed-batches) | **Get** `/suggested-entitlement-description-batches` | List Sed Batch Request +[**list-seds**](#list-seds) | **Get** `/suggested-entitlement-descriptions` | List Suggested Entitlement Descriptions +[**patch-sed**](#patch-sed) | **Patch** `/suggested-entitlement-descriptions` | Patch Suggested Entitlement Description +[**submit-sed-approval**](#submit-sed-approval) | **Post** `/suggested-entitlement-description-approvals` | Submit Bulk Approval Request +[**submit-sed-assignment**](#submit-sed-assignment) | **Post** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request +[**submit-sed-batch-request**](#submit-sed-batch-request) | **Post** `/suggested-entitlement-description-batches` | Submit Sed Batch Request + + +## get-sed-batch-stats +Submit Sed Batch Stats Request +'Submit Sed Batch Stats Request. + + Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats + of the batchId.' + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sed-batch-stats) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**batchId** | **string** | Batch Id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSedBatchStatsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SedBatchStats**](../models/sed-batch-stats) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + batchId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | Batch Id # string | Batch Id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.GetSedBatchStats(context.Background(), batchId).Execute() + //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.GetSedBatchStats(context.Background(), batchId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatchStats``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSedBatchStats`: SedBatchStats + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatchStats`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sed-batches +List Sed Batch Request +List Sed Batches. +API responses with Sed Batch Status + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sed-batches) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSedBatchesRequest struct via the builder pattern + + +### Return type + +[**SedBatchStatus**](../models/sed-batch-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatches``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSedBatches`: SedBatchStatus + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatches`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-seds +List Suggested Entitlement Descriptions +List of Suggested Entitlement Descriptions (SED) + +SED field descriptions: + +**batchId**: the ID of the batch of entitlements that are submitted for description generation + +**displayName**: the display name of the entitlement that we are generating a description for + +**sourceName**: the name of the source associated with the entitlement that we are generating the description for + +**sourceId**: the ID of the source associated with the entitlement that we are generating the description for + +**status**: the status of the suggested entitlement description, valid status options: "requested", "suggested", "not_suggested", "failed", "assigned", "approved", "denied" + +**fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-seds) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSedsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* | + **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: **displayName, sourceName, status** | + **countOnly** | **bool** | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. | [default to false] + **requestedByAnyone** | **bool** | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested | [default to false] + **showPendingStatusOnly** | **bool** | Will limit records to items that are in \"suggested\" or \"approved\" status | [default to false] + +### Return type + +[**[]Sed**](../models/sed) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `displayName co "Read and Write"` // 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) + sorters := `sorters=displayName` // 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: **displayName, sourceName, status** (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: **displayName, sourceName, status** (optional) + countOnly := count-only=true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) + requestedByAnyone := requested-by-anyone=true // bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to false) # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to false) + showPendingStatusOnly := show-pending-status-only=true // bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to false) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.ListSeds(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.ListSeds(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).CountOnly(countOnly).RequestedByAnyone(requestedByAnyone).ShowPendingStatusOnly(showPendingStatusOnly).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.ListSeds``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSeds`: []Sed + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.ListSeds`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-sed +Patch Suggested Entitlement Description +Patch Suggested Entitlement Description + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-sed) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | id is sed id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSedRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **sedPatch** | [**[]SedPatch**](../models/sed-patch) | Sed Patch Request | + +### Return type + +[**Sed**](../models/sed) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ebab396f-0af1-4050-89b7-dafc63ec70e7` // string | id is sed id # string | id is sed id + sedpatch := []byte(``) // []SedPatch | Sed Patch Request + + + var sedPatch v2025.[]SedPatch + if err := json.Unmarshal(sedpatch, &sedPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.PatchSed(context.Background(), id).SedPatch(sedPatch).Execute() + //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.PatchSed(context.Background(), id).SedPatch(sedPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.PatchSed``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSed`: Sed + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.PatchSed`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-sed-approval +Submit Bulk Approval Request +Submit Bulk Approval Request for SED. +Request body takes list of SED Ids. API responses with list of SED Approval Status + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/submit-sed-approval) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitSedApprovalRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sedApproval** | [**[]SedApproval**](../models/sed-approval) | Sed Approval | + +### Return type + +[**[]SedApprovalStatus**](../models/sed-approval-status) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sedapproval := []byte(``) // []SedApproval | Sed Approval + + + var sedApproval v2025.[]SedApproval + if err := json.Unmarshal(sedapproval, &sedApproval); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.SubmitSedApproval(context.Background()).SedApproval(sedApproval).Execute() + //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.SubmitSedApproval(context.Background()).SedApproval(sedApproval).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedApproval`: []SedApprovalStatus + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedApproval`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-sed-assignment +Submit Sed Assignment Request +Submit Assignment Request. +Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/submit-sed-assignment) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitSedAssignmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sedAssignment** | [**SedAssignment**](../models/sed-assignment) | Sed Assignment Request | + +### Return type + +[**SedAssignmentResponse**](../models/sed-assignment-response) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sedassignment := []byte(`{ + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] + }`) // SedAssignment | Sed Assignment Request + + + var sedAssignment v2025.SedAssignment + if err := json.Unmarshal(sedassignment, &sedAssignment); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.SubmitSedAssignment(context.Background()).SedAssignment(sedAssignment).Execute() + //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.SubmitSedAssignment(context.Background()).SedAssignment(sedAssignment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedAssignment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedAssignment`: SedAssignmentResponse + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedAssignment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-sed-batch-request +Submit Sed Batch Request +Submit Sed Batch Request. +Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/submit-sed-batch-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitSedBatchRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sedBatchRequest** | [**SedBatchRequest**](../models/sed-batch-request) | Sed Batch Request | + +### Return type + +[**SedBatchResponse**](../models/sed-batch-response) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sedbatchrequest := []byte(`{ + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + }`) // SedBatchRequest | Sed Batch Request (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest(context.Background()).SedBatchRequest(sedBatchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedBatchRequest`: SedBatchResponse + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/TaggedObjectsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/TaggedObjectsAPI.md new file mode 100644 index 000000000..7db98030e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/TaggedObjectsAPI.md @@ -0,0 +1,678 @@ +--- +id: v2025-tagged-objects +title: TaggedObjects +pagination_label: TaggedObjects +sidebar_label: TaggedObjects +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaggedObjects', 'V2025TaggedObjects'] +slug: /tools/sdk/go/v2025/methods/tagged-objects +tags: ['SDK', 'Software Development Kit', 'TaggedObjects', 'V2025TaggedObjects'] +--- + +# TaggedObjectsAPI + Use this API to implement object tagging functionality. +With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches Identity Security Cloud. + +In Identity Security Cloud, users can search their tenants for information and add tags objects they find. +Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future. + +For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. +Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. +The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. +When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag. + +With the API, you can tag even more different object types than you can in Identity Security Cloud (access profiles, entitlements, identities, and roles). +You can use the API to tag all these objects: + +- Access profiles + +- Applications + +- Certification campaigns + +- Entitlements + +- Identities + +- Roles + +- SOD (separation of duties) policies + +- Sources + +You can also use the API to directly find, create, and manage tagged objects without using search queries. + +There are limits to tags: + +- You can have up to 500 different tags in your tenant. + +- You can apply up to 30 tags to one object. + +- You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant. + +Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by Identity Security Cloud. + +These are the types of information often expressed in tags: + +- Affected departments + +- Compliance and regulatory categories + +- Remediation urgency levels + +- Risk levels + +Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-tagged-object**](#delete-tagged-object) | **Delete** `/tagged-objects/{type}/{id}` | Delete Object Tags +[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **Post** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects +[**get-tagged-object**](#get-tagged-object) | **Get** `/tagged-objects/{type}/{id}` | Get Tagged Object +[**list-tagged-objects**](#list-tagged-objects) | **Get** `/tagged-objects` | List Tagged Objects +[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **Get** `/tagged-objects/{type}` | List Tagged Objects by Type +[**put-tagged-object**](#put-tagged-object) | **Put** `/tagged-objects/{type}/{id}` | Update Tagged Object +[**set-tag-to-object**](#set-tag-to-object) | **Post** `/tagged-objects` | Add Tag to Object +[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **Post** `/tagged-objects/bulk-add` | Tag Multiple Objects + + +## delete-tagged-object +Delete Object Tags +Delete all tags from a tagged object. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-tagged-object) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**type_** | **string** | The type of object to delete tags from. | +**id** | **string** | The ID of the object to delete tags from. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteTaggedObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `ROLE` // string | The type of object to delete tags from. # string | The type of object to delete tags from. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object to delete tags from. # string | The ID of the object to delete tags from. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.TaggedObjectsAPI.DeleteTaggedObject(context.Background(), type_, id).Execute() + //r, err := apiClient.V2025.TaggedObjectsAPI.DeleteTaggedObject(context.Background(), type_, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.DeleteTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-tags-to-many-object +Remove Tags from Multiple Objects +This API removes tags from multiple objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-tags-to-many-object) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteTagsToManyObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulkRemoveTaggedObject** | [**BulkRemoveTaggedObject**](../models/bulk-remove-tagged-object) | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + bulkremovetaggedobject := []byte(`{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // BulkRemoveTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + + var bulkRemoveTaggedObject v2025.BulkRemoveTaggedObject + if err := json.Unmarshal(bulkremovetaggedobject, &bulkRemoveTaggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.TaggedObjectsAPI.DeleteTagsToManyObject(context.Background()).BulkRemoveTaggedObject(bulkRemoveTaggedObject).Execute() + //r, err := apiClient.V2025.TaggedObjectsAPI.DeleteTagsToManyObject(context.Background()).BulkRemoveTaggedObject(bulkRemoveTaggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.DeleteTagsToManyObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-tagged-object +Get Tagged Object +This gets a tagged object for the specified type. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-tagged-object) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**type_** | **string** | The type of tagged object to retrieve. | +**id** | **string** | The ID of the object reference to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTaggedObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**TaggedObject**](../models/tagged-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `ROLE` // string | The type of tagged object to retrieve. # string | The type of tagged object to retrieve. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to retrieve. # string | The ID of the object reference to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TaggedObjectsAPI.GetTaggedObject(context.Background(), type_, id).Execute() + //resp, r, err := apiClient.V2025.TaggedObjectsAPI.GetTaggedObject(context.Background(), type_, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.GetTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaggedObject`: TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.GetTaggedObject`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-tagged-objects +List Tagged Objects +This API returns a list of all tagged objects. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-tagged-objects) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTaggedObjectsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* | + +### Return type + +[**[]TaggedObject**](../models/tagged-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `tagName eq "BU_FINANCE"` // 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TaggedObjectsAPI.ListTaggedObjects(context.Background()).Execute() + //resp, r, err := apiClient.V2025.TaggedObjectsAPI.ListTaggedObjects(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.ListTaggedObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTaggedObjects`: []TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.ListTaggedObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-tagged-objects-by-type +List Tagged Objects by Type +This API returns a list of all tagged objects by type. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-tagged-objects-by-type) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**type_** | **string** | The type of tagged object to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTaggedObjectsByTypeRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **objectRef.id**: *eq* **objectRef.type**: *eq* | + +### Return type + +[**[]TaggedObject**](../models/tagged-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `ROLE` // string | The type of tagged object to retrieve. # string | The type of tagged object to retrieve. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `objectRef.id eq "2c91808568c529c60168cca6f90c1313"` // 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: **objectRef.id**: *eq* **objectRef.type**: *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: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TaggedObjectsAPI.ListTaggedObjectsByType(context.Background(), type_).Execute() + //resp, r, err := apiClient.V2025.TaggedObjectsAPI.ListTaggedObjectsByType(context.Background(), type_).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.ListTaggedObjectsByType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTaggedObjectsByType`: []TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.ListTaggedObjectsByType`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-tagged-object +Update Tagged Object +This updates a tagged object for the specified type. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-tagged-object) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**type_** | **string** | The type of tagged object to update. | +**id** | **string** | The ID of the object reference to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutTaggedObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **taggedObject** | [**TaggedObject**](../models/tagged-object) | | + +### Return type + +[**TaggedObject**](../models/tagged-object) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `ROLE` // string | The type of tagged object to update. # string | The type of tagged object to update. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to update. # string | The ID of the object reference to update. + taggedobject := []byte(`{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // TaggedObject | + + + var taggedObject v2025.TaggedObject + if err := json.Unmarshal(taggedobject, &taggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TaggedObjectsAPI.PutTaggedObject(context.Background(), type_, id).TaggedObject(taggedObject).Execute() + //resp, r, err := apiClient.V2025.TaggedObjectsAPI.PutTaggedObject(context.Background(), type_, id).TaggedObject(taggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.PutTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutTaggedObject`: TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.PutTaggedObject`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-tag-to-object +Add Tag to Object +This adds a tag to an object. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-tag-to-object) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetTagToObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **taggedObject** | [**TaggedObject**](../models/tagged-object) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + taggedobject := []byte(`{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // TaggedObject | + + + var taggedObject v2025.TaggedObject + if err := json.Unmarshal(taggedobject, &taggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.TaggedObjectsAPI.SetTagToObject(context.Background()).TaggedObject(taggedObject).Execute() + //r, err := apiClient.V2025.TaggedObjectsAPI.SetTagToObject(context.Background()).TaggedObject(taggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.SetTagToObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## set-tags-to-many-objects +Tag Multiple Objects +This API adds tags to multiple objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-tags-to-many-objects) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetTagsToManyObjectsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulkAddTaggedObject** | [**BulkAddTaggedObject**](../models/bulk-add-tagged-object) | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. | + +### Return type + +[**[]BulkTaggedObjectResponse**](../models/bulk-tagged-object-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + bulkaddtaggedobject := []byte(`{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // BulkAddTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + + var bulkAddTaggedObject v2025.BulkAddTaggedObject + if err := json.Unmarshal(bulkaddtaggedobject, &bulkAddTaggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TaggedObjectsAPI.SetTagsToManyObjects(context.Background()).BulkAddTaggedObject(bulkAddTaggedObject).Execute() + //resp, r, err := apiClient.V2025.TaggedObjectsAPI.SetTagsToManyObjects(context.Background()).BulkAddTaggedObject(bulkAddTaggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.SetTagsToManyObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetTagsToManyObjects`: []BulkTaggedObjectResponse + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.SetTagsToManyObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/TaskManagementAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/TaskManagementAPI.md new file mode 100644 index 000000000..d4c83fbb4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/TaskManagementAPI.md @@ -0,0 +1,430 @@ +--- +id: v2025-task-management +title: TaskManagement +pagination_label: TaskManagement +sidebar_label: TaskManagement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskManagement', 'V2025TaskManagement'] +slug: /tools/sdk/go/v2025/methods/task-management +tags: ['SDK', 'Software Development Kit', 'TaskManagement', 'V2025TaskManagement'] +--- + +# TaskManagementAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-pending-task-headers**](#get-pending-task-headers) | **Head** `/task-status/pending-tasks` | Retrieve Pending Task List Headers +[**get-pending-tasks**](#get-pending-tasks) | **Get** `/task-status/pending-tasks` | Retrieve Pending Task Status List +[**get-task-status**](#get-task-status) | **Get** `/task-status/{id}` | Get Task Status by ID +[**get-task-status-list**](#get-task-status-list) | **Get** `/task-status` | Retrieve Task Status List +[**update-task-status**](#update-task-status) | **Patch** `/task-status/{id}` | Update Task Status by ID + + +## get-pending-task-headers +:::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 + ``` +::: +Retrieve Pending Task List Headers +Responds with headers only for list of task statuses for pending tasks. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-pending-task-headers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPendingTaskHeadersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.TaskManagementAPI.GetPendingTaskHeaders(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.TaskManagementAPI.GetPendingTaskHeaders(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetPendingTaskHeaders``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-pending-tasks +:::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 + ``` +::: +Retrieve Pending Task Status List +Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-pending-tasks) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPendingTasksRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]TaskStatus**](../models/task-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TaskManagementAPI.GetPendingTasks(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.TaskManagementAPI.GetPendingTasks(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetPendingTasks``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPendingTasks`: []TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetPendingTasks`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-task-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 + ``` +::: +Get Task Status by ID +Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-task-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Task ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTaskStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**TaskStatus**](../models/task-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `00eebcf881994e419d72e757fd30dc0e` // string | Task ID. # string | Task 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.TaskManagementAPI.GetTaskStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.TaskManagementAPI.GetTaskStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetTaskStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaskStatus`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetTaskStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-task-status-list +:::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 + ``` +::: +Retrieve Task Status List +Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTaskStatusListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* | + **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: **created** | + +### Return type + +[**[]TaskStatus**](../models/task-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `completionStatus eq "Success"` // 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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) + sorters := `-created` // 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: **created** (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: **created** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TaskManagementAPI.GetTaskStatusList(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.TaskManagementAPI.GetTaskStatusList(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetTaskStatusList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaskStatusList`: []TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetTaskStatusList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-task-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 + ``` +::: +Update Task Status by ID +Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-task-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Task ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateTaskStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | The JSONPatch payload used to update the object. | + +### Return type + +[**TaskStatus**](../models/task-status) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `00eebcf881994e419d72e757fd30dc0e` // string | Task ID. # string | Task 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") + jsonpatchoperation := []byte(``) // []JsonPatchOperation | The JSONPatch payload used to update the object. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TaskManagementAPI.UpdateTaskStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.TaskManagementAPI.UpdateTaskStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.UpdateTaskStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateTaskStatus`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.UpdateTaskStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/TenantAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/TenantAPI.md new file mode 100644 index 000000000..8c96678d2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/TenantAPI.md @@ -0,0 +1,77 @@ +--- +id: v2025-tenant +title: Tenant +pagination_label: Tenant +sidebar_label: Tenant +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Tenant', 'V2025Tenant'] +slug: /tools/sdk/go/v2025/methods/tenant +tags: ['SDK', 'Software Development Kit', 'Tenant', 'V2025Tenant'] +--- + +# TenantAPI + API for reading tenant details. +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-tenant**](#get-tenant) | **Get** `/tenant` | Get Tenant Information. + + +## get-tenant +Get Tenant Information. +This rest endpoint can be used to retrieve tenant details. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-tenant) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTenantRequest struct via the builder pattern + + +### Return type + +[**Tenant**](../models/tenant) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TenantAPI.GetTenant(context.Background()).Execute() + //resp, r, err := apiClient.V2025.TenantAPI.GetTenant(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TenantAPI.GetTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenant`: Tenant + fmt.Fprintf(os.Stdout, "Response from `TenantAPI.GetTenant`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/TenantContextAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/TenantContextAPI.md new file mode 100644 index 000000000..23982e353 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/TenantContextAPI.md @@ -0,0 +1,185 @@ +--- +id: v2025-tenant-context +title: TenantContext +pagination_label: TenantContext +sidebar_label: TenantContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantContext', 'V2025TenantContext'] +slug: /tools/sdk/go/v2025/methods/tenant-context +tags: ['SDK', 'Software Development Kit', 'TenantContext', 'V2025TenantContext'] +--- + +# TenantContextAPI + The purpose of this API is to manage key-value pairs specific to a tenant's context, enabling dynamic configuration and personalized settings per tenant. +Context key-value pairs will consist of common terms and acronyms used within your organization. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-tenant-context**](#get-tenant-context) | **Get** `/tenant-context` | Retrieve tenant context +[**patch-tenant-context**](#patch-tenant-context) | **Patch** `/tenant-context` | Update tenant context + + +## get-tenant-context +:::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 + ``` +::: +Retrieve tenant context +Returns a list of key-value pairs representing the current state of the tenant's context. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-tenant-context) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTenantContextRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**[]GetTenantContext200ResponseInner**](../models/get-tenant-context200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TenantContextAPI.GetTenantContext(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.TenantContextAPI.GetTenantContext(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TenantContextAPI.GetTenantContext``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenantContext`: []GetTenantContext200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `TenantContextAPI.GetTenantContext`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-tenant-context +:::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 tenant context +Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +This endpoint is specifically designed to modify the `/Key/*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. + +Note that each tenant is limited to a maximum of 100 key-value pairs. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-tenant-context) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchTenantContextRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **jsonPatchOperation** | [**JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + jsonpatchoperation := []byte(`{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }`) // JsonPatchOperation | + + + var jsonPatchOperation v2025.JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.TenantContextAPI.PatchTenantContext(context.Background()).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //r, err := apiClient.V2025.TenantContextAPI.PatchTenantContext(context.Background()).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TenantContextAPI.PatchTenantContext``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/TransformsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/TransformsAPI.md new file mode 100644 index 000000000..36ddd3de7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/TransformsAPI.md @@ -0,0 +1,373 @@ +--- +id: v2025-transforms +title: Transforms +pagination_label: Transforms +sidebar_label: Transforms +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Transforms', 'V2025Transforms'] +slug: /tools/sdk/go/v2025/methods/transforms +tags: ['SDK', 'Software Development Kit', 'Transforms', 'V2025Transforms'] +--- + +# TransformsAPI + The purpose of this API is to expose functionality for the manipulation of Transform objects. +Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having +to write code. + +Refer to [Transforms](https://developer.sailpoint.com/docs/extensibility/transforms/) for more information about transforms. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-transform**](#create-transform) | **Post** `/transforms` | Create transform +[**delete-transform**](#delete-transform) | **Delete** `/transforms/{id}` | Delete a transform +[**get-transform**](#get-transform) | **Get** `/transforms/{id}` | Transform by ID +[**list-transforms**](#list-transforms) | **Get** `/transforms` | List transforms +[**update-transform**](#update-transform) | **Put** `/transforms/{id}` | Update a transform + + +## create-transform +Create transform +Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-transform) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateTransformRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transform** | [**Transform**](../models/transform) | The transform to be created. | + +### Return type + +[**TransformRead**](../models/transform-read) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + transform := []byte(`{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }`) // Transform | The transform to be created. + + + var transform v2025.Transform + if err := json.Unmarshal(transform, &transform); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TransformsAPI.CreateTransform(context.Background()).Transform(transform).Execute() + //resp, r, err := apiClient.V2025.TransformsAPI.CreateTransform(context.Background()).Transform(transform).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.CreateTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.CreateTransform`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-transform +Delete a transform +Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-transform) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the transform to delete | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteTransformRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to delete # string | ID of the transform to delete + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.TransformsAPI.DeleteTransform(context.Background(), id).Execute() + //r, err := apiClient.V2025.TransformsAPI.DeleteTransform(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.DeleteTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-transform +Transform by ID +This API returns the transform specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-transform) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the transform to retrieve | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTransformRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**TransformRead**](../models/transform-read) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to retrieve # string | ID of the transform to retrieve + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TransformsAPI.GetTransform(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.TransformsAPI.GetTransform(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.GetTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.GetTransform`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-transforms +List transforms +Gets a list of all saved transform objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-transforms) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTransformsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **name** | **string** | Name of the transform to retrieve from the list. | + **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: **internal**: *eq* **name**: *eq, sw* | + +### Return type + +[**[]TransformRead**](../models/transform-read) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + name := `ExampleTransformName123` // string | Name of the transform to retrieve from the list. (optional) # string | Name of the transform to retrieve from the list. (optional) + filters := `name eq "Uppercase"` // 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: **internal**: *eq* **name**: *eq, sw* (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: **internal**: *eq* **name**: *eq, sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TransformsAPI.ListTransforms(context.Background()).Execute() + //resp, r, err := apiClient.V2025.TransformsAPI.ListTransforms(context.Background()).Offset(offset).Limit(limit).Count(count).Name(name).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.ListTransforms``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTransforms`: []TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.ListTransforms`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-transform +Update a transform +Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-transform) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the transform to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateTransformRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **transform** | [**Transform**](../models/transform) | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. | + +### Return type + +[**TransformRead**](../models/transform-read) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to update # string | ID of the transform to update + transform := []byte(`{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }`) // Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TransformsAPI.UpdateTransform(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.TransformsAPI.UpdateTransform(context.Background(), id).Transform(transform).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.UpdateTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.UpdateTransform`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/TriggersAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/TriggersAPI.md new file mode 100644 index 000000000..69c297fe4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/TriggersAPI.md @@ -0,0 +1,981 @@ +--- +id: v2025-triggers +title: Triggers +pagination_label: Triggers +sidebar_label: Triggers +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Triggers', 'V2025Triggers'] +slug: /tools/sdk/go/v2025/methods/triggers +tags: ['SDK', 'Software Development Kit', 'Triggers', 'V2025Triggers'] +--- + +# TriggersAPI + Event Triggers provide real-time updates to changes in Identity Security Cloud so you can take action as soon as an event occurs, rather than poll an API endpoint for updates. Identity Security Cloud provides a user interface within the admin console to create and manage trigger subscriptions. These endpoints allow for programatically creating and managing trigger subscriptions. + +There are two types of event triggers: + * `FIRE_AND_FORGET`: This trigger type will send a payload to each subscriber without needing a response. Each trigger of this type has a limit of **50 subscriptions**. + * `REQUEST_RESPONSE`: This trigger type will send a payload to a subscriber and expect a response back. Each trigger of this type may only have **one subscription**. + +## Available Event Triggers +Production ready event triggers that are available in all tenants. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Access Request Dynamic Approval](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-dynamic-approval/) | idn:access-request-dynamic-approver | REQUEST_RESPONSE |After an access request is submitted. Expects the subscriber to respond with the ID of an identity or workgroup to add to the approval workflow. | +| [Access Request Decision](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-decision/) | idn:access-request-post-approval | FIRE_AND_FORGET | After an access request is approved. | +| [Access Request Submitted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-submitted/) | idn:access-request-pre-approval | REQUEST_RESPONSE | After an access request is submitted. Expects the subscriber to respond with an approval decision. | +| [Account Aggregation Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:account-aggregation-completed | FIRE_AND_FORGET | After an account aggregation completed, terminated, failed. | +| Account Attributes Changed | idn:account-attributes-changed | FIRE_AND_FORGET | After an account aggregation, and one or more account attributes have changed. | +| Account Correlated | idn:account-correlated | FIRE_AND_FORGET | After an account is added to an identity. | +| Accounts Collected for Aggregation | idn:aggregation-accounts-collected | FIRE_AND_FORGET | New, changed, and deleted accounts have been gathered during an aggregation and are being processed. | +| Account Uncorrelated | idn:account-uncorrelated | FIRE_AND_FORGET | After an account is removed from an identity. | +| Campaign Activated | idn:campaign-activated | FIRE_AND_FORGET | After a campaign is activated. | +| Campaign Ended | idn:campaign-ended | FIRE_AND_FORGET | After a campaign ends. | +| Campaign Generated | idn:campaign-generated | FIRE_AND_FORGET | After a campaign finishes generating. | +| Certification Signed Off | idn:certification-signed-off | FIRE_AND_FORGET | After a certification is signed off by its reviewer. | +| [Identity Attributes Changed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:identity-attributes-changed | FIRE_AND_FORGET | After One or more identity attributes changed. | +| [Identity Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-created/) | idn:identity-created | FIRE_AND_FORGET | After an identity is created. | +| [Provisioning Action Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) | idn:post-provisioning | FIRE_AND_FORGET | After a provisioning action completed on a source. | +| [Scheduled Search](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/scheduled-search/) | idn:saved-search-complete | FIRE_AND_FORGET | After a scheduled search completed. | +| [Source Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-created/) | idn:source-created | FIRE_AND_FORGET | After a source is created. | +| [Source Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-deleted/) | idn:source-deleted | FIRE_AND_FORGET | After a source is deleted. | +| [Source Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-updated/) | idn:source-updated | FIRE_AND_FORGET | After configuration changes have been made to a source. | +| [VA Cluster Status Change](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/va-cluster-status-change/) | idn:va-cluster-status-change | FIRE_AND_FORGET | After the status of a VA cluster has changed. | + +## Early Access Event Triggers +Triggers that are in-development and not ready for production use. Please contact support to enable these triggers in your tenant. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Identity Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-deleted/) | idn:identity-deleted | FIRE_AND_FORGET | After an identity is deleted. | +| [Source Account Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-created/) | idn:source-account-created | FIRE_AND_FORGET | After a source account is created. | +| [Source Account Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-deleted/) | idn:source-account-deleted | FIRE_AND_FORGET | After a source account is deleted. | +| [Source Account Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-updated/) | idn:source-account-updated | FIRE_AND_FORGET | After a source account is changed. | + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**complete-trigger-invocation**](#complete-trigger-invocation) | **Post** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation +[**create-subscription**](#create-subscription) | **Post** `/trigger-subscriptions` | Create a Subscription +[**delete-subscription**](#delete-subscription) | **Delete** `/trigger-subscriptions/{id}` | Delete a Subscription +[**list-subscriptions**](#list-subscriptions) | **Get** `/trigger-subscriptions` | List Subscriptions +[**list-trigger-invocation-status**](#list-trigger-invocation-status) | **Get** `/trigger-invocations/status` | List Latest Invocation Statuses +[**list-triggers**](#list-triggers) | **Get** `/triggers` | List Triggers +[**patch-subscription**](#patch-subscription) | **Patch** `/trigger-subscriptions/{id}` | Patch a Subscription +[**start-test-trigger-invocation**](#start-test-trigger-invocation) | **Post** `/trigger-invocations/test` | Start a Test Invocation +[**test-subscription-filter**](#test-subscription-filter) | **Post** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter +[**update-subscription**](#update-subscription) | **Put** `/trigger-subscriptions/{id}` | Update a Subscription + + +## complete-trigger-invocation +:::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 + ``` +::: +Complete Trigger Invocation +Completes an invocation to a REQUEST_RESPONSE type trigger. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/complete-trigger-invocation) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the invocation to complete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompleteTriggerInvocationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **completeInvocation** | [**CompleteInvocation**](../models/complete-invocation) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | The ID of the invocation to complete. # string | The ID of the invocation to complete. + 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") + completeinvocation := []byte(`{ + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + }`) // CompleteInvocation | + + + var completeInvocation v2025.CompleteInvocation + if err := json.Unmarshal(completeinvocation, &completeInvocation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.TriggersAPI.CompleteTriggerInvocation(context.Background(), id).XSailPointExperimental(xSailPointExperimental).CompleteInvocation(completeInvocation).Execute() + //r, err := apiClient.V2025.TriggersAPI.CompleteTriggerInvocation(context.Background(), id).XSailPointExperimental(xSailPointExperimental).CompleteInvocation(completeInvocation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.CompleteTriggerInvocation``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## create-subscription +:::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 a Subscription +This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: +* HTTP subscriptions require httpConfig +* EventBridge subscriptions require eventBridgeConfig + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-subscription) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSubscriptionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **subscriptionPostRequest** | [**SubscriptionPostRequest**](../models/subscription-post-request) | | + +### Return type + +[**Subscription**](../models/subscription) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + subscriptionpostrequest := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "triggerId" : "idn:access-requested", + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + }`) // SubscriptionPostRequest | + + + var subscriptionPostRequest v2025.SubscriptionPostRequest + if err := json.Unmarshal(subscriptionpostrequest, &subscriptionPostRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TriggersAPI.CreateSubscription(context.Background()).XSailPointExperimental(xSailPointExperimental).SubscriptionPostRequest(subscriptionPostRequest).Execute() + //resp, r, err := apiClient.V2025.TriggersAPI.CreateSubscription(context.Background()).XSailPointExperimental(xSailPointExperimental).SubscriptionPostRequest(subscriptionPostRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.CreateSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.CreateSubscription`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-subscription +:::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 a Subscription +Deletes an existing subscription to a trigger. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-subscription) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Subscription ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSubscriptionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | Subscription ID # string | Subscription 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.V2025.TriggersAPI.DeleteSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.TriggersAPI.DeleteSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.DeleteSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## list-subscriptions +:::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 Subscriptions +Gets a list of all trigger subscriptions. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-subscriptions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSubscriptionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **triggerId**: *eq* **type**: *eq, le* | + **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: **triggerId, triggerName** | + +### Return type + +[**[]Subscription**](../models/subscription) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"` // 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* **triggerId**: *eq* **type**: *eq, le* (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* **triggerId**: *eq* **type**: *eq, le* (optional) + sorters := `triggerName` // 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: **triggerId, triggerName** (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: **triggerId, triggerName** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TriggersAPI.ListSubscriptions(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.TriggersAPI.ListSubscriptions(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListSubscriptions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSubscriptions`: []Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListSubscriptions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-trigger-invocation-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 + ``` +::: +List Latest Invocation Statuses +Gets a list of latest invocation statuses. +Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. +This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-trigger-invocation-status) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTriggerInvocationStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **triggerId**: *eq* **subscriptionId**: *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: **triggerId, subscriptionName, created, completed** | + +### Return type + +[**[]InvocationStatus**](../models/invocation-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `triggerId eq "idn:access-request-dynamic-approver"` // 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: **triggerId**: *eq* **subscriptionId**: *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: **triggerId**: *eq* **subscriptionId**: *eq* (optional) + sorters := `created` // 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: **triggerId, subscriptionName, created, completed** (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: **triggerId, subscriptionName, created, completed** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TriggersAPI.ListTriggerInvocationStatus(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.TriggersAPI.ListTriggerInvocationStatus(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListTriggerInvocationStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTriggerInvocationStatus`: []InvocationStatus + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListTriggerInvocationStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-triggers +:::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 Triggers +Gets a list of triggers that are available in the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-triggers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTriggersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ge, le* | + **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: **id, name** | + +### Return type + +[**[]Trigger**](../models/trigger) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "idn:access-request-post-approval"` // 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, ge, le* (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, ge, le* (optional) + sorters := `name` // 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: **id, name** (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: **id, name** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TriggersAPI.ListTriggers(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.TriggersAPI.ListTriggers(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListTriggers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTriggers`: []Trigger + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListTriggers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-subscription +:::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 + ``` +::: +Patch a Subscription +This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: + +**name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-subscription) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Subscription to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSubscriptionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **subscriptionPatchRequestInner** | [**[]SubscriptionPatchRequestInner**](../models/subscription-patch-request-inner) | | + +### Return type + +[**Subscription**](../models/subscription) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | ID of the Subscription to patch # string | ID of the Subscription to patch + 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") + subscriptionpatchrequestinner := []byte(``) // []SubscriptionPatchRequestInner | + + + var subscriptionPatchRequestInner v2025.[]SubscriptionPatchRequestInner + if err := json.Unmarshal(subscriptionpatchrequestinner, &subscriptionPatchRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TriggersAPI.PatchSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SubscriptionPatchRequestInner(subscriptionPatchRequestInner).Execute() + //resp, r, err := apiClient.V2025.TriggersAPI.PatchSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SubscriptionPatchRequestInner(subscriptionPatchRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.PatchSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.PatchSubscription`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-test-trigger-invocation +:::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 + ``` +::: +Start a Test Invocation +Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-test-trigger-invocation) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartTestTriggerInvocationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **testInvocation** | [**TestInvocation**](../models/test-invocation) | | + +### Return type + +[**[]Invocation**](../models/invocation) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + testinvocation := []byte(`{ + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } + }`) // TestInvocation | + + + var testInvocation v2025.TestInvocation + if err := json.Unmarshal(testinvocation, &testInvocation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TriggersAPI.StartTestTriggerInvocation(context.Background()).XSailPointExperimental(xSailPointExperimental).TestInvocation(testInvocation).Execute() + //resp, r, err := apiClient.V2025.TriggersAPI.StartTestTriggerInvocation(context.Background()).XSailPointExperimental(xSailPointExperimental).TestInvocation(testInvocation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.StartTestTriggerInvocation``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartTestTriggerInvocation`: []Invocation + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.StartTestTriggerInvocation`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-subscription-filter +:::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 + ``` +::: +Validate a Subscription Filter +Validates a JSONPath filter expression against a provided mock input. +Request requires a security scope of: + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/test-subscription-filter) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestSubscriptionFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **validateFilterInputDto** | [**ValidateFilterInputDto**](../models/validate-filter-input-dto) | | + +### Return type + +[**ValidateFilterOutputDto**](../models/validate-filter-output-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + validatefilterinputdto := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + }`) // ValidateFilterInputDto | + + + var validateFilterInputDto v2025.ValidateFilterInputDto + if err := json.Unmarshal(validatefilterinputdto, &validateFilterInputDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TriggersAPI.TestSubscriptionFilter(context.Background()).XSailPointExperimental(xSailPointExperimental).ValidateFilterInputDto(validateFilterInputDto).Execute() + //resp, r, err := apiClient.V2025.TriggersAPI.TestSubscriptionFilter(context.Background()).XSailPointExperimental(xSailPointExperimental).ValidateFilterInputDto(validateFilterInputDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.TestSubscriptionFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSubscriptionFilter`: ValidateFilterOutputDto + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.TestSubscriptionFilter`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-subscription +:::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 a Subscription +This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing + Subscription is completely replaced. The following fields are immutable: + + + * id + + * triggerId + + + Attempts to modify these fields result in 400. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-subscription) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Subscription ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSubscriptionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **subscriptionPutRequest** | [**SubscriptionPutRequest**](../models/subscription-put-request) | | + +### Return type + +[**Subscription**](../models/subscription) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | Subscription ID # string | Subscription 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") + subscriptionputrequest := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + }`) // SubscriptionPutRequest | + + + var subscriptionPutRequest v2025.SubscriptionPutRequest + if err := json.Unmarshal(subscriptionputrequest, &subscriptionPutRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TriggersAPI.UpdateSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SubscriptionPutRequest(subscriptionPutRequest).Execute() + //resp, r, err := apiClient.V2025.TriggersAPI.UpdateSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SubscriptionPutRequest(subscriptionPutRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.UpdateSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.UpdateSubscription`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/UIMetadataAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/UIMetadataAPI.md new file mode 100644 index 000000000..c19e55c9b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/UIMetadataAPI.md @@ -0,0 +1,180 @@ +--- +id: v2025-ui-metadata +title: UIMetadata +pagination_label: UIMetadata +sidebar_label: UIMetadata +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UIMetadata', 'V2025UIMetadata'] +slug: /tools/sdk/go/v2025/methods/ui-metadata +tags: ['SDK', 'Software Development Kit', 'UIMetadata', 'V2025UIMetadata'] +--- + +# UIMetadataAPI + API for managing UI Metadata. Use this API to manage metadata about your User Interface. +For example you can set the iFrameWhitelist parameter to permit another domain to encapsulate IDN within an iframe or set the usernameEmptyText to change the placeholder text for Username on your tenant's login screen. +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-tenant-ui-metadata**](#get-tenant-ui-metadata) | **Get** `/ui-metadata/tenant` | Get a tenant UI metadata +[**set-tenant-ui-metadata**](#set-tenant-ui-metadata) | **Put** `/ui-metadata/tenant` | Update tenant UI metadata + + +## get-tenant-ui-metadata +:::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 a tenant UI metadata +This API endpoint retrieves UI metadata configured for your tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-tenant-ui-metadata) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTenantUiMetadataRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.UIMetadataAPI.GetTenantUiMetadata(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.UIMetadataAPI.GetTenantUiMetadata(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `UIMetadataAPI.GetTenantUiMetadata``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenantUiMetadata`: TenantUiMetadataItemResponse + fmt.Fprintf(os.Stdout, "Response from `UIMetadataAPI.GetTenantUiMetadata`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-tenant-ui-metadata +:::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 tenant UI metadata +This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-tenant-ui-metadata) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetTenantUiMetadataRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **tenantUiMetadataItemUpdateRequest** | [**TenantUiMetadataItemUpdateRequest**](../models/tenant-ui-metadata-item-update-request) | | + +### Return type + +[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + tenantuimetadataitemupdaterequest := []byte(`{ + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" + }`) // TenantUiMetadataItemUpdateRequest | + + + var tenantUiMetadataItemUpdateRequest v2025.TenantUiMetadataItemUpdateRequest + if err := json.Unmarshal(tenantuimetadataitemupdaterequest, &tenantUiMetadataItemUpdateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.UIMetadataAPI.SetTenantUiMetadata(context.Background()).XSailPointExperimental(xSailPointExperimental).TenantUiMetadataItemUpdateRequest(tenantUiMetadataItemUpdateRequest).Execute() + //resp, r, err := apiClient.V2025.UIMetadataAPI.SetTenantUiMetadata(context.Background()).XSailPointExperimental(xSailPointExperimental).TenantUiMetadataItemUpdateRequest(tenantUiMetadataItemUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `UIMetadataAPI.SetTenantUiMetadata``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetTenantUiMetadata`: TenantUiMetadataItemResponse + fmt.Fprintf(os.Stdout, "Response from `UIMetadataAPI.SetTenantUiMetadata`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/VendorConnectorMappingsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/VendorConnectorMappingsAPI.md new file mode 100644 index 000000000..793ecf548 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/VendorConnectorMappingsAPI.md @@ -0,0 +1,266 @@ +--- +id: v2025-vendor-connector-mappings +title: VendorConnectorMappings +pagination_label: VendorConnectorMappings +sidebar_label: VendorConnectorMappings +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappings', 'V2025VendorConnectorMappings'] +slug: /tools/sdk/go/v2025/methods/vendor-connector-mappings +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappings', 'V2025VendorConnectorMappings'] +--- + +# VendorConnectorMappingsAPI + Vendors use ISC connectors to connect their source data to ISC, but the data in their source and the data in ISC may be stored in different formats. +Connector mappings allow vendors to match their data on both sides of the connection. +The vendors can then track and manage access across their sources from ISC. +This API allows you to create and manage these vendor connector mappings. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **Post** `/vendor-connector-mappings` | Create Vendor Connector Mapping +[**delete-vendor-connector-mapping**](#delete-vendor-connector-mapping) | **Delete** `/vendor-connector-mappings` | Delete Vendor Connector Mapping +[**get-vendor-connector-mappings**](#get-vendor-connector-mappings) | **Get** `/vendor-connector-mappings` | List Vendor Connector Mappings + + +## create-vendor-connector-mapping +Create Vendor Connector Mapping +Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-vendor-connector-mapping) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateVendorConnectorMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vendorConnectorMapping** | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | | + +### Return type + +[**VendorConnectorMapping**](../models/vendor-connector-mapping) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + vendorconnectormapping := []byte(`{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }`) // VendorConnectorMapping | + + + var vendorConnectorMapping v2025.VendorConnectorMapping + if err := json.Unmarshal(vendorconnectormapping, &vendorConnectorMapping); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.VendorConnectorMappingsAPI.CreateVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + //resp, r, err := apiClient.V2025.VendorConnectorMappingsAPI.CreateVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.CreateVendorConnectorMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateVendorConnectorMapping`: VendorConnectorMapping + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.CreateVendorConnectorMapping`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-vendor-connector-mapping +Delete Vendor Connector Mapping +Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-vendor-connector-mapping) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteVendorConnectorMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vendorConnectorMapping** | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | | + +### Return type + +[**DeleteVendorConnectorMapping200Response**](../models/delete-vendor-connector-mapping200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + vendorconnectormapping := []byte(`{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }`) // VendorConnectorMapping | + + + var vendorConnectorMapping v2025.VendorConnectorMapping + if err := json.Unmarshal(vendorconnectormapping, &vendorConnectorMapping); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.VendorConnectorMappingsAPI.DeleteVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + //resp, r, err := apiClient.V2025.VendorConnectorMappingsAPI.DeleteVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.DeleteVendorConnectorMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteVendorConnectorMapping`: DeleteVendorConnectorMapping200Response + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.DeleteVendorConnectorMapping`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-vendor-connector-mappings +List Vendor Connector Mappings +Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-vendor-connector-mappings) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetVendorConnectorMappingsRequest struct via the builder pattern + + +### Return type + +[**[]VendorConnectorMapping**](../models/vendor-connector-mapping) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.VendorConnectorMappingsAPI.GetVendorConnectorMappings(context.Background()).Execute() + //resp, r, err := apiClient.V2025.VendorConnectorMappingsAPI.GetVendorConnectorMappings(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.GetVendorConnectorMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetVendorConnectorMappings`: []VendorConnectorMapping + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.GetVendorConnectorMappings`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/WorkItemsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/WorkItemsAPI.md new file mode 100644 index 000000000..bf2ee38e1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/WorkItemsAPI.md @@ -0,0 +1,948 @@ +--- +id: v2025-work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItems', 'V2025WorkItems'] +slug: /tools/sdk/go/v2025/methods/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'V2025WorkItems'] +--- + +# WorkItemsAPI + Use this API to implement work item functionality. +With this functionality in place, users can manage their work items (tasks). + +Work items refer to the tasks users see in Identity Security Cloud's Task Manager. +They can see the pending work items they need to complete, as well as the work items they have already completed. +Task Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. +For example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. +Once the user completes the work item, the work item will be listed with his or her other completed work items. + +To complete work items, users can use their dashboards and select the 'My Tasks' widget. +The widget will list any work items they need to complete, and they can select the work item from the list to review its details. +When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. + +Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-approval-item**](#approve-approval-item) | **Post** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item +[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **Post** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items +[**complete-work-item**](#complete-work-item) | **Post** `/work-items/{id}` | Complete a Work Item +[**forward-work-item**](#forward-work-item) | **Post** `/work-items/{id}/forward` | Forward a Work Item +[**get-completed-work-items**](#get-completed-work-items) | **Get** `/work-items/completed` | Completed Work Items +[**get-count-completed-work-items**](#get-count-completed-work-items) | **Get** `/work-items/completed/count` | Count Completed Work Items +[**get-count-work-items**](#get-count-work-items) | **Get** `/work-items/count` | Count Work Items +[**get-work-item**](#get-work-item) | **Get** `/work-items/{id}` | Get a Work Item +[**get-work-items-summary**](#get-work-items-summary) | **Get** `/work-items/summary` | Work Items Summary +[**list-work-items**](#list-work-items) | **Get** `/work-items` | List Work Items +[**reject-approval-item**](#reject-approval-item) | **Post** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item +[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **Post** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items +[**submit-account-selection**](#submit-account-selection) | **Post** `/work-items/{id}/submit-account-selection` | Submit Account Selections + + +## approve-approval-item +Approve an Approval Item +This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/approve-approval-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | +**approvalItemId** | **string** | The ID of the approval item. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiApproveApprovalItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveApprovalItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## approve-approval-items-in-bulk +Bulk approve Approval Items +This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/approve-approval-items-in-bulk) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiApproveApprovalItemsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.ApproveApprovalItemsInBulk(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.ApproveApprovalItemsInBulk(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItemsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveApprovalItemsInBulk`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItemsInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## complete-work-item +Complete a Work Item +This API completes a work item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/complete-work-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompleteWorkItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | **string** | Body is the request payload to create form definition request | + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + body := `body_example` // string | Body is the request payload to create form definition request (optional) # string | Body is the request payload to create form definition request (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.CompleteWorkItem(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.CompleteWorkItem(context.Background(), id).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.CompleteWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompleteWorkItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.CompleteWorkItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## forward-work-item +:::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 + ``` +::: +Forward a Work Item +This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/forward-work-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiForwardWorkItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **workItemForward** | [**WorkItemForward**](../models/work-item-forward) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + 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") + workitemforward := []byte(`{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + }`) // WorkItemForward | + + + var workItemForward v2025.WorkItemForward + if err := json.Unmarshal(workitemforward, &workItemForward); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.WorkItemsAPI.ForwardWorkItem(context.Background(), id).XSailPointExperimental(xSailPointExperimental).WorkItemForward(workItemForward).Execute() + //r, err := apiClient.V2025.WorkItemsAPI.ForwardWorkItem(context.Background(), id).XSailPointExperimental(xSailPointExperimental).WorkItemForward(workItemForward).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ForwardWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-completed-work-items +Completed Work Items +This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-completed-work-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCompletedWorkItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.GetCompletedWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.GetCompletedWorkItems(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCompletedWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCompletedWorkItems`: []WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCompletedWorkItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-count-completed-work-items +:::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 + ``` +::: +Count Completed Work Items +This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-count-completed-work-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCountCompletedWorkItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **ownerId** | **string** | ID of the work item owner. | + +### Return type + +[**WorkItemsCount**](../models/work-items-count) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + ownerId := `ownerId_example` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.GetCountCompletedWorkItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.GetCountCompletedWorkItems(context.Background()).XSailPointExperimental(xSailPointExperimental).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCountCompletedWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCountCompletedWorkItems`: WorkItemsCount + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCountCompletedWorkItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-count-work-items +Count Work Items +This gets a count of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-count-work-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCountWorkItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | ID of the work item owner. | + +### Return type + +[**WorkItemsCount**](../models/work-items-count) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.GetCountWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.GetCountWorkItems(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCountWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCountWorkItems`: WorkItemsCount + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCountWorkItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-work-item +Get a Work Item +This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-work-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the work item. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the work item. # string | ID of the work item. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.GetWorkItem(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.GetWorkItem(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetWorkItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-work-items-summary +Work Items Summary +This gets a summary of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-work-items-summary) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkItemsSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | ID of the work item owner. | + +### Return type + +[**WorkItemsSummary**](../models/work-items-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.GetWorkItemsSummary(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.GetWorkItemsSummary(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetWorkItemsSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkItemsSummary`: WorkItemsSummary + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetWorkItemsSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-work-items +List Work Items +This gets a collection of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-work-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkItemsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **ownerId** | **string** | ID of the work item owner. | + +### Return type + +[**[]WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.ListWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.ListWorkItems(context.Background()).Limit(limit).Offset(offset).Count(count).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ListWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkItems`: []WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ListWorkItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reject-approval-item +Reject an Approval Item +This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/reject-approval-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | +**approvalItemId** | **string** | The ID of the approval item. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRejectApprovalItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.RejectApprovalItem(context.Background(), id, approvalItemId).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.RejectApprovalItem(context.Background(), id, approvalItemId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.RejectApprovalItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectApprovalItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.RejectApprovalItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reject-approval-items-in-bulk +Bulk reject Approval Items +This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/reject-approval-items-in-bulk) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRejectApprovalItemsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.RejectApprovalItemsInBulk(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.RejectApprovalItemsInBulk(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.RejectApprovalItemsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectApprovalItemsInBulk`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.RejectApprovalItemsInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-account-selection +Submit Account Selections +This API submits account selections. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/submit-account-selection) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitAccountSelectionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **requestBody** | **map[string]interface{}** | Account Selection Data map, keyed on fieldName | + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + requestBody := {fieldName=fieldValue} // map[string]interface{} | Account Selection Data map, keyed on fieldName # map[string]interface{} | Account Selection Data map, keyed on fieldName + + + var requestBody v2025.RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.SubmitAccountSelection(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.SubmitAccountSelection(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.SubmitAccountSelection``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitAccountSelection`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.SubmitAccountSelection`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/WorkReassignmentAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/WorkReassignmentAPI.md new file mode 100644 index 000000000..cc94efcb7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/WorkReassignmentAPI.md @@ -0,0 +1,765 @@ +--- +id: v2025-work-reassignment +title: WorkReassignment +pagination_label: WorkReassignment +sidebar_label: WorkReassignment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkReassignment', 'V2025WorkReassignment'] +slug: /tools/sdk/go/v2025/methods/work-reassignment +tags: ['SDK', 'Software Development Kit', 'WorkReassignment', 'V2025WorkReassignment'] +--- + +# WorkReassignmentAPI + Use this API to implement work reassignment functionality. + +Work Reassignment allows access request reviews, certifications, and manual provisioning tasks assigned to a user to be reassigned to a different user. This is primarily used for: + +- Temporarily redirecting work for users who are out of office, such as on vacation or sick leave +- Permanently redirecting work for users who should not be assigned these tasks at all, such as senior executives or service identities + +Users can define reassignments for themselves, managers can add them for their team members, and administrators can configure them on any user’s behalf. Work assigned during the specified reassignment timeframes will be automatically reassigned to the designated user as it is created. + +Refer to [Work Reassignment](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html) for more information about this topic. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-reassignment-configuration**](#create-reassignment-configuration) | **Post** `/reassignment-configurations` | Create a Reassignment Configuration +[**delete-reassignment-configuration**](#delete-reassignment-configuration) | **Delete** `/reassignment-configurations/{identityId}/{configType}` | Delete Reassignment Configuration +[**get-evaluate-reassignment-configuration**](#get-evaluate-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate Reassignment Configuration +[**get-reassignment-config-types**](#get-reassignment-config-types) | **Get** `/reassignment-configurations/types` | List Reassignment Config Types +[**get-reassignment-configuration**](#get-reassignment-configuration) | **Get** `/reassignment-configurations/{identityId}` | Get Reassignment Configuration +[**get-tenant-config-configuration**](#get-tenant-config-configuration) | **Get** `/reassignment-configurations/tenant-config` | Get Tenant-wide Reassignment Configuration settings +[**list-reassignment-configurations**](#list-reassignment-configurations) | **Get** `/reassignment-configurations` | List Reassignment Configurations +[**put-reassignment-config**](#put-reassignment-config) | **Put** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration +[**put-tenant-configuration**](#put-tenant-configuration) | **Put** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings + + +## create-reassignment-configuration +:::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 a Reassignment Configuration +Creates a new Reassignment Configuration for the specified identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-reassignment-configuration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateReassignmentConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **configurationItemRequest** | [**ConfigurationItemRequest**](../models/configuration-item-request) | | + +### Return type + +[**ConfigurationItemResponse**](../models/configuration-item-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + configurationitemrequest := []byte(`{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }`) // ConfigurationItemRequest | + + + var configurationItemRequest v2025.ConfigurationItemRequest + if err := json.Unmarshal(configurationitemrequest, &configurationItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkReassignmentAPI.CreateReassignmentConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).ConfigurationItemRequest(configurationItemRequest).Execute() + //resp, r, err := apiClient.V2025.WorkReassignmentAPI.CreateReassignmentConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).ConfigurationItemRequest(configurationItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.CreateReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateReassignmentConfiguration`: ConfigurationItemResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.CreateReassignmentConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-reassignment-configuration +:::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 Reassignment Configuration +Deletes a single reassignment configuration for the specified identity + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-reassignment-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | unique identity id | +**configType** | [**ConfigTypeEnum**](../models/) | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteReassignmentConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique identity id + configType := // ConfigTypeEnum | # ConfigTypeEnum | + 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.V2025.WorkReassignmentAPI.DeleteReassignmentConfiguration(context.Background(), identityId, configType).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.WorkReassignmentAPI.DeleteReassignmentConfiguration(context.Background(), identityId, configType).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.DeleteReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-evaluate-reassignment-configuration +:::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 + ``` +::: +Evaluate Reassignment Configuration +Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-evaluate-reassignment-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | unique identity id | +**configType** | [**ConfigTypeEnum**](../models/) | Reassignment work type | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEvaluateReassignmentConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **exclusionFilters** | **[]string** | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments | + +### Return type + +[**[]EvaluateResponse**](../models/evaluate-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique identity id + configType := accessRequests // ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type + 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") + exclusionfilters := []byte(`SELF_REVIEW_DELEGATION`) // []string | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkReassignmentAPI.GetEvaluateReassignmentConfiguration(context.Background(), identityId, configType).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.WorkReassignmentAPI.GetEvaluateReassignmentConfiguration(context.Background(), identityId, configType).XSailPointExperimental(xSailPointExperimental).ExclusionFilters(exclusionFilters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetEvaluateReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEvaluateReassignmentConfiguration`: []EvaluateResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetEvaluateReassignmentConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-reassignment-config-types +:::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 Reassignment Config Types +Gets a collection of types which are available in the Reassignment Configuration UI. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-reassignment-config-types) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetReassignmentConfigTypesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**[]ConfigType**](../models/config-type) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkReassignmentAPI.GetReassignmentConfigTypes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.WorkReassignmentAPI.GetReassignmentConfigTypes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetReassignmentConfigTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReassignmentConfigTypes`: []ConfigType + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetReassignmentConfigTypes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-reassignment-configuration +:::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 Reassignment Configuration +Gets the Reassignment Configuration for an identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-reassignment-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | unique identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetReassignmentConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**ConfigurationResponse**](../models/configuration-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `2c91808781a71ddb0181b9090b5c504f` // string | unique identity id # string | unique 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.WorkReassignmentAPI.GetReassignmentConfiguration(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.WorkReassignmentAPI.GetReassignmentConfiguration(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReassignmentConfiguration`: ConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetReassignmentConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-tenant-config-configuration +:::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 Tenant-wide Reassignment Configuration settings +Gets the global Reassignment Configuration settings for the requestor's tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-tenant-config-configuration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTenantConfigConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**TenantConfigurationResponse**](../models/tenant-configuration-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkReassignmentAPI.GetTenantConfigConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.WorkReassignmentAPI.GetTenantConfigConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetTenantConfigConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenantConfigConfiguration`: TenantConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetTenantConfigConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-reassignment-configurations +:::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 Reassignment Configurations +Gets all Reassignment configuration for the current org. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-reassignment-configurations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListReassignmentConfigurationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + +### Return type + +[**[]ConfigurationResponse**](../models/configuration-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkReassignmentAPI.ListReassignmentConfigurations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.WorkReassignmentAPI.ListReassignmentConfigurations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.ListReassignmentConfigurations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListReassignmentConfigurations`: []ConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.ListReassignmentConfigurations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-reassignment-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 Reassignment Configuration +Replaces existing Reassignment configuration for an identity with the newly provided configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-reassignment-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | unique identity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutReassignmentConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **configurationItemRequest** | [**ConfigurationItemRequest**](../models/configuration-item-request) | | + +### Return type + +[**ConfigurationItemResponse**](../models/configuration-item-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique 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") + configurationitemrequest := []byte(`{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }`) // ConfigurationItemRequest | + + + var configurationItemRequest v2025.ConfigurationItemRequest + if err := json.Unmarshal(configurationitemrequest, &configurationItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkReassignmentAPI.PutReassignmentConfig(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).ConfigurationItemRequest(configurationItemRequest).Execute() + //resp, r, err := apiClient.V2025.WorkReassignmentAPI.PutReassignmentConfig(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).ConfigurationItemRequest(configurationItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.PutReassignmentConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutReassignmentConfig`: ConfigurationItemResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.PutReassignmentConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-tenant-configuration +:::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 Tenant-wide Reassignment Configuration settings +Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-tenant-configuration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutTenantConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to "true"] + **tenantConfigurationRequest** | [**TenantConfigurationRequest**](../models/tenant-configuration-request) | | + +### Return type + +[**TenantConfigurationResponse**](../models/tenant-configuration-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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") + tenantconfigurationrequest := []byte(`{ + "configDetails" : { + "disabled" : true + } + }`) // TenantConfigurationRequest | + + + var tenantConfigurationRequest v2025.TenantConfigurationRequest + if err := json.Unmarshal(tenantconfigurationrequest, &tenantConfigurationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkReassignmentAPI.PutTenantConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).TenantConfigurationRequest(tenantConfigurationRequest).Execute() + //resp, r, err := apiClient.V2025.WorkReassignmentAPI.PutTenantConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).TenantConfigurationRequest(tenantConfigurationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.PutTenantConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutTenantConfiguration`: TenantConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.PutTenantConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/WorkflowsAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/WorkflowsAPI.md new file mode 100644 index 000000000..743f91904 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Methods/WorkflowsAPI.md @@ -0,0 +1,1294 @@ +--- +id: v2025-workflows +title: Workflows +pagination_label: Workflows +sidebar_label: Workflows +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Workflows', 'V2025Workflows'] +slug: /tools/sdk/go/v2025/methods/workflows +tags: ['SDK', 'Software Development Kit', 'Workflows', 'V2025Workflows'] +--- + +# WorkflowsAPI + Workflows allow administrators to create custom automation scripts directly within Identity Security Cloud. These automation scripts respond to [event triggers](https://developer.sailpoint.com/docs/extensibility/event-triggers/#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the Identity Security Cloud UI. Workflows can be configured via a graphical user interface within Identity Security Cloud, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-workflow-execution**](#cancel-workflow-execution) | **Post** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID +[**create-external-execute-workflow**](#create-external-execute-workflow) | **Post** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger +[**create-workflow**](#create-workflow) | **Post** `/workflows` | Create Workflow +[**create-workflow-external-trigger**](#create-workflow-external-trigger) | **Post** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client +[**delete-workflow**](#delete-workflow) | **Delete** `/workflows/{id}` | Delete Workflow By Id +[**get-workflow**](#get-workflow) | **Get** `/workflows/{id}` | Get Workflow By Id +[**get-workflow-execution**](#get-workflow-execution) | **Get** `/workflow-executions/{id}` | Get Workflow Execution +[**get-workflow-execution-history**](#get-workflow-execution-history) | **Get** `/workflow-executions/{id}/history` | Get Workflow Execution History +[**get-workflow-executions**](#get-workflow-executions) | **Get** `/workflows/{id}/executions` | List Workflow Executions +[**list-complete-workflow-library**](#list-complete-workflow-library) | **Get** `/workflow-library` | List Complete Workflow Library +[**list-workflow-library-actions**](#list-workflow-library-actions) | **Get** `/workflow-library/actions` | List Workflow Library Actions +[**list-workflow-library-operators**](#list-workflow-library-operators) | **Get** `/workflow-library/operators` | List Workflow Library Operators +[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **Get** `/workflow-library/triggers` | List Workflow Library Triggers +[**list-workflows**](#list-workflows) | **Get** `/workflows` | List Workflows +[**patch-workflow**](#patch-workflow) | **Patch** `/workflows/{id}` | Patch Workflow +[**put-workflow**](#put-workflow) | **Put** `/workflows/{id}` | Update Workflow +[**test-external-execute-workflow**](#test-external-execute-workflow) | **Post** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger +[**test-workflow**](#test-workflow) | **Post** `/workflows/{id}/test` | Test Workflow By Id + + +## cancel-workflow-execution +Cancel Workflow Execution by ID +Use this API to cancel a running workflow execution. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/cancel-workflow-execution) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The workflow execution ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCancelWorkflowExecutionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | The workflow execution ID # string | The workflow execution ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.WorkflowsAPI.CancelWorkflowExecution(context.Background(), id).Execute() + //r, err := apiClient.V2025.WorkflowsAPI.CancelWorkflowExecution(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CancelWorkflowExecution``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## create-external-execute-workflow +Execute Workflow via External Trigger +This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-external-execute-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateExternalExecuteWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **createExternalExecuteWorkflowRequest** | [**CreateExternalExecuteWorkflowRequest**](../models/create-external-execute-workflow-request) | | + +### Return type + +[**CreateExternalExecuteWorkflow200Response**](../models/create-external-execute-workflow200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + createexternalexecuteworkflowrequest := []byte(``) // CreateExternalExecuteWorkflowRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.CreateExternalExecuteWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.CreateExternalExecuteWorkflow(context.Background(), id).CreateExternalExecuteWorkflowRequest(createExternalExecuteWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateExternalExecuteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateExternalExecuteWorkflow`: CreateExternalExecuteWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateExternalExecuteWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-workflow +Create Workflow +Create a new workflow with the desired trigger and steps specified in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-workflow) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createWorkflowRequest** | [**CreateWorkflowRequest**](../models/create-workflow-request) | | + +### Return type + +[**Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createworkflowrequest := []byte(`{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}`) // CreateWorkflowRequest | + + + var createWorkflowRequest v2025.CreateWorkflowRequest + if err := json.Unmarshal(createworkflowrequest, &createWorkflowRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.CreateWorkflow(context.Background()).CreateWorkflowRequest(createWorkflowRequest).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.CreateWorkflow(context.Background()).CreateWorkflowRequest(createWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-workflow-external-trigger +Generate External Trigger OAuth Client +Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-workflow-external-trigger) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateWorkflowExternalTriggerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**WorkflowOAuthClient**](../models/workflow-o-auth-client) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.CreateWorkflowExternalTrigger(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.CreateWorkflowExternalTrigger(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateWorkflowExternalTrigger``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkflowExternalTrigger`: WorkflowOAuthClient + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateWorkflowExternalTrigger`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-workflow +Delete Workflow By Id +Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the Workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.WorkflowsAPI.DeleteWorkflow(context.Background(), id).Execute() + //r, err := apiClient.V2025.WorkflowsAPI.DeleteWorkflow(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.DeleteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-workflow +Get Workflow By Id +Get a single workflow by id. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflow(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-workflow-execution +Get Workflow Execution +Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-workflow-execution) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Workflow execution ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkflowExecutionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Workflow execution ID. # string | Workflow execution ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflowExecution(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflowExecution(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecution``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecution`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecution`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-workflow-execution-history +Get Workflow Execution History +Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-workflow-execution-history) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow execution | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkflowExecutionHistoryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]WorkflowExecutionEvent**](../models/workflow-execution-event) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow execution # string | Id of the workflow execution + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflowExecutionHistory(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflowExecutionHistory(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutionHistory``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecutionHistory`: []WorkflowExecutionEvent + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutionHistory`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-workflow-executions +List Workflow Executions +Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: +1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. +2. Get your workflow ID from the response. +3. You can then do either of the following: + + - Filter to find relevant workflow executions. + For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq "Failed"` + + - Paginate through results with the `offset` parameter. + For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. + Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-workflow-executions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Workflow ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkflowExecutionsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* | + +### Return type + +[**[]WorkflowExecution**](../models/workflow-execution) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Workflow ID. # string | Workflow 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `status eq "Failed"` // 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: **start_time**: *eq, lt, le, gt, ge* **status**: *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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflowExecutions(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflowExecutions(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecutions`: []WorkflowExecution + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-complete-workflow-library +List Complete Workflow Library +This lists all triggers, actions, and operators in the library + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-complete-workflow-library) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCompleteWorkflowLibraryRequest struct via the builder pattern + + +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 + +[**[]ListCompleteWorkflowLibrary200ResponseInner**](../models/list-complete-workflow-library200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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.V2025.WorkflowsAPI.ListCompleteWorkflowLibrary(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.ListCompleteWorkflowLibrary(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListCompleteWorkflowLibrary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCompleteWorkflowLibrary`: []ListCompleteWorkflowLibrary200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListCompleteWorkflowLibrary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workflow-library-actions +List Workflow Library Actions +This lists the workflow actions available to you. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-workflow-library-actions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkflowLibraryActionsRequest struct via the builder pattern + + +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] + **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* | + +### Return type + +[**[]WorkflowLibraryAction**](../models/workflow-library-action) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + filters := `id eq "sp:create-campaign"` // 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* (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* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.ListWorkflowLibraryActions(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.ListWorkflowLibraryActions(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryActions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryActions`: []WorkflowLibraryAction + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryActions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workflow-library-operators +List Workflow Library Operators +This lists the workflow operators available to you + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-workflow-library-operators) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkflowLibraryOperatorsRequest struct via the builder pattern + + +### Return type + +[**[]WorkflowLibraryOperator**](../models/workflow-library-operator) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.ListWorkflowLibraryOperators(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.ListWorkflowLibraryOperators(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryOperators``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryOperators`: []WorkflowLibraryOperator + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryOperators`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workflow-library-triggers +List Workflow Library Triggers +This lists the workflow triggers available to you + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-workflow-library-triggers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkflowLibraryTriggersRequest struct via the builder pattern + + +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] + **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* | + +### Return type + +[**[]WorkflowLibraryTrigger**](../models/workflow-library-trigger) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + filters := `id eq "idn:identity-attributes-changed"` // 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* (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* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.ListWorkflowLibraryTriggers(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.ListWorkflowLibraryTriggers(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryTriggers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryTriggers`: []WorkflowLibraryTrigger + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryTriggers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workflows +List Workflows +List all workflows in the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-workflows) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkflowsRequest struct via the builder pattern + + +### Return type + +[**[]Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.ListWorkflows(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.ListWorkflows(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflows``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflows`: []Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflows`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-workflow +Patch Workflow +Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the Workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.PatchWorkflow(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.PatchWorkflow(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PatchWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PatchWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-workflow +Update Workflow +Perform a full update of a workflow. The updated workflow object is returned in the response. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the Workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **workflowBody** | [**WorkflowBody**](../models/workflow-body) | | + +### Return type + +[**Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + workflowbody := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : "{}", + "type" : "EVENT" + }, + "enabled" : false + }`) // WorkflowBody | + + + var workflowBody v2025.WorkflowBody + if err := json.Unmarshal(workflowbody, &workflowBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.PutWorkflow(context.Background(), id).WorkflowBody(workflowBody).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.PutWorkflow(context.Background(), id).WorkflowBody(workflowBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PutWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PutWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-external-execute-workflow +Test Workflow via External Trigger +Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/test-external-execute-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestExternalExecuteWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **testExternalExecuteWorkflowRequest** | [**TestExternalExecuteWorkflowRequest**](../models/test-external-execute-workflow-request) | | + +### Return type + +[**TestExternalExecuteWorkflow200Response**](../models/test-external-execute-workflow200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + testexternalexecuteworkflowrequest := []byte(``) // TestExternalExecuteWorkflowRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.TestExternalExecuteWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.TestExternalExecuteWorkflow(context.Background(), id).TestExternalExecuteWorkflowRequest(testExternalExecuteWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.TestExternalExecuteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestExternalExecuteWorkflow`: TestExternalExecuteWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.TestExternalExecuteWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-workflow +Test Workflow By Id +:::info + +Workflow must be disabled in order to use this endpoint. + +::: + +Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. + +This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. + +**This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/test-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **testWorkflowRequest** | [**TestWorkflowRequest**](../models/test-workflow-request) | | + +### Return type + +[**TestWorkflow200Response**](../models/test-workflow200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + testworkflowrequest := []byte(`{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}`) // TestWorkflowRequest | + + + var testWorkflowRequest v2025.TestWorkflowRequest + if err := json.Unmarshal(testworkflowrequest, &testWorkflowRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.TestWorkflow(context.Background(), id).TestWorkflowRequest(testWorkflowRequest).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.TestWorkflow(context.Background(), id).TestWorkflowRequest(testWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.TestWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestWorkflow`: TestWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.TestWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Access.md b/docs/tools/sdk/go/Reference/V2025/Models/Access.md new file mode 100644 index 000000000..39f4f1c24 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Access.md @@ -0,0 +1,152 @@ +--- +id: v2025-access +title: Access +pagination_label: Access +sidebar_label: Access +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Access', 'V2025Access'] +slug: /tools/sdk/go/v2025/models/access +tags: ['SDK', 'Software Development Kit', 'Access', 'V2025Access'] +--- + +# Access + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] + +## Methods + +### NewAccess + +`func NewAccess() *Access` + +NewAccess instantiates a new Access 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 + +### NewAccessWithDefaults + +`func NewAccessWithDefaults() *Access` + +NewAccessWithDefaults instantiates a new Access 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 + +### GetId + +`func (o *Access) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Access) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Access) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Access) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Access) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Access) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Access) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Access) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *Access) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *Access) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *Access) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *Access) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *Access) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Access) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Access) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Access) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Access) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Access) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessApps.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessApps.md new file mode 100644 index 000000000..caf1d037d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessApps.md @@ -0,0 +1,142 @@ +--- +id: v2025-access-apps +title: AccessApps +pagination_label: AccessApps +sidebar_label: AccessApps +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessApps', 'V2025AccessApps'] +slug: /tools/sdk/go/v2025/models/access-apps +tags: ['SDK', 'Software Development Kit', 'AccessApps', 'V2025AccessApps'] +--- + +# AccessApps + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | Name of application | [optional] +**Description** | Pointer to **string** | Description of application. | [optional] +**Owner** | Pointer to [**AccessAppsOwner**](access-apps-owner) | | [optional] + +## Methods + +### NewAccessApps + +`func NewAccessApps() *AccessApps` + +NewAccessApps instantiates a new AccessApps 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 + +### NewAccessAppsWithDefaults + +`func NewAccessAppsWithDefaults() *AccessApps` + +NewAccessAppsWithDefaults instantiates a new AccessApps 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 + +### GetId + +`func (o *AccessApps) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessApps) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessApps) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessApps) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessApps) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessApps) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessApps) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessApps) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessApps) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessApps) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessApps) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessApps) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *AccessApps) GetOwner() AccessAppsOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *AccessApps) GetOwnerOk() (*AccessAppsOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *AccessApps) SetOwner(v AccessAppsOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *AccessApps) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessAppsOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessAppsOwner.md new file mode 100644 index 000000000..b0b6200b9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessAppsOwner.md @@ -0,0 +1,142 @@ +--- +id: v2025-access-apps-owner +title: AccessAppsOwner +pagination_label: AccessAppsOwner +sidebar_label: AccessAppsOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessAppsOwner', 'V2025AccessAppsOwner'] +slug: /tools/sdk/go/v2025/models/access-apps-owner +tags: ['SDK', 'Software Development Kit', 'AccessAppsOwner', 'V2025AccessAppsOwner'] +--- + +# AccessAppsOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's DTO type. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's display name. | [optional] +**Email** | Pointer to **string** | Owner's email. | [optional] + +## Methods + +### NewAccessAppsOwner + +`func NewAccessAppsOwner() *AccessAppsOwner` + +NewAccessAppsOwner instantiates a new AccessAppsOwner 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 + +### NewAccessAppsOwnerWithDefaults + +`func NewAccessAppsOwnerWithDefaults() *AccessAppsOwner` + +NewAccessAppsOwnerWithDefaults instantiates a new AccessAppsOwner 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 + +### GetType + +`func (o *AccessAppsOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessAppsOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessAppsOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessAppsOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessAppsOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessAppsOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessAppsOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessAppsOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessAppsOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessAppsOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessAppsOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessAppsOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *AccessAppsOwner) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *AccessAppsOwner) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *AccessAppsOwner) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *AccessAppsOwner) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessConstraint.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessConstraint.md new file mode 100644 index 000000000..3be43dcca --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessConstraint.md @@ -0,0 +1,106 @@ +--- +id: v2025-access-constraint +title: AccessConstraint +pagination_label: AccessConstraint +sidebar_label: AccessConstraint +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessConstraint', 'V2025AccessConstraint'] +slug: /tools/sdk/go/v2025/models/access-constraint +tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'V2025AccessConstraint'] +--- + +# AccessConstraint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of Access | +**Ids** | Pointer to **[]string** | Must be set only if operator is SELECTED. | [optional] +**Operator** | **string** | Used to determine whether the scope of the campaign should be reduced for selected ids or all. | + +## Methods + +### NewAccessConstraint + +`func NewAccessConstraint(type_ string, operator string, ) *AccessConstraint` + +NewAccessConstraint instantiates a new AccessConstraint 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 + +### NewAccessConstraintWithDefaults + +`func NewAccessConstraintWithDefaults() *AccessConstraint` + +NewAccessConstraintWithDefaults instantiates a new AccessConstraint 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 + +### GetType + +`func (o *AccessConstraint) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessConstraint) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessConstraint) SetType(v string)` + +SetType sets Type field to given value. + + +### GetIds + +`func (o *AccessConstraint) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *AccessConstraint) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *AccessConstraint) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *AccessConstraint) HasIds() bool` + +HasIds returns a boolean if a field has been set. + +### GetOperator + +`func (o *AccessConstraint) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *AccessConstraint) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *AccessConstraint) SetOperator(v string)` + +SetOperator sets Operator field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessCriteria.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessCriteria.md new file mode 100644 index 000000000..a5c4b3983 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: v2025-access-criteria +title: AccessCriteria +pagination_label: AccessCriteria +sidebar_label: AccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessCriteria', 'V2025AccessCriteria'] +slug: /tools/sdk/go/v2025/models/access-criteria +tags: ['SDK', 'Software Development Kit', 'AccessCriteria', 'V2025AccessCriteria'] +--- + +# AccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Business name for the access construct list | [optional] +**CriteriaList** | Pointer to [**[]AccessCriteriaCriteriaListInner**](access-criteria-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional] + +## Methods + +### NewAccessCriteria + +`func NewAccessCriteria() *AccessCriteria` + +NewAccessCriteria instantiates a new AccessCriteria 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 + +### NewAccessCriteriaWithDefaults + +`func NewAccessCriteriaWithDefaults() *AccessCriteria` + +NewAccessCriteriaWithDefaults instantiates a new AccessCriteria 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 + +### GetName + +`func (o *AccessCriteria) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessCriteria) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessCriteria) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessCriteria) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCriteriaList + +`func (o *AccessCriteria) GetCriteriaList() []AccessCriteriaCriteriaListInner` + +GetCriteriaList returns the CriteriaList field if non-nil, zero value otherwise. + +### GetCriteriaListOk + +`func (o *AccessCriteria) GetCriteriaListOk() (*[]AccessCriteriaCriteriaListInner, bool)` + +GetCriteriaListOk returns a tuple with the CriteriaList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteriaList + +`func (o *AccessCriteria) SetCriteriaList(v []AccessCriteriaCriteriaListInner)` + +SetCriteriaList sets CriteriaList field to given value. + +### HasCriteriaList + +`func (o *AccessCriteria) HasCriteriaList() bool` + +HasCriteriaList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessCriteriaCriteriaListInner.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessCriteriaCriteriaListInner.md new file mode 100644 index 000000000..25572c8d1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessCriteriaCriteriaListInner.md @@ -0,0 +1,116 @@ +--- +id: v2025-access-criteria-criteria-list-inner +title: AccessCriteriaCriteriaListInner +pagination_label: AccessCriteriaCriteriaListInner +sidebar_label: AccessCriteriaCriteriaListInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessCriteriaCriteriaListInner', 'V2025AccessCriteriaCriteriaListInner'] +slug: /tools/sdk/go/v2025/models/access-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'V2025AccessCriteriaCriteriaListInner'] +--- + +# AccessCriteriaCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the propery to which this reference applies to | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies to | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies to | [optional] + +## Methods + +### NewAccessCriteriaCriteriaListInner + +`func NewAccessCriteriaCriteriaListInner() *AccessCriteriaCriteriaListInner` + +NewAccessCriteriaCriteriaListInner instantiates a new AccessCriteriaCriteriaListInner 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 + +### NewAccessCriteriaCriteriaListInnerWithDefaults + +`func NewAccessCriteriaCriteriaListInnerWithDefaults() *AccessCriteriaCriteriaListInner` + +NewAccessCriteriaCriteriaListInnerWithDefaults instantiates a new AccessCriteriaCriteriaListInner 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 + +### GetType + +`func (o *AccessCriteriaCriteriaListInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessCriteriaCriteriaListInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessCriteriaCriteriaListInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessCriteriaCriteriaListInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessCriteriaCriteriaListInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessCriteriaCriteriaListInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessCriteriaCriteriaListInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessCriteriaCriteriaListInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessCriteriaCriteriaListInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessCriteriaCriteriaListInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessCriteriaCriteriaListInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessCriteriaCriteriaListInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessItemAccessProfileResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemAccessProfileResponse.md new file mode 100644 index 000000000..14b52828a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemAccessProfileResponse.md @@ -0,0 +1,340 @@ +--- +id: v2025-access-item-access-profile-response +title: AccessItemAccessProfileResponse +pagination_label: AccessItemAccessProfileResponse +sidebar_label: AccessItemAccessProfileResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemAccessProfileResponse', 'V2025AccessItemAccessProfileResponse'] +slug: /tools/sdk/go/v2025/models/access-item-access-profile-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'V2025AccessItemAccessProfileResponse'] +--- + +# AccessItemAccessProfileResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. accessProfile in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**Name** | Pointer to **string** | the access profile name | [optional] +**SourceName** | Pointer to **string** | the name of the source | [optional] +**SourceId** | Pointer to **string** | the id of the source | [optional] +**Description** | Pointer to **string** | the description for the access profile | [optional] +**DisplayName** | Pointer to **string** | the display name of the identity | [optional] +**EntitlementCount** | Pointer to **string** | the number of entitlements the access profile will create | [optional] +**AppDisplayName** | Pointer to **string** | the name of | [optional] +**RemoveDate** | Pointer to **string** | the date the access profile is no longer assigned to the specified identity | [optional] +**Standalone** | **bool** | indicates whether the access profile is standalone | +**Revocable** | **bool** | indicates whether the access profile is | + +## Methods + +### NewAccessItemAccessProfileResponse + +`func NewAccessItemAccessProfileResponse(standalone bool, revocable bool, ) *AccessItemAccessProfileResponse` + +NewAccessItemAccessProfileResponse instantiates a new AccessItemAccessProfileResponse 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 + +### NewAccessItemAccessProfileResponseWithDefaults + +`func NewAccessItemAccessProfileResponseWithDefaults() *AccessItemAccessProfileResponse` + +NewAccessItemAccessProfileResponseWithDefaults instantiates a new AccessItemAccessProfileResponse 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 + +### GetAccessType + +`func (o *AccessItemAccessProfileResponse) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemAccessProfileResponse) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemAccessProfileResponse) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemAccessProfileResponse) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemAccessProfileResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemAccessProfileResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemAccessProfileResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemAccessProfileResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemAccessProfileResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemAccessProfileResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemAccessProfileResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemAccessProfileResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemAccessProfileResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemAccessProfileResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemAccessProfileResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemAccessProfileResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessItemAccessProfileResponse) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessItemAccessProfileResponse) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessItemAccessProfileResponse) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessItemAccessProfileResponse) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessItemAccessProfileResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessItemAccessProfileResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessItemAccessProfileResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessItemAccessProfileResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemAccessProfileResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemAccessProfileResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemAccessProfileResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemAccessProfileResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccessItemAccessProfileResponse) GetEntitlementCount() string` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccessItemAccessProfileResponse) GetEntitlementCountOk() (*string, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccessItemAccessProfileResponse) SetEntitlementCount(v string)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccessItemAccessProfileResponse) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetAppDisplayName + +`func (o *AccessItemAccessProfileResponse) GetAppDisplayName() string` + +GetAppDisplayName returns the AppDisplayName field if non-nil, zero value otherwise. + +### GetAppDisplayNameOk + +`func (o *AccessItemAccessProfileResponse) GetAppDisplayNameOk() (*string, bool)` + +GetAppDisplayNameOk returns a tuple with the AppDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppDisplayName + +`func (o *AccessItemAccessProfileResponse) SetAppDisplayName(v string)` + +SetAppDisplayName sets AppDisplayName field to given value. + +### HasAppDisplayName + +`func (o *AccessItemAccessProfileResponse) HasAppDisplayName() bool` + +HasAppDisplayName returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *AccessItemAccessProfileResponse) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccessItemAccessProfileResponse) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccessItemAccessProfileResponse) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccessItemAccessProfileResponse) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetStandalone + +`func (o *AccessItemAccessProfileResponse) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *AccessItemAccessProfileResponse) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *AccessItemAccessProfileResponse) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + + +### GetRevocable + +`func (o *AccessItemAccessProfileResponse) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *AccessItemAccessProfileResponse) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *AccessItemAccessProfileResponse) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessItemAccountResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemAccountResponse.md new file mode 100644 index 000000000..ec18a0dce --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemAccountResponse.md @@ -0,0 +1,220 @@ +--- +id: v2025-access-item-account-response +title: AccessItemAccountResponse +pagination_label: AccessItemAccountResponse +sidebar_label: AccessItemAccountResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemAccountResponse', 'V2025AccessItemAccountResponse'] +slug: /tools/sdk/go/v2025/models/access-item-account-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAccountResponse', 'V2025AccessItemAccountResponse'] +--- + +# AccessItemAccountResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. account in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**NativeIdentity** | Pointer to **string** | the native identifier used to uniquely identify an acccount | [optional] +**SourceName** | Pointer to **string** | the name of the source | [optional] +**SourceId** | Pointer to **string** | the id of the source | [optional] +**EntitlementCount** | Pointer to **string** | the number of entitlements the account will create | [optional] +**DisplayName** | Pointer to **string** | the display name of the identity | [optional] + +## Methods + +### NewAccessItemAccountResponse + +`func NewAccessItemAccountResponse() *AccessItemAccountResponse` + +NewAccessItemAccountResponse instantiates a new AccessItemAccountResponse 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 + +### NewAccessItemAccountResponseWithDefaults + +`func NewAccessItemAccountResponseWithDefaults() *AccessItemAccountResponse` + +NewAccessItemAccountResponseWithDefaults instantiates a new AccessItemAccountResponse 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 + +### GetAccessType + +`func (o *AccessItemAccountResponse) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemAccountResponse) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemAccountResponse) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemAccountResponse) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemAccountResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemAccountResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemAccountResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemAccountResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *AccessItemAccountResponse) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccessItemAccountResponse) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccessItemAccountResponse) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccessItemAccountResponse) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemAccountResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemAccountResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemAccountResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemAccountResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessItemAccountResponse) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessItemAccountResponse) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessItemAccountResponse) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessItemAccountResponse) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccessItemAccountResponse) GetEntitlementCount() string` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccessItemAccountResponse) GetEntitlementCountOk() (*string, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccessItemAccountResponse) SetEntitlementCount(v string)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccessItemAccountResponse) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemAccountResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemAccountResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemAccountResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemAccountResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessItemAppResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemAppResponse.md new file mode 100644 index 000000000..f63c4c1c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemAppResponse.md @@ -0,0 +1,168 @@ +--- +id: v2025-access-item-app-response +title: AccessItemAppResponse +pagination_label: AccessItemAppResponse +sidebar_label: AccessItemAppResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemAppResponse', 'V2025AccessItemAppResponse'] +slug: /tools/sdk/go/v2025/models/access-item-app-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAppResponse', 'V2025AccessItemAppResponse'] +--- + +# AccessItemAppResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. entitlement in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**DisplayName** | Pointer to **string** | the access item display name | [optional] +**SourceName** | Pointer to **string** | the associated source name if it exists | [optional] +**AppRoleId** | Pointer to **string** | the app role id | [optional] + +## Methods + +### NewAccessItemAppResponse + +`func NewAccessItemAppResponse() *AccessItemAppResponse` + +NewAccessItemAppResponse instantiates a new AccessItemAppResponse 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 + +### NewAccessItemAppResponseWithDefaults + +`func NewAccessItemAppResponseWithDefaults() *AccessItemAppResponse` + +NewAccessItemAppResponseWithDefaults instantiates a new AccessItemAppResponse 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 + +### GetAccessType + +`func (o *AccessItemAppResponse) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemAppResponse) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemAppResponse) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemAppResponse) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemAppResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemAppResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemAppResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemAppResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemAppResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemAppResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemAppResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemAppResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemAppResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemAppResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemAppResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemAppResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetAppRoleId + +`func (o *AccessItemAppResponse) GetAppRoleId() string` + +GetAppRoleId returns the AppRoleId field if non-nil, zero value otherwise. + +### GetAppRoleIdOk + +`func (o *AccessItemAppResponse) GetAppRoleIdOk() (*string, bool)` + +GetAppRoleIdOk returns a tuple with the AppRoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppRoleId + +`func (o *AccessItemAppResponse) SetAppRoleId(v string)` + +SetAppRoleId sets AppRoleId field to given value. + +### HasAppRoleId + +`func (o *AccessItemAppResponse) HasAppRoleId() bool` + +HasAppRoleId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessItemApproverDto.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemApproverDto.md new file mode 100644 index 000000000..891dec3be --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemApproverDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-access-item-approver-dto +title: AccessItemApproverDto +pagination_label: AccessItemApproverDto +sidebar_label: AccessItemApproverDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemApproverDto', 'V2025AccessItemApproverDto'] +slug: /tools/sdk/go/v2025/models/access-item-approver-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemApproverDto', 'V2025AccessItemApproverDto'] +--- + +# AccessItemApproverDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity who approved the access item request. | [optional] +**Id** | Pointer to **string** | ID of identity who approved the access item request. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity who approved the access item request. | [optional] + +## Methods + +### NewAccessItemApproverDto + +`func NewAccessItemApproverDto() *AccessItemApproverDto` + +NewAccessItemApproverDto instantiates a new AccessItemApproverDto 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 + +### NewAccessItemApproverDtoWithDefaults + +`func NewAccessItemApproverDtoWithDefaults() *AccessItemApproverDto` + +NewAccessItemApproverDtoWithDefaults instantiates a new AccessItemApproverDto 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 + +### GetType + +`func (o *AccessItemApproverDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemApproverDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemApproverDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemApproverDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemApproverDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemApproverDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemApproverDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemApproverDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemApproverDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemApproverDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemApproverDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemApproverDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessItemAssociated.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemAssociated.md new file mode 100644 index 000000000..f97e0daad --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemAssociated.md @@ -0,0 +1,168 @@ +--- +id: v2025-access-item-associated +title: AccessItemAssociated +pagination_label: AccessItemAssociated +sidebar_label: AccessItemAssociated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemAssociated', 'V2025AccessItemAssociated'] +slug: /tools/sdk/go/v2025/models/access-item-associated +tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'V2025AccessItemAssociated'] +--- + +# AccessItemAssociated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] +**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] + +## Methods + +### NewAccessItemAssociated + +`func NewAccessItemAssociated() *AccessItemAssociated` + +NewAccessItemAssociated instantiates a new AccessItemAssociated 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 + +### NewAccessItemAssociatedWithDefaults + +`func NewAccessItemAssociatedWithDefaults() *AccessItemAssociated` + +NewAccessItemAssociatedWithDefaults instantiates a new AccessItemAssociated 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 + +### GetAccessItem + +`func (o *AccessItemAssociated) GetAccessItem() AccessItemAssociatedAccessItem` + +GetAccessItem returns the AccessItem field if non-nil, zero value otherwise. + +### GetAccessItemOk + +`func (o *AccessItemAssociated) GetAccessItemOk() (*AccessItemAssociatedAccessItem, bool)` + +GetAccessItemOk returns a tuple with the AccessItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItem + +`func (o *AccessItemAssociated) SetAccessItem(v AccessItemAssociatedAccessItem)` + +SetAccessItem sets AccessItem field to given value. + +### HasAccessItem + +`func (o *AccessItemAssociated) HasAccessItem() bool` + +HasAccessItem returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *AccessItemAssociated) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessItemAssociated) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessItemAssociated) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccessItemAssociated) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEventType + +`func (o *AccessItemAssociated) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AccessItemAssociated) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AccessItemAssociated) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AccessItemAssociated) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDt + +`func (o *AccessItemAssociated) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *AccessItemAssociated) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *AccessItemAssociated) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *AccessItemAssociated) HasDt() bool` + +HasDt returns a boolean if a field has been set. + +### GetGovernanceEvent + +`func (o *AccessItemAssociated) GetGovernanceEvent() CorrelatedGovernanceEvent` + +GetGovernanceEvent returns the GovernanceEvent field if non-nil, zero value otherwise. + +### GetGovernanceEventOk + +`func (o *AccessItemAssociated) GetGovernanceEventOk() (*CorrelatedGovernanceEvent, bool)` + +GetGovernanceEventOk returns a tuple with the GovernanceEvent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceEvent + +`func (o *AccessItemAssociated) SetGovernanceEvent(v CorrelatedGovernanceEvent)` + +SetGovernanceEvent sets GovernanceEvent field to given value. + +### HasGovernanceEvent + +`func (o *AccessItemAssociated) HasGovernanceEvent() bool` + +HasGovernanceEvent returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessItemAssociatedAccessItem.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemAssociatedAccessItem.md new file mode 100644 index 000000000..d8cb268c2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemAssociatedAccessItem.md @@ -0,0 +1,512 @@ +--- +id: v2025-access-item-associated-access-item +title: AccessItemAssociatedAccessItem +pagination_label: AccessItemAssociatedAccessItem +sidebar_label: AccessItemAssociatedAccessItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemAssociatedAccessItem', 'V2025AccessItemAssociatedAccessItem'] +slug: /tools/sdk/go/v2025/models/access-item-associated-access-item +tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'V2025AccessItemAssociatedAccessItem'] +--- + +# AccessItemAssociatedAccessItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. role in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**Name** | Pointer to **string** | the access profile name | [optional] +**SourceName** | Pointer to **string** | the associated source name if it exists | [optional] +**SourceId** | Pointer to **string** | the id of the source | [optional] +**Description** | Pointer to **string** | the description for the role | [optional] +**DisplayName** | Pointer to **string** | the role display name | [optional] +**EntitlementCount** | Pointer to **string** | the number of entitlements the account will create | [optional] +**AppDisplayName** | Pointer to **string** | the name of | [optional] +**RemoveDate** | Pointer to **string** | the date the role is no longer assigned to the specified identity | [optional] +**Standalone** | **bool** | indicates whether the entitlement is standalone | +**Revocable** | **bool** | indicates whether the role is revocable | +**NativeIdentity** | Pointer to **string** | the native identifier used to uniquely identify an acccount | [optional] +**AppRoleId** | Pointer to **string** | the app role id | [optional] +**Attribute** | Pointer to **string** | the entitlement attribute | [optional] +**Value** | Pointer to **string** | the associated value | [optional] +**EntitlementType** | Pointer to **string** | the type of entitlement | [optional] +**Privileged** | **bool** | indicates whether the entitlement is privileged | +**CloudGoverned** | **bool** | indicates whether the entitlement is cloud governed | + +## Methods + +### NewAccessItemAssociatedAccessItem + +`func NewAccessItemAssociatedAccessItem(standalone bool, revocable bool, privileged bool, cloudGoverned bool, ) *AccessItemAssociatedAccessItem` + +NewAccessItemAssociatedAccessItem instantiates a new AccessItemAssociatedAccessItem 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 + +### NewAccessItemAssociatedAccessItemWithDefaults + +`func NewAccessItemAssociatedAccessItemWithDefaults() *AccessItemAssociatedAccessItem` + +NewAccessItemAssociatedAccessItemWithDefaults instantiates a new AccessItemAssociatedAccessItem 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 + +### GetAccessType + +`func (o *AccessItemAssociatedAccessItem) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemAssociatedAccessItem) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemAssociatedAccessItem) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemAssociatedAccessItem) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemAssociatedAccessItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemAssociatedAccessItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemAssociatedAccessItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemAssociatedAccessItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemAssociatedAccessItem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemAssociatedAccessItem) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemAssociatedAccessItem) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemAssociatedAccessItem) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemAssociatedAccessItem) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemAssociatedAccessItem) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemAssociatedAccessItem) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemAssociatedAccessItem) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessItemAssociatedAccessItem) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessItemAssociatedAccessItem) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessItemAssociatedAccessItem) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessItemAssociatedAccessItem) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessItemAssociatedAccessItem) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessItemAssociatedAccessItem) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessItemAssociatedAccessItem) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessItemAssociatedAccessItem) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemAssociatedAccessItem) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemAssociatedAccessItem) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemAssociatedAccessItem) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemAssociatedAccessItem) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccessItemAssociatedAccessItem) GetEntitlementCount() string` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccessItemAssociatedAccessItem) GetEntitlementCountOk() (*string, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccessItemAssociatedAccessItem) SetEntitlementCount(v string)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccessItemAssociatedAccessItem) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetAppDisplayName + +`func (o *AccessItemAssociatedAccessItem) GetAppDisplayName() string` + +GetAppDisplayName returns the AppDisplayName field if non-nil, zero value otherwise. + +### GetAppDisplayNameOk + +`func (o *AccessItemAssociatedAccessItem) GetAppDisplayNameOk() (*string, bool)` + +GetAppDisplayNameOk returns a tuple with the AppDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppDisplayName + +`func (o *AccessItemAssociatedAccessItem) SetAppDisplayName(v string)` + +SetAppDisplayName sets AppDisplayName field to given value. + +### HasAppDisplayName + +`func (o *AccessItemAssociatedAccessItem) HasAppDisplayName() bool` + +HasAppDisplayName returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *AccessItemAssociatedAccessItem) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccessItemAssociatedAccessItem) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccessItemAssociatedAccessItem) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccessItemAssociatedAccessItem) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetStandalone + +`func (o *AccessItemAssociatedAccessItem) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *AccessItemAssociatedAccessItem) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *AccessItemAssociatedAccessItem) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + + +### GetRevocable + +`func (o *AccessItemAssociatedAccessItem) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *AccessItemAssociatedAccessItem) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *AccessItemAssociatedAccessItem) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + + +### GetNativeIdentity + +`func (o *AccessItemAssociatedAccessItem) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccessItemAssociatedAccessItem) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccessItemAssociatedAccessItem) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccessItemAssociatedAccessItem) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetAppRoleId + +`func (o *AccessItemAssociatedAccessItem) GetAppRoleId() string` + +GetAppRoleId returns the AppRoleId field if non-nil, zero value otherwise. + +### GetAppRoleIdOk + +`func (o *AccessItemAssociatedAccessItem) GetAppRoleIdOk() (*string, bool)` + +GetAppRoleIdOk returns a tuple with the AppRoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppRoleId + +`func (o *AccessItemAssociatedAccessItem) SetAppRoleId(v string)` + +SetAppRoleId sets AppRoleId field to given value. + +### HasAppRoleId + +`func (o *AccessItemAssociatedAccessItem) HasAppRoleId() bool` + +HasAppRoleId returns a boolean if a field has been set. + +### GetAttribute + +`func (o *AccessItemAssociatedAccessItem) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *AccessItemAssociatedAccessItem) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *AccessItemAssociatedAccessItem) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *AccessItemAssociatedAccessItem) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *AccessItemAssociatedAccessItem) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AccessItemAssociatedAccessItem) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AccessItemAssociatedAccessItem) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AccessItemAssociatedAccessItem) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetEntitlementType + +`func (o *AccessItemAssociatedAccessItem) GetEntitlementType() string` + +GetEntitlementType returns the EntitlementType field if non-nil, zero value otherwise. + +### GetEntitlementTypeOk + +`func (o *AccessItemAssociatedAccessItem) GetEntitlementTypeOk() (*string, bool)` + +GetEntitlementTypeOk returns a tuple with the EntitlementType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementType + +`func (o *AccessItemAssociatedAccessItem) SetEntitlementType(v string)` + +SetEntitlementType sets EntitlementType field to given value. + +### HasEntitlementType + +`func (o *AccessItemAssociatedAccessItem) HasEntitlementType() bool` + +HasEntitlementType returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *AccessItemAssociatedAccessItem) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *AccessItemAssociatedAccessItem) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *AccessItemAssociatedAccessItem) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + + +### GetCloudGoverned + +`func (o *AccessItemAssociatedAccessItem) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *AccessItemAssociatedAccessItem) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *AccessItemAssociatedAccessItem) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessItemDiff.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemDiff.md new file mode 100644 index 000000000..98339de92 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemDiff.md @@ -0,0 +1,142 @@ +--- +id: v2025-access-item-diff +title: AccessItemDiff +pagination_label: AccessItemDiff +sidebar_label: AccessItemDiff +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemDiff', 'V2025AccessItemDiff'] +slug: /tools/sdk/go/v2025/models/access-item-diff +tags: ['SDK', 'Software Development Kit', 'AccessItemDiff', 'V2025AccessItemDiff'] +--- + +# AccessItemDiff + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the id of the access item | [optional] +**EventType** | Pointer to **string** | | [optional] +**DisplayName** | Pointer to **string** | the display name of the access item | [optional] +**SourceName** | Pointer to **string** | the source name of the access item | [optional] + +## Methods + +### NewAccessItemDiff + +`func NewAccessItemDiff() *AccessItemDiff` + +NewAccessItemDiff instantiates a new AccessItemDiff 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 + +### NewAccessItemDiffWithDefaults + +`func NewAccessItemDiffWithDefaults() *AccessItemDiff` + +NewAccessItemDiffWithDefaults instantiates a new AccessItemDiff 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 + +### GetId + +`func (o *AccessItemDiff) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemDiff) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemDiff) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemDiff) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetEventType + +`func (o *AccessItemDiff) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AccessItemDiff) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AccessItemDiff) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AccessItemDiff) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemDiff) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemDiff) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemDiff) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemDiff) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemDiff) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemDiff) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemDiff) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemDiff) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessItemEntitlementResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemEntitlementResponse.md new file mode 100644 index 000000000..605b7a4e8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemEntitlementResponse.md @@ -0,0 +1,335 @@ +--- +id: v2025-access-item-entitlement-response +title: AccessItemEntitlementResponse +pagination_label: AccessItemEntitlementResponse +sidebar_label: AccessItemEntitlementResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemEntitlementResponse', 'V2025AccessItemEntitlementResponse'] +slug: /tools/sdk/go/v2025/models/access-item-entitlement-response +tags: ['SDK', 'Software Development Kit', 'AccessItemEntitlementResponse', 'V2025AccessItemEntitlementResponse'] +--- + +# AccessItemEntitlementResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. entitlement in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**Attribute** | Pointer to **string** | the entitlement attribute | [optional] +**Value** | Pointer to **string** | the associated value | [optional] +**EntitlementType** | Pointer to **string** | the type of entitlement | [optional] +**SourceName** | Pointer to **string** | the name of the source | [optional] +**SourceId** | Pointer to **string** | the id of the source | [optional] +**Description** | Pointer to **string** | the description for the entitlment | [optional] +**DisplayName** | Pointer to **string** | the display name of the identity | [optional] +**Standalone** | **bool** | indicates whether the entitlement is standalone | +**Privileged** | **bool** | indicates whether the entitlement is privileged | +**CloudGoverned** | **bool** | indicates whether the entitlement is cloud governed | + +## Methods + +### NewAccessItemEntitlementResponse + +`func NewAccessItemEntitlementResponse(standalone bool, privileged bool, cloudGoverned bool, ) *AccessItemEntitlementResponse` + +NewAccessItemEntitlementResponse instantiates a new AccessItemEntitlementResponse 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 + +### NewAccessItemEntitlementResponseWithDefaults + +`func NewAccessItemEntitlementResponseWithDefaults() *AccessItemEntitlementResponse` + +NewAccessItemEntitlementResponseWithDefaults instantiates a new AccessItemEntitlementResponse 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 + +### GetAccessType + +`func (o *AccessItemEntitlementResponse) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemEntitlementResponse) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemEntitlementResponse) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemEntitlementResponse) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemEntitlementResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemEntitlementResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemEntitlementResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemEntitlementResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAttribute + +`func (o *AccessItemEntitlementResponse) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *AccessItemEntitlementResponse) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *AccessItemEntitlementResponse) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *AccessItemEntitlementResponse) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *AccessItemEntitlementResponse) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AccessItemEntitlementResponse) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AccessItemEntitlementResponse) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AccessItemEntitlementResponse) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetEntitlementType + +`func (o *AccessItemEntitlementResponse) GetEntitlementType() string` + +GetEntitlementType returns the EntitlementType field if non-nil, zero value otherwise. + +### GetEntitlementTypeOk + +`func (o *AccessItemEntitlementResponse) GetEntitlementTypeOk() (*string, bool)` + +GetEntitlementTypeOk returns a tuple with the EntitlementType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementType + +`func (o *AccessItemEntitlementResponse) SetEntitlementType(v string)` + +SetEntitlementType sets EntitlementType field to given value. + +### HasEntitlementType + +`func (o *AccessItemEntitlementResponse) HasEntitlementType() bool` + +HasEntitlementType returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemEntitlementResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemEntitlementResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemEntitlementResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemEntitlementResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessItemEntitlementResponse) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessItemEntitlementResponse) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessItemEntitlementResponse) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessItemEntitlementResponse) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessItemEntitlementResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessItemEntitlementResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessItemEntitlementResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessItemEntitlementResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemEntitlementResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemEntitlementResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemEntitlementResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemEntitlementResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetStandalone + +`func (o *AccessItemEntitlementResponse) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *AccessItemEntitlementResponse) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *AccessItemEntitlementResponse) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + + +### GetPrivileged + +`func (o *AccessItemEntitlementResponse) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *AccessItemEntitlementResponse) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *AccessItemEntitlementResponse) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + + +### GetCloudGoverned + +`func (o *AccessItemEntitlementResponse) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *AccessItemEntitlementResponse) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *AccessItemEntitlementResponse) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRef.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRef.md new file mode 100644 index 000000000..0e3814730 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRef.md @@ -0,0 +1,90 @@ +--- +id: v2025-access-item-ref +title: AccessItemRef +pagination_label: AccessItemRef +sidebar_label: AccessItemRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRef', 'V2025AccessItemRef'] +slug: /tools/sdk/go/v2025/models/access-item-ref +tags: ['SDK', 'Software Development Kit', 'AccessItemRef', 'V2025AccessItemRef'] +--- + +# AccessItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the access item to retrieve the recommendation for. | [optional] +**Type** | Pointer to **string** | Access item's type. | [optional] + +## Methods + +### NewAccessItemRef + +`func NewAccessItemRef() *AccessItemRef` + +NewAccessItemRef instantiates a new AccessItemRef 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 + +### NewAccessItemRefWithDefaults + +`func NewAccessItemRefWithDefaults() *AccessItemRef` + +NewAccessItemRefWithDefaults instantiates a new AccessItemRef 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 + +### GetId + +`func (o *AccessItemRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessItemRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRef) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRemoved.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRemoved.md new file mode 100644 index 000000000..6880440c6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRemoved.md @@ -0,0 +1,168 @@ +--- +id: v2025-access-item-removed +title: AccessItemRemoved +pagination_label: AccessItemRemoved +sidebar_label: AccessItemRemoved +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRemoved', 'V2025AccessItemRemoved'] +slug: /tools/sdk/go/v2025/models/access-item-removed +tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'V2025AccessItemRemoved'] +--- + +# AccessItemRemoved + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] +**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] + +## Methods + +### NewAccessItemRemoved + +`func NewAccessItemRemoved() *AccessItemRemoved` + +NewAccessItemRemoved instantiates a new AccessItemRemoved 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 + +### NewAccessItemRemovedWithDefaults + +`func NewAccessItemRemovedWithDefaults() *AccessItemRemoved` + +NewAccessItemRemovedWithDefaults instantiates a new AccessItemRemoved 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 + +### GetAccessItem + +`func (o *AccessItemRemoved) GetAccessItem() AccessItemAssociatedAccessItem` + +GetAccessItem returns the AccessItem field if non-nil, zero value otherwise. + +### GetAccessItemOk + +`func (o *AccessItemRemoved) GetAccessItemOk() (*AccessItemAssociatedAccessItem, bool)` + +GetAccessItemOk returns a tuple with the AccessItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItem + +`func (o *AccessItemRemoved) SetAccessItem(v AccessItemAssociatedAccessItem)` + +SetAccessItem sets AccessItem field to given value. + +### HasAccessItem + +`func (o *AccessItemRemoved) HasAccessItem() bool` + +HasAccessItem returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *AccessItemRemoved) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessItemRemoved) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessItemRemoved) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccessItemRemoved) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEventType + +`func (o *AccessItemRemoved) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AccessItemRemoved) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AccessItemRemoved) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AccessItemRemoved) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDt + +`func (o *AccessItemRemoved) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *AccessItemRemoved) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *AccessItemRemoved) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *AccessItemRemoved) HasDt() bool` + +HasDt returns a boolean if a field has been set. + +### GetGovernanceEvent + +`func (o *AccessItemRemoved) GetGovernanceEvent() CorrelatedGovernanceEvent` + +GetGovernanceEvent returns the GovernanceEvent field if non-nil, zero value otherwise. + +### GetGovernanceEventOk + +`func (o *AccessItemRemoved) GetGovernanceEventOk() (*CorrelatedGovernanceEvent, bool)` + +GetGovernanceEventOk returns a tuple with the GovernanceEvent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceEvent + +`func (o *AccessItemRemoved) SetGovernanceEvent(v CorrelatedGovernanceEvent)` + +SetGovernanceEvent sets GovernanceEvent field to given value. + +### HasGovernanceEvent + +`func (o *AccessItemRemoved) HasGovernanceEvent() bool` + +HasGovernanceEvent returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRequestedFor.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRequestedFor.md new file mode 100644 index 000000000..b1119fcbb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRequestedFor.md @@ -0,0 +1,116 @@ +--- +id: v2025-access-item-requested-for +title: AccessItemRequestedFor +pagination_label: AccessItemRequestedFor +sidebar_label: AccessItemRequestedFor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRequestedFor', 'V2025AccessItemRequestedFor'] +slug: /tools/sdk/go/v2025/models/access-item-requested-for +tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedFor', 'V2025AccessItemRequestedFor'] +--- + +# AccessItemRequestedFor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity the access item is requested for. | [optional] +**Id** | Pointer to **string** | ID of identity the access item is requested for. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity the access item is requested for. | [optional] + +## Methods + +### NewAccessItemRequestedFor + +`func NewAccessItemRequestedFor() *AccessItemRequestedFor` + +NewAccessItemRequestedFor instantiates a new AccessItemRequestedFor 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 + +### NewAccessItemRequestedForWithDefaults + +`func NewAccessItemRequestedForWithDefaults() *AccessItemRequestedFor` + +NewAccessItemRequestedForWithDefaults instantiates a new AccessItemRequestedFor 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 + +### GetType + +`func (o *AccessItemRequestedFor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRequestedFor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRequestedFor) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRequestedFor) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRequestedFor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRequestedFor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRequestedFor) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRequestedFor) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemRequestedFor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemRequestedFor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemRequestedFor) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemRequestedFor) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRequestedForDto.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRequestedForDto.md new file mode 100644 index 000000000..2a9344d5f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRequestedForDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-access-item-requested-for-dto +title: AccessItemRequestedForDto +pagination_label: AccessItemRequestedForDto +sidebar_label: AccessItemRequestedForDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRequestedForDto', 'V2025AccessItemRequestedForDto'] +slug: /tools/sdk/go/v2025/models/access-item-requested-for-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedForDto', 'V2025AccessItemRequestedForDto'] +--- + +# AccessItemRequestedForDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity the access item is requested for. | [optional] +**Id** | Pointer to **string** | ID of identity the access item is requested for. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity the access item is requested for. | [optional] + +## Methods + +### NewAccessItemRequestedForDto + +`func NewAccessItemRequestedForDto() *AccessItemRequestedForDto` + +NewAccessItemRequestedForDto instantiates a new AccessItemRequestedForDto 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 + +### NewAccessItemRequestedForDtoWithDefaults + +`func NewAccessItemRequestedForDtoWithDefaults() *AccessItemRequestedForDto` + +NewAccessItemRequestedForDtoWithDefaults instantiates a new AccessItemRequestedForDto 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 + +### GetType + +`func (o *AccessItemRequestedForDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRequestedForDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRequestedForDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRequestedForDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRequestedForDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRequestedForDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRequestedForDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRequestedForDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemRequestedForDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemRequestedForDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemRequestedForDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemRequestedForDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRequester.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRequester.md new file mode 100644 index 000000000..c39d4ba8c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRequester.md @@ -0,0 +1,116 @@ +--- +id: v2025-access-item-requester +title: AccessItemRequester +pagination_label: AccessItemRequester +sidebar_label: AccessItemRequester +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRequester', 'V2025AccessItemRequester'] +slug: /tools/sdk/go/v2025/models/access-item-requester +tags: ['SDK', 'Software Development Kit', 'AccessItemRequester', 'V2025AccessItemRequester'] +--- + +# AccessItemRequester + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Access item requester's DTO type. | [optional] +**Id** | Pointer to **string** | Access item requester's identity ID. | [optional] +**Name** | Pointer to **string** | Access item owner's human-readable display name. | [optional] + +## Methods + +### NewAccessItemRequester + +`func NewAccessItemRequester() *AccessItemRequester` + +NewAccessItemRequester instantiates a new AccessItemRequester 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 + +### NewAccessItemRequesterWithDefaults + +`func NewAccessItemRequesterWithDefaults() *AccessItemRequester` + +NewAccessItemRequesterWithDefaults instantiates a new AccessItemRequester 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 + +### GetType + +`func (o *AccessItemRequester) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRequester) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRequester) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRequester) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRequester) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRequester) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRequester) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRequester) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemRequester) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemRequester) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemRequester) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemRequester) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRequesterDto.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRequesterDto.md new file mode 100644 index 000000000..03dd59958 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRequesterDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-access-item-requester-dto +title: AccessItemRequesterDto +pagination_label: AccessItemRequesterDto +sidebar_label: AccessItemRequesterDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRequesterDto', 'V2025AccessItemRequesterDto'] +slug: /tools/sdk/go/v2025/models/access-item-requester-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemRequesterDto', 'V2025AccessItemRequesterDto'] +--- + +# AccessItemRequesterDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Access item requester's DTO type. | [optional] +**Id** | Pointer to **string** | Access item requester's identity ID. | [optional] +**Name** | Pointer to **string** | Access item owner's human-readable display name. | [optional] + +## Methods + +### NewAccessItemRequesterDto + +`func NewAccessItemRequesterDto() *AccessItemRequesterDto` + +NewAccessItemRequesterDto instantiates a new AccessItemRequesterDto 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 + +### NewAccessItemRequesterDtoWithDefaults + +`func NewAccessItemRequesterDtoWithDefaults() *AccessItemRequesterDto` + +NewAccessItemRequesterDtoWithDefaults instantiates a new AccessItemRequesterDto 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 + +### GetType + +`func (o *AccessItemRequesterDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRequesterDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRequesterDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRequesterDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRequesterDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRequesterDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRequesterDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRequesterDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemRequesterDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemRequesterDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemRequesterDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemRequesterDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessItemReviewedBy.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemReviewedBy.md new file mode 100644 index 000000000..7846677cf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemReviewedBy.md @@ -0,0 +1,116 @@ +--- +id: v2025-access-item-reviewed-by +title: AccessItemReviewedBy +pagination_label: AccessItemReviewedBy +sidebar_label: AccessItemReviewedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemReviewedBy', 'V2025AccessItemReviewedBy'] +slug: /tools/sdk/go/v2025/models/access-item-reviewed-by +tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy', 'V2025AccessItemReviewedBy'] +--- + +# AccessItemReviewedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity who reviewed the access item request. | [optional] +**Id** | Pointer to **string** | ID of identity who reviewed the access item request. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity who reviewed the access item request. | [optional] + +## Methods + +### NewAccessItemReviewedBy + +`func NewAccessItemReviewedBy() *AccessItemReviewedBy` + +NewAccessItemReviewedBy instantiates a new AccessItemReviewedBy 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 + +### NewAccessItemReviewedByWithDefaults + +`func NewAccessItemReviewedByWithDefaults() *AccessItemReviewedBy` + +NewAccessItemReviewedByWithDefaults instantiates a new AccessItemReviewedBy 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 + +### GetType + +`func (o *AccessItemReviewedBy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemReviewedBy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemReviewedBy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemReviewedBy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemReviewedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemReviewedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemReviewedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemReviewedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemReviewedBy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemReviewedBy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemReviewedBy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemReviewedBy) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRoleResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRoleResponse.md new file mode 100644 index 000000000..e3a8a7dc2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessItemRoleResponse.md @@ -0,0 +1,215 @@ +--- +id: v2025-access-item-role-response +title: AccessItemRoleResponse +pagination_label: AccessItemRoleResponse +sidebar_label: AccessItemRoleResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRoleResponse', 'V2025AccessItemRoleResponse'] +slug: /tools/sdk/go/v2025/models/access-item-role-response +tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'V2025AccessItemRoleResponse'] +--- + +# AccessItemRoleResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. role in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**DisplayName** | Pointer to **string** | the role display name | [optional] +**Description** | Pointer to **string** | the description for the role | [optional] +**SourceName** | Pointer to **string** | the associated source name if it exists | [optional] +**RemoveDate** | Pointer to **string** | the date the role is no longer assigned to the specified identity | [optional] +**Revocable** | **bool** | indicates whether the role is revocable | + +## Methods + +### NewAccessItemRoleResponse + +`func NewAccessItemRoleResponse(revocable bool, ) *AccessItemRoleResponse` + +NewAccessItemRoleResponse instantiates a new AccessItemRoleResponse 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 + +### NewAccessItemRoleResponseWithDefaults + +`func NewAccessItemRoleResponseWithDefaults() *AccessItemRoleResponse` + +NewAccessItemRoleResponseWithDefaults instantiates a new AccessItemRoleResponse 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 + +### GetAccessType + +`func (o *AccessItemRoleResponse) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccessItemRoleResponse) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccessItemRoleResponse) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccessItemRoleResponse) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRoleResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRoleResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRoleResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRoleResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessItemRoleResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessItemRoleResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessItemRoleResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessItemRoleResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessItemRoleResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessItemRoleResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessItemRoleResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessItemRoleResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessItemRoleResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessItemRoleResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessItemRoleResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessItemRoleResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *AccessItemRoleResponse) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccessItemRoleResponse) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccessItemRoleResponse) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccessItemRoleResponse) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetRevocable + +`func (o *AccessItemRoleResponse) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *AccessItemRoleResponse) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *AccessItemRoleResponse) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessModelMetadata.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessModelMetadata.md new file mode 100644 index 000000000..84c7043ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessModelMetadata.md @@ -0,0 +1,246 @@ +--- +id: v2025-access-model-metadata +title: AccessModelMetadata +pagination_label: AccessModelMetadata +sidebar_label: AccessModelMetadata +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessModelMetadata', 'V2025AccessModelMetadata'] +slug: /tools/sdk/go/v2025/models/access-model-metadata +tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'V2025AccessModelMetadata'] +--- + +# AccessModelMetadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | Unique identifier for the metadata type | [optional] +**Name** | Pointer to **string** | Human readable name of the metadata type | [optional] +**Multiselect** | Pointer to **bool** | Allows selecting multiple values | [optional] [default to false] +**Status** | Pointer to **string** | The state of the metadata item | [optional] +**Type** | Pointer to **string** | The type of the metadata item | [optional] +**ObjectTypes** | Pointer to **[]string** | The types of objects | [optional] +**Description** | Pointer to **string** | Describes the metadata item | [optional] +**Values** | Pointer to [**[]AccessModelMetadataValuesInner**](access-model-metadata-values-inner) | The value to assign to the metadata item | [optional] + +## Methods + +### NewAccessModelMetadata + +`func NewAccessModelMetadata() *AccessModelMetadata` + +NewAccessModelMetadata instantiates a new AccessModelMetadata 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 + +### NewAccessModelMetadataWithDefaults + +`func NewAccessModelMetadataWithDefaults() *AccessModelMetadata` + +NewAccessModelMetadataWithDefaults instantiates a new AccessModelMetadata 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 + +### GetKey + +`func (o *AccessModelMetadata) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *AccessModelMetadata) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *AccessModelMetadata) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *AccessModelMetadata) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *AccessModelMetadata) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessModelMetadata) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessModelMetadata) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessModelMetadata) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetMultiselect + +`func (o *AccessModelMetadata) GetMultiselect() bool` + +GetMultiselect returns the Multiselect field if non-nil, zero value otherwise. + +### GetMultiselectOk + +`func (o *AccessModelMetadata) GetMultiselectOk() (*bool, bool)` + +GetMultiselectOk returns a tuple with the Multiselect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultiselect + +`func (o *AccessModelMetadata) SetMultiselect(v bool)` + +SetMultiselect sets Multiselect field to given value. + +### HasMultiselect + +`func (o *AccessModelMetadata) HasMultiselect() bool` + +HasMultiselect returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccessModelMetadata) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccessModelMetadata) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccessModelMetadata) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccessModelMetadata) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetType + +`func (o *AccessModelMetadata) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessModelMetadata) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessModelMetadata) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessModelMetadata) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetObjectTypes + +`func (o *AccessModelMetadata) GetObjectTypes() []string` + +GetObjectTypes returns the ObjectTypes field if non-nil, zero value otherwise. + +### GetObjectTypesOk + +`func (o *AccessModelMetadata) GetObjectTypesOk() (*[]string, bool)` + +GetObjectTypesOk returns a tuple with the ObjectTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectTypes + +`func (o *AccessModelMetadata) SetObjectTypes(v []string)` + +SetObjectTypes sets ObjectTypes field to given value. + +### HasObjectTypes + +`func (o *AccessModelMetadata) HasObjectTypes() bool` + +HasObjectTypes returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessModelMetadata) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessModelMetadata) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessModelMetadata) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessModelMetadata) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetValues + +`func (o *AccessModelMetadata) GetValues() []AccessModelMetadataValuesInner` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *AccessModelMetadata) GetValuesOk() (*[]AccessModelMetadataValuesInner, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *AccessModelMetadata) SetValues(v []AccessModelMetadataValuesInner)` + +SetValues sets Values field to given value. + +### HasValues + +`func (o *AccessModelMetadata) HasValues() bool` + +HasValues returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessModelMetadataValuesInner.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessModelMetadataValuesInner.md new file mode 100644 index 000000000..a4b4b1a96 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessModelMetadataValuesInner.md @@ -0,0 +1,116 @@ +--- +id: v2025-access-model-metadata-values-inner +title: AccessModelMetadataValuesInner +pagination_label: AccessModelMetadataValuesInner +sidebar_label: AccessModelMetadataValuesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessModelMetadataValuesInner', 'V2025AccessModelMetadataValuesInner'] +slug: /tools/sdk/go/v2025/models/access-model-metadata-values-inner +tags: ['SDK', 'Software Development Kit', 'AccessModelMetadataValuesInner', 'V2025AccessModelMetadataValuesInner'] +--- + +# AccessModelMetadataValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | The value to assign to the metdata item | [optional] +**Name** | Pointer to **string** | Display name of the value | [optional] +**Status** | Pointer to **string** | The status of the individual value | [optional] + +## Methods + +### NewAccessModelMetadataValuesInner + +`func NewAccessModelMetadataValuesInner() *AccessModelMetadataValuesInner` + +NewAccessModelMetadataValuesInner instantiates a new AccessModelMetadataValuesInner 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 + +### NewAccessModelMetadataValuesInnerWithDefaults + +`func NewAccessModelMetadataValuesInnerWithDefaults() *AccessModelMetadataValuesInner` + +NewAccessModelMetadataValuesInnerWithDefaults instantiates a new AccessModelMetadataValuesInner 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 + +### GetValue + +`func (o *AccessModelMetadataValuesInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AccessModelMetadataValuesInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AccessModelMetadataValuesInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AccessModelMetadataValuesInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetName + +`func (o *AccessModelMetadataValuesInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessModelMetadataValuesInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessModelMetadataValuesInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessModelMetadataValuesInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccessModelMetadataValuesInner) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccessModelMetadataValuesInner) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccessModelMetadataValuesInner) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccessModelMetadataValuesInner) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfile.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfile.md new file mode 100644 index 000000000..880433b09 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfile.md @@ -0,0 +1,447 @@ +--- +id: v2025-access-profile +title: AccessProfile +pagination_label: AccessProfile +sidebar_label: AccessProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfile', 'V2025AccessProfile'] +slug: /tools/sdk/go/v2025/models/access-profile +tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'V2025AccessProfile'] +--- + +# AccessProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Access profile ID. | [optional] [readonly] +**Name** | **string** | Access profile name. | +**Description** | Pointer to **NullableString** | Access profile description. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time when the access profile was created. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Date and time when the access profile was last modified. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to false] +**Owner** | [**OwnerReference**](owner-reference) | | +**Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | +**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**Requestable** | Pointer to **bool** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to true] +**AccessRequestConfig** | Pointer to [**NullableRequestability**](requestability) | | [optional] +**RevocationRequestConfig** | Pointer to [**NullableRevocability**](revocability) | | [optional] +**Segments** | Pointer to **[]string** | List of segment IDs, if any, that the access profile is assigned to. | [optional] +**ProvisioningCriteria** | Pointer to [**NullableProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] + +## Methods + +### NewAccessProfile + +`func NewAccessProfile(name string, owner OwnerReference, source AccessProfileSourceRef, ) *AccessProfile` + +NewAccessProfile instantiates a new AccessProfile 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 + +### NewAccessProfileWithDefaults + +`func NewAccessProfileWithDefaults() *AccessProfile` + +NewAccessProfileWithDefaults instantiates a new AccessProfile 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 + +### GetId + +`func (o *AccessProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfile) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *AccessProfile) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfile) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfile) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfile) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessProfile) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessProfile) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCreated + +`func (o *AccessProfile) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccessProfile) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccessProfile) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccessProfile) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *AccessProfile) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccessProfile) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccessProfile) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccessProfile) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetEnabled + +`func (o *AccessProfile) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AccessProfile) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AccessProfile) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *AccessProfile) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetOwner + +`func (o *AccessProfile) GetOwner() OwnerReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *AccessProfile) GetOwnerOk() (*OwnerReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *AccessProfile) SetOwner(v OwnerReference)` + +SetOwner sets Owner field to given value. + + +### GetSource + +`func (o *AccessProfile) GetSource() AccessProfileSourceRef` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccessProfile) GetSourceOk() (*AccessProfileSourceRef, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccessProfile) SetSource(v AccessProfileSourceRef)` + +SetSource sets Source field to given value. + + +### GetEntitlements + +`func (o *AccessProfile) GetEntitlements() []EntitlementRef` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *AccessProfile) GetEntitlementsOk() (*[]EntitlementRef, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *AccessProfile) SetEntitlements(v []EntitlementRef)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *AccessProfile) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### SetEntitlementsNil + +`func (o *AccessProfile) SetEntitlementsNil(b bool)` + + SetEntitlementsNil sets the value for Entitlements to be an explicit nil + +### UnsetEntitlements +`func (o *AccessProfile) UnsetEntitlements()` + +UnsetEntitlements ensures that no value is present for Entitlements, not even an explicit nil +### GetRequestable + +`func (o *AccessProfile) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *AccessProfile) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *AccessProfile) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *AccessProfile) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetAccessRequestConfig + +`func (o *AccessProfile) GetAccessRequestConfig() Requestability` + +GetAccessRequestConfig returns the AccessRequestConfig field if non-nil, zero value otherwise. + +### GetAccessRequestConfigOk + +`func (o *AccessProfile) GetAccessRequestConfigOk() (*Requestability, bool)` + +GetAccessRequestConfigOk returns a tuple with the AccessRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestConfig + +`func (o *AccessProfile) SetAccessRequestConfig(v Requestability)` + +SetAccessRequestConfig sets AccessRequestConfig field to given value. + +### HasAccessRequestConfig + +`func (o *AccessProfile) HasAccessRequestConfig() bool` + +HasAccessRequestConfig returns a boolean if a field has been set. + +### SetAccessRequestConfigNil + +`func (o *AccessProfile) SetAccessRequestConfigNil(b bool)` + + SetAccessRequestConfigNil sets the value for AccessRequestConfig to be an explicit nil + +### UnsetAccessRequestConfig +`func (o *AccessProfile) UnsetAccessRequestConfig()` + +UnsetAccessRequestConfig ensures that no value is present for AccessRequestConfig, not even an explicit nil +### GetRevocationRequestConfig + +`func (o *AccessProfile) GetRevocationRequestConfig() Revocability` + +GetRevocationRequestConfig returns the RevocationRequestConfig field if non-nil, zero value otherwise. + +### GetRevocationRequestConfigOk + +`func (o *AccessProfile) GetRevocationRequestConfigOk() (*Revocability, bool)` + +GetRevocationRequestConfigOk returns a tuple with the RevocationRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocationRequestConfig + +`func (o *AccessProfile) SetRevocationRequestConfig(v Revocability)` + +SetRevocationRequestConfig sets RevocationRequestConfig field to given value. + +### HasRevocationRequestConfig + +`func (o *AccessProfile) HasRevocationRequestConfig() bool` + +HasRevocationRequestConfig returns a boolean if a field has been set. + +### SetRevocationRequestConfigNil + +`func (o *AccessProfile) SetRevocationRequestConfigNil(b bool)` + + SetRevocationRequestConfigNil sets the value for RevocationRequestConfig to be an explicit nil + +### UnsetRevocationRequestConfig +`func (o *AccessProfile) UnsetRevocationRequestConfig()` + +UnsetRevocationRequestConfig ensures that no value is present for RevocationRequestConfig, not even an explicit nil +### GetSegments + +`func (o *AccessProfile) GetSegments() []string` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *AccessProfile) GetSegmentsOk() (*[]string, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *AccessProfile) SetSegments(v []string)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *AccessProfile) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### SetSegmentsNil + +`func (o *AccessProfile) SetSegmentsNil(b bool)` + + SetSegmentsNil sets the value for Segments to be an explicit nil + +### UnsetSegments +`func (o *AccessProfile) UnsetSegments()` + +UnsetSegments ensures that no value is present for Segments, not even an explicit nil +### GetProvisioningCriteria + +`func (o *AccessProfile) GetProvisioningCriteria() ProvisioningCriteriaLevel1` + +GetProvisioningCriteria returns the ProvisioningCriteria field if non-nil, zero value otherwise. + +### GetProvisioningCriteriaOk + +`func (o *AccessProfile) GetProvisioningCriteriaOk() (*ProvisioningCriteriaLevel1, bool)` + +GetProvisioningCriteriaOk returns a tuple with the ProvisioningCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningCriteria + +`func (o *AccessProfile) SetProvisioningCriteria(v ProvisioningCriteriaLevel1)` + +SetProvisioningCriteria sets ProvisioningCriteria field to given value. + +### HasProvisioningCriteria + +`func (o *AccessProfile) HasProvisioningCriteria() bool` + +HasProvisioningCriteria returns a boolean if a field has been set. + +### SetProvisioningCriteriaNil + +`func (o *AccessProfile) SetProvisioningCriteriaNil(b bool)` + + SetProvisioningCriteriaNil sets the value for ProvisioningCriteria to be an explicit nil + +### UnsetProvisioningCriteria +`func (o *AccessProfile) UnsetProvisioningCriteria()` + +UnsetProvisioningCriteria ensures that no value is present for ProvisioningCriteria, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileApprovalScheme.md new file mode 100644 index 000000000..36d23e6f5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileApprovalScheme.md @@ -0,0 +1,100 @@ +--- +id: v2025-access-profile-approval-scheme +title: AccessProfileApprovalScheme +pagination_label: AccessProfileApprovalScheme +sidebar_label: AccessProfileApprovalScheme +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileApprovalScheme', 'V2025AccessProfileApprovalScheme'] +slug: /tools/sdk/go/v2025/models/access-profile-approval-scheme +tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'V2025AccessProfileApprovalScheme'] +--- + +# AccessProfileApprovalScheme + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApproverType** | Pointer to **string** | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | Pointer to **NullableString** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] + +## Methods + +### NewAccessProfileApprovalScheme + +`func NewAccessProfileApprovalScheme() *AccessProfileApprovalScheme` + +NewAccessProfileApprovalScheme instantiates a new AccessProfileApprovalScheme 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 + +### NewAccessProfileApprovalSchemeWithDefaults + +`func NewAccessProfileApprovalSchemeWithDefaults() *AccessProfileApprovalScheme` + +NewAccessProfileApprovalSchemeWithDefaults instantiates a new AccessProfileApprovalScheme 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 + +### GetApproverType + +`func (o *AccessProfileApprovalScheme) GetApproverType() string` + +GetApproverType returns the ApproverType field if non-nil, zero value otherwise. + +### GetApproverTypeOk + +`func (o *AccessProfileApprovalScheme) GetApproverTypeOk() (*string, bool)` + +GetApproverTypeOk returns a tuple with the ApproverType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverType + +`func (o *AccessProfileApprovalScheme) SetApproverType(v string)` + +SetApproverType sets ApproverType field to given value. + +### HasApproverType + +`func (o *AccessProfileApprovalScheme) HasApproverType() bool` + +HasApproverType returns a boolean if a field has been set. + +### GetApproverId + +`func (o *AccessProfileApprovalScheme) GetApproverId() string` + +GetApproverId returns the ApproverId field if non-nil, zero value otherwise. + +### GetApproverIdOk + +`func (o *AccessProfileApprovalScheme) GetApproverIdOk() (*string, bool)` + +GetApproverIdOk returns a tuple with the ApproverId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverId + +`func (o *AccessProfileApprovalScheme) SetApproverId(v string)` + +SetApproverId sets ApproverId field to given value. + +### HasApproverId + +`func (o *AccessProfileApprovalScheme) HasApproverId() bool` + +HasApproverId returns a boolean if a field has been set. + +### SetApproverIdNil + +`func (o *AccessProfileApprovalScheme) SetApproverIdNil(b bool)` + + SetApproverIdNil sets the value for ApproverId to be an explicit nil + +### UnsetApproverId +`func (o *AccessProfileApprovalScheme) UnsetApproverId()` + +UnsetApproverId ensures that no value is present for ApproverId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileBulkDeleteRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileBulkDeleteRequest.md new file mode 100644 index 000000000..14fc17949 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileBulkDeleteRequest.md @@ -0,0 +1,90 @@ +--- +id: v2025-access-profile-bulk-delete-request +title: AccessProfileBulkDeleteRequest +pagination_label: AccessProfileBulkDeleteRequest +sidebar_label: AccessProfileBulkDeleteRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileBulkDeleteRequest', 'V2025AccessProfileBulkDeleteRequest'] +slug: /tools/sdk/go/v2025/models/access-profile-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest', 'V2025AccessProfileBulkDeleteRequest'] +--- + +# AccessProfileBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessProfileIds** | Pointer to **[]string** | List of IDs of Access Profiles to be deleted. | [optional] +**BestEffortOnly** | Pointer to **bool** | If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. | [optional] + +## Methods + +### NewAccessProfileBulkDeleteRequest + +`func NewAccessProfileBulkDeleteRequest() *AccessProfileBulkDeleteRequest` + +NewAccessProfileBulkDeleteRequest instantiates a new AccessProfileBulkDeleteRequest 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 + +### NewAccessProfileBulkDeleteRequestWithDefaults + +`func NewAccessProfileBulkDeleteRequestWithDefaults() *AccessProfileBulkDeleteRequest` + +NewAccessProfileBulkDeleteRequestWithDefaults instantiates a new AccessProfileBulkDeleteRequest 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 + +### GetAccessProfileIds + +`func (o *AccessProfileBulkDeleteRequest) GetAccessProfileIds() []string` + +GetAccessProfileIds returns the AccessProfileIds field if non-nil, zero value otherwise. + +### GetAccessProfileIdsOk + +`func (o *AccessProfileBulkDeleteRequest) GetAccessProfileIdsOk() (*[]string, bool)` + +GetAccessProfileIdsOk returns a tuple with the AccessProfileIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileIds + +`func (o *AccessProfileBulkDeleteRequest) SetAccessProfileIds(v []string)` + +SetAccessProfileIds sets AccessProfileIds field to given value. + +### HasAccessProfileIds + +`func (o *AccessProfileBulkDeleteRequest) HasAccessProfileIds() bool` + +HasAccessProfileIds returns a boolean if a field has been set. + +### GetBestEffortOnly + +`func (o *AccessProfileBulkDeleteRequest) GetBestEffortOnly() bool` + +GetBestEffortOnly returns the BestEffortOnly field if non-nil, zero value otherwise. + +### GetBestEffortOnlyOk + +`func (o *AccessProfileBulkDeleteRequest) GetBestEffortOnlyOk() (*bool, bool)` + +GetBestEffortOnlyOk returns a tuple with the BestEffortOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBestEffortOnly + +`func (o *AccessProfileBulkDeleteRequest) SetBestEffortOnly(v bool)` + +SetBestEffortOnly sets BestEffortOnly field to given value. + +### HasBestEffortOnly + +`func (o *AccessProfileBulkDeleteRequest) HasBestEffortOnly() bool` + +HasBestEffortOnly returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileBulkDeleteResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileBulkDeleteResponse.md new file mode 100644 index 000000000..3b4cfbf88 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileBulkDeleteResponse.md @@ -0,0 +1,116 @@ +--- +id: v2025-access-profile-bulk-delete-response +title: AccessProfileBulkDeleteResponse +pagination_label: AccessProfileBulkDeleteResponse +sidebar_label: AccessProfileBulkDeleteResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileBulkDeleteResponse', 'V2025AccessProfileBulkDeleteResponse'] +slug: /tools/sdk/go/v2025/models/access-profile-bulk-delete-response +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse', 'V2025AccessProfileBulkDeleteResponse'] +--- + +# AccessProfileBulkDeleteResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TaskId** | Pointer to **string** | ID of the task which is executing the bulk deletion. This can be passed to the **_/task-status** API to track status. | [optional] +**Pending** | Pointer to **[]string** | List of IDs of Access Profiles which are pending deletion. | [optional] +**InUse** | Pointer to [**[]AccessProfileUsage**](access-profile-usage) | List of usages of Access Profiles targeted for deletion. | [optional] + +## Methods + +### NewAccessProfileBulkDeleteResponse + +`func NewAccessProfileBulkDeleteResponse() *AccessProfileBulkDeleteResponse` + +NewAccessProfileBulkDeleteResponse instantiates a new AccessProfileBulkDeleteResponse 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 + +### NewAccessProfileBulkDeleteResponseWithDefaults + +`func NewAccessProfileBulkDeleteResponseWithDefaults() *AccessProfileBulkDeleteResponse` + +NewAccessProfileBulkDeleteResponseWithDefaults instantiates a new AccessProfileBulkDeleteResponse 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 + +### GetTaskId + +`func (o *AccessProfileBulkDeleteResponse) GetTaskId() string` + +GetTaskId returns the TaskId field if non-nil, zero value otherwise. + +### GetTaskIdOk + +`func (o *AccessProfileBulkDeleteResponse) GetTaskIdOk() (*string, bool)` + +GetTaskIdOk returns a tuple with the TaskId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskId + +`func (o *AccessProfileBulkDeleteResponse) SetTaskId(v string)` + +SetTaskId sets TaskId field to given value. + +### HasTaskId + +`func (o *AccessProfileBulkDeleteResponse) HasTaskId() bool` + +HasTaskId returns a boolean if a field has been set. + +### GetPending + +`func (o *AccessProfileBulkDeleteResponse) GetPending() []string` + +GetPending returns the Pending field if non-nil, zero value otherwise. + +### GetPendingOk + +`func (o *AccessProfileBulkDeleteResponse) GetPendingOk() (*[]string, bool)` + +GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPending + +`func (o *AccessProfileBulkDeleteResponse) SetPending(v []string)` + +SetPending sets Pending field to given value. + +### HasPending + +`func (o *AccessProfileBulkDeleteResponse) HasPending() bool` + +HasPending returns a boolean if a field has been set. + +### GetInUse + +`func (o *AccessProfileBulkDeleteResponse) GetInUse() []AccessProfileUsage` + +GetInUse returns the InUse field if non-nil, zero value otherwise. + +### GetInUseOk + +`func (o *AccessProfileBulkDeleteResponse) GetInUseOk() (*[]AccessProfileUsage, bool)` + +GetInUseOk returns a tuple with the InUse field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInUse + +`func (o *AccessProfileBulkDeleteResponse) SetInUse(v []AccessProfileUsage)` + +SetInUse sets InUse field to given value. + +### HasInUse + +`func (o *AccessProfileBulkDeleteResponse) HasInUse() bool` + +HasInUse returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileBulkUpdateRequestInner.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileBulkUpdateRequestInner.md new file mode 100644 index 000000000..42fb0e8d2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileBulkUpdateRequestInner.md @@ -0,0 +1,90 @@ +--- +id: v2025-access-profile-bulk-update-request-inner +title: AccessProfileBulkUpdateRequestInner +pagination_label: AccessProfileBulkUpdateRequestInner +sidebar_label: AccessProfileBulkUpdateRequestInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileBulkUpdateRequestInner', 'V2025AccessProfileBulkUpdateRequestInner'] +slug: /tools/sdk/go/v2025/models/access-profile-bulk-update-request-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkUpdateRequestInner', 'V2025AccessProfileBulkUpdateRequestInner'] +--- + +# AccessProfileBulkUpdateRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Access Profile ID. | [optional] +**Requestable** | Pointer to **bool** | Access Profile is requestable or not. | [optional] + +## Methods + +### NewAccessProfileBulkUpdateRequestInner + +`func NewAccessProfileBulkUpdateRequestInner() *AccessProfileBulkUpdateRequestInner` + +NewAccessProfileBulkUpdateRequestInner instantiates a new AccessProfileBulkUpdateRequestInner 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 + +### NewAccessProfileBulkUpdateRequestInnerWithDefaults + +`func NewAccessProfileBulkUpdateRequestInnerWithDefaults() *AccessProfileBulkUpdateRequestInner` + +NewAccessProfileBulkUpdateRequestInnerWithDefaults instantiates a new AccessProfileBulkUpdateRequestInner 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 + +### GetId + +`func (o *AccessProfileBulkUpdateRequestInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileBulkUpdateRequestInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileBulkUpdateRequestInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileBulkUpdateRequestInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRequestable + +`func (o *AccessProfileBulkUpdateRequestInner) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *AccessProfileBulkUpdateRequestInner) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *AccessProfileBulkUpdateRequestInner) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *AccessProfileBulkUpdateRequestInner) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileDetails.md new file mode 100644 index 000000000..f1c04f4f6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileDetails.md @@ -0,0 +1,676 @@ +--- +id: v2025-access-profile-details +title: AccessProfileDetails +pagination_label: AccessProfileDetails +sidebar_label: AccessProfileDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileDetails', 'V2025AccessProfileDetails'] +slug: /tools/sdk/go/v2025/models/access-profile-details +tags: ['SDK', 'Software Development Kit', 'AccessProfileDetails', 'V2025AccessProfileDetails'] +--- + +# AccessProfileDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the Access Profile | [optional] +**Name** | Pointer to **string** | Name of the Access Profile | [optional] +**Description** | Pointer to **NullableString** | Information about the Access Profile | [optional] +**Created** | Pointer to **SailPointTime** | Date the Access Profile was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date the Access Profile was last modified. | [optional] +**Disabled** | Pointer to **bool** | Whether the Access Profile is enabled. | [optional] [default to true] +**Requestable** | Pointer to **bool** | Whether the Access Profile is requestable via access request. | [optional] [default to false] +**Protected** | Pointer to **bool** | Whether the Access Profile is protected. | [optional] [default to false] +**OwnerId** | Pointer to **string** | The owner ID of the Access Profile | [optional] +**SourceId** | Pointer to **NullableInt64** | The source ID of the Access Profile | [optional] +**SourceName** | Pointer to **string** | The source name of the Access Profile | [optional] +**AppId** | Pointer to **NullableInt64** | The source app ID of the Access Profile | [optional] +**AppName** | Pointer to **NullableString** | The source app name of the Access Profile | [optional] +**ApplicationId** | Pointer to **string** | The id of the application | [optional] +**Type** | Pointer to **string** | The type of the access profile | [optional] +**Entitlements** | Pointer to **[]string** | List of IDs of entitlements | [optional] +**EntitlementCount** | Pointer to **int32** | The number of entitlements in the access profile | [optional] +**Segments** | Pointer to **[]string** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**ApprovalSchemes** | Pointer to **string** | Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional] +**RevokeRequestApprovalSchemes** | Pointer to **string** | Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional] +**RequestCommentsRequired** | Pointer to **bool** | Whether the access profile require request comment for access request. | [optional] [default to false] +**DeniedCommentsRequired** | Pointer to **bool** | Whether denied comment is required when access request is denied. | [optional] [default to false] +**AccountSelector** | Pointer to [**AccessProfileDetailsAccountSelector**](access-profile-details-account-selector) | | [optional] + +## Methods + +### NewAccessProfileDetails + +`func NewAccessProfileDetails() *AccessProfileDetails` + +NewAccessProfileDetails instantiates a new AccessProfileDetails 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 + +### NewAccessProfileDetailsWithDefaults + +`func NewAccessProfileDetailsWithDefaults() *AccessProfileDetails` + +NewAccessProfileDetailsWithDefaults instantiates a new AccessProfileDetails 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 + +### GetId + +`func (o *AccessProfileDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessProfileDetails) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileDetails) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileDetails) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileDetails) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessProfileDetails) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessProfileDetails) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCreated + +`func (o *AccessProfileDetails) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccessProfileDetails) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccessProfileDetails) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccessProfileDetails) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *AccessProfileDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccessProfileDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccessProfileDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccessProfileDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDisabled + +`func (o *AccessProfileDetails) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *AccessProfileDetails) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *AccessProfileDetails) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *AccessProfileDetails) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetRequestable + +`func (o *AccessProfileDetails) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *AccessProfileDetails) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *AccessProfileDetails) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *AccessProfileDetails) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetProtected + +`func (o *AccessProfileDetails) GetProtected() bool` + +GetProtected returns the Protected field if non-nil, zero value otherwise. + +### GetProtectedOk + +`func (o *AccessProfileDetails) GetProtectedOk() (*bool, bool)` + +GetProtectedOk returns a tuple with the Protected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProtected + +`func (o *AccessProfileDetails) SetProtected(v bool)` + +SetProtected sets Protected field to given value. + +### HasProtected + +`func (o *AccessProfileDetails) HasProtected() bool` + +HasProtected returns a boolean if a field has been set. + +### GetOwnerId + +`func (o *AccessProfileDetails) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *AccessProfileDetails) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *AccessProfileDetails) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *AccessProfileDetails) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessProfileDetails) GetSourceId() int64` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessProfileDetails) GetSourceIdOk() (*int64, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessProfileDetails) SetSourceId(v int64)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessProfileDetails) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### SetSourceIdNil + +`func (o *AccessProfileDetails) SetSourceIdNil(b bool)` + + SetSourceIdNil sets the value for SourceId to be an explicit nil + +### UnsetSourceId +`func (o *AccessProfileDetails) UnsetSourceId()` + +UnsetSourceId ensures that no value is present for SourceId, not even an explicit nil +### GetSourceName + +`func (o *AccessProfileDetails) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessProfileDetails) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessProfileDetails) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessProfileDetails) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetAppId + +`func (o *AccessProfileDetails) GetAppId() int64` + +GetAppId returns the AppId field if non-nil, zero value otherwise. + +### GetAppIdOk + +`func (o *AccessProfileDetails) GetAppIdOk() (*int64, bool)` + +GetAppIdOk returns a tuple with the AppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppId + +`func (o *AccessProfileDetails) SetAppId(v int64)` + +SetAppId sets AppId field to given value. + +### HasAppId + +`func (o *AccessProfileDetails) HasAppId() bool` + +HasAppId returns a boolean if a field has been set. + +### SetAppIdNil + +`func (o *AccessProfileDetails) SetAppIdNil(b bool)` + + SetAppIdNil sets the value for AppId to be an explicit nil + +### UnsetAppId +`func (o *AccessProfileDetails) UnsetAppId()` + +UnsetAppId ensures that no value is present for AppId, not even an explicit nil +### GetAppName + +`func (o *AccessProfileDetails) GetAppName() string` + +GetAppName returns the AppName field if non-nil, zero value otherwise. + +### GetAppNameOk + +`func (o *AccessProfileDetails) GetAppNameOk() (*string, bool)` + +GetAppNameOk returns a tuple with the AppName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppName + +`func (o *AccessProfileDetails) SetAppName(v string)` + +SetAppName sets AppName field to given value. + +### HasAppName + +`func (o *AccessProfileDetails) HasAppName() bool` + +HasAppName returns a boolean if a field has been set. + +### SetAppNameNil + +`func (o *AccessProfileDetails) SetAppNameNil(b bool)` + + SetAppNameNil sets the value for AppName to be an explicit nil + +### UnsetAppName +`func (o *AccessProfileDetails) UnsetAppName()` + +UnsetAppName ensures that no value is present for AppName, not even an explicit nil +### GetApplicationId + +`func (o *AccessProfileDetails) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *AccessProfileDetails) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *AccessProfileDetails) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *AccessProfileDetails) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessProfileDetails) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileDetails) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileDetails) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileDetails) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetEntitlements + +`func (o *AccessProfileDetails) GetEntitlements() []string` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *AccessProfileDetails) GetEntitlementsOk() (*[]string, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *AccessProfileDetails) SetEntitlements(v []string)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *AccessProfileDetails) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccessProfileDetails) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccessProfileDetails) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccessProfileDetails) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccessProfileDetails) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetSegments + +`func (o *AccessProfileDetails) GetSegments() []string` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *AccessProfileDetails) GetSegmentsOk() (*[]string, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *AccessProfileDetails) SetSegments(v []string)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *AccessProfileDetails) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### GetApprovalSchemes + +`func (o *AccessProfileDetails) GetApprovalSchemes() string` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *AccessProfileDetails) GetApprovalSchemesOk() (*string, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *AccessProfileDetails) SetApprovalSchemes(v string)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *AccessProfileDetails) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + +### GetRevokeRequestApprovalSchemes + +`func (o *AccessProfileDetails) GetRevokeRequestApprovalSchemes() string` + +GetRevokeRequestApprovalSchemes returns the RevokeRequestApprovalSchemes field if non-nil, zero value otherwise. + +### GetRevokeRequestApprovalSchemesOk + +`func (o *AccessProfileDetails) GetRevokeRequestApprovalSchemesOk() (*string, bool)` + +GetRevokeRequestApprovalSchemesOk returns a tuple with the RevokeRequestApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevokeRequestApprovalSchemes + +`func (o *AccessProfileDetails) SetRevokeRequestApprovalSchemes(v string)` + +SetRevokeRequestApprovalSchemes sets RevokeRequestApprovalSchemes field to given value. + +### HasRevokeRequestApprovalSchemes + +`func (o *AccessProfileDetails) HasRevokeRequestApprovalSchemes() bool` + +HasRevokeRequestApprovalSchemes returns a boolean if a field has been set. + +### GetRequestCommentsRequired + +`func (o *AccessProfileDetails) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *AccessProfileDetails) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *AccessProfileDetails) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *AccessProfileDetails) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + +### GetDeniedCommentsRequired + +`func (o *AccessProfileDetails) GetDeniedCommentsRequired() bool` + +GetDeniedCommentsRequired returns the DeniedCommentsRequired field if non-nil, zero value otherwise. + +### GetDeniedCommentsRequiredOk + +`func (o *AccessProfileDetails) GetDeniedCommentsRequiredOk() (*bool, bool)` + +GetDeniedCommentsRequiredOk returns a tuple with the DeniedCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeniedCommentsRequired + +`func (o *AccessProfileDetails) SetDeniedCommentsRequired(v bool)` + +SetDeniedCommentsRequired sets DeniedCommentsRequired field to given value. + +### HasDeniedCommentsRequired + +`func (o *AccessProfileDetails) HasDeniedCommentsRequired() bool` + +HasDeniedCommentsRequired returns a boolean if a field has been set. + +### GetAccountSelector + +`func (o *AccessProfileDetails) GetAccountSelector() AccessProfileDetailsAccountSelector` + +GetAccountSelector returns the AccountSelector field if non-nil, zero value otherwise. + +### GetAccountSelectorOk + +`func (o *AccessProfileDetails) GetAccountSelectorOk() (*AccessProfileDetailsAccountSelector, bool)` + +GetAccountSelectorOk returns a tuple with the AccountSelector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSelector + +`func (o *AccessProfileDetails) SetAccountSelector(v AccessProfileDetailsAccountSelector)` + +SetAccountSelector sets AccountSelector field to given value. + +### HasAccountSelector + +`func (o *AccessProfileDetails) HasAccountSelector() bool` + +HasAccountSelector returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileDetailsAccountSelector.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileDetailsAccountSelector.md new file mode 100644 index 000000000..d9063c479 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileDetailsAccountSelector.md @@ -0,0 +1,74 @@ +--- +id: v2025-access-profile-details-account-selector +title: AccessProfileDetailsAccountSelector +pagination_label: AccessProfileDetailsAccountSelector +sidebar_label: AccessProfileDetailsAccountSelector +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileDetailsAccountSelector', 'V2025AccessProfileDetailsAccountSelector'] +slug: /tools/sdk/go/v2025/models/access-profile-details-account-selector +tags: ['SDK', 'Software Development Kit', 'AccessProfileDetailsAccountSelector', 'V2025AccessProfileDetailsAccountSelector'] +--- + +# AccessProfileDetailsAccountSelector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Selectors** | Pointer to [**[]Selector**](selector) | | [optional] + +## Methods + +### NewAccessProfileDetailsAccountSelector + +`func NewAccessProfileDetailsAccountSelector() *AccessProfileDetailsAccountSelector` + +NewAccessProfileDetailsAccountSelector instantiates a new AccessProfileDetailsAccountSelector 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 + +### NewAccessProfileDetailsAccountSelectorWithDefaults + +`func NewAccessProfileDetailsAccountSelectorWithDefaults() *AccessProfileDetailsAccountSelector` + +NewAccessProfileDetailsAccountSelectorWithDefaults instantiates a new AccessProfileDetailsAccountSelector 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 + +### GetSelectors + +`func (o *AccessProfileDetailsAccountSelector) GetSelectors() []Selector` + +GetSelectors returns the Selectors field if non-nil, zero value otherwise. + +### GetSelectorsOk + +`func (o *AccessProfileDetailsAccountSelector) GetSelectorsOk() (*[]Selector, bool)` + +GetSelectorsOk returns a tuple with the Selectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectors + +`func (o *AccessProfileDetailsAccountSelector) SetSelectors(v []Selector)` + +SetSelectors sets Selectors field to given value. + +### HasSelectors + +`func (o *AccessProfileDetailsAccountSelector) HasSelectors() bool` + +HasSelectors returns a boolean if a field has been set. + +### SetSelectorsNil + +`func (o *AccessProfileDetailsAccountSelector) SetSelectorsNil(b bool)` + + SetSelectorsNil sets the value for Selectors to be an explicit nil + +### UnsetSelectors +`func (o *AccessProfileDetailsAccountSelector) UnsetSelectors()` + +UnsetSelectors ensures that no value is present for Selectors, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileDocument.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileDocument.md new file mode 100644 index 000000000..29c92206d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileDocument.md @@ -0,0 +1,500 @@ +--- +id: v2025-access-profile-document +title: AccessProfileDocument +pagination_label: AccessProfileDocument +sidebar_label: AccessProfileDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileDocument', 'V2025AccessProfileDocument'] +slug: /tools/sdk/go/v2025/models/access-profile-document +tags: ['SDK', 'Software Development Kit', 'AccessProfileDocument', 'V2025AccessProfileDocument'] +--- + +# AccessProfileDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Access item's description. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **NullableTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Enabled** | Pointer to **bool** | Indicates whether the access item is currently enabled. | [optional] [default to false] +**Requestable** | Pointer to **bool** | Indicates whether the access item can be requested. | [optional] [default to true] +**RequestCommentsRequired** | Pointer to **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to false] +**Owner** | Pointer to [**BaseAccessOwner**](base-access-owner) | | [optional] +**Id** | **string** | Access profile's ID. | +**Name** | **string** | Access profile's name. | +**Source** | Pointer to [**AccessProfileDocumentAllOfSource**](access-profile-document-all-of-source) | | [optional] +**Entitlements** | Pointer to [**[]BaseEntitlement**](base-entitlement) | Entitlements the access profile has access to. | [optional] +**EntitlementCount** | Pointer to **int32** | Number of entitlements. | [optional] +**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the access profile. | [optional] +**SegmentCount** | Pointer to **int32** | Number of segments with the access profile. | [optional] +**Tags** | Pointer to **[]string** | Tags that have been applied to the object. | [optional] +**Apps** | Pointer to [**[]AccessApps**](access-apps) | Applications with the access profile | [optional] + +## Methods + +### NewAccessProfileDocument + +`func NewAccessProfileDocument(id string, name string, ) *AccessProfileDocument` + +NewAccessProfileDocument instantiates a new AccessProfileDocument 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 + +### NewAccessProfileDocumentWithDefaults + +`func NewAccessProfileDocumentWithDefaults() *AccessProfileDocument` + +NewAccessProfileDocumentWithDefaults instantiates a new AccessProfileDocument 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 + +### GetDescription + +`func (o *AccessProfileDocument) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileDocument) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileDocument) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileDocument) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetCreated + +`func (o *AccessProfileDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccessProfileDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccessProfileDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccessProfileDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *AccessProfileDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *AccessProfileDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *AccessProfileDocument) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccessProfileDocument) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccessProfileDocument) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccessProfileDocument) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *AccessProfileDocument) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *AccessProfileDocument) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *AccessProfileDocument) GetSynced() SailPointTime` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *AccessProfileDocument) GetSyncedOk() (*SailPointTime, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *AccessProfileDocument) SetSynced(v SailPointTime)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *AccessProfileDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### SetSyncedNil + +`func (o *AccessProfileDocument) SetSyncedNil(b bool)` + + SetSyncedNil sets the value for Synced to be an explicit nil + +### UnsetSynced +`func (o *AccessProfileDocument) UnsetSynced()` + +UnsetSynced ensures that no value is present for Synced, not even an explicit nil +### GetEnabled + +`func (o *AccessProfileDocument) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AccessProfileDocument) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AccessProfileDocument) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *AccessProfileDocument) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetRequestable + +`func (o *AccessProfileDocument) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *AccessProfileDocument) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *AccessProfileDocument) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *AccessProfileDocument) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetRequestCommentsRequired + +`func (o *AccessProfileDocument) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *AccessProfileDocument) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *AccessProfileDocument) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *AccessProfileDocument) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + +### GetOwner + +`func (o *AccessProfileDocument) GetOwner() BaseAccessOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *AccessProfileDocument) GetOwnerOk() (*BaseAccessOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *AccessProfileDocument) SetOwner(v BaseAccessOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *AccessProfileDocument) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetId + +`func (o *AccessProfileDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileDocument) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessProfileDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileDocument) SetName(v string)` + +SetName sets Name field to given value. + + +### GetSource + +`func (o *AccessProfileDocument) GetSource() AccessProfileDocumentAllOfSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccessProfileDocument) GetSourceOk() (*AccessProfileDocumentAllOfSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccessProfileDocument) SetSource(v AccessProfileDocumentAllOfSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *AccessProfileDocument) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetEntitlements + +`func (o *AccessProfileDocument) GetEntitlements() []BaseEntitlement` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *AccessProfileDocument) GetEntitlementsOk() (*[]BaseEntitlement, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *AccessProfileDocument) SetEntitlements(v []BaseEntitlement)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *AccessProfileDocument) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccessProfileDocument) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccessProfileDocument) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccessProfileDocument) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccessProfileDocument) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetSegments + +`func (o *AccessProfileDocument) GetSegments() []BaseSegment` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *AccessProfileDocument) GetSegmentsOk() (*[]BaseSegment, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *AccessProfileDocument) SetSegments(v []BaseSegment)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *AccessProfileDocument) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### GetSegmentCount + +`func (o *AccessProfileDocument) GetSegmentCount() int32` + +GetSegmentCount returns the SegmentCount field if non-nil, zero value otherwise. + +### GetSegmentCountOk + +`func (o *AccessProfileDocument) GetSegmentCountOk() (*int32, bool)` + +GetSegmentCountOk returns a tuple with the SegmentCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegmentCount + +`func (o *AccessProfileDocument) SetSegmentCount(v int32)` + +SetSegmentCount sets SegmentCount field to given value. + +### HasSegmentCount + +`func (o *AccessProfileDocument) HasSegmentCount() bool` + +HasSegmentCount returns a boolean if a field has been set. + +### GetTags + +`func (o *AccessProfileDocument) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *AccessProfileDocument) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *AccessProfileDocument) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *AccessProfileDocument) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetApps + +`func (o *AccessProfileDocument) GetApps() []AccessApps` + +GetApps returns the Apps field if non-nil, zero value otherwise. + +### GetAppsOk + +`func (o *AccessProfileDocument) GetAppsOk() (*[]AccessApps, bool)` + +GetAppsOk returns a tuple with the Apps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApps + +`func (o *AccessProfileDocument) SetApps(v []AccessApps)` + +SetApps sets Apps field to given value. + +### HasApps + +`func (o *AccessProfileDocument) HasApps() bool` + +HasApps returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileDocumentAllOfSource.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileDocumentAllOfSource.md new file mode 100644 index 000000000..d83427b45 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileDocumentAllOfSource.md @@ -0,0 +1,90 @@ +--- +id: v2025-access-profile-document-all-of-source +title: AccessProfileDocumentAllOfSource +pagination_label: AccessProfileDocumentAllOfSource +sidebar_label: AccessProfileDocumentAllOfSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileDocumentAllOfSource', 'V2025AccessProfileDocumentAllOfSource'] +slug: /tools/sdk/go/v2025/models/access-profile-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'AccessProfileDocumentAllOfSource', 'V2025AccessProfileDocumentAllOfSource'] +--- + +# AccessProfileDocumentAllOfSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Source's ID. | [optional] +**Name** | Pointer to **string** | Source's name. | [optional] + +## Methods + +### NewAccessProfileDocumentAllOfSource + +`func NewAccessProfileDocumentAllOfSource() *AccessProfileDocumentAllOfSource` + +NewAccessProfileDocumentAllOfSource instantiates a new AccessProfileDocumentAllOfSource 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 + +### NewAccessProfileDocumentAllOfSourceWithDefaults + +`func NewAccessProfileDocumentAllOfSourceWithDefaults() *AccessProfileDocumentAllOfSource` + +NewAccessProfileDocumentAllOfSourceWithDefaults instantiates a new AccessProfileDocumentAllOfSource 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 + +### GetId + +`func (o *AccessProfileDocumentAllOfSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileDocumentAllOfSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileDocumentAllOfSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileDocumentAllOfSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileDocumentAllOfSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileDocumentAllOfSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileDocumentAllOfSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileDocumentAllOfSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileEntitlement.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileEntitlement.md new file mode 100644 index 000000000..1fa50f631 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileEntitlement.md @@ -0,0 +1,308 @@ +--- +id: v2025-access-profile-entitlement +title: AccessProfileEntitlement +pagination_label: AccessProfileEntitlement +sidebar_label: AccessProfileEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileEntitlement', 'V2025AccessProfileEntitlement'] +slug: /tools/sdk/go/v2025/models/access-profile-entitlement +tags: ['SDK', 'Software Development Kit', 'AccessProfileEntitlement', 'V2025AccessProfileEntitlement'] +--- + +# AccessProfileEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Source** | Pointer to [**Reference**](reference) | | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Privileged** | Pointer to **bool** | | [optional] +**Attribute** | Pointer to **string** | | [optional] +**Value** | Pointer to **string** | | [optional] +**Standalone** | Pointer to **bool** | | [optional] + +## Methods + +### NewAccessProfileEntitlement + +`func NewAccessProfileEntitlement() *AccessProfileEntitlement` + +NewAccessProfileEntitlement instantiates a new AccessProfileEntitlement 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 + +### NewAccessProfileEntitlementWithDefaults + +`func NewAccessProfileEntitlementWithDefaults() *AccessProfileEntitlement` + +NewAccessProfileEntitlementWithDefaults instantiates a new AccessProfileEntitlement 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 + +### GetId + +`func (o *AccessProfileEntitlement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileEntitlement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileEntitlement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileEntitlement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileEntitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileEntitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileEntitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileEntitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessProfileEntitlement) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessProfileEntitlement) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessProfileEntitlement) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessProfileEntitlement) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessProfileEntitlement) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileEntitlement) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileEntitlement) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileEntitlement) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessProfileEntitlement) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessProfileEntitlement) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSource + +`func (o *AccessProfileEntitlement) GetSource() Reference` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccessProfileEntitlement) GetSourceOk() (*Reference, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccessProfileEntitlement) SetSource(v Reference)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *AccessProfileEntitlement) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetType + +`func (o *AccessProfileEntitlement) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileEntitlement) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileEntitlement) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileEntitlement) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *AccessProfileEntitlement) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *AccessProfileEntitlement) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *AccessProfileEntitlement) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *AccessProfileEntitlement) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetAttribute + +`func (o *AccessProfileEntitlement) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *AccessProfileEntitlement) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *AccessProfileEntitlement) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *AccessProfileEntitlement) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *AccessProfileEntitlement) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AccessProfileEntitlement) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AccessProfileEntitlement) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AccessProfileEntitlement) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetStandalone + +`func (o *AccessProfileEntitlement) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *AccessProfileEntitlement) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *AccessProfileEntitlement) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + +### HasStandalone + +`func (o *AccessProfileEntitlement) HasStandalone() bool` + +HasStandalone returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileRef.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileRef.md new file mode 100644 index 000000000..a12892330 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileRef.md @@ -0,0 +1,116 @@ +--- +id: v2025-access-profile-ref +title: AccessProfileRef +pagination_label: AccessProfileRef +sidebar_label: AccessProfileRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileRef', 'V2025AccessProfileRef'] +slug: /tools/sdk/go/v2025/models/access-profile-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'V2025AccessProfileRef'] +--- + +# AccessProfileRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the Access Profile | [optional] +**Type** | Pointer to **string** | Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result. | [optional] +**Name** | Pointer to **string** | Human-readable display name of the Access Profile. This field is ignored on input. | [optional] + +## Methods + +### NewAccessProfileRef + +`func NewAccessProfileRef() *AccessProfileRef` + +NewAccessProfileRef instantiates a new AccessProfileRef 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 + +### NewAccessProfileRefWithDefaults + +`func NewAccessProfileRefWithDefaults() *AccessProfileRef` + +NewAccessProfileRefWithDefaults instantiates a new AccessProfileRef 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 + +### GetId + +`func (o *AccessProfileRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessProfileRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileRole.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileRole.md new file mode 100644 index 000000000..cc9438776 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileRole.md @@ -0,0 +1,256 @@ +--- +id: v2025-access-profile-role +title: AccessProfileRole +pagination_label: AccessProfileRole +sidebar_label: AccessProfileRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileRole', 'V2025AccessProfileRole'] +slug: /tools/sdk/go/v2025/models/access-profile-role +tags: ['SDK', 'Software Development Kit', 'AccessProfileRole', 'V2025AccessProfileRole'] +--- + +# AccessProfileRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional] +**Disabled** | Pointer to **bool** | | [optional] +**Revocable** | Pointer to **bool** | | [optional] + +## Methods + +### NewAccessProfileRole + +`func NewAccessProfileRole() *AccessProfileRole` + +NewAccessProfileRole instantiates a new AccessProfileRole 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 + +### NewAccessProfileRoleWithDefaults + +`func NewAccessProfileRoleWithDefaults() *AccessProfileRole` + +NewAccessProfileRoleWithDefaults instantiates a new AccessProfileRole 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 + +### GetId + +`func (o *AccessProfileRole) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileRole) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileRole) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileRole) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileRole) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileRole) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileRole) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileRole) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessProfileRole) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessProfileRole) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessProfileRole) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessProfileRole) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessProfileRole) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileRole) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileRole) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileRole) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessProfileRole) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessProfileRole) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *AccessProfileRole) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileRole) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileRole) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileRole) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetOwner + +`func (o *AccessProfileRole) GetOwner() DisplayReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *AccessProfileRole) GetOwnerOk() (*DisplayReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *AccessProfileRole) SetOwner(v DisplayReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *AccessProfileRole) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDisabled + +`func (o *AccessProfileRole) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *AccessProfileRole) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *AccessProfileRole) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *AccessProfileRole) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetRevocable + +`func (o *AccessProfileRole) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *AccessProfileRole) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *AccessProfileRole) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *AccessProfileRole) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileSourceRef.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileSourceRef.md new file mode 100644 index 000000000..a56622ebc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileSourceRef.md @@ -0,0 +1,116 @@ +--- +id: v2025-access-profile-source-ref +title: AccessProfileSourceRef +pagination_label: AccessProfileSourceRef +sidebar_label: AccessProfileSourceRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileSourceRef', 'V2025AccessProfileSourceRef'] +slug: /tools/sdk/go/v2025/models/access-profile-source-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'V2025AccessProfileSourceRef'] +--- + +# AccessProfileSourceRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the source the access profile is associated with. | [optional] +**Type** | Pointer to **string** | Source's DTO type. | [optional] +**Name** | Pointer to **string** | Source name. | [optional] + +## Methods + +### NewAccessProfileSourceRef + +`func NewAccessProfileSourceRef() *AccessProfileSourceRef` + +NewAccessProfileSourceRef instantiates a new AccessProfileSourceRef 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 + +### NewAccessProfileSourceRefWithDefaults + +`func NewAccessProfileSourceRefWithDefaults() *AccessProfileSourceRef` + +NewAccessProfileSourceRefWithDefaults instantiates a new AccessProfileSourceRef 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 + +### GetId + +`func (o *AccessProfileSourceRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileSourceRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileSourceRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileSourceRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessProfileSourceRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileSourceRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileSourceRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileSourceRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileSourceRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileSourceRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileSourceRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileSourceRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileSummary.md new file mode 100644 index 000000000..52a150ada --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileSummary.md @@ -0,0 +1,256 @@ +--- +id: v2025-access-profile-summary +title: AccessProfileSummary +pagination_label: AccessProfileSummary +sidebar_label: AccessProfileSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileSummary', 'V2025AccessProfileSummary'] +slug: /tools/sdk/go/v2025/models/access-profile-summary +tags: ['SDK', 'Software Development Kit', 'AccessProfileSummary', 'V2025AccessProfileSummary'] +--- + +# AccessProfileSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Source** | Pointer to [**Reference**](reference) | | [optional] +**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional] +**Revocable** | Pointer to **bool** | | [optional] + +## Methods + +### NewAccessProfileSummary + +`func NewAccessProfileSummary() *AccessProfileSummary` + +NewAccessProfileSummary instantiates a new AccessProfileSummary 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 + +### NewAccessProfileSummaryWithDefaults + +`func NewAccessProfileSummaryWithDefaults() *AccessProfileSummary` + +NewAccessProfileSummaryWithDefaults instantiates a new AccessProfileSummary 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 + +### GetId + +`func (o *AccessProfileSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileSummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileSummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileSummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileSummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileSummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileSummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessProfileSummary) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessProfileSummary) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessProfileSummary) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessProfileSummary) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessProfileSummary) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileSummary) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileSummary) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileSummary) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessProfileSummary) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessProfileSummary) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *AccessProfileSummary) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileSummary) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileSummary) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSource + +`func (o *AccessProfileSummary) GetSource() Reference` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccessProfileSummary) GetSourceOk() (*Reference, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccessProfileSummary) SetSource(v Reference)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *AccessProfileSummary) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetOwner + +`func (o *AccessProfileSummary) GetOwner() DisplayReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *AccessProfileSummary) GetOwnerOk() (*DisplayReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *AccessProfileSummary) SetOwner(v DisplayReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *AccessProfileSummary) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRevocable + +`func (o *AccessProfileSummary) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *AccessProfileSummary) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *AccessProfileSummary) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *AccessProfileSummary) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileUpdateItem.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileUpdateItem.md new file mode 100644 index 000000000..48aa1583e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileUpdateItem.md @@ -0,0 +1,127 @@ +--- +id: v2025-access-profile-update-item +title: AccessProfileUpdateItem +pagination_label: AccessProfileUpdateItem +sidebar_label: AccessProfileUpdateItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileUpdateItem', 'V2025AccessProfileUpdateItem'] +slug: /tools/sdk/go/v2025/models/access-profile-update-item +tags: ['SDK', 'Software Development Kit', 'AccessProfileUpdateItem', 'V2025AccessProfileUpdateItem'] +--- + +# AccessProfileUpdateItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Identifier of Access Profile in bulk update request. | +**Requestable** | **bool** | Access Profile requestable or not. | +**Status** | **string** | The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. | +**Description** | Pointer to **string** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Methods + +### NewAccessProfileUpdateItem + +`func NewAccessProfileUpdateItem(id string, requestable bool, status string, ) *AccessProfileUpdateItem` + +NewAccessProfileUpdateItem instantiates a new AccessProfileUpdateItem 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 + +### NewAccessProfileUpdateItemWithDefaults + +`func NewAccessProfileUpdateItemWithDefaults() *AccessProfileUpdateItem` + +NewAccessProfileUpdateItemWithDefaults instantiates a new AccessProfileUpdateItem 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 + +### GetId + +`func (o *AccessProfileUpdateItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileUpdateItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileUpdateItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetRequestable + +`func (o *AccessProfileUpdateItem) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *AccessProfileUpdateItem) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *AccessProfileUpdateItem) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + + +### GetStatus + +`func (o *AccessProfileUpdateItem) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccessProfileUpdateItem) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccessProfileUpdateItem) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetDescription + +`func (o *AccessProfileUpdateItem) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileUpdateItem) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileUpdateItem) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileUpdateItem) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileUsage.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileUsage.md new file mode 100644 index 000000000..13a3c3aed --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileUsage.md @@ -0,0 +1,90 @@ +--- +id: v2025-access-profile-usage +title: AccessProfileUsage +pagination_label: AccessProfileUsage +sidebar_label: AccessProfileUsage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileUsage', 'V2025AccessProfileUsage'] +slug: /tools/sdk/go/v2025/models/access-profile-usage +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'V2025AccessProfileUsage'] +--- + +# AccessProfileUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessProfileId** | Pointer to **string** | ID of the Access Profile that is in use | [optional] +**UsedBy** | Pointer to [**[]AccessProfileUsageUsedByInner**](access-profile-usage-used-by-inner) | List of references to objects which are using the indicated Access Profile | [optional] + +## Methods + +### NewAccessProfileUsage + +`func NewAccessProfileUsage() *AccessProfileUsage` + +NewAccessProfileUsage instantiates a new AccessProfileUsage 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 + +### NewAccessProfileUsageWithDefaults + +`func NewAccessProfileUsageWithDefaults() *AccessProfileUsage` + +NewAccessProfileUsageWithDefaults instantiates a new AccessProfileUsage 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 + +### GetAccessProfileId + +`func (o *AccessProfileUsage) GetAccessProfileId() string` + +GetAccessProfileId returns the AccessProfileId field if non-nil, zero value otherwise. + +### GetAccessProfileIdOk + +`func (o *AccessProfileUsage) GetAccessProfileIdOk() (*string, bool)` + +GetAccessProfileIdOk returns a tuple with the AccessProfileId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileId + +`func (o *AccessProfileUsage) SetAccessProfileId(v string)` + +SetAccessProfileId sets AccessProfileId field to given value. + +### HasAccessProfileId + +`func (o *AccessProfileUsage) HasAccessProfileId() bool` + +HasAccessProfileId returns a boolean if a field has been set. + +### GetUsedBy + +`func (o *AccessProfileUsage) GetUsedBy() []AccessProfileUsageUsedByInner` + +GetUsedBy returns the UsedBy field if non-nil, zero value otherwise. + +### GetUsedByOk + +`func (o *AccessProfileUsage) GetUsedByOk() (*[]AccessProfileUsageUsedByInner, bool)` + +GetUsedByOk returns a tuple with the UsedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsedBy + +`func (o *AccessProfileUsage) SetUsedBy(v []AccessProfileUsageUsedByInner)` + +SetUsedBy sets UsedBy field to given value. + +### HasUsedBy + +`func (o *AccessProfileUsage) HasUsedBy() bool` + +HasUsedBy returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileUsageUsedByInner.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileUsageUsedByInner.md new file mode 100644 index 000000000..d86b25170 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessProfileUsageUsedByInner.md @@ -0,0 +1,116 @@ +--- +id: v2025-access-profile-usage-used-by-inner +title: AccessProfileUsageUsedByInner +pagination_label: AccessProfileUsageUsedByInner +sidebar_label: AccessProfileUsageUsedByInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileUsageUsedByInner', 'V2025AccessProfileUsageUsedByInner'] +slug: /tools/sdk/go/v2025/models/access-profile-usage-used-by-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner', 'V2025AccessProfileUsageUsedByInner'] +--- + +# AccessProfileUsageUsedByInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of role using the access profile. | [optional] +**Id** | Pointer to **string** | ID of role using the access profile. | [optional] +**Name** | Pointer to **string** | Display name of role using the access profile. | [optional] + +## Methods + +### NewAccessProfileUsageUsedByInner + +`func NewAccessProfileUsageUsedByInner() *AccessProfileUsageUsedByInner` + +NewAccessProfileUsageUsedByInner instantiates a new AccessProfileUsageUsedByInner 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 + +### NewAccessProfileUsageUsedByInnerWithDefaults + +`func NewAccessProfileUsageUsedByInnerWithDefaults() *AccessProfileUsageUsedByInner` + +NewAccessProfileUsageUsedByInnerWithDefaults instantiates a new AccessProfileUsageUsedByInner 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 + +### GetType + +`func (o *AccessProfileUsageUsedByInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileUsageUsedByInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileUsageUsedByInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileUsageUsedByInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessProfileUsageUsedByInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileUsageUsedByInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileUsageUsedByInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileUsageUsedByInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileUsageUsedByInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileUsageUsedByInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileUsageUsedByInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileUsageUsedByInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRecommendationMessage.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRecommendationMessage.md new file mode 100644 index 000000000..1655ef956 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRecommendationMessage.md @@ -0,0 +1,64 @@ +--- +id: v2025-access-recommendation-message +title: AccessRecommendationMessage +pagination_label: AccessRecommendationMessage +sidebar_label: AccessRecommendationMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRecommendationMessage', 'V2025AccessRecommendationMessage'] +slug: /tools/sdk/go/v2025/models/access-recommendation-message +tags: ['SDK', 'Software Development Kit', 'AccessRecommendationMessage', 'V2025AccessRecommendationMessage'] +--- + +# AccessRecommendationMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Interpretation** | Pointer to **string** | Information about why the access item was recommended. | [optional] + +## Methods + +### NewAccessRecommendationMessage + +`func NewAccessRecommendationMessage() *AccessRecommendationMessage` + +NewAccessRecommendationMessage instantiates a new AccessRecommendationMessage 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 + +### NewAccessRecommendationMessageWithDefaults + +`func NewAccessRecommendationMessageWithDefaults() *AccessRecommendationMessage` + +NewAccessRecommendationMessageWithDefaults instantiates a new AccessRecommendationMessage 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 + +### GetInterpretation + +`func (o *AccessRecommendationMessage) GetInterpretation() string` + +GetInterpretation returns the Interpretation field if non-nil, zero value otherwise. + +### GetInterpretationOk + +`func (o *AccessRecommendationMessage) GetInterpretationOk() (*string, bool)` + +GetInterpretationOk returns a tuple with the Interpretation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterpretation + +`func (o *AccessRecommendationMessage) SetInterpretation(v string)` + +SetInterpretation sets Interpretation field to given value. + +### HasInterpretation + +`func (o *AccessRecommendationMessage) HasInterpretation() bool` + +HasInterpretation returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequest.md new file mode 100644 index 000000000..e96520864 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequest.md @@ -0,0 +1,178 @@ +--- +id: v2025-access-request +title: AccessRequest +pagination_label: AccessRequest +sidebar_label: AccessRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequest', 'V2025AccessRequest'] +slug: /tools/sdk/go/v2025/models/access-request +tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'V2025AccessRequest'] +--- + +# AccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedFor** | **[]string** | A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. | +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**RequestedForWithRequestedItems** | Pointer to [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] + +## Methods + +### NewAccessRequest + +`func NewAccessRequest(requestedFor []string, requestedItems []AccessRequestItem, ) *AccessRequest` + +NewAccessRequest instantiates a new AccessRequest 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 + +### NewAccessRequestWithDefaults + +`func NewAccessRequestWithDefaults() *AccessRequest` + +NewAccessRequestWithDefaults instantiates a new AccessRequest 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 + +### GetRequestedFor + +`func (o *AccessRequest) GetRequestedFor() []string` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequest) GetRequestedForOk() (*[]string, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequest) SetRequestedFor(v []string)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestType + +`func (o *AccessRequest) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *AccessRequest) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *AccessRequest) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *AccessRequest) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *AccessRequest) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *AccessRequest) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetRequestedItems + +`func (o *AccessRequest) GetRequestedItems() []AccessRequestItem` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *AccessRequest) GetRequestedItemsOk() (*[]AccessRequestItem, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *AccessRequest) SetRequestedItems(v []AccessRequestItem)` + +SetRequestedItems sets RequestedItems field to given value. + + +### GetClientMetadata + +`func (o *AccessRequest) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccessRequest) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccessRequest) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccessRequest) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRequestedForWithRequestedItems + +`func (o *AccessRequest) GetRequestedForWithRequestedItems() []RequestedForDtoRef` + +GetRequestedForWithRequestedItems returns the RequestedForWithRequestedItems field if non-nil, zero value otherwise. + +### GetRequestedForWithRequestedItemsOk + +`func (o *AccessRequest) GetRequestedForWithRequestedItemsOk() (*[]RequestedForDtoRef, bool)` + +GetRequestedForWithRequestedItemsOk returns a tuple with the RequestedForWithRequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedForWithRequestedItems + +`func (o *AccessRequest) SetRequestedForWithRequestedItems(v []RequestedForDtoRef)` + +SetRequestedForWithRequestedItems sets RequestedForWithRequestedItems field to given value. + +### HasRequestedForWithRequestedItems + +`func (o *AccessRequest) HasRequestedForWithRequestedItems() bool` + +HasRequestedForWithRequestedItems returns a boolean if a field has been set. + +### SetRequestedForWithRequestedItemsNil + +`func (o *AccessRequest) SetRequestedForWithRequestedItemsNil(b bool)` + + SetRequestedForWithRequestedItemsNil sets the value for RequestedForWithRequestedItems to be an explicit nil + +### UnsetRequestedForWithRequestedItems +`func (o *AccessRequest) UnsetRequestedForWithRequestedItems()` + +UnsetRequestedForWithRequestedItems ensures that no value is present for RequestedForWithRequestedItems, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestAdminItemStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestAdminItemStatus.md new file mode 100644 index 000000000..e3dfbda0a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestAdminItemStatus.md @@ -0,0 +1,798 @@ +--- +id: v2025-access-request-admin-item-status +title: AccessRequestAdminItemStatus +pagination_label: AccessRequestAdminItemStatus +sidebar_label: AccessRequestAdminItemStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestAdminItemStatus', 'V2025AccessRequestAdminItemStatus'] +slug: /tools/sdk/go/v2025/models/access-request-admin-item-status +tags: ['SDK', 'Software Development Kit', 'AccessRequestAdminItemStatus', 'V2025AccessRequestAdminItemStatus'] +--- + +# AccessRequestAdminItemStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | ID of the access request. This is a new property as of 2025. Older access requests may not have an ID. | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the item being requested. | [optional] +**Type** | Pointer to **NullableString** | Type of requested object. | [optional] +**CancelledRequestDetails** | Pointer to [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional] +**ErrorMessages** | Pointer to [**[][]ErrorMessageDto**](error-message-dto) | List of localized error messages, if any, encountered during the approval/provisioning process. | [optional] +**State** | Pointer to [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional] +**ApprovalDetails** | Pointer to [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional] +**ManualWorkItemDetails** | Pointer to [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional] +**AccountActivityItemId** | Pointer to **string** | Id of associated account activity item. | [optional] +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**Modified** | Pointer to **NullableTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**RequesterComment** | Pointer to [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional] +**SodViolationContext** | Pointer to [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional] +**ProvisioningDetails** | Pointer to [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional] +**PreApprovalTriggerDetails** | Pointer to [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional] +**AccessRequestPhases** | Pointer to [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional] +**Description** | Pointer to **NullableString** | Description associated to the requested object. | [optional] +**RemoveDate** | Pointer to **NullableTime** | When the role access is scheduled for removal. | [optional] +**Cancelable** | Pointer to **bool** | True if the request can be canceled. | [optional] [default to false] +**ReauthorizationRequired** | Pointer to **bool** | True if re-auth is required. | [optional] [default to false] +**AccessRequestId** | Pointer to **string** | This is the account activity id. | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] + +## Methods + +### NewAccessRequestAdminItemStatus + +`func NewAccessRequestAdminItemStatus() *AccessRequestAdminItemStatus` + +NewAccessRequestAdminItemStatus instantiates a new AccessRequestAdminItemStatus 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 + +### NewAccessRequestAdminItemStatusWithDefaults + +`func NewAccessRequestAdminItemStatusWithDefaults() *AccessRequestAdminItemStatus` + +NewAccessRequestAdminItemStatusWithDefaults instantiates a new AccessRequestAdminItemStatus 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 + +### GetId + +`func (o *AccessRequestAdminItemStatus) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestAdminItemStatus) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestAdminItemStatus) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessRequestAdminItemStatus) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *AccessRequestAdminItemStatus) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *AccessRequestAdminItemStatus) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *AccessRequestAdminItemStatus) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestAdminItemStatus) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestAdminItemStatus) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessRequestAdminItemStatus) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *AccessRequestAdminItemStatus) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *AccessRequestAdminItemStatus) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetType + +`func (o *AccessRequestAdminItemStatus) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestAdminItemStatus) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestAdminItemStatus) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessRequestAdminItemStatus) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *AccessRequestAdminItemStatus) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *AccessRequestAdminItemStatus) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetCancelledRequestDetails + +`func (o *AccessRequestAdminItemStatus) GetCancelledRequestDetails() RequestedItemStatusCancelledRequestDetails` + +GetCancelledRequestDetails returns the CancelledRequestDetails field if non-nil, zero value otherwise. + +### GetCancelledRequestDetailsOk + +`func (o *AccessRequestAdminItemStatus) GetCancelledRequestDetailsOk() (*RequestedItemStatusCancelledRequestDetails, bool)` + +GetCancelledRequestDetailsOk returns a tuple with the CancelledRequestDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCancelledRequestDetails + +`func (o *AccessRequestAdminItemStatus) SetCancelledRequestDetails(v RequestedItemStatusCancelledRequestDetails)` + +SetCancelledRequestDetails sets CancelledRequestDetails field to given value. + +### HasCancelledRequestDetails + +`func (o *AccessRequestAdminItemStatus) HasCancelledRequestDetails() bool` + +HasCancelledRequestDetails returns a boolean if a field has been set. + +### GetErrorMessages + +`func (o *AccessRequestAdminItemStatus) GetErrorMessages() [][]ErrorMessageDto` + +GetErrorMessages returns the ErrorMessages field if non-nil, zero value otherwise. + +### GetErrorMessagesOk + +`func (o *AccessRequestAdminItemStatus) GetErrorMessagesOk() (*[][]ErrorMessageDto, bool)` + +GetErrorMessagesOk returns a tuple with the ErrorMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessages + +`func (o *AccessRequestAdminItemStatus) SetErrorMessages(v [][]ErrorMessageDto)` + +SetErrorMessages sets ErrorMessages field to given value. + +### HasErrorMessages + +`func (o *AccessRequestAdminItemStatus) HasErrorMessages() bool` + +HasErrorMessages returns a boolean if a field has been set. + +### SetErrorMessagesNil + +`func (o *AccessRequestAdminItemStatus) SetErrorMessagesNil(b bool)` + + SetErrorMessagesNil sets the value for ErrorMessages to be an explicit nil + +### UnsetErrorMessages +`func (o *AccessRequestAdminItemStatus) UnsetErrorMessages()` + +UnsetErrorMessages ensures that no value is present for ErrorMessages, not even an explicit nil +### GetState + +`func (o *AccessRequestAdminItemStatus) GetState() RequestedItemStatusRequestState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *AccessRequestAdminItemStatus) GetStateOk() (*RequestedItemStatusRequestState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *AccessRequestAdminItemStatus) SetState(v RequestedItemStatusRequestState)` + +SetState sets State field to given value. + +### HasState + +`func (o *AccessRequestAdminItemStatus) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetApprovalDetails + +`func (o *AccessRequestAdminItemStatus) GetApprovalDetails() []ApprovalStatusDto` + +GetApprovalDetails returns the ApprovalDetails field if non-nil, zero value otherwise. + +### GetApprovalDetailsOk + +`func (o *AccessRequestAdminItemStatus) GetApprovalDetailsOk() (*[]ApprovalStatusDto, bool)` + +GetApprovalDetailsOk returns a tuple with the ApprovalDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalDetails + +`func (o *AccessRequestAdminItemStatus) SetApprovalDetails(v []ApprovalStatusDto)` + +SetApprovalDetails sets ApprovalDetails field to given value. + +### HasApprovalDetails + +`func (o *AccessRequestAdminItemStatus) HasApprovalDetails() bool` + +HasApprovalDetails returns a boolean if a field has been set. + +### GetManualWorkItemDetails + +`func (o *AccessRequestAdminItemStatus) GetManualWorkItemDetails() []ManualWorkItemDetails` + +GetManualWorkItemDetails returns the ManualWorkItemDetails field if non-nil, zero value otherwise. + +### GetManualWorkItemDetailsOk + +`func (o *AccessRequestAdminItemStatus) GetManualWorkItemDetailsOk() (*[]ManualWorkItemDetails, bool)` + +GetManualWorkItemDetailsOk returns a tuple with the ManualWorkItemDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManualWorkItemDetails + +`func (o *AccessRequestAdminItemStatus) SetManualWorkItemDetails(v []ManualWorkItemDetails)` + +SetManualWorkItemDetails sets ManualWorkItemDetails field to given value. + +### HasManualWorkItemDetails + +`func (o *AccessRequestAdminItemStatus) HasManualWorkItemDetails() bool` + +HasManualWorkItemDetails returns a boolean if a field has been set. + +### SetManualWorkItemDetailsNil + +`func (o *AccessRequestAdminItemStatus) SetManualWorkItemDetailsNil(b bool)` + + SetManualWorkItemDetailsNil sets the value for ManualWorkItemDetails to be an explicit nil + +### UnsetManualWorkItemDetails +`func (o *AccessRequestAdminItemStatus) UnsetManualWorkItemDetails()` + +UnsetManualWorkItemDetails ensures that no value is present for ManualWorkItemDetails, not even an explicit nil +### GetAccountActivityItemId + +`func (o *AccessRequestAdminItemStatus) GetAccountActivityItemId() string` + +GetAccountActivityItemId returns the AccountActivityItemId field if non-nil, zero value otherwise. + +### GetAccountActivityItemIdOk + +`func (o *AccessRequestAdminItemStatus) GetAccountActivityItemIdOk() (*string, bool)` + +GetAccountActivityItemIdOk returns a tuple with the AccountActivityItemId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActivityItemId + +`func (o *AccessRequestAdminItemStatus) SetAccountActivityItemId(v string)` + +SetAccountActivityItemId sets AccountActivityItemId field to given value. + +### HasAccountActivityItemId + +`func (o *AccessRequestAdminItemStatus) HasAccountActivityItemId() bool` + +HasAccountActivityItemId returns a boolean if a field has been set. + +### GetRequestType + +`func (o *AccessRequestAdminItemStatus) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *AccessRequestAdminItemStatus) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *AccessRequestAdminItemStatus) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *AccessRequestAdminItemStatus) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *AccessRequestAdminItemStatus) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *AccessRequestAdminItemStatus) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetModified + +`func (o *AccessRequestAdminItemStatus) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccessRequestAdminItemStatus) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccessRequestAdminItemStatus) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccessRequestAdminItemStatus) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *AccessRequestAdminItemStatus) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *AccessRequestAdminItemStatus) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetCreated + +`func (o *AccessRequestAdminItemStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccessRequestAdminItemStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccessRequestAdminItemStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccessRequestAdminItemStatus) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetRequester + +`func (o *AccessRequestAdminItemStatus) GetRequester() AccessItemRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *AccessRequestAdminItemStatus) GetRequesterOk() (*AccessItemRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *AccessRequestAdminItemStatus) SetRequester(v AccessItemRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *AccessRequestAdminItemStatus) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRequestedFor + +`func (o *AccessRequestAdminItemStatus) GetRequestedFor() RequestedItemStatusRequestedFor` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequestAdminItemStatus) GetRequestedForOk() (*RequestedItemStatusRequestedFor, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequestAdminItemStatus) SetRequestedFor(v RequestedItemStatusRequestedFor)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *AccessRequestAdminItemStatus) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *AccessRequestAdminItemStatus) GetRequesterComment() RequestedItemStatusRequesterComment` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *AccessRequestAdminItemStatus) GetRequesterCommentOk() (*RequestedItemStatusRequesterComment, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *AccessRequestAdminItemStatus) SetRequesterComment(v RequestedItemStatusRequesterComment)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *AccessRequestAdminItemStatus) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### GetSodViolationContext + +`func (o *AccessRequestAdminItemStatus) GetSodViolationContext() RequestedItemStatusSodViolationContext` + +GetSodViolationContext returns the SodViolationContext field if non-nil, zero value otherwise. + +### GetSodViolationContextOk + +`func (o *AccessRequestAdminItemStatus) GetSodViolationContextOk() (*RequestedItemStatusSodViolationContext, bool)` + +GetSodViolationContextOk returns a tuple with the SodViolationContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodViolationContext + +`func (o *AccessRequestAdminItemStatus) SetSodViolationContext(v RequestedItemStatusSodViolationContext)` + +SetSodViolationContext sets SodViolationContext field to given value. + +### HasSodViolationContext + +`func (o *AccessRequestAdminItemStatus) HasSodViolationContext() bool` + +HasSodViolationContext returns a boolean if a field has been set. + +### GetProvisioningDetails + +`func (o *AccessRequestAdminItemStatus) GetProvisioningDetails() RequestedItemStatusProvisioningDetails` + +GetProvisioningDetails returns the ProvisioningDetails field if non-nil, zero value otherwise. + +### GetProvisioningDetailsOk + +`func (o *AccessRequestAdminItemStatus) GetProvisioningDetailsOk() (*RequestedItemStatusProvisioningDetails, bool)` + +GetProvisioningDetailsOk returns a tuple with the ProvisioningDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningDetails + +`func (o *AccessRequestAdminItemStatus) SetProvisioningDetails(v RequestedItemStatusProvisioningDetails)` + +SetProvisioningDetails sets ProvisioningDetails field to given value. + +### HasProvisioningDetails + +`func (o *AccessRequestAdminItemStatus) HasProvisioningDetails() bool` + +HasProvisioningDetails returns a boolean if a field has been set. + +### GetPreApprovalTriggerDetails + +`func (o *AccessRequestAdminItemStatus) GetPreApprovalTriggerDetails() RequestedItemStatusPreApprovalTriggerDetails` + +GetPreApprovalTriggerDetails returns the PreApprovalTriggerDetails field if non-nil, zero value otherwise. + +### GetPreApprovalTriggerDetailsOk + +`func (o *AccessRequestAdminItemStatus) GetPreApprovalTriggerDetailsOk() (*RequestedItemStatusPreApprovalTriggerDetails, bool)` + +GetPreApprovalTriggerDetailsOk returns a tuple with the PreApprovalTriggerDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreApprovalTriggerDetails + +`func (o *AccessRequestAdminItemStatus) SetPreApprovalTriggerDetails(v RequestedItemStatusPreApprovalTriggerDetails)` + +SetPreApprovalTriggerDetails sets PreApprovalTriggerDetails field to given value. + +### HasPreApprovalTriggerDetails + +`func (o *AccessRequestAdminItemStatus) HasPreApprovalTriggerDetails() bool` + +HasPreApprovalTriggerDetails returns a boolean if a field has been set. + +### GetAccessRequestPhases + +`func (o *AccessRequestAdminItemStatus) GetAccessRequestPhases() []AccessRequestPhases` + +GetAccessRequestPhases returns the AccessRequestPhases field if non-nil, zero value otherwise. + +### GetAccessRequestPhasesOk + +`func (o *AccessRequestAdminItemStatus) GetAccessRequestPhasesOk() (*[]AccessRequestPhases, bool)` + +GetAccessRequestPhasesOk returns a tuple with the AccessRequestPhases field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestPhases + +`func (o *AccessRequestAdminItemStatus) SetAccessRequestPhases(v []AccessRequestPhases)` + +SetAccessRequestPhases sets AccessRequestPhases field to given value. + +### HasAccessRequestPhases + +`func (o *AccessRequestAdminItemStatus) HasAccessRequestPhases() bool` + +HasAccessRequestPhases returns a boolean if a field has been set. + +### SetAccessRequestPhasesNil + +`func (o *AccessRequestAdminItemStatus) SetAccessRequestPhasesNil(b bool)` + + SetAccessRequestPhasesNil sets the value for AccessRequestPhases to be an explicit nil + +### UnsetAccessRequestPhases +`func (o *AccessRequestAdminItemStatus) UnsetAccessRequestPhases()` + +UnsetAccessRequestPhases ensures that no value is present for AccessRequestPhases, not even an explicit nil +### GetDescription + +`func (o *AccessRequestAdminItemStatus) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestAdminItemStatus) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestAdminItemStatus) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestAdminItemStatus) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessRequestAdminItemStatus) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessRequestAdminItemStatus) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetRemoveDate + +`func (o *AccessRequestAdminItemStatus) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccessRequestAdminItemStatus) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccessRequestAdminItemStatus) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccessRequestAdminItemStatus) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *AccessRequestAdminItemStatus) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *AccessRequestAdminItemStatus) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil +### GetCancelable + +`func (o *AccessRequestAdminItemStatus) GetCancelable() bool` + +GetCancelable returns the Cancelable field if non-nil, zero value otherwise. + +### GetCancelableOk + +`func (o *AccessRequestAdminItemStatus) GetCancelableOk() (*bool, bool)` + +GetCancelableOk returns a tuple with the Cancelable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCancelable + +`func (o *AccessRequestAdminItemStatus) SetCancelable(v bool)` + +SetCancelable sets Cancelable field to given value. + +### HasCancelable + +`func (o *AccessRequestAdminItemStatus) HasCancelable() bool` + +HasCancelable returns a boolean if a field has been set. + +### GetReauthorizationRequired + +`func (o *AccessRequestAdminItemStatus) GetReauthorizationRequired() bool` + +GetReauthorizationRequired returns the ReauthorizationRequired field if non-nil, zero value otherwise. + +### GetReauthorizationRequiredOk + +`func (o *AccessRequestAdminItemStatus) GetReauthorizationRequiredOk() (*bool, bool)` + +GetReauthorizationRequiredOk returns a tuple with the ReauthorizationRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReauthorizationRequired + +`func (o *AccessRequestAdminItemStatus) SetReauthorizationRequired(v bool)` + +SetReauthorizationRequired sets ReauthorizationRequired field to given value. + +### HasReauthorizationRequired + +`func (o *AccessRequestAdminItemStatus) HasReauthorizationRequired() bool` + +HasReauthorizationRequired returns a boolean if a field has been set. + +### GetAccessRequestId + +`func (o *AccessRequestAdminItemStatus) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *AccessRequestAdminItemStatus) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *AccessRequestAdminItemStatus) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + +### HasAccessRequestId + +`func (o *AccessRequestAdminItemStatus) HasAccessRequestId() bool` + +HasAccessRequestId returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *AccessRequestAdminItemStatus) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccessRequestAdminItemStatus) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccessRequestAdminItemStatus) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccessRequestAdminItemStatus) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *AccessRequestAdminItemStatus) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *AccessRequestAdminItemStatus) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestApproversListResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestApproversListResponse.md new file mode 100644 index 000000000..171eb9ae7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestApproversListResponse.md @@ -0,0 +1,168 @@ +--- +id: v2025-access-request-approvers-list-response +title: AccessRequestApproversListResponse +pagination_label: AccessRequestApproversListResponse +sidebar_label: AccessRequestApproversListResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestApproversListResponse', 'V2025AccessRequestApproversListResponse'] +slug: /tools/sdk/go/v2025/models/access-request-approvers-list-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestApproversListResponse', 'V2025AccessRequestApproversListResponse'] +--- + +# AccessRequestApproversListResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Approver id. | [optional] +**Email** | Pointer to **string** | Email of the approver. | [optional] +**Name** | Pointer to **string** | Name of the approver. | [optional] +**ApprovalId** | Pointer to **string** | Id of the approval item. | [optional] +**Type** | Pointer to **string** | Type of the object returned. In this case, the value for this field will always Identity. | [optional] + +## Methods + +### NewAccessRequestApproversListResponse + +`func NewAccessRequestApproversListResponse() *AccessRequestApproversListResponse` + +NewAccessRequestApproversListResponse instantiates a new AccessRequestApproversListResponse 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 + +### NewAccessRequestApproversListResponseWithDefaults + +`func NewAccessRequestApproversListResponseWithDefaults() *AccessRequestApproversListResponse` + +NewAccessRequestApproversListResponseWithDefaults instantiates a new AccessRequestApproversListResponse 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 + +### GetId + +`func (o *AccessRequestApproversListResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestApproversListResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestApproversListResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessRequestApproversListResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetEmail + +`func (o *AccessRequestApproversListResponse) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *AccessRequestApproversListResponse) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *AccessRequestApproversListResponse) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *AccessRequestApproversListResponse) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetName + +`func (o *AccessRequestApproversListResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestApproversListResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestApproversListResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessRequestApproversListResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetApprovalId + +`func (o *AccessRequestApproversListResponse) GetApprovalId() string` + +GetApprovalId returns the ApprovalId field if non-nil, zero value otherwise. + +### GetApprovalIdOk + +`func (o *AccessRequestApproversListResponse) GetApprovalIdOk() (*string, bool)` + +GetApprovalIdOk returns a tuple with the ApprovalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalId + +`func (o *AccessRequestApproversListResponse) SetApprovalId(v string)` + +SetApprovalId sets ApprovalId field to given value. + +### HasApprovalId + +`func (o *AccessRequestApproversListResponse) HasApprovalId() bool` + +HasApprovalId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessRequestApproversListResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestApproversListResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestApproversListResponse) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessRequestApproversListResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestConfig.md new file mode 100644 index 000000000..5f7ff6220 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestConfig.md @@ -0,0 +1,194 @@ +--- +id: v2025-access-request-config +title: AccessRequestConfig +pagination_label: AccessRequestConfig +sidebar_label: AccessRequestConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestConfig', 'V2025AccessRequestConfig'] +slug: /tools/sdk/go/v2025/models/access-request-config +tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig', 'V2025AccessRequestConfig'] +--- + +# AccessRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalsMustBeExternal** | Pointer to **bool** | If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin. | [optional] [default to false] +**AutoApprovalEnabled** | Pointer to **bool** | If this is true and the requester and reviewer are the same, the request is automatically approved. | [optional] [default to false] +**ReauthorizationEnabled** | Pointer to **bool** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to false] +**RequestOnBehalfOfConfig** | Pointer to [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional] +**ApprovalReminderAndEscalationConfig** | Pointer to [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional] +**EntitlementRequestConfig** | Pointer to [**EntitlementRequestConfig**](entitlement-request-config) | | [optional] + +## Methods + +### NewAccessRequestConfig + +`func NewAccessRequestConfig() *AccessRequestConfig` + +NewAccessRequestConfig instantiates a new AccessRequestConfig 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 + +### NewAccessRequestConfigWithDefaults + +`func NewAccessRequestConfigWithDefaults() *AccessRequestConfig` + +NewAccessRequestConfigWithDefaults instantiates a new AccessRequestConfig 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 + +### GetApprovalsMustBeExternal + +`func (o *AccessRequestConfig) GetApprovalsMustBeExternal() bool` + +GetApprovalsMustBeExternal returns the ApprovalsMustBeExternal field if non-nil, zero value otherwise. + +### GetApprovalsMustBeExternalOk + +`func (o *AccessRequestConfig) GetApprovalsMustBeExternalOk() (*bool, bool)` + +GetApprovalsMustBeExternalOk returns a tuple with the ApprovalsMustBeExternal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalsMustBeExternal + +`func (o *AccessRequestConfig) SetApprovalsMustBeExternal(v bool)` + +SetApprovalsMustBeExternal sets ApprovalsMustBeExternal field to given value. + +### HasApprovalsMustBeExternal + +`func (o *AccessRequestConfig) HasApprovalsMustBeExternal() bool` + +HasApprovalsMustBeExternal returns a boolean if a field has been set. + +### GetAutoApprovalEnabled + +`func (o *AccessRequestConfig) GetAutoApprovalEnabled() bool` + +GetAutoApprovalEnabled returns the AutoApprovalEnabled field if non-nil, zero value otherwise. + +### GetAutoApprovalEnabledOk + +`func (o *AccessRequestConfig) GetAutoApprovalEnabledOk() (*bool, bool)` + +GetAutoApprovalEnabledOk returns a tuple with the AutoApprovalEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoApprovalEnabled + +`func (o *AccessRequestConfig) SetAutoApprovalEnabled(v bool)` + +SetAutoApprovalEnabled sets AutoApprovalEnabled field to given value. + +### HasAutoApprovalEnabled + +`func (o *AccessRequestConfig) HasAutoApprovalEnabled() bool` + +HasAutoApprovalEnabled returns a boolean if a field has been set. + +### GetReauthorizationEnabled + +`func (o *AccessRequestConfig) GetReauthorizationEnabled() bool` + +GetReauthorizationEnabled returns the ReauthorizationEnabled field if non-nil, zero value otherwise. + +### GetReauthorizationEnabledOk + +`func (o *AccessRequestConfig) GetReauthorizationEnabledOk() (*bool, bool)` + +GetReauthorizationEnabledOk returns a tuple with the ReauthorizationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReauthorizationEnabled + +`func (o *AccessRequestConfig) SetReauthorizationEnabled(v bool)` + +SetReauthorizationEnabled sets ReauthorizationEnabled field to given value. + +### HasReauthorizationEnabled + +`func (o *AccessRequestConfig) HasReauthorizationEnabled() bool` + +HasReauthorizationEnabled returns a boolean if a field has been set. + +### GetRequestOnBehalfOfConfig + +`func (o *AccessRequestConfig) GetRequestOnBehalfOfConfig() RequestOnBehalfOfConfig` + +GetRequestOnBehalfOfConfig returns the RequestOnBehalfOfConfig field if non-nil, zero value otherwise. + +### GetRequestOnBehalfOfConfigOk + +`func (o *AccessRequestConfig) GetRequestOnBehalfOfConfigOk() (*RequestOnBehalfOfConfig, bool)` + +GetRequestOnBehalfOfConfigOk returns a tuple with the RequestOnBehalfOfConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestOnBehalfOfConfig + +`func (o *AccessRequestConfig) SetRequestOnBehalfOfConfig(v RequestOnBehalfOfConfig)` + +SetRequestOnBehalfOfConfig sets RequestOnBehalfOfConfig field to given value. + +### HasRequestOnBehalfOfConfig + +`func (o *AccessRequestConfig) HasRequestOnBehalfOfConfig() bool` + +HasRequestOnBehalfOfConfig returns a boolean if a field has been set. + +### GetApprovalReminderAndEscalationConfig + +`func (o *AccessRequestConfig) GetApprovalReminderAndEscalationConfig() ApprovalReminderAndEscalationConfig` + +GetApprovalReminderAndEscalationConfig returns the ApprovalReminderAndEscalationConfig field if non-nil, zero value otherwise. + +### GetApprovalReminderAndEscalationConfigOk + +`func (o *AccessRequestConfig) GetApprovalReminderAndEscalationConfigOk() (*ApprovalReminderAndEscalationConfig, bool)` + +GetApprovalReminderAndEscalationConfigOk returns a tuple with the ApprovalReminderAndEscalationConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalReminderAndEscalationConfig + +`func (o *AccessRequestConfig) SetApprovalReminderAndEscalationConfig(v ApprovalReminderAndEscalationConfig)` + +SetApprovalReminderAndEscalationConfig sets ApprovalReminderAndEscalationConfig field to given value. + +### HasApprovalReminderAndEscalationConfig + +`func (o *AccessRequestConfig) HasApprovalReminderAndEscalationConfig() bool` + +HasApprovalReminderAndEscalationConfig returns a boolean if a field has been set. + +### GetEntitlementRequestConfig + +`func (o *AccessRequestConfig) GetEntitlementRequestConfig() EntitlementRequestConfig` + +GetEntitlementRequestConfig returns the EntitlementRequestConfig field if non-nil, zero value otherwise. + +### GetEntitlementRequestConfigOk + +`func (o *AccessRequestConfig) GetEntitlementRequestConfigOk() (*EntitlementRequestConfig, bool)` + +GetEntitlementRequestConfigOk returns a tuple with the EntitlementRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementRequestConfig + +`func (o *AccessRequestConfig) SetEntitlementRequestConfig(v EntitlementRequestConfig)` + +SetEntitlementRequestConfig sets EntitlementRequestConfig field to given value. + +### HasEntitlementRequestConfig + +`func (o *AccessRequestConfig) HasEntitlementRequestConfig() bool` + +HasEntitlementRequestConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestContext.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestContext.md new file mode 100644 index 000000000..8201ffc71 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestContext.md @@ -0,0 +1,64 @@ +--- +id: v2025-access-request-context +title: AccessRequestContext +pagination_label: AccessRequestContext +sidebar_label: AccessRequestContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestContext', 'V2025AccessRequestContext'] +slug: /tools/sdk/go/v2025/models/access-request-context +tags: ['SDK', 'Software Development Kit', 'AccessRequestContext', 'V2025AccessRequestContext'] +--- + +# AccessRequestContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContextAttributes** | Pointer to [**[]ContextAttributeDto**](context-attribute-dto) | | [optional] + +## Methods + +### NewAccessRequestContext + +`func NewAccessRequestContext() *AccessRequestContext` + +NewAccessRequestContext instantiates a new AccessRequestContext 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 + +### NewAccessRequestContextWithDefaults + +`func NewAccessRequestContextWithDefaults() *AccessRequestContext` + +NewAccessRequestContextWithDefaults instantiates a new AccessRequestContext 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 + +### GetContextAttributes + +`func (o *AccessRequestContext) GetContextAttributes() []ContextAttributeDto` + +GetContextAttributes returns the ContextAttributes field if non-nil, zero value otherwise. + +### GetContextAttributesOk + +`func (o *AccessRequestContext) GetContextAttributesOk() (*[]ContextAttributeDto, bool)` + +GetContextAttributesOk returns a tuple with the ContextAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContextAttributes + +`func (o *AccessRequestContext) SetContextAttributes(v []ContextAttributeDto)` + +SetContextAttributes sets ContextAttributes field to given value. + +### HasContextAttributes + +`func (o *AccessRequestContext) HasContextAttributes() bool` + +HasContextAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestDynamicApprover.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestDynamicApprover.md new file mode 100644 index 000000000..314eca0c8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestDynamicApprover.md @@ -0,0 +1,122 @@ +--- +id: v2025-access-request-dynamic-approver +title: AccessRequestDynamicApprover +pagination_label: AccessRequestDynamicApprover +sidebar_label: AccessRequestDynamicApprover +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestDynamicApprover', 'V2025AccessRequestDynamicApprover'] +slug: /tools/sdk/go/v2025/models/access-request-dynamic-approver +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover', 'V2025AccessRequestDynamicApprover'] +--- + +# AccessRequestDynamicApprover + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **string** | The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. | +**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | +**RequestedItems** | [**[]AccessRequestDynamicApproverRequestedItemsInner**](access-request-dynamic-approver-requested-items-inner) | The access items that are being requested. | +**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | + +## Methods + +### NewAccessRequestDynamicApprover + +`func NewAccessRequestDynamicApprover(accessRequestId string, requestedFor []AccessItemRequestedForDto, requestedItems []AccessRequestDynamicApproverRequestedItemsInner, requestedBy AccessItemRequesterDto, ) *AccessRequestDynamicApprover` + +NewAccessRequestDynamicApprover instantiates a new AccessRequestDynamicApprover 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 + +### NewAccessRequestDynamicApproverWithDefaults + +`func NewAccessRequestDynamicApproverWithDefaults() *AccessRequestDynamicApprover` + +NewAccessRequestDynamicApproverWithDefaults instantiates a new AccessRequestDynamicApprover 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 + +### GetAccessRequestId + +`func (o *AccessRequestDynamicApprover) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *AccessRequestDynamicApprover) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *AccessRequestDynamicApprover) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + + +### GetRequestedFor + +`func (o *AccessRequestDynamicApprover) GetRequestedFor() []AccessItemRequestedForDto` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequestDynamicApprover) GetRequestedForOk() (*[]AccessItemRequestedForDto, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequestDynamicApprover) SetRequestedFor(v []AccessItemRequestedForDto)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestedItems + +`func (o *AccessRequestDynamicApprover) GetRequestedItems() []AccessRequestDynamicApproverRequestedItemsInner` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *AccessRequestDynamicApprover) GetRequestedItemsOk() (*[]AccessRequestDynamicApproverRequestedItemsInner, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *AccessRequestDynamicApprover) SetRequestedItems(v []AccessRequestDynamicApproverRequestedItemsInner)` + +SetRequestedItems sets RequestedItems field to given value. + + +### GetRequestedBy + +`func (o *AccessRequestDynamicApprover) GetRequestedBy() AccessItemRequesterDto` + +GetRequestedBy returns the RequestedBy field if non-nil, zero value otherwise. + +### GetRequestedByOk + +`func (o *AccessRequestDynamicApprover) GetRequestedByOk() (*AccessItemRequesterDto, bool)` + +GetRequestedByOk returns a tuple with the RequestedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedBy + +`func (o *AccessRequestDynamicApprover) SetRequestedBy(v AccessItemRequesterDto)` + +SetRequestedBy sets RequestedBy field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestDynamicApprover1.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestDynamicApprover1.md new file mode 100644 index 000000000..e05d2c935 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestDynamicApprover1.md @@ -0,0 +1,101 @@ +--- +id: v2025-access-request-dynamic-approver1 +title: AccessRequestDynamicApprover1 +pagination_label: AccessRequestDynamicApprover1 +sidebar_label: AccessRequestDynamicApprover1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestDynamicApprover1', 'V2025AccessRequestDynamicApprover1'] +slug: /tools/sdk/go/v2025/models/access-request-dynamic-approver1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover1', 'V2025AccessRequestDynamicApprover1'] +--- + +# AccessRequestDynamicApprover1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the identity to add to the approver list for the access request. | +**Name** | **string** | The name of the identity to add to the approver list for the access request. | +**Type** | **map[string]interface{}** | The type of object being referenced. | + +## Methods + +### NewAccessRequestDynamicApprover1 + +`func NewAccessRequestDynamicApprover1(id string, name string, type_ map[string]interface{}, ) *AccessRequestDynamicApprover1` + +NewAccessRequestDynamicApprover1 instantiates a new AccessRequestDynamicApprover1 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 + +### NewAccessRequestDynamicApprover1WithDefaults + +`func NewAccessRequestDynamicApprover1WithDefaults() *AccessRequestDynamicApprover1` + +NewAccessRequestDynamicApprover1WithDefaults instantiates a new AccessRequestDynamicApprover1 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 + +### GetId + +`func (o *AccessRequestDynamicApprover1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestDynamicApprover1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestDynamicApprover1) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessRequestDynamicApprover1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestDynamicApprover1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestDynamicApprover1) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *AccessRequestDynamicApprover1) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestDynamicApprover1) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestDynamicApprover1) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestDynamicApproverRequestedItemsInner.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestDynamicApproverRequestedItemsInner.md new file mode 100644 index 000000000..ac3b4adfb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestDynamicApproverRequestedItemsInner.md @@ -0,0 +1,194 @@ +--- +id: v2025-access-request-dynamic-approver-requested-items-inner +title: AccessRequestDynamicApproverRequestedItemsInner +pagination_label: AccessRequestDynamicApproverRequestedItemsInner +sidebar_label: AccessRequestDynamicApproverRequestedItemsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestDynamicApproverRequestedItemsInner', 'V2025AccessRequestDynamicApproverRequestedItemsInner'] +slug: /tools/sdk/go/v2025/models/access-request-dynamic-approver-requested-items-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApproverRequestedItemsInner', 'V2025AccessRequestDynamicApproverRequestedItemsInner'] +--- + +# AccessRequestDynamicApproverRequestedItemsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the access item. | +**Name** | **string** | Human friendly name of the access item. | +**Description** | Pointer to **NullableString** | Extended description of the access item. | [optional] +**Type** | **map[string]interface{}** | The type of access item being requested. | +**Operation** | **map[string]interface{}** | Grant or revoke the access item | +**Comment** | Pointer to **NullableString** | A comment from the requestor on why the access is needed. | [optional] + +## Methods + +### NewAccessRequestDynamicApproverRequestedItemsInner + +`func NewAccessRequestDynamicApproverRequestedItemsInner(id string, name string, type_ map[string]interface{}, operation map[string]interface{}, ) *AccessRequestDynamicApproverRequestedItemsInner` + +NewAccessRequestDynamicApproverRequestedItemsInner instantiates a new AccessRequestDynamicApproverRequestedItemsInner 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 + +### NewAccessRequestDynamicApproverRequestedItemsInnerWithDefaults + +`func NewAccessRequestDynamicApproverRequestedItemsInnerWithDefaults() *AccessRequestDynamicApproverRequestedItemsInner` + +NewAccessRequestDynamicApproverRequestedItemsInnerWithDefaults instantiates a new AccessRequestDynamicApproverRequestedItemsInner 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 + +### GetId + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessRequestDynamicApproverRequestedItemsInner) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetOperation + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetOperation() map[string]interface{}` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetOperationOk() (*map[string]interface{}, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetOperation(v map[string]interface{})` + +SetOperation sets Operation field to given value. + + +### GetComment + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *AccessRequestDynamicApproverRequestedItemsInner) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *AccessRequestDynamicApproverRequestedItemsInner) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestItem.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestItem.md new file mode 100644 index 000000000..ca861611b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestItem.md @@ -0,0 +1,158 @@ +--- +id: v2025-access-request-item +title: AccessRequestItem +pagination_label: AccessRequestItem +sidebar_label: AccessRequestItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestItem', 'V2025AccessRequestItem'] +slug: /tools/sdk/go/v2025/models/access-request-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'V2025AccessRequestItem'] +--- + +# AccessRequestItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of the item being requested. | +**Id** | **string** | ID of Role, Access Profile or Entitlement being requested. | +**Comment** | Pointer to **string** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | Pointer to **SailPointTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] + +## Methods + +### NewAccessRequestItem + +`func NewAccessRequestItem(type_ string, id string, ) *AccessRequestItem` + +NewAccessRequestItem instantiates a new AccessRequestItem 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 + +### NewAccessRequestItemWithDefaults + +`func NewAccessRequestItemWithDefaults() *AccessRequestItem` + +NewAccessRequestItemWithDefaults instantiates a new AccessRequestItem 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 + +### GetType + +`func (o *AccessRequestItem) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestItem) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestItem) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccessRequestItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetComment + +`func (o *AccessRequestItem) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestItem) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestItem) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *AccessRequestItem) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *AccessRequestItem) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccessRequestItem) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccessRequestItem) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccessRequestItem) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *AccessRequestItem) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccessRequestItem) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccessRequestItem) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccessRequestItem) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestItem1.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestItem1.md new file mode 100644 index 000000000..f8e122406 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestItem1.md @@ -0,0 +1,230 @@ +--- +id: v2025-access-request-item1 +title: AccessRequestItem1 +pagination_label: AccessRequestItem1 +sidebar_label: AccessRequestItem1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestItem1', 'V2025AccessRequestItem1'] +slug: /tools/sdk/go/v2025/models/access-request-item1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestItem1', 'V2025AccessRequestItem1'] +--- + +# AccessRequestItem1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of the item being requested. | +**Id** | **string** | ID of Role, Access Profile or Entitlement being requested. | +**Comment** | Pointer to **string** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | Pointer to **SailPointTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | Pointer to **NullableString** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | Pointer to **NullableString** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] + +## Methods + +### NewAccessRequestItem1 + +`func NewAccessRequestItem1(type_ string, id string, ) *AccessRequestItem1` + +NewAccessRequestItem1 instantiates a new AccessRequestItem1 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 + +### NewAccessRequestItem1WithDefaults + +`func NewAccessRequestItem1WithDefaults() *AccessRequestItem1` + +NewAccessRequestItem1WithDefaults instantiates a new AccessRequestItem1 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 + +### GetType + +`func (o *AccessRequestItem1) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestItem1) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestItem1) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccessRequestItem1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestItem1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestItem1) SetId(v string)` + +SetId sets Id field to given value. + + +### GetComment + +`func (o *AccessRequestItem1) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestItem1) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestItem1) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *AccessRequestItem1) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *AccessRequestItem1) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccessRequestItem1) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccessRequestItem1) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccessRequestItem1) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *AccessRequestItem1) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccessRequestItem1) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccessRequestItem1) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccessRequestItem1) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetAssignmentId + +`func (o *AccessRequestItem1) GetAssignmentId() string` + +GetAssignmentId returns the AssignmentId field if non-nil, zero value otherwise. + +### GetAssignmentIdOk + +`func (o *AccessRequestItem1) GetAssignmentIdOk() (*string, bool)` + +GetAssignmentIdOk returns a tuple with the AssignmentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentId + +`func (o *AccessRequestItem1) SetAssignmentId(v string)` + +SetAssignmentId sets AssignmentId field to given value. + +### HasAssignmentId + +`func (o *AccessRequestItem1) HasAssignmentId() bool` + +HasAssignmentId returns a boolean if a field has been set. + +### SetAssignmentIdNil + +`func (o *AccessRequestItem1) SetAssignmentIdNil(b bool)` + + SetAssignmentIdNil sets the value for AssignmentId to be an explicit nil + +### UnsetAssignmentId +`func (o *AccessRequestItem1) UnsetAssignmentId()` + +UnsetAssignmentId ensures that no value is present for AssignmentId, not even an explicit nil +### GetNativeIdentity + +`func (o *AccessRequestItem1) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccessRequestItem1) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccessRequestItem1) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccessRequestItem1) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### SetNativeIdentityNil + +`func (o *AccessRequestItem1) SetNativeIdentityNil(b bool)` + + SetNativeIdentityNil sets the value for NativeIdentity to be an explicit nil + +### UnsetNativeIdentity +`func (o *AccessRequestItem1) UnsetNativeIdentity()` + +UnsetNativeIdentity ensures that no value is present for NativeIdentity, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestItemResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestItemResponse.md new file mode 100644 index 000000000..0adf782c7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestItemResponse.md @@ -0,0 +1,246 @@ +--- +id: v2025-access-request-item-response +title: AccessRequestItemResponse +pagination_label: AccessRequestItemResponse +sidebar_label: AccessRequestItemResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestItemResponse', 'V2025AccessRequestItemResponse'] +slug: /tools/sdk/go/v2025/models/access-request-item-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestItemResponse', 'V2025AccessRequestItemResponse'] +--- + +# AccessRequestItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to **string** | the access request item operation | [optional] +**AccessItemType** | Pointer to **string** | the access item type | [optional] +**Name** | Pointer to **string** | the name of access request item | [optional] +**Decision** | Pointer to **string** | the final decision for the access request | [optional] +**Description** | Pointer to **string** | the description of access request item | [optional] +**SourceId** | Pointer to **string** | the source id | [optional] +**SourceName** | Pointer to **string** | the source Name | [optional] +**ApprovalInfos** | Pointer to [**[]ApprovalInfoResponse**](approval-info-response) | | [optional] + +## Methods + +### NewAccessRequestItemResponse + +`func NewAccessRequestItemResponse() *AccessRequestItemResponse` + +NewAccessRequestItemResponse instantiates a new AccessRequestItemResponse 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 + +### NewAccessRequestItemResponseWithDefaults + +`func NewAccessRequestItemResponseWithDefaults() *AccessRequestItemResponse` + +NewAccessRequestItemResponseWithDefaults instantiates a new AccessRequestItemResponse 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 + +### GetOperation + +`func (o *AccessRequestItemResponse) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *AccessRequestItemResponse) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *AccessRequestItemResponse) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *AccessRequestItemResponse) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetAccessItemType + +`func (o *AccessRequestItemResponse) GetAccessItemType() string` + +GetAccessItemType returns the AccessItemType field if non-nil, zero value otherwise. + +### GetAccessItemTypeOk + +`func (o *AccessRequestItemResponse) GetAccessItemTypeOk() (*string, bool)` + +GetAccessItemTypeOk returns a tuple with the AccessItemType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItemType + +`func (o *AccessRequestItemResponse) SetAccessItemType(v string)` + +SetAccessItemType sets AccessItemType field to given value. + +### HasAccessItemType + +`func (o *AccessRequestItemResponse) HasAccessItemType() bool` + +HasAccessItemType returns a boolean if a field has been set. + +### GetName + +`func (o *AccessRequestItemResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestItemResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestItemResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessRequestItemResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDecision + +`func (o *AccessRequestItemResponse) GetDecision() string` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *AccessRequestItemResponse) GetDecisionOk() (*string, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *AccessRequestItemResponse) SetDecision(v string)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *AccessRequestItemResponse) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessRequestItemResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestItemResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestItemResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestItemResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccessRequestItemResponse) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccessRequestItemResponse) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccessRequestItemResponse) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccessRequestItemResponse) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccessRequestItemResponse) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccessRequestItemResponse) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccessRequestItemResponse) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccessRequestItemResponse) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetApprovalInfos + +`func (o *AccessRequestItemResponse) GetApprovalInfos() []ApprovalInfoResponse` + +GetApprovalInfos returns the ApprovalInfos field if non-nil, zero value otherwise. + +### GetApprovalInfosOk + +`func (o *AccessRequestItemResponse) GetApprovalInfosOk() (*[]ApprovalInfoResponse, bool)` + +GetApprovalInfosOk returns a tuple with the ApprovalInfos field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalInfos + +`func (o *AccessRequestItemResponse) SetApprovalInfos(v []ApprovalInfoResponse)` + +SetApprovalInfos sets ApprovalInfos field to given value. + +### HasApprovalInfos + +`func (o *AccessRequestItemResponse) HasApprovalInfos() bool` + +HasApprovalInfos returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPhases.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPhases.md new file mode 100644 index 000000000..cbb63ece7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPhases.md @@ -0,0 +1,224 @@ +--- +id: v2025-access-request-phases +title: AccessRequestPhases +pagination_label: AccessRequestPhases +sidebar_label: AccessRequestPhases +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPhases', 'V2025AccessRequestPhases'] +slug: /tools/sdk/go/v2025/models/access-request-phases +tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'V2025AccessRequestPhases'] +--- + +# AccessRequestPhases + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Started** | Pointer to **SailPointTime** | The time that this phase started. | [optional] +**Finished** | Pointer to **NullableTime** | The time that this phase finished. | [optional] +**Name** | Pointer to **string** | The name of this phase. | [optional] +**State** | Pointer to **string** | The state of this phase. | [optional] +**Result** | Pointer to **NullableString** | The state of this phase. | [optional] +**PhaseReference** | Pointer to **NullableString** | A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. | [optional] + +## Methods + +### NewAccessRequestPhases + +`func NewAccessRequestPhases() *AccessRequestPhases` + +NewAccessRequestPhases instantiates a new AccessRequestPhases 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 + +### NewAccessRequestPhasesWithDefaults + +`func NewAccessRequestPhasesWithDefaults() *AccessRequestPhases` + +NewAccessRequestPhasesWithDefaults instantiates a new AccessRequestPhases 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 + +### GetStarted + +`func (o *AccessRequestPhases) GetStarted() SailPointTime` + +GetStarted returns the Started field if non-nil, zero value otherwise. + +### GetStartedOk + +`func (o *AccessRequestPhases) GetStartedOk() (*SailPointTime, bool)` + +GetStartedOk returns a tuple with the Started field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStarted + +`func (o *AccessRequestPhases) SetStarted(v SailPointTime)` + +SetStarted sets Started field to given value. + +### HasStarted + +`func (o *AccessRequestPhases) HasStarted() bool` + +HasStarted returns a boolean if a field has been set. + +### GetFinished + +`func (o *AccessRequestPhases) GetFinished() SailPointTime` + +GetFinished returns the Finished field if non-nil, zero value otherwise. + +### GetFinishedOk + +`func (o *AccessRequestPhases) GetFinishedOk() (*SailPointTime, bool)` + +GetFinishedOk returns a tuple with the Finished field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFinished + +`func (o *AccessRequestPhases) SetFinished(v SailPointTime)` + +SetFinished sets Finished field to given value. + +### HasFinished + +`func (o *AccessRequestPhases) HasFinished() bool` + +HasFinished returns a boolean if a field has been set. + +### SetFinishedNil + +`func (o *AccessRequestPhases) SetFinishedNil(b bool)` + + SetFinishedNil sets the value for Finished to be an explicit nil + +### UnsetFinished +`func (o *AccessRequestPhases) UnsetFinished()` + +UnsetFinished ensures that no value is present for Finished, not even an explicit nil +### GetName + +`func (o *AccessRequestPhases) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestPhases) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestPhases) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessRequestPhases) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetState + +`func (o *AccessRequestPhases) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *AccessRequestPhases) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *AccessRequestPhases) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *AccessRequestPhases) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetResult + +`func (o *AccessRequestPhases) GetResult() string` + +GetResult returns the Result field if non-nil, zero value otherwise. + +### GetResultOk + +`func (o *AccessRequestPhases) GetResultOk() (*string, bool)` + +GetResultOk returns a tuple with the Result field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResult + +`func (o *AccessRequestPhases) SetResult(v string)` + +SetResult sets Result field to given value. + +### HasResult + +`func (o *AccessRequestPhases) HasResult() bool` + +HasResult returns a boolean if a field has been set. + +### SetResultNil + +`func (o *AccessRequestPhases) SetResultNil(b bool)` + + SetResultNil sets the value for Result to be an explicit nil + +### UnsetResult +`func (o *AccessRequestPhases) UnsetResult()` + +UnsetResult ensures that no value is present for Result, not even an explicit nil +### GetPhaseReference + +`func (o *AccessRequestPhases) GetPhaseReference() string` + +GetPhaseReference returns the PhaseReference field if non-nil, zero value otherwise. + +### GetPhaseReferenceOk + +`func (o *AccessRequestPhases) GetPhaseReferenceOk() (*string, bool)` + +GetPhaseReferenceOk returns a tuple with the PhaseReference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhaseReference + +`func (o *AccessRequestPhases) SetPhaseReference(v string)` + +SetPhaseReference sets PhaseReference field to given value. + +### HasPhaseReference + +`func (o *AccessRequestPhases) HasPhaseReference() bool` + +HasPhaseReference returns a boolean if a field has been set. + +### SetPhaseReferenceNil + +`func (o *AccessRequestPhases) SetPhaseReferenceNil(b bool)` + + SetPhaseReferenceNil sets the value for PhaseReference to be an explicit nil + +### UnsetPhaseReference +`func (o *AccessRequestPhases) UnsetPhaseReference()` + +UnsetPhaseReference ensures that no value is present for PhaseReference, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPostApproval.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPostApproval.md new file mode 100644 index 000000000..68b6ccd67 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPostApproval.md @@ -0,0 +1,122 @@ +--- +id: v2025-access-request-post-approval +title: AccessRequestPostApproval +pagination_label: AccessRequestPostApproval +sidebar_label: AccessRequestPostApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPostApproval', 'V2025AccessRequestPostApproval'] +slug: /tools/sdk/go/v2025/models/access-request-post-approval +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApproval', 'V2025AccessRequestPostApproval'] +--- + +# AccessRequestPostApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **string** | The unique ID of the access request. | +**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | +**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | +**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | + +## Methods + +### NewAccessRequestPostApproval + +`func NewAccessRequestPostApproval(accessRequestId string, requestedFor []AccessItemRequestedForDto, requestedItemsStatus []AccessRequestPostApprovalRequestedItemsStatusInner, requestedBy AccessItemRequesterDto, ) *AccessRequestPostApproval` + +NewAccessRequestPostApproval instantiates a new AccessRequestPostApproval 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 + +### NewAccessRequestPostApprovalWithDefaults + +`func NewAccessRequestPostApprovalWithDefaults() *AccessRequestPostApproval` + +NewAccessRequestPostApprovalWithDefaults instantiates a new AccessRequestPostApproval 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 + +### GetAccessRequestId + +`func (o *AccessRequestPostApproval) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *AccessRequestPostApproval) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *AccessRequestPostApproval) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + + +### GetRequestedFor + +`func (o *AccessRequestPostApproval) GetRequestedFor() []AccessItemRequestedForDto` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequestPostApproval) GetRequestedForOk() (*[]AccessItemRequestedForDto, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequestPostApproval) SetRequestedFor(v []AccessItemRequestedForDto)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestedItemsStatus + +`func (o *AccessRequestPostApproval) GetRequestedItemsStatus() []AccessRequestPostApprovalRequestedItemsStatusInner` + +GetRequestedItemsStatus returns the RequestedItemsStatus field if non-nil, zero value otherwise. + +### GetRequestedItemsStatusOk + +`func (o *AccessRequestPostApproval) GetRequestedItemsStatusOk() (*[]AccessRequestPostApprovalRequestedItemsStatusInner, bool)` + +GetRequestedItemsStatusOk returns a tuple with the RequestedItemsStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItemsStatus + +`func (o *AccessRequestPostApproval) SetRequestedItemsStatus(v []AccessRequestPostApprovalRequestedItemsStatusInner)` + +SetRequestedItemsStatus sets RequestedItemsStatus field to given value. + + +### GetRequestedBy + +`func (o *AccessRequestPostApproval) GetRequestedBy() AccessItemRequesterDto` + +GetRequestedBy returns the RequestedBy field if non-nil, zero value otherwise. + +### GetRequestedByOk + +`func (o *AccessRequestPostApproval) GetRequestedByOk() (*AccessItemRequesterDto, bool)` + +GetRequestedByOk returns a tuple with the RequestedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedBy + +`func (o *AccessRequestPostApproval) SetRequestedBy(v AccessItemRequesterDto)` + +SetRequestedBy sets RequestedBy field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md new file mode 100644 index 000000000..00cd902c0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md @@ -0,0 +1,251 @@ +--- +id: v2025-access-request-post-approval-requested-items-status-inner +title: AccessRequestPostApprovalRequestedItemsStatusInner +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInner +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'V2025AccessRequestPostApprovalRequestedItemsStatusInner'] +slug: /tools/sdk/go/v2025/models/access-request-post-approval-requested-items-status-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'V2025AccessRequestPostApprovalRequestedItemsStatusInner'] +--- + +# AccessRequestPostApprovalRequestedItemsStatusInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the access item being requested. | +**Name** | **string** | The human friendly name of the access item. | +**Description** | Pointer to **NullableString** | Detailed description of the access item. | [optional] +**Type** | **map[string]interface{}** | The type of access item. | +**Operation** | **map[string]interface{}** | The action to perform on the access item. | +**Comment** | Pointer to **NullableString** | A comment from the identity requesting the access. | [optional] +**ClientMetadata** | Pointer to **map[string]interface{}** | Additional customer defined metadata about the access item. | [optional] +**ApprovalInfo** | [**[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner**](access-request-post-approval-requested-items-status-inner-approval-info-inner) | A list of one or more approvers for the access request. | + +## Methods + +### NewAccessRequestPostApprovalRequestedItemsStatusInner + +`func NewAccessRequestPostApprovalRequestedItemsStatusInner(id string, name string, type_ map[string]interface{}, operation map[string]interface{}, approvalInfo []AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner, ) *AccessRequestPostApprovalRequestedItemsStatusInner` + +NewAccessRequestPostApprovalRequestedItemsStatusInner instantiates a new AccessRequestPostApprovalRequestedItemsStatusInner 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 + +### NewAccessRequestPostApprovalRequestedItemsStatusInnerWithDefaults + +`func NewAccessRequestPostApprovalRequestedItemsStatusInnerWithDefaults() *AccessRequestPostApprovalRequestedItemsStatusInner` + +NewAccessRequestPostApprovalRequestedItemsStatusInnerWithDefaults instantiates a new AccessRequestPostApprovalRequestedItemsStatusInner 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 + +### GetId + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetOperation + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetOperation() map[string]interface{}` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetOperationOk() (*map[string]interface{}, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetOperation(v map[string]interface{})` + +SetOperation sets Operation field to given value. + + +### GetComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetClientMetadata + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetClientMetadata() map[string]interface{}` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetClientMetadataOk() (*map[string]interface{}, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetClientMetadata(v map[string]interface{})` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetApprovalInfo + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetApprovalInfo() []AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner` + +GetApprovalInfo returns the ApprovalInfo field if non-nil, zero value otherwise. + +### GetApprovalInfoOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) GetApprovalInfoOk() (*[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner, bool)` + +GetApprovalInfoOk returns a tuple with the ApprovalInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalInfo + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInner) SetApprovalInfo(v []AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner)` + +SetApprovalInfo sets ApprovalInfo field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md new file mode 100644 index 000000000..90cd00b5c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md @@ -0,0 +1,137 @@ +--- +id: v2025-access-request-post-approval-requested-items-status-inner-approval-info-inner +title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'V2025AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner'] +slug: /tools/sdk/go/v2025/models/access-request-post-approval-requested-items-status-inner-approval-info-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'V2025AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner'] +--- + +# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalComment** | Pointer to **NullableString** | A comment left by the approver. | [optional] +**ApprovalDecision** | **map[string]interface{}** | The final decision of the approver. | +**ApproverName** | **string** | The name of the approver | +**Approver** | [**AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover**](access-request-post-approval-requested-items-status-inner-approval-info-inner-approver) | | + +## Methods + +### NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner + +`func NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner(approvalDecision map[string]interface{}, approverName string, approver AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover, ) *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner` + +NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner instantiates a new AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner 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 + +### NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerWithDefaults + +`func NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerWithDefaults() *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner` + +NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerWithDefaults instantiates a new AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner 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 + +### GetApprovalComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApprovalComment() string` + +GetApprovalComment returns the ApprovalComment field if non-nil, zero value otherwise. + +### GetApprovalCommentOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApprovalCommentOk() (*string, bool)` + +GetApprovalCommentOk returns a tuple with the ApprovalComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) SetApprovalComment(v string)` + +SetApprovalComment sets ApprovalComment field to given value. + +### HasApprovalComment + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) HasApprovalComment() bool` + +HasApprovalComment returns a boolean if a field has been set. + +### SetApprovalCommentNil + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) SetApprovalCommentNil(b bool)` + + SetApprovalCommentNil sets the value for ApprovalComment to be an explicit nil + +### UnsetApprovalComment +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) UnsetApprovalComment()` + +UnsetApprovalComment ensures that no value is present for ApprovalComment, not even an explicit nil +### GetApprovalDecision + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApprovalDecision() map[string]interface{}` + +GetApprovalDecision returns the ApprovalDecision field if non-nil, zero value otherwise. + +### GetApprovalDecisionOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApprovalDecisionOk() (*map[string]interface{}, bool)` + +GetApprovalDecisionOk returns a tuple with the ApprovalDecision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalDecision + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) SetApprovalDecision(v map[string]interface{})` + +SetApprovalDecision sets ApprovalDecision field to given value. + + +### GetApproverName + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApproverName() string` + +GetApproverName returns the ApproverName field if non-nil, zero value otherwise. + +### GetApproverNameOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApproverNameOk() (*string, bool)` + +GetApproverNameOk returns a tuple with the ApproverName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverName + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) SetApproverName(v string)` + +SetApproverName sets ApproverName field to given value. + + +### GetApprover + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApprover() AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) GetApproverOk() (*AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner) SetApprover(v AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover)` + +SetApprover sets Approver field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md new file mode 100644 index 000000000..0b99eb5ac --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md @@ -0,0 +1,101 @@ +--- +id: v2025-access-request-post-approval-requested-items-status-inner-approval-info-inner-approver +title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'V2025AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover'] +slug: /tools/sdk/go/v2025/models/access-request-post-approval-requested-items-status-inner-approval-info-inner-approver +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'V2025AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover'] +--- + +# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **map[string]interface{}** | The type of object that is referenced | +**Id** | **string** | ID of identity who approved the access item request. | +**Name** | **string** | Human-readable display name of identity who approved the access item request. | + +## Methods + +### NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover + +`func NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover(type_ map[string]interface{}, id string, name string, ) *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover` + +NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover instantiates a new AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover 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 + +### NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverWithDefaults + +`func NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverWithDefaults() *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover` + +NewAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverWithDefaults instantiates a new AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover 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 + +### GetType + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPreApproval.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPreApproval.md new file mode 100644 index 000000000..712b36150 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPreApproval.md @@ -0,0 +1,122 @@ +--- +id: v2025-access-request-pre-approval +title: AccessRequestPreApproval +pagination_label: AccessRequestPreApproval +sidebar_label: AccessRequestPreApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPreApproval', 'V2025AccessRequestPreApproval'] +slug: /tools/sdk/go/v2025/models/access-request-pre-approval +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval', 'V2025AccessRequestPreApproval'] +--- + +# AccessRequestPreApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **string** | The unique ID of the access request. | +**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | +**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | +**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | + +## Methods + +### NewAccessRequestPreApproval + +`func NewAccessRequestPreApproval(accessRequestId string, requestedFor []AccessItemRequestedForDto, requestedItems []AccessRequestPreApprovalRequestedItemsInner, requestedBy AccessItemRequesterDto, ) *AccessRequestPreApproval` + +NewAccessRequestPreApproval instantiates a new AccessRequestPreApproval 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 + +### NewAccessRequestPreApprovalWithDefaults + +`func NewAccessRequestPreApprovalWithDefaults() *AccessRequestPreApproval` + +NewAccessRequestPreApprovalWithDefaults instantiates a new AccessRequestPreApproval 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 + +### GetAccessRequestId + +`func (o *AccessRequestPreApproval) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *AccessRequestPreApproval) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *AccessRequestPreApproval) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + + +### GetRequestedFor + +`func (o *AccessRequestPreApproval) GetRequestedFor() []AccessItemRequestedForDto` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequestPreApproval) GetRequestedForOk() (*[]AccessItemRequestedForDto, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequestPreApproval) SetRequestedFor(v []AccessItemRequestedForDto)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestedItems + +`func (o *AccessRequestPreApproval) GetRequestedItems() []AccessRequestPreApprovalRequestedItemsInner` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *AccessRequestPreApproval) GetRequestedItemsOk() (*[]AccessRequestPreApprovalRequestedItemsInner, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *AccessRequestPreApproval) SetRequestedItems(v []AccessRequestPreApprovalRequestedItemsInner)` + +SetRequestedItems sets RequestedItems field to given value. + + +### GetRequestedBy + +`func (o *AccessRequestPreApproval) GetRequestedBy() AccessItemRequesterDto` + +GetRequestedBy returns the RequestedBy field if non-nil, zero value otherwise. + +### GetRequestedByOk + +`func (o *AccessRequestPreApproval) GetRequestedByOk() (*AccessItemRequesterDto, bool)` + +GetRequestedByOk returns a tuple with the RequestedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedBy + +`func (o *AccessRequestPreApproval) SetRequestedBy(v AccessItemRequesterDto)` + +SetRequestedBy sets RequestedBy field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPreApproval1.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPreApproval1.md new file mode 100644 index 000000000..c62652cfd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPreApproval1.md @@ -0,0 +1,101 @@ +--- +id: v2025-access-request-pre-approval1 +title: AccessRequestPreApproval1 +pagination_label: AccessRequestPreApproval1 +sidebar_label: AccessRequestPreApproval1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPreApproval1', 'V2025AccessRequestPreApproval1'] +slug: /tools/sdk/go/v2025/models/access-request-pre-approval1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval1', 'V2025AccessRequestPreApproval1'] +--- + +# AccessRequestPreApproval1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | **bool** | Whether or not to approve the access request. | +**Comment** | **string** | A comment about the decision to approve or deny the request. | +**Approver** | **string** | The name of the entity that approved or denied the request. | + +## Methods + +### NewAccessRequestPreApproval1 + +`func NewAccessRequestPreApproval1(approved bool, comment string, approver string, ) *AccessRequestPreApproval1` + +NewAccessRequestPreApproval1 instantiates a new AccessRequestPreApproval1 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 + +### NewAccessRequestPreApproval1WithDefaults + +`func NewAccessRequestPreApproval1WithDefaults() *AccessRequestPreApproval1` + +NewAccessRequestPreApproval1WithDefaults instantiates a new AccessRequestPreApproval1 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 + +### GetApproved + +`func (o *AccessRequestPreApproval1) GetApproved() bool` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *AccessRequestPreApproval1) GetApprovedOk() (*bool, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *AccessRequestPreApproval1) SetApproved(v bool)` + +SetApproved sets Approved field to given value. + + +### GetComment + +`func (o *AccessRequestPreApproval1) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestPreApproval1) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestPreApproval1) SetComment(v string)` + +SetComment sets Comment field to given value. + + +### GetApprover + +`func (o *AccessRequestPreApproval1) GetApprover() string` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *AccessRequestPreApproval1) GetApproverOk() (*string, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *AccessRequestPreApproval1) SetApprover(v string)` + +SetApprover sets Approver field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPreApprovalRequestedItemsInner.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPreApprovalRequestedItemsInner.md new file mode 100644 index 000000000..952ce1228 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestPreApprovalRequestedItemsInner.md @@ -0,0 +1,194 @@ +--- +id: v2025-access-request-pre-approval-requested-items-inner +title: AccessRequestPreApprovalRequestedItemsInner +pagination_label: AccessRequestPreApprovalRequestedItemsInner +sidebar_label: AccessRequestPreApprovalRequestedItemsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPreApprovalRequestedItemsInner', 'V2025AccessRequestPreApprovalRequestedItemsInner'] +slug: /tools/sdk/go/v2025/models/access-request-pre-approval-requested-items-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApprovalRequestedItemsInner', 'V2025AccessRequestPreApprovalRequestedItemsInner'] +--- + +# AccessRequestPreApprovalRequestedItemsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the access item being requested. | +**Name** | **string** | The human friendly name of the access item. | +**Description** | Pointer to **NullableString** | Detailed description of the access item. | [optional] +**Type** | **map[string]interface{}** | The type of access item. | +**Operation** | **map[string]interface{}** | The action to perform on the access item. | +**Comment** | Pointer to **NullableString** | A comment from the identity requesting the access. | [optional] + +## Methods + +### NewAccessRequestPreApprovalRequestedItemsInner + +`func NewAccessRequestPreApprovalRequestedItemsInner(id string, name string, type_ map[string]interface{}, operation map[string]interface{}, ) *AccessRequestPreApprovalRequestedItemsInner` + +NewAccessRequestPreApprovalRequestedItemsInner instantiates a new AccessRequestPreApprovalRequestedItemsInner 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 + +### NewAccessRequestPreApprovalRequestedItemsInnerWithDefaults + +`func NewAccessRequestPreApprovalRequestedItemsInnerWithDefaults() *AccessRequestPreApprovalRequestedItemsInner` + +NewAccessRequestPreApprovalRequestedItemsInnerWithDefaults instantiates a new AccessRequestPreApprovalRequestedItemsInner 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 + +### GetId + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestPreApprovalRequestedItemsInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessRequestPreApprovalRequestedItemsInner) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetOperation + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetOperation() map[string]interface{}` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetOperationOk() (*map[string]interface{}, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetOperation(v map[string]interface{})` + +SetOperation sets Operation field to given value. + + +### GetComment + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestPreApprovalRequestedItemsInner) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *AccessRequestPreApprovalRequestedItemsInner) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *AccessRequestPreApprovalRequestedItemsInner) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *AccessRequestPreApprovalRequestedItemsInner) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationActionItemDto.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationActionItemDto.md new file mode 100644 index 000000000..5a544e985 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationActionItemDto.md @@ -0,0 +1,80 @@ +--- +id: v2025-access-request-recommendation-action-item-dto +title: AccessRequestRecommendationActionItemDto +pagination_label: AccessRequestRecommendationActionItemDto +sidebar_label: AccessRequestRecommendationActionItemDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationActionItemDto', 'V2025AccessRequestRecommendationActionItemDto'] +slug: /tools/sdk/go/v2025/models/access-request-recommendation-action-item-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemDto', 'V2025AccessRequestRecommendationActionItemDto'] +--- + +# AccessRequestRecommendationActionItemDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **string** | The identity ID taking the action. | +**Access** | [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | + +## Methods + +### NewAccessRequestRecommendationActionItemDto + +`func NewAccessRequestRecommendationActionItemDto(identityId string, access AccessRequestRecommendationItem, ) *AccessRequestRecommendationActionItemDto` + +NewAccessRequestRecommendationActionItemDto instantiates a new AccessRequestRecommendationActionItemDto 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 + +### NewAccessRequestRecommendationActionItemDtoWithDefaults + +`func NewAccessRequestRecommendationActionItemDtoWithDefaults() *AccessRequestRecommendationActionItemDto` + +NewAccessRequestRecommendationActionItemDtoWithDefaults instantiates a new AccessRequestRecommendationActionItemDto 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 + +### GetIdentityId + +`func (o *AccessRequestRecommendationActionItemDto) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessRequestRecommendationActionItemDto) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessRequestRecommendationActionItemDto) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetAccess + +`func (o *AccessRequestRecommendationActionItemDto) GetAccess() AccessRequestRecommendationItem` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *AccessRequestRecommendationActionItemDto) GetAccessOk() (*AccessRequestRecommendationItem, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *AccessRequestRecommendationActionItemDto) SetAccess(v AccessRequestRecommendationItem)` + +SetAccess sets Access field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationActionItemResponseDto.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationActionItemResponseDto.md new file mode 100644 index 000000000..aa38ba67f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationActionItemResponseDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-access-request-recommendation-action-item-response-dto +title: AccessRequestRecommendationActionItemResponseDto +pagination_label: AccessRequestRecommendationActionItemResponseDto +sidebar_label: AccessRequestRecommendationActionItemResponseDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationActionItemResponseDto', 'V2025AccessRequestRecommendationActionItemResponseDto'] +slug: /tools/sdk/go/v2025/models/access-request-recommendation-action-item-response-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemResponseDto', 'V2025AccessRequestRecommendationActionItemResponseDto'] +--- + +# AccessRequestRecommendationActionItemResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | The identity ID taking the action. | [optional] +**Access** | Pointer to [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [optional] +**Timestamp** | Pointer to **SailPointTime** | | [optional] + +## Methods + +### NewAccessRequestRecommendationActionItemResponseDto + +`func NewAccessRequestRecommendationActionItemResponseDto() *AccessRequestRecommendationActionItemResponseDto` + +NewAccessRequestRecommendationActionItemResponseDto instantiates a new AccessRequestRecommendationActionItemResponseDto 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 + +### NewAccessRequestRecommendationActionItemResponseDtoWithDefaults + +`func NewAccessRequestRecommendationActionItemResponseDtoWithDefaults() *AccessRequestRecommendationActionItemResponseDto` + +NewAccessRequestRecommendationActionItemResponseDtoWithDefaults instantiates a new AccessRequestRecommendationActionItemResponseDto 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 + +### GetIdentityId + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessRequestRecommendationActionItemResponseDto) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccessRequestRecommendationActionItemResponseDto) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetAccess + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetAccess() AccessRequestRecommendationItem` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetAccessOk() (*AccessRequestRecommendationItem, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *AccessRequestRecommendationActionItemResponseDto) SetAccess(v AccessRequestRecommendationItem)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *AccessRequestRecommendationActionItemResponseDto) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetTimestamp + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *AccessRequestRecommendationActionItemResponseDto) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *AccessRequestRecommendationActionItemResponseDto) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *AccessRequestRecommendationActionItemResponseDto) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationConfigDto.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationConfigDto.md new file mode 100644 index 000000000..658aae307 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationConfigDto.md @@ -0,0 +1,189 @@ +--- +id: v2025-access-request-recommendation-config-dto +title: AccessRequestRecommendationConfigDto +pagination_label: AccessRequestRecommendationConfigDto +sidebar_label: AccessRequestRecommendationConfigDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationConfigDto', 'V2025AccessRequestRecommendationConfigDto'] +slug: /tools/sdk/go/v2025/models/access-request-recommendation-config-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationConfigDto', 'V2025AccessRequestRecommendationConfigDto'] +--- + +# AccessRequestRecommendationConfigDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ScoreThreshold** | **float32** | The value that internal calculations need to exceed for recommendations to be made. | +**StartDateAttribute** | Pointer to **string** | Use to map an attribute name for determining identities' start date. | [optional] +**RestrictionAttribute** | Pointer to **string** | Use to only give recommendations based on this attribute. | [optional] +**MoverAttribute** | Pointer to **string** | Use to map an attribute name for determining whether identities are movers. | [optional] +**JoinerAttribute** | Pointer to **string** | Use to map an attribute name for determining whether identities are joiners. | [optional] +**UseRestrictionAttribute** | Pointer to **bool** | Use only the attribute named in restrictionAttribute to make recommendations. | [optional] [default to false] + +## Methods + +### NewAccessRequestRecommendationConfigDto + +`func NewAccessRequestRecommendationConfigDto(scoreThreshold float32, ) *AccessRequestRecommendationConfigDto` + +NewAccessRequestRecommendationConfigDto instantiates a new AccessRequestRecommendationConfigDto 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 + +### NewAccessRequestRecommendationConfigDtoWithDefaults + +`func NewAccessRequestRecommendationConfigDtoWithDefaults() *AccessRequestRecommendationConfigDto` + +NewAccessRequestRecommendationConfigDtoWithDefaults instantiates a new AccessRequestRecommendationConfigDto 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 + +### GetScoreThreshold + +`func (o *AccessRequestRecommendationConfigDto) GetScoreThreshold() float32` + +GetScoreThreshold returns the ScoreThreshold field if non-nil, zero value otherwise. + +### GetScoreThresholdOk + +`func (o *AccessRequestRecommendationConfigDto) GetScoreThresholdOk() (*float32, bool)` + +GetScoreThresholdOk returns a tuple with the ScoreThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScoreThreshold + +`func (o *AccessRequestRecommendationConfigDto) SetScoreThreshold(v float32)` + +SetScoreThreshold sets ScoreThreshold field to given value. + + +### GetStartDateAttribute + +`func (o *AccessRequestRecommendationConfigDto) GetStartDateAttribute() string` + +GetStartDateAttribute returns the StartDateAttribute field if non-nil, zero value otherwise. + +### GetStartDateAttributeOk + +`func (o *AccessRequestRecommendationConfigDto) GetStartDateAttributeOk() (*string, bool)` + +GetStartDateAttributeOk returns a tuple with the StartDateAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDateAttribute + +`func (o *AccessRequestRecommendationConfigDto) SetStartDateAttribute(v string)` + +SetStartDateAttribute sets StartDateAttribute field to given value. + +### HasStartDateAttribute + +`func (o *AccessRequestRecommendationConfigDto) HasStartDateAttribute() bool` + +HasStartDateAttribute returns a boolean if a field has been set. + +### GetRestrictionAttribute + +`func (o *AccessRequestRecommendationConfigDto) GetRestrictionAttribute() string` + +GetRestrictionAttribute returns the RestrictionAttribute field if non-nil, zero value otherwise. + +### GetRestrictionAttributeOk + +`func (o *AccessRequestRecommendationConfigDto) GetRestrictionAttributeOk() (*string, bool)` + +GetRestrictionAttributeOk returns a tuple with the RestrictionAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestrictionAttribute + +`func (o *AccessRequestRecommendationConfigDto) SetRestrictionAttribute(v string)` + +SetRestrictionAttribute sets RestrictionAttribute field to given value. + +### HasRestrictionAttribute + +`func (o *AccessRequestRecommendationConfigDto) HasRestrictionAttribute() bool` + +HasRestrictionAttribute returns a boolean if a field has been set. + +### GetMoverAttribute + +`func (o *AccessRequestRecommendationConfigDto) GetMoverAttribute() string` + +GetMoverAttribute returns the MoverAttribute field if non-nil, zero value otherwise. + +### GetMoverAttributeOk + +`func (o *AccessRequestRecommendationConfigDto) GetMoverAttributeOk() (*string, bool)` + +GetMoverAttributeOk returns a tuple with the MoverAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMoverAttribute + +`func (o *AccessRequestRecommendationConfigDto) SetMoverAttribute(v string)` + +SetMoverAttribute sets MoverAttribute field to given value. + +### HasMoverAttribute + +`func (o *AccessRequestRecommendationConfigDto) HasMoverAttribute() bool` + +HasMoverAttribute returns a boolean if a field has been set. + +### GetJoinerAttribute + +`func (o *AccessRequestRecommendationConfigDto) GetJoinerAttribute() string` + +GetJoinerAttribute returns the JoinerAttribute field if non-nil, zero value otherwise. + +### GetJoinerAttributeOk + +`func (o *AccessRequestRecommendationConfigDto) GetJoinerAttributeOk() (*string, bool)` + +GetJoinerAttributeOk returns a tuple with the JoinerAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJoinerAttribute + +`func (o *AccessRequestRecommendationConfigDto) SetJoinerAttribute(v string)` + +SetJoinerAttribute sets JoinerAttribute field to given value. + +### HasJoinerAttribute + +`func (o *AccessRequestRecommendationConfigDto) HasJoinerAttribute() bool` + +HasJoinerAttribute returns a boolean if a field has been set. + +### GetUseRestrictionAttribute + +`func (o *AccessRequestRecommendationConfigDto) GetUseRestrictionAttribute() bool` + +GetUseRestrictionAttribute returns the UseRestrictionAttribute field if non-nil, zero value otherwise. + +### GetUseRestrictionAttributeOk + +`func (o *AccessRequestRecommendationConfigDto) GetUseRestrictionAttributeOk() (*bool, bool)` + +GetUseRestrictionAttributeOk returns a tuple with the UseRestrictionAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseRestrictionAttribute + +`func (o *AccessRequestRecommendationConfigDto) SetUseRestrictionAttribute(v bool)` + +SetUseRestrictionAttribute sets UseRestrictionAttribute field to given value. + +### HasUseRestrictionAttribute + +`func (o *AccessRequestRecommendationConfigDto) HasUseRestrictionAttribute() bool` + +HasUseRestrictionAttribute returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationItem.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationItem.md new file mode 100644 index 000000000..29843d7ac --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationItem.md @@ -0,0 +1,90 @@ +--- +id: v2025-access-request-recommendation-item +title: AccessRequestRecommendationItem +pagination_label: AccessRequestRecommendationItem +sidebar_label: AccessRequestRecommendationItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationItem', 'V2025AccessRequestRecommendationItem'] +slug: /tools/sdk/go/v2025/models/access-request-recommendation-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItem', 'V2025AccessRequestRecommendationItem'] +--- + +# AccessRequestRecommendationItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of access item being recommended. | [optional] +**Type** | Pointer to [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional] + +## Methods + +### NewAccessRequestRecommendationItem + +`func NewAccessRequestRecommendationItem() *AccessRequestRecommendationItem` + +NewAccessRequestRecommendationItem instantiates a new AccessRequestRecommendationItem 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 + +### NewAccessRequestRecommendationItemWithDefaults + +`func NewAccessRequestRecommendationItemWithDefaults() *AccessRequestRecommendationItem` + +NewAccessRequestRecommendationItemWithDefaults instantiates a new AccessRequestRecommendationItem 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 + +### GetId + +`func (o *AccessRequestRecommendationItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestRecommendationItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestRecommendationItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessRequestRecommendationItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessRequestRecommendationItem) GetType() AccessRequestRecommendationItemType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestRecommendationItem) GetTypeOk() (*AccessRequestRecommendationItemType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestRecommendationItem) SetType(v AccessRequestRecommendationItemType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessRequestRecommendationItem) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationItemDetail.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationItemDetail.md new file mode 100644 index 000000000..cf0afaf0e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationItemDetail.md @@ -0,0 +1,220 @@ +--- +id: v2025-access-request-recommendation-item-detail +title: AccessRequestRecommendationItemDetail +pagination_label: AccessRequestRecommendationItemDetail +sidebar_label: AccessRequestRecommendationItemDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationItemDetail', 'V2025AccessRequestRecommendationItemDetail'] +slug: /tools/sdk/go/v2025/models/access-request-recommendation-item-detail +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetail', 'V2025AccessRequestRecommendationItemDetail'] +--- + +# AccessRequestRecommendationItemDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | Identity ID for the recommendation | [optional] +**Access** | Pointer to [**AccessRequestRecommendationItemDetailAccess**](access-request-recommendation-item-detail-access) | | [optional] +**Ignored** | Pointer to **bool** | Whether or not the identity has already chosen to ignore this recommendation. | [optional] +**Requested** | Pointer to **bool** | Whether or not the identity has already chosen to request this recommendation. | [optional] +**Viewed** | Pointer to **bool** | Whether or not the identity reportedly viewed this recommendation. | [optional] +**Messages** | Pointer to [**[]AccessRecommendationMessage**](access-recommendation-message) | | [optional] +**TranslationMessages** | Pointer to [**[]TranslationMessage**](translation-message) | The list of translation messages | [optional] + +## Methods + +### NewAccessRequestRecommendationItemDetail + +`func NewAccessRequestRecommendationItemDetail() *AccessRequestRecommendationItemDetail` + +NewAccessRequestRecommendationItemDetail instantiates a new AccessRequestRecommendationItemDetail 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 + +### NewAccessRequestRecommendationItemDetailWithDefaults + +`func NewAccessRequestRecommendationItemDetailWithDefaults() *AccessRequestRecommendationItemDetail` + +NewAccessRequestRecommendationItemDetailWithDefaults instantiates a new AccessRequestRecommendationItemDetail 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 + +### GetIdentityId + +`func (o *AccessRequestRecommendationItemDetail) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessRequestRecommendationItemDetail) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessRequestRecommendationItemDetail) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccessRequestRecommendationItemDetail) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetAccess + +`func (o *AccessRequestRecommendationItemDetail) GetAccess() AccessRequestRecommendationItemDetailAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *AccessRequestRecommendationItemDetail) GetAccessOk() (*AccessRequestRecommendationItemDetailAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *AccessRequestRecommendationItemDetail) SetAccess(v AccessRequestRecommendationItemDetailAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *AccessRequestRecommendationItemDetail) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetIgnored + +`func (o *AccessRequestRecommendationItemDetail) GetIgnored() bool` + +GetIgnored returns the Ignored field if non-nil, zero value otherwise. + +### GetIgnoredOk + +`func (o *AccessRequestRecommendationItemDetail) GetIgnoredOk() (*bool, bool)` + +GetIgnoredOk returns a tuple with the Ignored field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIgnored + +`func (o *AccessRequestRecommendationItemDetail) SetIgnored(v bool)` + +SetIgnored sets Ignored field to given value. + +### HasIgnored + +`func (o *AccessRequestRecommendationItemDetail) HasIgnored() bool` + +HasIgnored returns a boolean if a field has been set. + +### GetRequested + +`func (o *AccessRequestRecommendationItemDetail) GetRequested() bool` + +GetRequested returns the Requested field if non-nil, zero value otherwise. + +### GetRequestedOk + +`func (o *AccessRequestRecommendationItemDetail) GetRequestedOk() (*bool, bool)` + +GetRequestedOk returns a tuple with the Requested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequested + +`func (o *AccessRequestRecommendationItemDetail) SetRequested(v bool)` + +SetRequested sets Requested field to given value. + +### HasRequested + +`func (o *AccessRequestRecommendationItemDetail) HasRequested() bool` + +HasRequested returns a boolean if a field has been set. + +### GetViewed + +`func (o *AccessRequestRecommendationItemDetail) GetViewed() bool` + +GetViewed returns the Viewed field if non-nil, zero value otherwise. + +### GetViewedOk + +`func (o *AccessRequestRecommendationItemDetail) GetViewedOk() (*bool, bool)` + +GetViewedOk returns a tuple with the Viewed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViewed + +`func (o *AccessRequestRecommendationItemDetail) SetViewed(v bool)` + +SetViewed sets Viewed field to given value. + +### HasViewed + +`func (o *AccessRequestRecommendationItemDetail) HasViewed() bool` + +HasViewed returns a boolean if a field has been set. + +### GetMessages + +`func (o *AccessRequestRecommendationItemDetail) GetMessages() []AccessRecommendationMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *AccessRequestRecommendationItemDetail) GetMessagesOk() (*[]AccessRecommendationMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *AccessRequestRecommendationItemDetail) SetMessages(v []AccessRecommendationMessage)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *AccessRequestRecommendationItemDetail) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetTranslationMessages + +`func (o *AccessRequestRecommendationItemDetail) GetTranslationMessages() []TranslationMessage` + +GetTranslationMessages returns the TranslationMessages field if non-nil, zero value otherwise. + +### GetTranslationMessagesOk + +`func (o *AccessRequestRecommendationItemDetail) GetTranslationMessagesOk() (*[]TranslationMessage, bool)` + +GetTranslationMessagesOk returns a tuple with the TranslationMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslationMessages + +`func (o *AccessRequestRecommendationItemDetail) SetTranslationMessages(v []TranslationMessage)` + +SetTranslationMessages sets TranslationMessages field to given value. + +### HasTranslationMessages + +`func (o *AccessRequestRecommendationItemDetail) HasTranslationMessages() bool` + +HasTranslationMessages returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationItemDetailAccess.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationItemDetailAccess.md new file mode 100644 index 000000000..11edb25b2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationItemDetailAccess.md @@ -0,0 +1,142 @@ +--- +id: v2025-access-request-recommendation-item-detail-access +title: AccessRequestRecommendationItemDetailAccess +pagination_label: AccessRequestRecommendationItemDetailAccess +sidebar_label: AccessRequestRecommendationItemDetailAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationItemDetailAccess', 'V2025AccessRequestRecommendationItemDetailAccess'] +slug: /tools/sdk/go/v2025/models/access-request-recommendation-item-detail-access +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetailAccess', 'V2025AccessRequestRecommendationItemDetailAccess'] +--- + +# AccessRequestRecommendationItemDetailAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of access item being recommended. | [optional] +**Type** | Pointer to [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional] +**Name** | Pointer to **string** | Name of the access item | [optional] +**Description** | Pointer to **string** | Description of the access item | [optional] + +## Methods + +### NewAccessRequestRecommendationItemDetailAccess + +`func NewAccessRequestRecommendationItemDetailAccess() *AccessRequestRecommendationItemDetailAccess` + +NewAccessRequestRecommendationItemDetailAccess instantiates a new AccessRequestRecommendationItemDetailAccess 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 + +### NewAccessRequestRecommendationItemDetailAccessWithDefaults + +`func NewAccessRequestRecommendationItemDetailAccessWithDefaults() *AccessRequestRecommendationItemDetailAccess` + +NewAccessRequestRecommendationItemDetailAccessWithDefaults instantiates a new AccessRequestRecommendationItemDetailAccess 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 + +### GetId + +`func (o *AccessRequestRecommendationItemDetailAccess) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestRecommendationItemDetailAccess) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestRecommendationItemDetailAccess) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessRequestRecommendationItemDetailAccess) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessRequestRecommendationItemDetailAccess) GetType() AccessRequestRecommendationItemType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestRecommendationItemDetailAccess) GetTypeOk() (*AccessRequestRecommendationItemType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestRecommendationItemDetailAccess) SetType(v AccessRequestRecommendationItemType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessRequestRecommendationItemDetailAccess) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccessRequestRecommendationItemDetailAccess) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestRecommendationItemDetailAccess) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestRecommendationItemDetailAccess) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessRequestRecommendationItemDetailAccess) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessRequestRecommendationItemDetailAccess) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessRequestRecommendationItemDetailAccess) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessRequestRecommendationItemDetailAccess) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessRequestRecommendationItemDetailAccess) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationItemType.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationItemType.md new file mode 100644 index 000000000..2e796017f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestRecommendationItemType.md @@ -0,0 +1,21 @@ +--- +id: v2025-access-request-recommendation-item-type +title: AccessRequestRecommendationItemType +pagination_label: AccessRequestRecommendationItemType +sidebar_label: AccessRequestRecommendationItemType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestRecommendationItemType', 'V2025AccessRequestRecommendationItemType'] +slug: /tools/sdk/go/v2025/models/access-request-recommendation-item-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemType', 'V2025AccessRequestRecommendationItemType'] +--- + +# AccessRequestRecommendationItemType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestResponse.md new file mode 100644 index 000000000..8466886f9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestResponse.md @@ -0,0 +1,90 @@ +--- +id: v2025-access-request-response +title: AccessRequestResponse +pagination_label: AccessRequestResponse +sidebar_label: AccessRequestResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestResponse', 'V2025AccessRequestResponse'] +slug: /tools/sdk/go/v2025/models/access-request-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'V2025AccessRequestResponse'] +--- + +# AccessRequestResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewRequests** | Pointer to [**[]AccessRequestTracking**](access-request-tracking) | A list of new access request tracking data mapped to the values requested. | [optional] +**ExistingRequests** | Pointer to [**[]AccessRequestTracking**](access-request-tracking) | A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. | [optional] + +## Methods + +### NewAccessRequestResponse + +`func NewAccessRequestResponse() *AccessRequestResponse` + +NewAccessRequestResponse instantiates a new AccessRequestResponse 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 + +### NewAccessRequestResponseWithDefaults + +`func NewAccessRequestResponseWithDefaults() *AccessRequestResponse` + +NewAccessRequestResponseWithDefaults instantiates a new AccessRequestResponse 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 + +### GetNewRequests + +`func (o *AccessRequestResponse) GetNewRequests() []AccessRequestTracking` + +GetNewRequests returns the NewRequests field if non-nil, zero value otherwise. + +### GetNewRequestsOk + +`func (o *AccessRequestResponse) GetNewRequestsOk() (*[]AccessRequestTracking, bool)` + +GetNewRequestsOk returns a tuple with the NewRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewRequests + +`func (o *AccessRequestResponse) SetNewRequests(v []AccessRequestTracking)` + +SetNewRequests sets NewRequests field to given value. + +### HasNewRequests + +`func (o *AccessRequestResponse) HasNewRequests() bool` + +HasNewRequests returns a boolean if a field has been set. + +### GetExistingRequests + +`func (o *AccessRequestResponse) GetExistingRequests() []AccessRequestTracking` + +GetExistingRequests returns the ExistingRequests field if non-nil, zero value otherwise. + +### GetExistingRequestsOk + +`func (o *AccessRequestResponse) GetExistingRequestsOk() (*[]AccessRequestTracking, bool)` + +GetExistingRequestsOk returns a tuple with the ExistingRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExistingRequests + +`func (o *AccessRequestResponse) SetExistingRequests(v []AccessRequestTracking)` + +SetExistingRequests sets ExistingRequests field to given value. + +### HasExistingRequests + +`func (o *AccessRequestResponse) HasExistingRequests() bool` + +HasExistingRequests returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestResponse1.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestResponse1.md new file mode 100644 index 000000000..a3d613720 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestResponse1.md @@ -0,0 +1,116 @@ +--- +id: v2025-access-request-response1 +title: AccessRequestResponse1 +pagination_label: AccessRequestResponse1 +sidebar_label: AccessRequestResponse1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestResponse1', 'V2025AccessRequestResponse1'] +slug: /tools/sdk/go/v2025/models/access-request-response1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse1', 'V2025AccessRequestResponse1'] +--- + +# AccessRequestResponse1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequesterId** | Pointer to **string** | the requester Id | [optional] +**RequesterName** | Pointer to **string** | the requesterName | [optional] +**Items** | Pointer to [**[]AccessRequestItemResponse**](access-request-item-response) | | [optional] + +## Methods + +### NewAccessRequestResponse1 + +`func NewAccessRequestResponse1() *AccessRequestResponse1` + +NewAccessRequestResponse1 instantiates a new AccessRequestResponse1 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 + +### NewAccessRequestResponse1WithDefaults + +`func NewAccessRequestResponse1WithDefaults() *AccessRequestResponse1` + +NewAccessRequestResponse1WithDefaults instantiates a new AccessRequestResponse1 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 + +### GetRequesterId + +`func (o *AccessRequestResponse1) GetRequesterId() string` + +GetRequesterId returns the RequesterId field if non-nil, zero value otherwise. + +### GetRequesterIdOk + +`func (o *AccessRequestResponse1) GetRequesterIdOk() (*string, bool)` + +GetRequesterIdOk returns a tuple with the RequesterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterId + +`func (o *AccessRequestResponse1) SetRequesterId(v string)` + +SetRequesterId sets RequesterId field to given value. + +### HasRequesterId + +`func (o *AccessRequestResponse1) HasRequesterId() bool` + +HasRequesterId returns a boolean if a field has been set. + +### GetRequesterName + +`func (o *AccessRequestResponse1) GetRequesterName() string` + +GetRequesterName returns the RequesterName field if non-nil, zero value otherwise. + +### GetRequesterNameOk + +`func (o *AccessRequestResponse1) GetRequesterNameOk() (*string, bool)` + +GetRequesterNameOk returns a tuple with the RequesterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterName + +`func (o *AccessRequestResponse1) SetRequesterName(v string)` + +SetRequesterName sets RequesterName field to given value. + +### HasRequesterName + +`func (o *AccessRequestResponse1) HasRequesterName() bool` + +HasRequesterName returns a boolean if a field has been set. + +### GetItems + +`func (o *AccessRequestResponse1) GetItems() []AccessRequestItemResponse` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *AccessRequestResponse1) GetItemsOk() (*[]AccessRequestItemResponse, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *AccessRequestResponse1) SetItems(v []AccessRequestItemResponse)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *AccessRequestResponse1) HasItems() bool` + +HasItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestTracking.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestTracking.md new file mode 100644 index 000000000..41a19c636 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestTracking.md @@ -0,0 +1,142 @@ +--- +id: v2025-access-request-tracking +title: AccessRequestTracking +pagination_label: AccessRequestTracking +sidebar_label: AccessRequestTracking +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestTracking', 'V2025AccessRequestTracking'] +slug: /tools/sdk/go/v2025/models/access-request-tracking +tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'V2025AccessRequestTracking'] +--- + +# AccessRequestTracking + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedFor** | Pointer to **string** | The identity id in which the access request is for. | [optional] +**RequestedItemsDetails** | Pointer to [**[]RequestedItemDetails**](requested-item-details) | The details of the item requested. | [optional] +**AttributesHash** | Pointer to **int32** | a hash representation of the access requested, useful for longer term tracking client side. | [optional] +**AccessRequestIds** | Pointer to **[]string** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [optional] + +## Methods + +### NewAccessRequestTracking + +`func NewAccessRequestTracking() *AccessRequestTracking` + +NewAccessRequestTracking instantiates a new AccessRequestTracking 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 + +### NewAccessRequestTrackingWithDefaults + +`func NewAccessRequestTrackingWithDefaults() *AccessRequestTracking` + +NewAccessRequestTrackingWithDefaults instantiates a new AccessRequestTracking 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 + +### GetRequestedFor + +`func (o *AccessRequestTracking) GetRequestedFor() string` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequestTracking) GetRequestedForOk() (*string, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequestTracking) SetRequestedFor(v string)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *AccessRequestTracking) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetRequestedItemsDetails + +`func (o *AccessRequestTracking) GetRequestedItemsDetails() []RequestedItemDetails` + +GetRequestedItemsDetails returns the RequestedItemsDetails field if non-nil, zero value otherwise. + +### GetRequestedItemsDetailsOk + +`func (o *AccessRequestTracking) GetRequestedItemsDetailsOk() (*[]RequestedItemDetails, bool)` + +GetRequestedItemsDetailsOk returns a tuple with the RequestedItemsDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItemsDetails + +`func (o *AccessRequestTracking) SetRequestedItemsDetails(v []RequestedItemDetails)` + +SetRequestedItemsDetails sets RequestedItemsDetails field to given value. + +### HasRequestedItemsDetails + +`func (o *AccessRequestTracking) HasRequestedItemsDetails() bool` + +HasRequestedItemsDetails returns a boolean if a field has been set. + +### GetAttributesHash + +`func (o *AccessRequestTracking) GetAttributesHash() int32` + +GetAttributesHash returns the AttributesHash field if non-nil, zero value otherwise. + +### GetAttributesHashOk + +`func (o *AccessRequestTracking) GetAttributesHashOk() (*int32, bool)` + +GetAttributesHashOk returns a tuple with the AttributesHash field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributesHash + +`func (o *AccessRequestTracking) SetAttributesHash(v int32)` + +SetAttributesHash sets AttributesHash field to given value. + +### HasAttributesHash + +`func (o *AccessRequestTracking) HasAttributesHash() bool` + +HasAttributesHash returns a boolean if a field has been set. + +### GetAccessRequestIds + +`func (o *AccessRequestTracking) GetAccessRequestIds() []string` + +GetAccessRequestIds returns the AccessRequestIds field if non-nil, zero value otherwise. + +### GetAccessRequestIdsOk + +`func (o *AccessRequestTracking) GetAccessRequestIdsOk() (*[]string, bool)` + +GetAccessRequestIdsOk returns a tuple with the AccessRequestIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestIds + +`func (o *AccessRequestTracking) SetAccessRequestIds(v []string)` + +SetAccessRequestIds sets AccessRequestIds field to given value. + +### HasAccessRequestIds + +`func (o *AccessRequestTracking) HasAccessRequestIds() bool` + +HasAccessRequestIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestType.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestType.md new file mode 100644 index 000000000..d08136684 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequestType.md @@ -0,0 +1,21 @@ +--- +id: v2025-access-request-type +title: AccessRequestType +pagination_label: AccessRequestType +sidebar_label: AccessRequestType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestType', 'V2025AccessRequestType'] +slug: /tools/sdk/go/v2025/models/access-request-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestType', 'V2025AccessRequestType'] +--- + +# AccessRequestType + +## Enum + + +* `GRANT_ACCESS` (value: `"GRANT_ACCESS"`) + +* `REVOKE_ACCESS` (value: `"REVOKE_ACCESS"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessRequested.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequested.md new file mode 100644 index 000000000..af0a9f022 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessRequested.md @@ -0,0 +1,142 @@ +--- +id: v2025-access-requested +title: AccessRequested +pagination_label: AccessRequested +sidebar_label: AccessRequested +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequested', 'V2025AccessRequested'] +slug: /tools/sdk/go/v2025/models/access-requested +tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'V2025AccessRequested'] +--- + +# AccessRequested + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequest** | Pointer to [**AccessRequestResponse1**](access-request-response1) | | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] + +## Methods + +### NewAccessRequested + +`func NewAccessRequested() *AccessRequested` + +NewAccessRequested instantiates a new AccessRequested 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 + +### NewAccessRequestedWithDefaults + +`func NewAccessRequestedWithDefaults() *AccessRequested` + +NewAccessRequestedWithDefaults instantiates a new AccessRequested 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 + +### GetAccessRequest + +`func (o *AccessRequested) GetAccessRequest() AccessRequestResponse1` + +GetAccessRequest returns the AccessRequest field if non-nil, zero value otherwise. + +### GetAccessRequestOk + +`func (o *AccessRequested) GetAccessRequestOk() (*AccessRequestResponse1, bool)` + +GetAccessRequestOk returns a tuple with the AccessRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequest + +`func (o *AccessRequested) SetAccessRequest(v AccessRequestResponse1)` + +SetAccessRequest sets AccessRequest field to given value. + +### HasAccessRequest + +`func (o *AccessRequested) HasAccessRequest() bool` + +HasAccessRequest returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *AccessRequested) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccessRequested) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccessRequested) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccessRequested) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEventType + +`func (o *AccessRequested) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AccessRequested) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AccessRequested) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AccessRequested) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDt + +`func (o *AccessRequested) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *AccessRequested) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *AccessRequested) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *AccessRequested) HasDt() bool` + +HasDt returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessReviewItem.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessReviewItem.md new file mode 100644 index 000000000..3cbf80e63 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessReviewItem.md @@ -0,0 +1,230 @@ +--- +id: v2025-access-review-item +title: AccessReviewItem +pagination_label: AccessReviewItem +sidebar_label: AccessReviewItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessReviewItem', 'V2025AccessReviewItem'] +slug: /tools/sdk/go/v2025/models/access-review-item +tags: ['SDK', 'Software Development Kit', 'AccessReviewItem', 'V2025AccessReviewItem'] +--- + +# AccessReviewItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessSummary** | Pointer to [**AccessSummary**](access-summary) | | [optional] +**IdentitySummary** | Pointer to [**CertificationIdentitySummary**](certification-identity-summary) | | [optional] +**Id** | Pointer to **string** | The review item's id | [optional] +**Completed** | Pointer to **bool** | Whether the review item is complete | [optional] +**NewAccess** | Pointer to **bool** | Indicates whether the review item is for new access to a source | [optional] +**Decision** | Pointer to [**CertificationDecision**](certification-decision) | | [optional] +**Comments** | Pointer to **NullableString** | Comments for this review item | [optional] + +## Methods + +### NewAccessReviewItem + +`func NewAccessReviewItem() *AccessReviewItem` + +NewAccessReviewItem instantiates a new AccessReviewItem 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 + +### NewAccessReviewItemWithDefaults + +`func NewAccessReviewItemWithDefaults() *AccessReviewItem` + +NewAccessReviewItemWithDefaults instantiates a new AccessReviewItem 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 + +### GetAccessSummary + +`func (o *AccessReviewItem) GetAccessSummary() AccessSummary` + +GetAccessSummary returns the AccessSummary field if non-nil, zero value otherwise. + +### GetAccessSummaryOk + +`func (o *AccessReviewItem) GetAccessSummaryOk() (*AccessSummary, bool)` + +GetAccessSummaryOk returns a tuple with the AccessSummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessSummary + +`func (o *AccessReviewItem) SetAccessSummary(v AccessSummary)` + +SetAccessSummary sets AccessSummary field to given value. + +### HasAccessSummary + +`func (o *AccessReviewItem) HasAccessSummary() bool` + +HasAccessSummary returns a boolean if a field has been set. + +### GetIdentitySummary + +`func (o *AccessReviewItem) GetIdentitySummary() CertificationIdentitySummary` + +GetIdentitySummary returns the IdentitySummary field if non-nil, zero value otherwise. + +### GetIdentitySummaryOk + +`func (o *AccessReviewItem) GetIdentitySummaryOk() (*CertificationIdentitySummary, bool)` + +GetIdentitySummaryOk returns a tuple with the IdentitySummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitySummary + +`func (o *AccessReviewItem) SetIdentitySummary(v CertificationIdentitySummary)` + +SetIdentitySummary sets IdentitySummary field to given value. + +### HasIdentitySummary + +`func (o *AccessReviewItem) HasIdentitySummary() bool` + +HasIdentitySummary returns a boolean if a field has been set. + +### GetId + +`func (o *AccessReviewItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessReviewItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessReviewItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessReviewItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCompleted + +`func (o *AccessReviewItem) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *AccessReviewItem) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *AccessReviewItem) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *AccessReviewItem) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetNewAccess + +`func (o *AccessReviewItem) GetNewAccess() bool` + +GetNewAccess returns the NewAccess field if non-nil, zero value otherwise. + +### GetNewAccessOk + +`func (o *AccessReviewItem) GetNewAccessOk() (*bool, bool)` + +GetNewAccessOk returns a tuple with the NewAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewAccess + +`func (o *AccessReviewItem) SetNewAccess(v bool)` + +SetNewAccess sets NewAccess field to given value. + +### HasNewAccess + +`func (o *AccessReviewItem) HasNewAccess() bool` + +HasNewAccess returns a boolean if a field has been set. + +### GetDecision + +`func (o *AccessReviewItem) GetDecision() CertificationDecision` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *AccessReviewItem) GetDecisionOk() (*CertificationDecision, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *AccessReviewItem) SetDecision(v CertificationDecision)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *AccessReviewItem) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + +### GetComments + +`func (o *AccessReviewItem) GetComments() string` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *AccessReviewItem) GetCommentsOk() (*string, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *AccessReviewItem) SetComments(v string)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *AccessReviewItem) HasComments() bool` + +HasComments returns a boolean if a field has been set. + +### SetCommentsNil + +`func (o *AccessReviewItem) SetCommentsNil(b bool)` + + SetCommentsNil sets the value for Comments to be an explicit nil + +### UnsetComments +`func (o *AccessReviewItem) UnsetComments()` + +UnsetComments ensures that no value is present for Comments, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessReviewReassignment.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessReviewReassignment.md new file mode 100644 index 000000000..746d41ca7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessReviewReassignment.md @@ -0,0 +1,101 @@ +--- +id: v2025-access-review-reassignment +title: AccessReviewReassignment +pagination_label: AccessReviewReassignment +sidebar_label: AccessReviewReassignment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessReviewReassignment', 'V2025AccessReviewReassignment'] +slug: /tools/sdk/go/v2025/models/access-review-reassignment +tags: ['SDK', 'Software Development Kit', 'AccessReviewReassignment', 'V2025AccessReviewReassignment'] +--- + +# AccessReviewReassignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Reassign** | [**[]ReassignReference**](reassign-reference) | | +**ReassignTo** | **string** | The ID of the identity to which the certification is reassigned | +**Reason** | **string** | The reason comment for why the reassign was made | + +## Methods + +### NewAccessReviewReassignment + +`func NewAccessReviewReassignment(reassign []ReassignReference, reassignTo string, reason string, ) *AccessReviewReassignment` + +NewAccessReviewReassignment instantiates a new AccessReviewReassignment 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 + +### NewAccessReviewReassignmentWithDefaults + +`func NewAccessReviewReassignmentWithDefaults() *AccessReviewReassignment` + +NewAccessReviewReassignmentWithDefaults instantiates a new AccessReviewReassignment 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 + +### GetReassign + +`func (o *AccessReviewReassignment) GetReassign() []ReassignReference` + +GetReassign returns the Reassign field if non-nil, zero value otherwise. + +### GetReassignOk + +`func (o *AccessReviewReassignment) GetReassignOk() (*[]ReassignReference, bool)` + +GetReassignOk returns a tuple with the Reassign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassign + +`func (o *AccessReviewReassignment) SetReassign(v []ReassignReference)` + +SetReassign sets Reassign field to given value. + + +### GetReassignTo + +`func (o *AccessReviewReassignment) GetReassignTo() string` + +GetReassignTo returns the ReassignTo field if non-nil, zero value otherwise. + +### GetReassignToOk + +`func (o *AccessReviewReassignment) GetReassignToOk() (*string, bool)` + +GetReassignToOk returns a tuple with the ReassignTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignTo + +`func (o *AccessReviewReassignment) SetReassignTo(v string)` + +SetReassignTo sets ReassignTo field to given value. + + +### GetReason + +`func (o *AccessReviewReassignment) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *AccessReviewReassignment) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *AccessReviewReassignment) SetReason(v string)` + +SetReason sets Reason field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessSummary.md new file mode 100644 index 000000000..910a20e96 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessSummary.md @@ -0,0 +1,162 @@ +--- +id: v2025-access-summary +title: AccessSummary +pagination_label: AccessSummary +sidebar_label: AccessSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessSummary', 'V2025AccessSummary'] +slug: /tools/sdk/go/v2025/models/access-summary +tags: ['SDK', 'Software Development Kit', 'AccessSummary', 'V2025AccessSummary'] +--- + +# AccessSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Access** | Pointer to [**AccessSummaryAccess**](access-summary-access) | | [optional] +**Entitlement** | Pointer to [**NullableReviewableEntitlement**](reviewable-entitlement) | | [optional] +**AccessProfile** | Pointer to [**ReviewableAccessProfile**](reviewable-access-profile) | | [optional] +**Role** | Pointer to [**NullableReviewableRole**](reviewable-role) | | [optional] + +## Methods + +### NewAccessSummary + +`func NewAccessSummary() *AccessSummary` + +NewAccessSummary instantiates a new AccessSummary 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 + +### NewAccessSummaryWithDefaults + +`func NewAccessSummaryWithDefaults() *AccessSummary` + +NewAccessSummaryWithDefaults instantiates a new AccessSummary 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 + +### GetAccess + +`func (o *AccessSummary) GetAccess() AccessSummaryAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *AccessSummary) GetAccessOk() (*AccessSummaryAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *AccessSummary) SetAccess(v AccessSummaryAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *AccessSummary) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetEntitlement + +`func (o *AccessSummary) GetEntitlement() ReviewableEntitlement` + +GetEntitlement returns the Entitlement field if non-nil, zero value otherwise. + +### GetEntitlementOk + +`func (o *AccessSummary) GetEntitlementOk() (*ReviewableEntitlement, bool)` + +GetEntitlementOk returns a tuple with the Entitlement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlement + +`func (o *AccessSummary) SetEntitlement(v ReviewableEntitlement)` + +SetEntitlement sets Entitlement field to given value. + +### HasEntitlement + +`func (o *AccessSummary) HasEntitlement() bool` + +HasEntitlement returns a boolean if a field has been set. + +### SetEntitlementNil + +`func (o *AccessSummary) SetEntitlementNil(b bool)` + + SetEntitlementNil sets the value for Entitlement to be an explicit nil + +### UnsetEntitlement +`func (o *AccessSummary) UnsetEntitlement()` + +UnsetEntitlement ensures that no value is present for Entitlement, not even an explicit nil +### GetAccessProfile + +`func (o *AccessSummary) GetAccessProfile() ReviewableAccessProfile` + +GetAccessProfile returns the AccessProfile field if non-nil, zero value otherwise. + +### GetAccessProfileOk + +`func (o *AccessSummary) GetAccessProfileOk() (*ReviewableAccessProfile, bool)` + +GetAccessProfileOk returns a tuple with the AccessProfile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfile + +`func (o *AccessSummary) SetAccessProfile(v ReviewableAccessProfile)` + +SetAccessProfile sets AccessProfile field to given value. + +### HasAccessProfile + +`func (o *AccessSummary) HasAccessProfile() bool` + +HasAccessProfile returns a boolean if a field has been set. + +### GetRole + +`func (o *AccessSummary) GetRole() ReviewableRole` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *AccessSummary) GetRoleOk() (*ReviewableRole, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *AccessSummary) SetRole(v ReviewableRole)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *AccessSummary) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### SetRoleNil + +`func (o *AccessSummary) SetRoleNil(b bool)` + + SetRoleNil sets the value for Role to be an explicit nil + +### UnsetRole +`func (o *AccessSummary) UnsetRole()` + +UnsetRole ensures that no value is present for Role, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessSummaryAccess.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessSummaryAccess.md new file mode 100644 index 000000000..823db515e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessSummaryAccess.md @@ -0,0 +1,116 @@ +--- +id: v2025-access-summary-access +title: AccessSummaryAccess +pagination_label: AccessSummaryAccess +sidebar_label: AccessSummaryAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessSummaryAccess', 'V2025AccessSummaryAccess'] +slug: /tools/sdk/go/v2025/models/access-summary-access +tags: ['SDK', 'Software Development Kit', 'AccessSummaryAccess', 'V2025AccessSummaryAccess'] +--- + +# AccessSummaryAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | The ID of the item being certified | [optional] +**Name** | Pointer to **string** | The name of the item being certified | [optional] + +## Methods + +### NewAccessSummaryAccess + +`func NewAccessSummaryAccess() *AccessSummaryAccess` + +NewAccessSummaryAccess instantiates a new AccessSummaryAccess 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 + +### NewAccessSummaryAccessWithDefaults + +`func NewAccessSummaryAccessWithDefaults() *AccessSummaryAccess` + +NewAccessSummaryAccessWithDefaults instantiates a new AccessSummaryAccess 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 + +### GetType + +`func (o *AccessSummaryAccess) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessSummaryAccess) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessSummaryAccess) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessSummaryAccess) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessSummaryAccess) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessSummaryAccess) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessSummaryAccess) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessSummaryAccess) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessSummaryAccess) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessSummaryAccess) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessSummaryAccess) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessSummaryAccess) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccessType.md b/docs/tools/sdk/go/Reference/V2025/Models/AccessType.md new file mode 100644 index 000000000..a4713da4e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccessType.md @@ -0,0 +1,21 @@ +--- +id: v2025-access-type +title: AccessType +pagination_label: AccessType +sidebar_label: AccessType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessType', 'V2025AccessType'] +slug: /tools/sdk/go/v2025/models/access-type +tags: ['SDK', 'Software Development Kit', 'AccessType', 'V2025AccessType'] +--- + +# AccessType + +## Enum + + +* `ONLINE` (value: `"ONLINE"`) + +* `OFFLINE` (value: `"OFFLINE"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Account.md b/docs/tools/sdk/go/Reference/V2025/Models/Account.md new file mode 100644 index 000000000..b923d1687 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Account.md @@ -0,0 +1,816 @@ +--- +id: v2025-account +title: Account +pagination_label: Account +sidebar_label: Account +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Account', 'V2025Account'] +slug: /tools/sdk/go/v2025/models/account +tags: ['SDK', 'Software Development Kit', 'Account', 'V2025Account'] +--- + +# Account + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**SourceId** | **string** | The unique ID of the source this account belongs to | +**SourceName** | **NullableString** | The display name of the source this account belongs to | +**IdentityId** | Pointer to **string** | The unique ID of the identity this account is correlated to | [optional] +**CloudLifecycleState** | Pointer to **NullableString** | The lifecycle state of the identity this account is correlated to | [optional] +**IdentityState** | Pointer to **NullableString** | The identity state of the identity this account is correlated to | [optional] +**ConnectionType** | Pointer to **NullableString** | The connection type of the source this account is from | [optional] +**IsMachine** | Pointer to **bool** | Indicates if the account is of machine type | [optional] [default to false] +**Recommendation** | Pointer to [**AccountAllOfRecommendation**](account-all-of-recommendation) | | [optional] +**Attributes** | **map[string]interface{}** | The account attributes that are aggregated | +**Authoritative** | **bool** | Indicates if this account is from an authoritative source | +**Description** | Pointer to **NullableString** | A description of the account | [optional] +**Disabled** | **bool** | Indicates if the account is currently disabled | +**Locked** | **bool** | Indicates if the account is currently locked | +**NativeIdentity** | **string** | The unique ID of the account generated by the source system | +**SystemAccount** | **bool** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | +**Uncorrelated** | **bool** | Indicates if this account is not correlated to an identity | +**Uuid** | Pointer to **NullableString** | The unique ID of the account as determined by the account schema | [optional] +**ManuallyCorrelated** | **bool** | Indicates if the account has been manually correlated to an identity | +**HasEntitlements** | **bool** | Indicates if the account has entitlements | +**Identity** | Pointer to [**AccountAllOfIdentity**](account-all-of-identity) | | [optional] +**SourceOwner** | Pointer to [**NullableAccountAllOfSourceOwner**](account-all-of-source-owner) | | [optional] +**Features** | Pointer to **NullableString** | A string list containing the owning source's features | [optional] +**Origin** | Pointer to **NullableString** | The origin of the account either aggregated or provisioned | [optional] +**OwnerIdentity** | Pointer to [**AccountAllOfOwnerIdentity**](account-all-of-owner-identity) | | [optional] + +## Methods + +### NewAccount + +`func NewAccount(name NullableString, sourceId string, sourceName NullableString, attributes map[string]interface{}, authoritative bool, disabled bool, locked bool, nativeIdentity string, systemAccount bool, uncorrelated bool, manuallyCorrelated bool, hasEntitlements bool, ) *Account` + +NewAccount instantiates a new Account 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 + +### NewAccountWithDefaults + +`func NewAccountWithDefaults() *Account` + +NewAccountWithDefaults instantiates a new Account 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 + +### GetId + +`func (o *Account) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Account) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Account) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Account) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Account) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Account) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Account) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *Account) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *Account) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *Account) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Account) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Account) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Account) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Account) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Account) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Account) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Account) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetSourceId + +`func (o *Account) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *Account) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *Account) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetSourceName + +`func (o *Account) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *Account) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *Account) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### SetSourceNameNil + +`func (o *Account) SetSourceNameNil(b bool)` + + SetSourceNameNil sets the value for SourceName to be an explicit nil + +### UnsetSourceName +`func (o *Account) UnsetSourceName()` + +UnsetSourceName ensures that no value is present for SourceName, not even an explicit nil +### GetIdentityId + +`func (o *Account) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *Account) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *Account) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *Account) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetCloudLifecycleState + +`func (o *Account) GetCloudLifecycleState() string` + +GetCloudLifecycleState returns the CloudLifecycleState field if non-nil, zero value otherwise. + +### GetCloudLifecycleStateOk + +`func (o *Account) GetCloudLifecycleStateOk() (*string, bool)` + +GetCloudLifecycleStateOk returns a tuple with the CloudLifecycleState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudLifecycleState + +`func (o *Account) SetCloudLifecycleState(v string)` + +SetCloudLifecycleState sets CloudLifecycleState field to given value. + +### HasCloudLifecycleState + +`func (o *Account) HasCloudLifecycleState() bool` + +HasCloudLifecycleState returns a boolean if a field has been set. + +### SetCloudLifecycleStateNil + +`func (o *Account) SetCloudLifecycleStateNil(b bool)` + + SetCloudLifecycleStateNil sets the value for CloudLifecycleState to be an explicit nil + +### UnsetCloudLifecycleState +`func (o *Account) UnsetCloudLifecycleState()` + +UnsetCloudLifecycleState ensures that no value is present for CloudLifecycleState, not even an explicit nil +### GetIdentityState + +`func (o *Account) GetIdentityState() string` + +GetIdentityState returns the IdentityState field if non-nil, zero value otherwise. + +### GetIdentityStateOk + +`func (o *Account) GetIdentityStateOk() (*string, bool)` + +GetIdentityStateOk returns a tuple with the IdentityState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityState + +`func (o *Account) SetIdentityState(v string)` + +SetIdentityState sets IdentityState field to given value. + +### HasIdentityState + +`func (o *Account) HasIdentityState() bool` + +HasIdentityState returns a boolean if a field has been set. + +### SetIdentityStateNil + +`func (o *Account) SetIdentityStateNil(b bool)` + + SetIdentityStateNil sets the value for IdentityState to be an explicit nil + +### UnsetIdentityState +`func (o *Account) UnsetIdentityState()` + +UnsetIdentityState ensures that no value is present for IdentityState, not even an explicit nil +### GetConnectionType + +`func (o *Account) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *Account) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *Account) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *Account) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + +### SetConnectionTypeNil + +`func (o *Account) SetConnectionTypeNil(b bool)` + + SetConnectionTypeNil sets the value for ConnectionType to be an explicit nil + +### UnsetConnectionType +`func (o *Account) UnsetConnectionType()` + +UnsetConnectionType ensures that no value is present for ConnectionType, not even an explicit nil +### GetIsMachine + +`func (o *Account) GetIsMachine() bool` + +GetIsMachine returns the IsMachine field if non-nil, zero value otherwise. + +### GetIsMachineOk + +`func (o *Account) GetIsMachineOk() (*bool, bool)` + +GetIsMachineOk returns a tuple with the IsMachine field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsMachine + +`func (o *Account) SetIsMachine(v bool)` + +SetIsMachine sets IsMachine field to given value. + +### HasIsMachine + +`func (o *Account) HasIsMachine() bool` + +HasIsMachine returns a boolean if a field has been set. + +### GetRecommendation + +`func (o *Account) GetRecommendation() AccountAllOfRecommendation` + +GetRecommendation returns the Recommendation field if non-nil, zero value otherwise. + +### GetRecommendationOk + +`func (o *Account) GetRecommendationOk() (*AccountAllOfRecommendation, bool)` + +GetRecommendationOk returns a tuple with the Recommendation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendation + +`func (o *Account) SetRecommendation(v AccountAllOfRecommendation)` + +SetRecommendation sets Recommendation field to given value. + +### HasRecommendation + +`func (o *Account) HasRecommendation() bool` + +HasRecommendation returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Account) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Account) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Account) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *Account) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *Account) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetAuthoritative + +`func (o *Account) GetAuthoritative() bool` + +GetAuthoritative returns the Authoritative field if non-nil, zero value otherwise. + +### GetAuthoritativeOk + +`func (o *Account) GetAuthoritativeOk() (*bool, bool)` + +GetAuthoritativeOk returns a tuple with the Authoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritative + +`func (o *Account) SetAuthoritative(v bool)` + +SetAuthoritative sets Authoritative field to given value. + + +### GetDescription + +`func (o *Account) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Account) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Account) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Account) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Account) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Account) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetDisabled + +`func (o *Account) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *Account) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *Account) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + + +### GetLocked + +`func (o *Account) GetLocked() bool` + +GetLocked returns the Locked field if non-nil, zero value otherwise. + +### GetLockedOk + +`func (o *Account) GetLockedOk() (*bool, bool)` + +GetLockedOk returns a tuple with the Locked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocked + +`func (o *Account) SetLocked(v bool)` + +SetLocked sets Locked field to given value. + + +### GetNativeIdentity + +`func (o *Account) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *Account) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *Account) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + + +### GetSystemAccount + +`func (o *Account) GetSystemAccount() bool` + +GetSystemAccount returns the SystemAccount field if non-nil, zero value otherwise. + +### GetSystemAccountOk + +`func (o *Account) GetSystemAccountOk() (*bool, bool)` + +GetSystemAccountOk returns a tuple with the SystemAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSystemAccount + +`func (o *Account) SetSystemAccount(v bool)` + +SetSystemAccount sets SystemAccount field to given value. + + +### GetUncorrelated + +`func (o *Account) GetUncorrelated() bool` + +GetUncorrelated returns the Uncorrelated field if non-nil, zero value otherwise. + +### GetUncorrelatedOk + +`func (o *Account) GetUncorrelatedOk() (*bool, bool)` + +GetUncorrelatedOk returns a tuple with the Uncorrelated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUncorrelated + +`func (o *Account) SetUncorrelated(v bool)` + +SetUncorrelated sets Uncorrelated field to given value. + + +### GetUuid + +`func (o *Account) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *Account) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *Account) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *Account) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *Account) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *Account) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetManuallyCorrelated + +`func (o *Account) GetManuallyCorrelated() bool` + +GetManuallyCorrelated returns the ManuallyCorrelated field if non-nil, zero value otherwise. + +### GetManuallyCorrelatedOk + +`func (o *Account) GetManuallyCorrelatedOk() (*bool, bool)` + +GetManuallyCorrelatedOk returns a tuple with the ManuallyCorrelated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyCorrelated + +`func (o *Account) SetManuallyCorrelated(v bool)` + +SetManuallyCorrelated sets ManuallyCorrelated field to given value. + + +### GetHasEntitlements + +`func (o *Account) GetHasEntitlements() bool` + +GetHasEntitlements returns the HasEntitlements field if non-nil, zero value otherwise. + +### GetHasEntitlementsOk + +`func (o *Account) GetHasEntitlementsOk() (*bool, bool)` + +GetHasEntitlementsOk returns a tuple with the HasEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasEntitlements + +`func (o *Account) SetHasEntitlements(v bool)` + +SetHasEntitlements sets HasEntitlements field to given value. + + +### GetIdentity + +`func (o *Account) GetIdentity() AccountAllOfIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *Account) GetIdentityOk() (*AccountAllOfIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *Account) SetIdentity(v AccountAllOfIdentity)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *Account) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetSourceOwner + +`func (o *Account) GetSourceOwner() AccountAllOfSourceOwner` + +GetSourceOwner returns the SourceOwner field if non-nil, zero value otherwise. + +### GetSourceOwnerOk + +`func (o *Account) GetSourceOwnerOk() (*AccountAllOfSourceOwner, bool)` + +GetSourceOwnerOk returns a tuple with the SourceOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceOwner + +`func (o *Account) SetSourceOwner(v AccountAllOfSourceOwner)` + +SetSourceOwner sets SourceOwner field to given value. + +### HasSourceOwner + +`func (o *Account) HasSourceOwner() bool` + +HasSourceOwner returns a boolean if a field has been set. + +### SetSourceOwnerNil + +`func (o *Account) SetSourceOwnerNil(b bool)` + + SetSourceOwnerNil sets the value for SourceOwner to be an explicit nil + +### UnsetSourceOwner +`func (o *Account) UnsetSourceOwner()` + +UnsetSourceOwner ensures that no value is present for SourceOwner, not even an explicit nil +### GetFeatures + +`func (o *Account) GetFeatures() string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *Account) GetFeaturesOk() (*string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *Account) SetFeatures(v string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *Account) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### SetFeaturesNil + +`func (o *Account) SetFeaturesNil(b bool)` + + SetFeaturesNil sets the value for Features to be an explicit nil + +### UnsetFeatures +`func (o *Account) UnsetFeatures()` + +UnsetFeatures ensures that no value is present for Features, not even an explicit nil +### GetOrigin + +`func (o *Account) GetOrigin() string` + +GetOrigin returns the Origin field if non-nil, zero value otherwise. + +### GetOriginOk + +`func (o *Account) GetOriginOk() (*string, bool)` + +GetOriginOk returns a tuple with the Origin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrigin + +`func (o *Account) SetOrigin(v string)` + +SetOrigin sets Origin field to given value. + +### HasOrigin + +`func (o *Account) HasOrigin() bool` + +HasOrigin returns a boolean if a field has been set. + +### SetOriginNil + +`func (o *Account) SetOriginNil(b bool)` + + SetOriginNil sets the value for Origin to be an explicit nil + +### UnsetOrigin +`func (o *Account) UnsetOrigin()` + +UnsetOrigin ensures that no value is present for Origin, not even an explicit nil +### GetOwnerIdentity + +`func (o *Account) GetOwnerIdentity() AccountAllOfOwnerIdentity` + +GetOwnerIdentity returns the OwnerIdentity field if non-nil, zero value otherwise. + +### GetOwnerIdentityOk + +`func (o *Account) GetOwnerIdentityOk() (*AccountAllOfOwnerIdentity, bool)` + +GetOwnerIdentityOk returns a tuple with the OwnerIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerIdentity + +`func (o *Account) SetOwnerIdentity(v AccountAllOfOwnerIdentity)` + +SetOwnerIdentity sets OwnerIdentity field to given value. + +### HasOwnerIdentity + +`func (o *Account) HasOwnerIdentity() bool` + +HasOwnerIdentity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAction.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAction.md new file mode 100644 index 000000000..d1a2c1e1d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAction.md @@ -0,0 +1,90 @@ +--- +id: v2025-account-action +title: AccountAction +pagination_label: AccountAction +sidebar_label: AccountAction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAction', 'V2025AccountAction'] +slug: /tools/sdk/go/v2025/models/account-action +tags: ['SDK', 'Software Development Kit', 'AccountAction', 'V2025AccountAction'] +--- + +# AccountAction + +## Properties + +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] + +## Methods + +### NewAccountAction + +`func NewAccountAction() *AccountAction` + +NewAccountAction instantiates a new AccountAction 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 + +### NewAccountActionWithDefaults + +`func NewAccountActionWithDefaults() *AccountAction` + +NewAccountActionWithDefaults instantiates a new AccountAction 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 + +### GetAction + +`func (o *AccountAction) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *AccountAction) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *AccountAction) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *AccountAction) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetSourceIds + +`func (o *AccountAction) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *AccountAction) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *AccountAction) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *AccountAction) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountActivity.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountActivity.md new file mode 100644 index 000000000..81d8d951b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountActivity.md @@ -0,0 +1,502 @@ +--- +id: v2025-account-activity +title: AccountActivity +pagination_label: AccountActivity +sidebar_label: AccountActivity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivity', 'V2025AccountActivity'] +slug: /tools/sdk/go/v2025/models/account-activity +tags: ['SDK', 'Software Development Kit', 'AccountActivity', 'V2025AccountActivity'] +--- + +# AccountActivity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the account activity | [optional] +**Name** | Pointer to **string** | The name of the activity | [optional] +**Created** | Pointer to **SailPointTime** | When the activity was first created | [optional] +**Modified** | Pointer to **NullableTime** | When the activity was last modified | [optional] +**Completed** | Pointer to **NullableTime** | When the activity was completed | [optional] +**CompletionStatus** | Pointer to [**NullableCompletionStatus**](completion-status) | | [optional] +**Type** | Pointer to **NullableString** | The type of action the activity performed. Please see the following list of types. This list may grow over time. - CloudAutomated - IdentityAttributeUpdate - appRequest - LifecycleStateChange - AccountStateUpdate - AccountAttributeUpdate - CloudPasswordRequest - Attribute Synchronization Refresh - Certification - Identity Refresh - Lifecycle Change Refresh [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). | [optional] +**RequesterIdentitySummary** | Pointer to [**NullableIdentitySummary**](identity-summary) | | [optional] +**TargetIdentitySummary** | Pointer to [**NullableIdentitySummary**](identity-summary) | | [optional] +**Errors** | Pointer to **[]string** | A list of error messages, if any, that were encountered. | [optional] +**Warnings** | Pointer to **[]string** | A list of warning messages, if any, that were encountered. | [optional] +**Items** | Pointer to [**[]AccountActivityItem**](account-activity-item) | Individual actions performed as part of this account activity | [optional] +**ExecutionStatus** | Pointer to [**ExecutionStatus**](execution-status) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] + +## Methods + +### NewAccountActivity + +`func NewAccountActivity() *AccountActivity` + +NewAccountActivity instantiates a new AccountActivity 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 + +### NewAccountActivityWithDefaults + +`func NewAccountActivityWithDefaults() *AccountActivity` + +NewAccountActivityWithDefaults instantiates a new AccountActivity 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 + +### GetId + +`func (o *AccountActivity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountActivity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountActivity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountActivity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccountActivity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountActivity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountActivity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountActivity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *AccountActivity) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccountActivity) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccountActivity) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccountActivity) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *AccountActivity) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccountActivity) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccountActivity) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccountActivity) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *AccountActivity) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *AccountActivity) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetCompleted + +`func (o *AccountActivity) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *AccountActivity) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *AccountActivity) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *AccountActivity) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *AccountActivity) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *AccountActivity) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetCompletionStatus + +`func (o *AccountActivity) GetCompletionStatus() CompletionStatus` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *AccountActivity) GetCompletionStatusOk() (*CompletionStatus, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *AccountActivity) SetCompletionStatus(v CompletionStatus)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *AccountActivity) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + +### SetCompletionStatusNil + +`func (o *AccountActivity) SetCompletionStatusNil(b bool)` + + SetCompletionStatusNil sets the value for CompletionStatus to be an explicit nil + +### UnsetCompletionStatus +`func (o *AccountActivity) UnsetCompletionStatus()` + +UnsetCompletionStatus ensures that no value is present for CompletionStatus, not even an explicit nil +### GetType + +`func (o *AccountActivity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountActivity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountActivity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountActivity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *AccountActivity) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *AccountActivity) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetRequesterIdentitySummary + +`func (o *AccountActivity) GetRequesterIdentitySummary() IdentitySummary` + +GetRequesterIdentitySummary returns the RequesterIdentitySummary field if non-nil, zero value otherwise. + +### GetRequesterIdentitySummaryOk + +`func (o *AccountActivity) GetRequesterIdentitySummaryOk() (*IdentitySummary, bool)` + +GetRequesterIdentitySummaryOk returns a tuple with the RequesterIdentitySummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterIdentitySummary + +`func (o *AccountActivity) SetRequesterIdentitySummary(v IdentitySummary)` + +SetRequesterIdentitySummary sets RequesterIdentitySummary field to given value. + +### HasRequesterIdentitySummary + +`func (o *AccountActivity) HasRequesterIdentitySummary() bool` + +HasRequesterIdentitySummary returns a boolean if a field has been set. + +### SetRequesterIdentitySummaryNil + +`func (o *AccountActivity) SetRequesterIdentitySummaryNil(b bool)` + + SetRequesterIdentitySummaryNil sets the value for RequesterIdentitySummary to be an explicit nil + +### UnsetRequesterIdentitySummary +`func (o *AccountActivity) UnsetRequesterIdentitySummary()` + +UnsetRequesterIdentitySummary ensures that no value is present for RequesterIdentitySummary, not even an explicit nil +### GetTargetIdentitySummary + +`func (o *AccountActivity) GetTargetIdentitySummary() IdentitySummary` + +GetTargetIdentitySummary returns the TargetIdentitySummary field if non-nil, zero value otherwise. + +### GetTargetIdentitySummaryOk + +`func (o *AccountActivity) GetTargetIdentitySummaryOk() (*IdentitySummary, bool)` + +GetTargetIdentitySummaryOk returns a tuple with the TargetIdentitySummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetIdentitySummary + +`func (o *AccountActivity) SetTargetIdentitySummary(v IdentitySummary)` + +SetTargetIdentitySummary sets TargetIdentitySummary field to given value. + +### HasTargetIdentitySummary + +`func (o *AccountActivity) HasTargetIdentitySummary() bool` + +HasTargetIdentitySummary returns a boolean if a field has been set. + +### SetTargetIdentitySummaryNil + +`func (o *AccountActivity) SetTargetIdentitySummaryNil(b bool)` + + SetTargetIdentitySummaryNil sets the value for TargetIdentitySummary to be an explicit nil + +### UnsetTargetIdentitySummary +`func (o *AccountActivity) UnsetTargetIdentitySummary()` + +UnsetTargetIdentitySummary ensures that no value is present for TargetIdentitySummary, not even an explicit nil +### GetErrors + +`func (o *AccountActivity) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountActivity) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountActivity) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *AccountActivity) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### SetErrorsNil + +`func (o *AccountActivity) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *AccountActivity) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *AccountActivity) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *AccountActivity) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *AccountActivity) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *AccountActivity) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + +### SetWarningsNil + +`func (o *AccountActivity) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *AccountActivity) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetItems + +`func (o *AccountActivity) GetItems() []AccountActivityItem` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *AccountActivity) GetItemsOk() (*[]AccountActivityItem, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *AccountActivity) SetItems(v []AccountActivityItem)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *AccountActivity) HasItems() bool` + +HasItems returns a boolean if a field has been set. + +### SetItemsNil + +`func (o *AccountActivity) SetItemsNil(b bool)` + + SetItemsNil sets the value for Items to be an explicit nil + +### UnsetItems +`func (o *AccountActivity) UnsetItems()` + +UnsetItems ensures that no value is present for Items, not even an explicit nil +### GetExecutionStatus + +`func (o *AccountActivity) GetExecutionStatus() ExecutionStatus` + +GetExecutionStatus returns the ExecutionStatus field if non-nil, zero value otherwise. + +### GetExecutionStatusOk + +`func (o *AccountActivity) GetExecutionStatusOk() (*ExecutionStatus, bool)` + +GetExecutionStatusOk returns a tuple with the ExecutionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExecutionStatus + +`func (o *AccountActivity) SetExecutionStatus(v ExecutionStatus)` + +SetExecutionStatus sets ExecutionStatus field to given value. + +### HasExecutionStatus + +`func (o *AccountActivity) HasExecutionStatus() bool` + +HasExecutionStatus returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *AccountActivity) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccountActivity) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccountActivity) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccountActivity) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *AccountActivity) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *AccountActivity) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountActivityApprovalStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountActivityApprovalStatus.md new file mode 100644 index 000000000..8de7ce414 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountActivityApprovalStatus.md @@ -0,0 +1,29 @@ +--- +id: v2025-account-activity-approval-status +title: AccountActivityApprovalStatus +pagination_label: AccountActivityApprovalStatus +sidebar_label: AccountActivityApprovalStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivityApprovalStatus', 'V2025AccountActivityApprovalStatus'] +slug: /tools/sdk/go/v2025/models/account-activity-approval-status +tags: ['SDK', 'Software Development Kit', 'AccountActivityApprovalStatus', 'V2025AccountActivityApprovalStatus'] +--- + +# AccountActivityApprovalStatus + +## Enum + + +* `FINISHED` (value: `"FINISHED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `RETURNED` (value: `"RETURNED"`) + +* `EXPIRED` (value: `"EXPIRED"`) + +* `PENDING` (value: `"PENDING"`) + +* `CANCELED` (value: `"CANCELED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountActivityDocument.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountActivityDocument.md new file mode 100644 index 000000000..488603e82 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountActivityDocument.md @@ -0,0 +1,520 @@ +--- +id: v2025-account-activity-document +title: AccountActivityDocument +pagination_label: AccountActivityDocument +sidebar_label: AccountActivityDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivityDocument', 'V2025AccountActivityDocument'] +slug: /tools/sdk/go/v2025/models/account-activity-document +tags: ['SDK', 'Software Development Kit', 'AccountActivityDocument', 'V2025AccountActivityDocument'] +--- + +# AccountActivityDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of account activity. | [optional] +**Action** | Pointer to **string** | Type of action performed in the activity. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Stage** | Pointer to **string** | Activity's current stage. | [optional] +**Status** | Pointer to **string** | Activity's current status. | [optional] +**Requester** | Pointer to [**ActivityIdentity**](activity-identity) | | [optional] +**Recipient** | Pointer to [**ActivityIdentity**](activity-identity) | | [optional] +**TrackingNumber** | Pointer to **string** | Account activity's tracking number. | [optional] +**Errors** | Pointer to **[]string** | Errors provided by the source while completing account actions. | [optional] +**Warnings** | Pointer to **[]string** | Warnings provided by the source while completing account actions. | [optional] +**Approvals** | Pointer to [**[]Approval1**](approval1) | Approvals performed on an item during activity. | [optional] +**OriginalRequests** | Pointer to [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional] +**ExpansionItems** | Pointer to [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional] +**AccountRequests** | Pointer to [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional] +**Sources** | Pointer to **string** | Sources involved in the account activity. | [optional] + +## Methods + +### NewAccountActivityDocument + +`func NewAccountActivityDocument() *AccountActivityDocument` + +NewAccountActivityDocument instantiates a new AccountActivityDocument 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 + +### NewAccountActivityDocumentWithDefaults + +`func NewAccountActivityDocumentWithDefaults() *AccountActivityDocument` + +NewAccountActivityDocumentWithDefaults instantiates a new AccountActivityDocument 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 + +### GetId + +`func (o *AccountActivityDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountActivityDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountActivityDocument) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountActivityDocument) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAction + +`func (o *AccountActivityDocument) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *AccountActivityDocument) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *AccountActivityDocument) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *AccountActivityDocument) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetCreated + +`func (o *AccountActivityDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccountActivityDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccountActivityDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccountActivityDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *AccountActivityDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *AccountActivityDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *AccountActivityDocument) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccountActivityDocument) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccountActivityDocument) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccountActivityDocument) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *AccountActivityDocument) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *AccountActivityDocument) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *AccountActivityDocument) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *AccountActivityDocument) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *AccountActivityDocument) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *AccountActivityDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetStage + +`func (o *AccountActivityDocument) GetStage() string` + +GetStage returns the Stage field if non-nil, zero value otherwise. + +### GetStageOk + +`func (o *AccountActivityDocument) GetStageOk() (*string, bool)` + +GetStageOk returns a tuple with the Stage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStage + +`func (o *AccountActivityDocument) SetStage(v string)` + +SetStage sets Stage field to given value. + +### HasStage + +`func (o *AccountActivityDocument) HasStage() bool` + +HasStage returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccountActivityDocument) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountActivityDocument) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountActivityDocument) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccountActivityDocument) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetRequester + +`func (o *AccountActivityDocument) GetRequester() ActivityIdentity` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *AccountActivityDocument) GetRequesterOk() (*ActivityIdentity, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *AccountActivityDocument) SetRequester(v ActivityIdentity)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *AccountActivityDocument) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRecipient + +`func (o *AccountActivityDocument) GetRecipient() ActivityIdentity` + +GetRecipient returns the Recipient field if non-nil, zero value otherwise. + +### GetRecipientOk + +`func (o *AccountActivityDocument) GetRecipientOk() (*ActivityIdentity, bool)` + +GetRecipientOk returns a tuple with the Recipient field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipient + +`func (o *AccountActivityDocument) SetRecipient(v ActivityIdentity)` + +SetRecipient sets Recipient field to given value. + +### HasRecipient + +`func (o *AccountActivityDocument) HasRecipient() bool` + +HasRecipient returns a boolean if a field has been set. + +### GetTrackingNumber + +`func (o *AccountActivityDocument) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *AccountActivityDocument) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *AccountActivityDocument) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + +### HasTrackingNumber + +`func (o *AccountActivityDocument) HasTrackingNumber() bool` + +HasTrackingNumber returns a boolean if a field has been set. + +### GetErrors + +`func (o *AccountActivityDocument) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountActivityDocument) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountActivityDocument) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *AccountActivityDocument) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### SetErrorsNil + +`func (o *AccountActivityDocument) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *AccountActivityDocument) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *AccountActivityDocument) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *AccountActivityDocument) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *AccountActivityDocument) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *AccountActivityDocument) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + +### SetWarningsNil + +`func (o *AccountActivityDocument) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *AccountActivityDocument) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetApprovals + +`func (o *AccountActivityDocument) GetApprovals() []Approval1` + +GetApprovals returns the Approvals field if non-nil, zero value otherwise. + +### GetApprovalsOk + +`func (o *AccountActivityDocument) GetApprovalsOk() (*[]Approval1, bool)` + +GetApprovalsOk returns a tuple with the Approvals field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovals + +`func (o *AccountActivityDocument) SetApprovals(v []Approval1)` + +SetApprovals sets Approvals field to given value. + +### HasApprovals + +`func (o *AccountActivityDocument) HasApprovals() bool` + +HasApprovals returns a boolean if a field has been set. + +### GetOriginalRequests + +`func (o *AccountActivityDocument) GetOriginalRequests() []OriginalRequest` + +GetOriginalRequests returns the OriginalRequests field if non-nil, zero value otherwise. + +### GetOriginalRequestsOk + +`func (o *AccountActivityDocument) GetOriginalRequestsOk() (*[]OriginalRequest, bool)` + +GetOriginalRequestsOk returns a tuple with the OriginalRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalRequests + +`func (o *AccountActivityDocument) SetOriginalRequests(v []OriginalRequest)` + +SetOriginalRequests sets OriginalRequests field to given value. + +### HasOriginalRequests + +`func (o *AccountActivityDocument) HasOriginalRequests() bool` + +HasOriginalRequests returns a boolean if a field has been set. + +### GetExpansionItems + +`func (o *AccountActivityDocument) GetExpansionItems() []ExpansionItem` + +GetExpansionItems returns the ExpansionItems field if non-nil, zero value otherwise. + +### GetExpansionItemsOk + +`func (o *AccountActivityDocument) GetExpansionItemsOk() (*[]ExpansionItem, bool)` + +GetExpansionItemsOk returns a tuple with the ExpansionItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpansionItems + +`func (o *AccountActivityDocument) SetExpansionItems(v []ExpansionItem)` + +SetExpansionItems sets ExpansionItems field to given value. + +### HasExpansionItems + +`func (o *AccountActivityDocument) HasExpansionItems() bool` + +HasExpansionItems returns a boolean if a field has been set. + +### GetAccountRequests + +`func (o *AccountActivityDocument) GetAccountRequests() []AccountRequest` + +GetAccountRequests returns the AccountRequests field if non-nil, zero value otherwise. + +### GetAccountRequestsOk + +`func (o *AccountActivityDocument) GetAccountRequestsOk() (*[]AccountRequest, bool)` + +GetAccountRequestsOk returns a tuple with the AccountRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountRequests + +`func (o *AccountActivityDocument) SetAccountRequests(v []AccountRequest)` + +SetAccountRequests sets AccountRequests field to given value. + +### HasAccountRequests + +`func (o *AccountActivityDocument) HasAccountRequests() bool` + +HasAccountRequests returns a boolean if a field has been set. + +### GetSources + +`func (o *AccountActivityDocument) GetSources() string` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *AccountActivityDocument) GetSourcesOk() (*string, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *AccountActivityDocument) SetSources(v string)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *AccountActivityDocument) HasSources() bool` + +HasSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountActivityItem.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountActivityItem.md new file mode 100644 index 000000000..09a099a82 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountActivityItem.md @@ -0,0 +1,564 @@ +--- +id: v2025-account-activity-item +title: AccountActivityItem +pagination_label: AccountActivityItem +sidebar_label: AccountActivityItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivityItem', 'V2025AccountActivityItem'] +slug: /tools/sdk/go/v2025/models/account-activity-item +tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'V2025AccountActivityItem'] +--- + +# AccountActivityItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Item id | [optional] +**Name** | Pointer to **string** | Human-readable display name of item | [optional] +**Requested** | Pointer to **SailPointTime** | Date and time item was requested | [optional] +**ApprovalStatus** | Pointer to [**NullableAccountActivityApprovalStatus**](account-activity-approval-status) | | [optional] +**ProvisioningStatus** | Pointer to [**ProvisioningState**](provisioning-state) | | [optional] +**RequesterComment** | Pointer to [**NullableComment**](comment) | | [optional] +**ReviewerIdentitySummary** | Pointer to [**NullableIdentitySummary**](identity-summary) | | [optional] +**ReviewerComment** | Pointer to [**NullableComment**](comment) | | [optional] +**Operation** | Pointer to [**NullableAccountActivityItemOperation**](account-activity-item-operation) | | [optional] +**Attribute** | Pointer to **NullableString** | Attribute to which account activity applies | [optional] +**Value** | Pointer to **NullableString** | Value of attribute | [optional] +**NativeIdentity** | Pointer to **NullableString** | Native identity in the target system to which the account activity applies | [optional] +**SourceId** | Pointer to **string** | Id of Source to which account activity applies | [optional] +**AccountRequestInfo** | Pointer to [**NullableAccountRequestInfo**](account-request-info) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional] +**RemoveDate** | Pointer to **NullableTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] + +## Methods + +### NewAccountActivityItem + +`func NewAccountActivityItem() *AccountActivityItem` + +NewAccountActivityItem instantiates a new AccountActivityItem 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 + +### NewAccountActivityItemWithDefaults + +`func NewAccountActivityItemWithDefaults() *AccountActivityItem` + +NewAccountActivityItemWithDefaults instantiates a new AccountActivityItem 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 + +### GetId + +`func (o *AccountActivityItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountActivityItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountActivityItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountActivityItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccountActivityItem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountActivityItem) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountActivityItem) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountActivityItem) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetRequested + +`func (o *AccountActivityItem) GetRequested() SailPointTime` + +GetRequested returns the Requested field if non-nil, zero value otherwise. + +### GetRequestedOk + +`func (o *AccountActivityItem) GetRequestedOk() (*SailPointTime, bool)` + +GetRequestedOk returns a tuple with the Requested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequested + +`func (o *AccountActivityItem) SetRequested(v SailPointTime)` + +SetRequested sets Requested field to given value. + +### HasRequested + +`func (o *AccountActivityItem) HasRequested() bool` + +HasRequested returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *AccountActivityItem) GetApprovalStatus() AccountActivityApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *AccountActivityItem) GetApprovalStatusOk() (*AccountActivityApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *AccountActivityItem) SetApprovalStatus(v AccountActivityApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *AccountActivityItem) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### SetApprovalStatusNil + +`func (o *AccountActivityItem) SetApprovalStatusNil(b bool)` + + SetApprovalStatusNil sets the value for ApprovalStatus to be an explicit nil + +### UnsetApprovalStatus +`func (o *AccountActivityItem) UnsetApprovalStatus()` + +UnsetApprovalStatus ensures that no value is present for ApprovalStatus, not even an explicit nil +### GetProvisioningStatus + +`func (o *AccountActivityItem) GetProvisioningStatus() ProvisioningState` + +GetProvisioningStatus returns the ProvisioningStatus field if non-nil, zero value otherwise. + +### GetProvisioningStatusOk + +`func (o *AccountActivityItem) GetProvisioningStatusOk() (*ProvisioningState, bool)` + +GetProvisioningStatusOk returns a tuple with the ProvisioningStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningStatus + +`func (o *AccountActivityItem) SetProvisioningStatus(v ProvisioningState)` + +SetProvisioningStatus sets ProvisioningStatus field to given value. + +### HasProvisioningStatus + +`func (o *AccountActivityItem) HasProvisioningStatus() bool` + +HasProvisioningStatus returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *AccountActivityItem) GetRequesterComment() Comment` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *AccountActivityItem) GetRequesterCommentOk() (*Comment, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *AccountActivityItem) SetRequesterComment(v Comment)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *AccountActivityItem) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### SetRequesterCommentNil + +`func (o *AccountActivityItem) SetRequesterCommentNil(b bool)` + + SetRequesterCommentNil sets the value for RequesterComment to be an explicit nil + +### UnsetRequesterComment +`func (o *AccountActivityItem) UnsetRequesterComment()` + +UnsetRequesterComment ensures that no value is present for RequesterComment, not even an explicit nil +### GetReviewerIdentitySummary + +`func (o *AccountActivityItem) GetReviewerIdentitySummary() IdentitySummary` + +GetReviewerIdentitySummary returns the ReviewerIdentitySummary field if non-nil, zero value otherwise. + +### GetReviewerIdentitySummaryOk + +`func (o *AccountActivityItem) GetReviewerIdentitySummaryOk() (*IdentitySummary, bool)` + +GetReviewerIdentitySummaryOk returns a tuple with the ReviewerIdentitySummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerIdentitySummary + +`func (o *AccountActivityItem) SetReviewerIdentitySummary(v IdentitySummary)` + +SetReviewerIdentitySummary sets ReviewerIdentitySummary field to given value. + +### HasReviewerIdentitySummary + +`func (o *AccountActivityItem) HasReviewerIdentitySummary() bool` + +HasReviewerIdentitySummary returns a boolean if a field has been set. + +### SetReviewerIdentitySummaryNil + +`func (o *AccountActivityItem) SetReviewerIdentitySummaryNil(b bool)` + + SetReviewerIdentitySummaryNil sets the value for ReviewerIdentitySummary to be an explicit nil + +### UnsetReviewerIdentitySummary +`func (o *AccountActivityItem) UnsetReviewerIdentitySummary()` + +UnsetReviewerIdentitySummary ensures that no value is present for ReviewerIdentitySummary, not even an explicit nil +### GetReviewerComment + +`func (o *AccountActivityItem) GetReviewerComment() Comment` + +GetReviewerComment returns the ReviewerComment field if non-nil, zero value otherwise. + +### GetReviewerCommentOk + +`func (o *AccountActivityItem) GetReviewerCommentOk() (*Comment, bool)` + +GetReviewerCommentOk returns a tuple with the ReviewerComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerComment + +`func (o *AccountActivityItem) SetReviewerComment(v Comment)` + +SetReviewerComment sets ReviewerComment field to given value. + +### HasReviewerComment + +`func (o *AccountActivityItem) HasReviewerComment() bool` + +HasReviewerComment returns a boolean if a field has been set. + +### SetReviewerCommentNil + +`func (o *AccountActivityItem) SetReviewerCommentNil(b bool)` + + SetReviewerCommentNil sets the value for ReviewerComment to be an explicit nil + +### UnsetReviewerComment +`func (o *AccountActivityItem) UnsetReviewerComment()` + +UnsetReviewerComment ensures that no value is present for ReviewerComment, not even an explicit nil +### GetOperation + +`func (o *AccountActivityItem) GetOperation() AccountActivityItemOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *AccountActivityItem) GetOperationOk() (*AccountActivityItemOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *AccountActivityItem) SetOperation(v AccountActivityItemOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *AccountActivityItem) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### SetOperationNil + +`func (o *AccountActivityItem) SetOperationNil(b bool)` + + SetOperationNil sets the value for Operation to be an explicit nil + +### UnsetOperation +`func (o *AccountActivityItem) UnsetOperation()` + +UnsetOperation ensures that no value is present for Operation, not even an explicit nil +### GetAttribute + +`func (o *AccountActivityItem) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *AccountActivityItem) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *AccountActivityItem) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *AccountActivityItem) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *AccountActivityItem) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *AccountActivityItem) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *AccountActivityItem) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AccountActivityItem) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AccountActivityItem) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AccountActivityItem) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *AccountActivityItem) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *AccountActivityItem) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetNativeIdentity + +`func (o *AccountActivityItem) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountActivityItem) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountActivityItem) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccountActivityItem) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### SetNativeIdentityNil + +`func (o *AccountActivityItem) SetNativeIdentityNil(b bool)` + + SetNativeIdentityNil sets the value for NativeIdentity to be an explicit nil + +### UnsetNativeIdentity +`func (o *AccountActivityItem) UnsetNativeIdentity()` + +UnsetNativeIdentity ensures that no value is present for NativeIdentity, not even an explicit nil +### GetSourceId + +`func (o *AccountActivityItem) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccountActivityItem) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccountActivityItem) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccountActivityItem) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetAccountRequestInfo + +`func (o *AccountActivityItem) GetAccountRequestInfo() AccountRequestInfo` + +GetAccountRequestInfo returns the AccountRequestInfo field if non-nil, zero value otherwise. + +### GetAccountRequestInfoOk + +`func (o *AccountActivityItem) GetAccountRequestInfoOk() (*AccountRequestInfo, bool)` + +GetAccountRequestInfoOk returns a tuple with the AccountRequestInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountRequestInfo + +`func (o *AccountActivityItem) SetAccountRequestInfo(v AccountRequestInfo)` + +SetAccountRequestInfo sets AccountRequestInfo field to given value. + +### HasAccountRequestInfo + +`func (o *AccountActivityItem) HasAccountRequestInfo() bool` + +HasAccountRequestInfo returns a boolean if a field has been set. + +### SetAccountRequestInfoNil + +`func (o *AccountActivityItem) SetAccountRequestInfoNil(b bool)` + + SetAccountRequestInfoNil sets the value for AccountRequestInfo to be an explicit nil + +### UnsetAccountRequestInfo +`func (o *AccountActivityItem) UnsetAccountRequestInfo()` + +UnsetAccountRequestInfo ensures that no value is present for AccountRequestInfo, not even an explicit nil +### GetClientMetadata + +`func (o *AccountActivityItem) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccountActivityItem) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccountActivityItem) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccountActivityItem) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *AccountActivityItem) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *AccountActivityItem) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetRemoveDate + +`func (o *AccountActivityItem) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccountActivityItem) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccountActivityItem) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccountActivityItem) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *AccountActivityItem) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *AccountActivityItem) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountActivityItemOperation.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountActivityItemOperation.md new file mode 100644 index 000000000..adac5ca76 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountActivityItemOperation.md @@ -0,0 +1,37 @@ +--- +id: v2025-account-activity-item-operation +title: AccountActivityItemOperation +pagination_label: AccountActivityItemOperation +sidebar_label: AccountActivityItemOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivityItemOperation', 'V2025AccountActivityItemOperation'] +slug: /tools/sdk/go/v2025/models/account-activity-item-operation +tags: ['SDK', 'Software Development Kit', 'AccountActivityItemOperation', 'V2025AccountActivityItemOperation'] +--- + +# AccountActivityItemOperation + +## Enum + + +* `ADD` (value: `"ADD"`) + +* `CREATE` (value: `"CREATE"`) + +* `MODIFY` (value: `"MODIFY"`) + +* `DELETE` (value: `"DELETE"`) + +* `DISABLE` (value: `"DISABLE"`) + +* `ENABLE` (value: `"ENABLE"`) + +* `UNLOCK` (value: `"UNLOCK"`) + +* `LOCK` (value: `"LOCK"`) + +* `REMOVE` (value: `"REMOVE"`) + +* `SET` (value: `"SET"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountActivitySearchedItem.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountActivitySearchedItem.md new file mode 100644 index 000000000..46596e400 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountActivitySearchedItem.md @@ -0,0 +1,520 @@ +--- +id: v2025-account-activity-searched-item +title: AccountActivitySearchedItem +pagination_label: AccountActivitySearchedItem +sidebar_label: AccountActivitySearchedItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivitySearchedItem', 'V2025AccountActivitySearchedItem'] +slug: /tools/sdk/go/v2025/models/account-activity-searched-item +tags: ['SDK', 'Software Development Kit', 'AccountActivitySearchedItem', 'V2025AccountActivitySearchedItem'] +--- + +# AccountActivitySearchedItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of account activity. | [optional] +**Action** | Pointer to **string** | Type of action performed in the activity. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Stage** | Pointer to **string** | Activity's current stage. | [optional] +**Status** | Pointer to **string** | Activity's current status. | [optional] +**Requester** | Pointer to [**ActivityIdentity**](activity-identity) | | [optional] +**Recipient** | Pointer to [**ActivityIdentity**](activity-identity) | | [optional] +**TrackingNumber** | Pointer to **string** | Account activity's tracking number. | [optional] +**Errors** | Pointer to **[]string** | Errors provided by the source while completing account actions. | [optional] +**Warnings** | Pointer to **[]string** | Warnings provided by the source while completing account actions. | [optional] +**Approvals** | Pointer to [**[]Approval1**](approval1) | Approvals performed on an item during activity. | [optional] +**OriginalRequests** | Pointer to [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional] +**ExpansionItems** | Pointer to [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional] +**AccountRequests** | Pointer to [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional] +**Sources** | Pointer to **string** | Sources involved in the account activity. | [optional] + +## Methods + +### NewAccountActivitySearchedItem + +`func NewAccountActivitySearchedItem() *AccountActivitySearchedItem` + +NewAccountActivitySearchedItem instantiates a new AccountActivitySearchedItem 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 + +### NewAccountActivitySearchedItemWithDefaults + +`func NewAccountActivitySearchedItemWithDefaults() *AccountActivitySearchedItem` + +NewAccountActivitySearchedItemWithDefaults instantiates a new AccountActivitySearchedItem 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 + +### GetId + +`func (o *AccountActivitySearchedItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountActivitySearchedItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountActivitySearchedItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountActivitySearchedItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAction + +`func (o *AccountActivitySearchedItem) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *AccountActivitySearchedItem) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *AccountActivitySearchedItem) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *AccountActivitySearchedItem) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetCreated + +`func (o *AccountActivitySearchedItem) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccountActivitySearchedItem) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccountActivitySearchedItem) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccountActivitySearchedItem) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *AccountActivitySearchedItem) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *AccountActivitySearchedItem) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *AccountActivitySearchedItem) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccountActivitySearchedItem) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccountActivitySearchedItem) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccountActivitySearchedItem) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *AccountActivitySearchedItem) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *AccountActivitySearchedItem) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *AccountActivitySearchedItem) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *AccountActivitySearchedItem) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *AccountActivitySearchedItem) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *AccountActivitySearchedItem) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetStage + +`func (o *AccountActivitySearchedItem) GetStage() string` + +GetStage returns the Stage field if non-nil, zero value otherwise. + +### GetStageOk + +`func (o *AccountActivitySearchedItem) GetStageOk() (*string, bool)` + +GetStageOk returns a tuple with the Stage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStage + +`func (o *AccountActivitySearchedItem) SetStage(v string)` + +SetStage sets Stage field to given value. + +### HasStage + +`func (o *AccountActivitySearchedItem) HasStage() bool` + +HasStage returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccountActivitySearchedItem) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountActivitySearchedItem) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountActivitySearchedItem) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccountActivitySearchedItem) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetRequester + +`func (o *AccountActivitySearchedItem) GetRequester() ActivityIdentity` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *AccountActivitySearchedItem) GetRequesterOk() (*ActivityIdentity, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *AccountActivitySearchedItem) SetRequester(v ActivityIdentity)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *AccountActivitySearchedItem) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRecipient + +`func (o *AccountActivitySearchedItem) GetRecipient() ActivityIdentity` + +GetRecipient returns the Recipient field if non-nil, zero value otherwise. + +### GetRecipientOk + +`func (o *AccountActivitySearchedItem) GetRecipientOk() (*ActivityIdentity, bool)` + +GetRecipientOk returns a tuple with the Recipient field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipient + +`func (o *AccountActivitySearchedItem) SetRecipient(v ActivityIdentity)` + +SetRecipient sets Recipient field to given value. + +### HasRecipient + +`func (o *AccountActivitySearchedItem) HasRecipient() bool` + +HasRecipient returns a boolean if a field has been set. + +### GetTrackingNumber + +`func (o *AccountActivitySearchedItem) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *AccountActivitySearchedItem) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *AccountActivitySearchedItem) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + +### HasTrackingNumber + +`func (o *AccountActivitySearchedItem) HasTrackingNumber() bool` + +HasTrackingNumber returns a boolean if a field has been set. + +### GetErrors + +`func (o *AccountActivitySearchedItem) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountActivitySearchedItem) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountActivitySearchedItem) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *AccountActivitySearchedItem) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### SetErrorsNil + +`func (o *AccountActivitySearchedItem) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *AccountActivitySearchedItem) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *AccountActivitySearchedItem) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *AccountActivitySearchedItem) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *AccountActivitySearchedItem) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *AccountActivitySearchedItem) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + +### SetWarningsNil + +`func (o *AccountActivitySearchedItem) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *AccountActivitySearchedItem) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetApprovals + +`func (o *AccountActivitySearchedItem) GetApprovals() []Approval1` + +GetApprovals returns the Approvals field if non-nil, zero value otherwise. + +### GetApprovalsOk + +`func (o *AccountActivitySearchedItem) GetApprovalsOk() (*[]Approval1, bool)` + +GetApprovalsOk returns a tuple with the Approvals field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovals + +`func (o *AccountActivitySearchedItem) SetApprovals(v []Approval1)` + +SetApprovals sets Approvals field to given value. + +### HasApprovals + +`func (o *AccountActivitySearchedItem) HasApprovals() bool` + +HasApprovals returns a boolean if a field has been set. + +### GetOriginalRequests + +`func (o *AccountActivitySearchedItem) GetOriginalRequests() []OriginalRequest` + +GetOriginalRequests returns the OriginalRequests field if non-nil, zero value otherwise. + +### GetOriginalRequestsOk + +`func (o *AccountActivitySearchedItem) GetOriginalRequestsOk() (*[]OriginalRequest, bool)` + +GetOriginalRequestsOk returns a tuple with the OriginalRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalRequests + +`func (o *AccountActivitySearchedItem) SetOriginalRequests(v []OriginalRequest)` + +SetOriginalRequests sets OriginalRequests field to given value. + +### HasOriginalRequests + +`func (o *AccountActivitySearchedItem) HasOriginalRequests() bool` + +HasOriginalRequests returns a boolean if a field has been set. + +### GetExpansionItems + +`func (o *AccountActivitySearchedItem) GetExpansionItems() []ExpansionItem` + +GetExpansionItems returns the ExpansionItems field if non-nil, zero value otherwise. + +### GetExpansionItemsOk + +`func (o *AccountActivitySearchedItem) GetExpansionItemsOk() (*[]ExpansionItem, bool)` + +GetExpansionItemsOk returns a tuple with the ExpansionItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpansionItems + +`func (o *AccountActivitySearchedItem) SetExpansionItems(v []ExpansionItem)` + +SetExpansionItems sets ExpansionItems field to given value. + +### HasExpansionItems + +`func (o *AccountActivitySearchedItem) HasExpansionItems() bool` + +HasExpansionItems returns a boolean if a field has been set. + +### GetAccountRequests + +`func (o *AccountActivitySearchedItem) GetAccountRequests() []AccountRequest` + +GetAccountRequests returns the AccountRequests field if non-nil, zero value otherwise. + +### GetAccountRequestsOk + +`func (o *AccountActivitySearchedItem) GetAccountRequestsOk() (*[]AccountRequest, bool)` + +GetAccountRequestsOk returns a tuple with the AccountRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountRequests + +`func (o *AccountActivitySearchedItem) SetAccountRequests(v []AccountRequest)` + +SetAccountRequests sets AccountRequests field to given value. + +### HasAccountRequests + +`func (o *AccountActivitySearchedItem) HasAccountRequests() bool` + +HasAccountRequests returns a boolean if a field has been set. + +### GetSources + +`func (o *AccountActivitySearchedItem) GetSources() string` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *AccountActivitySearchedItem) GetSourcesOk() (*string, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *AccountActivitySearchedItem) SetSources(v string)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *AccountActivitySearchedItem) HasSources() bool` + +HasSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAggregationCompleted.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAggregationCompleted.md new file mode 100644 index 000000000..e2dd6b2d6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAggregationCompleted.md @@ -0,0 +1,205 @@ +--- +id: v2025-account-aggregation-completed +title: AccountAggregationCompleted +pagination_label: AccountAggregationCompleted +sidebar_label: AccountAggregationCompleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAggregationCompleted', 'V2025AccountAggregationCompleted'] +slug: /tools/sdk/go/v2025/models/account-aggregation-completed +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompleted', 'V2025AccountAggregationCompleted'] +--- + +# AccountAggregationCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**AccountAggregationCompletedSource**](account-aggregation-completed-source) | | +**Status** | **map[string]interface{}** | The overall status of the aggregation. | +**Started** | **SailPointTime** | The date and time when the account aggregation started. | +**Completed** | **SailPointTime** | The date and time when the account aggregation finished. | +**Errors** | **[]string** | A list of errors that occurred during the aggregation. | +**Warnings** | **[]string** | A list of warnings that occurred during the aggregation. | +**Stats** | [**AccountAggregationCompletedStats**](account-aggregation-completed-stats) | | + +## Methods + +### NewAccountAggregationCompleted + +`func NewAccountAggregationCompleted(source AccountAggregationCompletedSource, status map[string]interface{}, started SailPointTime, completed SailPointTime, errors []string, warnings []string, stats AccountAggregationCompletedStats, ) *AccountAggregationCompleted` + +NewAccountAggregationCompleted instantiates a new AccountAggregationCompleted 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 + +### NewAccountAggregationCompletedWithDefaults + +`func NewAccountAggregationCompletedWithDefaults() *AccountAggregationCompleted` + +NewAccountAggregationCompletedWithDefaults instantiates a new AccountAggregationCompleted 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 + +### GetSource + +`func (o *AccountAggregationCompleted) GetSource() AccountAggregationCompletedSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountAggregationCompleted) GetSourceOk() (*AccountAggregationCompletedSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountAggregationCompleted) SetSource(v AccountAggregationCompletedSource)` + +SetSource sets Source field to given value. + + +### GetStatus + +`func (o *AccountAggregationCompleted) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountAggregationCompleted) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountAggregationCompleted) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + +### GetStarted + +`func (o *AccountAggregationCompleted) GetStarted() SailPointTime` + +GetStarted returns the Started field if non-nil, zero value otherwise. + +### GetStartedOk + +`func (o *AccountAggregationCompleted) GetStartedOk() (*SailPointTime, bool)` + +GetStartedOk returns a tuple with the Started field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStarted + +`func (o *AccountAggregationCompleted) SetStarted(v SailPointTime)` + +SetStarted sets Started field to given value. + + +### GetCompleted + +`func (o *AccountAggregationCompleted) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *AccountAggregationCompleted) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *AccountAggregationCompleted) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + + +### GetErrors + +`func (o *AccountAggregationCompleted) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountAggregationCompleted) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountAggregationCompleted) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + + +### SetErrorsNil + +`func (o *AccountAggregationCompleted) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *AccountAggregationCompleted) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *AccountAggregationCompleted) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *AccountAggregationCompleted) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *AccountAggregationCompleted) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + + +### SetWarningsNil + +`func (o *AccountAggregationCompleted) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *AccountAggregationCompleted) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetStats + +`func (o *AccountAggregationCompleted) GetStats() AccountAggregationCompletedStats` + +GetStats returns the Stats field if non-nil, zero value otherwise. + +### GetStatsOk + +`func (o *AccountAggregationCompleted) GetStatsOk() (*AccountAggregationCompletedStats, bool)` + +GetStatsOk returns a tuple with the Stats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStats + +`func (o *AccountAggregationCompleted) SetStats(v AccountAggregationCompletedStats)` + +SetStats sets Stats field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAggregationCompletedSource.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAggregationCompletedSource.md new file mode 100644 index 000000000..6e3b1a861 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAggregationCompletedSource.md @@ -0,0 +1,101 @@ +--- +id: v2025-account-aggregation-completed-source +title: AccountAggregationCompletedSource +pagination_label: AccountAggregationCompletedSource +sidebar_label: AccountAggregationCompletedSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAggregationCompletedSource', 'V2025AccountAggregationCompletedSource'] +slug: /tools/sdk/go/v2025/models/account-aggregation-completed-source +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedSource', 'V2025AccountAggregationCompletedSource'] +--- + +# AccountAggregationCompletedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The DTO type of the source the accounts are being aggregated from. | +**Id** | **string** | The ID of the source the accounts are being aggregated from. | +**Name** | **string** | Display name of the source the accounts are being aggregated from. | + +## Methods + +### NewAccountAggregationCompletedSource + +`func NewAccountAggregationCompletedSource(type_ string, id string, name string, ) *AccountAggregationCompletedSource` + +NewAccountAggregationCompletedSource instantiates a new AccountAggregationCompletedSource 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 + +### NewAccountAggregationCompletedSourceWithDefaults + +`func NewAccountAggregationCompletedSourceWithDefaults() *AccountAggregationCompletedSource` + +NewAccountAggregationCompletedSourceWithDefaults instantiates a new AccountAggregationCompletedSource 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 + +### GetType + +`func (o *AccountAggregationCompletedSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAggregationCompletedSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAggregationCompletedSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountAggregationCompletedSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAggregationCompletedSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAggregationCompletedSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountAggregationCompletedSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAggregationCompletedSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAggregationCompletedSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAggregationCompletedStats.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAggregationCompletedStats.md new file mode 100644 index 000000000..4932bd431 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAggregationCompletedStats.md @@ -0,0 +1,143 @@ +--- +id: v2025-account-aggregation-completed-stats +title: AccountAggregationCompletedStats +pagination_label: AccountAggregationCompletedStats +sidebar_label: AccountAggregationCompletedStats +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAggregationCompletedStats', 'V2025AccountAggregationCompletedStats'] +slug: /tools/sdk/go/v2025/models/account-aggregation-completed-stats +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedStats', 'V2025AccountAggregationCompletedStats'] +--- + +# AccountAggregationCompletedStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scanned** | **int32** | The number of accounts which were scanned / iterated over. | +**Unchanged** | **int32** | The number of accounts which existed before, but had no changes. | +**Changed** | **int32** | The number of accounts which existed before, but had changes. | +**Added** | **int32** | The number of accounts which are new - have not existed before. | +**Removed** | **int32** | The number accounts which existed before, but no longer exist (thus getting removed). | + +## Methods + +### NewAccountAggregationCompletedStats + +`func NewAccountAggregationCompletedStats(scanned int32, unchanged int32, changed int32, added int32, removed int32, ) *AccountAggregationCompletedStats` + +NewAccountAggregationCompletedStats instantiates a new AccountAggregationCompletedStats 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 + +### NewAccountAggregationCompletedStatsWithDefaults + +`func NewAccountAggregationCompletedStatsWithDefaults() *AccountAggregationCompletedStats` + +NewAccountAggregationCompletedStatsWithDefaults instantiates a new AccountAggregationCompletedStats 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 + +### GetScanned + +`func (o *AccountAggregationCompletedStats) GetScanned() int32` + +GetScanned returns the Scanned field if non-nil, zero value otherwise. + +### GetScannedOk + +`func (o *AccountAggregationCompletedStats) GetScannedOk() (*int32, bool)` + +GetScannedOk returns a tuple with the Scanned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScanned + +`func (o *AccountAggregationCompletedStats) SetScanned(v int32)` + +SetScanned sets Scanned field to given value. + + +### GetUnchanged + +`func (o *AccountAggregationCompletedStats) GetUnchanged() int32` + +GetUnchanged returns the Unchanged field if non-nil, zero value otherwise. + +### GetUnchangedOk + +`func (o *AccountAggregationCompletedStats) GetUnchangedOk() (*int32, bool)` + +GetUnchangedOk returns a tuple with the Unchanged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnchanged + +`func (o *AccountAggregationCompletedStats) SetUnchanged(v int32)` + +SetUnchanged sets Unchanged field to given value. + + +### GetChanged + +`func (o *AccountAggregationCompletedStats) GetChanged() int32` + +GetChanged returns the Changed field if non-nil, zero value otherwise. + +### GetChangedOk + +`func (o *AccountAggregationCompletedStats) GetChangedOk() (*int32, bool)` + +GetChangedOk returns a tuple with the Changed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanged + +`func (o *AccountAggregationCompletedStats) SetChanged(v int32)` + +SetChanged sets Changed field to given value. + + +### GetAdded + +`func (o *AccountAggregationCompletedStats) GetAdded() int32` + +GetAdded returns the Added field if non-nil, zero value otherwise. + +### GetAddedOk + +`func (o *AccountAggregationCompletedStats) GetAddedOk() (*int32, bool)` + +GetAddedOk returns a tuple with the Added field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAdded + +`func (o *AccountAggregationCompletedStats) SetAdded(v int32)` + +SetAdded sets Added field to given value. + + +### GetRemoved + +`func (o *AccountAggregationCompletedStats) GetRemoved() int32` + +GetRemoved returns the Removed field if non-nil, zero value otherwise. + +### GetRemovedOk + +`func (o *AccountAggregationCompletedStats) GetRemovedOk() (*int32, bool)` + +GetRemovedOk returns a tuple with the Removed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoved + +`func (o *AccountAggregationCompletedStats) SetRemoved(v int32)` + +SetRemoved sets Removed field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAggregationStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAggregationStatus.md new file mode 100644 index 000000000..70aaad1a0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAggregationStatus.md @@ -0,0 +1,152 @@ +--- +id: v2025-account-aggregation-status +title: AccountAggregationStatus +pagination_label: AccountAggregationStatus +sidebar_label: AccountAggregationStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAggregationStatus', 'V2025AccountAggregationStatus'] +slug: /tools/sdk/go/v2025/models/account-aggregation-status +tags: ['SDK', 'Software Development Kit', 'AccountAggregationStatus', 'V2025AccountAggregationStatus'] +--- + +# AccountAggregationStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **NullableTime** | When the aggregation started. | [optional] +**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] + +## Methods + +### NewAccountAggregationStatus + +`func NewAccountAggregationStatus() *AccountAggregationStatus` + +NewAccountAggregationStatus instantiates a new AccountAggregationStatus 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 + +### NewAccountAggregationStatusWithDefaults + +`func NewAccountAggregationStatusWithDefaults() *AccountAggregationStatus` + +NewAccountAggregationStatusWithDefaults instantiates a new AccountAggregationStatus 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 + +### GetStart + +`func (o *AccountAggregationStatus) GetStart() SailPointTime` + +GetStart returns the Start field if non-nil, zero value otherwise. + +### GetStartOk + +`func (o *AccountAggregationStatus) GetStartOk() (*SailPointTime, bool)` + +GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStart + +`func (o *AccountAggregationStatus) SetStart(v SailPointTime)` + +SetStart sets Start field to given value. + +### HasStart + +`func (o *AccountAggregationStatus) HasStart() bool` + +HasStart returns a boolean if a field has been set. + +### SetStartNil + +`func (o *AccountAggregationStatus) SetStartNil(b bool)` + + SetStartNil sets the value for Start to be an explicit nil + +### UnsetStart +`func (o *AccountAggregationStatus) UnsetStart()` + +UnsetStart ensures that no value is present for Start, not even an explicit nil +### GetStatus + +`func (o *AccountAggregationStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountAggregationStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountAggregationStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccountAggregationStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetTotalAccounts + +`func (o *AccountAggregationStatus) GetTotalAccounts() int32` + +GetTotalAccounts returns the TotalAccounts field if non-nil, zero value otherwise. + +### GetTotalAccountsOk + +`func (o *AccountAggregationStatus) GetTotalAccountsOk() (*int32, bool)` + +GetTotalAccountsOk returns a tuple with the TotalAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalAccounts + +`func (o *AccountAggregationStatus) SetTotalAccounts(v int32)` + +SetTotalAccounts sets TotalAccounts field to given value. + +### HasTotalAccounts + +`func (o *AccountAggregationStatus) HasTotalAccounts() bool` + +HasTotalAccounts returns a boolean if a field has been set. + +### GetProcessedAccounts + +`func (o *AccountAggregationStatus) GetProcessedAccounts() int32` + +GetProcessedAccounts returns the ProcessedAccounts field if non-nil, zero value otherwise. + +### GetProcessedAccountsOk + +`func (o *AccountAggregationStatus) GetProcessedAccountsOk() (*int32, bool)` + +GetProcessedAccountsOk returns a tuple with the ProcessedAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessedAccounts + +`func (o *AccountAggregationStatus) SetProcessedAccounts(v int32)` + +SetProcessedAccounts sets ProcessedAccounts field to given value. + +### HasProcessedAccounts + +`func (o *AccountAggregationStatus) HasProcessedAccounts() bool` + +HasProcessedAccounts returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAllOfIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAllOfIdentity.md new file mode 100644 index 000000000..21ee9ab39 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAllOfIdentity.md @@ -0,0 +1,116 @@ +--- +id: v2025-account-all-of-identity +title: AccountAllOfIdentity +pagination_label: AccountAllOfIdentity +sidebar_label: AccountAllOfIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAllOfIdentity', 'V2025AccountAllOfIdentity'] +slug: /tools/sdk/go/v2025/models/account-all-of-identity +tags: ['SDK', 'Software Development Kit', 'AccountAllOfIdentity', 'V2025AccountAllOfIdentity'] +--- + +# AccountAllOfIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the identity | [optional] +**Type** | Pointer to **string** | The type of object being referenced | [optional] +**Name** | Pointer to **string** | display name of identity | [optional] + +## Methods + +### NewAccountAllOfIdentity + +`func NewAccountAllOfIdentity() *AccountAllOfIdentity` + +NewAccountAllOfIdentity instantiates a new AccountAllOfIdentity 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 + +### NewAccountAllOfIdentityWithDefaults + +`func NewAccountAllOfIdentityWithDefaults() *AccountAllOfIdentity` + +NewAccountAllOfIdentityWithDefaults instantiates a new AccountAllOfIdentity 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 + +### GetId + +`func (o *AccountAllOfIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAllOfIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAllOfIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountAllOfIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccountAllOfIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAllOfIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAllOfIdentity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountAllOfIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccountAllOfIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAllOfIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAllOfIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountAllOfIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAllOfOwnerIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAllOfOwnerIdentity.md new file mode 100644 index 000000000..135a4c67f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAllOfOwnerIdentity.md @@ -0,0 +1,116 @@ +--- +id: v2025-account-all-of-owner-identity +title: AccountAllOfOwnerIdentity +pagination_label: AccountAllOfOwnerIdentity +sidebar_label: AccountAllOfOwnerIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAllOfOwnerIdentity', 'V2025AccountAllOfOwnerIdentity'] +slug: /tools/sdk/go/v2025/models/account-all-of-owner-identity +tags: ['SDK', 'Software Development Kit', 'AccountAllOfOwnerIdentity', 'V2025AccountAllOfOwnerIdentity'] +--- + +# AccountAllOfOwnerIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewAccountAllOfOwnerIdentity + +`func NewAccountAllOfOwnerIdentity() *AccountAllOfOwnerIdentity` + +NewAccountAllOfOwnerIdentity instantiates a new AccountAllOfOwnerIdentity 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 + +### NewAccountAllOfOwnerIdentityWithDefaults + +`func NewAccountAllOfOwnerIdentityWithDefaults() *AccountAllOfOwnerIdentity` + +NewAccountAllOfOwnerIdentityWithDefaults instantiates a new AccountAllOfOwnerIdentity 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 + +### GetType + +`func (o *AccountAllOfOwnerIdentity) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAllOfOwnerIdentity) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAllOfOwnerIdentity) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountAllOfOwnerIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccountAllOfOwnerIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAllOfOwnerIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAllOfOwnerIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountAllOfOwnerIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccountAllOfOwnerIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAllOfOwnerIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAllOfOwnerIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountAllOfOwnerIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAllOfRecommendation.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAllOfRecommendation.md new file mode 100644 index 000000000..d780e7135 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAllOfRecommendation.md @@ -0,0 +1,80 @@ +--- +id: v2025-account-all-of-recommendation +title: AccountAllOfRecommendation +pagination_label: AccountAllOfRecommendation +sidebar_label: AccountAllOfRecommendation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAllOfRecommendation', 'V2025AccountAllOfRecommendation'] +slug: /tools/sdk/go/v2025/models/account-all-of-recommendation +tags: ['SDK', 'Software Development Kit', 'AccountAllOfRecommendation', 'V2025AccountAllOfRecommendation'] +--- + +# AccountAllOfRecommendation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Recommended type of account. | +**Method** | **string** | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | + +## Methods + +### NewAccountAllOfRecommendation + +`func NewAccountAllOfRecommendation(type_ string, method string, ) *AccountAllOfRecommendation` + +NewAccountAllOfRecommendation instantiates a new AccountAllOfRecommendation 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 + +### NewAccountAllOfRecommendationWithDefaults + +`func NewAccountAllOfRecommendationWithDefaults() *AccountAllOfRecommendation` + +NewAccountAllOfRecommendationWithDefaults instantiates a new AccountAllOfRecommendation 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 + +### GetType + +`func (o *AccountAllOfRecommendation) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAllOfRecommendation) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAllOfRecommendation) SetType(v string)` + +SetType sets Type field to given value. + + +### GetMethod + +`func (o *AccountAllOfRecommendation) GetMethod() string` + +GetMethod returns the Method field if non-nil, zero value otherwise. + +### GetMethodOk + +`func (o *AccountAllOfRecommendation) GetMethodOk() (*string, bool)` + +GetMethodOk returns a tuple with the Method field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMethod + +`func (o *AccountAllOfRecommendation) SetMethod(v string)` + +SetMethod sets Method field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAllOfSourceOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAllOfSourceOwner.md new file mode 100644 index 000000000..475c47182 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAllOfSourceOwner.md @@ -0,0 +1,116 @@ +--- +id: v2025-account-all-of-source-owner +title: AccountAllOfSourceOwner +pagination_label: AccountAllOfSourceOwner +sidebar_label: AccountAllOfSourceOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAllOfSourceOwner', 'V2025AccountAllOfSourceOwner'] +slug: /tools/sdk/go/v2025/models/account-all-of-source-owner +tags: ['SDK', 'Software Development Kit', 'AccountAllOfSourceOwner', 'V2025AccountAllOfSourceOwner'] +--- + +# AccountAllOfSourceOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the identity | [optional] +**Type** | Pointer to **string** | The type of object being referenced | [optional] +**Name** | Pointer to **string** | display name of identity | [optional] + +## Methods + +### NewAccountAllOfSourceOwner + +`func NewAccountAllOfSourceOwner() *AccountAllOfSourceOwner` + +NewAccountAllOfSourceOwner instantiates a new AccountAllOfSourceOwner 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 + +### NewAccountAllOfSourceOwnerWithDefaults + +`func NewAccountAllOfSourceOwnerWithDefaults() *AccountAllOfSourceOwner` + +NewAccountAllOfSourceOwnerWithDefaults instantiates a new AccountAllOfSourceOwner 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 + +### GetId + +`func (o *AccountAllOfSourceOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAllOfSourceOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAllOfSourceOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountAllOfSourceOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccountAllOfSourceOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAllOfSourceOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAllOfSourceOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountAllOfSourceOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccountAllOfSourceOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAllOfSourceOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAllOfSourceOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountAllOfSourceOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributes.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributes.md new file mode 100644 index 000000000..b10852f65 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributes.md @@ -0,0 +1,59 @@ +--- +id: v2025-account-attributes +title: AccountAttributes +pagination_label: AccountAttributes +sidebar_label: AccountAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributes', 'V2025AccountAttributes'] +slug: /tools/sdk/go/v2025/models/account-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributes', 'V2025AccountAttributes'] +--- + +# AccountAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | **map[string]interface{}** | The schema attribute values for the account | + +## Methods + +### NewAccountAttributes + +`func NewAccountAttributes(attributes map[string]interface{}, ) *AccountAttributes` + +NewAccountAttributes instantiates a new AccountAttributes 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 + +### NewAccountAttributesWithDefaults + +`func NewAccountAttributesWithDefaults() *AccountAttributes` + +NewAccountAttributesWithDefaults instantiates a new AccountAttributes 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 + +### GetAttributes + +`func (o *AccountAttributes) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AccountAttributes) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AccountAttributes) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChanged.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChanged.md new file mode 100644 index 000000000..1e5466000 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChanged.md @@ -0,0 +1,122 @@ +--- +id: v2025-account-attributes-changed +title: AccountAttributesChanged +pagination_label: AccountAttributesChanged +sidebar_label: AccountAttributesChanged +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChanged', 'V2025AccountAttributesChanged'] +slug: /tools/sdk/go/v2025/models/account-attributes-changed +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChanged', 'V2025AccountAttributesChanged'] +--- + +# AccountAttributesChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**AccountAttributesChangedIdentity**](account-attributes-changed-identity) | | +**Source** | [**AccountAttributesChangedSource**](account-attributes-changed-source) | | +**Account** | [**AccountAttributesChangedAccount**](account-attributes-changed-account) | | +**Changes** | [**[]AccountAttributesChangedChangesInner**](account-attributes-changed-changes-inner) | A list of attributes that changed. | + +## Methods + +### NewAccountAttributesChanged + +`func NewAccountAttributesChanged(identity AccountAttributesChangedIdentity, source AccountAttributesChangedSource, account AccountAttributesChangedAccount, changes []AccountAttributesChangedChangesInner, ) *AccountAttributesChanged` + +NewAccountAttributesChanged instantiates a new AccountAttributesChanged 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 + +### NewAccountAttributesChangedWithDefaults + +`func NewAccountAttributesChangedWithDefaults() *AccountAttributesChanged` + +NewAccountAttributesChangedWithDefaults instantiates a new AccountAttributesChanged 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 + +### GetIdentity + +`func (o *AccountAttributesChanged) GetIdentity() AccountAttributesChangedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *AccountAttributesChanged) GetIdentityOk() (*AccountAttributesChangedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *AccountAttributesChanged) SetIdentity(v AccountAttributesChangedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetSource + +`func (o *AccountAttributesChanged) GetSource() AccountAttributesChangedSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountAttributesChanged) GetSourceOk() (*AccountAttributesChangedSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountAttributesChanged) SetSource(v AccountAttributesChangedSource)` + +SetSource sets Source field to given value. + + +### GetAccount + +`func (o *AccountAttributesChanged) GetAccount() AccountAttributesChangedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *AccountAttributesChanged) GetAccountOk() (*AccountAttributesChangedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *AccountAttributesChanged) SetAccount(v AccountAttributesChangedAccount)` + +SetAccount sets Account field to given value. + + +### GetChanges + +`func (o *AccountAttributesChanged) GetChanges() []AccountAttributesChangedChangesInner` + +GetChanges returns the Changes field if non-nil, zero value otherwise. + +### GetChangesOk + +`func (o *AccountAttributesChanged) GetChangesOk() (*[]AccountAttributesChangedChangesInner, bool)` + +GetChangesOk returns a tuple with the Changes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanges + +`func (o *AccountAttributesChanged) SetChanges(v []AccountAttributesChangedChangesInner)` + +SetChanges sets Changes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedAccount.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedAccount.md new file mode 100644 index 000000000..520d70916 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedAccount.md @@ -0,0 +1,153 @@ +--- +id: v2025-account-attributes-changed-account +title: AccountAttributesChangedAccount +pagination_label: AccountAttributesChangedAccount +sidebar_label: AccountAttributesChangedAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedAccount', 'V2025AccountAttributesChangedAccount'] +slug: /tools/sdk/go/v2025/models/account-attributes-changed-account +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedAccount', 'V2025AccountAttributesChangedAccount'] +--- + +# AccountAttributesChangedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | SailPoint generated unique identifier. | +**Uuid** | **NullableString** | The source's unique identifier for the account. UUID is generated by the source system. | +**Name** | **string** | Name of the account. | +**NativeIdentity** | **string** | Unique ID of the account on the source. | +**Type** | **map[string]interface{}** | The type of the account | + +## Methods + +### NewAccountAttributesChangedAccount + +`func NewAccountAttributesChangedAccount(id string, uuid NullableString, name string, nativeIdentity string, type_ map[string]interface{}, ) *AccountAttributesChangedAccount` + +NewAccountAttributesChangedAccount instantiates a new AccountAttributesChangedAccount 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 + +### NewAccountAttributesChangedAccountWithDefaults + +`func NewAccountAttributesChangedAccountWithDefaults() *AccountAttributesChangedAccount` + +NewAccountAttributesChangedAccountWithDefaults instantiates a new AccountAttributesChangedAccount 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 + +### GetId + +`func (o *AccountAttributesChangedAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAttributesChangedAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAttributesChangedAccount) SetId(v string)` + +SetId sets Id field to given value. + + +### GetUuid + +`func (o *AccountAttributesChangedAccount) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *AccountAttributesChangedAccount) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *AccountAttributesChangedAccount) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + + +### SetUuidNil + +`func (o *AccountAttributesChangedAccount) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *AccountAttributesChangedAccount) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetName + +`func (o *AccountAttributesChangedAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAttributesChangedAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAttributesChangedAccount) SetName(v string)` + +SetName sets Name field to given value. + + +### GetNativeIdentity + +`func (o *AccountAttributesChangedAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountAttributesChangedAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountAttributesChangedAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + + +### GetType + +`func (o *AccountAttributesChangedAccount) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAttributesChangedAccount) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAttributesChangedAccount) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedChangesInner.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedChangesInner.md new file mode 100644 index 000000000..7bf6eb170 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedChangesInner.md @@ -0,0 +1,121 @@ +--- +id: v2025-account-attributes-changed-changes-inner +title: AccountAttributesChangedChangesInner +pagination_label: AccountAttributesChangedChangesInner +sidebar_label: AccountAttributesChangedChangesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedChangesInner', 'V2025AccountAttributesChangedChangesInner'] +slug: /tools/sdk/go/v2025/models/account-attributes-changed-changes-inner +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInner', 'V2025AccountAttributesChangedChangesInner'] +--- + +# AccountAttributesChangedChangesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | **string** | The name of the attribute. | +**OldValue** | [**NullableAccountAttributesChangedChangesInnerOldValue**](account-attributes-changed-changes-inner-old-value) | | +**NewValue** | [**NullableAccountAttributesChangedChangesInnerNewValue**](account-attributes-changed-changes-inner-new-value) | | + +## Methods + +### NewAccountAttributesChangedChangesInner + +`func NewAccountAttributesChangedChangesInner(attribute string, oldValue NullableAccountAttributesChangedChangesInnerOldValue, newValue NullableAccountAttributesChangedChangesInnerNewValue, ) *AccountAttributesChangedChangesInner` + +NewAccountAttributesChangedChangesInner instantiates a new AccountAttributesChangedChangesInner 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 + +### NewAccountAttributesChangedChangesInnerWithDefaults + +`func NewAccountAttributesChangedChangesInnerWithDefaults() *AccountAttributesChangedChangesInner` + +NewAccountAttributesChangedChangesInnerWithDefaults instantiates a new AccountAttributesChangedChangesInner 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 + +### GetAttribute + +`func (o *AccountAttributesChangedChangesInner) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *AccountAttributesChangedChangesInner) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *AccountAttributesChangedChangesInner) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + + +### GetOldValue + +`func (o *AccountAttributesChangedChangesInner) GetOldValue() AccountAttributesChangedChangesInnerOldValue` + +GetOldValue returns the OldValue field if non-nil, zero value otherwise. + +### GetOldValueOk + +`func (o *AccountAttributesChangedChangesInner) GetOldValueOk() (*AccountAttributesChangedChangesInnerOldValue, bool)` + +GetOldValueOk returns a tuple with the OldValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOldValue + +`func (o *AccountAttributesChangedChangesInner) SetOldValue(v AccountAttributesChangedChangesInnerOldValue)` + +SetOldValue sets OldValue field to given value. + + +### SetOldValueNil + +`func (o *AccountAttributesChangedChangesInner) SetOldValueNil(b bool)` + + SetOldValueNil sets the value for OldValue to be an explicit nil + +### UnsetOldValue +`func (o *AccountAttributesChangedChangesInner) UnsetOldValue()` + +UnsetOldValue ensures that no value is present for OldValue, not even an explicit nil +### GetNewValue + +`func (o *AccountAttributesChangedChangesInner) GetNewValue() AccountAttributesChangedChangesInnerNewValue` + +GetNewValue returns the NewValue field if non-nil, zero value otherwise. + +### GetNewValueOk + +`func (o *AccountAttributesChangedChangesInner) GetNewValueOk() (*AccountAttributesChangedChangesInnerNewValue, bool)` + +GetNewValueOk returns a tuple with the NewValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewValue + +`func (o *AccountAttributesChangedChangesInner) SetNewValue(v AccountAttributesChangedChangesInnerNewValue)` + +SetNewValue sets NewValue field to given value. + + +### SetNewValueNil + +`func (o *AccountAttributesChangedChangesInner) SetNewValueNil(b bool)` + + SetNewValueNil sets the value for NewValue to be an explicit nil + +### UnsetNewValue +`func (o *AccountAttributesChangedChangesInner) UnsetNewValue()` + +UnsetNewValue ensures that no value is present for NewValue, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedChangesInnerNewValue.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedChangesInnerNewValue.md new file mode 100644 index 000000000..2fed930f5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedChangesInnerNewValue.md @@ -0,0 +1,38 @@ +--- +id: v2025-account-attributes-changed-changes-inner-new-value +title: AccountAttributesChangedChangesInnerNewValue +pagination_label: AccountAttributesChangedChangesInnerNewValue +sidebar_label: AccountAttributesChangedChangesInnerNewValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedChangesInnerNewValue', 'V2025AccountAttributesChangedChangesInnerNewValue'] +slug: /tools/sdk/go/v2025/models/account-attributes-changed-changes-inner-new-value +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerNewValue', 'V2025AccountAttributesChangedChangesInnerNewValue'] +--- + +# AccountAttributesChangedChangesInnerNewValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewAccountAttributesChangedChangesInnerNewValue + +`func NewAccountAttributesChangedChangesInnerNewValue() *AccountAttributesChangedChangesInnerNewValue` + +NewAccountAttributesChangedChangesInnerNewValue instantiates a new AccountAttributesChangedChangesInnerNewValue 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 + +### NewAccountAttributesChangedChangesInnerNewValueWithDefaults + +`func NewAccountAttributesChangedChangesInnerNewValueWithDefaults() *AccountAttributesChangedChangesInnerNewValue` + +NewAccountAttributesChangedChangesInnerNewValueWithDefaults instantiates a new AccountAttributesChangedChangesInnerNewValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedChangesInnerOldValue.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedChangesInnerOldValue.md new file mode 100644 index 000000000..795182624 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedChangesInnerOldValue.md @@ -0,0 +1,38 @@ +--- +id: v2025-account-attributes-changed-changes-inner-old-value +title: AccountAttributesChangedChangesInnerOldValue +pagination_label: AccountAttributesChangedChangesInnerOldValue +sidebar_label: AccountAttributesChangedChangesInnerOldValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedChangesInnerOldValue', 'V2025AccountAttributesChangedChangesInnerOldValue'] +slug: /tools/sdk/go/v2025/models/account-attributes-changed-changes-inner-old-value +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerOldValue', 'V2025AccountAttributesChangedChangesInnerOldValue'] +--- + +# AccountAttributesChangedChangesInnerOldValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewAccountAttributesChangedChangesInnerOldValue + +`func NewAccountAttributesChangedChangesInnerOldValue() *AccountAttributesChangedChangesInnerOldValue` + +NewAccountAttributesChangedChangesInnerOldValue instantiates a new AccountAttributesChangedChangesInnerOldValue 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 + +### NewAccountAttributesChangedChangesInnerOldValueWithDefaults + +`func NewAccountAttributesChangedChangesInnerOldValueWithDefaults() *AccountAttributesChangedChangesInnerOldValue` + +NewAccountAttributesChangedChangesInnerOldValueWithDefaults instantiates a new AccountAttributesChangedChangesInnerOldValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedIdentity.md new file mode 100644 index 000000000..401c3ce63 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedIdentity.md @@ -0,0 +1,101 @@ +--- +id: v2025-account-attributes-changed-identity +title: AccountAttributesChangedIdentity +pagination_label: AccountAttributesChangedIdentity +sidebar_label: AccountAttributesChangedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedIdentity', 'V2025AccountAttributesChangedIdentity'] +slug: /tools/sdk/go/v2025/models/account-attributes-changed-identity +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedIdentity', 'V2025AccountAttributesChangedIdentity'] +--- + +# AccountAttributesChangedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of the identity whose account attributes were updated. | +**Id** | **string** | ID of the identity whose account attributes were updated. | +**Name** | **string** | Display name of the identity whose account attributes were updated. | + +## Methods + +### NewAccountAttributesChangedIdentity + +`func NewAccountAttributesChangedIdentity(type_ string, id string, name string, ) *AccountAttributesChangedIdentity` + +NewAccountAttributesChangedIdentity instantiates a new AccountAttributesChangedIdentity 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 + +### NewAccountAttributesChangedIdentityWithDefaults + +`func NewAccountAttributesChangedIdentityWithDefaults() *AccountAttributesChangedIdentity` + +NewAccountAttributesChangedIdentityWithDefaults instantiates a new AccountAttributesChangedIdentity 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 + +### GetType + +`func (o *AccountAttributesChangedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAttributesChangedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAttributesChangedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountAttributesChangedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAttributesChangedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAttributesChangedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountAttributesChangedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAttributesChangedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAttributesChangedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedSource.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedSource.md new file mode 100644 index 000000000..02594fa9d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesChangedSource.md @@ -0,0 +1,101 @@ +--- +id: v2025-account-attributes-changed-source +title: AccountAttributesChangedSource +pagination_label: AccountAttributesChangedSource +sidebar_label: AccountAttributesChangedSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesChangedSource', 'V2025AccountAttributesChangedSource'] +slug: /tools/sdk/go/v2025/models/account-attributes-changed-source +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedSource', 'V2025AccountAttributesChangedSource'] +--- + +# AccountAttributesChangedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the object to which this reference applies | +**Type** | **string** | The type of object that is referenced | +**Name** | **string** | Human-readable display name of the object to which this reference applies | + +## Methods + +### NewAccountAttributesChangedSource + +`func NewAccountAttributesChangedSource(id string, type_ string, name string, ) *AccountAttributesChangedSource` + +NewAccountAttributesChangedSource instantiates a new AccountAttributesChangedSource 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 + +### NewAccountAttributesChangedSourceWithDefaults + +`func NewAccountAttributesChangedSourceWithDefaults() *AccountAttributesChangedSource` + +NewAccountAttributesChangedSourceWithDefaults instantiates a new AccountAttributesChangedSource 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 + +### GetId + +`func (o *AccountAttributesChangedSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAttributesChangedSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAttributesChangedSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *AccountAttributesChangedSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAttributesChangedSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAttributesChangedSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetName + +`func (o *AccountAttributesChangedSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAttributesChangedSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAttributesChangedSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesCreate.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesCreate.md new file mode 100644 index 000000000..32a7d5631 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesCreate.md @@ -0,0 +1,59 @@ +--- +id: v2025-account-attributes-create +title: AccountAttributesCreate +pagination_label: AccountAttributesCreate +sidebar_label: AccountAttributesCreate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesCreate', 'V2025AccountAttributesCreate'] +slug: /tools/sdk/go/v2025/models/account-attributes-create +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate', 'V2025AccountAttributesCreate'] +--- + +# AccountAttributesCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | + +## Methods + +### NewAccountAttributesCreate + +`func NewAccountAttributesCreate(attributes AccountAttributesCreateAttributes, ) *AccountAttributesCreate` + +NewAccountAttributesCreate instantiates a new AccountAttributesCreate 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 + +### NewAccountAttributesCreateWithDefaults + +`func NewAccountAttributesCreateWithDefaults() *AccountAttributesCreate` + +NewAccountAttributesCreateWithDefaults instantiates a new AccountAttributesCreate 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 + +### GetAttributes + +`func (o *AccountAttributesCreate) GetAttributes() AccountAttributesCreateAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AccountAttributesCreate) GetAttributesOk() (*AccountAttributesCreateAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AccountAttributesCreate) SetAttributes(v AccountAttributesCreateAttributes)` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesCreateAttributes.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesCreateAttributes.md new file mode 100644 index 000000000..4b55d24db --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountAttributesCreateAttributes.md @@ -0,0 +1,59 @@ +--- +id: v2025-account-attributes-create-attributes +title: AccountAttributesCreateAttributes +pagination_label: AccountAttributesCreateAttributes +sidebar_label: AccountAttributesCreateAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesCreateAttributes', 'V2025AccountAttributesCreateAttributes'] +slug: /tools/sdk/go/v2025/models/account-attributes-create-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreateAttributes', 'V2025AccountAttributesCreateAttributes'] +--- + +# AccountAttributesCreateAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | **string** | Target source to create an account | + +## Methods + +### NewAccountAttributesCreateAttributes + +`func NewAccountAttributesCreateAttributes(sourceId string, ) *AccountAttributesCreateAttributes` + +NewAccountAttributesCreateAttributes instantiates a new AccountAttributesCreateAttributes 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 + +### NewAccountAttributesCreateAttributesWithDefaults + +`func NewAccountAttributesCreateAttributesWithDefaults() *AccountAttributesCreateAttributes` + +NewAccountAttributesCreateAttributesWithDefaults instantiates a new AccountAttributesCreateAttributes 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 + +### GetSourceId + +`func (o *AccountAttributesCreateAttributes) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccountAttributesCreateAttributes) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccountAttributesCreateAttributes) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountCorrelated.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountCorrelated.md new file mode 100644 index 000000000..56be56cc9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountCorrelated.md @@ -0,0 +1,148 @@ +--- +id: v2025-account-correlated +title: AccountCorrelated +pagination_label: AccountCorrelated +sidebar_label: AccountCorrelated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountCorrelated', 'V2025AccountCorrelated'] +slug: /tools/sdk/go/v2025/models/account-correlated +tags: ['SDK', 'Software Development Kit', 'AccountCorrelated', 'V2025AccountCorrelated'] +--- + +# AccountCorrelated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**AccountCorrelatedIdentity**](account-correlated-identity) | | +**Source** | [**AccountCorrelatedSource**](account-correlated-source) | | +**Account** | [**AccountCorrelatedAccount**](account-correlated-account) | | +**Attributes** | **map[string]interface{}** | The attributes associated with the account. Attributes are unique per source. | +**EntitlementCount** | Pointer to **int32** | The number of entitlements associated with this account. | [optional] + +## Methods + +### NewAccountCorrelated + +`func NewAccountCorrelated(identity AccountCorrelatedIdentity, source AccountCorrelatedSource, account AccountCorrelatedAccount, attributes map[string]interface{}, ) *AccountCorrelated` + +NewAccountCorrelated instantiates a new AccountCorrelated 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 + +### NewAccountCorrelatedWithDefaults + +`func NewAccountCorrelatedWithDefaults() *AccountCorrelated` + +NewAccountCorrelatedWithDefaults instantiates a new AccountCorrelated 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 + +### GetIdentity + +`func (o *AccountCorrelated) GetIdentity() AccountCorrelatedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *AccountCorrelated) GetIdentityOk() (*AccountCorrelatedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *AccountCorrelated) SetIdentity(v AccountCorrelatedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetSource + +`func (o *AccountCorrelated) GetSource() AccountCorrelatedSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountCorrelated) GetSourceOk() (*AccountCorrelatedSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountCorrelated) SetSource(v AccountCorrelatedSource)` + +SetSource sets Source field to given value. + + +### GetAccount + +`func (o *AccountCorrelated) GetAccount() AccountCorrelatedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *AccountCorrelated) GetAccountOk() (*AccountCorrelatedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *AccountCorrelated) SetAccount(v AccountCorrelatedAccount)` + +SetAccount sets Account field to given value. + + +### GetAttributes + +`func (o *AccountCorrelated) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AccountCorrelated) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AccountCorrelated) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetEntitlementCount + +`func (o *AccountCorrelated) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccountCorrelated) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccountCorrelated) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccountCorrelated) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountCorrelatedAccount.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountCorrelatedAccount.md new file mode 100644 index 000000000..a3a370175 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountCorrelatedAccount.md @@ -0,0 +1,158 @@ +--- +id: v2025-account-correlated-account +title: AccountCorrelatedAccount +pagination_label: AccountCorrelatedAccount +sidebar_label: AccountCorrelatedAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountCorrelatedAccount', 'V2025AccountCorrelatedAccount'] +slug: /tools/sdk/go/v2025/models/account-correlated-account +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedAccount', 'V2025AccountCorrelatedAccount'] +--- + +# AccountCorrelatedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The correlated account's DTO type. | +**Id** | **string** | The correlated account's ID. | +**Name** | **string** | The correlated account's display name. | +**NativeIdentity** | **string** | Unique ID of the account on the source. | +**Uuid** | Pointer to **NullableString** | The source's unique identifier for the account. UUID is generated by the source system. | [optional] + +## Methods + +### NewAccountCorrelatedAccount + +`func NewAccountCorrelatedAccount(type_ string, id string, name string, nativeIdentity string, ) *AccountCorrelatedAccount` + +NewAccountCorrelatedAccount instantiates a new AccountCorrelatedAccount 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 + +### NewAccountCorrelatedAccountWithDefaults + +`func NewAccountCorrelatedAccountWithDefaults() *AccountCorrelatedAccount` + +NewAccountCorrelatedAccountWithDefaults instantiates a new AccountCorrelatedAccount 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 + +### GetType + +`func (o *AccountCorrelatedAccount) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountCorrelatedAccount) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountCorrelatedAccount) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountCorrelatedAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountCorrelatedAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountCorrelatedAccount) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountCorrelatedAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountCorrelatedAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountCorrelatedAccount) SetName(v string)` + +SetName sets Name field to given value. + + +### GetNativeIdentity + +`func (o *AccountCorrelatedAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountCorrelatedAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountCorrelatedAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + + +### GetUuid + +`func (o *AccountCorrelatedAccount) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *AccountCorrelatedAccount) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *AccountCorrelatedAccount) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *AccountCorrelatedAccount) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *AccountCorrelatedAccount) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *AccountCorrelatedAccount) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountCorrelatedIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountCorrelatedIdentity.md new file mode 100644 index 000000000..f1d62af84 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountCorrelatedIdentity.md @@ -0,0 +1,101 @@ +--- +id: v2025-account-correlated-identity +title: AccountCorrelatedIdentity +pagination_label: AccountCorrelatedIdentity +sidebar_label: AccountCorrelatedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountCorrelatedIdentity', 'V2025AccountCorrelatedIdentity'] +slug: /tools/sdk/go/v2025/models/account-correlated-identity +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedIdentity', 'V2025AccountCorrelatedIdentity'] +--- + +# AccountCorrelatedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of the identity the account is correlated with. | +**Id** | **string** | ID of the identity the account is correlated with. | +**Name** | **string** | Display name of the identity the account is correlated with. | + +## Methods + +### NewAccountCorrelatedIdentity + +`func NewAccountCorrelatedIdentity(type_ string, id string, name string, ) *AccountCorrelatedIdentity` + +NewAccountCorrelatedIdentity instantiates a new AccountCorrelatedIdentity 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 + +### NewAccountCorrelatedIdentityWithDefaults + +`func NewAccountCorrelatedIdentityWithDefaults() *AccountCorrelatedIdentity` + +NewAccountCorrelatedIdentityWithDefaults instantiates a new AccountCorrelatedIdentity 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 + +### GetType + +`func (o *AccountCorrelatedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountCorrelatedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountCorrelatedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountCorrelatedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountCorrelatedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountCorrelatedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountCorrelatedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountCorrelatedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountCorrelatedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountCorrelatedSource.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountCorrelatedSource.md new file mode 100644 index 000000000..dbe755c2e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountCorrelatedSource.md @@ -0,0 +1,101 @@ +--- +id: v2025-account-correlated-source +title: AccountCorrelatedSource +pagination_label: AccountCorrelatedSource +sidebar_label: AccountCorrelatedSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountCorrelatedSource', 'V2025AccountCorrelatedSource'] +slug: /tools/sdk/go/v2025/models/account-correlated-source +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedSource', 'V2025AccountCorrelatedSource'] +--- + +# AccountCorrelatedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The DTO type of the source the accounts are being correlated from. | +**Id** | **string** | The ID of the source the accounts are being correlated from. | +**Name** | **string** | Display name of the source the accounts are being correlated from. | + +## Methods + +### NewAccountCorrelatedSource + +`func NewAccountCorrelatedSource(type_ string, id string, name string, ) *AccountCorrelatedSource` + +NewAccountCorrelatedSource instantiates a new AccountCorrelatedSource 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 + +### NewAccountCorrelatedSourceWithDefaults + +`func NewAccountCorrelatedSourceWithDefaults() *AccountCorrelatedSource` + +NewAccountCorrelatedSourceWithDefaults instantiates a new AccountCorrelatedSource 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 + +### GetType + +`func (o *AccountCorrelatedSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountCorrelatedSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountCorrelatedSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountCorrelatedSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountCorrelatedSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountCorrelatedSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountCorrelatedSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountCorrelatedSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountCorrelatedSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountInfoDto.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountInfoDto.md new file mode 100644 index 000000000..cc8588eb8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountInfoDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-account-info-dto +title: AccountInfoDto +pagination_label: AccountInfoDto +sidebar_label: AccountInfoDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountInfoDto', 'V2025AccountInfoDto'] +slug: /tools/sdk/go/v2025/models/account-info-dto +tags: ['SDK', 'Software Development Kit', 'AccountInfoDto', 'V2025AccountInfoDto'] +--- + +# AccountInfoDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NativeIdentity** | Pointer to **string** | The unique ID of the account generated by the source system | [optional] +**DisplayName** | Pointer to **string** | Display name for this account | [optional] +**Uuid** | Pointer to **string** | UUID associated with this account | [optional] + +## Methods + +### NewAccountInfoDto + +`func NewAccountInfoDto() *AccountInfoDto` + +NewAccountInfoDto instantiates a new AccountInfoDto 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 + +### NewAccountInfoDtoWithDefaults + +`func NewAccountInfoDtoWithDefaults() *AccountInfoDto` + +NewAccountInfoDtoWithDefaults instantiates a new AccountInfoDto 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 + +### GetNativeIdentity + +`func (o *AccountInfoDto) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountInfoDto) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountInfoDto) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccountInfoDto) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccountInfoDto) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccountInfoDto) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccountInfoDto) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccountInfoDto) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetUuid + +`func (o *AccountInfoDto) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *AccountInfoDto) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *AccountInfoDto) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *AccountInfoDto) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountInfoRef.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountInfoRef.md new file mode 100644 index 000000000..8e403ac64 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountInfoRef.md @@ -0,0 +1,168 @@ +--- +id: v2025-account-info-ref +title: AccountInfoRef +pagination_label: AccountInfoRef +sidebar_label: AccountInfoRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountInfoRef', 'V2025AccountInfoRef'] +slug: /tools/sdk/go/v2025/models/account-info-ref +tags: ['SDK', 'Software Development Kit', 'AccountInfoRef', 'V2025AccountInfoRef'] +--- + +# AccountInfoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | Pointer to **string** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | Pointer to **string** | The 'distinguishedName' attribute for the account | [optional] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | The account id | [optional] +**Name** | Pointer to **string** | The account display name | [optional] + +## Methods + +### NewAccountInfoRef + +`func NewAccountInfoRef() *AccountInfoRef` + +NewAccountInfoRef instantiates a new AccountInfoRef 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 + +### NewAccountInfoRefWithDefaults + +`func NewAccountInfoRefWithDefaults() *AccountInfoRef` + +NewAccountInfoRefWithDefaults instantiates a new AccountInfoRef 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 + +### GetUuid + +`func (o *AccountInfoRef) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *AccountInfoRef) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *AccountInfoRef) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *AccountInfoRef) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *AccountInfoRef) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountInfoRef) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountInfoRef) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccountInfoRef) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetType + +`func (o *AccountInfoRef) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountInfoRef) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountInfoRef) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountInfoRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccountInfoRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountInfoRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountInfoRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountInfoRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccountInfoRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountInfoRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountInfoRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountInfoRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountItemRef.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountItemRef.md new file mode 100644 index 000000000..9cef371d2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountItemRef.md @@ -0,0 +1,100 @@ +--- +id: v2025-account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountItemRef', 'V2025AccountItemRef'] +slug: /tools/sdk/go/v2025/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'V2025AccountItemRef'] +--- + +# AccountItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountUuid** | Pointer to **NullableString** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | Pointer to **string** | The 'distinguishedName' attribute for the account | [optional] + +## Methods + +### NewAccountItemRef + +`func NewAccountItemRef() *AccountItemRef` + +NewAccountItemRef instantiates a new AccountItemRef 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 + +### NewAccountItemRefWithDefaults + +`func NewAccountItemRefWithDefaults() *AccountItemRef` + +NewAccountItemRefWithDefaults instantiates a new AccountItemRef 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 + +### GetAccountUuid + +`func (o *AccountItemRef) GetAccountUuid() string` + +GetAccountUuid returns the AccountUuid field if non-nil, zero value otherwise. + +### GetAccountUuidOk + +`func (o *AccountItemRef) GetAccountUuidOk() (*string, bool)` + +GetAccountUuidOk returns a tuple with the AccountUuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountUuid + +`func (o *AccountItemRef) SetAccountUuid(v string)` + +SetAccountUuid sets AccountUuid field to given value. + +### HasAccountUuid + +`func (o *AccountItemRef) HasAccountUuid() bool` + +HasAccountUuid returns a boolean if a field has been set. + +### SetAccountUuidNil + +`func (o *AccountItemRef) SetAccountUuidNil(b bool)` + + SetAccountUuidNil sets the value for AccountUuid to be an explicit nil + +### UnsetAccountUuid +`func (o *AccountItemRef) UnsetAccountUuid()` + +UnsetAccountUuid ensures that no value is present for AccountUuid, not even an explicit nil +### GetNativeIdentity + +`func (o *AccountItemRef) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountItemRef) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountItemRef) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccountItemRef) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountRequest.md new file mode 100644 index 000000000..7959ff916 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountRequest.md @@ -0,0 +1,194 @@ +--- +id: v2025-account-request +title: AccountRequest +pagination_label: AccountRequest +sidebar_label: AccountRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountRequest', 'V2025AccountRequest'] +slug: /tools/sdk/go/v2025/models/account-request +tags: ['SDK', 'Software Development Kit', 'AccountRequest', 'V2025AccountRequest'] +--- + +# AccountRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **string** | Unique ID of the account | [optional] +**AttributeRequests** | Pointer to [**[]AttributeRequest**](attribute-request) | | [optional] +**Op** | Pointer to **string** | The operation that was performed | [optional] +**ProvisioningTarget** | Pointer to [**AccountSource**](account-source) | | [optional] +**Result** | Pointer to [**AccountRequestResult**](account-request-result) | | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] + +## Methods + +### NewAccountRequest + +`func NewAccountRequest() *AccountRequest` + +NewAccountRequest instantiates a new AccountRequest 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 + +### NewAccountRequestWithDefaults + +`func NewAccountRequestWithDefaults() *AccountRequest` + +NewAccountRequestWithDefaults instantiates a new AccountRequest 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 + +### GetAccountId + +`func (o *AccountRequest) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *AccountRequest) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *AccountRequest) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *AccountRequest) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetAttributeRequests + +`func (o *AccountRequest) GetAttributeRequests() []AttributeRequest` + +GetAttributeRequests returns the AttributeRequests field if non-nil, zero value otherwise. + +### GetAttributeRequestsOk + +`func (o *AccountRequest) GetAttributeRequestsOk() (*[]AttributeRequest, bool)` + +GetAttributeRequestsOk returns a tuple with the AttributeRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeRequests + +`func (o *AccountRequest) SetAttributeRequests(v []AttributeRequest)` + +SetAttributeRequests sets AttributeRequests field to given value. + +### HasAttributeRequests + +`func (o *AccountRequest) HasAttributeRequests() bool` + +HasAttributeRequests returns a boolean if a field has been set. + +### GetOp + +`func (o *AccountRequest) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *AccountRequest) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *AccountRequest) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *AccountRequest) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetProvisioningTarget + +`func (o *AccountRequest) GetProvisioningTarget() AccountSource` + +GetProvisioningTarget returns the ProvisioningTarget field if non-nil, zero value otherwise. + +### GetProvisioningTargetOk + +`func (o *AccountRequest) GetProvisioningTargetOk() (*AccountSource, bool)` + +GetProvisioningTargetOk returns a tuple with the ProvisioningTarget field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningTarget + +`func (o *AccountRequest) SetProvisioningTarget(v AccountSource)` + +SetProvisioningTarget sets ProvisioningTarget field to given value. + +### HasProvisioningTarget + +`func (o *AccountRequest) HasProvisioningTarget() bool` + +HasProvisioningTarget returns a boolean if a field has been set. + +### GetResult + +`func (o *AccountRequest) GetResult() AccountRequestResult` + +GetResult returns the Result field if non-nil, zero value otherwise. + +### GetResultOk + +`func (o *AccountRequest) GetResultOk() (*AccountRequestResult, bool)` + +GetResultOk returns a tuple with the Result field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResult + +`func (o *AccountRequest) SetResult(v AccountRequestResult)` + +SetResult sets Result field to given value. + +### HasResult + +`func (o *AccountRequest) HasResult() bool` + +HasResult returns a boolean if a field has been set. + +### GetSource + +`func (o *AccountRequest) GetSource() AccountSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountRequest) GetSourceOk() (*AccountSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountRequest) SetSource(v AccountSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *AccountRequest) HasSource() bool` + +HasSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountRequestInfo.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountRequestInfo.md new file mode 100644 index 000000000..df602b0e4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountRequestInfo.md @@ -0,0 +1,116 @@ +--- +id: v2025-account-request-info +title: AccountRequestInfo +pagination_label: AccountRequestInfo +sidebar_label: AccountRequestInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountRequestInfo', 'V2025AccountRequestInfo'] +slug: /tools/sdk/go/v2025/models/account-request-info +tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'V2025AccountRequestInfo'] +--- + +# AccountRequestInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedObjectId** | Pointer to **string** | Id of requested object | [optional] +**RequestedObjectName** | Pointer to **string** | Human-readable name of requested object | [optional] +**RequestedObjectType** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional] + +## Methods + +### NewAccountRequestInfo + +`func NewAccountRequestInfo() *AccountRequestInfo` + +NewAccountRequestInfo instantiates a new AccountRequestInfo 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 + +### NewAccountRequestInfoWithDefaults + +`func NewAccountRequestInfoWithDefaults() *AccountRequestInfo` + +NewAccountRequestInfoWithDefaults instantiates a new AccountRequestInfo 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 + +### GetRequestedObjectId + +`func (o *AccountRequestInfo) GetRequestedObjectId() string` + +GetRequestedObjectId returns the RequestedObjectId field if non-nil, zero value otherwise. + +### GetRequestedObjectIdOk + +`func (o *AccountRequestInfo) GetRequestedObjectIdOk() (*string, bool)` + +GetRequestedObjectIdOk returns a tuple with the RequestedObjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObjectId + +`func (o *AccountRequestInfo) SetRequestedObjectId(v string)` + +SetRequestedObjectId sets RequestedObjectId field to given value. + +### HasRequestedObjectId + +`func (o *AccountRequestInfo) HasRequestedObjectId() bool` + +HasRequestedObjectId returns a boolean if a field has been set. + +### GetRequestedObjectName + +`func (o *AccountRequestInfo) GetRequestedObjectName() string` + +GetRequestedObjectName returns the RequestedObjectName field if non-nil, zero value otherwise. + +### GetRequestedObjectNameOk + +`func (o *AccountRequestInfo) GetRequestedObjectNameOk() (*string, bool)` + +GetRequestedObjectNameOk returns a tuple with the RequestedObjectName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObjectName + +`func (o *AccountRequestInfo) SetRequestedObjectName(v string)` + +SetRequestedObjectName sets RequestedObjectName field to given value. + +### HasRequestedObjectName + +`func (o *AccountRequestInfo) HasRequestedObjectName() bool` + +HasRequestedObjectName returns a boolean if a field has been set. + +### GetRequestedObjectType + +`func (o *AccountRequestInfo) GetRequestedObjectType() RequestableObjectType` + +GetRequestedObjectType returns the RequestedObjectType field if non-nil, zero value otherwise. + +### GetRequestedObjectTypeOk + +`func (o *AccountRequestInfo) GetRequestedObjectTypeOk() (*RequestableObjectType, bool)` + +GetRequestedObjectTypeOk returns a tuple with the RequestedObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObjectType + +`func (o *AccountRequestInfo) SetRequestedObjectType(v RequestableObjectType)` + +SetRequestedObjectType sets RequestedObjectType field to given value. + +### HasRequestedObjectType + +`func (o *AccountRequestInfo) HasRequestedObjectType() bool` + +HasRequestedObjectType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountRequestResult.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountRequestResult.md new file mode 100644 index 000000000..fedc8dfc3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountRequestResult.md @@ -0,0 +1,126 @@ +--- +id: v2025-account-request-result +title: AccountRequestResult +pagination_label: AccountRequestResult +sidebar_label: AccountRequestResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountRequestResult', 'V2025AccountRequestResult'] +slug: /tools/sdk/go/v2025/models/account-request-result +tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'V2025AccountRequestResult'] +--- + +# AccountRequestResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | Pointer to **[]string** | Error message. | [optional] +**Status** | Pointer to **string** | The status of the account request | [optional] +**TicketId** | Pointer to **NullableString** | ID of associated ticket. | [optional] + +## Methods + +### NewAccountRequestResult + +`func NewAccountRequestResult() *AccountRequestResult` + +NewAccountRequestResult instantiates a new AccountRequestResult 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 + +### NewAccountRequestResultWithDefaults + +`func NewAccountRequestResultWithDefaults() *AccountRequestResult` + +NewAccountRequestResultWithDefaults instantiates a new AccountRequestResult 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 + +### GetErrors + +`func (o *AccountRequestResult) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountRequestResult) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountRequestResult) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *AccountRequestResult) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccountRequestResult) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountRequestResult) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountRequestResult) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccountRequestResult) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetTicketId + +`func (o *AccountRequestResult) GetTicketId() string` + +GetTicketId returns the TicketId field if non-nil, zero value otherwise. + +### GetTicketIdOk + +`func (o *AccountRequestResult) GetTicketIdOk() (*string, bool)` + +GetTicketIdOk returns a tuple with the TicketId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTicketId + +`func (o *AccountRequestResult) SetTicketId(v string)` + +SetTicketId sets TicketId field to given value. + +### HasTicketId + +`func (o *AccountRequestResult) HasTicketId() bool` + +HasTicketId returns a boolean if a field has been set. + +### SetTicketIdNil + +`func (o *AccountRequestResult) SetTicketIdNil(b bool)` + + SetTicketIdNil sets the value for TicketId to be an explicit nil + +### UnsetTicketId +`func (o *AccountRequestResult) UnsetTicketId()` + +UnsetTicketId ensures that no value is present for TicketId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountSource.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountSource.md new file mode 100644 index 000000000..1bbbb888e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountSource.md @@ -0,0 +1,116 @@ +--- +id: v2025-account-source +title: AccountSource +pagination_label: AccountSource +sidebar_label: AccountSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountSource', 'V2025AccountSource'] +slug: /tools/sdk/go/v2025/models/account-source +tags: ['SDK', 'Software Development Kit', 'AccountSource', 'V2025AccountSource'] +--- + +# AccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**Type** | Pointer to **string** | Type of source returned. | [optional] + +## Methods + +### NewAccountSource + +`func NewAccountSource() *AccountSource` + +NewAccountSource instantiates a new AccountSource 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 + +### NewAccountSourceWithDefaults + +`func NewAccountSourceWithDefaults() *AccountSource` + +NewAccountSourceWithDefaults instantiates a new AccountSource 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 + +### GetId + +`func (o *AccountSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccountSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountSource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *AccountSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountSource) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountStatusChanged.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountStatusChanged.md new file mode 100644 index 000000000..4519a00a4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountStatusChanged.md @@ -0,0 +1,168 @@ +--- +id: v2025-account-status-changed +title: AccountStatusChanged +pagination_label: AccountStatusChanged +sidebar_label: AccountStatusChanged +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountStatusChanged', 'V2025AccountStatusChanged'] +slug: /tools/sdk/go/v2025/models/account-status-changed +tags: ['SDK', 'Software Development Kit', 'AccountStatusChanged', 'V2025AccountStatusChanged'] +--- + +# AccountStatusChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EventType** | Pointer to **string** | the event type | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] +**Account** | Pointer to [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] +**StatusChange** | Pointer to [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional] + +## Methods + +### NewAccountStatusChanged + +`func NewAccountStatusChanged() *AccountStatusChanged` + +NewAccountStatusChanged instantiates a new AccountStatusChanged 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 + +### NewAccountStatusChangedWithDefaults + +`func NewAccountStatusChangedWithDefaults() *AccountStatusChanged` + +NewAccountStatusChangedWithDefaults instantiates a new AccountStatusChanged 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 + +### GetEventType + +`func (o *AccountStatusChanged) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AccountStatusChanged) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AccountStatusChanged) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AccountStatusChanged) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *AccountStatusChanged) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AccountStatusChanged) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AccountStatusChanged) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AccountStatusChanged) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetDt + +`func (o *AccountStatusChanged) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *AccountStatusChanged) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *AccountStatusChanged) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *AccountStatusChanged) HasDt() bool` + +HasDt returns a boolean if a field has been set. + +### GetAccount + +`func (o *AccountStatusChanged) GetAccount() AccountStatusChangedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *AccountStatusChanged) GetAccountOk() (*AccountStatusChangedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *AccountStatusChanged) SetAccount(v AccountStatusChangedAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *AccountStatusChanged) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### GetStatusChange + +`func (o *AccountStatusChanged) GetStatusChange() AccountStatusChangedStatusChange` + +GetStatusChange returns the StatusChange field if non-nil, zero value otherwise. + +### GetStatusChangeOk + +`func (o *AccountStatusChanged) GetStatusChangeOk() (*AccountStatusChangedStatusChange, bool)` + +GetStatusChangeOk returns a tuple with the StatusChange field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusChange + +`func (o *AccountStatusChanged) SetStatusChange(v AccountStatusChangedStatusChange)` + +SetStatusChange sets StatusChange field to given value. + +### HasStatusChange + +`func (o *AccountStatusChanged) HasStatusChange() bool` + +HasStatusChange returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountStatusChangedAccount.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountStatusChangedAccount.md new file mode 100644 index 000000000..8d3b91e18 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountStatusChangedAccount.md @@ -0,0 +1,220 @@ +--- +id: v2025-account-status-changed-account +title: AccountStatusChangedAccount +pagination_label: AccountStatusChangedAccount +sidebar_label: AccountStatusChangedAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountStatusChangedAccount', 'V2025AccountStatusChangedAccount'] +slug: /tools/sdk/go/v2025/models/account-status-changed-account +tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedAccount', 'V2025AccountStatusChangedAccount'] +--- + +# AccountStatusChangedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the ID of the account in the database | [optional] +**NativeIdentity** | Pointer to **string** | the native identifier of the account | [optional] +**DisplayName** | Pointer to **string** | the display name of the account | [optional] +**SourceId** | Pointer to **string** | the ID of the source for this account | [optional] +**SourceName** | Pointer to **string** | the name of the source for this account | [optional] +**EntitlementCount** | Pointer to **int32** | the number of entitlements on this account | [optional] +**AccessType** | Pointer to **string** | this value is always \"account\" | [optional] + +## Methods + +### NewAccountStatusChangedAccount + +`func NewAccountStatusChangedAccount() *AccountStatusChangedAccount` + +NewAccountStatusChangedAccount instantiates a new AccountStatusChangedAccount 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 + +### NewAccountStatusChangedAccountWithDefaults + +`func NewAccountStatusChangedAccountWithDefaults() *AccountStatusChangedAccount` + +NewAccountStatusChangedAccountWithDefaults instantiates a new AccountStatusChangedAccount 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 + +### GetId + +`func (o *AccountStatusChangedAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountStatusChangedAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountStatusChangedAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountStatusChangedAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *AccountStatusChangedAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountStatusChangedAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountStatusChangedAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccountStatusChangedAccount) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccountStatusChangedAccount) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccountStatusChangedAccount) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccountStatusChangedAccount) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccountStatusChangedAccount) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AccountStatusChangedAccount) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccountStatusChangedAccount) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccountStatusChangedAccount) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccountStatusChangedAccount) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceName + +`func (o *AccountStatusChangedAccount) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccountStatusChangedAccount) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccountStatusChangedAccount) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *AccountStatusChangedAccount) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccountStatusChangedAccount) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccountStatusChangedAccount) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccountStatusChangedAccount) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccountStatusChangedAccount) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetAccessType + +`func (o *AccountStatusChangedAccount) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *AccountStatusChangedAccount) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *AccountStatusChangedAccount) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *AccountStatusChangedAccount) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountStatusChangedStatusChange.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountStatusChangedStatusChange.md new file mode 100644 index 000000000..8a896b314 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountStatusChangedStatusChange.md @@ -0,0 +1,90 @@ +--- +id: v2025-account-status-changed-status-change +title: AccountStatusChangedStatusChange +pagination_label: AccountStatusChangedStatusChange +sidebar_label: AccountStatusChangedStatusChange +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountStatusChangedStatusChange', 'V2025AccountStatusChangedStatusChange'] +slug: /tools/sdk/go/v2025/models/account-status-changed-status-change +tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedStatusChange', 'V2025AccountStatusChangedStatusChange'] +--- + +# AccountStatusChangedStatusChange + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PreviousStatus** | Pointer to **string** | the previous status of the account | [optional] +**NewStatus** | Pointer to **string** | the new status of the account | [optional] + +## Methods + +### NewAccountStatusChangedStatusChange + +`func NewAccountStatusChangedStatusChange() *AccountStatusChangedStatusChange` + +NewAccountStatusChangedStatusChange instantiates a new AccountStatusChangedStatusChange 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 + +### NewAccountStatusChangedStatusChangeWithDefaults + +`func NewAccountStatusChangedStatusChangeWithDefaults() *AccountStatusChangedStatusChange` + +NewAccountStatusChangedStatusChangeWithDefaults instantiates a new AccountStatusChangedStatusChange 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 + +### GetPreviousStatus + +`func (o *AccountStatusChangedStatusChange) GetPreviousStatus() string` + +GetPreviousStatus returns the PreviousStatus field if non-nil, zero value otherwise. + +### GetPreviousStatusOk + +`func (o *AccountStatusChangedStatusChange) GetPreviousStatusOk() (*string, bool)` + +GetPreviousStatusOk returns a tuple with the PreviousStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousStatus + +`func (o *AccountStatusChangedStatusChange) SetPreviousStatus(v string)` + +SetPreviousStatus sets PreviousStatus field to given value. + +### HasPreviousStatus + +`func (o *AccountStatusChangedStatusChange) HasPreviousStatus() bool` + +HasPreviousStatus returns a boolean if a field has been set. + +### GetNewStatus + +`func (o *AccountStatusChangedStatusChange) GetNewStatus() string` + +GetNewStatus returns the NewStatus field if non-nil, zero value otherwise. + +### GetNewStatusOk + +`func (o *AccountStatusChangedStatusChange) GetNewStatusOk() (*string, bool)` + +GetNewStatusOk returns a tuple with the NewStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewStatus + +`func (o *AccountStatusChangedStatusChange) SetNewStatus(v string)` + +SetNewStatus sets NewStatus field to given value. + +### HasNewStatus + +`func (o *AccountStatusChangedStatusChange) HasNewStatus() bool` + +HasNewStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountToggleRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountToggleRequest.md new file mode 100644 index 000000000..78fb6220f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountToggleRequest.md @@ -0,0 +1,90 @@ +--- +id: v2025-account-toggle-request +title: AccountToggleRequest +pagination_label: AccountToggleRequest +sidebar_label: AccountToggleRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountToggleRequest', 'V2025AccountToggleRequest'] +slug: /tools/sdk/go/v2025/models/account-toggle-request +tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'V2025AccountToggleRequest'] +--- + +# AccountToggleRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExternalVerificationId** | Pointer to **string** | If set, an external process validates that the user wants to proceed with this request. | [optional] +**ForceProvisioning** | Pointer to **bool** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing 'true' for an unlocked account will add and process 'Unlock' operation by the workflow. | [optional] + +## Methods + +### NewAccountToggleRequest + +`func NewAccountToggleRequest() *AccountToggleRequest` + +NewAccountToggleRequest instantiates a new AccountToggleRequest 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 + +### NewAccountToggleRequestWithDefaults + +`func NewAccountToggleRequestWithDefaults() *AccountToggleRequest` + +NewAccountToggleRequestWithDefaults instantiates a new AccountToggleRequest 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 + +### GetExternalVerificationId + +`func (o *AccountToggleRequest) GetExternalVerificationId() string` + +GetExternalVerificationId returns the ExternalVerificationId field if non-nil, zero value otherwise. + +### GetExternalVerificationIdOk + +`func (o *AccountToggleRequest) GetExternalVerificationIdOk() (*string, bool)` + +GetExternalVerificationIdOk returns a tuple with the ExternalVerificationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExternalVerificationId + +`func (o *AccountToggleRequest) SetExternalVerificationId(v string)` + +SetExternalVerificationId sets ExternalVerificationId field to given value. + +### HasExternalVerificationId + +`func (o *AccountToggleRequest) HasExternalVerificationId() bool` + +HasExternalVerificationId returns a boolean if a field has been set. + +### GetForceProvisioning + +`func (o *AccountToggleRequest) GetForceProvisioning() bool` + +GetForceProvisioning returns the ForceProvisioning field if non-nil, zero value otherwise. + +### GetForceProvisioningOk + +`func (o *AccountToggleRequest) GetForceProvisioningOk() (*bool, bool)` + +GetForceProvisioningOk returns a tuple with the ForceProvisioning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForceProvisioning + +`func (o *AccountToggleRequest) SetForceProvisioning(v bool)` + +SetForceProvisioning sets ForceProvisioning field to given value. + +### HasForceProvisioning + +`func (o *AccountToggleRequest) HasForceProvisioning() bool` + +HasForceProvisioning returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountUncorrelated.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountUncorrelated.md new file mode 100644 index 000000000..9e3e600a6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountUncorrelated.md @@ -0,0 +1,127 @@ +--- +id: v2025-account-uncorrelated +title: AccountUncorrelated +pagination_label: AccountUncorrelated +sidebar_label: AccountUncorrelated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUncorrelated', 'V2025AccountUncorrelated'] +slug: /tools/sdk/go/v2025/models/account-uncorrelated +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelated', 'V2025AccountUncorrelated'] +--- + +# AccountUncorrelated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**AccountUncorrelatedIdentity**](account-uncorrelated-identity) | | +**Source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | +**Account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | +**EntitlementCount** | Pointer to **int32** | The number of entitlements associated with this account. | [optional] + +## Methods + +### NewAccountUncorrelated + +`func NewAccountUncorrelated(identity AccountUncorrelatedIdentity, source AccountUncorrelatedSource, account AccountUncorrelatedAccount, ) *AccountUncorrelated` + +NewAccountUncorrelated instantiates a new AccountUncorrelated 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 + +### NewAccountUncorrelatedWithDefaults + +`func NewAccountUncorrelatedWithDefaults() *AccountUncorrelated` + +NewAccountUncorrelatedWithDefaults instantiates a new AccountUncorrelated 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 + +### GetIdentity + +`func (o *AccountUncorrelated) GetIdentity() AccountUncorrelatedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *AccountUncorrelated) GetIdentityOk() (*AccountUncorrelatedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *AccountUncorrelated) SetIdentity(v AccountUncorrelatedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetSource + +`func (o *AccountUncorrelated) GetSource() AccountUncorrelatedSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountUncorrelated) GetSourceOk() (*AccountUncorrelatedSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountUncorrelated) SetSource(v AccountUncorrelatedSource)` + +SetSource sets Source field to given value. + + +### GetAccount + +`func (o *AccountUncorrelated) GetAccount() AccountUncorrelatedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *AccountUncorrelated) GetAccountOk() (*AccountUncorrelatedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *AccountUncorrelated) SetAccount(v AccountUncorrelatedAccount)` + +SetAccount sets Account field to given value. + + +### GetEntitlementCount + +`func (o *AccountUncorrelated) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccountUncorrelated) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccountUncorrelated) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccountUncorrelated) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountUncorrelatedAccount.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountUncorrelatedAccount.md new file mode 100644 index 000000000..1b232fda4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountUncorrelatedAccount.md @@ -0,0 +1,158 @@ +--- +id: v2025-account-uncorrelated-account +title: AccountUncorrelatedAccount +pagination_label: AccountUncorrelatedAccount +sidebar_label: AccountUncorrelatedAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUncorrelatedAccount', 'V2025AccountUncorrelatedAccount'] +slug: /tools/sdk/go/v2025/models/account-uncorrelated-account +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedAccount', 'V2025AccountUncorrelatedAccount'] +--- + +# AccountUncorrelatedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **map[string]interface{}** | Uncorrelated account's DTO type. | +**Id** | **string** | Uncorrelated account's ID. | +**Name** | **string** | Uncorrelated account's display name. | +**NativeIdentity** | **string** | Unique ID of the account on the source. | +**Uuid** | Pointer to **NullableString** | The source's unique identifier for the account. UUID is generated by the source system. | [optional] + +## Methods + +### NewAccountUncorrelatedAccount + +`func NewAccountUncorrelatedAccount(type_ map[string]interface{}, id string, name string, nativeIdentity string, ) *AccountUncorrelatedAccount` + +NewAccountUncorrelatedAccount instantiates a new AccountUncorrelatedAccount 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 + +### NewAccountUncorrelatedAccountWithDefaults + +`func NewAccountUncorrelatedAccountWithDefaults() *AccountUncorrelatedAccount` + +NewAccountUncorrelatedAccountWithDefaults instantiates a new AccountUncorrelatedAccount 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 + +### GetType + +`func (o *AccountUncorrelatedAccount) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountUncorrelatedAccount) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountUncorrelatedAccount) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountUncorrelatedAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountUncorrelatedAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountUncorrelatedAccount) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountUncorrelatedAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountUncorrelatedAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountUncorrelatedAccount) SetName(v string)` + +SetName sets Name field to given value. + + +### GetNativeIdentity + +`func (o *AccountUncorrelatedAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountUncorrelatedAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountUncorrelatedAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + + +### GetUuid + +`func (o *AccountUncorrelatedAccount) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *AccountUncorrelatedAccount) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *AccountUncorrelatedAccount) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *AccountUncorrelatedAccount) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *AccountUncorrelatedAccount) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *AccountUncorrelatedAccount) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountUncorrelatedIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountUncorrelatedIdentity.md new file mode 100644 index 000000000..47490d362 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountUncorrelatedIdentity.md @@ -0,0 +1,101 @@ +--- +id: v2025-account-uncorrelated-identity +title: AccountUncorrelatedIdentity +pagination_label: AccountUncorrelatedIdentity +sidebar_label: AccountUncorrelatedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUncorrelatedIdentity', 'V2025AccountUncorrelatedIdentity'] +slug: /tools/sdk/go/v2025/models/account-uncorrelated-identity +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedIdentity', 'V2025AccountUncorrelatedIdentity'] +--- + +# AccountUncorrelatedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of the identity the account is uncorrelated with. | +**Id** | **string** | ID of the identity the account is uncorrelated with. | +**Name** | **string** | Display name of the identity the account is uncorrelated with. | + +## Methods + +### NewAccountUncorrelatedIdentity + +`func NewAccountUncorrelatedIdentity(type_ string, id string, name string, ) *AccountUncorrelatedIdentity` + +NewAccountUncorrelatedIdentity instantiates a new AccountUncorrelatedIdentity 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 + +### NewAccountUncorrelatedIdentityWithDefaults + +`func NewAccountUncorrelatedIdentityWithDefaults() *AccountUncorrelatedIdentity` + +NewAccountUncorrelatedIdentityWithDefaults instantiates a new AccountUncorrelatedIdentity 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 + +### GetType + +`func (o *AccountUncorrelatedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountUncorrelatedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountUncorrelatedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountUncorrelatedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountUncorrelatedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountUncorrelatedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountUncorrelatedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountUncorrelatedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountUncorrelatedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountUncorrelatedSource.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountUncorrelatedSource.md new file mode 100644 index 000000000..31a70ac98 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountUncorrelatedSource.md @@ -0,0 +1,101 @@ +--- +id: v2025-account-uncorrelated-source +title: AccountUncorrelatedSource +pagination_label: AccountUncorrelatedSource +sidebar_label: AccountUncorrelatedSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUncorrelatedSource', 'V2025AccountUncorrelatedSource'] +slug: /tools/sdk/go/v2025/models/account-uncorrelated-source +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedSource', 'V2025AccountUncorrelatedSource'] +--- + +# AccountUncorrelatedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The DTO type of the source the accounts are uncorrelated from. | +**Id** | **string** | The ID of the source the accounts are uncorrelated from. | +**Name** | **string** | Display name of the source the accounts are uncorrelated from. | + +## Methods + +### NewAccountUncorrelatedSource + +`func NewAccountUncorrelatedSource(type_ string, id string, name string, ) *AccountUncorrelatedSource` + +NewAccountUncorrelatedSource instantiates a new AccountUncorrelatedSource 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 + +### NewAccountUncorrelatedSourceWithDefaults + +`func NewAccountUncorrelatedSourceWithDefaults() *AccountUncorrelatedSource` + +NewAccountUncorrelatedSourceWithDefaults instantiates a new AccountUncorrelatedSource 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 + +### GetType + +`func (o *AccountUncorrelatedSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountUncorrelatedSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountUncorrelatedSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccountUncorrelatedSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountUncorrelatedSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountUncorrelatedSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccountUncorrelatedSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountUncorrelatedSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountUncorrelatedSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountUnlockRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountUnlockRequest.md new file mode 100644 index 000000000..e5d5485ce --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountUnlockRequest.md @@ -0,0 +1,116 @@ +--- +id: v2025-account-unlock-request +title: AccountUnlockRequest +pagination_label: AccountUnlockRequest +sidebar_label: AccountUnlockRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUnlockRequest', 'V2025AccountUnlockRequest'] +slug: /tools/sdk/go/v2025/models/account-unlock-request +tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'V2025AccountUnlockRequest'] +--- + +# AccountUnlockRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExternalVerificationId** | Pointer to **string** | If set, an external process validates that the user wants to proceed with this request. | [optional] +**UnlockIDNAccount** | Pointer to **bool** | If set, the IDN account is unlocked after the workflow completes. | [optional] +**ForceProvisioning** | Pointer to **bool** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional] + +## Methods + +### NewAccountUnlockRequest + +`func NewAccountUnlockRequest() *AccountUnlockRequest` + +NewAccountUnlockRequest instantiates a new AccountUnlockRequest 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 + +### NewAccountUnlockRequestWithDefaults + +`func NewAccountUnlockRequestWithDefaults() *AccountUnlockRequest` + +NewAccountUnlockRequestWithDefaults instantiates a new AccountUnlockRequest 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 + +### GetExternalVerificationId + +`func (o *AccountUnlockRequest) GetExternalVerificationId() string` + +GetExternalVerificationId returns the ExternalVerificationId field if non-nil, zero value otherwise. + +### GetExternalVerificationIdOk + +`func (o *AccountUnlockRequest) GetExternalVerificationIdOk() (*string, bool)` + +GetExternalVerificationIdOk returns a tuple with the ExternalVerificationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExternalVerificationId + +`func (o *AccountUnlockRequest) SetExternalVerificationId(v string)` + +SetExternalVerificationId sets ExternalVerificationId field to given value. + +### HasExternalVerificationId + +`func (o *AccountUnlockRequest) HasExternalVerificationId() bool` + +HasExternalVerificationId returns a boolean if a field has been set. + +### GetUnlockIDNAccount + +`func (o *AccountUnlockRequest) GetUnlockIDNAccount() bool` + +GetUnlockIDNAccount returns the UnlockIDNAccount field if non-nil, zero value otherwise. + +### GetUnlockIDNAccountOk + +`func (o *AccountUnlockRequest) GetUnlockIDNAccountOk() (*bool, bool)` + +GetUnlockIDNAccountOk returns a tuple with the UnlockIDNAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnlockIDNAccount + +`func (o *AccountUnlockRequest) SetUnlockIDNAccount(v bool)` + +SetUnlockIDNAccount sets UnlockIDNAccount field to given value. + +### HasUnlockIDNAccount + +`func (o *AccountUnlockRequest) HasUnlockIDNAccount() bool` + +HasUnlockIDNAccount returns a boolean if a field has been set. + +### GetForceProvisioning + +`func (o *AccountUnlockRequest) GetForceProvisioning() bool` + +GetForceProvisioning returns the ForceProvisioning field if non-nil, zero value otherwise. + +### GetForceProvisioningOk + +`func (o *AccountUnlockRequest) GetForceProvisioningOk() (*bool, bool)` + +GetForceProvisioningOk returns a tuple with the ForceProvisioning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForceProvisioning + +`func (o *AccountUnlockRequest) SetForceProvisioning(v bool)` + +SetForceProvisioning sets ForceProvisioning field to given value. + +### HasForceProvisioning + +`func (o *AccountUnlockRequest) HasForceProvisioning() bool` + +HasForceProvisioning returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountUsage.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountUsage.md new file mode 100644 index 000000000..b32264d83 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountUsage.md @@ -0,0 +1,90 @@ +--- +id: v2025-account-usage +title: AccountUsage +pagination_label: AccountUsage +sidebar_label: AccountUsage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUsage', 'V2025AccountUsage'] +slug: /tools/sdk/go/v2025/models/account-usage +tags: ['SDK', 'Software Development Kit', 'AccountUsage', 'V2025AccountUsage'] +--- + +# AccountUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **string** | The first day of the month for which activity is aggregated. | [optional] +**Count** | Pointer to **int64** | The number of days within the month that the account was active in a source. | [optional] + +## Methods + +### NewAccountUsage + +`func NewAccountUsage() *AccountUsage` + +NewAccountUsage instantiates a new AccountUsage 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 + +### NewAccountUsageWithDefaults + +`func NewAccountUsageWithDefaults() *AccountUsage` + +NewAccountUsageWithDefaults instantiates a new AccountUsage 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 + +### GetDate + +`func (o *AccountUsage) GetDate() string` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *AccountUsage) GetDateOk() (*string, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *AccountUsage) SetDate(v string)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *AccountUsage) HasDate() bool` + +HasDate returns a boolean if a field has been set. + +### GetCount + +`func (o *AccountUsage) GetCount() int64` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *AccountUsage) GetCountOk() (*int64, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *AccountUsage) SetCount(v int64)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *AccountUsage) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountsAsyncResult.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountsAsyncResult.md new file mode 100644 index 000000000..70c0ee185 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountsAsyncResult.md @@ -0,0 +1,59 @@ +--- +id: v2025-accounts-async-result +title: AccountsAsyncResult +pagination_label: AccountsAsyncResult +sidebar_label: AccountsAsyncResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsAsyncResult', 'V2025AccountsAsyncResult'] +slug: /tools/sdk/go/v2025/models/accounts-async-result +tags: ['SDK', 'Software Development Kit', 'AccountsAsyncResult', 'V2025AccountsAsyncResult'] +--- + +# AccountsAsyncResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | id of the task | + +## Methods + +### NewAccountsAsyncResult + +`func NewAccountsAsyncResult(id string, ) *AccountsAsyncResult` + +NewAccountsAsyncResult instantiates a new AccountsAsyncResult 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 + +### NewAccountsAsyncResultWithDefaults + +`func NewAccountsAsyncResultWithDefaults() *AccountsAsyncResult` + +NewAccountsAsyncResultWithDefaults instantiates a new AccountsAsyncResult 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 + +### GetId + +`func (o *AccountsAsyncResult) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountsAsyncResult) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountsAsyncResult) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountsCollectedForAggregation.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountsCollectedForAggregation.md new file mode 100644 index 000000000..e28cae784 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountsCollectedForAggregation.md @@ -0,0 +1,205 @@ +--- +id: v2025-accounts-collected-for-aggregation +title: AccountsCollectedForAggregation +pagination_label: AccountsCollectedForAggregation +sidebar_label: AccountsCollectedForAggregation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsCollectedForAggregation', 'V2025AccountsCollectedForAggregation'] +slug: /tools/sdk/go/v2025/models/accounts-collected-for-aggregation +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregation', 'V2025AccountsCollectedForAggregation'] +--- + +# AccountsCollectedForAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**AccountsCollectedForAggregationSource**](accounts-collected-for-aggregation-source) | | +**Status** | **map[string]interface{}** | The overall status of the collection. | +**Started** | **SailPointTime** | The date and time when the account collection started. | +**Completed** | **SailPointTime** | The date and time when the account collection finished. | +**Errors** | **[]string** | A list of errors that occurred during the collection. | +**Warnings** | **[]string** | A list of warnings that occurred during the collection. | +**Stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | + +## Methods + +### NewAccountsCollectedForAggregation + +`func NewAccountsCollectedForAggregation(source AccountsCollectedForAggregationSource, status map[string]interface{}, started SailPointTime, completed SailPointTime, errors []string, warnings []string, stats AccountsCollectedForAggregationStats, ) *AccountsCollectedForAggregation` + +NewAccountsCollectedForAggregation instantiates a new AccountsCollectedForAggregation 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 + +### NewAccountsCollectedForAggregationWithDefaults + +`func NewAccountsCollectedForAggregationWithDefaults() *AccountsCollectedForAggregation` + +NewAccountsCollectedForAggregationWithDefaults instantiates a new AccountsCollectedForAggregation 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 + +### GetSource + +`func (o *AccountsCollectedForAggregation) GetSource() AccountsCollectedForAggregationSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountsCollectedForAggregation) GetSourceOk() (*AccountsCollectedForAggregationSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountsCollectedForAggregation) SetSource(v AccountsCollectedForAggregationSource)` + +SetSource sets Source field to given value. + + +### GetStatus + +`func (o *AccountsCollectedForAggregation) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountsCollectedForAggregation) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountsCollectedForAggregation) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + +### GetStarted + +`func (o *AccountsCollectedForAggregation) GetStarted() SailPointTime` + +GetStarted returns the Started field if non-nil, zero value otherwise. + +### GetStartedOk + +`func (o *AccountsCollectedForAggregation) GetStartedOk() (*SailPointTime, bool)` + +GetStartedOk returns a tuple with the Started field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStarted + +`func (o *AccountsCollectedForAggregation) SetStarted(v SailPointTime)` + +SetStarted sets Started field to given value. + + +### GetCompleted + +`func (o *AccountsCollectedForAggregation) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *AccountsCollectedForAggregation) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *AccountsCollectedForAggregation) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + + +### GetErrors + +`func (o *AccountsCollectedForAggregation) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountsCollectedForAggregation) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountsCollectedForAggregation) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + + +### SetErrorsNil + +`func (o *AccountsCollectedForAggregation) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *AccountsCollectedForAggregation) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *AccountsCollectedForAggregation) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *AccountsCollectedForAggregation) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *AccountsCollectedForAggregation) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + + +### SetWarningsNil + +`func (o *AccountsCollectedForAggregation) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *AccountsCollectedForAggregation) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetStats + +`func (o *AccountsCollectedForAggregation) GetStats() AccountsCollectedForAggregationStats` + +GetStats returns the Stats field if non-nil, zero value otherwise. + +### GetStatsOk + +`func (o *AccountsCollectedForAggregation) GetStatsOk() (*AccountsCollectedForAggregationStats, bool)` + +GetStatsOk returns a tuple with the Stats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStats + +`func (o *AccountsCollectedForAggregation) SetStats(v AccountsCollectedForAggregationStats)` + +SetStats sets Stats field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountsCollectedForAggregationSource.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountsCollectedForAggregationSource.md new file mode 100644 index 000000000..52420be49 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountsCollectedForAggregationSource.md @@ -0,0 +1,101 @@ +--- +id: v2025-accounts-collected-for-aggregation-source +title: AccountsCollectedForAggregationSource +pagination_label: AccountsCollectedForAggregationSource +sidebar_label: AccountsCollectedForAggregationSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsCollectedForAggregationSource', 'V2025AccountsCollectedForAggregationSource'] +slug: /tools/sdk/go/v2025/models/accounts-collected-for-aggregation-source +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationSource', 'V2025AccountsCollectedForAggregationSource'] +--- + +# AccountsCollectedForAggregationSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the object to which this reference applies | +**Type** | **string** | The type of object that is referenced | +**Name** | **string** | Human-readable display name of the object to which this reference applies | + +## Methods + +### NewAccountsCollectedForAggregationSource + +`func NewAccountsCollectedForAggregationSource(id string, type_ string, name string, ) *AccountsCollectedForAggregationSource` + +NewAccountsCollectedForAggregationSource instantiates a new AccountsCollectedForAggregationSource 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 + +### NewAccountsCollectedForAggregationSourceWithDefaults + +`func NewAccountsCollectedForAggregationSourceWithDefaults() *AccountsCollectedForAggregationSource` + +NewAccountsCollectedForAggregationSourceWithDefaults instantiates a new AccountsCollectedForAggregationSource 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 + +### GetId + +`func (o *AccountsCollectedForAggregationSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountsCollectedForAggregationSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountsCollectedForAggregationSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *AccountsCollectedForAggregationSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountsCollectedForAggregationSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountsCollectedForAggregationSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetName + +`func (o *AccountsCollectedForAggregationSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountsCollectedForAggregationSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountsCollectedForAggregationSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountsCollectedForAggregationStats.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountsCollectedForAggregationStats.md new file mode 100644 index 000000000..258cf7eb8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountsCollectedForAggregationStats.md @@ -0,0 +1,143 @@ +--- +id: v2025-accounts-collected-for-aggregation-stats +title: AccountsCollectedForAggregationStats +pagination_label: AccountsCollectedForAggregationStats +sidebar_label: AccountsCollectedForAggregationStats +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsCollectedForAggregationStats', 'V2025AccountsCollectedForAggregationStats'] +slug: /tools/sdk/go/v2025/models/accounts-collected-for-aggregation-stats +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationStats', 'V2025AccountsCollectedForAggregationStats'] +--- + +# AccountsCollectedForAggregationStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scanned** | **int32** | The number of accounts which were scanned / iterated over. | +**Unchanged** | **int32** | The number of accounts which existed before, but had no changes. | +**Changed** | **int32** | The number of accounts which existed before, but had changes. | +**Added** | **int32** | The number of accounts which are new - have not existed before. | +**Removed** | **int32** | The number accounts which existed before, but no longer exist (thus getting removed). | + +## Methods + +### NewAccountsCollectedForAggregationStats + +`func NewAccountsCollectedForAggregationStats(scanned int32, unchanged int32, changed int32, added int32, removed int32, ) *AccountsCollectedForAggregationStats` + +NewAccountsCollectedForAggregationStats instantiates a new AccountsCollectedForAggregationStats 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 + +### NewAccountsCollectedForAggregationStatsWithDefaults + +`func NewAccountsCollectedForAggregationStatsWithDefaults() *AccountsCollectedForAggregationStats` + +NewAccountsCollectedForAggregationStatsWithDefaults instantiates a new AccountsCollectedForAggregationStats 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 + +### GetScanned + +`func (o *AccountsCollectedForAggregationStats) GetScanned() int32` + +GetScanned returns the Scanned field if non-nil, zero value otherwise. + +### GetScannedOk + +`func (o *AccountsCollectedForAggregationStats) GetScannedOk() (*int32, bool)` + +GetScannedOk returns a tuple with the Scanned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScanned + +`func (o *AccountsCollectedForAggregationStats) SetScanned(v int32)` + +SetScanned sets Scanned field to given value. + + +### GetUnchanged + +`func (o *AccountsCollectedForAggregationStats) GetUnchanged() int32` + +GetUnchanged returns the Unchanged field if non-nil, zero value otherwise. + +### GetUnchangedOk + +`func (o *AccountsCollectedForAggregationStats) GetUnchangedOk() (*int32, bool)` + +GetUnchangedOk returns a tuple with the Unchanged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnchanged + +`func (o *AccountsCollectedForAggregationStats) SetUnchanged(v int32)` + +SetUnchanged sets Unchanged field to given value. + + +### GetChanged + +`func (o *AccountsCollectedForAggregationStats) GetChanged() int32` + +GetChanged returns the Changed field if non-nil, zero value otherwise. + +### GetChangedOk + +`func (o *AccountsCollectedForAggregationStats) GetChangedOk() (*int32, bool)` + +GetChangedOk returns a tuple with the Changed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanged + +`func (o *AccountsCollectedForAggregationStats) SetChanged(v int32)` + +SetChanged sets Changed field to given value. + + +### GetAdded + +`func (o *AccountsCollectedForAggregationStats) GetAdded() int32` + +GetAdded returns the Added field if non-nil, zero value otherwise. + +### GetAddedOk + +`func (o *AccountsCollectedForAggregationStats) GetAddedOk() (*int32, bool)` + +GetAddedOk returns a tuple with the Added field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAdded + +`func (o *AccountsCollectedForAggregationStats) SetAdded(v int32)` + +SetAdded sets Added field to given value. + + +### GetRemoved + +`func (o *AccountsCollectedForAggregationStats) GetRemoved() int32` + +GetRemoved returns the Removed field if non-nil, zero value otherwise. + +### GetRemovedOk + +`func (o *AccountsCollectedForAggregationStats) GetRemovedOk() (*int32, bool)` + +GetRemovedOk returns a tuple with the Removed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoved + +`func (o *AccountsCollectedForAggregationStats) SetRemoved(v int32)` + +SetRemoved sets Removed field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountsExportReportArguments.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountsExportReportArguments.md new file mode 100644 index 000000000..b5854ebae --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountsExportReportArguments.md @@ -0,0 +1,80 @@ +--- +id: v2025-accounts-export-report-arguments +title: AccountsExportReportArguments +pagination_label: AccountsExportReportArguments +sidebar_label: AccountsExportReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsExportReportArguments', 'V2025AccountsExportReportArguments'] +slug: /tools/sdk/go/v2025/models/accounts-export-report-arguments +tags: ['SDK', 'Software Development Kit', 'AccountsExportReportArguments', 'V2025AccountsExportReportArguments'] +--- + +# AccountsExportReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Application** | **string** | Source ID. | +**SourceName** | **string** | Source name. | + +## Methods + +### NewAccountsExportReportArguments + +`func NewAccountsExportReportArguments(application string, sourceName string, ) *AccountsExportReportArguments` + +NewAccountsExportReportArguments instantiates a new AccountsExportReportArguments 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 + +### NewAccountsExportReportArgumentsWithDefaults + +`func NewAccountsExportReportArgumentsWithDefaults() *AccountsExportReportArguments` + +NewAccountsExportReportArgumentsWithDefaults instantiates a new AccountsExportReportArguments 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 + +### GetApplication + +`func (o *AccountsExportReportArguments) GetApplication() string` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *AccountsExportReportArguments) GetApplicationOk() (*string, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *AccountsExportReportArguments) SetApplication(v string)` + +SetApplication sets Application field to given value. + + +### GetSourceName + +`func (o *AccountsExportReportArguments) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccountsExportReportArguments) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccountsExportReportArguments) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountsSelectionRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountsSelectionRequest.md new file mode 100644 index 000000000..cdf3980c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountsSelectionRequest.md @@ -0,0 +1,142 @@ +--- +id: v2025-accounts-selection-request +title: AccountsSelectionRequest +pagination_label: AccountsSelectionRequest +sidebar_label: AccountsSelectionRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsSelectionRequest', 'V2025AccountsSelectionRequest'] +slug: /tools/sdk/go/v2025/models/accounts-selection-request +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionRequest', 'V2025AccountsSelectionRequest'] +--- + +# AccountsSelectionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedFor** | **[]string** | A list of Identity IDs for whom the Access is requested. | +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**RequestedItems** | [**[]AccessRequestItem1**](access-request-item1) | | +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] + +## Methods + +### NewAccountsSelectionRequest + +`func NewAccountsSelectionRequest(requestedFor []string, requestedItems []AccessRequestItem1, ) *AccountsSelectionRequest` + +NewAccountsSelectionRequest instantiates a new AccountsSelectionRequest 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 + +### NewAccountsSelectionRequestWithDefaults + +`func NewAccountsSelectionRequestWithDefaults() *AccountsSelectionRequest` + +NewAccountsSelectionRequestWithDefaults instantiates a new AccountsSelectionRequest 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 + +### GetRequestedFor + +`func (o *AccountsSelectionRequest) GetRequestedFor() []string` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccountsSelectionRequest) GetRequestedForOk() (*[]string, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccountsSelectionRequest) SetRequestedFor(v []string)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestType + +`func (o *AccountsSelectionRequest) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *AccountsSelectionRequest) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *AccountsSelectionRequest) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *AccountsSelectionRequest) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *AccountsSelectionRequest) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *AccountsSelectionRequest) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetRequestedItems + +`func (o *AccountsSelectionRequest) GetRequestedItems() []AccessRequestItem1` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *AccountsSelectionRequest) GetRequestedItemsOk() (*[]AccessRequestItem1, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *AccountsSelectionRequest) SetRequestedItems(v []AccessRequestItem1)` + +SetRequestedItems sets RequestedItems field to given value. + + +### GetClientMetadata + +`func (o *AccountsSelectionRequest) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccountsSelectionRequest) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccountsSelectionRequest) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccountsSelectionRequest) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AccountsSelectionResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/AccountsSelectionResponse.md new file mode 100644 index 000000000..afc72f8cf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AccountsSelectionResponse.md @@ -0,0 +1,64 @@ +--- +id: v2025-accounts-selection-response +title: AccountsSelectionResponse +pagination_label: AccountsSelectionResponse +sidebar_label: AccountsSelectionResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsSelectionResponse', 'V2025AccountsSelectionResponse'] +slug: /tools/sdk/go/v2025/models/accounts-selection-response +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionResponse', 'V2025AccountsSelectionResponse'] +--- + +# AccountsSelectionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identities** | Pointer to [**[]IdentityAccountSelections**](identity-account-selections) | A list of available account selections per identity in the request, for all the requested items | [optional] + +## Methods + +### NewAccountsSelectionResponse + +`func NewAccountsSelectionResponse() *AccountsSelectionResponse` + +NewAccountsSelectionResponse instantiates a new AccountsSelectionResponse 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 + +### NewAccountsSelectionResponseWithDefaults + +`func NewAccountsSelectionResponseWithDefaults() *AccountsSelectionResponse` + +NewAccountsSelectionResponseWithDefaults instantiates a new AccountsSelectionResponse 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 + +### GetIdentities + +`func (o *AccountsSelectionResponse) GetIdentities() []IdentityAccountSelections` + +GetIdentities returns the Identities field if non-nil, zero value otherwise. + +### GetIdentitiesOk + +`func (o *AccountsSelectionResponse) GetIdentitiesOk() (*[]IdentityAccountSelections, bool)` + +GetIdentitiesOk returns a tuple with the Identities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentities + +`func (o *AccountsSelectionResponse) SetIdentities(v []IdentityAccountSelections)` + +SetIdentities sets Identities field to given value. + +### HasIdentities + +`func (o *AccountsSelectionResponse) HasIdentities() bool` + +HasIdentities returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ActivateCampaignOptions.md b/docs/tools/sdk/go/Reference/V2025/Models/ActivateCampaignOptions.md new file mode 100644 index 000000000..906e96a0c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ActivateCampaignOptions.md @@ -0,0 +1,64 @@ +--- +id: v2025-activate-campaign-options +title: ActivateCampaignOptions +pagination_label: ActivateCampaignOptions +sidebar_label: ActivateCampaignOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ActivateCampaignOptions', 'V2025ActivateCampaignOptions'] +slug: /tools/sdk/go/v2025/models/activate-campaign-options +tags: ['SDK', 'Software Development Kit', 'ActivateCampaignOptions', 'V2025ActivateCampaignOptions'] +--- + +# ActivateCampaignOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TimeZone** | Pointer to **string** | The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. | [optional] [default to "Z"] + +## Methods + +### NewActivateCampaignOptions + +`func NewActivateCampaignOptions() *ActivateCampaignOptions` + +NewActivateCampaignOptions instantiates a new ActivateCampaignOptions 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 + +### NewActivateCampaignOptionsWithDefaults + +`func NewActivateCampaignOptionsWithDefaults() *ActivateCampaignOptions` + +NewActivateCampaignOptionsWithDefaults instantiates a new ActivateCampaignOptions 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 + +### GetTimeZone + +`func (o *ActivateCampaignOptions) GetTimeZone() string` + +GetTimeZone returns the TimeZone field if non-nil, zero value otherwise. + +### GetTimeZoneOk + +`func (o *ActivateCampaignOptions) GetTimeZoneOk() (*string, bool)` + +GetTimeZoneOk returns a tuple with the TimeZone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZone + +`func (o *ActivateCampaignOptions) SetTimeZone(v string)` + +SetTimeZone sets TimeZone field to given value. + +### HasTimeZone + +`func (o *ActivateCampaignOptions) HasTimeZone() bool` + +HasTimeZone returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ActivityIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/ActivityIdentity.md new file mode 100644 index 000000000..c34bd41ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ActivityIdentity.md @@ -0,0 +1,116 @@ +--- +id: v2025-activity-identity +title: ActivityIdentity +pagination_label: ActivityIdentity +sidebar_label: ActivityIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ActivityIdentity', 'V2025ActivityIdentity'] +slug: /tools/sdk/go/v2025/models/activity-identity +tags: ['SDK', 'Software Development Kit', 'ActivityIdentity', 'V2025ActivityIdentity'] +--- + +# ActivityIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**Type** | Pointer to **string** | Type of object | [optional] + +## Methods + +### NewActivityIdentity + +`func NewActivityIdentity() *ActivityIdentity` + +NewActivityIdentity instantiates a new ActivityIdentity 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 + +### NewActivityIdentityWithDefaults + +`func NewActivityIdentityWithDefaults() *ActivityIdentity` + +NewActivityIdentityWithDefaults instantiates a new ActivityIdentity 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 + +### GetId + +`func (o *ActivityIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ActivityIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ActivityIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ActivityIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ActivityIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ActivityIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ActivityIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ActivityIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *ActivityIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ActivityIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ActivityIdentity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ActivityIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ActivityInsights.md b/docs/tools/sdk/go/Reference/V2025/Models/ActivityInsights.md new file mode 100644 index 000000000..abba5e60c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ActivityInsights.md @@ -0,0 +1,116 @@ +--- +id: v2025-activity-insights +title: ActivityInsights +pagination_label: ActivityInsights +sidebar_label: ActivityInsights +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ActivityInsights', 'V2025ActivityInsights'] +slug: /tools/sdk/go/v2025/models/activity-insights +tags: ['SDK', 'Software Development Kit', 'ActivityInsights', 'V2025ActivityInsights'] +--- + +# ActivityInsights + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountID** | Pointer to **string** | UUID of the account | [optional] +**UsageDays** | Pointer to **int32** | The number of days of activity | [optional] +**UsageDaysState** | Pointer to **string** | Status indicating if the activity is complete or unknown | [optional] + +## Methods + +### NewActivityInsights + +`func NewActivityInsights() *ActivityInsights` + +NewActivityInsights instantiates a new ActivityInsights 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 + +### NewActivityInsightsWithDefaults + +`func NewActivityInsightsWithDefaults() *ActivityInsights` + +NewActivityInsightsWithDefaults instantiates a new ActivityInsights 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 + +### GetAccountID + +`func (o *ActivityInsights) GetAccountID() string` + +GetAccountID returns the AccountID field if non-nil, zero value otherwise. + +### GetAccountIDOk + +`func (o *ActivityInsights) GetAccountIDOk() (*string, bool)` + +GetAccountIDOk returns a tuple with the AccountID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountID + +`func (o *ActivityInsights) SetAccountID(v string)` + +SetAccountID sets AccountID field to given value. + +### HasAccountID + +`func (o *ActivityInsights) HasAccountID() bool` + +HasAccountID returns a boolean if a field has been set. + +### GetUsageDays + +`func (o *ActivityInsights) GetUsageDays() int32` + +GetUsageDays returns the UsageDays field if non-nil, zero value otherwise. + +### GetUsageDaysOk + +`func (o *ActivityInsights) GetUsageDaysOk() (*int32, bool)` + +GetUsageDaysOk returns a tuple with the UsageDays field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsageDays + +`func (o *ActivityInsights) SetUsageDays(v int32)` + +SetUsageDays sets UsageDays field to given value. + +### HasUsageDays + +`func (o *ActivityInsights) HasUsageDays() bool` + +HasUsageDays returns a boolean if a field has been set. + +### GetUsageDaysState + +`func (o *ActivityInsights) GetUsageDaysState() string` + +GetUsageDaysState returns the UsageDaysState field if non-nil, zero value otherwise. + +### GetUsageDaysStateOk + +`func (o *ActivityInsights) GetUsageDaysStateOk() (*string, bool)` + +GetUsageDaysStateOk returns a tuple with the UsageDaysState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsageDaysState + +`func (o *ActivityInsights) SetUsageDaysState(v string)` + +SetUsageDaysState sets UsageDaysState field to given value. + +### HasUsageDaysState + +`func (o *ActivityInsights) HasUsageDaysState() bool` + +HasUsageDaysState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AdminReviewReassign.md b/docs/tools/sdk/go/Reference/V2025/Models/AdminReviewReassign.md new file mode 100644 index 000000000..a69abd48b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AdminReviewReassign.md @@ -0,0 +1,116 @@ +--- +id: v2025-admin-review-reassign +title: AdminReviewReassign +pagination_label: AdminReviewReassign +sidebar_label: AdminReviewReassign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AdminReviewReassign', 'V2025AdminReviewReassign'] +slug: /tools/sdk/go/v2025/models/admin-review-reassign +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassign', 'V2025AdminReviewReassign'] +--- + +# AdminReviewReassign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CertificationIds** | Pointer to **[]string** | List of certification IDs to reassign | [optional] +**ReassignTo** | Pointer to [**AdminReviewReassignReassignTo**](admin-review-reassign-reassign-to) | | [optional] +**Reason** | Pointer to **string** | Comment to explain why the certification was reassigned | [optional] + +## Methods + +### NewAdminReviewReassign + +`func NewAdminReviewReassign() *AdminReviewReassign` + +NewAdminReviewReassign instantiates a new AdminReviewReassign 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 + +### NewAdminReviewReassignWithDefaults + +`func NewAdminReviewReassignWithDefaults() *AdminReviewReassign` + +NewAdminReviewReassignWithDefaults instantiates a new AdminReviewReassign 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 + +### GetCertificationIds + +`func (o *AdminReviewReassign) GetCertificationIds() []string` + +GetCertificationIds returns the CertificationIds field if non-nil, zero value otherwise. + +### GetCertificationIdsOk + +`func (o *AdminReviewReassign) GetCertificationIdsOk() (*[]string, bool)` + +GetCertificationIdsOk returns a tuple with the CertificationIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationIds + +`func (o *AdminReviewReassign) SetCertificationIds(v []string)` + +SetCertificationIds sets CertificationIds field to given value. + +### HasCertificationIds + +`func (o *AdminReviewReassign) HasCertificationIds() bool` + +HasCertificationIds returns a boolean if a field has been set. + +### GetReassignTo + +`func (o *AdminReviewReassign) GetReassignTo() AdminReviewReassignReassignTo` + +GetReassignTo returns the ReassignTo field if non-nil, zero value otherwise. + +### GetReassignToOk + +`func (o *AdminReviewReassign) GetReassignToOk() (*AdminReviewReassignReassignTo, bool)` + +GetReassignToOk returns a tuple with the ReassignTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignTo + +`func (o *AdminReviewReassign) SetReassignTo(v AdminReviewReassignReassignTo)` + +SetReassignTo sets ReassignTo field to given value. + +### HasReassignTo + +`func (o *AdminReviewReassign) HasReassignTo() bool` + +HasReassignTo returns a boolean if a field has been set. + +### GetReason + +`func (o *AdminReviewReassign) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *AdminReviewReassign) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *AdminReviewReassign) SetReason(v string)` + +SetReason sets Reason field to given value. + +### HasReason + +`func (o *AdminReviewReassign) HasReason() bool` + +HasReason returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AdminReviewReassignReassignTo.md b/docs/tools/sdk/go/Reference/V2025/Models/AdminReviewReassignReassignTo.md new file mode 100644 index 000000000..9910f4a84 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AdminReviewReassignReassignTo.md @@ -0,0 +1,90 @@ +--- +id: v2025-admin-review-reassign-reassign-to +title: AdminReviewReassignReassignTo +pagination_label: AdminReviewReassignReassignTo +sidebar_label: AdminReviewReassignReassignTo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AdminReviewReassignReassignTo', 'V2025AdminReviewReassignReassignTo'] +slug: /tools/sdk/go/v2025/models/admin-review-reassign-reassign-to +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassignReassignTo', 'V2025AdminReviewReassignReassignTo'] +--- + +# AdminReviewReassignReassignTo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity ID to which the review is being assigned. | [optional] +**Type** | Pointer to **string** | The type of the ID provided. | [optional] + +## Methods + +### NewAdminReviewReassignReassignTo + +`func NewAdminReviewReassignReassignTo() *AdminReviewReassignReassignTo` + +NewAdminReviewReassignReassignTo instantiates a new AdminReviewReassignReassignTo 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 + +### NewAdminReviewReassignReassignToWithDefaults + +`func NewAdminReviewReassignReassignToWithDefaults() *AdminReviewReassignReassignTo` + +NewAdminReviewReassignReassignToWithDefaults instantiates a new AdminReviewReassignReassignTo 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 + +### GetId + +`func (o *AdminReviewReassignReassignTo) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AdminReviewReassignReassignTo) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AdminReviewReassignReassignTo) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AdminReviewReassignReassignTo) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AdminReviewReassignReassignTo) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AdminReviewReassignReassignTo) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AdminReviewReassignReassignTo) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AdminReviewReassignReassignTo) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AggregationResult.md b/docs/tools/sdk/go/Reference/V2025/Models/AggregationResult.md new file mode 100644 index 000000000..9fac5b2e7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AggregationResult.md @@ -0,0 +1,90 @@ +--- +id: v2025-aggregation-result +title: AggregationResult +pagination_label: AggregationResult +sidebar_label: AggregationResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AggregationResult', 'V2025AggregationResult'] +slug: /tools/sdk/go/v2025/models/aggregation-result +tags: ['SDK', 'Software Development Kit', 'AggregationResult', 'V2025AggregationResult'] +--- + +# AggregationResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Aggregations** | Pointer to **map[string]interface{}** | The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. | [optional] +**Hits** | Pointer to **[]map[string]interface{}** | The results of the aggregation search query. | [optional] + +## Methods + +### NewAggregationResult + +`func NewAggregationResult() *AggregationResult` + +NewAggregationResult instantiates a new AggregationResult 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 + +### NewAggregationResultWithDefaults + +`func NewAggregationResultWithDefaults() *AggregationResult` + +NewAggregationResultWithDefaults instantiates a new AggregationResult 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 + +### GetAggregations + +`func (o *AggregationResult) GetAggregations() map[string]interface{}` + +GetAggregations returns the Aggregations field if non-nil, zero value otherwise. + +### GetAggregationsOk + +`func (o *AggregationResult) GetAggregationsOk() (*map[string]interface{}, bool)` + +GetAggregationsOk returns a tuple with the Aggregations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregations + +`func (o *AggregationResult) SetAggregations(v map[string]interface{})` + +SetAggregations sets Aggregations field to given value. + +### HasAggregations + +`func (o *AggregationResult) HasAggregations() bool` + +HasAggregations returns a boolean if a field has been set. + +### GetHits + +`func (o *AggregationResult) GetHits() []map[string]interface{}` + +GetHits returns the Hits field if non-nil, zero value otherwise. + +### GetHitsOk + +`func (o *AggregationResult) GetHitsOk() (*[]map[string]interface{}, bool)` + +GetHitsOk returns a tuple with the Hits field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHits + +`func (o *AggregationResult) SetHits(v []map[string]interface{})` + +SetHits sets Hits field to given value. + +### HasHits + +`func (o *AggregationResult) HasHits() bool` + +HasHits returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AggregationType.md b/docs/tools/sdk/go/Reference/V2025/Models/AggregationType.md new file mode 100644 index 000000000..f80bb3b68 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AggregationType.md @@ -0,0 +1,21 @@ +--- +id: v2025-aggregation-type +title: AggregationType +pagination_label: AggregationType +sidebar_label: AggregationType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AggregationType', 'V2025AggregationType'] +slug: /tools/sdk/go/v2025/models/aggregation-type +tags: ['SDK', 'Software Development Kit', 'AggregationType', 'V2025AggregationType'] +--- + +# AggregationType + +## Enum + + +* `DSL` (value: `"DSL"`) + +* `SAILPOINT` (value: `"SAILPOINT"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Aggregations.md b/docs/tools/sdk/go/Reference/V2025/Models/Aggregations.md new file mode 100644 index 000000000..1cc58a897 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Aggregations.md @@ -0,0 +1,142 @@ +--- +id: v2025-aggregations +title: Aggregations +pagination_label: Aggregations +sidebar_label: Aggregations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Aggregations', 'V2025Aggregations'] +slug: /tools/sdk/go/v2025/models/aggregations +tags: ['SDK', 'Software Development Kit', 'Aggregations', 'V2025Aggregations'] +--- + +# Aggregations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional] +**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional] +**Filter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional] +**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional] + +## Methods + +### NewAggregations + +`func NewAggregations() *Aggregations` + +NewAggregations instantiates a new Aggregations 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 + +### NewAggregationsWithDefaults + +`func NewAggregationsWithDefaults() *Aggregations` + +NewAggregationsWithDefaults instantiates a new Aggregations 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 + +### GetNested + +`func (o *Aggregations) GetNested() NestedAggregation` + +GetNested returns the Nested field if non-nil, zero value otherwise. + +### GetNestedOk + +`func (o *Aggregations) GetNestedOk() (*NestedAggregation, bool)` + +GetNestedOk returns a tuple with the Nested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNested + +`func (o *Aggregations) SetNested(v NestedAggregation)` + +SetNested sets Nested field to given value. + +### HasNested + +`func (o *Aggregations) HasNested() bool` + +HasNested returns a boolean if a field has been set. + +### GetMetric + +`func (o *Aggregations) GetMetric() MetricAggregation` + +GetMetric returns the Metric field if non-nil, zero value otherwise. + +### GetMetricOk + +`func (o *Aggregations) GetMetricOk() (*MetricAggregation, bool)` + +GetMetricOk returns a tuple with the Metric field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetric + +`func (o *Aggregations) SetMetric(v MetricAggregation)` + +SetMetric sets Metric field to given value. + +### HasMetric + +`func (o *Aggregations) HasMetric() bool` + +HasMetric returns a boolean if a field has been set. + +### GetFilter + +`func (o *Aggregations) GetFilter() FilterAggregation` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *Aggregations) GetFilterOk() (*FilterAggregation, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *Aggregations) SetFilter(v FilterAggregation)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *Aggregations) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### GetBucket + +`func (o *Aggregations) GetBucket() BucketAggregation` + +GetBucket returns the Bucket field if non-nil, zero value otherwise. + +### GetBucketOk + +`func (o *Aggregations) GetBucketOk() (*BucketAggregation, bool)` + +GetBucketOk returns a tuple with the Bucket field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBucket + +`func (o *Aggregations) SetBucket(v BucketAggregation)` + +SetBucket sets Bucket field to given value. + +### HasBucket + +`func (o *Aggregations) HasBucket() bool` + +HasBucket returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/App.md b/docs/tools/sdk/go/Reference/V2025/Models/App.md new file mode 100644 index 000000000..b202cfb94 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/App.md @@ -0,0 +1,142 @@ +--- +id: v2025-app +title: App +pagination_label: App +sidebar_label: App +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'App', 'V2025App'] +slug: /tools/sdk/go/v2025/models/app +tags: ['SDK', 'Software Development Kit', 'App', 'V2025App'] +--- + +# App + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**Source** | Pointer to [**Reference**](reference) | | [optional] +**Account** | Pointer to [**AppAllOfAccount**](app-all-of-account) | | [optional] + +## Methods + +### NewApp + +`func NewApp() *App` + +NewApp instantiates a new App 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 + +### NewAppWithDefaults + +`func NewAppWithDefaults() *App` + +NewAppWithDefaults instantiates a new App 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 + +### GetId + +`func (o *App) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *App) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *App) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *App) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *App) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *App) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *App) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *App) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSource + +`func (o *App) GetSource() Reference` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *App) GetSourceOk() (*Reference, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *App) SetSource(v Reference)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *App) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAccount + +`func (o *App) GetAccount() AppAllOfAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *App) GetAccountOk() (*AppAllOfAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *App) SetAccount(v AppAllOfAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *App) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AppAccountDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/AppAccountDetails.md new file mode 100644 index 000000000..0e76d3e2d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AppAccountDetails.md @@ -0,0 +1,116 @@ +--- +id: v2025-app-account-details +title: AppAccountDetails +pagination_label: AppAccountDetails +sidebar_label: AppAccountDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AppAccountDetails', 'V2025AppAccountDetails'] +slug: /tools/sdk/go/v2025/models/app-account-details +tags: ['SDK', 'Software Development Kit', 'AppAccountDetails', 'V2025AppAccountDetails'] +--- + +# AppAccountDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AppId** | Pointer to **string** | The source app ID | [optional] +**AppDisplayName** | Pointer to **string** | The source app display name | [optional] +**SourceAccount** | Pointer to [**AppAccountDetailsSourceAccount**](app-account-details-source-account) | | [optional] + +## Methods + +### NewAppAccountDetails + +`func NewAppAccountDetails() *AppAccountDetails` + +NewAppAccountDetails instantiates a new AppAccountDetails 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 + +### NewAppAccountDetailsWithDefaults + +`func NewAppAccountDetailsWithDefaults() *AppAccountDetails` + +NewAppAccountDetailsWithDefaults instantiates a new AppAccountDetails 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 + +### GetAppId + +`func (o *AppAccountDetails) GetAppId() string` + +GetAppId returns the AppId field if non-nil, zero value otherwise. + +### GetAppIdOk + +`func (o *AppAccountDetails) GetAppIdOk() (*string, bool)` + +GetAppIdOk returns a tuple with the AppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppId + +`func (o *AppAccountDetails) SetAppId(v string)` + +SetAppId sets AppId field to given value. + +### HasAppId + +`func (o *AppAccountDetails) HasAppId() bool` + +HasAppId returns a boolean if a field has been set. + +### GetAppDisplayName + +`func (o *AppAccountDetails) GetAppDisplayName() string` + +GetAppDisplayName returns the AppDisplayName field if non-nil, zero value otherwise. + +### GetAppDisplayNameOk + +`func (o *AppAccountDetails) GetAppDisplayNameOk() (*string, bool)` + +GetAppDisplayNameOk returns a tuple with the AppDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppDisplayName + +`func (o *AppAccountDetails) SetAppDisplayName(v string)` + +SetAppDisplayName sets AppDisplayName field to given value. + +### HasAppDisplayName + +`func (o *AppAccountDetails) HasAppDisplayName() bool` + +HasAppDisplayName returns a boolean if a field has been set. + +### GetSourceAccount + +`func (o *AppAccountDetails) GetSourceAccount() AppAccountDetailsSourceAccount` + +GetSourceAccount returns the SourceAccount field if non-nil, zero value otherwise. + +### GetSourceAccountOk + +`func (o *AppAccountDetails) GetSourceAccountOk() (*AppAccountDetailsSourceAccount, bool)` + +GetSourceAccountOk returns a tuple with the SourceAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceAccount + +`func (o *AppAccountDetails) SetSourceAccount(v AppAccountDetailsSourceAccount)` + +SetSourceAccount sets SourceAccount field to given value. + +### HasSourceAccount + +`func (o *AppAccountDetails) HasSourceAccount() bool` + +HasSourceAccount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AppAccountDetailsSourceAccount.md b/docs/tools/sdk/go/Reference/V2025/Models/AppAccountDetailsSourceAccount.md new file mode 100644 index 000000000..2372df358 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AppAccountDetailsSourceAccount.md @@ -0,0 +1,168 @@ +--- +id: v2025-app-account-details-source-account +title: AppAccountDetailsSourceAccount +pagination_label: AppAccountDetailsSourceAccount +sidebar_label: AppAccountDetailsSourceAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AppAccountDetailsSourceAccount', 'V2025AppAccountDetailsSourceAccount'] +slug: /tools/sdk/go/v2025/models/app-account-details-source-account +tags: ['SDK', 'Software Development Kit', 'AppAccountDetailsSourceAccount', 'V2025AppAccountDetailsSourceAccount'] +--- + +# AppAccountDetailsSourceAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The account ID | [optional] +**NativeIdentity** | Pointer to **string** | The native identity of account | [optional] +**DisplayName** | Pointer to **string** | The display name of account | [optional] +**SourceId** | Pointer to **string** | The source ID of account | [optional] +**SourceDisplayName** | Pointer to **string** | The source name of account | [optional] + +## Methods + +### NewAppAccountDetailsSourceAccount + +`func NewAppAccountDetailsSourceAccount() *AppAccountDetailsSourceAccount` + +NewAppAccountDetailsSourceAccount instantiates a new AppAccountDetailsSourceAccount 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 + +### NewAppAccountDetailsSourceAccountWithDefaults + +`func NewAppAccountDetailsSourceAccountWithDefaults() *AppAccountDetailsSourceAccount` + +NewAppAccountDetailsSourceAccountWithDefaults instantiates a new AppAccountDetailsSourceAccount 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 + +### GetId + +`func (o *AppAccountDetailsSourceAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AppAccountDetailsSourceAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AppAccountDetailsSourceAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AppAccountDetailsSourceAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *AppAccountDetailsSourceAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AppAccountDetailsSourceAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AppAccountDetailsSourceAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AppAccountDetailsSourceAccount) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AppAccountDetailsSourceAccount) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AppAccountDetailsSourceAccount) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AppAccountDetailsSourceAccount) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AppAccountDetailsSourceAccount) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *AppAccountDetailsSourceAccount) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AppAccountDetailsSourceAccount) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AppAccountDetailsSourceAccount) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AppAccountDetailsSourceAccount) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceDisplayName + +`func (o *AppAccountDetailsSourceAccount) GetSourceDisplayName() string` + +GetSourceDisplayName returns the SourceDisplayName field if non-nil, zero value otherwise. + +### GetSourceDisplayNameOk + +`func (o *AppAccountDetailsSourceAccount) GetSourceDisplayNameOk() (*string, bool)` + +GetSourceDisplayNameOk returns a tuple with the SourceDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceDisplayName + +`func (o *AppAccountDetailsSourceAccount) SetSourceDisplayName(v string)` + +SetSourceDisplayName sets SourceDisplayName field to given value. + +### HasSourceDisplayName + +`func (o *AppAccountDetailsSourceAccount) HasSourceDisplayName() bool` + +HasSourceDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AppAllOfAccount.md b/docs/tools/sdk/go/Reference/V2025/Models/AppAllOfAccount.md new file mode 100644 index 000000000..ca400e80e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AppAllOfAccount.md @@ -0,0 +1,90 @@ +--- +id: v2025-app-all-of-account +title: AppAllOfAccount +pagination_label: AppAllOfAccount +sidebar_label: AppAllOfAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AppAllOfAccount', 'V2025AppAllOfAccount'] +slug: /tools/sdk/go/v2025/models/app-all-of-account +tags: ['SDK', 'Software Development Kit', 'AppAllOfAccount', 'V2025AppAllOfAccount'] +--- + +# AppAllOfAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The SailPoint generated unique ID | [optional] +**AccountId** | Pointer to **string** | The account ID generated by the source | [optional] + +## Methods + +### NewAppAllOfAccount + +`func NewAppAllOfAccount() *AppAllOfAccount` + +NewAppAllOfAccount instantiates a new AppAllOfAccount 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 + +### NewAppAllOfAccountWithDefaults + +`func NewAppAllOfAccountWithDefaults() *AppAllOfAccount` + +NewAppAllOfAccountWithDefaults instantiates a new AppAllOfAccount 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 + +### GetId + +`func (o *AppAllOfAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AppAllOfAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AppAllOfAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AppAllOfAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccountId + +`func (o *AppAllOfAccount) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *AppAllOfAccount) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *AppAllOfAccount) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *AppAllOfAccount) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Approval.md b/docs/tools/sdk/go/Reference/V2025/Models/Approval.md new file mode 100644 index 000000000..8a0bac2cf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Approval.md @@ -0,0 +1,480 @@ +--- +id: v2025-approval +title: Approval +pagination_label: Approval +sidebar_label: Approval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Approval', 'V2025Approval'] +slug: /tools/sdk/go/v2025/models/approval +tags: ['SDK', 'Software Development Kit', 'Approval', 'V2025Approval'] +--- + +# Approval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalId** | Pointer to **string** | The Approval ID | [optional] +**Approvers** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Object representation of an approver of an approval | [optional] +**CreatedDate** | Pointer to **string** | Date the approval was created | [optional] +**Type** | Pointer to **string** | Type of approval | [optional] +**Name** | Pointer to [**[]ApprovalName**](approval-name) | The name of the approval for a given locale | [optional] +**BatchRequest** | Pointer to [**ApprovalBatch**](approval-batch) | The name of the approval for a given locale | [optional] +**Description** | Pointer to [**[]ApprovalDescription**](approval-description) | The description of the approval for a given locale | [optional] +**Priority** | Pointer to **string** | The priority of the approval | [optional] +**Requester** | Pointer to [**ApprovalIdentity**](approval-identity) | Object representation of the requester of the approval | [optional] +**Comments** | Pointer to [**[]ApprovalComment1**](approval-comment1) | Object representation of a comment on the approval | [optional] +**ApprovedBy** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have approved the approval | [optional] +**RejectedBy** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have rejected the approval | [optional] +**CompletedDate** | Pointer to **string** | Date the approval was completed | [optional] +**ApprovalCriteria** | Pointer to **string** | Criteria that needs to be met for an approval to be marked as approved | [optional] +**Status** | Pointer to **string** | The current status of the approval | [optional] +**AdditionalAttributes** | Pointer to **string** | Json string representing additional attributes known about the object to be approved. | [optional] +**ReferenceData** | Pointer to [**[]ApprovalReference**](approval-reference) | Reference data related to the approval | [optional] + +## Methods + +### NewApproval + +`func NewApproval() *Approval` + +NewApproval instantiates a new Approval 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 + +### NewApprovalWithDefaults + +`func NewApprovalWithDefaults() *Approval` + +NewApprovalWithDefaults instantiates a new Approval 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 + +### GetApprovalId + +`func (o *Approval) GetApprovalId() string` + +GetApprovalId returns the ApprovalId field if non-nil, zero value otherwise. + +### GetApprovalIdOk + +`func (o *Approval) GetApprovalIdOk() (*string, bool)` + +GetApprovalIdOk returns a tuple with the ApprovalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalId + +`func (o *Approval) SetApprovalId(v string)` + +SetApprovalId sets ApprovalId field to given value. + +### HasApprovalId + +`func (o *Approval) HasApprovalId() bool` + +HasApprovalId returns a boolean if a field has been set. + +### GetApprovers + +`func (o *Approval) GetApprovers() []ApprovalIdentity` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *Approval) GetApproversOk() (*[]ApprovalIdentity, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *Approval) SetApprovers(v []ApprovalIdentity)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *Approval) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *Approval) GetCreatedDate() string` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *Approval) GetCreatedDateOk() (*string, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *Approval) SetCreatedDate(v string)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *Approval) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetType + +`func (o *Approval) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Approval) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Approval) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Approval) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *Approval) GetName() []ApprovalName` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Approval) GetNameOk() (*[]ApprovalName, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Approval) SetName(v []ApprovalName)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Approval) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetBatchRequest + +`func (o *Approval) GetBatchRequest() ApprovalBatch` + +GetBatchRequest returns the BatchRequest field if non-nil, zero value otherwise. + +### GetBatchRequestOk + +`func (o *Approval) GetBatchRequestOk() (*ApprovalBatch, bool)` + +GetBatchRequestOk returns a tuple with the BatchRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchRequest + +`func (o *Approval) SetBatchRequest(v ApprovalBatch)` + +SetBatchRequest sets BatchRequest field to given value. + +### HasBatchRequest + +`func (o *Approval) HasBatchRequest() bool` + +HasBatchRequest returns a boolean if a field has been set. + +### GetDescription + +`func (o *Approval) GetDescription() []ApprovalDescription` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Approval) GetDescriptionOk() (*[]ApprovalDescription, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Approval) SetDescription(v []ApprovalDescription)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Approval) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetPriority + +`func (o *Approval) GetPriority() string` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *Approval) GetPriorityOk() (*string, 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 *Approval) SetPriority(v string)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *Approval) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetRequester + +`func (o *Approval) GetRequester() ApprovalIdentity` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *Approval) GetRequesterOk() (*ApprovalIdentity, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *Approval) SetRequester(v ApprovalIdentity)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *Approval) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetComments + +`func (o *Approval) GetComments() []ApprovalComment1` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *Approval) GetCommentsOk() (*[]ApprovalComment1, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *Approval) SetComments(v []ApprovalComment1)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *Approval) HasComments() bool` + +HasComments returns a boolean if a field has been set. + +### GetApprovedBy + +`func (o *Approval) GetApprovedBy() []ApprovalIdentity` + +GetApprovedBy returns the ApprovedBy field if non-nil, zero value otherwise. + +### GetApprovedByOk + +`func (o *Approval) GetApprovedByOk() (*[]ApprovalIdentity, bool)` + +GetApprovedByOk returns a tuple with the ApprovedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovedBy + +`func (o *Approval) SetApprovedBy(v []ApprovalIdentity)` + +SetApprovedBy sets ApprovedBy field to given value. + +### HasApprovedBy + +`func (o *Approval) HasApprovedBy() bool` + +HasApprovedBy returns a boolean if a field has been set. + +### GetRejectedBy + +`func (o *Approval) GetRejectedBy() []ApprovalIdentity` + +GetRejectedBy returns the RejectedBy field if non-nil, zero value otherwise. + +### GetRejectedByOk + +`func (o *Approval) GetRejectedByOk() (*[]ApprovalIdentity, bool)` + +GetRejectedByOk returns a tuple with the RejectedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRejectedBy + +`func (o *Approval) SetRejectedBy(v []ApprovalIdentity)` + +SetRejectedBy sets RejectedBy field to given value. + +### HasRejectedBy + +`func (o *Approval) HasRejectedBy() bool` + +HasRejectedBy returns a boolean if a field has been set. + +### GetCompletedDate + +`func (o *Approval) GetCompletedDate() string` + +GetCompletedDate returns the CompletedDate field if non-nil, zero value otherwise. + +### GetCompletedDateOk + +`func (o *Approval) GetCompletedDateOk() (*string, bool)` + +GetCompletedDateOk returns a tuple with the CompletedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedDate + +`func (o *Approval) SetCompletedDate(v string)` + +SetCompletedDate sets CompletedDate field to given value. + +### HasCompletedDate + +`func (o *Approval) HasCompletedDate() bool` + +HasCompletedDate returns a boolean if a field has been set. + +### GetApprovalCriteria + +`func (o *Approval) GetApprovalCriteria() string` + +GetApprovalCriteria returns the ApprovalCriteria field if non-nil, zero value otherwise. + +### GetApprovalCriteriaOk + +`func (o *Approval) GetApprovalCriteriaOk() (*string, bool)` + +GetApprovalCriteriaOk returns a tuple with the ApprovalCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalCriteria + +`func (o *Approval) SetApprovalCriteria(v string)` + +SetApprovalCriteria sets ApprovalCriteria field to given value. + +### HasApprovalCriteria + +`func (o *Approval) HasApprovalCriteria() bool` + +HasApprovalCriteria returns a boolean if a field has been set. + +### GetStatus + +`func (o *Approval) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Approval) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Approval) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Approval) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetAdditionalAttributes + +`func (o *Approval) GetAdditionalAttributes() string` + +GetAdditionalAttributes returns the AdditionalAttributes field if non-nil, zero value otherwise. + +### GetAdditionalAttributesOk + +`func (o *Approval) GetAdditionalAttributesOk() (*string, bool)` + +GetAdditionalAttributesOk returns a tuple with the AdditionalAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAdditionalAttributes + +`func (o *Approval) SetAdditionalAttributes(v string)` + +SetAdditionalAttributes sets AdditionalAttributes field to given value. + +### HasAdditionalAttributes + +`func (o *Approval) HasAdditionalAttributes() bool` + +HasAdditionalAttributes returns a boolean if a field has been set. + +### GetReferenceData + +`func (o *Approval) GetReferenceData() []ApprovalReference` + +GetReferenceData returns the ReferenceData field if non-nil, zero value otherwise. + +### GetReferenceDataOk + +`func (o *Approval) GetReferenceDataOk() (*[]ApprovalReference, bool)` + +GetReferenceDataOk returns a tuple with the ReferenceData field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReferenceData + +`func (o *Approval) SetReferenceData(v []ApprovalReference)` + +SetReferenceData sets ReferenceData field to given value. + +### HasReferenceData + +`func (o *Approval) HasReferenceData() bool` + +HasReferenceData returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Approval1.md b/docs/tools/sdk/go/Reference/V2025/Models/Approval1.md new file mode 100644 index 000000000..b34fecd72 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Approval1.md @@ -0,0 +1,204 @@ +--- +id: v2025-approval1 +title: Approval1 +pagination_label: Approval1 +sidebar_label: Approval1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Approval1', 'V2025Approval1'] +slug: /tools/sdk/go/v2025/models/approval1 +tags: ['SDK', 'Software Development Kit', 'Approval1', 'V2025Approval1'] +--- + +# Approval1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comments** | Pointer to [**[]ApprovalComment2**](approval-comment2) | | [optional] +**Modified** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Owner** | Pointer to [**ActivityIdentity**](activity-identity) | | [optional] +**Result** | Pointer to **string** | The result of the approval | [optional] +**AttributeRequest** | Pointer to [**AttributeRequest**](attribute-request) | | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] + +## Methods + +### NewApproval1 + +`func NewApproval1() *Approval1` + +NewApproval1 instantiates a new Approval1 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 + +### NewApproval1WithDefaults + +`func NewApproval1WithDefaults() *Approval1` + +NewApproval1WithDefaults instantiates a new Approval1 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 + +### GetComments + +`func (o *Approval1) GetComments() []ApprovalComment2` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *Approval1) GetCommentsOk() (*[]ApprovalComment2, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *Approval1) SetComments(v []ApprovalComment2)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *Approval1) HasComments() bool` + +HasComments returns a boolean if a field has been set. + +### GetModified + +`func (o *Approval1) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Approval1) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Approval1) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Approval1) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *Approval1) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *Approval1) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetOwner + +`func (o *Approval1) GetOwner() ActivityIdentity` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Approval1) GetOwnerOk() (*ActivityIdentity, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Approval1) SetOwner(v ActivityIdentity)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *Approval1) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetResult + +`func (o *Approval1) GetResult() string` + +GetResult returns the Result field if non-nil, zero value otherwise. + +### GetResultOk + +`func (o *Approval1) GetResultOk() (*string, bool)` + +GetResultOk returns a tuple with the Result field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResult + +`func (o *Approval1) SetResult(v string)` + +SetResult sets Result field to given value. + +### HasResult + +`func (o *Approval1) HasResult() bool` + +HasResult returns a boolean if a field has been set. + +### GetAttributeRequest + +`func (o *Approval1) GetAttributeRequest() AttributeRequest` + +GetAttributeRequest returns the AttributeRequest field if non-nil, zero value otherwise. + +### GetAttributeRequestOk + +`func (o *Approval1) GetAttributeRequestOk() (*AttributeRequest, bool)` + +GetAttributeRequestOk returns a tuple with the AttributeRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeRequest + +`func (o *Approval1) SetAttributeRequest(v AttributeRequest)` + +SetAttributeRequest sets AttributeRequest field to given value. + +### HasAttributeRequest + +`func (o *Approval1) HasAttributeRequest() bool` + +HasAttributeRequest returns a boolean if a field has been set. + +### GetSource + +`func (o *Approval1) GetSource() AccountSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *Approval1) GetSourceOk() (*AccountSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *Approval1) SetSource(v AccountSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *Approval1) HasSource() bool` + +HasSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalBatch.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalBatch.md new file mode 100644 index 000000000..e0a69960a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalBatch.md @@ -0,0 +1,90 @@ +--- +id: v2025-approval-batch +title: ApprovalBatch +pagination_label: ApprovalBatch +sidebar_label: ApprovalBatch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalBatch', 'V2025ApprovalBatch'] +slug: /tools/sdk/go/v2025/models/approval-batch +tags: ['SDK', 'Software Development Kit', 'ApprovalBatch', 'V2025ApprovalBatch'] +--- + +# ApprovalBatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **string** | ID of the batch | [optional] +**BatchSize** | Pointer to **int64** | How many approvals are going to be in this batch. Defaults to 1 if not provided. | [optional] + +## Methods + +### NewApprovalBatch + +`func NewApprovalBatch() *ApprovalBatch` + +NewApprovalBatch instantiates a new ApprovalBatch 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 + +### NewApprovalBatchWithDefaults + +`func NewApprovalBatchWithDefaults() *ApprovalBatch` + +NewApprovalBatchWithDefaults instantiates a new ApprovalBatch 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 + +### GetBatchId + +`func (o *ApprovalBatch) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *ApprovalBatch) GetBatchIdOk() (*string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchId + +`func (o *ApprovalBatch) SetBatchId(v string)` + +SetBatchId sets BatchId field to given value. + +### HasBatchId + +`func (o *ApprovalBatch) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### GetBatchSize + +`func (o *ApprovalBatch) GetBatchSize() int64` + +GetBatchSize returns the BatchSize field if non-nil, zero value otherwise. + +### GetBatchSizeOk + +`func (o *ApprovalBatch) GetBatchSizeOk() (*int64, bool)` + +GetBatchSizeOk returns a tuple with the BatchSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchSize + +`func (o *ApprovalBatch) SetBatchSize(v int64)` + +SetBatchSize sets BatchSize field to given value. + +### HasBatchSize + +`func (o *ApprovalBatch) HasBatchSize() bool` + +HasBatchSize returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalComment.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalComment.md new file mode 100644 index 000000000..68dc07d0b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalComment.md @@ -0,0 +1,143 @@ +--- +id: v2025-approval-comment +title: ApprovalComment +pagination_label: ApprovalComment +sidebar_label: ApprovalComment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalComment', 'V2025ApprovalComment'] +slug: /tools/sdk/go/v2025/models/approval-comment +tags: ['SDK', 'Software Development Kit', 'ApprovalComment', 'V2025ApprovalComment'] +--- + +# ApprovalComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | **string** | Comment provided either by the approval requester or the approver. | +**Timestamp** | **SailPointTime** | The time when this comment was provided. | +**User** | **string** | Name of the user that provided this comment. | +**Id** | **string** | Id of the user that provided this comment. | +**ChangedToStatus** | **string** | Status transition of the draft. | + +## Methods + +### NewApprovalComment + +`func NewApprovalComment(comment string, timestamp SailPointTime, user string, id string, changedToStatus string, ) *ApprovalComment` + +NewApprovalComment instantiates a new ApprovalComment 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 + +### NewApprovalCommentWithDefaults + +`func NewApprovalCommentWithDefaults() *ApprovalComment` + +NewApprovalCommentWithDefaults instantiates a new ApprovalComment 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 + +### GetComment + +`func (o *ApprovalComment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ApprovalComment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ApprovalComment) SetComment(v string)` + +SetComment sets Comment field to given value. + + +### GetTimestamp + +`func (o *ApprovalComment) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *ApprovalComment) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *ApprovalComment) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + + +### GetUser + +`func (o *ApprovalComment) GetUser() string` + +GetUser returns the User field if non-nil, zero value otherwise. + +### GetUserOk + +`func (o *ApprovalComment) GetUserOk() (*string, bool)` + +GetUserOk returns a tuple with the User field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUser + +`func (o *ApprovalComment) SetUser(v string)` + +SetUser sets User field to given value. + + +### GetId + +`func (o *ApprovalComment) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalComment) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalComment) SetId(v string)` + +SetId sets Id field to given value. + + +### GetChangedToStatus + +`func (o *ApprovalComment) GetChangedToStatus() string` + +GetChangedToStatus returns the ChangedToStatus field if non-nil, zero value otherwise. + +### GetChangedToStatusOk + +`func (o *ApprovalComment) GetChangedToStatusOk() (*string, bool)` + +GetChangedToStatusOk returns a tuple with the ChangedToStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChangedToStatus + +`func (o *ApprovalComment) SetChangedToStatus(v string)` + +SetChangedToStatus sets ChangedToStatus field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalComment1.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalComment1.md new file mode 100644 index 000000000..fead697a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalComment1.md @@ -0,0 +1,116 @@ +--- +id: v2025-approval-comment1 +title: ApprovalComment1 +pagination_label: ApprovalComment1 +sidebar_label: ApprovalComment1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalComment1', 'V2025ApprovalComment1'] +slug: /tools/sdk/go/v2025/models/approval-comment1 +tags: ['SDK', 'Software Development Kit', 'ApprovalComment1', 'V2025ApprovalComment1'] +--- + +# ApprovalComment1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Author** | Pointer to [**ApprovalIdentity**](approval-identity) | | [optional] +**Comment** | Pointer to **string** | Comment to be left on an approval | [optional] +**CreatedDate** | Pointer to **string** | Date the comment was created | [optional] + +## Methods + +### NewApprovalComment1 + +`func NewApprovalComment1() *ApprovalComment1` + +NewApprovalComment1 instantiates a new ApprovalComment1 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 + +### NewApprovalComment1WithDefaults + +`func NewApprovalComment1WithDefaults() *ApprovalComment1` + +NewApprovalComment1WithDefaults instantiates a new ApprovalComment1 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 + +### GetAuthor + +`func (o *ApprovalComment1) GetAuthor() ApprovalIdentity` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *ApprovalComment1) GetAuthorOk() (*ApprovalIdentity, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *ApprovalComment1) SetAuthor(v ApprovalIdentity)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *ApprovalComment1) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + +### GetComment + +`func (o *ApprovalComment1) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ApprovalComment1) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ApprovalComment1) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ApprovalComment1) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *ApprovalComment1) GetCreatedDate() string` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *ApprovalComment1) GetCreatedDateOk() (*string, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *ApprovalComment1) SetCreatedDate(v string)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *ApprovalComment1) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalComment2.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalComment2.md new file mode 100644 index 000000000..c204a637a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalComment2.md @@ -0,0 +1,126 @@ +--- +id: v2025-approval-comment2 +title: ApprovalComment2 +pagination_label: ApprovalComment2 +sidebar_label: ApprovalComment2 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalComment2', 'V2025ApprovalComment2'] +slug: /tools/sdk/go/v2025/models/approval-comment2 +tags: ['SDK', 'Software Development Kit', 'ApprovalComment2', 'V2025ApprovalComment2'] +--- + +# ApprovalComment2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | The comment text | [optional] +**Commenter** | Pointer to **string** | The name of the commenter | [optional] +**Date** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] + +## Methods + +### NewApprovalComment2 + +`func NewApprovalComment2() *ApprovalComment2` + +NewApprovalComment2 instantiates a new ApprovalComment2 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 + +### NewApprovalComment2WithDefaults + +`func NewApprovalComment2WithDefaults() *ApprovalComment2` + +NewApprovalComment2WithDefaults instantiates a new ApprovalComment2 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 + +### GetComment + +`func (o *ApprovalComment2) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ApprovalComment2) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ApprovalComment2) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ApprovalComment2) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetCommenter + +`func (o *ApprovalComment2) GetCommenter() string` + +GetCommenter returns the Commenter field if non-nil, zero value otherwise. + +### GetCommenterOk + +`func (o *ApprovalComment2) GetCommenterOk() (*string, bool)` + +GetCommenterOk returns a tuple with the Commenter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommenter + +`func (o *ApprovalComment2) SetCommenter(v string)` + +SetCommenter sets Commenter field to given value. + +### HasCommenter + +`func (o *ApprovalComment2) HasCommenter() bool` + +HasCommenter returns a boolean if a field has been set. + +### GetDate + +`func (o *ApprovalComment2) GetDate() SailPointTime` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *ApprovalComment2) GetDateOk() (*SailPointTime, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *ApprovalComment2) SetDate(v SailPointTime)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *ApprovalComment2) HasDate() bool` + +HasDate returns a boolean if a field has been set. + +### SetDateNil + +`func (o *ApprovalComment2) SetDateNil(b bool)` + + SetDateNil sets the value for Date to be an explicit nil + +### UnsetDate +`func (o *ApprovalComment2) UnsetDate()` + +UnsetDate ensures that no value is present for Date, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalDescription.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalDescription.md new file mode 100644 index 000000000..6a7be7a35 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalDescription.md @@ -0,0 +1,90 @@ +--- +id: v2025-approval-description +title: ApprovalDescription +pagination_label: ApprovalDescription +sidebar_label: ApprovalDescription +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalDescription', 'V2025ApprovalDescription'] +slug: /tools/sdk/go/v2025/models/approval-description +tags: ['SDK', 'Software Development Kit', 'ApprovalDescription', 'V2025ApprovalDescription'] +--- + +# ApprovalDescription + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | The description of what the approval is asking for | [optional] +**Locale** | Pointer to **string** | What locale the description of the approval is using | [optional] + +## Methods + +### NewApprovalDescription + +`func NewApprovalDescription() *ApprovalDescription` + +NewApprovalDescription instantiates a new ApprovalDescription 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 + +### NewApprovalDescriptionWithDefaults + +`func NewApprovalDescriptionWithDefaults() *ApprovalDescription` + +NewApprovalDescriptionWithDefaults instantiates a new ApprovalDescription 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 + +### GetValue + +`func (o *ApprovalDescription) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ApprovalDescription) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ApprovalDescription) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ApprovalDescription) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetLocale + +`func (o *ApprovalDescription) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *ApprovalDescription) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *ApprovalDescription) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *ApprovalDescription) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalForwardHistory.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalForwardHistory.md new file mode 100644 index 000000000..cb8de9432 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalForwardHistory.md @@ -0,0 +1,214 @@ +--- +id: v2025-approval-forward-history +title: ApprovalForwardHistory +pagination_label: ApprovalForwardHistory +sidebar_label: ApprovalForwardHistory +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalForwardHistory', 'V2025ApprovalForwardHistory'] +slug: /tools/sdk/go/v2025/models/approval-forward-history +tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory', 'V2025ApprovalForwardHistory'] +--- + +# ApprovalForwardHistory + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OldApproverName** | Pointer to **string** | Display name of approver from whom the approval was forwarded. | [optional] +**NewApproverName** | Pointer to **string** | Display name of approver to whom the approval was forwarded. | [optional] +**Comment** | Pointer to **NullableString** | Comment made while forwarding. | [optional] +**Modified** | Pointer to **SailPointTime** | Time at which approval was forwarded. | [optional] +**ForwarderName** | Pointer to **NullableString** | Display name of forwarder who forwarded the approval. | [optional] +**ReassignmentType** | Pointer to [**ReassignmentType**](reassignment-type) | | [optional] + +## Methods + +### NewApprovalForwardHistory + +`func NewApprovalForwardHistory() *ApprovalForwardHistory` + +NewApprovalForwardHistory instantiates a new ApprovalForwardHistory 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 + +### NewApprovalForwardHistoryWithDefaults + +`func NewApprovalForwardHistoryWithDefaults() *ApprovalForwardHistory` + +NewApprovalForwardHistoryWithDefaults instantiates a new ApprovalForwardHistory 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 + +### GetOldApproverName + +`func (o *ApprovalForwardHistory) GetOldApproverName() string` + +GetOldApproverName returns the OldApproverName field if non-nil, zero value otherwise. + +### GetOldApproverNameOk + +`func (o *ApprovalForwardHistory) GetOldApproverNameOk() (*string, bool)` + +GetOldApproverNameOk returns a tuple with the OldApproverName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOldApproverName + +`func (o *ApprovalForwardHistory) SetOldApproverName(v string)` + +SetOldApproverName sets OldApproverName field to given value. + +### HasOldApproverName + +`func (o *ApprovalForwardHistory) HasOldApproverName() bool` + +HasOldApproverName returns a boolean if a field has been set. + +### GetNewApproverName + +`func (o *ApprovalForwardHistory) GetNewApproverName() string` + +GetNewApproverName returns the NewApproverName field if non-nil, zero value otherwise. + +### GetNewApproverNameOk + +`func (o *ApprovalForwardHistory) GetNewApproverNameOk() (*string, bool)` + +GetNewApproverNameOk returns a tuple with the NewApproverName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewApproverName + +`func (o *ApprovalForwardHistory) SetNewApproverName(v string)` + +SetNewApproverName sets NewApproverName field to given value. + +### HasNewApproverName + +`func (o *ApprovalForwardHistory) HasNewApproverName() bool` + +HasNewApproverName returns a boolean if a field has been set. + +### GetComment + +`func (o *ApprovalForwardHistory) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ApprovalForwardHistory) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ApprovalForwardHistory) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ApprovalForwardHistory) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *ApprovalForwardHistory) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *ApprovalForwardHistory) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetModified + +`func (o *ApprovalForwardHistory) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ApprovalForwardHistory) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ApprovalForwardHistory) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ApprovalForwardHistory) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetForwarderName + +`func (o *ApprovalForwardHistory) GetForwarderName() string` + +GetForwarderName returns the ForwarderName field if non-nil, zero value otherwise. + +### GetForwarderNameOk + +`func (o *ApprovalForwardHistory) GetForwarderNameOk() (*string, bool)` + +GetForwarderNameOk returns a tuple with the ForwarderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwarderName + +`func (o *ApprovalForwardHistory) SetForwarderName(v string)` + +SetForwarderName sets ForwarderName field to given value. + +### HasForwarderName + +`func (o *ApprovalForwardHistory) HasForwarderName() bool` + +HasForwarderName returns a boolean if a field has been set. + +### SetForwarderNameNil + +`func (o *ApprovalForwardHistory) SetForwarderNameNil(b bool)` + + SetForwarderNameNil sets the value for ForwarderName to be an explicit nil + +### UnsetForwarderName +`func (o *ApprovalForwardHistory) UnsetForwarderName()` + +UnsetForwarderName ensures that no value is present for ForwarderName, not even an explicit nil +### GetReassignmentType + +`func (o *ApprovalForwardHistory) GetReassignmentType() ReassignmentType` + +GetReassignmentType returns the ReassignmentType field if non-nil, zero value otherwise. + +### GetReassignmentTypeOk + +`func (o *ApprovalForwardHistory) GetReassignmentTypeOk() (*ReassignmentType, bool)` + +GetReassignmentTypeOk returns a tuple with the ReassignmentType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignmentType + +`func (o *ApprovalForwardHistory) SetReassignmentType(v ReassignmentType)` + +SetReassignmentType sets ReassignmentType field to given value. + +### HasReassignmentType + +`func (o *ApprovalForwardHistory) HasReassignmentType() bool` + +HasReassignmentType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalIdentity.md new file mode 100644 index 000000000..6d6ac07e8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalIdentity.md @@ -0,0 +1,116 @@ +--- +id: v2025-approval-identity +title: ApprovalIdentity +pagination_label: ApprovalIdentity +sidebar_label: ApprovalIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalIdentity', 'V2025ApprovalIdentity'] +slug: /tools/sdk/go/v2025/models/approval-identity +tags: ['SDK', 'Software Development Kit', 'ApprovalIdentity', 'V2025ApprovalIdentity'] +--- + +# ApprovalIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity ID | [optional] +**Type** | Pointer to **string** | Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc | [optional] +**Name** | Pointer to **string** | Name of the identity | [optional] + +## Methods + +### NewApprovalIdentity + +`func NewApprovalIdentity() *ApprovalIdentity` + +NewApprovalIdentity instantiates a new ApprovalIdentity 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 + +### NewApprovalIdentityWithDefaults + +`func NewApprovalIdentityWithDefaults() *ApprovalIdentity` + +NewApprovalIdentityWithDefaults instantiates a new ApprovalIdentity 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 + +### GetId + +`func (o *ApprovalIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *ApprovalIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ApprovalIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ApprovalIdentity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ApprovalIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalInfoResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalInfoResponse.md new file mode 100644 index 000000000..45ea827d1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalInfoResponse.md @@ -0,0 +1,116 @@ +--- +id: v2025-approval-info-response +title: ApprovalInfoResponse +pagination_label: ApprovalInfoResponse +sidebar_label: ApprovalInfoResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalInfoResponse', 'V2025ApprovalInfoResponse'] +slug: /tools/sdk/go/v2025/models/approval-info-response +tags: ['SDK', 'Software Development Kit', 'ApprovalInfoResponse', 'V2025ApprovalInfoResponse'] +--- + +# ApprovalInfoResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the id of approver | [optional] +**Name** | Pointer to **string** | the name of approver | [optional] +**Status** | Pointer to **string** | the status of the approval request | [optional] + +## Methods + +### NewApprovalInfoResponse + +`func NewApprovalInfoResponse() *ApprovalInfoResponse` + +NewApprovalInfoResponse instantiates a new ApprovalInfoResponse 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 + +### NewApprovalInfoResponseWithDefaults + +`func NewApprovalInfoResponseWithDefaults() *ApprovalInfoResponse` + +NewApprovalInfoResponseWithDefaults instantiates a new ApprovalInfoResponse 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 + +### GetId + +`func (o *ApprovalInfoResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalInfoResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalInfoResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalInfoResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalInfoResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalInfoResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalInfoResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalInfoResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *ApprovalInfoResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ApprovalInfoResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ApprovalInfoResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ApprovalInfoResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalItemDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalItemDetails.md new file mode 100644 index 000000000..e616bdbff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalItemDetails.md @@ -0,0 +1,250 @@ +--- +id: v2025-approval-item-details +title: ApprovalItemDetails +pagination_label: ApprovalItemDetails +sidebar_label: ApprovalItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalItemDetails', 'V2025ApprovalItemDetails'] +slug: /tools/sdk/go/v2025/models/approval-item-details +tags: ['SDK', 'Software Development Kit', 'ApprovalItemDetails', 'V2025ApprovalItemDetails'] +--- + +# ApprovalItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The approval item's ID | [optional] +**Account** | Pointer to **NullableString** | The account referenced by the approval item | [optional] +**Application** | Pointer to **string** | The name of the application/source | [optional] +**Name** | Pointer to **NullableString** | The attribute's name | [optional] +**Operation** | Pointer to **string** | The attribute's operation | [optional] +**Value** | Pointer to **NullableString** | The attribute's value | [optional] +**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional] + +## Methods + +### NewApprovalItemDetails + +`func NewApprovalItemDetails() *ApprovalItemDetails` + +NewApprovalItemDetails instantiates a new ApprovalItemDetails 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 + +### NewApprovalItemDetailsWithDefaults + +`func NewApprovalItemDetailsWithDefaults() *ApprovalItemDetails` + +NewApprovalItemDetailsWithDefaults instantiates a new ApprovalItemDetails 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 + +### GetId + +`func (o *ApprovalItemDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalItemDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalItemDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalItemDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccount + +`func (o *ApprovalItemDetails) GetAccount() string` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *ApprovalItemDetails) GetAccountOk() (*string, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *ApprovalItemDetails) SetAccount(v string)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *ApprovalItemDetails) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### SetAccountNil + +`func (o *ApprovalItemDetails) SetAccountNil(b bool)` + + SetAccountNil sets the value for Account to be an explicit nil + +### UnsetAccount +`func (o *ApprovalItemDetails) UnsetAccount()` + +UnsetAccount ensures that no value is present for Account, not even an explicit nil +### GetApplication + +`func (o *ApprovalItemDetails) GetApplication() string` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *ApprovalItemDetails) GetApplicationOk() (*string, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *ApprovalItemDetails) SetApplication(v string)` + +SetApplication sets Application field to given value. + +### HasApplication + +`func (o *ApprovalItemDetails) HasApplication() bool` + +HasApplication returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalItemDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalItemDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalItemDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalItemDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ApprovalItemDetails) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ApprovalItemDetails) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetOperation + +`func (o *ApprovalItemDetails) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ApprovalItemDetails) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ApprovalItemDetails) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ApprovalItemDetails) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetValue + +`func (o *ApprovalItemDetails) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ApprovalItemDetails) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ApprovalItemDetails) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ApprovalItemDetails) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ApprovalItemDetails) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ApprovalItemDetails) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetState + +`func (o *ApprovalItemDetails) GetState() WorkItemState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ApprovalItemDetails) GetStateOk() (*WorkItemState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ApprovalItemDetails) SetState(v WorkItemState)` + +SetState sets State field to given value. + +### HasState + +`func (o *ApprovalItemDetails) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalItems.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalItems.md new file mode 100644 index 000000000..c87fab0ed --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalItems.md @@ -0,0 +1,250 @@ +--- +id: v2025-approval-items +title: ApprovalItems +pagination_label: ApprovalItems +sidebar_label: ApprovalItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalItems', 'V2025ApprovalItems'] +slug: /tools/sdk/go/v2025/models/approval-items +tags: ['SDK', 'Software Development Kit', 'ApprovalItems', 'V2025ApprovalItems'] +--- + +# ApprovalItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The approval item's ID | [optional] +**Account** | Pointer to **NullableString** | The account referenced by the approval item | [optional] +**Application** | Pointer to **string** | The name of the application/source | [optional] +**Name** | Pointer to **NullableString** | The attribute's name | [optional] +**Operation** | Pointer to **string** | The attribute's operation | [optional] +**Value** | Pointer to **NullableString** | The attribute's value | [optional] +**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional] + +## Methods + +### NewApprovalItems + +`func NewApprovalItems() *ApprovalItems` + +NewApprovalItems instantiates a new ApprovalItems 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 + +### NewApprovalItemsWithDefaults + +`func NewApprovalItemsWithDefaults() *ApprovalItems` + +NewApprovalItemsWithDefaults instantiates a new ApprovalItems 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 + +### GetId + +`func (o *ApprovalItems) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalItems) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalItems) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalItems) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccount + +`func (o *ApprovalItems) GetAccount() string` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *ApprovalItems) GetAccountOk() (*string, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *ApprovalItems) SetAccount(v string)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *ApprovalItems) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### SetAccountNil + +`func (o *ApprovalItems) SetAccountNil(b bool)` + + SetAccountNil sets the value for Account to be an explicit nil + +### UnsetAccount +`func (o *ApprovalItems) UnsetAccount()` + +UnsetAccount ensures that no value is present for Account, not even an explicit nil +### GetApplication + +`func (o *ApprovalItems) GetApplication() string` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *ApprovalItems) GetApplicationOk() (*string, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *ApprovalItems) SetApplication(v string)` + +SetApplication sets Application field to given value. + +### HasApplication + +`func (o *ApprovalItems) HasApplication() bool` + +HasApplication returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalItems) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalItems) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalItems) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalItems) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ApprovalItems) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ApprovalItems) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetOperation + +`func (o *ApprovalItems) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ApprovalItems) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ApprovalItems) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ApprovalItems) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetValue + +`func (o *ApprovalItems) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ApprovalItems) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ApprovalItems) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ApprovalItems) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ApprovalItems) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ApprovalItems) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetState + +`func (o *ApprovalItems) GetState() WorkItemState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ApprovalItems) GetStateOk() (*WorkItemState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ApprovalItems) SetState(v WorkItemState)` + +SetState sets State field to given value. + +### HasState + +`func (o *ApprovalItems) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalName.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalName.md new file mode 100644 index 000000000..b8c86cf63 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalName.md @@ -0,0 +1,90 @@ +--- +id: v2025-approval-name +title: ApprovalName +pagination_label: ApprovalName +sidebar_label: ApprovalName +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalName', 'V2025ApprovalName'] +slug: /tools/sdk/go/v2025/models/approval-name +tags: ['SDK', 'Software Development Kit', 'ApprovalName', 'V2025ApprovalName'] +--- + +# ApprovalName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | Name of the approval | [optional] +**Locale** | Pointer to **string** | What locale the name of the approval is using | [optional] + +## Methods + +### NewApprovalName + +`func NewApprovalName() *ApprovalName` + +NewApprovalName instantiates a new ApprovalName 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 + +### NewApprovalNameWithDefaults + +`func NewApprovalNameWithDefaults() *ApprovalName` + +NewApprovalNameWithDefaults instantiates a new ApprovalName 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 + +### GetValue + +`func (o *ApprovalName) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ApprovalName) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ApprovalName) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ApprovalName) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetLocale + +`func (o *ApprovalName) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *ApprovalName) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *ApprovalName) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *ApprovalName) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalReference.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalReference.md new file mode 100644 index 000000000..690dbdb80 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalReference.md @@ -0,0 +1,90 @@ +--- +id: v2025-approval-reference +title: ApprovalReference +pagination_label: ApprovalReference +sidebar_label: ApprovalReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalReference', 'V2025ApprovalReference'] +slug: /tools/sdk/go/v2025/models/approval-reference +tags: ['SDK', 'Software Development Kit', 'ApprovalReference', 'V2025ApprovalReference'] +--- + +# ApprovalReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the reference object | [optional] +**Type** | Pointer to **string** | What reference object does this ID correspond to | [optional] + +## Methods + +### NewApprovalReference + +`func NewApprovalReference() *ApprovalReference` + +NewApprovalReference instantiates a new ApprovalReference 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 + +### NewApprovalReferenceWithDefaults + +`func NewApprovalReferenceWithDefaults() *ApprovalReference` + +NewApprovalReferenceWithDefaults instantiates a new ApprovalReference 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 + +### GetId + +`func (o *ApprovalReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *ApprovalReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ApprovalReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ApprovalReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ApprovalReference) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalReminderAndEscalationConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalReminderAndEscalationConfig.md new file mode 100644 index 000000000..eb94d6fcd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalReminderAndEscalationConfig.md @@ -0,0 +1,182 @@ +--- +id: v2025-approval-reminder-and-escalation-config +title: ApprovalReminderAndEscalationConfig +pagination_label: ApprovalReminderAndEscalationConfig +sidebar_label: ApprovalReminderAndEscalationConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalReminderAndEscalationConfig', 'V2025ApprovalReminderAndEscalationConfig'] +slug: /tools/sdk/go/v2025/models/approval-reminder-and-escalation-config +tags: ['SDK', 'Software Development Kit', 'ApprovalReminderAndEscalationConfig', 'V2025ApprovalReminderAndEscalationConfig'] +--- + +# ApprovalReminderAndEscalationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DaysUntilEscalation** | Pointer to **NullableInt32** | Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. | [optional] +**DaysBetweenReminders** | Pointer to **NullableInt32** | Number of days to wait between reminder notifications. | [optional] +**MaxReminders** | Pointer to **NullableInt32** | Maximum number of reminder notification to send to the reviewer before approval escalation. | [optional] +**FallbackApproverRef** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] + +## Methods + +### NewApprovalReminderAndEscalationConfig + +`func NewApprovalReminderAndEscalationConfig() *ApprovalReminderAndEscalationConfig` + +NewApprovalReminderAndEscalationConfig instantiates a new ApprovalReminderAndEscalationConfig 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 + +### NewApprovalReminderAndEscalationConfigWithDefaults + +`func NewApprovalReminderAndEscalationConfigWithDefaults() *ApprovalReminderAndEscalationConfig` + +NewApprovalReminderAndEscalationConfigWithDefaults instantiates a new ApprovalReminderAndEscalationConfig 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 + +### GetDaysUntilEscalation + +`func (o *ApprovalReminderAndEscalationConfig) GetDaysUntilEscalation() int32` + +GetDaysUntilEscalation returns the DaysUntilEscalation field if non-nil, zero value otherwise. + +### GetDaysUntilEscalationOk + +`func (o *ApprovalReminderAndEscalationConfig) GetDaysUntilEscalationOk() (*int32, bool)` + +GetDaysUntilEscalationOk returns a tuple with the DaysUntilEscalation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDaysUntilEscalation + +`func (o *ApprovalReminderAndEscalationConfig) SetDaysUntilEscalation(v int32)` + +SetDaysUntilEscalation sets DaysUntilEscalation field to given value. + +### HasDaysUntilEscalation + +`func (o *ApprovalReminderAndEscalationConfig) HasDaysUntilEscalation() bool` + +HasDaysUntilEscalation returns a boolean if a field has been set. + +### SetDaysUntilEscalationNil + +`func (o *ApprovalReminderAndEscalationConfig) SetDaysUntilEscalationNil(b bool)` + + SetDaysUntilEscalationNil sets the value for DaysUntilEscalation to be an explicit nil + +### UnsetDaysUntilEscalation +`func (o *ApprovalReminderAndEscalationConfig) UnsetDaysUntilEscalation()` + +UnsetDaysUntilEscalation ensures that no value is present for DaysUntilEscalation, not even an explicit nil +### GetDaysBetweenReminders + +`func (o *ApprovalReminderAndEscalationConfig) GetDaysBetweenReminders() int32` + +GetDaysBetweenReminders returns the DaysBetweenReminders field if non-nil, zero value otherwise. + +### GetDaysBetweenRemindersOk + +`func (o *ApprovalReminderAndEscalationConfig) GetDaysBetweenRemindersOk() (*int32, bool)` + +GetDaysBetweenRemindersOk returns a tuple with the DaysBetweenReminders field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDaysBetweenReminders + +`func (o *ApprovalReminderAndEscalationConfig) SetDaysBetweenReminders(v int32)` + +SetDaysBetweenReminders sets DaysBetweenReminders field to given value. + +### HasDaysBetweenReminders + +`func (o *ApprovalReminderAndEscalationConfig) HasDaysBetweenReminders() bool` + +HasDaysBetweenReminders returns a boolean if a field has been set. + +### SetDaysBetweenRemindersNil + +`func (o *ApprovalReminderAndEscalationConfig) SetDaysBetweenRemindersNil(b bool)` + + SetDaysBetweenRemindersNil sets the value for DaysBetweenReminders to be an explicit nil + +### UnsetDaysBetweenReminders +`func (o *ApprovalReminderAndEscalationConfig) UnsetDaysBetweenReminders()` + +UnsetDaysBetweenReminders ensures that no value is present for DaysBetweenReminders, not even an explicit nil +### GetMaxReminders + +`func (o *ApprovalReminderAndEscalationConfig) GetMaxReminders() int32` + +GetMaxReminders returns the MaxReminders field if non-nil, zero value otherwise. + +### GetMaxRemindersOk + +`func (o *ApprovalReminderAndEscalationConfig) GetMaxRemindersOk() (*int32, bool)` + +GetMaxRemindersOk returns a tuple with the MaxReminders field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxReminders + +`func (o *ApprovalReminderAndEscalationConfig) SetMaxReminders(v int32)` + +SetMaxReminders sets MaxReminders field to given value. + +### HasMaxReminders + +`func (o *ApprovalReminderAndEscalationConfig) HasMaxReminders() bool` + +HasMaxReminders returns a boolean if a field has been set. + +### SetMaxRemindersNil + +`func (o *ApprovalReminderAndEscalationConfig) SetMaxRemindersNil(b bool)` + + SetMaxRemindersNil sets the value for MaxReminders to be an explicit nil + +### UnsetMaxReminders +`func (o *ApprovalReminderAndEscalationConfig) UnsetMaxReminders()` + +UnsetMaxReminders ensures that no value is present for MaxReminders, not even an explicit nil +### GetFallbackApproverRef + +`func (o *ApprovalReminderAndEscalationConfig) GetFallbackApproverRef() IdentityReferenceWithNameAndEmail` + +GetFallbackApproverRef returns the FallbackApproverRef field if non-nil, zero value otherwise. + +### GetFallbackApproverRefOk + +`func (o *ApprovalReminderAndEscalationConfig) GetFallbackApproverRefOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetFallbackApproverRefOk returns a tuple with the FallbackApproverRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFallbackApproverRef + +`func (o *ApprovalReminderAndEscalationConfig) SetFallbackApproverRef(v IdentityReferenceWithNameAndEmail)` + +SetFallbackApproverRef sets FallbackApproverRef field to given value. + +### HasFallbackApproverRef + +`func (o *ApprovalReminderAndEscalationConfig) HasFallbackApproverRef() bool` + +HasFallbackApproverRef returns a boolean if a field has been set. + +### SetFallbackApproverRefNil + +`func (o *ApprovalReminderAndEscalationConfig) SetFallbackApproverRefNil(b bool)` + + SetFallbackApproverRefNil sets the value for FallbackApproverRef to be an explicit nil + +### UnsetFallbackApproverRef +`func (o *ApprovalReminderAndEscalationConfig) UnsetFallbackApproverRef()` + +UnsetFallbackApproverRef ensures that no value is present for FallbackApproverRef, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalScheme.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalScheme.md new file mode 100644 index 000000000..7c1243470 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalScheme.md @@ -0,0 +1,31 @@ +--- +id: v2025-approval-scheme +title: ApprovalScheme +pagination_label: ApprovalScheme +sidebar_label: ApprovalScheme +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalScheme', 'V2025ApprovalScheme'] +slug: /tools/sdk/go/v2025/models/approval-scheme +tags: ['SDK', 'Software Development Kit', 'ApprovalScheme', 'V2025ApprovalScheme'] +--- + +# ApprovalScheme + +## Enum + + +* `APP_OWNER` (value: `"APP_OWNER"`) + +* `SOURCE_OWNER` (value: `"SOURCE_OWNER"`) + +* `MANAGER` (value: `"MANAGER"`) + +* `ROLE_OWNER` (value: `"ROLE_OWNER"`) + +* `ACCESS_PROFILE_OWNER` (value: `"ACCESS_PROFILE_OWNER"`) + +* `ENTITLEMENT_OWNER` (value: `"ENTITLEMENT_OWNER"`) + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalSchemeForRole.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalSchemeForRole.md new file mode 100644 index 000000000..b4648cd41 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalSchemeForRole.md @@ -0,0 +1,100 @@ +--- +id: v2025-approval-scheme-for-role +title: ApprovalSchemeForRole +pagination_label: ApprovalSchemeForRole +sidebar_label: ApprovalSchemeForRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalSchemeForRole', 'V2025ApprovalSchemeForRole'] +slug: /tools/sdk/go/v2025/models/approval-scheme-for-role +tags: ['SDK', 'Software Development Kit', 'ApprovalSchemeForRole', 'V2025ApprovalSchemeForRole'] +--- + +# ApprovalSchemeForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApproverType** | Pointer to **string** | Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | Pointer to **NullableString** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] + +## Methods + +### NewApprovalSchemeForRole + +`func NewApprovalSchemeForRole() *ApprovalSchemeForRole` + +NewApprovalSchemeForRole instantiates a new ApprovalSchemeForRole 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 + +### NewApprovalSchemeForRoleWithDefaults + +`func NewApprovalSchemeForRoleWithDefaults() *ApprovalSchemeForRole` + +NewApprovalSchemeForRoleWithDefaults instantiates a new ApprovalSchemeForRole 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 + +### GetApproverType + +`func (o *ApprovalSchemeForRole) GetApproverType() string` + +GetApproverType returns the ApproverType field if non-nil, zero value otherwise. + +### GetApproverTypeOk + +`func (o *ApprovalSchemeForRole) GetApproverTypeOk() (*string, bool)` + +GetApproverTypeOk returns a tuple with the ApproverType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverType + +`func (o *ApprovalSchemeForRole) SetApproverType(v string)` + +SetApproverType sets ApproverType field to given value. + +### HasApproverType + +`func (o *ApprovalSchemeForRole) HasApproverType() bool` + +HasApproverType returns a boolean if a field has been set. + +### GetApproverId + +`func (o *ApprovalSchemeForRole) GetApproverId() string` + +GetApproverId returns the ApproverId field if non-nil, zero value otherwise. + +### GetApproverIdOk + +`func (o *ApprovalSchemeForRole) GetApproverIdOk() (*string, bool)` + +GetApproverIdOk returns a tuple with the ApproverId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverId + +`func (o *ApprovalSchemeForRole) SetApproverId(v string)` + +SetApproverId sets ApproverId field to given value. + +### HasApproverId + +`func (o *ApprovalSchemeForRole) HasApproverId() bool` + +HasApproverId returns a boolean if a field has been set. + +### SetApproverIdNil + +`func (o *ApprovalSchemeForRole) SetApproverIdNil(b bool)` + + SetApproverIdNil sets the value for ApproverId to be an explicit nil + +### UnsetApproverId +`func (o *ApprovalSchemeForRole) UnsetApproverId()` + +UnsetApproverId ensures that no value is present for ApproverId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalStatus.md new file mode 100644 index 000000000..c05b06f0b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalStatus.md @@ -0,0 +1,27 @@ +--- +id: v2025-approval-status +title: ApprovalStatus +pagination_label: ApprovalStatus +sidebar_label: ApprovalStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalStatus', 'V2025ApprovalStatus'] +slug: /tools/sdk/go/v2025/models/approval-status +tags: ['SDK', 'Software Development Kit', 'ApprovalStatus', 'V2025ApprovalStatus'] +--- + +# ApprovalStatus + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `PENDING` (value: `"PENDING"`) + +* `NOT_READY` (value: `"NOT_READY"`) + +* `CANCELLED` (value: `"CANCELLED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalStatusDto.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalStatusDto.md new file mode 100644 index 000000000..d169c28a7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalStatusDto.md @@ -0,0 +1,312 @@ +--- +id: v2025-approval-status-dto +title: ApprovalStatusDto +pagination_label: ApprovalStatusDto +sidebar_label: ApprovalStatusDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalStatusDto', 'V2025ApprovalStatusDto'] +slug: /tools/sdk/go/v2025/models/approval-status-dto +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto', 'V2025ApprovalStatusDto'] +--- + +# ApprovalStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Forwarded** | Pointer to **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to false] +**OriginalOwner** | Pointer to [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional] +**CurrentOwner** | Pointer to [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional] +**Modified** | Pointer to **NullableTime** | Time at which item was modified. | [optional] +**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**Scheme** | Pointer to [**ApprovalScheme**](approval-scheme) | | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | If the request failed, includes any error messages that were generated. | [optional] +**Comment** | Pointer to **NullableString** | Comment, if any, provided by the approver. | [optional] +**RemoveDate** | Pointer to **NullableTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] + +## Methods + +### NewApprovalStatusDto + +`func NewApprovalStatusDto() *ApprovalStatusDto` + +NewApprovalStatusDto instantiates a new ApprovalStatusDto 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 + +### NewApprovalStatusDtoWithDefaults + +`func NewApprovalStatusDtoWithDefaults() *ApprovalStatusDto` + +NewApprovalStatusDtoWithDefaults instantiates a new ApprovalStatusDto 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 + +### GetForwarded + +`func (o *ApprovalStatusDto) GetForwarded() bool` + +GetForwarded returns the Forwarded field if non-nil, zero value otherwise. + +### GetForwardedOk + +`func (o *ApprovalStatusDto) GetForwardedOk() (*bool, bool)` + +GetForwardedOk returns a tuple with the Forwarded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwarded + +`func (o *ApprovalStatusDto) SetForwarded(v bool)` + +SetForwarded sets Forwarded field to given value. + +### HasForwarded + +`func (o *ApprovalStatusDto) HasForwarded() bool` + +HasForwarded returns a boolean if a field has been set. + +### GetOriginalOwner + +`func (o *ApprovalStatusDto) GetOriginalOwner() ApprovalStatusDtoOriginalOwner` + +GetOriginalOwner returns the OriginalOwner field if non-nil, zero value otherwise. + +### GetOriginalOwnerOk + +`func (o *ApprovalStatusDto) GetOriginalOwnerOk() (*ApprovalStatusDtoOriginalOwner, bool)` + +GetOriginalOwnerOk returns a tuple with the OriginalOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalOwner + +`func (o *ApprovalStatusDto) SetOriginalOwner(v ApprovalStatusDtoOriginalOwner)` + +SetOriginalOwner sets OriginalOwner field to given value. + +### HasOriginalOwner + +`func (o *ApprovalStatusDto) HasOriginalOwner() bool` + +HasOriginalOwner returns a boolean if a field has been set. + +### GetCurrentOwner + +`func (o *ApprovalStatusDto) GetCurrentOwner() ApprovalStatusDtoCurrentOwner` + +GetCurrentOwner returns the CurrentOwner field if non-nil, zero value otherwise. + +### GetCurrentOwnerOk + +`func (o *ApprovalStatusDto) GetCurrentOwnerOk() (*ApprovalStatusDtoCurrentOwner, bool)` + +GetCurrentOwnerOk returns a tuple with the CurrentOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentOwner + +`func (o *ApprovalStatusDto) SetCurrentOwner(v ApprovalStatusDtoCurrentOwner)` + +SetCurrentOwner sets CurrentOwner field to given value. + +### HasCurrentOwner + +`func (o *ApprovalStatusDto) HasCurrentOwner() bool` + +HasCurrentOwner returns a boolean if a field has been set. + +### GetModified + +`func (o *ApprovalStatusDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ApprovalStatusDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ApprovalStatusDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ApprovalStatusDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *ApprovalStatusDto) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *ApprovalStatusDto) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetStatus + +`func (o *ApprovalStatusDto) GetStatus() ManualWorkItemState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ApprovalStatusDto) GetStatusOk() (*ManualWorkItemState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ApprovalStatusDto) SetStatus(v ManualWorkItemState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ApprovalStatusDto) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetScheme + +`func (o *ApprovalStatusDto) GetScheme() ApprovalScheme` + +GetScheme returns the Scheme field if non-nil, zero value otherwise. + +### GetSchemeOk + +`func (o *ApprovalStatusDto) GetSchemeOk() (*ApprovalScheme, bool)` + +GetSchemeOk returns a tuple with the Scheme field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheme + +`func (o *ApprovalStatusDto) SetScheme(v ApprovalScheme)` + +SetScheme sets Scheme field to given value. + +### HasScheme + +`func (o *ApprovalStatusDto) HasScheme() bool` + +HasScheme returns a boolean if a field has been set. + +### GetErrorMessages + +`func (o *ApprovalStatusDto) GetErrorMessages() []ErrorMessageDto` + +GetErrorMessages returns the ErrorMessages field if non-nil, zero value otherwise. + +### GetErrorMessagesOk + +`func (o *ApprovalStatusDto) GetErrorMessagesOk() (*[]ErrorMessageDto, bool)` + +GetErrorMessagesOk returns a tuple with the ErrorMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessages + +`func (o *ApprovalStatusDto) SetErrorMessages(v []ErrorMessageDto)` + +SetErrorMessages sets ErrorMessages field to given value. + +### HasErrorMessages + +`func (o *ApprovalStatusDto) HasErrorMessages() bool` + +HasErrorMessages returns a boolean if a field has been set. + +### SetErrorMessagesNil + +`func (o *ApprovalStatusDto) SetErrorMessagesNil(b bool)` + + SetErrorMessagesNil sets the value for ErrorMessages to be an explicit nil + +### UnsetErrorMessages +`func (o *ApprovalStatusDto) UnsetErrorMessages()` + +UnsetErrorMessages ensures that no value is present for ErrorMessages, not even an explicit nil +### GetComment + +`func (o *ApprovalStatusDto) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ApprovalStatusDto) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ApprovalStatusDto) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ApprovalStatusDto) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *ApprovalStatusDto) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *ApprovalStatusDto) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetRemoveDate + +`func (o *ApprovalStatusDto) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *ApprovalStatusDto) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *ApprovalStatusDto) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *ApprovalStatusDto) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *ApprovalStatusDto) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *ApprovalStatusDto) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalStatusDtoCurrentOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalStatusDtoCurrentOwner.md new file mode 100644 index 000000000..5cd04d488 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalStatusDtoCurrentOwner.md @@ -0,0 +1,116 @@ +--- +id: v2025-approval-status-dto-current-owner +title: ApprovalStatusDtoCurrentOwner +pagination_label: ApprovalStatusDtoCurrentOwner +sidebar_label: ApprovalStatusDtoCurrentOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalStatusDtoCurrentOwner', 'V2025ApprovalStatusDtoCurrentOwner'] +slug: /tools/sdk/go/v2025/models/approval-status-dto-current-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoCurrentOwner', 'V2025ApprovalStatusDtoCurrentOwner'] +--- + +# ApprovalStatusDtoCurrentOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity who reviewed the access item request. | [optional] +**Id** | Pointer to **string** | ID of identity who reviewed the access item request. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity who reviewed the access item request. | [optional] + +## Methods + +### NewApprovalStatusDtoCurrentOwner + +`func NewApprovalStatusDtoCurrentOwner() *ApprovalStatusDtoCurrentOwner` + +NewApprovalStatusDtoCurrentOwner instantiates a new ApprovalStatusDtoCurrentOwner 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 + +### NewApprovalStatusDtoCurrentOwnerWithDefaults + +`func NewApprovalStatusDtoCurrentOwnerWithDefaults() *ApprovalStatusDtoCurrentOwner` + +NewApprovalStatusDtoCurrentOwnerWithDefaults instantiates a new ApprovalStatusDtoCurrentOwner 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 + +### GetType + +`func (o *ApprovalStatusDtoCurrentOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ApprovalStatusDtoCurrentOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ApprovalStatusDtoCurrentOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ApprovalStatusDtoCurrentOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ApprovalStatusDtoCurrentOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalStatusDtoCurrentOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalStatusDtoCurrentOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalStatusDtoCurrentOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalStatusDtoCurrentOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalStatusDtoCurrentOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalStatusDtoCurrentOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalStatusDtoCurrentOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalStatusDtoOriginalOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalStatusDtoOriginalOwner.md new file mode 100644 index 000000000..7f7733840 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalStatusDtoOriginalOwner.md @@ -0,0 +1,116 @@ +--- +id: v2025-approval-status-dto-original-owner +title: ApprovalStatusDtoOriginalOwner +pagination_label: ApprovalStatusDtoOriginalOwner +sidebar_label: ApprovalStatusDtoOriginalOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalStatusDtoOriginalOwner', 'V2025ApprovalStatusDtoOriginalOwner'] +slug: /tools/sdk/go/v2025/models/approval-status-dto-original-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoOriginalOwner', 'V2025ApprovalStatusDtoOriginalOwner'] +--- + +# ApprovalStatusDtoOriginalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of original approval owner's identity. | [optional] +**Id** | Pointer to **string** | ID of original approval owner's identity. | [optional] +**Name** | Pointer to **string** | Display name of original approval owner. | [optional] + +## Methods + +### NewApprovalStatusDtoOriginalOwner + +`func NewApprovalStatusDtoOriginalOwner() *ApprovalStatusDtoOriginalOwner` + +NewApprovalStatusDtoOriginalOwner instantiates a new ApprovalStatusDtoOriginalOwner 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 + +### NewApprovalStatusDtoOriginalOwnerWithDefaults + +`func NewApprovalStatusDtoOriginalOwnerWithDefaults() *ApprovalStatusDtoOriginalOwner` + +NewApprovalStatusDtoOriginalOwnerWithDefaults instantiates a new ApprovalStatusDtoOriginalOwner 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 + +### GetType + +`func (o *ApprovalStatusDtoOriginalOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ApprovalStatusDtoOriginalOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ApprovalStatusDtoOriginalOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ApprovalStatusDtoOriginalOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ApprovalStatusDtoOriginalOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalStatusDtoOriginalOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalStatusDtoOriginalOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalStatusDtoOriginalOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalStatusDtoOriginalOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalStatusDtoOriginalOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalStatusDtoOriginalOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalStatusDtoOriginalOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ApprovalSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalSummary.md new file mode 100644 index 000000000..4a5b009b1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ApprovalSummary.md @@ -0,0 +1,116 @@ +--- +id: v2025-approval-summary +title: ApprovalSummary +pagination_label: ApprovalSummary +sidebar_label: ApprovalSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalSummary', 'V2025ApprovalSummary'] +slug: /tools/sdk/go/v2025/models/approval-summary +tags: ['SDK', 'Software Development Kit', 'ApprovalSummary', 'V2025ApprovalSummary'] +--- + +# ApprovalSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Pending** | Pointer to **int32** | The number of pending access requests approvals. | [optional] +**Approved** | Pointer to **int32** | The number of approved access requests approvals. | [optional] +**Rejected** | Pointer to **int32** | The number of rejected access requests approvals. | [optional] + +## Methods + +### NewApprovalSummary + +`func NewApprovalSummary() *ApprovalSummary` + +NewApprovalSummary instantiates a new ApprovalSummary 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 + +### NewApprovalSummaryWithDefaults + +`func NewApprovalSummaryWithDefaults() *ApprovalSummary` + +NewApprovalSummaryWithDefaults instantiates a new ApprovalSummary 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 + +### GetPending + +`func (o *ApprovalSummary) GetPending() int32` + +GetPending returns the Pending field if non-nil, zero value otherwise. + +### GetPendingOk + +`func (o *ApprovalSummary) GetPendingOk() (*int32, bool)` + +GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPending + +`func (o *ApprovalSummary) SetPending(v int32)` + +SetPending sets Pending field to given value. + +### HasPending + +`func (o *ApprovalSummary) HasPending() bool` + +HasPending returns a boolean if a field has been set. + +### GetApproved + +`func (o *ApprovalSummary) GetApproved() int32` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *ApprovalSummary) GetApprovedOk() (*int32, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *ApprovalSummary) SetApproved(v int32)` + +SetApproved sets Approved field to given value. + +### HasApproved + +`func (o *ApprovalSummary) HasApproved() bool` + +HasApproved returns a boolean if a field has been set. + +### GetRejected + +`func (o *ApprovalSummary) GetRejected() int32` + +GetRejected returns the Rejected field if non-nil, zero value otherwise. + +### GetRejectedOk + +`func (o *ApprovalSummary) GetRejectedOk() (*int32, bool)` + +GetRejectedOk returns a tuple with the Rejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRejected + +`func (o *ApprovalSummary) SetRejected(v int32)` + +SetRejected sets Rejected field to given value. + +### HasRejected + +`func (o *ApprovalSummary) HasRejected() bool` + +HasRejected returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Argument.md b/docs/tools/sdk/go/Reference/V2025/Models/Argument.md new file mode 100644 index 000000000..8d382f7d0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Argument.md @@ -0,0 +1,131 @@ +--- +id: v2025-argument +title: Argument +pagination_label: Argument +sidebar_label: Argument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Argument', 'V2025Argument'] +slug: /tools/sdk/go/v2025/models/argument +tags: ['SDK', 'Software Development Kit', 'Argument', 'V2025Argument'] +--- + +# Argument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | the name of the argument | +**Description** | Pointer to **NullableString** | the description of the argument | [optional] +**Type** | Pointer to **NullableString** | the programmatic type of the argument | [optional] + +## Methods + +### NewArgument + +`func NewArgument(name string, ) *Argument` + +NewArgument instantiates a new Argument 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 + +### NewArgumentWithDefaults + +`func NewArgumentWithDefaults() *Argument` + +NewArgumentWithDefaults instantiates a new Argument 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 + +### GetName + +`func (o *Argument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Argument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Argument) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Argument) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Argument) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Argument) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Argument) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Argument) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Argument) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *Argument) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Argument) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Argument) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Argument) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *Argument) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *Argument) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ArrayInner.md b/docs/tools/sdk/go/Reference/V2025/Models/ArrayInner.md new file mode 100644 index 000000000..79ba86c35 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ArrayInner.md @@ -0,0 +1,38 @@ +--- +id: v2025-array-inner +title: ArrayInner +pagination_label: ArrayInner +sidebar_label: ArrayInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ArrayInner', 'V2025ArrayInner'] +slug: /tools/sdk/go/v2025/models/array-inner +tags: ['SDK', 'Software Development Kit', 'ArrayInner', 'V2025ArrayInner'] +--- + +# ArrayInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewArrayInner + +`func NewArrayInner() *ArrayInner` + +NewArrayInner instantiates a new ArrayInner 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 + +### NewArrayInnerWithDefaults + +`func NewArrayInnerWithDefaults() *ArrayInner` + +NewArrayInnerWithDefaults instantiates a new ArrayInner 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 + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AssignmentContextDto.md b/docs/tools/sdk/go/Reference/V2025/Models/AssignmentContextDto.md new file mode 100644 index 000000000..b270a8f4d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AssignmentContextDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-assignment-context-dto +title: AssignmentContextDto +pagination_label: AssignmentContextDto +sidebar_label: AssignmentContextDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AssignmentContextDto', 'V2025AssignmentContextDto'] +slug: /tools/sdk/go/v2025/models/assignment-context-dto +tags: ['SDK', 'Software Development Kit', 'AssignmentContextDto', 'V2025AssignmentContextDto'] +--- + +# AssignmentContextDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Requested** | Pointer to [**AccessRequestContext**](access-request-context) | | [optional] +**Matched** | Pointer to [**[]RoleMatchDto**](role-match-dto) | | [optional] +**ComputedDate** | Pointer to **string** | Date that the assignment will was evaluated | [optional] + +## Methods + +### NewAssignmentContextDto + +`func NewAssignmentContextDto() *AssignmentContextDto` + +NewAssignmentContextDto instantiates a new AssignmentContextDto 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 + +### NewAssignmentContextDtoWithDefaults + +`func NewAssignmentContextDtoWithDefaults() *AssignmentContextDto` + +NewAssignmentContextDtoWithDefaults instantiates a new AssignmentContextDto 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 + +### GetRequested + +`func (o *AssignmentContextDto) GetRequested() AccessRequestContext` + +GetRequested returns the Requested field if non-nil, zero value otherwise. + +### GetRequestedOk + +`func (o *AssignmentContextDto) GetRequestedOk() (*AccessRequestContext, bool)` + +GetRequestedOk returns a tuple with the Requested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequested + +`func (o *AssignmentContextDto) SetRequested(v AccessRequestContext)` + +SetRequested sets Requested field to given value. + +### HasRequested + +`func (o *AssignmentContextDto) HasRequested() bool` + +HasRequested returns a boolean if a field has been set. + +### GetMatched + +`func (o *AssignmentContextDto) GetMatched() []RoleMatchDto` + +GetMatched returns the Matched field if non-nil, zero value otherwise. + +### GetMatchedOk + +`func (o *AssignmentContextDto) GetMatchedOk() (*[]RoleMatchDto, bool)` + +GetMatchedOk returns a tuple with the Matched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatched + +`func (o *AssignmentContextDto) SetMatched(v []RoleMatchDto)` + +SetMatched sets Matched field to given value. + +### HasMatched + +`func (o *AssignmentContextDto) HasMatched() bool` + +HasMatched returns a boolean if a field has been set. + +### GetComputedDate + +`func (o *AssignmentContextDto) GetComputedDate() string` + +GetComputedDate returns the ComputedDate field if non-nil, zero value otherwise. + +### GetComputedDateOk + +`func (o *AssignmentContextDto) GetComputedDateOk() (*string, bool)` + +GetComputedDateOk returns a tuple with the ComputedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComputedDate + +`func (o *AssignmentContextDto) SetComputedDate(v string)` + +SetComputedDate sets ComputedDate field to given value. + +### HasComputedDate + +`func (o *AssignmentContextDto) HasComputedDate() bool` + +HasComputedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AttrSyncSource.md b/docs/tools/sdk/go/Reference/V2025/Models/AttrSyncSource.md new file mode 100644 index 000000000..41cf3e128 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AttrSyncSource.md @@ -0,0 +1,126 @@ +--- +id: v2025-attr-sync-source +title: AttrSyncSource +pagination_label: AttrSyncSource +sidebar_label: AttrSyncSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttrSyncSource', 'V2025AttrSyncSource'] +slug: /tools/sdk/go/v2025/models/attr-sync-source +tags: ['SDK', 'Software Development Kit', 'AttrSyncSource', 'V2025AttrSyncSource'] +--- + +# AttrSyncSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of target source for attribute synchronization. | [optional] +**Id** | Pointer to **string** | ID of target source for attribute synchronization. | [optional] +**Name** | Pointer to **NullableString** | Human-readable name of target source for attribute synchronization. | [optional] + +## Methods + +### NewAttrSyncSource + +`func NewAttrSyncSource() *AttrSyncSource` + +NewAttrSyncSource instantiates a new AttrSyncSource 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 + +### NewAttrSyncSourceWithDefaults + +`func NewAttrSyncSourceWithDefaults() *AttrSyncSource` + +NewAttrSyncSourceWithDefaults instantiates a new AttrSyncSource 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 + +### GetType + +`func (o *AttrSyncSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttrSyncSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttrSyncSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttrSyncSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AttrSyncSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AttrSyncSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AttrSyncSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AttrSyncSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AttrSyncSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttrSyncSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttrSyncSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttrSyncSource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *AttrSyncSource) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *AttrSyncSource) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AttrSyncSourceAttributeConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/AttrSyncSourceAttributeConfig.md new file mode 100644 index 000000000..fedb25463 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AttrSyncSourceAttributeConfig.md @@ -0,0 +1,122 @@ +--- +id: v2025-attr-sync-source-attribute-config +title: AttrSyncSourceAttributeConfig +pagination_label: AttrSyncSourceAttributeConfig +sidebar_label: AttrSyncSourceAttributeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttrSyncSourceAttributeConfig', 'V2025AttrSyncSourceAttributeConfig'] +slug: /tools/sdk/go/v2025/models/attr-sync-source-attribute-config +tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceAttributeConfig', 'V2025AttrSyncSourceAttributeConfig'] +--- + +# AttrSyncSourceAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Name of the identity attribute | +**DisplayName** | **string** | Display name of the identity attribute | +**Enabled** | **bool** | Determines whether or not the attribute is enabled for synchronization | +**Target** | **string** | Name of the source account attribute to which the identity attribute value will be synchronized if enabled | + +## Methods + +### NewAttrSyncSourceAttributeConfig + +`func NewAttrSyncSourceAttributeConfig(name string, displayName string, enabled bool, target string, ) *AttrSyncSourceAttributeConfig` + +NewAttrSyncSourceAttributeConfig instantiates a new AttrSyncSourceAttributeConfig 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 + +### NewAttrSyncSourceAttributeConfigWithDefaults + +`func NewAttrSyncSourceAttributeConfigWithDefaults() *AttrSyncSourceAttributeConfig` + +NewAttrSyncSourceAttributeConfigWithDefaults instantiates a new AttrSyncSourceAttributeConfig 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 + +### GetName + +`func (o *AttrSyncSourceAttributeConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttrSyncSourceAttributeConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttrSyncSourceAttributeConfig) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDisplayName + +`func (o *AttrSyncSourceAttributeConfig) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AttrSyncSourceAttributeConfig) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AttrSyncSourceAttributeConfig) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + + +### GetEnabled + +`func (o *AttrSyncSourceAttributeConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AttrSyncSourceAttributeConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AttrSyncSourceAttributeConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetTarget + +`func (o *AttrSyncSourceAttributeConfig) GetTarget() string` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *AttrSyncSourceAttributeConfig) GetTargetOk() (*string, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *AttrSyncSourceAttributeConfig) SetTarget(v string)` + +SetTarget sets Target field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AttrSyncSourceConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/AttrSyncSourceConfig.md new file mode 100644 index 000000000..010e1f10f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AttrSyncSourceConfig.md @@ -0,0 +1,80 @@ +--- +id: v2025-attr-sync-source-config +title: AttrSyncSourceConfig +pagination_label: AttrSyncSourceConfig +sidebar_label: AttrSyncSourceConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttrSyncSourceConfig', 'V2025AttrSyncSourceConfig'] +slug: /tools/sdk/go/v2025/models/attr-sync-source-config +tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceConfig', 'V2025AttrSyncSourceConfig'] +--- + +# AttrSyncSourceConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**AttrSyncSource**](attr-sync-source) | | +**Attributes** | [**[]AttrSyncSourceAttributeConfig**](attr-sync-source-attribute-config) | Attribute synchronization configuration for specific identity attributes in the context of a source | + +## Methods + +### NewAttrSyncSourceConfig + +`func NewAttrSyncSourceConfig(source AttrSyncSource, attributes []AttrSyncSourceAttributeConfig, ) *AttrSyncSourceConfig` + +NewAttrSyncSourceConfig instantiates a new AttrSyncSourceConfig 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 + +### NewAttrSyncSourceConfigWithDefaults + +`func NewAttrSyncSourceConfigWithDefaults() *AttrSyncSourceConfig` + +NewAttrSyncSourceConfigWithDefaults instantiates a new AttrSyncSourceConfig 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 + +### GetSource + +`func (o *AttrSyncSourceConfig) GetSource() AttrSyncSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AttrSyncSourceConfig) GetSourceOk() (*AttrSyncSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AttrSyncSourceConfig) SetSource(v AttrSyncSource)` + +SetSource sets Source field to given value. + + +### GetAttributes + +`func (o *AttrSyncSourceConfig) GetAttributes() []AttrSyncSourceAttributeConfig` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AttrSyncSourceConfig) GetAttributesOk() (*[]AttrSyncSourceAttributeConfig, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AttrSyncSourceConfig) SetAttributes(v []AttrSyncSourceAttributeConfig)` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AttributeChange.md b/docs/tools/sdk/go/Reference/V2025/Models/AttributeChange.md new file mode 100644 index 000000000..3c68ef2bd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AttributeChange.md @@ -0,0 +1,116 @@ +--- +id: v2025-attribute-change +title: AttributeChange +pagination_label: AttributeChange +sidebar_label: AttributeChange +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeChange', 'V2025AttributeChange'] +slug: /tools/sdk/go/v2025/models/attribute-change +tags: ['SDK', 'Software Development Kit', 'AttributeChange', 'V2025AttributeChange'] +--- + +# AttributeChange + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | the attribute name | [optional] +**PreviousValue** | Pointer to **string** | the old value of attribute | [optional] +**NewValue** | Pointer to **string** | the new value of attribute | [optional] + +## Methods + +### NewAttributeChange + +`func NewAttributeChange() *AttributeChange` + +NewAttributeChange instantiates a new AttributeChange 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 + +### NewAttributeChangeWithDefaults + +`func NewAttributeChangeWithDefaults() *AttributeChange` + +NewAttributeChangeWithDefaults instantiates a new AttributeChange 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 + +### GetName + +`func (o *AttributeChange) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeChange) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeChange) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeChange) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPreviousValue + +`func (o *AttributeChange) GetPreviousValue() string` + +GetPreviousValue returns the PreviousValue field if non-nil, zero value otherwise. + +### GetPreviousValueOk + +`func (o *AttributeChange) GetPreviousValueOk() (*string, bool)` + +GetPreviousValueOk returns a tuple with the PreviousValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousValue + +`func (o *AttributeChange) SetPreviousValue(v string)` + +SetPreviousValue sets PreviousValue field to given value. + +### HasPreviousValue + +`func (o *AttributeChange) HasPreviousValue() bool` + +HasPreviousValue returns a boolean if a field has been set. + +### GetNewValue + +`func (o *AttributeChange) GetNewValue() string` + +GetNewValue returns the NewValue field if non-nil, zero value otherwise. + +### GetNewValueOk + +`func (o *AttributeChange) GetNewValueOk() (*string, bool)` + +GetNewValueOk returns a tuple with the NewValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewValue + +`func (o *AttributeChange) SetNewValue(v string)` + +SetNewValue sets NewValue field to given value. + +### HasNewValue + +`func (o *AttributeChange) HasNewValue() bool` + +HasNewValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AttributeDTO.md b/docs/tools/sdk/go/Reference/V2025/Models/AttributeDTO.md new file mode 100644 index 000000000..f92f261f6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AttributeDTO.md @@ -0,0 +1,266 @@ +--- +id: v2025-attribute-dto +title: AttributeDTO +pagination_label: AttributeDTO +sidebar_label: AttributeDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDTO', 'V2025AttributeDTO'] +slug: /tools/sdk/go/v2025/models/attribute-dto +tags: ['SDK', 'Software Development Kit', 'AttributeDTO', 'V2025AttributeDTO'] +--- + +# AttributeDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [optional] +**Name** | Pointer to **string** | The display name of the key. | [optional] +**Multiselect** | Pointer to **bool** | Indicates whether the attribute can have multiple values. | [optional] [default to false] +**Status** | Pointer to **string** | The status of the Attribute. | [optional] +**Type** | Pointer to **string** | The type of the Attribute. This can be either \"custom\" or \"governance\". | [optional] +**ObjectTypes** | Pointer to **[]string** | An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. | [optional] +**Description** | Pointer to **string** | The description of the Attribute. | [optional] +**Values** | Pointer to [**[]AttributeValueDTO**](attribute-value-dto) | | [optional] + +## Methods + +### NewAttributeDTO + +`func NewAttributeDTO() *AttributeDTO` + +NewAttributeDTO instantiates a new AttributeDTO 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 + +### NewAttributeDTOWithDefaults + +`func NewAttributeDTOWithDefaults() *AttributeDTO` + +NewAttributeDTOWithDefaults instantiates a new AttributeDTO 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 + +### GetKey + +`func (o *AttributeDTO) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *AttributeDTO) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *AttributeDTO) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *AttributeDTO) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *AttributeDTO) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeDTO) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeDTO) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeDTO) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetMultiselect + +`func (o *AttributeDTO) GetMultiselect() bool` + +GetMultiselect returns the Multiselect field if non-nil, zero value otherwise. + +### GetMultiselectOk + +`func (o *AttributeDTO) GetMultiselectOk() (*bool, bool)` + +GetMultiselectOk returns a tuple with the Multiselect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultiselect + +`func (o *AttributeDTO) SetMultiselect(v bool)` + +SetMultiselect sets Multiselect field to given value. + +### HasMultiselect + +`func (o *AttributeDTO) HasMultiselect() bool` + +HasMultiselect returns a boolean if a field has been set. + +### GetStatus + +`func (o *AttributeDTO) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AttributeDTO) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AttributeDTO) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AttributeDTO) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetType + +`func (o *AttributeDTO) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttributeDTO) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttributeDTO) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttributeDTO) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetObjectTypes + +`func (o *AttributeDTO) GetObjectTypes() []string` + +GetObjectTypes returns the ObjectTypes field if non-nil, zero value otherwise. + +### GetObjectTypesOk + +`func (o *AttributeDTO) GetObjectTypesOk() (*[]string, bool)` + +GetObjectTypesOk returns a tuple with the ObjectTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectTypes + +`func (o *AttributeDTO) SetObjectTypes(v []string)` + +SetObjectTypes sets ObjectTypes field to given value. + +### HasObjectTypes + +`func (o *AttributeDTO) HasObjectTypes() bool` + +HasObjectTypes returns a boolean if a field has been set. + +### SetObjectTypesNil + +`func (o *AttributeDTO) SetObjectTypesNil(b bool)` + + SetObjectTypesNil sets the value for ObjectTypes to be an explicit nil + +### UnsetObjectTypes +`func (o *AttributeDTO) UnsetObjectTypes()` + +UnsetObjectTypes ensures that no value is present for ObjectTypes, not even an explicit nil +### GetDescription + +`func (o *AttributeDTO) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AttributeDTO) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AttributeDTO) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AttributeDTO) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetValues + +`func (o *AttributeDTO) GetValues() []AttributeValueDTO` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *AttributeDTO) GetValuesOk() (*[]AttributeValueDTO, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *AttributeDTO) SetValues(v []AttributeValueDTO)` + +SetValues sets Values field to given value. + +### HasValues + +`func (o *AttributeDTO) HasValues() bool` + +HasValues returns a boolean if a field has been set. + +### SetValuesNil + +`func (o *AttributeDTO) SetValuesNil(b bool)` + + SetValuesNil sets the value for Values to be an explicit nil + +### UnsetValues +`func (o *AttributeDTO) UnsetValues()` + +UnsetValues ensures that no value is present for Values, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AttributeDTOList.md b/docs/tools/sdk/go/Reference/V2025/Models/AttributeDTOList.md new file mode 100644 index 000000000..ee64b4db1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AttributeDTOList.md @@ -0,0 +1,74 @@ +--- +id: v2025-attribute-dto-list +title: AttributeDTOList +pagination_label: AttributeDTOList +sidebar_label: AttributeDTOList +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDTOList', 'V2025AttributeDTOList'] +slug: /tools/sdk/go/v2025/models/attribute-dto-list +tags: ['SDK', 'Software Development Kit', 'AttributeDTOList', 'V2025AttributeDTOList'] +--- + +# AttributeDTOList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]AttributeDTO**](attribute-dto) | | [optional] + +## Methods + +### NewAttributeDTOList + +`func NewAttributeDTOList() *AttributeDTOList` + +NewAttributeDTOList instantiates a new AttributeDTOList 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 + +### NewAttributeDTOListWithDefaults + +`func NewAttributeDTOListWithDefaults() *AttributeDTOList` + +NewAttributeDTOListWithDefaults instantiates a new AttributeDTOList 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 + +### GetAttributes + +`func (o *AttributeDTOList) GetAttributes() []AttributeDTO` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AttributeDTOList) GetAttributesOk() (*[]AttributeDTO, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AttributeDTOList) SetAttributes(v []AttributeDTO)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *AttributeDTOList) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *AttributeDTOList) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *AttributeDTOList) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AttributeDefinition.md b/docs/tools/sdk/go/Reference/V2025/Models/AttributeDefinition.md new file mode 100644 index 000000000..d80445dfa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AttributeDefinition.md @@ -0,0 +1,230 @@ +--- +id: v2025-attribute-definition +title: AttributeDefinition +pagination_label: AttributeDefinition +sidebar_label: AttributeDefinition +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDefinition', 'V2025AttributeDefinition'] +slug: /tools/sdk/go/v2025/models/attribute-definition +tags: ['SDK', 'Software Development Kit', 'AttributeDefinition', 'V2025AttributeDefinition'] +--- + +# AttributeDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the attribute. | [optional] +**Type** | Pointer to [**AttributeDefinitionType**](attribute-definition-type) | | [optional] +**Schema** | Pointer to [**NullableAttributeDefinitionSchema**](attribute-definition-schema) | | [optional] +**Description** | Pointer to **string** | A human-readable description of the attribute. | [optional] +**IsMulti** | Pointer to **bool** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to false] +**IsEntitlement** | Pointer to **bool** | Flag indicating whether or not the attribute is an entitlement. | [optional] [default to false] +**IsGroup** | Pointer to **bool** | Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. | [optional] [default to false] + +## Methods + +### NewAttributeDefinition + +`func NewAttributeDefinition() *AttributeDefinition` + +NewAttributeDefinition instantiates a new AttributeDefinition 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 + +### NewAttributeDefinitionWithDefaults + +`func NewAttributeDefinitionWithDefaults() *AttributeDefinition` + +NewAttributeDefinitionWithDefaults instantiates a new AttributeDefinition 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 + +### GetName + +`func (o *AttributeDefinition) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeDefinition) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeDefinition) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeDefinition) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *AttributeDefinition) GetType() AttributeDefinitionType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttributeDefinition) GetTypeOk() (*AttributeDefinitionType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttributeDefinition) SetType(v AttributeDefinitionType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttributeDefinition) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSchema + +`func (o *AttributeDefinition) GetSchema() AttributeDefinitionSchema` + +GetSchema returns the Schema field if non-nil, zero value otherwise. + +### GetSchemaOk + +`func (o *AttributeDefinition) GetSchemaOk() (*AttributeDefinitionSchema, bool)` + +GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchema + +`func (o *AttributeDefinition) SetSchema(v AttributeDefinitionSchema)` + +SetSchema sets Schema field to given value. + +### HasSchema + +`func (o *AttributeDefinition) HasSchema() bool` + +HasSchema returns a boolean if a field has been set. + +### SetSchemaNil + +`func (o *AttributeDefinition) SetSchemaNil(b bool)` + + SetSchemaNil sets the value for Schema to be an explicit nil + +### UnsetSchema +`func (o *AttributeDefinition) UnsetSchema()` + +UnsetSchema ensures that no value is present for Schema, not even an explicit nil +### GetDescription + +`func (o *AttributeDefinition) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AttributeDefinition) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AttributeDefinition) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AttributeDefinition) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIsMulti + +`func (o *AttributeDefinition) GetIsMulti() bool` + +GetIsMulti returns the IsMulti field if non-nil, zero value otherwise. + +### GetIsMultiOk + +`func (o *AttributeDefinition) GetIsMultiOk() (*bool, bool)` + +GetIsMultiOk returns a tuple with the IsMulti field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsMulti + +`func (o *AttributeDefinition) SetIsMulti(v bool)` + +SetIsMulti sets IsMulti field to given value. + +### HasIsMulti + +`func (o *AttributeDefinition) HasIsMulti() bool` + +HasIsMulti returns a boolean if a field has been set. + +### GetIsEntitlement + +`func (o *AttributeDefinition) GetIsEntitlement() bool` + +GetIsEntitlement returns the IsEntitlement field if non-nil, zero value otherwise. + +### GetIsEntitlementOk + +`func (o *AttributeDefinition) GetIsEntitlementOk() (*bool, bool)` + +GetIsEntitlementOk returns a tuple with the IsEntitlement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsEntitlement + +`func (o *AttributeDefinition) SetIsEntitlement(v bool)` + +SetIsEntitlement sets IsEntitlement field to given value. + +### HasIsEntitlement + +`func (o *AttributeDefinition) HasIsEntitlement() bool` + +HasIsEntitlement returns a boolean if a field has been set. + +### GetIsGroup + +`func (o *AttributeDefinition) GetIsGroup() bool` + +GetIsGroup returns the IsGroup field if non-nil, zero value otherwise. + +### GetIsGroupOk + +`func (o *AttributeDefinition) GetIsGroupOk() (*bool, bool)` + +GetIsGroupOk returns a tuple with the IsGroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGroup + +`func (o *AttributeDefinition) SetIsGroup(v bool)` + +SetIsGroup sets IsGroup field to given value. + +### HasIsGroup + +`func (o *AttributeDefinition) HasIsGroup() bool` + +HasIsGroup returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AttributeDefinitionSchema.md b/docs/tools/sdk/go/Reference/V2025/Models/AttributeDefinitionSchema.md new file mode 100644 index 000000000..3f8c3e796 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AttributeDefinitionSchema.md @@ -0,0 +1,116 @@ +--- +id: v2025-attribute-definition-schema +title: AttributeDefinitionSchema +pagination_label: AttributeDefinitionSchema +sidebar_label: AttributeDefinitionSchema +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDefinitionSchema', 'V2025AttributeDefinitionSchema'] +slug: /tools/sdk/go/v2025/models/attribute-definition-schema +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionSchema', 'V2025AttributeDefinitionSchema'] +--- + +# AttributeDefinitionSchema + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of object being referenced | [optional] +**Id** | Pointer to **string** | The object ID this reference applies to. | [optional] +**Name** | Pointer to **string** | The human-readable display name of the object. | [optional] + +## Methods + +### NewAttributeDefinitionSchema + +`func NewAttributeDefinitionSchema() *AttributeDefinitionSchema` + +NewAttributeDefinitionSchema instantiates a new AttributeDefinitionSchema 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 + +### NewAttributeDefinitionSchemaWithDefaults + +`func NewAttributeDefinitionSchemaWithDefaults() *AttributeDefinitionSchema` + +NewAttributeDefinitionSchemaWithDefaults instantiates a new AttributeDefinitionSchema 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 + +### GetType + +`func (o *AttributeDefinitionSchema) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttributeDefinitionSchema) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttributeDefinitionSchema) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttributeDefinitionSchema) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AttributeDefinitionSchema) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AttributeDefinitionSchema) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AttributeDefinitionSchema) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AttributeDefinitionSchema) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AttributeDefinitionSchema) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeDefinitionSchema) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeDefinitionSchema) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeDefinitionSchema) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AttributeDefinitionType.md b/docs/tools/sdk/go/Reference/V2025/Models/AttributeDefinitionType.md new file mode 100644 index 000000000..342a8d0ec --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AttributeDefinitionType.md @@ -0,0 +1,27 @@ +--- +id: v2025-attribute-definition-type +title: AttributeDefinitionType +pagination_label: AttributeDefinitionType +sidebar_label: AttributeDefinitionType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDefinitionType', 'V2025AttributeDefinitionType'] +slug: /tools/sdk/go/v2025/models/attribute-definition-type +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'V2025AttributeDefinitionType'] +--- + +# AttributeDefinitionType + +## Enum + + +* `STRING` (value: `"STRING"`) + +* `LONG` (value: `"LONG"`) + +* `INT` (value: `"INT"`) + +* `BOOLEAN` (value: `"BOOLEAN"`) + +* `DATE` (value: `"DATE"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AttributeRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/AttributeRequest.md new file mode 100644 index 000000000..831d801b7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AttributeRequest.md @@ -0,0 +1,116 @@ +--- +id: v2025-attribute-request +title: AttributeRequest +pagination_label: AttributeRequest +sidebar_label: AttributeRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeRequest', 'V2025AttributeRequest'] +slug: /tools/sdk/go/v2025/models/attribute-request +tags: ['SDK', 'Software Development Kit', 'AttributeRequest', 'V2025AttributeRequest'] +--- + +# AttributeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Attribute name. | [optional] +**Op** | Pointer to **string** | Operation to perform on attribute. | [optional] +**Value** | Pointer to [**AttributeRequestValue**](attribute-request-value) | | [optional] + +## Methods + +### NewAttributeRequest + +`func NewAttributeRequest() *AttributeRequest` + +NewAttributeRequest instantiates a new AttributeRequest 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 + +### NewAttributeRequestWithDefaults + +`func NewAttributeRequestWithDefaults() *AttributeRequest` + +NewAttributeRequestWithDefaults instantiates a new AttributeRequest 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 + +### GetName + +`func (o *AttributeRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOp + +`func (o *AttributeRequest) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *AttributeRequest) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *AttributeRequest) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *AttributeRequest) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetValue + +`func (o *AttributeRequest) GetValue() AttributeRequestValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AttributeRequest) GetValueOk() (*AttributeRequestValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AttributeRequest) SetValue(v AttributeRequestValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AttributeRequest) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AttributeRequestValue.md b/docs/tools/sdk/go/Reference/V2025/Models/AttributeRequestValue.md new file mode 100644 index 000000000..474c8f9cf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AttributeRequestValue.md @@ -0,0 +1,38 @@ +--- +id: v2025-attribute-request-value +title: AttributeRequestValue +pagination_label: AttributeRequestValue +sidebar_label: AttributeRequestValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeRequestValue', 'V2025AttributeRequestValue'] +slug: /tools/sdk/go/v2025/models/attribute-request-value +tags: ['SDK', 'Software Development Kit', 'AttributeRequestValue', 'V2025AttributeRequestValue'] +--- + +# AttributeRequestValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewAttributeRequestValue + +`func NewAttributeRequestValue() *AttributeRequestValue` + +NewAttributeRequestValue instantiates a new AttributeRequestValue 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 + +### NewAttributeRequestValueWithDefaults + +`func NewAttributeRequestValueWithDefaults() *AttributeRequestValue` + +NewAttributeRequestValueWithDefaults instantiates a new AttributeRequestValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AttributeValueDTO.md b/docs/tools/sdk/go/Reference/V2025/Models/AttributeValueDTO.md new file mode 100644 index 000000000..abbbae1ca --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AttributeValueDTO.md @@ -0,0 +1,116 @@ +--- +id: v2025-attribute-value-dto +title: AttributeValueDTO +pagination_label: AttributeValueDTO +sidebar_label: AttributeValueDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeValueDTO', 'V2025AttributeValueDTO'] +slug: /tools/sdk/go/v2025/models/attribute-value-dto +tags: ['SDK', 'Software Development Kit', 'AttributeValueDTO', 'V2025AttributeValueDTO'] +--- + +# AttributeValueDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [optional] +**Name** | Pointer to **string** | The display name of the Attribute value. | [optional] +**Status** | Pointer to **string** | The status of the Attribute value. | [optional] + +## Methods + +### NewAttributeValueDTO + +`func NewAttributeValueDTO() *AttributeValueDTO` + +NewAttributeValueDTO instantiates a new AttributeValueDTO 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 + +### NewAttributeValueDTOWithDefaults + +`func NewAttributeValueDTOWithDefaults() *AttributeValueDTO` + +NewAttributeValueDTOWithDefaults instantiates a new AttributeValueDTO 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 + +### GetValue + +`func (o *AttributeValueDTO) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AttributeValueDTO) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AttributeValueDTO) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AttributeValueDTO) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetName + +`func (o *AttributeValueDTO) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeValueDTO) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeValueDTO) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeValueDTO) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *AttributeValueDTO) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AttributeValueDTO) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AttributeValueDTO) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AttributeValueDTO) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AttributesChanged.md b/docs/tools/sdk/go/Reference/V2025/Models/AttributesChanged.md new file mode 100644 index 000000000..b432f62a7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AttributesChanged.md @@ -0,0 +1,142 @@ +--- +id: v2025-attributes-changed +title: AttributesChanged +pagination_label: AttributesChanged +sidebar_label: AttributesChanged +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributesChanged', 'V2025AttributesChanged'] +slug: /tools/sdk/go/v2025/models/attributes-changed +tags: ['SDK', 'Software Development Kit', 'AttributesChanged', 'V2025AttributesChanged'] +--- + +# AttributesChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Changes** | Pointer to [**[]AttributeChange**](attribute-change) | | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] + +## Methods + +### NewAttributesChanged + +`func NewAttributesChanged() *AttributesChanged` + +NewAttributesChanged instantiates a new AttributesChanged 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 + +### NewAttributesChangedWithDefaults + +`func NewAttributesChangedWithDefaults() *AttributesChanged` + +NewAttributesChangedWithDefaults instantiates a new AttributesChanged 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 + +### GetChanges + +`func (o *AttributesChanged) GetChanges() []AttributeChange` + +GetChanges returns the Changes field if non-nil, zero value otherwise. + +### GetChangesOk + +`func (o *AttributesChanged) GetChangesOk() (*[]AttributeChange, bool)` + +GetChangesOk returns a tuple with the Changes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanges + +`func (o *AttributesChanged) SetChanges(v []AttributeChange)` + +SetChanges sets Changes field to given value. + +### HasChanges + +`func (o *AttributesChanged) HasChanges() bool` + +HasChanges returns a boolean if a field has been set. + +### GetEventType + +`func (o *AttributesChanged) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *AttributesChanged) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *AttributesChanged) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *AttributesChanged) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *AttributesChanged) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *AttributesChanged) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *AttributesChanged) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *AttributesChanged) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetDt + +`func (o *AttributesChanged) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *AttributesChanged) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *AttributesChanged) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *AttributesChanged) HasDt() bool` + +HasDt returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AuditDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/AuditDetails.md new file mode 100644 index 000000000..3bad4e22c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AuditDetails.md @@ -0,0 +1,142 @@ +--- +id: v2025-audit-details +title: AuditDetails +pagination_label: AuditDetails +sidebar_label: AuditDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuditDetails', 'V2025AuditDetails'] +slug: /tools/sdk/go/v2025/models/audit-details +tags: ['SDK', 'Software Development Kit', 'AuditDetails', 'V2025AuditDetails'] +--- + +# AuditDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **SailPointTime** | Initial date and time when the record was created | [optional] +**CreatedBy** | Pointer to [**Identity1**](identity1) | | [optional] +**Modified** | Pointer to **SailPointTime** | Last modified date and time for the record | [optional] +**ModifiedBy** | Pointer to [**Identity1**](identity1) | | [optional] + +## Methods + +### NewAuditDetails + +`func NewAuditDetails() *AuditDetails` + +NewAuditDetails instantiates a new AuditDetails 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 + +### NewAuditDetailsWithDefaults + +`func NewAuditDetailsWithDefaults() *AuditDetails` + +NewAuditDetailsWithDefaults instantiates a new AuditDetails 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 + +### GetCreated + +`func (o *AuditDetails) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AuditDetails) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AuditDetails) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AuditDetails) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetCreatedBy + +`func (o *AuditDetails) GetCreatedBy() Identity1` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *AuditDetails) GetCreatedByOk() (*Identity1, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *AuditDetails) SetCreatedBy(v Identity1)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *AuditDetails) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetModified + +`func (o *AuditDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AuditDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AuditDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AuditDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetModifiedBy + +`func (o *AuditDetails) GetModifiedBy() Identity1` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *AuditDetails) GetModifiedByOk() (*Identity1, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedBy + +`func (o *AuditDetails) SetModifiedBy(v Identity1)` + +SetModifiedBy sets ModifiedBy field to given value. + +### HasModifiedBy + +`func (o *AuditDetails) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AuthProfile.md b/docs/tools/sdk/go/Reference/V2025/Models/AuthProfile.md new file mode 100644 index 000000000..da4972c81 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AuthProfile.md @@ -0,0 +1,240 @@ +--- +id: v2025-auth-profile +title: AuthProfile +pagination_label: AuthProfile +sidebar_label: AuthProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuthProfile', 'V2025AuthProfile'] +slug: /tools/sdk/go/v2025/models/auth-profile +tags: ['SDK', 'Software Development Kit', 'AuthProfile', 'V2025AuthProfile'] +--- + +# AuthProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Authentication Profile name. | [optional] +**OffNetwork** | Pointer to **bool** | Use it to block access from off network. | [optional] [default to false] +**UntrustedGeography** | Pointer to **bool** | Use it to block access from untrusted geoographies. | [optional] [default to false] +**ApplicationId** | Pointer to **NullableString** | Application ID. | [optional] +**ApplicationName** | Pointer to **NullableString** | Application name. | [optional] +**Type** | Pointer to **string** | Type of the Authentication Profile. | [optional] +**StrongAuthLogin** | Pointer to **bool** | Use it to enable strong authentication. | [optional] [default to false] + +## Methods + +### NewAuthProfile + +`func NewAuthProfile() *AuthProfile` + +NewAuthProfile instantiates a new AuthProfile 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 + +### NewAuthProfileWithDefaults + +`func NewAuthProfileWithDefaults() *AuthProfile` + +NewAuthProfileWithDefaults instantiates a new AuthProfile 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 + +### GetName + +`func (o *AuthProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AuthProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AuthProfile) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AuthProfile) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOffNetwork + +`func (o *AuthProfile) GetOffNetwork() bool` + +GetOffNetwork returns the OffNetwork field if non-nil, zero value otherwise. + +### GetOffNetworkOk + +`func (o *AuthProfile) GetOffNetworkOk() (*bool, bool)` + +GetOffNetworkOk returns a tuple with the OffNetwork field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOffNetwork + +`func (o *AuthProfile) SetOffNetwork(v bool)` + +SetOffNetwork sets OffNetwork field to given value. + +### HasOffNetwork + +`func (o *AuthProfile) HasOffNetwork() bool` + +HasOffNetwork returns a boolean if a field has been set. + +### GetUntrustedGeography + +`func (o *AuthProfile) GetUntrustedGeography() bool` + +GetUntrustedGeography returns the UntrustedGeography field if non-nil, zero value otherwise. + +### GetUntrustedGeographyOk + +`func (o *AuthProfile) GetUntrustedGeographyOk() (*bool, bool)` + +GetUntrustedGeographyOk returns a tuple with the UntrustedGeography field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUntrustedGeography + +`func (o *AuthProfile) SetUntrustedGeography(v bool)` + +SetUntrustedGeography sets UntrustedGeography field to given value. + +### HasUntrustedGeography + +`func (o *AuthProfile) HasUntrustedGeography() bool` + +HasUntrustedGeography returns a boolean if a field has been set. + +### GetApplicationId + +`func (o *AuthProfile) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *AuthProfile) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *AuthProfile) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *AuthProfile) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationIdNil + +`func (o *AuthProfile) SetApplicationIdNil(b bool)` + + SetApplicationIdNil sets the value for ApplicationId to be an explicit nil + +### UnsetApplicationId +`func (o *AuthProfile) UnsetApplicationId()` + +UnsetApplicationId ensures that no value is present for ApplicationId, not even an explicit nil +### GetApplicationName + +`func (o *AuthProfile) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *AuthProfile) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *AuthProfile) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *AuthProfile) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### SetApplicationNameNil + +`func (o *AuthProfile) SetApplicationNameNil(b bool)` + + SetApplicationNameNil sets the value for ApplicationName to be an explicit nil + +### UnsetApplicationName +`func (o *AuthProfile) UnsetApplicationName()` + +UnsetApplicationName ensures that no value is present for ApplicationName, not even an explicit nil +### GetType + +`func (o *AuthProfile) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AuthProfile) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AuthProfile) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AuthProfile) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetStrongAuthLogin + +`func (o *AuthProfile) GetStrongAuthLogin() bool` + +GetStrongAuthLogin returns the StrongAuthLogin field if non-nil, zero value otherwise. + +### GetStrongAuthLoginOk + +`func (o *AuthProfile) GetStrongAuthLoginOk() (*bool, bool)` + +GetStrongAuthLoginOk returns a tuple with the StrongAuthLogin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStrongAuthLogin + +`func (o *AuthProfile) SetStrongAuthLogin(v bool)` + +SetStrongAuthLogin sets StrongAuthLogin field to given value. + +### HasStrongAuthLogin + +`func (o *AuthProfile) HasStrongAuthLogin() bool` + +HasStrongAuthLogin returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AuthProfileSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/AuthProfileSummary.md new file mode 100644 index 000000000..8741d326f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AuthProfileSummary.md @@ -0,0 +1,90 @@ +--- +id: v2025-auth-profile-summary +title: AuthProfileSummary +pagination_label: AuthProfileSummary +sidebar_label: AuthProfileSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuthProfileSummary', 'V2025AuthProfileSummary'] +slug: /tools/sdk/go/v2025/models/auth-profile-summary +tags: ['SDK', 'Software Development Kit', 'AuthProfileSummary', 'V2025AuthProfileSummary'] +--- + +# AuthProfileSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Tenant** | Pointer to **string** | Tenant name. | [optional] +**Id** | Pointer to **string** | Identity ID. | [optional] + +## Methods + +### NewAuthProfileSummary + +`func NewAuthProfileSummary() *AuthProfileSummary` + +NewAuthProfileSummary instantiates a new AuthProfileSummary 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 + +### NewAuthProfileSummaryWithDefaults + +`func NewAuthProfileSummaryWithDefaults() *AuthProfileSummary` + +NewAuthProfileSummaryWithDefaults instantiates a new AuthProfileSummary 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 + +### GetTenant + +`func (o *AuthProfileSummary) GetTenant() string` + +GetTenant returns the Tenant field if non-nil, zero value otherwise. + +### GetTenantOk + +`func (o *AuthProfileSummary) GetTenantOk() (*string, bool)` + +GetTenantOk returns a tuple with the Tenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenant + +`func (o *AuthProfileSummary) SetTenant(v string)` + +SetTenant sets Tenant field to given value. + +### HasTenant + +`func (o *AuthProfileSummary) HasTenant() bool` + +HasTenant returns a boolean if a field has been set. + +### GetId + +`func (o *AuthProfileSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AuthProfileSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AuthProfileSummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AuthProfileSummary) HasId() bool` + +HasId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/AuthUser.md b/docs/tools/sdk/go/Reference/V2025/Models/AuthUser.md new file mode 100644 index 000000000..fc18d6a59 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/AuthUser.md @@ -0,0 +1,606 @@ +--- +id: v2025-auth-user +title: AuthUser +pagination_label: AuthUser +sidebar_label: AuthUser +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuthUser', 'V2025AuthUser'] +slug: /tools/sdk/go/v2025/models/auth-user +tags: ['SDK', 'Software Development Kit', 'AuthUser', 'V2025AuthUser'] +--- + +# AuthUser + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Tenant** | Pointer to **string** | Tenant name. | [optional] +**Id** | Pointer to **string** | Identity ID. | [optional] +**Uid** | Pointer to **string** | Identity's unique identitifier. | [optional] +**Profile** | Pointer to **string** | ID of the auth profile associated with the auth user. | [optional] +**IdentificationNumber** | Pointer to **NullableString** | Auth user's employee number. | [optional] +**Email** | Pointer to **NullableString** | Auth user's email. | [optional] +**Phone** | Pointer to **NullableString** | Auth user's phone number. | [optional] +**WorkPhone** | Pointer to **NullableString** | Auth user's work phone number. | [optional] +**PersonalEmail** | Pointer to **NullableString** | Auth user's personal email. | [optional] +**Firstname** | Pointer to **NullableString** | Auth user's first name. | [optional] +**Lastname** | Pointer to **NullableString** | Auth user's last name. | [optional] +**DisplayName** | Pointer to **string** | Auth user's name in displayed format. | [optional] +**Alias** | Pointer to **string** | Auth user's alias. | [optional] +**LastPasswordChangeDate** | Pointer to **NullableTime** | Date of last password change. | [optional] +**LastLoginTimestamp** | Pointer to **int64** | Timestamp of the last login (long type value). | [optional] +**CurrentLoginTimestamp** | Pointer to **int64** | Timestamp of the current login (long type value). | [optional] +**LastUnlockTimestamp** | Pointer to **NullableTime** | The date and time when the user was last unlocked. | [optional] +**Capabilities** | Pointer to **[]string** | Array of the auth user's capabilities. | [optional] + +## Methods + +### NewAuthUser + +`func NewAuthUser() *AuthUser` + +NewAuthUser instantiates a new AuthUser 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 + +### NewAuthUserWithDefaults + +`func NewAuthUserWithDefaults() *AuthUser` + +NewAuthUserWithDefaults instantiates a new AuthUser 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 + +### GetTenant + +`func (o *AuthUser) GetTenant() string` + +GetTenant returns the Tenant field if non-nil, zero value otherwise. + +### GetTenantOk + +`func (o *AuthUser) GetTenantOk() (*string, bool)` + +GetTenantOk returns a tuple with the Tenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenant + +`func (o *AuthUser) SetTenant(v string)` + +SetTenant sets Tenant field to given value. + +### HasTenant + +`func (o *AuthUser) HasTenant() bool` + +HasTenant returns a boolean if a field has been set. + +### GetId + +`func (o *AuthUser) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AuthUser) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AuthUser) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AuthUser) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetUid + +`func (o *AuthUser) GetUid() string` + +GetUid returns the Uid field if non-nil, zero value otherwise. + +### GetUidOk + +`func (o *AuthUser) GetUidOk() (*string, bool)` + +GetUidOk returns a tuple with the Uid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUid + +`func (o *AuthUser) SetUid(v string)` + +SetUid sets Uid field to given value. + +### HasUid + +`func (o *AuthUser) HasUid() bool` + +HasUid returns a boolean if a field has been set. + +### GetProfile + +`func (o *AuthUser) GetProfile() string` + +GetProfile returns the Profile field if non-nil, zero value otherwise. + +### GetProfileOk + +`func (o *AuthUser) GetProfileOk() (*string, bool)` + +GetProfileOk returns a tuple with the Profile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProfile + +`func (o *AuthUser) SetProfile(v string)` + +SetProfile sets Profile field to given value. + +### HasProfile + +`func (o *AuthUser) HasProfile() bool` + +HasProfile returns a boolean if a field has been set. + +### GetIdentificationNumber + +`func (o *AuthUser) GetIdentificationNumber() string` + +GetIdentificationNumber returns the IdentificationNumber field if non-nil, zero value otherwise. + +### GetIdentificationNumberOk + +`func (o *AuthUser) GetIdentificationNumberOk() (*string, bool)` + +GetIdentificationNumberOk returns a tuple with the IdentificationNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentificationNumber + +`func (o *AuthUser) SetIdentificationNumber(v string)` + +SetIdentificationNumber sets IdentificationNumber field to given value. + +### HasIdentificationNumber + +`func (o *AuthUser) HasIdentificationNumber() bool` + +HasIdentificationNumber returns a boolean if a field has been set. + +### SetIdentificationNumberNil + +`func (o *AuthUser) SetIdentificationNumberNil(b bool)` + + SetIdentificationNumberNil sets the value for IdentificationNumber to be an explicit nil + +### UnsetIdentificationNumber +`func (o *AuthUser) UnsetIdentificationNumber()` + +UnsetIdentificationNumber ensures that no value is present for IdentificationNumber, not even an explicit nil +### GetEmail + +`func (o *AuthUser) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *AuthUser) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *AuthUser) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *AuthUser) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### SetEmailNil + +`func (o *AuthUser) SetEmailNil(b bool)` + + SetEmailNil sets the value for Email to be an explicit nil + +### UnsetEmail +`func (o *AuthUser) UnsetEmail()` + +UnsetEmail ensures that no value is present for Email, not even an explicit nil +### GetPhone + +`func (o *AuthUser) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *AuthUser) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *AuthUser) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *AuthUser) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### SetPhoneNil + +`func (o *AuthUser) SetPhoneNil(b bool)` + + SetPhoneNil sets the value for Phone to be an explicit nil + +### UnsetPhone +`func (o *AuthUser) UnsetPhone()` + +UnsetPhone ensures that no value is present for Phone, not even an explicit nil +### GetWorkPhone + +`func (o *AuthUser) GetWorkPhone() string` + +GetWorkPhone returns the WorkPhone field if non-nil, zero value otherwise. + +### GetWorkPhoneOk + +`func (o *AuthUser) GetWorkPhoneOk() (*string, bool)` + +GetWorkPhoneOk returns a tuple with the WorkPhone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWorkPhone + +`func (o *AuthUser) SetWorkPhone(v string)` + +SetWorkPhone sets WorkPhone field to given value. + +### HasWorkPhone + +`func (o *AuthUser) HasWorkPhone() bool` + +HasWorkPhone returns a boolean if a field has been set. + +### SetWorkPhoneNil + +`func (o *AuthUser) SetWorkPhoneNil(b bool)` + + SetWorkPhoneNil sets the value for WorkPhone to be an explicit nil + +### UnsetWorkPhone +`func (o *AuthUser) UnsetWorkPhone()` + +UnsetWorkPhone ensures that no value is present for WorkPhone, not even an explicit nil +### GetPersonalEmail + +`func (o *AuthUser) GetPersonalEmail() string` + +GetPersonalEmail returns the PersonalEmail field if non-nil, zero value otherwise. + +### GetPersonalEmailOk + +`func (o *AuthUser) GetPersonalEmailOk() (*string, bool)` + +GetPersonalEmailOk returns a tuple with the PersonalEmail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPersonalEmail + +`func (o *AuthUser) SetPersonalEmail(v string)` + +SetPersonalEmail sets PersonalEmail field to given value. + +### HasPersonalEmail + +`func (o *AuthUser) HasPersonalEmail() bool` + +HasPersonalEmail returns a boolean if a field has been set. + +### SetPersonalEmailNil + +`func (o *AuthUser) SetPersonalEmailNil(b bool)` + + SetPersonalEmailNil sets the value for PersonalEmail to be an explicit nil + +### UnsetPersonalEmail +`func (o *AuthUser) UnsetPersonalEmail()` + +UnsetPersonalEmail ensures that no value is present for PersonalEmail, not even an explicit nil +### GetFirstname + +`func (o *AuthUser) GetFirstname() string` + +GetFirstname returns the Firstname field if non-nil, zero value otherwise. + +### GetFirstnameOk + +`func (o *AuthUser) GetFirstnameOk() (*string, bool)` + +GetFirstnameOk returns a tuple with the Firstname field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstname + +`func (o *AuthUser) SetFirstname(v string)` + +SetFirstname sets Firstname field to given value. + +### HasFirstname + +`func (o *AuthUser) HasFirstname() bool` + +HasFirstname returns a boolean if a field has been set. + +### SetFirstnameNil + +`func (o *AuthUser) SetFirstnameNil(b bool)` + + SetFirstnameNil sets the value for Firstname to be an explicit nil + +### UnsetFirstname +`func (o *AuthUser) UnsetFirstname()` + +UnsetFirstname ensures that no value is present for Firstname, not even an explicit nil +### GetLastname + +`func (o *AuthUser) GetLastname() string` + +GetLastname returns the Lastname field if non-nil, zero value otherwise. + +### GetLastnameOk + +`func (o *AuthUser) GetLastnameOk() (*string, bool)` + +GetLastnameOk returns a tuple with the Lastname field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastname + +`func (o *AuthUser) SetLastname(v string)` + +SetLastname sets Lastname field to given value. + +### HasLastname + +`func (o *AuthUser) HasLastname() bool` + +HasLastname returns a boolean if a field has been set. + +### SetLastnameNil + +`func (o *AuthUser) SetLastnameNil(b bool)` + + SetLastnameNil sets the value for Lastname to be an explicit nil + +### UnsetLastname +`func (o *AuthUser) UnsetLastname()` + +UnsetLastname ensures that no value is present for Lastname, not even an explicit nil +### GetDisplayName + +`func (o *AuthUser) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AuthUser) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AuthUser) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AuthUser) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetAlias + +`func (o *AuthUser) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *AuthUser) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *AuthUser) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *AuthUser) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + +### GetLastPasswordChangeDate + +`func (o *AuthUser) GetLastPasswordChangeDate() SailPointTime` + +GetLastPasswordChangeDate returns the LastPasswordChangeDate field if non-nil, zero value otherwise. + +### GetLastPasswordChangeDateOk + +`func (o *AuthUser) GetLastPasswordChangeDateOk() (*SailPointTime, bool)` + +GetLastPasswordChangeDateOk returns a tuple with the LastPasswordChangeDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastPasswordChangeDate + +`func (o *AuthUser) SetLastPasswordChangeDate(v SailPointTime)` + +SetLastPasswordChangeDate sets LastPasswordChangeDate field to given value. + +### HasLastPasswordChangeDate + +`func (o *AuthUser) HasLastPasswordChangeDate() bool` + +HasLastPasswordChangeDate returns a boolean if a field has been set. + +### SetLastPasswordChangeDateNil + +`func (o *AuthUser) SetLastPasswordChangeDateNil(b bool)` + + SetLastPasswordChangeDateNil sets the value for LastPasswordChangeDate to be an explicit nil + +### UnsetLastPasswordChangeDate +`func (o *AuthUser) UnsetLastPasswordChangeDate()` + +UnsetLastPasswordChangeDate ensures that no value is present for LastPasswordChangeDate, not even an explicit nil +### GetLastLoginTimestamp + +`func (o *AuthUser) GetLastLoginTimestamp() int64` + +GetLastLoginTimestamp returns the LastLoginTimestamp field if non-nil, zero value otherwise. + +### GetLastLoginTimestampOk + +`func (o *AuthUser) GetLastLoginTimestampOk() (*int64, bool)` + +GetLastLoginTimestampOk returns a tuple with the LastLoginTimestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastLoginTimestamp + +`func (o *AuthUser) SetLastLoginTimestamp(v int64)` + +SetLastLoginTimestamp sets LastLoginTimestamp field to given value. + +### HasLastLoginTimestamp + +`func (o *AuthUser) HasLastLoginTimestamp() bool` + +HasLastLoginTimestamp returns a boolean if a field has been set. + +### GetCurrentLoginTimestamp + +`func (o *AuthUser) GetCurrentLoginTimestamp() int64` + +GetCurrentLoginTimestamp returns the CurrentLoginTimestamp field if non-nil, zero value otherwise. + +### GetCurrentLoginTimestampOk + +`func (o *AuthUser) GetCurrentLoginTimestampOk() (*int64, bool)` + +GetCurrentLoginTimestampOk returns a tuple with the CurrentLoginTimestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentLoginTimestamp + +`func (o *AuthUser) SetCurrentLoginTimestamp(v int64)` + +SetCurrentLoginTimestamp sets CurrentLoginTimestamp field to given value. + +### HasCurrentLoginTimestamp + +`func (o *AuthUser) HasCurrentLoginTimestamp() bool` + +HasCurrentLoginTimestamp returns a boolean if a field has been set. + +### GetLastUnlockTimestamp + +`func (o *AuthUser) GetLastUnlockTimestamp() SailPointTime` + +GetLastUnlockTimestamp returns the LastUnlockTimestamp field if non-nil, zero value otherwise. + +### GetLastUnlockTimestampOk + +`func (o *AuthUser) GetLastUnlockTimestampOk() (*SailPointTime, bool)` + +GetLastUnlockTimestampOk returns a tuple with the LastUnlockTimestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUnlockTimestamp + +`func (o *AuthUser) SetLastUnlockTimestamp(v SailPointTime)` + +SetLastUnlockTimestamp sets LastUnlockTimestamp field to given value. + +### HasLastUnlockTimestamp + +`func (o *AuthUser) HasLastUnlockTimestamp() bool` + +HasLastUnlockTimestamp returns a boolean if a field has been set. + +### SetLastUnlockTimestampNil + +`func (o *AuthUser) SetLastUnlockTimestampNil(b bool)` + + SetLastUnlockTimestampNil sets the value for LastUnlockTimestamp to be an explicit nil + +### UnsetLastUnlockTimestamp +`func (o *AuthUser) UnsetLastUnlockTimestamp()` + +UnsetLastUnlockTimestamp ensures that no value is present for LastUnlockTimestamp, not even an explicit nil +### GetCapabilities + +`func (o *AuthUser) GetCapabilities() []string` + +GetCapabilities returns the Capabilities field if non-nil, zero value otherwise. + +### GetCapabilitiesOk + +`func (o *AuthUser) GetCapabilitiesOk() (*[]string, bool)` + +GetCapabilitiesOk returns a tuple with the Capabilities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCapabilities + +`func (o *AuthUser) SetCapabilities(v []string)` + +SetCapabilities sets Capabilities field to given value. + +### HasCapabilities + +`func (o *AuthUser) HasCapabilities() bool` + +HasCapabilities returns a boolean if a field has been set. + +### SetCapabilitiesNil + +`func (o *AuthUser) SetCapabilitiesNil(b bool)` + + SetCapabilitiesNil sets the value for Capabilities to be an explicit nil + +### UnsetCapabilities +`func (o *AuthUser) UnsetCapabilities()` + +UnsetCapabilities ensures that no value is present for Capabilities, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BackupOptions.md b/docs/tools/sdk/go/Reference/V2025/Models/BackupOptions.md new file mode 100644 index 000000000..2819d2a10 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BackupOptions.md @@ -0,0 +1,90 @@ +--- +id: v2025-backup-options +title: BackupOptions +pagination_label: BackupOptions +sidebar_label: BackupOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BackupOptions', 'V2025BackupOptions'] +slug: /tools/sdk/go/v2025/models/backup-options +tags: ['SDK', 'Software Development Kit', 'BackupOptions', 'V2025BackupOptions'] +--- + +# BackupOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludeTypes** | Pointer to **[]string** | Object type names to be included in a Configuration Hub backup command. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportNames**](object-export-import-names) | Additional options targeting specific objects related to each item in the includeTypes field. | [optional] + +## Methods + +### NewBackupOptions + +`func NewBackupOptions() *BackupOptions` + +NewBackupOptions instantiates a new BackupOptions 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 + +### NewBackupOptionsWithDefaults + +`func NewBackupOptionsWithDefaults() *BackupOptions` + +NewBackupOptionsWithDefaults instantiates a new BackupOptions 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 + +### GetIncludeTypes + +`func (o *BackupOptions) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *BackupOptions) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *BackupOptions) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *BackupOptions) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *BackupOptions) GetObjectOptions() map[string]ObjectExportImportNames` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *BackupOptions) GetObjectOptionsOk() (*map[string]ObjectExportImportNames, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *BackupOptions) SetObjectOptions(v map[string]ObjectExportImportNames)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *BackupOptions) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BackupOptions1.md b/docs/tools/sdk/go/Reference/V2025/Models/BackupOptions1.md new file mode 100644 index 000000000..bc752a2ff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BackupOptions1.md @@ -0,0 +1,90 @@ +--- +id: v2025-backup-options1 +title: BackupOptions1 +pagination_label: BackupOptions1 +sidebar_label: BackupOptions1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BackupOptions1', 'V2025BackupOptions1'] +slug: /tools/sdk/go/v2025/models/backup-options1 +tags: ['SDK', 'Software Development Kit', 'BackupOptions1', 'V2025BackupOptions1'] +--- + +# BackupOptions1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludeTypes** | Pointer to **[]string** | Object type names to be included in a Configuration Hub backup command. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportNames**](object-export-import-names) | Additional options targeting specific objects related to each item in the includeTypes field. | [optional] + +## Methods + +### NewBackupOptions1 + +`func NewBackupOptions1() *BackupOptions1` + +NewBackupOptions1 instantiates a new BackupOptions1 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 + +### NewBackupOptions1WithDefaults + +`func NewBackupOptions1WithDefaults() *BackupOptions1` + +NewBackupOptions1WithDefaults instantiates a new BackupOptions1 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 + +### GetIncludeTypes + +`func (o *BackupOptions1) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *BackupOptions1) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *BackupOptions1) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *BackupOptions1) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *BackupOptions1) GetObjectOptions() map[string]ObjectExportImportNames` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *BackupOptions1) GetObjectOptionsOk() (*map[string]ObjectExportImportNames, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *BackupOptions1) SetObjectOptions(v map[string]ObjectExportImportNames)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *BackupOptions1) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BackupResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/BackupResponse.md new file mode 100644 index 000000000..8495d835b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BackupResponse.md @@ -0,0 +1,490 @@ +--- +id: v2025-backup-response +title: BackupResponse +pagination_label: BackupResponse +sidebar_label: BackupResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BackupResponse', 'V2025BackupResponse'] +slug: /tools/sdk/go/v2025/models/backup-response +tags: ['SDK', 'Software Development Kit', 'BackupResponse', 'V2025BackupResponse'] +--- + +# BackupResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | Pointer to **string** | Unique id assigned to this backup. | [optional] +**Status** | Pointer to **string** | Status of the backup. | [optional] +**Type** | Pointer to **string** | Type of the job, will always be BACKUP for this type of job. | [optional] +**Tenant** | Pointer to **string** | The name of the tenant performing the upload | [optional] +**RequesterName** | Pointer to **string** | The name of the requester. | [optional] +**FileExists** | Pointer to **bool** | Whether or not a file was created and stored for this backup. | [optional] [default to true] +**Created** | Pointer to **SailPointTime** | The time the job was started. | [optional] +**Modified** | Pointer to **SailPointTime** | The time of the last update to the job. | [optional] +**Completed** | Pointer to **SailPointTime** | The time the job was completed. | [optional] +**Name** | Pointer to **string** | The name assigned to the upload file in the request body. | [optional] +**UserCanDelete** | Pointer to **bool** | Whether this backup can be deleted by a regular user. | [optional] [default to true] +**IsPartial** | Pointer to **bool** | Whether this backup contains all supported object types or only some of them. | [optional] [default to false] +**BackupType** | Pointer to **string** | Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. | [optional] +**Options** | Pointer to [**NullableBackupOptions**](backup-options) | | [optional] +**HydrationStatus** | Pointer to **string** | Whether the object details of this backup are ready. | [optional] +**TotalObjectCount** | Pointer to **int64** | Number of objects contained in this backup. | [optional] +**CloudStorageStatus** | Pointer to **string** | Whether this backup has been transferred to a customer storage location. | [optional] + +## Methods + +### NewBackupResponse + +`func NewBackupResponse() *BackupResponse` + +NewBackupResponse instantiates a new BackupResponse 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 + +### NewBackupResponseWithDefaults + +`func NewBackupResponseWithDefaults() *BackupResponse` + +NewBackupResponseWithDefaults instantiates a new BackupResponse 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 + +### GetJobId + +`func (o *BackupResponse) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *BackupResponse) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *BackupResponse) SetJobId(v string)` + +SetJobId sets JobId field to given value. + +### HasJobId + +`func (o *BackupResponse) HasJobId() bool` + +HasJobId returns a boolean if a field has been set. + +### GetStatus + +`func (o *BackupResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *BackupResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *BackupResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *BackupResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetType + +`func (o *BackupResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BackupResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BackupResponse) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BackupResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetTenant + +`func (o *BackupResponse) GetTenant() string` + +GetTenant returns the Tenant field if non-nil, zero value otherwise. + +### GetTenantOk + +`func (o *BackupResponse) GetTenantOk() (*string, bool)` + +GetTenantOk returns a tuple with the Tenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenant + +`func (o *BackupResponse) SetTenant(v string)` + +SetTenant sets Tenant field to given value. + +### HasTenant + +`func (o *BackupResponse) HasTenant() bool` + +HasTenant returns a boolean if a field has been set. + +### GetRequesterName + +`func (o *BackupResponse) GetRequesterName() string` + +GetRequesterName returns the RequesterName field if non-nil, zero value otherwise. + +### GetRequesterNameOk + +`func (o *BackupResponse) GetRequesterNameOk() (*string, bool)` + +GetRequesterNameOk returns a tuple with the RequesterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterName + +`func (o *BackupResponse) SetRequesterName(v string)` + +SetRequesterName sets RequesterName field to given value. + +### HasRequesterName + +`func (o *BackupResponse) HasRequesterName() bool` + +HasRequesterName returns a boolean if a field has been set. + +### GetFileExists + +`func (o *BackupResponse) GetFileExists() bool` + +GetFileExists returns the FileExists field if non-nil, zero value otherwise. + +### GetFileExistsOk + +`func (o *BackupResponse) GetFileExistsOk() (*bool, bool)` + +GetFileExistsOk returns a tuple with the FileExists field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileExists + +`func (o *BackupResponse) SetFileExists(v bool)` + +SetFileExists sets FileExists field to given value. + +### HasFileExists + +`func (o *BackupResponse) HasFileExists() bool` + +HasFileExists returns a boolean if a field has been set. + +### GetCreated + +`func (o *BackupResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BackupResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BackupResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *BackupResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *BackupResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *BackupResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *BackupResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *BackupResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCompleted + +`func (o *BackupResponse) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *BackupResponse) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *BackupResponse) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *BackupResponse) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetName + +`func (o *BackupResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BackupResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BackupResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BackupResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetUserCanDelete + +`func (o *BackupResponse) GetUserCanDelete() bool` + +GetUserCanDelete returns the UserCanDelete field if non-nil, zero value otherwise. + +### GetUserCanDeleteOk + +`func (o *BackupResponse) GetUserCanDeleteOk() (*bool, bool)` + +GetUserCanDeleteOk returns a tuple with the UserCanDelete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserCanDelete + +`func (o *BackupResponse) SetUserCanDelete(v bool)` + +SetUserCanDelete sets UserCanDelete field to given value. + +### HasUserCanDelete + +`func (o *BackupResponse) HasUserCanDelete() bool` + +HasUserCanDelete returns a boolean if a field has been set. + +### GetIsPartial + +`func (o *BackupResponse) GetIsPartial() bool` + +GetIsPartial returns the IsPartial field if non-nil, zero value otherwise. + +### GetIsPartialOk + +`func (o *BackupResponse) GetIsPartialOk() (*bool, bool)` + +GetIsPartialOk returns a tuple with the IsPartial field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsPartial + +`func (o *BackupResponse) SetIsPartial(v bool)` + +SetIsPartial sets IsPartial field to given value. + +### HasIsPartial + +`func (o *BackupResponse) HasIsPartial() bool` + +HasIsPartial returns a boolean if a field has been set. + +### GetBackupType + +`func (o *BackupResponse) GetBackupType() string` + +GetBackupType returns the BackupType field if non-nil, zero value otherwise. + +### GetBackupTypeOk + +`func (o *BackupResponse) GetBackupTypeOk() (*string, bool)` + +GetBackupTypeOk returns a tuple with the BackupType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackupType + +`func (o *BackupResponse) SetBackupType(v string)` + +SetBackupType sets BackupType field to given value. + +### HasBackupType + +`func (o *BackupResponse) HasBackupType() bool` + +HasBackupType returns a boolean if a field has been set. + +### GetOptions + +`func (o *BackupResponse) GetOptions() BackupOptions` + +GetOptions returns the Options field if non-nil, zero value otherwise. + +### GetOptionsOk + +`func (o *BackupResponse) GetOptionsOk() (*BackupOptions, bool)` + +GetOptionsOk returns a tuple with the Options field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOptions + +`func (o *BackupResponse) SetOptions(v BackupOptions)` + +SetOptions sets Options field to given value. + +### HasOptions + +`func (o *BackupResponse) HasOptions() bool` + +HasOptions returns a boolean if a field has been set. + +### SetOptionsNil + +`func (o *BackupResponse) SetOptionsNil(b bool)` + + SetOptionsNil sets the value for Options to be an explicit nil + +### UnsetOptions +`func (o *BackupResponse) UnsetOptions()` + +UnsetOptions ensures that no value is present for Options, not even an explicit nil +### GetHydrationStatus + +`func (o *BackupResponse) GetHydrationStatus() string` + +GetHydrationStatus returns the HydrationStatus field if non-nil, zero value otherwise. + +### GetHydrationStatusOk + +`func (o *BackupResponse) GetHydrationStatusOk() (*string, bool)` + +GetHydrationStatusOk returns a tuple with the HydrationStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHydrationStatus + +`func (o *BackupResponse) SetHydrationStatus(v string)` + +SetHydrationStatus sets HydrationStatus field to given value. + +### HasHydrationStatus + +`func (o *BackupResponse) HasHydrationStatus() bool` + +HasHydrationStatus returns a boolean if a field has been set. + +### GetTotalObjectCount + +`func (o *BackupResponse) GetTotalObjectCount() int64` + +GetTotalObjectCount returns the TotalObjectCount field if non-nil, zero value otherwise. + +### GetTotalObjectCountOk + +`func (o *BackupResponse) GetTotalObjectCountOk() (*int64, bool)` + +GetTotalObjectCountOk returns a tuple with the TotalObjectCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalObjectCount + +`func (o *BackupResponse) SetTotalObjectCount(v int64)` + +SetTotalObjectCount sets TotalObjectCount field to given value. + +### HasTotalObjectCount + +`func (o *BackupResponse) HasTotalObjectCount() bool` + +HasTotalObjectCount returns a boolean if a field has been set. + +### GetCloudStorageStatus + +`func (o *BackupResponse) GetCloudStorageStatus() string` + +GetCloudStorageStatus returns the CloudStorageStatus field if non-nil, zero value otherwise. + +### GetCloudStorageStatusOk + +`func (o *BackupResponse) GetCloudStorageStatusOk() (*string, bool)` + +GetCloudStorageStatusOk returns a tuple with the CloudStorageStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudStorageStatus + +`func (o *BackupResponse) SetCloudStorageStatus(v string)` + +SetCloudStorageStatus sets CloudStorageStatus field to given value. + +### HasCloudStorageStatus + +`func (o *BackupResponse) HasCloudStorageStatus() bool` + +HasCloudStorageStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BackupResponse1.md b/docs/tools/sdk/go/Reference/V2025/Models/BackupResponse1.md new file mode 100644 index 000000000..0860f101e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BackupResponse1.md @@ -0,0 +1,490 @@ +--- +id: v2025-backup-response1 +title: BackupResponse1 +pagination_label: BackupResponse1 +sidebar_label: BackupResponse1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BackupResponse1', 'V2025BackupResponse1'] +slug: /tools/sdk/go/v2025/models/backup-response1 +tags: ['SDK', 'Software Development Kit', 'BackupResponse1', 'V2025BackupResponse1'] +--- + +# BackupResponse1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | Pointer to **string** | Unique id assigned to this backup. | [optional] +**Status** | Pointer to **string** | Status of the backup. | [optional] +**Type** | Pointer to **string** | Type of the job, will always be BACKUP for this type of job. | [optional] +**Tenant** | Pointer to **string** | The name of the tenant performing the upload | [optional] +**RequesterName** | Pointer to **string** | The name of the requester. | [optional] +**FileExists** | Pointer to **bool** | Whether or not a file was created and stored for this backup. | [optional] [default to true] +**Created** | Pointer to **SailPointTime** | The time the job was started. | [optional] +**Modified** | Pointer to **SailPointTime** | The time of the last update to the job. | [optional] +**Completed** | Pointer to **SailPointTime** | The time the job was completed. | [optional] +**Name** | Pointer to **string** | The name assigned to the upload file in the request body. | [optional] +**UserCanDelete** | Pointer to **bool** | Whether this backup can be deleted by a regular user. | [optional] [default to true] +**IsPartial** | Pointer to **bool** | Whether this backup contains all supported object types or only some of them. | [optional] [default to false] +**BackupType** | Pointer to **string** | Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. | [optional] +**Options** | Pointer to [**NullableBackupOptions1**](backup-options1) | | [optional] +**HydrationStatus** | Pointer to **string** | Whether the object details of this backup are ready. | [optional] +**TotalObjectCount** | Pointer to **int64** | Number of objects contained in this backup. | [optional] +**CloudStorageStatus** | Pointer to **string** | Whether this backup has been transferred to a customer storage location. | [optional] + +## Methods + +### NewBackupResponse1 + +`func NewBackupResponse1() *BackupResponse1` + +NewBackupResponse1 instantiates a new BackupResponse1 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 + +### NewBackupResponse1WithDefaults + +`func NewBackupResponse1WithDefaults() *BackupResponse1` + +NewBackupResponse1WithDefaults instantiates a new BackupResponse1 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 + +### GetJobId + +`func (o *BackupResponse1) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *BackupResponse1) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *BackupResponse1) SetJobId(v string)` + +SetJobId sets JobId field to given value. + +### HasJobId + +`func (o *BackupResponse1) HasJobId() bool` + +HasJobId returns a boolean if a field has been set. + +### GetStatus + +`func (o *BackupResponse1) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *BackupResponse1) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *BackupResponse1) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *BackupResponse1) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetType + +`func (o *BackupResponse1) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BackupResponse1) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BackupResponse1) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BackupResponse1) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetTenant + +`func (o *BackupResponse1) GetTenant() string` + +GetTenant returns the Tenant field if non-nil, zero value otherwise. + +### GetTenantOk + +`func (o *BackupResponse1) GetTenantOk() (*string, bool)` + +GetTenantOk returns a tuple with the Tenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenant + +`func (o *BackupResponse1) SetTenant(v string)` + +SetTenant sets Tenant field to given value. + +### HasTenant + +`func (o *BackupResponse1) HasTenant() bool` + +HasTenant returns a boolean if a field has been set. + +### GetRequesterName + +`func (o *BackupResponse1) GetRequesterName() string` + +GetRequesterName returns the RequesterName field if non-nil, zero value otherwise. + +### GetRequesterNameOk + +`func (o *BackupResponse1) GetRequesterNameOk() (*string, bool)` + +GetRequesterNameOk returns a tuple with the RequesterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterName + +`func (o *BackupResponse1) SetRequesterName(v string)` + +SetRequesterName sets RequesterName field to given value. + +### HasRequesterName + +`func (o *BackupResponse1) HasRequesterName() bool` + +HasRequesterName returns a boolean if a field has been set. + +### GetFileExists + +`func (o *BackupResponse1) GetFileExists() bool` + +GetFileExists returns the FileExists field if non-nil, zero value otherwise. + +### GetFileExistsOk + +`func (o *BackupResponse1) GetFileExistsOk() (*bool, bool)` + +GetFileExistsOk returns a tuple with the FileExists field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileExists + +`func (o *BackupResponse1) SetFileExists(v bool)` + +SetFileExists sets FileExists field to given value. + +### HasFileExists + +`func (o *BackupResponse1) HasFileExists() bool` + +HasFileExists returns a boolean if a field has been set. + +### GetCreated + +`func (o *BackupResponse1) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BackupResponse1) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BackupResponse1) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *BackupResponse1) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *BackupResponse1) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *BackupResponse1) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *BackupResponse1) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *BackupResponse1) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCompleted + +`func (o *BackupResponse1) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *BackupResponse1) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *BackupResponse1) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *BackupResponse1) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetName + +`func (o *BackupResponse1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BackupResponse1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BackupResponse1) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BackupResponse1) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetUserCanDelete + +`func (o *BackupResponse1) GetUserCanDelete() bool` + +GetUserCanDelete returns the UserCanDelete field if non-nil, zero value otherwise. + +### GetUserCanDeleteOk + +`func (o *BackupResponse1) GetUserCanDeleteOk() (*bool, bool)` + +GetUserCanDeleteOk returns a tuple with the UserCanDelete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserCanDelete + +`func (o *BackupResponse1) SetUserCanDelete(v bool)` + +SetUserCanDelete sets UserCanDelete field to given value. + +### HasUserCanDelete + +`func (o *BackupResponse1) HasUserCanDelete() bool` + +HasUserCanDelete returns a boolean if a field has been set. + +### GetIsPartial + +`func (o *BackupResponse1) GetIsPartial() bool` + +GetIsPartial returns the IsPartial field if non-nil, zero value otherwise. + +### GetIsPartialOk + +`func (o *BackupResponse1) GetIsPartialOk() (*bool, bool)` + +GetIsPartialOk returns a tuple with the IsPartial field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsPartial + +`func (o *BackupResponse1) SetIsPartial(v bool)` + +SetIsPartial sets IsPartial field to given value. + +### HasIsPartial + +`func (o *BackupResponse1) HasIsPartial() bool` + +HasIsPartial returns a boolean if a field has been set. + +### GetBackupType + +`func (o *BackupResponse1) GetBackupType() string` + +GetBackupType returns the BackupType field if non-nil, zero value otherwise. + +### GetBackupTypeOk + +`func (o *BackupResponse1) GetBackupTypeOk() (*string, bool)` + +GetBackupTypeOk returns a tuple with the BackupType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackupType + +`func (o *BackupResponse1) SetBackupType(v string)` + +SetBackupType sets BackupType field to given value. + +### HasBackupType + +`func (o *BackupResponse1) HasBackupType() bool` + +HasBackupType returns a boolean if a field has been set. + +### GetOptions + +`func (o *BackupResponse1) GetOptions() BackupOptions1` + +GetOptions returns the Options field if non-nil, zero value otherwise. + +### GetOptionsOk + +`func (o *BackupResponse1) GetOptionsOk() (*BackupOptions1, bool)` + +GetOptionsOk returns a tuple with the Options field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOptions + +`func (o *BackupResponse1) SetOptions(v BackupOptions1)` + +SetOptions sets Options field to given value. + +### HasOptions + +`func (o *BackupResponse1) HasOptions() bool` + +HasOptions returns a boolean if a field has been set. + +### SetOptionsNil + +`func (o *BackupResponse1) SetOptionsNil(b bool)` + + SetOptionsNil sets the value for Options to be an explicit nil + +### UnsetOptions +`func (o *BackupResponse1) UnsetOptions()` + +UnsetOptions ensures that no value is present for Options, not even an explicit nil +### GetHydrationStatus + +`func (o *BackupResponse1) GetHydrationStatus() string` + +GetHydrationStatus returns the HydrationStatus field if non-nil, zero value otherwise. + +### GetHydrationStatusOk + +`func (o *BackupResponse1) GetHydrationStatusOk() (*string, bool)` + +GetHydrationStatusOk returns a tuple with the HydrationStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHydrationStatus + +`func (o *BackupResponse1) SetHydrationStatus(v string)` + +SetHydrationStatus sets HydrationStatus field to given value. + +### HasHydrationStatus + +`func (o *BackupResponse1) HasHydrationStatus() bool` + +HasHydrationStatus returns a boolean if a field has been set. + +### GetTotalObjectCount + +`func (o *BackupResponse1) GetTotalObjectCount() int64` + +GetTotalObjectCount returns the TotalObjectCount field if non-nil, zero value otherwise. + +### GetTotalObjectCountOk + +`func (o *BackupResponse1) GetTotalObjectCountOk() (*int64, bool)` + +GetTotalObjectCountOk returns a tuple with the TotalObjectCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalObjectCount + +`func (o *BackupResponse1) SetTotalObjectCount(v int64)` + +SetTotalObjectCount sets TotalObjectCount field to given value. + +### HasTotalObjectCount + +`func (o *BackupResponse1) HasTotalObjectCount() bool` + +HasTotalObjectCount returns a boolean if a field has been set. + +### GetCloudStorageStatus + +`func (o *BackupResponse1) GetCloudStorageStatus() string` + +GetCloudStorageStatus returns the CloudStorageStatus field if non-nil, zero value otherwise. + +### GetCloudStorageStatusOk + +`func (o *BackupResponse1) GetCloudStorageStatusOk() (*string, bool)` + +GetCloudStorageStatusOk returns a tuple with the CloudStorageStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudStorageStatus + +`func (o *BackupResponse1) SetCloudStorageStatus(v string)` + +SetCloudStorageStatus sets CloudStorageStatus field to given value. + +### HasCloudStorageStatus + +`func (o *BackupResponse1) HasCloudStorageStatus() bool` + +HasCloudStorageStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BaseAccess.md b/docs/tools/sdk/go/Reference/V2025/Models/BaseAccess.md new file mode 100644 index 000000000..be7b5dc69 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BaseAccess.md @@ -0,0 +1,276 @@ +--- +id: v2025-base-access +title: BaseAccess +pagination_label: BaseAccess +sidebar_label: BaseAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseAccess', 'V2025BaseAccess'] +slug: /tools/sdk/go/v2025/models/base-access +tags: ['SDK', 'Software Development Kit', 'BaseAccess', 'V2025BaseAccess'] +--- + +# BaseAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Access item's description. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **NullableTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Enabled** | Pointer to **bool** | Indicates whether the access item is currently enabled. | [optional] [default to false] +**Requestable** | Pointer to **bool** | Indicates whether the access item can be requested. | [optional] [default to true] +**RequestCommentsRequired** | Pointer to **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to false] +**Owner** | Pointer to [**BaseAccessOwner**](base-access-owner) | | [optional] + +## Methods + +### NewBaseAccess + +`func NewBaseAccess() *BaseAccess` + +NewBaseAccess instantiates a new BaseAccess 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 + +### NewBaseAccessWithDefaults + +`func NewBaseAccessWithDefaults() *BaseAccess` + +NewBaseAccessWithDefaults instantiates a new BaseAccess 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 + +### GetDescription + +`func (o *BaseAccess) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *BaseAccess) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *BaseAccess) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *BaseAccess) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetCreated + +`func (o *BaseAccess) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BaseAccess) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BaseAccess) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *BaseAccess) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *BaseAccess) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *BaseAccess) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *BaseAccess) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *BaseAccess) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *BaseAccess) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *BaseAccess) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *BaseAccess) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *BaseAccess) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *BaseAccess) GetSynced() SailPointTime` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *BaseAccess) GetSyncedOk() (*SailPointTime, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *BaseAccess) SetSynced(v SailPointTime)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *BaseAccess) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### SetSyncedNil + +`func (o *BaseAccess) SetSyncedNil(b bool)` + + SetSyncedNil sets the value for Synced to be an explicit nil + +### UnsetSynced +`func (o *BaseAccess) UnsetSynced()` + +UnsetSynced ensures that no value is present for Synced, not even an explicit nil +### GetEnabled + +`func (o *BaseAccess) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *BaseAccess) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *BaseAccess) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *BaseAccess) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetRequestable + +`func (o *BaseAccess) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *BaseAccess) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *BaseAccess) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *BaseAccess) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetRequestCommentsRequired + +`func (o *BaseAccess) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *BaseAccess) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *BaseAccess) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *BaseAccess) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + +### GetOwner + +`func (o *BaseAccess) GetOwner() BaseAccessOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *BaseAccess) GetOwnerOk() (*BaseAccessOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *BaseAccess) SetOwner(v BaseAccessOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *BaseAccess) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BaseAccessOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/BaseAccessOwner.md new file mode 100644 index 000000000..66a2e9ec6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BaseAccessOwner.md @@ -0,0 +1,142 @@ +--- +id: v2025-base-access-owner +title: BaseAccessOwner +pagination_label: BaseAccessOwner +sidebar_label: BaseAccessOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseAccessOwner', 'V2025BaseAccessOwner'] +slug: /tools/sdk/go/v2025/models/base-access-owner +tags: ['SDK', 'Software Development Kit', 'BaseAccessOwner', 'V2025BaseAccessOwner'] +--- + +# BaseAccessOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's DTO type. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's display name. | [optional] +**Email** | Pointer to **string** | Owner's email. | [optional] + +## Methods + +### NewBaseAccessOwner + +`func NewBaseAccessOwner() *BaseAccessOwner` + +NewBaseAccessOwner instantiates a new BaseAccessOwner 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 + +### NewBaseAccessOwnerWithDefaults + +`func NewBaseAccessOwnerWithDefaults() *BaseAccessOwner` + +NewBaseAccessOwnerWithDefaults instantiates a new BaseAccessOwner 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 + +### GetType + +`func (o *BaseAccessOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BaseAccessOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BaseAccessOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BaseAccessOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *BaseAccessOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseAccessOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseAccessOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseAccessOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseAccessOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseAccessOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseAccessOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseAccessOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *BaseAccessOwner) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *BaseAccessOwner) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *BaseAccessOwner) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *BaseAccessOwner) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BaseAccessProfile.md b/docs/tools/sdk/go/Reference/V2025/Models/BaseAccessProfile.md new file mode 100644 index 000000000..d11de88eb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BaseAccessProfile.md @@ -0,0 +1,90 @@ +--- +id: v2025-base-access-profile +title: BaseAccessProfile +pagination_label: BaseAccessProfile +sidebar_label: BaseAccessProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseAccessProfile', 'V2025BaseAccessProfile'] +slug: /tools/sdk/go/v2025/models/base-access-profile +tags: ['SDK', 'Software Development Kit', 'BaseAccessProfile', 'V2025BaseAccessProfile'] +--- + +# BaseAccessProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Access profile's unique ID. | [optional] +**Name** | Pointer to **string** | Access profile's display name. | [optional] + +## Methods + +### NewBaseAccessProfile + +`func NewBaseAccessProfile() *BaseAccessProfile` + +NewBaseAccessProfile instantiates a new BaseAccessProfile 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 + +### NewBaseAccessProfileWithDefaults + +`func NewBaseAccessProfileWithDefaults() *BaseAccessProfile` + +NewBaseAccessProfileWithDefaults instantiates a new BaseAccessProfile 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 + +### GetId + +`func (o *BaseAccessProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseAccessProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseAccessProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseAccessProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseAccessProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseAccessProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseAccessProfile) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseAccessProfile) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BaseAccount.md b/docs/tools/sdk/go/Reference/V2025/Models/BaseAccount.md new file mode 100644 index 000000000..d99c54b93 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BaseAccount.md @@ -0,0 +1,416 @@ +--- +id: v2025-base-account +title: BaseAccount +pagination_label: BaseAccount +sidebar_label: BaseAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseAccount', 'V2025BaseAccount'] +slug: /tools/sdk/go/v2025/models/base-account +tags: ['SDK', 'Software Development Kit', 'BaseAccount', 'V2025BaseAccount'] +--- + +# BaseAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**AccountId** | Pointer to **string** | Account ID. | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] +**Disabled** | Pointer to **bool** | Indicates whether the account is disabled. | [optional] [default to false] +**Locked** | Pointer to **bool** | Indicates whether the account is locked. | [optional] [default to false] +**Privileged** | Pointer to **bool** | Indicates whether the account is privileged. | [optional] [default to false] +**ManuallyCorrelated** | Pointer to **bool** | Indicates whether the account has been manually correlated to an identity. | [optional] [default to false] +**PasswordLastSet** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**EntitlementAttributes** | Pointer to **map[string]interface{}** | Map or dictionary of key/value pairs. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**SupportsPasswordChange** | Pointer to **bool** | Indicates whether the account supports password change. | [optional] [default to false] +**AccountAttributes** | Pointer to **map[string]interface{}** | Map or dictionary of key/value pairs. | [optional] + +## Methods + +### NewBaseAccount + +`func NewBaseAccount() *BaseAccount` + +NewBaseAccount instantiates a new BaseAccount 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 + +### NewBaseAccountWithDefaults + +`func NewBaseAccountWithDefaults() *BaseAccount` + +NewBaseAccountWithDefaults instantiates a new BaseAccount 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 + +### GetId + +`func (o *BaseAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseAccount) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseAccount) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAccountId + +`func (o *BaseAccount) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *BaseAccount) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *BaseAccount) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *BaseAccount) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetSource + +`func (o *BaseAccount) GetSource() AccountSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *BaseAccount) GetSourceOk() (*AccountSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *BaseAccount) SetSource(v AccountSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *BaseAccount) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetDisabled + +`func (o *BaseAccount) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *BaseAccount) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *BaseAccount) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *BaseAccount) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetLocked + +`func (o *BaseAccount) GetLocked() bool` + +GetLocked returns the Locked field if non-nil, zero value otherwise. + +### GetLockedOk + +`func (o *BaseAccount) GetLockedOk() (*bool, bool)` + +GetLockedOk returns a tuple with the Locked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocked + +`func (o *BaseAccount) SetLocked(v bool)` + +SetLocked sets Locked field to given value. + +### HasLocked + +`func (o *BaseAccount) HasLocked() bool` + +HasLocked returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *BaseAccount) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *BaseAccount) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *BaseAccount) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *BaseAccount) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetManuallyCorrelated + +`func (o *BaseAccount) GetManuallyCorrelated() bool` + +GetManuallyCorrelated returns the ManuallyCorrelated field if non-nil, zero value otherwise. + +### GetManuallyCorrelatedOk + +`func (o *BaseAccount) GetManuallyCorrelatedOk() (*bool, bool)` + +GetManuallyCorrelatedOk returns a tuple with the ManuallyCorrelated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyCorrelated + +`func (o *BaseAccount) SetManuallyCorrelated(v bool)` + +SetManuallyCorrelated sets ManuallyCorrelated field to given value. + +### HasManuallyCorrelated + +`func (o *BaseAccount) HasManuallyCorrelated() bool` + +HasManuallyCorrelated returns a boolean if a field has been set. + +### GetPasswordLastSet + +`func (o *BaseAccount) GetPasswordLastSet() SailPointTime` + +GetPasswordLastSet returns the PasswordLastSet field if non-nil, zero value otherwise. + +### GetPasswordLastSetOk + +`func (o *BaseAccount) GetPasswordLastSetOk() (*SailPointTime, bool)` + +GetPasswordLastSetOk returns a tuple with the PasswordLastSet field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordLastSet + +`func (o *BaseAccount) SetPasswordLastSet(v SailPointTime)` + +SetPasswordLastSet sets PasswordLastSet field to given value. + +### HasPasswordLastSet + +`func (o *BaseAccount) HasPasswordLastSet() bool` + +HasPasswordLastSet returns a boolean if a field has been set. + +### SetPasswordLastSetNil + +`func (o *BaseAccount) SetPasswordLastSetNil(b bool)` + + SetPasswordLastSetNil sets the value for PasswordLastSet to be an explicit nil + +### UnsetPasswordLastSet +`func (o *BaseAccount) UnsetPasswordLastSet()` + +UnsetPasswordLastSet ensures that no value is present for PasswordLastSet, not even an explicit nil +### GetEntitlementAttributes + +`func (o *BaseAccount) GetEntitlementAttributes() map[string]interface{}` + +GetEntitlementAttributes returns the EntitlementAttributes field if non-nil, zero value otherwise. + +### GetEntitlementAttributesOk + +`func (o *BaseAccount) GetEntitlementAttributesOk() (*map[string]interface{}, bool)` + +GetEntitlementAttributesOk returns a tuple with the EntitlementAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementAttributes + +`func (o *BaseAccount) SetEntitlementAttributes(v map[string]interface{})` + +SetEntitlementAttributes sets EntitlementAttributes field to given value. + +### HasEntitlementAttributes + +`func (o *BaseAccount) HasEntitlementAttributes() bool` + +HasEntitlementAttributes returns a boolean if a field has been set. + +### SetEntitlementAttributesNil + +`func (o *BaseAccount) SetEntitlementAttributesNil(b bool)` + + SetEntitlementAttributesNil sets the value for EntitlementAttributes to be an explicit nil + +### UnsetEntitlementAttributes +`func (o *BaseAccount) UnsetEntitlementAttributes()` + +UnsetEntitlementAttributes ensures that no value is present for EntitlementAttributes, not even an explicit nil +### GetCreated + +`func (o *BaseAccount) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BaseAccount) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BaseAccount) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *BaseAccount) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *BaseAccount) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *BaseAccount) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetSupportsPasswordChange + +`func (o *BaseAccount) GetSupportsPasswordChange() bool` + +GetSupportsPasswordChange returns the SupportsPasswordChange field if non-nil, zero value otherwise. + +### GetSupportsPasswordChangeOk + +`func (o *BaseAccount) GetSupportsPasswordChangeOk() (*bool, bool)` + +GetSupportsPasswordChangeOk returns a tuple with the SupportsPasswordChange field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportsPasswordChange + +`func (o *BaseAccount) SetSupportsPasswordChange(v bool)` + +SetSupportsPasswordChange sets SupportsPasswordChange field to given value. + +### HasSupportsPasswordChange + +`func (o *BaseAccount) HasSupportsPasswordChange() bool` + +HasSupportsPasswordChange returns a boolean if a field has been set. + +### GetAccountAttributes + +`func (o *BaseAccount) GetAccountAttributes() map[string]interface{}` + +GetAccountAttributes returns the AccountAttributes field if non-nil, zero value otherwise. + +### GetAccountAttributesOk + +`func (o *BaseAccount) GetAccountAttributesOk() (*map[string]interface{}, bool)` + +GetAccountAttributesOk returns a tuple with the AccountAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountAttributes + +`func (o *BaseAccount) SetAccountAttributes(v map[string]interface{})` + +SetAccountAttributes sets AccountAttributes field to given value. + +### HasAccountAttributes + +`func (o *BaseAccount) HasAccountAttributes() bool` + +HasAccountAttributes returns a boolean if a field has been set. + +### SetAccountAttributesNil + +`func (o *BaseAccount) SetAccountAttributesNil(b bool)` + + SetAccountAttributesNil sets the value for AccountAttributes to be an explicit nil + +### UnsetAccountAttributes +`func (o *BaseAccount) UnsetAccountAttributes()` + +UnsetAccountAttributes ensures that no value is present for AccountAttributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BaseCommonDto.md b/docs/tools/sdk/go/Reference/V2025/Models/BaseCommonDto.md new file mode 100644 index 000000000..ae2e0f3e9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BaseCommonDto.md @@ -0,0 +1,147 @@ +--- +id: v2025-base-common-dto +title: BaseCommonDto +pagination_label: BaseCommonDto +sidebar_label: BaseCommonDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseCommonDto', 'V2025BaseCommonDto'] +slug: /tools/sdk/go/v2025/models/base-common-dto +tags: ['SDK', 'Software Development Kit', 'BaseCommonDto', 'V2025BaseCommonDto'] +--- + +# BaseCommonDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] + +## Methods + +### NewBaseCommonDto + +`func NewBaseCommonDto(name NullableString, ) *BaseCommonDto` + +NewBaseCommonDto instantiates a new BaseCommonDto 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 + +### NewBaseCommonDtoWithDefaults + +`func NewBaseCommonDtoWithDefaults() *BaseCommonDto` + +NewBaseCommonDtoWithDefaults instantiates a new BaseCommonDto 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 + +### GetId + +`func (o *BaseCommonDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseCommonDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseCommonDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseCommonDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseCommonDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseCommonDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseCommonDto) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *BaseCommonDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *BaseCommonDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *BaseCommonDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BaseCommonDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BaseCommonDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *BaseCommonDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *BaseCommonDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *BaseCommonDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *BaseCommonDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *BaseCommonDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BaseDocument.md b/docs/tools/sdk/go/Reference/V2025/Models/BaseDocument.md new file mode 100644 index 000000000..80349e8c8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BaseDocument.md @@ -0,0 +1,80 @@ +--- +id: v2025-base-document +title: BaseDocument +pagination_label: BaseDocument +sidebar_label: BaseDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseDocument', 'V2025BaseDocument'] +slug: /tools/sdk/go/v2025/models/base-document +tags: ['SDK', 'Software Development Kit', 'BaseDocument', 'V2025BaseDocument'] +--- + +# BaseDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the referenced object. | +**Name** | **string** | The human readable name of the referenced object. | + +## Methods + +### NewBaseDocument + +`func NewBaseDocument(id string, name string, ) *BaseDocument` + +NewBaseDocument instantiates a new BaseDocument 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 + +### NewBaseDocumentWithDefaults + +`func NewBaseDocumentWithDefaults() *BaseDocument` + +NewBaseDocumentWithDefaults instantiates a new BaseDocument 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 + +### GetId + +`func (o *BaseDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseDocument) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *BaseDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseDocument) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BaseEntitlement.md b/docs/tools/sdk/go/Reference/V2025/Models/BaseEntitlement.md new file mode 100644 index 000000000..fa71a19f0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BaseEntitlement.md @@ -0,0 +1,256 @@ +--- +id: v2025-base-entitlement +title: BaseEntitlement +pagination_label: BaseEntitlement +sidebar_label: BaseEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseEntitlement', 'V2025BaseEntitlement'] +slug: /tools/sdk/go/v2025/models/base-entitlement +tags: ['SDK', 'Software Development Kit', 'BaseEntitlement', 'V2025BaseEntitlement'] +--- + +# BaseEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasPermissions** | Pointer to **bool** | Indicates whether the entitlement has permissions. | [optional] [default to false] +**Description** | Pointer to **NullableString** | Entitlement's description. | [optional] +**Attribute** | Pointer to **string** | Entitlement attribute's name. | [optional] +**Value** | Pointer to **string** | Entitlement's value. | [optional] +**Schema** | Pointer to **string** | Entitlement's schema. | [optional] +**Privileged** | Pointer to **bool** | Indicates whether the entitlement is privileged. | [optional] [default to false] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **string** | Entitlement's name. | [optional] + +## Methods + +### NewBaseEntitlement + +`func NewBaseEntitlement() *BaseEntitlement` + +NewBaseEntitlement instantiates a new BaseEntitlement 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 + +### NewBaseEntitlementWithDefaults + +`func NewBaseEntitlementWithDefaults() *BaseEntitlement` + +NewBaseEntitlementWithDefaults instantiates a new BaseEntitlement 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 + +### GetHasPermissions + +`func (o *BaseEntitlement) GetHasPermissions() bool` + +GetHasPermissions returns the HasPermissions field if non-nil, zero value otherwise. + +### GetHasPermissionsOk + +`func (o *BaseEntitlement) GetHasPermissionsOk() (*bool, bool)` + +GetHasPermissionsOk returns a tuple with the HasPermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasPermissions + +`func (o *BaseEntitlement) SetHasPermissions(v bool)` + +SetHasPermissions sets HasPermissions field to given value. + +### HasHasPermissions + +`func (o *BaseEntitlement) HasHasPermissions() bool` + +HasHasPermissions returns a boolean if a field has been set. + +### GetDescription + +`func (o *BaseEntitlement) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *BaseEntitlement) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *BaseEntitlement) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *BaseEntitlement) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *BaseEntitlement) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *BaseEntitlement) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAttribute + +`func (o *BaseEntitlement) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *BaseEntitlement) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *BaseEntitlement) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *BaseEntitlement) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *BaseEntitlement) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *BaseEntitlement) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *BaseEntitlement) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *BaseEntitlement) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSchema + +`func (o *BaseEntitlement) GetSchema() string` + +GetSchema returns the Schema field if non-nil, zero value otherwise. + +### GetSchemaOk + +`func (o *BaseEntitlement) GetSchemaOk() (*string, bool)` + +GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchema + +`func (o *BaseEntitlement) SetSchema(v string)` + +SetSchema sets Schema field to given value. + +### HasSchema + +`func (o *BaseEntitlement) HasSchema() bool` + +HasSchema returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *BaseEntitlement) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *BaseEntitlement) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *BaseEntitlement) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *BaseEntitlement) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetId + +`func (o *BaseEntitlement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseEntitlement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseEntitlement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseEntitlement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseEntitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseEntitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseEntitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseEntitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BaseReferenceDto.md b/docs/tools/sdk/go/Reference/V2025/Models/BaseReferenceDto.md new file mode 100644 index 000000000..140382944 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BaseReferenceDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-base-reference-dto +title: BaseReferenceDto +pagination_label: BaseReferenceDto +sidebar_label: BaseReferenceDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseReferenceDto', 'V2025BaseReferenceDto'] +slug: /tools/sdk/go/v2025/models/base-reference-dto +tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto', 'V2025BaseReferenceDto'] +--- + +# BaseReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewBaseReferenceDto + +`func NewBaseReferenceDto() *BaseReferenceDto` + +NewBaseReferenceDto instantiates a new BaseReferenceDto 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 + +### NewBaseReferenceDtoWithDefaults + +`func NewBaseReferenceDtoWithDefaults() *BaseReferenceDto` + +NewBaseReferenceDtoWithDefaults instantiates a new BaseReferenceDto 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 + +### GetType + +`func (o *BaseReferenceDto) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BaseReferenceDto) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BaseReferenceDto) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BaseReferenceDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *BaseReferenceDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseReferenceDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseReferenceDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseReferenceDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseReferenceDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseReferenceDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseReferenceDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseReferenceDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BaseSegment.md b/docs/tools/sdk/go/Reference/V2025/Models/BaseSegment.md new file mode 100644 index 000000000..1102719a6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BaseSegment.md @@ -0,0 +1,90 @@ +--- +id: v2025-base-segment +title: BaseSegment +pagination_label: BaseSegment +sidebar_label: BaseSegment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseSegment', 'V2025BaseSegment'] +slug: /tools/sdk/go/v2025/models/base-segment +tags: ['SDK', 'Software Development Kit', 'BaseSegment', 'V2025BaseSegment'] +--- + +# BaseSegment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Segment's unique ID. | [optional] +**Name** | Pointer to **string** | Segment's display name. | [optional] + +## Methods + +### NewBaseSegment + +`func NewBaseSegment() *BaseSegment` + +NewBaseSegment instantiates a new BaseSegment 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 + +### NewBaseSegmentWithDefaults + +`func NewBaseSegmentWithDefaults() *BaseSegment` + +NewBaseSegmentWithDefaults instantiates a new BaseSegment 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 + +### GetId + +`func (o *BaseSegment) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseSegment) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseSegment) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseSegment) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseSegment) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseSegment) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseSegment) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseSegment) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BasicAuthConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/BasicAuthConfig.md new file mode 100644 index 000000000..c0d0301dc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BasicAuthConfig.md @@ -0,0 +1,100 @@ +--- +id: v2025-basic-auth-config +title: BasicAuthConfig +pagination_label: BasicAuthConfig +sidebar_label: BasicAuthConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BasicAuthConfig', 'V2025BasicAuthConfig'] +slug: /tools/sdk/go/v2025/models/basic-auth-config +tags: ['SDK', 'Software Development Kit', 'BasicAuthConfig', 'V2025BasicAuthConfig'] +--- + +# BasicAuthConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserName** | Pointer to **string** | The username to authenticate. | [optional] +**Password** | Pointer to **NullableString** | The password to authenticate. On response, this field is set to null as to not return secrets. | [optional] + +## Methods + +### NewBasicAuthConfig + +`func NewBasicAuthConfig() *BasicAuthConfig` + +NewBasicAuthConfig instantiates a new BasicAuthConfig 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 + +### NewBasicAuthConfigWithDefaults + +`func NewBasicAuthConfigWithDefaults() *BasicAuthConfig` + +NewBasicAuthConfigWithDefaults instantiates a new BasicAuthConfig 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 + +### GetUserName + +`func (o *BasicAuthConfig) GetUserName() string` + +GetUserName returns the UserName field if non-nil, zero value otherwise. + +### GetUserNameOk + +`func (o *BasicAuthConfig) GetUserNameOk() (*string, bool)` + +GetUserNameOk returns a tuple with the UserName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserName + +`func (o *BasicAuthConfig) SetUserName(v string)` + +SetUserName sets UserName field to given value. + +### HasUserName + +`func (o *BasicAuthConfig) HasUserName() bool` + +HasUserName returns a boolean if a field has been set. + +### GetPassword + +`func (o *BasicAuthConfig) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *BasicAuthConfig) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *BasicAuthConfig) SetPassword(v string)` + +SetPassword sets Password field to given value. + +### HasPassword + +`func (o *BasicAuthConfig) HasPassword() bool` + +HasPassword returns a boolean if a field has been set. + +### SetPasswordNil + +`func (o *BasicAuthConfig) SetPasswordNil(b bool)` + + SetPasswordNil sets the value for Password to be an explicit nil + +### UnsetPassword +`func (o *BasicAuthConfig) UnsetPassword()` + +UnsetPassword ensures that no value is present for Password, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BearerTokenAuthConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/BearerTokenAuthConfig.md new file mode 100644 index 000000000..2dbd4a1f8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BearerTokenAuthConfig.md @@ -0,0 +1,74 @@ +--- +id: v2025-bearer-token-auth-config +title: BearerTokenAuthConfig +pagination_label: BearerTokenAuthConfig +sidebar_label: BearerTokenAuthConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BearerTokenAuthConfig', 'V2025BearerTokenAuthConfig'] +slug: /tools/sdk/go/v2025/models/bearer-token-auth-config +tags: ['SDK', 'Software Development Kit', 'BearerTokenAuthConfig', 'V2025BearerTokenAuthConfig'] +--- + +# BearerTokenAuthConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BearerToken** | Pointer to **NullableString** | Bearer token | [optional] + +## Methods + +### NewBearerTokenAuthConfig + +`func NewBearerTokenAuthConfig() *BearerTokenAuthConfig` + +NewBearerTokenAuthConfig instantiates a new BearerTokenAuthConfig 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 + +### NewBearerTokenAuthConfigWithDefaults + +`func NewBearerTokenAuthConfigWithDefaults() *BearerTokenAuthConfig` + +NewBearerTokenAuthConfigWithDefaults instantiates a new BearerTokenAuthConfig 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 + +### GetBearerToken + +`func (o *BearerTokenAuthConfig) GetBearerToken() string` + +GetBearerToken returns the BearerToken field if non-nil, zero value otherwise. + +### GetBearerTokenOk + +`func (o *BearerTokenAuthConfig) GetBearerTokenOk() (*string, bool)` + +GetBearerTokenOk returns a tuple with the BearerToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBearerToken + +`func (o *BearerTokenAuthConfig) SetBearerToken(v string)` + +SetBearerToken sets BearerToken field to given value. + +### HasBearerToken + +`func (o *BearerTokenAuthConfig) HasBearerToken() bool` + +HasBearerToken returns a boolean if a field has been set. + +### SetBearerTokenNil + +`func (o *BearerTokenAuthConfig) SetBearerTokenNil(b bool)` + + SetBearerTokenNil sets the value for BearerToken to be an explicit nil + +### UnsetBearerToken +`func (o *BearerTokenAuthConfig) UnsetBearerToken()` + +UnsetBearerToken ensures that no value is present for BearerToken, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BeforeProvisioningRuleDto.md b/docs/tools/sdk/go/Reference/V2025/Models/BeforeProvisioningRuleDto.md new file mode 100644 index 000000000..8a99265a7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BeforeProvisioningRuleDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-before-provisioning-rule-dto +title: BeforeProvisioningRuleDto +pagination_label: BeforeProvisioningRuleDto +sidebar_label: BeforeProvisioningRuleDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BeforeProvisioningRuleDto', 'V2025BeforeProvisioningRuleDto'] +slug: /tools/sdk/go/v2025/models/before-provisioning-rule-dto +tags: ['SDK', 'Software Development Kit', 'BeforeProvisioningRuleDto', 'V2025BeforeProvisioningRuleDto'] +--- + +# BeforeProvisioningRuleDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Before Provisioning Rule DTO type. | [optional] +**Id** | Pointer to **string** | Before Provisioning Rule ID. | [optional] +**Name** | Pointer to **string** | Rule display name. | [optional] + +## Methods + +### NewBeforeProvisioningRuleDto + +`func NewBeforeProvisioningRuleDto() *BeforeProvisioningRuleDto` + +NewBeforeProvisioningRuleDto instantiates a new BeforeProvisioningRuleDto 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 + +### NewBeforeProvisioningRuleDtoWithDefaults + +`func NewBeforeProvisioningRuleDtoWithDefaults() *BeforeProvisioningRuleDto` + +NewBeforeProvisioningRuleDtoWithDefaults instantiates a new BeforeProvisioningRuleDto 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 + +### GetType + +`func (o *BeforeProvisioningRuleDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BeforeProvisioningRuleDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BeforeProvisioningRuleDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BeforeProvisioningRuleDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *BeforeProvisioningRuleDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BeforeProvisioningRuleDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BeforeProvisioningRuleDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BeforeProvisioningRuleDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BeforeProvisioningRuleDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BeforeProvisioningRuleDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BeforeProvisioningRuleDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BeforeProvisioningRuleDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Bound.md b/docs/tools/sdk/go/Reference/V2025/Models/Bound.md new file mode 100644 index 000000000..674fcef7d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Bound.md @@ -0,0 +1,85 @@ +--- +id: v2025-bound +title: Bound +pagination_label: Bound +sidebar_label: Bound +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Bound', 'V2025Bound'] +slug: /tools/sdk/go/v2025/models/bound +tags: ['SDK', 'Software Development Kit', 'Bound', 'V2025Bound'] +--- + +# Bound + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | **string** | The value of the range's endpoint. | +**Inclusive** | Pointer to **bool** | Indicates if the endpoint is included in the range. | [optional] [default to false] + +## Methods + +### NewBound + +`func NewBound(value string, ) *Bound` + +NewBound instantiates a new Bound 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 + +### NewBoundWithDefaults + +`func NewBoundWithDefaults() *Bound` + +NewBoundWithDefaults instantiates a new Bound 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 + +### GetValue + +`func (o *Bound) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Bound) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Bound) SetValue(v string)` + +SetValue sets Value field to given value. + + +### GetInclusive + +`func (o *Bound) GetInclusive() bool` + +GetInclusive returns the Inclusive field if non-nil, zero value otherwise. + +### GetInclusiveOk + +`func (o *Bound) GetInclusiveOk() (*bool, bool)` + +GetInclusiveOk returns a tuple with the Inclusive field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInclusive + +`func (o *Bound) SetInclusive(v bool)` + +SetInclusive sets Inclusive field to given value. + +### HasInclusive + +`func (o *Bound) HasInclusive() bool` + +HasInclusive returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BrandingItem.md b/docs/tools/sdk/go/Reference/V2025/Models/BrandingItem.md new file mode 100644 index 000000000..12cd5c67d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BrandingItem.md @@ -0,0 +1,316 @@ +--- +id: v2025-branding-item +title: BrandingItem +pagination_label: BrandingItem +sidebar_label: BrandingItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BrandingItem', 'V2025BrandingItem'] +slug: /tools/sdk/go/v2025/models/branding-item +tags: ['SDK', 'Software Development Kit', 'BrandingItem', 'V2025BrandingItem'] +--- + +# BrandingItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | name of branding item | [optional] +**ProductName** | Pointer to **NullableString** | product name | [optional] +**ActionButtonColor** | Pointer to **NullableString** | hex value of color for action button | [optional] +**ActiveLinkColor** | Pointer to **NullableString** | hex value of color for link | [optional] +**NavigationColor** | Pointer to **NullableString** | hex value of color for navigation bar | [optional] +**EmailFromAddress** | Pointer to **NullableString** | email from address | [optional] +**StandardLogoURL** | Pointer to **NullableString** | url to standard logo | [optional] +**LoginInformationalMessage** | Pointer to **NullableString** | login information message | [optional] + +## Methods + +### NewBrandingItem + +`func NewBrandingItem() *BrandingItem` + +NewBrandingItem instantiates a new BrandingItem 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 + +### NewBrandingItemWithDefaults + +`func NewBrandingItemWithDefaults() *BrandingItem` + +NewBrandingItemWithDefaults instantiates a new BrandingItem 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 + +### GetName + +`func (o *BrandingItem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BrandingItem) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BrandingItem) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BrandingItem) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetProductName + +`func (o *BrandingItem) GetProductName() string` + +GetProductName returns the ProductName field if non-nil, zero value otherwise. + +### GetProductNameOk + +`func (o *BrandingItem) GetProductNameOk() (*string, bool)` + +GetProductNameOk returns a tuple with the ProductName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductName + +`func (o *BrandingItem) SetProductName(v string)` + +SetProductName sets ProductName field to given value. + +### HasProductName + +`func (o *BrandingItem) HasProductName() bool` + +HasProductName returns a boolean if a field has been set. + +### SetProductNameNil + +`func (o *BrandingItem) SetProductNameNil(b bool)` + + SetProductNameNil sets the value for ProductName to be an explicit nil + +### UnsetProductName +`func (o *BrandingItem) UnsetProductName()` + +UnsetProductName ensures that no value is present for ProductName, not even an explicit nil +### GetActionButtonColor + +`func (o *BrandingItem) GetActionButtonColor() string` + +GetActionButtonColor returns the ActionButtonColor field if non-nil, zero value otherwise. + +### GetActionButtonColorOk + +`func (o *BrandingItem) GetActionButtonColorOk() (*string, bool)` + +GetActionButtonColorOk returns a tuple with the ActionButtonColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActionButtonColor + +`func (o *BrandingItem) SetActionButtonColor(v string)` + +SetActionButtonColor sets ActionButtonColor field to given value. + +### HasActionButtonColor + +`func (o *BrandingItem) HasActionButtonColor() bool` + +HasActionButtonColor returns a boolean if a field has been set. + +### SetActionButtonColorNil + +`func (o *BrandingItem) SetActionButtonColorNil(b bool)` + + SetActionButtonColorNil sets the value for ActionButtonColor to be an explicit nil + +### UnsetActionButtonColor +`func (o *BrandingItem) UnsetActionButtonColor()` + +UnsetActionButtonColor ensures that no value is present for ActionButtonColor, not even an explicit nil +### GetActiveLinkColor + +`func (o *BrandingItem) GetActiveLinkColor() string` + +GetActiveLinkColor returns the ActiveLinkColor field if non-nil, zero value otherwise. + +### GetActiveLinkColorOk + +`func (o *BrandingItem) GetActiveLinkColorOk() (*string, bool)` + +GetActiveLinkColorOk returns a tuple with the ActiveLinkColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActiveLinkColor + +`func (o *BrandingItem) SetActiveLinkColor(v string)` + +SetActiveLinkColor sets ActiveLinkColor field to given value. + +### HasActiveLinkColor + +`func (o *BrandingItem) HasActiveLinkColor() bool` + +HasActiveLinkColor returns a boolean if a field has been set. + +### SetActiveLinkColorNil + +`func (o *BrandingItem) SetActiveLinkColorNil(b bool)` + + SetActiveLinkColorNil sets the value for ActiveLinkColor to be an explicit nil + +### UnsetActiveLinkColor +`func (o *BrandingItem) UnsetActiveLinkColor()` + +UnsetActiveLinkColor ensures that no value is present for ActiveLinkColor, not even an explicit nil +### GetNavigationColor + +`func (o *BrandingItem) GetNavigationColor() string` + +GetNavigationColor returns the NavigationColor field if non-nil, zero value otherwise. + +### GetNavigationColorOk + +`func (o *BrandingItem) GetNavigationColorOk() (*string, bool)` + +GetNavigationColorOk returns a tuple with the NavigationColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNavigationColor + +`func (o *BrandingItem) SetNavigationColor(v string)` + +SetNavigationColor sets NavigationColor field to given value. + +### HasNavigationColor + +`func (o *BrandingItem) HasNavigationColor() bool` + +HasNavigationColor returns a boolean if a field has been set. + +### SetNavigationColorNil + +`func (o *BrandingItem) SetNavigationColorNil(b bool)` + + SetNavigationColorNil sets the value for NavigationColor to be an explicit nil + +### UnsetNavigationColor +`func (o *BrandingItem) UnsetNavigationColor()` + +UnsetNavigationColor ensures that no value is present for NavigationColor, not even an explicit nil +### GetEmailFromAddress + +`func (o *BrandingItem) GetEmailFromAddress() string` + +GetEmailFromAddress returns the EmailFromAddress field if non-nil, zero value otherwise. + +### GetEmailFromAddressOk + +`func (o *BrandingItem) GetEmailFromAddressOk() (*string, bool)` + +GetEmailFromAddressOk returns a tuple with the EmailFromAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailFromAddress + +`func (o *BrandingItem) SetEmailFromAddress(v string)` + +SetEmailFromAddress sets EmailFromAddress field to given value. + +### HasEmailFromAddress + +`func (o *BrandingItem) HasEmailFromAddress() bool` + +HasEmailFromAddress returns a boolean if a field has been set. + +### SetEmailFromAddressNil + +`func (o *BrandingItem) SetEmailFromAddressNil(b bool)` + + SetEmailFromAddressNil sets the value for EmailFromAddress to be an explicit nil + +### UnsetEmailFromAddress +`func (o *BrandingItem) UnsetEmailFromAddress()` + +UnsetEmailFromAddress ensures that no value is present for EmailFromAddress, not even an explicit nil +### GetStandardLogoURL + +`func (o *BrandingItem) GetStandardLogoURL() string` + +GetStandardLogoURL returns the StandardLogoURL field if non-nil, zero value otherwise. + +### GetStandardLogoURLOk + +`func (o *BrandingItem) GetStandardLogoURLOk() (*string, bool)` + +GetStandardLogoURLOk returns a tuple with the StandardLogoURL field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandardLogoURL + +`func (o *BrandingItem) SetStandardLogoURL(v string)` + +SetStandardLogoURL sets StandardLogoURL field to given value. + +### HasStandardLogoURL + +`func (o *BrandingItem) HasStandardLogoURL() bool` + +HasStandardLogoURL returns a boolean if a field has been set. + +### SetStandardLogoURLNil + +`func (o *BrandingItem) SetStandardLogoURLNil(b bool)` + + SetStandardLogoURLNil sets the value for StandardLogoURL to be an explicit nil + +### UnsetStandardLogoURL +`func (o *BrandingItem) UnsetStandardLogoURL()` + +UnsetStandardLogoURL ensures that no value is present for StandardLogoURL, not even an explicit nil +### GetLoginInformationalMessage + +`func (o *BrandingItem) GetLoginInformationalMessage() string` + +GetLoginInformationalMessage returns the LoginInformationalMessage field if non-nil, zero value otherwise. + +### GetLoginInformationalMessageOk + +`func (o *BrandingItem) GetLoginInformationalMessageOk() (*string, bool)` + +GetLoginInformationalMessageOk returns a tuple with the LoginInformationalMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginInformationalMessage + +`func (o *BrandingItem) SetLoginInformationalMessage(v string)` + +SetLoginInformationalMessage sets LoginInformationalMessage field to given value. + +### HasLoginInformationalMessage + +`func (o *BrandingItem) HasLoginInformationalMessage() bool` + +HasLoginInformationalMessage returns a boolean if a field has been set. + +### SetLoginInformationalMessageNil + +`func (o *BrandingItem) SetLoginInformationalMessageNil(b bool)` + + SetLoginInformationalMessageNil sets the value for LoginInformationalMessage to be an explicit nil + +### UnsetLoginInformationalMessage +`func (o *BrandingItem) UnsetLoginInformationalMessage()` + +UnsetLoginInformationalMessage ensures that no value is present for LoginInformationalMessage, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BrandingItemCreate.md b/docs/tools/sdk/go/Reference/V2025/Models/BrandingItemCreate.md new file mode 100644 index 000000000..9cb00548e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BrandingItemCreate.md @@ -0,0 +1,246 @@ +--- +id: v2025-branding-item-create +title: BrandingItemCreate +pagination_label: BrandingItemCreate +sidebar_label: BrandingItemCreate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BrandingItemCreate', 'V2025BrandingItemCreate'] +slug: /tools/sdk/go/v2025/models/branding-item-create +tags: ['SDK', 'Software Development Kit', 'BrandingItemCreate', 'V2025BrandingItemCreate'] +--- + +# BrandingItemCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | name of branding item | +**ProductName** | **NullableString** | product name | +**ActionButtonColor** | Pointer to **string** | hex value of color for action button | [optional] +**ActiveLinkColor** | Pointer to **string** | hex value of color for link | [optional] +**NavigationColor** | Pointer to **string** | hex value of color for navigation bar | [optional] +**EmailFromAddress** | Pointer to **string** | email from address | [optional] +**LoginInformationalMessage** | Pointer to **string** | login information message | [optional] +**FileStandard** | Pointer to ***os.File** | png file with logo | [optional] + +## Methods + +### NewBrandingItemCreate + +`func NewBrandingItemCreate(name string, productName NullableString, ) *BrandingItemCreate` + +NewBrandingItemCreate instantiates a new BrandingItemCreate 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 + +### NewBrandingItemCreateWithDefaults + +`func NewBrandingItemCreateWithDefaults() *BrandingItemCreate` + +NewBrandingItemCreateWithDefaults instantiates a new BrandingItemCreate 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 + +### GetName + +`func (o *BrandingItemCreate) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BrandingItemCreate) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BrandingItemCreate) SetName(v string)` + +SetName sets Name field to given value. + + +### GetProductName + +`func (o *BrandingItemCreate) GetProductName() string` + +GetProductName returns the ProductName field if non-nil, zero value otherwise. + +### GetProductNameOk + +`func (o *BrandingItemCreate) GetProductNameOk() (*string, bool)` + +GetProductNameOk returns a tuple with the ProductName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductName + +`func (o *BrandingItemCreate) SetProductName(v string)` + +SetProductName sets ProductName field to given value. + + +### SetProductNameNil + +`func (o *BrandingItemCreate) SetProductNameNil(b bool)` + + SetProductNameNil sets the value for ProductName to be an explicit nil + +### UnsetProductName +`func (o *BrandingItemCreate) UnsetProductName()` + +UnsetProductName ensures that no value is present for ProductName, not even an explicit nil +### GetActionButtonColor + +`func (o *BrandingItemCreate) GetActionButtonColor() string` + +GetActionButtonColor returns the ActionButtonColor field if non-nil, zero value otherwise. + +### GetActionButtonColorOk + +`func (o *BrandingItemCreate) GetActionButtonColorOk() (*string, bool)` + +GetActionButtonColorOk returns a tuple with the ActionButtonColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActionButtonColor + +`func (o *BrandingItemCreate) SetActionButtonColor(v string)` + +SetActionButtonColor sets ActionButtonColor field to given value. + +### HasActionButtonColor + +`func (o *BrandingItemCreate) HasActionButtonColor() bool` + +HasActionButtonColor returns a boolean if a field has been set. + +### GetActiveLinkColor + +`func (o *BrandingItemCreate) GetActiveLinkColor() string` + +GetActiveLinkColor returns the ActiveLinkColor field if non-nil, zero value otherwise. + +### GetActiveLinkColorOk + +`func (o *BrandingItemCreate) GetActiveLinkColorOk() (*string, bool)` + +GetActiveLinkColorOk returns a tuple with the ActiveLinkColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActiveLinkColor + +`func (o *BrandingItemCreate) SetActiveLinkColor(v string)` + +SetActiveLinkColor sets ActiveLinkColor field to given value. + +### HasActiveLinkColor + +`func (o *BrandingItemCreate) HasActiveLinkColor() bool` + +HasActiveLinkColor returns a boolean if a field has been set. + +### GetNavigationColor + +`func (o *BrandingItemCreate) GetNavigationColor() string` + +GetNavigationColor returns the NavigationColor field if non-nil, zero value otherwise. + +### GetNavigationColorOk + +`func (o *BrandingItemCreate) GetNavigationColorOk() (*string, bool)` + +GetNavigationColorOk returns a tuple with the NavigationColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNavigationColor + +`func (o *BrandingItemCreate) SetNavigationColor(v string)` + +SetNavigationColor sets NavigationColor field to given value. + +### HasNavigationColor + +`func (o *BrandingItemCreate) HasNavigationColor() bool` + +HasNavigationColor returns a boolean if a field has been set. + +### GetEmailFromAddress + +`func (o *BrandingItemCreate) GetEmailFromAddress() string` + +GetEmailFromAddress returns the EmailFromAddress field if non-nil, zero value otherwise. + +### GetEmailFromAddressOk + +`func (o *BrandingItemCreate) GetEmailFromAddressOk() (*string, bool)` + +GetEmailFromAddressOk returns a tuple with the EmailFromAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailFromAddress + +`func (o *BrandingItemCreate) SetEmailFromAddress(v string)` + +SetEmailFromAddress sets EmailFromAddress field to given value. + +### HasEmailFromAddress + +`func (o *BrandingItemCreate) HasEmailFromAddress() bool` + +HasEmailFromAddress returns a boolean if a field has been set. + +### GetLoginInformationalMessage + +`func (o *BrandingItemCreate) GetLoginInformationalMessage() string` + +GetLoginInformationalMessage returns the LoginInformationalMessage field if non-nil, zero value otherwise. + +### GetLoginInformationalMessageOk + +`func (o *BrandingItemCreate) GetLoginInformationalMessageOk() (*string, bool)` + +GetLoginInformationalMessageOk returns a tuple with the LoginInformationalMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginInformationalMessage + +`func (o *BrandingItemCreate) SetLoginInformationalMessage(v string)` + +SetLoginInformationalMessage sets LoginInformationalMessage field to given value. + +### HasLoginInformationalMessage + +`func (o *BrandingItemCreate) HasLoginInformationalMessage() bool` + +HasLoginInformationalMessage returns a boolean if a field has been set. + +### GetFileStandard + +`func (o *BrandingItemCreate) GetFileStandard() *os.File` + +GetFileStandard returns the FileStandard field if non-nil, zero value otherwise. + +### GetFileStandardOk + +`func (o *BrandingItemCreate) GetFileStandardOk() (**os.File, bool)` + +GetFileStandardOk returns a tuple with the FileStandard field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileStandard + +`func (o *BrandingItemCreate) SetFileStandard(v *os.File)` + +SetFileStandard sets FileStandard field to given value. + +### HasFileStandard + +`func (o *BrandingItemCreate) HasFileStandard() bool` + +HasFileStandard returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BucketAggregation.md b/docs/tools/sdk/go/Reference/V2025/Models/BucketAggregation.md new file mode 100644 index 000000000..9395ccc2f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BucketAggregation.md @@ -0,0 +1,158 @@ +--- +id: v2025-bucket-aggregation +title: BucketAggregation +pagination_label: BucketAggregation +sidebar_label: BucketAggregation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BucketAggregation', 'V2025BucketAggregation'] +slug: /tools/sdk/go/v2025/models/bucket-aggregation +tags: ['SDK', 'Software Development Kit', 'BucketAggregation', 'V2025BucketAggregation'] +--- + +# BucketAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the bucket aggregate to be included in the result. | +**Type** | Pointer to [**BucketType**](bucket-type) | | [optional] [default to BUCKETTYPE_TERMS] +**Field** | **string** | The field to bucket on. Prefix the field name with '@' to reference a nested object. | +**Size** | Pointer to **int32** | Maximum number of buckets to include. | [optional] +**MinDocCount** | Pointer to **int32** | Minimum number of documents a bucket should have. | [optional] + +## Methods + +### NewBucketAggregation + +`func NewBucketAggregation(name string, field string, ) *BucketAggregation` + +NewBucketAggregation instantiates a new BucketAggregation 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 + +### NewBucketAggregationWithDefaults + +`func NewBucketAggregationWithDefaults() *BucketAggregation` + +NewBucketAggregationWithDefaults instantiates a new BucketAggregation 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 + +### GetName + +`func (o *BucketAggregation) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BucketAggregation) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BucketAggregation) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *BucketAggregation) GetType() BucketType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BucketAggregation) GetTypeOk() (*BucketType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BucketAggregation) SetType(v BucketType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BucketAggregation) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetField + +`func (o *BucketAggregation) GetField() string` + +GetField returns the Field field if non-nil, zero value otherwise. + +### GetFieldOk + +`func (o *BucketAggregation) GetFieldOk() (*string, bool)` + +GetFieldOk returns a tuple with the Field field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetField + +`func (o *BucketAggregation) SetField(v string)` + +SetField sets Field field to given value. + + +### GetSize + +`func (o *BucketAggregation) GetSize() int32` + +GetSize returns the Size field if non-nil, zero value otherwise. + +### GetSizeOk + +`func (o *BucketAggregation) GetSizeOk() (*int32, bool)` + +GetSizeOk returns a tuple with the Size field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSize + +`func (o *BucketAggregation) SetSize(v int32)` + +SetSize sets Size field to given value. + +### HasSize + +`func (o *BucketAggregation) HasSize() bool` + +HasSize returns a boolean if a field has been set. + +### GetMinDocCount + +`func (o *BucketAggregation) GetMinDocCount() int32` + +GetMinDocCount returns the MinDocCount field if non-nil, zero value otherwise. + +### GetMinDocCountOk + +`func (o *BucketAggregation) GetMinDocCountOk() (*int32, bool)` + +GetMinDocCountOk returns a tuple with the MinDocCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinDocCount + +`func (o *BucketAggregation) SetMinDocCount(v int32)` + +SetMinDocCount sets MinDocCount field to given value. + +### HasMinDocCount + +`func (o *BucketAggregation) HasMinDocCount() bool` + +HasMinDocCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BucketType.md b/docs/tools/sdk/go/Reference/V2025/Models/BucketType.md new file mode 100644 index 000000000..e908abbfb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BucketType.md @@ -0,0 +1,19 @@ +--- +id: v2025-bucket-type +title: BucketType +pagination_label: BucketType +sidebar_label: BucketType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BucketType', 'V2025BucketType'] +slug: /tools/sdk/go/v2025/models/bucket-type +tags: ['SDK', 'Software Development Kit', 'BucketType', 'V2025BucketType'] +--- + +# BucketType + +## Enum + + +* `TERMS` (value: `"TERMS"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BulkAddTaggedObject.md b/docs/tools/sdk/go/Reference/V2025/Models/BulkAddTaggedObject.md new file mode 100644 index 000000000..c26a38cb9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BulkAddTaggedObject.md @@ -0,0 +1,116 @@ +--- +id: v2025-bulk-add-tagged-object +title: BulkAddTaggedObject +pagination_label: BulkAddTaggedObject +sidebar_label: BulkAddTaggedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkAddTaggedObject', 'V2025BulkAddTaggedObject'] +slug: /tools/sdk/go/v2025/models/bulk-add-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkAddTaggedObject', 'V2025BulkAddTaggedObject'] +--- + +# BulkAddTaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]string** | Label to be applied to an Object | [optional] +**Operation** | Pointer to **string** | If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. | [optional] [default to "APPEND"] + +## Methods + +### NewBulkAddTaggedObject + +`func NewBulkAddTaggedObject() *BulkAddTaggedObject` + +NewBulkAddTaggedObject instantiates a new BulkAddTaggedObject 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 + +### NewBulkAddTaggedObjectWithDefaults + +`func NewBulkAddTaggedObjectWithDefaults() *BulkAddTaggedObject` + +NewBulkAddTaggedObjectWithDefaults instantiates a new BulkAddTaggedObject 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 + +### GetObjectRefs + +`func (o *BulkAddTaggedObject) GetObjectRefs() []TaggedObjectDto` + +GetObjectRefs returns the ObjectRefs field if non-nil, zero value otherwise. + +### GetObjectRefsOk + +`func (o *BulkAddTaggedObject) GetObjectRefsOk() (*[]TaggedObjectDto, bool)` + +GetObjectRefsOk returns a tuple with the ObjectRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectRefs + +`func (o *BulkAddTaggedObject) SetObjectRefs(v []TaggedObjectDto)` + +SetObjectRefs sets ObjectRefs field to given value. + +### HasObjectRefs + +`func (o *BulkAddTaggedObject) HasObjectRefs() bool` + +HasObjectRefs returns a boolean if a field has been set. + +### GetTags + +`func (o *BulkAddTaggedObject) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *BulkAddTaggedObject) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *BulkAddTaggedObject) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *BulkAddTaggedObject) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetOperation + +`func (o *BulkAddTaggedObject) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *BulkAddTaggedObject) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *BulkAddTaggedObject) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *BulkAddTaggedObject) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BulkApproveAccessRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/BulkApproveAccessRequest.md new file mode 100644 index 000000000..342361d0e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BulkApproveAccessRequest.md @@ -0,0 +1,80 @@ +--- +id: v2025-bulk-approve-access-request +title: BulkApproveAccessRequest +pagination_label: BulkApproveAccessRequest +sidebar_label: BulkApproveAccessRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkApproveAccessRequest', 'V2025BulkApproveAccessRequest'] +slug: /tools/sdk/go/v2025/models/bulk-approve-access-request +tags: ['SDK', 'Software Development Kit', 'BulkApproveAccessRequest', 'V2025BulkApproveAccessRequest'] +--- + +# BulkApproveAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalIds** | **[]string** | List of approval ids to approve the pending requests | +**Comment** | **string** | Reason for approving the pending access request. | + +## Methods + +### NewBulkApproveAccessRequest + +`func NewBulkApproveAccessRequest(approvalIds []string, comment string, ) *BulkApproveAccessRequest` + +NewBulkApproveAccessRequest instantiates a new BulkApproveAccessRequest 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 + +### NewBulkApproveAccessRequestWithDefaults + +`func NewBulkApproveAccessRequestWithDefaults() *BulkApproveAccessRequest` + +NewBulkApproveAccessRequestWithDefaults instantiates a new BulkApproveAccessRequest 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 + +### GetApprovalIds + +`func (o *BulkApproveAccessRequest) GetApprovalIds() []string` + +GetApprovalIds returns the ApprovalIds field if non-nil, zero value otherwise. + +### GetApprovalIdsOk + +`func (o *BulkApproveAccessRequest) GetApprovalIdsOk() (*[]string, bool)` + +GetApprovalIdsOk returns a tuple with the ApprovalIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalIds + +`func (o *BulkApproveAccessRequest) SetApprovalIds(v []string)` + +SetApprovalIds sets ApprovalIds field to given value. + + +### GetComment + +`func (o *BulkApproveAccessRequest) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *BulkApproveAccessRequest) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *BulkApproveAccessRequest) SetComment(v string)` + +SetComment sets Comment field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BulkCancelAccessRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/BulkCancelAccessRequest.md new file mode 100644 index 000000000..81bb6f06a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BulkCancelAccessRequest.md @@ -0,0 +1,80 @@ +--- +id: v2025-bulk-cancel-access-request +title: BulkCancelAccessRequest +pagination_label: BulkCancelAccessRequest +sidebar_label: BulkCancelAccessRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkCancelAccessRequest', 'V2025BulkCancelAccessRequest'] +slug: /tools/sdk/go/v2025/models/bulk-cancel-access-request +tags: ['SDK', 'Software Development Kit', 'BulkCancelAccessRequest', 'V2025BulkCancelAccessRequest'] +--- + +# BulkCancelAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestIds** | **[]string** | List of access requests ids to cancel the pending requests | +**Comment** | **string** | Reason for cancelling the pending access request. | + +## Methods + +### NewBulkCancelAccessRequest + +`func NewBulkCancelAccessRequest(accessRequestIds []string, comment string, ) *BulkCancelAccessRequest` + +NewBulkCancelAccessRequest instantiates a new BulkCancelAccessRequest 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 + +### NewBulkCancelAccessRequestWithDefaults + +`func NewBulkCancelAccessRequestWithDefaults() *BulkCancelAccessRequest` + +NewBulkCancelAccessRequestWithDefaults instantiates a new BulkCancelAccessRequest 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 + +### GetAccessRequestIds + +`func (o *BulkCancelAccessRequest) GetAccessRequestIds() []string` + +GetAccessRequestIds returns the AccessRequestIds field if non-nil, zero value otherwise. + +### GetAccessRequestIdsOk + +`func (o *BulkCancelAccessRequest) GetAccessRequestIdsOk() (*[]string, bool)` + +GetAccessRequestIdsOk returns a tuple with the AccessRequestIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestIds + +`func (o *BulkCancelAccessRequest) SetAccessRequestIds(v []string)` + +SetAccessRequestIds sets AccessRequestIds field to given value. + + +### GetComment + +`func (o *BulkCancelAccessRequest) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *BulkCancelAccessRequest) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *BulkCancelAccessRequest) SetComment(v string)` + +SetComment sets Comment field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BulkIdentitiesAccountsResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/BulkIdentitiesAccountsResponse.md new file mode 100644 index 000000000..78e1d39d3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BulkIdentitiesAccountsResponse.md @@ -0,0 +1,116 @@ +--- +id: v2025-bulk-identities-accounts-response +title: BulkIdentitiesAccountsResponse +pagination_label: BulkIdentitiesAccountsResponse +sidebar_label: BulkIdentitiesAccountsResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkIdentitiesAccountsResponse', 'V2025BulkIdentitiesAccountsResponse'] +slug: /tools/sdk/go/v2025/models/bulk-identities-accounts-response +tags: ['SDK', 'Software Development Kit', 'BulkIdentitiesAccountsResponse', 'V2025BulkIdentitiesAccountsResponse'] +--- + +# BulkIdentitiesAccountsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Identifier of bulk request item. | [optional] +**StatusCode** | Pointer to **int32** | Response status value. | [optional] +**Message** | Pointer to **string** | Status containing additional context information about failures. | [optional] + +## Methods + +### NewBulkIdentitiesAccountsResponse + +`func NewBulkIdentitiesAccountsResponse() *BulkIdentitiesAccountsResponse` + +NewBulkIdentitiesAccountsResponse instantiates a new BulkIdentitiesAccountsResponse 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 + +### NewBulkIdentitiesAccountsResponseWithDefaults + +`func NewBulkIdentitiesAccountsResponseWithDefaults() *BulkIdentitiesAccountsResponse` + +NewBulkIdentitiesAccountsResponseWithDefaults instantiates a new BulkIdentitiesAccountsResponse 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 + +### GetId + +`func (o *BulkIdentitiesAccountsResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BulkIdentitiesAccountsResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BulkIdentitiesAccountsResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BulkIdentitiesAccountsResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetStatusCode + +`func (o *BulkIdentitiesAccountsResponse) GetStatusCode() int32` + +GetStatusCode returns the StatusCode field if non-nil, zero value otherwise. + +### GetStatusCodeOk + +`func (o *BulkIdentitiesAccountsResponse) GetStatusCodeOk() (*int32, bool)` + +GetStatusCodeOk returns a tuple with the StatusCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusCode + +`func (o *BulkIdentitiesAccountsResponse) SetStatusCode(v int32)` + +SetStatusCode sets StatusCode field to given value. + +### HasStatusCode + +`func (o *BulkIdentitiesAccountsResponse) HasStatusCode() bool` + +HasStatusCode returns a boolean if a field has been set. + +### GetMessage + +`func (o *BulkIdentitiesAccountsResponse) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *BulkIdentitiesAccountsResponse) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *BulkIdentitiesAccountsResponse) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *BulkIdentitiesAccountsResponse) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BulkRemoveTaggedObject.md b/docs/tools/sdk/go/Reference/V2025/Models/BulkRemoveTaggedObject.md new file mode 100644 index 000000000..32f9e66d0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BulkRemoveTaggedObject.md @@ -0,0 +1,90 @@ +--- +id: v2025-bulk-remove-tagged-object +title: BulkRemoveTaggedObject +pagination_label: BulkRemoveTaggedObject +sidebar_label: BulkRemoveTaggedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkRemoveTaggedObject', 'V2025BulkRemoveTaggedObject'] +slug: /tools/sdk/go/v2025/models/bulk-remove-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkRemoveTaggedObject', 'V2025BulkRemoveTaggedObject'] +--- + +# BulkRemoveTaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]string** | Label to be applied to an Object | [optional] + +## Methods + +### NewBulkRemoveTaggedObject + +`func NewBulkRemoveTaggedObject() *BulkRemoveTaggedObject` + +NewBulkRemoveTaggedObject instantiates a new BulkRemoveTaggedObject 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 + +### NewBulkRemoveTaggedObjectWithDefaults + +`func NewBulkRemoveTaggedObjectWithDefaults() *BulkRemoveTaggedObject` + +NewBulkRemoveTaggedObjectWithDefaults instantiates a new BulkRemoveTaggedObject 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 + +### GetObjectRefs + +`func (o *BulkRemoveTaggedObject) GetObjectRefs() []TaggedObjectDto` + +GetObjectRefs returns the ObjectRefs field if non-nil, zero value otherwise. + +### GetObjectRefsOk + +`func (o *BulkRemoveTaggedObject) GetObjectRefsOk() (*[]TaggedObjectDto, bool)` + +GetObjectRefsOk returns a tuple with the ObjectRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectRefs + +`func (o *BulkRemoveTaggedObject) SetObjectRefs(v []TaggedObjectDto)` + +SetObjectRefs sets ObjectRefs field to given value. + +### HasObjectRefs + +`func (o *BulkRemoveTaggedObject) HasObjectRefs() bool` + +HasObjectRefs returns a boolean if a field has been set. + +### GetTags + +`func (o *BulkRemoveTaggedObject) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *BulkRemoveTaggedObject) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *BulkRemoveTaggedObject) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *BulkRemoveTaggedObject) HasTags() bool` + +HasTags returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/BulkTaggedObjectResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/BulkTaggedObjectResponse.md new file mode 100644 index 000000000..bb1303255 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/BulkTaggedObjectResponse.md @@ -0,0 +1,90 @@ +--- +id: v2025-bulk-tagged-object-response +title: BulkTaggedObjectResponse +pagination_label: BulkTaggedObjectResponse +sidebar_label: BulkTaggedObjectResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkTaggedObjectResponse', 'V2025BulkTaggedObjectResponse'] +slug: /tools/sdk/go/v2025/models/bulk-tagged-object-response +tags: ['SDK', 'Software Development Kit', 'BulkTaggedObjectResponse', 'V2025BulkTaggedObjectResponse'] +--- + +# BulkTaggedObjectResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]string** | Label to be applied to an Object | [optional] + +## Methods + +### NewBulkTaggedObjectResponse + +`func NewBulkTaggedObjectResponse() *BulkTaggedObjectResponse` + +NewBulkTaggedObjectResponse instantiates a new BulkTaggedObjectResponse 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 + +### NewBulkTaggedObjectResponseWithDefaults + +`func NewBulkTaggedObjectResponseWithDefaults() *BulkTaggedObjectResponse` + +NewBulkTaggedObjectResponseWithDefaults instantiates a new BulkTaggedObjectResponse 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 + +### GetObjectRefs + +`func (o *BulkTaggedObjectResponse) GetObjectRefs() []TaggedObjectDto` + +GetObjectRefs returns the ObjectRefs field if non-nil, zero value otherwise. + +### GetObjectRefsOk + +`func (o *BulkTaggedObjectResponse) GetObjectRefsOk() (*[]TaggedObjectDto, bool)` + +GetObjectRefsOk returns a tuple with the ObjectRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectRefs + +`func (o *BulkTaggedObjectResponse) SetObjectRefs(v []TaggedObjectDto)` + +SetObjectRefs sets ObjectRefs field to given value. + +### HasObjectRefs + +`func (o *BulkTaggedObjectResponse) HasObjectRefs() bool` + +HasObjectRefs returns a boolean if a field has been set. + +### GetTags + +`func (o *BulkTaggedObjectResponse) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *BulkTaggedObjectResponse) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *BulkTaggedObjectResponse) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *BulkTaggedObjectResponse) HasTags() bool` + +HasTags returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Campaign.md b/docs/tools/sdk/go/Reference/V2025/Models/Campaign.md new file mode 100644 index 000000000..9fe6a7ac3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Campaign.md @@ -0,0 +1,771 @@ +--- +id: v2025-campaign +title: Campaign +pagination_label: Campaign +sidebar_label: Campaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Campaign', 'V2025Campaign'] +slug: /tools/sdk/go/v2025/models/campaign +tags: ['SDK', 'Software Development Kit', 'Campaign', 'V2025Campaign'] +--- + +# Campaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | Id of the campaign | [optional] [readonly] +**Name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Description** | **NullableString** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Deadline** | Pointer to **NullableTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **string** | The type of campaign. Could be extended in the future. | +**EmailNotificationEnabled** | Pointer to **bool** | Enables email notification for this campaign | [optional] [default to false] +**AutoRevokeAllowed** | Pointer to **bool** | Allows auto revoke for this campaign | [optional] [default to false] +**RecommendationsEnabled** | Pointer to **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to false] +**Status** | Pointer to **NullableString** | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **NullableTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **NullableInt32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **NullableInt32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **NullableTime** | Modified time of the campaign | [optional] [readonly] +**Filter** | Pointer to [**NullableCampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **bool** | Determines if comments on sunset date changes are required. | [optional] [default to true] +**SourceOwnerCampaignInfo** | Pointer to [**NullableCampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**NullableCampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**NullableCampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**NullableCampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Methods + +### NewCampaign + +`func NewCampaign(name string, description NullableString, type_ string, ) *Campaign` + +NewCampaign instantiates a new Campaign 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 + +### NewCampaignWithDefaults + +`func NewCampaignWithDefaults() *Campaign` + +NewCampaignWithDefaults instantiates a new Campaign 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 + +### GetId + +`func (o *Campaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Campaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Campaign) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Campaign) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *Campaign) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *Campaign) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *Campaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Campaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Campaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Campaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Campaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Campaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *Campaign) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Campaign) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetDeadline + +`func (o *Campaign) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *Campaign) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *Campaign) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *Campaign) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### SetDeadlineNil + +`func (o *Campaign) SetDeadlineNil(b bool)` + + SetDeadlineNil sets the value for Deadline to be an explicit nil + +### UnsetDeadline +`func (o *Campaign) UnsetDeadline()` + +UnsetDeadline ensures that no value is present for Deadline, not even an explicit nil +### GetType + +`func (o *Campaign) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Campaign) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Campaign) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEmailNotificationEnabled + +`func (o *Campaign) GetEmailNotificationEnabled() bool` + +GetEmailNotificationEnabled returns the EmailNotificationEnabled field if non-nil, zero value otherwise. + +### GetEmailNotificationEnabledOk + +`func (o *Campaign) GetEmailNotificationEnabledOk() (*bool, bool)` + +GetEmailNotificationEnabledOk returns a tuple with the EmailNotificationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationEnabled + +`func (o *Campaign) SetEmailNotificationEnabled(v bool)` + +SetEmailNotificationEnabled sets EmailNotificationEnabled field to given value. + +### HasEmailNotificationEnabled + +`func (o *Campaign) HasEmailNotificationEnabled() bool` + +HasEmailNotificationEnabled returns a boolean if a field has been set. + +### GetAutoRevokeAllowed + +`func (o *Campaign) GetAutoRevokeAllowed() bool` + +GetAutoRevokeAllowed returns the AutoRevokeAllowed field if non-nil, zero value otherwise. + +### GetAutoRevokeAllowedOk + +`func (o *Campaign) GetAutoRevokeAllowedOk() (*bool, bool)` + +GetAutoRevokeAllowedOk returns a tuple with the AutoRevokeAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoRevokeAllowed + +`func (o *Campaign) SetAutoRevokeAllowed(v bool)` + +SetAutoRevokeAllowed sets AutoRevokeAllowed field to given value. + +### HasAutoRevokeAllowed + +`func (o *Campaign) HasAutoRevokeAllowed() bool` + +HasAutoRevokeAllowed returns a boolean if a field has been set. + +### GetRecommendationsEnabled + +`func (o *Campaign) GetRecommendationsEnabled() bool` + +GetRecommendationsEnabled returns the RecommendationsEnabled field if non-nil, zero value otherwise. + +### GetRecommendationsEnabledOk + +`func (o *Campaign) GetRecommendationsEnabledOk() (*bool, bool)` + +GetRecommendationsEnabledOk returns a tuple with the RecommendationsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendationsEnabled + +`func (o *Campaign) SetRecommendationsEnabled(v bool)` + +SetRecommendationsEnabled sets RecommendationsEnabled field to given value. + +### HasRecommendationsEnabled + +`func (o *Campaign) HasRecommendationsEnabled() bool` + +HasRecommendationsEnabled returns a boolean if a field has been set. + +### GetStatus + +`func (o *Campaign) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Campaign) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Campaign) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Campaign) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatusNil + +`func (o *Campaign) SetStatusNil(b bool)` + + SetStatusNil sets the value for Status to be an explicit nil + +### UnsetStatus +`func (o *Campaign) UnsetStatus()` + +UnsetStatus ensures that no value is present for Status, not even an explicit nil +### GetCorrelatedStatus + +`func (o *Campaign) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *Campaign) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *Campaign) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + +### HasCorrelatedStatus + +`func (o *Campaign) HasCorrelatedStatus() bool` + +HasCorrelatedStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *Campaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Campaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Campaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Campaign) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *Campaign) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *Campaign) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetTotalCertifications + +`func (o *Campaign) GetTotalCertifications() int32` + +GetTotalCertifications returns the TotalCertifications field if non-nil, zero value otherwise. + +### GetTotalCertificationsOk + +`func (o *Campaign) GetTotalCertificationsOk() (*int32, bool)` + +GetTotalCertificationsOk returns a tuple with the TotalCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCertifications + +`func (o *Campaign) SetTotalCertifications(v int32)` + +SetTotalCertifications sets TotalCertifications field to given value. + +### HasTotalCertifications + +`func (o *Campaign) HasTotalCertifications() bool` + +HasTotalCertifications returns a boolean if a field has been set. + +### SetTotalCertificationsNil + +`func (o *Campaign) SetTotalCertificationsNil(b bool)` + + SetTotalCertificationsNil sets the value for TotalCertifications to be an explicit nil + +### UnsetTotalCertifications +`func (o *Campaign) UnsetTotalCertifications()` + +UnsetTotalCertifications ensures that no value is present for TotalCertifications, not even an explicit nil +### GetCompletedCertifications + +`func (o *Campaign) GetCompletedCertifications() int32` + +GetCompletedCertifications returns the CompletedCertifications field if non-nil, zero value otherwise. + +### GetCompletedCertificationsOk + +`func (o *Campaign) GetCompletedCertificationsOk() (*int32, bool)` + +GetCompletedCertificationsOk returns a tuple with the CompletedCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedCertifications + +`func (o *Campaign) SetCompletedCertifications(v int32)` + +SetCompletedCertifications sets CompletedCertifications field to given value. + +### HasCompletedCertifications + +`func (o *Campaign) HasCompletedCertifications() bool` + +HasCompletedCertifications returns a boolean if a field has been set. + +### SetCompletedCertificationsNil + +`func (o *Campaign) SetCompletedCertificationsNil(b bool)` + + SetCompletedCertificationsNil sets the value for CompletedCertifications to be an explicit nil + +### UnsetCompletedCertifications +`func (o *Campaign) UnsetCompletedCertifications()` + +UnsetCompletedCertifications ensures that no value is present for CompletedCertifications, not even an explicit nil +### GetAlerts + +`func (o *Campaign) GetAlerts() []CampaignAlert` + +GetAlerts returns the Alerts field if non-nil, zero value otherwise. + +### GetAlertsOk + +`func (o *Campaign) GetAlertsOk() (*[]CampaignAlert, bool)` + +GetAlertsOk returns a tuple with the Alerts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlerts + +`func (o *Campaign) SetAlerts(v []CampaignAlert)` + +SetAlerts sets Alerts field to given value. + +### HasAlerts + +`func (o *Campaign) HasAlerts() bool` + +HasAlerts returns a boolean if a field has been set. + +### SetAlertsNil + +`func (o *Campaign) SetAlertsNil(b bool)` + + SetAlertsNil sets the value for Alerts to be an explicit nil + +### UnsetAlerts +`func (o *Campaign) UnsetAlerts()` + +UnsetAlerts ensures that no value is present for Alerts, not even an explicit nil +### GetModified + +`func (o *Campaign) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Campaign) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Campaign) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Campaign) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *Campaign) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *Campaign) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetFilter + +`func (o *Campaign) GetFilter() CampaignAllOfFilter` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *Campaign) GetFilterOk() (*CampaignAllOfFilter, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *Campaign) SetFilter(v CampaignAllOfFilter)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *Campaign) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### SetFilterNil + +`func (o *Campaign) SetFilterNil(b bool)` + + SetFilterNil sets the value for Filter to be an explicit nil + +### UnsetFilter +`func (o *Campaign) UnsetFilter()` + +UnsetFilter ensures that no value is present for Filter, not even an explicit nil +### GetSunsetCommentsRequired + +`func (o *Campaign) GetSunsetCommentsRequired() bool` + +GetSunsetCommentsRequired returns the SunsetCommentsRequired field if non-nil, zero value otherwise. + +### GetSunsetCommentsRequiredOk + +`func (o *Campaign) GetSunsetCommentsRequiredOk() (*bool, bool)` + +GetSunsetCommentsRequiredOk returns a tuple with the SunsetCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSunsetCommentsRequired + +`func (o *Campaign) SetSunsetCommentsRequired(v bool)` + +SetSunsetCommentsRequired sets SunsetCommentsRequired field to given value. + +### HasSunsetCommentsRequired + +`func (o *Campaign) HasSunsetCommentsRequired() bool` + +HasSunsetCommentsRequired returns a boolean if a field has been set. + +### GetSourceOwnerCampaignInfo + +`func (o *Campaign) GetSourceOwnerCampaignInfo() CampaignAllOfSourceOwnerCampaignInfo` + +GetSourceOwnerCampaignInfo returns the SourceOwnerCampaignInfo field if non-nil, zero value otherwise. + +### GetSourceOwnerCampaignInfoOk + +`func (o *Campaign) GetSourceOwnerCampaignInfoOk() (*CampaignAllOfSourceOwnerCampaignInfo, bool)` + +GetSourceOwnerCampaignInfoOk returns a tuple with the SourceOwnerCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceOwnerCampaignInfo + +`func (o *Campaign) SetSourceOwnerCampaignInfo(v CampaignAllOfSourceOwnerCampaignInfo)` + +SetSourceOwnerCampaignInfo sets SourceOwnerCampaignInfo field to given value. + +### HasSourceOwnerCampaignInfo + +`func (o *Campaign) HasSourceOwnerCampaignInfo() bool` + +HasSourceOwnerCampaignInfo returns a boolean if a field has been set. + +### SetSourceOwnerCampaignInfoNil + +`func (o *Campaign) SetSourceOwnerCampaignInfoNil(b bool)` + + SetSourceOwnerCampaignInfoNil sets the value for SourceOwnerCampaignInfo to be an explicit nil + +### UnsetSourceOwnerCampaignInfo +`func (o *Campaign) UnsetSourceOwnerCampaignInfo()` + +UnsetSourceOwnerCampaignInfo ensures that no value is present for SourceOwnerCampaignInfo, not even an explicit nil +### GetSearchCampaignInfo + +`func (o *Campaign) GetSearchCampaignInfo() CampaignAllOfSearchCampaignInfo` + +GetSearchCampaignInfo returns the SearchCampaignInfo field if non-nil, zero value otherwise. + +### GetSearchCampaignInfoOk + +`func (o *Campaign) GetSearchCampaignInfoOk() (*CampaignAllOfSearchCampaignInfo, bool)` + +GetSearchCampaignInfoOk returns a tuple with the SearchCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchCampaignInfo + +`func (o *Campaign) SetSearchCampaignInfo(v CampaignAllOfSearchCampaignInfo)` + +SetSearchCampaignInfo sets SearchCampaignInfo field to given value. + +### HasSearchCampaignInfo + +`func (o *Campaign) HasSearchCampaignInfo() bool` + +HasSearchCampaignInfo returns a boolean if a field has been set. + +### SetSearchCampaignInfoNil + +`func (o *Campaign) SetSearchCampaignInfoNil(b bool)` + + SetSearchCampaignInfoNil sets the value for SearchCampaignInfo to be an explicit nil + +### UnsetSearchCampaignInfo +`func (o *Campaign) UnsetSearchCampaignInfo()` + +UnsetSearchCampaignInfo ensures that no value is present for SearchCampaignInfo, not even an explicit nil +### GetRoleCompositionCampaignInfo + +`func (o *Campaign) GetRoleCompositionCampaignInfo() CampaignAllOfRoleCompositionCampaignInfo` + +GetRoleCompositionCampaignInfo returns the RoleCompositionCampaignInfo field if non-nil, zero value otherwise. + +### GetRoleCompositionCampaignInfoOk + +`func (o *Campaign) GetRoleCompositionCampaignInfoOk() (*CampaignAllOfRoleCompositionCampaignInfo, bool)` + +GetRoleCompositionCampaignInfoOk returns a tuple with the RoleCompositionCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleCompositionCampaignInfo + +`func (o *Campaign) SetRoleCompositionCampaignInfo(v CampaignAllOfRoleCompositionCampaignInfo)` + +SetRoleCompositionCampaignInfo sets RoleCompositionCampaignInfo field to given value. + +### HasRoleCompositionCampaignInfo + +`func (o *Campaign) HasRoleCompositionCampaignInfo() bool` + +HasRoleCompositionCampaignInfo returns a boolean if a field has been set. + +### SetRoleCompositionCampaignInfoNil + +`func (o *Campaign) SetRoleCompositionCampaignInfoNil(b bool)` + + SetRoleCompositionCampaignInfoNil sets the value for RoleCompositionCampaignInfo to be an explicit nil + +### UnsetRoleCompositionCampaignInfo +`func (o *Campaign) UnsetRoleCompositionCampaignInfo()` + +UnsetRoleCompositionCampaignInfo ensures that no value is present for RoleCompositionCampaignInfo, not even an explicit nil +### GetMachineAccountCampaignInfo + +`func (o *Campaign) GetMachineAccountCampaignInfo() CampaignAllOfMachineAccountCampaignInfo` + +GetMachineAccountCampaignInfo returns the MachineAccountCampaignInfo field if non-nil, zero value otherwise. + +### GetMachineAccountCampaignInfoOk + +`func (o *Campaign) GetMachineAccountCampaignInfoOk() (*CampaignAllOfMachineAccountCampaignInfo, bool)` + +GetMachineAccountCampaignInfoOk returns a tuple with the MachineAccountCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMachineAccountCampaignInfo + +`func (o *Campaign) SetMachineAccountCampaignInfo(v CampaignAllOfMachineAccountCampaignInfo)` + +SetMachineAccountCampaignInfo sets MachineAccountCampaignInfo field to given value. + +### HasMachineAccountCampaignInfo + +`func (o *Campaign) HasMachineAccountCampaignInfo() bool` + +HasMachineAccountCampaignInfo returns a boolean if a field has been set. + +### SetMachineAccountCampaignInfoNil + +`func (o *Campaign) SetMachineAccountCampaignInfoNil(b bool)` + + SetMachineAccountCampaignInfoNil sets the value for MachineAccountCampaignInfo to be an explicit nil + +### UnsetMachineAccountCampaignInfo +`func (o *Campaign) UnsetMachineAccountCampaignInfo()` + +UnsetMachineAccountCampaignInfo ensures that no value is present for MachineAccountCampaignInfo, not even an explicit nil +### GetSourcesWithOrphanEntitlements + +`func (o *Campaign) GetSourcesWithOrphanEntitlements() []CampaignAllOfSourcesWithOrphanEntitlements` + +GetSourcesWithOrphanEntitlements returns the SourcesWithOrphanEntitlements field if non-nil, zero value otherwise. + +### GetSourcesWithOrphanEntitlementsOk + +`func (o *Campaign) GetSourcesWithOrphanEntitlementsOk() (*[]CampaignAllOfSourcesWithOrphanEntitlements, bool)` + +GetSourcesWithOrphanEntitlementsOk returns a tuple with the SourcesWithOrphanEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourcesWithOrphanEntitlements + +`func (o *Campaign) SetSourcesWithOrphanEntitlements(v []CampaignAllOfSourcesWithOrphanEntitlements)` + +SetSourcesWithOrphanEntitlements sets SourcesWithOrphanEntitlements field to given value. + +### HasSourcesWithOrphanEntitlements + +`func (o *Campaign) HasSourcesWithOrphanEntitlements() bool` + +HasSourcesWithOrphanEntitlements returns a boolean if a field has been set. + +### SetSourcesWithOrphanEntitlementsNil + +`func (o *Campaign) SetSourcesWithOrphanEntitlementsNil(b bool)` + + SetSourcesWithOrphanEntitlementsNil sets the value for SourcesWithOrphanEntitlements to be an explicit nil + +### UnsetSourcesWithOrphanEntitlements +`func (o *Campaign) UnsetSourcesWithOrphanEntitlements()` + +UnsetSourcesWithOrphanEntitlements ensures that no value is present for SourcesWithOrphanEntitlements, not even an explicit nil +### GetMandatoryCommentRequirement + +`func (o *Campaign) GetMandatoryCommentRequirement() string` + +GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise. + +### GetMandatoryCommentRequirementOk + +`func (o *Campaign) GetMandatoryCommentRequirementOk() (*string, bool)` + +GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMandatoryCommentRequirement + +`func (o *Campaign) SetMandatoryCommentRequirement(v string)` + +SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value. + +### HasMandatoryCommentRequirement + +`func (o *Campaign) HasMandatoryCommentRequirement() bool` + +HasMandatoryCommentRequirement returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignActivated.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignActivated.md new file mode 100644 index 000000000..a6cbc1b81 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignActivated.md @@ -0,0 +1,59 @@ +--- +id: v2025-campaign-activated +title: CampaignActivated +pagination_label: CampaignActivated +sidebar_label: CampaignActivated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignActivated', 'V2025CampaignActivated'] +slug: /tools/sdk/go/v2025/models/campaign-activated +tags: ['SDK', 'Software Development Kit', 'CampaignActivated', 'V2025CampaignActivated'] +--- + +# CampaignActivated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | [**CampaignActivatedCampaign**](campaign-activated-campaign) | | + +## Methods + +### NewCampaignActivated + +`func NewCampaignActivated(campaign CampaignActivatedCampaign, ) *CampaignActivated` + +NewCampaignActivated instantiates a new CampaignActivated 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 + +### NewCampaignActivatedWithDefaults + +`func NewCampaignActivatedWithDefaults() *CampaignActivated` + +NewCampaignActivatedWithDefaults instantiates a new CampaignActivated 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 + +### GetCampaign + +`func (o *CampaignActivated) GetCampaign() CampaignActivatedCampaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignActivated) GetCampaignOk() (*CampaignActivatedCampaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *CampaignActivated) SetCampaign(v CampaignActivatedCampaign)` + +SetCampaign sets Campaign field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignActivatedCampaign.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignActivatedCampaign.md new file mode 100644 index 000000000..def23c611 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignActivatedCampaign.md @@ -0,0 +1,242 @@ +--- +id: v2025-campaign-activated-campaign +title: CampaignActivatedCampaign +pagination_label: CampaignActivatedCampaign +sidebar_label: CampaignActivatedCampaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignActivatedCampaign', 'V2025CampaignActivatedCampaign'] +slug: /tools/sdk/go/v2025/models/campaign-activated-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaign', 'V2025CampaignActivatedCampaign'] +--- + +# CampaignActivatedCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique ID for the campaign. | +**Name** | **string** | The human friendly name of the campaign. | +**Description** | **string** | Extended description of the campaign. | +**Created** | **SailPointTime** | The date and time the campaign was created. | +**Modified** | Pointer to **NullableTime** | The date and time the campaign was last modified. | [optional] +**Deadline** | **SailPointTime** | The date and time the campaign is due. | +**Type** | **map[string]interface{}** | The type of campaign. | +**CampaignOwner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | +**Status** | **map[string]interface{}** | The current status of the campaign. | + +## Methods + +### NewCampaignActivatedCampaign + +`func NewCampaignActivatedCampaign(id string, name string, description string, created SailPointTime, deadline SailPointTime, type_ map[string]interface{}, campaignOwner CampaignActivatedCampaignCampaignOwner, status map[string]interface{}, ) *CampaignActivatedCampaign` + +NewCampaignActivatedCampaign instantiates a new CampaignActivatedCampaign 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 + +### NewCampaignActivatedCampaignWithDefaults + +`func NewCampaignActivatedCampaignWithDefaults() *CampaignActivatedCampaign` + +NewCampaignActivatedCampaignWithDefaults instantiates a new CampaignActivatedCampaign 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 + +### GetId + +`func (o *CampaignActivatedCampaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignActivatedCampaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignActivatedCampaign) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignActivatedCampaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignActivatedCampaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignActivatedCampaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CampaignActivatedCampaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignActivatedCampaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignActivatedCampaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetCreated + +`func (o *CampaignActivatedCampaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignActivatedCampaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CampaignActivatedCampaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CampaignActivatedCampaign) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CampaignActivatedCampaign) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CampaignActivatedCampaign) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CampaignActivatedCampaign) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CampaignActivatedCampaign) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CampaignActivatedCampaign) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDeadline + +`func (o *CampaignActivatedCampaign) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *CampaignActivatedCampaign) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *CampaignActivatedCampaign) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + + +### GetType + +`func (o *CampaignActivatedCampaign) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignActivatedCampaign) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignActivatedCampaign) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetCampaignOwner + +`func (o *CampaignActivatedCampaign) GetCampaignOwner() CampaignActivatedCampaignCampaignOwner` + +GetCampaignOwner returns the CampaignOwner field if non-nil, zero value otherwise. + +### GetCampaignOwnerOk + +`func (o *CampaignActivatedCampaign) GetCampaignOwnerOk() (*CampaignActivatedCampaignCampaignOwner, bool)` + +GetCampaignOwnerOk returns a tuple with the CampaignOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignOwner + +`func (o *CampaignActivatedCampaign) SetCampaignOwner(v CampaignActivatedCampaignCampaignOwner)` + +SetCampaignOwner sets CampaignOwner field to given value. + + +### GetStatus + +`func (o *CampaignActivatedCampaign) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CampaignActivatedCampaign) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CampaignActivatedCampaign) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignActivatedCampaignCampaignOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignActivatedCampaignCampaignOwner.md new file mode 100644 index 000000000..2d6773cff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignActivatedCampaignCampaignOwner.md @@ -0,0 +1,101 @@ +--- +id: v2025-campaign-activated-campaign-campaign-owner +title: CampaignActivatedCampaignCampaignOwner +pagination_label: CampaignActivatedCampaignCampaignOwner +sidebar_label: CampaignActivatedCampaignCampaignOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignActivatedCampaignCampaignOwner', 'V2025CampaignActivatedCampaignCampaignOwner'] +slug: /tools/sdk/go/v2025/models/campaign-activated-campaign-campaign-owner +tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaignCampaignOwner', 'V2025CampaignActivatedCampaignCampaignOwner'] +--- + +# CampaignActivatedCampaignCampaignOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the identity. | +**DisplayName** | **string** | The human friendly name of the identity. | +**Email** | **string** | The primary email address of the identity. | + +## Methods + +### NewCampaignActivatedCampaignCampaignOwner + +`func NewCampaignActivatedCampaignCampaignOwner(id string, displayName string, email string, ) *CampaignActivatedCampaignCampaignOwner` + +NewCampaignActivatedCampaignCampaignOwner instantiates a new CampaignActivatedCampaignCampaignOwner 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 + +### NewCampaignActivatedCampaignCampaignOwnerWithDefaults + +`func NewCampaignActivatedCampaignCampaignOwnerWithDefaults() *CampaignActivatedCampaignCampaignOwner` + +NewCampaignActivatedCampaignCampaignOwnerWithDefaults instantiates a new CampaignActivatedCampaignCampaignOwner 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 + +### GetId + +`func (o *CampaignActivatedCampaignCampaignOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignActivatedCampaignCampaignOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignActivatedCampaignCampaignOwner) SetId(v string)` + +SetId sets Id field to given value. + + +### GetDisplayName + +`func (o *CampaignActivatedCampaignCampaignOwner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *CampaignActivatedCampaignCampaignOwner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *CampaignActivatedCampaignCampaignOwner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + + +### GetEmail + +`func (o *CampaignActivatedCampaignCampaignOwner) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *CampaignActivatedCampaignCampaignOwner) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *CampaignActivatedCampaignCampaignOwner) SetEmail(v string)` + +SetEmail sets Email field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignAlert.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAlert.md new file mode 100644 index 000000000..4c6c2b0c7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAlert.md @@ -0,0 +1,90 @@ +--- +id: v2025-campaign-alert +title: CampaignAlert +pagination_label: CampaignAlert +sidebar_label: CampaignAlert +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAlert', 'V2025CampaignAlert'] +slug: /tools/sdk/go/v2025/models/campaign-alert +tags: ['SDK', 'Software Development Kit', 'CampaignAlert', 'V2025CampaignAlert'] +--- + +# CampaignAlert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Level** | Pointer to **string** | Denotes the level of the message | [optional] +**Localizations** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] + +## Methods + +### NewCampaignAlert + +`func NewCampaignAlert() *CampaignAlert` + +NewCampaignAlert instantiates a new CampaignAlert 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 + +### NewCampaignAlertWithDefaults + +`func NewCampaignAlertWithDefaults() *CampaignAlert` + +NewCampaignAlertWithDefaults instantiates a new CampaignAlert 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 + +### GetLevel + +`func (o *CampaignAlert) GetLevel() string` + +GetLevel returns the Level field if non-nil, zero value otherwise. + +### GetLevelOk + +`func (o *CampaignAlert) GetLevelOk() (*string, bool)` + +GetLevelOk returns a tuple with the Level field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLevel + +`func (o *CampaignAlert) SetLevel(v string)` + +SetLevel sets Level field to given value. + +### HasLevel + +`func (o *CampaignAlert) HasLevel() bool` + +HasLevel returns a boolean if a field has been set. + +### GetLocalizations + +`func (o *CampaignAlert) GetLocalizations() []ErrorMessageDto` + +GetLocalizations returns the Localizations field if non-nil, zero value otherwise. + +### GetLocalizationsOk + +`func (o *CampaignAlert) GetLocalizationsOk() (*[]ErrorMessageDto, bool)` + +GetLocalizationsOk returns a tuple with the Localizations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizations + +`func (o *CampaignAlert) SetLocalizations(v []ErrorMessageDto)` + +SetLocalizations sets Localizations field to given value. + +### HasLocalizations + +`func (o *CampaignAlert) HasLocalizations() bool` + +HasLocalizations returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfFilter.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfFilter.md new file mode 100644 index 000000000..8d36486b5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfFilter.md @@ -0,0 +1,116 @@ +--- +id: v2025-campaign-all-of-filter +title: CampaignAllOfFilter +pagination_label: CampaignAllOfFilter +sidebar_label: CampaignAllOfFilter +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfFilter', 'V2025CampaignAllOfFilter'] +slug: /tools/sdk/go/v2025/models/campaign-all-of-filter +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfFilter', 'V2025CampaignAllOfFilter'] +--- + +# CampaignAllOfFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of whatever type of filter is being used. | [optional] +**Type** | Pointer to **string** | Type of the filter | [optional] +**Name** | Pointer to **string** | Name of the filter | [optional] + +## Methods + +### NewCampaignAllOfFilter + +`func NewCampaignAllOfFilter() *CampaignAllOfFilter` + +NewCampaignAllOfFilter instantiates a new CampaignAllOfFilter 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 + +### NewCampaignAllOfFilterWithDefaults + +`func NewCampaignAllOfFilterWithDefaults() *CampaignAllOfFilter` + +NewCampaignAllOfFilterWithDefaults instantiates a new CampaignAllOfFilter 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 + +### GetId + +`func (o *CampaignAllOfFilter) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignAllOfFilter) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignAllOfFilter) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignAllOfFilter) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CampaignAllOfFilter) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfFilter) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfFilter) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignAllOfFilter) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignAllOfFilter) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignAllOfFilter) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignAllOfFilter) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignAllOfFilter) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfMachineAccountCampaignInfo.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfMachineAccountCampaignInfo.md new file mode 100644 index 000000000..efa737759 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfMachineAccountCampaignInfo.md @@ -0,0 +1,90 @@ +--- +id: v2025-campaign-all-of-machine-account-campaign-info +title: CampaignAllOfMachineAccountCampaignInfo +pagination_label: CampaignAllOfMachineAccountCampaignInfo +sidebar_label: CampaignAllOfMachineAccountCampaignInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfMachineAccountCampaignInfo', 'V2025CampaignAllOfMachineAccountCampaignInfo'] +slug: /tools/sdk/go/v2025/models/campaign-all-of-machine-account-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfMachineAccountCampaignInfo', 'V2025CampaignAllOfMachineAccountCampaignInfo'] +--- + +# CampaignAllOfMachineAccountCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceIds** | Pointer to **[]string** | The list of sources to be included in the campaign. | [optional] +**ReviewerType** | Pointer to **string** | The reviewer's type. | [optional] + +## Methods + +### NewCampaignAllOfMachineAccountCampaignInfo + +`func NewCampaignAllOfMachineAccountCampaignInfo() *CampaignAllOfMachineAccountCampaignInfo` + +NewCampaignAllOfMachineAccountCampaignInfo instantiates a new CampaignAllOfMachineAccountCampaignInfo 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 + +### NewCampaignAllOfMachineAccountCampaignInfoWithDefaults + +`func NewCampaignAllOfMachineAccountCampaignInfoWithDefaults() *CampaignAllOfMachineAccountCampaignInfo` + +NewCampaignAllOfMachineAccountCampaignInfoWithDefaults instantiates a new CampaignAllOfMachineAccountCampaignInfo 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 + +### GetSourceIds + +`func (o *CampaignAllOfMachineAccountCampaignInfo) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *CampaignAllOfMachineAccountCampaignInfo) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *CampaignAllOfMachineAccountCampaignInfo) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *CampaignAllOfMachineAccountCampaignInfo) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + +### GetReviewerType + +`func (o *CampaignAllOfMachineAccountCampaignInfo) GetReviewerType() string` + +GetReviewerType returns the ReviewerType field if non-nil, zero value otherwise. + +### GetReviewerTypeOk + +`func (o *CampaignAllOfMachineAccountCampaignInfo) GetReviewerTypeOk() (*string, bool)` + +GetReviewerTypeOk returns a tuple with the ReviewerType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerType + +`func (o *CampaignAllOfMachineAccountCampaignInfo) SetReviewerType(v string)` + +SetReviewerType sets ReviewerType field to given value. + +### HasReviewerType + +`func (o *CampaignAllOfMachineAccountCampaignInfo) HasReviewerType() bool` + +HasReviewerType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfRoleCompositionCampaignInfo.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfRoleCompositionCampaignInfo.md new file mode 100644 index 000000000..b196ded41 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfRoleCompositionCampaignInfo.md @@ -0,0 +1,229 @@ +--- +id: v2025-campaign-all-of-role-composition-campaign-info +title: CampaignAllOfRoleCompositionCampaignInfo +pagination_label: CampaignAllOfRoleCompositionCampaignInfo +sidebar_label: CampaignAllOfRoleCompositionCampaignInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfo', 'V2025CampaignAllOfRoleCompositionCampaignInfo'] +slug: /tools/sdk/go/v2025/models/campaign-all-of-role-composition-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfo', 'V2025CampaignAllOfRoleCompositionCampaignInfo'] +--- + +# CampaignAllOfRoleCompositionCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReviewerId** | Pointer to **NullableString** | The ID of the identity or governance group reviewing this campaign. Deprecated in favor of the \"reviewer\" object. | [optional] +**Reviewer** | Pointer to [**NullableCampaignAllOfRoleCompositionCampaignInfoReviewer**](campaign-all-of-role-composition-campaign-info-reviewer) | | [optional] +**RoleIds** | Pointer to **[]string** | Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] +**RemediatorRef** | [**CampaignAllOfRoleCompositionCampaignInfoRemediatorRef**](campaign-all-of-role-composition-campaign-info-remediator-ref) | | +**Query** | Pointer to **NullableString** | Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] +**Description** | Pointer to **NullableString** | Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. | [optional] + +## Methods + +### NewCampaignAllOfRoleCompositionCampaignInfo + +`func NewCampaignAllOfRoleCompositionCampaignInfo(remediatorRef CampaignAllOfRoleCompositionCampaignInfoRemediatorRef, ) *CampaignAllOfRoleCompositionCampaignInfo` + +NewCampaignAllOfRoleCompositionCampaignInfo instantiates a new CampaignAllOfRoleCompositionCampaignInfo 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 + +### NewCampaignAllOfRoleCompositionCampaignInfoWithDefaults + +`func NewCampaignAllOfRoleCompositionCampaignInfoWithDefaults() *CampaignAllOfRoleCompositionCampaignInfo` + +NewCampaignAllOfRoleCompositionCampaignInfoWithDefaults instantiates a new CampaignAllOfRoleCompositionCampaignInfo 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 + +### GetReviewerId + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetReviewerId() string` + +GetReviewerId returns the ReviewerId field if non-nil, zero value otherwise. + +### GetReviewerIdOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetReviewerIdOk() (*string, bool)` + +GetReviewerIdOk returns a tuple with the ReviewerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerId + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetReviewerId(v string)` + +SetReviewerId sets ReviewerId field to given value. + +### HasReviewerId + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) HasReviewerId() bool` + +HasReviewerId returns a boolean if a field has been set. + +### SetReviewerIdNil + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetReviewerIdNil(b bool)` + + SetReviewerIdNil sets the value for ReviewerId to be an explicit nil + +### UnsetReviewerId +`func (o *CampaignAllOfRoleCompositionCampaignInfo) UnsetReviewerId()` + +UnsetReviewerId ensures that no value is present for ReviewerId, not even an explicit nil +### GetReviewer + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetReviewer() CampaignAllOfRoleCompositionCampaignInfoReviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetReviewerOk() (*CampaignAllOfRoleCompositionCampaignInfoReviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetReviewer(v CampaignAllOfRoleCompositionCampaignInfoReviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### SetReviewerNil + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetReviewerNil(b bool)` + + SetReviewerNil sets the value for Reviewer to be an explicit nil + +### UnsetReviewer +`func (o *CampaignAllOfRoleCompositionCampaignInfo) UnsetReviewer()` + +UnsetReviewer ensures that no value is present for Reviewer, not even an explicit nil +### GetRoleIds + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetRoleIds() []string` + +GetRoleIds returns the RoleIds field if non-nil, zero value otherwise. + +### GetRoleIdsOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetRoleIdsOk() (*[]string, bool)` + +GetRoleIdsOk returns a tuple with the RoleIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleIds + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetRoleIds(v []string)` + +SetRoleIds sets RoleIds field to given value. + +### HasRoleIds + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) HasRoleIds() bool` + +HasRoleIds returns a boolean if a field has been set. + +### GetRemediatorRef + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetRemediatorRef() CampaignAllOfRoleCompositionCampaignInfoRemediatorRef` + +GetRemediatorRef returns the RemediatorRef field if non-nil, zero value otherwise. + +### GetRemediatorRefOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetRemediatorRefOk() (*CampaignAllOfRoleCompositionCampaignInfoRemediatorRef, bool)` + +GetRemediatorRefOk returns a tuple with the RemediatorRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemediatorRef + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetRemediatorRef(v CampaignAllOfRoleCompositionCampaignInfoRemediatorRef)` + +SetRemediatorRef sets RemediatorRef field to given value. + + +### GetQuery + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### SetQueryNil + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetQueryNil(b bool)` + + SetQueryNil sets the value for Query to be an explicit nil + +### UnsetQuery +`func (o *CampaignAllOfRoleCompositionCampaignInfo) UnsetQuery()` + +UnsetQuery ensures that no value is present for Query, not even an explicit nil +### GetDescription + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CampaignAllOfRoleCompositionCampaignInfo) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md new file mode 100644 index 000000000..53f2c01a7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md @@ -0,0 +1,106 @@ +--- +id: v2025-campaign-all-of-role-composition-campaign-info-remediator-ref +title: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +pagination_label: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_label: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'V2025CampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +slug: /tools/sdk/go/v2025/models/campaign-all-of-role-composition-campaign-info-remediator-ref +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'V2025CampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +--- + +# CampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Legal Remediator Type | +**Id** | **string** | The ID of the remediator. | +**Name** | Pointer to **string** | The name of the remediator. | [optional] [readonly] + +## Methods + +### NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +`func NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRef(type_ string, id string, ) *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef` + +NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRef instantiates a new CampaignAllOfRoleCompositionCampaignInfoRemediatorRef 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 + +### NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRefWithDefaults + +`func NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRefWithDefaults() *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef` + +NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRefWithDefaults instantiates a new CampaignAllOfRoleCompositionCampaignInfoRemediatorRef 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 + +### GetType + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfRoleCompositionCampaignInfoReviewer.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfRoleCompositionCampaignInfoReviewer.md new file mode 100644 index 000000000..1a5e1718e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfRoleCompositionCampaignInfoReviewer.md @@ -0,0 +1,116 @@ +--- +id: v2025-campaign-all-of-role-composition-campaign-info-reviewer +title: CampaignAllOfRoleCompositionCampaignInfoReviewer +pagination_label: CampaignAllOfRoleCompositionCampaignInfoReviewer +sidebar_label: CampaignAllOfRoleCompositionCampaignInfoReviewer +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfoReviewer', 'V2025CampaignAllOfRoleCompositionCampaignInfoReviewer'] +slug: /tools/sdk/go/v2025/models/campaign-all-of-role-composition-campaign-info-reviewer +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfoReviewer', 'V2025CampaignAllOfRoleCompositionCampaignInfoReviewer'] +--- + +# CampaignAllOfRoleCompositionCampaignInfoReviewer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The reviewer's DTO type. | [optional] +**Id** | Pointer to **string** | The reviewer's ID. | [optional] +**Name** | Pointer to **string** | The reviewer's name. | [optional] + +## Methods + +### NewCampaignAllOfRoleCompositionCampaignInfoReviewer + +`func NewCampaignAllOfRoleCompositionCampaignInfoReviewer() *CampaignAllOfRoleCompositionCampaignInfoReviewer` + +NewCampaignAllOfRoleCompositionCampaignInfoReviewer instantiates a new CampaignAllOfRoleCompositionCampaignInfoReviewer 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 + +### NewCampaignAllOfRoleCompositionCampaignInfoReviewerWithDefaults + +`func NewCampaignAllOfRoleCompositionCampaignInfoReviewerWithDefaults() *CampaignAllOfRoleCompositionCampaignInfoReviewer` + +NewCampaignAllOfRoleCompositionCampaignInfoReviewerWithDefaults instantiates a new CampaignAllOfRoleCompositionCampaignInfoReviewer 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 + +### GetType + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignAllOfRoleCompositionCampaignInfoReviewer) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfSearchCampaignInfo.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfSearchCampaignInfo.md new file mode 100644 index 000000000..43b91f8ad --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfSearchCampaignInfo.md @@ -0,0 +1,219 @@ +--- +id: v2025-campaign-all-of-search-campaign-info +title: CampaignAllOfSearchCampaignInfo +pagination_label: CampaignAllOfSearchCampaignInfo +sidebar_label: CampaignAllOfSearchCampaignInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfSearchCampaignInfo', 'V2025CampaignAllOfSearchCampaignInfo'] +slug: /tools/sdk/go/v2025/models/campaign-all-of-search-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfo', 'V2025CampaignAllOfSearchCampaignInfo'] +--- + +# CampaignAllOfSearchCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of search campaign represented. | +**Description** | Pointer to **string** | Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. | [optional] +**Reviewer** | Pointer to [**NullableCampaignAllOfSearchCampaignInfoReviewer**](campaign-all-of-search-campaign-info-reviewer) | | [optional] +**Query** | Pointer to **NullableString** | The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set. | [optional] +**IdentityIds** | Pointer to **[]string** | A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. | [optional] +**AccessConstraints** | Pointer to [**[]AccessConstraint**](access-constraint) | Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. | [optional] + +## Methods + +### NewCampaignAllOfSearchCampaignInfo + +`func NewCampaignAllOfSearchCampaignInfo(type_ string, ) *CampaignAllOfSearchCampaignInfo` + +NewCampaignAllOfSearchCampaignInfo instantiates a new CampaignAllOfSearchCampaignInfo 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 + +### NewCampaignAllOfSearchCampaignInfoWithDefaults + +`func NewCampaignAllOfSearchCampaignInfoWithDefaults() *CampaignAllOfSearchCampaignInfo` + +NewCampaignAllOfSearchCampaignInfoWithDefaults instantiates a new CampaignAllOfSearchCampaignInfo 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 + +### GetType + +`func (o *CampaignAllOfSearchCampaignInfo) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfSearchCampaignInfo) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDescription + +`func (o *CampaignAllOfSearchCampaignInfo) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignAllOfSearchCampaignInfo) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CampaignAllOfSearchCampaignInfo) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetReviewer + +`func (o *CampaignAllOfSearchCampaignInfo) GetReviewer() CampaignAllOfSearchCampaignInfoReviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetReviewerOk() (*CampaignAllOfSearchCampaignInfoReviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CampaignAllOfSearchCampaignInfo) SetReviewer(v CampaignAllOfSearchCampaignInfoReviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *CampaignAllOfSearchCampaignInfo) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### SetReviewerNil + +`func (o *CampaignAllOfSearchCampaignInfo) SetReviewerNil(b bool)` + + SetReviewerNil sets the value for Reviewer to be an explicit nil + +### UnsetReviewer +`func (o *CampaignAllOfSearchCampaignInfo) UnsetReviewer()` + +UnsetReviewer ensures that no value is present for Reviewer, not even an explicit nil +### GetQuery + +`func (o *CampaignAllOfSearchCampaignInfo) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *CampaignAllOfSearchCampaignInfo) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *CampaignAllOfSearchCampaignInfo) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### SetQueryNil + +`func (o *CampaignAllOfSearchCampaignInfo) SetQueryNil(b bool)` + + SetQueryNil sets the value for Query to be an explicit nil + +### UnsetQuery +`func (o *CampaignAllOfSearchCampaignInfo) UnsetQuery()` + +UnsetQuery ensures that no value is present for Query, not even an explicit nil +### GetIdentityIds + +`func (o *CampaignAllOfSearchCampaignInfo) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *CampaignAllOfSearchCampaignInfo) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *CampaignAllOfSearchCampaignInfo) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + +### SetIdentityIdsNil + +`func (o *CampaignAllOfSearchCampaignInfo) SetIdentityIdsNil(b bool)` + + SetIdentityIdsNil sets the value for IdentityIds to be an explicit nil + +### UnsetIdentityIds +`func (o *CampaignAllOfSearchCampaignInfo) UnsetIdentityIds()` + +UnsetIdentityIds ensures that no value is present for IdentityIds, not even an explicit nil +### GetAccessConstraints + +`func (o *CampaignAllOfSearchCampaignInfo) GetAccessConstraints() []AccessConstraint` + +GetAccessConstraints returns the AccessConstraints field if non-nil, zero value otherwise. + +### GetAccessConstraintsOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetAccessConstraintsOk() (*[]AccessConstraint, bool)` + +GetAccessConstraintsOk returns a tuple with the AccessConstraints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessConstraints + +`func (o *CampaignAllOfSearchCampaignInfo) SetAccessConstraints(v []AccessConstraint)` + +SetAccessConstraints sets AccessConstraints field to given value. + +### HasAccessConstraints + +`func (o *CampaignAllOfSearchCampaignInfo) HasAccessConstraints() bool` + +HasAccessConstraints returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfSearchCampaignInfoReviewer.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfSearchCampaignInfoReviewer.md new file mode 100644 index 000000000..0aaf722f5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfSearchCampaignInfoReviewer.md @@ -0,0 +1,126 @@ +--- +id: v2025-campaign-all-of-search-campaign-info-reviewer +title: CampaignAllOfSearchCampaignInfoReviewer +pagination_label: CampaignAllOfSearchCampaignInfoReviewer +sidebar_label: CampaignAllOfSearchCampaignInfoReviewer +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfSearchCampaignInfoReviewer', 'V2025CampaignAllOfSearchCampaignInfoReviewer'] +slug: /tools/sdk/go/v2025/models/campaign-all-of-search-campaign-info-reviewer +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfoReviewer', 'V2025CampaignAllOfSearchCampaignInfoReviewer'] +--- + +# CampaignAllOfSearchCampaignInfoReviewer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The reviewer's DTO type. | [optional] +**Id** | Pointer to **string** | The reviewer's ID. | [optional] +**Name** | Pointer to **NullableString** | The reviewer's name. | [optional] + +## Methods + +### NewCampaignAllOfSearchCampaignInfoReviewer + +`func NewCampaignAllOfSearchCampaignInfoReviewer() *CampaignAllOfSearchCampaignInfoReviewer` + +NewCampaignAllOfSearchCampaignInfoReviewer instantiates a new CampaignAllOfSearchCampaignInfoReviewer 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 + +### NewCampaignAllOfSearchCampaignInfoReviewerWithDefaults + +`func NewCampaignAllOfSearchCampaignInfoReviewerWithDefaults() *CampaignAllOfSearchCampaignInfoReviewer` + +NewCampaignAllOfSearchCampaignInfoReviewerWithDefaults instantiates a new CampaignAllOfSearchCampaignInfoReviewer 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 + +### GetType + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *CampaignAllOfSearchCampaignInfoReviewer) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfSourceOwnerCampaignInfo.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfSourceOwnerCampaignInfo.md new file mode 100644 index 000000000..dd12c4a65 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfSourceOwnerCampaignInfo.md @@ -0,0 +1,64 @@ +--- +id: v2025-campaign-all-of-source-owner-campaign-info +title: CampaignAllOfSourceOwnerCampaignInfo +pagination_label: CampaignAllOfSourceOwnerCampaignInfo +sidebar_label: CampaignAllOfSourceOwnerCampaignInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfSourceOwnerCampaignInfo', 'V2025CampaignAllOfSourceOwnerCampaignInfo'] +slug: /tools/sdk/go/v2025/models/campaign-all-of-source-owner-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSourceOwnerCampaignInfo', 'V2025CampaignAllOfSourceOwnerCampaignInfo'] +--- + +# CampaignAllOfSourceOwnerCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceIds** | Pointer to **[]string** | The list of sources to be included in the campaign. | [optional] + +## Methods + +### NewCampaignAllOfSourceOwnerCampaignInfo + +`func NewCampaignAllOfSourceOwnerCampaignInfo() *CampaignAllOfSourceOwnerCampaignInfo` + +NewCampaignAllOfSourceOwnerCampaignInfo instantiates a new CampaignAllOfSourceOwnerCampaignInfo 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 + +### NewCampaignAllOfSourceOwnerCampaignInfoWithDefaults + +`func NewCampaignAllOfSourceOwnerCampaignInfoWithDefaults() *CampaignAllOfSourceOwnerCampaignInfo` + +NewCampaignAllOfSourceOwnerCampaignInfoWithDefaults instantiates a new CampaignAllOfSourceOwnerCampaignInfo 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 + +### GetSourceIds + +`func (o *CampaignAllOfSourceOwnerCampaignInfo) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *CampaignAllOfSourceOwnerCampaignInfo) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *CampaignAllOfSourceOwnerCampaignInfo) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *CampaignAllOfSourceOwnerCampaignInfo) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfSourcesWithOrphanEntitlements.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfSourcesWithOrphanEntitlements.md new file mode 100644 index 000000000..826abd677 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignAllOfSourcesWithOrphanEntitlements.md @@ -0,0 +1,116 @@ +--- +id: v2025-campaign-all-of-sources-with-orphan-entitlements +title: CampaignAllOfSourcesWithOrphanEntitlements +pagination_label: CampaignAllOfSourcesWithOrphanEntitlements +sidebar_label: CampaignAllOfSourcesWithOrphanEntitlements +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfSourcesWithOrphanEntitlements', 'V2025CampaignAllOfSourcesWithOrphanEntitlements'] +slug: /tools/sdk/go/v2025/models/campaign-all-of-sources-with-orphan-entitlements +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSourcesWithOrphanEntitlements', 'V2025CampaignAllOfSourcesWithOrphanEntitlements'] +--- + +# CampaignAllOfSourcesWithOrphanEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the source | [optional] +**Type** | Pointer to **string** | Type | [optional] +**Name** | Pointer to **string** | Name of the source | [optional] + +## Methods + +### NewCampaignAllOfSourcesWithOrphanEntitlements + +`func NewCampaignAllOfSourcesWithOrphanEntitlements() *CampaignAllOfSourcesWithOrphanEntitlements` + +NewCampaignAllOfSourcesWithOrphanEntitlements instantiates a new CampaignAllOfSourcesWithOrphanEntitlements 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 + +### NewCampaignAllOfSourcesWithOrphanEntitlementsWithDefaults + +`func NewCampaignAllOfSourcesWithOrphanEntitlementsWithDefaults() *CampaignAllOfSourcesWithOrphanEntitlements` + +NewCampaignAllOfSourcesWithOrphanEntitlementsWithDefaults instantiates a new CampaignAllOfSourcesWithOrphanEntitlements 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 + +### GetId + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignCompleteOptions.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignCompleteOptions.md new file mode 100644 index 000000000..317b23036 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignCompleteOptions.md @@ -0,0 +1,64 @@ +--- +id: v2025-campaign-complete-options +title: CampaignCompleteOptions +pagination_label: CampaignCompleteOptions +sidebar_label: CampaignCompleteOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignCompleteOptions', 'V2025CampaignCompleteOptions'] +slug: /tools/sdk/go/v2025/models/campaign-complete-options +tags: ['SDK', 'Software Development Kit', 'CampaignCompleteOptions', 'V2025CampaignCompleteOptions'] +--- + +# CampaignCompleteOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AutoCompleteAction** | Pointer to **string** | Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. | [optional] [default to "APPROVE"] + +## Methods + +### NewCampaignCompleteOptions + +`func NewCampaignCompleteOptions() *CampaignCompleteOptions` + +NewCampaignCompleteOptions instantiates a new CampaignCompleteOptions 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 + +### NewCampaignCompleteOptionsWithDefaults + +`func NewCampaignCompleteOptionsWithDefaults() *CampaignCompleteOptions` + +NewCampaignCompleteOptionsWithDefaults instantiates a new CampaignCompleteOptions 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 + +### GetAutoCompleteAction + +`func (o *CampaignCompleteOptions) GetAutoCompleteAction() string` + +GetAutoCompleteAction returns the AutoCompleteAction field if non-nil, zero value otherwise. + +### GetAutoCompleteActionOk + +`func (o *CampaignCompleteOptions) GetAutoCompleteActionOk() (*string, bool)` + +GetAutoCompleteActionOk returns a tuple with the AutoCompleteAction field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoCompleteAction + +`func (o *CampaignCompleteOptions) SetAutoCompleteAction(v string)` + +SetAutoCompleteAction sets AutoCompleteAction field to given value. + +### HasAutoCompleteAction + +`func (o *CampaignCompleteOptions) HasAutoCompleteAction() bool` + +HasAutoCompleteAction returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignEnded.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignEnded.md new file mode 100644 index 000000000..0f1969951 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignEnded.md @@ -0,0 +1,59 @@ +--- +id: v2025-campaign-ended +title: CampaignEnded +pagination_label: CampaignEnded +sidebar_label: CampaignEnded +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignEnded', 'V2025CampaignEnded'] +slug: /tools/sdk/go/v2025/models/campaign-ended +tags: ['SDK', 'Software Development Kit', 'CampaignEnded', 'V2025CampaignEnded'] +--- + +# CampaignEnded + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | [**CampaignEndedCampaign**](campaign-ended-campaign) | | + +## Methods + +### NewCampaignEnded + +`func NewCampaignEnded(campaign CampaignEndedCampaign, ) *CampaignEnded` + +NewCampaignEnded instantiates a new CampaignEnded 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 + +### NewCampaignEndedWithDefaults + +`func NewCampaignEndedWithDefaults() *CampaignEnded` + +NewCampaignEndedWithDefaults instantiates a new CampaignEnded 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 + +### GetCampaign + +`func (o *CampaignEnded) GetCampaign() CampaignEndedCampaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignEnded) GetCampaignOk() (*CampaignEndedCampaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *CampaignEnded) SetCampaign(v CampaignEndedCampaign)` + +SetCampaign sets Campaign field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignEndedCampaign.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignEndedCampaign.md new file mode 100644 index 000000000..6c21868ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignEndedCampaign.md @@ -0,0 +1,242 @@ +--- +id: v2025-campaign-ended-campaign +title: CampaignEndedCampaign +pagination_label: CampaignEndedCampaign +sidebar_label: CampaignEndedCampaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignEndedCampaign', 'V2025CampaignEndedCampaign'] +slug: /tools/sdk/go/v2025/models/campaign-ended-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignEndedCampaign', 'V2025CampaignEndedCampaign'] +--- + +# CampaignEndedCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique ID for the campaign. | +**Name** | **string** | The human friendly name of the campaign. | +**Description** | **string** | Extended description of the campaign. | +**Created** | **SailPointTime** | The date and time the campaign was created. | +**Modified** | Pointer to **NullableTime** | The date and time the campaign was last modified. | [optional] +**Deadline** | **SailPointTime** | The date and time the campaign is due. | +**Type** | **map[string]interface{}** | The type of campaign. | +**CampaignOwner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | +**Status** | **map[string]interface{}** | The current status of the campaign. | + +## Methods + +### NewCampaignEndedCampaign + +`func NewCampaignEndedCampaign(id string, name string, description string, created SailPointTime, deadline SailPointTime, type_ map[string]interface{}, campaignOwner CampaignActivatedCampaignCampaignOwner, status map[string]interface{}, ) *CampaignEndedCampaign` + +NewCampaignEndedCampaign instantiates a new CampaignEndedCampaign 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 + +### NewCampaignEndedCampaignWithDefaults + +`func NewCampaignEndedCampaignWithDefaults() *CampaignEndedCampaign` + +NewCampaignEndedCampaignWithDefaults instantiates a new CampaignEndedCampaign 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 + +### GetId + +`func (o *CampaignEndedCampaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignEndedCampaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignEndedCampaign) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignEndedCampaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignEndedCampaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignEndedCampaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CampaignEndedCampaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignEndedCampaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignEndedCampaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetCreated + +`func (o *CampaignEndedCampaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignEndedCampaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CampaignEndedCampaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CampaignEndedCampaign) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CampaignEndedCampaign) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CampaignEndedCampaign) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CampaignEndedCampaign) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CampaignEndedCampaign) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CampaignEndedCampaign) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDeadline + +`func (o *CampaignEndedCampaign) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *CampaignEndedCampaign) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *CampaignEndedCampaign) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + + +### GetType + +`func (o *CampaignEndedCampaign) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignEndedCampaign) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignEndedCampaign) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetCampaignOwner + +`func (o *CampaignEndedCampaign) GetCampaignOwner() CampaignActivatedCampaignCampaignOwner` + +GetCampaignOwner returns the CampaignOwner field if non-nil, zero value otherwise. + +### GetCampaignOwnerOk + +`func (o *CampaignEndedCampaign) GetCampaignOwnerOk() (*CampaignActivatedCampaignCampaignOwner, bool)` + +GetCampaignOwnerOk returns a tuple with the CampaignOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignOwner + +`func (o *CampaignEndedCampaign) SetCampaignOwner(v CampaignActivatedCampaignCampaignOwner)` + +SetCampaignOwner sets CampaignOwner field to given value. + + +### GetStatus + +`func (o *CampaignEndedCampaign) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CampaignEndedCampaign) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CampaignEndedCampaign) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignFilterDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignFilterDetails.md new file mode 100644 index 000000000..74b6e0d9f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignFilterDetails.md @@ -0,0 +1,205 @@ +--- +id: v2025-campaign-filter-details +title: CampaignFilterDetails +pagination_label: CampaignFilterDetails +sidebar_label: CampaignFilterDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignFilterDetails', 'V2025CampaignFilterDetails'] +slug: /tools/sdk/go/v2025/models/campaign-filter-details +tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetails', 'V2025CampaignFilterDetails'] +--- + +# CampaignFilterDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the campaign filter | +**Name** | **string** | Campaign filter name. | +**Description** | Pointer to **string** | Campaign filter description. | [optional] +**Owner** | **NullableString** | Owner of the filter. This field automatically populates at creation time with the current user. | +**Mode** | **string** | Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria. | +**CriteriaList** | Pointer to [**[]CampaignFilterDetailsCriteriaListInner**](campaign-filter-details-criteria-list-inner) | List of criteria. | [optional] +**IsSystemFilter** | **bool** | If true, the filter is created by the system. If false, the filter is created by a user. | [default to false] + +## Methods + +### NewCampaignFilterDetails + +`func NewCampaignFilterDetails(id string, name string, owner NullableString, mode string, isSystemFilter bool, ) *CampaignFilterDetails` + +NewCampaignFilterDetails instantiates a new CampaignFilterDetails 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 + +### NewCampaignFilterDetailsWithDefaults + +`func NewCampaignFilterDetailsWithDefaults() *CampaignFilterDetails` + +NewCampaignFilterDetailsWithDefaults instantiates a new CampaignFilterDetails 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 + +### GetId + +`func (o *CampaignFilterDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignFilterDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignFilterDetails) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignFilterDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignFilterDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignFilterDetails) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CampaignFilterDetails) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignFilterDetails) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignFilterDetails) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CampaignFilterDetails) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *CampaignFilterDetails) GetOwner() string` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CampaignFilterDetails) GetOwnerOk() (*string, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CampaignFilterDetails) SetOwner(v string)` + +SetOwner sets Owner field to given value. + + +### SetOwnerNil + +`func (o *CampaignFilterDetails) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *CampaignFilterDetails) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetMode + +`func (o *CampaignFilterDetails) GetMode() string` + +GetMode returns the Mode field if non-nil, zero value otherwise. + +### GetModeOk + +`func (o *CampaignFilterDetails) GetModeOk() (*string, bool)` + +GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMode + +`func (o *CampaignFilterDetails) SetMode(v string)` + +SetMode sets Mode field to given value. + + +### GetCriteriaList + +`func (o *CampaignFilterDetails) GetCriteriaList() []CampaignFilterDetailsCriteriaListInner` + +GetCriteriaList returns the CriteriaList field if non-nil, zero value otherwise. + +### GetCriteriaListOk + +`func (o *CampaignFilterDetails) GetCriteriaListOk() (*[]CampaignFilterDetailsCriteriaListInner, bool)` + +GetCriteriaListOk returns a tuple with the CriteriaList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteriaList + +`func (o *CampaignFilterDetails) SetCriteriaList(v []CampaignFilterDetailsCriteriaListInner)` + +SetCriteriaList sets CriteriaList field to given value. + +### HasCriteriaList + +`func (o *CampaignFilterDetails) HasCriteriaList() bool` + +HasCriteriaList returns a boolean if a field has been set. + +### GetIsSystemFilter + +`func (o *CampaignFilterDetails) GetIsSystemFilter() bool` + +GetIsSystemFilter returns the IsSystemFilter field if non-nil, zero value otherwise. + +### GetIsSystemFilterOk + +`func (o *CampaignFilterDetails) GetIsSystemFilterOk() (*bool, bool)` + +GetIsSystemFilterOk returns a tuple with the IsSystemFilter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSystemFilter + +`func (o *CampaignFilterDetails) SetIsSystemFilter(v bool)` + +SetIsSystemFilter sets IsSystemFilter field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignFilterDetailsCriteriaListInner.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignFilterDetailsCriteriaListInner.md new file mode 100644 index 000000000..5dea19bcb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignFilterDetailsCriteriaListInner.md @@ -0,0 +1,323 @@ +--- +id: v2025-campaign-filter-details-criteria-list-inner +title: CampaignFilterDetailsCriteriaListInner +pagination_label: CampaignFilterDetailsCriteriaListInner +sidebar_label: CampaignFilterDetailsCriteriaListInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignFilterDetailsCriteriaListInner', 'V2025CampaignFilterDetailsCriteriaListInner'] +slug: /tools/sdk/go/v2025/models/campaign-filter-details-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetailsCriteriaListInner', 'V2025CampaignFilterDetailsCriteriaListInner'] +--- + +# CampaignFilterDetailsCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**CriteriaType**](criteria-type) | | +**Operation** | Pointer to [**NullableOperation**](operation) | | [optional] +**Property** | **NullableString** | Specified key from the type of criteria. | +**Value** | **NullableString** | Value for the specified key from the type of criteria. | +**NegateResult** | Pointer to **bool** | If true, the filter will negate the result of the criteria. | [optional] [default to false] +**ShortCircuit** | Pointer to **bool** | If true, the filter will short circuit the evaluation of the criteria. | [optional] [default to false] +**RecordChildMatches** | Pointer to **bool** | If true, the filter will record child matches for the criteria. | [optional] [default to false] +**Id** | Pointer to **NullableString** | The unique ID of the criteria. | [optional] +**SuppressMatchedItems** | Pointer to **bool** | If this value is true, then matched items will not only be excluded from the campaign, they will also not have archived certification items created. Such items will not appear in the exclusion report. | [optional] [default to false] +**Children** | Pointer to **[]map[string]interface{}** | List of child criteria. | [optional] + +## Methods + +### NewCampaignFilterDetailsCriteriaListInner + +`func NewCampaignFilterDetailsCriteriaListInner(type_ CriteriaType, property NullableString, value NullableString, ) *CampaignFilterDetailsCriteriaListInner` + +NewCampaignFilterDetailsCriteriaListInner instantiates a new CampaignFilterDetailsCriteriaListInner 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 + +### NewCampaignFilterDetailsCriteriaListInnerWithDefaults + +`func NewCampaignFilterDetailsCriteriaListInnerWithDefaults() *CampaignFilterDetailsCriteriaListInner` + +NewCampaignFilterDetailsCriteriaListInnerWithDefaults instantiates a new CampaignFilterDetailsCriteriaListInner 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 + +### GetType + +`func (o *CampaignFilterDetailsCriteriaListInner) GetType() CriteriaType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetTypeOk() (*CriteriaType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignFilterDetailsCriteriaListInner) SetType(v CriteriaType)` + +SetType sets Type field to given value. + + +### GetOperation + +`func (o *CampaignFilterDetailsCriteriaListInner) GetOperation() Operation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetOperationOk() (*Operation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *CampaignFilterDetailsCriteriaListInner) SetOperation(v Operation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *CampaignFilterDetailsCriteriaListInner) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### SetOperationNil + +`func (o *CampaignFilterDetailsCriteriaListInner) SetOperationNil(b bool)` + + SetOperationNil sets the value for Operation to be an explicit nil + +### UnsetOperation +`func (o *CampaignFilterDetailsCriteriaListInner) UnsetOperation()` + +UnsetOperation ensures that no value is present for Operation, not even an explicit nil +### GetProperty + +`func (o *CampaignFilterDetailsCriteriaListInner) GetProperty() string` + +GetProperty returns the Property field if non-nil, zero value otherwise. + +### GetPropertyOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetPropertyOk() (*string, bool)` + +GetPropertyOk returns a tuple with the Property field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperty + +`func (o *CampaignFilterDetailsCriteriaListInner) SetProperty(v string)` + +SetProperty sets Property field to given value. + + +### SetPropertyNil + +`func (o *CampaignFilterDetailsCriteriaListInner) SetPropertyNil(b bool)` + + SetPropertyNil sets the value for Property to be an explicit nil + +### UnsetProperty +`func (o *CampaignFilterDetailsCriteriaListInner) UnsetProperty()` + +UnsetProperty ensures that no value is present for Property, not even an explicit nil +### GetValue + +`func (o *CampaignFilterDetailsCriteriaListInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *CampaignFilterDetailsCriteriaListInner) SetValue(v string)` + +SetValue sets Value field to given value. + + +### SetValueNil + +`func (o *CampaignFilterDetailsCriteriaListInner) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *CampaignFilterDetailsCriteriaListInner) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetNegateResult + +`func (o *CampaignFilterDetailsCriteriaListInner) GetNegateResult() bool` + +GetNegateResult returns the NegateResult field if non-nil, zero value otherwise. + +### GetNegateResultOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetNegateResultOk() (*bool, bool)` + +GetNegateResultOk returns a tuple with the NegateResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNegateResult + +`func (o *CampaignFilterDetailsCriteriaListInner) SetNegateResult(v bool)` + +SetNegateResult sets NegateResult field to given value. + +### HasNegateResult + +`func (o *CampaignFilterDetailsCriteriaListInner) HasNegateResult() bool` + +HasNegateResult returns a boolean if a field has been set. + +### GetShortCircuit + +`func (o *CampaignFilterDetailsCriteriaListInner) GetShortCircuit() bool` + +GetShortCircuit returns the ShortCircuit field if non-nil, zero value otherwise. + +### GetShortCircuitOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetShortCircuitOk() (*bool, bool)` + +GetShortCircuitOk returns a tuple with the ShortCircuit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShortCircuit + +`func (o *CampaignFilterDetailsCriteriaListInner) SetShortCircuit(v bool)` + +SetShortCircuit sets ShortCircuit field to given value. + +### HasShortCircuit + +`func (o *CampaignFilterDetailsCriteriaListInner) HasShortCircuit() bool` + +HasShortCircuit returns a boolean if a field has been set. + +### GetRecordChildMatches + +`func (o *CampaignFilterDetailsCriteriaListInner) GetRecordChildMatches() bool` + +GetRecordChildMatches returns the RecordChildMatches field if non-nil, zero value otherwise. + +### GetRecordChildMatchesOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetRecordChildMatchesOk() (*bool, bool)` + +GetRecordChildMatchesOk returns a tuple with the RecordChildMatches field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecordChildMatches + +`func (o *CampaignFilterDetailsCriteriaListInner) SetRecordChildMatches(v bool)` + +SetRecordChildMatches sets RecordChildMatches field to given value. + +### HasRecordChildMatches + +`func (o *CampaignFilterDetailsCriteriaListInner) HasRecordChildMatches() bool` + +HasRecordChildMatches returns a boolean if a field has been set. + +### GetId + +`func (o *CampaignFilterDetailsCriteriaListInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignFilterDetailsCriteriaListInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignFilterDetailsCriteriaListInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *CampaignFilterDetailsCriteriaListInner) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *CampaignFilterDetailsCriteriaListInner) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetSuppressMatchedItems + +`func (o *CampaignFilterDetailsCriteriaListInner) GetSuppressMatchedItems() bool` + +GetSuppressMatchedItems returns the SuppressMatchedItems field if non-nil, zero value otherwise. + +### GetSuppressMatchedItemsOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetSuppressMatchedItemsOk() (*bool, bool)` + +GetSuppressMatchedItemsOk returns a tuple with the SuppressMatchedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSuppressMatchedItems + +`func (o *CampaignFilterDetailsCriteriaListInner) SetSuppressMatchedItems(v bool)` + +SetSuppressMatchedItems sets SuppressMatchedItems field to given value. + +### HasSuppressMatchedItems + +`func (o *CampaignFilterDetailsCriteriaListInner) HasSuppressMatchedItems() bool` + +HasSuppressMatchedItems returns a boolean if a field has been set. + +### GetChildren + +`func (o *CampaignFilterDetailsCriteriaListInner) GetChildren() []map[string]interface{}` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetChildrenOk() (*[]map[string]interface{}, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *CampaignFilterDetailsCriteriaListInner) SetChildren(v []map[string]interface{})` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *CampaignFilterDetailsCriteriaListInner) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignGenerated.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignGenerated.md new file mode 100644 index 000000000..05cbe2a21 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignGenerated.md @@ -0,0 +1,59 @@ +--- +id: v2025-campaign-generated +title: CampaignGenerated +pagination_label: CampaignGenerated +sidebar_label: CampaignGenerated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignGenerated', 'V2025CampaignGenerated'] +slug: /tools/sdk/go/v2025/models/campaign-generated +tags: ['SDK', 'Software Development Kit', 'CampaignGenerated', 'V2025CampaignGenerated'] +--- + +# CampaignGenerated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | + +## Methods + +### NewCampaignGenerated + +`func NewCampaignGenerated(campaign CampaignGeneratedCampaign, ) *CampaignGenerated` + +NewCampaignGenerated instantiates a new CampaignGenerated 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 + +### NewCampaignGeneratedWithDefaults + +`func NewCampaignGeneratedWithDefaults() *CampaignGenerated` + +NewCampaignGeneratedWithDefaults instantiates a new CampaignGenerated 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 + +### GetCampaign + +`func (o *CampaignGenerated) GetCampaign() CampaignGeneratedCampaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignGenerated) GetCampaignOk() (*CampaignGeneratedCampaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *CampaignGenerated) SetCampaign(v CampaignGeneratedCampaign)` + +SetCampaign sets Campaign field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignGeneratedCampaign.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignGeneratedCampaign.md new file mode 100644 index 000000000..7f203c2dd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignGeneratedCampaign.md @@ -0,0 +1,257 @@ +--- +id: v2025-campaign-generated-campaign +title: CampaignGeneratedCampaign +pagination_label: CampaignGeneratedCampaign +sidebar_label: CampaignGeneratedCampaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignGeneratedCampaign', 'V2025CampaignGeneratedCampaign'] +slug: /tools/sdk/go/v2025/models/campaign-generated-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaign', 'V2025CampaignGeneratedCampaign'] +--- + +# CampaignGeneratedCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the campaign. | +**Name** | **string** | Human friendly name of the campaign. | +**Description** | **string** | Extended description of the campaign. | +**Created** | **SailPointTime** | The date and time the campaign was created. | +**Modified** | Pointer to **NullableString** | The date and time the campaign was last modified. | [optional] +**Deadline** | Pointer to **NullableString** | The date and time when the campaign must be finished by. | [optional] +**Type** | **map[string]interface{}** | The type of campaign that was generated. | +**CampaignOwner** | [**CampaignGeneratedCampaignCampaignOwner**](campaign-generated-campaign-campaign-owner) | | +**Status** | **map[string]interface{}** | The current status of the campaign. | + +## Methods + +### NewCampaignGeneratedCampaign + +`func NewCampaignGeneratedCampaign(id string, name string, description string, created SailPointTime, type_ map[string]interface{}, campaignOwner CampaignGeneratedCampaignCampaignOwner, status map[string]interface{}, ) *CampaignGeneratedCampaign` + +NewCampaignGeneratedCampaign instantiates a new CampaignGeneratedCampaign 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 + +### NewCampaignGeneratedCampaignWithDefaults + +`func NewCampaignGeneratedCampaignWithDefaults() *CampaignGeneratedCampaign` + +NewCampaignGeneratedCampaignWithDefaults instantiates a new CampaignGeneratedCampaign 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 + +### GetId + +`func (o *CampaignGeneratedCampaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignGeneratedCampaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignGeneratedCampaign) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignGeneratedCampaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignGeneratedCampaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignGeneratedCampaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CampaignGeneratedCampaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignGeneratedCampaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignGeneratedCampaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetCreated + +`func (o *CampaignGeneratedCampaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignGeneratedCampaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CampaignGeneratedCampaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CampaignGeneratedCampaign) GetModified() string` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CampaignGeneratedCampaign) GetModifiedOk() (*string, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CampaignGeneratedCampaign) SetModified(v string)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CampaignGeneratedCampaign) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CampaignGeneratedCampaign) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CampaignGeneratedCampaign) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDeadline + +`func (o *CampaignGeneratedCampaign) GetDeadline() string` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *CampaignGeneratedCampaign) GetDeadlineOk() (*string, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *CampaignGeneratedCampaign) SetDeadline(v string)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *CampaignGeneratedCampaign) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### SetDeadlineNil + +`func (o *CampaignGeneratedCampaign) SetDeadlineNil(b bool)` + + SetDeadlineNil sets the value for Deadline to be an explicit nil + +### UnsetDeadline +`func (o *CampaignGeneratedCampaign) UnsetDeadline()` + +UnsetDeadline ensures that no value is present for Deadline, not even an explicit nil +### GetType + +`func (o *CampaignGeneratedCampaign) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignGeneratedCampaign) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignGeneratedCampaign) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetCampaignOwner + +`func (o *CampaignGeneratedCampaign) GetCampaignOwner() CampaignGeneratedCampaignCampaignOwner` + +GetCampaignOwner returns the CampaignOwner field if non-nil, zero value otherwise. + +### GetCampaignOwnerOk + +`func (o *CampaignGeneratedCampaign) GetCampaignOwnerOk() (*CampaignGeneratedCampaignCampaignOwner, bool)` + +GetCampaignOwnerOk returns a tuple with the CampaignOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignOwner + +`func (o *CampaignGeneratedCampaign) SetCampaignOwner(v CampaignGeneratedCampaignCampaignOwner)` + +SetCampaignOwner sets CampaignOwner field to given value. + + +### GetStatus + +`func (o *CampaignGeneratedCampaign) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CampaignGeneratedCampaign) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CampaignGeneratedCampaign) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignGeneratedCampaignCampaignOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignGeneratedCampaignCampaignOwner.md new file mode 100644 index 000000000..804302496 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignGeneratedCampaignCampaignOwner.md @@ -0,0 +1,101 @@ +--- +id: v2025-campaign-generated-campaign-campaign-owner +title: CampaignGeneratedCampaignCampaignOwner +pagination_label: CampaignGeneratedCampaignCampaignOwner +sidebar_label: CampaignGeneratedCampaignCampaignOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignGeneratedCampaignCampaignOwner', 'V2025CampaignGeneratedCampaignCampaignOwner'] +slug: /tools/sdk/go/v2025/models/campaign-generated-campaign-campaign-owner +tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaignCampaignOwner', 'V2025CampaignGeneratedCampaignCampaignOwner'] +--- + +# CampaignGeneratedCampaignCampaignOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the identity. | +**DisplayName** | **string** | The display name of the identity. | +**Email** | **string** | The primary email address of the identity. | + +## Methods + +### NewCampaignGeneratedCampaignCampaignOwner + +`func NewCampaignGeneratedCampaignCampaignOwner(id string, displayName string, email string, ) *CampaignGeneratedCampaignCampaignOwner` + +NewCampaignGeneratedCampaignCampaignOwner instantiates a new CampaignGeneratedCampaignCampaignOwner 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 + +### NewCampaignGeneratedCampaignCampaignOwnerWithDefaults + +`func NewCampaignGeneratedCampaignCampaignOwnerWithDefaults() *CampaignGeneratedCampaignCampaignOwner` + +NewCampaignGeneratedCampaignCampaignOwnerWithDefaults instantiates a new CampaignGeneratedCampaignCampaignOwner 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 + +### GetId + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignGeneratedCampaignCampaignOwner) SetId(v string)` + +SetId sets Id field to given value. + + +### GetDisplayName + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *CampaignGeneratedCampaignCampaignOwner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + + +### GetEmail + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *CampaignGeneratedCampaignCampaignOwner) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *CampaignGeneratedCampaignCampaignOwner) SetEmail(v string)` + +SetEmail sets Email field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignReference.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignReference.md new file mode 100644 index 000000000..fb11ac1bb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignReference.md @@ -0,0 +1,195 @@ +--- +id: v2025-campaign-reference +title: CampaignReference +pagination_label: CampaignReference +sidebar_label: CampaignReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignReference', 'V2025CampaignReference'] +slug: /tools/sdk/go/v2025/models/campaign-reference +tags: ['SDK', 'Software Development Kit', 'CampaignReference', 'V2025CampaignReference'] +--- + +# CampaignReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the campaign. | +**Name** | **string** | The name of the campaign. | +**Type** | **string** | The type of object that is being referenced. | +**CampaignType** | **string** | The type of the campaign. | +**Description** | **NullableString** | The description of the campaign set by the admin who created it. | +**CorrelatedStatus** | **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | +**MandatoryCommentRequirement** | **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | + +## Methods + +### NewCampaignReference + +`func NewCampaignReference(id string, name string, type_ string, campaignType string, description NullableString, correlatedStatus string, mandatoryCommentRequirement string, ) *CampaignReference` + +NewCampaignReference instantiates a new CampaignReference 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 + +### NewCampaignReferenceWithDefaults + +`func NewCampaignReferenceWithDefaults() *CampaignReference` + +NewCampaignReferenceWithDefaults instantiates a new CampaignReference 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 + +### GetId + +`func (o *CampaignReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignReference) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignReference) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *CampaignReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignReference) SetType(v string)` + +SetType sets Type field to given value. + + +### GetCampaignType + +`func (o *CampaignReference) GetCampaignType() string` + +GetCampaignType returns the CampaignType field if non-nil, zero value otherwise. + +### GetCampaignTypeOk + +`func (o *CampaignReference) GetCampaignTypeOk() (*string, bool)` + +GetCampaignTypeOk returns a tuple with the CampaignType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignType + +`func (o *CampaignReference) SetCampaignType(v string)` + +SetCampaignType sets CampaignType field to given value. + + +### GetDescription + +`func (o *CampaignReference) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignReference) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignReference) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *CampaignReference) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CampaignReference) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCorrelatedStatus + +`func (o *CampaignReference) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *CampaignReference) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *CampaignReference) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + + +### GetMandatoryCommentRequirement + +`func (o *CampaignReference) GetMandatoryCommentRequirement() string` + +GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise. + +### GetMandatoryCommentRequirementOk + +`func (o *CampaignReference) GetMandatoryCommentRequirementOk() (*string, bool)` + +GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMandatoryCommentRequirement + +`func (o *CampaignReference) SetMandatoryCommentRequirement(v string)` + +SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignReport.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignReport.md new file mode 100644 index 000000000..fe810b03d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignReport.md @@ -0,0 +1,189 @@ +--- +id: v2025-campaign-report +title: CampaignReport +pagination_label: CampaignReport +sidebar_label: CampaignReport +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignReport', 'V2025CampaignReport'] +slug: /tools/sdk/go/v2025/models/campaign-report +tags: ['SDK', 'Software Development Kit', 'CampaignReport', 'V2025CampaignReport'] +--- + +# CampaignReport + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **string** | Human-readable name of the SOD policy violation report result. | [optional] +**Status** | Pointer to **string** | Status of a SOD policy violation report. | [optional] +**ReportType** | [**ReportType**](report-type) | | +**LastRunAt** | Pointer to **SailPointTime** | The most recent date and time this report was run | [optional] [readonly] + +## Methods + +### NewCampaignReport + +`func NewCampaignReport(reportType ReportType, ) *CampaignReport` + +NewCampaignReport instantiates a new CampaignReport 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 + +### NewCampaignReportWithDefaults + +`func NewCampaignReportWithDefaults() *CampaignReport` + +NewCampaignReportWithDefaults instantiates a new CampaignReport 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 + +### GetType + +`func (o *CampaignReport) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignReport) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignReport) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignReport) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CampaignReport) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignReport) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignReport) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignReport) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignReport) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignReport) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignReport) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignReport) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *CampaignReport) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CampaignReport) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CampaignReport) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CampaignReport) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetReportType + +`func (o *CampaignReport) GetReportType() ReportType` + +GetReportType returns the ReportType field if non-nil, zero value otherwise. + +### GetReportTypeOk + +`func (o *CampaignReport) GetReportTypeOk() (*ReportType, bool)` + +GetReportTypeOk returns a tuple with the ReportType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportType + +`func (o *CampaignReport) SetReportType(v ReportType)` + +SetReportType sets ReportType field to given value. + + +### GetLastRunAt + +`func (o *CampaignReport) GetLastRunAt() SailPointTime` + +GetLastRunAt returns the LastRunAt field if non-nil, zero value otherwise. + +### GetLastRunAtOk + +`func (o *CampaignReport) GetLastRunAtOk() (*SailPointTime, bool)` + +GetLastRunAtOk returns a tuple with the LastRunAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastRunAt + +`func (o *CampaignReport) SetLastRunAt(v SailPointTime)` + +SetLastRunAt sets LastRunAt field to given value. + +### HasLastRunAt + +`func (o *CampaignReport) HasLastRunAt() bool` + +HasLastRunAt returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignReportsConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignReportsConfig.md new file mode 100644 index 000000000..ec788ff29 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignReportsConfig.md @@ -0,0 +1,74 @@ +--- +id: v2025-campaign-reports-config +title: CampaignReportsConfig +pagination_label: CampaignReportsConfig +sidebar_label: CampaignReportsConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignReportsConfig', 'V2025CampaignReportsConfig'] +slug: /tools/sdk/go/v2025/models/campaign-reports-config +tags: ['SDK', 'Software Development Kit', 'CampaignReportsConfig', 'V2025CampaignReportsConfig'] +--- + +# CampaignReportsConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttributeColumns** | Pointer to **[]string** | list of identity attribute columns | [optional] + +## Methods + +### NewCampaignReportsConfig + +`func NewCampaignReportsConfig() *CampaignReportsConfig` + +NewCampaignReportsConfig instantiates a new CampaignReportsConfig 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 + +### NewCampaignReportsConfigWithDefaults + +`func NewCampaignReportsConfigWithDefaults() *CampaignReportsConfig` + +NewCampaignReportsConfigWithDefaults instantiates a new CampaignReportsConfig 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 + +### GetIdentityAttributeColumns + +`func (o *CampaignReportsConfig) GetIdentityAttributeColumns() []string` + +GetIdentityAttributeColumns returns the IdentityAttributeColumns field if non-nil, zero value otherwise. + +### GetIdentityAttributeColumnsOk + +`func (o *CampaignReportsConfig) GetIdentityAttributeColumnsOk() (*[]string, bool)` + +GetIdentityAttributeColumnsOk returns a tuple with the IdentityAttributeColumns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeColumns + +`func (o *CampaignReportsConfig) SetIdentityAttributeColumns(v []string)` + +SetIdentityAttributeColumns sets IdentityAttributeColumns field to given value. + +### HasIdentityAttributeColumns + +`func (o *CampaignReportsConfig) HasIdentityAttributeColumns() bool` + +HasIdentityAttributeColumns returns a boolean if a field has been set. + +### SetIdentityAttributeColumnsNil + +`func (o *CampaignReportsConfig) SetIdentityAttributeColumnsNil(b bool)` + + SetIdentityAttributeColumnsNil sets the value for IdentityAttributeColumns to be an explicit nil + +### UnsetIdentityAttributeColumns +`func (o *CampaignReportsConfig) UnsetIdentityAttributeColumns()` + +UnsetIdentityAttributeColumns ensures that no value is present for IdentityAttributeColumns, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignTemplate.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignTemplate.md new file mode 100644 index 000000000..5a6dc52da --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignTemplate.md @@ -0,0 +1,267 @@ +--- +id: v2025-campaign-template +title: CampaignTemplate +pagination_label: CampaignTemplate +sidebar_label: CampaignTemplate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignTemplate', 'V2025CampaignTemplate'] +slug: /tools/sdk/go/v2025/models/campaign-template +tags: ['SDK', 'Software Development Kit', 'CampaignTemplate', 'V2025CampaignTemplate'] +--- + +# CampaignTemplate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the campaign template | [optional] +**Name** | **string** | This template's name. Has no bearing on generated campaigns' names. | +**Description** | **string** | This template's description. Has no bearing on generated campaigns' descriptions. | +**Created** | **SailPointTime** | Creation date of Campaign Template | [readonly] +**Modified** | **NullableTime** | Modification date of Campaign Template | [readonly] +**Scheduled** | Pointer to **bool** | Indicates if this campaign template has been scheduled. | [optional] [readonly] [default to false] +**OwnerRef** | Pointer to [**CampaignTemplateOwnerRef**](campaign-template-owner-ref) | | [optional] +**DeadlineDuration** | Pointer to **NullableString** | The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days). | [optional] +**Campaign** | [**Campaign**](campaign) | | + +## Methods + +### NewCampaignTemplate + +`func NewCampaignTemplate(name string, description string, created SailPointTime, modified NullableTime, campaign Campaign, ) *CampaignTemplate` + +NewCampaignTemplate instantiates a new CampaignTemplate 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 + +### NewCampaignTemplateWithDefaults + +`func NewCampaignTemplateWithDefaults() *CampaignTemplate` + +NewCampaignTemplateWithDefaults instantiates a new CampaignTemplate 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 + +### GetId + +`func (o *CampaignTemplate) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignTemplate) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignTemplate) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignTemplate) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignTemplate) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignTemplate) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignTemplate) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CampaignTemplate) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignTemplate) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignTemplate) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetCreated + +`func (o *CampaignTemplate) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignTemplate) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CampaignTemplate) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CampaignTemplate) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CampaignTemplate) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CampaignTemplate) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### SetModifiedNil + +`func (o *CampaignTemplate) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CampaignTemplate) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetScheduled + +`func (o *CampaignTemplate) GetScheduled() bool` + +GetScheduled returns the Scheduled field if non-nil, zero value otherwise. + +### GetScheduledOk + +`func (o *CampaignTemplate) GetScheduledOk() (*bool, bool)` + +GetScheduledOk returns a tuple with the Scheduled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheduled + +`func (o *CampaignTemplate) SetScheduled(v bool)` + +SetScheduled sets Scheduled field to given value. + +### HasScheduled + +`func (o *CampaignTemplate) HasScheduled() bool` + +HasScheduled returns a boolean if a field has been set. + +### GetOwnerRef + +`func (o *CampaignTemplate) GetOwnerRef() CampaignTemplateOwnerRef` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *CampaignTemplate) GetOwnerRefOk() (*CampaignTemplateOwnerRef, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *CampaignTemplate) SetOwnerRef(v CampaignTemplateOwnerRef)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *CampaignTemplate) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### GetDeadlineDuration + +`func (o *CampaignTemplate) GetDeadlineDuration() string` + +GetDeadlineDuration returns the DeadlineDuration field if non-nil, zero value otherwise. + +### GetDeadlineDurationOk + +`func (o *CampaignTemplate) GetDeadlineDurationOk() (*string, bool)` + +GetDeadlineDurationOk returns a tuple with the DeadlineDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadlineDuration + +`func (o *CampaignTemplate) SetDeadlineDuration(v string)` + +SetDeadlineDuration sets DeadlineDuration field to given value. + +### HasDeadlineDuration + +`func (o *CampaignTemplate) HasDeadlineDuration() bool` + +HasDeadlineDuration returns a boolean if a field has been set. + +### SetDeadlineDurationNil + +`func (o *CampaignTemplate) SetDeadlineDurationNil(b bool)` + + SetDeadlineDurationNil sets the value for DeadlineDuration to be an explicit nil + +### UnsetDeadlineDuration +`func (o *CampaignTemplate) UnsetDeadlineDuration()` + +UnsetDeadlineDuration ensures that no value is present for DeadlineDuration, not even an explicit nil +### GetCampaign + +`func (o *CampaignTemplate) GetCampaign() Campaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignTemplate) GetCampaignOk() (*Campaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *CampaignTemplate) SetCampaign(v Campaign)` + +SetCampaign sets Campaign field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignTemplateOwnerRef.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignTemplateOwnerRef.md new file mode 100644 index 000000000..27939c418 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignTemplateOwnerRef.md @@ -0,0 +1,142 @@ +--- +id: v2025-campaign-template-owner-ref +title: CampaignTemplateOwnerRef +pagination_label: CampaignTemplateOwnerRef +sidebar_label: CampaignTemplateOwnerRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignTemplateOwnerRef', 'V2025CampaignTemplateOwnerRef'] +slug: /tools/sdk/go/v2025/models/campaign-template-owner-ref +tags: ['SDK', 'Software Development Kit', 'CampaignTemplateOwnerRef', 'V2025CampaignTemplateOwnerRef'] +--- + +# CampaignTemplateOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the owner | [optional] +**Type** | Pointer to **string** | Type of the owner | [optional] +**Name** | Pointer to **string** | Name of the owner | [optional] +**Email** | Pointer to **string** | Email of the owner | [optional] + +## Methods + +### NewCampaignTemplateOwnerRef + +`func NewCampaignTemplateOwnerRef() *CampaignTemplateOwnerRef` + +NewCampaignTemplateOwnerRef instantiates a new CampaignTemplateOwnerRef 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 + +### NewCampaignTemplateOwnerRefWithDefaults + +`func NewCampaignTemplateOwnerRefWithDefaults() *CampaignTemplateOwnerRef` + +NewCampaignTemplateOwnerRefWithDefaults instantiates a new CampaignTemplateOwnerRef 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 + +### GetId + +`func (o *CampaignTemplateOwnerRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignTemplateOwnerRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignTemplateOwnerRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignTemplateOwnerRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CampaignTemplateOwnerRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignTemplateOwnerRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignTemplateOwnerRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignTemplateOwnerRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignTemplateOwnerRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignTemplateOwnerRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignTemplateOwnerRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignTemplateOwnerRef) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *CampaignTemplateOwnerRef) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *CampaignTemplateOwnerRef) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *CampaignTemplateOwnerRef) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *CampaignTemplateOwnerRef) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CampaignsDeleteRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/CampaignsDeleteRequest.md new file mode 100644 index 000000000..3798a9e83 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CampaignsDeleteRequest.md @@ -0,0 +1,64 @@ +--- +id: v2025-campaigns-delete-request +title: CampaignsDeleteRequest +pagination_label: CampaignsDeleteRequest +sidebar_label: CampaignsDeleteRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignsDeleteRequest', 'V2025CampaignsDeleteRequest'] +slug: /tools/sdk/go/v2025/models/campaigns-delete-request +tags: ['SDK', 'Software Development Kit', 'CampaignsDeleteRequest', 'V2025CampaignsDeleteRequest'] +--- + +# CampaignsDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]string** | The ids of the campaigns to delete | [optional] + +## Methods + +### NewCampaignsDeleteRequest + +`func NewCampaignsDeleteRequest() *CampaignsDeleteRequest` + +NewCampaignsDeleteRequest instantiates a new CampaignsDeleteRequest 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 + +### NewCampaignsDeleteRequestWithDefaults + +`func NewCampaignsDeleteRequestWithDefaults() *CampaignsDeleteRequest` + +NewCampaignsDeleteRequestWithDefaults instantiates a new CampaignsDeleteRequest 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 + +### GetIds + +`func (o *CampaignsDeleteRequest) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *CampaignsDeleteRequest) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *CampaignsDeleteRequest) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *CampaignsDeleteRequest) HasIds() bool` + +HasIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CancelAccessRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/CancelAccessRequest.md new file mode 100644 index 000000000..b283af66b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CancelAccessRequest.md @@ -0,0 +1,80 @@ +--- +id: v2025-cancel-access-request +title: CancelAccessRequest +pagination_label: CancelAccessRequest +sidebar_label: CancelAccessRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CancelAccessRequest', 'V2025CancelAccessRequest'] +slug: /tools/sdk/go/v2025/models/cancel-access-request +tags: ['SDK', 'Software Development Kit', 'CancelAccessRequest', 'V2025CancelAccessRequest'] +--- + +# CancelAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountActivityId** | **string** | This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. | +**Comment** | **string** | Reason for cancelling the pending access request. | + +## Methods + +### NewCancelAccessRequest + +`func NewCancelAccessRequest(accountActivityId string, comment string, ) *CancelAccessRequest` + +NewCancelAccessRequest instantiates a new CancelAccessRequest 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 + +### NewCancelAccessRequestWithDefaults + +`func NewCancelAccessRequestWithDefaults() *CancelAccessRequest` + +NewCancelAccessRequestWithDefaults instantiates a new CancelAccessRequest 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 + +### GetAccountActivityId + +`func (o *CancelAccessRequest) GetAccountActivityId() string` + +GetAccountActivityId returns the AccountActivityId field if non-nil, zero value otherwise. + +### GetAccountActivityIdOk + +`func (o *CancelAccessRequest) GetAccountActivityIdOk() (*string, bool)` + +GetAccountActivityIdOk returns a tuple with the AccountActivityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActivityId + +`func (o *CancelAccessRequest) SetAccountActivityId(v string)` + +SetAccountActivityId sets AccountActivityId field to given value. + + +### GetComment + +`func (o *CancelAccessRequest) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CancelAccessRequest) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CancelAccessRequest) SetComment(v string)` + +SetComment sets Comment field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CancelledRequestDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/CancelledRequestDetails.md new file mode 100644 index 000000000..4562cf57e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CancelledRequestDetails.md @@ -0,0 +1,116 @@ +--- +id: v2025-cancelled-request-details +title: CancelledRequestDetails +pagination_label: CancelledRequestDetails +sidebar_label: CancelledRequestDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CancelledRequestDetails', 'V2025CancelledRequestDetails'] +slug: /tools/sdk/go/v2025/models/cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails', 'V2025CancelledRequestDetails'] +--- + +# CancelledRequestDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment made by the owner when cancelling the associated request. | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Modified** | Pointer to **SailPointTime** | Date comment was added by the owner when cancelling the associated request. | [optional] + +## Methods + +### NewCancelledRequestDetails + +`func NewCancelledRequestDetails() *CancelledRequestDetails` + +NewCancelledRequestDetails instantiates a new CancelledRequestDetails 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 + +### NewCancelledRequestDetailsWithDefaults + +`func NewCancelledRequestDetailsWithDefaults() *CancelledRequestDetails` + +NewCancelledRequestDetailsWithDefaults instantiates a new CancelledRequestDetails 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 + +### GetComment + +`func (o *CancelledRequestDetails) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CancelledRequestDetails) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CancelledRequestDetails) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CancelledRequestDetails) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetOwner + +`func (o *CancelledRequestDetails) GetOwner() OwnerDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CancelledRequestDetails) GetOwnerOk() (*OwnerDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CancelledRequestDetails) SetOwner(v OwnerDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *CancelledRequestDetails) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetModified + +`func (o *CancelledRequestDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CancelledRequestDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CancelledRequestDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CancelledRequestDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Certification.md b/docs/tools/sdk/go/Reference/V2025/Models/Certification.md new file mode 100644 index 000000000..ab6fac269 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Certification.md @@ -0,0 +1,520 @@ +--- +id: v2025-certification +title: Certification +pagination_label: Certification +sidebar_label: Certification +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Certification', 'V2025Certification'] +slug: /tools/sdk/go/v2025/models/certification +tags: ['SDK', 'Software Development Kit', 'Certification', 'V2025Certification'] +--- + +# Certification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | id of the certification | [optional] +**Name** | Pointer to **string** | name of the certification | [optional] +**Campaign** | Pointer to [**CampaignReference**](campaign-reference) | | [optional] +**Completed** | Pointer to **bool** | Have all decisions been made? | [optional] +**IdentitiesCompleted** | Pointer to **int32** | The number of identities for whom all decisions have been made and are complete. | [optional] +**IdentitiesTotal** | Pointer to **int32** | The total number of identities in the Certification, both complete and incomplete. | [optional] +**Created** | Pointer to **SailPointTime** | created date | [optional] +**Modified** | Pointer to **SailPointTime** | modified date | [optional] +**DecisionsMade** | Pointer to **int32** | The number of approve/revoke/acknowledge decisions that have been made. | [optional] +**DecisionsTotal** | Pointer to **int32** | The total number of approve/revoke/acknowledge decisions. | [optional] +**Due** | Pointer to **NullableTime** | The due date of the certification. | [optional] +**Signed** | Pointer to **NullableTime** | The date the reviewer signed off on the Certification. | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] +**Reassignment** | Pointer to [**NullableReassignment**](reassignment) | | [optional] +**HasErrors** | Pointer to **bool** | Identifies if the certification has an error | [optional] +**ErrorMessage** | Pointer to **NullableString** | Description of the certification error | [optional] +**Phase** | Pointer to [**CertificationPhase**](certification-phase) | | [optional] + +## Methods + +### NewCertification + +`func NewCertification() *Certification` + +NewCertification instantiates a new Certification 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 + +### NewCertificationWithDefaults + +`func NewCertificationWithDefaults() *Certification` + +NewCertificationWithDefaults instantiates a new Certification 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 + +### GetId + +`func (o *Certification) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Certification) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Certification) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Certification) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Certification) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Certification) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Certification) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Certification) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCampaign + +`func (o *Certification) GetCampaign() CampaignReference` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *Certification) GetCampaignOk() (*CampaignReference, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *Certification) SetCampaign(v CampaignReference)` + +SetCampaign sets Campaign field to given value. + +### HasCampaign + +`func (o *Certification) HasCampaign() bool` + +HasCampaign returns a boolean if a field has been set. + +### GetCompleted + +`func (o *Certification) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *Certification) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *Certification) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *Certification) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetIdentitiesCompleted + +`func (o *Certification) GetIdentitiesCompleted() int32` + +GetIdentitiesCompleted returns the IdentitiesCompleted field if non-nil, zero value otherwise. + +### GetIdentitiesCompletedOk + +`func (o *Certification) GetIdentitiesCompletedOk() (*int32, bool)` + +GetIdentitiesCompletedOk returns a tuple with the IdentitiesCompleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesCompleted + +`func (o *Certification) SetIdentitiesCompleted(v int32)` + +SetIdentitiesCompleted sets IdentitiesCompleted field to given value. + +### HasIdentitiesCompleted + +`func (o *Certification) HasIdentitiesCompleted() bool` + +HasIdentitiesCompleted returns a boolean if a field has been set. + +### GetIdentitiesTotal + +`func (o *Certification) GetIdentitiesTotal() int32` + +GetIdentitiesTotal returns the IdentitiesTotal field if non-nil, zero value otherwise. + +### GetIdentitiesTotalOk + +`func (o *Certification) GetIdentitiesTotalOk() (*int32, bool)` + +GetIdentitiesTotalOk returns a tuple with the IdentitiesTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesTotal + +`func (o *Certification) SetIdentitiesTotal(v int32)` + +SetIdentitiesTotal sets IdentitiesTotal field to given value. + +### HasIdentitiesTotal + +`func (o *Certification) HasIdentitiesTotal() bool` + +HasIdentitiesTotal returns a boolean if a field has been set. + +### GetCreated + +`func (o *Certification) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Certification) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Certification) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Certification) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Certification) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Certification) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Certification) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Certification) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDecisionsMade + +`func (o *Certification) GetDecisionsMade() int32` + +GetDecisionsMade returns the DecisionsMade field if non-nil, zero value otherwise. + +### GetDecisionsMadeOk + +`func (o *Certification) GetDecisionsMadeOk() (*int32, bool)` + +GetDecisionsMadeOk returns a tuple with the DecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsMade + +`func (o *Certification) SetDecisionsMade(v int32)` + +SetDecisionsMade sets DecisionsMade field to given value. + +### HasDecisionsMade + +`func (o *Certification) HasDecisionsMade() bool` + +HasDecisionsMade returns a boolean if a field has been set. + +### GetDecisionsTotal + +`func (o *Certification) GetDecisionsTotal() int32` + +GetDecisionsTotal returns the DecisionsTotal field if non-nil, zero value otherwise. + +### GetDecisionsTotalOk + +`func (o *Certification) GetDecisionsTotalOk() (*int32, bool)` + +GetDecisionsTotalOk returns a tuple with the DecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsTotal + +`func (o *Certification) SetDecisionsTotal(v int32)` + +SetDecisionsTotal sets DecisionsTotal field to given value. + +### HasDecisionsTotal + +`func (o *Certification) HasDecisionsTotal() bool` + +HasDecisionsTotal returns a boolean if a field has been set. + +### GetDue + +`func (o *Certification) GetDue() SailPointTime` + +GetDue returns the Due field if non-nil, zero value otherwise. + +### GetDueOk + +`func (o *Certification) GetDueOk() (*SailPointTime, bool)` + +GetDueOk returns a tuple with the Due field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDue + +`func (o *Certification) SetDue(v SailPointTime)` + +SetDue sets Due field to given value. + +### HasDue + +`func (o *Certification) HasDue() bool` + +HasDue returns a boolean if a field has been set. + +### SetDueNil + +`func (o *Certification) SetDueNil(b bool)` + + SetDueNil sets the value for Due to be an explicit nil + +### UnsetDue +`func (o *Certification) UnsetDue()` + +UnsetDue ensures that no value is present for Due, not even an explicit nil +### GetSigned + +`func (o *Certification) GetSigned() SailPointTime` + +GetSigned returns the Signed field if non-nil, zero value otherwise. + +### GetSignedOk + +`func (o *Certification) GetSignedOk() (*SailPointTime, bool)` + +GetSignedOk returns a tuple with the Signed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigned + +`func (o *Certification) SetSigned(v SailPointTime)` + +SetSigned sets Signed field to given value. + +### HasSigned + +`func (o *Certification) HasSigned() bool` + +HasSigned returns a boolean if a field has been set. + +### SetSignedNil + +`func (o *Certification) SetSignedNil(b bool)` + + SetSignedNil sets the value for Signed to be an explicit nil + +### UnsetSigned +`func (o *Certification) UnsetSigned()` + +UnsetSigned ensures that no value is present for Signed, not even an explicit nil +### GetReviewer + +`func (o *Certification) GetReviewer() Reviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *Certification) GetReviewerOk() (*Reviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *Certification) SetReviewer(v Reviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *Certification) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetReassignment + +`func (o *Certification) GetReassignment() Reassignment` + +GetReassignment returns the Reassignment field if non-nil, zero value otherwise. + +### GetReassignmentOk + +`func (o *Certification) GetReassignmentOk() (*Reassignment, bool)` + +GetReassignmentOk returns a tuple with the Reassignment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignment + +`func (o *Certification) SetReassignment(v Reassignment)` + +SetReassignment sets Reassignment field to given value. + +### HasReassignment + +`func (o *Certification) HasReassignment() bool` + +HasReassignment returns a boolean if a field has been set. + +### SetReassignmentNil + +`func (o *Certification) SetReassignmentNil(b bool)` + + SetReassignmentNil sets the value for Reassignment to be an explicit nil + +### UnsetReassignment +`func (o *Certification) UnsetReassignment()` + +UnsetReassignment ensures that no value is present for Reassignment, not even an explicit nil +### GetHasErrors + +`func (o *Certification) GetHasErrors() bool` + +GetHasErrors returns the HasErrors field if non-nil, zero value otherwise. + +### GetHasErrorsOk + +`func (o *Certification) GetHasErrorsOk() (*bool, bool)` + +GetHasErrorsOk returns a tuple with the HasErrors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasErrors + +`func (o *Certification) SetHasErrors(v bool)` + +SetHasErrors sets HasErrors field to given value. + +### HasHasErrors + +`func (o *Certification) HasHasErrors() bool` + +HasHasErrors returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *Certification) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *Certification) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *Certification) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *Certification) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### SetErrorMessageNil + +`func (o *Certification) SetErrorMessageNil(b bool)` + + SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil + +### UnsetErrorMessage +`func (o *Certification) UnsetErrorMessage()` + +UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil +### GetPhase + +`func (o *Certification) GetPhase() CertificationPhase` + +GetPhase returns the Phase field if non-nil, zero value otherwise. + +### GetPhaseOk + +`func (o *Certification) GetPhaseOk() (*CertificationPhase, bool)` + +GetPhaseOk returns a tuple with the Phase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhase + +`func (o *Certification) SetPhase(v CertificationPhase)` + +SetPhase sets Phase field to given value. + +### HasPhase + +`func (o *Certification) HasPhase() bool` + +HasPhase returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CertificationDecision.md b/docs/tools/sdk/go/Reference/V2025/Models/CertificationDecision.md new file mode 100644 index 000000000..6cf92b58e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CertificationDecision.md @@ -0,0 +1,21 @@ +--- +id: v2025-certification-decision +title: CertificationDecision +pagination_label: CertificationDecision +sidebar_label: CertificationDecision +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationDecision', 'V2025CertificationDecision'] +slug: /tools/sdk/go/v2025/models/certification-decision +tags: ['SDK', 'Software Development Kit', 'CertificationDecision', 'V2025CertificationDecision'] +--- + +# CertificationDecision + +## Enum + + +* `APPROVE` (value: `"APPROVE"`) + +* `REVOKE` (value: `"REVOKE"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CertificationDto.md b/docs/tools/sdk/go/Reference/V2025/Models/CertificationDto.md new file mode 100644 index 000000000..62cef5fbb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CertificationDto.md @@ -0,0 +1,341 @@ +--- +id: v2025-certification-dto +title: CertificationDto +pagination_label: CertificationDto +sidebar_label: CertificationDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationDto', 'V2025CertificationDto'] +slug: /tools/sdk/go/v2025/models/certification-dto +tags: ['SDK', 'Software Development Kit', 'CertificationDto', 'V2025CertificationDto'] +--- + +# CertificationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CampaignRef** | [**CampaignReference**](campaign-reference) | | +**Phase** | [**CertificationPhase**](certification-phase) | | +**Due** | **SailPointTime** | The due date of the certification. | +**Signed** | **SailPointTime** | The date the reviewer signed off on the certification. | +**Reviewer** | [**Reviewer**](reviewer) | | +**Reassignment** | Pointer to [**NullableReassignment**](reassignment) | | [optional] +**HasErrors** | **bool** | Indicates it the certification has any errors. | +**ErrorMessage** | Pointer to **NullableString** | A message indicating what the error is. | [optional] +**Completed** | **bool** | Indicates if all certification decisions have been made. | +**DecisionsMade** | **int32** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | +**DecisionsTotal** | **int32** | The total number of approve/revoke/acknowledge decisions for the certification. | +**EntitiesCompleted** | **int32** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | +**EntitiesTotal** | **int32** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | + +## Methods + +### NewCertificationDto + +`func NewCertificationDto(campaignRef CampaignReference, phase CertificationPhase, due SailPointTime, signed SailPointTime, reviewer Reviewer, hasErrors bool, completed bool, decisionsMade int32, decisionsTotal int32, entitiesCompleted int32, entitiesTotal int32, ) *CertificationDto` + +NewCertificationDto instantiates a new CertificationDto 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 + +### NewCertificationDtoWithDefaults + +`func NewCertificationDtoWithDefaults() *CertificationDto` + +NewCertificationDtoWithDefaults instantiates a new CertificationDto 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 + +### GetCampaignRef + +`func (o *CertificationDto) GetCampaignRef() CampaignReference` + +GetCampaignRef returns the CampaignRef field if non-nil, zero value otherwise. + +### GetCampaignRefOk + +`func (o *CertificationDto) GetCampaignRefOk() (*CampaignReference, bool)` + +GetCampaignRefOk returns a tuple with the CampaignRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignRef + +`func (o *CertificationDto) SetCampaignRef(v CampaignReference)` + +SetCampaignRef sets CampaignRef field to given value. + + +### GetPhase + +`func (o *CertificationDto) GetPhase() CertificationPhase` + +GetPhase returns the Phase field if non-nil, zero value otherwise. + +### GetPhaseOk + +`func (o *CertificationDto) GetPhaseOk() (*CertificationPhase, bool)` + +GetPhaseOk returns a tuple with the Phase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhase + +`func (o *CertificationDto) SetPhase(v CertificationPhase)` + +SetPhase sets Phase field to given value. + + +### GetDue + +`func (o *CertificationDto) GetDue() SailPointTime` + +GetDue returns the Due field if non-nil, zero value otherwise. + +### GetDueOk + +`func (o *CertificationDto) GetDueOk() (*SailPointTime, bool)` + +GetDueOk returns a tuple with the Due field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDue + +`func (o *CertificationDto) SetDue(v SailPointTime)` + +SetDue sets Due field to given value. + + +### GetSigned + +`func (o *CertificationDto) GetSigned() SailPointTime` + +GetSigned returns the Signed field if non-nil, zero value otherwise. + +### GetSignedOk + +`func (o *CertificationDto) GetSignedOk() (*SailPointTime, bool)` + +GetSignedOk returns a tuple with the Signed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigned + +`func (o *CertificationDto) SetSigned(v SailPointTime)` + +SetSigned sets Signed field to given value. + + +### GetReviewer + +`func (o *CertificationDto) GetReviewer() Reviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CertificationDto) GetReviewerOk() (*Reviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CertificationDto) SetReviewer(v Reviewer)` + +SetReviewer sets Reviewer field to given value. + + +### GetReassignment + +`func (o *CertificationDto) GetReassignment() Reassignment` + +GetReassignment returns the Reassignment field if non-nil, zero value otherwise. + +### GetReassignmentOk + +`func (o *CertificationDto) GetReassignmentOk() (*Reassignment, bool)` + +GetReassignmentOk returns a tuple with the Reassignment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignment + +`func (o *CertificationDto) SetReassignment(v Reassignment)` + +SetReassignment sets Reassignment field to given value. + +### HasReassignment + +`func (o *CertificationDto) HasReassignment() bool` + +HasReassignment returns a boolean if a field has been set. + +### SetReassignmentNil + +`func (o *CertificationDto) SetReassignmentNil(b bool)` + + SetReassignmentNil sets the value for Reassignment to be an explicit nil + +### UnsetReassignment +`func (o *CertificationDto) UnsetReassignment()` + +UnsetReassignment ensures that no value is present for Reassignment, not even an explicit nil +### GetHasErrors + +`func (o *CertificationDto) GetHasErrors() bool` + +GetHasErrors returns the HasErrors field if non-nil, zero value otherwise. + +### GetHasErrorsOk + +`func (o *CertificationDto) GetHasErrorsOk() (*bool, bool)` + +GetHasErrorsOk returns a tuple with the HasErrors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasErrors + +`func (o *CertificationDto) SetHasErrors(v bool)` + +SetHasErrors sets HasErrors field to given value. + + +### GetErrorMessage + +`func (o *CertificationDto) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *CertificationDto) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *CertificationDto) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *CertificationDto) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### SetErrorMessageNil + +`func (o *CertificationDto) SetErrorMessageNil(b bool)` + + SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil + +### UnsetErrorMessage +`func (o *CertificationDto) UnsetErrorMessage()` + +UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil +### GetCompleted + +`func (o *CertificationDto) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *CertificationDto) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *CertificationDto) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + + +### GetDecisionsMade + +`func (o *CertificationDto) GetDecisionsMade() int32` + +GetDecisionsMade returns the DecisionsMade field if non-nil, zero value otherwise. + +### GetDecisionsMadeOk + +`func (o *CertificationDto) GetDecisionsMadeOk() (*int32, bool)` + +GetDecisionsMadeOk returns a tuple with the DecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsMade + +`func (o *CertificationDto) SetDecisionsMade(v int32)` + +SetDecisionsMade sets DecisionsMade field to given value. + + +### GetDecisionsTotal + +`func (o *CertificationDto) GetDecisionsTotal() int32` + +GetDecisionsTotal returns the DecisionsTotal field if non-nil, zero value otherwise. + +### GetDecisionsTotalOk + +`func (o *CertificationDto) GetDecisionsTotalOk() (*int32, bool)` + +GetDecisionsTotalOk returns a tuple with the DecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsTotal + +`func (o *CertificationDto) SetDecisionsTotal(v int32)` + +SetDecisionsTotal sets DecisionsTotal field to given value. + + +### GetEntitiesCompleted + +`func (o *CertificationDto) GetEntitiesCompleted() int32` + +GetEntitiesCompleted returns the EntitiesCompleted field if non-nil, zero value otherwise. + +### GetEntitiesCompletedOk + +`func (o *CertificationDto) GetEntitiesCompletedOk() (*int32, bool)` + +GetEntitiesCompletedOk returns a tuple with the EntitiesCompleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitiesCompleted + +`func (o *CertificationDto) SetEntitiesCompleted(v int32)` + +SetEntitiesCompleted sets EntitiesCompleted field to given value. + + +### GetEntitiesTotal + +`func (o *CertificationDto) GetEntitiesTotal() int32` + +GetEntitiesTotal returns the EntitiesTotal field if non-nil, zero value otherwise. + +### GetEntitiesTotalOk + +`func (o *CertificationDto) GetEntitiesTotalOk() (*int32, bool)` + +GetEntitiesTotalOk returns a tuple with the EntitiesTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitiesTotal + +`func (o *CertificationDto) SetEntitiesTotal(v int32)` + +SetEntitiesTotal sets EntitiesTotal field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CertificationIdentitySummary.md b/docs/tools/sdk/go/Reference/V2025/Models/CertificationIdentitySummary.md new file mode 100644 index 000000000..0cfdbc119 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CertificationIdentitySummary.md @@ -0,0 +1,142 @@ +--- +id: v2025-certification-identity-summary +title: CertificationIdentitySummary +pagination_label: CertificationIdentitySummary +sidebar_label: CertificationIdentitySummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationIdentitySummary', 'V2025CertificationIdentitySummary'] +slug: /tools/sdk/go/v2025/models/certification-identity-summary +tags: ['SDK', 'Software Development Kit', 'CertificationIdentitySummary', 'V2025CertificationIdentitySummary'] +--- + +# CertificationIdentitySummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the identity summary | [optional] +**Name** | Pointer to **string** | Name of the linked identity | [optional] +**IdentityId** | Pointer to **string** | The ID of the identity being certified | [optional] +**Completed** | Pointer to **bool** | Indicates whether the review items for the linked identity's certification have been completed | [optional] + +## Methods + +### NewCertificationIdentitySummary + +`func NewCertificationIdentitySummary() *CertificationIdentitySummary` + +NewCertificationIdentitySummary instantiates a new CertificationIdentitySummary 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 + +### NewCertificationIdentitySummaryWithDefaults + +`func NewCertificationIdentitySummaryWithDefaults() *CertificationIdentitySummary` + +NewCertificationIdentitySummaryWithDefaults instantiates a new CertificationIdentitySummary 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 + +### GetId + +`func (o *CertificationIdentitySummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertificationIdentitySummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertificationIdentitySummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CertificationIdentitySummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CertificationIdentitySummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CertificationIdentitySummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CertificationIdentitySummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CertificationIdentitySummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *CertificationIdentitySummary) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *CertificationIdentitySummary) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *CertificationIdentitySummary) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *CertificationIdentitySummary) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetCompleted + +`func (o *CertificationIdentitySummary) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *CertificationIdentitySummary) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *CertificationIdentitySummary) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *CertificationIdentitySummary) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CertificationPhase.md b/docs/tools/sdk/go/Reference/V2025/Models/CertificationPhase.md new file mode 100644 index 000000000..631661066 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CertificationPhase.md @@ -0,0 +1,23 @@ +--- +id: v2025-certification-phase +title: CertificationPhase +pagination_label: CertificationPhase +sidebar_label: CertificationPhase +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationPhase', 'V2025CertificationPhase'] +slug: /tools/sdk/go/v2025/models/certification-phase +tags: ['SDK', 'Software Development Kit', 'CertificationPhase', 'V2025CertificationPhase'] +--- + +# CertificationPhase + +## Enum + + +* `STAGED` (value: `"STAGED"`) + +* `ACTIVE` (value: `"ACTIVE"`) + +* `SIGNED` (value: `"SIGNED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CertificationReference.md b/docs/tools/sdk/go/Reference/V2025/Models/CertificationReference.md new file mode 100644 index 000000000..f7c945881 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CertificationReference.md @@ -0,0 +1,142 @@ +--- +id: v2025-certification-reference +title: CertificationReference +pagination_label: CertificationReference +sidebar_label: CertificationReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationReference', 'V2025CertificationReference'] +slug: /tools/sdk/go/v2025/models/certification-reference +tags: ['SDK', 'Software Development Kit', 'CertificationReference', 'V2025CertificationReference'] +--- + +# CertificationReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the certification. | [optional] +**Name** | Pointer to **string** | The name of the certification. | [optional] +**Type** | Pointer to **string** | | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] + +## Methods + +### NewCertificationReference + +`func NewCertificationReference() *CertificationReference` + +NewCertificationReference instantiates a new CertificationReference 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 + +### NewCertificationReferenceWithDefaults + +`func NewCertificationReferenceWithDefaults() *CertificationReference` + +NewCertificationReferenceWithDefaults instantiates a new CertificationReference 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 + +### GetId + +`func (o *CertificationReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertificationReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertificationReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CertificationReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CertificationReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CertificationReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CertificationReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CertificationReference) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *CertificationReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CertificationReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CertificationReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CertificationReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetReviewer + +`func (o *CertificationReference) GetReviewer() Reviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CertificationReference) GetReviewerOk() (*Reviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CertificationReference) SetReviewer(v Reviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *CertificationReference) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CertificationSignedOff.md b/docs/tools/sdk/go/Reference/V2025/Models/CertificationSignedOff.md new file mode 100644 index 000000000..767589a20 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CertificationSignedOff.md @@ -0,0 +1,59 @@ +--- +id: v2025-certification-signed-off +title: CertificationSignedOff +pagination_label: CertificationSignedOff +sidebar_label: CertificationSignedOff +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationSignedOff', 'V2025CertificationSignedOff'] +slug: /tools/sdk/go/v2025/models/certification-signed-off +tags: ['SDK', 'Software Development Kit', 'CertificationSignedOff', 'V2025CertificationSignedOff'] +--- + +# CertificationSignedOff + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | + +## Methods + +### NewCertificationSignedOff + +`func NewCertificationSignedOff(certification CertificationSignedOffCertification, ) *CertificationSignedOff` + +NewCertificationSignedOff instantiates a new CertificationSignedOff 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 + +### NewCertificationSignedOffWithDefaults + +`func NewCertificationSignedOffWithDefaults() *CertificationSignedOff` + +NewCertificationSignedOffWithDefaults instantiates a new CertificationSignedOff 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 + +### GetCertification + +`func (o *CertificationSignedOff) GetCertification() CertificationSignedOffCertification` + +GetCertification returns the Certification field if non-nil, zero value otherwise. + +### GetCertificationOk + +`func (o *CertificationSignedOff) GetCertificationOk() (*CertificationSignedOffCertification, bool)` + +GetCertificationOk returns a tuple with the Certification field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertification + +`func (o *CertificationSignedOff) SetCertification(v CertificationSignedOffCertification)` + +SetCertification sets Certification field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CertificationSignedOffCertification.md b/docs/tools/sdk/go/Reference/V2025/Models/CertificationSignedOffCertification.md new file mode 100644 index 000000000..e4b09b5ea --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CertificationSignedOffCertification.md @@ -0,0 +1,440 @@ +--- +id: v2025-certification-signed-off-certification +title: CertificationSignedOffCertification +pagination_label: CertificationSignedOffCertification +sidebar_label: CertificationSignedOffCertification +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationSignedOffCertification', 'V2025CertificationSignedOffCertification'] +slug: /tools/sdk/go/v2025/models/certification-signed-off-certification +tags: ['SDK', 'Software Development Kit', 'CertificationSignedOffCertification', 'V2025CertificationSignedOffCertification'] +--- + +# CertificationSignedOffCertification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique ID of the certification. | +**Name** | **string** | The name of the certification. | +**Created** | **SailPointTime** | The date and time the certification was created. | +**Modified** | Pointer to **NullableTime** | The date and time the certification was last modified. | [optional] +**CampaignRef** | [**CampaignReference**](campaign-reference) | | +**Phase** | [**CertificationPhase**](certification-phase) | | +**Due** | **SailPointTime** | The due date of the certification. | +**Signed** | **SailPointTime** | The date the reviewer signed off on the certification. | +**Reviewer** | [**Reviewer**](reviewer) | | +**Reassignment** | Pointer to [**NullableReassignment**](reassignment) | | [optional] +**HasErrors** | **bool** | Indicates it the certification has any errors. | +**ErrorMessage** | Pointer to **NullableString** | A message indicating what the error is. | [optional] +**Completed** | **bool** | Indicates if all certification decisions have been made. | +**DecisionsMade** | **int32** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | +**DecisionsTotal** | **int32** | The total number of approve/revoke/acknowledge decisions for the certification. | +**EntitiesCompleted** | **int32** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | +**EntitiesTotal** | **int32** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | + +## Methods + +### NewCertificationSignedOffCertification + +`func NewCertificationSignedOffCertification(id string, name string, created SailPointTime, campaignRef CampaignReference, phase CertificationPhase, due SailPointTime, signed SailPointTime, reviewer Reviewer, hasErrors bool, completed bool, decisionsMade int32, decisionsTotal int32, entitiesCompleted int32, entitiesTotal int32, ) *CertificationSignedOffCertification` + +NewCertificationSignedOffCertification instantiates a new CertificationSignedOffCertification 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 + +### NewCertificationSignedOffCertificationWithDefaults + +`func NewCertificationSignedOffCertificationWithDefaults() *CertificationSignedOffCertification` + +NewCertificationSignedOffCertificationWithDefaults instantiates a new CertificationSignedOffCertification 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 + +### GetId + +`func (o *CertificationSignedOffCertification) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertificationSignedOffCertification) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertificationSignedOffCertification) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CertificationSignedOffCertification) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CertificationSignedOffCertification) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CertificationSignedOffCertification) SetName(v string)` + +SetName sets Name field to given value. + + +### GetCreated + +`func (o *CertificationSignedOffCertification) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CertificationSignedOffCertification) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CertificationSignedOffCertification) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CertificationSignedOffCertification) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CertificationSignedOffCertification) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CertificationSignedOffCertification) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CertificationSignedOffCertification) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CertificationSignedOffCertification) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CertificationSignedOffCertification) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetCampaignRef + +`func (o *CertificationSignedOffCertification) GetCampaignRef() CampaignReference` + +GetCampaignRef returns the CampaignRef field if non-nil, zero value otherwise. + +### GetCampaignRefOk + +`func (o *CertificationSignedOffCertification) GetCampaignRefOk() (*CampaignReference, bool)` + +GetCampaignRefOk returns a tuple with the CampaignRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignRef + +`func (o *CertificationSignedOffCertification) SetCampaignRef(v CampaignReference)` + +SetCampaignRef sets CampaignRef field to given value. + + +### GetPhase + +`func (o *CertificationSignedOffCertification) GetPhase() CertificationPhase` + +GetPhase returns the Phase field if non-nil, zero value otherwise. + +### GetPhaseOk + +`func (o *CertificationSignedOffCertification) GetPhaseOk() (*CertificationPhase, bool)` + +GetPhaseOk returns a tuple with the Phase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhase + +`func (o *CertificationSignedOffCertification) SetPhase(v CertificationPhase)` + +SetPhase sets Phase field to given value. + + +### GetDue + +`func (o *CertificationSignedOffCertification) GetDue() SailPointTime` + +GetDue returns the Due field if non-nil, zero value otherwise. + +### GetDueOk + +`func (o *CertificationSignedOffCertification) GetDueOk() (*SailPointTime, bool)` + +GetDueOk returns a tuple with the Due field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDue + +`func (o *CertificationSignedOffCertification) SetDue(v SailPointTime)` + +SetDue sets Due field to given value. + + +### GetSigned + +`func (o *CertificationSignedOffCertification) GetSigned() SailPointTime` + +GetSigned returns the Signed field if non-nil, zero value otherwise. + +### GetSignedOk + +`func (o *CertificationSignedOffCertification) GetSignedOk() (*SailPointTime, bool)` + +GetSignedOk returns a tuple with the Signed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigned + +`func (o *CertificationSignedOffCertification) SetSigned(v SailPointTime)` + +SetSigned sets Signed field to given value. + + +### GetReviewer + +`func (o *CertificationSignedOffCertification) GetReviewer() Reviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CertificationSignedOffCertification) GetReviewerOk() (*Reviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CertificationSignedOffCertification) SetReviewer(v Reviewer)` + +SetReviewer sets Reviewer field to given value. + + +### GetReassignment + +`func (o *CertificationSignedOffCertification) GetReassignment() Reassignment` + +GetReassignment returns the Reassignment field if non-nil, zero value otherwise. + +### GetReassignmentOk + +`func (o *CertificationSignedOffCertification) GetReassignmentOk() (*Reassignment, bool)` + +GetReassignmentOk returns a tuple with the Reassignment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignment + +`func (o *CertificationSignedOffCertification) SetReassignment(v Reassignment)` + +SetReassignment sets Reassignment field to given value. + +### HasReassignment + +`func (o *CertificationSignedOffCertification) HasReassignment() bool` + +HasReassignment returns a boolean if a field has been set. + +### SetReassignmentNil + +`func (o *CertificationSignedOffCertification) SetReassignmentNil(b bool)` + + SetReassignmentNil sets the value for Reassignment to be an explicit nil + +### UnsetReassignment +`func (o *CertificationSignedOffCertification) UnsetReassignment()` + +UnsetReassignment ensures that no value is present for Reassignment, not even an explicit nil +### GetHasErrors + +`func (o *CertificationSignedOffCertification) GetHasErrors() bool` + +GetHasErrors returns the HasErrors field if non-nil, zero value otherwise. + +### GetHasErrorsOk + +`func (o *CertificationSignedOffCertification) GetHasErrorsOk() (*bool, bool)` + +GetHasErrorsOk returns a tuple with the HasErrors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasErrors + +`func (o *CertificationSignedOffCertification) SetHasErrors(v bool)` + +SetHasErrors sets HasErrors field to given value. + + +### GetErrorMessage + +`func (o *CertificationSignedOffCertification) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *CertificationSignedOffCertification) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *CertificationSignedOffCertification) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *CertificationSignedOffCertification) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### SetErrorMessageNil + +`func (o *CertificationSignedOffCertification) SetErrorMessageNil(b bool)` + + SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil + +### UnsetErrorMessage +`func (o *CertificationSignedOffCertification) UnsetErrorMessage()` + +UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil +### GetCompleted + +`func (o *CertificationSignedOffCertification) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *CertificationSignedOffCertification) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *CertificationSignedOffCertification) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + + +### GetDecisionsMade + +`func (o *CertificationSignedOffCertification) GetDecisionsMade() int32` + +GetDecisionsMade returns the DecisionsMade field if non-nil, zero value otherwise. + +### GetDecisionsMadeOk + +`func (o *CertificationSignedOffCertification) GetDecisionsMadeOk() (*int32, bool)` + +GetDecisionsMadeOk returns a tuple with the DecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsMade + +`func (o *CertificationSignedOffCertification) SetDecisionsMade(v int32)` + +SetDecisionsMade sets DecisionsMade field to given value. + + +### GetDecisionsTotal + +`func (o *CertificationSignedOffCertification) GetDecisionsTotal() int32` + +GetDecisionsTotal returns the DecisionsTotal field if non-nil, zero value otherwise. + +### GetDecisionsTotalOk + +`func (o *CertificationSignedOffCertification) GetDecisionsTotalOk() (*int32, bool)` + +GetDecisionsTotalOk returns a tuple with the DecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsTotal + +`func (o *CertificationSignedOffCertification) SetDecisionsTotal(v int32)` + +SetDecisionsTotal sets DecisionsTotal field to given value. + + +### GetEntitiesCompleted + +`func (o *CertificationSignedOffCertification) GetEntitiesCompleted() int32` + +GetEntitiesCompleted returns the EntitiesCompleted field if non-nil, zero value otherwise. + +### GetEntitiesCompletedOk + +`func (o *CertificationSignedOffCertification) GetEntitiesCompletedOk() (*int32, bool)` + +GetEntitiesCompletedOk returns a tuple with the EntitiesCompleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitiesCompleted + +`func (o *CertificationSignedOffCertification) SetEntitiesCompleted(v int32)` + +SetEntitiesCompleted sets EntitiesCompleted field to given value. + + +### GetEntitiesTotal + +`func (o *CertificationSignedOffCertification) GetEntitiesTotal() int32` + +GetEntitiesTotal returns the EntitiesTotal field if non-nil, zero value otherwise. + +### GetEntitiesTotalOk + +`func (o *CertificationSignedOffCertification) GetEntitiesTotalOk() (*int32, bool)` + +GetEntitiesTotalOk returns a tuple with the EntitiesTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitiesTotal + +`func (o *CertificationSignedOffCertification) SetEntitiesTotal(v int32)` + +SetEntitiesTotal sets EntitiesTotal field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CertificationTask.md b/docs/tools/sdk/go/Reference/V2025/Models/CertificationTask.md new file mode 100644 index 000000000..70010b9ea --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CertificationTask.md @@ -0,0 +1,246 @@ +--- +id: v2025-certification-task +title: CertificationTask +pagination_label: CertificationTask +sidebar_label: CertificationTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationTask', 'V2025CertificationTask'] +slug: /tools/sdk/go/v2025/models/certification-task +tags: ['SDK', 'Software Development Kit', 'CertificationTask', 'V2025CertificationTask'] +--- + +# CertificationTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the certification task. | [optional] +**Type** | Pointer to **string** | The type of the certification task. More values may be added in the future. | [optional] +**TargetType** | Pointer to **string** | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [optional] +**TargetId** | Pointer to **string** | The ID of the item being operated on by this task. | [optional] +**Status** | Pointer to **string** | The status of the task. | [optional] +**Errors** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | List of error messages | [optional] +**ReassignmentTrailDTOs** | Pointer to [**[]ReassignmentTrailDTO**](reassignment-trail-dto) | Reassignment trails that lead to self certification identity | [optional] +**Created** | Pointer to **SailPointTime** | The date and time on which this task was created. | [optional] + +## Methods + +### NewCertificationTask + +`func NewCertificationTask() *CertificationTask` + +NewCertificationTask instantiates a new CertificationTask 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 + +### NewCertificationTaskWithDefaults + +`func NewCertificationTaskWithDefaults() *CertificationTask` + +NewCertificationTaskWithDefaults instantiates a new CertificationTask 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 + +### GetId + +`func (o *CertificationTask) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertificationTask) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertificationTask) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CertificationTask) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CertificationTask) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CertificationTask) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CertificationTask) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CertificationTask) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetTargetType + +`func (o *CertificationTask) GetTargetType() string` + +GetTargetType returns the TargetType field if non-nil, zero value otherwise. + +### GetTargetTypeOk + +`func (o *CertificationTask) GetTargetTypeOk() (*string, bool)` + +GetTargetTypeOk returns a tuple with the TargetType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetType + +`func (o *CertificationTask) SetTargetType(v string)` + +SetTargetType sets TargetType field to given value. + +### HasTargetType + +`func (o *CertificationTask) HasTargetType() bool` + +HasTargetType returns a boolean if a field has been set. + +### GetTargetId + +`func (o *CertificationTask) GetTargetId() string` + +GetTargetId returns the TargetId field if non-nil, zero value otherwise. + +### GetTargetIdOk + +`func (o *CertificationTask) GetTargetIdOk() (*string, bool)` + +GetTargetIdOk returns a tuple with the TargetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetId + +`func (o *CertificationTask) SetTargetId(v string)` + +SetTargetId sets TargetId field to given value. + +### HasTargetId + +`func (o *CertificationTask) HasTargetId() bool` + +HasTargetId returns a boolean if a field has been set. + +### GetStatus + +`func (o *CertificationTask) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CertificationTask) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CertificationTask) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CertificationTask) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetErrors + +`func (o *CertificationTask) GetErrors() []ErrorMessageDto` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *CertificationTask) GetErrorsOk() (*[]ErrorMessageDto, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *CertificationTask) SetErrors(v []ErrorMessageDto)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *CertificationTask) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### GetReassignmentTrailDTOs + +`func (o *CertificationTask) GetReassignmentTrailDTOs() []ReassignmentTrailDTO` + +GetReassignmentTrailDTOs returns the ReassignmentTrailDTOs field if non-nil, zero value otherwise. + +### GetReassignmentTrailDTOsOk + +`func (o *CertificationTask) GetReassignmentTrailDTOsOk() (*[]ReassignmentTrailDTO, bool)` + +GetReassignmentTrailDTOsOk returns a tuple with the ReassignmentTrailDTOs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignmentTrailDTOs + +`func (o *CertificationTask) SetReassignmentTrailDTOs(v []ReassignmentTrailDTO)` + +SetReassignmentTrailDTOs sets ReassignmentTrailDTOs field to given value. + +### HasReassignmentTrailDTOs + +`func (o *CertificationTask) HasReassignmentTrailDTOs() bool` + +HasReassignmentTrailDTOs returns a boolean if a field has been set. + +### GetCreated + +`func (o *CertificationTask) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CertificationTask) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CertificationTask) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CertificationTask) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CertifierResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/CertifierResponse.md new file mode 100644 index 000000000..ee2cf221f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CertifierResponse.md @@ -0,0 +1,90 @@ +--- +id: v2025-certifier-response +title: CertifierResponse +pagination_label: CertifierResponse +sidebar_label: CertifierResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertifierResponse', 'V2025CertifierResponse'] +slug: /tools/sdk/go/v2025/models/certifier-response +tags: ['SDK', 'Software Development Kit', 'CertifierResponse', 'V2025CertifierResponse'] +--- + +# CertifierResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the id of the certifier | [optional] +**DisplayName** | Pointer to **string** | the name of the certifier | [optional] + +## Methods + +### NewCertifierResponse + +`func NewCertifierResponse() *CertifierResponse` + +NewCertifierResponse instantiates a new CertifierResponse 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 + +### NewCertifierResponseWithDefaults + +`func NewCertifierResponseWithDefaults() *CertifierResponse` + +NewCertifierResponseWithDefaults instantiates a new CertifierResponse 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 + +### GetId + +`func (o *CertifierResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertifierResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertifierResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CertifierResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *CertifierResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *CertifierResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *CertifierResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *CertifierResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ClientLogConfiguration.md b/docs/tools/sdk/go/Reference/V2025/Models/ClientLogConfiguration.md new file mode 100644 index 000000000..dea9c4698 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ClientLogConfiguration.md @@ -0,0 +1,163 @@ +--- +id: v2025-client-log-configuration +title: ClientLogConfiguration +pagination_label: ClientLogConfiguration +sidebar_label: ClientLogConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClientLogConfiguration', 'V2025ClientLogConfiguration'] +slug: /tools/sdk/go/v2025/models/client-log-configuration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfiguration', 'V2025ClientLogConfiguration'] +--- + +# ClientLogConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **string** | Log configuration's client ID | [optional] +**DurationMinutes** | Pointer to **int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**Expiration** | Pointer to **SailPointTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] +**RootLevel** | [**StandardLevel**](standard-level) | | +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Methods + +### NewClientLogConfiguration + +`func NewClientLogConfiguration(rootLevel StandardLevel, ) *ClientLogConfiguration` + +NewClientLogConfiguration instantiates a new ClientLogConfiguration 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 + +### NewClientLogConfigurationWithDefaults + +`func NewClientLogConfigurationWithDefaults() *ClientLogConfiguration` + +NewClientLogConfigurationWithDefaults instantiates a new ClientLogConfiguration 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 + +### GetClientId + +`func (o *ClientLogConfiguration) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ClientLogConfiguration) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ClientLogConfiguration) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + +### HasClientId + +`func (o *ClientLogConfiguration) HasClientId() bool` + +HasClientId returns a boolean if a field has been set. + +### GetDurationMinutes + +`func (o *ClientLogConfiguration) GetDurationMinutes() int32` + +GetDurationMinutes returns the DurationMinutes field if non-nil, zero value otherwise. + +### GetDurationMinutesOk + +`func (o *ClientLogConfiguration) GetDurationMinutesOk() (*int32, bool)` + +GetDurationMinutesOk returns a tuple with the DurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDurationMinutes + +`func (o *ClientLogConfiguration) SetDurationMinutes(v int32)` + +SetDurationMinutes sets DurationMinutes field to given value. + +### HasDurationMinutes + +`func (o *ClientLogConfiguration) HasDurationMinutes() bool` + +HasDurationMinutes returns a boolean if a field has been set. + +### GetExpiration + +`func (o *ClientLogConfiguration) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *ClientLogConfiguration) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *ClientLogConfiguration) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *ClientLogConfiguration) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + +### GetRootLevel + +`func (o *ClientLogConfiguration) GetRootLevel() StandardLevel` + +GetRootLevel returns the RootLevel field if non-nil, zero value otherwise. + +### GetRootLevelOk + +`func (o *ClientLogConfiguration) GetRootLevelOk() (*StandardLevel, bool)` + +GetRootLevelOk returns a tuple with the RootLevel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootLevel + +`func (o *ClientLogConfiguration) SetRootLevel(v StandardLevel)` + +SetRootLevel sets RootLevel field to given value. + + +### GetLogLevels + +`func (o *ClientLogConfiguration) GetLogLevels() map[string]StandardLevel` + +GetLogLevels returns the LogLevels field if non-nil, zero value otherwise. + +### GetLogLevelsOk + +`func (o *ClientLogConfiguration) GetLogLevelsOk() (*map[string]StandardLevel, bool)` + +GetLogLevelsOk returns a tuple with the LogLevels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogLevels + +`func (o *ClientLogConfiguration) SetLogLevels(v map[string]StandardLevel)` + +SetLogLevels sets LogLevels field to given value. + +### HasLogLevels + +`func (o *ClientLogConfiguration) HasLogLevels() bool` + +HasLogLevels returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ClientLogConfigurationDurationMinutes.md b/docs/tools/sdk/go/Reference/V2025/Models/ClientLogConfigurationDurationMinutes.md new file mode 100644 index 000000000..4f36653c9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ClientLogConfigurationDurationMinutes.md @@ -0,0 +1,137 @@ +--- +id: v2025-client-log-configuration-duration-minutes +title: ClientLogConfigurationDurationMinutes +pagination_label: ClientLogConfigurationDurationMinutes +sidebar_label: ClientLogConfigurationDurationMinutes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClientLogConfigurationDurationMinutes', 'V2025ClientLogConfigurationDurationMinutes'] +slug: /tools/sdk/go/v2025/models/client-log-configuration-duration-minutes +tags: ['SDK', 'Software Development Kit', 'ClientLogConfigurationDurationMinutes', 'V2025ClientLogConfigurationDurationMinutes'] +--- + +# ClientLogConfigurationDurationMinutes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **string** | Log configuration's client ID | [optional] +**DurationMinutes** | Pointer to **int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**RootLevel** | [**StandardLevel**](standard-level) | | +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Methods + +### NewClientLogConfigurationDurationMinutes + +`func NewClientLogConfigurationDurationMinutes(rootLevel StandardLevel, ) *ClientLogConfigurationDurationMinutes` + +NewClientLogConfigurationDurationMinutes instantiates a new ClientLogConfigurationDurationMinutes 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 + +### NewClientLogConfigurationDurationMinutesWithDefaults + +`func NewClientLogConfigurationDurationMinutesWithDefaults() *ClientLogConfigurationDurationMinutes` + +NewClientLogConfigurationDurationMinutesWithDefaults instantiates a new ClientLogConfigurationDurationMinutes 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 + +### GetClientId + +`func (o *ClientLogConfigurationDurationMinutes) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ClientLogConfigurationDurationMinutes) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ClientLogConfigurationDurationMinutes) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + +### HasClientId + +`func (o *ClientLogConfigurationDurationMinutes) HasClientId() bool` + +HasClientId returns a boolean if a field has been set. + +### GetDurationMinutes + +`func (o *ClientLogConfigurationDurationMinutes) GetDurationMinutes() int32` + +GetDurationMinutes returns the DurationMinutes field if non-nil, zero value otherwise. + +### GetDurationMinutesOk + +`func (o *ClientLogConfigurationDurationMinutes) GetDurationMinutesOk() (*int32, bool)` + +GetDurationMinutesOk returns a tuple with the DurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDurationMinutes + +`func (o *ClientLogConfigurationDurationMinutes) SetDurationMinutes(v int32)` + +SetDurationMinutes sets DurationMinutes field to given value. + +### HasDurationMinutes + +`func (o *ClientLogConfigurationDurationMinutes) HasDurationMinutes() bool` + +HasDurationMinutes returns a boolean if a field has been set. + +### GetRootLevel + +`func (o *ClientLogConfigurationDurationMinutes) GetRootLevel() StandardLevel` + +GetRootLevel returns the RootLevel field if non-nil, zero value otherwise. + +### GetRootLevelOk + +`func (o *ClientLogConfigurationDurationMinutes) GetRootLevelOk() (*StandardLevel, bool)` + +GetRootLevelOk returns a tuple with the RootLevel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootLevel + +`func (o *ClientLogConfigurationDurationMinutes) SetRootLevel(v StandardLevel)` + +SetRootLevel sets RootLevel field to given value. + + +### GetLogLevels + +`func (o *ClientLogConfigurationDurationMinutes) GetLogLevels() map[string]StandardLevel` + +GetLogLevels returns the LogLevels field if non-nil, zero value otherwise. + +### GetLogLevelsOk + +`func (o *ClientLogConfigurationDurationMinutes) GetLogLevelsOk() (*map[string]StandardLevel, bool)` + +GetLogLevelsOk returns a tuple with the LogLevels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogLevels + +`func (o *ClientLogConfigurationDurationMinutes) SetLogLevels(v map[string]StandardLevel)` + +SetLogLevels sets LogLevels field to given value. + +### HasLogLevels + +`func (o *ClientLogConfigurationDurationMinutes) HasLogLevels() bool` + +HasLogLevels returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ClientLogConfigurationExpiration.md b/docs/tools/sdk/go/Reference/V2025/Models/ClientLogConfigurationExpiration.md new file mode 100644 index 000000000..2cfa5aabc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ClientLogConfigurationExpiration.md @@ -0,0 +1,137 @@ +--- +id: v2025-client-log-configuration-expiration +title: ClientLogConfigurationExpiration +pagination_label: ClientLogConfigurationExpiration +sidebar_label: ClientLogConfigurationExpiration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClientLogConfigurationExpiration', 'V2025ClientLogConfigurationExpiration'] +slug: /tools/sdk/go/v2025/models/client-log-configuration-expiration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfigurationExpiration', 'V2025ClientLogConfigurationExpiration'] +--- + +# ClientLogConfigurationExpiration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **string** | Log configuration's client ID | [optional] +**Expiration** | Pointer to **SailPointTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] +**RootLevel** | [**StandardLevel**](standard-level) | | +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Methods + +### NewClientLogConfigurationExpiration + +`func NewClientLogConfigurationExpiration(rootLevel StandardLevel, ) *ClientLogConfigurationExpiration` + +NewClientLogConfigurationExpiration instantiates a new ClientLogConfigurationExpiration 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 + +### NewClientLogConfigurationExpirationWithDefaults + +`func NewClientLogConfigurationExpirationWithDefaults() *ClientLogConfigurationExpiration` + +NewClientLogConfigurationExpirationWithDefaults instantiates a new ClientLogConfigurationExpiration 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 + +### GetClientId + +`func (o *ClientLogConfigurationExpiration) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ClientLogConfigurationExpiration) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ClientLogConfigurationExpiration) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + +### HasClientId + +`func (o *ClientLogConfigurationExpiration) HasClientId() bool` + +HasClientId returns a boolean if a field has been set. + +### GetExpiration + +`func (o *ClientLogConfigurationExpiration) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *ClientLogConfigurationExpiration) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *ClientLogConfigurationExpiration) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *ClientLogConfigurationExpiration) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + +### GetRootLevel + +`func (o *ClientLogConfigurationExpiration) GetRootLevel() StandardLevel` + +GetRootLevel returns the RootLevel field if non-nil, zero value otherwise. + +### GetRootLevelOk + +`func (o *ClientLogConfigurationExpiration) GetRootLevelOk() (*StandardLevel, bool)` + +GetRootLevelOk returns a tuple with the RootLevel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootLevel + +`func (o *ClientLogConfigurationExpiration) SetRootLevel(v StandardLevel)` + +SetRootLevel sets RootLevel field to given value. + + +### GetLogLevels + +`func (o *ClientLogConfigurationExpiration) GetLogLevels() map[string]StandardLevel` + +GetLogLevels returns the LogLevels field if non-nil, zero value otherwise. + +### GetLogLevelsOk + +`func (o *ClientLogConfigurationExpiration) GetLogLevelsOk() (*map[string]StandardLevel, bool)` + +GetLogLevelsOk returns a tuple with the LogLevels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogLevels + +`func (o *ClientLogConfigurationExpiration) SetLogLevels(v map[string]StandardLevel)` + +SetLogLevels sets LogLevels field to given value. + +### HasLogLevels + +`func (o *ClientLogConfigurationExpiration) HasLogLevels() bool` + +HasLogLevels returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ClientType.md b/docs/tools/sdk/go/Reference/V2025/Models/ClientType.md new file mode 100644 index 000000000..0c230d01e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ClientType.md @@ -0,0 +1,21 @@ +--- +id: v2025-client-type +title: ClientType +pagination_label: ClientType +sidebar_label: ClientType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClientType', 'V2025ClientType'] +slug: /tools/sdk/go/v2025/models/client-type +tags: ['SDK', 'Software Development Kit', 'ClientType', 'V2025ClientType'] +--- + +# ClientType + +## Enum + + +* `CONFIDENTIAL` (value: `"CONFIDENTIAL"`) + +* `PUBLIC` (value: `"PUBLIC"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CloseAccessRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/CloseAccessRequest.md new file mode 100644 index 000000000..cf9b3ab51 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CloseAccessRequest.md @@ -0,0 +1,137 @@ +--- +id: v2025-close-access-request +title: CloseAccessRequest +pagination_label: CloseAccessRequest +sidebar_label: CloseAccessRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CloseAccessRequest', 'V2025CloseAccessRequest'] +slug: /tools/sdk/go/v2025/models/close-access-request +tags: ['SDK', 'Software Development Kit', 'CloseAccessRequest', 'V2025CloseAccessRequest'] +--- + +# CloseAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestIds** | **[]string** | Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request. | +**Message** | Pointer to **string** | Reason for closing the access request. Displayed under Warnings in IdentityNow. | [optional] [default to "The IdentityNow Administrator manually closed this request."] +**ExecutionStatus** | Pointer to **string** | The request's provisioning status. Displayed as Stage in IdentityNow. | [optional] [default to "Terminated"] +**CompletionStatus** | Pointer to **string** | The request's overall status. Displayed as Status in IdentityNow. | [optional] [default to "Failure"] + +## Methods + +### NewCloseAccessRequest + +`func NewCloseAccessRequest(accessRequestIds []string, ) *CloseAccessRequest` + +NewCloseAccessRequest instantiates a new CloseAccessRequest 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 + +### NewCloseAccessRequestWithDefaults + +`func NewCloseAccessRequestWithDefaults() *CloseAccessRequest` + +NewCloseAccessRequestWithDefaults instantiates a new CloseAccessRequest 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 + +### GetAccessRequestIds + +`func (o *CloseAccessRequest) GetAccessRequestIds() []string` + +GetAccessRequestIds returns the AccessRequestIds field if non-nil, zero value otherwise. + +### GetAccessRequestIdsOk + +`func (o *CloseAccessRequest) GetAccessRequestIdsOk() (*[]string, bool)` + +GetAccessRequestIdsOk returns a tuple with the AccessRequestIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestIds + +`func (o *CloseAccessRequest) SetAccessRequestIds(v []string)` + +SetAccessRequestIds sets AccessRequestIds field to given value. + + +### GetMessage + +`func (o *CloseAccessRequest) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *CloseAccessRequest) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *CloseAccessRequest) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *CloseAccessRequest) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetExecutionStatus + +`func (o *CloseAccessRequest) GetExecutionStatus() string` + +GetExecutionStatus returns the ExecutionStatus field if non-nil, zero value otherwise. + +### GetExecutionStatusOk + +`func (o *CloseAccessRequest) GetExecutionStatusOk() (*string, bool)` + +GetExecutionStatusOk returns a tuple with the ExecutionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExecutionStatus + +`func (o *CloseAccessRequest) SetExecutionStatus(v string)` + +SetExecutionStatus sets ExecutionStatus field to given value. + +### HasExecutionStatus + +`func (o *CloseAccessRequest) HasExecutionStatus() bool` + +HasExecutionStatus returns a boolean if a field has been set. + +### GetCompletionStatus + +`func (o *CloseAccessRequest) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *CloseAccessRequest) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *CloseAccessRequest) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *CloseAccessRequest) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgrade.md b/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgrade.md new file mode 100644 index 000000000..072e0e853 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgrade.md @@ -0,0 +1,64 @@ +--- +id: v2025-cluster-manual-upgrade +title: ClusterManualUpgrade +pagination_label: ClusterManualUpgrade +sidebar_label: ClusterManualUpgrade +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClusterManualUpgrade', 'V2025ClusterManualUpgrade'] +slug: /tools/sdk/go/v2025/models/cluster-manual-upgrade +tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgrade', 'V2025ClusterManualUpgrade'] +--- + +# ClusterManualUpgrade + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Jobs** | Pointer to [**[]ClusterManualUpgradeJobsInner**](cluster-manual-upgrade-jobs-inner) | List of job objects for the upgrade request. | [optional] + +## Methods + +### NewClusterManualUpgrade + +`func NewClusterManualUpgrade() *ClusterManualUpgrade` + +NewClusterManualUpgrade instantiates a new ClusterManualUpgrade 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 + +### NewClusterManualUpgradeWithDefaults + +`func NewClusterManualUpgradeWithDefaults() *ClusterManualUpgrade` + +NewClusterManualUpgradeWithDefaults instantiates a new ClusterManualUpgrade 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 + +### GetJobs + +`func (o *ClusterManualUpgrade) GetJobs() []ClusterManualUpgradeJobsInner` + +GetJobs returns the Jobs field if non-nil, zero value otherwise. + +### GetJobsOk + +`func (o *ClusterManualUpgrade) GetJobsOk() (*[]ClusterManualUpgradeJobsInner, bool)` + +GetJobsOk returns a tuple with the Jobs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobs + +`func (o *ClusterManualUpgrade) SetJobs(v []ClusterManualUpgradeJobsInner)` + +SetJobs sets Jobs field to given value. + +### HasJobs + +`func (o *ClusterManualUpgrade) HasJobs() bool` + +HasJobs returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInner.md b/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInner.md new file mode 100644 index 000000000..662866348 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInner.md @@ -0,0 +1,164 @@ +--- +id: v2025-cluster-manual-upgrade-jobs-inner +title: ClusterManualUpgradeJobsInner +pagination_label: ClusterManualUpgradeJobsInner +sidebar_label: ClusterManualUpgradeJobsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClusterManualUpgradeJobsInner', 'V2025ClusterManualUpgradeJobsInner'] +slug: /tools/sdk/go/v2025/models/cluster-manual-upgrade-jobs-inner +tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInner', 'V2025ClusterManualUpgradeJobsInner'] +--- + +# ClusterManualUpgradeJobsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | **string** | Unique identifier for the upgrade job. | +**Cookbook** | **string** | Identifier for the cookbook used in the upgrade job. | +**State** | **string** | Current state of the upgrade job. | +**Type** | **string** | The type of upgrade job (e.g., VA_UPGRADE). | +**TargetId** | **string** | Unique identifier of the target for the upgrade job. | +**ManagedProcessConfiguration** | [**ClusterManualUpgradeJobsInnerManagedProcessConfiguration**](cluster-manual-upgrade-jobs-inner-managed-process-configuration) | | + +## Methods + +### NewClusterManualUpgradeJobsInner + +`func NewClusterManualUpgradeJobsInner(uuid string, cookbook string, state string, type_ string, targetId string, managedProcessConfiguration ClusterManualUpgradeJobsInnerManagedProcessConfiguration, ) *ClusterManualUpgradeJobsInner` + +NewClusterManualUpgradeJobsInner instantiates a new ClusterManualUpgradeJobsInner 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 + +### NewClusterManualUpgradeJobsInnerWithDefaults + +`func NewClusterManualUpgradeJobsInnerWithDefaults() *ClusterManualUpgradeJobsInner` + +NewClusterManualUpgradeJobsInnerWithDefaults instantiates a new ClusterManualUpgradeJobsInner 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 + +### GetUuid + +`func (o *ClusterManualUpgradeJobsInner) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *ClusterManualUpgradeJobsInner) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *ClusterManualUpgradeJobsInner) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + + +### GetCookbook + +`func (o *ClusterManualUpgradeJobsInner) GetCookbook() string` + +GetCookbook returns the Cookbook field if non-nil, zero value otherwise. + +### GetCookbookOk + +`func (o *ClusterManualUpgradeJobsInner) GetCookbookOk() (*string, bool)` + +GetCookbookOk returns a tuple with the Cookbook field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCookbook + +`func (o *ClusterManualUpgradeJobsInner) SetCookbook(v string)` + +SetCookbook sets Cookbook field to given value. + + +### GetState + +`func (o *ClusterManualUpgradeJobsInner) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ClusterManualUpgradeJobsInner) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ClusterManualUpgradeJobsInner) SetState(v string)` + +SetState sets State field to given value. + + +### GetType + +`func (o *ClusterManualUpgradeJobsInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ClusterManualUpgradeJobsInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ClusterManualUpgradeJobsInner) SetType(v string)` + +SetType sets Type field to given value. + + +### GetTargetId + +`func (o *ClusterManualUpgradeJobsInner) GetTargetId() string` + +GetTargetId returns the TargetId field if non-nil, zero value otherwise. + +### GetTargetIdOk + +`func (o *ClusterManualUpgradeJobsInner) GetTargetIdOk() (*string, bool)` + +GetTargetIdOk returns a tuple with the TargetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetId + +`func (o *ClusterManualUpgradeJobsInner) SetTargetId(v string)` + +SetTargetId sets TargetId field to given value. + + +### GetManagedProcessConfiguration + +`func (o *ClusterManualUpgradeJobsInner) GetManagedProcessConfiguration() ClusterManualUpgradeJobsInnerManagedProcessConfiguration` + +GetManagedProcessConfiguration returns the ManagedProcessConfiguration field if non-nil, zero value otherwise. + +### GetManagedProcessConfigurationOk + +`func (o *ClusterManualUpgradeJobsInner) GetManagedProcessConfigurationOk() (*ClusterManualUpgradeJobsInnerManagedProcessConfiguration, bool)` + +GetManagedProcessConfigurationOk returns a tuple with the ManagedProcessConfiguration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagedProcessConfiguration + +`func (o *ClusterManualUpgradeJobsInner) SetManagedProcessConfiguration(v ClusterManualUpgradeJobsInnerManagedProcessConfiguration)` + +SetManagedProcessConfiguration sets ManagedProcessConfiguration field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfiguration.md b/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfiguration.md new file mode 100644 index 000000000..f78501e95 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfiguration.md @@ -0,0 +1,168 @@ +--- +id: v2025-cluster-manual-upgrade-jobs-inner-managed-process-configuration +title: ClusterManualUpgradeJobsInnerManagedProcessConfiguration +pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfiguration +sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfiguration', 'V2025ClusterManualUpgradeJobsInnerManagedProcessConfiguration'] +slug: /tools/sdk/go/v2025/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration +tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfiguration', 'V2025ClusterManualUpgradeJobsInnerManagedProcessConfiguration'] +--- + +# ClusterManualUpgradeJobsInnerManagedProcessConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Charon** | Pointer to [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-charon) | | [optional] +**Ccg** | Pointer to [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-ccg) | | [optional] +**OtelAgent** | Pointer to [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-otel-agent) | | [optional] +**Relay** | Pointer to [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-relay) | | [optional] +**Toolbox** | Pointer to [**ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox**](cluster-manual-upgrade-jobs-inner-managed-process-configuration-toolbox) | | [optional] + +## Methods + +### NewClusterManualUpgradeJobsInnerManagedProcessConfiguration + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfiguration() *ClusterManualUpgradeJobsInnerManagedProcessConfiguration` + +NewClusterManualUpgradeJobsInnerManagedProcessConfiguration instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfiguration 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 + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationWithDefaults + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationWithDefaults() *ClusterManualUpgradeJobsInnerManagedProcessConfiguration` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationWithDefaults instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfiguration 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 + +### GetCharon + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetCharon() ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon` + +GetCharon returns the Charon field if non-nil, zero value otherwise. + +### GetCharonOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetCharonOk() (*ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon, bool)` + +GetCharonOk returns a tuple with the Charon field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCharon + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) SetCharon(v ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon)` + +SetCharon sets Charon field to given value. + +### HasCharon + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) HasCharon() bool` + +HasCharon returns a boolean if a field has been set. + +### GetCcg + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetCcg() ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg` + +GetCcg returns the Ccg field if non-nil, zero value otherwise. + +### GetCcgOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetCcgOk() (*ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg, bool)` + +GetCcgOk returns a tuple with the Ccg field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCcg + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) SetCcg(v ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg)` + +SetCcg sets Ccg field to given value. + +### HasCcg + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) HasCcg() bool` + +HasCcg returns a boolean if a field has been set. + +### GetOtelAgent + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetOtelAgent() ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent` + +GetOtelAgent returns the OtelAgent field if non-nil, zero value otherwise. + +### GetOtelAgentOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetOtelAgentOk() (*ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent, bool)` + +GetOtelAgentOk returns a tuple with the OtelAgent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOtelAgent + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) SetOtelAgent(v ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent)` + +SetOtelAgent sets OtelAgent field to given value. + +### HasOtelAgent + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) HasOtelAgent() bool` + +HasOtelAgent returns a boolean if a field has been set. + +### GetRelay + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetRelay() ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay` + +GetRelay returns the Relay field if non-nil, zero value otherwise. + +### GetRelayOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetRelayOk() (*ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay, bool)` + +GetRelayOk returns a tuple with the Relay field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRelay + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) SetRelay(v ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay)` + +SetRelay sets Relay field to given value. + +### HasRelay + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) HasRelay() bool` + +HasRelay returns a boolean if a field has been set. + +### GetToolbox + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetToolbox() ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox` + +GetToolbox returns the Toolbox field if non-nil, zero value otherwise. + +### GetToolboxOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) GetToolboxOk() (*ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox, bool)` + +GetToolboxOk returns a tuple with the Toolbox field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetToolbox + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) SetToolbox(v ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox)` + +SetToolbox sets Toolbox field to given value. + +### HasToolbox + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfiguration) HasToolbox() bool` + +HasToolbox returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg.md b/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg.md new file mode 100644 index 000000000..c6a773a8f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg.md @@ -0,0 +1,143 @@ +--- +id: v2025-cluster-manual-upgrade-jobs-inner-managed-process-configuration-ccg +title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg +pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg +sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg', 'V2025ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg'] +slug: /tools/sdk/go/v2025/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-ccg +tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg', 'V2025ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg'] +--- + +# ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | **string** | Version of the 'ccg' process. | +**Path** | **string** | Path to the 'ccg' process. | +**Description** | **string** | A brief description of the 'ccg' process. | +**RestartNeeded** | **bool** | Indicates whether the process needs to be restarted. | +**Dependencies** | **map[string]string** | A map of dependencies for the 'ccg' process. | + +## Methods + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg(version string, path string, description string, restartNeeded bool, dependencies map[string]string, ) *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg 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 + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgWithDefaults + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgWithDefaults() *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgWithDefaults instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg 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 + +### GetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) SetVersion(v string)` + +SetVersion sets Version field to given value. + + +### GetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetRestartNeeded() bool` + +GetRestartNeeded returns the RestartNeeded field if non-nil, zero value otherwise. + +### GetRestartNeededOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetRestartNeededOk() (*bool, bool)` + +GetRestartNeededOk returns a tuple with the RestartNeeded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) SetRestartNeeded(v bool)` + +SetRestartNeeded sets RestartNeeded field to given value. + + +### GetDependencies + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetDependencies() map[string]string` + +GetDependencies returns the Dependencies field if non-nil, zero value otherwise. + +### GetDependenciesOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) GetDependenciesOk() (*map[string]string, bool)` + +GetDependenciesOk returns a tuple with the Dependencies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDependencies + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcg) SetDependencies(v map[string]string)` + +SetDependencies sets Dependencies field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon.md b/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon.md new file mode 100644 index 000000000..3f74b466d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon.md @@ -0,0 +1,122 @@ +--- +id: v2025-cluster-manual-upgrade-jobs-inner-managed-process-configuration-charon +title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon +pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon +sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon', 'V2025ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon'] +slug: /tools/sdk/go/v2025/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-charon +tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon', 'V2025ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon'] +--- + +# ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | **string** | Version of the 'charon' process. | +**Path** | **string** | Path to the 'charon' process. | +**Description** | **string** | A brief description of the 'charon' process. | +**RestartNeeded** | **bool** | Indicates whether the process needs to be restarted. | + +## Methods + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon(version string, path string, description string, restartNeeded bool, ) *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon 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 + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonWithDefaults + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonWithDefaults() *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonWithDefaults instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon 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 + +### GetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) SetVersion(v string)` + +SetVersion sets Version field to given value. + + +### GetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) GetRestartNeeded() bool` + +GetRestartNeeded returns the RestartNeeded field if non-nil, zero value otherwise. + +### GetRestartNeededOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) GetRestartNeededOk() (*bool, bool)` + +GetRestartNeededOk returns a tuple with the RestartNeeded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharon) SetRestartNeeded(v bool)` + +SetRestartNeeded sets RestartNeeded field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent.md b/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent.md new file mode 100644 index 000000000..1359c5836 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent.md @@ -0,0 +1,122 @@ +--- +id: v2025-cluster-manual-upgrade-jobs-inner-managed-process-configuration-otel-agent +title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent +pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent +sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent', 'V2025ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent'] +slug: /tools/sdk/go/v2025/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-otel-agent +tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent', 'V2025ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent'] +--- + +# ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | **string** | Version of the 'otel_agent' process. | +**Path** | **string** | Path to the 'otel_agent' process. | +**Description** | **string** | A brief description of the 'otel_agent' process. | +**RestartNeeded** | **bool** | Indicates whether the process needs to be restarted. | + +## Methods + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent(version string, path string, description string, restartNeeded bool, ) *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent 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 + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentWithDefaults + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentWithDefaults() *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentWithDefaults instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent 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 + +### GetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) SetVersion(v string)` + +SetVersion sets Version field to given value. + + +### GetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) GetRestartNeeded() bool` + +GetRestartNeeded returns the RestartNeeded field if non-nil, zero value otherwise. + +### GetRestartNeededOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) GetRestartNeededOk() (*bool, bool)` + +GetRestartNeededOk returns a tuple with the RestartNeeded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgent) SetRestartNeeded(v bool)` + +SetRestartNeeded sets RestartNeeded field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay.md b/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay.md new file mode 100644 index 000000000..fd68eb7ce --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay.md @@ -0,0 +1,122 @@ +--- +id: v2025-cluster-manual-upgrade-jobs-inner-managed-process-configuration-relay +title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay +pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay +sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay', 'V2025ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay'] +slug: /tools/sdk/go/v2025/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-relay +tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay', 'V2025ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay'] +--- + +# ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | **string** | Version of the 'relay' process. | +**Path** | **string** | Path to the 'relay' process. | +**Description** | **string** | A brief description of the 'relay' process. | +**RestartNeeded** | **bool** | Indicates whether the process needs to be restarted. | + +## Methods + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay(version string, path string, description string, restartNeeded bool, ) *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay 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 + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayWithDefaults + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayWithDefaults() *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayWithDefaults instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay 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 + +### GetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) SetVersion(v string)` + +SetVersion sets Version field to given value. + + +### GetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) GetRestartNeeded() bool` + +GetRestartNeeded returns the RestartNeeded field if non-nil, zero value otherwise. + +### GetRestartNeededOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) GetRestartNeededOk() (*bool, bool)` + +GetRestartNeededOk returns a tuple with the RestartNeeded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelay) SetRestartNeeded(v bool)` + +SetRestartNeeded sets RestartNeeded field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox.md b/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox.md new file mode 100644 index 000000000..21ec14ab4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox.md @@ -0,0 +1,122 @@ +--- +id: v2025-cluster-manual-upgrade-jobs-inner-managed-process-configuration-toolbox +title: ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox +pagination_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox +sidebar_label: ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox', 'V2025ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox'] +slug: /tools/sdk/go/v2025/models/cluster-manual-upgrade-jobs-inner-managed-process-configuration-toolbox +tags: ['SDK', 'Software Development Kit', 'ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox', 'V2025ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox'] +--- + +# ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | **string** | Version of the 'toolbox' process. | +**Path** | **string** | Path to the 'toolbox' process. | +**Description** | **string** | A brief description of the 'toolbox' process. | +**RestartNeeded** | **bool** | Indicates whether the process needs to be restarted. | + +## Methods + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox(version string, path string, description string, restartNeeded bool, ) *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox 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 + +### NewClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxWithDefaults + +`func NewClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxWithDefaults() *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox` + +NewClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxWithDefaults instantiates a new ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox 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 + +### GetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) SetVersion(v string)` + +SetVersion sets Version field to given value. + + +### GetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) GetRestartNeeded() bool` + +GetRestartNeeded returns the RestartNeeded field if non-nil, zero value otherwise. + +### GetRestartNeededOk + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) GetRestartNeededOk() (*bool, bool)` + +GetRestartNeededOk returns a tuple with the RestartNeeded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRestartNeeded + +`func (o *ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolbox) SetRestartNeeded(v bool)` + +SetRestartNeeded sets RestartNeeded field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Column.md b/docs/tools/sdk/go/Reference/V2025/Models/Column.md new file mode 100644 index 000000000..7c69d9cd1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Column.md @@ -0,0 +1,85 @@ +--- +id: v2025-column +title: Column +pagination_label: Column +sidebar_label: Column +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Column', 'V2025Column'] +slug: /tools/sdk/go/v2025/models/column +tags: ['SDK', 'Software Development Kit', 'Column', 'V2025Column'] +--- + +# Column + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Field** | **string** | The name of the field. | +**Header** | Pointer to **string** | The value of the header. | [optional] + +## Methods + +### NewColumn + +`func NewColumn(field string, ) *Column` + +NewColumn instantiates a new Column 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 + +### NewColumnWithDefaults + +`func NewColumnWithDefaults() *Column` + +NewColumnWithDefaults instantiates a new Column 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 + +### GetField + +`func (o *Column) GetField() string` + +GetField returns the Field field if non-nil, zero value otherwise. + +### GetFieldOk + +`func (o *Column) GetFieldOk() (*string, bool)` + +GetFieldOk returns a tuple with the Field field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetField + +`func (o *Column) SetField(v string)` + +SetField sets Field field to given value. + + +### GetHeader + +`func (o *Column) GetHeader() string` + +GetHeader returns the Header field if non-nil, zero value otherwise. + +### GetHeaderOk + +`func (o *Column) GetHeaderOk() (*string, bool)` + +GetHeaderOk returns a tuple with the Header field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHeader + +`func (o *Column) SetHeader(v string)` + +SetHeader sets Header field to given value. + +### HasHeader + +`func (o *Column) HasHeader() bool` + +HasHeader returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Comment.md b/docs/tools/sdk/go/Reference/V2025/Models/Comment.md new file mode 100644 index 000000000..f1ed4e339 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Comment.md @@ -0,0 +1,142 @@ +--- +id: v2025-comment +title: Comment +pagination_label: Comment +sidebar_label: Comment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Comment', 'V2025Comment'] +slug: /tools/sdk/go/v2025/models/comment +tags: ['SDK', 'Software Development Kit', 'Comment', 'V2025Comment'] +--- + +# Comment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommenterId** | Pointer to **string** | Id of the identity making the comment | [optional] +**CommenterName** | Pointer to **string** | Human-readable display name of the identity making the comment | [optional] +**Body** | Pointer to **string** | Content of the comment | [optional] +**Date** | Pointer to **SailPointTime** | Date and time comment was made | [optional] + +## Methods + +### NewComment + +`func NewComment() *Comment` + +NewComment instantiates a new Comment 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 + +### NewCommentWithDefaults + +`func NewCommentWithDefaults() *Comment` + +NewCommentWithDefaults instantiates a new Comment 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 + +### GetCommenterId + +`func (o *Comment) GetCommenterId() string` + +GetCommenterId returns the CommenterId field if non-nil, zero value otherwise. + +### GetCommenterIdOk + +`func (o *Comment) GetCommenterIdOk() (*string, bool)` + +GetCommenterIdOk returns a tuple with the CommenterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommenterId + +`func (o *Comment) SetCommenterId(v string)` + +SetCommenterId sets CommenterId field to given value. + +### HasCommenterId + +`func (o *Comment) HasCommenterId() bool` + +HasCommenterId returns a boolean if a field has been set. + +### GetCommenterName + +`func (o *Comment) GetCommenterName() string` + +GetCommenterName returns the CommenterName field if non-nil, zero value otherwise. + +### GetCommenterNameOk + +`func (o *Comment) GetCommenterNameOk() (*string, bool)` + +GetCommenterNameOk returns a tuple with the CommenterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommenterName + +`func (o *Comment) SetCommenterName(v string)` + +SetCommenterName sets CommenterName field to given value. + +### HasCommenterName + +`func (o *Comment) HasCommenterName() bool` + +HasCommenterName returns a boolean if a field has been set. + +### GetBody + +`func (o *Comment) GetBody() string` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *Comment) GetBodyOk() (*string, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBody + +`func (o *Comment) SetBody(v string)` + +SetBody sets Body field to given value. + +### HasBody + +`func (o *Comment) HasBody() bool` + +HasBody returns a boolean if a field has been set. + +### GetDate + +`func (o *Comment) GetDate() SailPointTime` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *Comment) GetDateOk() (*SailPointTime, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *Comment) SetDate(v SailPointTime)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *Comment) HasDate() bool` + +HasDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CommentDto.md b/docs/tools/sdk/go/Reference/V2025/Models/CommentDto.md new file mode 100644 index 000000000..1d6305917 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CommentDto.md @@ -0,0 +1,126 @@ +--- +id: v2025-comment-dto +title: CommentDto +pagination_label: CommentDto +sidebar_label: CommentDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommentDto', 'V2025CommentDto'] +slug: /tools/sdk/go/v2025/models/comment-dto +tags: ['SDK', 'Software Development Kit', 'CommentDto', 'V2025CommentDto'] +--- + +# CommentDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **NullableString** | Comment content. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Methods + +### NewCommentDto + +`func NewCommentDto() *CommentDto` + +NewCommentDto instantiates a new CommentDto 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 + +### NewCommentDtoWithDefaults + +`func NewCommentDtoWithDefaults() *CommentDto` + +NewCommentDtoWithDefaults instantiates a new CommentDto 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 + +### GetComment + +`func (o *CommentDto) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CommentDto) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CommentDto) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CommentDto) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *CommentDto) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *CommentDto) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetCreated + +`func (o *CommentDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CommentDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CommentDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CommentDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetAuthor + +`func (o *CommentDto) GetAuthor() CommentDtoAuthor` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *CommentDto) GetAuthorOk() (*CommentDtoAuthor, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *CommentDto) SetAuthor(v CommentDtoAuthor)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *CommentDto) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CommentDtoAuthor.md b/docs/tools/sdk/go/Reference/V2025/Models/CommentDtoAuthor.md new file mode 100644 index 000000000..963b02cd1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CommentDtoAuthor.md @@ -0,0 +1,116 @@ +--- +id: v2025-comment-dto-author +title: CommentDtoAuthor +pagination_label: CommentDtoAuthor +sidebar_label: CommentDtoAuthor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommentDtoAuthor', 'V2025CommentDtoAuthor'] +slug: /tools/sdk/go/v2025/models/comment-dto-author +tags: ['SDK', 'Software Development Kit', 'CommentDtoAuthor', 'V2025CommentDtoAuthor'] +--- + +# CommentDtoAuthor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of object | [optional] +**Id** | Pointer to **string** | The unique ID of the object | [optional] +**Name** | Pointer to **string** | The display name of the object | [optional] + +## Methods + +### NewCommentDtoAuthor + +`func NewCommentDtoAuthor() *CommentDtoAuthor` + +NewCommentDtoAuthor instantiates a new CommentDtoAuthor 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 + +### NewCommentDtoAuthorWithDefaults + +`func NewCommentDtoAuthorWithDefaults() *CommentDtoAuthor` + +NewCommentDtoAuthorWithDefaults instantiates a new CommentDtoAuthor 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 + +### GetType + +`func (o *CommentDtoAuthor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CommentDtoAuthor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CommentDtoAuthor) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CommentDtoAuthor) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CommentDtoAuthor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CommentDtoAuthor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CommentDtoAuthor) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CommentDtoAuthor) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CommentDtoAuthor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CommentDtoAuthor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CommentDtoAuthor) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CommentDtoAuthor) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessIDStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessIDStatus.md new file mode 100644 index 000000000..a5931766a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessIDStatus.md @@ -0,0 +1,90 @@ +--- +id: v2025-common-access-id-status +title: CommonAccessIDStatus +pagination_label: CommonAccessIDStatus +sidebar_label: CommonAccessIDStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessIDStatus', 'V2025CommonAccessIDStatus'] +slug: /tools/sdk/go/v2025/models/common-access-id-status +tags: ['SDK', 'Software Development Kit', 'CommonAccessIDStatus', 'V2025CommonAccessIDStatus'] +--- + +# CommonAccessIDStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConfirmedIds** | Pointer to **[]string** | List of confirmed common access ids. | [optional] +**DeniedIds** | Pointer to **[]string** | List of denied common access ids. | [optional] + +## Methods + +### NewCommonAccessIDStatus + +`func NewCommonAccessIDStatus() *CommonAccessIDStatus` + +NewCommonAccessIDStatus instantiates a new CommonAccessIDStatus 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 + +### NewCommonAccessIDStatusWithDefaults + +`func NewCommonAccessIDStatusWithDefaults() *CommonAccessIDStatus` + +NewCommonAccessIDStatusWithDefaults instantiates a new CommonAccessIDStatus 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 + +### GetConfirmedIds + +`func (o *CommonAccessIDStatus) GetConfirmedIds() []string` + +GetConfirmedIds returns the ConfirmedIds field if non-nil, zero value otherwise. + +### GetConfirmedIdsOk + +`func (o *CommonAccessIDStatus) GetConfirmedIdsOk() (*[]string, bool)` + +GetConfirmedIdsOk returns a tuple with the ConfirmedIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfirmedIds + +`func (o *CommonAccessIDStatus) SetConfirmedIds(v []string)` + +SetConfirmedIds sets ConfirmedIds field to given value. + +### HasConfirmedIds + +`func (o *CommonAccessIDStatus) HasConfirmedIds() bool` + +HasConfirmedIds returns a boolean if a field has been set. + +### GetDeniedIds + +`func (o *CommonAccessIDStatus) GetDeniedIds() []string` + +GetDeniedIds returns the DeniedIds field if non-nil, zero value otherwise. + +### GetDeniedIdsOk + +`func (o *CommonAccessIDStatus) GetDeniedIdsOk() (*[]string, bool)` + +GetDeniedIdsOk returns a tuple with the DeniedIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeniedIds + +`func (o *CommonAccessIDStatus) SetDeniedIds(v []string)` + +SetDeniedIds sets DeniedIds field to given value. + +### HasDeniedIds + +`func (o *CommonAccessIDStatus) HasDeniedIds() bool` + +HasDeniedIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessItemAccess.md b/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessItemAccess.md new file mode 100644 index 000000000..f067749cb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessItemAccess.md @@ -0,0 +1,204 @@ +--- +id: v2025-common-access-item-access +title: CommonAccessItemAccess +pagination_label: CommonAccessItemAccess +sidebar_label: CommonAccessItemAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessItemAccess', 'V2025CommonAccessItemAccess'] +slug: /tools/sdk/go/v2025/models/common-access-item-access +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemAccess', 'V2025CommonAccessItemAccess'] +--- + +# CommonAccessItemAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Common access ID | [optional] +**Type** | Pointer to [**CommonAccessType**](common-access-type) | | [optional] +**Name** | Pointer to **string** | Common access name | [optional] +**Description** | Pointer to **NullableString** | Common access description | [optional] +**OwnerName** | Pointer to **string** | Common access owner name | [optional] +**OwnerId** | Pointer to **string** | Common access owner ID | [optional] + +## Methods + +### NewCommonAccessItemAccess + +`func NewCommonAccessItemAccess() *CommonAccessItemAccess` + +NewCommonAccessItemAccess instantiates a new CommonAccessItemAccess 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 + +### NewCommonAccessItemAccessWithDefaults + +`func NewCommonAccessItemAccessWithDefaults() *CommonAccessItemAccess` + +NewCommonAccessItemAccessWithDefaults instantiates a new CommonAccessItemAccess 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 + +### GetId + +`func (o *CommonAccessItemAccess) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CommonAccessItemAccess) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CommonAccessItemAccess) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CommonAccessItemAccess) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CommonAccessItemAccess) GetType() CommonAccessType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CommonAccessItemAccess) GetTypeOk() (*CommonAccessType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CommonAccessItemAccess) SetType(v CommonAccessType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CommonAccessItemAccess) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *CommonAccessItemAccess) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CommonAccessItemAccess) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CommonAccessItemAccess) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CommonAccessItemAccess) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *CommonAccessItemAccess) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CommonAccessItemAccess) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CommonAccessItemAccess) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CommonAccessItemAccess) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *CommonAccessItemAccess) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CommonAccessItemAccess) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwnerName + +`func (o *CommonAccessItemAccess) GetOwnerName() string` + +GetOwnerName returns the OwnerName field if non-nil, zero value otherwise. + +### GetOwnerNameOk + +`func (o *CommonAccessItemAccess) GetOwnerNameOk() (*string, bool)` + +GetOwnerNameOk returns a tuple with the OwnerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerName + +`func (o *CommonAccessItemAccess) SetOwnerName(v string)` + +SetOwnerName sets OwnerName field to given value. + +### HasOwnerName + +`func (o *CommonAccessItemAccess) HasOwnerName() bool` + +HasOwnerName returns a boolean if a field has been set. + +### GetOwnerId + +`func (o *CommonAccessItemAccess) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *CommonAccessItemAccess) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *CommonAccessItemAccess) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *CommonAccessItemAccess) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessItemRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessItemRequest.md new file mode 100644 index 000000000..bfbd43e1b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessItemRequest.md @@ -0,0 +1,90 @@ +--- +id: v2025-common-access-item-request +title: CommonAccessItemRequest +pagination_label: CommonAccessItemRequest +sidebar_label: CommonAccessItemRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessItemRequest', 'V2025CommonAccessItemRequest'] +slug: /tools/sdk/go/v2025/models/common-access-item-request +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemRequest', 'V2025CommonAccessItemRequest'] +--- + +# CommonAccessItemRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**Status** | Pointer to [**CommonAccessItemState**](common-access-item-state) | | [optional] + +## Methods + +### NewCommonAccessItemRequest + +`func NewCommonAccessItemRequest() *CommonAccessItemRequest` + +NewCommonAccessItemRequest instantiates a new CommonAccessItemRequest 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 + +### NewCommonAccessItemRequestWithDefaults + +`func NewCommonAccessItemRequestWithDefaults() *CommonAccessItemRequest` + +NewCommonAccessItemRequestWithDefaults instantiates a new CommonAccessItemRequest 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 + +### GetAccess + +`func (o *CommonAccessItemRequest) GetAccess() CommonAccessItemAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *CommonAccessItemRequest) GetAccessOk() (*CommonAccessItemAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *CommonAccessItemRequest) SetAccess(v CommonAccessItemAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *CommonAccessItemRequest) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetStatus + +`func (o *CommonAccessItemRequest) GetStatus() CommonAccessItemState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CommonAccessItemRequest) GetStatusOk() (*CommonAccessItemState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CommonAccessItemRequest) SetStatus(v CommonAccessItemState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CommonAccessItemRequest) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessItemResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessItemResponse.md new file mode 100644 index 000000000..2e853ebde --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessItemResponse.md @@ -0,0 +1,220 @@ +--- +id: v2025-common-access-item-response +title: CommonAccessItemResponse +pagination_label: CommonAccessItemResponse +sidebar_label: CommonAccessItemResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessItemResponse', 'V2025CommonAccessItemResponse'] +slug: /tools/sdk/go/v2025/models/common-access-item-response +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemResponse', 'V2025CommonAccessItemResponse'] +--- + +# CommonAccessItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Common Access Item ID | [optional] +**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**Status** | Pointer to [**CommonAccessItemState**](common-access-item-state) | | [optional] +**LastUpdated** | Pointer to **string** | | [optional] +**ReviewedByUser** | Pointer to **bool** | | [optional] +**LastReviewed** | Pointer to **string** | | [optional] +**CreatedByUser** | Pointer to **string** | | [optional] + +## Methods + +### NewCommonAccessItemResponse + +`func NewCommonAccessItemResponse() *CommonAccessItemResponse` + +NewCommonAccessItemResponse instantiates a new CommonAccessItemResponse 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 + +### NewCommonAccessItemResponseWithDefaults + +`func NewCommonAccessItemResponseWithDefaults() *CommonAccessItemResponse` + +NewCommonAccessItemResponseWithDefaults instantiates a new CommonAccessItemResponse 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 + +### GetId + +`func (o *CommonAccessItemResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CommonAccessItemResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CommonAccessItemResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CommonAccessItemResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccess + +`func (o *CommonAccessItemResponse) GetAccess() CommonAccessItemAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *CommonAccessItemResponse) GetAccessOk() (*CommonAccessItemAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *CommonAccessItemResponse) SetAccess(v CommonAccessItemAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *CommonAccessItemResponse) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetStatus + +`func (o *CommonAccessItemResponse) GetStatus() CommonAccessItemState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CommonAccessItemResponse) GetStatusOk() (*CommonAccessItemState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CommonAccessItemResponse) SetStatus(v CommonAccessItemState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CommonAccessItemResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetLastUpdated + +`func (o *CommonAccessItemResponse) GetLastUpdated() string` + +GetLastUpdated returns the LastUpdated field if non-nil, zero value otherwise. + +### GetLastUpdatedOk + +`func (o *CommonAccessItemResponse) GetLastUpdatedOk() (*string, bool)` + +GetLastUpdatedOk returns a tuple with the LastUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdated + +`func (o *CommonAccessItemResponse) SetLastUpdated(v string)` + +SetLastUpdated sets LastUpdated field to given value. + +### HasLastUpdated + +`func (o *CommonAccessItemResponse) HasLastUpdated() bool` + +HasLastUpdated returns a boolean if a field has been set. + +### GetReviewedByUser + +`func (o *CommonAccessItemResponse) GetReviewedByUser() bool` + +GetReviewedByUser returns the ReviewedByUser field if non-nil, zero value otherwise. + +### GetReviewedByUserOk + +`func (o *CommonAccessItemResponse) GetReviewedByUserOk() (*bool, bool)` + +GetReviewedByUserOk returns a tuple with the ReviewedByUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewedByUser + +`func (o *CommonAccessItemResponse) SetReviewedByUser(v bool)` + +SetReviewedByUser sets ReviewedByUser field to given value. + +### HasReviewedByUser + +`func (o *CommonAccessItemResponse) HasReviewedByUser() bool` + +HasReviewedByUser returns a boolean if a field has been set. + +### GetLastReviewed + +`func (o *CommonAccessItemResponse) GetLastReviewed() string` + +GetLastReviewed returns the LastReviewed field if non-nil, zero value otherwise. + +### GetLastReviewedOk + +`func (o *CommonAccessItemResponse) GetLastReviewedOk() (*string, bool)` + +GetLastReviewedOk returns a tuple with the LastReviewed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastReviewed + +`func (o *CommonAccessItemResponse) SetLastReviewed(v string)` + +SetLastReviewed sets LastReviewed field to given value. + +### HasLastReviewed + +`func (o *CommonAccessItemResponse) HasLastReviewed() bool` + +HasLastReviewed returns a boolean if a field has been set. + +### GetCreatedByUser + +`func (o *CommonAccessItemResponse) GetCreatedByUser() string` + +GetCreatedByUser returns the CreatedByUser field if non-nil, zero value otherwise. + +### GetCreatedByUserOk + +`func (o *CommonAccessItemResponse) GetCreatedByUserOk() (*string, bool)` + +GetCreatedByUserOk returns a tuple with the CreatedByUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedByUser + +`func (o *CommonAccessItemResponse) SetCreatedByUser(v string)` + +SetCreatedByUser sets CreatedByUser field to given value. + +### HasCreatedByUser + +`func (o *CommonAccessItemResponse) HasCreatedByUser() bool` + +HasCreatedByUser returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessItemState.md b/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessItemState.md new file mode 100644 index 000000000..8cb5277f1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessItemState.md @@ -0,0 +1,21 @@ +--- +id: v2025-common-access-item-state +title: CommonAccessItemState +pagination_label: CommonAccessItemState +sidebar_label: CommonAccessItemState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessItemState', 'V2025CommonAccessItemState'] +slug: /tools/sdk/go/v2025/models/common-access-item-state +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemState', 'V2025CommonAccessItemState'] +--- + +# CommonAccessItemState + +## Enum + + +* `CONFIRMED` (value: `"CONFIRMED"`) + +* `DENIED` (value: `"DENIED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessResponse.md new file mode 100644 index 000000000..2e81eee37 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessResponse.md @@ -0,0 +1,256 @@ +--- +id: v2025-common-access-response +title: CommonAccessResponse +pagination_label: CommonAccessResponse +sidebar_label: CommonAccessResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessResponse', 'V2025CommonAccessResponse'] +slug: /tools/sdk/go/v2025/models/common-access-response +tags: ['SDK', 'Software Development Kit', 'CommonAccessResponse', 'V2025CommonAccessResponse'] +--- + +# CommonAccessResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique ID of the common access item | [optional] +**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**Status** | Pointer to **string** | CONFIRMED or DENIED | [optional] +**CommonAccessType** | Pointer to **string** | | [optional] +**LastUpdated** | Pointer to **SailPointTime** | | [optional] [readonly] +**ReviewedByUser** | Pointer to **bool** | true if user has confirmed or denied status | [optional] +**LastReviewed** | Pointer to **NullableTime** | | [optional] [readonly] +**CreatedByUser** | Pointer to **bool** | | [optional] [default to false] + +## Methods + +### NewCommonAccessResponse + +`func NewCommonAccessResponse() *CommonAccessResponse` + +NewCommonAccessResponse instantiates a new CommonAccessResponse 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 + +### NewCommonAccessResponseWithDefaults + +`func NewCommonAccessResponseWithDefaults() *CommonAccessResponse` + +NewCommonAccessResponseWithDefaults instantiates a new CommonAccessResponse 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 + +### GetId + +`func (o *CommonAccessResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CommonAccessResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CommonAccessResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CommonAccessResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccess + +`func (o *CommonAccessResponse) GetAccess() CommonAccessItemAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *CommonAccessResponse) GetAccessOk() (*CommonAccessItemAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *CommonAccessResponse) SetAccess(v CommonAccessItemAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *CommonAccessResponse) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetStatus + +`func (o *CommonAccessResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CommonAccessResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CommonAccessResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CommonAccessResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetCommonAccessType + +`func (o *CommonAccessResponse) GetCommonAccessType() string` + +GetCommonAccessType returns the CommonAccessType field if non-nil, zero value otherwise. + +### GetCommonAccessTypeOk + +`func (o *CommonAccessResponse) GetCommonAccessTypeOk() (*string, bool)` + +GetCommonAccessTypeOk returns a tuple with the CommonAccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommonAccessType + +`func (o *CommonAccessResponse) SetCommonAccessType(v string)` + +SetCommonAccessType sets CommonAccessType field to given value. + +### HasCommonAccessType + +`func (o *CommonAccessResponse) HasCommonAccessType() bool` + +HasCommonAccessType returns a boolean if a field has been set. + +### GetLastUpdated + +`func (o *CommonAccessResponse) GetLastUpdated() SailPointTime` + +GetLastUpdated returns the LastUpdated field if non-nil, zero value otherwise. + +### GetLastUpdatedOk + +`func (o *CommonAccessResponse) GetLastUpdatedOk() (*SailPointTime, bool)` + +GetLastUpdatedOk returns a tuple with the LastUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdated + +`func (o *CommonAccessResponse) SetLastUpdated(v SailPointTime)` + +SetLastUpdated sets LastUpdated field to given value. + +### HasLastUpdated + +`func (o *CommonAccessResponse) HasLastUpdated() bool` + +HasLastUpdated returns a boolean if a field has been set. + +### GetReviewedByUser + +`func (o *CommonAccessResponse) GetReviewedByUser() bool` + +GetReviewedByUser returns the ReviewedByUser field if non-nil, zero value otherwise. + +### GetReviewedByUserOk + +`func (o *CommonAccessResponse) GetReviewedByUserOk() (*bool, bool)` + +GetReviewedByUserOk returns a tuple with the ReviewedByUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewedByUser + +`func (o *CommonAccessResponse) SetReviewedByUser(v bool)` + +SetReviewedByUser sets ReviewedByUser field to given value. + +### HasReviewedByUser + +`func (o *CommonAccessResponse) HasReviewedByUser() bool` + +HasReviewedByUser returns a boolean if a field has been set. + +### GetLastReviewed + +`func (o *CommonAccessResponse) GetLastReviewed() SailPointTime` + +GetLastReviewed returns the LastReviewed field if non-nil, zero value otherwise. + +### GetLastReviewedOk + +`func (o *CommonAccessResponse) GetLastReviewedOk() (*SailPointTime, bool)` + +GetLastReviewedOk returns a tuple with the LastReviewed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastReviewed + +`func (o *CommonAccessResponse) SetLastReviewed(v SailPointTime)` + +SetLastReviewed sets LastReviewed field to given value. + +### HasLastReviewed + +`func (o *CommonAccessResponse) HasLastReviewed() bool` + +HasLastReviewed returns a boolean if a field has been set. + +### SetLastReviewedNil + +`func (o *CommonAccessResponse) SetLastReviewedNil(b bool)` + + SetLastReviewedNil sets the value for LastReviewed to be an explicit nil + +### UnsetLastReviewed +`func (o *CommonAccessResponse) UnsetLastReviewed()` + +UnsetLastReviewed ensures that no value is present for LastReviewed, not even an explicit nil +### GetCreatedByUser + +`func (o *CommonAccessResponse) GetCreatedByUser() bool` + +GetCreatedByUser returns the CreatedByUser field if non-nil, zero value otherwise. + +### GetCreatedByUserOk + +`func (o *CommonAccessResponse) GetCreatedByUserOk() (*bool, bool)` + +GetCreatedByUserOk returns a tuple with the CreatedByUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedByUser + +`func (o *CommonAccessResponse) SetCreatedByUser(v bool)` + +SetCreatedByUser sets CreatedByUser field to given value. + +### HasCreatedByUser + +`func (o *CommonAccessResponse) HasCreatedByUser() bool` + +HasCreatedByUser returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessType.md b/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessType.md new file mode 100644 index 000000000..6f86146b7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CommonAccessType.md @@ -0,0 +1,21 @@ +--- +id: v2025-common-access-type +title: CommonAccessType +pagination_label: CommonAccessType +sidebar_label: CommonAccessType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommonAccessType', 'V2025CommonAccessType'] +slug: /tools/sdk/go/v2025/models/common-access-type +tags: ['SDK', 'Software Development Kit', 'CommonAccessType', 'V2025CommonAccessType'] +--- + +# CommonAccessType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CompleteInvocation.md b/docs/tools/sdk/go/Reference/V2025/Models/CompleteInvocation.md new file mode 100644 index 000000000..e5960032a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CompleteInvocation.md @@ -0,0 +1,106 @@ +--- +id: v2025-complete-invocation +title: CompleteInvocation +pagination_label: CompleteInvocation +sidebar_label: CompleteInvocation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompleteInvocation', 'V2025CompleteInvocation'] +slug: /tools/sdk/go/v2025/models/complete-invocation +tags: ['SDK', 'Software Development Kit', 'CompleteInvocation', 'V2025CompleteInvocation'] +--- + +# CompleteInvocation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Secret** | **string** | Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint. | +**Error** | Pointer to **string** | The error message to indicate a failed invocation or error if any. | [optional] +**Output** | **map[string]interface{}** | Trigger output to complete the invocation. Its schema is defined in the trigger definition. | + +## Methods + +### NewCompleteInvocation + +`func NewCompleteInvocation(secret string, output map[string]interface{}, ) *CompleteInvocation` + +NewCompleteInvocation instantiates a new CompleteInvocation 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 + +### NewCompleteInvocationWithDefaults + +`func NewCompleteInvocationWithDefaults() *CompleteInvocation` + +NewCompleteInvocationWithDefaults instantiates a new CompleteInvocation 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 + +### GetSecret + +`func (o *CompleteInvocation) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *CompleteInvocation) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *CompleteInvocation) SetSecret(v string)` + +SetSecret sets Secret field to given value. + + +### GetError + +`func (o *CompleteInvocation) GetError() string` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *CompleteInvocation) GetErrorOk() (*string, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *CompleteInvocation) SetError(v string)` + +SetError sets Error field to given value. + +### HasError + +`func (o *CompleteInvocation) HasError() bool` + +HasError returns a boolean if a field has been set. + +### GetOutput + +`func (o *CompleteInvocation) GetOutput() map[string]interface{}` + +GetOutput returns the Output field if non-nil, zero value otherwise. + +### GetOutputOk + +`func (o *CompleteInvocation) GetOutputOk() (*map[string]interface{}, bool)` + +GetOutputOk returns a tuple with the Output field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutput + +`func (o *CompleteInvocation) SetOutput(v map[string]interface{})` + +SetOutput sets Output field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CompleteInvocationInput.md b/docs/tools/sdk/go/Reference/V2025/Models/CompleteInvocationInput.md new file mode 100644 index 000000000..6229fd894 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CompleteInvocationInput.md @@ -0,0 +1,110 @@ +--- +id: v2025-complete-invocation-input +title: CompleteInvocationInput +pagination_label: CompleteInvocationInput +sidebar_label: CompleteInvocationInput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompleteInvocationInput', 'V2025CompleteInvocationInput'] +slug: /tools/sdk/go/v2025/models/complete-invocation-input +tags: ['SDK', 'Software Development Kit', 'CompleteInvocationInput', 'V2025CompleteInvocationInput'] +--- + +# CompleteInvocationInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LocalizedError** | Pointer to [**NullableLocalizedMessage**](localized-message) | | [optional] +**Output** | Pointer to **map[string]interface{}** | Trigger output that completed the invocation. Its schema is defined in the trigger definition. | [optional] + +## Methods + +### NewCompleteInvocationInput + +`func NewCompleteInvocationInput() *CompleteInvocationInput` + +NewCompleteInvocationInput instantiates a new CompleteInvocationInput 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 + +### NewCompleteInvocationInputWithDefaults + +`func NewCompleteInvocationInputWithDefaults() *CompleteInvocationInput` + +NewCompleteInvocationInputWithDefaults instantiates a new CompleteInvocationInput 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 + +### GetLocalizedError + +`func (o *CompleteInvocationInput) GetLocalizedError() LocalizedMessage` + +GetLocalizedError returns the LocalizedError field if non-nil, zero value otherwise. + +### GetLocalizedErrorOk + +`func (o *CompleteInvocationInput) GetLocalizedErrorOk() (*LocalizedMessage, bool)` + +GetLocalizedErrorOk returns a tuple with the LocalizedError field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizedError + +`func (o *CompleteInvocationInput) SetLocalizedError(v LocalizedMessage)` + +SetLocalizedError sets LocalizedError field to given value. + +### HasLocalizedError + +`func (o *CompleteInvocationInput) HasLocalizedError() bool` + +HasLocalizedError returns a boolean if a field has been set. + +### SetLocalizedErrorNil + +`func (o *CompleteInvocationInput) SetLocalizedErrorNil(b bool)` + + SetLocalizedErrorNil sets the value for LocalizedError to be an explicit nil + +### UnsetLocalizedError +`func (o *CompleteInvocationInput) UnsetLocalizedError()` + +UnsetLocalizedError ensures that no value is present for LocalizedError, not even an explicit nil +### GetOutput + +`func (o *CompleteInvocationInput) GetOutput() map[string]interface{}` + +GetOutput returns the Output field if non-nil, zero value otherwise. + +### GetOutputOk + +`func (o *CompleteInvocationInput) GetOutputOk() (*map[string]interface{}, bool)` + +GetOutputOk returns a tuple with the Output field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutput + +`func (o *CompleteInvocationInput) SetOutput(v map[string]interface{})` + +SetOutput sets Output field to given value. + +### HasOutput + +`func (o *CompleteInvocationInput) HasOutput() bool` + +HasOutput returns a boolean if a field has been set. + +### SetOutputNil + +`func (o *CompleteInvocationInput) SetOutputNil(b bool)` + + SetOutputNil sets the value for Output to be an explicit nil + +### UnsetOutput +`func (o *CompleteInvocationInput) UnsetOutput()` + +UnsetOutput ensures that no value is present for Output, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CompletedApproval.md b/docs/tools/sdk/go/Reference/V2025/Models/CompletedApproval.md new file mode 100644 index 000000000..8d154bb73 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CompletedApproval.md @@ -0,0 +1,722 @@ +--- +id: v2025-completed-approval +title: CompletedApproval +pagination_label: CompletedApproval +sidebar_label: CompletedApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApproval', 'V2025CompletedApproval'] +slug: /tools/sdk/go/v2025/models/completed-approval +tags: ['SDK', 'Software Development Kit', 'CompletedApproval', 'V2025CompletedApproval'] +--- + +# CompletedApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The approval id. | [optional] +**Name** | Pointer to **string** | The name of the approval. | [optional] +**Created** | Pointer to **SailPointTime** | When the approval was created. | [optional] +**Modified** | Pointer to **SailPointTime** | When the approval was modified last time. | [optional] +**RequestCreated** | Pointer to **SailPointTime** | When the access-request was created. | [optional] +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**ReviewedBy** | Pointer to [**AccessItemReviewedBy**](access-item-reviewed-by) | | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**RequesterComment** | Pointer to [**CompletedApprovalRequesterComment**](completed-approval-requester-comment) | | [optional] +**ReviewerComment** | Pointer to [**CompletedApprovalReviewerComment**](completed-approval-reviewer-comment) | | [optional] +**PreviousReviewersComments** | Pointer to [**[]CommentDto**](comment-dto) | The history of the previous reviewers comments. | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**CommentRequiredWhenRejected** | Pointer to **bool** | When true the rejector has to provide comments when rejecting | [optional] [default to false] +**State** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] +**RemoveDate** | Pointer to **NullableTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**RemoveDateUpdateRequested** | Pointer to **bool** | If true, then the request was to change the remove date or sunset date. | [optional] [default to false] +**CurrentRemoveDate** | Pointer to **NullableTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**SodViolationContext** | Pointer to [**NullableSodViolationContextCheckCompleted**](sod-violation-context-check-completed) | | [optional] +**PreApprovalTriggerResult** | Pointer to [**NullableCompletedApprovalPreApprovalTriggerResult**](completed-approval-pre-approval-trigger-result) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs provided during the request. | [optional] +**RequestedAccounts** | Pointer to [**[]RequestedAccountRef**](requested-account-ref) | The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. | [optional] + +## Methods + +### NewCompletedApproval + +`func NewCompletedApproval() *CompletedApproval` + +NewCompletedApproval instantiates a new CompletedApproval 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 + +### NewCompletedApprovalWithDefaults + +`func NewCompletedApprovalWithDefaults() *CompletedApproval` + +NewCompletedApprovalWithDefaults instantiates a new CompletedApproval 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 + +### GetId + +`func (o *CompletedApproval) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CompletedApproval) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CompletedApproval) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CompletedApproval) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CompletedApproval) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CompletedApproval) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CompletedApproval) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CompletedApproval) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *CompletedApproval) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CompletedApproval) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CompletedApproval) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CompletedApproval) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *CompletedApproval) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CompletedApproval) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CompletedApproval) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CompletedApproval) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetRequestCreated + +`func (o *CompletedApproval) GetRequestCreated() SailPointTime` + +GetRequestCreated returns the RequestCreated field if non-nil, zero value otherwise. + +### GetRequestCreatedOk + +`func (o *CompletedApproval) GetRequestCreatedOk() (*SailPointTime, bool)` + +GetRequestCreatedOk returns a tuple with the RequestCreated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCreated + +`func (o *CompletedApproval) SetRequestCreated(v SailPointTime)` + +SetRequestCreated sets RequestCreated field to given value. + +### HasRequestCreated + +`func (o *CompletedApproval) HasRequestCreated() bool` + +HasRequestCreated returns a boolean if a field has been set. + +### GetRequestType + +`func (o *CompletedApproval) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *CompletedApproval) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *CompletedApproval) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *CompletedApproval) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *CompletedApproval) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *CompletedApproval) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetRequester + +`func (o *CompletedApproval) GetRequester() AccessItemRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *CompletedApproval) GetRequesterOk() (*AccessItemRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *CompletedApproval) SetRequester(v AccessItemRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *CompletedApproval) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRequestedFor + +`func (o *CompletedApproval) GetRequestedFor() RequestedItemStatusRequestedFor` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *CompletedApproval) GetRequestedForOk() (*RequestedItemStatusRequestedFor, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *CompletedApproval) SetRequestedFor(v RequestedItemStatusRequestedFor)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *CompletedApproval) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetReviewedBy + +`func (o *CompletedApproval) GetReviewedBy() AccessItemReviewedBy` + +GetReviewedBy returns the ReviewedBy field if non-nil, zero value otherwise. + +### GetReviewedByOk + +`func (o *CompletedApproval) GetReviewedByOk() (*AccessItemReviewedBy, bool)` + +GetReviewedByOk returns a tuple with the ReviewedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewedBy + +`func (o *CompletedApproval) SetReviewedBy(v AccessItemReviewedBy)` + +SetReviewedBy sets ReviewedBy field to given value. + +### HasReviewedBy + +`func (o *CompletedApproval) HasReviewedBy() bool` + +HasReviewedBy returns a boolean if a field has been set. + +### GetOwner + +`func (o *CompletedApproval) GetOwner() OwnerDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CompletedApproval) GetOwnerOk() (*OwnerDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CompletedApproval) SetOwner(v OwnerDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *CompletedApproval) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRequestedObject + +`func (o *CompletedApproval) GetRequestedObject() RequestableObjectReference` + +GetRequestedObject returns the RequestedObject field if non-nil, zero value otherwise. + +### GetRequestedObjectOk + +`func (o *CompletedApproval) GetRequestedObjectOk() (*RequestableObjectReference, bool)` + +GetRequestedObjectOk returns a tuple with the RequestedObject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObject + +`func (o *CompletedApproval) SetRequestedObject(v RequestableObjectReference)` + +SetRequestedObject sets RequestedObject field to given value. + +### HasRequestedObject + +`func (o *CompletedApproval) HasRequestedObject() bool` + +HasRequestedObject returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *CompletedApproval) GetRequesterComment() CompletedApprovalRequesterComment` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *CompletedApproval) GetRequesterCommentOk() (*CompletedApprovalRequesterComment, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *CompletedApproval) SetRequesterComment(v CompletedApprovalRequesterComment)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *CompletedApproval) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### GetReviewerComment + +`func (o *CompletedApproval) GetReviewerComment() CompletedApprovalReviewerComment` + +GetReviewerComment returns the ReviewerComment field if non-nil, zero value otherwise. + +### GetReviewerCommentOk + +`func (o *CompletedApproval) GetReviewerCommentOk() (*CompletedApprovalReviewerComment, bool)` + +GetReviewerCommentOk returns a tuple with the ReviewerComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerComment + +`func (o *CompletedApproval) SetReviewerComment(v CompletedApprovalReviewerComment)` + +SetReviewerComment sets ReviewerComment field to given value. + +### HasReviewerComment + +`func (o *CompletedApproval) HasReviewerComment() bool` + +HasReviewerComment returns a boolean if a field has been set. + +### GetPreviousReviewersComments + +`func (o *CompletedApproval) GetPreviousReviewersComments() []CommentDto` + +GetPreviousReviewersComments returns the PreviousReviewersComments field if non-nil, zero value otherwise. + +### GetPreviousReviewersCommentsOk + +`func (o *CompletedApproval) GetPreviousReviewersCommentsOk() (*[]CommentDto, bool)` + +GetPreviousReviewersCommentsOk returns a tuple with the PreviousReviewersComments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousReviewersComments + +`func (o *CompletedApproval) SetPreviousReviewersComments(v []CommentDto)` + +SetPreviousReviewersComments sets PreviousReviewersComments field to given value. + +### HasPreviousReviewersComments + +`func (o *CompletedApproval) HasPreviousReviewersComments() bool` + +HasPreviousReviewersComments returns a boolean if a field has been set. + +### GetForwardHistory + +`func (o *CompletedApproval) GetForwardHistory() []ApprovalForwardHistory` + +GetForwardHistory returns the ForwardHistory field if non-nil, zero value otherwise. + +### GetForwardHistoryOk + +`func (o *CompletedApproval) GetForwardHistoryOk() (*[]ApprovalForwardHistory, bool)` + +GetForwardHistoryOk returns a tuple with the ForwardHistory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwardHistory + +`func (o *CompletedApproval) SetForwardHistory(v []ApprovalForwardHistory)` + +SetForwardHistory sets ForwardHistory field to given value. + +### HasForwardHistory + +`func (o *CompletedApproval) HasForwardHistory() bool` + +HasForwardHistory returns a boolean if a field has been set. + +### GetCommentRequiredWhenRejected + +`func (o *CompletedApproval) GetCommentRequiredWhenRejected() bool` + +GetCommentRequiredWhenRejected returns the CommentRequiredWhenRejected field if non-nil, zero value otherwise. + +### GetCommentRequiredWhenRejectedOk + +`func (o *CompletedApproval) GetCommentRequiredWhenRejectedOk() (*bool, bool)` + +GetCommentRequiredWhenRejectedOk returns a tuple with the CommentRequiredWhenRejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentRequiredWhenRejected + +`func (o *CompletedApproval) SetCommentRequiredWhenRejected(v bool)` + +SetCommentRequiredWhenRejected sets CommentRequiredWhenRejected field to given value. + +### HasCommentRequiredWhenRejected + +`func (o *CompletedApproval) HasCommentRequiredWhenRejected() bool` + +HasCommentRequiredWhenRejected returns a boolean if a field has been set. + +### GetState + +`func (o *CompletedApproval) GetState() CompletedApprovalState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *CompletedApproval) GetStateOk() (*CompletedApprovalState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *CompletedApproval) SetState(v CompletedApprovalState)` + +SetState sets State field to given value. + +### HasState + +`func (o *CompletedApproval) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *CompletedApproval) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *CompletedApproval) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *CompletedApproval) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *CompletedApproval) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *CompletedApproval) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *CompletedApproval) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil +### GetRemoveDateUpdateRequested + +`func (o *CompletedApproval) GetRemoveDateUpdateRequested() bool` + +GetRemoveDateUpdateRequested returns the RemoveDateUpdateRequested field if non-nil, zero value otherwise. + +### GetRemoveDateUpdateRequestedOk + +`func (o *CompletedApproval) GetRemoveDateUpdateRequestedOk() (*bool, bool)` + +GetRemoveDateUpdateRequestedOk returns a tuple with the RemoveDateUpdateRequested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDateUpdateRequested + +`func (o *CompletedApproval) SetRemoveDateUpdateRequested(v bool)` + +SetRemoveDateUpdateRequested sets RemoveDateUpdateRequested field to given value. + +### HasRemoveDateUpdateRequested + +`func (o *CompletedApproval) HasRemoveDateUpdateRequested() bool` + +HasRemoveDateUpdateRequested returns a boolean if a field has been set. + +### GetCurrentRemoveDate + +`func (o *CompletedApproval) GetCurrentRemoveDate() SailPointTime` + +GetCurrentRemoveDate returns the CurrentRemoveDate field if non-nil, zero value otherwise. + +### GetCurrentRemoveDateOk + +`func (o *CompletedApproval) GetCurrentRemoveDateOk() (*SailPointTime, bool)` + +GetCurrentRemoveDateOk returns a tuple with the CurrentRemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentRemoveDate + +`func (o *CompletedApproval) SetCurrentRemoveDate(v SailPointTime)` + +SetCurrentRemoveDate sets CurrentRemoveDate field to given value. + +### HasCurrentRemoveDate + +`func (o *CompletedApproval) HasCurrentRemoveDate() bool` + +HasCurrentRemoveDate returns a boolean if a field has been set. + +### SetCurrentRemoveDateNil + +`func (o *CompletedApproval) SetCurrentRemoveDateNil(b bool)` + + SetCurrentRemoveDateNil sets the value for CurrentRemoveDate to be an explicit nil + +### UnsetCurrentRemoveDate +`func (o *CompletedApproval) UnsetCurrentRemoveDate()` + +UnsetCurrentRemoveDate ensures that no value is present for CurrentRemoveDate, not even an explicit nil +### GetSodViolationContext + +`func (o *CompletedApproval) GetSodViolationContext() SodViolationContextCheckCompleted` + +GetSodViolationContext returns the SodViolationContext field if non-nil, zero value otherwise. + +### GetSodViolationContextOk + +`func (o *CompletedApproval) GetSodViolationContextOk() (*SodViolationContextCheckCompleted, bool)` + +GetSodViolationContextOk returns a tuple with the SodViolationContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodViolationContext + +`func (o *CompletedApproval) SetSodViolationContext(v SodViolationContextCheckCompleted)` + +SetSodViolationContext sets SodViolationContext field to given value. + +### HasSodViolationContext + +`func (o *CompletedApproval) HasSodViolationContext() bool` + +HasSodViolationContext returns a boolean if a field has been set. + +### SetSodViolationContextNil + +`func (o *CompletedApproval) SetSodViolationContextNil(b bool)` + + SetSodViolationContextNil sets the value for SodViolationContext to be an explicit nil + +### UnsetSodViolationContext +`func (o *CompletedApproval) UnsetSodViolationContext()` + +UnsetSodViolationContext ensures that no value is present for SodViolationContext, not even an explicit nil +### GetPreApprovalTriggerResult + +`func (o *CompletedApproval) GetPreApprovalTriggerResult() CompletedApprovalPreApprovalTriggerResult` + +GetPreApprovalTriggerResult returns the PreApprovalTriggerResult field if non-nil, zero value otherwise. + +### GetPreApprovalTriggerResultOk + +`func (o *CompletedApproval) GetPreApprovalTriggerResultOk() (*CompletedApprovalPreApprovalTriggerResult, bool)` + +GetPreApprovalTriggerResultOk returns a tuple with the PreApprovalTriggerResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreApprovalTriggerResult + +`func (o *CompletedApproval) SetPreApprovalTriggerResult(v CompletedApprovalPreApprovalTriggerResult)` + +SetPreApprovalTriggerResult sets PreApprovalTriggerResult field to given value. + +### HasPreApprovalTriggerResult + +`func (o *CompletedApproval) HasPreApprovalTriggerResult() bool` + +HasPreApprovalTriggerResult returns a boolean if a field has been set. + +### SetPreApprovalTriggerResultNil + +`func (o *CompletedApproval) SetPreApprovalTriggerResultNil(b bool)` + + SetPreApprovalTriggerResultNil sets the value for PreApprovalTriggerResult to be an explicit nil + +### UnsetPreApprovalTriggerResult +`func (o *CompletedApproval) UnsetPreApprovalTriggerResult()` + +UnsetPreApprovalTriggerResult ensures that no value is present for PreApprovalTriggerResult, not even an explicit nil +### GetClientMetadata + +`func (o *CompletedApproval) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *CompletedApproval) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *CompletedApproval) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *CompletedApproval) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRequestedAccounts + +`func (o *CompletedApproval) GetRequestedAccounts() []RequestedAccountRef` + +GetRequestedAccounts returns the RequestedAccounts field if non-nil, zero value otherwise. + +### GetRequestedAccountsOk + +`func (o *CompletedApproval) GetRequestedAccountsOk() (*[]RequestedAccountRef, bool)` + +GetRequestedAccountsOk returns a tuple with the RequestedAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedAccounts + +`func (o *CompletedApproval) SetRequestedAccounts(v []RequestedAccountRef)` + +SetRequestedAccounts sets RequestedAccounts field to given value. + +### HasRequestedAccounts + +`func (o *CompletedApproval) HasRequestedAccounts() bool` + +HasRequestedAccounts returns a boolean if a field has been set. + +### SetRequestedAccountsNil + +`func (o *CompletedApproval) SetRequestedAccountsNil(b bool)` + + SetRequestedAccountsNil sets the value for RequestedAccounts to be an explicit nil + +### UnsetRequestedAccounts +`func (o *CompletedApproval) UnsetRequestedAccounts()` + +UnsetRequestedAccounts ensures that no value is present for RequestedAccounts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CompletedApprovalPreApprovalTriggerResult.md b/docs/tools/sdk/go/Reference/V2025/Models/CompletedApprovalPreApprovalTriggerResult.md new file mode 100644 index 000000000..d3f0b03f1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CompletedApprovalPreApprovalTriggerResult.md @@ -0,0 +1,142 @@ +--- +id: v2025-completed-approval-pre-approval-trigger-result +title: CompletedApprovalPreApprovalTriggerResult +pagination_label: CompletedApprovalPreApprovalTriggerResult +sidebar_label: CompletedApprovalPreApprovalTriggerResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApprovalPreApprovalTriggerResult', 'V2025CompletedApprovalPreApprovalTriggerResult'] +slug: /tools/sdk/go/v2025/models/completed-approval-pre-approval-trigger-result +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalPreApprovalTriggerResult', 'V2025CompletedApprovalPreApprovalTriggerResult'] +--- + +# CompletedApprovalPreApprovalTriggerResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | The comment from the trigger | [optional] +**Decision** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] +**Reviewer** | Pointer to **string** | The name of the approver | [optional] +**Date** | Pointer to **SailPointTime** | The date and time the trigger decided on the request | [optional] + +## Methods + +### NewCompletedApprovalPreApprovalTriggerResult + +`func NewCompletedApprovalPreApprovalTriggerResult() *CompletedApprovalPreApprovalTriggerResult` + +NewCompletedApprovalPreApprovalTriggerResult instantiates a new CompletedApprovalPreApprovalTriggerResult 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 + +### NewCompletedApprovalPreApprovalTriggerResultWithDefaults + +`func NewCompletedApprovalPreApprovalTriggerResultWithDefaults() *CompletedApprovalPreApprovalTriggerResult` + +NewCompletedApprovalPreApprovalTriggerResultWithDefaults instantiates a new CompletedApprovalPreApprovalTriggerResult 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 + +### GetComment + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CompletedApprovalPreApprovalTriggerResult) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CompletedApprovalPreApprovalTriggerResult) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetDecision + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetDecision() CompletedApprovalState` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetDecisionOk() (*CompletedApprovalState, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *CompletedApprovalPreApprovalTriggerResult) SetDecision(v CompletedApprovalState)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *CompletedApprovalPreApprovalTriggerResult) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + +### GetReviewer + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetReviewer() string` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetReviewerOk() (*string, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CompletedApprovalPreApprovalTriggerResult) SetReviewer(v string)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *CompletedApprovalPreApprovalTriggerResult) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetDate + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetDate() SailPointTime` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetDateOk() (*SailPointTime, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *CompletedApprovalPreApprovalTriggerResult) SetDate(v SailPointTime)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *CompletedApprovalPreApprovalTriggerResult) HasDate() bool` + +HasDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CompletedApprovalRequesterComment.md b/docs/tools/sdk/go/Reference/V2025/Models/CompletedApprovalRequesterComment.md new file mode 100644 index 000000000..c9e94fcef --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CompletedApprovalRequesterComment.md @@ -0,0 +1,126 @@ +--- +id: v2025-completed-approval-requester-comment +title: CompletedApprovalRequesterComment +pagination_label: CompletedApprovalRequesterComment +sidebar_label: CompletedApprovalRequesterComment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApprovalRequesterComment', 'V2025CompletedApprovalRequesterComment'] +slug: /tools/sdk/go/v2025/models/completed-approval-requester-comment +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalRequesterComment', 'V2025CompletedApprovalRequesterComment'] +--- + +# CompletedApprovalRequesterComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **NullableString** | Comment content. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Methods + +### NewCompletedApprovalRequesterComment + +`func NewCompletedApprovalRequesterComment() *CompletedApprovalRequesterComment` + +NewCompletedApprovalRequesterComment instantiates a new CompletedApprovalRequesterComment 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 + +### NewCompletedApprovalRequesterCommentWithDefaults + +`func NewCompletedApprovalRequesterCommentWithDefaults() *CompletedApprovalRequesterComment` + +NewCompletedApprovalRequesterCommentWithDefaults instantiates a new CompletedApprovalRequesterComment 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 + +### GetComment + +`func (o *CompletedApprovalRequesterComment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CompletedApprovalRequesterComment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CompletedApprovalRequesterComment) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CompletedApprovalRequesterComment) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *CompletedApprovalRequesterComment) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *CompletedApprovalRequesterComment) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetCreated + +`func (o *CompletedApprovalRequesterComment) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CompletedApprovalRequesterComment) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CompletedApprovalRequesterComment) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CompletedApprovalRequesterComment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetAuthor + +`func (o *CompletedApprovalRequesterComment) GetAuthor() CommentDtoAuthor` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *CompletedApprovalRequesterComment) GetAuthorOk() (*CommentDtoAuthor, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *CompletedApprovalRequesterComment) SetAuthor(v CommentDtoAuthor)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *CompletedApprovalRequesterComment) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CompletedApprovalReviewerComment.md b/docs/tools/sdk/go/Reference/V2025/Models/CompletedApprovalReviewerComment.md new file mode 100644 index 000000000..94ee41185 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CompletedApprovalReviewerComment.md @@ -0,0 +1,126 @@ +--- +id: v2025-completed-approval-reviewer-comment +title: CompletedApprovalReviewerComment +pagination_label: CompletedApprovalReviewerComment +sidebar_label: CompletedApprovalReviewerComment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApprovalReviewerComment', 'V2025CompletedApprovalReviewerComment'] +slug: /tools/sdk/go/v2025/models/completed-approval-reviewer-comment +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalReviewerComment', 'V2025CompletedApprovalReviewerComment'] +--- + +# CompletedApprovalReviewerComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **NullableString** | Comment content. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Methods + +### NewCompletedApprovalReviewerComment + +`func NewCompletedApprovalReviewerComment() *CompletedApprovalReviewerComment` + +NewCompletedApprovalReviewerComment instantiates a new CompletedApprovalReviewerComment 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 + +### NewCompletedApprovalReviewerCommentWithDefaults + +`func NewCompletedApprovalReviewerCommentWithDefaults() *CompletedApprovalReviewerComment` + +NewCompletedApprovalReviewerCommentWithDefaults instantiates a new CompletedApprovalReviewerComment 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 + +### GetComment + +`func (o *CompletedApprovalReviewerComment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CompletedApprovalReviewerComment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CompletedApprovalReviewerComment) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CompletedApprovalReviewerComment) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *CompletedApprovalReviewerComment) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *CompletedApprovalReviewerComment) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetCreated + +`func (o *CompletedApprovalReviewerComment) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CompletedApprovalReviewerComment) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CompletedApprovalReviewerComment) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CompletedApprovalReviewerComment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetAuthor + +`func (o *CompletedApprovalReviewerComment) GetAuthor() CommentDtoAuthor` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *CompletedApprovalReviewerComment) GetAuthorOk() (*CommentDtoAuthor, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *CompletedApprovalReviewerComment) SetAuthor(v CommentDtoAuthor)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *CompletedApprovalReviewerComment) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CompletedApprovalState.md b/docs/tools/sdk/go/Reference/V2025/Models/CompletedApprovalState.md new file mode 100644 index 000000000..9c13b16d2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CompletedApprovalState.md @@ -0,0 +1,21 @@ +--- +id: v2025-completed-approval-state +title: CompletedApprovalState +pagination_label: CompletedApprovalState +sidebar_label: CompletedApprovalState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApprovalState', 'V2025CompletedApprovalState'] +slug: /tools/sdk/go/v2025/models/completed-approval-state +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalState', 'V2025CompletedApprovalState'] +--- + +# CompletedApprovalState + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CompletionStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/CompletionStatus.md new file mode 100644 index 000000000..684350235 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CompletionStatus.md @@ -0,0 +1,25 @@ +--- +id: v2025-completion-status +title: CompletionStatus +pagination_label: CompletionStatus +sidebar_label: CompletionStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletionStatus', 'V2025CompletionStatus'] +slug: /tools/sdk/go/v2025/models/completion-status +tags: ['SDK', 'Software Development Kit', 'CompletionStatus', 'V2025CompletionStatus'] +--- + +# CompletionStatus + +## Enum + + +* `SUCCESS` (value: `"SUCCESS"`) + +* `FAILURE` (value: `"FAILURE"`) + +* `INCOMPLETE` (value: `"INCOMPLETE"`) + +* `PENDING` (value: `"PENDING"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConditionEffect.md b/docs/tools/sdk/go/Reference/V2025/Models/ConditionEffect.md new file mode 100644 index 000000000..7b80ce45a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConditionEffect.md @@ -0,0 +1,90 @@ +--- +id: v2025-condition-effect +title: ConditionEffect +pagination_label: ConditionEffect +sidebar_label: ConditionEffect +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConditionEffect', 'V2025ConditionEffect'] +slug: /tools/sdk/go/v2025/models/condition-effect +tags: ['SDK', 'Software Development Kit', 'ConditionEffect', 'V2025ConditionEffect'] +--- + +# ConditionEffect + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EffectType** | Pointer to **string** | Type of effect to perform when the conditions are evaluated for this logic block. HIDE ConditionEffectTypeHide Disables validations. SHOW ConditionEffectTypeShow Enables validations. DISABLE ConditionEffectTypeDisable Disables validations. ENABLE ConditionEffectTypeEnable Enables validations. REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. | [optional] +**Config** | Pointer to [**ConditionEffectConfig**](condition-effect-config) | | [optional] + +## Methods + +### NewConditionEffect + +`func NewConditionEffect() *ConditionEffect` + +NewConditionEffect instantiates a new ConditionEffect 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 + +### NewConditionEffectWithDefaults + +`func NewConditionEffectWithDefaults() *ConditionEffect` + +NewConditionEffectWithDefaults instantiates a new ConditionEffect 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 + +### GetEffectType + +`func (o *ConditionEffect) GetEffectType() string` + +GetEffectType returns the EffectType field if non-nil, zero value otherwise. + +### GetEffectTypeOk + +`func (o *ConditionEffect) GetEffectTypeOk() (*string, bool)` + +GetEffectTypeOk returns a tuple with the EffectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEffectType + +`func (o *ConditionEffect) SetEffectType(v string)` + +SetEffectType sets EffectType field to given value. + +### HasEffectType + +`func (o *ConditionEffect) HasEffectType() bool` + +HasEffectType returns a boolean if a field has been set. + +### GetConfig + +`func (o *ConditionEffect) GetConfig() ConditionEffectConfig` + +GetConfig returns the Config field if non-nil, zero value otherwise. + +### GetConfigOk + +`func (o *ConditionEffect) GetConfigOk() (*ConditionEffectConfig, bool)` + +GetConfigOk returns a tuple with the Config field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfig + +`func (o *ConditionEffect) SetConfig(v ConditionEffectConfig)` + +SetConfig sets Config field to given value. + +### HasConfig + +`func (o *ConditionEffect) HasConfig() bool` + +HasConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConditionEffectConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/ConditionEffectConfig.md new file mode 100644 index 000000000..9508e5ba4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConditionEffectConfig.md @@ -0,0 +1,90 @@ +--- +id: v2025-condition-effect-config +title: ConditionEffectConfig +pagination_label: ConditionEffectConfig +sidebar_label: ConditionEffectConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConditionEffectConfig', 'V2025ConditionEffectConfig'] +slug: /tools/sdk/go/v2025/models/condition-effect-config +tags: ['SDK', 'Software Development Kit', 'ConditionEffectConfig', 'V2025ConditionEffectConfig'] +--- + +# ConditionEffectConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DefaultValueLabel** | Pointer to **string** | Effect type's label. | [optional] +**Element** | Pointer to **string** | Element's identifier. | [optional] + +## Methods + +### NewConditionEffectConfig + +`func NewConditionEffectConfig() *ConditionEffectConfig` + +NewConditionEffectConfig instantiates a new ConditionEffectConfig 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 + +### NewConditionEffectConfigWithDefaults + +`func NewConditionEffectConfigWithDefaults() *ConditionEffectConfig` + +NewConditionEffectConfigWithDefaults instantiates a new ConditionEffectConfig 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 + +### GetDefaultValueLabel + +`func (o *ConditionEffectConfig) GetDefaultValueLabel() string` + +GetDefaultValueLabel returns the DefaultValueLabel field if non-nil, zero value otherwise. + +### GetDefaultValueLabelOk + +`func (o *ConditionEffectConfig) GetDefaultValueLabelOk() (*string, bool)` + +GetDefaultValueLabelOk returns a tuple with the DefaultValueLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultValueLabel + +`func (o *ConditionEffectConfig) SetDefaultValueLabel(v string)` + +SetDefaultValueLabel sets DefaultValueLabel field to given value. + +### HasDefaultValueLabel + +`func (o *ConditionEffectConfig) HasDefaultValueLabel() bool` + +HasDefaultValueLabel returns a boolean if a field has been set. + +### GetElement + +`func (o *ConditionEffectConfig) GetElement() string` + +GetElement returns the Element field if non-nil, zero value otherwise. + +### GetElementOk + +`func (o *ConditionEffectConfig) GetElementOk() (*string, bool)` + +GetElementOk returns a tuple with the Element field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElement + +`func (o *ConditionEffectConfig) SetElement(v string)` + +SetElement sets Element field to given value. + +### HasElement + +`func (o *ConditionEffectConfig) HasElement() bool` + +HasElement returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConditionRule.md b/docs/tools/sdk/go/Reference/V2025/Models/ConditionRule.md new file mode 100644 index 000000000..63eec5b2b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConditionRule.md @@ -0,0 +1,168 @@ +--- +id: v2025-condition-rule +title: ConditionRule +pagination_label: ConditionRule +sidebar_label: ConditionRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConditionRule', 'V2025ConditionRule'] +slug: /tools/sdk/go/v2025/models/condition-rule +tags: ['SDK', 'Software Development Kit', 'ConditionRule', 'V2025ConditionRule'] +--- + +# ConditionRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceType** | Pointer to **string** | Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement | [optional] +**Source** | Pointer to **string** | Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, the source is the name of a technical key of an element to retrieve its value. | [optional] +**Operator** | Pointer to **string** | ConditionRuleComparisonOperatorType value. EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith | [optional] +**ValueType** | Pointer to **string** | ConditionRuleValueType type. STRING ConditionRuleValueTypeString This value is a static string. STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. INPUT ConditionRuleValueTypeInput This value is a reference to a form input. ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean | [optional] +**Value** | Pointer to **string** | Based on the ValueType. | [optional] + +## Methods + +### NewConditionRule + +`func NewConditionRule() *ConditionRule` + +NewConditionRule instantiates a new ConditionRule 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 + +### NewConditionRuleWithDefaults + +`func NewConditionRuleWithDefaults() *ConditionRule` + +NewConditionRuleWithDefaults instantiates a new ConditionRule 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 + +### GetSourceType + +`func (o *ConditionRule) GetSourceType() string` + +GetSourceType returns the SourceType field if non-nil, zero value otherwise. + +### GetSourceTypeOk + +`func (o *ConditionRule) GetSourceTypeOk() (*string, bool)` + +GetSourceTypeOk returns a tuple with the SourceType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceType + +`func (o *ConditionRule) SetSourceType(v string)` + +SetSourceType sets SourceType field to given value. + +### HasSourceType + +`func (o *ConditionRule) HasSourceType() bool` + +HasSourceType returns a boolean if a field has been set. + +### GetSource + +`func (o *ConditionRule) GetSource() string` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *ConditionRule) GetSourceOk() (*string, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *ConditionRule) SetSource(v string)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *ConditionRule) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetOperator + +`func (o *ConditionRule) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *ConditionRule) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *ConditionRule) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *ConditionRule) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetValueType + +`func (o *ConditionRule) GetValueType() string` + +GetValueType returns the ValueType field if non-nil, zero value otherwise. + +### GetValueTypeOk + +`func (o *ConditionRule) GetValueTypeOk() (*string, bool)` + +GetValueTypeOk returns a tuple with the ValueType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValueType + +`func (o *ConditionRule) SetValueType(v string)` + +SetValueType sets ValueType field to given value. + +### HasValueType + +`func (o *ConditionRule) HasValueType() bool` + +HasValueType returns a boolean if a field has been set. + +### GetValue + +`func (o *ConditionRule) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ConditionRule) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ConditionRule) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ConditionRule) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConfigObject.md b/docs/tools/sdk/go/Reference/V2025/Models/ConfigObject.md new file mode 100644 index 000000000..c9fcd344d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConfigObject.md @@ -0,0 +1,116 @@ +--- +id: v2025-config-object +title: ConfigObject +pagination_label: ConfigObject +sidebar_label: ConfigObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigObject', 'V2025ConfigObject'] +slug: /tools/sdk/go/v2025/models/config-object +tags: ['SDK', 'Software Development Kit', 'ConfigObject', 'V2025ConfigObject'] +--- + +# ConfigObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **int32** | Current version of configuration object. | [optional] +**Self** | Pointer to [**SelfImportExportDto**](self-import-export-dto) | | [optional] +**Object** | Pointer to **map[string]interface{}** | Object details. Format dependant on the object type. | [optional] + +## Methods + +### NewConfigObject + +`func NewConfigObject() *ConfigObject` + +NewConfigObject instantiates a new ConfigObject 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 + +### NewConfigObjectWithDefaults + +`func NewConfigObjectWithDefaults() *ConfigObject` + +NewConfigObjectWithDefaults instantiates a new ConfigObject 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 + +### GetVersion + +`func (o *ConfigObject) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ConfigObject) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ConfigObject) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *ConfigObject) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### GetSelf + +`func (o *ConfigObject) GetSelf() SelfImportExportDto` + +GetSelf returns the Self field if non-nil, zero value otherwise. + +### GetSelfOk + +`func (o *ConfigObject) GetSelfOk() (*SelfImportExportDto, bool)` + +GetSelfOk returns a tuple with the Self field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelf + +`func (o *ConfigObject) SetSelf(v SelfImportExportDto)` + +SetSelf sets Self field to given value. + +### HasSelf + +`func (o *ConfigObject) HasSelf() bool` + +HasSelf returns a boolean if a field has been set. + +### GetObject + +`func (o *ConfigObject) GetObject() map[string]interface{}` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *ConfigObject) GetObjectOk() (*map[string]interface{}, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *ConfigObject) SetObject(v map[string]interface{})` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *ConfigObject) HasObject() bool` + +HasObject returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConfigType.md b/docs/tools/sdk/go/Reference/V2025/Models/ConfigType.md new file mode 100644 index 000000000..f5911ba04 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConfigType.md @@ -0,0 +1,168 @@ +--- +id: v2025-config-type +title: ConfigType +pagination_label: ConfigType +sidebar_label: ConfigType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigType', 'V2025ConfigType'] +slug: /tools/sdk/go/v2025/models/config-type +tags: ['SDK', 'Software Development Kit', 'ConfigType', 'V2025ConfigType'] +--- + +# ConfigType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Priority** | Pointer to **int32** | | [optional] +**InternalName** | Pointer to [**ConfigTypeEnumCamel**](config-type-enum-camel) | | [optional] +**InternalNameCamel** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] +**DisplayName** | Pointer to **string** | Human readable display name of the type to be shown on UI | [optional] +**Description** | Pointer to **string** | Description of the type of work to be reassigned, displayed by the UI. | [optional] + +## Methods + +### NewConfigType + +`func NewConfigType() *ConfigType` + +NewConfigType instantiates a new ConfigType 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 + +### NewConfigTypeWithDefaults + +`func NewConfigTypeWithDefaults() *ConfigType` + +NewConfigTypeWithDefaults instantiates a new ConfigType 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 + +### GetPriority + +`func (o *ConfigType) GetPriority() int32` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *ConfigType) 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 *ConfigType) SetPriority(v int32)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *ConfigType) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetInternalName + +`func (o *ConfigType) GetInternalName() ConfigTypeEnumCamel` + +GetInternalName returns the InternalName field if non-nil, zero value otherwise. + +### GetInternalNameOk + +`func (o *ConfigType) GetInternalNameOk() (*ConfigTypeEnumCamel, bool)` + +GetInternalNameOk returns a tuple with the InternalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternalName + +`func (o *ConfigType) SetInternalName(v ConfigTypeEnumCamel)` + +SetInternalName sets InternalName field to given value. + +### HasInternalName + +`func (o *ConfigType) HasInternalName() bool` + +HasInternalName returns a boolean if a field has been set. + +### GetInternalNameCamel + +`func (o *ConfigType) GetInternalNameCamel() ConfigTypeEnum` + +GetInternalNameCamel returns the InternalNameCamel field if non-nil, zero value otherwise. + +### GetInternalNameCamelOk + +`func (o *ConfigType) GetInternalNameCamelOk() (*ConfigTypeEnum, bool)` + +GetInternalNameCamelOk returns a tuple with the InternalNameCamel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternalNameCamel + +`func (o *ConfigType) SetInternalNameCamel(v ConfigTypeEnum)` + +SetInternalNameCamel sets InternalNameCamel field to given value. + +### HasInternalNameCamel + +`func (o *ConfigType) HasInternalNameCamel() bool` + +HasInternalNameCamel returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *ConfigType) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *ConfigType) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *ConfigType) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *ConfigType) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ConfigType) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ConfigType) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ConfigType) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ConfigType) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConfigTypeEnum.md b/docs/tools/sdk/go/Reference/V2025/Models/ConfigTypeEnum.md new file mode 100644 index 000000000..acf984384 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConfigTypeEnum.md @@ -0,0 +1,23 @@ +--- +id: v2025-config-type-enum +title: ConfigTypeEnum +pagination_label: ConfigTypeEnum +sidebar_label: ConfigTypeEnum +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigTypeEnum', 'V2025ConfigTypeEnum'] +slug: /tools/sdk/go/v2025/models/config-type-enum +tags: ['SDK', 'Software Development Kit', 'ConfigTypeEnum', 'V2025ConfigTypeEnum'] +--- + +# ConfigTypeEnum + +## Enum + + +* `ACCESS_REQUESTS` (value: `"ACCESS_REQUESTS"`) + +* `CERTIFICATIONS` (value: `"CERTIFICATIONS"`) + +* `MANUAL_TASKS` (value: `"MANUAL_TASKS"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConfigTypeEnumCamel.md b/docs/tools/sdk/go/Reference/V2025/Models/ConfigTypeEnumCamel.md new file mode 100644 index 000000000..0c9dd38ca --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConfigTypeEnumCamel.md @@ -0,0 +1,23 @@ +--- +id: v2025-config-type-enum-camel +title: ConfigTypeEnumCamel +pagination_label: ConfigTypeEnumCamel +sidebar_label: ConfigTypeEnumCamel +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigTypeEnumCamel', 'V2025ConfigTypeEnumCamel'] +slug: /tools/sdk/go/v2025/models/config-type-enum-camel +tags: ['SDK', 'Software Development Kit', 'ConfigTypeEnumCamel', 'V2025ConfigTypeEnumCamel'] +--- + +# ConfigTypeEnumCamel + +## Enum + + +* `ACCESS_REQUESTS` (value: `"accessRequests"`) + +* `CERTIFICATIONS` (value: `"certifications"`) + +* `MANUAL_TASKS` (value: `"manualTasks"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConfigurationDetailsResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ConfigurationDetailsResponse.md new file mode 100644 index 000000000..9d6871056 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConfigurationDetailsResponse.md @@ -0,0 +1,168 @@ +--- +id: v2025-configuration-details-response +title: ConfigurationDetailsResponse +pagination_label: ConfigurationDetailsResponse +sidebar_label: ConfigurationDetailsResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigurationDetailsResponse', 'V2025ConfigurationDetailsResponse'] +slug: /tools/sdk/go/v2025/models/configuration-details-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationDetailsResponse', 'V2025ConfigurationDetailsResponse'] +--- + +# ConfigurationDetailsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConfigType** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] +**TargetIdentity** | Pointer to [**Identity1**](identity1) | | [optional] +**StartDate** | Pointer to **SailPointTime** | The date from which to start reassigning work items | [optional] +**EndDate** | Pointer to **SailPointTime** | The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment. | [optional] +**AuditDetails** | Pointer to [**AuditDetails**](audit-details) | | [optional] + +## Methods + +### NewConfigurationDetailsResponse + +`func NewConfigurationDetailsResponse() *ConfigurationDetailsResponse` + +NewConfigurationDetailsResponse instantiates a new ConfigurationDetailsResponse 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 + +### NewConfigurationDetailsResponseWithDefaults + +`func NewConfigurationDetailsResponseWithDefaults() *ConfigurationDetailsResponse` + +NewConfigurationDetailsResponseWithDefaults instantiates a new ConfigurationDetailsResponse 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 + +### GetConfigType + +`func (o *ConfigurationDetailsResponse) GetConfigType() ConfigTypeEnum` + +GetConfigType returns the ConfigType field if non-nil, zero value otherwise. + +### GetConfigTypeOk + +`func (o *ConfigurationDetailsResponse) GetConfigTypeOk() (*ConfigTypeEnum, bool)` + +GetConfigTypeOk returns a tuple with the ConfigType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigType + +`func (o *ConfigurationDetailsResponse) SetConfigType(v ConfigTypeEnum)` + +SetConfigType sets ConfigType field to given value. + +### HasConfigType + +`func (o *ConfigurationDetailsResponse) HasConfigType() bool` + +HasConfigType returns a boolean if a field has been set. + +### GetTargetIdentity + +`func (o *ConfigurationDetailsResponse) GetTargetIdentity() Identity1` + +GetTargetIdentity returns the TargetIdentity field if non-nil, zero value otherwise. + +### GetTargetIdentityOk + +`func (o *ConfigurationDetailsResponse) GetTargetIdentityOk() (*Identity1, bool)` + +GetTargetIdentityOk returns a tuple with the TargetIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetIdentity + +`func (o *ConfigurationDetailsResponse) SetTargetIdentity(v Identity1)` + +SetTargetIdentity sets TargetIdentity field to given value. + +### HasTargetIdentity + +`func (o *ConfigurationDetailsResponse) HasTargetIdentity() bool` + +HasTargetIdentity returns a boolean if a field has been set. + +### GetStartDate + +`func (o *ConfigurationDetailsResponse) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *ConfigurationDetailsResponse) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *ConfigurationDetailsResponse) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *ConfigurationDetailsResponse) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *ConfigurationDetailsResponse) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *ConfigurationDetailsResponse) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *ConfigurationDetailsResponse) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *ConfigurationDetailsResponse) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetAuditDetails + +`func (o *ConfigurationDetailsResponse) GetAuditDetails() AuditDetails` + +GetAuditDetails returns the AuditDetails field if non-nil, zero value otherwise. + +### GetAuditDetailsOk + +`func (o *ConfigurationDetailsResponse) GetAuditDetailsOk() (*AuditDetails, bool)` + +GetAuditDetailsOk returns a tuple with the AuditDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuditDetails + +`func (o *ConfigurationDetailsResponse) SetAuditDetails(v AuditDetails)` + +SetAuditDetails sets AuditDetails field to given value. + +### HasAuditDetails + +`func (o *ConfigurationDetailsResponse) HasAuditDetails() bool` + +HasAuditDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConfigurationItemRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/ConfigurationItemRequest.md new file mode 100644 index 000000000..1afd136c3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConfigurationItemRequest.md @@ -0,0 +1,178 @@ +--- +id: v2025-configuration-item-request +title: ConfigurationItemRequest +pagination_label: ConfigurationItemRequest +sidebar_label: ConfigurationItemRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigurationItemRequest', 'V2025ConfigurationItemRequest'] +slug: /tools/sdk/go/v2025/models/configuration-item-request +tags: ['SDK', 'Software Development Kit', 'ConfigurationItemRequest', 'V2025ConfigurationItemRequest'] +--- + +# ConfigurationItemRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReassignedFromId** | Pointer to **string** | The identity id to reassign an item from | [optional] +**ReassignedToId** | Pointer to **string** | The identity id to reassign an item to | [optional] +**ConfigType** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] +**StartDate** | Pointer to **SailPointTime** | The date from which to start reassigning work items | [optional] +**EndDate** | Pointer to **NullableTime** | The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment. | [optional] + +## Methods + +### NewConfigurationItemRequest + +`func NewConfigurationItemRequest() *ConfigurationItemRequest` + +NewConfigurationItemRequest instantiates a new ConfigurationItemRequest 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 + +### NewConfigurationItemRequestWithDefaults + +`func NewConfigurationItemRequestWithDefaults() *ConfigurationItemRequest` + +NewConfigurationItemRequestWithDefaults instantiates a new ConfigurationItemRequest 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 + +### GetReassignedFromId + +`func (o *ConfigurationItemRequest) GetReassignedFromId() string` + +GetReassignedFromId returns the ReassignedFromId field if non-nil, zero value otherwise. + +### GetReassignedFromIdOk + +`func (o *ConfigurationItemRequest) GetReassignedFromIdOk() (*string, bool)` + +GetReassignedFromIdOk returns a tuple with the ReassignedFromId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignedFromId + +`func (o *ConfigurationItemRequest) SetReassignedFromId(v string)` + +SetReassignedFromId sets ReassignedFromId field to given value. + +### HasReassignedFromId + +`func (o *ConfigurationItemRequest) HasReassignedFromId() bool` + +HasReassignedFromId returns a boolean if a field has been set. + +### GetReassignedToId + +`func (o *ConfigurationItemRequest) GetReassignedToId() string` + +GetReassignedToId returns the ReassignedToId field if non-nil, zero value otherwise. + +### GetReassignedToIdOk + +`func (o *ConfigurationItemRequest) GetReassignedToIdOk() (*string, bool)` + +GetReassignedToIdOk returns a tuple with the ReassignedToId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignedToId + +`func (o *ConfigurationItemRequest) SetReassignedToId(v string)` + +SetReassignedToId sets ReassignedToId field to given value. + +### HasReassignedToId + +`func (o *ConfigurationItemRequest) HasReassignedToId() bool` + +HasReassignedToId returns a boolean if a field has been set. + +### GetConfigType + +`func (o *ConfigurationItemRequest) GetConfigType() ConfigTypeEnum` + +GetConfigType returns the ConfigType field if non-nil, zero value otherwise. + +### GetConfigTypeOk + +`func (o *ConfigurationItemRequest) GetConfigTypeOk() (*ConfigTypeEnum, bool)` + +GetConfigTypeOk returns a tuple with the ConfigType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigType + +`func (o *ConfigurationItemRequest) SetConfigType(v ConfigTypeEnum)` + +SetConfigType sets ConfigType field to given value. + +### HasConfigType + +`func (o *ConfigurationItemRequest) HasConfigType() bool` + +HasConfigType returns a boolean if a field has been set. + +### GetStartDate + +`func (o *ConfigurationItemRequest) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *ConfigurationItemRequest) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *ConfigurationItemRequest) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *ConfigurationItemRequest) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *ConfigurationItemRequest) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *ConfigurationItemRequest) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *ConfigurationItemRequest) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *ConfigurationItemRequest) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### SetEndDateNil + +`func (o *ConfigurationItemRequest) SetEndDateNil(b bool)` + + SetEndDateNil sets the value for EndDate to be an explicit nil + +### UnsetEndDate +`func (o *ConfigurationItemRequest) UnsetEndDate()` + +UnsetEndDate ensures that no value is present for EndDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConfigurationItemResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ConfigurationItemResponse.md new file mode 100644 index 000000000..3d5d2e131 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConfigurationItemResponse.md @@ -0,0 +1,90 @@ +--- +id: v2025-configuration-item-response +title: ConfigurationItemResponse +pagination_label: ConfigurationItemResponse +sidebar_label: ConfigurationItemResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigurationItemResponse', 'V2025ConfigurationItemResponse'] +slug: /tools/sdk/go/v2025/models/configuration-item-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationItemResponse', 'V2025ConfigurationItemResponse'] +--- + +# ConfigurationItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**Identity1**](identity1) | | [optional] +**ConfigDetails** | Pointer to [**[]ConfigurationDetailsResponse**](configuration-details-response) | Details of how work should be reassigned for an Identity | [optional] + +## Methods + +### NewConfigurationItemResponse + +`func NewConfigurationItemResponse() *ConfigurationItemResponse` + +NewConfigurationItemResponse instantiates a new ConfigurationItemResponse 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 + +### NewConfigurationItemResponseWithDefaults + +`func NewConfigurationItemResponseWithDefaults() *ConfigurationItemResponse` + +NewConfigurationItemResponseWithDefaults instantiates a new ConfigurationItemResponse 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 + +### GetIdentity + +`func (o *ConfigurationItemResponse) GetIdentity() Identity1` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *ConfigurationItemResponse) GetIdentityOk() (*Identity1, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *ConfigurationItemResponse) SetIdentity(v Identity1)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *ConfigurationItemResponse) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetConfigDetails + +`func (o *ConfigurationItemResponse) GetConfigDetails() []ConfigurationDetailsResponse` + +GetConfigDetails returns the ConfigDetails field if non-nil, zero value otherwise. + +### GetConfigDetailsOk + +`func (o *ConfigurationItemResponse) GetConfigDetailsOk() (*[]ConfigurationDetailsResponse, bool)` + +GetConfigDetailsOk returns a tuple with the ConfigDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigDetails + +`func (o *ConfigurationItemResponse) SetConfigDetails(v []ConfigurationDetailsResponse)` + +SetConfigDetails sets ConfigDetails field to given value. + +### HasConfigDetails + +`func (o *ConfigurationItemResponse) HasConfigDetails() bool` + +HasConfigDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConfigurationResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ConfigurationResponse.md new file mode 100644 index 000000000..29dfc89d7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConfigurationResponse.md @@ -0,0 +1,90 @@ +--- +id: v2025-configuration-response +title: ConfigurationResponse +pagination_label: ConfigurationResponse +sidebar_label: ConfigurationResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigurationResponse', 'V2025ConfigurationResponse'] +slug: /tools/sdk/go/v2025/models/configuration-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationResponse', 'V2025ConfigurationResponse'] +--- + +# ConfigurationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**Identity1**](identity1) | | [optional] +**ConfigDetails** | Pointer to [**[]ConfigurationDetailsResponse**](configuration-details-response) | Details of how work should be reassigned for an Identity | [optional] + +## Methods + +### NewConfigurationResponse + +`func NewConfigurationResponse() *ConfigurationResponse` + +NewConfigurationResponse instantiates a new ConfigurationResponse 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 + +### NewConfigurationResponseWithDefaults + +`func NewConfigurationResponseWithDefaults() *ConfigurationResponse` + +NewConfigurationResponseWithDefaults instantiates a new ConfigurationResponse 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 + +### GetIdentity + +`func (o *ConfigurationResponse) GetIdentity() Identity1` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *ConfigurationResponse) GetIdentityOk() (*Identity1, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *ConfigurationResponse) SetIdentity(v Identity1)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *ConfigurationResponse) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetConfigDetails + +`func (o *ConfigurationResponse) GetConfigDetails() []ConfigurationDetailsResponse` + +GetConfigDetails returns the ConfigDetails field if non-nil, zero value otherwise. + +### GetConfigDetailsOk + +`func (o *ConfigurationResponse) GetConfigDetailsOk() (*[]ConfigurationDetailsResponse, bool)` + +GetConfigDetailsOk returns a tuple with the ConfigDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigDetails + +`func (o *ConfigurationResponse) SetConfigDetails(v []ConfigurationDetailsResponse)` + +SetConfigDetails sets ConfigDetails field to given value. + +### HasConfigDetails + +`func (o *ConfigurationResponse) HasConfigDetails() bool` + +HasConfigDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConflictingAccessCriteria.md b/docs/tools/sdk/go/Reference/V2025/Models/ConflictingAccessCriteria.md new file mode 100644 index 000000000..af746285d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConflictingAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: v2025-conflicting-access-criteria +title: ConflictingAccessCriteria +pagination_label: ConflictingAccessCriteria +sidebar_label: ConflictingAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConflictingAccessCriteria', 'V2025ConflictingAccessCriteria'] +slug: /tools/sdk/go/v2025/models/conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'ConflictingAccessCriteria', 'V2025ConflictingAccessCriteria'] +--- + +# ConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] +**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] + +## Methods + +### NewConflictingAccessCriteria + +`func NewConflictingAccessCriteria() *ConflictingAccessCriteria` + +NewConflictingAccessCriteria instantiates a new ConflictingAccessCriteria 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 + +### NewConflictingAccessCriteriaWithDefaults + +`func NewConflictingAccessCriteriaWithDefaults() *ConflictingAccessCriteria` + +NewConflictingAccessCriteriaWithDefaults instantiates a new ConflictingAccessCriteria 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 + +### GetLeftCriteria + +`func (o *ConflictingAccessCriteria) GetLeftCriteria() AccessCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *ConflictingAccessCriteria) GetLeftCriteriaOk() (*AccessCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *ConflictingAccessCriteria) SetLeftCriteria(v AccessCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *ConflictingAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *ConflictingAccessCriteria) GetRightCriteria() AccessCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *ConflictingAccessCriteria) GetRightCriteriaOk() (*AccessCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *ConflictingAccessCriteria) SetRightCriteria(v AccessCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *ConflictingAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConnectedObject.md b/docs/tools/sdk/go/Reference/V2025/Models/ConnectedObject.md new file mode 100644 index 000000000..18ebc79ec --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConnectedObject.md @@ -0,0 +1,152 @@ +--- +id: v2025-connected-object +title: ConnectedObject +pagination_label: ConnectedObject +sidebar_label: ConnectedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectedObject', 'V2025ConnectedObject'] +slug: /tools/sdk/go/v2025/models/connected-object +tags: ['SDK', 'Software Development Kit', 'ConnectedObject', 'V2025ConnectedObject'] +--- + +# ConnectedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**ConnectedObjectType**](connected-object-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable name of Connected object | [optional] +**Description** | Pointer to **NullableString** | Description of the Connected object. | [optional] + +## Methods + +### NewConnectedObject + +`func NewConnectedObject() *ConnectedObject` + +NewConnectedObject instantiates a new ConnectedObject 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 + +### NewConnectedObjectWithDefaults + +`func NewConnectedObjectWithDefaults() *ConnectedObject` + +NewConnectedObjectWithDefaults instantiates a new ConnectedObject 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 + +### GetType + +`func (o *ConnectedObject) GetType() ConnectedObjectType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ConnectedObject) GetTypeOk() (*ConnectedObjectType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ConnectedObject) SetType(v ConnectedObjectType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ConnectedObject) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ConnectedObject) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ConnectedObject) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ConnectedObject) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ConnectedObject) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ConnectedObject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectedObject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectedObject) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectedObject) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ConnectedObject) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ConnectedObject) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ConnectedObject) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ConnectedObject) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ConnectedObject) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ConnectedObject) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConnectedObjectType.md b/docs/tools/sdk/go/Reference/V2025/Models/ConnectedObjectType.md new file mode 100644 index 000000000..be0bbd13d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConnectedObjectType.md @@ -0,0 +1,25 @@ +--- +id: v2025-connected-object-type +title: ConnectedObjectType +pagination_label: ConnectedObjectType +sidebar_label: ConnectedObjectType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectedObjectType', 'V2025ConnectedObjectType'] +slug: /tools/sdk/go/v2025/models/connected-object-type +tags: ['SDK', 'Software Development Kit', 'ConnectedObjectType', 'V2025ConnectedObjectType'] +--- + +# ConnectedObjectType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + +* `SOD_POLICY` (value: `"SOD_POLICY"`) + +* `SOURCE` (value: `"SOURCE"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizerCreateRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizerCreateRequest.md new file mode 100644 index 000000000..9a5bb409f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizerCreateRequest.md @@ -0,0 +1,64 @@ +--- +id: v2025-connector-customizer-create-request +title: ConnectorCustomizerCreateRequest +pagination_label: ConnectorCustomizerCreateRequest +sidebar_label: ConnectorCustomizerCreateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorCustomizerCreateRequest', 'V2025ConnectorCustomizerCreateRequest'] +slug: /tools/sdk/go/v2025/models/connector-customizer-create-request +tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerCreateRequest', 'V2025ConnectorCustomizerCreateRequest'] +--- + +# ConnectorCustomizerCreateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Connector customizer name. | [optional] + +## Methods + +### NewConnectorCustomizerCreateRequest + +`func NewConnectorCustomizerCreateRequest() *ConnectorCustomizerCreateRequest` + +NewConnectorCustomizerCreateRequest instantiates a new ConnectorCustomizerCreateRequest 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 + +### NewConnectorCustomizerCreateRequestWithDefaults + +`func NewConnectorCustomizerCreateRequestWithDefaults() *ConnectorCustomizerCreateRequest` + +NewConnectorCustomizerCreateRequestWithDefaults instantiates a new ConnectorCustomizerCreateRequest 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 + +### GetName + +`func (o *ConnectorCustomizerCreateRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorCustomizerCreateRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorCustomizerCreateRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectorCustomizerCreateRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizerCreateResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizerCreateResponse.md new file mode 100644 index 000000000..8844024ae --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizerCreateResponse.md @@ -0,0 +1,142 @@ +--- +id: v2025-connector-customizer-create-response +title: ConnectorCustomizerCreateResponse +pagination_label: ConnectorCustomizerCreateResponse +sidebar_label: ConnectorCustomizerCreateResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorCustomizerCreateResponse', 'V2025ConnectorCustomizerCreateResponse'] +slug: /tools/sdk/go/v2025/models/connector-customizer-create-response +tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerCreateResponse', 'V2025ConnectorCustomizerCreateResponse'] +--- + +# ConnectorCustomizerCreateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the ID of connector customizer. | [optional] +**Name** | Pointer to **string** | name of the connector customizer. | [optional] +**TenantID** | Pointer to **string** | Connector customizer tenant id. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the connector customizer was created. | [optional] + +## Methods + +### NewConnectorCustomizerCreateResponse + +`func NewConnectorCustomizerCreateResponse() *ConnectorCustomizerCreateResponse` + +NewConnectorCustomizerCreateResponse instantiates a new ConnectorCustomizerCreateResponse 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 + +### NewConnectorCustomizerCreateResponseWithDefaults + +`func NewConnectorCustomizerCreateResponseWithDefaults() *ConnectorCustomizerCreateResponse` + +NewConnectorCustomizerCreateResponseWithDefaults instantiates a new ConnectorCustomizerCreateResponse 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 + +### GetId + +`func (o *ConnectorCustomizerCreateResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ConnectorCustomizerCreateResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ConnectorCustomizerCreateResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ConnectorCustomizerCreateResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ConnectorCustomizerCreateResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorCustomizerCreateResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorCustomizerCreateResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectorCustomizerCreateResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetTenantID + +`func (o *ConnectorCustomizerCreateResponse) GetTenantID() string` + +GetTenantID returns the TenantID field if non-nil, zero value otherwise. + +### GetTenantIDOk + +`func (o *ConnectorCustomizerCreateResponse) GetTenantIDOk() (*string, bool)` + +GetTenantIDOk returns a tuple with the TenantID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenantID + +`func (o *ConnectorCustomizerCreateResponse) SetTenantID(v string)` + +SetTenantID sets TenantID field to given value. + +### HasTenantID + +`func (o *ConnectorCustomizerCreateResponse) HasTenantID() bool` + +HasTenantID returns a boolean if a field has been set. + +### GetCreated + +`func (o *ConnectorCustomizerCreateResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ConnectorCustomizerCreateResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ConnectorCustomizerCreateResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ConnectorCustomizerCreateResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizerUpdateRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizerUpdateRequest.md new file mode 100644 index 000000000..abdb28eda --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizerUpdateRequest.md @@ -0,0 +1,64 @@ +--- +id: v2025-connector-customizer-update-request +title: ConnectorCustomizerUpdateRequest +pagination_label: ConnectorCustomizerUpdateRequest +sidebar_label: ConnectorCustomizerUpdateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorCustomizerUpdateRequest', 'V2025ConnectorCustomizerUpdateRequest'] +slug: /tools/sdk/go/v2025/models/connector-customizer-update-request +tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerUpdateRequest', 'V2025ConnectorCustomizerUpdateRequest'] +--- + +# ConnectorCustomizerUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Connector customizer name. | [optional] + +## Methods + +### NewConnectorCustomizerUpdateRequest + +`func NewConnectorCustomizerUpdateRequest() *ConnectorCustomizerUpdateRequest` + +NewConnectorCustomizerUpdateRequest instantiates a new ConnectorCustomizerUpdateRequest 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 + +### NewConnectorCustomizerUpdateRequestWithDefaults + +`func NewConnectorCustomizerUpdateRequestWithDefaults() *ConnectorCustomizerUpdateRequest` + +NewConnectorCustomizerUpdateRequestWithDefaults instantiates a new ConnectorCustomizerUpdateRequest 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 + +### GetName + +`func (o *ConnectorCustomizerUpdateRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorCustomizerUpdateRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorCustomizerUpdateRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectorCustomizerUpdateRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizerUpdateResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizerUpdateResponse.md new file mode 100644 index 000000000..0e5c02064 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizerUpdateResponse.md @@ -0,0 +1,194 @@ +--- +id: v2025-connector-customizer-update-response +title: ConnectorCustomizerUpdateResponse +pagination_label: ConnectorCustomizerUpdateResponse +sidebar_label: ConnectorCustomizerUpdateResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorCustomizerUpdateResponse', 'V2025ConnectorCustomizerUpdateResponse'] +slug: /tools/sdk/go/v2025/models/connector-customizer-update-response +tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerUpdateResponse', 'V2025ConnectorCustomizerUpdateResponse'] +--- + +# ConnectorCustomizerUpdateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the ID of connector customizer. | [optional] +**Name** | Pointer to **string** | name of the connector customizer. | [optional] +**TenantID** | Pointer to **string** | Connector customizer tenant id. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the connector customizer was created. | [optional] +**ImageVersion** | Pointer to **int64** | Connector customizer image version. | [optional] +**ImageID** | Pointer to **string** | Connector customizer image id. | [optional] + +## Methods + +### NewConnectorCustomizerUpdateResponse + +`func NewConnectorCustomizerUpdateResponse() *ConnectorCustomizerUpdateResponse` + +NewConnectorCustomizerUpdateResponse instantiates a new ConnectorCustomizerUpdateResponse 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 + +### NewConnectorCustomizerUpdateResponseWithDefaults + +`func NewConnectorCustomizerUpdateResponseWithDefaults() *ConnectorCustomizerUpdateResponse` + +NewConnectorCustomizerUpdateResponseWithDefaults instantiates a new ConnectorCustomizerUpdateResponse 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 + +### GetId + +`func (o *ConnectorCustomizerUpdateResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ConnectorCustomizerUpdateResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ConnectorCustomizerUpdateResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ConnectorCustomizerUpdateResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ConnectorCustomizerUpdateResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorCustomizerUpdateResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorCustomizerUpdateResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectorCustomizerUpdateResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetTenantID + +`func (o *ConnectorCustomizerUpdateResponse) GetTenantID() string` + +GetTenantID returns the TenantID field if non-nil, zero value otherwise. + +### GetTenantIDOk + +`func (o *ConnectorCustomizerUpdateResponse) GetTenantIDOk() (*string, bool)` + +GetTenantIDOk returns a tuple with the TenantID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenantID + +`func (o *ConnectorCustomizerUpdateResponse) SetTenantID(v string)` + +SetTenantID sets TenantID field to given value. + +### HasTenantID + +`func (o *ConnectorCustomizerUpdateResponse) HasTenantID() bool` + +HasTenantID returns a boolean if a field has been set. + +### GetCreated + +`func (o *ConnectorCustomizerUpdateResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ConnectorCustomizerUpdateResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ConnectorCustomizerUpdateResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ConnectorCustomizerUpdateResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetImageVersion + +`func (o *ConnectorCustomizerUpdateResponse) GetImageVersion() int64` + +GetImageVersion returns the ImageVersion field if non-nil, zero value otherwise. + +### GetImageVersionOk + +`func (o *ConnectorCustomizerUpdateResponse) GetImageVersionOk() (*int64, bool)` + +GetImageVersionOk returns a tuple with the ImageVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImageVersion + +`func (o *ConnectorCustomizerUpdateResponse) SetImageVersion(v int64)` + +SetImageVersion sets ImageVersion field to given value. + +### HasImageVersion + +`func (o *ConnectorCustomizerUpdateResponse) HasImageVersion() bool` + +HasImageVersion returns a boolean if a field has been set. + +### GetImageID + +`func (o *ConnectorCustomizerUpdateResponse) GetImageID() string` + +GetImageID returns the ImageID field if non-nil, zero value otherwise. + +### GetImageIDOk + +`func (o *ConnectorCustomizerUpdateResponse) GetImageIDOk() (*string, bool)` + +GetImageIDOk returns a tuple with the ImageID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImageID + +`func (o *ConnectorCustomizerUpdateResponse) SetImageID(v string)` + +SetImageID sets ImageID field to given value. + +### HasImageID + +`func (o *ConnectorCustomizerUpdateResponse) HasImageID() bool` + +HasImageID returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizerVersionCreateResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizerVersionCreateResponse.md new file mode 100644 index 000000000..5db5bb44a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizerVersionCreateResponse.md @@ -0,0 +1,142 @@ +--- +id: v2025-connector-customizer-version-create-response +title: ConnectorCustomizerVersionCreateResponse +pagination_label: ConnectorCustomizerVersionCreateResponse +sidebar_label: ConnectorCustomizerVersionCreateResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorCustomizerVersionCreateResponse', 'V2025ConnectorCustomizerVersionCreateResponse'] +slug: /tools/sdk/go/v2025/models/connector-customizer-version-create-response +tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizerVersionCreateResponse', 'V2025ConnectorCustomizerVersionCreateResponse'] +--- + +# ConnectorCustomizerVersionCreateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomizerID** | Pointer to **string** | ID of connector customizer. | [optional] +**ImageID** | Pointer to **string** | ImageID of the connector customizer. | [optional] +**Version** | Pointer to **int64** | Image version of the connector customizer. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the connector customizer version was created. | [optional] + +## Methods + +### NewConnectorCustomizerVersionCreateResponse + +`func NewConnectorCustomizerVersionCreateResponse() *ConnectorCustomizerVersionCreateResponse` + +NewConnectorCustomizerVersionCreateResponse instantiates a new ConnectorCustomizerVersionCreateResponse 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 + +### NewConnectorCustomizerVersionCreateResponseWithDefaults + +`func NewConnectorCustomizerVersionCreateResponseWithDefaults() *ConnectorCustomizerVersionCreateResponse` + +NewConnectorCustomizerVersionCreateResponseWithDefaults instantiates a new ConnectorCustomizerVersionCreateResponse 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 + +### GetCustomizerID + +`func (o *ConnectorCustomizerVersionCreateResponse) GetCustomizerID() string` + +GetCustomizerID returns the CustomizerID field if non-nil, zero value otherwise. + +### GetCustomizerIDOk + +`func (o *ConnectorCustomizerVersionCreateResponse) GetCustomizerIDOk() (*string, bool)` + +GetCustomizerIDOk returns a tuple with the CustomizerID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomizerID + +`func (o *ConnectorCustomizerVersionCreateResponse) SetCustomizerID(v string)` + +SetCustomizerID sets CustomizerID field to given value. + +### HasCustomizerID + +`func (o *ConnectorCustomizerVersionCreateResponse) HasCustomizerID() bool` + +HasCustomizerID returns a boolean if a field has been set. + +### GetImageID + +`func (o *ConnectorCustomizerVersionCreateResponse) GetImageID() string` + +GetImageID returns the ImageID field if non-nil, zero value otherwise. + +### GetImageIDOk + +`func (o *ConnectorCustomizerVersionCreateResponse) GetImageIDOk() (*string, bool)` + +GetImageIDOk returns a tuple with the ImageID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImageID + +`func (o *ConnectorCustomizerVersionCreateResponse) SetImageID(v string)` + +SetImageID sets ImageID field to given value. + +### HasImageID + +`func (o *ConnectorCustomizerVersionCreateResponse) HasImageID() bool` + +HasImageID returns a boolean if a field has been set. + +### GetVersion + +`func (o *ConnectorCustomizerVersionCreateResponse) GetVersion() int64` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ConnectorCustomizerVersionCreateResponse) GetVersionOk() (*int64, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ConnectorCustomizerVersionCreateResponse) SetVersion(v int64)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *ConnectorCustomizerVersionCreateResponse) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### GetCreated + +`func (o *ConnectorCustomizerVersionCreateResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ConnectorCustomizerVersionCreateResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ConnectorCustomizerVersionCreateResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ConnectorCustomizerVersionCreateResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizersResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizersResponse.md new file mode 100644 index 000000000..78903d877 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorCustomizersResponse.md @@ -0,0 +1,194 @@ +--- +id: v2025-connector-customizers-response +title: ConnectorCustomizersResponse +pagination_label: ConnectorCustomizersResponse +sidebar_label: ConnectorCustomizersResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorCustomizersResponse', 'V2025ConnectorCustomizersResponse'] +slug: /tools/sdk/go/v2025/models/connector-customizers-response +tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizersResponse', 'V2025ConnectorCustomizersResponse'] +--- + +# ConnectorCustomizersResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Connector customizer ID. | [optional] [readonly] +**Name** | Pointer to **string** | Connector customizer name. | [optional] +**ImageVersion** | Pointer to **int64** | Connector customizer image version. | [optional] +**ImageID** | Pointer to **string** | Connector customizer image id. | [optional] +**TenantID** | Pointer to **string** | Connector customizer tenant id. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the connector customizer was created | [optional] + +## Methods + +### NewConnectorCustomizersResponse + +`func NewConnectorCustomizersResponse() *ConnectorCustomizersResponse` + +NewConnectorCustomizersResponse instantiates a new ConnectorCustomizersResponse 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 + +### NewConnectorCustomizersResponseWithDefaults + +`func NewConnectorCustomizersResponseWithDefaults() *ConnectorCustomizersResponse` + +NewConnectorCustomizersResponseWithDefaults instantiates a new ConnectorCustomizersResponse 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 + +### GetId + +`func (o *ConnectorCustomizersResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ConnectorCustomizersResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ConnectorCustomizersResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ConnectorCustomizersResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ConnectorCustomizersResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorCustomizersResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorCustomizersResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectorCustomizersResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetImageVersion + +`func (o *ConnectorCustomizersResponse) GetImageVersion() int64` + +GetImageVersion returns the ImageVersion field if non-nil, zero value otherwise. + +### GetImageVersionOk + +`func (o *ConnectorCustomizersResponse) GetImageVersionOk() (*int64, bool)` + +GetImageVersionOk returns a tuple with the ImageVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImageVersion + +`func (o *ConnectorCustomizersResponse) SetImageVersion(v int64)` + +SetImageVersion sets ImageVersion field to given value. + +### HasImageVersion + +`func (o *ConnectorCustomizersResponse) HasImageVersion() bool` + +HasImageVersion returns a boolean if a field has been set. + +### GetImageID + +`func (o *ConnectorCustomizersResponse) GetImageID() string` + +GetImageID returns the ImageID field if non-nil, zero value otherwise. + +### GetImageIDOk + +`func (o *ConnectorCustomizersResponse) GetImageIDOk() (*string, bool)` + +GetImageIDOk returns a tuple with the ImageID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImageID + +`func (o *ConnectorCustomizersResponse) SetImageID(v string)` + +SetImageID sets ImageID field to given value. + +### HasImageID + +`func (o *ConnectorCustomizersResponse) HasImageID() bool` + +HasImageID returns a boolean if a field has been set. + +### GetTenantID + +`func (o *ConnectorCustomizersResponse) GetTenantID() string` + +GetTenantID returns the TenantID field if non-nil, zero value otherwise. + +### GetTenantIDOk + +`func (o *ConnectorCustomizersResponse) GetTenantIDOk() (*string, bool)` + +GetTenantIDOk returns a tuple with the TenantID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenantID + +`func (o *ConnectorCustomizersResponse) SetTenantID(v string)` + +SetTenantID sets TenantID field to given value. + +### HasTenantID + +`func (o *ConnectorCustomizersResponse) HasTenantID() bool` + +HasTenantID returns a boolean if a field has been set. + +### GetCreated + +`func (o *ConnectorCustomizersResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ConnectorCustomizersResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ConnectorCustomizersResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ConnectorCustomizersResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConnectorDetail.md b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorDetail.md new file mode 100644 index 000000000..56b156042 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorDetail.md @@ -0,0 +1,484 @@ +--- +id: v2025-connector-detail +title: ConnectorDetail +pagination_label: ConnectorDetail +sidebar_label: ConnectorDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorDetail', 'V2025ConnectorDetail'] +slug: /tools/sdk/go/v2025/models/connector-detail +tags: ['SDK', 'Software Development Kit', 'ConnectorDetail', 'V2025ConnectorDetail'] +--- + +# ConnectorDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The connector name | [optional] +**Type** | Pointer to **string** | The connector type | [optional] +**ClassName** | Pointer to **string** | The connector class name | [optional] +**ScriptName** | Pointer to **string** | The connector script name | [optional] +**ApplicationXml** | Pointer to **string** | The connector application xml | [optional] +**CorrelationConfigXml** | Pointer to **string** | The connector correlation config xml | [optional] +**SourceConfigXml** | Pointer to **string** | The connector source config xml | [optional] +**SourceConfig** | Pointer to **NullableString** | The connector source config | [optional] +**SourceConfigFrom** | Pointer to **NullableString** | The connector source config origin | [optional] +**S3Location** | Pointer to **string** | storage path key for this connector | [optional] +**UploadedFiles** | Pointer to **[]string** | The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. | [optional] +**FileUpload** | Pointer to **bool** | true if the source is file upload | [optional] [default to false] +**DirectConnect** | Pointer to **bool** | true if the source is a direct connect source | [optional] [default to false] +**TranslationProperties** | Pointer to **map[string]interface{}** | A map containing translation attributes by loacale key | [optional] +**ConnectorMetadata** | Pointer to **map[string]interface{}** | A map containing metadata pertinent to the UI to be used | [optional] +**Status** | Pointer to **string** | The connector status | [optional] + +## Methods + +### NewConnectorDetail + +`func NewConnectorDetail() *ConnectorDetail` + +NewConnectorDetail instantiates a new ConnectorDetail 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 + +### NewConnectorDetailWithDefaults + +`func NewConnectorDetailWithDefaults() *ConnectorDetail` + +NewConnectorDetailWithDefaults instantiates a new ConnectorDetail 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 + +### GetName + +`func (o *ConnectorDetail) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorDetail) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorDetail) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectorDetail) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *ConnectorDetail) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ConnectorDetail) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ConnectorDetail) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ConnectorDetail) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetClassName + +`func (o *ConnectorDetail) GetClassName() string` + +GetClassName returns the ClassName field if non-nil, zero value otherwise. + +### GetClassNameOk + +`func (o *ConnectorDetail) GetClassNameOk() (*string, bool)` + +GetClassNameOk returns a tuple with the ClassName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClassName + +`func (o *ConnectorDetail) SetClassName(v string)` + +SetClassName sets ClassName field to given value. + +### HasClassName + +`func (o *ConnectorDetail) HasClassName() bool` + +HasClassName returns a boolean if a field has been set. + +### GetScriptName + +`func (o *ConnectorDetail) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *ConnectorDetail) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *ConnectorDetail) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + +### HasScriptName + +`func (o *ConnectorDetail) HasScriptName() bool` + +HasScriptName returns a boolean if a field has been set. + +### GetApplicationXml + +`func (o *ConnectorDetail) GetApplicationXml() string` + +GetApplicationXml returns the ApplicationXml field if non-nil, zero value otherwise. + +### GetApplicationXmlOk + +`func (o *ConnectorDetail) GetApplicationXmlOk() (*string, bool)` + +GetApplicationXmlOk returns a tuple with the ApplicationXml field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationXml + +`func (o *ConnectorDetail) SetApplicationXml(v string)` + +SetApplicationXml sets ApplicationXml field to given value. + +### HasApplicationXml + +`func (o *ConnectorDetail) HasApplicationXml() bool` + +HasApplicationXml returns a boolean if a field has been set. + +### GetCorrelationConfigXml + +`func (o *ConnectorDetail) GetCorrelationConfigXml() string` + +GetCorrelationConfigXml returns the CorrelationConfigXml field if non-nil, zero value otherwise. + +### GetCorrelationConfigXmlOk + +`func (o *ConnectorDetail) GetCorrelationConfigXmlOk() (*string, bool)` + +GetCorrelationConfigXmlOk returns a tuple with the CorrelationConfigXml field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelationConfigXml + +`func (o *ConnectorDetail) SetCorrelationConfigXml(v string)` + +SetCorrelationConfigXml sets CorrelationConfigXml field to given value. + +### HasCorrelationConfigXml + +`func (o *ConnectorDetail) HasCorrelationConfigXml() bool` + +HasCorrelationConfigXml returns a boolean if a field has been set. + +### GetSourceConfigXml + +`func (o *ConnectorDetail) GetSourceConfigXml() string` + +GetSourceConfigXml returns the SourceConfigXml field if non-nil, zero value otherwise. + +### GetSourceConfigXmlOk + +`func (o *ConnectorDetail) GetSourceConfigXmlOk() (*string, bool)` + +GetSourceConfigXmlOk returns a tuple with the SourceConfigXml field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceConfigXml + +`func (o *ConnectorDetail) SetSourceConfigXml(v string)` + +SetSourceConfigXml sets SourceConfigXml field to given value. + +### HasSourceConfigXml + +`func (o *ConnectorDetail) HasSourceConfigXml() bool` + +HasSourceConfigXml returns a boolean if a field has been set. + +### GetSourceConfig + +`func (o *ConnectorDetail) GetSourceConfig() string` + +GetSourceConfig returns the SourceConfig field if non-nil, zero value otherwise. + +### GetSourceConfigOk + +`func (o *ConnectorDetail) GetSourceConfigOk() (*string, bool)` + +GetSourceConfigOk returns a tuple with the SourceConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceConfig + +`func (o *ConnectorDetail) SetSourceConfig(v string)` + +SetSourceConfig sets SourceConfig field to given value. + +### HasSourceConfig + +`func (o *ConnectorDetail) HasSourceConfig() bool` + +HasSourceConfig returns a boolean if a field has been set. + +### SetSourceConfigNil + +`func (o *ConnectorDetail) SetSourceConfigNil(b bool)` + + SetSourceConfigNil sets the value for SourceConfig to be an explicit nil + +### UnsetSourceConfig +`func (o *ConnectorDetail) UnsetSourceConfig()` + +UnsetSourceConfig ensures that no value is present for SourceConfig, not even an explicit nil +### GetSourceConfigFrom + +`func (o *ConnectorDetail) GetSourceConfigFrom() string` + +GetSourceConfigFrom returns the SourceConfigFrom field if non-nil, zero value otherwise. + +### GetSourceConfigFromOk + +`func (o *ConnectorDetail) GetSourceConfigFromOk() (*string, bool)` + +GetSourceConfigFromOk returns a tuple with the SourceConfigFrom field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceConfigFrom + +`func (o *ConnectorDetail) SetSourceConfigFrom(v string)` + +SetSourceConfigFrom sets SourceConfigFrom field to given value. + +### HasSourceConfigFrom + +`func (o *ConnectorDetail) HasSourceConfigFrom() bool` + +HasSourceConfigFrom returns a boolean if a field has been set. + +### SetSourceConfigFromNil + +`func (o *ConnectorDetail) SetSourceConfigFromNil(b bool)` + + SetSourceConfigFromNil sets the value for SourceConfigFrom to be an explicit nil + +### UnsetSourceConfigFrom +`func (o *ConnectorDetail) UnsetSourceConfigFrom()` + +UnsetSourceConfigFrom ensures that no value is present for SourceConfigFrom, not even an explicit nil +### GetS3Location + +`func (o *ConnectorDetail) GetS3Location() string` + +GetS3Location returns the S3Location field if non-nil, zero value otherwise. + +### GetS3LocationOk + +`func (o *ConnectorDetail) GetS3LocationOk() (*string, bool)` + +GetS3LocationOk returns a tuple with the S3Location field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetS3Location + +`func (o *ConnectorDetail) SetS3Location(v string)` + +SetS3Location sets S3Location field to given value. + +### HasS3Location + +`func (o *ConnectorDetail) HasS3Location() bool` + +HasS3Location returns a boolean if a field has been set. + +### GetUploadedFiles + +`func (o *ConnectorDetail) GetUploadedFiles() []string` + +GetUploadedFiles returns the UploadedFiles field if non-nil, zero value otherwise. + +### GetUploadedFilesOk + +`func (o *ConnectorDetail) GetUploadedFilesOk() (*[]string, bool)` + +GetUploadedFilesOk returns a tuple with the UploadedFiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUploadedFiles + +`func (o *ConnectorDetail) SetUploadedFiles(v []string)` + +SetUploadedFiles sets UploadedFiles field to given value. + +### HasUploadedFiles + +`func (o *ConnectorDetail) HasUploadedFiles() bool` + +HasUploadedFiles returns a boolean if a field has been set. + +### SetUploadedFilesNil + +`func (o *ConnectorDetail) SetUploadedFilesNil(b bool)` + + SetUploadedFilesNil sets the value for UploadedFiles to be an explicit nil + +### UnsetUploadedFiles +`func (o *ConnectorDetail) UnsetUploadedFiles()` + +UnsetUploadedFiles ensures that no value is present for UploadedFiles, not even an explicit nil +### GetFileUpload + +`func (o *ConnectorDetail) GetFileUpload() bool` + +GetFileUpload returns the FileUpload field if non-nil, zero value otherwise. + +### GetFileUploadOk + +`func (o *ConnectorDetail) GetFileUploadOk() (*bool, bool)` + +GetFileUploadOk returns a tuple with the FileUpload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileUpload + +`func (o *ConnectorDetail) SetFileUpload(v bool)` + +SetFileUpload sets FileUpload field to given value. + +### HasFileUpload + +`func (o *ConnectorDetail) HasFileUpload() bool` + +HasFileUpload returns a boolean if a field has been set. + +### GetDirectConnect + +`func (o *ConnectorDetail) GetDirectConnect() bool` + +GetDirectConnect returns the DirectConnect field if non-nil, zero value otherwise. + +### GetDirectConnectOk + +`func (o *ConnectorDetail) GetDirectConnectOk() (*bool, bool)` + +GetDirectConnectOk returns a tuple with the DirectConnect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectConnect + +`func (o *ConnectorDetail) SetDirectConnect(v bool)` + +SetDirectConnect sets DirectConnect field to given value. + +### HasDirectConnect + +`func (o *ConnectorDetail) HasDirectConnect() bool` + +HasDirectConnect returns a boolean if a field has been set. + +### GetTranslationProperties + +`func (o *ConnectorDetail) GetTranslationProperties() map[string]interface{}` + +GetTranslationProperties returns the TranslationProperties field if non-nil, zero value otherwise. + +### GetTranslationPropertiesOk + +`func (o *ConnectorDetail) GetTranslationPropertiesOk() (*map[string]interface{}, bool)` + +GetTranslationPropertiesOk returns a tuple with the TranslationProperties field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslationProperties + +`func (o *ConnectorDetail) SetTranslationProperties(v map[string]interface{})` + +SetTranslationProperties sets TranslationProperties field to given value. + +### HasTranslationProperties + +`func (o *ConnectorDetail) HasTranslationProperties() bool` + +HasTranslationProperties returns a boolean if a field has been set. + +### GetConnectorMetadata + +`func (o *ConnectorDetail) GetConnectorMetadata() map[string]interface{}` + +GetConnectorMetadata returns the ConnectorMetadata field if non-nil, zero value otherwise. + +### GetConnectorMetadataOk + +`func (o *ConnectorDetail) GetConnectorMetadataOk() (*map[string]interface{}, bool)` + +GetConnectorMetadataOk returns a tuple with the ConnectorMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorMetadata + +`func (o *ConnectorDetail) SetConnectorMetadata(v map[string]interface{})` + +SetConnectorMetadata sets ConnectorMetadata field to given value. + +### HasConnectorMetadata + +`func (o *ConnectorDetail) HasConnectorMetadata() bool` + +HasConnectorMetadata returns a boolean if a field has been set. + +### GetStatus + +`func (o *ConnectorDetail) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ConnectorDetail) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ConnectorDetail) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ConnectorDetail) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleCreateRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleCreateRequest.md new file mode 100644 index 000000000..59483eb08 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleCreateRequest.md @@ -0,0 +1,199 @@ +--- +id: v2025-connector-rule-create-request +title: ConnectorRuleCreateRequest +pagination_label: ConnectorRuleCreateRequest +sidebar_label: ConnectorRuleCreateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleCreateRequest', 'V2025ConnectorRuleCreateRequest'] +slug: /tools/sdk/go/v2025/models/connector-rule-create-request +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleCreateRequest', 'V2025ConnectorRuleCreateRequest'] +--- + +# ConnectorRuleCreateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | the name of the rule | +**Description** | Pointer to **NullableString** | a description of the rule's purpose | [optional] +**Type** | **string** | the type of rule | +**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**SourceCode** | [**SourceCode**](source-code) | | +**Attributes** | Pointer to **map[string]interface{}** | a map of string to objects | [optional] + +## Methods + +### NewConnectorRuleCreateRequest + +`func NewConnectorRuleCreateRequest(name string, type_ string, sourceCode SourceCode, ) *ConnectorRuleCreateRequest` + +NewConnectorRuleCreateRequest instantiates a new ConnectorRuleCreateRequest 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 + +### NewConnectorRuleCreateRequestWithDefaults + +`func NewConnectorRuleCreateRequestWithDefaults() *ConnectorRuleCreateRequest` + +NewConnectorRuleCreateRequestWithDefaults instantiates a new ConnectorRuleCreateRequest 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 + +### GetName + +`func (o *ConnectorRuleCreateRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorRuleCreateRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorRuleCreateRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *ConnectorRuleCreateRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ConnectorRuleCreateRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ConnectorRuleCreateRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ConnectorRuleCreateRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ConnectorRuleCreateRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ConnectorRuleCreateRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *ConnectorRuleCreateRequest) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ConnectorRuleCreateRequest) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ConnectorRuleCreateRequest) SetType(v string)` + +SetType sets Type field to given value. + + +### GetSignature + +`func (o *ConnectorRuleCreateRequest) GetSignature() ConnectorRuleCreateRequestSignature` + +GetSignature returns the Signature field if non-nil, zero value otherwise. + +### GetSignatureOk + +`func (o *ConnectorRuleCreateRequest) GetSignatureOk() (*ConnectorRuleCreateRequestSignature, bool)` + +GetSignatureOk returns a tuple with the Signature field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignature + +`func (o *ConnectorRuleCreateRequest) SetSignature(v ConnectorRuleCreateRequestSignature)` + +SetSignature sets Signature field to given value. + +### HasSignature + +`func (o *ConnectorRuleCreateRequest) HasSignature() bool` + +HasSignature returns a boolean if a field has been set. + +### GetSourceCode + +`func (o *ConnectorRuleCreateRequest) GetSourceCode() SourceCode` + +GetSourceCode returns the SourceCode field if non-nil, zero value otherwise. + +### GetSourceCodeOk + +`func (o *ConnectorRuleCreateRequest) GetSourceCodeOk() (*SourceCode, bool)` + +GetSourceCodeOk returns a tuple with the SourceCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceCode + +`func (o *ConnectorRuleCreateRequest) SetSourceCode(v SourceCode)` + +SetSourceCode sets SourceCode field to given value. + + +### GetAttributes + +`func (o *ConnectorRuleCreateRequest) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ConnectorRuleCreateRequest) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ConnectorRuleCreateRequest) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ConnectorRuleCreateRequest) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *ConnectorRuleCreateRequest) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *ConnectorRuleCreateRequest) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleCreateRequestSignature.md b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleCreateRequestSignature.md new file mode 100644 index 000000000..336b35338 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleCreateRequestSignature.md @@ -0,0 +1,95 @@ +--- +id: v2025-connector-rule-create-request-signature +title: ConnectorRuleCreateRequestSignature +pagination_label: ConnectorRuleCreateRequestSignature +sidebar_label: ConnectorRuleCreateRequestSignature +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleCreateRequestSignature', 'V2025ConnectorRuleCreateRequestSignature'] +slug: /tools/sdk/go/v2025/models/connector-rule-create-request-signature +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleCreateRequestSignature', 'V2025ConnectorRuleCreateRequestSignature'] +--- + +# ConnectorRuleCreateRequestSignature + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | [**[]Argument**](argument) | | +**Output** | Pointer to [**NullableArgument**](argument) | | [optional] + +## Methods + +### NewConnectorRuleCreateRequestSignature + +`func NewConnectorRuleCreateRequestSignature(input []Argument, ) *ConnectorRuleCreateRequestSignature` + +NewConnectorRuleCreateRequestSignature instantiates a new ConnectorRuleCreateRequestSignature 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 + +### NewConnectorRuleCreateRequestSignatureWithDefaults + +`func NewConnectorRuleCreateRequestSignatureWithDefaults() *ConnectorRuleCreateRequestSignature` + +NewConnectorRuleCreateRequestSignatureWithDefaults instantiates a new ConnectorRuleCreateRequestSignature 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 + +### GetInput + +`func (o *ConnectorRuleCreateRequestSignature) GetInput() []Argument` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *ConnectorRuleCreateRequestSignature) GetInputOk() (*[]Argument, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *ConnectorRuleCreateRequestSignature) SetInput(v []Argument)` + +SetInput sets Input field to given value. + + +### GetOutput + +`func (o *ConnectorRuleCreateRequestSignature) GetOutput() Argument` + +GetOutput returns the Output field if non-nil, zero value otherwise. + +### GetOutputOk + +`func (o *ConnectorRuleCreateRequestSignature) GetOutputOk() (*Argument, bool)` + +GetOutputOk returns a tuple with the Output field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutput + +`func (o *ConnectorRuleCreateRequestSignature) SetOutput(v Argument)` + +SetOutput sets Output field to given value. + +### HasOutput + +`func (o *ConnectorRuleCreateRequestSignature) HasOutput() bool` + +HasOutput returns a boolean if a field has been set. + +### SetOutputNil + +`func (o *ConnectorRuleCreateRequestSignature) SetOutputNil(b bool)` + + SetOutputNil sets the value for Output to be an explicit nil + +### UnsetOutput +`func (o *ConnectorRuleCreateRequestSignature) UnsetOutput()` + +UnsetOutput ensures that no value is present for Output, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleResponse.md new file mode 100644 index 000000000..fb306be25 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleResponse.md @@ -0,0 +1,277 @@ +--- +id: v2025-connector-rule-response +title: ConnectorRuleResponse +pagination_label: ConnectorRuleResponse +sidebar_label: ConnectorRuleResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleResponse', 'V2025ConnectorRuleResponse'] +slug: /tools/sdk/go/v2025/models/connector-rule-response +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleResponse', 'V2025ConnectorRuleResponse'] +--- + +# ConnectorRuleResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | the name of the rule | +**Description** | Pointer to **NullableString** | a description of the rule's purpose | [optional] +**Type** | **string** | the type of rule | +**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**SourceCode** | [**SourceCode**](source-code) | | +**Attributes** | Pointer to **map[string]interface{}** | a map of string to objects | [optional] +**Id** | **string** | the ID of the rule | +**Created** | **string** | an ISO 8601 UTC timestamp when this rule was created | +**Modified** | Pointer to **NullableString** | an ISO 8601 UTC timestamp when this rule was last modified | [optional] + +## Methods + +### NewConnectorRuleResponse + +`func NewConnectorRuleResponse(name string, type_ string, sourceCode SourceCode, id string, created string, ) *ConnectorRuleResponse` + +NewConnectorRuleResponse instantiates a new ConnectorRuleResponse 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 + +### NewConnectorRuleResponseWithDefaults + +`func NewConnectorRuleResponseWithDefaults() *ConnectorRuleResponse` + +NewConnectorRuleResponseWithDefaults instantiates a new ConnectorRuleResponse 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 + +### GetName + +`func (o *ConnectorRuleResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorRuleResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorRuleResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *ConnectorRuleResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ConnectorRuleResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ConnectorRuleResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ConnectorRuleResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ConnectorRuleResponse) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ConnectorRuleResponse) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *ConnectorRuleResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ConnectorRuleResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ConnectorRuleResponse) SetType(v string)` + +SetType sets Type field to given value. + + +### GetSignature + +`func (o *ConnectorRuleResponse) GetSignature() ConnectorRuleCreateRequestSignature` + +GetSignature returns the Signature field if non-nil, zero value otherwise. + +### GetSignatureOk + +`func (o *ConnectorRuleResponse) GetSignatureOk() (*ConnectorRuleCreateRequestSignature, bool)` + +GetSignatureOk returns a tuple with the Signature field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignature + +`func (o *ConnectorRuleResponse) SetSignature(v ConnectorRuleCreateRequestSignature)` + +SetSignature sets Signature field to given value. + +### HasSignature + +`func (o *ConnectorRuleResponse) HasSignature() bool` + +HasSignature returns a boolean if a field has been set. + +### GetSourceCode + +`func (o *ConnectorRuleResponse) GetSourceCode() SourceCode` + +GetSourceCode returns the SourceCode field if non-nil, zero value otherwise. + +### GetSourceCodeOk + +`func (o *ConnectorRuleResponse) GetSourceCodeOk() (*SourceCode, bool)` + +GetSourceCodeOk returns a tuple with the SourceCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceCode + +`func (o *ConnectorRuleResponse) SetSourceCode(v SourceCode)` + +SetSourceCode sets SourceCode field to given value. + + +### GetAttributes + +`func (o *ConnectorRuleResponse) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ConnectorRuleResponse) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ConnectorRuleResponse) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ConnectorRuleResponse) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *ConnectorRuleResponse) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *ConnectorRuleResponse) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetId + +`func (o *ConnectorRuleResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ConnectorRuleResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ConnectorRuleResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetCreated + +`func (o *ConnectorRuleResponse) GetCreated() string` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ConnectorRuleResponse) GetCreatedOk() (*string, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ConnectorRuleResponse) SetCreated(v string)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *ConnectorRuleResponse) GetModified() string` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ConnectorRuleResponse) GetModifiedOk() (*string, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ConnectorRuleResponse) SetModified(v string)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ConnectorRuleResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *ConnectorRuleResponse) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *ConnectorRuleResponse) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleUpdateRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleUpdateRequest.md new file mode 100644 index 000000000..c32be0ba8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleUpdateRequest.md @@ -0,0 +1,220 @@ +--- +id: v2025-connector-rule-update-request +title: ConnectorRuleUpdateRequest +pagination_label: ConnectorRuleUpdateRequest +sidebar_label: ConnectorRuleUpdateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleUpdateRequest', 'V2025ConnectorRuleUpdateRequest'] +slug: /tools/sdk/go/v2025/models/connector-rule-update-request +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleUpdateRequest', 'V2025ConnectorRuleUpdateRequest'] +--- + +# ConnectorRuleUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | the name of the rule | +**Description** | Pointer to **NullableString** | a description of the rule's purpose | [optional] +**Type** | **string** | the type of rule | +**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**SourceCode** | [**SourceCode**](source-code) | | +**Attributes** | Pointer to **map[string]interface{}** | a map of string to objects | [optional] +**Id** | **string** | the ID of the rule to update | + +## Methods + +### NewConnectorRuleUpdateRequest + +`func NewConnectorRuleUpdateRequest(name string, type_ string, sourceCode SourceCode, id string, ) *ConnectorRuleUpdateRequest` + +NewConnectorRuleUpdateRequest instantiates a new ConnectorRuleUpdateRequest 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 + +### NewConnectorRuleUpdateRequestWithDefaults + +`func NewConnectorRuleUpdateRequestWithDefaults() *ConnectorRuleUpdateRequest` + +NewConnectorRuleUpdateRequestWithDefaults instantiates a new ConnectorRuleUpdateRequest 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 + +### GetName + +`func (o *ConnectorRuleUpdateRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorRuleUpdateRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorRuleUpdateRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *ConnectorRuleUpdateRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ConnectorRuleUpdateRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ConnectorRuleUpdateRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ConnectorRuleUpdateRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ConnectorRuleUpdateRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ConnectorRuleUpdateRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *ConnectorRuleUpdateRequest) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ConnectorRuleUpdateRequest) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ConnectorRuleUpdateRequest) SetType(v string)` + +SetType sets Type field to given value. + + +### GetSignature + +`func (o *ConnectorRuleUpdateRequest) GetSignature() ConnectorRuleCreateRequestSignature` + +GetSignature returns the Signature field if non-nil, zero value otherwise. + +### GetSignatureOk + +`func (o *ConnectorRuleUpdateRequest) GetSignatureOk() (*ConnectorRuleCreateRequestSignature, bool)` + +GetSignatureOk returns a tuple with the Signature field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignature + +`func (o *ConnectorRuleUpdateRequest) SetSignature(v ConnectorRuleCreateRequestSignature)` + +SetSignature sets Signature field to given value. + +### HasSignature + +`func (o *ConnectorRuleUpdateRequest) HasSignature() bool` + +HasSignature returns a boolean if a field has been set. + +### GetSourceCode + +`func (o *ConnectorRuleUpdateRequest) GetSourceCode() SourceCode` + +GetSourceCode returns the SourceCode field if non-nil, zero value otherwise. + +### GetSourceCodeOk + +`func (o *ConnectorRuleUpdateRequest) GetSourceCodeOk() (*SourceCode, bool)` + +GetSourceCodeOk returns a tuple with the SourceCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceCode + +`func (o *ConnectorRuleUpdateRequest) SetSourceCode(v SourceCode)` + +SetSourceCode sets SourceCode field to given value. + + +### GetAttributes + +`func (o *ConnectorRuleUpdateRequest) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ConnectorRuleUpdateRequest) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ConnectorRuleUpdateRequest) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ConnectorRuleUpdateRequest) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *ConnectorRuleUpdateRequest) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *ConnectorRuleUpdateRequest) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetId + +`func (o *ConnectorRuleUpdateRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ConnectorRuleUpdateRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ConnectorRuleUpdateRequest) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleValidationResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleValidationResponse.md new file mode 100644 index 000000000..e60068f2a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleValidationResponse.md @@ -0,0 +1,80 @@ +--- +id: v2025-connector-rule-validation-response +title: ConnectorRuleValidationResponse +pagination_label: ConnectorRuleValidationResponse +sidebar_label: ConnectorRuleValidationResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleValidationResponse', 'V2025ConnectorRuleValidationResponse'] +slug: /tools/sdk/go/v2025/models/connector-rule-validation-response +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleValidationResponse', 'V2025ConnectorRuleValidationResponse'] +--- + +# ConnectorRuleValidationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | **string** | | +**Details** | [**[]ConnectorRuleValidationResponseDetailsInner**](connector-rule-validation-response-details-inner) | | + +## Methods + +### NewConnectorRuleValidationResponse + +`func NewConnectorRuleValidationResponse(state string, details []ConnectorRuleValidationResponseDetailsInner, ) *ConnectorRuleValidationResponse` + +NewConnectorRuleValidationResponse instantiates a new ConnectorRuleValidationResponse 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 + +### NewConnectorRuleValidationResponseWithDefaults + +`func NewConnectorRuleValidationResponseWithDefaults() *ConnectorRuleValidationResponse` + +NewConnectorRuleValidationResponseWithDefaults instantiates a new ConnectorRuleValidationResponse 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 + +### GetState + +`func (o *ConnectorRuleValidationResponse) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ConnectorRuleValidationResponse) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ConnectorRuleValidationResponse) SetState(v string)` + +SetState sets State field to given value. + + +### GetDetails + +`func (o *ConnectorRuleValidationResponse) GetDetails() []ConnectorRuleValidationResponseDetailsInner` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *ConnectorRuleValidationResponse) GetDetailsOk() (*[]ConnectorRuleValidationResponseDetailsInner, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *ConnectorRuleValidationResponse) SetDetails(v []ConnectorRuleValidationResponseDetailsInner)` + +SetDetails sets Details field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleValidationResponseDetailsInner.md b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleValidationResponseDetailsInner.md new file mode 100644 index 000000000..12a5e396b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ConnectorRuleValidationResponseDetailsInner.md @@ -0,0 +1,106 @@ +--- +id: v2025-connector-rule-validation-response-details-inner +title: ConnectorRuleValidationResponseDetailsInner +pagination_label: ConnectorRuleValidationResponseDetailsInner +sidebar_label: ConnectorRuleValidationResponseDetailsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorRuleValidationResponseDetailsInner', 'V2025ConnectorRuleValidationResponseDetailsInner'] +slug: /tools/sdk/go/v2025/models/connector-rule-validation-response-details-inner +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleValidationResponseDetailsInner', 'V2025ConnectorRuleValidationResponseDetailsInner'] +--- + +# ConnectorRuleValidationResponseDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Line** | **int32** | The line number where the issue occurred | +**Column** | **int32** | the column number where the issue occurred | +**Messsage** | Pointer to **string** | a description of the issue in the code | [optional] + +## Methods + +### NewConnectorRuleValidationResponseDetailsInner + +`func NewConnectorRuleValidationResponseDetailsInner(line int32, column int32, ) *ConnectorRuleValidationResponseDetailsInner` + +NewConnectorRuleValidationResponseDetailsInner instantiates a new ConnectorRuleValidationResponseDetailsInner 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 + +### NewConnectorRuleValidationResponseDetailsInnerWithDefaults + +`func NewConnectorRuleValidationResponseDetailsInnerWithDefaults() *ConnectorRuleValidationResponseDetailsInner` + +NewConnectorRuleValidationResponseDetailsInnerWithDefaults instantiates a new ConnectorRuleValidationResponseDetailsInner 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 + +### GetLine + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetLine() int32` + +GetLine returns the Line field if non-nil, zero value otherwise. + +### GetLineOk + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetLineOk() (*int32, bool)` + +GetLineOk returns a tuple with the Line field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLine + +`func (o *ConnectorRuleValidationResponseDetailsInner) SetLine(v int32)` + +SetLine sets Line field to given value. + + +### GetColumn + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetColumn() int32` + +GetColumn returns the Column field if non-nil, zero value otherwise. + +### GetColumnOk + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetColumnOk() (*int32, bool)` + +GetColumnOk returns a tuple with the Column field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumn + +`func (o *ConnectorRuleValidationResponseDetailsInner) SetColumn(v int32)` + +SetColumn sets Column field to given value. + + +### GetMesssage + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetMesssage() string` + +GetMesssage returns the Messsage field if non-nil, zero value otherwise. + +### GetMesssageOk + +`func (o *ConnectorRuleValidationResponseDetailsInner) GetMesssageOk() (*string, bool)` + +GetMesssageOk returns a tuple with the Messsage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMesssage + +`func (o *ConnectorRuleValidationResponseDetailsInner) SetMesssage(v string)` + +SetMesssage sets Messsage field to given value. + +### HasMesssage + +`func (o *ConnectorRuleValidationResponseDetailsInner) HasMesssage() bool` + +HasMesssage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ContextAttributeDto.md b/docs/tools/sdk/go/Reference/V2025/Models/ContextAttributeDto.md new file mode 100644 index 000000000..8d0d7a8d3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ContextAttributeDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-context-attribute-dto +title: ContextAttributeDto +pagination_label: ContextAttributeDto +sidebar_label: ContextAttributeDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ContextAttributeDto', 'V2025ContextAttributeDto'] +slug: /tools/sdk/go/v2025/models/context-attribute-dto +tags: ['SDK', 'Software Development Kit', 'ContextAttributeDto', 'V2025ContextAttributeDto'] +--- + +# ContextAttributeDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | Pointer to **string** | The name of the attribute | [optional] +**Value** | Pointer to [**ContextAttributeDtoValue**](context-attribute-dto-value) | | [optional] +**Derived** | Pointer to **bool** | True if the attribute was derived. | [optional] [default to false] + +## Methods + +### NewContextAttributeDto + +`func NewContextAttributeDto() *ContextAttributeDto` + +NewContextAttributeDto instantiates a new ContextAttributeDto 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 + +### NewContextAttributeDtoWithDefaults + +`func NewContextAttributeDtoWithDefaults() *ContextAttributeDto` + +NewContextAttributeDtoWithDefaults instantiates a new ContextAttributeDto 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 + +### GetAttribute + +`func (o *ContextAttributeDto) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ContextAttributeDto) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ContextAttributeDto) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ContextAttributeDto) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *ContextAttributeDto) GetValue() ContextAttributeDtoValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ContextAttributeDto) GetValueOk() (*ContextAttributeDtoValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ContextAttributeDto) SetValue(v ContextAttributeDtoValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ContextAttributeDto) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetDerived + +`func (o *ContextAttributeDto) GetDerived() bool` + +GetDerived returns the Derived field if non-nil, zero value otherwise. + +### GetDerivedOk + +`func (o *ContextAttributeDto) GetDerivedOk() (*bool, bool)` + +GetDerivedOk returns a tuple with the Derived field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDerived + +`func (o *ContextAttributeDto) SetDerived(v bool)` + +SetDerived sets Derived field to given value. + +### HasDerived + +`func (o *ContextAttributeDto) HasDerived() bool` + +HasDerived returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ContextAttributeDtoValue.md b/docs/tools/sdk/go/Reference/V2025/Models/ContextAttributeDtoValue.md new file mode 100644 index 000000000..4e04c2425 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ContextAttributeDtoValue.md @@ -0,0 +1,38 @@ +--- +id: v2025-context-attribute-dto-value +title: ContextAttributeDtoValue +pagination_label: ContextAttributeDtoValue +sidebar_label: ContextAttributeDtoValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ContextAttributeDtoValue', 'V2025ContextAttributeDtoValue'] +slug: /tools/sdk/go/v2025/models/context-attribute-dto-value +tags: ['SDK', 'Software Development Kit', 'ContextAttributeDtoValue', 'V2025ContextAttributeDtoValue'] +--- + +# ContextAttributeDtoValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewContextAttributeDtoValue + +`func NewContextAttributeDtoValue() *ContextAttributeDtoValue` + +NewContextAttributeDtoValue instantiates a new ContextAttributeDtoValue 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 + +### NewContextAttributeDtoValueWithDefaults + +`func NewContextAttributeDtoValueWithDefaults() *ContextAttributeDtoValue` + +NewContextAttributeDtoValueWithDefaults instantiates a new ContextAttributeDtoValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CorrelatedGovernanceEvent.md b/docs/tools/sdk/go/Reference/V2025/Models/CorrelatedGovernanceEvent.md new file mode 100644 index 000000000..58ad01f6f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CorrelatedGovernanceEvent.md @@ -0,0 +1,220 @@ +--- +id: v2025-correlated-governance-event +title: CorrelatedGovernanceEvent +pagination_label: CorrelatedGovernanceEvent +sidebar_label: CorrelatedGovernanceEvent +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CorrelatedGovernanceEvent', 'V2025CorrelatedGovernanceEvent'] +slug: /tools/sdk/go/v2025/models/correlated-governance-event +tags: ['SDK', 'Software Development Kit', 'CorrelatedGovernanceEvent', 'V2025CorrelatedGovernanceEvent'] +--- + +# CorrelatedGovernanceEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the governance event, such as the certification name or access request ID. | [optional] +**Dt** | Pointer to **string** | The date that the certification or access request was completed. | [optional] +**Type** | Pointer to **string** | The type of governance event. | [optional] +**GovernanceId** | Pointer to **string** | The ID of the instance that caused the event - either the certification ID or access request ID. | [optional] +**Owners** | Pointer to [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers) | [optional] +**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers), this field should be preferred over owners | [optional] +**DecisionMaker** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] + +## Methods + +### NewCorrelatedGovernanceEvent + +`func NewCorrelatedGovernanceEvent() *CorrelatedGovernanceEvent` + +NewCorrelatedGovernanceEvent instantiates a new CorrelatedGovernanceEvent 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 + +### NewCorrelatedGovernanceEventWithDefaults + +`func NewCorrelatedGovernanceEventWithDefaults() *CorrelatedGovernanceEvent` + +NewCorrelatedGovernanceEventWithDefaults instantiates a new CorrelatedGovernanceEvent 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 + +### GetName + +`func (o *CorrelatedGovernanceEvent) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CorrelatedGovernanceEvent) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CorrelatedGovernanceEvent) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CorrelatedGovernanceEvent) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDt + +`func (o *CorrelatedGovernanceEvent) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *CorrelatedGovernanceEvent) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *CorrelatedGovernanceEvent) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *CorrelatedGovernanceEvent) HasDt() bool` + +HasDt returns a boolean if a field has been set. + +### GetType + +`func (o *CorrelatedGovernanceEvent) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CorrelatedGovernanceEvent) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CorrelatedGovernanceEvent) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CorrelatedGovernanceEvent) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetGovernanceId + +`func (o *CorrelatedGovernanceEvent) GetGovernanceId() string` + +GetGovernanceId returns the GovernanceId field if non-nil, zero value otherwise. + +### GetGovernanceIdOk + +`func (o *CorrelatedGovernanceEvent) GetGovernanceIdOk() (*string, bool)` + +GetGovernanceIdOk returns a tuple with the GovernanceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceId + +`func (o *CorrelatedGovernanceEvent) SetGovernanceId(v string)` + +SetGovernanceId sets GovernanceId field to given value. + +### HasGovernanceId + +`func (o *CorrelatedGovernanceEvent) HasGovernanceId() bool` + +HasGovernanceId returns a boolean if a field has been set. + +### GetOwners + +`func (o *CorrelatedGovernanceEvent) GetOwners() []CertifierResponse` + +GetOwners returns the Owners field if non-nil, zero value otherwise. + +### GetOwnersOk + +`func (o *CorrelatedGovernanceEvent) GetOwnersOk() (*[]CertifierResponse, bool)` + +GetOwnersOk returns a tuple with the Owners field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwners + +`func (o *CorrelatedGovernanceEvent) SetOwners(v []CertifierResponse)` + +SetOwners sets Owners field to given value. + +### HasOwners + +`func (o *CorrelatedGovernanceEvent) HasOwners() bool` + +HasOwners returns a boolean if a field has been set. + +### GetReviewers + +`func (o *CorrelatedGovernanceEvent) GetReviewers() []CertifierResponse` + +GetReviewers returns the Reviewers field if non-nil, zero value otherwise. + +### GetReviewersOk + +`func (o *CorrelatedGovernanceEvent) GetReviewersOk() (*[]CertifierResponse, bool)` + +GetReviewersOk returns a tuple with the Reviewers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewers + +`func (o *CorrelatedGovernanceEvent) SetReviewers(v []CertifierResponse)` + +SetReviewers sets Reviewers field to given value. + +### HasReviewers + +`func (o *CorrelatedGovernanceEvent) HasReviewers() bool` + +HasReviewers returns a boolean if a field has been set. + +### GetDecisionMaker + +`func (o *CorrelatedGovernanceEvent) GetDecisionMaker() CertifierResponse` + +GetDecisionMaker returns the DecisionMaker field if non-nil, zero value otherwise. + +### GetDecisionMakerOk + +`func (o *CorrelatedGovernanceEvent) GetDecisionMakerOk() (*CertifierResponse, bool)` + +GetDecisionMakerOk returns a tuple with the DecisionMaker field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionMaker + +`func (o *CorrelatedGovernanceEvent) SetDecisionMaker(v CertifierResponse)` + +SetDecisionMaker sets DecisionMaker field to given value. + +### HasDecisionMaker + +`func (o *CorrelatedGovernanceEvent) HasDecisionMaker() bool` + +HasDecisionMaker returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CorrelationConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/CorrelationConfig.md new file mode 100644 index 000000000..89d7ebd46 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CorrelationConfig.md @@ -0,0 +1,146 @@ +--- +id: v2025-correlation-config +title: CorrelationConfig +pagination_label: CorrelationConfig +sidebar_label: CorrelationConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CorrelationConfig', 'V2025CorrelationConfig'] +slug: /tools/sdk/go/v2025/models/correlation-config +tags: ['SDK', 'Software Development Kit', 'CorrelationConfig', 'V2025CorrelationConfig'] +--- + +# CorrelationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | The ID of the correlation configuration. | [optional] +**Name** | Pointer to **NullableString** | The name of the correlation configuration. | [optional] +**AttributeAssignments** | Pointer to [**[]CorrelationConfigAttributeAssignmentsInner**](correlation-config-attribute-assignments-inner) | The list of attribute assignments of the correlation configuration. | [optional] + +## Methods + +### NewCorrelationConfig + +`func NewCorrelationConfig() *CorrelationConfig` + +NewCorrelationConfig instantiates a new CorrelationConfig 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 + +### NewCorrelationConfigWithDefaults + +`func NewCorrelationConfigWithDefaults() *CorrelationConfig` + +NewCorrelationConfigWithDefaults instantiates a new CorrelationConfig 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 + +### GetId + +`func (o *CorrelationConfig) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CorrelationConfig) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CorrelationConfig) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CorrelationConfig) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *CorrelationConfig) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *CorrelationConfig) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *CorrelationConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CorrelationConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CorrelationConfig) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CorrelationConfig) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *CorrelationConfig) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *CorrelationConfig) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetAttributeAssignments + +`func (o *CorrelationConfig) GetAttributeAssignments() []CorrelationConfigAttributeAssignmentsInner` + +GetAttributeAssignments returns the AttributeAssignments field if non-nil, zero value otherwise. + +### GetAttributeAssignmentsOk + +`func (o *CorrelationConfig) GetAttributeAssignmentsOk() (*[]CorrelationConfigAttributeAssignmentsInner, bool)` + +GetAttributeAssignmentsOk returns a tuple with the AttributeAssignments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeAssignments + +`func (o *CorrelationConfig) SetAttributeAssignments(v []CorrelationConfigAttributeAssignmentsInner)` + +SetAttributeAssignments sets AttributeAssignments field to given value. + +### HasAttributeAssignments + +`func (o *CorrelationConfig) HasAttributeAssignments() bool` + +HasAttributeAssignments returns a boolean if a field has been set. + +### SetAttributeAssignmentsNil + +`func (o *CorrelationConfig) SetAttributeAssignmentsNil(b bool)` + + SetAttributeAssignmentsNil sets the value for AttributeAssignments to be an explicit nil + +### UnsetAttributeAssignments +`func (o *CorrelationConfig) UnsetAttributeAssignments()` + +UnsetAttributeAssignments ensures that no value is present for AttributeAssignments, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CorrelationConfigAttributeAssignmentsInner.md b/docs/tools/sdk/go/Reference/V2025/Models/CorrelationConfigAttributeAssignmentsInner.md new file mode 100644 index 000000000..4dfd031ca --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CorrelationConfigAttributeAssignmentsInner.md @@ -0,0 +1,220 @@ +--- +id: v2025-correlation-config-attribute-assignments-inner +title: CorrelationConfigAttributeAssignmentsInner +pagination_label: CorrelationConfigAttributeAssignmentsInner +sidebar_label: CorrelationConfigAttributeAssignmentsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CorrelationConfigAttributeAssignmentsInner', 'V2025CorrelationConfigAttributeAssignmentsInner'] +slug: /tools/sdk/go/v2025/models/correlation-config-attribute-assignments-inner +tags: ['SDK', 'Software Development Kit', 'CorrelationConfigAttributeAssignmentsInner', 'V2025CorrelationConfigAttributeAssignmentsInner'] +--- + +# CorrelationConfigAttributeAssignmentsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Property** | Pointer to **string** | The property of the attribute assignment. | [optional] +**Value** | Pointer to **string** | The value of the attribute assignment. | [optional] +**Operation** | Pointer to **string** | The operation of the attribute assignment. | [optional] +**Complex** | Pointer to **bool** | Whether or not the it's a complex attribute assignment. | [optional] [default to false] +**IgnoreCase** | Pointer to **bool** | Whether or not the attribute assignment should ignore case. | [optional] [default to false] +**MatchMode** | Pointer to **string** | The match mode of the attribute assignment. | [optional] +**FilterString** | Pointer to **string** | The filter string of the attribute assignment. | [optional] + +## Methods + +### NewCorrelationConfigAttributeAssignmentsInner + +`func NewCorrelationConfigAttributeAssignmentsInner() *CorrelationConfigAttributeAssignmentsInner` + +NewCorrelationConfigAttributeAssignmentsInner instantiates a new CorrelationConfigAttributeAssignmentsInner 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 + +### NewCorrelationConfigAttributeAssignmentsInnerWithDefaults + +`func NewCorrelationConfigAttributeAssignmentsInnerWithDefaults() *CorrelationConfigAttributeAssignmentsInner` + +NewCorrelationConfigAttributeAssignmentsInnerWithDefaults instantiates a new CorrelationConfigAttributeAssignmentsInner 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 + +### GetProperty + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetProperty() string` + +GetProperty returns the Property field if non-nil, zero value otherwise. + +### GetPropertyOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetPropertyOk() (*string, bool)` + +GetPropertyOk returns a tuple with the Property field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperty + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetProperty(v string)` + +SetProperty sets Property field to given value. + +### HasProperty + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasProperty() bool` + +HasProperty returns a boolean if a field has been set. + +### GetValue + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetOperation + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetComplex + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetComplex() bool` + +GetComplex returns the Complex field if non-nil, zero value otherwise. + +### GetComplexOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetComplexOk() (*bool, bool)` + +GetComplexOk returns a tuple with the Complex field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComplex + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetComplex(v bool)` + +SetComplex sets Complex field to given value. + +### HasComplex + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasComplex() bool` + +HasComplex returns a boolean if a field has been set. + +### GetIgnoreCase + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetIgnoreCase() bool` + +GetIgnoreCase returns the IgnoreCase field if non-nil, zero value otherwise. + +### GetIgnoreCaseOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetIgnoreCaseOk() (*bool, bool)` + +GetIgnoreCaseOk returns a tuple with the IgnoreCase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIgnoreCase + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetIgnoreCase(v bool)` + +SetIgnoreCase sets IgnoreCase field to given value. + +### HasIgnoreCase + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasIgnoreCase() bool` + +HasIgnoreCase returns a boolean if a field has been set. + +### GetMatchMode + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetMatchMode() string` + +GetMatchMode returns the MatchMode field if non-nil, zero value otherwise. + +### GetMatchModeOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetMatchModeOk() (*string, bool)` + +GetMatchModeOk returns a tuple with the MatchMode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchMode + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetMatchMode(v string)` + +SetMatchMode sets MatchMode field to given value. + +### HasMatchMode + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasMatchMode() bool` + +HasMatchMode returns a boolean if a field has been set. + +### GetFilterString + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetFilterString() string` + +GetFilterString returns the FilterString field if non-nil, zero value otherwise. + +### GetFilterStringOk + +`func (o *CorrelationConfigAttributeAssignmentsInner) GetFilterStringOk() (*string, bool)` + +GetFilterStringOk returns a tuple with the FilterString field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilterString + +`func (o *CorrelationConfigAttributeAssignmentsInner) SetFilterString(v string)` + +SetFilterString sets FilterString field to given value. + +### HasFilterString + +`func (o *CorrelationConfigAttributeAssignmentsInner) HasFilterString() bool` + +HasFilterString returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CreateDomainDkim405Response.md b/docs/tools/sdk/go/Reference/V2025/Models/CreateDomainDkim405Response.md new file mode 100644 index 000000000..dc5366d54 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CreateDomainDkim405Response.md @@ -0,0 +1,116 @@ +--- +id: v2025-create-domain-dkim405-response +title: CreateDomainDkim405Response +pagination_label: CreateDomainDkim405Response +sidebar_label: CreateDomainDkim405Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateDomainDkim405Response', 'V2025CreateDomainDkim405Response'] +slug: /tools/sdk/go/v2025/models/create-domain-dkim405-response +tags: ['SDK', 'Software Development Kit', 'CreateDomainDkim405Response', 'V2025CreateDomainDkim405Response'] +--- + +# CreateDomainDkim405Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ErrorName** | Pointer to **map[string]interface{}** | A message describing the error | [optional] +**ErrorMessage** | Pointer to **map[string]interface{}** | Description of the error | [optional] +**TrackingId** | Pointer to **string** | Unique tracking id for the error. | [optional] + +## Methods + +### NewCreateDomainDkim405Response + +`func NewCreateDomainDkim405Response() *CreateDomainDkim405Response` + +NewCreateDomainDkim405Response instantiates a new CreateDomainDkim405Response 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 + +### NewCreateDomainDkim405ResponseWithDefaults + +`func NewCreateDomainDkim405ResponseWithDefaults() *CreateDomainDkim405Response` + +NewCreateDomainDkim405ResponseWithDefaults instantiates a new CreateDomainDkim405Response 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 + +### GetErrorName + +`func (o *CreateDomainDkim405Response) GetErrorName() map[string]interface{}` + +GetErrorName returns the ErrorName field if non-nil, zero value otherwise. + +### GetErrorNameOk + +`func (o *CreateDomainDkim405Response) GetErrorNameOk() (*map[string]interface{}, bool)` + +GetErrorNameOk returns a tuple with the ErrorName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorName + +`func (o *CreateDomainDkim405Response) SetErrorName(v map[string]interface{})` + +SetErrorName sets ErrorName field to given value. + +### HasErrorName + +`func (o *CreateDomainDkim405Response) HasErrorName() bool` + +HasErrorName returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *CreateDomainDkim405Response) GetErrorMessage() map[string]interface{}` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *CreateDomainDkim405Response) GetErrorMessageOk() (*map[string]interface{}, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *CreateDomainDkim405Response) SetErrorMessage(v map[string]interface{})` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *CreateDomainDkim405Response) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetTrackingId + +`func (o *CreateDomainDkim405Response) GetTrackingId() string` + +GetTrackingId returns the TrackingId field if non-nil, zero value otherwise. + +### GetTrackingIdOk + +`func (o *CreateDomainDkim405Response) GetTrackingIdOk() (*string, bool)` + +GetTrackingIdOk returns a tuple with the TrackingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingId + +`func (o *CreateDomainDkim405Response) SetTrackingId(v string)` + +SetTrackingId sets TrackingId field to given value. + +### HasTrackingId + +`func (o *CreateDomainDkim405Response) HasTrackingId() bool` + +HasTrackingId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CreateExternalExecuteWorkflow200Response.md b/docs/tools/sdk/go/Reference/V2025/Models/CreateExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..92e5f477c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CreateExternalExecuteWorkflow200Response.md @@ -0,0 +1,90 @@ +--- +id: v2025-create-external-execute-workflow200-response +title: CreateExternalExecuteWorkflow200Response +pagination_label: CreateExternalExecuteWorkflow200Response +sidebar_label: CreateExternalExecuteWorkflow200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateExternalExecuteWorkflow200Response', 'V2025CreateExternalExecuteWorkflow200Response'] +slug: /tools/sdk/go/v2025/models/create-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflow200Response', 'V2025CreateExternalExecuteWorkflow200Response'] +--- + +# CreateExternalExecuteWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**WorkflowExecutionId** | Pointer to **string** | The workflow execution id | [optional] +**Message** | Pointer to **string** | An error message if any errors occurred | [optional] + +## Methods + +### NewCreateExternalExecuteWorkflow200Response + +`func NewCreateExternalExecuteWorkflow200Response() *CreateExternalExecuteWorkflow200Response` + +NewCreateExternalExecuteWorkflow200Response instantiates a new CreateExternalExecuteWorkflow200Response 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 + +### NewCreateExternalExecuteWorkflow200ResponseWithDefaults + +`func NewCreateExternalExecuteWorkflow200ResponseWithDefaults() *CreateExternalExecuteWorkflow200Response` + +NewCreateExternalExecuteWorkflow200ResponseWithDefaults instantiates a new CreateExternalExecuteWorkflow200Response 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 + +### GetWorkflowExecutionId + +`func (o *CreateExternalExecuteWorkflow200Response) GetWorkflowExecutionId() string` + +GetWorkflowExecutionId returns the WorkflowExecutionId field if non-nil, zero value otherwise. + +### GetWorkflowExecutionIdOk + +`func (o *CreateExternalExecuteWorkflow200Response) GetWorkflowExecutionIdOk() (*string, bool)` + +GetWorkflowExecutionIdOk returns a tuple with the WorkflowExecutionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWorkflowExecutionId + +`func (o *CreateExternalExecuteWorkflow200Response) SetWorkflowExecutionId(v string)` + +SetWorkflowExecutionId sets WorkflowExecutionId field to given value. + +### HasWorkflowExecutionId + +`func (o *CreateExternalExecuteWorkflow200Response) HasWorkflowExecutionId() bool` + +HasWorkflowExecutionId returns a boolean if a field has been set. + +### GetMessage + +`func (o *CreateExternalExecuteWorkflow200Response) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *CreateExternalExecuteWorkflow200Response) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *CreateExternalExecuteWorkflow200Response) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *CreateExternalExecuteWorkflow200Response) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CreateExternalExecuteWorkflowRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/CreateExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..8911c34c1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CreateExternalExecuteWorkflowRequest.md @@ -0,0 +1,64 @@ +--- +id: v2025-create-external-execute-workflow-request +title: CreateExternalExecuteWorkflowRequest +pagination_label: CreateExternalExecuteWorkflowRequest +sidebar_label: CreateExternalExecuteWorkflowRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateExternalExecuteWorkflowRequest', 'V2025CreateExternalExecuteWorkflowRequest'] +slug: /tools/sdk/go/v2025/models/create-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflowRequest', 'V2025CreateExternalExecuteWorkflowRequest'] +--- + +# CreateExternalExecuteWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | Pointer to **map[string]interface{}** | The input for the workflow | [optional] + +## Methods + +### NewCreateExternalExecuteWorkflowRequest + +`func NewCreateExternalExecuteWorkflowRequest() *CreateExternalExecuteWorkflowRequest` + +NewCreateExternalExecuteWorkflowRequest instantiates a new CreateExternalExecuteWorkflowRequest 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 + +### NewCreateExternalExecuteWorkflowRequestWithDefaults + +`func NewCreateExternalExecuteWorkflowRequestWithDefaults() *CreateExternalExecuteWorkflowRequest` + +NewCreateExternalExecuteWorkflowRequestWithDefaults instantiates a new CreateExternalExecuteWorkflowRequest 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 + +### GetInput + +`func (o *CreateExternalExecuteWorkflowRequest) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *CreateExternalExecuteWorkflowRequest) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *CreateExternalExecuteWorkflowRequest) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + +### HasInput + +`func (o *CreateExternalExecuteWorkflowRequest) HasInput() bool` + +HasInput returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CreateFormDefinitionFileRequestRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/CreateFormDefinitionFileRequestRequest.md new file mode 100644 index 000000000..e28ef3945 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CreateFormDefinitionFileRequestRequest.md @@ -0,0 +1,59 @@ +--- +id: v2025-create-form-definition-file-request-request +title: CreateFormDefinitionFileRequestRequest +pagination_label: CreateFormDefinitionFileRequestRequest +sidebar_label: CreateFormDefinitionFileRequestRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateFormDefinitionFileRequestRequest', 'V2025CreateFormDefinitionFileRequestRequest'] +slug: /tools/sdk/go/v2025/models/create-form-definition-file-request-request +tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionFileRequestRequest', 'V2025CreateFormDefinitionFileRequestRequest'] +--- + +# CreateFormDefinitionFileRequestRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | ***os.File** | File specifying the multipart | + +## Methods + +### NewCreateFormDefinitionFileRequestRequest + +`func NewCreateFormDefinitionFileRequestRequest(file *os.File, ) *CreateFormDefinitionFileRequestRequest` + +NewCreateFormDefinitionFileRequestRequest instantiates a new CreateFormDefinitionFileRequestRequest 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 + +### NewCreateFormDefinitionFileRequestRequestWithDefaults + +`func NewCreateFormDefinitionFileRequestRequestWithDefaults() *CreateFormDefinitionFileRequestRequest` + +NewCreateFormDefinitionFileRequestRequestWithDefaults instantiates a new CreateFormDefinitionFileRequestRequest 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 + +### GetFile + +`func (o *CreateFormDefinitionFileRequestRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *CreateFormDefinitionFileRequestRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *CreateFormDefinitionFileRequestRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CreateFormDefinitionRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/CreateFormDefinitionRequest.md new file mode 100644 index 000000000..15a25eb93 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CreateFormDefinitionRequest.md @@ -0,0 +1,210 @@ +--- +id: v2025-create-form-definition-request +title: CreateFormDefinitionRequest +pagination_label: CreateFormDefinitionRequest +sidebar_label: CreateFormDefinitionRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateFormDefinitionRequest', 'V2025CreateFormDefinitionRequest'] +slug: /tools/sdk/go/v2025/models/create-form-definition-request +tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionRequest', 'V2025CreateFormDefinitionRequest'] +--- + +# CreateFormDefinitionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Description is the form definition description | [optional] +**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**FormElements** | Pointer to [**[]FormElement**](form-element) | FormElements is a list of nested form elements | [optional] +**FormInput** | Pointer to [**[]FormDefinitionInput**](form-definition-input) | FormInput is a list of form inputs that are required when creating a form-instance object | [optional] +**Name** | **string** | Name is the form definition name | +**Owner** | [**FormOwner**](form-owner) | | +**UsedBy** | Pointer to [**[]FormUsedBy**](form-used-by) | UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used | [optional] + +## Methods + +### NewCreateFormDefinitionRequest + +`func NewCreateFormDefinitionRequest(name string, owner FormOwner, ) *CreateFormDefinitionRequest` + +NewCreateFormDefinitionRequest instantiates a new CreateFormDefinitionRequest 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 + +### NewCreateFormDefinitionRequestWithDefaults + +`func NewCreateFormDefinitionRequestWithDefaults() *CreateFormDefinitionRequest` + +NewCreateFormDefinitionRequestWithDefaults instantiates a new CreateFormDefinitionRequest 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 + +### GetDescription + +`func (o *CreateFormDefinitionRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateFormDefinitionRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateFormDefinitionRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CreateFormDefinitionRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetFormConditions + +`func (o *CreateFormDefinitionRequest) GetFormConditions() []FormCondition` + +GetFormConditions returns the FormConditions field if non-nil, zero value otherwise. + +### GetFormConditionsOk + +`func (o *CreateFormDefinitionRequest) GetFormConditionsOk() (*[]FormCondition, bool)` + +GetFormConditionsOk returns a tuple with the FormConditions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormConditions + +`func (o *CreateFormDefinitionRequest) SetFormConditions(v []FormCondition)` + +SetFormConditions sets FormConditions field to given value. + +### HasFormConditions + +`func (o *CreateFormDefinitionRequest) HasFormConditions() bool` + +HasFormConditions returns a boolean if a field has been set. + +### GetFormElements + +`func (o *CreateFormDefinitionRequest) GetFormElements() []FormElement` + +GetFormElements returns the FormElements field if non-nil, zero value otherwise. + +### GetFormElementsOk + +`func (o *CreateFormDefinitionRequest) GetFormElementsOk() (*[]FormElement, bool)` + +GetFormElementsOk returns a tuple with the FormElements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormElements + +`func (o *CreateFormDefinitionRequest) SetFormElements(v []FormElement)` + +SetFormElements sets FormElements field to given value. + +### HasFormElements + +`func (o *CreateFormDefinitionRequest) HasFormElements() bool` + +HasFormElements returns a boolean if a field has been set. + +### GetFormInput + +`func (o *CreateFormDefinitionRequest) GetFormInput() []FormDefinitionInput` + +GetFormInput returns the FormInput field if non-nil, zero value otherwise. + +### GetFormInputOk + +`func (o *CreateFormDefinitionRequest) GetFormInputOk() (*[]FormDefinitionInput, bool)` + +GetFormInputOk returns a tuple with the FormInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormInput + +`func (o *CreateFormDefinitionRequest) SetFormInput(v []FormDefinitionInput)` + +SetFormInput sets FormInput field to given value. + +### HasFormInput + +`func (o *CreateFormDefinitionRequest) HasFormInput() bool` + +HasFormInput returns a boolean if a field has been set. + +### GetName + +`func (o *CreateFormDefinitionRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateFormDefinitionRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateFormDefinitionRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetOwner + +`func (o *CreateFormDefinitionRequest) GetOwner() FormOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CreateFormDefinitionRequest) GetOwnerOk() (*FormOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CreateFormDefinitionRequest) SetOwner(v FormOwner)` + +SetOwner sets Owner field to given value. + + +### GetUsedBy + +`func (o *CreateFormDefinitionRequest) GetUsedBy() []FormUsedBy` + +GetUsedBy returns the UsedBy field if non-nil, zero value otherwise. + +### GetUsedByOk + +`func (o *CreateFormDefinitionRequest) GetUsedByOk() (*[]FormUsedBy, bool)` + +GetUsedByOk returns a tuple with the UsedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsedBy + +`func (o *CreateFormDefinitionRequest) SetUsedBy(v []FormUsedBy)` + +SetUsedBy sets UsedBy field to given value. + +### HasUsedBy + +`func (o *CreateFormDefinitionRequest) HasUsedBy() bool` + +HasUsedBy returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CreateFormInstanceRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/CreateFormInstanceRequest.md new file mode 100644 index 000000000..8c9cfb015 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CreateFormInstanceRequest.md @@ -0,0 +1,226 @@ +--- +id: v2025-create-form-instance-request +title: CreateFormInstanceRequest +pagination_label: CreateFormInstanceRequest +sidebar_label: CreateFormInstanceRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateFormInstanceRequest', 'V2025CreateFormInstanceRequest'] +slug: /tools/sdk/go/v2025/models/create-form-instance-request +tags: ['SDK', 'Software Development Kit', 'CreateFormInstanceRequest', 'V2025CreateFormInstanceRequest'] +--- + +# CreateFormInstanceRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedBy** | [**FormInstanceCreatedBy**](form-instance-created-by) | | +**Expire** | **string** | Expire is required | +**FormDefinitionId** | **string** | FormDefinitionID is the id of the form definition that created this form | +**FormInput** | Pointer to **map[string]interface{}** | FormInput is an object of form input labels to value | [optional] +**Recipients** | [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients is required | +**StandAloneForm** | Pointer to **bool** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to false] +**State** | Pointer to **string** | State is required, if not present initial state is FormInstanceStateAssigned ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] +**Ttl** | Pointer to **int64** | TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html | [optional] + +## Methods + +### NewCreateFormInstanceRequest + +`func NewCreateFormInstanceRequest(createdBy FormInstanceCreatedBy, expire string, formDefinitionId string, recipients []FormInstanceRecipient, ) *CreateFormInstanceRequest` + +NewCreateFormInstanceRequest instantiates a new CreateFormInstanceRequest 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 + +### NewCreateFormInstanceRequestWithDefaults + +`func NewCreateFormInstanceRequestWithDefaults() *CreateFormInstanceRequest` + +NewCreateFormInstanceRequestWithDefaults instantiates a new CreateFormInstanceRequest 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 + +### GetCreatedBy + +`func (o *CreateFormInstanceRequest) GetCreatedBy() FormInstanceCreatedBy` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *CreateFormInstanceRequest) GetCreatedByOk() (*FormInstanceCreatedBy, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *CreateFormInstanceRequest) SetCreatedBy(v FormInstanceCreatedBy)` + +SetCreatedBy sets CreatedBy field to given value. + + +### GetExpire + +`func (o *CreateFormInstanceRequest) GetExpire() string` + +GetExpire returns the Expire field if non-nil, zero value otherwise. + +### GetExpireOk + +`func (o *CreateFormInstanceRequest) GetExpireOk() (*string, bool)` + +GetExpireOk returns a tuple with the Expire field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpire + +`func (o *CreateFormInstanceRequest) SetExpire(v string)` + +SetExpire sets Expire field to given value. + + +### GetFormDefinitionId + +`func (o *CreateFormInstanceRequest) GetFormDefinitionId() string` + +GetFormDefinitionId returns the FormDefinitionId field if non-nil, zero value otherwise. + +### GetFormDefinitionIdOk + +`func (o *CreateFormInstanceRequest) GetFormDefinitionIdOk() (*string, bool)` + +GetFormDefinitionIdOk returns a tuple with the FormDefinitionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormDefinitionId + +`func (o *CreateFormInstanceRequest) SetFormDefinitionId(v string)` + +SetFormDefinitionId sets FormDefinitionId field to given value. + + +### GetFormInput + +`func (o *CreateFormInstanceRequest) GetFormInput() map[string]interface{}` + +GetFormInput returns the FormInput field if non-nil, zero value otherwise. + +### GetFormInputOk + +`func (o *CreateFormInstanceRequest) GetFormInputOk() (*map[string]interface{}, bool)` + +GetFormInputOk returns a tuple with the FormInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormInput + +`func (o *CreateFormInstanceRequest) SetFormInput(v map[string]interface{})` + +SetFormInput sets FormInput field to given value. + +### HasFormInput + +`func (o *CreateFormInstanceRequest) HasFormInput() bool` + +HasFormInput returns a boolean if a field has been set. + +### GetRecipients + +`func (o *CreateFormInstanceRequest) GetRecipients() []FormInstanceRecipient` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *CreateFormInstanceRequest) GetRecipientsOk() (*[]FormInstanceRecipient, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *CreateFormInstanceRequest) SetRecipients(v []FormInstanceRecipient)` + +SetRecipients sets Recipients field to given value. + + +### GetStandAloneForm + +`func (o *CreateFormInstanceRequest) GetStandAloneForm() bool` + +GetStandAloneForm returns the StandAloneForm field if non-nil, zero value otherwise. + +### GetStandAloneFormOk + +`func (o *CreateFormInstanceRequest) GetStandAloneFormOk() (*bool, bool)` + +GetStandAloneFormOk returns a tuple with the StandAloneForm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandAloneForm + +`func (o *CreateFormInstanceRequest) SetStandAloneForm(v bool)` + +SetStandAloneForm sets StandAloneForm field to given value. + +### HasStandAloneForm + +`func (o *CreateFormInstanceRequest) HasStandAloneForm() bool` + +HasStandAloneForm returns a boolean if a field has been set. + +### GetState + +`func (o *CreateFormInstanceRequest) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *CreateFormInstanceRequest) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *CreateFormInstanceRequest) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *CreateFormInstanceRequest) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetTtl + +`func (o *CreateFormInstanceRequest) GetTtl() int64` + +GetTtl returns the Ttl field if non-nil, zero value otherwise. + +### GetTtlOk + +`func (o *CreateFormInstanceRequest) GetTtlOk() (*int64, bool)` + +GetTtlOk returns a tuple with the Ttl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTtl + +`func (o *CreateFormInstanceRequest) SetTtl(v int64)` + +SetTtl sets Ttl field to given value. + +### HasTtl + +`func (o *CreateFormInstanceRequest) HasTtl() bool` + +HasTtl returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CreateOAuthClientRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/CreateOAuthClientRequest.md new file mode 100644 index 000000000..5c2b8dfb5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CreateOAuthClientRequest.md @@ -0,0 +1,468 @@ +--- +id: v2025-create-o-auth-client-request +title: CreateOAuthClientRequest +pagination_label: CreateOAuthClientRequest +sidebar_label: CreateOAuthClientRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateOAuthClientRequest', 'V2025CreateOAuthClientRequest'] +slug: /tools/sdk/go/v2025/models/create-o-auth-client-request +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientRequest', 'V2025CreateOAuthClientRequest'] +--- + +# CreateOAuthClientRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BusinessName** | Pointer to **NullableString** | The name of the business the API Client should belong to | [optional] +**HomepageUrl** | Pointer to **NullableString** | The homepage URL associated with the owner of the API Client | [optional] +**Name** | **NullableString** | A human-readable name for the API Client | +**Description** | **NullableString** | A description of the API Client | +**AccessTokenValiditySeconds** | **int32** | The number of seconds an access token generated for this API Client is valid for | +**RefreshTokenValiditySeconds** | Pointer to **int32** | The number of seconds a refresh token generated for this API Client is valid for | [optional] +**RedirectUris** | Pointer to **[]string** | A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. | [optional] +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | +**AccessType** | [**AccessType**](access-type) | | +**Type** | Pointer to [**ClientType**](client-type) | | [optional] +**Internal** | Pointer to **bool** | An indicator of whether the API Client can be used for requests internal within the product. | [optional] +**Enabled** | **bool** | An indicator of whether the API Client is enabled for use | +**StrongAuthSupported** | Pointer to **bool** | An indicator of whether the API Client supports strong authentication | [optional] +**ClaimsSupported** | Pointer to **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [optional] +**Scope** | Pointer to **[]string** | Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it. | [optional] + +## Methods + +### NewCreateOAuthClientRequest + +`func NewCreateOAuthClientRequest(name NullableString, description NullableString, accessTokenValiditySeconds int32, grantTypes []GrantType, accessType AccessType, enabled bool, ) *CreateOAuthClientRequest` + +NewCreateOAuthClientRequest instantiates a new CreateOAuthClientRequest 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 + +### NewCreateOAuthClientRequestWithDefaults + +`func NewCreateOAuthClientRequestWithDefaults() *CreateOAuthClientRequest` + +NewCreateOAuthClientRequestWithDefaults instantiates a new CreateOAuthClientRequest 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 + +### GetBusinessName + +`func (o *CreateOAuthClientRequest) GetBusinessName() string` + +GetBusinessName returns the BusinessName field if non-nil, zero value otherwise. + +### GetBusinessNameOk + +`func (o *CreateOAuthClientRequest) GetBusinessNameOk() (*string, bool)` + +GetBusinessNameOk returns a tuple with the BusinessName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBusinessName + +`func (o *CreateOAuthClientRequest) SetBusinessName(v string)` + +SetBusinessName sets BusinessName field to given value. + +### HasBusinessName + +`func (o *CreateOAuthClientRequest) HasBusinessName() bool` + +HasBusinessName returns a boolean if a field has been set. + +### SetBusinessNameNil + +`func (o *CreateOAuthClientRequest) SetBusinessNameNil(b bool)` + + SetBusinessNameNil sets the value for BusinessName to be an explicit nil + +### UnsetBusinessName +`func (o *CreateOAuthClientRequest) UnsetBusinessName()` + +UnsetBusinessName ensures that no value is present for BusinessName, not even an explicit nil +### GetHomepageUrl + +`func (o *CreateOAuthClientRequest) GetHomepageUrl() string` + +GetHomepageUrl returns the HomepageUrl field if non-nil, zero value otherwise. + +### GetHomepageUrlOk + +`func (o *CreateOAuthClientRequest) GetHomepageUrlOk() (*string, bool)` + +GetHomepageUrlOk returns a tuple with the HomepageUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHomepageUrl + +`func (o *CreateOAuthClientRequest) SetHomepageUrl(v string)` + +SetHomepageUrl sets HomepageUrl field to given value. + +### HasHomepageUrl + +`func (o *CreateOAuthClientRequest) HasHomepageUrl() bool` + +HasHomepageUrl returns a boolean if a field has been set. + +### SetHomepageUrlNil + +`func (o *CreateOAuthClientRequest) SetHomepageUrlNil(b bool)` + + SetHomepageUrlNil sets the value for HomepageUrl to be an explicit nil + +### UnsetHomepageUrl +`func (o *CreateOAuthClientRequest) UnsetHomepageUrl()` + +UnsetHomepageUrl ensures that no value is present for HomepageUrl, not even an explicit nil +### GetName + +`func (o *CreateOAuthClientRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateOAuthClientRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateOAuthClientRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *CreateOAuthClientRequest) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *CreateOAuthClientRequest) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *CreateOAuthClientRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateOAuthClientRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateOAuthClientRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *CreateOAuthClientRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CreateOAuthClientRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAccessTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *CreateOAuthClientRequest) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + + +### GetRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) GetRefreshTokenValiditySeconds() int32` + +GetRefreshTokenValiditySeconds returns the RefreshTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetRefreshTokenValiditySecondsOk + +`func (o *CreateOAuthClientRequest) GetRefreshTokenValiditySecondsOk() (*int32, bool)` + +GetRefreshTokenValiditySecondsOk returns a tuple with the RefreshTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) SetRefreshTokenValiditySeconds(v int32)` + +SetRefreshTokenValiditySeconds sets RefreshTokenValiditySeconds field to given value. + +### HasRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) HasRefreshTokenValiditySeconds() bool` + +HasRefreshTokenValiditySeconds returns a boolean if a field has been set. + +### GetRedirectUris + +`func (o *CreateOAuthClientRequest) GetRedirectUris() []string` + +GetRedirectUris returns the RedirectUris field if non-nil, zero value otherwise. + +### GetRedirectUrisOk + +`func (o *CreateOAuthClientRequest) GetRedirectUrisOk() (*[]string, bool)` + +GetRedirectUrisOk returns a tuple with the RedirectUris field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedirectUris + +`func (o *CreateOAuthClientRequest) SetRedirectUris(v []string)` + +SetRedirectUris sets RedirectUris field to given value. + +### HasRedirectUris + +`func (o *CreateOAuthClientRequest) HasRedirectUris() bool` + +HasRedirectUris returns a boolean if a field has been set. + +### SetRedirectUrisNil + +`func (o *CreateOAuthClientRequest) SetRedirectUrisNil(b bool)` + + SetRedirectUrisNil sets the value for RedirectUris to be an explicit nil + +### UnsetRedirectUris +`func (o *CreateOAuthClientRequest) UnsetRedirectUris()` + +UnsetRedirectUris ensures that no value is present for RedirectUris, not even an explicit nil +### GetGrantTypes + +`func (o *CreateOAuthClientRequest) GetGrantTypes() []GrantType` + +GetGrantTypes returns the GrantTypes field if non-nil, zero value otherwise. + +### GetGrantTypesOk + +`func (o *CreateOAuthClientRequest) GetGrantTypesOk() (*[]GrantType, bool)` + +GetGrantTypesOk returns a tuple with the GrantTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantTypes + +`func (o *CreateOAuthClientRequest) SetGrantTypes(v []GrantType)` + +SetGrantTypes sets GrantTypes field to given value. + + +### SetGrantTypesNil + +`func (o *CreateOAuthClientRequest) SetGrantTypesNil(b bool)` + + SetGrantTypesNil sets the value for GrantTypes to be an explicit nil + +### UnsetGrantTypes +`func (o *CreateOAuthClientRequest) UnsetGrantTypes()` + +UnsetGrantTypes ensures that no value is present for GrantTypes, not even an explicit nil +### GetAccessType + +`func (o *CreateOAuthClientRequest) GetAccessType() AccessType` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *CreateOAuthClientRequest) GetAccessTypeOk() (*AccessType, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *CreateOAuthClientRequest) SetAccessType(v AccessType)` + +SetAccessType sets AccessType field to given value. + + +### GetType + +`func (o *CreateOAuthClientRequest) GetType() ClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CreateOAuthClientRequest) GetTypeOk() (*ClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CreateOAuthClientRequest) SetType(v ClientType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CreateOAuthClientRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetInternal + +`func (o *CreateOAuthClientRequest) GetInternal() bool` + +GetInternal returns the Internal field if non-nil, zero value otherwise. + +### GetInternalOk + +`func (o *CreateOAuthClientRequest) GetInternalOk() (*bool, bool)` + +GetInternalOk returns a tuple with the Internal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternal + +`func (o *CreateOAuthClientRequest) SetInternal(v bool)` + +SetInternal sets Internal field to given value. + +### HasInternal + +`func (o *CreateOAuthClientRequest) HasInternal() bool` + +HasInternal returns a boolean if a field has been set. + +### GetEnabled + +`func (o *CreateOAuthClientRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CreateOAuthClientRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *CreateOAuthClientRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetStrongAuthSupported + +`func (o *CreateOAuthClientRequest) GetStrongAuthSupported() bool` + +GetStrongAuthSupported returns the StrongAuthSupported field if non-nil, zero value otherwise. + +### GetStrongAuthSupportedOk + +`func (o *CreateOAuthClientRequest) GetStrongAuthSupportedOk() (*bool, bool)` + +GetStrongAuthSupportedOk returns a tuple with the StrongAuthSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStrongAuthSupported + +`func (o *CreateOAuthClientRequest) SetStrongAuthSupported(v bool)` + +SetStrongAuthSupported sets StrongAuthSupported field to given value. + +### HasStrongAuthSupported + +`func (o *CreateOAuthClientRequest) HasStrongAuthSupported() bool` + +HasStrongAuthSupported returns a boolean if a field has been set. + +### GetClaimsSupported + +`func (o *CreateOAuthClientRequest) GetClaimsSupported() bool` + +GetClaimsSupported returns the ClaimsSupported field if non-nil, zero value otherwise. + +### GetClaimsSupportedOk + +`func (o *CreateOAuthClientRequest) GetClaimsSupportedOk() (*bool, bool)` + +GetClaimsSupportedOk returns a tuple with the ClaimsSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClaimsSupported + +`func (o *CreateOAuthClientRequest) SetClaimsSupported(v bool)` + +SetClaimsSupported sets ClaimsSupported field to given value. + +### HasClaimsSupported + +`func (o *CreateOAuthClientRequest) HasClaimsSupported() bool` + +HasClaimsSupported returns a boolean if a field has been set. + +### GetScope + +`func (o *CreateOAuthClientRequest) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *CreateOAuthClientRequest) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *CreateOAuthClientRequest) SetScope(v []string)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *CreateOAuthClientRequest) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### SetScopeNil + +`func (o *CreateOAuthClientRequest) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *CreateOAuthClientRequest) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CreateOAuthClientResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/CreateOAuthClientResponse.md new file mode 100644 index 000000000..d07298904 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CreateOAuthClientResponse.md @@ -0,0 +1,447 @@ +--- +id: v2025-create-o-auth-client-response +title: CreateOAuthClientResponse +pagination_label: CreateOAuthClientResponse +sidebar_label: CreateOAuthClientResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateOAuthClientResponse', 'V2025CreateOAuthClientResponse'] +slug: /tools/sdk/go/v2025/models/create-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientResponse', 'V2025CreateOAuthClientResponse'] +--- + +# CreateOAuthClientResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the OAuth client | +**Secret** | **string** | Secret of the OAuth client (This field is only returned on the intial create call.) | +**BusinessName** | **string** | The name of the business the API Client should belong to | +**HomepageUrl** | **string** | The homepage URL associated with the owner of the API Client | +**Name** | **string** | A human-readable name for the API Client | +**Description** | **string** | A description of the API Client | +**AccessTokenValiditySeconds** | **int32** | The number of seconds an access token generated for this API Client is valid for | +**RefreshTokenValiditySeconds** | **int32** | The number of seconds a refresh token generated for this API Client is valid for | +**RedirectUris** | **[]string** | A list of the approved redirect URIs used with the authorization_code flow | +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | +**AccessType** | [**AccessType**](access-type) | | +**Type** | [**ClientType**](client-type) | | +**Internal** | **bool** | An indicator of whether the API Client can be used for requests internal to IDN | +**Enabled** | **bool** | An indicator of whether the API Client is enabled for use | +**StrongAuthSupported** | **bool** | An indicator of whether the API Client supports strong authentication | +**ClaimsSupported** | **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | +**Created** | **SailPointTime** | The date and time, down to the millisecond, when the API Client was created | +**Modified** | **SailPointTime** | The date and time, down to the millisecond, when the API Client was last updated | +**Scope** | **[]string** | Scopes of the API Client. | + +## Methods + +### NewCreateOAuthClientResponse + +`func NewCreateOAuthClientResponse(id string, secret string, businessName string, homepageUrl string, name string, description string, accessTokenValiditySeconds int32, refreshTokenValiditySeconds int32, redirectUris []string, grantTypes []GrantType, accessType AccessType, type_ ClientType, internal bool, enabled bool, strongAuthSupported bool, claimsSupported bool, created SailPointTime, modified SailPointTime, scope []string, ) *CreateOAuthClientResponse` + +NewCreateOAuthClientResponse instantiates a new CreateOAuthClientResponse 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 + +### NewCreateOAuthClientResponseWithDefaults + +`func NewCreateOAuthClientResponseWithDefaults() *CreateOAuthClientResponse` + +NewCreateOAuthClientResponseWithDefaults instantiates a new CreateOAuthClientResponse 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 + +### GetId + +`func (o *CreateOAuthClientResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CreateOAuthClientResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CreateOAuthClientResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetSecret + +`func (o *CreateOAuthClientResponse) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *CreateOAuthClientResponse) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *CreateOAuthClientResponse) SetSecret(v string)` + +SetSecret sets Secret field to given value. + + +### GetBusinessName + +`func (o *CreateOAuthClientResponse) GetBusinessName() string` + +GetBusinessName returns the BusinessName field if non-nil, zero value otherwise. + +### GetBusinessNameOk + +`func (o *CreateOAuthClientResponse) GetBusinessNameOk() (*string, bool)` + +GetBusinessNameOk returns a tuple with the BusinessName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBusinessName + +`func (o *CreateOAuthClientResponse) SetBusinessName(v string)` + +SetBusinessName sets BusinessName field to given value. + + +### GetHomepageUrl + +`func (o *CreateOAuthClientResponse) GetHomepageUrl() string` + +GetHomepageUrl returns the HomepageUrl field if non-nil, zero value otherwise. + +### GetHomepageUrlOk + +`func (o *CreateOAuthClientResponse) GetHomepageUrlOk() (*string, bool)` + +GetHomepageUrlOk returns a tuple with the HomepageUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHomepageUrl + +`func (o *CreateOAuthClientResponse) SetHomepageUrl(v string)` + +SetHomepageUrl sets HomepageUrl field to given value. + + +### GetName + +`func (o *CreateOAuthClientResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateOAuthClientResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateOAuthClientResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CreateOAuthClientResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateOAuthClientResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateOAuthClientResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetAccessTokenValiditySeconds + +`func (o *CreateOAuthClientResponse) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *CreateOAuthClientResponse) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *CreateOAuthClientResponse) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + + +### GetRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientResponse) GetRefreshTokenValiditySeconds() int32` + +GetRefreshTokenValiditySeconds returns the RefreshTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetRefreshTokenValiditySecondsOk + +`func (o *CreateOAuthClientResponse) GetRefreshTokenValiditySecondsOk() (*int32, bool)` + +GetRefreshTokenValiditySecondsOk returns a tuple with the RefreshTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientResponse) SetRefreshTokenValiditySeconds(v int32)` + +SetRefreshTokenValiditySeconds sets RefreshTokenValiditySeconds field to given value. + + +### GetRedirectUris + +`func (o *CreateOAuthClientResponse) GetRedirectUris() []string` + +GetRedirectUris returns the RedirectUris field if non-nil, zero value otherwise. + +### GetRedirectUrisOk + +`func (o *CreateOAuthClientResponse) GetRedirectUrisOk() (*[]string, bool)` + +GetRedirectUrisOk returns a tuple with the RedirectUris field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedirectUris + +`func (o *CreateOAuthClientResponse) SetRedirectUris(v []string)` + +SetRedirectUris sets RedirectUris field to given value. + + +### GetGrantTypes + +`func (o *CreateOAuthClientResponse) GetGrantTypes() []GrantType` + +GetGrantTypes returns the GrantTypes field if non-nil, zero value otherwise. + +### GetGrantTypesOk + +`func (o *CreateOAuthClientResponse) GetGrantTypesOk() (*[]GrantType, bool)` + +GetGrantTypesOk returns a tuple with the GrantTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantTypes + +`func (o *CreateOAuthClientResponse) SetGrantTypes(v []GrantType)` + +SetGrantTypes sets GrantTypes field to given value. + + +### GetAccessType + +`func (o *CreateOAuthClientResponse) GetAccessType() AccessType` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *CreateOAuthClientResponse) GetAccessTypeOk() (*AccessType, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *CreateOAuthClientResponse) SetAccessType(v AccessType)` + +SetAccessType sets AccessType field to given value. + + +### GetType + +`func (o *CreateOAuthClientResponse) GetType() ClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CreateOAuthClientResponse) GetTypeOk() (*ClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CreateOAuthClientResponse) SetType(v ClientType)` + +SetType sets Type field to given value. + + +### GetInternal + +`func (o *CreateOAuthClientResponse) GetInternal() bool` + +GetInternal returns the Internal field if non-nil, zero value otherwise. + +### GetInternalOk + +`func (o *CreateOAuthClientResponse) GetInternalOk() (*bool, bool)` + +GetInternalOk returns a tuple with the Internal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternal + +`func (o *CreateOAuthClientResponse) SetInternal(v bool)` + +SetInternal sets Internal field to given value. + + +### GetEnabled + +`func (o *CreateOAuthClientResponse) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CreateOAuthClientResponse) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *CreateOAuthClientResponse) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetStrongAuthSupported + +`func (o *CreateOAuthClientResponse) GetStrongAuthSupported() bool` + +GetStrongAuthSupported returns the StrongAuthSupported field if non-nil, zero value otherwise. + +### GetStrongAuthSupportedOk + +`func (o *CreateOAuthClientResponse) GetStrongAuthSupportedOk() (*bool, bool)` + +GetStrongAuthSupportedOk returns a tuple with the StrongAuthSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStrongAuthSupported + +`func (o *CreateOAuthClientResponse) SetStrongAuthSupported(v bool)` + +SetStrongAuthSupported sets StrongAuthSupported field to given value. + + +### GetClaimsSupported + +`func (o *CreateOAuthClientResponse) GetClaimsSupported() bool` + +GetClaimsSupported returns the ClaimsSupported field if non-nil, zero value otherwise. + +### GetClaimsSupportedOk + +`func (o *CreateOAuthClientResponse) GetClaimsSupportedOk() (*bool, bool)` + +GetClaimsSupportedOk returns a tuple with the ClaimsSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClaimsSupported + +`func (o *CreateOAuthClientResponse) SetClaimsSupported(v bool)` + +SetClaimsSupported sets ClaimsSupported field to given value. + + +### GetCreated + +`func (o *CreateOAuthClientResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CreateOAuthClientResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CreateOAuthClientResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CreateOAuthClientResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CreateOAuthClientResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CreateOAuthClientResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetScope + +`func (o *CreateOAuthClientResponse) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *CreateOAuthClientResponse) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *CreateOAuthClientResponse) SetScope(v []string)` + +SetScope sets Scope field to given value. + + +### SetScopeNil + +`func (o *CreateOAuthClientResponse) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *CreateOAuthClientResponse) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CreatePersonalAccessTokenRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/CreatePersonalAccessTokenRequest.md new file mode 100644 index 000000000..ff823c8c6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CreatePersonalAccessTokenRequest.md @@ -0,0 +1,121 @@ +--- +id: v2025-create-personal-access-token-request +title: CreatePersonalAccessTokenRequest +pagination_label: CreatePersonalAccessTokenRequest +sidebar_label: CreatePersonalAccessTokenRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreatePersonalAccessTokenRequest', 'V2025CreatePersonalAccessTokenRequest'] +slug: /tools/sdk/go/v2025/models/create-personal-access-token-request +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenRequest', 'V2025CreatePersonalAccessTokenRequest'] +--- + +# CreatePersonalAccessTokenRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | +**Scope** | Pointer to **[]string** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it. | [optional] +**AccessTokenValiditySeconds** | Pointer to **int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] + +## Methods + +### NewCreatePersonalAccessTokenRequest + +`func NewCreatePersonalAccessTokenRequest(name string, ) *CreatePersonalAccessTokenRequest` + +NewCreatePersonalAccessTokenRequest instantiates a new CreatePersonalAccessTokenRequest 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 + +### NewCreatePersonalAccessTokenRequestWithDefaults + +`func NewCreatePersonalAccessTokenRequestWithDefaults() *CreatePersonalAccessTokenRequest` + +NewCreatePersonalAccessTokenRequestWithDefaults instantiates a new CreatePersonalAccessTokenRequest 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 + +### GetName + +`func (o *CreatePersonalAccessTokenRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreatePersonalAccessTokenRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreatePersonalAccessTokenRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetScope + +`func (o *CreatePersonalAccessTokenRequest) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *CreatePersonalAccessTokenRequest) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *CreatePersonalAccessTokenRequest) SetScope(v []string)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *CreatePersonalAccessTokenRequest) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### SetScopeNil + +`func (o *CreatePersonalAccessTokenRequest) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *CreatePersonalAccessTokenRequest) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil +### GetAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenRequest) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *CreatePersonalAccessTokenRequest) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenRequest) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + +### HasAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenRequest) HasAccessTokenValiditySeconds() bool` + +HasAccessTokenValiditySeconds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CreatePersonalAccessTokenResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/CreatePersonalAccessTokenResponse.md new file mode 100644 index 000000000..630403523 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CreatePersonalAccessTokenResponse.md @@ -0,0 +1,195 @@ +--- +id: v2025-create-personal-access-token-response +title: CreatePersonalAccessTokenResponse +pagination_label: CreatePersonalAccessTokenResponse +sidebar_label: CreatePersonalAccessTokenResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreatePersonalAccessTokenResponse', 'V2025CreatePersonalAccessTokenResponse'] +slug: /tools/sdk/go/v2025/models/create-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenResponse', 'V2025CreatePersonalAccessTokenResponse'] +--- + +# CreatePersonalAccessTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The ID of the personal access token (to be used as the username for Basic Auth). | +**Secret** | **string** | The secret of the personal access token (to be used as the password for Basic Auth). | +**Scope** | **[]string** | Scopes of the personal access token. | +**Name** | **string** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | +**Owner** | [**PatOwner**](pat-owner) | | +**Created** | **SailPointTime** | The date and time, down to the millisecond, when this personal access token was created. | +**AccessTokenValiditySeconds** | **int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | + +## Methods + +### NewCreatePersonalAccessTokenResponse + +`func NewCreatePersonalAccessTokenResponse(id string, secret string, scope []string, name string, owner PatOwner, created SailPointTime, accessTokenValiditySeconds int32, ) *CreatePersonalAccessTokenResponse` + +NewCreatePersonalAccessTokenResponse instantiates a new CreatePersonalAccessTokenResponse 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 + +### NewCreatePersonalAccessTokenResponseWithDefaults + +`func NewCreatePersonalAccessTokenResponseWithDefaults() *CreatePersonalAccessTokenResponse` + +NewCreatePersonalAccessTokenResponseWithDefaults instantiates a new CreatePersonalAccessTokenResponse 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 + +### GetId + +`func (o *CreatePersonalAccessTokenResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CreatePersonalAccessTokenResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CreatePersonalAccessTokenResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetSecret + +`func (o *CreatePersonalAccessTokenResponse) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *CreatePersonalAccessTokenResponse) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *CreatePersonalAccessTokenResponse) SetSecret(v string)` + +SetSecret sets Secret field to given value. + + +### GetScope + +`func (o *CreatePersonalAccessTokenResponse) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *CreatePersonalAccessTokenResponse) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *CreatePersonalAccessTokenResponse) SetScope(v []string)` + +SetScope sets Scope field to given value. + + +### SetScopeNil + +`func (o *CreatePersonalAccessTokenResponse) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *CreatePersonalAccessTokenResponse) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil +### GetName + +`func (o *CreatePersonalAccessTokenResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreatePersonalAccessTokenResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreatePersonalAccessTokenResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetOwner + +`func (o *CreatePersonalAccessTokenResponse) GetOwner() PatOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CreatePersonalAccessTokenResponse) GetOwnerOk() (*PatOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CreatePersonalAccessTokenResponse) SetOwner(v PatOwner)` + +SetOwner sets Owner field to given value. + + +### GetCreated + +`func (o *CreatePersonalAccessTokenResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CreatePersonalAccessTokenResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CreatePersonalAccessTokenResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenResponse) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *CreatePersonalAccessTokenResponse) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenResponse) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CreateSavedSearchRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/CreateSavedSearchRequest.md new file mode 100644 index 000000000..b2f7dd45c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CreateSavedSearchRequest.md @@ -0,0 +1,384 @@ +--- +id: v2025-create-saved-search-request +title: CreateSavedSearchRequest +pagination_label: CreateSavedSearchRequest +sidebar_label: CreateSavedSearchRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateSavedSearchRequest', 'V2025CreateSavedSearchRequest'] +slug: /tools/sdk/go/v2025/models/create-saved-search-request +tags: ['SDK', 'Software Development Kit', 'CreateSavedSearchRequest', 'V2025CreateSavedSearchRequest'] +--- + +# CreateSavedSearchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the saved search. | [optional] +**Description** | Pointer to **NullableString** | The description of the saved search. | [optional] +**Created** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | +**Columns** | Pointer to [**map[string][]Column**](https://go.dev/tour/moretypes/6) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**Query** | **string** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | +**Fields** | Pointer to **[]string** | The fields to be searched against in a multi-field query. | [optional] +**OrderBy** | Pointer to **map[string][]string** | Sort by index. This takes precedence over the `sort` property. | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. | [optional] +**Filters** | Pointer to [**NullableSavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] + +## Methods + +### NewCreateSavedSearchRequest + +`func NewCreateSavedSearchRequest(indices []Index, query string, ) *CreateSavedSearchRequest` + +NewCreateSavedSearchRequest instantiates a new CreateSavedSearchRequest 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 + +### NewCreateSavedSearchRequestWithDefaults + +`func NewCreateSavedSearchRequestWithDefaults() *CreateSavedSearchRequest` + +NewCreateSavedSearchRequestWithDefaults instantiates a new CreateSavedSearchRequest 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 + +### GetName + +`func (o *CreateSavedSearchRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateSavedSearchRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateSavedSearchRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CreateSavedSearchRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *CreateSavedSearchRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateSavedSearchRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateSavedSearchRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CreateSavedSearchRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *CreateSavedSearchRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CreateSavedSearchRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCreated + +`func (o *CreateSavedSearchRequest) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CreateSavedSearchRequest) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CreateSavedSearchRequest) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CreateSavedSearchRequest) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *CreateSavedSearchRequest) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *CreateSavedSearchRequest) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *CreateSavedSearchRequest) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CreateSavedSearchRequest) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CreateSavedSearchRequest) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CreateSavedSearchRequest) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CreateSavedSearchRequest) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CreateSavedSearchRequest) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetIndices + +`func (o *CreateSavedSearchRequest) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *CreateSavedSearchRequest) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *CreateSavedSearchRequest) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + + +### GetColumns + +`func (o *CreateSavedSearchRequest) GetColumns() map[string][]Column` + +GetColumns returns the Columns field if non-nil, zero value otherwise. + +### GetColumnsOk + +`func (o *CreateSavedSearchRequest) GetColumnsOk() (*map[string][]Column, bool)` + +GetColumnsOk returns a tuple with the Columns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumns + +`func (o *CreateSavedSearchRequest) SetColumns(v map[string][]Column)` + +SetColumns sets Columns field to given value. + +### HasColumns + +`func (o *CreateSavedSearchRequest) HasColumns() bool` + +HasColumns returns a boolean if a field has been set. + +### GetQuery + +`func (o *CreateSavedSearchRequest) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *CreateSavedSearchRequest) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *CreateSavedSearchRequest) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetFields + +`func (o *CreateSavedSearchRequest) GetFields() []string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *CreateSavedSearchRequest) GetFieldsOk() (*[]string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *CreateSavedSearchRequest) SetFields(v []string)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *CreateSavedSearchRequest) HasFields() bool` + +HasFields returns a boolean if a field has been set. + +### SetFieldsNil + +`func (o *CreateSavedSearchRequest) SetFieldsNil(b bool)` + + SetFieldsNil sets the value for Fields to be an explicit nil + +### UnsetFields +`func (o *CreateSavedSearchRequest) UnsetFields()` + +UnsetFields ensures that no value is present for Fields, not even an explicit nil +### GetOrderBy + +`func (o *CreateSavedSearchRequest) GetOrderBy() map[string][]string` + +GetOrderBy returns the OrderBy field if non-nil, zero value otherwise. + +### GetOrderByOk + +`func (o *CreateSavedSearchRequest) GetOrderByOk() (*map[string][]string, bool)` + +GetOrderByOk returns a tuple with the OrderBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderBy + +`func (o *CreateSavedSearchRequest) SetOrderBy(v map[string][]string)` + +SetOrderBy sets OrderBy field to given value. + +### HasOrderBy + +`func (o *CreateSavedSearchRequest) HasOrderBy() bool` + +HasOrderBy returns a boolean if a field has been set. + +### SetOrderByNil + +`func (o *CreateSavedSearchRequest) SetOrderByNil(b bool)` + + SetOrderByNil sets the value for OrderBy to be an explicit nil + +### UnsetOrderBy +`func (o *CreateSavedSearchRequest) UnsetOrderBy()` + +UnsetOrderBy ensures that no value is present for OrderBy, not even an explicit nil +### GetSort + +`func (o *CreateSavedSearchRequest) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *CreateSavedSearchRequest) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *CreateSavedSearchRequest) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *CreateSavedSearchRequest) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### SetSortNil + +`func (o *CreateSavedSearchRequest) SetSortNil(b bool)` + + SetSortNil sets the value for Sort to be an explicit nil + +### UnsetSort +`func (o *CreateSavedSearchRequest) UnsetSort()` + +UnsetSort ensures that no value is present for Sort, not even an explicit nil +### GetFilters + +`func (o *CreateSavedSearchRequest) GetFilters() SavedSearchDetailFilters` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *CreateSavedSearchRequest) GetFiltersOk() (*SavedSearchDetailFilters, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *CreateSavedSearchRequest) SetFilters(v SavedSearchDetailFilters)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *CreateSavedSearchRequest) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### SetFiltersNil + +`func (o *CreateSavedSearchRequest) SetFiltersNil(b bool)` + + SetFiltersNil sets the value for Filters to be an explicit nil + +### UnsetFilters +`func (o *CreateSavedSearchRequest) UnsetFilters()` + +UnsetFilters ensures that no value is present for Filters, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CreateScheduledSearchRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/CreateScheduledSearchRequest.md new file mode 100644 index 000000000..c2ec2634e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CreateScheduledSearchRequest.md @@ -0,0 +1,323 @@ +--- +id: v2025-create-scheduled-search-request +title: CreateScheduledSearchRequest +pagination_label: CreateScheduledSearchRequest +sidebar_label: CreateScheduledSearchRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateScheduledSearchRequest', 'V2025CreateScheduledSearchRequest'] +slug: /tools/sdk/go/v2025/models/create-scheduled-search-request +tags: ['SDK', 'Software Development Kit', 'CreateScheduledSearchRequest', 'V2025CreateScheduledSearchRequest'] +--- + +# CreateScheduledSearchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **NullableString** | The name of the scheduled search. | [optional] +**Description** | Pointer to **NullableString** | The description of the scheduled search. | [optional] +**SavedSearchId** | **string** | The ID of the saved search that will be executed. | +**Created** | Pointer to **NullableTime** | The date the scheduled search was initially created. | [optional] [readonly] +**Modified** | Pointer to **NullableTime** | The last date the scheduled search was modified. | [optional] [readonly] +**Schedule** | [**Schedule2**](schedule2) | | +**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | +**Enabled** | Pointer to **bool** | Indicates if the scheduled search is enabled. | [optional] [default to false] +**EmailEmptyResults** | Pointer to **bool** | Indicates if email generation should occur when search returns no results. | [optional] [default to false] +**DisplayQueryDetails** | Pointer to **bool** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to false] + +## Methods + +### NewCreateScheduledSearchRequest + +`func NewCreateScheduledSearchRequest(savedSearchId string, schedule Schedule2, recipients []SearchScheduleRecipientsInner, ) *CreateScheduledSearchRequest` + +NewCreateScheduledSearchRequest instantiates a new CreateScheduledSearchRequest 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 + +### NewCreateScheduledSearchRequestWithDefaults + +`func NewCreateScheduledSearchRequestWithDefaults() *CreateScheduledSearchRequest` + +NewCreateScheduledSearchRequestWithDefaults instantiates a new CreateScheduledSearchRequest 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 + +### GetName + +`func (o *CreateScheduledSearchRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateScheduledSearchRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateScheduledSearchRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CreateScheduledSearchRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *CreateScheduledSearchRequest) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *CreateScheduledSearchRequest) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *CreateScheduledSearchRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateScheduledSearchRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateScheduledSearchRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CreateScheduledSearchRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *CreateScheduledSearchRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CreateScheduledSearchRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSavedSearchId + +`func (o *CreateScheduledSearchRequest) GetSavedSearchId() string` + +GetSavedSearchId returns the SavedSearchId field if non-nil, zero value otherwise. + +### GetSavedSearchIdOk + +`func (o *CreateScheduledSearchRequest) GetSavedSearchIdOk() (*string, bool)` + +GetSavedSearchIdOk returns a tuple with the SavedSearchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSavedSearchId + +`func (o *CreateScheduledSearchRequest) SetSavedSearchId(v string)` + +SetSavedSearchId sets SavedSearchId field to given value. + + +### GetCreated + +`func (o *CreateScheduledSearchRequest) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CreateScheduledSearchRequest) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CreateScheduledSearchRequest) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CreateScheduledSearchRequest) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *CreateScheduledSearchRequest) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *CreateScheduledSearchRequest) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *CreateScheduledSearchRequest) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CreateScheduledSearchRequest) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CreateScheduledSearchRequest) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CreateScheduledSearchRequest) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CreateScheduledSearchRequest) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CreateScheduledSearchRequest) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSchedule + +`func (o *CreateScheduledSearchRequest) GetSchedule() Schedule2` + +GetSchedule returns the Schedule field if non-nil, zero value otherwise. + +### GetScheduleOk + +`func (o *CreateScheduledSearchRequest) GetScheduleOk() (*Schedule2, bool)` + +GetScheduleOk returns a tuple with the Schedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchedule + +`func (o *CreateScheduledSearchRequest) SetSchedule(v Schedule2)` + +SetSchedule sets Schedule field to given value. + + +### GetRecipients + +`func (o *CreateScheduledSearchRequest) GetRecipients() []SearchScheduleRecipientsInner` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *CreateScheduledSearchRequest) GetRecipientsOk() (*[]SearchScheduleRecipientsInner, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *CreateScheduledSearchRequest) SetRecipients(v []SearchScheduleRecipientsInner)` + +SetRecipients sets Recipients field to given value. + + +### GetEnabled + +`func (o *CreateScheduledSearchRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CreateScheduledSearchRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *CreateScheduledSearchRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *CreateScheduledSearchRequest) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEmailEmptyResults + +`func (o *CreateScheduledSearchRequest) GetEmailEmptyResults() bool` + +GetEmailEmptyResults returns the EmailEmptyResults field if non-nil, zero value otherwise. + +### GetEmailEmptyResultsOk + +`func (o *CreateScheduledSearchRequest) GetEmailEmptyResultsOk() (*bool, bool)` + +GetEmailEmptyResultsOk returns a tuple with the EmailEmptyResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEmptyResults + +`func (o *CreateScheduledSearchRequest) SetEmailEmptyResults(v bool)` + +SetEmailEmptyResults sets EmailEmptyResults field to given value. + +### HasEmailEmptyResults + +`func (o *CreateScheduledSearchRequest) HasEmailEmptyResults() bool` + +HasEmailEmptyResults returns a boolean if a field has been set. + +### GetDisplayQueryDetails + +`func (o *CreateScheduledSearchRequest) GetDisplayQueryDetails() bool` + +GetDisplayQueryDetails returns the DisplayQueryDetails field if non-nil, zero value otherwise. + +### GetDisplayQueryDetailsOk + +`func (o *CreateScheduledSearchRequest) GetDisplayQueryDetailsOk() (*bool, bool)` + +GetDisplayQueryDetailsOk returns a tuple with the DisplayQueryDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayQueryDetails + +`func (o *CreateScheduledSearchRequest) SetDisplayQueryDetails(v bool)` + +SetDisplayQueryDetails sets DisplayQueryDetails field to given value. + +### HasDisplayQueryDetails + +`func (o *CreateScheduledSearchRequest) HasDisplayQueryDetails() bool` + +HasDisplayQueryDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CreateUploadedConfigurationRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/CreateUploadedConfigurationRequest.md new file mode 100644 index 000000000..85f93e04f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CreateUploadedConfigurationRequest.md @@ -0,0 +1,80 @@ +--- +id: v2025-create-uploaded-configuration-request +title: CreateUploadedConfigurationRequest +pagination_label: CreateUploadedConfigurationRequest +sidebar_label: CreateUploadedConfigurationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateUploadedConfigurationRequest', 'V2025CreateUploadedConfigurationRequest'] +slug: /tools/sdk/go/v2025/models/create-uploaded-configuration-request +tags: ['SDK', 'Software Development Kit', 'CreateUploadedConfigurationRequest', 'V2025CreateUploadedConfigurationRequest'] +--- + +# CreateUploadedConfigurationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | ***os.File** | JSON file containing the objects to be imported. | +**Name** | **string** | Name that will be assigned to the uploaded configuration file. | + +## Methods + +### NewCreateUploadedConfigurationRequest + +`func NewCreateUploadedConfigurationRequest(data *os.File, name string, ) *CreateUploadedConfigurationRequest` + +NewCreateUploadedConfigurationRequest instantiates a new CreateUploadedConfigurationRequest 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 + +### NewCreateUploadedConfigurationRequestWithDefaults + +`func NewCreateUploadedConfigurationRequestWithDefaults() *CreateUploadedConfigurationRequest` + +NewCreateUploadedConfigurationRequestWithDefaults instantiates a new CreateUploadedConfigurationRequest 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 + +### GetData + +`func (o *CreateUploadedConfigurationRequest) GetData() *os.File` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *CreateUploadedConfigurationRequest) GetDataOk() (**os.File, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *CreateUploadedConfigurationRequest) SetData(v *os.File)` + +SetData sets Data field to given value. + + +### GetName + +`func (o *CreateUploadedConfigurationRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateUploadedConfigurationRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateUploadedConfigurationRequest) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CreateWorkflowRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/CreateWorkflowRequest.md new file mode 100644 index 000000000..e076a13ce --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CreateWorkflowRequest.md @@ -0,0 +1,189 @@ +--- +id: v2025-create-workflow-request +title: CreateWorkflowRequest +pagination_label: CreateWorkflowRequest +sidebar_label: CreateWorkflowRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateWorkflowRequest', 'V2025CreateWorkflowRequest'] +slug: /tools/sdk/go/v2025/models/create-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateWorkflowRequest', 'V2025CreateWorkflowRequest'] +--- + +# CreateWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the workflow | +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **string** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **bool** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] + +## Methods + +### NewCreateWorkflowRequest + +`func NewCreateWorkflowRequest(name string, ) *CreateWorkflowRequest` + +NewCreateWorkflowRequest instantiates a new CreateWorkflowRequest 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 + +### NewCreateWorkflowRequestWithDefaults + +`func NewCreateWorkflowRequestWithDefaults() *CreateWorkflowRequest` + +NewCreateWorkflowRequestWithDefaults instantiates a new CreateWorkflowRequest 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 + +### GetName + +`func (o *CreateWorkflowRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateWorkflowRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateWorkflowRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetOwner + +`func (o *CreateWorkflowRequest) GetOwner() WorkflowBodyOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CreateWorkflowRequest) GetOwnerOk() (*WorkflowBodyOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CreateWorkflowRequest) SetOwner(v WorkflowBodyOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *CreateWorkflowRequest) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDescription + +`func (o *CreateWorkflowRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateWorkflowRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateWorkflowRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CreateWorkflowRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDefinition + +`func (o *CreateWorkflowRequest) GetDefinition() WorkflowDefinition` + +GetDefinition returns the Definition field if non-nil, zero value otherwise. + +### GetDefinitionOk + +`func (o *CreateWorkflowRequest) GetDefinitionOk() (*WorkflowDefinition, bool)` + +GetDefinitionOk returns a tuple with the Definition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefinition + +`func (o *CreateWorkflowRequest) SetDefinition(v WorkflowDefinition)` + +SetDefinition sets Definition field to given value. + +### HasDefinition + +`func (o *CreateWorkflowRequest) HasDefinition() bool` + +HasDefinition returns a boolean if a field has been set. + +### GetEnabled + +`func (o *CreateWorkflowRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CreateWorkflowRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *CreateWorkflowRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *CreateWorkflowRequest) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetTrigger + +`func (o *CreateWorkflowRequest) GetTrigger() WorkflowTrigger` + +GetTrigger returns the Trigger field if non-nil, zero value otherwise. + +### GetTriggerOk + +`func (o *CreateWorkflowRequest) GetTriggerOk() (*WorkflowTrigger, bool)` + +GetTriggerOk returns a tuple with the Trigger field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrigger + +`func (o *CreateWorkflowRequest) SetTrigger(v WorkflowTrigger)` + +SetTrigger sets Trigger field to given value. + +### HasTrigger + +`func (o *CreateWorkflowRequest) HasTrigger() bool` + +HasTrigger returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CriteriaType.md b/docs/tools/sdk/go/Reference/V2025/Models/CriteriaType.md new file mode 100644 index 000000000..9ff33d148 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CriteriaType.md @@ -0,0 +1,39 @@ +--- +id: v2025-criteria-type +title: CriteriaType +pagination_label: CriteriaType +sidebar_label: CriteriaType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CriteriaType', 'V2025CriteriaType'] +slug: /tools/sdk/go/v2025/models/criteria-type +tags: ['SDK', 'Software Development Kit', 'CriteriaType', 'V2025CriteriaType'] +--- + +# CriteriaType + +## Enum + + +* `COMPOSITE` (value: `"COMPOSITE"`) + +* `ROLE` (value: `"ROLE"`) + +* `IDENTITY` (value: `"IDENTITY"`) + +* `IDENTITY_ATTRIBUTE` (value: `"IDENTITY_ATTRIBUTE"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `SOURCE` (value: `"SOURCE"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `AGGREGATED_ENTITLEMENT` (value: `"AGGREGATED_ENTITLEMENT"`) + +* `INVALID_CERTIFIABLE_ENTITY` (value: `"INVALID_CERTIFIABLE_ENTITY"`) + +* `INVALID_CERTIFIABLE_BUNDLE` (value: `"INVALID_CERTIFIABLE_BUNDLE"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/CustomPasswordInstruction.md b/docs/tools/sdk/go/Reference/V2025/Models/CustomPasswordInstruction.md new file mode 100644 index 000000000..ee2c8c5d8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/CustomPasswordInstruction.md @@ -0,0 +1,116 @@ +--- +id: v2025-custom-password-instruction +title: CustomPasswordInstruction +pagination_label: CustomPasswordInstruction +sidebar_label: CustomPasswordInstruction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CustomPasswordInstruction', 'V2025CustomPasswordInstruction'] +slug: /tools/sdk/go/v2025/models/custom-password-instruction +tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstruction', 'V2025CustomPasswordInstruction'] +--- + +# CustomPasswordInstruction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PageId** | Pointer to **string** | The page ID that represents the page for forget user name, reset password and unlock account flow. | [optional] +**PageContent** | Pointer to **string** | The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like `...` clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: `link`. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target. | [optional] +**Locale** | Pointer to **string** | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". | [optional] + +## Methods + +### NewCustomPasswordInstruction + +`func NewCustomPasswordInstruction() *CustomPasswordInstruction` + +NewCustomPasswordInstruction instantiates a new CustomPasswordInstruction 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 + +### NewCustomPasswordInstructionWithDefaults + +`func NewCustomPasswordInstructionWithDefaults() *CustomPasswordInstruction` + +NewCustomPasswordInstructionWithDefaults instantiates a new CustomPasswordInstruction 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 + +### GetPageId + +`func (o *CustomPasswordInstruction) GetPageId() string` + +GetPageId returns the PageId field if non-nil, zero value otherwise. + +### GetPageIdOk + +`func (o *CustomPasswordInstruction) GetPageIdOk() (*string, bool)` + +GetPageIdOk returns a tuple with the PageId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPageId + +`func (o *CustomPasswordInstruction) SetPageId(v string)` + +SetPageId sets PageId field to given value. + +### HasPageId + +`func (o *CustomPasswordInstruction) HasPageId() bool` + +HasPageId returns a boolean if a field has been set. + +### GetPageContent + +`func (o *CustomPasswordInstruction) GetPageContent() string` + +GetPageContent returns the PageContent field if non-nil, zero value otherwise. + +### GetPageContentOk + +`func (o *CustomPasswordInstruction) GetPageContentOk() (*string, bool)` + +GetPageContentOk returns a tuple with the PageContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPageContent + +`func (o *CustomPasswordInstruction) SetPageContent(v string)` + +SetPageContent sets PageContent field to given value. + +### HasPageContent + +`func (o *CustomPasswordInstruction) HasPageContent() bool` + +HasPageContent returns a boolean if a field has been set. + +### GetLocale + +`func (o *CustomPasswordInstruction) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *CustomPasswordInstruction) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *CustomPasswordInstruction) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *CustomPasswordInstruction) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DataAccess.md b/docs/tools/sdk/go/Reference/V2025/Models/DataAccess.md new file mode 100644 index 000000000..d10930378 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DataAccess.md @@ -0,0 +1,116 @@ +--- +id: v2025-data-access +title: DataAccess +pagination_label: DataAccess +sidebar_label: DataAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DataAccess', 'V2025DataAccess'] +slug: /tools/sdk/go/v2025/models/data-access +tags: ['SDK', 'Software Development Kit', 'DataAccess', 'V2025DataAccess'] +--- + +# DataAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policies** | Pointer to [**[]DataAccessPoliciesInner**](data-access-policies-inner) | List of classification policies that apply to resources the entitlement \\ groups has access to | [optional] +**Categories** | Pointer to [**[]DataAccessCategoriesInner**](data-access-categories-inner) | List of classification categories that apply to resources the entitlement \\ groups has access to | [optional] +**ImpactScore** | Pointer to [**DataAccessImpactScore**](data-access-impact-score) | | [optional] + +## Methods + +### NewDataAccess + +`func NewDataAccess() *DataAccess` + +NewDataAccess instantiates a new DataAccess 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 + +### NewDataAccessWithDefaults + +`func NewDataAccessWithDefaults() *DataAccess` + +NewDataAccessWithDefaults instantiates a new DataAccess 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 + +### GetPolicies + +`func (o *DataAccess) GetPolicies() []DataAccessPoliciesInner` + +GetPolicies returns the Policies field if non-nil, zero value otherwise. + +### GetPoliciesOk + +`func (o *DataAccess) GetPoliciesOk() (*[]DataAccessPoliciesInner, bool)` + +GetPoliciesOk returns a tuple with the Policies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicies + +`func (o *DataAccess) SetPolicies(v []DataAccessPoliciesInner)` + +SetPolicies sets Policies field to given value. + +### HasPolicies + +`func (o *DataAccess) HasPolicies() bool` + +HasPolicies returns a boolean if a field has been set. + +### GetCategories + +`func (o *DataAccess) GetCategories() []DataAccessCategoriesInner` + +GetCategories returns the Categories field if non-nil, zero value otherwise. + +### GetCategoriesOk + +`func (o *DataAccess) GetCategoriesOk() (*[]DataAccessCategoriesInner, bool)` + +GetCategoriesOk returns a tuple with the Categories field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCategories + +`func (o *DataAccess) SetCategories(v []DataAccessCategoriesInner)` + +SetCategories sets Categories field to given value. + +### HasCategories + +`func (o *DataAccess) HasCategories() bool` + +HasCategories returns a boolean if a field has been set. + +### GetImpactScore + +`func (o *DataAccess) GetImpactScore() DataAccessImpactScore` + +GetImpactScore returns the ImpactScore field if non-nil, zero value otherwise. + +### GetImpactScoreOk + +`func (o *DataAccess) GetImpactScoreOk() (*DataAccessImpactScore, bool)` + +GetImpactScoreOk returns a tuple with the ImpactScore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImpactScore + +`func (o *DataAccess) SetImpactScore(v DataAccessImpactScore)` + +SetImpactScore sets ImpactScore field to given value. + +### HasImpactScore + +`func (o *DataAccess) HasImpactScore() bool` + +HasImpactScore returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DataAccessCategoriesInner.md b/docs/tools/sdk/go/Reference/V2025/Models/DataAccessCategoriesInner.md new file mode 100644 index 000000000..a33d650c3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DataAccessCategoriesInner.md @@ -0,0 +1,90 @@ +--- +id: v2025-data-access-categories-inner +title: DataAccessCategoriesInner +pagination_label: DataAccessCategoriesInner +sidebar_label: DataAccessCategoriesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DataAccessCategoriesInner', 'V2025DataAccessCategoriesInner'] +slug: /tools/sdk/go/v2025/models/data-access-categories-inner +tags: ['SDK', 'Software Development Kit', 'DataAccessCategoriesInner', 'V2025DataAccessCategoriesInner'] +--- + +# DataAccessCategoriesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | Value of the category | [optional] +**MatchCount** | Pointer to **int32** | Number of matched for each category | [optional] + +## Methods + +### NewDataAccessCategoriesInner + +`func NewDataAccessCategoriesInner() *DataAccessCategoriesInner` + +NewDataAccessCategoriesInner instantiates a new DataAccessCategoriesInner 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 + +### NewDataAccessCategoriesInnerWithDefaults + +`func NewDataAccessCategoriesInnerWithDefaults() *DataAccessCategoriesInner` + +NewDataAccessCategoriesInnerWithDefaults instantiates a new DataAccessCategoriesInner 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 + +### GetValue + +`func (o *DataAccessCategoriesInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *DataAccessCategoriesInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *DataAccessCategoriesInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *DataAccessCategoriesInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetMatchCount + +`func (o *DataAccessCategoriesInner) GetMatchCount() int32` + +GetMatchCount returns the MatchCount field if non-nil, zero value otherwise. + +### GetMatchCountOk + +`func (o *DataAccessCategoriesInner) GetMatchCountOk() (*int32, bool)` + +GetMatchCountOk returns a tuple with the MatchCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchCount + +`func (o *DataAccessCategoriesInner) SetMatchCount(v int32)` + +SetMatchCount sets MatchCount field to given value. + +### HasMatchCount + +`func (o *DataAccessCategoriesInner) HasMatchCount() bool` + +HasMatchCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DataAccessImpactScore.md b/docs/tools/sdk/go/Reference/V2025/Models/DataAccessImpactScore.md new file mode 100644 index 000000000..9282b76bf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DataAccessImpactScore.md @@ -0,0 +1,64 @@ +--- +id: v2025-data-access-impact-score +title: DataAccessImpactScore +pagination_label: DataAccessImpactScore +sidebar_label: DataAccessImpactScore +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DataAccessImpactScore', 'V2025DataAccessImpactScore'] +slug: /tools/sdk/go/v2025/models/data-access-impact-score +tags: ['SDK', 'Software Development Kit', 'DataAccessImpactScore', 'V2025DataAccessImpactScore'] +--- + +# DataAccessImpactScore + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | Impact Score for this data | [optional] + +## Methods + +### NewDataAccessImpactScore + +`func NewDataAccessImpactScore() *DataAccessImpactScore` + +NewDataAccessImpactScore instantiates a new DataAccessImpactScore 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 + +### NewDataAccessImpactScoreWithDefaults + +`func NewDataAccessImpactScoreWithDefaults() *DataAccessImpactScore` + +NewDataAccessImpactScoreWithDefaults instantiates a new DataAccessImpactScore 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 + +### GetValue + +`func (o *DataAccessImpactScore) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *DataAccessImpactScore) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *DataAccessImpactScore) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *DataAccessImpactScore) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DataAccessPoliciesInner.md b/docs/tools/sdk/go/Reference/V2025/Models/DataAccessPoliciesInner.md new file mode 100644 index 000000000..b184b7b8d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DataAccessPoliciesInner.md @@ -0,0 +1,64 @@ +--- +id: v2025-data-access-policies-inner +title: DataAccessPoliciesInner +pagination_label: DataAccessPoliciesInner +sidebar_label: DataAccessPoliciesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DataAccessPoliciesInner', 'V2025DataAccessPoliciesInner'] +slug: /tools/sdk/go/v2025/models/data-access-policies-inner +tags: ['SDK', 'Software Development Kit', 'DataAccessPoliciesInner', 'V2025DataAccessPoliciesInner'] +--- + +# DataAccessPoliciesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | Value of the policy | [optional] + +## Methods + +### NewDataAccessPoliciesInner + +`func NewDataAccessPoliciesInner() *DataAccessPoliciesInner` + +NewDataAccessPoliciesInner instantiates a new DataAccessPoliciesInner 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 + +### NewDataAccessPoliciesInnerWithDefaults + +`func NewDataAccessPoliciesInnerWithDefaults() *DataAccessPoliciesInner` + +NewDataAccessPoliciesInnerWithDefaults instantiates a new DataAccessPoliciesInner 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 + +### GetValue + +`func (o *DataAccessPoliciesInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *DataAccessPoliciesInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *DataAccessPoliciesInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *DataAccessPoliciesInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DataSegment.md b/docs/tools/sdk/go/Reference/V2025/Models/DataSegment.md new file mode 100644 index 000000000..07b9fbac0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DataSegment.md @@ -0,0 +1,324 @@ +--- +id: v2025-data-segment +title: DataSegment +pagination_label: DataSegment +sidebar_label: DataSegment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DataSegment', 'V2025DataSegment'] +slug: /tools/sdk/go/v2025/models/data-segment +tags: ['SDK', 'Software Development Kit', 'DataSegment', 'V2025DataSegment'] +--- + +# DataSegment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The segment's ID. | [optional] +**Name** | Pointer to **string** | The segment's business name. | [optional] +**Created** | Pointer to **SailPointTime** | The time when the segment is created. | [optional] +**Modified** | Pointer to **SailPointTime** | The time when the segment is modified. | [optional] +**Description** | Pointer to **string** | The segment's optional description. | [optional] +**Scopes** | Pointer to [**[]Scope**](scope) | List of Scopes that are assigned to the segment | [optional] +**MemberSelection** | Pointer to [**[]Ref**](ref) | List of Identities that are assigned to the segment | [optional] +**MemberFilter** | Pointer to [**VisibilityCriteria**](visibility-criteria) | | [optional] +**Membership** | Pointer to [**MembershipType**](membership-type) | | [optional] +**Enabled** | Pointer to **bool** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to false] +**Published** | Pointer to **bool** | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified to until published | [optional] [default to false] + +## Methods + +### NewDataSegment + +`func NewDataSegment() *DataSegment` + +NewDataSegment instantiates a new DataSegment 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 + +### NewDataSegmentWithDefaults + +`func NewDataSegmentWithDefaults() *DataSegment` + +NewDataSegmentWithDefaults instantiates a new DataSegment 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 + +### GetId + +`func (o *DataSegment) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DataSegment) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DataSegment) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DataSegment) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *DataSegment) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DataSegment) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DataSegment) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DataSegment) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *DataSegment) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *DataSegment) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *DataSegment) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *DataSegment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *DataSegment) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *DataSegment) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *DataSegment) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *DataSegment) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *DataSegment) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *DataSegment) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *DataSegment) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *DataSegment) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetScopes + +`func (o *DataSegment) GetScopes() []Scope` + +GetScopes returns the Scopes field if non-nil, zero value otherwise. + +### GetScopesOk + +`func (o *DataSegment) GetScopesOk() (*[]Scope, bool)` + +GetScopesOk returns a tuple with the Scopes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScopes + +`func (o *DataSegment) SetScopes(v []Scope)` + +SetScopes sets Scopes field to given value. + +### HasScopes + +`func (o *DataSegment) HasScopes() bool` + +HasScopes returns a boolean if a field has been set. + +### GetMemberSelection + +`func (o *DataSegment) GetMemberSelection() []Ref` + +GetMemberSelection returns the MemberSelection field if non-nil, zero value otherwise. + +### GetMemberSelectionOk + +`func (o *DataSegment) GetMemberSelectionOk() (*[]Ref, bool)` + +GetMemberSelectionOk returns a tuple with the MemberSelection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMemberSelection + +`func (o *DataSegment) SetMemberSelection(v []Ref)` + +SetMemberSelection sets MemberSelection field to given value. + +### HasMemberSelection + +`func (o *DataSegment) HasMemberSelection() bool` + +HasMemberSelection returns a boolean if a field has been set. + +### GetMemberFilter + +`func (o *DataSegment) GetMemberFilter() VisibilityCriteria` + +GetMemberFilter returns the MemberFilter field if non-nil, zero value otherwise. + +### GetMemberFilterOk + +`func (o *DataSegment) GetMemberFilterOk() (*VisibilityCriteria, bool)` + +GetMemberFilterOk returns a tuple with the MemberFilter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMemberFilter + +`func (o *DataSegment) SetMemberFilter(v VisibilityCriteria)` + +SetMemberFilter sets MemberFilter field to given value. + +### HasMemberFilter + +`func (o *DataSegment) HasMemberFilter() bool` + +HasMemberFilter returns a boolean if a field has been set. + +### GetMembership + +`func (o *DataSegment) GetMembership() MembershipType` + +GetMembership returns the Membership field if non-nil, zero value otherwise. + +### GetMembershipOk + +`func (o *DataSegment) GetMembershipOk() (*MembershipType, bool)` + +GetMembershipOk returns a tuple with the Membership field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMembership + +`func (o *DataSegment) SetMembership(v MembershipType)` + +SetMembership sets Membership field to given value. + +### HasMembership + +`func (o *DataSegment) HasMembership() bool` + +HasMembership returns a boolean if a field has been set. + +### GetEnabled + +`func (o *DataSegment) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *DataSegment) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *DataSegment) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *DataSegment) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetPublished + +`func (o *DataSegment) GetPublished() bool` + +GetPublished returns the Published field if non-nil, zero value otherwise. + +### GetPublishedOk + +`func (o *DataSegment) GetPublishedOk() (*bool, bool)` + +GetPublishedOk returns a tuple with the Published field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublished + +`func (o *DataSegment) SetPublished(v bool)` + +SetPublished sets Published field to given value. + +### HasPublished + +`func (o *DataSegment) HasPublished() bool` + +HasPublished returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DeleteNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/DeleteNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..b8fef59c2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DeleteNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,59 @@ +--- +id: v2025-delete-non-employee-records-in-bulk-request +title: DeleteNonEmployeeRecordsInBulkRequest +pagination_label: DeleteNonEmployeeRecordsInBulkRequest +sidebar_label: DeleteNonEmployeeRecordsInBulkRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DeleteNonEmployeeRecordsInBulkRequest', 'V2025DeleteNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/go/v2025/models/delete-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'DeleteNonEmployeeRecordsInBulkRequest', 'V2025DeleteNonEmployeeRecordsInBulkRequest'] +--- + +# DeleteNonEmployeeRecordsInBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | **[]string** | List of non-employee ids. | + +## Methods + +### NewDeleteNonEmployeeRecordsInBulkRequest + +`func NewDeleteNonEmployeeRecordsInBulkRequest(ids []string, ) *DeleteNonEmployeeRecordsInBulkRequest` + +NewDeleteNonEmployeeRecordsInBulkRequest instantiates a new DeleteNonEmployeeRecordsInBulkRequest 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 + +### NewDeleteNonEmployeeRecordsInBulkRequestWithDefaults + +`func NewDeleteNonEmployeeRecordsInBulkRequestWithDefaults() *DeleteNonEmployeeRecordsInBulkRequest` + +NewDeleteNonEmployeeRecordsInBulkRequestWithDefaults instantiates a new DeleteNonEmployeeRecordsInBulkRequest 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 + +### GetIds + +`func (o *DeleteNonEmployeeRecordsInBulkRequest) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *DeleteNonEmployeeRecordsInBulkRequest) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *DeleteNonEmployeeRecordsInBulkRequest) SetIds(v []string)` + +SetIds sets Ids field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DeleteSource202Response.md b/docs/tools/sdk/go/Reference/V2025/Models/DeleteSource202Response.md new file mode 100644 index 000000000..c1fab1604 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DeleteSource202Response.md @@ -0,0 +1,116 @@ +--- +id: v2025-delete-source202-response +title: DeleteSource202Response +pagination_label: DeleteSource202Response +sidebar_label: DeleteSource202Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DeleteSource202Response', 'V2025DeleteSource202Response'] +slug: /tools/sdk/go/v2025/models/delete-source202-response +tags: ['SDK', 'Software Development Kit', 'DeleteSource202Response', 'V2025DeleteSource202Response'] +--- + +# DeleteSource202Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Task result ID. | [optional] +**Name** | Pointer to **string** | Task result's human-readable display name (this should be null/empty). | [optional] + +## Methods + +### NewDeleteSource202Response + +`func NewDeleteSource202Response() *DeleteSource202Response` + +NewDeleteSource202Response instantiates a new DeleteSource202Response 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 + +### NewDeleteSource202ResponseWithDefaults + +`func NewDeleteSource202ResponseWithDefaults() *DeleteSource202Response` + +NewDeleteSource202ResponseWithDefaults instantiates a new DeleteSource202Response 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 + +### GetType + +`func (o *DeleteSource202Response) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DeleteSource202Response) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DeleteSource202Response) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DeleteSource202Response) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *DeleteSource202Response) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DeleteSource202Response) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DeleteSource202Response) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DeleteSource202Response) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *DeleteSource202Response) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DeleteSource202Response) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DeleteSource202Response) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DeleteSource202Response) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DeleteVendorConnectorMapping200Response.md b/docs/tools/sdk/go/Reference/V2025/Models/DeleteVendorConnectorMapping200Response.md new file mode 100644 index 000000000..385531f0e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DeleteVendorConnectorMapping200Response.md @@ -0,0 +1,64 @@ +--- +id: v2025-delete-vendor-connector-mapping200-response +title: DeleteVendorConnectorMapping200Response +pagination_label: DeleteVendorConnectorMapping200Response +sidebar_label: DeleteVendorConnectorMapping200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DeleteVendorConnectorMapping200Response', 'V2025DeleteVendorConnectorMapping200Response'] +slug: /tools/sdk/go/v2025/models/delete-vendor-connector-mapping200-response +tags: ['SDK', 'Software Development Kit', 'DeleteVendorConnectorMapping200Response', 'V2025DeleteVendorConnectorMapping200Response'] +--- + +# DeleteVendorConnectorMapping200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **int32** | The number of vendor connector mappings successfully deleted. | [optional] + +## Methods + +### NewDeleteVendorConnectorMapping200Response + +`func NewDeleteVendorConnectorMapping200Response() *DeleteVendorConnectorMapping200Response` + +NewDeleteVendorConnectorMapping200Response instantiates a new DeleteVendorConnectorMapping200Response 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 + +### NewDeleteVendorConnectorMapping200ResponseWithDefaults + +`func NewDeleteVendorConnectorMapping200ResponseWithDefaults() *DeleteVendorConnectorMapping200Response` + +NewDeleteVendorConnectorMapping200ResponseWithDefaults instantiates a new DeleteVendorConnectorMapping200Response 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 + +### GetCount + +`func (o *DeleteVendorConnectorMapping200Response) GetCount() int32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *DeleteVendorConnectorMapping200Response) GetCountOk() (*int32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *DeleteVendorConnectorMapping200Response) SetCount(v int32)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *DeleteVendorConnectorMapping200Response) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DependantAppConnections.md b/docs/tools/sdk/go/Reference/V2025/Models/DependantAppConnections.md new file mode 100644 index 000000000..16a92192c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DependantAppConnections.md @@ -0,0 +1,272 @@ +--- +id: v2025-dependant-app-connections +title: DependantAppConnections +pagination_label: DependantAppConnections +sidebar_label: DependantAppConnections +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DependantAppConnections', 'V2025DependantAppConnections'] +slug: /tools/sdk/go/v2025/models/dependant-app-connections +tags: ['SDK', 'Software Development Kit', 'DependantAppConnections', 'V2025DependantAppConnections'] +--- + +# DependantAppConnections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CloudAppId** | Pointer to **string** | Id of the connected Application | [optional] +**Description** | Pointer to **string** | Description of the connected Application | [optional] +**Enabled** | Pointer to **bool** | Is the Application enabled | [optional] [default to true] +**ProvisionRequestEnabled** | Pointer to **bool** | Is Provisioning enabled for connected Application | [optional] [default to true] +**AccountSource** | Pointer to [**DependantAppConnectionsAccountSource**](dependant-app-connections-account-source) | | [optional] +**LauncherCount** | Pointer to **int64** | The amount of launchers for connected Application (long type) | [optional] +**MatchAllAccount** | Pointer to **bool** | Is Provisioning enabled for connected Application | [optional] [default to false] +**Owner** | Pointer to [**[]BaseReferenceDto**](base-reference-dto) | The owner of the connected Application | [optional] +**AppCenterEnabled** | Pointer to **bool** | Is App Center enabled for connected Application | [optional] [default to false] + +## Methods + +### NewDependantAppConnections + +`func NewDependantAppConnections() *DependantAppConnections` + +NewDependantAppConnections instantiates a new DependantAppConnections 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 + +### NewDependantAppConnectionsWithDefaults + +`func NewDependantAppConnectionsWithDefaults() *DependantAppConnections` + +NewDependantAppConnectionsWithDefaults instantiates a new DependantAppConnections 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 + +### GetCloudAppId + +`func (o *DependantAppConnections) GetCloudAppId() string` + +GetCloudAppId returns the CloudAppId field if non-nil, zero value otherwise. + +### GetCloudAppIdOk + +`func (o *DependantAppConnections) GetCloudAppIdOk() (*string, bool)` + +GetCloudAppIdOk returns a tuple with the CloudAppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudAppId + +`func (o *DependantAppConnections) SetCloudAppId(v string)` + +SetCloudAppId sets CloudAppId field to given value. + +### HasCloudAppId + +`func (o *DependantAppConnections) HasCloudAppId() bool` + +HasCloudAppId returns a boolean if a field has been set. + +### GetDescription + +`func (o *DependantAppConnections) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *DependantAppConnections) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *DependantAppConnections) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *DependantAppConnections) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetEnabled + +`func (o *DependantAppConnections) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *DependantAppConnections) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *DependantAppConnections) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *DependantAppConnections) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetProvisionRequestEnabled + +`func (o *DependantAppConnections) GetProvisionRequestEnabled() bool` + +GetProvisionRequestEnabled returns the ProvisionRequestEnabled field if non-nil, zero value otherwise. + +### GetProvisionRequestEnabledOk + +`func (o *DependantAppConnections) GetProvisionRequestEnabledOk() (*bool, bool)` + +GetProvisionRequestEnabledOk returns a tuple with the ProvisionRequestEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionRequestEnabled + +`func (o *DependantAppConnections) SetProvisionRequestEnabled(v bool)` + +SetProvisionRequestEnabled sets ProvisionRequestEnabled field to given value. + +### HasProvisionRequestEnabled + +`func (o *DependantAppConnections) HasProvisionRequestEnabled() bool` + +HasProvisionRequestEnabled returns a boolean if a field has been set. + +### GetAccountSource + +`func (o *DependantAppConnections) GetAccountSource() DependantAppConnectionsAccountSource` + +GetAccountSource returns the AccountSource field if non-nil, zero value otherwise. + +### GetAccountSourceOk + +`func (o *DependantAppConnections) GetAccountSourceOk() (*DependantAppConnectionsAccountSource, bool)` + +GetAccountSourceOk returns a tuple with the AccountSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSource + +`func (o *DependantAppConnections) SetAccountSource(v DependantAppConnectionsAccountSource)` + +SetAccountSource sets AccountSource field to given value. + +### HasAccountSource + +`func (o *DependantAppConnections) HasAccountSource() bool` + +HasAccountSource returns a boolean if a field has been set. + +### GetLauncherCount + +`func (o *DependantAppConnections) GetLauncherCount() int64` + +GetLauncherCount returns the LauncherCount field if non-nil, zero value otherwise. + +### GetLauncherCountOk + +`func (o *DependantAppConnections) GetLauncherCountOk() (*int64, bool)` + +GetLauncherCountOk returns a tuple with the LauncherCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncherCount + +`func (o *DependantAppConnections) SetLauncherCount(v int64)` + +SetLauncherCount sets LauncherCount field to given value. + +### HasLauncherCount + +`func (o *DependantAppConnections) HasLauncherCount() bool` + +HasLauncherCount returns a boolean if a field has been set. + +### GetMatchAllAccount + +`func (o *DependantAppConnections) GetMatchAllAccount() bool` + +GetMatchAllAccount returns the MatchAllAccount field if non-nil, zero value otherwise. + +### GetMatchAllAccountOk + +`func (o *DependantAppConnections) GetMatchAllAccountOk() (*bool, bool)` + +GetMatchAllAccountOk returns a tuple with the MatchAllAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAllAccount + +`func (o *DependantAppConnections) SetMatchAllAccount(v bool)` + +SetMatchAllAccount sets MatchAllAccount field to given value. + +### HasMatchAllAccount + +`func (o *DependantAppConnections) HasMatchAllAccount() bool` + +HasMatchAllAccount returns a boolean if a field has been set. + +### GetOwner + +`func (o *DependantAppConnections) GetOwner() []BaseReferenceDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *DependantAppConnections) GetOwnerOk() (*[]BaseReferenceDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *DependantAppConnections) SetOwner(v []BaseReferenceDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *DependantAppConnections) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetAppCenterEnabled + +`func (o *DependantAppConnections) GetAppCenterEnabled() bool` + +GetAppCenterEnabled returns the AppCenterEnabled field if non-nil, zero value otherwise. + +### GetAppCenterEnabledOk + +`func (o *DependantAppConnections) GetAppCenterEnabledOk() (*bool, bool)` + +GetAppCenterEnabledOk returns a tuple with the AppCenterEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppCenterEnabled + +`func (o *DependantAppConnections) SetAppCenterEnabled(v bool)` + +SetAppCenterEnabled sets AppCenterEnabled field to given value. + +### HasAppCenterEnabled + +`func (o *DependantAppConnections) HasAppCenterEnabled() bool` + +HasAppCenterEnabled returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DependantAppConnectionsAccountSource.md b/docs/tools/sdk/go/Reference/V2025/Models/DependantAppConnectionsAccountSource.md new file mode 100644 index 000000000..6dbd6b74b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DependantAppConnectionsAccountSource.md @@ -0,0 +1,90 @@ +--- +id: v2025-dependant-app-connections-account-source +title: DependantAppConnectionsAccountSource +pagination_label: DependantAppConnectionsAccountSource +sidebar_label: DependantAppConnectionsAccountSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DependantAppConnectionsAccountSource', 'V2025DependantAppConnectionsAccountSource'] +slug: /tools/sdk/go/v2025/models/dependant-app-connections-account-source +tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSource', 'V2025DependantAppConnectionsAccountSource'] +--- + +# DependantAppConnectionsAccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UseForPasswordManagement** | Pointer to **bool** | Use this Account Source for password management | [optional] [default to false] +**PasswordPolicies** | Pointer to [**[]DependantAppConnectionsAccountSourcePasswordPoliciesInner**](dependant-app-connections-account-source-password-policies-inner) | A list of Password Policies for this Account Source | [optional] + +## Methods + +### NewDependantAppConnectionsAccountSource + +`func NewDependantAppConnectionsAccountSource() *DependantAppConnectionsAccountSource` + +NewDependantAppConnectionsAccountSource instantiates a new DependantAppConnectionsAccountSource 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 + +### NewDependantAppConnectionsAccountSourceWithDefaults + +`func NewDependantAppConnectionsAccountSourceWithDefaults() *DependantAppConnectionsAccountSource` + +NewDependantAppConnectionsAccountSourceWithDefaults instantiates a new DependantAppConnectionsAccountSource 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 + +### GetUseForPasswordManagement + +`func (o *DependantAppConnectionsAccountSource) GetUseForPasswordManagement() bool` + +GetUseForPasswordManagement returns the UseForPasswordManagement field if non-nil, zero value otherwise. + +### GetUseForPasswordManagementOk + +`func (o *DependantAppConnectionsAccountSource) GetUseForPasswordManagementOk() (*bool, bool)` + +GetUseForPasswordManagementOk returns a tuple with the UseForPasswordManagement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseForPasswordManagement + +`func (o *DependantAppConnectionsAccountSource) SetUseForPasswordManagement(v bool)` + +SetUseForPasswordManagement sets UseForPasswordManagement field to given value. + +### HasUseForPasswordManagement + +`func (o *DependantAppConnectionsAccountSource) HasUseForPasswordManagement() bool` + +HasUseForPasswordManagement returns a boolean if a field has been set. + +### GetPasswordPolicies + +`func (o *DependantAppConnectionsAccountSource) GetPasswordPolicies() []DependantAppConnectionsAccountSourcePasswordPoliciesInner` + +GetPasswordPolicies returns the PasswordPolicies field if non-nil, zero value otherwise. + +### GetPasswordPoliciesOk + +`func (o *DependantAppConnectionsAccountSource) GetPasswordPoliciesOk() (*[]DependantAppConnectionsAccountSourcePasswordPoliciesInner, bool)` + +GetPasswordPoliciesOk returns a tuple with the PasswordPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicies + +`func (o *DependantAppConnectionsAccountSource) SetPasswordPolicies(v []DependantAppConnectionsAccountSourcePasswordPoliciesInner)` + +SetPasswordPolicies sets PasswordPolicies field to given value. + +### HasPasswordPolicies + +`func (o *DependantAppConnectionsAccountSource) HasPasswordPolicies() bool` + +HasPasswordPolicies returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md b/docs/tools/sdk/go/Reference/V2025/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md new file mode 100644 index 000000000..66a58ddbb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md @@ -0,0 +1,116 @@ +--- +id: v2025-dependant-app-connections-account-source-password-policies-inner +title: DependantAppConnectionsAccountSourcePasswordPoliciesInner +pagination_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner +sidebar_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner', 'V2025DependantAppConnectionsAccountSourcePasswordPoliciesInner'] +slug: /tools/sdk/go/v2025/models/dependant-app-connections-account-source-password-policies-inner +tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner', 'V2025DependantAppConnectionsAccountSourcePasswordPoliciesInner'] +--- + +# DependantAppConnectionsAccountSourcePasswordPoliciesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewDependantAppConnectionsAccountSourcePasswordPoliciesInner + +`func NewDependantAppConnectionsAccountSourcePasswordPoliciesInner() *DependantAppConnectionsAccountSourcePasswordPoliciesInner` + +NewDependantAppConnectionsAccountSourcePasswordPoliciesInner instantiates a new DependantAppConnectionsAccountSourcePasswordPoliciesInner 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 + +### NewDependantAppConnectionsAccountSourcePasswordPoliciesInnerWithDefaults + +`func NewDependantAppConnectionsAccountSourcePasswordPoliciesInnerWithDefaults() *DependantAppConnectionsAccountSourcePasswordPoliciesInner` + +NewDependantAppConnectionsAccountSourcePasswordPoliciesInnerWithDefaults instantiates a new DependantAppConnectionsAccountSourcePasswordPoliciesInner 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 + +### GetType + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DependantConnectionsMissingDto.md b/docs/tools/sdk/go/Reference/V2025/Models/DependantConnectionsMissingDto.md new file mode 100644 index 000000000..557bab9b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DependantConnectionsMissingDto.md @@ -0,0 +1,90 @@ +--- +id: v2025-dependant-connections-missing-dto +title: DependantConnectionsMissingDto +pagination_label: DependantConnectionsMissingDto +sidebar_label: DependantConnectionsMissingDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DependantConnectionsMissingDto', 'V2025DependantConnectionsMissingDto'] +slug: /tools/sdk/go/v2025/models/dependant-connections-missing-dto +tags: ['SDK', 'Software Development Kit', 'DependantConnectionsMissingDto', 'V2025DependantConnectionsMissingDto'] +--- + +# DependantConnectionsMissingDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DependencyType** | Pointer to **string** | The type of dependency type that is missing in the SourceConnections | [optional] +**Reason** | Pointer to **string** | The reason why this dependency is missing | [optional] + +## Methods + +### NewDependantConnectionsMissingDto + +`func NewDependantConnectionsMissingDto() *DependantConnectionsMissingDto` + +NewDependantConnectionsMissingDto instantiates a new DependantConnectionsMissingDto 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 + +### NewDependantConnectionsMissingDtoWithDefaults + +`func NewDependantConnectionsMissingDtoWithDefaults() *DependantConnectionsMissingDto` + +NewDependantConnectionsMissingDtoWithDefaults instantiates a new DependantConnectionsMissingDto 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 + +### GetDependencyType + +`func (o *DependantConnectionsMissingDto) GetDependencyType() string` + +GetDependencyType returns the DependencyType field if non-nil, zero value otherwise. + +### GetDependencyTypeOk + +`func (o *DependantConnectionsMissingDto) GetDependencyTypeOk() (*string, bool)` + +GetDependencyTypeOk returns a tuple with the DependencyType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDependencyType + +`func (o *DependantConnectionsMissingDto) SetDependencyType(v string)` + +SetDependencyType sets DependencyType field to given value. + +### HasDependencyType + +`func (o *DependantConnectionsMissingDto) HasDependencyType() bool` + +HasDependencyType returns a boolean if a field has been set. + +### GetReason + +`func (o *DependantConnectionsMissingDto) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *DependantConnectionsMissingDto) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *DependantConnectionsMissingDto) SetReason(v string)` + +SetReason sets Reason field to given value. + +### HasReason + +`func (o *DependantConnectionsMissingDto) HasReason() bool` + +HasReason returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DeployRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/DeployRequest.md new file mode 100644 index 000000000..874ac1bf7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DeployRequest.md @@ -0,0 +1,59 @@ +--- +id: v2025-deploy-request +title: DeployRequest +pagination_label: DeployRequest +sidebar_label: DeployRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DeployRequest', 'V2025DeployRequest'] +slug: /tools/sdk/go/v2025/models/deploy-request +tags: ['SDK', 'Software Development Kit', 'DeployRequest', 'V2025DeployRequest'] +--- + +# DeployRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DraftId** | **string** | The id of the draft to be used by this deploy. | + +## Methods + +### NewDeployRequest + +`func NewDeployRequest(draftId string, ) *DeployRequest` + +NewDeployRequest instantiates a new DeployRequest 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 + +### NewDeployRequestWithDefaults + +`func NewDeployRequestWithDefaults() *DeployRequest` + +NewDeployRequestWithDefaults instantiates a new DeployRequest 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 + +### GetDraftId + +`func (o *DeployRequest) GetDraftId() string` + +GetDraftId returns the DraftId field if non-nil, zero value otherwise. + +### GetDraftIdOk + +`func (o *DeployRequest) GetDraftIdOk() (*string, bool)` + +GetDraftIdOk returns a tuple with the DraftId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDraftId + +`func (o *DeployRequest) SetDraftId(v string)` + +SetDraftId sets DraftId field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DeployResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/DeployResponse.md new file mode 100644 index 000000000..51622be74 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DeployResponse.md @@ -0,0 +1,350 @@ +--- +id: v2025-deploy-response +title: DeployResponse +pagination_label: DeployResponse +sidebar_label: DeployResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DeployResponse', 'V2025DeployResponse'] +slug: /tools/sdk/go/v2025/models/deploy-response +tags: ['SDK', 'Software Development Kit', 'DeployResponse', 'V2025DeployResponse'] +--- + +# DeployResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | Pointer to **string** | Unique id assigned to this job. | [optional] +**Status** | Pointer to **string** | Status of the job. | [optional] +**Type** | Pointer to **string** | Type of the job, will always be CONFIG_DEPLOY_DRAFT for this type of job. | [optional] +**Message** | Pointer to **string** | Message providing information about the outcome of the deploy process. | [optional] +**RequesterName** | Pointer to **string** | The name of the user that initiated the deploy process. | [optional] +**FileExists** | Pointer to **bool** | Whether or not a results file was created and stored for this deploy. | [optional] [default to true] +**Created** | Pointer to **SailPointTime** | The time the job was started. | [optional] +**Modified** | Pointer to **SailPointTime** | The time of the last update to the job. | [optional] +**Completed** | Pointer to **SailPointTime** | The time the job was completed. | [optional] +**DraftId** | Pointer to **string** | The id of the draft that was used for this deploy. | [optional] +**DraftName** | Pointer to **string** | The name of the draft that was used for this deploy. | [optional] +**CloudStorageStatus** | Pointer to **string** | Whether this deploy results file has been transferred to a customer storage location. | [optional] + +## Methods + +### NewDeployResponse + +`func NewDeployResponse() *DeployResponse` + +NewDeployResponse instantiates a new DeployResponse 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 + +### NewDeployResponseWithDefaults + +`func NewDeployResponseWithDefaults() *DeployResponse` + +NewDeployResponseWithDefaults instantiates a new DeployResponse 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 + +### GetJobId + +`func (o *DeployResponse) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *DeployResponse) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *DeployResponse) SetJobId(v string)` + +SetJobId sets JobId field to given value. + +### HasJobId + +`func (o *DeployResponse) HasJobId() bool` + +HasJobId returns a boolean if a field has been set. + +### GetStatus + +`func (o *DeployResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *DeployResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *DeployResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *DeployResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetType + +`func (o *DeployResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DeployResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DeployResponse) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DeployResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetMessage + +`func (o *DeployResponse) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *DeployResponse) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *DeployResponse) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *DeployResponse) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetRequesterName + +`func (o *DeployResponse) GetRequesterName() string` + +GetRequesterName returns the RequesterName field if non-nil, zero value otherwise. + +### GetRequesterNameOk + +`func (o *DeployResponse) GetRequesterNameOk() (*string, bool)` + +GetRequesterNameOk returns a tuple with the RequesterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterName + +`func (o *DeployResponse) SetRequesterName(v string)` + +SetRequesterName sets RequesterName field to given value. + +### HasRequesterName + +`func (o *DeployResponse) HasRequesterName() bool` + +HasRequesterName returns a boolean if a field has been set. + +### GetFileExists + +`func (o *DeployResponse) GetFileExists() bool` + +GetFileExists returns the FileExists field if non-nil, zero value otherwise. + +### GetFileExistsOk + +`func (o *DeployResponse) GetFileExistsOk() (*bool, bool)` + +GetFileExistsOk returns a tuple with the FileExists field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileExists + +`func (o *DeployResponse) SetFileExists(v bool)` + +SetFileExists sets FileExists field to given value. + +### HasFileExists + +`func (o *DeployResponse) HasFileExists() bool` + +HasFileExists returns a boolean if a field has been set. + +### GetCreated + +`func (o *DeployResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *DeployResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *DeployResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *DeployResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *DeployResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *DeployResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *DeployResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *DeployResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCompleted + +`func (o *DeployResponse) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *DeployResponse) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *DeployResponse) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *DeployResponse) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetDraftId + +`func (o *DeployResponse) GetDraftId() string` + +GetDraftId returns the DraftId field if non-nil, zero value otherwise. + +### GetDraftIdOk + +`func (o *DeployResponse) GetDraftIdOk() (*string, bool)` + +GetDraftIdOk returns a tuple with the DraftId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDraftId + +`func (o *DeployResponse) SetDraftId(v string)` + +SetDraftId sets DraftId field to given value. + +### HasDraftId + +`func (o *DeployResponse) HasDraftId() bool` + +HasDraftId returns a boolean if a field has been set. + +### GetDraftName + +`func (o *DeployResponse) GetDraftName() string` + +GetDraftName returns the DraftName field if non-nil, zero value otherwise. + +### GetDraftNameOk + +`func (o *DeployResponse) GetDraftNameOk() (*string, bool)` + +GetDraftNameOk returns a tuple with the DraftName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDraftName + +`func (o *DeployResponse) SetDraftName(v string)` + +SetDraftName sets DraftName field to given value. + +### HasDraftName + +`func (o *DeployResponse) HasDraftName() bool` + +HasDraftName returns a boolean if a field has been set. + +### GetCloudStorageStatus + +`func (o *DeployResponse) GetCloudStorageStatus() string` + +GetCloudStorageStatus returns the CloudStorageStatus field if non-nil, zero value otherwise. + +### GetCloudStorageStatusOk + +`func (o *DeployResponse) GetCloudStorageStatusOk() (*string, bool)` + +GetCloudStorageStatusOk returns a tuple with the CloudStorageStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudStorageStatus + +`func (o *DeployResponse) SetCloudStorageStatus(v string)` + +SetCloudStorageStatus sets CloudStorageStatus field to given value. + +### HasCloudStorageStatus + +`func (o *DeployResponse) HasCloudStorageStatus() bool` + +HasCloudStorageStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Dimension.md b/docs/tools/sdk/go/Reference/V2025/Models/Dimension.md new file mode 100644 index 000000000..87c14b490 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Dimension.md @@ -0,0 +1,328 @@ +--- +id: v2025-dimension +title: Dimension +pagination_label: Dimension +sidebar_label: Dimension +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Dimension', 'V2025Dimension'] +slug: /tools/sdk/go/v2025/models/dimension +tags: ['SDK', 'Software Development Kit', 'Dimension', 'V2025Dimension'] +--- + +# Dimension + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the Dimension. This field must be left null when creating a dimension, otherwise a 400 Bad Request error will result. | [optional] +**Name** | **string** | The human-readable display name of the Dimension | +**Created** | Pointer to **SailPointTime** | Date the Dimension was created | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Date the Dimension was last modified. | [optional] [readonly] +**Description** | Pointer to **NullableString** | A human-readable description of the Dimension | [optional] +**Owner** | [**OwnerReference**](owner-reference) | | +**AccessProfiles** | Pointer to [**[]AccessProfileRef**](access-profile-ref) | | [optional] +**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | | [optional] +**Membership** | Pointer to [**NullableDimensionMembershipSelector**](dimension-membership-selector) | | [optional] +**ParentId** | Pointer to **NullableString** | The ID of the parent role. This field can be left null when creating a dimension, but if provided, it must match the role ID specified in the path variable of the API call. | [optional] + +## Methods + +### NewDimension + +`func NewDimension(name string, owner OwnerReference, ) *Dimension` + +NewDimension instantiates a new Dimension 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 + +### NewDimensionWithDefaults + +`func NewDimensionWithDefaults() *Dimension` + +NewDimensionWithDefaults instantiates a new Dimension 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 + +### GetId + +`func (o *Dimension) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Dimension) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Dimension) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Dimension) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Dimension) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Dimension) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Dimension) SetName(v string)` + +SetName sets Name field to given value. + + +### GetCreated + +`func (o *Dimension) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Dimension) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Dimension) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Dimension) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Dimension) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Dimension) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Dimension) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Dimension) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *Dimension) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Dimension) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Dimension) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Dimension) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Dimension) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Dimension) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwner + +`func (o *Dimension) GetOwner() OwnerReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Dimension) GetOwnerOk() (*OwnerReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Dimension) SetOwner(v OwnerReference)` + +SetOwner sets Owner field to given value. + + +### GetAccessProfiles + +`func (o *Dimension) GetAccessProfiles() []AccessProfileRef` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *Dimension) GetAccessProfilesOk() (*[]AccessProfileRef, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *Dimension) SetAccessProfiles(v []AccessProfileRef)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *Dimension) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### SetAccessProfilesNil + +`func (o *Dimension) SetAccessProfilesNil(b bool)` + + SetAccessProfilesNil sets the value for AccessProfiles to be an explicit nil + +### UnsetAccessProfiles +`func (o *Dimension) UnsetAccessProfiles()` + +UnsetAccessProfiles ensures that no value is present for AccessProfiles, not even an explicit nil +### GetEntitlements + +`func (o *Dimension) GetEntitlements() []EntitlementRef` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *Dimension) GetEntitlementsOk() (*[]EntitlementRef, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *Dimension) SetEntitlements(v []EntitlementRef)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *Dimension) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetMembership + +`func (o *Dimension) GetMembership() DimensionMembershipSelector` + +GetMembership returns the Membership field if non-nil, zero value otherwise. + +### GetMembershipOk + +`func (o *Dimension) GetMembershipOk() (*DimensionMembershipSelector, bool)` + +GetMembershipOk returns a tuple with the Membership field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMembership + +`func (o *Dimension) SetMembership(v DimensionMembershipSelector)` + +SetMembership sets Membership field to given value. + +### HasMembership + +`func (o *Dimension) HasMembership() bool` + +HasMembership returns a boolean if a field has been set. + +### SetMembershipNil + +`func (o *Dimension) SetMembershipNil(b bool)` + + SetMembershipNil sets the value for Membership to be an explicit nil + +### UnsetMembership +`func (o *Dimension) UnsetMembership()` + +UnsetMembership ensures that no value is present for Membership, not even an explicit nil +### GetParentId + +`func (o *Dimension) GetParentId() string` + +GetParentId returns the ParentId field if non-nil, zero value otherwise. + +### GetParentIdOk + +`func (o *Dimension) GetParentIdOk() (*string, bool)` + +GetParentIdOk returns a tuple with the ParentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentId + +`func (o *Dimension) SetParentId(v string)` + +SetParentId sets ParentId field to given value. + +### HasParentId + +`func (o *Dimension) HasParentId() bool` + +HasParentId returns a boolean if a field has been set. + +### SetParentIdNil + +`func (o *Dimension) SetParentIdNil(b bool)` + + SetParentIdNil sets the value for ParentId to be an explicit nil + +### UnsetParentId +`func (o *Dimension) UnsetParentId()` + +UnsetParentId ensures that no value is present for ParentId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DimensionBulkDeleteRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/DimensionBulkDeleteRequest.md new file mode 100644 index 000000000..1f1374187 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DimensionBulkDeleteRequest.md @@ -0,0 +1,59 @@ +--- +id: v2025-dimension-bulk-delete-request +title: DimensionBulkDeleteRequest +pagination_label: DimensionBulkDeleteRequest +sidebar_label: DimensionBulkDeleteRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionBulkDeleteRequest', 'V2025DimensionBulkDeleteRequest'] +slug: /tools/sdk/go/v2025/models/dimension-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'DimensionBulkDeleteRequest', 'V2025DimensionBulkDeleteRequest'] +--- + +# DimensionBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DimensionIds** | **[]string** | List of IDs of Dimensions to be deleted. | + +## Methods + +### NewDimensionBulkDeleteRequest + +`func NewDimensionBulkDeleteRequest(dimensionIds []string, ) *DimensionBulkDeleteRequest` + +NewDimensionBulkDeleteRequest instantiates a new DimensionBulkDeleteRequest 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 + +### NewDimensionBulkDeleteRequestWithDefaults + +`func NewDimensionBulkDeleteRequestWithDefaults() *DimensionBulkDeleteRequest` + +NewDimensionBulkDeleteRequestWithDefaults instantiates a new DimensionBulkDeleteRequest 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 + +### GetDimensionIds + +`func (o *DimensionBulkDeleteRequest) GetDimensionIds() []string` + +GetDimensionIds returns the DimensionIds field if non-nil, zero value otherwise. + +### GetDimensionIdsOk + +`func (o *DimensionBulkDeleteRequest) GetDimensionIdsOk() (*[]string, bool)` + +GetDimensionIdsOk returns a tuple with the DimensionIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensionIds + +`func (o *DimensionBulkDeleteRequest) SetDimensionIds(v []string)` + +SetDimensionIds sets DimensionIds field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaKey.md b/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaKey.md new file mode 100644 index 000000000..0fc564a00 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaKey.md @@ -0,0 +1,80 @@ +--- +id: v2025-dimension-criteria-key +title: DimensionCriteriaKey +pagination_label: DimensionCriteriaKey +sidebar_label: DimensionCriteriaKey +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionCriteriaKey', 'V2025DimensionCriteriaKey'] +slug: /tools/sdk/go/v2025/models/dimension-criteria-key +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaKey', 'V2025DimensionCriteriaKey'] +--- + +# DimensionCriteriaKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**DimensionCriteriaKeyType**](dimension-criteria-key-type) | | +**Property** | **string** | The name of the identity attribute to which the associated criteria applies. | + +## Methods + +### NewDimensionCriteriaKey + +`func NewDimensionCriteriaKey(type_ DimensionCriteriaKeyType, property string, ) *DimensionCriteriaKey` + +NewDimensionCriteriaKey instantiates a new DimensionCriteriaKey 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 + +### NewDimensionCriteriaKeyWithDefaults + +`func NewDimensionCriteriaKeyWithDefaults() *DimensionCriteriaKey` + +NewDimensionCriteriaKeyWithDefaults instantiates a new DimensionCriteriaKey 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 + +### GetType + +`func (o *DimensionCriteriaKey) GetType() DimensionCriteriaKeyType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DimensionCriteriaKey) GetTypeOk() (*DimensionCriteriaKeyType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DimensionCriteriaKey) SetType(v DimensionCriteriaKeyType)` + +SetType sets Type field to given value. + + +### GetProperty + +`func (o *DimensionCriteriaKey) GetProperty() string` + +GetProperty returns the Property field if non-nil, zero value otherwise. + +### GetPropertyOk + +`func (o *DimensionCriteriaKey) GetPropertyOk() (*string, bool)` + +GetPropertyOk returns a tuple with the Property field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperty + +`func (o *DimensionCriteriaKey) SetProperty(v string)` + +SetProperty sets Property field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaKeyType.md b/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaKeyType.md new file mode 100644 index 000000000..3b581533c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaKeyType.md @@ -0,0 +1,19 @@ +--- +id: v2025-dimension-criteria-key-type +title: DimensionCriteriaKeyType +pagination_label: DimensionCriteriaKeyType +sidebar_label: DimensionCriteriaKeyType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionCriteriaKeyType', 'V2025DimensionCriteriaKeyType'] +slug: /tools/sdk/go/v2025/models/dimension-criteria-key-type +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaKeyType', 'V2025DimensionCriteriaKeyType'] +--- + +# DimensionCriteriaKeyType + +## Enum + + +* `IDENTITY` (value: `"IDENTITY"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaLevel1.md b/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaLevel1.md new file mode 100644 index 000000000..6712d2b05 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaLevel1.md @@ -0,0 +1,172 @@ +--- +id: v2025-dimension-criteria-level1 +title: DimensionCriteriaLevel1 +pagination_label: DimensionCriteriaLevel1 +sidebar_label: DimensionCriteriaLevel1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionCriteriaLevel1', 'V2025DimensionCriteriaLevel1'] +slug: /tools/sdk/go/v2025/models/dimension-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaLevel1', 'V2025DimensionCriteriaLevel1'] +--- + +# DimensionCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**DimensionCriteriaOperation**](dimension-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableDimensionCriteriaKey**](dimension-criteria-key) | | [optional] +**StringValue** | Pointer to **NullableString** | String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is EQUALS, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]DimensionCriteriaLevel2**](dimension-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Methods + +### NewDimensionCriteriaLevel1 + +`func NewDimensionCriteriaLevel1() *DimensionCriteriaLevel1` + +NewDimensionCriteriaLevel1 instantiates a new DimensionCriteriaLevel1 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 + +### NewDimensionCriteriaLevel1WithDefaults + +`func NewDimensionCriteriaLevel1WithDefaults() *DimensionCriteriaLevel1` + +NewDimensionCriteriaLevel1WithDefaults instantiates a new DimensionCriteriaLevel1 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 + +### GetOperation + +`func (o *DimensionCriteriaLevel1) GetOperation() DimensionCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *DimensionCriteriaLevel1) GetOperationOk() (*DimensionCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *DimensionCriteriaLevel1) SetOperation(v DimensionCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *DimensionCriteriaLevel1) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *DimensionCriteriaLevel1) GetKey() DimensionCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *DimensionCriteriaLevel1) GetKeyOk() (*DimensionCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *DimensionCriteriaLevel1) SetKey(v DimensionCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *DimensionCriteriaLevel1) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *DimensionCriteriaLevel1) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *DimensionCriteriaLevel1) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *DimensionCriteriaLevel1) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *DimensionCriteriaLevel1) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *DimensionCriteriaLevel1) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *DimensionCriteriaLevel1) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + +### SetStringValueNil + +`func (o *DimensionCriteriaLevel1) SetStringValueNil(b bool)` + + SetStringValueNil sets the value for StringValue to be an explicit nil + +### UnsetStringValue +`func (o *DimensionCriteriaLevel1) UnsetStringValue()` + +UnsetStringValue ensures that no value is present for StringValue, not even an explicit nil +### GetChildren + +`func (o *DimensionCriteriaLevel1) GetChildren() []DimensionCriteriaLevel2` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *DimensionCriteriaLevel1) GetChildrenOk() (*[]DimensionCriteriaLevel2, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *DimensionCriteriaLevel1) SetChildren(v []DimensionCriteriaLevel2)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *DimensionCriteriaLevel1) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *DimensionCriteriaLevel1) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *DimensionCriteriaLevel1) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaLevel2.md b/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaLevel2.md new file mode 100644 index 000000000..7a9fcd074 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaLevel2.md @@ -0,0 +1,172 @@ +--- +id: v2025-dimension-criteria-level2 +title: DimensionCriteriaLevel2 +pagination_label: DimensionCriteriaLevel2 +sidebar_label: DimensionCriteriaLevel2 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionCriteriaLevel2', 'V2025DimensionCriteriaLevel2'] +slug: /tools/sdk/go/v2025/models/dimension-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaLevel2', 'V2025DimensionCriteriaLevel2'] +--- + +# DimensionCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**DimensionCriteriaOperation**](dimension-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableDimensionCriteriaKey**](dimension-criteria-key) | | [optional] +**StringValue** | Pointer to **NullableString** | String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]DimensionCriteriaLevel3**](dimension-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Methods + +### NewDimensionCriteriaLevel2 + +`func NewDimensionCriteriaLevel2() *DimensionCriteriaLevel2` + +NewDimensionCriteriaLevel2 instantiates a new DimensionCriteriaLevel2 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 + +### NewDimensionCriteriaLevel2WithDefaults + +`func NewDimensionCriteriaLevel2WithDefaults() *DimensionCriteriaLevel2` + +NewDimensionCriteriaLevel2WithDefaults instantiates a new DimensionCriteriaLevel2 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 + +### GetOperation + +`func (o *DimensionCriteriaLevel2) GetOperation() DimensionCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *DimensionCriteriaLevel2) GetOperationOk() (*DimensionCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *DimensionCriteriaLevel2) SetOperation(v DimensionCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *DimensionCriteriaLevel2) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *DimensionCriteriaLevel2) GetKey() DimensionCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *DimensionCriteriaLevel2) GetKeyOk() (*DimensionCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *DimensionCriteriaLevel2) SetKey(v DimensionCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *DimensionCriteriaLevel2) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *DimensionCriteriaLevel2) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *DimensionCriteriaLevel2) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *DimensionCriteriaLevel2) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *DimensionCriteriaLevel2) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *DimensionCriteriaLevel2) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *DimensionCriteriaLevel2) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + +### SetStringValueNil + +`func (o *DimensionCriteriaLevel2) SetStringValueNil(b bool)` + + SetStringValueNil sets the value for StringValue to be an explicit nil + +### UnsetStringValue +`func (o *DimensionCriteriaLevel2) UnsetStringValue()` + +UnsetStringValue ensures that no value is present for StringValue, not even an explicit nil +### GetChildren + +`func (o *DimensionCriteriaLevel2) GetChildren() []DimensionCriteriaLevel3` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *DimensionCriteriaLevel2) GetChildrenOk() (*[]DimensionCriteriaLevel3, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *DimensionCriteriaLevel2) SetChildren(v []DimensionCriteriaLevel3)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *DimensionCriteriaLevel2) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *DimensionCriteriaLevel2) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *DimensionCriteriaLevel2) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaLevel3.md b/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaLevel3.md new file mode 100644 index 000000000..d0685ec3b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaLevel3.md @@ -0,0 +1,126 @@ +--- +id: v2025-dimension-criteria-level3 +title: DimensionCriteriaLevel3 +pagination_label: DimensionCriteriaLevel3 +sidebar_label: DimensionCriteriaLevel3 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionCriteriaLevel3', 'V2025DimensionCriteriaLevel3'] +slug: /tools/sdk/go/v2025/models/dimension-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaLevel3', 'V2025DimensionCriteriaLevel3'] +--- + +# DimensionCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**DimensionCriteriaOperation**](dimension-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableDimensionCriteriaKey**](dimension-criteria-key) | | [optional] +**StringValue** | Pointer to **string** | String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. | [optional] + +## Methods + +### NewDimensionCriteriaLevel3 + +`func NewDimensionCriteriaLevel3() *DimensionCriteriaLevel3` + +NewDimensionCriteriaLevel3 instantiates a new DimensionCriteriaLevel3 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 + +### NewDimensionCriteriaLevel3WithDefaults + +`func NewDimensionCriteriaLevel3WithDefaults() *DimensionCriteriaLevel3` + +NewDimensionCriteriaLevel3WithDefaults instantiates a new DimensionCriteriaLevel3 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 + +### GetOperation + +`func (o *DimensionCriteriaLevel3) GetOperation() DimensionCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *DimensionCriteriaLevel3) GetOperationOk() (*DimensionCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *DimensionCriteriaLevel3) SetOperation(v DimensionCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *DimensionCriteriaLevel3) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *DimensionCriteriaLevel3) GetKey() DimensionCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *DimensionCriteriaLevel3) GetKeyOk() (*DimensionCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *DimensionCriteriaLevel3) SetKey(v DimensionCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *DimensionCriteriaLevel3) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *DimensionCriteriaLevel3) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *DimensionCriteriaLevel3) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *DimensionCriteriaLevel3) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *DimensionCriteriaLevel3) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *DimensionCriteriaLevel3) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *DimensionCriteriaLevel3) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaOperation.md b/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaOperation.md new file mode 100644 index 000000000..0c6270d6a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DimensionCriteriaOperation.md @@ -0,0 +1,23 @@ +--- +id: v2025-dimension-criteria-operation +title: DimensionCriteriaOperation +pagination_label: DimensionCriteriaOperation +sidebar_label: DimensionCriteriaOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionCriteriaOperation', 'V2025DimensionCriteriaOperation'] +slug: /tools/sdk/go/v2025/models/dimension-criteria-operation +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaOperation', 'V2025DimensionCriteriaOperation'] +--- + +# DimensionCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DimensionMembershipSelector.md b/docs/tools/sdk/go/Reference/V2025/Models/DimensionMembershipSelector.md new file mode 100644 index 000000000..bac48d28b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DimensionMembershipSelector.md @@ -0,0 +1,100 @@ +--- +id: v2025-dimension-membership-selector +title: DimensionMembershipSelector +pagination_label: DimensionMembershipSelector +sidebar_label: DimensionMembershipSelector +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionMembershipSelector', 'V2025DimensionMembershipSelector'] +slug: /tools/sdk/go/v2025/models/dimension-membership-selector +tags: ['SDK', 'Software Development Kit', 'DimensionMembershipSelector', 'V2025DimensionMembershipSelector'] +--- + +# DimensionMembershipSelector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DimensionMembershipSelectorType**](dimension-membership-selector-type) | | [optional] +**Criteria** | Pointer to [**NullableDimensionCriteriaLevel1**](dimension-criteria-level1) | | [optional] + +## Methods + +### NewDimensionMembershipSelector + +`func NewDimensionMembershipSelector() *DimensionMembershipSelector` + +NewDimensionMembershipSelector instantiates a new DimensionMembershipSelector 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 + +### NewDimensionMembershipSelectorWithDefaults + +`func NewDimensionMembershipSelectorWithDefaults() *DimensionMembershipSelector` + +NewDimensionMembershipSelectorWithDefaults instantiates a new DimensionMembershipSelector 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 + +### GetType + +`func (o *DimensionMembershipSelector) GetType() DimensionMembershipSelectorType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DimensionMembershipSelector) GetTypeOk() (*DimensionMembershipSelectorType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DimensionMembershipSelector) SetType(v DimensionMembershipSelectorType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DimensionMembershipSelector) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetCriteria + +`func (o *DimensionMembershipSelector) GetCriteria() DimensionCriteriaLevel1` + +GetCriteria returns the Criteria field if non-nil, zero value otherwise. + +### GetCriteriaOk + +`func (o *DimensionMembershipSelector) GetCriteriaOk() (*DimensionCriteriaLevel1, bool)` + +GetCriteriaOk returns a tuple with the Criteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteria + +`func (o *DimensionMembershipSelector) SetCriteria(v DimensionCriteriaLevel1)` + +SetCriteria sets Criteria field to given value. + +### HasCriteria + +`func (o *DimensionMembershipSelector) HasCriteria() bool` + +HasCriteria returns a boolean if a field has been set. + +### SetCriteriaNil + +`func (o *DimensionMembershipSelector) SetCriteriaNil(b bool)` + + SetCriteriaNil sets the value for Criteria to be an explicit nil + +### UnsetCriteria +`func (o *DimensionMembershipSelector) UnsetCriteria()` + +UnsetCriteria ensures that no value is present for Criteria, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DimensionMembershipSelectorType.md b/docs/tools/sdk/go/Reference/V2025/Models/DimensionMembershipSelectorType.md new file mode 100644 index 000000000..370a3208b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DimensionMembershipSelectorType.md @@ -0,0 +1,19 @@ +--- +id: v2025-dimension-membership-selector-type +title: DimensionMembershipSelectorType +pagination_label: DimensionMembershipSelectorType +sidebar_label: DimensionMembershipSelectorType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionMembershipSelectorType', 'V2025DimensionMembershipSelectorType'] +slug: /tools/sdk/go/v2025/models/dimension-membership-selector-type +tags: ['SDK', 'Software Development Kit', 'DimensionMembershipSelectorType', 'V2025DimensionMembershipSelectorType'] +--- + +# DimensionMembershipSelectorType + +## Enum + + +* `STANDARD` (value: `"STANDARD"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DimensionRef.md b/docs/tools/sdk/go/Reference/V2025/Models/DimensionRef.md new file mode 100644 index 000000000..c82ca830c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DimensionRef.md @@ -0,0 +1,116 @@ +--- +id: v2025-dimension-ref +title: DimensionRef +pagination_label: DimensionRef +sidebar_label: DimensionRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionRef', 'V2025DimensionRef'] +slug: /tools/sdk/go/v2025/models/dimension-ref +tags: ['SDK', 'Software Development Kit', 'DimensionRef', 'V2025DimensionRef'] +--- + +# DimensionRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of the object to which this reference applies | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewDimensionRef + +`func NewDimensionRef() *DimensionRef` + +NewDimensionRef instantiates a new DimensionRef 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 + +### NewDimensionRefWithDefaults + +`func NewDimensionRefWithDefaults() *DimensionRef` + +NewDimensionRefWithDefaults instantiates a new DimensionRef 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 + +### GetType + +`func (o *DimensionRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DimensionRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DimensionRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DimensionRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *DimensionRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DimensionRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DimensionRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DimensionRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *DimensionRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DimensionRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DimensionRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DimensionRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DisplayReference.md b/docs/tools/sdk/go/Reference/V2025/Models/DisplayReference.md new file mode 100644 index 000000000..ce555dddc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DisplayReference.md @@ -0,0 +1,116 @@ +--- +id: v2025-display-reference +title: DisplayReference +pagination_label: DisplayReference +sidebar_label: DisplayReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DisplayReference', 'V2025DisplayReference'] +slug: /tools/sdk/go/v2025/models/display-reference +tags: ['SDK', 'Software Development Kit', 'DisplayReference', 'V2025DisplayReference'] +--- + +# DisplayReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] + +## Methods + +### NewDisplayReference + +`func NewDisplayReference() *DisplayReference` + +NewDisplayReference instantiates a new DisplayReference 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 + +### NewDisplayReferenceWithDefaults + +`func NewDisplayReferenceWithDefaults() *DisplayReference` + +NewDisplayReferenceWithDefaults instantiates a new DisplayReference 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 + +### GetId + +`func (o *DisplayReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DisplayReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DisplayReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DisplayReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *DisplayReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DisplayReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DisplayReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DisplayReference) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *DisplayReference) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *DisplayReference) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *DisplayReference) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *DisplayReference) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DkimAttributes.md b/docs/tools/sdk/go/Reference/V2025/Models/DkimAttributes.md new file mode 100644 index 000000000..e88dbc2c3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DkimAttributes.md @@ -0,0 +1,168 @@ +--- +id: v2025-dkim-attributes +title: DkimAttributes +pagination_label: DkimAttributes +sidebar_label: DkimAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DkimAttributes', 'V2025DkimAttributes'] +slug: /tools/sdk/go/v2025/models/dkim-attributes +tags: ['SDK', 'Software Development Kit', 'DkimAttributes', 'V2025DkimAttributes'] +--- + +# DkimAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | UUID associated with domain to be verified | [optional] +**Address** | Pointer to **string** | The identity or domain address | [optional] +**DkimEnabled** | Pointer to **bool** | Whether or not DKIM has been enabled for this domain / identity | [optional] [default to false] +**DkimTokens** | Pointer to **[]string** | The tokens to be added to a DNS for verification | [optional] +**DkimVerificationStatus** | Pointer to **string** | The current status if the domain /identity has been verified. Ie Success, Failed, Pending | [optional] + +## Methods + +### NewDkimAttributes + +`func NewDkimAttributes() *DkimAttributes` + +NewDkimAttributes instantiates a new DkimAttributes 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 + +### NewDkimAttributesWithDefaults + +`func NewDkimAttributesWithDefaults() *DkimAttributes` + +NewDkimAttributesWithDefaults instantiates a new DkimAttributes 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 + +### GetId + +`func (o *DkimAttributes) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DkimAttributes) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DkimAttributes) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DkimAttributes) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAddress + +`func (o *DkimAttributes) GetAddress() string` + +GetAddress returns the Address field if non-nil, zero value otherwise. + +### GetAddressOk + +`func (o *DkimAttributes) GetAddressOk() (*string, bool)` + +GetAddressOk returns a tuple with the Address field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAddress + +`func (o *DkimAttributes) SetAddress(v string)` + +SetAddress sets Address field to given value. + +### HasAddress + +`func (o *DkimAttributes) HasAddress() bool` + +HasAddress returns a boolean if a field has been set. + +### GetDkimEnabled + +`func (o *DkimAttributes) GetDkimEnabled() bool` + +GetDkimEnabled returns the DkimEnabled field if non-nil, zero value otherwise. + +### GetDkimEnabledOk + +`func (o *DkimAttributes) GetDkimEnabledOk() (*bool, bool)` + +GetDkimEnabledOk returns a tuple with the DkimEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimEnabled + +`func (o *DkimAttributes) SetDkimEnabled(v bool)` + +SetDkimEnabled sets DkimEnabled field to given value. + +### HasDkimEnabled + +`func (o *DkimAttributes) HasDkimEnabled() bool` + +HasDkimEnabled returns a boolean if a field has been set. + +### GetDkimTokens + +`func (o *DkimAttributes) GetDkimTokens() []string` + +GetDkimTokens returns the DkimTokens field if non-nil, zero value otherwise. + +### GetDkimTokensOk + +`func (o *DkimAttributes) GetDkimTokensOk() (*[]string, bool)` + +GetDkimTokensOk returns a tuple with the DkimTokens field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimTokens + +`func (o *DkimAttributes) SetDkimTokens(v []string)` + +SetDkimTokens sets DkimTokens field to given value. + +### HasDkimTokens + +`func (o *DkimAttributes) HasDkimTokens() bool` + +HasDkimTokens returns a boolean if a field has been set. + +### GetDkimVerificationStatus + +`func (o *DkimAttributes) GetDkimVerificationStatus() string` + +GetDkimVerificationStatus returns the DkimVerificationStatus field if non-nil, zero value otherwise. + +### GetDkimVerificationStatusOk + +`func (o *DkimAttributes) GetDkimVerificationStatusOk() (*string, bool)` + +GetDkimVerificationStatusOk returns a tuple with the DkimVerificationStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimVerificationStatus + +`func (o *DkimAttributes) SetDkimVerificationStatus(v string)` + +SetDkimVerificationStatus sets DkimVerificationStatus field to given value. + +### HasDkimVerificationStatus + +`func (o *DkimAttributes) HasDkimVerificationStatus() bool` + +HasDkimVerificationStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DomainAddress.md b/docs/tools/sdk/go/Reference/V2025/Models/DomainAddress.md new file mode 100644 index 000000000..b5c3b57f8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DomainAddress.md @@ -0,0 +1,64 @@ +--- +id: v2025-domain-address +title: DomainAddress +pagination_label: DomainAddress +sidebar_label: DomainAddress +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DomainAddress', 'V2025DomainAddress'] +slug: /tools/sdk/go/v2025/models/domain-address +tags: ['SDK', 'Software Development Kit', 'DomainAddress', 'V2025DomainAddress'] +--- + +# DomainAddress + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Domain** | Pointer to **string** | A domain address | [optional] + +## Methods + +### NewDomainAddress + +`func NewDomainAddress() *DomainAddress` + +NewDomainAddress instantiates a new DomainAddress 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 + +### NewDomainAddressWithDefaults + +`func NewDomainAddressWithDefaults() *DomainAddress` + +NewDomainAddressWithDefaults instantiates a new DomainAddress 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 + +### GetDomain + +`func (o *DomainAddress) GetDomain() string` + +GetDomain returns the Domain field if non-nil, zero value otherwise. + +### GetDomainOk + +`func (o *DomainAddress) GetDomainOk() (*string, bool)` + +GetDomainOk returns a tuple with the Domain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDomain + +`func (o *DomainAddress) SetDomain(v string)` + +SetDomain sets Domain field to given value. + +### HasDomain + +`func (o *DomainAddress) HasDomain() bool` + +HasDomain returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DomainStatusDto.md b/docs/tools/sdk/go/Reference/V2025/Models/DomainStatusDto.md new file mode 100644 index 000000000..e2703ecdb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DomainStatusDto.md @@ -0,0 +1,168 @@ +--- +id: v2025-domain-status-dto +title: DomainStatusDto +pagination_label: DomainStatusDto +sidebar_label: DomainStatusDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DomainStatusDto', 'V2025DomainStatusDto'] +slug: /tools/sdk/go/v2025/models/domain-status-dto +tags: ['SDK', 'Software Development Kit', 'DomainStatusDto', 'V2025DomainStatusDto'] +--- + +# DomainStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | New UUID associated with domain to be verified | [optional] +**Domain** | Pointer to **string** | A domain address | [optional] +**DkimEnabled** | Pointer to **map[string]interface{}** | DKIM is enabled for this domain | [optional] [default to false] +**DkimTokens** | Pointer to **[]string** | DKIM tokens required for authentication | [optional] +**DkimVerificationStatus** | Pointer to **string** | Status of DKIM authentication | [optional] + +## Methods + +### NewDomainStatusDto + +`func NewDomainStatusDto() *DomainStatusDto` + +NewDomainStatusDto instantiates a new DomainStatusDto 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 + +### NewDomainStatusDtoWithDefaults + +`func NewDomainStatusDtoWithDefaults() *DomainStatusDto` + +NewDomainStatusDtoWithDefaults instantiates a new DomainStatusDto 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 + +### GetId + +`func (o *DomainStatusDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DomainStatusDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DomainStatusDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DomainStatusDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDomain + +`func (o *DomainStatusDto) GetDomain() string` + +GetDomain returns the Domain field if non-nil, zero value otherwise. + +### GetDomainOk + +`func (o *DomainStatusDto) GetDomainOk() (*string, bool)` + +GetDomainOk returns a tuple with the Domain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDomain + +`func (o *DomainStatusDto) SetDomain(v string)` + +SetDomain sets Domain field to given value. + +### HasDomain + +`func (o *DomainStatusDto) HasDomain() bool` + +HasDomain returns a boolean if a field has been set. + +### GetDkimEnabled + +`func (o *DomainStatusDto) GetDkimEnabled() map[string]interface{}` + +GetDkimEnabled returns the DkimEnabled field if non-nil, zero value otherwise. + +### GetDkimEnabledOk + +`func (o *DomainStatusDto) GetDkimEnabledOk() (*map[string]interface{}, bool)` + +GetDkimEnabledOk returns a tuple with the DkimEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimEnabled + +`func (o *DomainStatusDto) SetDkimEnabled(v map[string]interface{})` + +SetDkimEnabled sets DkimEnabled field to given value. + +### HasDkimEnabled + +`func (o *DomainStatusDto) HasDkimEnabled() bool` + +HasDkimEnabled returns a boolean if a field has been set. + +### GetDkimTokens + +`func (o *DomainStatusDto) GetDkimTokens() []string` + +GetDkimTokens returns the DkimTokens field if non-nil, zero value otherwise. + +### GetDkimTokensOk + +`func (o *DomainStatusDto) GetDkimTokensOk() (*[]string, bool)` + +GetDkimTokensOk returns a tuple with the DkimTokens field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimTokens + +`func (o *DomainStatusDto) SetDkimTokens(v []string)` + +SetDkimTokens sets DkimTokens field to given value. + +### HasDkimTokens + +`func (o *DomainStatusDto) HasDkimTokens() bool` + +HasDkimTokens returns a boolean if a field has been set. + +### GetDkimVerificationStatus + +`func (o *DomainStatusDto) GetDkimVerificationStatus() string` + +GetDkimVerificationStatus returns the DkimVerificationStatus field if non-nil, zero value otherwise. + +### GetDkimVerificationStatusOk + +`func (o *DomainStatusDto) GetDkimVerificationStatusOk() (*string, bool)` + +GetDkimVerificationStatusOk returns a tuple with the DkimVerificationStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDkimVerificationStatus + +`func (o *DomainStatusDto) SetDkimVerificationStatus(v string)` + +SetDkimVerificationStatus sets DkimVerificationStatus field to given value. + +### HasDkimVerificationStatus + +`func (o *DomainStatusDto) HasDkimVerificationStatus() bool` + +HasDkimVerificationStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DraftResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/DraftResponse.md new file mode 100644 index 000000000..4e438ed13 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DraftResponse.md @@ -0,0 +1,454 @@ +--- +id: v2025-draft-response +title: DraftResponse +pagination_label: DraftResponse +sidebar_label: DraftResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DraftResponse', 'V2025DraftResponse'] +slug: /tools/sdk/go/v2025/models/draft-response +tags: ['SDK', 'Software Development Kit', 'DraftResponse', 'V2025DraftResponse'] +--- + +# DraftResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | Pointer to **string** | Unique id assigned to this job. | [optional] +**Status** | Pointer to **string** | Status of the job. | [optional] +**Type** | Pointer to **string** | Type of the job, will always be CREATE_DRAFT for this type of job. | [optional] +**Message** | Pointer to **string** | Message providing information about the outcome of the draft process. | [optional] +**RequesterName** | Pointer to **string** | The name of user that that initiated the draft process. | [optional] +**FileExists** | Pointer to **bool** | Whether or not a file was generated for this draft. | [optional] [default to true] +**Created** | Pointer to **SailPointTime** | The time the job was started. | [optional] +**Modified** | Pointer to **SailPointTime** | The time of the last update to the job. | [optional] +**Completed** | Pointer to **SailPointTime** | The time the job was completed. | [optional] +**Name** | Pointer to **string** | Name of the draft. | [optional] +**SourceTenant** | Pointer to **string** | Tenant owner of the backup from which the draft was generated. | [optional] +**SourceBackupId** | Pointer to **string** | Id of the backup from which the draft was generated. | [optional] +**SourceBackupName** | Pointer to **string** | Name of the backup from which the draft was generated. | [optional] +**Mode** | Pointer to **string** | Denotes the origin of the source backup from which the draft was generated. - RESTORE - Same tenant. - PROMOTE - Different tenant. - UPLOAD - Uploaded configuration. | [optional] +**ApprovalStatus** | Pointer to **string** | Approval status of the draft used to determine whether or not the draft can be deployed. | [optional] +**ApprovalComment** | Pointer to [**[]ApprovalComment**](approval-comment) | List of comments that have been exchanged between an approval requester and an approver. | [optional] + +## Methods + +### NewDraftResponse + +`func NewDraftResponse() *DraftResponse` + +NewDraftResponse instantiates a new DraftResponse 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 + +### NewDraftResponseWithDefaults + +`func NewDraftResponseWithDefaults() *DraftResponse` + +NewDraftResponseWithDefaults instantiates a new DraftResponse 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 + +### GetJobId + +`func (o *DraftResponse) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *DraftResponse) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *DraftResponse) SetJobId(v string)` + +SetJobId sets JobId field to given value. + +### HasJobId + +`func (o *DraftResponse) HasJobId() bool` + +HasJobId returns a boolean if a field has been set. + +### GetStatus + +`func (o *DraftResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *DraftResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *DraftResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *DraftResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetType + +`func (o *DraftResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DraftResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DraftResponse) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DraftResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetMessage + +`func (o *DraftResponse) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *DraftResponse) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *DraftResponse) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *DraftResponse) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetRequesterName + +`func (o *DraftResponse) GetRequesterName() string` + +GetRequesterName returns the RequesterName field if non-nil, zero value otherwise. + +### GetRequesterNameOk + +`func (o *DraftResponse) GetRequesterNameOk() (*string, bool)` + +GetRequesterNameOk returns a tuple with the RequesterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterName + +`func (o *DraftResponse) SetRequesterName(v string)` + +SetRequesterName sets RequesterName field to given value. + +### HasRequesterName + +`func (o *DraftResponse) HasRequesterName() bool` + +HasRequesterName returns a boolean if a field has been set. + +### GetFileExists + +`func (o *DraftResponse) GetFileExists() bool` + +GetFileExists returns the FileExists field if non-nil, zero value otherwise. + +### GetFileExistsOk + +`func (o *DraftResponse) GetFileExistsOk() (*bool, bool)` + +GetFileExistsOk returns a tuple with the FileExists field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileExists + +`func (o *DraftResponse) SetFileExists(v bool)` + +SetFileExists sets FileExists field to given value. + +### HasFileExists + +`func (o *DraftResponse) HasFileExists() bool` + +HasFileExists returns a boolean if a field has been set. + +### GetCreated + +`func (o *DraftResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *DraftResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *DraftResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *DraftResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *DraftResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *DraftResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *DraftResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *DraftResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCompleted + +`func (o *DraftResponse) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *DraftResponse) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *DraftResponse) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *DraftResponse) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetName + +`func (o *DraftResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DraftResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DraftResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DraftResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceTenant + +`func (o *DraftResponse) GetSourceTenant() string` + +GetSourceTenant returns the SourceTenant field if non-nil, zero value otherwise. + +### GetSourceTenantOk + +`func (o *DraftResponse) GetSourceTenantOk() (*string, bool)` + +GetSourceTenantOk returns a tuple with the SourceTenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceTenant + +`func (o *DraftResponse) SetSourceTenant(v string)` + +SetSourceTenant sets SourceTenant field to given value. + +### HasSourceTenant + +`func (o *DraftResponse) HasSourceTenant() bool` + +HasSourceTenant returns a boolean if a field has been set. + +### GetSourceBackupId + +`func (o *DraftResponse) GetSourceBackupId() string` + +GetSourceBackupId returns the SourceBackupId field if non-nil, zero value otherwise. + +### GetSourceBackupIdOk + +`func (o *DraftResponse) GetSourceBackupIdOk() (*string, bool)` + +GetSourceBackupIdOk returns a tuple with the SourceBackupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceBackupId + +`func (o *DraftResponse) SetSourceBackupId(v string)` + +SetSourceBackupId sets SourceBackupId field to given value. + +### HasSourceBackupId + +`func (o *DraftResponse) HasSourceBackupId() bool` + +HasSourceBackupId returns a boolean if a field has been set. + +### GetSourceBackupName + +`func (o *DraftResponse) GetSourceBackupName() string` + +GetSourceBackupName returns the SourceBackupName field if non-nil, zero value otherwise. + +### GetSourceBackupNameOk + +`func (o *DraftResponse) GetSourceBackupNameOk() (*string, bool)` + +GetSourceBackupNameOk returns a tuple with the SourceBackupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceBackupName + +`func (o *DraftResponse) SetSourceBackupName(v string)` + +SetSourceBackupName sets SourceBackupName field to given value. + +### HasSourceBackupName + +`func (o *DraftResponse) HasSourceBackupName() bool` + +HasSourceBackupName returns a boolean if a field has been set. + +### GetMode + +`func (o *DraftResponse) GetMode() string` + +GetMode returns the Mode field if non-nil, zero value otherwise. + +### GetModeOk + +`func (o *DraftResponse) GetModeOk() (*string, bool)` + +GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMode + +`func (o *DraftResponse) SetMode(v string)` + +SetMode sets Mode field to given value. + +### HasMode + +`func (o *DraftResponse) HasMode() bool` + +HasMode returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *DraftResponse) GetApprovalStatus() string` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *DraftResponse) GetApprovalStatusOk() (*string, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *DraftResponse) SetApprovalStatus(v string)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *DraftResponse) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetApprovalComment + +`func (o *DraftResponse) GetApprovalComment() []ApprovalComment` + +GetApprovalComment returns the ApprovalComment field if non-nil, zero value otherwise. + +### GetApprovalCommentOk + +`func (o *DraftResponse) GetApprovalCommentOk() (*[]ApprovalComment, bool)` + +GetApprovalCommentOk returns a tuple with the ApprovalComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalComment + +`func (o *DraftResponse) SetApprovalComment(v []ApprovalComment)` + +SetApprovalComment sets ApprovalComment field to given value. + +### HasApprovalComment + +`func (o *DraftResponse) HasApprovalComment() bool` + +HasApprovalComment returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/DtoType.md b/docs/tools/sdk/go/Reference/V2025/Models/DtoType.md new file mode 100644 index 000000000..b6dc63191 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/DtoType.md @@ -0,0 +1,75 @@ +--- +id: v2025-dto-type +title: DtoType +pagination_label: DtoType +sidebar_label: DtoType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DtoType', 'V2025DtoType'] +slug: /tools/sdk/go/v2025/models/dto-type +tags: ['SDK', 'Software Development Kit', 'DtoType', 'V2025DtoType'] +--- + +# DtoType + +## Enum + + +* `ACCOUNT_CORRELATION_CONFIG` (value: `"ACCOUNT_CORRELATION_CONFIG"`) + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ACCESS_REQUEST_APPROVAL` (value: `"ACCESS_REQUEST_APPROVAL"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `APPLICATION` (value: `"APPLICATION"`) + +* `CAMPAIGN` (value: `"CAMPAIGN"`) + +* `CAMPAIGN_FILTER` (value: `"CAMPAIGN_FILTER"`) + +* `CERTIFICATION` (value: `"CERTIFICATION"`) + +* `CLUSTER` (value: `"CLUSTER"`) + +* `CONNECTOR_SCHEMA` (value: `"CONNECTOR_SCHEMA"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + +* `IDENTITY` (value: `"IDENTITY"`) + +* `IDENTITY_PROFILE` (value: `"IDENTITY_PROFILE"`) + +* `IDENTITY_REQUEST` (value: `"IDENTITY_REQUEST"`) + +* `MACHINE_IDENTITY` (value: `"MACHINE_IDENTITY"`) + +* `LIFECYCLE_STATE` (value: `"LIFECYCLE_STATE"`) + +* `PASSWORD_POLICY` (value: `"PASSWORD_POLICY"`) + +* `ROLE` (value: `"ROLE"`) + +* `RULE` (value: `"RULE"`) + +* `SOD_POLICY` (value: `"SOD_POLICY"`) + +* `SOURCE` (value: `"SOURCE"`) + +* `TAG` (value: `"TAG"`) + +* `TAG_CATEGORY` (value: `"TAG_CATEGORY"`) + +* `TASK_RESULT` (value: `"TASK_RESULT"`) + +* `REPORT_RESULT` (value: `"REPORT_RESULT"`) + +* `SOD_VIOLATION` (value: `"SOD_VIOLATION"`) + +* `ACCOUNT_ACTIVITY` (value: `"ACCOUNT_ACTIVITY"`) + +* `WORKGROUP` (value: `"WORKGROUP"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EmailNotificationOption.md b/docs/tools/sdk/go/Reference/V2025/Models/EmailNotificationOption.md new file mode 100644 index 000000000..82273de74 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EmailNotificationOption.md @@ -0,0 +1,142 @@ +--- +id: v2025-email-notification-option +title: EmailNotificationOption +pagination_label: EmailNotificationOption +sidebar_label: EmailNotificationOption +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EmailNotificationOption', 'V2025EmailNotificationOption'] +slug: /tools/sdk/go/v2025/models/email-notification-option +tags: ['SDK', 'Software Development Kit', 'EmailNotificationOption', 'V2025EmailNotificationOption'] +--- + +# EmailNotificationOption + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NotifyManagers** | Pointer to **bool** | If true, then the manager is notified of the lifecycle state change. | [optional] [default to false] +**NotifyAllAdmins** | Pointer to **bool** | If true, then all the admins are notified of the lifecycle state change. | [optional] [default to false] +**NotifySpecificUsers** | Pointer to **bool** | If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change. | [optional] [default to false] +**EmailAddressList** | Pointer to **[]string** | List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change. | [optional] + +## Methods + +### NewEmailNotificationOption + +`func NewEmailNotificationOption() *EmailNotificationOption` + +NewEmailNotificationOption instantiates a new EmailNotificationOption 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 + +### NewEmailNotificationOptionWithDefaults + +`func NewEmailNotificationOptionWithDefaults() *EmailNotificationOption` + +NewEmailNotificationOptionWithDefaults instantiates a new EmailNotificationOption 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 + +### GetNotifyManagers + +`func (o *EmailNotificationOption) GetNotifyManagers() bool` + +GetNotifyManagers returns the NotifyManagers field if non-nil, zero value otherwise. + +### GetNotifyManagersOk + +`func (o *EmailNotificationOption) GetNotifyManagersOk() (*bool, bool)` + +GetNotifyManagersOk returns a tuple with the NotifyManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifyManagers + +`func (o *EmailNotificationOption) SetNotifyManagers(v bool)` + +SetNotifyManagers sets NotifyManagers field to given value. + +### HasNotifyManagers + +`func (o *EmailNotificationOption) HasNotifyManagers() bool` + +HasNotifyManagers returns a boolean if a field has been set. + +### GetNotifyAllAdmins + +`func (o *EmailNotificationOption) GetNotifyAllAdmins() bool` + +GetNotifyAllAdmins returns the NotifyAllAdmins field if non-nil, zero value otherwise. + +### GetNotifyAllAdminsOk + +`func (o *EmailNotificationOption) GetNotifyAllAdminsOk() (*bool, bool)` + +GetNotifyAllAdminsOk returns a tuple with the NotifyAllAdmins field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifyAllAdmins + +`func (o *EmailNotificationOption) SetNotifyAllAdmins(v bool)` + +SetNotifyAllAdmins sets NotifyAllAdmins field to given value. + +### HasNotifyAllAdmins + +`func (o *EmailNotificationOption) HasNotifyAllAdmins() bool` + +HasNotifyAllAdmins returns a boolean if a field has been set. + +### GetNotifySpecificUsers + +`func (o *EmailNotificationOption) GetNotifySpecificUsers() bool` + +GetNotifySpecificUsers returns the NotifySpecificUsers field if non-nil, zero value otherwise. + +### GetNotifySpecificUsersOk + +`func (o *EmailNotificationOption) GetNotifySpecificUsersOk() (*bool, bool)` + +GetNotifySpecificUsersOk returns a tuple with the NotifySpecificUsers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifySpecificUsers + +`func (o *EmailNotificationOption) SetNotifySpecificUsers(v bool)` + +SetNotifySpecificUsers sets NotifySpecificUsers field to given value. + +### HasNotifySpecificUsers + +`func (o *EmailNotificationOption) HasNotifySpecificUsers() bool` + +HasNotifySpecificUsers returns a boolean if a field has been set. + +### GetEmailAddressList + +`func (o *EmailNotificationOption) GetEmailAddressList() []string` + +GetEmailAddressList returns the EmailAddressList field if non-nil, zero value otherwise. + +### GetEmailAddressListOk + +`func (o *EmailNotificationOption) GetEmailAddressListOk() (*[]string, bool)` + +GetEmailAddressListOk returns a tuple with the EmailAddressList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailAddressList + +`func (o *EmailNotificationOption) SetEmailAddressList(v []string)` + +SetEmailAddressList sets EmailAddressList field to given value. + +### HasEmailAddressList + +`func (o *EmailNotificationOption) HasEmailAddressList() bool` + +HasEmailAddressList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EmailStatusDto.md b/docs/tools/sdk/go/Reference/V2025/Models/EmailStatusDto.md new file mode 100644 index 000000000..7ffda19df --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EmailStatusDto.md @@ -0,0 +1,152 @@ +--- +id: v2025-email-status-dto +title: EmailStatusDto +pagination_label: EmailStatusDto +sidebar_label: EmailStatusDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EmailStatusDto', 'V2025EmailStatusDto'] +slug: /tools/sdk/go/v2025/models/email-status-dto +tags: ['SDK', 'Software Development Kit', 'EmailStatusDto', 'V2025EmailStatusDto'] +--- + +# EmailStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | | [optional] +**Email** | Pointer to **string** | | [optional] +**IsVerifiedByDomain** | Pointer to **bool** | | [optional] +**VerificationStatus** | Pointer to **string** | | [optional] + +## Methods + +### NewEmailStatusDto + +`func NewEmailStatusDto() *EmailStatusDto` + +NewEmailStatusDto instantiates a new EmailStatusDto 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 + +### NewEmailStatusDtoWithDefaults + +`func NewEmailStatusDtoWithDefaults() *EmailStatusDto` + +NewEmailStatusDtoWithDefaults instantiates a new EmailStatusDto 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 + +### GetId + +`func (o *EmailStatusDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EmailStatusDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EmailStatusDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EmailStatusDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *EmailStatusDto) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *EmailStatusDto) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetEmail + +`func (o *EmailStatusDto) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *EmailStatusDto) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *EmailStatusDto) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *EmailStatusDto) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetIsVerifiedByDomain + +`func (o *EmailStatusDto) GetIsVerifiedByDomain() bool` + +GetIsVerifiedByDomain returns the IsVerifiedByDomain field if non-nil, zero value otherwise. + +### GetIsVerifiedByDomainOk + +`func (o *EmailStatusDto) GetIsVerifiedByDomainOk() (*bool, bool)` + +GetIsVerifiedByDomainOk returns a tuple with the IsVerifiedByDomain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsVerifiedByDomain + +`func (o *EmailStatusDto) SetIsVerifiedByDomain(v bool)` + +SetIsVerifiedByDomain sets IsVerifiedByDomain field to given value. + +### HasIsVerifiedByDomain + +`func (o *EmailStatusDto) HasIsVerifiedByDomain() bool` + +HasIsVerifiedByDomain returns a boolean if a field has been set. + +### GetVerificationStatus + +`func (o *EmailStatusDto) GetVerificationStatus() string` + +GetVerificationStatus returns the VerificationStatus field if non-nil, zero value otherwise. + +### GetVerificationStatusOk + +`func (o *EmailStatusDto) GetVerificationStatusOk() (*string, bool)` + +GetVerificationStatusOk returns a tuple with the VerificationStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVerificationStatus + +`func (o *EmailStatusDto) SetVerificationStatus(v string)` + +SetVerificationStatus sets VerificationStatus field to given value. + +### HasVerificationStatus + +`func (o *EmailStatusDto) HasVerificationStatus() bool` + +HasVerificationStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Entitlement.md b/docs/tools/sdk/go/Reference/V2025/Models/Entitlement.md new file mode 100644 index 000000000..fc6fa7507 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Entitlement.md @@ -0,0 +1,546 @@ +--- +id: v2025-entitlement +title: Entitlement +pagination_label: Entitlement +sidebar_label: Entitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Entitlement', 'V2025Entitlement'] +slug: /tools/sdk/go/v2025/models/entitlement +tags: ['SDK', 'Software Development Kit', 'Entitlement', 'V2025Entitlement'] +--- + +# Entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The entitlement id | [optional] +**Name** | Pointer to **string** | The entitlement name | [optional] +**Attribute** | Pointer to **string** | The entitlement attribute name | [optional] +**Value** | Pointer to **string** | The value of the entitlement | [optional] +**SourceSchemaObjectType** | Pointer to **string** | The object type of the entitlement from the source schema | [optional] +**Description** | Pointer to **NullableString** | The description of the entitlement | [optional] +**Privileged** | Pointer to **bool** | True if the entitlement is privileged | [optional] [default to false] +**CloudGoverned** | Pointer to **bool** | True if the entitlement is cloud governed | [optional] [default to false] +**Requestable** | Pointer to **bool** | True if the entitlement is able to be directly requested | [optional] [default to false] +**Owner** | Pointer to [**NullableEntitlementOwner**](entitlement-owner) | | [optional] +**ManuallyUpdatedFields** | Pointer to **map[string]interface{}** | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [optional] +**AccessModelMetadata** | Pointer to [**EntitlementAccessModelMetadata**](entitlement-access-model-metadata) | | [optional] +**Created** | Pointer to **SailPointTime** | Time when the entitlement was created | [optional] +**Modified** | Pointer to **SailPointTime** | Time when the entitlement was last modified | [optional] +**Source** | Pointer to [**EntitlementSource**](entitlement-source) | | [optional] +**Attributes** | Pointer to **map[string]interface{}** | A map of free-form key-value pairs from the source system | [optional] +**Segments** | Pointer to **[]string** | List of IDs of segments, if any, to which this Entitlement is assigned. | [optional] +**DirectPermissions** | Pointer to [**[]PermissionDto**](permission-dto) | | [optional] + +## Methods + +### NewEntitlement + +`func NewEntitlement() *Entitlement` + +NewEntitlement instantiates a new Entitlement 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 + +### NewEntitlementWithDefaults + +`func NewEntitlementWithDefaults() *Entitlement` + +NewEntitlementWithDefaults instantiates a new Entitlement 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 + +### GetId + +`func (o *Entitlement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Entitlement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Entitlement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Entitlement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Entitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Entitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Entitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Entitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAttribute + +`func (o *Entitlement) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *Entitlement) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *Entitlement) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *Entitlement) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *Entitlement) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Entitlement) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Entitlement) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Entitlement) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSourceSchemaObjectType + +`func (o *Entitlement) GetSourceSchemaObjectType() string` + +GetSourceSchemaObjectType returns the SourceSchemaObjectType field if non-nil, zero value otherwise. + +### GetSourceSchemaObjectTypeOk + +`func (o *Entitlement) GetSourceSchemaObjectTypeOk() (*string, bool)` + +GetSourceSchemaObjectTypeOk returns a tuple with the SourceSchemaObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceSchemaObjectType + +`func (o *Entitlement) SetSourceSchemaObjectType(v string)` + +SetSourceSchemaObjectType sets SourceSchemaObjectType field to given value. + +### HasSourceSchemaObjectType + +`func (o *Entitlement) HasSourceSchemaObjectType() bool` + +HasSourceSchemaObjectType returns a boolean if a field has been set. + +### GetDescription + +`func (o *Entitlement) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Entitlement) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Entitlement) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Entitlement) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Entitlement) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Entitlement) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetPrivileged + +`func (o *Entitlement) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *Entitlement) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *Entitlement) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *Entitlement) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetCloudGoverned + +`func (o *Entitlement) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *Entitlement) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *Entitlement) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + +### HasCloudGoverned + +`func (o *Entitlement) HasCloudGoverned() bool` + +HasCloudGoverned returns a boolean if a field has been set. + +### GetRequestable + +`func (o *Entitlement) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *Entitlement) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *Entitlement) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *Entitlement) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetOwner + +`func (o *Entitlement) GetOwner() EntitlementOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Entitlement) GetOwnerOk() (*EntitlementOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Entitlement) SetOwner(v EntitlementOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *Entitlement) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *Entitlement) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *Entitlement) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetManuallyUpdatedFields + +`func (o *Entitlement) GetManuallyUpdatedFields() map[string]interface{}` + +GetManuallyUpdatedFields returns the ManuallyUpdatedFields field if non-nil, zero value otherwise. + +### GetManuallyUpdatedFieldsOk + +`func (o *Entitlement) GetManuallyUpdatedFieldsOk() (*map[string]interface{}, bool)` + +GetManuallyUpdatedFieldsOk returns a tuple with the ManuallyUpdatedFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyUpdatedFields + +`func (o *Entitlement) SetManuallyUpdatedFields(v map[string]interface{})` + +SetManuallyUpdatedFields sets ManuallyUpdatedFields field to given value. + +### HasManuallyUpdatedFields + +`func (o *Entitlement) HasManuallyUpdatedFields() bool` + +HasManuallyUpdatedFields returns a boolean if a field has been set. + +### SetManuallyUpdatedFieldsNil + +`func (o *Entitlement) SetManuallyUpdatedFieldsNil(b bool)` + + SetManuallyUpdatedFieldsNil sets the value for ManuallyUpdatedFields to be an explicit nil + +### UnsetManuallyUpdatedFields +`func (o *Entitlement) UnsetManuallyUpdatedFields()` + +UnsetManuallyUpdatedFields ensures that no value is present for ManuallyUpdatedFields, not even an explicit nil +### GetAccessModelMetadata + +`func (o *Entitlement) GetAccessModelMetadata() EntitlementAccessModelMetadata` + +GetAccessModelMetadata returns the AccessModelMetadata field if non-nil, zero value otherwise. + +### GetAccessModelMetadataOk + +`func (o *Entitlement) GetAccessModelMetadataOk() (*EntitlementAccessModelMetadata, bool)` + +GetAccessModelMetadataOk returns a tuple with the AccessModelMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessModelMetadata + +`func (o *Entitlement) SetAccessModelMetadata(v EntitlementAccessModelMetadata)` + +SetAccessModelMetadata sets AccessModelMetadata field to given value. + +### HasAccessModelMetadata + +`func (o *Entitlement) HasAccessModelMetadata() bool` + +HasAccessModelMetadata returns a boolean if a field has been set. + +### GetCreated + +`func (o *Entitlement) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Entitlement) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Entitlement) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Entitlement) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Entitlement) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Entitlement) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Entitlement) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Entitlement) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetSource + +`func (o *Entitlement) GetSource() EntitlementSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *Entitlement) GetSourceOk() (*EntitlementSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *Entitlement) SetSource(v EntitlementSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *Entitlement) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Entitlement) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Entitlement) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Entitlement) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Entitlement) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetSegments + +`func (o *Entitlement) GetSegments() []string` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *Entitlement) GetSegmentsOk() (*[]string, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *Entitlement) SetSegments(v []string)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *Entitlement) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### SetSegmentsNil + +`func (o *Entitlement) SetSegmentsNil(b bool)` + + SetSegmentsNil sets the value for Segments to be an explicit nil + +### UnsetSegments +`func (o *Entitlement) UnsetSegments()` + +UnsetSegments ensures that no value is present for Segments, not even an explicit nil +### GetDirectPermissions + +`func (o *Entitlement) GetDirectPermissions() []PermissionDto` + +GetDirectPermissions returns the DirectPermissions field if non-nil, zero value otherwise. + +### GetDirectPermissionsOk + +`func (o *Entitlement) GetDirectPermissionsOk() (*[]PermissionDto, bool)` + +GetDirectPermissionsOk returns a tuple with the DirectPermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectPermissions + +`func (o *Entitlement) SetDirectPermissions(v []PermissionDto)` + +SetDirectPermissions sets DirectPermissions field to given value. + +### HasDirectPermissions + +`func (o *Entitlement) HasDirectPermissions() bool` + +HasDirectPermissions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EntitlementAccessModelMetadata.md b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementAccessModelMetadata.md new file mode 100644 index 000000000..227f569ef --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementAccessModelMetadata.md @@ -0,0 +1,64 @@ +--- +id: v2025-entitlement-access-model-metadata +title: EntitlementAccessModelMetadata +pagination_label: EntitlementAccessModelMetadata +sidebar_label: EntitlementAccessModelMetadata +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementAccessModelMetadata', 'V2025EntitlementAccessModelMetadata'] +slug: /tools/sdk/go/v2025/models/entitlement-access-model-metadata +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadata', 'V2025EntitlementAccessModelMetadata'] +--- + +# EntitlementAccessModelMetadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]AccessModelMetadata**](access-model-metadata) | | [optional] + +## Methods + +### NewEntitlementAccessModelMetadata + +`func NewEntitlementAccessModelMetadata() *EntitlementAccessModelMetadata` + +NewEntitlementAccessModelMetadata instantiates a new EntitlementAccessModelMetadata 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 + +### NewEntitlementAccessModelMetadataWithDefaults + +`func NewEntitlementAccessModelMetadataWithDefaults() *EntitlementAccessModelMetadata` + +NewEntitlementAccessModelMetadataWithDefaults instantiates a new EntitlementAccessModelMetadata 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 + +### GetAttributes + +`func (o *EntitlementAccessModelMetadata) GetAttributes() []AccessModelMetadata` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *EntitlementAccessModelMetadata) GetAttributesOk() (*[]AccessModelMetadata, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *EntitlementAccessModelMetadata) SetAttributes(v []AccessModelMetadata)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *EntitlementAccessModelMetadata) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EntitlementAccessRequestConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementAccessRequestConfig.md new file mode 100644 index 000000000..e2420472a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementAccessRequestConfig.md @@ -0,0 +1,116 @@ +--- +id: v2025-entitlement-access-request-config +title: EntitlementAccessRequestConfig +pagination_label: EntitlementAccessRequestConfig +sidebar_label: EntitlementAccessRequestConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementAccessRequestConfig', 'V2025EntitlementAccessRequestConfig'] +slug: /tools/sdk/go/v2025/models/entitlement-access-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessRequestConfig', 'V2025EntitlementAccessRequestConfig'] +--- + +# EntitlementAccessRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalSchemes** | Pointer to [**[]EntitlementApprovalScheme**](entitlement-approval-scheme) | Ordered list of approval steps for the access request. Empty when no approval is required. | [optional] +**RequestCommentRequired** | Pointer to **bool** | If the requester must provide a comment during access request. | [optional] [default to false] +**DenialCommentRequired** | Pointer to **bool** | If the reviewer must provide a comment when denying the access request. | [optional] [default to false] + +## Methods + +### NewEntitlementAccessRequestConfig + +`func NewEntitlementAccessRequestConfig() *EntitlementAccessRequestConfig` + +NewEntitlementAccessRequestConfig instantiates a new EntitlementAccessRequestConfig 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 + +### NewEntitlementAccessRequestConfigWithDefaults + +`func NewEntitlementAccessRequestConfigWithDefaults() *EntitlementAccessRequestConfig` + +NewEntitlementAccessRequestConfigWithDefaults instantiates a new EntitlementAccessRequestConfig 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 + +### GetApprovalSchemes + +`func (o *EntitlementAccessRequestConfig) GetApprovalSchemes() []EntitlementApprovalScheme` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *EntitlementAccessRequestConfig) GetApprovalSchemesOk() (*[]EntitlementApprovalScheme, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *EntitlementAccessRequestConfig) SetApprovalSchemes(v []EntitlementApprovalScheme)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *EntitlementAccessRequestConfig) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + +### GetRequestCommentRequired + +`func (o *EntitlementAccessRequestConfig) GetRequestCommentRequired() bool` + +GetRequestCommentRequired returns the RequestCommentRequired field if non-nil, zero value otherwise. + +### GetRequestCommentRequiredOk + +`func (o *EntitlementAccessRequestConfig) GetRequestCommentRequiredOk() (*bool, bool)` + +GetRequestCommentRequiredOk returns a tuple with the RequestCommentRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentRequired + +`func (o *EntitlementAccessRequestConfig) SetRequestCommentRequired(v bool)` + +SetRequestCommentRequired sets RequestCommentRequired field to given value. + +### HasRequestCommentRequired + +`func (o *EntitlementAccessRequestConfig) HasRequestCommentRequired() bool` + +HasRequestCommentRequired returns a boolean if a field has been set. + +### GetDenialCommentRequired + +`func (o *EntitlementAccessRequestConfig) GetDenialCommentRequired() bool` + +GetDenialCommentRequired returns the DenialCommentRequired field if non-nil, zero value otherwise. + +### GetDenialCommentRequiredOk + +`func (o *EntitlementAccessRequestConfig) GetDenialCommentRequiredOk() (*bool, bool)` + +GetDenialCommentRequiredOk returns a tuple with the DenialCommentRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenialCommentRequired + +`func (o *EntitlementAccessRequestConfig) SetDenialCommentRequired(v bool)` + +SetDenialCommentRequired sets DenialCommentRequired field to given value. + +### HasDenialCommentRequired + +`func (o *EntitlementAccessRequestConfig) HasDenialCommentRequired() bool` + +HasDenialCommentRequired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EntitlementApprovalScheme.md b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementApprovalScheme.md new file mode 100644 index 000000000..c7d6f731f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementApprovalScheme.md @@ -0,0 +1,100 @@ +--- +id: v2025-entitlement-approval-scheme +title: EntitlementApprovalScheme +pagination_label: EntitlementApprovalScheme +sidebar_label: EntitlementApprovalScheme +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementApprovalScheme', 'V2025EntitlementApprovalScheme'] +slug: /tools/sdk/go/v2025/models/entitlement-approval-scheme +tags: ['SDK', 'Software Development Kit', 'EntitlementApprovalScheme', 'V2025EntitlementApprovalScheme'] +--- + +# EntitlementApprovalScheme + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApproverType** | Pointer to **string** | Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | Pointer to **NullableString** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] + +## Methods + +### NewEntitlementApprovalScheme + +`func NewEntitlementApprovalScheme() *EntitlementApprovalScheme` + +NewEntitlementApprovalScheme instantiates a new EntitlementApprovalScheme 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 + +### NewEntitlementApprovalSchemeWithDefaults + +`func NewEntitlementApprovalSchemeWithDefaults() *EntitlementApprovalScheme` + +NewEntitlementApprovalSchemeWithDefaults instantiates a new EntitlementApprovalScheme 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 + +### GetApproverType + +`func (o *EntitlementApprovalScheme) GetApproverType() string` + +GetApproverType returns the ApproverType field if non-nil, zero value otherwise. + +### GetApproverTypeOk + +`func (o *EntitlementApprovalScheme) GetApproverTypeOk() (*string, bool)` + +GetApproverTypeOk returns a tuple with the ApproverType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverType + +`func (o *EntitlementApprovalScheme) SetApproverType(v string)` + +SetApproverType sets ApproverType field to given value. + +### HasApproverType + +`func (o *EntitlementApprovalScheme) HasApproverType() bool` + +HasApproverType returns a boolean if a field has been set. + +### GetApproverId + +`func (o *EntitlementApprovalScheme) GetApproverId() string` + +GetApproverId returns the ApproverId field if non-nil, zero value otherwise. + +### GetApproverIdOk + +`func (o *EntitlementApprovalScheme) GetApproverIdOk() (*string, bool)` + +GetApproverIdOk returns a tuple with the ApproverId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverId + +`func (o *EntitlementApprovalScheme) SetApproverId(v string)` + +SetApproverId sets ApproverId field to given value. + +### HasApproverId + +`func (o *EntitlementApprovalScheme) HasApproverId() bool` + +HasApproverId returns a boolean if a field has been set. + +### SetApproverIdNil + +`func (o *EntitlementApprovalScheme) SetApproverIdNil(b bool)` + + SetApproverIdNil sets the value for ApproverId to be an explicit nil + +### UnsetApproverId +`func (o *EntitlementApprovalScheme) UnsetApproverId()` + +UnsetApproverId ensures that no value is present for ApproverId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EntitlementBulkUpdateRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementBulkUpdateRequest.md new file mode 100644 index 000000000..68268e257 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementBulkUpdateRequest.md @@ -0,0 +1,80 @@ +--- +id: v2025-entitlement-bulk-update-request +title: EntitlementBulkUpdateRequest +pagination_label: EntitlementBulkUpdateRequest +sidebar_label: EntitlementBulkUpdateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementBulkUpdateRequest', 'V2025EntitlementBulkUpdateRequest'] +slug: /tools/sdk/go/v2025/models/entitlement-bulk-update-request +tags: ['SDK', 'Software Development Kit', 'EntitlementBulkUpdateRequest', 'V2025EntitlementBulkUpdateRequest'] +--- + +# EntitlementBulkUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EntitlementIds** | **[]string** | List of entitlement ids to update | +**JsonPatch** | [**[]JsonPatchOperation**](json-patch-operation) | | + +## Methods + +### NewEntitlementBulkUpdateRequest + +`func NewEntitlementBulkUpdateRequest(entitlementIds []string, jsonPatch []JsonPatchOperation, ) *EntitlementBulkUpdateRequest` + +NewEntitlementBulkUpdateRequest instantiates a new EntitlementBulkUpdateRequest 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 + +### NewEntitlementBulkUpdateRequestWithDefaults + +`func NewEntitlementBulkUpdateRequestWithDefaults() *EntitlementBulkUpdateRequest` + +NewEntitlementBulkUpdateRequestWithDefaults instantiates a new EntitlementBulkUpdateRequest 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 + +### GetEntitlementIds + +`func (o *EntitlementBulkUpdateRequest) GetEntitlementIds() []string` + +GetEntitlementIds returns the EntitlementIds field if non-nil, zero value otherwise. + +### GetEntitlementIdsOk + +`func (o *EntitlementBulkUpdateRequest) GetEntitlementIdsOk() (*[]string, bool)` + +GetEntitlementIdsOk returns a tuple with the EntitlementIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementIds + +`func (o *EntitlementBulkUpdateRequest) SetEntitlementIds(v []string)` + +SetEntitlementIds sets EntitlementIds field to given value. + + +### GetJsonPatch + +`func (o *EntitlementBulkUpdateRequest) GetJsonPatch() []JsonPatchOperation` + +GetJsonPatch returns the JsonPatch field if non-nil, zero value otherwise. + +### GetJsonPatchOk + +`func (o *EntitlementBulkUpdateRequest) GetJsonPatchOk() (*[]JsonPatchOperation, bool)` + +GetJsonPatchOk returns a tuple with the JsonPatch field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJsonPatch + +`func (o *EntitlementBulkUpdateRequest) SetJsonPatch(v []JsonPatchOperation)` + +SetJsonPatch sets JsonPatch field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EntitlementDocument.md b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementDocument.md new file mode 100644 index 000000000..095c9f9e1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementDocument.md @@ -0,0 +1,656 @@ +--- +id: v2025-entitlement-document +title: EntitlementDocument +pagination_label: EntitlementDocument +sidebar_label: EntitlementDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementDocument', 'V2025EntitlementDocument'] +slug: /tools/sdk/go/v2025/models/entitlement-document +tags: ['SDK', 'Software Development Kit', 'EntitlementDocument', 'V2025EntitlementDocument'] +--- + +# EntitlementDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the referenced object. | +**Name** | **string** | The human readable name of the referenced object. | +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**DisplayName** | Pointer to **string** | Entitlement's display name. | [optional] +**Source** | Pointer to [**EntitlementDocumentAllOfSource**](entitlement-document-all-of-source) | | [optional] +**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the entitlement. | [optional] +**SegmentCount** | Pointer to **int32** | Number of segments with the role. | [optional] +**Requestable** | Pointer to **bool** | Indicates whether the entitlement is requestable. | [optional] [default to false] +**CloudGoverned** | Pointer to **bool** | Indicates whether the entitlement is cloud governed. | [optional] [default to false] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Privileged** | Pointer to **bool** | Indicates whether the entitlement is privileged. | [optional] [default to false] +**Tags** | Pointer to **[]string** | Tags that have been applied to the object. | [optional] +**Attribute** | Pointer to **string** | Attribute information for the entitlement. | [optional] +**Value** | Pointer to **string** | Value of the entitlement. | [optional] +**SourceSchemaObjectType** | Pointer to **string** | Source schema object type of the entitlement. | [optional] +**Schema** | Pointer to **string** | Schema type of the entitlement. | [optional] +**Hash** | Pointer to **string** | Read-only calculated hash value of an entitlement. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Attributes of the entitlement. | [optional] +**TruncatedAttributes** | Pointer to **[]string** | Truncated attributes of the entitlement. | [optional] +**ContainsDataAccess** | Pointer to **bool** | Indicates whether the entitlement contains data access. | [optional] [default to false] +**ManuallyUpdatedFields** | Pointer to [**NullableEntitlementDocumentAllOfManuallyUpdatedFields**](entitlement-document-all-of-manually-updated-fields) | | [optional] +**Permissions** | Pointer to [**[]EntitlementDocumentAllOfPermissions**](entitlement-document-all-of-permissions) | | [optional] + +## Methods + +### NewEntitlementDocument + +`func NewEntitlementDocument(id string, name string, ) *EntitlementDocument` + +NewEntitlementDocument instantiates a new EntitlementDocument 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 + +### NewEntitlementDocumentWithDefaults + +`func NewEntitlementDocumentWithDefaults() *EntitlementDocument` + +NewEntitlementDocumentWithDefaults instantiates a new EntitlementDocument 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 + +### GetId + +`func (o *EntitlementDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementDocument) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *EntitlementDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementDocument) SetName(v string)` + +SetName sets Name field to given value. + + +### GetModified + +`func (o *EntitlementDocument) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *EntitlementDocument) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *EntitlementDocument) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *EntitlementDocument) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *EntitlementDocument) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *EntitlementDocument) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *EntitlementDocument) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *EntitlementDocument) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *EntitlementDocument) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *EntitlementDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *EntitlementDocument) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *EntitlementDocument) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *EntitlementDocument) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *EntitlementDocument) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSource + +`func (o *EntitlementDocument) GetSource() EntitlementDocumentAllOfSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *EntitlementDocument) GetSourceOk() (*EntitlementDocumentAllOfSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *EntitlementDocument) SetSource(v EntitlementDocumentAllOfSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *EntitlementDocument) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetSegments + +`func (o *EntitlementDocument) GetSegments() []BaseSegment` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *EntitlementDocument) GetSegmentsOk() (*[]BaseSegment, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *EntitlementDocument) SetSegments(v []BaseSegment)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *EntitlementDocument) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### GetSegmentCount + +`func (o *EntitlementDocument) GetSegmentCount() int32` + +GetSegmentCount returns the SegmentCount field if non-nil, zero value otherwise. + +### GetSegmentCountOk + +`func (o *EntitlementDocument) GetSegmentCountOk() (*int32, bool)` + +GetSegmentCountOk returns a tuple with the SegmentCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegmentCount + +`func (o *EntitlementDocument) SetSegmentCount(v int32)` + +SetSegmentCount sets SegmentCount field to given value. + +### HasSegmentCount + +`func (o *EntitlementDocument) HasSegmentCount() bool` + +HasSegmentCount returns a boolean if a field has been set. + +### GetRequestable + +`func (o *EntitlementDocument) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *EntitlementDocument) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *EntitlementDocument) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *EntitlementDocument) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetCloudGoverned + +`func (o *EntitlementDocument) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *EntitlementDocument) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *EntitlementDocument) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + +### HasCloudGoverned + +`func (o *EntitlementDocument) HasCloudGoverned() bool` + +HasCloudGoverned returns a boolean if a field has been set. + +### GetCreated + +`func (o *EntitlementDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *EntitlementDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *EntitlementDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *EntitlementDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *EntitlementDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *EntitlementDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetPrivileged + +`func (o *EntitlementDocument) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *EntitlementDocument) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *EntitlementDocument) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *EntitlementDocument) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetTags + +`func (o *EntitlementDocument) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *EntitlementDocument) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *EntitlementDocument) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *EntitlementDocument) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetAttribute + +`func (o *EntitlementDocument) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *EntitlementDocument) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *EntitlementDocument) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *EntitlementDocument) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *EntitlementDocument) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *EntitlementDocument) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *EntitlementDocument) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *EntitlementDocument) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSourceSchemaObjectType + +`func (o *EntitlementDocument) GetSourceSchemaObjectType() string` + +GetSourceSchemaObjectType returns the SourceSchemaObjectType field if non-nil, zero value otherwise. + +### GetSourceSchemaObjectTypeOk + +`func (o *EntitlementDocument) GetSourceSchemaObjectTypeOk() (*string, bool)` + +GetSourceSchemaObjectTypeOk returns a tuple with the SourceSchemaObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceSchemaObjectType + +`func (o *EntitlementDocument) SetSourceSchemaObjectType(v string)` + +SetSourceSchemaObjectType sets SourceSchemaObjectType field to given value. + +### HasSourceSchemaObjectType + +`func (o *EntitlementDocument) HasSourceSchemaObjectType() bool` + +HasSourceSchemaObjectType returns a boolean if a field has been set. + +### GetSchema + +`func (o *EntitlementDocument) GetSchema() string` + +GetSchema returns the Schema field if non-nil, zero value otherwise. + +### GetSchemaOk + +`func (o *EntitlementDocument) GetSchemaOk() (*string, bool)` + +GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchema + +`func (o *EntitlementDocument) SetSchema(v string)` + +SetSchema sets Schema field to given value. + +### HasSchema + +`func (o *EntitlementDocument) HasSchema() bool` + +HasSchema returns a boolean if a field has been set. + +### GetHash + +`func (o *EntitlementDocument) GetHash() string` + +GetHash returns the Hash field if non-nil, zero value otherwise. + +### GetHashOk + +`func (o *EntitlementDocument) GetHashOk() (*string, bool)` + +GetHashOk returns a tuple with the Hash field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHash + +`func (o *EntitlementDocument) SetHash(v string)` + +SetHash sets Hash field to given value. + +### HasHash + +`func (o *EntitlementDocument) HasHash() bool` + +HasHash returns a boolean if a field has been set. + +### GetAttributes + +`func (o *EntitlementDocument) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *EntitlementDocument) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *EntitlementDocument) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *EntitlementDocument) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetTruncatedAttributes + +`func (o *EntitlementDocument) GetTruncatedAttributes() []string` + +GetTruncatedAttributes returns the TruncatedAttributes field if non-nil, zero value otherwise. + +### GetTruncatedAttributesOk + +`func (o *EntitlementDocument) GetTruncatedAttributesOk() (*[]string, bool)` + +GetTruncatedAttributesOk returns a tuple with the TruncatedAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTruncatedAttributes + +`func (o *EntitlementDocument) SetTruncatedAttributes(v []string)` + +SetTruncatedAttributes sets TruncatedAttributes field to given value. + +### HasTruncatedAttributes + +`func (o *EntitlementDocument) HasTruncatedAttributes() bool` + +HasTruncatedAttributes returns a boolean if a field has been set. + +### GetContainsDataAccess + +`func (o *EntitlementDocument) GetContainsDataAccess() bool` + +GetContainsDataAccess returns the ContainsDataAccess field if non-nil, zero value otherwise. + +### GetContainsDataAccessOk + +`func (o *EntitlementDocument) GetContainsDataAccessOk() (*bool, bool)` + +GetContainsDataAccessOk returns a tuple with the ContainsDataAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainsDataAccess + +`func (o *EntitlementDocument) SetContainsDataAccess(v bool)` + +SetContainsDataAccess sets ContainsDataAccess field to given value. + +### HasContainsDataAccess + +`func (o *EntitlementDocument) HasContainsDataAccess() bool` + +HasContainsDataAccess returns a boolean if a field has been set. + +### GetManuallyUpdatedFields + +`func (o *EntitlementDocument) GetManuallyUpdatedFields() EntitlementDocumentAllOfManuallyUpdatedFields` + +GetManuallyUpdatedFields returns the ManuallyUpdatedFields field if non-nil, zero value otherwise. + +### GetManuallyUpdatedFieldsOk + +`func (o *EntitlementDocument) GetManuallyUpdatedFieldsOk() (*EntitlementDocumentAllOfManuallyUpdatedFields, bool)` + +GetManuallyUpdatedFieldsOk returns a tuple with the ManuallyUpdatedFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyUpdatedFields + +`func (o *EntitlementDocument) SetManuallyUpdatedFields(v EntitlementDocumentAllOfManuallyUpdatedFields)` + +SetManuallyUpdatedFields sets ManuallyUpdatedFields field to given value. + +### HasManuallyUpdatedFields + +`func (o *EntitlementDocument) HasManuallyUpdatedFields() bool` + +HasManuallyUpdatedFields returns a boolean if a field has been set. + +### SetManuallyUpdatedFieldsNil + +`func (o *EntitlementDocument) SetManuallyUpdatedFieldsNil(b bool)` + + SetManuallyUpdatedFieldsNil sets the value for ManuallyUpdatedFields to be an explicit nil + +### UnsetManuallyUpdatedFields +`func (o *EntitlementDocument) UnsetManuallyUpdatedFields()` + +UnsetManuallyUpdatedFields ensures that no value is present for ManuallyUpdatedFields, not even an explicit nil +### GetPermissions + +`func (o *EntitlementDocument) GetPermissions() []EntitlementDocumentAllOfPermissions` + +GetPermissions returns the Permissions field if non-nil, zero value otherwise. + +### GetPermissionsOk + +`func (o *EntitlementDocument) GetPermissionsOk() (*[]EntitlementDocumentAllOfPermissions, bool)` + +GetPermissionsOk returns a tuple with the Permissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPermissions + +`func (o *EntitlementDocument) SetPermissions(v []EntitlementDocumentAllOfPermissions)` + +SetPermissions sets Permissions field to given value. + +### HasPermissions + +`func (o *EntitlementDocument) HasPermissions() bool` + +HasPermissions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md new file mode 100644 index 000000000..4cd4abf05 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md @@ -0,0 +1,90 @@ +--- +id: v2025-entitlement-document-all-of-manually-updated-fields +title: EntitlementDocumentAllOfManuallyUpdatedFields +pagination_label: EntitlementDocumentAllOfManuallyUpdatedFields +sidebar_label: EntitlementDocumentAllOfManuallyUpdatedFields +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'V2025EntitlementDocumentAllOfManuallyUpdatedFields'] +slug: /tools/sdk/go/v2025/models/entitlement-document-all-of-manually-updated-fields +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'V2025EntitlementDocumentAllOfManuallyUpdatedFields'] +--- + +# EntitlementDocumentAllOfManuallyUpdatedFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DESCRIPTION** | Pointer to **bool** | | [optional] [default to false] +**DISPLAY_NAME** | Pointer to **bool** | | [optional] [default to false] + +## Methods + +### NewEntitlementDocumentAllOfManuallyUpdatedFields + +`func NewEntitlementDocumentAllOfManuallyUpdatedFields() *EntitlementDocumentAllOfManuallyUpdatedFields` + +NewEntitlementDocumentAllOfManuallyUpdatedFields instantiates a new EntitlementDocumentAllOfManuallyUpdatedFields 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 + +### NewEntitlementDocumentAllOfManuallyUpdatedFieldsWithDefaults + +`func NewEntitlementDocumentAllOfManuallyUpdatedFieldsWithDefaults() *EntitlementDocumentAllOfManuallyUpdatedFields` + +NewEntitlementDocumentAllOfManuallyUpdatedFieldsWithDefaults instantiates a new EntitlementDocumentAllOfManuallyUpdatedFields 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 + +### GetDESCRIPTION + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) GetDESCRIPTION() bool` + +GetDESCRIPTION returns the DESCRIPTION field if non-nil, zero value otherwise. + +### GetDESCRIPTIONOk + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) GetDESCRIPTIONOk() (*bool, bool)` + +GetDESCRIPTIONOk returns a tuple with the DESCRIPTION field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDESCRIPTION + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) SetDESCRIPTION(v bool)` + +SetDESCRIPTION sets DESCRIPTION field to given value. + +### HasDESCRIPTION + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) HasDESCRIPTION() bool` + +HasDESCRIPTION returns a boolean if a field has been set. + +### GetDISPLAY_NAME + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) GetDISPLAY_NAME() bool` + +GetDISPLAY_NAME returns the DISPLAY_NAME field if non-nil, zero value otherwise. + +### GetDISPLAY_NAMEOk + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) GetDISPLAY_NAMEOk() (*bool, bool)` + +GetDISPLAY_NAMEOk returns a tuple with the DISPLAY_NAME field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDISPLAY_NAME + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) SetDISPLAY_NAME(v bool)` + +SetDISPLAY_NAME sets DISPLAY_NAME field to given value. + +### HasDISPLAY_NAME + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) HasDISPLAY_NAME() bool` + +HasDISPLAY_NAME returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EntitlementDocumentAllOfPermissions.md b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementDocumentAllOfPermissions.md new file mode 100644 index 000000000..3b930095a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementDocumentAllOfPermissions.md @@ -0,0 +1,90 @@ +--- +id: v2025-entitlement-document-all-of-permissions +title: EntitlementDocumentAllOfPermissions +pagination_label: EntitlementDocumentAllOfPermissions +sidebar_label: EntitlementDocumentAllOfPermissions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementDocumentAllOfPermissions', 'V2025EntitlementDocumentAllOfPermissions'] +slug: /tools/sdk/go/v2025/models/entitlement-document-all-of-permissions +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfPermissions', 'V2025EntitlementDocumentAllOfPermissions'] +--- + +# EntitlementDocumentAllOfPermissions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Target** | Pointer to **string** | The target the permission would grants rights on. | [optional] +**Rights** | Pointer to **[]string** | All the rights (e.g. actions) that this permission allows on the target | [optional] + +## Methods + +### NewEntitlementDocumentAllOfPermissions + +`func NewEntitlementDocumentAllOfPermissions() *EntitlementDocumentAllOfPermissions` + +NewEntitlementDocumentAllOfPermissions instantiates a new EntitlementDocumentAllOfPermissions 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 + +### NewEntitlementDocumentAllOfPermissionsWithDefaults + +`func NewEntitlementDocumentAllOfPermissionsWithDefaults() *EntitlementDocumentAllOfPermissions` + +NewEntitlementDocumentAllOfPermissionsWithDefaults instantiates a new EntitlementDocumentAllOfPermissions 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 + +### GetTarget + +`func (o *EntitlementDocumentAllOfPermissions) GetTarget() string` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *EntitlementDocumentAllOfPermissions) GetTargetOk() (*string, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *EntitlementDocumentAllOfPermissions) SetTarget(v string)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *EntitlementDocumentAllOfPermissions) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + +### GetRights + +`func (o *EntitlementDocumentAllOfPermissions) GetRights() []string` + +GetRights returns the Rights field if non-nil, zero value otherwise. + +### GetRightsOk + +`func (o *EntitlementDocumentAllOfPermissions) GetRightsOk() (*[]string, bool)` + +GetRightsOk returns a tuple with the Rights field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRights + +`func (o *EntitlementDocumentAllOfPermissions) SetRights(v []string)` + +SetRights sets Rights field to given value. + +### HasRights + +`func (o *EntitlementDocumentAllOfPermissions) HasRights() bool` + +HasRights returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EntitlementDocumentAllOfSource.md b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementDocumentAllOfSource.md new file mode 100644 index 000000000..aa8850b73 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementDocumentAllOfSource.md @@ -0,0 +1,116 @@ +--- +id: v2025-entitlement-document-all-of-source +title: EntitlementDocumentAllOfSource +pagination_label: EntitlementDocumentAllOfSource +sidebar_label: EntitlementDocumentAllOfSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementDocumentAllOfSource', 'V2025EntitlementDocumentAllOfSource'] +slug: /tools/sdk/go/v2025/models/entitlement-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfSource', 'V2025EntitlementDocumentAllOfSource'] +--- + +# EntitlementDocumentAllOfSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of entitlement's source. | [optional] +**Name** | Pointer to **string** | Display name of entitlement's source. | [optional] +**Type** | Pointer to **string** | Type of object. | [optional] + +## Methods + +### NewEntitlementDocumentAllOfSource + +`func NewEntitlementDocumentAllOfSource() *EntitlementDocumentAllOfSource` + +NewEntitlementDocumentAllOfSource instantiates a new EntitlementDocumentAllOfSource 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 + +### NewEntitlementDocumentAllOfSourceWithDefaults + +`func NewEntitlementDocumentAllOfSourceWithDefaults() *EntitlementDocumentAllOfSource` + +NewEntitlementDocumentAllOfSourceWithDefaults instantiates a new EntitlementDocumentAllOfSource 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 + +### GetId + +`func (o *EntitlementDocumentAllOfSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementDocumentAllOfSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementDocumentAllOfSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementDocumentAllOfSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementDocumentAllOfSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementDocumentAllOfSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementDocumentAllOfSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementDocumentAllOfSource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *EntitlementDocumentAllOfSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementDocumentAllOfSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementDocumentAllOfSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementDocumentAllOfSource) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EntitlementOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementOwner.md new file mode 100644 index 000000000..aab128908 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementOwner.md @@ -0,0 +1,116 @@ +--- +id: v2025-entitlement-owner +title: EntitlementOwner +pagination_label: EntitlementOwner +sidebar_label: EntitlementOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementOwner', 'V2025EntitlementOwner'] +slug: /tools/sdk/go/v2025/models/entitlement-owner +tags: ['SDK', 'Software Development Kit', 'EntitlementOwner', 'V2025EntitlementOwner'] +--- + +# EntitlementOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity ID | [optional] +**Type** | Pointer to **string** | The type of object | [optional] +**Name** | Pointer to **string** | The display name of the identity | [optional] + +## Methods + +### NewEntitlementOwner + +`func NewEntitlementOwner() *EntitlementOwner` + +NewEntitlementOwner instantiates a new EntitlementOwner 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 + +### NewEntitlementOwnerWithDefaults + +`func NewEntitlementOwnerWithDefaults() *EntitlementOwner` + +NewEntitlementOwnerWithDefaults instantiates a new EntitlementOwner 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 + +### GetId + +`func (o *EntitlementOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *EntitlementOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EntitlementRef.md b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementRef.md new file mode 100644 index 000000000..5ceb0cf42 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementRef.md @@ -0,0 +1,126 @@ +--- +id: v2025-entitlement-ref +title: EntitlementRef +pagination_label: EntitlementRef +sidebar_label: EntitlementRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementRef', 'V2025EntitlementRef'] +slug: /tools/sdk/go/v2025/models/entitlement-ref +tags: ['SDK', 'Software Development Kit', 'EntitlementRef', 'V2025EntitlementRef'] +--- + +# EntitlementRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Entitlement's DTO type. | [optional] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **NullableString** | Entitlement's display name. | [optional] + +## Methods + +### NewEntitlementRef + +`func NewEntitlementRef() *EntitlementRef` + +NewEntitlementRef instantiates a new EntitlementRef 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 + +### NewEntitlementRefWithDefaults + +`func NewEntitlementRefWithDefaults() *EntitlementRef` + +NewEntitlementRefWithDefaults instantiates a new EntitlementRef 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 + +### GetType + +`func (o *EntitlementRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *EntitlementRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementRef) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *EntitlementRef) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *EntitlementRef) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EntitlementRef1.md b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementRef1.md new file mode 100644 index 000000000..49f9cb436 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementRef1.md @@ -0,0 +1,116 @@ +--- +id: v2025-entitlement-ref1 +title: EntitlementRef1 +pagination_label: EntitlementRef1 +sidebar_label: EntitlementRef1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementRef1', 'V2025EntitlementRef1'] +slug: /tools/sdk/go/v2025/models/entitlement-ref1 +tags: ['SDK', 'Software Development Kit', 'EntitlementRef1', 'V2025EntitlementRef1'] +--- + +# EntitlementRef1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Entitlement's DTO type. | [optional] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **string** | Entitlement's display name. | [optional] + +## Methods + +### NewEntitlementRef1 + +`func NewEntitlementRef1() *EntitlementRef1` + +NewEntitlementRef1 instantiates a new EntitlementRef1 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 + +### NewEntitlementRef1WithDefaults + +`func NewEntitlementRef1WithDefaults() *EntitlementRef1` + +NewEntitlementRef1WithDefaults instantiates a new EntitlementRef1 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 + +### GetType + +`func (o *EntitlementRef1) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementRef1) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementRef1) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementRef1) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *EntitlementRef1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementRef1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementRef1) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementRef1) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementRef1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementRef1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementRef1) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementRef1) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EntitlementRequestConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementRequestConfig.md new file mode 100644 index 000000000..6f35aeae3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementRequestConfig.md @@ -0,0 +1,64 @@ +--- +id: v2025-entitlement-request-config +title: EntitlementRequestConfig +pagination_label: EntitlementRequestConfig +sidebar_label: EntitlementRequestConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementRequestConfig', 'V2025EntitlementRequestConfig'] +slug: /tools/sdk/go/v2025/models/entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig', 'V2025EntitlementRequestConfig'] +--- + +# EntitlementRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestConfig** | Pointer to [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] + +## Methods + +### NewEntitlementRequestConfig + +`func NewEntitlementRequestConfig() *EntitlementRequestConfig` + +NewEntitlementRequestConfig instantiates a new EntitlementRequestConfig 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 + +### NewEntitlementRequestConfigWithDefaults + +`func NewEntitlementRequestConfigWithDefaults() *EntitlementRequestConfig` + +NewEntitlementRequestConfigWithDefaults instantiates a new EntitlementRequestConfig 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 + +### GetAccessRequestConfig + +`func (o *EntitlementRequestConfig) GetAccessRequestConfig() EntitlementAccessRequestConfig` + +GetAccessRequestConfig returns the AccessRequestConfig field if non-nil, zero value otherwise. + +### GetAccessRequestConfigOk + +`func (o *EntitlementRequestConfig) GetAccessRequestConfigOk() (*EntitlementAccessRequestConfig, bool)` + +GetAccessRequestConfigOk returns a tuple with the AccessRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestConfig + +`func (o *EntitlementRequestConfig) SetAccessRequestConfig(v EntitlementAccessRequestConfig)` + +SetAccessRequestConfig sets AccessRequestConfig field to given value. + +### HasAccessRequestConfig + +`func (o *EntitlementRequestConfig) HasAccessRequestConfig() bool` + +HasAccessRequestConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EntitlementSource.md b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementSource.md new file mode 100644 index 000000000..5d6ac6245 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementSource.md @@ -0,0 +1,116 @@ +--- +id: v2025-entitlement-source +title: EntitlementSource +pagination_label: EntitlementSource +sidebar_label: EntitlementSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementSource', 'V2025EntitlementSource'] +slug: /tools/sdk/go/v2025/models/entitlement-source +tags: ['SDK', 'Software Development Kit', 'EntitlementSource', 'V2025EntitlementSource'] +--- + +# EntitlementSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The source ID | [optional] +**Type** | Pointer to **string** | The source type, will always be \"SOURCE\" | [optional] +**Name** | Pointer to **string** | The source name | [optional] + +## Methods + +### NewEntitlementSource + +`func NewEntitlementSource() *EntitlementSource` + +NewEntitlementSource instantiates a new EntitlementSource 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 + +### NewEntitlementSourceWithDefaults + +`func NewEntitlementSourceWithDefaults() *EntitlementSource` + +NewEntitlementSourceWithDefaults instantiates a new EntitlementSource 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 + +### GetId + +`func (o *EntitlementSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *EntitlementSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EntitlementSourceResetBaseReferenceDto.md b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementSourceResetBaseReferenceDto.md new file mode 100644 index 000000000..8c13505ba --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementSourceResetBaseReferenceDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-entitlement-source-reset-base-reference-dto +title: EntitlementSourceResetBaseReferenceDto +pagination_label: EntitlementSourceResetBaseReferenceDto +sidebar_label: EntitlementSourceResetBaseReferenceDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementSourceResetBaseReferenceDto', 'V2025EntitlementSourceResetBaseReferenceDto'] +slug: /tools/sdk/go/v2025/models/entitlement-source-reset-base-reference-dto +tags: ['SDK', 'Software Development Kit', 'EntitlementSourceResetBaseReferenceDto', 'V2025EntitlementSourceResetBaseReferenceDto'] +--- + +# EntitlementSourceResetBaseReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The DTO type | [optional] +**Id** | Pointer to **string** | The task ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewEntitlementSourceResetBaseReferenceDto + +`func NewEntitlementSourceResetBaseReferenceDto() *EntitlementSourceResetBaseReferenceDto` + +NewEntitlementSourceResetBaseReferenceDto instantiates a new EntitlementSourceResetBaseReferenceDto 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 + +### NewEntitlementSourceResetBaseReferenceDtoWithDefaults + +`func NewEntitlementSourceResetBaseReferenceDtoWithDefaults() *EntitlementSourceResetBaseReferenceDto` + +NewEntitlementSourceResetBaseReferenceDtoWithDefaults instantiates a new EntitlementSourceResetBaseReferenceDto 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 + +### GetType + +`func (o *EntitlementSourceResetBaseReferenceDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementSourceResetBaseReferenceDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementSourceResetBaseReferenceDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementSourceResetBaseReferenceDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *EntitlementSourceResetBaseReferenceDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementSourceResetBaseReferenceDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementSourceResetBaseReferenceDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementSourceResetBaseReferenceDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementSourceResetBaseReferenceDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementSourceResetBaseReferenceDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementSourceResetBaseReferenceDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementSourceResetBaseReferenceDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EntitlementSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementSummary.md new file mode 100644 index 000000000..7269ffd9e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EntitlementSummary.md @@ -0,0 +1,308 @@ +--- +id: v2025-entitlement-summary +title: EntitlementSummary +pagination_label: EntitlementSummary +sidebar_label: EntitlementSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementSummary', 'V2025EntitlementSummary'] +slug: /tools/sdk/go/v2025/models/entitlement-summary +tags: ['SDK', 'Software Development Kit', 'EntitlementSummary', 'V2025EntitlementSummary'] +--- + +# EntitlementSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Source** | Pointer to [**Reference**](reference) | | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Privileged** | Pointer to **bool** | | [optional] +**Attribute** | Pointer to **string** | | [optional] +**Value** | Pointer to **string** | | [optional] +**Standalone** | Pointer to **bool** | | [optional] + +## Methods + +### NewEntitlementSummary + +`func NewEntitlementSummary() *EntitlementSummary` + +NewEntitlementSummary instantiates a new EntitlementSummary 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 + +### NewEntitlementSummaryWithDefaults + +`func NewEntitlementSummaryWithDefaults() *EntitlementSummary` + +NewEntitlementSummaryWithDefaults instantiates a new EntitlementSummary 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 + +### GetId + +`func (o *EntitlementSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementSummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementSummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementSummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementSummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementSummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementSummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *EntitlementSummary) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *EntitlementSummary) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *EntitlementSummary) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *EntitlementSummary) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *EntitlementSummary) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *EntitlementSummary) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *EntitlementSummary) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *EntitlementSummary) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *EntitlementSummary) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *EntitlementSummary) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSource + +`func (o *EntitlementSummary) GetSource() Reference` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *EntitlementSummary) GetSourceOk() (*Reference, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *EntitlementSummary) SetSource(v Reference)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *EntitlementSummary) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetType + +`func (o *EntitlementSummary) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementSummary) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementSummary) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *EntitlementSummary) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *EntitlementSummary) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *EntitlementSummary) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *EntitlementSummary) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetAttribute + +`func (o *EntitlementSummary) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *EntitlementSummary) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *EntitlementSummary) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *EntitlementSummary) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *EntitlementSummary) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *EntitlementSummary) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *EntitlementSummary) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *EntitlementSummary) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetStandalone + +`func (o *EntitlementSummary) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *EntitlementSummary) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *EntitlementSummary) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + +### HasStandalone + +`func (o *EntitlementSummary) HasStandalone() bool` + +HasStandalone returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EntityCreatedByDTO.md b/docs/tools/sdk/go/Reference/V2025/Models/EntityCreatedByDTO.md new file mode 100644 index 000000000..fe7166b6b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EntityCreatedByDTO.md @@ -0,0 +1,90 @@ +--- +id: v2025-entity-created-by-dto +title: EntityCreatedByDTO +pagination_label: EntityCreatedByDTO +sidebar_label: EntityCreatedByDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntityCreatedByDTO', 'V2025EntityCreatedByDTO'] +slug: /tools/sdk/go/v2025/models/entity-created-by-dto +tags: ['SDK', 'Software Development Kit', 'EntityCreatedByDTO', 'V2025EntityCreatedByDTO'] +--- + +# EntityCreatedByDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the creator | [optional] +**DisplayName** | Pointer to **string** | The display name of the creator | [optional] + +## Methods + +### NewEntityCreatedByDTO + +`func NewEntityCreatedByDTO() *EntityCreatedByDTO` + +NewEntityCreatedByDTO instantiates a new EntityCreatedByDTO 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 + +### NewEntityCreatedByDTOWithDefaults + +`func NewEntityCreatedByDTOWithDefaults() *EntityCreatedByDTO` + +NewEntityCreatedByDTOWithDefaults instantiates a new EntityCreatedByDTO 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 + +### GetId + +`func (o *EntityCreatedByDTO) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntityCreatedByDTO) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntityCreatedByDTO) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntityCreatedByDTO) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *EntityCreatedByDTO) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *EntityCreatedByDTO) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *EntityCreatedByDTO) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *EntityCreatedByDTO) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Error.md b/docs/tools/sdk/go/Reference/V2025/Models/Error.md new file mode 100644 index 000000000..895f69209 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Error.md @@ -0,0 +1,116 @@ +--- +id: v2025-error +title: Error +pagination_label: Error +sidebar_label: Error +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Error', 'V2025Error'] +slug: /tools/sdk/go/v2025/models/error +tags: ['SDK', 'Software Development Kit', 'Error', 'V2025Error'] +--- + +# Error + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **string** | DetailCode is the text of the status code returned | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | | [optional] +**TrackingId** | Pointer to **string** | TrackingID is the request tracking unique identifier | [optional] + +## Methods + +### NewError + +`func NewError() *Error` + +NewError instantiates a new Error 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 + +### NewErrorWithDefaults + +`func NewErrorWithDefaults() *Error` + +NewErrorWithDefaults instantiates a new Error 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 + +### GetDetailCode + +`func (o *Error) GetDetailCode() string` + +GetDetailCode returns the DetailCode field if non-nil, zero value otherwise. + +### GetDetailCodeOk + +`func (o *Error) GetDetailCodeOk() (*string, bool)` + +GetDetailCodeOk returns a tuple with the DetailCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetailCode + +`func (o *Error) SetDetailCode(v string)` + +SetDetailCode sets DetailCode field to given value. + +### HasDetailCode + +`func (o *Error) HasDetailCode() bool` + +HasDetailCode returns a boolean if a field has been set. + +### GetMessages + +`func (o *Error) GetMessages() []ErrorMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *Error) GetMessagesOk() (*[]ErrorMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *Error) SetMessages(v []ErrorMessage)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *Error) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetTrackingId + +`func (o *Error) GetTrackingId() string` + +GetTrackingId returns the TrackingId field if non-nil, zero value otherwise. + +### GetTrackingIdOk + +`func (o *Error) GetTrackingIdOk() (*string, bool)` + +GetTrackingIdOk returns a tuple with the TrackingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingId + +`func (o *Error) SetTrackingId(v string)` + +SetTrackingId sets TrackingId field to given value. + +### HasTrackingId + +`func (o *Error) HasTrackingId() bool` + +HasTrackingId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ErrorMessage.md b/docs/tools/sdk/go/Reference/V2025/Models/ErrorMessage.md new file mode 100644 index 000000000..8a75d5e29 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ErrorMessage.md @@ -0,0 +1,116 @@ +--- +id: v2025-error-message +title: ErrorMessage +pagination_label: ErrorMessage +sidebar_label: ErrorMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ErrorMessage', 'V2025ErrorMessage'] +slug: /tools/sdk/go/v2025/models/error-message +tags: ['SDK', 'Software Development Kit', 'ErrorMessage', 'V2025ErrorMessage'] +--- + +# ErrorMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | Pointer to **string** | Locale is the current Locale | [optional] +**LocaleOrigin** | Pointer to **string** | LocaleOrigin holds possible values of how the locale was selected | [optional] +**Text** | Pointer to **string** | Text is the actual text of the error message | [optional] + +## Methods + +### NewErrorMessage + +`func NewErrorMessage() *ErrorMessage` + +NewErrorMessage instantiates a new ErrorMessage 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 + +### NewErrorMessageWithDefaults + +`func NewErrorMessageWithDefaults() *ErrorMessage` + +NewErrorMessageWithDefaults instantiates a new ErrorMessage 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 + +### GetLocale + +`func (o *ErrorMessage) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *ErrorMessage) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *ErrorMessage) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *ErrorMessage) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + +### GetLocaleOrigin + +`func (o *ErrorMessage) GetLocaleOrigin() string` + +GetLocaleOrigin returns the LocaleOrigin field if non-nil, zero value otherwise. + +### GetLocaleOriginOk + +`func (o *ErrorMessage) GetLocaleOriginOk() (*string, bool)` + +GetLocaleOriginOk returns a tuple with the LocaleOrigin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocaleOrigin + +`func (o *ErrorMessage) SetLocaleOrigin(v string)` + +SetLocaleOrigin sets LocaleOrigin field to given value. + +### HasLocaleOrigin + +`func (o *ErrorMessage) HasLocaleOrigin() bool` + +HasLocaleOrigin returns a boolean if a field has been set. + +### GetText + +`func (o *ErrorMessage) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *ErrorMessage) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *ErrorMessage) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *ErrorMessage) HasText() bool` + +HasText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ErrorMessageDto.md b/docs/tools/sdk/go/Reference/V2025/Models/ErrorMessageDto.md new file mode 100644 index 000000000..7876d07e8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ErrorMessageDto.md @@ -0,0 +1,136 @@ +--- +id: v2025-error-message-dto +title: ErrorMessageDto +pagination_label: ErrorMessageDto +sidebar_label: ErrorMessageDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ErrorMessageDto', 'V2025ErrorMessageDto'] +slug: /tools/sdk/go/v2025/models/error-message-dto +tags: ['SDK', 'Software Development Kit', 'ErrorMessageDto', 'V2025ErrorMessageDto'] +--- + +# ErrorMessageDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | Pointer to **NullableString** | The locale for the message text, a BCP 47 language tag. | [optional] +**LocaleOrigin** | Pointer to [**NullableLocaleOrigin**](locale-origin) | | [optional] +**Text** | Pointer to **string** | Actual text of the error message in the indicated locale. | [optional] + +## Methods + +### NewErrorMessageDto + +`func NewErrorMessageDto() *ErrorMessageDto` + +NewErrorMessageDto instantiates a new ErrorMessageDto 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 + +### NewErrorMessageDtoWithDefaults + +`func NewErrorMessageDtoWithDefaults() *ErrorMessageDto` + +NewErrorMessageDtoWithDefaults instantiates a new ErrorMessageDto 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 + +### GetLocale + +`func (o *ErrorMessageDto) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *ErrorMessageDto) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *ErrorMessageDto) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *ErrorMessageDto) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + +### SetLocaleNil + +`func (o *ErrorMessageDto) SetLocaleNil(b bool)` + + SetLocaleNil sets the value for Locale to be an explicit nil + +### UnsetLocale +`func (o *ErrorMessageDto) UnsetLocale()` + +UnsetLocale ensures that no value is present for Locale, not even an explicit nil +### GetLocaleOrigin + +`func (o *ErrorMessageDto) GetLocaleOrigin() LocaleOrigin` + +GetLocaleOrigin returns the LocaleOrigin field if non-nil, zero value otherwise. + +### GetLocaleOriginOk + +`func (o *ErrorMessageDto) GetLocaleOriginOk() (*LocaleOrigin, bool)` + +GetLocaleOriginOk returns a tuple with the LocaleOrigin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocaleOrigin + +`func (o *ErrorMessageDto) SetLocaleOrigin(v LocaleOrigin)` + +SetLocaleOrigin sets LocaleOrigin field to given value. + +### HasLocaleOrigin + +`func (o *ErrorMessageDto) HasLocaleOrigin() bool` + +HasLocaleOrigin returns a boolean if a field has been set. + +### SetLocaleOriginNil + +`func (o *ErrorMessageDto) SetLocaleOriginNil(b bool)` + + SetLocaleOriginNil sets the value for LocaleOrigin to be an explicit nil + +### UnsetLocaleOrigin +`func (o *ErrorMessageDto) UnsetLocaleOrigin()` + +UnsetLocaleOrigin ensures that no value is present for LocaleOrigin, not even an explicit nil +### GetText + +`func (o *ErrorMessageDto) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *ErrorMessageDto) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *ErrorMessageDto) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *ErrorMessageDto) HasText() bool` + +HasText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ErrorMessageDto1.md b/docs/tools/sdk/go/Reference/V2025/Models/ErrorMessageDto1.md new file mode 100644 index 000000000..7de742e11 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ErrorMessageDto1.md @@ -0,0 +1,136 @@ +--- +id: v2025-error-message-dto1 +title: ErrorMessageDto1 +pagination_label: ErrorMessageDto1 +sidebar_label: ErrorMessageDto1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ErrorMessageDto1', 'V2025ErrorMessageDto1'] +slug: /tools/sdk/go/v2025/models/error-message-dto1 +tags: ['SDK', 'Software Development Kit', 'ErrorMessageDto1', 'V2025ErrorMessageDto1'] +--- + +# ErrorMessageDto1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | Pointer to **NullableString** | The locale for the message text, a BCP 47 language tag. | [optional] +**LocaleOrigin** | Pointer to [**NullableLocaleOrigin**](locale-origin) | | [optional] +**Text** | Pointer to **string** | Actual text of the error message in the indicated locale. | [optional] + +## Methods + +### NewErrorMessageDto1 + +`func NewErrorMessageDto1() *ErrorMessageDto1` + +NewErrorMessageDto1 instantiates a new ErrorMessageDto1 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 + +### NewErrorMessageDto1WithDefaults + +`func NewErrorMessageDto1WithDefaults() *ErrorMessageDto1` + +NewErrorMessageDto1WithDefaults instantiates a new ErrorMessageDto1 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 + +### GetLocale + +`func (o *ErrorMessageDto1) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *ErrorMessageDto1) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *ErrorMessageDto1) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *ErrorMessageDto1) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + +### SetLocaleNil + +`func (o *ErrorMessageDto1) SetLocaleNil(b bool)` + + SetLocaleNil sets the value for Locale to be an explicit nil + +### UnsetLocale +`func (o *ErrorMessageDto1) UnsetLocale()` + +UnsetLocale ensures that no value is present for Locale, not even an explicit nil +### GetLocaleOrigin + +`func (o *ErrorMessageDto1) GetLocaleOrigin() LocaleOrigin` + +GetLocaleOrigin returns the LocaleOrigin field if non-nil, zero value otherwise. + +### GetLocaleOriginOk + +`func (o *ErrorMessageDto1) GetLocaleOriginOk() (*LocaleOrigin, bool)` + +GetLocaleOriginOk returns a tuple with the LocaleOrigin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocaleOrigin + +`func (o *ErrorMessageDto1) SetLocaleOrigin(v LocaleOrigin)` + +SetLocaleOrigin sets LocaleOrigin field to given value. + +### HasLocaleOrigin + +`func (o *ErrorMessageDto1) HasLocaleOrigin() bool` + +HasLocaleOrigin returns a boolean if a field has been set. + +### SetLocaleOriginNil + +`func (o *ErrorMessageDto1) SetLocaleOriginNil(b bool)` + + SetLocaleOriginNil sets the value for LocaleOrigin to be an explicit nil + +### UnsetLocaleOrigin +`func (o *ErrorMessageDto1) UnsetLocaleOrigin()` + +UnsetLocaleOrigin ensures that no value is present for LocaleOrigin, not even an explicit nil +### GetText + +`func (o *ErrorMessageDto1) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *ErrorMessageDto1) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *ErrorMessageDto1) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *ErrorMessageDto1) HasText() bool` + +HasText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ErrorResponseDto.md b/docs/tools/sdk/go/Reference/V2025/Models/ErrorResponseDto.md new file mode 100644 index 000000000..c78065b64 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ErrorResponseDto.md @@ -0,0 +1,142 @@ +--- +id: v2025-error-response-dto +title: ErrorResponseDto +pagination_label: ErrorResponseDto +sidebar_label: ErrorResponseDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ErrorResponseDto', 'V2025ErrorResponseDto'] +slug: /tools/sdk/go/v2025/models/error-response-dto +tags: ['SDK', 'Software Development Kit', 'ErrorResponseDto', 'V2025ErrorResponseDto'] +--- + +# ErrorResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **string** | Fine-grained error code providing more detail of the error. | [optional] +**TrackingId** | Pointer to **string** | Unique tracking id for the error. | [optional] +**Messages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Generic localized reason for error | [optional] +**Causes** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [optional] + +## Methods + +### NewErrorResponseDto + +`func NewErrorResponseDto() *ErrorResponseDto` + +NewErrorResponseDto instantiates a new ErrorResponseDto 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 + +### NewErrorResponseDtoWithDefaults + +`func NewErrorResponseDtoWithDefaults() *ErrorResponseDto` + +NewErrorResponseDtoWithDefaults instantiates a new ErrorResponseDto 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 + +### GetDetailCode + +`func (o *ErrorResponseDto) GetDetailCode() string` + +GetDetailCode returns the DetailCode field if non-nil, zero value otherwise. + +### GetDetailCodeOk + +`func (o *ErrorResponseDto) GetDetailCodeOk() (*string, bool)` + +GetDetailCodeOk returns a tuple with the DetailCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetailCode + +`func (o *ErrorResponseDto) SetDetailCode(v string)` + +SetDetailCode sets DetailCode field to given value. + +### HasDetailCode + +`func (o *ErrorResponseDto) HasDetailCode() bool` + +HasDetailCode returns a boolean if a field has been set. + +### GetTrackingId + +`func (o *ErrorResponseDto) GetTrackingId() string` + +GetTrackingId returns the TrackingId field if non-nil, zero value otherwise. + +### GetTrackingIdOk + +`func (o *ErrorResponseDto) GetTrackingIdOk() (*string, bool)` + +GetTrackingIdOk returns a tuple with the TrackingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingId + +`func (o *ErrorResponseDto) SetTrackingId(v string)` + +SetTrackingId sets TrackingId field to given value. + +### HasTrackingId + +`func (o *ErrorResponseDto) HasTrackingId() bool` + +HasTrackingId returns a boolean if a field has been set. + +### GetMessages + +`func (o *ErrorResponseDto) GetMessages() []ErrorMessageDto` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *ErrorResponseDto) GetMessagesOk() (*[]ErrorMessageDto, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *ErrorResponseDto) SetMessages(v []ErrorMessageDto)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *ErrorResponseDto) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetCauses + +`func (o *ErrorResponseDto) GetCauses() []ErrorMessageDto` + +GetCauses returns the Causes field if non-nil, zero value otherwise. + +### GetCausesOk + +`func (o *ErrorResponseDto) GetCausesOk() (*[]ErrorMessageDto, bool)` + +GetCausesOk returns a tuple with the Causes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCauses + +`func (o *ErrorResponseDto) SetCauses(v []ErrorMessageDto)` + +SetCauses sets Causes field to given value. + +### HasCauses + +`func (o *ErrorResponseDto) HasCauses() bool` + +HasCauses returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ErrorResponseDto1.md b/docs/tools/sdk/go/Reference/V2025/Models/ErrorResponseDto1.md new file mode 100644 index 000000000..cf2a88c0f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ErrorResponseDto1.md @@ -0,0 +1,142 @@ +--- +id: v2025-error-response-dto1 +title: ErrorResponseDto1 +pagination_label: ErrorResponseDto1 +sidebar_label: ErrorResponseDto1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ErrorResponseDto1', 'V2025ErrorResponseDto1'] +slug: /tools/sdk/go/v2025/models/error-response-dto1 +tags: ['SDK', 'Software Development Kit', 'ErrorResponseDto1', 'V2025ErrorResponseDto1'] +--- + +# ErrorResponseDto1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **string** | Fine-grained error code providing more detail of the error. | [optional] +**TrackingId** | Pointer to **string** | Unique tracking id for the error. | [optional] +**Messages** | Pointer to [**[]ErrorMessageDto1**](error-message-dto1) | Generic localized reason for error | [optional] +**Causes** | Pointer to [**[]ErrorMessageDto1**](error-message-dto1) | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [optional] + +## Methods + +### NewErrorResponseDto1 + +`func NewErrorResponseDto1() *ErrorResponseDto1` + +NewErrorResponseDto1 instantiates a new ErrorResponseDto1 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 + +### NewErrorResponseDto1WithDefaults + +`func NewErrorResponseDto1WithDefaults() *ErrorResponseDto1` + +NewErrorResponseDto1WithDefaults instantiates a new ErrorResponseDto1 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 + +### GetDetailCode + +`func (o *ErrorResponseDto1) GetDetailCode() string` + +GetDetailCode returns the DetailCode field if non-nil, zero value otherwise. + +### GetDetailCodeOk + +`func (o *ErrorResponseDto1) GetDetailCodeOk() (*string, bool)` + +GetDetailCodeOk returns a tuple with the DetailCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetailCode + +`func (o *ErrorResponseDto1) SetDetailCode(v string)` + +SetDetailCode sets DetailCode field to given value. + +### HasDetailCode + +`func (o *ErrorResponseDto1) HasDetailCode() bool` + +HasDetailCode returns a boolean if a field has been set. + +### GetTrackingId + +`func (o *ErrorResponseDto1) GetTrackingId() string` + +GetTrackingId returns the TrackingId field if non-nil, zero value otherwise. + +### GetTrackingIdOk + +`func (o *ErrorResponseDto1) GetTrackingIdOk() (*string, bool)` + +GetTrackingIdOk returns a tuple with the TrackingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingId + +`func (o *ErrorResponseDto1) SetTrackingId(v string)` + +SetTrackingId sets TrackingId field to given value. + +### HasTrackingId + +`func (o *ErrorResponseDto1) HasTrackingId() bool` + +HasTrackingId returns a boolean if a field has been set. + +### GetMessages + +`func (o *ErrorResponseDto1) GetMessages() []ErrorMessageDto1` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *ErrorResponseDto1) GetMessagesOk() (*[]ErrorMessageDto1, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *ErrorResponseDto1) SetMessages(v []ErrorMessageDto1)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *ErrorResponseDto1) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetCauses + +`func (o *ErrorResponseDto1) GetCauses() []ErrorMessageDto1` + +GetCauses returns the Causes field if non-nil, zero value otherwise. + +### GetCausesOk + +`func (o *ErrorResponseDto1) GetCausesOk() (*[]ErrorMessageDto1, bool)` + +GetCausesOk returns a tuple with the Causes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCauses + +`func (o *ErrorResponseDto1) SetCauses(v []ErrorMessageDto1)` + +SetCauses sets Causes field to given value. + +### HasCauses + +`func (o *ErrorResponseDto1) HasCauses() bool` + +HasCauses returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EvaluateResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/EvaluateResponse.md new file mode 100644 index 000000000..3e68e96a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EvaluateResponse.md @@ -0,0 +1,90 @@ +--- +id: v2025-evaluate-response +title: EvaluateResponse +pagination_label: EvaluateResponse +sidebar_label: EvaluateResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EvaluateResponse', 'V2025EvaluateResponse'] +slug: /tools/sdk/go/v2025/models/evaluate-response +tags: ['SDK', 'Software Development Kit', 'EvaluateResponse', 'V2025EvaluateResponse'] +--- + +# EvaluateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReassignToId** | Pointer to **string** | The Identity ID which should be the recipient of any work items sent to a specific identity & work type | [optional] +**LookupTrail** | Pointer to [**[]LookupStep**](lookup-step) | List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration | [optional] + +## Methods + +### NewEvaluateResponse + +`func NewEvaluateResponse() *EvaluateResponse` + +NewEvaluateResponse instantiates a new EvaluateResponse 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 + +### NewEvaluateResponseWithDefaults + +`func NewEvaluateResponseWithDefaults() *EvaluateResponse` + +NewEvaluateResponseWithDefaults instantiates a new EvaluateResponse 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 + +### GetReassignToId + +`func (o *EvaluateResponse) GetReassignToId() string` + +GetReassignToId returns the ReassignToId field if non-nil, zero value otherwise. + +### GetReassignToIdOk + +`func (o *EvaluateResponse) GetReassignToIdOk() (*string, bool)` + +GetReassignToIdOk returns a tuple with the ReassignToId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignToId + +`func (o *EvaluateResponse) SetReassignToId(v string)` + +SetReassignToId sets ReassignToId field to given value. + +### HasReassignToId + +`func (o *EvaluateResponse) HasReassignToId() bool` + +HasReassignToId returns a boolean if a field has been set. + +### GetLookupTrail + +`func (o *EvaluateResponse) GetLookupTrail() []LookupStep` + +GetLookupTrail returns the LookupTrail field if non-nil, zero value otherwise. + +### GetLookupTrailOk + +`func (o *EvaluateResponse) GetLookupTrailOk() (*[]LookupStep, bool)` + +GetLookupTrailOk returns a tuple with the LookupTrail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLookupTrail + +`func (o *EvaluateResponse) SetLookupTrail(v []LookupStep)` + +SetLookupTrail sets LookupTrail field to given value. + +### HasLookupTrail + +`func (o *EvaluateResponse) HasLookupTrail() bool` + +HasLookupTrail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Event.md b/docs/tools/sdk/go/Reference/V2025/Models/Event.md new file mode 100644 index 000000000..787c865b2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Event.md @@ -0,0 +1,490 @@ +--- +id: v2025-event +title: Event +pagination_label: Event +sidebar_label: Event +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Event', 'V2025Event'] +slug: /tools/sdk/go/v2025/models/event +tags: ['SDK', 'Software Development Kit', 'Event', 'V2025Event'] +--- + +# Event + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the entitlement. | [optional] +**Name** | Pointer to **string** | Name of the entitlement. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Action** | Pointer to **string** | Name of the event as it's displayed in audit reports. | [optional] +**Type** | Pointer to **string** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**Actor** | Pointer to [**EventActor**](event-actor) | | [optional] +**Target** | Pointer to [**EventTarget**](event-target) | | [optional] +**Stack** | Pointer to **string** | The event's stack. | [optional] +**TrackingNumber** | Pointer to **string** | ID of the group of events. | [optional] +**IpAddress** | Pointer to **string** | Target system's IP address. | [optional] +**Details** | Pointer to **string** | ID of event's details. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Attributes involved in the event. | [optional] +**Objects** | Pointer to **[]string** | Objects the event is happening to. | [optional] +**Operation** | Pointer to **string** | Operation, or action, performed during the event. | [optional] +**Status** | Pointer to **string** | Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. | [optional] +**TechnicalName** | Pointer to **string** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] + +## Methods + +### NewEvent + +`func NewEvent() *Event` + +NewEvent instantiates a new Event 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 + +### NewEventWithDefaults + +`func NewEventWithDefaults() *Event` + +NewEventWithDefaults instantiates a new Event 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 + +### GetId + +`func (o *Event) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Event) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Event) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Event) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Event) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Event) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Event) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Event) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *Event) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Event) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Event) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Event) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *Event) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *Event) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetSynced + +`func (o *Event) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *Event) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *Event) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *Event) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetAction + +`func (o *Event) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *Event) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *Event) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *Event) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetType + +`func (o *Event) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Event) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Event) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Event) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetActor + +`func (o *Event) GetActor() EventActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *Event) GetActorOk() (*EventActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *Event) SetActor(v EventActor)` + +SetActor sets Actor field to given value. + +### HasActor + +`func (o *Event) HasActor() bool` + +HasActor returns a boolean if a field has been set. + +### GetTarget + +`func (o *Event) GetTarget() EventTarget` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *Event) GetTargetOk() (*EventTarget, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *Event) SetTarget(v EventTarget)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *Event) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + +### GetStack + +`func (o *Event) GetStack() string` + +GetStack returns the Stack field if non-nil, zero value otherwise. + +### GetStackOk + +`func (o *Event) GetStackOk() (*string, bool)` + +GetStackOk returns a tuple with the Stack field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStack + +`func (o *Event) SetStack(v string)` + +SetStack sets Stack field to given value. + +### HasStack + +`func (o *Event) HasStack() bool` + +HasStack returns a boolean if a field has been set. + +### GetTrackingNumber + +`func (o *Event) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *Event) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *Event) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + +### HasTrackingNumber + +`func (o *Event) HasTrackingNumber() bool` + +HasTrackingNumber returns a boolean if a field has been set. + +### GetIpAddress + +`func (o *Event) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *Event) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *Event) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + +### HasIpAddress + +`func (o *Event) HasIpAddress() bool` + +HasIpAddress returns a boolean if a field has been set. + +### GetDetails + +`func (o *Event) GetDetails() string` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *Event) GetDetailsOk() (*string, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *Event) SetDetails(v string)` + +SetDetails sets Details field to given value. + +### HasDetails + +`func (o *Event) HasDetails() bool` + +HasDetails returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Event) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Event) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Event) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Event) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetObjects + +`func (o *Event) GetObjects() []string` + +GetObjects returns the Objects field if non-nil, zero value otherwise. + +### GetObjectsOk + +`func (o *Event) GetObjectsOk() (*[]string, bool)` + +GetObjectsOk returns a tuple with the Objects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjects + +`func (o *Event) SetObjects(v []string)` + +SetObjects sets Objects field to given value. + +### HasObjects + +`func (o *Event) HasObjects() bool` + +HasObjects returns a boolean if a field has been set. + +### GetOperation + +`func (o *Event) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *Event) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *Event) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *Event) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetStatus + +`func (o *Event) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Event) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Event) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Event) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetTechnicalName + +`func (o *Event) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *Event) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *Event) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + +### HasTechnicalName + +`func (o *Event) HasTechnicalName() bool` + +HasTechnicalName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EventActor.md b/docs/tools/sdk/go/Reference/V2025/Models/EventActor.md new file mode 100644 index 000000000..4d721c3df --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EventActor.md @@ -0,0 +1,64 @@ +--- +id: v2025-event-actor +title: EventActor +pagination_label: EventActor +sidebar_label: EventActor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EventActor', 'V2025EventActor'] +slug: /tools/sdk/go/v2025/models/event-actor +tags: ['SDK', 'Software Development Kit', 'EventActor', 'V2025EventActor'] +--- + +# EventActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the actor that generated the event. | [optional] + +## Methods + +### NewEventActor + +`func NewEventActor() *EventActor` + +NewEventActor instantiates a new EventActor 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 + +### NewEventActorWithDefaults + +`func NewEventActorWithDefaults() *EventActor` + +NewEventActorWithDefaults instantiates a new EventActor 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 + +### GetName + +`func (o *EventActor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EventActor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EventActor) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EventActor) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EventBridgeConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/EventBridgeConfig.md new file mode 100644 index 000000000..08085396c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EventBridgeConfig.md @@ -0,0 +1,80 @@ +--- +id: v2025-event-bridge-config +title: EventBridgeConfig +pagination_label: EventBridgeConfig +sidebar_label: EventBridgeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EventBridgeConfig', 'V2025EventBridgeConfig'] +slug: /tools/sdk/go/v2025/models/event-bridge-config +tags: ['SDK', 'Software Development Kit', 'EventBridgeConfig', 'V2025EventBridgeConfig'] +--- + +# EventBridgeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AwsAccount** | **string** | AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource. | +**AwsRegion** | **string** | AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values. | + +## Methods + +### NewEventBridgeConfig + +`func NewEventBridgeConfig(awsAccount string, awsRegion string, ) *EventBridgeConfig` + +NewEventBridgeConfig instantiates a new EventBridgeConfig 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 + +### NewEventBridgeConfigWithDefaults + +`func NewEventBridgeConfigWithDefaults() *EventBridgeConfig` + +NewEventBridgeConfigWithDefaults instantiates a new EventBridgeConfig 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 + +### GetAwsAccount + +`func (o *EventBridgeConfig) GetAwsAccount() string` + +GetAwsAccount returns the AwsAccount field if non-nil, zero value otherwise. + +### GetAwsAccountOk + +`func (o *EventBridgeConfig) GetAwsAccountOk() (*string, bool)` + +GetAwsAccountOk returns a tuple with the AwsAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsAccount + +`func (o *EventBridgeConfig) SetAwsAccount(v string)` + +SetAwsAccount sets AwsAccount field to given value. + + +### GetAwsRegion + +`func (o *EventBridgeConfig) GetAwsRegion() string` + +GetAwsRegion returns the AwsRegion field if non-nil, zero value otherwise. + +### GetAwsRegionOk + +`func (o *EventBridgeConfig) GetAwsRegionOk() (*string, bool)` + +GetAwsRegionOk returns a tuple with the AwsRegion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAwsRegion + +`func (o *EventBridgeConfig) SetAwsRegion(v string)` + +SetAwsRegion sets AwsRegion field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EventDocument.md b/docs/tools/sdk/go/Reference/V2025/Models/EventDocument.md new file mode 100644 index 000000000..c938c0304 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EventDocument.md @@ -0,0 +1,490 @@ +--- +id: v2025-event-document +title: EventDocument +pagination_label: EventDocument +sidebar_label: EventDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EventDocument', 'V2025EventDocument'] +slug: /tools/sdk/go/v2025/models/event-document +tags: ['SDK', 'Software Development Kit', 'EventDocument', 'V2025EventDocument'] +--- + +# EventDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the entitlement. | [optional] +**Name** | Pointer to **string** | Name of the entitlement. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Action** | Pointer to **string** | Name of the event as it's displayed in audit reports. | [optional] +**Type** | Pointer to **string** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**Actor** | Pointer to [**EventActor**](event-actor) | | [optional] +**Target** | Pointer to [**EventTarget**](event-target) | | [optional] +**Stack** | Pointer to **string** | The event's stack. | [optional] +**TrackingNumber** | Pointer to **string** | ID of the group of events. | [optional] +**IpAddress** | Pointer to **string** | Target system's IP address. | [optional] +**Details** | Pointer to **string** | ID of event's details. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Attributes involved in the event. | [optional] +**Objects** | Pointer to **[]string** | Objects the event is happening to. | [optional] +**Operation** | Pointer to **string** | Operation, or action, performed during the event. | [optional] +**Status** | Pointer to **string** | Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. | [optional] +**TechnicalName** | Pointer to **string** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] + +## Methods + +### NewEventDocument + +`func NewEventDocument() *EventDocument` + +NewEventDocument instantiates a new EventDocument 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 + +### NewEventDocumentWithDefaults + +`func NewEventDocumentWithDefaults() *EventDocument` + +NewEventDocumentWithDefaults instantiates a new EventDocument 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 + +### GetId + +`func (o *EventDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EventDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EventDocument) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EventDocument) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EventDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EventDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EventDocument) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EventDocument) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *EventDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *EventDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *EventDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *EventDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *EventDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *EventDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetSynced + +`func (o *EventDocument) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *EventDocument) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *EventDocument) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *EventDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetAction + +`func (o *EventDocument) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *EventDocument) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *EventDocument) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *EventDocument) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetType + +`func (o *EventDocument) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EventDocument) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EventDocument) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EventDocument) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetActor + +`func (o *EventDocument) GetActor() EventActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *EventDocument) GetActorOk() (*EventActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *EventDocument) SetActor(v EventActor)` + +SetActor sets Actor field to given value. + +### HasActor + +`func (o *EventDocument) HasActor() bool` + +HasActor returns a boolean if a field has been set. + +### GetTarget + +`func (o *EventDocument) GetTarget() EventTarget` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *EventDocument) GetTargetOk() (*EventTarget, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *EventDocument) SetTarget(v EventTarget)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *EventDocument) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + +### GetStack + +`func (o *EventDocument) GetStack() string` + +GetStack returns the Stack field if non-nil, zero value otherwise. + +### GetStackOk + +`func (o *EventDocument) GetStackOk() (*string, bool)` + +GetStackOk returns a tuple with the Stack field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStack + +`func (o *EventDocument) SetStack(v string)` + +SetStack sets Stack field to given value. + +### HasStack + +`func (o *EventDocument) HasStack() bool` + +HasStack returns a boolean if a field has been set. + +### GetTrackingNumber + +`func (o *EventDocument) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *EventDocument) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *EventDocument) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + +### HasTrackingNumber + +`func (o *EventDocument) HasTrackingNumber() bool` + +HasTrackingNumber returns a boolean if a field has been set. + +### GetIpAddress + +`func (o *EventDocument) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *EventDocument) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *EventDocument) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + +### HasIpAddress + +`func (o *EventDocument) HasIpAddress() bool` + +HasIpAddress returns a boolean if a field has been set. + +### GetDetails + +`func (o *EventDocument) GetDetails() string` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *EventDocument) GetDetailsOk() (*string, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *EventDocument) SetDetails(v string)` + +SetDetails sets Details field to given value. + +### HasDetails + +`func (o *EventDocument) HasDetails() bool` + +HasDetails returns a boolean if a field has been set. + +### GetAttributes + +`func (o *EventDocument) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *EventDocument) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *EventDocument) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *EventDocument) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetObjects + +`func (o *EventDocument) GetObjects() []string` + +GetObjects returns the Objects field if non-nil, zero value otherwise. + +### GetObjectsOk + +`func (o *EventDocument) GetObjectsOk() (*[]string, bool)` + +GetObjectsOk returns a tuple with the Objects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjects + +`func (o *EventDocument) SetObjects(v []string)` + +SetObjects sets Objects field to given value. + +### HasObjects + +`func (o *EventDocument) HasObjects() bool` + +HasObjects returns a boolean if a field has been set. + +### GetOperation + +`func (o *EventDocument) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *EventDocument) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *EventDocument) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *EventDocument) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetStatus + +`func (o *EventDocument) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *EventDocument) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *EventDocument) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *EventDocument) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetTechnicalName + +`func (o *EventDocument) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *EventDocument) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *EventDocument) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + +### HasTechnicalName + +`func (o *EventDocument) HasTechnicalName() bool` + +HasTechnicalName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/EventTarget.md b/docs/tools/sdk/go/Reference/V2025/Models/EventTarget.md new file mode 100644 index 000000000..5618dc122 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/EventTarget.md @@ -0,0 +1,64 @@ +--- +id: v2025-event-target +title: EventTarget +pagination_label: EventTarget +sidebar_label: EventTarget +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EventTarget', 'V2025EventTarget'] +slug: /tools/sdk/go/v2025/models/event-target +tags: ['SDK', 'Software Development Kit', 'EventTarget', 'V2025EventTarget'] +--- + +# EventTarget + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the target, or recipient, of the event. | [optional] + +## Methods + +### NewEventTarget + +`func NewEventTarget() *EventTarget` + +NewEventTarget instantiates a new EventTarget 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 + +### NewEventTargetWithDefaults + +`func NewEventTargetWithDefaults() *EventTarget` + +NewEventTargetWithDefaults instantiates a new EventTarget 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 + +### GetName + +`func (o *EventTarget) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EventTarget) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EventTarget) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EventTarget) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ExceptionAccessCriteria.md b/docs/tools/sdk/go/Reference/V2025/Models/ExceptionAccessCriteria.md new file mode 100644 index 000000000..3f101b26d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ExceptionAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: v2025-exception-access-criteria +title: ExceptionAccessCriteria +pagination_label: ExceptionAccessCriteria +sidebar_label: ExceptionAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExceptionAccessCriteria', 'V2025ExceptionAccessCriteria'] +slug: /tools/sdk/go/v2025/models/exception-access-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionAccessCriteria', 'V2025ExceptionAccessCriteria'] +--- + +# ExceptionAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] +**RightCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] + +## Methods + +### NewExceptionAccessCriteria + +`func NewExceptionAccessCriteria() *ExceptionAccessCriteria` + +NewExceptionAccessCriteria instantiates a new ExceptionAccessCriteria 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 + +### NewExceptionAccessCriteriaWithDefaults + +`func NewExceptionAccessCriteriaWithDefaults() *ExceptionAccessCriteria` + +NewExceptionAccessCriteriaWithDefaults instantiates a new ExceptionAccessCriteria 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 + +### GetLeftCriteria + +`func (o *ExceptionAccessCriteria) GetLeftCriteria() ExceptionCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *ExceptionAccessCriteria) GetLeftCriteriaOk() (*ExceptionCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *ExceptionAccessCriteria) SetLeftCriteria(v ExceptionCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *ExceptionAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *ExceptionAccessCriteria) GetRightCriteria() ExceptionCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *ExceptionAccessCriteria) GetRightCriteriaOk() (*ExceptionCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *ExceptionAccessCriteria) SetRightCriteria(v ExceptionCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *ExceptionAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ExceptionCriteria.md b/docs/tools/sdk/go/Reference/V2025/Models/ExceptionCriteria.md new file mode 100644 index 000000000..4013876c9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ExceptionCriteria.md @@ -0,0 +1,64 @@ +--- +id: v2025-exception-criteria +title: ExceptionCriteria +pagination_label: ExceptionCriteria +sidebar_label: ExceptionCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExceptionCriteria', 'V2025ExceptionCriteria'] +slug: /tools/sdk/go/v2025/models/exception-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteria', 'V2025ExceptionCriteria'] +--- + +# ExceptionCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]ExceptionCriteriaCriteriaListInner**](exception-criteria-criteria-list-inner) | List of exception criteria. There is a min of 1 and max of 50 items in the list. | [optional] + +## Methods + +### NewExceptionCriteria + +`func NewExceptionCriteria() *ExceptionCriteria` + +NewExceptionCriteria instantiates a new ExceptionCriteria 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 + +### NewExceptionCriteriaWithDefaults + +`func NewExceptionCriteriaWithDefaults() *ExceptionCriteria` + +NewExceptionCriteriaWithDefaults instantiates a new ExceptionCriteria 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 + +### GetCriteriaList + +`func (o *ExceptionCriteria) GetCriteriaList() []ExceptionCriteriaCriteriaListInner` + +GetCriteriaList returns the CriteriaList field if non-nil, zero value otherwise. + +### GetCriteriaListOk + +`func (o *ExceptionCriteria) GetCriteriaListOk() (*[]ExceptionCriteriaCriteriaListInner, bool)` + +GetCriteriaListOk returns a tuple with the CriteriaList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteriaList + +`func (o *ExceptionCriteria) SetCriteriaList(v []ExceptionCriteriaCriteriaListInner)` + +SetCriteriaList sets CriteriaList field to given value. + +### HasCriteriaList + +`func (o *ExceptionCriteria) HasCriteriaList() bool` + +HasCriteriaList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ExceptionCriteriaAccess.md b/docs/tools/sdk/go/Reference/V2025/Models/ExceptionCriteriaAccess.md new file mode 100644 index 000000000..c7cdb55e9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ExceptionCriteriaAccess.md @@ -0,0 +1,142 @@ +--- +id: v2025-exception-criteria-access +title: ExceptionCriteriaAccess +pagination_label: ExceptionCriteriaAccess +sidebar_label: ExceptionCriteriaAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExceptionCriteriaAccess', 'V2025ExceptionCriteriaAccess'] +slug: /tools/sdk/go/v2025/models/exception-criteria-access +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaAccess', 'V2025ExceptionCriteriaAccess'] +--- + +# ExceptionCriteriaAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] +**Existing** | Pointer to **bool** | Whether the subject identity already had that access or not | [optional] [default to false] + +## Methods + +### NewExceptionCriteriaAccess + +`func NewExceptionCriteriaAccess() *ExceptionCriteriaAccess` + +NewExceptionCriteriaAccess instantiates a new ExceptionCriteriaAccess 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 + +### NewExceptionCriteriaAccessWithDefaults + +`func NewExceptionCriteriaAccessWithDefaults() *ExceptionCriteriaAccess` + +NewExceptionCriteriaAccessWithDefaults instantiates a new ExceptionCriteriaAccess 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 + +### GetType + +`func (o *ExceptionCriteriaAccess) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ExceptionCriteriaAccess) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ExceptionCriteriaAccess) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ExceptionCriteriaAccess) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ExceptionCriteriaAccess) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ExceptionCriteriaAccess) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ExceptionCriteriaAccess) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ExceptionCriteriaAccess) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ExceptionCriteriaAccess) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ExceptionCriteriaAccess) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ExceptionCriteriaAccess) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ExceptionCriteriaAccess) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetExisting + +`func (o *ExceptionCriteriaAccess) GetExisting() bool` + +GetExisting returns the Existing field if non-nil, zero value otherwise. + +### GetExistingOk + +`func (o *ExceptionCriteriaAccess) GetExistingOk() (*bool, bool)` + +GetExistingOk returns a tuple with the Existing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExisting + +`func (o *ExceptionCriteriaAccess) SetExisting(v bool)` + +SetExisting sets Existing field to given value. + +### HasExisting + +`func (o *ExceptionCriteriaAccess) HasExisting() bool` + +HasExisting returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ExceptionCriteriaCriteriaListInner.md b/docs/tools/sdk/go/Reference/V2025/Models/ExceptionCriteriaCriteriaListInner.md new file mode 100644 index 000000000..31ceec09d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ExceptionCriteriaCriteriaListInner.md @@ -0,0 +1,142 @@ +--- +id: v2025-exception-criteria-criteria-list-inner +title: ExceptionCriteriaCriteriaListInner +pagination_label: ExceptionCriteriaCriteriaListInner +sidebar_label: ExceptionCriteriaCriteriaListInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExceptionCriteriaCriteriaListInner', 'V2025ExceptionCriteriaCriteriaListInner'] +slug: /tools/sdk/go/v2025/models/exception-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaCriteriaListInner', 'V2025ExceptionCriteriaCriteriaListInner'] +--- + +# ExceptionCriteriaCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **map[string]interface{}** | The type of object that is referenced | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] +**Existing** | Pointer to **bool** | Whether the subject identity already had that access or not | [optional] [default to false] + +## Methods + +### NewExceptionCriteriaCriteriaListInner + +`func NewExceptionCriteriaCriteriaListInner() *ExceptionCriteriaCriteriaListInner` + +NewExceptionCriteriaCriteriaListInner instantiates a new ExceptionCriteriaCriteriaListInner 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 + +### NewExceptionCriteriaCriteriaListInnerWithDefaults + +`func NewExceptionCriteriaCriteriaListInnerWithDefaults() *ExceptionCriteriaCriteriaListInner` + +NewExceptionCriteriaCriteriaListInnerWithDefaults instantiates a new ExceptionCriteriaCriteriaListInner 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 + +### GetType + +`func (o *ExceptionCriteriaCriteriaListInner) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ExceptionCriteriaCriteriaListInner) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ExceptionCriteriaCriteriaListInner) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + +### HasType + +`func (o *ExceptionCriteriaCriteriaListInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ExceptionCriteriaCriteriaListInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ExceptionCriteriaCriteriaListInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ExceptionCriteriaCriteriaListInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ExceptionCriteriaCriteriaListInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ExceptionCriteriaCriteriaListInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ExceptionCriteriaCriteriaListInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ExceptionCriteriaCriteriaListInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ExceptionCriteriaCriteriaListInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetExisting + +`func (o *ExceptionCriteriaCriteriaListInner) GetExisting() bool` + +GetExisting returns the Existing field if non-nil, zero value otherwise. + +### GetExistingOk + +`func (o *ExceptionCriteriaCriteriaListInner) GetExistingOk() (*bool, bool)` + +GetExistingOk returns a tuple with the Existing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExisting + +`func (o *ExceptionCriteriaCriteriaListInner) SetExisting(v bool)` + +SetExisting sets Existing field to given value. + +### HasExisting + +`func (o *ExceptionCriteriaCriteriaListInner) HasExisting() bool` + +HasExisting returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ExecutionStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/ExecutionStatus.md new file mode 100644 index 000000000..83a2d65bd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ExecutionStatus.md @@ -0,0 +1,25 @@ +--- +id: v2025-execution-status +title: ExecutionStatus +pagination_label: ExecutionStatus +sidebar_label: ExecutionStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExecutionStatus', 'V2025ExecutionStatus'] +slug: /tools/sdk/go/v2025/models/execution-status +tags: ['SDK', 'Software Development Kit', 'ExecutionStatus', 'V2025ExecutionStatus'] +--- + +# ExecutionStatus + +## Enum + + +* `EXECUTING` (value: `"EXECUTING"`) + +* `VERIFYING` (value: `"VERIFYING"`) + +* `TERMINATED` (value: `"TERMINATED"`) + +* `COMPLETED` (value: `"COMPLETED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ExpansionItem.md b/docs/tools/sdk/go/Reference/V2025/Models/ExpansionItem.md new file mode 100644 index 000000000..088ef7465 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ExpansionItem.md @@ -0,0 +1,220 @@ +--- +id: v2025-expansion-item +title: ExpansionItem +pagination_label: ExpansionItem +sidebar_label: ExpansionItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExpansionItem', 'V2025ExpansionItem'] +slug: /tools/sdk/go/v2025/models/expansion-item +tags: ['SDK', 'Software Development Kit', 'ExpansionItem', 'V2025ExpansionItem'] +--- + +# ExpansionItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **string** | The ID of the account | [optional] +**Cause** | Pointer to **string** | Cause of the expansion item. | [optional] +**Name** | Pointer to **string** | The name of the item | [optional] +**AttributeRequest** | Pointer to [**AttributeRequest**](attribute-request) | | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] +**Id** | Pointer to **string** | ID of the expansion item | [optional] +**State** | Pointer to **string** | State of the expansion item | [optional] + +## Methods + +### NewExpansionItem + +`func NewExpansionItem() *ExpansionItem` + +NewExpansionItem instantiates a new ExpansionItem 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 + +### NewExpansionItemWithDefaults + +`func NewExpansionItemWithDefaults() *ExpansionItem` + +NewExpansionItemWithDefaults instantiates a new ExpansionItem 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 + +### GetAccountId + +`func (o *ExpansionItem) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *ExpansionItem) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *ExpansionItem) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *ExpansionItem) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetCause + +`func (o *ExpansionItem) GetCause() string` + +GetCause returns the Cause field if non-nil, zero value otherwise. + +### GetCauseOk + +`func (o *ExpansionItem) GetCauseOk() (*string, bool)` + +GetCauseOk returns a tuple with the Cause field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCause + +`func (o *ExpansionItem) SetCause(v string)` + +SetCause sets Cause field to given value. + +### HasCause + +`func (o *ExpansionItem) HasCause() bool` + +HasCause returns a boolean if a field has been set. + +### GetName + +`func (o *ExpansionItem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ExpansionItem) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ExpansionItem) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ExpansionItem) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAttributeRequest + +`func (o *ExpansionItem) GetAttributeRequest() AttributeRequest` + +GetAttributeRequest returns the AttributeRequest field if non-nil, zero value otherwise. + +### GetAttributeRequestOk + +`func (o *ExpansionItem) GetAttributeRequestOk() (*AttributeRequest, bool)` + +GetAttributeRequestOk returns a tuple with the AttributeRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeRequest + +`func (o *ExpansionItem) SetAttributeRequest(v AttributeRequest)` + +SetAttributeRequest sets AttributeRequest field to given value. + +### HasAttributeRequest + +`func (o *ExpansionItem) HasAttributeRequest() bool` + +HasAttributeRequest returns a boolean if a field has been set. + +### GetSource + +`func (o *ExpansionItem) GetSource() AccountSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *ExpansionItem) GetSourceOk() (*AccountSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *ExpansionItem) SetSource(v AccountSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *ExpansionItem) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetId + +`func (o *ExpansionItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ExpansionItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ExpansionItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ExpansionItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetState + +`func (o *ExpansionItem) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ExpansionItem) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ExpansionItem) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *ExpansionItem) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ExportFormDefinitionsByTenant200ResponseInner.md b/docs/tools/sdk/go/Reference/V2025/Models/ExportFormDefinitionsByTenant200ResponseInner.md new file mode 100644 index 000000000..2da2f47ff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ExportFormDefinitionsByTenant200ResponseInner.md @@ -0,0 +1,116 @@ +--- +id: v2025-export-form-definitions-by-tenant200-response-inner +title: ExportFormDefinitionsByTenant200ResponseInner +pagination_label: ExportFormDefinitionsByTenant200ResponseInner +sidebar_label: ExportFormDefinitionsByTenant200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExportFormDefinitionsByTenant200ResponseInner', 'V2025ExportFormDefinitionsByTenant200ResponseInner'] +slug: /tools/sdk/go/v2025/models/export-form-definitions-by-tenant200-response-inner +tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenant200ResponseInner', 'V2025ExportFormDefinitionsByTenant200ResponseInner'] +--- + +# ExportFormDefinitionsByTenant200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Object** | Pointer to [**FormDefinitionResponse**](form-definition-response) | | [optional] +**Self** | Pointer to [**ExportFormDefinitionsByTenant200ResponseInnerSelf**](export-form-definitions-by-tenant200-response-inner-self) | | [optional] +**Version** | Pointer to **int32** | | [optional] + +## Methods + +### NewExportFormDefinitionsByTenant200ResponseInner + +`func NewExportFormDefinitionsByTenant200ResponseInner() *ExportFormDefinitionsByTenant200ResponseInner` + +NewExportFormDefinitionsByTenant200ResponseInner instantiates a new ExportFormDefinitionsByTenant200ResponseInner 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 + +### NewExportFormDefinitionsByTenant200ResponseInnerWithDefaults + +`func NewExportFormDefinitionsByTenant200ResponseInnerWithDefaults() *ExportFormDefinitionsByTenant200ResponseInner` + +NewExportFormDefinitionsByTenant200ResponseInnerWithDefaults instantiates a new ExportFormDefinitionsByTenant200ResponseInner 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 + +### GetObject + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetObject() FormDefinitionResponse` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetObjectOk() (*FormDefinitionResponse, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) SetObject(v FormDefinitionResponse)` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) HasObject() bool` + +HasObject returns a boolean if a field has been set. + +### GetSelf + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetSelf() ExportFormDefinitionsByTenant200ResponseInnerSelf` + +GetSelf returns the Self field if non-nil, zero value otherwise. + +### GetSelfOk + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetSelfOk() (*ExportFormDefinitionsByTenant200ResponseInnerSelf, bool)` + +GetSelfOk returns a tuple with the Self field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelf + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) SetSelf(v ExportFormDefinitionsByTenant200ResponseInnerSelf)` + +SetSelf sets Self field to given value. + +### HasSelf + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) HasSelf() bool` + +HasSelf returns a boolean if a field has been set. + +### GetVersion + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *ExportFormDefinitionsByTenant200ResponseInner) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ExportFormDefinitionsByTenant200ResponseInnerSelf.md b/docs/tools/sdk/go/Reference/V2025/Models/ExportFormDefinitionsByTenant200ResponseInnerSelf.md new file mode 100644 index 000000000..dc8a3b525 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ExportFormDefinitionsByTenant200ResponseInnerSelf.md @@ -0,0 +1,64 @@ +--- +id: v2025-export-form-definitions-by-tenant200-response-inner-self +title: ExportFormDefinitionsByTenant200ResponseInnerSelf +pagination_label: ExportFormDefinitionsByTenant200ResponseInnerSelf +sidebar_label: ExportFormDefinitionsByTenant200ResponseInnerSelf +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExportFormDefinitionsByTenant200ResponseInnerSelf', 'V2025ExportFormDefinitionsByTenant200ResponseInnerSelf'] +slug: /tools/sdk/go/v2025/models/export-form-definitions-by-tenant200-response-inner-self +tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenant200ResponseInnerSelf', 'V2025ExportFormDefinitionsByTenant200ResponseInnerSelf'] +--- + +# ExportFormDefinitionsByTenant200ResponseInnerSelf + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Object** | Pointer to [**FormDefinitionSelfImportExportDto**](form-definition-self-import-export-dto) | | [optional] + +## Methods + +### NewExportFormDefinitionsByTenant200ResponseInnerSelf + +`func NewExportFormDefinitionsByTenant200ResponseInnerSelf() *ExportFormDefinitionsByTenant200ResponseInnerSelf` + +NewExportFormDefinitionsByTenant200ResponseInnerSelf instantiates a new ExportFormDefinitionsByTenant200ResponseInnerSelf 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 + +### NewExportFormDefinitionsByTenant200ResponseInnerSelfWithDefaults + +`func NewExportFormDefinitionsByTenant200ResponseInnerSelfWithDefaults() *ExportFormDefinitionsByTenant200ResponseInnerSelf` + +NewExportFormDefinitionsByTenant200ResponseInnerSelfWithDefaults instantiates a new ExportFormDefinitionsByTenant200ResponseInnerSelf 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 + +### GetObject + +`func (o *ExportFormDefinitionsByTenant200ResponseInnerSelf) GetObject() FormDefinitionSelfImportExportDto` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *ExportFormDefinitionsByTenant200ResponseInnerSelf) GetObjectOk() (*FormDefinitionSelfImportExportDto, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *ExportFormDefinitionsByTenant200ResponseInnerSelf) SetObject(v FormDefinitionSelfImportExportDto)` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *ExportFormDefinitionsByTenant200ResponseInnerSelf) HasObject() bool` + +HasObject returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ExportOptions.md b/docs/tools/sdk/go/Reference/V2025/Models/ExportOptions.md new file mode 100644 index 000000000..9453bd07c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ExportOptions.md @@ -0,0 +1,116 @@ +--- +id: v2025-export-options +title: ExportOptions +pagination_label: ExportOptions +sidebar_label: ExportOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExportOptions', 'V2025ExportOptions'] +slug: /tools/sdk/go/v2025/models/export-options +tags: ['SDK', 'Software Development Kit', 'ExportOptions', 'V2025ExportOptions'] +--- + +# ExportOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExcludeTypes** | Pointer to **[]string** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]string** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] + +## Methods + +### NewExportOptions + +`func NewExportOptions() *ExportOptions` + +NewExportOptions instantiates a new ExportOptions 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 + +### NewExportOptionsWithDefaults + +`func NewExportOptionsWithDefaults() *ExportOptions` + +NewExportOptionsWithDefaults instantiates a new ExportOptions 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 + +### GetExcludeTypes + +`func (o *ExportOptions) GetExcludeTypes() []string` + +GetExcludeTypes returns the ExcludeTypes field if non-nil, zero value otherwise. + +### GetExcludeTypesOk + +`func (o *ExportOptions) GetExcludeTypesOk() (*[]string, bool)` + +GetExcludeTypesOk returns a tuple with the ExcludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeTypes + +`func (o *ExportOptions) SetExcludeTypes(v []string)` + +SetExcludeTypes sets ExcludeTypes field to given value. + +### HasExcludeTypes + +`func (o *ExportOptions) HasExcludeTypes() bool` + +HasExcludeTypes returns a boolean if a field has been set. + +### GetIncludeTypes + +`func (o *ExportOptions) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *ExportOptions) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *ExportOptions) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *ExportOptions) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *ExportOptions) GetObjectOptions() map[string]ObjectExportImportOptions` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *ExportOptions) GetObjectOptionsOk() (*map[string]ObjectExportImportOptions, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *ExportOptions) SetObjectOptions(v map[string]ObjectExportImportOptions)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *ExportOptions) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ExportOptions1.md b/docs/tools/sdk/go/Reference/V2025/Models/ExportOptions1.md new file mode 100644 index 000000000..f548602b5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ExportOptions1.md @@ -0,0 +1,116 @@ +--- +id: v2025-export-options1 +title: ExportOptions1 +pagination_label: ExportOptions1 +sidebar_label: ExportOptions1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExportOptions1', 'V2025ExportOptions1'] +slug: /tools/sdk/go/v2025/models/export-options1 +tags: ['SDK', 'Software Development Kit', 'ExportOptions1', 'V2025ExportOptions1'] +--- + +# ExportOptions1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExcludeTypes** | Pointer to **[]string** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]string** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] + +## Methods + +### NewExportOptions1 + +`func NewExportOptions1() *ExportOptions1` + +NewExportOptions1 instantiates a new ExportOptions1 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 + +### NewExportOptions1WithDefaults + +`func NewExportOptions1WithDefaults() *ExportOptions1` + +NewExportOptions1WithDefaults instantiates a new ExportOptions1 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 + +### GetExcludeTypes + +`func (o *ExportOptions1) GetExcludeTypes() []string` + +GetExcludeTypes returns the ExcludeTypes field if non-nil, zero value otherwise. + +### GetExcludeTypesOk + +`func (o *ExportOptions1) GetExcludeTypesOk() (*[]string, bool)` + +GetExcludeTypesOk returns a tuple with the ExcludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeTypes + +`func (o *ExportOptions1) SetExcludeTypes(v []string)` + +SetExcludeTypes sets ExcludeTypes field to given value. + +### HasExcludeTypes + +`func (o *ExportOptions1) HasExcludeTypes() bool` + +HasExcludeTypes returns a boolean if a field has been set. + +### GetIncludeTypes + +`func (o *ExportOptions1) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *ExportOptions1) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *ExportOptions1) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *ExportOptions1) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *ExportOptions1) GetObjectOptions() map[string]ObjectExportImportOptions` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *ExportOptions1) GetObjectOptionsOk() (*map[string]ObjectExportImportOptions, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *ExportOptions1) SetObjectOptions(v map[string]ObjectExportImportOptions)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *ExportOptions1) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ExportPayload.md b/docs/tools/sdk/go/Reference/V2025/Models/ExportPayload.md new file mode 100644 index 000000000..d6112d1c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ExportPayload.md @@ -0,0 +1,142 @@ +--- +id: v2025-export-payload +title: ExportPayload +pagination_label: ExportPayload +sidebar_label: ExportPayload +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExportPayload', 'V2025ExportPayload'] +slug: /tools/sdk/go/v2025/models/export-payload +tags: ['SDK', 'Software Development Kit', 'ExportPayload', 'V2025ExportPayload'] +--- + +# ExportPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Optional user defined description/name for export job. | [optional] +**ExcludeTypes** | Pointer to **[]string** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]string** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] + +## Methods + +### NewExportPayload + +`func NewExportPayload() *ExportPayload` + +NewExportPayload instantiates a new ExportPayload 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 + +### NewExportPayloadWithDefaults + +`func NewExportPayloadWithDefaults() *ExportPayload` + +NewExportPayloadWithDefaults instantiates a new ExportPayload 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 + +### GetDescription + +`func (o *ExportPayload) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ExportPayload) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ExportPayload) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ExportPayload) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetExcludeTypes + +`func (o *ExportPayload) GetExcludeTypes() []string` + +GetExcludeTypes returns the ExcludeTypes field if non-nil, zero value otherwise. + +### GetExcludeTypesOk + +`func (o *ExportPayload) GetExcludeTypesOk() (*[]string, bool)` + +GetExcludeTypesOk returns a tuple with the ExcludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeTypes + +`func (o *ExportPayload) SetExcludeTypes(v []string)` + +SetExcludeTypes sets ExcludeTypes field to given value. + +### HasExcludeTypes + +`func (o *ExportPayload) HasExcludeTypes() bool` + +HasExcludeTypes returns a boolean if a field has been set. + +### GetIncludeTypes + +`func (o *ExportPayload) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *ExportPayload) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *ExportPayload) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *ExportPayload) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *ExportPayload) GetObjectOptions() map[string]ObjectExportImportOptions` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *ExportPayload) GetObjectOptionsOk() (*map[string]ObjectExportImportOptions, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *ExportPayload) SetObjectOptions(v map[string]ObjectExportImportOptions)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *ExportPayload) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Expression.md b/docs/tools/sdk/go/Reference/V2025/Models/Expression.md new file mode 100644 index 000000000..e414acff1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Expression.md @@ -0,0 +1,172 @@ +--- +id: v2025-expression +title: Expression +pagination_label: Expression +sidebar_label: Expression +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Expression', 'V2025Expression'] +slug: /tools/sdk/go/v2025/models/expression +tags: ['SDK', 'Software Development Kit', 'Expression', 'V2025Expression'] +--- + +# Expression + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **string** | Operator for the expression | [optional] +**Attribute** | Pointer to **NullableString** | Name for the attribute | [optional] +**Value** | Pointer to [**NullableValue**](value) | | [optional] +**Children** | Pointer to [**[]ExpressionChildrenInner**](expression-children-inner) | List of expressions | [optional] + +## Methods + +### NewExpression + +`func NewExpression() *Expression` + +NewExpression instantiates a new Expression 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 + +### NewExpressionWithDefaults + +`func NewExpressionWithDefaults() *Expression` + +NewExpressionWithDefaults instantiates a new Expression 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 + +### GetOperator + +`func (o *Expression) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *Expression) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *Expression) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *Expression) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetAttribute + +`func (o *Expression) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *Expression) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *Expression) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *Expression) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *Expression) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *Expression) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *Expression) GetValue() Value` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Expression) GetValueOk() (*Value, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Expression) SetValue(v Value)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Expression) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *Expression) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *Expression) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *Expression) GetChildren() []ExpressionChildrenInner` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *Expression) GetChildrenOk() (*[]ExpressionChildrenInner, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *Expression) SetChildren(v []ExpressionChildrenInner)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *Expression) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *Expression) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *Expression) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ExpressionChildrenInner.md b/docs/tools/sdk/go/Reference/V2025/Models/ExpressionChildrenInner.md new file mode 100644 index 000000000..55f519b38 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ExpressionChildrenInner.md @@ -0,0 +1,172 @@ +--- +id: v2025-expression-children-inner +title: ExpressionChildrenInner +pagination_label: ExpressionChildrenInner +sidebar_label: ExpressionChildrenInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExpressionChildrenInner', 'V2025ExpressionChildrenInner'] +slug: /tools/sdk/go/v2025/models/expression-children-inner +tags: ['SDK', 'Software Development Kit', 'ExpressionChildrenInner', 'V2025ExpressionChildrenInner'] +--- + +# ExpressionChildrenInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **string** | Operator for the expression | [optional] +**Attribute** | Pointer to **NullableString** | Name for the attribute | [optional] +**Value** | Pointer to [**NullableValue**](value) | | [optional] +**Children** | Pointer to **NullableString** | There cannot be anymore nested children. This will always be null. | [optional] + +## Methods + +### NewExpressionChildrenInner + +`func NewExpressionChildrenInner() *ExpressionChildrenInner` + +NewExpressionChildrenInner instantiates a new ExpressionChildrenInner 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 + +### NewExpressionChildrenInnerWithDefaults + +`func NewExpressionChildrenInnerWithDefaults() *ExpressionChildrenInner` + +NewExpressionChildrenInnerWithDefaults instantiates a new ExpressionChildrenInner 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 + +### GetOperator + +`func (o *ExpressionChildrenInner) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *ExpressionChildrenInner) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *ExpressionChildrenInner) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *ExpressionChildrenInner) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ExpressionChildrenInner) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ExpressionChildrenInner) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ExpressionChildrenInner) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ExpressionChildrenInner) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *ExpressionChildrenInner) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *ExpressionChildrenInner) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *ExpressionChildrenInner) GetValue() Value` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ExpressionChildrenInner) GetValueOk() (*Value, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ExpressionChildrenInner) SetValue(v Value)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ExpressionChildrenInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ExpressionChildrenInner) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ExpressionChildrenInner) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *ExpressionChildrenInner) GetChildren() string` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *ExpressionChildrenInner) GetChildrenOk() (*string, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *ExpressionChildrenInner) SetChildren(v string)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *ExpressionChildrenInner) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *ExpressionChildrenInner) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *ExpressionChildrenInner) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FeatureValueDto.md b/docs/tools/sdk/go/Reference/V2025/Models/FeatureValueDto.md new file mode 100644 index 000000000..8a5f8501c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FeatureValueDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-feature-value-dto +title: FeatureValueDto +pagination_label: FeatureValueDto +sidebar_label: FeatureValueDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FeatureValueDto', 'V2025FeatureValueDto'] +slug: /tools/sdk/go/v2025/models/feature-value-dto +tags: ['SDK', 'Software Development Kit', 'FeatureValueDto', 'V2025FeatureValueDto'] +--- + +# FeatureValueDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Feature** | Pointer to **string** | The type of feature | [optional] +**Numerator** | Pointer to **int32** | The number of identities that have access to the feature | [optional] +**Denominator** | Pointer to **int32** | The number of identities with the corresponding feature | [optional] + +## Methods + +### NewFeatureValueDto + +`func NewFeatureValueDto() *FeatureValueDto` + +NewFeatureValueDto instantiates a new FeatureValueDto 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 + +### NewFeatureValueDtoWithDefaults + +`func NewFeatureValueDtoWithDefaults() *FeatureValueDto` + +NewFeatureValueDtoWithDefaults instantiates a new FeatureValueDto 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 + +### GetFeature + +`func (o *FeatureValueDto) GetFeature() string` + +GetFeature returns the Feature field if non-nil, zero value otherwise. + +### GetFeatureOk + +`func (o *FeatureValueDto) GetFeatureOk() (*string, bool)` + +GetFeatureOk returns a tuple with the Feature field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeature + +`func (o *FeatureValueDto) SetFeature(v string)` + +SetFeature sets Feature field to given value. + +### HasFeature + +`func (o *FeatureValueDto) HasFeature() bool` + +HasFeature returns a boolean if a field has been set. + +### GetNumerator + +`func (o *FeatureValueDto) GetNumerator() int32` + +GetNumerator returns the Numerator field if non-nil, zero value otherwise. + +### GetNumeratorOk + +`func (o *FeatureValueDto) GetNumeratorOk() (*int32, bool)` + +GetNumeratorOk returns a tuple with the Numerator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumerator + +`func (o *FeatureValueDto) SetNumerator(v int32)` + +SetNumerator sets Numerator field to given value. + +### HasNumerator + +`func (o *FeatureValueDto) HasNumerator() bool` + +HasNumerator returns a boolean if a field has been set. + +### GetDenominator + +`func (o *FeatureValueDto) GetDenominator() int32` + +GetDenominator returns the Denominator field if non-nil, zero value otherwise. + +### GetDenominatorOk + +`func (o *FeatureValueDto) GetDenominatorOk() (*int32, bool)` + +GetDenominatorOk returns a tuple with the Denominator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenominator + +`func (o *FeatureValueDto) SetDenominator(v int32)` + +SetDenominator sets Denominator field to given value. + +### HasDenominator + +`func (o *FeatureValueDto) HasDenominator() bool` + +HasDenominator returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FederationProtocolDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/FederationProtocolDetails.md new file mode 100644 index 000000000..d096c223f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FederationProtocolDetails.md @@ -0,0 +1,90 @@ +--- +id: v2025-federation-protocol-details +title: FederationProtocolDetails +pagination_label: FederationProtocolDetails +sidebar_label: FederationProtocolDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FederationProtocolDetails', 'V2025FederationProtocolDetails'] +slug: /tools/sdk/go/v2025/models/federation-protocol-details +tags: ['SDK', 'Software Development Kit', 'FederationProtocolDetails', 'V2025FederationProtocolDetails'] +--- + +# FederationProtocolDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | Pointer to **string** | Federation protocol role | [optional] +**EntityId** | Pointer to **string** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] + +## Methods + +### NewFederationProtocolDetails + +`func NewFederationProtocolDetails() *FederationProtocolDetails` + +NewFederationProtocolDetails instantiates a new FederationProtocolDetails 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 + +### NewFederationProtocolDetailsWithDefaults + +`func NewFederationProtocolDetailsWithDefaults() *FederationProtocolDetails` + +NewFederationProtocolDetailsWithDefaults instantiates a new FederationProtocolDetails 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 + +### GetRole + +`func (o *FederationProtocolDetails) GetRole() string` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *FederationProtocolDetails) GetRoleOk() (*string, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *FederationProtocolDetails) SetRole(v string)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *FederationProtocolDetails) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetEntityId + +`func (o *FederationProtocolDetails) GetEntityId() string` + +GetEntityId returns the EntityId field if non-nil, zero value otherwise. + +### GetEntityIdOk + +`func (o *FederationProtocolDetails) GetEntityIdOk() (*string, bool)` + +GetEntityIdOk returns a tuple with the EntityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntityId + +`func (o *FederationProtocolDetails) SetEntityId(v string)` + +SetEntityId sets EntityId field to given value. + +### HasEntityId + +`func (o *FederationProtocolDetails) HasEntityId() bool` + +HasEntityId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FieldDetailsDto.md b/docs/tools/sdk/go/Reference/V2025/Models/FieldDetailsDto.md new file mode 100644 index 000000000..50b4a1577 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FieldDetailsDto.md @@ -0,0 +1,194 @@ +--- +id: v2025-field-details-dto +title: FieldDetailsDto +pagination_label: FieldDetailsDto +sidebar_label: FieldDetailsDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FieldDetailsDto', 'V2025FieldDetailsDto'] +slug: /tools/sdk/go/v2025/models/field-details-dto +tags: ['SDK', 'Software Development Kit', 'FieldDetailsDto', 'V2025FieldDetailsDto'] +--- + +# FieldDetailsDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the attribute. | [optional] +**Transform** | Pointer to **map[string]interface{}** | The transform to apply to the field | [optional] [default to {}] +**Attributes** | Pointer to **map[string]interface{}** | Attributes required for the transform | [optional] +**IsRequired** | Pointer to **bool** | Flag indicating whether or not the attribute is required. | [optional] [readonly] [default to false] +**Type** | Pointer to **string** | The type of the attribute. | [optional] +**IsMultiValued** | Pointer to **bool** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to false] + +## Methods + +### NewFieldDetailsDto + +`func NewFieldDetailsDto() *FieldDetailsDto` + +NewFieldDetailsDto instantiates a new FieldDetailsDto 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 + +### NewFieldDetailsDtoWithDefaults + +`func NewFieldDetailsDtoWithDefaults() *FieldDetailsDto` + +NewFieldDetailsDtoWithDefaults instantiates a new FieldDetailsDto 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 + +### GetName + +`func (o *FieldDetailsDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FieldDetailsDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FieldDetailsDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FieldDetailsDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetTransform + +`func (o *FieldDetailsDto) GetTransform() map[string]interface{}` + +GetTransform returns the Transform field if non-nil, zero value otherwise. + +### GetTransformOk + +`func (o *FieldDetailsDto) GetTransformOk() (*map[string]interface{}, bool)` + +GetTransformOk returns a tuple with the Transform field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTransform + +`func (o *FieldDetailsDto) SetTransform(v map[string]interface{})` + +SetTransform sets Transform field to given value. + +### HasTransform + +`func (o *FieldDetailsDto) HasTransform() bool` + +HasTransform returns a boolean if a field has been set. + +### GetAttributes + +`func (o *FieldDetailsDto) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *FieldDetailsDto) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *FieldDetailsDto) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *FieldDetailsDto) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetIsRequired + +`func (o *FieldDetailsDto) GetIsRequired() bool` + +GetIsRequired returns the IsRequired field if non-nil, zero value otherwise. + +### GetIsRequiredOk + +`func (o *FieldDetailsDto) GetIsRequiredOk() (*bool, bool)` + +GetIsRequiredOk returns a tuple with the IsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsRequired + +`func (o *FieldDetailsDto) SetIsRequired(v bool)` + +SetIsRequired sets IsRequired field to given value. + +### HasIsRequired + +`func (o *FieldDetailsDto) HasIsRequired() bool` + +HasIsRequired returns a boolean if a field has been set. + +### GetType + +`func (o *FieldDetailsDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FieldDetailsDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FieldDetailsDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FieldDetailsDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetIsMultiValued + +`func (o *FieldDetailsDto) GetIsMultiValued() bool` + +GetIsMultiValued returns the IsMultiValued field if non-nil, zero value otherwise. + +### GetIsMultiValuedOk + +`func (o *FieldDetailsDto) GetIsMultiValuedOk() (*bool, bool)` + +GetIsMultiValuedOk returns a tuple with the IsMultiValued field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsMultiValued + +`func (o *FieldDetailsDto) SetIsMultiValued(v bool)` + +SetIsMultiValued sets IsMultiValued field to given value. + +### HasIsMultiValued + +`func (o *FieldDetailsDto) HasIsMultiValued() bool` + +HasIsMultiValued returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Filter.md b/docs/tools/sdk/go/Reference/V2025/Models/Filter.md new file mode 100644 index 000000000..973d65fe8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Filter.md @@ -0,0 +1,142 @@ +--- +id: v2025-filter +title: Filter +pagination_label: Filter +sidebar_label: Filter +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Filter', 'V2025Filter'] +slug: /tools/sdk/go/v2025/models/filter +tags: ['SDK', 'Software Development Kit', 'Filter', 'V2025Filter'] +--- + +# Filter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**FilterType**](filter-type) | | [optional] +**Range** | Pointer to [**Range**](range) | | [optional] +**Terms** | Pointer to **[]string** | The terms to be filtered. | [optional] +**Exclude** | Pointer to **bool** | Indicates if the filter excludes results. | [optional] [default to false] + +## Methods + +### NewFilter + +`func NewFilter() *Filter` + +NewFilter instantiates a new Filter 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 + +### NewFilterWithDefaults + +`func NewFilterWithDefaults() *Filter` + +NewFilterWithDefaults instantiates a new Filter 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 + +### GetType + +`func (o *Filter) GetType() FilterType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Filter) GetTypeOk() (*FilterType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Filter) SetType(v FilterType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Filter) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRange + +`func (o *Filter) GetRange() Range` + +GetRange returns the Range field if non-nil, zero value otherwise. + +### GetRangeOk + +`func (o *Filter) GetRangeOk() (*Range, bool)` + +GetRangeOk returns a tuple with the Range field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRange + +`func (o *Filter) SetRange(v Range)` + +SetRange sets Range field to given value. + +### HasRange + +`func (o *Filter) HasRange() bool` + +HasRange returns a boolean if a field has been set. + +### GetTerms + +`func (o *Filter) GetTerms() []string` + +GetTerms returns the Terms field if non-nil, zero value otherwise. + +### GetTermsOk + +`func (o *Filter) GetTermsOk() (*[]string, bool)` + +GetTermsOk returns a tuple with the Terms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerms + +`func (o *Filter) SetTerms(v []string)` + +SetTerms sets Terms field to given value. + +### HasTerms + +`func (o *Filter) HasTerms() bool` + +HasTerms returns a boolean if a field has been set. + +### GetExclude + +`func (o *Filter) GetExclude() bool` + +GetExclude returns the Exclude field if non-nil, zero value otherwise. + +### GetExcludeOk + +`func (o *Filter) GetExcludeOk() (*bool, bool)` + +GetExcludeOk returns a tuple with the Exclude field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExclude + +`func (o *Filter) SetExclude(v bool)` + +SetExclude sets Exclude field to given value. + +### HasExclude + +`func (o *Filter) HasExclude() bool` + +HasExclude returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FilterAggregation.md b/docs/tools/sdk/go/Reference/V2025/Models/FilterAggregation.md new file mode 100644 index 000000000..e0c32b63f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FilterAggregation.md @@ -0,0 +1,127 @@ +--- +id: v2025-filter-aggregation +title: FilterAggregation +pagination_label: FilterAggregation +sidebar_label: FilterAggregation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FilterAggregation', 'V2025FilterAggregation'] +slug: /tools/sdk/go/v2025/models/filter-aggregation +tags: ['SDK', 'Software Development Kit', 'FilterAggregation', 'V2025FilterAggregation'] +--- + +# FilterAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the filter aggregate to be included in the result. | +**Type** | Pointer to [**SearchFilterType**](search-filter-type) | | [optional] [default to SEARCHFILTERTYPE_TERM] +**Field** | **string** | The search field to apply the filter to. Prefix the field name with '@' to reference a nested object. | +**Value** | **string** | The value to filter on. | + +## Methods + +### NewFilterAggregation + +`func NewFilterAggregation(name string, field string, value string, ) *FilterAggregation` + +NewFilterAggregation instantiates a new FilterAggregation 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 + +### NewFilterAggregationWithDefaults + +`func NewFilterAggregationWithDefaults() *FilterAggregation` + +NewFilterAggregationWithDefaults instantiates a new FilterAggregation 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 + +### GetName + +`func (o *FilterAggregation) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FilterAggregation) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FilterAggregation) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *FilterAggregation) GetType() SearchFilterType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FilterAggregation) GetTypeOk() (*SearchFilterType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FilterAggregation) SetType(v SearchFilterType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FilterAggregation) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetField + +`func (o *FilterAggregation) GetField() string` + +GetField returns the Field field if non-nil, zero value otherwise. + +### GetFieldOk + +`func (o *FilterAggregation) GetFieldOk() (*string, bool)` + +GetFieldOk returns a tuple with the Field field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetField + +`func (o *FilterAggregation) SetField(v string)` + +SetField sets Field field to given value. + + +### GetValue + +`func (o *FilterAggregation) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *FilterAggregation) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *FilterAggregation) SetValue(v string)` + +SetValue sets Value field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FilterType.md b/docs/tools/sdk/go/Reference/V2025/Models/FilterType.md new file mode 100644 index 000000000..0015a29db --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FilterType.md @@ -0,0 +1,23 @@ +--- +id: v2025-filter-type +title: FilterType +pagination_label: FilterType +sidebar_label: FilterType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FilterType', 'V2025FilterType'] +slug: /tools/sdk/go/v2025/models/filter-type +tags: ['SDK', 'Software Development Kit', 'FilterType', 'V2025FilterType'] +--- + +# FilterType + +## Enum + + +* `EXISTS` (value: `"EXISTS"`) + +* `RANGE` (value: `"RANGE"`) + +* `TERMS` (value: `"TERMS"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormCondition.md b/docs/tools/sdk/go/Reference/V2025/Models/FormCondition.md new file mode 100644 index 000000000..a571d0798 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormCondition.md @@ -0,0 +1,116 @@ +--- +id: v2025-form-condition +title: FormCondition +pagination_label: FormCondition +sidebar_label: FormCondition +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormCondition', 'V2025FormCondition'] +slug: /tools/sdk/go/v2025/models/form-condition +tags: ['SDK', 'Software Development Kit', 'FormCondition', 'V2025FormCondition'] +--- + +# FormCondition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RuleOperator** | Pointer to **string** | ConditionRuleLogicalOperatorType value. AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr | [optional] +**Rules** | Pointer to [**[]ConditionRule**](condition-rule) | List of rules. | [optional] +**Effects** | Pointer to [**[]ConditionEffect**](condition-effect) | List of effects. | [optional] + +## Methods + +### NewFormCondition + +`func NewFormCondition() *FormCondition` + +NewFormCondition instantiates a new FormCondition 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 + +### NewFormConditionWithDefaults + +`func NewFormConditionWithDefaults() *FormCondition` + +NewFormConditionWithDefaults instantiates a new FormCondition 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 + +### GetRuleOperator + +`func (o *FormCondition) GetRuleOperator() string` + +GetRuleOperator returns the RuleOperator field if non-nil, zero value otherwise. + +### GetRuleOperatorOk + +`func (o *FormCondition) GetRuleOperatorOk() (*string, bool)` + +GetRuleOperatorOk returns a tuple with the RuleOperator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRuleOperator + +`func (o *FormCondition) SetRuleOperator(v string)` + +SetRuleOperator sets RuleOperator field to given value. + +### HasRuleOperator + +`func (o *FormCondition) HasRuleOperator() bool` + +HasRuleOperator returns a boolean if a field has been set. + +### GetRules + +`func (o *FormCondition) GetRules() []ConditionRule` + +GetRules returns the Rules field if non-nil, zero value otherwise. + +### GetRulesOk + +`func (o *FormCondition) GetRulesOk() (*[]ConditionRule, bool)` + +GetRulesOk returns a tuple with the Rules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRules + +`func (o *FormCondition) SetRules(v []ConditionRule)` + +SetRules sets Rules field to given value. + +### HasRules + +`func (o *FormCondition) HasRules() bool` + +HasRules returns a boolean if a field has been set. + +### GetEffects + +`func (o *FormCondition) GetEffects() []ConditionEffect` + +GetEffects returns the Effects field if non-nil, zero value otherwise. + +### GetEffectsOk + +`func (o *FormCondition) GetEffectsOk() (*[]ConditionEffect, bool)` + +GetEffectsOk returns a tuple with the Effects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEffects + +`func (o *FormCondition) SetEffects(v []ConditionEffect)` + +SetEffects sets Effects field to given value. + +### HasEffects + +`func (o *FormCondition) HasEffects() bool` + +HasEffects returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionDynamicSchemaRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionDynamicSchemaRequest.md new file mode 100644 index 000000000..9c1e2804b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionDynamicSchemaRequest.md @@ -0,0 +1,168 @@ +--- +id: v2025-form-definition-dynamic-schema-request +title: FormDefinitionDynamicSchemaRequest +pagination_label: FormDefinitionDynamicSchemaRequest +sidebar_label: FormDefinitionDynamicSchemaRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionDynamicSchemaRequest', 'V2025FormDefinitionDynamicSchemaRequest'] +slug: /tools/sdk/go/v2025/models/form-definition-dynamic-schema-request +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaRequest', 'V2025FormDefinitionDynamicSchemaRequest'] +--- + +# FormDefinitionDynamicSchemaRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**FormDefinitionDynamicSchemaRequestAttributes**](form-definition-dynamic-schema-request-attributes) | | [optional] +**Description** | Pointer to **string** | Description is the form definition dynamic schema description text | [optional] +**Id** | Pointer to **string** | ID is a unique identifier | [optional] +**Type** | Pointer to **string** | Type is the form definition dynamic schema type | [optional] +**VersionNumber** | Pointer to **int64** | VersionNumber is the form definition dynamic schema version number | [optional] + +## Methods + +### NewFormDefinitionDynamicSchemaRequest + +`func NewFormDefinitionDynamicSchemaRequest() *FormDefinitionDynamicSchemaRequest` + +NewFormDefinitionDynamicSchemaRequest instantiates a new FormDefinitionDynamicSchemaRequest 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 + +### NewFormDefinitionDynamicSchemaRequestWithDefaults + +`func NewFormDefinitionDynamicSchemaRequestWithDefaults() *FormDefinitionDynamicSchemaRequest` + +NewFormDefinitionDynamicSchemaRequestWithDefaults instantiates a new FormDefinitionDynamicSchemaRequest 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 + +### GetAttributes + +`func (o *FormDefinitionDynamicSchemaRequest) GetAttributes() FormDefinitionDynamicSchemaRequestAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *FormDefinitionDynamicSchemaRequest) GetAttributesOk() (*FormDefinitionDynamicSchemaRequestAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *FormDefinitionDynamicSchemaRequest) SetAttributes(v FormDefinitionDynamicSchemaRequestAttributes)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *FormDefinitionDynamicSchemaRequest) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetDescription + +`func (o *FormDefinitionDynamicSchemaRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *FormDefinitionDynamicSchemaRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *FormDefinitionDynamicSchemaRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *FormDefinitionDynamicSchemaRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetId + +`func (o *FormDefinitionDynamicSchemaRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormDefinitionDynamicSchemaRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormDefinitionDynamicSchemaRequest) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormDefinitionDynamicSchemaRequest) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *FormDefinitionDynamicSchemaRequest) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormDefinitionDynamicSchemaRequest) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormDefinitionDynamicSchemaRequest) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormDefinitionDynamicSchemaRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetVersionNumber + +`func (o *FormDefinitionDynamicSchemaRequest) GetVersionNumber() int64` + +GetVersionNumber returns the VersionNumber field if non-nil, zero value otherwise. + +### GetVersionNumberOk + +`func (o *FormDefinitionDynamicSchemaRequest) GetVersionNumberOk() (*int64, bool)` + +GetVersionNumberOk returns a tuple with the VersionNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionNumber + +`func (o *FormDefinitionDynamicSchemaRequest) SetVersionNumber(v int64)` + +SetVersionNumber sets VersionNumber field to given value. + +### HasVersionNumber + +`func (o *FormDefinitionDynamicSchemaRequest) HasVersionNumber() bool` + +HasVersionNumber returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionDynamicSchemaRequestAttributes.md b/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionDynamicSchemaRequestAttributes.md new file mode 100644 index 000000000..0b48032b8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionDynamicSchemaRequestAttributes.md @@ -0,0 +1,64 @@ +--- +id: v2025-form-definition-dynamic-schema-request-attributes +title: FormDefinitionDynamicSchemaRequestAttributes +pagination_label: FormDefinitionDynamicSchemaRequestAttributes +sidebar_label: FormDefinitionDynamicSchemaRequestAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionDynamicSchemaRequestAttributes', 'V2025FormDefinitionDynamicSchemaRequestAttributes'] +slug: /tools/sdk/go/v2025/models/form-definition-dynamic-schema-request-attributes +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaRequestAttributes', 'V2025FormDefinitionDynamicSchemaRequestAttributes'] +--- + +# FormDefinitionDynamicSchemaRequestAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FormDefinitionId** | Pointer to **string** | FormDefinitionID is a unique guid identifying this form definition | [optional] + +## Methods + +### NewFormDefinitionDynamicSchemaRequestAttributes + +`func NewFormDefinitionDynamicSchemaRequestAttributes() *FormDefinitionDynamicSchemaRequestAttributes` + +NewFormDefinitionDynamicSchemaRequestAttributes instantiates a new FormDefinitionDynamicSchemaRequestAttributes 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 + +### NewFormDefinitionDynamicSchemaRequestAttributesWithDefaults + +`func NewFormDefinitionDynamicSchemaRequestAttributesWithDefaults() *FormDefinitionDynamicSchemaRequestAttributes` + +NewFormDefinitionDynamicSchemaRequestAttributesWithDefaults instantiates a new FormDefinitionDynamicSchemaRequestAttributes 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 + +### GetFormDefinitionId + +`func (o *FormDefinitionDynamicSchemaRequestAttributes) GetFormDefinitionId() string` + +GetFormDefinitionId returns the FormDefinitionId field if non-nil, zero value otherwise. + +### GetFormDefinitionIdOk + +`func (o *FormDefinitionDynamicSchemaRequestAttributes) GetFormDefinitionIdOk() (*string, bool)` + +GetFormDefinitionIdOk returns a tuple with the FormDefinitionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormDefinitionId + +`func (o *FormDefinitionDynamicSchemaRequestAttributes) SetFormDefinitionId(v string)` + +SetFormDefinitionId sets FormDefinitionId field to given value. + +### HasFormDefinitionId + +`func (o *FormDefinitionDynamicSchemaRequestAttributes) HasFormDefinitionId() bool` + +HasFormDefinitionId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionDynamicSchemaResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionDynamicSchemaResponse.md new file mode 100644 index 000000000..b199da795 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionDynamicSchemaResponse.md @@ -0,0 +1,64 @@ +--- +id: v2025-form-definition-dynamic-schema-response +title: FormDefinitionDynamicSchemaResponse +pagination_label: FormDefinitionDynamicSchemaResponse +sidebar_label: FormDefinitionDynamicSchemaResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionDynamicSchemaResponse', 'V2025FormDefinitionDynamicSchemaResponse'] +slug: /tools/sdk/go/v2025/models/form-definition-dynamic-schema-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaResponse', 'V2025FormDefinitionDynamicSchemaResponse'] +--- + +# FormDefinitionDynamicSchemaResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OutputSchema** | Pointer to **map[string]map[string]interface{}** | OutputSchema holds a JSON schema generated dynamically | [optional] + +## Methods + +### NewFormDefinitionDynamicSchemaResponse + +`func NewFormDefinitionDynamicSchemaResponse() *FormDefinitionDynamicSchemaResponse` + +NewFormDefinitionDynamicSchemaResponse instantiates a new FormDefinitionDynamicSchemaResponse 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 + +### NewFormDefinitionDynamicSchemaResponseWithDefaults + +`func NewFormDefinitionDynamicSchemaResponseWithDefaults() *FormDefinitionDynamicSchemaResponse` + +NewFormDefinitionDynamicSchemaResponseWithDefaults instantiates a new FormDefinitionDynamicSchemaResponse 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 + +### GetOutputSchema + +`func (o *FormDefinitionDynamicSchemaResponse) GetOutputSchema() map[string]map[string]interface{}` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *FormDefinitionDynamicSchemaResponse) GetOutputSchemaOk() (*map[string]map[string]interface{}, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *FormDefinitionDynamicSchemaResponse) SetOutputSchema(v map[string]map[string]interface{})` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *FormDefinitionDynamicSchemaResponse) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionFileUploadResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionFileUploadResponse.md new file mode 100644 index 000000000..7c72fc632 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionFileUploadResponse.md @@ -0,0 +1,116 @@ +--- +id: v2025-form-definition-file-upload-response +title: FormDefinitionFileUploadResponse +pagination_label: FormDefinitionFileUploadResponse +sidebar_label: FormDefinitionFileUploadResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionFileUploadResponse', 'V2025FormDefinitionFileUploadResponse'] +slug: /tools/sdk/go/v2025/models/form-definition-file-upload-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionFileUploadResponse', 'V2025FormDefinitionFileUploadResponse'] +--- + +# FormDefinitionFileUploadResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **string** | Created is the date the file was uploaded | [optional] +**FileId** | Pointer to **string** | fileId is a unique ULID that serves as an identifier for the form definition file | [optional] +**FormDefinitionId** | Pointer to **string** | FormDefinitionID is a unique guid identifying this form definition | [optional] + +## Methods + +### NewFormDefinitionFileUploadResponse + +`func NewFormDefinitionFileUploadResponse() *FormDefinitionFileUploadResponse` + +NewFormDefinitionFileUploadResponse instantiates a new FormDefinitionFileUploadResponse 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 + +### NewFormDefinitionFileUploadResponseWithDefaults + +`func NewFormDefinitionFileUploadResponseWithDefaults() *FormDefinitionFileUploadResponse` + +NewFormDefinitionFileUploadResponseWithDefaults instantiates a new FormDefinitionFileUploadResponse 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 + +### GetCreated + +`func (o *FormDefinitionFileUploadResponse) GetCreated() string` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *FormDefinitionFileUploadResponse) GetCreatedOk() (*string, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *FormDefinitionFileUploadResponse) SetCreated(v string)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *FormDefinitionFileUploadResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetFileId + +`func (o *FormDefinitionFileUploadResponse) GetFileId() string` + +GetFileId returns the FileId field if non-nil, zero value otherwise. + +### GetFileIdOk + +`func (o *FormDefinitionFileUploadResponse) GetFileIdOk() (*string, bool)` + +GetFileIdOk returns a tuple with the FileId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileId + +`func (o *FormDefinitionFileUploadResponse) SetFileId(v string)` + +SetFileId sets FileId field to given value. + +### HasFileId + +`func (o *FormDefinitionFileUploadResponse) HasFileId() bool` + +HasFileId returns a boolean if a field has been set. + +### GetFormDefinitionId + +`func (o *FormDefinitionFileUploadResponse) GetFormDefinitionId() string` + +GetFormDefinitionId returns the FormDefinitionId field if non-nil, zero value otherwise. + +### GetFormDefinitionIdOk + +`func (o *FormDefinitionFileUploadResponse) GetFormDefinitionIdOk() (*string, bool)` + +GetFormDefinitionIdOk returns a tuple with the FormDefinitionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormDefinitionId + +`func (o *FormDefinitionFileUploadResponse) SetFormDefinitionId(v string)` + +SetFormDefinitionId sets FormDefinitionId field to given value. + +### HasFormDefinitionId + +`func (o *FormDefinitionFileUploadResponse) HasFormDefinitionId() bool` + +HasFormDefinitionId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionInput.md b/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionInput.md new file mode 100644 index 000000000..fdbfe89a9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionInput.md @@ -0,0 +1,142 @@ +--- +id: v2025-form-definition-input +title: FormDefinitionInput +pagination_label: FormDefinitionInput +sidebar_label: FormDefinitionInput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionInput', 'V2025FormDefinitionInput'] +slug: /tools/sdk/go/v2025/models/form-definition-input +tags: ['SDK', 'Software Development Kit', 'FormDefinitionInput', 'V2025FormDefinitionInput'] +--- + +# FormDefinitionInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the form input. | [optional] +**Type** | Pointer to **string** | FormDefinitionInputType value. STRING FormDefinitionInputTypeString | [optional] +**Label** | Pointer to **string** | Name for the form input. | [optional] +**Description** | Pointer to **string** | Form input's description. | [optional] + +## Methods + +### NewFormDefinitionInput + +`func NewFormDefinitionInput() *FormDefinitionInput` + +NewFormDefinitionInput instantiates a new FormDefinitionInput 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 + +### NewFormDefinitionInputWithDefaults + +`func NewFormDefinitionInputWithDefaults() *FormDefinitionInput` + +NewFormDefinitionInputWithDefaults instantiates a new FormDefinitionInput 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 + +### GetId + +`func (o *FormDefinitionInput) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormDefinitionInput) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormDefinitionInput) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormDefinitionInput) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *FormDefinitionInput) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormDefinitionInput) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormDefinitionInput) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormDefinitionInput) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetLabel + +`func (o *FormDefinitionInput) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *FormDefinitionInput) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *FormDefinitionInput) SetLabel(v string)` + +SetLabel sets Label field to given value. + +### HasLabel + +`func (o *FormDefinitionInput) HasLabel() bool` + +HasLabel returns a boolean if a field has been set. + +### GetDescription + +`func (o *FormDefinitionInput) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *FormDefinitionInput) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *FormDefinitionInput) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *FormDefinitionInput) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionResponse.md new file mode 100644 index 000000000..e4fb30a81 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionResponse.md @@ -0,0 +1,298 @@ +--- +id: v2025-form-definition-response +title: FormDefinitionResponse +pagination_label: FormDefinitionResponse +sidebar_label: FormDefinitionResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionResponse', 'V2025FormDefinitionResponse'] +slug: /tools/sdk/go/v2025/models/form-definition-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionResponse', 'V2025FormDefinitionResponse'] +--- + +# FormDefinitionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique guid identifying the form definition. | [optional] +**Name** | Pointer to **string** | Name of the form definition. | [optional] +**Description** | Pointer to **string** | Form definition's description. | [optional] +**Owner** | Pointer to [**FormOwner**](form-owner) | | [optional] +**UsedBy** | Pointer to [**[]FormUsedBy**](form-used-by) | List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. | [optional] +**FormInput** | Pointer to [**[]FormDefinitionInput**](form-definition-input) | List of form inputs required to create a form-instance object. | [optional] +**FormElements** | Pointer to [**[]FormElement**](form-element) | List of nested form elements. | [optional] +**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | Conditional logic that can dynamically modify the form as the recipient is interacting with it. | [optional] +**Created** | Pointer to **SailPointTime** | Created is the date the form definition was created | [optional] +**Modified** | Pointer to **SailPointTime** | Modified is the last date the form definition was modified | [optional] + +## Methods + +### NewFormDefinitionResponse + +`func NewFormDefinitionResponse() *FormDefinitionResponse` + +NewFormDefinitionResponse instantiates a new FormDefinitionResponse 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 + +### NewFormDefinitionResponseWithDefaults + +`func NewFormDefinitionResponseWithDefaults() *FormDefinitionResponse` + +NewFormDefinitionResponseWithDefaults instantiates a new FormDefinitionResponse 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 + +### GetId + +`func (o *FormDefinitionResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormDefinitionResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormDefinitionResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormDefinitionResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FormDefinitionResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormDefinitionResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormDefinitionResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormDefinitionResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *FormDefinitionResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *FormDefinitionResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *FormDefinitionResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *FormDefinitionResponse) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *FormDefinitionResponse) GetOwner() FormOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *FormDefinitionResponse) GetOwnerOk() (*FormOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *FormDefinitionResponse) SetOwner(v FormOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *FormDefinitionResponse) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetUsedBy + +`func (o *FormDefinitionResponse) GetUsedBy() []FormUsedBy` + +GetUsedBy returns the UsedBy field if non-nil, zero value otherwise. + +### GetUsedByOk + +`func (o *FormDefinitionResponse) GetUsedByOk() (*[]FormUsedBy, bool)` + +GetUsedByOk returns a tuple with the UsedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsedBy + +`func (o *FormDefinitionResponse) SetUsedBy(v []FormUsedBy)` + +SetUsedBy sets UsedBy field to given value. + +### HasUsedBy + +`func (o *FormDefinitionResponse) HasUsedBy() bool` + +HasUsedBy returns a boolean if a field has been set. + +### GetFormInput + +`func (o *FormDefinitionResponse) GetFormInput() []FormDefinitionInput` + +GetFormInput returns the FormInput field if non-nil, zero value otherwise. + +### GetFormInputOk + +`func (o *FormDefinitionResponse) GetFormInputOk() (*[]FormDefinitionInput, bool)` + +GetFormInputOk returns a tuple with the FormInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormInput + +`func (o *FormDefinitionResponse) SetFormInput(v []FormDefinitionInput)` + +SetFormInput sets FormInput field to given value. + +### HasFormInput + +`func (o *FormDefinitionResponse) HasFormInput() bool` + +HasFormInput returns a boolean if a field has been set. + +### GetFormElements + +`func (o *FormDefinitionResponse) GetFormElements() []FormElement` + +GetFormElements returns the FormElements field if non-nil, zero value otherwise. + +### GetFormElementsOk + +`func (o *FormDefinitionResponse) GetFormElementsOk() (*[]FormElement, bool)` + +GetFormElementsOk returns a tuple with the FormElements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormElements + +`func (o *FormDefinitionResponse) SetFormElements(v []FormElement)` + +SetFormElements sets FormElements field to given value. + +### HasFormElements + +`func (o *FormDefinitionResponse) HasFormElements() bool` + +HasFormElements returns a boolean if a field has been set. + +### GetFormConditions + +`func (o *FormDefinitionResponse) GetFormConditions() []FormCondition` + +GetFormConditions returns the FormConditions field if non-nil, zero value otherwise. + +### GetFormConditionsOk + +`func (o *FormDefinitionResponse) GetFormConditionsOk() (*[]FormCondition, bool)` + +GetFormConditionsOk returns a tuple with the FormConditions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormConditions + +`func (o *FormDefinitionResponse) SetFormConditions(v []FormCondition)` + +SetFormConditions sets FormConditions field to given value. + +### HasFormConditions + +`func (o *FormDefinitionResponse) HasFormConditions() bool` + +HasFormConditions returns a boolean if a field has been set. + +### GetCreated + +`func (o *FormDefinitionResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *FormDefinitionResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *FormDefinitionResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *FormDefinitionResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *FormDefinitionResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *FormDefinitionResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *FormDefinitionResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *FormDefinitionResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionSelfImportExportDto.md b/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionSelfImportExportDto.md new file mode 100644 index 000000000..b364c7133 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormDefinitionSelfImportExportDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-form-definition-self-import-export-dto +title: FormDefinitionSelfImportExportDto +pagination_label: FormDefinitionSelfImportExportDto +sidebar_label: FormDefinitionSelfImportExportDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDefinitionSelfImportExportDto', 'V2025FormDefinitionSelfImportExportDto'] +slug: /tools/sdk/go/v2025/models/form-definition-self-import-export-dto +tags: ['SDK', 'Software Development Kit', 'FormDefinitionSelfImportExportDto', 'V2025FormDefinitionSelfImportExportDto'] +--- + +# FormDefinitionSelfImportExportDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Imported/exported object's DTO type. | [optional] +**Id** | Pointer to **string** | Imported/exported object's ID. | [optional] +**Name** | Pointer to **string** | Imported/exported object's display name. | [optional] + +## Methods + +### NewFormDefinitionSelfImportExportDto + +`func NewFormDefinitionSelfImportExportDto() *FormDefinitionSelfImportExportDto` + +NewFormDefinitionSelfImportExportDto instantiates a new FormDefinitionSelfImportExportDto 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 + +### NewFormDefinitionSelfImportExportDtoWithDefaults + +`func NewFormDefinitionSelfImportExportDtoWithDefaults() *FormDefinitionSelfImportExportDto` + +NewFormDefinitionSelfImportExportDtoWithDefaults instantiates a new FormDefinitionSelfImportExportDto 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 + +### GetType + +`func (o *FormDefinitionSelfImportExportDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormDefinitionSelfImportExportDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormDefinitionSelfImportExportDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormDefinitionSelfImportExportDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *FormDefinitionSelfImportExportDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormDefinitionSelfImportExportDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormDefinitionSelfImportExportDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormDefinitionSelfImportExportDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FormDefinitionSelfImportExportDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormDefinitionSelfImportExportDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormDefinitionSelfImportExportDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormDefinitionSelfImportExportDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/FormDetails.md new file mode 100644 index 000000000..fac98eb41 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormDetails.md @@ -0,0 +1,234 @@ +--- +id: v2025-form-details +title: FormDetails +pagination_label: FormDetails +sidebar_label: FormDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDetails', 'V2025FormDetails'] +slug: /tools/sdk/go/v2025/models/form-details +tags: ['SDK', 'Software Development Kit', 'FormDetails', 'V2025FormDetails'] +--- + +# FormDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | ID of the form | [optional] +**Name** | Pointer to **NullableString** | Name of the form | [optional] +**Title** | Pointer to **NullableString** | The form title | [optional] +**Subtitle** | Pointer to **NullableString** | The form subtitle. | [optional] +**TargetUser** | Pointer to **string** | The name of the user that should be shown this form | [optional] +**Sections** | Pointer to [**[]SectionDetails**](section-details) | Sections of the form | [optional] + +## Methods + +### NewFormDetails + +`func NewFormDetails() *FormDetails` + +NewFormDetails instantiates a new FormDetails 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 + +### NewFormDetailsWithDefaults + +`func NewFormDetailsWithDefaults() *FormDetails` + +NewFormDetailsWithDefaults instantiates a new FormDetails 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 + +### GetId + +`func (o *FormDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *FormDetails) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *FormDetails) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *FormDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *FormDetails) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *FormDetails) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetTitle + +`func (o *FormDetails) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *FormDetails) GetTitleOk() (*string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTitle + +`func (o *FormDetails) SetTitle(v string)` + +SetTitle sets Title field to given value. + +### HasTitle + +`func (o *FormDetails) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### SetTitleNil + +`func (o *FormDetails) SetTitleNil(b bool)` + + SetTitleNil sets the value for Title to be an explicit nil + +### UnsetTitle +`func (o *FormDetails) UnsetTitle()` + +UnsetTitle ensures that no value is present for Title, not even an explicit nil +### GetSubtitle + +`func (o *FormDetails) GetSubtitle() string` + +GetSubtitle returns the Subtitle field if non-nil, zero value otherwise. + +### GetSubtitleOk + +`func (o *FormDetails) GetSubtitleOk() (*string, bool)` + +GetSubtitleOk returns a tuple with the Subtitle field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubtitle + +`func (o *FormDetails) SetSubtitle(v string)` + +SetSubtitle sets Subtitle field to given value. + +### HasSubtitle + +`func (o *FormDetails) HasSubtitle() bool` + +HasSubtitle returns a boolean if a field has been set. + +### SetSubtitleNil + +`func (o *FormDetails) SetSubtitleNil(b bool)` + + SetSubtitleNil sets the value for Subtitle to be an explicit nil + +### UnsetSubtitle +`func (o *FormDetails) UnsetSubtitle()` + +UnsetSubtitle ensures that no value is present for Subtitle, not even an explicit nil +### GetTargetUser + +`func (o *FormDetails) GetTargetUser() string` + +GetTargetUser returns the TargetUser field if non-nil, zero value otherwise. + +### GetTargetUserOk + +`func (o *FormDetails) GetTargetUserOk() (*string, bool)` + +GetTargetUserOk returns a tuple with the TargetUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetUser + +`func (o *FormDetails) SetTargetUser(v string)` + +SetTargetUser sets TargetUser field to given value. + +### HasTargetUser + +`func (o *FormDetails) HasTargetUser() bool` + +HasTargetUser returns a boolean if a field has been set. + +### GetSections + +`func (o *FormDetails) GetSections() []SectionDetails` + +GetSections returns the Sections field if non-nil, zero value otherwise. + +### GetSectionsOk + +`func (o *FormDetails) GetSectionsOk() (*[]SectionDetails, bool)` + +GetSectionsOk returns a tuple with the Sections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSections + +`func (o *FormDetails) SetSections(v []SectionDetails)` + +SetSections sets Sections field to given value. + +### HasSections + +`func (o *FormDetails) HasSections() bool` + +HasSections returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormElement.md b/docs/tools/sdk/go/Reference/V2025/Models/FormElement.md new file mode 100644 index 000000000..bf5a169a5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormElement.md @@ -0,0 +1,178 @@ +--- +id: v2025-form-element +title: FormElement +pagination_label: FormElement +sidebar_label: FormElement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElement', 'V2025FormElement'] +slug: /tools/sdk/go/v2025/models/form-element +tags: ['SDK', 'Software Development Kit', 'FormElement', 'V2025FormElement'] +--- + +# FormElement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Form element identifier. | [optional] +**ElementType** | Pointer to **string** | FormElementType value. TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMN_SET FormElementTypeColumns IMAGE FormElementTypeImage DESCRIPTION FormElementTypeDescription | [optional] +**Config** | Pointer to **map[string]interface{}** | Config object. | [optional] +**Key** | Pointer to **string** | Technical key. | [optional] +**Validations** | Pointer to [**[]FormElementValidationsSet**](form-element-validations-set) | | [optional] + +## Methods + +### NewFormElement + +`func NewFormElement() *FormElement` + +NewFormElement instantiates a new FormElement 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 + +### NewFormElementWithDefaults + +`func NewFormElementWithDefaults() *FormElement` + +NewFormElementWithDefaults instantiates a new FormElement 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 + +### GetId + +`func (o *FormElement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormElement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormElement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormElement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetElementType + +`func (o *FormElement) GetElementType() string` + +GetElementType returns the ElementType field if non-nil, zero value otherwise. + +### GetElementTypeOk + +`func (o *FormElement) GetElementTypeOk() (*string, bool)` + +GetElementTypeOk returns a tuple with the ElementType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElementType + +`func (o *FormElement) SetElementType(v string)` + +SetElementType sets ElementType field to given value. + +### HasElementType + +`func (o *FormElement) HasElementType() bool` + +HasElementType returns a boolean if a field has been set. + +### GetConfig + +`func (o *FormElement) GetConfig() map[string]interface{}` + +GetConfig returns the Config field if non-nil, zero value otherwise. + +### GetConfigOk + +`func (o *FormElement) GetConfigOk() (*map[string]interface{}, bool)` + +GetConfigOk returns a tuple with the Config field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfig + +`func (o *FormElement) SetConfig(v map[string]interface{})` + +SetConfig sets Config field to given value. + +### HasConfig + +`func (o *FormElement) HasConfig() bool` + +HasConfig returns a boolean if a field has been set. + +### GetKey + +`func (o *FormElement) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *FormElement) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *FormElement) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *FormElement) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetValidations + +`func (o *FormElement) GetValidations() []FormElementValidationsSet` + +GetValidations returns the Validations field if non-nil, zero value otherwise. + +### GetValidationsOk + +`func (o *FormElement) GetValidationsOk() (*[]FormElementValidationsSet, bool)` + +GetValidationsOk returns a tuple with the Validations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValidations + +`func (o *FormElement) SetValidations(v []FormElementValidationsSet)` + +SetValidations sets Validations field to given value. + +### HasValidations + +`func (o *FormElement) HasValidations() bool` + +HasValidations returns a boolean if a field has been set. + +### SetValidationsNil + +`func (o *FormElement) SetValidationsNil(b bool)` + + SetValidationsNil sets the value for Validations to be an explicit nil + +### UnsetValidations +`func (o *FormElement) UnsetValidations()` + +UnsetValidations ensures that no value is present for Validations, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormElementDataSourceConfigOptions.md b/docs/tools/sdk/go/Reference/V2025/Models/FormElementDataSourceConfigOptions.md new file mode 100644 index 000000000..30f26e410 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormElementDataSourceConfigOptions.md @@ -0,0 +1,116 @@ +--- +id: v2025-form-element-data-source-config-options +title: FormElementDataSourceConfigOptions +pagination_label: FormElementDataSourceConfigOptions +sidebar_label: FormElementDataSourceConfigOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElementDataSourceConfigOptions', 'V2025FormElementDataSourceConfigOptions'] +slug: /tools/sdk/go/v2025/models/form-element-data-source-config-options +tags: ['SDK', 'Software Development Kit', 'FormElementDataSourceConfigOptions', 'V2025FormElementDataSourceConfigOptions'] +--- + +# FormElementDataSourceConfigOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Label** | Pointer to **string** | Label is the main label to display to the user when selecting this option | [optional] +**SubLabel** | Pointer to **string** | SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option | [optional] +**Value** | Pointer to **string** | Value is the value to save as an entry when the user selects this option | [optional] + +## Methods + +### NewFormElementDataSourceConfigOptions + +`func NewFormElementDataSourceConfigOptions() *FormElementDataSourceConfigOptions` + +NewFormElementDataSourceConfigOptions instantiates a new FormElementDataSourceConfigOptions 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 + +### NewFormElementDataSourceConfigOptionsWithDefaults + +`func NewFormElementDataSourceConfigOptionsWithDefaults() *FormElementDataSourceConfigOptions` + +NewFormElementDataSourceConfigOptionsWithDefaults instantiates a new FormElementDataSourceConfigOptions 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 + +### GetLabel + +`func (o *FormElementDataSourceConfigOptions) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *FormElementDataSourceConfigOptions) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *FormElementDataSourceConfigOptions) SetLabel(v string)` + +SetLabel sets Label field to given value. + +### HasLabel + +`func (o *FormElementDataSourceConfigOptions) HasLabel() bool` + +HasLabel returns a boolean if a field has been set. + +### GetSubLabel + +`func (o *FormElementDataSourceConfigOptions) GetSubLabel() string` + +GetSubLabel returns the SubLabel field if non-nil, zero value otherwise. + +### GetSubLabelOk + +`func (o *FormElementDataSourceConfigOptions) GetSubLabelOk() (*string, bool)` + +GetSubLabelOk returns a tuple with the SubLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubLabel + +`func (o *FormElementDataSourceConfigOptions) SetSubLabel(v string)` + +SetSubLabel sets SubLabel field to given value. + +### HasSubLabel + +`func (o *FormElementDataSourceConfigOptions) HasSubLabel() bool` + +HasSubLabel returns a boolean if a field has been set. + +### GetValue + +`func (o *FormElementDataSourceConfigOptions) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *FormElementDataSourceConfigOptions) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *FormElementDataSourceConfigOptions) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *FormElementDataSourceConfigOptions) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormElementDynamicDataSource.md b/docs/tools/sdk/go/Reference/V2025/Models/FormElementDynamicDataSource.md new file mode 100644 index 000000000..eec61f475 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormElementDynamicDataSource.md @@ -0,0 +1,90 @@ +--- +id: v2025-form-element-dynamic-data-source +title: FormElementDynamicDataSource +pagination_label: FormElementDynamicDataSource +sidebar_label: FormElementDynamicDataSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElementDynamicDataSource', 'V2025FormElementDynamicDataSource'] +slug: /tools/sdk/go/v2025/models/form-element-dynamic-data-source +tags: ['SDK', 'Software Development Kit', 'FormElementDynamicDataSource', 'V2025FormElementDynamicDataSource'] +--- + +# FormElementDynamicDataSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Config** | Pointer to [**FormElementDynamicDataSourceConfig**](form-element-dynamic-data-source-config) | | [optional] +**DataSourceType** | Pointer to **string** | DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch FORM_INPUT FormElementDataSourceTypeFormInput | [optional] + +## Methods + +### NewFormElementDynamicDataSource + +`func NewFormElementDynamicDataSource() *FormElementDynamicDataSource` + +NewFormElementDynamicDataSource instantiates a new FormElementDynamicDataSource 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 + +### NewFormElementDynamicDataSourceWithDefaults + +`func NewFormElementDynamicDataSourceWithDefaults() *FormElementDynamicDataSource` + +NewFormElementDynamicDataSourceWithDefaults instantiates a new FormElementDynamicDataSource 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 + +### GetConfig + +`func (o *FormElementDynamicDataSource) GetConfig() FormElementDynamicDataSourceConfig` + +GetConfig returns the Config field if non-nil, zero value otherwise. + +### GetConfigOk + +`func (o *FormElementDynamicDataSource) GetConfigOk() (*FormElementDynamicDataSourceConfig, bool)` + +GetConfigOk returns a tuple with the Config field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfig + +`func (o *FormElementDynamicDataSource) SetConfig(v FormElementDynamicDataSourceConfig)` + +SetConfig sets Config field to given value. + +### HasConfig + +`func (o *FormElementDynamicDataSource) HasConfig() bool` + +HasConfig returns a boolean if a field has been set. + +### GetDataSourceType + +`func (o *FormElementDynamicDataSource) GetDataSourceType() string` + +GetDataSourceType returns the DataSourceType field if non-nil, zero value otherwise. + +### GetDataSourceTypeOk + +`func (o *FormElementDynamicDataSource) GetDataSourceTypeOk() (*string, bool)` + +GetDataSourceTypeOk returns a tuple with the DataSourceType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataSourceType + +`func (o *FormElementDynamicDataSource) SetDataSourceType(v string)` + +SetDataSourceType sets DataSourceType field to given value. + +### HasDataSourceType + +`func (o *FormElementDynamicDataSource) HasDataSourceType() bool` + +HasDataSourceType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormElementDynamicDataSourceConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/FormElementDynamicDataSourceConfig.md new file mode 100644 index 000000000..911c253a0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormElementDynamicDataSourceConfig.md @@ -0,0 +1,142 @@ +--- +id: v2025-form-element-dynamic-data-source-config +title: FormElementDynamicDataSourceConfig +pagination_label: FormElementDynamicDataSourceConfig +sidebar_label: FormElementDynamicDataSourceConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElementDynamicDataSourceConfig', 'V2025FormElementDynamicDataSourceConfig'] +slug: /tools/sdk/go/v2025/models/form-element-dynamic-data-source-config +tags: ['SDK', 'Software Development Kit', 'FormElementDynamicDataSourceConfig', 'V2025FormElementDynamicDataSourceConfig'] +--- + +# FormElementDynamicDataSourceConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AggregationBucketField** | Pointer to **string** | AggregationBucketField is the aggregation bucket field name | [optional] +**Indices** | Pointer to **[]string** | Indices is a list of indices to use | [optional] +**ObjectType** | Pointer to **string** | ObjectType is a PreDefinedSelectOption value IDENTITY PreDefinedSelectOptionIdentity ACCESS_PROFILE PreDefinedSelectOptionAccessProfile SOURCES PreDefinedSelectOptionSources ROLE PreDefinedSelectOptionRole ENTITLEMENT PreDefinedSelectOptionEntitlement | [optional] +**Query** | Pointer to **string** | Query is a text | [optional] + +## Methods + +### NewFormElementDynamicDataSourceConfig + +`func NewFormElementDynamicDataSourceConfig() *FormElementDynamicDataSourceConfig` + +NewFormElementDynamicDataSourceConfig instantiates a new FormElementDynamicDataSourceConfig 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 + +### NewFormElementDynamicDataSourceConfigWithDefaults + +`func NewFormElementDynamicDataSourceConfigWithDefaults() *FormElementDynamicDataSourceConfig` + +NewFormElementDynamicDataSourceConfigWithDefaults instantiates a new FormElementDynamicDataSourceConfig 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 + +### GetAggregationBucketField + +`func (o *FormElementDynamicDataSourceConfig) GetAggregationBucketField() string` + +GetAggregationBucketField returns the AggregationBucketField field if non-nil, zero value otherwise. + +### GetAggregationBucketFieldOk + +`func (o *FormElementDynamicDataSourceConfig) GetAggregationBucketFieldOk() (*string, bool)` + +GetAggregationBucketFieldOk returns a tuple with the AggregationBucketField field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationBucketField + +`func (o *FormElementDynamicDataSourceConfig) SetAggregationBucketField(v string)` + +SetAggregationBucketField sets AggregationBucketField field to given value. + +### HasAggregationBucketField + +`func (o *FormElementDynamicDataSourceConfig) HasAggregationBucketField() bool` + +HasAggregationBucketField returns a boolean if a field has been set. + +### GetIndices + +`func (o *FormElementDynamicDataSourceConfig) GetIndices() []string` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *FormElementDynamicDataSourceConfig) GetIndicesOk() (*[]string, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *FormElementDynamicDataSourceConfig) SetIndices(v []string)` + +SetIndices sets Indices field to given value. + +### HasIndices + +`func (o *FormElementDynamicDataSourceConfig) HasIndices() bool` + +HasIndices returns a boolean if a field has been set. + +### GetObjectType + +`func (o *FormElementDynamicDataSourceConfig) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *FormElementDynamicDataSourceConfig) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *FormElementDynamicDataSourceConfig) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + +### HasObjectType + +`func (o *FormElementDynamicDataSourceConfig) HasObjectType() bool` + +HasObjectType returns a boolean if a field has been set. + +### GetQuery + +`func (o *FormElementDynamicDataSourceConfig) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *FormElementDynamicDataSourceConfig) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *FormElementDynamicDataSourceConfig) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *FormElementDynamicDataSourceConfig) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormElementPreviewRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/FormElementPreviewRequest.md new file mode 100644 index 000000000..d24399734 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormElementPreviewRequest.md @@ -0,0 +1,64 @@ +--- +id: v2025-form-element-preview-request +title: FormElementPreviewRequest +pagination_label: FormElementPreviewRequest +sidebar_label: FormElementPreviewRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElementPreviewRequest', 'V2025FormElementPreviewRequest'] +slug: /tools/sdk/go/v2025/models/form-element-preview-request +tags: ['SDK', 'Software Development Kit', 'FormElementPreviewRequest', 'V2025FormElementPreviewRequest'] +--- + +# FormElementPreviewRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DataSource** | Pointer to [**FormElementDynamicDataSource**](form-element-dynamic-data-source) | | [optional] + +## Methods + +### NewFormElementPreviewRequest + +`func NewFormElementPreviewRequest() *FormElementPreviewRequest` + +NewFormElementPreviewRequest instantiates a new FormElementPreviewRequest 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 + +### NewFormElementPreviewRequestWithDefaults + +`func NewFormElementPreviewRequestWithDefaults() *FormElementPreviewRequest` + +NewFormElementPreviewRequestWithDefaults instantiates a new FormElementPreviewRequest 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 + +### GetDataSource + +`func (o *FormElementPreviewRequest) GetDataSource() FormElementDynamicDataSource` + +GetDataSource returns the DataSource field if non-nil, zero value otherwise. + +### GetDataSourceOk + +`func (o *FormElementPreviewRequest) GetDataSourceOk() (*FormElementDynamicDataSource, bool)` + +GetDataSourceOk returns a tuple with the DataSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataSource + +`func (o *FormElementPreviewRequest) SetDataSource(v FormElementDynamicDataSource)` + +SetDataSource sets DataSource field to given value. + +### HasDataSource + +`func (o *FormElementPreviewRequest) HasDataSource() bool` + +HasDataSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormElementValidationsSet.md b/docs/tools/sdk/go/Reference/V2025/Models/FormElementValidationsSet.md new file mode 100644 index 000000000..d7559b306 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormElementValidationsSet.md @@ -0,0 +1,64 @@ +--- +id: v2025-form-element-validations-set +title: FormElementValidationsSet +pagination_label: FormElementValidationsSet +sidebar_label: FormElementValidationsSet +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormElementValidationsSet', 'V2025FormElementValidationsSet'] +slug: /tools/sdk/go/v2025/models/form-element-validations-set +tags: ['SDK', 'Software Development Kit', 'FormElementValidationsSet', 'V2025FormElementValidationsSet'] +--- + +# FormElementValidationsSet + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ValidationType** | Pointer to **string** | The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. | [optional] + +## Methods + +### NewFormElementValidationsSet + +`func NewFormElementValidationsSet() *FormElementValidationsSet` + +NewFormElementValidationsSet instantiates a new FormElementValidationsSet 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 + +### NewFormElementValidationsSetWithDefaults + +`func NewFormElementValidationsSetWithDefaults() *FormElementValidationsSet` + +NewFormElementValidationsSetWithDefaults instantiates a new FormElementValidationsSet 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 + +### GetValidationType + +`func (o *FormElementValidationsSet) GetValidationType() string` + +GetValidationType returns the ValidationType field if non-nil, zero value otherwise. + +### GetValidationTypeOk + +`func (o *FormElementValidationsSet) GetValidationTypeOk() (*string, bool)` + +GetValidationTypeOk returns a tuple with the ValidationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValidationType + +`func (o *FormElementValidationsSet) SetValidationType(v string)` + +SetValidationType sets ValidationType field to given value. + +### HasValidationType + +`func (o *FormElementValidationsSet) HasValidationType() bool` + +HasValidationType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormError.md b/docs/tools/sdk/go/Reference/V2025/Models/FormError.md new file mode 100644 index 000000000..4f0807aef --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormError.md @@ -0,0 +1,116 @@ +--- +id: v2025-form-error +title: FormError +pagination_label: FormError +sidebar_label: FormError +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormError', 'V2025FormError'] +slug: /tools/sdk/go/v2025/models/form-error +tags: ['SDK', 'Software Development Kit', 'FormError', 'V2025FormError'] +--- + +# FormError + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | Key is the technical key | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | Messages is a list of web.ErrorMessage items | [optional] +**Value** | Pointer to **map[string]interface{}** | Value is the value associated with a Key | [optional] + +## Methods + +### NewFormError + +`func NewFormError() *FormError` + +NewFormError instantiates a new FormError 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 + +### NewFormErrorWithDefaults + +`func NewFormErrorWithDefaults() *FormError` + +NewFormErrorWithDefaults instantiates a new FormError 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 + +### GetKey + +`func (o *FormError) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *FormError) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *FormError) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *FormError) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetMessages + +`func (o *FormError) GetMessages() []ErrorMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *FormError) GetMessagesOk() (*[]ErrorMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *FormError) SetMessages(v []ErrorMessage)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *FormError) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetValue + +`func (o *FormError) GetValue() map[string]interface{}` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *FormError) GetValueOk() (*map[string]interface{}, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *FormError) SetValue(v map[string]interface{})` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *FormError) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormInstanceCreatedBy.md b/docs/tools/sdk/go/Reference/V2025/Models/FormInstanceCreatedBy.md new file mode 100644 index 000000000..909f57ce1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormInstanceCreatedBy.md @@ -0,0 +1,90 @@ +--- +id: v2025-form-instance-created-by +title: FormInstanceCreatedBy +pagination_label: FormInstanceCreatedBy +sidebar_label: FormInstanceCreatedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormInstanceCreatedBy', 'V2025FormInstanceCreatedBy'] +slug: /tools/sdk/go/v2025/models/form-instance-created-by +tags: ['SDK', 'Software Development Kit', 'FormInstanceCreatedBy', 'V2025FormInstanceCreatedBy'] +--- + +# FormInstanceCreatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID is a unique identifier | [optional] +**Type** | Pointer to **string** | Type is a form instance created by type enum value WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution SOURCE FormInstanceCreatedByTypeSource | [optional] + +## Methods + +### NewFormInstanceCreatedBy + +`func NewFormInstanceCreatedBy() *FormInstanceCreatedBy` + +NewFormInstanceCreatedBy instantiates a new FormInstanceCreatedBy 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 + +### NewFormInstanceCreatedByWithDefaults + +`func NewFormInstanceCreatedByWithDefaults() *FormInstanceCreatedBy` + +NewFormInstanceCreatedByWithDefaults instantiates a new FormInstanceCreatedBy 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 + +### GetId + +`func (o *FormInstanceCreatedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormInstanceCreatedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormInstanceCreatedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormInstanceCreatedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *FormInstanceCreatedBy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormInstanceCreatedBy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormInstanceCreatedBy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormInstanceCreatedBy) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormInstanceRecipient.md b/docs/tools/sdk/go/Reference/V2025/Models/FormInstanceRecipient.md new file mode 100644 index 000000000..32a09932d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormInstanceRecipient.md @@ -0,0 +1,90 @@ +--- +id: v2025-form-instance-recipient +title: FormInstanceRecipient +pagination_label: FormInstanceRecipient +sidebar_label: FormInstanceRecipient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormInstanceRecipient', 'V2025FormInstanceRecipient'] +slug: /tools/sdk/go/v2025/models/form-instance-recipient +tags: ['SDK', 'Software Development Kit', 'FormInstanceRecipient', 'V2025FormInstanceRecipient'] +--- + +# FormInstanceRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID is a unique identifier | [optional] +**Type** | Pointer to **string** | Type is a FormInstanceRecipientType value IDENTITY FormInstanceRecipientIdentity | [optional] + +## Methods + +### NewFormInstanceRecipient + +`func NewFormInstanceRecipient() *FormInstanceRecipient` + +NewFormInstanceRecipient instantiates a new FormInstanceRecipient 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 + +### NewFormInstanceRecipientWithDefaults + +`func NewFormInstanceRecipientWithDefaults() *FormInstanceRecipient` + +NewFormInstanceRecipientWithDefaults instantiates a new FormInstanceRecipient 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 + +### GetId + +`func (o *FormInstanceRecipient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormInstanceRecipient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormInstanceRecipient) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormInstanceRecipient) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *FormInstanceRecipient) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormInstanceRecipient) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormInstanceRecipient) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormInstanceRecipient) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormInstanceResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/FormInstanceResponse.md new file mode 100644 index 000000000..289c4f782 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormInstanceResponse.md @@ -0,0 +1,448 @@ +--- +id: v2025-form-instance-response +title: FormInstanceResponse +pagination_label: FormInstanceResponse +sidebar_label: FormInstanceResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormInstanceResponse', 'V2025FormInstanceResponse'] +slug: /tools/sdk/go/v2025/models/form-instance-response +tags: ['SDK', 'Software Development Kit', 'FormInstanceResponse', 'V2025FormInstanceResponse'] +--- + +# FormInstanceResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **SailPointTime** | Created is the date the form instance was assigned | [optional] +**CreatedBy** | Pointer to [**FormInstanceCreatedBy**](form-instance-created-by) | | [optional] +**Expire** | Pointer to **string** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [optional] +**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**FormData** | Pointer to **map[string]interface{}** | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] +**FormDefinitionId** | Pointer to **string** | FormDefinitionID is the id of the form definition that created this form | [optional] +**FormElements** | Pointer to [**[]FormElement**](form-element) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] +**FormErrors** | Pointer to [**[]FormError**](form-error) | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [optional] +**FormInput** | Pointer to **map[string]map[string]interface{}** | FormInput is an object of form input labels to value | [optional] +**Id** | Pointer to **string** | Unique guid identifying this form instance | [optional] +**Modified** | Pointer to **SailPointTime** | Modified is the last date the form instance was modified | [optional] +**Recipients** | Pointer to [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [optional] +**StandAloneForm** | Pointer to **bool** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to false] +**StandAloneFormUrl** | Pointer to **string** | StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI | [optional] +**State** | Pointer to **string** | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] + +## Methods + +### NewFormInstanceResponse + +`func NewFormInstanceResponse() *FormInstanceResponse` + +NewFormInstanceResponse instantiates a new FormInstanceResponse 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 + +### NewFormInstanceResponseWithDefaults + +`func NewFormInstanceResponseWithDefaults() *FormInstanceResponse` + +NewFormInstanceResponseWithDefaults instantiates a new FormInstanceResponse 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 + +### GetCreated + +`func (o *FormInstanceResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *FormInstanceResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *FormInstanceResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *FormInstanceResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetCreatedBy + +`func (o *FormInstanceResponse) GetCreatedBy() FormInstanceCreatedBy` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *FormInstanceResponse) GetCreatedByOk() (*FormInstanceCreatedBy, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *FormInstanceResponse) SetCreatedBy(v FormInstanceCreatedBy)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *FormInstanceResponse) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetExpire + +`func (o *FormInstanceResponse) GetExpire() string` + +GetExpire returns the Expire field if non-nil, zero value otherwise. + +### GetExpireOk + +`func (o *FormInstanceResponse) GetExpireOk() (*string, bool)` + +GetExpireOk returns a tuple with the Expire field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpire + +`func (o *FormInstanceResponse) SetExpire(v string)` + +SetExpire sets Expire field to given value. + +### HasExpire + +`func (o *FormInstanceResponse) HasExpire() bool` + +HasExpire returns a boolean if a field has been set. + +### GetFormConditions + +`func (o *FormInstanceResponse) GetFormConditions() []FormCondition` + +GetFormConditions returns the FormConditions field if non-nil, zero value otherwise. + +### GetFormConditionsOk + +`func (o *FormInstanceResponse) GetFormConditionsOk() (*[]FormCondition, bool)` + +GetFormConditionsOk returns a tuple with the FormConditions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormConditions + +`func (o *FormInstanceResponse) SetFormConditions(v []FormCondition)` + +SetFormConditions sets FormConditions field to given value. + +### HasFormConditions + +`func (o *FormInstanceResponse) HasFormConditions() bool` + +HasFormConditions returns a boolean if a field has been set. + +### GetFormData + +`func (o *FormInstanceResponse) GetFormData() map[string]interface{}` + +GetFormData returns the FormData field if non-nil, zero value otherwise. + +### GetFormDataOk + +`func (o *FormInstanceResponse) GetFormDataOk() (*map[string]interface{}, bool)` + +GetFormDataOk returns a tuple with the FormData field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormData + +`func (o *FormInstanceResponse) SetFormData(v map[string]interface{})` + +SetFormData sets FormData field to given value. + +### HasFormData + +`func (o *FormInstanceResponse) HasFormData() bool` + +HasFormData returns a boolean if a field has been set. + +### SetFormDataNil + +`func (o *FormInstanceResponse) SetFormDataNil(b bool)` + + SetFormDataNil sets the value for FormData to be an explicit nil + +### UnsetFormData +`func (o *FormInstanceResponse) UnsetFormData()` + +UnsetFormData ensures that no value is present for FormData, not even an explicit nil +### GetFormDefinitionId + +`func (o *FormInstanceResponse) GetFormDefinitionId() string` + +GetFormDefinitionId returns the FormDefinitionId field if non-nil, zero value otherwise. + +### GetFormDefinitionIdOk + +`func (o *FormInstanceResponse) GetFormDefinitionIdOk() (*string, bool)` + +GetFormDefinitionIdOk returns a tuple with the FormDefinitionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormDefinitionId + +`func (o *FormInstanceResponse) SetFormDefinitionId(v string)` + +SetFormDefinitionId sets FormDefinitionId field to given value. + +### HasFormDefinitionId + +`func (o *FormInstanceResponse) HasFormDefinitionId() bool` + +HasFormDefinitionId returns a boolean if a field has been set. + +### GetFormElements + +`func (o *FormInstanceResponse) GetFormElements() []FormElement` + +GetFormElements returns the FormElements field if non-nil, zero value otherwise. + +### GetFormElementsOk + +`func (o *FormInstanceResponse) GetFormElementsOk() (*[]FormElement, bool)` + +GetFormElementsOk returns a tuple with the FormElements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormElements + +`func (o *FormInstanceResponse) SetFormElements(v []FormElement)` + +SetFormElements sets FormElements field to given value. + +### HasFormElements + +`func (o *FormInstanceResponse) HasFormElements() bool` + +HasFormElements returns a boolean if a field has been set. + +### GetFormErrors + +`func (o *FormInstanceResponse) GetFormErrors() []FormError` + +GetFormErrors returns the FormErrors field if non-nil, zero value otherwise. + +### GetFormErrorsOk + +`func (o *FormInstanceResponse) GetFormErrorsOk() (*[]FormError, bool)` + +GetFormErrorsOk returns a tuple with the FormErrors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormErrors + +`func (o *FormInstanceResponse) SetFormErrors(v []FormError)` + +SetFormErrors sets FormErrors field to given value. + +### HasFormErrors + +`func (o *FormInstanceResponse) HasFormErrors() bool` + +HasFormErrors returns a boolean if a field has been set. + +### GetFormInput + +`func (o *FormInstanceResponse) GetFormInput() map[string]map[string]interface{}` + +GetFormInput returns the FormInput field if non-nil, zero value otherwise. + +### GetFormInputOk + +`func (o *FormInstanceResponse) GetFormInputOk() (*map[string]map[string]interface{}, bool)` + +GetFormInputOk returns a tuple with the FormInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormInput + +`func (o *FormInstanceResponse) SetFormInput(v map[string]map[string]interface{})` + +SetFormInput sets FormInput field to given value. + +### HasFormInput + +`func (o *FormInstanceResponse) HasFormInput() bool` + +HasFormInput returns a boolean if a field has been set. + +### SetFormInputNil + +`func (o *FormInstanceResponse) SetFormInputNil(b bool)` + + SetFormInputNil sets the value for FormInput to be an explicit nil + +### UnsetFormInput +`func (o *FormInstanceResponse) UnsetFormInput()` + +UnsetFormInput ensures that no value is present for FormInput, not even an explicit nil +### GetId + +`func (o *FormInstanceResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormInstanceResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormInstanceResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormInstanceResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetModified + +`func (o *FormInstanceResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *FormInstanceResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *FormInstanceResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *FormInstanceResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetRecipients + +`func (o *FormInstanceResponse) GetRecipients() []FormInstanceRecipient` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *FormInstanceResponse) GetRecipientsOk() (*[]FormInstanceRecipient, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *FormInstanceResponse) SetRecipients(v []FormInstanceRecipient)` + +SetRecipients sets Recipients field to given value. + +### HasRecipients + +`func (o *FormInstanceResponse) HasRecipients() bool` + +HasRecipients returns a boolean if a field has been set. + +### GetStandAloneForm + +`func (o *FormInstanceResponse) GetStandAloneForm() bool` + +GetStandAloneForm returns the StandAloneForm field if non-nil, zero value otherwise. + +### GetStandAloneFormOk + +`func (o *FormInstanceResponse) GetStandAloneFormOk() (*bool, bool)` + +GetStandAloneFormOk returns a tuple with the StandAloneForm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandAloneForm + +`func (o *FormInstanceResponse) SetStandAloneForm(v bool)` + +SetStandAloneForm sets StandAloneForm field to given value. + +### HasStandAloneForm + +`func (o *FormInstanceResponse) HasStandAloneForm() bool` + +HasStandAloneForm returns a boolean if a field has been set. + +### GetStandAloneFormUrl + +`func (o *FormInstanceResponse) GetStandAloneFormUrl() string` + +GetStandAloneFormUrl returns the StandAloneFormUrl field if non-nil, zero value otherwise. + +### GetStandAloneFormUrlOk + +`func (o *FormInstanceResponse) GetStandAloneFormUrlOk() (*string, bool)` + +GetStandAloneFormUrlOk returns a tuple with the StandAloneFormUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandAloneFormUrl + +`func (o *FormInstanceResponse) SetStandAloneFormUrl(v string)` + +SetStandAloneFormUrl sets StandAloneFormUrl field to given value. + +### HasStandAloneFormUrl + +`func (o *FormInstanceResponse) HasStandAloneFormUrl() bool` + +HasStandAloneFormUrl returns a boolean if a field has been set. + +### GetState + +`func (o *FormInstanceResponse) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *FormInstanceResponse) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *FormInstanceResponse) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *FormInstanceResponse) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormItemDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/FormItemDetails.md new file mode 100644 index 000000000..d61bfcbec --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormItemDetails.md @@ -0,0 +1,74 @@ +--- +id: v2025-form-item-details +title: FormItemDetails +pagination_label: FormItemDetails +sidebar_label: FormItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormItemDetails', 'V2025FormItemDetails'] +slug: /tools/sdk/go/v2025/models/form-item-details +tags: ['SDK', 'Software Development Kit', 'FormItemDetails', 'V2025FormItemDetails'] +--- + +# FormItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **NullableString** | Name of the FormItem | [optional] + +## Methods + +### NewFormItemDetails + +`func NewFormItemDetails() *FormItemDetails` + +NewFormItemDetails instantiates a new FormItemDetails 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 + +### NewFormItemDetailsWithDefaults + +`func NewFormItemDetailsWithDefaults() *FormItemDetails` + +NewFormItemDetailsWithDefaults instantiates a new FormItemDetails 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 + +### GetName + +`func (o *FormItemDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormItemDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormItemDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormItemDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *FormItemDetails) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *FormItemDetails) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/FormOwner.md new file mode 100644 index 000000000..0e881d1bd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormOwner.md @@ -0,0 +1,116 @@ +--- +id: v2025-form-owner +title: FormOwner +pagination_label: FormOwner +sidebar_label: FormOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormOwner', 'V2025FormOwner'] +slug: /tools/sdk/go/v2025/models/form-owner +tags: ['SDK', 'Software Development Kit', 'FormOwner', 'V2025FormOwner'] +--- + +# FormOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | FormOwnerType value. IDENTITY FormOwnerTypeIdentity | [optional] +**Id** | Pointer to **string** | Unique identifier of the form's owner. | [optional] +**Name** | Pointer to **string** | Name of the form's owner. | [optional] + +## Methods + +### NewFormOwner + +`func NewFormOwner() *FormOwner` + +NewFormOwner instantiates a new FormOwner 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 + +### NewFormOwnerWithDefaults + +`func NewFormOwnerWithDefaults() *FormOwner` + +NewFormOwnerWithDefaults instantiates a new FormOwner 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 + +### GetType + +`func (o *FormOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *FormOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FormOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FormUsedBy.md b/docs/tools/sdk/go/Reference/V2025/Models/FormUsedBy.md new file mode 100644 index 000000000..172336c11 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FormUsedBy.md @@ -0,0 +1,116 @@ +--- +id: v2025-form-used-by +title: FormUsedBy +pagination_label: FormUsedBy +sidebar_label: FormUsedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormUsedBy', 'V2025FormUsedBy'] +slug: /tools/sdk/go/v2025/models/form-used-by +tags: ['SDK', 'Software Development Kit', 'FormUsedBy', 'V2025FormUsedBy'] +--- + +# FormUsedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | FormUsedByType value. WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource MySailPoint FormUsedByType | [optional] +**Id** | Pointer to **string** | Unique identifier of the system using the form. | [optional] +**Name** | Pointer to **string** | Name of the system using the form. | [optional] + +## Methods + +### NewFormUsedBy + +`func NewFormUsedBy() *FormUsedBy` + +NewFormUsedBy instantiates a new FormUsedBy 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 + +### NewFormUsedByWithDefaults + +`func NewFormUsedByWithDefaults() *FormUsedBy` + +NewFormUsedByWithDefaults instantiates a new FormUsedBy 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 + +### GetType + +`func (o *FormUsedBy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FormUsedBy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FormUsedBy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FormUsedBy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *FormUsedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormUsedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormUsedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormUsedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FormUsedBy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormUsedBy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormUsedBy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormUsedBy) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ForwardApprovalDto.md b/docs/tools/sdk/go/Reference/V2025/Models/ForwardApprovalDto.md new file mode 100644 index 000000000..0ee135607 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ForwardApprovalDto.md @@ -0,0 +1,80 @@ +--- +id: v2025-forward-approval-dto +title: ForwardApprovalDto +pagination_label: ForwardApprovalDto +sidebar_label: ForwardApprovalDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ForwardApprovalDto', 'V2025ForwardApprovalDto'] +slug: /tools/sdk/go/v2025/models/forward-approval-dto +tags: ['SDK', 'Software Development Kit', 'ForwardApprovalDto', 'V2025ForwardApprovalDto'] +--- + +# ForwardApprovalDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewOwnerId** | **string** | The Id of the new owner | +**Comment** | **string** | The comment provided by the forwarder | + +## Methods + +### NewForwardApprovalDto + +`func NewForwardApprovalDto(newOwnerId string, comment string, ) *ForwardApprovalDto` + +NewForwardApprovalDto instantiates a new ForwardApprovalDto 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 + +### NewForwardApprovalDtoWithDefaults + +`func NewForwardApprovalDtoWithDefaults() *ForwardApprovalDto` + +NewForwardApprovalDtoWithDefaults instantiates a new ForwardApprovalDto 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 + +### GetNewOwnerId + +`func (o *ForwardApprovalDto) GetNewOwnerId() string` + +GetNewOwnerId returns the NewOwnerId field if non-nil, zero value otherwise. + +### GetNewOwnerIdOk + +`func (o *ForwardApprovalDto) GetNewOwnerIdOk() (*string, bool)` + +GetNewOwnerIdOk returns a tuple with the NewOwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewOwnerId + +`func (o *ForwardApprovalDto) SetNewOwnerId(v string)` + +SetNewOwnerId sets NewOwnerId field to given value. + + +### GetComment + +`func (o *ForwardApprovalDto) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ForwardApprovalDto) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ForwardApprovalDto) SetComment(v string)` + +SetComment sets Comment field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/FullDiscoveredApplications.md b/docs/tools/sdk/go/Reference/V2025/Models/FullDiscoveredApplications.md new file mode 100644 index 000000000..cf76d241f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/FullDiscoveredApplications.md @@ -0,0 +1,298 @@ +--- +id: v2025-full-discovered-applications +title: FullDiscoveredApplications +pagination_label: FullDiscoveredApplications +sidebar_label: FullDiscoveredApplications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FullDiscoveredApplications', 'V2025FullDiscoveredApplications'] +slug: /tools/sdk/go/v2025/models/full-discovered-applications +tags: ['SDK', 'Software Development Kit', 'FullDiscoveredApplications', 'V2025FullDiscoveredApplications'] +--- + +# FullDiscoveredApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **string** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **string** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **string** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **string** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]string** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **SailPointTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **string** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [optional] +**AssociatedSources** | Pointer to **[]string** | List of associated sources related to this discovered application. | [optional] + +## Methods + +### NewFullDiscoveredApplications + +`func NewFullDiscoveredApplications() *FullDiscoveredApplications` + +NewFullDiscoveredApplications instantiates a new FullDiscoveredApplications 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 + +### NewFullDiscoveredApplicationsWithDefaults + +`func NewFullDiscoveredApplicationsWithDefaults() *FullDiscoveredApplications` + +NewFullDiscoveredApplicationsWithDefaults instantiates a new FullDiscoveredApplications 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 + +### GetId + +`func (o *FullDiscoveredApplications) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FullDiscoveredApplications) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FullDiscoveredApplications) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FullDiscoveredApplications) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FullDiscoveredApplications) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FullDiscoveredApplications) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FullDiscoveredApplications) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FullDiscoveredApplications) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDiscoverySource + +`func (o *FullDiscoveredApplications) GetDiscoverySource() string` + +GetDiscoverySource returns the DiscoverySource field if non-nil, zero value otherwise. + +### GetDiscoverySourceOk + +`func (o *FullDiscoveredApplications) GetDiscoverySourceOk() (*string, bool)` + +GetDiscoverySourceOk returns a tuple with the DiscoverySource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoverySource + +`func (o *FullDiscoveredApplications) SetDiscoverySource(v string)` + +SetDiscoverySource sets DiscoverySource field to given value. + +### HasDiscoverySource + +`func (o *FullDiscoveredApplications) HasDiscoverySource() bool` + +HasDiscoverySource returns a boolean if a field has been set. + +### GetDiscoveredVendor + +`func (o *FullDiscoveredApplications) GetDiscoveredVendor() string` + +GetDiscoveredVendor returns the DiscoveredVendor field if non-nil, zero value otherwise. + +### GetDiscoveredVendorOk + +`func (o *FullDiscoveredApplications) GetDiscoveredVendorOk() (*string, bool)` + +GetDiscoveredVendorOk returns a tuple with the DiscoveredVendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredVendor + +`func (o *FullDiscoveredApplications) SetDiscoveredVendor(v string)` + +SetDiscoveredVendor sets DiscoveredVendor field to given value. + +### HasDiscoveredVendor + +`func (o *FullDiscoveredApplications) HasDiscoveredVendor() bool` + +HasDiscoveredVendor returns a boolean if a field has been set. + +### GetDescription + +`func (o *FullDiscoveredApplications) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *FullDiscoveredApplications) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *FullDiscoveredApplications) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *FullDiscoveredApplications) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetRecommendedConnectors + +`func (o *FullDiscoveredApplications) GetRecommendedConnectors() []string` + +GetRecommendedConnectors returns the RecommendedConnectors field if non-nil, zero value otherwise. + +### GetRecommendedConnectorsOk + +`func (o *FullDiscoveredApplications) GetRecommendedConnectorsOk() (*[]string, bool)` + +GetRecommendedConnectorsOk returns a tuple with the RecommendedConnectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendedConnectors + +`func (o *FullDiscoveredApplications) SetRecommendedConnectors(v []string)` + +SetRecommendedConnectors sets RecommendedConnectors field to given value. + +### HasRecommendedConnectors + +`func (o *FullDiscoveredApplications) HasRecommendedConnectors() bool` + +HasRecommendedConnectors returns a boolean if a field has been set. + +### GetDiscoveredAt + +`func (o *FullDiscoveredApplications) GetDiscoveredAt() SailPointTime` + +GetDiscoveredAt returns the DiscoveredAt field if non-nil, zero value otherwise. + +### GetDiscoveredAtOk + +`func (o *FullDiscoveredApplications) GetDiscoveredAtOk() (*SailPointTime, bool)` + +GetDiscoveredAtOk returns a tuple with the DiscoveredAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredAt + +`func (o *FullDiscoveredApplications) SetDiscoveredAt(v SailPointTime)` + +SetDiscoveredAt sets DiscoveredAt field to given value. + +### HasDiscoveredAt + +`func (o *FullDiscoveredApplications) HasDiscoveredAt() bool` + +HasDiscoveredAt returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *FullDiscoveredApplications) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *FullDiscoveredApplications) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *FullDiscoveredApplications) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *FullDiscoveredApplications) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetStatus + +`func (o *FullDiscoveredApplications) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *FullDiscoveredApplications) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *FullDiscoveredApplications) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *FullDiscoveredApplications) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetAssociatedSources + +`func (o *FullDiscoveredApplications) GetAssociatedSources() []string` + +GetAssociatedSources returns the AssociatedSources field if non-nil, zero value otherwise. + +### GetAssociatedSourcesOk + +`func (o *FullDiscoveredApplications) GetAssociatedSourcesOk() (*[]string, bool)` + +GetAssociatedSourcesOk returns a tuple with the AssociatedSources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociatedSources + +`func (o *FullDiscoveredApplications) SetAssociatedSources(v []string)` + +SetAssociatedSources sets AssociatedSources field to given value. + +### HasAssociatedSources + +`func (o *FullDiscoveredApplications) HasAssociatedSources() bool` + +HasAssociatedSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/GetActiveCampaigns200ResponseInner.md b/docs/tools/sdk/go/Reference/V2025/Models/GetActiveCampaigns200ResponseInner.md new file mode 100644 index 000000000..0678a8c33 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/GetActiveCampaigns200ResponseInner.md @@ -0,0 +1,771 @@ +--- +id: v2025-get-active-campaigns200-response-inner +title: GetActiveCampaigns200ResponseInner +pagination_label: GetActiveCampaigns200ResponseInner +sidebar_label: GetActiveCampaigns200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetActiveCampaigns200ResponseInner', 'V2025GetActiveCampaigns200ResponseInner'] +slug: /tools/sdk/go/v2025/models/get-active-campaigns200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetActiveCampaigns200ResponseInner', 'V2025GetActiveCampaigns200ResponseInner'] +--- + +# GetActiveCampaigns200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | Id of the campaign | [optional] [readonly] +**Name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Description** | **NullableString** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Deadline** | Pointer to **NullableTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **string** | The type of campaign. Could be extended in the future. | +**EmailNotificationEnabled** | Pointer to **bool** | Enables email notification for this campaign | [optional] [default to false] +**AutoRevokeAllowed** | Pointer to **bool** | Allows auto revoke for this campaign | [optional] [default to false] +**RecommendationsEnabled** | Pointer to **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to false] +**Status** | Pointer to **NullableString** | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **NullableTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **NullableInt32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **NullableInt32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **NullableTime** | Modified time of the campaign | [optional] [readonly] +**Filter** | Pointer to [**NullableCampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **bool** | Determines if comments on sunset date changes are required. | [optional] [default to true] +**SourceOwnerCampaignInfo** | Pointer to [**NullableCampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**NullableCampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**NullableCampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**NullableCampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Methods + +### NewGetActiveCampaigns200ResponseInner + +`func NewGetActiveCampaigns200ResponseInner(name string, description NullableString, type_ string, ) *GetActiveCampaigns200ResponseInner` + +NewGetActiveCampaigns200ResponseInner instantiates a new GetActiveCampaigns200ResponseInner 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 + +### NewGetActiveCampaigns200ResponseInnerWithDefaults + +`func NewGetActiveCampaigns200ResponseInnerWithDefaults() *GetActiveCampaigns200ResponseInner` + +NewGetActiveCampaigns200ResponseInnerWithDefaults instantiates a new GetActiveCampaigns200ResponseInner 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 + +### GetId + +`func (o *GetActiveCampaigns200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetActiveCampaigns200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetActiveCampaigns200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetActiveCampaigns200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *GetActiveCampaigns200ResponseInner) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *GetActiveCampaigns200ResponseInner) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *GetActiveCampaigns200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetActiveCampaigns200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetActiveCampaigns200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *GetActiveCampaigns200ResponseInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *GetActiveCampaigns200ResponseInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *GetActiveCampaigns200ResponseInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *GetActiveCampaigns200ResponseInner) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *GetActiveCampaigns200ResponseInner) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetDeadline + +`func (o *GetActiveCampaigns200ResponseInner) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *GetActiveCampaigns200ResponseInner) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *GetActiveCampaigns200ResponseInner) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *GetActiveCampaigns200ResponseInner) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### SetDeadlineNil + +`func (o *GetActiveCampaigns200ResponseInner) SetDeadlineNil(b bool)` + + SetDeadlineNil sets the value for Deadline to be an explicit nil + +### UnsetDeadline +`func (o *GetActiveCampaigns200ResponseInner) UnsetDeadline()` + +UnsetDeadline ensures that no value is present for Deadline, not even an explicit nil +### GetType + +`func (o *GetActiveCampaigns200ResponseInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *GetActiveCampaigns200ResponseInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *GetActiveCampaigns200ResponseInner) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEmailNotificationEnabled + +`func (o *GetActiveCampaigns200ResponseInner) GetEmailNotificationEnabled() bool` + +GetEmailNotificationEnabled returns the EmailNotificationEnabled field if non-nil, zero value otherwise. + +### GetEmailNotificationEnabledOk + +`func (o *GetActiveCampaigns200ResponseInner) GetEmailNotificationEnabledOk() (*bool, bool)` + +GetEmailNotificationEnabledOk returns a tuple with the EmailNotificationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationEnabled + +`func (o *GetActiveCampaigns200ResponseInner) SetEmailNotificationEnabled(v bool)` + +SetEmailNotificationEnabled sets EmailNotificationEnabled field to given value. + +### HasEmailNotificationEnabled + +`func (o *GetActiveCampaigns200ResponseInner) HasEmailNotificationEnabled() bool` + +HasEmailNotificationEnabled returns a boolean if a field has been set. + +### GetAutoRevokeAllowed + +`func (o *GetActiveCampaigns200ResponseInner) GetAutoRevokeAllowed() bool` + +GetAutoRevokeAllowed returns the AutoRevokeAllowed field if non-nil, zero value otherwise. + +### GetAutoRevokeAllowedOk + +`func (o *GetActiveCampaigns200ResponseInner) GetAutoRevokeAllowedOk() (*bool, bool)` + +GetAutoRevokeAllowedOk returns a tuple with the AutoRevokeAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoRevokeAllowed + +`func (o *GetActiveCampaigns200ResponseInner) SetAutoRevokeAllowed(v bool)` + +SetAutoRevokeAllowed sets AutoRevokeAllowed field to given value. + +### HasAutoRevokeAllowed + +`func (o *GetActiveCampaigns200ResponseInner) HasAutoRevokeAllowed() bool` + +HasAutoRevokeAllowed returns a boolean if a field has been set. + +### GetRecommendationsEnabled + +`func (o *GetActiveCampaigns200ResponseInner) GetRecommendationsEnabled() bool` + +GetRecommendationsEnabled returns the RecommendationsEnabled field if non-nil, zero value otherwise. + +### GetRecommendationsEnabledOk + +`func (o *GetActiveCampaigns200ResponseInner) GetRecommendationsEnabledOk() (*bool, bool)` + +GetRecommendationsEnabledOk returns a tuple with the RecommendationsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendationsEnabled + +`func (o *GetActiveCampaigns200ResponseInner) SetRecommendationsEnabled(v bool)` + +SetRecommendationsEnabled sets RecommendationsEnabled field to given value. + +### HasRecommendationsEnabled + +`func (o *GetActiveCampaigns200ResponseInner) HasRecommendationsEnabled() bool` + +HasRecommendationsEnabled returns a boolean if a field has been set. + +### GetStatus + +`func (o *GetActiveCampaigns200ResponseInner) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GetActiveCampaigns200ResponseInner) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GetActiveCampaigns200ResponseInner) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GetActiveCampaigns200ResponseInner) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatusNil + +`func (o *GetActiveCampaigns200ResponseInner) SetStatusNil(b bool)` + + SetStatusNil sets the value for Status to be an explicit nil + +### UnsetStatus +`func (o *GetActiveCampaigns200ResponseInner) UnsetStatus()` + +UnsetStatus ensures that no value is present for Status, not even an explicit nil +### GetCorrelatedStatus + +`func (o *GetActiveCampaigns200ResponseInner) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *GetActiveCampaigns200ResponseInner) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *GetActiveCampaigns200ResponseInner) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + +### HasCorrelatedStatus + +`func (o *GetActiveCampaigns200ResponseInner) HasCorrelatedStatus() bool` + +HasCorrelatedStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *GetActiveCampaigns200ResponseInner) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GetActiveCampaigns200ResponseInner) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *GetActiveCampaigns200ResponseInner) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *GetActiveCampaigns200ResponseInner) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *GetActiveCampaigns200ResponseInner) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *GetActiveCampaigns200ResponseInner) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetTotalCertifications + +`func (o *GetActiveCampaigns200ResponseInner) GetTotalCertifications() int32` + +GetTotalCertifications returns the TotalCertifications field if non-nil, zero value otherwise. + +### GetTotalCertificationsOk + +`func (o *GetActiveCampaigns200ResponseInner) GetTotalCertificationsOk() (*int32, bool)` + +GetTotalCertificationsOk returns a tuple with the TotalCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCertifications + +`func (o *GetActiveCampaigns200ResponseInner) SetTotalCertifications(v int32)` + +SetTotalCertifications sets TotalCertifications field to given value. + +### HasTotalCertifications + +`func (o *GetActiveCampaigns200ResponseInner) HasTotalCertifications() bool` + +HasTotalCertifications returns a boolean if a field has been set. + +### SetTotalCertificationsNil + +`func (o *GetActiveCampaigns200ResponseInner) SetTotalCertificationsNil(b bool)` + + SetTotalCertificationsNil sets the value for TotalCertifications to be an explicit nil + +### UnsetTotalCertifications +`func (o *GetActiveCampaigns200ResponseInner) UnsetTotalCertifications()` + +UnsetTotalCertifications ensures that no value is present for TotalCertifications, not even an explicit nil +### GetCompletedCertifications + +`func (o *GetActiveCampaigns200ResponseInner) GetCompletedCertifications() int32` + +GetCompletedCertifications returns the CompletedCertifications field if non-nil, zero value otherwise. + +### GetCompletedCertificationsOk + +`func (o *GetActiveCampaigns200ResponseInner) GetCompletedCertificationsOk() (*int32, bool)` + +GetCompletedCertificationsOk returns a tuple with the CompletedCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedCertifications + +`func (o *GetActiveCampaigns200ResponseInner) SetCompletedCertifications(v int32)` + +SetCompletedCertifications sets CompletedCertifications field to given value. + +### HasCompletedCertifications + +`func (o *GetActiveCampaigns200ResponseInner) HasCompletedCertifications() bool` + +HasCompletedCertifications returns a boolean if a field has been set. + +### SetCompletedCertificationsNil + +`func (o *GetActiveCampaigns200ResponseInner) SetCompletedCertificationsNil(b bool)` + + SetCompletedCertificationsNil sets the value for CompletedCertifications to be an explicit nil + +### UnsetCompletedCertifications +`func (o *GetActiveCampaigns200ResponseInner) UnsetCompletedCertifications()` + +UnsetCompletedCertifications ensures that no value is present for CompletedCertifications, not even an explicit nil +### GetAlerts + +`func (o *GetActiveCampaigns200ResponseInner) GetAlerts() []CampaignAlert` + +GetAlerts returns the Alerts field if non-nil, zero value otherwise. + +### GetAlertsOk + +`func (o *GetActiveCampaigns200ResponseInner) GetAlertsOk() (*[]CampaignAlert, bool)` + +GetAlertsOk returns a tuple with the Alerts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlerts + +`func (o *GetActiveCampaigns200ResponseInner) SetAlerts(v []CampaignAlert)` + +SetAlerts sets Alerts field to given value. + +### HasAlerts + +`func (o *GetActiveCampaigns200ResponseInner) HasAlerts() bool` + +HasAlerts returns a boolean if a field has been set. + +### SetAlertsNil + +`func (o *GetActiveCampaigns200ResponseInner) SetAlertsNil(b bool)` + + SetAlertsNil sets the value for Alerts to be an explicit nil + +### UnsetAlerts +`func (o *GetActiveCampaigns200ResponseInner) UnsetAlerts()` + +UnsetAlerts ensures that no value is present for Alerts, not even an explicit nil +### GetModified + +`func (o *GetActiveCampaigns200ResponseInner) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *GetActiveCampaigns200ResponseInner) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *GetActiveCampaigns200ResponseInner) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *GetActiveCampaigns200ResponseInner) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *GetActiveCampaigns200ResponseInner) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *GetActiveCampaigns200ResponseInner) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetFilter + +`func (o *GetActiveCampaigns200ResponseInner) GetFilter() CampaignAllOfFilter` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *GetActiveCampaigns200ResponseInner) GetFilterOk() (*CampaignAllOfFilter, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *GetActiveCampaigns200ResponseInner) SetFilter(v CampaignAllOfFilter)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *GetActiveCampaigns200ResponseInner) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### SetFilterNil + +`func (o *GetActiveCampaigns200ResponseInner) SetFilterNil(b bool)` + + SetFilterNil sets the value for Filter to be an explicit nil + +### UnsetFilter +`func (o *GetActiveCampaigns200ResponseInner) UnsetFilter()` + +UnsetFilter ensures that no value is present for Filter, not even an explicit nil +### GetSunsetCommentsRequired + +`func (o *GetActiveCampaigns200ResponseInner) GetSunsetCommentsRequired() bool` + +GetSunsetCommentsRequired returns the SunsetCommentsRequired field if non-nil, zero value otherwise. + +### GetSunsetCommentsRequiredOk + +`func (o *GetActiveCampaigns200ResponseInner) GetSunsetCommentsRequiredOk() (*bool, bool)` + +GetSunsetCommentsRequiredOk returns a tuple with the SunsetCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSunsetCommentsRequired + +`func (o *GetActiveCampaigns200ResponseInner) SetSunsetCommentsRequired(v bool)` + +SetSunsetCommentsRequired sets SunsetCommentsRequired field to given value. + +### HasSunsetCommentsRequired + +`func (o *GetActiveCampaigns200ResponseInner) HasSunsetCommentsRequired() bool` + +HasSunsetCommentsRequired returns a boolean if a field has been set. + +### GetSourceOwnerCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) GetSourceOwnerCampaignInfo() CampaignAllOfSourceOwnerCampaignInfo` + +GetSourceOwnerCampaignInfo returns the SourceOwnerCampaignInfo field if non-nil, zero value otherwise. + +### GetSourceOwnerCampaignInfoOk + +`func (o *GetActiveCampaigns200ResponseInner) GetSourceOwnerCampaignInfoOk() (*CampaignAllOfSourceOwnerCampaignInfo, bool)` + +GetSourceOwnerCampaignInfoOk returns a tuple with the SourceOwnerCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceOwnerCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) SetSourceOwnerCampaignInfo(v CampaignAllOfSourceOwnerCampaignInfo)` + +SetSourceOwnerCampaignInfo sets SourceOwnerCampaignInfo field to given value. + +### HasSourceOwnerCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) HasSourceOwnerCampaignInfo() bool` + +HasSourceOwnerCampaignInfo returns a boolean if a field has been set. + +### SetSourceOwnerCampaignInfoNil + +`func (o *GetActiveCampaigns200ResponseInner) SetSourceOwnerCampaignInfoNil(b bool)` + + SetSourceOwnerCampaignInfoNil sets the value for SourceOwnerCampaignInfo to be an explicit nil + +### UnsetSourceOwnerCampaignInfo +`func (o *GetActiveCampaigns200ResponseInner) UnsetSourceOwnerCampaignInfo()` + +UnsetSourceOwnerCampaignInfo ensures that no value is present for SourceOwnerCampaignInfo, not even an explicit nil +### GetSearchCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) GetSearchCampaignInfo() CampaignAllOfSearchCampaignInfo` + +GetSearchCampaignInfo returns the SearchCampaignInfo field if non-nil, zero value otherwise. + +### GetSearchCampaignInfoOk + +`func (o *GetActiveCampaigns200ResponseInner) GetSearchCampaignInfoOk() (*CampaignAllOfSearchCampaignInfo, bool)` + +GetSearchCampaignInfoOk returns a tuple with the SearchCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) SetSearchCampaignInfo(v CampaignAllOfSearchCampaignInfo)` + +SetSearchCampaignInfo sets SearchCampaignInfo field to given value. + +### HasSearchCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) HasSearchCampaignInfo() bool` + +HasSearchCampaignInfo returns a boolean if a field has been set. + +### SetSearchCampaignInfoNil + +`func (o *GetActiveCampaigns200ResponseInner) SetSearchCampaignInfoNil(b bool)` + + SetSearchCampaignInfoNil sets the value for SearchCampaignInfo to be an explicit nil + +### UnsetSearchCampaignInfo +`func (o *GetActiveCampaigns200ResponseInner) UnsetSearchCampaignInfo()` + +UnsetSearchCampaignInfo ensures that no value is present for SearchCampaignInfo, not even an explicit nil +### GetRoleCompositionCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) GetRoleCompositionCampaignInfo() CampaignAllOfRoleCompositionCampaignInfo` + +GetRoleCompositionCampaignInfo returns the RoleCompositionCampaignInfo field if non-nil, zero value otherwise. + +### GetRoleCompositionCampaignInfoOk + +`func (o *GetActiveCampaigns200ResponseInner) GetRoleCompositionCampaignInfoOk() (*CampaignAllOfRoleCompositionCampaignInfo, bool)` + +GetRoleCompositionCampaignInfoOk returns a tuple with the RoleCompositionCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleCompositionCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) SetRoleCompositionCampaignInfo(v CampaignAllOfRoleCompositionCampaignInfo)` + +SetRoleCompositionCampaignInfo sets RoleCompositionCampaignInfo field to given value. + +### HasRoleCompositionCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) HasRoleCompositionCampaignInfo() bool` + +HasRoleCompositionCampaignInfo returns a boolean if a field has been set. + +### SetRoleCompositionCampaignInfoNil + +`func (o *GetActiveCampaigns200ResponseInner) SetRoleCompositionCampaignInfoNil(b bool)` + + SetRoleCompositionCampaignInfoNil sets the value for RoleCompositionCampaignInfo to be an explicit nil + +### UnsetRoleCompositionCampaignInfo +`func (o *GetActiveCampaigns200ResponseInner) UnsetRoleCompositionCampaignInfo()` + +UnsetRoleCompositionCampaignInfo ensures that no value is present for RoleCompositionCampaignInfo, not even an explicit nil +### GetMachineAccountCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) GetMachineAccountCampaignInfo() CampaignAllOfMachineAccountCampaignInfo` + +GetMachineAccountCampaignInfo returns the MachineAccountCampaignInfo field if non-nil, zero value otherwise. + +### GetMachineAccountCampaignInfoOk + +`func (o *GetActiveCampaigns200ResponseInner) GetMachineAccountCampaignInfoOk() (*CampaignAllOfMachineAccountCampaignInfo, bool)` + +GetMachineAccountCampaignInfoOk returns a tuple with the MachineAccountCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMachineAccountCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) SetMachineAccountCampaignInfo(v CampaignAllOfMachineAccountCampaignInfo)` + +SetMachineAccountCampaignInfo sets MachineAccountCampaignInfo field to given value. + +### HasMachineAccountCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) HasMachineAccountCampaignInfo() bool` + +HasMachineAccountCampaignInfo returns a boolean if a field has been set. + +### SetMachineAccountCampaignInfoNil + +`func (o *GetActiveCampaigns200ResponseInner) SetMachineAccountCampaignInfoNil(b bool)` + + SetMachineAccountCampaignInfoNil sets the value for MachineAccountCampaignInfo to be an explicit nil + +### UnsetMachineAccountCampaignInfo +`func (o *GetActiveCampaigns200ResponseInner) UnsetMachineAccountCampaignInfo()` + +UnsetMachineAccountCampaignInfo ensures that no value is present for MachineAccountCampaignInfo, not even an explicit nil +### GetSourcesWithOrphanEntitlements + +`func (o *GetActiveCampaigns200ResponseInner) GetSourcesWithOrphanEntitlements() []CampaignAllOfSourcesWithOrphanEntitlements` + +GetSourcesWithOrphanEntitlements returns the SourcesWithOrphanEntitlements field if non-nil, zero value otherwise. + +### GetSourcesWithOrphanEntitlementsOk + +`func (o *GetActiveCampaigns200ResponseInner) GetSourcesWithOrphanEntitlementsOk() (*[]CampaignAllOfSourcesWithOrphanEntitlements, bool)` + +GetSourcesWithOrphanEntitlementsOk returns a tuple with the SourcesWithOrphanEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourcesWithOrphanEntitlements + +`func (o *GetActiveCampaigns200ResponseInner) SetSourcesWithOrphanEntitlements(v []CampaignAllOfSourcesWithOrphanEntitlements)` + +SetSourcesWithOrphanEntitlements sets SourcesWithOrphanEntitlements field to given value. + +### HasSourcesWithOrphanEntitlements + +`func (o *GetActiveCampaigns200ResponseInner) HasSourcesWithOrphanEntitlements() bool` + +HasSourcesWithOrphanEntitlements returns a boolean if a field has been set. + +### SetSourcesWithOrphanEntitlementsNil + +`func (o *GetActiveCampaigns200ResponseInner) SetSourcesWithOrphanEntitlementsNil(b bool)` + + SetSourcesWithOrphanEntitlementsNil sets the value for SourcesWithOrphanEntitlements to be an explicit nil + +### UnsetSourcesWithOrphanEntitlements +`func (o *GetActiveCampaigns200ResponseInner) UnsetSourcesWithOrphanEntitlements()` + +UnsetSourcesWithOrphanEntitlements ensures that no value is present for SourcesWithOrphanEntitlements, not even an explicit nil +### GetMandatoryCommentRequirement + +`func (o *GetActiveCampaigns200ResponseInner) GetMandatoryCommentRequirement() string` + +GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise. + +### GetMandatoryCommentRequirementOk + +`func (o *GetActiveCampaigns200ResponseInner) GetMandatoryCommentRequirementOk() (*string, bool)` + +GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMandatoryCommentRequirement + +`func (o *GetActiveCampaigns200ResponseInner) SetMandatoryCommentRequirement(v string)` + +SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value. + +### HasMandatoryCommentRequirement + +`func (o *GetActiveCampaigns200ResponseInner) HasMandatoryCommentRequirement() bool` + +HasMandatoryCommentRequirement returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/GetCampaign200Response.md b/docs/tools/sdk/go/Reference/V2025/Models/GetCampaign200Response.md new file mode 100644 index 000000000..78868406f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/GetCampaign200Response.md @@ -0,0 +1,771 @@ +--- +id: v2025-get-campaign200-response +title: GetCampaign200Response +pagination_label: GetCampaign200Response +sidebar_label: GetCampaign200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetCampaign200Response', 'V2025GetCampaign200Response'] +slug: /tools/sdk/go/v2025/models/get-campaign200-response +tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'V2025GetCampaign200Response'] +--- + +# GetCampaign200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | Id of the campaign | [optional] [readonly] +**Name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Description** | **NullableString** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Deadline** | Pointer to **NullableTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **string** | The type of campaign. Could be extended in the future. | +**EmailNotificationEnabled** | Pointer to **bool** | Enables email notification for this campaign | [optional] [default to false] +**AutoRevokeAllowed** | Pointer to **bool** | Allows auto revoke for this campaign | [optional] [default to false] +**RecommendationsEnabled** | Pointer to **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to false] +**Status** | Pointer to **NullableString** | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **NullableTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **NullableInt32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **NullableInt32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **NullableTime** | Modified time of the campaign | [optional] [readonly] +**Filter** | Pointer to [**NullableCampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **bool** | Determines if comments on sunset date changes are required. | [optional] [default to true] +**SourceOwnerCampaignInfo** | Pointer to [**NullableCampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**NullableCampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**NullableCampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**NullableCampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Methods + +### NewGetCampaign200Response + +`func NewGetCampaign200Response(name string, description NullableString, type_ string, ) *GetCampaign200Response` + +NewGetCampaign200Response instantiates a new GetCampaign200Response 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 + +### NewGetCampaign200ResponseWithDefaults + +`func NewGetCampaign200ResponseWithDefaults() *GetCampaign200Response` + +NewGetCampaign200ResponseWithDefaults instantiates a new GetCampaign200Response 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 + +### GetId + +`func (o *GetCampaign200Response) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetCampaign200Response) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetCampaign200Response) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetCampaign200Response) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *GetCampaign200Response) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *GetCampaign200Response) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *GetCampaign200Response) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetCampaign200Response) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetCampaign200Response) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *GetCampaign200Response) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *GetCampaign200Response) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *GetCampaign200Response) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *GetCampaign200Response) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *GetCampaign200Response) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetDeadline + +`func (o *GetCampaign200Response) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *GetCampaign200Response) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *GetCampaign200Response) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *GetCampaign200Response) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### SetDeadlineNil + +`func (o *GetCampaign200Response) SetDeadlineNil(b bool)` + + SetDeadlineNil sets the value for Deadline to be an explicit nil + +### UnsetDeadline +`func (o *GetCampaign200Response) UnsetDeadline()` + +UnsetDeadline ensures that no value is present for Deadline, not even an explicit nil +### GetType + +`func (o *GetCampaign200Response) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *GetCampaign200Response) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *GetCampaign200Response) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEmailNotificationEnabled + +`func (o *GetCampaign200Response) GetEmailNotificationEnabled() bool` + +GetEmailNotificationEnabled returns the EmailNotificationEnabled field if non-nil, zero value otherwise. + +### GetEmailNotificationEnabledOk + +`func (o *GetCampaign200Response) GetEmailNotificationEnabledOk() (*bool, bool)` + +GetEmailNotificationEnabledOk returns a tuple with the EmailNotificationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationEnabled + +`func (o *GetCampaign200Response) SetEmailNotificationEnabled(v bool)` + +SetEmailNotificationEnabled sets EmailNotificationEnabled field to given value. + +### HasEmailNotificationEnabled + +`func (o *GetCampaign200Response) HasEmailNotificationEnabled() bool` + +HasEmailNotificationEnabled returns a boolean if a field has been set. + +### GetAutoRevokeAllowed + +`func (o *GetCampaign200Response) GetAutoRevokeAllowed() bool` + +GetAutoRevokeAllowed returns the AutoRevokeAllowed field if non-nil, zero value otherwise. + +### GetAutoRevokeAllowedOk + +`func (o *GetCampaign200Response) GetAutoRevokeAllowedOk() (*bool, bool)` + +GetAutoRevokeAllowedOk returns a tuple with the AutoRevokeAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoRevokeAllowed + +`func (o *GetCampaign200Response) SetAutoRevokeAllowed(v bool)` + +SetAutoRevokeAllowed sets AutoRevokeAllowed field to given value. + +### HasAutoRevokeAllowed + +`func (o *GetCampaign200Response) HasAutoRevokeAllowed() bool` + +HasAutoRevokeAllowed returns a boolean if a field has been set. + +### GetRecommendationsEnabled + +`func (o *GetCampaign200Response) GetRecommendationsEnabled() bool` + +GetRecommendationsEnabled returns the RecommendationsEnabled field if non-nil, zero value otherwise. + +### GetRecommendationsEnabledOk + +`func (o *GetCampaign200Response) GetRecommendationsEnabledOk() (*bool, bool)` + +GetRecommendationsEnabledOk returns a tuple with the RecommendationsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendationsEnabled + +`func (o *GetCampaign200Response) SetRecommendationsEnabled(v bool)` + +SetRecommendationsEnabled sets RecommendationsEnabled field to given value. + +### HasRecommendationsEnabled + +`func (o *GetCampaign200Response) HasRecommendationsEnabled() bool` + +HasRecommendationsEnabled returns a boolean if a field has been set. + +### GetStatus + +`func (o *GetCampaign200Response) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GetCampaign200Response) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GetCampaign200Response) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GetCampaign200Response) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatusNil + +`func (o *GetCampaign200Response) SetStatusNil(b bool)` + + SetStatusNil sets the value for Status to be an explicit nil + +### UnsetStatus +`func (o *GetCampaign200Response) UnsetStatus()` + +UnsetStatus ensures that no value is present for Status, not even an explicit nil +### GetCorrelatedStatus + +`func (o *GetCampaign200Response) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *GetCampaign200Response) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *GetCampaign200Response) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + +### HasCorrelatedStatus + +`func (o *GetCampaign200Response) HasCorrelatedStatus() bool` + +HasCorrelatedStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *GetCampaign200Response) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GetCampaign200Response) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *GetCampaign200Response) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *GetCampaign200Response) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *GetCampaign200Response) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *GetCampaign200Response) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetTotalCertifications + +`func (o *GetCampaign200Response) GetTotalCertifications() int32` + +GetTotalCertifications returns the TotalCertifications field if non-nil, zero value otherwise. + +### GetTotalCertificationsOk + +`func (o *GetCampaign200Response) GetTotalCertificationsOk() (*int32, bool)` + +GetTotalCertificationsOk returns a tuple with the TotalCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCertifications + +`func (o *GetCampaign200Response) SetTotalCertifications(v int32)` + +SetTotalCertifications sets TotalCertifications field to given value. + +### HasTotalCertifications + +`func (o *GetCampaign200Response) HasTotalCertifications() bool` + +HasTotalCertifications returns a boolean if a field has been set. + +### SetTotalCertificationsNil + +`func (o *GetCampaign200Response) SetTotalCertificationsNil(b bool)` + + SetTotalCertificationsNil sets the value for TotalCertifications to be an explicit nil + +### UnsetTotalCertifications +`func (o *GetCampaign200Response) UnsetTotalCertifications()` + +UnsetTotalCertifications ensures that no value is present for TotalCertifications, not even an explicit nil +### GetCompletedCertifications + +`func (o *GetCampaign200Response) GetCompletedCertifications() int32` + +GetCompletedCertifications returns the CompletedCertifications field if non-nil, zero value otherwise. + +### GetCompletedCertificationsOk + +`func (o *GetCampaign200Response) GetCompletedCertificationsOk() (*int32, bool)` + +GetCompletedCertificationsOk returns a tuple with the CompletedCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedCertifications + +`func (o *GetCampaign200Response) SetCompletedCertifications(v int32)` + +SetCompletedCertifications sets CompletedCertifications field to given value. + +### HasCompletedCertifications + +`func (o *GetCampaign200Response) HasCompletedCertifications() bool` + +HasCompletedCertifications returns a boolean if a field has been set. + +### SetCompletedCertificationsNil + +`func (o *GetCampaign200Response) SetCompletedCertificationsNil(b bool)` + + SetCompletedCertificationsNil sets the value for CompletedCertifications to be an explicit nil + +### UnsetCompletedCertifications +`func (o *GetCampaign200Response) UnsetCompletedCertifications()` + +UnsetCompletedCertifications ensures that no value is present for CompletedCertifications, not even an explicit nil +### GetAlerts + +`func (o *GetCampaign200Response) GetAlerts() []CampaignAlert` + +GetAlerts returns the Alerts field if non-nil, zero value otherwise. + +### GetAlertsOk + +`func (o *GetCampaign200Response) GetAlertsOk() (*[]CampaignAlert, bool)` + +GetAlertsOk returns a tuple with the Alerts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlerts + +`func (o *GetCampaign200Response) SetAlerts(v []CampaignAlert)` + +SetAlerts sets Alerts field to given value. + +### HasAlerts + +`func (o *GetCampaign200Response) HasAlerts() bool` + +HasAlerts returns a boolean if a field has been set. + +### SetAlertsNil + +`func (o *GetCampaign200Response) SetAlertsNil(b bool)` + + SetAlertsNil sets the value for Alerts to be an explicit nil + +### UnsetAlerts +`func (o *GetCampaign200Response) UnsetAlerts()` + +UnsetAlerts ensures that no value is present for Alerts, not even an explicit nil +### GetModified + +`func (o *GetCampaign200Response) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *GetCampaign200Response) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *GetCampaign200Response) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *GetCampaign200Response) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *GetCampaign200Response) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *GetCampaign200Response) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetFilter + +`func (o *GetCampaign200Response) GetFilter() CampaignAllOfFilter` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *GetCampaign200Response) GetFilterOk() (*CampaignAllOfFilter, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *GetCampaign200Response) SetFilter(v CampaignAllOfFilter)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *GetCampaign200Response) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### SetFilterNil + +`func (o *GetCampaign200Response) SetFilterNil(b bool)` + + SetFilterNil sets the value for Filter to be an explicit nil + +### UnsetFilter +`func (o *GetCampaign200Response) UnsetFilter()` + +UnsetFilter ensures that no value is present for Filter, not even an explicit nil +### GetSunsetCommentsRequired + +`func (o *GetCampaign200Response) GetSunsetCommentsRequired() bool` + +GetSunsetCommentsRequired returns the SunsetCommentsRequired field if non-nil, zero value otherwise. + +### GetSunsetCommentsRequiredOk + +`func (o *GetCampaign200Response) GetSunsetCommentsRequiredOk() (*bool, bool)` + +GetSunsetCommentsRequiredOk returns a tuple with the SunsetCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSunsetCommentsRequired + +`func (o *GetCampaign200Response) SetSunsetCommentsRequired(v bool)` + +SetSunsetCommentsRequired sets SunsetCommentsRequired field to given value. + +### HasSunsetCommentsRequired + +`func (o *GetCampaign200Response) HasSunsetCommentsRequired() bool` + +HasSunsetCommentsRequired returns a boolean if a field has been set. + +### GetSourceOwnerCampaignInfo + +`func (o *GetCampaign200Response) GetSourceOwnerCampaignInfo() CampaignAllOfSourceOwnerCampaignInfo` + +GetSourceOwnerCampaignInfo returns the SourceOwnerCampaignInfo field if non-nil, zero value otherwise. + +### GetSourceOwnerCampaignInfoOk + +`func (o *GetCampaign200Response) GetSourceOwnerCampaignInfoOk() (*CampaignAllOfSourceOwnerCampaignInfo, bool)` + +GetSourceOwnerCampaignInfoOk returns a tuple with the SourceOwnerCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceOwnerCampaignInfo + +`func (o *GetCampaign200Response) SetSourceOwnerCampaignInfo(v CampaignAllOfSourceOwnerCampaignInfo)` + +SetSourceOwnerCampaignInfo sets SourceOwnerCampaignInfo field to given value. + +### HasSourceOwnerCampaignInfo + +`func (o *GetCampaign200Response) HasSourceOwnerCampaignInfo() bool` + +HasSourceOwnerCampaignInfo returns a boolean if a field has been set. + +### SetSourceOwnerCampaignInfoNil + +`func (o *GetCampaign200Response) SetSourceOwnerCampaignInfoNil(b bool)` + + SetSourceOwnerCampaignInfoNil sets the value for SourceOwnerCampaignInfo to be an explicit nil + +### UnsetSourceOwnerCampaignInfo +`func (o *GetCampaign200Response) UnsetSourceOwnerCampaignInfo()` + +UnsetSourceOwnerCampaignInfo ensures that no value is present for SourceOwnerCampaignInfo, not even an explicit nil +### GetSearchCampaignInfo + +`func (o *GetCampaign200Response) GetSearchCampaignInfo() CampaignAllOfSearchCampaignInfo` + +GetSearchCampaignInfo returns the SearchCampaignInfo field if non-nil, zero value otherwise. + +### GetSearchCampaignInfoOk + +`func (o *GetCampaign200Response) GetSearchCampaignInfoOk() (*CampaignAllOfSearchCampaignInfo, bool)` + +GetSearchCampaignInfoOk returns a tuple with the SearchCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchCampaignInfo + +`func (o *GetCampaign200Response) SetSearchCampaignInfo(v CampaignAllOfSearchCampaignInfo)` + +SetSearchCampaignInfo sets SearchCampaignInfo field to given value. + +### HasSearchCampaignInfo + +`func (o *GetCampaign200Response) HasSearchCampaignInfo() bool` + +HasSearchCampaignInfo returns a boolean if a field has been set. + +### SetSearchCampaignInfoNil + +`func (o *GetCampaign200Response) SetSearchCampaignInfoNil(b bool)` + + SetSearchCampaignInfoNil sets the value for SearchCampaignInfo to be an explicit nil + +### UnsetSearchCampaignInfo +`func (o *GetCampaign200Response) UnsetSearchCampaignInfo()` + +UnsetSearchCampaignInfo ensures that no value is present for SearchCampaignInfo, not even an explicit nil +### GetRoleCompositionCampaignInfo + +`func (o *GetCampaign200Response) GetRoleCompositionCampaignInfo() CampaignAllOfRoleCompositionCampaignInfo` + +GetRoleCompositionCampaignInfo returns the RoleCompositionCampaignInfo field if non-nil, zero value otherwise. + +### GetRoleCompositionCampaignInfoOk + +`func (o *GetCampaign200Response) GetRoleCompositionCampaignInfoOk() (*CampaignAllOfRoleCompositionCampaignInfo, bool)` + +GetRoleCompositionCampaignInfoOk returns a tuple with the RoleCompositionCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleCompositionCampaignInfo + +`func (o *GetCampaign200Response) SetRoleCompositionCampaignInfo(v CampaignAllOfRoleCompositionCampaignInfo)` + +SetRoleCompositionCampaignInfo sets RoleCompositionCampaignInfo field to given value. + +### HasRoleCompositionCampaignInfo + +`func (o *GetCampaign200Response) HasRoleCompositionCampaignInfo() bool` + +HasRoleCompositionCampaignInfo returns a boolean if a field has been set. + +### SetRoleCompositionCampaignInfoNil + +`func (o *GetCampaign200Response) SetRoleCompositionCampaignInfoNil(b bool)` + + SetRoleCompositionCampaignInfoNil sets the value for RoleCompositionCampaignInfo to be an explicit nil + +### UnsetRoleCompositionCampaignInfo +`func (o *GetCampaign200Response) UnsetRoleCompositionCampaignInfo()` + +UnsetRoleCompositionCampaignInfo ensures that no value is present for RoleCompositionCampaignInfo, not even an explicit nil +### GetMachineAccountCampaignInfo + +`func (o *GetCampaign200Response) GetMachineAccountCampaignInfo() CampaignAllOfMachineAccountCampaignInfo` + +GetMachineAccountCampaignInfo returns the MachineAccountCampaignInfo field if non-nil, zero value otherwise. + +### GetMachineAccountCampaignInfoOk + +`func (o *GetCampaign200Response) GetMachineAccountCampaignInfoOk() (*CampaignAllOfMachineAccountCampaignInfo, bool)` + +GetMachineAccountCampaignInfoOk returns a tuple with the MachineAccountCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMachineAccountCampaignInfo + +`func (o *GetCampaign200Response) SetMachineAccountCampaignInfo(v CampaignAllOfMachineAccountCampaignInfo)` + +SetMachineAccountCampaignInfo sets MachineAccountCampaignInfo field to given value. + +### HasMachineAccountCampaignInfo + +`func (o *GetCampaign200Response) HasMachineAccountCampaignInfo() bool` + +HasMachineAccountCampaignInfo returns a boolean if a field has been set. + +### SetMachineAccountCampaignInfoNil + +`func (o *GetCampaign200Response) SetMachineAccountCampaignInfoNil(b bool)` + + SetMachineAccountCampaignInfoNil sets the value for MachineAccountCampaignInfo to be an explicit nil + +### UnsetMachineAccountCampaignInfo +`func (o *GetCampaign200Response) UnsetMachineAccountCampaignInfo()` + +UnsetMachineAccountCampaignInfo ensures that no value is present for MachineAccountCampaignInfo, not even an explicit nil +### GetSourcesWithOrphanEntitlements + +`func (o *GetCampaign200Response) GetSourcesWithOrphanEntitlements() []CampaignAllOfSourcesWithOrphanEntitlements` + +GetSourcesWithOrphanEntitlements returns the SourcesWithOrphanEntitlements field if non-nil, zero value otherwise. + +### GetSourcesWithOrphanEntitlementsOk + +`func (o *GetCampaign200Response) GetSourcesWithOrphanEntitlementsOk() (*[]CampaignAllOfSourcesWithOrphanEntitlements, bool)` + +GetSourcesWithOrphanEntitlementsOk returns a tuple with the SourcesWithOrphanEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourcesWithOrphanEntitlements + +`func (o *GetCampaign200Response) SetSourcesWithOrphanEntitlements(v []CampaignAllOfSourcesWithOrphanEntitlements)` + +SetSourcesWithOrphanEntitlements sets SourcesWithOrphanEntitlements field to given value. + +### HasSourcesWithOrphanEntitlements + +`func (o *GetCampaign200Response) HasSourcesWithOrphanEntitlements() bool` + +HasSourcesWithOrphanEntitlements returns a boolean if a field has been set. + +### SetSourcesWithOrphanEntitlementsNil + +`func (o *GetCampaign200Response) SetSourcesWithOrphanEntitlementsNil(b bool)` + + SetSourcesWithOrphanEntitlementsNil sets the value for SourcesWithOrphanEntitlements to be an explicit nil + +### UnsetSourcesWithOrphanEntitlements +`func (o *GetCampaign200Response) UnsetSourcesWithOrphanEntitlements()` + +UnsetSourcesWithOrphanEntitlements ensures that no value is present for SourcesWithOrphanEntitlements, not even an explicit nil +### GetMandatoryCommentRequirement + +`func (o *GetCampaign200Response) GetMandatoryCommentRequirement() string` + +GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise. + +### GetMandatoryCommentRequirementOk + +`func (o *GetCampaign200Response) GetMandatoryCommentRequirementOk() (*string, bool)` + +GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMandatoryCommentRequirement + +`func (o *GetCampaign200Response) SetMandatoryCommentRequirement(v string)` + +SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value. + +### HasMandatoryCommentRequirement + +`func (o *GetCampaign200Response) HasMandatoryCommentRequirement() bool` + +HasMandatoryCommentRequirement returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/GetDiscoveredApplications200ResponseInner.md b/docs/tools/sdk/go/Reference/V2025/Models/GetDiscoveredApplications200ResponseInner.md new file mode 100644 index 000000000..7cfb163af --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/GetDiscoveredApplications200ResponseInner.md @@ -0,0 +1,298 @@ +--- +id: v2025-get-discovered-applications200-response-inner +title: GetDiscoveredApplications200ResponseInner +pagination_label: GetDiscoveredApplications200ResponseInner +sidebar_label: GetDiscoveredApplications200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetDiscoveredApplications200ResponseInner', 'V2025GetDiscoveredApplications200ResponseInner'] +slug: /tools/sdk/go/v2025/models/get-discovered-applications200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetDiscoveredApplications200ResponseInner', 'V2025GetDiscoveredApplications200ResponseInner'] +--- + +# GetDiscoveredApplications200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **string** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **string** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **string** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **string** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]string** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **SailPointTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **string** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [optional] +**AssociatedSources** | Pointer to **[]string** | List of associated sources related to this discovered application. | [optional] + +## Methods + +### NewGetDiscoveredApplications200ResponseInner + +`func NewGetDiscoveredApplications200ResponseInner() *GetDiscoveredApplications200ResponseInner` + +NewGetDiscoveredApplications200ResponseInner instantiates a new GetDiscoveredApplications200ResponseInner 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 + +### NewGetDiscoveredApplications200ResponseInnerWithDefaults + +`func NewGetDiscoveredApplications200ResponseInnerWithDefaults() *GetDiscoveredApplications200ResponseInner` + +NewGetDiscoveredApplications200ResponseInnerWithDefaults instantiates a new GetDiscoveredApplications200ResponseInner 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 + +### GetId + +`func (o *GetDiscoveredApplications200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetDiscoveredApplications200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetDiscoveredApplications200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *GetDiscoveredApplications200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetDiscoveredApplications200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *GetDiscoveredApplications200ResponseInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDiscoverySource + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoverySource() string` + +GetDiscoverySource returns the DiscoverySource field if non-nil, zero value otherwise. + +### GetDiscoverySourceOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoverySourceOk() (*string, bool)` + +GetDiscoverySourceOk returns a tuple with the DiscoverySource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoverySource + +`func (o *GetDiscoveredApplications200ResponseInner) SetDiscoverySource(v string)` + +SetDiscoverySource sets DiscoverySource field to given value. + +### HasDiscoverySource + +`func (o *GetDiscoveredApplications200ResponseInner) HasDiscoverySource() bool` + +HasDiscoverySource returns a boolean if a field has been set. + +### GetDiscoveredVendor + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoveredVendor() string` + +GetDiscoveredVendor returns the DiscoveredVendor field if non-nil, zero value otherwise. + +### GetDiscoveredVendorOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoveredVendorOk() (*string, bool)` + +GetDiscoveredVendorOk returns a tuple with the DiscoveredVendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredVendor + +`func (o *GetDiscoveredApplications200ResponseInner) SetDiscoveredVendor(v string)` + +SetDiscoveredVendor sets DiscoveredVendor field to given value. + +### HasDiscoveredVendor + +`func (o *GetDiscoveredApplications200ResponseInner) HasDiscoveredVendor() bool` + +HasDiscoveredVendor returns a boolean if a field has been set. + +### GetDescription + +`func (o *GetDiscoveredApplications200ResponseInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *GetDiscoveredApplications200ResponseInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *GetDiscoveredApplications200ResponseInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetRecommendedConnectors + +`func (o *GetDiscoveredApplications200ResponseInner) GetRecommendedConnectors() []string` + +GetRecommendedConnectors returns the RecommendedConnectors field if non-nil, zero value otherwise. + +### GetRecommendedConnectorsOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetRecommendedConnectorsOk() (*[]string, bool)` + +GetRecommendedConnectorsOk returns a tuple with the RecommendedConnectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendedConnectors + +`func (o *GetDiscoveredApplications200ResponseInner) SetRecommendedConnectors(v []string)` + +SetRecommendedConnectors sets RecommendedConnectors field to given value. + +### HasRecommendedConnectors + +`func (o *GetDiscoveredApplications200ResponseInner) HasRecommendedConnectors() bool` + +HasRecommendedConnectors returns a boolean if a field has been set. + +### GetDiscoveredAt + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoveredAt() SailPointTime` + +GetDiscoveredAt returns the DiscoveredAt field if non-nil, zero value otherwise. + +### GetDiscoveredAtOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoveredAtOk() (*SailPointTime, bool)` + +GetDiscoveredAtOk returns a tuple with the DiscoveredAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredAt + +`func (o *GetDiscoveredApplications200ResponseInner) SetDiscoveredAt(v SailPointTime)` + +SetDiscoveredAt sets DiscoveredAt field to given value. + +### HasDiscoveredAt + +`func (o *GetDiscoveredApplications200ResponseInner) HasDiscoveredAt() bool` + +HasDiscoveredAt returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *GetDiscoveredApplications200ResponseInner) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *GetDiscoveredApplications200ResponseInner) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *GetDiscoveredApplications200ResponseInner) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetStatus + +`func (o *GetDiscoveredApplications200ResponseInner) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GetDiscoveredApplications200ResponseInner) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GetDiscoveredApplications200ResponseInner) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetAssociatedSources + +`func (o *GetDiscoveredApplications200ResponseInner) GetAssociatedSources() []string` + +GetAssociatedSources returns the AssociatedSources field if non-nil, zero value otherwise. + +### GetAssociatedSourcesOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetAssociatedSourcesOk() (*[]string, bool)` + +GetAssociatedSourcesOk returns a tuple with the AssociatedSources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociatedSources + +`func (o *GetDiscoveredApplications200ResponseInner) SetAssociatedSources(v []string)` + +SetAssociatedSources sets AssociatedSources field to given value. + +### HasAssociatedSources + +`func (o *GetDiscoveredApplications200ResponseInner) HasAssociatedSources() bool` + +HasAssociatedSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/GetHistoricalIdentityEvents200ResponseInner.md b/docs/tools/sdk/go/Reference/V2025/Models/GetHistoricalIdentityEvents200ResponseInner.md new file mode 100644 index 000000000..6e6b948e8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/GetHistoricalIdentityEvents200ResponseInner.md @@ -0,0 +1,428 @@ +--- +id: v2025-get-historical-identity-events200-response-inner +title: GetHistoricalIdentityEvents200ResponseInner +pagination_label: GetHistoricalIdentityEvents200ResponseInner +sidebar_label: GetHistoricalIdentityEvents200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetHistoricalIdentityEvents200ResponseInner', 'V2025GetHistoricalIdentityEvents200ResponseInner'] +slug: /tools/sdk/go/v2025/models/get-historical-identity-events200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetHistoricalIdentityEvents200ResponseInner', 'V2025GetHistoricalIdentityEvents200ResponseInner'] +--- + +# GetHistoricalIdentityEvents200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] +**IdentityId** | Pointer to **string** | the identity id | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] +**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] +**Changes** | Pointer to [**[]AttributeChange**](attribute-change) | | [optional] +**AccessRequest** | Pointer to [**AccessRequestResponse1**](access-request-response1) | | [optional] +**CertificationId** | Pointer to **string** | the id of the certification item | [optional] +**CertificationName** | Pointer to **string** | the certification item name | [optional] +**SignedDate** | Pointer to **string** | the date ceritification was signed | [optional] +**Certifiers** | Pointer to [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional] +**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional] +**Signer** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] +**Account** | Pointer to [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] +**StatusChange** | Pointer to [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional] + +## Methods + +### NewGetHistoricalIdentityEvents200ResponseInner + +`func NewGetHistoricalIdentityEvents200ResponseInner() *GetHistoricalIdentityEvents200ResponseInner` + +NewGetHistoricalIdentityEvents200ResponseInner instantiates a new GetHistoricalIdentityEvents200ResponseInner 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 + +### NewGetHistoricalIdentityEvents200ResponseInnerWithDefaults + +`func NewGetHistoricalIdentityEvents200ResponseInnerWithDefaults() *GetHistoricalIdentityEvents200ResponseInner` + +NewGetHistoricalIdentityEvents200ResponseInnerWithDefaults instantiates a new GetHistoricalIdentityEvents200ResponseInner 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 + +### GetAccessItem + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccessItem() AccessItemAssociatedAccessItem` + +GetAccessItem returns the AccessItem field if non-nil, zero value otherwise. + +### GetAccessItemOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccessItemOk() (*AccessItemAssociatedAccessItem, bool)` + +GetAccessItemOk returns a tuple with the AccessItem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItem + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetAccessItem(v AccessItemAssociatedAccessItem)` + +SetAccessItem sets AccessItem field to given value. + +### HasAccessItem + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasAccessItem() bool` + +HasAccessItem returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEventType + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDt + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasDt() bool` + +HasDt returns a boolean if a field has been set. + +### GetGovernanceEvent + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetGovernanceEvent() CorrelatedGovernanceEvent` + +GetGovernanceEvent returns the GovernanceEvent field if non-nil, zero value otherwise. + +### GetGovernanceEventOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetGovernanceEventOk() (*CorrelatedGovernanceEvent, bool)` + +GetGovernanceEventOk returns a tuple with the GovernanceEvent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceEvent + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetGovernanceEvent(v CorrelatedGovernanceEvent)` + +SetGovernanceEvent sets GovernanceEvent field to given value. + +### HasGovernanceEvent + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasGovernanceEvent() bool` + +HasGovernanceEvent returns a boolean if a field has been set. + +### GetChanges + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetChanges() []AttributeChange` + +GetChanges returns the Changes field if non-nil, zero value otherwise. + +### GetChangesOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetChangesOk() (*[]AttributeChange, bool)` + +GetChangesOk returns a tuple with the Changes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanges + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetChanges(v []AttributeChange)` + +SetChanges sets Changes field to given value. + +### HasChanges + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasChanges() bool` + +HasChanges returns a boolean if a field has been set. + +### GetAccessRequest + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccessRequest() AccessRequestResponse1` + +GetAccessRequest returns the AccessRequest field if non-nil, zero value otherwise. + +### GetAccessRequestOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccessRequestOk() (*AccessRequestResponse1, bool)` + +GetAccessRequestOk returns a tuple with the AccessRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequest + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetAccessRequest(v AccessRequestResponse1)` + +SetAccessRequest sets AccessRequest field to given value. + +### HasAccessRequest + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasAccessRequest() bool` + +HasAccessRequest returns a boolean if a field has been set. + +### GetCertificationId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertificationId() string` + +GetCertificationId returns the CertificationId field if non-nil, zero value otherwise. + +### GetCertificationIdOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertificationIdOk() (*string, bool)` + +GetCertificationIdOk returns a tuple with the CertificationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetCertificationId(v string)` + +SetCertificationId sets CertificationId field to given value. + +### HasCertificationId + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasCertificationId() bool` + +HasCertificationId returns a boolean if a field has been set. + +### GetCertificationName + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertificationName() string` + +GetCertificationName returns the CertificationName field if non-nil, zero value otherwise. + +### GetCertificationNameOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertificationNameOk() (*string, bool)` + +GetCertificationNameOk returns a tuple with the CertificationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationName + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetCertificationName(v string)` + +SetCertificationName sets CertificationName field to given value. + +### HasCertificationName + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasCertificationName() bool` + +HasCertificationName returns a boolean if a field has been set. + +### GetSignedDate + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetSignedDate() string` + +GetSignedDate returns the SignedDate field if non-nil, zero value otherwise. + +### GetSignedDateOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetSignedDateOk() (*string, bool)` + +GetSignedDateOk returns a tuple with the SignedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignedDate + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetSignedDate(v string)` + +SetSignedDate sets SignedDate field to given value. + +### HasSignedDate + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasSignedDate() bool` + +HasSignedDate returns a boolean if a field has been set. + +### GetCertifiers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertifiers() []CertifierResponse` + +GetCertifiers returns the Certifiers field if non-nil, zero value otherwise. + +### GetCertifiersOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetCertifiersOk() (*[]CertifierResponse, bool)` + +GetCertifiersOk returns a tuple with the Certifiers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertifiers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetCertifiers(v []CertifierResponse)` + +SetCertifiers sets Certifiers field to given value. + +### HasCertifiers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasCertifiers() bool` + +HasCertifiers returns a boolean if a field has been set. + +### GetReviewers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetReviewers() []CertifierResponse` + +GetReviewers returns the Reviewers field if non-nil, zero value otherwise. + +### GetReviewersOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetReviewersOk() (*[]CertifierResponse, bool)` + +GetReviewersOk returns a tuple with the Reviewers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetReviewers(v []CertifierResponse)` + +SetReviewers sets Reviewers field to given value. + +### HasReviewers + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasReviewers() bool` + +HasReviewers returns a boolean if a field has been set. + +### GetSigner + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetSigner() CertifierResponse` + +GetSigner returns the Signer field if non-nil, zero value otherwise. + +### GetSignerOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetSignerOk() (*CertifierResponse, bool)` + +GetSignerOk returns a tuple with the Signer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigner + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetSigner(v CertifierResponse)` + +SetSigner sets Signer field to given value. + +### HasSigner + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasSigner() bool` + +HasSigner returns a boolean if a field has been set. + +### GetAccount + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccount() AccountStatusChangedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetAccountOk() (*AccountStatusChangedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetAccount(v AccountStatusChangedAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### GetStatusChange + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetStatusChange() AccountStatusChangedStatusChange` + +GetStatusChange returns the StatusChange field if non-nil, zero value otherwise. + +### GetStatusChangeOk + +`func (o *GetHistoricalIdentityEvents200ResponseInner) GetStatusChangeOk() (*AccountStatusChangedStatusChange, bool)` + +GetStatusChangeOk returns a tuple with the StatusChange field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusChange + +`func (o *GetHistoricalIdentityEvents200ResponseInner) SetStatusChange(v AccountStatusChangedStatusChange)` + +SetStatusChange sets StatusChange field to given value. + +### HasStatusChange + +`func (o *GetHistoricalIdentityEvents200ResponseInner) HasStatusChange() bool` + +HasStatusChange returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/GetOAuthClientResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/GetOAuthClientResponse.md new file mode 100644 index 000000000..d8c33b26f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/GetOAuthClientResponse.md @@ -0,0 +1,574 @@ +--- +id: v2025-get-o-auth-client-response +title: GetOAuthClientResponse +pagination_label: GetOAuthClientResponse +sidebar_label: GetOAuthClientResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetOAuthClientResponse', 'V2025GetOAuthClientResponse'] +slug: /tools/sdk/go/v2025/models/get-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'GetOAuthClientResponse', 'V2025GetOAuthClientResponse'] +--- + +# GetOAuthClientResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the OAuth client | +**BusinessName** | **NullableString** | The name of the business the API Client should belong to | +**HomepageUrl** | **NullableString** | The homepage URL associated with the owner of the API Client | +**Name** | **string** | A human-readable name for the API Client | +**Description** | **NullableString** | A description of the API Client | +**AccessTokenValiditySeconds** | **int32** | The number of seconds an access token generated for this API Client is valid for | +**RefreshTokenValiditySeconds** | **int32** | The number of seconds a refresh token generated for this API Client is valid for | +**RedirectUris** | **[]string** | A list of the approved redirect URIs used with the authorization_code flow | +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | +**AccessType** | [**AccessType**](access-type) | | +**Type** | [**ClientType**](client-type) | | +**Internal** | **bool** | An indicator of whether the API Client can be used for requests internal to IDN | +**Enabled** | **bool** | An indicator of whether the API Client is enabled for use | +**StrongAuthSupported** | **bool** | An indicator of whether the API Client supports strong authentication | +**ClaimsSupported** | **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | +**Created** | **SailPointTime** | The date and time, down to the millisecond, when the API Client was created | +**Modified** | **SailPointTime** | The date and time, down to the millisecond, when the API Client was last updated | +**Secret** | Pointer to **NullableString** | | [optional] +**Metadata** | Pointer to **NullableString** | | [optional] +**LastUsed** | Pointer to **NullableTime** | The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. | [optional] +**Scope** | **[]string** | Scopes of the API Client. | + +## Methods + +### NewGetOAuthClientResponse + +`func NewGetOAuthClientResponse(id string, businessName NullableString, homepageUrl NullableString, name string, description NullableString, accessTokenValiditySeconds int32, refreshTokenValiditySeconds int32, redirectUris []string, grantTypes []GrantType, accessType AccessType, type_ ClientType, internal bool, enabled bool, strongAuthSupported bool, claimsSupported bool, created SailPointTime, modified SailPointTime, scope []string, ) *GetOAuthClientResponse` + +NewGetOAuthClientResponse instantiates a new GetOAuthClientResponse 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 + +### NewGetOAuthClientResponseWithDefaults + +`func NewGetOAuthClientResponseWithDefaults() *GetOAuthClientResponse` + +NewGetOAuthClientResponseWithDefaults instantiates a new GetOAuthClientResponse 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 + +### GetId + +`func (o *GetOAuthClientResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetOAuthClientResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetOAuthClientResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetBusinessName + +`func (o *GetOAuthClientResponse) GetBusinessName() string` + +GetBusinessName returns the BusinessName field if non-nil, zero value otherwise. + +### GetBusinessNameOk + +`func (o *GetOAuthClientResponse) GetBusinessNameOk() (*string, bool)` + +GetBusinessNameOk returns a tuple with the BusinessName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBusinessName + +`func (o *GetOAuthClientResponse) SetBusinessName(v string)` + +SetBusinessName sets BusinessName field to given value. + + +### SetBusinessNameNil + +`func (o *GetOAuthClientResponse) SetBusinessNameNil(b bool)` + + SetBusinessNameNil sets the value for BusinessName to be an explicit nil + +### UnsetBusinessName +`func (o *GetOAuthClientResponse) UnsetBusinessName()` + +UnsetBusinessName ensures that no value is present for BusinessName, not even an explicit nil +### GetHomepageUrl + +`func (o *GetOAuthClientResponse) GetHomepageUrl() string` + +GetHomepageUrl returns the HomepageUrl field if non-nil, zero value otherwise. + +### GetHomepageUrlOk + +`func (o *GetOAuthClientResponse) GetHomepageUrlOk() (*string, bool)` + +GetHomepageUrlOk returns a tuple with the HomepageUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHomepageUrl + +`func (o *GetOAuthClientResponse) SetHomepageUrl(v string)` + +SetHomepageUrl sets HomepageUrl field to given value. + + +### SetHomepageUrlNil + +`func (o *GetOAuthClientResponse) SetHomepageUrlNil(b bool)` + + SetHomepageUrlNil sets the value for HomepageUrl to be an explicit nil + +### UnsetHomepageUrl +`func (o *GetOAuthClientResponse) UnsetHomepageUrl()` + +UnsetHomepageUrl ensures that no value is present for HomepageUrl, not even an explicit nil +### GetName + +`func (o *GetOAuthClientResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetOAuthClientResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetOAuthClientResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *GetOAuthClientResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *GetOAuthClientResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *GetOAuthClientResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *GetOAuthClientResponse) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *GetOAuthClientResponse) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAccessTokenValiditySeconds + +`func (o *GetOAuthClientResponse) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *GetOAuthClientResponse) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *GetOAuthClientResponse) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + + +### GetRefreshTokenValiditySeconds + +`func (o *GetOAuthClientResponse) GetRefreshTokenValiditySeconds() int32` + +GetRefreshTokenValiditySeconds returns the RefreshTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetRefreshTokenValiditySecondsOk + +`func (o *GetOAuthClientResponse) GetRefreshTokenValiditySecondsOk() (*int32, bool)` + +GetRefreshTokenValiditySecondsOk returns a tuple with the RefreshTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenValiditySeconds + +`func (o *GetOAuthClientResponse) SetRefreshTokenValiditySeconds(v int32)` + +SetRefreshTokenValiditySeconds sets RefreshTokenValiditySeconds field to given value. + + +### GetRedirectUris + +`func (o *GetOAuthClientResponse) GetRedirectUris() []string` + +GetRedirectUris returns the RedirectUris field if non-nil, zero value otherwise. + +### GetRedirectUrisOk + +`func (o *GetOAuthClientResponse) GetRedirectUrisOk() (*[]string, bool)` + +GetRedirectUrisOk returns a tuple with the RedirectUris field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedirectUris + +`func (o *GetOAuthClientResponse) SetRedirectUris(v []string)` + +SetRedirectUris sets RedirectUris field to given value. + + +### SetRedirectUrisNil + +`func (o *GetOAuthClientResponse) SetRedirectUrisNil(b bool)` + + SetRedirectUrisNil sets the value for RedirectUris to be an explicit nil + +### UnsetRedirectUris +`func (o *GetOAuthClientResponse) UnsetRedirectUris()` + +UnsetRedirectUris ensures that no value is present for RedirectUris, not even an explicit nil +### GetGrantTypes + +`func (o *GetOAuthClientResponse) GetGrantTypes() []GrantType` + +GetGrantTypes returns the GrantTypes field if non-nil, zero value otherwise. + +### GetGrantTypesOk + +`func (o *GetOAuthClientResponse) GetGrantTypesOk() (*[]GrantType, bool)` + +GetGrantTypesOk returns a tuple with the GrantTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantTypes + +`func (o *GetOAuthClientResponse) SetGrantTypes(v []GrantType)` + +SetGrantTypes sets GrantTypes field to given value. + + +### GetAccessType + +`func (o *GetOAuthClientResponse) GetAccessType() AccessType` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *GetOAuthClientResponse) GetAccessTypeOk() (*AccessType, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *GetOAuthClientResponse) SetAccessType(v AccessType)` + +SetAccessType sets AccessType field to given value. + + +### GetType + +`func (o *GetOAuthClientResponse) GetType() ClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *GetOAuthClientResponse) GetTypeOk() (*ClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *GetOAuthClientResponse) SetType(v ClientType)` + +SetType sets Type field to given value. + + +### GetInternal + +`func (o *GetOAuthClientResponse) GetInternal() bool` + +GetInternal returns the Internal field if non-nil, zero value otherwise. + +### GetInternalOk + +`func (o *GetOAuthClientResponse) GetInternalOk() (*bool, bool)` + +GetInternalOk returns a tuple with the Internal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternal + +`func (o *GetOAuthClientResponse) SetInternal(v bool)` + +SetInternal sets Internal field to given value. + + +### GetEnabled + +`func (o *GetOAuthClientResponse) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *GetOAuthClientResponse) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *GetOAuthClientResponse) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetStrongAuthSupported + +`func (o *GetOAuthClientResponse) GetStrongAuthSupported() bool` + +GetStrongAuthSupported returns the StrongAuthSupported field if non-nil, zero value otherwise. + +### GetStrongAuthSupportedOk + +`func (o *GetOAuthClientResponse) GetStrongAuthSupportedOk() (*bool, bool)` + +GetStrongAuthSupportedOk returns a tuple with the StrongAuthSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStrongAuthSupported + +`func (o *GetOAuthClientResponse) SetStrongAuthSupported(v bool)` + +SetStrongAuthSupported sets StrongAuthSupported field to given value. + + +### GetClaimsSupported + +`func (o *GetOAuthClientResponse) GetClaimsSupported() bool` + +GetClaimsSupported returns the ClaimsSupported field if non-nil, zero value otherwise. + +### GetClaimsSupportedOk + +`func (o *GetOAuthClientResponse) GetClaimsSupportedOk() (*bool, bool)` + +GetClaimsSupportedOk returns a tuple with the ClaimsSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClaimsSupported + +`func (o *GetOAuthClientResponse) SetClaimsSupported(v bool)` + +SetClaimsSupported sets ClaimsSupported field to given value. + + +### GetCreated + +`func (o *GetOAuthClientResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GetOAuthClientResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *GetOAuthClientResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *GetOAuthClientResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *GetOAuthClientResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *GetOAuthClientResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetSecret + +`func (o *GetOAuthClientResponse) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *GetOAuthClientResponse) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *GetOAuthClientResponse) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *GetOAuthClientResponse) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### SetSecretNil + +`func (o *GetOAuthClientResponse) SetSecretNil(b bool)` + + SetSecretNil sets the value for Secret to be an explicit nil + +### UnsetSecret +`func (o *GetOAuthClientResponse) UnsetSecret()` + +UnsetSecret ensures that no value is present for Secret, not even an explicit nil +### GetMetadata + +`func (o *GetOAuthClientResponse) GetMetadata() string` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetOAuthClientResponse) GetMetadataOk() (*string, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetOAuthClientResponse) SetMetadata(v string)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetOAuthClientResponse) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### SetMetadataNil + +`func (o *GetOAuthClientResponse) SetMetadataNil(b bool)` + + SetMetadataNil sets the value for Metadata to be an explicit nil + +### UnsetMetadata +`func (o *GetOAuthClientResponse) UnsetMetadata()` + +UnsetMetadata ensures that no value is present for Metadata, not even an explicit nil +### GetLastUsed + +`func (o *GetOAuthClientResponse) GetLastUsed() SailPointTime` + +GetLastUsed returns the LastUsed field if non-nil, zero value otherwise. + +### GetLastUsedOk + +`func (o *GetOAuthClientResponse) GetLastUsedOk() (*SailPointTime, bool)` + +GetLastUsedOk returns a tuple with the LastUsed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUsed + +`func (o *GetOAuthClientResponse) SetLastUsed(v SailPointTime)` + +SetLastUsed sets LastUsed field to given value. + +### HasLastUsed + +`func (o *GetOAuthClientResponse) HasLastUsed() bool` + +HasLastUsed returns a boolean if a field has been set. + +### SetLastUsedNil + +`func (o *GetOAuthClientResponse) SetLastUsedNil(b bool)` + + SetLastUsedNil sets the value for LastUsed to be an explicit nil + +### UnsetLastUsed +`func (o *GetOAuthClientResponse) UnsetLastUsed()` + +UnsetLastUsed ensures that no value is present for LastUsed, not even an explicit nil +### GetScope + +`func (o *GetOAuthClientResponse) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *GetOAuthClientResponse) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *GetOAuthClientResponse) SetScope(v []string)` + +SetScope sets Scope field to given value. + + +### SetScopeNil + +`func (o *GetOAuthClientResponse) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *GetOAuthClientResponse) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/GetPersonalAccessTokenResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/GetPersonalAccessTokenResponse.md new file mode 100644 index 000000000..94bbb1919 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/GetPersonalAccessTokenResponse.md @@ -0,0 +1,215 @@ +--- +id: v2025-get-personal-access-token-response +title: GetPersonalAccessTokenResponse +pagination_label: GetPersonalAccessTokenResponse +sidebar_label: GetPersonalAccessTokenResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetPersonalAccessTokenResponse', 'V2025GetPersonalAccessTokenResponse'] +slug: /tools/sdk/go/v2025/models/get-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'GetPersonalAccessTokenResponse', 'V2025GetPersonalAccessTokenResponse'] +--- + +# GetPersonalAccessTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The ID of the personal access token (to be used as the username for Basic Auth). | +**Name** | **string** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | +**Scope** | **[]string** | Scopes of the personal access token. | +**Owner** | [**PatOwner**](pat-owner) | | +**Created** | **SailPointTime** | The date and time, down to the millisecond, when this personal access token was created. | +**LastUsed** | Pointer to **NullableTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional] +**Managed** | Pointer to **bool** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to false] + +## Methods + +### NewGetPersonalAccessTokenResponse + +`func NewGetPersonalAccessTokenResponse(id string, name string, scope []string, owner PatOwner, created SailPointTime, ) *GetPersonalAccessTokenResponse` + +NewGetPersonalAccessTokenResponse instantiates a new GetPersonalAccessTokenResponse 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 + +### NewGetPersonalAccessTokenResponseWithDefaults + +`func NewGetPersonalAccessTokenResponseWithDefaults() *GetPersonalAccessTokenResponse` + +NewGetPersonalAccessTokenResponseWithDefaults instantiates a new GetPersonalAccessTokenResponse 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 + +### GetId + +`func (o *GetPersonalAccessTokenResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetPersonalAccessTokenResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetPersonalAccessTokenResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *GetPersonalAccessTokenResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetPersonalAccessTokenResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetPersonalAccessTokenResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetScope + +`func (o *GetPersonalAccessTokenResponse) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *GetPersonalAccessTokenResponse) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *GetPersonalAccessTokenResponse) SetScope(v []string)` + +SetScope sets Scope field to given value. + + +### SetScopeNil + +`func (o *GetPersonalAccessTokenResponse) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *GetPersonalAccessTokenResponse) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil +### GetOwner + +`func (o *GetPersonalAccessTokenResponse) GetOwner() PatOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *GetPersonalAccessTokenResponse) GetOwnerOk() (*PatOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *GetPersonalAccessTokenResponse) SetOwner(v PatOwner)` + +SetOwner sets Owner field to given value. + + +### GetCreated + +`func (o *GetPersonalAccessTokenResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GetPersonalAccessTokenResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *GetPersonalAccessTokenResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetLastUsed + +`func (o *GetPersonalAccessTokenResponse) GetLastUsed() SailPointTime` + +GetLastUsed returns the LastUsed field if non-nil, zero value otherwise. + +### GetLastUsedOk + +`func (o *GetPersonalAccessTokenResponse) GetLastUsedOk() (*SailPointTime, bool)` + +GetLastUsedOk returns a tuple with the LastUsed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUsed + +`func (o *GetPersonalAccessTokenResponse) SetLastUsed(v SailPointTime)` + +SetLastUsed sets LastUsed field to given value. + +### HasLastUsed + +`func (o *GetPersonalAccessTokenResponse) HasLastUsed() bool` + +HasLastUsed returns a boolean if a field has been set. + +### SetLastUsedNil + +`func (o *GetPersonalAccessTokenResponse) SetLastUsedNil(b bool)` + + SetLastUsedNil sets the value for LastUsed to be an explicit nil + +### UnsetLastUsed +`func (o *GetPersonalAccessTokenResponse) UnsetLastUsed()` + +UnsetLastUsed ensures that no value is present for LastUsed, not even an explicit nil +### GetManaged + +`func (o *GetPersonalAccessTokenResponse) GetManaged() bool` + +GetManaged returns the Managed field if non-nil, zero value otherwise. + +### GetManagedOk + +`func (o *GetPersonalAccessTokenResponse) GetManagedOk() (*bool, bool)` + +GetManagedOk returns a tuple with the Managed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManaged + +`func (o *GetPersonalAccessTokenResponse) SetManaged(v bool)` + +SetManaged sets Managed field to given value. + +### HasManaged + +`func (o *GetPersonalAccessTokenResponse) HasManaged() bool` + +HasManaged returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/GetRoleAssignments200ResponseInner.md b/docs/tools/sdk/go/Reference/V2025/Models/GetRoleAssignments200ResponseInner.md new file mode 100644 index 000000000..73284b136 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/GetRoleAssignments200ResponseInner.md @@ -0,0 +1,292 @@ +--- +id: v2025-get-role-assignments200-response-inner +title: GetRoleAssignments200ResponseInner +pagination_label: GetRoleAssignments200ResponseInner +sidebar_label: GetRoleAssignments200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetRoleAssignments200ResponseInner', 'V2025GetRoleAssignments200ResponseInner'] +slug: /tools/sdk/go/v2025/models/get-role-assignments200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetRoleAssignments200ResponseInner', 'V2025GetRoleAssignments200ResponseInner'] +--- + +# GetRoleAssignments200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Assignment Id | [optional] +**Role** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] +**Comments** | Pointer to **NullableString** | Comments added by the user when the assignment was made | [optional] +**AssignmentSource** | Pointer to **string** | Source describing how this assignment was made | [optional] +**Assigner** | Pointer to [**RoleAssignmentDtoAssigner**](role-assignment-dto-assigner) | | [optional] +**AssignedDimensions** | Pointer to [**[]BaseReferenceDto**](base-reference-dto) | Dimensions assigned related to this role | [optional] +**AssignmentContext** | Pointer to [**RoleAssignmentDtoAssignmentContext**](role-assignment-dto-assignment-context) | | [optional] +**AccountTargets** | Pointer to [**[]RoleTargetDto**](role-target-dto) | | [optional] +**RemoveDate** | Pointer to **NullableString** | Date that the assignment will be removed | [optional] + +## Methods + +### NewGetRoleAssignments200ResponseInner + +`func NewGetRoleAssignments200ResponseInner() *GetRoleAssignments200ResponseInner` + +NewGetRoleAssignments200ResponseInner instantiates a new GetRoleAssignments200ResponseInner 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 + +### NewGetRoleAssignments200ResponseInnerWithDefaults + +`func NewGetRoleAssignments200ResponseInnerWithDefaults() *GetRoleAssignments200ResponseInner` + +NewGetRoleAssignments200ResponseInnerWithDefaults instantiates a new GetRoleAssignments200ResponseInner 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 + +### GetId + +`func (o *GetRoleAssignments200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetRoleAssignments200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetRoleAssignments200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetRoleAssignments200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRole + +`func (o *GetRoleAssignments200ResponseInner) GetRole() BaseReferenceDto` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *GetRoleAssignments200ResponseInner) GetRoleOk() (*BaseReferenceDto, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *GetRoleAssignments200ResponseInner) SetRole(v BaseReferenceDto)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *GetRoleAssignments200ResponseInner) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetComments + +`func (o *GetRoleAssignments200ResponseInner) GetComments() string` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *GetRoleAssignments200ResponseInner) GetCommentsOk() (*string, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *GetRoleAssignments200ResponseInner) SetComments(v string)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *GetRoleAssignments200ResponseInner) HasComments() bool` + +HasComments returns a boolean if a field has been set. + +### SetCommentsNil + +`func (o *GetRoleAssignments200ResponseInner) SetCommentsNil(b bool)` + + SetCommentsNil sets the value for Comments to be an explicit nil + +### UnsetComments +`func (o *GetRoleAssignments200ResponseInner) UnsetComments()` + +UnsetComments ensures that no value is present for Comments, not even an explicit nil +### GetAssignmentSource + +`func (o *GetRoleAssignments200ResponseInner) GetAssignmentSource() string` + +GetAssignmentSource returns the AssignmentSource field if non-nil, zero value otherwise. + +### GetAssignmentSourceOk + +`func (o *GetRoleAssignments200ResponseInner) GetAssignmentSourceOk() (*string, bool)` + +GetAssignmentSourceOk returns a tuple with the AssignmentSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentSource + +`func (o *GetRoleAssignments200ResponseInner) SetAssignmentSource(v string)` + +SetAssignmentSource sets AssignmentSource field to given value. + +### HasAssignmentSource + +`func (o *GetRoleAssignments200ResponseInner) HasAssignmentSource() bool` + +HasAssignmentSource returns a boolean if a field has been set. + +### GetAssigner + +`func (o *GetRoleAssignments200ResponseInner) GetAssigner() RoleAssignmentDtoAssigner` + +GetAssigner returns the Assigner field if non-nil, zero value otherwise. + +### GetAssignerOk + +`func (o *GetRoleAssignments200ResponseInner) GetAssignerOk() (*RoleAssignmentDtoAssigner, bool)` + +GetAssignerOk returns a tuple with the Assigner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssigner + +`func (o *GetRoleAssignments200ResponseInner) SetAssigner(v RoleAssignmentDtoAssigner)` + +SetAssigner sets Assigner field to given value. + +### HasAssigner + +`func (o *GetRoleAssignments200ResponseInner) HasAssigner() bool` + +HasAssigner returns a boolean if a field has been set. + +### GetAssignedDimensions + +`func (o *GetRoleAssignments200ResponseInner) GetAssignedDimensions() []BaseReferenceDto` + +GetAssignedDimensions returns the AssignedDimensions field if non-nil, zero value otherwise. + +### GetAssignedDimensionsOk + +`func (o *GetRoleAssignments200ResponseInner) GetAssignedDimensionsOk() (*[]BaseReferenceDto, bool)` + +GetAssignedDimensionsOk returns a tuple with the AssignedDimensions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignedDimensions + +`func (o *GetRoleAssignments200ResponseInner) SetAssignedDimensions(v []BaseReferenceDto)` + +SetAssignedDimensions sets AssignedDimensions field to given value. + +### HasAssignedDimensions + +`func (o *GetRoleAssignments200ResponseInner) HasAssignedDimensions() bool` + +HasAssignedDimensions returns a boolean if a field has been set. + +### GetAssignmentContext + +`func (o *GetRoleAssignments200ResponseInner) GetAssignmentContext() RoleAssignmentDtoAssignmentContext` + +GetAssignmentContext returns the AssignmentContext field if non-nil, zero value otherwise. + +### GetAssignmentContextOk + +`func (o *GetRoleAssignments200ResponseInner) GetAssignmentContextOk() (*RoleAssignmentDtoAssignmentContext, bool)` + +GetAssignmentContextOk returns a tuple with the AssignmentContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentContext + +`func (o *GetRoleAssignments200ResponseInner) SetAssignmentContext(v RoleAssignmentDtoAssignmentContext)` + +SetAssignmentContext sets AssignmentContext field to given value. + +### HasAssignmentContext + +`func (o *GetRoleAssignments200ResponseInner) HasAssignmentContext() bool` + +HasAssignmentContext returns a boolean if a field has been set. + +### GetAccountTargets + +`func (o *GetRoleAssignments200ResponseInner) GetAccountTargets() []RoleTargetDto` + +GetAccountTargets returns the AccountTargets field if non-nil, zero value otherwise. + +### GetAccountTargetsOk + +`func (o *GetRoleAssignments200ResponseInner) GetAccountTargetsOk() (*[]RoleTargetDto, bool)` + +GetAccountTargetsOk returns a tuple with the AccountTargets field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountTargets + +`func (o *GetRoleAssignments200ResponseInner) SetAccountTargets(v []RoleTargetDto)` + +SetAccountTargets sets AccountTargets field to given value. + +### HasAccountTargets + +`func (o *GetRoleAssignments200ResponseInner) HasAccountTargets() bool` + +HasAccountTargets returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *GetRoleAssignments200ResponseInner) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *GetRoleAssignments200ResponseInner) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *GetRoleAssignments200ResponseInner) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *GetRoleAssignments200ResponseInner) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *GetRoleAssignments200ResponseInner) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *GetRoleAssignments200ResponseInner) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/GetTenantContext200ResponseInner.md b/docs/tools/sdk/go/Reference/V2025/Models/GetTenantContext200ResponseInner.md new file mode 100644 index 000000000..ab430e2ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/GetTenantContext200ResponseInner.md @@ -0,0 +1,90 @@ +--- +id: v2025-get-tenant-context200-response-inner +title: GetTenantContext200ResponseInner +pagination_label: GetTenantContext200ResponseInner +sidebar_label: GetTenantContext200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetTenantContext200ResponseInner', 'V2025GetTenantContext200ResponseInner'] +slug: /tools/sdk/go/v2025/models/get-tenant-context200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetTenantContext200ResponseInner', 'V2025GetTenantContext200ResponseInner'] +--- + +# GetTenantContext200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | | [optional] +**Value** | Pointer to **string** | | [optional] + +## Methods + +### NewGetTenantContext200ResponseInner + +`func NewGetTenantContext200ResponseInner() *GetTenantContext200ResponseInner` + +NewGetTenantContext200ResponseInner instantiates a new GetTenantContext200ResponseInner 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 + +### NewGetTenantContext200ResponseInnerWithDefaults + +`func NewGetTenantContext200ResponseInnerWithDefaults() *GetTenantContext200ResponseInner` + +NewGetTenantContext200ResponseInnerWithDefaults instantiates a new GetTenantContext200ResponseInner 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 + +### GetKey + +`func (o *GetTenantContext200ResponseInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *GetTenantContext200ResponseInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *GetTenantContext200ResponseInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *GetTenantContext200ResponseInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetValue + +`func (o *GetTenantContext200ResponseInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *GetTenantContext200ResponseInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *GetTenantContext200ResponseInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *GetTenantContext200ResponseInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/GrantType.md b/docs/tools/sdk/go/Reference/V2025/Models/GrantType.md new file mode 100644 index 000000000..2072c50eb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/GrantType.md @@ -0,0 +1,23 @@ +--- +id: v2025-grant-type +title: GrantType +pagination_label: GrantType +sidebar_label: GrantType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GrantType', 'V2025GrantType'] +slug: /tools/sdk/go/v2025/models/grant-type +tags: ['SDK', 'Software Development Kit', 'GrantType', 'V2025GrantType'] +--- + +# GrantType + +## Enum + + +* `CLIENT_CREDENTIALS` (value: `"CLIENT_CREDENTIALS"`) + +* `AUTHORIZATION_CODE` (value: `"AUTHORIZATION_CODE"`) + +* `REFRESH_TOKEN` (value: `"REFRESH_TOKEN"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/HttpAuthenticationType.md b/docs/tools/sdk/go/Reference/V2025/Models/HttpAuthenticationType.md new file mode 100644 index 000000000..b73aa81f5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/HttpAuthenticationType.md @@ -0,0 +1,23 @@ +--- +id: v2025-http-authentication-type +title: HttpAuthenticationType +pagination_label: HttpAuthenticationType +sidebar_label: HttpAuthenticationType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'HttpAuthenticationType', 'V2025HttpAuthenticationType'] +slug: /tools/sdk/go/v2025/models/http-authentication-type +tags: ['SDK', 'Software Development Kit', 'HttpAuthenticationType', 'V2025HttpAuthenticationType'] +--- + +# HttpAuthenticationType + +## Enum + + +* `NO_AUTH` (value: `"NO_AUTH"`) + +* `BASIC_AUTH` (value: `"BASIC_AUTH"`) + +* `BEARER_TOKEN` (value: `"BEARER_TOKEN"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/HttpConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/HttpConfig.md new file mode 100644 index 000000000..97a3b2ae7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/HttpConfig.md @@ -0,0 +1,178 @@ +--- +id: v2025-http-config +title: HttpConfig +pagination_label: HttpConfig +sidebar_label: HttpConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'HttpConfig', 'V2025HttpConfig'] +slug: /tools/sdk/go/v2025/models/http-config +tags: ['SDK', 'Software Development Kit', 'HttpConfig', 'V2025HttpConfig'] +--- + +# HttpConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Url** | **string** | URL of the external/custom integration. | +**HttpDispatchMode** | [**HttpDispatchMode**](http-dispatch-mode) | | +**HttpAuthenticationType** | Pointer to [**HttpAuthenticationType**](http-authentication-type) | | [optional] [default to HTTPAUTHENTICATIONTYPE_NO_AUTH] +**BasicAuthConfig** | Pointer to [**NullableBasicAuthConfig**](basic-auth-config) | | [optional] +**BearerTokenAuthConfig** | Pointer to [**NullableBearerTokenAuthConfig**](bearer-token-auth-config) | | [optional] + +## Methods + +### NewHttpConfig + +`func NewHttpConfig(url string, httpDispatchMode HttpDispatchMode, ) *HttpConfig` + +NewHttpConfig instantiates a new HttpConfig 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 + +### NewHttpConfigWithDefaults + +`func NewHttpConfigWithDefaults() *HttpConfig` + +NewHttpConfigWithDefaults instantiates a new HttpConfig 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 + +### GetUrl + +`func (o *HttpConfig) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *HttpConfig) GetUrlOk() (*string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrl + +`func (o *HttpConfig) SetUrl(v string)` + +SetUrl sets Url field to given value. + + +### GetHttpDispatchMode + +`func (o *HttpConfig) GetHttpDispatchMode() HttpDispatchMode` + +GetHttpDispatchMode returns the HttpDispatchMode field if non-nil, zero value otherwise. + +### GetHttpDispatchModeOk + +`func (o *HttpConfig) GetHttpDispatchModeOk() (*HttpDispatchMode, bool)` + +GetHttpDispatchModeOk returns a tuple with the HttpDispatchMode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHttpDispatchMode + +`func (o *HttpConfig) SetHttpDispatchMode(v HttpDispatchMode)` + +SetHttpDispatchMode sets HttpDispatchMode field to given value. + + +### GetHttpAuthenticationType + +`func (o *HttpConfig) GetHttpAuthenticationType() HttpAuthenticationType` + +GetHttpAuthenticationType returns the HttpAuthenticationType field if non-nil, zero value otherwise. + +### GetHttpAuthenticationTypeOk + +`func (o *HttpConfig) GetHttpAuthenticationTypeOk() (*HttpAuthenticationType, bool)` + +GetHttpAuthenticationTypeOk returns a tuple with the HttpAuthenticationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHttpAuthenticationType + +`func (o *HttpConfig) SetHttpAuthenticationType(v HttpAuthenticationType)` + +SetHttpAuthenticationType sets HttpAuthenticationType field to given value. + +### HasHttpAuthenticationType + +`func (o *HttpConfig) HasHttpAuthenticationType() bool` + +HasHttpAuthenticationType returns a boolean if a field has been set. + +### GetBasicAuthConfig + +`func (o *HttpConfig) GetBasicAuthConfig() BasicAuthConfig` + +GetBasicAuthConfig returns the BasicAuthConfig field if non-nil, zero value otherwise. + +### GetBasicAuthConfigOk + +`func (o *HttpConfig) GetBasicAuthConfigOk() (*BasicAuthConfig, bool)` + +GetBasicAuthConfigOk returns a tuple with the BasicAuthConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBasicAuthConfig + +`func (o *HttpConfig) SetBasicAuthConfig(v BasicAuthConfig)` + +SetBasicAuthConfig sets BasicAuthConfig field to given value. + +### HasBasicAuthConfig + +`func (o *HttpConfig) HasBasicAuthConfig() bool` + +HasBasicAuthConfig returns a boolean if a field has been set. + +### SetBasicAuthConfigNil + +`func (o *HttpConfig) SetBasicAuthConfigNil(b bool)` + + SetBasicAuthConfigNil sets the value for BasicAuthConfig to be an explicit nil + +### UnsetBasicAuthConfig +`func (o *HttpConfig) UnsetBasicAuthConfig()` + +UnsetBasicAuthConfig ensures that no value is present for BasicAuthConfig, not even an explicit nil +### GetBearerTokenAuthConfig + +`func (o *HttpConfig) GetBearerTokenAuthConfig() BearerTokenAuthConfig` + +GetBearerTokenAuthConfig returns the BearerTokenAuthConfig field if non-nil, zero value otherwise. + +### GetBearerTokenAuthConfigOk + +`func (o *HttpConfig) GetBearerTokenAuthConfigOk() (*BearerTokenAuthConfig, bool)` + +GetBearerTokenAuthConfigOk returns a tuple with the BearerTokenAuthConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBearerTokenAuthConfig + +`func (o *HttpConfig) SetBearerTokenAuthConfig(v BearerTokenAuthConfig)` + +SetBearerTokenAuthConfig sets BearerTokenAuthConfig field to given value. + +### HasBearerTokenAuthConfig + +`func (o *HttpConfig) HasBearerTokenAuthConfig() bool` + +HasBearerTokenAuthConfig returns a boolean if a field has been set. + +### SetBearerTokenAuthConfigNil + +`func (o *HttpConfig) SetBearerTokenAuthConfigNil(b bool)` + + SetBearerTokenAuthConfigNil sets the value for BearerTokenAuthConfig to be an explicit nil + +### UnsetBearerTokenAuthConfig +`func (o *HttpConfig) UnsetBearerTokenAuthConfig()` + +UnsetBearerTokenAuthConfig ensures that no value is present for BearerTokenAuthConfig, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/HttpDispatchMode.md b/docs/tools/sdk/go/Reference/V2025/Models/HttpDispatchMode.md new file mode 100644 index 000000000..8096afbde --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/HttpDispatchMode.md @@ -0,0 +1,23 @@ +--- +id: v2025-http-dispatch-mode +title: HttpDispatchMode +pagination_label: HttpDispatchMode +sidebar_label: HttpDispatchMode +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'HttpDispatchMode', 'V2025HttpDispatchMode'] +slug: /tools/sdk/go/v2025/models/http-dispatch-mode +tags: ['SDK', 'Software Development Kit', 'HttpDispatchMode', 'V2025HttpDispatchMode'] +--- + +# HttpDispatchMode + +## Enum + + +* `SYNC` (value: `"SYNC"`) + +* `ASYNC` (value: `"ASYNC"`) + +* `DYNAMIC` (value: `"DYNAMIC"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentitiesAccountsBulkRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentitiesAccountsBulkRequest.md new file mode 100644 index 000000000..efa514647 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentitiesAccountsBulkRequest.md @@ -0,0 +1,64 @@ +--- +id: v2025-identities-accounts-bulk-request +title: IdentitiesAccountsBulkRequest +pagination_label: IdentitiesAccountsBulkRequest +sidebar_label: IdentitiesAccountsBulkRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitiesAccountsBulkRequest', 'V2025IdentitiesAccountsBulkRequest'] +slug: /tools/sdk/go/v2025/models/identities-accounts-bulk-request +tags: ['SDK', 'Software Development Kit', 'IdentitiesAccountsBulkRequest', 'V2025IdentitiesAccountsBulkRequest'] +--- + +# IdentitiesAccountsBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityIds** | Pointer to **[]string** | The ids of the identities for which enable/disable accounts. | [optional] + +## Methods + +### NewIdentitiesAccountsBulkRequest + +`func NewIdentitiesAccountsBulkRequest() *IdentitiesAccountsBulkRequest` + +NewIdentitiesAccountsBulkRequest instantiates a new IdentitiesAccountsBulkRequest 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 + +### NewIdentitiesAccountsBulkRequestWithDefaults + +`func NewIdentitiesAccountsBulkRequestWithDefaults() *IdentitiesAccountsBulkRequest` + +NewIdentitiesAccountsBulkRequestWithDefaults instantiates a new IdentitiesAccountsBulkRequest 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 + +### GetIdentityIds + +`func (o *IdentitiesAccountsBulkRequest) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *IdentitiesAccountsBulkRequest) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *IdentitiesAccountsBulkRequest) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *IdentitiesAccountsBulkRequest) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentitiesDetailsReportArguments.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentitiesDetailsReportArguments.md new file mode 100644 index 000000000..61008a642 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentitiesDetailsReportArguments.md @@ -0,0 +1,59 @@ +--- +id: v2025-identities-details-report-arguments +title: IdentitiesDetailsReportArguments +pagination_label: IdentitiesDetailsReportArguments +sidebar_label: IdentitiesDetailsReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitiesDetailsReportArguments', 'V2025IdentitiesDetailsReportArguments'] +slug: /tools/sdk/go/v2025/models/identities-details-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentitiesDetailsReportArguments', 'V2025IdentitiesDetailsReportArguments'] +--- + +# IdentitiesDetailsReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelatedOnly** | **bool** | Flag to specify if only correlated identities are included in report. | [default to false] + +## Methods + +### NewIdentitiesDetailsReportArguments + +`func NewIdentitiesDetailsReportArguments(correlatedOnly bool, ) *IdentitiesDetailsReportArguments` + +NewIdentitiesDetailsReportArguments instantiates a new IdentitiesDetailsReportArguments 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 + +### NewIdentitiesDetailsReportArgumentsWithDefaults + +`func NewIdentitiesDetailsReportArgumentsWithDefaults() *IdentitiesDetailsReportArguments` + +NewIdentitiesDetailsReportArgumentsWithDefaults instantiates a new IdentitiesDetailsReportArguments 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 + +### GetCorrelatedOnly + +`func (o *IdentitiesDetailsReportArguments) GetCorrelatedOnly() bool` + +GetCorrelatedOnly returns the CorrelatedOnly field if non-nil, zero value otherwise. + +### GetCorrelatedOnlyOk + +`func (o *IdentitiesDetailsReportArguments) GetCorrelatedOnlyOk() (*bool, bool)` + +GetCorrelatedOnlyOk returns a tuple with the CorrelatedOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedOnly + +`func (o *IdentitiesDetailsReportArguments) SetCorrelatedOnly(v bool)` + +SetCorrelatedOnly sets CorrelatedOnly field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentitiesReportArguments.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentitiesReportArguments.md new file mode 100644 index 000000000..94b0a2d87 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentitiesReportArguments.md @@ -0,0 +1,64 @@ +--- +id: v2025-identities-report-arguments +title: IdentitiesReportArguments +pagination_label: IdentitiesReportArguments +sidebar_label: IdentitiesReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitiesReportArguments', 'V2025IdentitiesReportArguments'] +slug: /tools/sdk/go/v2025/models/identities-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentitiesReportArguments', 'V2025IdentitiesReportArguments'] +--- + +# IdentitiesReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelatedOnly** | Pointer to **bool** | Flag to specify if only correlated identities are included in report. | [optional] [default to false] + +## Methods + +### NewIdentitiesReportArguments + +`func NewIdentitiesReportArguments() *IdentitiesReportArguments` + +NewIdentitiesReportArguments instantiates a new IdentitiesReportArguments 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 + +### NewIdentitiesReportArgumentsWithDefaults + +`func NewIdentitiesReportArgumentsWithDefaults() *IdentitiesReportArguments` + +NewIdentitiesReportArgumentsWithDefaults instantiates a new IdentitiesReportArguments 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 + +### GetCorrelatedOnly + +`func (o *IdentitiesReportArguments) GetCorrelatedOnly() bool` + +GetCorrelatedOnly returns the CorrelatedOnly field if non-nil, zero value otherwise. + +### GetCorrelatedOnlyOk + +`func (o *IdentitiesReportArguments) GetCorrelatedOnlyOk() (*bool, bool)` + +GetCorrelatedOnlyOk returns a tuple with the CorrelatedOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedOnly + +`func (o *IdentitiesReportArguments) SetCorrelatedOnly(v bool)` + +SetCorrelatedOnly sets CorrelatedOnly field to given value. + +### HasCorrelatedOnly + +`func (o *IdentitiesReportArguments) HasCorrelatedOnly() bool` + +HasCorrelatedOnly returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Identity.md b/docs/tools/sdk/go/Reference/V2025/Models/Identity.md new file mode 100644 index 000000000..a5d324ae4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Identity.md @@ -0,0 +1,401 @@ +--- +id: v2025-identity +title: Identity +pagination_label: Identity +sidebar_label: Identity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Identity', 'V2025Identity'] +slug: /tools/sdk/go/v2025/models/identity +tags: ['SDK', 'Software Development Kit', 'Identity', 'V2025Identity'] +--- + +# Identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the identity | [optional] [readonly] +**Name** | **string** | The identity's name is equivalent to its Display Name attribute. | +**Created** | Pointer to **SailPointTime** | Creation date of the identity | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the identity | [optional] [readonly] +**Alias** | Pointer to **string** | The identity's alternate unique identifier is equivalent to its Account Name on the authoritative source account schema. | [optional] +**EmailAddress** | Pointer to **NullableString** | The email address of the identity | [optional] +**ProcessingState** | Pointer to **NullableString** | The processing state of the identity | [optional] +**IdentityStatus** | Pointer to **string** | The identity's status in the system | [optional] +**ManagerRef** | Pointer to [**NullableIdentityManagerRef**](identity-manager-ref) | | [optional] +**IsManager** | Pointer to **bool** | Whether this identity is a manager of another identity | [optional] [default to false] +**LastRefresh** | Pointer to **SailPointTime** | The last time the identity was refreshed by the system | [optional] +**Attributes** | Pointer to **map[string]interface{}** | A map with the identity attributes for the identity | [optional] +**LifecycleState** | Pointer to [**IdentityLifecycleState**](identity-lifecycle-state) | | [optional] + +## Methods + +### NewIdentity + +`func NewIdentity(name string, ) *Identity` + +NewIdentity instantiates a new Identity 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 + +### NewIdentityWithDefaults + +`func NewIdentityWithDefaults() *Identity` + +NewIdentityWithDefaults instantiates a new Identity 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 + +### GetId + +`func (o *Identity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Identity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Identity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Identity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Identity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Identity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Identity) SetName(v string)` + +SetName sets Name field to given value. + + +### GetCreated + +`func (o *Identity) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Identity) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Identity) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Identity) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Identity) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Identity) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Identity) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Identity) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetAlias + +`func (o *Identity) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *Identity) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *Identity) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *Identity) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + +### GetEmailAddress + +`func (o *Identity) GetEmailAddress() string` + +GetEmailAddress returns the EmailAddress field if non-nil, zero value otherwise. + +### GetEmailAddressOk + +`func (o *Identity) GetEmailAddressOk() (*string, bool)` + +GetEmailAddressOk returns a tuple with the EmailAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailAddress + +`func (o *Identity) SetEmailAddress(v string)` + +SetEmailAddress sets EmailAddress field to given value. + +### HasEmailAddress + +`func (o *Identity) HasEmailAddress() bool` + +HasEmailAddress returns a boolean if a field has been set. + +### SetEmailAddressNil + +`func (o *Identity) SetEmailAddressNil(b bool)` + + SetEmailAddressNil sets the value for EmailAddress to be an explicit nil + +### UnsetEmailAddress +`func (o *Identity) UnsetEmailAddress()` + +UnsetEmailAddress ensures that no value is present for EmailAddress, not even an explicit nil +### GetProcessingState + +`func (o *Identity) GetProcessingState() string` + +GetProcessingState returns the ProcessingState field if non-nil, zero value otherwise. + +### GetProcessingStateOk + +`func (o *Identity) GetProcessingStateOk() (*string, bool)` + +GetProcessingStateOk returns a tuple with the ProcessingState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessingState + +`func (o *Identity) SetProcessingState(v string)` + +SetProcessingState sets ProcessingState field to given value. + +### HasProcessingState + +`func (o *Identity) HasProcessingState() bool` + +HasProcessingState returns a boolean if a field has been set. + +### SetProcessingStateNil + +`func (o *Identity) SetProcessingStateNil(b bool)` + + SetProcessingStateNil sets the value for ProcessingState to be an explicit nil + +### UnsetProcessingState +`func (o *Identity) UnsetProcessingState()` + +UnsetProcessingState ensures that no value is present for ProcessingState, not even an explicit nil +### GetIdentityStatus + +`func (o *Identity) GetIdentityStatus() string` + +GetIdentityStatus returns the IdentityStatus field if non-nil, zero value otherwise. + +### GetIdentityStatusOk + +`func (o *Identity) GetIdentityStatusOk() (*string, bool)` + +GetIdentityStatusOk returns a tuple with the IdentityStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityStatus + +`func (o *Identity) SetIdentityStatus(v string)` + +SetIdentityStatus sets IdentityStatus field to given value. + +### HasIdentityStatus + +`func (o *Identity) HasIdentityStatus() bool` + +HasIdentityStatus returns a boolean if a field has been set. + +### GetManagerRef + +`func (o *Identity) GetManagerRef() IdentityManagerRef` + +GetManagerRef returns the ManagerRef field if non-nil, zero value otherwise. + +### GetManagerRefOk + +`func (o *Identity) GetManagerRefOk() (*IdentityManagerRef, bool)` + +GetManagerRefOk returns a tuple with the ManagerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerRef + +`func (o *Identity) SetManagerRef(v IdentityManagerRef)` + +SetManagerRef sets ManagerRef field to given value. + +### HasManagerRef + +`func (o *Identity) HasManagerRef() bool` + +HasManagerRef returns a boolean if a field has been set. + +### SetManagerRefNil + +`func (o *Identity) SetManagerRefNil(b bool)` + + SetManagerRefNil sets the value for ManagerRef to be an explicit nil + +### UnsetManagerRef +`func (o *Identity) UnsetManagerRef()` + +UnsetManagerRef ensures that no value is present for ManagerRef, not even an explicit nil +### GetIsManager + +`func (o *Identity) GetIsManager() bool` + +GetIsManager returns the IsManager field if non-nil, zero value otherwise. + +### GetIsManagerOk + +`func (o *Identity) GetIsManagerOk() (*bool, bool)` + +GetIsManagerOk returns a tuple with the IsManager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsManager + +`func (o *Identity) SetIsManager(v bool)` + +SetIsManager sets IsManager field to given value. + +### HasIsManager + +`func (o *Identity) HasIsManager() bool` + +HasIsManager returns a boolean if a field has been set. + +### GetLastRefresh + +`func (o *Identity) GetLastRefresh() SailPointTime` + +GetLastRefresh returns the LastRefresh field if non-nil, zero value otherwise. + +### GetLastRefreshOk + +`func (o *Identity) GetLastRefreshOk() (*SailPointTime, bool)` + +GetLastRefreshOk returns a tuple with the LastRefresh field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastRefresh + +`func (o *Identity) SetLastRefresh(v SailPointTime)` + +SetLastRefresh sets LastRefresh field to given value. + +### HasLastRefresh + +`func (o *Identity) HasLastRefresh() bool` + +HasLastRefresh returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Identity) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Identity) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Identity) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Identity) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetLifecycleState + +`func (o *Identity) GetLifecycleState() IdentityLifecycleState` + +GetLifecycleState returns the LifecycleState field if non-nil, zero value otherwise. + +### GetLifecycleStateOk + +`func (o *Identity) GetLifecycleStateOk() (*IdentityLifecycleState, bool)` + +GetLifecycleStateOk returns a tuple with the LifecycleState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLifecycleState + +`func (o *Identity) SetLifecycleState(v IdentityLifecycleState)` + +SetLifecycleState sets LifecycleState field to given value. + +### HasLifecycleState + +`func (o *Identity) HasLifecycleState() bool` + +HasLifecycleState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Identity1.md b/docs/tools/sdk/go/Reference/V2025/Models/Identity1.md new file mode 100644 index 000000000..b17f37473 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Identity1.md @@ -0,0 +1,90 @@ +--- +id: v2025-identity1 +title: Identity1 +pagination_label: Identity1 +sidebar_label: Identity1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Identity1', 'V2025Identity1'] +slug: /tools/sdk/go/v2025/models/identity1 +tags: ['SDK', 'Software Development Kit', 'Identity1', 'V2025Identity1'] +--- + +# Identity1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the object | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object | [optional] + +## Methods + +### NewIdentity1 + +`func NewIdentity1() *Identity1` + +NewIdentity1 instantiates a new Identity1 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 + +### NewIdentity1WithDefaults + +`func NewIdentity1WithDefaults() *Identity1` + +NewIdentity1WithDefaults instantiates a new Identity1 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 + +### GetId + +`func (o *Identity1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Identity1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Identity1) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Identity1) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Identity1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Identity1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Identity1) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Identity1) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityAccess.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAccess.md new file mode 100644 index 000000000..fa3e57556 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAccess.md @@ -0,0 +1,386 @@ +--- +id: v2025-identity-access +title: IdentityAccess +pagination_label: IdentityAccess +sidebar_label: IdentityAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAccess', 'V2025IdentityAccess'] +slug: /tools/sdk/go/v2025/models/identity-access +tags: ['SDK', 'Software Development Kit', 'IdentityAccess', 'V2025IdentityAccess'] +--- + +# IdentityAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Source** | Pointer to [**Reference**](reference) | | [optional] +**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional] +**Revocable** | Pointer to **bool** | | [optional] +**Privileged** | Pointer to **bool** | | [optional] +**Attribute** | Pointer to **string** | | [optional] +**Value** | Pointer to **string** | | [optional] +**Standalone** | Pointer to **bool** | | [optional] +**Disabled** | Pointer to **bool** | | [optional] + +## Methods + +### NewIdentityAccess + +`func NewIdentityAccess() *IdentityAccess` + +NewIdentityAccess instantiates a new IdentityAccess 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 + +### NewIdentityAccessWithDefaults + +`func NewIdentityAccessWithDefaults() *IdentityAccess` + +NewIdentityAccessWithDefaults instantiates a new IdentityAccess 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 + +### GetId + +`func (o *IdentityAccess) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityAccess) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityAccess) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityAccess) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityAccess) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityAccess) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityAccess) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityAccess) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *IdentityAccess) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityAccess) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityAccess) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityAccess) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *IdentityAccess) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *IdentityAccess) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *IdentityAccess) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *IdentityAccess) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *IdentityAccess) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *IdentityAccess) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *IdentityAccess) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityAccess) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityAccess) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityAccess) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSource + +`func (o *IdentityAccess) GetSource() Reference` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *IdentityAccess) GetSourceOk() (*Reference, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *IdentityAccess) SetSource(v Reference)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *IdentityAccess) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetOwner + +`func (o *IdentityAccess) GetOwner() DisplayReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *IdentityAccess) GetOwnerOk() (*DisplayReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *IdentityAccess) SetOwner(v DisplayReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *IdentityAccess) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRevocable + +`func (o *IdentityAccess) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *IdentityAccess) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *IdentityAccess) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *IdentityAccess) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *IdentityAccess) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *IdentityAccess) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *IdentityAccess) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *IdentityAccess) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetAttribute + +`func (o *IdentityAccess) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *IdentityAccess) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *IdentityAccess) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *IdentityAccess) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *IdentityAccess) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *IdentityAccess) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *IdentityAccess) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *IdentityAccess) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetStandalone + +`func (o *IdentityAccess) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *IdentityAccess) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *IdentityAccess) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + +### HasStandalone + +`func (o *IdentityAccess) HasStandalone() bool` + +HasStandalone returns a boolean if a field has been set. + +### GetDisabled + +`func (o *IdentityAccess) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *IdentityAccess) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *IdentityAccess) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *IdentityAccess) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityAccountSelections.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAccountSelections.md new file mode 100644 index 000000000..b94f833a1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAccountSelections.md @@ -0,0 +1,168 @@ +--- +id: v2025-identity-account-selections +title: IdentityAccountSelections +pagination_label: IdentityAccountSelections +sidebar_label: IdentityAccountSelections +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAccountSelections', 'V2025IdentityAccountSelections'] +slug: /tools/sdk/go/v2025/models/identity-account-selections +tags: ['SDK', 'Software Development Kit', 'IdentityAccountSelections', 'V2025IdentityAccountSelections'] +--- + +# IdentityAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedItems** | Pointer to [**[]RequestedItemAccountSelections**](requested-item-account-selections) | Available account selections for the identity, per requested item | [optional] +**AccountsSelectionRequired** | Pointer to **bool** | A boolean indicating whether any account selections will be required for the user to raise an access request | [optional] [default to false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | The identity id for the user | [optional] +**Name** | Pointer to **string** | The name of the identity | [optional] + +## Methods + +### NewIdentityAccountSelections + +`func NewIdentityAccountSelections() *IdentityAccountSelections` + +NewIdentityAccountSelections instantiates a new IdentityAccountSelections 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 + +### NewIdentityAccountSelectionsWithDefaults + +`func NewIdentityAccountSelectionsWithDefaults() *IdentityAccountSelections` + +NewIdentityAccountSelectionsWithDefaults instantiates a new IdentityAccountSelections 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 + +### GetRequestedItems + +`func (o *IdentityAccountSelections) GetRequestedItems() []RequestedItemAccountSelections` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *IdentityAccountSelections) GetRequestedItemsOk() (*[]RequestedItemAccountSelections, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *IdentityAccountSelections) SetRequestedItems(v []RequestedItemAccountSelections)` + +SetRequestedItems sets RequestedItems field to given value. + +### HasRequestedItems + +`func (o *IdentityAccountSelections) HasRequestedItems() bool` + +HasRequestedItems returns a boolean if a field has been set. + +### GetAccountsSelectionRequired + +`func (o *IdentityAccountSelections) GetAccountsSelectionRequired() bool` + +GetAccountsSelectionRequired returns the AccountsSelectionRequired field if non-nil, zero value otherwise. + +### GetAccountsSelectionRequiredOk + +`func (o *IdentityAccountSelections) GetAccountsSelectionRequiredOk() (*bool, bool)` + +GetAccountsSelectionRequiredOk returns a tuple with the AccountsSelectionRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountsSelectionRequired + +`func (o *IdentityAccountSelections) SetAccountsSelectionRequired(v bool)` + +SetAccountsSelectionRequired sets AccountsSelectionRequired field to given value. + +### HasAccountsSelectionRequired + +`func (o *IdentityAccountSelections) HasAccountsSelectionRequired() bool` + +HasAccountsSelectionRequired returns a boolean if a field has been set. + +### GetType + +`func (o *IdentityAccountSelections) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityAccountSelections) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityAccountSelections) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityAccountSelections) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityAccountSelections) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityAccountSelections) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityAccountSelections) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityAccountSelections) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityAccountSelections) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityAccountSelections) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityAccountSelections) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityAccountSelections) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityAssociationDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAssociationDetails.md new file mode 100644 index 000000000..95a19d709 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAssociationDetails.md @@ -0,0 +1,90 @@ +--- +id: v2025-identity-association-details +title: IdentityAssociationDetails +pagination_label: IdentityAssociationDetails +sidebar_label: IdentityAssociationDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAssociationDetails', 'V2025IdentityAssociationDetails'] +slug: /tools/sdk/go/v2025/models/identity-association-details +tags: ['SDK', 'Software Development Kit', 'IdentityAssociationDetails', 'V2025IdentityAssociationDetails'] +--- + +# IdentityAssociationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **string** | any additional context information of the http call result | [optional] +**AssociationDetails** | Pointer to [**[]IdentityAssociationDetailsAssociationDetailsInner**](identity-association-details-association-details-inner) | list of all the resource associations for the identity | [optional] + +## Methods + +### NewIdentityAssociationDetails + +`func NewIdentityAssociationDetails() *IdentityAssociationDetails` + +NewIdentityAssociationDetails instantiates a new IdentityAssociationDetails 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 + +### NewIdentityAssociationDetailsWithDefaults + +`func NewIdentityAssociationDetailsWithDefaults() *IdentityAssociationDetails` + +NewIdentityAssociationDetailsWithDefaults instantiates a new IdentityAssociationDetails 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 + +### GetMessage + +`func (o *IdentityAssociationDetails) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *IdentityAssociationDetails) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *IdentityAssociationDetails) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *IdentityAssociationDetails) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetAssociationDetails + +`func (o *IdentityAssociationDetails) GetAssociationDetails() []IdentityAssociationDetailsAssociationDetailsInner` + +GetAssociationDetails returns the AssociationDetails field if non-nil, zero value otherwise. + +### GetAssociationDetailsOk + +`func (o *IdentityAssociationDetails) GetAssociationDetailsOk() (*[]IdentityAssociationDetailsAssociationDetailsInner, bool)` + +GetAssociationDetailsOk returns a tuple with the AssociationDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociationDetails + +`func (o *IdentityAssociationDetails) SetAssociationDetails(v []IdentityAssociationDetailsAssociationDetailsInner)` + +SetAssociationDetails sets AssociationDetails field to given value. + +### HasAssociationDetails + +`func (o *IdentityAssociationDetails) HasAssociationDetails() bool` + +HasAssociationDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAssociationDetailsAssociationDetailsInner.md new file mode 100644 index 000000000..8c7fe8597 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAssociationDetailsAssociationDetailsInner.md @@ -0,0 +1,90 @@ +--- +id: v2025-identity-association-details-association-details-inner +title: IdentityAssociationDetailsAssociationDetailsInner +pagination_label: IdentityAssociationDetailsAssociationDetailsInner +sidebar_label: IdentityAssociationDetailsAssociationDetailsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAssociationDetailsAssociationDetailsInner', 'V2025IdentityAssociationDetailsAssociationDetailsInner'] +slug: /tools/sdk/go/v2025/models/identity-association-details-association-details-inner +tags: ['SDK', 'Software Development Kit', 'IdentityAssociationDetailsAssociationDetailsInner', 'V2025IdentityAssociationDetailsAssociationDetailsInner'] +--- + +# IdentityAssociationDetailsAssociationDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssociationType** | Pointer to **string** | association type with the identity | [optional] +**Entities** | Pointer to [**[]IdentityEntities**](identity-entities) | the specific resource this identity has ownership on | [optional] + +## Methods + +### NewIdentityAssociationDetailsAssociationDetailsInner + +`func NewIdentityAssociationDetailsAssociationDetailsInner() *IdentityAssociationDetailsAssociationDetailsInner` + +NewIdentityAssociationDetailsAssociationDetailsInner instantiates a new IdentityAssociationDetailsAssociationDetailsInner 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 + +### NewIdentityAssociationDetailsAssociationDetailsInnerWithDefaults + +`func NewIdentityAssociationDetailsAssociationDetailsInnerWithDefaults() *IdentityAssociationDetailsAssociationDetailsInner` + +NewIdentityAssociationDetailsAssociationDetailsInnerWithDefaults instantiates a new IdentityAssociationDetailsAssociationDetailsInner 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 + +### GetAssociationType + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) GetAssociationType() string` + +GetAssociationType returns the AssociationType field if non-nil, zero value otherwise. + +### GetAssociationTypeOk + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) GetAssociationTypeOk() (*string, bool)` + +GetAssociationTypeOk returns a tuple with the AssociationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociationType + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) SetAssociationType(v string)` + +SetAssociationType sets AssociationType field to given value. + +### HasAssociationType + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) HasAssociationType() bool` + +HasAssociationType returns a boolean if a field has been set. + +### GetEntities + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) GetEntities() []IdentityEntities` + +GetEntities returns the Entities field if non-nil, zero value otherwise. + +### GetEntitiesOk + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) GetEntitiesOk() (*[]IdentityEntities, bool)` + +GetEntitiesOk returns a tuple with the Entities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntities + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) SetEntities(v []IdentityEntities)` + +SetEntities sets Entities field to given value. + +### HasEntities + +`func (o *IdentityAssociationDetailsAssociationDetailsInner) HasEntities() bool` + +HasEntities returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttribute.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttribute.md new file mode 100644 index 000000000..bb99ae6da --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttribute.md @@ -0,0 +1,251 @@ +--- +id: v2025-identity-attribute +title: IdentityAttribute +pagination_label: IdentityAttribute +sidebar_label: IdentityAttribute +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttribute', 'V2025IdentityAttribute'] +slug: /tools/sdk/go/v2025/models/identity-attribute +tags: ['SDK', 'Software Development Kit', 'IdentityAttribute', 'V2025IdentityAttribute'] +--- + +# IdentityAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Identity attribute's technical name. | +**DisplayName** | Pointer to **string** | Identity attribute's business-friendly name. | [optional] +**Standard** | Pointer to **bool** | Indicates whether the attribute is 'standard' or 'default'. | [optional] [default to false] +**Type** | Pointer to **NullableString** | Identity attribute's type. | [optional] +**Multi** | Pointer to **bool** | Indicates whether the identity attribute is multi-valued. | [optional] [default to false] +**Searchable** | Pointer to **bool** | Indicates whether the identity attribute is searchable. | [optional] [default to false] +**System** | Pointer to **bool** | Indicates whether the identity attribute is 'system', meaning that it doesn't have a source and isn't configurable. | [optional] [default to false] +**Sources** | Pointer to [**[]Source1**](source1) | Identity attribute's list of sources - this specifies how the rule's value is derived. | [optional] + +## Methods + +### NewIdentityAttribute + +`func NewIdentityAttribute(name string, ) *IdentityAttribute` + +NewIdentityAttribute instantiates a new IdentityAttribute 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 + +### NewIdentityAttributeWithDefaults + +`func NewIdentityAttributeWithDefaults() *IdentityAttribute` + +NewIdentityAttributeWithDefaults instantiates a new IdentityAttribute 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 + +### GetName + +`func (o *IdentityAttribute) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityAttribute) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityAttribute) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDisplayName + +`func (o *IdentityAttribute) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityAttribute) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityAttribute) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityAttribute) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetStandard + +`func (o *IdentityAttribute) GetStandard() bool` + +GetStandard returns the Standard field if non-nil, zero value otherwise. + +### GetStandardOk + +`func (o *IdentityAttribute) GetStandardOk() (*bool, bool)` + +GetStandardOk returns a tuple with the Standard field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandard + +`func (o *IdentityAttribute) SetStandard(v bool)` + +SetStandard sets Standard field to given value. + +### HasStandard + +`func (o *IdentityAttribute) HasStandard() bool` + +HasStandard returns a boolean if a field has been set. + +### GetType + +`func (o *IdentityAttribute) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityAttribute) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityAttribute) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityAttribute) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *IdentityAttribute) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *IdentityAttribute) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetMulti + +`func (o *IdentityAttribute) GetMulti() bool` + +GetMulti returns the Multi field if non-nil, zero value otherwise. + +### GetMultiOk + +`func (o *IdentityAttribute) GetMultiOk() (*bool, bool)` + +GetMultiOk returns a tuple with the Multi field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMulti + +`func (o *IdentityAttribute) SetMulti(v bool)` + +SetMulti sets Multi field to given value. + +### HasMulti + +`func (o *IdentityAttribute) HasMulti() bool` + +HasMulti returns a boolean if a field has been set. + +### GetSearchable + +`func (o *IdentityAttribute) GetSearchable() bool` + +GetSearchable returns the Searchable field if non-nil, zero value otherwise. + +### GetSearchableOk + +`func (o *IdentityAttribute) GetSearchableOk() (*bool, bool)` + +GetSearchableOk returns a tuple with the Searchable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchable + +`func (o *IdentityAttribute) SetSearchable(v bool)` + +SetSearchable sets Searchable field to given value. + +### HasSearchable + +`func (o *IdentityAttribute) HasSearchable() bool` + +HasSearchable returns a boolean if a field has been set. + +### GetSystem + +`func (o *IdentityAttribute) GetSystem() bool` + +GetSystem returns the System field if non-nil, zero value otherwise. + +### GetSystemOk + +`func (o *IdentityAttribute) GetSystemOk() (*bool, bool)` + +GetSystemOk returns a tuple with the System field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSystem + +`func (o *IdentityAttribute) SetSystem(v bool)` + +SetSystem sets System field to given value. + +### HasSystem + +`func (o *IdentityAttribute) HasSystem() bool` + +HasSystem returns a boolean if a field has been set. + +### GetSources + +`func (o *IdentityAttribute) GetSources() []Source1` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *IdentityAttribute) GetSourcesOk() (*[]Source1, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *IdentityAttribute) SetSources(v []Source1)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *IdentityAttribute) HasSources() bool` + +HasSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributeConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributeConfig.md new file mode 100644 index 000000000..ff640d61d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributeConfig.md @@ -0,0 +1,90 @@ +--- +id: v2025-identity-attribute-config +title: IdentityAttributeConfig +pagination_label: IdentityAttributeConfig +sidebar_label: IdentityAttributeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributeConfig', 'V2025IdentityAttributeConfig'] +slug: /tools/sdk/go/v2025/models/identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'V2025IdentityAttributeConfig'] +--- + +# IdentityAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to false] +**AttributeTransforms** | Pointer to [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] + +## Methods + +### NewIdentityAttributeConfig + +`func NewIdentityAttributeConfig() *IdentityAttributeConfig` + +NewIdentityAttributeConfig instantiates a new IdentityAttributeConfig 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 + +### NewIdentityAttributeConfigWithDefaults + +`func NewIdentityAttributeConfigWithDefaults() *IdentityAttributeConfig` + +NewIdentityAttributeConfigWithDefaults instantiates a new IdentityAttributeConfig 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 + +### GetEnabled + +`func (o *IdentityAttributeConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *IdentityAttributeConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *IdentityAttributeConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *IdentityAttributeConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetAttributeTransforms + +`func (o *IdentityAttributeConfig) GetAttributeTransforms() []IdentityAttributeTransform` + +GetAttributeTransforms returns the AttributeTransforms field if non-nil, zero value otherwise. + +### GetAttributeTransformsOk + +`func (o *IdentityAttributeConfig) GetAttributeTransformsOk() (*[]IdentityAttributeTransform, bool)` + +GetAttributeTransformsOk returns a tuple with the AttributeTransforms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeTransforms + +`func (o *IdentityAttributeConfig) SetAttributeTransforms(v []IdentityAttributeTransform)` + +SetAttributeTransforms sets AttributeTransforms field to given value. + +### HasAttributeTransforms + +`func (o *IdentityAttributeConfig) HasAttributeTransforms() bool` + +HasAttributeTransforms returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributeNames.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributeNames.md new file mode 100644 index 000000000..e3f22092b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributeNames.md @@ -0,0 +1,64 @@ +--- +id: v2025-identity-attribute-names +title: IdentityAttributeNames +pagination_label: IdentityAttributeNames +sidebar_label: IdentityAttributeNames +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributeNames', 'V2025IdentityAttributeNames'] +slug: /tools/sdk/go/v2025/models/identity-attribute-names +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeNames', 'V2025IdentityAttributeNames'] +--- + +# IdentityAttributeNames + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]string** | List of identity attributes' technical names. | [optional] + +## Methods + +### NewIdentityAttributeNames + +`func NewIdentityAttributeNames() *IdentityAttributeNames` + +NewIdentityAttributeNames instantiates a new IdentityAttributeNames 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 + +### NewIdentityAttributeNamesWithDefaults + +`func NewIdentityAttributeNamesWithDefaults() *IdentityAttributeNames` + +NewIdentityAttributeNamesWithDefaults instantiates a new IdentityAttributeNames 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 + +### GetIds + +`func (o *IdentityAttributeNames) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *IdentityAttributeNames) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *IdentityAttributeNames) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *IdentityAttributeNames) HasIds() bool` + +HasIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributePreview.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributePreview.md new file mode 100644 index 000000000..f97a04614 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributePreview.md @@ -0,0 +1,142 @@ +--- +id: v2025-identity-attribute-preview +title: IdentityAttributePreview +pagination_label: IdentityAttributePreview +sidebar_label: IdentityAttributePreview +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributePreview', 'V2025IdentityAttributePreview'] +slug: /tools/sdk/go/v2025/models/identity-attribute-preview +tags: ['SDK', 'Software Development Kit', 'IdentityAttributePreview', 'V2025IdentityAttributePreview'] +--- + +# IdentityAttributePreview + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the attribute that is being previewed. | [optional] +**Value** | Pointer to **string** | Value that was derived during the preview. | [optional] +**PreviousValue** | Pointer to **string** | The value of the attribute before the preview. | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | List of error messages | [optional] + +## Methods + +### NewIdentityAttributePreview + +`func NewIdentityAttributePreview() *IdentityAttributePreview` + +NewIdentityAttributePreview instantiates a new IdentityAttributePreview 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 + +### NewIdentityAttributePreviewWithDefaults + +`func NewIdentityAttributePreviewWithDefaults() *IdentityAttributePreview` + +NewIdentityAttributePreviewWithDefaults instantiates a new IdentityAttributePreview 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 + +### GetName + +`func (o *IdentityAttributePreview) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityAttributePreview) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityAttributePreview) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityAttributePreview) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValue + +`func (o *IdentityAttributePreview) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *IdentityAttributePreview) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *IdentityAttributePreview) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *IdentityAttributePreview) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetPreviousValue + +`func (o *IdentityAttributePreview) GetPreviousValue() string` + +GetPreviousValue returns the PreviousValue field if non-nil, zero value otherwise. + +### GetPreviousValueOk + +`func (o *IdentityAttributePreview) GetPreviousValueOk() (*string, bool)` + +GetPreviousValueOk returns a tuple with the PreviousValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousValue + +`func (o *IdentityAttributePreview) SetPreviousValue(v string)` + +SetPreviousValue sets PreviousValue field to given value. + +### HasPreviousValue + +`func (o *IdentityAttributePreview) HasPreviousValue() bool` + +HasPreviousValue returns a boolean if a field has been set. + +### GetErrorMessages + +`func (o *IdentityAttributePreview) GetErrorMessages() []ErrorMessageDto` + +GetErrorMessages returns the ErrorMessages field if non-nil, zero value otherwise. + +### GetErrorMessagesOk + +`func (o *IdentityAttributePreview) GetErrorMessagesOk() (*[]ErrorMessageDto, bool)` + +GetErrorMessagesOk returns a tuple with the ErrorMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessages + +`func (o *IdentityAttributePreview) SetErrorMessages(v []ErrorMessageDto)` + +SetErrorMessages sets ErrorMessages field to given value. + +### HasErrorMessages + +`func (o *IdentityAttributePreview) HasErrorMessages() bool` + +HasErrorMessages returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributeTransform.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributeTransform.md new file mode 100644 index 000000000..b034bd2ae --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributeTransform.md @@ -0,0 +1,90 @@ +--- +id: v2025-identity-attribute-transform +title: IdentityAttributeTransform +pagination_label: IdentityAttributeTransform +sidebar_label: IdentityAttributeTransform +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributeTransform', 'V2025IdentityAttributeTransform'] +slug: /tools/sdk/go/v2025/models/identity-attribute-transform +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'V2025IdentityAttributeTransform'] +--- + +# IdentityAttributeTransform + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttributeName** | Pointer to **string** | Identity attribute's name. | [optional] +**TransformDefinition** | Pointer to [**TransformDefinition**](transform-definition) | | [optional] + +## Methods + +### NewIdentityAttributeTransform + +`func NewIdentityAttributeTransform() *IdentityAttributeTransform` + +NewIdentityAttributeTransform instantiates a new IdentityAttributeTransform 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 + +### NewIdentityAttributeTransformWithDefaults + +`func NewIdentityAttributeTransformWithDefaults() *IdentityAttributeTransform` + +NewIdentityAttributeTransformWithDefaults instantiates a new IdentityAttributeTransform 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 + +### GetIdentityAttributeName + +`func (o *IdentityAttributeTransform) GetIdentityAttributeName() string` + +GetIdentityAttributeName returns the IdentityAttributeName field if non-nil, zero value otherwise. + +### GetIdentityAttributeNameOk + +`func (o *IdentityAttributeTransform) GetIdentityAttributeNameOk() (*string, bool)` + +GetIdentityAttributeNameOk returns a tuple with the IdentityAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeName + +`func (o *IdentityAttributeTransform) SetIdentityAttributeName(v string)` + +SetIdentityAttributeName sets IdentityAttributeName field to given value. + +### HasIdentityAttributeName + +`func (o *IdentityAttributeTransform) HasIdentityAttributeName() bool` + +HasIdentityAttributeName returns a boolean if a field has been set. + +### GetTransformDefinition + +`func (o *IdentityAttributeTransform) GetTransformDefinition() TransformDefinition` + +GetTransformDefinition returns the TransformDefinition field if non-nil, zero value otherwise. + +### GetTransformDefinitionOk + +`func (o *IdentityAttributeTransform) GetTransformDefinitionOk() (*TransformDefinition, bool)` + +GetTransformDefinitionOk returns a tuple with the TransformDefinition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTransformDefinition + +`func (o *IdentityAttributeTransform) SetTransformDefinition(v TransformDefinition)` + +SetTransformDefinition sets TransformDefinition field to given value. + +### HasTransformDefinition + +`func (o *IdentityAttributeTransform) HasTransformDefinition() bool` + +HasTransformDefinition returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChanged.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChanged.md new file mode 100644 index 000000000..495861e8a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChanged.md @@ -0,0 +1,80 @@ +--- +id: v2025-identity-attributes-changed +title: IdentityAttributesChanged +pagination_label: IdentityAttributesChanged +sidebar_label: IdentityAttributesChanged +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChanged', 'V2025IdentityAttributesChanged'] +slug: /tools/sdk/go/v2025/models/identity-attributes-changed +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChanged', 'V2025IdentityAttributesChanged'] +--- + +# IdentityAttributesChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**IdentityAttributesChangedIdentity**](identity-attributes-changed-identity) | | +**Changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | + +## Methods + +### NewIdentityAttributesChanged + +`func NewIdentityAttributesChanged(identity IdentityAttributesChangedIdentity, changes []IdentityAttributesChangedChangesInner, ) *IdentityAttributesChanged` + +NewIdentityAttributesChanged instantiates a new IdentityAttributesChanged 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 + +### NewIdentityAttributesChangedWithDefaults + +`func NewIdentityAttributesChangedWithDefaults() *IdentityAttributesChanged` + +NewIdentityAttributesChangedWithDefaults instantiates a new IdentityAttributesChanged 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 + +### GetIdentity + +`func (o *IdentityAttributesChanged) GetIdentity() IdentityAttributesChangedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *IdentityAttributesChanged) GetIdentityOk() (*IdentityAttributesChangedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *IdentityAttributesChanged) SetIdentity(v IdentityAttributesChangedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetChanges + +`func (o *IdentityAttributesChanged) GetChanges() []IdentityAttributesChangedChangesInner` + +GetChanges returns the Changes field if non-nil, zero value otherwise. + +### GetChangesOk + +`func (o *IdentityAttributesChanged) GetChangesOk() (*[]IdentityAttributesChangedChangesInner, bool)` + +GetChangesOk returns a tuple with the Changes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanges + +`func (o *IdentityAttributesChanged) SetChanges(v []IdentityAttributesChangedChangesInner)` + +SetChanges sets Changes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChangedChangesInner.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChangedChangesInner.md new file mode 100644 index 000000000..8122fcd19 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChangedChangesInner.md @@ -0,0 +1,121 @@ +--- +id: v2025-identity-attributes-changed-changes-inner +title: IdentityAttributesChangedChangesInner +pagination_label: IdentityAttributesChangedChangesInner +sidebar_label: IdentityAttributesChangedChangesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChangedChangesInner', 'V2025IdentityAttributesChangedChangesInner'] +slug: /tools/sdk/go/v2025/models/identity-attributes-changed-changes-inner +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInner', 'V2025IdentityAttributesChangedChangesInner'] +--- + +# IdentityAttributesChangedChangesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | **string** | The name of the identity attribute that changed. | +**OldValue** | Pointer to [**NullableIdentityAttributesChangedChangesInnerOldValue**](identity-attributes-changed-changes-inner-old-value) | | [optional] +**NewValue** | Pointer to [**IdentityAttributesChangedChangesInnerNewValue**](identity-attributes-changed-changes-inner-new-value) | | [optional] + +## Methods + +### NewIdentityAttributesChangedChangesInner + +`func NewIdentityAttributesChangedChangesInner(attribute string, ) *IdentityAttributesChangedChangesInner` + +NewIdentityAttributesChangedChangesInner instantiates a new IdentityAttributesChangedChangesInner 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 + +### NewIdentityAttributesChangedChangesInnerWithDefaults + +`func NewIdentityAttributesChangedChangesInnerWithDefaults() *IdentityAttributesChangedChangesInner` + +NewIdentityAttributesChangedChangesInnerWithDefaults instantiates a new IdentityAttributesChangedChangesInner 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 + +### GetAttribute + +`func (o *IdentityAttributesChangedChangesInner) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *IdentityAttributesChangedChangesInner) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *IdentityAttributesChangedChangesInner) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + + +### GetOldValue + +`func (o *IdentityAttributesChangedChangesInner) GetOldValue() IdentityAttributesChangedChangesInnerOldValue` + +GetOldValue returns the OldValue field if non-nil, zero value otherwise. + +### GetOldValueOk + +`func (o *IdentityAttributesChangedChangesInner) GetOldValueOk() (*IdentityAttributesChangedChangesInnerOldValue, bool)` + +GetOldValueOk returns a tuple with the OldValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOldValue + +`func (o *IdentityAttributesChangedChangesInner) SetOldValue(v IdentityAttributesChangedChangesInnerOldValue)` + +SetOldValue sets OldValue field to given value. + +### HasOldValue + +`func (o *IdentityAttributesChangedChangesInner) HasOldValue() bool` + +HasOldValue returns a boolean if a field has been set. + +### SetOldValueNil + +`func (o *IdentityAttributesChangedChangesInner) SetOldValueNil(b bool)` + + SetOldValueNil sets the value for OldValue to be an explicit nil + +### UnsetOldValue +`func (o *IdentityAttributesChangedChangesInner) UnsetOldValue()` + +UnsetOldValue ensures that no value is present for OldValue, not even an explicit nil +### GetNewValue + +`func (o *IdentityAttributesChangedChangesInner) GetNewValue() IdentityAttributesChangedChangesInnerNewValue` + +GetNewValue returns the NewValue field if non-nil, zero value otherwise. + +### GetNewValueOk + +`func (o *IdentityAttributesChangedChangesInner) GetNewValueOk() (*IdentityAttributesChangedChangesInnerNewValue, bool)` + +GetNewValueOk returns a tuple with the NewValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewValue + +`func (o *IdentityAttributesChangedChangesInner) SetNewValue(v IdentityAttributesChangedChangesInnerNewValue)` + +SetNewValue sets NewValue field to given value. + +### HasNewValue + +`func (o *IdentityAttributesChangedChangesInner) HasNewValue() bool` + +HasNewValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChangedChangesInnerNewValue.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChangedChangesInnerNewValue.md new file mode 100644 index 000000000..fe3476f65 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChangedChangesInnerNewValue.md @@ -0,0 +1,38 @@ +--- +id: v2025-identity-attributes-changed-changes-inner-new-value +title: IdentityAttributesChangedChangesInnerNewValue +pagination_label: IdentityAttributesChangedChangesInnerNewValue +sidebar_label: IdentityAttributesChangedChangesInnerNewValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChangedChangesInnerNewValue', 'V2025IdentityAttributesChangedChangesInnerNewValue'] +slug: /tools/sdk/go/v2025/models/identity-attributes-changed-changes-inner-new-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerNewValue', 'V2025IdentityAttributesChangedChangesInnerNewValue'] +--- + +# IdentityAttributesChangedChangesInnerNewValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewIdentityAttributesChangedChangesInnerNewValue + +`func NewIdentityAttributesChangedChangesInnerNewValue() *IdentityAttributesChangedChangesInnerNewValue` + +NewIdentityAttributesChangedChangesInnerNewValue instantiates a new IdentityAttributesChangedChangesInnerNewValue 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 + +### NewIdentityAttributesChangedChangesInnerNewValueWithDefaults + +`func NewIdentityAttributesChangedChangesInnerNewValueWithDefaults() *IdentityAttributesChangedChangesInnerNewValue` + +NewIdentityAttributesChangedChangesInnerNewValueWithDefaults instantiates a new IdentityAttributesChangedChangesInnerNewValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChangedChangesInnerOldValue.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChangedChangesInnerOldValue.md new file mode 100644 index 000000000..0be21daa2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChangedChangesInnerOldValue.md @@ -0,0 +1,38 @@ +--- +id: v2025-identity-attributes-changed-changes-inner-old-value +title: IdentityAttributesChangedChangesInnerOldValue +pagination_label: IdentityAttributesChangedChangesInnerOldValue +sidebar_label: IdentityAttributesChangedChangesInnerOldValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChangedChangesInnerOldValue', 'V2025IdentityAttributesChangedChangesInnerOldValue'] +slug: /tools/sdk/go/v2025/models/identity-attributes-changed-changes-inner-old-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerOldValue', 'V2025IdentityAttributesChangedChangesInnerOldValue'] +--- + +# IdentityAttributesChangedChangesInnerOldValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewIdentityAttributesChangedChangesInnerOldValue + +`func NewIdentityAttributesChangedChangesInnerOldValue() *IdentityAttributesChangedChangesInnerOldValue` + +NewIdentityAttributesChangedChangesInnerOldValue instantiates a new IdentityAttributesChangedChangesInnerOldValue 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 + +### NewIdentityAttributesChangedChangesInnerOldValueWithDefaults + +`func NewIdentityAttributesChangedChangesInnerOldValueWithDefaults() *IdentityAttributesChangedChangesInnerOldValue` + +NewIdentityAttributesChangedChangesInnerOldValueWithDefaults instantiates a new IdentityAttributesChangedChangesInnerOldValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md new file mode 100644 index 000000000..2ca572838 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md @@ -0,0 +1,38 @@ +--- +id: v2025-identity-attributes-changed-changes-inner-old-value-one-of-value +title: IdentityAttributesChangedChangesInnerOldValueOneOfValue +pagination_label: IdentityAttributesChangedChangesInnerOldValueOneOfValue +sidebar_label: IdentityAttributesChangedChangesInnerOldValueOneOfValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChangedChangesInnerOldValueOneOfValue', 'V2025IdentityAttributesChangedChangesInnerOldValueOneOfValue'] +slug: /tools/sdk/go/v2025/models/identity-attributes-changed-changes-inner-old-value-one-of-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerOldValueOneOfValue', 'V2025IdentityAttributesChangedChangesInnerOldValueOneOfValue'] +--- + +# IdentityAttributesChangedChangesInnerOldValueOneOfValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewIdentityAttributesChangedChangesInnerOldValueOneOfValue + +`func NewIdentityAttributesChangedChangesInnerOldValueOneOfValue() *IdentityAttributesChangedChangesInnerOldValueOneOfValue` + +NewIdentityAttributesChangedChangesInnerOldValueOneOfValue instantiates a new IdentityAttributesChangedChangesInnerOldValueOneOfValue 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 + +### NewIdentityAttributesChangedChangesInnerOldValueOneOfValueWithDefaults + +`func NewIdentityAttributesChangedChangesInnerOldValueOneOfValueWithDefaults() *IdentityAttributesChangedChangesInnerOldValueOneOfValue` + +NewIdentityAttributesChangedChangesInnerOldValueOneOfValueWithDefaults instantiates a new IdentityAttributesChangedChangesInnerOldValueOneOfValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChangedIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChangedIdentity.md new file mode 100644 index 000000000..623f604b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityAttributesChangedIdentity.md @@ -0,0 +1,101 @@ +--- +id: v2025-identity-attributes-changed-identity +title: IdentityAttributesChangedIdentity +pagination_label: IdentityAttributesChangedIdentity +sidebar_label: IdentityAttributesChangedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributesChangedIdentity', 'V2025IdentityAttributesChangedIdentity'] +slug: /tools/sdk/go/v2025/models/identity-attributes-changed-identity +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedIdentity', 'V2025IdentityAttributesChangedIdentity'] +--- + +# IdentityAttributesChangedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of identity whose attributes changed. | +**Id** | **string** | ID of identity whose attributes changed. | +**Name** | **string** | Display name of identity whose attributes changed. | + +## Methods + +### NewIdentityAttributesChangedIdentity + +`func NewIdentityAttributesChangedIdentity(type_ string, id string, name string, ) *IdentityAttributesChangedIdentity` + +NewIdentityAttributesChangedIdentity instantiates a new IdentityAttributesChangedIdentity 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 + +### NewIdentityAttributesChangedIdentityWithDefaults + +`func NewIdentityAttributesChangedIdentityWithDefaults() *IdentityAttributesChangedIdentity` + +NewIdentityAttributesChangedIdentityWithDefaults instantiates a new IdentityAttributesChangedIdentity 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 + +### GetType + +`func (o *IdentityAttributesChangedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityAttributesChangedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityAttributesChangedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *IdentityAttributesChangedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityAttributesChangedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityAttributesChangedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *IdentityAttributesChangedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityAttributesChangedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityAttributesChangedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityCertDecisionSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityCertDecisionSummary.md new file mode 100644 index 000000000..4368f7ced --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityCertDecisionSummary.md @@ -0,0 +1,454 @@ +--- +id: v2025-identity-cert-decision-summary +title: IdentityCertDecisionSummary +pagination_label: IdentityCertDecisionSummary +sidebar_label: IdentityCertDecisionSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCertDecisionSummary', 'V2025IdentityCertDecisionSummary'] +slug: /tools/sdk/go/v2025/models/identity-cert-decision-summary +tags: ['SDK', 'Software Development Kit', 'IdentityCertDecisionSummary', 'V2025IdentityCertDecisionSummary'] +--- + +# IdentityCertDecisionSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EntitlementDecisionsMade** | Pointer to **int32** | Number of entitlement decisions that have been made | [optional] +**AccessProfileDecisionsMade** | Pointer to **int32** | Number of access profile decisions that have been made | [optional] +**RoleDecisionsMade** | Pointer to **int32** | Number of role decisions that have been made | [optional] +**AccountDecisionsMade** | Pointer to **int32** | Number of account decisions that have been made | [optional] +**EntitlementDecisionsTotal** | Pointer to **int32** | The total number of entitlement decisions on the certification, both complete and incomplete | [optional] +**AccessProfileDecisionsTotal** | Pointer to **int32** | The total number of access profile decisions on the certification, both complete and incomplete | [optional] +**RoleDecisionsTotal** | Pointer to **int32** | The total number of role decisions on the certification, both complete and incomplete | [optional] +**AccountDecisionsTotal** | Pointer to **int32** | The total number of account decisions on the certification, both complete and incomplete | [optional] +**EntitlementsApproved** | Pointer to **int32** | The number of entitlement decisions that have been made which were approved | [optional] +**EntitlementsRevoked** | Pointer to **int32** | The number of entitlement decisions that have been made which were revoked | [optional] +**AccessProfilesApproved** | Pointer to **int32** | The number of access profile decisions that have been made which were approved | [optional] +**AccessProfilesRevoked** | Pointer to **int32** | The number of access profile decisions that have been made which were revoked | [optional] +**RolesApproved** | Pointer to **int32** | The number of role decisions that have been made which were approved | [optional] +**RolesRevoked** | Pointer to **int32** | The number of role decisions that have been made which were revoked | [optional] +**AccountsApproved** | Pointer to **int32** | The number of account decisions that have been made which were approved | [optional] +**AccountsRevoked** | Pointer to **int32** | The number of account decisions that have been made which were revoked | [optional] + +## Methods + +### NewIdentityCertDecisionSummary + +`func NewIdentityCertDecisionSummary() *IdentityCertDecisionSummary` + +NewIdentityCertDecisionSummary instantiates a new IdentityCertDecisionSummary 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 + +### NewIdentityCertDecisionSummaryWithDefaults + +`func NewIdentityCertDecisionSummaryWithDefaults() *IdentityCertDecisionSummary` + +NewIdentityCertDecisionSummaryWithDefaults instantiates a new IdentityCertDecisionSummary 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 + +### GetEntitlementDecisionsMade + +`func (o *IdentityCertDecisionSummary) GetEntitlementDecisionsMade() int32` + +GetEntitlementDecisionsMade returns the EntitlementDecisionsMade field if non-nil, zero value otherwise. + +### GetEntitlementDecisionsMadeOk + +`func (o *IdentityCertDecisionSummary) GetEntitlementDecisionsMadeOk() (*int32, bool)` + +GetEntitlementDecisionsMadeOk returns a tuple with the EntitlementDecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementDecisionsMade + +`func (o *IdentityCertDecisionSummary) SetEntitlementDecisionsMade(v int32)` + +SetEntitlementDecisionsMade sets EntitlementDecisionsMade field to given value. + +### HasEntitlementDecisionsMade + +`func (o *IdentityCertDecisionSummary) HasEntitlementDecisionsMade() bool` + +HasEntitlementDecisionsMade returns a boolean if a field has been set. + +### GetAccessProfileDecisionsMade + +`func (o *IdentityCertDecisionSummary) GetAccessProfileDecisionsMade() int32` + +GetAccessProfileDecisionsMade returns the AccessProfileDecisionsMade field if non-nil, zero value otherwise. + +### GetAccessProfileDecisionsMadeOk + +`func (o *IdentityCertDecisionSummary) GetAccessProfileDecisionsMadeOk() (*int32, bool)` + +GetAccessProfileDecisionsMadeOk returns a tuple with the AccessProfileDecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileDecisionsMade + +`func (o *IdentityCertDecisionSummary) SetAccessProfileDecisionsMade(v int32)` + +SetAccessProfileDecisionsMade sets AccessProfileDecisionsMade field to given value. + +### HasAccessProfileDecisionsMade + +`func (o *IdentityCertDecisionSummary) HasAccessProfileDecisionsMade() bool` + +HasAccessProfileDecisionsMade returns a boolean if a field has been set. + +### GetRoleDecisionsMade + +`func (o *IdentityCertDecisionSummary) GetRoleDecisionsMade() int32` + +GetRoleDecisionsMade returns the RoleDecisionsMade field if non-nil, zero value otherwise. + +### GetRoleDecisionsMadeOk + +`func (o *IdentityCertDecisionSummary) GetRoleDecisionsMadeOk() (*int32, bool)` + +GetRoleDecisionsMadeOk returns a tuple with the RoleDecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleDecisionsMade + +`func (o *IdentityCertDecisionSummary) SetRoleDecisionsMade(v int32)` + +SetRoleDecisionsMade sets RoleDecisionsMade field to given value. + +### HasRoleDecisionsMade + +`func (o *IdentityCertDecisionSummary) HasRoleDecisionsMade() bool` + +HasRoleDecisionsMade returns a boolean if a field has been set. + +### GetAccountDecisionsMade + +`func (o *IdentityCertDecisionSummary) GetAccountDecisionsMade() int32` + +GetAccountDecisionsMade returns the AccountDecisionsMade field if non-nil, zero value otherwise. + +### GetAccountDecisionsMadeOk + +`func (o *IdentityCertDecisionSummary) GetAccountDecisionsMadeOk() (*int32, bool)` + +GetAccountDecisionsMadeOk returns a tuple with the AccountDecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountDecisionsMade + +`func (o *IdentityCertDecisionSummary) SetAccountDecisionsMade(v int32)` + +SetAccountDecisionsMade sets AccountDecisionsMade field to given value. + +### HasAccountDecisionsMade + +`func (o *IdentityCertDecisionSummary) HasAccountDecisionsMade() bool` + +HasAccountDecisionsMade returns a boolean if a field has been set. + +### GetEntitlementDecisionsTotal + +`func (o *IdentityCertDecisionSummary) GetEntitlementDecisionsTotal() int32` + +GetEntitlementDecisionsTotal returns the EntitlementDecisionsTotal field if non-nil, zero value otherwise. + +### GetEntitlementDecisionsTotalOk + +`func (o *IdentityCertDecisionSummary) GetEntitlementDecisionsTotalOk() (*int32, bool)` + +GetEntitlementDecisionsTotalOk returns a tuple with the EntitlementDecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementDecisionsTotal + +`func (o *IdentityCertDecisionSummary) SetEntitlementDecisionsTotal(v int32)` + +SetEntitlementDecisionsTotal sets EntitlementDecisionsTotal field to given value. + +### HasEntitlementDecisionsTotal + +`func (o *IdentityCertDecisionSummary) HasEntitlementDecisionsTotal() bool` + +HasEntitlementDecisionsTotal returns a boolean if a field has been set. + +### GetAccessProfileDecisionsTotal + +`func (o *IdentityCertDecisionSummary) GetAccessProfileDecisionsTotal() int32` + +GetAccessProfileDecisionsTotal returns the AccessProfileDecisionsTotal field if non-nil, zero value otherwise. + +### GetAccessProfileDecisionsTotalOk + +`func (o *IdentityCertDecisionSummary) GetAccessProfileDecisionsTotalOk() (*int32, bool)` + +GetAccessProfileDecisionsTotalOk returns a tuple with the AccessProfileDecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileDecisionsTotal + +`func (o *IdentityCertDecisionSummary) SetAccessProfileDecisionsTotal(v int32)` + +SetAccessProfileDecisionsTotal sets AccessProfileDecisionsTotal field to given value. + +### HasAccessProfileDecisionsTotal + +`func (o *IdentityCertDecisionSummary) HasAccessProfileDecisionsTotal() bool` + +HasAccessProfileDecisionsTotal returns a boolean if a field has been set. + +### GetRoleDecisionsTotal + +`func (o *IdentityCertDecisionSummary) GetRoleDecisionsTotal() int32` + +GetRoleDecisionsTotal returns the RoleDecisionsTotal field if non-nil, zero value otherwise. + +### GetRoleDecisionsTotalOk + +`func (o *IdentityCertDecisionSummary) GetRoleDecisionsTotalOk() (*int32, bool)` + +GetRoleDecisionsTotalOk returns a tuple with the RoleDecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleDecisionsTotal + +`func (o *IdentityCertDecisionSummary) SetRoleDecisionsTotal(v int32)` + +SetRoleDecisionsTotal sets RoleDecisionsTotal field to given value. + +### HasRoleDecisionsTotal + +`func (o *IdentityCertDecisionSummary) HasRoleDecisionsTotal() bool` + +HasRoleDecisionsTotal returns a boolean if a field has been set. + +### GetAccountDecisionsTotal + +`func (o *IdentityCertDecisionSummary) GetAccountDecisionsTotal() int32` + +GetAccountDecisionsTotal returns the AccountDecisionsTotal field if non-nil, zero value otherwise. + +### GetAccountDecisionsTotalOk + +`func (o *IdentityCertDecisionSummary) GetAccountDecisionsTotalOk() (*int32, bool)` + +GetAccountDecisionsTotalOk returns a tuple with the AccountDecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountDecisionsTotal + +`func (o *IdentityCertDecisionSummary) SetAccountDecisionsTotal(v int32)` + +SetAccountDecisionsTotal sets AccountDecisionsTotal field to given value. + +### HasAccountDecisionsTotal + +`func (o *IdentityCertDecisionSummary) HasAccountDecisionsTotal() bool` + +HasAccountDecisionsTotal returns a boolean if a field has been set. + +### GetEntitlementsApproved + +`func (o *IdentityCertDecisionSummary) GetEntitlementsApproved() int32` + +GetEntitlementsApproved returns the EntitlementsApproved field if non-nil, zero value otherwise. + +### GetEntitlementsApprovedOk + +`func (o *IdentityCertDecisionSummary) GetEntitlementsApprovedOk() (*int32, bool)` + +GetEntitlementsApprovedOk returns a tuple with the EntitlementsApproved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementsApproved + +`func (o *IdentityCertDecisionSummary) SetEntitlementsApproved(v int32)` + +SetEntitlementsApproved sets EntitlementsApproved field to given value. + +### HasEntitlementsApproved + +`func (o *IdentityCertDecisionSummary) HasEntitlementsApproved() bool` + +HasEntitlementsApproved returns a boolean if a field has been set. + +### GetEntitlementsRevoked + +`func (o *IdentityCertDecisionSummary) GetEntitlementsRevoked() int32` + +GetEntitlementsRevoked returns the EntitlementsRevoked field if non-nil, zero value otherwise. + +### GetEntitlementsRevokedOk + +`func (o *IdentityCertDecisionSummary) GetEntitlementsRevokedOk() (*int32, bool)` + +GetEntitlementsRevokedOk returns a tuple with the EntitlementsRevoked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementsRevoked + +`func (o *IdentityCertDecisionSummary) SetEntitlementsRevoked(v int32)` + +SetEntitlementsRevoked sets EntitlementsRevoked field to given value. + +### HasEntitlementsRevoked + +`func (o *IdentityCertDecisionSummary) HasEntitlementsRevoked() bool` + +HasEntitlementsRevoked returns a boolean if a field has been set. + +### GetAccessProfilesApproved + +`func (o *IdentityCertDecisionSummary) GetAccessProfilesApproved() int32` + +GetAccessProfilesApproved returns the AccessProfilesApproved field if non-nil, zero value otherwise. + +### GetAccessProfilesApprovedOk + +`func (o *IdentityCertDecisionSummary) GetAccessProfilesApprovedOk() (*int32, bool)` + +GetAccessProfilesApprovedOk returns a tuple with the AccessProfilesApproved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfilesApproved + +`func (o *IdentityCertDecisionSummary) SetAccessProfilesApproved(v int32)` + +SetAccessProfilesApproved sets AccessProfilesApproved field to given value. + +### HasAccessProfilesApproved + +`func (o *IdentityCertDecisionSummary) HasAccessProfilesApproved() bool` + +HasAccessProfilesApproved returns a boolean if a field has been set. + +### GetAccessProfilesRevoked + +`func (o *IdentityCertDecisionSummary) GetAccessProfilesRevoked() int32` + +GetAccessProfilesRevoked returns the AccessProfilesRevoked field if non-nil, zero value otherwise. + +### GetAccessProfilesRevokedOk + +`func (o *IdentityCertDecisionSummary) GetAccessProfilesRevokedOk() (*int32, bool)` + +GetAccessProfilesRevokedOk returns a tuple with the AccessProfilesRevoked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfilesRevoked + +`func (o *IdentityCertDecisionSummary) SetAccessProfilesRevoked(v int32)` + +SetAccessProfilesRevoked sets AccessProfilesRevoked field to given value. + +### HasAccessProfilesRevoked + +`func (o *IdentityCertDecisionSummary) HasAccessProfilesRevoked() bool` + +HasAccessProfilesRevoked returns a boolean if a field has been set. + +### GetRolesApproved + +`func (o *IdentityCertDecisionSummary) GetRolesApproved() int32` + +GetRolesApproved returns the RolesApproved field if non-nil, zero value otherwise. + +### GetRolesApprovedOk + +`func (o *IdentityCertDecisionSummary) GetRolesApprovedOk() (*int32, bool)` + +GetRolesApprovedOk returns a tuple with the RolesApproved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRolesApproved + +`func (o *IdentityCertDecisionSummary) SetRolesApproved(v int32)` + +SetRolesApproved sets RolesApproved field to given value. + +### HasRolesApproved + +`func (o *IdentityCertDecisionSummary) HasRolesApproved() bool` + +HasRolesApproved returns a boolean if a field has been set. + +### GetRolesRevoked + +`func (o *IdentityCertDecisionSummary) GetRolesRevoked() int32` + +GetRolesRevoked returns the RolesRevoked field if non-nil, zero value otherwise. + +### GetRolesRevokedOk + +`func (o *IdentityCertDecisionSummary) GetRolesRevokedOk() (*int32, bool)` + +GetRolesRevokedOk returns a tuple with the RolesRevoked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRolesRevoked + +`func (o *IdentityCertDecisionSummary) SetRolesRevoked(v int32)` + +SetRolesRevoked sets RolesRevoked field to given value. + +### HasRolesRevoked + +`func (o *IdentityCertDecisionSummary) HasRolesRevoked() bool` + +HasRolesRevoked returns a boolean if a field has been set. + +### GetAccountsApproved + +`func (o *IdentityCertDecisionSummary) GetAccountsApproved() int32` + +GetAccountsApproved returns the AccountsApproved field if non-nil, zero value otherwise. + +### GetAccountsApprovedOk + +`func (o *IdentityCertDecisionSummary) GetAccountsApprovedOk() (*int32, bool)` + +GetAccountsApprovedOk returns a tuple with the AccountsApproved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountsApproved + +`func (o *IdentityCertDecisionSummary) SetAccountsApproved(v int32)` + +SetAccountsApproved sets AccountsApproved field to given value. + +### HasAccountsApproved + +`func (o *IdentityCertDecisionSummary) HasAccountsApproved() bool` + +HasAccountsApproved returns a boolean if a field has been set. + +### GetAccountsRevoked + +`func (o *IdentityCertDecisionSummary) GetAccountsRevoked() int32` + +GetAccountsRevoked returns the AccountsRevoked field if non-nil, zero value otherwise. + +### GetAccountsRevokedOk + +`func (o *IdentityCertDecisionSummary) GetAccountsRevokedOk() (*int32, bool)` + +GetAccountsRevokedOk returns a tuple with the AccountsRevoked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountsRevoked + +`func (o *IdentityCertDecisionSummary) SetAccountsRevoked(v int32)` + +SetAccountsRevoked sets AccountsRevoked field to given value. + +### HasAccountsRevoked + +`func (o *IdentityCertDecisionSummary) HasAccountsRevoked() bool` + +HasAccountsRevoked returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityCertificationDto.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityCertificationDto.md new file mode 100644 index 000000000..8528b88fc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityCertificationDto.md @@ -0,0 +1,520 @@ +--- +id: v2025-identity-certification-dto +title: IdentityCertificationDto +pagination_label: IdentityCertificationDto +sidebar_label: IdentityCertificationDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCertificationDto', 'V2025IdentityCertificationDto'] +slug: /tools/sdk/go/v2025/models/identity-certification-dto +tags: ['SDK', 'Software Development Kit', 'IdentityCertificationDto', 'V2025IdentityCertificationDto'] +--- + +# IdentityCertificationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | id of the certification | [optional] +**Name** | Pointer to **string** | name of the certification | [optional] +**Campaign** | Pointer to [**CampaignReference**](campaign-reference) | | [optional] +**Completed** | Pointer to **bool** | Have all decisions been made? | [optional] +**IdentitiesCompleted** | Pointer to **int32** | The number of identities for whom all decisions have been made and are complete. | [optional] +**IdentitiesTotal** | Pointer to **int32** | The total number of identities in the Certification, both complete and incomplete. | [optional] +**Created** | Pointer to **SailPointTime** | created date | [optional] +**Modified** | Pointer to **SailPointTime** | modified date | [optional] +**DecisionsMade** | Pointer to **int32** | The number of approve/revoke/acknowledge decisions that have been made. | [optional] +**DecisionsTotal** | Pointer to **int32** | The total number of approve/revoke/acknowledge decisions. | [optional] +**Due** | Pointer to **NullableTime** | The due date of the certification. | [optional] +**Signed** | Pointer to **NullableTime** | The date the reviewer signed off on the Certification. | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] +**Reassignment** | Pointer to [**NullableReassignment**](reassignment) | | [optional] +**HasErrors** | Pointer to **bool** | Identifies if the certification has an error | [optional] +**ErrorMessage** | Pointer to **NullableString** | Description of the certification error | [optional] +**Phase** | Pointer to [**CertificationPhase**](certification-phase) | | [optional] + +## Methods + +### NewIdentityCertificationDto + +`func NewIdentityCertificationDto() *IdentityCertificationDto` + +NewIdentityCertificationDto instantiates a new IdentityCertificationDto 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 + +### NewIdentityCertificationDtoWithDefaults + +`func NewIdentityCertificationDtoWithDefaults() *IdentityCertificationDto` + +NewIdentityCertificationDtoWithDefaults instantiates a new IdentityCertificationDto 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 + +### GetId + +`func (o *IdentityCertificationDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityCertificationDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityCertificationDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityCertificationDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityCertificationDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityCertificationDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityCertificationDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityCertificationDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCampaign + +`func (o *IdentityCertificationDto) GetCampaign() CampaignReference` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *IdentityCertificationDto) GetCampaignOk() (*CampaignReference, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *IdentityCertificationDto) SetCampaign(v CampaignReference)` + +SetCampaign sets Campaign field to given value. + +### HasCampaign + +`func (o *IdentityCertificationDto) HasCampaign() bool` + +HasCampaign returns a boolean if a field has been set. + +### GetCompleted + +`func (o *IdentityCertificationDto) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *IdentityCertificationDto) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *IdentityCertificationDto) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *IdentityCertificationDto) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetIdentitiesCompleted + +`func (o *IdentityCertificationDto) GetIdentitiesCompleted() int32` + +GetIdentitiesCompleted returns the IdentitiesCompleted field if non-nil, zero value otherwise. + +### GetIdentitiesCompletedOk + +`func (o *IdentityCertificationDto) GetIdentitiesCompletedOk() (*int32, bool)` + +GetIdentitiesCompletedOk returns a tuple with the IdentitiesCompleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesCompleted + +`func (o *IdentityCertificationDto) SetIdentitiesCompleted(v int32)` + +SetIdentitiesCompleted sets IdentitiesCompleted field to given value. + +### HasIdentitiesCompleted + +`func (o *IdentityCertificationDto) HasIdentitiesCompleted() bool` + +HasIdentitiesCompleted returns a boolean if a field has been set. + +### GetIdentitiesTotal + +`func (o *IdentityCertificationDto) GetIdentitiesTotal() int32` + +GetIdentitiesTotal returns the IdentitiesTotal field if non-nil, zero value otherwise. + +### GetIdentitiesTotalOk + +`func (o *IdentityCertificationDto) GetIdentitiesTotalOk() (*int32, bool)` + +GetIdentitiesTotalOk returns a tuple with the IdentitiesTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesTotal + +`func (o *IdentityCertificationDto) SetIdentitiesTotal(v int32)` + +SetIdentitiesTotal sets IdentitiesTotal field to given value. + +### HasIdentitiesTotal + +`func (o *IdentityCertificationDto) HasIdentitiesTotal() bool` + +HasIdentitiesTotal returns a boolean if a field has been set. + +### GetCreated + +`func (o *IdentityCertificationDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *IdentityCertificationDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *IdentityCertificationDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *IdentityCertificationDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *IdentityCertificationDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *IdentityCertificationDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *IdentityCertificationDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *IdentityCertificationDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDecisionsMade + +`func (o *IdentityCertificationDto) GetDecisionsMade() int32` + +GetDecisionsMade returns the DecisionsMade field if non-nil, zero value otherwise. + +### GetDecisionsMadeOk + +`func (o *IdentityCertificationDto) GetDecisionsMadeOk() (*int32, bool)` + +GetDecisionsMadeOk returns a tuple with the DecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsMade + +`func (o *IdentityCertificationDto) SetDecisionsMade(v int32)` + +SetDecisionsMade sets DecisionsMade field to given value. + +### HasDecisionsMade + +`func (o *IdentityCertificationDto) HasDecisionsMade() bool` + +HasDecisionsMade returns a boolean if a field has been set. + +### GetDecisionsTotal + +`func (o *IdentityCertificationDto) GetDecisionsTotal() int32` + +GetDecisionsTotal returns the DecisionsTotal field if non-nil, zero value otherwise. + +### GetDecisionsTotalOk + +`func (o *IdentityCertificationDto) GetDecisionsTotalOk() (*int32, bool)` + +GetDecisionsTotalOk returns a tuple with the DecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsTotal + +`func (o *IdentityCertificationDto) SetDecisionsTotal(v int32)` + +SetDecisionsTotal sets DecisionsTotal field to given value. + +### HasDecisionsTotal + +`func (o *IdentityCertificationDto) HasDecisionsTotal() bool` + +HasDecisionsTotal returns a boolean if a field has been set. + +### GetDue + +`func (o *IdentityCertificationDto) GetDue() SailPointTime` + +GetDue returns the Due field if non-nil, zero value otherwise. + +### GetDueOk + +`func (o *IdentityCertificationDto) GetDueOk() (*SailPointTime, bool)` + +GetDueOk returns a tuple with the Due field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDue + +`func (o *IdentityCertificationDto) SetDue(v SailPointTime)` + +SetDue sets Due field to given value. + +### HasDue + +`func (o *IdentityCertificationDto) HasDue() bool` + +HasDue returns a boolean if a field has been set. + +### SetDueNil + +`func (o *IdentityCertificationDto) SetDueNil(b bool)` + + SetDueNil sets the value for Due to be an explicit nil + +### UnsetDue +`func (o *IdentityCertificationDto) UnsetDue()` + +UnsetDue ensures that no value is present for Due, not even an explicit nil +### GetSigned + +`func (o *IdentityCertificationDto) GetSigned() SailPointTime` + +GetSigned returns the Signed field if non-nil, zero value otherwise. + +### GetSignedOk + +`func (o *IdentityCertificationDto) GetSignedOk() (*SailPointTime, bool)` + +GetSignedOk returns a tuple with the Signed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigned + +`func (o *IdentityCertificationDto) SetSigned(v SailPointTime)` + +SetSigned sets Signed field to given value. + +### HasSigned + +`func (o *IdentityCertificationDto) HasSigned() bool` + +HasSigned returns a boolean if a field has been set. + +### SetSignedNil + +`func (o *IdentityCertificationDto) SetSignedNil(b bool)` + + SetSignedNil sets the value for Signed to be an explicit nil + +### UnsetSigned +`func (o *IdentityCertificationDto) UnsetSigned()` + +UnsetSigned ensures that no value is present for Signed, not even an explicit nil +### GetReviewer + +`func (o *IdentityCertificationDto) GetReviewer() Reviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *IdentityCertificationDto) GetReviewerOk() (*Reviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *IdentityCertificationDto) SetReviewer(v Reviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *IdentityCertificationDto) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetReassignment + +`func (o *IdentityCertificationDto) GetReassignment() Reassignment` + +GetReassignment returns the Reassignment field if non-nil, zero value otherwise. + +### GetReassignmentOk + +`func (o *IdentityCertificationDto) GetReassignmentOk() (*Reassignment, bool)` + +GetReassignmentOk returns a tuple with the Reassignment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignment + +`func (o *IdentityCertificationDto) SetReassignment(v Reassignment)` + +SetReassignment sets Reassignment field to given value. + +### HasReassignment + +`func (o *IdentityCertificationDto) HasReassignment() bool` + +HasReassignment returns a boolean if a field has been set. + +### SetReassignmentNil + +`func (o *IdentityCertificationDto) SetReassignmentNil(b bool)` + + SetReassignmentNil sets the value for Reassignment to be an explicit nil + +### UnsetReassignment +`func (o *IdentityCertificationDto) UnsetReassignment()` + +UnsetReassignment ensures that no value is present for Reassignment, not even an explicit nil +### GetHasErrors + +`func (o *IdentityCertificationDto) GetHasErrors() bool` + +GetHasErrors returns the HasErrors field if non-nil, zero value otherwise. + +### GetHasErrorsOk + +`func (o *IdentityCertificationDto) GetHasErrorsOk() (*bool, bool)` + +GetHasErrorsOk returns a tuple with the HasErrors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasErrors + +`func (o *IdentityCertificationDto) SetHasErrors(v bool)` + +SetHasErrors sets HasErrors field to given value. + +### HasHasErrors + +`func (o *IdentityCertificationDto) HasHasErrors() bool` + +HasHasErrors returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *IdentityCertificationDto) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *IdentityCertificationDto) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *IdentityCertificationDto) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *IdentityCertificationDto) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### SetErrorMessageNil + +`func (o *IdentityCertificationDto) SetErrorMessageNil(b bool)` + + SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil + +### UnsetErrorMessage +`func (o *IdentityCertificationDto) UnsetErrorMessage()` + +UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil +### GetPhase + +`func (o *IdentityCertificationDto) GetPhase() CertificationPhase` + +GetPhase returns the Phase field if non-nil, zero value otherwise. + +### GetPhaseOk + +`func (o *IdentityCertificationDto) GetPhaseOk() (*CertificationPhase, bool)` + +GetPhaseOk returns a tuple with the Phase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhase + +`func (o *IdentityCertificationDto) SetPhase(v CertificationPhase)` + +SetPhase sets Phase field to given value. + +### HasPhase + +`func (o *IdentityCertificationDto) HasPhase() bool` + +HasPhase returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityCertified.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityCertified.md new file mode 100644 index 000000000..a12d19357 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityCertified.md @@ -0,0 +1,246 @@ +--- +id: v2025-identity-certified +title: IdentityCertified +pagination_label: IdentityCertified +sidebar_label: IdentityCertified +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCertified', 'V2025IdentityCertified'] +slug: /tools/sdk/go/v2025/models/identity-certified +tags: ['SDK', 'Software Development Kit', 'IdentityCertified', 'V2025IdentityCertified'] +--- + +# IdentityCertified + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CertificationId** | Pointer to **string** | the id of the certification item | [optional] +**CertificationName** | Pointer to **string** | the certification item name | [optional] +**SignedDate** | Pointer to **string** | the date ceritification was signed | [optional] +**Certifiers** | Pointer to [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional] +**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional] +**Signer** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] +**EventType** | Pointer to **string** | the event type | [optional] +**Dt** | Pointer to **string** | the date of event | [optional] + +## Methods + +### NewIdentityCertified + +`func NewIdentityCertified() *IdentityCertified` + +NewIdentityCertified instantiates a new IdentityCertified 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 + +### NewIdentityCertifiedWithDefaults + +`func NewIdentityCertifiedWithDefaults() *IdentityCertified` + +NewIdentityCertifiedWithDefaults instantiates a new IdentityCertified 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 + +### GetCertificationId + +`func (o *IdentityCertified) GetCertificationId() string` + +GetCertificationId returns the CertificationId field if non-nil, zero value otherwise. + +### GetCertificationIdOk + +`func (o *IdentityCertified) GetCertificationIdOk() (*string, bool)` + +GetCertificationIdOk returns a tuple with the CertificationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationId + +`func (o *IdentityCertified) SetCertificationId(v string)` + +SetCertificationId sets CertificationId field to given value. + +### HasCertificationId + +`func (o *IdentityCertified) HasCertificationId() bool` + +HasCertificationId returns a boolean if a field has been set. + +### GetCertificationName + +`func (o *IdentityCertified) GetCertificationName() string` + +GetCertificationName returns the CertificationName field if non-nil, zero value otherwise. + +### GetCertificationNameOk + +`func (o *IdentityCertified) GetCertificationNameOk() (*string, bool)` + +GetCertificationNameOk returns a tuple with the CertificationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationName + +`func (o *IdentityCertified) SetCertificationName(v string)` + +SetCertificationName sets CertificationName field to given value. + +### HasCertificationName + +`func (o *IdentityCertified) HasCertificationName() bool` + +HasCertificationName returns a boolean if a field has been set. + +### GetSignedDate + +`func (o *IdentityCertified) GetSignedDate() string` + +GetSignedDate returns the SignedDate field if non-nil, zero value otherwise. + +### GetSignedDateOk + +`func (o *IdentityCertified) GetSignedDateOk() (*string, bool)` + +GetSignedDateOk returns a tuple with the SignedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignedDate + +`func (o *IdentityCertified) SetSignedDate(v string)` + +SetSignedDate sets SignedDate field to given value. + +### HasSignedDate + +`func (o *IdentityCertified) HasSignedDate() bool` + +HasSignedDate returns a boolean if a field has been set. + +### GetCertifiers + +`func (o *IdentityCertified) GetCertifiers() []CertifierResponse` + +GetCertifiers returns the Certifiers field if non-nil, zero value otherwise. + +### GetCertifiersOk + +`func (o *IdentityCertified) GetCertifiersOk() (*[]CertifierResponse, bool)` + +GetCertifiersOk returns a tuple with the Certifiers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertifiers + +`func (o *IdentityCertified) SetCertifiers(v []CertifierResponse)` + +SetCertifiers sets Certifiers field to given value. + +### HasCertifiers + +`func (o *IdentityCertified) HasCertifiers() bool` + +HasCertifiers returns a boolean if a field has been set. + +### GetReviewers + +`func (o *IdentityCertified) GetReviewers() []CertifierResponse` + +GetReviewers returns the Reviewers field if non-nil, zero value otherwise. + +### GetReviewersOk + +`func (o *IdentityCertified) GetReviewersOk() (*[]CertifierResponse, bool)` + +GetReviewersOk returns a tuple with the Reviewers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewers + +`func (o *IdentityCertified) SetReviewers(v []CertifierResponse)` + +SetReviewers sets Reviewers field to given value. + +### HasReviewers + +`func (o *IdentityCertified) HasReviewers() bool` + +HasReviewers returns a boolean if a field has been set. + +### GetSigner + +`func (o *IdentityCertified) GetSigner() CertifierResponse` + +GetSigner returns the Signer field if non-nil, zero value otherwise. + +### GetSignerOk + +`func (o *IdentityCertified) GetSignerOk() (*CertifierResponse, bool)` + +GetSignerOk returns a tuple with the Signer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigner + +`func (o *IdentityCertified) SetSigner(v CertifierResponse)` + +SetSigner sets Signer field to given value. + +### HasSigner + +`func (o *IdentityCertified) HasSigner() bool` + +HasSigner returns a boolean if a field has been set. + +### GetEventType + +`func (o *IdentityCertified) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *IdentityCertified) GetEventTypeOk() (*string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventType + +`func (o *IdentityCertified) SetEventType(v string)` + +SetEventType sets EventType field to given value. + +### HasEventType + +`func (o *IdentityCertified) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### GetDt + +`func (o *IdentityCertified) GetDt() string` + +GetDt returns the Dt field if non-nil, zero value otherwise. + +### GetDtOk + +`func (o *IdentityCertified) GetDtOk() (*string, bool)` + +GetDtOk returns a tuple with the Dt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDt + +`func (o *IdentityCertified) SetDt(v string)` + +SetDt sets Dt field to given value. + +### HasDt + +`func (o *IdentityCertified) HasDt() bool` + +HasDt returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityCompareResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityCompareResponse.md new file mode 100644 index 000000000..41ad79b4f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityCompareResponse.md @@ -0,0 +1,64 @@ +--- +id: v2025-identity-compare-response +title: IdentityCompareResponse +pagination_label: IdentityCompareResponse +sidebar_label: IdentityCompareResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCompareResponse', 'V2025IdentityCompareResponse'] +slug: /tools/sdk/go/v2025/models/identity-compare-response +tags: ['SDK', 'Software Development Kit', 'IdentityCompareResponse', 'V2025IdentityCompareResponse'] +--- + +# IdentityCompareResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItemDiff** | Pointer to **map[string]map[string]interface{}** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] + +## Methods + +### NewIdentityCompareResponse + +`func NewIdentityCompareResponse() *IdentityCompareResponse` + +NewIdentityCompareResponse instantiates a new IdentityCompareResponse 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 + +### NewIdentityCompareResponseWithDefaults + +`func NewIdentityCompareResponseWithDefaults() *IdentityCompareResponse` + +NewIdentityCompareResponseWithDefaults instantiates a new IdentityCompareResponse 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 + +### GetAccessItemDiff + +`func (o *IdentityCompareResponse) GetAccessItemDiff() map[string]map[string]interface{}` + +GetAccessItemDiff returns the AccessItemDiff field if non-nil, zero value otherwise. + +### GetAccessItemDiffOk + +`func (o *IdentityCompareResponse) GetAccessItemDiffOk() (*map[string]map[string]interface{}, bool)` + +GetAccessItemDiffOk returns a tuple with the AccessItemDiff field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItemDiff + +`func (o *IdentityCompareResponse) SetAccessItemDiff(v map[string]map[string]interface{})` + +SetAccessItemDiff sets AccessItemDiff field to given value. + +### HasAccessItemDiff + +`func (o *IdentityCompareResponse) HasAccessItemDiff() bool` + +HasAccessItemDiff returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityCreated.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityCreated.md new file mode 100644 index 000000000..79ed37d0b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityCreated.md @@ -0,0 +1,80 @@ +--- +id: v2025-identity-created +title: IdentityCreated +pagination_label: IdentityCreated +sidebar_label: IdentityCreated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCreated', 'V2025IdentityCreated'] +slug: /tools/sdk/go/v2025/models/identity-created +tags: ['SDK', 'Software Development Kit', 'IdentityCreated', 'V2025IdentityCreated'] +--- + +# IdentityCreated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**IdentityCreatedIdentity**](identity-created-identity) | | +**Attributes** | **map[string]interface{}** | The attributes assigned to the identity. Attributes are determined by the identity profile. | + +## Methods + +### NewIdentityCreated + +`func NewIdentityCreated(identity IdentityCreatedIdentity, attributes map[string]interface{}, ) *IdentityCreated` + +NewIdentityCreated instantiates a new IdentityCreated 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 + +### NewIdentityCreatedWithDefaults + +`func NewIdentityCreatedWithDefaults() *IdentityCreated` + +NewIdentityCreatedWithDefaults instantiates a new IdentityCreated 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 + +### GetIdentity + +`func (o *IdentityCreated) GetIdentity() IdentityCreatedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *IdentityCreated) GetIdentityOk() (*IdentityCreatedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *IdentityCreated) SetIdentity(v IdentityCreatedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetAttributes + +`func (o *IdentityCreated) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *IdentityCreated) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *IdentityCreated) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityCreatedIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityCreatedIdentity.md new file mode 100644 index 000000000..b9079c56f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityCreatedIdentity.md @@ -0,0 +1,101 @@ +--- +id: v2025-identity-created-identity +title: IdentityCreatedIdentity +pagination_label: IdentityCreatedIdentity +sidebar_label: IdentityCreatedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCreatedIdentity', 'V2025IdentityCreatedIdentity'] +slug: /tools/sdk/go/v2025/models/identity-created-identity +tags: ['SDK', 'Software Development Kit', 'IdentityCreatedIdentity', 'V2025IdentityCreatedIdentity'] +--- + +# IdentityCreatedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Created identity's DTO type. | +**Id** | **string** | Created identity ID. | +**Name** | **string** | Created identity's display name. | + +## Methods + +### NewIdentityCreatedIdentity + +`func NewIdentityCreatedIdentity(type_ string, id string, name string, ) *IdentityCreatedIdentity` + +NewIdentityCreatedIdentity instantiates a new IdentityCreatedIdentity 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 + +### NewIdentityCreatedIdentityWithDefaults + +`func NewIdentityCreatedIdentityWithDefaults() *IdentityCreatedIdentity` + +NewIdentityCreatedIdentityWithDefaults instantiates a new IdentityCreatedIdentity 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 + +### GetType + +`func (o *IdentityCreatedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityCreatedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityCreatedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *IdentityCreatedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityCreatedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityCreatedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *IdentityCreatedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityCreatedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityCreatedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityDeleted.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityDeleted.md new file mode 100644 index 000000000..db7371e77 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityDeleted.md @@ -0,0 +1,80 @@ +--- +id: v2025-identity-deleted +title: IdentityDeleted +pagination_label: IdentityDeleted +sidebar_label: IdentityDeleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDeleted', 'V2025IdentityDeleted'] +slug: /tools/sdk/go/v2025/models/identity-deleted +tags: ['SDK', 'Software Development Kit', 'IdentityDeleted', 'V2025IdentityDeleted'] +--- + +# IdentityDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | +**Attributes** | **map[string]interface{}** | The attributes assigned to the identity. Attributes are determined by the identity profile. | + +## Methods + +### NewIdentityDeleted + +`func NewIdentityDeleted(identity IdentityDeletedIdentity, attributes map[string]interface{}, ) *IdentityDeleted` + +NewIdentityDeleted instantiates a new IdentityDeleted 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 + +### NewIdentityDeletedWithDefaults + +`func NewIdentityDeletedWithDefaults() *IdentityDeleted` + +NewIdentityDeletedWithDefaults instantiates a new IdentityDeleted 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 + +### GetIdentity + +`func (o *IdentityDeleted) GetIdentity() IdentityDeletedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *IdentityDeleted) GetIdentityOk() (*IdentityDeletedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *IdentityDeleted) SetIdentity(v IdentityDeletedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetAttributes + +`func (o *IdentityDeleted) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *IdentityDeleted) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *IdentityDeleted) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityDeletedIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityDeletedIdentity.md new file mode 100644 index 000000000..b15983eb1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityDeletedIdentity.md @@ -0,0 +1,101 @@ +--- +id: v2025-identity-deleted-identity +title: IdentityDeletedIdentity +pagination_label: IdentityDeletedIdentity +sidebar_label: IdentityDeletedIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDeletedIdentity', 'V2025IdentityDeletedIdentity'] +slug: /tools/sdk/go/v2025/models/identity-deleted-identity +tags: ['SDK', 'Software Development Kit', 'IdentityDeletedIdentity', 'V2025IdentityDeletedIdentity'] +--- + +# IdentityDeletedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Deleted identity's DTO type. | +**Id** | **string** | Deleted identity ID. | +**Name** | **string** | Deleted identity's display name. | + +## Methods + +### NewIdentityDeletedIdentity + +`func NewIdentityDeletedIdentity(type_ string, id string, name string, ) *IdentityDeletedIdentity` + +NewIdentityDeletedIdentity instantiates a new IdentityDeletedIdentity 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 + +### NewIdentityDeletedIdentityWithDefaults + +`func NewIdentityDeletedIdentityWithDefaults() *IdentityDeletedIdentity` + +NewIdentityDeletedIdentityWithDefaults instantiates a new IdentityDeletedIdentity 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 + +### GetType + +`func (o *IdentityDeletedIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityDeletedIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityDeletedIdentity) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *IdentityDeletedIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityDeletedIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityDeletedIdentity) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *IdentityDeletedIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityDeletedIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityDeletedIdentity) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityDocument.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityDocument.md new file mode 100644 index 000000000..4a916e413 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityDocument.md @@ -0,0 +1,1066 @@ +--- +id: v2025-identity-document +title: IdentityDocument +pagination_label: IdentityDocument +sidebar_label: IdentityDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDocument', 'V2025IdentityDocument'] +slug: /tools/sdk/go/v2025/models/identity-document +tags: ['SDK', 'Software Development Kit', 'IdentityDocument', 'V2025IdentityDocument'] +--- + +# IdentityDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the referenced object. | +**Name** | **string** | The human readable name of the referenced object. | +**DisplayName** | Pointer to **string** | Identity's display name. | [optional] +**FirstName** | Pointer to **string** | Identity's first name. | [optional] +**LastName** | Pointer to **string** | Identity's last name. | [optional] +**Email** | Pointer to **string** | Identity's primary email address. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Phone** | Pointer to **string** | Identity's phone number. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Inactive** | Pointer to **bool** | Indicates whether the identity is inactive. | [optional] [default to false] +**Protected** | Pointer to **bool** | Indicates whether the identity is protected. | [optional] [default to false] +**Status** | Pointer to **string** | Identity's status in SailPoint. | [optional] +**EmployeeNumber** | Pointer to **string** | Identity's employee number. | [optional] +**Manager** | Pointer to [**NullableIdentityDocumentAllOfManager**](identity-document-all-of-manager) | | [optional] +**IsManager** | Pointer to **bool** | Indicates whether the identity is a manager of other identities. | [optional] +**IdentityProfile** | Pointer to [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional] +**Source** | Pointer to [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Map or dictionary of key/value pairs. | [optional] +**Disabled** | Pointer to **bool** | Indicates whether the identity is disabled. | [optional] [default to false] +**Locked** | Pointer to **bool** | Indicates whether the identity is locked. | [optional] [default to false] +**ProcessingState** | Pointer to **NullableString** | Identity's processing state. | [optional] +**ProcessingDetails** | Pointer to [**ProcessingDetails**](processing-details) | | [optional] +**Accounts** | Pointer to [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional] +**AccountCount** | Pointer to **int32** | Number of accounts associated with the identity. | [optional] +**Apps** | Pointer to [**[]App**](app) | List of applications the identity has access to. | [optional] +**AppCount** | Pointer to **int32** | Number of applications the identity has access to. | [optional] +**Access** | Pointer to [**[]IdentityAccess**](identity-access) | List of access items assigned to the identity. | [optional] +**AccessCount** | Pointer to **int32** | Number of access items assigned to the identity. | [optional] +**EntitlementCount** | Pointer to **int32** | Number of entitlements assigned to the identity. | [optional] +**RoleCount** | Pointer to **int32** | Number of roles assigned to the identity. | [optional] +**AccessProfileCount** | Pointer to **int32** | Number of access profiles assigned to the identity. | [optional] +**Owns** | Pointer to [**[]Owns**](owns) | Access items the identity owns. | [optional] +**OwnsCount** | Pointer to **int32** | Number of access items the identity owns. | [optional] +**Tags** | Pointer to **[]string** | Tags that have been applied to the object. | [optional] +**TagsCount** | Pointer to **int32** | Number of tags on the identity. | [optional] +**VisibleSegments** | Pointer to **[]string** | List of segments that the identity is in. | [optional] +**VisibleSegmentCount** | Pointer to **int32** | Number of segments the identity is in. | [optional] + +## Methods + +### NewIdentityDocument + +`func NewIdentityDocument(id string, name string, ) *IdentityDocument` + +NewIdentityDocument instantiates a new IdentityDocument 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 + +### NewIdentityDocumentWithDefaults + +`func NewIdentityDocumentWithDefaults() *IdentityDocument` + +NewIdentityDocumentWithDefaults instantiates a new IdentityDocument 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 + +### GetId + +`func (o *IdentityDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityDocument) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *IdentityDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityDocument) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDisplayName + +`func (o *IdentityDocument) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityDocument) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityDocument) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityDocument) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *IdentityDocument) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *IdentityDocument) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *IdentityDocument) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *IdentityDocument) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### GetLastName + +`func (o *IdentityDocument) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *IdentityDocument) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *IdentityDocument) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *IdentityDocument) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### GetEmail + +`func (o *IdentityDocument) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *IdentityDocument) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *IdentityDocument) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *IdentityDocument) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetCreated + +`func (o *IdentityDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *IdentityDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *IdentityDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *IdentityDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *IdentityDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *IdentityDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *IdentityDocument) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *IdentityDocument) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *IdentityDocument) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *IdentityDocument) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *IdentityDocument) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *IdentityDocument) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetPhone + +`func (o *IdentityDocument) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *IdentityDocument) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *IdentityDocument) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *IdentityDocument) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### GetSynced + +`func (o *IdentityDocument) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *IdentityDocument) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *IdentityDocument) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *IdentityDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetInactive + +`func (o *IdentityDocument) GetInactive() bool` + +GetInactive returns the Inactive field if non-nil, zero value otherwise. + +### GetInactiveOk + +`func (o *IdentityDocument) GetInactiveOk() (*bool, bool)` + +GetInactiveOk returns a tuple with the Inactive field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInactive + +`func (o *IdentityDocument) SetInactive(v bool)` + +SetInactive sets Inactive field to given value. + +### HasInactive + +`func (o *IdentityDocument) HasInactive() bool` + +HasInactive returns a boolean if a field has been set. + +### GetProtected + +`func (o *IdentityDocument) GetProtected() bool` + +GetProtected returns the Protected field if non-nil, zero value otherwise. + +### GetProtectedOk + +`func (o *IdentityDocument) GetProtectedOk() (*bool, bool)` + +GetProtectedOk returns a tuple with the Protected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProtected + +`func (o *IdentityDocument) SetProtected(v bool)` + +SetProtected sets Protected field to given value. + +### HasProtected + +`func (o *IdentityDocument) HasProtected() bool` + +HasProtected returns a boolean if a field has been set. + +### GetStatus + +`func (o *IdentityDocument) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *IdentityDocument) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *IdentityDocument) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *IdentityDocument) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetEmployeeNumber + +`func (o *IdentityDocument) GetEmployeeNumber() string` + +GetEmployeeNumber returns the EmployeeNumber field if non-nil, zero value otherwise. + +### GetEmployeeNumberOk + +`func (o *IdentityDocument) GetEmployeeNumberOk() (*string, bool)` + +GetEmployeeNumberOk returns a tuple with the EmployeeNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmployeeNumber + +`func (o *IdentityDocument) SetEmployeeNumber(v string)` + +SetEmployeeNumber sets EmployeeNumber field to given value. + +### HasEmployeeNumber + +`func (o *IdentityDocument) HasEmployeeNumber() bool` + +HasEmployeeNumber returns a boolean if a field has been set. + +### GetManager + +`func (o *IdentityDocument) GetManager() IdentityDocumentAllOfManager` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *IdentityDocument) GetManagerOk() (*IdentityDocumentAllOfManager, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *IdentityDocument) SetManager(v IdentityDocumentAllOfManager)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *IdentityDocument) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### SetManagerNil + +`func (o *IdentityDocument) SetManagerNil(b bool)` + + SetManagerNil sets the value for Manager to be an explicit nil + +### UnsetManager +`func (o *IdentityDocument) UnsetManager()` + +UnsetManager ensures that no value is present for Manager, not even an explicit nil +### GetIsManager + +`func (o *IdentityDocument) GetIsManager() bool` + +GetIsManager returns the IsManager field if non-nil, zero value otherwise. + +### GetIsManagerOk + +`func (o *IdentityDocument) GetIsManagerOk() (*bool, bool)` + +GetIsManagerOk returns a tuple with the IsManager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsManager + +`func (o *IdentityDocument) SetIsManager(v bool)` + +SetIsManager sets IsManager field to given value. + +### HasIsManager + +`func (o *IdentityDocument) HasIsManager() bool` + +HasIsManager returns a boolean if a field has been set. + +### GetIdentityProfile + +`func (o *IdentityDocument) GetIdentityProfile() IdentityDocumentAllOfIdentityProfile` + +GetIdentityProfile returns the IdentityProfile field if non-nil, zero value otherwise. + +### GetIdentityProfileOk + +`func (o *IdentityDocument) GetIdentityProfileOk() (*IdentityDocumentAllOfIdentityProfile, bool)` + +GetIdentityProfileOk returns a tuple with the IdentityProfile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityProfile + +`func (o *IdentityDocument) SetIdentityProfile(v IdentityDocumentAllOfIdentityProfile)` + +SetIdentityProfile sets IdentityProfile field to given value. + +### HasIdentityProfile + +`func (o *IdentityDocument) HasIdentityProfile() bool` + +HasIdentityProfile returns a boolean if a field has been set. + +### GetSource + +`func (o *IdentityDocument) GetSource() IdentityDocumentAllOfSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *IdentityDocument) GetSourceOk() (*IdentityDocumentAllOfSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *IdentityDocument) SetSource(v IdentityDocumentAllOfSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *IdentityDocument) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAttributes + +`func (o *IdentityDocument) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *IdentityDocument) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *IdentityDocument) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *IdentityDocument) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetDisabled + +`func (o *IdentityDocument) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *IdentityDocument) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *IdentityDocument) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *IdentityDocument) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetLocked + +`func (o *IdentityDocument) GetLocked() bool` + +GetLocked returns the Locked field if non-nil, zero value otherwise. + +### GetLockedOk + +`func (o *IdentityDocument) GetLockedOk() (*bool, bool)` + +GetLockedOk returns a tuple with the Locked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocked + +`func (o *IdentityDocument) SetLocked(v bool)` + +SetLocked sets Locked field to given value. + +### HasLocked + +`func (o *IdentityDocument) HasLocked() bool` + +HasLocked returns a boolean if a field has been set. + +### GetProcessingState + +`func (o *IdentityDocument) GetProcessingState() string` + +GetProcessingState returns the ProcessingState field if non-nil, zero value otherwise. + +### GetProcessingStateOk + +`func (o *IdentityDocument) GetProcessingStateOk() (*string, bool)` + +GetProcessingStateOk returns a tuple with the ProcessingState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessingState + +`func (o *IdentityDocument) SetProcessingState(v string)` + +SetProcessingState sets ProcessingState field to given value. + +### HasProcessingState + +`func (o *IdentityDocument) HasProcessingState() bool` + +HasProcessingState returns a boolean if a field has been set. + +### SetProcessingStateNil + +`func (o *IdentityDocument) SetProcessingStateNil(b bool)` + + SetProcessingStateNil sets the value for ProcessingState to be an explicit nil + +### UnsetProcessingState +`func (o *IdentityDocument) UnsetProcessingState()` + +UnsetProcessingState ensures that no value is present for ProcessingState, not even an explicit nil +### GetProcessingDetails + +`func (o *IdentityDocument) GetProcessingDetails() ProcessingDetails` + +GetProcessingDetails returns the ProcessingDetails field if non-nil, zero value otherwise. + +### GetProcessingDetailsOk + +`func (o *IdentityDocument) GetProcessingDetailsOk() (*ProcessingDetails, bool)` + +GetProcessingDetailsOk returns a tuple with the ProcessingDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessingDetails + +`func (o *IdentityDocument) SetProcessingDetails(v ProcessingDetails)` + +SetProcessingDetails sets ProcessingDetails field to given value. + +### HasProcessingDetails + +`func (o *IdentityDocument) HasProcessingDetails() bool` + +HasProcessingDetails returns a boolean if a field has been set. + +### GetAccounts + +`func (o *IdentityDocument) GetAccounts() []BaseAccount` + +GetAccounts returns the Accounts field if non-nil, zero value otherwise. + +### GetAccountsOk + +`func (o *IdentityDocument) GetAccountsOk() (*[]BaseAccount, bool)` + +GetAccountsOk returns a tuple with the Accounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccounts + +`func (o *IdentityDocument) SetAccounts(v []BaseAccount)` + +SetAccounts sets Accounts field to given value. + +### HasAccounts + +`func (o *IdentityDocument) HasAccounts() bool` + +HasAccounts returns a boolean if a field has been set. + +### GetAccountCount + +`func (o *IdentityDocument) GetAccountCount() int32` + +GetAccountCount returns the AccountCount field if non-nil, zero value otherwise. + +### GetAccountCountOk + +`func (o *IdentityDocument) GetAccountCountOk() (*int32, bool)` + +GetAccountCountOk returns a tuple with the AccountCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCount + +`func (o *IdentityDocument) SetAccountCount(v int32)` + +SetAccountCount sets AccountCount field to given value. + +### HasAccountCount + +`func (o *IdentityDocument) HasAccountCount() bool` + +HasAccountCount returns a boolean if a field has been set. + +### GetApps + +`func (o *IdentityDocument) GetApps() []App` + +GetApps returns the Apps field if non-nil, zero value otherwise. + +### GetAppsOk + +`func (o *IdentityDocument) GetAppsOk() (*[]App, bool)` + +GetAppsOk returns a tuple with the Apps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApps + +`func (o *IdentityDocument) SetApps(v []App)` + +SetApps sets Apps field to given value. + +### HasApps + +`func (o *IdentityDocument) HasApps() bool` + +HasApps returns a boolean if a field has been set. + +### GetAppCount + +`func (o *IdentityDocument) GetAppCount() int32` + +GetAppCount returns the AppCount field if non-nil, zero value otherwise. + +### GetAppCountOk + +`func (o *IdentityDocument) GetAppCountOk() (*int32, bool)` + +GetAppCountOk returns a tuple with the AppCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppCount + +`func (o *IdentityDocument) SetAppCount(v int32)` + +SetAppCount sets AppCount field to given value. + +### HasAppCount + +`func (o *IdentityDocument) HasAppCount() bool` + +HasAppCount returns a boolean if a field has been set. + +### GetAccess + +`func (o *IdentityDocument) GetAccess() []IdentityAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *IdentityDocument) GetAccessOk() (*[]IdentityAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *IdentityDocument) SetAccess(v []IdentityAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *IdentityDocument) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetAccessCount + +`func (o *IdentityDocument) GetAccessCount() int32` + +GetAccessCount returns the AccessCount field if non-nil, zero value otherwise. + +### GetAccessCountOk + +`func (o *IdentityDocument) GetAccessCountOk() (*int32, bool)` + +GetAccessCountOk returns a tuple with the AccessCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessCount + +`func (o *IdentityDocument) SetAccessCount(v int32)` + +SetAccessCount sets AccessCount field to given value. + +### HasAccessCount + +`func (o *IdentityDocument) HasAccessCount() bool` + +HasAccessCount returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *IdentityDocument) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *IdentityDocument) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *IdentityDocument) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *IdentityDocument) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetRoleCount + +`func (o *IdentityDocument) GetRoleCount() int32` + +GetRoleCount returns the RoleCount field if non-nil, zero value otherwise. + +### GetRoleCountOk + +`func (o *IdentityDocument) GetRoleCountOk() (*int32, bool)` + +GetRoleCountOk returns a tuple with the RoleCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleCount + +`func (o *IdentityDocument) SetRoleCount(v int32)` + +SetRoleCount sets RoleCount field to given value. + +### HasRoleCount + +`func (o *IdentityDocument) HasRoleCount() bool` + +HasRoleCount returns a boolean if a field has been set. + +### GetAccessProfileCount + +`func (o *IdentityDocument) GetAccessProfileCount() int32` + +GetAccessProfileCount returns the AccessProfileCount field if non-nil, zero value otherwise. + +### GetAccessProfileCountOk + +`func (o *IdentityDocument) GetAccessProfileCountOk() (*int32, bool)` + +GetAccessProfileCountOk returns a tuple with the AccessProfileCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileCount + +`func (o *IdentityDocument) SetAccessProfileCount(v int32)` + +SetAccessProfileCount sets AccessProfileCount field to given value. + +### HasAccessProfileCount + +`func (o *IdentityDocument) HasAccessProfileCount() bool` + +HasAccessProfileCount returns a boolean if a field has been set. + +### GetOwns + +`func (o *IdentityDocument) GetOwns() []Owns` + +GetOwns returns the Owns field if non-nil, zero value otherwise. + +### GetOwnsOk + +`func (o *IdentityDocument) GetOwnsOk() (*[]Owns, bool)` + +GetOwnsOk returns a tuple with the Owns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwns + +`func (o *IdentityDocument) SetOwns(v []Owns)` + +SetOwns sets Owns field to given value. + +### HasOwns + +`func (o *IdentityDocument) HasOwns() bool` + +HasOwns returns a boolean if a field has been set. + +### GetOwnsCount + +`func (o *IdentityDocument) GetOwnsCount() int32` + +GetOwnsCount returns the OwnsCount field if non-nil, zero value otherwise. + +### GetOwnsCountOk + +`func (o *IdentityDocument) GetOwnsCountOk() (*int32, bool)` + +GetOwnsCountOk returns a tuple with the OwnsCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnsCount + +`func (o *IdentityDocument) SetOwnsCount(v int32)` + +SetOwnsCount sets OwnsCount field to given value. + +### HasOwnsCount + +`func (o *IdentityDocument) HasOwnsCount() bool` + +HasOwnsCount returns a boolean if a field has been set. + +### GetTags + +`func (o *IdentityDocument) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *IdentityDocument) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *IdentityDocument) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *IdentityDocument) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetTagsCount + +`func (o *IdentityDocument) GetTagsCount() int32` + +GetTagsCount returns the TagsCount field if non-nil, zero value otherwise. + +### GetTagsCountOk + +`func (o *IdentityDocument) GetTagsCountOk() (*int32, bool)` + +GetTagsCountOk returns a tuple with the TagsCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTagsCount + +`func (o *IdentityDocument) SetTagsCount(v int32)` + +SetTagsCount sets TagsCount field to given value. + +### HasTagsCount + +`func (o *IdentityDocument) HasTagsCount() bool` + +HasTagsCount returns a boolean if a field has been set. + +### GetVisibleSegments + +`func (o *IdentityDocument) GetVisibleSegments() []string` + +GetVisibleSegments returns the VisibleSegments field if non-nil, zero value otherwise. + +### GetVisibleSegmentsOk + +`func (o *IdentityDocument) GetVisibleSegmentsOk() (*[]string, bool)` + +GetVisibleSegmentsOk returns a tuple with the VisibleSegments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVisibleSegments + +`func (o *IdentityDocument) SetVisibleSegments(v []string)` + +SetVisibleSegments sets VisibleSegments field to given value. + +### HasVisibleSegments + +`func (o *IdentityDocument) HasVisibleSegments() bool` + +HasVisibleSegments returns a boolean if a field has been set. + +### SetVisibleSegmentsNil + +`func (o *IdentityDocument) SetVisibleSegmentsNil(b bool)` + + SetVisibleSegmentsNil sets the value for VisibleSegments to be an explicit nil + +### UnsetVisibleSegments +`func (o *IdentityDocument) UnsetVisibleSegments()` + +UnsetVisibleSegments ensures that no value is present for VisibleSegments, not even an explicit nil +### GetVisibleSegmentCount + +`func (o *IdentityDocument) GetVisibleSegmentCount() int32` + +GetVisibleSegmentCount returns the VisibleSegmentCount field if non-nil, zero value otherwise. + +### GetVisibleSegmentCountOk + +`func (o *IdentityDocument) GetVisibleSegmentCountOk() (*int32, bool)` + +GetVisibleSegmentCountOk returns a tuple with the VisibleSegmentCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVisibleSegmentCount + +`func (o *IdentityDocument) SetVisibleSegmentCount(v int32)` + +SetVisibleSegmentCount sets VisibleSegmentCount field to given value. + +### HasVisibleSegmentCount + +`func (o *IdentityDocument) HasVisibleSegmentCount() bool` + +HasVisibleSegmentCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityDocumentAllOfIdentityProfile.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityDocumentAllOfIdentityProfile.md new file mode 100644 index 000000000..4caf85329 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityDocumentAllOfIdentityProfile.md @@ -0,0 +1,90 @@ +--- +id: v2025-identity-document-all-of-identity-profile +title: IdentityDocumentAllOfIdentityProfile +pagination_label: IdentityDocumentAllOfIdentityProfile +sidebar_label: IdentityDocumentAllOfIdentityProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDocumentAllOfIdentityProfile', 'V2025IdentityDocumentAllOfIdentityProfile'] +slug: /tools/sdk/go/v2025/models/identity-document-all-of-identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfIdentityProfile', 'V2025IdentityDocumentAllOfIdentityProfile'] +--- + +# IdentityDocumentAllOfIdentityProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Identity profile's ID. | [optional] +**Name** | Pointer to **string** | Identity profile's name. | [optional] + +## Methods + +### NewIdentityDocumentAllOfIdentityProfile + +`func NewIdentityDocumentAllOfIdentityProfile() *IdentityDocumentAllOfIdentityProfile` + +NewIdentityDocumentAllOfIdentityProfile instantiates a new IdentityDocumentAllOfIdentityProfile 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 + +### NewIdentityDocumentAllOfIdentityProfileWithDefaults + +`func NewIdentityDocumentAllOfIdentityProfileWithDefaults() *IdentityDocumentAllOfIdentityProfile` + +NewIdentityDocumentAllOfIdentityProfileWithDefaults instantiates a new IdentityDocumentAllOfIdentityProfile 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 + +### GetId + +`func (o *IdentityDocumentAllOfIdentityProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityDocumentAllOfIdentityProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityDocumentAllOfIdentityProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityDocumentAllOfIdentityProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityDocumentAllOfIdentityProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityDocumentAllOfIdentityProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityDocumentAllOfIdentityProfile) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityDocumentAllOfIdentityProfile) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityDocumentAllOfManager.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityDocumentAllOfManager.md new file mode 100644 index 000000000..19748aac9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityDocumentAllOfManager.md @@ -0,0 +1,116 @@ +--- +id: v2025-identity-document-all-of-manager +title: IdentityDocumentAllOfManager +pagination_label: IdentityDocumentAllOfManager +sidebar_label: IdentityDocumentAllOfManager +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDocumentAllOfManager', 'V2025IdentityDocumentAllOfManager'] +slug: /tools/sdk/go/v2025/models/identity-document-all-of-manager +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfManager', 'V2025IdentityDocumentAllOfManager'] +--- + +# IdentityDocumentAllOfManager + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of identity's manager. | [optional] +**Name** | Pointer to **string** | Name of identity's manager. | [optional] +**DisplayName** | Pointer to **string** | Display name of identity's manager. | [optional] + +## Methods + +### NewIdentityDocumentAllOfManager + +`func NewIdentityDocumentAllOfManager() *IdentityDocumentAllOfManager` + +NewIdentityDocumentAllOfManager instantiates a new IdentityDocumentAllOfManager 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 + +### NewIdentityDocumentAllOfManagerWithDefaults + +`func NewIdentityDocumentAllOfManagerWithDefaults() *IdentityDocumentAllOfManager` + +NewIdentityDocumentAllOfManagerWithDefaults instantiates a new IdentityDocumentAllOfManager 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 + +### GetId + +`func (o *IdentityDocumentAllOfManager) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityDocumentAllOfManager) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityDocumentAllOfManager) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityDocumentAllOfManager) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityDocumentAllOfManager) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityDocumentAllOfManager) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityDocumentAllOfManager) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityDocumentAllOfManager) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *IdentityDocumentAllOfManager) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityDocumentAllOfManager) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityDocumentAllOfManager) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityDocumentAllOfManager) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityDocumentAllOfSource.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityDocumentAllOfSource.md new file mode 100644 index 000000000..3eed7708d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityDocumentAllOfSource.md @@ -0,0 +1,90 @@ +--- +id: v2025-identity-document-all-of-source +title: IdentityDocumentAllOfSource +pagination_label: IdentityDocumentAllOfSource +sidebar_label: IdentityDocumentAllOfSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDocumentAllOfSource', 'V2025IdentityDocumentAllOfSource'] +slug: /tools/sdk/go/v2025/models/identity-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfSource', 'V2025IdentityDocumentAllOfSource'] +--- + +# IdentityDocumentAllOfSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of identity's source. | [optional] +**Name** | Pointer to **string** | Display name of identity's source. | [optional] + +## Methods + +### NewIdentityDocumentAllOfSource + +`func NewIdentityDocumentAllOfSource() *IdentityDocumentAllOfSource` + +NewIdentityDocumentAllOfSource instantiates a new IdentityDocumentAllOfSource 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 + +### NewIdentityDocumentAllOfSourceWithDefaults + +`func NewIdentityDocumentAllOfSourceWithDefaults() *IdentityDocumentAllOfSource` + +NewIdentityDocumentAllOfSourceWithDefaults instantiates a new IdentityDocumentAllOfSource 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 + +### GetId + +`func (o *IdentityDocumentAllOfSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityDocumentAllOfSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityDocumentAllOfSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityDocumentAllOfSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityDocumentAllOfSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityDocumentAllOfSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityDocumentAllOfSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityDocumentAllOfSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityEntities.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityEntities.md new file mode 100644 index 000000000..c48ffd83c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityEntities.md @@ -0,0 +1,64 @@ +--- +id: v2025-identity-entities +title: IdentityEntities +pagination_label: IdentityEntities +sidebar_label: IdentityEntities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityEntities', 'V2025IdentityEntities'] +slug: /tools/sdk/go/v2025/models/identity-entities +tags: ['SDK', 'Software Development Kit', 'IdentityEntities', 'V2025IdentityEntities'] +--- + +# IdentityEntities + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityEntity** | Pointer to [**IdentityEntitiesIdentityEntity**](identity-entities-identity-entity) | | [optional] + +## Methods + +### NewIdentityEntities + +`func NewIdentityEntities() *IdentityEntities` + +NewIdentityEntities instantiates a new IdentityEntities 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 + +### NewIdentityEntitiesWithDefaults + +`func NewIdentityEntitiesWithDefaults() *IdentityEntities` + +NewIdentityEntitiesWithDefaults instantiates a new IdentityEntities 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 + +### GetIdentityEntity + +`func (o *IdentityEntities) GetIdentityEntity() IdentityEntitiesIdentityEntity` + +GetIdentityEntity returns the IdentityEntity field if non-nil, zero value otherwise. + +### GetIdentityEntityOk + +`func (o *IdentityEntities) GetIdentityEntityOk() (*IdentityEntitiesIdentityEntity, bool)` + +GetIdentityEntityOk returns a tuple with the IdentityEntity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityEntity + +`func (o *IdentityEntities) SetIdentityEntity(v IdentityEntitiesIdentityEntity)` + +SetIdentityEntity sets IdentityEntity field to given value. + +### HasIdentityEntity + +`func (o *IdentityEntities) HasIdentityEntity() bool` + +HasIdentityEntity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityEntitiesIdentityEntity.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityEntitiesIdentityEntity.md new file mode 100644 index 000000000..babc1b741 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityEntitiesIdentityEntity.md @@ -0,0 +1,116 @@ +--- +id: v2025-identity-entities-identity-entity +title: IdentityEntitiesIdentityEntity +pagination_label: IdentityEntitiesIdentityEntity +sidebar_label: IdentityEntitiesIdentityEntity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityEntitiesIdentityEntity', 'V2025IdentityEntitiesIdentityEntity'] +slug: /tools/sdk/go/v2025/models/identity-entities-identity-entity +tags: ['SDK', 'Software Development Kit', 'IdentityEntitiesIdentityEntity', 'V2025IdentityEntitiesIdentityEntity'] +--- + +# IdentityEntitiesIdentityEntity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | id of the resource to which the identity is associated | [optional] +**Name** | Pointer to **string** | name of the resource to which the identity is associated | [optional] +**Type** | Pointer to **string** | type of the resource to which the identity is associated | [optional] + +## Methods + +### NewIdentityEntitiesIdentityEntity + +`func NewIdentityEntitiesIdentityEntity() *IdentityEntitiesIdentityEntity` + +NewIdentityEntitiesIdentityEntity instantiates a new IdentityEntitiesIdentityEntity 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 + +### NewIdentityEntitiesIdentityEntityWithDefaults + +`func NewIdentityEntitiesIdentityEntityWithDefaults() *IdentityEntitiesIdentityEntity` + +NewIdentityEntitiesIdentityEntityWithDefaults instantiates a new IdentityEntitiesIdentityEntity 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 + +### GetId + +`func (o *IdentityEntitiesIdentityEntity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityEntitiesIdentityEntity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityEntitiesIdentityEntity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityEntitiesIdentityEntity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityEntitiesIdentityEntity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityEntitiesIdentityEntity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityEntitiesIdentityEntity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityEntitiesIdentityEntity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *IdentityEntitiesIdentityEntity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityEntitiesIdentityEntity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityEntitiesIdentityEntity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityEntitiesIdentityEntity) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityEntitlementDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityEntitlementDetails.md new file mode 100644 index 000000000..85b5bfa3f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityEntitlementDetails.md @@ -0,0 +1,142 @@ +--- +id: v2025-identity-entitlement-details +title: IdentityEntitlementDetails +pagination_label: IdentityEntitlementDetails +sidebar_label: IdentityEntitlementDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityEntitlementDetails', 'V2025IdentityEntitlementDetails'] +slug: /tools/sdk/go/v2025/models/identity-entitlement-details +tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetails', 'V2025IdentityEntitlementDetails'] +--- + +# IdentityEntitlementDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | Id of Identity | [optional] +**Entitlement** | Pointer to [**IdentityEntitlementDetailsEntitlementDto**](identity-entitlement-details-entitlement-dto) | | [optional] +**SourceId** | Pointer to **string** | Id of Source | [optional] +**AccountTargets** | Pointer to [**[]IdentityEntitlementDetailsAccountTarget**](identity-entitlement-details-account-target) | A list of account targets on the identity provisioned with the requested entitlement. | [optional] + +## Methods + +### NewIdentityEntitlementDetails + +`func NewIdentityEntitlementDetails() *IdentityEntitlementDetails` + +NewIdentityEntitlementDetails instantiates a new IdentityEntitlementDetails 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 + +### NewIdentityEntitlementDetailsWithDefaults + +`func NewIdentityEntitlementDetailsWithDefaults() *IdentityEntitlementDetails` + +NewIdentityEntitlementDetailsWithDefaults instantiates a new IdentityEntitlementDetails 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 + +### GetIdentityId + +`func (o *IdentityEntitlementDetails) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *IdentityEntitlementDetails) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *IdentityEntitlementDetails) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *IdentityEntitlementDetails) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEntitlement + +`func (o *IdentityEntitlementDetails) GetEntitlement() IdentityEntitlementDetailsEntitlementDto` + +GetEntitlement returns the Entitlement field if non-nil, zero value otherwise. + +### GetEntitlementOk + +`func (o *IdentityEntitlementDetails) GetEntitlementOk() (*IdentityEntitlementDetailsEntitlementDto, bool)` + +GetEntitlementOk returns a tuple with the Entitlement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlement + +`func (o *IdentityEntitlementDetails) SetEntitlement(v IdentityEntitlementDetailsEntitlementDto)` + +SetEntitlement sets Entitlement field to given value. + +### HasEntitlement + +`func (o *IdentityEntitlementDetails) HasEntitlement() bool` + +HasEntitlement returns a boolean if a field has been set. + +### GetSourceId + +`func (o *IdentityEntitlementDetails) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *IdentityEntitlementDetails) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *IdentityEntitlementDetails) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *IdentityEntitlementDetails) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetAccountTargets + +`func (o *IdentityEntitlementDetails) GetAccountTargets() []IdentityEntitlementDetailsAccountTarget` + +GetAccountTargets returns the AccountTargets field if non-nil, zero value otherwise. + +### GetAccountTargetsOk + +`func (o *IdentityEntitlementDetails) GetAccountTargetsOk() (*[]IdentityEntitlementDetailsAccountTarget, bool)` + +GetAccountTargetsOk returns a tuple with the AccountTargets field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountTargets + +`func (o *IdentityEntitlementDetails) SetAccountTargets(v []IdentityEntitlementDetailsAccountTarget)` + +SetAccountTargets sets AccountTargets field to given value. + +### HasAccountTargets + +`func (o *IdentityEntitlementDetails) HasAccountTargets() bool` + +HasAccountTargets returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md new file mode 100644 index 000000000..6a364b9d1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md @@ -0,0 +1,276 @@ +--- +id: v2025-identity-entitlement-details-account-target +title: IdentityEntitlementDetailsAccountTarget +pagination_label: IdentityEntitlementDetailsAccountTarget +sidebar_label: IdentityEntitlementDetailsAccountTarget +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityEntitlementDetailsAccountTarget', 'V2025IdentityEntitlementDetailsAccountTarget'] +slug: /tools/sdk/go/v2025/models/identity-entitlement-details-account-target +tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetailsAccountTarget', 'V2025IdentityEntitlementDetailsAccountTarget'] +--- + +# IdentityEntitlementDetailsAccountTarget + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **string** | The id of account | [optional] +**AccountName** | Pointer to **string** | The name of account | [optional] +**AccountUUID** | Pointer to **NullableString** | The UUID representation of the account if available | [optional] +**SourceId** | Pointer to **string** | The id of Source | [optional] +**SourceName** | Pointer to **string** | The name of Source | [optional] +**RemoveDate** | Pointer to **NullableString** | The removal date scheduled for the entitlement on the Identity | [optional] +**AssignmentId** | Pointer to **NullableString** | The assignmentId of the entitlement on the Identity | [optional] +**Revocable** | Pointer to **bool** | If the entitlement can be revoked | [optional] [default to false] + +## Methods + +### NewIdentityEntitlementDetailsAccountTarget + +`func NewIdentityEntitlementDetailsAccountTarget() *IdentityEntitlementDetailsAccountTarget` + +NewIdentityEntitlementDetailsAccountTarget instantiates a new IdentityEntitlementDetailsAccountTarget 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 + +### NewIdentityEntitlementDetailsAccountTargetWithDefaults + +`func NewIdentityEntitlementDetailsAccountTargetWithDefaults() *IdentityEntitlementDetailsAccountTarget` + +NewIdentityEntitlementDetailsAccountTargetWithDefaults instantiates a new IdentityEntitlementDetailsAccountTarget 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 + +### GetAccountId + +`func (o *IdentityEntitlementDetailsAccountTarget) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *IdentityEntitlementDetailsAccountTarget) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *IdentityEntitlementDetailsAccountTarget) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *IdentityEntitlementDetailsAccountTarget) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetAccountName + +`func (o *IdentityEntitlementDetailsAccountTarget) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *IdentityEntitlementDetailsAccountTarget) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *IdentityEntitlementDetailsAccountTarget) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *IdentityEntitlementDetailsAccountTarget) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetAccountUUID + +`func (o *IdentityEntitlementDetailsAccountTarget) GetAccountUUID() string` + +GetAccountUUID returns the AccountUUID field if non-nil, zero value otherwise. + +### GetAccountUUIDOk + +`func (o *IdentityEntitlementDetailsAccountTarget) GetAccountUUIDOk() (*string, bool)` + +GetAccountUUIDOk returns a tuple with the AccountUUID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountUUID + +`func (o *IdentityEntitlementDetailsAccountTarget) SetAccountUUID(v string)` + +SetAccountUUID sets AccountUUID field to given value. + +### HasAccountUUID + +`func (o *IdentityEntitlementDetailsAccountTarget) HasAccountUUID() bool` + +HasAccountUUID returns a boolean if a field has been set. + +### SetAccountUUIDNil + +`func (o *IdentityEntitlementDetailsAccountTarget) SetAccountUUIDNil(b bool)` + + SetAccountUUIDNil sets the value for AccountUUID to be an explicit nil + +### UnsetAccountUUID +`func (o *IdentityEntitlementDetailsAccountTarget) UnsetAccountUUID()` + +UnsetAccountUUID ensures that no value is present for AccountUUID, not even an explicit nil +### GetSourceId + +`func (o *IdentityEntitlementDetailsAccountTarget) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *IdentityEntitlementDetailsAccountTarget) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *IdentityEntitlementDetailsAccountTarget) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *IdentityEntitlementDetailsAccountTarget) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceName + +`func (o *IdentityEntitlementDetailsAccountTarget) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *IdentityEntitlementDetailsAccountTarget) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *IdentityEntitlementDetailsAccountTarget) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *IdentityEntitlementDetailsAccountTarget) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *IdentityEntitlementDetailsAccountTarget) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *IdentityEntitlementDetailsAccountTarget) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *IdentityEntitlementDetailsAccountTarget) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *IdentityEntitlementDetailsAccountTarget) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *IdentityEntitlementDetailsAccountTarget) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *IdentityEntitlementDetailsAccountTarget) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil +### GetAssignmentId + +`func (o *IdentityEntitlementDetailsAccountTarget) GetAssignmentId() string` + +GetAssignmentId returns the AssignmentId field if non-nil, zero value otherwise. + +### GetAssignmentIdOk + +`func (o *IdentityEntitlementDetailsAccountTarget) GetAssignmentIdOk() (*string, bool)` + +GetAssignmentIdOk returns a tuple with the AssignmentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentId + +`func (o *IdentityEntitlementDetailsAccountTarget) SetAssignmentId(v string)` + +SetAssignmentId sets AssignmentId field to given value. + +### HasAssignmentId + +`func (o *IdentityEntitlementDetailsAccountTarget) HasAssignmentId() bool` + +HasAssignmentId returns a boolean if a field has been set. + +### SetAssignmentIdNil + +`func (o *IdentityEntitlementDetailsAccountTarget) SetAssignmentIdNil(b bool)` + + SetAssignmentIdNil sets the value for AssignmentId to be an explicit nil + +### UnsetAssignmentId +`func (o *IdentityEntitlementDetailsAccountTarget) UnsetAssignmentId()` + +UnsetAssignmentId ensures that no value is present for AssignmentId, not even an explicit nil +### GetRevocable + +`func (o *IdentityEntitlementDetailsAccountTarget) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *IdentityEntitlementDetailsAccountTarget) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *IdentityEntitlementDetailsAccountTarget) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *IdentityEntitlementDetailsAccountTarget) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md new file mode 100644 index 000000000..40ca154b7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md @@ -0,0 +1,334 @@ +--- +id: v2025-identity-entitlement-details-entitlement-dto +title: IdentityEntitlementDetailsEntitlementDto +pagination_label: IdentityEntitlementDetailsEntitlementDto +sidebar_label: IdentityEntitlementDetailsEntitlementDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityEntitlementDetailsEntitlementDto', 'V2025IdentityEntitlementDetailsEntitlementDto'] +slug: /tools/sdk/go/v2025/models/identity-entitlement-details-entitlement-dto +tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetailsEntitlementDto', 'V2025IdentityEntitlementDetailsEntitlementDto'] +--- + +# IdentityEntitlementDetailsEntitlementDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The entitlement id | [optional] +**Name** | Pointer to **string** | The entitlement name | [optional] +**Created** | Pointer to **SailPointTime** | Time when the entitlement was last modified | [optional] +**Modified** | Pointer to **SailPointTime** | Time when the entitlement was last modified | [optional] +**Description** | Pointer to **NullableString** | The description of the entitlement | [optional] +**Type** | Pointer to **string** | The type of the object, will always be \"ENTITLEMENT\" | [optional] +**SourceId** | Pointer to **string** | The source ID | [optional] +**SourceName** | Pointer to **string** | The source name | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Value** | Pointer to **string** | The value of the entitlement | [optional] +**Flags** | Pointer to **[]string** | a list of properties informing the viewer about the entitlement | [optional] + +## Methods + +### NewIdentityEntitlementDetailsEntitlementDto + +`func NewIdentityEntitlementDetailsEntitlementDto() *IdentityEntitlementDetailsEntitlementDto` + +NewIdentityEntitlementDetailsEntitlementDto instantiates a new IdentityEntitlementDetailsEntitlementDto 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 + +### NewIdentityEntitlementDetailsEntitlementDtoWithDefaults + +`func NewIdentityEntitlementDetailsEntitlementDtoWithDefaults() *IdentityEntitlementDetailsEntitlementDto` + +NewIdentityEntitlementDetailsEntitlementDtoWithDefaults instantiates a new IdentityEntitlementDetailsEntitlementDto 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 + +### GetId + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityEntitlementDetailsEntitlementDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityEntitlementDetailsEntitlementDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityEntitlementDetailsEntitlementDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityEntitlementDetailsEntitlementDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *IdentityEntitlementDetailsEntitlementDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *IdentityEntitlementDetailsEntitlementDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *IdentityEntitlementDetailsEntitlementDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *IdentityEntitlementDetailsEntitlementDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *IdentityEntitlementDetailsEntitlementDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *IdentityEntitlementDetailsEntitlementDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *IdentityEntitlementDetailsEntitlementDto) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *IdentityEntitlementDetailsEntitlementDto) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityEntitlementDetailsEntitlementDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityEntitlementDetailsEntitlementDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSourceId + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *IdentityEntitlementDetailsEntitlementDto) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *IdentityEntitlementDetailsEntitlementDto) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceName + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *IdentityEntitlementDetailsEntitlementDto) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *IdentityEntitlementDetailsEntitlementDto) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetOwner + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetOwner() OwnerDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetOwnerOk() (*OwnerDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *IdentityEntitlementDetailsEntitlementDto) SetOwner(v OwnerDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *IdentityEntitlementDetailsEntitlementDto) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetValue + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *IdentityEntitlementDetailsEntitlementDto) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *IdentityEntitlementDetailsEntitlementDto) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetFlags + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetFlags() []string` + +GetFlags returns the Flags field if non-nil, zero value otherwise. + +### GetFlagsOk + +`func (o *IdentityEntitlementDetailsEntitlementDto) GetFlagsOk() (*[]string, bool)` + +GetFlagsOk returns a tuple with the Flags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFlags + +`func (o *IdentityEntitlementDetailsEntitlementDto) SetFlags(v []string)` + +SetFlags sets Flags field to given value. + +### HasFlags + +`func (o *IdentityEntitlementDetailsEntitlementDto) HasFlags() bool` + +HasFlags returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityExceptionReportReference.md new file mode 100644 index 000000000..158205b8e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityExceptionReportReference.md @@ -0,0 +1,90 @@ +--- +id: v2025-identity-exception-report-reference +title: IdentityExceptionReportReference +pagination_label: IdentityExceptionReportReference +sidebar_label: IdentityExceptionReportReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityExceptionReportReference', 'V2025IdentityExceptionReportReference'] +slug: /tools/sdk/go/v2025/models/identity-exception-report-reference +tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'V2025IdentityExceptionReportReference'] +--- + +# IdentityExceptionReportReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TaskResultId** | Pointer to **string** | Task result ID. | [optional] +**ReportName** | Pointer to **string** | Report name. | [optional] + +## Methods + +### NewIdentityExceptionReportReference + +`func NewIdentityExceptionReportReference() *IdentityExceptionReportReference` + +NewIdentityExceptionReportReference instantiates a new IdentityExceptionReportReference 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 + +### NewIdentityExceptionReportReferenceWithDefaults + +`func NewIdentityExceptionReportReferenceWithDefaults() *IdentityExceptionReportReference` + +NewIdentityExceptionReportReferenceWithDefaults instantiates a new IdentityExceptionReportReference 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 + +### GetTaskResultId + +`func (o *IdentityExceptionReportReference) GetTaskResultId() string` + +GetTaskResultId returns the TaskResultId field if non-nil, zero value otherwise. + +### GetTaskResultIdOk + +`func (o *IdentityExceptionReportReference) GetTaskResultIdOk() (*string, bool)` + +GetTaskResultIdOk returns a tuple with the TaskResultId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskResultId + +`func (o *IdentityExceptionReportReference) SetTaskResultId(v string)` + +SetTaskResultId sets TaskResultId field to given value. + +### HasTaskResultId + +`func (o *IdentityExceptionReportReference) HasTaskResultId() bool` + +HasTaskResultId returns a boolean if a field has been set. + +### GetReportName + +`func (o *IdentityExceptionReportReference) GetReportName() string` + +GetReportName returns the ReportName field if non-nil, zero value otherwise. + +### GetReportNameOk + +`func (o *IdentityExceptionReportReference) GetReportNameOk() (*string, bool)` + +GetReportNameOk returns a tuple with the ReportName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportName + +`func (o *IdentityExceptionReportReference) SetReportName(v string)` + +SetReportName sets ReportName field to given value. + +### HasReportName + +`func (o *IdentityExceptionReportReference) HasReportName() bool` + +HasReportName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityHistoryResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityHistoryResponse.md new file mode 100644 index 000000000..e95b084db --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityHistoryResponse.md @@ -0,0 +1,194 @@ +--- +id: v2025-identity-history-response +title: IdentityHistoryResponse +pagination_label: IdentityHistoryResponse +sidebar_label: IdentityHistoryResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityHistoryResponse', 'V2025IdentityHistoryResponse'] +slug: /tools/sdk/go/v2025/models/identity-history-response +tags: ['SDK', 'Software Development Kit', 'IdentityHistoryResponse', 'V2025IdentityHistoryResponse'] +--- + +# IdentityHistoryResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the identity ID | [optional] +**DisplayName** | Pointer to **string** | the display name of the identity | [optional] +**Snapshot** | Pointer to **string** | the date when the identity record was created | [optional] +**DeletedDate** | Pointer to **string** | the date when the identity was deleted | [optional] +**AccessItemCount** | Pointer to **map[string]int32** | A map containing the count of each access item | [optional] +**Attributes** | Pointer to **map[string]interface{}** | A map containing the identity attributes | [optional] + +## Methods + +### NewIdentityHistoryResponse + +`func NewIdentityHistoryResponse() *IdentityHistoryResponse` + +NewIdentityHistoryResponse instantiates a new IdentityHistoryResponse 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 + +### NewIdentityHistoryResponseWithDefaults + +`func NewIdentityHistoryResponseWithDefaults() *IdentityHistoryResponse` + +NewIdentityHistoryResponseWithDefaults instantiates a new IdentityHistoryResponse 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 + +### GetId + +`func (o *IdentityHistoryResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityHistoryResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityHistoryResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityHistoryResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *IdentityHistoryResponse) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityHistoryResponse) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityHistoryResponse) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityHistoryResponse) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSnapshot + +`func (o *IdentityHistoryResponse) GetSnapshot() string` + +GetSnapshot returns the Snapshot field if non-nil, zero value otherwise. + +### GetSnapshotOk + +`func (o *IdentityHistoryResponse) GetSnapshotOk() (*string, bool)` + +GetSnapshotOk returns a tuple with the Snapshot field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshot + +`func (o *IdentityHistoryResponse) SetSnapshot(v string)` + +SetSnapshot sets Snapshot field to given value. + +### HasSnapshot + +`func (o *IdentityHistoryResponse) HasSnapshot() bool` + +HasSnapshot returns a boolean if a field has been set. + +### GetDeletedDate + +`func (o *IdentityHistoryResponse) GetDeletedDate() string` + +GetDeletedDate returns the DeletedDate field if non-nil, zero value otherwise. + +### GetDeletedDateOk + +`func (o *IdentityHistoryResponse) GetDeletedDateOk() (*string, bool)` + +GetDeletedDateOk returns a tuple with the DeletedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeletedDate + +`func (o *IdentityHistoryResponse) SetDeletedDate(v string)` + +SetDeletedDate sets DeletedDate field to given value. + +### HasDeletedDate + +`func (o *IdentityHistoryResponse) HasDeletedDate() bool` + +HasDeletedDate returns a boolean if a field has been set. + +### GetAccessItemCount + +`func (o *IdentityHistoryResponse) GetAccessItemCount() map[string]int32` + +GetAccessItemCount returns the AccessItemCount field if non-nil, zero value otherwise. + +### GetAccessItemCountOk + +`func (o *IdentityHistoryResponse) GetAccessItemCountOk() (*map[string]int32, bool)` + +GetAccessItemCountOk returns a tuple with the AccessItemCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItemCount + +`func (o *IdentityHistoryResponse) SetAccessItemCount(v map[string]int32)` + +SetAccessItemCount sets AccessItemCount field to given value. + +### HasAccessItemCount + +`func (o *IdentityHistoryResponse) HasAccessItemCount() bool` + +HasAccessItemCount returns a boolean if a field has been set. + +### GetAttributes + +`func (o *IdentityHistoryResponse) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *IdentityHistoryResponse) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *IdentityHistoryResponse) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *IdentityHistoryResponse) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityLifecycleState.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityLifecycleState.md new file mode 100644 index 000000000..a3d76d52e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityLifecycleState.md @@ -0,0 +1,80 @@ +--- +id: v2025-identity-lifecycle-state +title: IdentityLifecycleState +pagination_label: IdentityLifecycleState +sidebar_label: IdentityLifecycleState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityLifecycleState', 'V2025IdentityLifecycleState'] +slug: /tools/sdk/go/v2025/models/identity-lifecycle-state +tags: ['SDK', 'Software Development Kit', 'IdentityLifecycleState', 'V2025IdentityLifecycleState'] +--- + +# IdentityLifecycleState + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**StateName** | **string** | The name of the lifecycle state | +**ManuallyUpdated** | **bool** | Whether the lifecycle state has been manually or automatically set | + +## Methods + +### NewIdentityLifecycleState + +`func NewIdentityLifecycleState(stateName string, manuallyUpdated bool, ) *IdentityLifecycleState` + +NewIdentityLifecycleState instantiates a new IdentityLifecycleState 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 + +### NewIdentityLifecycleStateWithDefaults + +`func NewIdentityLifecycleStateWithDefaults() *IdentityLifecycleState` + +NewIdentityLifecycleStateWithDefaults instantiates a new IdentityLifecycleState 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 + +### GetStateName + +`func (o *IdentityLifecycleState) GetStateName() string` + +GetStateName returns the StateName field if non-nil, zero value otherwise. + +### GetStateNameOk + +`func (o *IdentityLifecycleState) GetStateNameOk() (*string, bool)` + +GetStateNameOk returns a tuple with the StateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStateName + +`func (o *IdentityLifecycleState) SetStateName(v string)` + +SetStateName sets StateName field to given value. + + +### GetManuallyUpdated + +`func (o *IdentityLifecycleState) GetManuallyUpdated() bool` + +GetManuallyUpdated returns the ManuallyUpdated field if non-nil, zero value otherwise. + +### GetManuallyUpdatedOk + +`func (o *IdentityLifecycleState) GetManuallyUpdatedOk() (*bool, bool)` + +GetManuallyUpdatedOk returns a tuple with the ManuallyUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyUpdated + +`func (o *IdentityLifecycleState) SetManuallyUpdated(v bool)` + +SetManuallyUpdated sets ManuallyUpdated field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityListItem.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityListItem.md new file mode 100644 index 000000000..df2326219 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityListItem.md @@ -0,0 +1,224 @@ +--- +id: v2025-identity-list-item +title: IdentityListItem +pagination_label: IdentityListItem +sidebar_label: IdentityListItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityListItem', 'V2025IdentityListItem'] +slug: /tools/sdk/go/v2025/models/identity-list-item +tags: ['SDK', 'Software Development Kit', 'IdentityListItem', 'V2025IdentityListItem'] +--- + +# IdentityListItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the identity ID | [optional] +**DisplayName** | Pointer to **string** | the display name of the identity | [optional] +**FirstName** | Pointer to **NullableString** | the first name of the identity | [optional] +**LastName** | Pointer to **NullableString** | the last name of the identity | [optional] +**Active** | Pointer to **bool** | indicates if an identity is active or not | [optional] [default to true] +**DeletedDate** | Pointer to **NullableString** | the date when the identity was deleted | [optional] + +## Methods + +### NewIdentityListItem + +`func NewIdentityListItem() *IdentityListItem` + +NewIdentityListItem instantiates a new IdentityListItem 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 + +### NewIdentityListItemWithDefaults + +`func NewIdentityListItemWithDefaults() *IdentityListItem` + +NewIdentityListItemWithDefaults instantiates a new IdentityListItem 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 + +### GetId + +`func (o *IdentityListItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityListItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityListItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityListItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *IdentityListItem) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityListItem) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityListItem) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityListItem) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *IdentityListItem) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *IdentityListItem) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *IdentityListItem) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *IdentityListItem) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### SetFirstNameNil + +`func (o *IdentityListItem) SetFirstNameNil(b bool)` + + SetFirstNameNil sets the value for FirstName to be an explicit nil + +### UnsetFirstName +`func (o *IdentityListItem) UnsetFirstName()` + +UnsetFirstName ensures that no value is present for FirstName, not even an explicit nil +### GetLastName + +`func (o *IdentityListItem) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *IdentityListItem) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *IdentityListItem) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *IdentityListItem) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### SetLastNameNil + +`func (o *IdentityListItem) SetLastNameNil(b bool)` + + SetLastNameNil sets the value for LastName to be an explicit nil + +### UnsetLastName +`func (o *IdentityListItem) UnsetLastName()` + +UnsetLastName ensures that no value is present for LastName, not even an explicit nil +### GetActive + +`func (o *IdentityListItem) GetActive() bool` + +GetActive returns the Active field if non-nil, zero value otherwise. + +### GetActiveOk + +`func (o *IdentityListItem) GetActiveOk() (*bool, bool)` + +GetActiveOk returns a tuple with the Active field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActive + +`func (o *IdentityListItem) SetActive(v bool)` + +SetActive sets Active field to given value. + +### HasActive + +`func (o *IdentityListItem) HasActive() bool` + +HasActive returns a boolean if a field has been set. + +### GetDeletedDate + +`func (o *IdentityListItem) GetDeletedDate() string` + +GetDeletedDate returns the DeletedDate field if non-nil, zero value otherwise. + +### GetDeletedDateOk + +`func (o *IdentityListItem) GetDeletedDateOk() (*string, bool)` + +GetDeletedDateOk returns a tuple with the DeletedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeletedDate + +`func (o *IdentityListItem) SetDeletedDate(v string)` + +SetDeletedDate sets DeletedDate field to given value. + +### HasDeletedDate + +`func (o *IdentityListItem) HasDeletedDate() bool` + +HasDeletedDate returns a boolean if a field has been set. + +### SetDeletedDateNil + +`func (o *IdentityListItem) SetDeletedDateNil(b bool)` + + SetDeletedDateNil sets the value for DeletedDate to be an explicit nil + +### UnsetDeletedDate +`func (o *IdentityListItem) UnsetDeletedDate()` + +UnsetDeletedDate ensures that no value is present for DeletedDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityManagerRef.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityManagerRef.md new file mode 100644 index 000000000..9db9357a2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityManagerRef.md @@ -0,0 +1,116 @@ +--- +id: v2025-identity-manager-ref +title: IdentityManagerRef +pagination_label: IdentityManagerRef +sidebar_label: IdentityManagerRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityManagerRef', 'V2025IdentityManagerRef'] +slug: /tools/sdk/go/v2025/models/identity-manager-ref +tags: ['SDK', 'Software Development Kit', 'IdentityManagerRef', 'V2025IdentityManagerRef'] +--- + +# IdentityManagerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity's manager | [optional] +**Id** | Pointer to **string** | ID of identity's manager | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity's manager | [optional] + +## Methods + +### NewIdentityManagerRef + +`func NewIdentityManagerRef() *IdentityManagerRef` + +NewIdentityManagerRef instantiates a new IdentityManagerRef 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 + +### NewIdentityManagerRefWithDefaults + +`func NewIdentityManagerRefWithDefaults() *IdentityManagerRef` + +NewIdentityManagerRefWithDefaults instantiates a new IdentityManagerRef 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 + +### GetType + +`func (o *IdentityManagerRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityManagerRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityManagerRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityManagerRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityManagerRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityManagerRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityManagerRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityManagerRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityManagerRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityManagerRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityManagerRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityManagerRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityOwnershipAssociationDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityOwnershipAssociationDetails.md new file mode 100644 index 000000000..b95664ce5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityOwnershipAssociationDetails.md @@ -0,0 +1,64 @@ +--- +id: v2025-identity-ownership-association-details +title: IdentityOwnershipAssociationDetails +pagination_label: IdentityOwnershipAssociationDetails +sidebar_label: IdentityOwnershipAssociationDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityOwnershipAssociationDetails', 'V2025IdentityOwnershipAssociationDetails'] +slug: /tools/sdk/go/v2025/models/identity-ownership-association-details +tags: ['SDK', 'Software Development Kit', 'IdentityOwnershipAssociationDetails', 'V2025IdentityOwnershipAssociationDetails'] +--- + +# IdentityOwnershipAssociationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssociationDetails** | Pointer to [**[]IdentityOwnershipAssociationDetailsAssociationDetailsInner**](identity-ownership-association-details-association-details-inner) | list of all the resource associations for the identity | [optional] + +## Methods + +### NewIdentityOwnershipAssociationDetails + +`func NewIdentityOwnershipAssociationDetails() *IdentityOwnershipAssociationDetails` + +NewIdentityOwnershipAssociationDetails instantiates a new IdentityOwnershipAssociationDetails 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 + +### NewIdentityOwnershipAssociationDetailsWithDefaults + +`func NewIdentityOwnershipAssociationDetailsWithDefaults() *IdentityOwnershipAssociationDetails` + +NewIdentityOwnershipAssociationDetailsWithDefaults instantiates a new IdentityOwnershipAssociationDetails 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 + +### GetAssociationDetails + +`func (o *IdentityOwnershipAssociationDetails) GetAssociationDetails() []IdentityOwnershipAssociationDetailsAssociationDetailsInner` + +GetAssociationDetails returns the AssociationDetails field if non-nil, zero value otherwise. + +### GetAssociationDetailsOk + +`func (o *IdentityOwnershipAssociationDetails) GetAssociationDetailsOk() (*[]IdentityOwnershipAssociationDetailsAssociationDetailsInner, bool)` + +GetAssociationDetailsOk returns a tuple with the AssociationDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociationDetails + +`func (o *IdentityOwnershipAssociationDetails) SetAssociationDetails(v []IdentityOwnershipAssociationDetailsAssociationDetailsInner)` + +SetAssociationDetails sets AssociationDetails field to given value. + +### HasAssociationDetails + +`func (o *IdentityOwnershipAssociationDetails) HasAssociationDetails() bool` + +HasAssociationDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md new file mode 100644 index 000000000..ab6b4eeec --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md @@ -0,0 +1,90 @@ +--- +id: v2025-identity-ownership-association-details-association-details-inner +title: IdentityOwnershipAssociationDetailsAssociationDetailsInner +pagination_label: IdentityOwnershipAssociationDetailsAssociationDetailsInner +sidebar_label: IdentityOwnershipAssociationDetailsAssociationDetailsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityOwnershipAssociationDetailsAssociationDetailsInner', 'V2025IdentityOwnershipAssociationDetailsAssociationDetailsInner'] +slug: /tools/sdk/go/v2025/models/identity-ownership-association-details-association-details-inner +tags: ['SDK', 'Software Development Kit', 'IdentityOwnershipAssociationDetailsAssociationDetailsInner', 'V2025IdentityOwnershipAssociationDetailsAssociationDetailsInner'] +--- + +# IdentityOwnershipAssociationDetailsAssociationDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssociationType** | Pointer to **string** | association type with the identity | [optional] +**Entities** | Pointer to [**[]IdentityEntities**](identity-entities) | the specific resource this identity has ownership on | [optional] + +## Methods + +### NewIdentityOwnershipAssociationDetailsAssociationDetailsInner + +`func NewIdentityOwnershipAssociationDetailsAssociationDetailsInner() *IdentityOwnershipAssociationDetailsAssociationDetailsInner` + +NewIdentityOwnershipAssociationDetailsAssociationDetailsInner instantiates a new IdentityOwnershipAssociationDetailsAssociationDetailsInner 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 + +### NewIdentityOwnershipAssociationDetailsAssociationDetailsInnerWithDefaults + +`func NewIdentityOwnershipAssociationDetailsAssociationDetailsInnerWithDefaults() *IdentityOwnershipAssociationDetailsAssociationDetailsInner` + +NewIdentityOwnershipAssociationDetailsAssociationDetailsInnerWithDefaults instantiates a new IdentityOwnershipAssociationDetailsAssociationDetailsInner 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 + +### GetAssociationType + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) GetAssociationType() string` + +GetAssociationType returns the AssociationType field if non-nil, zero value otherwise. + +### GetAssociationTypeOk + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) GetAssociationTypeOk() (*string, bool)` + +GetAssociationTypeOk returns a tuple with the AssociationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociationType + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) SetAssociationType(v string)` + +SetAssociationType sets AssociationType field to given value. + +### HasAssociationType + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) HasAssociationType() bool` + +HasAssociationType returns a boolean if a field has been set. + +### GetEntities + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) GetEntities() []IdentityEntities` + +GetEntities returns the Entities field if non-nil, zero value otherwise. + +### GetEntitiesOk + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) GetEntitiesOk() (*[]IdentityEntities, bool)` + +GetEntitiesOk returns a tuple with the Entities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntities + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) SetEntities(v []IdentityEntities)` + +SetEntities sets Entities field to given value. + +### HasEntities + +`func (o *IdentityOwnershipAssociationDetailsAssociationDetailsInner) HasEntities() bool` + +HasEntities returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityPreviewRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityPreviewRequest.md new file mode 100644 index 000000000..16cecd135 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityPreviewRequest.md @@ -0,0 +1,90 @@ +--- +id: v2025-identity-preview-request +title: IdentityPreviewRequest +pagination_label: IdentityPreviewRequest +sidebar_label: IdentityPreviewRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityPreviewRequest', 'V2025IdentityPreviewRequest'] +slug: /tools/sdk/go/v2025/models/identity-preview-request +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewRequest', 'V2025IdentityPreviewRequest'] +--- + +# IdentityPreviewRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | The Identity id | [optional] +**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] + +## Methods + +### NewIdentityPreviewRequest + +`func NewIdentityPreviewRequest() *IdentityPreviewRequest` + +NewIdentityPreviewRequest instantiates a new IdentityPreviewRequest 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 + +### NewIdentityPreviewRequestWithDefaults + +`func NewIdentityPreviewRequestWithDefaults() *IdentityPreviewRequest` + +NewIdentityPreviewRequestWithDefaults instantiates a new IdentityPreviewRequest 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 + +### GetIdentityId + +`func (o *IdentityPreviewRequest) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *IdentityPreviewRequest) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *IdentityPreviewRequest) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *IdentityPreviewRequest) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetIdentityAttributeConfig + +`func (o *IdentityPreviewRequest) GetIdentityAttributeConfig() IdentityAttributeConfig` + +GetIdentityAttributeConfig returns the IdentityAttributeConfig field if non-nil, zero value otherwise. + +### GetIdentityAttributeConfigOk + +`func (o *IdentityPreviewRequest) GetIdentityAttributeConfigOk() (*IdentityAttributeConfig, bool)` + +GetIdentityAttributeConfigOk returns a tuple with the IdentityAttributeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeConfig + +`func (o *IdentityPreviewRequest) SetIdentityAttributeConfig(v IdentityAttributeConfig)` + +SetIdentityAttributeConfig sets IdentityAttributeConfig field to given value. + +### HasIdentityAttributeConfig + +`func (o *IdentityPreviewRequest) HasIdentityAttributeConfig() bool` + +HasIdentityAttributeConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityPreviewResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityPreviewResponse.md new file mode 100644 index 000000000..64c5079e1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityPreviewResponse.md @@ -0,0 +1,90 @@ +--- +id: v2025-identity-preview-response +title: IdentityPreviewResponse +pagination_label: IdentityPreviewResponse +sidebar_label: IdentityPreviewResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityPreviewResponse', 'V2025IdentityPreviewResponse'] +slug: /tools/sdk/go/v2025/models/identity-preview-response +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponse', 'V2025IdentityPreviewResponse'] +--- + +# IdentityPreviewResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**IdentityPreviewResponseIdentity**](identity-preview-response-identity) | | [optional] +**PreviewAttributes** | Pointer to [**[]IdentityAttributePreview**](identity-attribute-preview) | | [optional] + +## Methods + +### NewIdentityPreviewResponse + +`func NewIdentityPreviewResponse() *IdentityPreviewResponse` + +NewIdentityPreviewResponse instantiates a new IdentityPreviewResponse 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 + +### NewIdentityPreviewResponseWithDefaults + +`func NewIdentityPreviewResponseWithDefaults() *IdentityPreviewResponse` + +NewIdentityPreviewResponseWithDefaults instantiates a new IdentityPreviewResponse 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 + +### GetIdentity + +`func (o *IdentityPreviewResponse) GetIdentity() IdentityPreviewResponseIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *IdentityPreviewResponse) GetIdentityOk() (*IdentityPreviewResponseIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *IdentityPreviewResponse) SetIdentity(v IdentityPreviewResponseIdentity)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *IdentityPreviewResponse) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetPreviewAttributes + +`func (o *IdentityPreviewResponse) GetPreviewAttributes() []IdentityAttributePreview` + +GetPreviewAttributes returns the PreviewAttributes field if non-nil, zero value otherwise. + +### GetPreviewAttributesOk + +`func (o *IdentityPreviewResponse) GetPreviewAttributesOk() (*[]IdentityAttributePreview, bool)` + +GetPreviewAttributesOk returns a tuple with the PreviewAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviewAttributes + +`func (o *IdentityPreviewResponse) SetPreviewAttributes(v []IdentityAttributePreview)` + +SetPreviewAttributes sets PreviewAttributes field to given value. + +### HasPreviewAttributes + +`func (o *IdentityPreviewResponse) HasPreviewAttributes() bool` + +HasPreviewAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityPreviewResponseIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityPreviewResponseIdentity.md new file mode 100644 index 000000000..4fa6768fe --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityPreviewResponseIdentity.md @@ -0,0 +1,116 @@ +--- +id: v2025-identity-preview-response-identity +title: IdentityPreviewResponseIdentity +pagination_label: IdentityPreviewResponseIdentity +sidebar_label: IdentityPreviewResponseIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityPreviewResponseIdentity', 'V2025IdentityPreviewResponseIdentity'] +slug: /tools/sdk/go/v2025/models/identity-preview-response-identity +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponseIdentity', 'V2025IdentityPreviewResponseIdentity'] +--- + +# IdentityPreviewResponseIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Identity's DTO type. | [optional] +**Id** | Pointer to **string** | Identity ID. | [optional] +**Name** | Pointer to **string** | Identity's display name. | [optional] + +## Methods + +### NewIdentityPreviewResponseIdentity + +`func NewIdentityPreviewResponseIdentity() *IdentityPreviewResponseIdentity` + +NewIdentityPreviewResponseIdentity instantiates a new IdentityPreviewResponseIdentity 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 + +### NewIdentityPreviewResponseIdentityWithDefaults + +`func NewIdentityPreviewResponseIdentityWithDefaults() *IdentityPreviewResponseIdentity` + +NewIdentityPreviewResponseIdentityWithDefaults instantiates a new IdentityPreviewResponseIdentity 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 + +### GetType + +`func (o *IdentityPreviewResponseIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityPreviewResponseIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityPreviewResponseIdentity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityPreviewResponseIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityPreviewResponseIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityPreviewResponseIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityPreviewResponseIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityPreviewResponseIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityPreviewResponseIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityPreviewResponseIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityPreviewResponseIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityPreviewResponseIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfile.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfile.md new file mode 100644 index 000000000..f0086d6be --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfile.md @@ -0,0 +1,406 @@ +--- +id: v2025-identity-profile +title: IdentityProfile +pagination_label: IdentityProfile +sidebar_label: IdentityProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfile', 'V2025IdentityProfile'] +slug: /tools/sdk/go/v2025/models/identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityProfile', 'V2025IdentityProfile'] +--- + +# IdentityProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Description** | Pointer to **NullableString** | Identity profile's description. | [optional] +**Owner** | Pointer to [**NullableIdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] +**Priority** | Pointer to **int64** | Identity profile's priority. | [optional] +**AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | +**IdentityRefreshRequired** | Pointer to **bool** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to false] +**IdentityCount** | Pointer to **int32** | Number of identities belonging to the identity profile. | [optional] +**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] +**IdentityExceptionReportReference** | Pointer to [**NullableIdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] +**HasTimeBasedAttr** | Pointer to **bool** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to false] + +## Methods + +### NewIdentityProfile + +`func NewIdentityProfile(name NullableString, authoritativeSource IdentityProfileAllOfAuthoritativeSource, ) *IdentityProfile` + +NewIdentityProfile instantiates a new IdentityProfile 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 + +### NewIdentityProfileWithDefaults + +`func NewIdentityProfileWithDefaults() *IdentityProfile` + +NewIdentityProfileWithDefaults instantiates a new IdentityProfile 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 + +### GetId + +`func (o *IdentityProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfile) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *IdentityProfile) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *IdentityProfile) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *IdentityProfile) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *IdentityProfile) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *IdentityProfile) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *IdentityProfile) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *IdentityProfile) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *IdentityProfile) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *IdentityProfile) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *IdentityProfile) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *IdentityProfile) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *IdentityProfile) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *IdentityProfile) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *IdentityProfile) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *IdentityProfile) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *IdentityProfile) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwner + +`func (o *IdentityProfile) GetOwner() IdentityProfileAllOfOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *IdentityProfile) GetOwnerOk() (*IdentityProfileAllOfOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *IdentityProfile) SetOwner(v IdentityProfileAllOfOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *IdentityProfile) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *IdentityProfile) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *IdentityProfile) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetPriority + +`func (o *IdentityProfile) GetPriority() int64` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *IdentityProfile) GetPriorityOk() (*int64, 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 *IdentityProfile) SetPriority(v int64)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *IdentityProfile) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetAuthoritativeSource + +`func (o *IdentityProfile) GetAuthoritativeSource() IdentityProfileAllOfAuthoritativeSource` + +GetAuthoritativeSource returns the AuthoritativeSource field if non-nil, zero value otherwise. + +### GetAuthoritativeSourceOk + +`func (o *IdentityProfile) GetAuthoritativeSourceOk() (*IdentityProfileAllOfAuthoritativeSource, bool)` + +GetAuthoritativeSourceOk returns a tuple with the AuthoritativeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritativeSource + +`func (o *IdentityProfile) SetAuthoritativeSource(v IdentityProfileAllOfAuthoritativeSource)` + +SetAuthoritativeSource sets AuthoritativeSource field to given value. + + +### GetIdentityRefreshRequired + +`func (o *IdentityProfile) GetIdentityRefreshRequired() bool` + +GetIdentityRefreshRequired returns the IdentityRefreshRequired field if non-nil, zero value otherwise. + +### GetIdentityRefreshRequiredOk + +`func (o *IdentityProfile) GetIdentityRefreshRequiredOk() (*bool, bool)` + +GetIdentityRefreshRequiredOk returns a tuple with the IdentityRefreshRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityRefreshRequired + +`func (o *IdentityProfile) SetIdentityRefreshRequired(v bool)` + +SetIdentityRefreshRequired sets IdentityRefreshRequired field to given value. + +### HasIdentityRefreshRequired + +`func (o *IdentityProfile) HasIdentityRefreshRequired() bool` + +HasIdentityRefreshRequired returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *IdentityProfile) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *IdentityProfile) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *IdentityProfile) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *IdentityProfile) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetIdentityAttributeConfig + +`func (o *IdentityProfile) GetIdentityAttributeConfig() IdentityAttributeConfig` + +GetIdentityAttributeConfig returns the IdentityAttributeConfig field if non-nil, zero value otherwise. + +### GetIdentityAttributeConfigOk + +`func (o *IdentityProfile) GetIdentityAttributeConfigOk() (*IdentityAttributeConfig, bool)` + +GetIdentityAttributeConfigOk returns a tuple with the IdentityAttributeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeConfig + +`func (o *IdentityProfile) SetIdentityAttributeConfig(v IdentityAttributeConfig)` + +SetIdentityAttributeConfig sets IdentityAttributeConfig field to given value. + +### HasIdentityAttributeConfig + +`func (o *IdentityProfile) HasIdentityAttributeConfig() bool` + +HasIdentityAttributeConfig returns a boolean if a field has been set. + +### GetIdentityExceptionReportReference + +`func (o *IdentityProfile) GetIdentityExceptionReportReference() IdentityExceptionReportReference` + +GetIdentityExceptionReportReference returns the IdentityExceptionReportReference field if non-nil, zero value otherwise. + +### GetIdentityExceptionReportReferenceOk + +`func (o *IdentityProfile) GetIdentityExceptionReportReferenceOk() (*IdentityExceptionReportReference, bool)` + +GetIdentityExceptionReportReferenceOk returns a tuple with the IdentityExceptionReportReference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityExceptionReportReference + +`func (o *IdentityProfile) SetIdentityExceptionReportReference(v IdentityExceptionReportReference)` + +SetIdentityExceptionReportReference sets IdentityExceptionReportReference field to given value. + +### HasIdentityExceptionReportReference + +`func (o *IdentityProfile) HasIdentityExceptionReportReference() bool` + +HasIdentityExceptionReportReference returns a boolean if a field has been set. + +### SetIdentityExceptionReportReferenceNil + +`func (o *IdentityProfile) SetIdentityExceptionReportReferenceNil(b bool)` + + SetIdentityExceptionReportReferenceNil sets the value for IdentityExceptionReportReference to be an explicit nil + +### UnsetIdentityExceptionReportReference +`func (o *IdentityProfile) UnsetIdentityExceptionReportReference()` + +UnsetIdentityExceptionReportReference ensures that no value is present for IdentityExceptionReportReference, not even an explicit nil +### GetHasTimeBasedAttr + +`func (o *IdentityProfile) GetHasTimeBasedAttr() bool` + +GetHasTimeBasedAttr returns the HasTimeBasedAttr field if non-nil, zero value otherwise. + +### GetHasTimeBasedAttrOk + +`func (o *IdentityProfile) GetHasTimeBasedAttrOk() (*bool, bool)` + +GetHasTimeBasedAttrOk returns a tuple with the HasTimeBasedAttr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasTimeBasedAttr + +`func (o *IdentityProfile) SetHasTimeBasedAttr(v bool)` + +SetHasTimeBasedAttr sets HasTimeBasedAttr field to given value. + +### HasHasTimeBasedAttr + +`func (o *IdentityProfile) HasHasTimeBasedAttr() bool` + +HasHasTimeBasedAttr returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfileAllOfAuthoritativeSource.md new file mode 100644 index 000000000..f4be39017 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -0,0 +1,116 @@ +--- +id: v2025-identity-profile-all-of-authoritative-source +title: IdentityProfileAllOfAuthoritativeSource +pagination_label: IdentityProfileAllOfAuthoritativeSource +sidebar_label: IdentityProfileAllOfAuthoritativeSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileAllOfAuthoritativeSource', 'V2025IdentityProfileAllOfAuthoritativeSource'] +slug: /tools/sdk/go/v2025/models/identity-profile-all-of-authoritative-source +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSource', 'V2025IdentityProfileAllOfAuthoritativeSource'] +--- + +# IdentityProfileAllOfAuthoritativeSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Authoritative source's object type. | [optional] +**Id** | Pointer to **string** | Authoritative source's ID. | [optional] +**Name** | Pointer to **string** | Authoritative source's name. | [optional] + +## Methods + +### NewIdentityProfileAllOfAuthoritativeSource + +`func NewIdentityProfileAllOfAuthoritativeSource() *IdentityProfileAllOfAuthoritativeSource` + +NewIdentityProfileAllOfAuthoritativeSource instantiates a new IdentityProfileAllOfAuthoritativeSource 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 + +### NewIdentityProfileAllOfAuthoritativeSourceWithDefaults + +`func NewIdentityProfileAllOfAuthoritativeSourceWithDefaults() *IdentityProfileAllOfAuthoritativeSource` + +NewIdentityProfileAllOfAuthoritativeSourceWithDefaults instantiates a new IdentityProfileAllOfAuthoritativeSource 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 + +### GetType + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityProfileAllOfAuthoritativeSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityProfileAllOfAuthoritativeSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfileAllOfAuthoritativeSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfileAllOfAuthoritativeSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfileAllOfAuthoritativeSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityProfileAllOfAuthoritativeSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfileAllOfOwner.md new file mode 100644 index 000000000..5162f9b1b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfileAllOfOwner.md @@ -0,0 +1,116 @@ +--- +id: v2025-identity-profile-all-of-owner +title: IdentityProfileAllOfOwner +pagination_label: IdentityProfileAllOfOwner +sidebar_label: IdentityProfileAllOfOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileAllOfOwner', 'V2025IdentityProfileAllOfOwner'] +slug: /tools/sdk/go/v2025/models/identity-profile-all-of-owner +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'V2025IdentityProfileAllOfOwner'] +--- + +# IdentityProfileAllOfOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's object type. | [optional] +**Id** | Pointer to **string** | Owner's ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] + +## Methods + +### NewIdentityProfileAllOfOwner + +`func NewIdentityProfileAllOfOwner() *IdentityProfileAllOfOwner` + +NewIdentityProfileAllOfOwner instantiates a new IdentityProfileAllOfOwner 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 + +### NewIdentityProfileAllOfOwnerWithDefaults + +`func NewIdentityProfileAllOfOwnerWithDefaults() *IdentityProfileAllOfOwner` + +NewIdentityProfileAllOfOwnerWithDefaults instantiates a new IdentityProfileAllOfOwner 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 + +### GetType + +`func (o *IdentityProfileAllOfOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityProfileAllOfOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityProfileAllOfOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityProfileAllOfOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityProfileAllOfOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfileAllOfOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfileAllOfOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfileAllOfOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfileAllOfOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfileAllOfOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfileAllOfOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityProfileAllOfOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfileExportedObject.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfileExportedObject.md new file mode 100644 index 000000000..8a8f31bf5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfileExportedObject.md @@ -0,0 +1,116 @@ +--- +id: v2025-identity-profile-exported-object +title: IdentityProfileExportedObject +pagination_label: IdentityProfileExportedObject +sidebar_label: IdentityProfileExportedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileExportedObject', 'V2025IdentityProfileExportedObject'] +slug: /tools/sdk/go/v2025/models/identity-profile-exported-object +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObject', 'V2025IdentityProfileExportedObject'] +--- + +# IdentityProfileExportedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **int32** | Version or object from the target service. | [optional] +**Self** | Pointer to [**IdentityProfileExportedObjectSelf**](identity-profile-exported-object-self) | | [optional] +**Object** | Pointer to [**IdentityProfile**](identity-profile) | | [optional] + +## Methods + +### NewIdentityProfileExportedObject + +`func NewIdentityProfileExportedObject() *IdentityProfileExportedObject` + +NewIdentityProfileExportedObject instantiates a new IdentityProfileExportedObject 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 + +### NewIdentityProfileExportedObjectWithDefaults + +`func NewIdentityProfileExportedObjectWithDefaults() *IdentityProfileExportedObject` + +NewIdentityProfileExportedObjectWithDefaults instantiates a new IdentityProfileExportedObject 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 + +### GetVersion + +`func (o *IdentityProfileExportedObject) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *IdentityProfileExportedObject) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *IdentityProfileExportedObject) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *IdentityProfileExportedObject) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### GetSelf + +`func (o *IdentityProfileExportedObject) GetSelf() IdentityProfileExportedObjectSelf` + +GetSelf returns the Self field if non-nil, zero value otherwise. + +### GetSelfOk + +`func (o *IdentityProfileExportedObject) GetSelfOk() (*IdentityProfileExportedObjectSelf, bool)` + +GetSelfOk returns a tuple with the Self field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelf + +`func (o *IdentityProfileExportedObject) SetSelf(v IdentityProfileExportedObjectSelf)` + +SetSelf sets Self field to given value. + +### HasSelf + +`func (o *IdentityProfileExportedObject) HasSelf() bool` + +HasSelf returns a boolean if a field has been set. + +### GetObject + +`func (o *IdentityProfileExportedObject) GetObject() IdentityProfile` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *IdentityProfileExportedObject) GetObjectOk() (*IdentityProfile, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *IdentityProfileExportedObject) SetObject(v IdentityProfile)` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *IdentityProfileExportedObject) HasObject() bool` + +HasObject returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfileExportedObjectSelf.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfileExportedObjectSelf.md new file mode 100644 index 000000000..bca3afaf3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfileExportedObjectSelf.md @@ -0,0 +1,116 @@ +--- +id: v2025-identity-profile-exported-object-self +title: IdentityProfileExportedObjectSelf +pagination_label: IdentityProfileExportedObjectSelf +sidebar_label: IdentityProfileExportedObjectSelf +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileExportedObjectSelf', 'V2025IdentityProfileExportedObjectSelf'] +slug: /tools/sdk/go/v2025/models/identity-profile-exported-object-self +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObjectSelf', 'V2025IdentityProfileExportedObjectSelf'] +--- + +# IdentityProfileExportedObjectSelf + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Exported object's DTO type. | [optional] +**Id** | Pointer to **string** | Exported object's ID. | [optional] +**Name** | Pointer to **string** | Exported object's display name. | [optional] + +## Methods + +### NewIdentityProfileExportedObjectSelf + +`func NewIdentityProfileExportedObjectSelf() *IdentityProfileExportedObjectSelf` + +NewIdentityProfileExportedObjectSelf instantiates a new IdentityProfileExportedObjectSelf 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 + +### NewIdentityProfileExportedObjectSelfWithDefaults + +`func NewIdentityProfileExportedObjectSelfWithDefaults() *IdentityProfileExportedObjectSelf` + +NewIdentityProfileExportedObjectSelfWithDefaults instantiates a new IdentityProfileExportedObjectSelf 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 + +### GetType + +`func (o *IdentityProfileExportedObjectSelf) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityProfileExportedObjectSelf) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityProfileExportedObjectSelf) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityProfileExportedObjectSelf) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityProfileExportedObjectSelf) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfileExportedObjectSelf) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfileExportedObjectSelf) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfileExportedObjectSelf) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfileExportedObjectSelf) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfileExportedObjectSelf) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfileExportedObjectSelf) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityProfileExportedObjectSelf) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfileIdentityErrorReportArguments.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfileIdentityErrorReportArguments.md new file mode 100644 index 000000000..bf4181483 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfileIdentityErrorReportArguments.md @@ -0,0 +1,59 @@ +--- +id: v2025-identity-profile-identity-error-report-arguments +title: IdentityProfileIdentityErrorReportArguments +pagination_label: IdentityProfileIdentityErrorReportArguments +sidebar_label: IdentityProfileIdentityErrorReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileIdentityErrorReportArguments', 'V2025IdentityProfileIdentityErrorReportArguments'] +slug: /tools/sdk/go/v2025/models/identity-profile-identity-error-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentityProfileIdentityErrorReportArguments', 'V2025IdentityProfileIdentityErrorReportArguments'] +--- + +# IdentityProfileIdentityErrorReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuthoritativeSource** | **string** | Source ID. | + +## Methods + +### NewIdentityProfileIdentityErrorReportArguments + +`func NewIdentityProfileIdentityErrorReportArguments(authoritativeSource string, ) *IdentityProfileIdentityErrorReportArguments` + +NewIdentityProfileIdentityErrorReportArguments instantiates a new IdentityProfileIdentityErrorReportArguments 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 + +### NewIdentityProfileIdentityErrorReportArgumentsWithDefaults + +`func NewIdentityProfileIdentityErrorReportArgumentsWithDefaults() *IdentityProfileIdentityErrorReportArguments` + +NewIdentityProfileIdentityErrorReportArgumentsWithDefaults instantiates a new IdentityProfileIdentityErrorReportArguments 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 + +### GetAuthoritativeSource + +`func (o *IdentityProfileIdentityErrorReportArguments) GetAuthoritativeSource() string` + +GetAuthoritativeSource returns the AuthoritativeSource field if non-nil, zero value otherwise. + +### GetAuthoritativeSourceOk + +`func (o *IdentityProfileIdentityErrorReportArguments) GetAuthoritativeSourceOk() (*string, bool)` + +GetAuthoritativeSourceOk returns a tuple with the AuthoritativeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritativeSource + +`func (o *IdentityProfileIdentityErrorReportArguments) SetAuthoritativeSource(v string)` + +SetAuthoritativeSource sets AuthoritativeSource field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfilesConnections.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfilesConnections.md new file mode 100644 index 000000000..8e36fe796 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityProfilesConnections.md @@ -0,0 +1,116 @@ +--- +id: v2025-identity-profiles-connections +title: IdentityProfilesConnections +pagination_label: IdentityProfilesConnections +sidebar_label: IdentityProfilesConnections +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfilesConnections', 'V2025IdentityProfilesConnections'] +slug: /tools/sdk/go/v2025/models/identity-profiles-connections +tags: ['SDK', 'Software Development Kit', 'IdentityProfilesConnections', 'V2025IdentityProfilesConnections'] +--- + +# IdentityProfilesConnections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the IdentityProfile this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the IdentityProfile to which this reference applies | [optional] +**IdentityCount** | Pointer to **int64** | The Number of Identities managed by this IdentityProfile | [optional] + +## Methods + +### NewIdentityProfilesConnections + +`func NewIdentityProfilesConnections() *IdentityProfilesConnections` + +NewIdentityProfilesConnections instantiates a new IdentityProfilesConnections 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 + +### NewIdentityProfilesConnectionsWithDefaults + +`func NewIdentityProfilesConnectionsWithDefaults() *IdentityProfilesConnections` + +NewIdentityProfilesConnectionsWithDefaults instantiates a new IdentityProfilesConnections 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 + +### GetId + +`func (o *IdentityProfilesConnections) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfilesConnections) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfilesConnections) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfilesConnections) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfilesConnections) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfilesConnections) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfilesConnections) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityProfilesConnections) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *IdentityProfilesConnections) GetIdentityCount() int64` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *IdentityProfilesConnections) GetIdentityCountOk() (*int64, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *IdentityProfilesConnections) SetIdentityCount(v int64)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *IdentityProfilesConnections) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityReference.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityReference.md new file mode 100644 index 000000000..a0aae0541 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityReference.md @@ -0,0 +1,116 @@ +--- +id: v2025-identity-reference +title: IdentityReference +pagination_label: IdentityReference +sidebar_label: IdentityReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityReference', 'V2025IdentityReference'] +slug: /tools/sdk/go/v2025/models/identity-reference +tags: ['SDK', 'Software Development Kit', 'IdentityReference', 'V2025IdentityReference'] +--- + +# IdentityReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | Identity id | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity. | [optional] + +## Methods + +### NewIdentityReference + +`func NewIdentityReference() *IdentityReference` + +NewIdentityReference instantiates a new IdentityReference 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 + +### NewIdentityReferenceWithDefaults + +`func NewIdentityReferenceWithDefaults() *IdentityReference` + +NewIdentityReferenceWithDefaults instantiates a new IdentityReference 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 + +### GetType + +`func (o *IdentityReference) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityReference) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityReference) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityReference) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityReferenceWithNameAndEmail.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityReferenceWithNameAndEmail.md new file mode 100644 index 000000000..293be2774 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityReferenceWithNameAndEmail.md @@ -0,0 +1,152 @@ +--- +id: v2025-identity-reference-with-name-and-email +title: IdentityReferenceWithNameAndEmail +pagination_label: IdentityReferenceWithNameAndEmail +sidebar_label: IdentityReferenceWithNameAndEmail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityReferenceWithNameAndEmail', 'V2025IdentityReferenceWithNameAndEmail'] +slug: /tools/sdk/go/v2025/models/identity-reference-with-name-and-email +tags: ['SDK', 'Software Development Kit', 'IdentityReferenceWithNameAndEmail', 'V2025IdentityReferenceWithNameAndEmail'] +--- + +# IdentityReferenceWithNameAndEmail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type can only be IDENTITY. This is read-only. | [optional] +**Id** | Pointer to **string** | Identity ID. | [optional] +**Name** | Pointer to **string** | Identity's human-readable display name. This is read-only. | [optional] +**Email** | Pointer to **NullableString** | Identity's email address. This is read-only. | [optional] + +## Methods + +### NewIdentityReferenceWithNameAndEmail + +`func NewIdentityReferenceWithNameAndEmail() *IdentityReferenceWithNameAndEmail` + +NewIdentityReferenceWithNameAndEmail instantiates a new IdentityReferenceWithNameAndEmail 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 + +### NewIdentityReferenceWithNameAndEmailWithDefaults + +`func NewIdentityReferenceWithNameAndEmailWithDefaults() *IdentityReferenceWithNameAndEmail` + +NewIdentityReferenceWithNameAndEmailWithDefaults instantiates a new IdentityReferenceWithNameAndEmail 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 + +### GetType + +`func (o *IdentityReferenceWithNameAndEmail) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityReferenceWithNameAndEmail) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityReferenceWithNameAndEmail) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityReferenceWithNameAndEmail) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityReferenceWithNameAndEmail) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityReferenceWithNameAndEmail) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityReferenceWithNameAndEmail) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityReferenceWithNameAndEmail) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityReferenceWithNameAndEmail) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityReferenceWithNameAndEmail) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityReferenceWithNameAndEmail) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityReferenceWithNameAndEmail) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *IdentityReferenceWithNameAndEmail) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *IdentityReferenceWithNameAndEmail) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *IdentityReferenceWithNameAndEmail) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *IdentityReferenceWithNameAndEmail) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### SetEmailNil + +`func (o *IdentityReferenceWithNameAndEmail) SetEmailNil(b bool)` + + SetEmailNil sets the value for Email to be an explicit nil + +### UnsetEmail +`func (o *IdentityReferenceWithNameAndEmail) UnsetEmail()` + +UnsetEmail ensures that no value is present for Email, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentitySnapshotSummaryResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentitySnapshotSummaryResponse.md new file mode 100644 index 000000000..75b6dd1da --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentitySnapshotSummaryResponse.md @@ -0,0 +1,64 @@ +--- +id: v2025-identity-snapshot-summary-response +title: IdentitySnapshotSummaryResponse +pagination_label: IdentitySnapshotSummaryResponse +sidebar_label: IdentitySnapshotSummaryResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitySnapshotSummaryResponse', 'V2025IdentitySnapshotSummaryResponse'] +slug: /tools/sdk/go/v2025/models/identity-snapshot-summary-response +tags: ['SDK', 'Software Development Kit', 'IdentitySnapshotSummaryResponse', 'V2025IdentitySnapshotSummaryResponse'] +--- + +# IdentitySnapshotSummaryResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Snapshot** | Pointer to **string** | the date when the identity record was created | [optional] + +## Methods + +### NewIdentitySnapshotSummaryResponse + +`func NewIdentitySnapshotSummaryResponse() *IdentitySnapshotSummaryResponse` + +NewIdentitySnapshotSummaryResponse instantiates a new IdentitySnapshotSummaryResponse 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 + +### NewIdentitySnapshotSummaryResponseWithDefaults + +`func NewIdentitySnapshotSummaryResponseWithDefaults() *IdentitySnapshotSummaryResponse` + +NewIdentitySnapshotSummaryResponseWithDefaults instantiates a new IdentitySnapshotSummaryResponse 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 + +### GetSnapshot + +`func (o *IdentitySnapshotSummaryResponse) GetSnapshot() string` + +GetSnapshot returns the Snapshot field if non-nil, zero value otherwise. + +### GetSnapshotOk + +`func (o *IdentitySnapshotSummaryResponse) GetSnapshotOk() (*string, bool)` + +GetSnapshotOk returns a tuple with the Snapshot field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshot + +`func (o *IdentitySnapshotSummaryResponse) SetSnapshot(v string)` + +SetSnapshot sets Snapshot field to given value. + +### HasSnapshot + +`func (o *IdentitySnapshotSummaryResponse) HasSnapshot() bool` + +HasSnapshot returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentitySummary.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentitySummary.md new file mode 100644 index 000000000..661d21dfa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentitySummary.md @@ -0,0 +1,142 @@ +--- +id: v2025-identity-summary +title: IdentitySummary +pagination_label: IdentitySummary +sidebar_label: IdentitySummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitySummary', 'V2025IdentitySummary'] +slug: /tools/sdk/go/v2025/models/identity-summary +tags: ['SDK', 'Software Development Kit', 'IdentitySummary', 'V2025IdentitySummary'] +--- + +# IdentitySummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of this identity summary | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity | [optional] +**IdentityId** | Pointer to **string** | ID of the identity that this summary represents | [optional] +**Completed** | Pointer to **bool** | Indicates if all access items for this summary have been decided on | [optional] [default to false] + +## Methods + +### NewIdentitySummary + +`func NewIdentitySummary() *IdentitySummary` + +NewIdentitySummary instantiates a new IdentitySummary 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 + +### NewIdentitySummaryWithDefaults + +`func NewIdentitySummaryWithDefaults() *IdentitySummary` + +NewIdentitySummaryWithDefaults instantiates a new IdentitySummary 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 + +### GetId + +`func (o *IdentitySummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentitySummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentitySummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentitySummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentitySummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentitySummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentitySummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentitySummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *IdentitySummary) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *IdentitySummary) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *IdentitySummary) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *IdentitySummary) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetCompleted + +`func (o *IdentitySummary) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *IdentitySummary) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *IdentitySummary) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *IdentitySummary) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentitySyncJob.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentitySyncJob.md new file mode 100644 index 000000000..650076cfb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentitySyncJob.md @@ -0,0 +1,101 @@ +--- +id: v2025-identity-sync-job +title: IdentitySyncJob +pagination_label: IdentitySyncJob +sidebar_label: IdentitySyncJob +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitySyncJob', 'V2025IdentitySyncJob'] +slug: /tools/sdk/go/v2025/models/identity-sync-job +tags: ['SDK', 'Software Development Kit', 'IdentitySyncJob', 'V2025IdentitySyncJob'] +--- + +# IdentitySyncJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Job ID. | +**Status** | **string** | The job status. | +**Payload** | [**IdentitySyncPayload**](identity-sync-payload) | | + +## Methods + +### NewIdentitySyncJob + +`func NewIdentitySyncJob(id string, status string, payload IdentitySyncPayload, ) *IdentitySyncJob` + +NewIdentitySyncJob instantiates a new IdentitySyncJob 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 + +### NewIdentitySyncJobWithDefaults + +`func NewIdentitySyncJobWithDefaults() *IdentitySyncJob` + +NewIdentitySyncJobWithDefaults instantiates a new IdentitySyncJob 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 + +### GetId + +`func (o *IdentitySyncJob) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentitySyncJob) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentitySyncJob) SetId(v string)` + +SetId sets Id field to given value. + + +### GetStatus + +`func (o *IdentitySyncJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *IdentitySyncJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *IdentitySyncJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetPayload + +`func (o *IdentitySyncJob) GetPayload() IdentitySyncPayload` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *IdentitySyncJob) GetPayloadOk() (*IdentitySyncPayload, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPayload + +`func (o *IdentitySyncJob) SetPayload(v IdentitySyncPayload)` + +SetPayload sets Payload field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentitySyncPayload.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentitySyncPayload.md new file mode 100644 index 000000000..48d899744 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentitySyncPayload.md @@ -0,0 +1,80 @@ +--- +id: v2025-identity-sync-payload +title: IdentitySyncPayload +pagination_label: IdentitySyncPayload +sidebar_label: IdentitySyncPayload +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitySyncPayload', 'V2025IdentitySyncPayload'] +slug: /tools/sdk/go/v2025/models/identity-sync-payload +tags: ['SDK', 'Software Development Kit', 'IdentitySyncPayload', 'V2025IdentitySyncPayload'] +--- + +# IdentitySyncPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Payload type. | +**DataJson** | **string** | Payload type. | + +## Methods + +### NewIdentitySyncPayload + +`func NewIdentitySyncPayload(type_ string, dataJson string, ) *IdentitySyncPayload` + +NewIdentitySyncPayload instantiates a new IdentitySyncPayload 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 + +### NewIdentitySyncPayloadWithDefaults + +`func NewIdentitySyncPayloadWithDefaults() *IdentitySyncPayload` + +NewIdentitySyncPayloadWithDefaults instantiates a new IdentitySyncPayload 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 + +### GetType + +`func (o *IdentitySyncPayload) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentitySyncPayload) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentitySyncPayload) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDataJson + +`func (o *IdentitySyncPayload) GetDataJson() string` + +GetDataJson returns the DataJson field if non-nil, zero value otherwise. + +### GetDataJsonOk + +`func (o *IdentitySyncPayload) GetDataJsonOk() (*string, bool)` + +GetDataJsonOk returns a tuple with the DataJson field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataJson + +`func (o *IdentitySyncPayload) SetDataJson(v string)` + +SetDataJson sets DataJson field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityWithNewAccess.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityWithNewAccess.md new file mode 100644 index 000000000..3f81fe7aa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityWithNewAccess.md @@ -0,0 +1,80 @@ +--- +id: v2025-identity-with-new-access +title: IdentityWithNewAccess +pagination_label: IdentityWithNewAccess +sidebar_label: IdentityWithNewAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityWithNewAccess', 'V2025IdentityWithNewAccess'] +slug: /tools/sdk/go/v2025/models/identity-with-new-access +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess', 'V2025IdentityWithNewAccess'] +--- + +# IdentityWithNewAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **string** | Identity id to be checked. | +**AccessRefs** | [**[]IdentityWithNewAccessAccessRefsInner**](identity-with-new-access-access-refs-inner) | The list of entitlements to consider for possible violations in a preventive check. | + +## Methods + +### NewIdentityWithNewAccess + +`func NewIdentityWithNewAccess(identityId string, accessRefs []IdentityWithNewAccessAccessRefsInner, ) *IdentityWithNewAccess` + +NewIdentityWithNewAccess instantiates a new IdentityWithNewAccess 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 + +### NewIdentityWithNewAccessWithDefaults + +`func NewIdentityWithNewAccessWithDefaults() *IdentityWithNewAccess` + +NewIdentityWithNewAccessWithDefaults instantiates a new IdentityWithNewAccess 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 + +### GetIdentityId + +`func (o *IdentityWithNewAccess) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *IdentityWithNewAccess) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *IdentityWithNewAccess) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetAccessRefs + +`func (o *IdentityWithNewAccess) GetAccessRefs() []IdentityWithNewAccessAccessRefsInner` + +GetAccessRefs returns the AccessRefs field if non-nil, zero value otherwise. + +### GetAccessRefsOk + +`func (o *IdentityWithNewAccess) GetAccessRefsOk() (*[]IdentityWithNewAccessAccessRefsInner, bool)` + +GetAccessRefsOk returns a tuple with the AccessRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRefs + +`func (o *IdentityWithNewAccess) SetAccessRefs(v []IdentityWithNewAccessAccessRefsInner)` + +SetAccessRefs sets AccessRefs field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityWithNewAccess1.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityWithNewAccess1.md new file mode 100644 index 000000000..a0fbd25a5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityWithNewAccess1.md @@ -0,0 +1,106 @@ +--- +id: v2025-identity-with-new-access1 +title: IdentityWithNewAccess1 +pagination_label: IdentityWithNewAccess1 +sidebar_label: IdentityWithNewAccess1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityWithNewAccess1', 'V2025IdentityWithNewAccess1'] +slug: /tools/sdk/go/v2025/models/identity-with-new-access1 +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess1', 'V2025IdentityWithNewAccess1'] +--- + +# IdentityWithNewAccess1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **string** | Set of identity IDs to be checked. | +**AccessRefs** | [**[]EntitlementRef1**](entitlement-ref1) | The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. | +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] + +## Methods + +### NewIdentityWithNewAccess1 + +`func NewIdentityWithNewAccess1(identityId string, accessRefs []EntitlementRef1, ) *IdentityWithNewAccess1` + +NewIdentityWithNewAccess1 instantiates a new IdentityWithNewAccess1 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 + +### NewIdentityWithNewAccess1WithDefaults + +`func NewIdentityWithNewAccess1WithDefaults() *IdentityWithNewAccess1` + +NewIdentityWithNewAccess1WithDefaults instantiates a new IdentityWithNewAccess1 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 + +### GetIdentityId + +`func (o *IdentityWithNewAccess1) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *IdentityWithNewAccess1) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *IdentityWithNewAccess1) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetAccessRefs + +`func (o *IdentityWithNewAccess1) GetAccessRefs() []EntitlementRef1` + +GetAccessRefs returns the AccessRefs field if non-nil, zero value otherwise. + +### GetAccessRefsOk + +`func (o *IdentityWithNewAccess1) GetAccessRefsOk() (*[]EntitlementRef1, bool)` + +GetAccessRefsOk returns a tuple with the AccessRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRefs + +`func (o *IdentityWithNewAccess1) SetAccessRefs(v []EntitlementRef1)` + +SetAccessRefs sets AccessRefs field to given value. + + +### GetClientMetadata + +`func (o *IdentityWithNewAccess1) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *IdentityWithNewAccess1) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *IdentityWithNewAccess1) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *IdentityWithNewAccess1) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/go/Reference/V2025/Models/IdentityWithNewAccessAccessRefsInner.md new file mode 100644 index 000000000..95a8bfe28 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdentityWithNewAccessAccessRefsInner.md @@ -0,0 +1,116 @@ +--- +id: v2025-identity-with-new-access-access-refs-inner +title: IdentityWithNewAccessAccessRefsInner +pagination_label: IdentityWithNewAccessAccessRefsInner +sidebar_label: IdentityWithNewAccessAccessRefsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityWithNewAccessAccessRefsInner', 'V2025IdentityWithNewAccessAccessRefsInner'] +slug: /tools/sdk/go/v2025/models/identity-with-new-access-access-refs-inner +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccessAccessRefsInner', 'V2025IdentityWithNewAccessAccessRefsInner'] +--- + +# IdentityWithNewAccessAccessRefsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Entitlement's DTO type. | [optional] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **string** | Entitlement's display name. | [optional] + +## Methods + +### NewIdentityWithNewAccessAccessRefsInner + +`func NewIdentityWithNewAccessAccessRefsInner() *IdentityWithNewAccessAccessRefsInner` + +NewIdentityWithNewAccessAccessRefsInner instantiates a new IdentityWithNewAccessAccessRefsInner 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 + +### NewIdentityWithNewAccessAccessRefsInnerWithDefaults + +`func NewIdentityWithNewAccessAccessRefsInnerWithDefaults() *IdentityWithNewAccessAccessRefsInner` + +NewIdentityWithNewAccessAccessRefsInnerWithDefaults instantiates a new IdentityWithNewAccessAccessRefsInner 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 + +### GetType + +`func (o *IdentityWithNewAccessAccessRefsInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityWithNewAccessAccessRefsInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityWithNewAccessAccessRefsInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityWithNewAccessAccessRefsInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityWithNewAccessAccessRefsInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityWithNewAccessAccessRefsInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityWithNewAccessAccessRefsInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityWithNewAccessAccessRefsInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityWithNewAccessAccessRefsInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityWithNewAccessAccessRefsInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityWithNewAccessAccessRefsInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityWithNewAccessAccessRefsInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/IdpDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/IdpDetails.md new file mode 100644 index 000000000..7a60c0fc6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/IdpDetails.md @@ -0,0 +1,397 @@ +--- +id: v2025-idp-details +title: IdpDetails +pagination_label: IdpDetails +sidebar_label: IdpDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdpDetails', 'V2025IdpDetails'] +slug: /tools/sdk/go/v2025/models/idp-details +tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'V2025IdpDetails'] +--- + +# IdpDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | Pointer to **string** | Federation protocol role | [optional] +**EntityId** | Pointer to **string** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Binding** | Pointer to **string** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**AuthnContext** | Pointer to **string** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**LogoutUrl** | Pointer to **string** | The IDP logout URL. Used with IDP configurations. | [optional] +**IncludeAuthnContext** | Pointer to **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to false] +**NameId** | Pointer to **string** | The name id format to use. Used with IDP configurations. | [optional] +**JitConfiguration** | Pointer to [**JITConfiguration**](jit-configuration) | | [optional] +**Cert** | Pointer to **string** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**LoginUrlPost** | Pointer to **string** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**LoginUrlRedirect** | Pointer to **string** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**MappingAttribute** | **string** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | +**CertificateExpirationDate** | Pointer to **string** | The expiration date extracted from the certificate. | [optional] +**CertificateName** | Pointer to **string** | The name extracted from the certificate. | [optional] + +## Methods + +### NewIdpDetails + +`func NewIdpDetails(mappingAttribute string, ) *IdpDetails` + +NewIdpDetails instantiates a new IdpDetails 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 + +### NewIdpDetailsWithDefaults + +`func NewIdpDetailsWithDefaults() *IdpDetails` + +NewIdpDetailsWithDefaults instantiates a new IdpDetails 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 + +### GetRole + +`func (o *IdpDetails) GetRole() string` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *IdpDetails) GetRoleOk() (*string, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *IdpDetails) SetRole(v string)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *IdpDetails) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetEntityId + +`func (o *IdpDetails) GetEntityId() string` + +GetEntityId returns the EntityId field if non-nil, zero value otherwise. + +### GetEntityIdOk + +`func (o *IdpDetails) GetEntityIdOk() (*string, bool)` + +GetEntityIdOk returns a tuple with the EntityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntityId + +`func (o *IdpDetails) SetEntityId(v string)` + +SetEntityId sets EntityId field to given value. + +### HasEntityId + +`func (o *IdpDetails) HasEntityId() bool` + +HasEntityId returns a boolean if a field has been set. + +### GetBinding + +`func (o *IdpDetails) GetBinding() string` + +GetBinding returns the Binding field if non-nil, zero value otherwise. + +### GetBindingOk + +`func (o *IdpDetails) GetBindingOk() (*string, bool)` + +GetBindingOk returns a tuple with the Binding field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBinding + +`func (o *IdpDetails) SetBinding(v string)` + +SetBinding sets Binding field to given value. + +### HasBinding + +`func (o *IdpDetails) HasBinding() bool` + +HasBinding returns a boolean if a field has been set. + +### GetAuthnContext + +`func (o *IdpDetails) GetAuthnContext() string` + +GetAuthnContext returns the AuthnContext field if non-nil, zero value otherwise. + +### GetAuthnContextOk + +`func (o *IdpDetails) GetAuthnContextOk() (*string, bool)` + +GetAuthnContextOk returns a tuple with the AuthnContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthnContext + +`func (o *IdpDetails) SetAuthnContext(v string)` + +SetAuthnContext sets AuthnContext field to given value. + +### HasAuthnContext + +`func (o *IdpDetails) HasAuthnContext() bool` + +HasAuthnContext returns a boolean if a field has been set. + +### GetLogoutUrl + +`func (o *IdpDetails) GetLogoutUrl() string` + +GetLogoutUrl returns the LogoutUrl field if non-nil, zero value otherwise. + +### GetLogoutUrlOk + +`func (o *IdpDetails) GetLogoutUrlOk() (*string, bool)` + +GetLogoutUrlOk returns a tuple with the LogoutUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogoutUrl + +`func (o *IdpDetails) SetLogoutUrl(v string)` + +SetLogoutUrl sets LogoutUrl field to given value. + +### HasLogoutUrl + +`func (o *IdpDetails) HasLogoutUrl() bool` + +HasLogoutUrl returns a boolean if a field has been set. + +### GetIncludeAuthnContext + +`func (o *IdpDetails) GetIncludeAuthnContext() bool` + +GetIncludeAuthnContext returns the IncludeAuthnContext field if non-nil, zero value otherwise. + +### GetIncludeAuthnContextOk + +`func (o *IdpDetails) GetIncludeAuthnContextOk() (*bool, bool)` + +GetIncludeAuthnContextOk returns a tuple with the IncludeAuthnContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeAuthnContext + +`func (o *IdpDetails) SetIncludeAuthnContext(v bool)` + +SetIncludeAuthnContext sets IncludeAuthnContext field to given value. + +### HasIncludeAuthnContext + +`func (o *IdpDetails) HasIncludeAuthnContext() bool` + +HasIncludeAuthnContext returns a boolean if a field has been set. + +### GetNameId + +`func (o *IdpDetails) GetNameId() string` + +GetNameId returns the NameId field if non-nil, zero value otherwise. + +### GetNameIdOk + +`func (o *IdpDetails) GetNameIdOk() (*string, bool)` + +GetNameIdOk returns a tuple with the NameId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNameId + +`func (o *IdpDetails) SetNameId(v string)` + +SetNameId sets NameId field to given value. + +### HasNameId + +`func (o *IdpDetails) HasNameId() bool` + +HasNameId returns a boolean if a field has been set. + +### GetJitConfiguration + +`func (o *IdpDetails) GetJitConfiguration() JITConfiguration` + +GetJitConfiguration returns the JitConfiguration field if non-nil, zero value otherwise. + +### GetJitConfigurationOk + +`func (o *IdpDetails) GetJitConfigurationOk() (*JITConfiguration, bool)` + +GetJitConfigurationOk returns a tuple with the JitConfiguration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJitConfiguration + +`func (o *IdpDetails) SetJitConfiguration(v JITConfiguration)` + +SetJitConfiguration sets JitConfiguration field to given value. + +### HasJitConfiguration + +`func (o *IdpDetails) HasJitConfiguration() bool` + +HasJitConfiguration returns a boolean if a field has been set. + +### GetCert + +`func (o *IdpDetails) GetCert() string` + +GetCert returns the Cert field if non-nil, zero value otherwise. + +### GetCertOk + +`func (o *IdpDetails) GetCertOk() (*string, bool)` + +GetCertOk returns a tuple with the Cert field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCert + +`func (o *IdpDetails) SetCert(v string)` + +SetCert sets Cert field to given value. + +### HasCert + +`func (o *IdpDetails) HasCert() bool` + +HasCert returns a boolean if a field has been set. + +### GetLoginUrlPost + +`func (o *IdpDetails) GetLoginUrlPost() string` + +GetLoginUrlPost returns the LoginUrlPost field if non-nil, zero value otherwise. + +### GetLoginUrlPostOk + +`func (o *IdpDetails) GetLoginUrlPostOk() (*string, bool)` + +GetLoginUrlPostOk returns a tuple with the LoginUrlPost field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginUrlPost + +`func (o *IdpDetails) SetLoginUrlPost(v string)` + +SetLoginUrlPost sets LoginUrlPost field to given value. + +### HasLoginUrlPost + +`func (o *IdpDetails) HasLoginUrlPost() bool` + +HasLoginUrlPost returns a boolean if a field has been set. + +### GetLoginUrlRedirect + +`func (o *IdpDetails) GetLoginUrlRedirect() string` + +GetLoginUrlRedirect returns the LoginUrlRedirect field if non-nil, zero value otherwise. + +### GetLoginUrlRedirectOk + +`func (o *IdpDetails) GetLoginUrlRedirectOk() (*string, bool)` + +GetLoginUrlRedirectOk returns a tuple with the LoginUrlRedirect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginUrlRedirect + +`func (o *IdpDetails) SetLoginUrlRedirect(v string)` + +SetLoginUrlRedirect sets LoginUrlRedirect field to given value. + +### HasLoginUrlRedirect + +`func (o *IdpDetails) HasLoginUrlRedirect() bool` + +HasLoginUrlRedirect returns a boolean if a field has been set. + +### GetMappingAttribute + +`func (o *IdpDetails) GetMappingAttribute() string` + +GetMappingAttribute returns the MappingAttribute field if non-nil, zero value otherwise. + +### GetMappingAttributeOk + +`func (o *IdpDetails) GetMappingAttributeOk() (*string, bool)` + +GetMappingAttributeOk returns a tuple with the MappingAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMappingAttribute + +`func (o *IdpDetails) SetMappingAttribute(v string)` + +SetMappingAttribute sets MappingAttribute field to given value. + + +### GetCertificateExpirationDate + +`func (o *IdpDetails) GetCertificateExpirationDate() string` + +GetCertificateExpirationDate returns the CertificateExpirationDate field if non-nil, zero value otherwise. + +### GetCertificateExpirationDateOk + +`func (o *IdpDetails) GetCertificateExpirationDateOk() (*string, bool)` + +GetCertificateExpirationDateOk returns a tuple with the CertificateExpirationDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificateExpirationDate + +`func (o *IdpDetails) SetCertificateExpirationDate(v string)` + +SetCertificateExpirationDate sets CertificateExpirationDate field to given value. + +### HasCertificateExpirationDate + +`func (o *IdpDetails) HasCertificateExpirationDate() bool` + +HasCertificateExpirationDate returns a boolean if a field has been set. + +### GetCertificateName + +`func (o *IdpDetails) GetCertificateName() string` + +GetCertificateName returns the CertificateName field if non-nil, zero value otherwise. + +### GetCertificateNameOk + +`func (o *IdpDetails) GetCertificateNameOk() (*string, bool)` + +GetCertificateNameOk returns a tuple with the CertificateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificateName + +`func (o *IdpDetails) SetCertificateName(v string)` + +SetCertificateName sets CertificateName field to given value. + +### HasCertificateName + +`func (o *IdpDetails) HasCertificateName() bool` + +HasCertificateName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ImportAccountsRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/ImportAccountsRequest.md new file mode 100644 index 000000000..bb8fc667e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ImportAccountsRequest.md @@ -0,0 +1,90 @@ +--- +id: v2025-import-accounts-request +title: ImportAccountsRequest +pagination_label: ImportAccountsRequest +sidebar_label: ImportAccountsRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportAccountsRequest', 'V2025ImportAccountsRequest'] +slug: /tools/sdk/go/v2025/models/import-accounts-request +tags: ['SDK', 'Software Development Kit', 'ImportAccountsRequest', 'V2025ImportAccountsRequest'] +--- + +# ImportAccountsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | Pointer to ***os.File** | The CSV file containing the source accounts to aggregate. | [optional] +**DisableOptimization** | Pointer to **string** | Use this flag to reprocess every account whether or not the data has changed. | [optional] + +## Methods + +### NewImportAccountsRequest + +`func NewImportAccountsRequest() *ImportAccountsRequest` + +NewImportAccountsRequest instantiates a new ImportAccountsRequest 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 + +### NewImportAccountsRequestWithDefaults + +`func NewImportAccountsRequestWithDefaults() *ImportAccountsRequest` + +NewImportAccountsRequestWithDefaults instantiates a new ImportAccountsRequest 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 + +### GetFile + +`func (o *ImportAccountsRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *ImportAccountsRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *ImportAccountsRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + +### HasFile + +`func (o *ImportAccountsRequest) HasFile() bool` + +HasFile returns a boolean if a field has been set. + +### GetDisableOptimization + +`func (o *ImportAccountsRequest) GetDisableOptimization() string` + +GetDisableOptimization returns the DisableOptimization field if non-nil, zero value otherwise. + +### GetDisableOptimizationOk + +`func (o *ImportAccountsRequest) GetDisableOptimizationOk() (*string, bool)` + +GetDisableOptimizationOk returns a tuple with the DisableOptimization field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisableOptimization + +`func (o *ImportAccountsRequest) SetDisableOptimization(v string)` + +SetDisableOptimization sets DisableOptimization field to given value. + +### HasDisableOptimization + +`func (o *ImportAccountsRequest) HasDisableOptimization() bool` + +HasDisableOptimization returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ImportEntitlementsBySourceRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/ImportEntitlementsBySourceRequest.md new file mode 100644 index 000000000..841d394b5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ImportEntitlementsBySourceRequest.md @@ -0,0 +1,64 @@ +--- +id: v2025-import-entitlements-by-source-request +title: ImportEntitlementsBySourceRequest +pagination_label: ImportEntitlementsBySourceRequest +sidebar_label: ImportEntitlementsBySourceRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportEntitlementsBySourceRequest', 'V2025ImportEntitlementsBySourceRequest'] +slug: /tools/sdk/go/v2025/models/import-entitlements-by-source-request +tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsBySourceRequest', 'V2025ImportEntitlementsBySourceRequest'] +--- + +# ImportEntitlementsBySourceRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CsvFile** | Pointer to ***os.File** | The CSV file containing the source entitlements to aggregate. | [optional] + +## Methods + +### NewImportEntitlementsBySourceRequest + +`func NewImportEntitlementsBySourceRequest() *ImportEntitlementsBySourceRequest` + +NewImportEntitlementsBySourceRequest instantiates a new ImportEntitlementsBySourceRequest 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 + +### NewImportEntitlementsBySourceRequestWithDefaults + +`func NewImportEntitlementsBySourceRequestWithDefaults() *ImportEntitlementsBySourceRequest` + +NewImportEntitlementsBySourceRequestWithDefaults instantiates a new ImportEntitlementsBySourceRequest 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 + +### GetCsvFile + +`func (o *ImportEntitlementsBySourceRequest) GetCsvFile() *os.File` + +GetCsvFile returns the CsvFile field if non-nil, zero value otherwise. + +### GetCsvFileOk + +`func (o *ImportEntitlementsBySourceRequest) GetCsvFileOk() (**os.File, bool)` + +GetCsvFileOk returns a tuple with the CsvFile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCsvFile + +`func (o *ImportEntitlementsBySourceRequest) SetCsvFile(v *os.File)` + +SetCsvFile sets CsvFile field to given value. + +### HasCsvFile + +`func (o *ImportEntitlementsBySourceRequest) HasCsvFile() bool` + +HasCsvFile returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ImportFormDefinitions202Response.md b/docs/tools/sdk/go/Reference/V2025/Models/ImportFormDefinitions202Response.md new file mode 100644 index 000000000..463d3091f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ImportFormDefinitions202Response.md @@ -0,0 +1,142 @@ +--- +id: v2025-import-form-definitions202-response +title: ImportFormDefinitions202Response +pagination_label: ImportFormDefinitions202Response +sidebar_label: ImportFormDefinitions202Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportFormDefinitions202Response', 'V2025ImportFormDefinitions202Response'] +slug: /tools/sdk/go/v2025/models/import-form-definitions202-response +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202Response', 'V2025ImportFormDefinitions202Response'] +--- + +# ImportFormDefinitions202Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] +**ImportedObjects** | Pointer to [**[]ImportFormDefinitionsRequestInner**](import-form-definitions-request-inner) | | [optional] +**Infos** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] +**Warnings** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] + +## Methods + +### NewImportFormDefinitions202Response + +`func NewImportFormDefinitions202Response() *ImportFormDefinitions202Response` + +NewImportFormDefinitions202Response instantiates a new ImportFormDefinitions202Response 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 + +### NewImportFormDefinitions202ResponseWithDefaults + +`func NewImportFormDefinitions202ResponseWithDefaults() *ImportFormDefinitions202Response` + +NewImportFormDefinitions202ResponseWithDefaults instantiates a new ImportFormDefinitions202Response 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 + +### GetErrors + +`func (o *ImportFormDefinitions202Response) GetErrors() []ImportFormDefinitions202ResponseErrorsInner` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *ImportFormDefinitions202Response) GetErrorsOk() (*[]ImportFormDefinitions202ResponseErrorsInner, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *ImportFormDefinitions202Response) SetErrors(v []ImportFormDefinitions202ResponseErrorsInner)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *ImportFormDefinitions202Response) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### GetImportedObjects + +`func (o *ImportFormDefinitions202Response) GetImportedObjects() []ImportFormDefinitionsRequestInner` + +GetImportedObjects returns the ImportedObjects field if non-nil, zero value otherwise. + +### GetImportedObjectsOk + +`func (o *ImportFormDefinitions202Response) GetImportedObjectsOk() (*[]ImportFormDefinitionsRequestInner, bool)` + +GetImportedObjectsOk returns a tuple with the ImportedObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImportedObjects + +`func (o *ImportFormDefinitions202Response) SetImportedObjects(v []ImportFormDefinitionsRequestInner)` + +SetImportedObjects sets ImportedObjects field to given value. + +### HasImportedObjects + +`func (o *ImportFormDefinitions202Response) HasImportedObjects() bool` + +HasImportedObjects returns a boolean if a field has been set. + +### GetInfos + +`func (o *ImportFormDefinitions202Response) GetInfos() []ImportFormDefinitions202ResponseErrorsInner` + +GetInfos returns the Infos field if non-nil, zero value otherwise. + +### GetInfosOk + +`func (o *ImportFormDefinitions202Response) GetInfosOk() (*[]ImportFormDefinitions202ResponseErrorsInner, bool)` + +GetInfosOk returns a tuple with the Infos field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfos + +`func (o *ImportFormDefinitions202Response) SetInfos(v []ImportFormDefinitions202ResponseErrorsInner)` + +SetInfos sets Infos field to given value. + +### HasInfos + +`func (o *ImportFormDefinitions202Response) HasInfos() bool` + +HasInfos returns a boolean if a field has been set. + +### GetWarnings + +`func (o *ImportFormDefinitions202Response) GetWarnings() []ImportFormDefinitions202ResponseErrorsInner` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *ImportFormDefinitions202Response) GetWarningsOk() (*[]ImportFormDefinitions202ResponseErrorsInner, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *ImportFormDefinitions202Response) SetWarnings(v []ImportFormDefinitions202ResponseErrorsInner)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *ImportFormDefinitions202Response) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ImportFormDefinitions202ResponseErrorsInner.md b/docs/tools/sdk/go/Reference/V2025/Models/ImportFormDefinitions202ResponseErrorsInner.md new file mode 100644 index 000000000..67e12feb8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ImportFormDefinitions202ResponseErrorsInner.md @@ -0,0 +1,116 @@ +--- +id: v2025-import-form-definitions202-response-errors-inner +title: ImportFormDefinitions202ResponseErrorsInner +pagination_label: ImportFormDefinitions202ResponseErrorsInner +sidebar_label: ImportFormDefinitions202ResponseErrorsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportFormDefinitions202ResponseErrorsInner', 'V2025ImportFormDefinitions202ResponseErrorsInner'] +slug: /tools/sdk/go/v2025/models/import-form-definitions202-response-errors-inner +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202ResponseErrorsInner', 'V2025ImportFormDefinitions202ResponseErrorsInner'] +--- + +# ImportFormDefinitions202ResponseErrorsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Detail** | Pointer to **map[string]map[string]interface{}** | | [optional] +**Key** | Pointer to **string** | | [optional] +**Text** | Pointer to **string** | | [optional] + +## Methods + +### NewImportFormDefinitions202ResponseErrorsInner + +`func NewImportFormDefinitions202ResponseErrorsInner() *ImportFormDefinitions202ResponseErrorsInner` + +NewImportFormDefinitions202ResponseErrorsInner instantiates a new ImportFormDefinitions202ResponseErrorsInner 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 + +### NewImportFormDefinitions202ResponseErrorsInnerWithDefaults + +`func NewImportFormDefinitions202ResponseErrorsInnerWithDefaults() *ImportFormDefinitions202ResponseErrorsInner` + +NewImportFormDefinitions202ResponseErrorsInnerWithDefaults instantiates a new ImportFormDefinitions202ResponseErrorsInner 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 + +### GetDetail + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetDetail() map[string]map[string]interface{}` + +GetDetail returns the Detail field if non-nil, zero value otherwise. + +### GetDetailOk + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetDetailOk() (*map[string]map[string]interface{}, bool)` + +GetDetailOk returns a tuple with the Detail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetail + +`func (o *ImportFormDefinitions202ResponseErrorsInner) SetDetail(v map[string]map[string]interface{})` + +SetDetail sets Detail field to given value. + +### HasDetail + +`func (o *ImportFormDefinitions202ResponseErrorsInner) HasDetail() bool` + +HasDetail returns a boolean if a field has been set. + +### GetKey + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *ImportFormDefinitions202ResponseErrorsInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *ImportFormDefinitions202ResponseErrorsInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetText + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *ImportFormDefinitions202ResponseErrorsInner) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *ImportFormDefinitions202ResponseErrorsInner) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *ImportFormDefinitions202ResponseErrorsInner) HasText() bool` + +HasText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ImportFormDefinitionsRequestInner.md b/docs/tools/sdk/go/Reference/V2025/Models/ImportFormDefinitionsRequestInner.md new file mode 100644 index 000000000..ca5570863 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ImportFormDefinitionsRequestInner.md @@ -0,0 +1,116 @@ +--- +id: v2025-import-form-definitions-request-inner +title: ImportFormDefinitionsRequestInner +pagination_label: ImportFormDefinitionsRequestInner +sidebar_label: ImportFormDefinitionsRequestInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportFormDefinitionsRequestInner', 'V2025ImportFormDefinitionsRequestInner'] +slug: /tools/sdk/go/v2025/models/import-form-definitions-request-inner +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitionsRequestInner', 'V2025ImportFormDefinitionsRequestInner'] +--- + +# ImportFormDefinitionsRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Object** | Pointer to [**FormDefinitionResponse**](form-definition-response) | | [optional] +**Self** | Pointer to **string** | | [optional] +**Version** | Pointer to **int32** | | [optional] + +## Methods + +### NewImportFormDefinitionsRequestInner + +`func NewImportFormDefinitionsRequestInner() *ImportFormDefinitionsRequestInner` + +NewImportFormDefinitionsRequestInner instantiates a new ImportFormDefinitionsRequestInner 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 + +### NewImportFormDefinitionsRequestInnerWithDefaults + +`func NewImportFormDefinitionsRequestInnerWithDefaults() *ImportFormDefinitionsRequestInner` + +NewImportFormDefinitionsRequestInnerWithDefaults instantiates a new ImportFormDefinitionsRequestInner 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 + +### GetObject + +`func (o *ImportFormDefinitionsRequestInner) GetObject() FormDefinitionResponse` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *ImportFormDefinitionsRequestInner) GetObjectOk() (*FormDefinitionResponse, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *ImportFormDefinitionsRequestInner) SetObject(v FormDefinitionResponse)` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *ImportFormDefinitionsRequestInner) HasObject() bool` + +HasObject returns a boolean if a field has been set. + +### GetSelf + +`func (o *ImportFormDefinitionsRequestInner) GetSelf() string` + +GetSelf returns the Self field if non-nil, zero value otherwise. + +### GetSelfOk + +`func (o *ImportFormDefinitionsRequestInner) GetSelfOk() (*string, bool)` + +GetSelfOk returns a tuple with the Self field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelf + +`func (o *ImportFormDefinitionsRequestInner) SetSelf(v string)` + +SetSelf sets Self field to given value. + +### HasSelf + +`func (o *ImportFormDefinitionsRequestInner) HasSelf() bool` + +HasSelf returns a boolean if a field has been set. + +### GetVersion + +`func (o *ImportFormDefinitionsRequestInner) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *ImportFormDefinitionsRequestInner) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *ImportFormDefinitionsRequestInner) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *ImportFormDefinitionsRequestInner) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ImportNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/ImportNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..4d821a352 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ImportNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,59 @@ +--- +id: v2025-import-non-employee-records-in-bulk-request +title: ImportNonEmployeeRecordsInBulkRequest +pagination_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportNonEmployeeRecordsInBulkRequest', 'V2025ImportNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/go/v2025/models/import-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'ImportNonEmployeeRecordsInBulkRequest', 'V2025ImportNonEmployeeRecordsInBulkRequest'] +--- + +# ImportNonEmployeeRecordsInBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | ***os.File** | | + +## Methods + +### NewImportNonEmployeeRecordsInBulkRequest + +`func NewImportNonEmployeeRecordsInBulkRequest(data *os.File, ) *ImportNonEmployeeRecordsInBulkRequest` + +NewImportNonEmployeeRecordsInBulkRequest instantiates a new ImportNonEmployeeRecordsInBulkRequest 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 + +### NewImportNonEmployeeRecordsInBulkRequestWithDefaults + +`func NewImportNonEmployeeRecordsInBulkRequestWithDefaults() *ImportNonEmployeeRecordsInBulkRequest` + +NewImportNonEmployeeRecordsInBulkRequestWithDefaults instantiates a new ImportNonEmployeeRecordsInBulkRequest 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 + +### GetData + +`func (o *ImportNonEmployeeRecordsInBulkRequest) GetData() *os.File` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *ImportNonEmployeeRecordsInBulkRequest) GetDataOk() (**os.File, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *ImportNonEmployeeRecordsInBulkRequest) SetData(v *os.File)` + +SetData sets Data field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ImportObject.md b/docs/tools/sdk/go/Reference/V2025/Models/ImportObject.md new file mode 100644 index 000000000..af8698bd3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ImportObject.md @@ -0,0 +1,116 @@ +--- +id: v2025-import-object +title: ImportObject +pagination_label: ImportObject +sidebar_label: ImportObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportObject', 'V2025ImportObject'] +slug: /tools/sdk/go/v2025/models/import-object +tags: ['SDK', 'Software Development Kit', 'ImportObject', 'V2025ImportObject'] +--- + +# ImportObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of object created or updated by import. | [optional] +**Id** | Pointer to **string** | ID of object created or updated by import. | [optional] +**Name** | Pointer to **string** | Display name of object created or updated by import. | [optional] + +## Methods + +### NewImportObject + +`func NewImportObject() *ImportObject` + +NewImportObject instantiates a new ImportObject 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 + +### NewImportObjectWithDefaults + +`func NewImportObjectWithDefaults() *ImportObject` + +NewImportObjectWithDefaults instantiates a new ImportObject 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 + +### GetType + +`func (o *ImportObject) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ImportObject) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ImportObject) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ImportObject) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ImportObject) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ImportObject) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ImportObject) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ImportObject) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ImportObject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ImportObject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ImportObject) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ImportObject) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ImportOptions.md b/docs/tools/sdk/go/Reference/V2025/Models/ImportOptions.md new file mode 100644 index 000000000..8ef12ecdb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ImportOptions.md @@ -0,0 +1,168 @@ +--- +id: v2025-import-options +title: ImportOptions +pagination_label: ImportOptions +sidebar_label: ImportOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportOptions', 'V2025ImportOptions'] +slug: /tools/sdk/go/v2025/models/import-options +tags: ['SDK', 'Software Development Kit', 'ImportOptions', 'V2025ImportOptions'] +--- + +# ImportOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExcludeTypes** | Pointer to **[]string** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]string** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] +**DefaultReferences** | Pointer to **[]string** | List of object types that can be used to resolve references on import. | [optional] +**ExcludeBackup** | Pointer to **bool** | By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed. | [optional] [default to false] + +## Methods + +### NewImportOptions + +`func NewImportOptions() *ImportOptions` + +NewImportOptions instantiates a new ImportOptions 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 + +### NewImportOptionsWithDefaults + +`func NewImportOptionsWithDefaults() *ImportOptions` + +NewImportOptionsWithDefaults instantiates a new ImportOptions 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 + +### GetExcludeTypes + +`func (o *ImportOptions) GetExcludeTypes() []string` + +GetExcludeTypes returns the ExcludeTypes field if non-nil, zero value otherwise. + +### GetExcludeTypesOk + +`func (o *ImportOptions) GetExcludeTypesOk() (*[]string, bool)` + +GetExcludeTypesOk returns a tuple with the ExcludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeTypes + +`func (o *ImportOptions) SetExcludeTypes(v []string)` + +SetExcludeTypes sets ExcludeTypes field to given value. + +### HasExcludeTypes + +`func (o *ImportOptions) HasExcludeTypes() bool` + +HasExcludeTypes returns a boolean if a field has been set. + +### GetIncludeTypes + +`func (o *ImportOptions) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *ImportOptions) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *ImportOptions) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *ImportOptions) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *ImportOptions) GetObjectOptions() map[string]ObjectExportImportOptions` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *ImportOptions) GetObjectOptionsOk() (*map[string]ObjectExportImportOptions, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *ImportOptions) SetObjectOptions(v map[string]ObjectExportImportOptions)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *ImportOptions) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + +### GetDefaultReferences + +`func (o *ImportOptions) GetDefaultReferences() []string` + +GetDefaultReferences returns the DefaultReferences field if non-nil, zero value otherwise. + +### GetDefaultReferencesOk + +`func (o *ImportOptions) GetDefaultReferencesOk() (*[]string, bool)` + +GetDefaultReferencesOk returns a tuple with the DefaultReferences field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultReferences + +`func (o *ImportOptions) SetDefaultReferences(v []string)` + +SetDefaultReferences sets DefaultReferences field to given value. + +### HasDefaultReferences + +`func (o *ImportOptions) HasDefaultReferences() bool` + +HasDefaultReferences returns a boolean if a field has been set. + +### GetExcludeBackup + +`func (o *ImportOptions) GetExcludeBackup() bool` + +GetExcludeBackup returns the ExcludeBackup field if non-nil, zero value otherwise. + +### GetExcludeBackupOk + +`func (o *ImportOptions) GetExcludeBackupOk() (*bool, bool)` + +GetExcludeBackupOk returns a tuple with the ExcludeBackup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeBackup + +`func (o *ImportOptions) SetExcludeBackup(v bool)` + +SetExcludeBackup sets ExcludeBackup field to given value. + +### HasExcludeBackup + +`func (o *ImportOptions) HasExcludeBackup() bool` + +HasExcludeBackup returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ImportSpConfigRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/ImportSpConfigRequest.md new file mode 100644 index 000000000..d931754c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ImportSpConfigRequest.md @@ -0,0 +1,85 @@ +--- +id: v2025-import-sp-config-request +title: ImportSpConfigRequest +pagination_label: ImportSpConfigRequest +sidebar_label: ImportSpConfigRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportSpConfigRequest', 'V2025ImportSpConfigRequest'] +slug: /tools/sdk/go/v2025/models/import-sp-config-request +tags: ['SDK', 'Software Development Kit', 'ImportSpConfigRequest', 'V2025ImportSpConfigRequest'] +--- + +# ImportSpConfigRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | ***os.File** | JSON file containing the objects to be imported. | +**Options** | Pointer to [**ImportOptions**](import-options) | | [optional] + +## Methods + +### NewImportSpConfigRequest + +`func NewImportSpConfigRequest(data *os.File, ) *ImportSpConfigRequest` + +NewImportSpConfigRequest instantiates a new ImportSpConfigRequest 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 + +### NewImportSpConfigRequestWithDefaults + +`func NewImportSpConfigRequestWithDefaults() *ImportSpConfigRequest` + +NewImportSpConfigRequestWithDefaults instantiates a new ImportSpConfigRequest 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 + +### GetData + +`func (o *ImportSpConfigRequest) GetData() *os.File` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *ImportSpConfigRequest) GetDataOk() (**os.File, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *ImportSpConfigRequest) SetData(v *os.File)` + +SetData sets Data field to given value. + + +### GetOptions + +`func (o *ImportSpConfigRequest) GetOptions() ImportOptions` + +GetOptions returns the Options field if non-nil, zero value otherwise. + +### GetOptionsOk + +`func (o *ImportSpConfigRequest) GetOptionsOk() (*ImportOptions, bool)` + +GetOptionsOk returns a tuple with the Options field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOptions + +`func (o *ImportSpConfigRequest) SetOptions(v ImportOptions)` + +SetOptions sets Options field to given value. + +### HasOptions + +`func (o *ImportSpConfigRequest) HasOptions() bool` + +HasOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Index.md b/docs/tools/sdk/go/Reference/V2025/Models/Index.md new file mode 100644 index 000000000..80cfc16c6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Index.md @@ -0,0 +1,18 @@ +--- +id: models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 3 +sidebar_class_name: models +keywords: ['go', 'Golang', 'sdk', 'models'] +slug: /tools/sdk/go/v2025/models +tags: ['SDK', 'Software Development Kit', 'v2025', 'models'] +--- + +The Python SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. \ No newline at end of file diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Indices.md b/docs/tools/sdk/go/Reference/V2025/Models/Indices.md new file mode 100644 index 000000000..f8638be63 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Indices.md @@ -0,0 +1,31 @@ +--- +id: v2025-index +title: Index +pagination_label: Index +sidebar_label: Index +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Index', 'V2025Index'] +slug: /tools/sdk/go/v2025/models/index +tags: ['SDK', 'Software Development Kit', 'Index', 'V2025Index'] +--- + +# Index + +## Enum + + +* `ACCESSPROFILES` (value: `"accessprofiles"`) + +* `ACCOUNTACTIVITIES` (value: `"accountactivities"`) + +* `ENTITLEMENTS` (value: `"entitlements"`) + +* `EVENTS` (value: `"events"`) + +* `IDENTITIES` (value: `"identities"`) + +* `ROLES` (value: `"roles"`) + +* `STAR` (value: `"*"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/InnerHit.md b/docs/tools/sdk/go/Reference/V2025/Models/InnerHit.md new file mode 100644 index 000000000..18a00796a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/InnerHit.md @@ -0,0 +1,80 @@ +--- +id: v2025-inner-hit +title: InnerHit +pagination_label: InnerHit +sidebar_label: InnerHit +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'InnerHit', 'V2025InnerHit'] +slug: /tools/sdk/go/v2025/models/inner-hit +tags: ['SDK', 'Software Development Kit', 'InnerHit', 'V2025InnerHit'] +--- + +# InnerHit + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **string** | The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | +**Type** | **string** | The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps. | + +## Methods + +### NewInnerHit + +`func NewInnerHit(query string, type_ string, ) *InnerHit` + +NewInnerHit instantiates a new InnerHit 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 + +### NewInnerHitWithDefaults + +`func NewInnerHitWithDefaults() *InnerHit` + +NewInnerHitWithDefaults instantiates a new InnerHit 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 + +### GetQuery + +`func (o *InnerHit) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *InnerHit) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *InnerHit) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetType + +`func (o *InnerHit) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *InnerHit) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *InnerHit) SetType(v string)` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/InviteIdentitiesRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/InviteIdentitiesRequest.md new file mode 100644 index 000000000..9ea4237d6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/InviteIdentitiesRequest.md @@ -0,0 +1,100 @@ +--- +id: v2025-invite-identities-request +title: InviteIdentitiesRequest +pagination_label: InviteIdentitiesRequest +sidebar_label: InviteIdentitiesRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'InviteIdentitiesRequest', 'V2025InviteIdentitiesRequest'] +slug: /tools/sdk/go/v2025/models/invite-identities-request +tags: ['SDK', 'Software Development Kit', 'InviteIdentitiesRequest', 'V2025InviteIdentitiesRequest'] +--- + +# InviteIdentitiesRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]string** | The list of Identities IDs to invite - required when 'uninvited' is false | [optional] +**Uninvited** | Pointer to **bool** | indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when 'ids' is empty. | [optional] [default to false] + +## Methods + +### NewInviteIdentitiesRequest + +`func NewInviteIdentitiesRequest() *InviteIdentitiesRequest` + +NewInviteIdentitiesRequest instantiates a new InviteIdentitiesRequest 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 + +### NewInviteIdentitiesRequestWithDefaults + +`func NewInviteIdentitiesRequestWithDefaults() *InviteIdentitiesRequest` + +NewInviteIdentitiesRequestWithDefaults instantiates a new InviteIdentitiesRequest 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 + +### GetIds + +`func (o *InviteIdentitiesRequest) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *InviteIdentitiesRequest) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *InviteIdentitiesRequest) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *InviteIdentitiesRequest) HasIds() bool` + +HasIds returns a boolean if a field has been set. + +### SetIdsNil + +`func (o *InviteIdentitiesRequest) SetIdsNil(b bool)` + + SetIdsNil sets the value for Ids to be an explicit nil + +### UnsetIds +`func (o *InviteIdentitiesRequest) UnsetIds()` + +UnsetIds ensures that no value is present for Ids, not even an explicit nil +### GetUninvited + +`func (o *InviteIdentitiesRequest) GetUninvited() bool` + +GetUninvited returns the Uninvited field if non-nil, zero value otherwise. + +### GetUninvitedOk + +`func (o *InviteIdentitiesRequest) GetUninvitedOk() (*bool, bool)` + +GetUninvitedOk returns a tuple with the Uninvited field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUninvited + +`func (o *InviteIdentitiesRequest) SetUninvited(v bool)` + +SetUninvited sets Uninvited field to given value. + +### HasUninvited + +`func (o *InviteIdentitiesRequest) HasUninvited() bool` + +HasUninvited returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Invocation.md b/docs/tools/sdk/go/Reference/V2025/Models/Invocation.md new file mode 100644 index 000000000..03d67c539 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Invocation.md @@ -0,0 +1,142 @@ +--- +id: v2025-invocation +title: Invocation +pagination_label: Invocation +sidebar_label: Invocation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Invocation', 'V2025Invocation'] +slug: /tools/sdk/go/v2025/models/invocation +tags: ['SDK', 'Software Development Kit', 'Invocation', 'V2025Invocation'] +--- + +# Invocation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Invocation ID | [optional] +**TriggerId** | Pointer to **string** | Trigger ID | [optional] +**Secret** | Pointer to **string** | Unique invocation secret. | [optional] +**ContentJson** | Pointer to **map[string]interface{}** | JSON map of invocation metadata. | [optional] + +## Methods + +### NewInvocation + +`func NewInvocation() *Invocation` + +NewInvocation instantiates a new Invocation 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 + +### NewInvocationWithDefaults + +`func NewInvocationWithDefaults() *Invocation` + +NewInvocationWithDefaults instantiates a new Invocation 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 + +### GetId + +`func (o *Invocation) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Invocation) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Invocation) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Invocation) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetTriggerId + +`func (o *Invocation) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *Invocation) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *Invocation) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + +### HasTriggerId + +`func (o *Invocation) HasTriggerId() bool` + +HasTriggerId returns a boolean if a field has been set. + +### GetSecret + +`func (o *Invocation) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *Invocation) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *Invocation) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *Invocation) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### GetContentJson + +`func (o *Invocation) GetContentJson() map[string]interface{}` + +GetContentJson returns the ContentJson field if non-nil, zero value otherwise. + +### GetContentJsonOk + +`func (o *Invocation) GetContentJsonOk() (*map[string]interface{}, bool)` + +GetContentJsonOk returns a tuple with the ContentJson field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContentJson + +`func (o *Invocation) SetContentJson(v map[string]interface{})` + +SetContentJson sets ContentJson field to given value. + +### HasContentJson + +`func (o *Invocation) HasContentJson() bool` + +HasContentJson returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/InvocationStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/InvocationStatus.md new file mode 100644 index 000000000..9e34b4499 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/InvocationStatus.md @@ -0,0 +1,237 @@ +--- +id: v2025-invocation-status +title: InvocationStatus +pagination_label: InvocationStatus +sidebar_label: InvocationStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'InvocationStatus', 'V2025InvocationStatus'] +slug: /tools/sdk/go/v2025/models/invocation-status +tags: ['SDK', 'Software Development Kit', 'InvocationStatus', 'V2025InvocationStatus'] +--- + +# InvocationStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Invocation ID | +**TriggerId** | **string** | Trigger ID | +**SubscriptionName** | **string** | Subscription name | +**SubscriptionId** | **string** | Subscription ID | +**Type** | [**InvocationStatusType**](invocation-status-type) | | +**Created** | **SailPointTime** | Invocation created timestamp. ISO-8601 in UTC. | +**Completed** | Pointer to **SailPointTime** | Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC. | [optional] +**StartInvocationInput** | [**StartInvocationInput**](start-invocation-input) | | +**CompleteInvocationInput** | Pointer to [**CompleteInvocationInput**](complete-invocation-input) | | [optional] + +## Methods + +### NewInvocationStatus + +`func NewInvocationStatus(id string, triggerId string, subscriptionName string, subscriptionId string, type_ InvocationStatusType, created SailPointTime, startInvocationInput StartInvocationInput, ) *InvocationStatus` + +NewInvocationStatus instantiates a new InvocationStatus 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 + +### NewInvocationStatusWithDefaults + +`func NewInvocationStatusWithDefaults() *InvocationStatus` + +NewInvocationStatusWithDefaults instantiates a new InvocationStatus 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 + +### GetId + +`func (o *InvocationStatus) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *InvocationStatus) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *InvocationStatus) SetId(v string)` + +SetId sets Id field to given value. + + +### GetTriggerId + +`func (o *InvocationStatus) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *InvocationStatus) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *InvocationStatus) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + + +### GetSubscriptionName + +`func (o *InvocationStatus) GetSubscriptionName() string` + +GetSubscriptionName returns the SubscriptionName field if non-nil, zero value otherwise. + +### GetSubscriptionNameOk + +`func (o *InvocationStatus) GetSubscriptionNameOk() (*string, bool)` + +GetSubscriptionNameOk returns a tuple with the SubscriptionName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubscriptionName + +`func (o *InvocationStatus) SetSubscriptionName(v string)` + +SetSubscriptionName sets SubscriptionName field to given value. + + +### GetSubscriptionId + +`func (o *InvocationStatus) GetSubscriptionId() string` + +GetSubscriptionId returns the SubscriptionId field if non-nil, zero value otherwise. + +### GetSubscriptionIdOk + +`func (o *InvocationStatus) GetSubscriptionIdOk() (*string, bool)` + +GetSubscriptionIdOk returns a tuple with the SubscriptionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubscriptionId + +`func (o *InvocationStatus) SetSubscriptionId(v string)` + +SetSubscriptionId sets SubscriptionId field to given value. + + +### GetType + +`func (o *InvocationStatus) GetType() InvocationStatusType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *InvocationStatus) GetTypeOk() (*InvocationStatusType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *InvocationStatus) SetType(v InvocationStatusType)` + +SetType sets Type field to given value. + + +### GetCreated + +`func (o *InvocationStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *InvocationStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *InvocationStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetCompleted + +`func (o *InvocationStatus) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *InvocationStatus) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *InvocationStatus) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *InvocationStatus) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetStartInvocationInput + +`func (o *InvocationStatus) GetStartInvocationInput() StartInvocationInput` + +GetStartInvocationInput returns the StartInvocationInput field if non-nil, zero value otherwise. + +### GetStartInvocationInputOk + +`func (o *InvocationStatus) GetStartInvocationInputOk() (*StartInvocationInput, bool)` + +GetStartInvocationInputOk returns a tuple with the StartInvocationInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartInvocationInput + +`func (o *InvocationStatus) SetStartInvocationInput(v StartInvocationInput)` + +SetStartInvocationInput sets StartInvocationInput field to given value. + + +### GetCompleteInvocationInput + +`func (o *InvocationStatus) GetCompleteInvocationInput() CompleteInvocationInput` + +GetCompleteInvocationInput returns the CompleteInvocationInput field if non-nil, zero value otherwise. + +### GetCompleteInvocationInputOk + +`func (o *InvocationStatus) GetCompleteInvocationInputOk() (*CompleteInvocationInput, bool)` + +GetCompleteInvocationInputOk returns a tuple with the CompleteInvocationInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleteInvocationInput + +`func (o *InvocationStatus) SetCompleteInvocationInput(v CompleteInvocationInput)` + +SetCompleteInvocationInput sets CompleteInvocationInput field to given value. + +### HasCompleteInvocationInput + +`func (o *InvocationStatus) HasCompleteInvocationInput() bool` + +HasCompleteInvocationInput returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/InvocationStatusType.md b/docs/tools/sdk/go/Reference/V2025/Models/InvocationStatusType.md new file mode 100644 index 000000000..87af03416 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/InvocationStatusType.md @@ -0,0 +1,21 @@ +--- +id: v2025-invocation-status-type +title: InvocationStatusType +pagination_label: InvocationStatusType +sidebar_label: InvocationStatusType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'InvocationStatusType', 'V2025InvocationStatusType'] +slug: /tools/sdk/go/v2025/models/invocation-status-type +tags: ['SDK', 'Software Development Kit', 'InvocationStatusType', 'V2025InvocationStatusType'] +--- + +# InvocationStatusType + +## Enum + + +* `TEST` (value: `"TEST"`) + +* `REAL_TIME` (value: `"REAL_TIME"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/JITConfiguration.md b/docs/tools/sdk/go/Reference/V2025/Models/JITConfiguration.md new file mode 100644 index 000000000..4a7db7ad6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/JITConfiguration.md @@ -0,0 +1,116 @@ +--- +id: v2025-jit-configuration +title: JITConfiguration +pagination_label: JITConfiguration +sidebar_label: JITConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'JITConfiguration', 'V2025JITConfiguration'] +slug: /tools/sdk/go/v2025/models/jit-configuration +tags: ['SDK', 'Software Development Kit', 'JITConfiguration', 'V2025JITConfiguration'] +--- + +# JITConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | The indicator for just-in-time provisioning enabled | [optional] [default to false] +**SourceId** | Pointer to **string** | the sourceId that mapped to just-in-time provisioning configuration | [optional] +**SourceAttributeMappings** | Pointer to **map[string]string** | A mapping of identity profile attribute names to SAML assertion attribute names | [optional] + +## Methods + +### NewJITConfiguration + +`func NewJITConfiguration() *JITConfiguration` + +NewJITConfiguration instantiates a new JITConfiguration 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 + +### NewJITConfigurationWithDefaults + +`func NewJITConfigurationWithDefaults() *JITConfiguration` + +NewJITConfigurationWithDefaults instantiates a new JITConfiguration 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 + +### GetEnabled + +`func (o *JITConfiguration) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *JITConfiguration) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *JITConfiguration) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *JITConfiguration) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetSourceId + +`func (o *JITConfiguration) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *JITConfiguration) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *JITConfiguration) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *JITConfiguration) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceAttributeMappings + +`func (o *JITConfiguration) GetSourceAttributeMappings() map[string]string` + +GetSourceAttributeMappings returns the SourceAttributeMappings field if non-nil, zero value otherwise. + +### GetSourceAttributeMappingsOk + +`func (o *JITConfiguration) GetSourceAttributeMappingsOk() (*map[string]string, bool)` + +GetSourceAttributeMappingsOk returns a tuple with the SourceAttributeMappings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceAttributeMappings + +`func (o *JITConfiguration) SetSourceAttributeMappings(v map[string]string)` + +SetSourceAttributeMappings sets SourceAttributeMappings field to given value. + +### HasSourceAttributeMappings + +`func (o *JITConfiguration) HasSourceAttributeMappings() bool` + +HasSourceAttributeMappings returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/JsonPatch.md b/docs/tools/sdk/go/Reference/V2025/Models/JsonPatch.md new file mode 100644 index 000000000..68e3be33f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/JsonPatch.md @@ -0,0 +1,64 @@ +--- +id: v2025-json-patch +title: JsonPatch +pagination_label: JsonPatch +sidebar_label: JsonPatch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'JsonPatch', 'V2025JsonPatch'] +slug: /tools/sdk/go/v2025/models/json-patch +tags: ['SDK', 'Software Development Kit', 'JsonPatch', 'V2025JsonPatch'] +--- + +# JsonPatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operations** | Pointer to [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] + +## Methods + +### NewJsonPatch + +`func NewJsonPatch() *JsonPatch` + +NewJsonPatch instantiates a new JsonPatch 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 + +### NewJsonPatchWithDefaults + +`func NewJsonPatchWithDefaults() *JsonPatch` + +NewJsonPatchWithDefaults instantiates a new JsonPatch 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 + +### GetOperations + +`func (o *JsonPatch) GetOperations() []JsonPatchOperation` + +GetOperations returns the Operations field if non-nil, zero value otherwise. + +### GetOperationsOk + +`func (o *JsonPatch) GetOperationsOk() (*[]JsonPatchOperation, bool)` + +GetOperationsOk returns a tuple with the Operations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperations + +`func (o *JsonPatch) SetOperations(v []JsonPatchOperation)` + +SetOperations sets Operations field to given value. + +### HasOperations + +`func (o *JsonPatch) HasOperations() bool` + +HasOperations returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/JsonPatchOperation.md b/docs/tools/sdk/go/Reference/V2025/Models/JsonPatchOperation.md new file mode 100644 index 000000000..0b037b041 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/JsonPatchOperation.md @@ -0,0 +1,106 @@ +--- +id: v2025-json-patch-operation +title: JsonPatchOperation +pagination_label: JsonPatchOperation +sidebar_label: JsonPatchOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'JsonPatchOperation', 'V2025JsonPatchOperation'] +slug: /tools/sdk/go/v2025/models/json-patch-operation +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperation', 'V2025JsonPatchOperation'] +--- + +# JsonPatchOperation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **string** | The operation to be performed | +**Path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | +**Value** | Pointer to [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] + +## Methods + +### NewJsonPatchOperation + +`func NewJsonPatchOperation(op string, path string, ) *JsonPatchOperation` + +NewJsonPatchOperation instantiates a new JsonPatchOperation 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 + +### NewJsonPatchOperationWithDefaults + +`func NewJsonPatchOperationWithDefaults() *JsonPatchOperation` + +NewJsonPatchOperationWithDefaults instantiates a new JsonPatchOperation 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 + +### GetOp + +`func (o *JsonPatchOperation) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *JsonPatchOperation) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *JsonPatchOperation) SetOp(v string)` + +SetOp sets Op field to given value. + + +### GetPath + +`func (o *JsonPatchOperation) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *JsonPatchOperation) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *JsonPatchOperation) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetValue + +`func (o *JsonPatchOperation) GetValue() UpdateMultiHostSourcesRequestInnerValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *JsonPatchOperation) GetValueOk() (*UpdateMultiHostSourcesRequestInnerValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *JsonPatchOperation) SetValue(v UpdateMultiHostSourcesRequestInnerValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *JsonPatchOperation) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/KbaAnswerRequestItem.md b/docs/tools/sdk/go/Reference/V2025/Models/KbaAnswerRequestItem.md new file mode 100644 index 000000000..43d31a1e6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/KbaAnswerRequestItem.md @@ -0,0 +1,80 @@ +--- +id: v2025-kba-answer-request-item +title: KbaAnswerRequestItem +pagination_label: KbaAnswerRequestItem +sidebar_label: KbaAnswerRequestItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'KbaAnswerRequestItem', 'V2025KbaAnswerRequestItem'] +slug: /tools/sdk/go/v2025/models/kba-answer-request-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerRequestItem', 'V2025KbaAnswerRequestItem'] +--- + +# KbaAnswerRequestItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Question Id | +**Answer** | **string** | An answer for the KBA question | + +## Methods + +### NewKbaAnswerRequestItem + +`func NewKbaAnswerRequestItem(id string, answer string, ) *KbaAnswerRequestItem` + +NewKbaAnswerRequestItem instantiates a new KbaAnswerRequestItem 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 + +### NewKbaAnswerRequestItemWithDefaults + +`func NewKbaAnswerRequestItemWithDefaults() *KbaAnswerRequestItem` + +NewKbaAnswerRequestItemWithDefaults instantiates a new KbaAnswerRequestItem 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 + +### GetId + +`func (o *KbaAnswerRequestItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *KbaAnswerRequestItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *KbaAnswerRequestItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetAnswer + +`func (o *KbaAnswerRequestItem) GetAnswer() string` + +GetAnswer returns the Answer field if non-nil, zero value otherwise. + +### GetAnswerOk + +`func (o *KbaAnswerRequestItem) GetAnswerOk() (*string, bool)` + +GetAnswerOk returns a tuple with the Answer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnswer + +`func (o *KbaAnswerRequestItem) SetAnswer(v string)` + +SetAnswer sets Answer field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/KbaAnswerResponseItem.md b/docs/tools/sdk/go/Reference/V2025/Models/KbaAnswerResponseItem.md new file mode 100644 index 000000000..eadb5517d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/KbaAnswerResponseItem.md @@ -0,0 +1,101 @@ +--- +id: v2025-kba-answer-response-item +title: KbaAnswerResponseItem +pagination_label: KbaAnswerResponseItem +sidebar_label: KbaAnswerResponseItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'KbaAnswerResponseItem', 'V2025KbaAnswerResponseItem'] +slug: /tools/sdk/go/v2025/models/kba-answer-response-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerResponseItem', 'V2025KbaAnswerResponseItem'] +--- + +# KbaAnswerResponseItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Question Id | +**Question** | **string** | Question description | +**HasAnswer** | **bool** | Denotes whether the KBA question has an answer configured for the current user | + +## Methods + +### NewKbaAnswerResponseItem + +`func NewKbaAnswerResponseItem(id string, question string, hasAnswer bool, ) *KbaAnswerResponseItem` + +NewKbaAnswerResponseItem instantiates a new KbaAnswerResponseItem 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 + +### NewKbaAnswerResponseItemWithDefaults + +`func NewKbaAnswerResponseItemWithDefaults() *KbaAnswerResponseItem` + +NewKbaAnswerResponseItemWithDefaults instantiates a new KbaAnswerResponseItem 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 + +### GetId + +`func (o *KbaAnswerResponseItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *KbaAnswerResponseItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *KbaAnswerResponseItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetQuestion + +`func (o *KbaAnswerResponseItem) GetQuestion() string` + +GetQuestion returns the Question field if non-nil, zero value otherwise. + +### GetQuestionOk + +`func (o *KbaAnswerResponseItem) GetQuestionOk() (*string, bool)` + +GetQuestionOk returns a tuple with the Question field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuestion + +`func (o *KbaAnswerResponseItem) SetQuestion(v string)` + +SetQuestion sets Question field to given value. + + +### GetHasAnswer + +`func (o *KbaAnswerResponseItem) GetHasAnswer() bool` + +GetHasAnswer returns the HasAnswer field if non-nil, zero value otherwise. + +### GetHasAnswerOk + +`func (o *KbaAnswerResponseItem) GetHasAnswerOk() (*bool, bool)` + +GetHasAnswerOk returns a tuple with the HasAnswer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasAnswer + +`func (o *KbaAnswerResponseItem) SetHasAnswer(v bool)` + +SetHasAnswer sets HasAnswer field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/KbaQuestion.md b/docs/tools/sdk/go/Reference/V2025/Models/KbaQuestion.md new file mode 100644 index 000000000..06065f417 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/KbaQuestion.md @@ -0,0 +1,122 @@ +--- +id: v2025-kba-question +title: KbaQuestion +pagination_label: KbaQuestion +sidebar_label: KbaQuestion +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'KbaQuestion', 'V2025KbaQuestion'] +slug: /tools/sdk/go/v2025/models/kba-question +tags: ['SDK', 'Software Development Kit', 'KbaQuestion', 'V2025KbaQuestion'] +--- + +# KbaQuestion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | KBA Question Id | +**Text** | **string** | KBA Question description | +**HasAnswer** | **bool** | Denotes whether the KBA question has an answer configured for any user in the tenant | +**NumAnswers** | **int32** | Denotes the number of KBA configurations for this question | + +## Methods + +### NewKbaQuestion + +`func NewKbaQuestion(id string, text string, hasAnswer bool, numAnswers int32, ) *KbaQuestion` + +NewKbaQuestion instantiates a new KbaQuestion 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 + +### NewKbaQuestionWithDefaults + +`func NewKbaQuestionWithDefaults() *KbaQuestion` + +NewKbaQuestionWithDefaults instantiates a new KbaQuestion 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 + +### GetId + +`func (o *KbaQuestion) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *KbaQuestion) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *KbaQuestion) SetId(v string)` + +SetId sets Id field to given value. + + +### GetText + +`func (o *KbaQuestion) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *KbaQuestion) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *KbaQuestion) SetText(v string)` + +SetText sets Text field to given value. + + +### GetHasAnswer + +`func (o *KbaQuestion) GetHasAnswer() bool` + +GetHasAnswer returns the HasAnswer field if non-nil, zero value otherwise. + +### GetHasAnswerOk + +`func (o *KbaQuestion) GetHasAnswerOk() (*bool, bool)` + +GetHasAnswerOk returns a tuple with the HasAnswer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasAnswer + +`func (o *KbaQuestion) SetHasAnswer(v bool)` + +SetHasAnswer sets HasAnswer field to given value. + + +### GetNumAnswers + +`func (o *KbaQuestion) GetNumAnswers() int32` + +GetNumAnswers returns the NumAnswers field if non-nil, zero value otherwise. + +### GetNumAnswersOk + +`func (o *KbaQuestion) GetNumAnswersOk() (*int32, bool)` + +GetNumAnswersOk returns a tuple with the NumAnswers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumAnswers + +`func (o *KbaQuestion) SetNumAnswers(v int32)` + +SetNumAnswers sets NumAnswers field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LatestOutlierSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/LatestOutlierSummary.md new file mode 100644 index 000000000..a8156794f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LatestOutlierSummary.md @@ -0,0 +1,168 @@ +--- +id: v2025-latest-outlier-summary +title: LatestOutlierSummary +pagination_label: LatestOutlierSummary +sidebar_label: LatestOutlierSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LatestOutlierSummary', 'V2025LatestOutlierSummary'] +slug: /tools/sdk/go/v2025/models/latest-outlier-summary +tags: ['SDK', 'Software Development Kit', 'LatestOutlierSummary', 'V2025LatestOutlierSummary'] +--- + +# LatestOutlierSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of outlier summary | [optional] +**SnapshotDate** | Pointer to **SailPointTime** | The date the bulk outlier detection ran/snapshot was created | [optional] +**TotalOutliers** | Pointer to **int32** | Total number of outliers for the customer making the request | [optional] +**TotalIdentities** | Pointer to **int32** | Total number of identities for the customer making the request | [optional] +**TotalIgnored** | Pointer to **int32** | Total number of ignored outliers | [optional] + +## Methods + +### NewLatestOutlierSummary + +`func NewLatestOutlierSummary() *LatestOutlierSummary` + +NewLatestOutlierSummary instantiates a new LatestOutlierSummary 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 + +### NewLatestOutlierSummaryWithDefaults + +`func NewLatestOutlierSummaryWithDefaults() *LatestOutlierSummary` + +NewLatestOutlierSummaryWithDefaults instantiates a new LatestOutlierSummary 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 + +### GetType + +`func (o *LatestOutlierSummary) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LatestOutlierSummary) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LatestOutlierSummary) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LatestOutlierSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSnapshotDate + +`func (o *LatestOutlierSummary) GetSnapshotDate() SailPointTime` + +GetSnapshotDate returns the SnapshotDate field if non-nil, zero value otherwise. + +### GetSnapshotDateOk + +`func (o *LatestOutlierSummary) GetSnapshotDateOk() (*SailPointTime, bool)` + +GetSnapshotDateOk returns a tuple with the SnapshotDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotDate + +`func (o *LatestOutlierSummary) SetSnapshotDate(v SailPointTime)` + +SetSnapshotDate sets SnapshotDate field to given value. + +### HasSnapshotDate + +`func (o *LatestOutlierSummary) HasSnapshotDate() bool` + +HasSnapshotDate returns a boolean if a field has been set. + +### GetTotalOutliers + +`func (o *LatestOutlierSummary) GetTotalOutliers() int32` + +GetTotalOutliers returns the TotalOutliers field if non-nil, zero value otherwise. + +### GetTotalOutliersOk + +`func (o *LatestOutlierSummary) GetTotalOutliersOk() (*int32, bool)` + +GetTotalOutliersOk returns a tuple with the TotalOutliers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalOutliers + +`func (o *LatestOutlierSummary) SetTotalOutliers(v int32)` + +SetTotalOutliers sets TotalOutliers field to given value. + +### HasTotalOutliers + +`func (o *LatestOutlierSummary) HasTotalOutliers() bool` + +HasTotalOutliers returns a boolean if a field has been set. + +### GetTotalIdentities + +`func (o *LatestOutlierSummary) GetTotalIdentities() int32` + +GetTotalIdentities returns the TotalIdentities field if non-nil, zero value otherwise. + +### GetTotalIdentitiesOk + +`func (o *LatestOutlierSummary) 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 *LatestOutlierSummary) SetTotalIdentities(v int32)` + +SetTotalIdentities sets TotalIdentities field to given value. + +### HasTotalIdentities + +`func (o *LatestOutlierSummary) HasTotalIdentities() bool` + +HasTotalIdentities returns a boolean if a field has been set. + +### GetTotalIgnored + +`func (o *LatestOutlierSummary) GetTotalIgnored() int32` + +GetTotalIgnored returns the TotalIgnored field if non-nil, zero value otherwise. + +### GetTotalIgnoredOk + +`func (o *LatestOutlierSummary) GetTotalIgnoredOk() (*int32, bool)` + +GetTotalIgnoredOk returns a tuple with the TotalIgnored field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalIgnored + +`func (o *LatestOutlierSummary) SetTotalIgnored(v int32)` + +SetTotalIgnored sets TotalIgnored field to given value. + +### HasTotalIgnored + +`func (o *LatestOutlierSummary) HasTotalIgnored() bool` + +HasTotalIgnored returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/License.md b/docs/tools/sdk/go/Reference/V2025/Models/License.md new file mode 100644 index 000000000..684bd5fa1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/License.md @@ -0,0 +1,90 @@ +--- +id: v2025-license +title: License +pagination_label: License +sidebar_label: License +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'License', 'V2025License'] +slug: /tools/sdk/go/v2025/models/license +tags: ['SDK', 'Software Development Kit', 'License', 'V2025License'] +--- + +# License + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LicenseId** | Pointer to **string** | Name of the license | [optional] +**LegacyFeatureName** | Pointer to **string** | Legacy name of the license | [optional] + +## Methods + +### NewLicense + +`func NewLicense() *License` + +NewLicense instantiates a new License 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 + +### NewLicenseWithDefaults + +`func NewLicenseWithDefaults() *License` + +NewLicenseWithDefaults instantiates a new License 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 + +### GetLicenseId + +`func (o *License) GetLicenseId() string` + +GetLicenseId returns the LicenseId field if non-nil, zero value otherwise. + +### GetLicenseIdOk + +`func (o *License) GetLicenseIdOk() (*string, bool)` + +GetLicenseIdOk returns a tuple with the LicenseId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLicenseId + +`func (o *License) SetLicenseId(v string)` + +SetLicenseId sets LicenseId field to given value. + +### HasLicenseId + +`func (o *License) HasLicenseId() bool` + +HasLicenseId returns a boolean if a field has been set. + +### GetLegacyFeatureName + +`func (o *License) GetLegacyFeatureName() string` + +GetLegacyFeatureName returns the LegacyFeatureName field if non-nil, zero value otherwise. + +### GetLegacyFeatureNameOk + +`func (o *License) GetLegacyFeatureNameOk() (*string, bool)` + +GetLegacyFeatureNameOk returns a tuple with the LegacyFeatureName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyFeatureName + +`func (o *License) SetLegacyFeatureName(v string)` + +SetLegacyFeatureName sets LegacyFeatureName field to given value. + +### HasLegacyFeatureName + +`func (o *License) HasLegacyFeatureName() bool` + +HasLegacyFeatureName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LifecycleState.md b/docs/tools/sdk/go/Reference/V2025/Models/LifecycleState.md new file mode 100644 index 000000000..0a622e9fa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LifecycleState.md @@ -0,0 +1,370 @@ +--- +id: v2025-lifecycle-state +title: LifecycleState +pagination_label: LifecycleState +sidebar_label: LifecycleState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LifecycleState', 'V2025LifecycleState'] +slug: /tools/sdk/go/v2025/models/lifecycle-state +tags: ['SDK', 'Software Development Kit', 'LifecycleState', 'V2025LifecycleState'] +--- + +# LifecycleState + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Enabled** | Pointer to **bool** | Indicates whether the lifecycle state is enabled or disabled. | [optional] [default to false] +**TechnicalName** | **string** | The lifecycle state's technical name. This is for internal use. | +**Description** | Pointer to **NullableString** | Lifecycle state's description. | [optional] +**IdentityCount** | Pointer to **int32** | Number of identities that have the lifecycle state. | [optional] [readonly] +**EmailNotificationOption** | Pointer to [**EmailNotificationOption**](email-notification-option) | | [optional] +**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] + +## Methods + +### NewLifecycleState + +`func NewLifecycleState(name NullableString, technicalName string, ) *LifecycleState` + +NewLifecycleState instantiates a new LifecycleState 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 + +### NewLifecycleStateWithDefaults + +`func NewLifecycleStateWithDefaults() *LifecycleState` + +NewLifecycleStateWithDefaults instantiates a new LifecycleState 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 + +### GetId + +`func (o *LifecycleState) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LifecycleState) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LifecycleState) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LifecycleState) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *LifecycleState) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LifecycleState) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *LifecycleState) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *LifecycleState) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *LifecycleState) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *LifecycleState) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LifecycleState) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *LifecycleState) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *LifecycleState) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *LifecycleState) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *LifecycleState) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *LifecycleState) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *LifecycleState) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetEnabled + +`func (o *LifecycleState) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *LifecycleState) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *LifecycleState) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *LifecycleState) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetTechnicalName + +`func (o *LifecycleState) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *LifecycleState) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *LifecycleState) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + + +### GetDescription + +`func (o *LifecycleState) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *LifecycleState) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *LifecycleState) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *LifecycleState) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *LifecycleState) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *LifecycleState) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetIdentityCount + +`func (o *LifecycleState) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *LifecycleState) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *LifecycleState) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *LifecycleState) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetEmailNotificationOption + +`func (o *LifecycleState) GetEmailNotificationOption() EmailNotificationOption` + +GetEmailNotificationOption returns the EmailNotificationOption field if non-nil, zero value otherwise. + +### GetEmailNotificationOptionOk + +`func (o *LifecycleState) GetEmailNotificationOptionOk() (*EmailNotificationOption, bool)` + +GetEmailNotificationOptionOk returns a tuple with the EmailNotificationOption field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationOption + +`func (o *LifecycleState) SetEmailNotificationOption(v EmailNotificationOption)` + +SetEmailNotificationOption sets EmailNotificationOption field to given value. + +### HasEmailNotificationOption + +`func (o *LifecycleState) HasEmailNotificationOption() bool` + +HasEmailNotificationOption returns a boolean if a field has been set. + +### GetAccountActions + +`func (o *LifecycleState) GetAccountActions() []AccountAction` + +GetAccountActions returns the AccountActions field if non-nil, zero value otherwise. + +### GetAccountActionsOk + +`func (o *LifecycleState) GetAccountActionsOk() (*[]AccountAction, bool)` + +GetAccountActionsOk returns a tuple with the AccountActions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActions + +`func (o *LifecycleState) SetAccountActions(v []AccountAction)` + +SetAccountActions sets AccountActions field to given value. + +### HasAccountActions + +`func (o *LifecycleState) HasAccountActions() bool` + +HasAccountActions returns a boolean if a field has been set. + +### GetAccessProfileIds + +`func (o *LifecycleState) GetAccessProfileIds() []string` + +GetAccessProfileIds returns the AccessProfileIds field if non-nil, zero value otherwise. + +### GetAccessProfileIdsOk + +`func (o *LifecycleState) GetAccessProfileIdsOk() (*[]string, bool)` + +GetAccessProfileIdsOk returns a tuple with the AccessProfileIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileIds + +`func (o *LifecycleState) SetAccessProfileIds(v []string)` + +SetAccessProfileIds sets AccessProfileIds field to given value. + +### HasAccessProfileIds + +`func (o *LifecycleState) HasAccessProfileIds() bool` + +HasAccessProfileIds returns a boolean if a field has been set. + +### GetIdentityState + +`func (o *LifecycleState) GetIdentityState() string` + +GetIdentityState returns the IdentityState field if non-nil, zero value otherwise. + +### GetIdentityStateOk + +`func (o *LifecycleState) GetIdentityStateOk() (*string, bool)` + +GetIdentityStateOk returns a tuple with the IdentityState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityState + +`func (o *LifecycleState) SetIdentityState(v string)` + +SetIdentityState sets IdentityState field to given value. + +### HasIdentityState + +`func (o *LifecycleState) HasIdentityState() bool` + +HasIdentityState returns a boolean if a field has been set. + +### SetIdentityStateNil + +`func (o *LifecycleState) SetIdentityStateNil(b bool)` + + SetIdentityStateNil sets the value for IdentityState to be an explicit nil + +### UnsetIdentityState +`func (o *LifecycleState) UnsetIdentityState()` + +UnsetIdentityState ensures that no value is present for IdentityState, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LifecycleStateDto.md b/docs/tools/sdk/go/Reference/V2025/Models/LifecycleStateDto.md new file mode 100644 index 000000000..99e22c09e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LifecycleStateDto.md @@ -0,0 +1,80 @@ +--- +id: v2025-lifecycle-state-dto +title: LifecycleStateDto +pagination_label: LifecycleStateDto +sidebar_label: LifecycleStateDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LifecycleStateDto', 'V2025LifecycleStateDto'] +slug: /tools/sdk/go/v2025/models/lifecycle-state-dto +tags: ['SDK', 'Software Development Kit', 'LifecycleStateDto', 'V2025LifecycleStateDto'] +--- + +# LifecycleStateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**StateName** | **string** | The name of the lifecycle state | +**ManuallyUpdated** | **bool** | Whether the lifecycle state has been manually or automatically set | + +## Methods + +### NewLifecycleStateDto + +`func NewLifecycleStateDto(stateName string, manuallyUpdated bool, ) *LifecycleStateDto` + +NewLifecycleStateDto instantiates a new LifecycleStateDto 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 + +### NewLifecycleStateDtoWithDefaults + +`func NewLifecycleStateDtoWithDefaults() *LifecycleStateDto` + +NewLifecycleStateDtoWithDefaults instantiates a new LifecycleStateDto 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 + +### GetStateName + +`func (o *LifecycleStateDto) GetStateName() string` + +GetStateName returns the StateName field if non-nil, zero value otherwise. + +### GetStateNameOk + +`func (o *LifecycleStateDto) GetStateNameOk() (*string, bool)` + +GetStateNameOk returns a tuple with the StateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStateName + +`func (o *LifecycleStateDto) SetStateName(v string)` + +SetStateName sets StateName field to given value. + + +### GetManuallyUpdated + +`func (o *LifecycleStateDto) GetManuallyUpdated() bool` + +GetManuallyUpdated returns the ManuallyUpdated field if non-nil, zero value otherwise. + +### GetManuallyUpdatedOk + +`func (o *LifecycleStateDto) GetManuallyUpdatedOk() (*bool, bool)` + +GetManuallyUpdatedOk returns a tuple with the ManuallyUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyUpdated + +`func (o *LifecycleStateDto) SetManuallyUpdated(v bool)` + +SetManuallyUpdated sets ManuallyUpdated field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LifecyclestateDeleted.md b/docs/tools/sdk/go/Reference/V2025/Models/LifecyclestateDeleted.md new file mode 100644 index 000000000..0dfda6b82 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LifecyclestateDeleted.md @@ -0,0 +1,116 @@ +--- +id: v2025-lifecyclestate-deleted +title: LifecyclestateDeleted +pagination_label: LifecyclestateDeleted +sidebar_label: LifecyclestateDeleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LifecyclestateDeleted', 'V2025LifecyclestateDeleted'] +slug: /tools/sdk/go/v2025/models/lifecyclestate-deleted +tags: ['SDK', 'Software Development Kit', 'LifecyclestateDeleted', 'V2025LifecyclestateDeleted'] +--- + +# LifecyclestateDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Deleted lifecycle state's DTO type. | [optional] +**Id** | Pointer to **string** | Deleted lifecycle state ID. | [optional] +**Name** | Pointer to **string** | Deleted lifecycle state's display name. | [optional] + +## Methods + +### NewLifecyclestateDeleted + +`func NewLifecyclestateDeleted() *LifecyclestateDeleted` + +NewLifecyclestateDeleted instantiates a new LifecyclestateDeleted 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 + +### NewLifecyclestateDeletedWithDefaults + +`func NewLifecyclestateDeletedWithDefaults() *LifecyclestateDeleted` + +NewLifecyclestateDeletedWithDefaults instantiates a new LifecyclestateDeleted 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 + +### GetType + +`func (o *LifecyclestateDeleted) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LifecyclestateDeleted) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LifecyclestateDeleted) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LifecyclestateDeleted) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *LifecyclestateDeleted) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LifecyclestateDeleted) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LifecyclestateDeleted) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LifecyclestateDeleted) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *LifecyclestateDeleted) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LifecyclestateDeleted) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *LifecyclestateDeleted) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *LifecyclestateDeleted) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ListAccessProfiles401Response.md b/docs/tools/sdk/go/Reference/V2025/Models/ListAccessProfiles401Response.md new file mode 100644 index 000000000..a93ffa37c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ListAccessProfiles401Response.md @@ -0,0 +1,64 @@ +--- +id: v2025-list-access-profiles401-response +title: ListAccessProfiles401Response +pagination_label: ListAccessProfiles401Response +sidebar_label: ListAccessProfiles401Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListAccessProfiles401Response', 'V2025ListAccessProfiles401Response'] +slug: /tools/sdk/go/v2025/models/list-access-profiles401-response +tags: ['SDK', 'Software Development Kit', 'ListAccessProfiles401Response', 'V2025ListAccessProfiles401Response'] +--- + +# ListAccessProfiles401Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Error** | Pointer to **map[string]interface{}** | A message describing the error | [optional] + +## Methods + +### NewListAccessProfiles401Response + +`func NewListAccessProfiles401Response() *ListAccessProfiles401Response` + +NewListAccessProfiles401Response instantiates a new ListAccessProfiles401Response 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 + +### NewListAccessProfiles401ResponseWithDefaults + +`func NewListAccessProfiles401ResponseWithDefaults() *ListAccessProfiles401Response` + +NewListAccessProfiles401ResponseWithDefaults instantiates a new ListAccessProfiles401Response 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 + +### GetError + +`func (o *ListAccessProfiles401Response) GetError() map[string]interface{}` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *ListAccessProfiles401Response) GetErrorOk() (*map[string]interface{}, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *ListAccessProfiles401Response) SetError(v map[string]interface{})` + +SetError sets Error field to given value. + +### HasError + +`func (o *ListAccessProfiles401Response) HasError() bool` + +HasError returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ListAccessProfiles429Response.md b/docs/tools/sdk/go/Reference/V2025/Models/ListAccessProfiles429Response.md new file mode 100644 index 000000000..86b11d7df --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ListAccessProfiles429Response.md @@ -0,0 +1,64 @@ +--- +id: v2025-list-access-profiles429-response +title: ListAccessProfiles429Response +pagination_label: ListAccessProfiles429Response +sidebar_label: ListAccessProfiles429Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListAccessProfiles429Response', 'V2025ListAccessProfiles429Response'] +slug: /tools/sdk/go/v2025/models/list-access-profiles429-response +tags: ['SDK', 'Software Development Kit', 'ListAccessProfiles429Response', 'V2025ListAccessProfiles429Response'] +--- + +# ListAccessProfiles429Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **map[string]interface{}** | A message describing the error | [optional] + +## Methods + +### NewListAccessProfiles429Response + +`func NewListAccessProfiles429Response() *ListAccessProfiles429Response` + +NewListAccessProfiles429Response instantiates a new ListAccessProfiles429Response 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 + +### NewListAccessProfiles429ResponseWithDefaults + +`func NewListAccessProfiles429ResponseWithDefaults() *ListAccessProfiles429Response` + +NewListAccessProfiles429ResponseWithDefaults instantiates a new ListAccessProfiles429Response 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 + +### GetMessage + +`func (o *ListAccessProfiles429Response) GetMessage() map[string]interface{}` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *ListAccessProfiles429Response) GetMessageOk() (*map[string]interface{}, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *ListAccessProfiles429Response) SetMessage(v map[string]interface{})` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *ListAccessProfiles429Response) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ListCampaignFilters200Response.md b/docs/tools/sdk/go/Reference/V2025/Models/ListCampaignFilters200Response.md new file mode 100644 index 000000000..178c48296 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ListCampaignFilters200Response.md @@ -0,0 +1,90 @@ +--- +id: v2025-list-campaign-filters200-response +title: ListCampaignFilters200Response +pagination_label: ListCampaignFilters200Response +sidebar_label: ListCampaignFilters200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListCampaignFilters200Response', 'V2025ListCampaignFilters200Response'] +slug: /tools/sdk/go/v2025/models/list-campaign-filters200-response +tags: ['SDK', 'Software Development Kit', 'ListCampaignFilters200Response', 'V2025ListCampaignFilters200Response'] +--- + +# ListCampaignFilters200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Items** | Pointer to [**[]CampaignFilterDetails**](campaign-filter-details) | List of campaign filters. | [optional] +**Count** | Pointer to **int32** | Number of filters returned. | [optional] + +## Methods + +### NewListCampaignFilters200Response + +`func NewListCampaignFilters200Response() *ListCampaignFilters200Response` + +NewListCampaignFilters200Response instantiates a new ListCampaignFilters200Response 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 + +### NewListCampaignFilters200ResponseWithDefaults + +`func NewListCampaignFilters200ResponseWithDefaults() *ListCampaignFilters200Response` + +NewListCampaignFilters200ResponseWithDefaults instantiates a new ListCampaignFilters200Response 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 + +### GetItems + +`func (o *ListCampaignFilters200Response) GetItems() []CampaignFilterDetails` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *ListCampaignFilters200Response) GetItemsOk() (*[]CampaignFilterDetails, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *ListCampaignFilters200Response) SetItems(v []CampaignFilterDetails)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *ListCampaignFilters200Response) HasItems() bool` + +HasItems returns a boolean if a field has been set. + +### GetCount + +`func (o *ListCampaignFilters200Response) GetCount() int32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *ListCampaignFilters200Response) GetCountOk() (*int32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *ListCampaignFilters200Response) SetCount(v int32)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *ListCampaignFilters200Response) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ListCompleteWorkflowLibrary200ResponseInner.md b/docs/tools/sdk/go/Reference/V2025/Models/ListCompleteWorkflowLibrary200ResponseInner.md new file mode 100644 index 000000000..292b67529 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ListCompleteWorkflowLibrary200ResponseInner.md @@ -0,0 +1,396 @@ +--- +id: v2025-list-complete-workflow-library200-response-inner +title: ListCompleteWorkflowLibrary200ResponseInner +pagination_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListCompleteWorkflowLibrary200ResponseInner', 'V2025ListCompleteWorkflowLibrary200ResponseInner'] +slug: /tools/sdk/go/v2025/models/list-complete-workflow-library200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListCompleteWorkflowLibrary200ResponseInner', 'V2025ListCompleteWorkflowLibrary200ResponseInner'] +--- + +# ListCompleteWorkflowLibrary200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Operator ID. | [optional] +**Name** | Pointer to **string** | Operator friendly name | [optional] +**Type** | Pointer to **string** | Operator type | [optional] +**Description** | Pointer to **string** | Description of the operator | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] +**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**Deprecated** | Pointer to **bool** | | [optional] +**DeprecatedBy** | Pointer to **SailPointTime** | | [optional] +**VersionNumber** | Pointer to **int32** | Version number | [optional] +**IsSimulationEnabled** | Pointer to **bool** | | [optional] +**IsDynamicSchema** | Pointer to **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**OutputSchema** | Pointer to **map[string]interface{}** | Example output schema | [optional] +**InputExample** | Pointer to **map[string]interface{}** | Example trigger payload if applicable | [optional] + +## Methods + +### NewListCompleteWorkflowLibrary200ResponseInner + +`func NewListCompleteWorkflowLibrary200ResponseInner() *ListCompleteWorkflowLibrary200ResponseInner` + +NewListCompleteWorkflowLibrary200ResponseInner instantiates a new ListCompleteWorkflowLibrary200ResponseInner 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 + +### NewListCompleteWorkflowLibrary200ResponseInnerWithDefaults + +`func NewListCompleteWorkflowLibrary200ResponseInnerWithDefaults() *ListCompleteWorkflowLibrary200ResponseInner` + +NewListCompleteWorkflowLibrary200ResponseInnerWithDefaults instantiates a new ListCompleteWorkflowLibrary200ResponseInner 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 + +### GetId + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDescription + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetFormFields + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetFormFields() []WorkflowLibraryFormFields` + +GetFormFields returns the FormFields field if non-nil, zero value otherwise. + +### GetFormFieldsOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetFormFieldsOk() (*[]WorkflowLibraryFormFields, bool)` + +GetFormFieldsOk returns a tuple with the FormFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormFields + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetFormFields(v []WorkflowLibraryFormFields)` + +SetFormFields sets FormFields field to given value. + +### HasFormFields + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasFormFields() bool` + +HasFormFields returns a boolean if a field has been set. + +### SetFormFieldsNil + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetFormFieldsNil(b bool)` + + SetFormFieldsNil sets the value for FormFields to be an explicit nil + +### UnsetFormFields +`func (o *ListCompleteWorkflowLibrary200ResponseInner) UnsetFormFields()` + +UnsetFormFields ensures that no value is present for FormFields, not even an explicit nil +### GetExampleOutput + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetExampleOutput() WorkflowLibraryActionExampleOutput` + +GetExampleOutput returns the ExampleOutput field if non-nil, zero value otherwise. + +### GetExampleOutputOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetExampleOutputOk() (*WorkflowLibraryActionExampleOutput, bool)` + +GetExampleOutputOk returns a tuple with the ExampleOutput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExampleOutput + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetExampleOutput(v WorkflowLibraryActionExampleOutput)` + +SetExampleOutput sets ExampleOutput field to given value. + +### HasExampleOutput + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasExampleOutput() bool` + +HasExampleOutput returns a boolean if a field has been set. + +### GetDeprecated + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDeprecated() bool` + +GetDeprecated returns the Deprecated field if non-nil, zero value otherwise. + +### GetDeprecatedOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDeprecatedOk() (*bool, bool)` + +GetDeprecatedOk returns a tuple with the Deprecated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecated + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetDeprecated(v bool)` + +SetDeprecated sets Deprecated field to given value. + +### HasDeprecated + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasDeprecated() bool` + +HasDeprecated returns a boolean if a field has been set. + +### GetDeprecatedBy + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDeprecatedBy() SailPointTime` + +GetDeprecatedBy returns the DeprecatedBy field if non-nil, zero value otherwise. + +### GetDeprecatedByOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDeprecatedByOk() (*SailPointTime, bool)` + +GetDeprecatedByOk returns a tuple with the DeprecatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecatedBy + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetDeprecatedBy(v SailPointTime)` + +SetDeprecatedBy sets DeprecatedBy field to given value. + +### HasDeprecatedBy + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasDeprecatedBy() bool` + +HasDeprecatedBy returns a boolean if a field has been set. + +### GetVersionNumber + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetVersionNumber() int32` + +GetVersionNumber returns the VersionNumber field if non-nil, zero value otherwise. + +### GetVersionNumberOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetVersionNumberOk() (*int32, bool)` + +GetVersionNumberOk returns a tuple with the VersionNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionNumber + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetVersionNumber(v int32)` + +SetVersionNumber sets VersionNumber field to given value. + +### HasVersionNumber + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasVersionNumber() bool` + +HasVersionNumber returns a boolean if a field has been set. + +### GetIsSimulationEnabled + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIsSimulationEnabled() bool` + +GetIsSimulationEnabled returns the IsSimulationEnabled field if non-nil, zero value otherwise. + +### GetIsSimulationEnabledOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIsSimulationEnabledOk() (*bool, bool)` + +GetIsSimulationEnabledOk returns a tuple with the IsSimulationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSimulationEnabled + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetIsSimulationEnabled(v bool)` + +SetIsSimulationEnabled sets IsSimulationEnabled field to given value. + +### HasIsSimulationEnabled + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasIsSimulationEnabled() bool` + +HasIsSimulationEnabled returns a boolean if a field has been set. + +### GetIsDynamicSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIsDynamicSchema() bool` + +GetIsDynamicSchema returns the IsDynamicSchema field if non-nil, zero value otherwise. + +### GetIsDynamicSchemaOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIsDynamicSchemaOk() (*bool, bool)` + +GetIsDynamicSchemaOk returns a tuple with the IsDynamicSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDynamicSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetIsDynamicSchema(v bool)` + +SetIsDynamicSchema sets IsDynamicSchema field to given value. + +### HasIsDynamicSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasIsDynamicSchema() bool` + +HasIsDynamicSchema returns a boolean if a field has been set. + +### GetOutputSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetOutputSchema() map[string]interface{}` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetOutputSchemaOk() (*map[string]interface{}, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetOutputSchema(v map[string]interface{})` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + +### GetInputExample + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetInputExample() map[string]interface{}` + +GetInputExample returns the InputExample field if non-nil, zero value otherwise. + +### GetInputExampleOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetInputExampleOk() (*map[string]interface{}, bool)` + +GetInputExampleOk returns a tuple with the InputExample field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInputExample + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetInputExample(v map[string]interface{})` + +SetInputExample sets InputExample field to given value. + +### HasInputExample + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasInputExample() bool` + +HasInputExample returns a boolean if a field has been set. + +### SetInputExampleNil + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetInputExampleNil(b bool)` + + SetInputExampleNil sets the value for InputExample to be an explicit nil + +### UnsetInputExample +`func (o *ListCompleteWorkflowLibrary200ResponseInner) UnsetInputExample()` + +UnsetInputExample ensures that no value is present for InputExample, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ListDeploys200Response.md b/docs/tools/sdk/go/Reference/V2025/Models/ListDeploys200Response.md new file mode 100644 index 000000000..fbbf38c0c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ListDeploys200Response.md @@ -0,0 +1,64 @@ +--- +id: v2025-list-deploys200-response +title: ListDeploys200Response +pagination_label: ListDeploys200Response +sidebar_label: ListDeploys200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListDeploys200Response', 'V2025ListDeploys200Response'] +slug: /tools/sdk/go/v2025/models/list-deploys200-response +tags: ['SDK', 'Software Development Kit', 'ListDeploys200Response', 'V2025ListDeploys200Response'] +--- + +# ListDeploys200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Items** | Pointer to [**[]DeployResponse**](deploy-response) | list of deployments | [optional] + +## Methods + +### NewListDeploys200Response + +`func NewListDeploys200Response() *ListDeploys200Response` + +NewListDeploys200Response instantiates a new ListDeploys200Response 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 + +### NewListDeploys200ResponseWithDefaults + +`func NewListDeploys200ResponseWithDefaults() *ListDeploys200Response` + +NewListDeploys200ResponseWithDefaults instantiates a new ListDeploys200Response 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 + +### GetItems + +`func (o *ListDeploys200Response) GetItems() []DeployResponse` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *ListDeploys200Response) GetItemsOk() (*[]DeployResponse, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *ListDeploys200Response) SetItems(v []DeployResponse)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *ListDeploys200Response) HasItems() bool` + +HasItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ListFormDefinitionsByTenantResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ListFormDefinitionsByTenantResponse.md new file mode 100644 index 000000000..435b4ba1b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ListFormDefinitionsByTenantResponse.md @@ -0,0 +1,90 @@ +--- +id: v2025-list-form-definitions-by-tenant-response +title: ListFormDefinitionsByTenantResponse +pagination_label: ListFormDefinitionsByTenantResponse +sidebar_label: ListFormDefinitionsByTenantResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListFormDefinitionsByTenantResponse', 'V2025ListFormDefinitionsByTenantResponse'] +slug: /tools/sdk/go/v2025/models/list-form-definitions-by-tenant-response +tags: ['SDK', 'Software Development Kit', 'ListFormDefinitionsByTenantResponse', 'V2025ListFormDefinitionsByTenantResponse'] +--- + +# ListFormDefinitionsByTenantResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **int64** | Count number of results. | [optional] +**Results** | Pointer to [**[]FormDefinitionResponse**](form-definition-response) | List of FormDefinitionResponse items. | [optional] + +## Methods + +### NewListFormDefinitionsByTenantResponse + +`func NewListFormDefinitionsByTenantResponse() *ListFormDefinitionsByTenantResponse` + +NewListFormDefinitionsByTenantResponse instantiates a new ListFormDefinitionsByTenantResponse 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 + +### NewListFormDefinitionsByTenantResponseWithDefaults + +`func NewListFormDefinitionsByTenantResponseWithDefaults() *ListFormDefinitionsByTenantResponse` + +NewListFormDefinitionsByTenantResponseWithDefaults instantiates a new ListFormDefinitionsByTenantResponse 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 + +### GetCount + +`func (o *ListFormDefinitionsByTenantResponse) GetCount() int64` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *ListFormDefinitionsByTenantResponse) GetCountOk() (*int64, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *ListFormDefinitionsByTenantResponse) SetCount(v int64)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *ListFormDefinitionsByTenantResponse) HasCount() bool` + +HasCount returns a boolean if a field has been set. + +### GetResults + +`func (o *ListFormDefinitionsByTenantResponse) GetResults() []FormDefinitionResponse` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *ListFormDefinitionsByTenantResponse) GetResultsOk() (*[]FormDefinitionResponse, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *ListFormDefinitionsByTenantResponse) SetResults(v []FormDefinitionResponse)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *ListFormDefinitionsByTenantResponse) HasResults() bool` + +HasResults returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ListFormElementDataByElementIDResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ListFormElementDataByElementIDResponse.md new file mode 100644 index 000000000..f22cb9858 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ListFormElementDataByElementIDResponse.md @@ -0,0 +1,64 @@ +--- +id: v2025-list-form-element-data-by-element-id-response +title: ListFormElementDataByElementIDResponse +pagination_label: ListFormElementDataByElementIDResponse +sidebar_label: ListFormElementDataByElementIDResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListFormElementDataByElementIDResponse', 'V2025ListFormElementDataByElementIDResponse'] +slug: /tools/sdk/go/v2025/models/list-form-element-data-by-element-id-response +tags: ['SDK', 'Software Development Kit', 'ListFormElementDataByElementIDResponse', 'V2025ListFormElementDataByElementIDResponse'] +--- + +# ListFormElementDataByElementIDResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | Pointer to [**[]FormElementDataSourceConfigOptions**](form-element-data-source-config-options) | Results holds a list of FormElementDataSourceConfigOptions items | [optional] + +## Methods + +### NewListFormElementDataByElementIDResponse + +`func NewListFormElementDataByElementIDResponse() *ListFormElementDataByElementIDResponse` + +NewListFormElementDataByElementIDResponse instantiates a new ListFormElementDataByElementIDResponse 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 + +### NewListFormElementDataByElementIDResponseWithDefaults + +`func NewListFormElementDataByElementIDResponseWithDefaults() *ListFormElementDataByElementIDResponse` + +NewListFormElementDataByElementIDResponseWithDefaults instantiates a new ListFormElementDataByElementIDResponse 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 + +### GetResults + +`func (o *ListFormElementDataByElementIDResponse) GetResults() []FormElementDataSourceConfigOptions` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *ListFormElementDataByElementIDResponse) GetResultsOk() (*[]FormElementDataSourceConfigOptions, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *ListFormElementDataByElementIDResponse) SetResults(v []FormElementDataSourceConfigOptions)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *ListFormElementDataByElementIDResponse) HasResults() bool` + +HasResults returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ListFormInstancesByTenantResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ListFormInstancesByTenantResponse.md new file mode 100644 index 000000000..5de0c5fc4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ListFormInstancesByTenantResponse.md @@ -0,0 +1,90 @@ +--- +id: v2025-list-form-instances-by-tenant-response +title: ListFormInstancesByTenantResponse +pagination_label: ListFormInstancesByTenantResponse +sidebar_label: ListFormInstancesByTenantResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListFormInstancesByTenantResponse', 'V2025ListFormInstancesByTenantResponse'] +slug: /tools/sdk/go/v2025/models/list-form-instances-by-tenant-response +tags: ['SDK', 'Software Development Kit', 'ListFormInstancesByTenantResponse', 'V2025ListFormInstancesByTenantResponse'] +--- + +# ListFormInstancesByTenantResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **int64** | Count number of Results | [optional] +**Results** | Pointer to [**[]FormInstanceResponse**](form-instance-response) | Results holds a list of FormInstanceResponse items | [optional] + +## Methods + +### NewListFormInstancesByTenantResponse + +`func NewListFormInstancesByTenantResponse() *ListFormInstancesByTenantResponse` + +NewListFormInstancesByTenantResponse instantiates a new ListFormInstancesByTenantResponse 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 + +### NewListFormInstancesByTenantResponseWithDefaults + +`func NewListFormInstancesByTenantResponseWithDefaults() *ListFormInstancesByTenantResponse` + +NewListFormInstancesByTenantResponseWithDefaults instantiates a new ListFormInstancesByTenantResponse 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 + +### GetCount + +`func (o *ListFormInstancesByTenantResponse) GetCount() int64` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *ListFormInstancesByTenantResponse) GetCountOk() (*int64, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *ListFormInstancesByTenantResponse) SetCount(v int64)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *ListFormInstancesByTenantResponse) HasCount() bool` + +HasCount returns a boolean if a field has been set. + +### GetResults + +`func (o *ListFormInstancesByTenantResponse) GetResults() []FormInstanceResponse` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *ListFormInstancesByTenantResponse) GetResultsOk() (*[]FormInstanceResponse, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *ListFormInstancesByTenantResponse) SetResults(v []FormInstanceResponse)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *ListFormInstancesByTenantResponse) HasResults() bool` + +HasResults returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ListIdentityAccessItems200ResponseInner.md b/docs/tools/sdk/go/Reference/V2025/Models/ListIdentityAccessItems200ResponseInner.md new file mode 100644 index 000000000..0b820eadb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ListIdentityAccessItems200ResponseInner.md @@ -0,0 +1,512 @@ +--- +id: v2025-list-identity-access-items200-response-inner +title: ListIdentityAccessItems200ResponseInner +pagination_label: ListIdentityAccessItems200ResponseInner +sidebar_label: ListIdentityAccessItems200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListIdentityAccessItems200ResponseInner', 'V2025ListIdentityAccessItems200ResponseInner'] +slug: /tools/sdk/go/v2025/models/list-identity-access-items200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListIdentityAccessItems200ResponseInner', 'V2025ListIdentityAccessItems200ResponseInner'] +--- + +# ListIdentityAccessItems200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **string** | the access item type. role in this case | [optional] +**Id** | Pointer to **string** | the access item id | [optional] +**Name** | Pointer to **string** | the access profile name | [optional] +**SourceName** | Pointer to **string** | the associated source name if it exists | [optional] +**SourceId** | Pointer to **string** | the id of the source | [optional] +**Description** | Pointer to **string** | the description for the role | [optional] +**DisplayName** | Pointer to **string** | the role display name | [optional] +**EntitlementCount** | Pointer to **string** | the number of entitlements the account will create | [optional] +**AppDisplayName** | Pointer to **string** | the name of | [optional] +**RemoveDate** | Pointer to **string** | the date the role is no longer assigned to the specified identity | [optional] +**Standalone** | **bool** | indicates whether the entitlement is standalone | +**Revocable** | **bool** | indicates whether the role is revocable | +**NativeIdentity** | Pointer to **string** | the native identifier used to uniquely identify an acccount | [optional] +**AppRoleId** | Pointer to **string** | the app role id | [optional] +**Attribute** | Pointer to **string** | the entitlement attribute | [optional] +**Value** | Pointer to **string** | the associated value | [optional] +**EntitlementType** | Pointer to **string** | the type of entitlement | [optional] +**Privileged** | **bool** | indicates whether the entitlement is privileged | +**CloudGoverned** | **bool** | indicates whether the entitlement is cloud governed | + +## Methods + +### NewListIdentityAccessItems200ResponseInner + +`func NewListIdentityAccessItems200ResponseInner(standalone bool, revocable bool, privileged bool, cloudGoverned bool, ) *ListIdentityAccessItems200ResponseInner` + +NewListIdentityAccessItems200ResponseInner instantiates a new ListIdentityAccessItems200ResponseInner 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 + +### NewListIdentityAccessItems200ResponseInnerWithDefaults + +`func NewListIdentityAccessItems200ResponseInnerWithDefaults() *ListIdentityAccessItems200ResponseInner` + +NewListIdentityAccessItems200ResponseInnerWithDefaults instantiates a new ListIdentityAccessItems200ResponseInner 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 + +### GetAccessType + +`func (o *ListIdentityAccessItems200ResponseInner) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *ListIdentityAccessItems200ResponseInner) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *ListIdentityAccessItems200ResponseInner) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetId + +`func (o *ListIdentityAccessItems200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ListIdentityAccessItems200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ListIdentityAccessItems200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ListIdentityAccessItems200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ListIdentityAccessItems200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ListIdentityAccessItems200ResponseInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *ListIdentityAccessItems200ResponseInner) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *ListIdentityAccessItems200ResponseInner) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *ListIdentityAccessItems200ResponseInner) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceId + +`func (o *ListIdentityAccessItems200ResponseInner) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *ListIdentityAccessItems200ResponseInner) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *ListIdentityAccessItems200ResponseInner) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetDescription + +`func (o *ListIdentityAccessItems200ResponseInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ListIdentityAccessItems200ResponseInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ListIdentityAccessItems200ResponseInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *ListIdentityAccessItems200ResponseInner) GetEntitlementCount() string` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetEntitlementCountOk() (*string, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *ListIdentityAccessItems200ResponseInner) SetEntitlementCount(v string)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *ListIdentityAccessItems200ResponseInner) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetAppDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) GetAppDisplayName() string` + +GetAppDisplayName returns the AppDisplayName field if non-nil, zero value otherwise. + +### GetAppDisplayNameOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetAppDisplayNameOk() (*string, bool)` + +GetAppDisplayNameOk returns a tuple with the AppDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) SetAppDisplayName(v string)` + +SetAppDisplayName sets AppDisplayName field to given value. + +### HasAppDisplayName + +`func (o *ListIdentityAccessItems200ResponseInner) HasAppDisplayName() bool` + +HasAppDisplayName returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *ListIdentityAccessItems200ResponseInner) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *ListIdentityAccessItems200ResponseInner) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *ListIdentityAccessItems200ResponseInner) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetStandalone + +`func (o *ListIdentityAccessItems200ResponseInner) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *ListIdentityAccessItems200ResponseInner) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + + +### GetRevocable + +`func (o *ListIdentityAccessItems200ResponseInner) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *ListIdentityAccessItems200ResponseInner) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + + +### GetNativeIdentity + +`func (o *ListIdentityAccessItems200ResponseInner) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *ListIdentityAccessItems200ResponseInner) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *ListIdentityAccessItems200ResponseInner) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetAppRoleId + +`func (o *ListIdentityAccessItems200ResponseInner) GetAppRoleId() string` + +GetAppRoleId returns the AppRoleId field if non-nil, zero value otherwise. + +### GetAppRoleIdOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetAppRoleIdOk() (*string, bool)` + +GetAppRoleIdOk returns a tuple with the AppRoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppRoleId + +`func (o *ListIdentityAccessItems200ResponseInner) SetAppRoleId(v string)` + +SetAppRoleId sets AppRoleId field to given value. + +### HasAppRoleId + +`func (o *ListIdentityAccessItems200ResponseInner) HasAppRoleId() bool` + +HasAppRoleId returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ListIdentityAccessItems200ResponseInner) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ListIdentityAccessItems200ResponseInner) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ListIdentityAccessItems200ResponseInner) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *ListIdentityAccessItems200ResponseInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ListIdentityAccessItems200ResponseInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ListIdentityAccessItems200ResponseInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetEntitlementType + +`func (o *ListIdentityAccessItems200ResponseInner) GetEntitlementType() string` + +GetEntitlementType returns the EntitlementType field if non-nil, zero value otherwise. + +### GetEntitlementTypeOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetEntitlementTypeOk() (*string, bool)` + +GetEntitlementTypeOk returns a tuple with the EntitlementType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementType + +`func (o *ListIdentityAccessItems200ResponseInner) SetEntitlementType(v string)` + +SetEntitlementType sets EntitlementType field to given value. + +### HasEntitlementType + +`func (o *ListIdentityAccessItems200ResponseInner) HasEntitlementType() bool` + +HasEntitlementType returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *ListIdentityAccessItems200ResponseInner) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *ListIdentityAccessItems200ResponseInner) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + + +### GetCloudGoverned + +`func (o *ListIdentityAccessItems200ResponseInner) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *ListIdentityAccessItems200ResponseInner) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *ListIdentityAccessItems200ResponseInner) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ListPredefinedSelectOptionsResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ListPredefinedSelectOptionsResponse.md new file mode 100644 index 000000000..e8b62d18f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ListPredefinedSelectOptionsResponse.md @@ -0,0 +1,64 @@ +--- +id: v2025-list-predefined-select-options-response +title: ListPredefinedSelectOptionsResponse +pagination_label: ListPredefinedSelectOptionsResponse +sidebar_label: ListPredefinedSelectOptionsResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListPredefinedSelectOptionsResponse', 'V2025ListPredefinedSelectOptionsResponse'] +slug: /tools/sdk/go/v2025/models/list-predefined-select-options-response +tags: ['SDK', 'Software Development Kit', 'ListPredefinedSelectOptionsResponse', 'V2025ListPredefinedSelectOptionsResponse'] +--- + +# ListPredefinedSelectOptionsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | Pointer to **[]string** | Results holds a list of PreDefinedSelectOption items | [optional] + +## Methods + +### NewListPredefinedSelectOptionsResponse + +`func NewListPredefinedSelectOptionsResponse() *ListPredefinedSelectOptionsResponse` + +NewListPredefinedSelectOptionsResponse instantiates a new ListPredefinedSelectOptionsResponse 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 + +### NewListPredefinedSelectOptionsResponseWithDefaults + +`func NewListPredefinedSelectOptionsResponseWithDefaults() *ListPredefinedSelectOptionsResponse` + +NewListPredefinedSelectOptionsResponseWithDefaults instantiates a new ListPredefinedSelectOptionsResponse 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 + +### GetResults + +`func (o *ListPredefinedSelectOptionsResponse) GetResults() []string` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *ListPredefinedSelectOptionsResponse) GetResultsOk() (*[]string, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *ListPredefinedSelectOptionsResponse) SetResults(v []string)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *ListPredefinedSelectOptionsResponse) HasResults() bool` + +HasResults returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ListWorkgroupMembers200ResponseInner.md b/docs/tools/sdk/go/Reference/V2025/Models/ListWorkgroupMembers200ResponseInner.md new file mode 100644 index 000000000..1f33029b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ListWorkgroupMembers200ResponseInner.md @@ -0,0 +1,142 @@ +--- +id: v2025-list-workgroup-members200-response-inner +title: ListWorkgroupMembers200ResponseInner +pagination_label: ListWorkgroupMembers200ResponseInner +sidebar_label: ListWorkgroupMembers200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListWorkgroupMembers200ResponseInner', 'V2025ListWorkgroupMembers200ResponseInner'] +slug: /tools/sdk/go/v2025/models/list-workgroup-members200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListWorkgroupMembers200ResponseInner', 'V2025ListWorkgroupMembers200ResponseInner'] +--- + +# ListWorkgroupMembers200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Workgroup member identity DTO type. | [optional] +**Id** | Pointer to **string** | Workgroup member identity ID. | [optional] +**Name** | Pointer to **string** | Workgroup member identity display name. | [optional] +**Email** | Pointer to **string** | Workgroup member identity email. | [optional] + +## Methods + +### NewListWorkgroupMembers200ResponseInner + +`func NewListWorkgroupMembers200ResponseInner() *ListWorkgroupMembers200ResponseInner` + +NewListWorkgroupMembers200ResponseInner instantiates a new ListWorkgroupMembers200ResponseInner 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 + +### NewListWorkgroupMembers200ResponseInnerWithDefaults + +`func NewListWorkgroupMembers200ResponseInnerWithDefaults() *ListWorkgroupMembers200ResponseInner` + +NewListWorkgroupMembers200ResponseInnerWithDefaults instantiates a new ListWorkgroupMembers200ResponseInner 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 + +### GetType + +`func (o *ListWorkgroupMembers200ResponseInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ListWorkgroupMembers200ResponseInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ListWorkgroupMembers200ResponseInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ListWorkgroupMembers200ResponseInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ListWorkgroupMembers200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ListWorkgroupMembers200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ListWorkgroupMembers200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ListWorkgroupMembers200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ListWorkgroupMembers200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ListWorkgroupMembers200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ListWorkgroupMembers200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ListWorkgroupMembers200ResponseInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *ListWorkgroupMembers200ResponseInner) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *ListWorkgroupMembers200ResponseInner) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *ListWorkgroupMembers200ResponseInner) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *ListWorkgroupMembers200ResponseInner) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LoadAccountsTask.md b/docs/tools/sdk/go/Reference/V2025/Models/LoadAccountsTask.md new file mode 100644 index 000000000..536e267a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LoadAccountsTask.md @@ -0,0 +1,90 @@ +--- +id: v2025-load-accounts-task +title: LoadAccountsTask +pagination_label: LoadAccountsTask +sidebar_label: LoadAccountsTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadAccountsTask', 'V2025LoadAccountsTask'] +slug: /tools/sdk/go/v2025/models/load-accounts-task +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTask', 'V2025LoadAccountsTask'] +--- + +# LoadAccountsTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Success** | Pointer to **bool** | The status of the result | [optional] [default to true] +**Task** | Pointer to [**LoadAccountsTaskTask**](load-accounts-task-task) | | [optional] + +## Methods + +### NewLoadAccountsTask + +`func NewLoadAccountsTask() *LoadAccountsTask` + +NewLoadAccountsTask instantiates a new LoadAccountsTask 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 + +### NewLoadAccountsTaskWithDefaults + +`func NewLoadAccountsTaskWithDefaults() *LoadAccountsTask` + +NewLoadAccountsTaskWithDefaults instantiates a new LoadAccountsTask 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 + +### GetSuccess + +`func (o *LoadAccountsTask) GetSuccess() bool` + +GetSuccess returns the Success field if non-nil, zero value otherwise. + +### GetSuccessOk + +`func (o *LoadAccountsTask) GetSuccessOk() (*bool, bool)` + +GetSuccessOk returns a tuple with the Success field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSuccess + +`func (o *LoadAccountsTask) SetSuccess(v bool)` + +SetSuccess sets Success field to given value. + +### HasSuccess + +`func (o *LoadAccountsTask) HasSuccess() bool` + +HasSuccess returns a boolean if a field has been set. + +### GetTask + +`func (o *LoadAccountsTask) GetTask() LoadAccountsTaskTask` + +GetTask returns the Task field if non-nil, zero value otherwise. + +### GetTaskOk + +`func (o *LoadAccountsTask) GetTaskOk() (*LoadAccountsTaskTask, bool)` + +GetTaskOk returns a tuple with the Task field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTask + +`func (o *LoadAccountsTask) SetTask(v LoadAccountsTaskTask)` + +SetTask sets Task field to given value. + +### HasTask + +`func (o *LoadAccountsTask) HasTask() bool` + +HasTask returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LoadAccountsTaskTask.md b/docs/tools/sdk/go/Reference/V2025/Models/LoadAccountsTaskTask.md new file mode 100644 index 000000000..f3147a740 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LoadAccountsTaskTask.md @@ -0,0 +1,452 @@ +--- +id: v2025-load-accounts-task-task +title: LoadAccountsTaskTask +pagination_label: LoadAccountsTaskTask +sidebar_label: LoadAccountsTaskTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadAccountsTaskTask', 'V2025LoadAccountsTaskTask'] +slug: /tools/sdk/go/v2025/models/load-accounts-task-task +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTask', 'V2025LoadAccountsTaskTask'] +--- + +# LoadAccountsTaskTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the task this taskStatus represents | [optional] +**Type** | Pointer to **string** | Type of task this task represents | [optional] +**Name** | Pointer to **string** | The name of the aggregation process | [optional] +**Description** | Pointer to **string** | The description of the task | [optional] +**Launcher** | Pointer to **string** | The user who initiated the task | [optional] +**Created** | Pointer to **SailPointTime** | The Task creation date | [optional] +**Launched** | Pointer to **NullableTime** | The task start date | [optional] +**Completed** | Pointer to **NullableTime** | The task completion date | [optional] +**CompletionStatus** | Pointer to **NullableString** | Task completion status. | [optional] +**ParentName** | Pointer to **NullableString** | Name of the parent task if exists. | [optional] +**Messages** | Pointer to [**[]LoadAccountsTaskTaskMessagesInner**](load-accounts-task-task-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**Progress** | Pointer to **NullableString** | Current task state. | [optional] +**Attributes** | Pointer to [**LoadAccountsTaskTaskAttributes**](load-accounts-task-task-attributes) | | [optional] +**Returns** | Pointer to [**[]LoadAccountsTaskTaskReturnsInner**](load-accounts-task-task-returns-inner) | Return values from the task | [optional] + +## Methods + +### NewLoadAccountsTaskTask + +`func NewLoadAccountsTaskTask() *LoadAccountsTaskTask` + +NewLoadAccountsTaskTask instantiates a new LoadAccountsTaskTask 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 + +### NewLoadAccountsTaskTaskWithDefaults + +`func NewLoadAccountsTaskTaskWithDefaults() *LoadAccountsTaskTask` + +NewLoadAccountsTaskTaskWithDefaults instantiates a new LoadAccountsTaskTask 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 + +### GetId + +`func (o *LoadAccountsTaskTask) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LoadAccountsTaskTask) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LoadAccountsTaskTask) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LoadAccountsTaskTask) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *LoadAccountsTaskTask) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LoadAccountsTaskTask) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LoadAccountsTaskTask) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LoadAccountsTaskTask) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *LoadAccountsTaskTask) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LoadAccountsTaskTask) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *LoadAccountsTaskTask) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *LoadAccountsTaskTask) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *LoadAccountsTaskTask) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *LoadAccountsTaskTask) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *LoadAccountsTaskTask) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *LoadAccountsTaskTask) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetLauncher + +`func (o *LoadAccountsTaskTask) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *LoadAccountsTaskTask) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *LoadAccountsTaskTask) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + +### HasLauncher + +`func (o *LoadAccountsTaskTask) HasLauncher() bool` + +HasLauncher returns a boolean if a field has been set. + +### GetCreated + +`func (o *LoadAccountsTaskTask) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LoadAccountsTaskTask) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *LoadAccountsTaskTask) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *LoadAccountsTaskTask) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetLaunched + +`func (o *LoadAccountsTaskTask) GetLaunched() SailPointTime` + +GetLaunched returns the Launched field if non-nil, zero value otherwise. + +### GetLaunchedOk + +`func (o *LoadAccountsTaskTask) GetLaunchedOk() (*SailPointTime, bool)` + +GetLaunchedOk returns a tuple with the Launched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunched + +`func (o *LoadAccountsTaskTask) SetLaunched(v SailPointTime)` + +SetLaunched sets Launched field to given value. + +### HasLaunched + +`func (o *LoadAccountsTaskTask) HasLaunched() bool` + +HasLaunched returns a boolean if a field has been set. + +### SetLaunchedNil + +`func (o *LoadAccountsTaskTask) SetLaunchedNil(b bool)` + + SetLaunchedNil sets the value for Launched to be an explicit nil + +### UnsetLaunched +`func (o *LoadAccountsTaskTask) UnsetLaunched()` + +UnsetLaunched ensures that no value is present for Launched, not even an explicit nil +### GetCompleted + +`func (o *LoadAccountsTaskTask) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *LoadAccountsTaskTask) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *LoadAccountsTaskTask) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *LoadAccountsTaskTask) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *LoadAccountsTaskTask) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *LoadAccountsTaskTask) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetCompletionStatus + +`func (o *LoadAccountsTaskTask) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *LoadAccountsTaskTask) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *LoadAccountsTaskTask) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *LoadAccountsTaskTask) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + +### SetCompletionStatusNil + +`func (o *LoadAccountsTaskTask) SetCompletionStatusNil(b bool)` + + SetCompletionStatusNil sets the value for CompletionStatus to be an explicit nil + +### UnsetCompletionStatus +`func (o *LoadAccountsTaskTask) UnsetCompletionStatus()` + +UnsetCompletionStatus ensures that no value is present for CompletionStatus, not even an explicit nil +### GetParentName + +`func (o *LoadAccountsTaskTask) GetParentName() string` + +GetParentName returns the ParentName field if non-nil, zero value otherwise. + +### GetParentNameOk + +`func (o *LoadAccountsTaskTask) GetParentNameOk() (*string, bool)` + +GetParentNameOk returns a tuple with the ParentName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentName + +`func (o *LoadAccountsTaskTask) SetParentName(v string)` + +SetParentName sets ParentName field to given value. + +### HasParentName + +`func (o *LoadAccountsTaskTask) HasParentName() bool` + +HasParentName returns a boolean if a field has been set. + +### SetParentNameNil + +`func (o *LoadAccountsTaskTask) SetParentNameNil(b bool)` + + SetParentNameNil sets the value for ParentName to be an explicit nil + +### UnsetParentName +`func (o *LoadAccountsTaskTask) UnsetParentName()` + +UnsetParentName ensures that no value is present for ParentName, not even an explicit nil +### GetMessages + +`func (o *LoadAccountsTaskTask) GetMessages() []LoadAccountsTaskTaskMessagesInner` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *LoadAccountsTaskTask) GetMessagesOk() (*[]LoadAccountsTaskTaskMessagesInner, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *LoadAccountsTaskTask) SetMessages(v []LoadAccountsTaskTaskMessagesInner)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *LoadAccountsTaskTask) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetProgress + +`func (o *LoadAccountsTaskTask) GetProgress() string` + +GetProgress returns the Progress field if non-nil, zero value otherwise. + +### GetProgressOk + +`func (o *LoadAccountsTaskTask) GetProgressOk() (*string, bool)` + +GetProgressOk returns a tuple with the Progress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProgress + +`func (o *LoadAccountsTaskTask) SetProgress(v string)` + +SetProgress sets Progress field to given value. + +### HasProgress + +`func (o *LoadAccountsTaskTask) HasProgress() bool` + +HasProgress returns a boolean if a field has been set. + +### SetProgressNil + +`func (o *LoadAccountsTaskTask) SetProgressNil(b bool)` + + SetProgressNil sets the value for Progress to be an explicit nil + +### UnsetProgress +`func (o *LoadAccountsTaskTask) UnsetProgress()` + +UnsetProgress ensures that no value is present for Progress, not even an explicit nil +### GetAttributes + +`func (o *LoadAccountsTaskTask) GetAttributes() LoadAccountsTaskTaskAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *LoadAccountsTaskTask) GetAttributesOk() (*LoadAccountsTaskTaskAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *LoadAccountsTaskTask) SetAttributes(v LoadAccountsTaskTaskAttributes)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *LoadAccountsTaskTask) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetReturns + +`func (o *LoadAccountsTaskTask) GetReturns() []LoadAccountsTaskTaskReturnsInner` + +GetReturns returns the Returns field if non-nil, zero value otherwise. + +### GetReturnsOk + +`func (o *LoadAccountsTaskTask) GetReturnsOk() (*[]LoadAccountsTaskTaskReturnsInner, bool)` + +GetReturnsOk returns a tuple with the Returns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReturns + +`func (o *LoadAccountsTaskTask) SetReturns(v []LoadAccountsTaskTaskReturnsInner)` + +SetReturns sets Returns field to given value. + +### HasReturns + +`func (o *LoadAccountsTaskTask) HasReturns() bool` + +HasReturns returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LoadAccountsTaskTaskAttributes.md b/docs/tools/sdk/go/Reference/V2025/Models/LoadAccountsTaskTaskAttributes.md new file mode 100644 index 000000000..7b2a7a5c3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LoadAccountsTaskTaskAttributes.md @@ -0,0 +1,90 @@ +--- +id: v2025-load-accounts-task-task-attributes +title: LoadAccountsTaskTaskAttributes +pagination_label: LoadAccountsTaskTaskAttributes +sidebar_label: LoadAccountsTaskTaskAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadAccountsTaskTaskAttributes', 'V2025LoadAccountsTaskTaskAttributes'] +slug: /tools/sdk/go/v2025/models/load-accounts-task-task-attributes +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskAttributes', 'V2025LoadAccountsTaskTaskAttributes'] +--- + +# LoadAccountsTaskTaskAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AppId** | Pointer to **string** | The id of the source | [optional] +**OptimizedAggregation** | Pointer to **string** | The indicator if the aggregation process was enabled/disabled for the aggregation job | [optional] + +## Methods + +### NewLoadAccountsTaskTaskAttributes + +`func NewLoadAccountsTaskTaskAttributes() *LoadAccountsTaskTaskAttributes` + +NewLoadAccountsTaskTaskAttributes instantiates a new LoadAccountsTaskTaskAttributes 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 + +### NewLoadAccountsTaskTaskAttributesWithDefaults + +`func NewLoadAccountsTaskTaskAttributesWithDefaults() *LoadAccountsTaskTaskAttributes` + +NewLoadAccountsTaskTaskAttributesWithDefaults instantiates a new LoadAccountsTaskTaskAttributes 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 + +### GetAppId + +`func (o *LoadAccountsTaskTaskAttributes) GetAppId() string` + +GetAppId returns the AppId field if non-nil, zero value otherwise. + +### GetAppIdOk + +`func (o *LoadAccountsTaskTaskAttributes) GetAppIdOk() (*string, bool)` + +GetAppIdOk returns a tuple with the AppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppId + +`func (o *LoadAccountsTaskTaskAttributes) SetAppId(v string)` + +SetAppId sets AppId field to given value. + +### HasAppId + +`func (o *LoadAccountsTaskTaskAttributes) HasAppId() bool` + +HasAppId returns a boolean if a field has been set. + +### GetOptimizedAggregation + +`func (o *LoadAccountsTaskTaskAttributes) GetOptimizedAggregation() string` + +GetOptimizedAggregation returns the OptimizedAggregation field if non-nil, zero value otherwise. + +### GetOptimizedAggregationOk + +`func (o *LoadAccountsTaskTaskAttributes) GetOptimizedAggregationOk() (*string, bool)` + +GetOptimizedAggregationOk returns a tuple with the OptimizedAggregation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOptimizedAggregation + +`func (o *LoadAccountsTaskTaskAttributes) SetOptimizedAggregation(v string)` + +SetOptimizedAggregation sets OptimizedAggregation field to given value. + +### HasOptimizedAggregation + +`func (o *LoadAccountsTaskTaskAttributes) HasOptimizedAggregation() bool` + +HasOptimizedAggregation returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LoadAccountsTaskTaskMessagesInner.md b/docs/tools/sdk/go/Reference/V2025/Models/LoadAccountsTaskTaskMessagesInner.md new file mode 100644 index 000000000..a5fb6b7c1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LoadAccountsTaskTaskMessagesInner.md @@ -0,0 +1,168 @@ +--- +id: v2025-load-accounts-task-task-messages-inner +title: LoadAccountsTaskTaskMessagesInner +pagination_label: LoadAccountsTaskTaskMessagesInner +sidebar_label: LoadAccountsTaskTaskMessagesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadAccountsTaskTaskMessagesInner', 'V2025LoadAccountsTaskTaskMessagesInner'] +slug: /tools/sdk/go/v2025/models/load-accounts-task-task-messages-inner +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskMessagesInner', 'V2025LoadAccountsTaskTaskMessagesInner'] +--- + +# LoadAccountsTaskTaskMessagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the message. | [optional] +**Error** | Pointer to **bool** | Flag whether message is an error. | [optional] [default to false] +**Warning** | Pointer to **bool** | Flag whether message is a warning. | [optional] [default to false] +**Key** | Pointer to **string** | Message string identifier. | [optional] +**LocalizedText** | Pointer to **string** | Message context with the locale based language. | [optional] + +## Methods + +### NewLoadAccountsTaskTaskMessagesInner + +`func NewLoadAccountsTaskTaskMessagesInner() *LoadAccountsTaskTaskMessagesInner` + +NewLoadAccountsTaskTaskMessagesInner instantiates a new LoadAccountsTaskTaskMessagesInner 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 + +### NewLoadAccountsTaskTaskMessagesInnerWithDefaults + +`func NewLoadAccountsTaskTaskMessagesInnerWithDefaults() *LoadAccountsTaskTaskMessagesInner` + +NewLoadAccountsTaskTaskMessagesInnerWithDefaults instantiates a new LoadAccountsTaskTaskMessagesInner 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 + +### GetType + +`func (o *LoadAccountsTaskTaskMessagesInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LoadAccountsTaskTaskMessagesInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LoadAccountsTaskTaskMessagesInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LoadAccountsTaskTaskMessagesInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetError + +`func (o *LoadAccountsTaskTaskMessagesInner) GetError() bool` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *LoadAccountsTaskTaskMessagesInner) GetErrorOk() (*bool, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *LoadAccountsTaskTaskMessagesInner) SetError(v bool)` + +SetError sets Error field to given value. + +### HasError + +`func (o *LoadAccountsTaskTaskMessagesInner) HasError() bool` + +HasError returns a boolean if a field has been set. + +### GetWarning + +`func (o *LoadAccountsTaskTaskMessagesInner) GetWarning() bool` + +GetWarning returns the Warning field if non-nil, zero value otherwise. + +### GetWarningOk + +`func (o *LoadAccountsTaskTaskMessagesInner) GetWarningOk() (*bool, bool)` + +GetWarningOk returns a tuple with the Warning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarning + +`func (o *LoadAccountsTaskTaskMessagesInner) SetWarning(v bool)` + +SetWarning sets Warning field to given value. + +### HasWarning + +`func (o *LoadAccountsTaskTaskMessagesInner) HasWarning() bool` + +HasWarning returns a boolean if a field has been set. + +### GetKey + +`func (o *LoadAccountsTaskTaskMessagesInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *LoadAccountsTaskTaskMessagesInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *LoadAccountsTaskTaskMessagesInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *LoadAccountsTaskTaskMessagesInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetLocalizedText + +`func (o *LoadAccountsTaskTaskMessagesInner) GetLocalizedText() string` + +GetLocalizedText returns the LocalizedText field if non-nil, zero value otherwise. + +### GetLocalizedTextOk + +`func (o *LoadAccountsTaskTaskMessagesInner) GetLocalizedTextOk() (*string, bool)` + +GetLocalizedTextOk returns a tuple with the LocalizedText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizedText + +`func (o *LoadAccountsTaskTaskMessagesInner) SetLocalizedText(v string)` + +SetLocalizedText sets LocalizedText field to given value. + +### HasLocalizedText + +`func (o *LoadAccountsTaskTaskMessagesInner) HasLocalizedText() bool` + +HasLocalizedText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LoadAccountsTaskTaskReturnsInner.md b/docs/tools/sdk/go/Reference/V2025/Models/LoadAccountsTaskTaskReturnsInner.md new file mode 100644 index 000000000..3c5b0164f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LoadAccountsTaskTaskReturnsInner.md @@ -0,0 +1,90 @@ +--- +id: v2025-load-accounts-task-task-returns-inner +title: LoadAccountsTaskTaskReturnsInner +pagination_label: LoadAccountsTaskTaskReturnsInner +sidebar_label: LoadAccountsTaskTaskReturnsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadAccountsTaskTaskReturnsInner', 'V2025LoadAccountsTaskTaskReturnsInner'] +slug: /tools/sdk/go/v2025/models/load-accounts-task-task-returns-inner +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskReturnsInner', 'V2025LoadAccountsTaskTaskReturnsInner'] +--- + +# LoadAccountsTaskTaskReturnsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayLabel** | Pointer to **string** | The display label of the return value | [optional] +**AttributeName** | Pointer to **string** | The attribute name of the return value | [optional] + +## Methods + +### NewLoadAccountsTaskTaskReturnsInner + +`func NewLoadAccountsTaskTaskReturnsInner() *LoadAccountsTaskTaskReturnsInner` + +NewLoadAccountsTaskTaskReturnsInner instantiates a new LoadAccountsTaskTaskReturnsInner 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 + +### NewLoadAccountsTaskTaskReturnsInnerWithDefaults + +`func NewLoadAccountsTaskTaskReturnsInnerWithDefaults() *LoadAccountsTaskTaskReturnsInner` + +NewLoadAccountsTaskTaskReturnsInnerWithDefaults instantiates a new LoadAccountsTaskTaskReturnsInner 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 + +### GetDisplayLabel + +`func (o *LoadAccountsTaskTaskReturnsInner) GetDisplayLabel() string` + +GetDisplayLabel returns the DisplayLabel field if non-nil, zero value otherwise. + +### GetDisplayLabelOk + +`func (o *LoadAccountsTaskTaskReturnsInner) GetDisplayLabelOk() (*string, bool)` + +GetDisplayLabelOk returns a tuple with the DisplayLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayLabel + +`func (o *LoadAccountsTaskTaskReturnsInner) SetDisplayLabel(v string)` + +SetDisplayLabel sets DisplayLabel field to given value. + +### HasDisplayLabel + +`func (o *LoadAccountsTaskTaskReturnsInner) HasDisplayLabel() bool` + +HasDisplayLabel returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *LoadAccountsTaskTaskReturnsInner) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *LoadAccountsTaskTaskReturnsInner) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *LoadAccountsTaskTaskReturnsInner) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *LoadAccountsTaskTaskReturnsInner) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LoadEntitlementTask.md b/docs/tools/sdk/go/Reference/V2025/Models/LoadEntitlementTask.md new file mode 100644 index 000000000..eb3791828 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LoadEntitlementTask.md @@ -0,0 +1,220 @@ +--- +id: v2025-load-entitlement-task +title: LoadEntitlementTask +pagination_label: LoadEntitlementTask +sidebar_label: LoadEntitlementTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadEntitlementTask', 'V2025LoadEntitlementTask'] +slug: /tools/sdk/go/v2025/models/load-entitlement-task +tags: ['SDK', 'Software Development Kit', 'LoadEntitlementTask', 'V2025LoadEntitlementTask'] +--- + +# LoadEntitlementTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the task this taskStatus represents | [optional] +**Type** | Pointer to **string** | Type of task this task represents | [optional] +**UniqueName** | Pointer to **string** | The name of the task | [optional] +**Description** | Pointer to **string** | The description of the task | [optional] +**Launcher** | Pointer to **string** | The user who initiated the task | [optional] +**Created** | Pointer to **SailPointTime** | The creation date of the task | [optional] +**Returns** | Pointer to [**[]LoadEntitlementTaskReturnsInner**](load-entitlement-task-returns-inner) | Return values from the task | [optional] + +## Methods + +### NewLoadEntitlementTask + +`func NewLoadEntitlementTask() *LoadEntitlementTask` + +NewLoadEntitlementTask instantiates a new LoadEntitlementTask 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 + +### NewLoadEntitlementTaskWithDefaults + +`func NewLoadEntitlementTaskWithDefaults() *LoadEntitlementTask` + +NewLoadEntitlementTaskWithDefaults instantiates a new LoadEntitlementTask 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 + +### GetId + +`func (o *LoadEntitlementTask) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LoadEntitlementTask) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LoadEntitlementTask) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LoadEntitlementTask) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *LoadEntitlementTask) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LoadEntitlementTask) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LoadEntitlementTask) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LoadEntitlementTask) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetUniqueName + +`func (o *LoadEntitlementTask) GetUniqueName() string` + +GetUniqueName returns the UniqueName field if non-nil, zero value otherwise. + +### GetUniqueNameOk + +`func (o *LoadEntitlementTask) GetUniqueNameOk() (*string, bool)` + +GetUniqueNameOk returns a tuple with the UniqueName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUniqueName + +`func (o *LoadEntitlementTask) SetUniqueName(v string)` + +SetUniqueName sets UniqueName field to given value. + +### HasUniqueName + +`func (o *LoadEntitlementTask) HasUniqueName() bool` + +HasUniqueName returns a boolean if a field has been set. + +### GetDescription + +`func (o *LoadEntitlementTask) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *LoadEntitlementTask) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *LoadEntitlementTask) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *LoadEntitlementTask) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetLauncher + +`func (o *LoadEntitlementTask) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *LoadEntitlementTask) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *LoadEntitlementTask) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + +### HasLauncher + +`func (o *LoadEntitlementTask) HasLauncher() bool` + +HasLauncher returns a boolean if a field has been set. + +### GetCreated + +`func (o *LoadEntitlementTask) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LoadEntitlementTask) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *LoadEntitlementTask) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *LoadEntitlementTask) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetReturns + +`func (o *LoadEntitlementTask) GetReturns() []LoadEntitlementTaskReturnsInner` + +GetReturns returns the Returns field if non-nil, zero value otherwise. + +### GetReturnsOk + +`func (o *LoadEntitlementTask) GetReturnsOk() (*[]LoadEntitlementTaskReturnsInner, bool)` + +GetReturnsOk returns a tuple with the Returns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReturns + +`func (o *LoadEntitlementTask) SetReturns(v []LoadEntitlementTaskReturnsInner)` + +SetReturns sets Returns field to given value. + +### HasReturns + +`func (o *LoadEntitlementTask) HasReturns() bool` + +HasReturns returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LoadEntitlementTaskReturnsInner.md b/docs/tools/sdk/go/Reference/V2025/Models/LoadEntitlementTaskReturnsInner.md new file mode 100644 index 000000000..47a4bcc06 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LoadEntitlementTaskReturnsInner.md @@ -0,0 +1,90 @@ +--- +id: v2025-load-entitlement-task-returns-inner +title: LoadEntitlementTaskReturnsInner +pagination_label: LoadEntitlementTaskReturnsInner +sidebar_label: LoadEntitlementTaskReturnsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadEntitlementTaskReturnsInner', 'V2025LoadEntitlementTaskReturnsInner'] +slug: /tools/sdk/go/v2025/models/load-entitlement-task-returns-inner +tags: ['SDK', 'Software Development Kit', 'LoadEntitlementTaskReturnsInner', 'V2025LoadEntitlementTaskReturnsInner'] +--- + +# LoadEntitlementTaskReturnsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayLabel** | Pointer to **string** | The display label for the return value | [optional] +**AttributeName** | Pointer to **string** | The attribute name for the return value | [optional] + +## Methods + +### NewLoadEntitlementTaskReturnsInner + +`func NewLoadEntitlementTaskReturnsInner() *LoadEntitlementTaskReturnsInner` + +NewLoadEntitlementTaskReturnsInner instantiates a new LoadEntitlementTaskReturnsInner 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 + +### NewLoadEntitlementTaskReturnsInnerWithDefaults + +`func NewLoadEntitlementTaskReturnsInnerWithDefaults() *LoadEntitlementTaskReturnsInner` + +NewLoadEntitlementTaskReturnsInnerWithDefaults instantiates a new LoadEntitlementTaskReturnsInner 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 + +### GetDisplayLabel + +`func (o *LoadEntitlementTaskReturnsInner) GetDisplayLabel() string` + +GetDisplayLabel returns the DisplayLabel field if non-nil, zero value otherwise. + +### GetDisplayLabelOk + +`func (o *LoadEntitlementTaskReturnsInner) GetDisplayLabelOk() (*string, bool)` + +GetDisplayLabelOk returns a tuple with the DisplayLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayLabel + +`func (o *LoadEntitlementTaskReturnsInner) SetDisplayLabel(v string)` + +SetDisplayLabel sets DisplayLabel field to given value. + +### HasDisplayLabel + +`func (o *LoadEntitlementTaskReturnsInner) HasDisplayLabel() bool` + +HasDisplayLabel returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *LoadEntitlementTaskReturnsInner) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *LoadEntitlementTaskReturnsInner) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *LoadEntitlementTaskReturnsInner) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *LoadEntitlementTaskReturnsInner) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LoadUncorrelatedAccountsTask.md b/docs/tools/sdk/go/Reference/V2025/Models/LoadUncorrelatedAccountsTask.md new file mode 100644 index 000000000..0e5240e80 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LoadUncorrelatedAccountsTask.md @@ -0,0 +1,90 @@ +--- +id: v2025-load-uncorrelated-accounts-task +title: LoadUncorrelatedAccountsTask +pagination_label: LoadUncorrelatedAccountsTask +sidebar_label: LoadUncorrelatedAccountsTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadUncorrelatedAccountsTask', 'V2025LoadUncorrelatedAccountsTask'] +slug: /tools/sdk/go/v2025/models/load-uncorrelated-accounts-task +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTask', 'V2025LoadUncorrelatedAccountsTask'] +--- + +# LoadUncorrelatedAccountsTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Success** | Pointer to **bool** | The status of the result | [optional] [default to true] +**Task** | Pointer to [**LoadUncorrelatedAccountsTaskTask**](load-uncorrelated-accounts-task-task) | | [optional] + +## Methods + +### NewLoadUncorrelatedAccountsTask + +`func NewLoadUncorrelatedAccountsTask() *LoadUncorrelatedAccountsTask` + +NewLoadUncorrelatedAccountsTask instantiates a new LoadUncorrelatedAccountsTask 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 + +### NewLoadUncorrelatedAccountsTaskWithDefaults + +`func NewLoadUncorrelatedAccountsTaskWithDefaults() *LoadUncorrelatedAccountsTask` + +NewLoadUncorrelatedAccountsTaskWithDefaults instantiates a new LoadUncorrelatedAccountsTask 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 + +### GetSuccess + +`func (o *LoadUncorrelatedAccountsTask) GetSuccess() bool` + +GetSuccess returns the Success field if non-nil, zero value otherwise. + +### GetSuccessOk + +`func (o *LoadUncorrelatedAccountsTask) GetSuccessOk() (*bool, bool)` + +GetSuccessOk returns a tuple with the Success field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSuccess + +`func (o *LoadUncorrelatedAccountsTask) SetSuccess(v bool)` + +SetSuccess sets Success field to given value. + +### HasSuccess + +`func (o *LoadUncorrelatedAccountsTask) HasSuccess() bool` + +HasSuccess returns a boolean if a field has been set. + +### GetTask + +`func (o *LoadUncorrelatedAccountsTask) GetTask() LoadUncorrelatedAccountsTaskTask` + +GetTask returns the Task field if non-nil, zero value otherwise. + +### GetTaskOk + +`func (o *LoadUncorrelatedAccountsTask) GetTaskOk() (*LoadUncorrelatedAccountsTaskTask, bool)` + +GetTaskOk returns a tuple with the Task field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTask + +`func (o *LoadUncorrelatedAccountsTask) SetTask(v LoadUncorrelatedAccountsTaskTask)` + +SetTask sets Task field to given value. + +### HasTask + +`func (o *LoadUncorrelatedAccountsTask) HasTask() bool` + +HasTask returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LoadUncorrelatedAccountsTaskTask.md b/docs/tools/sdk/go/Reference/V2025/Models/LoadUncorrelatedAccountsTaskTask.md new file mode 100644 index 000000000..4647de519 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LoadUncorrelatedAccountsTaskTask.md @@ -0,0 +1,452 @@ +--- +id: v2025-load-uncorrelated-accounts-task-task +title: LoadUncorrelatedAccountsTaskTask +pagination_label: LoadUncorrelatedAccountsTaskTask +sidebar_label: LoadUncorrelatedAccountsTaskTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadUncorrelatedAccountsTaskTask', 'V2025LoadUncorrelatedAccountsTaskTask'] +slug: /tools/sdk/go/v2025/models/load-uncorrelated-accounts-task-task +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTask', 'V2025LoadUncorrelatedAccountsTaskTask'] +--- + +# LoadUncorrelatedAccountsTaskTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the task this taskStatus represents | [optional] +**Type** | Pointer to **string** | Type of task this task represents | [optional] +**Name** | Pointer to **string** | The name of uncorrelated accounts process | [optional] +**Description** | Pointer to **string** | The description of the task | [optional] +**Launcher** | Pointer to **string** | The user who initiated the task | [optional] +**Created** | Pointer to **SailPointTime** | The Task creation date | [optional] +**Launched** | Pointer to **NullableTime** | The task start date | [optional] +**Completed** | Pointer to **NullableTime** | The task completion date | [optional] +**CompletionStatus** | Pointer to **NullableString** | Task completion status. | [optional] +**ParentName** | Pointer to **NullableString** | Name of the parent task if exists. | [optional] +**Messages** | Pointer to [**[]LoadUncorrelatedAccountsTaskTaskMessagesInner**](load-uncorrelated-accounts-task-task-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**Progress** | Pointer to **NullableString** | Current task state. | [optional] +**Attributes** | Pointer to [**LoadUncorrelatedAccountsTaskTaskAttributes**](load-uncorrelated-accounts-task-task-attributes) | | [optional] +**Returns** | Pointer to **map[string]interface{}** | Return values from the task | [optional] + +## Methods + +### NewLoadUncorrelatedAccountsTaskTask + +`func NewLoadUncorrelatedAccountsTaskTask() *LoadUncorrelatedAccountsTaskTask` + +NewLoadUncorrelatedAccountsTaskTask instantiates a new LoadUncorrelatedAccountsTaskTask 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 + +### NewLoadUncorrelatedAccountsTaskTaskWithDefaults + +`func NewLoadUncorrelatedAccountsTaskTaskWithDefaults() *LoadUncorrelatedAccountsTaskTask` + +NewLoadUncorrelatedAccountsTaskTaskWithDefaults instantiates a new LoadUncorrelatedAccountsTaskTask 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 + +### GetId + +`func (o *LoadUncorrelatedAccountsTaskTask) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LoadUncorrelatedAccountsTaskTask) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LoadUncorrelatedAccountsTaskTask) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *LoadUncorrelatedAccountsTaskTask) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LoadUncorrelatedAccountsTaskTask) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LoadUncorrelatedAccountsTaskTask) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *LoadUncorrelatedAccountsTaskTask) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *LoadUncorrelatedAccountsTaskTask) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *LoadUncorrelatedAccountsTaskTask) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *LoadUncorrelatedAccountsTaskTask) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *LoadUncorrelatedAccountsTaskTask) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *LoadUncorrelatedAccountsTaskTask) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetLauncher + +`func (o *LoadUncorrelatedAccountsTaskTask) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *LoadUncorrelatedAccountsTaskTask) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + +### HasLauncher + +`func (o *LoadUncorrelatedAccountsTaskTask) HasLauncher() bool` + +HasLauncher returns a boolean if a field has been set. + +### GetCreated + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *LoadUncorrelatedAccountsTaskTask) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *LoadUncorrelatedAccountsTaskTask) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetLaunched + +`func (o *LoadUncorrelatedAccountsTaskTask) GetLaunched() SailPointTime` + +GetLaunched returns the Launched field if non-nil, zero value otherwise. + +### GetLaunchedOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetLaunchedOk() (*SailPointTime, bool)` + +GetLaunchedOk returns a tuple with the Launched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunched + +`func (o *LoadUncorrelatedAccountsTaskTask) SetLaunched(v SailPointTime)` + +SetLaunched sets Launched field to given value. + +### HasLaunched + +`func (o *LoadUncorrelatedAccountsTaskTask) HasLaunched() bool` + +HasLaunched returns a boolean if a field has been set. + +### SetLaunchedNil + +`func (o *LoadUncorrelatedAccountsTaskTask) SetLaunchedNil(b bool)` + + SetLaunchedNil sets the value for Launched to be an explicit nil + +### UnsetLaunched +`func (o *LoadUncorrelatedAccountsTaskTask) UnsetLaunched()` + +UnsetLaunched ensures that no value is present for Launched, not even an explicit nil +### GetCompleted + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *LoadUncorrelatedAccountsTaskTask) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *LoadUncorrelatedAccountsTaskTask) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *LoadUncorrelatedAccountsTaskTask) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *LoadUncorrelatedAccountsTaskTask) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetCompletionStatus + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *LoadUncorrelatedAccountsTaskTask) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *LoadUncorrelatedAccountsTaskTask) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + +### SetCompletionStatusNil + +`func (o *LoadUncorrelatedAccountsTaskTask) SetCompletionStatusNil(b bool)` + + SetCompletionStatusNil sets the value for CompletionStatus to be an explicit nil + +### UnsetCompletionStatus +`func (o *LoadUncorrelatedAccountsTaskTask) UnsetCompletionStatus()` + +UnsetCompletionStatus ensures that no value is present for CompletionStatus, not even an explicit nil +### GetParentName + +`func (o *LoadUncorrelatedAccountsTaskTask) GetParentName() string` + +GetParentName returns the ParentName field if non-nil, zero value otherwise. + +### GetParentNameOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetParentNameOk() (*string, bool)` + +GetParentNameOk returns a tuple with the ParentName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentName + +`func (o *LoadUncorrelatedAccountsTaskTask) SetParentName(v string)` + +SetParentName sets ParentName field to given value. + +### HasParentName + +`func (o *LoadUncorrelatedAccountsTaskTask) HasParentName() bool` + +HasParentName returns a boolean if a field has been set. + +### SetParentNameNil + +`func (o *LoadUncorrelatedAccountsTaskTask) SetParentNameNil(b bool)` + + SetParentNameNil sets the value for ParentName to be an explicit nil + +### UnsetParentName +`func (o *LoadUncorrelatedAccountsTaskTask) UnsetParentName()` + +UnsetParentName ensures that no value is present for ParentName, not even an explicit nil +### GetMessages + +`func (o *LoadUncorrelatedAccountsTaskTask) GetMessages() []LoadUncorrelatedAccountsTaskTaskMessagesInner` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetMessagesOk() (*[]LoadUncorrelatedAccountsTaskTaskMessagesInner, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *LoadUncorrelatedAccountsTaskTask) SetMessages(v []LoadUncorrelatedAccountsTaskTaskMessagesInner)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *LoadUncorrelatedAccountsTaskTask) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetProgress + +`func (o *LoadUncorrelatedAccountsTaskTask) GetProgress() string` + +GetProgress returns the Progress field if non-nil, zero value otherwise. + +### GetProgressOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetProgressOk() (*string, bool)` + +GetProgressOk returns a tuple with the Progress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProgress + +`func (o *LoadUncorrelatedAccountsTaskTask) SetProgress(v string)` + +SetProgress sets Progress field to given value. + +### HasProgress + +`func (o *LoadUncorrelatedAccountsTaskTask) HasProgress() bool` + +HasProgress returns a boolean if a field has been set. + +### SetProgressNil + +`func (o *LoadUncorrelatedAccountsTaskTask) SetProgressNil(b bool)` + + SetProgressNil sets the value for Progress to be an explicit nil + +### UnsetProgress +`func (o *LoadUncorrelatedAccountsTaskTask) UnsetProgress()` + +UnsetProgress ensures that no value is present for Progress, not even an explicit nil +### GetAttributes + +`func (o *LoadUncorrelatedAccountsTaskTask) GetAttributes() LoadUncorrelatedAccountsTaskTaskAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetAttributesOk() (*LoadUncorrelatedAccountsTaskTaskAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *LoadUncorrelatedAccountsTaskTask) SetAttributes(v LoadUncorrelatedAccountsTaskTaskAttributes)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *LoadUncorrelatedAccountsTaskTask) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetReturns + +`func (o *LoadUncorrelatedAccountsTaskTask) GetReturns() map[string]interface{}` + +GetReturns returns the Returns field if non-nil, zero value otherwise. + +### GetReturnsOk + +`func (o *LoadUncorrelatedAccountsTaskTask) GetReturnsOk() (*map[string]interface{}, bool)` + +GetReturnsOk returns a tuple with the Returns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReturns + +`func (o *LoadUncorrelatedAccountsTaskTask) SetReturns(v map[string]interface{})` + +SetReturns sets Returns field to given value. + +### HasReturns + +`func (o *LoadUncorrelatedAccountsTaskTask) HasReturns() bool` + +HasReturns returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md b/docs/tools/sdk/go/Reference/V2025/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md new file mode 100644 index 000000000..d3215ea42 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md @@ -0,0 +1,90 @@ +--- +id: v2025-load-uncorrelated-accounts-task-task-attributes +title: LoadUncorrelatedAccountsTaskTaskAttributes +pagination_label: LoadUncorrelatedAccountsTaskTaskAttributes +sidebar_label: LoadUncorrelatedAccountsTaskTaskAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadUncorrelatedAccountsTaskTaskAttributes', 'V2025LoadUncorrelatedAccountsTaskTaskAttributes'] +slug: /tools/sdk/go/v2025/models/load-uncorrelated-accounts-task-task-attributes +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTaskAttributes', 'V2025LoadUncorrelatedAccountsTaskTaskAttributes'] +--- + +# LoadUncorrelatedAccountsTaskTaskAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**QpocJobId** | Pointer to **string** | The id of qpoc job | [optional] +**TaskStartDelay** | Pointer to **map[string]interface{}** | the task start delay value | [optional] + +## Methods + +### NewLoadUncorrelatedAccountsTaskTaskAttributes + +`func NewLoadUncorrelatedAccountsTaskTaskAttributes() *LoadUncorrelatedAccountsTaskTaskAttributes` + +NewLoadUncorrelatedAccountsTaskTaskAttributes instantiates a new LoadUncorrelatedAccountsTaskTaskAttributes 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 + +### NewLoadUncorrelatedAccountsTaskTaskAttributesWithDefaults + +`func NewLoadUncorrelatedAccountsTaskTaskAttributesWithDefaults() *LoadUncorrelatedAccountsTaskTaskAttributes` + +NewLoadUncorrelatedAccountsTaskTaskAttributesWithDefaults instantiates a new LoadUncorrelatedAccountsTaskTaskAttributes 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 + +### GetQpocJobId + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) GetQpocJobId() string` + +GetQpocJobId returns the QpocJobId field if non-nil, zero value otherwise. + +### GetQpocJobIdOk + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) GetQpocJobIdOk() (*string, bool)` + +GetQpocJobIdOk returns a tuple with the QpocJobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQpocJobId + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) SetQpocJobId(v string)` + +SetQpocJobId sets QpocJobId field to given value. + +### HasQpocJobId + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) HasQpocJobId() bool` + +HasQpocJobId returns a boolean if a field has been set. + +### GetTaskStartDelay + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) GetTaskStartDelay() map[string]interface{}` + +GetTaskStartDelay returns the TaskStartDelay field if non-nil, zero value otherwise. + +### GetTaskStartDelayOk + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) GetTaskStartDelayOk() (*map[string]interface{}, bool)` + +GetTaskStartDelayOk returns a tuple with the TaskStartDelay field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskStartDelay + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) SetTaskStartDelay(v map[string]interface{})` + +SetTaskStartDelay sets TaskStartDelay field to given value. + +### HasTaskStartDelay + +`func (o *LoadUncorrelatedAccountsTaskTaskAttributes) HasTaskStartDelay() bool` + +HasTaskStartDelay returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md b/docs/tools/sdk/go/Reference/V2025/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md new file mode 100644 index 000000000..c4ed9f4d4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md @@ -0,0 +1,168 @@ +--- +id: v2025-load-uncorrelated-accounts-task-task-messages-inner +title: LoadUncorrelatedAccountsTaskTaskMessagesInner +pagination_label: LoadUncorrelatedAccountsTaskTaskMessagesInner +sidebar_label: LoadUncorrelatedAccountsTaskTaskMessagesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LoadUncorrelatedAccountsTaskTaskMessagesInner', 'V2025LoadUncorrelatedAccountsTaskTaskMessagesInner'] +slug: /tools/sdk/go/v2025/models/load-uncorrelated-accounts-task-task-messages-inner +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTaskMessagesInner', 'V2025LoadUncorrelatedAccountsTaskTaskMessagesInner'] +--- + +# LoadUncorrelatedAccountsTaskTaskMessagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the message. | [optional] +**Error** | Pointer to **bool** | Flag whether message is an error. | [optional] [default to false] +**Warning** | Pointer to **bool** | Flag whether message is a warning. | [optional] [default to false] +**Key** | Pointer to **string** | Message string identifier. | [optional] +**LocalizedText** | Pointer to **string** | Message context with the locale based language. | [optional] + +## Methods + +### NewLoadUncorrelatedAccountsTaskTaskMessagesInner + +`func NewLoadUncorrelatedAccountsTaskTaskMessagesInner() *LoadUncorrelatedAccountsTaskTaskMessagesInner` + +NewLoadUncorrelatedAccountsTaskTaskMessagesInner instantiates a new LoadUncorrelatedAccountsTaskTaskMessagesInner 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 + +### NewLoadUncorrelatedAccountsTaskTaskMessagesInnerWithDefaults + +`func NewLoadUncorrelatedAccountsTaskTaskMessagesInnerWithDefaults() *LoadUncorrelatedAccountsTaskTaskMessagesInner` + +NewLoadUncorrelatedAccountsTaskTaskMessagesInnerWithDefaults instantiates a new LoadUncorrelatedAccountsTaskTaskMessagesInner 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 + +### GetType + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetError + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetError() bool` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetErrorOk() (*bool, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) SetError(v bool)` + +SetError sets Error field to given value. + +### HasError + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) HasError() bool` + +HasError returns a boolean if a field has been set. + +### GetWarning + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetWarning() bool` + +GetWarning returns the Warning field if non-nil, zero value otherwise. + +### GetWarningOk + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetWarningOk() (*bool, bool)` + +GetWarningOk returns a tuple with the Warning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarning + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) SetWarning(v bool)` + +SetWarning sets Warning field to given value. + +### HasWarning + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) HasWarning() bool` + +HasWarning returns a boolean if a field has been set. + +### GetKey + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetLocalizedText + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetLocalizedText() string` + +GetLocalizedText returns the LocalizedText field if non-nil, zero value otherwise. + +### GetLocalizedTextOk + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) GetLocalizedTextOk() (*string, bool)` + +GetLocalizedTextOk returns a tuple with the LocalizedText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizedText + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) SetLocalizedText(v string)` + +SetLocalizedText sets LocalizedText field to given value. + +### HasLocalizedText + +`func (o *LoadUncorrelatedAccountsTaskTaskMessagesInner) HasLocalizedText() bool` + +HasLocalizedText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LocaleOrigin.md b/docs/tools/sdk/go/Reference/V2025/Models/LocaleOrigin.md new file mode 100644 index 000000000..e0dbd88ed --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LocaleOrigin.md @@ -0,0 +1,21 @@ +--- +id: v2025-locale-origin +title: LocaleOrigin +pagination_label: LocaleOrigin +sidebar_label: LocaleOrigin +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LocaleOrigin', 'V2025LocaleOrigin'] +slug: /tools/sdk/go/v2025/models/locale-origin +tags: ['SDK', 'Software Development Kit', 'LocaleOrigin', 'V2025LocaleOrigin'] +--- + +# LocaleOrigin + +## Enum + + +* `DEFAULT` (value: `"DEFAULT"`) + +* `REQUEST` (value: `"REQUEST"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LocalizedMessage.md b/docs/tools/sdk/go/Reference/V2025/Models/LocalizedMessage.md new file mode 100644 index 000000000..6579f1107 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LocalizedMessage.md @@ -0,0 +1,80 @@ +--- +id: v2025-localized-message +title: LocalizedMessage +pagination_label: LocalizedMessage +sidebar_label: LocalizedMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LocalizedMessage', 'V2025LocalizedMessage'] +slug: /tools/sdk/go/v2025/models/localized-message +tags: ['SDK', 'Software Development Kit', 'LocalizedMessage', 'V2025LocalizedMessage'] +--- + +# LocalizedMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | **string** | Message locale | +**Message** | **string** | Message text | + +## Methods + +### NewLocalizedMessage + +`func NewLocalizedMessage(locale string, message string, ) *LocalizedMessage` + +NewLocalizedMessage instantiates a new LocalizedMessage 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 + +### NewLocalizedMessageWithDefaults + +`func NewLocalizedMessageWithDefaults() *LocalizedMessage` + +NewLocalizedMessageWithDefaults instantiates a new LocalizedMessage 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 + +### GetLocale + +`func (o *LocalizedMessage) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *LocalizedMessage) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *LocalizedMessage) SetLocale(v string)` + +SetLocale sets Locale field to given value. + + +### GetMessage + +`func (o *LocalizedMessage) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *LocalizedMessage) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *LocalizedMessage) SetMessage(v string)` + +SetMessage sets Message field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LockoutConfiguration.md b/docs/tools/sdk/go/Reference/V2025/Models/LockoutConfiguration.md new file mode 100644 index 000000000..fef6fa8fe --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LockoutConfiguration.md @@ -0,0 +1,116 @@ +--- +id: v2025-lockout-configuration +title: LockoutConfiguration +pagination_label: LockoutConfiguration +sidebar_label: LockoutConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LockoutConfiguration', 'V2025LockoutConfiguration'] +slug: /tools/sdk/go/v2025/models/lockout-configuration +tags: ['SDK', 'Software Development Kit', 'LockoutConfiguration', 'V2025LockoutConfiguration'] +--- + +# LockoutConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaximumAttempts** | Pointer to **int32** | The maximum attempts allowed before lockout occurs. | [optional] +**LockoutDuration** | Pointer to **int32** | The total time in minutes a user will be locked out. | [optional] +**LockoutWindow** | Pointer to **int32** | A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. | [optional] + +## Methods + +### NewLockoutConfiguration + +`func NewLockoutConfiguration() *LockoutConfiguration` + +NewLockoutConfiguration instantiates a new LockoutConfiguration 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 + +### NewLockoutConfigurationWithDefaults + +`func NewLockoutConfigurationWithDefaults() *LockoutConfiguration` + +NewLockoutConfigurationWithDefaults instantiates a new LockoutConfiguration 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 + +### GetMaximumAttempts + +`func (o *LockoutConfiguration) GetMaximumAttempts() int32` + +GetMaximumAttempts returns the MaximumAttempts field if non-nil, zero value otherwise. + +### GetMaximumAttemptsOk + +`func (o *LockoutConfiguration) GetMaximumAttemptsOk() (*int32, bool)` + +GetMaximumAttemptsOk returns a tuple with the MaximumAttempts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaximumAttempts + +`func (o *LockoutConfiguration) SetMaximumAttempts(v int32)` + +SetMaximumAttempts sets MaximumAttempts field to given value. + +### HasMaximumAttempts + +`func (o *LockoutConfiguration) HasMaximumAttempts() bool` + +HasMaximumAttempts returns a boolean if a field has been set. + +### GetLockoutDuration + +`func (o *LockoutConfiguration) GetLockoutDuration() int32` + +GetLockoutDuration returns the LockoutDuration field if non-nil, zero value otherwise. + +### GetLockoutDurationOk + +`func (o *LockoutConfiguration) GetLockoutDurationOk() (*int32, bool)` + +GetLockoutDurationOk returns a tuple with the LockoutDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLockoutDuration + +`func (o *LockoutConfiguration) SetLockoutDuration(v int32)` + +SetLockoutDuration sets LockoutDuration field to given value. + +### HasLockoutDuration + +`func (o *LockoutConfiguration) HasLockoutDuration() bool` + +HasLockoutDuration returns a boolean if a field has been set. + +### GetLockoutWindow + +`func (o *LockoutConfiguration) GetLockoutWindow() int32` + +GetLockoutWindow returns the LockoutWindow field if non-nil, zero value otherwise. + +### GetLockoutWindowOk + +`func (o *LockoutConfiguration) GetLockoutWindowOk() (*int32, bool)` + +GetLockoutWindowOk returns a tuple with the LockoutWindow field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLockoutWindow + +`func (o *LockoutConfiguration) SetLockoutWindow(v int32)` + +SetLockoutWindow sets LockoutWindow field to given value. + +### HasLockoutWindow + +`func (o *LockoutConfiguration) HasLockoutWindow() bool` + +HasLockoutWindow returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/LookupStep.md b/docs/tools/sdk/go/Reference/V2025/Models/LookupStep.md new file mode 100644 index 000000000..60d4b3605 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/LookupStep.md @@ -0,0 +1,116 @@ +--- +id: v2025-lookup-step +title: LookupStep +pagination_label: LookupStep +sidebar_label: LookupStep +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LookupStep', 'V2025LookupStep'] +slug: /tools/sdk/go/v2025/models/lookup-step +tags: ['SDK', 'Software Development Kit', 'LookupStep', 'V2025LookupStep'] +--- + +# LookupStep + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReassignedToId** | Pointer to **string** | The ID of the Identity who work is reassigned to | [optional] +**ReassignedFromId** | Pointer to **string** | The ID of the Identity who work is reassigned from | [optional] +**ReassignmentType** | Pointer to [**ReassignmentTypeEnum**](reassignment-type-enum) | | [optional] + +## Methods + +### NewLookupStep + +`func NewLookupStep() *LookupStep` + +NewLookupStep instantiates a new LookupStep 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 + +### NewLookupStepWithDefaults + +`func NewLookupStepWithDefaults() *LookupStep` + +NewLookupStepWithDefaults instantiates a new LookupStep 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 + +### GetReassignedToId + +`func (o *LookupStep) GetReassignedToId() string` + +GetReassignedToId returns the ReassignedToId field if non-nil, zero value otherwise. + +### GetReassignedToIdOk + +`func (o *LookupStep) GetReassignedToIdOk() (*string, bool)` + +GetReassignedToIdOk returns a tuple with the ReassignedToId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignedToId + +`func (o *LookupStep) SetReassignedToId(v string)` + +SetReassignedToId sets ReassignedToId field to given value. + +### HasReassignedToId + +`func (o *LookupStep) HasReassignedToId() bool` + +HasReassignedToId returns a boolean if a field has been set. + +### GetReassignedFromId + +`func (o *LookupStep) GetReassignedFromId() string` + +GetReassignedFromId returns the ReassignedFromId field if non-nil, zero value otherwise. + +### GetReassignedFromIdOk + +`func (o *LookupStep) GetReassignedFromIdOk() (*string, bool)` + +GetReassignedFromIdOk returns a tuple with the ReassignedFromId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignedFromId + +`func (o *LookupStep) SetReassignedFromId(v string)` + +SetReassignedFromId sets ReassignedFromId field to given value. + +### HasReassignedFromId + +`func (o *LookupStep) HasReassignedFromId() bool` + +HasReassignedFromId returns a boolean if a field has been set. + +### GetReassignmentType + +`func (o *LookupStep) GetReassignmentType() ReassignmentTypeEnum` + +GetReassignmentType returns the ReassignmentType field if non-nil, zero value otherwise. + +### GetReassignmentTypeOk + +`func (o *LookupStep) GetReassignmentTypeOk() (*ReassignmentTypeEnum, bool)` + +GetReassignmentTypeOk returns a tuple with the ReassignmentType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignmentType + +`func (o *LookupStep) SetReassignmentType(v ReassignmentTypeEnum)` + +SetReassignmentType sets ReassignmentType field to given value. + +### HasReassignmentType + +`func (o *LookupStep) HasReassignmentType() bool` + +HasReassignmentType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MachineAccount.md b/docs/tools/sdk/go/Reference/V2025/Models/MachineAccount.md new file mode 100644 index 000000000..0e3ffa0e5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MachineAccount.md @@ -0,0 +1,619 @@ +--- +id: v2025-machine-account +title: MachineAccount +pagination_label: MachineAccount +sidebar_label: MachineAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MachineAccount', 'V2025MachineAccount'] +slug: /tools/sdk/go/v2025/models/machine-account +tags: ['SDK', 'Software Development Kit', 'MachineAccount', 'V2025MachineAccount'] +--- + +# MachineAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Description** | Pointer to **NullableString** | A description of the machine account | [optional] +**NativeIdentity** | **string** | The unique ID of the machine account generated by the source system | +**Uuid** | Pointer to **NullableString** | The unique ID of the account as determined by the account schema | [optional] +**ClassificationMethod** | **string** | Classification Method | +**MachineIdentity** | Pointer to **map[string]interface{}** | The machine identity this account is associated with | [optional] +**OwnerIdentity** | Pointer to **map[string]interface{}** | The identity who owns this account. | [optional] +**AccessType** | Pointer to **string** | The connection type of the source this account is from | [optional] +**Subtype** | Pointer to **NullableString** | The sub-type | [optional] +**Environment** | Pointer to **NullableString** | Environment | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Custom attributes specific to the machine account | [optional] +**ConnectorAttributes** | **map[string]interface{}** | The connector attributes for the account | +**ManuallyCorrelated** | Pointer to **bool** | Indicates if the account has been manually correlated to an identity | [optional] [default to false] +**ManuallyEdited** | **bool** | Indicates if the account has been manually edited | [default to false] +**Locked** | **bool** | Indicates if the account is currently locked | +**Enabled** | **bool** | Indicates if the account is enabled | [default to false] +**HasEntitlements** | **bool** | Indicates if the account has entitlements | [default to true] +**Source** | **map[string]interface{}** | The source this machine account belongs to. | + +## Methods + +### NewMachineAccount + +`func NewMachineAccount(name NullableString, nativeIdentity string, classificationMethod string, connectorAttributes map[string]interface{}, manuallyEdited bool, locked bool, enabled bool, hasEntitlements bool, source map[string]interface{}, ) *MachineAccount` + +NewMachineAccount instantiates a new MachineAccount 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 + +### NewMachineAccountWithDefaults + +`func NewMachineAccountWithDefaults() *MachineAccount` + +NewMachineAccountWithDefaults instantiates a new MachineAccount 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 + +### GetId + +`func (o *MachineAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MachineAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MachineAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *MachineAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *MachineAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MachineAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MachineAccount) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *MachineAccount) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *MachineAccount) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *MachineAccount) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MachineAccount) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MachineAccount) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MachineAccount) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MachineAccount) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MachineAccount) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MachineAccount) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MachineAccount) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *MachineAccount) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *MachineAccount) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *MachineAccount) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *MachineAccount) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *MachineAccount) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *MachineAccount) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetNativeIdentity + +`func (o *MachineAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *MachineAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *MachineAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + + +### GetUuid + +`func (o *MachineAccount) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *MachineAccount) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *MachineAccount) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *MachineAccount) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *MachineAccount) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *MachineAccount) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetClassificationMethod + +`func (o *MachineAccount) GetClassificationMethod() string` + +GetClassificationMethod returns the ClassificationMethod field if non-nil, zero value otherwise. + +### GetClassificationMethodOk + +`func (o *MachineAccount) GetClassificationMethodOk() (*string, bool)` + +GetClassificationMethodOk returns a tuple with the ClassificationMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClassificationMethod + +`func (o *MachineAccount) SetClassificationMethod(v string)` + +SetClassificationMethod sets ClassificationMethod field to given value. + + +### GetMachineIdentity + +`func (o *MachineAccount) GetMachineIdentity() map[string]interface{}` + +GetMachineIdentity returns the MachineIdentity field if non-nil, zero value otherwise. + +### GetMachineIdentityOk + +`func (o *MachineAccount) GetMachineIdentityOk() (*map[string]interface{}, bool)` + +GetMachineIdentityOk returns a tuple with the MachineIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMachineIdentity + +`func (o *MachineAccount) SetMachineIdentity(v map[string]interface{})` + +SetMachineIdentity sets MachineIdentity field to given value. + +### HasMachineIdentity + +`func (o *MachineAccount) HasMachineIdentity() bool` + +HasMachineIdentity returns a boolean if a field has been set. + +### GetOwnerIdentity + +`func (o *MachineAccount) GetOwnerIdentity() map[string]interface{}` + +GetOwnerIdentity returns the OwnerIdentity field if non-nil, zero value otherwise. + +### GetOwnerIdentityOk + +`func (o *MachineAccount) GetOwnerIdentityOk() (*map[string]interface{}, bool)` + +GetOwnerIdentityOk returns a tuple with the OwnerIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerIdentity + +`func (o *MachineAccount) SetOwnerIdentity(v map[string]interface{})` + +SetOwnerIdentity sets OwnerIdentity field to given value. + +### HasOwnerIdentity + +`func (o *MachineAccount) HasOwnerIdentity() bool` + +HasOwnerIdentity returns a boolean if a field has been set. + +### SetOwnerIdentityNil + +`func (o *MachineAccount) SetOwnerIdentityNil(b bool)` + + SetOwnerIdentityNil sets the value for OwnerIdentity to be an explicit nil + +### UnsetOwnerIdentity +`func (o *MachineAccount) UnsetOwnerIdentity()` + +UnsetOwnerIdentity ensures that no value is present for OwnerIdentity, not even an explicit nil +### GetAccessType + +`func (o *MachineAccount) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *MachineAccount) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *MachineAccount) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *MachineAccount) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetSubtype + +`func (o *MachineAccount) GetSubtype() string` + +GetSubtype returns the Subtype field if non-nil, zero value otherwise. + +### GetSubtypeOk + +`func (o *MachineAccount) GetSubtypeOk() (*string, bool)` + +GetSubtypeOk returns a tuple with the Subtype field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubtype + +`func (o *MachineAccount) SetSubtype(v string)` + +SetSubtype sets Subtype field to given value. + +### HasSubtype + +`func (o *MachineAccount) HasSubtype() bool` + +HasSubtype returns a boolean if a field has been set. + +### SetSubtypeNil + +`func (o *MachineAccount) SetSubtypeNil(b bool)` + + SetSubtypeNil sets the value for Subtype to be an explicit nil + +### UnsetSubtype +`func (o *MachineAccount) UnsetSubtype()` + +UnsetSubtype ensures that no value is present for Subtype, not even an explicit nil +### GetEnvironment + +`func (o *MachineAccount) GetEnvironment() string` + +GetEnvironment returns the Environment field if non-nil, zero value otherwise. + +### GetEnvironmentOk + +`func (o *MachineAccount) GetEnvironmentOk() (*string, bool)` + +GetEnvironmentOk returns a tuple with the Environment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnvironment + +`func (o *MachineAccount) SetEnvironment(v string)` + +SetEnvironment sets Environment field to given value. + +### HasEnvironment + +`func (o *MachineAccount) HasEnvironment() bool` + +HasEnvironment returns a boolean if a field has been set. + +### SetEnvironmentNil + +`func (o *MachineAccount) SetEnvironmentNil(b bool)` + + SetEnvironmentNil sets the value for Environment to be an explicit nil + +### UnsetEnvironment +`func (o *MachineAccount) UnsetEnvironment()` + +UnsetEnvironment ensures that no value is present for Environment, not even an explicit nil +### GetAttributes + +`func (o *MachineAccount) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *MachineAccount) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *MachineAccount) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *MachineAccount) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *MachineAccount) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *MachineAccount) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetConnectorAttributes + +`func (o *MachineAccount) GetConnectorAttributes() map[string]interface{}` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *MachineAccount) GetConnectorAttributesOk() (*map[string]interface{}, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *MachineAccount) SetConnectorAttributes(v map[string]interface{})` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + + +### SetConnectorAttributesNil + +`func (o *MachineAccount) SetConnectorAttributesNil(b bool)` + + SetConnectorAttributesNil sets the value for ConnectorAttributes to be an explicit nil + +### UnsetConnectorAttributes +`func (o *MachineAccount) UnsetConnectorAttributes()` + +UnsetConnectorAttributes ensures that no value is present for ConnectorAttributes, not even an explicit nil +### GetManuallyCorrelated + +`func (o *MachineAccount) GetManuallyCorrelated() bool` + +GetManuallyCorrelated returns the ManuallyCorrelated field if non-nil, zero value otherwise. + +### GetManuallyCorrelatedOk + +`func (o *MachineAccount) GetManuallyCorrelatedOk() (*bool, bool)` + +GetManuallyCorrelatedOk returns a tuple with the ManuallyCorrelated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyCorrelated + +`func (o *MachineAccount) SetManuallyCorrelated(v bool)` + +SetManuallyCorrelated sets ManuallyCorrelated field to given value. + +### HasManuallyCorrelated + +`func (o *MachineAccount) HasManuallyCorrelated() bool` + +HasManuallyCorrelated returns a boolean if a field has been set. + +### GetManuallyEdited + +`func (o *MachineAccount) GetManuallyEdited() bool` + +GetManuallyEdited returns the ManuallyEdited field if non-nil, zero value otherwise. + +### GetManuallyEditedOk + +`func (o *MachineAccount) GetManuallyEditedOk() (*bool, bool)` + +GetManuallyEditedOk returns a tuple with the ManuallyEdited field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyEdited + +`func (o *MachineAccount) SetManuallyEdited(v bool)` + +SetManuallyEdited sets ManuallyEdited field to given value. + + +### GetLocked + +`func (o *MachineAccount) GetLocked() bool` + +GetLocked returns the Locked field if non-nil, zero value otherwise. + +### GetLockedOk + +`func (o *MachineAccount) GetLockedOk() (*bool, bool)` + +GetLockedOk returns a tuple with the Locked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocked + +`func (o *MachineAccount) SetLocked(v bool)` + +SetLocked sets Locked field to given value. + + +### GetEnabled + +`func (o *MachineAccount) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *MachineAccount) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *MachineAccount) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetHasEntitlements + +`func (o *MachineAccount) GetHasEntitlements() bool` + +GetHasEntitlements returns the HasEntitlements field if non-nil, zero value otherwise. + +### GetHasEntitlementsOk + +`func (o *MachineAccount) GetHasEntitlementsOk() (*bool, bool)` + +GetHasEntitlementsOk returns a tuple with the HasEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasEntitlements + +`func (o *MachineAccount) SetHasEntitlements(v bool)` + +SetHasEntitlements sets HasEntitlements field to given value. + + +### GetSource + +`func (o *MachineAccount) GetSource() map[string]interface{}` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *MachineAccount) GetSourceOk() (*map[string]interface{}, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *MachineAccount) SetSource(v map[string]interface{})` + +SetSource sets Source field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MachineIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/MachineIdentity.md new file mode 100644 index 000000000..90e3a8210 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MachineIdentity.md @@ -0,0 +1,246 @@ +--- +id: v2025-machine-identity +title: MachineIdentity +pagination_label: MachineIdentity +sidebar_label: MachineIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MachineIdentity', 'V2025MachineIdentity'] +slug: /tools/sdk/go/v2025/models/machine-identity +tags: ['SDK', 'Software Development Kit', 'MachineIdentity', 'V2025MachineIdentity'] +--- + +# MachineIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**BusinessApplication** | **string** | The business application that the identity represents | +**Description** | Pointer to **string** | Description of machine identity | [optional] +**ManuallyEdited** | Pointer to **bool** | Indicates if the machine identity has been manually edited | [optional] [default to false] +**Attributes** | Pointer to **map[string]interface{}** | A map of custom machine identity attributes | [optional] + +## Methods + +### NewMachineIdentity + +`func NewMachineIdentity(name NullableString, businessApplication string, ) *MachineIdentity` + +NewMachineIdentity instantiates a new MachineIdentity 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 + +### NewMachineIdentityWithDefaults + +`func NewMachineIdentityWithDefaults() *MachineIdentity` + +NewMachineIdentityWithDefaults instantiates a new MachineIdentity 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 + +### GetId + +`func (o *MachineIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MachineIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MachineIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *MachineIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *MachineIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MachineIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MachineIdentity) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *MachineIdentity) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *MachineIdentity) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *MachineIdentity) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MachineIdentity) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MachineIdentity) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MachineIdentity) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MachineIdentity) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MachineIdentity) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MachineIdentity) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MachineIdentity) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetBusinessApplication + +`func (o *MachineIdentity) GetBusinessApplication() string` + +GetBusinessApplication returns the BusinessApplication field if non-nil, zero value otherwise. + +### GetBusinessApplicationOk + +`func (o *MachineIdentity) GetBusinessApplicationOk() (*string, bool)` + +GetBusinessApplicationOk returns a tuple with the BusinessApplication field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBusinessApplication + +`func (o *MachineIdentity) SetBusinessApplication(v string)` + +SetBusinessApplication sets BusinessApplication field to given value. + + +### GetDescription + +`func (o *MachineIdentity) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *MachineIdentity) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *MachineIdentity) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *MachineIdentity) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetManuallyEdited + +`func (o *MachineIdentity) GetManuallyEdited() bool` + +GetManuallyEdited returns the ManuallyEdited field if non-nil, zero value otherwise. + +### GetManuallyEditedOk + +`func (o *MachineIdentity) GetManuallyEditedOk() (*bool, bool)` + +GetManuallyEditedOk returns a tuple with the ManuallyEdited field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyEdited + +`func (o *MachineIdentity) SetManuallyEdited(v bool)` + +SetManuallyEdited sets ManuallyEdited field to given value. + +### HasManuallyEdited + +`func (o *MachineIdentity) HasManuallyEdited() bool` + +HasManuallyEdited returns a boolean if a field has been set. + +### GetAttributes + +`func (o *MachineIdentity) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *MachineIdentity) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *MachineIdentity) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *MachineIdentity) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MailFromAttributes.md b/docs/tools/sdk/go/Reference/V2025/Models/MailFromAttributes.md new file mode 100644 index 000000000..b4def4de9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MailFromAttributes.md @@ -0,0 +1,168 @@ +--- +id: v2025-mail-from-attributes +title: MailFromAttributes +pagination_label: MailFromAttributes +sidebar_label: MailFromAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MailFromAttributes', 'V2025MailFromAttributes'] +slug: /tools/sdk/go/v2025/models/mail-from-attributes +tags: ['SDK', 'Software Development Kit', 'MailFromAttributes', 'V2025MailFromAttributes'] +--- + +# MailFromAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to **string** | The email identity | [optional] +**MailFromDomain** | Pointer to **string** | The name of a domain that an email identity uses as a custom MAIL FROM domain | [optional] +**MxRecord** | Pointer to **string** | MX record that is required in customer's DNS to allow the domain to receive bounce and complaint notifications that email providers send you | [optional] +**TxtRecord** | Pointer to **string** | TXT record that is required in customer's DNS in order to prove that Amazon SES is authorized to send email from your domain | [optional] +**MailFromDomainStatus** | Pointer to **string** | The current status of the MAIL FROM verification | [optional] + +## Methods + +### NewMailFromAttributes + +`func NewMailFromAttributes() *MailFromAttributes` + +NewMailFromAttributes instantiates a new MailFromAttributes 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 + +### NewMailFromAttributesWithDefaults + +`func NewMailFromAttributesWithDefaults() *MailFromAttributes` + +NewMailFromAttributesWithDefaults instantiates a new MailFromAttributes 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 + +### GetIdentity + +`func (o *MailFromAttributes) GetIdentity() string` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *MailFromAttributes) GetIdentityOk() (*string, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *MailFromAttributes) SetIdentity(v string)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *MailFromAttributes) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetMailFromDomain + +`func (o *MailFromAttributes) GetMailFromDomain() string` + +GetMailFromDomain returns the MailFromDomain field if non-nil, zero value otherwise. + +### GetMailFromDomainOk + +`func (o *MailFromAttributes) GetMailFromDomainOk() (*string, bool)` + +GetMailFromDomainOk returns a tuple with the MailFromDomain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMailFromDomain + +`func (o *MailFromAttributes) SetMailFromDomain(v string)` + +SetMailFromDomain sets MailFromDomain field to given value. + +### HasMailFromDomain + +`func (o *MailFromAttributes) HasMailFromDomain() bool` + +HasMailFromDomain returns a boolean if a field has been set. + +### GetMxRecord + +`func (o *MailFromAttributes) GetMxRecord() string` + +GetMxRecord returns the MxRecord field if non-nil, zero value otherwise. + +### GetMxRecordOk + +`func (o *MailFromAttributes) GetMxRecordOk() (*string, bool)` + +GetMxRecordOk returns a tuple with the MxRecord field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMxRecord + +`func (o *MailFromAttributes) SetMxRecord(v string)` + +SetMxRecord sets MxRecord field to given value. + +### HasMxRecord + +`func (o *MailFromAttributes) HasMxRecord() bool` + +HasMxRecord returns a boolean if a field has been set. + +### GetTxtRecord + +`func (o *MailFromAttributes) GetTxtRecord() string` + +GetTxtRecord returns the TxtRecord field if non-nil, zero value otherwise. + +### GetTxtRecordOk + +`func (o *MailFromAttributes) GetTxtRecordOk() (*string, bool)` + +GetTxtRecordOk returns a tuple with the TxtRecord field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTxtRecord + +`func (o *MailFromAttributes) SetTxtRecord(v string)` + +SetTxtRecord sets TxtRecord field to given value. + +### HasTxtRecord + +`func (o *MailFromAttributes) HasTxtRecord() bool` + +HasTxtRecord returns a boolean if a field has been set. + +### GetMailFromDomainStatus + +`func (o *MailFromAttributes) GetMailFromDomainStatus() string` + +GetMailFromDomainStatus returns the MailFromDomainStatus field if non-nil, zero value otherwise. + +### GetMailFromDomainStatusOk + +`func (o *MailFromAttributes) GetMailFromDomainStatusOk() (*string, bool)` + +GetMailFromDomainStatusOk returns a tuple with the MailFromDomainStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMailFromDomainStatus + +`func (o *MailFromAttributes) SetMailFromDomainStatus(v string)` + +SetMailFromDomainStatus sets MailFromDomainStatus field to given value. + +### HasMailFromDomainStatus + +`func (o *MailFromAttributes) HasMailFromDomainStatus() bool` + +HasMailFromDomainStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MailFromAttributesDto.md b/docs/tools/sdk/go/Reference/V2025/Models/MailFromAttributesDto.md new file mode 100644 index 000000000..529400fe9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MailFromAttributesDto.md @@ -0,0 +1,90 @@ +--- +id: v2025-mail-from-attributes-dto +title: MailFromAttributesDto +pagination_label: MailFromAttributesDto +sidebar_label: MailFromAttributesDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MailFromAttributesDto', 'V2025MailFromAttributesDto'] +slug: /tools/sdk/go/v2025/models/mail-from-attributes-dto +tags: ['SDK', 'Software Development Kit', 'MailFromAttributesDto', 'V2025MailFromAttributesDto'] +--- + +# MailFromAttributesDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to **string** | The identity or domain address | [optional] +**MailFromDomain** | Pointer to **string** | The new MAIL FROM domain of the identity. Must be a subdomain of the identity. | [optional] + +## Methods + +### NewMailFromAttributesDto + +`func NewMailFromAttributesDto() *MailFromAttributesDto` + +NewMailFromAttributesDto instantiates a new MailFromAttributesDto 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 + +### NewMailFromAttributesDtoWithDefaults + +`func NewMailFromAttributesDtoWithDefaults() *MailFromAttributesDto` + +NewMailFromAttributesDtoWithDefaults instantiates a new MailFromAttributesDto 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 + +### GetIdentity + +`func (o *MailFromAttributesDto) GetIdentity() string` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *MailFromAttributesDto) GetIdentityOk() (*string, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *MailFromAttributesDto) SetIdentity(v string)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *MailFromAttributesDto) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetMailFromDomain + +`func (o *MailFromAttributesDto) GetMailFromDomain() string` + +GetMailFromDomain returns the MailFromDomain field if non-nil, zero value otherwise. + +### GetMailFromDomainOk + +`func (o *MailFromAttributesDto) GetMailFromDomainOk() (*string, bool)` + +GetMailFromDomainOk returns a tuple with the MailFromDomain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMailFromDomain + +`func (o *MailFromAttributesDto) SetMailFromDomain(v string)` + +SetMailFromDomain sets MailFromDomain field to given value. + +### HasMailFromDomain + +`func (o *MailFromAttributesDto) HasMailFromDomain() bool` + +HasMailFromDomain returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManagedClient.md b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClient.md new file mode 100644 index 000000000..e68beef6a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClient.md @@ -0,0 +1,734 @@ +--- +id: v2025-managed-client +title: ManagedClient +pagination_label: ManagedClient +sidebar_label: ManagedClient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClient', 'V2025ManagedClient'] +slug: /tools/sdk/go/v2025/models/managed-client +tags: ['SDK', 'Software Development Kit', 'ManagedClient', 'V2025ManagedClient'] +--- + +# ManagedClient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | ManagedClient ID | [optional] [readonly] +**AlertKey** | Pointer to **NullableString** | ManagedClient alert key | [optional] [readonly] +**ApiGatewayBaseUrl** | Pointer to **NullableString** | | [optional] +**Cookbook** | Pointer to **NullableString** | | [optional] +**CcId** | Pointer to **NullableInt64** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] +**ClientId** | **string** | The client ID used in API management | +**ClusterId** | **string** | Cluster ID that the ManagedClient is linked to | +**Description** | **string** | ManagedClient description | [default to ""] +**IpAddress** | Pointer to **NullableString** | The public IP address of the ManagedClient | [optional] [readonly] +**LastSeen** | Pointer to **NullableTime** | When the ManagedClient was last seen by the server | [optional] [readonly] +**Name** | Pointer to **NullableString** | ManagedClient name | [optional] [default to "VA-$clientId"] +**SinceLastSeen** | Pointer to **NullableString** | Milliseconds since the ManagedClient has polled the server | [optional] [readonly] +**Status** | Pointer to **NullableString** | Status of the ManagedClient | [optional] [readonly] +**Type** | **string** | Type of the ManagedClient (VA, CCG) | +**ClusterType** | Pointer to **NullableString** | Cluster Type of the ManagedClient | [optional] [readonly] +**VaDownloadUrl** | Pointer to **NullableString** | ManagedClient VA download URL | [optional] [readonly] +**VaVersion** | Pointer to **NullableString** | Version that the ManagedClient's VA is running | [optional] [readonly] +**Secret** | Pointer to **NullableString** | Client's apiKey | [optional] +**CreatedAt** | Pointer to **NullableTime** | The date/time this ManagedClient was created | [optional] +**UpdatedAt** | Pointer to **NullableTime** | The date/time this ManagedClient was last updated | [optional] +**ProvisionStatus** | Pointer to **NullableString** | The provisioning status of the ManagedClient | [optional] [readonly] + +## Methods + +### NewManagedClient + +`func NewManagedClient(clientId string, clusterId string, description string, type_ string, ) *ManagedClient` + +NewManagedClient instantiates a new ManagedClient 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 + +### NewManagedClientWithDefaults + +`func NewManagedClientWithDefaults() *ManagedClient` + +NewManagedClientWithDefaults instantiates a new ManagedClient 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 + +### GetId + +`func (o *ManagedClient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManagedClient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManagedClient) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ManagedClient) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *ManagedClient) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *ManagedClient) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetAlertKey + +`func (o *ManagedClient) GetAlertKey() string` + +GetAlertKey returns the AlertKey field if non-nil, zero value otherwise. + +### GetAlertKeyOk + +`func (o *ManagedClient) GetAlertKeyOk() (*string, bool)` + +GetAlertKeyOk returns a tuple with the AlertKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertKey + +`func (o *ManagedClient) SetAlertKey(v string)` + +SetAlertKey sets AlertKey field to given value. + +### HasAlertKey + +`func (o *ManagedClient) HasAlertKey() bool` + +HasAlertKey returns a boolean if a field has been set. + +### SetAlertKeyNil + +`func (o *ManagedClient) SetAlertKeyNil(b bool)` + + SetAlertKeyNil sets the value for AlertKey to be an explicit nil + +### UnsetAlertKey +`func (o *ManagedClient) UnsetAlertKey()` + +UnsetAlertKey ensures that no value is present for AlertKey, not even an explicit nil +### GetApiGatewayBaseUrl + +`func (o *ManagedClient) GetApiGatewayBaseUrl() string` + +GetApiGatewayBaseUrl returns the ApiGatewayBaseUrl field if non-nil, zero value otherwise. + +### GetApiGatewayBaseUrlOk + +`func (o *ManagedClient) GetApiGatewayBaseUrlOk() (*string, bool)` + +GetApiGatewayBaseUrlOk returns a tuple with the ApiGatewayBaseUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiGatewayBaseUrl + +`func (o *ManagedClient) SetApiGatewayBaseUrl(v string)` + +SetApiGatewayBaseUrl sets ApiGatewayBaseUrl field to given value. + +### HasApiGatewayBaseUrl + +`func (o *ManagedClient) HasApiGatewayBaseUrl() bool` + +HasApiGatewayBaseUrl returns a boolean if a field has been set. + +### SetApiGatewayBaseUrlNil + +`func (o *ManagedClient) SetApiGatewayBaseUrlNil(b bool)` + + SetApiGatewayBaseUrlNil sets the value for ApiGatewayBaseUrl to be an explicit nil + +### UnsetApiGatewayBaseUrl +`func (o *ManagedClient) UnsetApiGatewayBaseUrl()` + +UnsetApiGatewayBaseUrl ensures that no value is present for ApiGatewayBaseUrl, not even an explicit nil +### GetCookbook + +`func (o *ManagedClient) GetCookbook() string` + +GetCookbook returns the Cookbook field if non-nil, zero value otherwise. + +### GetCookbookOk + +`func (o *ManagedClient) GetCookbookOk() (*string, bool)` + +GetCookbookOk returns a tuple with the Cookbook field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCookbook + +`func (o *ManagedClient) SetCookbook(v string)` + +SetCookbook sets Cookbook field to given value. + +### HasCookbook + +`func (o *ManagedClient) HasCookbook() bool` + +HasCookbook returns a boolean if a field has been set. + +### SetCookbookNil + +`func (o *ManagedClient) SetCookbookNil(b bool)` + + SetCookbookNil sets the value for Cookbook to be an explicit nil + +### UnsetCookbook +`func (o *ManagedClient) UnsetCookbook()` + +UnsetCookbook ensures that no value is present for Cookbook, not even an explicit nil +### GetCcId + +`func (o *ManagedClient) GetCcId() int64` + +GetCcId returns the CcId field if non-nil, zero value otherwise. + +### GetCcIdOk + +`func (o *ManagedClient) GetCcIdOk() (*int64, bool)` + +GetCcIdOk returns a tuple with the CcId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCcId + +`func (o *ManagedClient) SetCcId(v int64)` + +SetCcId sets CcId field to given value. + +### HasCcId + +`func (o *ManagedClient) HasCcId() bool` + +HasCcId returns a boolean if a field has been set. + +### SetCcIdNil + +`func (o *ManagedClient) SetCcIdNil(b bool)` + + SetCcIdNil sets the value for CcId to be an explicit nil + +### UnsetCcId +`func (o *ManagedClient) UnsetCcId()` + +UnsetCcId ensures that no value is present for CcId, not even an explicit nil +### GetClientId + +`func (o *ManagedClient) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ManagedClient) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ManagedClient) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + + +### GetClusterId + +`func (o *ManagedClient) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *ManagedClient) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *ManagedClient) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + + +### GetDescription + +`func (o *ManagedClient) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManagedClient) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManagedClient) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetIpAddress + +`func (o *ManagedClient) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *ManagedClient) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *ManagedClient) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + +### HasIpAddress + +`func (o *ManagedClient) HasIpAddress() bool` + +HasIpAddress returns a boolean if a field has been set. + +### SetIpAddressNil + +`func (o *ManagedClient) SetIpAddressNil(b bool)` + + SetIpAddressNil sets the value for IpAddress to be an explicit nil + +### UnsetIpAddress +`func (o *ManagedClient) UnsetIpAddress()` + +UnsetIpAddress ensures that no value is present for IpAddress, not even an explicit nil +### GetLastSeen + +`func (o *ManagedClient) GetLastSeen() SailPointTime` + +GetLastSeen returns the LastSeen field if non-nil, zero value otherwise. + +### GetLastSeenOk + +`func (o *ManagedClient) GetLastSeenOk() (*SailPointTime, bool)` + +GetLastSeenOk returns a tuple with the LastSeen field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastSeen + +`func (o *ManagedClient) SetLastSeen(v SailPointTime)` + +SetLastSeen sets LastSeen field to given value. + +### HasLastSeen + +`func (o *ManagedClient) HasLastSeen() bool` + +HasLastSeen returns a boolean if a field has been set. + +### SetLastSeenNil + +`func (o *ManagedClient) SetLastSeenNil(b bool)` + + SetLastSeenNil sets the value for LastSeen to be an explicit nil + +### UnsetLastSeen +`func (o *ManagedClient) UnsetLastSeen()` + +UnsetLastSeen ensures that no value is present for LastSeen, not even an explicit nil +### GetName + +`func (o *ManagedClient) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedClient) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedClient) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManagedClient) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ManagedClient) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ManagedClient) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetSinceLastSeen + +`func (o *ManagedClient) GetSinceLastSeen() string` + +GetSinceLastSeen returns the SinceLastSeen field if non-nil, zero value otherwise. + +### GetSinceLastSeenOk + +`func (o *ManagedClient) GetSinceLastSeenOk() (*string, bool)` + +GetSinceLastSeenOk returns a tuple with the SinceLastSeen field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSinceLastSeen + +`func (o *ManagedClient) SetSinceLastSeen(v string)` + +SetSinceLastSeen sets SinceLastSeen field to given value. + +### HasSinceLastSeen + +`func (o *ManagedClient) HasSinceLastSeen() bool` + +HasSinceLastSeen returns a boolean if a field has been set. + +### SetSinceLastSeenNil + +`func (o *ManagedClient) SetSinceLastSeenNil(b bool)` + + SetSinceLastSeenNil sets the value for SinceLastSeen to be an explicit nil + +### UnsetSinceLastSeen +`func (o *ManagedClient) UnsetSinceLastSeen()` + +UnsetSinceLastSeen ensures that no value is present for SinceLastSeen, not even an explicit nil +### GetStatus + +`func (o *ManagedClient) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManagedClient) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManagedClient) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ManagedClient) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatusNil + +`func (o *ManagedClient) SetStatusNil(b bool)` + + SetStatusNil sets the value for Status to be an explicit nil + +### UnsetStatus +`func (o *ManagedClient) UnsetStatus()` + +UnsetStatus ensures that no value is present for Status, not even an explicit nil +### GetType + +`func (o *ManagedClient) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClient) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClient) SetType(v string)` + +SetType sets Type field to given value. + + +### GetClusterType + +`func (o *ManagedClient) GetClusterType() string` + +GetClusterType returns the ClusterType field if non-nil, zero value otherwise. + +### GetClusterTypeOk + +`func (o *ManagedClient) GetClusterTypeOk() (*string, bool)` + +GetClusterTypeOk returns a tuple with the ClusterType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterType + +`func (o *ManagedClient) SetClusterType(v string)` + +SetClusterType sets ClusterType field to given value. + +### HasClusterType + +`func (o *ManagedClient) HasClusterType() bool` + +HasClusterType returns a boolean if a field has been set. + +### SetClusterTypeNil + +`func (o *ManagedClient) SetClusterTypeNil(b bool)` + + SetClusterTypeNil sets the value for ClusterType to be an explicit nil + +### UnsetClusterType +`func (o *ManagedClient) UnsetClusterType()` + +UnsetClusterType ensures that no value is present for ClusterType, not even an explicit nil +### GetVaDownloadUrl + +`func (o *ManagedClient) GetVaDownloadUrl() string` + +GetVaDownloadUrl returns the VaDownloadUrl field if non-nil, zero value otherwise. + +### GetVaDownloadUrlOk + +`func (o *ManagedClient) GetVaDownloadUrlOk() (*string, bool)` + +GetVaDownloadUrlOk returns a tuple with the VaDownloadUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVaDownloadUrl + +`func (o *ManagedClient) SetVaDownloadUrl(v string)` + +SetVaDownloadUrl sets VaDownloadUrl field to given value. + +### HasVaDownloadUrl + +`func (o *ManagedClient) HasVaDownloadUrl() bool` + +HasVaDownloadUrl returns a boolean if a field has been set. + +### SetVaDownloadUrlNil + +`func (o *ManagedClient) SetVaDownloadUrlNil(b bool)` + + SetVaDownloadUrlNil sets the value for VaDownloadUrl to be an explicit nil + +### UnsetVaDownloadUrl +`func (o *ManagedClient) UnsetVaDownloadUrl()` + +UnsetVaDownloadUrl ensures that no value is present for VaDownloadUrl, not even an explicit nil +### GetVaVersion + +`func (o *ManagedClient) GetVaVersion() string` + +GetVaVersion returns the VaVersion field if non-nil, zero value otherwise. + +### GetVaVersionOk + +`func (o *ManagedClient) GetVaVersionOk() (*string, bool)` + +GetVaVersionOk returns a tuple with the VaVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVaVersion + +`func (o *ManagedClient) SetVaVersion(v string)` + +SetVaVersion sets VaVersion field to given value. + +### HasVaVersion + +`func (o *ManagedClient) HasVaVersion() bool` + +HasVaVersion returns a boolean if a field has been set. + +### SetVaVersionNil + +`func (o *ManagedClient) SetVaVersionNil(b bool)` + + SetVaVersionNil sets the value for VaVersion to be an explicit nil + +### UnsetVaVersion +`func (o *ManagedClient) UnsetVaVersion()` + +UnsetVaVersion ensures that no value is present for VaVersion, not even an explicit nil +### GetSecret + +`func (o *ManagedClient) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *ManagedClient) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *ManagedClient) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *ManagedClient) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### SetSecretNil + +`func (o *ManagedClient) SetSecretNil(b bool)` + + SetSecretNil sets the value for Secret to be an explicit nil + +### UnsetSecret +`func (o *ManagedClient) UnsetSecret()` + +UnsetSecret ensures that no value is present for Secret, not even an explicit nil +### GetCreatedAt + +`func (o *ManagedClient) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *ManagedClient) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *ManagedClient) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *ManagedClient) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### SetCreatedAtNil + +`func (o *ManagedClient) SetCreatedAtNil(b bool)` + + SetCreatedAtNil sets the value for CreatedAt to be an explicit nil + +### UnsetCreatedAt +`func (o *ManagedClient) UnsetCreatedAt()` + +UnsetCreatedAt ensures that no value is present for CreatedAt, not even an explicit nil +### GetUpdatedAt + +`func (o *ManagedClient) GetUpdatedAt() SailPointTime` + +GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise. + +### GetUpdatedAtOk + +`func (o *ManagedClient) GetUpdatedAtOk() (*SailPointTime, bool)` + +GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedAt + +`func (o *ManagedClient) SetUpdatedAt(v SailPointTime)` + +SetUpdatedAt sets UpdatedAt field to given value. + +### HasUpdatedAt + +`func (o *ManagedClient) HasUpdatedAt() bool` + +HasUpdatedAt returns a boolean if a field has been set. + +### SetUpdatedAtNil + +`func (o *ManagedClient) SetUpdatedAtNil(b bool)` + + SetUpdatedAtNil sets the value for UpdatedAt to be an explicit nil + +### UnsetUpdatedAt +`func (o *ManagedClient) UnsetUpdatedAt()` + +UnsetUpdatedAt ensures that no value is present for UpdatedAt, not even an explicit nil +### GetProvisionStatus + +`func (o *ManagedClient) GetProvisionStatus() string` + +GetProvisionStatus returns the ProvisionStatus field if non-nil, zero value otherwise. + +### GetProvisionStatusOk + +`func (o *ManagedClient) GetProvisionStatusOk() (*string, bool)` + +GetProvisionStatusOk returns a tuple with the ProvisionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionStatus + +`func (o *ManagedClient) SetProvisionStatus(v string)` + +SetProvisionStatus sets ProvisionStatus field to given value. + +### HasProvisionStatus + +`func (o *ManagedClient) HasProvisionStatus() bool` + +HasProvisionStatus returns a boolean if a field has been set. + +### SetProvisionStatusNil + +`func (o *ManagedClient) SetProvisionStatusNil(b bool)` + + SetProvisionStatusNil sets the value for ProvisionStatus to be an explicit nil + +### UnsetProvisionStatus +`func (o *ManagedClient) UnsetProvisionStatus()` + +UnsetProvisionStatus ensures that no value is present for ProvisionStatus, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManagedClientRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClientRequest.md new file mode 100644 index 000000000..ea4902fd3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClientRequest.md @@ -0,0 +1,167 @@ +--- +id: v2025-managed-client-request +title: ManagedClientRequest +pagination_label: ManagedClientRequest +sidebar_label: ManagedClientRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClientRequest', 'V2025ManagedClientRequest'] +slug: /tools/sdk/go/v2025/models/managed-client-request +tags: ['SDK', 'Software Development Kit', 'ManagedClientRequest', 'V2025ManagedClientRequest'] +--- + +# ManagedClientRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterId** | **string** | Cluster ID that the ManagedClient is linked to | +**Description** | Pointer to **NullableString** | description for the ManagedClient to create | [optional] +**Name** | Pointer to **NullableString** | name for the ManagedClient to create | [optional] +**Type** | Pointer to **NullableString** | Type of the ManagedClient (VA, CCG) to create | [optional] + +## Methods + +### NewManagedClientRequest + +`func NewManagedClientRequest(clusterId string, ) *ManagedClientRequest` + +NewManagedClientRequest instantiates a new ManagedClientRequest 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 + +### NewManagedClientRequestWithDefaults + +`func NewManagedClientRequestWithDefaults() *ManagedClientRequest` + +NewManagedClientRequestWithDefaults instantiates a new ManagedClientRequest 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 + +### GetClusterId + +`func (o *ManagedClientRequest) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *ManagedClientRequest) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *ManagedClientRequest) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + + +### GetDescription + +`func (o *ManagedClientRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManagedClientRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManagedClientRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ManagedClientRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ManagedClientRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ManagedClientRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetName + +`func (o *ManagedClientRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedClientRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedClientRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManagedClientRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ManagedClientRequest) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ManagedClientRequest) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetType + +`func (o *ManagedClientRequest) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClientRequest) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClientRequest) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManagedClientRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *ManagedClientRequest) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *ManagedClientRequest) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManagedClientStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClientStatus.md new file mode 100644 index 000000000..5a7398a82 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClientStatus.md @@ -0,0 +1,132 @@ +--- +id: v2025-managed-client-status +title: ManagedClientStatus +pagination_label: ManagedClientStatus +sidebar_label: ManagedClientStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClientStatus', 'V2025ManagedClientStatus'] +slug: /tools/sdk/go/v2025/models/managed-client-status +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatus', 'V2025ManagedClientStatus'] +--- + +# ManagedClientStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Body** | **map[string]interface{}** | ManagedClientStatus body information | +**Status** | [**ManagedClientStatusCode**](managed-client-status-code) | | +**Type** | [**NullableManagedClientType**](managed-client-type) | | +**Timestamp** | **SailPointTime** | timestamp on the Client Status update | + +## Methods + +### NewManagedClientStatus + +`func NewManagedClientStatus(body map[string]interface{}, status ManagedClientStatusCode, type_ NullableManagedClientType, timestamp SailPointTime, ) *ManagedClientStatus` + +NewManagedClientStatus instantiates a new ManagedClientStatus 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 + +### NewManagedClientStatusWithDefaults + +`func NewManagedClientStatusWithDefaults() *ManagedClientStatus` + +NewManagedClientStatusWithDefaults instantiates a new ManagedClientStatus 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 + +### GetBody + +`func (o *ManagedClientStatus) GetBody() map[string]interface{}` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *ManagedClientStatus) GetBodyOk() (*map[string]interface{}, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBody + +`func (o *ManagedClientStatus) SetBody(v map[string]interface{})` + +SetBody sets Body field to given value. + + +### GetStatus + +`func (o *ManagedClientStatus) GetStatus() ManagedClientStatusCode` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManagedClientStatus) GetStatusOk() (*ManagedClientStatusCode, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManagedClientStatus) SetStatus(v ManagedClientStatusCode)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *ManagedClientStatus) GetType() ManagedClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClientStatus) GetTypeOk() (*ManagedClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClientStatus) SetType(v ManagedClientType)` + +SetType sets Type field to given value. + + +### SetTypeNil + +`func (o *ManagedClientStatus) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *ManagedClientStatus) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetTimestamp + +`func (o *ManagedClientStatus) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *ManagedClientStatus) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *ManagedClientStatus) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManagedClientStatusCode.md b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClientStatusCode.md new file mode 100644 index 000000000..01c8c6128 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClientStatusCode.md @@ -0,0 +1,31 @@ +--- +id: v2025-managed-client-status-code +title: ManagedClientStatusCode +pagination_label: ManagedClientStatusCode +sidebar_label: ManagedClientStatusCode +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClientStatusCode', 'V2025ManagedClientStatusCode'] +slug: /tools/sdk/go/v2025/models/managed-client-status-code +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatusCode', 'V2025ManagedClientStatusCode'] +--- + +# ManagedClientStatusCode + +## Enum + + +* `NORMAL` (value: `"NORMAL"`) + +* `UNDEFINED` (value: `"UNDEFINED"`) + +* `NOT_CONFIGURED` (value: `"NOT_CONFIGURED"`) + +* `CONFIGURING` (value: `"CONFIGURING"`) + +* `WARNING` (value: `"WARNING"`) + +* `ERROR` (value: `"ERROR"`) + +* `FAILED` (value: `"FAILED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManagedClientType.md b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClientType.md new file mode 100644 index 000000000..ff73fdb62 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClientType.md @@ -0,0 +1,25 @@ +--- +id: v2025-managed-client-type +title: ManagedClientType +pagination_label: ManagedClientType +sidebar_label: ManagedClientType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClientType', 'V2025ManagedClientType'] +slug: /tools/sdk/go/v2025/models/managed-client-type +tags: ['SDK', 'Software Development Kit', 'ManagedClientType', 'V2025ManagedClientType'] +--- + +# ManagedClientType + +## Enum + + +* `CCG` (value: `"CCG"`) + +* `VA` (value: `"VA"`) + +* `INTERNAL` (value: `"INTERNAL"`) + +* `IIQ_HARVESTER` (value: `"IIQ_HARVESTER"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManagedCluster.md b/docs/tools/sdk/go/Reference/V2025/Models/ManagedCluster.md new file mode 100644 index 000000000..db350de70 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManagedCluster.md @@ -0,0 +1,743 @@ +--- +id: v2025-managed-cluster +title: ManagedCluster +pagination_label: ManagedCluster +sidebar_label: ManagedCluster +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedCluster', 'V2025ManagedCluster'] +slug: /tools/sdk/go/v2025/models/managed-cluster +tags: ['SDK', 'Software Development Kit', 'ManagedCluster', 'V2025ManagedCluster'] +--- + +# ManagedCluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ManagedCluster ID | +**Name** | Pointer to **string** | ManagedCluster name | [optional] +**Pod** | Pointer to **string** | ManagedCluster pod | [optional] +**Org** | Pointer to **string** | ManagedCluster org | [optional] +**Type** | Pointer to [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**Configuration** | Pointer to **map[string]string** | ManagedProcess configuration map | [optional] +**KeyPair** | Pointer to [**ManagedClusterKeyPair**](managed-cluster-key-pair) | | [optional] +**Attributes** | Pointer to [**ManagedClusterAttributes**](managed-cluster-attributes) | | [optional] +**Description** | Pointer to **string** | ManagedCluster description | [optional] [default to "q"] +**Redis** | Pointer to [**ManagedClusterRedis**](managed-cluster-redis) | | [optional] +**ClientType** | [**NullableManagedClientType**](managed-client-type) | | +**CcgVersion** | **string** | CCG version used by the ManagedCluster | +**PinnedConfig** | Pointer to **bool** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to false] +**LogConfiguration** | Pointer to [**NullableClientLogConfiguration**](client-log-configuration) | | [optional] +**Operational** | Pointer to **bool** | Whether or not the cluster is operational or not | [optional] [default to false] +**Status** | Pointer to **string** | Cluster status | [optional] +**PublicKeyCertificate** | Pointer to **NullableString** | Public key certificate | [optional] +**PublicKeyThumbprint** | Pointer to **NullableString** | Public key thumbprint | [optional] +**PublicKey** | Pointer to **NullableString** | Public key | [optional] +**AlertKey** | Pointer to **string** | Key describing any immediate cluster alerts | [optional] +**ClientIds** | Pointer to **[]string** | List of clients in a cluster | [optional] +**ServiceCount** | Pointer to **int32** | Number of services bound to a cluster | [optional] [default to 0] +**CcId** | Pointer to **string** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to "0"] +**CreatedAt** | Pointer to **NullableTime** | The date/time this cluster was created | [optional] +**UpdatedAt** | Pointer to **NullableTime** | The date/time this cluster was last updated | [optional] + +## Methods + +### NewManagedCluster + +`func NewManagedCluster(id string, clientType NullableManagedClientType, ccgVersion string, ) *ManagedCluster` + +NewManagedCluster instantiates a new ManagedCluster 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 + +### NewManagedClusterWithDefaults + +`func NewManagedClusterWithDefaults() *ManagedCluster` + +NewManagedClusterWithDefaults instantiates a new ManagedCluster 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 + +### GetId + +`func (o *ManagedCluster) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManagedCluster) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManagedCluster) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *ManagedCluster) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedCluster) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedCluster) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManagedCluster) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPod + +`func (o *ManagedCluster) GetPod() string` + +GetPod returns the Pod field if non-nil, zero value otherwise. + +### GetPodOk + +`func (o *ManagedCluster) GetPodOk() (*string, bool)` + +GetPodOk returns a tuple with the Pod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPod + +`func (o *ManagedCluster) SetPod(v string)` + +SetPod sets Pod field to given value. + +### HasPod + +`func (o *ManagedCluster) HasPod() bool` + +HasPod returns a boolean if a field has been set. + +### GetOrg + +`func (o *ManagedCluster) GetOrg() string` + +GetOrg returns the Org field if non-nil, zero value otherwise. + +### GetOrgOk + +`func (o *ManagedCluster) GetOrgOk() (*string, bool)` + +GetOrgOk returns a tuple with the Org field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrg + +`func (o *ManagedCluster) SetOrg(v string)` + +SetOrg sets Org field to given value. + +### HasOrg + +`func (o *ManagedCluster) HasOrg() bool` + +HasOrg returns a boolean if a field has been set. + +### GetType + +`func (o *ManagedCluster) GetType() ManagedClusterTypes` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedCluster) GetTypeOk() (*ManagedClusterTypes, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedCluster) SetType(v ManagedClusterTypes)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManagedCluster) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConfiguration + +`func (o *ManagedCluster) GetConfiguration() map[string]string` + +GetConfiguration returns the Configuration field if non-nil, zero value otherwise. + +### GetConfigurationOk + +`func (o *ManagedCluster) GetConfigurationOk() (*map[string]string, bool)` + +GetConfigurationOk returns a tuple with the Configuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfiguration + +`func (o *ManagedCluster) SetConfiguration(v map[string]string)` + +SetConfiguration sets Configuration field to given value. + +### HasConfiguration + +`func (o *ManagedCluster) HasConfiguration() bool` + +HasConfiguration returns a boolean if a field has been set. + +### GetKeyPair + +`func (o *ManagedCluster) GetKeyPair() ManagedClusterKeyPair` + +GetKeyPair returns the KeyPair field if non-nil, zero value otherwise. + +### GetKeyPairOk + +`func (o *ManagedCluster) GetKeyPairOk() (*ManagedClusterKeyPair, bool)` + +GetKeyPairOk returns a tuple with the KeyPair field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKeyPair + +`func (o *ManagedCluster) SetKeyPair(v ManagedClusterKeyPair)` + +SetKeyPair sets KeyPair field to given value. + +### HasKeyPair + +`func (o *ManagedCluster) HasKeyPair() bool` + +HasKeyPair returns a boolean if a field has been set. + +### GetAttributes + +`func (o *ManagedCluster) GetAttributes() ManagedClusterAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ManagedCluster) GetAttributesOk() (*ManagedClusterAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ManagedCluster) SetAttributes(v ManagedClusterAttributes)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ManagedCluster) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetDescription + +`func (o *ManagedCluster) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManagedCluster) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManagedCluster) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ManagedCluster) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetRedis + +`func (o *ManagedCluster) GetRedis() ManagedClusterRedis` + +GetRedis returns the Redis field if non-nil, zero value otherwise. + +### GetRedisOk + +`func (o *ManagedCluster) GetRedisOk() (*ManagedClusterRedis, bool)` + +GetRedisOk returns a tuple with the Redis field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedis + +`func (o *ManagedCluster) SetRedis(v ManagedClusterRedis)` + +SetRedis sets Redis field to given value. + +### HasRedis + +`func (o *ManagedCluster) HasRedis() bool` + +HasRedis returns a boolean if a field has been set. + +### GetClientType + +`func (o *ManagedCluster) GetClientType() ManagedClientType` + +GetClientType returns the ClientType field if non-nil, zero value otherwise. + +### GetClientTypeOk + +`func (o *ManagedCluster) GetClientTypeOk() (*ManagedClientType, bool)` + +GetClientTypeOk returns a tuple with the ClientType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientType + +`func (o *ManagedCluster) SetClientType(v ManagedClientType)` + +SetClientType sets ClientType field to given value. + + +### SetClientTypeNil + +`func (o *ManagedCluster) SetClientTypeNil(b bool)` + + SetClientTypeNil sets the value for ClientType to be an explicit nil + +### UnsetClientType +`func (o *ManagedCluster) UnsetClientType()` + +UnsetClientType ensures that no value is present for ClientType, not even an explicit nil +### GetCcgVersion + +`func (o *ManagedCluster) GetCcgVersion() string` + +GetCcgVersion returns the CcgVersion field if non-nil, zero value otherwise. + +### GetCcgVersionOk + +`func (o *ManagedCluster) GetCcgVersionOk() (*string, bool)` + +GetCcgVersionOk returns a tuple with the CcgVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCcgVersion + +`func (o *ManagedCluster) SetCcgVersion(v string)` + +SetCcgVersion sets CcgVersion field to given value. + + +### GetPinnedConfig + +`func (o *ManagedCluster) GetPinnedConfig() bool` + +GetPinnedConfig returns the PinnedConfig field if non-nil, zero value otherwise. + +### GetPinnedConfigOk + +`func (o *ManagedCluster) GetPinnedConfigOk() (*bool, bool)` + +GetPinnedConfigOk returns a tuple with the PinnedConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPinnedConfig + +`func (o *ManagedCluster) SetPinnedConfig(v bool)` + +SetPinnedConfig sets PinnedConfig field to given value. + +### HasPinnedConfig + +`func (o *ManagedCluster) HasPinnedConfig() bool` + +HasPinnedConfig returns a boolean if a field has been set. + +### GetLogConfiguration + +`func (o *ManagedCluster) GetLogConfiguration() ClientLogConfiguration` + +GetLogConfiguration returns the LogConfiguration field if non-nil, zero value otherwise. + +### GetLogConfigurationOk + +`func (o *ManagedCluster) GetLogConfigurationOk() (*ClientLogConfiguration, bool)` + +GetLogConfigurationOk returns a tuple with the LogConfiguration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogConfiguration + +`func (o *ManagedCluster) SetLogConfiguration(v ClientLogConfiguration)` + +SetLogConfiguration sets LogConfiguration field to given value. + +### HasLogConfiguration + +`func (o *ManagedCluster) HasLogConfiguration() bool` + +HasLogConfiguration returns a boolean if a field has been set. + +### SetLogConfigurationNil + +`func (o *ManagedCluster) SetLogConfigurationNil(b bool)` + + SetLogConfigurationNil sets the value for LogConfiguration to be an explicit nil + +### UnsetLogConfiguration +`func (o *ManagedCluster) UnsetLogConfiguration()` + +UnsetLogConfiguration ensures that no value is present for LogConfiguration, not even an explicit nil +### GetOperational + +`func (o *ManagedCluster) GetOperational() bool` + +GetOperational returns the Operational field if non-nil, zero value otherwise. + +### GetOperationalOk + +`func (o *ManagedCluster) GetOperationalOk() (*bool, bool)` + +GetOperationalOk returns a tuple with the Operational field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperational + +`func (o *ManagedCluster) SetOperational(v bool)` + +SetOperational sets Operational field to given value. + +### HasOperational + +`func (o *ManagedCluster) HasOperational() bool` + +HasOperational returns a boolean if a field has been set. + +### GetStatus + +`func (o *ManagedCluster) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManagedCluster) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManagedCluster) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ManagedCluster) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetPublicKeyCertificate + +`func (o *ManagedCluster) GetPublicKeyCertificate() string` + +GetPublicKeyCertificate returns the PublicKeyCertificate field if non-nil, zero value otherwise. + +### GetPublicKeyCertificateOk + +`func (o *ManagedCluster) GetPublicKeyCertificateOk() (*string, bool)` + +GetPublicKeyCertificateOk returns a tuple with the PublicKeyCertificate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyCertificate + +`func (o *ManagedCluster) SetPublicKeyCertificate(v string)` + +SetPublicKeyCertificate sets PublicKeyCertificate field to given value. + +### HasPublicKeyCertificate + +`func (o *ManagedCluster) HasPublicKeyCertificate() bool` + +HasPublicKeyCertificate returns a boolean if a field has been set. + +### SetPublicKeyCertificateNil + +`func (o *ManagedCluster) SetPublicKeyCertificateNil(b bool)` + + SetPublicKeyCertificateNil sets the value for PublicKeyCertificate to be an explicit nil + +### UnsetPublicKeyCertificate +`func (o *ManagedCluster) UnsetPublicKeyCertificate()` + +UnsetPublicKeyCertificate ensures that no value is present for PublicKeyCertificate, not even an explicit nil +### GetPublicKeyThumbprint + +`func (o *ManagedCluster) GetPublicKeyThumbprint() string` + +GetPublicKeyThumbprint returns the PublicKeyThumbprint field if non-nil, zero value otherwise. + +### GetPublicKeyThumbprintOk + +`func (o *ManagedCluster) GetPublicKeyThumbprintOk() (*string, bool)` + +GetPublicKeyThumbprintOk returns a tuple with the PublicKeyThumbprint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyThumbprint + +`func (o *ManagedCluster) SetPublicKeyThumbprint(v string)` + +SetPublicKeyThumbprint sets PublicKeyThumbprint field to given value. + +### HasPublicKeyThumbprint + +`func (o *ManagedCluster) HasPublicKeyThumbprint() bool` + +HasPublicKeyThumbprint returns a boolean if a field has been set. + +### SetPublicKeyThumbprintNil + +`func (o *ManagedCluster) SetPublicKeyThumbprintNil(b bool)` + + SetPublicKeyThumbprintNil sets the value for PublicKeyThumbprint to be an explicit nil + +### UnsetPublicKeyThumbprint +`func (o *ManagedCluster) UnsetPublicKeyThumbprint()` + +UnsetPublicKeyThumbprint ensures that no value is present for PublicKeyThumbprint, not even an explicit nil +### GetPublicKey + +`func (o *ManagedCluster) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *ManagedCluster) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *ManagedCluster) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *ManagedCluster) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### SetPublicKeyNil + +`func (o *ManagedCluster) SetPublicKeyNil(b bool)` + + SetPublicKeyNil sets the value for PublicKey to be an explicit nil + +### UnsetPublicKey +`func (o *ManagedCluster) UnsetPublicKey()` + +UnsetPublicKey ensures that no value is present for PublicKey, not even an explicit nil +### GetAlertKey + +`func (o *ManagedCluster) GetAlertKey() string` + +GetAlertKey returns the AlertKey field if non-nil, zero value otherwise. + +### GetAlertKeyOk + +`func (o *ManagedCluster) GetAlertKeyOk() (*string, bool)` + +GetAlertKeyOk returns a tuple with the AlertKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertKey + +`func (o *ManagedCluster) SetAlertKey(v string)` + +SetAlertKey sets AlertKey field to given value. + +### HasAlertKey + +`func (o *ManagedCluster) HasAlertKey() bool` + +HasAlertKey returns a boolean if a field has been set. + +### GetClientIds + +`func (o *ManagedCluster) GetClientIds() []string` + +GetClientIds returns the ClientIds field if non-nil, zero value otherwise. + +### GetClientIdsOk + +`func (o *ManagedCluster) GetClientIdsOk() (*[]string, bool)` + +GetClientIdsOk returns a tuple with the ClientIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientIds + +`func (o *ManagedCluster) SetClientIds(v []string)` + +SetClientIds sets ClientIds field to given value. + +### HasClientIds + +`func (o *ManagedCluster) HasClientIds() bool` + +HasClientIds returns a boolean if a field has been set. + +### GetServiceCount + +`func (o *ManagedCluster) GetServiceCount() int32` + +GetServiceCount returns the ServiceCount field if non-nil, zero value otherwise. + +### GetServiceCountOk + +`func (o *ManagedCluster) GetServiceCountOk() (*int32, bool)` + +GetServiceCountOk returns a tuple with the ServiceCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceCount + +`func (o *ManagedCluster) SetServiceCount(v int32)` + +SetServiceCount sets ServiceCount field to given value. + +### HasServiceCount + +`func (o *ManagedCluster) HasServiceCount() bool` + +HasServiceCount returns a boolean if a field has been set. + +### GetCcId + +`func (o *ManagedCluster) GetCcId() string` + +GetCcId returns the CcId field if non-nil, zero value otherwise. + +### GetCcIdOk + +`func (o *ManagedCluster) GetCcIdOk() (*string, bool)` + +GetCcIdOk returns a tuple with the CcId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCcId + +`func (o *ManagedCluster) SetCcId(v string)` + +SetCcId sets CcId field to given value. + +### HasCcId + +`func (o *ManagedCluster) HasCcId() bool` + +HasCcId returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *ManagedCluster) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *ManagedCluster) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *ManagedCluster) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *ManagedCluster) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### SetCreatedAtNil + +`func (o *ManagedCluster) SetCreatedAtNil(b bool)` + + SetCreatedAtNil sets the value for CreatedAt to be an explicit nil + +### UnsetCreatedAt +`func (o *ManagedCluster) UnsetCreatedAt()` + +UnsetCreatedAt ensures that no value is present for CreatedAt, not even an explicit nil +### GetUpdatedAt + +`func (o *ManagedCluster) GetUpdatedAt() SailPointTime` + +GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise. + +### GetUpdatedAtOk + +`func (o *ManagedCluster) GetUpdatedAtOk() (*SailPointTime, bool)` + +GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedAt + +`func (o *ManagedCluster) SetUpdatedAt(v SailPointTime)` + +SetUpdatedAt sets UpdatedAt field to given value. + +### HasUpdatedAt + +`func (o *ManagedCluster) HasUpdatedAt() bool` + +HasUpdatedAt returns a boolean if a field has been set. + +### SetUpdatedAtNil + +`func (o *ManagedCluster) SetUpdatedAtNil(b bool)` + + SetUpdatedAtNil sets the value for UpdatedAt to be an explicit nil + +### UnsetUpdatedAt +`func (o *ManagedCluster) UnsetUpdatedAt()` + +UnsetUpdatedAt ensures that no value is present for UpdatedAt, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterAttributes.md b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterAttributes.md new file mode 100644 index 000000000..fe94e2464 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterAttributes.md @@ -0,0 +1,100 @@ +--- +id: v2025-managed-cluster-attributes +title: ManagedClusterAttributes +pagination_label: ManagedClusterAttributes +sidebar_label: ManagedClusterAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterAttributes', 'V2025ManagedClusterAttributes'] +slug: /tools/sdk/go/v2025/models/managed-cluster-attributes +tags: ['SDK', 'Software Development Kit', 'ManagedClusterAttributes', 'V2025ManagedClusterAttributes'] +--- + +# ManagedClusterAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Queue** | Pointer to [**ManagedClusterQueue**](managed-cluster-queue) | | [optional] +**Keystore** | Pointer to **NullableString** | ManagedCluster keystore for spConnectCluster type | [optional] + +## Methods + +### NewManagedClusterAttributes + +`func NewManagedClusterAttributes() *ManagedClusterAttributes` + +NewManagedClusterAttributes instantiates a new ManagedClusterAttributes 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 + +### NewManagedClusterAttributesWithDefaults + +`func NewManagedClusterAttributesWithDefaults() *ManagedClusterAttributes` + +NewManagedClusterAttributesWithDefaults instantiates a new ManagedClusterAttributes 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 + +### GetQueue + +`func (o *ManagedClusterAttributes) GetQueue() ManagedClusterQueue` + +GetQueue returns the Queue field if non-nil, zero value otherwise. + +### GetQueueOk + +`func (o *ManagedClusterAttributes) GetQueueOk() (*ManagedClusterQueue, bool)` + +GetQueueOk returns a tuple with the Queue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueue + +`func (o *ManagedClusterAttributes) SetQueue(v ManagedClusterQueue)` + +SetQueue sets Queue field to given value. + +### HasQueue + +`func (o *ManagedClusterAttributes) HasQueue() bool` + +HasQueue returns a boolean if a field has been set. + +### GetKeystore + +`func (o *ManagedClusterAttributes) GetKeystore() string` + +GetKeystore returns the Keystore field if non-nil, zero value otherwise. + +### GetKeystoreOk + +`func (o *ManagedClusterAttributes) GetKeystoreOk() (*string, bool)` + +GetKeystoreOk returns a tuple with the Keystore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKeystore + +`func (o *ManagedClusterAttributes) SetKeystore(v string)` + +SetKeystore sets Keystore field to given value. + +### HasKeystore + +`func (o *ManagedClusterAttributes) HasKeystore() bool` + +HasKeystore returns a boolean if a field has been set. + +### SetKeystoreNil + +`func (o *ManagedClusterAttributes) SetKeystoreNil(b bool)` + + SetKeystoreNil sets the value for Keystore to be an explicit nil + +### UnsetKeystore +`func (o *ManagedClusterAttributes) UnsetKeystore()` + +UnsetKeystore ensures that no value is present for Keystore, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterKeyPair.md b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterKeyPair.md new file mode 100644 index 000000000..4239beb2a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterKeyPair.md @@ -0,0 +1,146 @@ +--- +id: v2025-managed-cluster-key-pair +title: ManagedClusterKeyPair +pagination_label: ManagedClusterKeyPair +sidebar_label: ManagedClusterKeyPair +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterKeyPair', 'V2025ManagedClusterKeyPair'] +slug: /tools/sdk/go/v2025/models/managed-cluster-key-pair +tags: ['SDK', 'Software Development Kit', 'ManagedClusterKeyPair', 'V2025ManagedClusterKeyPair'] +--- + +# ManagedClusterKeyPair + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PublicKey** | Pointer to **NullableString** | ManagedCluster publicKey | [optional] +**PublicKeyThumbprint** | Pointer to **NullableString** | ManagedCluster publicKeyThumbprint | [optional] +**PublicKeyCertificate** | Pointer to **NullableString** | ManagedCluster publicKeyCertificate | [optional] + +## Methods + +### NewManagedClusterKeyPair + +`func NewManagedClusterKeyPair() *ManagedClusterKeyPair` + +NewManagedClusterKeyPair instantiates a new ManagedClusterKeyPair 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 + +### NewManagedClusterKeyPairWithDefaults + +`func NewManagedClusterKeyPairWithDefaults() *ManagedClusterKeyPair` + +NewManagedClusterKeyPairWithDefaults instantiates a new ManagedClusterKeyPair 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 + +### GetPublicKey + +`func (o *ManagedClusterKeyPair) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *ManagedClusterKeyPair) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *ManagedClusterKeyPair) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *ManagedClusterKeyPair) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### SetPublicKeyNil + +`func (o *ManagedClusterKeyPair) SetPublicKeyNil(b bool)` + + SetPublicKeyNil sets the value for PublicKey to be an explicit nil + +### UnsetPublicKey +`func (o *ManagedClusterKeyPair) UnsetPublicKey()` + +UnsetPublicKey ensures that no value is present for PublicKey, not even an explicit nil +### GetPublicKeyThumbprint + +`func (o *ManagedClusterKeyPair) GetPublicKeyThumbprint() string` + +GetPublicKeyThumbprint returns the PublicKeyThumbprint field if non-nil, zero value otherwise. + +### GetPublicKeyThumbprintOk + +`func (o *ManagedClusterKeyPair) GetPublicKeyThumbprintOk() (*string, bool)` + +GetPublicKeyThumbprintOk returns a tuple with the PublicKeyThumbprint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyThumbprint + +`func (o *ManagedClusterKeyPair) SetPublicKeyThumbprint(v string)` + +SetPublicKeyThumbprint sets PublicKeyThumbprint field to given value. + +### HasPublicKeyThumbprint + +`func (o *ManagedClusterKeyPair) HasPublicKeyThumbprint() bool` + +HasPublicKeyThumbprint returns a boolean if a field has been set. + +### SetPublicKeyThumbprintNil + +`func (o *ManagedClusterKeyPair) SetPublicKeyThumbprintNil(b bool)` + + SetPublicKeyThumbprintNil sets the value for PublicKeyThumbprint to be an explicit nil + +### UnsetPublicKeyThumbprint +`func (o *ManagedClusterKeyPair) UnsetPublicKeyThumbprint()` + +UnsetPublicKeyThumbprint ensures that no value is present for PublicKeyThumbprint, not even an explicit nil +### GetPublicKeyCertificate + +`func (o *ManagedClusterKeyPair) GetPublicKeyCertificate() string` + +GetPublicKeyCertificate returns the PublicKeyCertificate field if non-nil, zero value otherwise. + +### GetPublicKeyCertificateOk + +`func (o *ManagedClusterKeyPair) GetPublicKeyCertificateOk() (*string, bool)` + +GetPublicKeyCertificateOk returns a tuple with the PublicKeyCertificate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyCertificate + +`func (o *ManagedClusterKeyPair) SetPublicKeyCertificate(v string)` + +SetPublicKeyCertificate sets PublicKeyCertificate field to given value. + +### HasPublicKeyCertificate + +`func (o *ManagedClusterKeyPair) HasPublicKeyCertificate() bool` + +HasPublicKeyCertificate returns a boolean if a field has been set. + +### SetPublicKeyCertificateNil + +`func (o *ManagedClusterKeyPair) SetPublicKeyCertificateNil(b bool)` + + SetPublicKeyCertificateNil sets the value for PublicKeyCertificate to be an explicit nil + +### UnsetPublicKeyCertificate +`func (o *ManagedClusterKeyPair) UnsetPublicKeyCertificate()` + +UnsetPublicKeyCertificate ensures that no value is present for PublicKeyCertificate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterQueue.md b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterQueue.md new file mode 100644 index 000000000..80052bc16 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterQueue.md @@ -0,0 +1,90 @@ +--- +id: v2025-managed-cluster-queue +title: ManagedClusterQueue +pagination_label: ManagedClusterQueue +sidebar_label: ManagedClusterQueue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterQueue', 'V2025ManagedClusterQueue'] +slug: /tools/sdk/go/v2025/models/managed-cluster-queue +tags: ['SDK', 'Software Development Kit', 'ManagedClusterQueue', 'V2025ManagedClusterQueue'] +--- + +# ManagedClusterQueue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | ManagedCluster queue name | [optional] +**Region** | Pointer to **string** | ManagedCluster queue aws region | [optional] + +## Methods + +### NewManagedClusterQueue + +`func NewManagedClusterQueue() *ManagedClusterQueue` + +NewManagedClusterQueue instantiates a new ManagedClusterQueue 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 + +### NewManagedClusterQueueWithDefaults + +`func NewManagedClusterQueueWithDefaults() *ManagedClusterQueue` + +NewManagedClusterQueueWithDefaults instantiates a new ManagedClusterQueue 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 + +### GetName + +`func (o *ManagedClusterQueue) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedClusterQueue) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedClusterQueue) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManagedClusterQueue) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetRegion + +`func (o *ManagedClusterQueue) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *ManagedClusterQueue) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *ManagedClusterQueue) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *ManagedClusterQueue) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterRedis.md b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterRedis.md new file mode 100644 index 000000000..3132296bd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterRedis.md @@ -0,0 +1,90 @@ +--- +id: v2025-managed-cluster-redis +title: ManagedClusterRedis +pagination_label: ManagedClusterRedis +sidebar_label: ManagedClusterRedis +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterRedis', 'V2025ManagedClusterRedis'] +slug: /tools/sdk/go/v2025/models/managed-cluster-redis +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRedis', 'V2025ManagedClusterRedis'] +--- + +# ManagedClusterRedis + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RedisHost** | Pointer to **string** | ManagedCluster redisHost | [optional] +**RedisPort** | Pointer to **int32** | ManagedCluster redisPort | [optional] + +## Methods + +### NewManagedClusterRedis + +`func NewManagedClusterRedis() *ManagedClusterRedis` + +NewManagedClusterRedis instantiates a new ManagedClusterRedis 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 + +### NewManagedClusterRedisWithDefaults + +`func NewManagedClusterRedisWithDefaults() *ManagedClusterRedis` + +NewManagedClusterRedisWithDefaults instantiates a new ManagedClusterRedis 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 + +### GetRedisHost + +`func (o *ManagedClusterRedis) GetRedisHost() string` + +GetRedisHost returns the RedisHost field if non-nil, zero value otherwise. + +### GetRedisHostOk + +`func (o *ManagedClusterRedis) GetRedisHostOk() (*string, bool)` + +GetRedisHostOk returns a tuple with the RedisHost field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedisHost + +`func (o *ManagedClusterRedis) SetRedisHost(v string)` + +SetRedisHost sets RedisHost field to given value. + +### HasRedisHost + +`func (o *ManagedClusterRedis) HasRedisHost() bool` + +HasRedisHost returns a boolean if a field has been set. + +### GetRedisPort + +`func (o *ManagedClusterRedis) GetRedisPort() int32` + +GetRedisPort returns the RedisPort field if non-nil, zero value otherwise. + +### GetRedisPortOk + +`func (o *ManagedClusterRedis) GetRedisPortOk() (*int32, bool)` + +GetRedisPortOk returns a tuple with the RedisPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedisPort + +`func (o *ManagedClusterRedis) SetRedisPort(v int32)` + +SetRedisPort sets RedisPort field to given value. + +### HasRedisPort + +`func (o *ManagedClusterRedis) HasRedisPort() bool` + +HasRedisPort returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterRequest.md new file mode 100644 index 000000000..c25dab45f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterRequest.md @@ -0,0 +1,147 @@ +--- +id: v2025-managed-cluster-request +title: ManagedClusterRequest +pagination_label: ManagedClusterRequest +sidebar_label: ManagedClusterRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterRequest', 'V2025ManagedClusterRequest'] +slug: /tools/sdk/go/v2025/models/managed-cluster-request +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRequest', 'V2025ManagedClusterRequest'] +--- + +# ManagedClusterRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | ManagedCluster name | +**Type** | Pointer to [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**Configuration** | Pointer to **map[string]string** | ManagedProcess configuration map | [optional] +**Description** | Pointer to **NullableString** | ManagedCluster description | [optional] + +## Methods + +### NewManagedClusterRequest + +`func NewManagedClusterRequest(name string, ) *ManagedClusterRequest` + +NewManagedClusterRequest instantiates a new ManagedClusterRequest 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 + +### NewManagedClusterRequestWithDefaults + +`func NewManagedClusterRequestWithDefaults() *ManagedClusterRequest` + +NewManagedClusterRequestWithDefaults instantiates a new ManagedClusterRequest 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 + +### GetName + +`func (o *ManagedClusterRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedClusterRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedClusterRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *ManagedClusterRequest) GetType() ManagedClusterTypes` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClusterRequest) GetTypeOk() (*ManagedClusterTypes, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClusterRequest) SetType(v ManagedClusterTypes)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManagedClusterRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConfiguration + +`func (o *ManagedClusterRequest) GetConfiguration() map[string]string` + +GetConfiguration returns the Configuration field if non-nil, zero value otherwise. + +### GetConfigurationOk + +`func (o *ManagedClusterRequest) GetConfigurationOk() (*map[string]string, bool)` + +GetConfigurationOk returns a tuple with the Configuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfiguration + +`func (o *ManagedClusterRequest) SetConfiguration(v map[string]string)` + +SetConfiguration sets Configuration field to given value. + +### HasConfiguration + +`func (o *ManagedClusterRequest) HasConfiguration() bool` + +HasConfiguration returns a boolean if a field has been set. + +### GetDescription + +`func (o *ManagedClusterRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManagedClusterRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManagedClusterRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ManagedClusterRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ManagedClusterRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ManagedClusterRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterType.md b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterType.md new file mode 100644 index 000000000..52bbc032a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterType.md @@ -0,0 +1,153 @@ +--- +id: v2025-managed-cluster-type +title: ManagedClusterType +pagination_label: ManagedClusterType +sidebar_label: ManagedClusterType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterType', 'V2025ManagedClusterType'] +slug: /tools/sdk/go/v2025/models/managed-cluster-type +tags: ['SDK', 'Software Development Kit', 'ManagedClusterType', 'V2025ManagedClusterType'] +--- + +# ManagedClusterType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ManagedClusterType ID | [optional] [readonly] +**Type** | **string** | ManagedClusterType type name | +**Pod** | **string** | ManagedClusterType pod | +**Org** | **string** | ManagedClusterType org | +**ManagedProcessIds** | Pointer to **[]string** | List of processes for the cluster type | [optional] + +## Methods + +### NewManagedClusterType + +`func NewManagedClusterType(type_ string, pod string, org string, ) *ManagedClusterType` + +NewManagedClusterType instantiates a new ManagedClusterType 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 + +### NewManagedClusterTypeWithDefaults + +`func NewManagedClusterTypeWithDefaults() *ManagedClusterType` + +NewManagedClusterTypeWithDefaults instantiates a new ManagedClusterType 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 + +### GetId + +`func (o *ManagedClusterType) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManagedClusterType) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManagedClusterType) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ManagedClusterType) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *ManagedClusterType) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClusterType) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClusterType) SetType(v string)` + +SetType sets Type field to given value. + + +### GetPod + +`func (o *ManagedClusterType) GetPod() string` + +GetPod returns the Pod field if non-nil, zero value otherwise. + +### GetPodOk + +`func (o *ManagedClusterType) GetPodOk() (*string, bool)` + +GetPodOk returns a tuple with the Pod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPod + +`func (o *ManagedClusterType) SetPod(v string)` + +SetPod sets Pod field to given value. + + +### GetOrg + +`func (o *ManagedClusterType) GetOrg() string` + +GetOrg returns the Org field if non-nil, zero value otherwise. + +### GetOrgOk + +`func (o *ManagedClusterType) GetOrgOk() (*string, bool)` + +GetOrgOk returns a tuple with the Org field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrg + +`func (o *ManagedClusterType) SetOrg(v string)` + +SetOrg sets Org field to given value. + + +### GetManagedProcessIds + +`func (o *ManagedClusterType) GetManagedProcessIds() []string` + +GetManagedProcessIds returns the ManagedProcessIds field if non-nil, zero value otherwise. + +### GetManagedProcessIdsOk + +`func (o *ManagedClusterType) GetManagedProcessIdsOk() (*[]string, bool)` + +GetManagedProcessIdsOk returns a tuple with the ManagedProcessIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagedProcessIds + +`func (o *ManagedClusterType) SetManagedProcessIds(v []string)` + +SetManagedProcessIds sets ManagedProcessIds field to given value. + +### HasManagedProcessIds + +`func (o *ManagedClusterType) HasManagedProcessIds() bool` + +HasManagedProcessIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterTypes.md b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterTypes.md new file mode 100644 index 000000000..4e54fbc36 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManagedClusterTypes.md @@ -0,0 +1,21 @@ +--- +id: v2025-managed-cluster-types +title: ManagedClusterTypes +pagination_label: ManagedClusterTypes +sidebar_label: ManagedClusterTypes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterTypes', 'V2025ManagedClusterTypes'] +slug: /tools/sdk/go/v2025/models/managed-cluster-types +tags: ['SDK', 'Software Development Kit', 'ManagedClusterTypes', 'V2025ManagedClusterTypes'] +--- + +# ManagedClusterTypes + +## Enum + + +* `IDN` (value: `"idn"`) + +* `IAI` (value: `"iai"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManagerCorrelationMapping.md b/docs/tools/sdk/go/Reference/V2025/Models/ManagerCorrelationMapping.md new file mode 100644 index 000000000..8a605e90f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManagerCorrelationMapping.md @@ -0,0 +1,90 @@ +--- +id: v2025-manager-correlation-mapping +title: ManagerCorrelationMapping +pagination_label: ManagerCorrelationMapping +sidebar_label: ManagerCorrelationMapping +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagerCorrelationMapping', 'V2025ManagerCorrelationMapping'] +slug: /tools/sdk/go/v2025/models/manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'ManagerCorrelationMapping', 'V2025ManagerCorrelationMapping'] +--- + +# ManagerCorrelationMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountAttributeName** | Pointer to **string** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**IdentityAttributeName** | Pointer to **string** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] + +## Methods + +### NewManagerCorrelationMapping + +`func NewManagerCorrelationMapping() *ManagerCorrelationMapping` + +NewManagerCorrelationMapping instantiates a new ManagerCorrelationMapping 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 + +### NewManagerCorrelationMappingWithDefaults + +`func NewManagerCorrelationMappingWithDefaults() *ManagerCorrelationMapping` + +NewManagerCorrelationMappingWithDefaults instantiates a new ManagerCorrelationMapping 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 + +### GetAccountAttributeName + +`func (o *ManagerCorrelationMapping) GetAccountAttributeName() string` + +GetAccountAttributeName returns the AccountAttributeName field if non-nil, zero value otherwise. + +### GetAccountAttributeNameOk + +`func (o *ManagerCorrelationMapping) GetAccountAttributeNameOk() (*string, bool)` + +GetAccountAttributeNameOk returns a tuple with the AccountAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountAttributeName + +`func (o *ManagerCorrelationMapping) SetAccountAttributeName(v string)` + +SetAccountAttributeName sets AccountAttributeName field to given value. + +### HasAccountAttributeName + +`func (o *ManagerCorrelationMapping) HasAccountAttributeName() bool` + +HasAccountAttributeName returns a boolean if a field has been set. + +### GetIdentityAttributeName + +`func (o *ManagerCorrelationMapping) GetIdentityAttributeName() string` + +GetIdentityAttributeName returns the IdentityAttributeName field if non-nil, zero value otherwise. + +### GetIdentityAttributeNameOk + +`func (o *ManagerCorrelationMapping) GetIdentityAttributeNameOk() (*string, bool)` + +GetIdentityAttributeNameOk returns a tuple with the IdentityAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeName + +`func (o *ManagerCorrelationMapping) SetIdentityAttributeName(v string)` + +SetIdentityAttributeName sets IdentityAttributeName field to given value. + +### HasIdentityAttributeName + +`func (o *ManagerCorrelationMapping) HasIdentityAttributeName() bool` + +HasIdentityAttributeName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManualDiscoverApplications.md b/docs/tools/sdk/go/Reference/V2025/Models/ManualDiscoverApplications.md new file mode 100644 index 000000000..d780ce2bd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManualDiscoverApplications.md @@ -0,0 +1,59 @@ +--- +id: v2025-manual-discover-applications +title: ManualDiscoverApplications +pagination_label: ManualDiscoverApplications +sidebar_label: ManualDiscoverApplications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualDiscoverApplications', 'V2025ManualDiscoverApplications'] +slug: /tools/sdk/go/v2025/models/manual-discover-applications +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplications', 'V2025ManualDiscoverApplications'] +--- + +# ManualDiscoverApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | ***os.File** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | + +## Methods + +### NewManualDiscoverApplications + +`func NewManualDiscoverApplications(file *os.File, ) *ManualDiscoverApplications` + +NewManualDiscoverApplications instantiates a new ManualDiscoverApplications 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 + +### NewManualDiscoverApplicationsWithDefaults + +`func NewManualDiscoverApplicationsWithDefaults() *ManualDiscoverApplications` + +NewManualDiscoverApplicationsWithDefaults instantiates a new ManualDiscoverApplications 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 + +### GetFile + +`func (o *ManualDiscoverApplications) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *ManualDiscoverApplications) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *ManualDiscoverApplications) SetFile(v *os.File)` + +SetFile sets File field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManualDiscoverApplicationsTemplate.md b/docs/tools/sdk/go/Reference/V2025/Models/ManualDiscoverApplicationsTemplate.md new file mode 100644 index 000000000..1264dc954 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManualDiscoverApplicationsTemplate.md @@ -0,0 +1,90 @@ +--- +id: v2025-manual-discover-applications-template +title: ManualDiscoverApplicationsTemplate +pagination_label: ManualDiscoverApplicationsTemplate +sidebar_label: ManualDiscoverApplicationsTemplate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualDiscoverApplicationsTemplate', 'V2025ManualDiscoverApplicationsTemplate'] +slug: /tools/sdk/go/v2025/models/manual-discover-applications-template +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplicationsTemplate', 'V2025ManualDiscoverApplicationsTemplate'] +--- + +# ManualDiscoverApplicationsTemplate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationName** | Pointer to **string** | Name of the application. | [optional] +**Description** | Pointer to **string** | Description of the application. | [optional] + +## Methods + +### NewManualDiscoverApplicationsTemplate + +`func NewManualDiscoverApplicationsTemplate() *ManualDiscoverApplicationsTemplate` + +NewManualDiscoverApplicationsTemplate instantiates a new ManualDiscoverApplicationsTemplate 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 + +### NewManualDiscoverApplicationsTemplateWithDefaults + +`func NewManualDiscoverApplicationsTemplateWithDefaults() *ManualDiscoverApplicationsTemplate` + +NewManualDiscoverApplicationsTemplateWithDefaults instantiates a new ManualDiscoverApplicationsTemplate 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 + +### GetApplicationName + +`func (o *ManualDiscoverApplicationsTemplate) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *ManualDiscoverApplicationsTemplate) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *ManualDiscoverApplicationsTemplate) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *ManualDiscoverApplicationsTemplate) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ManualDiscoverApplicationsTemplate) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManualDiscoverApplicationsTemplate) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManualDiscoverApplicationsTemplate) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ManualDiscoverApplicationsTemplate) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManualWorkItemDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/ManualWorkItemDetails.md new file mode 100644 index 000000000..77e6eadc9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManualWorkItemDetails.md @@ -0,0 +1,224 @@ +--- +id: v2025-manual-work-item-details +title: ManualWorkItemDetails +pagination_label: ManualWorkItemDetails +sidebar_label: ManualWorkItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualWorkItemDetails', 'V2025ManualWorkItemDetails'] +slug: /tools/sdk/go/v2025/models/manual-work-item-details +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetails', 'V2025ManualWorkItemDetails'] +--- + +# ManualWorkItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Forwarded** | Pointer to **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to false] +**OriginalOwner** | Pointer to [**NullableManualWorkItemDetailsOriginalOwner**](manual-work-item-details-original-owner) | | [optional] +**CurrentOwner** | Pointer to [**NullableManualWorkItemDetailsCurrentOwner**](manual-work-item-details-current-owner) | | [optional] +**Modified** | Pointer to **SailPointTime** | Time at which item was modified. | [optional] +**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] + +## Methods + +### NewManualWorkItemDetails + +`func NewManualWorkItemDetails() *ManualWorkItemDetails` + +NewManualWorkItemDetails instantiates a new ManualWorkItemDetails 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 + +### NewManualWorkItemDetailsWithDefaults + +`func NewManualWorkItemDetailsWithDefaults() *ManualWorkItemDetails` + +NewManualWorkItemDetailsWithDefaults instantiates a new ManualWorkItemDetails 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 + +### GetForwarded + +`func (o *ManualWorkItemDetails) GetForwarded() bool` + +GetForwarded returns the Forwarded field if non-nil, zero value otherwise. + +### GetForwardedOk + +`func (o *ManualWorkItemDetails) GetForwardedOk() (*bool, bool)` + +GetForwardedOk returns a tuple with the Forwarded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwarded + +`func (o *ManualWorkItemDetails) SetForwarded(v bool)` + +SetForwarded sets Forwarded field to given value. + +### HasForwarded + +`func (o *ManualWorkItemDetails) HasForwarded() bool` + +HasForwarded returns a boolean if a field has been set. + +### GetOriginalOwner + +`func (o *ManualWorkItemDetails) GetOriginalOwner() ManualWorkItemDetailsOriginalOwner` + +GetOriginalOwner returns the OriginalOwner field if non-nil, zero value otherwise. + +### GetOriginalOwnerOk + +`func (o *ManualWorkItemDetails) GetOriginalOwnerOk() (*ManualWorkItemDetailsOriginalOwner, bool)` + +GetOriginalOwnerOk returns a tuple with the OriginalOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalOwner + +`func (o *ManualWorkItemDetails) SetOriginalOwner(v ManualWorkItemDetailsOriginalOwner)` + +SetOriginalOwner sets OriginalOwner field to given value. + +### HasOriginalOwner + +`func (o *ManualWorkItemDetails) HasOriginalOwner() bool` + +HasOriginalOwner returns a boolean if a field has been set. + +### SetOriginalOwnerNil + +`func (o *ManualWorkItemDetails) SetOriginalOwnerNil(b bool)` + + SetOriginalOwnerNil sets the value for OriginalOwner to be an explicit nil + +### UnsetOriginalOwner +`func (o *ManualWorkItemDetails) UnsetOriginalOwner()` + +UnsetOriginalOwner ensures that no value is present for OriginalOwner, not even an explicit nil +### GetCurrentOwner + +`func (o *ManualWorkItemDetails) GetCurrentOwner() ManualWorkItemDetailsCurrentOwner` + +GetCurrentOwner returns the CurrentOwner field if non-nil, zero value otherwise. + +### GetCurrentOwnerOk + +`func (o *ManualWorkItemDetails) GetCurrentOwnerOk() (*ManualWorkItemDetailsCurrentOwner, bool)` + +GetCurrentOwnerOk returns a tuple with the CurrentOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentOwner + +`func (o *ManualWorkItemDetails) SetCurrentOwner(v ManualWorkItemDetailsCurrentOwner)` + +SetCurrentOwner sets CurrentOwner field to given value. + +### HasCurrentOwner + +`func (o *ManualWorkItemDetails) HasCurrentOwner() bool` + +HasCurrentOwner returns a boolean if a field has been set. + +### SetCurrentOwnerNil + +`func (o *ManualWorkItemDetails) SetCurrentOwnerNil(b bool)` + + SetCurrentOwnerNil sets the value for CurrentOwner to be an explicit nil + +### UnsetCurrentOwner +`func (o *ManualWorkItemDetails) UnsetCurrentOwner()` + +UnsetCurrentOwner ensures that no value is present for CurrentOwner, not even an explicit nil +### GetModified + +`func (o *ManualWorkItemDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ManualWorkItemDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ManualWorkItemDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ManualWorkItemDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetStatus + +`func (o *ManualWorkItemDetails) GetStatus() ManualWorkItemState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManualWorkItemDetails) GetStatusOk() (*ManualWorkItemState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManualWorkItemDetails) SetStatus(v ManualWorkItemState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ManualWorkItemDetails) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetForwardHistory + +`func (o *ManualWorkItemDetails) GetForwardHistory() []ApprovalForwardHistory` + +GetForwardHistory returns the ForwardHistory field if non-nil, zero value otherwise. + +### GetForwardHistoryOk + +`func (o *ManualWorkItemDetails) GetForwardHistoryOk() (*[]ApprovalForwardHistory, bool)` + +GetForwardHistoryOk returns a tuple with the ForwardHistory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwardHistory + +`func (o *ManualWorkItemDetails) SetForwardHistory(v []ApprovalForwardHistory)` + +SetForwardHistory sets ForwardHistory field to given value. + +### HasForwardHistory + +`func (o *ManualWorkItemDetails) HasForwardHistory() bool` + +HasForwardHistory returns a boolean if a field has been set. + +### SetForwardHistoryNil + +`func (o *ManualWorkItemDetails) SetForwardHistoryNil(b bool)` + + SetForwardHistoryNil sets the value for ForwardHistory to be an explicit nil + +### UnsetForwardHistory +`func (o *ManualWorkItemDetails) UnsetForwardHistory()` + +UnsetForwardHistory ensures that no value is present for ForwardHistory, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManualWorkItemDetailsCurrentOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/ManualWorkItemDetailsCurrentOwner.md new file mode 100644 index 000000000..723449c22 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManualWorkItemDetailsCurrentOwner.md @@ -0,0 +1,116 @@ +--- +id: v2025-manual-work-item-details-current-owner +title: ManualWorkItemDetailsCurrentOwner +pagination_label: ManualWorkItemDetailsCurrentOwner +sidebar_label: ManualWorkItemDetailsCurrentOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualWorkItemDetailsCurrentOwner', 'V2025ManualWorkItemDetailsCurrentOwner'] +slug: /tools/sdk/go/v2025/models/manual-work-item-details-current-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsCurrentOwner', 'V2025ManualWorkItemDetailsCurrentOwner'] +--- + +# ManualWorkItemDetailsCurrentOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of current work item owner's identity. | [optional] +**Id** | Pointer to **string** | ID of current work item owner's identity. | [optional] +**Name** | Pointer to **string** | Display name of current work item owner. | [optional] + +## Methods + +### NewManualWorkItemDetailsCurrentOwner + +`func NewManualWorkItemDetailsCurrentOwner() *ManualWorkItemDetailsCurrentOwner` + +NewManualWorkItemDetailsCurrentOwner instantiates a new ManualWorkItemDetailsCurrentOwner 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 + +### NewManualWorkItemDetailsCurrentOwnerWithDefaults + +`func NewManualWorkItemDetailsCurrentOwnerWithDefaults() *ManualWorkItemDetailsCurrentOwner` + +NewManualWorkItemDetailsCurrentOwnerWithDefaults instantiates a new ManualWorkItemDetailsCurrentOwner 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 + +### GetType + +`func (o *ManualWorkItemDetailsCurrentOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManualWorkItemDetailsCurrentOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManualWorkItemDetailsCurrentOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManualWorkItemDetailsCurrentOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ManualWorkItemDetailsCurrentOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManualWorkItemDetailsCurrentOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManualWorkItemDetailsCurrentOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ManualWorkItemDetailsCurrentOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ManualWorkItemDetailsCurrentOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManualWorkItemDetailsCurrentOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManualWorkItemDetailsCurrentOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManualWorkItemDetailsCurrentOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManualWorkItemDetailsOriginalOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/ManualWorkItemDetailsOriginalOwner.md new file mode 100644 index 000000000..11ffb2d0a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManualWorkItemDetailsOriginalOwner.md @@ -0,0 +1,116 @@ +--- +id: v2025-manual-work-item-details-original-owner +title: ManualWorkItemDetailsOriginalOwner +pagination_label: ManualWorkItemDetailsOriginalOwner +sidebar_label: ManualWorkItemDetailsOriginalOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualWorkItemDetailsOriginalOwner', 'V2025ManualWorkItemDetailsOriginalOwner'] +slug: /tools/sdk/go/v2025/models/manual-work-item-details-original-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsOriginalOwner', 'V2025ManualWorkItemDetailsOriginalOwner'] +--- + +# ManualWorkItemDetailsOriginalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of original work item owner's identity. | [optional] +**Id** | Pointer to **string** | ID of original work item owner's identity. | [optional] +**Name** | Pointer to **string** | Display name of original work item owner. | [optional] + +## Methods + +### NewManualWorkItemDetailsOriginalOwner + +`func NewManualWorkItemDetailsOriginalOwner() *ManualWorkItemDetailsOriginalOwner` + +NewManualWorkItemDetailsOriginalOwner instantiates a new ManualWorkItemDetailsOriginalOwner 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 + +### NewManualWorkItemDetailsOriginalOwnerWithDefaults + +`func NewManualWorkItemDetailsOriginalOwnerWithDefaults() *ManualWorkItemDetailsOriginalOwner` + +NewManualWorkItemDetailsOriginalOwnerWithDefaults instantiates a new ManualWorkItemDetailsOriginalOwner 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 + +### GetType + +`func (o *ManualWorkItemDetailsOriginalOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManualWorkItemDetailsOriginalOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManualWorkItemDetailsOriginalOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManualWorkItemDetailsOriginalOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ManualWorkItemDetailsOriginalOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManualWorkItemDetailsOriginalOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManualWorkItemDetailsOriginalOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ManualWorkItemDetailsOriginalOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ManualWorkItemDetailsOriginalOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManualWorkItemDetailsOriginalOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManualWorkItemDetailsOriginalOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManualWorkItemDetailsOriginalOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ManualWorkItemState.md b/docs/tools/sdk/go/Reference/V2025/Models/ManualWorkItemState.md new file mode 100644 index 000000000..812d082e9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ManualWorkItemState.md @@ -0,0 +1,29 @@ +--- +id: v2025-manual-work-item-state +title: ManualWorkItemState +pagination_label: ManualWorkItemState +sidebar_label: ManualWorkItemState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualWorkItemState', 'V2025ManualWorkItemState'] +slug: /tools/sdk/go/v2025/models/manual-work-item-state +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemState', 'V2025ManualWorkItemState'] +--- + +# ManualWorkItemState + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `EXPIRED` (value: `"EXPIRED"`) + +* `CANCELLED` (value: `"CANCELLED"`) + +* `ARCHIVED` (value: `"ARCHIVED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MatchTerm.md b/docs/tools/sdk/go/Reference/V2025/Models/MatchTerm.md new file mode 100644 index 000000000..7a6b17e70 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MatchTerm.md @@ -0,0 +1,204 @@ +--- +id: v2025-match-term +title: MatchTerm +pagination_label: MatchTerm +sidebar_label: MatchTerm +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MatchTerm', 'V2025MatchTerm'] +slug: /tools/sdk/go/v2025/models/match-term +tags: ['SDK', 'Software Development Kit', 'MatchTerm', 'V2025MatchTerm'] +--- + +# MatchTerm + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The attribute name | [optional] +**Value** | Pointer to **string** | The attribute value | [optional] +**Op** | Pointer to **string** | The operator between name and value | [optional] +**Container** | Pointer to **bool** | If it is a container or a real match term | [optional] [default to false] +**And** | Pointer to **bool** | If it is AND logical operator for the children match terms | [optional] [default to false] +**Children** | Pointer to **[]map[string]interface{}** | The children under this match term | [optional] + +## Methods + +### NewMatchTerm + +`func NewMatchTerm() *MatchTerm` + +NewMatchTerm instantiates a new MatchTerm 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 + +### NewMatchTermWithDefaults + +`func NewMatchTermWithDefaults() *MatchTerm` + +NewMatchTermWithDefaults instantiates a new MatchTerm 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 + +### GetName + +`func (o *MatchTerm) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MatchTerm) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MatchTerm) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MatchTerm) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValue + +`func (o *MatchTerm) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *MatchTerm) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *MatchTerm) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *MatchTerm) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetOp + +`func (o *MatchTerm) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *MatchTerm) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *MatchTerm) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *MatchTerm) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetContainer + +`func (o *MatchTerm) GetContainer() bool` + +GetContainer returns the Container field if non-nil, zero value otherwise. + +### GetContainerOk + +`func (o *MatchTerm) GetContainerOk() (*bool, bool)` + +GetContainerOk returns a tuple with the Container field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainer + +`func (o *MatchTerm) SetContainer(v bool)` + +SetContainer sets Container field to given value. + +### HasContainer + +`func (o *MatchTerm) HasContainer() bool` + +HasContainer returns a boolean if a field has been set. + +### GetAnd + +`func (o *MatchTerm) GetAnd() bool` + +GetAnd returns the And field if non-nil, zero value otherwise. + +### GetAndOk + +`func (o *MatchTerm) GetAndOk() (*bool, bool)` + +GetAndOk returns a tuple with the And field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnd + +`func (o *MatchTerm) SetAnd(v bool)` + +SetAnd sets And field to given value. + +### HasAnd + +`func (o *MatchTerm) HasAnd() bool` + +HasAnd returns a boolean if a field has been set. + +### GetChildren + +`func (o *MatchTerm) GetChildren() []map[string]interface{}` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *MatchTerm) GetChildrenOk() (*[]map[string]interface{}, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *MatchTerm) SetChildren(v []map[string]interface{})` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *MatchTerm) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *MatchTerm) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *MatchTerm) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Medium.md b/docs/tools/sdk/go/Reference/V2025/Models/Medium.md new file mode 100644 index 000000000..77bdc5ceb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Medium.md @@ -0,0 +1,27 @@ +--- +id: v2025-medium +title: Medium +pagination_label: Medium +sidebar_label: Medium +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Medium', 'V2025Medium'] +slug: /tools/sdk/go/v2025/models/medium +tags: ['SDK', 'Software Development Kit', 'Medium', 'V2025Medium'] +--- + +# Medium + +## Enum + + +* `EMAIL` (value: `"EMAIL"`) + +* `SMS` (value: `"SMS"`) + +* `PHONE` (value: `"PHONE"`) + +* `SLACK` (value: `"SLACK"`) + +* `TEAMS` (value: `"TEAMS"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MembershipType.md b/docs/tools/sdk/go/Reference/V2025/Models/MembershipType.md new file mode 100644 index 000000000..b7e207f4c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MembershipType.md @@ -0,0 +1,23 @@ +--- +id: v2025-membership-type +title: MembershipType +pagination_label: MembershipType +sidebar_label: MembershipType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MembershipType', 'V2025MembershipType'] +slug: /tools/sdk/go/v2025/models/membership-type +tags: ['SDK', 'Software Development Kit', 'MembershipType', 'V2025MembershipType'] +--- + +# MembershipType + +## Enum + + +* `ALL` (value: `"ALL"`) + +* `FILTER` (value: `"FILTER"`) + +* `SELECTION` (value: `"SELECTION"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MetricAggregation.md b/docs/tools/sdk/go/Reference/V2025/Models/MetricAggregation.md new file mode 100644 index 000000000..760b2383e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MetricAggregation.md @@ -0,0 +1,106 @@ +--- +id: v2025-metric-aggregation +title: MetricAggregation +pagination_label: MetricAggregation +sidebar_label: MetricAggregation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MetricAggregation', 'V2025MetricAggregation'] +slug: /tools/sdk/go/v2025/models/metric-aggregation +tags: ['SDK', 'Software Development Kit', 'MetricAggregation', 'V2025MetricAggregation'] +--- + +# MetricAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the metric aggregate to be included in the result. If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. | +**Type** | Pointer to [**MetricType**](metric-type) | | [optional] [default to METRICTYPE_UNIQUE_COUNT] +**Field** | **string** | The field the calculation is performed on. Prefix the field name with '@' to reference a nested object. | + +## Methods + +### NewMetricAggregation + +`func NewMetricAggregation(name string, field string, ) *MetricAggregation` + +NewMetricAggregation instantiates a new MetricAggregation 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 + +### NewMetricAggregationWithDefaults + +`func NewMetricAggregationWithDefaults() *MetricAggregation` + +NewMetricAggregationWithDefaults instantiates a new MetricAggregation 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 + +### GetName + +`func (o *MetricAggregation) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MetricAggregation) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MetricAggregation) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *MetricAggregation) GetType() MetricType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MetricAggregation) GetTypeOk() (*MetricType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MetricAggregation) SetType(v MetricType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MetricAggregation) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetField + +`func (o *MetricAggregation) GetField() string` + +GetField returns the Field field if non-nil, zero value otherwise. + +### GetFieldOk + +`func (o *MetricAggregation) GetFieldOk() (*string, bool)` + +GetFieldOk returns a tuple with the Field field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetField + +`func (o *MetricAggregation) SetField(v string)` + +SetField sets Field field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MetricResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/MetricResponse.md new file mode 100644 index 000000000..2974ab6a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MetricResponse.md @@ -0,0 +1,90 @@ +--- +id: v2025-metric-response +title: MetricResponse +pagination_label: MetricResponse +sidebar_label: MetricResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MetricResponse', 'V2025MetricResponse'] +slug: /tools/sdk/go/v2025/models/metric-response +tags: ['SDK', 'Software Development Kit', 'MetricResponse', 'V2025MetricResponse'] +--- + +# MetricResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | the name of metric | [optional] +**Value** | Pointer to **float32** | the value associated to the metric | [optional] + +## Methods + +### NewMetricResponse + +`func NewMetricResponse() *MetricResponse` + +NewMetricResponse instantiates a new MetricResponse 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 + +### NewMetricResponseWithDefaults + +`func NewMetricResponseWithDefaults() *MetricResponse` + +NewMetricResponseWithDefaults instantiates a new MetricResponse 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 + +### GetName + +`func (o *MetricResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MetricResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MetricResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MetricResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValue + +`func (o *MetricResponse) GetValue() float32` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *MetricResponse) GetValueOk() (*float32, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *MetricResponse) SetValue(v float32)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *MetricResponse) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MetricType.md b/docs/tools/sdk/go/Reference/V2025/Models/MetricType.md new file mode 100644 index 000000000..9424c8148 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MetricType.md @@ -0,0 +1,31 @@ +--- +id: v2025-metric-type +title: MetricType +pagination_label: MetricType +sidebar_label: MetricType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MetricType', 'V2025MetricType'] +slug: /tools/sdk/go/v2025/models/metric-type +tags: ['SDK', 'Software Development Kit', 'MetricType', 'V2025MetricType'] +--- + +# MetricType + +## Enum + + +* `COUNT` (value: `"COUNT"`) + +* `UNIQUE_COUNT` (value: `"UNIQUE_COUNT"`) + +* `AVG` (value: `"AVG"`) + +* `SUM` (value: `"SUM"`) + +* `MEDIAN` (value: `"MEDIAN"`) + +* `MIN` (value: `"MIN"`) + +* `MAX` (value: `"MAX"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MfaConfigTestResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/MfaConfigTestResponse.md new file mode 100644 index 000000000..9456437a2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MfaConfigTestResponse.md @@ -0,0 +1,90 @@ +--- +id: v2025-mfa-config-test-response +title: MfaConfigTestResponse +pagination_label: MfaConfigTestResponse +sidebar_label: MfaConfigTestResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MfaConfigTestResponse', 'V2025MfaConfigTestResponse'] +slug: /tools/sdk/go/v2025/models/mfa-config-test-response +tags: ['SDK', 'Software Development Kit', 'MfaConfigTestResponse', 'V2025MfaConfigTestResponse'] +--- + +# MfaConfigTestResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **string** | The configuration test result. | [optional] [readonly] +**Error** | Pointer to **string** | The error message to indicate the failure of configuration test. | [optional] [readonly] + +## Methods + +### NewMfaConfigTestResponse + +`func NewMfaConfigTestResponse() *MfaConfigTestResponse` + +NewMfaConfigTestResponse instantiates a new MfaConfigTestResponse 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 + +### NewMfaConfigTestResponseWithDefaults + +`func NewMfaConfigTestResponseWithDefaults() *MfaConfigTestResponse` + +NewMfaConfigTestResponseWithDefaults instantiates a new MfaConfigTestResponse 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 + +### GetState + +`func (o *MfaConfigTestResponse) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *MfaConfigTestResponse) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *MfaConfigTestResponse) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *MfaConfigTestResponse) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetError + +`func (o *MfaConfigTestResponse) GetError() string` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *MfaConfigTestResponse) GetErrorOk() (*string, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *MfaConfigTestResponse) SetError(v string)` + +SetError sets Error field to given value. + +### HasError + +`func (o *MfaConfigTestResponse) HasError() bool` + +HasError returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MfaDuoConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/MfaDuoConfig.md new file mode 100644 index 000000000..15299be10 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MfaDuoConfig.md @@ -0,0 +1,244 @@ +--- +id: v2025-mfa-duo-config +title: MfaDuoConfig +pagination_label: MfaDuoConfig +sidebar_label: MfaDuoConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MfaDuoConfig', 'V2025MfaDuoConfig'] +slug: /tools/sdk/go/v2025/models/mfa-duo-config +tags: ['SDK', 'Software Development Kit', 'MfaDuoConfig', 'V2025MfaDuoConfig'] +--- + +# MfaDuoConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MfaMethod** | Pointer to **NullableString** | Mfa method name | [optional] +**Enabled** | Pointer to **bool** | If MFA method is enabled. | [optional] [default to false] +**Host** | Pointer to **NullableString** | The server host name or IP address of the MFA provider. | [optional] +**AccessKey** | Pointer to **NullableString** | The secret key for authenticating requests to the MFA provider. | [optional] +**IdentityAttribute** | Pointer to **NullableString** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] +**ConfigProperties** | Pointer to **map[string]interface{}** | A map with additional config properties for the given MFA method - duo-web. | [optional] + +## Methods + +### NewMfaDuoConfig + +`func NewMfaDuoConfig() *MfaDuoConfig` + +NewMfaDuoConfig instantiates a new MfaDuoConfig 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 + +### NewMfaDuoConfigWithDefaults + +`func NewMfaDuoConfigWithDefaults() *MfaDuoConfig` + +NewMfaDuoConfigWithDefaults instantiates a new MfaDuoConfig 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 + +### GetMfaMethod + +`func (o *MfaDuoConfig) GetMfaMethod() string` + +GetMfaMethod returns the MfaMethod field if non-nil, zero value otherwise. + +### GetMfaMethodOk + +`func (o *MfaDuoConfig) GetMfaMethodOk() (*string, bool)` + +GetMfaMethodOk returns a tuple with the MfaMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMfaMethod + +`func (o *MfaDuoConfig) SetMfaMethod(v string)` + +SetMfaMethod sets MfaMethod field to given value. + +### HasMfaMethod + +`func (o *MfaDuoConfig) HasMfaMethod() bool` + +HasMfaMethod returns a boolean if a field has been set. + +### SetMfaMethodNil + +`func (o *MfaDuoConfig) SetMfaMethodNil(b bool)` + + SetMfaMethodNil sets the value for MfaMethod to be an explicit nil + +### UnsetMfaMethod +`func (o *MfaDuoConfig) UnsetMfaMethod()` + +UnsetMfaMethod ensures that no value is present for MfaMethod, not even an explicit nil +### GetEnabled + +`func (o *MfaDuoConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *MfaDuoConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *MfaDuoConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *MfaDuoConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetHost + +`func (o *MfaDuoConfig) GetHost() string` + +GetHost returns the Host field if non-nil, zero value otherwise. + +### GetHostOk + +`func (o *MfaDuoConfig) GetHostOk() (*string, bool)` + +GetHostOk returns a tuple with the Host field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHost + +`func (o *MfaDuoConfig) SetHost(v string)` + +SetHost sets Host field to given value. + +### HasHost + +`func (o *MfaDuoConfig) HasHost() bool` + +HasHost returns a boolean if a field has been set. + +### SetHostNil + +`func (o *MfaDuoConfig) SetHostNil(b bool)` + + SetHostNil sets the value for Host to be an explicit nil + +### UnsetHost +`func (o *MfaDuoConfig) UnsetHost()` + +UnsetHost ensures that no value is present for Host, not even an explicit nil +### GetAccessKey + +`func (o *MfaDuoConfig) GetAccessKey() string` + +GetAccessKey returns the AccessKey field if non-nil, zero value otherwise. + +### GetAccessKeyOk + +`func (o *MfaDuoConfig) GetAccessKeyOk() (*string, bool)` + +GetAccessKeyOk returns a tuple with the AccessKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessKey + +`func (o *MfaDuoConfig) SetAccessKey(v string)` + +SetAccessKey sets AccessKey field to given value. + +### HasAccessKey + +`func (o *MfaDuoConfig) HasAccessKey() bool` + +HasAccessKey returns a boolean if a field has been set. + +### SetAccessKeyNil + +`func (o *MfaDuoConfig) SetAccessKeyNil(b bool)` + + SetAccessKeyNil sets the value for AccessKey to be an explicit nil + +### UnsetAccessKey +`func (o *MfaDuoConfig) UnsetAccessKey()` + +UnsetAccessKey ensures that no value is present for AccessKey, not even an explicit nil +### GetIdentityAttribute + +`func (o *MfaDuoConfig) GetIdentityAttribute() string` + +GetIdentityAttribute returns the IdentityAttribute field if non-nil, zero value otherwise. + +### GetIdentityAttributeOk + +`func (o *MfaDuoConfig) GetIdentityAttributeOk() (*string, bool)` + +GetIdentityAttributeOk returns a tuple with the IdentityAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttribute + +`func (o *MfaDuoConfig) SetIdentityAttribute(v string)` + +SetIdentityAttribute sets IdentityAttribute field to given value. + +### HasIdentityAttribute + +`func (o *MfaDuoConfig) HasIdentityAttribute() bool` + +HasIdentityAttribute returns a boolean if a field has been set. + +### SetIdentityAttributeNil + +`func (o *MfaDuoConfig) SetIdentityAttributeNil(b bool)` + + SetIdentityAttributeNil sets the value for IdentityAttribute to be an explicit nil + +### UnsetIdentityAttribute +`func (o *MfaDuoConfig) UnsetIdentityAttribute()` + +UnsetIdentityAttribute ensures that no value is present for IdentityAttribute, not even an explicit nil +### GetConfigProperties + +`func (o *MfaDuoConfig) GetConfigProperties() map[string]interface{}` + +GetConfigProperties returns the ConfigProperties field if non-nil, zero value otherwise. + +### GetConfigPropertiesOk + +`func (o *MfaDuoConfig) GetConfigPropertiesOk() (*map[string]interface{}, bool)` + +GetConfigPropertiesOk returns a tuple with the ConfigProperties field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigProperties + +`func (o *MfaDuoConfig) SetConfigProperties(v map[string]interface{})` + +SetConfigProperties sets ConfigProperties field to given value. + +### HasConfigProperties + +`func (o *MfaDuoConfig) HasConfigProperties() bool` + +HasConfigProperties returns a boolean if a field has been set. + +### SetConfigPropertiesNil + +`func (o *MfaDuoConfig) SetConfigPropertiesNil(b bool)` + + SetConfigPropertiesNil sets the value for ConfigProperties to be an explicit nil + +### UnsetConfigProperties +`func (o *MfaDuoConfig) UnsetConfigProperties()` + +UnsetConfigProperties ensures that no value is present for ConfigProperties, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MfaOktaConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/MfaOktaConfig.md new file mode 100644 index 000000000..8764ffde2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MfaOktaConfig.md @@ -0,0 +1,208 @@ +--- +id: v2025-mfa-okta-config +title: MfaOktaConfig +pagination_label: MfaOktaConfig +sidebar_label: MfaOktaConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MfaOktaConfig', 'V2025MfaOktaConfig'] +slug: /tools/sdk/go/v2025/models/mfa-okta-config +tags: ['SDK', 'Software Development Kit', 'MfaOktaConfig', 'V2025MfaOktaConfig'] +--- + +# MfaOktaConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MfaMethod** | Pointer to **NullableString** | Mfa method name | [optional] +**Enabled** | Pointer to **bool** | If MFA method is enabled. | [optional] [default to false] +**Host** | Pointer to **NullableString** | The server host name or IP address of the MFA provider. | [optional] +**AccessKey** | Pointer to **NullableString** | The secret key for authenticating requests to the MFA provider. | [optional] +**IdentityAttribute** | Pointer to **NullableString** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] + +## Methods + +### NewMfaOktaConfig + +`func NewMfaOktaConfig() *MfaOktaConfig` + +NewMfaOktaConfig instantiates a new MfaOktaConfig 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 + +### NewMfaOktaConfigWithDefaults + +`func NewMfaOktaConfigWithDefaults() *MfaOktaConfig` + +NewMfaOktaConfigWithDefaults instantiates a new MfaOktaConfig 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 + +### GetMfaMethod + +`func (o *MfaOktaConfig) GetMfaMethod() string` + +GetMfaMethod returns the MfaMethod field if non-nil, zero value otherwise. + +### GetMfaMethodOk + +`func (o *MfaOktaConfig) GetMfaMethodOk() (*string, bool)` + +GetMfaMethodOk returns a tuple with the MfaMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMfaMethod + +`func (o *MfaOktaConfig) SetMfaMethod(v string)` + +SetMfaMethod sets MfaMethod field to given value. + +### HasMfaMethod + +`func (o *MfaOktaConfig) HasMfaMethod() bool` + +HasMfaMethod returns a boolean if a field has been set. + +### SetMfaMethodNil + +`func (o *MfaOktaConfig) SetMfaMethodNil(b bool)` + + SetMfaMethodNil sets the value for MfaMethod to be an explicit nil + +### UnsetMfaMethod +`func (o *MfaOktaConfig) UnsetMfaMethod()` + +UnsetMfaMethod ensures that no value is present for MfaMethod, not even an explicit nil +### GetEnabled + +`func (o *MfaOktaConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *MfaOktaConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *MfaOktaConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *MfaOktaConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetHost + +`func (o *MfaOktaConfig) GetHost() string` + +GetHost returns the Host field if non-nil, zero value otherwise. + +### GetHostOk + +`func (o *MfaOktaConfig) GetHostOk() (*string, bool)` + +GetHostOk returns a tuple with the Host field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHost + +`func (o *MfaOktaConfig) SetHost(v string)` + +SetHost sets Host field to given value. + +### HasHost + +`func (o *MfaOktaConfig) HasHost() bool` + +HasHost returns a boolean if a field has been set. + +### SetHostNil + +`func (o *MfaOktaConfig) SetHostNil(b bool)` + + SetHostNil sets the value for Host to be an explicit nil + +### UnsetHost +`func (o *MfaOktaConfig) UnsetHost()` + +UnsetHost ensures that no value is present for Host, not even an explicit nil +### GetAccessKey + +`func (o *MfaOktaConfig) GetAccessKey() string` + +GetAccessKey returns the AccessKey field if non-nil, zero value otherwise. + +### GetAccessKeyOk + +`func (o *MfaOktaConfig) GetAccessKeyOk() (*string, bool)` + +GetAccessKeyOk returns a tuple with the AccessKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessKey + +`func (o *MfaOktaConfig) SetAccessKey(v string)` + +SetAccessKey sets AccessKey field to given value. + +### HasAccessKey + +`func (o *MfaOktaConfig) HasAccessKey() bool` + +HasAccessKey returns a boolean if a field has been set. + +### SetAccessKeyNil + +`func (o *MfaOktaConfig) SetAccessKeyNil(b bool)` + + SetAccessKeyNil sets the value for AccessKey to be an explicit nil + +### UnsetAccessKey +`func (o *MfaOktaConfig) UnsetAccessKey()` + +UnsetAccessKey ensures that no value is present for AccessKey, not even an explicit nil +### GetIdentityAttribute + +`func (o *MfaOktaConfig) GetIdentityAttribute() string` + +GetIdentityAttribute returns the IdentityAttribute field if non-nil, zero value otherwise. + +### GetIdentityAttributeOk + +`func (o *MfaOktaConfig) GetIdentityAttributeOk() (*string, bool)` + +GetIdentityAttributeOk returns a tuple with the IdentityAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttribute + +`func (o *MfaOktaConfig) SetIdentityAttribute(v string)` + +SetIdentityAttribute sets IdentityAttribute field to given value. + +### HasIdentityAttribute + +`func (o *MfaOktaConfig) HasIdentityAttribute() bool` + +HasIdentityAttribute returns a boolean if a field has been set. + +### SetIdentityAttributeNil + +`func (o *MfaOktaConfig) SetIdentityAttributeNil(b bool)` + + SetIdentityAttributeNil sets the value for IdentityAttribute to be an explicit nil + +### UnsetIdentityAttribute +`func (o *MfaOktaConfig) UnsetIdentityAttribute()` + +UnsetIdentityAttribute ensures that no value is present for IdentityAttribute, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationTemplateType.md b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationTemplateType.md new file mode 100644 index 000000000..57bd26be6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationTemplateType.md @@ -0,0 +1,106 @@ +--- +id: v2025-multi-host-integration-template-type +title: MultiHostIntegrationTemplateType +pagination_label: MultiHostIntegrationTemplateType +sidebar_label: MultiHostIntegrationTemplateType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationTemplateType', 'V2025MultiHostIntegrationTemplateType'] +slug: /tools/sdk/go/v2025/models/multi-host-integration-template-type +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationTemplateType', 'V2025MultiHostIntegrationTemplateType'] +--- + +# MultiHostIntegrationTemplateType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | This is the name of the type. | [optional] +**Type** | **string** | This is the type value for the type. | +**ScriptName** | **string** | This is the scriptName attribute value for the type. | + +## Methods + +### NewMultiHostIntegrationTemplateType + +`func NewMultiHostIntegrationTemplateType(type_ string, scriptName string, ) *MultiHostIntegrationTemplateType` + +NewMultiHostIntegrationTemplateType instantiates a new MultiHostIntegrationTemplateType 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 + +### NewMultiHostIntegrationTemplateTypeWithDefaults + +`func NewMultiHostIntegrationTemplateTypeWithDefaults() *MultiHostIntegrationTemplateType` + +NewMultiHostIntegrationTemplateTypeWithDefaults instantiates a new MultiHostIntegrationTemplateType 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 + +### GetName + +`func (o *MultiHostIntegrationTemplateType) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrationTemplateType) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrationTemplateType) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MultiHostIntegrationTemplateType) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *MultiHostIntegrationTemplateType) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostIntegrationTemplateType) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostIntegrationTemplateType) SetType(v string)` + +SetType sets Type field to given value. + + +### GetScriptName + +`func (o *MultiHostIntegrationTemplateType) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *MultiHostIntegrationTemplateType) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *MultiHostIntegrationTemplateType) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrations.md b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrations.md new file mode 100644 index 000000000..8b2982551 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrations.md @@ -0,0 +1,935 @@ +--- +id: v2025-multi-host-integrations +title: MultiHostIntegrations +pagination_label: MultiHostIntegrations +sidebar_label: MultiHostIntegrations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrations', 'V2025MultiHostIntegrations'] +slug: /tools/sdk/go/v2025/models/multi-host-integrations +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrations', 'V2025MultiHostIntegrations'] +--- + +# MultiHostIntegrations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Multi-Host Integration ID. | [readonly] +**Name** | **string** | Multi-Host Integration's human-readable name. | +**Description** | **string** | Multi-Host Integration's human-readable description. | +**Owner** | [**SourceOwner**](source-owner) | | +**Cluster** | Pointer to [**NullableSourceCluster**](source-cluster) | | [optional] +**AccountCorrelationConfig** | Pointer to [**NullableSourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional] +**AccountCorrelationRule** | Pointer to [**NullableSourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional] +**ManagerCorrelationMapping** | Pointer to [**SourceManagerCorrelationMapping**](source-manager-correlation-mapping) | | [optional] +**ManagerCorrelationRule** | Pointer to [**NullableSourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional] +**BeforeProvisioningRule** | Pointer to [**NullableMultiHostIntegrationsBeforeProvisioningRule**](multi-host-integrations-before-provisioning-rule) | | [optional] +**Schemas** | Pointer to [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional] +**PasswordPolicies** | Pointer to [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**Features** | Pointer to **[]string** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Type** | Pointer to **string** | Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Connector** | **string** | Connector script name. | +**ConnectorClass** | Pointer to **string** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**ConnectorAttributes** | Pointer to [**MultiHostIntegrationsConnectorAttributes**](multi-host-integrations-connector-attributes) | | [optional] +**DeleteThreshold** | Pointer to **int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**Authoritative** | Pointer to **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to false] +**ManagementWorkgroup** | Pointer to [**NullableSourceManagementWorkgroup**](source-management-workgroup) | | [optional] +**Healthy** | Pointer to **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to false] +**Status** | Pointer to **string** | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**Since** | Pointer to **SailPointTime** | Timestamp that shows when a source health check was last performed. | [optional] +**ConnectorId** | Pointer to **string** | Connector ID | [optional] +**ConnectorName** | Pointer to **string** | Name of the connector that was chosen during source creation. | [optional] +**ConnectionType** | Pointer to **string** | Type of connection (direct or file). | [optional] +**ConnectorImplementationId** | Pointer to **string** | Connector implementation ID. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date-time when the source was last modified. | [optional] +**CredentialProviderEnabled** | Pointer to **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to false] +**Category** | Pointer to **NullableString** | Source category (e.g. null, CredentialProvider). | [optional] +**AccountsFile** | Pointer to [**NullableMultiHostIntegrationsAccountsFile**](multi-host-integrations-accounts-file) | | [optional] + +## Methods + +### NewMultiHostIntegrations + +`func NewMultiHostIntegrations(id string, name string, description string, owner SourceOwner, connector string, ) *MultiHostIntegrations` + +NewMultiHostIntegrations instantiates a new MultiHostIntegrations 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 + +### NewMultiHostIntegrationsWithDefaults + +`func NewMultiHostIntegrationsWithDefaults() *MultiHostIntegrations` + +NewMultiHostIntegrationsWithDefaults instantiates a new MultiHostIntegrations 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 + +### GetId + +`func (o *MultiHostIntegrations) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostIntegrations) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostIntegrations) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *MultiHostIntegrations) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrations) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrations) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *MultiHostIntegrations) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *MultiHostIntegrations) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *MultiHostIntegrations) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetOwner + +`func (o *MultiHostIntegrations) GetOwner() SourceOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *MultiHostIntegrations) GetOwnerOk() (*SourceOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *MultiHostIntegrations) SetOwner(v SourceOwner)` + +SetOwner sets Owner field to given value. + + +### GetCluster + +`func (o *MultiHostIntegrations) GetCluster() SourceCluster` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *MultiHostIntegrations) GetClusterOk() (*SourceCluster, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *MultiHostIntegrations) SetCluster(v SourceCluster)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *MultiHostIntegrations) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### SetClusterNil + +`func (o *MultiHostIntegrations) SetClusterNil(b bool)` + + SetClusterNil sets the value for Cluster to be an explicit nil + +### UnsetCluster +`func (o *MultiHostIntegrations) UnsetCluster()` + +UnsetCluster ensures that no value is present for Cluster, not even an explicit nil +### GetAccountCorrelationConfig + +`func (o *MultiHostIntegrations) GetAccountCorrelationConfig() SourceAccountCorrelationConfig` + +GetAccountCorrelationConfig returns the AccountCorrelationConfig field if non-nil, zero value otherwise. + +### GetAccountCorrelationConfigOk + +`func (o *MultiHostIntegrations) GetAccountCorrelationConfigOk() (*SourceAccountCorrelationConfig, bool)` + +GetAccountCorrelationConfigOk returns a tuple with the AccountCorrelationConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationConfig + +`func (o *MultiHostIntegrations) SetAccountCorrelationConfig(v SourceAccountCorrelationConfig)` + +SetAccountCorrelationConfig sets AccountCorrelationConfig field to given value. + +### HasAccountCorrelationConfig + +`func (o *MultiHostIntegrations) HasAccountCorrelationConfig() bool` + +HasAccountCorrelationConfig returns a boolean if a field has been set. + +### SetAccountCorrelationConfigNil + +`func (o *MultiHostIntegrations) SetAccountCorrelationConfigNil(b bool)` + + SetAccountCorrelationConfigNil sets the value for AccountCorrelationConfig to be an explicit nil + +### UnsetAccountCorrelationConfig +`func (o *MultiHostIntegrations) UnsetAccountCorrelationConfig()` + +UnsetAccountCorrelationConfig ensures that no value is present for AccountCorrelationConfig, not even an explicit nil +### GetAccountCorrelationRule + +`func (o *MultiHostIntegrations) GetAccountCorrelationRule() SourceAccountCorrelationRule` + +GetAccountCorrelationRule returns the AccountCorrelationRule field if non-nil, zero value otherwise. + +### GetAccountCorrelationRuleOk + +`func (o *MultiHostIntegrations) GetAccountCorrelationRuleOk() (*SourceAccountCorrelationRule, bool)` + +GetAccountCorrelationRuleOk returns a tuple with the AccountCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationRule + +`func (o *MultiHostIntegrations) SetAccountCorrelationRule(v SourceAccountCorrelationRule)` + +SetAccountCorrelationRule sets AccountCorrelationRule field to given value. + +### HasAccountCorrelationRule + +`func (o *MultiHostIntegrations) HasAccountCorrelationRule() bool` + +HasAccountCorrelationRule returns a boolean if a field has been set. + +### SetAccountCorrelationRuleNil + +`func (o *MultiHostIntegrations) SetAccountCorrelationRuleNil(b bool)` + + SetAccountCorrelationRuleNil sets the value for AccountCorrelationRule to be an explicit nil + +### UnsetAccountCorrelationRule +`func (o *MultiHostIntegrations) UnsetAccountCorrelationRule()` + +UnsetAccountCorrelationRule ensures that no value is present for AccountCorrelationRule, not even an explicit nil +### GetManagerCorrelationMapping + +`func (o *MultiHostIntegrations) GetManagerCorrelationMapping() SourceManagerCorrelationMapping` + +GetManagerCorrelationMapping returns the ManagerCorrelationMapping field if non-nil, zero value otherwise. + +### GetManagerCorrelationMappingOk + +`func (o *MultiHostIntegrations) GetManagerCorrelationMappingOk() (*SourceManagerCorrelationMapping, bool)` + +GetManagerCorrelationMappingOk returns a tuple with the ManagerCorrelationMapping field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationMapping + +`func (o *MultiHostIntegrations) SetManagerCorrelationMapping(v SourceManagerCorrelationMapping)` + +SetManagerCorrelationMapping sets ManagerCorrelationMapping field to given value. + +### HasManagerCorrelationMapping + +`func (o *MultiHostIntegrations) HasManagerCorrelationMapping() bool` + +HasManagerCorrelationMapping returns a boolean if a field has been set. + +### GetManagerCorrelationRule + +`func (o *MultiHostIntegrations) GetManagerCorrelationRule() SourceManagerCorrelationRule` + +GetManagerCorrelationRule returns the ManagerCorrelationRule field if non-nil, zero value otherwise. + +### GetManagerCorrelationRuleOk + +`func (o *MultiHostIntegrations) GetManagerCorrelationRuleOk() (*SourceManagerCorrelationRule, bool)` + +GetManagerCorrelationRuleOk returns a tuple with the ManagerCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationRule + +`func (o *MultiHostIntegrations) SetManagerCorrelationRule(v SourceManagerCorrelationRule)` + +SetManagerCorrelationRule sets ManagerCorrelationRule field to given value. + +### HasManagerCorrelationRule + +`func (o *MultiHostIntegrations) HasManagerCorrelationRule() bool` + +HasManagerCorrelationRule returns a boolean if a field has been set. + +### SetManagerCorrelationRuleNil + +`func (o *MultiHostIntegrations) SetManagerCorrelationRuleNil(b bool)` + + SetManagerCorrelationRuleNil sets the value for ManagerCorrelationRule to be an explicit nil + +### UnsetManagerCorrelationRule +`func (o *MultiHostIntegrations) UnsetManagerCorrelationRule()` + +UnsetManagerCorrelationRule ensures that no value is present for ManagerCorrelationRule, not even an explicit nil +### GetBeforeProvisioningRule + +`func (o *MultiHostIntegrations) GetBeforeProvisioningRule() MultiHostIntegrationsBeforeProvisioningRule` + +GetBeforeProvisioningRule returns the BeforeProvisioningRule field if non-nil, zero value otherwise. + +### GetBeforeProvisioningRuleOk + +`func (o *MultiHostIntegrations) GetBeforeProvisioningRuleOk() (*MultiHostIntegrationsBeforeProvisioningRule, bool)` + +GetBeforeProvisioningRuleOk returns a tuple with the BeforeProvisioningRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBeforeProvisioningRule + +`func (o *MultiHostIntegrations) SetBeforeProvisioningRule(v MultiHostIntegrationsBeforeProvisioningRule)` + +SetBeforeProvisioningRule sets BeforeProvisioningRule field to given value. + +### HasBeforeProvisioningRule + +`func (o *MultiHostIntegrations) HasBeforeProvisioningRule() bool` + +HasBeforeProvisioningRule returns a boolean if a field has been set. + +### SetBeforeProvisioningRuleNil + +`func (o *MultiHostIntegrations) SetBeforeProvisioningRuleNil(b bool)` + + SetBeforeProvisioningRuleNil sets the value for BeforeProvisioningRule to be an explicit nil + +### UnsetBeforeProvisioningRule +`func (o *MultiHostIntegrations) UnsetBeforeProvisioningRule()` + +UnsetBeforeProvisioningRule ensures that no value is present for BeforeProvisioningRule, not even an explicit nil +### GetSchemas + +`func (o *MultiHostIntegrations) GetSchemas() []SourceSchemasInner` + +GetSchemas returns the Schemas field if non-nil, zero value otherwise. + +### GetSchemasOk + +`func (o *MultiHostIntegrations) GetSchemasOk() (*[]SourceSchemasInner, bool)` + +GetSchemasOk returns a tuple with the Schemas field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchemas + +`func (o *MultiHostIntegrations) SetSchemas(v []SourceSchemasInner)` + +SetSchemas sets Schemas field to given value. + +### HasSchemas + +`func (o *MultiHostIntegrations) HasSchemas() bool` + +HasSchemas returns a boolean if a field has been set. + +### GetPasswordPolicies + +`func (o *MultiHostIntegrations) GetPasswordPolicies() []SourcePasswordPoliciesInner` + +GetPasswordPolicies returns the PasswordPolicies field if non-nil, zero value otherwise. + +### GetPasswordPoliciesOk + +`func (o *MultiHostIntegrations) GetPasswordPoliciesOk() (*[]SourcePasswordPoliciesInner, bool)` + +GetPasswordPoliciesOk returns a tuple with the PasswordPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicies + +`func (o *MultiHostIntegrations) SetPasswordPolicies(v []SourcePasswordPoliciesInner)` + +SetPasswordPolicies sets PasswordPolicies field to given value. + +### HasPasswordPolicies + +`func (o *MultiHostIntegrations) HasPasswordPolicies() bool` + +HasPasswordPolicies returns a boolean if a field has been set. + +### SetPasswordPoliciesNil + +`func (o *MultiHostIntegrations) SetPasswordPoliciesNil(b bool)` + + SetPasswordPoliciesNil sets the value for PasswordPolicies to be an explicit nil + +### UnsetPasswordPolicies +`func (o *MultiHostIntegrations) UnsetPasswordPolicies()` + +UnsetPasswordPolicies ensures that no value is present for PasswordPolicies, not even an explicit nil +### GetFeatures + +`func (o *MultiHostIntegrations) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *MultiHostIntegrations) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *MultiHostIntegrations) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *MultiHostIntegrations) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### GetType + +`func (o *MultiHostIntegrations) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostIntegrations) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostIntegrations) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MultiHostIntegrations) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConnector + +`func (o *MultiHostIntegrations) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *MultiHostIntegrations) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *MultiHostIntegrations) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetConnectorClass + +`func (o *MultiHostIntegrations) GetConnectorClass() string` + +GetConnectorClass returns the ConnectorClass field if non-nil, zero value otherwise. + +### GetConnectorClassOk + +`func (o *MultiHostIntegrations) GetConnectorClassOk() (*string, bool)` + +GetConnectorClassOk returns a tuple with the ConnectorClass field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorClass + +`func (o *MultiHostIntegrations) SetConnectorClass(v string)` + +SetConnectorClass sets ConnectorClass field to given value. + +### HasConnectorClass + +`func (o *MultiHostIntegrations) HasConnectorClass() bool` + +HasConnectorClass returns a boolean if a field has been set. + +### GetConnectorAttributes + +`func (o *MultiHostIntegrations) GetConnectorAttributes() MultiHostIntegrationsConnectorAttributes` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *MultiHostIntegrations) GetConnectorAttributesOk() (*MultiHostIntegrationsConnectorAttributes, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *MultiHostIntegrations) SetConnectorAttributes(v MultiHostIntegrationsConnectorAttributes)` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + +### HasConnectorAttributes + +`func (o *MultiHostIntegrations) HasConnectorAttributes() bool` + +HasConnectorAttributes returns a boolean if a field has been set. + +### GetDeleteThreshold + +`func (o *MultiHostIntegrations) GetDeleteThreshold() int32` + +GetDeleteThreshold returns the DeleteThreshold field if non-nil, zero value otherwise. + +### GetDeleteThresholdOk + +`func (o *MultiHostIntegrations) GetDeleteThresholdOk() (*int32, bool)` + +GetDeleteThresholdOk returns a tuple with the DeleteThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteThreshold + +`func (o *MultiHostIntegrations) SetDeleteThreshold(v int32)` + +SetDeleteThreshold sets DeleteThreshold field to given value. + +### HasDeleteThreshold + +`func (o *MultiHostIntegrations) HasDeleteThreshold() bool` + +HasDeleteThreshold returns a boolean if a field has been set. + +### GetAuthoritative + +`func (o *MultiHostIntegrations) GetAuthoritative() bool` + +GetAuthoritative returns the Authoritative field if non-nil, zero value otherwise. + +### GetAuthoritativeOk + +`func (o *MultiHostIntegrations) GetAuthoritativeOk() (*bool, bool)` + +GetAuthoritativeOk returns a tuple with the Authoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritative + +`func (o *MultiHostIntegrations) SetAuthoritative(v bool)` + +SetAuthoritative sets Authoritative field to given value. + +### HasAuthoritative + +`func (o *MultiHostIntegrations) HasAuthoritative() bool` + +HasAuthoritative returns a boolean if a field has been set. + +### GetManagementWorkgroup + +`func (o *MultiHostIntegrations) GetManagementWorkgroup() SourceManagementWorkgroup` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *MultiHostIntegrations) GetManagementWorkgroupOk() (*SourceManagementWorkgroup, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *MultiHostIntegrations) SetManagementWorkgroup(v SourceManagementWorkgroup)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *MultiHostIntegrations) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### SetManagementWorkgroupNil + +`func (o *MultiHostIntegrations) SetManagementWorkgroupNil(b bool)` + + SetManagementWorkgroupNil sets the value for ManagementWorkgroup to be an explicit nil + +### UnsetManagementWorkgroup +`func (o *MultiHostIntegrations) UnsetManagementWorkgroup()` + +UnsetManagementWorkgroup ensures that no value is present for ManagementWorkgroup, not even an explicit nil +### GetHealthy + +`func (o *MultiHostIntegrations) GetHealthy() bool` + +GetHealthy returns the Healthy field if non-nil, zero value otherwise. + +### GetHealthyOk + +`func (o *MultiHostIntegrations) GetHealthyOk() (*bool, bool)` + +GetHealthyOk returns a tuple with the Healthy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthy + +`func (o *MultiHostIntegrations) SetHealthy(v bool)` + +SetHealthy sets Healthy field to given value. + +### HasHealthy + +`func (o *MultiHostIntegrations) HasHealthy() bool` + +HasHealthy returns a boolean if a field has been set. + +### GetStatus + +`func (o *MultiHostIntegrations) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *MultiHostIntegrations) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *MultiHostIntegrations) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *MultiHostIntegrations) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSince + +`func (o *MultiHostIntegrations) GetSince() SailPointTime` + +GetSince returns the Since field if non-nil, zero value otherwise. + +### GetSinceOk + +`func (o *MultiHostIntegrations) GetSinceOk() (*SailPointTime, bool)` + +GetSinceOk returns a tuple with the Since field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSince + +`func (o *MultiHostIntegrations) SetSince(v SailPointTime)` + +SetSince sets Since field to given value. + +### HasSince + +`func (o *MultiHostIntegrations) HasSince() bool` + +HasSince returns a boolean if a field has been set. + +### GetConnectorId + +`func (o *MultiHostIntegrations) GetConnectorId() string` + +GetConnectorId returns the ConnectorId field if non-nil, zero value otherwise. + +### GetConnectorIdOk + +`func (o *MultiHostIntegrations) GetConnectorIdOk() (*string, bool)` + +GetConnectorIdOk returns a tuple with the ConnectorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorId + +`func (o *MultiHostIntegrations) SetConnectorId(v string)` + +SetConnectorId sets ConnectorId field to given value. + +### HasConnectorId + +`func (o *MultiHostIntegrations) HasConnectorId() bool` + +HasConnectorId returns a boolean if a field has been set. + +### GetConnectorName + +`func (o *MultiHostIntegrations) GetConnectorName() string` + +GetConnectorName returns the ConnectorName field if non-nil, zero value otherwise. + +### GetConnectorNameOk + +`func (o *MultiHostIntegrations) GetConnectorNameOk() (*string, bool)` + +GetConnectorNameOk returns a tuple with the ConnectorName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorName + +`func (o *MultiHostIntegrations) SetConnectorName(v string)` + +SetConnectorName sets ConnectorName field to given value. + +### HasConnectorName + +`func (o *MultiHostIntegrations) HasConnectorName() bool` + +HasConnectorName returns a boolean if a field has been set. + +### GetConnectionType + +`func (o *MultiHostIntegrations) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *MultiHostIntegrations) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *MultiHostIntegrations) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *MultiHostIntegrations) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + +### GetConnectorImplementationId + +`func (o *MultiHostIntegrations) GetConnectorImplementationId() string` + +GetConnectorImplementationId returns the ConnectorImplementationId field if non-nil, zero value otherwise. + +### GetConnectorImplementationIdOk + +`func (o *MultiHostIntegrations) GetConnectorImplementationIdOk() (*string, bool)` + +GetConnectorImplementationIdOk returns a tuple with the ConnectorImplementationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorImplementationId + +`func (o *MultiHostIntegrations) SetConnectorImplementationId(v string)` + +SetConnectorImplementationId sets ConnectorImplementationId field to given value. + +### HasConnectorImplementationId + +`func (o *MultiHostIntegrations) HasConnectorImplementationId() bool` + +HasConnectorImplementationId returns a boolean if a field has been set. + +### GetCreated + +`func (o *MultiHostIntegrations) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MultiHostIntegrations) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MultiHostIntegrations) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MultiHostIntegrations) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MultiHostIntegrations) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MultiHostIntegrations) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MultiHostIntegrations) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MultiHostIntegrations) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCredentialProviderEnabled + +`func (o *MultiHostIntegrations) GetCredentialProviderEnabled() bool` + +GetCredentialProviderEnabled returns the CredentialProviderEnabled field if non-nil, zero value otherwise. + +### GetCredentialProviderEnabledOk + +`func (o *MultiHostIntegrations) GetCredentialProviderEnabledOk() (*bool, bool)` + +GetCredentialProviderEnabledOk returns a tuple with the CredentialProviderEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialProviderEnabled + +`func (o *MultiHostIntegrations) SetCredentialProviderEnabled(v bool)` + +SetCredentialProviderEnabled sets CredentialProviderEnabled field to given value. + +### HasCredentialProviderEnabled + +`func (o *MultiHostIntegrations) HasCredentialProviderEnabled() bool` + +HasCredentialProviderEnabled returns a boolean if a field has been set. + +### GetCategory + +`func (o *MultiHostIntegrations) GetCategory() string` + +GetCategory returns the Category field if non-nil, zero value otherwise. + +### GetCategoryOk + +`func (o *MultiHostIntegrations) GetCategoryOk() (*string, bool)` + +GetCategoryOk returns a tuple with the Category field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCategory + +`func (o *MultiHostIntegrations) SetCategory(v string)` + +SetCategory sets Category field to given value. + +### HasCategory + +`func (o *MultiHostIntegrations) HasCategory() bool` + +HasCategory returns a boolean if a field has been set. + +### SetCategoryNil + +`func (o *MultiHostIntegrations) SetCategoryNil(b bool)` + + SetCategoryNil sets the value for Category to be an explicit nil + +### UnsetCategory +`func (o *MultiHostIntegrations) UnsetCategory()` + +UnsetCategory ensures that no value is present for Category, not even an explicit nil +### GetAccountsFile + +`func (o *MultiHostIntegrations) GetAccountsFile() MultiHostIntegrationsAccountsFile` + +GetAccountsFile returns the AccountsFile field if non-nil, zero value otherwise. + +### GetAccountsFileOk + +`func (o *MultiHostIntegrations) GetAccountsFileOk() (*MultiHostIntegrationsAccountsFile, bool)` + +GetAccountsFileOk returns a tuple with the AccountsFile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountsFile + +`func (o *MultiHostIntegrations) SetAccountsFile(v MultiHostIntegrationsAccountsFile)` + +SetAccountsFile sets AccountsFile field to given value. + +### HasAccountsFile + +`func (o *MultiHostIntegrations) HasAccountsFile() bool` + +HasAccountsFile returns a boolean if a field has been set. + +### SetAccountsFileNil + +`func (o *MultiHostIntegrations) SetAccountsFileNil(b bool)` + + SetAccountsFileNil sets the value for AccountsFile to be an explicit nil + +### UnsetAccountsFile +`func (o *MultiHostIntegrations) UnsetAccountsFile()` + +UnsetAccountsFile ensures that no value is present for AccountsFile, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsAccountsFile.md b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsAccountsFile.md new file mode 100644 index 000000000..3440e331a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsAccountsFile.md @@ -0,0 +1,168 @@ +--- +id: v2025-multi-host-integrations-accounts-file +title: MultiHostIntegrationsAccountsFile +pagination_label: MultiHostIntegrationsAccountsFile +sidebar_label: MultiHostIntegrationsAccountsFile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsAccountsFile', 'V2025MultiHostIntegrationsAccountsFile'] +slug: /tools/sdk/go/v2025/models/multi-host-integrations-accounts-file +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsAccountsFile', 'V2025MultiHostIntegrationsAccountsFile'] +--- + +# MultiHostIntegrationsAccountsFile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the accounts file. | [optional] +**Key** | Pointer to **string** | The accounts file key. | [optional] +**UploadTime** | Pointer to **SailPointTime** | Date-time when the file was uploaded | [optional] +**Expiry** | Pointer to **SailPointTime** | Date-time when the accounts file expired. | [optional] +**Expired** | Pointer to **bool** | If this is true, it indicates that the accounts file has expired. | [optional] [default to false] + +## Methods + +### NewMultiHostIntegrationsAccountsFile + +`func NewMultiHostIntegrationsAccountsFile() *MultiHostIntegrationsAccountsFile` + +NewMultiHostIntegrationsAccountsFile instantiates a new MultiHostIntegrationsAccountsFile 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 + +### NewMultiHostIntegrationsAccountsFileWithDefaults + +`func NewMultiHostIntegrationsAccountsFileWithDefaults() *MultiHostIntegrationsAccountsFile` + +NewMultiHostIntegrationsAccountsFileWithDefaults instantiates a new MultiHostIntegrationsAccountsFile 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 + +### GetName + +`func (o *MultiHostIntegrationsAccountsFile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrationsAccountsFile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrationsAccountsFile) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MultiHostIntegrationsAccountsFile) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetKey + +`func (o *MultiHostIntegrationsAccountsFile) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *MultiHostIntegrationsAccountsFile) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *MultiHostIntegrationsAccountsFile) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *MultiHostIntegrationsAccountsFile) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetUploadTime + +`func (o *MultiHostIntegrationsAccountsFile) GetUploadTime() SailPointTime` + +GetUploadTime returns the UploadTime field if non-nil, zero value otherwise. + +### GetUploadTimeOk + +`func (o *MultiHostIntegrationsAccountsFile) GetUploadTimeOk() (*SailPointTime, bool)` + +GetUploadTimeOk returns a tuple with the UploadTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUploadTime + +`func (o *MultiHostIntegrationsAccountsFile) SetUploadTime(v SailPointTime)` + +SetUploadTime sets UploadTime field to given value. + +### HasUploadTime + +`func (o *MultiHostIntegrationsAccountsFile) HasUploadTime() bool` + +HasUploadTime returns a boolean if a field has been set. + +### GetExpiry + +`func (o *MultiHostIntegrationsAccountsFile) GetExpiry() SailPointTime` + +GetExpiry returns the Expiry field if non-nil, zero value otherwise. + +### GetExpiryOk + +`func (o *MultiHostIntegrationsAccountsFile) GetExpiryOk() (*SailPointTime, bool)` + +GetExpiryOk returns a tuple with the Expiry field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiry + +`func (o *MultiHostIntegrationsAccountsFile) SetExpiry(v SailPointTime)` + +SetExpiry sets Expiry field to given value. + +### HasExpiry + +`func (o *MultiHostIntegrationsAccountsFile) HasExpiry() bool` + +HasExpiry returns a boolean if a field has been set. + +### GetExpired + +`func (o *MultiHostIntegrationsAccountsFile) GetExpired() bool` + +GetExpired returns the Expired field if non-nil, zero value otherwise. + +### GetExpiredOk + +`func (o *MultiHostIntegrationsAccountsFile) GetExpiredOk() (*bool, bool)` + +GetExpiredOk returns a tuple with the Expired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpired + +`func (o *MultiHostIntegrationsAccountsFile) SetExpired(v bool)` + +SetExpired sets Expired field to given value. + +### HasExpired + +`func (o *MultiHostIntegrationsAccountsFile) HasExpired() bool` + +HasExpired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsAggScheduleUpdate.md b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsAggScheduleUpdate.md new file mode 100644 index 000000000..08dc918f8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsAggScheduleUpdate.md @@ -0,0 +1,216 @@ +--- +id: v2025-multi-host-integrations-agg-schedule-update +title: MultiHostIntegrationsAggScheduleUpdate +pagination_label: MultiHostIntegrationsAggScheduleUpdate +sidebar_label: MultiHostIntegrationsAggScheduleUpdate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsAggScheduleUpdate', 'V2025MultiHostIntegrationsAggScheduleUpdate'] +slug: /tools/sdk/go/v2025/models/multi-host-integrations-agg-schedule-update +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsAggScheduleUpdate', 'V2025MultiHostIntegrationsAggScheduleUpdate'] +--- + +# MultiHostIntegrationsAggScheduleUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MultihostId** | **string** | Multi-Host Integration ID. The ID must be unique | +**AggregationGrpId** | **string** | Multi-Host Integration aggregation group ID | +**AggregationGrpName** | **string** | Multi-Host Integration name | +**AggregationCronSchedule** | **string** | Cron expression to schedule aggregation | +**EnableSchedule** | **bool** | Boolean value for Multi-Host Integration aggregation schedule. This specifies if scheduled aggregation is enabled or disabled. | [default to false] +**SourceIdList** | **[]string** | Source IDs of the Multi-Host Integration | +**Created** | Pointer to **SailPointTime** | Created date of Multi-Host Integration aggregation schedule | [optional] +**Modified** | Pointer to **SailPointTime** | Modified date of Multi-Host Integration aggregation schedule | [optional] + +## Methods + +### NewMultiHostIntegrationsAggScheduleUpdate + +`func NewMultiHostIntegrationsAggScheduleUpdate(multihostId string, aggregationGrpId string, aggregationGrpName string, aggregationCronSchedule string, enableSchedule bool, sourceIdList []string, ) *MultiHostIntegrationsAggScheduleUpdate` + +NewMultiHostIntegrationsAggScheduleUpdate instantiates a new MultiHostIntegrationsAggScheduleUpdate 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 + +### NewMultiHostIntegrationsAggScheduleUpdateWithDefaults + +`func NewMultiHostIntegrationsAggScheduleUpdateWithDefaults() *MultiHostIntegrationsAggScheduleUpdate` + +NewMultiHostIntegrationsAggScheduleUpdateWithDefaults instantiates a new MultiHostIntegrationsAggScheduleUpdate 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 + +### GetMultihostId + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetMultihostId() string` + +GetMultihostId returns the MultihostId field if non-nil, zero value otherwise. + +### GetMultihostIdOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetMultihostIdOk() (*string, bool)` + +GetMultihostIdOk returns a tuple with the MultihostId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultihostId + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetMultihostId(v string)` + +SetMultihostId sets MultihostId field to given value. + + +### GetAggregationGrpId + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationGrpId() string` + +GetAggregationGrpId returns the AggregationGrpId field if non-nil, zero value otherwise. + +### GetAggregationGrpIdOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationGrpIdOk() (*string, bool)` + +GetAggregationGrpIdOk returns a tuple with the AggregationGrpId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationGrpId + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetAggregationGrpId(v string)` + +SetAggregationGrpId sets AggregationGrpId field to given value. + + +### GetAggregationGrpName + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationGrpName() string` + +GetAggregationGrpName returns the AggregationGrpName field if non-nil, zero value otherwise. + +### GetAggregationGrpNameOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationGrpNameOk() (*string, bool)` + +GetAggregationGrpNameOk returns a tuple with the AggregationGrpName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationGrpName + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetAggregationGrpName(v string)` + +SetAggregationGrpName sets AggregationGrpName field to given value. + + +### GetAggregationCronSchedule + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationCronSchedule() string` + +GetAggregationCronSchedule returns the AggregationCronSchedule field if non-nil, zero value otherwise. + +### GetAggregationCronScheduleOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetAggregationCronScheduleOk() (*string, bool)` + +GetAggregationCronScheduleOk returns a tuple with the AggregationCronSchedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationCronSchedule + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetAggregationCronSchedule(v string)` + +SetAggregationCronSchedule sets AggregationCronSchedule field to given value. + + +### GetEnableSchedule + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetEnableSchedule() bool` + +GetEnableSchedule returns the EnableSchedule field if non-nil, zero value otherwise. + +### GetEnableScheduleOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetEnableScheduleOk() (*bool, bool)` + +GetEnableScheduleOk returns a tuple with the EnableSchedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnableSchedule + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetEnableSchedule(v bool)` + +SetEnableSchedule sets EnableSchedule field to given value. + + +### GetSourceIdList + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetSourceIdList() []string` + +GetSourceIdList returns the SourceIdList field if non-nil, zero value otherwise. + +### GetSourceIdListOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetSourceIdListOk() (*[]string, bool)` + +GetSourceIdListOk returns a tuple with the SourceIdList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIdList + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetSourceIdList(v []string)` + +SetSourceIdList sets SourceIdList field to given value. + + +### GetCreated + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MultiHostIntegrationsAggScheduleUpdate) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MultiHostIntegrationsAggScheduleUpdate) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MultiHostIntegrationsAggScheduleUpdate) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MultiHostIntegrationsAggScheduleUpdate) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsBeforeProvisioningRule.md b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsBeforeProvisioningRule.md new file mode 100644 index 000000000..2a394b9d1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsBeforeProvisioningRule.md @@ -0,0 +1,116 @@ +--- +id: v2025-multi-host-integrations-before-provisioning-rule +title: MultiHostIntegrationsBeforeProvisioningRule +pagination_label: MultiHostIntegrationsBeforeProvisioningRule +sidebar_label: MultiHostIntegrationsBeforeProvisioningRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsBeforeProvisioningRule', 'V2025MultiHostIntegrationsBeforeProvisioningRule'] +slug: /tools/sdk/go/v2025/models/multi-host-integrations-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsBeforeProvisioningRule', 'V2025MultiHostIntegrationsBeforeProvisioningRule'] +--- + +# MultiHostIntegrationsBeforeProvisioningRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Rule ID. | [optional] +**Name** | Pointer to **string** | Rule's human-readable display name. | [optional] + +## Methods + +### NewMultiHostIntegrationsBeforeProvisioningRule + +`func NewMultiHostIntegrationsBeforeProvisioningRule() *MultiHostIntegrationsBeforeProvisioningRule` + +NewMultiHostIntegrationsBeforeProvisioningRule instantiates a new MultiHostIntegrationsBeforeProvisioningRule 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 + +### NewMultiHostIntegrationsBeforeProvisioningRuleWithDefaults + +`func NewMultiHostIntegrationsBeforeProvisioningRuleWithDefaults() *MultiHostIntegrationsBeforeProvisioningRule` + +NewMultiHostIntegrationsBeforeProvisioningRuleWithDefaults instantiates a new MultiHostIntegrationsBeforeProvisioningRule 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 + +### GetType + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MultiHostIntegrationsBeforeProvisioningRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsConnectorAttributes.md b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsConnectorAttributes.md new file mode 100644 index 000000000..c7d936691 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsConnectorAttributes.md @@ -0,0 +1,220 @@ +--- +id: v2025-multi-host-integrations-connector-attributes +title: MultiHostIntegrationsConnectorAttributes +pagination_label: MultiHostIntegrationsConnectorAttributes +sidebar_label: MultiHostIntegrationsConnectorAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsConnectorAttributes', 'V2025MultiHostIntegrationsConnectorAttributes'] +slug: /tools/sdk/go/v2025/models/multi-host-integrations-connector-attributes +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributes', 'V2025MultiHostIntegrationsConnectorAttributes'] +--- + +# MultiHostIntegrationsConnectorAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxAllowedSources** | Pointer to **int32** | Maximum sources allowed count of a Multi-Host Integration | [optional] +**LastSourceUploadCount** | Pointer to **int32** | Last upload sources count of a Multi-Host Integration | [optional] +**ConnectorFileUploadHistory** | Pointer to [**MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory**](multi-host-integrations-connector-attributes-connector-file-upload-history) | | [optional] +**MultihostStatus** | Pointer to **string** | Multi-Host integration status. | [optional] +**ShowAccountSchema** | Pointer to **bool** | Show account schema | [optional] [default to true] +**ShowEntitlementSchema** | Pointer to **bool** | Show entitlement schema | [optional] [default to true] +**MultiHostAttributes** | Pointer to [**MultiHostIntegrationsConnectorAttributesMultiHostAttributes**](multi-host-integrations-connector-attributes-multi-host-attributes) | | [optional] + +## Methods + +### NewMultiHostIntegrationsConnectorAttributes + +`func NewMultiHostIntegrationsConnectorAttributes() *MultiHostIntegrationsConnectorAttributes` + +NewMultiHostIntegrationsConnectorAttributes instantiates a new MultiHostIntegrationsConnectorAttributes 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 + +### NewMultiHostIntegrationsConnectorAttributesWithDefaults + +`func NewMultiHostIntegrationsConnectorAttributesWithDefaults() *MultiHostIntegrationsConnectorAttributes` + +NewMultiHostIntegrationsConnectorAttributesWithDefaults instantiates a new MultiHostIntegrationsConnectorAttributes 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 + +### GetMaxAllowedSources + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMaxAllowedSources() int32` + +GetMaxAllowedSources returns the MaxAllowedSources field if non-nil, zero value otherwise. + +### GetMaxAllowedSourcesOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMaxAllowedSourcesOk() (*int32, bool)` + +GetMaxAllowedSourcesOk returns a tuple with the MaxAllowedSources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxAllowedSources + +`func (o *MultiHostIntegrationsConnectorAttributes) SetMaxAllowedSources(v int32)` + +SetMaxAllowedSources sets MaxAllowedSources field to given value. + +### HasMaxAllowedSources + +`func (o *MultiHostIntegrationsConnectorAttributes) HasMaxAllowedSources() bool` + +HasMaxAllowedSources returns a boolean if a field has been set. + +### GetLastSourceUploadCount + +`func (o *MultiHostIntegrationsConnectorAttributes) GetLastSourceUploadCount() int32` + +GetLastSourceUploadCount returns the LastSourceUploadCount field if non-nil, zero value otherwise. + +### GetLastSourceUploadCountOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetLastSourceUploadCountOk() (*int32, bool)` + +GetLastSourceUploadCountOk returns a tuple with the LastSourceUploadCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastSourceUploadCount + +`func (o *MultiHostIntegrationsConnectorAttributes) SetLastSourceUploadCount(v int32)` + +SetLastSourceUploadCount sets LastSourceUploadCount field to given value. + +### HasLastSourceUploadCount + +`func (o *MultiHostIntegrationsConnectorAttributes) HasLastSourceUploadCount() bool` + +HasLastSourceUploadCount returns a boolean if a field has been set. + +### GetConnectorFileUploadHistory + +`func (o *MultiHostIntegrationsConnectorAttributes) GetConnectorFileUploadHistory() MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory` + +GetConnectorFileUploadHistory returns the ConnectorFileUploadHistory field if non-nil, zero value otherwise. + +### GetConnectorFileUploadHistoryOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetConnectorFileUploadHistoryOk() (*MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory, bool)` + +GetConnectorFileUploadHistoryOk returns a tuple with the ConnectorFileUploadHistory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorFileUploadHistory + +`func (o *MultiHostIntegrationsConnectorAttributes) SetConnectorFileUploadHistory(v MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory)` + +SetConnectorFileUploadHistory sets ConnectorFileUploadHistory field to given value. + +### HasConnectorFileUploadHistory + +`func (o *MultiHostIntegrationsConnectorAttributes) HasConnectorFileUploadHistory() bool` + +HasConnectorFileUploadHistory returns a boolean if a field has been set. + +### GetMultihostStatus + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMultihostStatus() string` + +GetMultihostStatus returns the MultihostStatus field if non-nil, zero value otherwise. + +### GetMultihostStatusOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMultihostStatusOk() (*string, bool)` + +GetMultihostStatusOk returns a tuple with the MultihostStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultihostStatus + +`func (o *MultiHostIntegrationsConnectorAttributes) SetMultihostStatus(v string)` + +SetMultihostStatus sets MultihostStatus field to given value. + +### HasMultihostStatus + +`func (o *MultiHostIntegrationsConnectorAttributes) HasMultihostStatus() bool` + +HasMultihostStatus returns a boolean if a field has been set. + +### GetShowAccountSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) GetShowAccountSchema() bool` + +GetShowAccountSchema returns the ShowAccountSchema field if non-nil, zero value otherwise. + +### GetShowAccountSchemaOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetShowAccountSchemaOk() (*bool, bool)` + +GetShowAccountSchemaOk returns a tuple with the ShowAccountSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShowAccountSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) SetShowAccountSchema(v bool)` + +SetShowAccountSchema sets ShowAccountSchema field to given value. + +### HasShowAccountSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) HasShowAccountSchema() bool` + +HasShowAccountSchema returns a boolean if a field has been set. + +### GetShowEntitlementSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) GetShowEntitlementSchema() bool` + +GetShowEntitlementSchema returns the ShowEntitlementSchema field if non-nil, zero value otherwise. + +### GetShowEntitlementSchemaOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetShowEntitlementSchemaOk() (*bool, bool)` + +GetShowEntitlementSchemaOk returns a tuple with the ShowEntitlementSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShowEntitlementSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) SetShowEntitlementSchema(v bool)` + +SetShowEntitlementSchema sets ShowEntitlementSchema field to given value. + +### HasShowEntitlementSchema + +`func (o *MultiHostIntegrationsConnectorAttributes) HasShowEntitlementSchema() bool` + +HasShowEntitlementSchema returns a boolean if a field has been set. + +### GetMultiHostAttributes + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMultiHostAttributes() MultiHostIntegrationsConnectorAttributesMultiHostAttributes` + +GetMultiHostAttributes returns the MultiHostAttributes field if non-nil, zero value otherwise. + +### GetMultiHostAttributesOk + +`func (o *MultiHostIntegrationsConnectorAttributes) GetMultiHostAttributesOk() (*MultiHostIntegrationsConnectorAttributesMultiHostAttributes, bool)` + +GetMultiHostAttributesOk returns a tuple with the MultiHostAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultiHostAttributes + +`func (o *MultiHostIntegrationsConnectorAttributes) SetMultiHostAttributes(v MultiHostIntegrationsConnectorAttributesMultiHostAttributes)` + +SetMultiHostAttributes sets MultiHostAttributes field to given value. + +### HasMultiHostAttributes + +`func (o *MultiHostIntegrationsConnectorAttributes) HasMultiHostAttributes() bool` + +HasMultiHostAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md new file mode 100644 index 000000000..25c4bafae --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md @@ -0,0 +1,64 @@ +--- +id: v2025-multi-host-integrations-connector-attributes-connector-file-upload-history +title: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory +pagination_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory +sidebar_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory', 'V2025MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory'] +slug: /tools/sdk/go/v2025/models/multi-host-integrations-connector-attributes-connector-file-upload-history +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory', 'V2025MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory'] +--- + +# MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConnectorFileNameUploadedDate** | Pointer to **string** | File name of the connector JAR | [optional] + +## Methods + +### NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory + +`func NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory() *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory` + +NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory instantiates a new MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory 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 + +### NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryWithDefaults + +`func NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryWithDefaults() *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory` + +NewMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryWithDefaults instantiates a new MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory 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 + +### GetConnectorFileNameUploadedDate + +`func (o *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory) GetConnectorFileNameUploadedDate() string` + +GetConnectorFileNameUploadedDate returns the ConnectorFileNameUploadedDate field if non-nil, zero value otherwise. + +### GetConnectorFileNameUploadedDateOk + +`func (o *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory) GetConnectorFileNameUploadedDateOk() (*string, bool)` + +GetConnectorFileNameUploadedDateOk returns a tuple with the ConnectorFileNameUploadedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorFileNameUploadedDate + +`func (o *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory) SetConnectorFileNameUploadedDate(v string)` + +SetConnectorFileNameUploadedDate sets ConnectorFileNameUploadedDate field to given value. + +### HasConnectorFileNameUploadedDate + +`func (o *MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory) HasConnectorFileNameUploadedDate() bool` + +HasConnectorFileNameUploadedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md new file mode 100644 index 000000000..7d06bcbd8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md @@ -0,0 +1,142 @@ +--- +id: v2025-multi-host-integrations-connector-attributes-multi-host-attributes +title: MultiHostIntegrationsConnectorAttributesMultiHostAttributes +pagination_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes +sidebar_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes', 'V2025MultiHostIntegrationsConnectorAttributesMultiHostAttributes'] +slug: /tools/sdk/go/v2025/models/multi-host-integrations-connector-attributes-multi-host-attributes +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes', 'V2025MultiHostIntegrationsConnectorAttributesMultiHostAttributes'] +--- + +# MultiHostIntegrationsConnectorAttributesMultiHostAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Password** | Pointer to **string** | Password. | [optional] +**ConnectorFiles** | Pointer to **string** | Connector file. | [optional] +**AuthType** | Pointer to **string** | Authentication type. | [optional] +**User** | Pointer to **string** | Username. | [optional] + +## Methods + +### NewMultiHostIntegrationsConnectorAttributesMultiHostAttributes + +`func NewMultiHostIntegrationsConnectorAttributesMultiHostAttributes() *MultiHostIntegrationsConnectorAttributesMultiHostAttributes` + +NewMultiHostIntegrationsConnectorAttributesMultiHostAttributes instantiates a new MultiHostIntegrationsConnectorAttributesMultiHostAttributes 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 + +### NewMultiHostIntegrationsConnectorAttributesMultiHostAttributesWithDefaults + +`func NewMultiHostIntegrationsConnectorAttributesMultiHostAttributesWithDefaults() *MultiHostIntegrationsConnectorAttributesMultiHostAttributes` + +NewMultiHostIntegrationsConnectorAttributesMultiHostAttributesWithDefaults instantiates a new MultiHostIntegrationsConnectorAttributesMultiHostAttributes 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 + +### GetPassword + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) SetPassword(v string)` + +SetPassword sets Password field to given value. + +### HasPassword + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) HasPassword() bool` + +HasPassword returns a boolean if a field has been set. + +### GetConnectorFiles + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetConnectorFiles() string` + +GetConnectorFiles returns the ConnectorFiles field if non-nil, zero value otherwise. + +### GetConnectorFilesOk + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetConnectorFilesOk() (*string, bool)` + +GetConnectorFilesOk returns a tuple with the ConnectorFiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorFiles + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) SetConnectorFiles(v string)` + +SetConnectorFiles sets ConnectorFiles field to given value. + +### HasConnectorFiles + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) HasConnectorFiles() bool` + +HasConnectorFiles returns a boolean if a field has been set. + +### GetAuthType + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetAuthType() string` + +GetAuthType returns the AuthType field if non-nil, zero value otherwise. + +### GetAuthTypeOk + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetAuthTypeOk() (*string, bool)` + +GetAuthTypeOk returns a tuple with the AuthType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthType + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) SetAuthType(v string)` + +SetAuthType sets AuthType field to given value. + +### HasAuthType + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) HasAuthType() bool` + +HasAuthType returns a boolean if a field has been set. + +### GetUser + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetUser() string` + +GetUser returns the User field if non-nil, zero value otherwise. + +### GetUserOk + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) GetUserOk() (*string, bool)` + +GetUserOk returns a tuple with the User field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUser + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) SetUser(v string)` + +SetUser sets User field to given value. + +### HasUser + +`func (o *MultiHostIntegrationsConnectorAttributesMultiHostAttributes) HasUser() bool` + +HasUser returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsCreate.md b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsCreate.md new file mode 100644 index 000000000..37e3c58f3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsCreate.md @@ -0,0 +1,272 @@ +--- +id: v2025-multi-host-integrations-create +title: MultiHostIntegrationsCreate +pagination_label: MultiHostIntegrationsCreate +sidebar_label: MultiHostIntegrationsCreate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsCreate', 'V2025MultiHostIntegrationsCreate'] +slug: /tools/sdk/go/v2025/models/multi-host-integrations-create +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreate', 'V2025MultiHostIntegrationsCreate'] +--- + +# MultiHostIntegrationsCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Multi-Host Integration's human-readable name. | +**Description** | **string** | Multi-Host Integration's human-readable description. | +**Owner** | [**SourceOwner**](source-owner) | | +**Cluster** | Pointer to [**NullableSourceCluster**](source-cluster) | | [optional] +**Connector** | **string** | Connector script name. | +**ConnectorAttributes** | Pointer to **map[string]interface{}** | Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc. | [optional] +**ManagementWorkgroup** | Pointer to [**NullableSourceManagementWorkgroup**](source-management-workgroup) | | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date-time when the source was last modified. | [optional] + +## Methods + +### NewMultiHostIntegrationsCreate + +`func NewMultiHostIntegrationsCreate(name string, description string, owner SourceOwner, connector string, ) *MultiHostIntegrationsCreate` + +NewMultiHostIntegrationsCreate instantiates a new MultiHostIntegrationsCreate 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 + +### NewMultiHostIntegrationsCreateWithDefaults + +`func NewMultiHostIntegrationsCreateWithDefaults() *MultiHostIntegrationsCreate` + +NewMultiHostIntegrationsCreateWithDefaults instantiates a new MultiHostIntegrationsCreate 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 + +### GetName + +`func (o *MultiHostIntegrationsCreate) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrationsCreate) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrationsCreate) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *MultiHostIntegrationsCreate) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *MultiHostIntegrationsCreate) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *MultiHostIntegrationsCreate) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetOwner + +`func (o *MultiHostIntegrationsCreate) GetOwner() SourceOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *MultiHostIntegrationsCreate) GetOwnerOk() (*SourceOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *MultiHostIntegrationsCreate) SetOwner(v SourceOwner)` + +SetOwner sets Owner field to given value. + + +### GetCluster + +`func (o *MultiHostIntegrationsCreate) GetCluster() SourceCluster` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *MultiHostIntegrationsCreate) GetClusterOk() (*SourceCluster, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *MultiHostIntegrationsCreate) SetCluster(v SourceCluster)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *MultiHostIntegrationsCreate) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### SetClusterNil + +`func (o *MultiHostIntegrationsCreate) SetClusterNil(b bool)` + + SetClusterNil sets the value for Cluster to be an explicit nil + +### UnsetCluster +`func (o *MultiHostIntegrationsCreate) UnsetCluster()` + +UnsetCluster ensures that no value is present for Cluster, not even an explicit nil +### GetConnector + +`func (o *MultiHostIntegrationsCreate) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *MultiHostIntegrationsCreate) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *MultiHostIntegrationsCreate) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetConnectorAttributes + +`func (o *MultiHostIntegrationsCreate) GetConnectorAttributes() map[string]interface{}` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *MultiHostIntegrationsCreate) GetConnectorAttributesOk() (*map[string]interface{}, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *MultiHostIntegrationsCreate) SetConnectorAttributes(v map[string]interface{})` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + +### HasConnectorAttributes + +`func (o *MultiHostIntegrationsCreate) HasConnectorAttributes() bool` + +HasConnectorAttributes returns a boolean if a field has been set. + +### GetManagementWorkgroup + +`func (o *MultiHostIntegrationsCreate) GetManagementWorkgroup() SourceManagementWorkgroup` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *MultiHostIntegrationsCreate) GetManagementWorkgroupOk() (*SourceManagementWorkgroup, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *MultiHostIntegrationsCreate) SetManagementWorkgroup(v SourceManagementWorkgroup)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *MultiHostIntegrationsCreate) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### SetManagementWorkgroupNil + +`func (o *MultiHostIntegrationsCreate) SetManagementWorkgroupNil(b bool)` + + SetManagementWorkgroupNil sets the value for ManagementWorkgroup to be an explicit nil + +### UnsetManagementWorkgroup +`func (o *MultiHostIntegrationsCreate) UnsetManagementWorkgroup()` + +UnsetManagementWorkgroup ensures that no value is present for ManagementWorkgroup, not even an explicit nil +### GetCreated + +`func (o *MultiHostIntegrationsCreate) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MultiHostIntegrationsCreate) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MultiHostIntegrationsCreate) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MultiHostIntegrationsCreate) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MultiHostIntegrationsCreate) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MultiHostIntegrationsCreate) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MultiHostIntegrationsCreate) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MultiHostIntegrationsCreate) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsCreateSources.md b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsCreateSources.md new file mode 100644 index 000000000..654668ed7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostIntegrationsCreateSources.md @@ -0,0 +1,111 @@ +--- +id: v2025-multi-host-integrations-create-sources +title: MultiHostIntegrationsCreateSources +pagination_label: MultiHostIntegrationsCreateSources +sidebar_label: MultiHostIntegrationsCreateSources +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostIntegrationsCreateSources', 'V2025MultiHostIntegrationsCreateSources'] +slug: /tools/sdk/go/v2025/models/multi-host-integrations-create-sources +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreateSources', 'V2025MultiHostIntegrationsCreateSources'] +--- + +# MultiHostIntegrationsCreateSources + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Source's human-readable name. | +**Description** | Pointer to **string** | Source's human-readable description. | [optional] +**ConnectorAttributes** | Pointer to **map[string]interface{}** | Connector specific configuration. This configuration will differ from type to type. | [optional] + +## Methods + +### NewMultiHostIntegrationsCreateSources + +`func NewMultiHostIntegrationsCreateSources(name string, ) *MultiHostIntegrationsCreateSources` + +NewMultiHostIntegrationsCreateSources instantiates a new MultiHostIntegrationsCreateSources 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 + +### NewMultiHostIntegrationsCreateSourcesWithDefaults + +`func NewMultiHostIntegrationsCreateSourcesWithDefaults() *MultiHostIntegrationsCreateSources` + +NewMultiHostIntegrationsCreateSourcesWithDefaults instantiates a new MultiHostIntegrationsCreateSources 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 + +### GetName + +`func (o *MultiHostIntegrationsCreateSources) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostIntegrationsCreateSources) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostIntegrationsCreateSources) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *MultiHostIntegrationsCreateSources) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *MultiHostIntegrationsCreateSources) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *MultiHostIntegrationsCreateSources) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *MultiHostIntegrationsCreateSources) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetConnectorAttributes + +`func (o *MultiHostIntegrationsCreateSources) GetConnectorAttributes() map[string]interface{}` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *MultiHostIntegrationsCreateSources) GetConnectorAttributesOk() (*map[string]interface{}, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *MultiHostIntegrationsCreateSources) SetConnectorAttributes(v map[string]interface{})` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + +### HasConnectorAttributes + +`func (o *MultiHostIntegrationsCreateSources) HasConnectorAttributes() bool` + +HasConnectorAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MultiHostSources.md b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostSources.md new file mode 100644 index 000000000..447e36012 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MultiHostSources.md @@ -0,0 +1,899 @@ +--- +id: v2025-multi-host-sources +title: MultiHostSources +pagination_label: MultiHostSources +sidebar_label: MultiHostSources +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiHostSources', 'V2025MultiHostSources'] +slug: /tools/sdk/go/v2025/models/multi-host-sources +tags: ['SDK', 'Software Development Kit', 'MultiHostSources', 'V2025MultiHostSources'] +--- + +# MultiHostSources + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Source ID. | [readonly] +**Name** | **string** | Source's human-readable name. | +**Description** | Pointer to **string** | Source's human-readable description. | [optional] +**Owner** | [**SourceOwner**](source-owner) | | +**Cluster** | Pointer to [**NullableSourceCluster**](source-cluster) | | [optional] +**AccountCorrelationConfig** | Pointer to [**NullableSourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional] +**AccountCorrelationRule** | Pointer to [**NullableSourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional] +**ManagerCorrelationMapping** | Pointer to [**ManagerCorrelationMapping**](manager-correlation-mapping) | | [optional] +**ManagerCorrelationRule** | Pointer to [**NullableSourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional] +**BeforeProvisioningRule** | Pointer to [**NullableSourceBeforeProvisioningRule**](source-before-provisioning-rule) | | [optional] +**Schemas** | Pointer to [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional] +**PasswordPolicies** | Pointer to [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**Features** | Pointer to **[]string** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Type** | Pointer to **string** | Specifies the type of system being managed e.g. Multi-Host - Microsoft SQL Server, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Connector** | **string** | Connector script name. | +**ConnectorClass** | Pointer to **string** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**ConnectorAttributes** | Pointer to **map[string]interface{}** | Connector specific configuration. This configuration will differ from type to type. | [optional] +**DeleteThreshold** | Pointer to **int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**Authoritative** | Pointer to **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to false] +**ManagementWorkgroup** | Pointer to [**NullableSourceManagementWorkgroup**](source-management-workgroup) | | [optional] +**Healthy** | Pointer to **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to false] +**Status** | Pointer to **string** | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**Since** | Pointer to **SailPointTime** | Timestamp that shows when a source health check was last performed. | [optional] +**ConnectorId** | Pointer to **string** | Connector ID | [optional] +**ConnectorName** | **string** | Name of the connector that was chosen during source creation. | +**ConnectionType** | Pointer to **string** | Type of connection (direct or file). | [optional] +**ConnectorImplementationId** | Pointer to **string** | Connector implementation ID. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date-time when the source was last modified. | [optional] +**CredentialProviderEnabled** | Pointer to **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to false] +**Category** | Pointer to **NullableString** | Source category (e.g. null, CredentialProvider). | [optional] + +## Methods + +### NewMultiHostSources + +`func NewMultiHostSources(id string, name string, owner SourceOwner, connector string, connectorName string, ) *MultiHostSources` + +NewMultiHostSources instantiates a new MultiHostSources 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 + +### NewMultiHostSourcesWithDefaults + +`func NewMultiHostSourcesWithDefaults() *MultiHostSources` + +NewMultiHostSourcesWithDefaults instantiates a new MultiHostSources 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 + +### GetId + +`func (o *MultiHostSources) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MultiHostSources) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MultiHostSources) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *MultiHostSources) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MultiHostSources) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MultiHostSources) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *MultiHostSources) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *MultiHostSources) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *MultiHostSources) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *MultiHostSources) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *MultiHostSources) GetOwner() SourceOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *MultiHostSources) GetOwnerOk() (*SourceOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *MultiHostSources) SetOwner(v SourceOwner)` + +SetOwner sets Owner field to given value. + + +### GetCluster + +`func (o *MultiHostSources) GetCluster() SourceCluster` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *MultiHostSources) GetClusterOk() (*SourceCluster, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *MultiHostSources) SetCluster(v SourceCluster)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *MultiHostSources) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### SetClusterNil + +`func (o *MultiHostSources) SetClusterNil(b bool)` + + SetClusterNil sets the value for Cluster to be an explicit nil + +### UnsetCluster +`func (o *MultiHostSources) UnsetCluster()` + +UnsetCluster ensures that no value is present for Cluster, not even an explicit nil +### GetAccountCorrelationConfig + +`func (o *MultiHostSources) GetAccountCorrelationConfig() SourceAccountCorrelationConfig` + +GetAccountCorrelationConfig returns the AccountCorrelationConfig field if non-nil, zero value otherwise. + +### GetAccountCorrelationConfigOk + +`func (o *MultiHostSources) GetAccountCorrelationConfigOk() (*SourceAccountCorrelationConfig, bool)` + +GetAccountCorrelationConfigOk returns a tuple with the AccountCorrelationConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationConfig + +`func (o *MultiHostSources) SetAccountCorrelationConfig(v SourceAccountCorrelationConfig)` + +SetAccountCorrelationConfig sets AccountCorrelationConfig field to given value. + +### HasAccountCorrelationConfig + +`func (o *MultiHostSources) HasAccountCorrelationConfig() bool` + +HasAccountCorrelationConfig returns a boolean if a field has been set. + +### SetAccountCorrelationConfigNil + +`func (o *MultiHostSources) SetAccountCorrelationConfigNil(b bool)` + + SetAccountCorrelationConfigNil sets the value for AccountCorrelationConfig to be an explicit nil + +### UnsetAccountCorrelationConfig +`func (o *MultiHostSources) UnsetAccountCorrelationConfig()` + +UnsetAccountCorrelationConfig ensures that no value is present for AccountCorrelationConfig, not even an explicit nil +### GetAccountCorrelationRule + +`func (o *MultiHostSources) GetAccountCorrelationRule() SourceAccountCorrelationRule` + +GetAccountCorrelationRule returns the AccountCorrelationRule field if non-nil, zero value otherwise. + +### GetAccountCorrelationRuleOk + +`func (o *MultiHostSources) GetAccountCorrelationRuleOk() (*SourceAccountCorrelationRule, bool)` + +GetAccountCorrelationRuleOk returns a tuple with the AccountCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationRule + +`func (o *MultiHostSources) SetAccountCorrelationRule(v SourceAccountCorrelationRule)` + +SetAccountCorrelationRule sets AccountCorrelationRule field to given value. + +### HasAccountCorrelationRule + +`func (o *MultiHostSources) HasAccountCorrelationRule() bool` + +HasAccountCorrelationRule returns a boolean if a field has been set. + +### SetAccountCorrelationRuleNil + +`func (o *MultiHostSources) SetAccountCorrelationRuleNil(b bool)` + + SetAccountCorrelationRuleNil sets the value for AccountCorrelationRule to be an explicit nil + +### UnsetAccountCorrelationRule +`func (o *MultiHostSources) UnsetAccountCorrelationRule()` + +UnsetAccountCorrelationRule ensures that no value is present for AccountCorrelationRule, not even an explicit nil +### GetManagerCorrelationMapping + +`func (o *MultiHostSources) GetManagerCorrelationMapping() ManagerCorrelationMapping` + +GetManagerCorrelationMapping returns the ManagerCorrelationMapping field if non-nil, zero value otherwise. + +### GetManagerCorrelationMappingOk + +`func (o *MultiHostSources) GetManagerCorrelationMappingOk() (*ManagerCorrelationMapping, bool)` + +GetManagerCorrelationMappingOk returns a tuple with the ManagerCorrelationMapping field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationMapping + +`func (o *MultiHostSources) SetManagerCorrelationMapping(v ManagerCorrelationMapping)` + +SetManagerCorrelationMapping sets ManagerCorrelationMapping field to given value. + +### HasManagerCorrelationMapping + +`func (o *MultiHostSources) HasManagerCorrelationMapping() bool` + +HasManagerCorrelationMapping returns a boolean if a field has been set. + +### GetManagerCorrelationRule + +`func (o *MultiHostSources) GetManagerCorrelationRule() SourceManagerCorrelationRule` + +GetManagerCorrelationRule returns the ManagerCorrelationRule field if non-nil, zero value otherwise. + +### GetManagerCorrelationRuleOk + +`func (o *MultiHostSources) GetManagerCorrelationRuleOk() (*SourceManagerCorrelationRule, bool)` + +GetManagerCorrelationRuleOk returns a tuple with the ManagerCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationRule + +`func (o *MultiHostSources) SetManagerCorrelationRule(v SourceManagerCorrelationRule)` + +SetManagerCorrelationRule sets ManagerCorrelationRule field to given value. + +### HasManagerCorrelationRule + +`func (o *MultiHostSources) HasManagerCorrelationRule() bool` + +HasManagerCorrelationRule returns a boolean if a field has been set. + +### SetManagerCorrelationRuleNil + +`func (o *MultiHostSources) SetManagerCorrelationRuleNil(b bool)` + + SetManagerCorrelationRuleNil sets the value for ManagerCorrelationRule to be an explicit nil + +### UnsetManagerCorrelationRule +`func (o *MultiHostSources) UnsetManagerCorrelationRule()` + +UnsetManagerCorrelationRule ensures that no value is present for ManagerCorrelationRule, not even an explicit nil +### GetBeforeProvisioningRule + +`func (o *MultiHostSources) GetBeforeProvisioningRule() SourceBeforeProvisioningRule` + +GetBeforeProvisioningRule returns the BeforeProvisioningRule field if non-nil, zero value otherwise. + +### GetBeforeProvisioningRuleOk + +`func (o *MultiHostSources) GetBeforeProvisioningRuleOk() (*SourceBeforeProvisioningRule, bool)` + +GetBeforeProvisioningRuleOk returns a tuple with the BeforeProvisioningRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBeforeProvisioningRule + +`func (o *MultiHostSources) SetBeforeProvisioningRule(v SourceBeforeProvisioningRule)` + +SetBeforeProvisioningRule sets BeforeProvisioningRule field to given value. + +### HasBeforeProvisioningRule + +`func (o *MultiHostSources) HasBeforeProvisioningRule() bool` + +HasBeforeProvisioningRule returns a boolean if a field has been set. + +### SetBeforeProvisioningRuleNil + +`func (o *MultiHostSources) SetBeforeProvisioningRuleNil(b bool)` + + SetBeforeProvisioningRuleNil sets the value for BeforeProvisioningRule to be an explicit nil + +### UnsetBeforeProvisioningRule +`func (o *MultiHostSources) UnsetBeforeProvisioningRule()` + +UnsetBeforeProvisioningRule ensures that no value is present for BeforeProvisioningRule, not even an explicit nil +### GetSchemas + +`func (o *MultiHostSources) GetSchemas() []SourceSchemasInner` + +GetSchemas returns the Schemas field if non-nil, zero value otherwise. + +### GetSchemasOk + +`func (o *MultiHostSources) GetSchemasOk() (*[]SourceSchemasInner, bool)` + +GetSchemasOk returns a tuple with the Schemas field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchemas + +`func (o *MultiHostSources) SetSchemas(v []SourceSchemasInner)` + +SetSchemas sets Schemas field to given value. + +### HasSchemas + +`func (o *MultiHostSources) HasSchemas() bool` + +HasSchemas returns a boolean if a field has been set. + +### GetPasswordPolicies + +`func (o *MultiHostSources) GetPasswordPolicies() []SourcePasswordPoliciesInner` + +GetPasswordPolicies returns the PasswordPolicies field if non-nil, zero value otherwise. + +### GetPasswordPoliciesOk + +`func (o *MultiHostSources) GetPasswordPoliciesOk() (*[]SourcePasswordPoliciesInner, bool)` + +GetPasswordPoliciesOk returns a tuple with the PasswordPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicies + +`func (o *MultiHostSources) SetPasswordPolicies(v []SourcePasswordPoliciesInner)` + +SetPasswordPolicies sets PasswordPolicies field to given value. + +### HasPasswordPolicies + +`func (o *MultiHostSources) HasPasswordPolicies() bool` + +HasPasswordPolicies returns a boolean if a field has been set. + +### SetPasswordPoliciesNil + +`func (o *MultiHostSources) SetPasswordPoliciesNil(b bool)` + + SetPasswordPoliciesNil sets the value for PasswordPolicies to be an explicit nil + +### UnsetPasswordPolicies +`func (o *MultiHostSources) UnsetPasswordPolicies()` + +UnsetPasswordPolicies ensures that no value is present for PasswordPolicies, not even an explicit nil +### GetFeatures + +`func (o *MultiHostSources) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *MultiHostSources) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *MultiHostSources) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *MultiHostSources) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### GetType + +`func (o *MultiHostSources) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MultiHostSources) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MultiHostSources) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MultiHostSources) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConnector + +`func (o *MultiHostSources) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *MultiHostSources) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *MultiHostSources) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetConnectorClass + +`func (o *MultiHostSources) GetConnectorClass() string` + +GetConnectorClass returns the ConnectorClass field if non-nil, zero value otherwise. + +### GetConnectorClassOk + +`func (o *MultiHostSources) GetConnectorClassOk() (*string, bool)` + +GetConnectorClassOk returns a tuple with the ConnectorClass field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorClass + +`func (o *MultiHostSources) SetConnectorClass(v string)` + +SetConnectorClass sets ConnectorClass field to given value. + +### HasConnectorClass + +`func (o *MultiHostSources) HasConnectorClass() bool` + +HasConnectorClass returns a boolean if a field has been set. + +### GetConnectorAttributes + +`func (o *MultiHostSources) GetConnectorAttributes() map[string]interface{}` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *MultiHostSources) GetConnectorAttributesOk() (*map[string]interface{}, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *MultiHostSources) SetConnectorAttributes(v map[string]interface{})` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + +### HasConnectorAttributes + +`func (o *MultiHostSources) HasConnectorAttributes() bool` + +HasConnectorAttributes returns a boolean if a field has been set. + +### GetDeleteThreshold + +`func (o *MultiHostSources) GetDeleteThreshold() int32` + +GetDeleteThreshold returns the DeleteThreshold field if non-nil, zero value otherwise. + +### GetDeleteThresholdOk + +`func (o *MultiHostSources) GetDeleteThresholdOk() (*int32, bool)` + +GetDeleteThresholdOk returns a tuple with the DeleteThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteThreshold + +`func (o *MultiHostSources) SetDeleteThreshold(v int32)` + +SetDeleteThreshold sets DeleteThreshold field to given value. + +### HasDeleteThreshold + +`func (o *MultiHostSources) HasDeleteThreshold() bool` + +HasDeleteThreshold returns a boolean if a field has been set. + +### GetAuthoritative + +`func (o *MultiHostSources) GetAuthoritative() bool` + +GetAuthoritative returns the Authoritative field if non-nil, zero value otherwise. + +### GetAuthoritativeOk + +`func (o *MultiHostSources) GetAuthoritativeOk() (*bool, bool)` + +GetAuthoritativeOk returns a tuple with the Authoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritative + +`func (o *MultiHostSources) SetAuthoritative(v bool)` + +SetAuthoritative sets Authoritative field to given value. + +### HasAuthoritative + +`func (o *MultiHostSources) HasAuthoritative() bool` + +HasAuthoritative returns a boolean if a field has been set. + +### GetManagementWorkgroup + +`func (o *MultiHostSources) GetManagementWorkgroup() SourceManagementWorkgroup` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *MultiHostSources) GetManagementWorkgroupOk() (*SourceManagementWorkgroup, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *MultiHostSources) SetManagementWorkgroup(v SourceManagementWorkgroup)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *MultiHostSources) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### SetManagementWorkgroupNil + +`func (o *MultiHostSources) SetManagementWorkgroupNil(b bool)` + + SetManagementWorkgroupNil sets the value for ManagementWorkgroup to be an explicit nil + +### UnsetManagementWorkgroup +`func (o *MultiHostSources) UnsetManagementWorkgroup()` + +UnsetManagementWorkgroup ensures that no value is present for ManagementWorkgroup, not even an explicit nil +### GetHealthy + +`func (o *MultiHostSources) GetHealthy() bool` + +GetHealthy returns the Healthy field if non-nil, zero value otherwise. + +### GetHealthyOk + +`func (o *MultiHostSources) GetHealthyOk() (*bool, bool)` + +GetHealthyOk returns a tuple with the Healthy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthy + +`func (o *MultiHostSources) SetHealthy(v bool)` + +SetHealthy sets Healthy field to given value. + +### HasHealthy + +`func (o *MultiHostSources) HasHealthy() bool` + +HasHealthy returns a boolean if a field has been set. + +### GetStatus + +`func (o *MultiHostSources) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *MultiHostSources) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *MultiHostSources) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *MultiHostSources) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSince + +`func (o *MultiHostSources) GetSince() SailPointTime` + +GetSince returns the Since field if non-nil, zero value otherwise. + +### GetSinceOk + +`func (o *MultiHostSources) GetSinceOk() (*SailPointTime, bool)` + +GetSinceOk returns a tuple with the Since field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSince + +`func (o *MultiHostSources) SetSince(v SailPointTime)` + +SetSince sets Since field to given value. + +### HasSince + +`func (o *MultiHostSources) HasSince() bool` + +HasSince returns a boolean if a field has been set. + +### GetConnectorId + +`func (o *MultiHostSources) GetConnectorId() string` + +GetConnectorId returns the ConnectorId field if non-nil, zero value otherwise. + +### GetConnectorIdOk + +`func (o *MultiHostSources) GetConnectorIdOk() (*string, bool)` + +GetConnectorIdOk returns a tuple with the ConnectorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorId + +`func (o *MultiHostSources) SetConnectorId(v string)` + +SetConnectorId sets ConnectorId field to given value. + +### HasConnectorId + +`func (o *MultiHostSources) HasConnectorId() bool` + +HasConnectorId returns a boolean if a field has been set. + +### GetConnectorName + +`func (o *MultiHostSources) GetConnectorName() string` + +GetConnectorName returns the ConnectorName field if non-nil, zero value otherwise. + +### GetConnectorNameOk + +`func (o *MultiHostSources) GetConnectorNameOk() (*string, bool)` + +GetConnectorNameOk returns a tuple with the ConnectorName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorName + +`func (o *MultiHostSources) SetConnectorName(v string)` + +SetConnectorName sets ConnectorName field to given value. + + +### GetConnectionType + +`func (o *MultiHostSources) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *MultiHostSources) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *MultiHostSources) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *MultiHostSources) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + +### GetConnectorImplementationId + +`func (o *MultiHostSources) GetConnectorImplementationId() string` + +GetConnectorImplementationId returns the ConnectorImplementationId field if non-nil, zero value otherwise. + +### GetConnectorImplementationIdOk + +`func (o *MultiHostSources) GetConnectorImplementationIdOk() (*string, bool)` + +GetConnectorImplementationIdOk returns a tuple with the ConnectorImplementationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorImplementationId + +`func (o *MultiHostSources) SetConnectorImplementationId(v string)` + +SetConnectorImplementationId sets ConnectorImplementationId field to given value. + +### HasConnectorImplementationId + +`func (o *MultiHostSources) HasConnectorImplementationId() bool` + +HasConnectorImplementationId returns a boolean if a field has been set. + +### GetCreated + +`func (o *MultiHostSources) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *MultiHostSources) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *MultiHostSources) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *MultiHostSources) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *MultiHostSources) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *MultiHostSources) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *MultiHostSources) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *MultiHostSources) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCredentialProviderEnabled + +`func (o *MultiHostSources) GetCredentialProviderEnabled() bool` + +GetCredentialProviderEnabled returns the CredentialProviderEnabled field if non-nil, zero value otherwise. + +### GetCredentialProviderEnabledOk + +`func (o *MultiHostSources) GetCredentialProviderEnabledOk() (*bool, bool)` + +GetCredentialProviderEnabledOk returns a tuple with the CredentialProviderEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialProviderEnabled + +`func (o *MultiHostSources) SetCredentialProviderEnabled(v bool)` + +SetCredentialProviderEnabled sets CredentialProviderEnabled field to given value. + +### HasCredentialProviderEnabled + +`func (o *MultiHostSources) HasCredentialProviderEnabled() bool` + +HasCredentialProviderEnabled returns a boolean if a field has been set. + +### GetCategory + +`func (o *MultiHostSources) GetCategory() string` + +GetCategory returns the Category field if non-nil, zero value otherwise. + +### GetCategoryOk + +`func (o *MultiHostSources) GetCategoryOk() (*string, bool)` + +GetCategoryOk returns a tuple with the Category field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCategory + +`func (o *MultiHostSources) SetCategory(v string)` + +SetCategory sets Category field to given value. + +### HasCategory + +`func (o *MultiHostSources) HasCategory() bool` + +HasCategory returns a boolean if a field has been set. + +### SetCategoryNil + +`func (o *MultiHostSources) SetCategoryNil(b bool)` + + SetCategoryNil sets the value for Category to be an explicit nil + +### UnsetCategory +`func (o *MultiHostSources) UnsetCategory()` + +UnsetCategory ensures that no value is present for Category, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/MultiPolicyRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/MultiPolicyRequest.md new file mode 100644 index 000000000..383424ce7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/MultiPolicyRequest.md @@ -0,0 +1,64 @@ +--- +id: v2025-multi-policy-request +title: MultiPolicyRequest +pagination_label: MultiPolicyRequest +sidebar_label: MultiPolicyRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiPolicyRequest', 'V2025MultiPolicyRequest'] +slug: /tools/sdk/go/v2025/models/multi-policy-request +tags: ['SDK', 'Software Development Kit', 'MultiPolicyRequest', 'V2025MultiPolicyRequest'] +--- + +# MultiPolicyRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FilteredPolicyList** | Pointer to **[]string** | Multi-policy report will be run for this list of ids | [optional] + +## Methods + +### NewMultiPolicyRequest + +`func NewMultiPolicyRequest() *MultiPolicyRequest` + +NewMultiPolicyRequest instantiates a new MultiPolicyRequest 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 + +### NewMultiPolicyRequestWithDefaults + +`func NewMultiPolicyRequestWithDefaults() *MultiPolicyRequest` + +NewMultiPolicyRequestWithDefaults instantiates a new MultiPolicyRequest 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 + +### GetFilteredPolicyList + +`func (o *MultiPolicyRequest) GetFilteredPolicyList() []string` + +GetFilteredPolicyList returns the FilteredPolicyList field if non-nil, zero value otherwise. + +### GetFilteredPolicyListOk + +`func (o *MultiPolicyRequest) GetFilteredPolicyListOk() (*[]string, bool)` + +GetFilteredPolicyListOk returns a tuple with the FilteredPolicyList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilteredPolicyList + +`func (o *MultiPolicyRequest) SetFilteredPolicyList(v []string)` + +SetFilteredPolicyList sets FilteredPolicyList field to given value. + +### HasFilteredPolicyList + +`func (o *MultiPolicyRequest) HasFilteredPolicyList() bool` + +HasFilteredPolicyList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NativeChangeDetectionConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/NativeChangeDetectionConfig.md new file mode 100644 index 000000000..d4237c99f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NativeChangeDetectionConfig.md @@ -0,0 +1,194 @@ +--- +id: v2025-native-change-detection-config +title: NativeChangeDetectionConfig +pagination_label: NativeChangeDetectionConfig +sidebar_label: NativeChangeDetectionConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NativeChangeDetectionConfig', 'V2025NativeChangeDetectionConfig'] +slug: /tools/sdk/go/v2025/models/native-change-detection-config +tags: ['SDK', 'Software Development Kit', 'NativeChangeDetectionConfig', 'V2025NativeChangeDetectionConfig'] +--- + +# NativeChangeDetectionConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | A flag indicating if Native Change Detection is enabled for a source. | [optional] [default to false] +**Operations** | Pointer to **[]string** | Operation types for which Native Change Detection is enabled for a source. | [optional] +**AllEntitlements** | Pointer to **bool** | A flag indicating that all entitlements participate in Native Change Detection. | [optional] [default to false] +**AllNonEntitlementAttributes** | Pointer to **bool** | A flag indicating that all non-entitlement account attributes participate in Native Change Detection. | [optional] [default to false] +**SelectedEntitlements** | Pointer to **[]string** | If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection. | [optional] +**SelectedNonEntitlementAttributes** | Pointer to **[]string** | If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection. | [optional] + +## Methods + +### NewNativeChangeDetectionConfig + +`func NewNativeChangeDetectionConfig() *NativeChangeDetectionConfig` + +NewNativeChangeDetectionConfig instantiates a new NativeChangeDetectionConfig 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 + +### NewNativeChangeDetectionConfigWithDefaults + +`func NewNativeChangeDetectionConfigWithDefaults() *NativeChangeDetectionConfig` + +NewNativeChangeDetectionConfigWithDefaults instantiates a new NativeChangeDetectionConfig 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 + +### GetEnabled + +`func (o *NativeChangeDetectionConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *NativeChangeDetectionConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *NativeChangeDetectionConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *NativeChangeDetectionConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetOperations + +`func (o *NativeChangeDetectionConfig) GetOperations() []string` + +GetOperations returns the Operations field if non-nil, zero value otherwise. + +### GetOperationsOk + +`func (o *NativeChangeDetectionConfig) GetOperationsOk() (*[]string, bool)` + +GetOperationsOk returns a tuple with the Operations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperations + +`func (o *NativeChangeDetectionConfig) SetOperations(v []string)` + +SetOperations sets Operations field to given value. + +### HasOperations + +`func (o *NativeChangeDetectionConfig) HasOperations() bool` + +HasOperations returns a boolean if a field has been set. + +### GetAllEntitlements + +`func (o *NativeChangeDetectionConfig) GetAllEntitlements() bool` + +GetAllEntitlements returns the AllEntitlements field if non-nil, zero value otherwise. + +### GetAllEntitlementsOk + +`func (o *NativeChangeDetectionConfig) GetAllEntitlementsOk() (*bool, bool)` + +GetAllEntitlementsOk returns a tuple with the AllEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllEntitlements + +`func (o *NativeChangeDetectionConfig) SetAllEntitlements(v bool)` + +SetAllEntitlements sets AllEntitlements field to given value. + +### HasAllEntitlements + +`func (o *NativeChangeDetectionConfig) HasAllEntitlements() bool` + +HasAllEntitlements returns a boolean if a field has been set. + +### GetAllNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) GetAllNonEntitlementAttributes() bool` + +GetAllNonEntitlementAttributes returns the AllNonEntitlementAttributes field if non-nil, zero value otherwise. + +### GetAllNonEntitlementAttributesOk + +`func (o *NativeChangeDetectionConfig) GetAllNonEntitlementAttributesOk() (*bool, bool)` + +GetAllNonEntitlementAttributesOk returns a tuple with the AllNonEntitlementAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) SetAllNonEntitlementAttributes(v bool)` + +SetAllNonEntitlementAttributes sets AllNonEntitlementAttributes field to given value. + +### HasAllNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) HasAllNonEntitlementAttributes() bool` + +HasAllNonEntitlementAttributes returns a boolean if a field has been set. + +### GetSelectedEntitlements + +`func (o *NativeChangeDetectionConfig) GetSelectedEntitlements() []string` + +GetSelectedEntitlements returns the SelectedEntitlements field if non-nil, zero value otherwise. + +### GetSelectedEntitlementsOk + +`func (o *NativeChangeDetectionConfig) GetSelectedEntitlementsOk() (*[]string, bool)` + +GetSelectedEntitlementsOk returns a tuple with the SelectedEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectedEntitlements + +`func (o *NativeChangeDetectionConfig) SetSelectedEntitlements(v []string)` + +SetSelectedEntitlements sets SelectedEntitlements field to given value. + +### HasSelectedEntitlements + +`func (o *NativeChangeDetectionConfig) HasSelectedEntitlements() bool` + +HasSelectedEntitlements returns a boolean if a field has been set. + +### GetSelectedNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) GetSelectedNonEntitlementAttributes() []string` + +GetSelectedNonEntitlementAttributes returns the SelectedNonEntitlementAttributes field if non-nil, zero value otherwise. + +### GetSelectedNonEntitlementAttributesOk + +`func (o *NativeChangeDetectionConfig) GetSelectedNonEntitlementAttributesOk() (*[]string, bool)` + +GetSelectedNonEntitlementAttributesOk returns a tuple with the SelectedNonEntitlementAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectedNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) SetSelectedNonEntitlementAttributes(v []string)` + +SetSelectedNonEntitlementAttributes sets SelectedNonEntitlementAttributes field to given value. + +### HasSelectedNonEntitlementAttributes + +`func (o *NativeChangeDetectionConfig) HasSelectedNonEntitlementAttributes() bool` + +HasSelectedNonEntitlementAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NestedAggregation.md b/docs/tools/sdk/go/Reference/V2025/Models/NestedAggregation.md new file mode 100644 index 000000000..b8cf2e488 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NestedAggregation.md @@ -0,0 +1,80 @@ +--- +id: v2025-nested-aggregation +title: NestedAggregation +pagination_label: NestedAggregation +sidebar_label: NestedAggregation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NestedAggregation', 'V2025NestedAggregation'] +slug: /tools/sdk/go/v2025/models/nested-aggregation +tags: ['SDK', 'Software Development Kit', 'NestedAggregation', 'V2025NestedAggregation'] +--- + +# NestedAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the nested aggregate to be included in the result. | +**Type** | **string** | The type of the nested object. | + +## Methods + +### NewNestedAggregation + +`func NewNestedAggregation(name string, type_ string, ) *NestedAggregation` + +NewNestedAggregation instantiates a new NestedAggregation 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 + +### NewNestedAggregationWithDefaults + +`func NewNestedAggregationWithDefaults() *NestedAggregation` + +NewNestedAggregationWithDefaults instantiates a new NestedAggregation 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 + +### GetName + +`func (o *NestedAggregation) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NestedAggregation) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NestedAggregation) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *NestedAggregation) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NestedAggregation) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NestedAggregation) SetType(v string)` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NetworkConfiguration.md b/docs/tools/sdk/go/Reference/V2025/Models/NetworkConfiguration.md new file mode 100644 index 000000000..b4eaf10cf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NetworkConfiguration.md @@ -0,0 +1,136 @@ +--- +id: v2025-network-configuration +title: NetworkConfiguration +pagination_label: NetworkConfiguration +sidebar_label: NetworkConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NetworkConfiguration', 'V2025NetworkConfiguration'] +slug: /tools/sdk/go/v2025/models/network-configuration +tags: ['SDK', 'Software Development Kit', 'NetworkConfiguration', 'V2025NetworkConfiguration'] +--- + +# NetworkConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Range** | Pointer to **[]string** | The collection of ip ranges. | [optional] +**Geolocation** | Pointer to **[]string** | The collection of country codes. | [optional] +**Whitelisted** | Pointer to **bool** | Denotes whether the provided lists are whitelisted or blacklisted for geo location. | [optional] [default to false] + +## Methods + +### NewNetworkConfiguration + +`func NewNetworkConfiguration() *NetworkConfiguration` + +NewNetworkConfiguration instantiates a new NetworkConfiguration 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 + +### NewNetworkConfigurationWithDefaults + +`func NewNetworkConfigurationWithDefaults() *NetworkConfiguration` + +NewNetworkConfigurationWithDefaults instantiates a new NetworkConfiguration 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 + +### GetRange + +`func (o *NetworkConfiguration) GetRange() []string` + +GetRange returns the Range field if non-nil, zero value otherwise. + +### GetRangeOk + +`func (o *NetworkConfiguration) GetRangeOk() (*[]string, bool)` + +GetRangeOk returns a tuple with the Range field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRange + +`func (o *NetworkConfiguration) SetRange(v []string)` + +SetRange sets Range field to given value. + +### HasRange + +`func (o *NetworkConfiguration) HasRange() bool` + +HasRange returns a boolean if a field has been set. + +### SetRangeNil + +`func (o *NetworkConfiguration) SetRangeNil(b bool)` + + SetRangeNil sets the value for Range to be an explicit nil + +### UnsetRange +`func (o *NetworkConfiguration) UnsetRange()` + +UnsetRange ensures that no value is present for Range, not even an explicit nil +### GetGeolocation + +`func (o *NetworkConfiguration) GetGeolocation() []string` + +GetGeolocation returns the Geolocation field if non-nil, zero value otherwise. + +### GetGeolocationOk + +`func (o *NetworkConfiguration) GetGeolocationOk() (*[]string, bool)` + +GetGeolocationOk returns a tuple with the Geolocation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGeolocation + +`func (o *NetworkConfiguration) SetGeolocation(v []string)` + +SetGeolocation sets Geolocation field to given value. + +### HasGeolocation + +`func (o *NetworkConfiguration) HasGeolocation() bool` + +HasGeolocation returns a boolean if a field has been set. + +### SetGeolocationNil + +`func (o *NetworkConfiguration) SetGeolocationNil(b bool)` + + SetGeolocationNil sets the value for Geolocation to be an explicit nil + +### UnsetGeolocation +`func (o *NetworkConfiguration) UnsetGeolocation()` + +UnsetGeolocation ensures that no value is present for Geolocation, not even an explicit nil +### GetWhitelisted + +`func (o *NetworkConfiguration) GetWhitelisted() bool` + +GetWhitelisted returns the Whitelisted field if non-nil, zero value otherwise. + +### GetWhitelistedOk + +`func (o *NetworkConfiguration) GetWhitelistedOk() (*bool, bool)` + +GetWhitelistedOk returns a tuple with the Whitelisted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWhitelisted + +`func (o *NetworkConfiguration) SetWhitelisted(v bool)` + +SetWhitelisted sets Whitelisted field to given value. + +### HasWhitelisted + +`func (o *NetworkConfiguration) HasWhitelisted() bool` + +HasWhitelisted returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeApprovalDecision.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeApprovalDecision.md new file mode 100644 index 000000000..73f1c3292 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeApprovalDecision.md @@ -0,0 +1,64 @@ +--- +id: v2025-non-employee-approval-decision +title: NonEmployeeApprovalDecision +pagination_label: NonEmployeeApprovalDecision +sidebar_label: NonEmployeeApprovalDecision +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalDecision', 'V2025NonEmployeeApprovalDecision'] +slug: /tools/sdk/go/v2025/models/non-employee-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalDecision', 'V2025NonEmployeeApprovalDecision'] +--- + +# NonEmployeeApprovalDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment on the approval item. | [optional] + +## Methods + +### NewNonEmployeeApprovalDecision + +`func NewNonEmployeeApprovalDecision() *NonEmployeeApprovalDecision` + +NewNonEmployeeApprovalDecision instantiates a new NonEmployeeApprovalDecision 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 + +### NewNonEmployeeApprovalDecisionWithDefaults + +`func NewNonEmployeeApprovalDecisionWithDefaults() *NonEmployeeApprovalDecision` + +NewNonEmployeeApprovalDecisionWithDefaults instantiates a new NonEmployeeApprovalDecision 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 + +### GetComment + +`func (o *NonEmployeeApprovalDecision) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeApprovalDecision) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeApprovalDecision) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeApprovalDecision) HasComment() bool` + +HasComment returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeApprovalItem.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeApprovalItem.md new file mode 100644 index 000000000..63bc5dd30 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeApprovalItem.md @@ -0,0 +1,272 @@ +--- +id: v2025-non-employee-approval-item +title: NonEmployeeApprovalItem +pagination_label: NonEmployeeApprovalItem +sidebar_label: NonEmployeeApprovalItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalItem', 'V2025NonEmployeeApprovalItem'] +slug: /tools/sdk/go/v2025/models/non-employee-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItem', 'V2025NonEmployeeApprovalItem'] +--- + +# NonEmployeeApprovalItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **string** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **float32** | Approval order | [optional] +**Comment** | Pointer to **string** | comment of approver | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestLite**](non-employee-request-lite) | | [optional] + +## Methods + +### NewNonEmployeeApprovalItem + +`func NewNonEmployeeApprovalItem() *NonEmployeeApprovalItem` + +NewNonEmployeeApprovalItem instantiates a new NonEmployeeApprovalItem 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 + +### NewNonEmployeeApprovalItemWithDefaults + +`func NewNonEmployeeApprovalItemWithDefaults() *NonEmployeeApprovalItem` + +NewNonEmployeeApprovalItemWithDefaults instantiates a new NonEmployeeApprovalItem 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 + +### GetId + +`func (o *NonEmployeeApprovalItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeApprovalItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeApprovalItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeApprovalItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetApprover + +`func (o *NonEmployeeApprovalItem) GetApprover() NonEmployeeIdentityReferenceWithId` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *NonEmployeeApprovalItem) GetApproverOk() (*NonEmployeeIdentityReferenceWithId, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *NonEmployeeApprovalItem) SetApprover(v NonEmployeeIdentityReferenceWithId)` + +SetApprover sets Approver field to given value. + +### HasApprover + +`func (o *NonEmployeeApprovalItem) HasApprover() bool` + +HasApprover returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeApprovalItem) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeApprovalItem) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeApprovalItem) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeApprovalItem) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeApprovalItem) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeApprovalItem) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeApprovalItem) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeApprovalItem) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetApprovalOrder + +`func (o *NonEmployeeApprovalItem) GetApprovalOrder() float32` + +GetApprovalOrder returns the ApprovalOrder field if non-nil, zero value otherwise. + +### GetApprovalOrderOk + +`func (o *NonEmployeeApprovalItem) GetApprovalOrderOk() (*float32, bool)` + +GetApprovalOrderOk returns a tuple with the ApprovalOrder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalOrder + +`func (o *NonEmployeeApprovalItem) SetApprovalOrder(v float32)` + +SetApprovalOrder sets ApprovalOrder field to given value. + +### HasApprovalOrder + +`func (o *NonEmployeeApprovalItem) HasApprovalOrder() bool` + +HasApprovalOrder returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeApprovalItem) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeApprovalItem) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeApprovalItem) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeApprovalItem) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeApprovalItem) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeApprovalItem) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeApprovalItem) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeApprovalItem) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeApprovalItem) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeApprovalItem) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeApprovalItem) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeApprovalItem) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetNonEmployeeRequest + +`func (o *NonEmployeeApprovalItem) GetNonEmployeeRequest() NonEmployeeRequestLite` + +GetNonEmployeeRequest returns the NonEmployeeRequest field if non-nil, zero value otherwise. + +### GetNonEmployeeRequestOk + +`func (o *NonEmployeeApprovalItem) GetNonEmployeeRequestOk() (*NonEmployeeRequestLite, bool)` + +GetNonEmployeeRequestOk returns a tuple with the NonEmployeeRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeRequest + +`func (o *NonEmployeeApprovalItem) SetNonEmployeeRequest(v NonEmployeeRequestLite)` + +SetNonEmployeeRequest sets NonEmployeeRequest field to given value. + +### HasNonEmployeeRequest + +`func (o *NonEmployeeApprovalItem) HasNonEmployeeRequest() bool` + +HasNonEmployeeRequest returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeApprovalItemBase.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeApprovalItemBase.md new file mode 100644 index 000000000..5bcfc34cd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeApprovalItemBase.md @@ -0,0 +1,246 @@ +--- +id: v2025-non-employee-approval-item-base +title: NonEmployeeApprovalItemBase +pagination_label: NonEmployeeApprovalItemBase +sidebar_label: NonEmployeeApprovalItemBase +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalItemBase', 'V2025NonEmployeeApprovalItemBase'] +slug: /tools/sdk/go/v2025/models/non-employee-approval-item-base +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemBase', 'V2025NonEmployeeApprovalItemBase'] +--- + +# NonEmployeeApprovalItemBase + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **string** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **float32** | Approval order | [optional] +**Comment** | Pointer to **string** | comment of approver | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeApprovalItemBase + +`func NewNonEmployeeApprovalItemBase() *NonEmployeeApprovalItemBase` + +NewNonEmployeeApprovalItemBase instantiates a new NonEmployeeApprovalItemBase 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 + +### NewNonEmployeeApprovalItemBaseWithDefaults + +`func NewNonEmployeeApprovalItemBaseWithDefaults() *NonEmployeeApprovalItemBase` + +NewNonEmployeeApprovalItemBaseWithDefaults instantiates a new NonEmployeeApprovalItemBase 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 + +### GetId + +`func (o *NonEmployeeApprovalItemBase) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeApprovalItemBase) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeApprovalItemBase) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeApprovalItemBase) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetApprover + +`func (o *NonEmployeeApprovalItemBase) GetApprover() NonEmployeeIdentityReferenceWithId` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *NonEmployeeApprovalItemBase) GetApproverOk() (*NonEmployeeIdentityReferenceWithId, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *NonEmployeeApprovalItemBase) SetApprover(v NonEmployeeIdentityReferenceWithId)` + +SetApprover sets Approver field to given value. + +### HasApprover + +`func (o *NonEmployeeApprovalItemBase) HasApprover() bool` + +HasApprover returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeApprovalItemBase) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeApprovalItemBase) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeApprovalItemBase) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeApprovalItemBase) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeApprovalItemBase) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeApprovalItemBase) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeApprovalItemBase) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeApprovalItemBase) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetApprovalOrder + +`func (o *NonEmployeeApprovalItemBase) GetApprovalOrder() float32` + +GetApprovalOrder returns the ApprovalOrder field if non-nil, zero value otherwise. + +### GetApprovalOrderOk + +`func (o *NonEmployeeApprovalItemBase) GetApprovalOrderOk() (*float32, bool)` + +GetApprovalOrderOk returns a tuple with the ApprovalOrder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalOrder + +`func (o *NonEmployeeApprovalItemBase) SetApprovalOrder(v float32)` + +SetApprovalOrder sets ApprovalOrder field to given value. + +### HasApprovalOrder + +`func (o *NonEmployeeApprovalItemBase) HasApprovalOrder() bool` + +HasApprovalOrder returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeApprovalItemBase) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeApprovalItemBase) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeApprovalItemBase) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeApprovalItemBase) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeApprovalItemBase) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeApprovalItemBase) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeApprovalItemBase) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeApprovalItemBase) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeApprovalItemBase) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeApprovalItemBase) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeApprovalItemBase) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeApprovalItemBase) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeApprovalItemDetail.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeApprovalItemDetail.md new file mode 100644 index 000000000..20028e00c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeApprovalItemDetail.md @@ -0,0 +1,272 @@ +--- +id: v2025-non-employee-approval-item-detail +title: NonEmployeeApprovalItemDetail +pagination_label: NonEmployeeApprovalItemDetail +sidebar_label: NonEmployeeApprovalItemDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalItemDetail', 'V2025NonEmployeeApprovalItemDetail'] +slug: /tools/sdk/go/v2025/models/non-employee-approval-item-detail +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemDetail', 'V2025NonEmployeeApprovalItemDetail'] +--- + +# NonEmployeeApprovalItemDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **string** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **float32** | Approval order | [optional] +**Comment** | Pointer to **string** | comment of approver | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestWithoutApprovalItem**](non-employee-request-without-approval-item) | | [optional] + +## Methods + +### NewNonEmployeeApprovalItemDetail + +`func NewNonEmployeeApprovalItemDetail() *NonEmployeeApprovalItemDetail` + +NewNonEmployeeApprovalItemDetail instantiates a new NonEmployeeApprovalItemDetail 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 + +### NewNonEmployeeApprovalItemDetailWithDefaults + +`func NewNonEmployeeApprovalItemDetailWithDefaults() *NonEmployeeApprovalItemDetail` + +NewNonEmployeeApprovalItemDetailWithDefaults instantiates a new NonEmployeeApprovalItemDetail 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 + +### GetId + +`func (o *NonEmployeeApprovalItemDetail) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeApprovalItemDetail) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeApprovalItemDetail) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeApprovalItemDetail) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetApprover + +`func (o *NonEmployeeApprovalItemDetail) GetApprover() NonEmployeeIdentityReferenceWithId` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *NonEmployeeApprovalItemDetail) GetApproverOk() (*NonEmployeeIdentityReferenceWithId, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *NonEmployeeApprovalItemDetail) SetApprover(v NonEmployeeIdentityReferenceWithId)` + +SetApprover sets Approver field to given value. + +### HasApprover + +`func (o *NonEmployeeApprovalItemDetail) HasApprover() bool` + +HasApprover returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeApprovalItemDetail) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeApprovalItemDetail) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeApprovalItemDetail) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeApprovalItemDetail) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeApprovalItemDetail) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeApprovalItemDetail) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeApprovalItemDetail) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeApprovalItemDetail) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetApprovalOrder + +`func (o *NonEmployeeApprovalItemDetail) GetApprovalOrder() float32` + +GetApprovalOrder returns the ApprovalOrder field if non-nil, zero value otherwise. + +### GetApprovalOrderOk + +`func (o *NonEmployeeApprovalItemDetail) GetApprovalOrderOk() (*float32, bool)` + +GetApprovalOrderOk returns a tuple with the ApprovalOrder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalOrder + +`func (o *NonEmployeeApprovalItemDetail) SetApprovalOrder(v float32)` + +SetApprovalOrder sets ApprovalOrder field to given value. + +### HasApprovalOrder + +`func (o *NonEmployeeApprovalItemDetail) HasApprovalOrder() bool` + +HasApprovalOrder returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeApprovalItemDetail) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeApprovalItemDetail) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeApprovalItemDetail) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeApprovalItemDetail) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeApprovalItemDetail) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeApprovalItemDetail) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeApprovalItemDetail) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeApprovalItemDetail) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeApprovalItemDetail) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeApprovalItemDetail) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeApprovalItemDetail) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeApprovalItemDetail) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetNonEmployeeRequest + +`func (o *NonEmployeeApprovalItemDetail) GetNonEmployeeRequest() NonEmployeeRequestWithoutApprovalItem` + +GetNonEmployeeRequest returns the NonEmployeeRequest field if non-nil, zero value otherwise. + +### GetNonEmployeeRequestOk + +`func (o *NonEmployeeApprovalItemDetail) GetNonEmployeeRequestOk() (*NonEmployeeRequestWithoutApprovalItem, bool)` + +GetNonEmployeeRequestOk returns a tuple with the NonEmployeeRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeRequest + +`func (o *NonEmployeeApprovalItemDetail) SetNonEmployeeRequest(v NonEmployeeRequestWithoutApprovalItem)` + +SetNonEmployeeRequest sets NonEmployeeRequest field to given value. + +### HasNonEmployeeRequest + +`func (o *NonEmployeeApprovalItemDetail) HasNonEmployeeRequest() bool` + +HasNonEmployeeRequest returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeApprovalSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeApprovalSummary.md new file mode 100644 index 000000000..e6cbf7176 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeApprovalSummary.md @@ -0,0 +1,116 @@ +--- +id: v2025-non-employee-approval-summary +title: NonEmployeeApprovalSummary +pagination_label: NonEmployeeApprovalSummary +sidebar_label: NonEmployeeApprovalSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalSummary', 'V2025NonEmployeeApprovalSummary'] +slug: /tools/sdk/go/v2025/models/non-employee-approval-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalSummary', 'V2025NonEmployeeApprovalSummary'] +--- + +# NonEmployeeApprovalSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | Pointer to **int32** | The number of approved non-employee approval requests. | [optional] +**Pending** | Pointer to **int32** | The number of pending non-employee approval requests. | [optional] +**Rejected** | Pointer to **int32** | The number of rejected non-employee approval requests. | [optional] + +## Methods + +### NewNonEmployeeApprovalSummary + +`func NewNonEmployeeApprovalSummary() *NonEmployeeApprovalSummary` + +NewNonEmployeeApprovalSummary instantiates a new NonEmployeeApprovalSummary 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 + +### NewNonEmployeeApprovalSummaryWithDefaults + +`func NewNonEmployeeApprovalSummaryWithDefaults() *NonEmployeeApprovalSummary` + +NewNonEmployeeApprovalSummaryWithDefaults instantiates a new NonEmployeeApprovalSummary 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 + +### GetApproved + +`func (o *NonEmployeeApprovalSummary) GetApproved() int32` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *NonEmployeeApprovalSummary) GetApprovedOk() (*int32, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *NonEmployeeApprovalSummary) SetApproved(v int32)` + +SetApproved sets Approved field to given value. + +### HasApproved + +`func (o *NonEmployeeApprovalSummary) HasApproved() bool` + +HasApproved returns a boolean if a field has been set. + +### GetPending + +`func (o *NonEmployeeApprovalSummary) GetPending() int32` + +GetPending returns the Pending field if non-nil, zero value otherwise. + +### GetPendingOk + +`func (o *NonEmployeeApprovalSummary) GetPendingOk() (*int32, bool)` + +GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPending + +`func (o *NonEmployeeApprovalSummary) SetPending(v int32)` + +SetPending sets Pending field to given value. + +### HasPending + +`func (o *NonEmployeeApprovalSummary) HasPending() bool` + +HasPending returns a boolean if a field has been set. + +### GetRejected + +`func (o *NonEmployeeApprovalSummary) GetRejected() int32` + +GetRejected returns the Rejected field if non-nil, zero value otherwise. + +### GetRejectedOk + +`func (o *NonEmployeeApprovalSummary) GetRejectedOk() (*int32, bool)` + +GetRejectedOk returns a tuple with the Rejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRejected + +`func (o *NonEmployeeApprovalSummary) SetRejected(v int32)` + +SetRejected sets Rejected field to given value. + +### HasRejected + +`func (o *NonEmployeeApprovalSummary) HasRejected() bool` + +HasRejected returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeBulkUploadJob.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeBulkUploadJob.md new file mode 100644 index 000000000..51e40f782 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeBulkUploadJob.md @@ -0,0 +1,168 @@ +--- +id: v2025-non-employee-bulk-upload-job +title: NonEmployeeBulkUploadJob +pagination_label: NonEmployeeBulkUploadJob +sidebar_label: NonEmployeeBulkUploadJob +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeBulkUploadJob', 'V2025NonEmployeeBulkUploadJob'] +slug: /tools/sdk/go/v2025/models/non-employee-bulk-upload-job +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadJob', 'V2025NonEmployeeBulkUploadJob'] +--- + +# NonEmployeeBulkUploadJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The bulk upload job's ID. (UUID) | [optional] +**SourceId** | Pointer to **string** | The ID of the source to bulk-upload non-employees to. (UUID) | [optional] +**Created** | Pointer to **SailPointTime** | The date-time the job was submitted. | [optional] +**Modified** | Pointer to **SailPointTime** | The date-time that the job was last updated. | [optional] +**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. | [optional] + +## Methods + +### NewNonEmployeeBulkUploadJob + +`func NewNonEmployeeBulkUploadJob() *NonEmployeeBulkUploadJob` + +NewNonEmployeeBulkUploadJob instantiates a new NonEmployeeBulkUploadJob 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 + +### NewNonEmployeeBulkUploadJobWithDefaults + +`func NewNonEmployeeBulkUploadJobWithDefaults() *NonEmployeeBulkUploadJob` + +NewNonEmployeeBulkUploadJobWithDefaults instantiates a new NonEmployeeBulkUploadJob 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 + +### GetId + +`func (o *NonEmployeeBulkUploadJob) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeBulkUploadJob) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeBulkUploadJob) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeBulkUploadJob) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeBulkUploadJob) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeBulkUploadJob) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeBulkUploadJob) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeBulkUploadJob) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeBulkUploadJob) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeBulkUploadJob) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeBulkUploadJob) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeBulkUploadJob) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeBulkUploadJob) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeBulkUploadJob) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeBulkUploadJob) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeBulkUploadJob) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetStatus + +`func (o *NonEmployeeBulkUploadJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *NonEmployeeBulkUploadJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *NonEmployeeBulkUploadJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *NonEmployeeBulkUploadJob) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeBulkUploadStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeBulkUploadStatus.md new file mode 100644 index 000000000..43fd05091 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeBulkUploadStatus.md @@ -0,0 +1,64 @@ +--- +id: v2025-non-employee-bulk-upload-status +title: NonEmployeeBulkUploadStatus +pagination_label: NonEmployeeBulkUploadStatus +sidebar_label: NonEmployeeBulkUploadStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeBulkUploadStatus', 'V2025NonEmployeeBulkUploadStatus'] +slug: /tools/sdk/go/v2025/models/non-employee-bulk-upload-status +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadStatus', 'V2025NonEmployeeBulkUploadStatus'] +--- + +# NonEmployeeBulkUploadStatus + +## Properties + +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] + +## Methods + +### NewNonEmployeeBulkUploadStatus + +`func NewNonEmployeeBulkUploadStatus() *NonEmployeeBulkUploadStatus` + +NewNonEmployeeBulkUploadStatus instantiates a new NonEmployeeBulkUploadStatus 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 + +### NewNonEmployeeBulkUploadStatusWithDefaults + +`func NewNonEmployeeBulkUploadStatusWithDefaults() *NonEmployeeBulkUploadStatus` + +NewNonEmployeeBulkUploadStatusWithDefaults instantiates a new NonEmployeeBulkUploadStatus 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 + +### GetStatus + +`func (o *NonEmployeeBulkUploadStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *NonEmployeeBulkUploadStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *NonEmployeeBulkUploadStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *NonEmployeeBulkUploadStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeIdentityDtoType.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeIdentityDtoType.md new file mode 100644 index 000000000..968eb63ff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeIdentityDtoType.md @@ -0,0 +1,21 @@ +--- +id: v2025-non-employee-identity-dto-type +title: NonEmployeeIdentityDtoType +pagination_label: NonEmployeeIdentityDtoType +sidebar_label: NonEmployeeIdentityDtoType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeIdentityDtoType', 'V2025NonEmployeeIdentityDtoType'] +slug: /tools/sdk/go/v2025/models/non-employee-identity-dto-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdentityDtoType', 'V2025NonEmployeeIdentityDtoType'] +--- + +# NonEmployeeIdentityDtoType + +## Enum + + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + +* `IDENTITY` (value: `"IDENTITY"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeIdentityReferenceWithId.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeIdentityReferenceWithId.md new file mode 100644 index 000000000..e2784ce2f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeIdentityReferenceWithId.md @@ -0,0 +1,90 @@ +--- +id: v2025-non-employee-identity-reference-with-id +title: NonEmployeeIdentityReferenceWithId +pagination_label: NonEmployeeIdentityReferenceWithId +sidebar_label: NonEmployeeIdentityReferenceWithId +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeIdentityReferenceWithId', 'V2025NonEmployeeIdentityReferenceWithId'] +slug: /tools/sdk/go/v2025/models/non-employee-identity-reference-with-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdentityReferenceWithId', 'V2025NonEmployeeIdentityReferenceWithId'] +--- + +# NonEmployeeIdentityReferenceWithId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**NonEmployeeIdentityDtoType**](non-employee-identity-dto-type) | | [optional] +**Id** | Pointer to **string** | Identity id | [optional] + +## Methods + +### NewNonEmployeeIdentityReferenceWithId + +`func NewNonEmployeeIdentityReferenceWithId() *NonEmployeeIdentityReferenceWithId` + +NewNonEmployeeIdentityReferenceWithId instantiates a new NonEmployeeIdentityReferenceWithId 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 + +### NewNonEmployeeIdentityReferenceWithIdWithDefaults + +`func NewNonEmployeeIdentityReferenceWithIdWithDefaults() *NonEmployeeIdentityReferenceWithId` + +NewNonEmployeeIdentityReferenceWithIdWithDefaults instantiates a new NonEmployeeIdentityReferenceWithId 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 + +### GetType + +`func (o *NonEmployeeIdentityReferenceWithId) GetType() NonEmployeeIdentityDtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NonEmployeeIdentityReferenceWithId) GetTypeOk() (*NonEmployeeIdentityDtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NonEmployeeIdentityReferenceWithId) SetType(v NonEmployeeIdentityDtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *NonEmployeeIdentityReferenceWithId) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *NonEmployeeIdentityReferenceWithId) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeIdentityReferenceWithId) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeIdentityReferenceWithId) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeIdentityReferenceWithId) HasId() bool` + +HasId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeIdnUserRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeIdnUserRequest.md new file mode 100644 index 000000000..d2ba2f829 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeIdnUserRequest.md @@ -0,0 +1,59 @@ +--- +id: v2025-non-employee-idn-user-request +title: NonEmployeeIdnUserRequest +pagination_label: NonEmployeeIdnUserRequest +sidebar_label: NonEmployeeIdnUserRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeIdnUserRequest', 'V2025NonEmployeeIdnUserRequest'] +slug: /tools/sdk/go/v2025/models/non-employee-idn-user-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdnUserRequest', 'V2025NonEmployeeIdnUserRequest'] +--- + +# NonEmployeeIdnUserRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Identity id. | + +## Methods + +### NewNonEmployeeIdnUserRequest + +`func NewNonEmployeeIdnUserRequest(id string, ) *NonEmployeeIdnUserRequest` + +NewNonEmployeeIdnUserRequest instantiates a new NonEmployeeIdnUserRequest 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 + +### NewNonEmployeeIdnUserRequestWithDefaults + +`func NewNonEmployeeIdnUserRequestWithDefaults() *NonEmployeeIdnUserRequest` + +NewNonEmployeeIdnUserRequestWithDefaults instantiates a new NonEmployeeIdnUserRequest 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 + +### GetId + +`func (o *NonEmployeeIdnUserRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeIdnUserRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeIdnUserRequest) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRecord.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRecord.md new file mode 100644 index 000000000..1685004af --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRecord.md @@ -0,0 +1,376 @@ +--- +id: v2025-non-employee-record +title: NonEmployeeRecord +pagination_label: NonEmployeeRecord +sidebar_label: NonEmployeeRecord +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRecord', 'V2025NonEmployeeRecord'] +slug: /tools/sdk/go/v2025/models/non-employee-record +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRecord', 'V2025NonEmployeeRecord'] +--- + +# NonEmployeeRecord + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee record id. | [optional] +**AccountName** | Pointer to **string** | Requested identity account name. | [optional] +**FirstName** | Pointer to **string** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **string** | Non-Employee's last name. | [optional] +**Email** | Pointer to **string** | Non-Employee's email. | [optional] +**Phone** | Pointer to **string** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **string** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**SourceId** | Pointer to **string** | Non-Employee's source id. | [optional] +**Data** | Pointer to **map[string]string** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**StartDate** | Pointer to **SailPointTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **SailPointTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeRecord + +`func NewNonEmployeeRecord() *NonEmployeeRecord` + +NewNonEmployeeRecord instantiates a new NonEmployeeRecord 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 + +### NewNonEmployeeRecordWithDefaults + +`func NewNonEmployeeRecordWithDefaults() *NonEmployeeRecord` + +NewNonEmployeeRecordWithDefaults instantiates a new NonEmployeeRecord 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 + +### GetId + +`func (o *NonEmployeeRecord) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeRecord) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeRecord) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeRecord) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeRecord) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeRecord) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeRecord) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeRecord) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *NonEmployeeRecord) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *NonEmployeeRecord) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *NonEmployeeRecord) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *NonEmployeeRecord) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### GetLastName + +`func (o *NonEmployeeRecord) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *NonEmployeeRecord) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *NonEmployeeRecord) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *NonEmployeeRecord) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### GetEmail + +`func (o *NonEmployeeRecord) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *NonEmployeeRecord) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *NonEmployeeRecord) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *NonEmployeeRecord) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetPhone + +`func (o *NonEmployeeRecord) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *NonEmployeeRecord) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *NonEmployeeRecord) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *NonEmployeeRecord) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### GetManager + +`func (o *NonEmployeeRecord) GetManager() string` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *NonEmployeeRecord) GetManagerOk() (*string, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *NonEmployeeRecord) SetManager(v string)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *NonEmployeeRecord) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeRecord) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeRecord) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeRecord) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeRecord) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetData + +`func (o *NonEmployeeRecord) GetData() map[string]string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *NonEmployeeRecord) GetDataOk() (*map[string]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *NonEmployeeRecord) SetData(v map[string]string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *NonEmployeeRecord) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetStartDate + +`func (o *NonEmployeeRecord) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NonEmployeeRecord) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *NonEmployeeRecord) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *NonEmployeeRecord) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *NonEmployeeRecord) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *NonEmployeeRecord) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *NonEmployeeRecord) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *NonEmployeeRecord) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeRecord) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeRecord) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeRecord) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeRecord) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeRecord) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeRecord) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeRecord) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeRecord) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRejectApprovalDecision.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRejectApprovalDecision.md new file mode 100644 index 000000000..01b5b9a57 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRejectApprovalDecision.md @@ -0,0 +1,59 @@ +--- +id: v2025-non-employee-reject-approval-decision +title: NonEmployeeRejectApprovalDecision +pagination_label: NonEmployeeRejectApprovalDecision +sidebar_label: NonEmployeeRejectApprovalDecision +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRejectApprovalDecision', 'V2025NonEmployeeRejectApprovalDecision'] +slug: /tools/sdk/go/v2025/models/non-employee-reject-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRejectApprovalDecision', 'V2025NonEmployeeRejectApprovalDecision'] +--- + +# NonEmployeeRejectApprovalDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | **string** | Comment on the approval item. | + +## Methods + +### NewNonEmployeeRejectApprovalDecision + +`func NewNonEmployeeRejectApprovalDecision(comment string, ) *NonEmployeeRejectApprovalDecision` + +NewNonEmployeeRejectApprovalDecision instantiates a new NonEmployeeRejectApprovalDecision 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 + +### NewNonEmployeeRejectApprovalDecisionWithDefaults + +`func NewNonEmployeeRejectApprovalDecisionWithDefaults() *NonEmployeeRejectApprovalDecision` + +NewNonEmployeeRejectApprovalDecisionWithDefaults instantiates a new NonEmployeeRejectApprovalDecision 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 + +### GetComment + +`func (o *NonEmployeeRejectApprovalDecision) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeRejectApprovalDecision) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeRejectApprovalDecision) SetComment(v string)` + +SetComment sets Comment field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRequest.md new file mode 100644 index 000000000..d9bffa26d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRequest.md @@ -0,0 +1,558 @@ +--- +id: v2025-non-employee-request +title: NonEmployeeRequest +pagination_label: NonEmployeeRequest +sidebar_label: NonEmployeeRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequest', 'V2025NonEmployeeRequest'] +slug: /tools/sdk/go/v2025/models/non-employee-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequest', 'V2025NonEmployeeRequest'] +--- + +# NonEmployeeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**AccountName** | Pointer to **string** | Requested identity account name. | [optional] +**FirstName** | Pointer to **string** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **string** | Non-Employee's last name. | [optional] +**Email** | Pointer to **string** | Non-Employee's email. | [optional] +**Phone** | Pointer to **string** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **string** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLite**](non-employee-source-lite) | | [optional] +**Data** | Pointer to **map[string]string** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**ApprovalItems** | Pointer to [**[]NonEmployeeApprovalItemBase**](non-employee-approval-item-base) | List of approval item for the request | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**Comment** | Pointer to **string** | Comment of requester | [optional] +**CompletionDate** | Pointer to **SailPointTime** | When the request was completely approved. | [optional] +**StartDate** | Pointer to **SailPointTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **SailPointTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeRequest + +`func NewNonEmployeeRequest() *NonEmployeeRequest` + +NewNonEmployeeRequest instantiates a new NonEmployeeRequest 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 + +### NewNonEmployeeRequestWithDefaults + +`func NewNonEmployeeRequestWithDefaults() *NonEmployeeRequest` + +NewNonEmployeeRequestWithDefaults instantiates a new NonEmployeeRequest 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 + +### GetId + +`func (o *NonEmployeeRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeRequest) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeRequest) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeRequest) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeRequest) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeRequest) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeRequest) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeRequest) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeRequest) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeRequest) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeRequest) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *NonEmployeeRequest) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *NonEmployeeRequest) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *NonEmployeeRequest) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *NonEmployeeRequest) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### GetLastName + +`func (o *NonEmployeeRequest) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *NonEmployeeRequest) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *NonEmployeeRequest) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *NonEmployeeRequest) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### GetEmail + +`func (o *NonEmployeeRequest) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *NonEmployeeRequest) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *NonEmployeeRequest) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *NonEmployeeRequest) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetPhone + +`func (o *NonEmployeeRequest) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *NonEmployeeRequest) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *NonEmployeeRequest) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *NonEmployeeRequest) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### GetManager + +`func (o *NonEmployeeRequest) GetManager() string` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *NonEmployeeRequest) GetManagerOk() (*string, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *NonEmployeeRequest) SetManager(v string)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *NonEmployeeRequest) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### GetNonEmployeeSource + +`func (o *NonEmployeeRequest) GetNonEmployeeSource() NonEmployeeSourceLite` + +GetNonEmployeeSource returns the NonEmployeeSource field if non-nil, zero value otherwise. + +### GetNonEmployeeSourceOk + +`func (o *NonEmployeeRequest) GetNonEmployeeSourceOk() (*NonEmployeeSourceLite, bool)` + +GetNonEmployeeSourceOk returns a tuple with the NonEmployeeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeSource + +`func (o *NonEmployeeRequest) SetNonEmployeeSource(v NonEmployeeSourceLite)` + +SetNonEmployeeSource sets NonEmployeeSource field to given value. + +### HasNonEmployeeSource + +`func (o *NonEmployeeRequest) HasNonEmployeeSource() bool` + +HasNonEmployeeSource returns a boolean if a field has been set. + +### GetData + +`func (o *NonEmployeeRequest) GetData() map[string]string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *NonEmployeeRequest) GetDataOk() (*map[string]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *NonEmployeeRequest) SetData(v map[string]string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *NonEmployeeRequest) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetApprovalItems + +`func (o *NonEmployeeRequest) GetApprovalItems() []NonEmployeeApprovalItemBase` + +GetApprovalItems returns the ApprovalItems field if non-nil, zero value otherwise. + +### GetApprovalItemsOk + +`func (o *NonEmployeeRequest) GetApprovalItemsOk() (*[]NonEmployeeApprovalItemBase, bool)` + +GetApprovalItemsOk returns a tuple with the ApprovalItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalItems + +`func (o *NonEmployeeRequest) SetApprovalItems(v []NonEmployeeApprovalItemBase)` + +SetApprovalItems sets ApprovalItems field to given value. + +### HasApprovalItems + +`func (o *NonEmployeeRequest) HasApprovalItems() bool` + +HasApprovalItems returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeRequest) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeRequest) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeRequest) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeRequest) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeRequest) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeRequest) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeRequest) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeRequest) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetCompletionDate + +`func (o *NonEmployeeRequest) GetCompletionDate() SailPointTime` + +GetCompletionDate returns the CompletionDate field if non-nil, zero value otherwise. + +### GetCompletionDateOk + +`func (o *NonEmployeeRequest) GetCompletionDateOk() (*SailPointTime, bool)` + +GetCompletionDateOk returns a tuple with the CompletionDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionDate + +`func (o *NonEmployeeRequest) SetCompletionDate(v SailPointTime)` + +SetCompletionDate sets CompletionDate field to given value. + +### HasCompletionDate + +`func (o *NonEmployeeRequest) HasCompletionDate() bool` + +HasCompletionDate returns a boolean if a field has been set. + +### GetStartDate + +`func (o *NonEmployeeRequest) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NonEmployeeRequest) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *NonEmployeeRequest) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *NonEmployeeRequest) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *NonEmployeeRequest) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *NonEmployeeRequest) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *NonEmployeeRequest) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *NonEmployeeRequest) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeRequest) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeRequest) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeRequest) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeRequest) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeRequest) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeRequest) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeRequest) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeRequest) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRequestBody.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRequestBody.md new file mode 100644 index 000000000..a46c4fac1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRequestBody.md @@ -0,0 +1,253 @@ +--- +id: v2025-non-employee-request-body +title: NonEmployeeRequestBody +pagination_label: NonEmployeeRequestBody +sidebar_label: NonEmployeeRequestBody +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequestBody', 'V2025NonEmployeeRequestBody'] +slug: /tools/sdk/go/v2025/models/non-employee-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestBody', 'V2025NonEmployeeRequestBody'] +--- + +# NonEmployeeRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountName** | **string** | Requested identity account name. | +**FirstName** | **string** | Non-Employee's first name. | +**LastName** | **string** | Non-Employee's last name. | +**Email** | **string** | Non-Employee's email. | +**Phone** | **string** | Non-Employee's phone. | +**Manager** | **string** | The account ID of a valid identity to serve as this non-employee's manager. | +**SourceId** | **string** | Non-Employee's source id. | +**Data** | Pointer to **map[string]string** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**StartDate** | **SailPointTime** | Non-Employee employment start date. | +**EndDate** | **SailPointTime** | Non-Employee employment end date. | + +## Methods + +### NewNonEmployeeRequestBody + +`func NewNonEmployeeRequestBody(accountName string, firstName string, lastName string, email string, phone string, manager string, sourceId string, startDate SailPointTime, endDate SailPointTime, ) *NonEmployeeRequestBody` + +NewNonEmployeeRequestBody instantiates a new NonEmployeeRequestBody 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 + +### NewNonEmployeeRequestBodyWithDefaults + +`func NewNonEmployeeRequestBodyWithDefaults() *NonEmployeeRequestBody` + +NewNonEmployeeRequestBodyWithDefaults instantiates a new NonEmployeeRequestBody 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 + +### GetAccountName + +`func (o *NonEmployeeRequestBody) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeRequestBody) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeRequestBody) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + + +### GetFirstName + +`func (o *NonEmployeeRequestBody) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *NonEmployeeRequestBody) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *NonEmployeeRequestBody) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + + +### GetLastName + +`func (o *NonEmployeeRequestBody) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *NonEmployeeRequestBody) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *NonEmployeeRequestBody) SetLastName(v string)` + +SetLastName sets LastName field to given value. + + +### GetEmail + +`func (o *NonEmployeeRequestBody) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *NonEmployeeRequestBody) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *NonEmployeeRequestBody) SetEmail(v string)` + +SetEmail sets Email field to given value. + + +### GetPhone + +`func (o *NonEmployeeRequestBody) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *NonEmployeeRequestBody) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *NonEmployeeRequestBody) SetPhone(v string)` + +SetPhone sets Phone field to given value. + + +### GetManager + +`func (o *NonEmployeeRequestBody) GetManager() string` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *NonEmployeeRequestBody) GetManagerOk() (*string, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *NonEmployeeRequestBody) SetManager(v string)` + +SetManager sets Manager field to given value. + + +### GetSourceId + +`func (o *NonEmployeeRequestBody) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeRequestBody) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeRequestBody) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetData + +`func (o *NonEmployeeRequestBody) GetData() map[string]string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *NonEmployeeRequestBody) GetDataOk() (*map[string]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *NonEmployeeRequestBody) SetData(v map[string]string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *NonEmployeeRequestBody) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetStartDate + +`func (o *NonEmployeeRequestBody) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NonEmployeeRequestBody) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *NonEmployeeRequestBody) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + + +### GetEndDate + +`func (o *NonEmployeeRequestBody) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *NonEmployeeRequestBody) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *NonEmployeeRequestBody) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRequestLite.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRequestLite.md new file mode 100644 index 000000000..8c8dc54a6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRequestLite.md @@ -0,0 +1,90 @@ +--- +id: v2025-non-employee-request-lite +title: NonEmployeeRequestLite +pagination_label: NonEmployeeRequestLite +sidebar_label: NonEmployeeRequestLite +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequestLite', 'V2025NonEmployeeRequestLite'] +slug: /tools/sdk/go/v2025/models/non-employee-request-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestLite', 'V2025NonEmployeeRequestLite'] +--- + +# NonEmployeeRequestLite + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee request id. | [optional] +**Requester** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] + +## Methods + +### NewNonEmployeeRequestLite + +`func NewNonEmployeeRequestLite() *NonEmployeeRequestLite` + +NewNonEmployeeRequestLite instantiates a new NonEmployeeRequestLite 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 + +### NewNonEmployeeRequestLiteWithDefaults + +`func NewNonEmployeeRequestLiteWithDefaults() *NonEmployeeRequestLite` + +NewNonEmployeeRequestLiteWithDefaults instantiates a new NonEmployeeRequestLite 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 + +### GetId + +`func (o *NonEmployeeRequestLite) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeRequestLite) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeRequestLite) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeRequestLite) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRequester + +`func (o *NonEmployeeRequestLite) GetRequester() NonEmployeeIdentityReferenceWithId` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *NonEmployeeRequestLite) GetRequesterOk() (*NonEmployeeIdentityReferenceWithId, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *NonEmployeeRequestLite) SetRequester(v NonEmployeeIdentityReferenceWithId)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *NonEmployeeRequestLite) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRequestSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRequestSummary.md new file mode 100644 index 000000000..d37ec7b0c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRequestSummary.md @@ -0,0 +1,142 @@ +--- +id: v2025-non-employee-request-summary +title: NonEmployeeRequestSummary +pagination_label: NonEmployeeRequestSummary +sidebar_label: NonEmployeeRequestSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequestSummary', 'V2025NonEmployeeRequestSummary'] +slug: /tools/sdk/go/v2025/models/non-employee-request-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestSummary', 'V2025NonEmployeeRequestSummary'] +--- + +# NonEmployeeRequestSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | Pointer to **int32** | The number of approved non-employee requests on all sources that *requested-for* user manages. | [optional] +**Rejected** | Pointer to **int32** | The number of rejected non-employee requests on all sources that *requested-for* user manages. | [optional] +**Pending** | Pointer to **int32** | The number of pending non-employee requests on all sources that *requested-for* user manages. | [optional] +**NonEmployeeCount** | Pointer to **int32** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] + +## Methods + +### NewNonEmployeeRequestSummary + +`func NewNonEmployeeRequestSummary() *NonEmployeeRequestSummary` + +NewNonEmployeeRequestSummary instantiates a new NonEmployeeRequestSummary 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 + +### NewNonEmployeeRequestSummaryWithDefaults + +`func NewNonEmployeeRequestSummaryWithDefaults() *NonEmployeeRequestSummary` + +NewNonEmployeeRequestSummaryWithDefaults instantiates a new NonEmployeeRequestSummary 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 + +### GetApproved + +`func (o *NonEmployeeRequestSummary) GetApproved() int32` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *NonEmployeeRequestSummary) GetApprovedOk() (*int32, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *NonEmployeeRequestSummary) SetApproved(v int32)` + +SetApproved sets Approved field to given value. + +### HasApproved + +`func (o *NonEmployeeRequestSummary) HasApproved() bool` + +HasApproved returns a boolean if a field has been set. + +### GetRejected + +`func (o *NonEmployeeRequestSummary) GetRejected() int32` + +GetRejected returns the Rejected field if non-nil, zero value otherwise. + +### GetRejectedOk + +`func (o *NonEmployeeRequestSummary) GetRejectedOk() (*int32, bool)` + +GetRejectedOk returns a tuple with the Rejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRejected + +`func (o *NonEmployeeRequestSummary) SetRejected(v int32)` + +SetRejected sets Rejected field to given value. + +### HasRejected + +`func (o *NonEmployeeRequestSummary) HasRejected() bool` + +HasRejected returns a boolean if a field has been set. + +### GetPending + +`func (o *NonEmployeeRequestSummary) GetPending() int32` + +GetPending returns the Pending field if non-nil, zero value otherwise. + +### GetPendingOk + +`func (o *NonEmployeeRequestSummary) GetPendingOk() (*int32, bool)` + +GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPending + +`func (o *NonEmployeeRequestSummary) SetPending(v int32)` + +SetPending sets Pending field to given value. + +### HasPending + +`func (o *NonEmployeeRequestSummary) HasPending() bool` + +HasPending returns a boolean if a field has been set. + +### GetNonEmployeeCount + +`func (o *NonEmployeeRequestSummary) GetNonEmployeeCount() int32` + +GetNonEmployeeCount returns the NonEmployeeCount field if non-nil, zero value otherwise. + +### GetNonEmployeeCountOk + +`func (o *NonEmployeeRequestSummary) GetNonEmployeeCountOk() (*int32, bool)` + +GetNonEmployeeCountOk returns a tuple with the NonEmployeeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeCount + +`func (o *NonEmployeeRequestSummary) SetNonEmployeeCount(v int32)` + +SetNonEmployeeCount sets NonEmployeeCount field to given value. + +### HasNonEmployeeCount + +`func (o *NonEmployeeRequestSummary) HasNonEmployeeCount() bool` + +HasNonEmployeeCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md new file mode 100644 index 000000000..5735f5217 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -0,0 +1,480 @@ +--- +id: v2025-non-employee-request-without-approval-item +title: NonEmployeeRequestWithoutApprovalItem +pagination_label: NonEmployeeRequestWithoutApprovalItem +sidebar_label: NonEmployeeRequestWithoutApprovalItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequestWithoutApprovalItem', 'V2025NonEmployeeRequestWithoutApprovalItem'] +slug: /tools/sdk/go/v2025/models/non-employee-request-without-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestWithoutApprovalItem', 'V2025NonEmployeeRequestWithoutApprovalItem'] +--- + +# NonEmployeeRequestWithoutApprovalItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee request id. | [optional] +**Requester** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **string** | Requested identity account name. | [optional] +**FirstName** | Pointer to **string** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **string** | Non-Employee's last name. | [optional] +**Email** | Pointer to **string** | Non-Employee's email. | [optional] +**Phone** | Pointer to **string** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **string** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLiteWithSchemaAttributes**](non-employee-source-lite-with-schema-attributes) | | [optional] +**Data** | Pointer to **map[string]string** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**Comment** | Pointer to **string** | Comment of requester | [optional] +**CompletionDate** | Pointer to **SailPointTime** | When the request was completely approved. | [optional] +**StartDate** | Pointer to **string** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **string** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeRequestWithoutApprovalItem + +`func NewNonEmployeeRequestWithoutApprovalItem() *NonEmployeeRequestWithoutApprovalItem` + +NewNonEmployeeRequestWithoutApprovalItem instantiates a new NonEmployeeRequestWithoutApprovalItem 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 + +### NewNonEmployeeRequestWithoutApprovalItemWithDefaults + +`func NewNonEmployeeRequestWithoutApprovalItemWithDefaults() *NonEmployeeRequestWithoutApprovalItem` + +NewNonEmployeeRequestWithoutApprovalItemWithDefaults instantiates a new NonEmployeeRequestWithoutApprovalItem 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 + +### GetId + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRequester + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetRequester() NonEmployeeIdentityReferenceWithId` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetRequesterOk() (*NonEmployeeIdentityReferenceWithId, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetRequester(v NonEmployeeIdentityReferenceWithId)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### GetLastName + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### GetEmail + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetPhone + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### GetManager + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetManager() string` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetManagerOk() (*string, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetManager(v string)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### GetNonEmployeeSource + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetNonEmployeeSource() NonEmployeeSourceLiteWithSchemaAttributes` + +GetNonEmployeeSource returns the NonEmployeeSource field if non-nil, zero value otherwise. + +### GetNonEmployeeSourceOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetNonEmployeeSourceOk() (*NonEmployeeSourceLiteWithSchemaAttributes, bool)` + +GetNonEmployeeSourceOk returns a tuple with the NonEmployeeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeSource + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetNonEmployeeSource(v NonEmployeeSourceLiteWithSchemaAttributes)` + +SetNonEmployeeSource sets NonEmployeeSource field to given value. + +### HasNonEmployeeSource + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasNonEmployeeSource() bool` + +HasNonEmployeeSource returns a boolean if a field has been set. + +### GetData + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetData() map[string]string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetDataOk() (*map[string]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetData(v map[string]string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetCompletionDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCompletionDate() SailPointTime` + +GetCompletionDate returns the CompletionDate field if non-nil, zero value otherwise. + +### GetCompletionDateOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCompletionDateOk() (*SailPointTime, bool)` + +GetCompletionDateOk returns a tuple with the CompletionDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetCompletionDate(v SailPointTime)` + +SetCompletionDate sets CompletionDate field to given value. + +### HasCompletionDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasCompletionDate() bool` + +HasCompletionDate returns a boolean if a field has been set. + +### GetStartDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetStartDate() string` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetStartDateOk() (*string, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetStartDate(v string)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetEndDate() string` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetEndDateOk() (*string, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetEndDate(v string)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSchemaAttribute.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSchemaAttribute.md new file mode 100644 index 000000000..96c1689b8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSchemaAttribute.md @@ -0,0 +1,283 @@ +--- +id: v2025-non-employee-schema-attribute +title: NonEmployeeSchemaAttribute +pagination_label: NonEmployeeSchemaAttribute +sidebar_label: NonEmployeeSchemaAttribute +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSchemaAttribute', 'V2025NonEmployeeSchemaAttribute'] +slug: /tools/sdk/go/v2025/models/non-employee-schema-attribute +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttribute', 'V2025NonEmployeeSchemaAttribute'] +--- + +# NonEmployeeSchemaAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Schema Attribute Id | [optional] +**System** | Pointer to **bool** | True if this schema attribute is mandatory on all non-employees sources. | [optional] [default to false] +**Modified** | Pointer to **SailPointTime** | When the schema attribute was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the schema attribute was created. | [optional] +**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] +**Required** | Pointer to **bool** | If true, the schema attribute is required for all non-employees in the source | [optional] [default to false] + +## Methods + +### NewNonEmployeeSchemaAttribute + +`func NewNonEmployeeSchemaAttribute(type_ NonEmployeeSchemaAttributeType, label string, technicalName string, ) *NonEmployeeSchemaAttribute` + +NewNonEmployeeSchemaAttribute instantiates a new NonEmployeeSchemaAttribute 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 + +### NewNonEmployeeSchemaAttributeWithDefaults + +`func NewNonEmployeeSchemaAttributeWithDefaults() *NonEmployeeSchemaAttribute` + +NewNonEmployeeSchemaAttributeWithDefaults instantiates a new NonEmployeeSchemaAttribute 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 + +### GetId + +`func (o *NonEmployeeSchemaAttribute) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSchemaAttribute) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSchemaAttribute) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSchemaAttribute) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSystem + +`func (o *NonEmployeeSchemaAttribute) GetSystem() bool` + +GetSystem returns the System field if non-nil, zero value otherwise. + +### GetSystemOk + +`func (o *NonEmployeeSchemaAttribute) GetSystemOk() (*bool, bool)` + +GetSystemOk returns a tuple with the System field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSystem + +`func (o *NonEmployeeSchemaAttribute) SetSystem(v bool)` + +SetSystem sets System field to given value. + +### HasSystem + +`func (o *NonEmployeeSchemaAttribute) HasSystem() bool` + +HasSystem returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeSchemaAttribute) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeSchemaAttribute) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeSchemaAttribute) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeSchemaAttribute) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeSchemaAttribute) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeSchemaAttribute) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeSchemaAttribute) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeSchemaAttribute) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetType + +`func (o *NonEmployeeSchemaAttribute) GetType() NonEmployeeSchemaAttributeType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NonEmployeeSchemaAttribute) GetTypeOk() (*NonEmployeeSchemaAttributeType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NonEmployeeSchemaAttribute) SetType(v NonEmployeeSchemaAttributeType)` + +SetType sets Type field to given value. + + +### GetLabel + +`func (o *NonEmployeeSchemaAttribute) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *NonEmployeeSchemaAttribute) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *NonEmployeeSchemaAttribute) SetLabel(v string)` + +SetLabel sets Label field to given value. + + +### GetTechnicalName + +`func (o *NonEmployeeSchemaAttribute) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *NonEmployeeSchemaAttribute) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *NonEmployeeSchemaAttribute) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + + +### GetHelpText + +`func (o *NonEmployeeSchemaAttribute) GetHelpText() string` + +GetHelpText returns the HelpText field if non-nil, zero value otherwise. + +### GetHelpTextOk + +`func (o *NonEmployeeSchemaAttribute) GetHelpTextOk() (*string, bool)` + +GetHelpTextOk returns a tuple with the HelpText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHelpText + +`func (o *NonEmployeeSchemaAttribute) SetHelpText(v string)` + +SetHelpText sets HelpText field to given value. + +### HasHelpText + +`func (o *NonEmployeeSchemaAttribute) HasHelpText() bool` + +HasHelpText returns a boolean if a field has been set. + +### GetPlaceholder + +`func (o *NonEmployeeSchemaAttribute) GetPlaceholder() string` + +GetPlaceholder returns the Placeholder field if non-nil, zero value otherwise. + +### GetPlaceholderOk + +`func (o *NonEmployeeSchemaAttribute) GetPlaceholderOk() (*string, bool)` + +GetPlaceholderOk returns a tuple with the Placeholder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPlaceholder + +`func (o *NonEmployeeSchemaAttribute) SetPlaceholder(v string)` + +SetPlaceholder sets Placeholder field to given value. + +### HasPlaceholder + +`func (o *NonEmployeeSchemaAttribute) HasPlaceholder() bool` + +HasPlaceholder returns a boolean if a field has been set. + +### GetRequired + +`func (o *NonEmployeeSchemaAttribute) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *NonEmployeeSchemaAttribute) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *NonEmployeeSchemaAttribute) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *NonEmployeeSchemaAttribute) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSchemaAttributeBody.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSchemaAttributeBody.md new file mode 100644 index 000000000..0975123ca --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSchemaAttributeBody.md @@ -0,0 +1,179 @@ +--- +id: v2025-non-employee-schema-attribute-body +title: NonEmployeeSchemaAttributeBody +pagination_label: NonEmployeeSchemaAttributeBody +sidebar_label: NonEmployeeSchemaAttributeBody +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSchemaAttributeBody', 'V2025NonEmployeeSchemaAttributeBody'] +slug: /tools/sdk/go/v2025/models/non-employee-schema-attribute-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeBody', 'V2025NonEmployeeSchemaAttributeBody'] +--- + +# NonEmployeeSchemaAttributeBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of the attribute. Only type 'TEXT' is supported for custom attributes. | +**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] +**Required** | Pointer to **bool** | If true, the schema attribute is required for all non-employees in the source | [optional] + +## Methods + +### NewNonEmployeeSchemaAttributeBody + +`func NewNonEmployeeSchemaAttributeBody(type_ string, label string, technicalName string, ) *NonEmployeeSchemaAttributeBody` + +NewNonEmployeeSchemaAttributeBody instantiates a new NonEmployeeSchemaAttributeBody 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 + +### NewNonEmployeeSchemaAttributeBodyWithDefaults + +`func NewNonEmployeeSchemaAttributeBodyWithDefaults() *NonEmployeeSchemaAttributeBody` + +NewNonEmployeeSchemaAttributeBodyWithDefaults instantiates a new NonEmployeeSchemaAttributeBody 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 + +### GetType + +`func (o *NonEmployeeSchemaAttributeBody) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NonEmployeeSchemaAttributeBody) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NonEmployeeSchemaAttributeBody) SetType(v string)` + +SetType sets Type field to given value. + + +### GetLabel + +`func (o *NonEmployeeSchemaAttributeBody) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *NonEmployeeSchemaAttributeBody) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *NonEmployeeSchemaAttributeBody) SetLabel(v string)` + +SetLabel sets Label field to given value. + + +### GetTechnicalName + +`func (o *NonEmployeeSchemaAttributeBody) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *NonEmployeeSchemaAttributeBody) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *NonEmployeeSchemaAttributeBody) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + + +### GetHelpText + +`func (o *NonEmployeeSchemaAttributeBody) GetHelpText() string` + +GetHelpText returns the HelpText field if non-nil, zero value otherwise. + +### GetHelpTextOk + +`func (o *NonEmployeeSchemaAttributeBody) GetHelpTextOk() (*string, bool)` + +GetHelpTextOk returns a tuple with the HelpText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHelpText + +`func (o *NonEmployeeSchemaAttributeBody) SetHelpText(v string)` + +SetHelpText sets HelpText field to given value. + +### HasHelpText + +`func (o *NonEmployeeSchemaAttributeBody) HasHelpText() bool` + +HasHelpText returns a boolean if a field has been set. + +### GetPlaceholder + +`func (o *NonEmployeeSchemaAttributeBody) GetPlaceholder() string` + +GetPlaceholder returns the Placeholder field if non-nil, zero value otherwise. + +### GetPlaceholderOk + +`func (o *NonEmployeeSchemaAttributeBody) GetPlaceholderOk() (*string, bool)` + +GetPlaceholderOk returns a tuple with the Placeholder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPlaceholder + +`func (o *NonEmployeeSchemaAttributeBody) SetPlaceholder(v string)` + +SetPlaceholder sets Placeholder field to given value. + +### HasPlaceholder + +`func (o *NonEmployeeSchemaAttributeBody) HasPlaceholder() bool` + +HasPlaceholder returns a boolean if a field has been set. + +### GetRequired + +`func (o *NonEmployeeSchemaAttributeBody) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *NonEmployeeSchemaAttributeBody) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *NonEmployeeSchemaAttributeBody) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *NonEmployeeSchemaAttributeBody) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSchemaAttributeType.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSchemaAttributeType.md new file mode 100644 index 000000000..218d33f5c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSchemaAttributeType.md @@ -0,0 +1,23 @@ +--- +id: v2025-non-employee-schema-attribute-type +title: NonEmployeeSchemaAttributeType +pagination_label: NonEmployeeSchemaAttributeType +sidebar_label: NonEmployeeSchemaAttributeType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSchemaAttributeType', 'V2025NonEmployeeSchemaAttributeType'] +slug: /tools/sdk/go/v2025/models/non-employee-schema-attribute-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeType', 'V2025NonEmployeeSchemaAttributeType'] +--- + +# NonEmployeeSchemaAttributeType + +## Enum + + +* `TEXT` (value: `"TEXT"`) + +* `DATE` (value: `"DATE"`) + +* `IDENTITY` (value: `"IDENTITY"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSource.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSource.md new file mode 100644 index 000000000..442a9ee00 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSource.md @@ -0,0 +1,246 @@ +--- +id: v2025-non-employee-source +title: NonEmployeeSource +pagination_label: NonEmployeeSource +sidebar_label: NonEmployeeSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSource', 'V2025NonEmployeeSource'] +slug: /tools/sdk/go/v2025/models/non-employee-source +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSource', 'V2025NonEmployeeSource'] +--- + +# NonEmployeeSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeSource + +`func NewNonEmployeeSource() *NonEmployeeSource` + +NewNonEmployeeSource instantiates a new NonEmployeeSource 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 + +### NewNonEmployeeSourceWithDefaults + +`func NewNonEmployeeSourceWithDefaults() *NonEmployeeSource` + +NewNonEmployeeSourceWithDefaults instantiates a new NonEmployeeSource 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 + +### GetId + +`func (o *NonEmployeeSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSource) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSource) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSource) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSource) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSource) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSource) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSource) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSource) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetApprovers + +`func (o *NonEmployeeSource) GetApprovers() []NonEmployeeIdentityReferenceWithId` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *NonEmployeeSource) GetApproversOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *NonEmployeeSource) SetApprovers(v []NonEmployeeIdentityReferenceWithId)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *NonEmployeeSource) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetAccountManagers + +`func (o *NonEmployeeSource) GetAccountManagers() []NonEmployeeIdentityReferenceWithId` + +GetAccountManagers returns the AccountManagers field if non-nil, zero value otherwise. + +### GetAccountManagersOk + +`func (o *NonEmployeeSource) GetAccountManagersOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetAccountManagersOk returns a tuple with the AccountManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountManagers + +`func (o *NonEmployeeSource) SetAccountManagers(v []NonEmployeeIdentityReferenceWithId)` + +SetAccountManagers sets AccountManagers field to given value. + +### HasAccountManagers + +`func (o *NonEmployeeSource) HasAccountManagers() bool` + +HasAccountManagers returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeSource) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeSource) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeSource) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeSource) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeSource) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeSource) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeSource) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeSource) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSourceLite.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSourceLite.md new file mode 100644 index 000000000..60f25d555 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSourceLite.md @@ -0,0 +1,142 @@ +--- +id: v2025-non-employee-source-lite +title: NonEmployeeSourceLite +pagination_label: NonEmployeeSourceLite +sidebar_label: NonEmployeeSourceLite +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceLite', 'V2025NonEmployeeSourceLite'] +slug: /tools/sdk/go/v2025/models/non-employee-source-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLite', 'V2025NonEmployeeSourceLite'] +--- + +# NonEmployeeSourceLite + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] + +## Methods + +### NewNonEmployeeSourceLite + +`func NewNonEmployeeSourceLite() *NonEmployeeSourceLite` + +NewNonEmployeeSourceLite instantiates a new NonEmployeeSourceLite 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 + +### NewNonEmployeeSourceLiteWithDefaults + +`func NewNonEmployeeSourceLiteWithDefaults() *NonEmployeeSourceLite` + +NewNonEmployeeSourceLiteWithDefaults instantiates a new NonEmployeeSourceLite 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 + +### GetId + +`func (o *NonEmployeeSourceLite) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSourceLite) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSourceLite) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSourceLite) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSourceLite) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSourceLite) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSourceLite) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSourceLite) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSourceLite) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceLite) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceLite) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSourceLite) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSourceLite) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceLite) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceLite) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSourceLite) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSourceLiteWithSchemaAttributes.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSourceLiteWithSchemaAttributes.md new file mode 100644 index 000000000..8bfb54836 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSourceLiteWithSchemaAttributes.md @@ -0,0 +1,168 @@ +--- +id: v2025-non-employee-source-lite-with-schema-attributes +title: NonEmployeeSourceLiteWithSchemaAttributes +pagination_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceLiteWithSchemaAttributes', 'V2025NonEmployeeSourceLiteWithSchemaAttributes'] +slug: /tools/sdk/go/v2025/models/non-employee-source-lite-with-schema-attributes +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLiteWithSchemaAttributes', 'V2025NonEmployeeSourceLiteWithSchemaAttributes'] +--- + +# NonEmployeeSourceLiteWithSchemaAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**SchemaAttributes** | Pointer to [**[]NonEmployeeSchemaAttribute**](non-employee-schema-attribute) | List of schema attributes associated with this non-employee source. | [optional] + +## Methods + +### NewNonEmployeeSourceLiteWithSchemaAttributes + +`func NewNonEmployeeSourceLiteWithSchemaAttributes() *NonEmployeeSourceLiteWithSchemaAttributes` + +NewNonEmployeeSourceLiteWithSchemaAttributes instantiates a new NonEmployeeSourceLiteWithSchemaAttributes 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 + +### NewNonEmployeeSourceLiteWithSchemaAttributesWithDefaults + +`func NewNonEmployeeSourceLiteWithSchemaAttributesWithDefaults() *NonEmployeeSourceLiteWithSchemaAttributes` + +NewNonEmployeeSourceLiteWithSchemaAttributesWithDefaults instantiates a new NonEmployeeSourceLiteWithSchemaAttributes 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 + +### GetId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetSchemaAttributes + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetSchemaAttributes() []NonEmployeeSchemaAttribute` + +GetSchemaAttributes returns the SchemaAttributes field if non-nil, zero value otherwise. + +### GetSchemaAttributesOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetSchemaAttributesOk() (*[]NonEmployeeSchemaAttribute, bool)` + +GetSchemaAttributesOk returns a tuple with the SchemaAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchemaAttributes + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetSchemaAttributes(v []NonEmployeeSchemaAttribute)` + +SetSchemaAttributes sets SchemaAttributes field to given value. + +### HasSchemaAttributes + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasSchemaAttributes() bool` + +HasSchemaAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSourceRequestBody.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSourceRequestBody.md new file mode 100644 index 000000000..fa281a80a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSourceRequestBody.md @@ -0,0 +1,179 @@ +--- +id: v2025-non-employee-source-request-body +title: NonEmployeeSourceRequestBody +pagination_label: NonEmployeeSourceRequestBody +sidebar_label: NonEmployeeSourceRequestBody +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceRequestBody', 'V2025NonEmployeeSourceRequestBody'] +slug: /tools/sdk/go/v2025/models/non-employee-source-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceRequestBody', 'V2025NonEmployeeSourceRequestBody'] +--- + +# NonEmployeeSourceRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Name of non-employee source. | +**Description** | **string** | Description of non-employee source. | +**Owner** | [**NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | | +**ManagementWorkgroup** | Pointer to **string** | The ID for the management workgroup that contains source sub-admins | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of approvers. | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of account managers. | [optional] + +## Methods + +### NewNonEmployeeSourceRequestBody + +`func NewNonEmployeeSourceRequestBody(name string, description string, owner NonEmployeeIdnUserRequest, ) *NonEmployeeSourceRequestBody` + +NewNonEmployeeSourceRequestBody instantiates a new NonEmployeeSourceRequestBody 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 + +### NewNonEmployeeSourceRequestBodyWithDefaults + +`func NewNonEmployeeSourceRequestBodyWithDefaults() *NonEmployeeSourceRequestBody` + +NewNonEmployeeSourceRequestBodyWithDefaults instantiates a new NonEmployeeSourceRequestBody 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 + +### GetName + +`func (o *NonEmployeeSourceRequestBody) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceRequestBody) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceRequestBody) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *NonEmployeeSourceRequestBody) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceRequestBody) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceRequestBody) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetOwner + +`func (o *NonEmployeeSourceRequestBody) GetOwner() NonEmployeeIdnUserRequest` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *NonEmployeeSourceRequestBody) GetOwnerOk() (*NonEmployeeIdnUserRequest, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *NonEmployeeSourceRequestBody) SetOwner(v NonEmployeeIdnUserRequest)` + +SetOwner sets Owner field to given value. + + +### GetManagementWorkgroup + +`func (o *NonEmployeeSourceRequestBody) GetManagementWorkgroup() string` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *NonEmployeeSourceRequestBody) GetManagementWorkgroupOk() (*string, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *NonEmployeeSourceRequestBody) SetManagementWorkgroup(v string)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *NonEmployeeSourceRequestBody) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### GetApprovers + +`func (o *NonEmployeeSourceRequestBody) GetApprovers() []NonEmployeeIdnUserRequest` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *NonEmployeeSourceRequestBody) GetApproversOk() (*[]NonEmployeeIdnUserRequest, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *NonEmployeeSourceRequestBody) SetApprovers(v []NonEmployeeIdnUserRequest)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *NonEmployeeSourceRequestBody) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetAccountManagers + +`func (o *NonEmployeeSourceRequestBody) GetAccountManagers() []NonEmployeeIdnUserRequest` + +GetAccountManagers returns the AccountManagers field if non-nil, zero value otherwise. + +### GetAccountManagersOk + +`func (o *NonEmployeeSourceRequestBody) GetAccountManagersOk() (*[]NonEmployeeIdnUserRequest, bool)` + +GetAccountManagersOk returns a tuple with the AccountManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountManagers + +`func (o *NonEmployeeSourceRequestBody) SetAccountManagers(v []NonEmployeeIdnUserRequest)` + +SetAccountManagers sets AccountManagers field to given value. + +### HasAccountManagers + +`func (o *NonEmployeeSourceRequestBody) HasAccountManagers() bool` + +HasAccountManagers returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSourceWithCloudExternalId.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSourceWithCloudExternalId.md new file mode 100644 index 000000000..4044cc42e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSourceWithCloudExternalId.md @@ -0,0 +1,272 @@ +--- +id: v2025-non-employee-source-with-cloud-external-id +title: NonEmployeeSourceWithCloudExternalId +pagination_label: NonEmployeeSourceWithCloudExternalId +sidebar_label: NonEmployeeSourceWithCloudExternalId +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceWithCloudExternalId', 'V2025NonEmployeeSourceWithCloudExternalId'] +slug: /tools/sdk/go/v2025/models/non-employee-source-with-cloud-external-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithCloudExternalId', 'V2025NonEmployeeSourceWithCloudExternalId'] +--- + +# NonEmployeeSourceWithCloudExternalId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**CloudExternalId** | Pointer to **string** | Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. | [optional] + +## Methods + +### NewNonEmployeeSourceWithCloudExternalId + +`func NewNonEmployeeSourceWithCloudExternalId() *NonEmployeeSourceWithCloudExternalId` + +NewNonEmployeeSourceWithCloudExternalId instantiates a new NonEmployeeSourceWithCloudExternalId 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 + +### NewNonEmployeeSourceWithCloudExternalIdWithDefaults + +`func NewNonEmployeeSourceWithCloudExternalIdWithDefaults() *NonEmployeeSourceWithCloudExternalId` + +NewNonEmployeeSourceWithCloudExternalIdWithDefaults instantiates a new NonEmployeeSourceWithCloudExternalId 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 + +### GetId + +`func (o *NonEmployeeSourceWithCloudExternalId) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSourceWithCloudExternalId) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSourceWithCloudExternalId) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSourceWithCloudExternalId) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSourceWithCloudExternalId) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSourceWithCloudExternalId) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSourceWithCloudExternalId) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceWithCloudExternalId) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSourceWithCloudExternalId) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSourceWithCloudExternalId) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceWithCloudExternalId) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSourceWithCloudExternalId) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetApprovers + +`func (o *NonEmployeeSourceWithCloudExternalId) GetApprovers() []NonEmployeeIdentityReferenceWithId` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetApproversOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *NonEmployeeSourceWithCloudExternalId) SetApprovers(v []NonEmployeeIdentityReferenceWithId)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *NonEmployeeSourceWithCloudExternalId) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetAccountManagers + +`func (o *NonEmployeeSourceWithCloudExternalId) GetAccountManagers() []NonEmployeeIdentityReferenceWithId` + +GetAccountManagers returns the AccountManagers field if non-nil, zero value otherwise. + +### GetAccountManagersOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetAccountManagersOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetAccountManagersOk returns a tuple with the AccountManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountManagers + +`func (o *NonEmployeeSourceWithCloudExternalId) SetAccountManagers(v []NonEmployeeIdentityReferenceWithId)` + +SetAccountManagers sets AccountManagers field to given value. + +### HasAccountManagers + +`func (o *NonEmployeeSourceWithCloudExternalId) HasAccountManagers() bool` + +HasAccountManagers returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeSourceWithCloudExternalId) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeSourceWithCloudExternalId) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeSourceWithCloudExternalId) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeSourceWithCloudExternalId) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeSourceWithCloudExternalId) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeSourceWithCloudExternalId) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetCloudExternalId + +`func (o *NonEmployeeSourceWithCloudExternalId) GetCloudExternalId() string` + +GetCloudExternalId returns the CloudExternalId field if non-nil, zero value otherwise. + +### GetCloudExternalIdOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetCloudExternalIdOk() (*string, bool)` + +GetCloudExternalIdOk returns a tuple with the CloudExternalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudExternalId + +`func (o *NonEmployeeSourceWithCloudExternalId) SetCloudExternalId(v string)` + +SetCloudExternalId sets CloudExternalId field to given value. + +### HasCloudExternalId + +`func (o *NonEmployeeSourceWithCloudExternalId) HasCloudExternalId() bool` + +HasCloudExternalId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSourceWithNECount.md new file mode 100644 index 000000000..df34fd440 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NonEmployeeSourceWithNECount.md @@ -0,0 +1,282 @@ +--- +id: v2025-non-employee-source-with-ne-count +title: NonEmployeeSourceWithNECount +pagination_label: NonEmployeeSourceWithNECount +sidebar_label: NonEmployeeSourceWithNECount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceWithNECount', 'V2025NonEmployeeSourceWithNECount'] +slug: /tools/sdk/go/v2025/models/non-employee-source-with-ne-count +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithNECount', 'V2025NonEmployeeSourceWithNECount'] +--- + +# NonEmployeeSourceWithNECount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**NonEmployeeCount** | Pointer to **NullableInt32** | Number of non-employee records associated with this source. This value is 'NULL' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional] + +## Methods + +### NewNonEmployeeSourceWithNECount + +`func NewNonEmployeeSourceWithNECount() *NonEmployeeSourceWithNECount` + +NewNonEmployeeSourceWithNECount instantiates a new NonEmployeeSourceWithNECount 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 + +### NewNonEmployeeSourceWithNECountWithDefaults + +`func NewNonEmployeeSourceWithNECountWithDefaults() *NonEmployeeSourceWithNECount` + +NewNonEmployeeSourceWithNECountWithDefaults instantiates a new NonEmployeeSourceWithNECount 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 + +### GetId + +`func (o *NonEmployeeSourceWithNECount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSourceWithNECount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSourceWithNECount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSourceWithNECount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSourceWithNECount) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSourceWithNECount) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSourceWithNECount) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSourceWithNECount) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSourceWithNECount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceWithNECount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceWithNECount) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSourceWithNECount) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSourceWithNECount) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceWithNECount) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceWithNECount) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSourceWithNECount) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetApprovers + +`func (o *NonEmployeeSourceWithNECount) GetApprovers() []NonEmployeeIdentityReferenceWithId` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *NonEmployeeSourceWithNECount) GetApproversOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *NonEmployeeSourceWithNECount) SetApprovers(v []NonEmployeeIdentityReferenceWithId)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *NonEmployeeSourceWithNECount) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetAccountManagers + +`func (o *NonEmployeeSourceWithNECount) GetAccountManagers() []NonEmployeeIdentityReferenceWithId` + +GetAccountManagers returns the AccountManagers field if non-nil, zero value otherwise. + +### GetAccountManagersOk + +`func (o *NonEmployeeSourceWithNECount) GetAccountManagersOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetAccountManagersOk returns a tuple with the AccountManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountManagers + +`func (o *NonEmployeeSourceWithNECount) SetAccountManagers(v []NonEmployeeIdentityReferenceWithId)` + +SetAccountManagers sets AccountManagers field to given value. + +### HasAccountManagers + +`func (o *NonEmployeeSourceWithNECount) HasAccountManagers() bool` + +HasAccountManagers returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeSourceWithNECount) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeSourceWithNECount) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeSourceWithNECount) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeSourceWithNECount) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeSourceWithNECount) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeSourceWithNECount) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeSourceWithNECount) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeSourceWithNECount) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetNonEmployeeCount + +`func (o *NonEmployeeSourceWithNECount) GetNonEmployeeCount() int32` + +GetNonEmployeeCount returns the NonEmployeeCount field if non-nil, zero value otherwise. + +### GetNonEmployeeCountOk + +`func (o *NonEmployeeSourceWithNECount) GetNonEmployeeCountOk() (*int32, bool)` + +GetNonEmployeeCountOk returns a tuple with the NonEmployeeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeCount + +`func (o *NonEmployeeSourceWithNECount) SetNonEmployeeCount(v int32)` + +SetNonEmployeeCount sets NonEmployeeCount field to given value. + +### HasNonEmployeeCount + +`func (o *NonEmployeeSourceWithNECount) HasNonEmployeeCount() bool` + +HasNonEmployeeCount returns a boolean if a field has been set. + +### SetNonEmployeeCountNil + +`func (o *NonEmployeeSourceWithNECount) SetNonEmployeeCountNil(b bool)` + + SetNonEmployeeCountNil sets the value for NonEmployeeCount to be an explicit nil + +### UnsetNonEmployeeCount +`func (o *NonEmployeeSourceWithNECount) UnsetNonEmployeeCount()` + +UnsetNonEmployeeCount ensures that no value is present for NonEmployeeCount, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/NotificationTemplateContext.md b/docs/tools/sdk/go/Reference/V2025/Models/NotificationTemplateContext.md new file mode 100644 index 000000000..ef37ef8a5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/NotificationTemplateContext.md @@ -0,0 +1,116 @@ +--- +id: v2025-notification-template-context +title: NotificationTemplateContext +pagination_label: NotificationTemplateContext +sidebar_label: NotificationTemplateContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NotificationTemplateContext', 'V2025NotificationTemplateContext'] +slug: /tools/sdk/go/v2025/models/notification-template-context +tags: ['SDK', 'Software Development Kit', 'NotificationTemplateContext', 'V2025NotificationTemplateContext'] +--- + +# NotificationTemplateContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to **map[string]interface{}** | A JSON object that stores the context. | [optional] +**Created** | Pointer to **SailPointTime** | When the global context was created | [optional] +**Modified** | Pointer to **SailPointTime** | When the global context was last modified | [optional] + +## Methods + +### NewNotificationTemplateContext + +`func NewNotificationTemplateContext() *NotificationTemplateContext` + +NewNotificationTemplateContext instantiates a new NotificationTemplateContext 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 + +### NewNotificationTemplateContextWithDefaults + +`func NewNotificationTemplateContextWithDefaults() *NotificationTemplateContext` + +NewNotificationTemplateContextWithDefaults instantiates a new NotificationTemplateContext 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 + +### GetAttributes + +`func (o *NotificationTemplateContext) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *NotificationTemplateContext) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *NotificationTemplateContext) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *NotificationTemplateContext) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetCreated + +`func (o *NotificationTemplateContext) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NotificationTemplateContext) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NotificationTemplateContext) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NotificationTemplateContext) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *NotificationTemplateContext) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NotificationTemplateContext) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NotificationTemplateContext) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NotificationTemplateContext) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ObjectExportImportNames.md b/docs/tools/sdk/go/Reference/V2025/Models/ObjectExportImportNames.md new file mode 100644 index 000000000..9a505a825 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ObjectExportImportNames.md @@ -0,0 +1,64 @@ +--- +id: v2025-object-export-import-names +title: ObjectExportImportNames +pagination_label: ObjectExportImportNames +sidebar_label: ObjectExportImportNames +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectExportImportNames', 'V2025ObjectExportImportNames'] +slug: /tools/sdk/go/v2025/models/object-export-import-names +tags: ['SDK', 'Software Development Kit', 'ObjectExportImportNames', 'V2025ObjectExportImportNames'] +--- + +# ObjectExportImportNames + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludedNames** | Pointer to **[]string** | Object names to be included in a backup. | [optional] + +## Methods + +### NewObjectExportImportNames + +`func NewObjectExportImportNames() *ObjectExportImportNames` + +NewObjectExportImportNames instantiates a new ObjectExportImportNames 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 + +### NewObjectExportImportNamesWithDefaults + +`func NewObjectExportImportNamesWithDefaults() *ObjectExportImportNames` + +NewObjectExportImportNamesWithDefaults instantiates a new ObjectExportImportNames 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 + +### GetIncludedNames + +`func (o *ObjectExportImportNames) GetIncludedNames() []string` + +GetIncludedNames returns the IncludedNames field if non-nil, zero value otherwise. + +### GetIncludedNamesOk + +`func (o *ObjectExportImportNames) GetIncludedNamesOk() (*[]string, bool)` + +GetIncludedNamesOk returns a tuple with the IncludedNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludedNames + +`func (o *ObjectExportImportNames) SetIncludedNames(v []string)` + +SetIncludedNames sets IncludedNames field to given value. + +### HasIncludedNames + +`func (o *ObjectExportImportNames) HasIncludedNames() bool` + +HasIncludedNames returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ObjectExportImportOptions.md b/docs/tools/sdk/go/Reference/V2025/Models/ObjectExportImportOptions.md new file mode 100644 index 000000000..657d01ade --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ObjectExportImportOptions.md @@ -0,0 +1,90 @@ +--- +id: v2025-object-export-import-options +title: ObjectExportImportOptions +pagination_label: ObjectExportImportOptions +sidebar_label: ObjectExportImportOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectExportImportOptions', 'V2025ObjectExportImportOptions'] +slug: /tools/sdk/go/v2025/models/object-export-import-options +tags: ['SDK', 'Software Development Kit', 'ObjectExportImportOptions', 'V2025ObjectExportImportOptions'] +--- + +# ObjectExportImportOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludedIds** | Pointer to **[]string** | Object ids to be included in an import or export. | [optional] +**IncludedNames** | Pointer to **[]string** | Object names to be included in an import or export. | [optional] + +## Methods + +### NewObjectExportImportOptions + +`func NewObjectExportImportOptions() *ObjectExportImportOptions` + +NewObjectExportImportOptions instantiates a new ObjectExportImportOptions 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 + +### NewObjectExportImportOptionsWithDefaults + +`func NewObjectExportImportOptionsWithDefaults() *ObjectExportImportOptions` + +NewObjectExportImportOptionsWithDefaults instantiates a new ObjectExportImportOptions 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 + +### GetIncludedIds + +`func (o *ObjectExportImportOptions) GetIncludedIds() []string` + +GetIncludedIds returns the IncludedIds field if non-nil, zero value otherwise. + +### GetIncludedIdsOk + +`func (o *ObjectExportImportOptions) GetIncludedIdsOk() (*[]string, bool)` + +GetIncludedIdsOk returns a tuple with the IncludedIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludedIds + +`func (o *ObjectExportImportOptions) SetIncludedIds(v []string)` + +SetIncludedIds sets IncludedIds field to given value. + +### HasIncludedIds + +`func (o *ObjectExportImportOptions) HasIncludedIds() bool` + +HasIncludedIds returns a boolean if a field has been set. + +### GetIncludedNames + +`func (o *ObjectExportImportOptions) GetIncludedNames() []string` + +GetIncludedNames returns the IncludedNames field if non-nil, zero value otherwise. + +### GetIncludedNamesOk + +`func (o *ObjectExportImportOptions) GetIncludedNamesOk() (*[]string, bool)` + +GetIncludedNamesOk returns a tuple with the IncludedNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludedNames + +`func (o *ObjectExportImportOptions) SetIncludedNames(v []string)` + +SetIncludedNames sets IncludedNames field to given value. + +### HasIncludedNames + +`func (o *ObjectExportImportOptions) HasIncludedNames() bool` + +HasIncludedNames returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ObjectImportResult.md b/docs/tools/sdk/go/Reference/V2025/Models/ObjectImportResult.md new file mode 100644 index 000000000..5a820cfbd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ObjectImportResult.md @@ -0,0 +1,122 @@ +--- +id: v2025-object-import-result +title: ObjectImportResult +pagination_label: ObjectImportResult +sidebar_label: ObjectImportResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectImportResult', 'V2025ObjectImportResult'] +slug: /tools/sdk/go/v2025/models/object-import-result +tags: ['SDK', 'Software Development Kit', 'ObjectImportResult', 'V2025ObjectImportResult'] +--- + +# ObjectImportResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Infos** | [**[]SpConfigMessage**](sp-config-message) | Informational messages returned from the target service on import. | +**Warnings** | [**[]SpConfigMessage**](sp-config-message) | Warning messages returned from the target service on import. | +**Errors** | [**[]SpConfigMessage**](sp-config-message) | Error messages returned from the target service on import. | +**ImportedObjects** | [**[]ImportObject**](import-object) | References to objects that were created or updated by the import. | + +## Methods + +### NewObjectImportResult + +`func NewObjectImportResult(infos []SpConfigMessage, warnings []SpConfigMessage, errors []SpConfigMessage, importedObjects []ImportObject, ) *ObjectImportResult` + +NewObjectImportResult instantiates a new ObjectImportResult 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 + +### NewObjectImportResultWithDefaults + +`func NewObjectImportResultWithDefaults() *ObjectImportResult` + +NewObjectImportResultWithDefaults instantiates a new ObjectImportResult 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 + +### GetInfos + +`func (o *ObjectImportResult) GetInfos() []SpConfigMessage` + +GetInfos returns the Infos field if non-nil, zero value otherwise. + +### GetInfosOk + +`func (o *ObjectImportResult) GetInfosOk() (*[]SpConfigMessage, bool)` + +GetInfosOk returns a tuple with the Infos field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfos + +`func (o *ObjectImportResult) SetInfos(v []SpConfigMessage)` + +SetInfos sets Infos field to given value. + + +### GetWarnings + +`func (o *ObjectImportResult) GetWarnings() []SpConfigMessage` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *ObjectImportResult) GetWarningsOk() (*[]SpConfigMessage, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *ObjectImportResult) SetWarnings(v []SpConfigMessage)` + +SetWarnings sets Warnings field to given value. + + +### GetErrors + +`func (o *ObjectImportResult) GetErrors() []SpConfigMessage` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *ObjectImportResult) GetErrorsOk() (*[]SpConfigMessage, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *ObjectImportResult) SetErrors(v []SpConfigMessage)` + +SetErrors sets Errors field to given value. + + +### GetImportedObjects + +`func (o *ObjectImportResult) GetImportedObjects() []ImportObject` + +GetImportedObjects returns the ImportedObjects field if non-nil, zero value otherwise. + +### GetImportedObjectsOk + +`func (o *ObjectImportResult) GetImportedObjectsOk() (*[]ImportObject, bool)` + +GetImportedObjectsOk returns a tuple with the ImportedObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImportedObjects + +`func (o *ObjectImportResult) SetImportedObjects(v []ImportObject)` + +SetImportedObjects sets ImportedObjects field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ObjectImportResult1.md b/docs/tools/sdk/go/Reference/V2025/Models/ObjectImportResult1.md new file mode 100644 index 000000000..d38339ecc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ObjectImportResult1.md @@ -0,0 +1,122 @@ +--- +id: v2025-object-import-result1 +title: ObjectImportResult1 +pagination_label: ObjectImportResult1 +sidebar_label: ObjectImportResult1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectImportResult1', 'V2025ObjectImportResult1'] +slug: /tools/sdk/go/v2025/models/object-import-result1 +tags: ['SDK', 'Software Development Kit', 'ObjectImportResult1', 'V2025ObjectImportResult1'] +--- + +# ObjectImportResult1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Infos** | [**[]SpConfigMessage1**](sp-config-message1) | Informational messages returned from the target service on import. | +**Warnings** | [**[]SpConfigMessage1**](sp-config-message1) | Warning messages returned from the target service on import. | +**Errors** | [**[]SpConfigMessage1**](sp-config-message1) | Error messages returned from the target service on import. | +**ImportedObjects** | [**[]ImportObject**](import-object) | References to objects that were created or updated by the import. | + +## Methods + +### NewObjectImportResult1 + +`func NewObjectImportResult1(infos []SpConfigMessage1, warnings []SpConfigMessage1, errors []SpConfigMessage1, importedObjects []ImportObject, ) *ObjectImportResult1` + +NewObjectImportResult1 instantiates a new ObjectImportResult1 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 + +### NewObjectImportResult1WithDefaults + +`func NewObjectImportResult1WithDefaults() *ObjectImportResult1` + +NewObjectImportResult1WithDefaults instantiates a new ObjectImportResult1 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 + +### GetInfos + +`func (o *ObjectImportResult1) GetInfos() []SpConfigMessage1` + +GetInfos returns the Infos field if non-nil, zero value otherwise. + +### GetInfosOk + +`func (o *ObjectImportResult1) GetInfosOk() (*[]SpConfigMessage1, bool)` + +GetInfosOk returns a tuple with the Infos field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfos + +`func (o *ObjectImportResult1) SetInfos(v []SpConfigMessage1)` + +SetInfos sets Infos field to given value. + + +### GetWarnings + +`func (o *ObjectImportResult1) GetWarnings() []SpConfigMessage1` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *ObjectImportResult1) GetWarningsOk() (*[]SpConfigMessage1, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *ObjectImportResult1) SetWarnings(v []SpConfigMessage1)` + +SetWarnings sets Warnings field to given value. + + +### GetErrors + +`func (o *ObjectImportResult1) GetErrors() []SpConfigMessage1` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *ObjectImportResult1) GetErrorsOk() (*[]SpConfigMessage1, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *ObjectImportResult1) SetErrors(v []SpConfigMessage1)` + +SetErrors sets Errors field to given value. + + +### GetImportedObjects + +`func (o *ObjectImportResult1) GetImportedObjects() []ImportObject` + +GetImportedObjects returns the ImportedObjects field if non-nil, zero value otherwise. + +### GetImportedObjectsOk + +`func (o *ObjectImportResult1) GetImportedObjectsOk() (*[]ImportObject, bool)` + +GetImportedObjectsOk returns a tuple with the ImportedObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImportedObjects + +`func (o *ObjectImportResult1) SetImportedObjects(v []ImportObject)` + +SetImportedObjects sets ImportedObjects field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingBulkCreateRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingBulkCreateRequest.md new file mode 100644 index 000000000..247da9ef7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingBulkCreateRequest.md @@ -0,0 +1,59 @@ +--- +id: v2025-object-mapping-bulk-create-request +title: ObjectMappingBulkCreateRequest +pagination_label: ObjectMappingBulkCreateRequest +sidebar_label: ObjectMappingBulkCreateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingBulkCreateRequest', 'V2025ObjectMappingBulkCreateRequest'] +slug: /tools/sdk/go/v2025/models/object-mapping-bulk-create-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkCreateRequest', 'V2025ObjectMappingBulkCreateRequest'] +--- + +# ObjectMappingBulkCreateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewObjectsMappings** | [**[]ObjectMappingRequest**](object-mapping-request) | | + +## Methods + +### NewObjectMappingBulkCreateRequest + +`func NewObjectMappingBulkCreateRequest(newObjectsMappings []ObjectMappingRequest, ) *ObjectMappingBulkCreateRequest` + +NewObjectMappingBulkCreateRequest instantiates a new ObjectMappingBulkCreateRequest 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 + +### NewObjectMappingBulkCreateRequestWithDefaults + +`func NewObjectMappingBulkCreateRequestWithDefaults() *ObjectMappingBulkCreateRequest` + +NewObjectMappingBulkCreateRequestWithDefaults instantiates a new ObjectMappingBulkCreateRequest 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 + +### GetNewObjectsMappings + +`func (o *ObjectMappingBulkCreateRequest) GetNewObjectsMappings() []ObjectMappingRequest` + +GetNewObjectsMappings returns the NewObjectsMappings field if non-nil, zero value otherwise. + +### GetNewObjectsMappingsOk + +`func (o *ObjectMappingBulkCreateRequest) GetNewObjectsMappingsOk() (*[]ObjectMappingRequest, bool)` + +GetNewObjectsMappingsOk returns a tuple with the NewObjectsMappings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewObjectsMappings + +`func (o *ObjectMappingBulkCreateRequest) SetNewObjectsMappings(v []ObjectMappingRequest)` + +SetNewObjectsMappings sets NewObjectsMappings field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingBulkCreateResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingBulkCreateResponse.md new file mode 100644 index 000000000..dbcaa26b7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingBulkCreateResponse.md @@ -0,0 +1,64 @@ +--- +id: v2025-object-mapping-bulk-create-response +title: ObjectMappingBulkCreateResponse +pagination_label: ObjectMappingBulkCreateResponse +sidebar_label: ObjectMappingBulkCreateResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingBulkCreateResponse', 'V2025ObjectMappingBulkCreateResponse'] +slug: /tools/sdk/go/v2025/models/object-mapping-bulk-create-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkCreateResponse', 'V2025ObjectMappingBulkCreateResponse'] +--- + +# ObjectMappingBulkCreateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddedObjects** | Pointer to [**[]ObjectMappingResponse**](object-mapping-response) | | [optional] + +## Methods + +### NewObjectMappingBulkCreateResponse + +`func NewObjectMappingBulkCreateResponse() *ObjectMappingBulkCreateResponse` + +NewObjectMappingBulkCreateResponse instantiates a new ObjectMappingBulkCreateResponse 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 + +### NewObjectMappingBulkCreateResponseWithDefaults + +`func NewObjectMappingBulkCreateResponseWithDefaults() *ObjectMappingBulkCreateResponse` + +NewObjectMappingBulkCreateResponseWithDefaults instantiates a new ObjectMappingBulkCreateResponse 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 + +### GetAddedObjects + +`func (o *ObjectMappingBulkCreateResponse) GetAddedObjects() []ObjectMappingResponse` + +GetAddedObjects returns the AddedObjects field if non-nil, zero value otherwise. + +### GetAddedObjectsOk + +`func (o *ObjectMappingBulkCreateResponse) GetAddedObjectsOk() (*[]ObjectMappingResponse, bool)` + +GetAddedObjectsOk returns a tuple with the AddedObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAddedObjects + +`func (o *ObjectMappingBulkCreateResponse) SetAddedObjects(v []ObjectMappingResponse)` + +SetAddedObjects sets AddedObjects field to given value. + +### HasAddedObjects + +`func (o *ObjectMappingBulkCreateResponse) HasAddedObjects() bool` + +HasAddedObjects returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingBulkPatchRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingBulkPatchRequest.md new file mode 100644 index 000000000..233913ca5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingBulkPatchRequest.md @@ -0,0 +1,59 @@ +--- +id: v2025-object-mapping-bulk-patch-request +title: ObjectMappingBulkPatchRequest +pagination_label: ObjectMappingBulkPatchRequest +sidebar_label: ObjectMappingBulkPatchRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingBulkPatchRequest', 'V2025ObjectMappingBulkPatchRequest'] +slug: /tools/sdk/go/v2025/models/object-mapping-bulk-patch-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchRequest', 'V2025ObjectMappingBulkPatchRequest'] +--- + +# ObjectMappingBulkPatchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Patches** | [**map[string][]JsonPatchOperation**](https://go.dev/tour/moretypes/6) | Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. | + +## Methods + +### NewObjectMappingBulkPatchRequest + +`func NewObjectMappingBulkPatchRequest(patches map[string][]JsonPatchOperation, ) *ObjectMappingBulkPatchRequest` + +NewObjectMappingBulkPatchRequest instantiates a new ObjectMappingBulkPatchRequest 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 + +### NewObjectMappingBulkPatchRequestWithDefaults + +`func NewObjectMappingBulkPatchRequestWithDefaults() *ObjectMappingBulkPatchRequest` + +NewObjectMappingBulkPatchRequestWithDefaults instantiates a new ObjectMappingBulkPatchRequest 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 + +### GetPatches + +`func (o *ObjectMappingBulkPatchRequest) GetPatches() map[string][]JsonPatchOperation` + +GetPatches returns the Patches field if non-nil, zero value otherwise. + +### GetPatchesOk + +`func (o *ObjectMappingBulkPatchRequest) GetPatchesOk() (*map[string][]JsonPatchOperation, bool)` + +GetPatchesOk returns a tuple with the Patches field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPatches + +`func (o *ObjectMappingBulkPatchRequest) SetPatches(v map[string][]JsonPatchOperation)` + +SetPatches sets Patches field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingBulkPatchResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingBulkPatchResponse.md new file mode 100644 index 000000000..83c70f2b6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingBulkPatchResponse.md @@ -0,0 +1,64 @@ +--- +id: v2025-object-mapping-bulk-patch-response +title: ObjectMappingBulkPatchResponse +pagination_label: ObjectMappingBulkPatchResponse +sidebar_label: ObjectMappingBulkPatchResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingBulkPatchResponse', 'V2025ObjectMappingBulkPatchResponse'] +slug: /tools/sdk/go/v2025/models/object-mapping-bulk-patch-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchResponse', 'V2025ObjectMappingBulkPatchResponse'] +--- + +# ObjectMappingBulkPatchResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PatchedObjects** | Pointer to [**[]ObjectMappingResponse**](object-mapping-response) | | [optional] + +## Methods + +### NewObjectMappingBulkPatchResponse + +`func NewObjectMappingBulkPatchResponse() *ObjectMappingBulkPatchResponse` + +NewObjectMappingBulkPatchResponse instantiates a new ObjectMappingBulkPatchResponse 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 + +### NewObjectMappingBulkPatchResponseWithDefaults + +`func NewObjectMappingBulkPatchResponseWithDefaults() *ObjectMappingBulkPatchResponse` + +NewObjectMappingBulkPatchResponseWithDefaults instantiates a new ObjectMappingBulkPatchResponse 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 + +### GetPatchedObjects + +`func (o *ObjectMappingBulkPatchResponse) GetPatchedObjects() []ObjectMappingResponse` + +GetPatchedObjects returns the PatchedObjects field if non-nil, zero value otherwise. + +### GetPatchedObjectsOk + +`func (o *ObjectMappingBulkPatchResponse) GetPatchedObjectsOk() (*[]ObjectMappingResponse, bool)` + +GetPatchedObjectsOk returns a tuple with the PatchedObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPatchedObjects + +`func (o *ObjectMappingBulkPatchResponse) SetPatchedObjects(v []ObjectMappingResponse)` + +SetPatchedObjects sets PatchedObjects field to given value. + +### HasPatchedObjects + +`func (o *ObjectMappingBulkPatchResponse) HasPatchedObjects() bool` + +HasPatchedObjects returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingRequest.md new file mode 100644 index 000000000..5b6a900f6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingRequest.md @@ -0,0 +1,148 @@ +--- +id: v2025-object-mapping-request +title: ObjectMappingRequest +pagination_label: ObjectMappingRequest +sidebar_label: ObjectMappingRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingRequest', 'V2025ObjectMappingRequest'] +slug: /tools/sdk/go/v2025/models/object-mapping-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingRequest', 'V2025ObjectMappingRequest'] +--- + +# ObjectMappingRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectType** | **string** | Type of the object the mapping value applies to, must be one from enum | +**JsonPath** | **string** | JSONPath expression denoting the path within the object where the mapping value should be applied | +**SourceValue** | **string** | Original value at the jsonPath location within the object | +**TargetValue** | **string** | Value to be assigned at the jsonPath location within the object | +**Enabled** | Pointer to **bool** | Whether or not this object mapping is enabled | [optional] [default to false] + +## Methods + +### NewObjectMappingRequest + +`func NewObjectMappingRequest(objectType string, jsonPath string, sourceValue string, targetValue string, ) *ObjectMappingRequest` + +NewObjectMappingRequest instantiates a new ObjectMappingRequest 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 + +### NewObjectMappingRequestWithDefaults + +`func NewObjectMappingRequestWithDefaults() *ObjectMappingRequest` + +NewObjectMappingRequestWithDefaults instantiates a new ObjectMappingRequest 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 + +### GetObjectType + +`func (o *ObjectMappingRequest) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *ObjectMappingRequest) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *ObjectMappingRequest) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + + +### GetJsonPath + +`func (o *ObjectMappingRequest) GetJsonPath() string` + +GetJsonPath returns the JsonPath field if non-nil, zero value otherwise. + +### GetJsonPathOk + +`func (o *ObjectMappingRequest) GetJsonPathOk() (*string, bool)` + +GetJsonPathOk returns a tuple with the JsonPath field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJsonPath + +`func (o *ObjectMappingRequest) SetJsonPath(v string)` + +SetJsonPath sets JsonPath field to given value. + + +### GetSourceValue + +`func (o *ObjectMappingRequest) GetSourceValue() string` + +GetSourceValue returns the SourceValue field if non-nil, zero value otherwise. + +### GetSourceValueOk + +`func (o *ObjectMappingRequest) GetSourceValueOk() (*string, bool)` + +GetSourceValueOk returns a tuple with the SourceValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceValue + +`func (o *ObjectMappingRequest) SetSourceValue(v string)` + +SetSourceValue sets SourceValue field to given value. + + +### GetTargetValue + +`func (o *ObjectMappingRequest) GetTargetValue() string` + +GetTargetValue returns the TargetValue field if non-nil, zero value otherwise. + +### GetTargetValueOk + +`func (o *ObjectMappingRequest) GetTargetValueOk() (*string, bool)` + +GetTargetValueOk returns a tuple with the TargetValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetValue + +`func (o *ObjectMappingRequest) SetTargetValue(v string)` + +SetTargetValue sets TargetValue field to given value. + + +### GetEnabled + +`func (o *ObjectMappingRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ObjectMappingRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ObjectMappingRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ObjectMappingRequest) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingResponse.md new file mode 100644 index 000000000..687899fb3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ObjectMappingResponse.md @@ -0,0 +1,246 @@ +--- +id: v2025-object-mapping-response +title: ObjectMappingResponse +pagination_label: ObjectMappingResponse +sidebar_label: ObjectMappingResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingResponse', 'V2025ObjectMappingResponse'] +slug: /tools/sdk/go/v2025/models/object-mapping-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingResponse', 'V2025ObjectMappingResponse'] +--- + +# ObjectMappingResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectMappingId** | Pointer to **string** | Id of the object mapping | [optional] +**ObjectType** | Pointer to **string** | Type of the object the mapping value applies to | [optional] +**JsonPath** | Pointer to **string** | JSONPath expression denoting the path within the object where the mapping value should be applied | [optional] +**SourceValue** | Pointer to **string** | Original value at the jsonPath location within the object | [optional] +**TargetValue** | Pointer to **string** | Value to be assigned at the jsonPath location within the object | [optional] +**Enabled** | Pointer to **bool** | Whether or not this object mapping is enabled | [optional] [default to false] +**Created** | Pointer to **string** | Object mapping creation timestamp | [optional] +**Modified** | Pointer to **string** | Object mapping latest update timestamp | [optional] + +## Methods + +### NewObjectMappingResponse + +`func NewObjectMappingResponse() *ObjectMappingResponse` + +NewObjectMappingResponse instantiates a new ObjectMappingResponse 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 + +### NewObjectMappingResponseWithDefaults + +`func NewObjectMappingResponseWithDefaults() *ObjectMappingResponse` + +NewObjectMappingResponseWithDefaults instantiates a new ObjectMappingResponse 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 + +### GetObjectMappingId + +`func (o *ObjectMappingResponse) GetObjectMappingId() string` + +GetObjectMappingId returns the ObjectMappingId field if non-nil, zero value otherwise. + +### GetObjectMappingIdOk + +`func (o *ObjectMappingResponse) GetObjectMappingIdOk() (*string, bool)` + +GetObjectMappingIdOk returns a tuple with the ObjectMappingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectMappingId + +`func (o *ObjectMappingResponse) SetObjectMappingId(v string)` + +SetObjectMappingId sets ObjectMappingId field to given value. + +### HasObjectMappingId + +`func (o *ObjectMappingResponse) HasObjectMappingId() bool` + +HasObjectMappingId returns a boolean if a field has been set. + +### GetObjectType + +`func (o *ObjectMappingResponse) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *ObjectMappingResponse) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *ObjectMappingResponse) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + +### HasObjectType + +`func (o *ObjectMappingResponse) HasObjectType() bool` + +HasObjectType returns a boolean if a field has been set. + +### GetJsonPath + +`func (o *ObjectMappingResponse) GetJsonPath() string` + +GetJsonPath returns the JsonPath field if non-nil, zero value otherwise. + +### GetJsonPathOk + +`func (o *ObjectMappingResponse) GetJsonPathOk() (*string, bool)` + +GetJsonPathOk returns a tuple with the JsonPath field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJsonPath + +`func (o *ObjectMappingResponse) SetJsonPath(v string)` + +SetJsonPath sets JsonPath field to given value. + +### HasJsonPath + +`func (o *ObjectMappingResponse) HasJsonPath() bool` + +HasJsonPath returns a boolean if a field has been set. + +### GetSourceValue + +`func (o *ObjectMappingResponse) GetSourceValue() string` + +GetSourceValue returns the SourceValue field if non-nil, zero value otherwise. + +### GetSourceValueOk + +`func (o *ObjectMappingResponse) GetSourceValueOk() (*string, bool)` + +GetSourceValueOk returns a tuple with the SourceValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceValue + +`func (o *ObjectMappingResponse) SetSourceValue(v string)` + +SetSourceValue sets SourceValue field to given value. + +### HasSourceValue + +`func (o *ObjectMappingResponse) HasSourceValue() bool` + +HasSourceValue returns a boolean if a field has been set. + +### GetTargetValue + +`func (o *ObjectMappingResponse) GetTargetValue() string` + +GetTargetValue returns the TargetValue field if non-nil, zero value otherwise. + +### GetTargetValueOk + +`func (o *ObjectMappingResponse) GetTargetValueOk() (*string, bool)` + +GetTargetValueOk returns a tuple with the TargetValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetValue + +`func (o *ObjectMappingResponse) SetTargetValue(v string)` + +SetTargetValue sets TargetValue field to given value. + +### HasTargetValue + +`func (o *ObjectMappingResponse) HasTargetValue() bool` + +HasTargetValue returns a boolean if a field has been set. + +### GetEnabled + +`func (o *ObjectMappingResponse) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ObjectMappingResponse) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ObjectMappingResponse) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ObjectMappingResponse) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetCreated + +`func (o *ObjectMappingResponse) GetCreated() string` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ObjectMappingResponse) GetCreatedOk() (*string, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ObjectMappingResponse) SetCreated(v string)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ObjectMappingResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *ObjectMappingResponse) GetModified() string` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ObjectMappingResponse) GetModifiedOk() (*string, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ObjectMappingResponse) SetModified(v string)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ObjectMappingResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Operation.md b/docs/tools/sdk/go/Reference/V2025/Models/Operation.md new file mode 100644 index 000000000..e808afb2a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Operation.md @@ -0,0 +1,31 @@ +--- +id: v2025-operation +title: Operation +pagination_label: Operation +sidebar_label: Operation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Operation', 'V2025Operation'] +slug: /tools/sdk/go/v2025/models/operation +tags: ['SDK', 'Software Development Kit', 'Operation', 'V2025Operation'] +--- + +# Operation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `STARTS_WITH` (value: `"STARTS_WITH"`) + +* `ENDS_WITH` (value: `"ENDS_WITH"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/OrgConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/OrgConfig.md new file mode 100644 index 000000000..575ae6d2c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/OrgConfig.md @@ -0,0 +1,348 @@ +--- +id: v2025-org-config +title: OrgConfig +pagination_label: OrgConfig +sidebar_label: OrgConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OrgConfig', 'V2025OrgConfig'] +slug: /tools/sdk/go/v2025/models/org-config +tags: ['SDK', 'Software Development Kit', 'OrgConfig', 'V2025OrgConfig'] +--- + +# OrgConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrgName** | Pointer to **string** | The name of the org. | [optional] +**TimeZone** | Pointer to **string** | The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones | [optional] +**LcsChangeHonorsSourceEnableFeature** | Pointer to **bool** | Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org. | [optional] +**ArmCustomerId** | Pointer to **NullableString** | ARM Customer ID | [optional] +**ArmSapSystemIdMappings** | Pointer to **NullableString** | A list of IDN::sourceId to ARM::systemId mappings. | [optional] +**ArmAuth** | Pointer to **NullableString** | ARM authentication string | [optional] +**ArmDb** | Pointer to **NullableString** | ARM database name | [optional] +**ArmSsoUrl** | Pointer to **NullableString** | ARM SSO URL | [optional] +**IaiEnableCertificationRecommendations** | Pointer to **bool** | Flag to determine whether IAI Certification Recommendations are enabled for the current org | [optional] +**SodReportConfigs** | Pointer to [**[]ReportConfigDTO**](report-config-dto) | | [optional] + +## Methods + +### NewOrgConfig + +`func NewOrgConfig() *OrgConfig` + +NewOrgConfig instantiates a new OrgConfig 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 + +### NewOrgConfigWithDefaults + +`func NewOrgConfigWithDefaults() *OrgConfig` + +NewOrgConfigWithDefaults instantiates a new OrgConfig 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 + +### GetOrgName + +`func (o *OrgConfig) GetOrgName() string` + +GetOrgName returns the OrgName field if non-nil, zero value otherwise. + +### GetOrgNameOk + +`func (o *OrgConfig) GetOrgNameOk() (*string, bool)` + +GetOrgNameOk returns a tuple with the OrgName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgName + +`func (o *OrgConfig) SetOrgName(v string)` + +SetOrgName sets OrgName field to given value. + +### HasOrgName + +`func (o *OrgConfig) HasOrgName() bool` + +HasOrgName returns a boolean if a field has been set. + +### GetTimeZone + +`func (o *OrgConfig) GetTimeZone() string` + +GetTimeZone returns the TimeZone field if non-nil, zero value otherwise. + +### GetTimeZoneOk + +`func (o *OrgConfig) GetTimeZoneOk() (*string, bool)` + +GetTimeZoneOk returns a tuple with the TimeZone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZone + +`func (o *OrgConfig) SetTimeZone(v string)` + +SetTimeZone sets TimeZone field to given value. + +### HasTimeZone + +`func (o *OrgConfig) HasTimeZone() bool` + +HasTimeZone returns a boolean if a field has been set. + +### GetLcsChangeHonorsSourceEnableFeature + +`func (o *OrgConfig) GetLcsChangeHonorsSourceEnableFeature() bool` + +GetLcsChangeHonorsSourceEnableFeature returns the LcsChangeHonorsSourceEnableFeature field if non-nil, zero value otherwise. + +### GetLcsChangeHonorsSourceEnableFeatureOk + +`func (o *OrgConfig) GetLcsChangeHonorsSourceEnableFeatureOk() (*bool, bool)` + +GetLcsChangeHonorsSourceEnableFeatureOk returns a tuple with the LcsChangeHonorsSourceEnableFeature field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLcsChangeHonorsSourceEnableFeature + +`func (o *OrgConfig) SetLcsChangeHonorsSourceEnableFeature(v bool)` + +SetLcsChangeHonorsSourceEnableFeature sets LcsChangeHonorsSourceEnableFeature field to given value. + +### HasLcsChangeHonorsSourceEnableFeature + +`func (o *OrgConfig) HasLcsChangeHonorsSourceEnableFeature() bool` + +HasLcsChangeHonorsSourceEnableFeature returns a boolean if a field has been set. + +### GetArmCustomerId + +`func (o *OrgConfig) GetArmCustomerId() string` + +GetArmCustomerId returns the ArmCustomerId field if non-nil, zero value otherwise. + +### GetArmCustomerIdOk + +`func (o *OrgConfig) GetArmCustomerIdOk() (*string, bool)` + +GetArmCustomerIdOk returns a tuple with the ArmCustomerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArmCustomerId + +`func (o *OrgConfig) SetArmCustomerId(v string)` + +SetArmCustomerId sets ArmCustomerId field to given value. + +### HasArmCustomerId + +`func (o *OrgConfig) HasArmCustomerId() bool` + +HasArmCustomerId returns a boolean if a field has been set. + +### SetArmCustomerIdNil + +`func (o *OrgConfig) SetArmCustomerIdNil(b bool)` + + SetArmCustomerIdNil sets the value for ArmCustomerId to be an explicit nil + +### UnsetArmCustomerId +`func (o *OrgConfig) UnsetArmCustomerId()` + +UnsetArmCustomerId ensures that no value is present for ArmCustomerId, not even an explicit nil +### GetArmSapSystemIdMappings + +`func (o *OrgConfig) GetArmSapSystemIdMappings() string` + +GetArmSapSystemIdMappings returns the ArmSapSystemIdMappings field if non-nil, zero value otherwise. + +### GetArmSapSystemIdMappingsOk + +`func (o *OrgConfig) GetArmSapSystemIdMappingsOk() (*string, bool)` + +GetArmSapSystemIdMappingsOk returns a tuple with the ArmSapSystemIdMappings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArmSapSystemIdMappings + +`func (o *OrgConfig) SetArmSapSystemIdMappings(v string)` + +SetArmSapSystemIdMappings sets ArmSapSystemIdMappings field to given value. + +### HasArmSapSystemIdMappings + +`func (o *OrgConfig) HasArmSapSystemIdMappings() bool` + +HasArmSapSystemIdMappings returns a boolean if a field has been set. + +### SetArmSapSystemIdMappingsNil + +`func (o *OrgConfig) SetArmSapSystemIdMappingsNil(b bool)` + + SetArmSapSystemIdMappingsNil sets the value for ArmSapSystemIdMappings to be an explicit nil + +### UnsetArmSapSystemIdMappings +`func (o *OrgConfig) UnsetArmSapSystemIdMappings()` + +UnsetArmSapSystemIdMappings ensures that no value is present for ArmSapSystemIdMappings, not even an explicit nil +### GetArmAuth + +`func (o *OrgConfig) GetArmAuth() string` + +GetArmAuth returns the ArmAuth field if non-nil, zero value otherwise. + +### GetArmAuthOk + +`func (o *OrgConfig) GetArmAuthOk() (*string, bool)` + +GetArmAuthOk returns a tuple with the ArmAuth field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArmAuth + +`func (o *OrgConfig) SetArmAuth(v string)` + +SetArmAuth sets ArmAuth field to given value. + +### HasArmAuth + +`func (o *OrgConfig) HasArmAuth() bool` + +HasArmAuth returns a boolean if a field has been set. + +### SetArmAuthNil + +`func (o *OrgConfig) SetArmAuthNil(b bool)` + + SetArmAuthNil sets the value for ArmAuth to be an explicit nil + +### UnsetArmAuth +`func (o *OrgConfig) UnsetArmAuth()` + +UnsetArmAuth ensures that no value is present for ArmAuth, not even an explicit nil +### GetArmDb + +`func (o *OrgConfig) GetArmDb() string` + +GetArmDb returns the ArmDb field if non-nil, zero value otherwise. + +### GetArmDbOk + +`func (o *OrgConfig) GetArmDbOk() (*string, bool)` + +GetArmDbOk returns a tuple with the ArmDb field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArmDb + +`func (o *OrgConfig) SetArmDb(v string)` + +SetArmDb sets ArmDb field to given value. + +### HasArmDb + +`func (o *OrgConfig) HasArmDb() bool` + +HasArmDb returns a boolean if a field has been set. + +### SetArmDbNil + +`func (o *OrgConfig) SetArmDbNil(b bool)` + + SetArmDbNil sets the value for ArmDb to be an explicit nil + +### UnsetArmDb +`func (o *OrgConfig) UnsetArmDb()` + +UnsetArmDb ensures that no value is present for ArmDb, not even an explicit nil +### GetArmSsoUrl + +`func (o *OrgConfig) GetArmSsoUrl() string` + +GetArmSsoUrl returns the ArmSsoUrl field if non-nil, zero value otherwise. + +### GetArmSsoUrlOk + +`func (o *OrgConfig) GetArmSsoUrlOk() (*string, bool)` + +GetArmSsoUrlOk returns a tuple with the ArmSsoUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArmSsoUrl + +`func (o *OrgConfig) SetArmSsoUrl(v string)` + +SetArmSsoUrl sets ArmSsoUrl field to given value. + +### HasArmSsoUrl + +`func (o *OrgConfig) HasArmSsoUrl() bool` + +HasArmSsoUrl returns a boolean if a field has been set. + +### SetArmSsoUrlNil + +`func (o *OrgConfig) SetArmSsoUrlNil(b bool)` + + SetArmSsoUrlNil sets the value for ArmSsoUrl to be an explicit nil + +### UnsetArmSsoUrl +`func (o *OrgConfig) UnsetArmSsoUrl()` + +UnsetArmSsoUrl ensures that no value is present for ArmSsoUrl, not even an explicit nil +### GetIaiEnableCertificationRecommendations + +`func (o *OrgConfig) GetIaiEnableCertificationRecommendations() bool` + +GetIaiEnableCertificationRecommendations returns the IaiEnableCertificationRecommendations field if non-nil, zero value otherwise. + +### GetIaiEnableCertificationRecommendationsOk + +`func (o *OrgConfig) GetIaiEnableCertificationRecommendationsOk() (*bool, bool)` + +GetIaiEnableCertificationRecommendationsOk returns a tuple with the IaiEnableCertificationRecommendations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIaiEnableCertificationRecommendations + +`func (o *OrgConfig) SetIaiEnableCertificationRecommendations(v bool)` + +SetIaiEnableCertificationRecommendations sets IaiEnableCertificationRecommendations field to given value. + +### HasIaiEnableCertificationRecommendations + +`func (o *OrgConfig) HasIaiEnableCertificationRecommendations() bool` + +HasIaiEnableCertificationRecommendations returns a boolean if a field has been set. + +### GetSodReportConfigs + +`func (o *OrgConfig) GetSodReportConfigs() []ReportConfigDTO` + +GetSodReportConfigs returns the SodReportConfigs field if non-nil, zero value otherwise. + +### GetSodReportConfigsOk + +`func (o *OrgConfig) GetSodReportConfigsOk() (*[]ReportConfigDTO, bool)` + +GetSodReportConfigsOk returns a tuple with the SodReportConfigs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodReportConfigs + +`func (o *OrgConfig) SetSodReportConfigs(v []ReportConfigDTO)` + +SetSodReportConfigs sets SodReportConfigs field to given value. + +### HasSodReportConfigs + +`func (o *OrgConfig) HasSodReportConfigs() bool` + +HasSodReportConfigs returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/OriginalRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/OriginalRequest.md new file mode 100644 index 000000000..58fa9559e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/OriginalRequest.md @@ -0,0 +1,168 @@ +--- +id: v2025-original-request +title: OriginalRequest +pagination_label: OriginalRequest +sidebar_label: OriginalRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OriginalRequest', 'V2025OriginalRequest'] +slug: /tools/sdk/go/v2025/models/original-request +tags: ['SDK', 'Software Development Kit', 'OriginalRequest', 'V2025OriginalRequest'] +--- + +# OriginalRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **string** | Account ID. | [optional] +**Result** | Pointer to [**Result**](result) | | [optional] +**AttributeRequests** | Pointer to [**[]AttributeRequest**](attribute-request) | Attribute changes requested for account. | [optional] +**Op** | Pointer to **string** | Operation used. | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] + +## Methods + +### NewOriginalRequest + +`func NewOriginalRequest() *OriginalRequest` + +NewOriginalRequest instantiates a new OriginalRequest 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 + +### NewOriginalRequestWithDefaults + +`func NewOriginalRequestWithDefaults() *OriginalRequest` + +NewOriginalRequestWithDefaults instantiates a new OriginalRequest 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 + +### GetAccountId + +`func (o *OriginalRequest) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *OriginalRequest) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *OriginalRequest) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *OriginalRequest) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetResult + +`func (o *OriginalRequest) GetResult() Result` + +GetResult returns the Result field if non-nil, zero value otherwise. + +### GetResultOk + +`func (o *OriginalRequest) GetResultOk() (*Result, bool)` + +GetResultOk returns a tuple with the Result field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResult + +`func (o *OriginalRequest) SetResult(v Result)` + +SetResult sets Result field to given value. + +### HasResult + +`func (o *OriginalRequest) HasResult() bool` + +HasResult returns a boolean if a field has been set. + +### GetAttributeRequests + +`func (o *OriginalRequest) GetAttributeRequests() []AttributeRequest` + +GetAttributeRequests returns the AttributeRequests field if non-nil, zero value otherwise. + +### GetAttributeRequestsOk + +`func (o *OriginalRequest) GetAttributeRequestsOk() (*[]AttributeRequest, bool)` + +GetAttributeRequestsOk returns a tuple with the AttributeRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeRequests + +`func (o *OriginalRequest) SetAttributeRequests(v []AttributeRequest)` + +SetAttributeRequests sets AttributeRequests field to given value. + +### HasAttributeRequests + +`func (o *OriginalRequest) HasAttributeRequests() bool` + +HasAttributeRequests returns a boolean if a field has been set. + +### GetOp + +`func (o *OriginalRequest) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *OriginalRequest) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *OriginalRequest) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *OriginalRequest) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetSource + +`func (o *OriginalRequest) GetSource() AccountSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *OriginalRequest) GetSourceOk() (*AccountSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *OriginalRequest) SetSource(v AccountSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *OriginalRequest) HasSource() bool` + +HasSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/OrphanIdentitiesReportArguments.md b/docs/tools/sdk/go/Reference/V2025/Models/OrphanIdentitiesReportArguments.md new file mode 100644 index 000000000..508a26575 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/OrphanIdentitiesReportArguments.md @@ -0,0 +1,64 @@ +--- +id: v2025-orphan-identities-report-arguments +title: OrphanIdentitiesReportArguments +pagination_label: OrphanIdentitiesReportArguments +sidebar_label: OrphanIdentitiesReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OrphanIdentitiesReportArguments', 'V2025OrphanIdentitiesReportArguments'] +slug: /tools/sdk/go/v2025/models/orphan-identities-report-arguments +tags: ['SDK', 'Software Development Kit', 'OrphanIdentitiesReportArguments', 'V2025OrphanIdentitiesReportArguments'] +--- + +# OrphanIdentitiesReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SelectedFormats** | Pointer to **[]string** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] + +## Methods + +### NewOrphanIdentitiesReportArguments + +`func NewOrphanIdentitiesReportArguments() *OrphanIdentitiesReportArguments` + +NewOrphanIdentitiesReportArguments instantiates a new OrphanIdentitiesReportArguments 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 + +### NewOrphanIdentitiesReportArgumentsWithDefaults + +`func NewOrphanIdentitiesReportArgumentsWithDefaults() *OrphanIdentitiesReportArguments` + +NewOrphanIdentitiesReportArgumentsWithDefaults instantiates a new OrphanIdentitiesReportArguments 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 + +### GetSelectedFormats + +`func (o *OrphanIdentitiesReportArguments) GetSelectedFormats() []string` + +GetSelectedFormats returns the SelectedFormats field if non-nil, zero value otherwise. + +### GetSelectedFormatsOk + +`func (o *OrphanIdentitiesReportArguments) GetSelectedFormatsOk() (*[]string, bool)` + +GetSelectedFormatsOk returns a tuple with the SelectedFormats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectedFormats + +`func (o *OrphanIdentitiesReportArguments) SetSelectedFormats(v []string)` + +SetSelectedFormats sets SelectedFormats field to given value. + +### HasSelectedFormats + +`func (o *OrphanIdentitiesReportArguments) HasSelectedFormats() bool` + +HasSelectedFormats returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Outlier.md b/docs/tools/sdk/go/Reference/V2025/Models/Outlier.md new file mode 100644 index 000000000..3fae9a00c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Outlier.md @@ -0,0 +1,354 @@ +--- +id: v2025-outlier +title: Outlier +pagination_label: Outlier +sidebar_label: Outlier +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Outlier', 'V2025Outlier'] +slug: /tools/sdk/go/v2025/models/outlier +tags: ['SDK', 'Software Development Kit', 'Outlier', 'V2025Outlier'] +--- + +# Outlier + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity's unique identifier for the outlier record | [optional] +**IdentityId** | Pointer to **string** | The ID of the identity that is detected as an outlier | [optional] +**Type** | Pointer to **string** | The type of outlier summary | [optional] +**FirstDetectionDate** | Pointer to **SailPointTime** | The first date the outlier was detected | [optional] +**LatestDetectionDate** | Pointer to **SailPointTime** | The most recent date the outlier was detected | [optional] +**Ignored** | Pointer to **bool** | Flag whether or not the outlier has been ignored | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Object containing mapped identity attributes | [optional] +**Score** | Pointer to **float32** | The outlier score determined by the detection engine ranging from 0..1 | [optional] +**UnignoreType** | Pointer to **NullableString** | Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored | [optional] +**UnignoreDate** | Pointer to **NullableTime** | shows date when last time has been unignored outlier | [optional] +**IgnoreDate** | Pointer to **NullableTime** | shows date when last time has been ignored outlier | [optional] + +## Methods + +### NewOutlier + +`func NewOutlier() *Outlier` + +NewOutlier instantiates a new Outlier 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 + +### NewOutlierWithDefaults + +`func NewOutlierWithDefaults() *Outlier` + +NewOutlierWithDefaults instantiates a new Outlier 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 + +### GetId + +`func (o *Outlier) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Outlier) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Outlier) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Outlier) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *Outlier) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *Outlier) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *Outlier) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *Outlier) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetType + +`func (o *Outlier) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Outlier) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Outlier) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Outlier) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetFirstDetectionDate + +`func (o *Outlier) GetFirstDetectionDate() SailPointTime` + +GetFirstDetectionDate returns the FirstDetectionDate field if non-nil, zero value otherwise. + +### GetFirstDetectionDateOk + +`func (o *Outlier) GetFirstDetectionDateOk() (*SailPointTime, bool)` + +GetFirstDetectionDateOk returns a tuple with the FirstDetectionDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstDetectionDate + +`func (o *Outlier) SetFirstDetectionDate(v SailPointTime)` + +SetFirstDetectionDate sets FirstDetectionDate field to given value. + +### HasFirstDetectionDate + +`func (o *Outlier) HasFirstDetectionDate() bool` + +HasFirstDetectionDate returns a boolean if a field has been set. + +### GetLatestDetectionDate + +`func (o *Outlier) GetLatestDetectionDate() SailPointTime` + +GetLatestDetectionDate returns the LatestDetectionDate field if non-nil, zero value otherwise. + +### GetLatestDetectionDateOk + +`func (o *Outlier) GetLatestDetectionDateOk() (*SailPointTime, bool)` + +GetLatestDetectionDateOk returns a tuple with the LatestDetectionDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLatestDetectionDate + +`func (o *Outlier) SetLatestDetectionDate(v SailPointTime)` + +SetLatestDetectionDate sets LatestDetectionDate field to given value. + +### HasLatestDetectionDate + +`func (o *Outlier) HasLatestDetectionDate() bool` + +HasLatestDetectionDate returns a boolean if a field has been set. + +### GetIgnored + +`func (o *Outlier) GetIgnored() bool` + +GetIgnored returns the Ignored field if non-nil, zero value otherwise. + +### GetIgnoredOk + +`func (o *Outlier) GetIgnoredOk() (*bool, bool)` + +GetIgnoredOk returns a tuple with the Ignored field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIgnored + +`func (o *Outlier) SetIgnored(v bool)` + +SetIgnored sets Ignored field to given value. + +### HasIgnored + +`func (o *Outlier) HasIgnored() bool` + +HasIgnored returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Outlier) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Outlier) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Outlier) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Outlier) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetScore + +`func (o *Outlier) GetScore() float32` + +GetScore returns the Score field if non-nil, zero value otherwise. + +### GetScoreOk + +`func (o *Outlier) GetScoreOk() (*float32, bool)` + +GetScoreOk returns a tuple with the Score field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScore + +`func (o *Outlier) SetScore(v float32)` + +SetScore sets Score field to given value. + +### HasScore + +`func (o *Outlier) HasScore() bool` + +HasScore returns a boolean if a field has been set. + +### GetUnignoreType + +`func (o *Outlier) GetUnignoreType() string` + +GetUnignoreType returns the UnignoreType field if non-nil, zero value otherwise. + +### GetUnignoreTypeOk + +`func (o *Outlier) GetUnignoreTypeOk() (*string, bool)` + +GetUnignoreTypeOk returns a tuple with the UnignoreType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnignoreType + +`func (o *Outlier) SetUnignoreType(v string)` + +SetUnignoreType sets UnignoreType field to given value. + +### HasUnignoreType + +`func (o *Outlier) HasUnignoreType() bool` + +HasUnignoreType returns a boolean if a field has been set. + +### SetUnignoreTypeNil + +`func (o *Outlier) SetUnignoreTypeNil(b bool)` + + SetUnignoreTypeNil sets the value for UnignoreType to be an explicit nil + +### UnsetUnignoreType +`func (o *Outlier) UnsetUnignoreType()` + +UnsetUnignoreType ensures that no value is present for UnignoreType, not even an explicit nil +### GetUnignoreDate + +`func (o *Outlier) GetUnignoreDate() SailPointTime` + +GetUnignoreDate returns the UnignoreDate field if non-nil, zero value otherwise. + +### GetUnignoreDateOk + +`func (o *Outlier) GetUnignoreDateOk() (*SailPointTime, bool)` + +GetUnignoreDateOk returns a tuple with the UnignoreDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnignoreDate + +`func (o *Outlier) SetUnignoreDate(v SailPointTime)` + +SetUnignoreDate sets UnignoreDate field to given value. + +### HasUnignoreDate + +`func (o *Outlier) HasUnignoreDate() bool` + +HasUnignoreDate returns a boolean if a field has been set. + +### SetUnignoreDateNil + +`func (o *Outlier) SetUnignoreDateNil(b bool)` + + SetUnignoreDateNil sets the value for UnignoreDate to be an explicit nil + +### UnsetUnignoreDate +`func (o *Outlier) UnsetUnignoreDate()` + +UnsetUnignoreDate ensures that no value is present for UnignoreDate, not even an explicit nil +### GetIgnoreDate + +`func (o *Outlier) GetIgnoreDate() SailPointTime` + +GetIgnoreDate returns the IgnoreDate field if non-nil, zero value otherwise. + +### GetIgnoreDateOk + +`func (o *Outlier) GetIgnoreDateOk() (*SailPointTime, bool)` + +GetIgnoreDateOk returns a tuple with the IgnoreDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIgnoreDate + +`func (o *Outlier) SetIgnoreDate(v SailPointTime)` + +SetIgnoreDate sets IgnoreDate field to given value. + +### HasIgnoreDate + +`func (o *Outlier) HasIgnoreDate() bool` + +HasIgnoreDate returns a boolean if a field has been set. + +### SetIgnoreDateNil + +`func (o *Outlier) SetIgnoreDateNil(b bool)` + + SetIgnoreDateNil sets the value for IgnoreDate to be an explicit nil + +### UnsetIgnoreDate +`func (o *Outlier) UnsetIgnoreDate()` + +UnsetIgnoreDate ensures that no value is present for IgnoreDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/OutlierContributingFeature.md b/docs/tools/sdk/go/Reference/V2025/Models/OutlierContributingFeature.md new file mode 100644 index 000000000..39479078d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/OutlierContributingFeature.md @@ -0,0 +1,256 @@ +--- +id: v2025-outlier-contributing-feature +title: OutlierContributingFeature +pagination_label: OutlierContributingFeature +sidebar_label: OutlierContributingFeature +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierContributingFeature', 'V2025OutlierContributingFeature'] +slug: /tools/sdk/go/v2025/models/outlier-contributing-feature +tags: ['SDK', 'Software Development Kit', 'OutlierContributingFeature', 'V2025OutlierContributingFeature'] +--- + +# OutlierContributingFeature + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Contributing feature id | [optional] +**Name** | Pointer to **string** | The name of the feature | [optional] +**ValueType** | Pointer to [**OutlierValueType**](outlier-value-type) | | [optional] +**Value** | Pointer to **float32** | The feature value | [optional] +**Importance** | Pointer to **float32** | The importance of the feature. This can also be a negative value | [optional] +**DisplayName** | Pointer to **string** | The (translated if header is passed) displayName for the feature | [optional] +**Description** | Pointer to **string** | The (translated if header is passed) description for the feature | [optional] +**TranslationMessages** | Pointer to [**NullableOutlierFeatureTranslation**](outlier-feature-translation) | | [optional] + +## Methods + +### NewOutlierContributingFeature + +`func NewOutlierContributingFeature() *OutlierContributingFeature` + +NewOutlierContributingFeature instantiates a new OutlierContributingFeature 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 + +### NewOutlierContributingFeatureWithDefaults + +`func NewOutlierContributingFeatureWithDefaults() *OutlierContributingFeature` + +NewOutlierContributingFeatureWithDefaults instantiates a new OutlierContributingFeature 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 + +### GetId + +`func (o *OutlierContributingFeature) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OutlierContributingFeature) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OutlierContributingFeature) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OutlierContributingFeature) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OutlierContributingFeature) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OutlierContributingFeature) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OutlierContributingFeature) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OutlierContributingFeature) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValueType + +`func (o *OutlierContributingFeature) GetValueType() OutlierValueType` + +GetValueType returns the ValueType field if non-nil, zero value otherwise. + +### GetValueTypeOk + +`func (o *OutlierContributingFeature) GetValueTypeOk() (*OutlierValueType, bool)` + +GetValueTypeOk returns a tuple with the ValueType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValueType + +`func (o *OutlierContributingFeature) SetValueType(v OutlierValueType)` + +SetValueType sets ValueType field to given value. + +### HasValueType + +`func (o *OutlierContributingFeature) HasValueType() bool` + +HasValueType returns a boolean if a field has been set. + +### GetValue + +`func (o *OutlierContributingFeature) GetValue() float32` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *OutlierContributingFeature) GetValueOk() (*float32, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *OutlierContributingFeature) SetValue(v float32)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *OutlierContributingFeature) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetImportance + +`func (o *OutlierContributingFeature) GetImportance() float32` + +GetImportance returns the Importance field if non-nil, zero value otherwise. + +### GetImportanceOk + +`func (o *OutlierContributingFeature) GetImportanceOk() (*float32, bool)` + +GetImportanceOk returns a tuple with the Importance field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImportance + +`func (o *OutlierContributingFeature) SetImportance(v float32)` + +SetImportance sets Importance field to given value. + +### HasImportance + +`func (o *OutlierContributingFeature) HasImportance() bool` + +HasImportance returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *OutlierContributingFeature) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *OutlierContributingFeature) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *OutlierContributingFeature) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *OutlierContributingFeature) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *OutlierContributingFeature) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *OutlierContributingFeature) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *OutlierContributingFeature) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *OutlierContributingFeature) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetTranslationMessages + +`func (o *OutlierContributingFeature) GetTranslationMessages() OutlierFeatureTranslation` + +GetTranslationMessages returns the TranslationMessages field if non-nil, zero value otherwise. + +### GetTranslationMessagesOk + +`func (o *OutlierContributingFeature) GetTranslationMessagesOk() (*OutlierFeatureTranslation, bool)` + +GetTranslationMessagesOk returns a tuple with the TranslationMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslationMessages + +`func (o *OutlierContributingFeature) SetTranslationMessages(v OutlierFeatureTranslation)` + +SetTranslationMessages sets TranslationMessages field to given value. + +### HasTranslationMessages + +`func (o *OutlierContributingFeature) HasTranslationMessages() bool` + +HasTranslationMessages returns a boolean if a field has been set. + +### SetTranslationMessagesNil + +`func (o *OutlierContributingFeature) SetTranslationMessagesNil(b bool)` + + SetTranslationMessagesNil sets the value for TranslationMessages to be an explicit nil + +### UnsetTranslationMessages +`func (o *OutlierContributingFeature) UnsetTranslationMessages()` + +UnsetTranslationMessages ensures that no value is present for TranslationMessages, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/OutlierFeatureSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/OutlierFeatureSummary.md new file mode 100644 index 000000000..309114227 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/OutlierFeatureSummary.md @@ -0,0 +1,266 @@ +--- +id: v2025-outlier-feature-summary +title: OutlierFeatureSummary +pagination_label: OutlierFeatureSummary +sidebar_label: OutlierFeatureSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierFeatureSummary', 'V2025OutlierFeatureSummary'] +slug: /tools/sdk/go/v2025/models/outlier-feature-summary +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureSummary', 'V2025OutlierFeatureSummary'] +--- + +# OutlierFeatureSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContributingFeatureName** | Pointer to **string** | Contributing feature name | [optional] +**IdentityOutlierDisplayName** | Pointer to **string** | Identity display name | [optional] +**OutlierFeatureDisplayValues** | Pointer to [**[]OutlierFeatureSummaryOutlierFeatureDisplayValuesInner**](outlier-feature-summary-outlier-feature-display-values-inner) | | [optional] +**FeatureDefinition** | Pointer to **string** | Definition of the feature | [optional] +**FeatureExplanation** | Pointer to **string** | Detailed explanation of the feature | [optional] +**PeerDisplayName** | Pointer to **NullableString** | outlier's peer identity display name | [optional] +**PeerIdentityId** | Pointer to **NullableString** | outlier's peer identity id | [optional] +**AccessItemReference** | Pointer to **map[string]interface{}** | Access Item reference | [optional] + +## Methods + +### NewOutlierFeatureSummary + +`func NewOutlierFeatureSummary() *OutlierFeatureSummary` + +NewOutlierFeatureSummary instantiates a new OutlierFeatureSummary 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 + +### NewOutlierFeatureSummaryWithDefaults + +`func NewOutlierFeatureSummaryWithDefaults() *OutlierFeatureSummary` + +NewOutlierFeatureSummaryWithDefaults instantiates a new OutlierFeatureSummary 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 + +### GetContributingFeatureName + +`func (o *OutlierFeatureSummary) GetContributingFeatureName() string` + +GetContributingFeatureName returns the ContributingFeatureName field if non-nil, zero value otherwise. + +### GetContributingFeatureNameOk + +`func (o *OutlierFeatureSummary) GetContributingFeatureNameOk() (*string, bool)` + +GetContributingFeatureNameOk returns a tuple with the ContributingFeatureName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContributingFeatureName + +`func (o *OutlierFeatureSummary) SetContributingFeatureName(v string)` + +SetContributingFeatureName sets ContributingFeatureName field to given value. + +### HasContributingFeatureName + +`func (o *OutlierFeatureSummary) HasContributingFeatureName() bool` + +HasContributingFeatureName returns a boolean if a field has been set. + +### GetIdentityOutlierDisplayName + +`func (o *OutlierFeatureSummary) GetIdentityOutlierDisplayName() string` + +GetIdentityOutlierDisplayName returns the IdentityOutlierDisplayName field if non-nil, zero value otherwise. + +### GetIdentityOutlierDisplayNameOk + +`func (o *OutlierFeatureSummary) GetIdentityOutlierDisplayNameOk() (*string, bool)` + +GetIdentityOutlierDisplayNameOk returns a tuple with the IdentityOutlierDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityOutlierDisplayName + +`func (o *OutlierFeatureSummary) SetIdentityOutlierDisplayName(v string)` + +SetIdentityOutlierDisplayName sets IdentityOutlierDisplayName field to given value. + +### HasIdentityOutlierDisplayName + +`func (o *OutlierFeatureSummary) HasIdentityOutlierDisplayName() bool` + +HasIdentityOutlierDisplayName returns a boolean if a field has been set. + +### GetOutlierFeatureDisplayValues + +`func (o *OutlierFeatureSummary) GetOutlierFeatureDisplayValues() []OutlierFeatureSummaryOutlierFeatureDisplayValuesInner` + +GetOutlierFeatureDisplayValues returns the OutlierFeatureDisplayValues field if non-nil, zero value otherwise. + +### GetOutlierFeatureDisplayValuesOk + +`func (o *OutlierFeatureSummary) GetOutlierFeatureDisplayValuesOk() (*[]OutlierFeatureSummaryOutlierFeatureDisplayValuesInner, bool)` + +GetOutlierFeatureDisplayValuesOk returns a tuple with the OutlierFeatureDisplayValues field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutlierFeatureDisplayValues + +`func (o *OutlierFeatureSummary) SetOutlierFeatureDisplayValues(v []OutlierFeatureSummaryOutlierFeatureDisplayValuesInner)` + +SetOutlierFeatureDisplayValues sets OutlierFeatureDisplayValues field to given value. + +### HasOutlierFeatureDisplayValues + +`func (o *OutlierFeatureSummary) HasOutlierFeatureDisplayValues() bool` + +HasOutlierFeatureDisplayValues returns a boolean if a field has been set. + +### GetFeatureDefinition + +`func (o *OutlierFeatureSummary) GetFeatureDefinition() string` + +GetFeatureDefinition returns the FeatureDefinition field if non-nil, zero value otherwise. + +### GetFeatureDefinitionOk + +`func (o *OutlierFeatureSummary) GetFeatureDefinitionOk() (*string, bool)` + +GetFeatureDefinitionOk returns a tuple with the FeatureDefinition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureDefinition + +`func (o *OutlierFeatureSummary) SetFeatureDefinition(v string)` + +SetFeatureDefinition sets FeatureDefinition field to given value. + +### HasFeatureDefinition + +`func (o *OutlierFeatureSummary) HasFeatureDefinition() bool` + +HasFeatureDefinition returns a boolean if a field has been set. + +### GetFeatureExplanation + +`func (o *OutlierFeatureSummary) GetFeatureExplanation() string` + +GetFeatureExplanation returns the FeatureExplanation field if non-nil, zero value otherwise. + +### GetFeatureExplanationOk + +`func (o *OutlierFeatureSummary) GetFeatureExplanationOk() (*string, bool)` + +GetFeatureExplanationOk returns a tuple with the FeatureExplanation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureExplanation + +`func (o *OutlierFeatureSummary) SetFeatureExplanation(v string)` + +SetFeatureExplanation sets FeatureExplanation field to given value. + +### HasFeatureExplanation + +`func (o *OutlierFeatureSummary) HasFeatureExplanation() bool` + +HasFeatureExplanation returns a boolean if a field has been set. + +### GetPeerDisplayName + +`func (o *OutlierFeatureSummary) GetPeerDisplayName() string` + +GetPeerDisplayName returns the PeerDisplayName field if non-nil, zero value otherwise. + +### GetPeerDisplayNameOk + +`func (o *OutlierFeatureSummary) GetPeerDisplayNameOk() (*string, bool)` + +GetPeerDisplayNameOk returns a tuple with the PeerDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPeerDisplayName + +`func (o *OutlierFeatureSummary) SetPeerDisplayName(v string)` + +SetPeerDisplayName sets PeerDisplayName field to given value. + +### HasPeerDisplayName + +`func (o *OutlierFeatureSummary) HasPeerDisplayName() bool` + +HasPeerDisplayName returns a boolean if a field has been set. + +### SetPeerDisplayNameNil + +`func (o *OutlierFeatureSummary) SetPeerDisplayNameNil(b bool)` + + SetPeerDisplayNameNil sets the value for PeerDisplayName to be an explicit nil + +### UnsetPeerDisplayName +`func (o *OutlierFeatureSummary) UnsetPeerDisplayName()` + +UnsetPeerDisplayName ensures that no value is present for PeerDisplayName, not even an explicit nil +### GetPeerIdentityId + +`func (o *OutlierFeatureSummary) GetPeerIdentityId() string` + +GetPeerIdentityId returns the PeerIdentityId field if non-nil, zero value otherwise. + +### GetPeerIdentityIdOk + +`func (o *OutlierFeatureSummary) GetPeerIdentityIdOk() (*string, bool)` + +GetPeerIdentityIdOk returns a tuple with the PeerIdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPeerIdentityId + +`func (o *OutlierFeatureSummary) SetPeerIdentityId(v string)` + +SetPeerIdentityId sets PeerIdentityId field to given value. + +### HasPeerIdentityId + +`func (o *OutlierFeatureSummary) HasPeerIdentityId() bool` + +HasPeerIdentityId returns a boolean if a field has been set. + +### SetPeerIdentityIdNil + +`func (o *OutlierFeatureSummary) SetPeerIdentityIdNil(b bool)` + + SetPeerIdentityIdNil sets the value for PeerIdentityId to be an explicit nil + +### UnsetPeerIdentityId +`func (o *OutlierFeatureSummary) UnsetPeerIdentityId()` + +UnsetPeerIdentityId ensures that no value is present for PeerIdentityId, not even an explicit nil +### GetAccessItemReference + +`func (o *OutlierFeatureSummary) GetAccessItemReference() map[string]interface{}` + +GetAccessItemReference returns the AccessItemReference field if non-nil, zero value otherwise. + +### GetAccessItemReferenceOk + +`func (o *OutlierFeatureSummary) GetAccessItemReferenceOk() (*map[string]interface{}, bool)` + +GetAccessItemReferenceOk returns a tuple with the AccessItemReference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessItemReference + +`func (o *OutlierFeatureSummary) SetAccessItemReference(v map[string]interface{})` + +SetAccessItemReference sets AccessItemReference field to given value. + +### HasAccessItemReference + +`func (o *OutlierFeatureSummary) HasAccessItemReference() bool` + +HasAccessItemReference returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md b/docs/tools/sdk/go/Reference/V2025/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md new file mode 100644 index 000000000..91a17e0a8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md @@ -0,0 +1,116 @@ +--- +id: v2025-outlier-feature-summary-outlier-feature-display-values-inner +title: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +pagination_label: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +sidebar_label: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierFeatureSummaryOutlierFeatureDisplayValuesInner', 'V2025OutlierFeatureSummaryOutlierFeatureDisplayValuesInner'] +slug: /tools/sdk/go/v2025/models/outlier-feature-summary-outlier-feature-display-values-inner +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureSummaryOutlierFeatureDisplayValuesInner', 'V2025OutlierFeatureSummaryOutlierFeatureDisplayValuesInner'] +--- + +# OutlierFeatureSummaryOutlierFeatureDisplayValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayName** | Pointer to **string** | display name | [optional] +**Value** | Pointer to **string** | value | [optional] +**ValueType** | Pointer to [**OutlierValueType**](outlier-value-type) | | [optional] + +## Methods + +### NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInner + +`func NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInner() *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner` + +NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInner instantiates a new OutlierFeatureSummaryOutlierFeatureDisplayValuesInner 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 + +### NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInnerWithDefaults + +`func NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInnerWithDefaults() *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner` + +NewOutlierFeatureSummaryOutlierFeatureDisplayValuesInnerWithDefaults instantiates a new OutlierFeatureSummaryOutlierFeatureDisplayValuesInner 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 + +### GetDisplayName + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetValue + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetValueType + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetValueType() OutlierValueType` + +GetValueType returns the ValueType field if non-nil, zero value otherwise. + +### GetValueTypeOk + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) GetValueTypeOk() (*OutlierValueType, bool)` + +GetValueTypeOk returns a tuple with the ValueType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValueType + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) SetValueType(v OutlierValueType)` + +SetValueType sets ValueType field to given value. + +### HasValueType + +`func (o *OutlierFeatureSummaryOutlierFeatureDisplayValuesInner) HasValueType() bool` + +HasValueType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/OutlierFeatureTranslation.md b/docs/tools/sdk/go/Reference/V2025/Models/OutlierFeatureTranslation.md new file mode 100644 index 000000000..9cd81c5be --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/OutlierFeatureTranslation.md @@ -0,0 +1,90 @@ +--- +id: v2025-outlier-feature-translation +title: OutlierFeatureTranslation +pagination_label: OutlierFeatureTranslation +sidebar_label: OutlierFeatureTranslation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierFeatureTranslation', 'V2025OutlierFeatureTranslation'] +slug: /tools/sdk/go/v2025/models/outlier-feature-translation +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureTranslation', 'V2025OutlierFeatureTranslation'] +--- + +# OutlierFeatureTranslation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayName** | Pointer to [**TranslationMessage**](translation-message) | | [optional] +**Description** | Pointer to [**TranslationMessage**](translation-message) | | [optional] + +## Methods + +### NewOutlierFeatureTranslation + +`func NewOutlierFeatureTranslation() *OutlierFeatureTranslation` + +NewOutlierFeatureTranslation instantiates a new OutlierFeatureTranslation 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 + +### NewOutlierFeatureTranslationWithDefaults + +`func NewOutlierFeatureTranslationWithDefaults() *OutlierFeatureTranslation` + +NewOutlierFeatureTranslationWithDefaults instantiates a new OutlierFeatureTranslation 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 + +### GetDisplayName + +`func (o *OutlierFeatureTranslation) GetDisplayName() TranslationMessage` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *OutlierFeatureTranslation) GetDisplayNameOk() (*TranslationMessage, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *OutlierFeatureTranslation) SetDisplayName(v TranslationMessage)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *OutlierFeatureTranslation) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *OutlierFeatureTranslation) GetDescription() TranslationMessage` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *OutlierFeatureTranslation) GetDescriptionOk() (*TranslationMessage, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *OutlierFeatureTranslation) SetDescription(v TranslationMessage)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *OutlierFeatureTranslation) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/OutlierSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/OutlierSummary.md new file mode 100644 index 000000000..89d9a22c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/OutlierSummary.md @@ -0,0 +1,168 @@ +--- +id: v2025-outlier-summary +title: OutlierSummary +pagination_label: OutlierSummary +sidebar_label: OutlierSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierSummary', 'V2025OutlierSummary'] +slug: /tools/sdk/go/v2025/models/outlier-summary +tags: ['SDK', 'Software Development Kit', 'OutlierSummary', 'V2025OutlierSummary'] +--- + +# OutlierSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of outlier summary | [optional] +**SnapshotDate** | Pointer to **SailPointTime** | The date the bulk outlier detection ran/snapshot was created | [optional] +**TotalOutliers** | Pointer to **int32** | Total number of outliers for the customer making the request | [optional] +**TotalIdentities** | Pointer to **int32** | Total number of identities for the customer making the request | [optional] +**TotalIgnored** | Pointer to **int32** | | [optional] [default to 0] + +## Methods + +### NewOutlierSummary + +`func NewOutlierSummary() *OutlierSummary` + +NewOutlierSummary instantiates a new OutlierSummary 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 + +### NewOutlierSummaryWithDefaults + +`func NewOutlierSummaryWithDefaults() *OutlierSummary` + +NewOutlierSummaryWithDefaults instantiates a new OutlierSummary 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 + +### GetType + +`func (o *OutlierSummary) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OutlierSummary) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OutlierSummary) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OutlierSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSnapshotDate + +`func (o *OutlierSummary) GetSnapshotDate() SailPointTime` + +GetSnapshotDate returns the SnapshotDate field if non-nil, zero value otherwise. + +### GetSnapshotDateOk + +`func (o *OutlierSummary) GetSnapshotDateOk() (*SailPointTime, bool)` + +GetSnapshotDateOk returns a tuple with the SnapshotDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSnapshotDate + +`func (o *OutlierSummary) SetSnapshotDate(v SailPointTime)` + +SetSnapshotDate sets SnapshotDate field to given value. + +### HasSnapshotDate + +`func (o *OutlierSummary) HasSnapshotDate() bool` + +HasSnapshotDate returns a boolean if a field has been set. + +### GetTotalOutliers + +`func (o *OutlierSummary) GetTotalOutliers() int32` + +GetTotalOutliers returns the TotalOutliers field if non-nil, zero value otherwise. + +### GetTotalOutliersOk + +`func (o *OutlierSummary) GetTotalOutliersOk() (*int32, bool)` + +GetTotalOutliersOk returns a tuple with the TotalOutliers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalOutliers + +`func (o *OutlierSummary) SetTotalOutliers(v int32)` + +SetTotalOutliers sets TotalOutliers field to given value. + +### HasTotalOutliers + +`func (o *OutlierSummary) HasTotalOutliers() bool` + +HasTotalOutliers returns a boolean if a field has been set. + +### GetTotalIdentities + +`func (o *OutlierSummary) GetTotalIdentities() int32` + +GetTotalIdentities returns the TotalIdentities field if non-nil, zero value otherwise. + +### GetTotalIdentitiesOk + +`func (o *OutlierSummary) 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 *OutlierSummary) SetTotalIdentities(v int32)` + +SetTotalIdentities sets TotalIdentities field to given value. + +### HasTotalIdentities + +`func (o *OutlierSummary) HasTotalIdentities() bool` + +HasTotalIdentities returns a boolean if a field has been set. + +### GetTotalIgnored + +`func (o *OutlierSummary) GetTotalIgnored() int32` + +GetTotalIgnored returns the TotalIgnored field if non-nil, zero value otherwise. + +### GetTotalIgnoredOk + +`func (o *OutlierSummary) GetTotalIgnoredOk() (*int32, bool)` + +GetTotalIgnoredOk returns a tuple with the TotalIgnored field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalIgnored + +`func (o *OutlierSummary) SetTotalIgnored(v int32)` + +SetTotalIgnored sets TotalIgnored field to given value. + +### HasTotalIgnored + +`func (o *OutlierSummary) HasTotalIgnored() bool` + +HasTotalIgnored returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/OutlierValueType.md b/docs/tools/sdk/go/Reference/V2025/Models/OutlierValueType.md new file mode 100644 index 000000000..28eb18d47 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/OutlierValueType.md @@ -0,0 +1,90 @@ +--- +id: v2025-outlier-value-type +title: OutlierValueType +pagination_label: OutlierValueType +sidebar_label: OutlierValueType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutlierValueType', 'V2025OutlierValueType'] +slug: /tools/sdk/go/v2025/models/outlier-value-type +tags: ['SDK', 'Software Development Kit', 'OutlierValueType', 'V2025OutlierValueType'] +--- + +# OutlierValueType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The data type of the value field | [optional] +**Ordinal** | Pointer to **int32** | The position of the value type | [optional] + +## Methods + +### NewOutlierValueType + +`func NewOutlierValueType() *OutlierValueType` + +NewOutlierValueType instantiates a new OutlierValueType 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 + +### NewOutlierValueTypeWithDefaults + +`func NewOutlierValueTypeWithDefaults() *OutlierValueType` + +NewOutlierValueTypeWithDefaults instantiates a new OutlierValueType 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 + +### GetName + +`func (o *OutlierValueType) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OutlierValueType) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OutlierValueType) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OutlierValueType) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOrdinal + +`func (o *OutlierValueType) GetOrdinal() int32` + +GetOrdinal returns the Ordinal field if non-nil, zero value otherwise. + +### GetOrdinalOk + +`func (o *OutlierValueType) GetOrdinalOk() (*int32, bool)` + +GetOrdinalOk returns a tuple with the Ordinal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrdinal + +`func (o *OutlierValueType) SetOrdinal(v int32)` + +SetOrdinal sets Ordinal field to given value. + +### HasOrdinal + +`func (o *OutlierValueType) HasOrdinal() bool` + +HasOrdinal returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/OutliersContributingFeatureAccessItems.md b/docs/tools/sdk/go/Reference/V2025/Models/OutliersContributingFeatureAccessItems.md new file mode 100644 index 000000000..14edd3f9d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/OutliersContributingFeatureAccessItems.md @@ -0,0 +1,204 @@ +--- +id: v2025-outliers-contributing-feature-access-items +title: OutliersContributingFeatureAccessItems +pagination_label: OutliersContributingFeatureAccessItems +sidebar_label: OutliersContributingFeatureAccessItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OutliersContributingFeatureAccessItems', 'V2025OutliersContributingFeatureAccessItems'] +slug: /tools/sdk/go/v2025/models/outliers-contributing-feature-access-items +tags: ['SDK', 'Software Development Kit', 'OutliersContributingFeatureAccessItems', 'V2025OutliersContributingFeatureAccessItems'] +--- + +# OutliersContributingFeatureAccessItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the access item | [optional] +**DisplayName** | Pointer to **string** | the display name of the access item | [optional] +**Description** | Pointer to **NullableString** | Description of the access item. | [optional] +**AccessType** | Pointer to **string** | The type of the access item. | [optional] +**SourceName** | Pointer to **string** | the associated source name if it exists | [optional] +**ExtremelyRare** | Pointer to **bool** | rarest access | [optional] [default to false] + +## Methods + +### NewOutliersContributingFeatureAccessItems + +`func NewOutliersContributingFeatureAccessItems() *OutliersContributingFeatureAccessItems` + +NewOutliersContributingFeatureAccessItems instantiates a new OutliersContributingFeatureAccessItems 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 + +### NewOutliersContributingFeatureAccessItemsWithDefaults + +`func NewOutliersContributingFeatureAccessItemsWithDefaults() *OutliersContributingFeatureAccessItems` + +NewOutliersContributingFeatureAccessItemsWithDefaults instantiates a new OutliersContributingFeatureAccessItems 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 + +### GetId + +`func (o *OutliersContributingFeatureAccessItems) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OutliersContributingFeatureAccessItems) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OutliersContributingFeatureAccessItems) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OutliersContributingFeatureAccessItems) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *OutliersContributingFeatureAccessItems) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *OutliersContributingFeatureAccessItems) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *OutliersContributingFeatureAccessItems) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *OutliersContributingFeatureAccessItems) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *OutliersContributingFeatureAccessItems) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *OutliersContributingFeatureAccessItems) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *OutliersContributingFeatureAccessItems) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *OutliersContributingFeatureAccessItems) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *OutliersContributingFeatureAccessItems) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *OutliersContributingFeatureAccessItems) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAccessType + +`func (o *OutliersContributingFeatureAccessItems) GetAccessType() string` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *OutliersContributingFeatureAccessItems) GetAccessTypeOk() (*string, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *OutliersContributingFeatureAccessItems) SetAccessType(v string)` + +SetAccessType sets AccessType field to given value. + +### HasAccessType + +`func (o *OutliersContributingFeatureAccessItems) HasAccessType() bool` + +HasAccessType returns a boolean if a field has been set. + +### GetSourceName + +`func (o *OutliersContributingFeatureAccessItems) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *OutliersContributingFeatureAccessItems) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *OutliersContributingFeatureAccessItems) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *OutliersContributingFeatureAccessItems) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetExtremelyRare + +`func (o *OutliersContributingFeatureAccessItems) GetExtremelyRare() bool` + +GetExtremelyRare returns the ExtremelyRare field if non-nil, zero value otherwise. + +### GetExtremelyRareOk + +`func (o *OutliersContributingFeatureAccessItems) GetExtremelyRareOk() (*bool, bool)` + +GetExtremelyRareOk returns a tuple with the ExtremelyRare field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExtremelyRare + +`func (o *OutliersContributingFeatureAccessItems) SetExtremelyRare(v bool)` + +SetExtremelyRare sets ExtremelyRare field to given value. + +### HasExtremelyRare + +`func (o *OutliersContributingFeatureAccessItems) HasExtremelyRare() bool` + +HasExtremelyRare returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/OwnerDto.md b/docs/tools/sdk/go/Reference/V2025/Models/OwnerDto.md new file mode 100644 index 000000000..76bad8143 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/OwnerDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-owner-dto +title: OwnerDto +pagination_label: OwnerDto +sidebar_label: OwnerDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OwnerDto', 'V2025OwnerDto'] +slug: /tools/sdk/go/v2025/models/owner-dto +tags: ['SDK', 'Software Development Kit', 'OwnerDto', 'V2025OwnerDto'] +--- + +# OwnerDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's DTO type. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] + +## Methods + +### NewOwnerDto + +`func NewOwnerDto() *OwnerDto` + +NewOwnerDto instantiates a new OwnerDto 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 + +### NewOwnerDtoWithDefaults + +`func NewOwnerDtoWithDefaults() *OwnerDto` + +NewOwnerDtoWithDefaults instantiates a new OwnerDto 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 + +### GetType + +`func (o *OwnerDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OwnerDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OwnerDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OwnerDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *OwnerDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OwnerDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OwnerDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OwnerDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OwnerDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OwnerDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OwnerDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OwnerDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/OwnerReference.md b/docs/tools/sdk/go/Reference/V2025/Models/OwnerReference.md new file mode 100644 index 000000000..cc370f84e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/OwnerReference.md @@ -0,0 +1,116 @@ +--- +id: v2025-owner-reference +title: OwnerReference +pagination_label: OwnerReference +sidebar_label: OwnerReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OwnerReference', 'V2025OwnerReference'] +slug: /tools/sdk/go/v2025/models/owner-reference +tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'V2025OwnerReference'] +--- + +# OwnerReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] + +## Methods + +### NewOwnerReference + +`func NewOwnerReference() *OwnerReference` + +NewOwnerReference instantiates a new OwnerReference 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 + +### NewOwnerReferenceWithDefaults + +`func NewOwnerReferenceWithDefaults() *OwnerReference` + +NewOwnerReferenceWithDefaults instantiates a new OwnerReference 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 + +### GetType + +`func (o *OwnerReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OwnerReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OwnerReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OwnerReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *OwnerReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OwnerReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OwnerReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OwnerReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OwnerReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OwnerReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OwnerReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OwnerReference) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/OwnerReferenceSegments.md b/docs/tools/sdk/go/Reference/V2025/Models/OwnerReferenceSegments.md new file mode 100644 index 000000000..51066b23c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/OwnerReferenceSegments.md @@ -0,0 +1,116 @@ +--- +id: v2025-owner-reference-segments +title: OwnerReferenceSegments +pagination_label: OwnerReferenceSegments +sidebar_label: OwnerReferenceSegments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OwnerReferenceSegments', 'V2025OwnerReferenceSegments'] +slug: /tools/sdk/go/v2025/models/owner-reference-segments +tags: ['SDK', 'Software Development Kit', 'OwnerReferenceSegments', 'V2025OwnerReferenceSegments'] +--- + +# OwnerReferenceSegments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**Id** | Pointer to **string** | Identity id | [optional] +**Name** | Pointer to **string** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] + +## Methods + +### NewOwnerReferenceSegments + +`func NewOwnerReferenceSegments() *OwnerReferenceSegments` + +NewOwnerReferenceSegments instantiates a new OwnerReferenceSegments 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 + +### NewOwnerReferenceSegmentsWithDefaults + +`func NewOwnerReferenceSegmentsWithDefaults() *OwnerReferenceSegments` + +NewOwnerReferenceSegmentsWithDefaults instantiates a new OwnerReferenceSegments 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 + +### GetType + +`func (o *OwnerReferenceSegments) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OwnerReferenceSegments) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OwnerReferenceSegments) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OwnerReferenceSegments) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *OwnerReferenceSegments) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OwnerReferenceSegments) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OwnerReferenceSegments) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OwnerReferenceSegments) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OwnerReferenceSegments) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OwnerReferenceSegments) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OwnerReferenceSegments) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OwnerReferenceSegments) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Owns.md b/docs/tools/sdk/go/Reference/V2025/Models/Owns.md new file mode 100644 index 000000000..2726a2079 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Owns.md @@ -0,0 +1,220 @@ +--- +id: v2025-owns +title: Owns +pagination_label: Owns +sidebar_label: Owns +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Owns', 'V2025Owns'] +slug: /tools/sdk/go/v2025/models/owns +tags: ['SDK', 'Software Development Kit', 'Owns', 'V2025Owns'] +--- + +# Owns + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Sources** | Pointer to [**[]Reference**](reference) | | [optional] +**Entitlements** | Pointer to [**[]Reference**](reference) | | [optional] +**AccessProfiles** | Pointer to [**[]Reference**](reference) | | [optional] +**Roles** | Pointer to [**[]Reference**](reference) | | [optional] +**Apps** | Pointer to [**[]Reference**](reference) | | [optional] +**GovernanceGroups** | Pointer to [**[]Reference**](reference) | | [optional] +**FallbackApprover** | Pointer to **bool** | | [optional] + +## Methods + +### NewOwns + +`func NewOwns() *Owns` + +NewOwns instantiates a new Owns 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 + +### NewOwnsWithDefaults + +`func NewOwnsWithDefaults() *Owns` + +NewOwnsWithDefaults instantiates a new Owns 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 + +### GetSources + +`func (o *Owns) GetSources() []Reference` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *Owns) GetSourcesOk() (*[]Reference, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *Owns) SetSources(v []Reference)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *Owns) HasSources() bool` + +HasSources returns a boolean if a field has been set. + +### GetEntitlements + +`func (o *Owns) GetEntitlements() []Reference` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *Owns) GetEntitlementsOk() (*[]Reference, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *Owns) SetEntitlements(v []Reference)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *Owns) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetAccessProfiles + +`func (o *Owns) GetAccessProfiles() []Reference` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *Owns) GetAccessProfilesOk() (*[]Reference, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *Owns) SetAccessProfiles(v []Reference)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *Owns) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### GetRoles + +`func (o *Owns) GetRoles() []Reference` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *Owns) GetRolesOk() (*[]Reference, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *Owns) SetRoles(v []Reference)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *Owns) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + +### GetApps + +`func (o *Owns) GetApps() []Reference` + +GetApps returns the Apps field if non-nil, zero value otherwise. + +### GetAppsOk + +`func (o *Owns) GetAppsOk() (*[]Reference, bool)` + +GetAppsOk returns a tuple with the Apps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApps + +`func (o *Owns) SetApps(v []Reference)` + +SetApps sets Apps field to given value. + +### HasApps + +`func (o *Owns) HasApps() bool` + +HasApps returns a boolean if a field has been set. + +### GetGovernanceGroups + +`func (o *Owns) GetGovernanceGroups() []Reference` + +GetGovernanceGroups returns the GovernanceGroups field if non-nil, zero value otherwise. + +### GetGovernanceGroupsOk + +`func (o *Owns) GetGovernanceGroupsOk() (*[]Reference, bool)` + +GetGovernanceGroupsOk returns a tuple with the GovernanceGroups field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceGroups + +`func (o *Owns) SetGovernanceGroups(v []Reference)` + +SetGovernanceGroups sets GovernanceGroups field to given value. + +### HasGovernanceGroups + +`func (o *Owns) HasGovernanceGroups() bool` + +HasGovernanceGroups returns a boolean if a field has been set. + +### GetFallbackApprover + +`func (o *Owns) GetFallbackApprover() bool` + +GetFallbackApprover returns the FallbackApprover field if non-nil, zero value otherwise. + +### GetFallbackApproverOk + +`func (o *Owns) GetFallbackApproverOk() (*bool, bool)` + +GetFallbackApproverOk returns a tuple with the FallbackApprover field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFallbackApprover + +`func (o *Owns) SetFallbackApprover(v bool)` + +SetFallbackApprover sets FallbackApprover field to given value. + +### HasFallbackApprover + +`func (o *Owns) HasFallbackApprover() bool` + +HasFallbackApprover returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PasswordChangeRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/PasswordChangeRequest.md new file mode 100644 index 000000000..0e9a413cd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PasswordChangeRequest.md @@ -0,0 +1,168 @@ +--- +id: v2025-password-change-request +title: PasswordChangeRequest +pagination_label: PasswordChangeRequest +sidebar_label: PasswordChangeRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordChangeRequest', 'V2025PasswordChangeRequest'] +slug: /tools/sdk/go/v2025/models/password-change-request +tags: ['SDK', 'Software Development Kit', 'PasswordChangeRequest', 'V2025PasswordChangeRequest'] +--- + +# PasswordChangeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | The identity ID that requested the password change | [optional] +**EncryptedPassword** | Pointer to **string** | The RSA encrypted password | [optional] +**PublicKeyId** | Pointer to **string** | The encryption key ID | [optional] +**AccountId** | Pointer to **string** | Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**SourceId** | Pointer to **string** | The ID of the source for which identity is requesting the password change | [optional] + +## Methods + +### NewPasswordChangeRequest + +`func NewPasswordChangeRequest() *PasswordChangeRequest` + +NewPasswordChangeRequest instantiates a new PasswordChangeRequest 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 + +### NewPasswordChangeRequestWithDefaults + +`func NewPasswordChangeRequestWithDefaults() *PasswordChangeRequest` + +NewPasswordChangeRequestWithDefaults instantiates a new PasswordChangeRequest 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 + +### GetIdentityId + +`func (o *PasswordChangeRequest) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *PasswordChangeRequest) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *PasswordChangeRequest) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *PasswordChangeRequest) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEncryptedPassword + +`func (o *PasswordChangeRequest) GetEncryptedPassword() string` + +GetEncryptedPassword returns the EncryptedPassword field if non-nil, zero value otherwise. + +### GetEncryptedPasswordOk + +`func (o *PasswordChangeRequest) GetEncryptedPasswordOk() (*string, bool)` + +GetEncryptedPasswordOk returns a tuple with the EncryptedPassword field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEncryptedPassword + +`func (o *PasswordChangeRequest) SetEncryptedPassword(v string)` + +SetEncryptedPassword sets EncryptedPassword field to given value. + +### HasEncryptedPassword + +`func (o *PasswordChangeRequest) HasEncryptedPassword() bool` + +HasEncryptedPassword returns a boolean if a field has been set. + +### GetPublicKeyId + +`func (o *PasswordChangeRequest) GetPublicKeyId() string` + +GetPublicKeyId returns the PublicKeyId field if non-nil, zero value otherwise. + +### GetPublicKeyIdOk + +`func (o *PasswordChangeRequest) GetPublicKeyIdOk() (*string, bool)` + +GetPublicKeyIdOk returns a tuple with the PublicKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyId + +`func (o *PasswordChangeRequest) SetPublicKeyId(v string)` + +SetPublicKeyId sets PublicKeyId field to given value. + +### HasPublicKeyId + +`func (o *PasswordChangeRequest) HasPublicKeyId() bool` + +HasPublicKeyId returns a boolean if a field has been set. + +### GetAccountId + +`func (o *PasswordChangeRequest) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *PasswordChangeRequest) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *PasswordChangeRequest) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *PasswordChangeRequest) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *PasswordChangeRequest) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *PasswordChangeRequest) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *PasswordChangeRequest) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *PasswordChangeRequest) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PasswordChangeResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/PasswordChangeResponse.md new file mode 100644 index 000000000..5c7dc6ead --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PasswordChangeResponse.md @@ -0,0 +1,100 @@ +--- +id: v2025-password-change-response +title: PasswordChangeResponse +pagination_label: PasswordChangeResponse +sidebar_label: PasswordChangeResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordChangeResponse', 'V2025PasswordChangeResponse'] +slug: /tools/sdk/go/v2025/models/password-change-response +tags: ['SDK', 'Software Development Kit', 'PasswordChangeResponse', 'V2025PasswordChangeResponse'] +--- + +# PasswordChangeResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **NullableString** | The password change request ID | [optional] +**State** | Pointer to **string** | Password change state | [optional] + +## Methods + +### NewPasswordChangeResponse + +`func NewPasswordChangeResponse() *PasswordChangeResponse` + +NewPasswordChangeResponse instantiates a new PasswordChangeResponse 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 + +### NewPasswordChangeResponseWithDefaults + +`func NewPasswordChangeResponseWithDefaults() *PasswordChangeResponse` + +NewPasswordChangeResponseWithDefaults instantiates a new PasswordChangeResponse 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 + +### GetRequestId + +`func (o *PasswordChangeResponse) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *PasswordChangeResponse) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *PasswordChangeResponse) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *PasswordChangeResponse) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *PasswordChangeResponse) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *PasswordChangeResponse) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetState + +`func (o *PasswordChangeResponse) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *PasswordChangeResponse) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *PasswordChangeResponse) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *PasswordChangeResponse) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PasswordDigitToken.md b/docs/tools/sdk/go/Reference/V2025/Models/PasswordDigitToken.md new file mode 100644 index 000000000..cda303c0c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PasswordDigitToken.md @@ -0,0 +1,90 @@ +--- +id: v2025-password-digit-token +title: PasswordDigitToken +pagination_label: PasswordDigitToken +sidebar_label: PasswordDigitToken +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordDigitToken', 'V2025PasswordDigitToken'] +slug: /tools/sdk/go/v2025/models/password-digit-token +tags: ['SDK', 'Software Development Kit', 'PasswordDigitToken', 'V2025PasswordDigitToken'] +--- + +# PasswordDigitToken + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DigitToken** | Pointer to **string** | The digit token for password management | [optional] +**RequestId** | Pointer to **string** | The reference ID of the digit token generation request | [optional] + +## Methods + +### NewPasswordDigitToken + +`func NewPasswordDigitToken() *PasswordDigitToken` + +NewPasswordDigitToken instantiates a new PasswordDigitToken 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 + +### NewPasswordDigitTokenWithDefaults + +`func NewPasswordDigitTokenWithDefaults() *PasswordDigitToken` + +NewPasswordDigitTokenWithDefaults instantiates a new PasswordDigitToken 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 + +### GetDigitToken + +`func (o *PasswordDigitToken) GetDigitToken() string` + +GetDigitToken returns the DigitToken field if non-nil, zero value otherwise. + +### GetDigitTokenOk + +`func (o *PasswordDigitToken) GetDigitTokenOk() (*string, bool)` + +GetDigitTokenOk returns a tuple with the DigitToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDigitToken + +`func (o *PasswordDigitToken) SetDigitToken(v string)` + +SetDigitToken sets DigitToken field to given value. + +### HasDigitToken + +`func (o *PasswordDigitToken) HasDigitToken() bool` + +HasDigitToken returns a boolean if a field has been set. + +### GetRequestId + +`func (o *PasswordDigitToken) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *PasswordDigitToken) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *PasswordDigitToken) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *PasswordDigitToken) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PasswordDigitTokenReset.md b/docs/tools/sdk/go/Reference/V2025/Models/PasswordDigitTokenReset.md new file mode 100644 index 000000000..e2bbccba5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PasswordDigitTokenReset.md @@ -0,0 +1,111 @@ +--- +id: v2025-password-digit-token-reset +title: PasswordDigitTokenReset +pagination_label: PasswordDigitTokenReset +sidebar_label: PasswordDigitTokenReset +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordDigitTokenReset', 'V2025PasswordDigitTokenReset'] +slug: /tools/sdk/go/v2025/models/password-digit-token-reset +tags: ['SDK', 'Software Development Kit', 'PasswordDigitTokenReset', 'V2025PasswordDigitTokenReset'] +--- + +# PasswordDigitTokenReset + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **string** | The uid of the user requested for digit token | +**Length** | Pointer to **int32** | The length of digit token. It should be from 6 to 18, inclusive. The default value is 6. | [optional] +**DurationMinutes** | Pointer to **int32** | The time to live for the digit token in minutes. The default value is 5 minutes. | [optional] + +## Methods + +### NewPasswordDigitTokenReset + +`func NewPasswordDigitTokenReset(userId string, ) *PasswordDigitTokenReset` + +NewPasswordDigitTokenReset instantiates a new PasswordDigitTokenReset 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 + +### NewPasswordDigitTokenResetWithDefaults + +`func NewPasswordDigitTokenResetWithDefaults() *PasswordDigitTokenReset` + +NewPasswordDigitTokenResetWithDefaults instantiates a new PasswordDigitTokenReset 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 + +### GetUserId + +`func (o *PasswordDigitTokenReset) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *PasswordDigitTokenReset) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *PasswordDigitTokenReset) SetUserId(v string)` + +SetUserId sets UserId field to given value. + + +### GetLength + +`func (o *PasswordDigitTokenReset) GetLength() int32` + +GetLength returns the Length field if non-nil, zero value otherwise. + +### GetLengthOk + +`func (o *PasswordDigitTokenReset) GetLengthOk() (*int32, bool)` + +GetLengthOk returns a tuple with the Length field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLength + +`func (o *PasswordDigitTokenReset) SetLength(v int32)` + +SetLength sets Length field to given value. + +### HasLength + +`func (o *PasswordDigitTokenReset) HasLength() bool` + +HasLength returns a boolean if a field has been set. + +### GetDurationMinutes + +`func (o *PasswordDigitTokenReset) GetDurationMinutes() int32` + +GetDurationMinutes returns the DurationMinutes field if non-nil, zero value otherwise. + +### GetDurationMinutesOk + +`func (o *PasswordDigitTokenReset) GetDurationMinutesOk() (*int32, bool)` + +GetDurationMinutesOk returns a tuple with the DurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDurationMinutes + +`func (o *PasswordDigitTokenReset) SetDurationMinutes(v int32)` + +SetDurationMinutes sets DurationMinutes field to given value. + +### HasDurationMinutes + +`func (o *PasswordDigitTokenReset) HasDurationMinutes() bool` + +HasDurationMinutes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PasswordInfo.md b/docs/tools/sdk/go/Reference/V2025/Models/PasswordInfo.md new file mode 100644 index 000000000..c411c8bb9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PasswordInfo.md @@ -0,0 +1,194 @@ +--- +id: v2025-password-info +title: PasswordInfo +pagination_label: PasswordInfo +sidebar_label: PasswordInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordInfo', 'V2025PasswordInfo'] +slug: /tools/sdk/go/v2025/models/password-info +tags: ['SDK', 'Software Development Kit', 'PasswordInfo', 'V2025PasswordInfo'] +--- + +# PasswordInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | Identity ID | [optional] +**SourceId** | Pointer to **string** | source ID | [optional] +**PublicKeyId** | Pointer to **string** | public key ID | [optional] +**PublicKey** | Pointer to **string** | User's public key with Base64 encoding | [optional] +**Accounts** | Pointer to [**[]PasswordInfoAccount**](password-info-account) | Account info related to queried identity and source | [optional] +**Policies** | Pointer to **[]string** | Password constraints | [optional] + +## Methods + +### NewPasswordInfo + +`func NewPasswordInfo() *PasswordInfo` + +NewPasswordInfo instantiates a new PasswordInfo 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 + +### NewPasswordInfoWithDefaults + +`func NewPasswordInfoWithDefaults() *PasswordInfo` + +NewPasswordInfoWithDefaults instantiates a new PasswordInfo 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 + +### GetIdentityId + +`func (o *PasswordInfo) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *PasswordInfo) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *PasswordInfo) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *PasswordInfo) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *PasswordInfo) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *PasswordInfo) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *PasswordInfo) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *PasswordInfo) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetPublicKeyId + +`func (o *PasswordInfo) GetPublicKeyId() string` + +GetPublicKeyId returns the PublicKeyId field if non-nil, zero value otherwise. + +### GetPublicKeyIdOk + +`func (o *PasswordInfo) GetPublicKeyIdOk() (*string, bool)` + +GetPublicKeyIdOk returns a tuple with the PublicKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyId + +`func (o *PasswordInfo) SetPublicKeyId(v string)` + +SetPublicKeyId sets PublicKeyId field to given value. + +### HasPublicKeyId + +`func (o *PasswordInfo) HasPublicKeyId() bool` + +HasPublicKeyId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *PasswordInfo) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *PasswordInfo) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *PasswordInfo) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *PasswordInfo) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetAccounts + +`func (o *PasswordInfo) GetAccounts() []PasswordInfoAccount` + +GetAccounts returns the Accounts field if non-nil, zero value otherwise. + +### GetAccountsOk + +`func (o *PasswordInfo) GetAccountsOk() (*[]PasswordInfoAccount, bool)` + +GetAccountsOk returns a tuple with the Accounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccounts + +`func (o *PasswordInfo) SetAccounts(v []PasswordInfoAccount)` + +SetAccounts sets Accounts field to given value. + +### HasAccounts + +`func (o *PasswordInfo) HasAccounts() bool` + +HasAccounts returns a boolean if a field has been set. + +### GetPolicies + +`func (o *PasswordInfo) GetPolicies() []string` + +GetPolicies returns the Policies field if non-nil, zero value otherwise. + +### GetPoliciesOk + +`func (o *PasswordInfo) GetPoliciesOk() (*[]string, bool)` + +GetPoliciesOk returns a tuple with the Policies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicies + +`func (o *PasswordInfo) SetPolicies(v []string)` + +SetPolicies sets Policies field to given value. + +### HasPolicies + +`func (o *PasswordInfo) HasPolicies() bool` + +HasPolicies returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PasswordInfoAccount.md b/docs/tools/sdk/go/Reference/V2025/Models/PasswordInfoAccount.md new file mode 100644 index 000000000..d4de240c9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PasswordInfoAccount.md @@ -0,0 +1,90 @@ +--- +id: v2025-password-info-account +title: PasswordInfoAccount +pagination_label: PasswordInfoAccount +sidebar_label: PasswordInfoAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordInfoAccount', 'V2025PasswordInfoAccount'] +slug: /tools/sdk/go/v2025/models/password-info-account +tags: ['SDK', 'Software Development Kit', 'PasswordInfoAccount', 'V2025PasswordInfoAccount'] +--- + +# PasswordInfoAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **string** | Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**AccountName** | Pointer to **string** | Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 | [optional] + +## Methods + +### NewPasswordInfoAccount + +`func NewPasswordInfoAccount() *PasswordInfoAccount` + +NewPasswordInfoAccount instantiates a new PasswordInfoAccount 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 + +### NewPasswordInfoAccountWithDefaults + +`func NewPasswordInfoAccountWithDefaults() *PasswordInfoAccount` + +NewPasswordInfoAccountWithDefaults instantiates a new PasswordInfoAccount 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 + +### GetAccountId + +`func (o *PasswordInfoAccount) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *PasswordInfoAccount) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *PasswordInfoAccount) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *PasswordInfoAccount) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetAccountName + +`func (o *PasswordInfoAccount) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *PasswordInfoAccount) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *PasswordInfoAccount) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *PasswordInfoAccount) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PasswordInfoQueryDTO.md b/docs/tools/sdk/go/Reference/V2025/Models/PasswordInfoQueryDTO.md new file mode 100644 index 000000000..6e67a9240 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PasswordInfoQueryDTO.md @@ -0,0 +1,90 @@ +--- +id: v2025-password-info-query-dto +title: PasswordInfoQueryDTO +pagination_label: PasswordInfoQueryDTO +sidebar_label: PasswordInfoQueryDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordInfoQueryDTO', 'V2025PasswordInfoQueryDTO'] +slug: /tools/sdk/go/v2025/models/password-info-query-dto +tags: ['SDK', 'Software Development Kit', 'PasswordInfoQueryDTO', 'V2025PasswordInfoQueryDTO'] +--- + +# PasswordInfoQueryDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserName** | Pointer to **string** | The login name of the user | [optional] +**SourceName** | Pointer to **string** | The display name of the source | [optional] + +## Methods + +### NewPasswordInfoQueryDTO + +`func NewPasswordInfoQueryDTO() *PasswordInfoQueryDTO` + +NewPasswordInfoQueryDTO instantiates a new PasswordInfoQueryDTO 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 + +### NewPasswordInfoQueryDTOWithDefaults + +`func NewPasswordInfoQueryDTOWithDefaults() *PasswordInfoQueryDTO` + +NewPasswordInfoQueryDTOWithDefaults instantiates a new PasswordInfoQueryDTO 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 + +### GetUserName + +`func (o *PasswordInfoQueryDTO) GetUserName() string` + +GetUserName returns the UserName field if non-nil, zero value otherwise. + +### GetUserNameOk + +`func (o *PasswordInfoQueryDTO) GetUserNameOk() (*string, bool)` + +GetUserNameOk returns a tuple with the UserName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserName + +`func (o *PasswordInfoQueryDTO) SetUserName(v string)` + +SetUserName sets UserName field to given value. + +### HasUserName + +`func (o *PasswordInfoQueryDTO) HasUserName() bool` + +HasUserName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *PasswordInfoQueryDTO) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *PasswordInfoQueryDTO) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *PasswordInfoQueryDTO) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *PasswordInfoQueryDTO) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PasswordOrgConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/PasswordOrgConfig.md new file mode 100644 index 000000000..d33578e22 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PasswordOrgConfig.md @@ -0,0 +1,142 @@ +--- +id: v2025-password-org-config +title: PasswordOrgConfig +pagination_label: PasswordOrgConfig +sidebar_label: PasswordOrgConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordOrgConfig', 'V2025PasswordOrgConfig'] +slug: /tools/sdk/go/v2025/models/password-org-config +tags: ['SDK', 'Software Development Kit', 'PasswordOrgConfig', 'V2025PasswordOrgConfig'] +--- + +# PasswordOrgConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomInstructionsEnabled** | Pointer to **bool** | Indicator whether custom password instructions feature is enabled. The default value is false. | [optional] [default to false] +**DigitTokenEnabled** | Pointer to **bool** | Indicator whether \"digit token\" feature is enabled. The default value is false. | [optional] [default to false] +**DigitTokenDurationMinutes** | Pointer to **int32** | The duration of \"digit token\" in minutes. The default value is 5. | [optional] [default to 5] +**DigitTokenLength** | Pointer to **int32** | The length of \"digit token\". The default value is 6. | [optional] [default to 6] + +## Methods + +### NewPasswordOrgConfig + +`func NewPasswordOrgConfig() *PasswordOrgConfig` + +NewPasswordOrgConfig instantiates a new PasswordOrgConfig 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 + +### NewPasswordOrgConfigWithDefaults + +`func NewPasswordOrgConfigWithDefaults() *PasswordOrgConfig` + +NewPasswordOrgConfigWithDefaults instantiates a new PasswordOrgConfig 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 + +### GetCustomInstructionsEnabled + +`func (o *PasswordOrgConfig) GetCustomInstructionsEnabled() bool` + +GetCustomInstructionsEnabled returns the CustomInstructionsEnabled field if non-nil, zero value otherwise. + +### GetCustomInstructionsEnabledOk + +`func (o *PasswordOrgConfig) GetCustomInstructionsEnabledOk() (*bool, bool)` + +GetCustomInstructionsEnabledOk returns a tuple with the CustomInstructionsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomInstructionsEnabled + +`func (o *PasswordOrgConfig) SetCustomInstructionsEnabled(v bool)` + +SetCustomInstructionsEnabled sets CustomInstructionsEnabled field to given value. + +### HasCustomInstructionsEnabled + +`func (o *PasswordOrgConfig) HasCustomInstructionsEnabled() bool` + +HasCustomInstructionsEnabled returns a boolean if a field has been set. + +### GetDigitTokenEnabled + +`func (o *PasswordOrgConfig) GetDigitTokenEnabled() bool` + +GetDigitTokenEnabled returns the DigitTokenEnabled field if non-nil, zero value otherwise. + +### GetDigitTokenEnabledOk + +`func (o *PasswordOrgConfig) GetDigitTokenEnabledOk() (*bool, bool)` + +GetDigitTokenEnabledOk returns a tuple with the DigitTokenEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDigitTokenEnabled + +`func (o *PasswordOrgConfig) SetDigitTokenEnabled(v bool)` + +SetDigitTokenEnabled sets DigitTokenEnabled field to given value. + +### HasDigitTokenEnabled + +`func (o *PasswordOrgConfig) HasDigitTokenEnabled() bool` + +HasDigitTokenEnabled returns a boolean if a field has been set. + +### GetDigitTokenDurationMinutes + +`func (o *PasswordOrgConfig) GetDigitTokenDurationMinutes() int32` + +GetDigitTokenDurationMinutes returns the DigitTokenDurationMinutes field if non-nil, zero value otherwise. + +### GetDigitTokenDurationMinutesOk + +`func (o *PasswordOrgConfig) GetDigitTokenDurationMinutesOk() (*int32, bool)` + +GetDigitTokenDurationMinutesOk returns a tuple with the DigitTokenDurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDigitTokenDurationMinutes + +`func (o *PasswordOrgConfig) SetDigitTokenDurationMinutes(v int32)` + +SetDigitTokenDurationMinutes sets DigitTokenDurationMinutes field to given value. + +### HasDigitTokenDurationMinutes + +`func (o *PasswordOrgConfig) HasDigitTokenDurationMinutes() bool` + +HasDigitTokenDurationMinutes returns a boolean if a field has been set. + +### GetDigitTokenLength + +`func (o *PasswordOrgConfig) GetDigitTokenLength() int32` + +GetDigitTokenLength returns the DigitTokenLength field if non-nil, zero value otherwise. + +### GetDigitTokenLengthOk + +`func (o *PasswordOrgConfig) GetDigitTokenLengthOk() (*int32, bool)` + +GetDigitTokenLengthOk returns a tuple with the DigitTokenLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDigitTokenLength + +`func (o *PasswordOrgConfig) SetDigitTokenLength(v int32)` + +SetDigitTokenLength sets DigitTokenLength field to given value. + +### HasDigitTokenLength + +`func (o *PasswordOrgConfig) HasDigitTokenLength() bool` + +HasDigitTokenLength returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PasswordPolicyHoldersDtoAttributes.md b/docs/tools/sdk/go/Reference/V2025/Models/PasswordPolicyHoldersDtoAttributes.md new file mode 100644 index 000000000..94b75b88e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PasswordPolicyHoldersDtoAttributes.md @@ -0,0 +1,64 @@ +--- +id: v2025-password-policy-holders-dto-attributes +title: PasswordPolicyHoldersDtoAttributes +pagination_label: PasswordPolicyHoldersDtoAttributes +sidebar_label: PasswordPolicyHoldersDtoAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordPolicyHoldersDtoAttributes', 'V2025PasswordPolicyHoldersDtoAttributes'] +slug: /tools/sdk/go/v2025/models/password-policy-holders-dto-attributes +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyHoldersDtoAttributes', 'V2025PasswordPolicyHoldersDtoAttributes'] +--- + +# PasswordPolicyHoldersDtoAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttr** | Pointer to [**[]PasswordPolicyHoldersDtoAttributesIdentityAttrInner**](password-policy-holders-dto-attributes-identity-attr-inner) | Attributes of PasswordPolicyHoldersDto | [optional] + +## Methods + +### NewPasswordPolicyHoldersDtoAttributes + +`func NewPasswordPolicyHoldersDtoAttributes() *PasswordPolicyHoldersDtoAttributes` + +NewPasswordPolicyHoldersDtoAttributes instantiates a new PasswordPolicyHoldersDtoAttributes 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 + +### NewPasswordPolicyHoldersDtoAttributesWithDefaults + +`func NewPasswordPolicyHoldersDtoAttributesWithDefaults() *PasswordPolicyHoldersDtoAttributes` + +NewPasswordPolicyHoldersDtoAttributesWithDefaults instantiates a new PasswordPolicyHoldersDtoAttributes 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 + +### GetIdentityAttr + +`func (o *PasswordPolicyHoldersDtoAttributes) GetIdentityAttr() []PasswordPolicyHoldersDtoAttributesIdentityAttrInner` + +GetIdentityAttr returns the IdentityAttr field if non-nil, zero value otherwise. + +### GetIdentityAttrOk + +`func (o *PasswordPolicyHoldersDtoAttributes) GetIdentityAttrOk() (*[]PasswordPolicyHoldersDtoAttributesIdentityAttrInner, bool)` + +GetIdentityAttrOk returns a tuple with the IdentityAttr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttr + +`func (o *PasswordPolicyHoldersDtoAttributes) SetIdentityAttr(v []PasswordPolicyHoldersDtoAttributesIdentityAttrInner)` + +SetIdentityAttr sets IdentityAttr field to given value. + +### HasIdentityAttr + +`func (o *PasswordPolicyHoldersDtoAttributes) HasIdentityAttr() bool` + +HasIdentityAttr returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PasswordPolicyHoldersDtoAttributesIdentityAttrInner.md b/docs/tools/sdk/go/Reference/V2025/Models/PasswordPolicyHoldersDtoAttributesIdentityAttrInner.md new file mode 100644 index 000000000..a8948932d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PasswordPolicyHoldersDtoAttributesIdentityAttrInner.md @@ -0,0 +1,90 @@ +--- +id: v2025-password-policy-holders-dto-attributes-identity-attr-inner +title: PasswordPolicyHoldersDtoAttributesIdentityAttrInner +pagination_label: PasswordPolicyHoldersDtoAttributesIdentityAttrInner +sidebar_label: PasswordPolicyHoldersDtoAttributesIdentityAttrInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordPolicyHoldersDtoAttributesIdentityAttrInner', 'V2025PasswordPolicyHoldersDtoAttributesIdentityAttrInner'] +slug: /tools/sdk/go/v2025/models/password-policy-holders-dto-attributes-identity-attr-inner +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyHoldersDtoAttributesIdentityAttrInner', 'V2025PasswordPolicyHoldersDtoAttributesIdentityAttrInner'] +--- + +# PasswordPolicyHoldersDtoAttributesIdentityAttrInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Attribute's name | [optional] +**Value** | Pointer to **string** | Attribute's value | [optional] + +## Methods + +### NewPasswordPolicyHoldersDtoAttributesIdentityAttrInner + +`func NewPasswordPolicyHoldersDtoAttributesIdentityAttrInner() *PasswordPolicyHoldersDtoAttributesIdentityAttrInner` + +NewPasswordPolicyHoldersDtoAttributesIdentityAttrInner instantiates a new PasswordPolicyHoldersDtoAttributesIdentityAttrInner 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 + +### NewPasswordPolicyHoldersDtoAttributesIdentityAttrInnerWithDefaults + +`func NewPasswordPolicyHoldersDtoAttributesIdentityAttrInnerWithDefaults() *PasswordPolicyHoldersDtoAttributesIdentityAttrInner` + +NewPasswordPolicyHoldersDtoAttributesIdentityAttrInnerWithDefaults instantiates a new PasswordPolicyHoldersDtoAttributesIdentityAttrInner 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 + +### GetName + +`func (o *PasswordPolicyHoldersDtoAttributesIdentityAttrInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PasswordPolicyHoldersDtoAttributesIdentityAttrInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PasswordPolicyHoldersDtoAttributesIdentityAttrInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PasswordPolicyHoldersDtoAttributesIdentityAttrInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValue + +`func (o *PasswordPolicyHoldersDtoAttributesIdentityAttrInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *PasswordPolicyHoldersDtoAttributesIdentityAttrInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *PasswordPolicyHoldersDtoAttributesIdentityAttrInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *PasswordPolicyHoldersDtoAttributesIdentityAttrInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PasswordPolicyHoldersDtoInner.md b/docs/tools/sdk/go/Reference/V2025/Models/PasswordPolicyHoldersDtoInner.md new file mode 100644 index 000000000..a1544f625 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PasswordPolicyHoldersDtoInner.md @@ -0,0 +1,116 @@ +--- +id: v2025-password-policy-holders-dto-inner +title: PasswordPolicyHoldersDtoInner +pagination_label: PasswordPolicyHoldersDtoInner +sidebar_label: PasswordPolicyHoldersDtoInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordPolicyHoldersDtoInner', 'V2025PasswordPolicyHoldersDtoInner'] +slug: /tools/sdk/go/v2025/models/password-policy-holders-dto-inner +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyHoldersDtoInner', 'V2025PasswordPolicyHoldersDtoInner'] +--- + +# PasswordPolicyHoldersDtoInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PolicyId** | Pointer to **string** | The password policy Id. | [optional] +**PolicyName** | Pointer to **string** | The name of the password policy. | [optional] +**Selectors** | Pointer to [**PasswordPolicyHoldersDtoAttributes**](password-policy-holders-dto-attributes) | | [optional] + +## Methods + +### NewPasswordPolicyHoldersDtoInner + +`func NewPasswordPolicyHoldersDtoInner() *PasswordPolicyHoldersDtoInner` + +NewPasswordPolicyHoldersDtoInner instantiates a new PasswordPolicyHoldersDtoInner 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 + +### NewPasswordPolicyHoldersDtoInnerWithDefaults + +`func NewPasswordPolicyHoldersDtoInnerWithDefaults() *PasswordPolicyHoldersDtoInner` + +NewPasswordPolicyHoldersDtoInnerWithDefaults instantiates a new PasswordPolicyHoldersDtoInner 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 + +### GetPolicyId + +`func (o *PasswordPolicyHoldersDtoInner) GetPolicyId() string` + +GetPolicyId returns the PolicyId field if non-nil, zero value otherwise. + +### GetPolicyIdOk + +`func (o *PasswordPolicyHoldersDtoInner) GetPolicyIdOk() (*string, bool)` + +GetPolicyIdOk returns a tuple with the PolicyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyId + +`func (o *PasswordPolicyHoldersDtoInner) SetPolicyId(v string)` + +SetPolicyId sets PolicyId field to given value. + +### HasPolicyId + +`func (o *PasswordPolicyHoldersDtoInner) HasPolicyId() bool` + +HasPolicyId returns a boolean if a field has been set. + +### GetPolicyName + +`func (o *PasswordPolicyHoldersDtoInner) GetPolicyName() string` + +GetPolicyName returns the PolicyName field if non-nil, zero value otherwise. + +### GetPolicyNameOk + +`func (o *PasswordPolicyHoldersDtoInner) GetPolicyNameOk() (*string, bool)` + +GetPolicyNameOk returns a tuple with the PolicyName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyName + +`func (o *PasswordPolicyHoldersDtoInner) SetPolicyName(v string)` + +SetPolicyName sets PolicyName field to given value. + +### HasPolicyName + +`func (o *PasswordPolicyHoldersDtoInner) HasPolicyName() bool` + +HasPolicyName returns a boolean if a field has been set. + +### GetSelectors + +`func (o *PasswordPolicyHoldersDtoInner) GetSelectors() PasswordPolicyHoldersDtoAttributes` + +GetSelectors returns the Selectors field if non-nil, zero value otherwise. + +### GetSelectorsOk + +`func (o *PasswordPolicyHoldersDtoInner) GetSelectorsOk() (*PasswordPolicyHoldersDtoAttributes, bool)` + +GetSelectorsOk returns a tuple with the Selectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectors + +`func (o *PasswordPolicyHoldersDtoInner) SetSelectors(v PasswordPolicyHoldersDtoAttributes)` + +SetSelectors sets Selectors field to given value. + +### HasSelectors + +`func (o *PasswordPolicyHoldersDtoInner) HasSelectors() bool` + +HasSelectors returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PasswordPolicyV3Dto.md b/docs/tools/sdk/go/Reference/V2025/Models/PasswordPolicyV3Dto.md new file mode 100644 index 000000000..a035f3950 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PasswordPolicyV3Dto.md @@ -0,0 +1,884 @@ +--- +id: v2025-password-policy-v3-dto +title: PasswordPolicyV3Dto +pagination_label: PasswordPolicyV3Dto +sidebar_label: PasswordPolicyV3Dto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordPolicyV3Dto', 'V2025PasswordPolicyV3Dto'] +slug: /tools/sdk/go/v2025/models/password-policy-v3-dto +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyV3Dto', 'V2025PasswordPolicyV3Dto'] +--- + +# PasswordPolicyV3Dto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The password policy Id. | [optional] +**Description** | Pointer to **NullableString** | Description for current password policy. | [optional] +**Name** | Pointer to **string** | The name of the password policy. | [optional] +**DateCreated** | Pointer to **int64** | Date the Password Policy was created. | [optional] +**LastUpdated** | Pointer to **NullableInt64** | Date the Password Policy was updated. | [optional] +**FirstExpirationReminder** | Pointer to **int64** | The number of days before expiration remaninder. | [optional] +**AccountIdMinWordLength** | Pointer to **int64** | The minimun length of account Id. By default is equals to -1. | [optional] +**AccountNameMinWordLength** | Pointer to **int64** | The minimun length of account name. By default is equals to -1. | [optional] +**MinAlpha** | Pointer to **int64** | Maximum alpha. By default is equals to 0. | [optional] +**MinCharacterTypes** | Pointer to **int64** | MinCharacterTypes. By default is equals to -1. | [optional] +**MaxLength** | Pointer to **int64** | Maximum length of the password. | [optional] +**MinLength** | Pointer to **int64** | Minimum length of the password. By default is equals to 0. | [optional] +**MaxRepeatedChars** | Pointer to **int64** | Maximum repetition of the same character in the password. By default is equals to -1. | [optional] +**MinLower** | Pointer to **int64** | Minimum amount of lower case character in the password. By default is equals to 0. | [optional] +**MinNumeric** | Pointer to **int64** | Minimum amount of numeric characters in the password. By default is equals to 0. | [optional] +**MinSpecial** | Pointer to **int64** | Minimum amount of special symbols in the password. By default is equals to 0. | [optional] +**MinUpper** | Pointer to **int64** | Minimum amount of upper case symbols in the password. By default is equals to 0. | [optional] +**PasswordExpiration** | Pointer to **int64** | Number of days before current password expires. By default is equals to 90. | [optional] +**DefaultPolicy** | Pointer to **bool** | Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. | [optional] [default to false] +**EnablePasswdExpiration** | Pointer to **bool** | Defines whether this policy is enabled to expire or not. This field is false by default. | [optional] [default to false] +**RequireStrongAuthn** | Pointer to **bool** | Defines whether this policy require strong Auth or not. This field is false by default. | [optional] [default to false] +**RequireStrongAuthOffNetwork** | Pointer to **bool** | Defines whether this policy require strong Auth of network or not. This field is false by default. | [optional] [default to false] +**RequireStrongAuthUntrustedGeographies** | Pointer to **bool** | Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. | [optional] [default to false] +**UseAccountAttributes** | Pointer to **bool** | Defines whether this policy uses account attributes or not. This field is false by default. | [optional] [default to false] +**UseDictionary** | Pointer to **bool** | Defines whether this policy uses dictionary or not. This field is false by default. | [optional] [default to false] +**UseIdentityAttributes** | Pointer to **bool** | Defines whether this policy uses identity attributes or not. This field is false by default. | [optional] [default to false] +**ValidateAgainstAccountId** | Pointer to **bool** | Defines whether this policy validate against account id or not. This field is false by default. | [optional] [default to false] +**ValidateAgainstAccountName** | Pointer to **bool** | Defines whether this policy validate against account name or not. This field is false by default. | [optional] [default to false] +**Created** | Pointer to **NullableString** | | [optional] +**Modified** | Pointer to **NullableString** | | [optional] +**SourceIds** | Pointer to **[]string** | List of sources IDs managed by this password policy. | [optional] + +## Methods + +### NewPasswordPolicyV3Dto + +`func NewPasswordPolicyV3Dto() *PasswordPolicyV3Dto` + +NewPasswordPolicyV3Dto instantiates a new PasswordPolicyV3Dto 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 + +### NewPasswordPolicyV3DtoWithDefaults + +`func NewPasswordPolicyV3DtoWithDefaults() *PasswordPolicyV3Dto` + +NewPasswordPolicyV3DtoWithDefaults instantiates a new PasswordPolicyV3Dto 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 + +### GetId + +`func (o *PasswordPolicyV3Dto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PasswordPolicyV3Dto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PasswordPolicyV3Dto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PasswordPolicyV3Dto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDescription + +`func (o *PasswordPolicyV3Dto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *PasswordPolicyV3Dto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *PasswordPolicyV3Dto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *PasswordPolicyV3Dto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *PasswordPolicyV3Dto) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *PasswordPolicyV3Dto) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetName + +`func (o *PasswordPolicyV3Dto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PasswordPolicyV3Dto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PasswordPolicyV3Dto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PasswordPolicyV3Dto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDateCreated + +`func (o *PasswordPolicyV3Dto) GetDateCreated() int64` + +GetDateCreated returns the DateCreated field if non-nil, zero value otherwise. + +### GetDateCreatedOk + +`func (o *PasswordPolicyV3Dto) GetDateCreatedOk() (*int64, bool)` + +GetDateCreatedOk returns a tuple with the DateCreated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDateCreated + +`func (o *PasswordPolicyV3Dto) SetDateCreated(v int64)` + +SetDateCreated sets DateCreated field to given value. + +### HasDateCreated + +`func (o *PasswordPolicyV3Dto) HasDateCreated() bool` + +HasDateCreated returns a boolean if a field has been set. + +### GetLastUpdated + +`func (o *PasswordPolicyV3Dto) GetLastUpdated() int64` + +GetLastUpdated returns the LastUpdated field if non-nil, zero value otherwise. + +### GetLastUpdatedOk + +`func (o *PasswordPolicyV3Dto) GetLastUpdatedOk() (*int64, bool)` + +GetLastUpdatedOk returns a tuple with the LastUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdated + +`func (o *PasswordPolicyV3Dto) SetLastUpdated(v int64)` + +SetLastUpdated sets LastUpdated field to given value. + +### HasLastUpdated + +`func (o *PasswordPolicyV3Dto) HasLastUpdated() bool` + +HasLastUpdated returns a boolean if a field has been set. + +### SetLastUpdatedNil + +`func (o *PasswordPolicyV3Dto) SetLastUpdatedNil(b bool)` + + SetLastUpdatedNil sets the value for LastUpdated to be an explicit nil + +### UnsetLastUpdated +`func (o *PasswordPolicyV3Dto) UnsetLastUpdated()` + +UnsetLastUpdated ensures that no value is present for LastUpdated, not even an explicit nil +### GetFirstExpirationReminder + +`func (o *PasswordPolicyV3Dto) GetFirstExpirationReminder() int64` + +GetFirstExpirationReminder returns the FirstExpirationReminder field if non-nil, zero value otherwise. + +### GetFirstExpirationReminderOk + +`func (o *PasswordPolicyV3Dto) GetFirstExpirationReminderOk() (*int64, bool)` + +GetFirstExpirationReminderOk returns a tuple with the FirstExpirationReminder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstExpirationReminder + +`func (o *PasswordPolicyV3Dto) SetFirstExpirationReminder(v int64)` + +SetFirstExpirationReminder sets FirstExpirationReminder field to given value. + +### HasFirstExpirationReminder + +`func (o *PasswordPolicyV3Dto) HasFirstExpirationReminder() bool` + +HasFirstExpirationReminder returns a boolean if a field has been set. + +### GetAccountIdMinWordLength + +`func (o *PasswordPolicyV3Dto) GetAccountIdMinWordLength() int64` + +GetAccountIdMinWordLength returns the AccountIdMinWordLength field if non-nil, zero value otherwise. + +### GetAccountIdMinWordLengthOk + +`func (o *PasswordPolicyV3Dto) GetAccountIdMinWordLengthOk() (*int64, bool)` + +GetAccountIdMinWordLengthOk returns a tuple with the AccountIdMinWordLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountIdMinWordLength + +`func (o *PasswordPolicyV3Dto) SetAccountIdMinWordLength(v int64)` + +SetAccountIdMinWordLength sets AccountIdMinWordLength field to given value. + +### HasAccountIdMinWordLength + +`func (o *PasswordPolicyV3Dto) HasAccountIdMinWordLength() bool` + +HasAccountIdMinWordLength returns a boolean if a field has been set. + +### GetAccountNameMinWordLength + +`func (o *PasswordPolicyV3Dto) GetAccountNameMinWordLength() int64` + +GetAccountNameMinWordLength returns the AccountNameMinWordLength field if non-nil, zero value otherwise. + +### GetAccountNameMinWordLengthOk + +`func (o *PasswordPolicyV3Dto) GetAccountNameMinWordLengthOk() (*int64, bool)` + +GetAccountNameMinWordLengthOk returns a tuple with the AccountNameMinWordLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountNameMinWordLength + +`func (o *PasswordPolicyV3Dto) SetAccountNameMinWordLength(v int64)` + +SetAccountNameMinWordLength sets AccountNameMinWordLength field to given value. + +### HasAccountNameMinWordLength + +`func (o *PasswordPolicyV3Dto) HasAccountNameMinWordLength() bool` + +HasAccountNameMinWordLength returns a boolean if a field has been set. + +### GetMinAlpha + +`func (o *PasswordPolicyV3Dto) GetMinAlpha() int64` + +GetMinAlpha returns the MinAlpha field if non-nil, zero value otherwise. + +### GetMinAlphaOk + +`func (o *PasswordPolicyV3Dto) GetMinAlphaOk() (*int64, bool)` + +GetMinAlphaOk returns a tuple with the MinAlpha field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinAlpha + +`func (o *PasswordPolicyV3Dto) SetMinAlpha(v int64)` + +SetMinAlpha sets MinAlpha field to given value. + +### HasMinAlpha + +`func (o *PasswordPolicyV3Dto) HasMinAlpha() bool` + +HasMinAlpha returns a boolean if a field has been set. + +### GetMinCharacterTypes + +`func (o *PasswordPolicyV3Dto) GetMinCharacterTypes() int64` + +GetMinCharacterTypes returns the MinCharacterTypes field if non-nil, zero value otherwise. + +### GetMinCharacterTypesOk + +`func (o *PasswordPolicyV3Dto) GetMinCharacterTypesOk() (*int64, bool)` + +GetMinCharacterTypesOk returns a tuple with the MinCharacterTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinCharacterTypes + +`func (o *PasswordPolicyV3Dto) SetMinCharacterTypes(v int64)` + +SetMinCharacterTypes sets MinCharacterTypes field to given value. + +### HasMinCharacterTypes + +`func (o *PasswordPolicyV3Dto) HasMinCharacterTypes() bool` + +HasMinCharacterTypes returns a boolean if a field has been set. + +### GetMaxLength + +`func (o *PasswordPolicyV3Dto) GetMaxLength() int64` + +GetMaxLength returns the MaxLength field if non-nil, zero value otherwise. + +### GetMaxLengthOk + +`func (o *PasswordPolicyV3Dto) GetMaxLengthOk() (*int64, bool)` + +GetMaxLengthOk returns a tuple with the MaxLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxLength + +`func (o *PasswordPolicyV3Dto) SetMaxLength(v int64)` + +SetMaxLength sets MaxLength field to given value. + +### HasMaxLength + +`func (o *PasswordPolicyV3Dto) HasMaxLength() bool` + +HasMaxLength returns a boolean if a field has been set. + +### GetMinLength + +`func (o *PasswordPolicyV3Dto) GetMinLength() int64` + +GetMinLength returns the MinLength field if non-nil, zero value otherwise. + +### GetMinLengthOk + +`func (o *PasswordPolicyV3Dto) GetMinLengthOk() (*int64, bool)` + +GetMinLengthOk returns a tuple with the MinLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinLength + +`func (o *PasswordPolicyV3Dto) SetMinLength(v int64)` + +SetMinLength sets MinLength field to given value. + +### HasMinLength + +`func (o *PasswordPolicyV3Dto) HasMinLength() bool` + +HasMinLength returns a boolean if a field has been set. + +### GetMaxRepeatedChars + +`func (o *PasswordPolicyV3Dto) GetMaxRepeatedChars() int64` + +GetMaxRepeatedChars returns the MaxRepeatedChars field if non-nil, zero value otherwise. + +### GetMaxRepeatedCharsOk + +`func (o *PasswordPolicyV3Dto) GetMaxRepeatedCharsOk() (*int64, bool)` + +GetMaxRepeatedCharsOk returns a tuple with the MaxRepeatedChars field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxRepeatedChars + +`func (o *PasswordPolicyV3Dto) SetMaxRepeatedChars(v int64)` + +SetMaxRepeatedChars sets MaxRepeatedChars field to given value. + +### HasMaxRepeatedChars + +`func (o *PasswordPolicyV3Dto) HasMaxRepeatedChars() bool` + +HasMaxRepeatedChars returns a boolean if a field has been set. + +### GetMinLower + +`func (o *PasswordPolicyV3Dto) GetMinLower() int64` + +GetMinLower returns the MinLower field if non-nil, zero value otherwise. + +### GetMinLowerOk + +`func (o *PasswordPolicyV3Dto) GetMinLowerOk() (*int64, bool)` + +GetMinLowerOk returns a tuple with the MinLower field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinLower + +`func (o *PasswordPolicyV3Dto) SetMinLower(v int64)` + +SetMinLower sets MinLower field to given value. + +### HasMinLower + +`func (o *PasswordPolicyV3Dto) HasMinLower() bool` + +HasMinLower returns a boolean if a field has been set. + +### GetMinNumeric + +`func (o *PasswordPolicyV3Dto) GetMinNumeric() int64` + +GetMinNumeric returns the MinNumeric field if non-nil, zero value otherwise. + +### GetMinNumericOk + +`func (o *PasswordPolicyV3Dto) GetMinNumericOk() (*int64, bool)` + +GetMinNumericOk returns a tuple with the MinNumeric field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinNumeric + +`func (o *PasswordPolicyV3Dto) SetMinNumeric(v int64)` + +SetMinNumeric sets MinNumeric field to given value. + +### HasMinNumeric + +`func (o *PasswordPolicyV3Dto) HasMinNumeric() bool` + +HasMinNumeric returns a boolean if a field has been set. + +### GetMinSpecial + +`func (o *PasswordPolicyV3Dto) GetMinSpecial() int64` + +GetMinSpecial returns the MinSpecial field if non-nil, zero value otherwise. + +### GetMinSpecialOk + +`func (o *PasswordPolicyV3Dto) GetMinSpecialOk() (*int64, bool)` + +GetMinSpecialOk returns a tuple with the MinSpecial field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinSpecial + +`func (o *PasswordPolicyV3Dto) SetMinSpecial(v int64)` + +SetMinSpecial sets MinSpecial field to given value. + +### HasMinSpecial + +`func (o *PasswordPolicyV3Dto) HasMinSpecial() bool` + +HasMinSpecial returns a boolean if a field has been set. + +### GetMinUpper + +`func (o *PasswordPolicyV3Dto) GetMinUpper() int64` + +GetMinUpper returns the MinUpper field if non-nil, zero value otherwise. + +### GetMinUpperOk + +`func (o *PasswordPolicyV3Dto) GetMinUpperOk() (*int64, bool)` + +GetMinUpperOk returns a tuple with the MinUpper field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinUpper + +`func (o *PasswordPolicyV3Dto) SetMinUpper(v int64)` + +SetMinUpper sets MinUpper field to given value. + +### HasMinUpper + +`func (o *PasswordPolicyV3Dto) HasMinUpper() bool` + +HasMinUpper returns a boolean if a field has been set. + +### GetPasswordExpiration + +`func (o *PasswordPolicyV3Dto) GetPasswordExpiration() int64` + +GetPasswordExpiration returns the PasswordExpiration field if non-nil, zero value otherwise. + +### GetPasswordExpirationOk + +`func (o *PasswordPolicyV3Dto) GetPasswordExpirationOk() (*int64, bool)` + +GetPasswordExpirationOk returns a tuple with the PasswordExpiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordExpiration + +`func (o *PasswordPolicyV3Dto) SetPasswordExpiration(v int64)` + +SetPasswordExpiration sets PasswordExpiration field to given value. + +### HasPasswordExpiration + +`func (o *PasswordPolicyV3Dto) HasPasswordExpiration() bool` + +HasPasswordExpiration returns a boolean if a field has been set. + +### GetDefaultPolicy + +`func (o *PasswordPolicyV3Dto) GetDefaultPolicy() bool` + +GetDefaultPolicy returns the DefaultPolicy field if non-nil, zero value otherwise. + +### GetDefaultPolicyOk + +`func (o *PasswordPolicyV3Dto) GetDefaultPolicyOk() (*bool, bool)` + +GetDefaultPolicyOk returns a tuple with the DefaultPolicy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultPolicy + +`func (o *PasswordPolicyV3Dto) SetDefaultPolicy(v bool)` + +SetDefaultPolicy sets DefaultPolicy field to given value. + +### HasDefaultPolicy + +`func (o *PasswordPolicyV3Dto) HasDefaultPolicy() bool` + +HasDefaultPolicy returns a boolean if a field has been set. + +### GetEnablePasswdExpiration + +`func (o *PasswordPolicyV3Dto) GetEnablePasswdExpiration() bool` + +GetEnablePasswdExpiration returns the EnablePasswdExpiration field if non-nil, zero value otherwise. + +### GetEnablePasswdExpirationOk + +`func (o *PasswordPolicyV3Dto) GetEnablePasswdExpirationOk() (*bool, bool)` + +GetEnablePasswdExpirationOk returns a tuple with the EnablePasswdExpiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnablePasswdExpiration + +`func (o *PasswordPolicyV3Dto) SetEnablePasswdExpiration(v bool)` + +SetEnablePasswdExpiration sets EnablePasswdExpiration field to given value. + +### HasEnablePasswdExpiration + +`func (o *PasswordPolicyV3Dto) HasEnablePasswdExpiration() bool` + +HasEnablePasswdExpiration returns a boolean if a field has been set. + +### GetRequireStrongAuthn + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthn() bool` + +GetRequireStrongAuthn returns the RequireStrongAuthn field if non-nil, zero value otherwise. + +### GetRequireStrongAuthnOk + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthnOk() (*bool, bool)` + +GetRequireStrongAuthnOk returns a tuple with the RequireStrongAuthn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequireStrongAuthn + +`func (o *PasswordPolicyV3Dto) SetRequireStrongAuthn(v bool)` + +SetRequireStrongAuthn sets RequireStrongAuthn field to given value. + +### HasRequireStrongAuthn + +`func (o *PasswordPolicyV3Dto) HasRequireStrongAuthn() bool` + +HasRequireStrongAuthn returns a boolean if a field has been set. + +### GetRequireStrongAuthOffNetwork + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthOffNetwork() bool` + +GetRequireStrongAuthOffNetwork returns the RequireStrongAuthOffNetwork field if non-nil, zero value otherwise. + +### GetRequireStrongAuthOffNetworkOk + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthOffNetworkOk() (*bool, bool)` + +GetRequireStrongAuthOffNetworkOk returns a tuple with the RequireStrongAuthOffNetwork field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequireStrongAuthOffNetwork + +`func (o *PasswordPolicyV3Dto) SetRequireStrongAuthOffNetwork(v bool)` + +SetRequireStrongAuthOffNetwork sets RequireStrongAuthOffNetwork field to given value. + +### HasRequireStrongAuthOffNetwork + +`func (o *PasswordPolicyV3Dto) HasRequireStrongAuthOffNetwork() bool` + +HasRequireStrongAuthOffNetwork returns a boolean if a field has been set. + +### GetRequireStrongAuthUntrustedGeographies + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthUntrustedGeographies() bool` + +GetRequireStrongAuthUntrustedGeographies returns the RequireStrongAuthUntrustedGeographies field if non-nil, zero value otherwise. + +### GetRequireStrongAuthUntrustedGeographiesOk + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthUntrustedGeographiesOk() (*bool, bool)` + +GetRequireStrongAuthUntrustedGeographiesOk returns a tuple with the RequireStrongAuthUntrustedGeographies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequireStrongAuthUntrustedGeographies + +`func (o *PasswordPolicyV3Dto) SetRequireStrongAuthUntrustedGeographies(v bool)` + +SetRequireStrongAuthUntrustedGeographies sets RequireStrongAuthUntrustedGeographies field to given value. + +### HasRequireStrongAuthUntrustedGeographies + +`func (o *PasswordPolicyV3Dto) HasRequireStrongAuthUntrustedGeographies() bool` + +HasRequireStrongAuthUntrustedGeographies returns a boolean if a field has been set. + +### GetUseAccountAttributes + +`func (o *PasswordPolicyV3Dto) GetUseAccountAttributes() bool` + +GetUseAccountAttributes returns the UseAccountAttributes field if non-nil, zero value otherwise. + +### GetUseAccountAttributesOk + +`func (o *PasswordPolicyV3Dto) GetUseAccountAttributesOk() (*bool, bool)` + +GetUseAccountAttributesOk returns a tuple with the UseAccountAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseAccountAttributes + +`func (o *PasswordPolicyV3Dto) SetUseAccountAttributes(v bool)` + +SetUseAccountAttributes sets UseAccountAttributes field to given value. + +### HasUseAccountAttributes + +`func (o *PasswordPolicyV3Dto) HasUseAccountAttributes() bool` + +HasUseAccountAttributes returns a boolean if a field has been set. + +### GetUseDictionary + +`func (o *PasswordPolicyV3Dto) GetUseDictionary() bool` + +GetUseDictionary returns the UseDictionary field if non-nil, zero value otherwise. + +### GetUseDictionaryOk + +`func (o *PasswordPolicyV3Dto) GetUseDictionaryOk() (*bool, bool)` + +GetUseDictionaryOk returns a tuple with the UseDictionary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseDictionary + +`func (o *PasswordPolicyV3Dto) SetUseDictionary(v bool)` + +SetUseDictionary sets UseDictionary field to given value. + +### HasUseDictionary + +`func (o *PasswordPolicyV3Dto) HasUseDictionary() bool` + +HasUseDictionary returns a boolean if a field has been set. + +### GetUseIdentityAttributes + +`func (o *PasswordPolicyV3Dto) GetUseIdentityAttributes() bool` + +GetUseIdentityAttributes returns the UseIdentityAttributes field if non-nil, zero value otherwise. + +### GetUseIdentityAttributesOk + +`func (o *PasswordPolicyV3Dto) GetUseIdentityAttributesOk() (*bool, bool)` + +GetUseIdentityAttributesOk returns a tuple with the UseIdentityAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseIdentityAttributes + +`func (o *PasswordPolicyV3Dto) SetUseIdentityAttributes(v bool)` + +SetUseIdentityAttributes sets UseIdentityAttributes field to given value. + +### HasUseIdentityAttributes + +`func (o *PasswordPolicyV3Dto) HasUseIdentityAttributes() bool` + +HasUseIdentityAttributes returns a boolean if a field has been set. + +### GetValidateAgainstAccountId + +`func (o *PasswordPolicyV3Dto) GetValidateAgainstAccountId() bool` + +GetValidateAgainstAccountId returns the ValidateAgainstAccountId field if non-nil, zero value otherwise. + +### GetValidateAgainstAccountIdOk + +`func (o *PasswordPolicyV3Dto) GetValidateAgainstAccountIdOk() (*bool, bool)` + +GetValidateAgainstAccountIdOk returns a tuple with the ValidateAgainstAccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValidateAgainstAccountId + +`func (o *PasswordPolicyV3Dto) SetValidateAgainstAccountId(v bool)` + +SetValidateAgainstAccountId sets ValidateAgainstAccountId field to given value. + +### HasValidateAgainstAccountId + +`func (o *PasswordPolicyV3Dto) HasValidateAgainstAccountId() bool` + +HasValidateAgainstAccountId returns a boolean if a field has been set. + +### GetValidateAgainstAccountName + +`func (o *PasswordPolicyV3Dto) GetValidateAgainstAccountName() bool` + +GetValidateAgainstAccountName returns the ValidateAgainstAccountName field if non-nil, zero value otherwise. + +### GetValidateAgainstAccountNameOk + +`func (o *PasswordPolicyV3Dto) GetValidateAgainstAccountNameOk() (*bool, bool)` + +GetValidateAgainstAccountNameOk returns a tuple with the ValidateAgainstAccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValidateAgainstAccountName + +`func (o *PasswordPolicyV3Dto) SetValidateAgainstAccountName(v bool)` + +SetValidateAgainstAccountName sets ValidateAgainstAccountName field to given value. + +### HasValidateAgainstAccountName + +`func (o *PasswordPolicyV3Dto) HasValidateAgainstAccountName() bool` + +HasValidateAgainstAccountName returns a boolean if a field has been set. + +### GetCreated + +`func (o *PasswordPolicyV3Dto) GetCreated() string` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *PasswordPolicyV3Dto) GetCreatedOk() (*string, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *PasswordPolicyV3Dto) SetCreated(v string)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *PasswordPolicyV3Dto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *PasswordPolicyV3Dto) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *PasswordPolicyV3Dto) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *PasswordPolicyV3Dto) GetModified() string` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PasswordPolicyV3Dto) GetModifiedOk() (*string, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PasswordPolicyV3Dto) SetModified(v string)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PasswordPolicyV3Dto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *PasswordPolicyV3Dto) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *PasswordPolicyV3Dto) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSourceIds + +`func (o *PasswordPolicyV3Dto) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *PasswordPolicyV3Dto) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *PasswordPolicyV3Dto) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *PasswordPolicyV3Dto) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PasswordStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/PasswordStatus.md new file mode 100644 index 000000000..f4b32746f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PasswordStatus.md @@ -0,0 +1,152 @@ +--- +id: v2025-password-status +title: PasswordStatus +pagination_label: PasswordStatus +sidebar_label: PasswordStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordStatus', 'V2025PasswordStatus'] +slug: /tools/sdk/go/v2025/models/password-status +tags: ['SDK', 'Software Development Kit', 'PasswordStatus', 'V2025PasswordStatus'] +--- + +# PasswordStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **NullableString** | The password change request ID | [optional] +**State** | Pointer to **string** | Password change state | [optional] +**Errors** | Pointer to **[]string** | The errors during the password change request | [optional] +**SourceIds** | Pointer to **[]string** | List of source IDs in the password change request | [optional] + +## Methods + +### NewPasswordStatus + +`func NewPasswordStatus() *PasswordStatus` + +NewPasswordStatus instantiates a new PasswordStatus 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 + +### NewPasswordStatusWithDefaults + +`func NewPasswordStatusWithDefaults() *PasswordStatus` + +NewPasswordStatusWithDefaults instantiates a new PasswordStatus 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 + +### GetRequestId + +`func (o *PasswordStatus) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *PasswordStatus) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *PasswordStatus) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *PasswordStatus) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *PasswordStatus) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *PasswordStatus) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetState + +`func (o *PasswordStatus) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *PasswordStatus) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *PasswordStatus) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *PasswordStatus) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetErrors + +`func (o *PasswordStatus) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *PasswordStatus) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *PasswordStatus) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *PasswordStatus) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### GetSourceIds + +`func (o *PasswordStatus) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *PasswordStatus) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *PasswordStatus) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *PasswordStatus) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PasswordSyncGroup.md b/docs/tools/sdk/go/Reference/V2025/Models/PasswordSyncGroup.md new file mode 100644 index 000000000..742b0359a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PasswordSyncGroup.md @@ -0,0 +1,214 @@ +--- +id: v2025-password-sync-group +title: PasswordSyncGroup +pagination_label: PasswordSyncGroup +sidebar_label: PasswordSyncGroup +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordSyncGroup', 'V2025PasswordSyncGroup'] +slug: /tools/sdk/go/v2025/models/password-sync-group +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroup', 'V2025PasswordSyncGroup'] +--- + +# PasswordSyncGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the sync group | [optional] +**Name** | Pointer to **string** | Name of the sync group | [optional] +**PasswordPolicyId** | Pointer to **string** | ID of the password policy | [optional] +**SourceIds** | Pointer to **[]string** | List of password managed sources IDs | [optional] +**Created** | Pointer to **NullableTime** | The date and time this sync group was created | [optional] +**Modified** | Pointer to **NullableTime** | The date and time this sync group was last modified | [optional] + +## Methods + +### NewPasswordSyncGroup + +`func NewPasswordSyncGroup() *PasswordSyncGroup` + +NewPasswordSyncGroup instantiates a new PasswordSyncGroup 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 + +### NewPasswordSyncGroupWithDefaults + +`func NewPasswordSyncGroupWithDefaults() *PasswordSyncGroup` + +NewPasswordSyncGroupWithDefaults instantiates a new PasswordSyncGroup 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 + +### GetId + +`func (o *PasswordSyncGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PasswordSyncGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PasswordSyncGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PasswordSyncGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *PasswordSyncGroup) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PasswordSyncGroup) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PasswordSyncGroup) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PasswordSyncGroup) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPasswordPolicyId + +`func (o *PasswordSyncGroup) GetPasswordPolicyId() string` + +GetPasswordPolicyId returns the PasswordPolicyId field if non-nil, zero value otherwise. + +### GetPasswordPolicyIdOk + +`func (o *PasswordSyncGroup) GetPasswordPolicyIdOk() (*string, bool)` + +GetPasswordPolicyIdOk returns a tuple with the PasswordPolicyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicyId + +`func (o *PasswordSyncGroup) SetPasswordPolicyId(v string)` + +SetPasswordPolicyId sets PasswordPolicyId field to given value. + +### HasPasswordPolicyId + +`func (o *PasswordSyncGroup) HasPasswordPolicyId() bool` + +HasPasswordPolicyId returns a boolean if a field has been set. + +### GetSourceIds + +`func (o *PasswordSyncGroup) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *PasswordSyncGroup) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *PasswordSyncGroup) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *PasswordSyncGroup) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + +### GetCreated + +`func (o *PasswordSyncGroup) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *PasswordSyncGroup) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *PasswordSyncGroup) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *PasswordSyncGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *PasswordSyncGroup) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *PasswordSyncGroup) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *PasswordSyncGroup) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PasswordSyncGroup) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PasswordSyncGroup) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PasswordSyncGroup) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *PasswordSyncGroup) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *PasswordSyncGroup) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PatOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/PatOwner.md new file mode 100644 index 000000000..724cdff7d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PatOwner.md @@ -0,0 +1,116 @@ +--- +id: v2025-pat-owner +title: PatOwner +pagination_label: PatOwner +sidebar_label: PatOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PatOwner', 'V2025PatOwner'] +slug: /tools/sdk/go/v2025/models/pat-owner +tags: ['SDK', 'Software Development Kit', 'PatOwner', 'V2025PatOwner'] +--- + +# PatOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Personal access token owner's DTO type. | [optional] +**Id** | Pointer to **string** | Personal access token owner's identity ID. | [optional] +**Name** | Pointer to **string** | Personal access token owner's human-readable display name. | [optional] + +## Methods + +### NewPatOwner + +`func NewPatOwner() *PatOwner` + +NewPatOwner instantiates a new PatOwner 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 + +### NewPatOwnerWithDefaults + +`func NewPatOwnerWithDefaults() *PatOwner` + +NewPatOwnerWithDefaults instantiates a new PatOwner 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 + +### GetType + +`func (o *PatOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *PatOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *PatOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *PatOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *PatOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PatOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PatOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PatOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *PatOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PatOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PatOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PatOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PatchPotentialRoleRequestInner.md b/docs/tools/sdk/go/Reference/V2025/Models/PatchPotentialRoleRequestInner.md new file mode 100644 index 000000000..65dd2b462 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PatchPotentialRoleRequestInner.md @@ -0,0 +1,111 @@ +--- +id: v2025-patch-potential-role-request-inner +title: PatchPotentialRoleRequestInner +pagination_label: PatchPotentialRoleRequestInner +sidebar_label: PatchPotentialRoleRequestInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PatchPotentialRoleRequestInner', 'V2025PatchPotentialRoleRequestInner'] +slug: /tools/sdk/go/v2025/models/patch-potential-role-request-inner +tags: ['SDK', 'Software Development Kit', 'PatchPotentialRoleRequestInner', 'V2025PatchPotentialRoleRequestInner'] +--- + +# PatchPotentialRoleRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | Pointer to **string** | The operation to be performed | [optional] +**Path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | +**Value** | Pointer to [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] + +## Methods + +### NewPatchPotentialRoleRequestInner + +`func NewPatchPotentialRoleRequestInner(path string, ) *PatchPotentialRoleRequestInner` + +NewPatchPotentialRoleRequestInner instantiates a new PatchPotentialRoleRequestInner 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 + +### NewPatchPotentialRoleRequestInnerWithDefaults + +`func NewPatchPotentialRoleRequestInnerWithDefaults() *PatchPotentialRoleRequestInner` + +NewPatchPotentialRoleRequestInnerWithDefaults instantiates a new PatchPotentialRoleRequestInner 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 + +### GetOp + +`func (o *PatchPotentialRoleRequestInner) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *PatchPotentialRoleRequestInner) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *PatchPotentialRoleRequestInner) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *PatchPotentialRoleRequestInner) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetPath + +`func (o *PatchPotentialRoleRequestInner) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *PatchPotentialRoleRequestInner) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *PatchPotentialRoleRequestInner) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetValue + +`func (o *PatchPotentialRoleRequestInner) GetValue() UpdateMultiHostSourcesRequestInnerValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *PatchPotentialRoleRequestInner) GetValueOk() (*UpdateMultiHostSourcesRequestInnerValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *PatchPotentialRoleRequestInner) SetValue(v UpdateMultiHostSourcesRequestInnerValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *PatchPotentialRoleRequestInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PeerGroupMember.md b/docs/tools/sdk/go/Reference/V2025/Models/PeerGroupMember.md new file mode 100644 index 000000000..39a959dbf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PeerGroupMember.md @@ -0,0 +1,142 @@ +--- +id: v2025-peer-group-member +title: PeerGroupMember +pagination_label: PeerGroupMember +sidebar_label: PeerGroupMember +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PeerGroupMember', 'V2025PeerGroupMember'] +slug: /tools/sdk/go/v2025/models/peer-group-member +tags: ['SDK', 'Software Development Kit', 'PeerGroupMember', 'V2025PeerGroupMember'] +--- + +# PeerGroupMember + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | A unique identifier for the peer group member. | [optional] +**Type** | Pointer to **string** | The type of the peer group member. | [optional] +**PeerGroupId** | Pointer to **string** | The ID of the peer group. | [optional] +**Attributes** | Pointer to **map[string]map[string]interface{}** | Arbitrary key-value pairs, belonging to the peer group member. | [optional] + +## Methods + +### NewPeerGroupMember + +`func NewPeerGroupMember() *PeerGroupMember` + +NewPeerGroupMember instantiates a new PeerGroupMember 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 + +### NewPeerGroupMemberWithDefaults + +`func NewPeerGroupMemberWithDefaults() *PeerGroupMember` + +NewPeerGroupMemberWithDefaults instantiates a new PeerGroupMember 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 + +### GetId + +`func (o *PeerGroupMember) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PeerGroupMember) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PeerGroupMember) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PeerGroupMember) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *PeerGroupMember) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *PeerGroupMember) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *PeerGroupMember) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *PeerGroupMember) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetPeerGroupId + +`func (o *PeerGroupMember) GetPeerGroupId() string` + +GetPeerGroupId returns the PeerGroupId field if non-nil, zero value otherwise. + +### GetPeerGroupIdOk + +`func (o *PeerGroupMember) GetPeerGroupIdOk() (*string, bool)` + +GetPeerGroupIdOk returns a tuple with the PeerGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPeerGroupId + +`func (o *PeerGroupMember) SetPeerGroupId(v string)` + +SetPeerGroupId sets PeerGroupId field to given value. + +### HasPeerGroupId + +`func (o *PeerGroupMember) HasPeerGroupId() bool` + +HasPeerGroupId returns a boolean if a field has been set. + +### GetAttributes + +`func (o *PeerGroupMember) GetAttributes() map[string]map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *PeerGroupMember) GetAttributesOk() (*map[string]map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *PeerGroupMember) SetAttributes(v map[string]map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *PeerGroupMember) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PendingApproval.md b/docs/tools/sdk/go/Reference/V2025/Models/PendingApproval.md new file mode 100644 index 000000000..b95638a04 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PendingApproval.md @@ -0,0 +1,650 @@ +--- +id: v2025-pending-approval +title: PendingApproval +pagination_label: PendingApproval +sidebar_label: PendingApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PendingApproval', 'V2025PendingApproval'] +slug: /tools/sdk/go/v2025/models/pending-approval +tags: ['SDK', 'Software Development Kit', 'PendingApproval', 'V2025PendingApproval'] +--- + +# PendingApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The approval id. | [optional] +**AccessRequestId** | Pointer to **string** | This is the access request id. | [optional] +**Name** | Pointer to **string** | The name of the approval. | [optional] +**Created** | Pointer to **SailPointTime** | When the approval was created. | [optional] +**Modified** | Pointer to **SailPointTime** | When the approval was modified last time. | [optional] +**RequestCreated** | Pointer to **SailPointTime** | When the access-request was created. | [optional] +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**AccessItemRequestedFor**](access-item-requested-for) | | [optional] +**Owner** | Pointer to [**PendingApprovalOwner**](pending-approval-owner) | | [optional] +**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**RequesterComment** | Pointer to [**CommentDto**](comment-dto) | | [optional] +**PreviousReviewersComments** | Pointer to [**[]CommentDto**](comment-dto) | The history of the previous reviewers comments. | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**CommentRequiredWhenRejected** | Pointer to **bool** | When true the rejector has to provide comments when rejecting | [optional] [default to false] +**ActionInProcess** | Pointer to [**PendingApprovalAction**](pending-approval-action) | | [optional] +**RemoveDate** | Pointer to **SailPointTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**RemoveDateUpdateRequested** | Pointer to **bool** | If true, then the request is to change the remove date or sunset date. | [optional] [default to false] +**CurrentRemoveDate** | Pointer to **SailPointTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**SodViolationContext** | Pointer to [**NullableSodViolationContextCheckCompleted**](sod-violation-context-check-completed) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional] +**RequestedAccounts** | Pointer to [**[]RequestedAccountRef**](requested-account-ref) | The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. | [optional] + +## Methods + +### NewPendingApproval + +`func NewPendingApproval() *PendingApproval` + +NewPendingApproval instantiates a new PendingApproval 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 + +### NewPendingApprovalWithDefaults + +`func NewPendingApprovalWithDefaults() *PendingApproval` + +NewPendingApprovalWithDefaults instantiates a new PendingApproval 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 + +### GetId + +`func (o *PendingApproval) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PendingApproval) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PendingApproval) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PendingApproval) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccessRequestId + +`func (o *PendingApproval) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *PendingApproval) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *PendingApproval) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + +### HasAccessRequestId + +`func (o *PendingApproval) HasAccessRequestId() bool` + +HasAccessRequestId returns a boolean if a field has been set. + +### GetName + +`func (o *PendingApproval) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PendingApproval) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PendingApproval) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PendingApproval) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *PendingApproval) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *PendingApproval) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *PendingApproval) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *PendingApproval) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *PendingApproval) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PendingApproval) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PendingApproval) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PendingApproval) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetRequestCreated + +`func (o *PendingApproval) GetRequestCreated() SailPointTime` + +GetRequestCreated returns the RequestCreated field if non-nil, zero value otherwise. + +### GetRequestCreatedOk + +`func (o *PendingApproval) GetRequestCreatedOk() (*SailPointTime, bool)` + +GetRequestCreatedOk returns a tuple with the RequestCreated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCreated + +`func (o *PendingApproval) SetRequestCreated(v SailPointTime)` + +SetRequestCreated sets RequestCreated field to given value. + +### HasRequestCreated + +`func (o *PendingApproval) HasRequestCreated() bool` + +HasRequestCreated returns a boolean if a field has been set. + +### GetRequestType + +`func (o *PendingApproval) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *PendingApproval) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *PendingApproval) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *PendingApproval) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *PendingApproval) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *PendingApproval) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetRequester + +`func (o *PendingApproval) GetRequester() AccessItemRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *PendingApproval) GetRequesterOk() (*AccessItemRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *PendingApproval) SetRequester(v AccessItemRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *PendingApproval) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRequestedFor + +`func (o *PendingApproval) GetRequestedFor() AccessItemRequestedFor` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *PendingApproval) GetRequestedForOk() (*AccessItemRequestedFor, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *PendingApproval) SetRequestedFor(v AccessItemRequestedFor)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *PendingApproval) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetOwner + +`func (o *PendingApproval) GetOwner() PendingApprovalOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *PendingApproval) GetOwnerOk() (*PendingApprovalOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *PendingApproval) SetOwner(v PendingApprovalOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *PendingApproval) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRequestedObject + +`func (o *PendingApproval) GetRequestedObject() RequestableObjectReference` + +GetRequestedObject returns the RequestedObject field if non-nil, zero value otherwise. + +### GetRequestedObjectOk + +`func (o *PendingApproval) GetRequestedObjectOk() (*RequestableObjectReference, bool)` + +GetRequestedObjectOk returns a tuple with the RequestedObject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObject + +`func (o *PendingApproval) SetRequestedObject(v RequestableObjectReference)` + +SetRequestedObject sets RequestedObject field to given value. + +### HasRequestedObject + +`func (o *PendingApproval) HasRequestedObject() bool` + +HasRequestedObject returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *PendingApproval) GetRequesterComment() CommentDto` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *PendingApproval) GetRequesterCommentOk() (*CommentDto, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *PendingApproval) SetRequesterComment(v CommentDto)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *PendingApproval) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### GetPreviousReviewersComments + +`func (o *PendingApproval) GetPreviousReviewersComments() []CommentDto` + +GetPreviousReviewersComments returns the PreviousReviewersComments field if non-nil, zero value otherwise. + +### GetPreviousReviewersCommentsOk + +`func (o *PendingApproval) GetPreviousReviewersCommentsOk() (*[]CommentDto, bool)` + +GetPreviousReviewersCommentsOk returns a tuple with the PreviousReviewersComments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousReviewersComments + +`func (o *PendingApproval) SetPreviousReviewersComments(v []CommentDto)` + +SetPreviousReviewersComments sets PreviousReviewersComments field to given value. + +### HasPreviousReviewersComments + +`func (o *PendingApproval) HasPreviousReviewersComments() bool` + +HasPreviousReviewersComments returns a boolean if a field has been set. + +### GetForwardHistory + +`func (o *PendingApproval) GetForwardHistory() []ApprovalForwardHistory` + +GetForwardHistory returns the ForwardHistory field if non-nil, zero value otherwise. + +### GetForwardHistoryOk + +`func (o *PendingApproval) GetForwardHistoryOk() (*[]ApprovalForwardHistory, bool)` + +GetForwardHistoryOk returns a tuple with the ForwardHistory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwardHistory + +`func (o *PendingApproval) SetForwardHistory(v []ApprovalForwardHistory)` + +SetForwardHistory sets ForwardHistory field to given value. + +### HasForwardHistory + +`func (o *PendingApproval) HasForwardHistory() bool` + +HasForwardHistory returns a boolean if a field has been set. + +### GetCommentRequiredWhenRejected + +`func (o *PendingApproval) GetCommentRequiredWhenRejected() bool` + +GetCommentRequiredWhenRejected returns the CommentRequiredWhenRejected field if non-nil, zero value otherwise. + +### GetCommentRequiredWhenRejectedOk + +`func (o *PendingApproval) GetCommentRequiredWhenRejectedOk() (*bool, bool)` + +GetCommentRequiredWhenRejectedOk returns a tuple with the CommentRequiredWhenRejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentRequiredWhenRejected + +`func (o *PendingApproval) SetCommentRequiredWhenRejected(v bool)` + +SetCommentRequiredWhenRejected sets CommentRequiredWhenRejected field to given value. + +### HasCommentRequiredWhenRejected + +`func (o *PendingApproval) HasCommentRequiredWhenRejected() bool` + +HasCommentRequiredWhenRejected returns a boolean if a field has been set. + +### GetActionInProcess + +`func (o *PendingApproval) GetActionInProcess() PendingApprovalAction` + +GetActionInProcess returns the ActionInProcess field if non-nil, zero value otherwise. + +### GetActionInProcessOk + +`func (o *PendingApproval) GetActionInProcessOk() (*PendingApprovalAction, bool)` + +GetActionInProcessOk returns a tuple with the ActionInProcess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActionInProcess + +`func (o *PendingApproval) SetActionInProcess(v PendingApprovalAction)` + +SetActionInProcess sets ActionInProcess field to given value. + +### HasActionInProcess + +`func (o *PendingApproval) HasActionInProcess() bool` + +HasActionInProcess returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *PendingApproval) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *PendingApproval) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *PendingApproval) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *PendingApproval) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetRemoveDateUpdateRequested + +`func (o *PendingApproval) GetRemoveDateUpdateRequested() bool` + +GetRemoveDateUpdateRequested returns the RemoveDateUpdateRequested field if non-nil, zero value otherwise. + +### GetRemoveDateUpdateRequestedOk + +`func (o *PendingApproval) GetRemoveDateUpdateRequestedOk() (*bool, bool)` + +GetRemoveDateUpdateRequestedOk returns a tuple with the RemoveDateUpdateRequested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDateUpdateRequested + +`func (o *PendingApproval) SetRemoveDateUpdateRequested(v bool)` + +SetRemoveDateUpdateRequested sets RemoveDateUpdateRequested field to given value. + +### HasRemoveDateUpdateRequested + +`func (o *PendingApproval) HasRemoveDateUpdateRequested() bool` + +HasRemoveDateUpdateRequested returns a boolean if a field has been set. + +### GetCurrentRemoveDate + +`func (o *PendingApproval) GetCurrentRemoveDate() SailPointTime` + +GetCurrentRemoveDate returns the CurrentRemoveDate field if non-nil, zero value otherwise. + +### GetCurrentRemoveDateOk + +`func (o *PendingApproval) GetCurrentRemoveDateOk() (*SailPointTime, bool)` + +GetCurrentRemoveDateOk returns a tuple with the CurrentRemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentRemoveDate + +`func (o *PendingApproval) SetCurrentRemoveDate(v SailPointTime)` + +SetCurrentRemoveDate sets CurrentRemoveDate field to given value. + +### HasCurrentRemoveDate + +`func (o *PendingApproval) HasCurrentRemoveDate() bool` + +HasCurrentRemoveDate returns a boolean if a field has been set. + +### GetSodViolationContext + +`func (o *PendingApproval) GetSodViolationContext() SodViolationContextCheckCompleted` + +GetSodViolationContext returns the SodViolationContext field if non-nil, zero value otherwise. + +### GetSodViolationContextOk + +`func (o *PendingApproval) GetSodViolationContextOk() (*SodViolationContextCheckCompleted, bool)` + +GetSodViolationContextOk returns a tuple with the SodViolationContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodViolationContext + +`func (o *PendingApproval) SetSodViolationContext(v SodViolationContextCheckCompleted)` + +SetSodViolationContext sets SodViolationContext field to given value. + +### HasSodViolationContext + +`func (o *PendingApproval) HasSodViolationContext() bool` + +HasSodViolationContext returns a boolean if a field has been set. + +### SetSodViolationContextNil + +`func (o *PendingApproval) SetSodViolationContextNil(b bool)` + + SetSodViolationContextNil sets the value for SodViolationContext to be an explicit nil + +### UnsetSodViolationContext +`func (o *PendingApproval) UnsetSodViolationContext()` + +UnsetSodViolationContext ensures that no value is present for SodViolationContext, not even an explicit nil +### GetClientMetadata + +`func (o *PendingApproval) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *PendingApproval) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *PendingApproval) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *PendingApproval) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *PendingApproval) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *PendingApproval) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetRequestedAccounts + +`func (o *PendingApproval) GetRequestedAccounts() []RequestedAccountRef` + +GetRequestedAccounts returns the RequestedAccounts field if non-nil, zero value otherwise. + +### GetRequestedAccountsOk + +`func (o *PendingApproval) GetRequestedAccountsOk() (*[]RequestedAccountRef, bool)` + +GetRequestedAccountsOk returns a tuple with the RequestedAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedAccounts + +`func (o *PendingApproval) SetRequestedAccounts(v []RequestedAccountRef)` + +SetRequestedAccounts sets RequestedAccounts field to given value. + +### HasRequestedAccounts + +`func (o *PendingApproval) HasRequestedAccounts() bool` + +HasRequestedAccounts returns a boolean if a field has been set. + +### SetRequestedAccountsNil + +`func (o *PendingApproval) SetRequestedAccountsNil(b bool)` + + SetRequestedAccountsNil sets the value for RequestedAccounts to be an explicit nil + +### UnsetRequestedAccounts +`func (o *PendingApproval) UnsetRequestedAccounts()` + +UnsetRequestedAccounts ensures that no value is present for RequestedAccounts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PendingApprovalAction.md b/docs/tools/sdk/go/Reference/V2025/Models/PendingApprovalAction.md new file mode 100644 index 000000000..c038ea051 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PendingApprovalAction.md @@ -0,0 +1,23 @@ +--- +id: v2025-pending-approval-action +title: PendingApprovalAction +pagination_label: PendingApprovalAction +sidebar_label: PendingApprovalAction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PendingApprovalAction', 'V2025PendingApprovalAction'] +slug: /tools/sdk/go/v2025/models/pending-approval-action +tags: ['SDK', 'Software Development Kit', 'PendingApprovalAction', 'V2025PendingApprovalAction'] +--- + +# PendingApprovalAction + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `FORWARDED` (value: `"FORWARDED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PendingApprovalOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/PendingApprovalOwner.md new file mode 100644 index 000000000..863029a22 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PendingApprovalOwner.md @@ -0,0 +1,116 @@ +--- +id: v2025-pending-approval-owner +title: PendingApprovalOwner +pagination_label: PendingApprovalOwner +sidebar_label: PendingApprovalOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PendingApprovalOwner', 'V2025PendingApprovalOwner'] +slug: /tools/sdk/go/v2025/models/pending-approval-owner +tags: ['SDK', 'Software Development Kit', 'PendingApprovalOwner', 'V2025PendingApprovalOwner'] +--- + +# PendingApprovalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Access item owner's DTO type. | [optional] +**Id** | Pointer to **string** | Access item owner's identity ID. | [optional] +**Name** | Pointer to **string** | Access item owner's human-readable display name. | [optional] + +## Methods + +### NewPendingApprovalOwner + +`func NewPendingApprovalOwner() *PendingApprovalOwner` + +NewPendingApprovalOwner instantiates a new PendingApprovalOwner 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 + +### NewPendingApprovalOwnerWithDefaults + +`func NewPendingApprovalOwnerWithDefaults() *PendingApprovalOwner` + +NewPendingApprovalOwnerWithDefaults instantiates a new PendingApprovalOwner 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 + +### GetType + +`func (o *PendingApprovalOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *PendingApprovalOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *PendingApprovalOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *PendingApprovalOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *PendingApprovalOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PendingApprovalOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PendingApprovalOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PendingApprovalOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *PendingApprovalOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PendingApprovalOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PendingApprovalOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PendingApprovalOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PermissionDto.md b/docs/tools/sdk/go/Reference/V2025/Models/PermissionDto.md new file mode 100644 index 000000000..c60988d20 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PermissionDto.md @@ -0,0 +1,90 @@ +--- +id: v2025-permission-dto +title: PermissionDto +pagination_label: PermissionDto +sidebar_label: PermissionDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PermissionDto', 'V2025PermissionDto'] +slug: /tools/sdk/go/v2025/models/permission-dto +tags: ['SDK', 'Software Development Kit', 'PermissionDto', 'V2025PermissionDto'] +--- + +# PermissionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Rights** | Pointer to **[]string** | All the rights (e.g. actions) that this permission allows on the target | [optional] [readonly] +**Target** | Pointer to **string** | The target the permission would grants rights on. | [optional] [readonly] + +## Methods + +### NewPermissionDto + +`func NewPermissionDto() *PermissionDto` + +NewPermissionDto instantiates a new PermissionDto 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 + +### NewPermissionDtoWithDefaults + +`func NewPermissionDtoWithDefaults() *PermissionDto` + +NewPermissionDtoWithDefaults instantiates a new PermissionDto 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 + +### GetRights + +`func (o *PermissionDto) GetRights() []string` + +GetRights returns the Rights field if non-nil, zero value otherwise. + +### GetRightsOk + +`func (o *PermissionDto) GetRightsOk() (*[]string, bool)` + +GetRightsOk returns a tuple with the Rights field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRights + +`func (o *PermissionDto) SetRights(v []string)` + +SetRights sets Rights field to given value. + +### HasRights + +`func (o *PermissionDto) HasRights() bool` + +HasRights returns a boolean if a field has been set. + +### GetTarget + +`func (o *PermissionDto) GetTarget() string` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *PermissionDto) GetTargetOk() (*string, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *PermissionDto) SetTarget(v string)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *PermissionDto) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PreApprovalTriggerDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/PreApprovalTriggerDetails.md new file mode 100644 index 000000000..dd32cbb88 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PreApprovalTriggerDetails.md @@ -0,0 +1,116 @@ +--- +id: v2025-pre-approval-trigger-details +title: PreApprovalTriggerDetails +pagination_label: PreApprovalTriggerDetails +sidebar_label: PreApprovalTriggerDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PreApprovalTriggerDetails', 'V2025PreApprovalTriggerDetails'] +slug: /tools/sdk/go/v2025/models/pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'PreApprovalTriggerDetails', 'V2025PreApprovalTriggerDetails'] +--- + +# PreApprovalTriggerDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment left for the pre-approval decision | [optional] +**Reviewer** | Pointer to **string** | The reviewer of the pre-approval decision | [optional] +**Decision** | Pointer to **string** | The decision of the pre-approval trigger | [optional] + +## Methods + +### NewPreApprovalTriggerDetails + +`func NewPreApprovalTriggerDetails() *PreApprovalTriggerDetails` + +NewPreApprovalTriggerDetails instantiates a new PreApprovalTriggerDetails 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 + +### NewPreApprovalTriggerDetailsWithDefaults + +`func NewPreApprovalTriggerDetailsWithDefaults() *PreApprovalTriggerDetails` + +NewPreApprovalTriggerDetailsWithDefaults instantiates a new PreApprovalTriggerDetails 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 + +### GetComment + +`func (o *PreApprovalTriggerDetails) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *PreApprovalTriggerDetails) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *PreApprovalTriggerDetails) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *PreApprovalTriggerDetails) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetReviewer + +`func (o *PreApprovalTriggerDetails) GetReviewer() string` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *PreApprovalTriggerDetails) GetReviewerOk() (*string, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *PreApprovalTriggerDetails) SetReviewer(v string)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *PreApprovalTriggerDetails) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetDecision + +`func (o *PreApprovalTriggerDetails) GetDecision() string` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *PreApprovalTriggerDetails) GetDecisionOk() (*string, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *PreApprovalTriggerDetails) SetDecision(v string)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *PreApprovalTriggerDetails) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PreferencesDto.md b/docs/tools/sdk/go/Reference/V2025/Models/PreferencesDto.md new file mode 100644 index 000000000..ae201ae03 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PreferencesDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-preferences-dto +title: PreferencesDto +pagination_label: PreferencesDto +sidebar_label: PreferencesDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PreferencesDto', 'V2025PreferencesDto'] +slug: /tools/sdk/go/v2025/models/preferences-dto +tags: ['SDK', 'Software Development Kit', 'PreferencesDto', 'V2025PreferencesDto'] +--- + +# PreferencesDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The template notification key. | [optional] +**Mediums** | Pointer to [**[]Medium**](medium) | List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. | [optional] +**Modified** | Pointer to **SailPointTime** | Modified date of preference | [optional] + +## Methods + +### NewPreferencesDto + +`func NewPreferencesDto() *PreferencesDto` + +NewPreferencesDto instantiates a new PreferencesDto 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 + +### NewPreferencesDtoWithDefaults + +`func NewPreferencesDtoWithDefaults() *PreferencesDto` + +NewPreferencesDtoWithDefaults instantiates a new PreferencesDto 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 + +### GetKey + +`func (o *PreferencesDto) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *PreferencesDto) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *PreferencesDto) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *PreferencesDto) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetMediums + +`func (o *PreferencesDto) GetMediums() []Medium` + +GetMediums returns the Mediums field if non-nil, zero value otherwise. + +### GetMediumsOk + +`func (o *PreferencesDto) GetMediumsOk() (*[]Medium, bool)` + +GetMediumsOk returns a tuple with the Mediums field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMediums + +`func (o *PreferencesDto) SetMediums(v []Medium)` + +SetMediums sets Mediums field to given value. + +### HasMediums + +`func (o *PreferencesDto) HasMediums() bool` + +HasMediums returns a boolean if a field has been set. + +### GetModified + +`func (o *PreferencesDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PreferencesDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PreferencesDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PreferencesDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PreviewDataSourceResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/PreviewDataSourceResponse.md new file mode 100644 index 000000000..7feda853c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PreviewDataSourceResponse.md @@ -0,0 +1,64 @@ +--- +id: v2025-preview-data-source-response +title: PreviewDataSourceResponse +pagination_label: PreviewDataSourceResponse +sidebar_label: PreviewDataSourceResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PreviewDataSourceResponse', 'V2025PreviewDataSourceResponse'] +slug: /tools/sdk/go/v2025/models/preview-data-source-response +tags: ['SDK', 'Software Development Kit', 'PreviewDataSourceResponse', 'V2025PreviewDataSourceResponse'] +--- + +# PreviewDataSourceResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | Pointer to [**[]FormElementDataSourceConfigOptions**](form-element-data-source-config-options) | Results holds a list of FormElementDataSourceConfigOptions items | [optional] + +## Methods + +### NewPreviewDataSourceResponse + +`func NewPreviewDataSourceResponse() *PreviewDataSourceResponse` + +NewPreviewDataSourceResponse instantiates a new PreviewDataSourceResponse 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 + +### NewPreviewDataSourceResponseWithDefaults + +`func NewPreviewDataSourceResponseWithDefaults() *PreviewDataSourceResponse` + +NewPreviewDataSourceResponseWithDefaults instantiates a new PreviewDataSourceResponse 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 + +### GetResults + +`func (o *PreviewDataSourceResponse) GetResults() []FormElementDataSourceConfigOptions` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *PreviewDataSourceResponse) GetResultsOk() (*[]FormElementDataSourceConfigOptions, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *PreviewDataSourceResponse) SetResults(v []FormElementDataSourceConfigOptions)` + +SetResults sets Results field to given value. + +### HasResults + +`func (o *PreviewDataSourceResponse) HasResults() bool` + +HasResults returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProcessIdentitiesRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/ProcessIdentitiesRequest.md new file mode 100644 index 000000000..29fa022f1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProcessIdentitiesRequest.md @@ -0,0 +1,64 @@ +--- +id: v2025-process-identities-request +title: ProcessIdentitiesRequest +pagination_label: ProcessIdentitiesRequest +sidebar_label: ProcessIdentitiesRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProcessIdentitiesRequest', 'V2025ProcessIdentitiesRequest'] +slug: /tools/sdk/go/v2025/models/process-identities-request +tags: ['SDK', 'Software Development Kit', 'ProcessIdentitiesRequest', 'V2025ProcessIdentitiesRequest'] +--- + +# ProcessIdentitiesRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityIds** | Pointer to **[]string** | List of up to 250 identity IDs to process. | [optional] + +## Methods + +### NewProcessIdentitiesRequest + +`func NewProcessIdentitiesRequest() *ProcessIdentitiesRequest` + +NewProcessIdentitiesRequest instantiates a new ProcessIdentitiesRequest 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 + +### NewProcessIdentitiesRequestWithDefaults + +`func NewProcessIdentitiesRequestWithDefaults() *ProcessIdentitiesRequest` + +NewProcessIdentitiesRequestWithDefaults instantiates a new ProcessIdentitiesRequest 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 + +### GetIdentityIds + +`func (o *ProcessIdentitiesRequest) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *ProcessIdentitiesRequest) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *ProcessIdentitiesRequest) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *ProcessIdentitiesRequest) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProcessingDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/ProcessingDetails.md new file mode 100644 index 000000000..663c8c289 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProcessingDetails.md @@ -0,0 +1,178 @@ +--- +id: v2025-processing-details +title: ProcessingDetails +pagination_label: ProcessingDetails +sidebar_label: ProcessingDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProcessingDetails', 'V2025ProcessingDetails'] +slug: /tools/sdk/go/v2025/models/processing-details +tags: ['SDK', 'Software Development Kit', 'ProcessingDetails', 'V2025ProcessingDetails'] +--- + +# ProcessingDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Stage** | Pointer to **string** | | [optional] +**RetryCount** | Pointer to **int32** | | [optional] +**StackTrace** | Pointer to **string** | | [optional] +**Message** | Pointer to **string** | | [optional] + +## Methods + +### NewProcessingDetails + +`func NewProcessingDetails() *ProcessingDetails` + +NewProcessingDetails instantiates a new ProcessingDetails 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 + +### NewProcessingDetailsWithDefaults + +`func NewProcessingDetailsWithDefaults() *ProcessingDetails` + +NewProcessingDetailsWithDefaults instantiates a new ProcessingDetails 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 + +### GetDate + +`func (o *ProcessingDetails) GetDate() SailPointTime` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *ProcessingDetails) GetDateOk() (*SailPointTime, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *ProcessingDetails) SetDate(v SailPointTime)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *ProcessingDetails) HasDate() bool` + +HasDate returns a boolean if a field has been set. + +### SetDateNil + +`func (o *ProcessingDetails) SetDateNil(b bool)` + + SetDateNil sets the value for Date to be an explicit nil + +### UnsetDate +`func (o *ProcessingDetails) UnsetDate()` + +UnsetDate ensures that no value is present for Date, not even an explicit nil +### GetStage + +`func (o *ProcessingDetails) GetStage() string` + +GetStage returns the Stage field if non-nil, zero value otherwise. + +### GetStageOk + +`func (o *ProcessingDetails) GetStageOk() (*string, bool)` + +GetStageOk returns a tuple with the Stage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStage + +`func (o *ProcessingDetails) SetStage(v string)` + +SetStage sets Stage field to given value. + +### HasStage + +`func (o *ProcessingDetails) HasStage() bool` + +HasStage returns a boolean if a field has been set. + +### GetRetryCount + +`func (o *ProcessingDetails) GetRetryCount() int32` + +GetRetryCount returns the RetryCount field if non-nil, zero value otherwise. + +### GetRetryCountOk + +`func (o *ProcessingDetails) GetRetryCountOk() (*int32, bool)` + +GetRetryCountOk returns a tuple with the RetryCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRetryCount + +`func (o *ProcessingDetails) SetRetryCount(v int32)` + +SetRetryCount sets RetryCount field to given value. + +### HasRetryCount + +`func (o *ProcessingDetails) HasRetryCount() bool` + +HasRetryCount returns a boolean if a field has been set. + +### GetStackTrace + +`func (o *ProcessingDetails) GetStackTrace() string` + +GetStackTrace returns the StackTrace field if non-nil, zero value otherwise. + +### GetStackTraceOk + +`func (o *ProcessingDetails) GetStackTraceOk() (*string, bool)` + +GetStackTraceOk returns a tuple with the StackTrace field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStackTrace + +`func (o *ProcessingDetails) SetStackTrace(v string)` + +SetStackTrace sets StackTrace field to given value. + +### HasStackTrace + +`func (o *ProcessingDetails) HasStackTrace() bool` + +HasStackTrace returns a boolean if a field has been set. + +### GetMessage + +`func (o *ProcessingDetails) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *ProcessingDetails) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *ProcessingDetails) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *ProcessingDetails) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Product.md b/docs/tools/sdk/go/Reference/V2025/Models/Product.md new file mode 100644 index 000000000..4849697dd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Product.md @@ -0,0 +1,494 @@ +--- +id: v2025-product +title: Product +pagination_label: Product +sidebar_label: Product +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Product', 'V2025Product'] +slug: /tools/sdk/go/v2025/models/product +tags: ['SDK', 'Software Development Kit', 'Product', 'V2025Product'] +--- + +# Product + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProductName** | Pointer to **string** | Name of the Product | [optional] +**Url** | Pointer to **string** | URL of the Product | [optional] +**ProductTenantId** | Pointer to **string** | An identifier for a specific product-tenant combination | [optional] +**ProductRegion** | Pointer to **string** | Product region | [optional] +**ProductRight** | Pointer to **string** | Right needed for the Product | [optional] +**ApiUrl** | Pointer to **NullableString** | API URL of the Product | [optional] +**Licenses** | Pointer to [**[]License**](license) | | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Additional attributes for a product | [optional] +**Zone** | Pointer to **string** | Zone | [optional] +**Status** | Pointer to **string** | Status of the product | [optional] +**StatusDateTime** | Pointer to **SailPointTime** | Status datetime | [optional] +**Reason** | Pointer to **string** | If there's a tenant provisioning failure then reason will have the description of error | [optional] +**Notes** | Pointer to **string** | Product could have additional notes added during tenant provisioning. | [optional] +**DateCreated** | Pointer to **NullableTime** | Date when the product was created | [optional] +**LastUpdated** | Pointer to **NullableTime** | Date when the product was last updated | [optional] +**OrgType** | Pointer to **NullableString** | Type of org | [optional] + +## Methods + +### NewProduct + +`func NewProduct() *Product` + +NewProduct instantiates a new Product 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 + +### NewProductWithDefaults + +`func NewProductWithDefaults() *Product` + +NewProductWithDefaults instantiates a new Product 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 + +### GetProductName + +`func (o *Product) GetProductName() string` + +GetProductName returns the ProductName field if non-nil, zero value otherwise. + +### GetProductNameOk + +`func (o *Product) GetProductNameOk() (*string, bool)` + +GetProductNameOk returns a tuple with the ProductName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductName + +`func (o *Product) SetProductName(v string)` + +SetProductName sets ProductName field to given value. + +### HasProductName + +`func (o *Product) HasProductName() bool` + +HasProductName returns a boolean if a field has been set. + +### GetUrl + +`func (o *Product) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *Product) GetUrlOk() (*string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrl + +`func (o *Product) SetUrl(v string)` + +SetUrl sets Url field to given value. + +### HasUrl + +`func (o *Product) HasUrl() bool` + +HasUrl returns a boolean if a field has been set. + +### GetProductTenantId + +`func (o *Product) GetProductTenantId() string` + +GetProductTenantId returns the ProductTenantId field if non-nil, zero value otherwise. + +### GetProductTenantIdOk + +`func (o *Product) GetProductTenantIdOk() (*string, bool)` + +GetProductTenantIdOk returns a tuple with the ProductTenantId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductTenantId + +`func (o *Product) SetProductTenantId(v string)` + +SetProductTenantId sets ProductTenantId field to given value. + +### HasProductTenantId + +`func (o *Product) HasProductTenantId() bool` + +HasProductTenantId returns a boolean if a field has been set. + +### GetProductRegion + +`func (o *Product) GetProductRegion() string` + +GetProductRegion returns the ProductRegion field if non-nil, zero value otherwise. + +### GetProductRegionOk + +`func (o *Product) GetProductRegionOk() (*string, bool)` + +GetProductRegionOk returns a tuple with the ProductRegion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductRegion + +`func (o *Product) SetProductRegion(v string)` + +SetProductRegion sets ProductRegion field to given value. + +### HasProductRegion + +`func (o *Product) HasProductRegion() bool` + +HasProductRegion returns a boolean if a field has been set. + +### GetProductRight + +`func (o *Product) GetProductRight() string` + +GetProductRight returns the ProductRight field if non-nil, zero value otherwise. + +### GetProductRightOk + +`func (o *Product) GetProductRightOk() (*string, bool)` + +GetProductRightOk returns a tuple with the ProductRight field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductRight + +`func (o *Product) SetProductRight(v string)` + +SetProductRight sets ProductRight field to given value. + +### HasProductRight + +`func (o *Product) HasProductRight() bool` + +HasProductRight returns a boolean if a field has been set. + +### GetApiUrl + +`func (o *Product) GetApiUrl() string` + +GetApiUrl returns the ApiUrl field if non-nil, zero value otherwise. + +### GetApiUrlOk + +`func (o *Product) GetApiUrlOk() (*string, bool)` + +GetApiUrlOk returns a tuple with the ApiUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiUrl + +`func (o *Product) SetApiUrl(v string)` + +SetApiUrl sets ApiUrl field to given value. + +### HasApiUrl + +`func (o *Product) HasApiUrl() bool` + +HasApiUrl returns a boolean if a field has been set. + +### SetApiUrlNil + +`func (o *Product) SetApiUrlNil(b bool)` + + SetApiUrlNil sets the value for ApiUrl to be an explicit nil + +### UnsetApiUrl +`func (o *Product) UnsetApiUrl()` + +UnsetApiUrl ensures that no value is present for ApiUrl, not even an explicit nil +### GetLicenses + +`func (o *Product) GetLicenses() []License` + +GetLicenses returns the Licenses field if non-nil, zero value otherwise. + +### GetLicensesOk + +`func (o *Product) GetLicensesOk() (*[]License, bool)` + +GetLicensesOk returns a tuple with the Licenses field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLicenses + +`func (o *Product) SetLicenses(v []License)` + +SetLicenses sets Licenses field to given value. + +### HasLicenses + +`func (o *Product) HasLicenses() bool` + +HasLicenses returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Product) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Product) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Product) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Product) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetZone + +`func (o *Product) GetZone() string` + +GetZone returns the Zone field if non-nil, zero value otherwise. + +### GetZoneOk + +`func (o *Product) GetZoneOk() (*string, bool)` + +GetZoneOk returns a tuple with the Zone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetZone + +`func (o *Product) SetZone(v string)` + +SetZone sets Zone field to given value. + +### HasZone + +`func (o *Product) HasZone() bool` + +HasZone returns a boolean if a field has been set. + +### GetStatus + +`func (o *Product) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Product) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Product) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Product) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetStatusDateTime + +`func (o *Product) GetStatusDateTime() SailPointTime` + +GetStatusDateTime returns the StatusDateTime field if non-nil, zero value otherwise. + +### GetStatusDateTimeOk + +`func (o *Product) GetStatusDateTimeOk() (*SailPointTime, bool)` + +GetStatusDateTimeOk returns a tuple with the StatusDateTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusDateTime + +`func (o *Product) SetStatusDateTime(v SailPointTime)` + +SetStatusDateTime sets StatusDateTime field to given value. + +### HasStatusDateTime + +`func (o *Product) HasStatusDateTime() bool` + +HasStatusDateTime returns a boolean if a field has been set. + +### GetReason + +`func (o *Product) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *Product) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *Product) SetReason(v string)` + +SetReason sets Reason field to given value. + +### HasReason + +`func (o *Product) HasReason() bool` + +HasReason returns a boolean if a field has been set. + +### GetNotes + +`func (o *Product) GetNotes() string` + +GetNotes returns the Notes field if non-nil, zero value otherwise. + +### GetNotesOk + +`func (o *Product) GetNotesOk() (*string, bool)` + +GetNotesOk returns a tuple with the Notes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotes + +`func (o *Product) SetNotes(v string)` + +SetNotes sets Notes field to given value. + +### HasNotes + +`func (o *Product) HasNotes() bool` + +HasNotes returns a boolean if a field has been set. + +### GetDateCreated + +`func (o *Product) GetDateCreated() SailPointTime` + +GetDateCreated returns the DateCreated field if non-nil, zero value otherwise. + +### GetDateCreatedOk + +`func (o *Product) GetDateCreatedOk() (*SailPointTime, bool)` + +GetDateCreatedOk returns a tuple with the DateCreated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDateCreated + +`func (o *Product) SetDateCreated(v SailPointTime)` + +SetDateCreated sets DateCreated field to given value. + +### HasDateCreated + +`func (o *Product) HasDateCreated() bool` + +HasDateCreated returns a boolean if a field has been set. + +### SetDateCreatedNil + +`func (o *Product) SetDateCreatedNil(b bool)` + + SetDateCreatedNil sets the value for DateCreated to be an explicit nil + +### UnsetDateCreated +`func (o *Product) UnsetDateCreated()` + +UnsetDateCreated ensures that no value is present for DateCreated, not even an explicit nil +### GetLastUpdated + +`func (o *Product) GetLastUpdated() SailPointTime` + +GetLastUpdated returns the LastUpdated field if non-nil, zero value otherwise. + +### GetLastUpdatedOk + +`func (o *Product) GetLastUpdatedOk() (*SailPointTime, bool)` + +GetLastUpdatedOk returns a tuple with the LastUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdated + +`func (o *Product) SetLastUpdated(v SailPointTime)` + +SetLastUpdated sets LastUpdated field to given value. + +### HasLastUpdated + +`func (o *Product) HasLastUpdated() bool` + +HasLastUpdated returns a boolean if a field has been set. + +### SetLastUpdatedNil + +`func (o *Product) SetLastUpdatedNil(b bool)` + + SetLastUpdatedNil sets the value for LastUpdated to be an explicit nil + +### UnsetLastUpdated +`func (o *Product) UnsetLastUpdated()` + +UnsetLastUpdated ensures that no value is present for LastUpdated, not even an explicit nil +### GetOrgType + +`func (o *Product) GetOrgType() string` + +GetOrgType returns the OrgType field if non-nil, zero value otherwise. + +### GetOrgTypeOk + +`func (o *Product) GetOrgTypeOk() (*string, bool)` + +GetOrgTypeOk returns a tuple with the OrgType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrgType + +`func (o *Product) SetOrgType(v string)` + +SetOrgType sets OrgType field to given value. + +### HasOrgType + +`func (o *Product) HasOrgType() bool` + +HasOrgType returns a boolean if a field has been set. + +### SetOrgTypeNil + +`func (o *Product) SetOrgTypeNil(b bool)` + + SetOrgTypeNil sets the value for OrgType to be an explicit nil + +### UnsetOrgType +`func (o *Product) UnsetOrgType()` + +UnsetOrgType ensures that no value is present for OrgType, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompleted.md b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompleted.md new file mode 100644 index 000000000..73d6faaec --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompleted.md @@ -0,0 +1,266 @@ +--- +id: v2025-provisioning-completed +title: ProvisioningCompleted +pagination_label: ProvisioningCompleted +sidebar_label: ProvisioningCompleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompleted', 'V2025ProvisioningCompleted'] +slug: /tools/sdk/go/v2025/models/provisioning-completed +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompleted', 'V2025ProvisioningCompleted'] +--- + +# ProvisioningCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TrackingNumber** | **string** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | +**Sources** | **string** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | +**Action** | Pointer to **NullableString** | Origin of where the provisioning request came from. | [optional] +**Errors** | Pointer to **[]string** | A list of any accumulated error messages that occurred during provisioning. | [optional] +**Warnings** | Pointer to **[]string** | A list of any accumulated warning messages that occurred during provisioning. | [optional] +**Recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | +**Requester** | Pointer to [**NullableProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional] +**AccountRequests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | + +## Methods + +### NewProvisioningCompleted + +`func NewProvisioningCompleted(trackingNumber string, sources string, recipient ProvisioningCompletedRecipient, accountRequests []ProvisioningCompletedAccountRequestsInner, ) *ProvisioningCompleted` + +NewProvisioningCompleted instantiates a new ProvisioningCompleted 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 + +### NewProvisioningCompletedWithDefaults + +`func NewProvisioningCompletedWithDefaults() *ProvisioningCompleted` + +NewProvisioningCompletedWithDefaults instantiates a new ProvisioningCompleted 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 + +### GetTrackingNumber + +`func (o *ProvisioningCompleted) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *ProvisioningCompleted) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *ProvisioningCompleted) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + + +### GetSources + +`func (o *ProvisioningCompleted) GetSources() string` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *ProvisioningCompleted) GetSourcesOk() (*string, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *ProvisioningCompleted) SetSources(v string)` + +SetSources sets Sources field to given value. + + +### GetAction + +`func (o *ProvisioningCompleted) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *ProvisioningCompleted) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *ProvisioningCompleted) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *ProvisioningCompleted) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### SetActionNil + +`func (o *ProvisioningCompleted) SetActionNil(b bool)` + + SetActionNil sets the value for Action to be an explicit nil + +### UnsetAction +`func (o *ProvisioningCompleted) UnsetAction()` + +UnsetAction ensures that no value is present for Action, not even an explicit nil +### GetErrors + +`func (o *ProvisioningCompleted) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *ProvisioningCompleted) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *ProvisioningCompleted) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *ProvisioningCompleted) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### SetErrorsNil + +`func (o *ProvisioningCompleted) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *ProvisioningCompleted) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *ProvisioningCompleted) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *ProvisioningCompleted) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *ProvisioningCompleted) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *ProvisioningCompleted) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + +### SetWarningsNil + +`func (o *ProvisioningCompleted) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *ProvisioningCompleted) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetRecipient + +`func (o *ProvisioningCompleted) GetRecipient() ProvisioningCompletedRecipient` + +GetRecipient returns the Recipient field if non-nil, zero value otherwise. + +### GetRecipientOk + +`func (o *ProvisioningCompleted) GetRecipientOk() (*ProvisioningCompletedRecipient, bool)` + +GetRecipientOk returns a tuple with the Recipient field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipient + +`func (o *ProvisioningCompleted) SetRecipient(v ProvisioningCompletedRecipient)` + +SetRecipient sets Recipient field to given value. + + +### GetRequester + +`func (o *ProvisioningCompleted) GetRequester() ProvisioningCompletedRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *ProvisioningCompleted) GetRequesterOk() (*ProvisioningCompletedRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *ProvisioningCompleted) SetRequester(v ProvisioningCompletedRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *ProvisioningCompleted) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### SetRequesterNil + +`func (o *ProvisioningCompleted) SetRequesterNil(b bool)` + + SetRequesterNil sets the value for Requester to be an explicit nil + +### UnsetRequester +`func (o *ProvisioningCompleted) UnsetRequester()` + +UnsetRequester ensures that no value is present for Requester, not even an explicit nil +### GetAccountRequests + +`func (o *ProvisioningCompleted) GetAccountRequests() []ProvisioningCompletedAccountRequestsInner` + +GetAccountRequests returns the AccountRequests field if non-nil, zero value otherwise. + +### GetAccountRequestsOk + +`func (o *ProvisioningCompleted) GetAccountRequestsOk() (*[]ProvisioningCompletedAccountRequestsInner, bool)` + +GetAccountRequestsOk returns a tuple with the AccountRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountRequests + +`func (o *ProvisioningCompleted) SetAccountRequests(v []ProvisioningCompletedAccountRequestsInner)` + +SetAccountRequests sets AccountRequests field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompletedAccountRequestsInner.md b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompletedAccountRequestsInner.md new file mode 100644 index 000000000..c8fd07cc4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompletedAccountRequestsInner.md @@ -0,0 +1,220 @@ +--- +id: v2025-provisioning-completed-account-requests-inner +title: ProvisioningCompletedAccountRequestsInner +pagination_label: ProvisioningCompletedAccountRequestsInner +sidebar_label: ProvisioningCompletedAccountRequestsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompletedAccountRequestsInner', 'V2025ProvisioningCompletedAccountRequestsInner'] +slug: /tools/sdk/go/v2025/models/provisioning-completed-account-requests-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInner', 'V2025ProvisioningCompletedAccountRequestsInner'] +--- + +# ProvisioningCompletedAccountRequestsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**ProvisioningCompletedAccountRequestsInnerSource**](provisioning-completed-account-requests-inner-source) | | +**AccountId** | Pointer to **string** | The unique idenfier of the account being provisioned. | [optional] +**AccountOperation** | **string** | The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. | +**ProvisioningResult** | **map[string]interface{}** | The overall result of the provisioning transaction; this could be success, pending, failed, etc. | +**ProvisioningTarget** | **string** | The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). | +**TicketId** | Pointer to **NullableString** | A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). | [optional] +**AttributeRequests** | Pointer to [**[]ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner**](provisioning-completed-account-requests-inner-attribute-requests-inner) | A list of attributes as part of the provisioning transaction. | [optional] + +## Methods + +### NewProvisioningCompletedAccountRequestsInner + +`func NewProvisioningCompletedAccountRequestsInner(source ProvisioningCompletedAccountRequestsInnerSource, accountOperation string, provisioningResult map[string]interface{}, provisioningTarget string, ) *ProvisioningCompletedAccountRequestsInner` + +NewProvisioningCompletedAccountRequestsInner instantiates a new ProvisioningCompletedAccountRequestsInner 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 + +### NewProvisioningCompletedAccountRequestsInnerWithDefaults + +`func NewProvisioningCompletedAccountRequestsInnerWithDefaults() *ProvisioningCompletedAccountRequestsInner` + +NewProvisioningCompletedAccountRequestsInnerWithDefaults instantiates a new ProvisioningCompletedAccountRequestsInner 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 + +### GetSource + +`func (o *ProvisioningCompletedAccountRequestsInner) GetSource() ProvisioningCompletedAccountRequestsInnerSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetSourceOk() (*ProvisioningCompletedAccountRequestsInnerSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *ProvisioningCompletedAccountRequestsInner) SetSource(v ProvisioningCompletedAccountRequestsInnerSource)` + +SetSource sets Source field to given value. + + +### GetAccountId + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *ProvisioningCompletedAccountRequestsInner) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *ProvisioningCompletedAccountRequestsInner) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetAccountOperation + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAccountOperation() string` + +GetAccountOperation returns the AccountOperation field if non-nil, zero value otherwise. + +### GetAccountOperationOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAccountOperationOk() (*string, bool)` + +GetAccountOperationOk returns a tuple with the AccountOperation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountOperation + +`func (o *ProvisioningCompletedAccountRequestsInner) SetAccountOperation(v string)` + +SetAccountOperation sets AccountOperation field to given value. + + +### GetProvisioningResult + +`func (o *ProvisioningCompletedAccountRequestsInner) GetProvisioningResult() map[string]interface{}` + +GetProvisioningResult returns the ProvisioningResult field if non-nil, zero value otherwise. + +### GetProvisioningResultOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetProvisioningResultOk() (*map[string]interface{}, bool)` + +GetProvisioningResultOk returns a tuple with the ProvisioningResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningResult + +`func (o *ProvisioningCompletedAccountRequestsInner) SetProvisioningResult(v map[string]interface{})` + +SetProvisioningResult sets ProvisioningResult field to given value. + + +### GetProvisioningTarget + +`func (o *ProvisioningCompletedAccountRequestsInner) GetProvisioningTarget() string` + +GetProvisioningTarget returns the ProvisioningTarget field if non-nil, zero value otherwise. + +### GetProvisioningTargetOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetProvisioningTargetOk() (*string, bool)` + +GetProvisioningTargetOk returns a tuple with the ProvisioningTarget field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningTarget + +`func (o *ProvisioningCompletedAccountRequestsInner) SetProvisioningTarget(v string)` + +SetProvisioningTarget sets ProvisioningTarget field to given value. + + +### GetTicketId + +`func (o *ProvisioningCompletedAccountRequestsInner) GetTicketId() string` + +GetTicketId returns the TicketId field if non-nil, zero value otherwise. + +### GetTicketIdOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetTicketIdOk() (*string, bool)` + +GetTicketIdOk returns a tuple with the TicketId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTicketId + +`func (o *ProvisioningCompletedAccountRequestsInner) SetTicketId(v string)` + +SetTicketId sets TicketId field to given value. + +### HasTicketId + +`func (o *ProvisioningCompletedAccountRequestsInner) HasTicketId() bool` + +HasTicketId returns a boolean if a field has been set. + +### SetTicketIdNil + +`func (o *ProvisioningCompletedAccountRequestsInner) SetTicketIdNil(b bool)` + + SetTicketIdNil sets the value for TicketId to be an explicit nil + +### UnsetTicketId +`func (o *ProvisioningCompletedAccountRequestsInner) UnsetTicketId()` + +UnsetTicketId ensures that no value is present for TicketId, not even an explicit nil +### GetAttributeRequests + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAttributeRequests() []ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner` + +GetAttributeRequests returns the AttributeRequests field if non-nil, zero value otherwise. + +### GetAttributeRequestsOk + +`func (o *ProvisioningCompletedAccountRequestsInner) GetAttributeRequestsOk() (*[]ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner, bool)` + +GetAttributeRequestsOk returns a tuple with the AttributeRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeRequests + +`func (o *ProvisioningCompletedAccountRequestsInner) SetAttributeRequests(v []ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner)` + +SetAttributeRequests sets AttributeRequests field to given value. + +### HasAttributeRequests + +`func (o *ProvisioningCompletedAccountRequestsInner) HasAttributeRequests() bool` + +HasAttributeRequests returns a boolean if a field has been set. + +### SetAttributeRequestsNil + +`func (o *ProvisioningCompletedAccountRequestsInner) SetAttributeRequestsNil(b bool)` + + SetAttributeRequestsNil sets the value for AttributeRequests to be an explicit nil + +### UnsetAttributeRequests +`func (o *ProvisioningCompletedAccountRequestsInner) UnsetAttributeRequests()` + +UnsetAttributeRequests ensures that no value is present for AttributeRequests, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md new file mode 100644 index 000000000..ae6569061 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md @@ -0,0 +1,116 @@ +--- +id: v2025-provisioning-completed-account-requests-inner-attribute-requests-inner +title: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +pagination_label: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +sidebar_label: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner', 'V2025ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner'] +slug: /tools/sdk/go/v2025/models/provisioning-completed-account-requests-inner-attribute-requests-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner', 'V2025ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner'] +--- + +# ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeName** | **string** | The name of the attribute being provisioned. | +**AttributeValue** | Pointer to **NullableString** | The value of the attribute being provisioned. | [optional] +**Operation** | **map[string]interface{}** | The operation to handle the attribute. | + +## Methods + +### NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInner + +`func NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInner(attributeName string, operation map[string]interface{}, ) *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner` + +NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInner instantiates a new ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner 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 + +### NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerWithDefaults + +`func NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerWithDefaults() *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner` + +NewProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerWithDefaults instantiates a new ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner 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 + +### GetAttributeName + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + + +### GetAttributeValue + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetAttributeValue() string` + +GetAttributeValue returns the AttributeValue field if non-nil, zero value otherwise. + +### GetAttributeValueOk + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetAttributeValueOk() (*string, bool)` + +GetAttributeValueOk returns a tuple with the AttributeValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeValue + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) SetAttributeValue(v string)` + +SetAttributeValue sets AttributeValue field to given value. + +### HasAttributeValue + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) HasAttributeValue() bool` + +HasAttributeValue returns a boolean if a field has been set. + +### SetAttributeValueNil + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) SetAttributeValueNil(b bool)` + + SetAttributeValueNil sets the value for AttributeValue to be an explicit nil + +### UnsetAttributeValue +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) UnsetAttributeValue()` + +UnsetAttributeValue ensures that no value is present for AttributeValue, not even an explicit nil +### GetOperation + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetOperation() map[string]interface{}` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) GetOperationOk() (*map[string]interface{}, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner) SetOperation(v map[string]interface{})` + +SetOperation sets Operation field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompletedAccountRequestsInnerSource.md b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompletedAccountRequestsInnerSource.md new file mode 100644 index 000000000..00c35aac7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompletedAccountRequestsInnerSource.md @@ -0,0 +1,101 @@ +--- +id: v2025-provisioning-completed-account-requests-inner-source +title: ProvisioningCompletedAccountRequestsInnerSource +pagination_label: ProvisioningCompletedAccountRequestsInnerSource +sidebar_label: ProvisioningCompletedAccountRequestsInnerSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompletedAccountRequestsInnerSource', 'V2025ProvisioningCompletedAccountRequestsInnerSource'] +slug: /tools/sdk/go/v2025/models/provisioning-completed-account-requests-inner-source +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInnerSource', 'V2025ProvisioningCompletedAccountRequestsInnerSource'] +--- + +# ProvisioningCompletedAccountRequestsInnerSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the object to which this reference applies | +**Type** | **string** | The type of object that is referenced | +**Name** | **string** | Human-readable display name of the object to which this reference applies | + +## Methods + +### NewProvisioningCompletedAccountRequestsInnerSource + +`func NewProvisioningCompletedAccountRequestsInnerSource(id string, type_ string, name string, ) *ProvisioningCompletedAccountRequestsInnerSource` + +NewProvisioningCompletedAccountRequestsInnerSource instantiates a new ProvisioningCompletedAccountRequestsInnerSource 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 + +### NewProvisioningCompletedAccountRequestsInnerSourceWithDefaults + +`func NewProvisioningCompletedAccountRequestsInnerSourceWithDefaults() *ProvisioningCompletedAccountRequestsInnerSource` + +NewProvisioningCompletedAccountRequestsInnerSourceWithDefaults instantiates a new ProvisioningCompletedAccountRequestsInnerSource 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 + +### GetId + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) SetType(v string)` + +SetType sets Type field to given value. + + +### GetName + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningCompletedAccountRequestsInnerSource) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompletedRecipient.md b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompletedRecipient.md new file mode 100644 index 000000000..9cb2ee29e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompletedRecipient.md @@ -0,0 +1,101 @@ +--- +id: v2025-provisioning-completed-recipient +title: ProvisioningCompletedRecipient +pagination_label: ProvisioningCompletedRecipient +sidebar_label: ProvisioningCompletedRecipient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompletedRecipient', 'V2025ProvisioningCompletedRecipient'] +slug: /tools/sdk/go/v2025/models/provisioning-completed-recipient +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedRecipient', 'V2025ProvisioningCompletedRecipient'] +--- + +# ProvisioningCompletedRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Provisioning recipient DTO type. | +**Id** | **string** | Provisioning recipient's identity ID. | +**Name** | **string** | Provisioning recipient's display name. | + +## Methods + +### NewProvisioningCompletedRecipient + +`func NewProvisioningCompletedRecipient(type_ string, id string, name string, ) *ProvisioningCompletedRecipient` + +NewProvisioningCompletedRecipient instantiates a new ProvisioningCompletedRecipient 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 + +### NewProvisioningCompletedRecipientWithDefaults + +`func NewProvisioningCompletedRecipientWithDefaults() *ProvisioningCompletedRecipient` + +NewProvisioningCompletedRecipientWithDefaults instantiates a new ProvisioningCompletedRecipient 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 + +### GetType + +`func (o *ProvisioningCompletedRecipient) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ProvisioningCompletedRecipient) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ProvisioningCompletedRecipient) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *ProvisioningCompletedRecipient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ProvisioningCompletedRecipient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ProvisioningCompletedRecipient) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *ProvisioningCompletedRecipient) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningCompletedRecipient) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningCompletedRecipient) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompletedRequester.md b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompletedRequester.md new file mode 100644 index 000000000..a14016e48 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCompletedRequester.md @@ -0,0 +1,101 @@ +--- +id: v2025-provisioning-completed-requester +title: ProvisioningCompletedRequester +pagination_label: ProvisioningCompletedRequester +sidebar_label: ProvisioningCompletedRequester +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCompletedRequester', 'V2025ProvisioningCompletedRequester'] +slug: /tools/sdk/go/v2025/models/provisioning-completed-requester +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedRequester', 'V2025ProvisioningCompletedRequester'] +--- + +# ProvisioningCompletedRequester + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Provisioning requester's DTO type. | +**Id** | **string** | Provisioning requester's identity ID. | +**Name** | **string** | Provisioning owner's human-readable display name. | + +## Methods + +### NewProvisioningCompletedRequester + +`func NewProvisioningCompletedRequester(type_ string, id string, name string, ) *ProvisioningCompletedRequester` + +NewProvisioningCompletedRequester instantiates a new ProvisioningCompletedRequester 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 + +### NewProvisioningCompletedRequesterWithDefaults + +`func NewProvisioningCompletedRequesterWithDefaults() *ProvisioningCompletedRequester` + +NewProvisioningCompletedRequesterWithDefaults instantiates a new ProvisioningCompletedRequester 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 + +### GetType + +`func (o *ProvisioningCompletedRequester) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ProvisioningCompletedRequester) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ProvisioningCompletedRequester) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *ProvisioningCompletedRequester) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ProvisioningCompletedRequester) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ProvisioningCompletedRequester) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *ProvisioningCompletedRequester) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningCompletedRequester) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningCompletedRequester) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningConfig.md new file mode 100644 index 000000000..18c7d7573 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningConfig.md @@ -0,0 +1,178 @@ +--- +id: v2025-provisioning-config +title: ProvisioningConfig +pagination_label: ProvisioningConfig +sidebar_label: ProvisioningConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningConfig', 'V2025ProvisioningConfig'] +slug: /tools/sdk/go/v2025/models/provisioning-config +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig', 'V2025ProvisioningConfig'] +--- + +# ProvisioningConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UniversalManager** | Pointer to **bool** | Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. | [optional] [readonly] [default to false] +**ManagedResourceRefs** | Pointer to [**[]ServiceDeskSource**](service-desk-source) | References to sources for the Service Desk integration template. May only be specified if universalManager is false. | [optional] +**PlanInitializerScript** | Pointer to [**NullableProvisioningConfigPlanInitializerScript**](provisioning-config-plan-initializer-script) | | [optional] +**NoProvisioningRequests** | Pointer to **bool** | Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. | [optional] [default to false] +**ProvisioningRequestExpiration** | Pointer to **int32** | When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. | [optional] + +## Methods + +### NewProvisioningConfig + +`func NewProvisioningConfig() *ProvisioningConfig` + +NewProvisioningConfig instantiates a new ProvisioningConfig 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 + +### NewProvisioningConfigWithDefaults + +`func NewProvisioningConfigWithDefaults() *ProvisioningConfig` + +NewProvisioningConfigWithDefaults instantiates a new ProvisioningConfig 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 + +### GetUniversalManager + +`func (o *ProvisioningConfig) GetUniversalManager() bool` + +GetUniversalManager returns the UniversalManager field if non-nil, zero value otherwise. + +### GetUniversalManagerOk + +`func (o *ProvisioningConfig) GetUniversalManagerOk() (*bool, bool)` + +GetUniversalManagerOk returns a tuple with the UniversalManager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUniversalManager + +`func (o *ProvisioningConfig) SetUniversalManager(v bool)` + +SetUniversalManager sets UniversalManager field to given value. + +### HasUniversalManager + +`func (o *ProvisioningConfig) HasUniversalManager() bool` + +HasUniversalManager returns a boolean if a field has been set. + +### GetManagedResourceRefs + +`func (o *ProvisioningConfig) GetManagedResourceRefs() []ServiceDeskSource` + +GetManagedResourceRefs returns the ManagedResourceRefs field if non-nil, zero value otherwise. + +### GetManagedResourceRefsOk + +`func (o *ProvisioningConfig) GetManagedResourceRefsOk() (*[]ServiceDeskSource, bool)` + +GetManagedResourceRefsOk returns a tuple with the ManagedResourceRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagedResourceRefs + +`func (o *ProvisioningConfig) SetManagedResourceRefs(v []ServiceDeskSource)` + +SetManagedResourceRefs sets ManagedResourceRefs field to given value. + +### HasManagedResourceRefs + +`func (o *ProvisioningConfig) HasManagedResourceRefs() bool` + +HasManagedResourceRefs returns a boolean if a field has been set. + +### GetPlanInitializerScript + +`func (o *ProvisioningConfig) GetPlanInitializerScript() ProvisioningConfigPlanInitializerScript` + +GetPlanInitializerScript returns the PlanInitializerScript field if non-nil, zero value otherwise. + +### GetPlanInitializerScriptOk + +`func (o *ProvisioningConfig) GetPlanInitializerScriptOk() (*ProvisioningConfigPlanInitializerScript, bool)` + +GetPlanInitializerScriptOk returns a tuple with the PlanInitializerScript field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPlanInitializerScript + +`func (o *ProvisioningConfig) SetPlanInitializerScript(v ProvisioningConfigPlanInitializerScript)` + +SetPlanInitializerScript sets PlanInitializerScript field to given value. + +### HasPlanInitializerScript + +`func (o *ProvisioningConfig) HasPlanInitializerScript() bool` + +HasPlanInitializerScript returns a boolean if a field has been set. + +### SetPlanInitializerScriptNil + +`func (o *ProvisioningConfig) SetPlanInitializerScriptNil(b bool)` + + SetPlanInitializerScriptNil sets the value for PlanInitializerScript to be an explicit nil + +### UnsetPlanInitializerScript +`func (o *ProvisioningConfig) UnsetPlanInitializerScript()` + +UnsetPlanInitializerScript ensures that no value is present for PlanInitializerScript, not even an explicit nil +### GetNoProvisioningRequests + +`func (o *ProvisioningConfig) GetNoProvisioningRequests() bool` + +GetNoProvisioningRequests returns the NoProvisioningRequests field if non-nil, zero value otherwise. + +### GetNoProvisioningRequestsOk + +`func (o *ProvisioningConfig) GetNoProvisioningRequestsOk() (*bool, bool)` + +GetNoProvisioningRequestsOk returns a tuple with the NoProvisioningRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNoProvisioningRequests + +`func (o *ProvisioningConfig) SetNoProvisioningRequests(v bool)` + +SetNoProvisioningRequests sets NoProvisioningRequests field to given value. + +### HasNoProvisioningRequests + +`func (o *ProvisioningConfig) HasNoProvisioningRequests() bool` + +HasNoProvisioningRequests returns a boolean if a field has been set. + +### GetProvisioningRequestExpiration + +`func (o *ProvisioningConfig) GetProvisioningRequestExpiration() int32` + +GetProvisioningRequestExpiration returns the ProvisioningRequestExpiration field if non-nil, zero value otherwise. + +### GetProvisioningRequestExpirationOk + +`func (o *ProvisioningConfig) GetProvisioningRequestExpirationOk() (*int32, bool)` + +GetProvisioningRequestExpirationOk returns a tuple with the ProvisioningRequestExpiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningRequestExpiration + +`func (o *ProvisioningConfig) SetProvisioningRequestExpiration(v int32)` + +SetProvisioningRequestExpiration sets ProvisioningRequestExpiration field to given value. + +### HasProvisioningRequestExpiration + +`func (o *ProvisioningConfig) HasProvisioningRequestExpiration() bool` + +HasProvisioningRequestExpiration returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningConfigPlanInitializerScript.md b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningConfigPlanInitializerScript.md new file mode 100644 index 000000000..b1589a7f3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningConfigPlanInitializerScript.md @@ -0,0 +1,64 @@ +--- +id: v2025-provisioning-config-plan-initializer-script +title: ProvisioningConfigPlanInitializerScript +pagination_label: ProvisioningConfigPlanInitializerScript +sidebar_label: ProvisioningConfigPlanInitializerScript +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningConfigPlanInitializerScript', 'V2025ProvisioningConfigPlanInitializerScript'] +slug: /tools/sdk/go/v2025/models/provisioning-config-plan-initializer-script +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfigPlanInitializerScript', 'V2025ProvisioningConfigPlanInitializerScript'] +--- + +# ProvisioningConfigPlanInitializerScript + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | Pointer to **string** | This is a Rule that allows provisioning instruction changes. | [optional] + +## Methods + +### NewProvisioningConfigPlanInitializerScript + +`func NewProvisioningConfigPlanInitializerScript() *ProvisioningConfigPlanInitializerScript` + +NewProvisioningConfigPlanInitializerScript instantiates a new ProvisioningConfigPlanInitializerScript 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 + +### NewProvisioningConfigPlanInitializerScriptWithDefaults + +`func NewProvisioningConfigPlanInitializerScriptWithDefaults() *ProvisioningConfigPlanInitializerScript` + +NewProvisioningConfigPlanInitializerScriptWithDefaults instantiates a new ProvisioningConfigPlanInitializerScript 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 + +### GetSource + +`func (o *ProvisioningConfigPlanInitializerScript) GetSource() string` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *ProvisioningConfigPlanInitializerScript) GetSourceOk() (*string, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *ProvisioningConfigPlanInitializerScript) SetSource(v string)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *ProvisioningConfigPlanInitializerScript) HasSource() bool` + +HasSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCriteriaLevel1.md new file mode 100644 index 000000000..1745e415f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCriteriaLevel1.md @@ -0,0 +1,172 @@ +--- +id: v2025-provisioning-criteria-level1 +title: ProvisioningCriteriaLevel1 +pagination_label: ProvisioningCriteriaLevel1 +sidebar_label: ProvisioningCriteriaLevel1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCriteriaLevel1', 'V2025ProvisioningCriteriaLevel1'] +slug: /tools/sdk/go/v2025/models/provisioning-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'V2025ProvisioningCriteriaLevel1'] +--- + +# ProvisioningCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **NullableString** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | Pointer to **NullableString** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | Pointer to [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Methods + +### NewProvisioningCriteriaLevel1 + +`func NewProvisioningCriteriaLevel1() *ProvisioningCriteriaLevel1` + +NewProvisioningCriteriaLevel1 instantiates a new ProvisioningCriteriaLevel1 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 + +### NewProvisioningCriteriaLevel1WithDefaults + +`func NewProvisioningCriteriaLevel1WithDefaults() *ProvisioningCriteriaLevel1` + +NewProvisioningCriteriaLevel1WithDefaults instantiates a new ProvisioningCriteriaLevel1 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 + +### GetOperation + +`func (o *ProvisioningCriteriaLevel1) GetOperation() ProvisioningCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ProvisioningCriteriaLevel1) GetOperationOk() (*ProvisioningCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ProvisioningCriteriaLevel1) SetOperation(v ProvisioningCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ProvisioningCriteriaLevel1) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ProvisioningCriteriaLevel1) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ProvisioningCriteriaLevel1) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ProvisioningCriteriaLevel1) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ProvisioningCriteriaLevel1) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *ProvisioningCriteriaLevel1) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *ProvisioningCriteriaLevel1) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *ProvisioningCriteriaLevel1) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ProvisioningCriteriaLevel1) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ProvisioningCriteriaLevel1) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ProvisioningCriteriaLevel1) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ProvisioningCriteriaLevel1) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ProvisioningCriteriaLevel1) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *ProvisioningCriteriaLevel1) GetChildren() []ProvisioningCriteriaLevel2` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *ProvisioningCriteriaLevel1) GetChildrenOk() (*[]ProvisioningCriteriaLevel2, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *ProvisioningCriteriaLevel1) SetChildren(v []ProvisioningCriteriaLevel2)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *ProvisioningCriteriaLevel1) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *ProvisioningCriteriaLevel1) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *ProvisioningCriteriaLevel1) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCriteriaLevel2.md new file mode 100644 index 000000000..ae22ce409 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCriteriaLevel2.md @@ -0,0 +1,172 @@ +--- +id: v2025-provisioning-criteria-level2 +title: ProvisioningCriteriaLevel2 +pagination_label: ProvisioningCriteriaLevel2 +sidebar_label: ProvisioningCriteriaLevel2 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCriteriaLevel2', 'V2025ProvisioningCriteriaLevel2'] +slug: /tools/sdk/go/v2025/models/provisioning-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'V2025ProvisioningCriteriaLevel2'] +--- + +# ProvisioningCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **NullableString** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | Pointer to **NullableString** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | Pointer to [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Methods + +### NewProvisioningCriteriaLevel2 + +`func NewProvisioningCriteriaLevel2() *ProvisioningCriteriaLevel2` + +NewProvisioningCriteriaLevel2 instantiates a new ProvisioningCriteriaLevel2 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 + +### NewProvisioningCriteriaLevel2WithDefaults + +`func NewProvisioningCriteriaLevel2WithDefaults() *ProvisioningCriteriaLevel2` + +NewProvisioningCriteriaLevel2WithDefaults instantiates a new ProvisioningCriteriaLevel2 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 + +### GetOperation + +`func (o *ProvisioningCriteriaLevel2) GetOperation() ProvisioningCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ProvisioningCriteriaLevel2) GetOperationOk() (*ProvisioningCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ProvisioningCriteriaLevel2) SetOperation(v ProvisioningCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ProvisioningCriteriaLevel2) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ProvisioningCriteriaLevel2) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ProvisioningCriteriaLevel2) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ProvisioningCriteriaLevel2) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ProvisioningCriteriaLevel2) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *ProvisioningCriteriaLevel2) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *ProvisioningCriteriaLevel2) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *ProvisioningCriteriaLevel2) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ProvisioningCriteriaLevel2) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ProvisioningCriteriaLevel2) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ProvisioningCriteriaLevel2) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ProvisioningCriteriaLevel2) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ProvisioningCriteriaLevel2) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *ProvisioningCriteriaLevel2) GetChildren() []ProvisioningCriteriaLevel3` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *ProvisioningCriteriaLevel2) GetChildrenOk() (*[]ProvisioningCriteriaLevel3, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *ProvisioningCriteriaLevel2) SetChildren(v []ProvisioningCriteriaLevel3)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *ProvisioningCriteriaLevel2) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *ProvisioningCriteriaLevel2) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *ProvisioningCriteriaLevel2) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCriteriaLevel3.md new file mode 100644 index 000000000..a493cb654 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCriteriaLevel3.md @@ -0,0 +1,172 @@ +--- +id: v2025-provisioning-criteria-level3 +title: ProvisioningCriteriaLevel3 +pagination_label: ProvisioningCriteriaLevel3 +sidebar_label: ProvisioningCriteriaLevel3 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCriteriaLevel3', 'V2025ProvisioningCriteriaLevel3'] +slug: /tools/sdk/go/v2025/models/provisioning-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'V2025ProvisioningCriteriaLevel3'] +--- + +# ProvisioningCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **NullableString** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | Pointer to **NullableString** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | Pointer to **NullableString** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Methods + +### NewProvisioningCriteriaLevel3 + +`func NewProvisioningCriteriaLevel3() *ProvisioningCriteriaLevel3` + +NewProvisioningCriteriaLevel3 instantiates a new ProvisioningCriteriaLevel3 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 + +### NewProvisioningCriteriaLevel3WithDefaults + +`func NewProvisioningCriteriaLevel3WithDefaults() *ProvisioningCriteriaLevel3` + +NewProvisioningCriteriaLevel3WithDefaults instantiates a new ProvisioningCriteriaLevel3 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 + +### GetOperation + +`func (o *ProvisioningCriteriaLevel3) GetOperation() ProvisioningCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ProvisioningCriteriaLevel3) GetOperationOk() (*ProvisioningCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ProvisioningCriteriaLevel3) SetOperation(v ProvisioningCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ProvisioningCriteriaLevel3) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ProvisioningCriteriaLevel3) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ProvisioningCriteriaLevel3) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ProvisioningCriteriaLevel3) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ProvisioningCriteriaLevel3) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *ProvisioningCriteriaLevel3) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *ProvisioningCriteriaLevel3) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *ProvisioningCriteriaLevel3) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ProvisioningCriteriaLevel3) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ProvisioningCriteriaLevel3) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ProvisioningCriteriaLevel3) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ProvisioningCriteriaLevel3) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ProvisioningCriteriaLevel3) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *ProvisioningCriteriaLevel3) GetChildren() string` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *ProvisioningCriteriaLevel3) GetChildrenOk() (*string, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *ProvisioningCriteriaLevel3) SetChildren(v string)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *ProvisioningCriteriaLevel3) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *ProvisioningCriteriaLevel3) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *ProvisioningCriteriaLevel3) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCriteriaOperation.md new file mode 100644 index 000000000..1f664207d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningCriteriaOperation.md @@ -0,0 +1,29 @@ +--- +id: v2025-provisioning-criteria-operation +title: ProvisioningCriteriaOperation +pagination_label: ProvisioningCriteriaOperation +sidebar_label: ProvisioningCriteriaOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCriteriaOperation', 'V2025ProvisioningCriteriaOperation'] +slug: /tools/sdk/go/v2025/models/provisioning-criteria-operation +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'V2025ProvisioningCriteriaOperation'] +--- + +# ProvisioningCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `HAS` (value: `"HAS"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningDetails.md new file mode 100644 index 000000000..940ac6289 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningDetails.md @@ -0,0 +1,64 @@ +--- +id: v2025-provisioning-details +title: ProvisioningDetails +pagination_label: ProvisioningDetails +sidebar_label: ProvisioningDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningDetails', 'V2025ProvisioningDetails'] +slug: /tools/sdk/go/v2025/models/provisioning-details +tags: ['SDK', 'Software Development Kit', 'ProvisioningDetails', 'V2025ProvisioningDetails'] +--- + +# ProvisioningDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrderedSubPhaseReferences** | Pointer to **string** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. | [optional] + +## Methods + +### NewProvisioningDetails + +`func NewProvisioningDetails() *ProvisioningDetails` + +NewProvisioningDetails instantiates a new ProvisioningDetails 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 + +### NewProvisioningDetailsWithDefaults + +`func NewProvisioningDetailsWithDefaults() *ProvisioningDetails` + +NewProvisioningDetailsWithDefaults instantiates a new ProvisioningDetails 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 + +### GetOrderedSubPhaseReferences + +`func (o *ProvisioningDetails) GetOrderedSubPhaseReferences() string` + +GetOrderedSubPhaseReferences returns the OrderedSubPhaseReferences field if non-nil, zero value otherwise. + +### GetOrderedSubPhaseReferencesOk + +`func (o *ProvisioningDetails) GetOrderedSubPhaseReferencesOk() (*string, bool)` + +GetOrderedSubPhaseReferencesOk returns a tuple with the OrderedSubPhaseReferences field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderedSubPhaseReferences + +`func (o *ProvisioningDetails) SetOrderedSubPhaseReferences(v string)` + +SetOrderedSubPhaseReferences sets OrderedSubPhaseReferences field to given value. + +### HasOrderedSubPhaseReferences + +`func (o *ProvisioningDetails) HasOrderedSubPhaseReferences() bool` + +HasOrderedSubPhaseReferences returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningPolicy.md b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningPolicy.md new file mode 100644 index 000000000..456f186e7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningPolicy.md @@ -0,0 +1,147 @@ +--- +id: v2025-provisioning-policy +title: ProvisioningPolicy +pagination_label: ProvisioningPolicy +sidebar_label: ProvisioningPolicy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningPolicy', 'V2025ProvisioningPolicy'] +slug: /tools/sdk/go/v2025/models/provisioning-policy +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicy', 'V2025ProvisioningPolicy'] +--- + +# ProvisioningPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **NullableString** | the provisioning policy name | +**Description** | Pointer to **string** | the description of the provisioning policy | [optional] +**UsageType** | Pointer to [**UsageType**](usage-type) | | [optional] +**Fields** | Pointer to [**[]FieldDetailsDto**](field-details-dto) | | [optional] + +## Methods + +### NewProvisioningPolicy + +`func NewProvisioningPolicy(name NullableString, ) *ProvisioningPolicy` + +NewProvisioningPolicy instantiates a new ProvisioningPolicy 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 + +### NewProvisioningPolicyWithDefaults + +`func NewProvisioningPolicyWithDefaults() *ProvisioningPolicy` + +NewProvisioningPolicyWithDefaults instantiates a new ProvisioningPolicy 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 + +### GetName + +`func (o *ProvisioningPolicy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningPolicy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningPolicy) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *ProvisioningPolicy) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ProvisioningPolicy) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *ProvisioningPolicy) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ProvisioningPolicy) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ProvisioningPolicy) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ProvisioningPolicy) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetUsageType + +`func (o *ProvisioningPolicy) GetUsageType() UsageType` + +GetUsageType returns the UsageType field if non-nil, zero value otherwise. + +### GetUsageTypeOk + +`func (o *ProvisioningPolicy) GetUsageTypeOk() (*UsageType, bool)` + +GetUsageTypeOk returns a tuple with the UsageType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsageType + +`func (o *ProvisioningPolicy) SetUsageType(v UsageType)` + +SetUsageType sets UsageType field to given value. + +### HasUsageType + +`func (o *ProvisioningPolicy) HasUsageType() bool` + +HasUsageType returns a boolean if a field has been set. + +### GetFields + +`func (o *ProvisioningPolicy) GetFields() []FieldDetailsDto` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *ProvisioningPolicy) GetFieldsOk() (*[]FieldDetailsDto, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *ProvisioningPolicy) SetFields(v []FieldDetailsDto)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *ProvisioningPolicy) HasFields() bool` + +HasFields returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningPolicyDto.md b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningPolicyDto.md new file mode 100644 index 000000000..445884b25 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningPolicyDto.md @@ -0,0 +1,147 @@ +--- +id: v2025-provisioning-policy-dto +title: ProvisioningPolicyDto +pagination_label: ProvisioningPolicyDto +sidebar_label: ProvisioningPolicyDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningPolicyDto', 'V2025ProvisioningPolicyDto'] +slug: /tools/sdk/go/v2025/models/provisioning-policy-dto +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicyDto', 'V2025ProvisioningPolicyDto'] +--- + +# ProvisioningPolicyDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **NullableString** | the provisioning policy name | +**Description** | Pointer to **string** | the description of the provisioning policy | [optional] +**UsageType** | Pointer to [**UsageType**](usage-type) | | [optional] +**Fields** | Pointer to [**[]FieldDetailsDto**](field-details-dto) | | [optional] + +## Methods + +### NewProvisioningPolicyDto + +`func NewProvisioningPolicyDto(name NullableString, ) *ProvisioningPolicyDto` + +NewProvisioningPolicyDto instantiates a new ProvisioningPolicyDto 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 + +### NewProvisioningPolicyDtoWithDefaults + +`func NewProvisioningPolicyDtoWithDefaults() *ProvisioningPolicyDto` + +NewProvisioningPolicyDtoWithDefaults instantiates a new ProvisioningPolicyDto 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 + +### GetName + +`func (o *ProvisioningPolicyDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningPolicyDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningPolicyDto) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *ProvisioningPolicyDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ProvisioningPolicyDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *ProvisioningPolicyDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ProvisioningPolicyDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ProvisioningPolicyDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ProvisioningPolicyDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetUsageType + +`func (o *ProvisioningPolicyDto) GetUsageType() UsageType` + +GetUsageType returns the UsageType field if non-nil, zero value otherwise. + +### GetUsageTypeOk + +`func (o *ProvisioningPolicyDto) GetUsageTypeOk() (*UsageType, bool)` + +GetUsageTypeOk returns a tuple with the UsageType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsageType + +`func (o *ProvisioningPolicyDto) SetUsageType(v UsageType)` + +SetUsageType sets UsageType field to given value. + +### HasUsageType + +`func (o *ProvisioningPolicyDto) HasUsageType() bool` + +HasUsageType returns a boolean if a field has been set. + +### GetFields + +`func (o *ProvisioningPolicyDto) GetFields() []FieldDetailsDto` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *ProvisioningPolicyDto) GetFieldsOk() (*[]FieldDetailsDto, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *ProvisioningPolicyDto) SetFields(v []FieldDetailsDto)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *ProvisioningPolicyDto) HasFields() bool` + +HasFields returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningState.md b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningState.md new file mode 100644 index 000000000..bb5c8cd66 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ProvisioningState.md @@ -0,0 +1,29 @@ +--- +id: v2025-provisioning-state +title: ProvisioningState +pagination_label: ProvisioningState +sidebar_label: ProvisioningState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningState', 'V2025ProvisioningState'] +slug: /tools/sdk/go/v2025/models/provisioning-state +tags: ['SDK', 'Software Development Kit', 'ProvisioningState', 'V2025ProvisioningState'] +--- + +# ProvisioningState + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `FINISHED` (value: `"FINISHED"`) + +* `UNVERIFIABLE` (value: `"UNVERIFIABLE"`) + +* `COMMITED` (value: `"COMMITED"`) + +* `FAILED` (value: `"FAILED"`) + +* `RETRY` (value: `"RETRY"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PublicIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/PublicIdentity.md new file mode 100644 index 000000000..2d3b79cc5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PublicIdentity.md @@ -0,0 +1,286 @@ +--- +id: v2025-public-identity +title: PublicIdentity +pagination_label: PublicIdentity +sidebar_label: PublicIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentity', 'V2025PublicIdentity'] +slug: /tools/sdk/go/v2025/models/public-identity +tags: ['SDK', 'Software Development Kit', 'PublicIdentity', 'V2025PublicIdentity'] +--- + +# PublicIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Identity id | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity. | [optional] +**Alias** | Pointer to **string** | Alternate unique identifier for the identity. | [optional] +**Email** | Pointer to **NullableString** | Email address of identity. | [optional] +**Status** | Pointer to **NullableString** | The lifecycle status for the identity | [optional] +**IdentityState** | Pointer to **NullableString** | The current state of the identity, which determines how Identity Security Cloud interacts with the identity. An identity that is Active will be included identity picklists in Request Center, identity processing, and more. Identities that are Inactive will be excluded from these features. | [optional] +**Manager** | Pointer to [**NullableIdentityReference**](identity-reference) | | [optional] +**Attributes** | Pointer to [**[]PublicIdentityAttributesInner**](public-identity-attributes-inner) | The public identity attributes of the identity | [optional] + +## Methods + +### NewPublicIdentity + +`func NewPublicIdentity() *PublicIdentity` + +NewPublicIdentity instantiates a new PublicIdentity 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 + +### NewPublicIdentityWithDefaults + +`func NewPublicIdentityWithDefaults() *PublicIdentity` + +NewPublicIdentityWithDefaults instantiates a new PublicIdentity 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 + +### GetId + +`func (o *PublicIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PublicIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PublicIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PublicIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *PublicIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PublicIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PublicIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PublicIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAlias + +`func (o *PublicIdentity) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *PublicIdentity) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *PublicIdentity) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *PublicIdentity) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + +### GetEmail + +`func (o *PublicIdentity) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *PublicIdentity) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *PublicIdentity) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *PublicIdentity) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### SetEmailNil + +`func (o *PublicIdentity) SetEmailNil(b bool)` + + SetEmailNil sets the value for Email to be an explicit nil + +### UnsetEmail +`func (o *PublicIdentity) UnsetEmail()` + +UnsetEmail ensures that no value is present for Email, not even an explicit nil +### GetStatus + +`func (o *PublicIdentity) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *PublicIdentity) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *PublicIdentity) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *PublicIdentity) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatusNil + +`func (o *PublicIdentity) SetStatusNil(b bool)` + + SetStatusNil sets the value for Status to be an explicit nil + +### UnsetStatus +`func (o *PublicIdentity) UnsetStatus()` + +UnsetStatus ensures that no value is present for Status, not even an explicit nil +### GetIdentityState + +`func (o *PublicIdentity) GetIdentityState() string` + +GetIdentityState returns the IdentityState field if non-nil, zero value otherwise. + +### GetIdentityStateOk + +`func (o *PublicIdentity) GetIdentityStateOk() (*string, bool)` + +GetIdentityStateOk returns a tuple with the IdentityState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityState + +`func (o *PublicIdentity) SetIdentityState(v string)` + +SetIdentityState sets IdentityState field to given value. + +### HasIdentityState + +`func (o *PublicIdentity) HasIdentityState() bool` + +HasIdentityState returns a boolean if a field has been set. + +### SetIdentityStateNil + +`func (o *PublicIdentity) SetIdentityStateNil(b bool)` + + SetIdentityStateNil sets the value for IdentityState to be an explicit nil + +### UnsetIdentityState +`func (o *PublicIdentity) UnsetIdentityState()` + +UnsetIdentityState ensures that no value is present for IdentityState, not even an explicit nil +### GetManager + +`func (o *PublicIdentity) GetManager() IdentityReference` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *PublicIdentity) GetManagerOk() (*IdentityReference, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *PublicIdentity) SetManager(v IdentityReference)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *PublicIdentity) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### SetManagerNil + +`func (o *PublicIdentity) SetManagerNil(b bool)` + + SetManagerNil sets the value for Manager to be an explicit nil + +### UnsetManager +`func (o *PublicIdentity) UnsetManager()` + +UnsetManager ensures that no value is present for Manager, not even an explicit nil +### GetAttributes + +`func (o *PublicIdentity) GetAttributes() []PublicIdentityAttributesInner` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *PublicIdentity) GetAttributesOk() (*[]PublicIdentityAttributesInner, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *PublicIdentity) SetAttributes(v []PublicIdentityAttributesInner)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *PublicIdentity) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PublicIdentityAttributeConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/PublicIdentityAttributeConfig.md new file mode 100644 index 000000000..6cc3054b2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PublicIdentityAttributeConfig.md @@ -0,0 +1,90 @@ +--- +id: v2025-public-identity-attribute-config +title: PublicIdentityAttributeConfig +pagination_label: PublicIdentityAttributeConfig +sidebar_label: PublicIdentityAttributeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentityAttributeConfig', 'V2025PublicIdentityAttributeConfig'] +slug: /tools/sdk/go/v2025/models/public-identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributeConfig', 'V2025PublicIdentityAttributeConfig'] +--- + +# PublicIdentityAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The attribute key | [optional] +**Name** | Pointer to **string** | The attribute display name | [optional] + +## Methods + +### NewPublicIdentityAttributeConfig + +`func NewPublicIdentityAttributeConfig() *PublicIdentityAttributeConfig` + +NewPublicIdentityAttributeConfig instantiates a new PublicIdentityAttributeConfig 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 + +### NewPublicIdentityAttributeConfigWithDefaults + +`func NewPublicIdentityAttributeConfigWithDefaults() *PublicIdentityAttributeConfig` + +NewPublicIdentityAttributeConfigWithDefaults instantiates a new PublicIdentityAttributeConfig 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 + +### GetKey + +`func (o *PublicIdentityAttributeConfig) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *PublicIdentityAttributeConfig) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *PublicIdentityAttributeConfig) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *PublicIdentityAttributeConfig) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *PublicIdentityAttributeConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PublicIdentityAttributeConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PublicIdentityAttributeConfig) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PublicIdentityAttributeConfig) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PublicIdentityAttributesInner.md b/docs/tools/sdk/go/Reference/V2025/Models/PublicIdentityAttributesInner.md new file mode 100644 index 000000000..6d02149b1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PublicIdentityAttributesInner.md @@ -0,0 +1,126 @@ +--- +id: v2025-public-identity-attributes-inner +title: PublicIdentityAttributesInner +pagination_label: PublicIdentityAttributesInner +sidebar_label: PublicIdentityAttributesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentityAttributesInner', 'V2025PublicIdentityAttributesInner'] +slug: /tools/sdk/go/v2025/models/public-identity-attributes-inner +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributesInner', 'V2025PublicIdentityAttributesInner'] +--- + +# PublicIdentityAttributesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The attribute key | [optional] +**Name** | Pointer to **string** | Human-readable display name of the attribute | [optional] +**Value** | Pointer to **NullableString** | The attribute value | [optional] + +## Methods + +### NewPublicIdentityAttributesInner + +`func NewPublicIdentityAttributesInner() *PublicIdentityAttributesInner` + +NewPublicIdentityAttributesInner instantiates a new PublicIdentityAttributesInner 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 + +### NewPublicIdentityAttributesInnerWithDefaults + +`func NewPublicIdentityAttributesInnerWithDefaults() *PublicIdentityAttributesInner` + +NewPublicIdentityAttributesInnerWithDefaults instantiates a new PublicIdentityAttributesInner 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 + +### GetKey + +`func (o *PublicIdentityAttributesInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *PublicIdentityAttributesInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *PublicIdentityAttributesInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *PublicIdentityAttributesInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *PublicIdentityAttributesInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PublicIdentityAttributesInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PublicIdentityAttributesInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PublicIdentityAttributesInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValue + +`func (o *PublicIdentityAttributesInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *PublicIdentityAttributesInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *PublicIdentityAttributesInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *PublicIdentityAttributesInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *PublicIdentityAttributesInner) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *PublicIdentityAttributesInner) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PublicIdentityConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/PublicIdentityConfig.md new file mode 100644 index 000000000..9dcc67374 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PublicIdentityConfig.md @@ -0,0 +1,136 @@ +--- +id: v2025-public-identity-config +title: PublicIdentityConfig +pagination_label: PublicIdentityConfig +sidebar_label: PublicIdentityConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentityConfig', 'V2025PublicIdentityConfig'] +slug: /tools/sdk/go/v2025/models/public-identity-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityConfig', 'V2025PublicIdentityConfig'] +--- + +# PublicIdentityConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]PublicIdentityAttributeConfig**](public-identity-attribute-config) | Up to 5 identity attributes that will be available to everyone in the org for all users in the org. | [optional] +**Modified** | Pointer to **NullableTime** | When this configuration was last modified. | [optional] +**ModifiedBy** | Pointer to [**NullableIdentityReference**](identity-reference) | | [optional] + +## Methods + +### NewPublicIdentityConfig + +`func NewPublicIdentityConfig() *PublicIdentityConfig` + +NewPublicIdentityConfig instantiates a new PublicIdentityConfig 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 + +### NewPublicIdentityConfigWithDefaults + +`func NewPublicIdentityConfigWithDefaults() *PublicIdentityConfig` + +NewPublicIdentityConfigWithDefaults instantiates a new PublicIdentityConfig 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 + +### GetAttributes + +`func (o *PublicIdentityConfig) GetAttributes() []PublicIdentityAttributeConfig` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *PublicIdentityConfig) GetAttributesOk() (*[]PublicIdentityAttributeConfig, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *PublicIdentityConfig) SetAttributes(v []PublicIdentityAttributeConfig)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *PublicIdentityConfig) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetModified + +`func (o *PublicIdentityConfig) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PublicIdentityConfig) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PublicIdentityConfig) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PublicIdentityConfig) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *PublicIdentityConfig) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *PublicIdentityConfig) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetModifiedBy + +`func (o *PublicIdentityConfig) GetModifiedBy() IdentityReference` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *PublicIdentityConfig) GetModifiedByOk() (*IdentityReference, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedBy + +`func (o *PublicIdentityConfig) SetModifiedBy(v IdentityReference)` + +SetModifiedBy sets ModifiedBy field to given value. + +### HasModifiedBy + +`func (o *PublicIdentityConfig) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### SetModifiedByNil + +`func (o *PublicIdentityConfig) SetModifiedByNil(b bool)` + + SetModifiedByNil sets the value for ModifiedBy to be an explicit nil + +### UnsetModifiedBy +`func (o *PublicIdentityConfig) UnsetModifiedBy()` + +UnsetModifiedBy ensures that no value is present for ModifiedBy, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PutClientLogConfigurationRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/PutClientLogConfigurationRequest.md new file mode 100644 index 000000000..a41a53fbb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PutClientLogConfigurationRequest.md @@ -0,0 +1,163 @@ +--- +id: v2025-put-client-log-configuration-request +title: PutClientLogConfigurationRequest +pagination_label: PutClientLogConfigurationRequest +sidebar_label: PutClientLogConfigurationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PutClientLogConfigurationRequest', 'V2025PutClientLogConfigurationRequest'] +slug: /tools/sdk/go/v2025/models/put-client-log-configuration-request +tags: ['SDK', 'Software Development Kit', 'PutClientLogConfigurationRequest', 'V2025PutClientLogConfigurationRequest'] +--- + +# PutClientLogConfigurationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **string** | Log configuration's client ID | [optional] +**DurationMinutes** | Pointer to **int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**RootLevel** | [**StandardLevel**](standard-level) | | +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] +**Expiration** | Pointer to **SailPointTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] + +## Methods + +### NewPutClientLogConfigurationRequest + +`func NewPutClientLogConfigurationRequest(rootLevel StandardLevel, ) *PutClientLogConfigurationRequest` + +NewPutClientLogConfigurationRequest instantiates a new PutClientLogConfigurationRequest 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 + +### NewPutClientLogConfigurationRequestWithDefaults + +`func NewPutClientLogConfigurationRequestWithDefaults() *PutClientLogConfigurationRequest` + +NewPutClientLogConfigurationRequestWithDefaults instantiates a new PutClientLogConfigurationRequest 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 + +### GetClientId + +`func (o *PutClientLogConfigurationRequest) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *PutClientLogConfigurationRequest) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *PutClientLogConfigurationRequest) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + +### HasClientId + +`func (o *PutClientLogConfigurationRequest) HasClientId() bool` + +HasClientId returns a boolean if a field has been set. + +### GetDurationMinutes + +`func (o *PutClientLogConfigurationRequest) GetDurationMinutes() int32` + +GetDurationMinutes returns the DurationMinutes field if non-nil, zero value otherwise. + +### GetDurationMinutesOk + +`func (o *PutClientLogConfigurationRequest) GetDurationMinutesOk() (*int32, bool)` + +GetDurationMinutesOk returns a tuple with the DurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDurationMinutes + +`func (o *PutClientLogConfigurationRequest) SetDurationMinutes(v int32)` + +SetDurationMinutes sets DurationMinutes field to given value. + +### HasDurationMinutes + +`func (o *PutClientLogConfigurationRequest) HasDurationMinutes() bool` + +HasDurationMinutes returns a boolean if a field has been set. + +### GetRootLevel + +`func (o *PutClientLogConfigurationRequest) GetRootLevel() StandardLevel` + +GetRootLevel returns the RootLevel field if non-nil, zero value otherwise. + +### GetRootLevelOk + +`func (o *PutClientLogConfigurationRequest) GetRootLevelOk() (*StandardLevel, bool)` + +GetRootLevelOk returns a tuple with the RootLevel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootLevel + +`func (o *PutClientLogConfigurationRequest) SetRootLevel(v StandardLevel)` + +SetRootLevel sets RootLevel field to given value. + + +### GetLogLevels + +`func (o *PutClientLogConfigurationRequest) GetLogLevels() map[string]StandardLevel` + +GetLogLevels returns the LogLevels field if non-nil, zero value otherwise. + +### GetLogLevelsOk + +`func (o *PutClientLogConfigurationRequest) GetLogLevelsOk() (*map[string]StandardLevel, bool)` + +GetLogLevelsOk returns a tuple with the LogLevels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogLevels + +`func (o *PutClientLogConfigurationRequest) SetLogLevels(v map[string]StandardLevel)` + +SetLogLevels sets LogLevels field to given value. + +### HasLogLevels + +`func (o *PutClientLogConfigurationRequest) HasLogLevels() bool` + +HasLogLevels returns a boolean if a field has been set. + +### GetExpiration + +`func (o *PutClientLogConfigurationRequest) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *PutClientLogConfigurationRequest) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *PutClientLogConfigurationRequest) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *PutClientLogConfigurationRequest) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PutConnectorCorrelationConfigRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/PutConnectorCorrelationConfigRequest.md new file mode 100644 index 000000000..f169793fb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PutConnectorCorrelationConfigRequest.md @@ -0,0 +1,59 @@ +--- +id: v2025-put-connector-correlation-config-request +title: PutConnectorCorrelationConfigRequest +pagination_label: PutConnectorCorrelationConfigRequest +sidebar_label: PutConnectorCorrelationConfigRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PutConnectorCorrelationConfigRequest', 'V2025PutConnectorCorrelationConfigRequest'] +slug: /tools/sdk/go/v2025/models/put-connector-correlation-config-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorCorrelationConfigRequest', 'V2025PutConnectorCorrelationConfigRequest'] +--- + +# PutConnectorCorrelationConfigRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | ***os.File** | connector correlation config xml file | + +## Methods + +### NewPutConnectorCorrelationConfigRequest + +`func NewPutConnectorCorrelationConfigRequest(file *os.File, ) *PutConnectorCorrelationConfigRequest` + +NewPutConnectorCorrelationConfigRequest instantiates a new PutConnectorCorrelationConfigRequest 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 + +### NewPutConnectorCorrelationConfigRequestWithDefaults + +`func NewPutConnectorCorrelationConfigRequestWithDefaults() *PutConnectorCorrelationConfigRequest` + +NewPutConnectorCorrelationConfigRequestWithDefaults instantiates a new PutConnectorCorrelationConfigRequest 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 + +### GetFile + +`func (o *PutConnectorCorrelationConfigRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *PutConnectorCorrelationConfigRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *PutConnectorCorrelationConfigRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PutConnectorSourceConfigRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/PutConnectorSourceConfigRequest.md new file mode 100644 index 000000000..a6deb9a78 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PutConnectorSourceConfigRequest.md @@ -0,0 +1,59 @@ +--- +id: v2025-put-connector-source-config-request +title: PutConnectorSourceConfigRequest +pagination_label: PutConnectorSourceConfigRequest +sidebar_label: PutConnectorSourceConfigRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PutConnectorSourceConfigRequest', 'V2025PutConnectorSourceConfigRequest'] +slug: /tools/sdk/go/v2025/models/put-connector-source-config-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceConfigRequest', 'V2025PutConnectorSourceConfigRequest'] +--- + +# PutConnectorSourceConfigRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | ***os.File** | connector source config xml file | + +## Methods + +### NewPutConnectorSourceConfigRequest + +`func NewPutConnectorSourceConfigRequest(file *os.File, ) *PutConnectorSourceConfigRequest` + +NewPutConnectorSourceConfigRequest instantiates a new PutConnectorSourceConfigRequest 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 + +### NewPutConnectorSourceConfigRequestWithDefaults + +`func NewPutConnectorSourceConfigRequestWithDefaults() *PutConnectorSourceConfigRequest` + +NewPutConnectorSourceConfigRequestWithDefaults instantiates a new PutConnectorSourceConfigRequest 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 + +### GetFile + +`func (o *PutConnectorSourceConfigRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *PutConnectorSourceConfigRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *PutConnectorSourceConfigRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PutConnectorSourceTemplateRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/PutConnectorSourceTemplateRequest.md new file mode 100644 index 000000000..57b98ae5f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PutConnectorSourceTemplateRequest.md @@ -0,0 +1,59 @@ +--- +id: v2025-put-connector-source-template-request +title: PutConnectorSourceTemplateRequest +pagination_label: PutConnectorSourceTemplateRequest +sidebar_label: PutConnectorSourceTemplateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PutConnectorSourceTemplateRequest', 'V2025PutConnectorSourceTemplateRequest'] +slug: /tools/sdk/go/v2025/models/put-connector-source-template-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceTemplateRequest', 'V2025PutConnectorSourceTemplateRequest'] +--- + +# PutConnectorSourceTemplateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | ***os.File** | connector source template xml file | + +## Methods + +### NewPutConnectorSourceTemplateRequest + +`func NewPutConnectorSourceTemplateRequest(file *os.File, ) *PutConnectorSourceTemplateRequest` + +NewPutConnectorSourceTemplateRequest instantiates a new PutConnectorSourceTemplateRequest 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 + +### NewPutConnectorSourceTemplateRequestWithDefaults + +`func NewPutConnectorSourceTemplateRequestWithDefaults() *PutConnectorSourceTemplateRequest` + +NewPutConnectorSourceTemplateRequestWithDefaults instantiates a new PutConnectorSourceTemplateRequest 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 + +### GetFile + +`func (o *PutConnectorSourceTemplateRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *PutConnectorSourceTemplateRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *PutConnectorSourceTemplateRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/PutPasswordDictionaryRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/PutPasswordDictionaryRequest.md new file mode 100644 index 000000000..de632506d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/PutPasswordDictionaryRequest.md @@ -0,0 +1,64 @@ +--- +id: v2025-put-password-dictionary-request +title: PutPasswordDictionaryRequest +pagination_label: PutPasswordDictionaryRequest +sidebar_label: PutPasswordDictionaryRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PutPasswordDictionaryRequest', 'V2025PutPasswordDictionaryRequest'] +slug: /tools/sdk/go/v2025/models/put-password-dictionary-request +tags: ['SDK', 'Software Development Kit', 'PutPasswordDictionaryRequest', 'V2025PutPasswordDictionaryRequest'] +--- + +# PutPasswordDictionaryRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | Pointer to ***os.File** | | [optional] + +## Methods + +### NewPutPasswordDictionaryRequest + +`func NewPutPasswordDictionaryRequest() *PutPasswordDictionaryRequest` + +NewPutPasswordDictionaryRequest instantiates a new PutPasswordDictionaryRequest 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 + +### NewPutPasswordDictionaryRequestWithDefaults + +`func NewPutPasswordDictionaryRequestWithDefaults() *PutPasswordDictionaryRequest` + +NewPutPasswordDictionaryRequestWithDefaults instantiates a new PutPasswordDictionaryRequest 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 + +### GetFile + +`func (o *PutPasswordDictionaryRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *PutPasswordDictionaryRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *PutPasswordDictionaryRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + +### HasFile + +`func (o *PutPasswordDictionaryRequest) HasFile() bool` + +HasFile returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Query.md b/docs/tools/sdk/go/Reference/V2025/Models/Query.md new file mode 100644 index 000000000..d2fd2b4a5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Query.md @@ -0,0 +1,142 @@ +--- +id: v2025-query +title: Query +pagination_label: Query +sidebar_label: Query +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Query', 'V2025Query'] +slug: /tools/sdk/go/v2025/models/query +tags: ['SDK', 'Software Development Kit', 'Query', 'V2025Query'] +--- + +# Query + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | Pointer to **string** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [optional] +**Fields** | Pointer to **string** | The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of \"a*\" to be applied to \"name\", \"firstName\", and the \"source.name\". The response will include all results matching the \"a*\" query found in those three fields. A field's availability depends on the indices being searched. For example, if you are searching \"identities\", you can apply your search to the \"firstName\" field, but you couldn't use \"firstName\" with a search on \"access profiles\". Refer to the response schema for the respective lists of available fields. | [optional] +**TimeZone** | Pointer to **string** | The time zone to be applied to any range query related to dates. | [optional] +**InnerHit** | Pointer to [**InnerHit**](inner-hit) | | [optional] + +## Methods + +### NewQuery + +`func NewQuery() *Query` + +NewQuery instantiates a new Query 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 + +### NewQueryWithDefaults + +`func NewQueryWithDefaults() *Query` + +NewQueryWithDefaults instantiates a new Query 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 + +### GetQuery + +`func (o *Query) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *Query) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *Query) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *Query) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### GetFields + +`func (o *Query) GetFields() string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *Query) GetFieldsOk() (*string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *Query) SetFields(v string)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *Query) HasFields() bool` + +HasFields returns a boolean if a field has been set. + +### GetTimeZone + +`func (o *Query) GetTimeZone() string` + +GetTimeZone returns the TimeZone field if non-nil, zero value otherwise. + +### GetTimeZoneOk + +`func (o *Query) GetTimeZoneOk() (*string, bool)` + +GetTimeZoneOk returns a tuple with the TimeZone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZone + +`func (o *Query) SetTimeZone(v string)` + +SetTimeZone sets TimeZone field to given value. + +### HasTimeZone + +`func (o *Query) HasTimeZone() bool` + +HasTimeZone returns a boolean if a field has been set. + +### GetInnerHit + +`func (o *Query) GetInnerHit() InnerHit` + +GetInnerHit returns the InnerHit field if non-nil, zero value otherwise. + +### GetInnerHitOk + +`func (o *Query) GetInnerHitOk() (*InnerHit, bool)` + +GetInnerHitOk returns a tuple with the InnerHit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInnerHit + +`func (o *Query) SetInnerHit(v InnerHit)` + +SetInnerHit sets InnerHit field to given value. + +### HasInnerHit + +`func (o *Query) HasInnerHit() bool` + +HasInnerHit returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/QueryResultFilter.md b/docs/tools/sdk/go/Reference/V2025/Models/QueryResultFilter.md new file mode 100644 index 000000000..18beb6d6f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/QueryResultFilter.md @@ -0,0 +1,90 @@ +--- +id: v2025-query-result-filter +title: QueryResultFilter +pagination_label: QueryResultFilter +sidebar_label: QueryResultFilter +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'QueryResultFilter', 'V2025QueryResultFilter'] +slug: /tools/sdk/go/v2025/models/query-result-filter +tags: ['SDK', 'Software Development Kit', 'QueryResultFilter', 'V2025QueryResultFilter'] +--- + +# QueryResultFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Includes** | Pointer to **[]string** | The list of field names to include in the result documents. | [optional] +**Excludes** | Pointer to **[]string** | The list of field names to exclude from the result documents. | [optional] + +## Methods + +### NewQueryResultFilter + +`func NewQueryResultFilter() *QueryResultFilter` + +NewQueryResultFilter instantiates a new QueryResultFilter 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 + +### NewQueryResultFilterWithDefaults + +`func NewQueryResultFilterWithDefaults() *QueryResultFilter` + +NewQueryResultFilterWithDefaults instantiates a new QueryResultFilter 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 + +### GetIncludes + +`func (o *QueryResultFilter) GetIncludes() []string` + +GetIncludes returns the Includes field if non-nil, zero value otherwise. + +### GetIncludesOk + +`func (o *QueryResultFilter) GetIncludesOk() (*[]string, bool)` + +GetIncludesOk returns a tuple with the Includes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludes + +`func (o *QueryResultFilter) SetIncludes(v []string)` + +SetIncludes sets Includes field to given value. + +### HasIncludes + +`func (o *QueryResultFilter) HasIncludes() bool` + +HasIncludes returns a boolean if a field has been set. + +### GetExcludes + +`func (o *QueryResultFilter) GetExcludes() []string` + +GetExcludes returns the Excludes field if non-nil, zero value otherwise. + +### GetExcludesOk + +`func (o *QueryResultFilter) GetExcludesOk() (*[]string, bool)` + +GetExcludesOk returns a tuple with the Excludes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludes + +`func (o *QueryResultFilter) SetExcludes(v []string)` + +SetExcludes sets Excludes field to given value. + +### HasExcludes + +`func (o *QueryResultFilter) HasExcludes() bool` + +HasExcludes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/QueryType.md b/docs/tools/sdk/go/Reference/V2025/Models/QueryType.md new file mode 100644 index 000000000..7f8d659dd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/QueryType.md @@ -0,0 +1,25 @@ +--- +id: v2025-query-type +title: QueryType +pagination_label: QueryType +sidebar_label: QueryType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'QueryType', 'V2025QueryType'] +slug: /tools/sdk/go/v2025/models/query-type +tags: ['SDK', 'Software Development Kit', 'QueryType', 'V2025QueryType'] +--- + +# QueryType + +## Enum + + +* `DSL` (value: `"DSL"`) + +* `SAILPOINT` (value: `"SAILPOINT"`) + +* `TEXT` (value: `"TEXT"`) + +* `TYPEAHEAD` (value: `"TYPEAHEAD"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/QueuedCheckConfigDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/QueuedCheckConfigDetails.md new file mode 100644 index 000000000..429d52a4f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/QueuedCheckConfigDetails.md @@ -0,0 +1,80 @@ +--- +id: v2025-queued-check-config-details +title: QueuedCheckConfigDetails +pagination_label: QueuedCheckConfigDetails +sidebar_label: QueuedCheckConfigDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'QueuedCheckConfigDetails', 'V2025QueuedCheckConfigDetails'] +slug: /tools/sdk/go/v2025/models/queued-check-config-details +tags: ['SDK', 'Software Development Kit', 'QueuedCheckConfigDetails', 'V2025QueuedCheckConfigDetails'] +--- + +# QueuedCheckConfigDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProvisioningStatusCheckIntervalMinutes** | **string** | Interval in minutes between status checks | +**ProvisioningMaxStatusCheckDays** | **string** | Maximum number of days to check | + +## Methods + +### NewQueuedCheckConfigDetails + +`func NewQueuedCheckConfigDetails(provisioningStatusCheckIntervalMinutes string, provisioningMaxStatusCheckDays string, ) *QueuedCheckConfigDetails` + +NewQueuedCheckConfigDetails instantiates a new QueuedCheckConfigDetails 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 + +### NewQueuedCheckConfigDetailsWithDefaults + +`func NewQueuedCheckConfigDetailsWithDefaults() *QueuedCheckConfigDetails` + +NewQueuedCheckConfigDetailsWithDefaults instantiates a new QueuedCheckConfigDetails 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 + +### GetProvisioningStatusCheckIntervalMinutes + +`func (o *QueuedCheckConfigDetails) GetProvisioningStatusCheckIntervalMinutes() string` + +GetProvisioningStatusCheckIntervalMinutes returns the ProvisioningStatusCheckIntervalMinutes field if non-nil, zero value otherwise. + +### GetProvisioningStatusCheckIntervalMinutesOk + +`func (o *QueuedCheckConfigDetails) GetProvisioningStatusCheckIntervalMinutesOk() (*string, bool)` + +GetProvisioningStatusCheckIntervalMinutesOk returns a tuple with the ProvisioningStatusCheckIntervalMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningStatusCheckIntervalMinutes + +`func (o *QueuedCheckConfigDetails) SetProvisioningStatusCheckIntervalMinutes(v string)` + +SetProvisioningStatusCheckIntervalMinutes sets ProvisioningStatusCheckIntervalMinutes field to given value. + + +### GetProvisioningMaxStatusCheckDays + +`func (o *QueuedCheckConfigDetails) GetProvisioningMaxStatusCheckDays() string` + +GetProvisioningMaxStatusCheckDays returns the ProvisioningMaxStatusCheckDays field if non-nil, zero value otherwise. + +### GetProvisioningMaxStatusCheckDaysOk + +`func (o *QueuedCheckConfigDetails) GetProvisioningMaxStatusCheckDaysOk() (*string, bool)` + +GetProvisioningMaxStatusCheckDaysOk returns a tuple with the ProvisioningMaxStatusCheckDays field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningMaxStatusCheckDays + +`func (o *QueuedCheckConfigDetails) SetProvisioningMaxStatusCheckDays(v string)` + +SetProvisioningMaxStatusCheckDays sets ProvisioningMaxStatusCheckDays field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Range.md b/docs/tools/sdk/go/Reference/V2025/Models/Range.md new file mode 100644 index 000000000..6a8890322 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Range.md @@ -0,0 +1,90 @@ +--- +id: v2025-range +title: Range +pagination_label: Range +sidebar_label: Range +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Range', 'V2025Range'] +slug: /tools/sdk/go/v2025/models/range +tags: ['SDK', 'Software Development Kit', 'Range', 'V2025Range'] +--- + +# Range + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Lower** | Pointer to [**Bound**](bound) | | [optional] +**Upper** | Pointer to [**Bound**](bound) | | [optional] + +## Methods + +### NewRange + +`func NewRange() *Range` + +NewRange instantiates a new Range 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 + +### NewRangeWithDefaults + +`func NewRangeWithDefaults() *Range` + +NewRangeWithDefaults instantiates a new Range 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 + +### GetLower + +`func (o *Range) GetLower() Bound` + +GetLower returns the Lower field if non-nil, zero value otherwise. + +### GetLowerOk + +`func (o *Range) GetLowerOk() (*Bound, bool)` + +GetLowerOk returns a tuple with the Lower field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLower + +`func (o *Range) SetLower(v Bound)` + +SetLower sets Lower field to given value. + +### HasLower + +`func (o *Range) HasLower() bool` + +HasLower returns a boolean if a field has been set. + +### GetUpper + +`func (o *Range) GetUpper() Bound` + +GetUpper returns the Upper field if non-nil, zero value otherwise. + +### GetUpperOk + +`func (o *Range) GetUpperOk() (*Bound, bool)` + +GetUpperOk returns a tuple with the Upper field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpper + +`func (o *Range) SetUpper(v Bound)` + +SetUpper sets Upper field to given value. + +### HasUpper + +`func (o *Range) HasUpper() bool` + +HasUpper returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReassignReference.md b/docs/tools/sdk/go/Reference/V2025/Models/ReassignReference.md new file mode 100644 index 000000000..3f7fb1714 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReassignReference.md @@ -0,0 +1,80 @@ +--- +id: v2025-reassign-reference +title: ReassignReference +pagination_label: ReassignReference +sidebar_label: ReassignReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignReference', 'V2025ReassignReference'] +slug: /tools/sdk/go/v2025/models/reassign-reference +tags: ['SDK', 'Software Development Kit', 'ReassignReference', 'V2025ReassignReference'] +--- + +# ReassignReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The ID of item or identity being reassigned. | +**Type** | **string** | The type of item or identity being reassigned. | + +## Methods + +### NewReassignReference + +`func NewReassignReference(id string, type_ string, ) *ReassignReference` + +NewReassignReference instantiates a new ReassignReference 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 + +### NewReassignReferenceWithDefaults + +`func NewReassignReferenceWithDefaults() *ReassignReference` + +NewReassignReferenceWithDefaults instantiates a new ReassignReference 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 + +### GetId + +`func (o *ReassignReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReassignReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReassignReference) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *ReassignReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReassignReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReassignReference) SetType(v string)` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Reassignment.md b/docs/tools/sdk/go/Reference/V2025/Models/Reassignment.md new file mode 100644 index 000000000..36d525e92 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Reassignment.md @@ -0,0 +1,90 @@ +--- +id: v2025-reassignment +title: Reassignment +pagination_label: Reassignment +sidebar_label: Reassignment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Reassignment', 'V2025Reassignment'] +slug: /tools/sdk/go/v2025/models/reassignment +tags: ['SDK', 'Software Development Kit', 'Reassignment', 'V2025Reassignment'] +--- + +# Reassignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**From** | Pointer to [**CertificationReference**](certification-reference) | | [optional] +**Comment** | Pointer to **string** | The comment entered when the Certification was reassigned | [optional] + +## Methods + +### NewReassignment + +`func NewReassignment() *Reassignment` + +NewReassignment instantiates a new Reassignment 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 + +### NewReassignmentWithDefaults + +`func NewReassignmentWithDefaults() *Reassignment` + +NewReassignmentWithDefaults instantiates a new Reassignment 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 + +### GetFrom + +`func (o *Reassignment) GetFrom() CertificationReference` + +GetFrom returns the From field if non-nil, zero value otherwise. + +### GetFromOk + +`func (o *Reassignment) GetFromOk() (*CertificationReference, bool)` + +GetFromOk returns a tuple with the From field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrom + +`func (o *Reassignment) SetFrom(v CertificationReference)` + +SetFrom sets From field to given value. + +### HasFrom + +`func (o *Reassignment) HasFrom() bool` + +HasFrom returns a boolean if a field has been set. + +### GetComment + +`func (o *Reassignment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *Reassignment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *Reassignment) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *Reassignment) HasComment() bool` + +HasComment returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReassignmentReference.md b/docs/tools/sdk/go/Reference/V2025/Models/ReassignmentReference.md new file mode 100644 index 000000000..d4ed7af6c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReassignmentReference.md @@ -0,0 +1,80 @@ +--- +id: v2025-reassignment-reference +title: ReassignmentReference +pagination_label: ReassignmentReference +sidebar_label: ReassignmentReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignmentReference', 'V2025ReassignmentReference'] +slug: /tools/sdk/go/v2025/models/reassignment-reference +tags: ['SDK', 'Software Development Kit', 'ReassignmentReference', 'V2025ReassignmentReference'] +--- + +# ReassignmentReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The ID of item or identity being reassigned. | +**Type** | **string** | The type of item or identity being reassigned. | + +## Methods + +### NewReassignmentReference + +`func NewReassignmentReference(id string, type_ string, ) *ReassignmentReference` + +NewReassignmentReference instantiates a new ReassignmentReference 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 + +### NewReassignmentReferenceWithDefaults + +`func NewReassignmentReferenceWithDefaults() *ReassignmentReference` + +NewReassignmentReferenceWithDefaults instantiates a new ReassignmentReference 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 + +### GetId + +`func (o *ReassignmentReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReassignmentReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReassignmentReference) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *ReassignmentReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReassignmentReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReassignmentReference) SetType(v string)` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReassignmentTrailDTO.md b/docs/tools/sdk/go/Reference/V2025/Models/ReassignmentTrailDTO.md new file mode 100644 index 000000000..762887dd0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReassignmentTrailDTO.md @@ -0,0 +1,116 @@ +--- +id: v2025-reassignment-trail-dto +title: ReassignmentTrailDTO +pagination_label: ReassignmentTrailDTO +sidebar_label: ReassignmentTrailDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignmentTrailDTO', 'V2025ReassignmentTrailDTO'] +slug: /tools/sdk/go/v2025/models/reassignment-trail-dto +tags: ['SDK', 'Software Development Kit', 'ReassignmentTrailDTO', 'V2025ReassignmentTrailDTO'] +--- + +# ReassignmentTrailDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PreviousOwner** | Pointer to **string** | The ID of previous owner identity. | [optional] +**NewOwner** | Pointer to **string** | The ID of new owner identity. | [optional] +**ReassignmentType** | Pointer to **string** | The type of reassignment. | [optional] + +## Methods + +### NewReassignmentTrailDTO + +`func NewReassignmentTrailDTO() *ReassignmentTrailDTO` + +NewReassignmentTrailDTO instantiates a new ReassignmentTrailDTO 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 + +### NewReassignmentTrailDTOWithDefaults + +`func NewReassignmentTrailDTOWithDefaults() *ReassignmentTrailDTO` + +NewReassignmentTrailDTOWithDefaults instantiates a new ReassignmentTrailDTO 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 + +### GetPreviousOwner + +`func (o *ReassignmentTrailDTO) GetPreviousOwner() string` + +GetPreviousOwner returns the PreviousOwner field if non-nil, zero value otherwise. + +### GetPreviousOwnerOk + +`func (o *ReassignmentTrailDTO) GetPreviousOwnerOk() (*string, bool)` + +GetPreviousOwnerOk returns a tuple with the PreviousOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousOwner + +`func (o *ReassignmentTrailDTO) SetPreviousOwner(v string)` + +SetPreviousOwner sets PreviousOwner field to given value. + +### HasPreviousOwner + +`func (o *ReassignmentTrailDTO) HasPreviousOwner() bool` + +HasPreviousOwner returns a boolean if a field has been set. + +### GetNewOwner + +`func (o *ReassignmentTrailDTO) GetNewOwner() string` + +GetNewOwner returns the NewOwner field if non-nil, zero value otherwise. + +### GetNewOwnerOk + +`func (o *ReassignmentTrailDTO) GetNewOwnerOk() (*string, bool)` + +GetNewOwnerOk returns a tuple with the NewOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewOwner + +`func (o *ReassignmentTrailDTO) SetNewOwner(v string)` + +SetNewOwner sets NewOwner field to given value. + +### HasNewOwner + +`func (o *ReassignmentTrailDTO) HasNewOwner() bool` + +HasNewOwner returns a boolean if a field has been set. + +### GetReassignmentType + +`func (o *ReassignmentTrailDTO) GetReassignmentType() string` + +GetReassignmentType returns the ReassignmentType field if non-nil, zero value otherwise. + +### GetReassignmentTypeOk + +`func (o *ReassignmentTrailDTO) GetReassignmentTypeOk() (*string, bool)` + +GetReassignmentTypeOk returns a tuple with the ReassignmentType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignmentType + +`func (o *ReassignmentTrailDTO) SetReassignmentType(v string)` + +SetReassignmentType sets ReassignmentType field to given value. + +### HasReassignmentType + +`func (o *ReassignmentTrailDTO) HasReassignmentType() bool` + +HasReassignmentType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReassignmentType.md b/docs/tools/sdk/go/Reference/V2025/Models/ReassignmentType.md new file mode 100644 index 000000000..fac8c8871 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReassignmentType.md @@ -0,0 +1,25 @@ +--- +id: v2025-reassignment-type +title: ReassignmentType +pagination_label: ReassignmentType +sidebar_label: ReassignmentType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignmentType', 'V2025ReassignmentType'] +slug: /tools/sdk/go/v2025/models/reassignment-type +tags: ['SDK', 'Software Development Kit', 'ReassignmentType', 'V2025ReassignmentType'] +--- + +# ReassignmentType + +## Enum + + +* `MANUAL_REASSIGNMENT` (value: `"MANUAL_REASSIGNMENT"`) + +* `AUTOMATIC_REASSIGNMENT` (value: `"AUTOMATIC_REASSIGNMENT"`) + +* `AUTO_ESCALATION` (value: `"AUTO_ESCALATION"`) + +* `SELF_REVIEW_DELEGATION` (value: `"SELF_REVIEW_DELEGATION"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReassignmentTypeEnum.md b/docs/tools/sdk/go/Reference/V2025/Models/ReassignmentTypeEnum.md new file mode 100644 index 000000000..4ea49e83a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReassignmentTypeEnum.md @@ -0,0 +1,25 @@ +--- +id: v2025-reassignment-type-enum +title: ReassignmentTypeEnum +pagination_label: ReassignmentTypeEnum +sidebar_label: ReassignmentTypeEnum +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignmentTypeEnum', 'V2025ReassignmentTypeEnum'] +slug: /tools/sdk/go/v2025/models/reassignment-type-enum +tags: ['SDK', 'Software Development Kit', 'ReassignmentTypeEnum', 'V2025ReassignmentTypeEnum'] +--- + +# ReassignmentTypeEnum + +## Enum + + +* `MANUAL_REASSIGNMENT` (value: `"MANUAL_REASSIGNMENT,"`) + +* `AUTOMATIC_REASSIGNMENT` (value: `"AUTOMATIC_REASSIGNMENT,"`) + +* `AUTO_ESCALATION` (value: `"AUTO_ESCALATION,"`) + +* `SELF_REVIEW_DELEGATION` (value: `"SELF_REVIEW_DELEGATION"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Recommendation.md b/docs/tools/sdk/go/Reference/V2025/Models/Recommendation.md new file mode 100644 index 000000000..84a0f38f9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Recommendation.md @@ -0,0 +1,80 @@ +--- +id: v2025-recommendation +title: Recommendation +pagination_label: Recommendation +sidebar_label: Recommendation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Recommendation', 'V2025Recommendation'] +slug: /tools/sdk/go/v2025/models/recommendation +tags: ['SDK', 'Software Development Kit', 'Recommendation', 'V2025Recommendation'] +--- + +# Recommendation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Recommended type of account. | +**Method** | **string** | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | + +## Methods + +### NewRecommendation + +`func NewRecommendation(type_ string, method string, ) *Recommendation` + +NewRecommendation instantiates a new Recommendation 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 + +### NewRecommendationWithDefaults + +`func NewRecommendationWithDefaults() *Recommendation` + +NewRecommendationWithDefaults instantiates a new Recommendation 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 + +### GetType + +`func (o *Recommendation) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Recommendation) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Recommendation) SetType(v string)` + +SetType sets Type field to given value. + + +### GetMethod + +`func (o *Recommendation) GetMethod() string` + +GetMethod returns the Method field if non-nil, zero value otherwise. + +### GetMethodOk + +`func (o *Recommendation) GetMethodOk() (*string, bool)` + +GetMethodOk returns a tuple with the Method field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMethod + +`func (o *Recommendation) SetMethod(v string)` + +SetMethod sets Method field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RecommendationConfigDto.md b/docs/tools/sdk/go/Reference/V2025/Models/RecommendationConfigDto.md new file mode 100644 index 000000000..a3a439ad1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RecommendationConfigDto.md @@ -0,0 +1,142 @@ +--- +id: v2025-recommendation-config-dto +title: RecommendationConfigDto +pagination_label: RecommendationConfigDto +sidebar_label: RecommendationConfigDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommendationConfigDto', 'V2025RecommendationConfigDto'] +slug: /tools/sdk/go/v2025/models/recommendation-config-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationConfigDto', 'V2025RecommendationConfigDto'] +--- + +# RecommendationConfigDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RecommenderFeatures** | Pointer to **[]string** | List of identity attributes to use for calculating certification recommendations | [optional] +**PeerGroupPercentageThreshold** | Pointer to **float32** | The percent value that the recommendation calculation must surpass to produce a YES recommendation | [optional] +**RunAutoSelectOnce** | Pointer to **bool** | If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run | [optional] [default to false] +**OnlyTuneThreshold** | Pointer to **bool** | If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run | [optional] [default to false] + +## Methods + +### NewRecommendationConfigDto + +`func NewRecommendationConfigDto() *RecommendationConfigDto` + +NewRecommendationConfigDto instantiates a new RecommendationConfigDto 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 + +### NewRecommendationConfigDtoWithDefaults + +`func NewRecommendationConfigDtoWithDefaults() *RecommendationConfigDto` + +NewRecommendationConfigDtoWithDefaults instantiates a new RecommendationConfigDto 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 + +### GetRecommenderFeatures + +`func (o *RecommendationConfigDto) GetRecommenderFeatures() []string` + +GetRecommenderFeatures returns the RecommenderFeatures field if non-nil, zero value otherwise. + +### GetRecommenderFeaturesOk + +`func (o *RecommendationConfigDto) GetRecommenderFeaturesOk() (*[]string, bool)` + +GetRecommenderFeaturesOk returns a tuple with the RecommenderFeatures field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommenderFeatures + +`func (o *RecommendationConfigDto) SetRecommenderFeatures(v []string)` + +SetRecommenderFeatures sets RecommenderFeatures field to given value. + +### HasRecommenderFeatures + +`func (o *RecommendationConfigDto) HasRecommenderFeatures() bool` + +HasRecommenderFeatures returns a boolean if a field has been set. + +### GetPeerGroupPercentageThreshold + +`func (o *RecommendationConfigDto) GetPeerGroupPercentageThreshold() float32` + +GetPeerGroupPercentageThreshold returns the PeerGroupPercentageThreshold field if non-nil, zero value otherwise. + +### GetPeerGroupPercentageThresholdOk + +`func (o *RecommendationConfigDto) GetPeerGroupPercentageThresholdOk() (*float32, bool)` + +GetPeerGroupPercentageThresholdOk returns a tuple with the PeerGroupPercentageThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPeerGroupPercentageThreshold + +`func (o *RecommendationConfigDto) SetPeerGroupPercentageThreshold(v float32)` + +SetPeerGroupPercentageThreshold sets PeerGroupPercentageThreshold field to given value. + +### HasPeerGroupPercentageThreshold + +`func (o *RecommendationConfigDto) HasPeerGroupPercentageThreshold() bool` + +HasPeerGroupPercentageThreshold returns a boolean if a field has been set. + +### GetRunAutoSelectOnce + +`func (o *RecommendationConfigDto) GetRunAutoSelectOnce() bool` + +GetRunAutoSelectOnce returns the RunAutoSelectOnce field if non-nil, zero value otherwise. + +### GetRunAutoSelectOnceOk + +`func (o *RecommendationConfigDto) GetRunAutoSelectOnceOk() (*bool, bool)` + +GetRunAutoSelectOnceOk returns a tuple with the RunAutoSelectOnce field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRunAutoSelectOnce + +`func (o *RecommendationConfigDto) SetRunAutoSelectOnce(v bool)` + +SetRunAutoSelectOnce sets RunAutoSelectOnce field to given value. + +### HasRunAutoSelectOnce + +`func (o *RecommendationConfigDto) HasRunAutoSelectOnce() bool` + +HasRunAutoSelectOnce returns a boolean if a field has been set. + +### GetOnlyTuneThreshold + +`func (o *RecommendationConfigDto) GetOnlyTuneThreshold() bool` + +GetOnlyTuneThreshold returns the OnlyTuneThreshold field if non-nil, zero value otherwise. + +### GetOnlyTuneThresholdOk + +`func (o *RecommendationConfigDto) GetOnlyTuneThresholdOk() (*bool, bool)` + +GetOnlyTuneThresholdOk returns a tuple with the OnlyTuneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOnlyTuneThreshold + +`func (o *RecommendationConfigDto) SetOnlyTuneThreshold(v bool)` + +SetOnlyTuneThreshold sets OnlyTuneThreshold field to given value. + +### HasOnlyTuneThreshold + +`func (o *RecommendationConfigDto) HasOnlyTuneThreshold() bool` + +HasOnlyTuneThreshold returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RecommendationRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/RecommendationRequest.md new file mode 100644 index 000000000..b88a60976 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RecommendationRequest.md @@ -0,0 +1,90 @@ +--- +id: v2025-recommendation-request +title: RecommendationRequest +pagination_label: RecommendationRequest +sidebar_label: RecommendationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommendationRequest', 'V2025RecommendationRequest'] +slug: /tools/sdk/go/v2025/models/recommendation-request +tags: ['SDK', 'Software Development Kit', 'RecommendationRequest', 'V2025RecommendationRequest'] +--- + +# RecommendationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | The identity ID | [optional] +**Item** | Pointer to [**AccessItemRef**](access-item-ref) | | [optional] + +## Methods + +### NewRecommendationRequest + +`func NewRecommendationRequest() *RecommendationRequest` + +NewRecommendationRequest instantiates a new RecommendationRequest 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 + +### NewRecommendationRequestWithDefaults + +`func NewRecommendationRequestWithDefaults() *RecommendationRequest` + +NewRecommendationRequestWithDefaults instantiates a new RecommendationRequest 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 + +### GetIdentityId + +`func (o *RecommendationRequest) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *RecommendationRequest) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *RecommendationRequest) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *RecommendationRequest) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetItem + +`func (o *RecommendationRequest) GetItem() AccessItemRef` + +GetItem returns the Item field if non-nil, zero value otherwise. + +### GetItemOk + +`func (o *RecommendationRequest) GetItemOk() (*AccessItemRef, bool)` + +GetItemOk returns a tuple with the Item field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItem + +`func (o *RecommendationRequest) SetItem(v AccessItemRef)` + +SetItem sets Item field to given value. + +### HasItem + +`func (o *RecommendationRequest) HasItem() bool` + +HasItem returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RecommendationRequestDto.md b/docs/tools/sdk/go/Reference/V2025/Models/RecommendationRequestDto.md new file mode 100644 index 000000000..a0df889f6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RecommendationRequestDto.md @@ -0,0 +1,168 @@ +--- +id: v2025-recommendation-request-dto +title: RecommendationRequestDto +pagination_label: RecommendationRequestDto +sidebar_label: RecommendationRequestDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommendationRequestDto', 'V2025RecommendationRequestDto'] +slug: /tools/sdk/go/v2025/models/recommendation-request-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationRequestDto', 'V2025RecommendationRequestDto'] +--- + +# RecommendationRequestDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Requests** | Pointer to [**[]RecommendationRequest**](recommendation-request) | | [optional] +**ExcludeInterpretations** | Pointer to **bool** | Exclude interpretations in the response if \"true\". Return interpretations in the response if this attribute is not specified. | [optional] [default to false] +**IncludeTranslationMessages** | Pointer to **bool** | When set to true, the calling system uses the translated messages for the specified language | [optional] [default to false] +**IncludeDebugInformation** | Pointer to **bool** | Returns the recommender calculations if set to true | [optional] [default to false] +**PrescribeMode** | Pointer to **bool** | When set to true, uses prescribedRulesRecommenderConfig to get identity attributes and peer group threshold instead of standard config. | [optional] [default to false] + +## Methods + +### NewRecommendationRequestDto + +`func NewRecommendationRequestDto() *RecommendationRequestDto` + +NewRecommendationRequestDto instantiates a new RecommendationRequestDto 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 + +### NewRecommendationRequestDtoWithDefaults + +`func NewRecommendationRequestDtoWithDefaults() *RecommendationRequestDto` + +NewRecommendationRequestDtoWithDefaults instantiates a new RecommendationRequestDto 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 + +### GetRequests + +`func (o *RecommendationRequestDto) GetRequests() []RecommendationRequest` + +GetRequests returns the Requests field if non-nil, zero value otherwise. + +### GetRequestsOk + +`func (o *RecommendationRequestDto) GetRequestsOk() (*[]RecommendationRequest, bool)` + +GetRequestsOk returns a tuple with the Requests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequests + +`func (o *RecommendationRequestDto) SetRequests(v []RecommendationRequest)` + +SetRequests sets Requests field to given value. + +### HasRequests + +`func (o *RecommendationRequestDto) HasRequests() bool` + +HasRequests returns a boolean if a field has been set. + +### GetExcludeInterpretations + +`func (o *RecommendationRequestDto) GetExcludeInterpretations() bool` + +GetExcludeInterpretations returns the ExcludeInterpretations field if non-nil, zero value otherwise. + +### GetExcludeInterpretationsOk + +`func (o *RecommendationRequestDto) GetExcludeInterpretationsOk() (*bool, bool)` + +GetExcludeInterpretationsOk returns a tuple with the ExcludeInterpretations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludeInterpretations + +`func (o *RecommendationRequestDto) SetExcludeInterpretations(v bool)` + +SetExcludeInterpretations sets ExcludeInterpretations field to given value. + +### HasExcludeInterpretations + +`func (o *RecommendationRequestDto) HasExcludeInterpretations() bool` + +HasExcludeInterpretations returns a boolean if a field has been set. + +### GetIncludeTranslationMessages + +`func (o *RecommendationRequestDto) GetIncludeTranslationMessages() bool` + +GetIncludeTranslationMessages returns the IncludeTranslationMessages field if non-nil, zero value otherwise. + +### GetIncludeTranslationMessagesOk + +`func (o *RecommendationRequestDto) GetIncludeTranslationMessagesOk() (*bool, bool)` + +GetIncludeTranslationMessagesOk returns a tuple with the IncludeTranslationMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTranslationMessages + +`func (o *RecommendationRequestDto) SetIncludeTranslationMessages(v bool)` + +SetIncludeTranslationMessages sets IncludeTranslationMessages field to given value. + +### HasIncludeTranslationMessages + +`func (o *RecommendationRequestDto) HasIncludeTranslationMessages() bool` + +HasIncludeTranslationMessages returns a boolean if a field has been set. + +### GetIncludeDebugInformation + +`func (o *RecommendationRequestDto) GetIncludeDebugInformation() bool` + +GetIncludeDebugInformation returns the IncludeDebugInformation field if non-nil, zero value otherwise. + +### GetIncludeDebugInformationOk + +`func (o *RecommendationRequestDto) GetIncludeDebugInformationOk() (*bool, bool)` + +GetIncludeDebugInformationOk returns a tuple with the IncludeDebugInformation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeDebugInformation + +`func (o *RecommendationRequestDto) SetIncludeDebugInformation(v bool)` + +SetIncludeDebugInformation sets IncludeDebugInformation field to given value. + +### HasIncludeDebugInformation + +`func (o *RecommendationRequestDto) HasIncludeDebugInformation() bool` + +HasIncludeDebugInformation returns a boolean if a field has been set. + +### GetPrescribeMode + +`func (o *RecommendationRequestDto) GetPrescribeMode() bool` + +GetPrescribeMode returns the PrescribeMode field if non-nil, zero value otherwise. + +### GetPrescribeModeOk + +`func (o *RecommendationRequestDto) GetPrescribeModeOk() (*bool, bool)` + +GetPrescribeModeOk returns a tuple with the PrescribeMode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrescribeMode + +`func (o *RecommendationRequestDto) SetPrescribeMode(v bool)` + +SetPrescribeMode sets PrescribeMode field to given value. + +### HasPrescribeMode + +`func (o *RecommendationRequestDto) HasPrescribeMode() bool` + +HasPrescribeMode returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RecommendationResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/RecommendationResponse.md new file mode 100644 index 000000000..7357fb208 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RecommendationResponse.md @@ -0,0 +1,168 @@ +--- +id: v2025-recommendation-response +title: RecommendationResponse +pagination_label: RecommendationResponse +sidebar_label: RecommendationResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommendationResponse', 'V2025RecommendationResponse'] +slug: /tools/sdk/go/v2025/models/recommendation-response +tags: ['SDK', 'Software Development Kit', 'RecommendationResponse', 'V2025RecommendationResponse'] +--- + +# RecommendationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Request** | Pointer to [**RecommendationRequest**](recommendation-request) | | [optional] +**Recommendation** | Pointer to **string** | The recommendation - YES if the access is recommended, NO if not recommended, MAYBE if there is not enough information to make a recommendation, NOT_FOUND if the identity is not found in the system | [optional] +**Interpretations** | Pointer to **[]string** | The list of interpretations explaining the recommendation. The array is empty if includeInterpretations is false or not present in the request. e.g. - [ \"Not approved in the last 6 months.\" ]. Interpretations will be translated using the client's locale as found in the Accept-Language header. If a translation for the client's locale cannot be found, the US English translation will be returned. | [optional] +**TranslationMessages** | Pointer to [**[]TranslationMessage**](translation-message) | The list of translation messages, if they have been requested. | [optional] +**RecommenderCalculations** | Pointer to [**RecommenderCalculations**](recommender-calculations) | | [optional] + +## Methods + +### NewRecommendationResponse + +`func NewRecommendationResponse() *RecommendationResponse` + +NewRecommendationResponse instantiates a new RecommendationResponse 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 + +### NewRecommendationResponseWithDefaults + +`func NewRecommendationResponseWithDefaults() *RecommendationResponse` + +NewRecommendationResponseWithDefaults instantiates a new RecommendationResponse 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 + +### GetRequest + +`func (o *RecommendationResponse) GetRequest() RecommendationRequest` + +GetRequest returns the Request field if non-nil, zero value otherwise. + +### GetRequestOk + +`func (o *RecommendationResponse) GetRequestOk() (*RecommendationRequest, bool)` + +GetRequestOk returns a tuple with the Request field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequest + +`func (o *RecommendationResponse) SetRequest(v RecommendationRequest)` + +SetRequest sets Request field to given value. + +### HasRequest + +`func (o *RecommendationResponse) HasRequest() bool` + +HasRequest returns a boolean if a field has been set. + +### GetRecommendation + +`func (o *RecommendationResponse) GetRecommendation() string` + +GetRecommendation returns the Recommendation field if non-nil, zero value otherwise. + +### GetRecommendationOk + +`func (o *RecommendationResponse) GetRecommendationOk() (*string, bool)` + +GetRecommendationOk returns a tuple with the Recommendation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendation + +`func (o *RecommendationResponse) SetRecommendation(v string)` + +SetRecommendation sets Recommendation field to given value. + +### HasRecommendation + +`func (o *RecommendationResponse) HasRecommendation() bool` + +HasRecommendation returns a boolean if a field has been set. + +### GetInterpretations + +`func (o *RecommendationResponse) GetInterpretations() []string` + +GetInterpretations returns the Interpretations field if non-nil, zero value otherwise. + +### GetInterpretationsOk + +`func (o *RecommendationResponse) GetInterpretationsOk() (*[]string, bool)` + +GetInterpretationsOk returns a tuple with the Interpretations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterpretations + +`func (o *RecommendationResponse) SetInterpretations(v []string)` + +SetInterpretations sets Interpretations field to given value. + +### HasInterpretations + +`func (o *RecommendationResponse) HasInterpretations() bool` + +HasInterpretations returns a boolean if a field has been set. + +### GetTranslationMessages + +`func (o *RecommendationResponse) GetTranslationMessages() []TranslationMessage` + +GetTranslationMessages returns the TranslationMessages field if non-nil, zero value otherwise. + +### GetTranslationMessagesOk + +`func (o *RecommendationResponse) GetTranslationMessagesOk() (*[]TranslationMessage, bool)` + +GetTranslationMessagesOk returns a tuple with the TranslationMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslationMessages + +`func (o *RecommendationResponse) SetTranslationMessages(v []TranslationMessage)` + +SetTranslationMessages sets TranslationMessages field to given value. + +### HasTranslationMessages + +`func (o *RecommendationResponse) HasTranslationMessages() bool` + +HasTranslationMessages returns a boolean if a field has been set. + +### GetRecommenderCalculations + +`func (o *RecommendationResponse) GetRecommenderCalculations() RecommenderCalculations` + +GetRecommenderCalculations returns the RecommenderCalculations field if non-nil, zero value otherwise. + +### GetRecommenderCalculationsOk + +`func (o *RecommendationResponse) GetRecommenderCalculationsOk() (*RecommenderCalculations, bool)` + +GetRecommenderCalculationsOk returns a tuple with the RecommenderCalculations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommenderCalculations + +`func (o *RecommendationResponse) SetRecommenderCalculations(v RecommenderCalculations)` + +SetRecommenderCalculations sets RecommenderCalculations field to given value. + +### HasRecommenderCalculations + +`func (o *RecommendationResponse) HasRecommenderCalculations() bool` + +HasRecommenderCalculations returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RecommendationResponseDto.md b/docs/tools/sdk/go/Reference/V2025/Models/RecommendationResponseDto.md new file mode 100644 index 000000000..823c1ce76 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RecommendationResponseDto.md @@ -0,0 +1,64 @@ +--- +id: v2025-recommendation-response-dto +title: RecommendationResponseDto +pagination_label: RecommendationResponseDto +sidebar_label: RecommendationResponseDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommendationResponseDto', 'V2025RecommendationResponseDto'] +slug: /tools/sdk/go/v2025/models/recommendation-response-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationResponseDto', 'V2025RecommendationResponseDto'] +--- + +# RecommendationResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Response** | Pointer to [**[]RecommendationResponse**](recommendation-response) | | [optional] + +## Methods + +### NewRecommendationResponseDto + +`func NewRecommendationResponseDto() *RecommendationResponseDto` + +NewRecommendationResponseDto instantiates a new RecommendationResponseDto 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 + +### NewRecommendationResponseDtoWithDefaults + +`func NewRecommendationResponseDtoWithDefaults() *RecommendationResponseDto` + +NewRecommendationResponseDtoWithDefaults instantiates a new RecommendationResponseDto 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 + +### GetResponse + +`func (o *RecommendationResponseDto) GetResponse() []RecommendationResponse` + +GetResponse returns the Response field if non-nil, zero value otherwise. + +### GetResponseOk + +`func (o *RecommendationResponseDto) GetResponseOk() (*[]RecommendationResponse, bool)` + +GetResponseOk returns a tuple with the Response field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponse + +`func (o *RecommendationResponseDto) SetResponse(v []RecommendationResponse)` + +SetResponse sets Response field to given value. + +### HasResponse + +`func (o *RecommendationResponseDto) HasResponse() bool` + +HasResponse returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RecommenderCalculations.md b/docs/tools/sdk/go/Reference/V2025/Models/RecommenderCalculations.md new file mode 100644 index 000000000..55b0149d0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RecommenderCalculations.md @@ -0,0 +1,246 @@ +--- +id: v2025-recommender-calculations +title: RecommenderCalculations +pagination_label: RecommenderCalculations +sidebar_label: RecommenderCalculations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommenderCalculations', 'V2025RecommenderCalculations'] +slug: /tools/sdk/go/v2025/models/recommender-calculations +tags: ['SDK', 'Software Development Kit', 'RecommenderCalculations', 'V2025RecommenderCalculations'] +--- + +# RecommenderCalculations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | The ID of the identity | [optional] +**EntitlementId** | Pointer to **string** | The entitlement ID | [optional] +**Recommendation** | Pointer to **string** | The actual recommendation | [optional] +**OverallWeightedScore** | Pointer to **float32** | The overall weighted score | [optional] +**FeatureWeightedScores** | Pointer to **map[string]float32** | The weighted score of each individual feature | [optional] +**Threshold** | Pointer to **float32** | The configured value against which the overallWeightedScore is compared | [optional] +**IdentityAttributes** | Pointer to [**map[string]RecommenderCalculationsIdentityAttributesValue**](recommender-calculations-identity-attributes-value) | The values for your configured features | [optional] +**FeatureValues** | Pointer to [**FeatureValueDto**](feature-value-dto) | | [optional] + +## Methods + +### NewRecommenderCalculations + +`func NewRecommenderCalculations() *RecommenderCalculations` + +NewRecommenderCalculations instantiates a new RecommenderCalculations 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 + +### NewRecommenderCalculationsWithDefaults + +`func NewRecommenderCalculationsWithDefaults() *RecommenderCalculations` + +NewRecommenderCalculationsWithDefaults instantiates a new RecommenderCalculations 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 + +### GetIdentityId + +`func (o *RecommenderCalculations) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *RecommenderCalculations) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *RecommenderCalculations) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *RecommenderCalculations) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEntitlementId + +`func (o *RecommenderCalculations) GetEntitlementId() string` + +GetEntitlementId returns the EntitlementId field if non-nil, zero value otherwise. + +### GetEntitlementIdOk + +`func (o *RecommenderCalculations) GetEntitlementIdOk() (*string, bool)` + +GetEntitlementIdOk returns a tuple with the EntitlementId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementId + +`func (o *RecommenderCalculations) SetEntitlementId(v string)` + +SetEntitlementId sets EntitlementId field to given value. + +### HasEntitlementId + +`func (o *RecommenderCalculations) HasEntitlementId() bool` + +HasEntitlementId returns a boolean if a field has been set. + +### GetRecommendation + +`func (o *RecommenderCalculations) GetRecommendation() string` + +GetRecommendation returns the Recommendation field if non-nil, zero value otherwise. + +### GetRecommendationOk + +`func (o *RecommenderCalculations) GetRecommendationOk() (*string, bool)` + +GetRecommendationOk returns a tuple with the Recommendation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendation + +`func (o *RecommenderCalculations) SetRecommendation(v string)` + +SetRecommendation sets Recommendation field to given value. + +### HasRecommendation + +`func (o *RecommenderCalculations) HasRecommendation() bool` + +HasRecommendation returns a boolean if a field has been set. + +### GetOverallWeightedScore + +`func (o *RecommenderCalculations) GetOverallWeightedScore() float32` + +GetOverallWeightedScore returns the OverallWeightedScore field if non-nil, zero value otherwise. + +### GetOverallWeightedScoreOk + +`func (o *RecommenderCalculations) GetOverallWeightedScoreOk() (*float32, bool)` + +GetOverallWeightedScoreOk returns a tuple with the OverallWeightedScore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOverallWeightedScore + +`func (o *RecommenderCalculations) SetOverallWeightedScore(v float32)` + +SetOverallWeightedScore sets OverallWeightedScore field to given value. + +### HasOverallWeightedScore + +`func (o *RecommenderCalculations) HasOverallWeightedScore() bool` + +HasOverallWeightedScore returns a boolean if a field has been set. + +### GetFeatureWeightedScores + +`func (o *RecommenderCalculations) GetFeatureWeightedScores() map[string]float32` + +GetFeatureWeightedScores returns the FeatureWeightedScores field if non-nil, zero value otherwise. + +### GetFeatureWeightedScoresOk + +`func (o *RecommenderCalculations) GetFeatureWeightedScoresOk() (*map[string]float32, bool)` + +GetFeatureWeightedScoresOk returns a tuple with the FeatureWeightedScores field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureWeightedScores + +`func (o *RecommenderCalculations) SetFeatureWeightedScores(v map[string]float32)` + +SetFeatureWeightedScores sets FeatureWeightedScores field to given value. + +### HasFeatureWeightedScores + +`func (o *RecommenderCalculations) HasFeatureWeightedScores() bool` + +HasFeatureWeightedScores returns a boolean if a field has been set. + +### GetThreshold + +`func (o *RecommenderCalculations) GetThreshold() float32` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *RecommenderCalculations) GetThresholdOk() (*float32, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *RecommenderCalculations) SetThreshold(v float32)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *RecommenderCalculations) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetIdentityAttributes + +`func (o *RecommenderCalculations) GetIdentityAttributes() map[string]RecommenderCalculationsIdentityAttributesValue` + +GetIdentityAttributes returns the IdentityAttributes field if non-nil, zero value otherwise. + +### GetIdentityAttributesOk + +`func (o *RecommenderCalculations) GetIdentityAttributesOk() (*map[string]RecommenderCalculationsIdentityAttributesValue, bool)` + +GetIdentityAttributesOk returns a tuple with the IdentityAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributes + +`func (o *RecommenderCalculations) SetIdentityAttributes(v map[string]RecommenderCalculationsIdentityAttributesValue)` + +SetIdentityAttributes sets IdentityAttributes field to given value. + +### HasIdentityAttributes + +`func (o *RecommenderCalculations) HasIdentityAttributes() bool` + +HasIdentityAttributes returns a boolean if a field has been set. + +### GetFeatureValues + +`func (o *RecommenderCalculations) GetFeatureValues() FeatureValueDto` + +GetFeatureValues returns the FeatureValues field if non-nil, zero value otherwise. + +### GetFeatureValuesOk + +`func (o *RecommenderCalculations) GetFeatureValuesOk() (*FeatureValueDto, bool)` + +GetFeatureValuesOk returns a tuple with the FeatureValues field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureValues + +`func (o *RecommenderCalculations) SetFeatureValues(v FeatureValueDto)` + +SetFeatureValues sets FeatureValues field to given value. + +### HasFeatureValues + +`func (o *RecommenderCalculations) HasFeatureValues() bool` + +HasFeatureValues returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RecommenderCalculationsIdentityAttributesValue.md b/docs/tools/sdk/go/Reference/V2025/Models/RecommenderCalculationsIdentityAttributesValue.md new file mode 100644 index 000000000..226cbddb4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RecommenderCalculationsIdentityAttributesValue.md @@ -0,0 +1,64 @@ +--- +id: v2025-recommender-calculations-identity-attributes-value +title: RecommenderCalculationsIdentityAttributesValue +pagination_label: RecommenderCalculationsIdentityAttributesValue +sidebar_label: RecommenderCalculationsIdentityAttributesValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RecommenderCalculationsIdentityAttributesValue', 'V2025RecommenderCalculationsIdentityAttributesValue'] +slug: /tools/sdk/go/v2025/models/recommender-calculations-identity-attributes-value +tags: ['SDK', 'Software Development Kit', 'RecommenderCalculationsIdentityAttributesValue', 'V2025RecommenderCalculationsIdentityAttributesValue'] +--- + +# RecommenderCalculationsIdentityAttributesValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | | [optional] + +## Methods + +### NewRecommenderCalculationsIdentityAttributesValue + +`func NewRecommenderCalculationsIdentityAttributesValue() *RecommenderCalculationsIdentityAttributesValue` + +NewRecommenderCalculationsIdentityAttributesValue instantiates a new RecommenderCalculationsIdentityAttributesValue 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 + +### NewRecommenderCalculationsIdentityAttributesValueWithDefaults + +`func NewRecommenderCalculationsIdentityAttributesValueWithDefaults() *RecommenderCalculationsIdentityAttributesValue` + +NewRecommenderCalculationsIdentityAttributesValueWithDefaults instantiates a new RecommenderCalculationsIdentityAttributesValue 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 + +### GetValue + +`func (o *RecommenderCalculationsIdentityAttributesValue) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *RecommenderCalculationsIdentityAttributesValue) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *RecommenderCalculationsIdentityAttributesValue) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *RecommenderCalculationsIdentityAttributesValue) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Ref.md b/docs/tools/sdk/go/Reference/V2025/Models/Ref.md new file mode 100644 index 000000000..4a6922246 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Ref.md @@ -0,0 +1,90 @@ +--- +id: v2025-ref +title: Ref +pagination_label: Ref +sidebar_label: Ref +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Ref', 'V2025Ref'] +slug: /tools/sdk/go/v2025/models/ref +tags: ['SDK', 'Software Development Kit', 'Ref', 'V2025Ref'] +--- + +# Ref + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] + +## Methods + +### NewRef + +`func NewRef() *Ref` + +NewRef instantiates a new Ref 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 + +### NewRefWithDefaults + +`func NewRefWithDefaults() *Ref` + +NewRefWithDefaults instantiates a new Ref 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 + +### GetType + +`func (o *Ref) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Ref) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Ref) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Ref) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *Ref) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Ref) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Ref) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Ref) HasId() bool` + +HasId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Reference.md b/docs/tools/sdk/go/Reference/V2025/Models/Reference.md new file mode 100644 index 000000000..913332936 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Reference.md @@ -0,0 +1,90 @@ +--- +id: v2025-reference +title: Reference +pagination_label: Reference +sidebar_label: Reference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Reference', 'V2025Reference'] +slug: /tools/sdk/go/v2025/models/reference +tags: ['SDK', 'Software Development Kit', 'Reference', 'V2025Reference'] +--- + +# Reference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] + +## Methods + +### NewReference + +`func NewReference() *Reference` + +NewReference instantiates a new Reference 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 + +### NewReferenceWithDefaults + +`func NewReferenceWithDefaults() *Reference` + +NewReferenceWithDefaults instantiates a new Reference 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 + +### GetId + +`func (o *Reference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Reference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Reference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Reference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Reference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Reference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Reference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Reference) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RemediationItemDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/RemediationItemDetails.md new file mode 100644 index 000000000..a026fc39c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RemediationItemDetails.md @@ -0,0 +1,272 @@ +--- +id: v2025-remediation-item-details +title: RemediationItemDetails +pagination_label: RemediationItemDetails +sidebar_label: RemediationItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RemediationItemDetails', 'V2025RemediationItemDetails'] +slug: /tools/sdk/go/v2025/models/remediation-item-details +tags: ['SDK', 'Software Development Kit', 'RemediationItemDetails', 'V2025RemediationItemDetails'] +--- + +# RemediationItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the certification | [optional] +**TargetId** | Pointer to **string** | The ID of the certification target | [optional] +**TargetName** | Pointer to **string** | The name of the certification target | [optional] +**TargetDisplayName** | Pointer to **string** | The display name of the certification target | [optional] +**ApplicationName** | Pointer to **string** | The name of the application/source | [optional] +**AttributeName** | Pointer to **string** | The name of the attribute being certified | [optional] +**AttributeOperation** | Pointer to **string** | The operation of the certification on the attribute | [optional] +**AttributeValue** | Pointer to **string** | The value of the attribute being certified | [optional] +**NativeIdentity** | Pointer to **string** | The native identity of the target | [optional] + +## Methods + +### NewRemediationItemDetails + +`func NewRemediationItemDetails() *RemediationItemDetails` + +NewRemediationItemDetails instantiates a new RemediationItemDetails 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 + +### NewRemediationItemDetailsWithDefaults + +`func NewRemediationItemDetailsWithDefaults() *RemediationItemDetails` + +NewRemediationItemDetailsWithDefaults instantiates a new RemediationItemDetails 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 + +### GetId + +`func (o *RemediationItemDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RemediationItemDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RemediationItemDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RemediationItemDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetTargetId + +`func (o *RemediationItemDetails) GetTargetId() string` + +GetTargetId returns the TargetId field if non-nil, zero value otherwise. + +### GetTargetIdOk + +`func (o *RemediationItemDetails) GetTargetIdOk() (*string, bool)` + +GetTargetIdOk returns a tuple with the TargetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetId + +`func (o *RemediationItemDetails) SetTargetId(v string)` + +SetTargetId sets TargetId field to given value. + +### HasTargetId + +`func (o *RemediationItemDetails) HasTargetId() bool` + +HasTargetId returns a boolean if a field has been set. + +### GetTargetName + +`func (o *RemediationItemDetails) GetTargetName() string` + +GetTargetName returns the TargetName field if non-nil, zero value otherwise. + +### GetTargetNameOk + +`func (o *RemediationItemDetails) GetTargetNameOk() (*string, bool)` + +GetTargetNameOk returns a tuple with the TargetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetName + +`func (o *RemediationItemDetails) SetTargetName(v string)` + +SetTargetName sets TargetName field to given value. + +### HasTargetName + +`func (o *RemediationItemDetails) HasTargetName() bool` + +HasTargetName returns a boolean if a field has been set. + +### GetTargetDisplayName + +`func (o *RemediationItemDetails) GetTargetDisplayName() string` + +GetTargetDisplayName returns the TargetDisplayName field if non-nil, zero value otherwise. + +### GetTargetDisplayNameOk + +`func (o *RemediationItemDetails) GetTargetDisplayNameOk() (*string, bool)` + +GetTargetDisplayNameOk returns a tuple with the TargetDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetDisplayName + +`func (o *RemediationItemDetails) SetTargetDisplayName(v string)` + +SetTargetDisplayName sets TargetDisplayName field to given value. + +### HasTargetDisplayName + +`func (o *RemediationItemDetails) HasTargetDisplayName() bool` + +HasTargetDisplayName returns a boolean if a field has been set. + +### GetApplicationName + +`func (o *RemediationItemDetails) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *RemediationItemDetails) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *RemediationItemDetails) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *RemediationItemDetails) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *RemediationItemDetails) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *RemediationItemDetails) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *RemediationItemDetails) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *RemediationItemDetails) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + +### GetAttributeOperation + +`func (o *RemediationItemDetails) GetAttributeOperation() string` + +GetAttributeOperation returns the AttributeOperation field if non-nil, zero value otherwise. + +### GetAttributeOperationOk + +`func (o *RemediationItemDetails) GetAttributeOperationOk() (*string, bool)` + +GetAttributeOperationOk returns a tuple with the AttributeOperation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeOperation + +`func (o *RemediationItemDetails) SetAttributeOperation(v string)` + +SetAttributeOperation sets AttributeOperation field to given value. + +### HasAttributeOperation + +`func (o *RemediationItemDetails) HasAttributeOperation() bool` + +HasAttributeOperation returns a boolean if a field has been set. + +### GetAttributeValue + +`func (o *RemediationItemDetails) GetAttributeValue() string` + +GetAttributeValue returns the AttributeValue field if non-nil, zero value otherwise. + +### GetAttributeValueOk + +`func (o *RemediationItemDetails) GetAttributeValueOk() (*string, bool)` + +GetAttributeValueOk returns a tuple with the AttributeValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeValue + +`func (o *RemediationItemDetails) SetAttributeValue(v string)` + +SetAttributeValue sets AttributeValue field to given value. + +### HasAttributeValue + +`func (o *RemediationItemDetails) HasAttributeValue() bool` + +HasAttributeValue returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *RemediationItemDetails) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *RemediationItemDetails) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *RemediationItemDetails) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *RemediationItemDetails) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RemediationItems.md b/docs/tools/sdk/go/Reference/V2025/Models/RemediationItems.md new file mode 100644 index 000000000..1820a9661 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RemediationItems.md @@ -0,0 +1,272 @@ +--- +id: v2025-remediation-items +title: RemediationItems +pagination_label: RemediationItems +sidebar_label: RemediationItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RemediationItems', 'V2025RemediationItems'] +slug: /tools/sdk/go/v2025/models/remediation-items +tags: ['SDK', 'Software Development Kit', 'RemediationItems', 'V2025RemediationItems'] +--- + +# RemediationItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the certification | [optional] +**TargetId** | Pointer to **string** | The ID of the certification target | [optional] +**TargetName** | Pointer to **string** | The name of the certification target | [optional] +**TargetDisplayName** | Pointer to **string** | The display name of the certification target | [optional] +**ApplicationName** | Pointer to **string** | The name of the application/source | [optional] +**AttributeName** | Pointer to **string** | The name of the attribute being certified | [optional] +**AttributeOperation** | Pointer to **string** | The operation of the certification on the attribute | [optional] +**AttributeValue** | Pointer to **string** | The value of the attribute being certified | [optional] +**NativeIdentity** | Pointer to **string** | The native identity of the target | [optional] + +## Methods + +### NewRemediationItems + +`func NewRemediationItems() *RemediationItems` + +NewRemediationItems instantiates a new RemediationItems 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 + +### NewRemediationItemsWithDefaults + +`func NewRemediationItemsWithDefaults() *RemediationItems` + +NewRemediationItemsWithDefaults instantiates a new RemediationItems 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 + +### GetId + +`func (o *RemediationItems) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RemediationItems) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RemediationItems) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RemediationItems) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetTargetId + +`func (o *RemediationItems) GetTargetId() string` + +GetTargetId returns the TargetId field if non-nil, zero value otherwise. + +### GetTargetIdOk + +`func (o *RemediationItems) GetTargetIdOk() (*string, bool)` + +GetTargetIdOk returns a tuple with the TargetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetId + +`func (o *RemediationItems) SetTargetId(v string)` + +SetTargetId sets TargetId field to given value. + +### HasTargetId + +`func (o *RemediationItems) HasTargetId() bool` + +HasTargetId returns a boolean if a field has been set. + +### GetTargetName + +`func (o *RemediationItems) GetTargetName() string` + +GetTargetName returns the TargetName field if non-nil, zero value otherwise. + +### GetTargetNameOk + +`func (o *RemediationItems) GetTargetNameOk() (*string, bool)` + +GetTargetNameOk returns a tuple with the TargetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetName + +`func (o *RemediationItems) SetTargetName(v string)` + +SetTargetName sets TargetName field to given value. + +### HasTargetName + +`func (o *RemediationItems) HasTargetName() bool` + +HasTargetName returns a boolean if a field has been set. + +### GetTargetDisplayName + +`func (o *RemediationItems) GetTargetDisplayName() string` + +GetTargetDisplayName returns the TargetDisplayName field if non-nil, zero value otherwise. + +### GetTargetDisplayNameOk + +`func (o *RemediationItems) GetTargetDisplayNameOk() (*string, bool)` + +GetTargetDisplayNameOk returns a tuple with the TargetDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetDisplayName + +`func (o *RemediationItems) SetTargetDisplayName(v string)` + +SetTargetDisplayName sets TargetDisplayName field to given value. + +### HasTargetDisplayName + +`func (o *RemediationItems) HasTargetDisplayName() bool` + +HasTargetDisplayName returns a boolean if a field has been set. + +### GetApplicationName + +`func (o *RemediationItems) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *RemediationItems) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *RemediationItems) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *RemediationItems) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *RemediationItems) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *RemediationItems) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *RemediationItems) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *RemediationItems) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + +### GetAttributeOperation + +`func (o *RemediationItems) GetAttributeOperation() string` + +GetAttributeOperation returns the AttributeOperation field if non-nil, zero value otherwise. + +### GetAttributeOperationOk + +`func (o *RemediationItems) GetAttributeOperationOk() (*string, bool)` + +GetAttributeOperationOk returns a tuple with the AttributeOperation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeOperation + +`func (o *RemediationItems) SetAttributeOperation(v string)` + +SetAttributeOperation sets AttributeOperation field to given value. + +### HasAttributeOperation + +`func (o *RemediationItems) HasAttributeOperation() bool` + +HasAttributeOperation returns a boolean if a field has been set. + +### GetAttributeValue + +`func (o *RemediationItems) GetAttributeValue() string` + +GetAttributeValue returns the AttributeValue field if non-nil, zero value otherwise. + +### GetAttributeValueOk + +`func (o *RemediationItems) GetAttributeValueOk() (*string, bool)` + +GetAttributeValueOk returns a tuple with the AttributeValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeValue + +`func (o *RemediationItems) SetAttributeValue(v string)` + +SetAttributeValue sets AttributeValue field to given value. + +### HasAttributeValue + +`func (o *RemediationItems) HasAttributeValue() bool` + +HasAttributeValue returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *RemediationItems) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *RemediationItems) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *RemediationItems) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *RemediationItems) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReportConfigDTO.md b/docs/tools/sdk/go/Reference/V2025/Models/ReportConfigDTO.md new file mode 100644 index 000000000..d2497e958 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReportConfigDTO.md @@ -0,0 +1,142 @@ +--- +id: v2025-report-config-dto +title: ReportConfigDTO +pagination_label: ReportConfigDTO +sidebar_label: ReportConfigDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportConfigDTO', 'V2025ReportConfigDTO'] +slug: /tools/sdk/go/v2025/models/report-config-dto +tags: ['SDK', 'Software Development Kit', 'ReportConfigDTO', 'V2025ReportConfigDTO'] +--- + +# ReportConfigDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ColumnName** | Pointer to **string** | Name of column in report | [optional] +**Required** | Pointer to **bool** | If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column's definition. | [optional] [default to false] +**Included** | Pointer to **bool** | If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true. | [optional] [default to false] +**Order** | Pointer to **int32** | Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order. | [optional] + +## Methods + +### NewReportConfigDTO + +`func NewReportConfigDTO() *ReportConfigDTO` + +NewReportConfigDTO instantiates a new ReportConfigDTO 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 + +### NewReportConfigDTOWithDefaults + +`func NewReportConfigDTOWithDefaults() *ReportConfigDTO` + +NewReportConfigDTOWithDefaults instantiates a new ReportConfigDTO 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 + +### GetColumnName + +`func (o *ReportConfigDTO) GetColumnName() string` + +GetColumnName returns the ColumnName field if non-nil, zero value otherwise. + +### GetColumnNameOk + +`func (o *ReportConfigDTO) GetColumnNameOk() (*string, bool)` + +GetColumnNameOk returns a tuple with the ColumnName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumnName + +`func (o *ReportConfigDTO) SetColumnName(v string)` + +SetColumnName sets ColumnName field to given value. + +### HasColumnName + +`func (o *ReportConfigDTO) HasColumnName() bool` + +HasColumnName returns a boolean if a field has been set. + +### GetRequired + +`func (o *ReportConfigDTO) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *ReportConfigDTO) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *ReportConfigDTO) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *ReportConfigDTO) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + +### GetIncluded + +`func (o *ReportConfigDTO) GetIncluded() bool` + +GetIncluded returns the Included field if non-nil, zero value otherwise. + +### GetIncludedOk + +`func (o *ReportConfigDTO) GetIncludedOk() (*bool, bool)` + +GetIncludedOk returns a tuple with the Included field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncluded + +`func (o *ReportConfigDTO) SetIncluded(v bool)` + +SetIncluded sets Included field to given value. + +### HasIncluded + +`func (o *ReportConfigDTO) HasIncluded() bool` + +HasIncluded returns a boolean if a field has been set. + +### GetOrder + +`func (o *ReportConfigDTO) GetOrder() int32` + +GetOrder returns the Order field if non-nil, zero value otherwise. + +### GetOrderOk + +`func (o *ReportConfigDTO) GetOrderOk() (*int32, bool)` + +GetOrderOk returns a tuple with the Order field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrder + +`func (o *ReportConfigDTO) SetOrder(v int32)` + +SetOrder sets Order field to given value. + +### HasOrder + +`func (o *ReportConfigDTO) HasOrder() bool` + +HasOrder returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReportDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/ReportDetails.md new file mode 100644 index 000000000..63beacefe --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReportDetails.md @@ -0,0 +1,90 @@ +--- +id: v2025-report-details +title: ReportDetails +pagination_label: ReportDetails +sidebar_label: ReportDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportDetails', 'V2025ReportDetails'] +slug: /tools/sdk/go/v2025/models/report-details +tags: ['SDK', 'Software Development Kit', 'ReportDetails', 'V2025ReportDetails'] +--- + +# ReportDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReportType** | Pointer to **string** | Use this property to define what report should be processed in the RDE service. | [optional] +**Arguments** | Pointer to [**ReportDetailsArguments**](report-details-arguments) | | [optional] + +## Methods + +### NewReportDetails + +`func NewReportDetails() *ReportDetails` + +NewReportDetails instantiates a new ReportDetails 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 + +### NewReportDetailsWithDefaults + +`func NewReportDetailsWithDefaults() *ReportDetails` + +NewReportDetailsWithDefaults instantiates a new ReportDetails 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 + +### GetReportType + +`func (o *ReportDetails) GetReportType() string` + +GetReportType returns the ReportType field if non-nil, zero value otherwise. + +### GetReportTypeOk + +`func (o *ReportDetails) GetReportTypeOk() (*string, bool)` + +GetReportTypeOk returns a tuple with the ReportType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportType + +`func (o *ReportDetails) SetReportType(v string)` + +SetReportType sets ReportType field to given value. + +### HasReportType + +`func (o *ReportDetails) HasReportType() bool` + +HasReportType returns a boolean if a field has been set. + +### GetArguments + +`func (o *ReportDetails) GetArguments() ReportDetailsArguments` + +GetArguments returns the Arguments field if non-nil, zero value otherwise. + +### GetArgumentsOk + +`func (o *ReportDetails) GetArgumentsOk() (*ReportDetailsArguments, bool)` + +GetArgumentsOk returns a tuple with the Arguments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArguments + +`func (o *ReportDetails) SetArguments(v ReportDetailsArguments)` + +SetArguments sets Arguments field to given value. + +### HasArguments + +`func (o *ReportDetails) HasArguments() bool` + +HasArguments returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReportDetailsArguments.md b/docs/tools/sdk/go/Reference/V2025/Models/ReportDetailsArguments.md new file mode 100644 index 000000000..f4c00801f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReportDetailsArguments.md @@ -0,0 +1,247 @@ +--- +id: v2025-report-details-arguments +title: ReportDetailsArguments +pagination_label: ReportDetailsArguments +sidebar_label: ReportDetailsArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportDetailsArguments', 'V2025ReportDetailsArguments'] +slug: /tools/sdk/go/v2025/models/report-details-arguments +tags: ['SDK', 'Software Development Kit', 'ReportDetailsArguments', 'V2025ReportDetailsArguments'] +--- + +# ReportDetailsArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Application** | **string** | Source ID. | +**SourceName** | **string** | Source name. | +**CorrelatedOnly** | **bool** | Flag to specify if only correlated identities are included in report. | [default to false] +**AuthoritativeSource** | **string** | Source ID. | +**SelectedFormats** | Pointer to **[]string** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] +**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**Query** | **string** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | +**Columns** | Pointer to **string** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] + +## Methods + +### NewReportDetailsArguments + +`func NewReportDetailsArguments(application string, sourceName string, correlatedOnly bool, authoritativeSource string, query string, ) *ReportDetailsArguments` + +NewReportDetailsArguments instantiates a new ReportDetailsArguments 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 + +### NewReportDetailsArgumentsWithDefaults + +`func NewReportDetailsArgumentsWithDefaults() *ReportDetailsArguments` + +NewReportDetailsArgumentsWithDefaults instantiates a new ReportDetailsArguments 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 + +### GetApplication + +`func (o *ReportDetailsArguments) GetApplication() string` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *ReportDetailsArguments) GetApplicationOk() (*string, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *ReportDetailsArguments) SetApplication(v string)` + +SetApplication sets Application field to given value. + + +### GetSourceName + +`func (o *ReportDetailsArguments) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *ReportDetailsArguments) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *ReportDetailsArguments) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### GetCorrelatedOnly + +`func (o *ReportDetailsArguments) GetCorrelatedOnly() bool` + +GetCorrelatedOnly returns the CorrelatedOnly field if non-nil, zero value otherwise. + +### GetCorrelatedOnlyOk + +`func (o *ReportDetailsArguments) GetCorrelatedOnlyOk() (*bool, bool)` + +GetCorrelatedOnlyOk returns a tuple with the CorrelatedOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedOnly + +`func (o *ReportDetailsArguments) SetCorrelatedOnly(v bool)` + +SetCorrelatedOnly sets CorrelatedOnly field to given value. + + +### GetAuthoritativeSource + +`func (o *ReportDetailsArguments) GetAuthoritativeSource() string` + +GetAuthoritativeSource returns the AuthoritativeSource field if non-nil, zero value otherwise. + +### GetAuthoritativeSourceOk + +`func (o *ReportDetailsArguments) GetAuthoritativeSourceOk() (*string, bool)` + +GetAuthoritativeSourceOk returns a tuple with the AuthoritativeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritativeSource + +`func (o *ReportDetailsArguments) SetAuthoritativeSource(v string)` + +SetAuthoritativeSource sets AuthoritativeSource field to given value. + + +### GetSelectedFormats + +`func (o *ReportDetailsArguments) GetSelectedFormats() []string` + +GetSelectedFormats returns the SelectedFormats field if non-nil, zero value otherwise. + +### GetSelectedFormatsOk + +`func (o *ReportDetailsArguments) GetSelectedFormatsOk() (*[]string, bool)` + +GetSelectedFormatsOk returns a tuple with the SelectedFormats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectedFormats + +`func (o *ReportDetailsArguments) SetSelectedFormats(v []string)` + +SetSelectedFormats sets SelectedFormats field to given value. + +### HasSelectedFormats + +`func (o *ReportDetailsArguments) HasSelectedFormats() bool` + +HasSelectedFormats returns a boolean if a field has been set. + +### GetIndices + +`func (o *ReportDetailsArguments) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *ReportDetailsArguments) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *ReportDetailsArguments) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + +### HasIndices + +`func (o *ReportDetailsArguments) HasIndices() bool` + +HasIndices returns a boolean if a field has been set. + +### GetQuery + +`func (o *ReportDetailsArguments) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *ReportDetailsArguments) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *ReportDetailsArguments) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetColumns + +`func (o *ReportDetailsArguments) GetColumns() string` + +GetColumns returns the Columns field if non-nil, zero value otherwise. + +### GetColumnsOk + +`func (o *ReportDetailsArguments) GetColumnsOk() (*string, bool)` + +GetColumnsOk returns a tuple with the Columns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumns + +`func (o *ReportDetailsArguments) SetColumns(v string)` + +SetColumns sets Columns field to given value. + +### HasColumns + +`func (o *ReportDetailsArguments) HasColumns() bool` + +HasColumns returns a boolean if a field has been set. + +### GetSort + +`func (o *ReportDetailsArguments) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *ReportDetailsArguments) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *ReportDetailsArguments) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *ReportDetailsArguments) HasSort() bool` + +HasSort returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReportResultReference.md b/docs/tools/sdk/go/Reference/V2025/Models/ReportResultReference.md new file mode 100644 index 000000000..aa51321db --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReportResultReference.md @@ -0,0 +1,142 @@ +--- +id: v2025-report-result-reference +title: ReportResultReference +pagination_label: ReportResultReference +sidebar_label: ReportResultReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportResultReference', 'V2025ReportResultReference'] +slug: /tools/sdk/go/v2025/models/report-result-reference +tags: ['SDK', 'Software Development Kit', 'ReportResultReference', 'V2025ReportResultReference'] +--- + +# ReportResultReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **string** | Human-readable name of the SOD policy violation report result. | [optional] +**Status** | Pointer to **string** | Status of a SOD policy violation report. | [optional] + +## Methods + +### NewReportResultReference + +`func NewReportResultReference() *ReportResultReference` + +NewReportResultReference instantiates a new ReportResultReference 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 + +### NewReportResultReferenceWithDefaults + +`func NewReportResultReferenceWithDefaults() *ReportResultReference` + +NewReportResultReferenceWithDefaults instantiates a new ReportResultReference 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 + +### GetType + +`func (o *ReportResultReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReportResultReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReportResultReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ReportResultReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ReportResultReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReportResultReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReportResultReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReportResultReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ReportResultReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ReportResultReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ReportResultReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ReportResultReference) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *ReportResultReference) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ReportResultReference) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ReportResultReference) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ReportResultReference) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReportResults.md b/docs/tools/sdk/go/Reference/V2025/Models/ReportResults.md new file mode 100644 index 000000000..e374ae048 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReportResults.md @@ -0,0 +1,246 @@ +--- +id: v2025-report-results +title: ReportResults +pagination_label: ReportResults +sidebar_label: ReportResults +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportResults', 'V2025ReportResults'] +slug: /tools/sdk/go/v2025/models/report-results +tags: ['SDK', 'Software Development Kit', 'ReportResults', 'V2025ReportResults'] +--- + +# ReportResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReportType** | Pointer to **string** | Use this property to define what report should be processed in the RDE service. | [optional] +**TaskDefName** | Pointer to **string** | Name of the task definition which is started to process requesting report. Usually the same as report name | [optional] +**Id** | Pointer to **string** | Unique task definition identifier. | [optional] +**Created** | Pointer to **SailPointTime** | Report processing start date | [optional] +**Status** | Pointer to **string** | Report current state or result status. | [optional] +**Duration** | Pointer to **int64** | Report processing time in ms. | [optional] +**Rows** | Pointer to **int64** | Report size in rows. | [optional] +**AvailableFormats** | Pointer to **[]string** | Output report file formats. This are formats for calling get endpoint as a query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] + +## Methods + +### NewReportResults + +`func NewReportResults() *ReportResults` + +NewReportResults instantiates a new ReportResults 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 + +### NewReportResultsWithDefaults + +`func NewReportResultsWithDefaults() *ReportResults` + +NewReportResultsWithDefaults instantiates a new ReportResults 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 + +### GetReportType + +`func (o *ReportResults) GetReportType() string` + +GetReportType returns the ReportType field if non-nil, zero value otherwise. + +### GetReportTypeOk + +`func (o *ReportResults) GetReportTypeOk() (*string, bool)` + +GetReportTypeOk returns a tuple with the ReportType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportType + +`func (o *ReportResults) SetReportType(v string)` + +SetReportType sets ReportType field to given value. + +### HasReportType + +`func (o *ReportResults) HasReportType() bool` + +HasReportType returns a boolean if a field has been set. + +### GetTaskDefName + +`func (o *ReportResults) GetTaskDefName() string` + +GetTaskDefName returns the TaskDefName field if non-nil, zero value otherwise. + +### GetTaskDefNameOk + +`func (o *ReportResults) GetTaskDefNameOk() (*string, bool)` + +GetTaskDefNameOk returns a tuple with the TaskDefName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskDefName + +`func (o *ReportResults) SetTaskDefName(v string)` + +SetTaskDefName sets TaskDefName field to given value. + +### HasTaskDefName + +`func (o *ReportResults) HasTaskDefName() bool` + +HasTaskDefName returns a boolean if a field has been set. + +### GetId + +`func (o *ReportResults) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReportResults) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReportResults) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReportResults) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreated + +`func (o *ReportResults) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ReportResults) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ReportResults) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ReportResults) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetStatus + +`func (o *ReportResults) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ReportResults) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ReportResults) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ReportResults) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetDuration + +`func (o *ReportResults) GetDuration() int64` + +GetDuration returns the Duration field if non-nil, zero value otherwise. + +### GetDurationOk + +`func (o *ReportResults) GetDurationOk() (*int64, bool)` + +GetDurationOk returns a tuple with the Duration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDuration + +`func (o *ReportResults) SetDuration(v int64)` + +SetDuration sets Duration field to given value. + +### HasDuration + +`func (o *ReportResults) HasDuration() bool` + +HasDuration returns a boolean if a field has been set. + +### GetRows + +`func (o *ReportResults) GetRows() int64` + +GetRows returns the Rows field if non-nil, zero value otherwise. + +### GetRowsOk + +`func (o *ReportResults) GetRowsOk() (*int64, bool)` + +GetRowsOk returns a tuple with the Rows field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRows + +`func (o *ReportResults) SetRows(v int64)` + +SetRows sets Rows field to given value. + +### HasRows + +`func (o *ReportResults) HasRows() bool` + +HasRows returns a boolean if a field has been set. + +### GetAvailableFormats + +`func (o *ReportResults) GetAvailableFormats() []string` + +GetAvailableFormats returns the AvailableFormats field if non-nil, zero value otherwise. + +### GetAvailableFormatsOk + +`func (o *ReportResults) GetAvailableFormatsOk() (*[]string, bool)` + +GetAvailableFormatsOk returns a tuple with the AvailableFormats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAvailableFormats + +`func (o *ReportResults) SetAvailableFormats(v []string)` + +SetAvailableFormats sets AvailableFormats field to given value. + +### HasAvailableFormats + +`func (o *ReportResults) HasAvailableFormats() bool` + +HasAvailableFormats returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReportType.md b/docs/tools/sdk/go/Reference/V2025/Models/ReportType.md new file mode 100644 index 000000000..5da737f6e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReportType.md @@ -0,0 +1,25 @@ +--- +id: v2025-report-type +title: ReportType +pagination_label: ReportType +sidebar_label: ReportType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportType', 'V2025ReportType'] +slug: /tools/sdk/go/v2025/models/report-type +tags: ['SDK', 'Software Development Kit', 'ReportType', 'V2025ReportType'] +--- + +# ReportType + +## Enum + + +* `CAMPAIGN_COMPOSITION_REPORT` (value: `"CAMPAIGN_COMPOSITION_REPORT"`) + +* `CAMPAIGN_REMEDIATION_STATUS_REPORT` (value: `"CAMPAIGN_REMEDIATION_STATUS_REPORT"`) + +* `CAMPAIGN_STATUS_REPORT` (value: `"CAMPAIGN_STATUS_REPORT"`) + +* `CERTIFICATION_SIGNOFF_REPORT` (value: `"CERTIFICATION_SIGNOFF_REPORT"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestOnBehalfOfConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestOnBehalfOfConfig.md new file mode 100644 index 000000000..04df1f3b6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestOnBehalfOfConfig.md @@ -0,0 +1,90 @@ +--- +id: v2025-request-on-behalf-of-config +title: RequestOnBehalfOfConfig +pagination_label: RequestOnBehalfOfConfig +sidebar_label: RequestOnBehalfOfConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestOnBehalfOfConfig', 'V2025RequestOnBehalfOfConfig'] +slug: /tools/sdk/go/v2025/models/request-on-behalf-of-config +tags: ['SDK', 'Software Development Kit', 'RequestOnBehalfOfConfig', 'V2025RequestOnBehalfOfConfig'] +--- + +# RequestOnBehalfOfConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AllowRequestOnBehalfOfAnyoneByAnyone** | Pointer to **bool** | If this is true, anyone can request access for anyone. | [optional] [default to false] +**AllowRequestOnBehalfOfEmployeeByManager** | Pointer to **bool** | If this is true, a manager can request access for his or her direct reports. | [optional] [default to false] + +## Methods + +### NewRequestOnBehalfOfConfig + +`func NewRequestOnBehalfOfConfig() *RequestOnBehalfOfConfig` + +NewRequestOnBehalfOfConfig instantiates a new RequestOnBehalfOfConfig 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 + +### NewRequestOnBehalfOfConfigWithDefaults + +`func NewRequestOnBehalfOfConfigWithDefaults() *RequestOnBehalfOfConfig` + +NewRequestOnBehalfOfConfigWithDefaults instantiates a new RequestOnBehalfOfConfig 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 + +### GetAllowRequestOnBehalfOfAnyoneByAnyone + +`func (o *RequestOnBehalfOfConfig) GetAllowRequestOnBehalfOfAnyoneByAnyone() bool` + +GetAllowRequestOnBehalfOfAnyoneByAnyone returns the AllowRequestOnBehalfOfAnyoneByAnyone field if non-nil, zero value otherwise. + +### GetAllowRequestOnBehalfOfAnyoneByAnyoneOk + +`func (o *RequestOnBehalfOfConfig) GetAllowRequestOnBehalfOfAnyoneByAnyoneOk() (*bool, bool)` + +GetAllowRequestOnBehalfOfAnyoneByAnyoneOk returns a tuple with the AllowRequestOnBehalfOfAnyoneByAnyone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllowRequestOnBehalfOfAnyoneByAnyone + +`func (o *RequestOnBehalfOfConfig) SetAllowRequestOnBehalfOfAnyoneByAnyone(v bool)` + +SetAllowRequestOnBehalfOfAnyoneByAnyone sets AllowRequestOnBehalfOfAnyoneByAnyone field to given value. + +### HasAllowRequestOnBehalfOfAnyoneByAnyone + +`func (o *RequestOnBehalfOfConfig) HasAllowRequestOnBehalfOfAnyoneByAnyone() bool` + +HasAllowRequestOnBehalfOfAnyoneByAnyone returns a boolean if a field has been set. + +### GetAllowRequestOnBehalfOfEmployeeByManager + +`func (o *RequestOnBehalfOfConfig) GetAllowRequestOnBehalfOfEmployeeByManager() bool` + +GetAllowRequestOnBehalfOfEmployeeByManager returns the AllowRequestOnBehalfOfEmployeeByManager field if non-nil, zero value otherwise. + +### GetAllowRequestOnBehalfOfEmployeeByManagerOk + +`func (o *RequestOnBehalfOfConfig) GetAllowRequestOnBehalfOfEmployeeByManagerOk() (*bool, bool)` + +GetAllowRequestOnBehalfOfEmployeeByManagerOk returns a tuple with the AllowRequestOnBehalfOfEmployeeByManager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllowRequestOnBehalfOfEmployeeByManager + +`func (o *RequestOnBehalfOfConfig) SetAllowRequestOnBehalfOfEmployeeByManager(v bool)` + +SetAllowRequestOnBehalfOfEmployeeByManager sets AllowRequestOnBehalfOfEmployeeByManager field to given value. + +### HasAllowRequestOnBehalfOfEmployeeByManager + +`func (o *RequestOnBehalfOfConfig) HasAllowRequestOnBehalfOfEmployeeByManager() bool` + +HasAllowRequestOnBehalfOfEmployeeByManager returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Requestability.md b/docs/tools/sdk/go/Reference/V2025/Models/Requestability.md new file mode 100644 index 000000000..3b5e7a954 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Requestability.md @@ -0,0 +1,182 @@ +--- +id: v2025-requestability +title: Requestability +pagination_label: Requestability +sidebar_label: Requestability +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Requestability', 'V2025Requestability'] +slug: /tools/sdk/go/v2025/models/requestability +tags: ['SDK', 'Software Development Kit', 'Requestability', 'V2025Requestability'] +--- + +# Requestability + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **NullableBool** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to false] +**DenialCommentsRequired** | Pointer to **NullableBool** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to false] +**ReauthorizationRequired** | Pointer to **NullableBool** | Indicates whether reauthorization is required for the request. | [optional] [default to false] +**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] + +## Methods + +### NewRequestability + +`func NewRequestability() *Requestability` + +NewRequestability instantiates a new Requestability 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 + +### NewRequestabilityWithDefaults + +`func NewRequestabilityWithDefaults() *Requestability` + +NewRequestabilityWithDefaults instantiates a new Requestability 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 + +### GetCommentsRequired + +`func (o *Requestability) GetCommentsRequired() bool` + +GetCommentsRequired returns the CommentsRequired field if non-nil, zero value otherwise. + +### GetCommentsRequiredOk + +`func (o *Requestability) GetCommentsRequiredOk() (*bool, bool)` + +GetCommentsRequiredOk returns a tuple with the CommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentsRequired + +`func (o *Requestability) SetCommentsRequired(v bool)` + +SetCommentsRequired sets CommentsRequired field to given value. + +### HasCommentsRequired + +`func (o *Requestability) HasCommentsRequired() bool` + +HasCommentsRequired returns a boolean if a field has been set. + +### SetCommentsRequiredNil + +`func (o *Requestability) SetCommentsRequiredNil(b bool)` + + SetCommentsRequiredNil sets the value for CommentsRequired to be an explicit nil + +### UnsetCommentsRequired +`func (o *Requestability) UnsetCommentsRequired()` + +UnsetCommentsRequired ensures that no value is present for CommentsRequired, not even an explicit nil +### GetDenialCommentsRequired + +`func (o *Requestability) GetDenialCommentsRequired() bool` + +GetDenialCommentsRequired returns the DenialCommentsRequired field if non-nil, zero value otherwise. + +### GetDenialCommentsRequiredOk + +`func (o *Requestability) GetDenialCommentsRequiredOk() (*bool, bool)` + +GetDenialCommentsRequiredOk returns a tuple with the DenialCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenialCommentsRequired + +`func (o *Requestability) SetDenialCommentsRequired(v bool)` + +SetDenialCommentsRequired sets DenialCommentsRequired field to given value. + +### HasDenialCommentsRequired + +`func (o *Requestability) HasDenialCommentsRequired() bool` + +HasDenialCommentsRequired returns a boolean if a field has been set. + +### SetDenialCommentsRequiredNil + +`func (o *Requestability) SetDenialCommentsRequiredNil(b bool)` + + SetDenialCommentsRequiredNil sets the value for DenialCommentsRequired to be an explicit nil + +### UnsetDenialCommentsRequired +`func (o *Requestability) UnsetDenialCommentsRequired()` + +UnsetDenialCommentsRequired ensures that no value is present for DenialCommentsRequired, not even an explicit nil +### GetReauthorizationRequired + +`func (o *Requestability) GetReauthorizationRequired() bool` + +GetReauthorizationRequired returns the ReauthorizationRequired field if non-nil, zero value otherwise. + +### GetReauthorizationRequiredOk + +`func (o *Requestability) GetReauthorizationRequiredOk() (*bool, bool)` + +GetReauthorizationRequiredOk returns a tuple with the ReauthorizationRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReauthorizationRequired + +`func (o *Requestability) SetReauthorizationRequired(v bool)` + +SetReauthorizationRequired sets ReauthorizationRequired field to given value. + +### HasReauthorizationRequired + +`func (o *Requestability) HasReauthorizationRequired() bool` + +HasReauthorizationRequired returns a boolean if a field has been set. + +### SetReauthorizationRequiredNil + +`func (o *Requestability) SetReauthorizationRequiredNil(b bool)` + + SetReauthorizationRequiredNil sets the value for ReauthorizationRequired to be an explicit nil + +### UnsetReauthorizationRequired +`func (o *Requestability) UnsetReauthorizationRequired()` + +UnsetReauthorizationRequired ensures that no value is present for ReauthorizationRequired, not even an explicit nil +### GetApprovalSchemes + +`func (o *Requestability) GetApprovalSchemes() []AccessProfileApprovalScheme` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *Requestability) GetApprovalSchemesOk() (*[]AccessProfileApprovalScheme, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *Requestability) SetApprovalSchemes(v []AccessProfileApprovalScheme)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *Requestability) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + +### SetApprovalSchemesNil + +`func (o *Requestability) SetApprovalSchemesNil(b bool)` + + SetApprovalSchemesNil sets the value for ApprovalSchemes to be an explicit nil + +### UnsetApprovalSchemes +`func (o *Requestability) UnsetApprovalSchemes()` + +UnsetApprovalSchemes ensures that no value is present for ApprovalSchemes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestabilityForRole.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestabilityForRole.md new file mode 100644 index 000000000..1522942f4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestabilityForRole.md @@ -0,0 +1,172 @@ +--- +id: v2025-requestability-for-role +title: RequestabilityForRole +pagination_label: RequestabilityForRole +sidebar_label: RequestabilityForRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestabilityForRole', 'V2025RequestabilityForRole'] +slug: /tools/sdk/go/v2025/models/requestability-for-role +tags: ['SDK', 'Software Development Kit', 'RequestabilityForRole', 'V2025RequestabilityForRole'] +--- + +# RequestabilityForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **NullableBool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to false] +**DenialCommentsRequired** | Pointer to **NullableBool** | Whether an approver must provide comments when denying the request | [optional] [default to false] +**ReauthorizationRequired** | Pointer to **NullableBool** | Indicates whether reauthorization is required for the request. | [optional] [default to false] +**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] + +## Methods + +### NewRequestabilityForRole + +`func NewRequestabilityForRole() *RequestabilityForRole` + +NewRequestabilityForRole instantiates a new RequestabilityForRole 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 + +### NewRequestabilityForRoleWithDefaults + +`func NewRequestabilityForRoleWithDefaults() *RequestabilityForRole` + +NewRequestabilityForRoleWithDefaults instantiates a new RequestabilityForRole 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 + +### GetCommentsRequired + +`func (o *RequestabilityForRole) GetCommentsRequired() bool` + +GetCommentsRequired returns the CommentsRequired field if non-nil, zero value otherwise. + +### GetCommentsRequiredOk + +`func (o *RequestabilityForRole) GetCommentsRequiredOk() (*bool, bool)` + +GetCommentsRequiredOk returns a tuple with the CommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentsRequired + +`func (o *RequestabilityForRole) SetCommentsRequired(v bool)` + +SetCommentsRequired sets CommentsRequired field to given value. + +### HasCommentsRequired + +`func (o *RequestabilityForRole) HasCommentsRequired() bool` + +HasCommentsRequired returns a boolean if a field has been set. + +### SetCommentsRequiredNil + +`func (o *RequestabilityForRole) SetCommentsRequiredNil(b bool)` + + SetCommentsRequiredNil sets the value for CommentsRequired to be an explicit nil + +### UnsetCommentsRequired +`func (o *RequestabilityForRole) UnsetCommentsRequired()` + +UnsetCommentsRequired ensures that no value is present for CommentsRequired, not even an explicit nil +### GetDenialCommentsRequired + +`func (o *RequestabilityForRole) GetDenialCommentsRequired() bool` + +GetDenialCommentsRequired returns the DenialCommentsRequired field if non-nil, zero value otherwise. + +### GetDenialCommentsRequiredOk + +`func (o *RequestabilityForRole) GetDenialCommentsRequiredOk() (*bool, bool)` + +GetDenialCommentsRequiredOk returns a tuple with the DenialCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenialCommentsRequired + +`func (o *RequestabilityForRole) SetDenialCommentsRequired(v bool)` + +SetDenialCommentsRequired sets DenialCommentsRequired field to given value. + +### HasDenialCommentsRequired + +`func (o *RequestabilityForRole) HasDenialCommentsRequired() bool` + +HasDenialCommentsRequired returns a boolean if a field has been set. + +### SetDenialCommentsRequiredNil + +`func (o *RequestabilityForRole) SetDenialCommentsRequiredNil(b bool)` + + SetDenialCommentsRequiredNil sets the value for DenialCommentsRequired to be an explicit nil + +### UnsetDenialCommentsRequired +`func (o *RequestabilityForRole) UnsetDenialCommentsRequired()` + +UnsetDenialCommentsRequired ensures that no value is present for DenialCommentsRequired, not even an explicit nil +### GetReauthorizationRequired + +`func (o *RequestabilityForRole) GetReauthorizationRequired() bool` + +GetReauthorizationRequired returns the ReauthorizationRequired field if non-nil, zero value otherwise. + +### GetReauthorizationRequiredOk + +`func (o *RequestabilityForRole) GetReauthorizationRequiredOk() (*bool, bool)` + +GetReauthorizationRequiredOk returns a tuple with the ReauthorizationRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReauthorizationRequired + +`func (o *RequestabilityForRole) SetReauthorizationRequired(v bool)` + +SetReauthorizationRequired sets ReauthorizationRequired field to given value. + +### HasReauthorizationRequired + +`func (o *RequestabilityForRole) HasReauthorizationRequired() bool` + +HasReauthorizationRequired returns a boolean if a field has been set. + +### SetReauthorizationRequiredNil + +`func (o *RequestabilityForRole) SetReauthorizationRequiredNil(b bool)` + + SetReauthorizationRequiredNil sets the value for ReauthorizationRequired to be an explicit nil + +### UnsetReauthorizationRequired +`func (o *RequestabilityForRole) UnsetReauthorizationRequired()` + +UnsetReauthorizationRequired ensures that no value is present for ReauthorizationRequired, not even an explicit nil +### GetApprovalSchemes + +`func (o *RequestabilityForRole) GetApprovalSchemes() []ApprovalSchemeForRole` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *RequestabilityForRole) GetApprovalSchemesOk() (*[]ApprovalSchemeForRole, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *RequestabilityForRole) SetApprovalSchemes(v []ApprovalSchemeForRole)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *RequestabilityForRole) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestableObject.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestableObject.md new file mode 100644 index 000000000..daa5bc011 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestableObject.md @@ -0,0 +1,338 @@ +--- +id: v2025-requestable-object +title: RequestableObject +pagination_label: RequestableObject +sidebar_label: RequestableObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObject', 'V2025RequestableObject'] +slug: /tools/sdk/go/v2025/models/requestable-object +tags: ['SDK', 'Software Development Kit', 'RequestableObject', 'V2025RequestableObject'] +--- + +# RequestableObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the requestable object itself | [optional] +**Name** | Pointer to **string** | Human-readable display name of the requestable object | [optional] +**Created** | Pointer to **SailPointTime** | The time when the requestable object was created | [optional] +**Modified** | Pointer to **NullableTime** | The time when the requestable object was last modified | [optional] +**Description** | Pointer to **NullableString** | Description of the requestable object. | [optional] +**Type** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional] +**RequestStatus** | Pointer to [**RequestableObjectRequestStatus**](requestable-object-request-status) | | [optional] +**IdentityRequestId** | Pointer to **NullableString** | If *requestStatus* is *PENDING*, indicates the id of the associated account activity. | [optional] +**OwnerRef** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**RequestCommentsRequired** | Pointer to **bool** | Whether the requester must provide comments when requesting the object. | [optional] + +## Methods + +### NewRequestableObject + +`func NewRequestableObject() *RequestableObject` + +NewRequestableObject instantiates a new RequestableObject 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 + +### NewRequestableObjectWithDefaults + +`func NewRequestableObjectWithDefaults() *RequestableObject` + +NewRequestableObjectWithDefaults instantiates a new RequestableObject 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 + +### GetId + +`func (o *RequestableObject) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestableObject) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestableObject) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestableObject) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RequestableObject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestableObject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestableObject) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestableObject) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *RequestableObject) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RequestableObject) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RequestableObject) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RequestableObject) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *RequestableObject) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RequestableObject) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RequestableObject) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RequestableObject) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *RequestableObject) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *RequestableObject) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDescription + +`func (o *RequestableObject) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RequestableObject) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RequestableObject) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RequestableObject) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RequestableObject) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RequestableObject) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *RequestableObject) GetType() RequestableObjectType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestableObject) GetTypeOk() (*RequestableObjectType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestableObject) SetType(v RequestableObjectType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestableObject) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRequestStatus + +`func (o *RequestableObject) GetRequestStatus() RequestableObjectRequestStatus` + +GetRequestStatus returns the RequestStatus field if non-nil, zero value otherwise. + +### GetRequestStatusOk + +`func (o *RequestableObject) GetRequestStatusOk() (*RequestableObjectRequestStatus, bool)` + +GetRequestStatusOk returns a tuple with the RequestStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestStatus + +`func (o *RequestableObject) SetRequestStatus(v RequestableObjectRequestStatus)` + +SetRequestStatus sets RequestStatus field to given value. + +### HasRequestStatus + +`func (o *RequestableObject) HasRequestStatus() bool` + +HasRequestStatus returns a boolean if a field has been set. + +### GetIdentityRequestId + +`func (o *RequestableObject) GetIdentityRequestId() string` + +GetIdentityRequestId returns the IdentityRequestId field if non-nil, zero value otherwise. + +### GetIdentityRequestIdOk + +`func (o *RequestableObject) GetIdentityRequestIdOk() (*string, bool)` + +GetIdentityRequestIdOk returns a tuple with the IdentityRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityRequestId + +`func (o *RequestableObject) SetIdentityRequestId(v string)` + +SetIdentityRequestId sets IdentityRequestId field to given value. + +### HasIdentityRequestId + +`func (o *RequestableObject) HasIdentityRequestId() bool` + +HasIdentityRequestId returns a boolean if a field has been set. + +### SetIdentityRequestIdNil + +`func (o *RequestableObject) SetIdentityRequestIdNil(b bool)` + + SetIdentityRequestIdNil sets the value for IdentityRequestId to be an explicit nil + +### UnsetIdentityRequestId +`func (o *RequestableObject) UnsetIdentityRequestId()` + +UnsetIdentityRequestId ensures that no value is present for IdentityRequestId, not even an explicit nil +### GetOwnerRef + +`func (o *RequestableObject) GetOwnerRef() IdentityReferenceWithNameAndEmail` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *RequestableObject) GetOwnerRefOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *RequestableObject) SetOwnerRef(v IdentityReferenceWithNameAndEmail)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *RequestableObject) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### SetOwnerRefNil + +`func (o *RequestableObject) SetOwnerRefNil(b bool)` + + SetOwnerRefNil sets the value for OwnerRef to be an explicit nil + +### UnsetOwnerRef +`func (o *RequestableObject) UnsetOwnerRef()` + +UnsetOwnerRef ensures that no value is present for OwnerRef, not even an explicit nil +### GetRequestCommentsRequired + +`func (o *RequestableObject) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *RequestableObject) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *RequestableObject) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *RequestableObject) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestableObjectReference.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestableObjectReference.md new file mode 100644 index 000000000..96d9e6ecb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestableObjectReference.md @@ -0,0 +1,142 @@ +--- +id: v2025-requestable-object-reference +title: RequestableObjectReference +pagination_label: RequestableObjectReference +sidebar_label: RequestableObjectReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObjectReference', 'V2025RequestableObjectReference'] +slug: /tools/sdk/go/v2025/models/requestable-object-reference +tags: ['SDK', 'Software Development Kit', 'RequestableObjectReference', 'V2025RequestableObjectReference'] +--- + +# RequestableObjectReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the object. | [optional] +**Name** | Pointer to **string** | Name of the object. | [optional] +**Description** | Pointer to **string** | Description of the object. | [optional] +**Type** | Pointer to **string** | Type of the object. | [optional] + +## Methods + +### NewRequestableObjectReference + +`func NewRequestableObjectReference() *RequestableObjectReference` + +NewRequestableObjectReference instantiates a new RequestableObjectReference 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 + +### NewRequestableObjectReferenceWithDefaults + +`func NewRequestableObjectReferenceWithDefaults() *RequestableObjectReference` + +NewRequestableObjectReferenceWithDefaults instantiates a new RequestableObjectReference 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 + +### GetId + +`func (o *RequestableObjectReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestableObjectReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestableObjectReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestableObjectReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RequestableObjectReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestableObjectReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestableObjectReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestableObjectReference) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RequestableObjectReference) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RequestableObjectReference) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RequestableObjectReference) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RequestableObjectReference) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetType + +`func (o *RequestableObjectReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestableObjectReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestableObjectReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestableObjectReference) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestableObjectRequestStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestableObjectRequestStatus.md new file mode 100644 index 000000000..bb14f65f3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestableObjectRequestStatus.md @@ -0,0 +1,23 @@ +--- +id: v2025-requestable-object-request-status +title: RequestableObjectRequestStatus +pagination_label: RequestableObjectRequestStatus +sidebar_label: RequestableObjectRequestStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObjectRequestStatus', 'V2025RequestableObjectRequestStatus'] +slug: /tools/sdk/go/v2025/models/requestable-object-request-status +tags: ['SDK', 'Software Development Kit', 'RequestableObjectRequestStatus', 'V2025RequestableObjectRequestStatus'] +--- + +# RequestableObjectRequestStatus + +## Enum + + +* `AVAILABLE` (value: `"AVAILABLE"`) + +* `PENDING` (value: `"PENDING"`) + +* `ASSIGNED` (value: `"ASSIGNED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestableObjectType.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestableObjectType.md new file mode 100644 index 000000000..67ac18160 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestableObjectType.md @@ -0,0 +1,23 @@ +--- +id: v2025-requestable-object-type +title: RequestableObjectType +pagination_label: RequestableObjectType +sidebar_label: RequestableObjectType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObjectType', 'V2025RequestableObjectType'] +slug: /tools/sdk/go/v2025/models/requestable-object-type +tags: ['SDK', 'Software Development Kit', 'RequestableObjectType', 'V2025RequestableObjectType'] +--- + +# RequestableObjectType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestedAccountRef.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestedAccountRef.md new file mode 100644 index 000000000..798ff7ad9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestedAccountRef.md @@ -0,0 +1,188 @@ +--- +id: v2025-requested-account-ref +title: RequestedAccountRef +pagination_label: RequestedAccountRef +sidebar_label: RequestedAccountRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedAccountRef', 'V2025RequestedAccountRef'] +slug: /tools/sdk/go/v2025/models/requested-account-ref +tags: ['SDK', 'Software Development Kit', 'RequestedAccountRef', 'V2025RequestedAccountRef'] +--- + +# RequestedAccountRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Display name of the account for the user | [optional] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**AccountUuid** | Pointer to **NullableString** | The uuid for the account | [optional] +**AccountId** | Pointer to **NullableString** | The native identity for the account | [optional] +**SourceName** | Pointer to **string** | Display name of the source for the account | [optional] + +## Methods + +### NewRequestedAccountRef + +`func NewRequestedAccountRef() *RequestedAccountRef` + +NewRequestedAccountRef instantiates a new RequestedAccountRef 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 + +### NewRequestedAccountRefWithDefaults + +`func NewRequestedAccountRefWithDefaults() *RequestedAccountRef` + +NewRequestedAccountRefWithDefaults instantiates a new RequestedAccountRef 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 + +### GetName + +`func (o *RequestedAccountRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestedAccountRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestedAccountRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestedAccountRef) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *RequestedAccountRef) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedAccountRef) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedAccountRef) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedAccountRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetAccountUuid + +`func (o *RequestedAccountRef) GetAccountUuid() string` + +GetAccountUuid returns the AccountUuid field if non-nil, zero value otherwise. + +### GetAccountUuidOk + +`func (o *RequestedAccountRef) GetAccountUuidOk() (*string, bool)` + +GetAccountUuidOk returns a tuple with the AccountUuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountUuid + +`func (o *RequestedAccountRef) SetAccountUuid(v string)` + +SetAccountUuid sets AccountUuid field to given value. + +### HasAccountUuid + +`func (o *RequestedAccountRef) HasAccountUuid() bool` + +HasAccountUuid returns a boolean if a field has been set. + +### SetAccountUuidNil + +`func (o *RequestedAccountRef) SetAccountUuidNil(b bool)` + + SetAccountUuidNil sets the value for AccountUuid to be an explicit nil + +### UnsetAccountUuid +`func (o *RequestedAccountRef) UnsetAccountUuid()` + +UnsetAccountUuid ensures that no value is present for AccountUuid, not even an explicit nil +### GetAccountId + +`func (o *RequestedAccountRef) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *RequestedAccountRef) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *RequestedAccountRef) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *RequestedAccountRef) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountIdNil + +`func (o *RequestedAccountRef) SetAccountIdNil(b bool)` + + SetAccountIdNil sets the value for AccountId to be an explicit nil + +### UnsetAccountId +`func (o *RequestedAccountRef) UnsetAccountId()` + +UnsetAccountId ensures that no value is present for AccountId, not even an explicit nil +### GetSourceName + +`func (o *RequestedAccountRef) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *RequestedAccountRef) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *RequestedAccountRef) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *RequestedAccountRef) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestedForDtoRef.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..1a781824c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestedForDtoRef.md @@ -0,0 +1,80 @@ +--- +id: v2025-requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedForDtoRef', 'V2025RequestedForDtoRef'] +slug: /tools/sdk/go/v2025/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'V2025RequestedForDtoRef'] +--- + +# RequestedForDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **string** | The identity id for which the access is requested | +**RequestedItems** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | + +## Methods + +### NewRequestedForDtoRef + +`func NewRequestedForDtoRef(identityId string, requestedItems []RequestedItemDtoRef, ) *RequestedForDtoRef` + +NewRequestedForDtoRef instantiates a new RequestedForDtoRef 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 + +### NewRequestedForDtoRefWithDefaults + +`func NewRequestedForDtoRefWithDefaults() *RequestedForDtoRef` + +NewRequestedForDtoRefWithDefaults instantiates a new RequestedForDtoRef 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 + +### GetIdentityId + +`func (o *RequestedForDtoRef) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *RequestedForDtoRef) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *RequestedForDtoRef) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetRequestedItems + +`func (o *RequestedForDtoRef) GetRequestedItems() []RequestedItemDtoRef` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *RequestedForDtoRef) GetRequestedItemsOk() (*[]RequestedItemDtoRef, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *RequestedForDtoRef) SetRequestedItems(v []RequestedItemDtoRef)` + +SetRequestedItems sets RequestedItems field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemAccountSelections.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemAccountSelections.md new file mode 100644 index 000000000..baac37bac --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemAccountSelections.md @@ -0,0 +1,230 @@ +--- +id: v2025-requested-item-account-selections +title: RequestedItemAccountSelections +pagination_label: RequestedItemAccountSelections +sidebar_label: RequestedItemAccountSelections +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemAccountSelections', 'V2025RequestedItemAccountSelections'] +slug: /tools/sdk/go/v2025/models/requested-item-account-selections +tags: ['SDK', 'Software Development Kit', 'RequestedItemAccountSelections', 'V2025RequestedItemAccountSelections'] +--- + +# RequestedItemAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | The description for this requested item | [optional] +**AccountsSelectionBlocked** | Pointer to **bool** | This field indicates if account selections are not allowed for this requested item. * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. * An example is where a user is requesting an access profile that is already assigned to one of their accounts. | [optional] [default to false] +**AccountsSelectionBlockedReason** | Pointer to **NullableString** | If account selections are not allowed for an item, this field will denote the reason. | [optional] +**Type** | Pointer to **string** | The type of the item being requested. | [optional] +**Id** | Pointer to **string** | The id of the requested item | [optional] +**Name** | Pointer to **string** | The name of the requested item | [optional] +**Sources** | Pointer to [**[]SourceAccountSelections**](source-account-selections) | The details for the sources and accounts for the requested item and identity combination | [optional] + +## Methods + +### NewRequestedItemAccountSelections + +`func NewRequestedItemAccountSelections() *RequestedItemAccountSelections` + +NewRequestedItemAccountSelections instantiates a new RequestedItemAccountSelections 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 + +### NewRequestedItemAccountSelectionsWithDefaults + +`func NewRequestedItemAccountSelectionsWithDefaults() *RequestedItemAccountSelections` + +NewRequestedItemAccountSelectionsWithDefaults instantiates a new RequestedItemAccountSelections 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 + +### GetDescription + +`func (o *RequestedItemAccountSelections) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RequestedItemAccountSelections) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RequestedItemAccountSelections) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RequestedItemAccountSelections) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetAccountsSelectionBlocked + +`func (o *RequestedItemAccountSelections) GetAccountsSelectionBlocked() bool` + +GetAccountsSelectionBlocked returns the AccountsSelectionBlocked field if non-nil, zero value otherwise. + +### GetAccountsSelectionBlockedOk + +`func (o *RequestedItemAccountSelections) GetAccountsSelectionBlockedOk() (*bool, bool)` + +GetAccountsSelectionBlockedOk returns a tuple with the AccountsSelectionBlocked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountsSelectionBlocked + +`func (o *RequestedItemAccountSelections) SetAccountsSelectionBlocked(v bool)` + +SetAccountsSelectionBlocked sets AccountsSelectionBlocked field to given value. + +### HasAccountsSelectionBlocked + +`func (o *RequestedItemAccountSelections) HasAccountsSelectionBlocked() bool` + +HasAccountsSelectionBlocked returns a boolean if a field has been set. + +### GetAccountsSelectionBlockedReason + +`func (o *RequestedItemAccountSelections) GetAccountsSelectionBlockedReason() string` + +GetAccountsSelectionBlockedReason returns the AccountsSelectionBlockedReason field if non-nil, zero value otherwise. + +### GetAccountsSelectionBlockedReasonOk + +`func (o *RequestedItemAccountSelections) GetAccountsSelectionBlockedReasonOk() (*string, bool)` + +GetAccountsSelectionBlockedReasonOk returns a tuple with the AccountsSelectionBlockedReason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountsSelectionBlockedReason + +`func (o *RequestedItemAccountSelections) SetAccountsSelectionBlockedReason(v string)` + +SetAccountsSelectionBlockedReason sets AccountsSelectionBlockedReason field to given value. + +### HasAccountsSelectionBlockedReason + +`func (o *RequestedItemAccountSelections) HasAccountsSelectionBlockedReason() bool` + +HasAccountsSelectionBlockedReason returns a boolean if a field has been set. + +### SetAccountsSelectionBlockedReasonNil + +`func (o *RequestedItemAccountSelections) SetAccountsSelectionBlockedReasonNil(b bool)` + + SetAccountsSelectionBlockedReasonNil sets the value for AccountsSelectionBlockedReason to be an explicit nil + +### UnsetAccountsSelectionBlockedReason +`func (o *RequestedItemAccountSelections) UnsetAccountsSelectionBlockedReason()` + +UnsetAccountsSelectionBlockedReason ensures that no value is present for AccountsSelectionBlockedReason, not even an explicit nil +### GetType + +`func (o *RequestedItemAccountSelections) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemAccountSelections) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemAccountSelections) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedItemAccountSelections) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RequestedItemAccountSelections) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemAccountSelections) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemAccountSelections) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestedItemAccountSelections) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RequestedItemAccountSelections) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestedItemAccountSelections) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestedItemAccountSelections) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestedItemAccountSelections) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSources + +`func (o *RequestedItemAccountSelections) GetSources() []SourceAccountSelections` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *RequestedItemAccountSelections) GetSourcesOk() (*[]SourceAccountSelections, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *RequestedItemAccountSelections) SetSources(v []SourceAccountSelections)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *RequestedItemAccountSelections) HasSources() bool` + +HasSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemDetails.md new file mode 100644 index 000000000..87dc89b25 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemDetails.md @@ -0,0 +1,90 @@ +--- +id: v2025-requested-item-details +title: RequestedItemDetails +pagination_label: RequestedItemDetails +sidebar_label: RequestedItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemDetails', 'V2025RequestedItemDetails'] +slug: /tools/sdk/go/v2025/models/requested-item-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemDetails', 'V2025RequestedItemDetails'] +--- + +# RequestedItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of access item requested. | [optional] +**Id** | Pointer to **string** | The id of the access item requested. | [optional] + +## Methods + +### NewRequestedItemDetails + +`func NewRequestedItemDetails() *RequestedItemDetails` + +NewRequestedItemDetails instantiates a new RequestedItemDetails 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 + +### NewRequestedItemDetailsWithDefaults + +`func NewRequestedItemDetailsWithDefaults() *RequestedItemDetails` + +NewRequestedItemDetailsWithDefaults instantiates a new RequestedItemDetails 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 + +### GetType + +`func (o *RequestedItemDetails) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemDetails) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemDetails) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedItemDetails) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RequestedItemDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestedItemDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemDtoRef.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..1d1907fdc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemDtoRef.md @@ -0,0 +1,266 @@ +--- +id: v2025-requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemDtoRef', 'V2025RequestedItemDtoRef'] +slug: /tools/sdk/go/v2025/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'V2025RequestedItemDtoRef'] +--- + +# RequestedItemDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of the item being requested. | +**Id** | **string** | ID of Role, Access Profile or Entitlement being requested. | +**Comment** | Pointer to **string** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | Pointer to **SailPointTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | Pointer to **NullableString** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | Pointer to **NullableString** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**AccountSelection** | Pointer to [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] + +## Methods + +### NewRequestedItemDtoRef + +`func NewRequestedItemDtoRef(type_ string, id string, ) *RequestedItemDtoRef` + +NewRequestedItemDtoRef instantiates a new RequestedItemDtoRef 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 + +### NewRequestedItemDtoRefWithDefaults + +`func NewRequestedItemDtoRefWithDefaults() *RequestedItemDtoRef` + +NewRequestedItemDtoRefWithDefaults instantiates a new RequestedItemDtoRef 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 + +### GetType + +`func (o *RequestedItemDtoRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemDtoRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemDtoRef) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *RequestedItemDtoRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemDtoRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemDtoRef) SetId(v string)` + +SetId sets Id field to given value. + + +### GetComment + +`func (o *RequestedItemDtoRef) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *RequestedItemDtoRef) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *RequestedItemDtoRef) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *RequestedItemDtoRef) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *RequestedItemDtoRef) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *RequestedItemDtoRef) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *RequestedItemDtoRef) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *RequestedItemDtoRef) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *RequestedItemDtoRef) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *RequestedItemDtoRef) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *RequestedItemDtoRef) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *RequestedItemDtoRef) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetAssignmentId + +`func (o *RequestedItemDtoRef) GetAssignmentId() string` + +GetAssignmentId returns the AssignmentId field if non-nil, zero value otherwise. + +### GetAssignmentIdOk + +`func (o *RequestedItemDtoRef) GetAssignmentIdOk() (*string, bool)` + +GetAssignmentIdOk returns a tuple with the AssignmentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentId + +`func (o *RequestedItemDtoRef) SetAssignmentId(v string)` + +SetAssignmentId sets AssignmentId field to given value. + +### HasAssignmentId + +`func (o *RequestedItemDtoRef) HasAssignmentId() bool` + +HasAssignmentId returns a boolean if a field has been set. + +### SetAssignmentIdNil + +`func (o *RequestedItemDtoRef) SetAssignmentIdNil(b bool)` + + SetAssignmentIdNil sets the value for AssignmentId to be an explicit nil + +### UnsetAssignmentId +`func (o *RequestedItemDtoRef) UnsetAssignmentId()` + +UnsetAssignmentId ensures that no value is present for AssignmentId, not even an explicit nil +### GetNativeIdentity + +`func (o *RequestedItemDtoRef) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *RequestedItemDtoRef) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *RequestedItemDtoRef) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *RequestedItemDtoRef) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### SetNativeIdentityNil + +`func (o *RequestedItemDtoRef) SetNativeIdentityNil(b bool)` + + SetNativeIdentityNil sets the value for NativeIdentity to be an explicit nil + +### UnsetNativeIdentity +`func (o *RequestedItemDtoRef) UnsetNativeIdentity()` + +UnsetNativeIdentity ensures that no value is present for NativeIdentity, not even an explicit nil +### GetAccountSelection + +`func (o *RequestedItemDtoRef) GetAccountSelection() []SourceItemRef` + +GetAccountSelection returns the AccountSelection field if non-nil, zero value otherwise. + +### GetAccountSelectionOk + +`func (o *RequestedItemDtoRef) GetAccountSelectionOk() (*[]SourceItemRef, bool)` + +GetAccountSelectionOk returns a tuple with the AccountSelection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSelection + +`func (o *RequestedItemDtoRef) SetAccountSelection(v []SourceItemRef)` + +SetAccountSelection sets AccountSelection field to given value. + +### HasAccountSelection + +`func (o *RequestedItemDtoRef) HasAccountSelection() bool` + +HasAccountSelection returns a boolean if a field has been set. + +### SetAccountSelectionNil + +`func (o *RequestedItemDtoRef) SetAccountSelectionNil(b bool)` + + SetAccountSelectionNil sets the value for AccountSelection to be an explicit nil + +### UnsetAccountSelection +`func (o *RequestedItemDtoRef) UnsetAccountSelection()` + +UnsetAccountSelection ensures that no value is present for AccountSelection, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatus.md new file mode 100644 index 000000000..4574ec994 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatus.md @@ -0,0 +1,844 @@ +--- +id: v2025-requested-item-status +title: RequestedItemStatus +pagination_label: RequestedItemStatus +sidebar_label: RequestedItemStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatus', 'V2025RequestedItemStatus'] +slug: /tools/sdk/go/v2025/models/requested-item-status +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'V2025RequestedItemStatus'] +--- + +# RequestedItemStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | The ID of the access request. As of 2025, this is a new property. Older access requests might not have an ID. | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the item being requested. | [optional] +**Type** | Pointer to **NullableString** | Type of requested object. | [optional] +**CancelledRequestDetails** | Pointer to [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional] +**ErrorMessages** | Pointer to [**[][]ErrorMessageDto**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional] +**State** | Pointer to [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional] +**ApprovalDetails** | Pointer to [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional] +**ApprovalIds** | Pointer to **[]string** | List of approval IDs associated with the request. | [optional] +**ManualWorkItemDetails** | Pointer to [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional] +**AccountActivityItemId** | Pointer to **string** | Id of associated account activity item. | [optional] +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**Modified** | Pointer to **NullableTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**RequesterComment** | Pointer to [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional] +**SodViolationContext** | Pointer to [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional] +**ProvisioningDetails** | Pointer to [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional] +**PreApprovalTriggerDetails** | Pointer to [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional] +**AccessRequestPhases** | Pointer to [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional] +**Description** | Pointer to **NullableString** | Description associated to the requested object. | [optional] +**RemoveDate** | Pointer to **NullableTime** | When the role access is scheduled for removal. | [optional] +**Cancelable** | Pointer to **bool** | True if the request can be canceled. | [optional] [default to false] +**AccessRequestId** | Pointer to **string** | This is the account activity id. | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] +**RequestedAccounts** | Pointer to [**[]RequestedAccountRef**](requested-account-ref) | The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. | [optional] + +## Methods + +### NewRequestedItemStatus + +`func NewRequestedItemStatus() *RequestedItemStatus` + +NewRequestedItemStatus instantiates a new RequestedItemStatus 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 + +### NewRequestedItemStatusWithDefaults + +`func NewRequestedItemStatusWithDefaults() *RequestedItemStatus` + +NewRequestedItemStatusWithDefaults instantiates a new RequestedItemStatus 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 + +### GetId + +`func (o *RequestedItemStatus) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemStatus) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemStatus) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestedItemStatus) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *RequestedItemStatus) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *RequestedItemStatus) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *RequestedItemStatus) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestedItemStatus) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestedItemStatus) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestedItemStatus) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RequestedItemStatus) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RequestedItemStatus) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetType + +`func (o *RequestedItemStatus) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemStatus) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemStatus) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedItemStatus) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *RequestedItemStatus) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *RequestedItemStatus) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetCancelledRequestDetails + +`func (o *RequestedItemStatus) GetCancelledRequestDetails() RequestedItemStatusCancelledRequestDetails` + +GetCancelledRequestDetails returns the CancelledRequestDetails field if non-nil, zero value otherwise. + +### GetCancelledRequestDetailsOk + +`func (o *RequestedItemStatus) GetCancelledRequestDetailsOk() (*RequestedItemStatusCancelledRequestDetails, bool)` + +GetCancelledRequestDetailsOk returns a tuple with the CancelledRequestDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCancelledRequestDetails + +`func (o *RequestedItemStatus) SetCancelledRequestDetails(v RequestedItemStatusCancelledRequestDetails)` + +SetCancelledRequestDetails sets CancelledRequestDetails field to given value. + +### HasCancelledRequestDetails + +`func (o *RequestedItemStatus) HasCancelledRequestDetails() bool` + +HasCancelledRequestDetails returns a boolean if a field has been set. + +### GetErrorMessages + +`func (o *RequestedItemStatus) GetErrorMessages() [][]ErrorMessageDto` + +GetErrorMessages returns the ErrorMessages field if non-nil, zero value otherwise. + +### GetErrorMessagesOk + +`func (o *RequestedItemStatus) GetErrorMessagesOk() (*[][]ErrorMessageDto, bool)` + +GetErrorMessagesOk returns a tuple with the ErrorMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessages + +`func (o *RequestedItemStatus) SetErrorMessages(v [][]ErrorMessageDto)` + +SetErrorMessages sets ErrorMessages field to given value. + +### HasErrorMessages + +`func (o *RequestedItemStatus) HasErrorMessages() bool` + +HasErrorMessages returns a boolean if a field has been set. + +### SetErrorMessagesNil + +`func (o *RequestedItemStatus) SetErrorMessagesNil(b bool)` + + SetErrorMessagesNil sets the value for ErrorMessages to be an explicit nil + +### UnsetErrorMessages +`func (o *RequestedItemStatus) UnsetErrorMessages()` + +UnsetErrorMessages ensures that no value is present for ErrorMessages, not even an explicit nil +### GetState + +`func (o *RequestedItemStatus) GetState() RequestedItemStatusRequestState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *RequestedItemStatus) GetStateOk() (*RequestedItemStatusRequestState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *RequestedItemStatus) SetState(v RequestedItemStatusRequestState)` + +SetState sets State field to given value. + +### HasState + +`func (o *RequestedItemStatus) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetApprovalDetails + +`func (o *RequestedItemStatus) GetApprovalDetails() []ApprovalStatusDto` + +GetApprovalDetails returns the ApprovalDetails field if non-nil, zero value otherwise. + +### GetApprovalDetailsOk + +`func (o *RequestedItemStatus) GetApprovalDetailsOk() (*[]ApprovalStatusDto, bool)` + +GetApprovalDetailsOk returns a tuple with the ApprovalDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalDetails + +`func (o *RequestedItemStatus) SetApprovalDetails(v []ApprovalStatusDto)` + +SetApprovalDetails sets ApprovalDetails field to given value. + +### HasApprovalDetails + +`func (o *RequestedItemStatus) HasApprovalDetails() bool` + +HasApprovalDetails returns a boolean if a field has been set. + +### GetApprovalIds + +`func (o *RequestedItemStatus) GetApprovalIds() []string` + +GetApprovalIds returns the ApprovalIds field if non-nil, zero value otherwise. + +### GetApprovalIdsOk + +`func (o *RequestedItemStatus) GetApprovalIdsOk() (*[]string, bool)` + +GetApprovalIdsOk returns a tuple with the ApprovalIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalIds + +`func (o *RequestedItemStatus) SetApprovalIds(v []string)` + +SetApprovalIds sets ApprovalIds field to given value. + +### HasApprovalIds + +`func (o *RequestedItemStatus) HasApprovalIds() bool` + +HasApprovalIds returns a boolean if a field has been set. + +### SetApprovalIdsNil + +`func (o *RequestedItemStatus) SetApprovalIdsNil(b bool)` + + SetApprovalIdsNil sets the value for ApprovalIds to be an explicit nil + +### UnsetApprovalIds +`func (o *RequestedItemStatus) UnsetApprovalIds()` + +UnsetApprovalIds ensures that no value is present for ApprovalIds, not even an explicit nil +### GetManualWorkItemDetails + +`func (o *RequestedItemStatus) GetManualWorkItemDetails() []ManualWorkItemDetails` + +GetManualWorkItemDetails returns the ManualWorkItemDetails field if non-nil, zero value otherwise. + +### GetManualWorkItemDetailsOk + +`func (o *RequestedItemStatus) GetManualWorkItemDetailsOk() (*[]ManualWorkItemDetails, bool)` + +GetManualWorkItemDetailsOk returns a tuple with the ManualWorkItemDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManualWorkItemDetails + +`func (o *RequestedItemStatus) SetManualWorkItemDetails(v []ManualWorkItemDetails)` + +SetManualWorkItemDetails sets ManualWorkItemDetails field to given value. + +### HasManualWorkItemDetails + +`func (o *RequestedItemStatus) HasManualWorkItemDetails() bool` + +HasManualWorkItemDetails returns a boolean if a field has been set. + +### SetManualWorkItemDetailsNil + +`func (o *RequestedItemStatus) SetManualWorkItemDetailsNil(b bool)` + + SetManualWorkItemDetailsNil sets the value for ManualWorkItemDetails to be an explicit nil + +### UnsetManualWorkItemDetails +`func (o *RequestedItemStatus) UnsetManualWorkItemDetails()` + +UnsetManualWorkItemDetails ensures that no value is present for ManualWorkItemDetails, not even an explicit nil +### GetAccountActivityItemId + +`func (o *RequestedItemStatus) GetAccountActivityItemId() string` + +GetAccountActivityItemId returns the AccountActivityItemId field if non-nil, zero value otherwise. + +### GetAccountActivityItemIdOk + +`func (o *RequestedItemStatus) GetAccountActivityItemIdOk() (*string, bool)` + +GetAccountActivityItemIdOk returns a tuple with the AccountActivityItemId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActivityItemId + +`func (o *RequestedItemStatus) SetAccountActivityItemId(v string)` + +SetAccountActivityItemId sets AccountActivityItemId field to given value. + +### HasAccountActivityItemId + +`func (o *RequestedItemStatus) HasAccountActivityItemId() bool` + +HasAccountActivityItemId returns a boolean if a field has been set. + +### GetRequestType + +`func (o *RequestedItemStatus) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *RequestedItemStatus) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *RequestedItemStatus) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *RequestedItemStatus) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *RequestedItemStatus) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *RequestedItemStatus) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetModified + +`func (o *RequestedItemStatus) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RequestedItemStatus) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RequestedItemStatus) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RequestedItemStatus) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *RequestedItemStatus) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *RequestedItemStatus) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetCreated + +`func (o *RequestedItemStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RequestedItemStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RequestedItemStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RequestedItemStatus) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetRequester + +`func (o *RequestedItemStatus) GetRequester() AccessItemRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *RequestedItemStatus) GetRequesterOk() (*AccessItemRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *RequestedItemStatus) SetRequester(v AccessItemRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *RequestedItemStatus) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRequestedFor + +`func (o *RequestedItemStatus) GetRequestedFor() RequestedItemStatusRequestedFor` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *RequestedItemStatus) GetRequestedForOk() (*RequestedItemStatusRequestedFor, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *RequestedItemStatus) SetRequestedFor(v RequestedItemStatusRequestedFor)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *RequestedItemStatus) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *RequestedItemStatus) GetRequesterComment() RequestedItemStatusRequesterComment` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *RequestedItemStatus) GetRequesterCommentOk() (*RequestedItemStatusRequesterComment, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *RequestedItemStatus) SetRequesterComment(v RequestedItemStatusRequesterComment)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *RequestedItemStatus) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### GetSodViolationContext + +`func (o *RequestedItemStatus) GetSodViolationContext() RequestedItemStatusSodViolationContext` + +GetSodViolationContext returns the SodViolationContext field if non-nil, zero value otherwise. + +### GetSodViolationContextOk + +`func (o *RequestedItemStatus) GetSodViolationContextOk() (*RequestedItemStatusSodViolationContext, bool)` + +GetSodViolationContextOk returns a tuple with the SodViolationContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodViolationContext + +`func (o *RequestedItemStatus) SetSodViolationContext(v RequestedItemStatusSodViolationContext)` + +SetSodViolationContext sets SodViolationContext field to given value. + +### HasSodViolationContext + +`func (o *RequestedItemStatus) HasSodViolationContext() bool` + +HasSodViolationContext returns a boolean if a field has been set. + +### GetProvisioningDetails + +`func (o *RequestedItemStatus) GetProvisioningDetails() RequestedItemStatusProvisioningDetails` + +GetProvisioningDetails returns the ProvisioningDetails field if non-nil, zero value otherwise. + +### GetProvisioningDetailsOk + +`func (o *RequestedItemStatus) GetProvisioningDetailsOk() (*RequestedItemStatusProvisioningDetails, bool)` + +GetProvisioningDetailsOk returns a tuple with the ProvisioningDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningDetails + +`func (o *RequestedItemStatus) SetProvisioningDetails(v RequestedItemStatusProvisioningDetails)` + +SetProvisioningDetails sets ProvisioningDetails field to given value. + +### HasProvisioningDetails + +`func (o *RequestedItemStatus) HasProvisioningDetails() bool` + +HasProvisioningDetails returns a boolean if a field has been set. + +### GetPreApprovalTriggerDetails + +`func (o *RequestedItemStatus) GetPreApprovalTriggerDetails() RequestedItemStatusPreApprovalTriggerDetails` + +GetPreApprovalTriggerDetails returns the PreApprovalTriggerDetails field if non-nil, zero value otherwise. + +### GetPreApprovalTriggerDetailsOk + +`func (o *RequestedItemStatus) GetPreApprovalTriggerDetailsOk() (*RequestedItemStatusPreApprovalTriggerDetails, bool)` + +GetPreApprovalTriggerDetailsOk returns a tuple with the PreApprovalTriggerDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreApprovalTriggerDetails + +`func (o *RequestedItemStatus) SetPreApprovalTriggerDetails(v RequestedItemStatusPreApprovalTriggerDetails)` + +SetPreApprovalTriggerDetails sets PreApprovalTriggerDetails field to given value. + +### HasPreApprovalTriggerDetails + +`func (o *RequestedItemStatus) HasPreApprovalTriggerDetails() bool` + +HasPreApprovalTriggerDetails returns a boolean if a field has been set. + +### GetAccessRequestPhases + +`func (o *RequestedItemStatus) GetAccessRequestPhases() []AccessRequestPhases` + +GetAccessRequestPhases returns the AccessRequestPhases field if non-nil, zero value otherwise. + +### GetAccessRequestPhasesOk + +`func (o *RequestedItemStatus) GetAccessRequestPhasesOk() (*[]AccessRequestPhases, bool)` + +GetAccessRequestPhasesOk returns a tuple with the AccessRequestPhases field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestPhases + +`func (o *RequestedItemStatus) SetAccessRequestPhases(v []AccessRequestPhases)` + +SetAccessRequestPhases sets AccessRequestPhases field to given value. + +### HasAccessRequestPhases + +`func (o *RequestedItemStatus) HasAccessRequestPhases() bool` + +HasAccessRequestPhases returns a boolean if a field has been set. + +### SetAccessRequestPhasesNil + +`func (o *RequestedItemStatus) SetAccessRequestPhasesNil(b bool)` + + SetAccessRequestPhasesNil sets the value for AccessRequestPhases to be an explicit nil + +### UnsetAccessRequestPhases +`func (o *RequestedItemStatus) UnsetAccessRequestPhases()` + +UnsetAccessRequestPhases ensures that no value is present for AccessRequestPhases, not even an explicit nil +### GetDescription + +`func (o *RequestedItemStatus) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RequestedItemStatus) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RequestedItemStatus) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RequestedItemStatus) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RequestedItemStatus) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RequestedItemStatus) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetRemoveDate + +`func (o *RequestedItemStatus) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *RequestedItemStatus) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *RequestedItemStatus) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *RequestedItemStatus) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *RequestedItemStatus) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *RequestedItemStatus) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil +### GetCancelable + +`func (o *RequestedItemStatus) GetCancelable() bool` + +GetCancelable returns the Cancelable field if non-nil, zero value otherwise. + +### GetCancelableOk + +`func (o *RequestedItemStatus) GetCancelableOk() (*bool, bool)` + +GetCancelableOk returns a tuple with the Cancelable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCancelable + +`func (o *RequestedItemStatus) SetCancelable(v bool)` + +SetCancelable sets Cancelable field to given value. + +### HasCancelable + +`func (o *RequestedItemStatus) HasCancelable() bool` + +HasCancelable returns a boolean if a field has been set. + +### GetAccessRequestId + +`func (o *RequestedItemStatus) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *RequestedItemStatus) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *RequestedItemStatus) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + +### HasAccessRequestId + +`func (o *RequestedItemStatus) HasAccessRequestId() bool` + +HasAccessRequestId returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *RequestedItemStatus) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *RequestedItemStatus) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *RequestedItemStatus) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *RequestedItemStatus) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *RequestedItemStatus) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *RequestedItemStatus) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetRequestedAccounts + +`func (o *RequestedItemStatus) GetRequestedAccounts() []RequestedAccountRef` + +GetRequestedAccounts returns the RequestedAccounts field if non-nil, zero value otherwise. + +### GetRequestedAccountsOk + +`func (o *RequestedItemStatus) GetRequestedAccountsOk() (*[]RequestedAccountRef, bool)` + +GetRequestedAccountsOk returns a tuple with the RequestedAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedAccounts + +`func (o *RequestedItemStatus) SetRequestedAccounts(v []RequestedAccountRef)` + +SetRequestedAccounts sets RequestedAccounts field to given value. + +### HasRequestedAccounts + +`func (o *RequestedItemStatus) HasRequestedAccounts() bool` + +HasRequestedAccounts returns a boolean if a field has been set. + +### SetRequestedAccountsNil + +`func (o *RequestedItemStatus) SetRequestedAccountsNil(b bool)` + + SetRequestedAccountsNil sets the value for RequestedAccounts to be an explicit nil + +### UnsetRequestedAccounts +`func (o *RequestedItemStatus) UnsetRequestedAccounts()` + +UnsetRequestedAccounts ensures that no value is present for RequestedAccounts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusCancelledRequestDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusCancelledRequestDetails.md new file mode 100644 index 000000000..f358a38df --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusCancelledRequestDetails.md @@ -0,0 +1,116 @@ +--- +id: v2025-requested-item-status-cancelled-request-details +title: RequestedItemStatusCancelledRequestDetails +pagination_label: RequestedItemStatusCancelledRequestDetails +sidebar_label: RequestedItemStatusCancelledRequestDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusCancelledRequestDetails', 'V2025RequestedItemStatusCancelledRequestDetails'] +slug: /tools/sdk/go/v2025/models/requested-item-status-cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusCancelledRequestDetails', 'V2025RequestedItemStatusCancelledRequestDetails'] +--- + +# RequestedItemStatusCancelledRequestDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment made by the owner when cancelling the associated request. | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Modified** | Pointer to **SailPointTime** | Date comment was added by the owner when cancelling the associated request. | [optional] + +## Methods + +### NewRequestedItemStatusCancelledRequestDetails + +`func NewRequestedItemStatusCancelledRequestDetails() *RequestedItemStatusCancelledRequestDetails` + +NewRequestedItemStatusCancelledRequestDetails instantiates a new RequestedItemStatusCancelledRequestDetails 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 + +### NewRequestedItemStatusCancelledRequestDetailsWithDefaults + +`func NewRequestedItemStatusCancelledRequestDetailsWithDefaults() *RequestedItemStatusCancelledRequestDetails` + +NewRequestedItemStatusCancelledRequestDetailsWithDefaults instantiates a new RequestedItemStatusCancelledRequestDetails 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 + +### GetComment + +`func (o *RequestedItemStatusCancelledRequestDetails) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *RequestedItemStatusCancelledRequestDetails) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *RequestedItemStatusCancelledRequestDetails) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *RequestedItemStatusCancelledRequestDetails) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetOwner + +`func (o *RequestedItemStatusCancelledRequestDetails) GetOwner() OwnerDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *RequestedItemStatusCancelledRequestDetails) GetOwnerOk() (*OwnerDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *RequestedItemStatusCancelledRequestDetails) SetOwner(v OwnerDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *RequestedItemStatusCancelledRequestDetails) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetModified + +`func (o *RequestedItemStatusCancelledRequestDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RequestedItemStatusCancelledRequestDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RequestedItemStatusCancelledRequestDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RequestedItemStatusCancelledRequestDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusPreApprovalTriggerDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusPreApprovalTriggerDetails.md new file mode 100644 index 000000000..4ee2ff4ab --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusPreApprovalTriggerDetails.md @@ -0,0 +1,116 @@ +--- +id: v2025-requested-item-status-pre-approval-trigger-details +title: RequestedItemStatusPreApprovalTriggerDetails +pagination_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusPreApprovalTriggerDetails', 'V2025RequestedItemStatusPreApprovalTriggerDetails'] +slug: /tools/sdk/go/v2025/models/requested-item-status-pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusPreApprovalTriggerDetails', 'V2025RequestedItemStatusPreApprovalTriggerDetails'] +--- + +# RequestedItemStatusPreApprovalTriggerDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment left for the pre-approval decision | [optional] +**Reviewer** | Pointer to **string** | The reviewer of the pre-approval decision | [optional] +**Decision** | Pointer to **string** | The decision of the pre-approval trigger | [optional] + +## Methods + +### NewRequestedItemStatusPreApprovalTriggerDetails + +`func NewRequestedItemStatusPreApprovalTriggerDetails() *RequestedItemStatusPreApprovalTriggerDetails` + +NewRequestedItemStatusPreApprovalTriggerDetails instantiates a new RequestedItemStatusPreApprovalTriggerDetails 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 + +### NewRequestedItemStatusPreApprovalTriggerDetailsWithDefaults + +`func NewRequestedItemStatusPreApprovalTriggerDetailsWithDefaults() *RequestedItemStatusPreApprovalTriggerDetails` + +NewRequestedItemStatusPreApprovalTriggerDetailsWithDefaults instantiates a new RequestedItemStatusPreApprovalTriggerDetails 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 + +### GetComment + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetReviewer + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetReviewer() string` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetReviewerOk() (*string, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) SetReviewer(v string)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetDecision + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetDecision() string` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetDecisionOk() (*string, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) SetDecision(v string)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusProvisioningDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusProvisioningDetails.md new file mode 100644 index 000000000..83a71c436 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusProvisioningDetails.md @@ -0,0 +1,64 @@ +--- +id: v2025-requested-item-status-provisioning-details +title: RequestedItemStatusProvisioningDetails +pagination_label: RequestedItemStatusProvisioningDetails +sidebar_label: RequestedItemStatusProvisioningDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusProvisioningDetails', 'V2025RequestedItemStatusProvisioningDetails'] +slug: /tools/sdk/go/v2025/models/requested-item-status-provisioning-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusProvisioningDetails', 'V2025RequestedItemStatusProvisioningDetails'] +--- + +# RequestedItemStatusProvisioningDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrderedSubPhaseReferences** | Pointer to **string** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. | [optional] + +## Methods + +### NewRequestedItemStatusProvisioningDetails + +`func NewRequestedItemStatusProvisioningDetails() *RequestedItemStatusProvisioningDetails` + +NewRequestedItemStatusProvisioningDetails instantiates a new RequestedItemStatusProvisioningDetails 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 + +### NewRequestedItemStatusProvisioningDetailsWithDefaults + +`func NewRequestedItemStatusProvisioningDetailsWithDefaults() *RequestedItemStatusProvisioningDetails` + +NewRequestedItemStatusProvisioningDetailsWithDefaults instantiates a new RequestedItemStatusProvisioningDetails 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 + +### GetOrderedSubPhaseReferences + +`func (o *RequestedItemStatusProvisioningDetails) GetOrderedSubPhaseReferences() string` + +GetOrderedSubPhaseReferences returns the OrderedSubPhaseReferences field if non-nil, zero value otherwise. + +### GetOrderedSubPhaseReferencesOk + +`func (o *RequestedItemStatusProvisioningDetails) GetOrderedSubPhaseReferencesOk() (*string, bool)` + +GetOrderedSubPhaseReferencesOk returns a tuple with the OrderedSubPhaseReferences field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderedSubPhaseReferences + +`func (o *RequestedItemStatusProvisioningDetails) SetOrderedSubPhaseReferences(v string)` + +SetOrderedSubPhaseReferences sets OrderedSubPhaseReferences field to given value. + +### HasOrderedSubPhaseReferences + +`func (o *RequestedItemStatusProvisioningDetails) HasOrderedSubPhaseReferences() bool` + +HasOrderedSubPhaseReferences returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusRequestState.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusRequestState.md new file mode 100644 index 000000000..9f533311e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusRequestState.md @@ -0,0 +1,35 @@ +--- +id: v2025-requested-item-status-request-state +title: RequestedItemStatusRequestState +pagination_label: RequestedItemStatusRequestState +sidebar_label: RequestedItemStatusRequestState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusRequestState', 'V2025RequestedItemStatusRequestState'] +slug: /tools/sdk/go/v2025/models/requested-item-status-request-state +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestState', 'V2025RequestedItemStatusRequestState'] +--- + +# RequestedItemStatusRequestState + +## Enum + + +* `EXECUTING` (value: `"EXECUTING"`) + +* `REQUEST_COMPLETED` (value: `"REQUEST_COMPLETED"`) + +* `CANCELLED` (value: `"CANCELLED"`) + +* `TERMINATED` (value: `"TERMINATED"`) + +* `PROVISIONING_VERIFICATION_PENDING` (value: `"PROVISIONING_VERIFICATION_PENDING"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `PROVISIONING_FAILED` (value: `"PROVISIONING_FAILED"`) + +* `NOT_ALL_ITEMS_PROVISIONED` (value: `"NOT_ALL_ITEMS_PROVISIONED"`) + +* `ERROR` (value: `"ERROR"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusRequestedFor.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusRequestedFor.md new file mode 100644 index 000000000..dbe8aab8e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusRequestedFor.md @@ -0,0 +1,116 @@ +--- +id: v2025-requested-item-status-requested-for +title: RequestedItemStatusRequestedFor +pagination_label: RequestedItemStatusRequestedFor +sidebar_label: RequestedItemStatusRequestedFor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusRequestedFor', 'V2025RequestedItemStatusRequestedFor'] +slug: /tools/sdk/go/v2025/models/requested-item-status-requested-for +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestedFor', 'V2025RequestedItemStatusRequestedFor'] +--- + +# RequestedItemStatusRequestedFor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the object to which this reference applies | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewRequestedItemStatusRequestedFor + +`func NewRequestedItemStatusRequestedFor() *RequestedItemStatusRequestedFor` + +NewRequestedItemStatusRequestedFor instantiates a new RequestedItemStatusRequestedFor 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 + +### NewRequestedItemStatusRequestedForWithDefaults + +`func NewRequestedItemStatusRequestedForWithDefaults() *RequestedItemStatusRequestedFor` + +NewRequestedItemStatusRequestedForWithDefaults instantiates a new RequestedItemStatusRequestedFor 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 + +### GetType + +`func (o *RequestedItemStatusRequestedFor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemStatusRequestedFor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemStatusRequestedFor) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedItemStatusRequestedFor) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RequestedItemStatusRequestedFor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemStatusRequestedFor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemStatusRequestedFor) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestedItemStatusRequestedFor) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RequestedItemStatusRequestedFor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestedItemStatusRequestedFor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestedItemStatusRequestedFor) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestedItemStatusRequestedFor) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusRequesterComment.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusRequesterComment.md new file mode 100644 index 000000000..99fda04c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusRequesterComment.md @@ -0,0 +1,126 @@ +--- +id: v2025-requested-item-status-requester-comment +title: RequestedItemStatusRequesterComment +pagination_label: RequestedItemStatusRequesterComment +sidebar_label: RequestedItemStatusRequesterComment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusRequesterComment', 'V2025RequestedItemStatusRequesterComment'] +slug: /tools/sdk/go/v2025/models/requested-item-status-requester-comment +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequesterComment', 'V2025RequestedItemStatusRequesterComment'] +--- + +# RequestedItemStatusRequesterComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **NullableString** | Comment content. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Methods + +### NewRequestedItemStatusRequesterComment + +`func NewRequestedItemStatusRequesterComment() *RequestedItemStatusRequesterComment` + +NewRequestedItemStatusRequesterComment instantiates a new RequestedItemStatusRequesterComment 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 + +### NewRequestedItemStatusRequesterCommentWithDefaults + +`func NewRequestedItemStatusRequesterCommentWithDefaults() *RequestedItemStatusRequesterComment` + +NewRequestedItemStatusRequesterCommentWithDefaults instantiates a new RequestedItemStatusRequesterComment 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 + +### GetComment + +`func (o *RequestedItemStatusRequesterComment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *RequestedItemStatusRequesterComment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *RequestedItemStatusRequesterComment) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *RequestedItemStatusRequesterComment) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *RequestedItemStatusRequesterComment) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *RequestedItemStatusRequesterComment) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetCreated + +`func (o *RequestedItemStatusRequesterComment) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RequestedItemStatusRequesterComment) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RequestedItemStatusRequesterComment) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RequestedItemStatusRequesterComment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetAuthor + +`func (o *RequestedItemStatusRequesterComment) GetAuthor() CommentDtoAuthor` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *RequestedItemStatusRequesterComment) GetAuthorOk() (*CommentDtoAuthor, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *RequestedItemStatusRequesterComment) SetAuthor(v CommentDtoAuthor)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *RequestedItemStatusRequesterComment) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusSodViolationContext.md b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusSodViolationContext.md new file mode 100644 index 000000000..ad20f6c85 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RequestedItemStatusSodViolationContext.md @@ -0,0 +1,136 @@ +--- +id: v2025-requested-item-status-sod-violation-context +title: RequestedItemStatusSodViolationContext +pagination_label: RequestedItemStatusSodViolationContext +sidebar_label: RequestedItemStatusSodViolationContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusSodViolationContext', 'V2025RequestedItemStatusSodViolationContext'] +slug: /tools/sdk/go/v2025/models/requested-item-status-sod-violation-context +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusSodViolationContext', 'V2025RequestedItemStatusSodViolationContext'] +--- + +# RequestedItemStatusSodViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **NullableString** | The status of SOD violation check | [optional] +**Uuid** | Pointer to **NullableString** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] + +## Methods + +### NewRequestedItemStatusSodViolationContext + +`func NewRequestedItemStatusSodViolationContext() *RequestedItemStatusSodViolationContext` + +NewRequestedItemStatusSodViolationContext instantiates a new RequestedItemStatusSodViolationContext 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 + +### NewRequestedItemStatusSodViolationContextWithDefaults + +`func NewRequestedItemStatusSodViolationContextWithDefaults() *RequestedItemStatusSodViolationContext` + +NewRequestedItemStatusSodViolationContextWithDefaults instantiates a new RequestedItemStatusSodViolationContext 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 + +### GetState + +`func (o *RequestedItemStatusSodViolationContext) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *RequestedItemStatusSodViolationContext) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *RequestedItemStatusSodViolationContext) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *RequestedItemStatusSodViolationContext) HasState() bool` + +HasState returns a boolean if a field has been set. + +### SetStateNil + +`func (o *RequestedItemStatusSodViolationContext) SetStateNil(b bool)` + + SetStateNil sets the value for State to be an explicit nil + +### UnsetState +`func (o *RequestedItemStatusSodViolationContext) UnsetState()` + +UnsetState ensures that no value is present for State, not even an explicit nil +### GetUuid + +`func (o *RequestedItemStatusSodViolationContext) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *RequestedItemStatusSodViolationContext) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *RequestedItemStatusSodViolationContext) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *RequestedItemStatusSodViolationContext) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *RequestedItemStatusSodViolationContext) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *RequestedItemStatusSodViolationContext) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetViolationCheckResult + +`func (o *RequestedItemStatusSodViolationContext) GetViolationCheckResult() SodViolationCheckResult` + +GetViolationCheckResult returns the ViolationCheckResult field if non-nil, zero value otherwise. + +### GetViolationCheckResultOk + +`func (o *RequestedItemStatusSodViolationContext) GetViolationCheckResultOk() (*SodViolationCheckResult, bool)` + +GetViolationCheckResultOk returns a tuple with the ViolationCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationCheckResult + +`func (o *RequestedItemStatusSodViolationContext) SetViolationCheckResult(v SodViolationCheckResult)` + +SetViolationCheckResult sets ViolationCheckResult field to given value. + +### HasViolationCheckResult + +`func (o *RequestedItemStatusSodViolationContext) HasViolationCheckResult() bool` + +HasViolationCheckResult returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ResourceObject.md b/docs/tools/sdk/go/Reference/V2025/Models/ResourceObject.md new file mode 100644 index 000000000..f4061fdb3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ResourceObject.md @@ -0,0 +1,376 @@ +--- +id: v2025-resource-object +title: ResourceObject +pagination_label: ResourceObject +sidebar_label: ResourceObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ResourceObject', 'V2025ResourceObject'] +slug: /tools/sdk/go/v2025/models/resource-object +tags: ['SDK', 'Software Development Kit', 'ResourceObject', 'V2025ResourceObject'] +--- + +# ResourceObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Instance** | Pointer to **string** | Identifier of the specific instance where this object resides. | [optional] [readonly] +**Identity** | Pointer to **string** | Native identity of the object in the Source. | [optional] [readonly] +**Uuid** | Pointer to **string** | Universal unique identifier of the object in the Source. | [optional] [readonly] +**PreviousIdentity** | Pointer to **string** | Native identity that the object has previously. | [optional] [readonly] +**Name** | Pointer to **string** | Display name for this object. | [optional] [readonly] +**ObjectType** | Pointer to **string** | Type of object. | [optional] [readonly] +**Incomplete** | Pointer to **bool** | A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. | [optional] [readonly] +**Incremental** | Pointer to **bool** | A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. | [optional] [readonly] +**Delete** | Pointer to **bool** | A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. | [optional] [readonly] +**Remove** | Pointer to **bool** | A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. | [optional] [readonly] +**Missing** | Pointer to **[]string** | A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain \"groups\". | [optional] [readonly] +**Attributes** | Pointer to **map[string]interface{}** | Attributes of this ResourceObject. | [optional] [readonly] +**FinalUpdate** | Pointer to **bool** | In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. | [optional] [readonly] + +## Methods + +### NewResourceObject + +`func NewResourceObject() *ResourceObject` + +NewResourceObject instantiates a new ResourceObject 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 + +### NewResourceObjectWithDefaults + +`func NewResourceObjectWithDefaults() *ResourceObject` + +NewResourceObjectWithDefaults instantiates a new ResourceObject 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 + +### GetInstance + +`func (o *ResourceObject) GetInstance() string` + +GetInstance returns the Instance field if non-nil, zero value otherwise. + +### GetInstanceOk + +`func (o *ResourceObject) GetInstanceOk() (*string, bool)` + +GetInstanceOk returns a tuple with the Instance field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstance + +`func (o *ResourceObject) SetInstance(v string)` + +SetInstance sets Instance field to given value. + +### HasInstance + +`func (o *ResourceObject) HasInstance() bool` + +HasInstance returns a boolean if a field has been set. + +### GetIdentity + +`func (o *ResourceObject) GetIdentity() string` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *ResourceObject) GetIdentityOk() (*string, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *ResourceObject) SetIdentity(v string)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *ResourceObject) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetUuid + +`func (o *ResourceObject) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *ResourceObject) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *ResourceObject) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *ResourceObject) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### GetPreviousIdentity + +`func (o *ResourceObject) GetPreviousIdentity() string` + +GetPreviousIdentity returns the PreviousIdentity field if non-nil, zero value otherwise. + +### GetPreviousIdentityOk + +`func (o *ResourceObject) GetPreviousIdentityOk() (*string, bool)` + +GetPreviousIdentityOk returns a tuple with the PreviousIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousIdentity + +`func (o *ResourceObject) SetPreviousIdentity(v string)` + +SetPreviousIdentity sets PreviousIdentity field to given value. + +### HasPreviousIdentity + +`func (o *ResourceObject) HasPreviousIdentity() bool` + +HasPreviousIdentity returns a boolean if a field has been set. + +### GetName + +`func (o *ResourceObject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ResourceObject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ResourceObject) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ResourceObject) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetObjectType + +`func (o *ResourceObject) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *ResourceObject) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *ResourceObject) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + +### HasObjectType + +`func (o *ResourceObject) HasObjectType() bool` + +HasObjectType returns a boolean if a field has been set. + +### GetIncomplete + +`func (o *ResourceObject) GetIncomplete() bool` + +GetIncomplete returns the Incomplete field if non-nil, zero value otherwise. + +### GetIncompleteOk + +`func (o *ResourceObject) GetIncompleteOk() (*bool, bool)` + +GetIncompleteOk returns a tuple with the Incomplete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncomplete + +`func (o *ResourceObject) SetIncomplete(v bool)` + +SetIncomplete sets Incomplete field to given value. + +### HasIncomplete + +`func (o *ResourceObject) HasIncomplete() bool` + +HasIncomplete returns a boolean if a field has been set. + +### GetIncremental + +`func (o *ResourceObject) GetIncremental() bool` + +GetIncremental returns the Incremental field if non-nil, zero value otherwise. + +### GetIncrementalOk + +`func (o *ResourceObject) GetIncrementalOk() (*bool, bool)` + +GetIncrementalOk returns a tuple with the Incremental field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncremental + +`func (o *ResourceObject) SetIncremental(v bool)` + +SetIncremental sets Incremental field to given value. + +### HasIncremental + +`func (o *ResourceObject) HasIncremental() bool` + +HasIncremental returns a boolean if a field has been set. + +### GetDelete + +`func (o *ResourceObject) GetDelete() bool` + +GetDelete returns the Delete field if non-nil, zero value otherwise. + +### GetDeleteOk + +`func (o *ResourceObject) GetDeleteOk() (*bool, bool)` + +GetDeleteOk returns a tuple with the Delete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDelete + +`func (o *ResourceObject) SetDelete(v bool)` + +SetDelete sets Delete field to given value. + +### HasDelete + +`func (o *ResourceObject) HasDelete() bool` + +HasDelete returns a boolean if a field has been set. + +### GetRemove + +`func (o *ResourceObject) GetRemove() bool` + +GetRemove returns the Remove field if non-nil, zero value otherwise. + +### GetRemoveOk + +`func (o *ResourceObject) GetRemoveOk() (*bool, bool)` + +GetRemoveOk returns a tuple with the Remove field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemove + +`func (o *ResourceObject) SetRemove(v bool)` + +SetRemove sets Remove field to given value. + +### HasRemove + +`func (o *ResourceObject) HasRemove() bool` + +HasRemove returns a boolean if a field has been set. + +### GetMissing + +`func (o *ResourceObject) GetMissing() []string` + +GetMissing returns the Missing field if non-nil, zero value otherwise. + +### GetMissingOk + +`func (o *ResourceObject) GetMissingOk() (*[]string, bool)` + +GetMissingOk returns a tuple with the Missing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMissing + +`func (o *ResourceObject) SetMissing(v []string)` + +SetMissing sets Missing field to given value. + +### HasMissing + +`func (o *ResourceObject) HasMissing() bool` + +HasMissing returns a boolean if a field has been set. + +### GetAttributes + +`func (o *ResourceObject) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ResourceObject) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ResourceObject) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ResourceObject) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetFinalUpdate + +`func (o *ResourceObject) GetFinalUpdate() bool` + +GetFinalUpdate returns the FinalUpdate field if non-nil, zero value otherwise. + +### GetFinalUpdateOk + +`func (o *ResourceObject) GetFinalUpdateOk() (*bool, bool)` + +GetFinalUpdateOk returns a tuple with the FinalUpdate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFinalUpdate + +`func (o *ResourceObject) SetFinalUpdate(v bool)` + +SetFinalUpdate sets FinalUpdate field to given value. + +### HasFinalUpdate + +`func (o *ResourceObject) HasFinalUpdate() bool` + +HasFinalUpdate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ResourceObjectsRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/ResourceObjectsRequest.md new file mode 100644 index 000000000..1c6ab830d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ResourceObjectsRequest.md @@ -0,0 +1,90 @@ +--- +id: v2025-resource-objects-request +title: ResourceObjectsRequest +pagination_label: ResourceObjectsRequest +sidebar_label: ResourceObjectsRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ResourceObjectsRequest', 'V2025ResourceObjectsRequest'] +slug: /tools/sdk/go/v2025/models/resource-objects-request +tags: ['SDK', 'Software Development Kit', 'ResourceObjectsRequest', 'V2025ResourceObjectsRequest'] +--- + +# ResourceObjectsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectType** | Pointer to **string** | The type of resource objects to iterate over. | [optional] [default to "account"] +**MaxCount** | Pointer to **int32** | The maximum number of resource objects to iterate over and return. | [optional] [default to 25] + +## Methods + +### NewResourceObjectsRequest + +`func NewResourceObjectsRequest() *ResourceObjectsRequest` + +NewResourceObjectsRequest instantiates a new ResourceObjectsRequest 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 + +### NewResourceObjectsRequestWithDefaults + +`func NewResourceObjectsRequestWithDefaults() *ResourceObjectsRequest` + +NewResourceObjectsRequestWithDefaults instantiates a new ResourceObjectsRequest 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 + +### GetObjectType + +`func (o *ResourceObjectsRequest) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *ResourceObjectsRequest) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *ResourceObjectsRequest) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + +### HasObjectType + +`func (o *ResourceObjectsRequest) HasObjectType() bool` + +HasObjectType returns a boolean if a field has been set. + +### GetMaxCount + +`func (o *ResourceObjectsRequest) GetMaxCount() int32` + +GetMaxCount returns the MaxCount field if non-nil, zero value otherwise. + +### GetMaxCountOk + +`func (o *ResourceObjectsRequest) GetMaxCountOk() (*int32, bool)` + +GetMaxCountOk returns a tuple with the MaxCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxCount + +`func (o *ResourceObjectsRequest) SetMaxCount(v int32)` + +SetMaxCount sets MaxCount field to given value. + +### HasMaxCount + +`func (o *ResourceObjectsRequest) HasMaxCount() bool` + +HasMaxCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ResourceObjectsResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ResourceObjectsResponse.md new file mode 100644 index 000000000..e976dadb1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ResourceObjectsResponse.md @@ -0,0 +1,168 @@ +--- +id: v2025-resource-objects-response +title: ResourceObjectsResponse +pagination_label: ResourceObjectsResponse +sidebar_label: ResourceObjectsResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ResourceObjectsResponse', 'V2025ResourceObjectsResponse'] +slug: /tools/sdk/go/v2025/models/resource-objects-response +tags: ['SDK', 'Software Development Kit', 'ResourceObjectsResponse', 'V2025ResourceObjectsResponse'] +--- + +# ResourceObjectsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the source | [optional] [readonly] +**Name** | Pointer to **string** | Name of the source | [optional] [readonly] +**ObjectCount** | Pointer to **int32** | The number of objects that were fetched by the connector. | [optional] [readonly] +**ElapsedMillis** | Pointer to **int32** | The number of milliseconds spent on the entire request. | [optional] [readonly] +**ResourceObjects** | Pointer to [**[]ResourceObject**](resource-object) | Fetched objects from the source connector. | [optional] [readonly] + +## Methods + +### NewResourceObjectsResponse + +`func NewResourceObjectsResponse() *ResourceObjectsResponse` + +NewResourceObjectsResponse instantiates a new ResourceObjectsResponse 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 + +### NewResourceObjectsResponseWithDefaults + +`func NewResourceObjectsResponseWithDefaults() *ResourceObjectsResponse` + +NewResourceObjectsResponseWithDefaults instantiates a new ResourceObjectsResponse 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 + +### GetId + +`func (o *ResourceObjectsResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ResourceObjectsResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ResourceObjectsResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ResourceObjectsResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ResourceObjectsResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ResourceObjectsResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ResourceObjectsResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ResourceObjectsResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetObjectCount + +`func (o *ResourceObjectsResponse) GetObjectCount() int32` + +GetObjectCount returns the ObjectCount field if non-nil, zero value otherwise. + +### GetObjectCountOk + +`func (o *ResourceObjectsResponse) GetObjectCountOk() (*int32, bool)` + +GetObjectCountOk returns a tuple with the ObjectCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectCount + +`func (o *ResourceObjectsResponse) SetObjectCount(v int32)` + +SetObjectCount sets ObjectCount field to given value. + +### HasObjectCount + +`func (o *ResourceObjectsResponse) HasObjectCount() bool` + +HasObjectCount returns a boolean if a field has been set. + +### GetElapsedMillis + +`func (o *ResourceObjectsResponse) GetElapsedMillis() int32` + +GetElapsedMillis returns the ElapsedMillis field if non-nil, zero value otherwise. + +### GetElapsedMillisOk + +`func (o *ResourceObjectsResponse) GetElapsedMillisOk() (*int32, bool)` + +GetElapsedMillisOk returns a tuple with the ElapsedMillis field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElapsedMillis + +`func (o *ResourceObjectsResponse) SetElapsedMillis(v int32)` + +SetElapsedMillis sets ElapsedMillis field to given value. + +### HasElapsedMillis + +`func (o *ResourceObjectsResponse) HasElapsedMillis() bool` + +HasElapsedMillis returns a boolean if a field has been set. + +### GetResourceObjects + +`func (o *ResourceObjectsResponse) GetResourceObjects() []ResourceObject` + +GetResourceObjects returns the ResourceObjects field if non-nil, zero value otherwise. + +### GetResourceObjectsOk + +`func (o *ResourceObjectsResponse) GetResourceObjectsOk() (*[]ResourceObject, bool)` + +GetResourceObjectsOk returns a tuple with the ResourceObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResourceObjects + +`func (o *ResourceObjectsResponse) SetResourceObjects(v []ResourceObject)` + +SetResourceObjects sets ResourceObjects field to given value. + +### HasResourceObjects + +`func (o *ResourceObjectsResponse) HasResourceObjects() bool` + +HasResourceObjects returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Result.md b/docs/tools/sdk/go/Reference/V2025/Models/Result.md new file mode 100644 index 000000000..4a267ccaf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Result.md @@ -0,0 +1,64 @@ +--- +id: v2025-result +title: Result +pagination_label: Result +sidebar_label: Result +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Result', 'V2025Result'] +slug: /tools/sdk/go/v2025/models/result +tags: ['SDK', 'Software Development Kit', 'Result', 'V2025Result'] +--- + +# Result + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | Request result status | [optional] + +## Methods + +### NewResult + +`func NewResult() *Result` + +NewResult instantiates a new Result 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 + +### NewResultWithDefaults + +`func NewResultWithDefaults() *Result` + +NewResultWithDefaults instantiates a new Result 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 + +### GetStatus + +`func (o *Result) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Result) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Result) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Result) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReviewDecision.md b/docs/tools/sdk/go/Reference/V2025/Models/ReviewDecision.md new file mode 100644 index 000000000..b8ba6365d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReviewDecision.md @@ -0,0 +1,179 @@ +--- +id: v2025-review-decision +title: ReviewDecision +pagination_label: ReviewDecision +sidebar_label: ReviewDecision +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewDecision', 'V2025ReviewDecision'] +slug: /tools/sdk/go/v2025/models/review-decision +tags: ['SDK', 'Software Development Kit', 'ReviewDecision', 'V2025ReviewDecision'] +--- + +# ReviewDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The id of the review decision | +**Decision** | [**CertificationDecision**](certification-decision) | | +**ProposedEndDate** | Pointer to **SailPointTime** | The date at which a user's access should be taken away. Should only be set for `REVOKE` decisions. | [optional] +**Bulk** | **bool** | Indicates whether decision should be marked as part of a larger bulk decision | +**Recommendation** | Pointer to [**ReviewRecommendation**](review-recommendation) | | [optional] +**Comments** | Pointer to **string** | Comments recorded when the decision was made | [optional] + +## Methods + +### NewReviewDecision + +`func NewReviewDecision(id string, decision CertificationDecision, bulk bool, ) *ReviewDecision` + +NewReviewDecision instantiates a new ReviewDecision 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 + +### NewReviewDecisionWithDefaults + +`func NewReviewDecisionWithDefaults() *ReviewDecision` + +NewReviewDecisionWithDefaults instantiates a new ReviewDecision 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 + +### GetId + +`func (o *ReviewDecision) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewDecision) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewDecision) SetId(v string)` + +SetId sets Id field to given value. + + +### GetDecision + +`func (o *ReviewDecision) GetDecision() CertificationDecision` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *ReviewDecision) GetDecisionOk() (*CertificationDecision, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *ReviewDecision) SetDecision(v CertificationDecision)` + +SetDecision sets Decision field to given value. + + +### GetProposedEndDate + +`func (o *ReviewDecision) GetProposedEndDate() SailPointTime` + +GetProposedEndDate returns the ProposedEndDate field if non-nil, zero value otherwise. + +### GetProposedEndDateOk + +`func (o *ReviewDecision) GetProposedEndDateOk() (*SailPointTime, bool)` + +GetProposedEndDateOk returns a tuple with the ProposedEndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProposedEndDate + +`func (o *ReviewDecision) SetProposedEndDate(v SailPointTime)` + +SetProposedEndDate sets ProposedEndDate field to given value. + +### HasProposedEndDate + +`func (o *ReviewDecision) HasProposedEndDate() bool` + +HasProposedEndDate returns a boolean if a field has been set. + +### GetBulk + +`func (o *ReviewDecision) GetBulk() bool` + +GetBulk returns the Bulk field if non-nil, zero value otherwise. + +### GetBulkOk + +`func (o *ReviewDecision) GetBulkOk() (*bool, bool)` + +GetBulkOk returns a tuple with the Bulk field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBulk + +`func (o *ReviewDecision) SetBulk(v bool)` + +SetBulk sets Bulk field to given value. + + +### GetRecommendation + +`func (o *ReviewDecision) GetRecommendation() ReviewRecommendation` + +GetRecommendation returns the Recommendation field if non-nil, zero value otherwise. + +### GetRecommendationOk + +`func (o *ReviewDecision) GetRecommendationOk() (*ReviewRecommendation, bool)` + +GetRecommendationOk returns a tuple with the Recommendation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendation + +`func (o *ReviewDecision) SetRecommendation(v ReviewRecommendation)` + +SetRecommendation sets Recommendation field to given value. + +### HasRecommendation + +`func (o *ReviewDecision) HasRecommendation() bool` + +HasRecommendation returns a boolean if a field has been set. + +### GetComments + +`func (o *ReviewDecision) GetComments() string` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *ReviewDecision) GetCommentsOk() (*string, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *ReviewDecision) SetComments(v string)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *ReviewDecision) HasComments() bool` + +HasComments returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReviewReassign.md b/docs/tools/sdk/go/Reference/V2025/Models/ReviewReassign.md new file mode 100644 index 000000000..714b1542f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReviewReassign.md @@ -0,0 +1,101 @@ +--- +id: v2025-review-reassign +title: ReviewReassign +pagination_label: ReviewReassign +sidebar_label: ReviewReassign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewReassign', 'V2025ReviewReassign'] +slug: /tools/sdk/go/v2025/models/review-reassign +tags: ['SDK', 'Software Development Kit', 'ReviewReassign', 'V2025ReviewReassign'] +--- + +# ReviewReassign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Reassign** | [**[]ReassignReference**](reassign-reference) | | +**ReassignTo** | **string** | The ID of the identity to which the certification is reassigned | +**Reason** | **string** | The reason comment for why the reassign was made | + +## Methods + +### NewReviewReassign + +`func NewReviewReassign(reassign []ReassignReference, reassignTo string, reason string, ) *ReviewReassign` + +NewReviewReassign instantiates a new ReviewReassign 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 + +### NewReviewReassignWithDefaults + +`func NewReviewReassignWithDefaults() *ReviewReassign` + +NewReviewReassignWithDefaults instantiates a new ReviewReassign 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 + +### GetReassign + +`func (o *ReviewReassign) GetReassign() []ReassignReference` + +GetReassign returns the Reassign field if non-nil, zero value otherwise. + +### GetReassignOk + +`func (o *ReviewReassign) GetReassignOk() (*[]ReassignReference, bool)` + +GetReassignOk returns a tuple with the Reassign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassign + +`func (o *ReviewReassign) SetReassign(v []ReassignReference)` + +SetReassign sets Reassign field to given value. + + +### GetReassignTo + +`func (o *ReviewReassign) GetReassignTo() string` + +GetReassignTo returns the ReassignTo field if non-nil, zero value otherwise. + +### GetReassignToOk + +`func (o *ReviewReassign) GetReassignToOk() (*string, bool)` + +GetReassignToOk returns a tuple with the ReassignTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignTo + +`func (o *ReviewReassign) SetReassignTo(v string)` + +SetReassignTo sets ReassignTo field to given value. + + +### GetReason + +`func (o *ReviewReassign) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *ReviewReassign) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *ReviewReassign) SetReason(v string)` + +SetReason sets Reason field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReviewRecommendation.md b/docs/tools/sdk/go/Reference/V2025/Models/ReviewRecommendation.md new file mode 100644 index 000000000..27b2385b8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReviewRecommendation.md @@ -0,0 +1,126 @@ +--- +id: v2025-review-recommendation +title: ReviewRecommendation +pagination_label: ReviewRecommendation +sidebar_label: ReviewRecommendation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewRecommendation', 'V2025ReviewRecommendation'] +slug: /tools/sdk/go/v2025/models/review-recommendation +tags: ['SDK', 'Software Development Kit', 'ReviewRecommendation', 'V2025ReviewRecommendation'] +--- + +# ReviewRecommendation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Recommendation** | Pointer to **NullableString** | The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. | [optional] +**Reasons** | Pointer to **[]string** | A list of reasons for the recommendation. | [optional] +**Timestamp** | Pointer to **SailPointTime** | The time at which the recommendation was recorded. | [optional] + +## Methods + +### NewReviewRecommendation + +`func NewReviewRecommendation() *ReviewRecommendation` + +NewReviewRecommendation instantiates a new ReviewRecommendation 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 + +### NewReviewRecommendationWithDefaults + +`func NewReviewRecommendationWithDefaults() *ReviewRecommendation` + +NewReviewRecommendationWithDefaults instantiates a new ReviewRecommendation 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 + +### GetRecommendation + +`func (o *ReviewRecommendation) GetRecommendation() string` + +GetRecommendation returns the Recommendation field if non-nil, zero value otherwise. + +### GetRecommendationOk + +`func (o *ReviewRecommendation) GetRecommendationOk() (*string, bool)` + +GetRecommendationOk returns a tuple with the Recommendation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendation + +`func (o *ReviewRecommendation) SetRecommendation(v string)` + +SetRecommendation sets Recommendation field to given value. + +### HasRecommendation + +`func (o *ReviewRecommendation) HasRecommendation() bool` + +HasRecommendation returns a boolean if a field has been set. + +### SetRecommendationNil + +`func (o *ReviewRecommendation) SetRecommendationNil(b bool)` + + SetRecommendationNil sets the value for Recommendation to be an explicit nil + +### UnsetRecommendation +`func (o *ReviewRecommendation) UnsetRecommendation()` + +UnsetRecommendation ensures that no value is present for Recommendation, not even an explicit nil +### GetReasons + +`func (o *ReviewRecommendation) GetReasons() []string` + +GetReasons returns the Reasons field if non-nil, zero value otherwise. + +### GetReasonsOk + +`func (o *ReviewRecommendation) GetReasonsOk() (*[]string, bool)` + +GetReasonsOk returns a tuple with the Reasons field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReasons + +`func (o *ReviewRecommendation) SetReasons(v []string)` + +SetReasons sets Reasons field to given value. + +### HasReasons + +`func (o *ReviewRecommendation) HasReasons() bool` + +HasReasons returns a boolean if a field has been set. + +### GetTimestamp + +`func (o *ReviewRecommendation) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *ReviewRecommendation) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *ReviewRecommendation) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *ReviewRecommendation) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReviewableAccessProfile.md b/docs/tools/sdk/go/Reference/V2025/Models/ReviewableAccessProfile.md new file mode 100644 index 000000000..157f681bd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReviewableAccessProfile.md @@ -0,0 +1,318 @@ +--- +id: v2025-reviewable-access-profile +title: ReviewableAccessProfile +pagination_label: ReviewableAccessProfile +sidebar_label: ReviewableAccessProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewableAccessProfile', 'V2025ReviewableAccessProfile'] +slug: /tools/sdk/go/v2025/models/reviewable-access-profile +tags: ['SDK', 'Software Development Kit', 'ReviewableAccessProfile', 'V2025ReviewableAccessProfile'] +--- + +# ReviewableAccessProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the Access Profile | [optional] +**Name** | Pointer to **string** | Name of the Access Profile | [optional] +**Description** | Pointer to **string** | Information about the Access Profile | [optional] +**Privileged** | Pointer to **bool** | Indicates if the entitlement is a privileged entitlement | [optional] +**CloudGoverned** | Pointer to **bool** | True if the entitlement is cloud governed | [optional] +**EndDate** | Pointer to **NullableTime** | The date at which a user's access expires | [optional] +**Owner** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**Entitlements** | Pointer to [**[]ReviewableEntitlement**](reviewable-entitlement) | A list of entitlements associated with this Access Profile | [optional] +**Created** | Pointer to **SailPointTime** | Date the Access Profile was created. | [optional] +**Modified** | Pointer to **SailPointTime** | Date the Access Profile was last modified. | [optional] + +## Methods + +### NewReviewableAccessProfile + +`func NewReviewableAccessProfile() *ReviewableAccessProfile` + +NewReviewableAccessProfile instantiates a new ReviewableAccessProfile 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 + +### NewReviewableAccessProfileWithDefaults + +`func NewReviewableAccessProfileWithDefaults() *ReviewableAccessProfile` + +NewReviewableAccessProfileWithDefaults instantiates a new ReviewableAccessProfile 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 + +### GetId + +`func (o *ReviewableAccessProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewableAccessProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewableAccessProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReviewableAccessProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ReviewableAccessProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ReviewableAccessProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ReviewableAccessProfile) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ReviewableAccessProfile) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ReviewableAccessProfile) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ReviewableAccessProfile) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ReviewableAccessProfile) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ReviewableAccessProfile) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *ReviewableAccessProfile) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *ReviewableAccessProfile) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *ReviewableAccessProfile) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *ReviewableAccessProfile) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetCloudGoverned + +`func (o *ReviewableAccessProfile) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *ReviewableAccessProfile) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *ReviewableAccessProfile) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + +### HasCloudGoverned + +`func (o *ReviewableAccessProfile) HasCloudGoverned() bool` + +HasCloudGoverned returns a boolean if a field has been set. + +### GetEndDate + +`func (o *ReviewableAccessProfile) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *ReviewableAccessProfile) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *ReviewableAccessProfile) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *ReviewableAccessProfile) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### SetEndDateNil + +`func (o *ReviewableAccessProfile) SetEndDateNil(b bool)` + + SetEndDateNil sets the value for EndDate to be an explicit nil + +### UnsetEndDate +`func (o *ReviewableAccessProfile) UnsetEndDate()` + +UnsetEndDate ensures that no value is present for EndDate, not even an explicit nil +### GetOwner + +`func (o *ReviewableAccessProfile) GetOwner() IdentityReferenceWithNameAndEmail` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *ReviewableAccessProfile) GetOwnerOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *ReviewableAccessProfile) SetOwner(v IdentityReferenceWithNameAndEmail)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *ReviewableAccessProfile) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *ReviewableAccessProfile) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *ReviewableAccessProfile) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetEntitlements + +`func (o *ReviewableAccessProfile) GetEntitlements() []ReviewableEntitlement` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *ReviewableAccessProfile) GetEntitlementsOk() (*[]ReviewableEntitlement, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *ReviewableAccessProfile) SetEntitlements(v []ReviewableEntitlement)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *ReviewableAccessProfile) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetCreated + +`func (o *ReviewableAccessProfile) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ReviewableAccessProfile) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ReviewableAccessProfile) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ReviewableAccessProfile) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *ReviewableAccessProfile) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ReviewableAccessProfile) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ReviewableAccessProfile) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ReviewableAccessProfile) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReviewableEntitlement.md b/docs/tools/sdk/go/Reference/V2025/Models/ReviewableEntitlement.md new file mode 100644 index 000000000..1b48ca3f8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReviewableEntitlement.md @@ -0,0 +1,546 @@ +--- +id: v2025-reviewable-entitlement +title: ReviewableEntitlement +pagination_label: ReviewableEntitlement +sidebar_label: ReviewableEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewableEntitlement', 'V2025ReviewableEntitlement'] +slug: /tools/sdk/go/v2025/models/reviewable-entitlement +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlement', 'V2025ReviewableEntitlement'] +--- + +# ReviewableEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id for the entitlement | [optional] +**Name** | Pointer to **string** | The name of the entitlement | [optional] +**Description** | Pointer to **NullableString** | Information about the entitlement | [optional] +**Privileged** | Pointer to **bool** | Indicates if the entitlement is a privileged entitlement | [optional] [default to false] +**Owner** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**AttributeName** | Pointer to **string** | The name of the attribute on the source | [optional] +**AttributeValue** | Pointer to **string** | The value of the attribute on the source | [optional] +**SourceSchemaObjectType** | Pointer to **string** | The schema object type on the source used to represent the entitlement and its attributes | [optional] +**SourceName** | Pointer to **string** | The name of the source for which this entitlement belongs | [optional] +**SourceType** | Pointer to **string** | The type of the source for which the entitlement belongs | [optional] +**SourceId** | Pointer to **string** | The ID of the source for which the entitlement belongs | [optional] +**HasPermissions** | Pointer to **bool** | Indicates if the entitlement has permissions | [optional] [default to false] +**IsPermission** | Pointer to **bool** | Indicates if the entitlement is a representation of an account permission | [optional] [default to false] +**Revocable** | Pointer to **bool** | Indicates whether the entitlement can be revoked | [optional] [default to false] +**CloudGoverned** | Pointer to **bool** | True if the entitlement is cloud governed | [optional] [default to false] +**ContainsDataAccess** | Pointer to **bool** | True if the entitlement has DAS data | [optional] [default to false] +**DataAccess** | Pointer to [**NullableDataAccess**](data-access) | | [optional] +**Account** | Pointer to [**NullableReviewableEntitlementAccount**](reviewable-entitlement-account) | | [optional] + +## Methods + +### NewReviewableEntitlement + +`func NewReviewableEntitlement() *ReviewableEntitlement` + +NewReviewableEntitlement instantiates a new ReviewableEntitlement 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 + +### NewReviewableEntitlementWithDefaults + +`func NewReviewableEntitlementWithDefaults() *ReviewableEntitlement` + +NewReviewableEntitlementWithDefaults instantiates a new ReviewableEntitlement 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 + +### GetId + +`func (o *ReviewableEntitlement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewableEntitlement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewableEntitlement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReviewableEntitlement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ReviewableEntitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ReviewableEntitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ReviewableEntitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ReviewableEntitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ReviewableEntitlement) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ReviewableEntitlement) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ReviewableEntitlement) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ReviewableEntitlement) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ReviewableEntitlement) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ReviewableEntitlement) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetPrivileged + +`func (o *ReviewableEntitlement) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *ReviewableEntitlement) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *ReviewableEntitlement) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *ReviewableEntitlement) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetOwner + +`func (o *ReviewableEntitlement) GetOwner() IdentityReferenceWithNameAndEmail` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *ReviewableEntitlement) GetOwnerOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *ReviewableEntitlement) SetOwner(v IdentityReferenceWithNameAndEmail)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *ReviewableEntitlement) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *ReviewableEntitlement) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *ReviewableEntitlement) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetAttributeName + +`func (o *ReviewableEntitlement) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *ReviewableEntitlement) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *ReviewableEntitlement) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *ReviewableEntitlement) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + +### GetAttributeValue + +`func (o *ReviewableEntitlement) GetAttributeValue() string` + +GetAttributeValue returns the AttributeValue field if non-nil, zero value otherwise. + +### GetAttributeValueOk + +`func (o *ReviewableEntitlement) GetAttributeValueOk() (*string, bool)` + +GetAttributeValueOk returns a tuple with the AttributeValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeValue + +`func (o *ReviewableEntitlement) SetAttributeValue(v string)` + +SetAttributeValue sets AttributeValue field to given value. + +### HasAttributeValue + +`func (o *ReviewableEntitlement) HasAttributeValue() bool` + +HasAttributeValue returns a boolean if a field has been set. + +### GetSourceSchemaObjectType + +`func (o *ReviewableEntitlement) GetSourceSchemaObjectType() string` + +GetSourceSchemaObjectType returns the SourceSchemaObjectType field if non-nil, zero value otherwise. + +### GetSourceSchemaObjectTypeOk + +`func (o *ReviewableEntitlement) GetSourceSchemaObjectTypeOk() (*string, bool)` + +GetSourceSchemaObjectTypeOk returns a tuple with the SourceSchemaObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceSchemaObjectType + +`func (o *ReviewableEntitlement) SetSourceSchemaObjectType(v string)` + +SetSourceSchemaObjectType sets SourceSchemaObjectType field to given value. + +### HasSourceSchemaObjectType + +`func (o *ReviewableEntitlement) HasSourceSchemaObjectType() bool` + +HasSourceSchemaObjectType returns a boolean if a field has been set. + +### GetSourceName + +`func (o *ReviewableEntitlement) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *ReviewableEntitlement) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *ReviewableEntitlement) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *ReviewableEntitlement) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceType + +`func (o *ReviewableEntitlement) GetSourceType() string` + +GetSourceType returns the SourceType field if non-nil, zero value otherwise. + +### GetSourceTypeOk + +`func (o *ReviewableEntitlement) GetSourceTypeOk() (*string, bool)` + +GetSourceTypeOk returns a tuple with the SourceType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceType + +`func (o *ReviewableEntitlement) SetSourceType(v string)` + +SetSourceType sets SourceType field to given value. + +### HasSourceType + +`func (o *ReviewableEntitlement) HasSourceType() bool` + +HasSourceType returns a boolean if a field has been set. + +### GetSourceId + +`func (o *ReviewableEntitlement) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *ReviewableEntitlement) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *ReviewableEntitlement) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *ReviewableEntitlement) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetHasPermissions + +`func (o *ReviewableEntitlement) GetHasPermissions() bool` + +GetHasPermissions returns the HasPermissions field if non-nil, zero value otherwise. + +### GetHasPermissionsOk + +`func (o *ReviewableEntitlement) GetHasPermissionsOk() (*bool, bool)` + +GetHasPermissionsOk returns a tuple with the HasPermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasPermissions + +`func (o *ReviewableEntitlement) SetHasPermissions(v bool)` + +SetHasPermissions sets HasPermissions field to given value. + +### HasHasPermissions + +`func (o *ReviewableEntitlement) HasHasPermissions() bool` + +HasHasPermissions returns a boolean if a field has been set. + +### GetIsPermission + +`func (o *ReviewableEntitlement) GetIsPermission() bool` + +GetIsPermission returns the IsPermission field if non-nil, zero value otherwise. + +### GetIsPermissionOk + +`func (o *ReviewableEntitlement) GetIsPermissionOk() (*bool, bool)` + +GetIsPermissionOk returns a tuple with the IsPermission field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsPermission + +`func (o *ReviewableEntitlement) SetIsPermission(v bool)` + +SetIsPermission sets IsPermission field to given value. + +### HasIsPermission + +`func (o *ReviewableEntitlement) HasIsPermission() bool` + +HasIsPermission returns a boolean if a field has been set. + +### GetRevocable + +`func (o *ReviewableEntitlement) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *ReviewableEntitlement) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *ReviewableEntitlement) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *ReviewableEntitlement) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + +### GetCloudGoverned + +`func (o *ReviewableEntitlement) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *ReviewableEntitlement) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *ReviewableEntitlement) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + +### HasCloudGoverned + +`func (o *ReviewableEntitlement) HasCloudGoverned() bool` + +HasCloudGoverned returns a boolean if a field has been set. + +### GetContainsDataAccess + +`func (o *ReviewableEntitlement) GetContainsDataAccess() bool` + +GetContainsDataAccess returns the ContainsDataAccess field if non-nil, zero value otherwise. + +### GetContainsDataAccessOk + +`func (o *ReviewableEntitlement) GetContainsDataAccessOk() (*bool, bool)` + +GetContainsDataAccessOk returns a tuple with the ContainsDataAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainsDataAccess + +`func (o *ReviewableEntitlement) SetContainsDataAccess(v bool)` + +SetContainsDataAccess sets ContainsDataAccess field to given value. + +### HasContainsDataAccess + +`func (o *ReviewableEntitlement) HasContainsDataAccess() bool` + +HasContainsDataAccess returns a boolean if a field has been set. + +### GetDataAccess + +`func (o *ReviewableEntitlement) GetDataAccess() DataAccess` + +GetDataAccess returns the DataAccess field if non-nil, zero value otherwise. + +### GetDataAccessOk + +`func (o *ReviewableEntitlement) GetDataAccessOk() (*DataAccess, bool)` + +GetDataAccessOk returns a tuple with the DataAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataAccess + +`func (o *ReviewableEntitlement) SetDataAccess(v DataAccess)` + +SetDataAccess sets DataAccess field to given value. + +### HasDataAccess + +`func (o *ReviewableEntitlement) HasDataAccess() bool` + +HasDataAccess returns a boolean if a field has been set. + +### SetDataAccessNil + +`func (o *ReviewableEntitlement) SetDataAccessNil(b bool)` + + SetDataAccessNil sets the value for DataAccess to be an explicit nil + +### UnsetDataAccess +`func (o *ReviewableEntitlement) UnsetDataAccess()` + +UnsetDataAccess ensures that no value is present for DataAccess, not even an explicit nil +### GetAccount + +`func (o *ReviewableEntitlement) GetAccount() ReviewableEntitlementAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *ReviewableEntitlement) GetAccountOk() (*ReviewableEntitlementAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *ReviewableEntitlement) SetAccount(v ReviewableEntitlementAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *ReviewableEntitlement) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### SetAccountNil + +`func (o *ReviewableEntitlement) SetAccountNil(b bool)` + + SetAccountNil sets the value for Account to be an explicit nil + +### UnsetAccount +`func (o *ReviewableEntitlement) UnsetAccount()` + +UnsetAccount ensures that no value is present for Account, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReviewableEntitlementAccount.md b/docs/tools/sdk/go/Reference/V2025/Models/ReviewableEntitlementAccount.md new file mode 100644 index 000000000..cac0e7d35 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReviewableEntitlementAccount.md @@ -0,0 +1,420 @@ +--- +id: v2025-reviewable-entitlement-account +title: ReviewableEntitlementAccount +pagination_label: ReviewableEntitlementAccount +sidebar_label: ReviewableEntitlementAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewableEntitlementAccount', 'V2025ReviewableEntitlementAccount'] +slug: /tools/sdk/go/v2025/models/reviewable-entitlement-account +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlementAccount', 'V2025ReviewableEntitlementAccount'] +--- + +# ReviewableEntitlementAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NativeIdentity** | Pointer to **string** | The native identity for this account | [optional] +**Disabled** | Pointer to **bool** | Indicates whether this account is currently disabled | [optional] [default to false] +**Locked** | Pointer to **bool** | Indicates whether this account is currently locked | [optional] [default to false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **NullableString** | The id associated with the account | [optional] +**Name** | Pointer to **NullableString** | The account name | [optional] +**Created** | Pointer to **NullableTime** | When the account was created | [optional] +**Modified** | Pointer to **NullableTime** | When the account was last modified | [optional] +**ActivityInsights** | Pointer to [**ActivityInsights**](activity-insights) | | [optional] +**Description** | Pointer to **NullableString** | Information about the account | [optional] +**GovernanceGroupId** | Pointer to **NullableString** | The id associated with the machine Account Governance Group | [optional] +**Owner** | Pointer to [**NullableReviewableEntitlementAccountOwner**](reviewable-entitlement-account-owner) | | [optional] + +## Methods + +### NewReviewableEntitlementAccount + +`func NewReviewableEntitlementAccount() *ReviewableEntitlementAccount` + +NewReviewableEntitlementAccount instantiates a new ReviewableEntitlementAccount 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 + +### NewReviewableEntitlementAccountWithDefaults + +`func NewReviewableEntitlementAccountWithDefaults() *ReviewableEntitlementAccount` + +NewReviewableEntitlementAccountWithDefaults instantiates a new ReviewableEntitlementAccount 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 + +### GetNativeIdentity + +`func (o *ReviewableEntitlementAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *ReviewableEntitlementAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *ReviewableEntitlementAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *ReviewableEntitlementAccount) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetDisabled + +`func (o *ReviewableEntitlementAccount) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *ReviewableEntitlementAccount) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *ReviewableEntitlementAccount) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *ReviewableEntitlementAccount) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetLocked + +`func (o *ReviewableEntitlementAccount) GetLocked() bool` + +GetLocked returns the Locked field if non-nil, zero value otherwise. + +### GetLockedOk + +`func (o *ReviewableEntitlementAccount) GetLockedOk() (*bool, bool)` + +GetLockedOk returns a tuple with the Locked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocked + +`func (o *ReviewableEntitlementAccount) SetLocked(v bool)` + +SetLocked sets Locked field to given value. + +### HasLocked + +`func (o *ReviewableEntitlementAccount) HasLocked() bool` + +HasLocked returns a boolean if a field has been set. + +### GetType + +`func (o *ReviewableEntitlementAccount) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReviewableEntitlementAccount) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReviewableEntitlementAccount) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ReviewableEntitlementAccount) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ReviewableEntitlementAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewableEntitlementAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewableEntitlementAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReviewableEntitlementAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *ReviewableEntitlementAccount) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *ReviewableEntitlementAccount) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *ReviewableEntitlementAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ReviewableEntitlementAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ReviewableEntitlementAccount) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ReviewableEntitlementAccount) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ReviewableEntitlementAccount) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ReviewableEntitlementAccount) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *ReviewableEntitlementAccount) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ReviewableEntitlementAccount) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ReviewableEntitlementAccount) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ReviewableEntitlementAccount) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *ReviewableEntitlementAccount) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *ReviewableEntitlementAccount) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *ReviewableEntitlementAccount) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ReviewableEntitlementAccount) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ReviewableEntitlementAccount) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ReviewableEntitlementAccount) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *ReviewableEntitlementAccount) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *ReviewableEntitlementAccount) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetActivityInsights + +`func (o *ReviewableEntitlementAccount) GetActivityInsights() ActivityInsights` + +GetActivityInsights returns the ActivityInsights field if non-nil, zero value otherwise. + +### GetActivityInsightsOk + +`func (o *ReviewableEntitlementAccount) GetActivityInsightsOk() (*ActivityInsights, bool)` + +GetActivityInsightsOk returns a tuple with the ActivityInsights field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActivityInsights + +`func (o *ReviewableEntitlementAccount) SetActivityInsights(v ActivityInsights)` + +SetActivityInsights sets ActivityInsights field to given value. + +### HasActivityInsights + +`func (o *ReviewableEntitlementAccount) HasActivityInsights() bool` + +HasActivityInsights returns a boolean if a field has been set. + +### GetDescription + +`func (o *ReviewableEntitlementAccount) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ReviewableEntitlementAccount) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ReviewableEntitlementAccount) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ReviewableEntitlementAccount) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ReviewableEntitlementAccount) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ReviewableEntitlementAccount) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetGovernanceGroupId + +`func (o *ReviewableEntitlementAccount) GetGovernanceGroupId() string` + +GetGovernanceGroupId returns the GovernanceGroupId field if non-nil, zero value otherwise. + +### GetGovernanceGroupIdOk + +`func (o *ReviewableEntitlementAccount) GetGovernanceGroupIdOk() (*string, bool)` + +GetGovernanceGroupIdOk returns a tuple with the GovernanceGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceGroupId + +`func (o *ReviewableEntitlementAccount) SetGovernanceGroupId(v string)` + +SetGovernanceGroupId sets GovernanceGroupId field to given value. + +### HasGovernanceGroupId + +`func (o *ReviewableEntitlementAccount) HasGovernanceGroupId() bool` + +HasGovernanceGroupId returns a boolean if a field has been set. + +### SetGovernanceGroupIdNil + +`func (o *ReviewableEntitlementAccount) SetGovernanceGroupIdNil(b bool)` + + SetGovernanceGroupIdNil sets the value for GovernanceGroupId to be an explicit nil + +### UnsetGovernanceGroupId +`func (o *ReviewableEntitlementAccount) UnsetGovernanceGroupId()` + +UnsetGovernanceGroupId ensures that no value is present for GovernanceGroupId, not even an explicit nil +### GetOwner + +`func (o *ReviewableEntitlementAccount) GetOwner() ReviewableEntitlementAccountOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *ReviewableEntitlementAccount) GetOwnerOk() (*ReviewableEntitlementAccountOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *ReviewableEntitlementAccount) SetOwner(v ReviewableEntitlementAccountOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *ReviewableEntitlementAccount) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *ReviewableEntitlementAccount) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *ReviewableEntitlementAccount) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReviewableEntitlementAccountOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/ReviewableEntitlementAccountOwner.md new file mode 100644 index 000000000..abce9cf5a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReviewableEntitlementAccountOwner.md @@ -0,0 +1,136 @@ +--- +id: v2025-reviewable-entitlement-account-owner +title: ReviewableEntitlementAccountOwner +pagination_label: ReviewableEntitlementAccountOwner +sidebar_label: ReviewableEntitlementAccountOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewableEntitlementAccountOwner', 'V2025ReviewableEntitlementAccountOwner'] +slug: /tools/sdk/go/v2025/models/reviewable-entitlement-account-owner +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlementAccountOwner', 'V2025ReviewableEntitlementAccountOwner'] +--- + +# ReviewableEntitlementAccountOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | The id associated with the machine account owner | [optional] +**Type** | Pointer to **string** | An enumeration of the types of Owner supported within the IdentityNow infrastructure. | [optional] +**DisplayName** | Pointer to **NullableString** | The machine account owner's display name | [optional] + +## Methods + +### NewReviewableEntitlementAccountOwner + +`func NewReviewableEntitlementAccountOwner() *ReviewableEntitlementAccountOwner` + +NewReviewableEntitlementAccountOwner instantiates a new ReviewableEntitlementAccountOwner 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 + +### NewReviewableEntitlementAccountOwnerWithDefaults + +`func NewReviewableEntitlementAccountOwnerWithDefaults() *ReviewableEntitlementAccountOwner` + +NewReviewableEntitlementAccountOwnerWithDefaults instantiates a new ReviewableEntitlementAccountOwner 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 + +### GetId + +`func (o *ReviewableEntitlementAccountOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewableEntitlementAccountOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewableEntitlementAccountOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReviewableEntitlementAccountOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *ReviewableEntitlementAccountOwner) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *ReviewableEntitlementAccountOwner) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetType + +`func (o *ReviewableEntitlementAccountOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReviewableEntitlementAccountOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReviewableEntitlementAccountOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ReviewableEntitlementAccountOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *ReviewableEntitlementAccountOwner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *ReviewableEntitlementAccountOwner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *ReviewableEntitlementAccountOwner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *ReviewableEntitlementAccountOwner) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### SetDisplayNameNil + +`func (o *ReviewableEntitlementAccountOwner) SetDisplayNameNil(b bool)` + + SetDisplayNameNil sets the value for DisplayName to be an explicit nil + +### UnsetDisplayName +`func (o *ReviewableEntitlementAccountOwner) UnsetDisplayName()` + +UnsetDisplayName ensures that no value is present for DisplayName, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ReviewableRole.md b/docs/tools/sdk/go/Reference/V2025/Models/ReviewableRole.md new file mode 100644 index 000000000..1576de7e4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ReviewableRole.md @@ -0,0 +1,282 @@ +--- +id: v2025-reviewable-role +title: ReviewableRole +pagination_label: ReviewableRole +sidebar_label: ReviewableRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewableRole', 'V2025ReviewableRole'] +slug: /tools/sdk/go/v2025/models/reviewable-role +tags: ['SDK', 'Software Development Kit', 'ReviewableRole', 'V2025ReviewableRole'] +--- + +# ReviewableRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id for the Role | [optional] +**Name** | Pointer to **string** | The name of the Role | [optional] +**Description** | Pointer to **string** | Information about the Role | [optional] +**Privileged** | Pointer to **bool** | Indicates if the entitlement is a privileged entitlement | [optional] +**Owner** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**Revocable** | Pointer to **bool** | Indicates whether the Role can be revoked or requested | [optional] +**EndDate** | Pointer to **SailPointTime** | The date when a user's access expires. | [optional] +**AccessProfiles** | Pointer to [**[]ReviewableAccessProfile**](reviewable-access-profile) | The list of Access Profiles associated with this Role | [optional] +**Entitlements** | Pointer to [**[]ReviewableEntitlement**](reviewable-entitlement) | The list of entitlements associated with this Role | [optional] + +## Methods + +### NewReviewableRole + +`func NewReviewableRole() *ReviewableRole` + +NewReviewableRole instantiates a new ReviewableRole 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 + +### NewReviewableRoleWithDefaults + +`func NewReviewableRoleWithDefaults() *ReviewableRole` + +NewReviewableRoleWithDefaults instantiates a new ReviewableRole 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 + +### GetId + +`func (o *ReviewableRole) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewableRole) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewableRole) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReviewableRole) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ReviewableRole) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ReviewableRole) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ReviewableRole) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ReviewableRole) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ReviewableRole) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ReviewableRole) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ReviewableRole) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ReviewableRole) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *ReviewableRole) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *ReviewableRole) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *ReviewableRole) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *ReviewableRole) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetOwner + +`func (o *ReviewableRole) GetOwner() IdentityReferenceWithNameAndEmail` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *ReviewableRole) GetOwnerOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *ReviewableRole) SetOwner(v IdentityReferenceWithNameAndEmail)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *ReviewableRole) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *ReviewableRole) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *ReviewableRole) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetRevocable + +`func (o *ReviewableRole) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *ReviewableRole) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *ReviewableRole) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *ReviewableRole) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + +### GetEndDate + +`func (o *ReviewableRole) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *ReviewableRole) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *ReviewableRole) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *ReviewableRole) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetAccessProfiles + +`func (o *ReviewableRole) GetAccessProfiles() []ReviewableAccessProfile` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *ReviewableRole) GetAccessProfilesOk() (*[]ReviewableAccessProfile, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *ReviewableRole) SetAccessProfiles(v []ReviewableAccessProfile)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *ReviewableRole) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### GetEntitlements + +`func (o *ReviewableRole) GetEntitlements() []ReviewableEntitlement` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *ReviewableRole) GetEntitlementsOk() (*[]ReviewableEntitlement, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *ReviewableRole) SetEntitlements(v []ReviewableEntitlement)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *ReviewableRole) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Reviewer.md b/docs/tools/sdk/go/Reference/V2025/Models/Reviewer.md new file mode 100644 index 000000000..1a80120fa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Reviewer.md @@ -0,0 +1,214 @@ +--- +id: v2025-reviewer +title: Reviewer +pagination_label: Reviewer +sidebar_label: Reviewer +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Reviewer', 'V2025Reviewer'] +slug: /tools/sdk/go/v2025/models/reviewer +tags: ['SDK', 'Software Development Kit', 'Reviewer', 'V2025Reviewer'] +--- + +# Reviewer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the reviewer. | [optional] +**Name** | Pointer to **string** | The name of the reviewer. | [optional] +**Email** | Pointer to **string** | The email of the reviewing identity. | [optional] +**Type** | Pointer to **string** | The type of the reviewing identity. | [optional] +**Created** | Pointer to **NullableTime** | The created date of the reviewing identity. | [optional] +**Modified** | Pointer to **NullableTime** | The modified date of the reviewing identity. | [optional] + +## Methods + +### NewReviewer + +`func NewReviewer() *Reviewer` + +NewReviewer instantiates a new Reviewer 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 + +### NewReviewerWithDefaults + +`func NewReviewerWithDefaults() *Reviewer` + +NewReviewerWithDefaults instantiates a new Reviewer 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 + +### GetId + +`func (o *Reviewer) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Reviewer) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Reviewer) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Reviewer) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Reviewer) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Reviewer) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Reviewer) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Reviewer) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *Reviewer) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *Reviewer) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *Reviewer) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *Reviewer) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetType + +`func (o *Reviewer) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Reviewer) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Reviewer) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Reviewer) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetCreated + +`func (o *Reviewer) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Reviewer) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Reviewer) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Reviewer) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *Reviewer) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *Reviewer) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *Reviewer) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Reviewer) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Reviewer) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Reviewer) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *Reviewer) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *Reviewer) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Revocability.md b/docs/tools/sdk/go/Reference/V2025/Models/Revocability.md new file mode 100644 index 000000000..d9e757b4f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Revocability.md @@ -0,0 +1,74 @@ +--- +id: v2025-revocability +title: Revocability +pagination_label: Revocability +sidebar_label: Revocability +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Revocability', 'V2025Revocability'] +slug: /tools/sdk/go/v2025/models/revocability +tags: ['SDK', 'Software Development Kit', 'Revocability', 'V2025Revocability'] +--- + +# Revocability + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] + +## Methods + +### NewRevocability + +`func NewRevocability() *Revocability` + +NewRevocability instantiates a new Revocability 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 + +### NewRevocabilityWithDefaults + +`func NewRevocabilityWithDefaults() *Revocability` + +NewRevocabilityWithDefaults instantiates a new Revocability 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 + +### GetApprovalSchemes + +`func (o *Revocability) GetApprovalSchemes() []AccessProfileApprovalScheme` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *Revocability) GetApprovalSchemesOk() (*[]AccessProfileApprovalScheme, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *Revocability) SetApprovalSchemes(v []AccessProfileApprovalScheme)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *Revocability) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + +### SetApprovalSchemesNil + +`func (o *Revocability) SetApprovalSchemesNil(b bool)` + + SetApprovalSchemesNil sets the value for ApprovalSchemes to be an explicit nil + +### UnsetApprovalSchemes +`func (o *Revocability) UnsetApprovalSchemes()` + +UnsetApprovalSchemes ensures that no value is present for ApprovalSchemes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RevocabilityForRole.md b/docs/tools/sdk/go/Reference/V2025/Models/RevocabilityForRole.md new file mode 100644 index 000000000..f855820f5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RevocabilityForRole.md @@ -0,0 +1,136 @@ +--- +id: v2025-revocability-for-role +title: RevocabilityForRole +pagination_label: RevocabilityForRole +sidebar_label: RevocabilityForRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RevocabilityForRole', 'V2025RevocabilityForRole'] +slug: /tools/sdk/go/v2025/models/revocability-for-role +tags: ['SDK', 'Software Development Kit', 'RevocabilityForRole', 'V2025RevocabilityForRole'] +--- + +# RevocabilityForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **NullableBool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to false] +**DenialCommentsRequired** | Pointer to **NullableBool** | Whether an approver must provide comments when denying the request | [optional] [default to false] +**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the revocation request | [optional] + +## Methods + +### NewRevocabilityForRole + +`func NewRevocabilityForRole() *RevocabilityForRole` + +NewRevocabilityForRole instantiates a new RevocabilityForRole 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 + +### NewRevocabilityForRoleWithDefaults + +`func NewRevocabilityForRoleWithDefaults() *RevocabilityForRole` + +NewRevocabilityForRoleWithDefaults instantiates a new RevocabilityForRole 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 + +### GetCommentsRequired + +`func (o *RevocabilityForRole) GetCommentsRequired() bool` + +GetCommentsRequired returns the CommentsRequired field if non-nil, zero value otherwise. + +### GetCommentsRequiredOk + +`func (o *RevocabilityForRole) GetCommentsRequiredOk() (*bool, bool)` + +GetCommentsRequiredOk returns a tuple with the CommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentsRequired + +`func (o *RevocabilityForRole) SetCommentsRequired(v bool)` + +SetCommentsRequired sets CommentsRequired field to given value. + +### HasCommentsRequired + +`func (o *RevocabilityForRole) HasCommentsRequired() bool` + +HasCommentsRequired returns a boolean if a field has been set. + +### SetCommentsRequiredNil + +`func (o *RevocabilityForRole) SetCommentsRequiredNil(b bool)` + + SetCommentsRequiredNil sets the value for CommentsRequired to be an explicit nil + +### UnsetCommentsRequired +`func (o *RevocabilityForRole) UnsetCommentsRequired()` + +UnsetCommentsRequired ensures that no value is present for CommentsRequired, not even an explicit nil +### GetDenialCommentsRequired + +`func (o *RevocabilityForRole) GetDenialCommentsRequired() bool` + +GetDenialCommentsRequired returns the DenialCommentsRequired field if non-nil, zero value otherwise. + +### GetDenialCommentsRequiredOk + +`func (o *RevocabilityForRole) GetDenialCommentsRequiredOk() (*bool, bool)` + +GetDenialCommentsRequiredOk returns a tuple with the DenialCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenialCommentsRequired + +`func (o *RevocabilityForRole) SetDenialCommentsRequired(v bool)` + +SetDenialCommentsRequired sets DenialCommentsRequired field to given value. + +### HasDenialCommentsRequired + +`func (o *RevocabilityForRole) HasDenialCommentsRequired() bool` + +HasDenialCommentsRequired returns a boolean if a field has been set. + +### SetDenialCommentsRequiredNil + +`func (o *RevocabilityForRole) SetDenialCommentsRequiredNil(b bool)` + + SetDenialCommentsRequiredNil sets the value for DenialCommentsRequired to be an explicit nil + +### UnsetDenialCommentsRequired +`func (o *RevocabilityForRole) UnsetDenialCommentsRequired()` + +UnsetDenialCommentsRequired ensures that no value is present for DenialCommentsRequired, not even an explicit nil +### GetApprovalSchemes + +`func (o *RevocabilityForRole) GetApprovalSchemes() []ApprovalSchemeForRole` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *RevocabilityForRole) GetApprovalSchemesOk() (*[]ApprovalSchemeForRole, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *RevocabilityForRole) SetApprovalSchemes(v []ApprovalSchemeForRole)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *RevocabilityForRole) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Role.md b/docs/tools/sdk/go/Reference/V2025/Models/Role.md new file mode 100644 index 000000000..e619506de --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Role.md @@ -0,0 +1,566 @@ +--- +id: v2025-role +title: Role +pagination_label: Role +sidebar_label: Role +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Role', 'V2025Role'] +slug: /tools/sdk/go/v2025/models/role +tags: ['SDK', 'Software Development Kit', 'Role', 'V2025Role'] +--- + +# Role + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. | [optional] +**Name** | **string** | The human-readable display name of the Role | +**Created** | Pointer to **SailPointTime** | Date the Role was created | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Date the Role was last modified. | [optional] [readonly] +**Description** | Pointer to **NullableString** | A human-readable description of the Role | [optional] +**Owner** | [**OwnerReference**](owner-reference) | | +**AccessProfiles** | Pointer to [**[]AccessProfileRef**](access-profile-ref) | | [optional] +**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | | [optional] +**Membership** | Pointer to [**NullableRoleMembershipSelector**](role-membership-selector) | | [optional] +**LegacyMembershipInfo** | Pointer to **map[string]interface{}** | This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. | [optional] +**Enabled** | Pointer to **bool** | Whether the Role is enabled or not. | [optional] [default to false] +**Requestable** | Pointer to **bool** | Whether the Role can be the target of access requests. | [optional] [default to false] +**AccessRequestConfig** | Pointer to [**RequestabilityForRole**](requestability-for-role) | | [optional] +**RevocationRequestConfig** | Pointer to [**RevocabilityForRole**](revocability-for-role) | | [optional] +**Segments** | Pointer to **[]string** | List of IDs of segments, if any, to which this Role is assigned. | [optional] +**Dimensional** | Pointer to **NullableBool** | Whether the Role is dimensional. | [optional] [default to false] +**DimensionRefs** | Pointer to [**[]DimensionRef**](dimension-ref) | List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. | [optional] +**AccessModelMetadata** | Pointer to [**AttributeDTOList**](attribute-dto-list) | | [optional] + +## Methods + +### NewRole + +`func NewRole(name string, owner OwnerReference, ) *Role` + +NewRole instantiates a new Role 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 + +### NewRoleWithDefaults + +`func NewRoleWithDefaults() *Role` + +NewRoleWithDefaults instantiates a new Role 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 + +### GetId + +`func (o *Role) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Role) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Role) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Role) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Role) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Role) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Role) SetName(v string)` + +SetName sets Name field to given value. + + +### GetCreated + +`func (o *Role) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Role) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Role) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Role) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Role) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Role) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Role) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Role) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *Role) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Role) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Role) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Role) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Role) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Role) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwner + +`func (o *Role) GetOwner() OwnerReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Role) GetOwnerOk() (*OwnerReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Role) SetOwner(v OwnerReference)` + +SetOwner sets Owner field to given value. + + +### GetAccessProfiles + +`func (o *Role) GetAccessProfiles() []AccessProfileRef` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *Role) GetAccessProfilesOk() (*[]AccessProfileRef, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *Role) SetAccessProfiles(v []AccessProfileRef)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *Role) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### SetAccessProfilesNil + +`func (o *Role) SetAccessProfilesNil(b bool)` + + SetAccessProfilesNil sets the value for AccessProfiles to be an explicit nil + +### UnsetAccessProfiles +`func (o *Role) UnsetAccessProfiles()` + +UnsetAccessProfiles ensures that no value is present for AccessProfiles, not even an explicit nil +### GetEntitlements + +`func (o *Role) GetEntitlements() []EntitlementRef` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *Role) GetEntitlementsOk() (*[]EntitlementRef, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *Role) SetEntitlements(v []EntitlementRef)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *Role) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetMembership + +`func (o *Role) GetMembership() RoleMembershipSelector` + +GetMembership returns the Membership field if non-nil, zero value otherwise. + +### GetMembershipOk + +`func (o *Role) GetMembershipOk() (*RoleMembershipSelector, bool)` + +GetMembershipOk returns a tuple with the Membership field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMembership + +`func (o *Role) SetMembership(v RoleMembershipSelector)` + +SetMembership sets Membership field to given value. + +### HasMembership + +`func (o *Role) HasMembership() bool` + +HasMembership returns a boolean if a field has been set. + +### SetMembershipNil + +`func (o *Role) SetMembershipNil(b bool)` + + SetMembershipNil sets the value for Membership to be an explicit nil + +### UnsetMembership +`func (o *Role) UnsetMembership()` + +UnsetMembership ensures that no value is present for Membership, not even an explicit nil +### GetLegacyMembershipInfo + +`func (o *Role) GetLegacyMembershipInfo() map[string]interface{}` + +GetLegacyMembershipInfo returns the LegacyMembershipInfo field if non-nil, zero value otherwise. + +### GetLegacyMembershipInfoOk + +`func (o *Role) GetLegacyMembershipInfoOk() (*map[string]interface{}, bool)` + +GetLegacyMembershipInfoOk returns a tuple with the LegacyMembershipInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyMembershipInfo + +`func (o *Role) SetLegacyMembershipInfo(v map[string]interface{})` + +SetLegacyMembershipInfo sets LegacyMembershipInfo field to given value. + +### HasLegacyMembershipInfo + +`func (o *Role) HasLegacyMembershipInfo() bool` + +HasLegacyMembershipInfo returns a boolean if a field has been set. + +### SetLegacyMembershipInfoNil + +`func (o *Role) SetLegacyMembershipInfoNil(b bool)` + + SetLegacyMembershipInfoNil sets the value for LegacyMembershipInfo to be an explicit nil + +### UnsetLegacyMembershipInfo +`func (o *Role) UnsetLegacyMembershipInfo()` + +UnsetLegacyMembershipInfo ensures that no value is present for LegacyMembershipInfo, not even an explicit nil +### GetEnabled + +`func (o *Role) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *Role) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *Role) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *Role) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetRequestable + +`func (o *Role) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *Role) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *Role) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *Role) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetAccessRequestConfig + +`func (o *Role) GetAccessRequestConfig() RequestabilityForRole` + +GetAccessRequestConfig returns the AccessRequestConfig field if non-nil, zero value otherwise. + +### GetAccessRequestConfigOk + +`func (o *Role) GetAccessRequestConfigOk() (*RequestabilityForRole, bool)` + +GetAccessRequestConfigOk returns a tuple with the AccessRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestConfig + +`func (o *Role) SetAccessRequestConfig(v RequestabilityForRole)` + +SetAccessRequestConfig sets AccessRequestConfig field to given value. + +### HasAccessRequestConfig + +`func (o *Role) HasAccessRequestConfig() bool` + +HasAccessRequestConfig returns a boolean if a field has been set. + +### GetRevocationRequestConfig + +`func (o *Role) GetRevocationRequestConfig() RevocabilityForRole` + +GetRevocationRequestConfig returns the RevocationRequestConfig field if non-nil, zero value otherwise. + +### GetRevocationRequestConfigOk + +`func (o *Role) GetRevocationRequestConfigOk() (*RevocabilityForRole, bool)` + +GetRevocationRequestConfigOk returns a tuple with the RevocationRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocationRequestConfig + +`func (o *Role) SetRevocationRequestConfig(v RevocabilityForRole)` + +SetRevocationRequestConfig sets RevocationRequestConfig field to given value. + +### HasRevocationRequestConfig + +`func (o *Role) HasRevocationRequestConfig() bool` + +HasRevocationRequestConfig returns a boolean if a field has been set. + +### GetSegments + +`func (o *Role) GetSegments() []string` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *Role) GetSegmentsOk() (*[]string, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *Role) SetSegments(v []string)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *Role) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### SetSegmentsNil + +`func (o *Role) SetSegmentsNil(b bool)` + + SetSegmentsNil sets the value for Segments to be an explicit nil + +### UnsetSegments +`func (o *Role) UnsetSegments()` + +UnsetSegments ensures that no value is present for Segments, not even an explicit nil +### GetDimensional + +`func (o *Role) GetDimensional() bool` + +GetDimensional returns the Dimensional field if non-nil, zero value otherwise. + +### GetDimensionalOk + +`func (o *Role) GetDimensionalOk() (*bool, bool)` + +GetDimensionalOk returns a tuple with the Dimensional field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensional + +`func (o *Role) SetDimensional(v bool)` + +SetDimensional sets Dimensional field to given value. + +### HasDimensional + +`func (o *Role) HasDimensional() bool` + +HasDimensional returns a boolean if a field has been set. + +### SetDimensionalNil + +`func (o *Role) SetDimensionalNil(b bool)` + + SetDimensionalNil sets the value for Dimensional to be an explicit nil + +### UnsetDimensional +`func (o *Role) UnsetDimensional()` + +UnsetDimensional ensures that no value is present for Dimensional, not even an explicit nil +### GetDimensionRefs + +`func (o *Role) GetDimensionRefs() []DimensionRef` + +GetDimensionRefs returns the DimensionRefs field if non-nil, zero value otherwise. + +### GetDimensionRefsOk + +`func (o *Role) GetDimensionRefsOk() (*[]DimensionRef, bool)` + +GetDimensionRefsOk returns a tuple with the DimensionRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensionRefs + +`func (o *Role) SetDimensionRefs(v []DimensionRef)` + +SetDimensionRefs sets DimensionRefs field to given value. + +### HasDimensionRefs + +`func (o *Role) HasDimensionRefs() bool` + +HasDimensionRefs returns a boolean if a field has been set. + +### SetDimensionRefsNil + +`func (o *Role) SetDimensionRefsNil(b bool)` + + SetDimensionRefsNil sets the value for DimensionRefs to be an explicit nil + +### UnsetDimensionRefs +`func (o *Role) UnsetDimensionRefs()` + +UnsetDimensionRefs ensures that no value is present for DimensionRefs, not even an explicit nil +### GetAccessModelMetadata + +`func (o *Role) GetAccessModelMetadata() AttributeDTOList` + +GetAccessModelMetadata returns the AccessModelMetadata field if non-nil, zero value otherwise. + +### GetAccessModelMetadataOk + +`func (o *Role) GetAccessModelMetadataOk() (*AttributeDTOList, bool)` + +GetAccessModelMetadataOk returns a tuple with the AccessModelMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessModelMetadata + +`func (o *Role) SetAccessModelMetadata(v AttributeDTOList)` + +SetAccessModelMetadata sets AccessModelMetadata field to given value. + +### HasAccessModelMetadata + +`func (o *Role) HasAccessModelMetadata() bool` + +HasAccessModelMetadata returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleAssignmentDto.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleAssignmentDto.md new file mode 100644 index 000000000..7eef9e0d6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleAssignmentDto.md @@ -0,0 +1,292 @@ +--- +id: v2025-role-assignment-dto +title: RoleAssignmentDto +pagination_label: RoleAssignmentDto +sidebar_label: RoleAssignmentDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleAssignmentDto', 'V2025RoleAssignmentDto'] +slug: /tools/sdk/go/v2025/models/role-assignment-dto +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentDto', 'V2025RoleAssignmentDto'] +--- + +# RoleAssignmentDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Assignment Id | [optional] +**Role** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] +**Comments** | Pointer to **NullableString** | Comments added by the user when the assignment was made | [optional] +**AssignmentSource** | Pointer to **string** | Source describing how this assignment was made | [optional] +**Assigner** | Pointer to [**RoleAssignmentDtoAssigner**](role-assignment-dto-assigner) | | [optional] +**AssignedDimensions** | Pointer to [**[]BaseReferenceDto**](base-reference-dto) | Dimensions assigned related to this role | [optional] +**AssignmentContext** | Pointer to [**RoleAssignmentDtoAssignmentContext**](role-assignment-dto-assignment-context) | | [optional] +**AccountTargets** | Pointer to [**[]RoleTargetDto**](role-target-dto) | | [optional] +**RemoveDate** | Pointer to **NullableString** | Date that the assignment will be removed | [optional] + +## Methods + +### NewRoleAssignmentDto + +`func NewRoleAssignmentDto() *RoleAssignmentDto` + +NewRoleAssignmentDto instantiates a new RoleAssignmentDto 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 + +### NewRoleAssignmentDtoWithDefaults + +`func NewRoleAssignmentDtoWithDefaults() *RoleAssignmentDto` + +NewRoleAssignmentDtoWithDefaults instantiates a new RoleAssignmentDto 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 + +### GetId + +`func (o *RoleAssignmentDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleAssignmentDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleAssignmentDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleAssignmentDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRole + +`func (o *RoleAssignmentDto) GetRole() BaseReferenceDto` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *RoleAssignmentDto) GetRoleOk() (*BaseReferenceDto, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *RoleAssignmentDto) SetRole(v BaseReferenceDto)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *RoleAssignmentDto) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetComments + +`func (o *RoleAssignmentDto) GetComments() string` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *RoleAssignmentDto) GetCommentsOk() (*string, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *RoleAssignmentDto) SetComments(v string)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *RoleAssignmentDto) HasComments() bool` + +HasComments returns a boolean if a field has been set. + +### SetCommentsNil + +`func (o *RoleAssignmentDto) SetCommentsNil(b bool)` + + SetCommentsNil sets the value for Comments to be an explicit nil + +### UnsetComments +`func (o *RoleAssignmentDto) UnsetComments()` + +UnsetComments ensures that no value is present for Comments, not even an explicit nil +### GetAssignmentSource + +`func (o *RoleAssignmentDto) GetAssignmentSource() string` + +GetAssignmentSource returns the AssignmentSource field if non-nil, zero value otherwise. + +### GetAssignmentSourceOk + +`func (o *RoleAssignmentDto) GetAssignmentSourceOk() (*string, bool)` + +GetAssignmentSourceOk returns a tuple with the AssignmentSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentSource + +`func (o *RoleAssignmentDto) SetAssignmentSource(v string)` + +SetAssignmentSource sets AssignmentSource field to given value. + +### HasAssignmentSource + +`func (o *RoleAssignmentDto) HasAssignmentSource() bool` + +HasAssignmentSource returns a boolean if a field has been set. + +### GetAssigner + +`func (o *RoleAssignmentDto) GetAssigner() RoleAssignmentDtoAssigner` + +GetAssigner returns the Assigner field if non-nil, zero value otherwise. + +### GetAssignerOk + +`func (o *RoleAssignmentDto) GetAssignerOk() (*RoleAssignmentDtoAssigner, bool)` + +GetAssignerOk returns a tuple with the Assigner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssigner + +`func (o *RoleAssignmentDto) SetAssigner(v RoleAssignmentDtoAssigner)` + +SetAssigner sets Assigner field to given value. + +### HasAssigner + +`func (o *RoleAssignmentDto) HasAssigner() bool` + +HasAssigner returns a boolean if a field has been set. + +### GetAssignedDimensions + +`func (o *RoleAssignmentDto) GetAssignedDimensions() []BaseReferenceDto` + +GetAssignedDimensions returns the AssignedDimensions field if non-nil, zero value otherwise. + +### GetAssignedDimensionsOk + +`func (o *RoleAssignmentDto) GetAssignedDimensionsOk() (*[]BaseReferenceDto, bool)` + +GetAssignedDimensionsOk returns a tuple with the AssignedDimensions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignedDimensions + +`func (o *RoleAssignmentDto) SetAssignedDimensions(v []BaseReferenceDto)` + +SetAssignedDimensions sets AssignedDimensions field to given value. + +### HasAssignedDimensions + +`func (o *RoleAssignmentDto) HasAssignedDimensions() bool` + +HasAssignedDimensions returns a boolean if a field has been set. + +### GetAssignmentContext + +`func (o *RoleAssignmentDto) GetAssignmentContext() RoleAssignmentDtoAssignmentContext` + +GetAssignmentContext returns the AssignmentContext field if non-nil, zero value otherwise. + +### GetAssignmentContextOk + +`func (o *RoleAssignmentDto) GetAssignmentContextOk() (*RoleAssignmentDtoAssignmentContext, bool)` + +GetAssignmentContextOk returns a tuple with the AssignmentContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentContext + +`func (o *RoleAssignmentDto) SetAssignmentContext(v RoleAssignmentDtoAssignmentContext)` + +SetAssignmentContext sets AssignmentContext field to given value. + +### HasAssignmentContext + +`func (o *RoleAssignmentDto) HasAssignmentContext() bool` + +HasAssignmentContext returns a boolean if a field has been set. + +### GetAccountTargets + +`func (o *RoleAssignmentDto) GetAccountTargets() []RoleTargetDto` + +GetAccountTargets returns the AccountTargets field if non-nil, zero value otherwise. + +### GetAccountTargetsOk + +`func (o *RoleAssignmentDto) GetAccountTargetsOk() (*[]RoleTargetDto, bool)` + +GetAccountTargetsOk returns a tuple with the AccountTargets field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountTargets + +`func (o *RoleAssignmentDto) SetAccountTargets(v []RoleTargetDto)` + +SetAccountTargets sets AccountTargets field to given value. + +### HasAccountTargets + +`func (o *RoleAssignmentDto) HasAccountTargets() bool` + +HasAccountTargets returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *RoleAssignmentDto) GetRemoveDate() string` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *RoleAssignmentDto) GetRemoveDateOk() (*string, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *RoleAssignmentDto) SetRemoveDate(v string)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *RoleAssignmentDto) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *RoleAssignmentDto) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *RoleAssignmentDto) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleAssignmentDtoAssigner.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleAssignmentDtoAssigner.md new file mode 100644 index 000000000..2fac24922 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleAssignmentDtoAssigner.md @@ -0,0 +1,126 @@ +--- +id: v2025-role-assignment-dto-assigner +title: RoleAssignmentDtoAssigner +pagination_label: RoleAssignmentDtoAssigner +sidebar_label: RoleAssignmentDtoAssigner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleAssignmentDtoAssigner', 'V2025RoleAssignmentDtoAssigner'] +slug: /tools/sdk/go/v2025/models/role-assignment-dto-assigner +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentDtoAssigner', 'V2025RoleAssignmentDtoAssigner'] +--- + +# RoleAssignmentDtoAssigner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Object type | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewRoleAssignmentDtoAssigner + +`func NewRoleAssignmentDtoAssigner() *RoleAssignmentDtoAssigner` + +NewRoleAssignmentDtoAssigner instantiates a new RoleAssignmentDtoAssigner 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 + +### NewRoleAssignmentDtoAssignerWithDefaults + +`func NewRoleAssignmentDtoAssignerWithDefaults() *RoleAssignmentDtoAssigner` + +NewRoleAssignmentDtoAssignerWithDefaults instantiates a new RoleAssignmentDtoAssigner 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 + +### GetType + +`func (o *RoleAssignmentDtoAssigner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleAssignmentDtoAssigner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleAssignmentDtoAssigner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleAssignmentDtoAssigner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RoleAssignmentDtoAssigner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleAssignmentDtoAssigner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleAssignmentDtoAssigner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleAssignmentDtoAssigner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleAssignmentDtoAssigner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleAssignmentDtoAssigner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleAssignmentDtoAssigner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleAssignmentDtoAssigner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RoleAssignmentDtoAssigner) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RoleAssignmentDtoAssigner) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleAssignmentDtoAssignmentContext.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleAssignmentDtoAssignmentContext.md new file mode 100644 index 000000000..1c1837b5e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleAssignmentDtoAssignmentContext.md @@ -0,0 +1,116 @@ +--- +id: v2025-role-assignment-dto-assignment-context +title: RoleAssignmentDtoAssignmentContext +pagination_label: RoleAssignmentDtoAssignmentContext +sidebar_label: RoleAssignmentDtoAssignmentContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleAssignmentDtoAssignmentContext', 'V2025RoleAssignmentDtoAssignmentContext'] +slug: /tools/sdk/go/v2025/models/role-assignment-dto-assignment-context +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentDtoAssignmentContext', 'V2025RoleAssignmentDtoAssignmentContext'] +--- + +# RoleAssignmentDtoAssignmentContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Requested** | Pointer to [**AccessRequestContext**](access-request-context) | | [optional] +**Matched** | Pointer to [**[]RoleMatchDto**](role-match-dto) | | [optional] +**ComputedDate** | Pointer to **string** | Date that the assignment will was evaluated | [optional] + +## Methods + +### NewRoleAssignmentDtoAssignmentContext + +`func NewRoleAssignmentDtoAssignmentContext() *RoleAssignmentDtoAssignmentContext` + +NewRoleAssignmentDtoAssignmentContext instantiates a new RoleAssignmentDtoAssignmentContext 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 + +### NewRoleAssignmentDtoAssignmentContextWithDefaults + +`func NewRoleAssignmentDtoAssignmentContextWithDefaults() *RoleAssignmentDtoAssignmentContext` + +NewRoleAssignmentDtoAssignmentContextWithDefaults instantiates a new RoleAssignmentDtoAssignmentContext 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 + +### GetRequested + +`func (o *RoleAssignmentDtoAssignmentContext) GetRequested() AccessRequestContext` + +GetRequested returns the Requested field if non-nil, zero value otherwise. + +### GetRequestedOk + +`func (o *RoleAssignmentDtoAssignmentContext) GetRequestedOk() (*AccessRequestContext, bool)` + +GetRequestedOk returns a tuple with the Requested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequested + +`func (o *RoleAssignmentDtoAssignmentContext) SetRequested(v AccessRequestContext)` + +SetRequested sets Requested field to given value. + +### HasRequested + +`func (o *RoleAssignmentDtoAssignmentContext) HasRequested() bool` + +HasRequested returns a boolean if a field has been set. + +### GetMatched + +`func (o *RoleAssignmentDtoAssignmentContext) GetMatched() []RoleMatchDto` + +GetMatched returns the Matched field if non-nil, zero value otherwise. + +### GetMatchedOk + +`func (o *RoleAssignmentDtoAssignmentContext) GetMatchedOk() (*[]RoleMatchDto, bool)` + +GetMatchedOk returns a tuple with the Matched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatched + +`func (o *RoleAssignmentDtoAssignmentContext) SetMatched(v []RoleMatchDto)` + +SetMatched sets Matched field to given value. + +### HasMatched + +`func (o *RoleAssignmentDtoAssignmentContext) HasMatched() bool` + +HasMatched returns a boolean if a field has been set. + +### GetComputedDate + +`func (o *RoleAssignmentDtoAssignmentContext) GetComputedDate() string` + +GetComputedDate returns the ComputedDate field if non-nil, zero value otherwise. + +### GetComputedDateOk + +`func (o *RoleAssignmentDtoAssignmentContext) GetComputedDateOk() (*string, bool)` + +GetComputedDateOk returns a tuple with the ComputedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComputedDate + +`func (o *RoleAssignmentDtoAssignmentContext) SetComputedDate(v string)` + +SetComputedDate sets ComputedDate field to given value. + +### HasComputedDate + +`func (o *RoleAssignmentDtoAssignmentContext) HasComputedDate() bool` + +HasComputedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleAssignmentRef.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleAssignmentRef.md new file mode 100644 index 000000000..d90c37538 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleAssignmentRef.md @@ -0,0 +1,90 @@ +--- +id: v2025-role-assignment-ref +title: RoleAssignmentRef +pagination_label: RoleAssignmentRef +sidebar_label: RoleAssignmentRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleAssignmentRef', 'V2025RoleAssignmentRef'] +slug: /tools/sdk/go/v2025/models/role-assignment-ref +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentRef', 'V2025RoleAssignmentRef'] +--- + +# RoleAssignmentRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Assignment Id | [optional] +**Role** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] + +## Methods + +### NewRoleAssignmentRef + +`func NewRoleAssignmentRef() *RoleAssignmentRef` + +NewRoleAssignmentRef instantiates a new RoleAssignmentRef 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 + +### NewRoleAssignmentRefWithDefaults + +`func NewRoleAssignmentRefWithDefaults() *RoleAssignmentRef` + +NewRoleAssignmentRefWithDefaults instantiates a new RoleAssignmentRef 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 + +### GetId + +`func (o *RoleAssignmentRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleAssignmentRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleAssignmentRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleAssignmentRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRole + +`func (o *RoleAssignmentRef) GetRole() BaseReferenceDto` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *RoleAssignmentRef) GetRoleOk() (*BaseReferenceDto, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *RoleAssignmentRef) SetRole(v BaseReferenceDto)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *RoleAssignmentRef) HasRole() bool` + +HasRole returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleAssignmentSourceType.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleAssignmentSourceType.md new file mode 100644 index 000000000..ae133d979 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleAssignmentSourceType.md @@ -0,0 +1,21 @@ +--- +id: v2025-role-assignment-source-type +title: RoleAssignmentSourceType +pagination_label: RoleAssignmentSourceType +sidebar_label: RoleAssignmentSourceType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleAssignmentSourceType', 'V2025RoleAssignmentSourceType'] +slug: /tools/sdk/go/v2025/models/role-assignment-source-type +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentSourceType', 'V2025RoleAssignmentSourceType'] +--- + +# RoleAssignmentSourceType + +## Enum + + +* `ACCESS_REQUEST` (value: `"ACCESS_REQUEST"`) + +* `ROLE_MEMBERSHIP` (value: `"ROLE_MEMBERSHIP"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleBulkDeleteRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleBulkDeleteRequest.md new file mode 100644 index 000000000..45e84e450 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleBulkDeleteRequest.md @@ -0,0 +1,59 @@ +--- +id: v2025-role-bulk-delete-request +title: RoleBulkDeleteRequest +pagination_label: RoleBulkDeleteRequest +sidebar_label: RoleBulkDeleteRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleBulkDeleteRequest', 'V2025RoleBulkDeleteRequest'] +slug: /tools/sdk/go/v2025/models/role-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'RoleBulkDeleteRequest', 'V2025RoleBulkDeleteRequest'] +--- + +# RoleBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleIds** | **[]string** | List of IDs of Roles to be deleted. | + +## Methods + +### NewRoleBulkDeleteRequest + +`func NewRoleBulkDeleteRequest(roleIds []string, ) *RoleBulkDeleteRequest` + +NewRoleBulkDeleteRequest instantiates a new RoleBulkDeleteRequest 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 + +### NewRoleBulkDeleteRequestWithDefaults + +`func NewRoleBulkDeleteRequestWithDefaults() *RoleBulkDeleteRequest` + +NewRoleBulkDeleteRequestWithDefaults instantiates a new RoleBulkDeleteRequest 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 + +### GetRoleIds + +`func (o *RoleBulkDeleteRequest) GetRoleIds() []string` + +GetRoleIds returns the RoleIds field if non-nil, zero value otherwise. + +### GetRoleIdsOk + +`func (o *RoleBulkDeleteRequest) GetRoleIdsOk() (*[]string, bool)` + +GetRoleIdsOk returns a tuple with the RoleIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleIds + +`func (o *RoleBulkDeleteRequest) SetRoleIds(v []string)` + +SetRoleIds sets RoleIds field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleBulkUpdateResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleBulkUpdateResponse.md new file mode 100644 index 000000000..6863011e2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleBulkUpdateResponse.md @@ -0,0 +1,142 @@ +--- +id: v2025-role-bulk-update-response +title: RoleBulkUpdateResponse +pagination_label: RoleBulkUpdateResponse +sidebar_label: RoleBulkUpdateResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleBulkUpdateResponse', 'V2025RoleBulkUpdateResponse'] +slug: /tools/sdk/go/v2025/models/role-bulk-update-response +tags: ['SDK', 'Software Development Kit', 'RoleBulkUpdateResponse', 'V2025RoleBulkUpdateResponse'] +--- + +# RoleBulkUpdateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the task which is executing the bulk update. This also used in to the bulk-update/_** API to track status. | [optional] +**Type** | Pointer to **string** | Type of the bulk update object. | [optional] +**Status** | Pointer to **string** | The status of the bulk update request, could also checked by getBulkUpdateStatus API | [optional] +**Created** | Pointer to **SailPointTime** | Time when the bulk update request was created | [optional] + +## Methods + +### NewRoleBulkUpdateResponse + +`func NewRoleBulkUpdateResponse() *RoleBulkUpdateResponse` + +NewRoleBulkUpdateResponse instantiates a new RoleBulkUpdateResponse 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 + +### NewRoleBulkUpdateResponseWithDefaults + +`func NewRoleBulkUpdateResponseWithDefaults() *RoleBulkUpdateResponse` + +NewRoleBulkUpdateResponseWithDefaults instantiates a new RoleBulkUpdateResponse 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 + +### GetId + +`func (o *RoleBulkUpdateResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleBulkUpdateResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleBulkUpdateResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleBulkUpdateResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *RoleBulkUpdateResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleBulkUpdateResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleBulkUpdateResponse) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleBulkUpdateResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetStatus + +`func (o *RoleBulkUpdateResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *RoleBulkUpdateResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *RoleBulkUpdateResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *RoleBulkUpdateResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *RoleBulkUpdateResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RoleBulkUpdateResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RoleBulkUpdateResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RoleBulkUpdateResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaKey.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaKey.md new file mode 100644 index 000000000..0007d832a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaKey.md @@ -0,0 +1,116 @@ +--- +id: v2025-role-criteria-key +title: RoleCriteriaKey +pagination_label: RoleCriteriaKey +sidebar_label: RoleCriteriaKey +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaKey', 'V2025RoleCriteriaKey'] +slug: /tools/sdk/go/v2025/models/role-criteria-key +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKey', 'V2025RoleCriteriaKey'] +--- + +# RoleCriteriaKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**RoleCriteriaKeyType**](role-criteria-key-type) | | +**Property** | **string** | The name of the attribute or entitlement to which the associated criteria applies. | +**SourceId** | Pointer to **NullableString** | ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT | [optional] + +## Methods + +### NewRoleCriteriaKey + +`func NewRoleCriteriaKey(type_ RoleCriteriaKeyType, property string, ) *RoleCriteriaKey` + +NewRoleCriteriaKey instantiates a new RoleCriteriaKey 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 + +### NewRoleCriteriaKeyWithDefaults + +`func NewRoleCriteriaKeyWithDefaults() *RoleCriteriaKey` + +NewRoleCriteriaKeyWithDefaults instantiates a new RoleCriteriaKey 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 + +### GetType + +`func (o *RoleCriteriaKey) GetType() RoleCriteriaKeyType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleCriteriaKey) GetTypeOk() (*RoleCriteriaKeyType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleCriteriaKey) SetType(v RoleCriteriaKeyType)` + +SetType sets Type field to given value. + + +### GetProperty + +`func (o *RoleCriteriaKey) GetProperty() string` + +GetProperty returns the Property field if non-nil, zero value otherwise. + +### GetPropertyOk + +`func (o *RoleCriteriaKey) GetPropertyOk() (*string, bool)` + +GetPropertyOk returns a tuple with the Property field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperty + +`func (o *RoleCriteriaKey) SetProperty(v string)` + +SetProperty sets Property field to given value. + + +### GetSourceId + +`func (o *RoleCriteriaKey) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *RoleCriteriaKey) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *RoleCriteriaKey) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *RoleCriteriaKey) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### SetSourceIdNil + +`func (o *RoleCriteriaKey) SetSourceIdNil(b bool)` + + SetSourceIdNil sets the value for SourceId to be an explicit nil + +### UnsetSourceId +`func (o *RoleCriteriaKey) UnsetSourceId()` + +UnsetSourceId ensures that no value is present for SourceId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaKeyType.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaKeyType.md new file mode 100644 index 000000000..aaf34cf1b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaKeyType.md @@ -0,0 +1,23 @@ +--- +id: v2025-role-criteria-key-type +title: RoleCriteriaKeyType +pagination_label: RoleCriteriaKeyType +sidebar_label: RoleCriteriaKeyType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaKeyType', 'V2025RoleCriteriaKeyType'] +slug: /tools/sdk/go/v2025/models/role-criteria-key-type +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKeyType', 'V2025RoleCriteriaKeyType'] +--- + +# RoleCriteriaKeyType + +## Enum + + +* `IDENTITY` (value: `"IDENTITY"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaLevel1.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaLevel1.md new file mode 100644 index 000000000..a4f799c61 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaLevel1.md @@ -0,0 +1,172 @@ +--- +id: v2025-role-criteria-level1 +title: RoleCriteriaLevel1 +pagination_label: RoleCriteriaLevel1 +sidebar_label: RoleCriteriaLevel1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaLevel1', 'V2025RoleCriteriaLevel1'] +slug: /tools/sdk/go/v2025/models/role-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel1', 'V2025RoleCriteriaLevel1'] +--- + +# RoleCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableRoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **NullableString** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]RoleCriteriaLevel2**](role-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Methods + +### NewRoleCriteriaLevel1 + +`func NewRoleCriteriaLevel1() *RoleCriteriaLevel1` + +NewRoleCriteriaLevel1 instantiates a new RoleCriteriaLevel1 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 + +### NewRoleCriteriaLevel1WithDefaults + +`func NewRoleCriteriaLevel1WithDefaults() *RoleCriteriaLevel1` + +NewRoleCriteriaLevel1WithDefaults instantiates a new RoleCriteriaLevel1 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 + +### GetOperation + +`func (o *RoleCriteriaLevel1) GetOperation() RoleCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleCriteriaLevel1) GetOperationOk() (*RoleCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleCriteriaLevel1) SetOperation(v RoleCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *RoleCriteriaLevel1) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *RoleCriteriaLevel1) GetKey() RoleCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *RoleCriteriaLevel1) GetKeyOk() (*RoleCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *RoleCriteriaLevel1) SetKey(v RoleCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *RoleCriteriaLevel1) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *RoleCriteriaLevel1) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *RoleCriteriaLevel1) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *RoleCriteriaLevel1) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *RoleCriteriaLevel1) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *RoleCriteriaLevel1) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *RoleCriteriaLevel1) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + +### SetStringValueNil + +`func (o *RoleCriteriaLevel1) SetStringValueNil(b bool)` + + SetStringValueNil sets the value for StringValue to be an explicit nil + +### UnsetStringValue +`func (o *RoleCriteriaLevel1) UnsetStringValue()` + +UnsetStringValue ensures that no value is present for StringValue, not even an explicit nil +### GetChildren + +`func (o *RoleCriteriaLevel1) GetChildren() []RoleCriteriaLevel2` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *RoleCriteriaLevel1) GetChildrenOk() (*[]RoleCriteriaLevel2, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *RoleCriteriaLevel1) SetChildren(v []RoleCriteriaLevel2)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *RoleCriteriaLevel1) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *RoleCriteriaLevel1) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *RoleCriteriaLevel1) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaLevel2.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaLevel2.md new file mode 100644 index 000000000..da5af7f68 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaLevel2.md @@ -0,0 +1,172 @@ +--- +id: v2025-role-criteria-level2 +title: RoleCriteriaLevel2 +pagination_label: RoleCriteriaLevel2 +sidebar_label: RoleCriteriaLevel2 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaLevel2', 'V2025RoleCriteriaLevel2'] +slug: /tools/sdk/go/v2025/models/role-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel2', 'V2025RoleCriteriaLevel2'] +--- + +# RoleCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableRoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **NullableString** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]RoleCriteriaLevel3**](role-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Methods + +### NewRoleCriteriaLevel2 + +`func NewRoleCriteriaLevel2() *RoleCriteriaLevel2` + +NewRoleCriteriaLevel2 instantiates a new RoleCriteriaLevel2 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 + +### NewRoleCriteriaLevel2WithDefaults + +`func NewRoleCriteriaLevel2WithDefaults() *RoleCriteriaLevel2` + +NewRoleCriteriaLevel2WithDefaults instantiates a new RoleCriteriaLevel2 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 + +### GetOperation + +`func (o *RoleCriteriaLevel2) GetOperation() RoleCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleCriteriaLevel2) GetOperationOk() (*RoleCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleCriteriaLevel2) SetOperation(v RoleCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *RoleCriteriaLevel2) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *RoleCriteriaLevel2) GetKey() RoleCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *RoleCriteriaLevel2) GetKeyOk() (*RoleCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *RoleCriteriaLevel2) SetKey(v RoleCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *RoleCriteriaLevel2) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *RoleCriteriaLevel2) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *RoleCriteriaLevel2) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *RoleCriteriaLevel2) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *RoleCriteriaLevel2) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *RoleCriteriaLevel2) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *RoleCriteriaLevel2) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + +### SetStringValueNil + +`func (o *RoleCriteriaLevel2) SetStringValueNil(b bool)` + + SetStringValueNil sets the value for StringValue to be an explicit nil + +### UnsetStringValue +`func (o *RoleCriteriaLevel2) UnsetStringValue()` + +UnsetStringValue ensures that no value is present for StringValue, not even an explicit nil +### GetChildren + +`func (o *RoleCriteriaLevel2) GetChildren() []RoleCriteriaLevel3` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *RoleCriteriaLevel2) GetChildrenOk() (*[]RoleCriteriaLevel3, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *RoleCriteriaLevel2) SetChildren(v []RoleCriteriaLevel3)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *RoleCriteriaLevel2) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *RoleCriteriaLevel2) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *RoleCriteriaLevel2) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaLevel3.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaLevel3.md new file mode 100644 index 000000000..f4b55ba66 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaLevel3.md @@ -0,0 +1,126 @@ +--- +id: v2025-role-criteria-level3 +title: RoleCriteriaLevel3 +pagination_label: RoleCriteriaLevel3 +sidebar_label: RoleCriteriaLevel3 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaLevel3', 'V2025RoleCriteriaLevel3'] +slug: /tools/sdk/go/v2025/models/role-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel3', 'V2025RoleCriteriaLevel3'] +--- + +# RoleCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableRoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **string** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] + +## Methods + +### NewRoleCriteriaLevel3 + +`func NewRoleCriteriaLevel3() *RoleCriteriaLevel3` + +NewRoleCriteriaLevel3 instantiates a new RoleCriteriaLevel3 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 + +### NewRoleCriteriaLevel3WithDefaults + +`func NewRoleCriteriaLevel3WithDefaults() *RoleCriteriaLevel3` + +NewRoleCriteriaLevel3WithDefaults instantiates a new RoleCriteriaLevel3 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 + +### GetOperation + +`func (o *RoleCriteriaLevel3) GetOperation() RoleCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleCriteriaLevel3) GetOperationOk() (*RoleCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleCriteriaLevel3) SetOperation(v RoleCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *RoleCriteriaLevel3) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *RoleCriteriaLevel3) GetKey() RoleCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *RoleCriteriaLevel3) GetKeyOk() (*RoleCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *RoleCriteriaLevel3) SetKey(v RoleCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *RoleCriteriaLevel3) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *RoleCriteriaLevel3) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *RoleCriteriaLevel3) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *RoleCriteriaLevel3) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *RoleCriteriaLevel3) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *RoleCriteriaLevel3) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *RoleCriteriaLevel3) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaOperation.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaOperation.md new file mode 100644 index 000000000..0b12c03d7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleCriteriaOperation.md @@ -0,0 +1,31 @@ +--- +id: v2025-role-criteria-operation +title: RoleCriteriaOperation +pagination_label: RoleCriteriaOperation +sidebar_label: RoleCriteriaOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaOperation', 'V2025RoleCriteriaOperation'] +slug: /tools/sdk/go/v2025/models/role-criteria-operation +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaOperation', 'V2025RoleCriteriaOperation'] +--- + +# RoleCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `STARTS_WITH` (value: `"STARTS_WITH"`) + +* `ENDS_WITH` (value: `"ENDS_WITH"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleDocument.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleDocument.md new file mode 100644 index 000000000..01ef5b2aa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleDocument.md @@ -0,0 +1,694 @@ +--- +id: v2025-role-document +title: RoleDocument +pagination_label: RoleDocument +sidebar_label: RoleDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleDocument', 'V2025RoleDocument'] +slug: /tools/sdk/go/v2025/models/role-document +tags: ['SDK', 'Software Development Kit', 'RoleDocument', 'V2025RoleDocument'] +--- + +# RoleDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Access item's description. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **NullableTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Enabled** | Pointer to **bool** | Indicates whether the access item is currently enabled. | [optional] [default to false] +**Requestable** | Pointer to **bool** | Indicates whether the access item can be requested. | [optional] [default to true] +**RequestCommentsRequired** | Pointer to **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to false] +**Owner** | Pointer to [**BaseAccessOwner**](base-access-owner) | | [optional] +**Id** | **string** | ID of the role. | +**Name** | **string** | Name of the role. | +**AccessProfiles** | Pointer to [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional] +**AccessProfileCount** | Pointer to **NullableInt32** | Number of access profiles included with the role. | [optional] +**Tags** | Pointer to **[]string** | Tags that have been applied to the object. | [optional] +**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] +**SegmentCount** | Pointer to **NullableInt32** | Number of segments with the role. | [optional] +**Entitlements** | Pointer to [**[]RoleDocumentAllOfEntitlements**](role-document-all-of-entitlements) | Entitlements included with the role. | [optional] +**EntitlementCount** | Pointer to **NullableInt32** | Number of entitlements included with the role. | [optional] +**Dimensional** | Pointer to **bool** | | [optional] [default to false] +**DimensionSchemaAttributeCount** | Pointer to **NullableInt32** | Number of dimension attributes included with the role. | [optional] +**DimensionSchemaAttributes** | Pointer to [**[]RoleDocumentAllOfDimensionSchemaAttributes**](role-document-all-of-dimension-schema-attributes) | Dimension attributes included with the role. | [optional] +**Dimensions** | Pointer to [**[]RoleDocumentAllOfDimensions**](role-document-all-of-dimensions) | | [optional] + +## Methods + +### NewRoleDocument + +`func NewRoleDocument(id string, name string, ) *RoleDocument` + +NewRoleDocument instantiates a new RoleDocument 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 + +### NewRoleDocumentWithDefaults + +`func NewRoleDocumentWithDefaults() *RoleDocument` + +NewRoleDocumentWithDefaults instantiates a new RoleDocument 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 + +### GetDescription + +`func (o *RoleDocument) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleDocument) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleDocument) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleDocument) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetCreated + +`func (o *RoleDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RoleDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RoleDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RoleDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *RoleDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *RoleDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *RoleDocument) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RoleDocument) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RoleDocument) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RoleDocument) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *RoleDocument) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *RoleDocument) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *RoleDocument) GetSynced() SailPointTime` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *RoleDocument) GetSyncedOk() (*SailPointTime, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *RoleDocument) SetSynced(v SailPointTime)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *RoleDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### SetSyncedNil + +`func (o *RoleDocument) SetSyncedNil(b bool)` + + SetSyncedNil sets the value for Synced to be an explicit nil + +### UnsetSynced +`func (o *RoleDocument) UnsetSynced()` + +UnsetSynced ensures that no value is present for Synced, not even an explicit nil +### GetEnabled + +`func (o *RoleDocument) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *RoleDocument) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *RoleDocument) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *RoleDocument) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetRequestable + +`func (o *RoleDocument) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *RoleDocument) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *RoleDocument) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *RoleDocument) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetRequestCommentsRequired + +`func (o *RoleDocument) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *RoleDocument) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *RoleDocument) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *RoleDocument) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + +### GetOwner + +`func (o *RoleDocument) GetOwner() BaseAccessOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *RoleDocument) GetOwnerOk() (*BaseAccessOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *RoleDocument) SetOwner(v BaseAccessOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *RoleDocument) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetId + +`func (o *RoleDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleDocument) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *RoleDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleDocument) SetName(v string)` + +SetName sets Name field to given value. + + +### GetAccessProfiles + +`func (o *RoleDocument) GetAccessProfiles() []BaseAccessProfile` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *RoleDocument) GetAccessProfilesOk() (*[]BaseAccessProfile, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *RoleDocument) SetAccessProfiles(v []BaseAccessProfile)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *RoleDocument) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### SetAccessProfilesNil + +`func (o *RoleDocument) SetAccessProfilesNil(b bool)` + + SetAccessProfilesNil sets the value for AccessProfiles to be an explicit nil + +### UnsetAccessProfiles +`func (o *RoleDocument) UnsetAccessProfiles()` + +UnsetAccessProfiles ensures that no value is present for AccessProfiles, not even an explicit nil +### GetAccessProfileCount + +`func (o *RoleDocument) GetAccessProfileCount() int32` + +GetAccessProfileCount returns the AccessProfileCount field if non-nil, zero value otherwise. + +### GetAccessProfileCountOk + +`func (o *RoleDocument) GetAccessProfileCountOk() (*int32, bool)` + +GetAccessProfileCountOk returns a tuple with the AccessProfileCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileCount + +`func (o *RoleDocument) SetAccessProfileCount(v int32)` + +SetAccessProfileCount sets AccessProfileCount field to given value. + +### HasAccessProfileCount + +`func (o *RoleDocument) HasAccessProfileCount() bool` + +HasAccessProfileCount returns a boolean if a field has been set. + +### SetAccessProfileCountNil + +`func (o *RoleDocument) SetAccessProfileCountNil(b bool)` + + SetAccessProfileCountNil sets the value for AccessProfileCount to be an explicit nil + +### UnsetAccessProfileCount +`func (o *RoleDocument) UnsetAccessProfileCount()` + +UnsetAccessProfileCount ensures that no value is present for AccessProfileCount, not even an explicit nil +### GetTags + +`func (o *RoleDocument) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *RoleDocument) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *RoleDocument) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *RoleDocument) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetSegments + +`func (o *RoleDocument) GetSegments() []BaseSegment` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *RoleDocument) GetSegmentsOk() (*[]BaseSegment, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *RoleDocument) SetSegments(v []BaseSegment)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *RoleDocument) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### SetSegmentsNil + +`func (o *RoleDocument) SetSegmentsNil(b bool)` + + SetSegmentsNil sets the value for Segments to be an explicit nil + +### UnsetSegments +`func (o *RoleDocument) UnsetSegments()` + +UnsetSegments ensures that no value is present for Segments, not even an explicit nil +### GetSegmentCount + +`func (o *RoleDocument) GetSegmentCount() int32` + +GetSegmentCount returns the SegmentCount field if non-nil, zero value otherwise. + +### GetSegmentCountOk + +`func (o *RoleDocument) GetSegmentCountOk() (*int32, bool)` + +GetSegmentCountOk returns a tuple with the SegmentCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegmentCount + +`func (o *RoleDocument) SetSegmentCount(v int32)` + +SetSegmentCount sets SegmentCount field to given value. + +### HasSegmentCount + +`func (o *RoleDocument) HasSegmentCount() bool` + +HasSegmentCount returns a boolean if a field has been set. + +### SetSegmentCountNil + +`func (o *RoleDocument) SetSegmentCountNil(b bool)` + + SetSegmentCountNil sets the value for SegmentCount to be an explicit nil + +### UnsetSegmentCount +`func (o *RoleDocument) UnsetSegmentCount()` + +UnsetSegmentCount ensures that no value is present for SegmentCount, not even an explicit nil +### GetEntitlements + +`func (o *RoleDocument) GetEntitlements() []RoleDocumentAllOfEntitlements` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *RoleDocument) GetEntitlementsOk() (*[]RoleDocumentAllOfEntitlements, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *RoleDocument) SetEntitlements(v []RoleDocumentAllOfEntitlements)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *RoleDocument) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### SetEntitlementsNil + +`func (o *RoleDocument) SetEntitlementsNil(b bool)` + + SetEntitlementsNil sets the value for Entitlements to be an explicit nil + +### UnsetEntitlements +`func (o *RoleDocument) UnsetEntitlements()` + +UnsetEntitlements ensures that no value is present for Entitlements, not even an explicit nil +### GetEntitlementCount + +`func (o *RoleDocument) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *RoleDocument) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *RoleDocument) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *RoleDocument) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### SetEntitlementCountNil + +`func (o *RoleDocument) SetEntitlementCountNil(b bool)` + + SetEntitlementCountNil sets the value for EntitlementCount to be an explicit nil + +### UnsetEntitlementCount +`func (o *RoleDocument) UnsetEntitlementCount()` + +UnsetEntitlementCount ensures that no value is present for EntitlementCount, not even an explicit nil +### GetDimensional + +`func (o *RoleDocument) GetDimensional() bool` + +GetDimensional returns the Dimensional field if non-nil, zero value otherwise. + +### GetDimensionalOk + +`func (o *RoleDocument) GetDimensionalOk() (*bool, bool)` + +GetDimensionalOk returns a tuple with the Dimensional field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensional + +`func (o *RoleDocument) SetDimensional(v bool)` + +SetDimensional sets Dimensional field to given value. + +### HasDimensional + +`func (o *RoleDocument) HasDimensional() bool` + +HasDimensional returns a boolean if a field has been set. + +### GetDimensionSchemaAttributeCount + +`func (o *RoleDocument) GetDimensionSchemaAttributeCount() int32` + +GetDimensionSchemaAttributeCount returns the DimensionSchemaAttributeCount field if non-nil, zero value otherwise. + +### GetDimensionSchemaAttributeCountOk + +`func (o *RoleDocument) GetDimensionSchemaAttributeCountOk() (*int32, bool)` + +GetDimensionSchemaAttributeCountOk returns a tuple with the DimensionSchemaAttributeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensionSchemaAttributeCount + +`func (o *RoleDocument) SetDimensionSchemaAttributeCount(v int32)` + +SetDimensionSchemaAttributeCount sets DimensionSchemaAttributeCount field to given value. + +### HasDimensionSchemaAttributeCount + +`func (o *RoleDocument) HasDimensionSchemaAttributeCount() bool` + +HasDimensionSchemaAttributeCount returns a boolean if a field has been set. + +### SetDimensionSchemaAttributeCountNil + +`func (o *RoleDocument) SetDimensionSchemaAttributeCountNil(b bool)` + + SetDimensionSchemaAttributeCountNil sets the value for DimensionSchemaAttributeCount to be an explicit nil + +### UnsetDimensionSchemaAttributeCount +`func (o *RoleDocument) UnsetDimensionSchemaAttributeCount()` + +UnsetDimensionSchemaAttributeCount ensures that no value is present for DimensionSchemaAttributeCount, not even an explicit nil +### GetDimensionSchemaAttributes + +`func (o *RoleDocument) GetDimensionSchemaAttributes() []RoleDocumentAllOfDimensionSchemaAttributes` + +GetDimensionSchemaAttributes returns the DimensionSchemaAttributes field if non-nil, zero value otherwise. + +### GetDimensionSchemaAttributesOk + +`func (o *RoleDocument) GetDimensionSchemaAttributesOk() (*[]RoleDocumentAllOfDimensionSchemaAttributes, bool)` + +GetDimensionSchemaAttributesOk returns a tuple with the DimensionSchemaAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensionSchemaAttributes + +`func (o *RoleDocument) SetDimensionSchemaAttributes(v []RoleDocumentAllOfDimensionSchemaAttributes)` + +SetDimensionSchemaAttributes sets DimensionSchemaAttributes field to given value. + +### HasDimensionSchemaAttributes + +`func (o *RoleDocument) HasDimensionSchemaAttributes() bool` + +HasDimensionSchemaAttributes returns a boolean if a field has been set. + +### SetDimensionSchemaAttributesNil + +`func (o *RoleDocument) SetDimensionSchemaAttributesNil(b bool)` + + SetDimensionSchemaAttributesNil sets the value for DimensionSchemaAttributes to be an explicit nil + +### UnsetDimensionSchemaAttributes +`func (o *RoleDocument) UnsetDimensionSchemaAttributes()` + +UnsetDimensionSchemaAttributes ensures that no value is present for DimensionSchemaAttributes, not even an explicit nil +### GetDimensions + +`func (o *RoleDocument) GetDimensions() []RoleDocumentAllOfDimensions` + +GetDimensions returns the Dimensions field if non-nil, zero value otherwise. + +### GetDimensionsOk + +`func (o *RoleDocument) GetDimensionsOk() (*[]RoleDocumentAllOfDimensions, bool)` + +GetDimensionsOk returns a tuple with the Dimensions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensions + +`func (o *RoleDocument) SetDimensions(v []RoleDocumentAllOfDimensions)` + +SetDimensions sets Dimensions field to given value. + +### HasDimensions + +`func (o *RoleDocument) HasDimensions() bool` + +HasDimensions returns a boolean if a field has been set. + +### SetDimensionsNil + +`func (o *RoleDocument) SetDimensionsNil(b bool)` + + SetDimensionsNil sets the value for Dimensions to be an explicit nil + +### UnsetDimensions +`func (o *RoleDocument) UnsetDimensions()` + +UnsetDimensions ensures that no value is present for Dimensions, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleDocumentAllOfDimensionSchemaAttributes.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleDocumentAllOfDimensionSchemaAttributes.md new file mode 100644 index 000000000..0deaa66f6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleDocumentAllOfDimensionSchemaAttributes.md @@ -0,0 +1,116 @@ +--- +id: v2025-role-document-all-of-dimension-schema-attributes +title: RoleDocumentAllOfDimensionSchemaAttributes +pagination_label: RoleDocumentAllOfDimensionSchemaAttributes +sidebar_label: RoleDocumentAllOfDimensionSchemaAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleDocumentAllOfDimensionSchemaAttributes', 'V2025RoleDocumentAllOfDimensionSchemaAttributes'] +slug: /tools/sdk/go/v2025/models/role-document-all-of-dimension-schema-attributes +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfDimensionSchemaAttributes', 'V2025RoleDocumentAllOfDimensionSchemaAttributes'] +--- + +# RoleDocumentAllOfDimensionSchemaAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Derived** | Pointer to **bool** | | [optional] [default to true] +**DisplayName** | Pointer to **string** | Displayname of the dimension attribute. | [optional] +**Name** | Pointer to **string** | Name of the dimension attribute. | [optional] + +## Methods + +### NewRoleDocumentAllOfDimensionSchemaAttributes + +`func NewRoleDocumentAllOfDimensionSchemaAttributes() *RoleDocumentAllOfDimensionSchemaAttributes` + +NewRoleDocumentAllOfDimensionSchemaAttributes instantiates a new RoleDocumentAllOfDimensionSchemaAttributes 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 + +### NewRoleDocumentAllOfDimensionSchemaAttributesWithDefaults + +`func NewRoleDocumentAllOfDimensionSchemaAttributesWithDefaults() *RoleDocumentAllOfDimensionSchemaAttributes` + +NewRoleDocumentAllOfDimensionSchemaAttributesWithDefaults instantiates a new RoleDocumentAllOfDimensionSchemaAttributes 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 + +### GetDerived + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetDerived() bool` + +GetDerived returns the Derived field if non-nil, zero value otherwise. + +### GetDerivedOk + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetDerivedOk() (*bool, bool)` + +GetDerivedOk returns a tuple with the Derived field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDerived + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) SetDerived(v bool)` + +SetDerived sets Derived field to given value. + +### HasDerived + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) HasDerived() bool` + +HasDerived returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleDocumentAllOfDimensions.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleDocumentAllOfDimensions.md new file mode 100644 index 000000000..d1b9d8c77 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleDocumentAllOfDimensions.md @@ -0,0 +1,198 @@ +--- +id: v2025-role-document-all-of-dimensions +title: RoleDocumentAllOfDimensions +pagination_label: RoleDocumentAllOfDimensions +sidebar_label: RoleDocumentAllOfDimensions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleDocumentAllOfDimensions', 'V2025RoleDocumentAllOfDimensions'] +slug: /tools/sdk/go/v2025/models/role-document-all-of-dimensions +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfDimensions', 'V2025RoleDocumentAllOfDimensions'] +--- + +# RoleDocumentAllOfDimensions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique ID of the dimension. | [optional] +**Name** | Pointer to **string** | Name of the dimension. | [optional] +**Description** | Pointer to **NullableString** | Description of the dimension. | [optional] +**Entitlements** | Pointer to [**[]RoleDocumentAllOfEntitlements1**](role-document-all-of-entitlements1) | Entitlements included with the role. | [optional] +**AccessProfiles** | Pointer to [**[]BaseAccessProfile**](base-access-profile) | Access profiles included in the dimension. | [optional] + +## Methods + +### NewRoleDocumentAllOfDimensions + +`func NewRoleDocumentAllOfDimensions() *RoleDocumentAllOfDimensions` + +NewRoleDocumentAllOfDimensions instantiates a new RoleDocumentAllOfDimensions 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 + +### NewRoleDocumentAllOfDimensionsWithDefaults + +`func NewRoleDocumentAllOfDimensionsWithDefaults() *RoleDocumentAllOfDimensions` + +NewRoleDocumentAllOfDimensionsWithDefaults instantiates a new RoleDocumentAllOfDimensions 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 + +### GetId + +`func (o *RoleDocumentAllOfDimensions) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleDocumentAllOfDimensions) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleDocumentAllOfDimensions) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleDocumentAllOfDimensions) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleDocumentAllOfDimensions) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleDocumentAllOfDimensions) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleDocumentAllOfDimensions) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleDocumentAllOfDimensions) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleDocumentAllOfDimensions) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleDocumentAllOfDimensions) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleDocumentAllOfDimensions) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleDocumentAllOfDimensions) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleDocumentAllOfDimensions) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleDocumentAllOfDimensions) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetEntitlements + +`func (o *RoleDocumentAllOfDimensions) GetEntitlements() []RoleDocumentAllOfEntitlements1` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *RoleDocumentAllOfDimensions) GetEntitlementsOk() (*[]RoleDocumentAllOfEntitlements1, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *RoleDocumentAllOfDimensions) SetEntitlements(v []RoleDocumentAllOfEntitlements1)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *RoleDocumentAllOfDimensions) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### SetEntitlementsNil + +`func (o *RoleDocumentAllOfDimensions) SetEntitlementsNil(b bool)` + + SetEntitlementsNil sets the value for Entitlements to be an explicit nil + +### UnsetEntitlements +`func (o *RoleDocumentAllOfDimensions) UnsetEntitlements()` + +UnsetEntitlements ensures that no value is present for Entitlements, not even an explicit nil +### GetAccessProfiles + +`func (o *RoleDocumentAllOfDimensions) GetAccessProfiles() []BaseAccessProfile` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *RoleDocumentAllOfDimensions) GetAccessProfilesOk() (*[]BaseAccessProfile, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *RoleDocumentAllOfDimensions) SetAccessProfiles(v []BaseAccessProfile)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *RoleDocumentAllOfDimensions) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### SetAccessProfilesNil + +`func (o *RoleDocumentAllOfDimensions) SetAccessProfilesNil(b bool)` + + SetAccessProfilesNil sets the value for AccessProfiles to be an explicit nil + +### UnsetAccessProfiles +`func (o *RoleDocumentAllOfDimensions) UnsetAccessProfiles()` + +UnsetAccessProfiles ensures that no value is present for AccessProfiles, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleDocumentAllOfEntitlements.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleDocumentAllOfEntitlements.md new file mode 100644 index 000000000..474c080e7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleDocumentAllOfEntitlements.md @@ -0,0 +1,308 @@ +--- +id: v2025-role-document-all-of-entitlements +title: RoleDocumentAllOfEntitlements +pagination_label: RoleDocumentAllOfEntitlements +sidebar_label: RoleDocumentAllOfEntitlements +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleDocumentAllOfEntitlements', 'V2025RoleDocumentAllOfEntitlements'] +slug: /tools/sdk/go/v2025/models/role-document-all-of-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfEntitlements', 'V2025RoleDocumentAllOfEntitlements'] +--- + +# RoleDocumentAllOfEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasPermissions** | Pointer to **bool** | Indicates whether the entitlement has permissions. | [optional] [default to false] +**Description** | Pointer to **NullableString** | Entitlement's description. | [optional] +**Attribute** | Pointer to **string** | Entitlement attribute's name. | [optional] +**Value** | Pointer to **string** | Entitlement's value. | [optional] +**Schema** | Pointer to **string** | Entitlement's schema. | [optional] +**Privileged** | Pointer to **bool** | Indicates whether the entitlement is privileged. | [optional] [default to false] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **string** | Entitlement's name. | [optional] +**SourceSchemaObjectType** | Pointer to **string** | Schema objectType. | [optional] +**Hash** | Pointer to **string** | Read-only calculated hash value of an entitlement. | [optional] + +## Methods + +### NewRoleDocumentAllOfEntitlements + +`func NewRoleDocumentAllOfEntitlements() *RoleDocumentAllOfEntitlements` + +NewRoleDocumentAllOfEntitlements instantiates a new RoleDocumentAllOfEntitlements 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 + +### NewRoleDocumentAllOfEntitlementsWithDefaults + +`func NewRoleDocumentAllOfEntitlementsWithDefaults() *RoleDocumentAllOfEntitlements` + +NewRoleDocumentAllOfEntitlementsWithDefaults instantiates a new RoleDocumentAllOfEntitlements 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 + +### GetHasPermissions + +`func (o *RoleDocumentAllOfEntitlements) GetHasPermissions() bool` + +GetHasPermissions returns the HasPermissions field if non-nil, zero value otherwise. + +### GetHasPermissionsOk + +`func (o *RoleDocumentAllOfEntitlements) GetHasPermissionsOk() (*bool, bool)` + +GetHasPermissionsOk returns a tuple with the HasPermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasPermissions + +`func (o *RoleDocumentAllOfEntitlements) SetHasPermissions(v bool)` + +SetHasPermissions sets HasPermissions field to given value. + +### HasHasPermissions + +`func (o *RoleDocumentAllOfEntitlements) HasHasPermissions() bool` + +HasHasPermissions returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleDocumentAllOfEntitlements) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleDocumentAllOfEntitlements) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleDocumentAllOfEntitlements) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleDocumentAllOfEntitlements) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleDocumentAllOfEntitlements) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleDocumentAllOfEntitlements) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAttribute + +`func (o *RoleDocumentAllOfEntitlements) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleDocumentAllOfEntitlements) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleDocumentAllOfEntitlements) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleDocumentAllOfEntitlements) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *RoleDocumentAllOfEntitlements) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *RoleDocumentAllOfEntitlements) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *RoleDocumentAllOfEntitlements) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *RoleDocumentAllOfEntitlements) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSchema + +`func (o *RoleDocumentAllOfEntitlements) GetSchema() string` + +GetSchema returns the Schema field if non-nil, zero value otherwise. + +### GetSchemaOk + +`func (o *RoleDocumentAllOfEntitlements) GetSchemaOk() (*string, bool)` + +GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchema + +`func (o *RoleDocumentAllOfEntitlements) SetSchema(v string)` + +SetSchema sets Schema field to given value. + +### HasSchema + +`func (o *RoleDocumentAllOfEntitlements) HasSchema() bool` + +HasSchema returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *RoleDocumentAllOfEntitlements) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *RoleDocumentAllOfEntitlements) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *RoleDocumentAllOfEntitlements) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *RoleDocumentAllOfEntitlements) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetId + +`func (o *RoleDocumentAllOfEntitlements) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleDocumentAllOfEntitlements) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleDocumentAllOfEntitlements) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleDocumentAllOfEntitlements) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleDocumentAllOfEntitlements) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleDocumentAllOfEntitlements) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleDocumentAllOfEntitlements) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleDocumentAllOfEntitlements) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements) GetSourceSchemaObjectType() string` + +GetSourceSchemaObjectType returns the SourceSchemaObjectType field if non-nil, zero value otherwise. + +### GetSourceSchemaObjectTypeOk + +`func (o *RoleDocumentAllOfEntitlements) GetSourceSchemaObjectTypeOk() (*string, bool)` + +GetSourceSchemaObjectTypeOk returns a tuple with the SourceSchemaObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements) SetSourceSchemaObjectType(v string)` + +SetSourceSchemaObjectType sets SourceSchemaObjectType field to given value. + +### HasSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements) HasSourceSchemaObjectType() bool` + +HasSourceSchemaObjectType returns a boolean if a field has been set. + +### GetHash + +`func (o *RoleDocumentAllOfEntitlements) GetHash() string` + +GetHash returns the Hash field if non-nil, zero value otherwise. + +### GetHashOk + +`func (o *RoleDocumentAllOfEntitlements) GetHashOk() (*string, bool)` + +GetHashOk returns a tuple with the Hash field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHash + +`func (o *RoleDocumentAllOfEntitlements) SetHash(v string)` + +SetHash sets Hash field to given value. + +### HasHash + +`func (o *RoleDocumentAllOfEntitlements) HasHash() bool` + +HasHash returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleDocumentAllOfEntitlements1.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleDocumentAllOfEntitlements1.md new file mode 100644 index 000000000..5c38195e8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleDocumentAllOfEntitlements1.md @@ -0,0 +1,308 @@ +--- +id: v2025-role-document-all-of-entitlements1 +title: RoleDocumentAllOfEntitlements1 +pagination_label: RoleDocumentAllOfEntitlements1 +sidebar_label: RoleDocumentAllOfEntitlements1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleDocumentAllOfEntitlements1', 'V2025RoleDocumentAllOfEntitlements1'] +slug: /tools/sdk/go/v2025/models/role-document-all-of-entitlements1 +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfEntitlements1', 'V2025RoleDocumentAllOfEntitlements1'] +--- + +# RoleDocumentAllOfEntitlements1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasPermissions** | Pointer to **bool** | Indicates whether the entitlement has permissions. | [optional] [default to false] +**Description** | Pointer to **NullableString** | Entitlement's description. | [optional] +**Attribute** | Pointer to **string** | Entitlement attribute's name. | [optional] +**Value** | Pointer to **string** | Entitlement's value. | [optional] +**Schema** | Pointer to **string** | Entitlement's schema. | [optional] +**Privileged** | Pointer to **bool** | Indicates whether the entitlement is privileged. | [optional] [default to false] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **string** | Entitlement's name. | [optional] +**SourceSchemaObjectType** | Pointer to **string** | Schema objectType. | [optional] +**Hash** | Pointer to **string** | Read-only calculated hash value of an entitlement. | [optional] + +## Methods + +### NewRoleDocumentAllOfEntitlements1 + +`func NewRoleDocumentAllOfEntitlements1() *RoleDocumentAllOfEntitlements1` + +NewRoleDocumentAllOfEntitlements1 instantiates a new RoleDocumentAllOfEntitlements1 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 + +### NewRoleDocumentAllOfEntitlements1WithDefaults + +`func NewRoleDocumentAllOfEntitlements1WithDefaults() *RoleDocumentAllOfEntitlements1` + +NewRoleDocumentAllOfEntitlements1WithDefaults instantiates a new RoleDocumentAllOfEntitlements1 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 + +### GetHasPermissions + +`func (o *RoleDocumentAllOfEntitlements1) GetHasPermissions() bool` + +GetHasPermissions returns the HasPermissions field if non-nil, zero value otherwise. + +### GetHasPermissionsOk + +`func (o *RoleDocumentAllOfEntitlements1) GetHasPermissionsOk() (*bool, bool)` + +GetHasPermissionsOk returns a tuple with the HasPermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasPermissions + +`func (o *RoleDocumentAllOfEntitlements1) SetHasPermissions(v bool)` + +SetHasPermissions sets HasPermissions field to given value. + +### HasHasPermissions + +`func (o *RoleDocumentAllOfEntitlements1) HasHasPermissions() bool` + +HasHasPermissions returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleDocumentAllOfEntitlements1) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleDocumentAllOfEntitlements1) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleDocumentAllOfEntitlements1) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleDocumentAllOfEntitlements1) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleDocumentAllOfEntitlements1) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleDocumentAllOfEntitlements1) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAttribute + +`func (o *RoleDocumentAllOfEntitlements1) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleDocumentAllOfEntitlements1) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleDocumentAllOfEntitlements1) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleDocumentAllOfEntitlements1) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *RoleDocumentAllOfEntitlements1) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *RoleDocumentAllOfEntitlements1) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *RoleDocumentAllOfEntitlements1) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *RoleDocumentAllOfEntitlements1) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSchema + +`func (o *RoleDocumentAllOfEntitlements1) GetSchema() string` + +GetSchema returns the Schema field if non-nil, zero value otherwise. + +### GetSchemaOk + +`func (o *RoleDocumentAllOfEntitlements1) GetSchemaOk() (*string, bool)` + +GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchema + +`func (o *RoleDocumentAllOfEntitlements1) SetSchema(v string)` + +SetSchema sets Schema field to given value. + +### HasSchema + +`func (o *RoleDocumentAllOfEntitlements1) HasSchema() bool` + +HasSchema returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *RoleDocumentAllOfEntitlements1) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *RoleDocumentAllOfEntitlements1) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *RoleDocumentAllOfEntitlements1) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *RoleDocumentAllOfEntitlements1) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetId + +`func (o *RoleDocumentAllOfEntitlements1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleDocumentAllOfEntitlements1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleDocumentAllOfEntitlements1) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleDocumentAllOfEntitlements1) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleDocumentAllOfEntitlements1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleDocumentAllOfEntitlements1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleDocumentAllOfEntitlements1) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleDocumentAllOfEntitlements1) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements1) GetSourceSchemaObjectType() string` + +GetSourceSchemaObjectType returns the SourceSchemaObjectType field if non-nil, zero value otherwise. + +### GetSourceSchemaObjectTypeOk + +`func (o *RoleDocumentAllOfEntitlements1) GetSourceSchemaObjectTypeOk() (*string, bool)` + +GetSourceSchemaObjectTypeOk returns a tuple with the SourceSchemaObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements1) SetSourceSchemaObjectType(v string)` + +SetSourceSchemaObjectType sets SourceSchemaObjectType field to given value. + +### HasSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements1) HasSourceSchemaObjectType() bool` + +HasSourceSchemaObjectType returns a boolean if a field has been set. + +### GetHash + +`func (o *RoleDocumentAllOfEntitlements1) GetHash() string` + +GetHash returns the Hash field if non-nil, zero value otherwise. + +### GetHashOk + +`func (o *RoleDocumentAllOfEntitlements1) GetHashOk() (*string, bool)` + +GetHashOk returns a tuple with the Hash field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHash + +`func (o *RoleDocumentAllOfEntitlements1) SetHash(v string)` + +SetHash sets Hash field to given value. + +### HasHash + +`func (o *RoleDocumentAllOfEntitlements1) HasHash() bool` + +HasHash returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleGetAllBulkUpdateResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleGetAllBulkUpdateResponse.md new file mode 100644 index 000000000..7e59deaf1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleGetAllBulkUpdateResponse.md @@ -0,0 +1,142 @@ +--- +id: v2025-role-get-all-bulk-update-response +title: RoleGetAllBulkUpdateResponse +pagination_label: RoleGetAllBulkUpdateResponse +sidebar_label: RoleGetAllBulkUpdateResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleGetAllBulkUpdateResponse', 'V2025RoleGetAllBulkUpdateResponse'] +slug: /tools/sdk/go/v2025/models/role-get-all-bulk-update-response +tags: ['SDK', 'Software Development Kit', 'RoleGetAllBulkUpdateResponse', 'V2025RoleGetAllBulkUpdateResponse'] +--- + +# RoleGetAllBulkUpdateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the task which is executing the bulk update. This also used in to the bulk-update/_** API to track status. | [optional] +**Type** | Pointer to **string** | Type of the bulk update object. | [optional] +**Status** | Pointer to **string** | The status of the bulk update request, only list unfinished request's status, the status could also checked by getBulkUpdateStatus API | [optional] +**Created** | Pointer to **SailPointTime** | Time when the bulk update request was created | [optional] + +## Methods + +### NewRoleGetAllBulkUpdateResponse + +`func NewRoleGetAllBulkUpdateResponse() *RoleGetAllBulkUpdateResponse` + +NewRoleGetAllBulkUpdateResponse instantiates a new RoleGetAllBulkUpdateResponse 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 + +### NewRoleGetAllBulkUpdateResponseWithDefaults + +`func NewRoleGetAllBulkUpdateResponseWithDefaults() *RoleGetAllBulkUpdateResponse` + +NewRoleGetAllBulkUpdateResponseWithDefaults instantiates a new RoleGetAllBulkUpdateResponse 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 + +### GetId + +`func (o *RoleGetAllBulkUpdateResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleGetAllBulkUpdateResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleGetAllBulkUpdateResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleGetAllBulkUpdateResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *RoleGetAllBulkUpdateResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleGetAllBulkUpdateResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleGetAllBulkUpdateResponse) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleGetAllBulkUpdateResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetStatus + +`func (o *RoleGetAllBulkUpdateResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *RoleGetAllBulkUpdateResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *RoleGetAllBulkUpdateResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *RoleGetAllBulkUpdateResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *RoleGetAllBulkUpdateResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RoleGetAllBulkUpdateResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RoleGetAllBulkUpdateResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RoleGetAllBulkUpdateResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleIdentity.md new file mode 100644 index 000000000..caea7d181 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleIdentity.md @@ -0,0 +1,168 @@ +--- +id: v2025-role-identity +title: RoleIdentity +pagination_label: RoleIdentity +sidebar_label: RoleIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleIdentity', 'V2025RoleIdentity'] +slug: /tools/sdk/go/v2025/models/role-identity +tags: ['SDK', 'Software Development Kit', 'RoleIdentity', 'V2025RoleIdentity'] +--- + +# RoleIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the Identity | [optional] +**AliasName** | Pointer to **string** | The alias / username of the Identity | [optional] +**Name** | Pointer to **string** | The human-readable display name of the Identity | [optional] +**Email** | Pointer to **string** | Email address of the Identity | [optional] +**RoleAssignmentSource** | Pointer to [**RoleAssignmentSourceType**](role-assignment-source-type) | | [optional] + +## Methods + +### NewRoleIdentity + +`func NewRoleIdentity() *RoleIdentity` + +NewRoleIdentity instantiates a new RoleIdentity 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 + +### NewRoleIdentityWithDefaults + +`func NewRoleIdentityWithDefaults() *RoleIdentity` + +NewRoleIdentityWithDefaults instantiates a new RoleIdentity 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 + +### GetId + +`func (o *RoleIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAliasName + +`func (o *RoleIdentity) GetAliasName() string` + +GetAliasName returns the AliasName field if non-nil, zero value otherwise. + +### GetAliasNameOk + +`func (o *RoleIdentity) GetAliasNameOk() (*string, bool)` + +GetAliasNameOk returns a tuple with the AliasName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAliasName + +`func (o *RoleIdentity) SetAliasName(v string)` + +SetAliasName sets AliasName field to given value. + +### HasAliasName + +`func (o *RoleIdentity) HasAliasName() bool` + +HasAliasName returns a boolean if a field has been set. + +### GetName + +`func (o *RoleIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *RoleIdentity) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *RoleIdentity) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *RoleIdentity) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *RoleIdentity) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetRoleAssignmentSource + +`func (o *RoleIdentity) GetRoleAssignmentSource() RoleAssignmentSourceType` + +GetRoleAssignmentSource returns the RoleAssignmentSource field if non-nil, zero value otherwise. + +### GetRoleAssignmentSourceOk + +`func (o *RoleIdentity) GetRoleAssignmentSourceOk() (*RoleAssignmentSourceType, bool)` + +GetRoleAssignmentSourceOk returns a tuple with the RoleAssignmentSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleAssignmentSource + +`func (o *RoleIdentity) SetRoleAssignmentSource(v RoleAssignmentSourceType)` + +SetRoleAssignmentSource sets RoleAssignmentSource field to given value. + +### HasRoleAssignmentSource + +`func (o *RoleIdentity) HasRoleAssignmentSource() bool` + +HasRoleAssignmentSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleInsight.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleInsight.md new file mode 100644 index 000000000..3176fe34d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleInsight.md @@ -0,0 +1,204 @@ +--- +id: v2025-role-insight +title: RoleInsight +pagination_label: RoleInsight +sidebar_label: RoleInsight +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsight', 'V2025RoleInsight'] +slug: /tools/sdk/go/v2025/models/role-insight +tags: ['SDK', 'Software Development Kit', 'RoleInsight', 'V2025RoleInsight'] +--- + +# RoleInsight + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Insight id | [optional] +**NumberOfUpdates** | Pointer to **int32** | Total number of updates for this role | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time insights were last created for this role. | [optional] +**ModifiedDate** | Pointer to **NullableTime** | The date-time insights were last modified for this role. | [optional] +**Role** | Pointer to [**RoleInsightsRole**](role-insights-role) | | [optional] +**Insight** | Pointer to [**RoleInsightsInsight**](role-insights-insight) | | [optional] + +## Methods + +### NewRoleInsight + +`func NewRoleInsight() *RoleInsight` + +NewRoleInsight instantiates a new RoleInsight 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 + +### NewRoleInsightWithDefaults + +`func NewRoleInsightWithDefaults() *RoleInsight` + +NewRoleInsightWithDefaults instantiates a new RoleInsight 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 + +### GetId + +`func (o *RoleInsight) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsight) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsight) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsight) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetNumberOfUpdates + +`func (o *RoleInsight) GetNumberOfUpdates() int32` + +GetNumberOfUpdates returns the NumberOfUpdates field if non-nil, zero value otherwise. + +### GetNumberOfUpdatesOk + +`func (o *RoleInsight) GetNumberOfUpdatesOk() (*int32, bool)` + +GetNumberOfUpdatesOk returns a tuple with the NumberOfUpdates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumberOfUpdates + +`func (o *RoleInsight) SetNumberOfUpdates(v int32)` + +SetNumberOfUpdates sets NumberOfUpdates field to given value. + +### HasNumberOfUpdates + +`func (o *RoleInsight) HasNumberOfUpdates() bool` + +HasNumberOfUpdates returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleInsight) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleInsight) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleInsight) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleInsight) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetModifiedDate + +`func (o *RoleInsight) GetModifiedDate() SailPointTime` + +GetModifiedDate returns the ModifiedDate field if non-nil, zero value otherwise. + +### GetModifiedDateOk + +`func (o *RoleInsight) GetModifiedDateOk() (*SailPointTime, bool)` + +GetModifiedDateOk returns a tuple with the ModifiedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedDate + +`func (o *RoleInsight) SetModifiedDate(v SailPointTime)` + +SetModifiedDate sets ModifiedDate field to given value. + +### HasModifiedDate + +`func (o *RoleInsight) HasModifiedDate() bool` + +HasModifiedDate returns a boolean if a field has been set. + +### SetModifiedDateNil + +`func (o *RoleInsight) SetModifiedDateNil(b bool)` + + SetModifiedDateNil sets the value for ModifiedDate to be an explicit nil + +### UnsetModifiedDate +`func (o *RoleInsight) UnsetModifiedDate()` + +UnsetModifiedDate ensures that no value is present for ModifiedDate, not even an explicit nil +### GetRole + +`func (o *RoleInsight) GetRole() RoleInsightsRole` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *RoleInsight) GetRoleOk() (*RoleInsightsRole, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *RoleInsight) SetRole(v RoleInsightsRole)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *RoleInsight) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetInsight + +`func (o *RoleInsight) GetInsight() RoleInsightsInsight` + +GetInsight returns the Insight field if non-nil, zero value otherwise. + +### GetInsightOk + +`func (o *RoleInsight) GetInsightOk() (*RoleInsightsInsight, bool)` + +GetInsightOk returns a tuple with the Insight field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInsight + +`func (o *RoleInsight) SetInsight(v RoleInsightsInsight)` + +SetInsight sets Insight field to given value. + +### HasInsight + +`func (o *RoleInsight) HasInsight() bool` + +HasInsight returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsEntitlement.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsEntitlement.md new file mode 100644 index 000000000..778a27c19 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsEntitlement.md @@ -0,0 +1,204 @@ +--- +id: v2025-role-insights-entitlement +title: RoleInsightsEntitlement +pagination_label: RoleInsightsEntitlement +sidebar_label: RoleInsightsEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsEntitlement', 'V2025RoleInsightsEntitlement'] +slug: /tools/sdk/go/v2025/models/role-insights-entitlement +tags: ['SDK', 'Software Development Kit', 'RoleInsightsEntitlement', 'V2025RoleInsightsEntitlement'] +--- + +# RoleInsightsEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the entitlement | [optional] +**Id** | Pointer to **string** | Id of the entitlement | [optional] +**Description** | Pointer to **NullableString** | Description for the entitlement | [optional] +**Source** | Pointer to **string** | Source or the application for the entitlement | [optional] +**Attribute** | Pointer to **string** | Attribute for the entitlement | [optional] +**Value** | Pointer to **string** | Attribute value for the entitlement | [optional] + +## Methods + +### NewRoleInsightsEntitlement + +`func NewRoleInsightsEntitlement() *RoleInsightsEntitlement` + +NewRoleInsightsEntitlement instantiates a new RoleInsightsEntitlement 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 + +### NewRoleInsightsEntitlementWithDefaults + +`func NewRoleInsightsEntitlementWithDefaults() *RoleInsightsEntitlement` + +NewRoleInsightsEntitlementWithDefaults instantiates a new RoleInsightsEntitlement 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 + +### GetName + +`func (o *RoleInsightsEntitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleInsightsEntitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleInsightsEntitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleInsightsEntitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetId + +`func (o *RoleInsightsEntitlement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsightsEntitlement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsightsEntitlement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsightsEntitlement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleInsightsEntitlement) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleInsightsEntitlement) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleInsightsEntitlement) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleInsightsEntitlement) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleInsightsEntitlement) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleInsightsEntitlement) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSource + +`func (o *RoleInsightsEntitlement) GetSource() string` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *RoleInsightsEntitlement) GetSourceOk() (*string, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *RoleInsightsEntitlement) SetSource(v string)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *RoleInsightsEntitlement) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAttribute + +`func (o *RoleInsightsEntitlement) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleInsightsEntitlement) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleInsightsEntitlement) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleInsightsEntitlement) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *RoleInsightsEntitlement) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *RoleInsightsEntitlement) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *RoleInsightsEntitlement) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *RoleInsightsEntitlement) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsEntitlementChanges.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsEntitlementChanges.md new file mode 100644 index 000000000..88c924ea5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsEntitlementChanges.md @@ -0,0 +1,230 @@ +--- +id: v2025-role-insights-entitlement-changes +title: RoleInsightsEntitlementChanges +pagination_label: RoleInsightsEntitlementChanges +sidebar_label: RoleInsightsEntitlementChanges +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsEntitlementChanges', 'V2025RoleInsightsEntitlementChanges'] +slug: /tools/sdk/go/v2025/models/role-insights-entitlement-changes +tags: ['SDK', 'Software Development Kit', 'RoleInsightsEntitlementChanges', 'V2025RoleInsightsEntitlementChanges'] +--- + +# RoleInsightsEntitlementChanges + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the entitlement | [optional] +**Id** | Pointer to **string** | Id of the entitlement | [optional] +**Description** | Pointer to **NullableString** | Description for the entitlement | [optional] +**Attribute** | Pointer to **string** | Attribute for the entitlement | [optional] +**Value** | Pointer to **string** | Attribute value for the entitlement | [optional] +**Source** | Pointer to **string** | Source or the application for the entitlement | [optional] +**Insight** | Pointer to [**RoleInsightsInsight**](role-insights-insight) | | [optional] + +## Methods + +### NewRoleInsightsEntitlementChanges + +`func NewRoleInsightsEntitlementChanges() *RoleInsightsEntitlementChanges` + +NewRoleInsightsEntitlementChanges instantiates a new RoleInsightsEntitlementChanges 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 + +### NewRoleInsightsEntitlementChangesWithDefaults + +`func NewRoleInsightsEntitlementChangesWithDefaults() *RoleInsightsEntitlementChanges` + +NewRoleInsightsEntitlementChangesWithDefaults instantiates a new RoleInsightsEntitlementChanges 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 + +### GetName + +`func (o *RoleInsightsEntitlementChanges) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleInsightsEntitlementChanges) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleInsightsEntitlementChanges) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleInsightsEntitlementChanges) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetId + +`func (o *RoleInsightsEntitlementChanges) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsightsEntitlementChanges) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsightsEntitlementChanges) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsightsEntitlementChanges) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleInsightsEntitlementChanges) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleInsightsEntitlementChanges) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleInsightsEntitlementChanges) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleInsightsEntitlementChanges) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleInsightsEntitlementChanges) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleInsightsEntitlementChanges) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAttribute + +`func (o *RoleInsightsEntitlementChanges) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleInsightsEntitlementChanges) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleInsightsEntitlementChanges) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleInsightsEntitlementChanges) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *RoleInsightsEntitlementChanges) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *RoleInsightsEntitlementChanges) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *RoleInsightsEntitlementChanges) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *RoleInsightsEntitlementChanges) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSource + +`func (o *RoleInsightsEntitlementChanges) GetSource() string` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *RoleInsightsEntitlementChanges) GetSourceOk() (*string, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *RoleInsightsEntitlementChanges) SetSource(v string)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *RoleInsightsEntitlementChanges) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetInsight + +`func (o *RoleInsightsEntitlementChanges) GetInsight() RoleInsightsInsight` + +GetInsight returns the Insight field if non-nil, zero value otherwise. + +### GetInsightOk + +`func (o *RoleInsightsEntitlementChanges) GetInsightOk() (*RoleInsightsInsight, bool)` + +GetInsightOk returns a tuple with the Insight field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInsight + +`func (o *RoleInsightsEntitlementChanges) SetInsight(v RoleInsightsInsight)` + +SetInsight sets Insight field to given value. + +### HasInsight + +`func (o *RoleInsightsEntitlementChanges) HasInsight() bool` + +HasInsight returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsIdentities.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsIdentities.md new file mode 100644 index 000000000..3171b8e00 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsIdentities.md @@ -0,0 +1,116 @@ +--- +id: v2025-role-insights-identities +title: RoleInsightsIdentities +pagination_label: RoleInsightsIdentities +sidebar_label: RoleInsightsIdentities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsIdentities', 'V2025RoleInsightsIdentities'] +slug: /tools/sdk/go/v2025/models/role-insights-identities +tags: ['SDK', 'Software Development Kit', 'RoleInsightsIdentities', 'V2025RoleInsightsIdentities'] +--- + +# RoleInsightsIdentities + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id for identity | [optional] +**Name** | Pointer to **string** | Name for identity | [optional] +**Attributes** | Pointer to **map[string]string** | | [optional] + +## Methods + +### NewRoleInsightsIdentities + +`func NewRoleInsightsIdentities() *RoleInsightsIdentities` + +NewRoleInsightsIdentities instantiates a new RoleInsightsIdentities 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 + +### NewRoleInsightsIdentitiesWithDefaults + +`func NewRoleInsightsIdentitiesWithDefaults() *RoleInsightsIdentities` + +NewRoleInsightsIdentitiesWithDefaults instantiates a new RoleInsightsIdentities 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 + +### GetId + +`func (o *RoleInsightsIdentities) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsightsIdentities) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsightsIdentities) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsightsIdentities) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleInsightsIdentities) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleInsightsIdentities) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleInsightsIdentities) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleInsightsIdentities) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAttributes + +`func (o *RoleInsightsIdentities) GetAttributes() map[string]string` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *RoleInsightsIdentities) GetAttributesOk() (*map[string]string, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *RoleInsightsIdentities) SetAttributes(v map[string]string)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *RoleInsightsIdentities) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsInsight.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsInsight.md new file mode 100644 index 000000000..23277110f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsInsight.md @@ -0,0 +1,178 @@ +--- +id: v2025-role-insights-insight +title: RoleInsightsInsight +pagination_label: RoleInsightsInsight +sidebar_label: RoleInsightsInsight +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsInsight', 'V2025RoleInsightsInsight'] +slug: /tools/sdk/go/v2025/models/role-insights-insight +tags: ['SDK', 'Software Development Kit', 'RoleInsightsInsight', 'V2025RoleInsightsInsight'] +--- + +# RoleInsightsInsight + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The number of identities in this role with the entitlement. | [optional] +**IdentitiesWithAccess** | Pointer to **int32** | The number of identities in this role with the entitlement. | [optional] +**IdentitiesImpacted** | Pointer to **int32** | The number of identities in this role that do not have the specified entitlement. | [optional] +**TotalNumberOfIdentities** | Pointer to **int32** | The total number of identities. | [optional] +**ImpactedIdentityNames** | Pointer to **NullableString** | | [optional] + +## Methods + +### NewRoleInsightsInsight + +`func NewRoleInsightsInsight() *RoleInsightsInsight` + +NewRoleInsightsInsight instantiates a new RoleInsightsInsight 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 + +### NewRoleInsightsInsightWithDefaults + +`func NewRoleInsightsInsightWithDefaults() *RoleInsightsInsight` + +NewRoleInsightsInsightWithDefaults instantiates a new RoleInsightsInsight 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 + +### GetType + +`func (o *RoleInsightsInsight) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleInsightsInsight) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleInsightsInsight) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleInsightsInsight) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetIdentitiesWithAccess + +`func (o *RoleInsightsInsight) GetIdentitiesWithAccess() int32` + +GetIdentitiesWithAccess returns the IdentitiesWithAccess field if non-nil, zero value otherwise. + +### GetIdentitiesWithAccessOk + +`func (o *RoleInsightsInsight) GetIdentitiesWithAccessOk() (*int32, bool)` + +GetIdentitiesWithAccessOk returns a tuple with the IdentitiesWithAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesWithAccess + +`func (o *RoleInsightsInsight) SetIdentitiesWithAccess(v int32)` + +SetIdentitiesWithAccess sets IdentitiesWithAccess field to given value. + +### HasIdentitiesWithAccess + +`func (o *RoleInsightsInsight) HasIdentitiesWithAccess() bool` + +HasIdentitiesWithAccess returns a boolean if a field has been set. + +### GetIdentitiesImpacted + +`func (o *RoleInsightsInsight) GetIdentitiesImpacted() int32` + +GetIdentitiesImpacted returns the IdentitiesImpacted field if non-nil, zero value otherwise. + +### GetIdentitiesImpactedOk + +`func (o *RoleInsightsInsight) GetIdentitiesImpactedOk() (*int32, bool)` + +GetIdentitiesImpactedOk returns a tuple with the IdentitiesImpacted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesImpacted + +`func (o *RoleInsightsInsight) SetIdentitiesImpacted(v int32)` + +SetIdentitiesImpacted sets IdentitiesImpacted field to given value. + +### HasIdentitiesImpacted + +`func (o *RoleInsightsInsight) HasIdentitiesImpacted() bool` + +HasIdentitiesImpacted returns a boolean if a field has been set. + +### GetTotalNumberOfIdentities + +`func (o *RoleInsightsInsight) GetTotalNumberOfIdentities() int32` + +GetTotalNumberOfIdentities returns the TotalNumberOfIdentities field if non-nil, zero value otherwise. + +### GetTotalNumberOfIdentitiesOk + +`func (o *RoleInsightsInsight) GetTotalNumberOfIdentitiesOk() (*int32, bool)` + +GetTotalNumberOfIdentitiesOk returns a tuple with the TotalNumberOfIdentities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalNumberOfIdentities + +`func (o *RoleInsightsInsight) SetTotalNumberOfIdentities(v int32)` + +SetTotalNumberOfIdentities sets TotalNumberOfIdentities field to given value. + +### HasTotalNumberOfIdentities + +`func (o *RoleInsightsInsight) HasTotalNumberOfIdentities() bool` + +HasTotalNumberOfIdentities returns a boolean if a field has been set. + +### GetImpactedIdentityNames + +`func (o *RoleInsightsInsight) GetImpactedIdentityNames() string` + +GetImpactedIdentityNames returns the ImpactedIdentityNames field if non-nil, zero value otherwise. + +### GetImpactedIdentityNamesOk + +`func (o *RoleInsightsInsight) GetImpactedIdentityNamesOk() (*string, bool)` + +GetImpactedIdentityNamesOk returns a tuple with the ImpactedIdentityNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImpactedIdentityNames + +`func (o *RoleInsightsInsight) SetImpactedIdentityNames(v string)` + +SetImpactedIdentityNames sets ImpactedIdentityNames field to given value. + +### HasImpactedIdentityNames + +`func (o *RoleInsightsInsight) HasImpactedIdentityNames() bool` + +HasImpactedIdentityNames returns a boolean if a field has been set. + +### SetImpactedIdentityNamesNil + +`func (o *RoleInsightsInsight) SetImpactedIdentityNamesNil(b bool)` + + SetImpactedIdentityNamesNil sets the value for ImpactedIdentityNames to be an explicit nil + +### UnsetImpactedIdentityNames +`func (o *RoleInsightsInsight) UnsetImpactedIdentityNames()` + +UnsetImpactedIdentityNames ensures that no value is present for ImpactedIdentityNames, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsResponse.md new file mode 100644 index 000000000..76c2d7d34 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsResponse.md @@ -0,0 +1,194 @@ +--- +id: v2025-role-insights-response +title: RoleInsightsResponse +pagination_label: RoleInsightsResponse +sidebar_label: RoleInsightsResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsResponse', 'V2025RoleInsightsResponse'] +slug: /tools/sdk/go/v2025/models/role-insights-response +tags: ['SDK', 'Software Development Kit', 'RoleInsightsResponse', 'V2025RoleInsightsResponse'] +--- + +# RoleInsightsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Request Id for a role insight generation request | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time role insights request was created. | [optional] +**LastGenerated** | Pointer to **SailPointTime** | The date-time role insights request was completed. | [optional] +**NumberOfUpdates** | Pointer to **int32** | Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED. | [optional] +**RoleIds** | Pointer to **[]string** | The role IDs that are in this request. | [optional] +**Status** | Pointer to **string** | Request status | [optional] + +## Methods + +### NewRoleInsightsResponse + +`func NewRoleInsightsResponse() *RoleInsightsResponse` + +NewRoleInsightsResponse instantiates a new RoleInsightsResponse 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 + +### NewRoleInsightsResponseWithDefaults + +`func NewRoleInsightsResponseWithDefaults() *RoleInsightsResponse` + +NewRoleInsightsResponseWithDefaults instantiates a new RoleInsightsResponse 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 + +### GetId + +`func (o *RoleInsightsResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsightsResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsightsResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsightsResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleInsightsResponse) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleInsightsResponse) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleInsightsResponse) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleInsightsResponse) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetLastGenerated + +`func (o *RoleInsightsResponse) GetLastGenerated() SailPointTime` + +GetLastGenerated returns the LastGenerated field if non-nil, zero value otherwise. + +### GetLastGeneratedOk + +`func (o *RoleInsightsResponse) GetLastGeneratedOk() (*SailPointTime, bool)` + +GetLastGeneratedOk returns a tuple with the LastGenerated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastGenerated + +`func (o *RoleInsightsResponse) SetLastGenerated(v SailPointTime)` + +SetLastGenerated sets LastGenerated field to given value. + +### HasLastGenerated + +`func (o *RoleInsightsResponse) HasLastGenerated() bool` + +HasLastGenerated returns a boolean if a field has been set. + +### GetNumberOfUpdates + +`func (o *RoleInsightsResponse) GetNumberOfUpdates() int32` + +GetNumberOfUpdates returns the NumberOfUpdates field if non-nil, zero value otherwise. + +### GetNumberOfUpdatesOk + +`func (o *RoleInsightsResponse) GetNumberOfUpdatesOk() (*int32, bool)` + +GetNumberOfUpdatesOk returns a tuple with the NumberOfUpdates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumberOfUpdates + +`func (o *RoleInsightsResponse) SetNumberOfUpdates(v int32)` + +SetNumberOfUpdates sets NumberOfUpdates field to given value. + +### HasNumberOfUpdates + +`func (o *RoleInsightsResponse) HasNumberOfUpdates() bool` + +HasNumberOfUpdates returns a boolean if a field has been set. + +### GetRoleIds + +`func (o *RoleInsightsResponse) GetRoleIds() []string` + +GetRoleIds returns the RoleIds field if non-nil, zero value otherwise. + +### GetRoleIdsOk + +`func (o *RoleInsightsResponse) GetRoleIdsOk() (*[]string, bool)` + +GetRoleIdsOk returns a tuple with the RoleIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleIds + +`func (o *RoleInsightsResponse) SetRoleIds(v []string)` + +SetRoleIds sets RoleIds field to given value. + +### HasRoleIds + +`func (o *RoleInsightsResponse) HasRoleIds() bool` + +HasRoleIds returns a boolean if a field has been set. + +### GetStatus + +`func (o *RoleInsightsResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *RoleInsightsResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *RoleInsightsResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *RoleInsightsResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsRole.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsRole.md new file mode 100644 index 000000000..8511bff65 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsRole.md @@ -0,0 +1,168 @@ +--- +id: v2025-role-insights-role +title: RoleInsightsRole +pagination_label: RoleInsightsRole +sidebar_label: RoleInsightsRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsRole', 'V2025RoleInsightsRole'] +slug: /tools/sdk/go/v2025/models/role-insights-role +tags: ['SDK', 'Software Development Kit', 'RoleInsightsRole', 'V2025RoleInsightsRole'] +--- + +# RoleInsightsRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Role name | [optional] +**Id** | Pointer to **string** | Role id | [optional] +**Description** | Pointer to **string** | Role description | [optional] +**OwnerName** | Pointer to **string** | Role owner name | [optional] +**OwnerId** | Pointer to **string** | Role owner id | [optional] + +## Methods + +### NewRoleInsightsRole + +`func NewRoleInsightsRole() *RoleInsightsRole` + +NewRoleInsightsRole instantiates a new RoleInsightsRole 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 + +### NewRoleInsightsRoleWithDefaults + +`func NewRoleInsightsRoleWithDefaults() *RoleInsightsRole` + +NewRoleInsightsRoleWithDefaults instantiates a new RoleInsightsRole 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 + +### GetName + +`func (o *RoleInsightsRole) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleInsightsRole) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleInsightsRole) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleInsightsRole) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetId + +`func (o *RoleInsightsRole) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleInsightsRole) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleInsightsRole) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleInsightsRole) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleInsightsRole) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleInsightsRole) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleInsightsRole) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleInsightsRole) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwnerName + +`func (o *RoleInsightsRole) GetOwnerName() string` + +GetOwnerName returns the OwnerName field if non-nil, zero value otherwise. + +### GetOwnerNameOk + +`func (o *RoleInsightsRole) GetOwnerNameOk() (*string, bool)` + +GetOwnerNameOk returns a tuple with the OwnerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerName + +`func (o *RoleInsightsRole) SetOwnerName(v string)` + +SetOwnerName sets OwnerName field to given value. + +### HasOwnerName + +`func (o *RoleInsightsRole) HasOwnerName() bool` + +HasOwnerName returns a boolean if a field has been set. + +### GetOwnerId + +`func (o *RoleInsightsRole) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *RoleInsightsRole) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *RoleInsightsRole) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *RoleInsightsRole) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsSummary.md new file mode 100644 index 000000000..1b252bed9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleInsightsSummary.md @@ -0,0 +1,194 @@ +--- +id: v2025-role-insights-summary +title: RoleInsightsSummary +pagination_label: RoleInsightsSummary +sidebar_label: RoleInsightsSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleInsightsSummary', 'V2025RoleInsightsSummary'] +slug: /tools/sdk/go/v2025/models/role-insights-summary +tags: ['SDK', 'Software Development Kit', 'RoleInsightsSummary', 'V2025RoleInsightsSummary'] +--- + +# RoleInsightsSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NumberOfUpdates** | Pointer to **int32** | Total number of roles with updates | [optional] +**LastGenerated** | Pointer to **SailPointTime** | The date-time role insights were last found. | [optional] +**EntitlementsIncludedInRoles** | Pointer to **int32** | The number of entitlements included in roles (vs free radicals). | [optional] +**TotalNumberOfEntitlements** | Pointer to **int32** | The total number of entitlements. | [optional] +**IdentitiesWithAccessViaRoles** | Pointer to **int32** | The number of identities in roles vs. identities with just entitlements and not in roles. | [optional] +**TotalNumberOfIdentities** | Pointer to **int32** | The total number of identities. | [optional] + +## Methods + +### NewRoleInsightsSummary + +`func NewRoleInsightsSummary() *RoleInsightsSummary` + +NewRoleInsightsSummary instantiates a new RoleInsightsSummary 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 + +### NewRoleInsightsSummaryWithDefaults + +`func NewRoleInsightsSummaryWithDefaults() *RoleInsightsSummary` + +NewRoleInsightsSummaryWithDefaults instantiates a new RoleInsightsSummary 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 + +### GetNumberOfUpdates + +`func (o *RoleInsightsSummary) GetNumberOfUpdates() int32` + +GetNumberOfUpdates returns the NumberOfUpdates field if non-nil, zero value otherwise. + +### GetNumberOfUpdatesOk + +`func (o *RoleInsightsSummary) GetNumberOfUpdatesOk() (*int32, bool)` + +GetNumberOfUpdatesOk returns a tuple with the NumberOfUpdates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumberOfUpdates + +`func (o *RoleInsightsSummary) SetNumberOfUpdates(v int32)` + +SetNumberOfUpdates sets NumberOfUpdates field to given value. + +### HasNumberOfUpdates + +`func (o *RoleInsightsSummary) HasNumberOfUpdates() bool` + +HasNumberOfUpdates returns a boolean if a field has been set. + +### GetLastGenerated + +`func (o *RoleInsightsSummary) GetLastGenerated() SailPointTime` + +GetLastGenerated returns the LastGenerated field if non-nil, zero value otherwise. + +### GetLastGeneratedOk + +`func (o *RoleInsightsSummary) GetLastGeneratedOk() (*SailPointTime, bool)` + +GetLastGeneratedOk returns a tuple with the LastGenerated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastGenerated + +`func (o *RoleInsightsSummary) SetLastGenerated(v SailPointTime)` + +SetLastGenerated sets LastGenerated field to given value. + +### HasLastGenerated + +`func (o *RoleInsightsSummary) HasLastGenerated() bool` + +HasLastGenerated returns a boolean if a field has been set. + +### GetEntitlementsIncludedInRoles + +`func (o *RoleInsightsSummary) GetEntitlementsIncludedInRoles() int32` + +GetEntitlementsIncludedInRoles returns the EntitlementsIncludedInRoles field if non-nil, zero value otherwise. + +### GetEntitlementsIncludedInRolesOk + +`func (o *RoleInsightsSummary) GetEntitlementsIncludedInRolesOk() (*int32, bool)` + +GetEntitlementsIncludedInRolesOk returns a tuple with the EntitlementsIncludedInRoles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementsIncludedInRoles + +`func (o *RoleInsightsSummary) SetEntitlementsIncludedInRoles(v int32)` + +SetEntitlementsIncludedInRoles sets EntitlementsIncludedInRoles field to given value. + +### HasEntitlementsIncludedInRoles + +`func (o *RoleInsightsSummary) HasEntitlementsIncludedInRoles() bool` + +HasEntitlementsIncludedInRoles returns a boolean if a field has been set. + +### GetTotalNumberOfEntitlements + +`func (o *RoleInsightsSummary) GetTotalNumberOfEntitlements() int32` + +GetTotalNumberOfEntitlements returns the TotalNumberOfEntitlements field if non-nil, zero value otherwise. + +### GetTotalNumberOfEntitlementsOk + +`func (o *RoleInsightsSummary) GetTotalNumberOfEntitlementsOk() (*int32, bool)` + +GetTotalNumberOfEntitlementsOk returns a tuple with the TotalNumberOfEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalNumberOfEntitlements + +`func (o *RoleInsightsSummary) SetTotalNumberOfEntitlements(v int32)` + +SetTotalNumberOfEntitlements sets TotalNumberOfEntitlements field to given value. + +### HasTotalNumberOfEntitlements + +`func (o *RoleInsightsSummary) HasTotalNumberOfEntitlements() bool` + +HasTotalNumberOfEntitlements returns a boolean if a field has been set. + +### GetIdentitiesWithAccessViaRoles + +`func (o *RoleInsightsSummary) GetIdentitiesWithAccessViaRoles() int32` + +GetIdentitiesWithAccessViaRoles returns the IdentitiesWithAccessViaRoles field if non-nil, zero value otherwise. + +### GetIdentitiesWithAccessViaRolesOk + +`func (o *RoleInsightsSummary) GetIdentitiesWithAccessViaRolesOk() (*int32, bool)` + +GetIdentitiesWithAccessViaRolesOk returns a tuple with the IdentitiesWithAccessViaRoles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesWithAccessViaRoles + +`func (o *RoleInsightsSummary) SetIdentitiesWithAccessViaRoles(v int32)` + +SetIdentitiesWithAccessViaRoles sets IdentitiesWithAccessViaRoles field to given value. + +### HasIdentitiesWithAccessViaRoles + +`func (o *RoleInsightsSummary) HasIdentitiesWithAccessViaRoles() bool` + +HasIdentitiesWithAccessViaRoles returns a boolean if a field has been set. + +### GetTotalNumberOfIdentities + +`func (o *RoleInsightsSummary) GetTotalNumberOfIdentities() int32` + +GetTotalNumberOfIdentities returns the TotalNumberOfIdentities field if non-nil, zero value otherwise. + +### GetTotalNumberOfIdentitiesOk + +`func (o *RoleInsightsSummary) GetTotalNumberOfIdentitiesOk() (*int32, bool)` + +GetTotalNumberOfIdentitiesOk returns a tuple with the TotalNumberOfIdentities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalNumberOfIdentities + +`func (o *RoleInsightsSummary) SetTotalNumberOfIdentities(v int32)` + +SetTotalNumberOfIdentities sets TotalNumberOfIdentities field to given value. + +### HasTotalNumberOfIdentities + +`func (o *RoleInsightsSummary) HasTotalNumberOfIdentities() bool` + +HasTotalNumberOfIdentities returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleListFilterDTO.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleListFilterDTO.md new file mode 100644 index 000000000..1702b2752 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleListFilterDTO.md @@ -0,0 +1,110 @@ +--- +id: v2025-role-list-filter-dto +title: RoleListFilterDTO +pagination_label: RoleListFilterDTO +sidebar_label: RoleListFilterDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleListFilterDTO', 'V2025RoleListFilterDTO'] +slug: /tools/sdk/go/v2025/models/role-list-filter-dto +tags: ['SDK', 'Software Development Kit', 'RoleListFilterDTO', 'V2025RoleListFilterDTO'] +--- + +# RoleListFilterDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Filters** | Pointer to **NullableString** | 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* | [optional] +**AmmKeyValues** | Pointer to [**[]RoleListFilterDTOAmmKeyValuesInner**](role-list-filter-dto-amm-key-values-inner) | | [optional] + +## Methods + +### NewRoleListFilterDTO + +`func NewRoleListFilterDTO() *RoleListFilterDTO` + +NewRoleListFilterDTO instantiates a new RoleListFilterDTO 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 + +### NewRoleListFilterDTOWithDefaults + +`func NewRoleListFilterDTOWithDefaults() *RoleListFilterDTO` + +NewRoleListFilterDTOWithDefaults instantiates a new RoleListFilterDTO 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 + +### GetFilters + +`func (o *RoleListFilterDTO) GetFilters() string` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *RoleListFilterDTO) GetFiltersOk() (*string, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *RoleListFilterDTO) SetFilters(v string)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *RoleListFilterDTO) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### SetFiltersNil + +`func (o *RoleListFilterDTO) SetFiltersNil(b bool)` + + SetFiltersNil sets the value for Filters to be an explicit nil + +### UnsetFilters +`func (o *RoleListFilterDTO) UnsetFilters()` + +UnsetFilters ensures that no value is present for Filters, not even an explicit nil +### GetAmmKeyValues + +`func (o *RoleListFilterDTO) GetAmmKeyValues() []RoleListFilterDTOAmmKeyValuesInner` + +GetAmmKeyValues returns the AmmKeyValues field if non-nil, zero value otherwise. + +### GetAmmKeyValuesOk + +`func (o *RoleListFilterDTO) GetAmmKeyValuesOk() (*[]RoleListFilterDTOAmmKeyValuesInner, bool)` + +GetAmmKeyValuesOk returns a tuple with the AmmKeyValues field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAmmKeyValues + +`func (o *RoleListFilterDTO) SetAmmKeyValues(v []RoleListFilterDTOAmmKeyValuesInner)` + +SetAmmKeyValues sets AmmKeyValues field to given value. + +### HasAmmKeyValues + +`func (o *RoleListFilterDTO) HasAmmKeyValues() bool` + +HasAmmKeyValues returns a boolean if a field has been set. + +### SetAmmKeyValuesNil + +`func (o *RoleListFilterDTO) SetAmmKeyValuesNil(b bool)` + + SetAmmKeyValuesNil sets the value for AmmKeyValues to be an explicit nil + +### UnsetAmmKeyValues +`func (o *RoleListFilterDTO) UnsetAmmKeyValues()` + +UnsetAmmKeyValues ensures that no value is present for AmmKeyValues, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleListFilterDTOAmmKeyValuesInner.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleListFilterDTOAmmKeyValuesInner.md new file mode 100644 index 000000000..2937fc6a0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleListFilterDTOAmmKeyValuesInner.md @@ -0,0 +1,90 @@ +--- +id: v2025-role-list-filter-dto-amm-key-values-inner +title: RoleListFilterDTOAmmKeyValuesInner +pagination_label: RoleListFilterDTOAmmKeyValuesInner +sidebar_label: RoleListFilterDTOAmmKeyValuesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleListFilterDTOAmmKeyValuesInner', 'V2025RoleListFilterDTOAmmKeyValuesInner'] +slug: /tools/sdk/go/v2025/models/role-list-filter-dto-amm-key-values-inner +tags: ['SDK', 'Software Development Kit', 'RoleListFilterDTOAmmKeyValuesInner', 'V2025RoleListFilterDTOAmmKeyValuesInner'] +--- + +# RoleListFilterDTOAmmKeyValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | Pointer to **string** | attribute key of a metadata. | [optional] +**Values** | Pointer to **[]string** | A list of attribute key names to filter roles. If the values is empty, will only filter by attribute key. | [optional] + +## Methods + +### NewRoleListFilterDTOAmmKeyValuesInner + +`func NewRoleListFilterDTOAmmKeyValuesInner() *RoleListFilterDTOAmmKeyValuesInner` + +NewRoleListFilterDTOAmmKeyValuesInner instantiates a new RoleListFilterDTOAmmKeyValuesInner 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 + +### NewRoleListFilterDTOAmmKeyValuesInnerWithDefaults + +`func NewRoleListFilterDTOAmmKeyValuesInnerWithDefaults() *RoleListFilterDTOAmmKeyValuesInner` + +NewRoleListFilterDTOAmmKeyValuesInnerWithDefaults instantiates a new RoleListFilterDTOAmmKeyValuesInner 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 + +### GetAttribute + +`func (o *RoleListFilterDTOAmmKeyValuesInner) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleListFilterDTOAmmKeyValuesInner) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleListFilterDTOAmmKeyValuesInner) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleListFilterDTOAmmKeyValuesInner) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValues + +`func (o *RoleListFilterDTOAmmKeyValuesInner) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *RoleListFilterDTOAmmKeyValuesInner) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *RoleListFilterDTOAmmKeyValuesInner) SetValues(v []string)` + +SetValues sets Values field to given value. + +### HasValues + +`func (o *RoleListFilterDTOAmmKeyValuesInner) HasValues() bool` + +HasValues returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMatchDto.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMatchDto.md new file mode 100644 index 000000000..ea8615449 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMatchDto.md @@ -0,0 +1,90 @@ +--- +id: v2025-role-match-dto +title: RoleMatchDto +pagination_label: RoleMatchDto +sidebar_label: RoleMatchDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMatchDto', 'V2025RoleMatchDto'] +slug: /tools/sdk/go/v2025/models/role-match-dto +tags: ['SDK', 'Software Development Kit', 'RoleMatchDto', 'V2025RoleMatchDto'] +--- + +# RoleMatchDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleRef** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] +**MatchedAttributes** | Pointer to [**[]ContextAttributeDto**](context-attribute-dto) | | [optional] + +## Methods + +### NewRoleMatchDto + +`func NewRoleMatchDto() *RoleMatchDto` + +NewRoleMatchDto instantiates a new RoleMatchDto 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 + +### NewRoleMatchDtoWithDefaults + +`func NewRoleMatchDtoWithDefaults() *RoleMatchDto` + +NewRoleMatchDtoWithDefaults instantiates a new RoleMatchDto 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 + +### GetRoleRef + +`func (o *RoleMatchDto) GetRoleRef() BaseReferenceDto` + +GetRoleRef returns the RoleRef field if non-nil, zero value otherwise. + +### GetRoleRefOk + +`func (o *RoleMatchDto) GetRoleRefOk() (*BaseReferenceDto, bool)` + +GetRoleRefOk returns a tuple with the RoleRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleRef + +`func (o *RoleMatchDto) SetRoleRef(v BaseReferenceDto)` + +SetRoleRef sets RoleRef field to given value. + +### HasRoleRef + +`func (o *RoleMatchDto) HasRoleRef() bool` + +HasRoleRef returns a boolean if a field has been set. + +### GetMatchedAttributes + +`func (o *RoleMatchDto) GetMatchedAttributes() []ContextAttributeDto` + +GetMatchedAttributes returns the MatchedAttributes field if non-nil, zero value otherwise. + +### GetMatchedAttributesOk + +`func (o *RoleMatchDto) GetMatchedAttributesOk() (*[]ContextAttributeDto, bool)` + +GetMatchedAttributesOk returns a tuple with the MatchedAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchedAttributes + +`func (o *RoleMatchDto) SetMatchedAttributes(v []ContextAttributeDto)` + +SetMatchedAttributes sets MatchedAttributes field to given value. + +### HasMatchedAttributes + +`func (o *RoleMatchDto) HasMatchedAttributes() bool` + +HasMatchedAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMembershipIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMembershipIdentity.md new file mode 100644 index 000000000..5011af12f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMembershipIdentity.md @@ -0,0 +1,162 @@ +--- +id: v2025-role-membership-identity +title: RoleMembershipIdentity +pagination_label: RoleMembershipIdentity +sidebar_label: RoleMembershipIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMembershipIdentity', 'V2025RoleMembershipIdentity'] +slug: /tools/sdk/go/v2025/models/role-membership-identity +tags: ['SDK', 'Software Development Kit', 'RoleMembershipIdentity', 'V2025RoleMembershipIdentity'] +--- + +# RoleMembershipIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | Identity id | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the Identity. | [optional] +**AliasName** | Pointer to **NullableString** | User name of the Identity | [optional] + +## Methods + +### NewRoleMembershipIdentity + +`func NewRoleMembershipIdentity() *RoleMembershipIdentity` + +NewRoleMembershipIdentity instantiates a new RoleMembershipIdentity 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 + +### NewRoleMembershipIdentityWithDefaults + +`func NewRoleMembershipIdentityWithDefaults() *RoleMembershipIdentity` + +NewRoleMembershipIdentityWithDefaults instantiates a new RoleMembershipIdentity 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 + +### GetType + +`func (o *RoleMembershipIdentity) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMembershipIdentity) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMembershipIdentity) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMembershipIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RoleMembershipIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMembershipIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMembershipIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMembershipIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMembershipIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMembershipIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMembershipIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMembershipIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RoleMembershipIdentity) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RoleMembershipIdentity) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetAliasName + +`func (o *RoleMembershipIdentity) GetAliasName() string` + +GetAliasName returns the AliasName field if non-nil, zero value otherwise. + +### GetAliasNameOk + +`func (o *RoleMembershipIdentity) GetAliasNameOk() (*string, bool)` + +GetAliasNameOk returns a tuple with the AliasName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAliasName + +`func (o *RoleMembershipIdentity) SetAliasName(v string)` + +SetAliasName sets AliasName field to given value. + +### HasAliasName + +`func (o *RoleMembershipIdentity) HasAliasName() bool` + +HasAliasName returns a boolean if a field has been set. + +### SetAliasNameNil + +`func (o *RoleMembershipIdentity) SetAliasNameNil(b bool)` + + SetAliasNameNil sets the value for AliasName to be an explicit nil + +### UnsetAliasName +`func (o *RoleMembershipIdentity) UnsetAliasName()` + +UnsetAliasName ensures that no value is present for AliasName, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMembershipSelector.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMembershipSelector.md new file mode 100644 index 000000000..692a87363 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMembershipSelector.md @@ -0,0 +1,136 @@ +--- +id: v2025-role-membership-selector +title: RoleMembershipSelector +pagination_label: RoleMembershipSelector +sidebar_label: RoleMembershipSelector +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMembershipSelector', 'V2025RoleMembershipSelector'] +slug: /tools/sdk/go/v2025/models/role-membership-selector +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelector', 'V2025RoleMembershipSelector'] +--- + +# RoleMembershipSelector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**RoleMembershipSelectorType**](role-membership-selector-type) | | [optional] +**Criteria** | Pointer to [**NullableRoleCriteriaLevel1**](role-criteria-level1) | | [optional] +**Identities** | Pointer to [**[]RoleMembershipIdentity**](role-membership-identity) | Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. | [optional] + +## Methods + +### NewRoleMembershipSelector + +`func NewRoleMembershipSelector() *RoleMembershipSelector` + +NewRoleMembershipSelector instantiates a new RoleMembershipSelector 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 + +### NewRoleMembershipSelectorWithDefaults + +`func NewRoleMembershipSelectorWithDefaults() *RoleMembershipSelector` + +NewRoleMembershipSelectorWithDefaults instantiates a new RoleMembershipSelector 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 + +### GetType + +`func (o *RoleMembershipSelector) GetType() RoleMembershipSelectorType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMembershipSelector) GetTypeOk() (*RoleMembershipSelectorType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMembershipSelector) SetType(v RoleMembershipSelectorType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMembershipSelector) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetCriteria + +`func (o *RoleMembershipSelector) GetCriteria() RoleCriteriaLevel1` + +GetCriteria returns the Criteria field if non-nil, zero value otherwise. + +### GetCriteriaOk + +`func (o *RoleMembershipSelector) GetCriteriaOk() (*RoleCriteriaLevel1, bool)` + +GetCriteriaOk returns a tuple with the Criteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteria + +`func (o *RoleMembershipSelector) SetCriteria(v RoleCriteriaLevel1)` + +SetCriteria sets Criteria field to given value. + +### HasCriteria + +`func (o *RoleMembershipSelector) HasCriteria() bool` + +HasCriteria returns a boolean if a field has been set. + +### SetCriteriaNil + +`func (o *RoleMembershipSelector) SetCriteriaNil(b bool)` + + SetCriteriaNil sets the value for Criteria to be an explicit nil + +### UnsetCriteria +`func (o *RoleMembershipSelector) UnsetCriteria()` + +UnsetCriteria ensures that no value is present for Criteria, not even an explicit nil +### GetIdentities + +`func (o *RoleMembershipSelector) GetIdentities() []RoleMembershipIdentity` + +GetIdentities returns the Identities field if non-nil, zero value otherwise. + +### GetIdentitiesOk + +`func (o *RoleMembershipSelector) GetIdentitiesOk() (*[]RoleMembershipIdentity, bool)` + +GetIdentitiesOk returns a tuple with the Identities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentities + +`func (o *RoleMembershipSelector) SetIdentities(v []RoleMembershipIdentity)` + +SetIdentities sets Identities field to given value. + +### HasIdentities + +`func (o *RoleMembershipSelector) HasIdentities() bool` + +HasIdentities returns a boolean if a field has been set. + +### SetIdentitiesNil + +`func (o *RoleMembershipSelector) SetIdentitiesNil(b bool)` + + SetIdentitiesNil sets the value for Identities to be an explicit nil + +### UnsetIdentities +`func (o *RoleMembershipSelector) UnsetIdentities()` + +UnsetIdentities ensures that no value is present for Identities, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMembershipSelectorType.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMembershipSelectorType.md new file mode 100644 index 000000000..0604e9cf6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMembershipSelectorType.md @@ -0,0 +1,21 @@ +--- +id: v2025-role-membership-selector-type +title: RoleMembershipSelectorType +pagination_label: RoleMembershipSelectorType +sidebar_label: RoleMembershipSelectorType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMembershipSelectorType', 'V2025RoleMembershipSelectorType'] +slug: /tools/sdk/go/v2025/models/role-membership-selector-type +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelectorType', 'V2025RoleMembershipSelectorType'] +--- + +# RoleMembershipSelectorType + +## Enum + + +* `STANDARD` (value: `"STANDARD"`) + +* `IDENTITY_LIST` (value: `"IDENTITY_LIST"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByFilterRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByFilterRequest.md new file mode 100644 index 000000000..229b746a0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByFilterRequest.md @@ -0,0 +1,127 @@ +--- +id: v2025-role-metadata-bulk-update-by-filter-request +title: RoleMetadataBulkUpdateByFilterRequest +pagination_label: RoleMetadataBulkUpdateByFilterRequest +sidebar_label: RoleMetadataBulkUpdateByFilterRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMetadataBulkUpdateByFilterRequest', 'V2025RoleMetadataBulkUpdateByFilterRequest'] +slug: /tools/sdk/go/v2025/models/role-metadata-bulk-update-by-filter-request +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByFilterRequest', 'V2025RoleMetadataBulkUpdateByFilterRequest'] +--- + +# RoleMetadataBulkUpdateByFilterRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Filters** | **string** | Filtering is supported for the following fields and operators: **id** : *eq, in* **name** : *eq, sw* **created** : *gt, lt, ge, le* **modified** : *gt, lt, ge, le* **owner.id** : *eq, in* **requestable** : *eq* | +**Operation** | **string** | The operation to be performed | +**ReplaceScope** | Pointer to **string** | The choice of update scope. | [optional] +**Values** | [**[]RoleMetadataBulkUpdateByFilterRequestValuesInner**](role-metadata-bulk-update-by-filter-request-values-inner) | The metadata to be updated, including attribute key and value. | + +## Methods + +### NewRoleMetadataBulkUpdateByFilterRequest + +`func NewRoleMetadataBulkUpdateByFilterRequest(filters string, operation string, values []RoleMetadataBulkUpdateByFilterRequestValuesInner, ) *RoleMetadataBulkUpdateByFilterRequest` + +NewRoleMetadataBulkUpdateByFilterRequest instantiates a new RoleMetadataBulkUpdateByFilterRequest 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 + +### NewRoleMetadataBulkUpdateByFilterRequestWithDefaults + +`func NewRoleMetadataBulkUpdateByFilterRequestWithDefaults() *RoleMetadataBulkUpdateByFilterRequest` + +NewRoleMetadataBulkUpdateByFilterRequestWithDefaults instantiates a new RoleMetadataBulkUpdateByFilterRequest 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 + +### GetFilters + +`func (o *RoleMetadataBulkUpdateByFilterRequest) GetFilters() string` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *RoleMetadataBulkUpdateByFilterRequest) GetFiltersOk() (*string, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *RoleMetadataBulkUpdateByFilterRequest) SetFilters(v string)` + +SetFilters sets Filters field to given value. + + +### GetOperation + +`func (o *RoleMetadataBulkUpdateByFilterRequest) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleMetadataBulkUpdateByFilterRequest) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleMetadataBulkUpdateByFilterRequest) SetOperation(v string)` + +SetOperation sets Operation field to given value. + + +### GetReplaceScope + +`func (o *RoleMetadataBulkUpdateByFilterRequest) GetReplaceScope() string` + +GetReplaceScope returns the ReplaceScope field if non-nil, zero value otherwise. + +### GetReplaceScopeOk + +`func (o *RoleMetadataBulkUpdateByFilterRequest) GetReplaceScopeOk() (*string, bool)` + +GetReplaceScopeOk returns a tuple with the ReplaceScope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplaceScope + +`func (o *RoleMetadataBulkUpdateByFilterRequest) SetReplaceScope(v string)` + +SetReplaceScope sets ReplaceScope field to given value. + +### HasReplaceScope + +`func (o *RoleMetadataBulkUpdateByFilterRequest) HasReplaceScope() bool` + +HasReplaceScope returns a boolean if a field has been set. + +### GetValues + +`func (o *RoleMetadataBulkUpdateByFilterRequest) GetValues() []RoleMetadataBulkUpdateByFilterRequestValuesInner` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *RoleMetadataBulkUpdateByFilterRequest) GetValuesOk() (*[]RoleMetadataBulkUpdateByFilterRequestValuesInner, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *RoleMetadataBulkUpdateByFilterRequest) SetValues(v []RoleMetadataBulkUpdateByFilterRequestValuesInner)` + +SetValues sets Values field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByFilterRequestValuesInner.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByFilterRequestValuesInner.md new file mode 100644 index 000000000..d71fa89c6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByFilterRequestValuesInner.md @@ -0,0 +1,95 @@ +--- +id: v2025-role-metadata-bulk-update-by-filter-request-values-inner +title: RoleMetadataBulkUpdateByFilterRequestValuesInner +pagination_label: RoleMetadataBulkUpdateByFilterRequestValuesInner +sidebar_label: RoleMetadataBulkUpdateByFilterRequestValuesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMetadataBulkUpdateByFilterRequestValuesInner', 'V2025RoleMetadataBulkUpdateByFilterRequestValuesInner'] +slug: /tools/sdk/go/v2025/models/role-metadata-bulk-update-by-filter-request-values-inner +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByFilterRequestValuesInner', 'V2025RoleMetadataBulkUpdateByFilterRequestValuesInner'] +--- + +# RoleMetadataBulkUpdateByFilterRequestValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeKey** | Pointer to **string** | the key of metadata attribute | [optional] +**Values** | **[]string** | the values of attribute to be updated | + +## Methods + +### NewRoleMetadataBulkUpdateByFilterRequestValuesInner + +`func NewRoleMetadataBulkUpdateByFilterRequestValuesInner(values []string, ) *RoleMetadataBulkUpdateByFilterRequestValuesInner` + +NewRoleMetadataBulkUpdateByFilterRequestValuesInner instantiates a new RoleMetadataBulkUpdateByFilterRequestValuesInner 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 + +### NewRoleMetadataBulkUpdateByFilterRequestValuesInnerWithDefaults + +`func NewRoleMetadataBulkUpdateByFilterRequestValuesInnerWithDefaults() *RoleMetadataBulkUpdateByFilterRequestValuesInner` + +NewRoleMetadataBulkUpdateByFilterRequestValuesInnerWithDefaults instantiates a new RoleMetadataBulkUpdateByFilterRequestValuesInner 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 + +### GetAttributeKey + +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) GetAttributeKey() string` + +GetAttributeKey returns the AttributeKey field if non-nil, zero value otherwise. + +### GetAttributeKeyOk + +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) GetAttributeKeyOk() (*string, bool)` + +GetAttributeKeyOk returns a tuple with the AttributeKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeKey + +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) SetAttributeKey(v string)` + +SetAttributeKey sets AttributeKey field to given value. + +### HasAttributeKey + +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) HasAttributeKey() bool` + +HasAttributeKey returns a boolean if a field has been set. + +### GetValues + +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### SetValuesNil + +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) SetValuesNil(b bool)` + + SetValuesNil sets the value for Values to be an explicit nil + +### UnsetValues +`func (o *RoleMetadataBulkUpdateByFilterRequestValuesInner) UnsetValues()` + +UnsetValues ensures that no value is present for Values, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByIdRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByIdRequest.md new file mode 100644 index 000000000..33a8f2647 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByIdRequest.md @@ -0,0 +1,127 @@ +--- +id: v2025-role-metadata-bulk-update-by-id-request +title: RoleMetadataBulkUpdateByIdRequest +pagination_label: RoleMetadataBulkUpdateByIdRequest +sidebar_label: RoleMetadataBulkUpdateByIdRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMetadataBulkUpdateByIdRequest', 'V2025RoleMetadataBulkUpdateByIdRequest'] +slug: /tools/sdk/go/v2025/models/role-metadata-bulk-update-by-id-request +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByIdRequest', 'V2025RoleMetadataBulkUpdateByIdRequest'] +--- + +# RoleMetadataBulkUpdateByIdRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Roles** | **[]string** | Roles' Id to be updated | +**Operation** | **string** | The operation to be performed | +**ReplaceScope** | Pointer to **string** | The choice of update scope. | [optional] +**Values** | [**[]RoleMetadataBulkUpdateByIdRequestValuesInner**](role-metadata-bulk-update-by-id-request-values-inner) | The metadata to be updated, including attribute key and value. | + +## Methods + +### NewRoleMetadataBulkUpdateByIdRequest + +`func NewRoleMetadataBulkUpdateByIdRequest(roles []string, operation string, values []RoleMetadataBulkUpdateByIdRequestValuesInner, ) *RoleMetadataBulkUpdateByIdRequest` + +NewRoleMetadataBulkUpdateByIdRequest instantiates a new RoleMetadataBulkUpdateByIdRequest 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 + +### NewRoleMetadataBulkUpdateByIdRequestWithDefaults + +`func NewRoleMetadataBulkUpdateByIdRequestWithDefaults() *RoleMetadataBulkUpdateByIdRequest` + +NewRoleMetadataBulkUpdateByIdRequestWithDefaults instantiates a new RoleMetadataBulkUpdateByIdRequest 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 + +### GetRoles + +`func (o *RoleMetadataBulkUpdateByIdRequest) GetRoles() []string` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *RoleMetadataBulkUpdateByIdRequest) GetRolesOk() (*[]string, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *RoleMetadataBulkUpdateByIdRequest) SetRoles(v []string)` + +SetRoles sets Roles field to given value. + + +### GetOperation + +`func (o *RoleMetadataBulkUpdateByIdRequest) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleMetadataBulkUpdateByIdRequest) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleMetadataBulkUpdateByIdRequest) SetOperation(v string)` + +SetOperation sets Operation field to given value. + + +### GetReplaceScope + +`func (o *RoleMetadataBulkUpdateByIdRequest) GetReplaceScope() string` + +GetReplaceScope returns the ReplaceScope field if non-nil, zero value otherwise. + +### GetReplaceScopeOk + +`func (o *RoleMetadataBulkUpdateByIdRequest) GetReplaceScopeOk() (*string, bool)` + +GetReplaceScopeOk returns a tuple with the ReplaceScope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplaceScope + +`func (o *RoleMetadataBulkUpdateByIdRequest) SetReplaceScope(v string)` + +SetReplaceScope sets ReplaceScope field to given value. + +### HasReplaceScope + +`func (o *RoleMetadataBulkUpdateByIdRequest) HasReplaceScope() bool` + +HasReplaceScope returns a boolean if a field has been set. + +### GetValues + +`func (o *RoleMetadataBulkUpdateByIdRequest) GetValues() []RoleMetadataBulkUpdateByIdRequestValuesInner` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *RoleMetadataBulkUpdateByIdRequest) GetValuesOk() (*[]RoleMetadataBulkUpdateByIdRequestValuesInner, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *RoleMetadataBulkUpdateByIdRequest) SetValues(v []RoleMetadataBulkUpdateByIdRequestValuesInner)` + +SetValues sets Values field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByIdRequestValuesInner.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByIdRequestValuesInner.md new file mode 100644 index 000000000..756eb4ba6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByIdRequestValuesInner.md @@ -0,0 +1,90 @@ +--- +id: v2025-role-metadata-bulk-update-by-id-request-values-inner +title: RoleMetadataBulkUpdateByIdRequestValuesInner +pagination_label: RoleMetadataBulkUpdateByIdRequestValuesInner +sidebar_label: RoleMetadataBulkUpdateByIdRequestValuesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMetadataBulkUpdateByIdRequestValuesInner', 'V2025RoleMetadataBulkUpdateByIdRequestValuesInner'] +slug: /tools/sdk/go/v2025/models/role-metadata-bulk-update-by-id-request-values-inner +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByIdRequestValuesInner', 'V2025RoleMetadataBulkUpdateByIdRequestValuesInner'] +--- + +# RoleMetadataBulkUpdateByIdRequestValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | **string** | the key of metadata attribute | +**Values** | **[]string** | the values of attribute to be updated | + +## Methods + +### NewRoleMetadataBulkUpdateByIdRequestValuesInner + +`func NewRoleMetadataBulkUpdateByIdRequestValuesInner(attribute string, values []string, ) *RoleMetadataBulkUpdateByIdRequestValuesInner` + +NewRoleMetadataBulkUpdateByIdRequestValuesInner instantiates a new RoleMetadataBulkUpdateByIdRequestValuesInner 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 + +### NewRoleMetadataBulkUpdateByIdRequestValuesInnerWithDefaults + +`func NewRoleMetadataBulkUpdateByIdRequestValuesInnerWithDefaults() *RoleMetadataBulkUpdateByIdRequestValuesInner` + +NewRoleMetadataBulkUpdateByIdRequestValuesInnerWithDefaults instantiates a new RoleMetadataBulkUpdateByIdRequestValuesInner 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 + +### GetAttribute + +`func (o *RoleMetadataBulkUpdateByIdRequestValuesInner) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleMetadataBulkUpdateByIdRequestValuesInner) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleMetadataBulkUpdateByIdRequestValuesInner) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + + +### GetValues + +`func (o *RoleMetadataBulkUpdateByIdRequestValuesInner) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *RoleMetadataBulkUpdateByIdRequestValuesInner) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *RoleMetadataBulkUpdateByIdRequestValuesInner) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### SetValuesNil + +`func (o *RoleMetadataBulkUpdateByIdRequestValuesInner) SetValuesNil(b bool)` + + SetValuesNil sets the value for Values to be an explicit nil + +### UnsetValues +`func (o *RoleMetadataBulkUpdateByIdRequestValuesInner) UnsetValues()` + +UnsetValues ensures that no value is present for Values, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByQueryRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByQueryRequest.md new file mode 100644 index 000000000..8c05ad7c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByQueryRequest.md @@ -0,0 +1,127 @@ +--- +id: v2025-role-metadata-bulk-update-by-query-request +title: RoleMetadataBulkUpdateByQueryRequest +pagination_label: RoleMetadataBulkUpdateByQueryRequest +sidebar_label: RoleMetadataBulkUpdateByQueryRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMetadataBulkUpdateByQueryRequest', 'V2025RoleMetadataBulkUpdateByQueryRequest'] +slug: /tools/sdk/go/v2025/models/role-metadata-bulk-update-by-query-request +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByQueryRequest', 'V2025RoleMetadataBulkUpdateByQueryRequest'] +--- + +# RoleMetadataBulkUpdateByQueryRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **map[string]interface{}** | query the identities to be updated | +**Operation** | **string** | The operation to be performed | +**ReplaceScope** | Pointer to **string** | The choice of update scope. | [optional] +**Values** | [**[]RoleMetadataBulkUpdateByQueryRequestValuesInner**](role-metadata-bulk-update-by-query-request-values-inner) | The metadata to be updated, including attribute key and value. | + +## Methods + +### NewRoleMetadataBulkUpdateByQueryRequest + +`func NewRoleMetadataBulkUpdateByQueryRequest(query map[string]interface{}, operation string, values []RoleMetadataBulkUpdateByQueryRequestValuesInner, ) *RoleMetadataBulkUpdateByQueryRequest` + +NewRoleMetadataBulkUpdateByQueryRequest instantiates a new RoleMetadataBulkUpdateByQueryRequest 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 + +### NewRoleMetadataBulkUpdateByQueryRequestWithDefaults + +`func NewRoleMetadataBulkUpdateByQueryRequestWithDefaults() *RoleMetadataBulkUpdateByQueryRequest` + +NewRoleMetadataBulkUpdateByQueryRequestWithDefaults instantiates a new RoleMetadataBulkUpdateByQueryRequest 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 + +### GetQuery + +`func (o *RoleMetadataBulkUpdateByQueryRequest) GetQuery() map[string]interface{}` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *RoleMetadataBulkUpdateByQueryRequest) GetQueryOk() (*map[string]interface{}, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *RoleMetadataBulkUpdateByQueryRequest) SetQuery(v map[string]interface{})` + +SetQuery sets Query field to given value. + + +### GetOperation + +`func (o *RoleMetadataBulkUpdateByQueryRequest) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleMetadataBulkUpdateByQueryRequest) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleMetadataBulkUpdateByQueryRequest) SetOperation(v string)` + +SetOperation sets Operation field to given value. + + +### GetReplaceScope + +`func (o *RoleMetadataBulkUpdateByQueryRequest) GetReplaceScope() string` + +GetReplaceScope returns the ReplaceScope field if non-nil, zero value otherwise. + +### GetReplaceScopeOk + +`func (o *RoleMetadataBulkUpdateByQueryRequest) GetReplaceScopeOk() (*string, bool)` + +GetReplaceScopeOk returns a tuple with the ReplaceScope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplaceScope + +`func (o *RoleMetadataBulkUpdateByQueryRequest) SetReplaceScope(v string)` + +SetReplaceScope sets ReplaceScope field to given value. + +### HasReplaceScope + +`func (o *RoleMetadataBulkUpdateByQueryRequest) HasReplaceScope() bool` + +HasReplaceScope returns a boolean if a field has been set. + +### GetValues + +`func (o *RoleMetadataBulkUpdateByQueryRequest) GetValues() []RoleMetadataBulkUpdateByQueryRequestValuesInner` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *RoleMetadataBulkUpdateByQueryRequest) GetValuesOk() (*[]RoleMetadataBulkUpdateByQueryRequestValuesInner, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *RoleMetadataBulkUpdateByQueryRequest) SetValues(v []RoleMetadataBulkUpdateByQueryRequestValuesInner)` + +SetValues sets Values field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByQueryRequestValuesInner.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByQueryRequestValuesInner.md new file mode 100644 index 000000000..ad62eb195 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMetadataBulkUpdateByQueryRequestValuesInner.md @@ -0,0 +1,90 @@ +--- +id: v2025-role-metadata-bulk-update-by-query-request-values-inner +title: RoleMetadataBulkUpdateByQueryRequestValuesInner +pagination_label: RoleMetadataBulkUpdateByQueryRequestValuesInner +sidebar_label: RoleMetadataBulkUpdateByQueryRequestValuesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMetadataBulkUpdateByQueryRequestValuesInner', 'V2025RoleMetadataBulkUpdateByQueryRequestValuesInner'] +slug: /tools/sdk/go/v2025/models/role-metadata-bulk-update-by-query-request-values-inner +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByQueryRequestValuesInner', 'V2025RoleMetadataBulkUpdateByQueryRequestValuesInner'] +--- + +# RoleMetadataBulkUpdateByQueryRequestValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeKey** | Pointer to **string** | the key of metadata attribute | [optional] +**AttributeValue** | Pointer to **[]string** | the values of attribute to be updated | [optional] + +## Methods + +### NewRoleMetadataBulkUpdateByQueryRequestValuesInner + +`func NewRoleMetadataBulkUpdateByQueryRequestValuesInner() *RoleMetadataBulkUpdateByQueryRequestValuesInner` + +NewRoleMetadataBulkUpdateByQueryRequestValuesInner instantiates a new RoleMetadataBulkUpdateByQueryRequestValuesInner 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 + +### NewRoleMetadataBulkUpdateByQueryRequestValuesInnerWithDefaults + +`func NewRoleMetadataBulkUpdateByQueryRequestValuesInnerWithDefaults() *RoleMetadataBulkUpdateByQueryRequestValuesInner` + +NewRoleMetadataBulkUpdateByQueryRequestValuesInnerWithDefaults instantiates a new RoleMetadataBulkUpdateByQueryRequestValuesInner 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 + +### GetAttributeKey + +`func (o *RoleMetadataBulkUpdateByQueryRequestValuesInner) GetAttributeKey() string` + +GetAttributeKey returns the AttributeKey field if non-nil, zero value otherwise. + +### GetAttributeKeyOk + +`func (o *RoleMetadataBulkUpdateByQueryRequestValuesInner) GetAttributeKeyOk() (*string, bool)` + +GetAttributeKeyOk returns a tuple with the AttributeKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeKey + +`func (o *RoleMetadataBulkUpdateByQueryRequestValuesInner) SetAttributeKey(v string)` + +SetAttributeKey sets AttributeKey field to given value. + +### HasAttributeKey + +`func (o *RoleMetadataBulkUpdateByQueryRequestValuesInner) HasAttributeKey() bool` + +HasAttributeKey returns a boolean if a field has been set. + +### GetAttributeValue + +`func (o *RoleMetadataBulkUpdateByQueryRequestValuesInner) GetAttributeValue() []string` + +GetAttributeValue returns the AttributeValue field if non-nil, zero value otherwise. + +### GetAttributeValueOk + +`func (o *RoleMetadataBulkUpdateByQueryRequestValuesInner) GetAttributeValueOk() (*[]string, bool)` + +GetAttributeValueOk returns a tuple with the AttributeValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeValue + +`func (o *RoleMetadataBulkUpdateByQueryRequestValuesInner) SetAttributeValue(v []string)` + +SetAttributeValue sets AttributeValue field to given value. + +### HasAttributeValue + +`func (o *RoleMetadataBulkUpdateByQueryRequestValuesInner) HasAttributeValue() bool` + +HasAttributeValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningEntitlement.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningEntitlement.md new file mode 100644 index 000000000..eb7b07c93 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningEntitlement.md @@ -0,0 +1,292 @@ +--- +id: v2025-role-mining-entitlement +title: RoleMiningEntitlement +pagination_label: RoleMiningEntitlement +sidebar_label: RoleMiningEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningEntitlement', 'V2025RoleMiningEntitlement'] +slug: /tools/sdk/go/v2025/models/role-mining-entitlement +tags: ['SDK', 'Software Development Kit', 'RoleMiningEntitlement', 'V2025RoleMiningEntitlement'] +--- + +# RoleMiningEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EntitlementRef** | Pointer to [**RoleMiningEntitlementRef**](role-mining-entitlement-ref) | | [optional] +**Name** | Pointer to **string** | Name of the entitlement | [optional] +**ApplicationName** | Pointer to **string** | Application name of the entitlement | [optional] +**IdentityCount** | Pointer to **int32** | The number of identities with this entitlement in a role. | [optional] +**Popularity** | Pointer to **float32** | The % popularity of this entitlement in a role. | [optional] +**PopularityInOrg** | Pointer to **float32** | The % popularity of this entitlement in the org. | [optional] +**SourceId** | Pointer to **string** | The ID of the source/application. | [optional] +**ActivitySourceState** | Pointer to **NullableString** | The status of activity data for the source. Value is complete or notComplete. | [optional] +**SourceUsagePercent** | Pointer to **NullableFloat32** | The percentage of identities in the potential role that have usage of the source/application of this entitlement. | [optional] + +## Methods + +### NewRoleMiningEntitlement + +`func NewRoleMiningEntitlement() *RoleMiningEntitlement` + +NewRoleMiningEntitlement instantiates a new RoleMiningEntitlement 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 + +### NewRoleMiningEntitlementWithDefaults + +`func NewRoleMiningEntitlementWithDefaults() *RoleMiningEntitlement` + +NewRoleMiningEntitlementWithDefaults instantiates a new RoleMiningEntitlement 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 + +### GetEntitlementRef + +`func (o *RoleMiningEntitlement) GetEntitlementRef() RoleMiningEntitlementRef` + +GetEntitlementRef returns the EntitlementRef field if non-nil, zero value otherwise. + +### GetEntitlementRefOk + +`func (o *RoleMiningEntitlement) GetEntitlementRefOk() (*RoleMiningEntitlementRef, bool)` + +GetEntitlementRefOk returns a tuple with the EntitlementRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementRef + +`func (o *RoleMiningEntitlement) SetEntitlementRef(v RoleMiningEntitlementRef)` + +SetEntitlementRef sets EntitlementRef field to given value. + +### HasEntitlementRef + +`func (o *RoleMiningEntitlement) HasEntitlementRef() bool` + +HasEntitlementRef returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningEntitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningEntitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningEntitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningEntitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetApplicationName + +`func (o *RoleMiningEntitlement) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *RoleMiningEntitlement) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *RoleMiningEntitlement) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *RoleMiningEntitlement) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *RoleMiningEntitlement) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *RoleMiningEntitlement) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *RoleMiningEntitlement) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *RoleMiningEntitlement) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetPopularity + +`func (o *RoleMiningEntitlement) GetPopularity() float32` + +GetPopularity returns the Popularity field if non-nil, zero value otherwise. + +### GetPopularityOk + +`func (o *RoleMiningEntitlement) GetPopularityOk() (*float32, bool)` + +GetPopularityOk returns a tuple with the Popularity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPopularity + +`func (o *RoleMiningEntitlement) SetPopularity(v float32)` + +SetPopularity sets Popularity field to given value. + +### HasPopularity + +`func (o *RoleMiningEntitlement) HasPopularity() bool` + +HasPopularity returns a boolean if a field has been set. + +### GetPopularityInOrg + +`func (o *RoleMiningEntitlement) GetPopularityInOrg() float32` + +GetPopularityInOrg returns the PopularityInOrg field if non-nil, zero value otherwise. + +### GetPopularityInOrgOk + +`func (o *RoleMiningEntitlement) GetPopularityInOrgOk() (*float32, bool)` + +GetPopularityInOrgOk returns a tuple with the PopularityInOrg field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPopularityInOrg + +`func (o *RoleMiningEntitlement) SetPopularityInOrg(v float32)` + +SetPopularityInOrg sets PopularityInOrg field to given value. + +### HasPopularityInOrg + +`func (o *RoleMiningEntitlement) HasPopularityInOrg() bool` + +HasPopularityInOrg returns a boolean if a field has been set. + +### GetSourceId + +`func (o *RoleMiningEntitlement) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *RoleMiningEntitlement) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *RoleMiningEntitlement) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *RoleMiningEntitlement) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetActivitySourceState + +`func (o *RoleMiningEntitlement) GetActivitySourceState() string` + +GetActivitySourceState returns the ActivitySourceState field if non-nil, zero value otherwise. + +### GetActivitySourceStateOk + +`func (o *RoleMiningEntitlement) GetActivitySourceStateOk() (*string, bool)` + +GetActivitySourceStateOk returns a tuple with the ActivitySourceState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActivitySourceState + +`func (o *RoleMiningEntitlement) SetActivitySourceState(v string)` + +SetActivitySourceState sets ActivitySourceState field to given value. + +### HasActivitySourceState + +`func (o *RoleMiningEntitlement) HasActivitySourceState() bool` + +HasActivitySourceState returns a boolean if a field has been set. + +### SetActivitySourceStateNil + +`func (o *RoleMiningEntitlement) SetActivitySourceStateNil(b bool)` + + SetActivitySourceStateNil sets the value for ActivitySourceState to be an explicit nil + +### UnsetActivitySourceState +`func (o *RoleMiningEntitlement) UnsetActivitySourceState()` + +UnsetActivitySourceState ensures that no value is present for ActivitySourceState, not even an explicit nil +### GetSourceUsagePercent + +`func (o *RoleMiningEntitlement) GetSourceUsagePercent() float32` + +GetSourceUsagePercent returns the SourceUsagePercent field if non-nil, zero value otherwise. + +### GetSourceUsagePercentOk + +`func (o *RoleMiningEntitlement) GetSourceUsagePercentOk() (*float32, bool)` + +GetSourceUsagePercentOk returns a tuple with the SourceUsagePercent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceUsagePercent + +`func (o *RoleMiningEntitlement) SetSourceUsagePercent(v float32)` + +SetSourceUsagePercent sets SourceUsagePercent field to given value. + +### HasSourceUsagePercent + +`func (o *RoleMiningEntitlement) HasSourceUsagePercent() bool` + +HasSourceUsagePercent returns a boolean if a field has been set. + +### SetSourceUsagePercentNil + +`func (o *RoleMiningEntitlement) SetSourceUsagePercentNil(b bool)` + + SetSourceUsagePercentNil sets the value for SourceUsagePercent to be an explicit nil + +### UnsetSourceUsagePercent +`func (o *RoleMiningEntitlement) UnsetSourceUsagePercent()` + +UnsetSourceUsagePercent ensures that no value is present for SourceUsagePercent, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningEntitlementRef.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningEntitlementRef.md new file mode 100644 index 000000000..c29cccce8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningEntitlementRef.md @@ -0,0 +1,152 @@ +--- +id: v2025-role-mining-entitlement-ref +title: RoleMiningEntitlementRef +pagination_label: RoleMiningEntitlementRef +sidebar_label: RoleMiningEntitlementRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningEntitlementRef', 'V2025RoleMiningEntitlementRef'] +slug: /tools/sdk/go/v2025/models/role-mining-entitlement-ref +tags: ['SDK', 'Software Development Kit', 'RoleMiningEntitlementRef', 'V2025RoleMiningEntitlementRef'] +--- + +# RoleMiningEntitlementRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the entitlement | [optional] +**Name** | Pointer to **string** | Name of the entitlement | [optional] +**Description** | Pointer to **NullableString** | Description forthe entitlement | [optional] +**Attribute** | Pointer to **string** | The entitlement attribute | [optional] + +## Methods + +### NewRoleMiningEntitlementRef + +`func NewRoleMiningEntitlementRef() *RoleMiningEntitlementRef` + +NewRoleMiningEntitlementRef instantiates a new RoleMiningEntitlementRef 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 + +### NewRoleMiningEntitlementRefWithDefaults + +`func NewRoleMiningEntitlementRefWithDefaults() *RoleMiningEntitlementRef` + +NewRoleMiningEntitlementRefWithDefaults instantiates a new RoleMiningEntitlementRef 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 + +### GetId + +`func (o *RoleMiningEntitlementRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningEntitlementRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningEntitlementRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningEntitlementRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningEntitlementRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningEntitlementRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningEntitlementRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningEntitlementRef) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleMiningEntitlementRef) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleMiningEntitlementRef) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleMiningEntitlementRef) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleMiningEntitlementRef) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleMiningEntitlementRef) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleMiningEntitlementRef) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAttribute + +`func (o *RoleMiningEntitlementRef) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleMiningEntitlementRef) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleMiningEntitlementRef) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleMiningEntitlementRef) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningIdentity.md new file mode 100644 index 000000000..11b6e8a71 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningIdentity.md @@ -0,0 +1,116 @@ +--- +id: v2025-role-mining-identity +title: RoleMiningIdentity +pagination_label: RoleMiningIdentity +sidebar_label: RoleMiningIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningIdentity', 'V2025RoleMiningIdentity'] +slug: /tools/sdk/go/v2025/models/role-mining-identity +tags: ['SDK', 'Software Development Kit', 'RoleMiningIdentity', 'V2025RoleMiningIdentity'] +--- + +# RoleMiningIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the identity | [optional] +**Name** | Pointer to **string** | Name of the identity | [optional] +**Attributes** | Pointer to **map[string]string** | | [optional] + +## Methods + +### NewRoleMiningIdentity + +`func NewRoleMiningIdentity() *RoleMiningIdentity` + +NewRoleMiningIdentity instantiates a new RoleMiningIdentity 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 + +### NewRoleMiningIdentityWithDefaults + +`func NewRoleMiningIdentityWithDefaults() *RoleMiningIdentity` + +NewRoleMiningIdentityWithDefaults instantiates a new RoleMiningIdentity 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 + +### GetId + +`func (o *RoleMiningIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAttributes + +`func (o *RoleMiningIdentity) GetAttributes() map[string]string` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *RoleMiningIdentity) GetAttributesOk() (*map[string]string, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *RoleMiningIdentity) SetAttributes(v map[string]string)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *RoleMiningIdentity) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningIdentityDistribution.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningIdentityDistribution.md new file mode 100644 index 000000000..0a0feb197 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningIdentityDistribution.md @@ -0,0 +1,90 @@ +--- +id: v2025-role-mining-identity-distribution +title: RoleMiningIdentityDistribution +pagination_label: RoleMiningIdentityDistribution +sidebar_label: RoleMiningIdentityDistribution +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningIdentityDistribution', 'V2025RoleMiningIdentityDistribution'] +slug: /tools/sdk/go/v2025/models/role-mining-identity-distribution +tags: ['SDK', 'Software Development Kit', 'RoleMiningIdentityDistribution', 'V2025RoleMiningIdentityDistribution'] +--- + +# RoleMiningIdentityDistribution + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeName** | Pointer to **string** | Id of the potential role | [optional] +**Distribution** | Pointer to **[]map[string]interface{}** | | [optional] + +## Methods + +### NewRoleMiningIdentityDistribution + +`func NewRoleMiningIdentityDistribution() *RoleMiningIdentityDistribution` + +NewRoleMiningIdentityDistribution instantiates a new RoleMiningIdentityDistribution 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 + +### NewRoleMiningIdentityDistributionWithDefaults + +`func NewRoleMiningIdentityDistributionWithDefaults() *RoleMiningIdentityDistribution` + +NewRoleMiningIdentityDistributionWithDefaults instantiates a new RoleMiningIdentityDistribution 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 + +### GetAttributeName + +`func (o *RoleMiningIdentityDistribution) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *RoleMiningIdentityDistribution) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *RoleMiningIdentityDistribution) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *RoleMiningIdentityDistribution) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + +### GetDistribution + +`func (o *RoleMiningIdentityDistribution) GetDistribution() []map[string]interface{}` + +GetDistribution returns the Distribution field if non-nil, zero value otherwise. + +### GetDistributionOk + +`func (o *RoleMiningIdentityDistribution) GetDistributionOk() (*[]map[string]interface{}, bool)` + +GetDistributionOk returns a tuple with the Distribution field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDistribution + +`func (o *RoleMiningIdentityDistribution) SetDistribution(v []map[string]interface{})` + +SetDistribution sets Distribution field to given value. + +### HasDistribution + +`func (o *RoleMiningIdentityDistribution) HasDistribution() bool` + +HasDistribution returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRole.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRole.md new file mode 100644 index 000000000..ffda75b1b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRole.md @@ -0,0 +1,572 @@ +--- +id: v2025-role-mining-potential-role +title: RoleMiningPotentialRole +pagination_label: RoleMiningPotentialRole +sidebar_label: RoleMiningPotentialRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRole', 'V2025RoleMiningPotentialRole'] +slug: /tools/sdk/go/v2025/models/role-mining-potential-role +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRole', 'V2025RoleMiningPotentialRole'] +--- + +# RoleMiningPotentialRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedBy** | Pointer to [**RoleMiningSessionResponseCreatedBy**](role-mining-session-response-created-by) | | [optional] +**Density** | Pointer to **int32** | The density of a potential role. | [optional] +**Description** | Pointer to **NullableString** | The description of a potential role. | [optional] +**EntitlementCount** | Pointer to **int32** | The number of entitlements in a potential role. | [optional] +**ExcludedEntitlements** | Pointer to **[]string** | The list of entitlement ids to be excluded. | [optional] +**Freshness** | Pointer to **int32** | The freshness of a potential role. | [optional] +**IdentityCount** | Pointer to **int32** | The number of identities in a potential role. | [optional] +**IdentityDistribution** | Pointer to [**[]RoleMiningIdentityDistribution**](role-mining-identity-distribution) | Identity attribute distribution. | [optional] +**IdentityIds** | Pointer to **[]string** | The list of ids in a potential role. | [optional] +**Name** | Pointer to **string** | Name of the potential role. | [optional] +**ProvisionState** | Pointer to [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional] +**Quality** | Pointer to **int32** | The quality of a potential role. | [optional] +**RoleId** | Pointer to **NullableString** | The roleId of a potential role. | [optional] +**Saved** | Pointer to **bool** | The potential role's saved status. | [optional] +**Session** | Pointer to [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**Id** | Pointer to **string** | Id of the potential role | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time when this potential role was created. | [optional] +**ModifiedDate** | Pointer to **SailPointTime** | The date-time when this potential role was modified. | [optional] + +## Methods + +### NewRoleMiningPotentialRole + +`func NewRoleMiningPotentialRole() *RoleMiningPotentialRole` + +NewRoleMiningPotentialRole instantiates a new RoleMiningPotentialRole 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 + +### NewRoleMiningPotentialRoleWithDefaults + +`func NewRoleMiningPotentialRoleWithDefaults() *RoleMiningPotentialRole` + +NewRoleMiningPotentialRoleWithDefaults instantiates a new RoleMiningPotentialRole 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 + +### GetCreatedBy + +`func (o *RoleMiningPotentialRole) GetCreatedBy() RoleMiningSessionResponseCreatedBy` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *RoleMiningPotentialRole) GetCreatedByOk() (*RoleMiningSessionResponseCreatedBy, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *RoleMiningPotentialRole) SetCreatedBy(v RoleMiningSessionResponseCreatedBy)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *RoleMiningPotentialRole) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetDensity + +`func (o *RoleMiningPotentialRole) GetDensity() int32` + +GetDensity returns the Density field if non-nil, zero value otherwise. + +### GetDensityOk + +`func (o *RoleMiningPotentialRole) GetDensityOk() (*int32, bool)` + +GetDensityOk returns a tuple with the Density field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDensity + +`func (o *RoleMiningPotentialRole) SetDensity(v int32)` + +SetDensity sets Density field to given value. + +### HasDensity + +`func (o *RoleMiningPotentialRole) HasDensity() bool` + +HasDensity returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleMiningPotentialRole) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleMiningPotentialRole) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleMiningPotentialRole) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleMiningPotentialRole) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleMiningPotentialRole) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleMiningPotentialRole) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetEntitlementCount + +`func (o *RoleMiningPotentialRole) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *RoleMiningPotentialRole) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *RoleMiningPotentialRole) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *RoleMiningPotentialRole) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetExcludedEntitlements + +`func (o *RoleMiningPotentialRole) GetExcludedEntitlements() []string` + +GetExcludedEntitlements returns the ExcludedEntitlements field if non-nil, zero value otherwise. + +### GetExcludedEntitlementsOk + +`func (o *RoleMiningPotentialRole) GetExcludedEntitlementsOk() (*[]string, bool)` + +GetExcludedEntitlementsOk returns a tuple with the ExcludedEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludedEntitlements + +`func (o *RoleMiningPotentialRole) SetExcludedEntitlements(v []string)` + +SetExcludedEntitlements sets ExcludedEntitlements field to given value. + +### HasExcludedEntitlements + +`func (o *RoleMiningPotentialRole) HasExcludedEntitlements() bool` + +HasExcludedEntitlements returns a boolean if a field has been set. + +### SetExcludedEntitlementsNil + +`func (o *RoleMiningPotentialRole) SetExcludedEntitlementsNil(b bool)` + + SetExcludedEntitlementsNil sets the value for ExcludedEntitlements to be an explicit nil + +### UnsetExcludedEntitlements +`func (o *RoleMiningPotentialRole) UnsetExcludedEntitlements()` + +UnsetExcludedEntitlements ensures that no value is present for ExcludedEntitlements, not even an explicit nil +### GetFreshness + +`func (o *RoleMiningPotentialRole) GetFreshness() int32` + +GetFreshness returns the Freshness field if non-nil, zero value otherwise. + +### GetFreshnessOk + +`func (o *RoleMiningPotentialRole) GetFreshnessOk() (*int32, bool)` + +GetFreshnessOk returns a tuple with the Freshness field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFreshness + +`func (o *RoleMiningPotentialRole) SetFreshness(v int32)` + +SetFreshness sets Freshness field to given value. + +### HasFreshness + +`func (o *RoleMiningPotentialRole) HasFreshness() bool` + +HasFreshness returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *RoleMiningPotentialRole) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *RoleMiningPotentialRole) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *RoleMiningPotentialRole) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *RoleMiningPotentialRole) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetIdentityDistribution + +`func (o *RoleMiningPotentialRole) GetIdentityDistribution() []RoleMiningIdentityDistribution` + +GetIdentityDistribution returns the IdentityDistribution field if non-nil, zero value otherwise. + +### GetIdentityDistributionOk + +`func (o *RoleMiningPotentialRole) GetIdentityDistributionOk() (*[]RoleMiningIdentityDistribution, bool)` + +GetIdentityDistributionOk returns a tuple with the IdentityDistribution field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityDistribution + +`func (o *RoleMiningPotentialRole) SetIdentityDistribution(v []RoleMiningIdentityDistribution)` + +SetIdentityDistribution sets IdentityDistribution field to given value. + +### HasIdentityDistribution + +`func (o *RoleMiningPotentialRole) HasIdentityDistribution() bool` + +HasIdentityDistribution returns a boolean if a field has been set. + +### SetIdentityDistributionNil + +`func (o *RoleMiningPotentialRole) SetIdentityDistributionNil(b bool)` + + SetIdentityDistributionNil sets the value for IdentityDistribution to be an explicit nil + +### UnsetIdentityDistribution +`func (o *RoleMiningPotentialRole) UnsetIdentityDistribution()` + +UnsetIdentityDistribution ensures that no value is present for IdentityDistribution, not even an explicit nil +### GetIdentityIds + +`func (o *RoleMiningPotentialRole) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *RoleMiningPotentialRole) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *RoleMiningPotentialRole) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *RoleMiningPotentialRole) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningPotentialRole) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningPotentialRole) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningPotentialRole) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningPotentialRole) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetProvisionState + +`func (o *RoleMiningPotentialRole) GetProvisionState() RoleMiningPotentialRoleProvisionState` + +GetProvisionState returns the ProvisionState field if non-nil, zero value otherwise. + +### GetProvisionStateOk + +`func (o *RoleMiningPotentialRole) GetProvisionStateOk() (*RoleMiningPotentialRoleProvisionState, bool)` + +GetProvisionStateOk returns a tuple with the ProvisionState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionState + +`func (o *RoleMiningPotentialRole) SetProvisionState(v RoleMiningPotentialRoleProvisionState)` + +SetProvisionState sets ProvisionState field to given value. + +### HasProvisionState + +`func (o *RoleMiningPotentialRole) HasProvisionState() bool` + +HasProvisionState returns a boolean if a field has been set. + +### GetQuality + +`func (o *RoleMiningPotentialRole) GetQuality() int32` + +GetQuality returns the Quality field if non-nil, zero value otherwise. + +### GetQualityOk + +`func (o *RoleMiningPotentialRole) GetQualityOk() (*int32, bool)` + +GetQualityOk returns a tuple with the Quality field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuality + +`func (o *RoleMiningPotentialRole) SetQuality(v int32)` + +SetQuality sets Quality field to given value. + +### HasQuality + +`func (o *RoleMiningPotentialRole) HasQuality() bool` + +HasQuality returns a boolean if a field has been set. + +### GetRoleId + +`func (o *RoleMiningPotentialRole) GetRoleId() string` + +GetRoleId returns the RoleId field if non-nil, zero value otherwise. + +### GetRoleIdOk + +`func (o *RoleMiningPotentialRole) GetRoleIdOk() (*string, bool)` + +GetRoleIdOk returns a tuple with the RoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleId + +`func (o *RoleMiningPotentialRole) SetRoleId(v string)` + +SetRoleId sets RoleId field to given value. + +### HasRoleId + +`func (o *RoleMiningPotentialRole) HasRoleId() bool` + +HasRoleId returns a boolean if a field has been set. + +### SetRoleIdNil + +`func (o *RoleMiningPotentialRole) SetRoleIdNil(b bool)` + + SetRoleIdNil sets the value for RoleId to be an explicit nil + +### UnsetRoleId +`func (o *RoleMiningPotentialRole) UnsetRoleId()` + +UnsetRoleId ensures that no value is present for RoleId, not even an explicit nil +### GetSaved + +`func (o *RoleMiningPotentialRole) GetSaved() bool` + +GetSaved returns the Saved field if non-nil, zero value otherwise. + +### GetSavedOk + +`func (o *RoleMiningPotentialRole) GetSavedOk() (*bool, bool)` + +GetSavedOk returns a tuple with the Saved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSaved + +`func (o *RoleMiningPotentialRole) SetSaved(v bool)` + +SetSaved sets Saved field to given value. + +### HasSaved + +`func (o *RoleMiningPotentialRole) HasSaved() bool` + +HasSaved returns a boolean if a field has been set. + +### GetSession + +`func (o *RoleMiningPotentialRole) GetSession() RoleMiningSessionParametersDto` + +GetSession returns the Session field if non-nil, zero value otherwise. + +### GetSessionOk + +`func (o *RoleMiningPotentialRole) GetSessionOk() (*RoleMiningSessionParametersDto, bool)` + +GetSessionOk returns a tuple with the Session field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSession + +`func (o *RoleMiningPotentialRole) SetSession(v RoleMiningSessionParametersDto)` + +SetSession sets Session field to given value. + +### HasSession + +`func (o *RoleMiningPotentialRole) HasSession() bool` + +HasSession returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningPotentialRole) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningPotentialRole) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningPotentialRole) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningPotentialRole) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RoleMiningPotentialRole) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRole) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRole) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRole) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleMiningPotentialRole) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleMiningPotentialRole) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleMiningPotentialRole) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleMiningPotentialRole) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetModifiedDate + +`func (o *RoleMiningPotentialRole) GetModifiedDate() SailPointTime` + +GetModifiedDate returns the ModifiedDate field if non-nil, zero value otherwise. + +### GetModifiedDateOk + +`func (o *RoleMiningPotentialRole) GetModifiedDateOk() (*SailPointTime, bool)` + +GetModifiedDateOk returns a tuple with the ModifiedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedDate + +`func (o *RoleMiningPotentialRole) SetModifiedDate(v SailPointTime)` + +SetModifiedDate sets ModifiedDate field to given value. + +### HasModifiedDate + +`func (o *RoleMiningPotentialRole) HasModifiedDate() bool` + +HasModifiedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleApplication.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleApplication.md new file mode 100644 index 000000000..372c34b58 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleApplication.md @@ -0,0 +1,90 @@ +--- +id: v2025-role-mining-potential-role-application +title: RoleMiningPotentialRoleApplication +pagination_label: RoleMiningPotentialRoleApplication +sidebar_label: RoleMiningPotentialRoleApplication +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleApplication', 'V2025RoleMiningPotentialRoleApplication'] +slug: /tools/sdk/go/v2025/models/role-mining-potential-role-application +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleApplication', 'V2025RoleMiningPotentialRoleApplication'] +--- + +# RoleMiningPotentialRoleApplication + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the application | [optional] +**Name** | Pointer to **string** | Name of the application | [optional] + +## Methods + +### NewRoleMiningPotentialRoleApplication + +`func NewRoleMiningPotentialRoleApplication() *RoleMiningPotentialRoleApplication` + +NewRoleMiningPotentialRoleApplication instantiates a new RoleMiningPotentialRoleApplication 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 + +### NewRoleMiningPotentialRoleApplicationWithDefaults + +`func NewRoleMiningPotentialRoleApplicationWithDefaults() *RoleMiningPotentialRoleApplication` + +NewRoleMiningPotentialRoleApplicationWithDefaults instantiates a new RoleMiningPotentialRoleApplication 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 + +### GetId + +`func (o *RoleMiningPotentialRoleApplication) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleApplication) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleApplication) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleApplication) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningPotentialRoleApplication) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningPotentialRoleApplication) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningPotentialRoleApplication) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningPotentialRoleApplication) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleEditEntitlements.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleEditEntitlements.md new file mode 100644 index 000000000..e78909431 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleEditEntitlements.md @@ -0,0 +1,90 @@ +--- +id: v2025-role-mining-potential-role-edit-entitlements +title: RoleMiningPotentialRoleEditEntitlements +pagination_label: RoleMiningPotentialRoleEditEntitlements +sidebar_label: RoleMiningPotentialRoleEditEntitlements +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleEditEntitlements', 'V2025RoleMiningPotentialRoleEditEntitlements'] +slug: /tools/sdk/go/v2025/models/role-mining-potential-role-edit-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleEditEntitlements', 'V2025RoleMiningPotentialRoleEditEntitlements'] +--- + +# RoleMiningPotentialRoleEditEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]string** | The list of entitlement ids to be edited | [optional] +**Exclude** | Pointer to **bool** | If true, add ids to be exclusion list. If false, remove ids from the exclusion list. | [optional] + +## Methods + +### NewRoleMiningPotentialRoleEditEntitlements + +`func NewRoleMiningPotentialRoleEditEntitlements() *RoleMiningPotentialRoleEditEntitlements` + +NewRoleMiningPotentialRoleEditEntitlements instantiates a new RoleMiningPotentialRoleEditEntitlements 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 + +### NewRoleMiningPotentialRoleEditEntitlementsWithDefaults + +`func NewRoleMiningPotentialRoleEditEntitlementsWithDefaults() *RoleMiningPotentialRoleEditEntitlements` + +NewRoleMiningPotentialRoleEditEntitlementsWithDefaults instantiates a new RoleMiningPotentialRoleEditEntitlements 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 + +### GetIds + +`func (o *RoleMiningPotentialRoleEditEntitlements) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *RoleMiningPotentialRoleEditEntitlements) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *RoleMiningPotentialRoleEditEntitlements) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *RoleMiningPotentialRoleEditEntitlements) HasIds() bool` + +HasIds returns a boolean if a field has been set. + +### GetExclude + +`func (o *RoleMiningPotentialRoleEditEntitlements) GetExclude() bool` + +GetExclude returns the Exclude field if non-nil, zero value otherwise. + +### GetExcludeOk + +`func (o *RoleMiningPotentialRoleEditEntitlements) GetExcludeOk() (*bool, bool)` + +GetExcludeOk returns a tuple with the Exclude field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExclude + +`func (o *RoleMiningPotentialRoleEditEntitlements) SetExclude(v bool)` + +SetExclude sets Exclude field to given value. + +### HasExclude + +`func (o *RoleMiningPotentialRoleEditEntitlements) HasExclude() bool` + +HasExclude returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleEntitlements.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleEntitlements.md new file mode 100644 index 000000000..129cebb23 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleEntitlements.md @@ -0,0 +1,90 @@ +--- +id: v2025-role-mining-potential-role-entitlements +title: RoleMiningPotentialRoleEntitlements +pagination_label: RoleMiningPotentialRoleEntitlements +sidebar_label: RoleMiningPotentialRoleEntitlements +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleEntitlements', 'V2025RoleMiningPotentialRoleEntitlements'] +slug: /tools/sdk/go/v2025/models/role-mining-potential-role-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleEntitlements', 'V2025RoleMiningPotentialRoleEntitlements'] +--- + +# RoleMiningPotentialRoleEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the entitlement | [optional] +**Name** | Pointer to **string** | Name of the entitlement | [optional] + +## Methods + +### NewRoleMiningPotentialRoleEntitlements + +`func NewRoleMiningPotentialRoleEntitlements() *RoleMiningPotentialRoleEntitlements` + +NewRoleMiningPotentialRoleEntitlements instantiates a new RoleMiningPotentialRoleEntitlements 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 + +### NewRoleMiningPotentialRoleEntitlementsWithDefaults + +`func NewRoleMiningPotentialRoleEntitlementsWithDefaults() *RoleMiningPotentialRoleEntitlements` + +NewRoleMiningPotentialRoleEntitlementsWithDefaults instantiates a new RoleMiningPotentialRoleEntitlements 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 + +### GetId + +`func (o *RoleMiningPotentialRoleEntitlements) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleEntitlements) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleEntitlements) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleEntitlements) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningPotentialRoleEntitlements) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningPotentialRoleEntitlements) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningPotentialRoleEntitlements) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningPotentialRoleEntitlements) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleExportRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleExportRequest.md new file mode 100644 index 000000000..92f2eda1d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleExportRequest.md @@ -0,0 +1,90 @@ +--- +id: v2025-role-mining-potential-role-export-request +title: RoleMiningPotentialRoleExportRequest +pagination_label: RoleMiningPotentialRoleExportRequest +sidebar_label: RoleMiningPotentialRoleExportRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleExportRequest', 'V2025RoleMiningPotentialRoleExportRequest'] +slug: /tools/sdk/go/v2025/models/role-mining-potential-role-export-request +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportRequest', 'V2025RoleMiningPotentialRoleExportRequest'] +--- + +# RoleMiningPotentialRoleExportRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MinEntitlementPopularity** | Pointer to **int32** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [optional] +**IncludeCommonAccess** | Pointer to **bool** | If false, do not include entitlements that are highly popular among the entire orginization | [optional] + +## Methods + +### NewRoleMiningPotentialRoleExportRequest + +`func NewRoleMiningPotentialRoleExportRequest() *RoleMiningPotentialRoleExportRequest` + +NewRoleMiningPotentialRoleExportRequest instantiates a new RoleMiningPotentialRoleExportRequest 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 + +### NewRoleMiningPotentialRoleExportRequestWithDefaults + +`func NewRoleMiningPotentialRoleExportRequestWithDefaults() *RoleMiningPotentialRoleExportRequest` + +NewRoleMiningPotentialRoleExportRequestWithDefaults instantiates a new RoleMiningPotentialRoleExportRequest 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 + +### GetMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportRequest) GetMinEntitlementPopularity() int32` + +GetMinEntitlementPopularity returns the MinEntitlementPopularity field if non-nil, zero value otherwise. + +### GetMinEntitlementPopularityOk + +`func (o *RoleMiningPotentialRoleExportRequest) GetMinEntitlementPopularityOk() (*int32, bool)` + +GetMinEntitlementPopularityOk returns a tuple with the MinEntitlementPopularity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportRequest) SetMinEntitlementPopularity(v int32)` + +SetMinEntitlementPopularity sets MinEntitlementPopularity field to given value. + +### HasMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportRequest) HasMinEntitlementPopularity() bool` + +HasMinEntitlementPopularity returns a boolean if a field has been set. + +### GetIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportRequest) GetIncludeCommonAccess() bool` + +GetIncludeCommonAccess returns the IncludeCommonAccess field if non-nil, zero value otherwise. + +### GetIncludeCommonAccessOk + +`func (o *RoleMiningPotentialRoleExportRequest) GetIncludeCommonAccessOk() (*bool, bool)` + +GetIncludeCommonAccessOk returns a tuple with the IncludeCommonAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportRequest) SetIncludeCommonAccess(v bool)` + +SetIncludeCommonAccess sets IncludeCommonAccess field to given value. + +### HasIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportRequest) HasIncludeCommonAccess() bool` + +HasIncludeCommonAccess returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleExportResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleExportResponse.md new file mode 100644 index 000000000..ccdb7b41f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleExportResponse.md @@ -0,0 +1,142 @@ +--- +id: v2025-role-mining-potential-role-export-response +title: RoleMiningPotentialRoleExportResponse +pagination_label: RoleMiningPotentialRoleExportResponse +sidebar_label: RoleMiningPotentialRoleExportResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleExportResponse', 'V2025RoleMiningPotentialRoleExportResponse'] +slug: /tools/sdk/go/v2025/models/role-mining-potential-role-export-response +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportResponse', 'V2025RoleMiningPotentialRoleExportResponse'] +--- + +# RoleMiningPotentialRoleExportResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MinEntitlementPopularity** | Pointer to **int32** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [optional] +**IncludeCommonAccess** | Pointer to **bool** | If false, do not include entitlements that are highly popular among the entire orginization | [optional] +**ExportId** | Pointer to **string** | ID used to reference this export | [optional] +**Status** | Pointer to [**RoleMiningPotentialRoleExportState**](role-mining-potential-role-export-state) | | [optional] + +## Methods + +### NewRoleMiningPotentialRoleExportResponse + +`func NewRoleMiningPotentialRoleExportResponse() *RoleMiningPotentialRoleExportResponse` + +NewRoleMiningPotentialRoleExportResponse instantiates a new RoleMiningPotentialRoleExportResponse 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 + +### NewRoleMiningPotentialRoleExportResponseWithDefaults + +`func NewRoleMiningPotentialRoleExportResponseWithDefaults() *RoleMiningPotentialRoleExportResponse` + +NewRoleMiningPotentialRoleExportResponseWithDefaults instantiates a new RoleMiningPotentialRoleExportResponse 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 + +### GetMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportResponse) GetMinEntitlementPopularity() int32` + +GetMinEntitlementPopularity returns the MinEntitlementPopularity field if non-nil, zero value otherwise. + +### GetMinEntitlementPopularityOk + +`func (o *RoleMiningPotentialRoleExportResponse) GetMinEntitlementPopularityOk() (*int32, bool)` + +GetMinEntitlementPopularityOk returns a tuple with the MinEntitlementPopularity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportResponse) SetMinEntitlementPopularity(v int32)` + +SetMinEntitlementPopularity sets MinEntitlementPopularity field to given value. + +### HasMinEntitlementPopularity + +`func (o *RoleMiningPotentialRoleExportResponse) HasMinEntitlementPopularity() bool` + +HasMinEntitlementPopularity returns a boolean if a field has been set. + +### GetIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportResponse) GetIncludeCommonAccess() bool` + +GetIncludeCommonAccess returns the IncludeCommonAccess field if non-nil, zero value otherwise. + +### GetIncludeCommonAccessOk + +`func (o *RoleMiningPotentialRoleExportResponse) GetIncludeCommonAccessOk() (*bool, bool)` + +GetIncludeCommonAccessOk returns a tuple with the IncludeCommonAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportResponse) SetIncludeCommonAccess(v bool)` + +SetIncludeCommonAccess sets IncludeCommonAccess field to given value. + +### HasIncludeCommonAccess + +`func (o *RoleMiningPotentialRoleExportResponse) HasIncludeCommonAccess() bool` + +HasIncludeCommonAccess returns a boolean if a field has been set. + +### GetExportId + +`func (o *RoleMiningPotentialRoleExportResponse) GetExportId() string` + +GetExportId returns the ExportId field if non-nil, zero value otherwise. + +### GetExportIdOk + +`func (o *RoleMiningPotentialRoleExportResponse) GetExportIdOk() (*string, bool)` + +GetExportIdOk returns a tuple with the ExportId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExportId + +`func (o *RoleMiningPotentialRoleExportResponse) SetExportId(v string)` + +SetExportId sets ExportId field to given value. + +### HasExportId + +`func (o *RoleMiningPotentialRoleExportResponse) HasExportId() bool` + +HasExportId returns a boolean if a field has been set. + +### GetStatus + +`func (o *RoleMiningPotentialRoleExportResponse) GetStatus() RoleMiningPotentialRoleExportState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *RoleMiningPotentialRoleExportResponse) GetStatusOk() (*RoleMiningPotentialRoleExportState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *RoleMiningPotentialRoleExportResponse) SetStatus(v RoleMiningPotentialRoleExportState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *RoleMiningPotentialRoleExportResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleExportState.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleExportState.md new file mode 100644 index 000000000..4043e8136 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleExportState.md @@ -0,0 +1,25 @@ +--- +id: v2025-role-mining-potential-role-export-state +title: RoleMiningPotentialRoleExportState +pagination_label: RoleMiningPotentialRoleExportState +sidebar_label: RoleMiningPotentialRoleExportState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleExportState', 'V2025RoleMiningPotentialRoleExportState'] +slug: /tools/sdk/go/v2025/models/role-mining-potential-role-export-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportState', 'V2025RoleMiningPotentialRoleExportState'] +--- + +# RoleMiningPotentialRoleExportState + +## Enum + + +* `QUEUED` (value: `"QUEUED"`) + +* `IN_PROGRESS` (value: `"IN_PROGRESS"`) + +* `SUCCESS` (value: `"SUCCESS"`) + +* `ERROR` (value: `"ERROR"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleProvisionRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleProvisionRequest.md new file mode 100644 index 000000000..c3eacabcd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleProvisionRequest.md @@ -0,0 +1,168 @@ +--- +id: v2025-role-mining-potential-role-provision-request +title: RoleMiningPotentialRoleProvisionRequest +pagination_label: RoleMiningPotentialRoleProvisionRequest +sidebar_label: RoleMiningPotentialRoleProvisionRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleProvisionRequest', 'V2025RoleMiningPotentialRoleProvisionRequest'] +slug: /tools/sdk/go/v2025/models/role-mining-potential-role-provision-request +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleProvisionRequest', 'V2025RoleMiningPotentialRoleProvisionRequest'] +--- + +# RoleMiningPotentialRoleProvisionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleName** | Pointer to **string** | Name of the new role being created | [optional] +**RoleDescription** | Pointer to **string** | Short description of the new role being created | [optional] +**OwnerId** | Pointer to **string** | ID of the identity that will own this role | [optional] +**IncludeIdentities** | Pointer to **bool** | When true, create access requests for the identities associated with the potential role | [optional] [default to false] +**DirectlyAssignedEntitlements** | Pointer to **bool** | When true, assign entitlements directly to the role; otherwise, create access profiles containing the entitlements | [optional] [default to false] + +## Methods + +### NewRoleMiningPotentialRoleProvisionRequest + +`func NewRoleMiningPotentialRoleProvisionRequest() *RoleMiningPotentialRoleProvisionRequest` + +NewRoleMiningPotentialRoleProvisionRequest instantiates a new RoleMiningPotentialRoleProvisionRequest 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 + +### NewRoleMiningPotentialRoleProvisionRequestWithDefaults + +`func NewRoleMiningPotentialRoleProvisionRequestWithDefaults() *RoleMiningPotentialRoleProvisionRequest` + +NewRoleMiningPotentialRoleProvisionRequestWithDefaults instantiates a new RoleMiningPotentialRoleProvisionRequest 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 + +### GetRoleName + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetRoleName() string` + +GetRoleName returns the RoleName field if non-nil, zero value otherwise. + +### GetRoleNameOk + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetRoleNameOk() (*string, bool)` + +GetRoleNameOk returns a tuple with the RoleName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleName + +`func (o *RoleMiningPotentialRoleProvisionRequest) SetRoleName(v string)` + +SetRoleName sets RoleName field to given value. + +### HasRoleName + +`func (o *RoleMiningPotentialRoleProvisionRequest) HasRoleName() bool` + +HasRoleName returns a boolean if a field has been set. + +### GetRoleDescription + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetRoleDescription() string` + +GetRoleDescription returns the RoleDescription field if non-nil, zero value otherwise. + +### GetRoleDescriptionOk + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetRoleDescriptionOk() (*string, bool)` + +GetRoleDescriptionOk returns a tuple with the RoleDescription field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleDescription + +`func (o *RoleMiningPotentialRoleProvisionRequest) SetRoleDescription(v string)` + +SetRoleDescription sets RoleDescription field to given value. + +### HasRoleDescription + +`func (o *RoleMiningPotentialRoleProvisionRequest) HasRoleDescription() bool` + +HasRoleDescription returns a boolean if a field has been set. + +### GetOwnerId + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *RoleMiningPotentialRoleProvisionRequest) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *RoleMiningPotentialRoleProvisionRequest) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + +### GetIncludeIdentities + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetIncludeIdentities() bool` + +GetIncludeIdentities returns the IncludeIdentities field if non-nil, zero value otherwise. + +### GetIncludeIdentitiesOk + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetIncludeIdentitiesOk() (*bool, bool)` + +GetIncludeIdentitiesOk returns a tuple with the IncludeIdentities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeIdentities + +`func (o *RoleMiningPotentialRoleProvisionRequest) SetIncludeIdentities(v bool)` + +SetIncludeIdentities sets IncludeIdentities field to given value. + +### HasIncludeIdentities + +`func (o *RoleMiningPotentialRoleProvisionRequest) HasIncludeIdentities() bool` + +HasIncludeIdentities returns a boolean if a field has been set. + +### GetDirectlyAssignedEntitlements + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetDirectlyAssignedEntitlements() bool` + +GetDirectlyAssignedEntitlements returns the DirectlyAssignedEntitlements field if non-nil, zero value otherwise. + +### GetDirectlyAssignedEntitlementsOk + +`func (o *RoleMiningPotentialRoleProvisionRequest) GetDirectlyAssignedEntitlementsOk() (*bool, bool)` + +GetDirectlyAssignedEntitlementsOk returns a tuple with the DirectlyAssignedEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectlyAssignedEntitlements + +`func (o *RoleMiningPotentialRoleProvisionRequest) SetDirectlyAssignedEntitlements(v bool)` + +SetDirectlyAssignedEntitlements sets DirectlyAssignedEntitlements field to given value. + +### HasDirectlyAssignedEntitlements + +`func (o *RoleMiningPotentialRoleProvisionRequest) HasDirectlyAssignedEntitlements() bool` + +HasDirectlyAssignedEntitlements returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleProvisionState.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleProvisionState.md new file mode 100644 index 000000000..b4f3013b3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleProvisionState.md @@ -0,0 +1,25 @@ +--- +id: v2025-role-mining-potential-role-provision-state +title: RoleMiningPotentialRoleProvisionState +pagination_label: RoleMiningPotentialRoleProvisionState +sidebar_label: RoleMiningPotentialRoleProvisionState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleProvisionState', 'V2025RoleMiningPotentialRoleProvisionState'] +slug: /tools/sdk/go/v2025/models/role-mining-potential-role-provision-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleProvisionState', 'V2025RoleMiningPotentialRoleProvisionState'] +--- + +# RoleMiningPotentialRoleProvisionState + +## Enum + + +* `POTENTIAL` (value: `"POTENTIAL"`) + +* `PENDING` (value: `"PENDING"`) + +* `COMPLETE` (value: `"COMPLETE"`) + +* `FAILED` (value: `"FAILED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleRef.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleRef.md new file mode 100644 index 000000000..9dc9a6aaf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleRef.md @@ -0,0 +1,90 @@ +--- +id: v2025-role-mining-potential-role-ref +title: RoleMiningPotentialRoleRef +pagination_label: RoleMiningPotentialRoleRef +sidebar_label: RoleMiningPotentialRoleRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleRef', 'V2025RoleMiningPotentialRoleRef'] +slug: /tools/sdk/go/v2025/models/role-mining-potential-role-ref +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleRef', 'V2025RoleMiningPotentialRoleRef'] +--- + +# RoleMiningPotentialRoleRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the potential role | [optional] +**Name** | Pointer to **string** | Name of the potential role | [optional] + +## Methods + +### NewRoleMiningPotentialRoleRef + +`func NewRoleMiningPotentialRoleRef() *RoleMiningPotentialRoleRef` + +NewRoleMiningPotentialRoleRef instantiates a new RoleMiningPotentialRoleRef 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 + +### NewRoleMiningPotentialRoleRefWithDefaults + +`func NewRoleMiningPotentialRoleRefWithDefaults() *RoleMiningPotentialRoleRef` + +NewRoleMiningPotentialRoleRefWithDefaults instantiates a new RoleMiningPotentialRoleRef 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 + +### GetId + +`func (o *RoleMiningPotentialRoleRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningPotentialRoleRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningPotentialRoleRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningPotentialRoleRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningPotentialRoleRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleSourceUsage.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleSourceUsage.md new file mode 100644 index 000000000..426fed4a9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleSourceUsage.md @@ -0,0 +1,142 @@ +--- +id: v2025-role-mining-potential-role-source-usage +title: RoleMiningPotentialRoleSourceUsage +pagination_label: RoleMiningPotentialRoleSourceUsage +sidebar_label: RoleMiningPotentialRoleSourceUsage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleSourceUsage', 'V2025RoleMiningPotentialRoleSourceUsage'] +slug: /tools/sdk/go/v2025/models/role-mining-potential-role-source-usage +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSourceUsage', 'V2025RoleMiningPotentialRoleSourceUsage'] +--- + +# RoleMiningPotentialRoleSourceUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity ID | [optional] +**DisplayName** | Pointer to **string** | Display name for the identity | [optional] +**Email** | Pointer to **string** | Email address for the identity | [optional] +**UsageCount** | Pointer to **int32** | The number of days there has been usage of the source by the identity. | [optional] + +## Methods + +### NewRoleMiningPotentialRoleSourceUsage + +`func NewRoleMiningPotentialRoleSourceUsage() *RoleMiningPotentialRoleSourceUsage` + +NewRoleMiningPotentialRoleSourceUsage instantiates a new RoleMiningPotentialRoleSourceUsage 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 + +### NewRoleMiningPotentialRoleSourceUsageWithDefaults + +`func NewRoleMiningPotentialRoleSourceUsageWithDefaults() *RoleMiningPotentialRoleSourceUsage` + +NewRoleMiningPotentialRoleSourceUsageWithDefaults instantiates a new RoleMiningPotentialRoleSourceUsage 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 + +### GetId + +`func (o *RoleMiningPotentialRoleSourceUsage) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleSourceUsage) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleSourceUsage) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleSourceUsage) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *RoleMiningPotentialRoleSourceUsage) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *RoleMiningPotentialRoleSourceUsage) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *RoleMiningPotentialRoleSourceUsage) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *RoleMiningPotentialRoleSourceUsage) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetEmail + +`func (o *RoleMiningPotentialRoleSourceUsage) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *RoleMiningPotentialRoleSourceUsage) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *RoleMiningPotentialRoleSourceUsage) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *RoleMiningPotentialRoleSourceUsage) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetUsageCount + +`func (o *RoleMiningPotentialRoleSourceUsage) GetUsageCount() int32` + +GetUsageCount returns the UsageCount field if non-nil, zero value otherwise. + +### GetUsageCountOk + +`func (o *RoleMiningPotentialRoleSourceUsage) GetUsageCountOk() (*int32, bool)` + +GetUsageCountOk returns a tuple with the UsageCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsageCount + +`func (o *RoleMiningPotentialRoleSourceUsage) SetUsageCount(v int32)` + +SetUsageCount sets UsageCount field to given value. + +### HasUsageCount + +`func (o *RoleMiningPotentialRoleSourceUsage) HasUsageCount() bool` + +HasUsageCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleSummary.md new file mode 100644 index 000000000..2b26a20ae --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleSummary.md @@ -0,0 +1,500 @@ +--- +id: v2025-role-mining-potential-role-summary +title: RoleMiningPotentialRoleSummary +pagination_label: RoleMiningPotentialRoleSummary +sidebar_label: RoleMiningPotentialRoleSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleSummary', 'V2025RoleMiningPotentialRoleSummary'] +slug: /tools/sdk/go/v2025/models/role-mining-potential-role-summary +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummary', 'V2025RoleMiningPotentialRoleSummary'] +--- + +# RoleMiningPotentialRoleSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the potential role | [optional] +**Name** | Pointer to **string** | Name of the potential role | [optional] +**PotentialRoleRef** | Pointer to [**RoleMiningPotentialRoleRef**](role-mining-potential-role-ref) | | [optional] +**IdentityCount** | Pointer to **int32** | The number of identities in a potential role. | [optional] +**EntitlementCount** | Pointer to **int32** | The number of entitlements in a potential role. | [optional] +**IdentityGroupStatus** | Pointer to **string** | The status for this identity group which can be \"REQUESTED\" or \"OBTAINED\" | [optional] +**ProvisionState** | Pointer to [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional] +**RoleId** | Pointer to **NullableString** | ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. | [optional] +**Density** | Pointer to **int32** | The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. | [optional] +**Freshness** | Pointer to **int32** | The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. | [optional] +**Quality** | Pointer to **int32** | The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**CreatedBy** | Pointer to [**RoleMiningPotentialRoleSummaryCreatedBy**](role-mining-potential-role-summary-created-by) | | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time when this potential role was created. | [optional] +**Saved** | Pointer to **bool** | The potential role's saved status | [optional] [default to false] +**Description** | Pointer to **NullableString** | Description of the potential role | [optional] +**Session** | Pointer to [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional] + +## Methods + +### NewRoleMiningPotentialRoleSummary + +`func NewRoleMiningPotentialRoleSummary() *RoleMiningPotentialRoleSummary` + +NewRoleMiningPotentialRoleSummary instantiates a new RoleMiningPotentialRoleSummary 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 + +### NewRoleMiningPotentialRoleSummaryWithDefaults + +`func NewRoleMiningPotentialRoleSummaryWithDefaults() *RoleMiningPotentialRoleSummary` + +NewRoleMiningPotentialRoleSummaryWithDefaults instantiates a new RoleMiningPotentialRoleSummary 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 + +### GetId + +`func (o *RoleMiningPotentialRoleSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleSummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleSummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningPotentialRoleSummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningPotentialRoleSummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningPotentialRoleSummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningPotentialRoleSummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPotentialRoleRef + +`func (o *RoleMiningPotentialRoleSummary) GetPotentialRoleRef() RoleMiningPotentialRoleRef` + +GetPotentialRoleRef returns the PotentialRoleRef field if non-nil, zero value otherwise. + +### GetPotentialRoleRefOk + +`func (o *RoleMiningPotentialRoleSummary) GetPotentialRoleRefOk() (*RoleMiningPotentialRoleRef, bool)` + +GetPotentialRoleRefOk returns a tuple with the PotentialRoleRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPotentialRoleRef + +`func (o *RoleMiningPotentialRoleSummary) SetPotentialRoleRef(v RoleMiningPotentialRoleRef)` + +SetPotentialRoleRef sets PotentialRoleRef field to given value. + +### HasPotentialRoleRef + +`func (o *RoleMiningPotentialRoleSummary) HasPotentialRoleRef() bool` + +HasPotentialRoleRef returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *RoleMiningPotentialRoleSummary) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *RoleMiningPotentialRoleSummary) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *RoleMiningPotentialRoleSummary) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *RoleMiningPotentialRoleSummary) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *RoleMiningPotentialRoleSummary) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *RoleMiningPotentialRoleSummary) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *RoleMiningPotentialRoleSummary) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *RoleMiningPotentialRoleSummary) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetIdentityGroupStatus + +`func (o *RoleMiningPotentialRoleSummary) GetIdentityGroupStatus() string` + +GetIdentityGroupStatus returns the IdentityGroupStatus field if non-nil, zero value otherwise. + +### GetIdentityGroupStatusOk + +`func (o *RoleMiningPotentialRoleSummary) GetIdentityGroupStatusOk() (*string, bool)` + +GetIdentityGroupStatusOk returns a tuple with the IdentityGroupStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityGroupStatus + +`func (o *RoleMiningPotentialRoleSummary) SetIdentityGroupStatus(v string)` + +SetIdentityGroupStatus sets IdentityGroupStatus field to given value. + +### HasIdentityGroupStatus + +`func (o *RoleMiningPotentialRoleSummary) HasIdentityGroupStatus() bool` + +HasIdentityGroupStatus returns a boolean if a field has been set. + +### GetProvisionState + +`func (o *RoleMiningPotentialRoleSummary) GetProvisionState() RoleMiningPotentialRoleProvisionState` + +GetProvisionState returns the ProvisionState field if non-nil, zero value otherwise. + +### GetProvisionStateOk + +`func (o *RoleMiningPotentialRoleSummary) GetProvisionStateOk() (*RoleMiningPotentialRoleProvisionState, bool)` + +GetProvisionStateOk returns a tuple with the ProvisionState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionState + +`func (o *RoleMiningPotentialRoleSummary) SetProvisionState(v RoleMiningPotentialRoleProvisionState)` + +SetProvisionState sets ProvisionState field to given value. + +### HasProvisionState + +`func (o *RoleMiningPotentialRoleSummary) HasProvisionState() bool` + +HasProvisionState returns a boolean if a field has been set. + +### GetRoleId + +`func (o *RoleMiningPotentialRoleSummary) GetRoleId() string` + +GetRoleId returns the RoleId field if non-nil, zero value otherwise. + +### GetRoleIdOk + +`func (o *RoleMiningPotentialRoleSummary) GetRoleIdOk() (*string, bool)` + +GetRoleIdOk returns a tuple with the RoleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleId + +`func (o *RoleMiningPotentialRoleSummary) SetRoleId(v string)` + +SetRoleId sets RoleId field to given value. + +### HasRoleId + +`func (o *RoleMiningPotentialRoleSummary) HasRoleId() bool` + +HasRoleId returns a boolean if a field has been set. + +### SetRoleIdNil + +`func (o *RoleMiningPotentialRoleSummary) SetRoleIdNil(b bool)` + + SetRoleIdNil sets the value for RoleId to be an explicit nil + +### UnsetRoleId +`func (o *RoleMiningPotentialRoleSummary) UnsetRoleId()` + +UnsetRoleId ensures that no value is present for RoleId, not even an explicit nil +### GetDensity + +`func (o *RoleMiningPotentialRoleSummary) GetDensity() int32` + +GetDensity returns the Density field if non-nil, zero value otherwise. + +### GetDensityOk + +`func (o *RoleMiningPotentialRoleSummary) GetDensityOk() (*int32, bool)` + +GetDensityOk returns a tuple with the Density field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDensity + +`func (o *RoleMiningPotentialRoleSummary) SetDensity(v int32)` + +SetDensity sets Density field to given value. + +### HasDensity + +`func (o *RoleMiningPotentialRoleSummary) HasDensity() bool` + +HasDensity returns a boolean if a field has been set. + +### GetFreshness + +`func (o *RoleMiningPotentialRoleSummary) GetFreshness() int32` + +GetFreshness returns the Freshness field if non-nil, zero value otherwise. + +### GetFreshnessOk + +`func (o *RoleMiningPotentialRoleSummary) GetFreshnessOk() (*int32, bool)` + +GetFreshnessOk returns a tuple with the Freshness field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFreshness + +`func (o *RoleMiningPotentialRoleSummary) SetFreshness(v int32)` + +SetFreshness sets Freshness field to given value. + +### HasFreshness + +`func (o *RoleMiningPotentialRoleSummary) HasFreshness() bool` + +HasFreshness returns a boolean if a field has been set. + +### GetQuality + +`func (o *RoleMiningPotentialRoleSummary) GetQuality() int32` + +GetQuality returns the Quality field if non-nil, zero value otherwise. + +### GetQualityOk + +`func (o *RoleMiningPotentialRoleSummary) GetQualityOk() (*int32, bool)` + +GetQualityOk returns a tuple with the Quality field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuality + +`func (o *RoleMiningPotentialRoleSummary) SetQuality(v int32)` + +SetQuality sets Quality field to given value. + +### HasQuality + +`func (o *RoleMiningPotentialRoleSummary) HasQuality() bool` + +HasQuality returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningPotentialRoleSummary) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningPotentialRoleSummary) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningPotentialRoleSummary) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningPotentialRoleSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetCreatedBy + +`func (o *RoleMiningPotentialRoleSummary) GetCreatedBy() RoleMiningPotentialRoleSummaryCreatedBy` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *RoleMiningPotentialRoleSummary) GetCreatedByOk() (*RoleMiningPotentialRoleSummaryCreatedBy, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *RoleMiningPotentialRoleSummary) SetCreatedBy(v RoleMiningPotentialRoleSummaryCreatedBy)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *RoleMiningPotentialRoleSummary) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleMiningPotentialRoleSummary) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleMiningPotentialRoleSummary) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleMiningPotentialRoleSummary) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleMiningPotentialRoleSummary) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetSaved + +`func (o *RoleMiningPotentialRoleSummary) GetSaved() bool` + +GetSaved returns the Saved field if non-nil, zero value otherwise. + +### GetSavedOk + +`func (o *RoleMiningPotentialRoleSummary) GetSavedOk() (*bool, bool)` + +GetSavedOk returns a tuple with the Saved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSaved + +`func (o *RoleMiningPotentialRoleSummary) SetSaved(v bool)` + +SetSaved sets Saved field to given value. + +### HasSaved + +`func (o *RoleMiningPotentialRoleSummary) HasSaved() bool` + +HasSaved returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleMiningPotentialRoleSummary) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleMiningPotentialRoleSummary) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleMiningPotentialRoleSummary) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleMiningPotentialRoleSummary) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleMiningPotentialRoleSummary) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleMiningPotentialRoleSummary) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSession + +`func (o *RoleMiningPotentialRoleSummary) GetSession() RoleMiningSessionParametersDto` + +GetSession returns the Session field if non-nil, zero value otherwise. + +### GetSessionOk + +`func (o *RoleMiningPotentialRoleSummary) GetSessionOk() (*RoleMiningSessionParametersDto, bool)` + +GetSessionOk returns a tuple with the Session field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSession + +`func (o *RoleMiningPotentialRoleSummary) SetSession(v RoleMiningSessionParametersDto)` + +SetSession sets Session field to given value. + +### HasSession + +`func (o *RoleMiningPotentialRoleSummary) HasSession() bool` + +HasSession returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleSummaryCreatedBy.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleSummaryCreatedBy.md new file mode 100644 index 000000000..007720685 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningPotentialRoleSummaryCreatedBy.md @@ -0,0 +1,90 @@ +--- +id: v2025-role-mining-potential-role-summary-created-by +title: RoleMiningPotentialRoleSummaryCreatedBy +pagination_label: RoleMiningPotentialRoleSummaryCreatedBy +sidebar_label: RoleMiningPotentialRoleSummaryCreatedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningPotentialRoleSummaryCreatedBy', 'V2025RoleMiningPotentialRoleSummaryCreatedBy'] +slug: /tools/sdk/go/v2025/models/role-mining-potential-role-summary-created-by +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummaryCreatedBy', 'V2025RoleMiningPotentialRoleSummaryCreatedBy'] +--- + +# RoleMiningPotentialRoleSummaryCreatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the creator | [optional] +**DisplayName** | Pointer to **string** | The display name of the creator | [optional] + +## Methods + +### NewRoleMiningPotentialRoleSummaryCreatedBy + +`func NewRoleMiningPotentialRoleSummaryCreatedBy() *RoleMiningPotentialRoleSummaryCreatedBy` + +NewRoleMiningPotentialRoleSummaryCreatedBy instantiates a new RoleMiningPotentialRoleSummaryCreatedBy 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 + +### NewRoleMiningPotentialRoleSummaryCreatedByWithDefaults + +`func NewRoleMiningPotentialRoleSummaryCreatedByWithDefaults() *RoleMiningPotentialRoleSummaryCreatedBy` + +NewRoleMiningPotentialRoleSummaryCreatedByWithDefaults instantiates a new RoleMiningPotentialRoleSummaryCreatedBy 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 + +### GetId + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *RoleMiningPotentialRoleSummaryCreatedBy) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningRoleType.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningRoleType.md new file mode 100644 index 000000000..ba063d082 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningRoleType.md @@ -0,0 +1,21 @@ +--- +id: v2025-role-mining-role-type +title: RoleMiningRoleType +pagination_label: RoleMiningRoleType +sidebar_label: RoleMiningRoleType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningRoleType', 'V2025RoleMiningRoleType'] +slug: /tools/sdk/go/v2025/models/role-mining-role-type +tags: ['SDK', 'Software Development Kit', 'RoleMiningRoleType', 'V2025RoleMiningRoleType'] +--- + +# RoleMiningRoleType + +## Enum + + +* `SPECIALIZED` (value: `"SPECIALIZED"`) + +* `COMMON` (value: `"COMMON"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionDraftRoleDto.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionDraftRoleDto.md new file mode 100644 index 000000000..8033fb18d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionDraftRoleDto.md @@ -0,0 +1,298 @@ +--- +id: v2025-role-mining-session-draft-role-dto +title: RoleMiningSessionDraftRoleDto +pagination_label: RoleMiningSessionDraftRoleDto +sidebar_label: RoleMiningSessionDraftRoleDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionDraftRoleDto', 'V2025RoleMiningSessionDraftRoleDto'] +slug: /tools/sdk/go/v2025/models/role-mining-session-draft-role-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionDraftRoleDto', 'V2025RoleMiningSessionDraftRoleDto'] +--- + +# RoleMiningSessionDraftRoleDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the draft role | [optional] +**Description** | Pointer to **string** | Draft role description | [optional] +**IdentityIds** | Pointer to **[]string** | The list of identities for this role mining session. | [optional] +**EntitlementIds** | Pointer to **[]string** | The list of entitlement ids for this role mining session. | [optional] +**ExcludedEntitlements** | Pointer to **[]string** | The list of excluded entitlement ids. | [optional] +**Modified** | Pointer to **SailPointTime** | Last modified date | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**Id** | Pointer to **string** | Id of the potential draft role | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time when this potential draft role was created. | [optional] +**ModifiedDate** | Pointer to **SailPointTime** | The date-time when this potential draft role was modified. | [optional] + +## Methods + +### NewRoleMiningSessionDraftRoleDto + +`func NewRoleMiningSessionDraftRoleDto() *RoleMiningSessionDraftRoleDto` + +NewRoleMiningSessionDraftRoleDto instantiates a new RoleMiningSessionDraftRoleDto 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 + +### NewRoleMiningSessionDraftRoleDtoWithDefaults + +`func NewRoleMiningSessionDraftRoleDtoWithDefaults() *RoleMiningSessionDraftRoleDto` + +NewRoleMiningSessionDraftRoleDtoWithDefaults instantiates a new RoleMiningSessionDraftRoleDto 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 + +### GetName + +`func (o *RoleMiningSessionDraftRoleDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningSessionDraftRoleDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningSessionDraftRoleDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningSessionDraftRoleDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleMiningSessionDraftRoleDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleMiningSessionDraftRoleDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleMiningSessionDraftRoleDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleMiningSessionDraftRoleDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIdentityIds + +`func (o *RoleMiningSessionDraftRoleDto) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *RoleMiningSessionDraftRoleDto) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *RoleMiningSessionDraftRoleDto) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *RoleMiningSessionDraftRoleDto) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + +### GetEntitlementIds + +`func (o *RoleMiningSessionDraftRoleDto) GetEntitlementIds() []string` + +GetEntitlementIds returns the EntitlementIds field if non-nil, zero value otherwise. + +### GetEntitlementIdsOk + +`func (o *RoleMiningSessionDraftRoleDto) GetEntitlementIdsOk() (*[]string, bool)` + +GetEntitlementIdsOk returns a tuple with the EntitlementIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementIds + +`func (o *RoleMiningSessionDraftRoleDto) SetEntitlementIds(v []string)` + +SetEntitlementIds sets EntitlementIds field to given value. + +### HasEntitlementIds + +`func (o *RoleMiningSessionDraftRoleDto) HasEntitlementIds() bool` + +HasEntitlementIds returns a boolean if a field has been set. + +### GetExcludedEntitlements + +`func (o *RoleMiningSessionDraftRoleDto) GetExcludedEntitlements() []string` + +GetExcludedEntitlements returns the ExcludedEntitlements field if non-nil, zero value otherwise. + +### GetExcludedEntitlementsOk + +`func (o *RoleMiningSessionDraftRoleDto) GetExcludedEntitlementsOk() (*[]string, bool)` + +GetExcludedEntitlementsOk returns a tuple with the ExcludedEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludedEntitlements + +`func (o *RoleMiningSessionDraftRoleDto) SetExcludedEntitlements(v []string)` + +SetExcludedEntitlements sets ExcludedEntitlements field to given value. + +### HasExcludedEntitlements + +`func (o *RoleMiningSessionDraftRoleDto) HasExcludedEntitlements() bool` + +HasExcludedEntitlements returns a boolean if a field has been set. + +### GetModified + +`func (o *RoleMiningSessionDraftRoleDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RoleMiningSessionDraftRoleDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RoleMiningSessionDraftRoleDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RoleMiningSessionDraftRoleDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningSessionDraftRoleDto) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningSessionDraftRoleDto) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningSessionDraftRoleDto) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningSessionDraftRoleDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RoleMiningSessionDraftRoleDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningSessionDraftRoleDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningSessionDraftRoleDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningSessionDraftRoleDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleMiningSessionDraftRoleDto) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleMiningSessionDraftRoleDto) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleMiningSessionDraftRoleDto) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleMiningSessionDraftRoleDto) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetModifiedDate + +`func (o *RoleMiningSessionDraftRoleDto) GetModifiedDate() SailPointTime` + +GetModifiedDate returns the ModifiedDate field if non-nil, zero value otherwise. + +### GetModifiedDateOk + +`func (o *RoleMiningSessionDraftRoleDto) GetModifiedDateOk() (*SailPointTime, bool)` + +GetModifiedDateOk returns a tuple with the ModifiedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedDate + +`func (o *RoleMiningSessionDraftRoleDto) SetModifiedDate(v SailPointTime)` + +SetModifiedDate sets ModifiedDate field to given value. + +### HasModifiedDate + +`func (o *RoleMiningSessionDraftRoleDto) HasModifiedDate() bool` + +HasModifiedDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionDto.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionDto.md new file mode 100644 index 000000000..56ba376da --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionDto.md @@ -0,0 +1,374 @@ +--- +id: v2025-role-mining-session-dto +title: RoleMiningSessionDto +pagination_label: RoleMiningSessionDto +sidebar_label: RoleMiningSessionDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionDto', 'V2025RoleMiningSessionDto'] +slug: /tools/sdk/go/v2025/models/role-mining-session-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionDto', 'V2025RoleMiningSessionDto'] +--- + +# RoleMiningSessionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**PruneThreshold** | Pointer to **NullableInt32** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [optional] +**PrescribedPruneThreshold** | Pointer to **NullableInt32** | The calculated prescribedPruneThreshold | [optional] +**MinNumIdentitiesInPotentialRole** | Pointer to **NullableInt32** | Minimum number of identities in a potential role | [optional] +**PotentialRoleCount** | Pointer to **int32** | Number of potential roles | [optional] +**PotentialRolesReadyCount** | Pointer to **int32** | Number of potential roles ready | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**EmailRecipientId** | Pointer to **NullableString** | The id of the user who will receive an email about the role mining session | [optional] +**IdentityCount** | Pointer to **int32** | Number of identities in the population which meet the search criteria or identity list provided | [optional] +**Saved** | Pointer to **bool** | The session's saved status | [optional] [default to false] +**Name** | Pointer to **NullableString** | The session's saved name | [optional] + +## Methods + +### NewRoleMiningSessionDto + +`func NewRoleMiningSessionDto() *RoleMiningSessionDto` + +NewRoleMiningSessionDto instantiates a new RoleMiningSessionDto 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 + +### NewRoleMiningSessionDtoWithDefaults + +`func NewRoleMiningSessionDtoWithDefaults() *RoleMiningSessionDto` + +NewRoleMiningSessionDtoWithDefaults instantiates a new RoleMiningSessionDto 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 + +### GetScope + +`func (o *RoleMiningSessionDto) GetScope() RoleMiningSessionScope` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *RoleMiningSessionDto) GetScopeOk() (*RoleMiningSessionScope, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *RoleMiningSessionDto) SetScope(v RoleMiningSessionScope)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *RoleMiningSessionDto) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### GetPruneThreshold + +`func (o *RoleMiningSessionDto) GetPruneThreshold() int32` + +GetPruneThreshold returns the PruneThreshold field if non-nil, zero value otherwise. + +### GetPruneThresholdOk + +`func (o *RoleMiningSessionDto) GetPruneThresholdOk() (*int32, bool)` + +GetPruneThresholdOk returns a tuple with the PruneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPruneThreshold + +`func (o *RoleMiningSessionDto) SetPruneThreshold(v int32)` + +SetPruneThreshold sets PruneThreshold field to given value. + +### HasPruneThreshold + +`func (o *RoleMiningSessionDto) HasPruneThreshold() bool` + +HasPruneThreshold returns a boolean if a field has been set. + +### SetPruneThresholdNil + +`func (o *RoleMiningSessionDto) SetPruneThresholdNil(b bool)` + + SetPruneThresholdNil sets the value for PruneThreshold to be an explicit nil + +### UnsetPruneThreshold +`func (o *RoleMiningSessionDto) UnsetPruneThreshold()` + +UnsetPruneThreshold ensures that no value is present for PruneThreshold, not even an explicit nil +### GetPrescribedPruneThreshold + +`func (o *RoleMiningSessionDto) GetPrescribedPruneThreshold() int32` + +GetPrescribedPruneThreshold returns the PrescribedPruneThreshold field if non-nil, zero value otherwise. + +### GetPrescribedPruneThresholdOk + +`func (o *RoleMiningSessionDto) GetPrescribedPruneThresholdOk() (*int32, bool)` + +GetPrescribedPruneThresholdOk returns a tuple with the PrescribedPruneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrescribedPruneThreshold + +`func (o *RoleMiningSessionDto) SetPrescribedPruneThreshold(v int32)` + +SetPrescribedPruneThreshold sets PrescribedPruneThreshold field to given value. + +### HasPrescribedPruneThreshold + +`func (o *RoleMiningSessionDto) HasPrescribedPruneThreshold() bool` + +HasPrescribedPruneThreshold returns a boolean if a field has been set. + +### SetPrescribedPruneThresholdNil + +`func (o *RoleMiningSessionDto) SetPrescribedPruneThresholdNil(b bool)` + + SetPrescribedPruneThresholdNil sets the value for PrescribedPruneThreshold to be an explicit nil + +### UnsetPrescribedPruneThreshold +`func (o *RoleMiningSessionDto) UnsetPrescribedPruneThreshold()` + +UnsetPrescribedPruneThreshold ensures that no value is present for PrescribedPruneThreshold, not even an explicit nil +### GetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionDto) GetMinNumIdentitiesInPotentialRole() int32` + +GetMinNumIdentitiesInPotentialRole returns the MinNumIdentitiesInPotentialRole field if non-nil, zero value otherwise. + +### GetMinNumIdentitiesInPotentialRoleOk + +`func (o *RoleMiningSessionDto) GetMinNumIdentitiesInPotentialRoleOk() (*int32, bool)` + +GetMinNumIdentitiesInPotentialRoleOk returns a tuple with the MinNumIdentitiesInPotentialRole field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionDto) SetMinNumIdentitiesInPotentialRole(v int32)` + +SetMinNumIdentitiesInPotentialRole sets MinNumIdentitiesInPotentialRole field to given value. + +### HasMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionDto) HasMinNumIdentitiesInPotentialRole() bool` + +HasMinNumIdentitiesInPotentialRole returns a boolean if a field has been set. + +### SetMinNumIdentitiesInPotentialRoleNil + +`func (o *RoleMiningSessionDto) SetMinNumIdentitiesInPotentialRoleNil(b bool)` + + SetMinNumIdentitiesInPotentialRoleNil sets the value for MinNumIdentitiesInPotentialRole to be an explicit nil + +### UnsetMinNumIdentitiesInPotentialRole +`func (o *RoleMiningSessionDto) UnsetMinNumIdentitiesInPotentialRole()` + +UnsetMinNumIdentitiesInPotentialRole ensures that no value is present for MinNumIdentitiesInPotentialRole, not even an explicit nil +### GetPotentialRoleCount + +`func (o *RoleMiningSessionDto) GetPotentialRoleCount() int32` + +GetPotentialRoleCount returns the PotentialRoleCount field if non-nil, zero value otherwise. + +### GetPotentialRoleCountOk + +`func (o *RoleMiningSessionDto) GetPotentialRoleCountOk() (*int32, bool)` + +GetPotentialRoleCountOk returns a tuple with the PotentialRoleCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPotentialRoleCount + +`func (o *RoleMiningSessionDto) SetPotentialRoleCount(v int32)` + +SetPotentialRoleCount sets PotentialRoleCount field to given value. + +### HasPotentialRoleCount + +`func (o *RoleMiningSessionDto) HasPotentialRoleCount() bool` + +HasPotentialRoleCount returns a boolean if a field has been set. + +### GetPotentialRolesReadyCount + +`func (o *RoleMiningSessionDto) GetPotentialRolesReadyCount() int32` + +GetPotentialRolesReadyCount returns the PotentialRolesReadyCount field if non-nil, zero value otherwise. + +### GetPotentialRolesReadyCountOk + +`func (o *RoleMiningSessionDto) GetPotentialRolesReadyCountOk() (*int32, bool)` + +GetPotentialRolesReadyCountOk returns a tuple with the PotentialRolesReadyCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPotentialRolesReadyCount + +`func (o *RoleMiningSessionDto) SetPotentialRolesReadyCount(v int32)` + +SetPotentialRolesReadyCount sets PotentialRolesReadyCount field to given value. + +### HasPotentialRolesReadyCount + +`func (o *RoleMiningSessionDto) HasPotentialRolesReadyCount() bool` + +HasPotentialRolesReadyCount returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningSessionDto) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningSessionDto) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningSessionDto) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningSessionDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetEmailRecipientId + +`func (o *RoleMiningSessionDto) GetEmailRecipientId() string` + +GetEmailRecipientId returns the EmailRecipientId field if non-nil, zero value otherwise. + +### GetEmailRecipientIdOk + +`func (o *RoleMiningSessionDto) GetEmailRecipientIdOk() (*string, bool)` + +GetEmailRecipientIdOk returns a tuple with the EmailRecipientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailRecipientId + +`func (o *RoleMiningSessionDto) SetEmailRecipientId(v string)` + +SetEmailRecipientId sets EmailRecipientId field to given value. + +### HasEmailRecipientId + +`func (o *RoleMiningSessionDto) HasEmailRecipientId() bool` + +HasEmailRecipientId returns a boolean if a field has been set. + +### SetEmailRecipientIdNil + +`func (o *RoleMiningSessionDto) SetEmailRecipientIdNil(b bool)` + + SetEmailRecipientIdNil sets the value for EmailRecipientId to be an explicit nil + +### UnsetEmailRecipientId +`func (o *RoleMiningSessionDto) UnsetEmailRecipientId()` + +UnsetEmailRecipientId ensures that no value is present for EmailRecipientId, not even an explicit nil +### GetIdentityCount + +`func (o *RoleMiningSessionDto) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *RoleMiningSessionDto) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *RoleMiningSessionDto) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *RoleMiningSessionDto) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetSaved + +`func (o *RoleMiningSessionDto) GetSaved() bool` + +GetSaved returns the Saved field if non-nil, zero value otherwise. + +### GetSavedOk + +`func (o *RoleMiningSessionDto) GetSavedOk() (*bool, bool)` + +GetSavedOk returns a tuple with the Saved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSaved + +`func (o *RoleMiningSessionDto) SetSaved(v bool)` + +SetSaved sets Saved field to given value. + +### HasSaved + +`func (o *RoleMiningSessionDto) HasSaved() bool` + +HasSaved returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningSessionDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningSessionDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningSessionDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningSessionDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RoleMiningSessionDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RoleMiningSessionDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionParametersDto.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionParametersDto.md new file mode 100644 index 000000000..6b78206e4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionParametersDto.md @@ -0,0 +1,302 @@ +--- +id: v2025-role-mining-session-parameters-dto +title: RoleMiningSessionParametersDto +pagination_label: RoleMiningSessionParametersDto +sidebar_label: RoleMiningSessionParametersDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionParametersDto', 'V2025RoleMiningSessionParametersDto'] +slug: /tools/sdk/go/v2025/models/role-mining-session-parameters-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionParametersDto', 'V2025RoleMiningSessionParametersDto'] +--- + +# RoleMiningSessionParametersDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the role mining session | [optional] +**Name** | Pointer to **NullableString** | The session's saved name | [optional] +**MinNumIdentitiesInPotentialRole** | Pointer to **NullableInt32** | Minimum number of identities in a potential role | [optional] +**PruneThreshold** | Pointer to **NullableInt32** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [optional] +**Saved** | Pointer to **bool** | The session's saved status | [optional] [default to true] +**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**State** | Pointer to [**RoleMiningSessionState**](role-mining-session-state) | | [optional] +**ScopingMethod** | Pointer to [**RoleMiningSessionScopingMethod**](role-mining-session-scoping-method) | | [optional] + +## Methods + +### NewRoleMiningSessionParametersDto + +`func NewRoleMiningSessionParametersDto() *RoleMiningSessionParametersDto` + +NewRoleMiningSessionParametersDto instantiates a new RoleMiningSessionParametersDto 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 + +### NewRoleMiningSessionParametersDtoWithDefaults + +`func NewRoleMiningSessionParametersDtoWithDefaults() *RoleMiningSessionParametersDto` + +NewRoleMiningSessionParametersDtoWithDefaults instantiates a new RoleMiningSessionParametersDto 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 + +### GetId + +`func (o *RoleMiningSessionParametersDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningSessionParametersDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningSessionParametersDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningSessionParametersDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningSessionParametersDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningSessionParametersDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningSessionParametersDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningSessionParametersDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RoleMiningSessionParametersDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RoleMiningSessionParametersDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionParametersDto) GetMinNumIdentitiesInPotentialRole() int32` + +GetMinNumIdentitiesInPotentialRole returns the MinNumIdentitiesInPotentialRole field if non-nil, zero value otherwise. + +### GetMinNumIdentitiesInPotentialRoleOk + +`func (o *RoleMiningSessionParametersDto) GetMinNumIdentitiesInPotentialRoleOk() (*int32, bool)` + +GetMinNumIdentitiesInPotentialRoleOk returns a tuple with the MinNumIdentitiesInPotentialRole field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionParametersDto) SetMinNumIdentitiesInPotentialRole(v int32)` + +SetMinNumIdentitiesInPotentialRole sets MinNumIdentitiesInPotentialRole field to given value. + +### HasMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionParametersDto) HasMinNumIdentitiesInPotentialRole() bool` + +HasMinNumIdentitiesInPotentialRole returns a boolean if a field has been set. + +### SetMinNumIdentitiesInPotentialRoleNil + +`func (o *RoleMiningSessionParametersDto) SetMinNumIdentitiesInPotentialRoleNil(b bool)` + + SetMinNumIdentitiesInPotentialRoleNil sets the value for MinNumIdentitiesInPotentialRole to be an explicit nil + +### UnsetMinNumIdentitiesInPotentialRole +`func (o *RoleMiningSessionParametersDto) UnsetMinNumIdentitiesInPotentialRole()` + +UnsetMinNumIdentitiesInPotentialRole ensures that no value is present for MinNumIdentitiesInPotentialRole, not even an explicit nil +### GetPruneThreshold + +`func (o *RoleMiningSessionParametersDto) GetPruneThreshold() int32` + +GetPruneThreshold returns the PruneThreshold field if non-nil, zero value otherwise. + +### GetPruneThresholdOk + +`func (o *RoleMiningSessionParametersDto) GetPruneThresholdOk() (*int32, bool)` + +GetPruneThresholdOk returns a tuple with the PruneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPruneThreshold + +`func (o *RoleMiningSessionParametersDto) SetPruneThreshold(v int32)` + +SetPruneThreshold sets PruneThreshold field to given value. + +### HasPruneThreshold + +`func (o *RoleMiningSessionParametersDto) HasPruneThreshold() bool` + +HasPruneThreshold returns a boolean if a field has been set. + +### SetPruneThresholdNil + +`func (o *RoleMiningSessionParametersDto) SetPruneThresholdNil(b bool)` + + SetPruneThresholdNil sets the value for PruneThreshold to be an explicit nil + +### UnsetPruneThreshold +`func (o *RoleMiningSessionParametersDto) UnsetPruneThreshold()` + +UnsetPruneThreshold ensures that no value is present for PruneThreshold, not even an explicit nil +### GetSaved + +`func (o *RoleMiningSessionParametersDto) GetSaved() bool` + +GetSaved returns the Saved field if non-nil, zero value otherwise. + +### GetSavedOk + +`func (o *RoleMiningSessionParametersDto) GetSavedOk() (*bool, bool)` + +GetSavedOk returns a tuple with the Saved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSaved + +`func (o *RoleMiningSessionParametersDto) SetSaved(v bool)` + +SetSaved sets Saved field to given value. + +### HasSaved + +`func (o *RoleMiningSessionParametersDto) HasSaved() bool` + +HasSaved returns a boolean if a field has been set. + +### GetScope + +`func (o *RoleMiningSessionParametersDto) GetScope() RoleMiningSessionScope` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *RoleMiningSessionParametersDto) GetScopeOk() (*RoleMiningSessionScope, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *RoleMiningSessionParametersDto) SetScope(v RoleMiningSessionScope)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *RoleMiningSessionParametersDto) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningSessionParametersDto) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningSessionParametersDto) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningSessionParametersDto) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningSessionParametersDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetState + +`func (o *RoleMiningSessionParametersDto) GetState() RoleMiningSessionState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *RoleMiningSessionParametersDto) GetStateOk() (*RoleMiningSessionState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *RoleMiningSessionParametersDto) SetState(v RoleMiningSessionState)` + +SetState sets State field to given value. + +### HasState + +`func (o *RoleMiningSessionParametersDto) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetScopingMethod + +`func (o *RoleMiningSessionParametersDto) GetScopingMethod() RoleMiningSessionScopingMethod` + +GetScopingMethod returns the ScopingMethod field if non-nil, zero value otherwise. + +### GetScopingMethodOk + +`func (o *RoleMiningSessionParametersDto) GetScopingMethodOk() (*RoleMiningSessionScopingMethod, bool)` + +GetScopingMethodOk returns a tuple with the ScopingMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScopingMethod + +`func (o *RoleMiningSessionParametersDto) SetScopingMethod(v RoleMiningSessionScopingMethod)` + +SetScopingMethod sets ScopingMethod field to given value. + +### HasScopingMethod + +`func (o *RoleMiningSessionParametersDto) HasScopingMethod() bool` + +HasScopingMethod returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionResponse.md new file mode 100644 index 000000000..d95a80bb2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionResponse.md @@ -0,0 +1,576 @@ +--- +id: v2025-role-mining-session-response +title: RoleMiningSessionResponse +pagination_label: RoleMiningSessionResponse +sidebar_label: RoleMiningSessionResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionResponse', 'V2025RoleMiningSessionResponse'] +slug: /tools/sdk/go/v2025/models/role-mining-session-response +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionResponse', 'V2025RoleMiningSessionResponse'] +--- + +# RoleMiningSessionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**MinNumIdentitiesInPotentialRole** | Pointer to **NullableInt32** | Minimum number of identities in a potential role | [optional] +**ScopingMethod** | Pointer to **NullableString** | The scoping method of the role mining session | [optional] +**PrescribedPruneThreshold** | Pointer to **NullableInt32** | The computed (or prescribed) prune threshold for this session | [optional] +**PruneThreshold** | Pointer to **NullableInt32** | The prune threshold to be used for this role mining session | [optional] +**PotentialRoleCount** | Pointer to **int32** | The number of potential roles | [optional] +**PotentialRolesReadyCount** | Pointer to **int32** | The number of potential roles which have completed processing | [optional] +**Status** | Pointer to [**RoleMiningSessionStatus**](role-mining-session-status) | | [optional] +**EmailRecipientId** | Pointer to **NullableString** | The id of the user who will receive an email about the role mining session | [optional] +**CreatedBy** | Pointer to [**RoleMiningSessionResponseCreatedBy**](role-mining-session-response-created-by) | | [optional] +**IdentityCount** | Pointer to **int32** | The number of identities | [optional] +**Saved** | Pointer to **bool** | The session's saved status | [optional] [default to false] +**Name** | Pointer to **NullableString** | The session's saved name | [optional] +**DataFilePath** | Pointer to **NullableString** | The data file path of the role mining session | [optional] +**Id** | Pointer to **string** | Session Id for this role mining session | [optional] +**CreatedDate** | Pointer to **SailPointTime** | The date-time when this role mining session was created. | [optional] +**ModifiedDate** | Pointer to **SailPointTime** | The date-time when this role mining session was completed. | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] + +## Methods + +### NewRoleMiningSessionResponse + +`func NewRoleMiningSessionResponse() *RoleMiningSessionResponse` + +NewRoleMiningSessionResponse instantiates a new RoleMiningSessionResponse 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 + +### NewRoleMiningSessionResponseWithDefaults + +`func NewRoleMiningSessionResponseWithDefaults() *RoleMiningSessionResponse` + +NewRoleMiningSessionResponseWithDefaults instantiates a new RoleMiningSessionResponse 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 + +### GetScope + +`func (o *RoleMiningSessionResponse) GetScope() RoleMiningSessionScope` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *RoleMiningSessionResponse) GetScopeOk() (*RoleMiningSessionScope, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *RoleMiningSessionResponse) SetScope(v RoleMiningSessionScope)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *RoleMiningSessionResponse) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### GetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionResponse) GetMinNumIdentitiesInPotentialRole() int32` + +GetMinNumIdentitiesInPotentialRole returns the MinNumIdentitiesInPotentialRole field if non-nil, zero value otherwise. + +### GetMinNumIdentitiesInPotentialRoleOk + +`func (o *RoleMiningSessionResponse) GetMinNumIdentitiesInPotentialRoleOk() (*int32, bool)` + +GetMinNumIdentitiesInPotentialRoleOk returns a tuple with the MinNumIdentitiesInPotentialRole field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionResponse) SetMinNumIdentitiesInPotentialRole(v int32)` + +SetMinNumIdentitiesInPotentialRole sets MinNumIdentitiesInPotentialRole field to given value. + +### HasMinNumIdentitiesInPotentialRole + +`func (o *RoleMiningSessionResponse) HasMinNumIdentitiesInPotentialRole() bool` + +HasMinNumIdentitiesInPotentialRole returns a boolean if a field has been set. + +### SetMinNumIdentitiesInPotentialRoleNil + +`func (o *RoleMiningSessionResponse) SetMinNumIdentitiesInPotentialRoleNil(b bool)` + + SetMinNumIdentitiesInPotentialRoleNil sets the value for MinNumIdentitiesInPotentialRole to be an explicit nil + +### UnsetMinNumIdentitiesInPotentialRole +`func (o *RoleMiningSessionResponse) UnsetMinNumIdentitiesInPotentialRole()` + +UnsetMinNumIdentitiesInPotentialRole ensures that no value is present for MinNumIdentitiesInPotentialRole, not even an explicit nil +### GetScopingMethod + +`func (o *RoleMiningSessionResponse) GetScopingMethod() string` + +GetScopingMethod returns the ScopingMethod field if non-nil, zero value otherwise. + +### GetScopingMethodOk + +`func (o *RoleMiningSessionResponse) GetScopingMethodOk() (*string, bool)` + +GetScopingMethodOk returns a tuple with the ScopingMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScopingMethod + +`func (o *RoleMiningSessionResponse) SetScopingMethod(v string)` + +SetScopingMethod sets ScopingMethod field to given value. + +### HasScopingMethod + +`func (o *RoleMiningSessionResponse) HasScopingMethod() bool` + +HasScopingMethod returns a boolean if a field has been set. + +### SetScopingMethodNil + +`func (o *RoleMiningSessionResponse) SetScopingMethodNil(b bool)` + + SetScopingMethodNil sets the value for ScopingMethod to be an explicit nil + +### UnsetScopingMethod +`func (o *RoleMiningSessionResponse) UnsetScopingMethod()` + +UnsetScopingMethod ensures that no value is present for ScopingMethod, not even an explicit nil +### GetPrescribedPruneThreshold + +`func (o *RoleMiningSessionResponse) GetPrescribedPruneThreshold() int32` + +GetPrescribedPruneThreshold returns the PrescribedPruneThreshold field if non-nil, zero value otherwise. + +### GetPrescribedPruneThresholdOk + +`func (o *RoleMiningSessionResponse) GetPrescribedPruneThresholdOk() (*int32, bool)` + +GetPrescribedPruneThresholdOk returns a tuple with the PrescribedPruneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrescribedPruneThreshold + +`func (o *RoleMiningSessionResponse) SetPrescribedPruneThreshold(v int32)` + +SetPrescribedPruneThreshold sets PrescribedPruneThreshold field to given value. + +### HasPrescribedPruneThreshold + +`func (o *RoleMiningSessionResponse) HasPrescribedPruneThreshold() bool` + +HasPrescribedPruneThreshold returns a boolean if a field has been set. + +### SetPrescribedPruneThresholdNil + +`func (o *RoleMiningSessionResponse) SetPrescribedPruneThresholdNil(b bool)` + + SetPrescribedPruneThresholdNil sets the value for PrescribedPruneThreshold to be an explicit nil + +### UnsetPrescribedPruneThreshold +`func (o *RoleMiningSessionResponse) UnsetPrescribedPruneThreshold()` + +UnsetPrescribedPruneThreshold ensures that no value is present for PrescribedPruneThreshold, not even an explicit nil +### GetPruneThreshold + +`func (o *RoleMiningSessionResponse) GetPruneThreshold() int32` + +GetPruneThreshold returns the PruneThreshold field if non-nil, zero value otherwise. + +### GetPruneThresholdOk + +`func (o *RoleMiningSessionResponse) GetPruneThresholdOk() (*int32, bool)` + +GetPruneThresholdOk returns a tuple with the PruneThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPruneThreshold + +`func (o *RoleMiningSessionResponse) SetPruneThreshold(v int32)` + +SetPruneThreshold sets PruneThreshold field to given value. + +### HasPruneThreshold + +`func (o *RoleMiningSessionResponse) HasPruneThreshold() bool` + +HasPruneThreshold returns a boolean if a field has been set. + +### SetPruneThresholdNil + +`func (o *RoleMiningSessionResponse) SetPruneThresholdNil(b bool)` + + SetPruneThresholdNil sets the value for PruneThreshold to be an explicit nil + +### UnsetPruneThreshold +`func (o *RoleMiningSessionResponse) UnsetPruneThreshold()` + +UnsetPruneThreshold ensures that no value is present for PruneThreshold, not even an explicit nil +### GetPotentialRoleCount + +`func (o *RoleMiningSessionResponse) GetPotentialRoleCount() int32` + +GetPotentialRoleCount returns the PotentialRoleCount field if non-nil, zero value otherwise. + +### GetPotentialRoleCountOk + +`func (o *RoleMiningSessionResponse) GetPotentialRoleCountOk() (*int32, bool)` + +GetPotentialRoleCountOk returns a tuple with the PotentialRoleCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPotentialRoleCount + +`func (o *RoleMiningSessionResponse) SetPotentialRoleCount(v int32)` + +SetPotentialRoleCount sets PotentialRoleCount field to given value. + +### HasPotentialRoleCount + +`func (o *RoleMiningSessionResponse) HasPotentialRoleCount() bool` + +HasPotentialRoleCount returns a boolean if a field has been set. + +### GetPotentialRolesReadyCount + +`func (o *RoleMiningSessionResponse) GetPotentialRolesReadyCount() int32` + +GetPotentialRolesReadyCount returns the PotentialRolesReadyCount field if non-nil, zero value otherwise. + +### GetPotentialRolesReadyCountOk + +`func (o *RoleMiningSessionResponse) GetPotentialRolesReadyCountOk() (*int32, bool)` + +GetPotentialRolesReadyCountOk returns a tuple with the PotentialRolesReadyCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPotentialRolesReadyCount + +`func (o *RoleMiningSessionResponse) SetPotentialRolesReadyCount(v int32)` + +SetPotentialRolesReadyCount sets PotentialRolesReadyCount field to given value. + +### HasPotentialRolesReadyCount + +`func (o *RoleMiningSessionResponse) HasPotentialRolesReadyCount() bool` + +HasPotentialRolesReadyCount returns a boolean if a field has been set. + +### GetStatus + +`func (o *RoleMiningSessionResponse) GetStatus() RoleMiningSessionStatus` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *RoleMiningSessionResponse) GetStatusOk() (*RoleMiningSessionStatus, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *RoleMiningSessionResponse) SetStatus(v RoleMiningSessionStatus)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *RoleMiningSessionResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetEmailRecipientId + +`func (o *RoleMiningSessionResponse) GetEmailRecipientId() string` + +GetEmailRecipientId returns the EmailRecipientId field if non-nil, zero value otherwise. + +### GetEmailRecipientIdOk + +`func (o *RoleMiningSessionResponse) GetEmailRecipientIdOk() (*string, bool)` + +GetEmailRecipientIdOk returns a tuple with the EmailRecipientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailRecipientId + +`func (o *RoleMiningSessionResponse) SetEmailRecipientId(v string)` + +SetEmailRecipientId sets EmailRecipientId field to given value. + +### HasEmailRecipientId + +`func (o *RoleMiningSessionResponse) HasEmailRecipientId() bool` + +HasEmailRecipientId returns a boolean if a field has been set. + +### SetEmailRecipientIdNil + +`func (o *RoleMiningSessionResponse) SetEmailRecipientIdNil(b bool)` + + SetEmailRecipientIdNil sets the value for EmailRecipientId to be an explicit nil + +### UnsetEmailRecipientId +`func (o *RoleMiningSessionResponse) UnsetEmailRecipientId()` + +UnsetEmailRecipientId ensures that no value is present for EmailRecipientId, not even an explicit nil +### GetCreatedBy + +`func (o *RoleMiningSessionResponse) GetCreatedBy() RoleMiningSessionResponseCreatedBy` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *RoleMiningSessionResponse) GetCreatedByOk() (*RoleMiningSessionResponseCreatedBy, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *RoleMiningSessionResponse) SetCreatedBy(v RoleMiningSessionResponseCreatedBy)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *RoleMiningSessionResponse) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *RoleMiningSessionResponse) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *RoleMiningSessionResponse) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *RoleMiningSessionResponse) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *RoleMiningSessionResponse) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetSaved + +`func (o *RoleMiningSessionResponse) GetSaved() bool` + +GetSaved returns the Saved field if non-nil, zero value otherwise. + +### GetSavedOk + +`func (o *RoleMiningSessionResponse) GetSavedOk() (*bool, bool)` + +GetSavedOk returns a tuple with the Saved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSaved + +`func (o *RoleMiningSessionResponse) SetSaved(v bool)` + +SetSaved sets Saved field to given value. + +### HasSaved + +`func (o *RoleMiningSessionResponse) HasSaved() bool` + +HasSaved returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMiningSessionResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMiningSessionResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMiningSessionResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMiningSessionResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RoleMiningSessionResponse) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RoleMiningSessionResponse) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDataFilePath + +`func (o *RoleMiningSessionResponse) GetDataFilePath() string` + +GetDataFilePath returns the DataFilePath field if non-nil, zero value otherwise. + +### GetDataFilePathOk + +`func (o *RoleMiningSessionResponse) GetDataFilePathOk() (*string, bool)` + +GetDataFilePathOk returns a tuple with the DataFilePath field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataFilePath + +`func (o *RoleMiningSessionResponse) SetDataFilePath(v string)` + +SetDataFilePath sets DataFilePath field to given value. + +### HasDataFilePath + +`func (o *RoleMiningSessionResponse) HasDataFilePath() bool` + +HasDataFilePath returns a boolean if a field has been set. + +### SetDataFilePathNil + +`func (o *RoleMiningSessionResponse) SetDataFilePathNil(b bool)` + + SetDataFilePathNil sets the value for DataFilePath to be an explicit nil + +### UnsetDataFilePath +`func (o *RoleMiningSessionResponse) UnsetDataFilePath()` + +UnsetDataFilePath ensures that no value is present for DataFilePath, not even an explicit nil +### GetId + +`func (o *RoleMiningSessionResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningSessionResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningSessionResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningSessionResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreatedDate + +`func (o *RoleMiningSessionResponse) GetCreatedDate() SailPointTime` + +GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise. + +### GetCreatedDateOk + +`func (o *RoleMiningSessionResponse) GetCreatedDateOk() (*SailPointTime, bool)` + +GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedDate + +`func (o *RoleMiningSessionResponse) SetCreatedDate(v SailPointTime)` + +SetCreatedDate sets CreatedDate field to given value. + +### HasCreatedDate + +`func (o *RoleMiningSessionResponse) HasCreatedDate() bool` + +HasCreatedDate returns a boolean if a field has been set. + +### GetModifiedDate + +`func (o *RoleMiningSessionResponse) GetModifiedDate() SailPointTime` + +GetModifiedDate returns the ModifiedDate field if non-nil, zero value otherwise. + +### GetModifiedDateOk + +`func (o *RoleMiningSessionResponse) GetModifiedDateOk() (*SailPointTime, bool)` + +GetModifiedDateOk returns a tuple with the ModifiedDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedDate + +`func (o *RoleMiningSessionResponse) SetModifiedDate(v SailPointTime)` + +SetModifiedDate sets ModifiedDate field to given value. + +### HasModifiedDate + +`func (o *RoleMiningSessionResponse) HasModifiedDate() bool` + +HasModifiedDate returns a boolean if a field has been set. + +### GetType + +`func (o *RoleMiningSessionResponse) GetType() RoleMiningRoleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMiningSessionResponse) GetTypeOk() (*RoleMiningRoleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMiningSessionResponse) SetType(v RoleMiningRoleType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMiningSessionResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionResponseCreatedBy.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionResponseCreatedBy.md new file mode 100644 index 000000000..2976a2518 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionResponseCreatedBy.md @@ -0,0 +1,90 @@ +--- +id: v2025-role-mining-session-response-created-by +title: RoleMiningSessionResponseCreatedBy +pagination_label: RoleMiningSessionResponseCreatedBy +sidebar_label: RoleMiningSessionResponseCreatedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionResponseCreatedBy', 'V2025RoleMiningSessionResponseCreatedBy'] +slug: /tools/sdk/go/v2025/models/role-mining-session-response-created-by +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionResponseCreatedBy', 'V2025RoleMiningSessionResponseCreatedBy'] +--- + +# RoleMiningSessionResponseCreatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the creator | [optional] +**DisplayName** | Pointer to **string** | The display name of the creator | [optional] + +## Methods + +### NewRoleMiningSessionResponseCreatedBy + +`func NewRoleMiningSessionResponseCreatedBy() *RoleMiningSessionResponseCreatedBy` + +NewRoleMiningSessionResponseCreatedBy instantiates a new RoleMiningSessionResponseCreatedBy 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 + +### NewRoleMiningSessionResponseCreatedByWithDefaults + +`func NewRoleMiningSessionResponseCreatedByWithDefaults() *RoleMiningSessionResponseCreatedBy` + +NewRoleMiningSessionResponseCreatedByWithDefaults instantiates a new RoleMiningSessionResponseCreatedBy 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 + +### GetId + +`func (o *RoleMiningSessionResponseCreatedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMiningSessionResponseCreatedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMiningSessionResponseCreatedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMiningSessionResponseCreatedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *RoleMiningSessionResponseCreatedBy) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *RoleMiningSessionResponseCreatedBy) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *RoleMiningSessionResponseCreatedBy) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *RoleMiningSessionResponseCreatedBy) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionScope.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionScope.md new file mode 100644 index 000000000..a1ec4ae64 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionScope.md @@ -0,0 +1,136 @@ +--- +id: v2025-role-mining-session-scope +title: RoleMiningSessionScope +pagination_label: RoleMiningSessionScope +sidebar_label: RoleMiningSessionScope +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionScope', 'V2025RoleMiningSessionScope'] +slug: /tools/sdk/go/v2025/models/role-mining-session-scope +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionScope', 'V2025RoleMiningSessionScope'] +--- + +# RoleMiningSessionScope + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityIds** | Pointer to **[]string** | The list of identities for this role mining session. | [optional] +**Criteria** | Pointer to **NullableString** | The \"search\" criteria that produces the list of identities for this role mining session. | [optional] +**AttributeFilterCriteria** | Pointer to **[]map[string]interface{}** | The filter criteria for this role mining session. | [optional] + +## Methods + +### NewRoleMiningSessionScope + +`func NewRoleMiningSessionScope() *RoleMiningSessionScope` + +NewRoleMiningSessionScope instantiates a new RoleMiningSessionScope 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 + +### NewRoleMiningSessionScopeWithDefaults + +`func NewRoleMiningSessionScopeWithDefaults() *RoleMiningSessionScope` + +NewRoleMiningSessionScopeWithDefaults instantiates a new RoleMiningSessionScope 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 + +### GetIdentityIds + +`func (o *RoleMiningSessionScope) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *RoleMiningSessionScope) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *RoleMiningSessionScope) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *RoleMiningSessionScope) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + +### GetCriteria + +`func (o *RoleMiningSessionScope) GetCriteria() string` + +GetCriteria returns the Criteria field if non-nil, zero value otherwise. + +### GetCriteriaOk + +`func (o *RoleMiningSessionScope) GetCriteriaOk() (*string, bool)` + +GetCriteriaOk returns a tuple with the Criteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteria + +`func (o *RoleMiningSessionScope) SetCriteria(v string)` + +SetCriteria sets Criteria field to given value. + +### HasCriteria + +`func (o *RoleMiningSessionScope) HasCriteria() bool` + +HasCriteria returns a boolean if a field has been set. + +### SetCriteriaNil + +`func (o *RoleMiningSessionScope) SetCriteriaNil(b bool)` + + SetCriteriaNil sets the value for Criteria to be an explicit nil + +### UnsetCriteria +`func (o *RoleMiningSessionScope) UnsetCriteria()` + +UnsetCriteria ensures that no value is present for Criteria, not even an explicit nil +### GetAttributeFilterCriteria + +`func (o *RoleMiningSessionScope) GetAttributeFilterCriteria() []map[string]interface{}` + +GetAttributeFilterCriteria returns the AttributeFilterCriteria field if non-nil, zero value otherwise. + +### GetAttributeFilterCriteriaOk + +`func (o *RoleMiningSessionScope) GetAttributeFilterCriteriaOk() (*[]map[string]interface{}, bool)` + +GetAttributeFilterCriteriaOk returns a tuple with the AttributeFilterCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeFilterCriteria + +`func (o *RoleMiningSessionScope) SetAttributeFilterCriteria(v []map[string]interface{})` + +SetAttributeFilterCriteria sets AttributeFilterCriteria field to given value. + +### HasAttributeFilterCriteria + +`func (o *RoleMiningSessionScope) HasAttributeFilterCriteria() bool` + +HasAttributeFilterCriteria returns a boolean if a field has been set. + +### SetAttributeFilterCriteriaNil + +`func (o *RoleMiningSessionScope) SetAttributeFilterCriteriaNil(b bool)` + + SetAttributeFilterCriteriaNil sets the value for AttributeFilterCriteria to be an explicit nil + +### UnsetAttributeFilterCriteria +`func (o *RoleMiningSessionScope) UnsetAttributeFilterCriteria()` + +UnsetAttributeFilterCriteria ensures that no value is present for AttributeFilterCriteria, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionScopingMethod.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionScopingMethod.md new file mode 100644 index 000000000..0f3558b79 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionScopingMethod.md @@ -0,0 +1,21 @@ +--- +id: v2025-role-mining-session-scoping-method +title: RoleMiningSessionScopingMethod +pagination_label: RoleMiningSessionScopingMethod +sidebar_label: RoleMiningSessionScopingMethod +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionScopingMethod', 'V2025RoleMiningSessionScopingMethod'] +slug: /tools/sdk/go/v2025/models/role-mining-session-scoping-method +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionScopingMethod', 'V2025RoleMiningSessionScopingMethod'] +--- + +# RoleMiningSessionScopingMethod + +## Enum + + +* `MANUAL` (value: `"MANUAL"`) + +* `AUTO_RM` (value: `"AUTO_RM"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionState.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionState.md new file mode 100644 index 000000000..487e6da7c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionState.md @@ -0,0 +1,29 @@ +--- +id: v2025-role-mining-session-state +title: RoleMiningSessionState +pagination_label: RoleMiningSessionState +sidebar_label: RoleMiningSessionState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionState', 'V2025RoleMiningSessionState'] +slug: /tools/sdk/go/v2025/models/role-mining-session-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionState', 'V2025RoleMiningSessionState'] +--- + +# RoleMiningSessionState + +## Enum + + +* `CREATED` (value: `"CREATED"`) + +* `UPDATED` (value: `"UPDATED"`) + +* `IDENTITIES_OBTAINED` (value: `"IDENTITIES_OBTAINED"`) + +* `PRUNE_THRESHOLD_OBTAINED` (value: `"PRUNE_THRESHOLD_OBTAINED"`) + +* `POTENTIAL_ROLES_PROCESSING` (value: `"POTENTIAL_ROLES_PROCESSING"`) + +* `POTENTIAL_ROLES_CREATED` (value: `"POTENTIAL_ROLES_CREATED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionStatus.md new file mode 100644 index 000000000..d8c416db6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleMiningSessionStatus.md @@ -0,0 +1,64 @@ +--- +id: v2025-role-mining-session-status +title: RoleMiningSessionStatus +pagination_label: RoleMiningSessionStatus +sidebar_label: RoleMiningSessionStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMiningSessionStatus', 'V2025RoleMiningSessionStatus'] +slug: /tools/sdk/go/v2025/models/role-mining-session-status +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionStatus', 'V2025RoleMiningSessionStatus'] +--- + +# RoleMiningSessionStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to [**RoleMiningSessionState**](role-mining-session-state) | | [optional] + +## Methods + +### NewRoleMiningSessionStatus + +`func NewRoleMiningSessionStatus() *RoleMiningSessionStatus` + +NewRoleMiningSessionStatus instantiates a new RoleMiningSessionStatus 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 + +### NewRoleMiningSessionStatusWithDefaults + +`func NewRoleMiningSessionStatusWithDefaults() *RoleMiningSessionStatus` + +NewRoleMiningSessionStatusWithDefaults instantiates a new RoleMiningSessionStatus 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 + +### GetState + +`func (o *RoleMiningSessionStatus) GetState() RoleMiningSessionState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *RoleMiningSessionStatus) GetStateOk() (*RoleMiningSessionState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *RoleMiningSessionStatus) SetState(v RoleMiningSessionState)` + +SetState sets State field to given value. + +### HasState + +`func (o *RoleMiningSessionStatus) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleSummary.md new file mode 100644 index 000000000..638b23172 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleSummary.md @@ -0,0 +1,256 @@ +--- +id: v2025-role-summary +title: RoleSummary +pagination_label: RoleSummary +sidebar_label: RoleSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleSummary', 'V2025RoleSummary'] +slug: /tools/sdk/go/v2025/models/role-summary +tags: ['SDK', 'Software Development Kit', 'RoleSummary', 'V2025RoleSummary'] +--- + +# RoleSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional] +**Disabled** | Pointer to **bool** | | [optional] +**Revocable** | Pointer to **bool** | | [optional] + +## Methods + +### NewRoleSummary + +`func NewRoleSummary() *RoleSummary` + +NewRoleSummary instantiates a new RoleSummary 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 + +### NewRoleSummaryWithDefaults + +`func NewRoleSummaryWithDefaults() *RoleSummary` + +NewRoleSummaryWithDefaults instantiates a new RoleSummary 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 + +### GetId + +`func (o *RoleSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleSummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleSummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleSummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleSummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleSummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleSummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *RoleSummary) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *RoleSummary) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *RoleSummary) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *RoleSummary) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleSummary) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleSummary) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleSummary) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleSummary) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleSummary) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleSummary) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *RoleSummary) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleSummary) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleSummary) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetOwner + +`func (o *RoleSummary) GetOwner() DisplayReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *RoleSummary) GetOwnerOk() (*DisplayReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *RoleSummary) SetOwner(v DisplayReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *RoleSummary) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDisabled + +`func (o *RoleSummary) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *RoleSummary) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *RoleSummary) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *RoleSummary) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetRevocable + +`func (o *RoleSummary) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *RoleSummary) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *RoleSummary) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *RoleSummary) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/RoleTargetDto.md b/docs/tools/sdk/go/Reference/V2025/Models/RoleTargetDto.md new file mode 100644 index 000000000..fa0c1d740 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/RoleTargetDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-role-target-dto +title: RoleTargetDto +pagination_label: RoleTargetDto +sidebar_label: RoleTargetDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleTargetDto', 'V2025RoleTargetDto'] +slug: /tools/sdk/go/v2025/models/role-target-dto +tags: ['SDK', 'Software Development Kit', 'RoleTargetDto', 'V2025RoleTargetDto'] +--- + +# RoleTargetDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] +**AccountInfo** | Pointer to [**AccountInfoDto**](account-info-dto) | | [optional] +**RoleName** | Pointer to **string** | Specific role name for this target if using multiple accounts | [optional] + +## Methods + +### NewRoleTargetDto + +`func NewRoleTargetDto() *RoleTargetDto` + +NewRoleTargetDto instantiates a new RoleTargetDto 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 + +### NewRoleTargetDtoWithDefaults + +`func NewRoleTargetDtoWithDefaults() *RoleTargetDto` + +NewRoleTargetDtoWithDefaults instantiates a new RoleTargetDto 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 + +### GetSource + +`func (o *RoleTargetDto) GetSource() BaseReferenceDto` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *RoleTargetDto) GetSourceOk() (*BaseReferenceDto, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *RoleTargetDto) SetSource(v BaseReferenceDto)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *RoleTargetDto) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAccountInfo + +`func (o *RoleTargetDto) GetAccountInfo() AccountInfoDto` + +GetAccountInfo returns the AccountInfo field if non-nil, zero value otherwise. + +### GetAccountInfoOk + +`func (o *RoleTargetDto) GetAccountInfoOk() (*AccountInfoDto, bool)` + +GetAccountInfoOk returns a tuple with the AccountInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountInfo + +`func (o *RoleTargetDto) SetAccountInfo(v AccountInfoDto)` + +SetAccountInfo sets AccountInfo field to given value. + +### HasAccountInfo + +`func (o *RoleTargetDto) HasAccountInfo() bool` + +HasAccountInfo returns a boolean if a field has been set. + +### GetRoleName + +`func (o *RoleTargetDto) GetRoleName() string` + +GetRoleName returns the RoleName field if non-nil, zero value otherwise. + +### GetRoleNameOk + +`func (o *RoleTargetDto) GetRoleNameOk() (*string, bool)` + +GetRoleNameOk returns a tuple with the RoleName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleName + +`func (o *RoleTargetDto) SetRoleName(v string)` + +SetRoleName sets RoleName field to given value. + +### HasRoleName + +`func (o *RoleTargetDto) HasRoleName() bool` + +HasRoleName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SavedSearch.md b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearch.md new file mode 100644 index 000000000..d0625fa14 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearch.md @@ -0,0 +1,488 @@ +--- +id: v2025-saved-search +title: SavedSearch +pagination_label: SavedSearch +sidebar_label: SavedSearch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearch', 'V2025SavedSearch'] +slug: /tools/sdk/go/v2025/models/saved-search +tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'V2025SavedSearch'] +--- + +# SavedSearch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the saved search. | [optional] +**Description** | Pointer to **NullableString** | The description of the saved search. | [optional] +**Created** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | +**Columns** | Pointer to [**map[string][]Column**](https://go.dev/tour/moretypes/6) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**Query** | **string** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | +**Fields** | Pointer to **[]string** | The fields to be searched against in a multi-field query. | [optional] +**OrderBy** | Pointer to **map[string][]string** | Sort by index. This takes precedence over the `sort` property. | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. | [optional] +**Filters** | Pointer to [**NullableSavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] +**Id** | Pointer to **string** | The saved search ID. | [optional] +**Owner** | Pointer to [**TypedReference**](typed-reference) | | [optional] +**OwnerId** | Pointer to **string** | The ID of the identity that owns this saved search. | [optional] +**Public** | Pointer to **bool** | Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. | [optional] [default to false] + +## Methods + +### NewSavedSearch + +`func NewSavedSearch(indices []Index, query string, ) *SavedSearch` + +NewSavedSearch instantiates a new SavedSearch 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 + +### NewSavedSearchWithDefaults + +`func NewSavedSearchWithDefaults() *SavedSearch` + +NewSavedSearchWithDefaults instantiates a new SavedSearch 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 + +### GetName + +`func (o *SavedSearch) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SavedSearch) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SavedSearch) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SavedSearch) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *SavedSearch) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SavedSearch) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SavedSearch) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SavedSearch) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *SavedSearch) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *SavedSearch) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCreated + +`func (o *SavedSearch) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SavedSearch) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SavedSearch) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SavedSearch) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *SavedSearch) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *SavedSearch) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *SavedSearch) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SavedSearch) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SavedSearch) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SavedSearch) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *SavedSearch) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *SavedSearch) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetIndices + +`func (o *SavedSearch) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *SavedSearch) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *SavedSearch) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + + +### GetColumns + +`func (o *SavedSearch) GetColumns() map[string][]Column` + +GetColumns returns the Columns field if non-nil, zero value otherwise. + +### GetColumnsOk + +`func (o *SavedSearch) GetColumnsOk() (*map[string][]Column, bool)` + +GetColumnsOk returns a tuple with the Columns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumns + +`func (o *SavedSearch) SetColumns(v map[string][]Column)` + +SetColumns sets Columns field to given value. + +### HasColumns + +`func (o *SavedSearch) HasColumns() bool` + +HasColumns returns a boolean if a field has been set. + +### GetQuery + +`func (o *SavedSearch) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SavedSearch) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SavedSearch) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetFields + +`func (o *SavedSearch) GetFields() []string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *SavedSearch) GetFieldsOk() (*[]string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *SavedSearch) SetFields(v []string)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *SavedSearch) HasFields() bool` + +HasFields returns a boolean if a field has been set. + +### SetFieldsNil + +`func (o *SavedSearch) SetFieldsNil(b bool)` + + SetFieldsNil sets the value for Fields to be an explicit nil + +### UnsetFields +`func (o *SavedSearch) UnsetFields()` + +UnsetFields ensures that no value is present for Fields, not even an explicit nil +### GetOrderBy + +`func (o *SavedSearch) GetOrderBy() map[string][]string` + +GetOrderBy returns the OrderBy field if non-nil, zero value otherwise. + +### GetOrderByOk + +`func (o *SavedSearch) GetOrderByOk() (*map[string][]string, bool)` + +GetOrderByOk returns a tuple with the OrderBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderBy + +`func (o *SavedSearch) SetOrderBy(v map[string][]string)` + +SetOrderBy sets OrderBy field to given value. + +### HasOrderBy + +`func (o *SavedSearch) HasOrderBy() bool` + +HasOrderBy returns a boolean if a field has been set. + +### SetOrderByNil + +`func (o *SavedSearch) SetOrderByNil(b bool)` + + SetOrderByNil sets the value for OrderBy to be an explicit nil + +### UnsetOrderBy +`func (o *SavedSearch) UnsetOrderBy()` + +UnsetOrderBy ensures that no value is present for OrderBy, not even an explicit nil +### GetSort + +`func (o *SavedSearch) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *SavedSearch) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *SavedSearch) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *SavedSearch) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### SetSortNil + +`func (o *SavedSearch) SetSortNil(b bool)` + + SetSortNil sets the value for Sort to be an explicit nil + +### UnsetSort +`func (o *SavedSearch) UnsetSort()` + +UnsetSort ensures that no value is present for Sort, not even an explicit nil +### GetFilters + +`func (o *SavedSearch) GetFilters() SavedSearchDetailFilters` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *SavedSearch) GetFiltersOk() (*SavedSearchDetailFilters, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *SavedSearch) SetFilters(v SavedSearchDetailFilters)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *SavedSearch) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### SetFiltersNil + +`func (o *SavedSearch) SetFiltersNil(b bool)` + + SetFiltersNil sets the value for Filters to be an explicit nil + +### UnsetFilters +`func (o *SavedSearch) UnsetFilters()` + +UnsetFilters ensures that no value is present for Filters, not even an explicit nil +### GetId + +`func (o *SavedSearch) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SavedSearch) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SavedSearch) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SavedSearch) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetOwner + +`func (o *SavedSearch) GetOwner() TypedReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *SavedSearch) GetOwnerOk() (*TypedReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *SavedSearch) SetOwner(v TypedReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *SavedSearch) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetOwnerId + +`func (o *SavedSearch) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *SavedSearch) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *SavedSearch) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *SavedSearch) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + +### GetPublic + +`func (o *SavedSearch) GetPublic() bool` + +GetPublic returns the Public field if non-nil, zero value otherwise. + +### GetPublicOk + +`func (o *SavedSearch) GetPublicOk() (*bool, bool)` + +GetPublicOk returns a tuple with the Public field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublic + +`func (o *SavedSearch) SetPublic(v bool)` + +SetPublic sets Public field to given value. + +### HasPublic + +`func (o *SavedSearch) HasPublic() bool` + +HasPublic returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchComplete.md b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchComplete.md new file mode 100644 index 000000000..3104b030c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchComplete.md @@ -0,0 +1,185 @@ +--- +id: v2025-saved-search-complete +title: SavedSearchComplete +pagination_label: SavedSearchComplete +sidebar_label: SavedSearchComplete +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchComplete', 'V2025SavedSearchComplete'] +slug: /tools/sdk/go/v2025/models/saved-search-complete +tags: ['SDK', 'Software Development Kit', 'SavedSearchComplete', 'V2025SavedSearchComplete'] +--- + +# SavedSearchComplete + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FileName** | **string** | A name for the report file. | +**OwnerEmail** | **string** | The email address of the identity that owns the saved search. | +**OwnerName** | **string** | The name of the identity that owns the saved search. | +**Query** | **string** | The search query that was used to generate the report. | +**SearchName** | **string** | The name of the saved search. | +**SearchResults** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | +**SignedS3Url** | **string** | The Amazon S3 URL to download the report from. | + +## Methods + +### NewSavedSearchComplete + +`func NewSavedSearchComplete(fileName string, ownerEmail string, ownerName string, query string, searchName string, searchResults SavedSearchCompleteSearchResults, signedS3Url string, ) *SavedSearchComplete` + +NewSavedSearchComplete instantiates a new SavedSearchComplete 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 + +### NewSavedSearchCompleteWithDefaults + +`func NewSavedSearchCompleteWithDefaults() *SavedSearchComplete` + +NewSavedSearchCompleteWithDefaults instantiates a new SavedSearchComplete 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 + +### GetFileName + +`func (o *SavedSearchComplete) GetFileName() string` + +GetFileName returns the FileName field if non-nil, zero value otherwise. + +### GetFileNameOk + +`func (o *SavedSearchComplete) GetFileNameOk() (*string, bool)` + +GetFileNameOk returns a tuple with the FileName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileName + +`func (o *SavedSearchComplete) SetFileName(v string)` + +SetFileName sets FileName field to given value. + + +### GetOwnerEmail + +`func (o *SavedSearchComplete) GetOwnerEmail() string` + +GetOwnerEmail returns the OwnerEmail field if non-nil, zero value otherwise. + +### GetOwnerEmailOk + +`func (o *SavedSearchComplete) GetOwnerEmailOk() (*string, bool)` + +GetOwnerEmailOk returns a tuple with the OwnerEmail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerEmail + +`func (o *SavedSearchComplete) SetOwnerEmail(v string)` + +SetOwnerEmail sets OwnerEmail field to given value. + + +### GetOwnerName + +`func (o *SavedSearchComplete) GetOwnerName() string` + +GetOwnerName returns the OwnerName field if non-nil, zero value otherwise. + +### GetOwnerNameOk + +`func (o *SavedSearchComplete) GetOwnerNameOk() (*string, bool)` + +GetOwnerNameOk returns a tuple with the OwnerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerName + +`func (o *SavedSearchComplete) SetOwnerName(v string)` + +SetOwnerName sets OwnerName field to given value. + + +### GetQuery + +`func (o *SavedSearchComplete) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SavedSearchComplete) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SavedSearchComplete) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetSearchName + +`func (o *SavedSearchComplete) GetSearchName() string` + +GetSearchName returns the SearchName field if non-nil, zero value otherwise. + +### GetSearchNameOk + +`func (o *SavedSearchComplete) GetSearchNameOk() (*string, bool)` + +GetSearchNameOk returns a tuple with the SearchName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchName + +`func (o *SavedSearchComplete) SetSearchName(v string)` + +SetSearchName sets SearchName field to given value. + + +### GetSearchResults + +`func (o *SavedSearchComplete) GetSearchResults() SavedSearchCompleteSearchResults` + +GetSearchResults returns the SearchResults field if non-nil, zero value otherwise. + +### GetSearchResultsOk + +`func (o *SavedSearchComplete) GetSearchResultsOk() (*SavedSearchCompleteSearchResults, bool)` + +GetSearchResultsOk returns a tuple with the SearchResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchResults + +`func (o *SavedSearchComplete) SetSearchResults(v SavedSearchCompleteSearchResults)` + +SetSearchResults sets SearchResults field to given value. + + +### GetSignedS3Url + +`func (o *SavedSearchComplete) GetSignedS3Url() string` + +GetSignedS3Url returns the SignedS3Url field if non-nil, zero value otherwise. + +### GetSignedS3UrlOk + +`func (o *SavedSearchComplete) GetSignedS3UrlOk() (*string, bool)` + +GetSignedS3UrlOk returns a tuple with the SignedS3Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignedS3Url + +`func (o *SavedSearchComplete) SetSignedS3Url(v string)` + +SetSignedS3Url sets SignedS3Url field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchCompleteSearchResults.md b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchCompleteSearchResults.md new file mode 100644 index 000000000..a7b94b5d1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchCompleteSearchResults.md @@ -0,0 +1,146 @@ +--- +id: v2025-saved-search-complete-search-results +title: SavedSearchCompleteSearchResults +pagination_label: SavedSearchCompleteSearchResults +sidebar_label: SavedSearchCompleteSearchResults +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchCompleteSearchResults', 'V2025SavedSearchCompleteSearchResults'] +slug: /tools/sdk/go/v2025/models/saved-search-complete-search-results +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResults', 'V2025SavedSearchCompleteSearchResults'] +--- + +# SavedSearchCompleteSearchResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Account** | Pointer to [**NullableSavedSearchCompleteSearchResultsAccount**](saved-search-complete-search-results-account) | | [optional] +**Entitlement** | Pointer to [**NullableSavedSearchCompleteSearchResultsEntitlement**](saved-search-complete-search-results-entitlement) | | [optional] +**Identity** | Pointer to [**NullableSavedSearchCompleteSearchResultsIdentity**](saved-search-complete-search-results-identity) | | [optional] + +## Methods + +### NewSavedSearchCompleteSearchResults + +`func NewSavedSearchCompleteSearchResults() *SavedSearchCompleteSearchResults` + +NewSavedSearchCompleteSearchResults instantiates a new SavedSearchCompleteSearchResults 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 + +### NewSavedSearchCompleteSearchResultsWithDefaults + +`func NewSavedSearchCompleteSearchResultsWithDefaults() *SavedSearchCompleteSearchResults` + +NewSavedSearchCompleteSearchResultsWithDefaults instantiates a new SavedSearchCompleteSearchResults 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 + +### GetAccount + +`func (o *SavedSearchCompleteSearchResults) GetAccount() SavedSearchCompleteSearchResultsAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *SavedSearchCompleteSearchResults) GetAccountOk() (*SavedSearchCompleteSearchResultsAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *SavedSearchCompleteSearchResults) SetAccount(v SavedSearchCompleteSearchResultsAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *SavedSearchCompleteSearchResults) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### SetAccountNil + +`func (o *SavedSearchCompleteSearchResults) SetAccountNil(b bool)` + + SetAccountNil sets the value for Account to be an explicit nil + +### UnsetAccount +`func (o *SavedSearchCompleteSearchResults) UnsetAccount()` + +UnsetAccount ensures that no value is present for Account, not even an explicit nil +### GetEntitlement + +`func (o *SavedSearchCompleteSearchResults) GetEntitlement() SavedSearchCompleteSearchResultsEntitlement` + +GetEntitlement returns the Entitlement field if non-nil, zero value otherwise. + +### GetEntitlementOk + +`func (o *SavedSearchCompleteSearchResults) GetEntitlementOk() (*SavedSearchCompleteSearchResultsEntitlement, bool)` + +GetEntitlementOk returns a tuple with the Entitlement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlement + +`func (o *SavedSearchCompleteSearchResults) SetEntitlement(v SavedSearchCompleteSearchResultsEntitlement)` + +SetEntitlement sets Entitlement field to given value. + +### HasEntitlement + +`func (o *SavedSearchCompleteSearchResults) HasEntitlement() bool` + +HasEntitlement returns a boolean if a field has been set. + +### SetEntitlementNil + +`func (o *SavedSearchCompleteSearchResults) SetEntitlementNil(b bool)` + + SetEntitlementNil sets the value for Entitlement to be an explicit nil + +### UnsetEntitlement +`func (o *SavedSearchCompleteSearchResults) UnsetEntitlement()` + +UnsetEntitlement ensures that no value is present for Entitlement, not even an explicit nil +### GetIdentity + +`func (o *SavedSearchCompleteSearchResults) GetIdentity() SavedSearchCompleteSearchResultsIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *SavedSearchCompleteSearchResults) GetIdentityOk() (*SavedSearchCompleteSearchResultsIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *SavedSearchCompleteSearchResults) SetIdentity(v SavedSearchCompleteSearchResultsIdentity)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *SavedSearchCompleteSearchResults) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### SetIdentityNil + +`func (o *SavedSearchCompleteSearchResults) SetIdentityNil(b bool)` + + SetIdentityNil sets the value for Identity to be an explicit nil + +### UnsetIdentity +`func (o *SavedSearchCompleteSearchResults) UnsetIdentity()` + +UnsetIdentity ensures that no value is present for Identity, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchCompleteSearchResultsAccount.md b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchCompleteSearchResultsAccount.md new file mode 100644 index 000000000..0c62cfd45 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchCompleteSearchResultsAccount.md @@ -0,0 +1,101 @@ +--- +id: v2025-saved-search-complete-search-results-account +title: SavedSearchCompleteSearchResultsAccount +pagination_label: SavedSearchCompleteSearchResultsAccount +sidebar_label: SavedSearchCompleteSearchResultsAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchCompleteSearchResultsAccount', 'V2025SavedSearchCompleteSearchResultsAccount'] +slug: /tools/sdk/go/v2025/models/saved-search-complete-search-results-account +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsAccount', 'V2025SavedSearchCompleteSearchResultsAccount'] +--- + +# SavedSearchCompleteSearchResultsAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **string** | The number of rows in the table. | +**Noun** | **string** | The type of object represented in the table. | +**Preview** | **[][]string** | A sample of the data in the table. | + +## Methods + +### NewSavedSearchCompleteSearchResultsAccount + +`func NewSavedSearchCompleteSearchResultsAccount(count string, noun string, preview [][]string, ) *SavedSearchCompleteSearchResultsAccount` + +NewSavedSearchCompleteSearchResultsAccount instantiates a new SavedSearchCompleteSearchResultsAccount 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 + +### NewSavedSearchCompleteSearchResultsAccountWithDefaults + +`func NewSavedSearchCompleteSearchResultsAccountWithDefaults() *SavedSearchCompleteSearchResultsAccount` + +NewSavedSearchCompleteSearchResultsAccountWithDefaults instantiates a new SavedSearchCompleteSearchResultsAccount 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 + +### GetCount + +`func (o *SavedSearchCompleteSearchResultsAccount) GetCount() string` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *SavedSearchCompleteSearchResultsAccount) GetCountOk() (*string, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *SavedSearchCompleteSearchResultsAccount) SetCount(v string)` + +SetCount sets Count field to given value. + + +### GetNoun + +`func (o *SavedSearchCompleteSearchResultsAccount) GetNoun() string` + +GetNoun returns the Noun field if non-nil, zero value otherwise. + +### GetNounOk + +`func (o *SavedSearchCompleteSearchResultsAccount) GetNounOk() (*string, bool)` + +GetNounOk returns a tuple with the Noun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNoun + +`func (o *SavedSearchCompleteSearchResultsAccount) SetNoun(v string)` + +SetNoun sets Noun field to given value. + + +### GetPreview + +`func (o *SavedSearchCompleteSearchResultsAccount) GetPreview() [][]string` + +GetPreview returns the Preview field if non-nil, zero value otherwise. + +### GetPreviewOk + +`func (o *SavedSearchCompleteSearchResultsAccount) GetPreviewOk() (*[][]string, bool)` + +GetPreviewOk returns a tuple with the Preview field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreview + +`func (o *SavedSearchCompleteSearchResultsAccount) SetPreview(v [][]string)` + +SetPreview sets Preview field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchCompleteSearchResultsEntitlement.md b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchCompleteSearchResultsEntitlement.md new file mode 100644 index 000000000..632e14ba2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchCompleteSearchResultsEntitlement.md @@ -0,0 +1,101 @@ +--- +id: v2025-saved-search-complete-search-results-entitlement +title: SavedSearchCompleteSearchResultsEntitlement +pagination_label: SavedSearchCompleteSearchResultsEntitlement +sidebar_label: SavedSearchCompleteSearchResultsEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchCompleteSearchResultsEntitlement', 'V2025SavedSearchCompleteSearchResultsEntitlement'] +slug: /tools/sdk/go/v2025/models/saved-search-complete-search-results-entitlement +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsEntitlement', 'V2025SavedSearchCompleteSearchResultsEntitlement'] +--- + +# SavedSearchCompleteSearchResultsEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **string** | The number of rows in the table. | +**Noun** | **string** | The type of object represented in the table. | +**Preview** | **[][]string** | A sample of the data in the table. | + +## Methods + +### NewSavedSearchCompleteSearchResultsEntitlement + +`func NewSavedSearchCompleteSearchResultsEntitlement(count string, noun string, preview [][]string, ) *SavedSearchCompleteSearchResultsEntitlement` + +NewSavedSearchCompleteSearchResultsEntitlement instantiates a new SavedSearchCompleteSearchResultsEntitlement 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 + +### NewSavedSearchCompleteSearchResultsEntitlementWithDefaults + +`func NewSavedSearchCompleteSearchResultsEntitlementWithDefaults() *SavedSearchCompleteSearchResultsEntitlement` + +NewSavedSearchCompleteSearchResultsEntitlementWithDefaults instantiates a new SavedSearchCompleteSearchResultsEntitlement 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 + +### GetCount + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetCount() string` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetCountOk() (*string, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *SavedSearchCompleteSearchResultsEntitlement) SetCount(v string)` + +SetCount sets Count field to given value. + + +### GetNoun + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetNoun() string` + +GetNoun returns the Noun field if non-nil, zero value otherwise. + +### GetNounOk + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetNounOk() (*string, bool)` + +GetNounOk returns a tuple with the Noun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNoun + +`func (o *SavedSearchCompleteSearchResultsEntitlement) SetNoun(v string)` + +SetNoun sets Noun field to given value. + + +### GetPreview + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetPreview() [][]string` + +GetPreview returns the Preview field if non-nil, zero value otherwise. + +### GetPreviewOk + +`func (o *SavedSearchCompleteSearchResultsEntitlement) GetPreviewOk() (*[][]string, bool)` + +GetPreviewOk returns a tuple with the Preview field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreview + +`func (o *SavedSearchCompleteSearchResultsEntitlement) SetPreview(v [][]string)` + +SetPreview sets Preview field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchCompleteSearchResultsIdentity.md b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchCompleteSearchResultsIdentity.md new file mode 100644 index 000000000..73c62d0ff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchCompleteSearchResultsIdentity.md @@ -0,0 +1,101 @@ +--- +id: v2025-saved-search-complete-search-results-identity +title: SavedSearchCompleteSearchResultsIdentity +pagination_label: SavedSearchCompleteSearchResultsIdentity +sidebar_label: SavedSearchCompleteSearchResultsIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchCompleteSearchResultsIdentity', 'V2025SavedSearchCompleteSearchResultsIdentity'] +slug: /tools/sdk/go/v2025/models/saved-search-complete-search-results-identity +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsIdentity', 'V2025SavedSearchCompleteSearchResultsIdentity'] +--- + +# SavedSearchCompleteSearchResultsIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **string** | The number of rows in the table. | +**Noun** | **string** | The type of object represented in the table. | +**Preview** | **[][]string** | A sample of the data in the table. | + +## Methods + +### NewSavedSearchCompleteSearchResultsIdentity + +`func NewSavedSearchCompleteSearchResultsIdentity(count string, noun string, preview [][]string, ) *SavedSearchCompleteSearchResultsIdentity` + +NewSavedSearchCompleteSearchResultsIdentity instantiates a new SavedSearchCompleteSearchResultsIdentity 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 + +### NewSavedSearchCompleteSearchResultsIdentityWithDefaults + +`func NewSavedSearchCompleteSearchResultsIdentityWithDefaults() *SavedSearchCompleteSearchResultsIdentity` + +NewSavedSearchCompleteSearchResultsIdentityWithDefaults instantiates a new SavedSearchCompleteSearchResultsIdentity 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 + +### GetCount + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetCount() string` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetCountOk() (*string, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *SavedSearchCompleteSearchResultsIdentity) SetCount(v string)` + +SetCount sets Count field to given value. + + +### GetNoun + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetNoun() string` + +GetNoun returns the Noun field if non-nil, zero value otherwise. + +### GetNounOk + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetNounOk() (*string, bool)` + +GetNounOk returns a tuple with the Noun field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNoun + +`func (o *SavedSearchCompleteSearchResultsIdentity) SetNoun(v string)` + +SetNoun sets Noun field to given value. + + +### GetPreview + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetPreview() [][]string` + +GetPreview returns the Preview field if non-nil, zero value otherwise. + +### GetPreviewOk + +`func (o *SavedSearchCompleteSearchResultsIdentity) GetPreviewOk() (*[][]string, bool)` + +GetPreviewOk returns a tuple with the Preview field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreview + +`func (o *SavedSearchCompleteSearchResultsIdentity) SetPreview(v [][]string)` + +SetPreview sets Preview field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchDetail.md b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchDetail.md new file mode 100644 index 000000000..bc1989c39 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchDetail.md @@ -0,0 +1,322 @@ +--- +id: v2025-saved-search-detail +title: SavedSearchDetail +pagination_label: SavedSearchDetail +sidebar_label: SavedSearchDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchDetail', 'V2025SavedSearchDetail'] +slug: /tools/sdk/go/v2025/models/saved-search-detail +tags: ['SDK', 'Software Development Kit', 'SavedSearchDetail', 'V2025SavedSearchDetail'] +--- + +# SavedSearchDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | +**Columns** | Pointer to [**map[string][]Column**](https://go.dev/tour/moretypes/6) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**Query** | **string** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | +**Fields** | Pointer to **[]string** | The fields to be searched against in a multi-field query. | [optional] +**OrderBy** | Pointer to **map[string][]string** | Sort by index. This takes precedence over the `sort` property. | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. | [optional] +**Filters** | Pointer to [**NullableSavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] + +## Methods + +### NewSavedSearchDetail + +`func NewSavedSearchDetail(indices []Index, query string, ) *SavedSearchDetail` + +NewSavedSearchDetail instantiates a new SavedSearchDetail 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 + +### NewSavedSearchDetailWithDefaults + +`func NewSavedSearchDetailWithDefaults() *SavedSearchDetail` + +NewSavedSearchDetailWithDefaults instantiates a new SavedSearchDetail 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 + +### GetCreated + +`func (o *SavedSearchDetail) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SavedSearchDetail) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SavedSearchDetail) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SavedSearchDetail) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *SavedSearchDetail) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *SavedSearchDetail) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *SavedSearchDetail) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SavedSearchDetail) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SavedSearchDetail) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SavedSearchDetail) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *SavedSearchDetail) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *SavedSearchDetail) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetIndices + +`func (o *SavedSearchDetail) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *SavedSearchDetail) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *SavedSearchDetail) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + + +### GetColumns + +`func (o *SavedSearchDetail) GetColumns() map[string][]Column` + +GetColumns returns the Columns field if non-nil, zero value otherwise. + +### GetColumnsOk + +`func (o *SavedSearchDetail) GetColumnsOk() (*map[string][]Column, bool)` + +GetColumnsOk returns a tuple with the Columns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumns + +`func (o *SavedSearchDetail) SetColumns(v map[string][]Column)` + +SetColumns sets Columns field to given value. + +### HasColumns + +`func (o *SavedSearchDetail) HasColumns() bool` + +HasColumns returns a boolean if a field has been set. + +### GetQuery + +`func (o *SavedSearchDetail) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SavedSearchDetail) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SavedSearchDetail) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetFields + +`func (o *SavedSearchDetail) GetFields() []string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *SavedSearchDetail) GetFieldsOk() (*[]string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *SavedSearchDetail) SetFields(v []string)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *SavedSearchDetail) HasFields() bool` + +HasFields returns a boolean if a field has been set. + +### SetFieldsNil + +`func (o *SavedSearchDetail) SetFieldsNil(b bool)` + + SetFieldsNil sets the value for Fields to be an explicit nil + +### UnsetFields +`func (o *SavedSearchDetail) UnsetFields()` + +UnsetFields ensures that no value is present for Fields, not even an explicit nil +### GetOrderBy + +`func (o *SavedSearchDetail) GetOrderBy() map[string][]string` + +GetOrderBy returns the OrderBy field if non-nil, zero value otherwise. + +### GetOrderByOk + +`func (o *SavedSearchDetail) GetOrderByOk() (*map[string][]string, bool)` + +GetOrderByOk returns a tuple with the OrderBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderBy + +`func (o *SavedSearchDetail) SetOrderBy(v map[string][]string)` + +SetOrderBy sets OrderBy field to given value. + +### HasOrderBy + +`func (o *SavedSearchDetail) HasOrderBy() bool` + +HasOrderBy returns a boolean if a field has been set. + +### SetOrderByNil + +`func (o *SavedSearchDetail) SetOrderByNil(b bool)` + + SetOrderByNil sets the value for OrderBy to be an explicit nil + +### UnsetOrderBy +`func (o *SavedSearchDetail) UnsetOrderBy()` + +UnsetOrderBy ensures that no value is present for OrderBy, not even an explicit nil +### GetSort + +`func (o *SavedSearchDetail) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *SavedSearchDetail) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *SavedSearchDetail) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *SavedSearchDetail) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### SetSortNil + +`func (o *SavedSearchDetail) SetSortNil(b bool)` + + SetSortNil sets the value for Sort to be an explicit nil + +### UnsetSort +`func (o *SavedSearchDetail) UnsetSort()` + +UnsetSort ensures that no value is present for Sort, not even an explicit nil +### GetFilters + +`func (o *SavedSearchDetail) GetFilters() SavedSearchDetailFilters` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *SavedSearchDetail) GetFiltersOk() (*SavedSearchDetailFilters, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *SavedSearchDetail) SetFilters(v SavedSearchDetailFilters)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *SavedSearchDetail) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### SetFiltersNil + +`func (o *SavedSearchDetail) SetFiltersNil(b bool)` + + SetFiltersNil sets the value for Filters to be an explicit nil + +### UnsetFilters +`func (o *SavedSearchDetail) UnsetFilters()` + +UnsetFilters ensures that no value is present for Filters, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchDetailFilters.md b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchDetailFilters.md new file mode 100644 index 000000000..68a59578b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchDetailFilters.md @@ -0,0 +1,142 @@ +--- +id: v2025-saved-search-detail-filters +title: SavedSearchDetailFilters +pagination_label: SavedSearchDetailFilters +sidebar_label: SavedSearchDetailFilters +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchDetailFilters', 'V2025SavedSearchDetailFilters'] +slug: /tools/sdk/go/v2025/models/saved-search-detail-filters +tags: ['SDK', 'Software Development Kit', 'SavedSearchDetailFilters', 'V2025SavedSearchDetailFilters'] +--- + +# SavedSearchDetailFilters + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**FilterType**](filter-type) | | [optional] +**Range** | Pointer to [**Range**](range) | | [optional] +**Terms** | Pointer to **[]string** | The terms to be filtered. | [optional] +**Exclude** | Pointer to **bool** | Indicates if the filter excludes results. | [optional] [default to false] + +## Methods + +### NewSavedSearchDetailFilters + +`func NewSavedSearchDetailFilters() *SavedSearchDetailFilters` + +NewSavedSearchDetailFilters instantiates a new SavedSearchDetailFilters 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 + +### NewSavedSearchDetailFiltersWithDefaults + +`func NewSavedSearchDetailFiltersWithDefaults() *SavedSearchDetailFilters` + +NewSavedSearchDetailFiltersWithDefaults instantiates a new SavedSearchDetailFilters 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 + +### GetType + +`func (o *SavedSearchDetailFilters) GetType() FilterType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SavedSearchDetailFilters) GetTypeOk() (*FilterType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SavedSearchDetailFilters) SetType(v FilterType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SavedSearchDetailFilters) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRange + +`func (o *SavedSearchDetailFilters) GetRange() Range` + +GetRange returns the Range field if non-nil, zero value otherwise. + +### GetRangeOk + +`func (o *SavedSearchDetailFilters) GetRangeOk() (*Range, bool)` + +GetRangeOk returns a tuple with the Range field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRange + +`func (o *SavedSearchDetailFilters) SetRange(v Range)` + +SetRange sets Range field to given value. + +### HasRange + +`func (o *SavedSearchDetailFilters) HasRange() bool` + +HasRange returns a boolean if a field has been set. + +### GetTerms + +`func (o *SavedSearchDetailFilters) GetTerms() []string` + +GetTerms returns the Terms field if non-nil, zero value otherwise. + +### GetTermsOk + +`func (o *SavedSearchDetailFilters) GetTermsOk() (*[]string, bool)` + +GetTermsOk returns a tuple with the Terms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerms + +`func (o *SavedSearchDetailFilters) SetTerms(v []string)` + +SetTerms sets Terms field to given value. + +### HasTerms + +`func (o *SavedSearchDetailFilters) HasTerms() bool` + +HasTerms returns a boolean if a field has been set. + +### GetExclude + +`func (o *SavedSearchDetailFilters) GetExclude() bool` + +GetExclude returns the Exclude field if non-nil, zero value otherwise. + +### GetExcludeOk + +`func (o *SavedSearchDetailFilters) GetExcludeOk() (*bool, bool)` + +GetExcludeOk returns a tuple with the Exclude field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExclude + +`func (o *SavedSearchDetailFilters) SetExclude(v bool)` + +SetExclude sets Exclude field to given value. + +### HasExclude + +`func (o *SavedSearchDetailFilters) HasExclude() bool` + +HasExclude returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchName.md b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchName.md new file mode 100644 index 000000000..a96c805c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SavedSearchName.md @@ -0,0 +1,100 @@ +--- +id: v2025-saved-search-name +title: SavedSearchName +pagination_label: SavedSearchName +sidebar_label: SavedSearchName +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchName', 'V2025SavedSearchName'] +slug: /tools/sdk/go/v2025/models/saved-search-name +tags: ['SDK', 'Software Development Kit', 'SavedSearchName', 'V2025SavedSearchName'] +--- + +# SavedSearchName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the saved search. | [optional] +**Description** | Pointer to **NullableString** | The description of the saved search. | [optional] + +## Methods + +### NewSavedSearchName + +`func NewSavedSearchName() *SavedSearchName` + +NewSavedSearchName instantiates a new SavedSearchName 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 + +### NewSavedSearchNameWithDefaults + +`func NewSavedSearchNameWithDefaults() *SavedSearchName` + +NewSavedSearchNameWithDefaults instantiates a new SavedSearchName 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 + +### GetName + +`func (o *SavedSearchName) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SavedSearchName) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SavedSearchName) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SavedSearchName) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *SavedSearchName) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SavedSearchName) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SavedSearchName) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SavedSearchName) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *SavedSearchName) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *SavedSearchName) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Schedule.md b/docs/tools/sdk/go/Reference/V2025/Models/Schedule.md new file mode 100644 index 000000000..e17aea905 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Schedule.md @@ -0,0 +1,204 @@ +--- +id: v2025-schedule +title: Schedule +pagination_label: Schedule +sidebar_label: Schedule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule', 'V2025Schedule'] +slug: /tools/sdk/go/v2025/models/schedule +tags: ['SDK', 'Software Development Kit', 'Schedule', 'V2025Schedule'] +--- + +# Schedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set. | +**Months** | Pointer to [**NullableScheduleMonths**](schedule-months) | | [optional] +**Days** | Pointer to [**ScheduleDays**](schedule-days) | | [optional] +**Hours** | [**ScheduleHours**](schedule-hours) | | +**Expiration** | Pointer to **NullableTime** | Specifies the time after which this schedule will no longer occur. | [optional] +**TimeZoneId** | Pointer to **string** | The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST. | [optional] + +## Methods + +### NewSchedule + +`func NewSchedule(type_ string, hours ScheduleHours, ) *Schedule` + +NewSchedule instantiates a new Schedule 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 + +### NewScheduleWithDefaults + +`func NewScheduleWithDefaults() *Schedule` + +NewScheduleWithDefaults instantiates a new Schedule 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 + +### GetType + +`func (o *Schedule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Schedule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Schedule) SetType(v string)` + +SetType sets Type field to given value. + + +### GetMonths + +`func (o *Schedule) GetMonths() ScheduleMonths` + +GetMonths returns the Months field if non-nil, zero value otherwise. + +### GetMonthsOk + +`func (o *Schedule) GetMonthsOk() (*ScheduleMonths, bool)` + +GetMonthsOk returns a tuple with the Months field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMonths + +`func (o *Schedule) SetMonths(v ScheduleMonths)` + +SetMonths sets Months field to given value. + +### HasMonths + +`func (o *Schedule) HasMonths() bool` + +HasMonths returns a boolean if a field has been set. + +### SetMonthsNil + +`func (o *Schedule) SetMonthsNil(b bool)` + + SetMonthsNil sets the value for Months to be an explicit nil + +### UnsetMonths +`func (o *Schedule) UnsetMonths()` + +UnsetMonths ensures that no value is present for Months, not even an explicit nil +### GetDays + +`func (o *Schedule) GetDays() ScheduleDays` + +GetDays returns the Days field if non-nil, zero value otherwise. + +### GetDaysOk + +`func (o *Schedule) GetDaysOk() (*ScheduleDays, bool)` + +GetDaysOk returns a tuple with the Days field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDays + +`func (o *Schedule) SetDays(v ScheduleDays)` + +SetDays sets Days field to given value. + +### HasDays + +`func (o *Schedule) HasDays() bool` + +HasDays returns a boolean if a field has been set. + +### GetHours + +`func (o *Schedule) GetHours() ScheduleHours` + +GetHours returns the Hours field if non-nil, zero value otherwise. + +### GetHoursOk + +`func (o *Schedule) GetHoursOk() (*ScheduleHours, bool)` + +GetHoursOk returns a tuple with the Hours field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHours + +`func (o *Schedule) SetHours(v ScheduleHours)` + +SetHours sets Hours field to given value. + + +### GetExpiration + +`func (o *Schedule) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *Schedule) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *Schedule) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *Schedule) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + +### SetExpirationNil + +`func (o *Schedule) SetExpirationNil(b bool)` + + SetExpirationNil sets the value for Expiration to be an explicit nil + +### UnsetExpiration +`func (o *Schedule) UnsetExpiration()` + +UnsetExpiration ensures that no value is present for Expiration, not even an explicit nil +### GetTimeZoneId + +`func (o *Schedule) GetTimeZoneId() string` + +GetTimeZoneId returns the TimeZoneId field if non-nil, zero value otherwise. + +### GetTimeZoneIdOk + +`func (o *Schedule) GetTimeZoneIdOk() (*string, bool)` + +GetTimeZoneIdOk returns a tuple with the TimeZoneId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZoneId + +`func (o *Schedule) SetTimeZoneId(v string)` + +SetTimeZoneId sets TimeZoneId field to given value. + +### HasTimeZoneId + +`func (o *Schedule) HasTimeZoneId() bool` + +HasTimeZoneId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Schedule1.md b/docs/tools/sdk/go/Reference/V2025/Models/Schedule1.md new file mode 100644 index 000000000..2b6531d93 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Schedule1.md @@ -0,0 +1,80 @@ +--- +id: v2025-schedule1 +title: Schedule1 +pagination_label: Schedule1 +sidebar_label: Schedule1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule1', 'V2025Schedule1'] +slug: /tools/sdk/go/v2025/models/schedule1 +tags: ['SDK', 'Software Development Kit', 'Schedule1', 'V2025Schedule1'] +--- + +# Schedule1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of the Schedule. | +**CronExpression** | **string** | The cron expression of the schedule. | + +## Methods + +### NewSchedule1 + +`func NewSchedule1(type_ string, cronExpression string, ) *Schedule1` + +NewSchedule1 instantiates a new Schedule1 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 + +### NewSchedule1WithDefaults + +`func NewSchedule1WithDefaults() *Schedule1` + +NewSchedule1WithDefaults instantiates a new Schedule1 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 + +### GetType + +`func (o *Schedule1) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Schedule1) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Schedule1) SetType(v string)` + +SetType sets Type field to given value. + + +### GetCronExpression + +`func (o *Schedule1) GetCronExpression() string` + +GetCronExpression returns the CronExpression field if non-nil, zero value otherwise. + +### GetCronExpressionOk + +`func (o *Schedule1) GetCronExpressionOk() (*string, bool)` + +GetCronExpressionOk returns a tuple with the CronExpression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCronExpression + +`func (o *Schedule1) SetCronExpression(v string)` + +SetCronExpression sets CronExpression field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Schedule2.md b/docs/tools/sdk/go/Reference/V2025/Models/Schedule2.md new file mode 100644 index 000000000..6d9031e15 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Schedule2.md @@ -0,0 +1,204 @@ +--- +id: v2025-schedule2 +title: Schedule2 +pagination_label: Schedule2 +sidebar_label: Schedule2 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule2', 'V2025Schedule2'] +slug: /tools/sdk/go/v2025/models/schedule2 +tags: ['SDK', 'Software Development Kit', 'Schedule2', 'V2025Schedule2'] +--- + +# Schedule2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**ScheduleType**](schedule-type) | | +**Months** | Pointer to [**Schedule2Months**](schedule2-months) | | [optional] +**Days** | Pointer to [**Schedule2Days**](schedule2-days) | | [optional] +**Hours** | [**Schedule2Hours**](schedule2-hours) | | +**Expiration** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**TimeZoneId** | Pointer to **NullableString** | The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used. | [optional] + +## Methods + +### NewSchedule2 + +`func NewSchedule2(type_ ScheduleType, hours Schedule2Hours, ) *Schedule2` + +NewSchedule2 instantiates a new Schedule2 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 + +### NewSchedule2WithDefaults + +`func NewSchedule2WithDefaults() *Schedule2` + +NewSchedule2WithDefaults instantiates a new Schedule2 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 + +### GetType + +`func (o *Schedule2) GetType() ScheduleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Schedule2) GetTypeOk() (*ScheduleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Schedule2) SetType(v ScheduleType)` + +SetType sets Type field to given value. + + +### GetMonths + +`func (o *Schedule2) GetMonths() Schedule2Months` + +GetMonths returns the Months field if non-nil, zero value otherwise. + +### GetMonthsOk + +`func (o *Schedule2) GetMonthsOk() (*Schedule2Months, bool)` + +GetMonthsOk returns a tuple with the Months field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMonths + +`func (o *Schedule2) SetMonths(v Schedule2Months)` + +SetMonths sets Months field to given value. + +### HasMonths + +`func (o *Schedule2) HasMonths() bool` + +HasMonths returns a boolean if a field has been set. + +### GetDays + +`func (o *Schedule2) GetDays() Schedule2Days` + +GetDays returns the Days field if non-nil, zero value otherwise. + +### GetDaysOk + +`func (o *Schedule2) GetDaysOk() (*Schedule2Days, bool)` + +GetDaysOk returns a tuple with the Days field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDays + +`func (o *Schedule2) SetDays(v Schedule2Days)` + +SetDays sets Days field to given value. + +### HasDays + +`func (o *Schedule2) HasDays() bool` + +HasDays returns a boolean if a field has been set. + +### GetHours + +`func (o *Schedule2) GetHours() Schedule2Hours` + +GetHours returns the Hours field if non-nil, zero value otherwise. + +### GetHoursOk + +`func (o *Schedule2) GetHoursOk() (*Schedule2Hours, bool)` + +GetHoursOk returns a tuple with the Hours field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHours + +`func (o *Schedule2) SetHours(v Schedule2Hours)` + +SetHours sets Hours field to given value. + + +### GetExpiration + +`func (o *Schedule2) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *Schedule2) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *Schedule2) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *Schedule2) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + +### SetExpirationNil + +`func (o *Schedule2) SetExpirationNil(b bool)` + + SetExpirationNil sets the value for Expiration to be an explicit nil + +### UnsetExpiration +`func (o *Schedule2) UnsetExpiration()` + +UnsetExpiration ensures that no value is present for Expiration, not even an explicit nil +### GetTimeZoneId + +`func (o *Schedule2) GetTimeZoneId() string` + +GetTimeZoneId returns the TimeZoneId field if non-nil, zero value otherwise. + +### GetTimeZoneIdOk + +`func (o *Schedule2) GetTimeZoneIdOk() (*string, bool)` + +GetTimeZoneIdOk returns a tuple with the TimeZoneId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZoneId + +`func (o *Schedule2) SetTimeZoneId(v string)` + +SetTimeZoneId sets TimeZoneId field to given value. + +### HasTimeZoneId + +`func (o *Schedule2) HasTimeZoneId() bool` + +HasTimeZoneId returns a boolean if a field has been set. + +### SetTimeZoneIdNil + +`func (o *Schedule2) SetTimeZoneIdNil(b bool)` + + SetTimeZoneIdNil sets the value for TimeZoneId to be an explicit nil + +### UnsetTimeZoneId +`func (o *Schedule2) UnsetTimeZoneId()` + +UnsetTimeZoneId ensures that no value is present for TimeZoneId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Schedule2Days.md b/docs/tools/sdk/go/Reference/V2025/Models/Schedule2Days.md new file mode 100644 index 000000000..92e2a493c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Schedule2Days.md @@ -0,0 +1,90 @@ +--- +id: v2025-schedule2-days +title: Schedule2Days +pagination_label: Schedule2Days +sidebar_label: Schedule2Days +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule2Days', 'V2025Schedule2Days'] +slug: /tools/sdk/go/v2025/models/schedule2-days +tags: ['SDK', 'Software Development Kit', 'Schedule2Days', 'V2025Schedule2Days'] +--- + +# Schedule2Days + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **string** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Methods + +### NewSchedule2Days + +`func NewSchedule2Days() *Schedule2Days` + +NewSchedule2Days instantiates a new Schedule2Days 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 + +### NewSchedule2DaysWithDefaults + +`func NewSchedule2DaysWithDefaults() *Schedule2Days` + +NewSchedule2DaysWithDefaults instantiates a new Schedule2Days 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 + +### GetApplicationId + +`func (o *Schedule2Days) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *Schedule2Days) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *Schedule2Days) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *Schedule2Days) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### GetAccountMatchConfig + +`func (o *Schedule2Days) GetAccountMatchConfig() SelectorAccountMatchConfig` + +GetAccountMatchConfig returns the AccountMatchConfig field if non-nil, zero value otherwise. + +### GetAccountMatchConfigOk + +`func (o *Schedule2Days) GetAccountMatchConfigOk() (*SelectorAccountMatchConfig, bool)` + +GetAccountMatchConfigOk returns a tuple with the AccountMatchConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountMatchConfig + +`func (o *Schedule2Days) SetAccountMatchConfig(v SelectorAccountMatchConfig)` + +SetAccountMatchConfig sets AccountMatchConfig field to given value. + +### HasAccountMatchConfig + +`func (o *Schedule2Days) HasAccountMatchConfig() bool` + +HasAccountMatchConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Schedule2Hours.md b/docs/tools/sdk/go/Reference/V2025/Models/Schedule2Hours.md new file mode 100644 index 000000000..a744dd445 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Schedule2Hours.md @@ -0,0 +1,90 @@ +--- +id: v2025-schedule2-hours +title: Schedule2Hours +pagination_label: Schedule2Hours +sidebar_label: Schedule2Hours +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule2Hours', 'V2025Schedule2Hours'] +slug: /tools/sdk/go/v2025/models/schedule2-hours +tags: ['SDK', 'Software Development Kit', 'Schedule2Hours', 'V2025Schedule2Hours'] +--- + +# Schedule2Hours + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **string** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Methods + +### NewSchedule2Hours + +`func NewSchedule2Hours() *Schedule2Hours` + +NewSchedule2Hours instantiates a new Schedule2Hours 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 + +### NewSchedule2HoursWithDefaults + +`func NewSchedule2HoursWithDefaults() *Schedule2Hours` + +NewSchedule2HoursWithDefaults instantiates a new Schedule2Hours 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 + +### GetApplicationId + +`func (o *Schedule2Hours) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *Schedule2Hours) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *Schedule2Hours) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *Schedule2Hours) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### GetAccountMatchConfig + +`func (o *Schedule2Hours) GetAccountMatchConfig() SelectorAccountMatchConfig` + +GetAccountMatchConfig returns the AccountMatchConfig field if non-nil, zero value otherwise. + +### GetAccountMatchConfigOk + +`func (o *Schedule2Hours) GetAccountMatchConfigOk() (*SelectorAccountMatchConfig, bool)` + +GetAccountMatchConfigOk returns a tuple with the AccountMatchConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountMatchConfig + +`func (o *Schedule2Hours) SetAccountMatchConfig(v SelectorAccountMatchConfig)` + +SetAccountMatchConfig sets AccountMatchConfig field to given value. + +### HasAccountMatchConfig + +`func (o *Schedule2Hours) HasAccountMatchConfig() bool` + +HasAccountMatchConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Schedule2Months.md b/docs/tools/sdk/go/Reference/V2025/Models/Schedule2Months.md new file mode 100644 index 000000000..544ecb5d2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Schedule2Months.md @@ -0,0 +1,90 @@ +--- +id: v2025-schedule2-months +title: Schedule2Months +pagination_label: Schedule2Months +sidebar_label: Schedule2Months +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule2Months', 'V2025Schedule2Months'] +slug: /tools/sdk/go/v2025/models/schedule2-months +tags: ['SDK', 'Software Development Kit', 'Schedule2Months', 'V2025Schedule2Months'] +--- + +# Schedule2Months + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **string** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Methods + +### NewSchedule2Months + +`func NewSchedule2Months() *Schedule2Months` + +NewSchedule2Months instantiates a new Schedule2Months 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 + +### NewSchedule2MonthsWithDefaults + +`func NewSchedule2MonthsWithDefaults() *Schedule2Months` + +NewSchedule2MonthsWithDefaults instantiates a new Schedule2Months 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 + +### GetApplicationId + +`func (o *Schedule2Months) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *Schedule2Months) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *Schedule2Months) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *Schedule2Months) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### GetAccountMatchConfig + +`func (o *Schedule2Months) GetAccountMatchConfig() SelectorAccountMatchConfig` + +GetAccountMatchConfig returns the AccountMatchConfig field if non-nil, zero value otherwise. + +### GetAccountMatchConfigOk + +`func (o *Schedule2Months) GetAccountMatchConfigOk() (*SelectorAccountMatchConfig, bool)` + +GetAccountMatchConfigOk returns a tuple with the AccountMatchConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountMatchConfig + +`func (o *Schedule2Months) SetAccountMatchConfig(v SelectorAccountMatchConfig)` + +SetAccountMatchConfig sets AccountMatchConfig field to given value. + +### HasAccountMatchConfig + +`func (o *Schedule2Months) HasAccountMatchConfig() bool` + +HasAccountMatchConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ScheduleDays.md b/docs/tools/sdk/go/Reference/V2025/Models/ScheduleDays.md new file mode 100644 index 000000000..24387fdef --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ScheduleDays.md @@ -0,0 +1,116 @@ +--- +id: v2025-schedule-days +title: ScheduleDays +pagination_label: ScheduleDays +sidebar_label: ScheduleDays +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduleDays', 'V2025ScheduleDays'] +slug: /tools/sdk/go/v2025/models/schedule-days +tags: ['SDK', 'Software Development Kit', 'ScheduleDays', 'V2025ScheduleDays'] +--- + +# ScheduleDays + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Enum type to specify days value | +**Values** | **[]string** | Values of the days based on the enum type mentioned above | +**Interval** | Pointer to **NullableInt64** | Interval between the cert generations | [optional] + +## Methods + +### NewScheduleDays + +`func NewScheduleDays(type_ string, values []string, ) *ScheduleDays` + +NewScheduleDays instantiates a new ScheduleDays 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 + +### NewScheduleDaysWithDefaults + +`func NewScheduleDaysWithDefaults() *ScheduleDays` + +NewScheduleDaysWithDefaults instantiates a new ScheduleDays 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 + +### GetType + +`func (o *ScheduleDays) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ScheduleDays) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ScheduleDays) SetType(v string)` + +SetType sets Type field to given value. + + +### GetValues + +`func (o *ScheduleDays) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *ScheduleDays) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *ScheduleDays) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### GetInterval + +`func (o *ScheduleDays) GetInterval() int64` + +GetInterval returns the Interval field if non-nil, zero value otherwise. + +### GetIntervalOk + +`func (o *ScheduleDays) GetIntervalOk() (*int64, bool)` + +GetIntervalOk returns a tuple with the Interval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterval + +`func (o *ScheduleDays) SetInterval(v int64)` + +SetInterval sets Interval field to given value. + +### HasInterval + +`func (o *ScheduleDays) HasInterval() bool` + +HasInterval returns a boolean if a field has been set. + +### SetIntervalNil + +`func (o *ScheduleDays) SetIntervalNil(b bool)` + + SetIntervalNil sets the value for Interval to be an explicit nil + +### UnsetInterval +`func (o *ScheduleDays) UnsetInterval()` + +UnsetInterval ensures that no value is present for Interval, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ScheduleHours.md b/docs/tools/sdk/go/Reference/V2025/Models/ScheduleHours.md new file mode 100644 index 000000000..46c16b1d6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ScheduleHours.md @@ -0,0 +1,116 @@ +--- +id: v2025-schedule-hours +title: ScheduleHours +pagination_label: ScheduleHours +sidebar_label: ScheduleHours +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduleHours', 'V2025ScheduleHours'] +slug: /tools/sdk/go/v2025/models/schedule-hours +tags: ['SDK', 'Software Development Kit', 'ScheduleHours', 'V2025ScheduleHours'] +--- + +# ScheduleHours + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Enum type to specify hours value | +**Values** | **[]string** | Values of the days based on the enum type mentioned above | +**Interval** | Pointer to **NullableInt64** | Interval between the cert generations | [optional] + +## Methods + +### NewScheduleHours + +`func NewScheduleHours(type_ string, values []string, ) *ScheduleHours` + +NewScheduleHours instantiates a new ScheduleHours 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 + +### NewScheduleHoursWithDefaults + +`func NewScheduleHoursWithDefaults() *ScheduleHours` + +NewScheduleHoursWithDefaults instantiates a new ScheduleHours 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 + +### GetType + +`func (o *ScheduleHours) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ScheduleHours) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ScheduleHours) SetType(v string)` + +SetType sets Type field to given value. + + +### GetValues + +`func (o *ScheduleHours) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *ScheduleHours) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *ScheduleHours) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### GetInterval + +`func (o *ScheduleHours) GetInterval() int64` + +GetInterval returns the Interval field if non-nil, zero value otherwise. + +### GetIntervalOk + +`func (o *ScheduleHours) GetIntervalOk() (*int64, bool)` + +GetIntervalOk returns a tuple with the Interval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterval + +`func (o *ScheduleHours) SetInterval(v int64)` + +SetInterval sets Interval field to given value. + +### HasInterval + +`func (o *ScheduleHours) HasInterval() bool` + +HasInterval returns a boolean if a field has been set. + +### SetIntervalNil + +`func (o *ScheduleHours) SetIntervalNil(b bool)` + + SetIntervalNil sets the value for Interval to be an explicit nil + +### UnsetInterval +`func (o *ScheduleHours) UnsetInterval()` + +UnsetInterval ensures that no value is present for Interval, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ScheduleMonths.md b/docs/tools/sdk/go/Reference/V2025/Models/ScheduleMonths.md new file mode 100644 index 000000000..6f7d7ad67 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ScheduleMonths.md @@ -0,0 +1,106 @@ +--- +id: v2025-schedule-months +title: ScheduleMonths +pagination_label: ScheduleMonths +sidebar_label: ScheduleMonths +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduleMonths', 'V2025ScheduleMonths'] +slug: /tools/sdk/go/v2025/models/schedule-months +tags: ['SDK', 'Software Development Kit', 'ScheduleMonths', 'V2025ScheduleMonths'] +--- + +# ScheduleMonths + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Enum type to specify months value | +**Values** | **[]string** | Values of the months based on the enum type mentioned above | +**Interval** | Pointer to **int64** | Interval between the cert generations | [optional] + +## Methods + +### NewScheduleMonths + +`func NewScheduleMonths(type_ string, values []string, ) *ScheduleMonths` + +NewScheduleMonths instantiates a new ScheduleMonths 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 + +### NewScheduleMonthsWithDefaults + +`func NewScheduleMonthsWithDefaults() *ScheduleMonths` + +NewScheduleMonthsWithDefaults instantiates a new ScheduleMonths 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 + +### GetType + +`func (o *ScheduleMonths) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ScheduleMonths) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ScheduleMonths) SetType(v string)` + +SetType sets Type field to given value. + + +### GetValues + +`func (o *ScheduleMonths) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *ScheduleMonths) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *ScheduleMonths) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### GetInterval + +`func (o *ScheduleMonths) GetInterval() int64` + +GetInterval returns the Interval field if non-nil, zero value otherwise. + +### GetIntervalOk + +`func (o *ScheduleMonths) GetIntervalOk() (*int64, bool)` + +GetIntervalOk returns a tuple with the Interval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterval + +`func (o *ScheduleMonths) SetInterval(v int64)` + +SetInterval sets Interval field to given value. + +### HasInterval + +`func (o *ScheduleMonths) HasInterval() bool` + +HasInterval returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ScheduleType.md b/docs/tools/sdk/go/Reference/V2025/Models/ScheduleType.md new file mode 100644 index 000000000..2519d8cde --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ScheduleType.md @@ -0,0 +1,27 @@ +--- +id: v2025-schedule-type +title: ScheduleType +pagination_label: ScheduleType +sidebar_label: ScheduleType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduleType', 'V2025ScheduleType'] +slug: /tools/sdk/go/v2025/models/schedule-type +tags: ['SDK', 'Software Development Kit', 'ScheduleType', 'V2025ScheduleType'] +--- + +# ScheduleType + +## Enum + + +* `DAILY` (value: `"DAILY"`) + +* `WEEKLY` (value: `"WEEKLY"`) + +* `MONTHLY` (value: `"MONTHLY"`) + +* `CALENDAR` (value: `"CALENDAR"`) + +* `ANNUALLY` (value: `"ANNUALLY"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionPayload.md b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionPayload.md new file mode 100644 index 000000000..34d7b1107 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionPayload.md @@ -0,0 +1,158 @@ +--- +id: v2025-scheduled-action-payload +title: ScheduledActionPayload +pagination_label: ScheduledActionPayload +sidebar_label: ScheduledActionPayload +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledActionPayload', 'V2025ScheduledActionPayload'] +slug: /tools/sdk/go/v2025/models/scheduled-action-payload +tags: ['SDK', 'Software Development Kit', 'ScheduledActionPayload', 'V2025ScheduledActionPayload'] +--- + +# ScheduledActionPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobType** | **string** | Type of the scheduled job. | +**StartTime** | Pointer to **SailPointTime** | The time when this scheduled action should start. Optional. | [optional] +**CronString** | Pointer to **string** | Cron expression defining the schedule for this action. Optional for repeated events. | [optional] +**TimeZoneId** | Pointer to **string** | Time zone ID for interpreting the cron expression. Optional, will default to current time zone. | [optional] +**Content** | [**ScheduledActionPayloadContent**](scheduled-action-payload-content) | | + +## Methods + +### NewScheduledActionPayload + +`func NewScheduledActionPayload(jobType string, content ScheduledActionPayloadContent, ) *ScheduledActionPayload` + +NewScheduledActionPayload instantiates a new ScheduledActionPayload 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 + +### NewScheduledActionPayloadWithDefaults + +`func NewScheduledActionPayloadWithDefaults() *ScheduledActionPayload` + +NewScheduledActionPayloadWithDefaults instantiates a new ScheduledActionPayload 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 + +### GetJobType + +`func (o *ScheduledActionPayload) GetJobType() string` + +GetJobType returns the JobType field if non-nil, zero value otherwise. + +### GetJobTypeOk + +`func (o *ScheduledActionPayload) GetJobTypeOk() (*string, bool)` + +GetJobTypeOk returns a tuple with the JobType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobType + +`func (o *ScheduledActionPayload) SetJobType(v string)` + +SetJobType sets JobType field to given value. + + +### GetStartTime + +`func (o *ScheduledActionPayload) GetStartTime() SailPointTime` + +GetStartTime returns the StartTime field if non-nil, zero value otherwise. + +### GetStartTimeOk + +`func (o *ScheduledActionPayload) GetStartTimeOk() (*SailPointTime, bool)` + +GetStartTimeOk returns a tuple with the StartTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartTime + +`func (o *ScheduledActionPayload) SetStartTime(v SailPointTime)` + +SetStartTime sets StartTime field to given value. + +### HasStartTime + +`func (o *ScheduledActionPayload) HasStartTime() bool` + +HasStartTime returns a boolean if a field has been set. + +### GetCronString + +`func (o *ScheduledActionPayload) GetCronString() string` + +GetCronString returns the CronString field if non-nil, zero value otherwise. + +### GetCronStringOk + +`func (o *ScheduledActionPayload) GetCronStringOk() (*string, bool)` + +GetCronStringOk returns a tuple with the CronString field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCronString + +`func (o *ScheduledActionPayload) SetCronString(v string)` + +SetCronString sets CronString field to given value. + +### HasCronString + +`func (o *ScheduledActionPayload) HasCronString() bool` + +HasCronString returns a boolean if a field has been set. + +### GetTimeZoneId + +`func (o *ScheduledActionPayload) GetTimeZoneId() string` + +GetTimeZoneId returns the TimeZoneId field if non-nil, zero value otherwise. + +### GetTimeZoneIdOk + +`func (o *ScheduledActionPayload) GetTimeZoneIdOk() (*string, bool)` + +GetTimeZoneIdOk returns a tuple with the TimeZoneId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZoneId + +`func (o *ScheduledActionPayload) SetTimeZoneId(v string)` + +SetTimeZoneId sets TimeZoneId field to given value. + +### HasTimeZoneId + +`func (o *ScheduledActionPayload) HasTimeZoneId() bool` + +HasTimeZoneId returns a boolean if a field has been set. + +### GetContent + +`func (o *ScheduledActionPayload) GetContent() ScheduledActionPayloadContent` + +GetContent returns the Content field if non-nil, zero value otherwise. + +### GetContentOk + +`func (o *ScheduledActionPayload) GetContentOk() (*ScheduledActionPayloadContent, bool)` + +GetContentOk returns a tuple with the Content field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContent + +`func (o *ScheduledActionPayload) SetContent(v ScheduledActionPayloadContent)` + +SetContent sets Content field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionPayloadContent.md b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionPayloadContent.md new file mode 100644 index 000000000..18b678ce5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionPayloadContent.md @@ -0,0 +1,163 @@ +--- +id: v2025-scheduled-action-payload-content +title: ScheduledActionPayloadContent +pagination_label: ScheduledActionPayloadContent +sidebar_label: ScheduledActionPayloadContent +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledActionPayloadContent', 'V2025ScheduledActionPayloadContent'] +slug: /tools/sdk/go/v2025/models/scheduled-action-payload-content +tags: ['SDK', 'Software Development Kit', 'ScheduledActionPayloadContent', 'V2025ScheduledActionPayloadContent'] +--- + +# ScheduledActionPayloadContent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Name of the scheduled action (maximum 50 characters). | +**BackupOptions** | Pointer to [**ScheduledActionPayloadContentBackupOptions**](scheduled-action-payload-content-backup-options) | | [optional] +**SourceBackupId** | Pointer to **string** | ID of the source backup. Required for CREATE_DRAFT jobs. | [optional] +**SourceTenant** | Pointer to **string** | Source tenant identifier. Required for CREATE_DRAFT jobs. | [optional] +**DraftId** | Pointer to **string** | ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs. | [optional] + +## Methods + +### NewScheduledActionPayloadContent + +`func NewScheduledActionPayloadContent(name string, ) *ScheduledActionPayloadContent` + +NewScheduledActionPayloadContent instantiates a new ScheduledActionPayloadContent 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 + +### NewScheduledActionPayloadContentWithDefaults + +`func NewScheduledActionPayloadContentWithDefaults() *ScheduledActionPayloadContent` + +NewScheduledActionPayloadContentWithDefaults instantiates a new ScheduledActionPayloadContent 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 + +### GetName + +`func (o *ScheduledActionPayloadContent) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ScheduledActionPayloadContent) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ScheduledActionPayloadContent) SetName(v string)` + +SetName sets Name field to given value. + + +### GetBackupOptions + +`func (o *ScheduledActionPayloadContent) GetBackupOptions() ScheduledActionPayloadContentBackupOptions` + +GetBackupOptions returns the BackupOptions field if non-nil, zero value otherwise. + +### GetBackupOptionsOk + +`func (o *ScheduledActionPayloadContent) GetBackupOptionsOk() (*ScheduledActionPayloadContentBackupOptions, bool)` + +GetBackupOptionsOk returns a tuple with the BackupOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackupOptions + +`func (o *ScheduledActionPayloadContent) SetBackupOptions(v ScheduledActionPayloadContentBackupOptions)` + +SetBackupOptions sets BackupOptions field to given value. + +### HasBackupOptions + +`func (o *ScheduledActionPayloadContent) HasBackupOptions() bool` + +HasBackupOptions returns a boolean if a field has been set. + +### GetSourceBackupId + +`func (o *ScheduledActionPayloadContent) GetSourceBackupId() string` + +GetSourceBackupId returns the SourceBackupId field if non-nil, zero value otherwise. + +### GetSourceBackupIdOk + +`func (o *ScheduledActionPayloadContent) GetSourceBackupIdOk() (*string, bool)` + +GetSourceBackupIdOk returns a tuple with the SourceBackupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceBackupId + +`func (o *ScheduledActionPayloadContent) SetSourceBackupId(v string)` + +SetSourceBackupId sets SourceBackupId field to given value. + +### HasSourceBackupId + +`func (o *ScheduledActionPayloadContent) HasSourceBackupId() bool` + +HasSourceBackupId returns a boolean if a field has been set. + +### GetSourceTenant + +`func (o *ScheduledActionPayloadContent) GetSourceTenant() string` + +GetSourceTenant returns the SourceTenant field if non-nil, zero value otherwise. + +### GetSourceTenantOk + +`func (o *ScheduledActionPayloadContent) GetSourceTenantOk() (*string, bool)` + +GetSourceTenantOk returns a tuple with the SourceTenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceTenant + +`func (o *ScheduledActionPayloadContent) SetSourceTenant(v string)` + +SetSourceTenant sets SourceTenant field to given value. + +### HasSourceTenant + +`func (o *ScheduledActionPayloadContent) HasSourceTenant() bool` + +HasSourceTenant returns a boolean if a field has been set. + +### GetDraftId + +`func (o *ScheduledActionPayloadContent) GetDraftId() string` + +GetDraftId returns the DraftId field if non-nil, zero value otherwise. + +### GetDraftIdOk + +`func (o *ScheduledActionPayloadContent) GetDraftIdOk() (*string, bool)` + +GetDraftIdOk returns a tuple with the DraftId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDraftId + +`func (o *ScheduledActionPayloadContent) SetDraftId(v string)` + +SetDraftId sets DraftId field to given value. + +### HasDraftId + +`func (o *ScheduledActionPayloadContent) HasDraftId() bool` + +HasDraftId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionPayloadContentBackupOptions.md b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionPayloadContentBackupOptions.md new file mode 100644 index 000000000..2731ddf39 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionPayloadContentBackupOptions.md @@ -0,0 +1,90 @@ +--- +id: v2025-scheduled-action-payload-content-backup-options +title: ScheduledActionPayloadContentBackupOptions +pagination_label: ScheduledActionPayloadContentBackupOptions +sidebar_label: ScheduledActionPayloadContentBackupOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledActionPayloadContentBackupOptions', 'V2025ScheduledActionPayloadContentBackupOptions'] +slug: /tools/sdk/go/v2025/models/scheduled-action-payload-content-backup-options +tags: ['SDK', 'Software Development Kit', 'ScheduledActionPayloadContentBackupOptions', 'V2025ScheduledActionPayloadContentBackupOptions'] +--- + +# ScheduledActionPayloadContentBackupOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludeTypes** | Pointer to **[]string** | Object types that are to be included in the backup. | [optional] +**ObjectOptions** | Pointer to [**map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue**](scheduled-action-response-content-backup-options-object-options-value) | Map of objectType string to the options to be passed to the target service for that objectType. | [optional] + +## Methods + +### NewScheduledActionPayloadContentBackupOptions + +`func NewScheduledActionPayloadContentBackupOptions() *ScheduledActionPayloadContentBackupOptions` + +NewScheduledActionPayloadContentBackupOptions instantiates a new ScheduledActionPayloadContentBackupOptions 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 + +### NewScheduledActionPayloadContentBackupOptionsWithDefaults + +`func NewScheduledActionPayloadContentBackupOptionsWithDefaults() *ScheduledActionPayloadContentBackupOptions` + +NewScheduledActionPayloadContentBackupOptionsWithDefaults instantiates a new ScheduledActionPayloadContentBackupOptions 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 + +### GetIncludeTypes + +`func (o *ScheduledActionPayloadContentBackupOptions) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *ScheduledActionPayloadContentBackupOptions) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *ScheduledActionPayloadContentBackupOptions) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *ScheduledActionPayloadContentBackupOptions) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *ScheduledActionPayloadContentBackupOptions) GetObjectOptions() map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *ScheduledActionPayloadContentBackupOptions) GetObjectOptionsOk() (*map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *ScheduledActionPayloadContentBackupOptions) SetObjectOptions(v map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *ScheduledActionPayloadContentBackupOptions) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionResponse.md new file mode 100644 index 000000000..3b33fd767 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionResponse.md @@ -0,0 +1,220 @@ +--- +id: v2025-scheduled-action-response +title: ScheduledActionResponse +pagination_label: ScheduledActionResponse +sidebar_label: ScheduledActionResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledActionResponse', 'V2025ScheduledActionResponse'] +slug: /tools/sdk/go/v2025/models/scheduled-action-response +tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponse', 'V2025ScheduledActionResponse'] +--- + +# ScheduledActionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for this scheduled action. | [optional] +**Created** | Pointer to **SailPointTime** | The time when this scheduled action was created. | [optional] +**JobType** | Pointer to **string** | Type of the scheduled job. | [optional] +**Content** | Pointer to [**ScheduledActionResponseContent**](scheduled-action-response-content) | | [optional] +**StartTime** | Pointer to **SailPointTime** | The time when this scheduled action should start. | [optional] +**CronString** | Pointer to **string** | Cron expression defining the schedule for this action. | [optional] +**TimeZoneId** | Pointer to **string** | Time zone ID for interpreting the cron expression. | [optional] + +## Methods + +### NewScheduledActionResponse + +`func NewScheduledActionResponse() *ScheduledActionResponse` + +NewScheduledActionResponse instantiates a new ScheduledActionResponse 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 + +### NewScheduledActionResponseWithDefaults + +`func NewScheduledActionResponseWithDefaults() *ScheduledActionResponse` + +NewScheduledActionResponseWithDefaults instantiates a new ScheduledActionResponse 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 + +### GetId + +`func (o *ScheduledActionResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ScheduledActionResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ScheduledActionResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ScheduledActionResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreated + +`func (o *ScheduledActionResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ScheduledActionResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ScheduledActionResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ScheduledActionResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetJobType + +`func (o *ScheduledActionResponse) GetJobType() string` + +GetJobType returns the JobType field if non-nil, zero value otherwise. + +### GetJobTypeOk + +`func (o *ScheduledActionResponse) GetJobTypeOk() (*string, bool)` + +GetJobTypeOk returns a tuple with the JobType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobType + +`func (o *ScheduledActionResponse) SetJobType(v string)` + +SetJobType sets JobType field to given value. + +### HasJobType + +`func (o *ScheduledActionResponse) HasJobType() bool` + +HasJobType returns a boolean if a field has been set. + +### GetContent + +`func (o *ScheduledActionResponse) GetContent() ScheduledActionResponseContent` + +GetContent returns the Content field if non-nil, zero value otherwise. + +### GetContentOk + +`func (o *ScheduledActionResponse) GetContentOk() (*ScheduledActionResponseContent, bool)` + +GetContentOk returns a tuple with the Content field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContent + +`func (o *ScheduledActionResponse) SetContent(v ScheduledActionResponseContent)` + +SetContent sets Content field to given value. + +### HasContent + +`func (o *ScheduledActionResponse) HasContent() bool` + +HasContent returns a boolean if a field has been set. + +### GetStartTime + +`func (o *ScheduledActionResponse) GetStartTime() SailPointTime` + +GetStartTime returns the StartTime field if non-nil, zero value otherwise. + +### GetStartTimeOk + +`func (o *ScheduledActionResponse) GetStartTimeOk() (*SailPointTime, bool)` + +GetStartTimeOk returns a tuple with the StartTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartTime + +`func (o *ScheduledActionResponse) SetStartTime(v SailPointTime)` + +SetStartTime sets StartTime field to given value. + +### HasStartTime + +`func (o *ScheduledActionResponse) HasStartTime() bool` + +HasStartTime returns a boolean if a field has been set. + +### GetCronString + +`func (o *ScheduledActionResponse) GetCronString() string` + +GetCronString returns the CronString field if non-nil, zero value otherwise. + +### GetCronStringOk + +`func (o *ScheduledActionResponse) GetCronStringOk() (*string, bool)` + +GetCronStringOk returns a tuple with the CronString field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCronString + +`func (o *ScheduledActionResponse) SetCronString(v string)` + +SetCronString sets CronString field to given value. + +### HasCronString + +`func (o *ScheduledActionResponse) HasCronString() bool` + +HasCronString returns a boolean if a field has been set. + +### GetTimeZoneId + +`func (o *ScheduledActionResponse) GetTimeZoneId() string` + +GetTimeZoneId returns the TimeZoneId field if non-nil, zero value otherwise. + +### GetTimeZoneIdOk + +`func (o *ScheduledActionResponse) GetTimeZoneIdOk() (*string, bool)` + +GetTimeZoneIdOk returns a tuple with the TimeZoneId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZoneId + +`func (o *ScheduledActionResponse) SetTimeZoneId(v string)` + +SetTimeZoneId sets TimeZoneId field to given value. + +### HasTimeZoneId + +`func (o *ScheduledActionResponse) HasTimeZoneId() bool` + +HasTimeZoneId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionResponseContent.md b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionResponseContent.md new file mode 100644 index 000000000..8454ca2ab --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionResponseContent.md @@ -0,0 +1,168 @@ +--- +id: v2025-scheduled-action-response-content +title: ScheduledActionResponseContent +pagination_label: ScheduledActionResponseContent +sidebar_label: ScheduledActionResponseContent +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledActionResponseContent', 'V2025ScheduledActionResponseContent'] +slug: /tools/sdk/go/v2025/models/scheduled-action-response-content +tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponseContent', 'V2025ScheduledActionResponseContent'] +--- + +# ScheduledActionResponseContent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the scheduled action (maximum 50 characters). | [optional] +**BackupOptions** | Pointer to [**ScheduledActionResponseContentBackupOptions**](scheduled-action-response-content-backup-options) | | [optional] +**SourceBackupId** | Pointer to **string** | ID of the source backup. Required for CREATE_DRAFT jobs only. | [optional] +**SourceTenant** | Pointer to **string** | Source tenant identifier. Required for CREATE_DRAFT jobs only. | [optional] +**DraftId** | Pointer to **string** | ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs only. | [optional] + +## Methods + +### NewScheduledActionResponseContent + +`func NewScheduledActionResponseContent() *ScheduledActionResponseContent` + +NewScheduledActionResponseContent instantiates a new ScheduledActionResponseContent 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 + +### NewScheduledActionResponseContentWithDefaults + +`func NewScheduledActionResponseContentWithDefaults() *ScheduledActionResponseContent` + +NewScheduledActionResponseContentWithDefaults instantiates a new ScheduledActionResponseContent 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 + +### GetName + +`func (o *ScheduledActionResponseContent) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ScheduledActionResponseContent) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ScheduledActionResponseContent) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ScheduledActionResponseContent) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetBackupOptions + +`func (o *ScheduledActionResponseContent) GetBackupOptions() ScheduledActionResponseContentBackupOptions` + +GetBackupOptions returns the BackupOptions field if non-nil, zero value otherwise. + +### GetBackupOptionsOk + +`func (o *ScheduledActionResponseContent) GetBackupOptionsOk() (*ScheduledActionResponseContentBackupOptions, bool)` + +GetBackupOptionsOk returns a tuple with the BackupOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackupOptions + +`func (o *ScheduledActionResponseContent) SetBackupOptions(v ScheduledActionResponseContentBackupOptions)` + +SetBackupOptions sets BackupOptions field to given value. + +### HasBackupOptions + +`func (o *ScheduledActionResponseContent) HasBackupOptions() bool` + +HasBackupOptions returns a boolean if a field has been set. + +### GetSourceBackupId + +`func (o *ScheduledActionResponseContent) GetSourceBackupId() string` + +GetSourceBackupId returns the SourceBackupId field if non-nil, zero value otherwise. + +### GetSourceBackupIdOk + +`func (o *ScheduledActionResponseContent) GetSourceBackupIdOk() (*string, bool)` + +GetSourceBackupIdOk returns a tuple with the SourceBackupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceBackupId + +`func (o *ScheduledActionResponseContent) SetSourceBackupId(v string)` + +SetSourceBackupId sets SourceBackupId field to given value. + +### HasSourceBackupId + +`func (o *ScheduledActionResponseContent) HasSourceBackupId() bool` + +HasSourceBackupId returns a boolean if a field has been set. + +### GetSourceTenant + +`func (o *ScheduledActionResponseContent) GetSourceTenant() string` + +GetSourceTenant returns the SourceTenant field if non-nil, zero value otherwise. + +### GetSourceTenantOk + +`func (o *ScheduledActionResponseContent) GetSourceTenantOk() (*string, bool)` + +GetSourceTenantOk returns a tuple with the SourceTenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceTenant + +`func (o *ScheduledActionResponseContent) SetSourceTenant(v string)` + +SetSourceTenant sets SourceTenant field to given value. + +### HasSourceTenant + +`func (o *ScheduledActionResponseContent) HasSourceTenant() bool` + +HasSourceTenant returns a boolean if a field has been set. + +### GetDraftId + +`func (o *ScheduledActionResponseContent) GetDraftId() string` + +GetDraftId returns the DraftId field if non-nil, zero value otherwise. + +### GetDraftIdOk + +`func (o *ScheduledActionResponseContent) GetDraftIdOk() (*string, bool)` + +GetDraftIdOk returns a tuple with the DraftId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDraftId + +`func (o *ScheduledActionResponseContent) SetDraftId(v string)` + +SetDraftId sets DraftId field to given value. + +### HasDraftId + +`func (o *ScheduledActionResponseContent) HasDraftId() bool` + +HasDraftId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionResponseContentBackupOptions.md b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionResponseContentBackupOptions.md new file mode 100644 index 000000000..5028fffbb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionResponseContentBackupOptions.md @@ -0,0 +1,90 @@ +--- +id: v2025-scheduled-action-response-content-backup-options +title: ScheduledActionResponseContentBackupOptions +pagination_label: ScheduledActionResponseContentBackupOptions +sidebar_label: ScheduledActionResponseContentBackupOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledActionResponseContentBackupOptions', 'V2025ScheduledActionResponseContentBackupOptions'] +slug: /tools/sdk/go/v2025/models/scheduled-action-response-content-backup-options +tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponseContentBackupOptions', 'V2025ScheduledActionResponseContentBackupOptions'] +--- + +# ScheduledActionResponseContentBackupOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludeTypes** | Pointer to **[]string** | Object types that are to be included in the backup. | [optional] +**ObjectOptions** | Pointer to [**map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue**](scheduled-action-response-content-backup-options-object-options-value) | Map of objectType string to the options to be passed to the target service for that objectType. | [optional] + +## Methods + +### NewScheduledActionResponseContentBackupOptions + +`func NewScheduledActionResponseContentBackupOptions() *ScheduledActionResponseContentBackupOptions` + +NewScheduledActionResponseContentBackupOptions instantiates a new ScheduledActionResponseContentBackupOptions 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 + +### NewScheduledActionResponseContentBackupOptionsWithDefaults + +`func NewScheduledActionResponseContentBackupOptionsWithDefaults() *ScheduledActionResponseContentBackupOptions` + +NewScheduledActionResponseContentBackupOptionsWithDefaults instantiates a new ScheduledActionResponseContentBackupOptions 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 + +### GetIncludeTypes + +`func (o *ScheduledActionResponseContentBackupOptions) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *ScheduledActionResponseContentBackupOptions) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *ScheduledActionResponseContentBackupOptions) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *ScheduledActionResponseContentBackupOptions) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *ScheduledActionResponseContentBackupOptions) GetObjectOptions() map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *ScheduledActionResponseContentBackupOptions) GetObjectOptionsOk() (*map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *ScheduledActionResponseContentBackupOptions) SetObjectOptions(v map[string]ScheduledActionResponseContentBackupOptionsObjectOptionsValue)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *ScheduledActionResponseContentBackupOptions) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionResponseContentBackupOptionsObjectOptionsValue.md b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionResponseContentBackupOptionsObjectOptionsValue.md new file mode 100644 index 000000000..c133713c6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledActionResponseContentBackupOptionsObjectOptionsValue.md @@ -0,0 +1,64 @@ +--- +id: v2025-scheduled-action-response-content-backup-options-object-options-value +title: ScheduledActionResponseContentBackupOptionsObjectOptionsValue +pagination_label: ScheduledActionResponseContentBackupOptionsObjectOptionsValue +sidebar_label: ScheduledActionResponseContentBackupOptionsObjectOptionsValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledActionResponseContentBackupOptionsObjectOptionsValue', 'V2025ScheduledActionResponseContentBackupOptionsObjectOptionsValue'] +slug: /tools/sdk/go/v2025/models/scheduled-action-response-content-backup-options-object-options-value +tags: ['SDK', 'Software Development Kit', 'ScheduledActionResponseContentBackupOptionsObjectOptionsValue', 'V2025ScheduledActionResponseContentBackupOptionsObjectOptionsValue'] +--- + +# ScheduledActionResponseContentBackupOptionsObjectOptionsValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludedNames** | Pointer to **[]string** | Set of names to be included. | [optional] + +## Methods + +### NewScheduledActionResponseContentBackupOptionsObjectOptionsValue + +`func NewScheduledActionResponseContentBackupOptionsObjectOptionsValue() *ScheduledActionResponseContentBackupOptionsObjectOptionsValue` + +NewScheduledActionResponseContentBackupOptionsObjectOptionsValue instantiates a new ScheduledActionResponseContentBackupOptionsObjectOptionsValue 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 + +### NewScheduledActionResponseContentBackupOptionsObjectOptionsValueWithDefaults + +`func NewScheduledActionResponseContentBackupOptionsObjectOptionsValueWithDefaults() *ScheduledActionResponseContentBackupOptionsObjectOptionsValue` + +NewScheduledActionResponseContentBackupOptionsObjectOptionsValueWithDefaults instantiates a new ScheduledActionResponseContentBackupOptionsObjectOptionsValue 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 + +### GetIncludedNames + +`func (o *ScheduledActionResponseContentBackupOptionsObjectOptionsValue) GetIncludedNames() []string` + +GetIncludedNames returns the IncludedNames field if non-nil, zero value otherwise. + +### GetIncludedNamesOk + +`func (o *ScheduledActionResponseContentBackupOptionsObjectOptionsValue) GetIncludedNamesOk() (*[]string, bool)` + +GetIncludedNamesOk returns a tuple with the IncludedNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludedNames + +`func (o *ScheduledActionResponseContentBackupOptionsObjectOptionsValue) SetIncludedNames(v []string)` + +SetIncludedNames sets IncludedNames field to given value. + +### HasIncludedNames + +`func (o *ScheduledActionResponseContentBackupOptionsObjectOptionsValue) HasIncludedNames() bool` + +HasIncludedNames returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ScheduledSearch.md b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledSearch.md new file mode 100644 index 000000000..7be201949 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledSearch.md @@ -0,0 +1,386 @@ +--- +id: v2025-scheduled-search +title: ScheduledSearch +pagination_label: ScheduledSearch +sidebar_label: ScheduledSearch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledSearch', 'V2025ScheduledSearch'] +slug: /tools/sdk/go/v2025/models/scheduled-search +tags: ['SDK', 'Software Development Kit', 'ScheduledSearch', 'V2025ScheduledSearch'] +--- + +# ScheduledSearch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **NullableString** | The name of the scheduled search. | [optional] +**Description** | Pointer to **NullableString** | The description of the scheduled search. | [optional] +**SavedSearchId** | **string** | The ID of the saved search that will be executed. | +**Created** | Pointer to **NullableTime** | The date the scheduled search was initially created. | [optional] [readonly] +**Modified** | Pointer to **NullableTime** | The last date the scheduled search was modified. | [optional] [readonly] +**Schedule** | [**Schedule2**](schedule2) | | +**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | +**Enabled** | Pointer to **bool** | Indicates if the scheduled search is enabled. | [optional] [default to false] +**EmailEmptyResults** | Pointer to **bool** | Indicates if email generation should occur when search returns no results. | [optional] [default to false] +**DisplayQueryDetails** | Pointer to **bool** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to false] +**Id** | **string** | The scheduled search ID. | [readonly] +**Owner** | [**ScheduledSearchAllOfOwner**](scheduled-search-all-of-owner) | | +**OwnerId** | **string** | The ID of the scheduled search owner. Please use the `id` in the `owner` object instead. | [readonly] + +## Methods + +### NewScheduledSearch + +`func NewScheduledSearch(savedSearchId string, schedule Schedule2, recipients []SearchScheduleRecipientsInner, id string, owner ScheduledSearchAllOfOwner, ownerId string, ) *ScheduledSearch` + +NewScheduledSearch instantiates a new ScheduledSearch 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 + +### NewScheduledSearchWithDefaults + +`func NewScheduledSearchWithDefaults() *ScheduledSearch` + +NewScheduledSearchWithDefaults instantiates a new ScheduledSearch 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 + +### GetName + +`func (o *ScheduledSearch) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ScheduledSearch) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ScheduledSearch) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ScheduledSearch) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ScheduledSearch) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ScheduledSearch) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *ScheduledSearch) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ScheduledSearch) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ScheduledSearch) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ScheduledSearch) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ScheduledSearch) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ScheduledSearch) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSavedSearchId + +`func (o *ScheduledSearch) GetSavedSearchId() string` + +GetSavedSearchId returns the SavedSearchId field if non-nil, zero value otherwise. + +### GetSavedSearchIdOk + +`func (o *ScheduledSearch) GetSavedSearchIdOk() (*string, bool)` + +GetSavedSearchIdOk returns a tuple with the SavedSearchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSavedSearchId + +`func (o *ScheduledSearch) SetSavedSearchId(v string)` + +SetSavedSearchId sets SavedSearchId field to given value. + + +### GetCreated + +`func (o *ScheduledSearch) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ScheduledSearch) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ScheduledSearch) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ScheduledSearch) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *ScheduledSearch) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *ScheduledSearch) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *ScheduledSearch) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ScheduledSearch) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ScheduledSearch) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ScheduledSearch) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *ScheduledSearch) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *ScheduledSearch) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSchedule + +`func (o *ScheduledSearch) GetSchedule() Schedule2` + +GetSchedule returns the Schedule field if non-nil, zero value otherwise. + +### GetScheduleOk + +`func (o *ScheduledSearch) GetScheduleOk() (*Schedule2, bool)` + +GetScheduleOk returns a tuple with the Schedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchedule + +`func (o *ScheduledSearch) SetSchedule(v Schedule2)` + +SetSchedule sets Schedule field to given value. + + +### GetRecipients + +`func (o *ScheduledSearch) GetRecipients() []SearchScheduleRecipientsInner` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *ScheduledSearch) GetRecipientsOk() (*[]SearchScheduleRecipientsInner, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *ScheduledSearch) SetRecipients(v []SearchScheduleRecipientsInner)` + +SetRecipients sets Recipients field to given value. + + +### GetEnabled + +`func (o *ScheduledSearch) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ScheduledSearch) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ScheduledSearch) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ScheduledSearch) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEmailEmptyResults + +`func (o *ScheduledSearch) GetEmailEmptyResults() bool` + +GetEmailEmptyResults returns the EmailEmptyResults field if non-nil, zero value otherwise. + +### GetEmailEmptyResultsOk + +`func (o *ScheduledSearch) GetEmailEmptyResultsOk() (*bool, bool)` + +GetEmailEmptyResultsOk returns a tuple with the EmailEmptyResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEmptyResults + +`func (o *ScheduledSearch) SetEmailEmptyResults(v bool)` + +SetEmailEmptyResults sets EmailEmptyResults field to given value. + +### HasEmailEmptyResults + +`func (o *ScheduledSearch) HasEmailEmptyResults() bool` + +HasEmailEmptyResults returns a boolean if a field has been set. + +### GetDisplayQueryDetails + +`func (o *ScheduledSearch) GetDisplayQueryDetails() bool` + +GetDisplayQueryDetails returns the DisplayQueryDetails field if non-nil, zero value otherwise. + +### GetDisplayQueryDetailsOk + +`func (o *ScheduledSearch) GetDisplayQueryDetailsOk() (*bool, bool)` + +GetDisplayQueryDetailsOk returns a tuple with the DisplayQueryDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayQueryDetails + +`func (o *ScheduledSearch) SetDisplayQueryDetails(v bool)` + +SetDisplayQueryDetails sets DisplayQueryDetails field to given value. + +### HasDisplayQueryDetails + +`func (o *ScheduledSearch) HasDisplayQueryDetails() bool` + +HasDisplayQueryDetails returns a boolean if a field has been set. + +### GetId + +`func (o *ScheduledSearch) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ScheduledSearch) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ScheduledSearch) SetId(v string)` + +SetId sets Id field to given value. + + +### GetOwner + +`func (o *ScheduledSearch) GetOwner() ScheduledSearchAllOfOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *ScheduledSearch) GetOwnerOk() (*ScheduledSearchAllOfOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *ScheduledSearch) SetOwner(v ScheduledSearchAllOfOwner)` + +SetOwner sets Owner field to given value. + + +### GetOwnerId + +`func (o *ScheduledSearch) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *ScheduledSearch) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *ScheduledSearch) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ScheduledSearchAllOfOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledSearchAllOfOwner.md new file mode 100644 index 000000000..1b7703505 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledSearchAllOfOwner.md @@ -0,0 +1,80 @@ +--- +id: v2025-scheduled-search-all-of-owner +title: ScheduledSearchAllOfOwner +pagination_label: ScheduledSearchAllOfOwner +sidebar_label: ScheduledSearchAllOfOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledSearchAllOfOwner', 'V2025ScheduledSearchAllOfOwner'] +slug: /tools/sdk/go/v2025/models/scheduled-search-all-of-owner +tags: ['SDK', 'Software Development Kit', 'ScheduledSearchAllOfOwner', 'V2025ScheduledSearchAllOfOwner'] +--- + +# ScheduledSearchAllOfOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of object being referenced | +**Id** | **string** | The ID of the referenced object | + +## Methods + +### NewScheduledSearchAllOfOwner + +`func NewScheduledSearchAllOfOwner(type_ string, id string, ) *ScheduledSearchAllOfOwner` + +NewScheduledSearchAllOfOwner instantiates a new ScheduledSearchAllOfOwner 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 + +### NewScheduledSearchAllOfOwnerWithDefaults + +`func NewScheduledSearchAllOfOwnerWithDefaults() *ScheduledSearchAllOfOwner` + +NewScheduledSearchAllOfOwnerWithDefaults instantiates a new ScheduledSearchAllOfOwner 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 + +### GetType + +`func (o *ScheduledSearchAllOfOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ScheduledSearchAllOfOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ScheduledSearchAllOfOwner) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *ScheduledSearchAllOfOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ScheduledSearchAllOfOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ScheduledSearchAllOfOwner) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ScheduledSearchName.md b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledSearchName.md new file mode 100644 index 000000000..0e30d4686 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ScheduledSearchName.md @@ -0,0 +1,110 @@ +--- +id: v2025-scheduled-search-name +title: ScheduledSearchName +pagination_label: ScheduledSearchName +sidebar_label: ScheduledSearchName +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledSearchName', 'V2025ScheduledSearchName'] +slug: /tools/sdk/go/v2025/models/scheduled-search-name +tags: ['SDK', 'Software Development Kit', 'ScheduledSearchName', 'V2025ScheduledSearchName'] +--- + +# ScheduledSearchName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **NullableString** | The name of the scheduled search. | [optional] +**Description** | Pointer to **NullableString** | The description of the scheduled search. | [optional] + +## Methods + +### NewScheduledSearchName + +`func NewScheduledSearchName() *ScheduledSearchName` + +NewScheduledSearchName instantiates a new ScheduledSearchName 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 + +### NewScheduledSearchNameWithDefaults + +`func NewScheduledSearchNameWithDefaults() *ScheduledSearchName` + +NewScheduledSearchNameWithDefaults instantiates a new ScheduledSearchName 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 + +### GetName + +`func (o *ScheduledSearchName) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ScheduledSearchName) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ScheduledSearchName) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ScheduledSearchName) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ScheduledSearchName) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ScheduledSearchName) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *ScheduledSearchName) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ScheduledSearchName) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ScheduledSearchName) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ScheduledSearchName) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ScheduledSearchName) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ScheduledSearchName) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Schema.md b/docs/tools/sdk/go/Reference/V2025/Models/Schema.md new file mode 100644 index 000000000..631ac6f89 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Schema.md @@ -0,0 +1,370 @@ +--- +id: v2025-schema +title: Schema +pagination_label: Schema +sidebar_label: Schema +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schema', 'V2025Schema'] +slug: /tools/sdk/go/v2025/models/schema +tags: ['SDK', 'Software Development Kit', 'Schema', 'V2025Schema'] +--- + +# Schema + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the Schema. | [optional] +**Name** | Pointer to **string** | The name of the Schema. | [optional] +**NativeObjectType** | Pointer to **string** | The name of the object type on the native system that the schema represents. | [optional] +**IdentityAttribute** | Pointer to **string** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional] +**DisplayAttribute** | Pointer to **string** | The name of the attribute used to calculate the display value for an object in the schema. | [optional] +**HierarchyAttribute** | Pointer to **NullableString** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional] +**IncludePermissions** | Pointer to **bool** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] +**Features** | Pointer to **[]string** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Configuration** | Pointer to **map[string]interface{}** | Holds any extra configuration data that the schema may require. | [optional] +**Attributes** | Pointer to [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional] +**Created** | Pointer to **SailPointTime** | The date the Schema was created. | [optional] +**Modified** | Pointer to **NullableTime** | The date the Schema was last modified. | [optional] + +## Methods + +### NewSchema + +`func NewSchema() *Schema` + +NewSchema instantiates a new Schema 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 + +### NewSchemaWithDefaults + +`func NewSchemaWithDefaults() *Schema` + +NewSchemaWithDefaults instantiates a new Schema 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 + +### GetId + +`func (o *Schema) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Schema) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Schema) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Schema) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Schema) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Schema) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Schema) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Schema) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetNativeObjectType + +`func (o *Schema) GetNativeObjectType() string` + +GetNativeObjectType returns the NativeObjectType field if non-nil, zero value otherwise. + +### GetNativeObjectTypeOk + +`func (o *Schema) GetNativeObjectTypeOk() (*string, bool)` + +GetNativeObjectTypeOk returns a tuple with the NativeObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeObjectType + +`func (o *Schema) SetNativeObjectType(v string)` + +SetNativeObjectType sets NativeObjectType field to given value. + +### HasNativeObjectType + +`func (o *Schema) HasNativeObjectType() bool` + +HasNativeObjectType returns a boolean if a field has been set. + +### GetIdentityAttribute + +`func (o *Schema) GetIdentityAttribute() string` + +GetIdentityAttribute returns the IdentityAttribute field if non-nil, zero value otherwise. + +### GetIdentityAttributeOk + +`func (o *Schema) GetIdentityAttributeOk() (*string, bool)` + +GetIdentityAttributeOk returns a tuple with the IdentityAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttribute + +`func (o *Schema) SetIdentityAttribute(v string)` + +SetIdentityAttribute sets IdentityAttribute field to given value. + +### HasIdentityAttribute + +`func (o *Schema) HasIdentityAttribute() bool` + +HasIdentityAttribute returns a boolean if a field has been set. + +### GetDisplayAttribute + +`func (o *Schema) GetDisplayAttribute() string` + +GetDisplayAttribute returns the DisplayAttribute field if non-nil, zero value otherwise. + +### GetDisplayAttributeOk + +`func (o *Schema) GetDisplayAttributeOk() (*string, bool)` + +GetDisplayAttributeOk returns a tuple with the DisplayAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayAttribute + +`func (o *Schema) SetDisplayAttribute(v string)` + +SetDisplayAttribute sets DisplayAttribute field to given value. + +### HasDisplayAttribute + +`func (o *Schema) HasDisplayAttribute() bool` + +HasDisplayAttribute returns a boolean if a field has been set. + +### GetHierarchyAttribute + +`func (o *Schema) GetHierarchyAttribute() string` + +GetHierarchyAttribute returns the HierarchyAttribute field if non-nil, zero value otherwise. + +### GetHierarchyAttributeOk + +`func (o *Schema) GetHierarchyAttributeOk() (*string, bool)` + +GetHierarchyAttributeOk returns a tuple with the HierarchyAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHierarchyAttribute + +`func (o *Schema) SetHierarchyAttribute(v string)` + +SetHierarchyAttribute sets HierarchyAttribute field to given value. + +### HasHierarchyAttribute + +`func (o *Schema) HasHierarchyAttribute() bool` + +HasHierarchyAttribute returns a boolean if a field has been set. + +### SetHierarchyAttributeNil + +`func (o *Schema) SetHierarchyAttributeNil(b bool)` + + SetHierarchyAttributeNil sets the value for HierarchyAttribute to be an explicit nil + +### UnsetHierarchyAttribute +`func (o *Schema) UnsetHierarchyAttribute()` + +UnsetHierarchyAttribute ensures that no value is present for HierarchyAttribute, not even an explicit nil +### GetIncludePermissions + +`func (o *Schema) GetIncludePermissions() bool` + +GetIncludePermissions returns the IncludePermissions field if non-nil, zero value otherwise. + +### GetIncludePermissionsOk + +`func (o *Schema) GetIncludePermissionsOk() (*bool, bool)` + +GetIncludePermissionsOk returns a tuple with the IncludePermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludePermissions + +`func (o *Schema) SetIncludePermissions(v bool)` + +SetIncludePermissions sets IncludePermissions field to given value. + +### HasIncludePermissions + +`func (o *Schema) HasIncludePermissions() bool` + +HasIncludePermissions returns a boolean if a field has been set. + +### GetFeatures + +`func (o *Schema) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *Schema) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *Schema) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *Schema) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### GetConfiguration + +`func (o *Schema) GetConfiguration() map[string]interface{}` + +GetConfiguration returns the Configuration field if non-nil, zero value otherwise. + +### GetConfigurationOk + +`func (o *Schema) GetConfigurationOk() (*map[string]interface{}, bool)` + +GetConfigurationOk returns a tuple with the Configuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfiguration + +`func (o *Schema) SetConfiguration(v map[string]interface{})` + +SetConfiguration sets Configuration field to given value. + +### HasConfiguration + +`func (o *Schema) HasConfiguration() bool` + +HasConfiguration returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Schema) GetAttributes() []AttributeDefinition` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Schema) GetAttributesOk() (*[]AttributeDefinition, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Schema) SetAttributes(v []AttributeDefinition)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Schema) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetCreated + +`func (o *Schema) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Schema) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Schema) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Schema) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Schema) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Schema) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Schema) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Schema) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *Schema) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *Schema) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Scope.md b/docs/tools/sdk/go/Reference/V2025/Models/Scope.md new file mode 100644 index 000000000..41eaeaf9e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Scope.md @@ -0,0 +1,142 @@ +--- +id: v2025-scope +title: Scope +pagination_label: Scope +sidebar_label: Scope +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Scope', 'V2025Scope'] +slug: /tools/sdk/go/v2025/models/scope +tags: ['SDK', 'Software Development Kit', 'Scope', 'V2025Scope'] +--- + +# Scope + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scope** | Pointer to [**ScopeType**](scope-type) | | [optional] +**Visibility** | Pointer to [**ScopeVisibilityType**](scope-visibility-type) | | [optional] +**ScopeFilter** | Pointer to [**VisibilityCriteria**](visibility-criteria) | | [optional] +**ScopeSelection** | Pointer to [**[]Ref**](ref) | List of Identities that are assigned to the segment | [optional] + +## Methods + +### NewScope + +`func NewScope() *Scope` + +NewScope instantiates a new Scope 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 + +### NewScopeWithDefaults + +`func NewScopeWithDefaults() *Scope` + +NewScopeWithDefaults instantiates a new Scope 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 + +### GetScope + +`func (o *Scope) GetScope() ScopeType` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *Scope) GetScopeOk() (*ScopeType, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *Scope) SetScope(v ScopeType)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *Scope) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### GetVisibility + +`func (o *Scope) GetVisibility() ScopeVisibilityType` + +GetVisibility returns the Visibility field if non-nil, zero value otherwise. + +### GetVisibilityOk + +`func (o *Scope) GetVisibilityOk() (*ScopeVisibilityType, bool)` + +GetVisibilityOk returns a tuple with the Visibility field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVisibility + +`func (o *Scope) SetVisibility(v ScopeVisibilityType)` + +SetVisibility sets Visibility field to given value. + +### HasVisibility + +`func (o *Scope) HasVisibility() bool` + +HasVisibility returns a boolean if a field has been set. + +### GetScopeFilter + +`func (o *Scope) GetScopeFilter() VisibilityCriteria` + +GetScopeFilter returns the ScopeFilter field if non-nil, zero value otherwise. + +### GetScopeFilterOk + +`func (o *Scope) GetScopeFilterOk() (*VisibilityCriteria, bool)` + +GetScopeFilterOk returns a tuple with the ScopeFilter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScopeFilter + +`func (o *Scope) SetScopeFilter(v VisibilityCriteria)` + +SetScopeFilter sets ScopeFilter field to given value. + +### HasScopeFilter + +`func (o *Scope) HasScopeFilter() bool` + +HasScopeFilter returns a boolean if a field has been set. + +### GetScopeSelection + +`func (o *Scope) GetScopeSelection() []Ref` + +GetScopeSelection returns the ScopeSelection field if non-nil, zero value otherwise. + +### GetScopeSelectionOk + +`func (o *Scope) GetScopeSelectionOk() (*[]Ref, bool)` + +GetScopeSelectionOk returns a tuple with the ScopeSelection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScopeSelection + +`func (o *Scope) SetScopeSelection(v []Ref)` + +SetScopeSelection sets ScopeSelection field to given value. + +### HasScopeSelection + +`func (o *Scope) HasScopeSelection() bool` + +HasScopeSelection returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ScopeType.md b/docs/tools/sdk/go/Reference/V2025/Models/ScopeType.md new file mode 100644 index 000000000..63c008635 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ScopeType.md @@ -0,0 +1,25 @@ +--- +id: v2025-scope-type +title: ScopeType +pagination_label: ScopeType +sidebar_label: ScopeType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScopeType', 'V2025ScopeType'] +slug: /tools/sdk/go/v2025/models/scope-type +tags: ['SDK', 'Software Development Kit', 'ScopeType', 'V2025ScopeType'] +--- + +# ScopeType + +## Enum + + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + +* `CERTIFICATION` (value: `"CERTIFICATION"`) + +* `IDENTITY` (value: `"IDENTITY"`) + +* `ENTITLEMENTREQUEST` (value: `"ENTITLEMENTREQUEST"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ScopeVisibilityType.md b/docs/tools/sdk/go/Reference/V2025/Models/ScopeVisibilityType.md new file mode 100644 index 000000000..5abd5f0db --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ScopeVisibilityType.md @@ -0,0 +1,25 @@ +--- +id: v2025-scope-visibility-type +title: ScopeVisibilityType +pagination_label: ScopeVisibilityType +sidebar_label: ScopeVisibilityType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScopeVisibilityType', 'V2025ScopeVisibilityType'] +slug: /tools/sdk/go/v2025/models/scope-visibility-type +tags: ['SDK', 'Software Development Kit', 'ScopeVisibilityType', 'V2025ScopeVisibilityType'] +--- + +# ScopeVisibilityType + +## Enum + + +* `ALL` (value: `"ALL"`) + +* `FILTER` (value: `"FILTER"`) + +* `SELECTION` (value: `"SELECTION"`) + +* `UNSEGMENTED` (value: `"UNSEGMENTED"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Search.md b/docs/tools/sdk/go/Reference/V2025/Models/Search.md new file mode 100644 index 000000000..adcbef719 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Search.md @@ -0,0 +1,454 @@ +--- +id: v2025-search +title: Search +pagination_label: Search +sidebar_label: Search +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Search', 'V2025Search'] +slug: /tools/sdk/go/v2025/models/search +tags: ['SDK', 'Software Development Kit', 'Search', 'V2025Search'] +--- + +# Search + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**QueryType** | Pointer to [**QueryType**](query-type) | | [optional] [default to QUERYTYPE_SAILPOINT] +**QueryVersion** | Pointer to **string** | | [optional] +**Query** | Pointer to [**Query**](query) | | [optional] +**QueryDsl** | Pointer to **map[string]interface{}** | The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. | [optional] +**TextQuery** | Pointer to [**TextQuery**](text-query) | | [optional] +**TypeAheadQuery** | Pointer to [**TypeAheadQuery**](type-ahead-query) | | [optional] +**IncludeNested** | Pointer to **bool** | Indicates whether nested objects from returned search results should be included. | [optional] [default to true] +**QueryResultFilter** | Pointer to [**QueryResultFilter**](query-result-filter) | | [optional] +**AggregationType** | Pointer to [**AggregationType**](aggregation-type) | | [optional] [default to AGGREGATIONTYPE_DSL] +**AggregationsVersion** | Pointer to **string** | | [optional] +**AggregationsDsl** | Pointer to **map[string]interface{}** | The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. | [optional] +**Aggregations** | Pointer to [**SearchAggregationSpecification**](search-aggregation-specification) | | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] +**SearchAfter** | Pointer to **[]string** | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [\"displayName\", \"id\"]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is \"John Doe\", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like [\"John Doe\",\"2c91808375d8e80a0175e1f88a575221\"] | [optional] +**Filters** | Pointer to [**map[string]Filter**](filter) | The filters to be applied for each filtered field name. | [optional] + +## Methods + +### NewSearch + +`func NewSearch() *Search` + +NewSearch instantiates a new Search 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 + +### NewSearchWithDefaults + +`func NewSearchWithDefaults() *Search` + +NewSearchWithDefaults instantiates a new Search 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 + +### GetIndices + +`func (o *Search) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *Search) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *Search) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + +### HasIndices + +`func (o *Search) HasIndices() bool` + +HasIndices returns a boolean if a field has been set. + +### GetQueryType + +`func (o *Search) GetQueryType() QueryType` + +GetQueryType returns the QueryType field if non-nil, zero value otherwise. + +### GetQueryTypeOk + +`func (o *Search) GetQueryTypeOk() (*QueryType, bool)` + +GetQueryTypeOk returns a tuple with the QueryType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueryType + +`func (o *Search) SetQueryType(v QueryType)` + +SetQueryType sets QueryType field to given value. + +### HasQueryType + +`func (o *Search) HasQueryType() bool` + +HasQueryType returns a boolean if a field has been set. + +### GetQueryVersion + +`func (o *Search) GetQueryVersion() string` + +GetQueryVersion returns the QueryVersion field if non-nil, zero value otherwise. + +### GetQueryVersionOk + +`func (o *Search) GetQueryVersionOk() (*string, bool)` + +GetQueryVersionOk returns a tuple with the QueryVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueryVersion + +`func (o *Search) SetQueryVersion(v string)` + +SetQueryVersion sets QueryVersion field to given value. + +### HasQueryVersion + +`func (o *Search) HasQueryVersion() bool` + +HasQueryVersion returns a boolean if a field has been set. + +### GetQuery + +`func (o *Search) GetQuery() Query` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *Search) GetQueryOk() (*Query, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *Search) SetQuery(v Query)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *Search) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### GetQueryDsl + +`func (o *Search) GetQueryDsl() map[string]interface{}` + +GetQueryDsl returns the QueryDsl field if non-nil, zero value otherwise. + +### GetQueryDslOk + +`func (o *Search) GetQueryDslOk() (*map[string]interface{}, bool)` + +GetQueryDslOk returns a tuple with the QueryDsl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueryDsl + +`func (o *Search) SetQueryDsl(v map[string]interface{})` + +SetQueryDsl sets QueryDsl field to given value. + +### HasQueryDsl + +`func (o *Search) HasQueryDsl() bool` + +HasQueryDsl returns a boolean if a field has been set. + +### GetTextQuery + +`func (o *Search) GetTextQuery() TextQuery` + +GetTextQuery returns the TextQuery field if non-nil, zero value otherwise. + +### GetTextQueryOk + +`func (o *Search) GetTextQueryOk() (*TextQuery, bool)` + +GetTextQueryOk returns a tuple with the TextQuery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTextQuery + +`func (o *Search) SetTextQuery(v TextQuery)` + +SetTextQuery sets TextQuery field to given value. + +### HasTextQuery + +`func (o *Search) HasTextQuery() bool` + +HasTextQuery returns a boolean if a field has been set. + +### GetTypeAheadQuery + +`func (o *Search) GetTypeAheadQuery() TypeAheadQuery` + +GetTypeAheadQuery returns the TypeAheadQuery field if non-nil, zero value otherwise. + +### GetTypeAheadQueryOk + +`func (o *Search) GetTypeAheadQueryOk() (*TypeAheadQuery, bool)` + +GetTypeAheadQueryOk returns a tuple with the TypeAheadQuery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeAheadQuery + +`func (o *Search) SetTypeAheadQuery(v TypeAheadQuery)` + +SetTypeAheadQuery sets TypeAheadQuery field to given value. + +### HasTypeAheadQuery + +`func (o *Search) HasTypeAheadQuery() bool` + +HasTypeAheadQuery returns a boolean if a field has been set. + +### GetIncludeNested + +`func (o *Search) GetIncludeNested() bool` + +GetIncludeNested returns the IncludeNested field if non-nil, zero value otherwise. + +### GetIncludeNestedOk + +`func (o *Search) GetIncludeNestedOk() (*bool, bool)` + +GetIncludeNestedOk returns a tuple with the IncludeNested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeNested + +`func (o *Search) SetIncludeNested(v bool)` + +SetIncludeNested sets IncludeNested field to given value. + +### HasIncludeNested + +`func (o *Search) HasIncludeNested() bool` + +HasIncludeNested returns a boolean if a field has been set. + +### GetQueryResultFilter + +`func (o *Search) GetQueryResultFilter() QueryResultFilter` + +GetQueryResultFilter returns the QueryResultFilter field if non-nil, zero value otherwise. + +### GetQueryResultFilterOk + +`func (o *Search) GetQueryResultFilterOk() (*QueryResultFilter, bool)` + +GetQueryResultFilterOk returns a tuple with the QueryResultFilter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueryResultFilter + +`func (o *Search) SetQueryResultFilter(v QueryResultFilter)` + +SetQueryResultFilter sets QueryResultFilter field to given value. + +### HasQueryResultFilter + +`func (o *Search) HasQueryResultFilter() bool` + +HasQueryResultFilter returns a boolean if a field has been set. + +### GetAggregationType + +`func (o *Search) GetAggregationType() AggregationType` + +GetAggregationType returns the AggregationType field if non-nil, zero value otherwise. + +### GetAggregationTypeOk + +`func (o *Search) GetAggregationTypeOk() (*AggregationType, bool)` + +GetAggregationTypeOk returns a tuple with the AggregationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationType + +`func (o *Search) SetAggregationType(v AggregationType)` + +SetAggregationType sets AggregationType field to given value. + +### HasAggregationType + +`func (o *Search) HasAggregationType() bool` + +HasAggregationType returns a boolean if a field has been set. + +### GetAggregationsVersion + +`func (o *Search) GetAggregationsVersion() string` + +GetAggregationsVersion returns the AggregationsVersion field if non-nil, zero value otherwise. + +### GetAggregationsVersionOk + +`func (o *Search) GetAggregationsVersionOk() (*string, bool)` + +GetAggregationsVersionOk returns a tuple with the AggregationsVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationsVersion + +`func (o *Search) SetAggregationsVersion(v string)` + +SetAggregationsVersion sets AggregationsVersion field to given value. + +### HasAggregationsVersion + +`func (o *Search) HasAggregationsVersion() bool` + +HasAggregationsVersion returns a boolean if a field has been set. + +### GetAggregationsDsl + +`func (o *Search) GetAggregationsDsl() map[string]interface{}` + +GetAggregationsDsl returns the AggregationsDsl field if non-nil, zero value otherwise. + +### GetAggregationsDslOk + +`func (o *Search) GetAggregationsDslOk() (*map[string]interface{}, bool)` + +GetAggregationsDslOk returns a tuple with the AggregationsDsl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationsDsl + +`func (o *Search) SetAggregationsDsl(v map[string]interface{})` + +SetAggregationsDsl sets AggregationsDsl field to given value. + +### HasAggregationsDsl + +`func (o *Search) HasAggregationsDsl() bool` + +HasAggregationsDsl returns a boolean if a field has been set. + +### GetAggregations + +`func (o *Search) GetAggregations() SearchAggregationSpecification` + +GetAggregations returns the Aggregations field if non-nil, zero value otherwise. + +### GetAggregationsOk + +`func (o *Search) GetAggregationsOk() (*SearchAggregationSpecification, bool)` + +GetAggregationsOk returns a tuple with the Aggregations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregations + +`func (o *Search) SetAggregations(v SearchAggregationSpecification)` + +SetAggregations sets Aggregations field to given value. + +### HasAggregations + +`func (o *Search) HasAggregations() bool` + +HasAggregations returns a boolean if a field has been set. + +### GetSort + +`func (o *Search) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *Search) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *Search) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *Search) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### GetSearchAfter + +`func (o *Search) GetSearchAfter() []string` + +GetSearchAfter returns the SearchAfter field if non-nil, zero value otherwise. + +### GetSearchAfterOk + +`func (o *Search) GetSearchAfterOk() (*[]string, bool)` + +GetSearchAfterOk returns a tuple with the SearchAfter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchAfter + +`func (o *Search) SetSearchAfter(v []string)` + +SetSearchAfter sets SearchAfter field to given value. + +### HasSearchAfter + +`func (o *Search) HasSearchAfter() bool` + +HasSearchAfter returns a boolean if a field has been set. + +### GetFilters + +`func (o *Search) GetFilters() map[string]Filter` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *Search) GetFiltersOk() (*map[string]Filter, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *Search) SetFilters(v map[string]Filter)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *Search) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SearchAggregationSpecification.md b/docs/tools/sdk/go/Reference/V2025/Models/SearchAggregationSpecification.md new file mode 100644 index 000000000..91ea6a360 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SearchAggregationSpecification.md @@ -0,0 +1,168 @@ +--- +id: v2025-search-aggregation-specification +title: SearchAggregationSpecification +pagination_label: SearchAggregationSpecification +sidebar_label: SearchAggregationSpecification +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchAggregationSpecification', 'V2025SearchAggregationSpecification'] +slug: /tools/sdk/go/v2025/models/search-aggregation-specification +tags: ['SDK', 'Software Development Kit', 'SearchAggregationSpecification', 'V2025SearchAggregationSpecification'] +--- + +# SearchAggregationSpecification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional] +**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional] +**Filter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional] +**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional] +**SubAggregation** | Pointer to [**SubSearchAggregationSpecification**](sub-search-aggregation-specification) | | [optional] + +## Methods + +### NewSearchAggregationSpecification + +`func NewSearchAggregationSpecification() *SearchAggregationSpecification` + +NewSearchAggregationSpecification instantiates a new SearchAggregationSpecification 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 + +### NewSearchAggregationSpecificationWithDefaults + +`func NewSearchAggregationSpecificationWithDefaults() *SearchAggregationSpecification` + +NewSearchAggregationSpecificationWithDefaults instantiates a new SearchAggregationSpecification 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 + +### GetNested + +`func (o *SearchAggregationSpecification) GetNested() NestedAggregation` + +GetNested returns the Nested field if non-nil, zero value otherwise. + +### GetNestedOk + +`func (o *SearchAggregationSpecification) GetNestedOk() (*NestedAggregation, bool)` + +GetNestedOk returns a tuple with the Nested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNested + +`func (o *SearchAggregationSpecification) SetNested(v NestedAggregation)` + +SetNested sets Nested field to given value. + +### HasNested + +`func (o *SearchAggregationSpecification) HasNested() bool` + +HasNested returns a boolean if a field has been set. + +### GetMetric + +`func (o *SearchAggregationSpecification) GetMetric() MetricAggregation` + +GetMetric returns the Metric field if non-nil, zero value otherwise. + +### GetMetricOk + +`func (o *SearchAggregationSpecification) GetMetricOk() (*MetricAggregation, bool)` + +GetMetricOk returns a tuple with the Metric field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetric + +`func (o *SearchAggregationSpecification) SetMetric(v MetricAggregation)` + +SetMetric sets Metric field to given value. + +### HasMetric + +`func (o *SearchAggregationSpecification) HasMetric() bool` + +HasMetric returns a boolean if a field has been set. + +### GetFilter + +`func (o *SearchAggregationSpecification) GetFilter() FilterAggregation` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *SearchAggregationSpecification) GetFilterOk() (*FilterAggregation, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *SearchAggregationSpecification) SetFilter(v FilterAggregation)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *SearchAggregationSpecification) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### GetBucket + +`func (o *SearchAggregationSpecification) GetBucket() BucketAggregation` + +GetBucket returns the Bucket field if non-nil, zero value otherwise. + +### GetBucketOk + +`func (o *SearchAggregationSpecification) GetBucketOk() (*BucketAggregation, bool)` + +GetBucketOk returns a tuple with the Bucket field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBucket + +`func (o *SearchAggregationSpecification) SetBucket(v BucketAggregation)` + +SetBucket sets Bucket field to given value. + +### HasBucket + +`func (o *SearchAggregationSpecification) HasBucket() bool` + +HasBucket returns a boolean if a field has been set. + +### GetSubAggregation + +`func (o *SearchAggregationSpecification) GetSubAggregation() SubSearchAggregationSpecification` + +GetSubAggregation returns the SubAggregation field if non-nil, zero value otherwise. + +### GetSubAggregationOk + +`func (o *SearchAggregationSpecification) GetSubAggregationOk() (*SubSearchAggregationSpecification, bool)` + +GetSubAggregationOk returns a tuple with the SubAggregation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubAggregation + +`func (o *SearchAggregationSpecification) SetSubAggregation(v SubSearchAggregationSpecification)` + +SetSubAggregation sets SubAggregation field to given value. + +### HasSubAggregation + +`func (o *SearchAggregationSpecification) HasSubAggregation() bool` + +HasSubAggregation returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SearchArguments.md b/docs/tools/sdk/go/Reference/V2025/Models/SearchArguments.md new file mode 100644 index 000000000..3e39a4ab1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SearchArguments.md @@ -0,0 +1,116 @@ +--- +id: v2025-search-arguments +title: SearchArguments +pagination_label: SearchArguments +sidebar_label: SearchArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchArguments', 'V2025SearchArguments'] +slug: /tools/sdk/go/v2025/models/search-arguments +tags: ['SDK', 'Software Development Kit', 'SearchArguments', 'V2025SearchArguments'] +--- + +# SearchArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ScheduleId** | Pointer to **string** | The ID of the scheduled search that triggered the saved search execution. | [optional] +**Owner** | Pointer to [**TypedReference**](typed-reference) | The owner of the scheduled search being tested. | [optional] +**Recipients** | Pointer to [**[]TypedReference**](typed-reference) | The email recipients of the scheduled search being tested. | [optional] + +## Methods + +### NewSearchArguments + +`func NewSearchArguments() *SearchArguments` + +NewSearchArguments instantiates a new SearchArguments 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 + +### NewSearchArgumentsWithDefaults + +`func NewSearchArgumentsWithDefaults() *SearchArguments` + +NewSearchArgumentsWithDefaults instantiates a new SearchArguments 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 + +### GetScheduleId + +`func (o *SearchArguments) GetScheduleId() string` + +GetScheduleId returns the ScheduleId field if non-nil, zero value otherwise. + +### GetScheduleIdOk + +`func (o *SearchArguments) GetScheduleIdOk() (*string, bool)` + +GetScheduleIdOk returns a tuple with the ScheduleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheduleId + +`func (o *SearchArguments) SetScheduleId(v string)` + +SetScheduleId sets ScheduleId field to given value. + +### HasScheduleId + +`func (o *SearchArguments) HasScheduleId() bool` + +HasScheduleId returns a boolean if a field has been set. + +### GetOwner + +`func (o *SearchArguments) GetOwner() TypedReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *SearchArguments) GetOwnerOk() (*TypedReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *SearchArguments) SetOwner(v TypedReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *SearchArguments) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRecipients + +`func (o *SearchArguments) GetRecipients() []TypedReference` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *SearchArguments) GetRecipientsOk() (*[]TypedReference, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *SearchArguments) SetRecipients(v []TypedReference)` + +SetRecipients sets Recipients field to given value. + +### HasRecipients + +`func (o *SearchArguments) HasRecipients() bool` + +HasRecipients returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SearchAttributeConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/SearchAttributeConfig.md new file mode 100644 index 000000000..025216332 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SearchAttributeConfig.md @@ -0,0 +1,116 @@ +--- +id: v2025-search-attribute-config +title: SearchAttributeConfig +pagination_label: SearchAttributeConfig +sidebar_label: SearchAttributeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchAttributeConfig', 'V2025SearchAttributeConfig'] +slug: /tools/sdk/go/v2025/models/search-attribute-config +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfig', 'V2025SearchAttributeConfig'] +--- + +# SearchAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the new attribute | [optional] +**DisplayName** | Pointer to **string** | The display name of the new attribute | [optional] +**ApplicationAttributes** | Pointer to **map[string]interface{}** | Map of application id and their associated attribute. | [optional] + +## Methods + +### NewSearchAttributeConfig + +`func NewSearchAttributeConfig() *SearchAttributeConfig` + +NewSearchAttributeConfig instantiates a new SearchAttributeConfig 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 + +### NewSearchAttributeConfigWithDefaults + +`func NewSearchAttributeConfigWithDefaults() *SearchAttributeConfig` + +NewSearchAttributeConfigWithDefaults instantiates a new SearchAttributeConfig 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 + +### GetName + +`func (o *SearchAttributeConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SearchAttributeConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SearchAttributeConfig) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SearchAttributeConfig) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *SearchAttributeConfig) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *SearchAttributeConfig) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *SearchAttributeConfig) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *SearchAttributeConfig) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetApplicationAttributes + +`func (o *SearchAttributeConfig) GetApplicationAttributes() map[string]interface{}` + +GetApplicationAttributes returns the ApplicationAttributes field if non-nil, zero value otherwise. + +### GetApplicationAttributesOk + +`func (o *SearchAttributeConfig) GetApplicationAttributesOk() (*map[string]interface{}, bool)` + +GetApplicationAttributesOk returns a tuple with the ApplicationAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationAttributes + +`func (o *SearchAttributeConfig) SetApplicationAttributes(v map[string]interface{})` + +SetApplicationAttributes sets ApplicationAttributes field to given value. + +### HasApplicationAttributes + +`func (o *SearchAttributeConfig) HasApplicationAttributes() bool` + +HasApplicationAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SearchExportReportArguments.md b/docs/tools/sdk/go/Reference/V2025/Models/SearchExportReportArguments.md new file mode 100644 index 000000000..5265b84fc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SearchExportReportArguments.md @@ -0,0 +1,137 @@ +--- +id: v2025-search-export-report-arguments +title: SearchExportReportArguments +pagination_label: SearchExportReportArguments +sidebar_label: SearchExportReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchExportReportArguments', 'V2025SearchExportReportArguments'] +slug: /tools/sdk/go/v2025/models/search-export-report-arguments +tags: ['SDK', 'Software Development Kit', 'SearchExportReportArguments', 'V2025SearchExportReportArguments'] +--- + +# SearchExportReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**Query** | **string** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | +**Columns** | Pointer to **string** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] + +## Methods + +### NewSearchExportReportArguments + +`func NewSearchExportReportArguments(query string, ) *SearchExportReportArguments` + +NewSearchExportReportArguments instantiates a new SearchExportReportArguments 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 + +### NewSearchExportReportArgumentsWithDefaults + +`func NewSearchExportReportArgumentsWithDefaults() *SearchExportReportArguments` + +NewSearchExportReportArgumentsWithDefaults instantiates a new SearchExportReportArguments 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 + +### GetIndices + +`func (o *SearchExportReportArguments) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *SearchExportReportArguments) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *SearchExportReportArguments) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + +### HasIndices + +`func (o *SearchExportReportArguments) HasIndices() bool` + +HasIndices returns a boolean if a field has been set. + +### GetQuery + +`func (o *SearchExportReportArguments) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SearchExportReportArguments) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SearchExportReportArguments) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetColumns + +`func (o *SearchExportReportArguments) GetColumns() string` + +GetColumns returns the Columns field if non-nil, zero value otherwise. + +### GetColumnsOk + +`func (o *SearchExportReportArguments) GetColumnsOk() (*string, bool)` + +GetColumnsOk returns a tuple with the Columns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumns + +`func (o *SearchExportReportArguments) SetColumns(v string)` + +SetColumns sets Columns field to given value. + +### HasColumns + +`func (o *SearchExportReportArguments) HasColumns() bool` + +HasColumns returns a boolean if a field has been set. + +### GetSort + +`func (o *SearchExportReportArguments) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *SearchExportReportArguments) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *SearchExportReportArguments) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *SearchExportReportArguments) HasSort() bool` + +HasSort returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SearchFilterType.md b/docs/tools/sdk/go/Reference/V2025/Models/SearchFilterType.md new file mode 100644 index 000000000..71f113137 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SearchFilterType.md @@ -0,0 +1,19 @@ +--- +id: v2025-search-filter-type +title: SearchFilterType +pagination_label: SearchFilterType +sidebar_label: SearchFilterType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchFilterType', 'V2025SearchFilterType'] +slug: /tools/sdk/go/v2025/models/search-filter-type +tags: ['SDK', 'Software Development Kit', 'SearchFilterType', 'V2025SearchFilterType'] +--- + +# SearchFilterType + +## Enum + + +* `TERM` (value: `"TERM"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SearchFormDefinitionsByTenant400Response.md b/docs/tools/sdk/go/Reference/V2025/Models/SearchFormDefinitionsByTenant400Response.md new file mode 100644 index 000000000..d34b99bc4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SearchFormDefinitionsByTenant400Response.md @@ -0,0 +1,142 @@ +--- +id: v2025-search-form-definitions-by-tenant400-response +title: SearchFormDefinitionsByTenant400Response +pagination_label: SearchFormDefinitionsByTenant400Response +sidebar_label: SearchFormDefinitionsByTenant400Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchFormDefinitionsByTenant400Response', 'V2025SearchFormDefinitionsByTenant400Response'] +slug: /tools/sdk/go/v2025/models/search-form-definitions-by-tenant400-response +tags: ['SDK', 'Software Development Kit', 'SearchFormDefinitionsByTenant400Response', 'V2025SearchFormDefinitionsByTenant400Response'] +--- + +# SearchFormDefinitionsByTenant400Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **string** | | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | | [optional] +**StatusCode** | Pointer to **int64** | | [optional] +**TrackingId** | Pointer to **string** | | [optional] + +## Methods + +### NewSearchFormDefinitionsByTenant400Response + +`func NewSearchFormDefinitionsByTenant400Response() *SearchFormDefinitionsByTenant400Response` + +NewSearchFormDefinitionsByTenant400Response instantiates a new SearchFormDefinitionsByTenant400Response 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 + +### NewSearchFormDefinitionsByTenant400ResponseWithDefaults + +`func NewSearchFormDefinitionsByTenant400ResponseWithDefaults() *SearchFormDefinitionsByTenant400Response` + +NewSearchFormDefinitionsByTenant400ResponseWithDefaults instantiates a new SearchFormDefinitionsByTenant400Response 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 + +### GetDetailCode + +`func (o *SearchFormDefinitionsByTenant400Response) GetDetailCode() string` + +GetDetailCode returns the DetailCode field if non-nil, zero value otherwise. + +### GetDetailCodeOk + +`func (o *SearchFormDefinitionsByTenant400Response) GetDetailCodeOk() (*string, bool)` + +GetDetailCodeOk returns a tuple with the DetailCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetailCode + +`func (o *SearchFormDefinitionsByTenant400Response) SetDetailCode(v string)` + +SetDetailCode sets DetailCode field to given value. + +### HasDetailCode + +`func (o *SearchFormDefinitionsByTenant400Response) HasDetailCode() bool` + +HasDetailCode returns a boolean if a field has been set. + +### GetMessages + +`func (o *SearchFormDefinitionsByTenant400Response) GetMessages() []ErrorMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *SearchFormDefinitionsByTenant400Response) GetMessagesOk() (*[]ErrorMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *SearchFormDefinitionsByTenant400Response) SetMessages(v []ErrorMessage)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *SearchFormDefinitionsByTenant400Response) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetStatusCode + +`func (o *SearchFormDefinitionsByTenant400Response) GetStatusCode() int64` + +GetStatusCode returns the StatusCode field if non-nil, zero value otherwise. + +### GetStatusCodeOk + +`func (o *SearchFormDefinitionsByTenant400Response) GetStatusCodeOk() (*int64, bool)` + +GetStatusCodeOk returns a tuple with the StatusCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusCode + +`func (o *SearchFormDefinitionsByTenant400Response) SetStatusCode(v int64)` + +SetStatusCode sets StatusCode field to given value. + +### HasStatusCode + +`func (o *SearchFormDefinitionsByTenant400Response) HasStatusCode() bool` + +HasStatusCode returns a boolean if a field has been set. + +### GetTrackingId + +`func (o *SearchFormDefinitionsByTenant400Response) GetTrackingId() string` + +GetTrackingId returns the TrackingId field if non-nil, zero value otherwise. + +### GetTrackingIdOk + +`func (o *SearchFormDefinitionsByTenant400Response) GetTrackingIdOk() (*string, bool)` + +GetTrackingIdOk returns a tuple with the TrackingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingId + +`func (o *SearchFormDefinitionsByTenant400Response) SetTrackingId(v string)` + +SetTrackingId sets TrackingId field to given value. + +### HasTrackingId + +`func (o *SearchFormDefinitionsByTenant400Response) HasTrackingId() bool` + +HasTrackingId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SearchSchedule.md b/docs/tools/sdk/go/Reference/V2025/Models/SearchSchedule.md new file mode 100644 index 000000000..d25a5a522 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SearchSchedule.md @@ -0,0 +1,251 @@ +--- +id: v2025-search-schedule +title: SearchSchedule +pagination_label: SearchSchedule +sidebar_label: SearchSchedule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchSchedule', 'V2025SearchSchedule'] +slug: /tools/sdk/go/v2025/models/search-schedule +tags: ['SDK', 'Software Development Kit', 'SearchSchedule', 'V2025SearchSchedule'] +--- + +# SearchSchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SavedSearchId** | **string** | The ID of the saved search that will be executed. | +**Created** | Pointer to **NullableTime** | The date the scheduled search was initially created. | [optional] [readonly] +**Modified** | Pointer to **NullableTime** | The last date the scheduled search was modified. | [optional] [readonly] +**Schedule** | [**Schedule2**](schedule2) | | +**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | +**Enabled** | Pointer to **bool** | Indicates if the scheduled search is enabled. | [optional] [default to false] +**EmailEmptyResults** | Pointer to **bool** | Indicates if email generation should occur when search returns no results. | [optional] [default to false] +**DisplayQueryDetails** | Pointer to **bool** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to false] + +## Methods + +### NewSearchSchedule + +`func NewSearchSchedule(savedSearchId string, schedule Schedule2, recipients []SearchScheduleRecipientsInner, ) *SearchSchedule` + +NewSearchSchedule instantiates a new SearchSchedule 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 + +### NewSearchScheduleWithDefaults + +`func NewSearchScheduleWithDefaults() *SearchSchedule` + +NewSearchScheduleWithDefaults instantiates a new SearchSchedule 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 + +### GetSavedSearchId + +`func (o *SearchSchedule) GetSavedSearchId() string` + +GetSavedSearchId returns the SavedSearchId field if non-nil, zero value otherwise. + +### GetSavedSearchIdOk + +`func (o *SearchSchedule) GetSavedSearchIdOk() (*string, bool)` + +GetSavedSearchIdOk returns a tuple with the SavedSearchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSavedSearchId + +`func (o *SearchSchedule) SetSavedSearchId(v string)` + +SetSavedSearchId sets SavedSearchId field to given value. + + +### GetCreated + +`func (o *SearchSchedule) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SearchSchedule) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SearchSchedule) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SearchSchedule) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *SearchSchedule) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *SearchSchedule) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *SearchSchedule) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SearchSchedule) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SearchSchedule) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SearchSchedule) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *SearchSchedule) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *SearchSchedule) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSchedule + +`func (o *SearchSchedule) GetSchedule() Schedule2` + +GetSchedule returns the Schedule field if non-nil, zero value otherwise. + +### GetScheduleOk + +`func (o *SearchSchedule) GetScheduleOk() (*Schedule2, bool)` + +GetScheduleOk returns a tuple with the Schedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchedule + +`func (o *SearchSchedule) SetSchedule(v Schedule2)` + +SetSchedule sets Schedule field to given value. + + +### GetRecipients + +`func (o *SearchSchedule) GetRecipients() []SearchScheduleRecipientsInner` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *SearchSchedule) GetRecipientsOk() (*[]SearchScheduleRecipientsInner, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *SearchSchedule) SetRecipients(v []SearchScheduleRecipientsInner)` + +SetRecipients sets Recipients field to given value. + + +### GetEnabled + +`func (o *SearchSchedule) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *SearchSchedule) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *SearchSchedule) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *SearchSchedule) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEmailEmptyResults + +`func (o *SearchSchedule) GetEmailEmptyResults() bool` + +GetEmailEmptyResults returns the EmailEmptyResults field if non-nil, zero value otherwise. + +### GetEmailEmptyResultsOk + +`func (o *SearchSchedule) GetEmailEmptyResultsOk() (*bool, bool)` + +GetEmailEmptyResultsOk returns a tuple with the EmailEmptyResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEmptyResults + +`func (o *SearchSchedule) SetEmailEmptyResults(v bool)` + +SetEmailEmptyResults sets EmailEmptyResults field to given value. + +### HasEmailEmptyResults + +`func (o *SearchSchedule) HasEmailEmptyResults() bool` + +HasEmailEmptyResults returns a boolean if a field has been set. + +### GetDisplayQueryDetails + +`func (o *SearchSchedule) GetDisplayQueryDetails() bool` + +GetDisplayQueryDetails returns the DisplayQueryDetails field if non-nil, zero value otherwise. + +### GetDisplayQueryDetailsOk + +`func (o *SearchSchedule) GetDisplayQueryDetailsOk() (*bool, bool)` + +GetDisplayQueryDetailsOk returns a tuple with the DisplayQueryDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayQueryDetails + +`func (o *SearchSchedule) SetDisplayQueryDetails(v bool)` + +SetDisplayQueryDetails sets DisplayQueryDetails field to given value. + +### HasDisplayQueryDetails + +`func (o *SearchSchedule) HasDisplayQueryDetails() bool` + +HasDisplayQueryDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SearchScheduleRecipientsInner.md b/docs/tools/sdk/go/Reference/V2025/Models/SearchScheduleRecipientsInner.md new file mode 100644 index 000000000..3386cd296 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SearchScheduleRecipientsInner.md @@ -0,0 +1,80 @@ +--- +id: v2025-search-schedule-recipients-inner +title: SearchScheduleRecipientsInner +pagination_label: SearchScheduleRecipientsInner +sidebar_label: SearchScheduleRecipientsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchScheduleRecipientsInner', 'V2025SearchScheduleRecipientsInner'] +slug: /tools/sdk/go/v2025/models/search-schedule-recipients-inner +tags: ['SDK', 'Software Development Kit', 'SearchScheduleRecipientsInner', 'V2025SearchScheduleRecipientsInner'] +--- + +# SearchScheduleRecipientsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of object being referenced | +**Id** | **string** | The ID of the referenced object | + +## Methods + +### NewSearchScheduleRecipientsInner + +`func NewSearchScheduleRecipientsInner(type_ string, id string, ) *SearchScheduleRecipientsInner` + +NewSearchScheduleRecipientsInner instantiates a new SearchScheduleRecipientsInner 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 + +### NewSearchScheduleRecipientsInnerWithDefaults + +`func NewSearchScheduleRecipientsInnerWithDefaults() *SearchScheduleRecipientsInner` + +NewSearchScheduleRecipientsInnerWithDefaults instantiates a new SearchScheduleRecipientsInner 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 + +### GetType + +`func (o *SearchScheduleRecipientsInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SearchScheduleRecipientsInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SearchScheduleRecipientsInner) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *SearchScheduleRecipientsInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SearchScheduleRecipientsInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SearchScheduleRecipientsInner) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SectionDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/SectionDetails.md new file mode 100644 index 000000000..2f4f35aac --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SectionDetails.md @@ -0,0 +1,136 @@ +--- +id: v2025-section-details +title: SectionDetails +pagination_label: SectionDetails +sidebar_label: SectionDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SectionDetails', 'V2025SectionDetails'] +slug: /tools/sdk/go/v2025/models/section-details +tags: ['SDK', 'Software Development Kit', 'SectionDetails', 'V2025SectionDetails'] +--- + +# SectionDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **NullableString** | Name of the FormItem | [optional] +**Label** | Pointer to **NullableString** | Label of the section | [optional] +**FormItems** | Pointer to **[]map[string]interface{}** | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [optional] + +## Methods + +### NewSectionDetails + +`func NewSectionDetails() *SectionDetails` + +NewSectionDetails instantiates a new SectionDetails 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 + +### NewSectionDetailsWithDefaults + +`func NewSectionDetailsWithDefaults() *SectionDetails` + +NewSectionDetailsWithDefaults instantiates a new SectionDetails 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 + +### GetName + +`func (o *SectionDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SectionDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SectionDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SectionDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *SectionDetails) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *SectionDetails) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetLabel + +`func (o *SectionDetails) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *SectionDetails) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *SectionDetails) SetLabel(v string)` + +SetLabel sets Label field to given value. + +### HasLabel + +`func (o *SectionDetails) HasLabel() bool` + +HasLabel returns a boolean if a field has been set. + +### SetLabelNil + +`func (o *SectionDetails) SetLabelNil(b bool)` + + SetLabelNil sets the value for Label to be an explicit nil + +### UnsetLabel +`func (o *SectionDetails) UnsetLabel()` + +UnsetLabel ensures that no value is present for Label, not even an explicit nil +### GetFormItems + +`func (o *SectionDetails) GetFormItems() []map[string]interface{}` + +GetFormItems returns the FormItems field if non-nil, zero value otherwise. + +### GetFormItemsOk + +`func (o *SectionDetails) GetFormItemsOk() (*[]map[string]interface{}, bool)` + +GetFormItemsOk returns a tuple with the FormItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormItems + +`func (o *SectionDetails) SetFormItems(v []map[string]interface{})` + +SetFormItems sets FormItems field to given value. + +### HasFormItems + +`func (o *SectionDetails) HasFormItems() bool` + +HasFormItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Sed.md b/docs/tools/sdk/go/Reference/V2025/Models/Sed.md new file mode 100644 index 000000000..4bce2b581 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Sed.md @@ -0,0 +1,402 @@ +--- +id: v2025-sed +title: Sed +pagination_label: Sed +sidebar_label: Sed +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Sed', 'V2025Sed'] +slug: /tools/sdk/go/v2025/models/sed +tags: ['SDK', 'Software Development Kit', 'Sed', 'V2025Sed'] +--- + +# Sed + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | name of the entitlement | [optional] +**ApprovedBy** | Pointer to **string** | entitlement approved by | [optional] +**ApprovedType** | Pointer to **string** | entitlement approved type | [optional] +**ApprovedWhen** | Pointer to **SailPointTime** | entitlement approved then | [optional] +**Attribute** | Pointer to **string** | entitlement attribute | [optional] +**Description** | Pointer to **string** | description of entitlement | [optional] +**DisplayName** | Pointer to **string** | entitlement display name | [optional] +**Id** | Pointer to **string** | sed id | [optional] +**SourceId** | Pointer to **string** | entitlement source id | [optional] +**SourceName** | Pointer to **string** | entitlement source name | [optional] +**Status** | Pointer to **string** | entitlement status | [optional] +**SuggestedDescription** | Pointer to **string** | llm suggested entitlement description | [optional] +**Type** | Pointer to **string** | entitlement type | [optional] +**Value** | Pointer to **string** | entitlement value | [optional] + +## Methods + +### NewSed + +`func NewSed() *Sed` + +NewSed instantiates a new Sed 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 + +### NewSedWithDefaults + +`func NewSedWithDefaults() *Sed` + +NewSedWithDefaults instantiates a new Sed 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 + +### GetName + +`func (o *Sed) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Sed) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Sed) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Sed) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetApprovedBy + +`func (o *Sed) GetApprovedBy() string` + +GetApprovedBy returns the ApprovedBy field if non-nil, zero value otherwise. + +### GetApprovedByOk + +`func (o *Sed) GetApprovedByOk() (*string, bool)` + +GetApprovedByOk returns a tuple with the ApprovedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovedBy + +`func (o *Sed) SetApprovedBy(v string)` + +SetApprovedBy sets ApprovedBy field to given value. + +### HasApprovedBy + +`func (o *Sed) HasApprovedBy() bool` + +HasApprovedBy returns a boolean if a field has been set. + +### GetApprovedType + +`func (o *Sed) GetApprovedType() string` + +GetApprovedType returns the ApprovedType field if non-nil, zero value otherwise. + +### GetApprovedTypeOk + +`func (o *Sed) GetApprovedTypeOk() (*string, bool)` + +GetApprovedTypeOk returns a tuple with the ApprovedType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovedType + +`func (o *Sed) SetApprovedType(v string)` + +SetApprovedType sets ApprovedType field to given value. + +### HasApprovedType + +`func (o *Sed) HasApprovedType() bool` + +HasApprovedType returns a boolean if a field has been set. + +### GetApprovedWhen + +`func (o *Sed) GetApprovedWhen() SailPointTime` + +GetApprovedWhen returns the ApprovedWhen field if non-nil, zero value otherwise. + +### GetApprovedWhenOk + +`func (o *Sed) GetApprovedWhenOk() (*SailPointTime, bool)` + +GetApprovedWhenOk returns a tuple with the ApprovedWhen field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovedWhen + +`func (o *Sed) SetApprovedWhen(v SailPointTime)` + +SetApprovedWhen sets ApprovedWhen field to given value. + +### HasApprovedWhen + +`func (o *Sed) HasApprovedWhen() bool` + +HasApprovedWhen returns a boolean if a field has been set. + +### GetAttribute + +`func (o *Sed) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *Sed) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *Sed) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *Sed) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetDescription + +`func (o *Sed) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Sed) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Sed) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Sed) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *Sed) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *Sed) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *Sed) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *Sed) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetId + +`func (o *Sed) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Sed) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Sed) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Sed) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *Sed) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *Sed) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *Sed) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *Sed) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceName + +`func (o *Sed) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *Sed) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *Sed) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *Sed) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetStatus + +`func (o *Sed) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Sed) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Sed) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Sed) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSuggestedDescription + +`func (o *Sed) GetSuggestedDescription() string` + +GetSuggestedDescription returns the SuggestedDescription field if non-nil, zero value otherwise. + +### GetSuggestedDescriptionOk + +`func (o *Sed) GetSuggestedDescriptionOk() (*string, bool)` + +GetSuggestedDescriptionOk returns a tuple with the SuggestedDescription field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSuggestedDescription + +`func (o *Sed) SetSuggestedDescription(v string)` + +SetSuggestedDescription sets SuggestedDescription field to given value. + +### HasSuggestedDescription + +`func (o *Sed) HasSuggestedDescription() bool` + +HasSuggestedDescription returns a boolean if a field has been set. + +### GetType + +`func (o *Sed) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Sed) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Sed) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Sed) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetValue + +`func (o *Sed) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Sed) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Sed) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Sed) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SedApproval.md b/docs/tools/sdk/go/Reference/V2025/Models/SedApproval.md new file mode 100644 index 000000000..0ea0727b5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SedApproval.md @@ -0,0 +1,64 @@ +--- +id: v2025-sed-approval +title: SedApproval +pagination_label: SedApproval +sidebar_label: SedApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedApproval', 'V2025SedApproval'] +slug: /tools/sdk/go/v2025/models/sed-approval +tags: ['SDK', 'Software Development Kit', 'SedApproval', 'V2025SedApproval'] +--- + +# SedApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Items** | Pointer to **[]string** | List of SED id's | [optional] + +## Methods + +### NewSedApproval + +`func NewSedApproval() *SedApproval` + +NewSedApproval instantiates a new SedApproval 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 + +### NewSedApprovalWithDefaults + +`func NewSedApprovalWithDefaults() *SedApproval` + +NewSedApprovalWithDefaults instantiates a new SedApproval 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 + +### GetItems + +`func (o *SedApproval) GetItems() []string` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *SedApproval) GetItemsOk() (*[]string, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *SedApproval) SetItems(v []string)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *SedApproval) HasItems() bool` + +HasItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SedApprovalStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/SedApprovalStatus.md new file mode 100644 index 000000000..782e8062e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SedApprovalStatus.md @@ -0,0 +1,116 @@ +--- +id: v2025-sed-approval-status +title: SedApprovalStatus +pagination_label: SedApprovalStatus +sidebar_label: SedApprovalStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedApprovalStatus', 'V2025SedApprovalStatus'] +slug: /tools/sdk/go/v2025/models/sed-approval-status +tags: ['SDK', 'Software Development Kit', 'SedApprovalStatus', 'V2025SedApprovalStatus'] +--- + +# SedApprovalStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FailedReason** | Pointer to **string** | failed reason will be display if status is failed | [optional] +**Id** | Pointer to **string** | Sed id | [optional] +**Status** | Pointer to **string** | SUCCESS | FAILED | [optional] + +## Methods + +### NewSedApprovalStatus + +`func NewSedApprovalStatus() *SedApprovalStatus` + +NewSedApprovalStatus instantiates a new SedApprovalStatus 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 + +### NewSedApprovalStatusWithDefaults + +`func NewSedApprovalStatusWithDefaults() *SedApprovalStatus` + +NewSedApprovalStatusWithDefaults instantiates a new SedApprovalStatus 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 + +### GetFailedReason + +`func (o *SedApprovalStatus) GetFailedReason() string` + +GetFailedReason returns the FailedReason field if non-nil, zero value otherwise. + +### GetFailedReasonOk + +`func (o *SedApprovalStatus) GetFailedReasonOk() (*string, bool)` + +GetFailedReasonOk returns a tuple with the FailedReason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFailedReason + +`func (o *SedApprovalStatus) SetFailedReason(v string)` + +SetFailedReason sets FailedReason field to given value. + +### HasFailedReason + +`func (o *SedApprovalStatus) HasFailedReason() bool` + +HasFailedReason returns a boolean if a field has been set. + +### GetId + +`func (o *SedApprovalStatus) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SedApprovalStatus) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SedApprovalStatus) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SedApprovalStatus) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetStatus + +`func (o *SedApprovalStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SedApprovalStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SedApprovalStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SedApprovalStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SedAssignee.md b/docs/tools/sdk/go/Reference/V2025/Models/SedAssignee.md new file mode 100644 index 000000000..e8001cd7c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SedAssignee.md @@ -0,0 +1,85 @@ +--- +id: v2025-sed-assignee +title: SedAssignee +pagination_label: SedAssignee +sidebar_label: SedAssignee +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedAssignee', 'V2025SedAssignee'] +slug: /tools/sdk/go/v2025/models/sed-assignee +tags: ['SDK', 'Software Development Kit', 'SedAssignee', 'V2025SedAssignee'] +--- + +# SedAssignee + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of assignment When value is PERSONA, the value MUST be SOURCE_OWNER or ENTITLEMENT_OWNER IDENTITY SED_ASSIGNEE_IDENTITY_TYPE GROUP SED_ASSIGNEE_GROUP_TYPE SOURCE_OWNER SED_ASSIGNEE_SOURCE_OWNER_TYPE ENTITLEMENT_OWNER SED_ASSIGNEE_ENTITLEMENT_OWNER_TYPE | +**Value** | Pointer to **string** | Identity or Group identifier Empty when using source/entitlement owner personas | [optional] + +## Methods + +### NewSedAssignee + +`func NewSedAssignee(type_ string, ) *SedAssignee` + +NewSedAssignee instantiates a new SedAssignee 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 + +### NewSedAssigneeWithDefaults + +`func NewSedAssigneeWithDefaults() *SedAssignee` + +NewSedAssigneeWithDefaults instantiates a new SedAssignee 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 + +### GetType + +`func (o *SedAssignee) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SedAssignee) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SedAssignee) SetType(v string)` + +SetType sets Type field to given value. + + +### GetValue + +`func (o *SedAssignee) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SedAssignee) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SedAssignee) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SedAssignee) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SedAssignment.md b/docs/tools/sdk/go/Reference/V2025/Models/SedAssignment.md new file mode 100644 index 000000000..fd272a229 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SedAssignment.md @@ -0,0 +1,90 @@ +--- +id: v2025-sed-assignment +title: SedAssignment +pagination_label: SedAssignment +sidebar_label: SedAssignment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedAssignment', 'V2025SedAssignment'] +slug: /tools/sdk/go/v2025/models/sed-assignment +tags: ['SDK', 'Software Development Kit', 'SedAssignment', 'V2025SedAssignment'] +--- + +# SedAssignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Assignee** | Pointer to [**SedAssignee**](sed-assignee) | | [optional] +**Items** | Pointer to **[]string** | List of SED id's | [optional] + +## Methods + +### NewSedAssignment + +`func NewSedAssignment() *SedAssignment` + +NewSedAssignment instantiates a new SedAssignment 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 + +### NewSedAssignmentWithDefaults + +`func NewSedAssignmentWithDefaults() *SedAssignment` + +NewSedAssignmentWithDefaults instantiates a new SedAssignment 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 + +### GetAssignee + +`func (o *SedAssignment) GetAssignee() SedAssignee` + +GetAssignee returns the Assignee field if non-nil, zero value otherwise. + +### GetAssigneeOk + +`func (o *SedAssignment) GetAssigneeOk() (*SedAssignee, bool)` + +GetAssigneeOk returns a tuple with the Assignee field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignee + +`func (o *SedAssignment) SetAssignee(v SedAssignee)` + +SetAssignee sets Assignee field to given value. + +### HasAssignee + +`func (o *SedAssignment) HasAssignee() bool` + +HasAssignee returns a boolean if a field has been set. + +### GetItems + +`func (o *SedAssignment) GetItems() []string` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *SedAssignment) GetItemsOk() (*[]string, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *SedAssignment) SetItems(v []string)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *SedAssignment) HasItems() bool` + +HasItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SedAssignmentResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/SedAssignmentResponse.md new file mode 100644 index 000000000..6c02fe04f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SedAssignmentResponse.md @@ -0,0 +1,64 @@ +--- +id: v2025-sed-assignment-response +title: SedAssignmentResponse +pagination_label: SedAssignmentResponse +sidebar_label: SedAssignmentResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedAssignmentResponse', 'V2025SedAssignmentResponse'] +slug: /tools/sdk/go/v2025/models/sed-assignment-response +tags: ['SDK', 'Software Development Kit', 'SedAssignmentResponse', 'V2025SedAssignmentResponse'] +--- + +# SedAssignmentResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **string** | BatchId that groups all the ids together | [optional] + +## Methods + +### NewSedAssignmentResponse + +`func NewSedAssignmentResponse() *SedAssignmentResponse` + +NewSedAssignmentResponse instantiates a new SedAssignmentResponse 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 + +### NewSedAssignmentResponseWithDefaults + +`func NewSedAssignmentResponseWithDefaults() *SedAssignmentResponse` + +NewSedAssignmentResponseWithDefaults instantiates a new SedAssignmentResponse 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 + +### GetBatchId + +`func (o *SedAssignmentResponse) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *SedAssignmentResponse) GetBatchIdOk() (*string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchId + +`func (o *SedAssignmentResponse) SetBatchId(v string)` + +SetBatchId sets BatchId field to given value. + +### HasBatchId + +`func (o *SedAssignmentResponse) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SedBatchRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/SedBatchRequest.md new file mode 100644 index 000000000..593d4dfad --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SedBatchRequest.md @@ -0,0 +1,90 @@ +--- +id: v2025-sed-batch-request +title: SedBatchRequest +pagination_label: SedBatchRequest +sidebar_label: SedBatchRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedBatchRequest', 'V2025SedBatchRequest'] +slug: /tools/sdk/go/v2025/models/sed-batch-request +tags: ['SDK', 'Software Development Kit', 'SedBatchRequest', 'V2025SedBatchRequest'] +--- + +# SedBatchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Entitlements** | Pointer to **[]string** | list of entitlement ids | [optional] +**Seds** | Pointer to **[]string** | list of sed ids | [optional] + +## Methods + +### NewSedBatchRequest + +`func NewSedBatchRequest() *SedBatchRequest` + +NewSedBatchRequest instantiates a new SedBatchRequest 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 + +### NewSedBatchRequestWithDefaults + +`func NewSedBatchRequestWithDefaults() *SedBatchRequest` + +NewSedBatchRequestWithDefaults instantiates a new SedBatchRequest 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 + +### GetEntitlements + +`func (o *SedBatchRequest) GetEntitlements() []string` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *SedBatchRequest) GetEntitlementsOk() (*[]string, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *SedBatchRequest) SetEntitlements(v []string)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *SedBatchRequest) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetSeds + +`func (o *SedBatchRequest) GetSeds() []string` + +GetSeds returns the Seds field if non-nil, zero value otherwise. + +### GetSedsOk + +`func (o *SedBatchRequest) GetSedsOk() (*[]string, bool)` + +GetSedsOk returns a tuple with the Seds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSeds + +`func (o *SedBatchRequest) SetSeds(v []string)` + +SetSeds sets Seds field to given value. + +### HasSeds + +`func (o *SedBatchRequest) HasSeds() bool` + +HasSeds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SedBatchResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/SedBatchResponse.md new file mode 100644 index 000000000..e703f1163 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SedBatchResponse.md @@ -0,0 +1,64 @@ +--- +id: v2025-sed-batch-response +title: SedBatchResponse +pagination_label: SedBatchResponse +sidebar_label: SedBatchResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedBatchResponse', 'V2025SedBatchResponse'] +slug: /tools/sdk/go/v2025/models/sed-batch-response +tags: ['SDK', 'Software Development Kit', 'SedBatchResponse', 'V2025SedBatchResponse'] +--- + +# SedBatchResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **string** | BatchId that groups all the ids together | [optional] + +## Methods + +### NewSedBatchResponse + +`func NewSedBatchResponse() *SedBatchResponse` + +NewSedBatchResponse instantiates a new SedBatchResponse 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 + +### NewSedBatchResponseWithDefaults + +`func NewSedBatchResponseWithDefaults() *SedBatchResponse` + +NewSedBatchResponseWithDefaults instantiates a new SedBatchResponse 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 + +### GetBatchId + +`func (o *SedBatchResponse) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *SedBatchResponse) GetBatchIdOk() (*string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchId + +`func (o *SedBatchResponse) SetBatchId(v string)` + +SetBatchId sets BatchId field to given value. + +### HasBatchId + +`func (o *SedBatchResponse) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SedBatchStats.md b/docs/tools/sdk/go/Reference/V2025/Models/SedBatchStats.md new file mode 100644 index 000000000..ea76f4fa5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SedBatchStats.md @@ -0,0 +1,168 @@ +--- +id: v2025-sed-batch-stats +title: SedBatchStats +pagination_label: SedBatchStats +sidebar_label: SedBatchStats +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedBatchStats', 'V2025SedBatchStats'] +slug: /tools/sdk/go/v2025/models/sed-batch-stats +tags: ['SDK', 'Software Development Kit', 'SedBatchStats', 'V2025SedBatchStats'] +--- + +# SedBatchStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchComplete** | Pointer to **bool** | batch complete | [optional] [default to false] +**BatchId** | Pointer to **string** | batch Id | [optional] +**DiscoveredCount** | Pointer to **int64** | discovered count | [optional] +**DiscoveryComplete** | Pointer to **bool** | discovery complete | [optional] [default to false] +**ProcessedCount** | Pointer to **int64** | processed count | [optional] + +## Methods + +### NewSedBatchStats + +`func NewSedBatchStats() *SedBatchStats` + +NewSedBatchStats instantiates a new SedBatchStats 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 + +### NewSedBatchStatsWithDefaults + +`func NewSedBatchStatsWithDefaults() *SedBatchStats` + +NewSedBatchStatsWithDefaults instantiates a new SedBatchStats 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 + +### GetBatchComplete + +`func (o *SedBatchStats) GetBatchComplete() bool` + +GetBatchComplete returns the BatchComplete field if non-nil, zero value otherwise. + +### GetBatchCompleteOk + +`func (o *SedBatchStats) GetBatchCompleteOk() (*bool, bool)` + +GetBatchCompleteOk returns a tuple with the BatchComplete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchComplete + +`func (o *SedBatchStats) SetBatchComplete(v bool)` + +SetBatchComplete sets BatchComplete field to given value. + +### HasBatchComplete + +`func (o *SedBatchStats) HasBatchComplete() bool` + +HasBatchComplete returns a boolean if a field has been set. + +### GetBatchId + +`func (o *SedBatchStats) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *SedBatchStats) GetBatchIdOk() (*string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchId + +`func (o *SedBatchStats) SetBatchId(v string)` + +SetBatchId sets BatchId field to given value. + +### HasBatchId + +`func (o *SedBatchStats) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### GetDiscoveredCount + +`func (o *SedBatchStats) GetDiscoveredCount() int64` + +GetDiscoveredCount returns the DiscoveredCount field if non-nil, zero value otherwise. + +### GetDiscoveredCountOk + +`func (o *SedBatchStats) GetDiscoveredCountOk() (*int64, bool)` + +GetDiscoveredCountOk returns a tuple with the DiscoveredCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredCount + +`func (o *SedBatchStats) SetDiscoveredCount(v int64)` + +SetDiscoveredCount sets DiscoveredCount field to given value. + +### HasDiscoveredCount + +`func (o *SedBatchStats) HasDiscoveredCount() bool` + +HasDiscoveredCount returns a boolean if a field has been set. + +### GetDiscoveryComplete + +`func (o *SedBatchStats) GetDiscoveryComplete() bool` + +GetDiscoveryComplete returns the DiscoveryComplete field if non-nil, zero value otherwise. + +### GetDiscoveryCompleteOk + +`func (o *SedBatchStats) GetDiscoveryCompleteOk() (*bool, bool)` + +GetDiscoveryCompleteOk returns a tuple with the DiscoveryComplete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveryComplete + +`func (o *SedBatchStats) SetDiscoveryComplete(v bool)` + +SetDiscoveryComplete sets DiscoveryComplete field to given value. + +### HasDiscoveryComplete + +`func (o *SedBatchStats) HasDiscoveryComplete() bool` + +HasDiscoveryComplete returns a boolean if a field has been set. + +### GetProcessedCount + +`func (o *SedBatchStats) GetProcessedCount() int64` + +GetProcessedCount returns the ProcessedCount field if non-nil, zero value otherwise. + +### GetProcessedCountOk + +`func (o *SedBatchStats) GetProcessedCountOk() (*int64, bool)` + +GetProcessedCountOk returns a tuple with the ProcessedCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessedCount + +`func (o *SedBatchStats) SetProcessedCount(v int64)` + +SetProcessedCount sets ProcessedCount field to given value. + +### HasProcessedCount + +`func (o *SedBatchStats) HasProcessedCount() bool` + +HasProcessedCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SedBatchStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/SedBatchStatus.md new file mode 100644 index 000000000..8aeaf6591 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SedBatchStatus.md @@ -0,0 +1,64 @@ +--- +id: v2025-sed-batch-status +title: SedBatchStatus +pagination_label: SedBatchStatus +sidebar_label: SedBatchStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedBatchStatus', 'V2025SedBatchStatus'] +slug: /tools/sdk/go/v2025/models/sed-batch-status +tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'V2025SedBatchStatus'] +--- + +# SedBatchStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | status of batch | [optional] + +## Methods + +### NewSedBatchStatus + +`func NewSedBatchStatus() *SedBatchStatus` + +NewSedBatchStatus instantiates a new SedBatchStatus 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 + +### NewSedBatchStatusWithDefaults + +`func NewSedBatchStatusWithDefaults() *SedBatchStatus` + +NewSedBatchStatusWithDefaults instantiates a new SedBatchStatus 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 + +### GetStatus + +`func (o *SedBatchStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SedBatchStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SedBatchStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SedBatchStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SedPatch.md b/docs/tools/sdk/go/Reference/V2025/Models/SedPatch.md new file mode 100644 index 000000000..ec40eddaa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SedPatch.md @@ -0,0 +1,116 @@ +--- +id: v2025-sed-patch +title: SedPatch +pagination_label: SedPatch +sidebar_label: SedPatch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedPatch', 'V2025SedPatch'] +slug: /tools/sdk/go/v2025/models/sed-patch +tags: ['SDK', 'Software Development Kit', 'SedPatch', 'V2025SedPatch'] +--- + +# SedPatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | Pointer to **string** | desired operation | [optional] +**Path** | Pointer to **string** | field to be patched | [optional] +**Value** | Pointer to **map[string]interface{}** | value to replace with | [optional] + +## Methods + +### NewSedPatch + +`func NewSedPatch() *SedPatch` + +NewSedPatch instantiates a new SedPatch 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 + +### NewSedPatchWithDefaults + +`func NewSedPatchWithDefaults() *SedPatch` + +NewSedPatchWithDefaults instantiates a new SedPatch 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 + +### GetOp + +`func (o *SedPatch) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *SedPatch) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *SedPatch) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *SedPatch) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetPath + +`func (o *SedPatch) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *SedPatch) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *SedPatch) SetPath(v string)` + +SetPath sets Path field to given value. + +### HasPath + +`func (o *SedPatch) HasPath() bool` + +HasPath returns a boolean if a field has been set. + +### GetValue + +`func (o *SedPatch) GetValue() map[string]interface{}` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SedPatch) GetValueOk() (*map[string]interface{}, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SedPatch) SetValue(v map[string]interface{})` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SedPatch) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Segment.md b/docs/tools/sdk/go/Reference/V2025/Models/Segment.md new file mode 100644 index 000000000..d4ca15177 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Segment.md @@ -0,0 +1,256 @@ +--- +id: v2025-segment +title: Segment +pagination_label: Segment +sidebar_label: Segment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Segment', 'V2025Segment'] +slug: /tools/sdk/go/v2025/models/segment +tags: ['SDK', 'Software Development Kit', 'Segment', 'V2025Segment'] +--- + +# Segment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The segment's ID. | [optional] +**Name** | Pointer to **string** | The segment's business name. | [optional] +**Created** | Pointer to **SailPointTime** | The time when the segment is created. | [optional] +**Modified** | Pointer to **SailPointTime** | The time when the segment is modified. | [optional] +**Description** | Pointer to **string** | The segment's optional description. | [optional] +**Owner** | Pointer to [**NullableOwnerReferenceSegments**](owner-reference-segments) | | [optional] +**VisibilityCriteria** | Pointer to [**SegmentVisibilityCriteria**](segment-visibility-criteria) | | [optional] +**Active** | Pointer to **bool** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to false] + +## Methods + +### NewSegment + +`func NewSegment() *Segment` + +NewSegment instantiates a new Segment 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 + +### NewSegmentWithDefaults + +`func NewSegmentWithDefaults() *Segment` + +NewSegmentWithDefaults instantiates a new Segment 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 + +### GetId + +`func (o *Segment) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Segment) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Segment) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Segment) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Segment) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Segment) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Segment) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Segment) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *Segment) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Segment) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Segment) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Segment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Segment) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Segment) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Segment) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Segment) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *Segment) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Segment) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Segment) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Segment) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *Segment) GetOwner() OwnerReferenceSegments` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Segment) GetOwnerOk() (*OwnerReferenceSegments, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Segment) SetOwner(v OwnerReferenceSegments)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *Segment) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *Segment) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *Segment) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetVisibilityCriteria + +`func (o *Segment) GetVisibilityCriteria() SegmentVisibilityCriteria` + +GetVisibilityCriteria returns the VisibilityCriteria field if non-nil, zero value otherwise. + +### GetVisibilityCriteriaOk + +`func (o *Segment) GetVisibilityCriteriaOk() (*SegmentVisibilityCriteria, bool)` + +GetVisibilityCriteriaOk returns a tuple with the VisibilityCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVisibilityCriteria + +`func (o *Segment) SetVisibilityCriteria(v SegmentVisibilityCriteria)` + +SetVisibilityCriteria sets VisibilityCriteria field to given value. + +### HasVisibilityCriteria + +`func (o *Segment) HasVisibilityCriteria() bool` + +HasVisibilityCriteria returns a boolean if a field has been set. + +### GetActive + +`func (o *Segment) GetActive() bool` + +GetActive returns the Active field if non-nil, zero value otherwise. + +### GetActiveOk + +`func (o *Segment) GetActiveOk() (*bool, bool)` + +GetActiveOk returns a tuple with the Active field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActive + +`func (o *Segment) SetActive(v bool)` + +SetActive sets Active field to given value. + +### HasActive + +`func (o *Segment) HasActive() bool` + +HasActive returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SegmentVisibilityCriteria.md b/docs/tools/sdk/go/Reference/V2025/Models/SegmentVisibilityCriteria.md new file mode 100644 index 000000000..5aef5648f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SegmentVisibilityCriteria.md @@ -0,0 +1,64 @@ +--- +id: v2025-segment-visibility-criteria +title: SegmentVisibilityCriteria +pagination_label: SegmentVisibilityCriteria +sidebar_label: SegmentVisibilityCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SegmentVisibilityCriteria', 'V2025SegmentVisibilityCriteria'] +slug: /tools/sdk/go/v2025/models/segment-visibility-criteria +tags: ['SDK', 'Software Development Kit', 'SegmentVisibilityCriteria', 'V2025SegmentVisibilityCriteria'] +--- + +# SegmentVisibilityCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | Pointer to [**Expression**](expression) | | [optional] + +## Methods + +### NewSegmentVisibilityCriteria + +`func NewSegmentVisibilityCriteria() *SegmentVisibilityCriteria` + +NewSegmentVisibilityCriteria instantiates a new SegmentVisibilityCriteria 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 + +### NewSegmentVisibilityCriteriaWithDefaults + +`func NewSegmentVisibilityCriteriaWithDefaults() *SegmentVisibilityCriteria` + +NewSegmentVisibilityCriteriaWithDefaults instantiates a new SegmentVisibilityCriteria 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 + +### GetExpression + +`func (o *SegmentVisibilityCriteria) GetExpression() Expression` + +GetExpression returns the Expression field if non-nil, zero value otherwise. + +### GetExpressionOk + +`func (o *SegmentVisibilityCriteria) GetExpressionOk() (*Expression, bool)` + +GetExpressionOk returns a tuple with the Expression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpression + +`func (o *SegmentVisibilityCriteria) SetExpression(v Expression)` + +SetExpression sets Expression field to given value. + +### HasExpression + +`func (o *SegmentVisibilityCriteria) HasExpression() bool` + +HasExpression returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Selector.md b/docs/tools/sdk/go/Reference/V2025/Models/Selector.md new file mode 100644 index 000000000..18abd7a32 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Selector.md @@ -0,0 +1,90 @@ +--- +id: v2025-selector +title: Selector +pagination_label: Selector +sidebar_label: Selector +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Selector', 'V2025Selector'] +slug: /tools/sdk/go/v2025/models/selector +tags: ['SDK', 'Software Development Kit', 'Selector', 'V2025Selector'] +--- + +# Selector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **string** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Methods + +### NewSelector + +`func NewSelector() *Selector` + +NewSelector instantiates a new Selector 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 + +### NewSelectorWithDefaults + +`func NewSelectorWithDefaults() *Selector` + +NewSelectorWithDefaults instantiates a new Selector 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 + +### GetApplicationId + +`func (o *Selector) GetApplicationId() string` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *Selector) GetApplicationIdOk() (*string, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationId + +`func (o *Selector) SetApplicationId(v string)` + +SetApplicationId sets ApplicationId field to given value. + +### HasApplicationId + +`func (o *Selector) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### GetAccountMatchConfig + +`func (o *Selector) GetAccountMatchConfig() SelectorAccountMatchConfig` + +GetAccountMatchConfig returns the AccountMatchConfig field if non-nil, zero value otherwise. + +### GetAccountMatchConfigOk + +`func (o *Selector) GetAccountMatchConfigOk() (*SelectorAccountMatchConfig, bool)` + +GetAccountMatchConfigOk returns a tuple with the AccountMatchConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountMatchConfig + +`func (o *Selector) SetAccountMatchConfig(v SelectorAccountMatchConfig)` + +SetAccountMatchConfig sets AccountMatchConfig field to given value. + +### HasAccountMatchConfig + +`func (o *Selector) HasAccountMatchConfig() bool` + +HasAccountMatchConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SelectorAccountMatchConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/SelectorAccountMatchConfig.md new file mode 100644 index 000000000..849b3092b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SelectorAccountMatchConfig.md @@ -0,0 +1,64 @@ +--- +id: v2025-selector-account-match-config +title: SelectorAccountMatchConfig +pagination_label: SelectorAccountMatchConfig +sidebar_label: SelectorAccountMatchConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SelectorAccountMatchConfig', 'V2025SelectorAccountMatchConfig'] +slug: /tools/sdk/go/v2025/models/selector-account-match-config +tags: ['SDK', 'Software Development Kit', 'SelectorAccountMatchConfig', 'V2025SelectorAccountMatchConfig'] +--- + +# SelectorAccountMatchConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MatchExpression** | Pointer to [**SelectorAccountMatchConfigMatchExpression**](selector-account-match-config-match-expression) | | [optional] + +## Methods + +### NewSelectorAccountMatchConfig + +`func NewSelectorAccountMatchConfig() *SelectorAccountMatchConfig` + +NewSelectorAccountMatchConfig instantiates a new SelectorAccountMatchConfig 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 + +### NewSelectorAccountMatchConfigWithDefaults + +`func NewSelectorAccountMatchConfigWithDefaults() *SelectorAccountMatchConfig` + +NewSelectorAccountMatchConfigWithDefaults instantiates a new SelectorAccountMatchConfig 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 + +### GetMatchExpression + +`func (o *SelectorAccountMatchConfig) GetMatchExpression() SelectorAccountMatchConfigMatchExpression` + +GetMatchExpression returns the MatchExpression field if non-nil, zero value otherwise. + +### GetMatchExpressionOk + +`func (o *SelectorAccountMatchConfig) GetMatchExpressionOk() (*SelectorAccountMatchConfigMatchExpression, bool)` + +GetMatchExpressionOk returns a tuple with the MatchExpression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchExpression + +`func (o *SelectorAccountMatchConfig) SetMatchExpression(v SelectorAccountMatchConfigMatchExpression)` + +SetMatchExpression sets MatchExpression field to given value. + +### HasMatchExpression + +`func (o *SelectorAccountMatchConfig) HasMatchExpression() bool` + +HasMatchExpression returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SelectorAccountMatchConfigMatchExpression.md b/docs/tools/sdk/go/Reference/V2025/Models/SelectorAccountMatchConfigMatchExpression.md new file mode 100644 index 000000000..6bf64a253 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SelectorAccountMatchConfigMatchExpression.md @@ -0,0 +1,90 @@ +--- +id: v2025-selector-account-match-config-match-expression +title: SelectorAccountMatchConfigMatchExpression +pagination_label: SelectorAccountMatchConfigMatchExpression +sidebar_label: SelectorAccountMatchConfigMatchExpression +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SelectorAccountMatchConfigMatchExpression', 'V2025SelectorAccountMatchConfigMatchExpression'] +slug: /tools/sdk/go/v2025/models/selector-account-match-config-match-expression +tags: ['SDK', 'Software Development Kit', 'SelectorAccountMatchConfigMatchExpression', 'V2025SelectorAccountMatchConfigMatchExpression'] +--- + +# SelectorAccountMatchConfigMatchExpression + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MatchTerms** | Pointer to [**[]MatchTerm**](match-term) | | [optional] +**And** | Pointer to **bool** | If it is AND operators for match terms | [optional] [default to true] + +## Methods + +### NewSelectorAccountMatchConfigMatchExpression + +`func NewSelectorAccountMatchConfigMatchExpression() *SelectorAccountMatchConfigMatchExpression` + +NewSelectorAccountMatchConfigMatchExpression instantiates a new SelectorAccountMatchConfigMatchExpression 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 + +### NewSelectorAccountMatchConfigMatchExpressionWithDefaults + +`func NewSelectorAccountMatchConfigMatchExpressionWithDefaults() *SelectorAccountMatchConfigMatchExpression` + +NewSelectorAccountMatchConfigMatchExpressionWithDefaults instantiates a new SelectorAccountMatchConfigMatchExpression 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 + +### GetMatchTerms + +`func (o *SelectorAccountMatchConfigMatchExpression) GetMatchTerms() []MatchTerm` + +GetMatchTerms returns the MatchTerms field if non-nil, zero value otherwise. + +### GetMatchTermsOk + +`func (o *SelectorAccountMatchConfigMatchExpression) GetMatchTermsOk() (*[]MatchTerm, bool)` + +GetMatchTermsOk returns a tuple with the MatchTerms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchTerms + +`func (o *SelectorAccountMatchConfigMatchExpression) SetMatchTerms(v []MatchTerm)` + +SetMatchTerms sets MatchTerms field to given value. + +### HasMatchTerms + +`func (o *SelectorAccountMatchConfigMatchExpression) HasMatchTerms() bool` + +HasMatchTerms returns a boolean if a field has been set. + +### GetAnd + +`func (o *SelectorAccountMatchConfigMatchExpression) GetAnd() bool` + +GetAnd returns the And field if non-nil, zero value otherwise. + +### GetAndOk + +`func (o *SelectorAccountMatchConfigMatchExpression) GetAndOk() (*bool, bool)` + +GetAndOk returns a tuple with the And field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnd + +`func (o *SelectorAccountMatchConfigMatchExpression) SetAnd(v bool)` + +SetAnd sets And field to given value. + +### HasAnd + +`func (o *SelectorAccountMatchConfigMatchExpression) HasAnd() bool` + +HasAnd returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SelfImportExportDto.md b/docs/tools/sdk/go/Reference/V2025/Models/SelfImportExportDto.md new file mode 100644 index 000000000..d557886e9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SelfImportExportDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-self-import-export-dto +title: SelfImportExportDto +pagination_label: SelfImportExportDto +sidebar_label: SelfImportExportDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SelfImportExportDto', 'V2025SelfImportExportDto'] +slug: /tools/sdk/go/v2025/models/self-import-export-dto +tags: ['SDK', 'Software Development Kit', 'SelfImportExportDto', 'V2025SelfImportExportDto'] +--- + +# SelfImportExportDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Imported/exported object's DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [optional] +**Id** | Pointer to **string** | Imported/exported object's ID. | [optional] +**Name** | Pointer to **string** | Imported/exported object's display name. | [optional] + +## Methods + +### NewSelfImportExportDto + +`func NewSelfImportExportDto() *SelfImportExportDto` + +NewSelfImportExportDto instantiates a new SelfImportExportDto 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 + +### NewSelfImportExportDtoWithDefaults + +`func NewSelfImportExportDtoWithDefaults() *SelfImportExportDto` + +NewSelfImportExportDtoWithDefaults instantiates a new SelfImportExportDto 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 + +### GetType + +`func (o *SelfImportExportDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SelfImportExportDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SelfImportExportDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SelfImportExportDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SelfImportExportDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SelfImportExportDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SelfImportExportDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SelfImportExportDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SelfImportExportDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SelfImportExportDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SelfImportExportDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SelfImportExportDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SendAccountVerificationRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/SendAccountVerificationRequest.md new file mode 100644 index 000000000..7151e8295 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SendAccountVerificationRequest.md @@ -0,0 +1,95 @@ +--- +id: v2025-send-account-verification-request +title: SendAccountVerificationRequest +pagination_label: SendAccountVerificationRequest +sidebar_label: SendAccountVerificationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SendAccountVerificationRequest', 'V2025SendAccountVerificationRequest'] +slug: /tools/sdk/go/v2025/models/send-account-verification-request +tags: ['SDK', 'Software Development Kit', 'SendAccountVerificationRequest', 'V2025SendAccountVerificationRequest'] +--- + +# SendAccountVerificationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceName** | Pointer to **NullableString** | The source name where identity account password should be reset | [optional] +**Via** | **string** | The method to send notification | + +## Methods + +### NewSendAccountVerificationRequest + +`func NewSendAccountVerificationRequest(via string, ) *SendAccountVerificationRequest` + +NewSendAccountVerificationRequest instantiates a new SendAccountVerificationRequest 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 + +### NewSendAccountVerificationRequestWithDefaults + +`func NewSendAccountVerificationRequestWithDefaults() *SendAccountVerificationRequest` + +NewSendAccountVerificationRequestWithDefaults instantiates a new SendAccountVerificationRequest 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 + +### GetSourceName + +`func (o *SendAccountVerificationRequest) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *SendAccountVerificationRequest) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *SendAccountVerificationRequest) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *SendAccountVerificationRequest) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### SetSourceNameNil + +`func (o *SendAccountVerificationRequest) SetSourceNameNil(b bool)` + + SetSourceNameNil sets the value for SourceName to be an explicit nil + +### UnsetSourceName +`func (o *SendAccountVerificationRequest) UnsetSourceName()` + +UnsetSourceName ensures that no value is present for SourceName, not even an explicit nil +### GetVia + +`func (o *SendAccountVerificationRequest) GetVia() string` + +GetVia returns the Via field if non-nil, zero value otherwise. + +### GetViaOk + +`func (o *SendAccountVerificationRequest) GetViaOk() (*string, bool)` + +GetViaOk returns a tuple with the Via field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVia + +`func (o *SendAccountVerificationRequest) SetVia(v string)` + +SetVia sets Via field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SendTestNotificationRequestDto.md b/docs/tools/sdk/go/Reference/V2025/Models/SendTestNotificationRequestDto.md new file mode 100644 index 000000000..56d3f91a6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SendTestNotificationRequestDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-send-test-notification-request-dto +title: SendTestNotificationRequestDto +pagination_label: SendTestNotificationRequestDto +sidebar_label: SendTestNotificationRequestDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SendTestNotificationRequestDto', 'V2025SendTestNotificationRequestDto'] +slug: /tools/sdk/go/v2025/models/send-test-notification-request-dto +tags: ['SDK', 'Software Development Kit', 'SendTestNotificationRequestDto', 'V2025SendTestNotificationRequestDto'] +--- + +# SendTestNotificationRequestDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The template notification key. | [optional] +**Medium** | Pointer to **string** | The notification medium. Has to be one of the following enum values. | [optional] +**Context** | Pointer to **map[string]interface{}** | A Json object that denotes the context specific to the template. | [optional] + +## Methods + +### NewSendTestNotificationRequestDto + +`func NewSendTestNotificationRequestDto() *SendTestNotificationRequestDto` + +NewSendTestNotificationRequestDto instantiates a new SendTestNotificationRequestDto 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 + +### NewSendTestNotificationRequestDtoWithDefaults + +`func NewSendTestNotificationRequestDtoWithDefaults() *SendTestNotificationRequestDto` + +NewSendTestNotificationRequestDtoWithDefaults instantiates a new SendTestNotificationRequestDto 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 + +### GetKey + +`func (o *SendTestNotificationRequestDto) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *SendTestNotificationRequestDto) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *SendTestNotificationRequestDto) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *SendTestNotificationRequestDto) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetMedium + +`func (o *SendTestNotificationRequestDto) GetMedium() string` + +GetMedium returns the Medium field if non-nil, zero value otherwise. + +### GetMediumOk + +`func (o *SendTestNotificationRequestDto) GetMediumOk() (*string, bool)` + +GetMediumOk returns a tuple with the Medium field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMedium + +`func (o *SendTestNotificationRequestDto) SetMedium(v string)` + +SetMedium sets Medium field to given value. + +### HasMedium + +`func (o *SendTestNotificationRequestDto) HasMedium() bool` + +HasMedium returns a boolean if a field has been set. + +### GetContext + +`func (o *SendTestNotificationRequestDto) GetContext() map[string]interface{}` + +GetContext returns the Context field if non-nil, zero value otherwise. + +### GetContextOk + +`func (o *SendTestNotificationRequestDto) GetContextOk() (*map[string]interface{}, bool)` + +GetContextOk returns a tuple with the Context field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContext + +`func (o *SendTestNotificationRequestDto) SetContext(v map[string]interface{})` + +SetContext sets Context field to given value. + +### HasContext + +`func (o *SendTestNotificationRequestDto) HasContext() bool` + +HasContext returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ServiceDeskIntegrationDto.md b/docs/tools/sdk/go/Reference/V2025/Models/ServiceDeskIntegrationDto.md new file mode 100644 index 000000000..151f8bc35 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ServiceDeskIntegrationDto.md @@ -0,0 +1,366 @@ +--- +id: v2025-service-desk-integration-dto +title: ServiceDeskIntegrationDto +pagination_label: ServiceDeskIntegrationDto +sidebar_label: ServiceDeskIntegrationDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskIntegrationDto', 'V2025ServiceDeskIntegrationDto'] +slug: /tools/sdk/go/v2025/models/service-desk-integration-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationDto', 'V2025ServiceDeskIntegrationDto'] +--- + +# ServiceDeskIntegrationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the Service Desk integration | [optional] +**Name** | **string** | Service Desk integration's name. The name must be unique. | +**Created** | Pointer to **SailPointTime** | The date and time the Service Desk integration was created | [optional] +**Modified** | Pointer to **SailPointTime** | The date and time the Service Desk integration was last modified | [optional] +**Description** | **string** | Service Desk integration's description. | +**Type** | **string** | Service Desk integration types: - ServiceNowSDIM - ServiceNow | [default to "ServiceNowSDIM"] +**OwnerRef** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**ClusterRef** | Pointer to [**SourceClusterDto**](source-cluster-dto) | | [optional] +**Cluster** | Pointer to **NullableString** | Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). | [optional] +**ManagedSources** | Pointer to **[]string** | Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). | [optional] +**ProvisioningConfig** | Pointer to [**ProvisioningConfig**](provisioning-config) | | [optional] +**Attributes** | **map[string]interface{}** | Service Desk integration's attributes. Validation constraints enforced by the implementation. | +**BeforeProvisioningRule** | Pointer to [**BeforeProvisioningRuleDto**](before-provisioning-rule-dto) | | [optional] + +## Methods + +### NewServiceDeskIntegrationDto + +`func NewServiceDeskIntegrationDto(name string, description string, type_ string, attributes map[string]interface{}, ) *ServiceDeskIntegrationDto` + +NewServiceDeskIntegrationDto instantiates a new ServiceDeskIntegrationDto 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 + +### NewServiceDeskIntegrationDtoWithDefaults + +`func NewServiceDeskIntegrationDtoWithDefaults() *ServiceDeskIntegrationDto` + +NewServiceDeskIntegrationDtoWithDefaults instantiates a new ServiceDeskIntegrationDto 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 + +### GetId + +`func (o *ServiceDeskIntegrationDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServiceDeskIntegrationDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServiceDeskIntegrationDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServiceDeskIntegrationDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ServiceDeskIntegrationDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServiceDeskIntegrationDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServiceDeskIntegrationDto) SetName(v string)` + +SetName sets Name field to given value. + + +### GetCreated + +`func (o *ServiceDeskIntegrationDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ServiceDeskIntegrationDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ServiceDeskIntegrationDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ServiceDeskIntegrationDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *ServiceDeskIntegrationDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ServiceDeskIntegrationDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ServiceDeskIntegrationDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ServiceDeskIntegrationDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *ServiceDeskIntegrationDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ServiceDeskIntegrationDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ServiceDeskIntegrationDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetType + +`func (o *ServiceDeskIntegrationDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServiceDeskIntegrationDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServiceDeskIntegrationDto) SetType(v string)` + +SetType sets Type field to given value. + + +### GetOwnerRef + +`func (o *ServiceDeskIntegrationDto) GetOwnerRef() OwnerDto` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *ServiceDeskIntegrationDto) GetOwnerRefOk() (*OwnerDto, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *ServiceDeskIntegrationDto) SetOwnerRef(v OwnerDto)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *ServiceDeskIntegrationDto) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### GetClusterRef + +`func (o *ServiceDeskIntegrationDto) GetClusterRef() SourceClusterDto` + +GetClusterRef returns the ClusterRef field if non-nil, zero value otherwise. + +### GetClusterRefOk + +`func (o *ServiceDeskIntegrationDto) GetClusterRefOk() (*SourceClusterDto, bool)` + +GetClusterRefOk returns a tuple with the ClusterRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterRef + +`func (o *ServiceDeskIntegrationDto) SetClusterRef(v SourceClusterDto)` + +SetClusterRef sets ClusterRef field to given value. + +### HasClusterRef + +`func (o *ServiceDeskIntegrationDto) HasClusterRef() bool` + +HasClusterRef returns a boolean if a field has been set. + +### GetCluster + +`func (o *ServiceDeskIntegrationDto) GetCluster() string` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *ServiceDeskIntegrationDto) GetClusterOk() (*string, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *ServiceDeskIntegrationDto) SetCluster(v string)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *ServiceDeskIntegrationDto) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### SetClusterNil + +`func (o *ServiceDeskIntegrationDto) SetClusterNil(b bool)` + + SetClusterNil sets the value for Cluster to be an explicit nil + +### UnsetCluster +`func (o *ServiceDeskIntegrationDto) UnsetCluster()` + +UnsetCluster ensures that no value is present for Cluster, not even an explicit nil +### GetManagedSources + +`func (o *ServiceDeskIntegrationDto) GetManagedSources() []string` + +GetManagedSources returns the ManagedSources field if non-nil, zero value otherwise. + +### GetManagedSourcesOk + +`func (o *ServiceDeskIntegrationDto) GetManagedSourcesOk() (*[]string, bool)` + +GetManagedSourcesOk returns a tuple with the ManagedSources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagedSources + +`func (o *ServiceDeskIntegrationDto) SetManagedSources(v []string)` + +SetManagedSources sets ManagedSources field to given value. + +### HasManagedSources + +`func (o *ServiceDeskIntegrationDto) HasManagedSources() bool` + +HasManagedSources returns a boolean if a field has been set. + +### GetProvisioningConfig + +`func (o *ServiceDeskIntegrationDto) GetProvisioningConfig() ProvisioningConfig` + +GetProvisioningConfig returns the ProvisioningConfig field if non-nil, zero value otherwise. + +### GetProvisioningConfigOk + +`func (o *ServiceDeskIntegrationDto) GetProvisioningConfigOk() (*ProvisioningConfig, bool)` + +GetProvisioningConfigOk returns a tuple with the ProvisioningConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningConfig + +`func (o *ServiceDeskIntegrationDto) SetProvisioningConfig(v ProvisioningConfig)` + +SetProvisioningConfig sets ProvisioningConfig field to given value. + +### HasProvisioningConfig + +`func (o *ServiceDeskIntegrationDto) HasProvisioningConfig() bool` + +HasProvisioningConfig returns a boolean if a field has been set. + +### GetAttributes + +`func (o *ServiceDeskIntegrationDto) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ServiceDeskIntegrationDto) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ServiceDeskIntegrationDto) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetBeforeProvisioningRule + +`func (o *ServiceDeskIntegrationDto) GetBeforeProvisioningRule() BeforeProvisioningRuleDto` + +GetBeforeProvisioningRule returns the BeforeProvisioningRule field if non-nil, zero value otherwise. + +### GetBeforeProvisioningRuleOk + +`func (o *ServiceDeskIntegrationDto) GetBeforeProvisioningRuleOk() (*BeforeProvisioningRuleDto, bool)` + +GetBeforeProvisioningRuleOk returns a tuple with the BeforeProvisioningRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBeforeProvisioningRule + +`func (o *ServiceDeskIntegrationDto) SetBeforeProvisioningRule(v BeforeProvisioningRuleDto)` + +SetBeforeProvisioningRule sets BeforeProvisioningRule field to given value. + +### HasBeforeProvisioningRule + +`func (o *ServiceDeskIntegrationDto) HasBeforeProvisioningRule() bool` + +HasBeforeProvisioningRule returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ServiceDeskIntegrationTemplateDto.md b/docs/tools/sdk/go/Reference/V2025/Models/ServiceDeskIntegrationTemplateDto.md new file mode 100644 index 000000000..a4dcb370c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ServiceDeskIntegrationTemplateDto.md @@ -0,0 +1,210 @@ +--- +id: v2025-service-desk-integration-template-dto +title: ServiceDeskIntegrationTemplateDto +pagination_label: ServiceDeskIntegrationTemplateDto +sidebar_label: ServiceDeskIntegrationTemplateDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskIntegrationTemplateDto', 'V2025ServiceDeskIntegrationTemplateDto'] +slug: /tools/sdk/go/v2025/models/service-desk-integration-template-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateDto', 'V2025ServiceDeskIntegrationTemplateDto'] +--- + +# ServiceDeskIntegrationTemplateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Type** | **string** | The 'type' property specifies the type of the Service Desk integration template. | [default to "Web Service SDIM"] +**Attributes** | **map[string]interface{}** | The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. | +**ProvisioningConfig** | [**ProvisioningConfig**](provisioning-config) | | + +## Methods + +### NewServiceDeskIntegrationTemplateDto + +`func NewServiceDeskIntegrationTemplateDto(name NullableString, type_ string, attributes map[string]interface{}, provisioningConfig ProvisioningConfig, ) *ServiceDeskIntegrationTemplateDto` + +NewServiceDeskIntegrationTemplateDto instantiates a new ServiceDeskIntegrationTemplateDto 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 + +### NewServiceDeskIntegrationTemplateDtoWithDefaults + +`func NewServiceDeskIntegrationTemplateDtoWithDefaults() *ServiceDeskIntegrationTemplateDto` + +NewServiceDeskIntegrationTemplateDtoWithDefaults instantiates a new ServiceDeskIntegrationTemplateDto 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 + +### GetId + +`func (o *ServiceDeskIntegrationTemplateDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServiceDeskIntegrationTemplateDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServiceDeskIntegrationTemplateDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ServiceDeskIntegrationTemplateDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServiceDeskIntegrationTemplateDto) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *ServiceDeskIntegrationTemplateDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ServiceDeskIntegrationTemplateDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *ServiceDeskIntegrationTemplateDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ServiceDeskIntegrationTemplateDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ServiceDeskIntegrationTemplateDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *ServiceDeskIntegrationTemplateDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ServiceDeskIntegrationTemplateDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ServiceDeskIntegrationTemplateDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetType + +`func (o *ServiceDeskIntegrationTemplateDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServiceDeskIntegrationTemplateDto) SetType(v string)` + +SetType sets Type field to given value. + + +### GetAttributes + +`func (o *ServiceDeskIntegrationTemplateDto) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ServiceDeskIntegrationTemplateDto) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetProvisioningConfig + +`func (o *ServiceDeskIntegrationTemplateDto) GetProvisioningConfig() ProvisioningConfig` + +GetProvisioningConfig returns the ProvisioningConfig field if non-nil, zero value otherwise. + +### GetProvisioningConfigOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetProvisioningConfigOk() (*ProvisioningConfig, bool)` + +GetProvisioningConfigOk returns a tuple with the ProvisioningConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningConfig + +`func (o *ServiceDeskIntegrationTemplateDto) SetProvisioningConfig(v ProvisioningConfig)` + +SetProvisioningConfig sets ProvisioningConfig field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ServiceDeskIntegrationTemplateType.md b/docs/tools/sdk/go/Reference/V2025/Models/ServiceDeskIntegrationTemplateType.md new file mode 100644 index 000000000..d33822005 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ServiceDeskIntegrationTemplateType.md @@ -0,0 +1,106 @@ +--- +id: v2025-service-desk-integration-template-type +title: ServiceDeskIntegrationTemplateType +pagination_label: ServiceDeskIntegrationTemplateType +sidebar_label: ServiceDeskIntegrationTemplateType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskIntegrationTemplateType', 'V2025ServiceDeskIntegrationTemplateType'] +slug: /tools/sdk/go/v2025/models/service-desk-integration-template-type +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateType', 'V2025ServiceDeskIntegrationTemplateType'] +--- + +# ServiceDeskIntegrationTemplateType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | This is the name of the type. | [optional] +**Type** | **string** | This is the type value for the type. | +**ScriptName** | **string** | This is the scriptName attribute value for the type. | + +## Methods + +### NewServiceDeskIntegrationTemplateType + +`func NewServiceDeskIntegrationTemplateType(type_ string, scriptName string, ) *ServiceDeskIntegrationTemplateType` + +NewServiceDeskIntegrationTemplateType instantiates a new ServiceDeskIntegrationTemplateType 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 + +### NewServiceDeskIntegrationTemplateTypeWithDefaults + +`func NewServiceDeskIntegrationTemplateTypeWithDefaults() *ServiceDeskIntegrationTemplateType` + +NewServiceDeskIntegrationTemplateTypeWithDefaults instantiates a new ServiceDeskIntegrationTemplateType 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 + +### GetName + +`func (o *ServiceDeskIntegrationTemplateType) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServiceDeskIntegrationTemplateType) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServiceDeskIntegrationTemplateType) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ServiceDeskIntegrationTemplateType) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *ServiceDeskIntegrationTemplateType) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServiceDeskIntegrationTemplateType) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServiceDeskIntegrationTemplateType) SetType(v string)` + +SetType sets Type field to given value. + + +### GetScriptName + +`func (o *ServiceDeskIntegrationTemplateType) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *ServiceDeskIntegrationTemplateType) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *ServiceDeskIntegrationTemplateType) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ServiceDeskSource.md b/docs/tools/sdk/go/Reference/V2025/Models/ServiceDeskSource.md new file mode 100644 index 000000000..2a4fff2ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ServiceDeskSource.md @@ -0,0 +1,116 @@ +--- +id: v2025-service-desk-source +title: ServiceDeskSource +pagination_label: ServiceDeskSource +sidebar_label: ServiceDeskSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskSource', 'V2025ServiceDeskSource'] +slug: /tools/sdk/go/v2025/models/service-desk-source +tags: ['SDK', 'Software Development Kit', 'ServiceDeskSource', 'V2025ServiceDeskSource'] +--- + +# ServiceDeskSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of source for service desk integration template. | [optional] +**Id** | Pointer to **string** | ID of source for service desk integration template. | [optional] +**Name** | Pointer to **string** | Human-readable name of source for service desk integration template. | [optional] + +## Methods + +### NewServiceDeskSource + +`func NewServiceDeskSource() *ServiceDeskSource` + +NewServiceDeskSource instantiates a new ServiceDeskSource 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 + +### NewServiceDeskSourceWithDefaults + +`func NewServiceDeskSourceWithDefaults() *ServiceDeskSource` + +NewServiceDeskSourceWithDefaults instantiates a new ServiceDeskSource 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 + +### GetType + +`func (o *ServiceDeskSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServiceDeskSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServiceDeskSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ServiceDeskSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ServiceDeskSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServiceDeskSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServiceDeskSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServiceDeskSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ServiceDeskSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServiceDeskSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServiceDeskSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ServiceDeskSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ServiceProviderConfiguration.md b/docs/tools/sdk/go/Reference/V2025/Models/ServiceProviderConfiguration.md new file mode 100644 index 000000000..c199bbd43 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ServiceProviderConfiguration.md @@ -0,0 +1,142 @@ +--- +id: v2025-service-provider-configuration +title: ServiceProviderConfiguration +pagination_label: ServiceProviderConfiguration +sidebar_label: ServiceProviderConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceProviderConfiguration', 'V2025ServiceProviderConfiguration'] +slug: /tools/sdk/go/v2025/models/service-provider-configuration +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfiguration', 'V2025ServiceProviderConfiguration'] +--- + +# ServiceProviderConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | This determines whether or not the SAML authentication flow is enabled for an org | [optional] [default to false] +**BypassIdp** | Pointer to **bool** | This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. | [optional] [default to false] +**SamlConfigurationValid** | Pointer to **bool** | This indicates whether or not the SAML configuration is valid. | [optional] [default to false] +**FederationProtocolDetails** | Pointer to [**[]ServiceProviderConfigurationFederationProtocolDetailsInner**](service-provider-configuration-federation-protocol-details-inner) | A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer's identity provider and a customer's SailPoint instance (i.e., the service provider). | [optional] + +## Methods + +### NewServiceProviderConfiguration + +`func NewServiceProviderConfiguration() *ServiceProviderConfiguration` + +NewServiceProviderConfiguration instantiates a new ServiceProviderConfiguration 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 + +### NewServiceProviderConfigurationWithDefaults + +`func NewServiceProviderConfigurationWithDefaults() *ServiceProviderConfiguration` + +NewServiceProviderConfigurationWithDefaults instantiates a new ServiceProviderConfiguration 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 + +### GetEnabled + +`func (o *ServiceProviderConfiguration) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ServiceProviderConfiguration) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ServiceProviderConfiguration) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ServiceProviderConfiguration) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetBypassIdp + +`func (o *ServiceProviderConfiguration) GetBypassIdp() bool` + +GetBypassIdp returns the BypassIdp field if non-nil, zero value otherwise. + +### GetBypassIdpOk + +`func (o *ServiceProviderConfiguration) GetBypassIdpOk() (*bool, bool)` + +GetBypassIdpOk returns a tuple with the BypassIdp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBypassIdp + +`func (o *ServiceProviderConfiguration) SetBypassIdp(v bool)` + +SetBypassIdp sets BypassIdp field to given value. + +### HasBypassIdp + +`func (o *ServiceProviderConfiguration) HasBypassIdp() bool` + +HasBypassIdp returns a boolean if a field has been set. + +### GetSamlConfigurationValid + +`func (o *ServiceProviderConfiguration) GetSamlConfigurationValid() bool` + +GetSamlConfigurationValid returns the SamlConfigurationValid field if non-nil, zero value otherwise. + +### GetSamlConfigurationValidOk + +`func (o *ServiceProviderConfiguration) GetSamlConfigurationValidOk() (*bool, bool)` + +GetSamlConfigurationValidOk returns a tuple with the SamlConfigurationValid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSamlConfigurationValid + +`func (o *ServiceProviderConfiguration) SetSamlConfigurationValid(v bool)` + +SetSamlConfigurationValid sets SamlConfigurationValid field to given value. + +### HasSamlConfigurationValid + +`func (o *ServiceProviderConfiguration) HasSamlConfigurationValid() bool` + +HasSamlConfigurationValid returns a boolean if a field has been set. + +### GetFederationProtocolDetails + +`func (o *ServiceProviderConfiguration) GetFederationProtocolDetails() []ServiceProviderConfigurationFederationProtocolDetailsInner` + +GetFederationProtocolDetails returns the FederationProtocolDetails field if non-nil, zero value otherwise. + +### GetFederationProtocolDetailsOk + +`func (o *ServiceProviderConfiguration) GetFederationProtocolDetailsOk() (*[]ServiceProviderConfigurationFederationProtocolDetailsInner, bool)` + +GetFederationProtocolDetailsOk returns a tuple with the FederationProtocolDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFederationProtocolDetails + +`func (o *ServiceProviderConfiguration) SetFederationProtocolDetails(v []ServiceProviderConfigurationFederationProtocolDetailsInner)` + +SetFederationProtocolDetails sets FederationProtocolDetails field to given value. + +### HasFederationProtocolDetails + +`func (o *ServiceProviderConfiguration) HasFederationProtocolDetails() bool` + +HasFederationProtocolDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/go/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md new file mode 100644 index 000000000..14a4b2643 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -0,0 +1,470 @@ +--- +id: v2025-service-provider-configuration-federation-protocol-details-inner +title: ServiceProviderConfigurationFederationProtocolDetailsInner +pagination_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2025ServiceProviderConfigurationFederationProtocolDetailsInner'] +slug: /tools/sdk/go/v2025/models/service-provider-configuration-federation-protocol-details-inner +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2025ServiceProviderConfigurationFederationProtocolDetailsInner'] +--- + +# ServiceProviderConfigurationFederationProtocolDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | Pointer to **string** | Federation protocol role | [optional] +**EntityId** | Pointer to **string** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Binding** | Pointer to **string** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**AuthnContext** | Pointer to **string** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**LogoutUrl** | Pointer to **string** | The IDP logout URL. Used with IDP configurations. | [optional] +**IncludeAuthnContext** | Pointer to **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to false] +**NameId** | Pointer to **string** | The name id format to use. Used with IDP configurations. | [optional] +**JitConfiguration** | Pointer to [**JITConfiguration**](jit-configuration) | | [optional] +**Cert** | Pointer to **string** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**LoginUrlPost** | Pointer to **string** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**LoginUrlRedirect** | Pointer to **string** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**MappingAttribute** | **string** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | +**CertificateExpirationDate** | Pointer to **string** | The expiration date extracted from the certificate. | [optional] +**CertificateName** | Pointer to **string** | The name extracted from the certificate. | [optional] +**Alias** | Pointer to **string** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**CallbackUrl** | **string** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | +**LegacyAcsUrl** | Pointer to **string** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] + +## Methods + +### NewServiceProviderConfigurationFederationProtocolDetailsInner + +`func NewServiceProviderConfigurationFederationProtocolDetailsInner(mappingAttribute string, callbackUrl string, ) *ServiceProviderConfigurationFederationProtocolDetailsInner` + +NewServiceProviderConfigurationFederationProtocolDetailsInner instantiates a new ServiceProviderConfigurationFederationProtocolDetailsInner 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 + +### NewServiceProviderConfigurationFederationProtocolDetailsInnerWithDefaults + +`func NewServiceProviderConfigurationFederationProtocolDetailsInnerWithDefaults() *ServiceProviderConfigurationFederationProtocolDetailsInner` + +NewServiceProviderConfigurationFederationProtocolDetailsInnerWithDefaults instantiates a new ServiceProviderConfigurationFederationProtocolDetailsInner 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 + +### GetRole + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetRole() string` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetRoleOk() (*string, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetRole(v string)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetEntityId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetEntityId() string` + +GetEntityId returns the EntityId field if non-nil, zero value otherwise. + +### GetEntityIdOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetEntityIdOk() (*string, bool)` + +GetEntityIdOk returns a tuple with the EntityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntityId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetEntityId(v string)` + +SetEntityId sets EntityId field to given value. + +### HasEntityId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasEntityId() bool` + +HasEntityId returns a boolean if a field has been set. + +### GetBinding + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetBinding() string` + +GetBinding returns the Binding field if non-nil, zero value otherwise. + +### GetBindingOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetBindingOk() (*string, bool)` + +GetBindingOk returns a tuple with the Binding field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBinding + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetBinding(v string)` + +SetBinding sets Binding field to given value. + +### HasBinding + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasBinding() bool` + +HasBinding returns a boolean if a field has been set. + +### GetAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetAuthnContext() string` + +GetAuthnContext returns the AuthnContext field if non-nil, zero value otherwise. + +### GetAuthnContextOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetAuthnContextOk() (*string, bool)` + +GetAuthnContextOk returns a tuple with the AuthnContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetAuthnContext(v string)` + +SetAuthnContext sets AuthnContext field to given value. + +### HasAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasAuthnContext() bool` + +HasAuthnContext returns a boolean if a field has been set. + +### GetLogoutUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLogoutUrl() string` + +GetLogoutUrl returns the LogoutUrl field if non-nil, zero value otherwise. + +### GetLogoutUrlOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLogoutUrlOk() (*string, bool)` + +GetLogoutUrlOk returns a tuple with the LogoutUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogoutUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetLogoutUrl(v string)` + +SetLogoutUrl sets LogoutUrl field to given value. + +### HasLogoutUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasLogoutUrl() bool` + +HasLogoutUrl returns a boolean if a field has been set. + +### GetIncludeAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetIncludeAuthnContext() bool` + +GetIncludeAuthnContext returns the IncludeAuthnContext field if non-nil, zero value otherwise. + +### GetIncludeAuthnContextOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetIncludeAuthnContextOk() (*bool, bool)` + +GetIncludeAuthnContextOk returns a tuple with the IncludeAuthnContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetIncludeAuthnContext(v bool)` + +SetIncludeAuthnContext sets IncludeAuthnContext field to given value. + +### HasIncludeAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasIncludeAuthnContext() bool` + +HasIncludeAuthnContext returns a boolean if a field has been set. + +### GetNameId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetNameId() string` + +GetNameId returns the NameId field if non-nil, zero value otherwise. + +### GetNameIdOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetNameIdOk() (*string, bool)` + +GetNameIdOk returns a tuple with the NameId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNameId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetNameId(v string)` + +SetNameId sets NameId field to given value. + +### HasNameId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasNameId() bool` + +HasNameId returns a boolean if a field has been set. + +### GetJitConfiguration + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetJitConfiguration() JITConfiguration` + +GetJitConfiguration returns the JitConfiguration field if non-nil, zero value otherwise. + +### GetJitConfigurationOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetJitConfigurationOk() (*JITConfiguration, bool)` + +GetJitConfigurationOk returns a tuple with the JitConfiguration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJitConfiguration + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetJitConfiguration(v JITConfiguration)` + +SetJitConfiguration sets JitConfiguration field to given value. + +### HasJitConfiguration + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasJitConfiguration() bool` + +HasJitConfiguration returns a boolean if a field has been set. + +### GetCert + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCert() string` + +GetCert returns the Cert field if non-nil, zero value otherwise. + +### GetCertOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCertOk() (*string, bool)` + +GetCertOk returns a tuple with the Cert field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCert + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetCert(v string)` + +SetCert sets Cert field to given value. + +### HasCert + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasCert() bool` + +HasCert returns a boolean if a field has been set. + +### GetLoginUrlPost + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLoginUrlPost() string` + +GetLoginUrlPost returns the LoginUrlPost field if non-nil, zero value otherwise. + +### GetLoginUrlPostOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLoginUrlPostOk() (*string, bool)` + +GetLoginUrlPostOk returns a tuple with the LoginUrlPost field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginUrlPost + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetLoginUrlPost(v string)` + +SetLoginUrlPost sets LoginUrlPost field to given value. + +### HasLoginUrlPost + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasLoginUrlPost() bool` + +HasLoginUrlPost returns a boolean if a field has been set. + +### GetLoginUrlRedirect + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLoginUrlRedirect() string` + +GetLoginUrlRedirect returns the LoginUrlRedirect field if non-nil, zero value otherwise. + +### GetLoginUrlRedirectOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLoginUrlRedirectOk() (*string, bool)` + +GetLoginUrlRedirectOk returns a tuple with the LoginUrlRedirect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginUrlRedirect + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetLoginUrlRedirect(v string)` + +SetLoginUrlRedirect sets LoginUrlRedirect field to given value. + +### HasLoginUrlRedirect + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasLoginUrlRedirect() bool` + +HasLoginUrlRedirect returns a boolean if a field has been set. + +### GetMappingAttribute + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetMappingAttribute() string` + +GetMappingAttribute returns the MappingAttribute field if non-nil, zero value otherwise. + +### GetMappingAttributeOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetMappingAttributeOk() (*string, bool)` + +GetMappingAttributeOk returns a tuple with the MappingAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMappingAttribute + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetMappingAttribute(v string)` + +SetMappingAttribute sets MappingAttribute field to given value. + + +### GetCertificateExpirationDate + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCertificateExpirationDate() string` + +GetCertificateExpirationDate returns the CertificateExpirationDate field if non-nil, zero value otherwise. + +### GetCertificateExpirationDateOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCertificateExpirationDateOk() (*string, bool)` + +GetCertificateExpirationDateOk returns a tuple with the CertificateExpirationDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificateExpirationDate + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetCertificateExpirationDate(v string)` + +SetCertificateExpirationDate sets CertificateExpirationDate field to given value. + +### HasCertificateExpirationDate + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasCertificateExpirationDate() bool` + +HasCertificateExpirationDate returns a boolean if a field has been set. + +### GetCertificateName + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCertificateName() string` + +GetCertificateName returns the CertificateName field if non-nil, zero value otherwise. + +### GetCertificateNameOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCertificateNameOk() (*string, bool)` + +GetCertificateNameOk returns a tuple with the CertificateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificateName + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetCertificateName(v string)` + +SetCertificateName sets CertificateName field to given value. + +### HasCertificateName + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasCertificateName() bool` + +HasCertificateName returns a boolean if a field has been set. + +### GetAlias + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + +### GetCallbackUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCallbackUrl() string` + +GetCallbackUrl returns the CallbackUrl field if non-nil, zero value otherwise. + +### GetCallbackUrlOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCallbackUrlOk() (*string, bool)` + +GetCallbackUrlOk returns a tuple with the CallbackUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCallbackUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetCallbackUrl(v string)` + +SetCallbackUrl sets CallbackUrl field to given value. + + +### GetLegacyAcsUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLegacyAcsUrl() string` + +GetLegacyAcsUrl returns the LegacyAcsUrl field if non-nil, zero value otherwise. + +### GetLegacyAcsUrlOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLegacyAcsUrlOk() (*string, bool)` + +GetLegacyAcsUrlOk returns a tuple with the LegacyAcsUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyAcsUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetLegacyAcsUrl(v string)` + +SetLegacyAcsUrl sets LegacyAcsUrl field to given value. + +### HasLegacyAcsUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasLegacyAcsUrl() bool` + +HasLegacyAcsUrl returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SessionConfiguration.md b/docs/tools/sdk/go/Reference/V2025/Models/SessionConfiguration.md new file mode 100644 index 000000000..ad1b1618b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SessionConfiguration.md @@ -0,0 +1,116 @@ +--- +id: v2025-session-configuration +title: SessionConfiguration +pagination_label: SessionConfiguration +sidebar_label: SessionConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SessionConfiguration', 'V2025SessionConfiguration'] +slug: /tools/sdk/go/v2025/models/session-configuration +tags: ['SDK', 'Software Development Kit', 'SessionConfiguration', 'V2025SessionConfiguration'] +--- + +# SessionConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxIdleTime** | Pointer to **int32** | The maximum time in minutes a session can be idle. | [optional] +**RememberMe** | Pointer to **bool** | Denotes if 'remember me' is enabled. | [optional] [default to false] +**MaxSessionTime** | Pointer to **int32** | The maximum allowable session time in minutes. | [optional] + +## Methods + +### NewSessionConfiguration + +`func NewSessionConfiguration() *SessionConfiguration` + +NewSessionConfiguration instantiates a new SessionConfiguration 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 + +### NewSessionConfigurationWithDefaults + +`func NewSessionConfigurationWithDefaults() *SessionConfiguration` + +NewSessionConfigurationWithDefaults instantiates a new SessionConfiguration 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 + +### GetMaxIdleTime + +`func (o *SessionConfiguration) GetMaxIdleTime() int32` + +GetMaxIdleTime returns the MaxIdleTime field if non-nil, zero value otherwise. + +### GetMaxIdleTimeOk + +`func (o *SessionConfiguration) GetMaxIdleTimeOk() (*int32, bool)` + +GetMaxIdleTimeOk returns a tuple with the MaxIdleTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxIdleTime + +`func (o *SessionConfiguration) SetMaxIdleTime(v int32)` + +SetMaxIdleTime sets MaxIdleTime field to given value. + +### HasMaxIdleTime + +`func (o *SessionConfiguration) HasMaxIdleTime() bool` + +HasMaxIdleTime returns a boolean if a field has been set. + +### GetRememberMe + +`func (o *SessionConfiguration) GetRememberMe() bool` + +GetRememberMe returns the RememberMe field if non-nil, zero value otherwise. + +### GetRememberMeOk + +`func (o *SessionConfiguration) GetRememberMeOk() (*bool, bool)` + +GetRememberMeOk returns a tuple with the RememberMe field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRememberMe + +`func (o *SessionConfiguration) SetRememberMe(v bool)` + +SetRememberMe sets RememberMe field to given value. + +### HasRememberMe + +`func (o *SessionConfiguration) HasRememberMe() bool` + +HasRememberMe returns a boolean if a field has been set. + +### GetMaxSessionTime + +`func (o *SessionConfiguration) GetMaxSessionTime() int32` + +GetMaxSessionTime returns the MaxSessionTime field if non-nil, zero value otherwise. + +### GetMaxSessionTimeOk + +`func (o *SessionConfiguration) GetMaxSessionTimeOk() (*int32, bool)` + +GetMaxSessionTimeOk returns a tuple with the MaxSessionTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxSessionTime + +`func (o *SessionConfiguration) SetMaxSessionTime(v int32)` + +SetMaxSessionTime sets MaxSessionTime field to given value. + +### HasMaxSessionTime + +`func (o *SessionConfiguration) HasMaxSessionTime() bool` + +HasMaxSessionTime returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SetIcon200Response.md b/docs/tools/sdk/go/Reference/V2025/Models/SetIcon200Response.md new file mode 100644 index 000000000..61d2608aa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SetIcon200Response.md @@ -0,0 +1,64 @@ +--- +id: v2025-set-icon200-response +title: SetIcon200Response +pagination_label: SetIcon200Response +sidebar_label: SetIcon200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SetIcon200Response', 'V2025SetIcon200Response'] +slug: /tools/sdk/go/v2025/models/set-icon200-response +tags: ['SDK', 'Software Development Kit', 'SetIcon200Response', 'V2025SetIcon200Response'] +--- + +# SetIcon200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Icon** | Pointer to **string** | url to file with icon | [optional] + +## Methods + +### NewSetIcon200Response + +`func NewSetIcon200Response() *SetIcon200Response` + +NewSetIcon200Response instantiates a new SetIcon200Response 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 + +### NewSetIcon200ResponseWithDefaults + +`func NewSetIcon200ResponseWithDefaults() *SetIcon200Response` + +NewSetIcon200ResponseWithDefaults instantiates a new SetIcon200Response 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 + +### GetIcon + +`func (o *SetIcon200Response) GetIcon() string` + +GetIcon returns the Icon field if non-nil, zero value otherwise. + +### GetIconOk + +`func (o *SetIcon200Response) GetIconOk() (*string, bool)` + +GetIconOk returns a tuple with the Icon field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIcon + +`func (o *SetIcon200Response) SetIcon(v string)` + +SetIcon sets Icon field to given value. + +### HasIcon + +`func (o *SetIcon200Response) HasIcon() bool` + +HasIcon returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SetIconRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/SetIconRequest.md new file mode 100644 index 000000000..e01254620 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SetIconRequest.md @@ -0,0 +1,59 @@ +--- +id: v2025-set-icon-request +title: SetIconRequest +pagination_label: SetIconRequest +sidebar_label: SetIconRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SetIconRequest', 'V2025SetIconRequest'] +slug: /tools/sdk/go/v2025/models/set-icon-request +tags: ['SDK', 'Software Development Kit', 'SetIconRequest', 'V2025SetIconRequest'] +--- + +# SetIconRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Image** | ***os.File** | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] | + +## Methods + +### NewSetIconRequest + +`func NewSetIconRequest(image *os.File, ) *SetIconRequest` + +NewSetIconRequest instantiates a new SetIconRequest 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 + +### NewSetIconRequestWithDefaults + +`func NewSetIconRequestWithDefaults() *SetIconRequest` + +NewSetIconRequestWithDefaults instantiates a new SetIconRequest 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 + +### GetImage + +`func (o *SetIconRequest) GetImage() *os.File` + +GetImage returns the Image field if non-nil, zero value otherwise. + +### GetImageOk + +`func (o *SetIconRequest) GetImageOk() (**os.File, bool)` + +GetImageOk returns a tuple with the Image field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImage + +`func (o *SetIconRequest) SetImage(v *os.File)` + +SetImage sets Image field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SetLifecycleState200Response.md b/docs/tools/sdk/go/Reference/V2025/Models/SetLifecycleState200Response.md new file mode 100644 index 000000000..73b450b44 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SetLifecycleState200Response.md @@ -0,0 +1,64 @@ +--- +id: v2025-set-lifecycle-state200-response +title: SetLifecycleState200Response +pagination_label: SetLifecycleState200Response +sidebar_label: SetLifecycleState200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SetLifecycleState200Response', 'V2025SetLifecycleState200Response'] +slug: /tools/sdk/go/v2025/models/set-lifecycle-state200-response +tags: ['SDK', 'Software Development Kit', 'SetLifecycleState200Response', 'V2025SetLifecycleState200Response'] +--- + +# SetLifecycleState200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountActivityId** | Pointer to **string** | ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/v3/get-account-activity/). The response will contain relevant information about the IdentityRequest, such as its status. | [optional] + +## Methods + +### NewSetLifecycleState200Response + +`func NewSetLifecycleState200Response() *SetLifecycleState200Response` + +NewSetLifecycleState200Response instantiates a new SetLifecycleState200Response 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 + +### NewSetLifecycleState200ResponseWithDefaults + +`func NewSetLifecycleState200ResponseWithDefaults() *SetLifecycleState200Response` + +NewSetLifecycleState200ResponseWithDefaults instantiates a new SetLifecycleState200Response 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 + +### GetAccountActivityId + +`func (o *SetLifecycleState200Response) GetAccountActivityId() string` + +GetAccountActivityId returns the AccountActivityId field if non-nil, zero value otherwise. + +### GetAccountActivityIdOk + +`func (o *SetLifecycleState200Response) GetAccountActivityIdOk() (*string, bool)` + +GetAccountActivityIdOk returns a tuple with the AccountActivityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActivityId + +`func (o *SetLifecycleState200Response) SetAccountActivityId(v string)` + +SetAccountActivityId sets AccountActivityId field to given value. + +### HasAccountActivityId + +`func (o *SetLifecycleState200Response) HasAccountActivityId() bool` + +HasAccountActivityId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SetLifecycleStateRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/SetLifecycleStateRequest.md new file mode 100644 index 000000000..4775354cc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SetLifecycleStateRequest.md @@ -0,0 +1,64 @@ +--- +id: v2025-set-lifecycle-state-request +title: SetLifecycleStateRequest +pagination_label: SetLifecycleStateRequest +sidebar_label: SetLifecycleStateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SetLifecycleStateRequest', 'V2025SetLifecycleStateRequest'] +slug: /tools/sdk/go/v2025/models/set-lifecycle-state-request +tags: ['SDK', 'Software Development Kit', 'SetLifecycleStateRequest', 'V2025SetLifecycleStateRequest'] +--- + +# SetLifecycleStateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LifecycleStateId** | Pointer to **string** | ID of the lifecycle state to set. | [optional] + +## Methods + +### NewSetLifecycleStateRequest + +`func NewSetLifecycleStateRequest() *SetLifecycleStateRequest` + +NewSetLifecycleStateRequest instantiates a new SetLifecycleStateRequest 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 + +### NewSetLifecycleStateRequestWithDefaults + +`func NewSetLifecycleStateRequestWithDefaults() *SetLifecycleStateRequest` + +NewSetLifecycleStateRequestWithDefaults instantiates a new SetLifecycleStateRequest 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 + +### GetLifecycleStateId + +`func (o *SetLifecycleStateRequest) GetLifecycleStateId() string` + +GetLifecycleStateId returns the LifecycleStateId field if non-nil, zero value otherwise. + +### GetLifecycleStateIdOk + +`func (o *SetLifecycleStateRequest) GetLifecycleStateIdOk() (*string, bool)` + +GetLifecycleStateIdOk returns a tuple with the LifecycleStateId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLifecycleStateId + +`func (o *SetLifecycleStateRequest) SetLifecycleStateId(v string)` + +SetLifecycleStateId sets LifecycleStateId field to given value. + +### HasLifecycleStateId + +`func (o *SetLifecycleStateRequest) HasLifecycleStateId() bool` + +HasLifecycleStateId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SimIntegrationDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/SimIntegrationDetails.md new file mode 100644 index 000000000..c7a7a2eaf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SimIntegrationDetails.md @@ -0,0 +1,365 @@ +--- +id: v2025-sim-integration-details +title: SimIntegrationDetails +pagination_label: SimIntegrationDetails +sidebar_label: SimIntegrationDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SimIntegrationDetails', 'V2025SimIntegrationDetails'] +slug: /tools/sdk/go/v2025/models/sim-integration-details +tags: ['SDK', 'Software Development Kit', 'SimIntegrationDetails', 'V2025SimIntegrationDetails'] +--- + +# SimIntegrationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Description** | Pointer to **string** | The description of the integration | [optional] +**Type** | Pointer to **string** | The integration type | [optional] +**Attributes** | Pointer to **map[string]interface{}** | The attributes map containing the credentials used to configure the integration. | [optional] +**Sources** | Pointer to **[]string** | The list of sources (managed resources) | [optional] +**Cluster** | Pointer to **string** | The cluster/proxy | [optional] +**StatusMap** | Pointer to **map[string]interface{}** | Custom mapping between the integration result and the provisioning result | [optional] +**Request** | Pointer to **map[string]interface{}** | Request data to customize desc and body of the created ticket | [optional] +**BeforeProvisioningRule** | Pointer to [**SimIntegrationDetailsAllOfBeforeProvisioningRule**](sim-integration-details-all-of-before-provisioning-rule) | | [optional] + +## Methods + +### NewSimIntegrationDetails + +`func NewSimIntegrationDetails(name NullableString, ) *SimIntegrationDetails` + +NewSimIntegrationDetails instantiates a new SimIntegrationDetails 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 + +### NewSimIntegrationDetailsWithDefaults + +`func NewSimIntegrationDetailsWithDefaults() *SimIntegrationDetails` + +NewSimIntegrationDetailsWithDefaults instantiates a new SimIntegrationDetails 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 + +### GetId + +`func (o *SimIntegrationDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SimIntegrationDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SimIntegrationDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SimIntegrationDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SimIntegrationDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SimIntegrationDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SimIntegrationDetails) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *SimIntegrationDetails) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *SimIntegrationDetails) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *SimIntegrationDetails) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SimIntegrationDetails) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SimIntegrationDetails) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SimIntegrationDetails) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SimIntegrationDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SimIntegrationDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SimIntegrationDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SimIntegrationDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *SimIntegrationDetails) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SimIntegrationDetails) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SimIntegrationDetails) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SimIntegrationDetails) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetType + +`func (o *SimIntegrationDetails) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SimIntegrationDetails) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SimIntegrationDetails) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SimIntegrationDetails) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetAttributes + +`func (o *SimIntegrationDetails) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *SimIntegrationDetails) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *SimIntegrationDetails) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *SimIntegrationDetails) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *SimIntegrationDetails) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *SimIntegrationDetails) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetSources + +`func (o *SimIntegrationDetails) GetSources() []string` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *SimIntegrationDetails) GetSourcesOk() (*[]string, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *SimIntegrationDetails) SetSources(v []string)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *SimIntegrationDetails) HasSources() bool` + +HasSources returns a boolean if a field has been set. + +### GetCluster + +`func (o *SimIntegrationDetails) GetCluster() string` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *SimIntegrationDetails) GetClusterOk() (*string, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *SimIntegrationDetails) SetCluster(v string)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *SimIntegrationDetails) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### GetStatusMap + +`func (o *SimIntegrationDetails) GetStatusMap() map[string]interface{}` + +GetStatusMap returns the StatusMap field if non-nil, zero value otherwise. + +### GetStatusMapOk + +`func (o *SimIntegrationDetails) GetStatusMapOk() (*map[string]interface{}, bool)` + +GetStatusMapOk returns a tuple with the StatusMap field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusMap + +`func (o *SimIntegrationDetails) SetStatusMap(v map[string]interface{})` + +SetStatusMap sets StatusMap field to given value. + +### HasStatusMap + +`func (o *SimIntegrationDetails) HasStatusMap() bool` + +HasStatusMap returns a boolean if a field has been set. + +### GetRequest + +`func (o *SimIntegrationDetails) GetRequest() map[string]interface{}` + +GetRequest returns the Request field if non-nil, zero value otherwise. + +### GetRequestOk + +`func (o *SimIntegrationDetails) GetRequestOk() (*map[string]interface{}, bool)` + +GetRequestOk returns a tuple with the Request field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequest + +`func (o *SimIntegrationDetails) SetRequest(v map[string]interface{})` + +SetRequest sets Request field to given value. + +### HasRequest + +`func (o *SimIntegrationDetails) HasRequest() bool` + +HasRequest returns a boolean if a field has been set. + +### GetBeforeProvisioningRule + +`func (o *SimIntegrationDetails) GetBeforeProvisioningRule() SimIntegrationDetailsAllOfBeforeProvisioningRule` + +GetBeforeProvisioningRule returns the BeforeProvisioningRule field if non-nil, zero value otherwise. + +### GetBeforeProvisioningRuleOk + +`func (o *SimIntegrationDetails) GetBeforeProvisioningRuleOk() (*SimIntegrationDetailsAllOfBeforeProvisioningRule, bool)` + +GetBeforeProvisioningRuleOk returns a tuple with the BeforeProvisioningRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBeforeProvisioningRule + +`func (o *SimIntegrationDetails) SetBeforeProvisioningRule(v SimIntegrationDetailsAllOfBeforeProvisioningRule)` + +SetBeforeProvisioningRule sets BeforeProvisioningRule field to given value. + +### HasBeforeProvisioningRule + +`func (o *SimIntegrationDetails) HasBeforeProvisioningRule() bool` + +HasBeforeProvisioningRule returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md b/docs/tools/sdk/go/Reference/V2025/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md new file mode 100644 index 000000000..cb8774c67 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md @@ -0,0 +1,116 @@ +--- +id: v2025-sim-integration-details-all-of-before-provisioning-rule +title: SimIntegrationDetailsAllOfBeforeProvisioningRule +pagination_label: SimIntegrationDetailsAllOfBeforeProvisioningRule +sidebar_label: SimIntegrationDetailsAllOfBeforeProvisioningRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SimIntegrationDetailsAllOfBeforeProvisioningRule', 'V2025SimIntegrationDetailsAllOfBeforeProvisioningRule'] +slug: /tools/sdk/go/v2025/models/sim-integration-details-all-of-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'SimIntegrationDetailsAllOfBeforeProvisioningRule', 'V2025SimIntegrationDetailsAllOfBeforeProvisioningRule'] +--- + +# SimIntegrationDetailsAllOfBeforeProvisioningRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | ID of the rule | [optional] +**Name** | Pointer to **string** | Human-readable display name of the rule | [optional] + +## Methods + +### NewSimIntegrationDetailsAllOfBeforeProvisioningRule + +`func NewSimIntegrationDetailsAllOfBeforeProvisioningRule() *SimIntegrationDetailsAllOfBeforeProvisioningRule` + +NewSimIntegrationDetailsAllOfBeforeProvisioningRule instantiates a new SimIntegrationDetailsAllOfBeforeProvisioningRule 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 + +### NewSimIntegrationDetailsAllOfBeforeProvisioningRuleWithDefaults + +`func NewSimIntegrationDetailsAllOfBeforeProvisioningRuleWithDefaults() *SimIntegrationDetailsAllOfBeforeProvisioningRule` + +NewSimIntegrationDetailsAllOfBeforeProvisioningRuleWithDefaults instantiates a new SimIntegrationDetailsAllOfBeforeProvisioningRule 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 + +### GetType + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SimIntegrationDetailsAllOfBeforeProvisioningRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SlimCampaign.md b/docs/tools/sdk/go/Reference/V2025/Models/SlimCampaign.md new file mode 100644 index 000000000..183cad4fc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SlimCampaign.md @@ -0,0 +1,467 @@ +--- +id: v2025-slim-campaign +title: SlimCampaign +pagination_label: SlimCampaign +sidebar_label: SlimCampaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SlimCampaign', 'V2025SlimCampaign'] +slug: /tools/sdk/go/v2025/models/slim-campaign +tags: ['SDK', 'Software Development Kit', 'SlimCampaign', 'V2025SlimCampaign'] +--- + +# SlimCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | Id of the campaign | [optional] [readonly] +**Name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Description** | **NullableString** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Deadline** | Pointer to **NullableTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **string** | The type of campaign. Could be extended in the future. | +**EmailNotificationEnabled** | Pointer to **bool** | Enables email notification for this campaign | [optional] [default to false] +**AutoRevokeAllowed** | Pointer to **bool** | Allows auto revoke for this campaign | [optional] [default to false] +**RecommendationsEnabled** | Pointer to **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to false] +**Status** | Pointer to **NullableString** | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **NullableTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **NullableInt32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **NullableInt32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] + +## Methods + +### NewSlimCampaign + +`func NewSlimCampaign(name string, description NullableString, type_ string, ) *SlimCampaign` + +NewSlimCampaign instantiates a new SlimCampaign 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 + +### NewSlimCampaignWithDefaults + +`func NewSlimCampaignWithDefaults() *SlimCampaign` + +NewSlimCampaignWithDefaults instantiates a new SlimCampaign 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 + +### GetId + +`func (o *SlimCampaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SlimCampaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SlimCampaign) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SlimCampaign) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *SlimCampaign) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *SlimCampaign) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *SlimCampaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SlimCampaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SlimCampaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *SlimCampaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SlimCampaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SlimCampaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *SlimCampaign) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *SlimCampaign) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetDeadline + +`func (o *SlimCampaign) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *SlimCampaign) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *SlimCampaign) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *SlimCampaign) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### SetDeadlineNil + +`func (o *SlimCampaign) SetDeadlineNil(b bool)` + + SetDeadlineNil sets the value for Deadline to be an explicit nil + +### UnsetDeadline +`func (o *SlimCampaign) UnsetDeadline()` + +UnsetDeadline ensures that no value is present for Deadline, not even an explicit nil +### GetType + +`func (o *SlimCampaign) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SlimCampaign) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SlimCampaign) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEmailNotificationEnabled + +`func (o *SlimCampaign) GetEmailNotificationEnabled() bool` + +GetEmailNotificationEnabled returns the EmailNotificationEnabled field if non-nil, zero value otherwise. + +### GetEmailNotificationEnabledOk + +`func (o *SlimCampaign) GetEmailNotificationEnabledOk() (*bool, bool)` + +GetEmailNotificationEnabledOk returns a tuple with the EmailNotificationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationEnabled + +`func (o *SlimCampaign) SetEmailNotificationEnabled(v bool)` + +SetEmailNotificationEnabled sets EmailNotificationEnabled field to given value. + +### HasEmailNotificationEnabled + +`func (o *SlimCampaign) HasEmailNotificationEnabled() bool` + +HasEmailNotificationEnabled returns a boolean if a field has been set. + +### GetAutoRevokeAllowed + +`func (o *SlimCampaign) GetAutoRevokeAllowed() bool` + +GetAutoRevokeAllowed returns the AutoRevokeAllowed field if non-nil, zero value otherwise. + +### GetAutoRevokeAllowedOk + +`func (o *SlimCampaign) GetAutoRevokeAllowedOk() (*bool, bool)` + +GetAutoRevokeAllowedOk returns a tuple with the AutoRevokeAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoRevokeAllowed + +`func (o *SlimCampaign) SetAutoRevokeAllowed(v bool)` + +SetAutoRevokeAllowed sets AutoRevokeAllowed field to given value. + +### HasAutoRevokeAllowed + +`func (o *SlimCampaign) HasAutoRevokeAllowed() bool` + +HasAutoRevokeAllowed returns a boolean if a field has been set. + +### GetRecommendationsEnabled + +`func (o *SlimCampaign) GetRecommendationsEnabled() bool` + +GetRecommendationsEnabled returns the RecommendationsEnabled field if non-nil, zero value otherwise. + +### GetRecommendationsEnabledOk + +`func (o *SlimCampaign) GetRecommendationsEnabledOk() (*bool, bool)` + +GetRecommendationsEnabledOk returns a tuple with the RecommendationsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendationsEnabled + +`func (o *SlimCampaign) SetRecommendationsEnabled(v bool)` + +SetRecommendationsEnabled sets RecommendationsEnabled field to given value. + +### HasRecommendationsEnabled + +`func (o *SlimCampaign) HasRecommendationsEnabled() bool` + +HasRecommendationsEnabled returns a boolean if a field has been set. + +### GetStatus + +`func (o *SlimCampaign) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SlimCampaign) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SlimCampaign) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SlimCampaign) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatusNil + +`func (o *SlimCampaign) SetStatusNil(b bool)` + + SetStatusNil sets the value for Status to be an explicit nil + +### UnsetStatus +`func (o *SlimCampaign) UnsetStatus()` + +UnsetStatus ensures that no value is present for Status, not even an explicit nil +### GetCorrelatedStatus + +`func (o *SlimCampaign) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *SlimCampaign) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *SlimCampaign) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + +### HasCorrelatedStatus + +`func (o *SlimCampaign) HasCorrelatedStatus() bool` + +HasCorrelatedStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *SlimCampaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SlimCampaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SlimCampaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SlimCampaign) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *SlimCampaign) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *SlimCampaign) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetTotalCertifications + +`func (o *SlimCampaign) GetTotalCertifications() int32` + +GetTotalCertifications returns the TotalCertifications field if non-nil, zero value otherwise. + +### GetTotalCertificationsOk + +`func (o *SlimCampaign) GetTotalCertificationsOk() (*int32, bool)` + +GetTotalCertificationsOk returns a tuple with the TotalCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCertifications + +`func (o *SlimCampaign) SetTotalCertifications(v int32)` + +SetTotalCertifications sets TotalCertifications field to given value. + +### HasTotalCertifications + +`func (o *SlimCampaign) HasTotalCertifications() bool` + +HasTotalCertifications returns a boolean if a field has been set. + +### SetTotalCertificationsNil + +`func (o *SlimCampaign) SetTotalCertificationsNil(b bool)` + + SetTotalCertificationsNil sets the value for TotalCertifications to be an explicit nil + +### UnsetTotalCertifications +`func (o *SlimCampaign) UnsetTotalCertifications()` + +UnsetTotalCertifications ensures that no value is present for TotalCertifications, not even an explicit nil +### GetCompletedCertifications + +`func (o *SlimCampaign) GetCompletedCertifications() int32` + +GetCompletedCertifications returns the CompletedCertifications field if non-nil, zero value otherwise. + +### GetCompletedCertificationsOk + +`func (o *SlimCampaign) GetCompletedCertificationsOk() (*int32, bool)` + +GetCompletedCertificationsOk returns a tuple with the CompletedCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedCertifications + +`func (o *SlimCampaign) SetCompletedCertifications(v int32)` + +SetCompletedCertifications sets CompletedCertifications field to given value. + +### HasCompletedCertifications + +`func (o *SlimCampaign) HasCompletedCertifications() bool` + +HasCompletedCertifications returns a boolean if a field has been set. + +### SetCompletedCertificationsNil + +`func (o *SlimCampaign) SetCompletedCertificationsNil(b bool)` + + SetCompletedCertificationsNil sets the value for CompletedCertifications to be an explicit nil + +### UnsetCompletedCertifications +`func (o *SlimCampaign) UnsetCompletedCertifications()` + +UnsetCompletedCertifications ensures that no value is present for CompletedCertifications, not even an explicit nil +### GetAlerts + +`func (o *SlimCampaign) GetAlerts() []CampaignAlert` + +GetAlerts returns the Alerts field if non-nil, zero value otherwise. + +### GetAlertsOk + +`func (o *SlimCampaign) GetAlertsOk() (*[]CampaignAlert, bool)` + +GetAlertsOk returns a tuple with the Alerts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlerts + +`func (o *SlimCampaign) SetAlerts(v []CampaignAlert)` + +SetAlerts sets Alerts field to given value. + +### HasAlerts + +`func (o *SlimCampaign) HasAlerts() bool` + +HasAlerts returns a boolean if a field has been set. + +### SetAlertsNil + +`func (o *SlimCampaign) SetAlertsNil(b bool)` + + SetAlertsNil sets the value for Alerts to be an explicit nil + +### UnsetAlerts +`func (o *SlimCampaign) UnsetAlerts()` + +UnsetAlerts ensures that no value is present for Alerts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SlimDiscoveredApplications.md b/docs/tools/sdk/go/Reference/V2025/Models/SlimDiscoveredApplications.md new file mode 100644 index 000000000..63ecf25b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SlimDiscoveredApplications.md @@ -0,0 +1,272 @@ +--- +id: v2025-slim-discovered-applications +title: SlimDiscoveredApplications +pagination_label: SlimDiscoveredApplications +sidebar_label: SlimDiscoveredApplications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SlimDiscoveredApplications', 'V2025SlimDiscoveredApplications'] +slug: /tools/sdk/go/v2025/models/slim-discovered-applications +tags: ['SDK', 'Software Development Kit', 'SlimDiscoveredApplications', 'V2025SlimDiscoveredApplications'] +--- + +# SlimDiscoveredApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **string** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **string** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **string** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **string** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]string** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **SailPointTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **string** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [optional] + +## Methods + +### NewSlimDiscoveredApplications + +`func NewSlimDiscoveredApplications() *SlimDiscoveredApplications` + +NewSlimDiscoveredApplications instantiates a new SlimDiscoveredApplications 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 + +### NewSlimDiscoveredApplicationsWithDefaults + +`func NewSlimDiscoveredApplicationsWithDefaults() *SlimDiscoveredApplications` + +NewSlimDiscoveredApplicationsWithDefaults instantiates a new SlimDiscoveredApplications 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 + +### GetId + +`func (o *SlimDiscoveredApplications) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SlimDiscoveredApplications) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SlimDiscoveredApplications) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SlimDiscoveredApplications) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SlimDiscoveredApplications) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SlimDiscoveredApplications) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SlimDiscoveredApplications) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SlimDiscoveredApplications) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDiscoverySource + +`func (o *SlimDiscoveredApplications) GetDiscoverySource() string` + +GetDiscoverySource returns the DiscoverySource field if non-nil, zero value otherwise. + +### GetDiscoverySourceOk + +`func (o *SlimDiscoveredApplications) GetDiscoverySourceOk() (*string, bool)` + +GetDiscoverySourceOk returns a tuple with the DiscoverySource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoverySource + +`func (o *SlimDiscoveredApplications) SetDiscoverySource(v string)` + +SetDiscoverySource sets DiscoverySource field to given value. + +### HasDiscoverySource + +`func (o *SlimDiscoveredApplications) HasDiscoverySource() bool` + +HasDiscoverySource returns a boolean if a field has been set. + +### GetDiscoveredVendor + +`func (o *SlimDiscoveredApplications) GetDiscoveredVendor() string` + +GetDiscoveredVendor returns the DiscoveredVendor field if non-nil, zero value otherwise. + +### GetDiscoveredVendorOk + +`func (o *SlimDiscoveredApplications) GetDiscoveredVendorOk() (*string, bool)` + +GetDiscoveredVendorOk returns a tuple with the DiscoveredVendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredVendor + +`func (o *SlimDiscoveredApplications) SetDiscoveredVendor(v string)` + +SetDiscoveredVendor sets DiscoveredVendor field to given value. + +### HasDiscoveredVendor + +`func (o *SlimDiscoveredApplications) HasDiscoveredVendor() bool` + +HasDiscoveredVendor returns a boolean if a field has been set. + +### GetDescription + +`func (o *SlimDiscoveredApplications) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SlimDiscoveredApplications) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SlimDiscoveredApplications) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SlimDiscoveredApplications) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetRecommendedConnectors + +`func (o *SlimDiscoveredApplications) GetRecommendedConnectors() []string` + +GetRecommendedConnectors returns the RecommendedConnectors field if non-nil, zero value otherwise. + +### GetRecommendedConnectorsOk + +`func (o *SlimDiscoveredApplications) GetRecommendedConnectorsOk() (*[]string, bool)` + +GetRecommendedConnectorsOk returns a tuple with the RecommendedConnectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendedConnectors + +`func (o *SlimDiscoveredApplications) SetRecommendedConnectors(v []string)` + +SetRecommendedConnectors sets RecommendedConnectors field to given value. + +### HasRecommendedConnectors + +`func (o *SlimDiscoveredApplications) HasRecommendedConnectors() bool` + +HasRecommendedConnectors returns a boolean if a field has been set. + +### GetDiscoveredAt + +`func (o *SlimDiscoveredApplications) GetDiscoveredAt() SailPointTime` + +GetDiscoveredAt returns the DiscoveredAt field if non-nil, zero value otherwise. + +### GetDiscoveredAtOk + +`func (o *SlimDiscoveredApplications) GetDiscoveredAtOk() (*SailPointTime, bool)` + +GetDiscoveredAtOk returns a tuple with the DiscoveredAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredAt + +`func (o *SlimDiscoveredApplications) SetDiscoveredAt(v SailPointTime)` + +SetDiscoveredAt sets DiscoveredAt field to given value. + +### HasDiscoveredAt + +`func (o *SlimDiscoveredApplications) HasDiscoveredAt() bool` + +HasDiscoveredAt returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *SlimDiscoveredApplications) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *SlimDiscoveredApplications) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *SlimDiscoveredApplications) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *SlimDiscoveredApplications) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetStatus + +`func (o *SlimDiscoveredApplications) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SlimDiscoveredApplications) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SlimDiscoveredApplications) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SlimDiscoveredApplications) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SodExemptCriteria.md b/docs/tools/sdk/go/Reference/V2025/Models/SodExemptCriteria.md new file mode 100644 index 000000000..2517c81b9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SodExemptCriteria.md @@ -0,0 +1,142 @@ +--- +id: v2025-sod-exempt-criteria +title: SodExemptCriteria +pagination_label: SodExemptCriteria +sidebar_label: SodExemptCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodExemptCriteria', 'V2025SodExemptCriteria'] +slug: /tools/sdk/go/v2025/models/sod-exempt-criteria +tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria', 'V2025SodExemptCriteria'] +--- + +# SodExemptCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Existing** | Pointer to **bool** | If the entitlement already belonged to the user or not. | [optional] [default to false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | Entitlement ID | [optional] +**Name** | Pointer to **string** | Entitlement name | [optional] + +## Methods + +### NewSodExemptCriteria + +`func NewSodExemptCriteria() *SodExemptCriteria` + +NewSodExemptCriteria instantiates a new SodExemptCriteria 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 + +### NewSodExemptCriteriaWithDefaults + +`func NewSodExemptCriteriaWithDefaults() *SodExemptCriteria` + +NewSodExemptCriteriaWithDefaults instantiates a new SodExemptCriteria 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 + +### GetExisting + +`func (o *SodExemptCriteria) GetExisting() bool` + +GetExisting returns the Existing field if non-nil, zero value otherwise. + +### GetExistingOk + +`func (o *SodExemptCriteria) GetExistingOk() (*bool, bool)` + +GetExistingOk returns a tuple with the Existing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExisting + +`func (o *SodExemptCriteria) SetExisting(v bool)` + +SetExisting sets Existing field to given value. + +### HasExisting + +`func (o *SodExemptCriteria) HasExisting() bool` + +HasExisting returns a boolean if a field has been set. + +### GetType + +`func (o *SodExemptCriteria) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodExemptCriteria) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodExemptCriteria) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodExemptCriteria) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodExemptCriteria) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodExemptCriteria) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodExemptCriteria) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodExemptCriteria) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodExemptCriteria) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodExemptCriteria) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodExemptCriteria) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodExemptCriteria) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SodPolicy.md b/docs/tools/sdk/go/Reference/V2025/Models/SodPolicy.md new file mode 100644 index 000000000..6c4915eee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SodPolicy.md @@ -0,0 +1,556 @@ +--- +id: v2025-sod-policy +title: SodPolicy +pagination_label: SodPolicy +sidebar_label: SodPolicy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicy', 'V2025SodPolicy'] +slug: /tools/sdk/go/v2025/models/sod-policy +tags: ['SDK', 'Software Development Kit', 'SodPolicy', 'V2025SodPolicy'] +--- + +# SodPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Policy id | [optional] [readonly] +**Name** | Pointer to **string** | Policy Business Name | [optional] +**Created** | Pointer to **SailPointTime** | The time when this SOD policy is created. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | The time when this SOD policy is modified. | [optional] [readonly] +**Description** | Pointer to **NullableString** | Optional description of the SOD policy | [optional] +**OwnerRef** | Pointer to [**SodPolicyOwnerRef**](sod-policy-owner-ref) | | [optional] +**ExternalPolicyReference** | Pointer to **NullableString** | Optional External Policy Reference | [optional] +**PolicyQuery** | Pointer to **string** | Search query of the SOD policy | [optional] +**CompensatingControls** | Pointer to **NullableString** | Optional compensating controls(Mitigating Controls) | [optional] +**CorrectionAdvice** | Pointer to **NullableString** | Optional correction advice | [optional] +**State** | Pointer to **string** | whether the policy is enforced or not | [optional] +**Tags** | Pointer to **[]string** | tags for this policy object | [optional] +**CreatorId** | Pointer to **string** | Policy's creator ID | [optional] [readonly] +**ModifierId** | Pointer to **NullableString** | Policy's modifier ID | [optional] [readonly] +**ViolationOwnerAssignmentConfig** | Pointer to [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional] +**Scheduled** | Pointer to **bool** | defines whether a policy has been scheduled or not | [optional] [default to false] +**Type** | Pointer to **string** | whether a policy is query based or conflicting access based | [optional] [default to "GENERAL"] +**ConflictingAccessCriteria** | Pointer to [**SodPolicyConflictingAccessCriteria**](sod-policy-conflicting-access-criteria) | | [optional] + +## Methods + +### NewSodPolicy + +`func NewSodPolicy() *SodPolicy` + +NewSodPolicy instantiates a new SodPolicy 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 + +### NewSodPolicyWithDefaults + +`func NewSodPolicyWithDefaults() *SodPolicy` + +NewSodPolicyWithDefaults instantiates a new SodPolicy 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 + +### GetId + +`func (o *SodPolicy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodPolicy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodPolicy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodPolicy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodPolicy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodPolicy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodPolicy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodPolicy) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *SodPolicy) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SodPolicy) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SodPolicy) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SodPolicy) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SodPolicy) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SodPolicy) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SodPolicy) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SodPolicy) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *SodPolicy) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SodPolicy) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SodPolicy) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SodPolicy) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *SodPolicy) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *SodPolicy) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwnerRef + +`func (o *SodPolicy) GetOwnerRef() SodPolicyOwnerRef` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *SodPolicy) GetOwnerRefOk() (*SodPolicyOwnerRef, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *SodPolicy) SetOwnerRef(v SodPolicyOwnerRef)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *SodPolicy) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### GetExternalPolicyReference + +`func (o *SodPolicy) GetExternalPolicyReference() string` + +GetExternalPolicyReference returns the ExternalPolicyReference field if non-nil, zero value otherwise. + +### GetExternalPolicyReferenceOk + +`func (o *SodPolicy) GetExternalPolicyReferenceOk() (*string, bool)` + +GetExternalPolicyReferenceOk returns a tuple with the ExternalPolicyReference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExternalPolicyReference + +`func (o *SodPolicy) SetExternalPolicyReference(v string)` + +SetExternalPolicyReference sets ExternalPolicyReference field to given value. + +### HasExternalPolicyReference + +`func (o *SodPolicy) HasExternalPolicyReference() bool` + +HasExternalPolicyReference returns a boolean if a field has been set. + +### SetExternalPolicyReferenceNil + +`func (o *SodPolicy) SetExternalPolicyReferenceNil(b bool)` + + SetExternalPolicyReferenceNil sets the value for ExternalPolicyReference to be an explicit nil + +### UnsetExternalPolicyReference +`func (o *SodPolicy) UnsetExternalPolicyReference()` + +UnsetExternalPolicyReference ensures that no value is present for ExternalPolicyReference, not even an explicit nil +### GetPolicyQuery + +`func (o *SodPolicy) GetPolicyQuery() string` + +GetPolicyQuery returns the PolicyQuery field if non-nil, zero value otherwise. + +### GetPolicyQueryOk + +`func (o *SodPolicy) GetPolicyQueryOk() (*string, bool)` + +GetPolicyQueryOk returns a tuple with the PolicyQuery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyQuery + +`func (o *SodPolicy) SetPolicyQuery(v string)` + +SetPolicyQuery sets PolicyQuery field to given value. + +### HasPolicyQuery + +`func (o *SodPolicy) HasPolicyQuery() bool` + +HasPolicyQuery returns a boolean if a field has been set. + +### GetCompensatingControls + +`func (o *SodPolicy) GetCompensatingControls() string` + +GetCompensatingControls returns the CompensatingControls field if non-nil, zero value otherwise. + +### GetCompensatingControlsOk + +`func (o *SodPolicy) GetCompensatingControlsOk() (*string, bool)` + +GetCompensatingControlsOk returns a tuple with the CompensatingControls field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompensatingControls + +`func (o *SodPolicy) SetCompensatingControls(v string)` + +SetCompensatingControls sets CompensatingControls field to given value. + +### HasCompensatingControls + +`func (o *SodPolicy) HasCompensatingControls() bool` + +HasCompensatingControls returns a boolean if a field has been set. + +### SetCompensatingControlsNil + +`func (o *SodPolicy) SetCompensatingControlsNil(b bool)` + + SetCompensatingControlsNil sets the value for CompensatingControls to be an explicit nil + +### UnsetCompensatingControls +`func (o *SodPolicy) UnsetCompensatingControls()` + +UnsetCompensatingControls ensures that no value is present for CompensatingControls, not even an explicit nil +### GetCorrectionAdvice + +`func (o *SodPolicy) GetCorrectionAdvice() string` + +GetCorrectionAdvice returns the CorrectionAdvice field if non-nil, zero value otherwise. + +### GetCorrectionAdviceOk + +`func (o *SodPolicy) GetCorrectionAdviceOk() (*string, bool)` + +GetCorrectionAdviceOk returns a tuple with the CorrectionAdvice field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrectionAdvice + +`func (o *SodPolicy) SetCorrectionAdvice(v string)` + +SetCorrectionAdvice sets CorrectionAdvice field to given value. + +### HasCorrectionAdvice + +`func (o *SodPolicy) HasCorrectionAdvice() bool` + +HasCorrectionAdvice returns a boolean if a field has been set. + +### SetCorrectionAdviceNil + +`func (o *SodPolicy) SetCorrectionAdviceNil(b bool)` + + SetCorrectionAdviceNil sets the value for CorrectionAdvice to be an explicit nil + +### UnsetCorrectionAdvice +`func (o *SodPolicy) UnsetCorrectionAdvice()` + +UnsetCorrectionAdvice ensures that no value is present for CorrectionAdvice, not even an explicit nil +### GetState + +`func (o *SodPolicy) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *SodPolicy) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *SodPolicy) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *SodPolicy) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetTags + +`func (o *SodPolicy) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *SodPolicy) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *SodPolicy) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *SodPolicy) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetCreatorId + +`func (o *SodPolicy) GetCreatorId() string` + +GetCreatorId returns the CreatorId field if non-nil, zero value otherwise. + +### GetCreatorIdOk + +`func (o *SodPolicy) GetCreatorIdOk() (*string, bool)` + +GetCreatorIdOk returns a tuple with the CreatorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatorId + +`func (o *SodPolicy) SetCreatorId(v string)` + +SetCreatorId sets CreatorId field to given value. + +### HasCreatorId + +`func (o *SodPolicy) HasCreatorId() bool` + +HasCreatorId returns a boolean if a field has been set. + +### GetModifierId + +`func (o *SodPolicy) GetModifierId() string` + +GetModifierId returns the ModifierId field if non-nil, zero value otherwise. + +### GetModifierIdOk + +`func (o *SodPolicy) GetModifierIdOk() (*string, bool)` + +GetModifierIdOk returns a tuple with the ModifierId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifierId + +`func (o *SodPolicy) SetModifierId(v string)` + +SetModifierId sets ModifierId field to given value. + +### HasModifierId + +`func (o *SodPolicy) HasModifierId() bool` + +HasModifierId returns a boolean if a field has been set. + +### SetModifierIdNil + +`func (o *SodPolicy) SetModifierIdNil(b bool)` + + SetModifierIdNil sets the value for ModifierId to be an explicit nil + +### UnsetModifierId +`func (o *SodPolicy) UnsetModifierId()` + +UnsetModifierId ensures that no value is present for ModifierId, not even an explicit nil +### GetViolationOwnerAssignmentConfig + +`func (o *SodPolicy) GetViolationOwnerAssignmentConfig() ViolationOwnerAssignmentConfig` + +GetViolationOwnerAssignmentConfig returns the ViolationOwnerAssignmentConfig field if non-nil, zero value otherwise. + +### GetViolationOwnerAssignmentConfigOk + +`func (o *SodPolicy) GetViolationOwnerAssignmentConfigOk() (*ViolationOwnerAssignmentConfig, bool)` + +GetViolationOwnerAssignmentConfigOk returns a tuple with the ViolationOwnerAssignmentConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationOwnerAssignmentConfig + +`func (o *SodPolicy) SetViolationOwnerAssignmentConfig(v ViolationOwnerAssignmentConfig)` + +SetViolationOwnerAssignmentConfig sets ViolationOwnerAssignmentConfig field to given value. + +### HasViolationOwnerAssignmentConfig + +`func (o *SodPolicy) HasViolationOwnerAssignmentConfig() bool` + +HasViolationOwnerAssignmentConfig returns a boolean if a field has been set. + +### GetScheduled + +`func (o *SodPolicy) GetScheduled() bool` + +GetScheduled returns the Scheduled field if non-nil, zero value otherwise. + +### GetScheduledOk + +`func (o *SodPolicy) GetScheduledOk() (*bool, bool)` + +GetScheduledOk returns a tuple with the Scheduled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheduled + +`func (o *SodPolicy) SetScheduled(v bool)` + +SetScheduled sets Scheduled field to given value. + +### HasScheduled + +`func (o *SodPolicy) HasScheduled() bool` + +HasScheduled returns a boolean if a field has been set. + +### GetType + +`func (o *SodPolicy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodPolicy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodPolicy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodPolicy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConflictingAccessCriteria + +`func (o *SodPolicy) GetConflictingAccessCriteria() SodPolicyConflictingAccessCriteria` + +GetConflictingAccessCriteria returns the ConflictingAccessCriteria field if non-nil, zero value otherwise. + +### GetConflictingAccessCriteriaOk + +`func (o *SodPolicy) GetConflictingAccessCriteriaOk() (*SodPolicyConflictingAccessCriteria, bool)` + +GetConflictingAccessCriteriaOk returns a tuple with the ConflictingAccessCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConflictingAccessCriteria + +`func (o *SodPolicy) SetConflictingAccessCriteria(v SodPolicyConflictingAccessCriteria)` + +SetConflictingAccessCriteria sets ConflictingAccessCriteria field to given value. + +### HasConflictingAccessCriteria + +`func (o *SodPolicy) HasConflictingAccessCriteria() bool` + +HasConflictingAccessCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SodPolicyConflictingAccessCriteria.md b/docs/tools/sdk/go/Reference/V2025/Models/SodPolicyConflictingAccessCriteria.md new file mode 100644 index 000000000..3c7561ebd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SodPolicyConflictingAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: v2025-sod-policy-conflicting-access-criteria +title: SodPolicyConflictingAccessCriteria +pagination_label: SodPolicyConflictingAccessCriteria +sidebar_label: SodPolicyConflictingAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicyConflictingAccessCriteria', 'V2025SodPolicyConflictingAccessCriteria'] +slug: /tools/sdk/go/v2025/models/sod-policy-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodPolicyConflictingAccessCriteria', 'V2025SodPolicyConflictingAccessCriteria'] +--- + +# SodPolicyConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] +**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] + +## Methods + +### NewSodPolicyConflictingAccessCriteria + +`func NewSodPolicyConflictingAccessCriteria() *SodPolicyConflictingAccessCriteria` + +NewSodPolicyConflictingAccessCriteria instantiates a new SodPolicyConflictingAccessCriteria 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 + +### NewSodPolicyConflictingAccessCriteriaWithDefaults + +`func NewSodPolicyConflictingAccessCriteriaWithDefaults() *SodPolicyConflictingAccessCriteria` + +NewSodPolicyConflictingAccessCriteriaWithDefaults instantiates a new SodPolicyConflictingAccessCriteria 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 + +### GetLeftCriteria + +`func (o *SodPolicyConflictingAccessCriteria) GetLeftCriteria() AccessCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *SodPolicyConflictingAccessCriteria) GetLeftCriteriaOk() (*AccessCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *SodPolicyConflictingAccessCriteria) SetLeftCriteria(v AccessCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *SodPolicyConflictingAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *SodPolicyConflictingAccessCriteria) GetRightCriteria() AccessCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *SodPolicyConflictingAccessCriteria) GetRightCriteriaOk() (*AccessCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *SodPolicyConflictingAccessCriteria) SetRightCriteria(v AccessCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *SodPolicyConflictingAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SodPolicyDto.md b/docs/tools/sdk/go/Reference/V2025/Models/SodPolicyDto.md new file mode 100644 index 000000000..0b9f1248d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SodPolicyDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-sod-policy-dto +title: SodPolicyDto +pagination_label: SodPolicyDto +sidebar_label: SodPolicyDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicyDto', 'V2025SodPolicyDto'] +slug: /tools/sdk/go/v2025/models/sod-policy-dto +tags: ['SDK', 'Software Development Kit', 'SodPolicyDto', 'V2025SodPolicyDto'] +--- + +# SodPolicyDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy ID. | [optional] +**Name** | Pointer to **string** | SOD policy display name. | [optional] + +## Methods + +### NewSodPolicyDto + +`func NewSodPolicyDto() *SodPolicyDto` + +NewSodPolicyDto instantiates a new SodPolicyDto 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 + +### NewSodPolicyDtoWithDefaults + +`func NewSodPolicyDtoWithDefaults() *SodPolicyDto` + +NewSodPolicyDtoWithDefaults instantiates a new SodPolicyDto 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 + +### GetType + +`func (o *SodPolicyDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodPolicyDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodPolicyDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodPolicyDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodPolicyDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodPolicyDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodPolicyDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodPolicyDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodPolicyDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodPolicyDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodPolicyDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodPolicyDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SodPolicyOwnerRef.md b/docs/tools/sdk/go/Reference/V2025/Models/SodPolicyOwnerRef.md new file mode 100644 index 000000000..99db95ec4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SodPolicyOwnerRef.md @@ -0,0 +1,116 @@ +--- +id: v2025-sod-policy-owner-ref +title: SodPolicyOwnerRef +pagination_label: SodPolicyOwnerRef +sidebar_label: SodPolicyOwnerRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicyOwnerRef', 'V2025SodPolicyOwnerRef'] +slug: /tools/sdk/go/v2025/models/sod-policy-owner-ref +tags: ['SDK', 'Software Development Kit', 'SodPolicyOwnerRef', 'V2025SodPolicyOwnerRef'] +--- + +# SodPolicyOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner type. | [optional] +**Id** | Pointer to **string** | Owner's ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] + +## Methods + +### NewSodPolicyOwnerRef + +`func NewSodPolicyOwnerRef() *SodPolicyOwnerRef` + +NewSodPolicyOwnerRef instantiates a new SodPolicyOwnerRef 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 + +### NewSodPolicyOwnerRefWithDefaults + +`func NewSodPolicyOwnerRefWithDefaults() *SodPolicyOwnerRef` + +NewSodPolicyOwnerRefWithDefaults instantiates a new SodPolicyOwnerRef 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 + +### GetType + +`func (o *SodPolicyOwnerRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodPolicyOwnerRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodPolicyOwnerRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodPolicyOwnerRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodPolicyOwnerRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodPolicyOwnerRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodPolicyOwnerRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodPolicyOwnerRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodPolicyOwnerRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodPolicyOwnerRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodPolicyOwnerRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodPolicyOwnerRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SodPolicySchedule.md b/docs/tools/sdk/go/Reference/V2025/Models/SodPolicySchedule.md new file mode 100644 index 000000000..e0567f0bc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SodPolicySchedule.md @@ -0,0 +1,272 @@ +--- +id: v2025-sod-policy-schedule +title: SodPolicySchedule +pagination_label: SodPolicySchedule +sidebar_label: SodPolicySchedule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicySchedule', 'V2025SodPolicySchedule'] +slug: /tools/sdk/go/v2025/models/sod-policy-schedule +tags: ['SDK', 'Software Development Kit', 'SodPolicySchedule', 'V2025SodPolicySchedule'] +--- + +# SodPolicySchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | SOD Policy schedule name | [optional] +**Created** | Pointer to **SailPointTime** | The time when this SOD policy schedule is created. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | The time when this SOD policy schedule is modified. | [optional] [readonly] +**Description** | Pointer to **string** | SOD Policy schedule description | [optional] +**Schedule** | Pointer to [**Schedule2**](schedule2) | | [optional] +**Recipients** | Pointer to [**[]SodRecipient**](sod-recipient) | | [optional] +**EmailEmptyResults** | Pointer to **bool** | Indicates if empty results need to be emailed | [optional] [default to false] +**CreatorId** | Pointer to **string** | Policy's creator ID | [optional] [readonly] +**ModifierId** | Pointer to **string** | Policy's modifier ID | [optional] [readonly] + +## Methods + +### NewSodPolicySchedule + +`func NewSodPolicySchedule() *SodPolicySchedule` + +NewSodPolicySchedule instantiates a new SodPolicySchedule 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 + +### NewSodPolicyScheduleWithDefaults + +`func NewSodPolicyScheduleWithDefaults() *SodPolicySchedule` + +NewSodPolicyScheduleWithDefaults instantiates a new SodPolicySchedule 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 + +### GetName + +`func (o *SodPolicySchedule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodPolicySchedule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodPolicySchedule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodPolicySchedule) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *SodPolicySchedule) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SodPolicySchedule) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SodPolicySchedule) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SodPolicySchedule) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SodPolicySchedule) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SodPolicySchedule) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SodPolicySchedule) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SodPolicySchedule) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *SodPolicySchedule) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SodPolicySchedule) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SodPolicySchedule) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SodPolicySchedule) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetSchedule + +`func (o *SodPolicySchedule) GetSchedule() Schedule2` + +GetSchedule returns the Schedule field if non-nil, zero value otherwise. + +### GetScheduleOk + +`func (o *SodPolicySchedule) GetScheduleOk() (*Schedule2, bool)` + +GetScheduleOk returns a tuple with the Schedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchedule + +`func (o *SodPolicySchedule) SetSchedule(v Schedule2)` + +SetSchedule sets Schedule field to given value. + +### HasSchedule + +`func (o *SodPolicySchedule) HasSchedule() bool` + +HasSchedule returns a boolean if a field has been set. + +### GetRecipients + +`func (o *SodPolicySchedule) GetRecipients() []SodRecipient` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *SodPolicySchedule) GetRecipientsOk() (*[]SodRecipient, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *SodPolicySchedule) SetRecipients(v []SodRecipient)` + +SetRecipients sets Recipients field to given value. + +### HasRecipients + +`func (o *SodPolicySchedule) HasRecipients() bool` + +HasRecipients returns a boolean if a field has been set. + +### GetEmailEmptyResults + +`func (o *SodPolicySchedule) GetEmailEmptyResults() bool` + +GetEmailEmptyResults returns the EmailEmptyResults field if non-nil, zero value otherwise. + +### GetEmailEmptyResultsOk + +`func (o *SodPolicySchedule) GetEmailEmptyResultsOk() (*bool, bool)` + +GetEmailEmptyResultsOk returns a tuple with the EmailEmptyResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEmptyResults + +`func (o *SodPolicySchedule) SetEmailEmptyResults(v bool)` + +SetEmailEmptyResults sets EmailEmptyResults field to given value. + +### HasEmailEmptyResults + +`func (o *SodPolicySchedule) HasEmailEmptyResults() bool` + +HasEmailEmptyResults returns a boolean if a field has been set. + +### GetCreatorId + +`func (o *SodPolicySchedule) GetCreatorId() string` + +GetCreatorId returns the CreatorId field if non-nil, zero value otherwise. + +### GetCreatorIdOk + +`func (o *SodPolicySchedule) GetCreatorIdOk() (*string, bool)` + +GetCreatorIdOk returns a tuple with the CreatorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatorId + +`func (o *SodPolicySchedule) SetCreatorId(v string)` + +SetCreatorId sets CreatorId field to given value. + +### HasCreatorId + +`func (o *SodPolicySchedule) HasCreatorId() bool` + +HasCreatorId returns a boolean if a field has been set. + +### GetModifierId + +`func (o *SodPolicySchedule) GetModifierId() string` + +GetModifierId returns the ModifierId field if non-nil, zero value otherwise. + +### GetModifierIdOk + +`func (o *SodPolicySchedule) GetModifierIdOk() (*string, bool)` + +GetModifierIdOk returns a tuple with the ModifierId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifierId + +`func (o *SodPolicySchedule) SetModifierId(v string)` + +SetModifierId sets ModifierId field to given value. + +### HasModifierId + +`func (o *SodPolicySchedule) HasModifierId() bool` + +HasModifierId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SodRecipient.md b/docs/tools/sdk/go/Reference/V2025/Models/SodRecipient.md new file mode 100644 index 000000000..e1f9545ea --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SodRecipient.md @@ -0,0 +1,116 @@ +--- +id: v2025-sod-recipient +title: SodRecipient +pagination_label: SodRecipient +sidebar_label: SodRecipient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodRecipient', 'V2025SodRecipient'] +slug: /tools/sdk/go/v2025/models/sod-recipient +tags: ['SDK', 'Software Development Kit', 'SodRecipient', 'V2025SodRecipient'] +--- + +# SodRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy recipient DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy recipient's identity ID. | [optional] +**Name** | Pointer to **string** | SOD policy recipient's display name. | [optional] + +## Methods + +### NewSodRecipient + +`func NewSodRecipient() *SodRecipient` + +NewSodRecipient instantiates a new SodRecipient 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 + +### NewSodRecipientWithDefaults + +`func NewSodRecipientWithDefaults() *SodRecipient` + +NewSodRecipientWithDefaults instantiates a new SodRecipient 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 + +### GetType + +`func (o *SodRecipient) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodRecipient) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodRecipient) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodRecipient) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodRecipient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodRecipient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodRecipient) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodRecipient) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodRecipient) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodRecipient) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodRecipient) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodRecipient) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SodReportResultDto.md b/docs/tools/sdk/go/Reference/V2025/Models/SodReportResultDto.md new file mode 100644 index 000000000..3010eee9d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SodReportResultDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-sod-report-result-dto +title: SodReportResultDto +pagination_label: SodReportResultDto +sidebar_label: SodReportResultDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodReportResultDto', 'V2025SodReportResultDto'] +slug: /tools/sdk/go/v2025/models/sod-report-result-dto +tags: ['SDK', 'Software Development Kit', 'SodReportResultDto', 'V2025SodReportResultDto'] +--- + +# SodReportResultDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **string** | Human-readable name of the SOD policy violation report result. | [optional] + +## Methods + +### NewSodReportResultDto + +`func NewSodReportResultDto() *SodReportResultDto` + +NewSodReportResultDto instantiates a new SodReportResultDto 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 + +### NewSodReportResultDtoWithDefaults + +`func NewSodReportResultDtoWithDefaults() *SodReportResultDto` + +NewSodReportResultDtoWithDefaults instantiates a new SodReportResultDto 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 + +### GetType + +`func (o *SodReportResultDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodReportResultDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodReportResultDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodReportResultDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodReportResultDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodReportResultDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodReportResultDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodReportResultDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodReportResultDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodReportResultDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodReportResultDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodReportResultDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SodViolationCheck.md b/docs/tools/sdk/go/Reference/V2025/Models/SodViolationCheck.md new file mode 100644 index 000000000..d9ad541c2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SodViolationCheck.md @@ -0,0 +1,85 @@ +--- +id: v2025-sod-violation-check +title: SodViolationCheck +pagination_label: SodViolationCheck +sidebar_label: SodViolationCheck +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationCheck', 'V2025SodViolationCheck'] +slug: /tools/sdk/go/v2025/models/sod-violation-check +tags: ['SDK', 'Software Development Kit', 'SodViolationCheck', 'V2025SodViolationCheck'] +--- + +# SodViolationCheck + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | **string** | The id of the original request | +**Created** | Pointer to **SailPointTime** | The date-time when this request was created. | [optional] [readonly] + +## Methods + +### NewSodViolationCheck + +`func NewSodViolationCheck(requestId string, ) *SodViolationCheck` + +NewSodViolationCheck instantiates a new SodViolationCheck 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 + +### NewSodViolationCheckWithDefaults + +`func NewSodViolationCheckWithDefaults() *SodViolationCheck` + +NewSodViolationCheckWithDefaults instantiates a new SodViolationCheck 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 + +### GetRequestId + +`func (o *SodViolationCheck) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *SodViolationCheck) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *SodViolationCheck) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + + +### GetCreated + +`func (o *SodViolationCheck) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SodViolationCheck) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SodViolationCheck) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SodViolationCheck) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SodViolationCheckResult.md b/docs/tools/sdk/go/Reference/V2025/Models/SodViolationCheckResult.md new file mode 100644 index 000000000..7240d50d7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SodViolationCheckResult.md @@ -0,0 +1,172 @@ +--- +id: v2025-sod-violation-check-result +title: SodViolationCheckResult +pagination_label: SodViolationCheckResult +sidebar_label: SodViolationCheckResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationCheckResult', 'V2025SodViolationCheckResult'] +slug: /tools/sdk/go/v2025/models/sod-violation-check-result +tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult', 'V2025SodViolationCheckResult'] +--- + +# SodViolationCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to [**ErrorMessageDto**](error-message-dto) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] +**ViolationContexts** | Pointer to [**[]SodViolationContext**](sod-violation-context) | | [optional] +**ViolatedPolicies** | Pointer to [**[]SodPolicyDto**](sod-policy-dto) | A list of the SOD policies that were violated. | [optional] + +## Methods + +### NewSodViolationCheckResult + +`func NewSodViolationCheckResult() *SodViolationCheckResult` + +NewSodViolationCheckResult instantiates a new SodViolationCheckResult 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 + +### NewSodViolationCheckResultWithDefaults + +`func NewSodViolationCheckResultWithDefaults() *SodViolationCheckResult` + +NewSodViolationCheckResultWithDefaults instantiates a new SodViolationCheckResult 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 + +### GetMessage + +`func (o *SodViolationCheckResult) GetMessage() ErrorMessageDto` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *SodViolationCheckResult) GetMessageOk() (*ErrorMessageDto, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *SodViolationCheckResult) SetMessage(v ErrorMessageDto)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *SodViolationCheckResult) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *SodViolationCheckResult) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *SodViolationCheckResult) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *SodViolationCheckResult) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *SodViolationCheckResult) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *SodViolationCheckResult) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *SodViolationCheckResult) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetViolationContexts + +`func (o *SodViolationCheckResult) GetViolationContexts() []SodViolationContext` + +GetViolationContexts returns the ViolationContexts field if non-nil, zero value otherwise. + +### GetViolationContextsOk + +`func (o *SodViolationCheckResult) GetViolationContextsOk() (*[]SodViolationContext, bool)` + +GetViolationContextsOk returns a tuple with the ViolationContexts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationContexts + +`func (o *SodViolationCheckResult) SetViolationContexts(v []SodViolationContext)` + +SetViolationContexts sets ViolationContexts field to given value. + +### HasViolationContexts + +`func (o *SodViolationCheckResult) HasViolationContexts() bool` + +HasViolationContexts returns a boolean if a field has been set. + +### SetViolationContextsNil + +`func (o *SodViolationCheckResult) SetViolationContextsNil(b bool)` + + SetViolationContextsNil sets the value for ViolationContexts to be an explicit nil + +### UnsetViolationContexts +`func (o *SodViolationCheckResult) UnsetViolationContexts()` + +UnsetViolationContexts ensures that no value is present for ViolationContexts, not even an explicit nil +### GetViolatedPolicies + +`func (o *SodViolationCheckResult) GetViolatedPolicies() []SodPolicyDto` + +GetViolatedPolicies returns the ViolatedPolicies field if non-nil, zero value otherwise. + +### GetViolatedPoliciesOk + +`func (o *SodViolationCheckResult) GetViolatedPoliciesOk() (*[]SodPolicyDto, bool)` + +GetViolatedPoliciesOk returns a tuple with the ViolatedPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolatedPolicies + +`func (o *SodViolationCheckResult) SetViolatedPolicies(v []SodPolicyDto)` + +SetViolatedPolicies sets ViolatedPolicies field to given value. + +### HasViolatedPolicies + +`func (o *SodViolationCheckResult) HasViolatedPolicies() bool` + +HasViolatedPolicies returns a boolean if a field has been set. + +### SetViolatedPoliciesNil + +`func (o *SodViolationCheckResult) SetViolatedPoliciesNil(b bool)` + + SetViolatedPoliciesNil sets the value for ViolatedPolicies to be an explicit nil + +### UnsetViolatedPolicies +`func (o *SodViolationCheckResult) UnsetViolatedPolicies()` + +UnsetViolatedPolicies ensures that no value is present for ViolatedPolicies, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SodViolationContext.md b/docs/tools/sdk/go/Reference/V2025/Models/SodViolationContext.md new file mode 100644 index 000000000..b21128761 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SodViolationContext.md @@ -0,0 +1,90 @@ +--- +id: v2025-sod-violation-context +title: SodViolationContext +pagination_label: SodViolationContext +sidebar_label: SodViolationContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContext', 'V2025SodViolationContext'] +slug: /tools/sdk/go/v2025/models/sod-violation-context +tags: ['SDK', 'Software Development Kit', 'SodViolationContext', 'V2025SodViolationContext'] +--- + +# SodViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**SodPolicyDto**](sod-policy-dto) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteria**](sod-violation-context-conflicting-access-criteria) | | [optional] + +## Methods + +### NewSodViolationContext + +`func NewSodViolationContext() *SodViolationContext` + +NewSodViolationContext instantiates a new SodViolationContext 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 + +### NewSodViolationContextWithDefaults + +`func NewSodViolationContextWithDefaults() *SodViolationContext` + +NewSodViolationContextWithDefaults instantiates a new SodViolationContext 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 + +### GetPolicy + +`func (o *SodViolationContext) GetPolicy() SodPolicyDto` + +GetPolicy returns the Policy field if non-nil, zero value otherwise. + +### GetPolicyOk + +`func (o *SodViolationContext) GetPolicyOk() (*SodPolicyDto, bool)` + +GetPolicyOk returns a tuple with the Policy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicy + +`func (o *SodViolationContext) SetPolicy(v SodPolicyDto)` + +SetPolicy sets Policy field to given value. + +### HasPolicy + +`func (o *SodViolationContext) HasPolicy() bool` + +HasPolicy returns a boolean if a field has been set. + +### GetConflictingAccessCriteria + +`func (o *SodViolationContext) GetConflictingAccessCriteria() SodViolationContextConflictingAccessCriteria` + +GetConflictingAccessCriteria returns the ConflictingAccessCriteria field if non-nil, zero value otherwise. + +### GetConflictingAccessCriteriaOk + +`func (o *SodViolationContext) GetConflictingAccessCriteriaOk() (*SodViolationContextConflictingAccessCriteria, bool)` + +GetConflictingAccessCriteriaOk returns a tuple with the ConflictingAccessCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConflictingAccessCriteria + +`func (o *SodViolationContext) SetConflictingAccessCriteria(v SodViolationContextConflictingAccessCriteria)` + +SetConflictingAccessCriteria sets ConflictingAccessCriteria field to given value. + +### HasConflictingAccessCriteria + +`func (o *SodViolationContext) HasConflictingAccessCriteria() bool` + +HasConflictingAccessCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SodViolationContextCheckCompleted.md b/docs/tools/sdk/go/Reference/V2025/Models/SodViolationContextCheckCompleted.md new file mode 100644 index 000000000..5102acaee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SodViolationContextCheckCompleted.md @@ -0,0 +1,136 @@ +--- +id: v2025-sod-violation-context-check-completed +title: SodViolationContextCheckCompleted +pagination_label: SodViolationContextCheckCompleted +sidebar_label: SodViolationContextCheckCompleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContextCheckCompleted', 'V2025SodViolationContextCheckCompleted'] +slug: /tools/sdk/go/v2025/models/sod-violation-context-check-completed +tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted', 'V2025SodViolationContextCheckCompleted'] +--- + +# SodViolationContextCheckCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **NullableString** | The status of SOD violation check | [optional] +**Uuid** | Pointer to **NullableString** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] + +## Methods + +### NewSodViolationContextCheckCompleted + +`func NewSodViolationContextCheckCompleted() *SodViolationContextCheckCompleted` + +NewSodViolationContextCheckCompleted instantiates a new SodViolationContextCheckCompleted 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 + +### NewSodViolationContextCheckCompletedWithDefaults + +`func NewSodViolationContextCheckCompletedWithDefaults() *SodViolationContextCheckCompleted` + +NewSodViolationContextCheckCompletedWithDefaults instantiates a new SodViolationContextCheckCompleted 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 + +### GetState + +`func (o *SodViolationContextCheckCompleted) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *SodViolationContextCheckCompleted) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *SodViolationContextCheckCompleted) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *SodViolationContextCheckCompleted) HasState() bool` + +HasState returns a boolean if a field has been set. + +### SetStateNil + +`func (o *SodViolationContextCheckCompleted) SetStateNil(b bool)` + + SetStateNil sets the value for State to be an explicit nil + +### UnsetState +`func (o *SodViolationContextCheckCompleted) UnsetState()` + +UnsetState ensures that no value is present for State, not even an explicit nil +### GetUuid + +`func (o *SodViolationContextCheckCompleted) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *SodViolationContextCheckCompleted) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *SodViolationContextCheckCompleted) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *SodViolationContextCheckCompleted) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *SodViolationContextCheckCompleted) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *SodViolationContextCheckCompleted) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetViolationCheckResult + +`func (o *SodViolationContextCheckCompleted) GetViolationCheckResult() SodViolationCheckResult` + +GetViolationCheckResult returns the ViolationCheckResult field if non-nil, zero value otherwise. + +### GetViolationCheckResultOk + +`func (o *SodViolationContextCheckCompleted) GetViolationCheckResultOk() (*SodViolationCheckResult, bool)` + +GetViolationCheckResultOk returns a tuple with the ViolationCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationCheckResult + +`func (o *SodViolationContextCheckCompleted) SetViolationCheckResult(v SodViolationCheckResult)` + +SetViolationCheckResult sets ViolationCheckResult field to given value. + +### HasViolationCheckResult + +`func (o *SodViolationContextCheckCompleted) HasViolationCheckResult() bool` + +HasViolationCheckResult returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SodViolationContextConflictingAccessCriteria.md b/docs/tools/sdk/go/Reference/V2025/Models/SodViolationContextConflictingAccessCriteria.md new file mode 100644 index 000000000..31123f1e9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SodViolationContextConflictingAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: v2025-sod-violation-context-conflicting-access-criteria +title: SodViolationContextConflictingAccessCriteria +pagination_label: SodViolationContextConflictingAccessCriteria +sidebar_label: SodViolationContextConflictingAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContextConflictingAccessCriteria', 'V2025SodViolationContextConflictingAccessCriteria'] +slug: /tools/sdk/go/v2025/models/sod-violation-context-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteria', 'V2025SodViolationContextConflictingAccessCriteria'] +--- + +# SodViolationContextConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] +**RightCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] + +## Methods + +### NewSodViolationContextConflictingAccessCriteria + +`func NewSodViolationContextConflictingAccessCriteria() *SodViolationContextConflictingAccessCriteria` + +NewSodViolationContextConflictingAccessCriteria instantiates a new SodViolationContextConflictingAccessCriteria 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 + +### NewSodViolationContextConflictingAccessCriteriaWithDefaults + +`func NewSodViolationContextConflictingAccessCriteriaWithDefaults() *SodViolationContextConflictingAccessCriteria` + +NewSodViolationContextConflictingAccessCriteriaWithDefaults instantiates a new SodViolationContextConflictingAccessCriteria 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 + +### GetLeftCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) GetLeftCriteria() SodViolationContextConflictingAccessCriteriaLeftCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *SodViolationContextConflictingAccessCriteria) GetLeftCriteriaOk() (*SodViolationContextConflictingAccessCriteriaLeftCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) SetLeftCriteria(v SodViolationContextConflictingAccessCriteriaLeftCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) GetRightCriteria() SodViolationContextConflictingAccessCriteriaLeftCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *SodViolationContextConflictingAccessCriteria) GetRightCriteriaOk() (*SodViolationContextConflictingAccessCriteriaLeftCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) SetRightCriteria(v SodViolationContextConflictingAccessCriteriaLeftCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/go/Reference/V2025/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md new file mode 100644 index 000000000..7e718189b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md @@ -0,0 +1,64 @@ +--- +id: v2025-sod-violation-context-conflicting-access-criteria-left-criteria +title: SodViolationContextConflictingAccessCriteriaLeftCriteria +pagination_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'V2025SodViolationContextConflictingAccessCriteriaLeftCriteria'] +slug: /tools/sdk/go/v2025/models/sod-violation-context-conflicting-access-criteria-left-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'V2025SodViolationContextConflictingAccessCriteriaLeftCriteria'] +--- + +# SodViolationContextConflictingAccessCriteriaLeftCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]SodExemptCriteria**](sod-exempt-criteria) | | [optional] + +## Methods + +### NewSodViolationContextConflictingAccessCriteriaLeftCriteria + +`func NewSodViolationContextConflictingAccessCriteriaLeftCriteria() *SodViolationContextConflictingAccessCriteriaLeftCriteria` + +NewSodViolationContextConflictingAccessCriteriaLeftCriteria instantiates a new SodViolationContextConflictingAccessCriteriaLeftCriteria 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 + +### NewSodViolationContextConflictingAccessCriteriaLeftCriteriaWithDefaults + +`func NewSodViolationContextConflictingAccessCriteriaLeftCriteriaWithDefaults() *SodViolationContextConflictingAccessCriteriaLeftCriteria` + +NewSodViolationContextConflictingAccessCriteriaLeftCriteriaWithDefaults instantiates a new SodViolationContextConflictingAccessCriteriaLeftCriteria 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 + +### GetCriteriaList + +`func (o *SodViolationContextConflictingAccessCriteriaLeftCriteria) GetCriteriaList() []SodExemptCriteria` + +GetCriteriaList returns the CriteriaList field if non-nil, zero value otherwise. + +### GetCriteriaListOk + +`func (o *SodViolationContextConflictingAccessCriteriaLeftCriteria) GetCriteriaListOk() (*[]SodExemptCriteria, bool)` + +GetCriteriaListOk returns a tuple with the CriteriaList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteriaList + +`func (o *SodViolationContextConflictingAccessCriteriaLeftCriteria) SetCriteriaList(v []SodExemptCriteria)` + +SetCriteriaList sets CriteriaList field to given value. + +### HasCriteriaList + +`func (o *SodViolationContextConflictingAccessCriteriaLeftCriteria) HasCriteriaList() bool` + +HasCriteriaList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Source.md b/docs/tools/sdk/go/Reference/V2025/Models/Source.md new file mode 100644 index 000000000..cebe5d723 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Source.md @@ -0,0 +1,909 @@ +--- +id: v2025-source +title: Source +pagination_label: Source +sidebar_label: Source +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Source', 'V2025Source'] +slug: /tools/sdk/go/v2025/models/source +tags: ['SDK', 'Software Development Kit', 'Source', 'V2025Source'] +--- + +# Source + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Source ID. | [optional] [readonly] +**Name** | **string** | Source's human-readable name. | +**Description** | Pointer to **string** | Source's human-readable description. | [optional] +**Owner** | [**SourceOwner**](source-owner) | | +**Cluster** | Pointer to [**NullableSourceCluster**](source-cluster) | | [optional] +**AccountCorrelationConfig** | Pointer to [**NullableSourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional] +**AccountCorrelationRule** | Pointer to [**NullableSourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional] +**ManagerCorrelationMapping** | Pointer to [**SourceManagerCorrelationMapping**](source-manager-correlation-mapping) | | [optional] +**ManagerCorrelationRule** | Pointer to [**NullableSourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional] +**BeforeProvisioningRule** | Pointer to [**NullableSourceBeforeProvisioningRule**](source-before-provisioning-rule) | | [optional] +**Schemas** | Pointer to [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional] +**PasswordPolicies** | Pointer to [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**Features** | Pointer to **[]string** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Type** | Pointer to **string** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Connector** | **string** | Connector script name. | +**ConnectorClass** | Pointer to **string** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**ConnectorAttributes** | Pointer to **map[string]interface{}** | Connector specific configuration. This configuration will differ from type to type. | [optional] +**DeleteThreshold** | Pointer to **int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**Authoritative** | Pointer to **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to false] +**ManagementWorkgroup** | Pointer to [**NullableSourceManagementWorkgroup**](source-management-workgroup) | | [optional] +**Healthy** | Pointer to **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to false] +**Status** | Pointer to **string** | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**Since** | Pointer to **string** | Timestamp that shows when a source health check was last performed. | [optional] +**ConnectorId** | Pointer to **string** | Connector ID | [optional] +**ConnectorName** | Pointer to **string** | Name of the connector that was chosen during source creation. | [optional] +**ConnectionType** | Pointer to **string** | Type of connection (direct or file). | [optional] +**ConnectorImplementationId** | Pointer to **string** | Connector implementation ID. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date-time when the source was last modified. | [optional] +**CredentialProviderEnabled** | Pointer to **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to false] +**Category** | Pointer to **NullableString** | Source category (e.g. null, CredentialProvider). | [optional] + +## Methods + +### NewSource + +`func NewSource(name string, owner SourceOwner, connector string, ) *Source` + +NewSource instantiates a new Source 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 + +### NewSourceWithDefaults + +`func NewSourceWithDefaults() *Source` + +NewSourceWithDefaults instantiates a new Source 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 + +### GetId + +`func (o *Source) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Source) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Source) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Source) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Source) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Source) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Source) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Source) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Source) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Source) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Source) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *Source) GetOwner() SourceOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Source) GetOwnerOk() (*SourceOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Source) SetOwner(v SourceOwner)` + +SetOwner sets Owner field to given value. + + +### GetCluster + +`func (o *Source) GetCluster() SourceCluster` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *Source) GetClusterOk() (*SourceCluster, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *Source) SetCluster(v SourceCluster)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *Source) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### SetClusterNil + +`func (o *Source) SetClusterNil(b bool)` + + SetClusterNil sets the value for Cluster to be an explicit nil + +### UnsetCluster +`func (o *Source) UnsetCluster()` + +UnsetCluster ensures that no value is present for Cluster, not even an explicit nil +### GetAccountCorrelationConfig + +`func (o *Source) GetAccountCorrelationConfig() SourceAccountCorrelationConfig` + +GetAccountCorrelationConfig returns the AccountCorrelationConfig field if non-nil, zero value otherwise. + +### GetAccountCorrelationConfigOk + +`func (o *Source) GetAccountCorrelationConfigOk() (*SourceAccountCorrelationConfig, bool)` + +GetAccountCorrelationConfigOk returns a tuple with the AccountCorrelationConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationConfig + +`func (o *Source) SetAccountCorrelationConfig(v SourceAccountCorrelationConfig)` + +SetAccountCorrelationConfig sets AccountCorrelationConfig field to given value. + +### HasAccountCorrelationConfig + +`func (o *Source) HasAccountCorrelationConfig() bool` + +HasAccountCorrelationConfig returns a boolean if a field has been set. + +### SetAccountCorrelationConfigNil + +`func (o *Source) SetAccountCorrelationConfigNil(b bool)` + + SetAccountCorrelationConfigNil sets the value for AccountCorrelationConfig to be an explicit nil + +### UnsetAccountCorrelationConfig +`func (o *Source) UnsetAccountCorrelationConfig()` + +UnsetAccountCorrelationConfig ensures that no value is present for AccountCorrelationConfig, not even an explicit nil +### GetAccountCorrelationRule + +`func (o *Source) GetAccountCorrelationRule() SourceAccountCorrelationRule` + +GetAccountCorrelationRule returns the AccountCorrelationRule field if non-nil, zero value otherwise. + +### GetAccountCorrelationRuleOk + +`func (o *Source) GetAccountCorrelationRuleOk() (*SourceAccountCorrelationRule, bool)` + +GetAccountCorrelationRuleOk returns a tuple with the AccountCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationRule + +`func (o *Source) SetAccountCorrelationRule(v SourceAccountCorrelationRule)` + +SetAccountCorrelationRule sets AccountCorrelationRule field to given value. + +### HasAccountCorrelationRule + +`func (o *Source) HasAccountCorrelationRule() bool` + +HasAccountCorrelationRule returns a boolean if a field has been set. + +### SetAccountCorrelationRuleNil + +`func (o *Source) SetAccountCorrelationRuleNil(b bool)` + + SetAccountCorrelationRuleNil sets the value for AccountCorrelationRule to be an explicit nil + +### UnsetAccountCorrelationRule +`func (o *Source) UnsetAccountCorrelationRule()` + +UnsetAccountCorrelationRule ensures that no value is present for AccountCorrelationRule, not even an explicit nil +### GetManagerCorrelationMapping + +`func (o *Source) GetManagerCorrelationMapping() SourceManagerCorrelationMapping` + +GetManagerCorrelationMapping returns the ManagerCorrelationMapping field if non-nil, zero value otherwise. + +### GetManagerCorrelationMappingOk + +`func (o *Source) GetManagerCorrelationMappingOk() (*SourceManagerCorrelationMapping, bool)` + +GetManagerCorrelationMappingOk returns a tuple with the ManagerCorrelationMapping field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationMapping + +`func (o *Source) SetManagerCorrelationMapping(v SourceManagerCorrelationMapping)` + +SetManagerCorrelationMapping sets ManagerCorrelationMapping field to given value. + +### HasManagerCorrelationMapping + +`func (o *Source) HasManagerCorrelationMapping() bool` + +HasManagerCorrelationMapping returns a boolean if a field has been set. + +### GetManagerCorrelationRule + +`func (o *Source) GetManagerCorrelationRule() SourceManagerCorrelationRule` + +GetManagerCorrelationRule returns the ManagerCorrelationRule field if non-nil, zero value otherwise. + +### GetManagerCorrelationRuleOk + +`func (o *Source) GetManagerCorrelationRuleOk() (*SourceManagerCorrelationRule, bool)` + +GetManagerCorrelationRuleOk returns a tuple with the ManagerCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationRule + +`func (o *Source) SetManagerCorrelationRule(v SourceManagerCorrelationRule)` + +SetManagerCorrelationRule sets ManagerCorrelationRule field to given value. + +### HasManagerCorrelationRule + +`func (o *Source) HasManagerCorrelationRule() bool` + +HasManagerCorrelationRule returns a boolean if a field has been set. + +### SetManagerCorrelationRuleNil + +`func (o *Source) SetManagerCorrelationRuleNil(b bool)` + + SetManagerCorrelationRuleNil sets the value for ManagerCorrelationRule to be an explicit nil + +### UnsetManagerCorrelationRule +`func (o *Source) UnsetManagerCorrelationRule()` + +UnsetManagerCorrelationRule ensures that no value is present for ManagerCorrelationRule, not even an explicit nil +### GetBeforeProvisioningRule + +`func (o *Source) GetBeforeProvisioningRule() SourceBeforeProvisioningRule` + +GetBeforeProvisioningRule returns the BeforeProvisioningRule field if non-nil, zero value otherwise. + +### GetBeforeProvisioningRuleOk + +`func (o *Source) GetBeforeProvisioningRuleOk() (*SourceBeforeProvisioningRule, bool)` + +GetBeforeProvisioningRuleOk returns a tuple with the BeforeProvisioningRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBeforeProvisioningRule + +`func (o *Source) SetBeforeProvisioningRule(v SourceBeforeProvisioningRule)` + +SetBeforeProvisioningRule sets BeforeProvisioningRule field to given value. + +### HasBeforeProvisioningRule + +`func (o *Source) HasBeforeProvisioningRule() bool` + +HasBeforeProvisioningRule returns a boolean if a field has been set. + +### SetBeforeProvisioningRuleNil + +`func (o *Source) SetBeforeProvisioningRuleNil(b bool)` + + SetBeforeProvisioningRuleNil sets the value for BeforeProvisioningRule to be an explicit nil + +### UnsetBeforeProvisioningRule +`func (o *Source) UnsetBeforeProvisioningRule()` + +UnsetBeforeProvisioningRule ensures that no value is present for BeforeProvisioningRule, not even an explicit nil +### GetSchemas + +`func (o *Source) GetSchemas() []SourceSchemasInner` + +GetSchemas returns the Schemas field if non-nil, zero value otherwise. + +### GetSchemasOk + +`func (o *Source) GetSchemasOk() (*[]SourceSchemasInner, bool)` + +GetSchemasOk returns a tuple with the Schemas field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchemas + +`func (o *Source) SetSchemas(v []SourceSchemasInner)` + +SetSchemas sets Schemas field to given value. + +### HasSchemas + +`func (o *Source) HasSchemas() bool` + +HasSchemas returns a boolean if a field has been set. + +### GetPasswordPolicies + +`func (o *Source) GetPasswordPolicies() []SourcePasswordPoliciesInner` + +GetPasswordPolicies returns the PasswordPolicies field if non-nil, zero value otherwise. + +### GetPasswordPoliciesOk + +`func (o *Source) GetPasswordPoliciesOk() (*[]SourcePasswordPoliciesInner, bool)` + +GetPasswordPoliciesOk returns a tuple with the PasswordPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicies + +`func (o *Source) SetPasswordPolicies(v []SourcePasswordPoliciesInner)` + +SetPasswordPolicies sets PasswordPolicies field to given value. + +### HasPasswordPolicies + +`func (o *Source) HasPasswordPolicies() bool` + +HasPasswordPolicies returns a boolean if a field has been set. + +### SetPasswordPoliciesNil + +`func (o *Source) SetPasswordPoliciesNil(b bool)` + + SetPasswordPoliciesNil sets the value for PasswordPolicies to be an explicit nil + +### UnsetPasswordPolicies +`func (o *Source) UnsetPasswordPolicies()` + +UnsetPasswordPolicies ensures that no value is present for PasswordPolicies, not even an explicit nil +### GetFeatures + +`func (o *Source) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *Source) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *Source) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *Source) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### GetType + +`func (o *Source) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Source) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Source) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Source) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConnector + +`func (o *Source) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *Source) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *Source) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetConnectorClass + +`func (o *Source) GetConnectorClass() string` + +GetConnectorClass returns the ConnectorClass field if non-nil, zero value otherwise. + +### GetConnectorClassOk + +`func (o *Source) GetConnectorClassOk() (*string, bool)` + +GetConnectorClassOk returns a tuple with the ConnectorClass field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorClass + +`func (o *Source) SetConnectorClass(v string)` + +SetConnectorClass sets ConnectorClass field to given value. + +### HasConnectorClass + +`func (o *Source) HasConnectorClass() bool` + +HasConnectorClass returns a boolean if a field has been set. + +### GetConnectorAttributes + +`func (o *Source) GetConnectorAttributes() map[string]interface{}` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *Source) GetConnectorAttributesOk() (*map[string]interface{}, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *Source) SetConnectorAttributes(v map[string]interface{})` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + +### HasConnectorAttributes + +`func (o *Source) HasConnectorAttributes() bool` + +HasConnectorAttributes returns a boolean if a field has been set. + +### GetDeleteThreshold + +`func (o *Source) GetDeleteThreshold() int32` + +GetDeleteThreshold returns the DeleteThreshold field if non-nil, zero value otherwise. + +### GetDeleteThresholdOk + +`func (o *Source) GetDeleteThresholdOk() (*int32, bool)` + +GetDeleteThresholdOk returns a tuple with the DeleteThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteThreshold + +`func (o *Source) SetDeleteThreshold(v int32)` + +SetDeleteThreshold sets DeleteThreshold field to given value. + +### HasDeleteThreshold + +`func (o *Source) HasDeleteThreshold() bool` + +HasDeleteThreshold returns a boolean if a field has been set. + +### GetAuthoritative + +`func (o *Source) GetAuthoritative() bool` + +GetAuthoritative returns the Authoritative field if non-nil, zero value otherwise. + +### GetAuthoritativeOk + +`func (o *Source) GetAuthoritativeOk() (*bool, bool)` + +GetAuthoritativeOk returns a tuple with the Authoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritative + +`func (o *Source) SetAuthoritative(v bool)` + +SetAuthoritative sets Authoritative field to given value. + +### HasAuthoritative + +`func (o *Source) HasAuthoritative() bool` + +HasAuthoritative returns a boolean if a field has been set. + +### GetManagementWorkgroup + +`func (o *Source) GetManagementWorkgroup() SourceManagementWorkgroup` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *Source) GetManagementWorkgroupOk() (*SourceManagementWorkgroup, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *Source) SetManagementWorkgroup(v SourceManagementWorkgroup)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *Source) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### SetManagementWorkgroupNil + +`func (o *Source) SetManagementWorkgroupNil(b bool)` + + SetManagementWorkgroupNil sets the value for ManagementWorkgroup to be an explicit nil + +### UnsetManagementWorkgroup +`func (o *Source) UnsetManagementWorkgroup()` + +UnsetManagementWorkgroup ensures that no value is present for ManagementWorkgroup, not even an explicit nil +### GetHealthy + +`func (o *Source) GetHealthy() bool` + +GetHealthy returns the Healthy field if non-nil, zero value otherwise. + +### GetHealthyOk + +`func (o *Source) GetHealthyOk() (*bool, bool)` + +GetHealthyOk returns a tuple with the Healthy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthy + +`func (o *Source) SetHealthy(v bool)` + +SetHealthy sets Healthy field to given value. + +### HasHealthy + +`func (o *Source) HasHealthy() bool` + +HasHealthy returns a boolean if a field has been set. + +### GetStatus + +`func (o *Source) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Source) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Source) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Source) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSince + +`func (o *Source) GetSince() string` + +GetSince returns the Since field if non-nil, zero value otherwise. + +### GetSinceOk + +`func (o *Source) GetSinceOk() (*string, bool)` + +GetSinceOk returns a tuple with the Since field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSince + +`func (o *Source) SetSince(v string)` + +SetSince sets Since field to given value. + +### HasSince + +`func (o *Source) HasSince() bool` + +HasSince returns a boolean if a field has been set. + +### GetConnectorId + +`func (o *Source) GetConnectorId() string` + +GetConnectorId returns the ConnectorId field if non-nil, zero value otherwise. + +### GetConnectorIdOk + +`func (o *Source) GetConnectorIdOk() (*string, bool)` + +GetConnectorIdOk returns a tuple with the ConnectorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorId + +`func (o *Source) SetConnectorId(v string)` + +SetConnectorId sets ConnectorId field to given value. + +### HasConnectorId + +`func (o *Source) HasConnectorId() bool` + +HasConnectorId returns a boolean if a field has been set. + +### GetConnectorName + +`func (o *Source) GetConnectorName() string` + +GetConnectorName returns the ConnectorName field if non-nil, zero value otherwise. + +### GetConnectorNameOk + +`func (o *Source) GetConnectorNameOk() (*string, bool)` + +GetConnectorNameOk returns a tuple with the ConnectorName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorName + +`func (o *Source) SetConnectorName(v string)` + +SetConnectorName sets ConnectorName field to given value. + +### HasConnectorName + +`func (o *Source) HasConnectorName() bool` + +HasConnectorName returns a boolean if a field has been set. + +### GetConnectionType + +`func (o *Source) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *Source) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *Source) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *Source) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + +### GetConnectorImplementationId + +`func (o *Source) GetConnectorImplementationId() string` + +GetConnectorImplementationId returns the ConnectorImplementationId field if non-nil, zero value otherwise. + +### GetConnectorImplementationIdOk + +`func (o *Source) GetConnectorImplementationIdOk() (*string, bool)` + +GetConnectorImplementationIdOk returns a tuple with the ConnectorImplementationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorImplementationId + +`func (o *Source) SetConnectorImplementationId(v string)` + +SetConnectorImplementationId sets ConnectorImplementationId field to given value. + +### HasConnectorImplementationId + +`func (o *Source) HasConnectorImplementationId() bool` + +HasConnectorImplementationId returns a boolean if a field has been set. + +### GetCreated + +`func (o *Source) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Source) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Source) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Source) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Source) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Source) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Source) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Source) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCredentialProviderEnabled + +`func (o *Source) GetCredentialProviderEnabled() bool` + +GetCredentialProviderEnabled returns the CredentialProviderEnabled field if non-nil, zero value otherwise. + +### GetCredentialProviderEnabledOk + +`func (o *Source) GetCredentialProviderEnabledOk() (*bool, bool)` + +GetCredentialProviderEnabledOk returns a tuple with the CredentialProviderEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialProviderEnabled + +`func (o *Source) SetCredentialProviderEnabled(v bool)` + +SetCredentialProviderEnabled sets CredentialProviderEnabled field to given value. + +### HasCredentialProviderEnabled + +`func (o *Source) HasCredentialProviderEnabled() bool` + +HasCredentialProviderEnabled returns a boolean if a field has been set. + +### GetCategory + +`func (o *Source) GetCategory() string` + +GetCategory returns the Category field if non-nil, zero value otherwise. + +### GetCategoryOk + +`func (o *Source) GetCategoryOk() (*string, bool)` + +GetCategoryOk returns a tuple with the Category field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCategory + +`func (o *Source) SetCategory(v string)` + +SetCategory sets Category field to given value. + +### HasCategory + +`func (o *Source) HasCategory() bool` + +HasCategory returns a boolean if a field has been set. + +### SetCategoryNil + +`func (o *Source) SetCategoryNil(b bool)` + + SetCategoryNil sets the value for Category to be an explicit nil + +### UnsetCategory +`func (o *Source) UnsetCategory()` + +UnsetCategory ensures that no value is present for Category, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Source1.md b/docs/tools/sdk/go/Reference/V2025/Models/Source1.md new file mode 100644 index 000000000..5e2cf1683 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Source1.md @@ -0,0 +1,90 @@ +--- +id: v2025-source1 +title: Source1 +pagination_label: Source1 +sidebar_label: Source1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Source1', 'V2025Source1'] +slug: /tools/sdk/go/v2025/models/source1 +tags: ['SDK', 'Software Development Kit', 'Source1', 'V2025Source1'] +--- + +# Source1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Attribute mapping type. | [optional] +**Properties** | Pointer to **map[string]interface{}** | Attribute mapping properties. | [optional] + +## Methods + +### NewSource1 + +`func NewSource1() *Source1` + +NewSource1 instantiates a new Source1 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 + +### NewSource1WithDefaults + +`func NewSource1WithDefaults() *Source1` + +NewSource1WithDefaults instantiates a new Source1 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 + +### GetType + +`func (o *Source1) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Source1) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Source1) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Source1) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetProperties + +`func (o *Source1) GetProperties() map[string]interface{}` + +GetProperties returns the Properties field if non-nil, zero value otherwise. + +### GetPropertiesOk + +`func (o *Source1) GetPropertiesOk() (*map[string]interface{}, bool)` + +GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperties + +`func (o *Source1) SetProperties(v map[string]interface{})` + +SetProperties sets Properties field to given value. + +### HasProperties + +`func (o *Source1) HasProperties() bool` + +HasProperties returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountCorrelationConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountCorrelationConfig.md new file mode 100644 index 000000000..aa6a113b7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountCorrelationConfig.md @@ -0,0 +1,116 @@ +--- +id: v2025-source-account-correlation-config +title: SourceAccountCorrelationConfig +pagination_label: SourceAccountCorrelationConfig +sidebar_label: SourceAccountCorrelationConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountCorrelationConfig', 'V2025SourceAccountCorrelationConfig'] +slug: /tools/sdk/go/v2025/models/source-account-correlation-config +tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationConfig', 'V2025SourceAccountCorrelationConfig'] +--- + +# SourceAccountCorrelationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Account correlation config ID. | [optional] +**Name** | Pointer to **string** | Account correlation config's human-readable display name. | [optional] + +## Methods + +### NewSourceAccountCorrelationConfig + +`func NewSourceAccountCorrelationConfig() *SourceAccountCorrelationConfig` + +NewSourceAccountCorrelationConfig instantiates a new SourceAccountCorrelationConfig 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 + +### NewSourceAccountCorrelationConfigWithDefaults + +`func NewSourceAccountCorrelationConfigWithDefaults() *SourceAccountCorrelationConfig` + +NewSourceAccountCorrelationConfigWithDefaults instantiates a new SourceAccountCorrelationConfig 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 + +### GetType + +`func (o *SourceAccountCorrelationConfig) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceAccountCorrelationConfig) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceAccountCorrelationConfig) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceAccountCorrelationConfig) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceAccountCorrelationConfig) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountCorrelationConfig) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountCorrelationConfig) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceAccountCorrelationConfig) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAccountCorrelationConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAccountCorrelationConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAccountCorrelationConfig) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAccountCorrelationConfig) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountCorrelationRule.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountCorrelationRule.md new file mode 100644 index 000000000..970a71922 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountCorrelationRule.md @@ -0,0 +1,116 @@ +--- +id: v2025-source-account-correlation-rule +title: SourceAccountCorrelationRule +pagination_label: SourceAccountCorrelationRule +sidebar_label: SourceAccountCorrelationRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountCorrelationRule', 'V2025SourceAccountCorrelationRule'] +slug: /tools/sdk/go/v2025/models/source-account-correlation-rule +tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationRule', 'V2025SourceAccountCorrelationRule'] +--- + +# SourceAccountCorrelationRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Rule ID. | [optional] +**Name** | Pointer to **string** | Rule's human-readable display name. | [optional] + +## Methods + +### NewSourceAccountCorrelationRule + +`func NewSourceAccountCorrelationRule() *SourceAccountCorrelationRule` + +NewSourceAccountCorrelationRule instantiates a new SourceAccountCorrelationRule 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 + +### NewSourceAccountCorrelationRuleWithDefaults + +`func NewSourceAccountCorrelationRuleWithDefaults() *SourceAccountCorrelationRule` + +NewSourceAccountCorrelationRuleWithDefaults instantiates a new SourceAccountCorrelationRule 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 + +### GetType + +`func (o *SourceAccountCorrelationRule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceAccountCorrelationRule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceAccountCorrelationRule) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceAccountCorrelationRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceAccountCorrelationRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountCorrelationRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountCorrelationRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceAccountCorrelationRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAccountCorrelationRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAccountCorrelationRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAccountCorrelationRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAccountCorrelationRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountCreated.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountCreated.md new file mode 100644 index 000000000..5196e8541 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountCreated.md @@ -0,0 +1,211 @@ +--- +id: v2025-source-account-created +title: SourceAccountCreated +pagination_label: SourceAccountCreated +sidebar_label: SourceAccountCreated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountCreated', 'V2025SourceAccountCreated'] +slug: /tools/sdk/go/v2025/models/source-account-created +tags: ['SDK', 'Software Development Kit', 'SourceAccountCreated', 'V2025SourceAccountCreated'] +--- + +# SourceAccountCreated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | Pointer to **string** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**Id** | **string** | SailPoint generated unique identifier. | +**NativeIdentifier** | **string** | Unique ID of the account on the source. | +**SourceId** | **string** | The ID of the source. | +**SourceName** | **string** | The name of the source. | +**IdentityId** | **string** | The ID of the identity that is correlated with this account. | +**IdentityName** | **string** | The name of the identity that is correlated with this account. | +**Attributes** | **map[string]interface{}** | The attributes of the account. The contents of attributes depends on the account schema for the source. | + +## Methods + +### NewSourceAccountCreated + +`func NewSourceAccountCreated(id string, nativeIdentifier string, sourceId string, sourceName string, identityId string, identityName string, attributes map[string]interface{}, ) *SourceAccountCreated` + +NewSourceAccountCreated instantiates a new SourceAccountCreated 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 + +### NewSourceAccountCreatedWithDefaults + +`func NewSourceAccountCreatedWithDefaults() *SourceAccountCreated` + +NewSourceAccountCreatedWithDefaults instantiates a new SourceAccountCreated 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 + +### GetUuid + +`func (o *SourceAccountCreated) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *SourceAccountCreated) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *SourceAccountCreated) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *SourceAccountCreated) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### GetId + +`func (o *SourceAccountCreated) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountCreated) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountCreated) SetId(v string)` + +SetId sets Id field to given value. + + +### GetNativeIdentifier + +`func (o *SourceAccountCreated) GetNativeIdentifier() string` + +GetNativeIdentifier returns the NativeIdentifier field if non-nil, zero value otherwise. + +### GetNativeIdentifierOk + +`func (o *SourceAccountCreated) GetNativeIdentifierOk() (*string, bool)` + +GetNativeIdentifierOk returns a tuple with the NativeIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentifier + +`func (o *SourceAccountCreated) SetNativeIdentifier(v string)` + +SetNativeIdentifier sets NativeIdentifier field to given value. + + +### GetSourceId + +`func (o *SourceAccountCreated) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *SourceAccountCreated) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *SourceAccountCreated) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetSourceName + +`func (o *SourceAccountCreated) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *SourceAccountCreated) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *SourceAccountCreated) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### GetIdentityId + +`func (o *SourceAccountCreated) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *SourceAccountCreated) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *SourceAccountCreated) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetIdentityName + +`func (o *SourceAccountCreated) GetIdentityName() string` + +GetIdentityName returns the IdentityName field if non-nil, zero value otherwise. + +### GetIdentityNameOk + +`func (o *SourceAccountCreated) GetIdentityNameOk() (*string, bool)` + +GetIdentityNameOk returns a tuple with the IdentityName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityName + +`func (o *SourceAccountCreated) SetIdentityName(v string)` + +SetIdentityName sets IdentityName field to given value. + + +### GetAttributes + +`func (o *SourceAccountCreated) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *SourceAccountCreated) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *SourceAccountCreated) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountDeleted.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountDeleted.md new file mode 100644 index 000000000..9987546ff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountDeleted.md @@ -0,0 +1,211 @@ +--- +id: v2025-source-account-deleted +title: SourceAccountDeleted +pagination_label: SourceAccountDeleted +sidebar_label: SourceAccountDeleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountDeleted', 'V2025SourceAccountDeleted'] +slug: /tools/sdk/go/v2025/models/source-account-deleted +tags: ['SDK', 'Software Development Kit', 'SourceAccountDeleted', 'V2025SourceAccountDeleted'] +--- + +# SourceAccountDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | Pointer to **string** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**Id** | **string** | SailPoint generated unique identifier. | +**NativeIdentifier** | **string** | Unique ID of the account on the source. | +**SourceId** | **string** | The ID of the source. | +**SourceName** | **string** | The name of the source. | +**IdentityId** | **string** | The ID of the identity that is correlated with this account. | +**IdentityName** | **string** | The name of the identity that is correlated with this account. | +**Attributes** | **map[string]interface{}** | The attributes of the account. The contents of attributes depends on the account schema for the source. | + +## Methods + +### NewSourceAccountDeleted + +`func NewSourceAccountDeleted(id string, nativeIdentifier string, sourceId string, sourceName string, identityId string, identityName string, attributes map[string]interface{}, ) *SourceAccountDeleted` + +NewSourceAccountDeleted instantiates a new SourceAccountDeleted 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 + +### NewSourceAccountDeletedWithDefaults + +`func NewSourceAccountDeletedWithDefaults() *SourceAccountDeleted` + +NewSourceAccountDeletedWithDefaults instantiates a new SourceAccountDeleted 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 + +### GetUuid + +`func (o *SourceAccountDeleted) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *SourceAccountDeleted) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *SourceAccountDeleted) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *SourceAccountDeleted) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### GetId + +`func (o *SourceAccountDeleted) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountDeleted) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountDeleted) SetId(v string)` + +SetId sets Id field to given value. + + +### GetNativeIdentifier + +`func (o *SourceAccountDeleted) GetNativeIdentifier() string` + +GetNativeIdentifier returns the NativeIdentifier field if non-nil, zero value otherwise. + +### GetNativeIdentifierOk + +`func (o *SourceAccountDeleted) GetNativeIdentifierOk() (*string, bool)` + +GetNativeIdentifierOk returns a tuple with the NativeIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentifier + +`func (o *SourceAccountDeleted) SetNativeIdentifier(v string)` + +SetNativeIdentifier sets NativeIdentifier field to given value. + + +### GetSourceId + +`func (o *SourceAccountDeleted) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *SourceAccountDeleted) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *SourceAccountDeleted) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetSourceName + +`func (o *SourceAccountDeleted) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *SourceAccountDeleted) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *SourceAccountDeleted) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### GetIdentityId + +`func (o *SourceAccountDeleted) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *SourceAccountDeleted) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *SourceAccountDeleted) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetIdentityName + +`func (o *SourceAccountDeleted) GetIdentityName() string` + +GetIdentityName returns the IdentityName field if non-nil, zero value otherwise. + +### GetIdentityNameOk + +`func (o *SourceAccountDeleted) GetIdentityNameOk() (*string, bool)` + +GetIdentityNameOk returns a tuple with the IdentityName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityName + +`func (o *SourceAccountDeleted) SetIdentityName(v string)` + +SetIdentityName sets IdentityName field to given value. + + +### GetAttributes + +`func (o *SourceAccountDeleted) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *SourceAccountDeleted) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *SourceAccountDeleted) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountSelections.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountSelections.md new file mode 100644 index 000000000..2551b9d5b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountSelections.md @@ -0,0 +1,142 @@ +--- +id: v2025-source-account-selections +title: SourceAccountSelections +pagination_label: SourceAccountSelections +sidebar_label: SourceAccountSelections +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountSelections', 'V2025SourceAccountSelections'] +slug: /tools/sdk/go/v2025/models/source-account-selections +tags: ['SDK', 'Software Development Kit', 'SourceAccountSelections', 'V2025SourceAccountSelections'] +--- + +# SourceAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | The source id | [optional] +**Name** | Pointer to **string** | The source name | [optional] +**Accounts** | Pointer to [**[]AccountInfoRef**](account-info-ref) | The accounts information for a particular source in the requested item | [optional] + +## Methods + +### NewSourceAccountSelections + +`func NewSourceAccountSelections() *SourceAccountSelections` + +NewSourceAccountSelections instantiates a new SourceAccountSelections 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 + +### NewSourceAccountSelectionsWithDefaults + +`func NewSourceAccountSelectionsWithDefaults() *SourceAccountSelections` + +NewSourceAccountSelectionsWithDefaults instantiates a new SourceAccountSelections 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 + +### GetType + +`func (o *SourceAccountSelections) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceAccountSelections) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceAccountSelections) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceAccountSelections) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceAccountSelections) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountSelections) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountSelections) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceAccountSelections) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAccountSelections) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAccountSelections) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAccountSelections) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAccountSelections) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAccounts + +`func (o *SourceAccountSelections) GetAccounts() []AccountInfoRef` + +GetAccounts returns the Accounts field if non-nil, zero value otherwise. + +### GetAccountsOk + +`func (o *SourceAccountSelections) GetAccountsOk() (*[]AccountInfoRef, bool)` + +GetAccountsOk returns a tuple with the Accounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccounts + +`func (o *SourceAccountSelections) SetAccounts(v []AccountInfoRef)` + +SetAccounts sets Accounts field to given value. + +### HasAccounts + +`func (o *SourceAccountSelections) HasAccounts() bool` + +HasAccounts returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountUpdated.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountUpdated.md new file mode 100644 index 000000000..f3f2f88e5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceAccountUpdated.md @@ -0,0 +1,211 @@ +--- +id: v2025-source-account-updated +title: SourceAccountUpdated +pagination_label: SourceAccountUpdated +sidebar_label: SourceAccountUpdated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountUpdated', 'V2025SourceAccountUpdated'] +slug: /tools/sdk/go/v2025/models/source-account-updated +tags: ['SDK', 'Software Development Kit', 'SourceAccountUpdated', 'V2025SourceAccountUpdated'] +--- + +# SourceAccountUpdated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | Pointer to **string** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**Id** | **string** | SailPoint generated unique identifier. | +**NativeIdentifier** | **string** | Unique ID of the account on the source. | +**SourceId** | **string** | The ID of the source. | +**SourceName** | **string** | The name of the source. | +**IdentityId** | **string** | The ID of the identity that is correlated with this account. | +**IdentityName** | **string** | The name of the identity that is correlated with this account. | +**Attributes** | **map[string]interface{}** | The attributes of the account. The contents of attributes depends on the account schema for the source. | + +## Methods + +### NewSourceAccountUpdated + +`func NewSourceAccountUpdated(id string, nativeIdentifier string, sourceId string, sourceName string, identityId string, identityName string, attributes map[string]interface{}, ) *SourceAccountUpdated` + +NewSourceAccountUpdated instantiates a new SourceAccountUpdated 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 + +### NewSourceAccountUpdatedWithDefaults + +`func NewSourceAccountUpdatedWithDefaults() *SourceAccountUpdated` + +NewSourceAccountUpdatedWithDefaults instantiates a new SourceAccountUpdated 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 + +### GetUuid + +`func (o *SourceAccountUpdated) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *SourceAccountUpdated) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *SourceAccountUpdated) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *SourceAccountUpdated) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### GetId + +`func (o *SourceAccountUpdated) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountUpdated) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountUpdated) SetId(v string)` + +SetId sets Id field to given value. + + +### GetNativeIdentifier + +`func (o *SourceAccountUpdated) GetNativeIdentifier() string` + +GetNativeIdentifier returns the NativeIdentifier field if non-nil, zero value otherwise. + +### GetNativeIdentifierOk + +`func (o *SourceAccountUpdated) GetNativeIdentifierOk() (*string, bool)` + +GetNativeIdentifierOk returns a tuple with the NativeIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentifier + +`func (o *SourceAccountUpdated) SetNativeIdentifier(v string)` + +SetNativeIdentifier sets NativeIdentifier field to given value. + + +### GetSourceId + +`func (o *SourceAccountUpdated) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *SourceAccountUpdated) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *SourceAccountUpdated) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetSourceName + +`func (o *SourceAccountUpdated) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *SourceAccountUpdated) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *SourceAccountUpdated) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### GetIdentityId + +`func (o *SourceAccountUpdated) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *SourceAccountUpdated) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *SourceAccountUpdated) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetIdentityName + +`func (o *SourceAccountUpdated) GetIdentityName() string` + +GetIdentityName returns the IdentityName field if non-nil, zero value otherwise. + +### GetIdentityNameOk + +`func (o *SourceAccountUpdated) GetIdentityNameOk() (*string, bool)` + +GetIdentityNameOk returns a tuple with the IdentityName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityName + +`func (o *SourceAccountUpdated) SetIdentityName(v string)` + +SetIdentityName sets IdentityName field to given value. + + +### GetAttributes + +`func (o *SourceAccountUpdated) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *SourceAccountUpdated) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *SourceAccountUpdated) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceApp.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceApp.md new file mode 100644 index 000000000..54d432990 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceApp.md @@ -0,0 +1,370 @@ +--- +id: v2025-source-app +title: SourceApp +pagination_label: SourceApp +sidebar_label: SourceApp +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceApp', 'V2025SourceApp'] +slug: /tools/sdk/go/v2025/models/source-app +tags: ['SDK', 'Software Development Kit', 'SourceApp', 'V2025SourceApp'] +--- + +# SourceApp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The source app id | [optional] +**CloudAppId** | Pointer to **string** | The deprecated source app id | [optional] +**Name** | Pointer to **string** | The source app name | [optional] +**Created** | Pointer to **SailPointTime** | Time when the source app was created | [optional] +**Modified** | Pointer to **SailPointTime** | Time when the source app was last modified | [optional] +**Enabled** | Pointer to **bool** | True if the source app is enabled | [optional] [default to false] +**ProvisionRequestEnabled** | Pointer to **bool** | True if the source app is provision request enabled | [optional] [default to false] +**Description** | Pointer to **string** | The description of the source app | [optional] +**MatchAllAccounts** | Pointer to **bool** | True if the source app match all accounts | [optional] [default to false] +**AppCenterEnabled** | Pointer to **bool** | True if the source app is shown in the app center | [optional] [default to true] +**AccountSource** | Pointer to [**NullableSourceAppAccountSource**](source-app-account-source) | | [optional] +**Owner** | Pointer to [**NullableBaseReferenceDto**](base-reference-dto) | The owner of source app | [optional] + +## Methods + +### NewSourceApp + +`func NewSourceApp() *SourceApp` + +NewSourceApp instantiates a new SourceApp 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 + +### NewSourceAppWithDefaults + +`func NewSourceAppWithDefaults() *SourceApp` + +NewSourceAppWithDefaults instantiates a new SourceApp 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 + +### GetId + +`func (o *SourceApp) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceApp) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceApp) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceApp) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCloudAppId + +`func (o *SourceApp) GetCloudAppId() string` + +GetCloudAppId returns the CloudAppId field if non-nil, zero value otherwise. + +### GetCloudAppIdOk + +`func (o *SourceApp) GetCloudAppIdOk() (*string, bool)` + +GetCloudAppIdOk returns a tuple with the CloudAppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudAppId + +`func (o *SourceApp) SetCloudAppId(v string)` + +SetCloudAppId sets CloudAppId field to given value. + +### HasCloudAppId + +`func (o *SourceApp) HasCloudAppId() bool` + +HasCloudAppId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceApp) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceApp) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceApp) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceApp) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *SourceApp) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SourceApp) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SourceApp) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SourceApp) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SourceApp) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SourceApp) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SourceApp) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SourceApp) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetEnabled + +`func (o *SourceApp) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *SourceApp) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *SourceApp) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *SourceApp) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetProvisionRequestEnabled + +`func (o *SourceApp) GetProvisionRequestEnabled() bool` + +GetProvisionRequestEnabled returns the ProvisionRequestEnabled field if non-nil, zero value otherwise. + +### GetProvisionRequestEnabledOk + +`func (o *SourceApp) GetProvisionRequestEnabledOk() (*bool, bool)` + +GetProvisionRequestEnabledOk returns a tuple with the ProvisionRequestEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionRequestEnabled + +`func (o *SourceApp) SetProvisionRequestEnabled(v bool)` + +SetProvisionRequestEnabled sets ProvisionRequestEnabled field to given value. + +### HasProvisionRequestEnabled + +`func (o *SourceApp) HasProvisionRequestEnabled() bool` + +HasProvisionRequestEnabled returns a boolean if a field has been set. + +### GetDescription + +`func (o *SourceApp) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SourceApp) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SourceApp) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SourceApp) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetMatchAllAccounts + +`func (o *SourceApp) GetMatchAllAccounts() bool` + +GetMatchAllAccounts returns the MatchAllAccounts field if non-nil, zero value otherwise. + +### GetMatchAllAccountsOk + +`func (o *SourceApp) GetMatchAllAccountsOk() (*bool, bool)` + +GetMatchAllAccountsOk returns a tuple with the MatchAllAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAllAccounts + +`func (o *SourceApp) SetMatchAllAccounts(v bool)` + +SetMatchAllAccounts sets MatchAllAccounts field to given value. + +### HasMatchAllAccounts + +`func (o *SourceApp) HasMatchAllAccounts() bool` + +HasMatchAllAccounts returns a boolean if a field has been set. + +### GetAppCenterEnabled + +`func (o *SourceApp) GetAppCenterEnabled() bool` + +GetAppCenterEnabled returns the AppCenterEnabled field if non-nil, zero value otherwise. + +### GetAppCenterEnabledOk + +`func (o *SourceApp) GetAppCenterEnabledOk() (*bool, bool)` + +GetAppCenterEnabledOk returns a tuple with the AppCenterEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppCenterEnabled + +`func (o *SourceApp) SetAppCenterEnabled(v bool)` + +SetAppCenterEnabled sets AppCenterEnabled field to given value. + +### HasAppCenterEnabled + +`func (o *SourceApp) HasAppCenterEnabled() bool` + +HasAppCenterEnabled returns a boolean if a field has been set. + +### GetAccountSource + +`func (o *SourceApp) GetAccountSource() SourceAppAccountSource` + +GetAccountSource returns the AccountSource field if non-nil, zero value otherwise. + +### GetAccountSourceOk + +`func (o *SourceApp) GetAccountSourceOk() (*SourceAppAccountSource, bool)` + +GetAccountSourceOk returns a tuple with the AccountSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSource + +`func (o *SourceApp) SetAccountSource(v SourceAppAccountSource)` + +SetAccountSource sets AccountSource field to given value. + +### HasAccountSource + +`func (o *SourceApp) HasAccountSource() bool` + +HasAccountSource returns a boolean if a field has been set. + +### SetAccountSourceNil + +`func (o *SourceApp) SetAccountSourceNil(b bool)` + + SetAccountSourceNil sets the value for AccountSource to be an explicit nil + +### UnsetAccountSource +`func (o *SourceApp) UnsetAccountSource()` + +UnsetAccountSource ensures that no value is present for AccountSource, not even an explicit nil +### GetOwner + +`func (o *SourceApp) GetOwner() BaseReferenceDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *SourceApp) GetOwnerOk() (*BaseReferenceDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *SourceApp) SetOwner(v BaseReferenceDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *SourceApp) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *SourceApp) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *SourceApp) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceAppAccountSource.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceAppAccountSource.md new file mode 100644 index 000000000..29a1b130e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceAppAccountSource.md @@ -0,0 +1,178 @@ +--- +id: v2025-source-app-account-source +title: SourceAppAccountSource +pagination_label: SourceAppAccountSource +sidebar_label: SourceAppAccountSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAppAccountSource', 'V2025SourceAppAccountSource'] +slug: /tools/sdk/go/v2025/models/source-app-account-source +tags: ['SDK', 'Software Development Kit', 'SourceAppAccountSource', 'V2025SourceAppAccountSource'] +--- + +# SourceAppAccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The source ID | [optional] +**Type** | Pointer to **string** | The source type, will always be \"SOURCE\" | [optional] +**Name** | Pointer to **string** | The source name | [optional] +**UseForPasswordManagement** | Pointer to **bool** | If the source is used for password management | [optional] [default to false] +**PasswordPolicies** | Pointer to [**[]BaseReferenceDto**](base-reference-dto) | The password policies for the source | [optional] + +## Methods + +### NewSourceAppAccountSource + +`func NewSourceAppAccountSource() *SourceAppAccountSource` + +NewSourceAppAccountSource instantiates a new SourceAppAccountSource 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 + +### NewSourceAppAccountSourceWithDefaults + +`func NewSourceAppAccountSourceWithDefaults() *SourceAppAccountSource` + +NewSourceAppAccountSourceWithDefaults instantiates a new SourceAppAccountSource 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 + +### GetId + +`func (o *SourceAppAccountSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAppAccountSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAppAccountSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceAppAccountSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *SourceAppAccountSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceAppAccountSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceAppAccountSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceAppAccountSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAppAccountSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAppAccountSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAppAccountSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAppAccountSource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetUseForPasswordManagement + +`func (o *SourceAppAccountSource) GetUseForPasswordManagement() bool` + +GetUseForPasswordManagement returns the UseForPasswordManagement field if non-nil, zero value otherwise. + +### GetUseForPasswordManagementOk + +`func (o *SourceAppAccountSource) GetUseForPasswordManagementOk() (*bool, bool)` + +GetUseForPasswordManagementOk returns a tuple with the UseForPasswordManagement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseForPasswordManagement + +`func (o *SourceAppAccountSource) SetUseForPasswordManagement(v bool)` + +SetUseForPasswordManagement sets UseForPasswordManagement field to given value. + +### HasUseForPasswordManagement + +`func (o *SourceAppAccountSource) HasUseForPasswordManagement() bool` + +HasUseForPasswordManagement returns a boolean if a field has been set. + +### GetPasswordPolicies + +`func (o *SourceAppAccountSource) GetPasswordPolicies() []BaseReferenceDto` + +GetPasswordPolicies returns the PasswordPolicies field if non-nil, zero value otherwise. + +### GetPasswordPoliciesOk + +`func (o *SourceAppAccountSource) GetPasswordPoliciesOk() (*[]BaseReferenceDto, bool)` + +GetPasswordPoliciesOk returns a tuple with the PasswordPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicies + +`func (o *SourceAppAccountSource) SetPasswordPolicies(v []BaseReferenceDto)` + +SetPasswordPolicies sets PasswordPolicies field to given value. + +### HasPasswordPolicies + +`func (o *SourceAppAccountSource) HasPasswordPolicies() bool` + +HasPasswordPolicies returns a boolean if a field has been set. + +### SetPasswordPoliciesNil + +`func (o *SourceAppAccountSource) SetPasswordPoliciesNil(b bool)` + + SetPasswordPoliciesNil sets the value for PasswordPolicies to be an explicit nil + +### UnsetPasswordPolicies +`func (o *SourceAppAccountSource) UnsetPasswordPolicies()` + +UnsetPasswordPolicies ensures that no value is present for PasswordPolicies, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceAppBulkUpdateRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceAppBulkUpdateRequest.md new file mode 100644 index 000000000..9f8aedc16 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceAppBulkUpdateRequest.md @@ -0,0 +1,80 @@ +--- +id: v2025-source-app-bulk-update-request +title: SourceAppBulkUpdateRequest +pagination_label: SourceAppBulkUpdateRequest +sidebar_label: SourceAppBulkUpdateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAppBulkUpdateRequest', 'V2025SourceAppBulkUpdateRequest'] +slug: /tools/sdk/go/v2025/models/source-app-bulk-update-request +tags: ['SDK', 'Software Development Kit', 'SourceAppBulkUpdateRequest', 'V2025SourceAppBulkUpdateRequest'] +--- + +# SourceAppBulkUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AppIds** | **[]string** | List of source app ids to update | +**JsonPatch** | [**[]JsonPatchOperation**](json-patch-operation) | The JSONPatch payload used to update the source app. | + +## Methods + +### NewSourceAppBulkUpdateRequest + +`func NewSourceAppBulkUpdateRequest(appIds []string, jsonPatch []JsonPatchOperation, ) *SourceAppBulkUpdateRequest` + +NewSourceAppBulkUpdateRequest instantiates a new SourceAppBulkUpdateRequest 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 + +### NewSourceAppBulkUpdateRequestWithDefaults + +`func NewSourceAppBulkUpdateRequestWithDefaults() *SourceAppBulkUpdateRequest` + +NewSourceAppBulkUpdateRequestWithDefaults instantiates a new SourceAppBulkUpdateRequest 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 + +### GetAppIds + +`func (o *SourceAppBulkUpdateRequest) GetAppIds() []string` + +GetAppIds returns the AppIds field if non-nil, zero value otherwise. + +### GetAppIdsOk + +`func (o *SourceAppBulkUpdateRequest) GetAppIdsOk() (*[]string, bool)` + +GetAppIdsOk returns a tuple with the AppIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppIds + +`func (o *SourceAppBulkUpdateRequest) SetAppIds(v []string)` + +SetAppIds sets AppIds field to given value. + + +### GetJsonPatch + +`func (o *SourceAppBulkUpdateRequest) GetJsonPatch() []JsonPatchOperation` + +GetJsonPatch returns the JsonPatch field if non-nil, zero value otherwise. + +### GetJsonPatchOk + +`func (o *SourceAppBulkUpdateRequest) GetJsonPatchOk() (*[]JsonPatchOperation, bool)` + +GetJsonPatchOk returns a tuple with the JsonPatch field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJsonPatch + +`func (o *SourceAppBulkUpdateRequest) SetJsonPatch(v []JsonPatchOperation)` + +SetJsonPatch sets JsonPatch field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceAppCreateDto.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceAppCreateDto.md new file mode 100644 index 000000000..1e82f573f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceAppCreateDto.md @@ -0,0 +1,127 @@ +--- +id: v2025-source-app-create-dto +title: SourceAppCreateDto +pagination_label: SourceAppCreateDto +sidebar_label: SourceAppCreateDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAppCreateDto', 'V2025SourceAppCreateDto'] +slug: /tools/sdk/go/v2025/models/source-app-create-dto +tags: ['SDK', 'Software Development Kit', 'SourceAppCreateDto', 'V2025SourceAppCreateDto'] +--- + +# SourceAppCreateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The source app name | +**Description** | **string** | The description of the source app | +**MatchAllAccounts** | Pointer to **bool** | True if the source app match all accounts | [optional] [default to false] +**AccountSource** | [**SourceAppCreateDtoAccountSource**](source-app-create-dto-account-source) | | + +## Methods + +### NewSourceAppCreateDto + +`func NewSourceAppCreateDto(name string, description string, accountSource SourceAppCreateDtoAccountSource, ) *SourceAppCreateDto` + +NewSourceAppCreateDto instantiates a new SourceAppCreateDto 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 + +### NewSourceAppCreateDtoWithDefaults + +`func NewSourceAppCreateDtoWithDefaults() *SourceAppCreateDto` + +NewSourceAppCreateDtoWithDefaults instantiates a new SourceAppCreateDto 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 + +### GetName + +`func (o *SourceAppCreateDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAppCreateDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAppCreateDto) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *SourceAppCreateDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SourceAppCreateDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SourceAppCreateDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetMatchAllAccounts + +`func (o *SourceAppCreateDto) GetMatchAllAccounts() bool` + +GetMatchAllAccounts returns the MatchAllAccounts field if non-nil, zero value otherwise. + +### GetMatchAllAccountsOk + +`func (o *SourceAppCreateDto) GetMatchAllAccountsOk() (*bool, bool)` + +GetMatchAllAccountsOk returns a tuple with the MatchAllAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAllAccounts + +`func (o *SourceAppCreateDto) SetMatchAllAccounts(v bool)` + +SetMatchAllAccounts sets MatchAllAccounts field to given value. + +### HasMatchAllAccounts + +`func (o *SourceAppCreateDto) HasMatchAllAccounts() bool` + +HasMatchAllAccounts returns a boolean if a field has been set. + +### GetAccountSource + +`func (o *SourceAppCreateDto) GetAccountSource() SourceAppCreateDtoAccountSource` + +GetAccountSource returns the AccountSource field if non-nil, zero value otherwise. + +### GetAccountSourceOk + +`func (o *SourceAppCreateDto) GetAccountSourceOk() (*SourceAppCreateDtoAccountSource, bool)` + +GetAccountSourceOk returns a tuple with the AccountSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSource + +`func (o *SourceAppCreateDto) SetAccountSource(v SourceAppCreateDtoAccountSource)` + +SetAccountSource sets AccountSource field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceAppCreateDtoAccountSource.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceAppCreateDtoAccountSource.md new file mode 100644 index 000000000..b3e5be83d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceAppCreateDtoAccountSource.md @@ -0,0 +1,111 @@ +--- +id: v2025-source-app-create-dto-account-source +title: SourceAppCreateDtoAccountSource +pagination_label: SourceAppCreateDtoAccountSource +sidebar_label: SourceAppCreateDtoAccountSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAppCreateDtoAccountSource', 'V2025SourceAppCreateDtoAccountSource'] +slug: /tools/sdk/go/v2025/models/source-app-create-dto-account-source +tags: ['SDK', 'Software Development Kit', 'SourceAppCreateDtoAccountSource', 'V2025SourceAppCreateDtoAccountSource'] +--- + +# SourceAppCreateDtoAccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The source ID | +**Type** | Pointer to **string** | The source type, will always be \"SOURCE\" | [optional] +**Name** | Pointer to **string** | The source name | [optional] + +## Methods + +### NewSourceAppCreateDtoAccountSource + +`func NewSourceAppCreateDtoAccountSource(id string, ) *SourceAppCreateDtoAccountSource` + +NewSourceAppCreateDtoAccountSource instantiates a new SourceAppCreateDtoAccountSource 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 + +### NewSourceAppCreateDtoAccountSourceWithDefaults + +`func NewSourceAppCreateDtoAccountSourceWithDefaults() *SourceAppCreateDtoAccountSource` + +NewSourceAppCreateDtoAccountSourceWithDefaults instantiates a new SourceAppCreateDtoAccountSource 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 + +### GetId + +`func (o *SourceAppCreateDtoAccountSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAppCreateDtoAccountSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAppCreateDtoAccountSource) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *SourceAppCreateDtoAccountSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceAppCreateDtoAccountSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceAppCreateDtoAccountSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceAppCreateDtoAccountSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAppCreateDtoAccountSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAppCreateDtoAccountSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAppCreateDtoAccountSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAppCreateDtoAccountSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceAppPatchDto.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceAppPatchDto.md new file mode 100644 index 000000000..5776257db --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceAppPatchDto.md @@ -0,0 +1,406 @@ +--- +id: v2025-source-app-patch-dto +title: SourceAppPatchDto +pagination_label: SourceAppPatchDto +sidebar_label: SourceAppPatchDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAppPatchDto', 'V2025SourceAppPatchDto'] +slug: /tools/sdk/go/v2025/models/source-app-patch-dto +tags: ['SDK', 'Software Development Kit', 'SourceAppPatchDto', 'V2025SourceAppPatchDto'] +--- + +# SourceAppPatchDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The source app id | [optional] +**CloudAppId** | Pointer to **string** | The deprecated source app id | [optional] +**Name** | Pointer to **string** | The source app name | [optional] +**Created** | Pointer to **SailPointTime** | Time when the source app was created | [optional] +**Modified** | Pointer to **SailPointTime** | Time when the source app was last modified | [optional] +**Enabled** | Pointer to **bool** | True if the source app is enabled | [optional] [default to false] +**ProvisionRequestEnabled** | Pointer to **bool** | True if the source app is provision request enabled | [optional] [default to false] +**Description** | Pointer to **string** | The description of the source app | [optional] +**MatchAllAccounts** | Pointer to **bool** | True if the source app match all accounts | [optional] [default to false] +**AppCenterEnabled** | Pointer to **bool** | True if the source app is shown in the app center | [optional] [default to true] +**AccessProfiles** | Pointer to **[]string** | List of IDs of access profiles | [optional] +**AccountSource** | Pointer to [**NullableSourceAppAccountSource**](source-app-account-source) | | [optional] +**Owner** | Pointer to [**NullableBaseReferenceDto**](base-reference-dto) | The owner of source app | [optional] + +## Methods + +### NewSourceAppPatchDto + +`func NewSourceAppPatchDto() *SourceAppPatchDto` + +NewSourceAppPatchDto instantiates a new SourceAppPatchDto 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 + +### NewSourceAppPatchDtoWithDefaults + +`func NewSourceAppPatchDtoWithDefaults() *SourceAppPatchDto` + +NewSourceAppPatchDtoWithDefaults instantiates a new SourceAppPatchDto 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 + +### GetId + +`func (o *SourceAppPatchDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAppPatchDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAppPatchDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceAppPatchDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCloudAppId + +`func (o *SourceAppPatchDto) GetCloudAppId() string` + +GetCloudAppId returns the CloudAppId field if non-nil, zero value otherwise. + +### GetCloudAppIdOk + +`func (o *SourceAppPatchDto) GetCloudAppIdOk() (*string, bool)` + +GetCloudAppIdOk returns a tuple with the CloudAppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudAppId + +`func (o *SourceAppPatchDto) SetCloudAppId(v string)` + +SetCloudAppId sets CloudAppId field to given value. + +### HasCloudAppId + +`func (o *SourceAppPatchDto) HasCloudAppId() bool` + +HasCloudAppId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAppPatchDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAppPatchDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAppPatchDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAppPatchDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *SourceAppPatchDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SourceAppPatchDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SourceAppPatchDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SourceAppPatchDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SourceAppPatchDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SourceAppPatchDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SourceAppPatchDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SourceAppPatchDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetEnabled + +`func (o *SourceAppPatchDto) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *SourceAppPatchDto) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *SourceAppPatchDto) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *SourceAppPatchDto) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetProvisionRequestEnabled + +`func (o *SourceAppPatchDto) GetProvisionRequestEnabled() bool` + +GetProvisionRequestEnabled returns the ProvisionRequestEnabled field if non-nil, zero value otherwise. + +### GetProvisionRequestEnabledOk + +`func (o *SourceAppPatchDto) GetProvisionRequestEnabledOk() (*bool, bool)` + +GetProvisionRequestEnabledOk returns a tuple with the ProvisionRequestEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionRequestEnabled + +`func (o *SourceAppPatchDto) SetProvisionRequestEnabled(v bool)` + +SetProvisionRequestEnabled sets ProvisionRequestEnabled field to given value. + +### HasProvisionRequestEnabled + +`func (o *SourceAppPatchDto) HasProvisionRequestEnabled() bool` + +HasProvisionRequestEnabled returns a boolean if a field has been set. + +### GetDescription + +`func (o *SourceAppPatchDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SourceAppPatchDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SourceAppPatchDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SourceAppPatchDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetMatchAllAccounts + +`func (o *SourceAppPatchDto) GetMatchAllAccounts() bool` + +GetMatchAllAccounts returns the MatchAllAccounts field if non-nil, zero value otherwise. + +### GetMatchAllAccountsOk + +`func (o *SourceAppPatchDto) GetMatchAllAccountsOk() (*bool, bool)` + +GetMatchAllAccountsOk returns a tuple with the MatchAllAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAllAccounts + +`func (o *SourceAppPatchDto) SetMatchAllAccounts(v bool)` + +SetMatchAllAccounts sets MatchAllAccounts field to given value. + +### HasMatchAllAccounts + +`func (o *SourceAppPatchDto) HasMatchAllAccounts() bool` + +HasMatchAllAccounts returns a boolean if a field has been set. + +### GetAppCenterEnabled + +`func (o *SourceAppPatchDto) GetAppCenterEnabled() bool` + +GetAppCenterEnabled returns the AppCenterEnabled field if non-nil, zero value otherwise. + +### GetAppCenterEnabledOk + +`func (o *SourceAppPatchDto) GetAppCenterEnabledOk() (*bool, bool)` + +GetAppCenterEnabledOk returns a tuple with the AppCenterEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppCenterEnabled + +`func (o *SourceAppPatchDto) SetAppCenterEnabled(v bool)` + +SetAppCenterEnabled sets AppCenterEnabled field to given value. + +### HasAppCenterEnabled + +`func (o *SourceAppPatchDto) HasAppCenterEnabled() bool` + +HasAppCenterEnabled returns a boolean if a field has been set. + +### GetAccessProfiles + +`func (o *SourceAppPatchDto) GetAccessProfiles() []string` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *SourceAppPatchDto) GetAccessProfilesOk() (*[]string, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *SourceAppPatchDto) SetAccessProfiles(v []string)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *SourceAppPatchDto) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### SetAccessProfilesNil + +`func (o *SourceAppPatchDto) SetAccessProfilesNil(b bool)` + + SetAccessProfilesNil sets the value for AccessProfiles to be an explicit nil + +### UnsetAccessProfiles +`func (o *SourceAppPatchDto) UnsetAccessProfiles()` + +UnsetAccessProfiles ensures that no value is present for AccessProfiles, not even an explicit nil +### GetAccountSource + +`func (o *SourceAppPatchDto) GetAccountSource() SourceAppAccountSource` + +GetAccountSource returns the AccountSource field if non-nil, zero value otherwise. + +### GetAccountSourceOk + +`func (o *SourceAppPatchDto) GetAccountSourceOk() (*SourceAppAccountSource, bool)` + +GetAccountSourceOk returns a tuple with the AccountSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSource + +`func (o *SourceAppPatchDto) SetAccountSource(v SourceAppAccountSource)` + +SetAccountSource sets AccountSource field to given value. + +### HasAccountSource + +`func (o *SourceAppPatchDto) HasAccountSource() bool` + +HasAccountSource returns a boolean if a field has been set. + +### SetAccountSourceNil + +`func (o *SourceAppPatchDto) SetAccountSourceNil(b bool)` + + SetAccountSourceNil sets the value for AccountSource to be an explicit nil + +### UnsetAccountSource +`func (o *SourceAppPatchDto) UnsetAccountSource()` + +UnsetAccountSource ensures that no value is present for AccountSource, not even an explicit nil +### GetOwner + +`func (o *SourceAppPatchDto) GetOwner() BaseReferenceDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *SourceAppPatchDto) GetOwnerOk() (*BaseReferenceDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *SourceAppPatchDto) SetOwner(v BaseReferenceDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *SourceAppPatchDto) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *SourceAppPatchDto) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *SourceAppPatchDto) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceBeforeProvisioningRule.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceBeforeProvisioningRule.md new file mode 100644 index 000000000..8f6bd219d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceBeforeProvisioningRule.md @@ -0,0 +1,116 @@ +--- +id: v2025-source-before-provisioning-rule +title: SourceBeforeProvisioningRule +pagination_label: SourceBeforeProvisioningRule +sidebar_label: SourceBeforeProvisioningRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceBeforeProvisioningRule', 'V2025SourceBeforeProvisioningRule'] +slug: /tools/sdk/go/v2025/models/source-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'SourceBeforeProvisioningRule', 'V2025SourceBeforeProvisioningRule'] +--- + +# SourceBeforeProvisioningRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Rule ID. | [optional] +**Name** | Pointer to **string** | Rule's human-readable display name. | [optional] + +## Methods + +### NewSourceBeforeProvisioningRule + +`func NewSourceBeforeProvisioningRule() *SourceBeforeProvisioningRule` + +NewSourceBeforeProvisioningRule instantiates a new SourceBeforeProvisioningRule 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 + +### NewSourceBeforeProvisioningRuleWithDefaults + +`func NewSourceBeforeProvisioningRuleWithDefaults() *SourceBeforeProvisioningRule` + +NewSourceBeforeProvisioningRuleWithDefaults instantiates a new SourceBeforeProvisioningRule 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 + +### GetType + +`func (o *SourceBeforeProvisioningRule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceBeforeProvisioningRule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceBeforeProvisioningRule) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceBeforeProvisioningRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceBeforeProvisioningRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceBeforeProvisioningRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceBeforeProvisioningRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceBeforeProvisioningRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceBeforeProvisioningRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceBeforeProvisioningRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceBeforeProvisioningRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceBeforeProvisioningRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceCluster.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceCluster.md new file mode 100644 index 000000000..19d2cd9cf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceCluster.md @@ -0,0 +1,101 @@ +--- +id: v2025-source-cluster +title: SourceCluster +pagination_label: SourceCluster +sidebar_label: SourceCluster +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceCluster', 'V2025SourceCluster'] +slug: /tools/sdk/go/v2025/models/source-cluster +tags: ['SDK', 'Software Development Kit', 'SourceCluster', 'V2025SourceCluster'] +--- + +# SourceCluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of object being referenced. | +**Id** | **string** | Cluster ID. | +**Name** | **string** | Cluster's human-readable display name. | + +## Methods + +### NewSourceCluster + +`func NewSourceCluster(type_ string, id string, name string, ) *SourceCluster` + +NewSourceCluster instantiates a new SourceCluster 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 + +### NewSourceClusterWithDefaults + +`func NewSourceClusterWithDefaults() *SourceCluster` + +NewSourceClusterWithDefaults instantiates a new SourceCluster 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 + +### GetType + +`func (o *SourceCluster) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceCluster) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceCluster) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *SourceCluster) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceCluster) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceCluster) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceCluster) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceCluster) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceCluster) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceClusterDto.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceClusterDto.md new file mode 100644 index 000000000..0bf6905e3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceClusterDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-source-cluster-dto +title: SourceClusterDto +pagination_label: SourceClusterDto +sidebar_label: SourceClusterDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceClusterDto', 'V2025SourceClusterDto'] +slug: /tools/sdk/go/v2025/models/source-cluster-dto +tags: ['SDK', 'Software Development Kit', 'SourceClusterDto', 'V2025SourceClusterDto'] +--- + +# SourceClusterDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Source cluster DTO type. | [optional] +**Id** | Pointer to **string** | Source cluster ID. | [optional] +**Name** | Pointer to **string** | Source cluster display name. | [optional] + +## Methods + +### NewSourceClusterDto + +`func NewSourceClusterDto() *SourceClusterDto` + +NewSourceClusterDto instantiates a new SourceClusterDto 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 + +### NewSourceClusterDtoWithDefaults + +`func NewSourceClusterDtoWithDefaults() *SourceClusterDto` + +NewSourceClusterDtoWithDefaults instantiates a new SourceClusterDto 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 + +### GetType + +`func (o *SourceClusterDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceClusterDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceClusterDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceClusterDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceClusterDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceClusterDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceClusterDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceClusterDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceClusterDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceClusterDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceClusterDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceClusterDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceCode.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceCode.md new file mode 100644 index 000000000..ee4d4e032 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceCode.md @@ -0,0 +1,80 @@ +--- +id: v2025-source-code +title: SourceCode +pagination_label: SourceCode +sidebar_label: SourceCode +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceCode', 'V2025SourceCode'] +slug: /tools/sdk/go/v2025/models/source-code +tags: ['SDK', 'Software Development Kit', 'SourceCode', 'V2025SourceCode'] +--- + +# SourceCode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | **string** | the version of the code | +**Script** | **string** | The code | + +## Methods + +### NewSourceCode + +`func NewSourceCode(version string, script string, ) *SourceCode` + +NewSourceCode instantiates a new SourceCode 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 + +### NewSourceCodeWithDefaults + +`func NewSourceCodeWithDefaults() *SourceCode` + +NewSourceCodeWithDefaults instantiates a new SourceCode 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 + +### GetVersion + +`func (o *SourceCode) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *SourceCode) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *SourceCode) SetVersion(v string)` + +SetVersion sets Version field to given value. + + +### GetScript + +`func (o *SourceCode) GetScript() string` + +GetScript returns the Script field if non-nil, zero value otherwise. + +### GetScriptOk + +`func (o *SourceCode) GetScriptOk() (*string, bool)` + +GetScriptOk returns a tuple with the Script field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScript + +`func (o *SourceCode) SetScript(v string)` + +SetScript sets Script field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceConnectionsDto.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceConnectionsDto.md new file mode 100644 index 000000000..87966a7b9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceConnectionsDto.md @@ -0,0 +1,220 @@ +--- +id: v2025-source-connections-dto +title: SourceConnectionsDto +pagination_label: SourceConnectionsDto +sidebar_label: SourceConnectionsDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceConnectionsDto', 'V2025SourceConnectionsDto'] +slug: /tools/sdk/go/v2025/models/source-connections-dto +tags: ['SDK', 'Software Development Kit', 'SourceConnectionsDto', 'V2025SourceConnectionsDto'] +--- + +# SourceConnectionsDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityProfiles** | Pointer to [**[]IdentityProfilesConnections**](identity-profiles-connections) | The IdentityProfile attached to this source | [optional] +**CredentialProfiles** | Pointer to **[]string** | Name of the CredentialProfile attached to this source | [optional] +**SourceAttributes** | Pointer to **[]string** | The attributes attached to this source | [optional] +**MappingProfiles** | Pointer to **[]string** | The profiles attached to this source | [optional] +**DependentCustomTransforms** | Pointer to [**[]TransformRead**](transform-read) | A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName. | [optional] +**DependentApps** | Pointer to [**[]DependantAppConnections**](dependant-app-connections) | | [optional] +**MissingDependents** | Pointer to [**[]DependantConnectionsMissingDto**](dependant-connections-missing-dto) | | [optional] + +## Methods + +### NewSourceConnectionsDto + +`func NewSourceConnectionsDto() *SourceConnectionsDto` + +NewSourceConnectionsDto instantiates a new SourceConnectionsDto 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 + +### NewSourceConnectionsDtoWithDefaults + +`func NewSourceConnectionsDtoWithDefaults() *SourceConnectionsDto` + +NewSourceConnectionsDtoWithDefaults instantiates a new SourceConnectionsDto 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 + +### GetIdentityProfiles + +`func (o *SourceConnectionsDto) GetIdentityProfiles() []IdentityProfilesConnections` + +GetIdentityProfiles returns the IdentityProfiles field if non-nil, zero value otherwise. + +### GetIdentityProfilesOk + +`func (o *SourceConnectionsDto) GetIdentityProfilesOk() (*[]IdentityProfilesConnections, bool)` + +GetIdentityProfilesOk returns a tuple with the IdentityProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityProfiles + +`func (o *SourceConnectionsDto) SetIdentityProfiles(v []IdentityProfilesConnections)` + +SetIdentityProfiles sets IdentityProfiles field to given value. + +### HasIdentityProfiles + +`func (o *SourceConnectionsDto) HasIdentityProfiles() bool` + +HasIdentityProfiles returns a boolean if a field has been set. + +### GetCredentialProfiles + +`func (o *SourceConnectionsDto) GetCredentialProfiles() []string` + +GetCredentialProfiles returns the CredentialProfiles field if non-nil, zero value otherwise. + +### GetCredentialProfilesOk + +`func (o *SourceConnectionsDto) GetCredentialProfilesOk() (*[]string, bool)` + +GetCredentialProfilesOk returns a tuple with the CredentialProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialProfiles + +`func (o *SourceConnectionsDto) SetCredentialProfiles(v []string)` + +SetCredentialProfiles sets CredentialProfiles field to given value. + +### HasCredentialProfiles + +`func (o *SourceConnectionsDto) HasCredentialProfiles() bool` + +HasCredentialProfiles returns a boolean if a field has been set. + +### GetSourceAttributes + +`func (o *SourceConnectionsDto) GetSourceAttributes() []string` + +GetSourceAttributes returns the SourceAttributes field if non-nil, zero value otherwise. + +### GetSourceAttributesOk + +`func (o *SourceConnectionsDto) GetSourceAttributesOk() (*[]string, bool)` + +GetSourceAttributesOk returns a tuple with the SourceAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceAttributes + +`func (o *SourceConnectionsDto) SetSourceAttributes(v []string)` + +SetSourceAttributes sets SourceAttributes field to given value. + +### HasSourceAttributes + +`func (o *SourceConnectionsDto) HasSourceAttributes() bool` + +HasSourceAttributes returns a boolean if a field has been set. + +### GetMappingProfiles + +`func (o *SourceConnectionsDto) GetMappingProfiles() []string` + +GetMappingProfiles returns the MappingProfiles field if non-nil, zero value otherwise. + +### GetMappingProfilesOk + +`func (o *SourceConnectionsDto) GetMappingProfilesOk() (*[]string, bool)` + +GetMappingProfilesOk returns a tuple with the MappingProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMappingProfiles + +`func (o *SourceConnectionsDto) SetMappingProfiles(v []string)` + +SetMappingProfiles sets MappingProfiles field to given value. + +### HasMappingProfiles + +`func (o *SourceConnectionsDto) HasMappingProfiles() bool` + +HasMappingProfiles returns a boolean if a field has been set. + +### GetDependentCustomTransforms + +`func (o *SourceConnectionsDto) GetDependentCustomTransforms() []TransformRead` + +GetDependentCustomTransforms returns the DependentCustomTransforms field if non-nil, zero value otherwise. + +### GetDependentCustomTransformsOk + +`func (o *SourceConnectionsDto) GetDependentCustomTransformsOk() (*[]TransformRead, bool)` + +GetDependentCustomTransformsOk returns a tuple with the DependentCustomTransforms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDependentCustomTransforms + +`func (o *SourceConnectionsDto) SetDependentCustomTransforms(v []TransformRead)` + +SetDependentCustomTransforms sets DependentCustomTransforms field to given value. + +### HasDependentCustomTransforms + +`func (o *SourceConnectionsDto) HasDependentCustomTransforms() bool` + +HasDependentCustomTransforms returns a boolean if a field has been set. + +### GetDependentApps + +`func (o *SourceConnectionsDto) GetDependentApps() []DependantAppConnections` + +GetDependentApps returns the DependentApps field if non-nil, zero value otherwise. + +### GetDependentAppsOk + +`func (o *SourceConnectionsDto) GetDependentAppsOk() (*[]DependantAppConnections, bool)` + +GetDependentAppsOk returns a tuple with the DependentApps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDependentApps + +`func (o *SourceConnectionsDto) SetDependentApps(v []DependantAppConnections)` + +SetDependentApps sets DependentApps field to given value. + +### HasDependentApps + +`func (o *SourceConnectionsDto) HasDependentApps() bool` + +HasDependentApps returns a boolean if a field has been set. + +### GetMissingDependents + +`func (o *SourceConnectionsDto) GetMissingDependents() []DependantConnectionsMissingDto` + +GetMissingDependents returns the MissingDependents field if non-nil, zero value otherwise. + +### GetMissingDependentsOk + +`func (o *SourceConnectionsDto) GetMissingDependentsOk() (*[]DependantConnectionsMissingDto, bool)` + +GetMissingDependentsOk returns a tuple with the MissingDependents field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMissingDependents + +`func (o *SourceConnectionsDto) SetMissingDependents(v []DependantConnectionsMissingDto)` + +SetMissingDependents sets MissingDependents field to given value. + +### HasMissingDependents + +`func (o *SourceConnectionsDto) HasMissingDependents() bool` + +HasMissingDependents returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceCreated.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceCreated.md new file mode 100644 index 000000000..d57590a9b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceCreated.md @@ -0,0 +1,164 @@ +--- +id: v2025-source-created +title: SourceCreated +pagination_label: SourceCreated +sidebar_label: SourceCreated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceCreated', 'V2025SourceCreated'] +slug: /tools/sdk/go/v2025/models/source-created +tags: ['SDK', 'Software Development Kit', 'SourceCreated', 'V2025SourceCreated'] +--- + +# SourceCreated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the source. | +**Name** | **string** | Human friendly name of the source. | +**Type** | **string** | The connection type. | +**Created** | **SailPointTime** | The date and time the source was created. | +**Connector** | **string** | The connector type used to connect to the source. | +**Actor** | [**SourceCreatedActor**](source-created-actor) | | + +## Methods + +### NewSourceCreated + +`func NewSourceCreated(id string, name string, type_ string, created SailPointTime, connector string, actor SourceCreatedActor, ) *SourceCreated` + +NewSourceCreated instantiates a new SourceCreated 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 + +### NewSourceCreatedWithDefaults + +`func NewSourceCreatedWithDefaults() *SourceCreated` + +NewSourceCreatedWithDefaults instantiates a new SourceCreated 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 + +### GetId + +`func (o *SourceCreated) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceCreated) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceCreated) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceCreated) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceCreated) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceCreated) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *SourceCreated) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceCreated) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceCreated) SetType(v string)` + +SetType sets Type field to given value. + + +### GetCreated + +`func (o *SourceCreated) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SourceCreated) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SourceCreated) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetConnector + +`func (o *SourceCreated) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *SourceCreated) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *SourceCreated) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetActor + +`func (o *SourceCreated) GetActor() SourceCreatedActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *SourceCreated) GetActorOk() (*SourceCreatedActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *SourceCreated) SetActor(v SourceCreatedActor)` + +SetActor sets Actor field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceCreatedActor.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceCreatedActor.md new file mode 100644 index 000000000..a3861cacf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceCreatedActor.md @@ -0,0 +1,101 @@ +--- +id: v2025-source-created-actor +title: SourceCreatedActor +pagination_label: SourceCreatedActor +sidebar_label: SourceCreatedActor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceCreatedActor', 'V2025SourceCreatedActor'] +slug: /tools/sdk/go/v2025/models/source-created-actor +tags: ['SDK', 'Software Development Kit', 'SourceCreatedActor', 'V2025SourceCreatedActor'] +--- + +# SourceCreatedActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of identity who created the source. | +**Id** | **string** | ID of identity who created the source. | +**Name** | **string** | Display name of identity who created the source. | + +## Methods + +### NewSourceCreatedActor + +`func NewSourceCreatedActor(type_ string, id string, name string, ) *SourceCreatedActor` + +NewSourceCreatedActor instantiates a new SourceCreatedActor 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 + +### NewSourceCreatedActorWithDefaults + +`func NewSourceCreatedActorWithDefaults() *SourceCreatedActor` + +NewSourceCreatedActorWithDefaults instantiates a new SourceCreatedActor 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 + +### GetType + +`func (o *SourceCreatedActor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceCreatedActor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceCreatedActor) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *SourceCreatedActor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceCreatedActor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceCreatedActor) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceCreatedActor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceCreatedActor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceCreatedActor) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceCreationErrors.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceCreationErrors.md new file mode 100644 index 000000000..6644d89d9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceCreationErrors.md @@ -0,0 +1,204 @@ +--- +id: v2025-source-creation-errors +title: SourceCreationErrors +pagination_label: SourceCreationErrors +sidebar_label: SourceCreationErrors +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceCreationErrors', 'V2025SourceCreationErrors'] +slug: /tools/sdk/go/v2025/models/source-creation-errors +tags: ['SDK', 'Software Development Kit', 'SourceCreationErrors', 'V2025SourceCreationErrors'] +--- + +# SourceCreationErrors + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MultihostId** | Pointer to **string** | Multi-Host Integration ID. | [optional] [readonly] +**SourceName** | Pointer to **string** | Source's human-readable name. | [optional] +**SourceError** | Pointer to **string** | Source's human-readable description. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date-time when the source was last modified. | [optional] +**Operation** | Pointer to **NullableString** | operation category (e.g. DELETE). | [optional] + +## Methods + +### NewSourceCreationErrors + +`func NewSourceCreationErrors() *SourceCreationErrors` + +NewSourceCreationErrors instantiates a new SourceCreationErrors 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 + +### NewSourceCreationErrorsWithDefaults + +`func NewSourceCreationErrorsWithDefaults() *SourceCreationErrors` + +NewSourceCreationErrorsWithDefaults instantiates a new SourceCreationErrors 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 + +### GetMultihostId + +`func (o *SourceCreationErrors) GetMultihostId() string` + +GetMultihostId returns the MultihostId field if non-nil, zero value otherwise. + +### GetMultihostIdOk + +`func (o *SourceCreationErrors) GetMultihostIdOk() (*string, bool)` + +GetMultihostIdOk returns a tuple with the MultihostId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultihostId + +`func (o *SourceCreationErrors) SetMultihostId(v string)` + +SetMultihostId sets MultihostId field to given value. + +### HasMultihostId + +`func (o *SourceCreationErrors) HasMultihostId() bool` + +HasMultihostId returns a boolean if a field has been set. + +### GetSourceName + +`func (o *SourceCreationErrors) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *SourceCreationErrors) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *SourceCreationErrors) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *SourceCreationErrors) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceError + +`func (o *SourceCreationErrors) GetSourceError() string` + +GetSourceError returns the SourceError field if non-nil, zero value otherwise. + +### GetSourceErrorOk + +`func (o *SourceCreationErrors) GetSourceErrorOk() (*string, bool)` + +GetSourceErrorOk returns a tuple with the SourceError field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceError + +`func (o *SourceCreationErrors) SetSourceError(v string)` + +SetSourceError sets SourceError field to given value. + +### HasSourceError + +`func (o *SourceCreationErrors) HasSourceError() bool` + +HasSourceError returns a boolean if a field has been set. + +### GetCreated + +`func (o *SourceCreationErrors) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SourceCreationErrors) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SourceCreationErrors) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SourceCreationErrors) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SourceCreationErrors) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SourceCreationErrors) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SourceCreationErrors) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SourceCreationErrors) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetOperation + +`func (o *SourceCreationErrors) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *SourceCreationErrors) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *SourceCreationErrors) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *SourceCreationErrors) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### SetOperationNil + +`func (o *SourceCreationErrors) SetOperationNil(b bool)` + + SetOperationNil sets the value for Operation to be an explicit nil + +### UnsetOperation +`func (o *SourceCreationErrors) UnsetOperation()` + +UnsetOperation ensures that no value is present for Operation, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceDeleted.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceDeleted.md new file mode 100644 index 000000000..3af27a1fd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceDeleted.md @@ -0,0 +1,164 @@ +--- +id: v2025-source-deleted +title: SourceDeleted +pagination_label: SourceDeleted +sidebar_label: SourceDeleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceDeleted', 'V2025SourceDeleted'] +slug: /tools/sdk/go/v2025/models/source-deleted +tags: ['SDK', 'Software Development Kit', 'SourceDeleted', 'V2025SourceDeleted'] +--- + +# SourceDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the source. | +**Name** | **string** | Human friendly name of the source. | +**Type** | **string** | The connection type. | +**Deleted** | **SailPointTime** | The date and time the source was deleted. | +**Connector** | **string** | The connector type used to connect to the source. | +**Actor** | [**SourceDeletedActor**](source-deleted-actor) | | + +## Methods + +### NewSourceDeleted + +`func NewSourceDeleted(id string, name string, type_ string, deleted SailPointTime, connector string, actor SourceDeletedActor, ) *SourceDeleted` + +NewSourceDeleted instantiates a new SourceDeleted 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 + +### NewSourceDeletedWithDefaults + +`func NewSourceDeletedWithDefaults() *SourceDeleted` + +NewSourceDeletedWithDefaults instantiates a new SourceDeleted 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 + +### GetId + +`func (o *SourceDeleted) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceDeleted) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceDeleted) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceDeleted) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceDeleted) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceDeleted) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *SourceDeleted) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceDeleted) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceDeleted) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDeleted + +`func (o *SourceDeleted) GetDeleted() SailPointTime` + +GetDeleted returns the Deleted field if non-nil, zero value otherwise. + +### GetDeletedOk + +`func (o *SourceDeleted) GetDeletedOk() (*SailPointTime, bool)` + +GetDeletedOk returns a tuple with the Deleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleted + +`func (o *SourceDeleted) SetDeleted(v SailPointTime)` + +SetDeleted sets Deleted field to given value. + + +### GetConnector + +`func (o *SourceDeleted) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *SourceDeleted) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *SourceDeleted) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetActor + +`func (o *SourceDeleted) GetActor() SourceDeletedActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *SourceDeleted) GetActorOk() (*SourceDeletedActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *SourceDeleted) SetActor(v SourceDeletedActor)` + +SetActor sets Actor field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceDeletedActor.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceDeletedActor.md new file mode 100644 index 000000000..3f77cf494 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceDeletedActor.md @@ -0,0 +1,101 @@ +--- +id: v2025-source-deleted-actor +title: SourceDeletedActor +pagination_label: SourceDeletedActor +sidebar_label: SourceDeletedActor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceDeletedActor', 'V2025SourceDeletedActor'] +slug: /tools/sdk/go/v2025/models/source-deleted-actor +tags: ['SDK', 'Software Development Kit', 'SourceDeletedActor', 'V2025SourceDeletedActor'] +--- + +# SourceDeletedActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of identity who deleted the source. | +**Id** | **string** | ID of identity who deleted the source. | +**Name** | **string** | Display name of identity who deleted the source. | + +## Methods + +### NewSourceDeletedActor + +`func NewSourceDeletedActor(type_ string, id string, name string, ) *SourceDeletedActor` + +NewSourceDeletedActor instantiates a new SourceDeletedActor 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 + +### NewSourceDeletedActorWithDefaults + +`func NewSourceDeletedActorWithDefaults() *SourceDeletedActor` + +NewSourceDeletedActorWithDefaults instantiates a new SourceDeletedActor 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 + +### GetType + +`func (o *SourceDeletedActor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceDeletedActor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceDeletedActor) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *SourceDeletedActor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceDeletedActor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceDeletedActor) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceDeletedActor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceDeletedActor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceDeletedActor) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceEntitlementRequestConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceEntitlementRequestConfig.md new file mode 100644 index 000000000..de0f01546 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceEntitlementRequestConfig.md @@ -0,0 +1,64 @@ +--- +id: v2025-source-entitlement-request-config +title: SourceEntitlementRequestConfig +pagination_label: SourceEntitlementRequestConfig +sidebar_label: SourceEntitlementRequestConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceEntitlementRequestConfig', 'V2025SourceEntitlementRequestConfig'] +slug: /tools/sdk/go/v2025/models/source-entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'SourceEntitlementRequestConfig', 'V2025SourceEntitlementRequestConfig'] +--- + +# SourceEntitlementRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestConfig** | Pointer to [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] + +## Methods + +### NewSourceEntitlementRequestConfig + +`func NewSourceEntitlementRequestConfig() *SourceEntitlementRequestConfig` + +NewSourceEntitlementRequestConfig instantiates a new SourceEntitlementRequestConfig 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 + +### NewSourceEntitlementRequestConfigWithDefaults + +`func NewSourceEntitlementRequestConfigWithDefaults() *SourceEntitlementRequestConfig` + +NewSourceEntitlementRequestConfigWithDefaults instantiates a new SourceEntitlementRequestConfig 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 + +### GetAccessRequestConfig + +`func (o *SourceEntitlementRequestConfig) GetAccessRequestConfig() EntitlementAccessRequestConfig` + +GetAccessRequestConfig returns the AccessRequestConfig field if non-nil, zero value otherwise. + +### GetAccessRequestConfigOk + +`func (o *SourceEntitlementRequestConfig) GetAccessRequestConfigOk() (*EntitlementAccessRequestConfig, bool)` + +GetAccessRequestConfigOk returns a tuple with the AccessRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestConfig + +`func (o *SourceEntitlementRequestConfig) SetAccessRequestConfig(v EntitlementAccessRequestConfig)` + +SetAccessRequestConfig sets AccessRequestConfig field to given value. + +### HasAccessRequestConfig + +`func (o *SourceEntitlementRequestConfig) HasAccessRequestConfig() bool` + +HasAccessRequestConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceHealthDto.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceHealthDto.md new file mode 100644 index 000000000..a6955382b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceHealthDto.md @@ -0,0 +1,308 @@ +--- +id: v2025-source-health-dto +title: SourceHealthDto +pagination_label: SourceHealthDto +sidebar_label: SourceHealthDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceHealthDto', 'V2025SourceHealthDto'] +slug: /tools/sdk/go/v2025/models/source-health-dto +tags: ['SDK', 'Software Development Kit', 'SourceHealthDto', 'V2025SourceHealthDto'] +--- + +# SourceHealthDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the id of the Source | [optional] [readonly] +**Type** | Pointer to **string** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Name** | Pointer to **string** | the name of the source | [optional] +**Org** | Pointer to **string** | source's org | [optional] +**IsAuthoritative** | Pointer to **bool** | Is the source authoritative | [optional] +**IsCluster** | Pointer to **bool** | Is the source in a cluster | [optional] +**Hostname** | Pointer to **string** | source's hostname | [optional] +**Pod** | Pointer to **string** | source's pod | [optional] +**IqServiceVersion** | Pointer to **NullableString** | The version of the iqService | [optional] +**Status** | Pointer to **string** | connection test result | [optional] + +## Methods + +### NewSourceHealthDto + +`func NewSourceHealthDto() *SourceHealthDto` + +NewSourceHealthDto instantiates a new SourceHealthDto 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 + +### NewSourceHealthDtoWithDefaults + +`func NewSourceHealthDtoWithDefaults() *SourceHealthDto` + +NewSourceHealthDtoWithDefaults instantiates a new SourceHealthDto 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 + +### GetId + +`func (o *SourceHealthDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceHealthDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceHealthDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceHealthDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *SourceHealthDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceHealthDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceHealthDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceHealthDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *SourceHealthDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceHealthDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceHealthDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceHealthDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOrg + +`func (o *SourceHealthDto) GetOrg() string` + +GetOrg returns the Org field if non-nil, zero value otherwise. + +### GetOrgOk + +`func (o *SourceHealthDto) GetOrgOk() (*string, bool)` + +GetOrgOk returns a tuple with the Org field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrg + +`func (o *SourceHealthDto) SetOrg(v string)` + +SetOrg sets Org field to given value. + +### HasOrg + +`func (o *SourceHealthDto) HasOrg() bool` + +HasOrg returns a boolean if a field has been set. + +### GetIsAuthoritative + +`func (o *SourceHealthDto) GetIsAuthoritative() bool` + +GetIsAuthoritative returns the IsAuthoritative field if non-nil, zero value otherwise. + +### GetIsAuthoritativeOk + +`func (o *SourceHealthDto) GetIsAuthoritativeOk() (*bool, bool)` + +GetIsAuthoritativeOk returns a tuple with the IsAuthoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsAuthoritative + +`func (o *SourceHealthDto) SetIsAuthoritative(v bool)` + +SetIsAuthoritative sets IsAuthoritative field to given value. + +### HasIsAuthoritative + +`func (o *SourceHealthDto) HasIsAuthoritative() bool` + +HasIsAuthoritative returns a boolean if a field has been set. + +### GetIsCluster + +`func (o *SourceHealthDto) GetIsCluster() bool` + +GetIsCluster returns the IsCluster field if non-nil, zero value otherwise. + +### GetIsClusterOk + +`func (o *SourceHealthDto) GetIsClusterOk() (*bool, bool)` + +GetIsClusterOk returns a tuple with the IsCluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsCluster + +`func (o *SourceHealthDto) SetIsCluster(v bool)` + +SetIsCluster sets IsCluster field to given value. + +### HasIsCluster + +`func (o *SourceHealthDto) HasIsCluster() bool` + +HasIsCluster returns a boolean if a field has been set. + +### GetHostname + +`func (o *SourceHealthDto) GetHostname() string` + +GetHostname returns the Hostname field if non-nil, zero value otherwise. + +### GetHostnameOk + +`func (o *SourceHealthDto) GetHostnameOk() (*string, bool)` + +GetHostnameOk returns a tuple with the Hostname field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostname + +`func (o *SourceHealthDto) SetHostname(v string)` + +SetHostname sets Hostname field to given value. + +### HasHostname + +`func (o *SourceHealthDto) HasHostname() bool` + +HasHostname returns a boolean if a field has been set. + +### GetPod + +`func (o *SourceHealthDto) GetPod() string` + +GetPod returns the Pod field if non-nil, zero value otherwise. + +### GetPodOk + +`func (o *SourceHealthDto) GetPodOk() (*string, bool)` + +GetPodOk returns a tuple with the Pod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPod + +`func (o *SourceHealthDto) SetPod(v string)` + +SetPod sets Pod field to given value. + +### HasPod + +`func (o *SourceHealthDto) HasPod() bool` + +HasPod returns a boolean if a field has been set. + +### GetIqServiceVersion + +`func (o *SourceHealthDto) GetIqServiceVersion() string` + +GetIqServiceVersion returns the IqServiceVersion field if non-nil, zero value otherwise. + +### GetIqServiceVersionOk + +`func (o *SourceHealthDto) GetIqServiceVersionOk() (*string, bool)` + +GetIqServiceVersionOk returns a tuple with the IqServiceVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIqServiceVersion + +`func (o *SourceHealthDto) SetIqServiceVersion(v string)` + +SetIqServiceVersion sets IqServiceVersion field to given value. + +### HasIqServiceVersion + +`func (o *SourceHealthDto) HasIqServiceVersion() bool` + +HasIqServiceVersion returns a boolean if a field has been set. + +### SetIqServiceVersionNil + +`func (o *SourceHealthDto) SetIqServiceVersionNil(b bool)` + + SetIqServiceVersionNil sets the value for IqServiceVersion to be an explicit nil + +### UnsetIqServiceVersion +`func (o *SourceHealthDto) UnsetIqServiceVersion()` + +UnsetIqServiceVersion ensures that no value is present for IqServiceVersion, not even an explicit nil +### GetStatus + +`func (o *SourceHealthDto) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SourceHealthDto) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SourceHealthDto) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SourceHealthDto) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceItemRef.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceItemRef.md new file mode 100644 index 000000000..7226a5a7b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceItemRef.md @@ -0,0 +1,110 @@ +--- +id: v2025-source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceItemRef', 'V2025SourceItemRef'] +slug: /tools/sdk/go/v2025/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'V2025SourceItemRef'] +--- + +# SourceItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | Pointer to **NullableString** | The id for the source on which account selections are made | [optional] +**Accounts** | Pointer to [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] + +## Methods + +### NewSourceItemRef + +`func NewSourceItemRef() *SourceItemRef` + +NewSourceItemRef instantiates a new SourceItemRef 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 + +### NewSourceItemRefWithDefaults + +`func NewSourceItemRefWithDefaults() *SourceItemRef` + +NewSourceItemRefWithDefaults instantiates a new SourceItemRef 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 + +### GetSourceId + +`func (o *SourceItemRef) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *SourceItemRef) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *SourceItemRef) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *SourceItemRef) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### SetSourceIdNil + +`func (o *SourceItemRef) SetSourceIdNil(b bool)` + + SetSourceIdNil sets the value for SourceId to be an explicit nil + +### UnsetSourceId +`func (o *SourceItemRef) UnsetSourceId()` + +UnsetSourceId ensures that no value is present for SourceId, not even an explicit nil +### GetAccounts + +`func (o *SourceItemRef) GetAccounts() []AccountItemRef` + +GetAccounts returns the Accounts field if non-nil, zero value otherwise. + +### GetAccountsOk + +`func (o *SourceItemRef) GetAccountsOk() (*[]AccountItemRef, bool)` + +GetAccountsOk returns a tuple with the Accounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccounts + +`func (o *SourceItemRef) SetAccounts(v []AccountItemRef)` + +SetAccounts sets Accounts field to given value. + +### HasAccounts + +`func (o *SourceItemRef) HasAccounts() bool` + +HasAccounts returns a boolean if a field has been set. + +### SetAccountsNil + +`func (o *SourceItemRef) SetAccountsNil(b bool)` + + SetAccountsNil sets the value for Accounts to be an explicit nil + +### UnsetAccounts +`func (o *SourceItemRef) UnsetAccounts()` + +UnsetAccounts ensures that no value is present for Accounts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceManagementWorkgroup.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceManagementWorkgroup.md new file mode 100644 index 000000000..865dfd3c8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceManagementWorkgroup.md @@ -0,0 +1,116 @@ +--- +id: v2025-source-management-workgroup +title: SourceManagementWorkgroup +pagination_label: SourceManagementWorkgroup +sidebar_label: SourceManagementWorkgroup +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceManagementWorkgroup', 'V2025SourceManagementWorkgroup'] +slug: /tools/sdk/go/v2025/models/source-management-workgroup +tags: ['SDK', 'Software Development Kit', 'SourceManagementWorkgroup', 'V2025SourceManagementWorkgroup'] +--- + +# SourceManagementWorkgroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Management workgroup ID. | [optional] +**Name** | Pointer to **string** | Management workgroup's human-readable display name. | [optional] + +## Methods + +### NewSourceManagementWorkgroup + +`func NewSourceManagementWorkgroup() *SourceManagementWorkgroup` + +NewSourceManagementWorkgroup instantiates a new SourceManagementWorkgroup 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 + +### NewSourceManagementWorkgroupWithDefaults + +`func NewSourceManagementWorkgroupWithDefaults() *SourceManagementWorkgroup` + +NewSourceManagementWorkgroupWithDefaults instantiates a new SourceManagementWorkgroup 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 + +### GetType + +`func (o *SourceManagementWorkgroup) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceManagementWorkgroup) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceManagementWorkgroup) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceManagementWorkgroup) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceManagementWorkgroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceManagementWorkgroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceManagementWorkgroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceManagementWorkgroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceManagementWorkgroup) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceManagementWorkgroup) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceManagementWorkgroup) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceManagementWorkgroup) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceManagerCorrelationMapping.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceManagerCorrelationMapping.md new file mode 100644 index 000000000..6aca69f72 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceManagerCorrelationMapping.md @@ -0,0 +1,90 @@ +--- +id: v2025-source-manager-correlation-mapping +title: SourceManagerCorrelationMapping +pagination_label: SourceManagerCorrelationMapping +sidebar_label: SourceManagerCorrelationMapping +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceManagerCorrelationMapping', 'V2025SourceManagerCorrelationMapping'] +slug: /tools/sdk/go/v2025/models/source-manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationMapping', 'V2025SourceManagerCorrelationMapping'] +--- + +# SourceManagerCorrelationMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountAttributeName** | Pointer to **string** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**IdentityAttributeName** | Pointer to **string** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] + +## Methods + +### NewSourceManagerCorrelationMapping + +`func NewSourceManagerCorrelationMapping() *SourceManagerCorrelationMapping` + +NewSourceManagerCorrelationMapping instantiates a new SourceManagerCorrelationMapping 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 + +### NewSourceManagerCorrelationMappingWithDefaults + +`func NewSourceManagerCorrelationMappingWithDefaults() *SourceManagerCorrelationMapping` + +NewSourceManagerCorrelationMappingWithDefaults instantiates a new SourceManagerCorrelationMapping 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 + +### GetAccountAttributeName + +`func (o *SourceManagerCorrelationMapping) GetAccountAttributeName() string` + +GetAccountAttributeName returns the AccountAttributeName field if non-nil, zero value otherwise. + +### GetAccountAttributeNameOk + +`func (o *SourceManagerCorrelationMapping) GetAccountAttributeNameOk() (*string, bool)` + +GetAccountAttributeNameOk returns a tuple with the AccountAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountAttributeName + +`func (o *SourceManagerCorrelationMapping) SetAccountAttributeName(v string)` + +SetAccountAttributeName sets AccountAttributeName field to given value. + +### HasAccountAttributeName + +`func (o *SourceManagerCorrelationMapping) HasAccountAttributeName() bool` + +HasAccountAttributeName returns a boolean if a field has been set. + +### GetIdentityAttributeName + +`func (o *SourceManagerCorrelationMapping) GetIdentityAttributeName() string` + +GetIdentityAttributeName returns the IdentityAttributeName field if non-nil, zero value otherwise. + +### GetIdentityAttributeNameOk + +`func (o *SourceManagerCorrelationMapping) GetIdentityAttributeNameOk() (*string, bool)` + +GetIdentityAttributeNameOk returns a tuple with the IdentityAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeName + +`func (o *SourceManagerCorrelationMapping) SetIdentityAttributeName(v string)` + +SetIdentityAttributeName sets IdentityAttributeName field to given value. + +### HasIdentityAttributeName + +`func (o *SourceManagerCorrelationMapping) HasIdentityAttributeName() bool` + +HasIdentityAttributeName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceManagerCorrelationRule.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceManagerCorrelationRule.md new file mode 100644 index 000000000..def425220 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceManagerCorrelationRule.md @@ -0,0 +1,116 @@ +--- +id: v2025-source-manager-correlation-rule +title: SourceManagerCorrelationRule +pagination_label: SourceManagerCorrelationRule +sidebar_label: SourceManagerCorrelationRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceManagerCorrelationRule', 'V2025SourceManagerCorrelationRule'] +slug: /tools/sdk/go/v2025/models/source-manager-correlation-rule +tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationRule', 'V2025SourceManagerCorrelationRule'] +--- + +# SourceManagerCorrelationRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Rule ID. | [optional] +**Name** | Pointer to **string** | Rule's human-readable display name. | [optional] + +## Methods + +### NewSourceManagerCorrelationRule + +`func NewSourceManagerCorrelationRule() *SourceManagerCorrelationRule` + +NewSourceManagerCorrelationRule instantiates a new SourceManagerCorrelationRule 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 + +### NewSourceManagerCorrelationRuleWithDefaults + +`func NewSourceManagerCorrelationRuleWithDefaults() *SourceManagerCorrelationRule` + +NewSourceManagerCorrelationRuleWithDefaults instantiates a new SourceManagerCorrelationRule 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 + +### GetType + +`func (o *SourceManagerCorrelationRule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceManagerCorrelationRule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceManagerCorrelationRule) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceManagerCorrelationRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceManagerCorrelationRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceManagerCorrelationRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceManagerCorrelationRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceManagerCorrelationRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceManagerCorrelationRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceManagerCorrelationRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceManagerCorrelationRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceManagerCorrelationRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceOwner.md new file mode 100644 index 000000000..4ddef8bb6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceOwner.md @@ -0,0 +1,116 @@ +--- +id: v2025-source-owner +title: SourceOwner +pagination_label: SourceOwner +sidebar_label: SourceOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceOwner', 'V2025SourceOwner'] +slug: /tools/sdk/go/v2025/models/source-owner +tags: ['SDK', 'Software Development Kit', 'SourceOwner', 'V2025SourceOwner'] +--- + +# SourceOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Owner identity's ID. | [optional] +**Name** | Pointer to **string** | Owner identity's human-readable display name. | [optional] + +## Methods + +### NewSourceOwner + +`func NewSourceOwner() *SourceOwner` + +NewSourceOwner instantiates a new SourceOwner 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 + +### NewSourceOwnerWithDefaults + +`func NewSourceOwnerWithDefaults() *SourceOwner` + +NewSourceOwnerWithDefaults instantiates a new SourceOwner 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 + +### GetType + +`func (o *SourceOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourcePasswordPoliciesInner.md b/docs/tools/sdk/go/Reference/V2025/Models/SourcePasswordPoliciesInner.md new file mode 100644 index 000000000..e989807d7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourcePasswordPoliciesInner.md @@ -0,0 +1,116 @@ +--- +id: v2025-source-password-policies-inner +title: SourcePasswordPoliciesInner +pagination_label: SourcePasswordPoliciesInner +sidebar_label: SourcePasswordPoliciesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourcePasswordPoliciesInner', 'V2025SourcePasswordPoliciesInner'] +slug: /tools/sdk/go/v2025/models/source-password-policies-inner +tags: ['SDK', 'Software Development Kit', 'SourcePasswordPoliciesInner', 'V2025SourcePasswordPoliciesInner'] +--- + +# SourcePasswordPoliciesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Policy ID. | [optional] +**Name** | Pointer to **string** | Policy's human-readable display name. | [optional] + +## Methods + +### NewSourcePasswordPoliciesInner + +`func NewSourcePasswordPoliciesInner() *SourcePasswordPoliciesInner` + +NewSourcePasswordPoliciesInner instantiates a new SourcePasswordPoliciesInner 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 + +### NewSourcePasswordPoliciesInnerWithDefaults + +`func NewSourcePasswordPoliciesInnerWithDefaults() *SourcePasswordPoliciesInner` + +NewSourcePasswordPoliciesInnerWithDefaults instantiates a new SourcePasswordPoliciesInner 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 + +### GetType + +`func (o *SourcePasswordPoliciesInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourcePasswordPoliciesInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourcePasswordPoliciesInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourcePasswordPoliciesInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourcePasswordPoliciesInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourcePasswordPoliciesInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourcePasswordPoliciesInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourcePasswordPoliciesInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourcePasswordPoliciesInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourcePasswordPoliciesInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourcePasswordPoliciesInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourcePasswordPoliciesInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceSchedule.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceSchedule.md new file mode 100644 index 000000000..632863c06 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceSchedule.md @@ -0,0 +1,80 @@ +--- +id: v2025-source-schedule +title: SourceSchedule +pagination_label: SourceSchedule +sidebar_label: SourceSchedule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceSchedule', 'V2025SourceSchedule'] +slug: /tools/sdk/go/v2025/models/source-schedule +tags: ['SDK', 'Software Development Kit', 'SourceSchedule', 'V2025SourceSchedule'] +--- + +# SourceSchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of the Schedule. | +**CronExpression** | **string** | The cron expression of the schedule. | + +## Methods + +### NewSourceSchedule + +`func NewSourceSchedule(type_ string, cronExpression string, ) *SourceSchedule` + +NewSourceSchedule instantiates a new SourceSchedule 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 + +### NewSourceScheduleWithDefaults + +`func NewSourceScheduleWithDefaults() *SourceSchedule` + +NewSourceScheduleWithDefaults instantiates a new SourceSchedule 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 + +### GetType + +`func (o *SourceSchedule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceSchedule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceSchedule) SetType(v string)` + +SetType sets Type field to given value. + + +### GetCronExpression + +`func (o *SourceSchedule) GetCronExpression() string` + +GetCronExpression returns the CronExpression field if non-nil, zero value otherwise. + +### GetCronExpressionOk + +`func (o *SourceSchedule) GetCronExpressionOk() (*string, bool)` + +GetCronExpressionOk returns a tuple with the CronExpression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCronExpression + +`func (o *SourceSchedule) SetCronExpression(v string)` + +SetCronExpression sets CronExpression field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceSchemasInner.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceSchemasInner.md new file mode 100644 index 000000000..89f4a88e3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceSchemasInner.md @@ -0,0 +1,116 @@ +--- +id: v2025-source-schemas-inner +title: SourceSchemasInner +pagination_label: SourceSchemasInner +sidebar_label: SourceSchemasInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceSchemasInner', 'V2025SourceSchemasInner'] +slug: /tools/sdk/go/v2025/models/source-schemas-inner +tags: ['SDK', 'Software Development Kit', 'SourceSchemasInner', 'V2025SourceSchemasInner'] +--- + +# SourceSchemasInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Schema ID. | [optional] +**Name** | Pointer to **string** | Schema's human-readable display name. | [optional] + +## Methods + +### NewSourceSchemasInner + +`func NewSourceSchemasInner() *SourceSchemasInner` + +NewSourceSchemasInner instantiates a new SourceSchemasInner 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 + +### NewSourceSchemasInnerWithDefaults + +`func NewSourceSchemasInnerWithDefaults() *SourceSchemasInner` + +NewSourceSchemasInnerWithDefaults instantiates a new SourceSchemasInner 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 + +### GetType + +`func (o *SourceSchemasInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceSchemasInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceSchemasInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceSchemasInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceSchemasInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceSchemasInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceSchemasInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceSchemasInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceSchemasInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceSchemasInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceSchemasInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceSchemasInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceSyncJob.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceSyncJob.md new file mode 100644 index 000000000..4df0da00b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceSyncJob.md @@ -0,0 +1,101 @@ +--- +id: v2025-source-sync-job +title: SourceSyncJob +pagination_label: SourceSyncJob +sidebar_label: SourceSyncJob +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceSyncJob', 'V2025SourceSyncJob'] +slug: /tools/sdk/go/v2025/models/source-sync-job +tags: ['SDK', 'Software Development Kit', 'SourceSyncJob', 'V2025SourceSyncJob'] +--- + +# SourceSyncJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Job ID. | +**Status** | **string** | The job status. | +**Payload** | [**SourceSyncPayload**](source-sync-payload) | | + +## Methods + +### NewSourceSyncJob + +`func NewSourceSyncJob(id string, status string, payload SourceSyncPayload, ) *SourceSyncJob` + +NewSourceSyncJob instantiates a new SourceSyncJob 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 + +### NewSourceSyncJobWithDefaults + +`func NewSourceSyncJobWithDefaults() *SourceSyncJob` + +NewSourceSyncJobWithDefaults instantiates a new SourceSyncJob 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 + +### GetId + +`func (o *SourceSyncJob) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceSyncJob) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceSyncJob) SetId(v string)` + +SetId sets Id field to given value. + + +### GetStatus + +`func (o *SourceSyncJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SourceSyncJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SourceSyncJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetPayload + +`func (o *SourceSyncJob) GetPayload() SourceSyncPayload` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *SourceSyncJob) GetPayloadOk() (*SourceSyncPayload, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPayload + +`func (o *SourceSyncJob) SetPayload(v SourceSyncPayload)` + +SetPayload sets Payload field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceSyncPayload.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceSyncPayload.md new file mode 100644 index 000000000..a73b3c650 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceSyncPayload.md @@ -0,0 +1,80 @@ +--- +id: v2025-source-sync-payload +title: SourceSyncPayload +pagination_label: SourceSyncPayload +sidebar_label: SourceSyncPayload +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceSyncPayload', 'V2025SourceSyncPayload'] +slug: /tools/sdk/go/v2025/models/source-sync-payload +tags: ['SDK', 'Software Development Kit', 'SourceSyncPayload', 'V2025SourceSyncPayload'] +--- + +# SourceSyncPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Payload type. | +**DataJson** | **string** | Payload type. | + +## Methods + +### NewSourceSyncPayload + +`func NewSourceSyncPayload(type_ string, dataJson string, ) *SourceSyncPayload` + +NewSourceSyncPayload instantiates a new SourceSyncPayload 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 + +### NewSourceSyncPayloadWithDefaults + +`func NewSourceSyncPayloadWithDefaults() *SourceSyncPayload` + +NewSourceSyncPayloadWithDefaults instantiates a new SourceSyncPayload 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 + +### GetType + +`func (o *SourceSyncPayload) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceSyncPayload) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceSyncPayload) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDataJson + +`func (o *SourceSyncPayload) GetDataJson() string` + +GetDataJson returns the DataJson field if non-nil, zero value otherwise. + +### GetDataJsonOk + +`func (o *SourceSyncPayload) GetDataJsonOk() (*string, bool)` + +GetDataJsonOk returns a tuple with the DataJson field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataJson + +`func (o *SourceSyncPayload) SetDataJson(v string)` + +SetDataJson sets DataJson field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceUpdated.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceUpdated.md new file mode 100644 index 000000000..b1596683f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceUpdated.md @@ -0,0 +1,164 @@ +--- +id: v2025-source-updated +title: SourceUpdated +pagination_label: SourceUpdated +sidebar_label: SourceUpdated +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUpdated', 'V2025SourceUpdated'] +slug: /tools/sdk/go/v2025/models/source-updated +tags: ['SDK', 'Software Development Kit', 'SourceUpdated', 'V2025SourceUpdated'] +--- + +# SourceUpdated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the source. | +**Name** | **string** | The user friendly name of the source. | +**Type** | **string** | The connection type of the source. | +**Modified** | **SailPointTime** | The date and time the source was modified. | +**Connector** | **string** | The connector type used to connect to the source. | +**Actor** | [**SourceUpdatedActor**](source-updated-actor) | | + +## Methods + +### NewSourceUpdated + +`func NewSourceUpdated(id string, name string, type_ string, modified SailPointTime, connector string, actor SourceUpdatedActor, ) *SourceUpdated` + +NewSourceUpdated instantiates a new SourceUpdated 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 + +### NewSourceUpdatedWithDefaults + +`func NewSourceUpdatedWithDefaults() *SourceUpdated` + +NewSourceUpdatedWithDefaults instantiates a new SourceUpdated 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 + +### GetId + +`func (o *SourceUpdated) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceUpdated) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceUpdated) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceUpdated) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceUpdated) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceUpdated) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *SourceUpdated) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceUpdated) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceUpdated) SetType(v string)` + +SetType sets Type field to given value. + + +### GetModified + +`func (o *SourceUpdated) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SourceUpdated) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SourceUpdated) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetConnector + +`func (o *SourceUpdated) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *SourceUpdated) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *SourceUpdated) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetActor + +`func (o *SourceUpdated) GetActor() SourceUpdatedActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *SourceUpdated) GetActorOk() (*SourceUpdatedActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *SourceUpdated) SetActor(v SourceUpdatedActor)` + +SetActor sets Actor field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceUpdatedActor.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceUpdatedActor.md new file mode 100644 index 000000000..a486ef571 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceUpdatedActor.md @@ -0,0 +1,106 @@ +--- +id: v2025-source-updated-actor +title: SourceUpdatedActor +pagination_label: SourceUpdatedActor +sidebar_label: SourceUpdatedActor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUpdatedActor', 'V2025SourceUpdatedActor'] +slug: /tools/sdk/go/v2025/models/source-updated-actor +tags: ['SDK', 'Software Development Kit', 'SourceUpdatedActor', 'V2025SourceUpdatedActor'] +--- + +# SourceUpdatedActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | DTO type of identity who updated the source. | +**Id** | Pointer to **string** | ID of identity who updated the source. | [optional] +**Name** | **string** | Display name of identity who updated the source. | + +## Methods + +### NewSourceUpdatedActor + +`func NewSourceUpdatedActor(type_ string, name string, ) *SourceUpdatedActor` + +NewSourceUpdatedActor instantiates a new SourceUpdatedActor 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 + +### NewSourceUpdatedActorWithDefaults + +`func NewSourceUpdatedActorWithDefaults() *SourceUpdatedActor` + +NewSourceUpdatedActorWithDefaults instantiates a new SourceUpdatedActor 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 + +### GetType + +`func (o *SourceUpdatedActor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceUpdatedActor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceUpdatedActor) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *SourceUpdatedActor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceUpdatedActor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceUpdatedActor) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceUpdatedActor) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceUpdatedActor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceUpdatedActor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceUpdatedActor) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceUsage.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceUsage.md new file mode 100644 index 000000000..94d5ff8a7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceUsage.md @@ -0,0 +1,90 @@ +--- +id: v2025-source-usage +title: SourceUsage +pagination_label: SourceUsage +sidebar_label: SourceUsage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUsage', 'V2025SourceUsage'] +slug: /tools/sdk/go/v2025/models/source-usage +tags: ['SDK', 'Software Development Kit', 'SourceUsage', 'V2025SourceUsage'] +--- + +# SourceUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **string** | The first day of the month for which activity is aggregated. | [optional] +**Count** | Pointer to **float32** | The average number of days that accounts were active within this source, for the month. | [optional] + +## Methods + +### NewSourceUsage + +`func NewSourceUsage() *SourceUsage` + +NewSourceUsage instantiates a new SourceUsage 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 + +### NewSourceUsageWithDefaults + +`func NewSourceUsageWithDefaults() *SourceUsage` + +NewSourceUsageWithDefaults instantiates a new SourceUsage 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 + +### GetDate + +`func (o *SourceUsage) GetDate() string` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *SourceUsage) GetDateOk() (*string, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *SourceUsage) SetDate(v string)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *SourceUsage) HasDate() bool` + +HasDate returns a boolean if a field has been set. + +### GetCount + +`func (o *SourceUsage) GetCount() float32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *SourceUsage) GetCountOk() (*float32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *SourceUsage) SetCount(v float32)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *SourceUsage) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SourceUsageStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/SourceUsageStatus.md new file mode 100644 index 000000000..c23cd1dc6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SourceUsageStatus.md @@ -0,0 +1,64 @@ +--- +id: v2025-source-usage-status +title: SourceUsageStatus +pagination_label: SourceUsageStatus +sidebar_label: SourceUsageStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUsageStatus', 'V2025SourceUsageStatus'] +slug: /tools/sdk/go/v2025/models/source-usage-status +tags: ['SDK', 'Software Development Kit', 'SourceUsageStatus', 'V2025SourceUsageStatus'] +--- + +# SourceUsageStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. | [optional] + +## Methods + +### NewSourceUsageStatus + +`func NewSourceUsageStatus() *SourceUsageStatus` + +NewSourceUsageStatus instantiates a new SourceUsageStatus 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 + +### NewSourceUsageStatusWithDefaults + +`func NewSourceUsageStatusWithDefaults() *SourceUsageStatus` + +NewSourceUsageStatusWithDefaults instantiates a new SourceUsageStatus 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 + +### GetStatus + +`func (o *SourceUsageStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SourceUsageStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SourceUsageStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SourceUsageStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SpConfigExportJob.md b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigExportJob.md new file mode 100644 index 000000000..76f2f9fa1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigExportJob.md @@ -0,0 +1,190 @@ +--- +id: v2025-sp-config-export-job +title: SpConfigExportJob +pagination_label: SpConfigExportJob +sidebar_label: SpConfigExportJob +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigExportJob', 'V2025SpConfigExportJob'] +slug: /tools/sdk/go/v2025/models/sp-config-export-job +tags: ['SDK', 'Software Development Kit', 'SpConfigExportJob', 'V2025SpConfigExportJob'] +--- + +# SpConfigExportJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **string** | Unique id assigned to this job. | +**Status** | **string** | Status of the job. | +**Type** | **string** | Type of the job, either export or import. | +**Expiration** | **SailPointTime** | The time until which the artifacts will be available for download. | +**Created** | **SailPointTime** | The time the job was started. | +**Modified** | **SailPointTime** | The time of the last update to the job. | +**Description** | Pointer to **string** | Optional user defined description/name for export job. | [optional] + +## Methods + +### NewSpConfigExportJob + +`func NewSpConfigExportJob(jobId string, status string, type_ string, expiration SailPointTime, created SailPointTime, modified SailPointTime, ) *SpConfigExportJob` + +NewSpConfigExportJob instantiates a new SpConfigExportJob 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 + +### NewSpConfigExportJobWithDefaults + +`func NewSpConfigExportJobWithDefaults() *SpConfigExportJob` + +NewSpConfigExportJobWithDefaults instantiates a new SpConfigExportJob 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 + +### GetJobId + +`func (o *SpConfigExportJob) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *SpConfigExportJob) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *SpConfigExportJob) SetJobId(v string)` + +SetJobId sets JobId field to given value. + + +### GetStatus + +`func (o *SpConfigExportJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SpConfigExportJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SpConfigExportJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *SpConfigExportJob) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SpConfigExportJob) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SpConfigExportJob) SetType(v string)` + +SetType sets Type field to given value. + + +### GetExpiration + +`func (o *SpConfigExportJob) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *SpConfigExportJob) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *SpConfigExportJob) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + + +### GetCreated + +`func (o *SpConfigExportJob) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SpConfigExportJob) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SpConfigExportJob) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *SpConfigExportJob) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SpConfigExportJob) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SpConfigExportJob) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetDescription + +`func (o *SpConfigExportJob) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SpConfigExportJob) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SpConfigExportJob) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SpConfigExportJob) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SpConfigExportJobStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigExportJobStatus.md new file mode 100644 index 000000000..cf28ccd36 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigExportJobStatus.md @@ -0,0 +1,216 @@ +--- +id: v2025-sp-config-export-job-status +title: SpConfigExportJobStatus +pagination_label: SpConfigExportJobStatus +sidebar_label: SpConfigExportJobStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigExportJobStatus', 'V2025SpConfigExportJobStatus'] +slug: /tools/sdk/go/v2025/models/sp-config-export-job-status +tags: ['SDK', 'Software Development Kit', 'SpConfigExportJobStatus', 'V2025SpConfigExportJobStatus'] +--- + +# SpConfigExportJobStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **string** | Unique id assigned to this job. | +**Status** | **string** | Status of the job. | +**Type** | **string** | Type of the job, either export or import. | +**Expiration** | **SailPointTime** | The time until which the artifacts will be available for download. | +**Created** | **SailPointTime** | The time the job was started. | +**Modified** | **SailPointTime** | The time of the last update to the job. | +**Description** | Pointer to **string** | Optional user defined description/name for export job. | [optional] +**Completed** | Pointer to **SailPointTime** | The time the job was completed. | [optional] + +## Methods + +### NewSpConfigExportJobStatus + +`func NewSpConfigExportJobStatus(jobId string, status string, type_ string, expiration SailPointTime, created SailPointTime, modified SailPointTime, ) *SpConfigExportJobStatus` + +NewSpConfigExportJobStatus instantiates a new SpConfigExportJobStatus 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 + +### NewSpConfigExportJobStatusWithDefaults + +`func NewSpConfigExportJobStatusWithDefaults() *SpConfigExportJobStatus` + +NewSpConfigExportJobStatusWithDefaults instantiates a new SpConfigExportJobStatus 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 + +### GetJobId + +`func (o *SpConfigExportJobStatus) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *SpConfigExportJobStatus) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *SpConfigExportJobStatus) SetJobId(v string)` + +SetJobId sets JobId field to given value. + + +### GetStatus + +`func (o *SpConfigExportJobStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SpConfigExportJobStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SpConfigExportJobStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *SpConfigExportJobStatus) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SpConfigExportJobStatus) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SpConfigExportJobStatus) SetType(v string)` + +SetType sets Type field to given value. + + +### GetExpiration + +`func (o *SpConfigExportJobStatus) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *SpConfigExportJobStatus) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *SpConfigExportJobStatus) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + + +### GetCreated + +`func (o *SpConfigExportJobStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SpConfigExportJobStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SpConfigExportJobStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *SpConfigExportJobStatus) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SpConfigExportJobStatus) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SpConfigExportJobStatus) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetDescription + +`func (o *SpConfigExportJobStatus) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SpConfigExportJobStatus) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SpConfigExportJobStatus) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SpConfigExportJobStatus) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetCompleted + +`func (o *SpConfigExportJobStatus) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *SpConfigExportJobStatus) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *SpConfigExportJobStatus) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *SpConfigExportJobStatus) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SpConfigExportResults.md b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigExportResults.md new file mode 100644 index 000000000..f2e3d7530 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigExportResults.md @@ -0,0 +1,194 @@ +--- +id: v2025-sp-config-export-results +title: SpConfigExportResults +pagination_label: SpConfigExportResults +sidebar_label: SpConfigExportResults +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigExportResults', 'V2025SpConfigExportResults'] +slug: /tools/sdk/go/v2025/models/sp-config-export-results +tags: ['SDK', 'Software Development Kit', 'SpConfigExportResults', 'V2025SpConfigExportResults'] +--- + +# SpConfigExportResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **int32** | Current version of the export results object. | [optional] +**Timestamp** | Pointer to **SailPointTime** | Time the export was completed. | [optional] +**Tenant** | Pointer to **string** | Name of the tenant where this export originated. | [optional] +**Description** | Pointer to **string** | Optional user defined description/name for export job. | [optional] +**Options** | Pointer to [**ExportOptions1**](export-options1) | | [optional] +**Objects** | Pointer to [**[]ConfigObject**](config-object) | | [optional] + +## Methods + +### NewSpConfigExportResults + +`func NewSpConfigExportResults() *SpConfigExportResults` + +NewSpConfigExportResults instantiates a new SpConfigExportResults 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 + +### NewSpConfigExportResultsWithDefaults + +`func NewSpConfigExportResultsWithDefaults() *SpConfigExportResults` + +NewSpConfigExportResultsWithDefaults instantiates a new SpConfigExportResults 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 + +### GetVersion + +`func (o *SpConfigExportResults) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *SpConfigExportResults) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *SpConfigExportResults) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *SpConfigExportResults) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### GetTimestamp + +`func (o *SpConfigExportResults) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *SpConfigExportResults) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *SpConfigExportResults) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *SpConfigExportResults) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + +### GetTenant + +`func (o *SpConfigExportResults) GetTenant() string` + +GetTenant returns the Tenant field if non-nil, zero value otherwise. + +### GetTenantOk + +`func (o *SpConfigExportResults) GetTenantOk() (*string, bool)` + +GetTenantOk returns a tuple with the Tenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenant + +`func (o *SpConfigExportResults) SetTenant(v string)` + +SetTenant sets Tenant field to given value. + +### HasTenant + +`func (o *SpConfigExportResults) HasTenant() bool` + +HasTenant returns a boolean if a field has been set. + +### GetDescription + +`func (o *SpConfigExportResults) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SpConfigExportResults) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SpConfigExportResults) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SpConfigExportResults) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOptions + +`func (o *SpConfigExportResults) GetOptions() ExportOptions1` + +GetOptions returns the Options field if non-nil, zero value otherwise. + +### GetOptionsOk + +`func (o *SpConfigExportResults) GetOptionsOk() (*ExportOptions1, bool)` + +GetOptionsOk returns a tuple with the Options field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOptions + +`func (o *SpConfigExportResults) SetOptions(v ExportOptions1)` + +SetOptions sets Options field to given value. + +### HasOptions + +`func (o *SpConfigExportResults) HasOptions() bool` + +HasOptions returns a boolean if a field has been set. + +### GetObjects + +`func (o *SpConfigExportResults) GetObjects() []ConfigObject` + +GetObjects returns the Objects field if non-nil, zero value otherwise. + +### GetObjectsOk + +`func (o *SpConfigExportResults) GetObjectsOk() (*[]ConfigObject, bool)` + +GetObjectsOk returns a tuple with the Objects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjects + +`func (o *SpConfigExportResults) SetObjects(v []ConfigObject)` + +SetObjects sets Objects field to given value. + +### HasObjects + +`func (o *SpConfigExportResults) HasObjects() bool` + +HasObjects returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SpConfigImportJobStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigImportJobStatus.md new file mode 100644 index 000000000..5c964c7d1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigImportJobStatus.md @@ -0,0 +1,216 @@ +--- +id: v2025-sp-config-import-job-status +title: SpConfigImportJobStatus +pagination_label: SpConfigImportJobStatus +sidebar_label: SpConfigImportJobStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigImportJobStatus', 'V2025SpConfigImportJobStatus'] +slug: /tools/sdk/go/v2025/models/sp-config-import-job-status +tags: ['SDK', 'Software Development Kit', 'SpConfigImportJobStatus', 'V2025SpConfigImportJobStatus'] +--- + +# SpConfigImportJobStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **string** | Unique id assigned to this job. | +**Status** | **string** | Status of the job. | +**Type** | **string** | Type of the job, either export or import. | +**Expiration** | **SailPointTime** | The time until which the artifacts will be available for download. | +**Created** | **SailPointTime** | The time the job was started. | +**Modified** | **SailPointTime** | The time of the last update to the job. | +**Message** | Pointer to **string** | This message contains additional information about the overall status of the job. | [optional] +**Completed** | Pointer to **SailPointTime** | The time the job was completed. | [optional] + +## Methods + +### NewSpConfigImportJobStatus + +`func NewSpConfigImportJobStatus(jobId string, status string, type_ string, expiration SailPointTime, created SailPointTime, modified SailPointTime, ) *SpConfigImportJobStatus` + +NewSpConfigImportJobStatus instantiates a new SpConfigImportJobStatus 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 + +### NewSpConfigImportJobStatusWithDefaults + +`func NewSpConfigImportJobStatusWithDefaults() *SpConfigImportJobStatus` + +NewSpConfigImportJobStatusWithDefaults instantiates a new SpConfigImportJobStatus 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 + +### GetJobId + +`func (o *SpConfigImportJobStatus) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *SpConfigImportJobStatus) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *SpConfigImportJobStatus) SetJobId(v string)` + +SetJobId sets JobId field to given value. + + +### GetStatus + +`func (o *SpConfigImportJobStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SpConfigImportJobStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SpConfigImportJobStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *SpConfigImportJobStatus) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SpConfigImportJobStatus) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SpConfigImportJobStatus) SetType(v string)` + +SetType sets Type field to given value. + + +### GetExpiration + +`func (o *SpConfigImportJobStatus) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *SpConfigImportJobStatus) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *SpConfigImportJobStatus) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + + +### GetCreated + +`func (o *SpConfigImportJobStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SpConfigImportJobStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SpConfigImportJobStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *SpConfigImportJobStatus) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SpConfigImportJobStatus) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SpConfigImportJobStatus) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetMessage + +`func (o *SpConfigImportJobStatus) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *SpConfigImportJobStatus) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *SpConfigImportJobStatus) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *SpConfigImportJobStatus) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetCompleted + +`func (o *SpConfigImportJobStatus) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *SpConfigImportJobStatus) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *SpConfigImportJobStatus) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *SpConfigImportJobStatus) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SpConfigImportResults.md b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigImportResults.md new file mode 100644 index 000000000..792039262 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigImportResults.md @@ -0,0 +1,85 @@ +--- +id: v2025-sp-config-import-results +title: SpConfigImportResults +pagination_label: SpConfigImportResults +sidebar_label: SpConfigImportResults +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigImportResults', 'V2025SpConfigImportResults'] +slug: /tools/sdk/go/v2025/models/sp-config-import-results +tags: ['SDK', 'Software Development Kit', 'SpConfigImportResults', 'V2025SpConfigImportResults'] +--- + +# SpConfigImportResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | [**map[string]ObjectImportResult1**](object-import-result1) | The results of an object configuration import job. | +**ExportJobId** | Pointer to **string** | If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export. | [optional] + +## Methods + +### NewSpConfigImportResults + +`func NewSpConfigImportResults(results map[string]ObjectImportResult1, ) *SpConfigImportResults` + +NewSpConfigImportResults instantiates a new SpConfigImportResults 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 + +### NewSpConfigImportResultsWithDefaults + +`func NewSpConfigImportResultsWithDefaults() *SpConfigImportResults` + +NewSpConfigImportResultsWithDefaults instantiates a new SpConfigImportResults 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 + +### GetResults + +`func (o *SpConfigImportResults) GetResults() map[string]ObjectImportResult1` + +GetResults returns the Results field if non-nil, zero value otherwise. + +### GetResultsOk + +`func (o *SpConfigImportResults) GetResultsOk() (*map[string]ObjectImportResult1, bool)` + +GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResults + +`func (o *SpConfigImportResults) SetResults(v map[string]ObjectImportResult1)` + +SetResults sets Results field to given value. + + +### GetExportJobId + +`func (o *SpConfigImportResults) GetExportJobId() string` + +GetExportJobId returns the ExportJobId field if non-nil, zero value otherwise. + +### GetExportJobIdOk + +`func (o *SpConfigImportResults) GetExportJobIdOk() (*string, bool)` + +GetExportJobIdOk returns a tuple with the ExportJobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExportJobId + +`func (o *SpConfigImportResults) SetExportJobId(v string)` + +SetExportJobId sets ExportJobId field to given value. + +### HasExportJobId + +`func (o *SpConfigImportResults) HasExportJobId() bool` + +HasExportJobId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SpConfigJob.md b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigJob.md new file mode 100644 index 000000000..542b5dce6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigJob.md @@ -0,0 +1,164 @@ +--- +id: v2025-sp-config-job +title: SpConfigJob +pagination_label: SpConfigJob +sidebar_label: SpConfigJob +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigJob', 'V2025SpConfigJob'] +slug: /tools/sdk/go/v2025/models/sp-config-job +tags: ['SDK', 'Software Development Kit', 'SpConfigJob', 'V2025SpConfigJob'] +--- + +# SpConfigJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **string** | Unique id assigned to this job. | +**Status** | **string** | Status of the job. | +**Type** | **string** | Type of the job, either export or import. | +**Expiration** | **SailPointTime** | The time until which the artifacts will be available for download. | +**Created** | **SailPointTime** | The time the job was started. | +**Modified** | **SailPointTime** | The time of the last update to the job. | + +## Methods + +### NewSpConfigJob + +`func NewSpConfigJob(jobId string, status string, type_ string, expiration SailPointTime, created SailPointTime, modified SailPointTime, ) *SpConfigJob` + +NewSpConfigJob instantiates a new SpConfigJob 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 + +### NewSpConfigJobWithDefaults + +`func NewSpConfigJobWithDefaults() *SpConfigJob` + +NewSpConfigJobWithDefaults instantiates a new SpConfigJob 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 + +### GetJobId + +`func (o *SpConfigJob) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *SpConfigJob) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *SpConfigJob) SetJobId(v string)` + +SetJobId sets JobId field to given value. + + +### GetStatus + +`func (o *SpConfigJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SpConfigJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SpConfigJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *SpConfigJob) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SpConfigJob) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SpConfigJob) SetType(v string)` + +SetType sets Type field to given value. + + +### GetExpiration + +`func (o *SpConfigJob) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *SpConfigJob) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *SpConfigJob) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + + +### GetCreated + +`func (o *SpConfigJob) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SpConfigJob) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SpConfigJob) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *SpConfigJob) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SpConfigJob) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SpConfigJob) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SpConfigMessage.md b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigMessage.md new file mode 100644 index 000000000..9073304de --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigMessage.md @@ -0,0 +1,101 @@ +--- +id: v2025-sp-config-message +title: SpConfigMessage +pagination_label: SpConfigMessage +sidebar_label: SpConfigMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigMessage', 'V2025SpConfigMessage'] +slug: /tools/sdk/go/v2025/models/sp-config-message +tags: ['SDK', 'Software Development Kit', 'SpConfigMessage', 'V2025SpConfigMessage'] +--- + +# SpConfigMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **string** | Message key. | +**Text** | **string** | Message text. | +**Details** | **map[string]interface{}** | Message details if any, in key:value pairs. | + +## Methods + +### NewSpConfigMessage + +`func NewSpConfigMessage(key string, text string, details map[string]interface{}, ) *SpConfigMessage` + +NewSpConfigMessage instantiates a new SpConfigMessage 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 + +### NewSpConfigMessageWithDefaults + +`func NewSpConfigMessageWithDefaults() *SpConfigMessage` + +NewSpConfigMessageWithDefaults instantiates a new SpConfigMessage 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 + +### GetKey + +`func (o *SpConfigMessage) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *SpConfigMessage) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *SpConfigMessage) SetKey(v string)` + +SetKey sets Key field to given value. + + +### GetText + +`func (o *SpConfigMessage) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *SpConfigMessage) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *SpConfigMessage) SetText(v string)` + +SetText sets Text field to given value. + + +### GetDetails + +`func (o *SpConfigMessage) GetDetails() map[string]interface{}` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *SpConfigMessage) GetDetailsOk() (*map[string]interface{}, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *SpConfigMessage) SetDetails(v map[string]interface{})` + +SetDetails sets Details field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SpConfigMessage1.md b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigMessage1.md new file mode 100644 index 000000000..e991f2394 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigMessage1.md @@ -0,0 +1,101 @@ +--- +id: v2025-sp-config-message1 +title: SpConfigMessage1 +pagination_label: SpConfigMessage1 +sidebar_label: SpConfigMessage1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigMessage1', 'V2025SpConfigMessage1'] +slug: /tools/sdk/go/v2025/models/sp-config-message1 +tags: ['SDK', 'Software Development Kit', 'SpConfigMessage1', 'V2025SpConfigMessage1'] +--- + +# SpConfigMessage1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **string** | Message key. | +**Text** | **string** | Message text. | +**Details** | **map[string]map[string]interface{}** | Message details if any, in key:value pairs. | + +## Methods + +### NewSpConfigMessage1 + +`func NewSpConfigMessage1(key string, text string, details map[string]map[string]interface{}, ) *SpConfigMessage1` + +NewSpConfigMessage1 instantiates a new SpConfigMessage1 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 + +### NewSpConfigMessage1WithDefaults + +`func NewSpConfigMessage1WithDefaults() *SpConfigMessage1` + +NewSpConfigMessage1WithDefaults instantiates a new SpConfigMessage1 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 + +### GetKey + +`func (o *SpConfigMessage1) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *SpConfigMessage1) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *SpConfigMessage1) SetKey(v string)` + +SetKey sets Key field to given value. + + +### GetText + +`func (o *SpConfigMessage1) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *SpConfigMessage1) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *SpConfigMessage1) SetText(v string)` + +SetText sets Text field to given value. + + +### GetDetails + +`func (o *SpConfigMessage1) GetDetails() map[string]map[string]interface{}` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *SpConfigMessage1) GetDetailsOk() (*map[string]map[string]interface{}, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *SpConfigMessage1) SetDetails(v map[string]map[string]interface{})` + +SetDetails sets Details field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SpConfigObject.md b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigObject.md new file mode 100644 index 000000000..8025427b8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigObject.md @@ -0,0 +1,256 @@ +--- +id: v2025-sp-config-object +title: SpConfigObject +pagination_label: SpConfigObject +sidebar_label: SpConfigObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigObject', 'V2025SpConfigObject'] +slug: /tools/sdk/go/v2025/models/sp-config-object +tags: ['SDK', 'Software Development Kit', 'SpConfigObject', 'V2025SpConfigObject'] +--- + +# SpConfigObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectType** | Pointer to **string** | Object type the configuration is for. | [optional] +**ReferenceExtractors** | Pointer to **[]string** | List of JSON paths within an exported object of this type, representing references that must be resolved. | [optional] +**SignatureRequired** | Pointer to **bool** | Indicates whether this type of object will be JWS signed and cannot be modified before import. | [optional] [default to false] +**AlwaysResolveById** | Pointer to **bool** | Indicates whether this object type must be always be resolved by ID. | [optional] [default to false] +**LegacyObject** | Pointer to **bool** | Indicates whether this is a legacy object. | [optional] [default to false] +**OnePerTenant** | Pointer to **bool** | Indicates whether there is only one object of this type. | [optional] [default to false] +**Exportable** | Pointer to **bool** | Indicates whether the object can be exported or is just a reference object. | [optional] [default to false] +**Rules** | Pointer to [**SpConfigRules**](sp-config-rules) | | [optional] + +## Methods + +### NewSpConfigObject + +`func NewSpConfigObject() *SpConfigObject` + +NewSpConfigObject instantiates a new SpConfigObject 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 + +### NewSpConfigObjectWithDefaults + +`func NewSpConfigObjectWithDefaults() *SpConfigObject` + +NewSpConfigObjectWithDefaults instantiates a new SpConfigObject 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 + +### GetObjectType + +`func (o *SpConfigObject) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *SpConfigObject) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *SpConfigObject) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + +### HasObjectType + +`func (o *SpConfigObject) HasObjectType() bool` + +HasObjectType returns a boolean if a field has been set. + +### GetReferenceExtractors + +`func (o *SpConfigObject) GetReferenceExtractors() []string` + +GetReferenceExtractors returns the ReferenceExtractors field if non-nil, zero value otherwise. + +### GetReferenceExtractorsOk + +`func (o *SpConfigObject) GetReferenceExtractorsOk() (*[]string, bool)` + +GetReferenceExtractorsOk returns a tuple with the ReferenceExtractors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReferenceExtractors + +`func (o *SpConfigObject) SetReferenceExtractors(v []string)` + +SetReferenceExtractors sets ReferenceExtractors field to given value. + +### HasReferenceExtractors + +`func (o *SpConfigObject) HasReferenceExtractors() bool` + +HasReferenceExtractors returns a boolean if a field has been set. + +### SetReferenceExtractorsNil + +`func (o *SpConfigObject) SetReferenceExtractorsNil(b bool)` + + SetReferenceExtractorsNil sets the value for ReferenceExtractors to be an explicit nil + +### UnsetReferenceExtractors +`func (o *SpConfigObject) UnsetReferenceExtractors()` + +UnsetReferenceExtractors ensures that no value is present for ReferenceExtractors, not even an explicit nil +### GetSignatureRequired + +`func (o *SpConfigObject) GetSignatureRequired() bool` + +GetSignatureRequired returns the SignatureRequired field if non-nil, zero value otherwise. + +### GetSignatureRequiredOk + +`func (o *SpConfigObject) GetSignatureRequiredOk() (*bool, bool)` + +GetSignatureRequiredOk returns a tuple with the SignatureRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignatureRequired + +`func (o *SpConfigObject) SetSignatureRequired(v bool)` + +SetSignatureRequired sets SignatureRequired field to given value. + +### HasSignatureRequired + +`func (o *SpConfigObject) HasSignatureRequired() bool` + +HasSignatureRequired returns a boolean if a field has been set. + +### GetAlwaysResolveById + +`func (o *SpConfigObject) GetAlwaysResolveById() bool` + +GetAlwaysResolveById returns the AlwaysResolveById field if non-nil, zero value otherwise. + +### GetAlwaysResolveByIdOk + +`func (o *SpConfigObject) GetAlwaysResolveByIdOk() (*bool, bool)` + +GetAlwaysResolveByIdOk returns a tuple with the AlwaysResolveById field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlwaysResolveById + +`func (o *SpConfigObject) SetAlwaysResolveById(v bool)` + +SetAlwaysResolveById sets AlwaysResolveById field to given value. + +### HasAlwaysResolveById + +`func (o *SpConfigObject) HasAlwaysResolveById() bool` + +HasAlwaysResolveById returns a boolean if a field has been set. + +### GetLegacyObject + +`func (o *SpConfigObject) GetLegacyObject() bool` + +GetLegacyObject returns the LegacyObject field if non-nil, zero value otherwise. + +### GetLegacyObjectOk + +`func (o *SpConfigObject) GetLegacyObjectOk() (*bool, bool)` + +GetLegacyObjectOk returns a tuple with the LegacyObject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyObject + +`func (o *SpConfigObject) SetLegacyObject(v bool)` + +SetLegacyObject sets LegacyObject field to given value. + +### HasLegacyObject + +`func (o *SpConfigObject) HasLegacyObject() bool` + +HasLegacyObject returns a boolean if a field has been set. + +### GetOnePerTenant + +`func (o *SpConfigObject) GetOnePerTenant() bool` + +GetOnePerTenant returns the OnePerTenant field if non-nil, zero value otherwise. + +### GetOnePerTenantOk + +`func (o *SpConfigObject) GetOnePerTenantOk() (*bool, bool)` + +GetOnePerTenantOk returns a tuple with the OnePerTenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOnePerTenant + +`func (o *SpConfigObject) SetOnePerTenant(v bool)` + +SetOnePerTenant sets OnePerTenant field to given value. + +### HasOnePerTenant + +`func (o *SpConfigObject) HasOnePerTenant() bool` + +HasOnePerTenant returns a boolean if a field has been set. + +### GetExportable + +`func (o *SpConfigObject) GetExportable() bool` + +GetExportable returns the Exportable field if non-nil, zero value otherwise. + +### GetExportableOk + +`func (o *SpConfigObject) GetExportableOk() (*bool, bool)` + +GetExportableOk returns a tuple with the Exportable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExportable + +`func (o *SpConfigObject) SetExportable(v bool)` + +SetExportable sets Exportable field to given value. + +### HasExportable + +`func (o *SpConfigObject) HasExportable() bool` + +HasExportable returns a boolean if a field has been set. + +### GetRules + +`func (o *SpConfigObject) GetRules() SpConfigRules` + +GetRules returns the Rules field if non-nil, zero value otherwise. + +### GetRulesOk + +`func (o *SpConfigObject) GetRulesOk() (*SpConfigRules, bool)` + +GetRulesOk returns a tuple with the Rules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRules + +`func (o *SpConfigObject) SetRules(v SpConfigRules)` + +SetRules sets Rules field to given value. + +### HasRules + +`func (o *SpConfigObject) HasRules() bool` + +HasRules returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SpConfigRule.md b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigRule.md new file mode 100644 index 000000000..d00898915 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigRule.md @@ -0,0 +1,126 @@ +--- +id: v2025-sp-config-rule +title: SpConfigRule +pagination_label: SpConfigRule +sidebar_label: SpConfigRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigRule', 'V2025SpConfigRule'] +slug: /tools/sdk/go/v2025/models/sp-config-rule +tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'V2025SpConfigRule'] +--- + +# SpConfigRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Path** | Pointer to **string** | JSONPath expression denoting the path within the object where a value substitution should be applied. | [optional] +**Value** | Pointer to [**NullableSpConfigRuleValue**](sp-config-rule-value) | | [optional] +**Modes** | Pointer to **[]string** | Draft modes the rule will apply to. | [optional] + +## Methods + +### NewSpConfigRule + +`func NewSpConfigRule() *SpConfigRule` + +NewSpConfigRule instantiates a new SpConfigRule 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 + +### NewSpConfigRuleWithDefaults + +`func NewSpConfigRuleWithDefaults() *SpConfigRule` + +NewSpConfigRuleWithDefaults instantiates a new SpConfigRule 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 + +### GetPath + +`func (o *SpConfigRule) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *SpConfigRule) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *SpConfigRule) SetPath(v string)` + +SetPath sets Path field to given value. + +### HasPath + +`func (o *SpConfigRule) HasPath() bool` + +HasPath returns a boolean if a field has been set. + +### GetValue + +`func (o *SpConfigRule) GetValue() SpConfigRuleValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SpConfigRule) GetValueOk() (*SpConfigRuleValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SpConfigRule) SetValue(v SpConfigRuleValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SpConfigRule) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *SpConfigRule) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *SpConfigRule) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetModes + +`func (o *SpConfigRule) GetModes() []string` + +GetModes returns the Modes field if non-nil, zero value otherwise. + +### GetModesOk + +`func (o *SpConfigRule) GetModesOk() (*[]string, bool)` + +GetModesOk returns a tuple with the Modes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModes + +`func (o *SpConfigRule) SetModes(v []string)` + +SetModes sets Modes field to given value. + +### HasModes + +`func (o *SpConfigRule) HasModes() bool` + +HasModes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SpConfigRuleValue.md b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigRuleValue.md new file mode 100644 index 000000000..81b77c514 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigRuleValue.md @@ -0,0 +1,38 @@ +--- +id: v2025-sp-config-rule-value +title: SpConfigRuleValue +pagination_label: SpConfigRuleValue +sidebar_label: SpConfigRuleValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigRuleValue', 'V2025SpConfigRuleValue'] +slug: /tools/sdk/go/v2025/models/sp-config-rule-value +tags: ['SDK', 'Software Development Kit', 'SpConfigRuleValue', 'V2025SpConfigRuleValue'] +--- + +# SpConfigRuleValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewSpConfigRuleValue + +`func NewSpConfigRuleValue() *SpConfigRuleValue` + +NewSpConfigRuleValue instantiates a new SpConfigRuleValue 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 + +### NewSpConfigRuleValueWithDefaults + +`func NewSpConfigRuleValueWithDefaults() *SpConfigRuleValue` + +NewSpConfigRuleValueWithDefaults instantiates a new SpConfigRuleValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SpConfigRules.md b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigRules.md new file mode 100644 index 000000000..42fb962ef --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SpConfigRules.md @@ -0,0 +1,116 @@ +--- +id: v2025-sp-config-rules +title: SpConfigRules +pagination_label: SpConfigRules +sidebar_label: SpConfigRules +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigRules', 'V2025SpConfigRules'] +slug: /tools/sdk/go/v2025/models/sp-config-rules +tags: ['SDK', 'Software Development Kit', 'SpConfigRules', 'V2025SpConfigRules'] +--- + +# SpConfigRules + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TakeFromTargetRules** | Pointer to [**[]SpConfigRule**](sp-config-rule) | | [optional] +**DefaultRules** | Pointer to [**[]SpConfigRule**](sp-config-rule) | | [optional] +**Editable** | Pointer to **bool** | Indicates whether the object can be edited. | [optional] [default to false] + +## Methods + +### NewSpConfigRules + +`func NewSpConfigRules() *SpConfigRules` + +NewSpConfigRules instantiates a new SpConfigRules 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 + +### NewSpConfigRulesWithDefaults + +`func NewSpConfigRulesWithDefaults() *SpConfigRules` + +NewSpConfigRulesWithDefaults instantiates a new SpConfigRules 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 + +### GetTakeFromTargetRules + +`func (o *SpConfigRules) GetTakeFromTargetRules() []SpConfigRule` + +GetTakeFromTargetRules returns the TakeFromTargetRules field if non-nil, zero value otherwise. + +### GetTakeFromTargetRulesOk + +`func (o *SpConfigRules) GetTakeFromTargetRulesOk() (*[]SpConfigRule, bool)` + +GetTakeFromTargetRulesOk returns a tuple with the TakeFromTargetRules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTakeFromTargetRules + +`func (o *SpConfigRules) SetTakeFromTargetRules(v []SpConfigRule)` + +SetTakeFromTargetRules sets TakeFromTargetRules field to given value. + +### HasTakeFromTargetRules + +`func (o *SpConfigRules) HasTakeFromTargetRules() bool` + +HasTakeFromTargetRules returns a boolean if a field has been set. + +### GetDefaultRules + +`func (o *SpConfigRules) GetDefaultRules() []SpConfigRule` + +GetDefaultRules returns the DefaultRules field if non-nil, zero value otherwise. + +### GetDefaultRulesOk + +`func (o *SpConfigRules) GetDefaultRulesOk() (*[]SpConfigRule, bool)` + +GetDefaultRulesOk returns a tuple with the DefaultRules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultRules + +`func (o *SpConfigRules) SetDefaultRules(v []SpConfigRule)` + +SetDefaultRules sets DefaultRules field to given value. + +### HasDefaultRules + +`func (o *SpConfigRules) HasDefaultRules() bool` + +HasDefaultRules returns a boolean if a field has been set. + +### GetEditable + +`func (o *SpConfigRules) GetEditable() bool` + +GetEditable returns the Editable field if non-nil, zero value otherwise. + +### GetEditableOk + +`func (o *SpConfigRules) GetEditableOk() (*bool, bool)` + +GetEditableOk returns a tuple with the Editable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEditable + +`func (o *SpConfigRules) SetEditable(v bool)` + +SetEditable sets Editable field to given value. + +### HasEditable + +`func (o *SpConfigRules) HasEditable() bool` + +HasEditable returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SpDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/SpDetails.md new file mode 100644 index 000000000..092bc1393 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SpDetails.md @@ -0,0 +1,163 @@ +--- +id: v2025-sp-details +title: SpDetails +pagination_label: SpDetails +sidebar_label: SpDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpDetails', 'V2025SpDetails'] +slug: /tools/sdk/go/v2025/models/sp-details +tags: ['SDK', 'Software Development Kit', 'SpDetails', 'V2025SpDetails'] +--- + +# SpDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | Pointer to **string** | Federation protocol role | [optional] +**EntityId** | Pointer to **string** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Alias** | Pointer to **string** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**CallbackUrl** | **string** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | +**LegacyAcsUrl** | Pointer to **string** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] + +## Methods + +### NewSpDetails + +`func NewSpDetails(callbackUrl string, ) *SpDetails` + +NewSpDetails instantiates a new SpDetails 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 + +### NewSpDetailsWithDefaults + +`func NewSpDetailsWithDefaults() *SpDetails` + +NewSpDetailsWithDefaults instantiates a new SpDetails 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 + +### GetRole + +`func (o *SpDetails) GetRole() string` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *SpDetails) GetRoleOk() (*string, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *SpDetails) SetRole(v string)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *SpDetails) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetEntityId + +`func (o *SpDetails) GetEntityId() string` + +GetEntityId returns the EntityId field if non-nil, zero value otherwise. + +### GetEntityIdOk + +`func (o *SpDetails) GetEntityIdOk() (*string, bool)` + +GetEntityIdOk returns a tuple with the EntityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntityId + +`func (o *SpDetails) SetEntityId(v string)` + +SetEntityId sets EntityId field to given value. + +### HasEntityId + +`func (o *SpDetails) HasEntityId() bool` + +HasEntityId returns a boolean if a field has been set. + +### GetAlias + +`func (o *SpDetails) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *SpDetails) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *SpDetails) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *SpDetails) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + +### GetCallbackUrl + +`func (o *SpDetails) GetCallbackUrl() string` + +GetCallbackUrl returns the CallbackUrl field if non-nil, zero value otherwise. + +### GetCallbackUrlOk + +`func (o *SpDetails) GetCallbackUrlOk() (*string, bool)` + +GetCallbackUrlOk returns a tuple with the CallbackUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCallbackUrl + +`func (o *SpDetails) SetCallbackUrl(v string)` + +SetCallbackUrl sets CallbackUrl field to given value. + + +### GetLegacyAcsUrl + +`func (o *SpDetails) GetLegacyAcsUrl() string` + +GetLegacyAcsUrl returns the LegacyAcsUrl field if non-nil, zero value otherwise. + +### GetLegacyAcsUrlOk + +`func (o *SpDetails) GetLegacyAcsUrlOk() (*string, bool)` + +GetLegacyAcsUrlOk returns a tuple with the LegacyAcsUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyAcsUrl + +`func (o *SpDetails) SetLegacyAcsUrl(v string)` + +SetLegacyAcsUrl sets LegacyAcsUrl field to given value. + +### HasLegacyAcsUrl + +`func (o *SpDetails) HasLegacyAcsUrl() bool` + +HasLegacyAcsUrl returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/StandardLevel.md b/docs/tools/sdk/go/Reference/V2025/Models/StandardLevel.md new file mode 100644 index 000000000..a6f6afaab --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/StandardLevel.md @@ -0,0 +1,31 @@ +--- +id: v2025-standard-level +title: StandardLevel +pagination_label: StandardLevel +sidebar_label: StandardLevel +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'StandardLevel', 'V2025StandardLevel'] +slug: /tools/sdk/go/v2025/models/standard-level +tags: ['SDK', 'Software Development Kit', 'StandardLevel', 'V2025StandardLevel'] +--- + +# StandardLevel + +## Enum + + +* `FALSE` (value: `"false"`) + +* `FATAL` (value: `"FATAL"`) + +* `ERROR` (value: `"ERROR"`) + +* `WARN` (value: `"WARN"`) + +* `INFO` (value: `"INFO"`) + +* `DEBUG` (value: `"DEBUG"`) + +* `TRACE` (value: `"TRACE"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/StartInvocationInput.md b/docs/tools/sdk/go/Reference/V2025/Models/StartInvocationInput.md new file mode 100644 index 000000000..7251f4df3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/StartInvocationInput.md @@ -0,0 +1,116 @@ +--- +id: v2025-start-invocation-input +title: StartInvocationInput +pagination_label: StartInvocationInput +sidebar_label: StartInvocationInput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'StartInvocationInput', 'V2025StartInvocationInput'] +slug: /tools/sdk/go/v2025/models/start-invocation-input +tags: ['SDK', 'Software Development Kit', 'StartInvocationInput', 'V2025StartInvocationInput'] +--- + +# StartInvocationInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TriggerId** | Pointer to **string** | Trigger ID | [optional] +**Input** | Pointer to **map[string]interface{}** | Trigger input payload. Its schema is defined in the trigger definition. | [optional] +**ContentJson** | Pointer to **map[string]interface{}** | JSON map of invocation metadata | [optional] + +## Methods + +### NewStartInvocationInput + +`func NewStartInvocationInput() *StartInvocationInput` + +NewStartInvocationInput instantiates a new StartInvocationInput 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 + +### NewStartInvocationInputWithDefaults + +`func NewStartInvocationInputWithDefaults() *StartInvocationInput` + +NewStartInvocationInputWithDefaults instantiates a new StartInvocationInput 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 + +### GetTriggerId + +`func (o *StartInvocationInput) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *StartInvocationInput) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *StartInvocationInput) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + +### HasTriggerId + +`func (o *StartInvocationInput) HasTriggerId() bool` + +HasTriggerId returns a boolean if a field has been set. + +### GetInput + +`func (o *StartInvocationInput) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *StartInvocationInput) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *StartInvocationInput) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + +### HasInput + +`func (o *StartInvocationInput) HasInput() bool` + +HasInput returns a boolean if a field has been set. + +### GetContentJson + +`func (o *StartInvocationInput) GetContentJson() map[string]interface{}` + +GetContentJson returns the ContentJson field if non-nil, zero value otherwise. + +### GetContentJsonOk + +`func (o *StartInvocationInput) GetContentJsonOk() (*map[string]interface{}, bool)` + +GetContentJsonOk returns a tuple with the ContentJson field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContentJson + +`func (o *StartInvocationInput) SetContentJson(v map[string]interface{})` + +SetContentJson sets ContentJson field to given value. + +### HasContentJson + +`func (o *StartInvocationInput) HasContentJson() bool` + +HasContentJson returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/StatusResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/StatusResponse.md new file mode 100644 index 000000000..056d51700 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/StatusResponse.md @@ -0,0 +1,168 @@ +--- +id: v2025-status-response +title: StatusResponse +pagination_label: StatusResponse +sidebar_label: StatusResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'StatusResponse', 'V2025StatusResponse'] +slug: /tools/sdk/go/v2025/models/status-response +tags: ['SDK', 'Software Development Kit', 'StatusResponse', 'V2025StatusResponse'] +--- + +# StatusResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the source | [optional] [readonly] +**Name** | Pointer to **string** | Name of the source | [optional] [readonly] +**Status** | Pointer to **string** | The status of the health check. | [optional] [readonly] +**ElapsedMillis** | Pointer to **int32** | The number of milliseconds spent on the entire request. | [optional] [readonly] +**Details** | Pointer to **map[string]interface{}** | The document contains the results of the health check. The schema of this document depends on the type of source used. | [optional] [readonly] + +## Methods + +### NewStatusResponse + +`func NewStatusResponse() *StatusResponse` + +NewStatusResponse instantiates a new StatusResponse 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 + +### NewStatusResponseWithDefaults + +`func NewStatusResponseWithDefaults() *StatusResponse` + +NewStatusResponseWithDefaults instantiates a new StatusResponse 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 + +### GetId + +`func (o *StatusResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *StatusResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *StatusResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *StatusResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *StatusResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *StatusResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *StatusResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *StatusResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *StatusResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *StatusResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *StatusResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *StatusResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetElapsedMillis + +`func (o *StatusResponse) GetElapsedMillis() int32` + +GetElapsedMillis returns the ElapsedMillis field if non-nil, zero value otherwise. + +### GetElapsedMillisOk + +`func (o *StatusResponse) GetElapsedMillisOk() (*int32, bool)` + +GetElapsedMillisOk returns a tuple with the ElapsedMillis field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetElapsedMillis + +`func (o *StatusResponse) SetElapsedMillis(v int32)` + +SetElapsedMillis sets ElapsedMillis field to given value. + +### HasElapsedMillis + +`func (o *StatusResponse) HasElapsedMillis() bool` + +HasElapsedMillis returns a boolean if a field has been set. + +### GetDetails + +`func (o *StatusResponse) GetDetails() map[string]interface{}` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *StatusResponse) GetDetailsOk() (*map[string]interface{}, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *StatusResponse) SetDetails(v map[string]interface{})` + +SetDetails sets Details field to given value. + +### HasDetails + +`func (o *StatusResponse) HasDetails() bool` + +HasDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SubSearchAggregationSpecification.md b/docs/tools/sdk/go/Reference/V2025/Models/SubSearchAggregationSpecification.md new file mode 100644 index 000000000..19a8446a8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SubSearchAggregationSpecification.md @@ -0,0 +1,168 @@ +--- +id: v2025-sub-search-aggregation-specification +title: SubSearchAggregationSpecification +pagination_label: SubSearchAggregationSpecification +sidebar_label: SubSearchAggregationSpecification +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubSearchAggregationSpecification', 'V2025SubSearchAggregationSpecification'] +slug: /tools/sdk/go/v2025/models/sub-search-aggregation-specification +tags: ['SDK', 'Software Development Kit', 'SubSearchAggregationSpecification', 'V2025SubSearchAggregationSpecification'] +--- + +# SubSearchAggregationSpecification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional] +**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional] +**Filter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional] +**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional] +**SubAggregation** | Pointer to [**Aggregations**](aggregations) | | [optional] + +## Methods + +### NewSubSearchAggregationSpecification + +`func NewSubSearchAggregationSpecification() *SubSearchAggregationSpecification` + +NewSubSearchAggregationSpecification instantiates a new SubSearchAggregationSpecification 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 + +### NewSubSearchAggregationSpecificationWithDefaults + +`func NewSubSearchAggregationSpecificationWithDefaults() *SubSearchAggregationSpecification` + +NewSubSearchAggregationSpecificationWithDefaults instantiates a new SubSearchAggregationSpecification 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 + +### GetNested + +`func (o *SubSearchAggregationSpecification) GetNested() NestedAggregation` + +GetNested returns the Nested field if non-nil, zero value otherwise. + +### GetNestedOk + +`func (o *SubSearchAggregationSpecification) GetNestedOk() (*NestedAggregation, bool)` + +GetNestedOk returns a tuple with the Nested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNested + +`func (o *SubSearchAggregationSpecification) SetNested(v NestedAggregation)` + +SetNested sets Nested field to given value. + +### HasNested + +`func (o *SubSearchAggregationSpecification) HasNested() bool` + +HasNested returns a boolean if a field has been set. + +### GetMetric + +`func (o *SubSearchAggregationSpecification) GetMetric() MetricAggregation` + +GetMetric returns the Metric field if non-nil, zero value otherwise. + +### GetMetricOk + +`func (o *SubSearchAggregationSpecification) GetMetricOk() (*MetricAggregation, bool)` + +GetMetricOk returns a tuple with the Metric field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetric + +`func (o *SubSearchAggregationSpecification) SetMetric(v MetricAggregation)` + +SetMetric sets Metric field to given value. + +### HasMetric + +`func (o *SubSearchAggregationSpecification) HasMetric() bool` + +HasMetric returns a boolean if a field has been set. + +### GetFilter + +`func (o *SubSearchAggregationSpecification) GetFilter() FilterAggregation` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *SubSearchAggregationSpecification) GetFilterOk() (*FilterAggregation, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *SubSearchAggregationSpecification) SetFilter(v FilterAggregation)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *SubSearchAggregationSpecification) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### GetBucket + +`func (o *SubSearchAggregationSpecification) GetBucket() BucketAggregation` + +GetBucket returns the Bucket field if non-nil, zero value otherwise. + +### GetBucketOk + +`func (o *SubSearchAggregationSpecification) GetBucketOk() (*BucketAggregation, bool)` + +GetBucketOk returns a tuple with the Bucket field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBucket + +`func (o *SubSearchAggregationSpecification) SetBucket(v BucketAggregation)` + +SetBucket sets Bucket field to given value. + +### HasBucket + +`func (o *SubSearchAggregationSpecification) HasBucket() bool` + +HasBucket returns a boolean if a field has been set. + +### GetSubAggregation + +`func (o *SubSearchAggregationSpecification) GetSubAggregation() Aggregations` + +GetSubAggregation returns the SubAggregation field if non-nil, zero value otherwise. + +### GetSubAggregationOk + +`func (o *SubSearchAggregationSpecification) GetSubAggregationOk() (*Aggregations, bool)` + +GetSubAggregationOk returns a tuple with the SubAggregation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubAggregation + +`func (o *SubSearchAggregationSpecification) SetSubAggregation(v Aggregations)` + +SetSubAggregation sets SubAggregation field to given value. + +### HasSubAggregation + +`func (o *SubSearchAggregationSpecification) HasSubAggregation() bool` + +HasSubAggregation returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Subscription.md b/docs/tools/sdk/go/Reference/V2025/Models/Subscription.md new file mode 100644 index 000000000..417bfeb3b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Subscription.md @@ -0,0 +1,294 @@ +--- +id: v2025-subscription +title: Subscription +pagination_label: Subscription +sidebar_label: Subscription +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Subscription', 'V2025Subscription'] +slug: /tools/sdk/go/v2025/models/subscription +tags: ['SDK', 'Software Development Kit', 'Subscription', 'V2025Subscription'] +--- + +# Subscription + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Subscription ID. | +**Name** | **string** | Subscription name. | +**Description** | Pointer to **string** | Subscription description. | [optional] +**TriggerId** | **string** | ID of trigger subscribed to. | +**TriggerName** | **string** | Trigger name of trigger subscribed to. | +**Type** | [**SubscriptionType**](subscription-type) | | +**ResponseDeadline** | Pointer to **string** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] +**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] +**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] +**Enabled** | **bool** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [default to true] +**Filter** | Pointer to **string** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] + +## Methods + +### NewSubscription + +`func NewSubscription(id string, name string, triggerId string, triggerName string, type_ SubscriptionType, enabled bool, ) *Subscription` + +NewSubscription instantiates a new Subscription 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 + +### NewSubscriptionWithDefaults + +`func NewSubscriptionWithDefaults() *Subscription` + +NewSubscriptionWithDefaults instantiates a new Subscription 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 + +### GetId + +`func (o *Subscription) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Subscription) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Subscription) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *Subscription) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Subscription) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Subscription) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Subscription) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Subscription) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Subscription) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Subscription) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetTriggerId + +`func (o *Subscription) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *Subscription) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *Subscription) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + + +### GetTriggerName + +`func (o *Subscription) GetTriggerName() string` + +GetTriggerName returns the TriggerName field if non-nil, zero value otherwise. + +### GetTriggerNameOk + +`func (o *Subscription) GetTriggerNameOk() (*string, bool)` + +GetTriggerNameOk returns a tuple with the TriggerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerName + +`func (o *Subscription) SetTriggerName(v string)` + +SetTriggerName sets TriggerName field to given value. + + +### GetType + +`func (o *Subscription) GetType() SubscriptionType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Subscription) GetTypeOk() (*SubscriptionType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Subscription) SetType(v SubscriptionType)` + +SetType sets Type field to given value. + + +### GetResponseDeadline + +`func (o *Subscription) GetResponseDeadline() string` + +GetResponseDeadline returns the ResponseDeadline field if non-nil, zero value otherwise. + +### GetResponseDeadlineOk + +`func (o *Subscription) GetResponseDeadlineOk() (*string, bool)` + +GetResponseDeadlineOk returns a tuple with the ResponseDeadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseDeadline + +`func (o *Subscription) SetResponseDeadline(v string)` + +SetResponseDeadline sets ResponseDeadline field to given value. + +### HasResponseDeadline + +`func (o *Subscription) HasResponseDeadline() bool` + +HasResponseDeadline returns a boolean if a field has been set. + +### GetHttpConfig + +`func (o *Subscription) GetHttpConfig() HttpConfig` + +GetHttpConfig returns the HttpConfig field if non-nil, zero value otherwise. + +### GetHttpConfigOk + +`func (o *Subscription) GetHttpConfigOk() (*HttpConfig, bool)` + +GetHttpConfigOk returns a tuple with the HttpConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHttpConfig + +`func (o *Subscription) SetHttpConfig(v HttpConfig)` + +SetHttpConfig sets HttpConfig field to given value. + +### HasHttpConfig + +`func (o *Subscription) HasHttpConfig() bool` + +HasHttpConfig returns a boolean if a field has been set. + +### GetEventBridgeConfig + +`func (o *Subscription) GetEventBridgeConfig() EventBridgeConfig` + +GetEventBridgeConfig returns the EventBridgeConfig field if non-nil, zero value otherwise. + +### GetEventBridgeConfigOk + +`func (o *Subscription) GetEventBridgeConfigOk() (*EventBridgeConfig, bool)` + +GetEventBridgeConfigOk returns a tuple with the EventBridgeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventBridgeConfig + +`func (o *Subscription) SetEventBridgeConfig(v EventBridgeConfig)` + +SetEventBridgeConfig sets EventBridgeConfig field to given value. + +### HasEventBridgeConfig + +`func (o *Subscription) HasEventBridgeConfig() bool` + +HasEventBridgeConfig returns a boolean if a field has been set. + +### GetEnabled + +`func (o *Subscription) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *Subscription) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *Subscription) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetFilter + +`func (o *Subscription) GetFilter() string` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *Subscription) GetFilterOk() (*string, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *Subscription) SetFilter(v string)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *Subscription) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionPatchRequestInner.md b/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionPatchRequestInner.md new file mode 100644 index 000000000..2aa3b0bf2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionPatchRequestInner.md @@ -0,0 +1,106 @@ +--- +id: v2025-subscription-patch-request-inner +title: SubscriptionPatchRequestInner +pagination_label: SubscriptionPatchRequestInner +sidebar_label: SubscriptionPatchRequestInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionPatchRequestInner', 'V2025SubscriptionPatchRequestInner'] +slug: /tools/sdk/go/v2025/models/subscription-patch-request-inner +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInner', 'V2025SubscriptionPatchRequestInner'] +--- + +# SubscriptionPatchRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **string** | The operation to be performed | +**Path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | +**Value** | Pointer to [**SubscriptionPatchRequestInnerValue**](subscription-patch-request-inner-value) | | [optional] + +## Methods + +### NewSubscriptionPatchRequestInner + +`func NewSubscriptionPatchRequestInner(op string, path string, ) *SubscriptionPatchRequestInner` + +NewSubscriptionPatchRequestInner instantiates a new SubscriptionPatchRequestInner 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 + +### NewSubscriptionPatchRequestInnerWithDefaults + +`func NewSubscriptionPatchRequestInnerWithDefaults() *SubscriptionPatchRequestInner` + +NewSubscriptionPatchRequestInnerWithDefaults instantiates a new SubscriptionPatchRequestInner 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 + +### GetOp + +`func (o *SubscriptionPatchRequestInner) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *SubscriptionPatchRequestInner) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *SubscriptionPatchRequestInner) SetOp(v string)` + +SetOp sets Op field to given value. + + +### GetPath + +`func (o *SubscriptionPatchRequestInner) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *SubscriptionPatchRequestInner) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *SubscriptionPatchRequestInner) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetValue + +`func (o *SubscriptionPatchRequestInner) GetValue() SubscriptionPatchRequestInnerValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SubscriptionPatchRequestInner) GetValueOk() (*SubscriptionPatchRequestInnerValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SubscriptionPatchRequestInner) SetValue(v SubscriptionPatchRequestInnerValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SubscriptionPatchRequestInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionPatchRequestInnerValue.md b/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionPatchRequestInnerValue.md new file mode 100644 index 000000000..ce5d996ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionPatchRequestInnerValue.md @@ -0,0 +1,38 @@ +--- +id: v2025-subscription-patch-request-inner-value +title: SubscriptionPatchRequestInnerValue +pagination_label: SubscriptionPatchRequestInnerValue +sidebar_label: SubscriptionPatchRequestInnerValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionPatchRequestInnerValue', 'V2025SubscriptionPatchRequestInnerValue'] +slug: /tools/sdk/go/v2025/models/subscription-patch-request-inner-value +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInnerValue', 'V2025SubscriptionPatchRequestInnerValue'] +--- + +# SubscriptionPatchRequestInnerValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewSubscriptionPatchRequestInnerValue + +`func NewSubscriptionPatchRequestInnerValue() *SubscriptionPatchRequestInnerValue` + +NewSubscriptionPatchRequestInnerValue instantiates a new SubscriptionPatchRequestInnerValue 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 + +### NewSubscriptionPatchRequestInnerValueWithDefaults + +`func NewSubscriptionPatchRequestInnerValueWithDefaults() *SubscriptionPatchRequestInnerValue` + +NewSubscriptionPatchRequestInnerValueWithDefaults instantiates a new SubscriptionPatchRequestInnerValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md b/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md new file mode 100644 index 000000000..1d5a3f458 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md @@ -0,0 +1,38 @@ +--- +id: v2025-subscription-patch-request-inner-value-any-of-inner +title: SubscriptionPatchRequestInnerValueAnyOfInner +pagination_label: SubscriptionPatchRequestInnerValueAnyOfInner +sidebar_label: SubscriptionPatchRequestInnerValueAnyOfInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionPatchRequestInnerValueAnyOfInner', 'V2025SubscriptionPatchRequestInnerValueAnyOfInner'] +slug: /tools/sdk/go/v2025/models/subscription-patch-request-inner-value-any-of-inner +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInnerValueAnyOfInner', 'V2025SubscriptionPatchRequestInnerValueAnyOfInner'] +--- + +# SubscriptionPatchRequestInnerValueAnyOfInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewSubscriptionPatchRequestInnerValueAnyOfInner + +`func NewSubscriptionPatchRequestInnerValueAnyOfInner() *SubscriptionPatchRequestInnerValueAnyOfInner` + +NewSubscriptionPatchRequestInnerValueAnyOfInner instantiates a new SubscriptionPatchRequestInnerValueAnyOfInner 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 + +### NewSubscriptionPatchRequestInnerValueAnyOfInnerWithDefaults + +`func NewSubscriptionPatchRequestInnerValueAnyOfInnerWithDefaults() *SubscriptionPatchRequestInnerValueAnyOfInner` + +NewSubscriptionPatchRequestInnerValueAnyOfInnerWithDefaults instantiates a new SubscriptionPatchRequestInnerValueAnyOfInner 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 + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionPostRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionPostRequest.md new file mode 100644 index 000000000..15e33aae3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionPostRequest.md @@ -0,0 +1,257 @@ +--- +id: v2025-subscription-post-request +title: SubscriptionPostRequest +pagination_label: SubscriptionPostRequest +sidebar_label: SubscriptionPostRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionPostRequest', 'V2025SubscriptionPostRequest'] +slug: /tools/sdk/go/v2025/models/subscription-post-request +tags: ['SDK', 'Software Development Kit', 'SubscriptionPostRequest', 'V2025SubscriptionPostRequest'] +--- + +# SubscriptionPostRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Subscription name. | +**Description** | Pointer to **string** | Subscription description. | [optional] +**TriggerId** | **string** | ID of trigger subscribed to. | +**Type** | [**SubscriptionType**](subscription-type) | | +**ResponseDeadline** | Pointer to **string** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] +**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] +**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] +**Enabled** | Pointer to **bool** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [optional] [default to true] +**Filter** | Pointer to **string** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] + +## Methods + +### NewSubscriptionPostRequest + +`func NewSubscriptionPostRequest(name string, triggerId string, type_ SubscriptionType, ) *SubscriptionPostRequest` + +NewSubscriptionPostRequest instantiates a new SubscriptionPostRequest 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 + +### NewSubscriptionPostRequestWithDefaults + +`func NewSubscriptionPostRequestWithDefaults() *SubscriptionPostRequest` + +NewSubscriptionPostRequestWithDefaults instantiates a new SubscriptionPostRequest 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 + +### GetName + +`func (o *SubscriptionPostRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SubscriptionPostRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SubscriptionPostRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *SubscriptionPostRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SubscriptionPostRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SubscriptionPostRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SubscriptionPostRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetTriggerId + +`func (o *SubscriptionPostRequest) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *SubscriptionPostRequest) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *SubscriptionPostRequest) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + + +### GetType + +`func (o *SubscriptionPostRequest) GetType() SubscriptionType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SubscriptionPostRequest) GetTypeOk() (*SubscriptionType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SubscriptionPostRequest) SetType(v SubscriptionType)` + +SetType sets Type field to given value. + + +### GetResponseDeadline + +`func (o *SubscriptionPostRequest) GetResponseDeadline() string` + +GetResponseDeadline returns the ResponseDeadline field if non-nil, zero value otherwise. + +### GetResponseDeadlineOk + +`func (o *SubscriptionPostRequest) GetResponseDeadlineOk() (*string, bool)` + +GetResponseDeadlineOk returns a tuple with the ResponseDeadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseDeadline + +`func (o *SubscriptionPostRequest) SetResponseDeadline(v string)` + +SetResponseDeadline sets ResponseDeadline field to given value. + +### HasResponseDeadline + +`func (o *SubscriptionPostRequest) HasResponseDeadline() bool` + +HasResponseDeadline returns a boolean if a field has been set. + +### GetHttpConfig + +`func (o *SubscriptionPostRequest) GetHttpConfig() HttpConfig` + +GetHttpConfig returns the HttpConfig field if non-nil, zero value otherwise. + +### GetHttpConfigOk + +`func (o *SubscriptionPostRequest) GetHttpConfigOk() (*HttpConfig, bool)` + +GetHttpConfigOk returns a tuple with the HttpConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHttpConfig + +`func (o *SubscriptionPostRequest) SetHttpConfig(v HttpConfig)` + +SetHttpConfig sets HttpConfig field to given value. + +### HasHttpConfig + +`func (o *SubscriptionPostRequest) HasHttpConfig() bool` + +HasHttpConfig returns a boolean if a field has been set. + +### GetEventBridgeConfig + +`func (o *SubscriptionPostRequest) GetEventBridgeConfig() EventBridgeConfig` + +GetEventBridgeConfig returns the EventBridgeConfig field if non-nil, zero value otherwise. + +### GetEventBridgeConfigOk + +`func (o *SubscriptionPostRequest) GetEventBridgeConfigOk() (*EventBridgeConfig, bool)` + +GetEventBridgeConfigOk returns a tuple with the EventBridgeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventBridgeConfig + +`func (o *SubscriptionPostRequest) SetEventBridgeConfig(v EventBridgeConfig)` + +SetEventBridgeConfig sets EventBridgeConfig field to given value. + +### HasEventBridgeConfig + +`func (o *SubscriptionPostRequest) HasEventBridgeConfig() bool` + +HasEventBridgeConfig returns a boolean if a field has been set. + +### GetEnabled + +`func (o *SubscriptionPostRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *SubscriptionPostRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *SubscriptionPostRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *SubscriptionPostRequest) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetFilter + +`func (o *SubscriptionPostRequest) GetFilter() string` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *SubscriptionPostRequest) GetFilterOk() (*string, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *SubscriptionPostRequest) SetFilter(v string)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *SubscriptionPostRequest) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionPutRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionPutRequest.md new file mode 100644 index 000000000..38ccf02f2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionPutRequest.md @@ -0,0 +1,246 @@ +--- +id: v2025-subscription-put-request +title: SubscriptionPutRequest +pagination_label: SubscriptionPutRequest +sidebar_label: SubscriptionPutRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionPutRequest', 'V2025SubscriptionPutRequest'] +slug: /tools/sdk/go/v2025/models/subscription-put-request +tags: ['SDK', 'Software Development Kit', 'SubscriptionPutRequest', 'V2025SubscriptionPutRequest'] +--- + +# SubscriptionPutRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Subscription name. | [optional] +**Description** | Pointer to **string** | Subscription description. | [optional] +**Type** | Pointer to [**SubscriptionType**](subscription-type) | | [optional] +**ResponseDeadline** | Pointer to **string** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] +**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] +**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] +**Enabled** | Pointer to **bool** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [optional] [default to true] +**Filter** | Pointer to **string** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] + +## Methods + +### NewSubscriptionPutRequest + +`func NewSubscriptionPutRequest() *SubscriptionPutRequest` + +NewSubscriptionPutRequest instantiates a new SubscriptionPutRequest 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 + +### NewSubscriptionPutRequestWithDefaults + +`func NewSubscriptionPutRequestWithDefaults() *SubscriptionPutRequest` + +NewSubscriptionPutRequestWithDefaults instantiates a new SubscriptionPutRequest 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 + +### GetName + +`func (o *SubscriptionPutRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SubscriptionPutRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SubscriptionPutRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SubscriptionPutRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *SubscriptionPutRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SubscriptionPutRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SubscriptionPutRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SubscriptionPutRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetType + +`func (o *SubscriptionPutRequest) GetType() SubscriptionType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SubscriptionPutRequest) GetTypeOk() (*SubscriptionType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SubscriptionPutRequest) SetType(v SubscriptionType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SubscriptionPutRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetResponseDeadline + +`func (o *SubscriptionPutRequest) GetResponseDeadline() string` + +GetResponseDeadline returns the ResponseDeadline field if non-nil, zero value otherwise. + +### GetResponseDeadlineOk + +`func (o *SubscriptionPutRequest) GetResponseDeadlineOk() (*string, bool)` + +GetResponseDeadlineOk returns a tuple with the ResponseDeadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResponseDeadline + +`func (o *SubscriptionPutRequest) SetResponseDeadline(v string)` + +SetResponseDeadline sets ResponseDeadline field to given value. + +### HasResponseDeadline + +`func (o *SubscriptionPutRequest) HasResponseDeadline() bool` + +HasResponseDeadline returns a boolean if a field has been set. + +### GetHttpConfig + +`func (o *SubscriptionPutRequest) GetHttpConfig() HttpConfig` + +GetHttpConfig returns the HttpConfig field if non-nil, zero value otherwise. + +### GetHttpConfigOk + +`func (o *SubscriptionPutRequest) GetHttpConfigOk() (*HttpConfig, bool)` + +GetHttpConfigOk returns a tuple with the HttpConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHttpConfig + +`func (o *SubscriptionPutRequest) SetHttpConfig(v HttpConfig)` + +SetHttpConfig sets HttpConfig field to given value. + +### HasHttpConfig + +`func (o *SubscriptionPutRequest) HasHttpConfig() bool` + +HasHttpConfig returns a boolean if a field has been set. + +### GetEventBridgeConfig + +`func (o *SubscriptionPutRequest) GetEventBridgeConfig() EventBridgeConfig` + +GetEventBridgeConfig returns the EventBridgeConfig field if non-nil, zero value otherwise. + +### GetEventBridgeConfigOk + +`func (o *SubscriptionPutRequest) GetEventBridgeConfigOk() (*EventBridgeConfig, bool)` + +GetEventBridgeConfigOk returns a tuple with the EventBridgeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEventBridgeConfig + +`func (o *SubscriptionPutRequest) SetEventBridgeConfig(v EventBridgeConfig)` + +SetEventBridgeConfig sets EventBridgeConfig field to given value. + +### HasEventBridgeConfig + +`func (o *SubscriptionPutRequest) HasEventBridgeConfig() bool` + +HasEventBridgeConfig returns a boolean if a field has been set. + +### GetEnabled + +`func (o *SubscriptionPutRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *SubscriptionPutRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *SubscriptionPutRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *SubscriptionPutRequest) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetFilter + +`func (o *SubscriptionPutRequest) GetFilter() string` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *SubscriptionPutRequest) GetFilterOk() (*string, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *SubscriptionPutRequest) SetFilter(v string)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *SubscriptionPutRequest) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionType.md b/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionType.md new file mode 100644 index 000000000..6dd72ae3e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SubscriptionType.md @@ -0,0 +1,27 @@ +--- +id: v2025-subscription-type +title: SubscriptionType +pagination_label: SubscriptionType +sidebar_label: SubscriptionType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubscriptionType', 'V2025SubscriptionType'] +slug: /tools/sdk/go/v2025/models/subscription-type +tags: ['SDK', 'Software Development Kit', 'SubscriptionType', 'V2025SubscriptionType'] +--- + +# SubscriptionType + +## Enum + + +* `HTTP` (value: `"HTTP"`) + +* `EVENTBRIDGE` (value: `"EVENTBRIDGE"`) + +* `INLINE` (value: `"INLINE"`) + +* `SCRIPT` (value: `"SCRIPT"`) + +* `WORKFLOW` (value: `"WORKFLOW"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TaggedObject.md b/docs/tools/sdk/go/Reference/V2025/Models/TaggedObject.md new file mode 100644 index 000000000..d2e908e47 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TaggedObject.md @@ -0,0 +1,90 @@ +--- +id: v2025-tagged-object +title: TaggedObject +pagination_label: TaggedObject +sidebar_label: TaggedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaggedObject', 'V2025TaggedObject'] +slug: /tools/sdk/go/v2025/models/tagged-object +tags: ['SDK', 'Software Development Kit', 'TaggedObject', 'V2025TaggedObject'] +--- + +# TaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRef** | Pointer to [**TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]string** | Labels to be applied to an Object | [optional] + +## Methods + +### NewTaggedObject + +`func NewTaggedObject() *TaggedObject` + +NewTaggedObject instantiates a new TaggedObject 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 + +### NewTaggedObjectWithDefaults + +`func NewTaggedObjectWithDefaults() *TaggedObject` + +NewTaggedObjectWithDefaults instantiates a new TaggedObject 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 + +### GetObjectRef + +`func (o *TaggedObject) GetObjectRef() TaggedObjectDto` + +GetObjectRef returns the ObjectRef field if non-nil, zero value otherwise. + +### GetObjectRefOk + +`func (o *TaggedObject) GetObjectRefOk() (*TaggedObjectDto, bool)` + +GetObjectRefOk returns a tuple with the ObjectRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectRef + +`func (o *TaggedObject) SetObjectRef(v TaggedObjectDto)` + +SetObjectRef sets ObjectRef field to given value. + +### HasObjectRef + +`func (o *TaggedObject) HasObjectRef() bool` + +HasObjectRef returns a boolean if a field has been set. + +### GetTags + +`func (o *TaggedObject) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *TaggedObject) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *TaggedObject) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *TaggedObject) HasTags() bool` + +HasTags returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TaggedObjectDto.md b/docs/tools/sdk/go/Reference/V2025/Models/TaggedObjectDto.md new file mode 100644 index 000000000..a39b3c0bc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TaggedObjectDto.md @@ -0,0 +1,126 @@ +--- +id: v2025-tagged-object-dto +title: TaggedObjectDto +pagination_label: TaggedObjectDto +sidebar_label: TaggedObjectDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaggedObjectDto', 'V2025TaggedObjectDto'] +slug: /tools/sdk/go/v2025/models/tagged-object-dto +tags: ['SDK', 'Software Development Kit', 'TaggedObjectDto', 'V2025TaggedObjectDto'] +--- + +# TaggedObjectDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type | [optional] +**Id** | Pointer to **string** | ID of the object this reference applies to | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the object this reference applies to | [optional] + +## Methods + +### NewTaggedObjectDto + +`func NewTaggedObjectDto() *TaggedObjectDto` + +NewTaggedObjectDto instantiates a new TaggedObjectDto 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 + +### NewTaggedObjectDtoWithDefaults + +`func NewTaggedObjectDtoWithDefaults() *TaggedObjectDto` + +NewTaggedObjectDtoWithDefaults instantiates a new TaggedObjectDto 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 + +### GetType + +`func (o *TaggedObjectDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaggedObjectDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaggedObjectDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaggedObjectDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *TaggedObjectDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaggedObjectDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaggedObjectDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaggedObjectDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TaggedObjectDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaggedObjectDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaggedObjectDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TaggedObjectDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *TaggedObjectDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *TaggedObjectDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Target.md b/docs/tools/sdk/go/Reference/V2025/Models/Target.md new file mode 100644 index 000000000..fdc05df2c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Target.md @@ -0,0 +1,126 @@ +--- +id: v2025-target +title: Target +pagination_label: Target +sidebar_label: Target +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Target', 'V2025Target'] +slug: /tools/sdk/go/v2025/models/target +tags: ['SDK', 'Software Development Kit', 'Target', 'V2025Target'] +--- + +# Target + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Target ID | [optional] +**Type** | Pointer to **NullableString** | Target type | [optional] +**Name** | Pointer to **string** | Target name | [optional] + +## Methods + +### NewTarget + +`func NewTarget() *Target` + +NewTarget instantiates a new Target 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 + +### NewTargetWithDefaults + +`func NewTargetWithDefaults() *Target` + +NewTargetWithDefaults instantiates a new Target 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 + +### GetId + +`func (o *Target) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Target) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Target) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Target) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *Target) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Target) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Target) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Target) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *Target) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *Target) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetName + +`func (o *Target) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Target) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Target) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Target) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TaskDefinitionSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/TaskDefinitionSummary.md new file mode 100644 index 000000000..ebb6905cb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TaskDefinitionSummary.md @@ -0,0 +1,184 @@ +--- +id: v2025-task-definition-summary +title: TaskDefinitionSummary +pagination_label: TaskDefinitionSummary +sidebar_label: TaskDefinitionSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskDefinitionSummary', 'V2025TaskDefinitionSummary'] +slug: /tools/sdk/go/v2025/models/task-definition-summary +tags: ['SDK', 'Software Development Kit', 'TaskDefinitionSummary', 'V2025TaskDefinitionSummary'] +--- + +# TaskDefinitionSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | System-generated unique ID of the TaskDefinition | +**UniqueName** | **string** | Name of the TaskDefinition | +**Description** | **NullableString** | Description of the TaskDefinition | +**ParentName** | **string** | Name of the parent of the TaskDefinition | +**Executor** | **NullableString** | Executor of the TaskDefinition | +**Arguments** | **map[string]interface{}** | Formal parameters of the TaskDefinition, without values | + +## Methods + +### NewTaskDefinitionSummary + +`func NewTaskDefinitionSummary(id string, uniqueName string, description NullableString, parentName string, executor NullableString, arguments map[string]interface{}, ) *TaskDefinitionSummary` + +NewTaskDefinitionSummary instantiates a new TaskDefinitionSummary 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 + +### NewTaskDefinitionSummaryWithDefaults + +`func NewTaskDefinitionSummaryWithDefaults() *TaskDefinitionSummary` + +NewTaskDefinitionSummaryWithDefaults instantiates a new TaskDefinitionSummary 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 + +### GetId + +`func (o *TaskDefinitionSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskDefinitionSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskDefinitionSummary) SetId(v string)` + +SetId sets Id field to given value. + + +### GetUniqueName + +`func (o *TaskDefinitionSummary) GetUniqueName() string` + +GetUniqueName returns the UniqueName field if non-nil, zero value otherwise. + +### GetUniqueNameOk + +`func (o *TaskDefinitionSummary) GetUniqueNameOk() (*string, bool)` + +GetUniqueNameOk returns a tuple with the UniqueName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUniqueName + +`func (o *TaskDefinitionSummary) SetUniqueName(v string)` + +SetUniqueName sets UniqueName field to given value. + + +### GetDescription + +`func (o *TaskDefinitionSummary) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TaskDefinitionSummary) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TaskDefinitionSummary) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *TaskDefinitionSummary) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *TaskDefinitionSummary) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetParentName + +`func (o *TaskDefinitionSummary) GetParentName() string` + +GetParentName returns the ParentName field if non-nil, zero value otherwise. + +### GetParentNameOk + +`func (o *TaskDefinitionSummary) GetParentNameOk() (*string, bool)` + +GetParentNameOk returns a tuple with the ParentName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentName + +`func (o *TaskDefinitionSummary) SetParentName(v string)` + +SetParentName sets ParentName field to given value. + + +### GetExecutor + +`func (o *TaskDefinitionSummary) GetExecutor() string` + +GetExecutor returns the Executor field if non-nil, zero value otherwise. + +### GetExecutorOk + +`func (o *TaskDefinitionSummary) GetExecutorOk() (*string, bool)` + +GetExecutorOk returns a tuple with the Executor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExecutor + +`func (o *TaskDefinitionSummary) SetExecutor(v string)` + +SetExecutor sets Executor field to given value. + + +### SetExecutorNil + +`func (o *TaskDefinitionSummary) SetExecutorNil(b bool)` + + SetExecutorNil sets the value for Executor to be an explicit nil + +### UnsetExecutor +`func (o *TaskDefinitionSummary) UnsetExecutor()` + +UnsetExecutor ensures that no value is present for Executor, not even an explicit nil +### GetArguments + +`func (o *TaskDefinitionSummary) GetArguments() map[string]interface{}` + +GetArguments returns the Arguments field if non-nil, zero value otherwise. + +### GetArgumentsOk + +`func (o *TaskDefinitionSummary) GetArgumentsOk() (*map[string]interface{}, bool)` + +GetArgumentsOk returns a tuple with the Arguments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArguments + +`func (o *TaskDefinitionSummary) SetArguments(v map[string]interface{})` + +SetArguments sets Arguments field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TaskResultDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/TaskResultDetails.md new file mode 100644 index 000000000..781b58585 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TaskResultDetails.md @@ -0,0 +1,452 @@ +--- +id: v2025-task-result-details +title: TaskResultDetails +pagination_label: TaskResultDetails +sidebar_label: TaskResultDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultDetails', 'V2025TaskResultDetails'] +slug: /tools/sdk/go/v2025/models/task-result-details +tags: ['SDK', 'Software Development Kit', 'TaskResultDetails', 'V2025TaskResultDetails'] +--- + +# TaskResultDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task. | [optional] +**Id** | Pointer to **string** | Unique task definition identifier. | [optional] +**ReportType** | Pointer to **string** | Use this property to define what report should be processed in the RDE service. | [optional] +**Description** | Pointer to **string** | Description of the report purpose and/or contents. | [optional] +**ParentName** | Pointer to **NullableString** | Name of the parent task/report if exists. | [optional] +**Launcher** | Pointer to **string** | Name of the report processing initiator. | [optional] +**Created** | Pointer to **SailPointTime** | Report creation date | [optional] +**Launched** | Pointer to **NullableTime** | Report start date | [optional] +**Completed** | Pointer to **NullableTime** | Report completion date | [optional] +**CompletionStatus** | Pointer to **NullableString** | Report completion status. | [optional] +**Messages** | Pointer to [**[]TaskResultDetailsMessagesInner**](task-result-details-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**Returns** | Pointer to [**[]TaskResultDetailsReturnsInner**](task-result-details-returns-inner) | Task definition results, if necessary. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Extra attributes map(dictionary) needed for the report. | [optional] +**Progress** | Pointer to **NullableString** | Current report state. | [optional] + +## Methods + +### NewTaskResultDetails + +`func NewTaskResultDetails() *TaskResultDetails` + +NewTaskResultDetails instantiates a new TaskResultDetails 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 + +### NewTaskResultDetailsWithDefaults + +`func NewTaskResultDetailsWithDefaults() *TaskResultDetails` + +NewTaskResultDetailsWithDefaults instantiates a new TaskResultDetails 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 + +### GetType + +`func (o *TaskResultDetails) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskResultDetails) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskResultDetails) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaskResultDetails) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *TaskResultDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskResultDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskResultDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaskResultDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetReportType + +`func (o *TaskResultDetails) GetReportType() string` + +GetReportType returns the ReportType field if non-nil, zero value otherwise. + +### GetReportTypeOk + +`func (o *TaskResultDetails) GetReportTypeOk() (*string, bool)` + +GetReportTypeOk returns a tuple with the ReportType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportType + +`func (o *TaskResultDetails) SetReportType(v string)` + +SetReportType sets ReportType field to given value. + +### HasReportType + +`func (o *TaskResultDetails) HasReportType() bool` + +HasReportType returns a boolean if a field has been set. + +### GetDescription + +`func (o *TaskResultDetails) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TaskResultDetails) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TaskResultDetails) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *TaskResultDetails) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetParentName + +`func (o *TaskResultDetails) GetParentName() string` + +GetParentName returns the ParentName field if non-nil, zero value otherwise. + +### GetParentNameOk + +`func (o *TaskResultDetails) GetParentNameOk() (*string, bool)` + +GetParentNameOk returns a tuple with the ParentName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentName + +`func (o *TaskResultDetails) SetParentName(v string)` + +SetParentName sets ParentName field to given value. + +### HasParentName + +`func (o *TaskResultDetails) HasParentName() bool` + +HasParentName returns a boolean if a field has been set. + +### SetParentNameNil + +`func (o *TaskResultDetails) SetParentNameNil(b bool)` + + SetParentNameNil sets the value for ParentName to be an explicit nil + +### UnsetParentName +`func (o *TaskResultDetails) UnsetParentName()` + +UnsetParentName ensures that no value is present for ParentName, not even an explicit nil +### GetLauncher + +`func (o *TaskResultDetails) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *TaskResultDetails) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *TaskResultDetails) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + +### HasLauncher + +`func (o *TaskResultDetails) HasLauncher() bool` + +HasLauncher returns a boolean if a field has been set. + +### GetCreated + +`func (o *TaskResultDetails) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *TaskResultDetails) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *TaskResultDetails) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *TaskResultDetails) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetLaunched + +`func (o *TaskResultDetails) GetLaunched() SailPointTime` + +GetLaunched returns the Launched field if non-nil, zero value otherwise. + +### GetLaunchedOk + +`func (o *TaskResultDetails) GetLaunchedOk() (*SailPointTime, bool)` + +GetLaunchedOk returns a tuple with the Launched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunched + +`func (o *TaskResultDetails) SetLaunched(v SailPointTime)` + +SetLaunched sets Launched field to given value. + +### HasLaunched + +`func (o *TaskResultDetails) HasLaunched() bool` + +HasLaunched returns a boolean if a field has been set. + +### SetLaunchedNil + +`func (o *TaskResultDetails) SetLaunchedNil(b bool)` + + SetLaunchedNil sets the value for Launched to be an explicit nil + +### UnsetLaunched +`func (o *TaskResultDetails) UnsetLaunched()` + +UnsetLaunched ensures that no value is present for Launched, not even an explicit nil +### GetCompleted + +`func (o *TaskResultDetails) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *TaskResultDetails) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *TaskResultDetails) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *TaskResultDetails) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *TaskResultDetails) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *TaskResultDetails) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetCompletionStatus + +`func (o *TaskResultDetails) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *TaskResultDetails) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *TaskResultDetails) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *TaskResultDetails) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + +### SetCompletionStatusNil + +`func (o *TaskResultDetails) SetCompletionStatusNil(b bool)` + + SetCompletionStatusNil sets the value for CompletionStatus to be an explicit nil + +### UnsetCompletionStatus +`func (o *TaskResultDetails) UnsetCompletionStatus()` + +UnsetCompletionStatus ensures that no value is present for CompletionStatus, not even an explicit nil +### GetMessages + +`func (o *TaskResultDetails) GetMessages() []TaskResultDetailsMessagesInner` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *TaskResultDetails) GetMessagesOk() (*[]TaskResultDetailsMessagesInner, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *TaskResultDetails) SetMessages(v []TaskResultDetailsMessagesInner)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *TaskResultDetails) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetReturns + +`func (o *TaskResultDetails) GetReturns() []TaskResultDetailsReturnsInner` + +GetReturns returns the Returns field if non-nil, zero value otherwise. + +### GetReturnsOk + +`func (o *TaskResultDetails) GetReturnsOk() (*[]TaskResultDetailsReturnsInner, bool)` + +GetReturnsOk returns a tuple with the Returns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReturns + +`func (o *TaskResultDetails) SetReturns(v []TaskResultDetailsReturnsInner)` + +SetReturns sets Returns field to given value. + +### HasReturns + +`func (o *TaskResultDetails) HasReturns() bool` + +HasReturns returns a boolean if a field has been set. + +### GetAttributes + +`func (o *TaskResultDetails) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TaskResultDetails) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TaskResultDetails) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *TaskResultDetails) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetProgress + +`func (o *TaskResultDetails) GetProgress() string` + +GetProgress returns the Progress field if non-nil, zero value otherwise. + +### GetProgressOk + +`func (o *TaskResultDetails) GetProgressOk() (*string, bool)` + +GetProgressOk returns a tuple with the Progress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProgress + +`func (o *TaskResultDetails) SetProgress(v string)` + +SetProgress sets Progress field to given value. + +### HasProgress + +`func (o *TaskResultDetails) HasProgress() bool` + +HasProgress returns a boolean if a field has been set. + +### SetProgressNil + +`func (o *TaskResultDetails) SetProgressNil(b bool)` + + SetProgressNil sets the value for Progress to be an explicit nil + +### UnsetProgress +`func (o *TaskResultDetails) UnsetProgress()` + +UnsetProgress ensures that no value is present for Progress, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TaskResultDetailsMessagesInner.md b/docs/tools/sdk/go/Reference/V2025/Models/TaskResultDetailsMessagesInner.md new file mode 100644 index 000000000..cb6cbae59 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TaskResultDetailsMessagesInner.md @@ -0,0 +1,168 @@ +--- +id: v2025-task-result-details-messages-inner +title: TaskResultDetailsMessagesInner +pagination_label: TaskResultDetailsMessagesInner +sidebar_label: TaskResultDetailsMessagesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultDetailsMessagesInner', 'V2025TaskResultDetailsMessagesInner'] +slug: /tools/sdk/go/v2025/models/task-result-details-messages-inner +tags: ['SDK', 'Software Development Kit', 'TaskResultDetailsMessagesInner', 'V2025TaskResultDetailsMessagesInner'] +--- + +# TaskResultDetailsMessagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the message. | [optional] +**Error** | Pointer to **bool** | Flag whether message is an error. | [optional] [default to false] +**Warning** | Pointer to **bool** | Flag whether message is a warning. | [optional] [default to false] +**Key** | Pointer to **string** | Message string identifier. | [optional] +**LocalizedText** | Pointer to **string** | Message context with the locale based language. | [optional] + +## Methods + +### NewTaskResultDetailsMessagesInner + +`func NewTaskResultDetailsMessagesInner() *TaskResultDetailsMessagesInner` + +NewTaskResultDetailsMessagesInner instantiates a new TaskResultDetailsMessagesInner 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 + +### NewTaskResultDetailsMessagesInnerWithDefaults + +`func NewTaskResultDetailsMessagesInnerWithDefaults() *TaskResultDetailsMessagesInner` + +NewTaskResultDetailsMessagesInnerWithDefaults instantiates a new TaskResultDetailsMessagesInner 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 + +### GetType + +`func (o *TaskResultDetailsMessagesInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskResultDetailsMessagesInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskResultDetailsMessagesInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaskResultDetailsMessagesInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetError + +`func (o *TaskResultDetailsMessagesInner) GetError() bool` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *TaskResultDetailsMessagesInner) GetErrorOk() (*bool, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *TaskResultDetailsMessagesInner) SetError(v bool)` + +SetError sets Error field to given value. + +### HasError + +`func (o *TaskResultDetailsMessagesInner) HasError() bool` + +HasError returns a boolean if a field has been set. + +### GetWarning + +`func (o *TaskResultDetailsMessagesInner) GetWarning() bool` + +GetWarning returns the Warning field if non-nil, zero value otherwise. + +### GetWarningOk + +`func (o *TaskResultDetailsMessagesInner) GetWarningOk() (*bool, bool)` + +GetWarningOk returns a tuple with the Warning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarning + +`func (o *TaskResultDetailsMessagesInner) SetWarning(v bool)` + +SetWarning sets Warning field to given value. + +### HasWarning + +`func (o *TaskResultDetailsMessagesInner) HasWarning() bool` + +HasWarning returns a boolean if a field has been set. + +### GetKey + +`func (o *TaskResultDetailsMessagesInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TaskResultDetailsMessagesInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TaskResultDetailsMessagesInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *TaskResultDetailsMessagesInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetLocalizedText + +`func (o *TaskResultDetailsMessagesInner) GetLocalizedText() string` + +GetLocalizedText returns the LocalizedText field if non-nil, zero value otherwise. + +### GetLocalizedTextOk + +`func (o *TaskResultDetailsMessagesInner) GetLocalizedTextOk() (*string, bool)` + +GetLocalizedTextOk returns a tuple with the LocalizedText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizedText + +`func (o *TaskResultDetailsMessagesInner) SetLocalizedText(v string)` + +SetLocalizedText sets LocalizedText field to given value. + +### HasLocalizedText + +`func (o *TaskResultDetailsMessagesInner) HasLocalizedText() bool` + +HasLocalizedText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TaskResultDetailsReturnsInner.md b/docs/tools/sdk/go/Reference/V2025/Models/TaskResultDetailsReturnsInner.md new file mode 100644 index 000000000..d608fd276 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TaskResultDetailsReturnsInner.md @@ -0,0 +1,90 @@ +--- +id: v2025-task-result-details-returns-inner +title: TaskResultDetailsReturnsInner +pagination_label: TaskResultDetailsReturnsInner +sidebar_label: TaskResultDetailsReturnsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultDetailsReturnsInner', 'V2025TaskResultDetailsReturnsInner'] +slug: /tools/sdk/go/v2025/models/task-result-details-returns-inner +tags: ['SDK', 'Software Development Kit', 'TaskResultDetailsReturnsInner', 'V2025TaskResultDetailsReturnsInner'] +--- + +# TaskResultDetailsReturnsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayLabel** | Pointer to **string** | Attribute description. | [optional] +**AttributeName** | Pointer to **string** | System or database attribute name. | [optional] + +## Methods + +### NewTaskResultDetailsReturnsInner + +`func NewTaskResultDetailsReturnsInner() *TaskResultDetailsReturnsInner` + +NewTaskResultDetailsReturnsInner instantiates a new TaskResultDetailsReturnsInner 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 + +### NewTaskResultDetailsReturnsInnerWithDefaults + +`func NewTaskResultDetailsReturnsInnerWithDefaults() *TaskResultDetailsReturnsInner` + +NewTaskResultDetailsReturnsInnerWithDefaults instantiates a new TaskResultDetailsReturnsInner 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 + +### GetDisplayLabel + +`func (o *TaskResultDetailsReturnsInner) GetDisplayLabel() string` + +GetDisplayLabel returns the DisplayLabel field if non-nil, zero value otherwise. + +### GetDisplayLabelOk + +`func (o *TaskResultDetailsReturnsInner) GetDisplayLabelOk() (*string, bool)` + +GetDisplayLabelOk returns a tuple with the DisplayLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayLabel + +`func (o *TaskResultDetailsReturnsInner) SetDisplayLabel(v string)` + +SetDisplayLabel sets DisplayLabel field to given value. + +### HasDisplayLabel + +`func (o *TaskResultDetailsReturnsInner) HasDisplayLabel() bool` + +HasDisplayLabel returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *TaskResultDetailsReturnsInner) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *TaskResultDetailsReturnsInner) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *TaskResultDetailsReturnsInner) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *TaskResultDetailsReturnsInner) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TaskResultDto.md b/docs/tools/sdk/go/Reference/V2025/Models/TaskResultDto.md new file mode 100644 index 000000000..5eb7b750a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TaskResultDto.md @@ -0,0 +1,126 @@ +--- +id: v2025-task-result-dto +title: TaskResultDto +pagination_label: TaskResultDto +sidebar_label: TaskResultDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultDto', 'V2025TaskResultDto'] +slug: /tools/sdk/go/v2025/models/task-result-dto +tags: ['SDK', 'Software Development Kit', 'TaskResultDto', 'V2025TaskResultDto'] +--- + +# TaskResultDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Task result DTO type. | [optional] +**Id** | Pointer to **string** | Task result ID. | [optional] +**Name** | Pointer to **NullableString** | Task result display name. | [optional] + +## Methods + +### NewTaskResultDto + +`func NewTaskResultDto() *TaskResultDto` + +NewTaskResultDto instantiates a new TaskResultDto 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 + +### NewTaskResultDtoWithDefaults + +`func NewTaskResultDtoWithDefaults() *TaskResultDto` + +NewTaskResultDtoWithDefaults instantiates a new TaskResultDto 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 + +### GetType + +`func (o *TaskResultDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskResultDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskResultDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaskResultDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *TaskResultDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskResultDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskResultDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaskResultDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TaskResultDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaskResultDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaskResultDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TaskResultDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *TaskResultDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *TaskResultDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TaskResultResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/TaskResultResponse.md new file mode 100644 index 000000000..f887479e8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TaskResultResponse.md @@ -0,0 +1,116 @@ +--- +id: v2025-task-result-response +title: TaskResultResponse +pagination_label: TaskResultResponse +sidebar_label: TaskResultResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultResponse', 'V2025TaskResultResponse'] +slug: /tools/sdk/go/v2025/models/task-result-response +tags: ['SDK', 'Software Development Kit', 'TaskResultResponse', 'V2025TaskResultResponse'] +--- + +# TaskResultResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | the type of response reference | [optional] +**Id** | Pointer to **string** | the task ID | [optional] +**Name** | Pointer to **string** | the task name (not used in this endpoint, always null) | [optional] + +## Methods + +### NewTaskResultResponse + +`func NewTaskResultResponse() *TaskResultResponse` + +NewTaskResultResponse instantiates a new TaskResultResponse 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 + +### NewTaskResultResponseWithDefaults + +`func NewTaskResultResponseWithDefaults() *TaskResultResponse` + +NewTaskResultResponseWithDefaults instantiates a new TaskResultResponse 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 + +### GetType + +`func (o *TaskResultResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskResultResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskResultResponse) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaskResultResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *TaskResultResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskResultResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskResultResponse) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaskResultResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TaskResultResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaskResultResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaskResultResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TaskResultResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TaskResultSimplified.md b/docs/tools/sdk/go/Reference/V2025/Models/TaskResultSimplified.md new file mode 100644 index 000000000..3b941d3c0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TaskResultSimplified.md @@ -0,0 +1,220 @@ +--- +id: v2025-task-result-simplified +title: TaskResultSimplified +pagination_label: TaskResultSimplified +sidebar_label: TaskResultSimplified +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultSimplified', 'V2025TaskResultSimplified'] +slug: /tools/sdk/go/v2025/models/task-result-simplified +tags: ['SDK', 'Software Development Kit', 'TaskResultSimplified', 'V2025TaskResultSimplified'] +--- + +# TaskResultSimplified + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Task identifier | [optional] +**Name** | Pointer to **string** | Task name | [optional] +**Description** | Pointer to **string** | Task description | [optional] +**Launcher** | Pointer to **string** | User or process who launched the task | [optional] +**Completed** | Pointer to **SailPointTime** | Date time of completion | [optional] +**Launched** | Pointer to **SailPointTime** | Date time when the task was launched | [optional] +**CompletionStatus** | Pointer to **string** | Task result status | [optional] + +## Methods + +### NewTaskResultSimplified + +`func NewTaskResultSimplified() *TaskResultSimplified` + +NewTaskResultSimplified instantiates a new TaskResultSimplified 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 + +### NewTaskResultSimplifiedWithDefaults + +`func NewTaskResultSimplifiedWithDefaults() *TaskResultSimplified` + +NewTaskResultSimplifiedWithDefaults instantiates a new TaskResultSimplified 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 + +### GetId + +`func (o *TaskResultSimplified) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskResultSimplified) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskResultSimplified) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaskResultSimplified) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TaskResultSimplified) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaskResultSimplified) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaskResultSimplified) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TaskResultSimplified) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *TaskResultSimplified) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TaskResultSimplified) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TaskResultSimplified) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *TaskResultSimplified) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetLauncher + +`func (o *TaskResultSimplified) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *TaskResultSimplified) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *TaskResultSimplified) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + +### HasLauncher + +`func (o *TaskResultSimplified) HasLauncher() bool` + +HasLauncher returns a boolean if a field has been set. + +### GetCompleted + +`func (o *TaskResultSimplified) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *TaskResultSimplified) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *TaskResultSimplified) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *TaskResultSimplified) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetLaunched + +`func (o *TaskResultSimplified) GetLaunched() SailPointTime` + +GetLaunched returns the Launched field if non-nil, zero value otherwise. + +### GetLaunchedOk + +`func (o *TaskResultSimplified) GetLaunchedOk() (*SailPointTime, bool)` + +GetLaunchedOk returns a tuple with the Launched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunched + +`func (o *TaskResultSimplified) SetLaunched(v SailPointTime)` + +SetLaunched sets Launched field to given value. + +### HasLaunched + +`func (o *TaskResultSimplified) HasLaunched() bool` + +HasLaunched returns a boolean if a field has been set. + +### GetCompletionStatus + +`func (o *TaskResultSimplified) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *TaskResultSimplified) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *TaskResultSimplified) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *TaskResultSimplified) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TaskReturnDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/TaskReturnDetails.md new file mode 100644 index 000000000..b05ec94ac --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TaskReturnDetails.md @@ -0,0 +1,80 @@ +--- +id: v2025-task-return-details +title: TaskReturnDetails +pagination_label: TaskReturnDetails +sidebar_label: TaskReturnDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskReturnDetails', 'V2025TaskReturnDetails'] +slug: /tools/sdk/go/v2025/models/task-return-details +tags: ['SDK', 'Software Development Kit', 'TaskReturnDetails', 'V2025TaskReturnDetails'] +--- + +# TaskReturnDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Display name of the TaskReturnDetails | +**AttributeName** | **string** | Attribute the TaskReturnDetails is for | + +## Methods + +### NewTaskReturnDetails + +`func NewTaskReturnDetails(name string, attributeName string, ) *TaskReturnDetails` + +NewTaskReturnDetails instantiates a new TaskReturnDetails 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 + +### NewTaskReturnDetailsWithDefaults + +`func NewTaskReturnDetailsWithDefaults() *TaskReturnDetails` + +NewTaskReturnDetailsWithDefaults instantiates a new TaskReturnDetails 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 + +### GetName + +`func (o *TaskReturnDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaskReturnDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaskReturnDetails) SetName(v string)` + +SetName sets Name field to given value. + + +### GetAttributeName + +`func (o *TaskReturnDetails) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *TaskReturnDetails) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *TaskReturnDetails) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TaskStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/TaskStatus.md new file mode 100644 index 000000000..29dd3481a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TaskStatus.md @@ -0,0 +1,486 @@ +--- +id: v2025-task-status +title: TaskStatus +pagination_label: TaskStatus +sidebar_label: TaskStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskStatus', 'V2025TaskStatus'] +slug: /tools/sdk/go/v2025/models/task-status +tags: ['SDK', 'Software Development Kit', 'TaskStatus', 'V2025TaskStatus'] +--- + +# TaskStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | System-generated unique ID of the task this TaskStatus represents | +**Type** | **string** | Type of task this TaskStatus represents | +**UniqueName** | **string** | Name of the task this TaskStatus represents | +**Description** | **string** | Description of the task this TaskStatus represents | +**ParentName** | **NullableString** | Name of the parent of the task this TaskStatus represents | +**Launcher** | **string** | Service to execute the task this TaskStatus represents | +**Target** | Pointer to [**NullableTarget**](target) | | [optional] +**Created** | **SailPointTime** | Creation date of the task this TaskStatus represents | +**Modified** | **SailPointTime** | Last modification date of the task this TaskStatus represents | +**Launched** | **NullableTime** | Launch date of the task this TaskStatus represents | +**Completed** | **NullableTime** | Completion date of the task this TaskStatus represents | +**CompletionStatus** | **NullableString** | Completion status of the task this TaskStatus represents | +**Messages** | [**[]TaskStatusMessage**](task-status-message) | Messages associated with the task this TaskStatus represents | +**Returns** | [**[]TaskReturnDetails**](task-return-details) | Return values from the task this TaskStatus represents | +**Attributes** | **map[string]interface{}** | Attributes of the task this TaskStatus represents | +**Progress** | **NullableString** | Current progress of the task this TaskStatus represents | +**PercentComplete** | **int32** | Current percentage completion of the task this TaskStatus represents | +**TaskDefinitionSummary** | Pointer to [**TaskDefinitionSummary**](task-definition-summary) | | [optional] + +## Methods + +### NewTaskStatus + +`func NewTaskStatus(id string, type_ string, uniqueName string, description string, parentName NullableString, launcher string, created SailPointTime, modified SailPointTime, launched NullableTime, completed NullableTime, completionStatus NullableString, messages []TaskStatusMessage, returns []TaskReturnDetails, attributes map[string]interface{}, progress NullableString, percentComplete int32, ) *TaskStatus` + +NewTaskStatus instantiates a new TaskStatus 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 + +### NewTaskStatusWithDefaults + +`func NewTaskStatusWithDefaults() *TaskStatus` + +NewTaskStatusWithDefaults instantiates a new TaskStatus 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 + +### GetId + +`func (o *TaskStatus) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskStatus) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskStatus) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *TaskStatus) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskStatus) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskStatus) SetType(v string)` + +SetType sets Type field to given value. + + +### GetUniqueName + +`func (o *TaskStatus) GetUniqueName() string` + +GetUniqueName returns the UniqueName field if non-nil, zero value otherwise. + +### GetUniqueNameOk + +`func (o *TaskStatus) GetUniqueNameOk() (*string, bool)` + +GetUniqueNameOk returns a tuple with the UniqueName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUniqueName + +`func (o *TaskStatus) SetUniqueName(v string)` + +SetUniqueName sets UniqueName field to given value. + + +### GetDescription + +`func (o *TaskStatus) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TaskStatus) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TaskStatus) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetParentName + +`func (o *TaskStatus) GetParentName() string` + +GetParentName returns the ParentName field if non-nil, zero value otherwise. + +### GetParentNameOk + +`func (o *TaskStatus) GetParentNameOk() (*string, bool)` + +GetParentNameOk returns a tuple with the ParentName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentName + +`func (o *TaskStatus) SetParentName(v string)` + +SetParentName sets ParentName field to given value. + + +### SetParentNameNil + +`func (o *TaskStatus) SetParentNameNil(b bool)` + + SetParentNameNil sets the value for ParentName to be an explicit nil + +### UnsetParentName +`func (o *TaskStatus) UnsetParentName()` + +UnsetParentName ensures that no value is present for ParentName, not even an explicit nil +### GetLauncher + +`func (o *TaskStatus) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *TaskStatus) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *TaskStatus) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + + +### GetTarget + +`func (o *TaskStatus) GetTarget() Target` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *TaskStatus) GetTargetOk() (*Target, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *TaskStatus) SetTarget(v Target)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *TaskStatus) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + +### SetTargetNil + +`func (o *TaskStatus) SetTargetNil(b bool)` + + SetTargetNil sets the value for Target to be an explicit nil + +### UnsetTarget +`func (o *TaskStatus) UnsetTarget()` + +UnsetTarget ensures that no value is present for Target, not even an explicit nil +### GetCreated + +`func (o *TaskStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *TaskStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *TaskStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *TaskStatus) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *TaskStatus) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *TaskStatus) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetLaunched + +`func (o *TaskStatus) GetLaunched() SailPointTime` + +GetLaunched returns the Launched field if non-nil, zero value otherwise. + +### GetLaunchedOk + +`func (o *TaskStatus) GetLaunchedOk() (*SailPointTime, bool)` + +GetLaunchedOk returns a tuple with the Launched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunched + +`func (o *TaskStatus) SetLaunched(v SailPointTime)` + +SetLaunched sets Launched field to given value. + + +### SetLaunchedNil + +`func (o *TaskStatus) SetLaunchedNil(b bool)` + + SetLaunchedNil sets the value for Launched to be an explicit nil + +### UnsetLaunched +`func (o *TaskStatus) UnsetLaunched()` + +UnsetLaunched ensures that no value is present for Launched, not even an explicit nil +### GetCompleted + +`func (o *TaskStatus) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *TaskStatus) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *TaskStatus) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + + +### SetCompletedNil + +`func (o *TaskStatus) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *TaskStatus) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetCompletionStatus + +`func (o *TaskStatus) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *TaskStatus) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *TaskStatus) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + + +### SetCompletionStatusNil + +`func (o *TaskStatus) SetCompletionStatusNil(b bool)` + + SetCompletionStatusNil sets the value for CompletionStatus to be an explicit nil + +### UnsetCompletionStatus +`func (o *TaskStatus) UnsetCompletionStatus()` + +UnsetCompletionStatus ensures that no value is present for CompletionStatus, not even an explicit nil +### GetMessages + +`func (o *TaskStatus) GetMessages() []TaskStatusMessage` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *TaskStatus) GetMessagesOk() (*[]TaskStatusMessage, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *TaskStatus) SetMessages(v []TaskStatusMessage)` + +SetMessages sets Messages field to given value. + + +### GetReturns + +`func (o *TaskStatus) GetReturns() []TaskReturnDetails` + +GetReturns returns the Returns field if non-nil, zero value otherwise. + +### GetReturnsOk + +`func (o *TaskStatus) GetReturnsOk() (*[]TaskReturnDetails, bool)` + +GetReturnsOk returns a tuple with the Returns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReturns + +`func (o *TaskStatus) SetReturns(v []TaskReturnDetails)` + +SetReturns sets Returns field to given value. + + +### GetAttributes + +`func (o *TaskStatus) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TaskStatus) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TaskStatus) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetProgress + +`func (o *TaskStatus) GetProgress() string` + +GetProgress returns the Progress field if non-nil, zero value otherwise. + +### GetProgressOk + +`func (o *TaskStatus) GetProgressOk() (*string, bool)` + +GetProgressOk returns a tuple with the Progress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProgress + +`func (o *TaskStatus) SetProgress(v string)` + +SetProgress sets Progress field to given value. + + +### SetProgressNil + +`func (o *TaskStatus) SetProgressNil(b bool)` + + SetProgressNil sets the value for Progress to be an explicit nil + +### UnsetProgress +`func (o *TaskStatus) UnsetProgress()` + +UnsetProgress ensures that no value is present for Progress, not even an explicit nil +### GetPercentComplete + +`func (o *TaskStatus) GetPercentComplete() int32` + +GetPercentComplete returns the PercentComplete field if non-nil, zero value otherwise. + +### GetPercentCompleteOk + +`func (o *TaskStatus) GetPercentCompleteOk() (*int32, bool)` + +GetPercentCompleteOk returns a tuple with the PercentComplete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPercentComplete + +`func (o *TaskStatus) SetPercentComplete(v int32)` + +SetPercentComplete sets PercentComplete field to given value. + + +### GetTaskDefinitionSummary + +`func (o *TaskStatus) GetTaskDefinitionSummary() TaskDefinitionSummary` + +GetTaskDefinitionSummary returns the TaskDefinitionSummary field if non-nil, zero value otherwise. + +### GetTaskDefinitionSummaryOk + +`func (o *TaskStatus) GetTaskDefinitionSummaryOk() (*TaskDefinitionSummary, bool)` + +GetTaskDefinitionSummaryOk returns a tuple with the TaskDefinitionSummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskDefinitionSummary + +`func (o *TaskStatus) SetTaskDefinitionSummary(v TaskDefinitionSummary)` + +SetTaskDefinitionSummary sets TaskDefinitionSummary field to given value. + +### HasTaskDefinitionSummary + +`func (o *TaskStatus) HasTaskDefinitionSummary() bool` + +HasTaskDefinitionSummary returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TaskStatusMessage.md b/docs/tools/sdk/go/Reference/V2025/Models/TaskStatusMessage.md new file mode 100644 index 000000000..02c227d08 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TaskStatusMessage.md @@ -0,0 +1,142 @@ +--- +id: v2025-task-status-message +title: TaskStatusMessage +pagination_label: TaskStatusMessage +sidebar_label: TaskStatusMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskStatusMessage', 'V2025TaskStatusMessage'] +slug: /tools/sdk/go/v2025/models/task-status-message +tags: ['SDK', 'Software Development Kit', 'TaskStatusMessage', 'V2025TaskStatusMessage'] +--- + +# TaskStatusMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of the message | +**LocalizedText** | [**NullableLocalizedMessage**](localized-message) | | +**Key** | **string** | Key of the message | +**Parameters** | [**[]TaskStatusMessageParametersInner**](task-status-message-parameters-inner) | Message parameters for internationalization | + +## Methods + +### NewTaskStatusMessage + +`func NewTaskStatusMessage(type_ string, localizedText NullableLocalizedMessage, key string, parameters []TaskStatusMessageParametersInner, ) *TaskStatusMessage` + +NewTaskStatusMessage instantiates a new TaskStatusMessage 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 + +### NewTaskStatusMessageWithDefaults + +`func NewTaskStatusMessageWithDefaults() *TaskStatusMessage` + +NewTaskStatusMessageWithDefaults instantiates a new TaskStatusMessage 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 + +### GetType + +`func (o *TaskStatusMessage) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskStatusMessage) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskStatusMessage) SetType(v string)` + +SetType sets Type field to given value. + + +### GetLocalizedText + +`func (o *TaskStatusMessage) GetLocalizedText() LocalizedMessage` + +GetLocalizedText returns the LocalizedText field if non-nil, zero value otherwise. + +### GetLocalizedTextOk + +`func (o *TaskStatusMessage) GetLocalizedTextOk() (*LocalizedMessage, bool)` + +GetLocalizedTextOk returns a tuple with the LocalizedText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizedText + +`func (o *TaskStatusMessage) SetLocalizedText(v LocalizedMessage)` + +SetLocalizedText sets LocalizedText field to given value. + + +### SetLocalizedTextNil + +`func (o *TaskStatusMessage) SetLocalizedTextNil(b bool)` + + SetLocalizedTextNil sets the value for LocalizedText to be an explicit nil + +### UnsetLocalizedText +`func (o *TaskStatusMessage) UnsetLocalizedText()` + +UnsetLocalizedText ensures that no value is present for LocalizedText, not even an explicit nil +### GetKey + +`func (o *TaskStatusMessage) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TaskStatusMessage) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TaskStatusMessage) SetKey(v string)` + +SetKey sets Key field to given value. + + +### GetParameters + +`func (o *TaskStatusMessage) GetParameters() []TaskStatusMessageParametersInner` + +GetParameters returns the Parameters field if non-nil, zero value otherwise. + +### GetParametersOk + +`func (o *TaskStatusMessage) GetParametersOk() (*[]TaskStatusMessageParametersInner, bool)` + +GetParametersOk returns a tuple with the Parameters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParameters + +`func (o *TaskStatusMessage) SetParameters(v []TaskStatusMessageParametersInner)` + +SetParameters sets Parameters field to given value. + + +### SetParametersNil + +`func (o *TaskStatusMessage) SetParametersNil(b bool)` + + SetParametersNil sets the value for Parameters to be an explicit nil + +### UnsetParameters +`func (o *TaskStatusMessage) UnsetParameters()` + +UnsetParameters ensures that no value is present for Parameters, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TaskStatusMessageParametersInner.md b/docs/tools/sdk/go/Reference/V2025/Models/TaskStatusMessageParametersInner.md new file mode 100644 index 000000000..0fe2aef4f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TaskStatusMessageParametersInner.md @@ -0,0 +1,38 @@ +--- +id: v2025-task-status-message-parameters-inner +title: TaskStatusMessageParametersInner +pagination_label: TaskStatusMessageParametersInner +sidebar_label: TaskStatusMessageParametersInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskStatusMessageParametersInner', 'V2025TaskStatusMessageParametersInner'] +slug: /tools/sdk/go/v2025/models/task-status-message-parameters-inner +tags: ['SDK', 'Software Development Kit', 'TaskStatusMessageParametersInner', 'V2025TaskStatusMessageParametersInner'] +--- + +# TaskStatusMessageParametersInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewTaskStatusMessageParametersInner + +`func NewTaskStatusMessageParametersInner() *TaskStatusMessageParametersInner` + +NewTaskStatusMessageParametersInner instantiates a new TaskStatusMessageParametersInner 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 + +### NewTaskStatusMessageParametersInnerWithDefaults + +`func NewTaskStatusMessageParametersInnerWithDefaults() *TaskStatusMessageParametersInner` + +NewTaskStatusMessageParametersInnerWithDefaults instantiates a new TaskStatusMessageParametersInner 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 + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TemplateBulkDeleteDto.md b/docs/tools/sdk/go/Reference/V2025/Models/TemplateBulkDeleteDto.md new file mode 100644 index 000000000..2d3551234 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TemplateBulkDeleteDto.md @@ -0,0 +1,111 @@ +--- +id: v2025-template-bulk-delete-dto +title: TemplateBulkDeleteDto +pagination_label: TemplateBulkDeleteDto +sidebar_label: TemplateBulkDeleteDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateBulkDeleteDto', 'V2025TemplateBulkDeleteDto'] +slug: /tools/sdk/go/v2025/models/template-bulk-delete-dto +tags: ['SDK', 'Software Development Kit', 'TemplateBulkDeleteDto', 'V2025TemplateBulkDeleteDto'] +--- + +# TemplateBulkDeleteDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **string** | | +**Medium** | Pointer to **string** | | [optional] +**Locale** | Pointer to **string** | The locale for the message text, a BCP 47 language tag. | [optional] + +## Methods + +### NewTemplateBulkDeleteDto + +`func NewTemplateBulkDeleteDto(key string, ) *TemplateBulkDeleteDto` + +NewTemplateBulkDeleteDto instantiates a new TemplateBulkDeleteDto 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 + +### NewTemplateBulkDeleteDtoWithDefaults + +`func NewTemplateBulkDeleteDtoWithDefaults() *TemplateBulkDeleteDto` + +NewTemplateBulkDeleteDtoWithDefaults instantiates a new TemplateBulkDeleteDto 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 + +### GetKey + +`func (o *TemplateBulkDeleteDto) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TemplateBulkDeleteDto) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TemplateBulkDeleteDto) SetKey(v string)` + +SetKey sets Key field to given value. + + +### GetMedium + +`func (o *TemplateBulkDeleteDto) GetMedium() string` + +GetMedium returns the Medium field if non-nil, zero value otherwise. + +### GetMediumOk + +`func (o *TemplateBulkDeleteDto) GetMediumOk() (*string, bool)` + +GetMediumOk returns a tuple with the Medium field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMedium + +`func (o *TemplateBulkDeleteDto) SetMedium(v string)` + +SetMedium sets Medium field to given value. + +### HasMedium + +`func (o *TemplateBulkDeleteDto) HasMedium() bool` + +HasMedium returns a boolean if a field has been set. + +### GetLocale + +`func (o *TemplateBulkDeleteDto) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *TemplateBulkDeleteDto) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *TemplateBulkDeleteDto) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *TemplateBulkDeleteDto) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TemplateDto.md b/docs/tools/sdk/go/Reference/V2025/Models/TemplateDto.md new file mode 100644 index 000000000..14aea0287 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TemplateDto.md @@ -0,0 +1,479 @@ +--- +id: v2025-template-dto +title: TemplateDto +pagination_label: TemplateDto +sidebar_label: TemplateDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateDto', 'V2025TemplateDto'] +slug: /tools/sdk/go/v2025/models/template-dto +tags: ['SDK', 'Software Development Kit', 'TemplateDto', 'V2025TemplateDto'] +--- + +# TemplateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **string** | The key of the template | +**Name** | Pointer to **string** | The name of the Task Manager Subscription | [optional] +**Medium** | **string** | The message medium. More mediums may be added in the future. | +**Locale** | **string** | The locale for the message text, a BCP 47 language tag. | +**Subject** | Pointer to **string** | The subject line in the template | [optional] +**Header** | Pointer to **NullableString** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**Body** | Pointer to **string** | The body in the template | [optional] +**Footer** | Pointer to **NullableString** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**From** | Pointer to **string** | The \"From:\" address in the template | [optional] +**ReplyTo** | Pointer to **string** | The \"Reply To\" line in the template | [optional] +**Description** | Pointer to **string** | The description in the template | [optional] +**Id** | Pointer to **string** | This is auto-generated. | [optional] +**Created** | Pointer to **SailPointTime** | The time when this template is created. This is auto-generated. | [optional] +**Modified** | Pointer to **SailPointTime** | The time when this template was last modified. This is auto-generated. | [optional] +**SlackTemplate** | Pointer to **NullableString** | | [optional] +**TeamsTemplate** | Pointer to **NullableString** | | [optional] + +## Methods + +### NewTemplateDto + +`func NewTemplateDto(key string, medium string, locale string, ) *TemplateDto` + +NewTemplateDto instantiates a new TemplateDto 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 + +### NewTemplateDtoWithDefaults + +`func NewTemplateDtoWithDefaults() *TemplateDto` + +NewTemplateDtoWithDefaults instantiates a new TemplateDto 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 + +### GetKey + +`func (o *TemplateDto) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TemplateDto) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TemplateDto) SetKey(v string)` + +SetKey sets Key field to given value. + + +### GetName + +`func (o *TemplateDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TemplateDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TemplateDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TemplateDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetMedium + +`func (o *TemplateDto) GetMedium() string` + +GetMedium returns the Medium field if non-nil, zero value otherwise. + +### GetMediumOk + +`func (o *TemplateDto) GetMediumOk() (*string, bool)` + +GetMediumOk returns a tuple with the Medium field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMedium + +`func (o *TemplateDto) SetMedium(v string)` + +SetMedium sets Medium field to given value. + + +### GetLocale + +`func (o *TemplateDto) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *TemplateDto) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *TemplateDto) SetLocale(v string)` + +SetLocale sets Locale field to given value. + + +### GetSubject + +`func (o *TemplateDto) GetSubject() string` + +GetSubject returns the Subject field if non-nil, zero value otherwise. + +### GetSubjectOk + +`func (o *TemplateDto) GetSubjectOk() (*string, bool)` + +GetSubjectOk returns a tuple with the Subject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubject + +`func (o *TemplateDto) SetSubject(v string)` + +SetSubject sets Subject field to given value. + +### HasSubject + +`func (o *TemplateDto) HasSubject() bool` + +HasSubject returns a boolean if a field has been set. + +### GetHeader + +`func (o *TemplateDto) GetHeader() string` + +GetHeader returns the Header field if non-nil, zero value otherwise. + +### GetHeaderOk + +`func (o *TemplateDto) GetHeaderOk() (*string, bool)` + +GetHeaderOk returns a tuple with the Header field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHeader + +`func (o *TemplateDto) SetHeader(v string)` + +SetHeader sets Header field to given value. + +### HasHeader + +`func (o *TemplateDto) HasHeader() bool` + +HasHeader returns a boolean if a field has been set. + +### SetHeaderNil + +`func (o *TemplateDto) SetHeaderNil(b bool)` + + SetHeaderNil sets the value for Header to be an explicit nil + +### UnsetHeader +`func (o *TemplateDto) UnsetHeader()` + +UnsetHeader ensures that no value is present for Header, not even an explicit nil +### GetBody + +`func (o *TemplateDto) GetBody() string` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *TemplateDto) GetBodyOk() (*string, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBody + +`func (o *TemplateDto) SetBody(v string)` + +SetBody sets Body field to given value. + +### HasBody + +`func (o *TemplateDto) HasBody() bool` + +HasBody returns a boolean if a field has been set. + +### GetFooter + +`func (o *TemplateDto) GetFooter() string` + +GetFooter returns the Footer field if non-nil, zero value otherwise. + +### GetFooterOk + +`func (o *TemplateDto) GetFooterOk() (*string, bool)` + +GetFooterOk returns a tuple with the Footer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFooter + +`func (o *TemplateDto) SetFooter(v string)` + +SetFooter sets Footer field to given value. + +### HasFooter + +`func (o *TemplateDto) HasFooter() bool` + +HasFooter returns a boolean if a field has been set. + +### SetFooterNil + +`func (o *TemplateDto) SetFooterNil(b bool)` + + SetFooterNil sets the value for Footer to be an explicit nil + +### UnsetFooter +`func (o *TemplateDto) UnsetFooter()` + +UnsetFooter ensures that no value is present for Footer, not even an explicit nil +### GetFrom + +`func (o *TemplateDto) GetFrom() string` + +GetFrom returns the From field if non-nil, zero value otherwise. + +### GetFromOk + +`func (o *TemplateDto) GetFromOk() (*string, bool)` + +GetFromOk returns a tuple with the From field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrom + +`func (o *TemplateDto) SetFrom(v string)` + +SetFrom sets From field to given value. + +### HasFrom + +`func (o *TemplateDto) HasFrom() bool` + +HasFrom returns a boolean if a field has been set. + +### GetReplyTo + +`func (o *TemplateDto) GetReplyTo() string` + +GetReplyTo returns the ReplyTo field if non-nil, zero value otherwise. + +### GetReplyToOk + +`func (o *TemplateDto) GetReplyToOk() (*string, bool)` + +GetReplyToOk returns a tuple with the ReplyTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplyTo + +`func (o *TemplateDto) SetReplyTo(v string)` + +SetReplyTo sets ReplyTo field to given value. + +### HasReplyTo + +`func (o *TemplateDto) HasReplyTo() bool` + +HasReplyTo returns a boolean if a field has been set. + +### GetDescription + +`func (o *TemplateDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TemplateDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TemplateDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *TemplateDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetId + +`func (o *TemplateDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TemplateDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TemplateDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TemplateDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreated + +`func (o *TemplateDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *TemplateDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *TemplateDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *TemplateDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *TemplateDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *TemplateDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *TemplateDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *TemplateDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetSlackTemplate + +`func (o *TemplateDto) GetSlackTemplate() string` + +GetSlackTemplate returns the SlackTemplate field if non-nil, zero value otherwise. + +### GetSlackTemplateOk + +`func (o *TemplateDto) GetSlackTemplateOk() (*string, bool)` + +GetSlackTemplateOk returns a tuple with the SlackTemplate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSlackTemplate + +`func (o *TemplateDto) SetSlackTemplate(v string)` + +SetSlackTemplate sets SlackTemplate field to given value. + +### HasSlackTemplate + +`func (o *TemplateDto) HasSlackTemplate() bool` + +HasSlackTemplate returns a boolean if a field has been set. + +### SetSlackTemplateNil + +`func (o *TemplateDto) SetSlackTemplateNil(b bool)` + + SetSlackTemplateNil sets the value for SlackTemplate to be an explicit nil + +### UnsetSlackTemplate +`func (o *TemplateDto) UnsetSlackTemplate()` + +UnsetSlackTemplate ensures that no value is present for SlackTemplate, not even an explicit nil +### GetTeamsTemplate + +`func (o *TemplateDto) GetTeamsTemplate() string` + +GetTeamsTemplate returns the TeamsTemplate field if non-nil, zero value otherwise. + +### GetTeamsTemplateOk + +`func (o *TemplateDto) GetTeamsTemplateOk() (*string, bool)` + +GetTeamsTemplateOk returns a tuple with the TeamsTemplate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamsTemplate + +`func (o *TemplateDto) SetTeamsTemplate(v string)` + +SetTeamsTemplate sets TeamsTemplate field to given value. + +### HasTeamsTemplate + +`func (o *TemplateDto) HasTeamsTemplate() bool` + +HasTeamsTemplate returns a boolean if a field has been set. + +### SetTeamsTemplateNil + +`func (o *TemplateDto) SetTeamsTemplateNil(b bool)` + + SetTeamsTemplateNil sets the value for TeamsTemplate to be an explicit nil + +### UnsetTeamsTemplate +`func (o *TemplateDto) UnsetTeamsTemplate()` + +UnsetTeamsTemplate ensures that no value is present for TeamsTemplate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TemplateDtoDefault.md b/docs/tools/sdk/go/Reference/V2025/Models/TemplateDtoDefault.md new file mode 100644 index 000000000..aaa793382 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TemplateDtoDefault.md @@ -0,0 +1,456 @@ +--- +id: v2025-template-dto-default +title: TemplateDtoDefault +pagination_label: TemplateDtoDefault +sidebar_label: TemplateDtoDefault +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateDtoDefault', 'V2025TemplateDtoDefault'] +slug: /tools/sdk/go/v2025/models/template-dto-default +tags: ['SDK', 'Software Development Kit', 'TemplateDtoDefault', 'V2025TemplateDtoDefault'] +--- + +# TemplateDtoDefault + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The key of the default template | [optional] +**Name** | Pointer to **string** | The name of the default template | [optional] +**Medium** | Pointer to **string** | The message medium. More mediums may be added in the future. | [optional] +**Locale** | Pointer to **string** | The locale for the message text, a BCP 47 language tag. | [optional] +**Subject** | Pointer to **NullableString** | The subject of the default template | [optional] +**Header** | Pointer to **NullableString** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**Body** | Pointer to **string** | The body of the default template | [optional] +**Footer** | Pointer to **NullableString** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**From** | Pointer to **NullableString** | The \"From:\" address of the default template | [optional] +**ReplyTo** | Pointer to **NullableString** | The \"Reply To\" field of the default template | [optional] +**Description** | Pointer to **NullableString** | The description of the default template | [optional] +**SlackTemplate** | Pointer to [**NullableTemplateSlack**](template-slack) | | [optional] +**TeamsTemplate** | Pointer to [**NullableTemplateTeams**](template-teams) | | [optional] + +## Methods + +### NewTemplateDtoDefault + +`func NewTemplateDtoDefault() *TemplateDtoDefault` + +NewTemplateDtoDefault instantiates a new TemplateDtoDefault 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 + +### NewTemplateDtoDefaultWithDefaults + +`func NewTemplateDtoDefaultWithDefaults() *TemplateDtoDefault` + +NewTemplateDtoDefaultWithDefaults instantiates a new TemplateDtoDefault 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 + +### GetKey + +`func (o *TemplateDtoDefault) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TemplateDtoDefault) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TemplateDtoDefault) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *TemplateDtoDefault) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *TemplateDtoDefault) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TemplateDtoDefault) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TemplateDtoDefault) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TemplateDtoDefault) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetMedium + +`func (o *TemplateDtoDefault) GetMedium() string` + +GetMedium returns the Medium field if non-nil, zero value otherwise. + +### GetMediumOk + +`func (o *TemplateDtoDefault) GetMediumOk() (*string, bool)` + +GetMediumOk returns a tuple with the Medium field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMedium + +`func (o *TemplateDtoDefault) SetMedium(v string)` + +SetMedium sets Medium field to given value. + +### HasMedium + +`func (o *TemplateDtoDefault) HasMedium() bool` + +HasMedium returns a boolean if a field has been set. + +### GetLocale + +`func (o *TemplateDtoDefault) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *TemplateDtoDefault) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *TemplateDtoDefault) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *TemplateDtoDefault) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + +### GetSubject + +`func (o *TemplateDtoDefault) GetSubject() string` + +GetSubject returns the Subject field if non-nil, zero value otherwise. + +### GetSubjectOk + +`func (o *TemplateDtoDefault) GetSubjectOk() (*string, bool)` + +GetSubjectOk returns a tuple with the Subject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubject + +`func (o *TemplateDtoDefault) SetSubject(v string)` + +SetSubject sets Subject field to given value. + +### HasSubject + +`func (o *TemplateDtoDefault) HasSubject() bool` + +HasSubject returns a boolean if a field has been set. + +### SetSubjectNil + +`func (o *TemplateDtoDefault) SetSubjectNil(b bool)` + + SetSubjectNil sets the value for Subject to be an explicit nil + +### UnsetSubject +`func (o *TemplateDtoDefault) UnsetSubject()` + +UnsetSubject ensures that no value is present for Subject, not even an explicit nil +### GetHeader + +`func (o *TemplateDtoDefault) GetHeader() string` + +GetHeader returns the Header field if non-nil, zero value otherwise. + +### GetHeaderOk + +`func (o *TemplateDtoDefault) GetHeaderOk() (*string, bool)` + +GetHeaderOk returns a tuple with the Header field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHeader + +`func (o *TemplateDtoDefault) SetHeader(v string)` + +SetHeader sets Header field to given value. + +### HasHeader + +`func (o *TemplateDtoDefault) HasHeader() bool` + +HasHeader returns a boolean if a field has been set. + +### SetHeaderNil + +`func (o *TemplateDtoDefault) SetHeaderNil(b bool)` + + SetHeaderNil sets the value for Header to be an explicit nil + +### UnsetHeader +`func (o *TemplateDtoDefault) UnsetHeader()` + +UnsetHeader ensures that no value is present for Header, not even an explicit nil +### GetBody + +`func (o *TemplateDtoDefault) GetBody() string` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *TemplateDtoDefault) GetBodyOk() (*string, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBody + +`func (o *TemplateDtoDefault) SetBody(v string)` + +SetBody sets Body field to given value. + +### HasBody + +`func (o *TemplateDtoDefault) HasBody() bool` + +HasBody returns a boolean if a field has been set. + +### GetFooter + +`func (o *TemplateDtoDefault) GetFooter() string` + +GetFooter returns the Footer field if non-nil, zero value otherwise. + +### GetFooterOk + +`func (o *TemplateDtoDefault) GetFooterOk() (*string, bool)` + +GetFooterOk returns a tuple with the Footer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFooter + +`func (o *TemplateDtoDefault) SetFooter(v string)` + +SetFooter sets Footer field to given value. + +### HasFooter + +`func (o *TemplateDtoDefault) HasFooter() bool` + +HasFooter returns a boolean if a field has been set. + +### SetFooterNil + +`func (o *TemplateDtoDefault) SetFooterNil(b bool)` + + SetFooterNil sets the value for Footer to be an explicit nil + +### UnsetFooter +`func (o *TemplateDtoDefault) UnsetFooter()` + +UnsetFooter ensures that no value is present for Footer, not even an explicit nil +### GetFrom + +`func (o *TemplateDtoDefault) GetFrom() string` + +GetFrom returns the From field if non-nil, zero value otherwise. + +### GetFromOk + +`func (o *TemplateDtoDefault) GetFromOk() (*string, bool)` + +GetFromOk returns a tuple with the From field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrom + +`func (o *TemplateDtoDefault) SetFrom(v string)` + +SetFrom sets From field to given value. + +### HasFrom + +`func (o *TemplateDtoDefault) HasFrom() bool` + +HasFrom returns a boolean if a field has been set. + +### SetFromNil + +`func (o *TemplateDtoDefault) SetFromNil(b bool)` + + SetFromNil sets the value for From to be an explicit nil + +### UnsetFrom +`func (o *TemplateDtoDefault) UnsetFrom()` + +UnsetFrom ensures that no value is present for From, not even an explicit nil +### GetReplyTo + +`func (o *TemplateDtoDefault) GetReplyTo() string` + +GetReplyTo returns the ReplyTo field if non-nil, zero value otherwise. + +### GetReplyToOk + +`func (o *TemplateDtoDefault) GetReplyToOk() (*string, bool)` + +GetReplyToOk returns a tuple with the ReplyTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReplyTo + +`func (o *TemplateDtoDefault) SetReplyTo(v string)` + +SetReplyTo sets ReplyTo field to given value. + +### HasReplyTo + +`func (o *TemplateDtoDefault) HasReplyTo() bool` + +HasReplyTo returns a boolean if a field has been set. + +### SetReplyToNil + +`func (o *TemplateDtoDefault) SetReplyToNil(b bool)` + + SetReplyToNil sets the value for ReplyTo to be an explicit nil + +### UnsetReplyTo +`func (o *TemplateDtoDefault) UnsetReplyTo()` + +UnsetReplyTo ensures that no value is present for ReplyTo, not even an explicit nil +### GetDescription + +`func (o *TemplateDtoDefault) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TemplateDtoDefault) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TemplateDtoDefault) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *TemplateDtoDefault) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *TemplateDtoDefault) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *TemplateDtoDefault) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSlackTemplate + +`func (o *TemplateDtoDefault) GetSlackTemplate() TemplateSlack` + +GetSlackTemplate returns the SlackTemplate field if non-nil, zero value otherwise. + +### GetSlackTemplateOk + +`func (o *TemplateDtoDefault) GetSlackTemplateOk() (*TemplateSlack, bool)` + +GetSlackTemplateOk returns a tuple with the SlackTemplate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSlackTemplate + +`func (o *TemplateDtoDefault) SetSlackTemplate(v TemplateSlack)` + +SetSlackTemplate sets SlackTemplate field to given value. + +### HasSlackTemplate + +`func (o *TemplateDtoDefault) HasSlackTemplate() bool` + +HasSlackTemplate returns a boolean if a field has been set. + +### SetSlackTemplateNil + +`func (o *TemplateDtoDefault) SetSlackTemplateNil(b bool)` + + SetSlackTemplateNil sets the value for SlackTemplate to be an explicit nil + +### UnsetSlackTemplate +`func (o *TemplateDtoDefault) UnsetSlackTemplate()` + +UnsetSlackTemplate ensures that no value is present for SlackTemplate, not even an explicit nil +### GetTeamsTemplate + +`func (o *TemplateDtoDefault) GetTeamsTemplate() TemplateTeams` + +GetTeamsTemplate returns the TeamsTemplate field if non-nil, zero value otherwise. + +### GetTeamsTemplateOk + +`func (o *TemplateDtoDefault) GetTeamsTemplateOk() (*TemplateTeams, bool)` + +GetTeamsTemplateOk returns a tuple with the TeamsTemplate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTeamsTemplate + +`func (o *TemplateDtoDefault) SetTeamsTemplate(v TemplateTeams)` + +SetTeamsTemplate sets TeamsTemplate field to given value. + +### HasTeamsTemplate + +`func (o *TemplateDtoDefault) HasTeamsTemplate() bool` + +HasTeamsTemplate returns a boolean if a field has been set. + +### SetTeamsTemplateNil + +`func (o *TemplateDtoDefault) SetTeamsTemplateNil(b bool)` + + SetTeamsTemplateNil sets the value for TeamsTemplate to be an explicit nil + +### UnsetTeamsTemplate +`func (o *TemplateDtoDefault) UnsetTeamsTemplate()` + +UnsetTeamsTemplate ensures that no value is present for TeamsTemplate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TemplateSlack.md b/docs/tools/sdk/go/Reference/V2025/Models/TemplateSlack.md new file mode 100644 index 000000000..bc918a85e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TemplateSlack.md @@ -0,0 +1,414 @@ +--- +id: v2025-template-slack +title: TemplateSlack +pagination_label: TemplateSlack +sidebar_label: TemplateSlack +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateSlack', 'V2025TemplateSlack'] +slug: /tools/sdk/go/v2025/models/template-slack +tags: ['SDK', 'Software Development Kit', 'TemplateSlack', 'V2025TemplateSlack'] +--- + +# TemplateSlack + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **NullableString** | | [optional] +**Text** | Pointer to **string** | | [optional] +**Blocks** | Pointer to **NullableString** | | [optional] +**Attachments** | Pointer to **string** | | [optional] +**NotificationType** | Pointer to **NullableString** | | [optional] +**ApprovalId** | Pointer to **NullableString** | | [optional] +**RequestId** | Pointer to **NullableString** | | [optional] +**RequestedById** | Pointer to **NullableString** | | [optional] +**IsSubscription** | Pointer to **NullableBool** | | [optional] +**AutoApprovalData** | Pointer to [**NullableTemplateSlackAutoApprovalData**](template-slack-auto-approval-data) | | [optional] +**CustomFields** | Pointer to [**NullableTemplateSlackCustomFields**](template-slack-custom-fields) | | [optional] + +## Methods + +### NewTemplateSlack + +`func NewTemplateSlack() *TemplateSlack` + +NewTemplateSlack instantiates a new TemplateSlack 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 + +### NewTemplateSlackWithDefaults + +`func NewTemplateSlackWithDefaults() *TemplateSlack` + +NewTemplateSlackWithDefaults instantiates a new TemplateSlack 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 + +### GetKey + +`func (o *TemplateSlack) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TemplateSlack) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TemplateSlack) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *TemplateSlack) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *TemplateSlack) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *TemplateSlack) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetText + +`func (o *TemplateSlack) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *TemplateSlack) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *TemplateSlack) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *TemplateSlack) HasText() bool` + +HasText returns a boolean if a field has been set. + +### GetBlocks + +`func (o *TemplateSlack) GetBlocks() string` + +GetBlocks returns the Blocks field if non-nil, zero value otherwise. + +### GetBlocksOk + +`func (o *TemplateSlack) GetBlocksOk() (*string, bool)` + +GetBlocksOk returns a tuple with the Blocks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBlocks + +`func (o *TemplateSlack) SetBlocks(v string)` + +SetBlocks sets Blocks field to given value. + +### HasBlocks + +`func (o *TemplateSlack) HasBlocks() bool` + +HasBlocks returns a boolean if a field has been set. + +### SetBlocksNil + +`func (o *TemplateSlack) SetBlocksNil(b bool)` + + SetBlocksNil sets the value for Blocks to be an explicit nil + +### UnsetBlocks +`func (o *TemplateSlack) UnsetBlocks()` + +UnsetBlocks ensures that no value is present for Blocks, not even an explicit nil +### GetAttachments + +`func (o *TemplateSlack) GetAttachments() string` + +GetAttachments returns the Attachments field if non-nil, zero value otherwise. + +### GetAttachmentsOk + +`func (o *TemplateSlack) GetAttachmentsOk() (*string, bool)` + +GetAttachmentsOk returns a tuple with the Attachments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttachments + +`func (o *TemplateSlack) SetAttachments(v string)` + +SetAttachments sets Attachments field to given value. + +### HasAttachments + +`func (o *TemplateSlack) HasAttachments() bool` + +HasAttachments returns a boolean if a field has been set. + +### GetNotificationType + +`func (o *TemplateSlack) GetNotificationType() string` + +GetNotificationType returns the NotificationType field if non-nil, zero value otherwise. + +### GetNotificationTypeOk + +`func (o *TemplateSlack) GetNotificationTypeOk() (*string, bool)` + +GetNotificationTypeOk returns a tuple with the NotificationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotificationType + +`func (o *TemplateSlack) SetNotificationType(v string)` + +SetNotificationType sets NotificationType field to given value. + +### HasNotificationType + +`func (o *TemplateSlack) HasNotificationType() bool` + +HasNotificationType returns a boolean if a field has been set. + +### SetNotificationTypeNil + +`func (o *TemplateSlack) SetNotificationTypeNil(b bool)` + + SetNotificationTypeNil sets the value for NotificationType to be an explicit nil + +### UnsetNotificationType +`func (o *TemplateSlack) UnsetNotificationType()` + +UnsetNotificationType ensures that no value is present for NotificationType, not even an explicit nil +### GetApprovalId + +`func (o *TemplateSlack) GetApprovalId() string` + +GetApprovalId returns the ApprovalId field if non-nil, zero value otherwise. + +### GetApprovalIdOk + +`func (o *TemplateSlack) GetApprovalIdOk() (*string, bool)` + +GetApprovalIdOk returns a tuple with the ApprovalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalId + +`func (o *TemplateSlack) SetApprovalId(v string)` + +SetApprovalId sets ApprovalId field to given value. + +### HasApprovalId + +`func (o *TemplateSlack) HasApprovalId() bool` + +HasApprovalId returns a boolean if a field has been set. + +### SetApprovalIdNil + +`func (o *TemplateSlack) SetApprovalIdNil(b bool)` + + SetApprovalIdNil sets the value for ApprovalId to be an explicit nil + +### UnsetApprovalId +`func (o *TemplateSlack) UnsetApprovalId()` + +UnsetApprovalId ensures that no value is present for ApprovalId, not even an explicit nil +### GetRequestId + +`func (o *TemplateSlack) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *TemplateSlack) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *TemplateSlack) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *TemplateSlack) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *TemplateSlack) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *TemplateSlack) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetRequestedById + +`func (o *TemplateSlack) GetRequestedById() string` + +GetRequestedById returns the RequestedById field if non-nil, zero value otherwise. + +### GetRequestedByIdOk + +`func (o *TemplateSlack) GetRequestedByIdOk() (*string, bool)` + +GetRequestedByIdOk returns a tuple with the RequestedById field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedById + +`func (o *TemplateSlack) SetRequestedById(v string)` + +SetRequestedById sets RequestedById field to given value. + +### HasRequestedById + +`func (o *TemplateSlack) HasRequestedById() bool` + +HasRequestedById returns a boolean if a field has been set. + +### SetRequestedByIdNil + +`func (o *TemplateSlack) SetRequestedByIdNil(b bool)` + + SetRequestedByIdNil sets the value for RequestedById to be an explicit nil + +### UnsetRequestedById +`func (o *TemplateSlack) UnsetRequestedById()` + +UnsetRequestedById ensures that no value is present for RequestedById, not even an explicit nil +### GetIsSubscription + +`func (o *TemplateSlack) GetIsSubscription() bool` + +GetIsSubscription returns the IsSubscription field if non-nil, zero value otherwise. + +### GetIsSubscriptionOk + +`func (o *TemplateSlack) GetIsSubscriptionOk() (*bool, bool)` + +GetIsSubscriptionOk returns a tuple with the IsSubscription field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSubscription + +`func (o *TemplateSlack) SetIsSubscription(v bool)` + +SetIsSubscription sets IsSubscription field to given value. + +### HasIsSubscription + +`func (o *TemplateSlack) HasIsSubscription() bool` + +HasIsSubscription returns a boolean if a field has been set. + +### SetIsSubscriptionNil + +`func (o *TemplateSlack) SetIsSubscriptionNil(b bool)` + + SetIsSubscriptionNil sets the value for IsSubscription to be an explicit nil + +### UnsetIsSubscription +`func (o *TemplateSlack) UnsetIsSubscription()` + +UnsetIsSubscription ensures that no value is present for IsSubscription, not even an explicit nil +### GetAutoApprovalData + +`func (o *TemplateSlack) GetAutoApprovalData() TemplateSlackAutoApprovalData` + +GetAutoApprovalData returns the AutoApprovalData field if non-nil, zero value otherwise. + +### GetAutoApprovalDataOk + +`func (o *TemplateSlack) GetAutoApprovalDataOk() (*TemplateSlackAutoApprovalData, bool)` + +GetAutoApprovalDataOk returns a tuple with the AutoApprovalData field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoApprovalData + +`func (o *TemplateSlack) SetAutoApprovalData(v TemplateSlackAutoApprovalData)` + +SetAutoApprovalData sets AutoApprovalData field to given value. + +### HasAutoApprovalData + +`func (o *TemplateSlack) HasAutoApprovalData() bool` + +HasAutoApprovalData returns a boolean if a field has been set. + +### SetAutoApprovalDataNil + +`func (o *TemplateSlack) SetAutoApprovalDataNil(b bool)` + + SetAutoApprovalDataNil sets the value for AutoApprovalData to be an explicit nil + +### UnsetAutoApprovalData +`func (o *TemplateSlack) UnsetAutoApprovalData()` + +UnsetAutoApprovalData ensures that no value is present for AutoApprovalData, not even an explicit nil +### GetCustomFields + +`func (o *TemplateSlack) GetCustomFields() TemplateSlackCustomFields` + +GetCustomFields returns the CustomFields field if non-nil, zero value otherwise. + +### GetCustomFieldsOk + +`func (o *TemplateSlack) GetCustomFieldsOk() (*TemplateSlackCustomFields, bool)` + +GetCustomFieldsOk returns a tuple with the CustomFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomFields + +`func (o *TemplateSlack) SetCustomFields(v TemplateSlackCustomFields)` + +SetCustomFields sets CustomFields field to given value. + +### HasCustomFields + +`func (o *TemplateSlack) HasCustomFields() bool` + +HasCustomFields returns a boolean if a field has been set. + +### SetCustomFieldsNil + +`func (o *TemplateSlack) SetCustomFieldsNil(b bool)` + + SetCustomFieldsNil sets the value for CustomFields to be an explicit nil + +### UnsetCustomFields +`func (o *TemplateSlack) UnsetCustomFields()` + +UnsetCustomFields ensures that no value is present for CustomFields, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TemplateSlackAutoApprovalData.md b/docs/tools/sdk/go/Reference/V2025/Models/TemplateSlackAutoApprovalData.md new file mode 100644 index 000000000..cc78a5154 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TemplateSlackAutoApprovalData.md @@ -0,0 +1,218 @@ +--- +id: v2025-template-slack-auto-approval-data +title: TemplateSlackAutoApprovalData +pagination_label: TemplateSlackAutoApprovalData +sidebar_label: TemplateSlackAutoApprovalData +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateSlackAutoApprovalData', 'V2025TemplateSlackAutoApprovalData'] +slug: /tools/sdk/go/v2025/models/template-slack-auto-approval-data +tags: ['SDK', 'Software Development Kit', 'TemplateSlackAutoApprovalData', 'V2025TemplateSlackAutoApprovalData'] +--- + +# TemplateSlackAutoApprovalData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsAutoApproved** | Pointer to **NullableString** | | [optional] +**ItemId** | Pointer to **NullableString** | | [optional] +**ItemType** | Pointer to **NullableString** | | [optional] +**AutoApprovalMessageJSON** | Pointer to **NullableString** | | [optional] +**AutoApprovalTitle** | Pointer to **NullableString** | | [optional] + +## Methods + +### NewTemplateSlackAutoApprovalData + +`func NewTemplateSlackAutoApprovalData() *TemplateSlackAutoApprovalData` + +NewTemplateSlackAutoApprovalData instantiates a new TemplateSlackAutoApprovalData 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 + +### NewTemplateSlackAutoApprovalDataWithDefaults + +`func NewTemplateSlackAutoApprovalDataWithDefaults() *TemplateSlackAutoApprovalData` + +NewTemplateSlackAutoApprovalDataWithDefaults instantiates a new TemplateSlackAutoApprovalData 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 + +### GetIsAutoApproved + +`func (o *TemplateSlackAutoApprovalData) GetIsAutoApproved() string` + +GetIsAutoApproved returns the IsAutoApproved field if non-nil, zero value otherwise. + +### GetIsAutoApprovedOk + +`func (o *TemplateSlackAutoApprovalData) GetIsAutoApprovedOk() (*string, bool)` + +GetIsAutoApprovedOk returns a tuple with the IsAutoApproved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsAutoApproved + +`func (o *TemplateSlackAutoApprovalData) SetIsAutoApproved(v string)` + +SetIsAutoApproved sets IsAutoApproved field to given value. + +### HasIsAutoApproved + +`func (o *TemplateSlackAutoApprovalData) HasIsAutoApproved() bool` + +HasIsAutoApproved returns a boolean if a field has been set. + +### SetIsAutoApprovedNil + +`func (o *TemplateSlackAutoApprovalData) SetIsAutoApprovedNil(b bool)` + + SetIsAutoApprovedNil sets the value for IsAutoApproved to be an explicit nil + +### UnsetIsAutoApproved +`func (o *TemplateSlackAutoApprovalData) UnsetIsAutoApproved()` + +UnsetIsAutoApproved ensures that no value is present for IsAutoApproved, not even an explicit nil +### GetItemId + +`func (o *TemplateSlackAutoApprovalData) GetItemId() string` + +GetItemId returns the ItemId field if non-nil, zero value otherwise. + +### GetItemIdOk + +`func (o *TemplateSlackAutoApprovalData) GetItemIdOk() (*string, bool)` + +GetItemIdOk returns a tuple with the ItemId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItemId + +`func (o *TemplateSlackAutoApprovalData) SetItemId(v string)` + +SetItemId sets ItemId field to given value. + +### HasItemId + +`func (o *TemplateSlackAutoApprovalData) HasItemId() bool` + +HasItemId returns a boolean if a field has been set. + +### SetItemIdNil + +`func (o *TemplateSlackAutoApprovalData) SetItemIdNil(b bool)` + + SetItemIdNil sets the value for ItemId to be an explicit nil + +### UnsetItemId +`func (o *TemplateSlackAutoApprovalData) UnsetItemId()` + +UnsetItemId ensures that no value is present for ItemId, not even an explicit nil +### GetItemType + +`func (o *TemplateSlackAutoApprovalData) GetItemType() string` + +GetItemType returns the ItemType field if non-nil, zero value otherwise. + +### GetItemTypeOk + +`func (o *TemplateSlackAutoApprovalData) GetItemTypeOk() (*string, bool)` + +GetItemTypeOk returns a tuple with the ItemType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItemType + +`func (o *TemplateSlackAutoApprovalData) SetItemType(v string)` + +SetItemType sets ItemType field to given value. + +### HasItemType + +`func (o *TemplateSlackAutoApprovalData) HasItemType() bool` + +HasItemType returns a boolean if a field has been set. + +### SetItemTypeNil + +`func (o *TemplateSlackAutoApprovalData) SetItemTypeNil(b bool)` + + SetItemTypeNil sets the value for ItemType to be an explicit nil + +### UnsetItemType +`func (o *TemplateSlackAutoApprovalData) UnsetItemType()` + +UnsetItemType ensures that no value is present for ItemType, not even an explicit nil +### GetAutoApprovalMessageJSON + +`func (o *TemplateSlackAutoApprovalData) GetAutoApprovalMessageJSON() string` + +GetAutoApprovalMessageJSON returns the AutoApprovalMessageJSON field if non-nil, zero value otherwise. + +### GetAutoApprovalMessageJSONOk + +`func (o *TemplateSlackAutoApprovalData) GetAutoApprovalMessageJSONOk() (*string, bool)` + +GetAutoApprovalMessageJSONOk returns a tuple with the AutoApprovalMessageJSON field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoApprovalMessageJSON + +`func (o *TemplateSlackAutoApprovalData) SetAutoApprovalMessageJSON(v string)` + +SetAutoApprovalMessageJSON sets AutoApprovalMessageJSON field to given value. + +### HasAutoApprovalMessageJSON + +`func (o *TemplateSlackAutoApprovalData) HasAutoApprovalMessageJSON() bool` + +HasAutoApprovalMessageJSON returns a boolean if a field has been set. + +### SetAutoApprovalMessageJSONNil + +`func (o *TemplateSlackAutoApprovalData) SetAutoApprovalMessageJSONNil(b bool)` + + SetAutoApprovalMessageJSONNil sets the value for AutoApprovalMessageJSON to be an explicit nil + +### UnsetAutoApprovalMessageJSON +`func (o *TemplateSlackAutoApprovalData) UnsetAutoApprovalMessageJSON()` + +UnsetAutoApprovalMessageJSON ensures that no value is present for AutoApprovalMessageJSON, not even an explicit nil +### GetAutoApprovalTitle + +`func (o *TemplateSlackAutoApprovalData) GetAutoApprovalTitle() string` + +GetAutoApprovalTitle returns the AutoApprovalTitle field if non-nil, zero value otherwise. + +### GetAutoApprovalTitleOk + +`func (o *TemplateSlackAutoApprovalData) GetAutoApprovalTitleOk() (*string, bool)` + +GetAutoApprovalTitleOk returns a tuple with the AutoApprovalTitle field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoApprovalTitle + +`func (o *TemplateSlackAutoApprovalData) SetAutoApprovalTitle(v string)` + +SetAutoApprovalTitle sets AutoApprovalTitle field to given value. + +### HasAutoApprovalTitle + +`func (o *TemplateSlackAutoApprovalData) HasAutoApprovalTitle() bool` + +HasAutoApprovalTitle returns a boolean if a field has been set. + +### SetAutoApprovalTitleNil + +`func (o *TemplateSlackAutoApprovalData) SetAutoApprovalTitleNil(b bool)` + + SetAutoApprovalTitleNil sets the value for AutoApprovalTitle to be an explicit nil + +### UnsetAutoApprovalTitle +`func (o *TemplateSlackAutoApprovalData) UnsetAutoApprovalTitle()` + +UnsetAutoApprovalTitle ensures that no value is present for AutoApprovalTitle, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TemplateSlackCustomFields.md b/docs/tools/sdk/go/Reference/V2025/Models/TemplateSlackCustomFields.md new file mode 100644 index 000000000..0d0ccdf87 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TemplateSlackCustomFields.md @@ -0,0 +1,182 @@ +--- +id: v2025-template-slack-custom-fields +title: TemplateSlackCustomFields +pagination_label: TemplateSlackCustomFields +sidebar_label: TemplateSlackCustomFields +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateSlackCustomFields', 'V2025TemplateSlackCustomFields'] +slug: /tools/sdk/go/v2025/models/template-slack-custom-fields +tags: ['SDK', 'Software Development Kit', 'TemplateSlackCustomFields', 'V2025TemplateSlackCustomFields'] +--- + +# TemplateSlackCustomFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestType** | Pointer to **NullableString** | | [optional] +**ContainsDeny** | Pointer to **NullableString** | | [optional] +**CampaignId** | Pointer to **NullableString** | | [optional] +**CampaignStatus** | Pointer to **NullableString** | | [optional] + +## Methods + +### NewTemplateSlackCustomFields + +`func NewTemplateSlackCustomFields() *TemplateSlackCustomFields` + +NewTemplateSlackCustomFields instantiates a new TemplateSlackCustomFields 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 + +### NewTemplateSlackCustomFieldsWithDefaults + +`func NewTemplateSlackCustomFieldsWithDefaults() *TemplateSlackCustomFields` + +NewTemplateSlackCustomFieldsWithDefaults instantiates a new TemplateSlackCustomFields 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 + +### GetRequestType + +`func (o *TemplateSlackCustomFields) GetRequestType() string` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *TemplateSlackCustomFields) GetRequestTypeOk() (*string, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *TemplateSlackCustomFields) SetRequestType(v string)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *TemplateSlackCustomFields) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *TemplateSlackCustomFields) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *TemplateSlackCustomFields) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetContainsDeny + +`func (o *TemplateSlackCustomFields) GetContainsDeny() string` + +GetContainsDeny returns the ContainsDeny field if non-nil, zero value otherwise. + +### GetContainsDenyOk + +`func (o *TemplateSlackCustomFields) GetContainsDenyOk() (*string, bool)` + +GetContainsDenyOk returns a tuple with the ContainsDeny field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainsDeny + +`func (o *TemplateSlackCustomFields) SetContainsDeny(v string)` + +SetContainsDeny sets ContainsDeny field to given value. + +### HasContainsDeny + +`func (o *TemplateSlackCustomFields) HasContainsDeny() bool` + +HasContainsDeny returns a boolean if a field has been set. + +### SetContainsDenyNil + +`func (o *TemplateSlackCustomFields) SetContainsDenyNil(b bool)` + + SetContainsDenyNil sets the value for ContainsDeny to be an explicit nil + +### UnsetContainsDeny +`func (o *TemplateSlackCustomFields) UnsetContainsDeny()` + +UnsetContainsDeny ensures that no value is present for ContainsDeny, not even an explicit nil +### GetCampaignId + +`func (o *TemplateSlackCustomFields) GetCampaignId() string` + +GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. + +### GetCampaignIdOk + +`func (o *TemplateSlackCustomFields) GetCampaignIdOk() (*string, bool)` + +GetCampaignIdOk returns a tuple with the CampaignId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignId + +`func (o *TemplateSlackCustomFields) SetCampaignId(v string)` + +SetCampaignId sets CampaignId field to given value. + +### HasCampaignId + +`func (o *TemplateSlackCustomFields) HasCampaignId() bool` + +HasCampaignId returns a boolean if a field has been set. + +### SetCampaignIdNil + +`func (o *TemplateSlackCustomFields) SetCampaignIdNil(b bool)` + + SetCampaignIdNil sets the value for CampaignId to be an explicit nil + +### UnsetCampaignId +`func (o *TemplateSlackCustomFields) UnsetCampaignId()` + +UnsetCampaignId ensures that no value is present for CampaignId, not even an explicit nil +### GetCampaignStatus + +`func (o *TemplateSlackCustomFields) GetCampaignStatus() string` + +GetCampaignStatus returns the CampaignStatus field if non-nil, zero value otherwise. + +### GetCampaignStatusOk + +`func (o *TemplateSlackCustomFields) GetCampaignStatusOk() (*string, bool)` + +GetCampaignStatusOk returns a tuple with the CampaignStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignStatus + +`func (o *TemplateSlackCustomFields) SetCampaignStatus(v string)` + +SetCampaignStatus sets CampaignStatus field to given value. + +### HasCampaignStatus + +`func (o *TemplateSlackCustomFields) HasCampaignStatus() bool` + +HasCampaignStatus returns a boolean if a field has been set. + +### SetCampaignStatusNil + +`func (o *TemplateSlackCustomFields) SetCampaignStatusNil(b bool)` + + SetCampaignStatusNil sets the value for CampaignStatus to be an explicit nil + +### UnsetCampaignStatus +`func (o *TemplateSlackCustomFields) UnsetCampaignStatus()` + +UnsetCampaignStatus ensures that no value is present for CampaignStatus, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TemplateTeams.md b/docs/tools/sdk/go/Reference/V2025/Models/TemplateTeams.md new file mode 100644 index 000000000..6db36960b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TemplateTeams.md @@ -0,0 +1,424 @@ +--- +id: v2025-template-teams +title: TemplateTeams +pagination_label: TemplateTeams +sidebar_label: TemplateTeams +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TemplateTeams', 'V2025TemplateTeams'] +slug: /tools/sdk/go/v2025/models/template-teams +tags: ['SDK', 'Software Development Kit', 'TemplateTeams', 'V2025TemplateTeams'] +--- + +# TemplateTeams + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **NullableString** | | [optional] +**Title** | Pointer to **NullableString** | | [optional] +**Text** | Pointer to **string** | | [optional] +**MessageJSON** | Pointer to **NullableString** | | [optional] +**IsSubscription** | Pointer to **NullableBool** | | [optional] +**ApprovalId** | Pointer to **NullableString** | | [optional] +**RequestId** | Pointer to **NullableString** | | [optional] +**RequestedById** | Pointer to **NullableString** | | [optional] +**NotificationType** | Pointer to **NullableString** | | [optional] +**AutoApprovalData** | Pointer to [**NullableTemplateSlackAutoApprovalData**](template-slack-auto-approval-data) | | [optional] +**CustomFields** | Pointer to [**NullableTemplateSlackCustomFields**](template-slack-custom-fields) | | [optional] + +## Methods + +### NewTemplateTeams + +`func NewTemplateTeams() *TemplateTeams` + +NewTemplateTeams instantiates a new TemplateTeams 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 + +### NewTemplateTeamsWithDefaults + +`func NewTemplateTeamsWithDefaults() *TemplateTeams` + +NewTemplateTeamsWithDefaults instantiates a new TemplateTeams 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 + +### GetKey + +`func (o *TemplateTeams) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TemplateTeams) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TemplateTeams) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *TemplateTeams) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *TemplateTeams) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *TemplateTeams) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetTitle + +`func (o *TemplateTeams) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *TemplateTeams) GetTitleOk() (*string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTitle + +`func (o *TemplateTeams) SetTitle(v string)` + +SetTitle sets Title field to given value. + +### HasTitle + +`func (o *TemplateTeams) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### SetTitleNil + +`func (o *TemplateTeams) SetTitleNil(b bool)` + + SetTitleNil sets the value for Title to be an explicit nil + +### UnsetTitle +`func (o *TemplateTeams) UnsetTitle()` + +UnsetTitle ensures that no value is present for Title, not even an explicit nil +### GetText + +`func (o *TemplateTeams) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *TemplateTeams) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *TemplateTeams) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *TemplateTeams) HasText() bool` + +HasText returns a boolean if a field has been set. + +### GetMessageJSON + +`func (o *TemplateTeams) GetMessageJSON() string` + +GetMessageJSON returns the MessageJSON field if non-nil, zero value otherwise. + +### GetMessageJSONOk + +`func (o *TemplateTeams) GetMessageJSONOk() (*string, bool)` + +GetMessageJSONOk returns a tuple with the MessageJSON field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessageJSON + +`func (o *TemplateTeams) SetMessageJSON(v string)` + +SetMessageJSON sets MessageJSON field to given value. + +### HasMessageJSON + +`func (o *TemplateTeams) HasMessageJSON() bool` + +HasMessageJSON returns a boolean if a field has been set. + +### SetMessageJSONNil + +`func (o *TemplateTeams) SetMessageJSONNil(b bool)` + + SetMessageJSONNil sets the value for MessageJSON to be an explicit nil + +### UnsetMessageJSON +`func (o *TemplateTeams) UnsetMessageJSON()` + +UnsetMessageJSON ensures that no value is present for MessageJSON, not even an explicit nil +### GetIsSubscription + +`func (o *TemplateTeams) GetIsSubscription() bool` + +GetIsSubscription returns the IsSubscription field if non-nil, zero value otherwise. + +### GetIsSubscriptionOk + +`func (o *TemplateTeams) GetIsSubscriptionOk() (*bool, bool)` + +GetIsSubscriptionOk returns a tuple with the IsSubscription field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSubscription + +`func (o *TemplateTeams) SetIsSubscription(v bool)` + +SetIsSubscription sets IsSubscription field to given value. + +### HasIsSubscription + +`func (o *TemplateTeams) HasIsSubscription() bool` + +HasIsSubscription returns a boolean if a field has been set. + +### SetIsSubscriptionNil + +`func (o *TemplateTeams) SetIsSubscriptionNil(b bool)` + + SetIsSubscriptionNil sets the value for IsSubscription to be an explicit nil + +### UnsetIsSubscription +`func (o *TemplateTeams) UnsetIsSubscription()` + +UnsetIsSubscription ensures that no value is present for IsSubscription, not even an explicit nil +### GetApprovalId + +`func (o *TemplateTeams) GetApprovalId() string` + +GetApprovalId returns the ApprovalId field if non-nil, zero value otherwise. + +### GetApprovalIdOk + +`func (o *TemplateTeams) GetApprovalIdOk() (*string, bool)` + +GetApprovalIdOk returns a tuple with the ApprovalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalId + +`func (o *TemplateTeams) SetApprovalId(v string)` + +SetApprovalId sets ApprovalId field to given value. + +### HasApprovalId + +`func (o *TemplateTeams) HasApprovalId() bool` + +HasApprovalId returns a boolean if a field has been set. + +### SetApprovalIdNil + +`func (o *TemplateTeams) SetApprovalIdNil(b bool)` + + SetApprovalIdNil sets the value for ApprovalId to be an explicit nil + +### UnsetApprovalId +`func (o *TemplateTeams) UnsetApprovalId()` + +UnsetApprovalId ensures that no value is present for ApprovalId, not even an explicit nil +### GetRequestId + +`func (o *TemplateTeams) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *TemplateTeams) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *TemplateTeams) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *TemplateTeams) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *TemplateTeams) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *TemplateTeams) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetRequestedById + +`func (o *TemplateTeams) GetRequestedById() string` + +GetRequestedById returns the RequestedById field if non-nil, zero value otherwise. + +### GetRequestedByIdOk + +`func (o *TemplateTeams) GetRequestedByIdOk() (*string, bool)` + +GetRequestedByIdOk returns a tuple with the RequestedById field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedById + +`func (o *TemplateTeams) SetRequestedById(v string)` + +SetRequestedById sets RequestedById field to given value. + +### HasRequestedById + +`func (o *TemplateTeams) HasRequestedById() bool` + +HasRequestedById returns a boolean if a field has been set. + +### SetRequestedByIdNil + +`func (o *TemplateTeams) SetRequestedByIdNil(b bool)` + + SetRequestedByIdNil sets the value for RequestedById to be an explicit nil + +### UnsetRequestedById +`func (o *TemplateTeams) UnsetRequestedById()` + +UnsetRequestedById ensures that no value is present for RequestedById, not even an explicit nil +### GetNotificationType + +`func (o *TemplateTeams) GetNotificationType() string` + +GetNotificationType returns the NotificationType field if non-nil, zero value otherwise. + +### GetNotificationTypeOk + +`func (o *TemplateTeams) GetNotificationTypeOk() (*string, bool)` + +GetNotificationTypeOk returns a tuple with the NotificationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotificationType + +`func (o *TemplateTeams) SetNotificationType(v string)` + +SetNotificationType sets NotificationType field to given value. + +### HasNotificationType + +`func (o *TemplateTeams) HasNotificationType() bool` + +HasNotificationType returns a boolean if a field has been set. + +### SetNotificationTypeNil + +`func (o *TemplateTeams) SetNotificationTypeNil(b bool)` + + SetNotificationTypeNil sets the value for NotificationType to be an explicit nil + +### UnsetNotificationType +`func (o *TemplateTeams) UnsetNotificationType()` + +UnsetNotificationType ensures that no value is present for NotificationType, not even an explicit nil +### GetAutoApprovalData + +`func (o *TemplateTeams) GetAutoApprovalData() TemplateSlackAutoApprovalData` + +GetAutoApprovalData returns the AutoApprovalData field if non-nil, zero value otherwise. + +### GetAutoApprovalDataOk + +`func (o *TemplateTeams) GetAutoApprovalDataOk() (*TemplateSlackAutoApprovalData, bool)` + +GetAutoApprovalDataOk returns a tuple with the AutoApprovalData field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoApprovalData + +`func (o *TemplateTeams) SetAutoApprovalData(v TemplateSlackAutoApprovalData)` + +SetAutoApprovalData sets AutoApprovalData field to given value. + +### HasAutoApprovalData + +`func (o *TemplateTeams) HasAutoApprovalData() bool` + +HasAutoApprovalData returns a boolean if a field has been set. + +### SetAutoApprovalDataNil + +`func (o *TemplateTeams) SetAutoApprovalDataNil(b bool)` + + SetAutoApprovalDataNil sets the value for AutoApprovalData to be an explicit nil + +### UnsetAutoApprovalData +`func (o *TemplateTeams) UnsetAutoApprovalData()` + +UnsetAutoApprovalData ensures that no value is present for AutoApprovalData, not even an explicit nil +### GetCustomFields + +`func (o *TemplateTeams) GetCustomFields() TemplateSlackCustomFields` + +GetCustomFields returns the CustomFields field if non-nil, zero value otherwise. + +### GetCustomFieldsOk + +`func (o *TemplateTeams) GetCustomFieldsOk() (*TemplateSlackCustomFields, bool)` + +GetCustomFieldsOk returns a tuple with the CustomFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomFields + +`func (o *TemplateTeams) SetCustomFields(v TemplateSlackCustomFields)` + +SetCustomFields sets CustomFields field to given value. + +### HasCustomFields + +`func (o *TemplateTeams) HasCustomFields() bool` + +HasCustomFields returns a boolean if a field has been set. + +### SetCustomFieldsNil + +`func (o *TemplateTeams) SetCustomFieldsNil(b bool)` + + SetCustomFieldsNil sets the value for CustomFields to be an explicit nil + +### UnsetCustomFields +`func (o *TemplateTeams) UnsetCustomFields()` + +UnsetCustomFields ensures that no value is present for CustomFields, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Tenant.md b/docs/tools/sdk/go/Reference/V2025/Models/Tenant.md new file mode 100644 index 000000000..efac9b762 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Tenant.md @@ -0,0 +1,220 @@ +--- +id: v2025-tenant +title: Tenant +pagination_label: Tenant +sidebar_label: Tenant +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Tenant', 'V2025Tenant'] +slug: /tools/sdk/go/v2025/models/tenant +tags: ['SDK', 'Software Development Kit', 'Tenant', 'V2025Tenant'] +--- + +# Tenant + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique identifier for the Tenant | [optional] [readonly] +**Name** | Pointer to **string** | Abbreviated name of the Tenant | [optional] +**FullName** | Pointer to **string** | Human-readable name of the Tenant | [optional] +**Pod** | Pointer to **string** | Deployment pod for the Tenant | [optional] +**Region** | Pointer to **string** | Deployment region for the Tenant | [optional] +**Description** | Pointer to **string** | Description of the Tenant | [optional] +**Products** | Pointer to [**[]Product**](product) | | [optional] + +## Methods + +### NewTenant + +`func NewTenant() *Tenant` + +NewTenant instantiates a new Tenant 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 + +### NewTenantWithDefaults + +`func NewTenantWithDefaults() *Tenant` + +NewTenantWithDefaults instantiates a new Tenant 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 + +### GetId + +`func (o *Tenant) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Tenant) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Tenant) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Tenant) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Tenant) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Tenant) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Tenant) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Tenant) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetFullName + +`func (o *Tenant) GetFullName() string` + +GetFullName returns the FullName field if non-nil, zero value otherwise. + +### GetFullNameOk + +`func (o *Tenant) GetFullNameOk() (*string, bool)` + +GetFullNameOk returns a tuple with the FullName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFullName + +`func (o *Tenant) SetFullName(v string)` + +SetFullName sets FullName field to given value. + +### HasFullName + +`func (o *Tenant) HasFullName() bool` + +HasFullName returns a boolean if a field has been set. + +### GetPod + +`func (o *Tenant) GetPod() string` + +GetPod returns the Pod field if non-nil, zero value otherwise. + +### GetPodOk + +`func (o *Tenant) GetPodOk() (*string, bool)` + +GetPodOk returns a tuple with the Pod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPod + +`func (o *Tenant) SetPod(v string)` + +SetPod sets Pod field to given value. + +### HasPod + +`func (o *Tenant) HasPod() bool` + +HasPod returns a boolean if a field has been set. + +### GetRegion + +`func (o *Tenant) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *Tenant) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *Tenant) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *Tenant) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetDescription + +`func (o *Tenant) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Tenant) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Tenant) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Tenant) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetProducts + +`func (o *Tenant) GetProducts() []Product` + +GetProducts returns the Products field if non-nil, zero value otherwise. + +### GetProductsOk + +`func (o *Tenant) GetProductsOk() (*[]Product, bool)` + +GetProductsOk returns a tuple with the Products field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProducts + +`func (o *Tenant) SetProducts(v []Product)` + +SetProducts sets Products field to given value. + +### HasProducts + +`func (o *Tenant) HasProducts() bool` + +HasProducts returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TenantConfigurationDetails.md b/docs/tools/sdk/go/Reference/V2025/Models/TenantConfigurationDetails.md new file mode 100644 index 000000000..9bb6f1a2f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TenantConfigurationDetails.md @@ -0,0 +1,74 @@ +--- +id: v2025-tenant-configuration-details +title: TenantConfigurationDetails +pagination_label: TenantConfigurationDetails +sidebar_label: TenantConfigurationDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantConfigurationDetails', 'V2025TenantConfigurationDetails'] +slug: /tools/sdk/go/v2025/models/tenant-configuration-details +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationDetails', 'V2025TenantConfigurationDetails'] +--- + +# TenantConfigurationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Disabled** | Pointer to **NullableBool** | Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled. | [optional] [default to false] + +## Methods + +### NewTenantConfigurationDetails + +`func NewTenantConfigurationDetails() *TenantConfigurationDetails` + +NewTenantConfigurationDetails instantiates a new TenantConfigurationDetails 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 + +### NewTenantConfigurationDetailsWithDefaults + +`func NewTenantConfigurationDetailsWithDefaults() *TenantConfigurationDetails` + +NewTenantConfigurationDetailsWithDefaults instantiates a new TenantConfigurationDetails 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 + +### GetDisabled + +`func (o *TenantConfigurationDetails) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *TenantConfigurationDetails) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *TenantConfigurationDetails) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *TenantConfigurationDetails) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### SetDisabledNil + +`func (o *TenantConfigurationDetails) SetDisabledNil(b bool)` + + SetDisabledNil sets the value for Disabled to be an explicit nil + +### UnsetDisabled +`func (o *TenantConfigurationDetails) UnsetDisabled()` + +UnsetDisabled ensures that no value is present for Disabled, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TenantConfigurationRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/TenantConfigurationRequest.md new file mode 100644 index 000000000..b24969248 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TenantConfigurationRequest.md @@ -0,0 +1,64 @@ +--- +id: v2025-tenant-configuration-request +title: TenantConfigurationRequest +pagination_label: TenantConfigurationRequest +sidebar_label: TenantConfigurationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantConfigurationRequest', 'V2025TenantConfigurationRequest'] +slug: /tools/sdk/go/v2025/models/tenant-configuration-request +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationRequest', 'V2025TenantConfigurationRequest'] +--- + +# TenantConfigurationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConfigDetails** | Pointer to [**TenantConfigurationDetails**](tenant-configuration-details) | | [optional] + +## Methods + +### NewTenantConfigurationRequest + +`func NewTenantConfigurationRequest() *TenantConfigurationRequest` + +NewTenantConfigurationRequest instantiates a new TenantConfigurationRequest 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 + +### NewTenantConfigurationRequestWithDefaults + +`func NewTenantConfigurationRequestWithDefaults() *TenantConfigurationRequest` + +NewTenantConfigurationRequestWithDefaults instantiates a new TenantConfigurationRequest 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 + +### GetConfigDetails + +`func (o *TenantConfigurationRequest) GetConfigDetails() TenantConfigurationDetails` + +GetConfigDetails returns the ConfigDetails field if non-nil, zero value otherwise. + +### GetConfigDetailsOk + +`func (o *TenantConfigurationRequest) GetConfigDetailsOk() (*TenantConfigurationDetails, bool)` + +GetConfigDetailsOk returns a tuple with the ConfigDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigDetails + +`func (o *TenantConfigurationRequest) SetConfigDetails(v TenantConfigurationDetails)` + +SetConfigDetails sets ConfigDetails field to given value. + +### HasConfigDetails + +`func (o *TenantConfigurationRequest) HasConfigDetails() bool` + +HasConfigDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TenantConfigurationResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/TenantConfigurationResponse.md new file mode 100644 index 000000000..c584c25b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TenantConfigurationResponse.md @@ -0,0 +1,90 @@ +--- +id: v2025-tenant-configuration-response +title: TenantConfigurationResponse +pagination_label: TenantConfigurationResponse +sidebar_label: TenantConfigurationResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantConfigurationResponse', 'V2025TenantConfigurationResponse'] +slug: /tools/sdk/go/v2025/models/tenant-configuration-response +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationResponse', 'V2025TenantConfigurationResponse'] +--- + +# TenantConfigurationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuditDetails** | Pointer to [**AuditDetails**](audit-details) | | [optional] +**ConfigDetails** | Pointer to [**TenantConfigurationDetails**](tenant-configuration-details) | | [optional] + +## Methods + +### NewTenantConfigurationResponse + +`func NewTenantConfigurationResponse() *TenantConfigurationResponse` + +NewTenantConfigurationResponse instantiates a new TenantConfigurationResponse 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 + +### NewTenantConfigurationResponseWithDefaults + +`func NewTenantConfigurationResponseWithDefaults() *TenantConfigurationResponse` + +NewTenantConfigurationResponseWithDefaults instantiates a new TenantConfigurationResponse 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 + +### GetAuditDetails + +`func (o *TenantConfigurationResponse) GetAuditDetails() AuditDetails` + +GetAuditDetails returns the AuditDetails field if non-nil, zero value otherwise. + +### GetAuditDetailsOk + +`func (o *TenantConfigurationResponse) GetAuditDetailsOk() (*AuditDetails, bool)` + +GetAuditDetailsOk returns a tuple with the AuditDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuditDetails + +`func (o *TenantConfigurationResponse) SetAuditDetails(v AuditDetails)` + +SetAuditDetails sets AuditDetails field to given value. + +### HasAuditDetails + +`func (o *TenantConfigurationResponse) HasAuditDetails() bool` + +HasAuditDetails returns a boolean if a field has been set. + +### GetConfigDetails + +`func (o *TenantConfigurationResponse) GetConfigDetails() TenantConfigurationDetails` + +GetConfigDetails returns the ConfigDetails field if non-nil, zero value otherwise. + +### GetConfigDetailsOk + +`func (o *TenantConfigurationResponse) GetConfigDetailsOk() (*TenantConfigurationDetails, bool)` + +GetConfigDetailsOk returns a tuple with the ConfigDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigDetails + +`func (o *TenantConfigurationResponse) SetConfigDetails(v TenantConfigurationDetails)` + +SetConfigDetails sets ConfigDetails field to given value. + +### HasConfigDetails + +`func (o *TenantConfigurationResponse) HasConfigDetails() bool` + +HasConfigDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TenantUiMetadataItemResponse.md b/docs/tools/sdk/go/Reference/V2025/Models/TenantUiMetadataItemResponse.md new file mode 100644 index 000000000..edd6cd32d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TenantUiMetadataItemResponse.md @@ -0,0 +1,146 @@ +--- +id: v2025-tenant-ui-metadata-item-response +title: TenantUiMetadataItemResponse +pagination_label: TenantUiMetadataItemResponse +sidebar_label: TenantUiMetadataItemResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantUiMetadataItemResponse', 'V2025TenantUiMetadataItemResponse'] +slug: /tools/sdk/go/v2025/models/tenant-ui-metadata-item-response +tags: ['SDK', 'Software Development Kit', 'TenantUiMetadataItemResponse', 'V2025TenantUiMetadataItemResponse'] +--- + +# TenantUiMetadataItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IframeWhiteList** | Pointer to **NullableString** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [optional] +**UsernameLabel** | Pointer to **NullableString** | Descriptor for the username input field. If you would like to reset the value use \"null\". | [optional] +**UsernameEmptyText** | Pointer to **NullableString** | Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". | [optional] + +## Methods + +### NewTenantUiMetadataItemResponse + +`func NewTenantUiMetadataItemResponse() *TenantUiMetadataItemResponse` + +NewTenantUiMetadataItemResponse instantiates a new TenantUiMetadataItemResponse 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 + +### NewTenantUiMetadataItemResponseWithDefaults + +`func NewTenantUiMetadataItemResponseWithDefaults() *TenantUiMetadataItemResponse` + +NewTenantUiMetadataItemResponseWithDefaults instantiates a new TenantUiMetadataItemResponse 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 + +### GetIframeWhiteList + +`func (o *TenantUiMetadataItemResponse) GetIframeWhiteList() string` + +GetIframeWhiteList returns the IframeWhiteList field if non-nil, zero value otherwise. + +### GetIframeWhiteListOk + +`func (o *TenantUiMetadataItemResponse) GetIframeWhiteListOk() (*string, bool)` + +GetIframeWhiteListOk returns a tuple with the IframeWhiteList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIframeWhiteList + +`func (o *TenantUiMetadataItemResponse) SetIframeWhiteList(v string)` + +SetIframeWhiteList sets IframeWhiteList field to given value. + +### HasIframeWhiteList + +`func (o *TenantUiMetadataItemResponse) HasIframeWhiteList() bool` + +HasIframeWhiteList returns a boolean if a field has been set. + +### SetIframeWhiteListNil + +`func (o *TenantUiMetadataItemResponse) SetIframeWhiteListNil(b bool)` + + SetIframeWhiteListNil sets the value for IframeWhiteList to be an explicit nil + +### UnsetIframeWhiteList +`func (o *TenantUiMetadataItemResponse) UnsetIframeWhiteList()` + +UnsetIframeWhiteList ensures that no value is present for IframeWhiteList, not even an explicit nil +### GetUsernameLabel + +`func (o *TenantUiMetadataItemResponse) GetUsernameLabel() string` + +GetUsernameLabel returns the UsernameLabel field if non-nil, zero value otherwise. + +### GetUsernameLabelOk + +`func (o *TenantUiMetadataItemResponse) GetUsernameLabelOk() (*string, bool)` + +GetUsernameLabelOk returns a tuple with the UsernameLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsernameLabel + +`func (o *TenantUiMetadataItemResponse) SetUsernameLabel(v string)` + +SetUsernameLabel sets UsernameLabel field to given value. + +### HasUsernameLabel + +`func (o *TenantUiMetadataItemResponse) HasUsernameLabel() bool` + +HasUsernameLabel returns a boolean if a field has been set. + +### SetUsernameLabelNil + +`func (o *TenantUiMetadataItemResponse) SetUsernameLabelNil(b bool)` + + SetUsernameLabelNil sets the value for UsernameLabel to be an explicit nil + +### UnsetUsernameLabel +`func (o *TenantUiMetadataItemResponse) UnsetUsernameLabel()` + +UnsetUsernameLabel ensures that no value is present for UsernameLabel, not even an explicit nil +### GetUsernameEmptyText + +`func (o *TenantUiMetadataItemResponse) GetUsernameEmptyText() string` + +GetUsernameEmptyText returns the UsernameEmptyText field if non-nil, zero value otherwise. + +### GetUsernameEmptyTextOk + +`func (o *TenantUiMetadataItemResponse) GetUsernameEmptyTextOk() (*string, bool)` + +GetUsernameEmptyTextOk returns a tuple with the UsernameEmptyText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsernameEmptyText + +`func (o *TenantUiMetadataItemResponse) SetUsernameEmptyText(v string)` + +SetUsernameEmptyText sets UsernameEmptyText field to given value. + +### HasUsernameEmptyText + +`func (o *TenantUiMetadataItemResponse) HasUsernameEmptyText() bool` + +HasUsernameEmptyText returns a boolean if a field has been set. + +### SetUsernameEmptyTextNil + +`func (o *TenantUiMetadataItemResponse) SetUsernameEmptyTextNil(b bool)` + + SetUsernameEmptyTextNil sets the value for UsernameEmptyText to be an explicit nil + +### UnsetUsernameEmptyText +`func (o *TenantUiMetadataItemResponse) UnsetUsernameEmptyText()` + +UnsetUsernameEmptyText ensures that no value is present for UsernameEmptyText, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TenantUiMetadataItemUpdateRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/TenantUiMetadataItemUpdateRequest.md new file mode 100644 index 000000000..7d4ef165e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TenantUiMetadataItemUpdateRequest.md @@ -0,0 +1,146 @@ +--- +id: v2025-tenant-ui-metadata-item-update-request +title: TenantUiMetadataItemUpdateRequest +pagination_label: TenantUiMetadataItemUpdateRequest +sidebar_label: TenantUiMetadataItemUpdateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TenantUiMetadataItemUpdateRequest', 'V2025TenantUiMetadataItemUpdateRequest'] +slug: /tools/sdk/go/v2025/models/tenant-ui-metadata-item-update-request +tags: ['SDK', 'Software Development Kit', 'TenantUiMetadataItemUpdateRequest', 'V2025TenantUiMetadataItemUpdateRequest'] +--- + +# TenantUiMetadataItemUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IframeWhiteList** | Pointer to **NullableString** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [optional] +**UsernameLabel** | Pointer to **NullableString** | Descriptor for the username input field. If you would like to reset the value use \"null\". | [optional] +**UsernameEmptyText** | Pointer to **NullableString** | Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". | [optional] + +## Methods + +### NewTenantUiMetadataItemUpdateRequest + +`func NewTenantUiMetadataItemUpdateRequest() *TenantUiMetadataItemUpdateRequest` + +NewTenantUiMetadataItemUpdateRequest instantiates a new TenantUiMetadataItemUpdateRequest 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 + +### NewTenantUiMetadataItemUpdateRequestWithDefaults + +`func NewTenantUiMetadataItemUpdateRequestWithDefaults() *TenantUiMetadataItemUpdateRequest` + +NewTenantUiMetadataItemUpdateRequestWithDefaults instantiates a new TenantUiMetadataItemUpdateRequest 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 + +### GetIframeWhiteList + +`func (o *TenantUiMetadataItemUpdateRequest) GetIframeWhiteList() string` + +GetIframeWhiteList returns the IframeWhiteList field if non-nil, zero value otherwise. + +### GetIframeWhiteListOk + +`func (o *TenantUiMetadataItemUpdateRequest) GetIframeWhiteListOk() (*string, bool)` + +GetIframeWhiteListOk returns a tuple with the IframeWhiteList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIframeWhiteList + +`func (o *TenantUiMetadataItemUpdateRequest) SetIframeWhiteList(v string)` + +SetIframeWhiteList sets IframeWhiteList field to given value. + +### HasIframeWhiteList + +`func (o *TenantUiMetadataItemUpdateRequest) HasIframeWhiteList() bool` + +HasIframeWhiteList returns a boolean if a field has been set. + +### SetIframeWhiteListNil + +`func (o *TenantUiMetadataItemUpdateRequest) SetIframeWhiteListNil(b bool)` + + SetIframeWhiteListNil sets the value for IframeWhiteList to be an explicit nil + +### UnsetIframeWhiteList +`func (o *TenantUiMetadataItemUpdateRequest) UnsetIframeWhiteList()` + +UnsetIframeWhiteList ensures that no value is present for IframeWhiteList, not even an explicit nil +### GetUsernameLabel + +`func (o *TenantUiMetadataItemUpdateRequest) GetUsernameLabel() string` + +GetUsernameLabel returns the UsernameLabel field if non-nil, zero value otherwise. + +### GetUsernameLabelOk + +`func (o *TenantUiMetadataItemUpdateRequest) GetUsernameLabelOk() (*string, bool)` + +GetUsernameLabelOk returns a tuple with the UsernameLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsernameLabel + +`func (o *TenantUiMetadataItemUpdateRequest) SetUsernameLabel(v string)` + +SetUsernameLabel sets UsernameLabel field to given value. + +### HasUsernameLabel + +`func (o *TenantUiMetadataItemUpdateRequest) HasUsernameLabel() bool` + +HasUsernameLabel returns a boolean if a field has been set. + +### SetUsernameLabelNil + +`func (o *TenantUiMetadataItemUpdateRequest) SetUsernameLabelNil(b bool)` + + SetUsernameLabelNil sets the value for UsernameLabel to be an explicit nil + +### UnsetUsernameLabel +`func (o *TenantUiMetadataItemUpdateRequest) UnsetUsernameLabel()` + +UnsetUsernameLabel ensures that no value is present for UsernameLabel, not even an explicit nil +### GetUsernameEmptyText + +`func (o *TenantUiMetadataItemUpdateRequest) GetUsernameEmptyText() string` + +GetUsernameEmptyText returns the UsernameEmptyText field if non-nil, zero value otherwise. + +### GetUsernameEmptyTextOk + +`func (o *TenantUiMetadataItemUpdateRequest) GetUsernameEmptyTextOk() (*string, bool)` + +GetUsernameEmptyTextOk returns a tuple with the UsernameEmptyText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsernameEmptyText + +`func (o *TenantUiMetadataItemUpdateRequest) SetUsernameEmptyText(v string)` + +SetUsernameEmptyText sets UsernameEmptyText field to given value. + +### HasUsernameEmptyText + +`func (o *TenantUiMetadataItemUpdateRequest) HasUsernameEmptyText() bool` + +HasUsernameEmptyText returns a boolean if a field has been set. + +### SetUsernameEmptyTextNil + +`func (o *TenantUiMetadataItemUpdateRequest) SetUsernameEmptyTextNil(b bool)` + + SetUsernameEmptyTextNil sets the value for UsernameEmptyText to be an explicit nil + +### UnsetUsernameEmptyText +`func (o *TenantUiMetadataItemUpdateRequest) UnsetUsernameEmptyText()` + +UnsetUsernameEmptyText ensures that no value is present for UsernameEmptyText, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TestExternalExecuteWorkflow200Response.md b/docs/tools/sdk/go/Reference/V2025/Models/TestExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..6dbbf7694 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TestExternalExecuteWorkflow200Response.md @@ -0,0 +1,64 @@ +--- +id: v2025-test-external-execute-workflow200-response +title: TestExternalExecuteWorkflow200Response +pagination_label: TestExternalExecuteWorkflow200Response +sidebar_label: TestExternalExecuteWorkflow200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestExternalExecuteWorkflow200Response', 'V2025TestExternalExecuteWorkflow200Response'] +slug: /tools/sdk/go/v2025/models/test-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflow200Response', 'V2025TestExternalExecuteWorkflow200Response'] +--- + +# TestExternalExecuteWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Payload** | Pointer to **map[string]interface{}** | The input that was received | [optional] + +## Methods + +### NewTestExternalExecuteWorkflow200Response + +`func NewTestExternalExecuteWorkflow200Response() *TestExternalExecuteWorkflow200Response` + +NewTestExternalExecuteWorkflow200Response instantiates a new TestExternalExecuteWorkflow200Response 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 + +### NewTestExternalExecuteWorkflow200ResponseWithDefaults + +`func NewTestExternalExecuteWorkflow200ResponseWithDefaults() *TestExternalExecuteWorkflow200Response` + +NewTestExternalExecuteWorkflow200ResponseWithDefaults instantiates a new TestExternalExecuteWorkflow200Response 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 + +### GetPayload + +`func (o *TestExternalExecuteWorkflow200Response) GetPayload() map[string]interface{}` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *TestExternalExecuteWorkflow200Response) GetPayloadOk() (*map[string]interface{}, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPayload + +`func (o *TestExternalExecuteWorkflow200Response) SetPayload(v map[string]interface{})` + +SetPayload sets Payload field to given value. + +### HasPayload + +`func (o *TestExternalExecuteWorkflow200Response) HasPayload() bool` + +HasPayload returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TestExternalExecuteWorkflowRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/TestExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..be5941506 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TestExternalExecuteWorkflowRequest.md @@ -0,0 +1,64 @@ +--- +id: v2025-test-external-execute-workflow-request +title: TestExternalExecuteWorkflowRequest +pagination_label: TestExternalExecuteWorkflowRequest +sidebar_label: TestExternalExecuteWorkflowRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestExternalExecuteWorkflowRequest', 'V2025TestExternalExecuteWorkflowRequest'] +slug: /tools/sdk/go/v2025/models/test-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflowRequest', 'V2025TestExternalExecuteWorkflowRequest'] +--- + +# TestExternalExecuteWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | Pointer to **map[string]interface{}** | The test input for the workflow | [optional] + +## Methods + +### NewTestExternalExecuteWorkflowRequest + +`func NewTestExternalExecuteWorkflowRequest() *TestExternalExecuteWorkflowRequest` + +NewTestExternalExecuteWorkflowRequest instantiates a new TestExternalExecuteWorkflowRequest 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 + +### NewTestExternalExecuteWorkflowRequestWithDefaults + +`func NewTestExternalExecuteWorkflowRequestWithDefaults() *TestExternalExecuteWorkflowRequest` + +NewTestExternalExecuteWorkflowRequestWithDefaults instantiates a new TestExternalExecuteWorkflowRequest 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 + +### GetInput + +`func (o *TestExternalExecuteWorkflowRequest) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *TestExternalExecuteWorkflowRequest) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *TestExternalExecuteWorkflowRequest) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + +### HasInput + +`func (o *TestExternalExecuteWorkflowRequest) HasInput() bool` + +HasInput returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TestInvocation.md b/docs/tools/sdk/go/Reference/V2025/Models/TestInvocation.md new file mode 100644 index 000000000..48bc05cb8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TestInvocation.md @@ -0,0 +1,132 @@ +--- +id: v2025-test-invocation +title: TestInvocation +pagination_label: TestInvocation +sidebar_label: TestInvocation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestInvocation', 'V2025TestInvocation'] +slug: /tools/sdk/go/v2025/models/test-invocation +tags: ['SDK', 'Software Development Kit', 'TestInvocation', 'V2025TestInvocation'] +--- + +# TestInvocation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TriggerId** | **string** | Trigger ID | +**Input** | Pointer to **map[string]interface{}** | Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent. | [optional] +**ContentJson** | **map[string]interface{}** | JSON map of invocation metadata. | +**SubscriptionIds** | Pointer to **[]string** | Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers. | [optional] + +## Methods + +### NewTestInvocation + +`func NewTestInvocation(triggerId string, contentJson map[string]interface{}, ) *TestInvocation` + +NewTestInvocation instantiates a new TestInvocation 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 + +### NewTestInvocationWithDefaults + +`func NewTestInvocationWithDefaults() *TestInvocation` + +NewTestInvocationWithDefaults instantiates a new TestInvocation 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 + +### GetTriggerId + +`func (o *TestInvocation) GetTriggerId() string` + +GetTriggerId returns the TriggerId field if non-nil, zero value otherwise. + +### GetTriggerIdOk + +`func (o *TestInvocation) GetTriggerIdOk() (*string, bool)` + +GetTriggerIdOk returns a tuple with the TriggerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTriggerId + +`func (o *TestInvocation) SetTriggerId(v string)` + +SetTriggerId sets TriggerId field to given value. + + +### GetInput + +`func (o *TestInvocation) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *TestInvocation) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *TestInvocation) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + +### HasInput + +`func (o *TestInvocation) HasInput() bool` + +HasInput returns a boolean if a field has been set. + +### GetContentJson + +`func (o *TestInvocation) GetContentJson() map[string]interface{}` + +GetContentJson returns the ContentJson field if non-nil, zero value otherwise. + +### GetContentJsonOk + +`func (o *TestInvocation) GetContentJsonOk() (*map[string]interface{}, bool)` + +GetContentJsonOk returns a tuple with the ContentJson field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContentJson + +`func (o *TestInvocation) SetContentJson(v map[string]interface{})` + +SetContentJson sets ContentJson field to given value. + + +### GetSubscriptionIds + +`func (o *TestInvocation) GetSubscriptionIds() []string` + +GetSubscriptionIds returns the SubscriptionIds field if non-nil, zero value otherwise. + +### GetSubscriptionIdsOk + +`func (o *TestInvocation) GetSubscriptionIdsOk() (*[]string, bool)` + +GetSubscriptionIdsOk returns a tuple with the SubscriptionIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubscriptionIds + +`func (o *TestInvocation) SetSubscriptionIds(v []string)` + +SetSubscriptionIds sets SubscriptionIds field to given value. + +### HasSubscriptionIds + +`func (o *TestInvocation) HasSubscriptionIds() bool` + +HasSubscriptionIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TestSourceConnectionMultihost200Response.md b/docs/tools/sdk/go/Reference/V2025/Models/TestSourceConnectionMultihost200Response.md new file mode 100644 index 000000000..8e64fc8d5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TestSourceConnectionMultihost200Response.md @@ -0,0 +1,168 @@ +--- +id: v2025-test-source-connection-multihost200-response +title: TestSourceConnectionMultihost200Response +pagination_label: TestSourceConnectionMultihost200Response +sidebar_label: TestSourceConnectionMultihost200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestSourceConnectionMultihost200Response', 'V2025TestSourceConnectionMultihost200Response'] +slug: /tools/sdk/go/v2025/models/test-source-connection-multihost200-response +tags: ['SDK', 'Software Development Kit', 'TestSourceConnectionMultihost200Response', 'V2025TestSourceConnectionMultihost200Response'] +--- + +# TestSourceConnectionMultihost200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Success** | Pointer to **bool** | Source's test connection status. | [optional] +**Message** | Pointer to **string** | Source's test connection message. | [optional] +**Timing** | Pointer to **int32** | Source's test connection timing. | [optional] +**ResultType** | Pointer to **map[string]interface{}** | Source's human-readable result type. | [optional] +**TestConnectionDetails** | Pointer to **string** | Source's human-readable test connection details. | [optional] + +## Methods + +### NewTestSourceConnectionMultihost200Response + +`func NewTestSourceConnectionMultihost200Response() *TestSourceConnectionMultihost200Response` + +NewTestSourceConnectionMultihost200Response instantiates a new TestSourceConnectionMultihost200Response 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 + +### NewTestSourceConnectionMultihost200ResponseWithDefaults + +`func NewTestSourceConnectionMultihost200ResponseWithDefaults() *TestSourceConnectionMultihost200Response` + +NewTestSourceConnectionMultihost200ResponseWithDefaults instantiates a new TestSourceConnectionMultihost200Response 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 + +### GetSuccess + +`func (o *TestSourceConnectionMultihost200Response) GetSuccess() bool` + +GetSuccess returns the Success field if non-nil, zero value otherwise. + +### GetSuccessOk + +`func (o *TestSourceConnectionMultihost200Response) GetSuccessOk() (*bool, bool)` + +GetSuccessOk returns a tuple with the Success field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSuccess + +`func (o *TestSourceConnectionMultihost200Response) SetSuccess(v bool)` + +SetSuccess sets Success field to given value. + +### HasSuccess + +`func (o *TestSourceConnectionMultihost200Response) HasSuccess() bool` + +HasSuccess returns a boolean if a field has been set. + +### GetMessage + +`func (o *TestSourceConnectionMultihost200Response) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *TestSourceConnectionMultihost200Response) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *TestSourceConnectionMultihost200Response) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *TestSourceConnectionMultihost200Response) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetTiming + +`func (o *TestSourceConnectionMultihost200Response) GetTiming() int32` + +GetTiming returns the Timing field if non-nil, zero value otherwise. + +### GetTimingOk + +`func (o *TestSourceConnectionMultihost200Response) GetTimingOk() (*int32, bool)` + +GetTimingOk returns a tuple with the Timing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTiming + +`func (o *TestSourceConnectionMultihost200Response) SetTiming(v int32)` + +SetTiming sets Timing field to given value. + +### HasTiming + +`func (o *TestSourceConnectionMultihost200Response) HasTiming() bool` + +HasTiming returns a boolean if a field has been set. + +### GetResultType + +`func (o *TestSourceConnectionMultihost200Response) GetResultType() map[string]interface{}` + +GetResultType returns the ResultType field if non-nil, zero value otherwise. + +### GetResultTypeOk + +`func (o *TestSourceConnectionMultihost200Response) GetResultTypeOk() (*map[string]interface{}, bool)` + +GetResultTypeOk returns a tuple with the ResultType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultType + +`func (o *TestSourceConnectionMultihost200Response) SetResultType(v map[string]interface{})` + +SetResultType sets ResultType field to given value. + +### HasResultType + +`func (o *TestSourceConnectionMultihost200Response) HasResultType() bool` + +HasResultType returns a boolean if a field has been set. + +### GetTestConnectionDetails + +`func (o *TestSourceConnectionMultihost200Response) GetTestConnectionDetails() string` + +GetTestConnectionDetails returns the TestConnectionDetails field if non-nil, zero value otherwise. + +### GetTestConnectionDetailsOk + +`func (o *TestSourceConnectionMultihost200Response) GetTestConnectionDetailsOk() (*string, bool)` + +GetTestConnectionDetailsOk returns a tuple with the TestConnectionDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTestConnectionDetails + +`func (o *TestSourceConnectionMultihost200Response) SetTestConnectionDetails(v string)` + +SetTestConnectionDetails sets TestConnectionDetails field to given value. + +### HasTestConnectionDetails + +`func (o *TestSourceConnectionMultihost200Response) HasTestConnectionDetails() bool` + +HasTestConnectionDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TestWorkflow200Response.md b/docs/tools/sdk/go/Reference/V2025/Models/TestWorkflow200Response.md new file mode 100644 index 000000000..ed4bb964a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TestWorkflow200Response.md @@ -0,0 +1,64 @@ +--- +id: v2025-test-workflow200-response +title: TestWorkflow200Response +pagination_label: TestWorkflow200Response +sidebar_label: TestWorkflow200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestWorkflow200Response', 'V2025TestWorkflow200Response'] +slug: /tools/sdk/go/v2025/models/test-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestWorkflow200Response', 'V2025TestWorkflow200Response'] +--- + +# TestWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**WorkflowExecutionId** | Pointer to **string** | The workflow execution id | [optional] + +## Methods + +### NewTestWorkflow200Response + +`func NewTestWorkflow200Response() *TestWorkflow200Response` + +NewTestWorkflow200Response instantiates a new TestWorkflow200Response 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 + +### NewTestWorkflow200ResponseWithDefaults + +`func NewTestWorkflow200ResponseWithDefaults() *TestWorkflow200Response` + +NewTestWorkflow200ResponseWithDefaults instantiates a new TestWorkflow200Response 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 + +### GetWorkflowExecutionId + +`func (o *TestWorkflow200Response) GetWorkflowExecutionId() string` + +GetWorkflowExecutionId returns the WorkflowExecutionId field if non-nil, zero value otherwise. + +### GetWorkflowExecutionIdOk + +`func (o *TestWorkflow200Response) GetWorkflowExecutionIdOk() (*string, bool)` + +GetWorkflowExecutionIdOk returns a tuple with the WorkflowExecutionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWorkflowExecutionId + +`func (o *TestWorkflow200Response) SetWorkflowExecutionId(v string)` + +SetWorkflowExecutionId sets WorkflowExecutionId field to given value. + +### HasWorkflowExecutionId + +`func (o *TestWorkflow200Response) HasWorkflowExecutionId() bool` + +HasWorkflowExecutionId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TestWorkflowRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/TestWorkflowRequest.md new file mode 100644 index 000000000..88cdd01c3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TestWorkflowRequest.md @@ -0,0 +1,59 @@ +--- +id: v2025-test-workflow-request +title: TestWorkflowRequest +pagination_label: TestWorkflowRequest +sidebar_label: TestWorkflowRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestWorkflowRequest', 'V2025TestWorkflowRequest'] +slug: /tools/sdk/go/v2025/models/test-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestWorkflowRequest', 'V2025TestWorkflowRequest'] +--- + +# TestWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | **map[string]interface{}** | The test input for the workflow. | + +## Methods + +### NewTestWorkflowRequest + +`func NewTestWorkflowRequest(input map[string]interface{}, ) *TestWorkflowRequest` + +NewTestWorkflowRequest instantiates a new TestWorkflowRequest 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 + +### NewTestWorkflowRequestWithDefaults + +`func NewTestWorkflowRequestWithDefaults() *TestWorkflowRequest` + +NewTestWorkflowRequestWithDefaults instantiates a new TestWorkflowRequest 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 + +### GetInput + +`func (o *TestWorkflowRequest) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *TestWorkflowRequest) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *TestWorkflowRequest) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TextQuery.md b/docs/tools/sdk/go/Reference/V2025/Models/TextQuery.md new file mode 100644 index 000000000..1f3f86e10 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TextQuery.md @@ -0,0 +1,132 @@ +--- +id: v2025-text-query +title: TextQuery +pagination_label: TextQuery +sidebar_label: TextQuery +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TextQuery', 'V2025TextQuery'] +slug: /tools/sdk/go/v2025/models/text-query +tags: ['SDK', 'Software Development Kit', 'TextQuery', 'V2025TextQuery'] +--- + +# TextQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Terms** | **[]string** | Words or characters that specify a particular thing to be searched for. | +**Fields** | **[]string** | The fields to be searched. | +**MatchAny** | Pointer to **bool** | Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. | [optional] [default to false] +**Contains** | Pointer to **bool** | Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. | [optional] [default to false] + +## Methods + +### NewTextQuery + +`func NewTextQuery(terms []string, fields []string, ) *TextQuery` + +NewTextQuery instantiates a new TextQuery 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 + +### NewTextQueryWithDefaults + +`func NewTextQueryWithDefaults() *TextQuery` + +NewTextQueryWithDefaults instantiates a new TextQuery 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 + +### GetTerms + +`func (o *TextQuery) GetTerms() []string` + +GetTerms returns the Terms field if non-nil, zero value otherwise. + +### GetTermsOk + +`func (o *TextQuery) GetTermsOk() (*[]string, bool)` + +GetTermsOk returns a tuple with the Terms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerms + +`func (o *TextQuery) SetTerms(v []string)` + +SetTerms sets Terms field to given value. + + +### GetFields + +`func (o *TextQuery) GetFields() []string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *TextQuery) GetFieldsOk() (*[]string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *TextQuery) SetFields(v []string)` + +SetFields sets Fields field to given value. + + +### GetMatchAny + +`func (o *TextQuery) GetMatchAny() bool` + +GetMatchAny returns the MatchAny field if non-nil, zero value otherwise. + +### GetMatchAnyOk + +`func (o *TextQuery) GetMatchAnyOk() (*bool, bool)` + +GetMatchAnyOk returns a tuple with the MatchAny field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAny + +`func (o *TextQuery) SetMatchAny(v bool)` + +SetMatchAny sets MatchAny field to given value. + +### HasMatchAny + +`func (o *TextQuery) HasMatchAny() bool` + +HasMatchAny returns a boolean if a field has been set. + +### GetContains + +`func (o *TextQuery) GetContains() bool` + +GetContains returns the Contains field if non-nil, zero value otherwise. + +### GetContainsOk + +`func (o *TextQuery) GetContainsOk() (*bool, bool)` + +GetContainsOk returns a tuple with the Contains field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContains + +`func (o *TextQuery) SetContains(v bool)` + +SetContains sets Contains field to given value. + +### HasContains + +`func (o *TextQuery) HasContains() bool` + +HasContains returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Transform.md b/docs/tools/sdk/go/Reference/V2025/Models/Transform.md new file mode 100644 index 000000000..a7948e91e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Transform.md @@ -0,0 +1,111 @@ +--- +id: v2025-transform +title: Transform +pagination_label: Transform +sidebar_label: Transform +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Transform', 'V2025Transform'] +slug: /tools/sdk/go/v2025/models/transform +tags: ['SDK', 'Software Development Kit', 'Transform', 'V2025Transform'] +--- + +# Transform + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Unique name of this transform | +**Type** | **string** | The type of transform operation | +**Attributes** | **map[string]interface{}** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | + +## Methods + +### NewTransform + +`func NewTransform(name string, type_ string, attributes map[string]interface{}, ) *Transform` + +NewTransform instantiates a new Transform 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 + +### NewTransformWithDefaults + +`func NewTransformWithDefaults() *Transform` + +NewTransformWithDefaults instantiates a new Transform 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 + +### GetName + +`func (o *Transform) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Transform) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Transform) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *Transform) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Transform) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Transform) SetType(v string)` + +SetType sets Type field to given value. + + +### GetAttributes + +`func (o *Transform) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Transform) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Transform) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *Transform) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *Transform) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TransformDefinition.md b/docs/tools/sdk/go/Reference/V2025/Models/TransformDefinition.md new file mode 100644 index 000000000..60c44d6b1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TransformDefinition.md @@ -0,0 +1,90 @@ +--- +id: v2025-transform-definition +title: TransformDefinition +pagination_label: TransformDefinition +sidebar_label: TransformDefinition +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TransformDefinition', 'V2025TransformDefinition'] +slug: /tools/sdk/go/v2025/models/transform-definition +tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'V2025TransformDefinition'] +--- + +# TransformDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Transform definition type. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Arbitrary key-value pairs to store any metadata for the object | [optional] + +## Methods + +### NewTransformDefinition + +`func NewTransformDefinition() *TransformDefinition` + +NewTransformDefinition instantiates a new TransformDefinition 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 + +### NewTransformDefinitionWithDefaults + +`func NewTransformDefinitionWithDefaults() *TransformDefinition` + +NewTransformDefinitionWithDefaults instantiates a new TransformDefinition 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 + +### GetType + +`func (o *TransformDefinition) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TransformDefinition) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TransformDefinition) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TransformDefinition) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetAttributes + +`func (o *TransformDefinition) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TransformDefinition) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TransformDefinition) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *TransformDefinition) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TransformRead.md b/docs/tools/sdk/go/Reference/V2025/Models/TransformRead.md new file mode 100644 index 000000000..2da7d8566 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TransformRead.md @@ -0,0 +1,153 @@ +--- +id: v2025-transform-read +title: TransformRead +pagination_label: TransformRead +sidebar_label: TransformRead +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TransformRead', 'V2025TransformRead'] +slug: /tools/sdk/go/v2025/models/transform-read +tags: ['SDK', 'Software Development Kit', 'TransformRead', 'V2025TransformRead'] +--- + +# TransformRead + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Unique name of this transform | +**Type** | **string** | The type of transform operation | +**Attributes** | **map[string]interface{}** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | +**Id** | **string** | Unique ID of this transform | +**Internal** | **bool** | Indicates whether this is an internal SailPoint-created transform or a customer-created transform | [default to false] + +## Methods + +### NewTransformRead + +`func NewTransformRead(name string, type_ string, attributes map[string]interface{}, id string, internal bool, ) *TransformRead` + +NewTransformRead instantiates a new TransformRead 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 + +### NewTransformReadWithDefaults + +`func NewTransformReadWithDefaults() *TransformRead` + +NewTransformReadWithDefaults instantiates a new TransformRead 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 + +### GetName + +`func (o *TransformRead) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TransformRead) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TransformRead) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *TransformRead) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TransformRead) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TransformRead) SetType(v string)` + +SetType sets Type field to given value. + + +### GetAttributes + +`func (o *TransformRead) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TransformRead) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TransformRead) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *TransformRead) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *TransformRead) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetId + +`func (o *TransformRead) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TransformRead) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TransformRead) SetId(v string)` + +SetId sets Id field to given value. + + +### GetInternal + +`func (o *TransformRead) GetInternal() bool` + +GetInternal returns the Internal field if non-nil, zero value otherwise. + +### GetInternalOk + +`func (o *TransformRead) GetInternalOk() (*bool, bool)` + +GetInternalOk returns a tuple with the Internal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternal + +`func (o *TransformRead) SetInternal(v bool)` + +SetInternal sets Internal field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TranslationMessage.md b/docs/tools/sdk/go/Reference/V2025/Models/TranslationMessage.md new file mode 100644 index 000000000..f542595f5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TranslationMessage.md @@ -0,0 +1,90 @@ +--- +id: v2025-translation-message +title: TranslationMessage +pagination_label: TranslationMessage +sidebar_label: TranslationMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TranslationMessage', 'V2025TranslationMessage'] +slug: /tools/sdk/go/v2025/models/translation-message +tags: ['SDK', 'Software Development Kit', 'TranslationMessage', 'V2025TranslationMessage'] +--- + +# TranslationMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The key of the translation message | [optional] +**Values** | Pointer to **[]string** | The values corresponding to the translation messages | [optional] + +## Methods + +### NewTranslationMessage + +`func NewTranslationMessage() *TranslationMessage` + +NewTranslationMessage instantiates a new TranslationMessage 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 + +### NewTranslationMessageWithDefaults + +`func NewTranslationMessageWithDefaults() *TranslationMessage` + +NewTranslationMessageWithDefaults instantiates a new TranslationMessage 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 + +### GetKey + +`func (o *TranslationMessage) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TranslationMessage) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TranslationMessage) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *TranslationMessage) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetValues + +`func (o *TranslationMessage) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *TranslationMessage) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *TranslationMessage) SetValues(v []string)` + +SetValues sets Values field to given value. + +### HasValues + +`func (o *TranslationMessage) HasValues() bool` + +HasValues returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Trigger.md b/docs/tools/sdk/go/Reference/V2025/Models/Trigger.md new file mode 100644 index 000000000..a0a55d0a0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Trigger.md @@ -0,0 +1,241 @@ +--- +id: v2025-trigger +title: Trigger +pagination_label: Trigger +sidebar_label: Trigger +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Trigger', 'V2025Trigger'] +slug: /tools/sdk/go/v2025/models/trigger +tags: ['SDK', 'Software Development Kit', 'Trigger', 'V2025Trigger'] +--- + +# Trigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier of the trigger. | +**Name** | **string** | Trigger Name. | +**Type** | [**TriggerType**](trigger-type) | | +**Description** | Pointer to **string** | Trigger Description. | [optional] +**InputSchema** | **string** | The JSON schema of the payload that will be sent by the trigger to the subscribed service. | +**ExampleInput** | [**TriggerExampleInput**](trigger-example-input) | | +**OutputSchema** | Pointer to **NullableString** | The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`. | [optional] +**ExampleOutput** | Pointer to [**NullableTriggerExampleOutput**](trigger-example-output) | | [optional] + +## Methods + +### NewTrigger + +`func NewTrigger(id string, name string, type_ TriggerType, inputSchema string, exampleInput TriggerExampleInput, ) *Trigger` + +NewTrigger instantiates a new Trigger 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 + +### NewTriggerWithDefaults + +`func NewTriggerWithDefaults() *Trigger` + +NewTriggerWithDefaults instantiates a new Trigger 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 + +### GetId + +`func (o *Trigger) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Trigger) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Trigger) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *Trigger) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Trigger) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Trigger) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *Trigger) GetType() TriggerType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Trigger) GetTypeOk() (*TriggerType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Trigger) SetType(v TriggerType)` + +SetType sets Type field to given value. + + +### GetDescription + +`func (o *Trigger) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Trigger) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Trigger) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Trigger) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetInputSchema + +`func (o *Trigger) GetInputSchema() string` + +GetInputSchema returns the InputSchema field if non-nil, zero value otherwise. + +### GetInputSchemaOk + +`func (o *Trigger) GetInputSchemaOk() (*string, bool)` + +GetInputSchemaOk returns a tuple with the InputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInputSchema + +`func (o *Trigger) SetInputSchema(v string)` + +SetInputSchema sets InputSchema field to given value. + + +### GetExampleInput + +`func (o *Trigger) GetExampleInput() TriggerExampleInput` + +GetExampleInput returns the ExampleInput field if non-nil, zero value otherwise. + +### GetExampleInputOk + +`func (o *Trigger) GetExampleInputOk() (*TriggerExampleInput, bool)` + +GetExampleInputOk returns a tuple with the ExampleInput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExampleInput + +`func (o *Trigger) SetExampleInput(v TriggerExampleInput)` + +SetExampleInput sets ExampleInput field to given value. + + +### GetOutputSchema + +`func (o *Trigger) GetOutputSchema() string` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *Trigger) GetOutputSchemaOk() (*string, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *Trigger) SetOutputSchema(v string)` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *Trigger) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + +### SetOutputSchemaNil + +`func (o *Trigger) SetOutputSchemaNil(b bool)` + + SetOutputSchemaNil sets the value for OutputSchema to be an explicit nil + +### UnsetOutputSchema +`func (o *Trigger) UnsetOutputSchema()` + +UnsetOutputSchema ensures that no value is present for OutputSchema, not even an explicit nil +### GetExampleOutput + +`func (o *Trigger) GetExampleOutput() TriggerExampleOutput` + +GetExampleOutput returns the ExampleOutput field if non-nil, zero value otherwise. + +### GetExampleOutputOk + +`func (o *Trigger) GetExampleOutputOk() (*TriggerExampleOutput, bool)` + +GetExampleOutputOk returns a tuple with the ExampleOutput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExampleOutput + +`func (o *Trigger) SetExampleOutput(v TriggerExampleOutput)` + +SetExampleOutput sets ExampleOutput field to given value. + +### HasExampleOutput + +`func (o *Trigger) HasExampleOutput() bool` + +HasExampleOutput returns a boolean if a field has been set. + +### SetExampleOutputNil + +`func (o *Trigger) SetExampleOutputNil(b bool)` + + SetExampleOutputNil sets the value for ExampleOutput to be an explicit nil + +### UnsetExampleOutput +`func (o *Trigger) UnsetExampleOutput()` + +UnsetExampleOutput ensures that no value is present for ExampleOutput, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TriggerExampleInput.md b/docs/tools/sdk/go/Reference/V2025/Models/TriggerExampleInput.md new file mode 100644 index 000000000..4bd932ced --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TriggerExampleInput.md @@ -0,0 +1,1127 @@ +--- +id: v2025-trigger-example-input +title: TriggerExampleInput +pagination_label: TriggerExampleInput +sidebar_label: TriggerExampleInput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TriggerExampleInput', 'V2025TriggerExampleInput'] +slug: /tools/sdk/go/v2025/models/trigger-example-input +tags: ['SDK', 'Software Development Kit', 'TriggerExampleInput', 'V2025TriggerExampleInput'] +--- + +# TriggerExampleInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **string** | The unique ID of the access request. | +**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | +**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | +**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | +**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | +**Source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | +**Status** | **map[string]interface{}** | The overall status of the collection. | +**Started** | **SailPointTime** | The date and time when the account collection started. | +**Completed** | **SailPointTime** | The date and time when the account collection finished. | +**Errors** | **[]string** | A list of any accumulated error messages that occurred during provisioning. | +**Warnings** | **[]string** | A list of any accumulated warning messages that occurred during provisioning. | +**Stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | +**Identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | +**Account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | +**Changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | +**Attributes** | **map[string]interface{}** | The attributes of the account. The contents of attributes depends on the account schema for the source. | +**EntitlementCount** | Pointer to **int32** | The number of entitlements associated with this account. | [optional] +**Campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | +**Certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | +**TrackingNumber** | **string** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | +**Sources** | **string** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | +**Action** | Pointer to **NullableString** | Origin of where the provisioning request came from. | [optional] +**Recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | +**Requester** | Pointer to [**NullableProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional] +**AccountRequests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | +**FileName** | **string** | A name for the report file. | +**OwnerEmail** | **string** | The email address of the identity that owns the saved search. | +**OwnerName** | **string** | The name of the identity that owns the saved search. | +**Query** | **string** | The search query that was used to generate the report. | +**SearchName** | **string** | The name of the saved search. | +**SearchResults** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | +**SignedS3Url** | **string** | The Amazon S3 URL to download the report from. | +**Uuid** | Pointer to **string** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**Id** | **string** | The unique ID of the source. | +**NativeIdentifier** | **string** | Unique ID of the account on the source. | +**SourceId** | **string** | The ID of the source. | +**SourceName** | **string** | The name of the source. | +**IdentityId** | **string** | The ID of the identity that is correlated with this account. | +**IdentityName** | **string** | The name of the identity that is correlated with this account. | +**Name** | **string** | The user friendly name of the source. | +**Type** | **string** | The connection type of the source. | +**Created** | **SailPointTime** | The date and time the status change occurred. | +**Connector** | **string** | The connector type used to connect to the source. | +**Actor** | [**SourceUpdatedActor**](source-updated-actor) | | +**Deleted** | **SailPointTime** | The date and time the source was deleted. | +**Modified** | **SailPointTime** | The date and time the source was modified. | +**Application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | +**HealthCheckResult** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | +**PreviousHealthCheckResult** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | + +## Methods + +### NewTriggerExampleInput + +`func NewTriggerExampleInput(accessRequestId string, requestedFor []AccessItemRequestedForDto, requestedItems []AccessRequestPreApprovalRequestedItemsInner, requestedBy AccessItemRequesterDto, requestedItemsStatus []AccessRequestPostApprovalRequestedItemsStatusInner, source AccountUncorrelatedSource, status map[string]interface{}, started SailPointTime, completed SailPointTime, errors []string, warnings []string, stats AccountsCollectedForAggregationStats, identity IdentityDeletedIdentity, account AccountUncorrelatedAccount, changes []IdentityAttributesChangedChangesInner, attributes map[string]interface{}, campaign CampaignGeneratedCampaign, certification CertificationSignedOffCertification, trackingNumber string, sources string, recipient ProvisioningCompletedRecipient, accountRequests []ProvisioningCompletedAccountRequestsInner, fileName string, ownerEmail string, ownerName string, query string, searchName string, searchResults SavedSearchCompleteSearchResults, signedS3Url string, id string, nativeIdentifier string, sourceId string, sourceName string, identityId string, identityName string, name string, type_ string, created SailPointTime, connector string, actor SourceUpdatedActor, deleted SailPointTime, modified SailPointTime, application VAClusterStatusChangeEventApplication, healthCheckResult VAClusterStatusChangeEventHealthCheckResult, previousHealthCheckResult VAClusterStatusChangeEventPreviousHealthCheckResult, ) *TriggerExampleInput` + +NewTriggerExampleInput instantiates a new TriggerExampleInput 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 + +### NewTriggerExampleInputWithDefaults + +`func NewTriggerExampleInputWithDefaults() *TriggerExampleInput` + +NewTriggerExampleInputWithDefaults instantiates a new TriggerExampleInput 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 + +### GetAccessRequestId + +`func (o *TriggerExampleInput) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *TriggerExampleInput) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *TriggerExampleInput) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + + +### GetRequestedFor + +`func (o *TriggerExampleInput) GetRequestedFor() []AccessItemRequestedForDto` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *TriggerExampleInput) GetRequestedForOk() (*[]AccessItemRequestedForDto, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *TriggerExampleInput) SetRequestedFor(v []AccessItemRequestedForDto)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestedItems + +`func (o *TriggerExampleInput) GetRequestedItems() []AccessRequestPreApprovalRequestedItemsInner` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *TriggerExampleInput) GetRequestedItemsOk() (*[]AccessRequestPreApprovalRequestedItemsInner, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *TriggerExampleInput) SetRequestedItems(v []AccessRequestPreApprovalRequestedItemsInner)` + +SetRequestedItems sets RequestedItems field to given value. + + +### GetRequestedBy + +`func (o *TriggerExampleInput) GetRequestedBy() AccessItemRequesterDto` + +GetRequestedBy returns the RequestedBy field if non-nil, zero value otherwise. + +### GetRequestedByOk + +`func (o *TriggerExampleInput) GetRequestedByOk() (*AccessItemRequesterDto, bool)` + +GetRequestedByOk returns a tuple with the RequestedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedBy + +`func (o *TriggerExampleInput) SetRequestedBy(v AccessItemRequesterDto)` + +SetRequestedBy sets RequestedBy field to given value. + + +### GetRequestedItemsStatus + +`func (o *TriggerExampleInput) GetRequestedItemsStatus() []AccessRequestPostApprovalRequestedItemsStatusInner` + +GetRequestedItemsStatus returns the RequestedItemsStatus field if non-nil, zero value otherwise. + +### GetRequestedItemsStatusOk + +`func (o *TriggerExampleInput) GetRequestedItemsStatusOk() (*[]AccessRequestPostApprovalRequestedItemsStatusInner, bool)` + +GetRequestedItemsStatusOk returns a tuple with the RequestedItemsStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItemsStatus + +`func (o *TriggerExampleInput) SetRequestedItemsStatus(v []AccessRequestPostApprovalRequestedItemsStatusInner)` + +SetRequestedItemsStatus sets RequestedItemsStatus field to given value. + + +### GetSource + +`func (o *TriggerExampleInput) GetSource() AccountUncorrelatedSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *TriggerExampleInput) GetSourceOk() (*AccountUncorrelatedSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *TriggerExampleInput) SetSource(v AccountUncorrelatedSource)` + +SetSource sets Source field to given value. + + +### GetStatus + +`func (o *TriggerExampleInput) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *TriggerExampleInput) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *TriggerExampleInput) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + +### GetStarted + +`func (o *TriggerExampleInput) GetStarted() SailPointTime` + +GetStarted returns the Started field if non-nil, zero value otherwise. + +### GetStartedOk + +`func (o *TriggerExampleInput) GetStartedOk() (*SailPointTime, bool)` + +GetStartedOk returns a tuple with the Started field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStarted + +`func (o *TriggerExampleInput) SetStarted(v SailPointTime)` + +SetStarted sets Started field to given value. + + +### GetCompleted + +`func (o *TriggerExampleInput) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *TriggerExampleInput) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *TriggerExampleInput) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + + +### GetErrors + +`func (o *TriggerExampleInput) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *TriggerExampleInput) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *TriggerExampleInput) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + + +### SetErrorsNil + +`func (o *TriggerExampleInput) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *TriggerExampleInput) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *TriggerExampleInput) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *TriggerExampleInput) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *TriggerExampleInput) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + + +### SetWarningsNil + +`func (o *TriggerExampleInput) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *TriggerExampleInput) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetStats + +`func (o *TriggerExampleInput) GetStats() AccountsCollectedForAggregationStats` + +GetStats returns the Stats field if non-nil, zero value otherwise. + +### GetStatsOk + +`func (o *TriggerExampleInput) GetStatsOk() (*AccountsCollectedForAggregationStats, bool)` + +GetStatsOk returns a tuple with the Stats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStats + +`func (o *TriggerExampleInput) SetStats(v AccountsCollectedForAggregationStats)` + +SetStats sets Stats field to given value. + + +### GetIdentity + +`func (o *TriggerExampleInput) GetIdentity() IdentityDeletedIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *TriggerExampleInput) GetIdentityOk() (*IdentityDeletedIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *TriggerExampleInput) SetIdentity(v IdentityDeletedIdentity)` + +SetIdentity sets Identity field to given value. + + +### GetAccount + +`func (o *TriggerExampleInput) GetAccount() AccountUncorrelatedAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *TriggerExampleInput) GetAccountOk() (*AccountUncorrelatedAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *TriggerExampleInput) SetAccount(v AccountUncorrelatedAccount)` + +SetAccount sets Account field to given value. + + +### GetChanges + +`func (o *TriggerExampleInput) GetChanges() []IdentityAttributesChangedChangesInner` + +GetChanges returns the Changes field if non-nil, zero value otherwise. + +### GetChangesOk + +`func (o *TriggerExampleInput) GetChangesOk() (*[]IdentityAttributesChangedChangesInner, bool)` + +GetChangesOk returns a tuple with the Changes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChanges + +`func (o *TriggerExampleInput) SetChanges(v []IdentityAttributesChangedChangesInner)` + +SetChanges sets Changes field to given value. + + +### GetAttributes + +`func (o *TriggerExampleInput) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TriggerExampleInput) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TriggerExampleInput) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetEntitlementCount + +`func (o *TriggerExampleInput) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *TriggerExampleInput) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *TriggerExampleInput) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *TriggerExampleInput) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetCampaign + +`func (o *TriggerExampleInput) GetCampaign() CampaignGeneratedCampaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *TriggerExampleInput) GetCampaignOk() (*CampaignGeneratedCampaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *TriggerExampleInput) SetCampaign(v CampaignGeneratedCampaign)` + +SetCampaign sets Campaign field to given value. + + +### GetCertification + +`func (o *TriggerExampleInput) GetCertification() CertificationSignedOffCertification` + +GetCertification returns the Certification field if non-nil, zero value otherwise. + +### GetCertificationOk + +`func (o *TriggerExampleInput) GetCertificationOk() (*CertificationSignedOffCertification, bool)` + +GetCertificationOk returns a tuple with the Certification field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertification + +`func (o *TriggerExampleInput) SetCertification(v CertificationSignedOffCertification)` + +SetCertification sets Certification field to given value. + + +### GetTrackingNumber + +`func (o *TriggerExampleInput) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *TriggerExampleInput) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *TriggerExampleInput) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + + +### GetSources + +`func (o *TriggerExampleInput) GetSources() string` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *TriggerExampleInput) GetSourcesOk() (*string, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *TriggerExampleInput) SetSources(v string)` + +SetSources sets Sources field to given value. + + +### GetAction + +`func (o *TriggerExampleInput) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *TriggerExampleInput) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *TriggerExampleInput) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *TriggerExampleInput) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### SetActionNil + +`func (o *TriggerExampleInput) SetActionNil(b bool)` + + SetActionNil sets the value for Action to be an explicit nil + +### UnsetAction +`func (o *TriggerExampleInput) UnsetAction()` + +UnsetAction ensures that no value is present for Action, not even an explicit nil +### GetRecipient + +`func (o *TriggerExampleInput) GetRecipient() ProvisioningCompletedRecipient` + +GetRecipient returns the Recipient field if non-nil, zero value otherwise. + +### GetRecipientOk + +`func (o *TriggerExampleInput) GetRecipientOk() (*ProvisioningCompletedRecipient, bool)` + +GetRecipientOk returns a tuple with the Recipient field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipient + +`func (o *TriggerExampleInput) SetRecipient(v ProvisioningCompletedRecipient)` + +SetRecipient sets Recipient field to given value. + + +### GetRequester + +`func (o *TriggerExampleInput) GetRequester() ProvisioningCompletedRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *TriggerExampleInput) GetRequesterOk() (*ProvisioningCompletedRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *TriggerExampleInput) SetRequester(v ProvisioningCompletedRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *TriggerExampleInput) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### SetRequesterNil + +`func (o *TriggerExampleInput) SetRequesterNil(b bool)` + + SetRequesterNil sets the value for Requester to be an explicit nil + +### UnsetRequester +`func (o *TriggerExampleInput) UnsetRequester()` + +UnsetRequester ensures that no value is present for Requester, not even an explicit nil +### GetAccountRequests + +`func (o *TriggerExampleInput) GetAccountRequests() []ProvisioningCompletedAccountRequestsInner` + +GetAccountRequests returns the AccountRequests field if non-nil, zero value otherwise. + +### GetAccountRequestsOk + +`func (o *TriggerExampleInput) GetAccountRequestsOk() (*[]ProvisioningCompletedAccountRequestsInner, bool)` + +GetAccountRequestsOk returns a tuple with the AccountRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountRequests + +`func (o *TriggerExampleInput) SetAccountRequests(v []ProvisioningCompletedAccountRequestsInner)` + +SetAccountRequests sets AccountRequests field to given value. + + +### GetFileName + +`func (o *TriggerExampleInput) GetFileName() string` + +GetFileName returns the FileName field if non-nil, zero value otherwise. + +### GetFileNameOk + +`func (o *TriggerExampleInput) GetFileNameOk() (*string, bool)` + +GetFileNameOk returns a tuple with the FileName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileName + +`func (o *TriggerExampleInput) SetFileName(v string)` + +SetFileName sets FileName field to given value. + + +### GetOwnerEmail + +`func (o *TriggerExampleInput) GetOwnerEmail() string` + +GetOwnerEmail returns the OwnerEmail field if non-nil, zero value otherwise. + +### GetOwnerEmailOk + +`func (o *TriggerExampleInput) GetOwnerEmailOk() (*string, bool)` + +GetOwnerEmailOk returns a tuple with the OwnerEmail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerEmail + +`func (o *TriggerExampleInput) SetOwnerEmail(v string)` + +SetOwnerEmail sets OwnerEmail field to given value. + + +### GetOwnerName + +`func (o *TriggerExampleInput) GetOwnerName() string` + +GetOwnerName returns the OwnerName field if non-nil, zero value otherwise. + +### GetOwnerNameOk + +`func (o *TriggerExampleInput) GetOwnerNameOk() (*string, bool)` + +GetOwnerNameOk returns a tuple with the OwnerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerName + +`func (o *TriggerExampleInput) SetOwnerName(v string)` + +SetOwnerName sets OwnerName field to given value. + + +### GetQuery + +`func (o *TriggerExampleInput) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *TriggerExampleInput) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *TriggerExampleInput) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetSearchName + +`func (o *TriggerExampleInput) GetSearchName() string` + +GetSearchName returns the SearchName field if non-nil, zero value otherwise. + +### GetSearchNameOk + +`func (o *TriggerExampleInput) GetSearchNameOk() (*string, bool)` + +GetSearchNameOk returns a tuple with the SearchName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchName + +`func (o *TriggerExampleInput) SetSearchName(v string)` + +SetSearchName sets SearchName field to given value. + + +### GetSearchResults + +`func (o *TriggerExampleInput) GetSearchResults() SavedSearchCompleteSearchResults` + +GetSearchResults returns the SearchResults field if non-nil, zero value otherwise. + +### GetSearchResultsOk + +`func (o *TriggerExampleInput) GetSearchResultsOk() (*SavedSearchCompleteSearchResults, bool)` + +GetSearchResultsOk returns a tuple with the SearchResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchResults + +`func (o *TriggerExampleInput) SetSearchResults(v SavedSearchCompleteSearchResults)` + +SetSearchResults sets SearchResults field to given value. + + +### GetSignedS3Url + +`func (o *TriggerExampleInput) GetSignedS3Url() string` + +GetSignedS3Url returns the SignedS3Url field if non-nil, zero value otherwise. + +### GetSignedS3UrlOk + +`func (o *TriggerExampleInput) GetSignedS3UrlOk() (*string, bool)` + +GetSignedS3UrlOk returns a tuple with the SignedS3Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignedS3Url + +`func (o *TriggerExampleInput) SetSignedS3Url(v string)` + +SetSignedS3Url sets SignedS3Url field to given value. + + +### GetUuid + +`func (o *TriggerExampleInput) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *TriggerExampleInput) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *TriggerExampleInput) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *TriggerExampleInput) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### GetId + +`func (o *TriggerExampleInput) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TriggerExampleInput) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TriggerExampleInput) SetId(v string)` + +SetId sets Id field to given value. + + +### GetNativeIdentifier + +`func (o *TriggerExampleInput) GetNativeIdentifier() string` + +GetNativeIdentifier returns the NativeIdentifier field if non-nil, zero value otherwise. + +### GetNativeIdentifierOk + +`func (o *TriggerExampleInput) GetNativeIdentifierOk() (*string, bool)` + +GetNativeIdentifierOk returns a tuple with the NativeIdentifier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentifier + +`func (o *TriggerExampleInput) SetNativeIdentifier(v string)` + +SetNativeIdentifier sets NativeIdentifier field to given value. + + +### GetSourceId + +`func (o *TriggerExampleInput) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *TriggerExampleInput) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *TriggerExampleInput) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetSourceName + +`func (o *TriggerExampleInput) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *TriggerExampleInput) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *TriggerExampleInput) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### GetIdentityId + +`func (o *TriggerExampleInput) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *TriggerExampleInput) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *TriggerExampleInput) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetIdentityName + +`func (o *TriggerExampleInput) GetIdentityName() string` + +GetIdentityName returns the IdentityName field if non-nil, zero value otherwise. + +### GetIdentityNameOk + +`func (o *TriggerExampleInput) GetIdentityNameOk() (*string, bool)` + +GetIdentityNameOk returns a tuple with the IdentityName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityName + +`func (o *TriggerExampleInput) SetIdentityName(v string)` + +SetIdentityName sets IdentityName field to given value. + + +### GetName + +`func (o *TriggerExampleInput) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TriggerExampleInput) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TriggerExampleInput) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *TriggerExampleInput) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TriggerExampleInput) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TriggerExampleInput) SetType(v string)` + +SetType sets Type field to given value. + + +### GetCreated + +`func (o *TriggerExampleInput) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *TriggerExampleInput) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *TriggerExampleInput) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetConnector + +`func (o *TriggerExampleInput) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *TriggerExampleInput) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *TriggerExampleInput) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetActor + +`func (o *TriggerExampleInput) GetActor() SourceUpdatedActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *TriggerExampleInput) GetActorOk() (*SourceUpdatedActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *TriggerExampleInput) SetActor(v SourceUpdatedActor)` + +SetActor sets Actor field to given value. + + +### GetDeleted + +`func (o *TriggerExampleInput) GetDeleted() SailPointTime` + +GetDeleted returns the Deleted field if non-nil, zero value otherwise. + +### GetDeletedOk + +`func (o *TriggerExampleInput) GetDeletedOk() (*SailPointTime, bool)` + +GetDeletedOk returns a tuple with the Deleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleted + +`func (o *TriggerExampleInput) SetDeleted(v SailPointTime)` + +SetDeleted sets Deleted field to given value. + + +### GetModified + +`func (o *TriggerExampleInput) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *TriggerExampleInput) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *TriggerExampleInput) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetApplication + +`func (o *TriggerExampleInput) GetApplication() VAClusterStatusChangeEventApplication` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *TriggerExampleInput) GetApplicationOk() (*VAClusterStatusChangeEventApplication, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *TriggerExampleInput) SetApplication(v VAClusterStatusChangeEventApplication)` + +SetApplication sets Application field to given value. + + +### GetHealthCheckResult + +`func (o *TriggerExampleInput) GetHealthCheckResult() VAClusterStatusChangeEventHealthCheckResult` + +GetHealthCheckResult returns the HealthCheckResult field if non-nil, zero value otherwise. + +### GetHealthCheckResultOk + +`func (o *TriggerExampleInput) GetHealthCheckResultOk() (*VAClusterStatusChangeEventHealthCheckResult, bool)` + +GetHealthCheckResultOk returns a tuple with the HealthCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthCheckResult + +`func (o *TriggerExampleInput) SetHealthCheckResult(v VAClusterStatusChangeEventHealthCheckResult)` + +SetHealthCheckResult sets HealthCheckResult field to given value. + + +### GetPreviousHealthCheckResult + +`func (o *TriggerExampleInput) GetPreviousHealthCheckResult() VAClusterStatusChangeEventPreviousHealthCheckResult` + +GetPreviousHealthCheckResult returns the PreviousHealthCheckResult field if non-nil, zero value otherwise. + +### GetPreviousHealthCheckResultOk + +`func (o *TriggerExampleInput) GetPreviousHealthCheckResultOk() (*VAClusterStatusChangeEventPreviousHealthCheckResult, bool)` + +GetPreviousHealthCheckResultOk returns a tuple with the PreviousHealthCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousHealthCheckResult + +`func (o *TriggerExampleInput) SetPreviousHealthCheckResult(v VAClusterStatusChangeEventPreviousHealthCheckResult)` + +SetPreviousHealthCheckResult sets PreviousHealthCheckResult field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TriggerExampleOutput.md b/docs/tools/sdk/go/Reference/V2025/Models/TriggerExampleOutput.md new file mode 100644 index 000000000..f14c196c4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TriggerExampleOutput.md @@ -0,0 +1,164 @@ +--- +id: v2025-trigger-example-output +title: TriggerExampleOutput +pagination_label: TriggerExampleOutput +sidebar_label: TriggerExampleOutput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TriggerExampleOutput', 'V2025TriggerExampleOutput'] +slug: /tools/sdk/go/v2025/models/trigger-example-output +tags: ['SDK', 'Software Development Kit', 'TriggerExampleOutput', 'V2025TriggerExampleOutput'] +--- + +# TriggerExampleOutput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the identity to add to the approver list for the access request. | +**Name** | **string** | The name of the identity to add to the approver list for the access request. | +**Type** | **map[string]interface{}** | The type of object being referenced. | +**Approved** | **bool** | Whether or not to approve the access request. | +**Comment** | **string** | A comment about the decision to approve or deny the request. | +**Approver** | **string** | The name of the entity that approved or denied the request. | + +## Methods + +### NewTriggerExampleOutput + +`func NewTriggerExampleOutput(id string, name string, type_ map[string]interface{}, approved bool, comment string, approver string, ) *TriggerExampleOutput` + +NewTriggerExampleOutput instantiates a new TriggerExampleOutput 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 + +### NewTriggerExampleOutputWithDefaults + +`func NewTriggerExampleOutputWithDefaults() *TriggerExampleOutput` + +NewTriggerExampleOutputWithDefaults instantiates a new TriggerExampleOutput 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 + +### GetId + +`func (o *TriggerExampleOutput) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TriggerExampleOutput) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TriggerExampleOutput) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *TriggerExampleOutput) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TriggerExampleOutput) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TriggerExampleOutput) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *TriggerExampleOutput) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TriggerExampleOutput) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TriggerExampleOutput) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetApproved + +`func (o *TriggerExampleOutput) GetApproved() bool` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *TriggerExampleOutput) GetApprovedOk() (*bool, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *TriggerExampleOutput) SetApproved(v bool)` + +SetApproved sets Approved field to given value. + + +### GetComment + +`func (o *TriggerExampleOutput) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *TriggerExampleOutput) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *TriggerExampleOutput) SetComment(v string)` + +SetComment sets Comment field to given value. + + +### GetApprover + +`func (o *TriggerExampleOutput) GetApprover() string` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *TriggerExampleOutput) GetApproverOk() (*string, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *TriggerExampleOutput) SetApprover(v string)` + +SetApprover sets Approver field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TriggerType.md b/docs/tools/sdk/go/Reference/V2025/Models/TriggerType.md new file mode 100644 index 000000000..6587a6e66 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TriggerType.md @@ -0,0 +1,21 @@ +--- +id: v2025-trigger-type +title: TriggerType +pagination_label: TriggerType +sidebar_label: TriggerType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TriggerType', 'V2025TriggerType'] +slug: /tools/sdk/go/v2025/models/trigger-type +tags: ['SDK', 'Software Development Kit', 'TriggerType', 'V2025TriggerType'] +--- + +# TriggerType + +## Enum + + +* `REQUEST_RESPONSE` (value: `"REQUEST_RESPONSE"`) + +* `FIRE_AND_FORGET` (value: `"FIRE_AND_FORGET"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TypeAheadQuery.md b/docs/tools/sdk/go/Reference/V2025/Models/TypeAheadQuery.md new file mode 100644 index 000000000..1685c972b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TypeAheadQuery.md @@ -0,0 +1,210 @@ +--- +id: v2025-type-ahead-query +title: TypeAheadQuery +pagination_label: TypeAheadQuery +sidebar_label: TypeAheadQuery +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TypeAheadQuery', 'V2025TypeAheadQuery'] +slug: /tools/sdk/go/v2025/models/type-ahead-query +tags: ['SDK', 'Software Development Kit', 'TypeAheadQuery', 'V2025TypeAheadQuery'] +--- + +# TypeAheadQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **string** | The type ahead query string used to construct a phrase prefix match query. | +**Field** | **string** | The field on which to perform the type ahead search. | +**NestedType** | Pointer to **string** | The nested type. | [optional] +**MaxExpansions** | Pointer to **int32** | The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000. | [optional] [default to 10] +**Size** | Pointer to **int32** | The max amount of records the search will return. | [optional] [default to 100] +**Sort** | Pointer to **string** | The sort order of the returned records. | [optional] [default to "desc"] +**SortByValue** | Pointer to **bool** | The flag that defines the sort type, by count or value. | [optional] [default to false] + +## Methods + +### NewTypeAheadQuery + +`func NewTypeAheadQuery(query string, field string, ) *TypeAheadQuery` + +NewTypeAheadQuery instantiates a new TypeAheadQuery 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 + +### NewTypeAheadQueryWithDefaults + +`func NewTypeAheadQueryWithDefaults() *TypeAheadQuery` + +NewTypeAheadQueryWithDefaults instantiates a new TypeAheadQuery 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 + +### GetQuery + +`func (o *TypeAheadQuery) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *TypeAheadQuery) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *TypeAheadQuery) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetField + +`func (o *TypeAheadQuery) GetField() string` + +GetField returns the Field field if non-nil, zero value otherwise. + +### GetFieldOk + +`func (o *TypeAheadQuery) GetFieldOk() (*string, bool)` + +GetFieldOk returns a tuple with the Field field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetField + +`func (o *TypeAheadQuery) SetField(v string)` + +SetField sets Field field to given value. + + +### GetNestedType + +`func (o *TypeAheadQuery) GetNestedType() string` + +GetNestedType returns the NestedType field if non-nil, zero value otherwise. + +### GetNestedTypeOk + +`func (o *TypeAheadQuery) GetNestedTypeOk() (*string, bool)` + +GetNestedTypeOk returns a tuple with the NestedType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNestedType + +`func (o *TypeAheadQuery) SetNestedType(v string)` + +SetNestedType sets NestedType field to given value. + +### HasNestedType + +`func (o *TypeAheadQuery) HasNestedType() bool` + +HasNestedType returns a boolean if a field has been set. + +### GetMaxExpansions + +`func (o *TypeAheadQuery) GetMaxExpansions() int32` + +GetMaxExpansions returns the MaxExpansions field if non-nil, zero value otherwise. + +### GetMaxExpansionsOk + +`func (o *TypeAheadQuery) GetMaxExpansionsOk() (*int32, bool)` + +GetMaxExpansionsOk returns a tuple with the MaxExpansions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxExpansions + +`func (o *TypeAheadQuery) SetMaxExpansions(v int32)` + +SetMaxExpansions sets MaxExpansions field to given value. + +### HasMaxExpansions + +`func (o *TypeAheadQuery) HasMaxExpansions() bool` + +HasMaxExpansions returns a boolean if a field has been set. + +### GetSize + +`func (o *TypeAheadQuery) GetSize() int32` + +GetSize returns the Size field if non-nil, zero value otherwise. + +### GetSizeOk + +`func (o *TypeAheadQuery) GetSizeOk() (*int32, bool)` + +GetSizeOk returns a tuple with the Size field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSize + +`func (o *TypeAheadQuery) SetSize(v int32)` + +SetSize sets Size field to given value. + +### HasSize + +`func (o *TypeAheadQuery) HasSize() bool` + +HasSize returns a boolean if a field has been set. + +### GetSort + +`func (o *TypeAheadQuery) GetSort() string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *TypeAheadQuery) GetSortOk() (*string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *TypeAheadQuery) SetSort(v string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *TypeAheadQuery) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### GetSortByValue + +`func (o *TypeAheadQuery) GetSortByValue() bool` + +GetSortByValue returns the SortByValue field if non-nil, zero value otherwise. + +### GetSortByValueOk + +`func (o *TypeAheadQuery) GetSortByValueOk() (*bool, bool)` + +GetSortByValueOk returns a tuple with the SortByValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSortByValue + +`func (o *TypeAheadQuery) SetSortByValue(v bool)` + +SetSortByValue sets SortByValue field to given value. + +### HasSortByValue + +`func (o *TypeAheadQuery) HasSortByValue() bool` + +HasSortByValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/TypedReference.md b/docs/tools/sdk/go/Reference/V2025/Models/TypedReference.md new file mode 100644 index 000000000..88d515840 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/TypedReference.md @@ -0,0 +1,80 @@ +--- +id: v2025-typed-reference +title: TypedReference +pagination_label: TypedReference +sidebar_label: TypedReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TypedReference', 'V2025TypedReference'] +slug: /tools/sdk/go/v2025/models/typed-reference +tags: ['SDK', 'Software Development Kit', 'TypedReference', 'V2025TypedReference'] +--- + +# TypedReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**DtoType**](dto-type) | | +**Id** | **string** | The id of the object. | + +## Methods + +### NewTypedReference + +`func NewTypedReference(type_ DtoType, id string, ) *TypedReference` + +NewTypedReference instantiates a new TypedReference 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 + +### NewTypedReferenceWithDefaults + +`func NewTypedReferenceWithDefaults() *TypedReference` + +NewTypedReferenceWithDefaults instantiates a new TypedReference 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 + +### GetType + +`func (o *TypedReference) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TypedReference) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TypedReference) SetType(v DtoType)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *TypedReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TypedReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TypedReference) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/UncorrelatedAccountsReportArguments.md b/docs/tools/sdk/go/Reference/V2025/Models/UncorrelatedAccountsReportArguments.md new file mode 100644 index 000000000..d89be7aca --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/UncorrelatedAccountsReportArguments.md @@ -0,0 +1,64 @@ +--- +id: v2025-uncorrelated-accounts-report-arguments +title: UncorrelatedAccountsReportArguments +pagination_label: UncorrelatedAccountsReportArguments +sidebar_label: UncorrelatedAccountsReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UncorrelatedAccountsReportArguments', 'V2025UncorrelatedAccountsReportArguments'] +slug: /tools/sdk/go/v2025/models/uncorrelated-accounts-report-arguments +tags: ['SDK', 'Software Development Kit', 'UncorrelatedAccountsReportArguments', 'V2025UncorrelatedAccountsReportArguments'] +--- + +# UncorrelatedAccountsReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SelectedFormats** | Pointer to **[]string** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] + +## Methods + +### NewUncorrelatedAccountsReportArguments + +`func NewUncorrelatedAccountsReportArguments() *UncorrelatedAccountsReportArguments` + +NewUncorrelatedAccountsReportArguments instantiates a new UncorrelatedAccountsReportArguments 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 + +### NewUncorrelatedAccountsReportArgumentsWithDefaults + +`func NewUncorrelatedAccountsReportArgumentsWithDefaults() *UncorrelatedAccountsReportArguments` + +NewUncorrelatedAccountsReportArgumentsWithDefaults instantiates a new UncorrelatedAccountsReportArguments 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 + +### GetSelectedFormats + +`func (o *UncorrelatedAccountsReportArguments) GetSelectedFormats() []string` + +GetSelectedFormats returns the SelectedFormats field if non-nil, zero value otherwise. + +### GetSelectedFormatsOk + +`func (o *UncorrelatedAccountsReportArguments) GetSelectedFormatsOk() (*[]string, bool)` + +GetSelectedFormatsOk returns a tuple with the SelectedFormats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectedFormats + +`func (o *UncorrelatedAccountsReportArguments) SetSelectedFormats(v []string)` + +SetSelectedFormats sets SelectedFormats field to given value. + +### HasSelectedFormats + +`func (o *UncorrelatedAccountsReportArguments) HasSelectedFormats() bool` + +HasSelectedFormats returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/UpdateAccessProfilesInBulk412Response.md b/docs/tools/sdk/go/Reference/V2025/Models/UpdateAccessProfilesInBulk412Response.md new file mode 100644 index 000000000..20c469c21 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/UpdateAccessProfilesInBulk412Response.md @@ -0,0 +1,64 @@ +--- +id: v2025-update-access-profiles-in-bulk412-response +title: UpdateAccessProfilesInBulk412Response +pagination_label: UpdateAccessProfilesInBulk412Response +sidebar_label: UpdateAccessProfilesInBulk412Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UpdateAccessProfilesInBulk412Response', 'V2025UpdateAccessProfilesInBulk412Response'] +slug: /tools/sdk/go/v2025/models/update-access-profiles-in-bulk412-response +tags: ['SDK', 'Software Development Kit', 'UpdateAccessProfilesInBulk412Response', 'V2025UpdateAccessProfilesInBulk412Response'] +--- + +# UpdateAccessProfilesInBulk412Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **map[string]interface{}** | A message describing the error | [optional] + +## Methods + +### NewUpdateAccessProfilesInBulk412Response + +`func NewUpdateAccessProfilesInBulk412Response() *UpdateAccessProfilesInBulk412Response` + +NewUpdateAccessProfilesInBulk412Response instantiates a new UpdateAccessProfilesInBulk412Response 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 + +### NewUpdateAccessProfilesInBulk412ResponseWithDefaults + +`func NewUpdateAccessProfilesInBulk412ResponseWithDefaults() *UpdateAccessProfilesInBulk412Response` + +NewUpdateAccessProfilesInBulk412ResponseWithDefaults instantiates a new UpdateAccessProfilesInBulk412Response 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 + +### GetMessage + +`func (o *UpdateAccessProfilesInBulk412Response) GetMessage() map[string]interface{}` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *UpdateAccessProfilesInBulk412Response) GetMessageOk() (*map[string]interface{}, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *UpdateAccessProfilesInBulk412Response) SetMessage(v map[string]interface{})` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *UpdateAccessProfilesInBulk412Response) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/UpdateDetail.md b/docs/tools/sdk/go/Reference/V2025/Models/UpdateDetail.md new file mode 100644 index 000000000..3e8e13c1a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/UpdateDetail.md @@ -0,0 +1,152 @@ +--- +id: v2025-update-detail +title: UpdateDetail +pagination_label: UpdateDetail +sidebar_label: UpdateDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UpdateDetail', 'V2025UpdateDetail'] +slug: /tools/sdk/go/v2025/models/update-detail +tags: ['SDK', 'Software Development Kit', 'UpdateDetail', 'V2025UpdateDetail'] +--- + +# UpdateDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **string** | The detailed message for an update. Typically the relevent error message when status is error. | [optional] +**ScriptName** | Pointer to **string** | The connector script name | [optional] +**UpdatedFiles** | Pointer to **[]string** | The list of updated files supported by the connector | [optional] +**Status** | Pointer to **string** | The connector update status | [optional] + +## Methods + +### NewUpdateDetail + +`func NewUpdateDetail() *UpdateDetail` + +NewUpdateDetail instantiates a new UpdateDetail 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 + +### NewUpdateDetailWithDefaults + +`func NewUpdateDetailWithDefaults() *UpdateDetail` + +NewUpdateDetailWithDefaults instantiates a new UpdateDetail 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 + +### GetMessage + +`func (o *UpdateDetail) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *UpdateDetail) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *UpdateDetail) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *UpdateDetail) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetScriptName + +`func (o *UpdateDetail) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *UpdateDetail) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *UpdateDetail) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + +### HasScriptName + +`func (o *UpdateDetail) HasScriptName() bool` + +HasScriptName returns a boolean if a field has been set. + +### GetUpdatedFiles + +`func (o *UpdateDetail) GetUpdatedFiles() []string` + +GetUpdatedFiles returns the UpdatedFiles field if non-nil, zero value otherwise. + +### GetUpdatedFilesOk + +`func (o *UpdateDetail) GetUpdatedFilesOk() (*[]string, bool)` + +GetUpdatedFilesOk returns a tuple with the UpdatedFiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedFiles + +`func (o *UpdateDetail) SetUpdatedFiles(v []string)` + +SetUpdatedFiles sets UpdatedFiles field to given value. + +### HasUpdatedFiles + +`func (o *UpdateDetail) HasUpdatedFiles() bool` + +HasUpdatedFiles returns a boolean if a field has been set. + +### SetUpdatedFilesNil + +`func (o *UpdateDetail) SetUpdatedFilesNil(b bool)` + + SetUpdatedFilesNil sets the value for UpdatedFiles to be an explicit nil + +### UnsetUpdatedFiles +`func (o *UpdateDetail) UnsetUpdatedFiles()` + +UnsetUpdatedFiles ensures that no value is present for UpdatedFiles, not even an explicit nil +### GetStatus + +`func (o *UpdateDetail) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *UpdateDetail) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *UpdateDetail) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *UpdateDetail) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/UpdateMultiHostSourcesRequestInner.md b/docs/tools/sdk/go/Reference/V2025/Models/UpdateMultiHostSourcesRequestInner.md new file mode 100644 index 000000000..ec43ffb92 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/UpdateMultiHostSourcesRequestInner.md @@ -0,0 +1,106 @@ +--- +id: v2025-update-multi-host-sources-request-inner +title: UpdateMultiHostSourcesRequestInner +pagination_label: UpdateMultiHostSourcesRequestInner +sidebar_label: UpdateMultiHostSourcesRequestInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UpdateMultiHostSourcesRequestInner', 'V2025UpdateMultiHostSourcesRequestInner'] +slug: /tools/sdk/go/v2025/models/update-multi-host-sources-request-inner +tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInner', 'V2025UpdateMultiHostSourcesRequestInner'] +--- + +# UpdateMultiHostSourcesRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **string** | The operation to be performed | +**Path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | +**Value** | Pointer to [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] + +## Methods + +### NewUpdateMultiHostSourcesRequestInner + +`func NewUpdateMultiHostSourcesRequestInner(op string, path string, ) *UpdateMultiHostSourcesRequestInner` + +NewUpdateMultiHostSourcesRequestInner instantiates a new UpdateMultiHostSourcesRequestInner 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 + +### NewUpdateMultiHostSourcesRequestInnerWithDefaults + +`func NewUpdateMultiHostSourcesRequestInnerWithDefaults() *UpdateMultiHostSourcesRequestInner` + +NewUpdateMultiHostSourcesRequestInnerWithDefaults instantiates a new UpdateMultiHostSourcesRequestInner 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 + +### GetOp + +`func (o *UpdateMultiHostSourcesRequestInner) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *UpdateMultiHostSourcesRequestInner) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *UpdateMultiHostSourcesRequestInner) SetOp(v string)` + +SetOp sets Op field to given value. + + +### GetPath + +`func (o *UpdateMultiHostSourcesRequestInner) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *UpdateMultiHostSourcesRequestInner) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *UpdateMultiHostSourcesRequestInner) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetValue + +`func (o *UpdateMultiHostSourcesRequestInner) GetValue() UpdateMultiHostSourcesRequestInnerValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *UpdateMultiHostSourcesRequestInner) GetValueOk() (*UpdateMultiHostSourcesRequestInnerValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *UpdateMultiHostSourcesRequestInner) SetValue(v UpdateMultiHostSourcesRequestInnerValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *UpdateMultiHostSourcesRequestInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/UpdateMultiHostSourcesRequestInnerValue.md b/docs/tools/sdk/go/Reference/V2025/Models/UpdateMultiHostSourcesRequestInnerValue.md new file mode 100644 index 000000000..b5a3b7b4e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/UpdateMultiHostSourcesRequestInnerValue.md @@ -0,0 +1,38 @@ +--- +id: v2025-update-multi-host-sources-request-inner-value +title: UpdateMultiHostSourcesRequestInnerValue +pagination_label: UpdateMultiHostSourcesRequestInnerValue +sidebar_label: UpdateMultiHostSourcesRequestInnerValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UpdateMultiHostSourcesRequestInnerValue', 'V2025UpdateMultiHostSourcesRequestInnerValue'] +slug: /tools/sdk/go/v2025/models/update-multi-host-sources-request-inner-value +tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInnerValue', 'V2025UpdateMultiHostSourcesRequestInnerValue'] +--- + +# UpdateMultiHostSourcesRequestInnerValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewUpdateMultiHostSourcesRequestInnerValue + +`func NewUpdateMultiHostSourcesRequestInnerValue() *UpdateMultiHostSourcesRequestInnerValue` + +NewUpdateMultiHostSourcesRequestInnerValue instantiates a new UpdateMultiHostSourcesRequestInnerValue 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 + +### NewUpdateMultiHostSourcesRequestInnerValueWithDefaults + +`func NewUpdateMultiHostSourcesRequestInnerValueWithDefaults() *UpdateMultiHostSourcesRequestInnerValue` + +NewUpdateMultiHostSourcesRequestInnerValueWithDefaults instantiates a new UpdateMultiHostSourcesRequestInnerValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/UsageType.md b/docs/tools/sdk/go/Reference/V2025/Models/UsageType.md new file mode 100644 index 000000000..040a394bf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/UsageType.md @@ -0,0 +1,49 @@ +--- +id: v2025-usage-type +title: UsageType +pagination_label: UsageType +sidebar_label: UsageType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UsageType', 'V2025UsageType'] +slug: /tools/sdk/go/v2025/models/usage-type +tags: ['SDK', 'Software Development Kit', 'UsageType', 'V2025UsageType'] +--- + +# UsageType + +## Enum + + +* `CREATE` (value: `"CREATE"`) + +* `UPDATE` (value: `"UPDATE"`) + +* `ENABLE` (value: `"ENABLE"`) + +* `DISABLE` (value: `"DISABLE"`) + +* `DELETE` (value: `"DELETE"`) + +* `ASSIGN` (value: `"ASSIGN"`) + +* `UNASSIGN` (value: `"UNASSIGN"`) + +* `CREATE_GROUP` (value: `"CREATE_GROUP"`) + +* `UPDATE_GROUP` (value: `"UPDATE_GROUP"`) + +* `DELETE_GROUP` (value: `"DELETE_GROUP"`) + +* `REGISTER` (value: `"REGISTER"`) + +* `CREATE_IDENTITY` (value: `"CREATE_IDENTITY"`) + +* `UPDATE_IDENTITY` (value: `"UPDATE_IDENTITY"`) + +* `EDIT_GROUP` (value: `"EDIT_GROUP"`) + +* `UNLOCK` (value: `"UNLOCK"`) + +* `CHANGE_PASSWORD` (value: `"CHANGE_PASSWORD"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/UserApp.md b/docs/tools/sdk/go/Reference/V2025/Models/UserApp.md new file mode 100644 index 000000000..ad71c153c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/UserApp.md @@ -0,0 +1,324 @@ +--- +id: v2025-user-app +title: UserApp +pagination_label: UserApp +sidebar_label: UserApp +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserApp', 'V2025UserApp'] +slug: /tools/sdk/go/v2025/models/user-app +tags: ['SDK', 'Software Development Kit', 'UserApp', 'V2025UserApp'] +--- + +# UserApp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The user app id | [optional] +**Created** | Pointer to **SailPointTime** | Time when the user app was created | [optional] +**Modified** | Pointer to **SailPointTime** | Time when the user app was last modified | [optional] +**HasMultipleAccounts** | Pointer to **bool** | True if the owner has multiple accounts for the source | [optional] [default to false] +**UseForPasswordManagement** | Pointer to **bool** | True if the source has password feature | [optional] [default to false] +**ProvisionRequestEnabled** | Pointer to **bool** | True if the source app related to the user app is provision request enabled | [optional] [default to false] +**AppCenterEnabled** | Pointer to **bool** | True if the source app related to the user app is shown in the app center | [optional] [default to true] +**SourceApp** | Pointer to [**UserAppSourceApp**](user-app-source-app) | | [optional] +**Source** | Pointer to [**UserAppSource**](user-app-source) | | [optional] +**Account** | Pointer to [**UserAppAccount**](user-app-account) | | [optional] +**Owner** | Pointer to [**UserAppOwner**](user-app-owner) | | [optional] + +## Methods + +### NewUserApp + +`func NewUserApp() *UserApp` + +NewUserApp instantiates a new UserApp 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 + +### NewUserAppWithDefaults + +`func NewUserAppWithDefaults() *UserApp` + +NewUserAppWithDefaults instantiates a new UserApp 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 + +### GetId + +`func (o *UserApp) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserApp) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserApp) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserApp) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreated + +`func (o *UserApp) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *UserApp) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *UserApp) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *UserApp) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *UserApp) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *UserApp) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *UserApp) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *UserApp) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetHasMultipleAccounts + +`func (o *UserApp) GetHasMultipleAccounts() bool` + +GetHasMultipleAccounts returns the HasMultipleAccounts field if non-nil, zero value otherwise. + +### GetHasMultipleAccountsOk + +`func (o *UserApp) GetHasMultipleAccountsOk() (*bool, bool)` + +GetHasMultipleAccountsOk returns a tuple with the HasMultipleAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasMultipleAccounts + +`func (o *UserApp) SetHasMultipleAccounts(v bool)` + +SetHasMultipleAccounts sets HasMultipleAccounts field to given value. + +### HasHasMultipleAccounts + +`func (o *UserApp) HasHasMultipleAccounts() bool` + +HasHasMultipleAccounts returns a boolean if a field has been set. + +### GetUseForPasswordManagement + +`func (o *UserApp) GetUseForPasswordManagement() bool` + +GetUseForPasswordManagement returns the UseForPasswordManagement field if non-nil, zero value otherwise. + +### GetUseForPasswordManagementOk + +`func (o *UserApp) GetUseForPasswordManagementOk() (*bool, bool)` + +GetUseForPasswordManagementOk returns a tuple with the UseForPasswordManagement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseForPasswordManagement + +`func (o *UserApp) SetUseForPasswordManagement(v bool)` + +SetUseForPasswordManagement sets UseForPasswordManagement field to given value. + +### HasUseForPasswordManagement + +`func (o *UserApp) HasUseForPasswordManagement() bool` + +HasUseForPasswordManagement returns a boolean if a field has been set. + +### GetProvisionRequestEnabled + +`func (o *UserApp) GetProvisionRequestEnabled() bool` + +GetProvisionRequestEnabled returns the ProvisionRequestEnabled field if non-nil, zero value otherwise. + +### GetProvisionRequestEnabledOk + +`func (o *UserApp) GetProvisionRequestEnabledOk() (*bool, bool)` + +GetProvisionRequestEnabledOk returns a tuple with the ProvisionRequestEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionRequestEnabled + +`func (o *UserApp) SetProvisionRequestEnabled(v bool)` + +SetProvisionRequestEnabled sets ProvisionRequestEnabled field to given value. + +### HasProvisionRequestEnabled + +`func (o *UserApp) HasProvisionRequestEnabled() bool` + +HasProvisionRequestEnabled returns a boolean if a field has been set. + +### GetAppCenterEnabled + +`func (o *UserApp) GetAppCenterEnabled() bool` + +GetAppCenterEnabled returns the AppCenterEnabled field if non-nil, zero value otherwise. + +### GetAppCenterEnabledOk + +`func (o *UserApp) GetAppCenterEnabledOk() (*bool, bool)` + +GetAppCenterEnabledOk returns a tuple with the AppCenterEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppCenterEnabled + +`func (o *UserApp) SetAppCenterEnabled(v bool)` + +SetAppCenterEnabled sets AppCenterEnabled field to given value. + +### HasAppCenterEnabled + +`func (o *UserApp) HasAppCenterEnabled() bool` + +HasAppCenterEnabled returns a boolean if a field has been set. + +### GetSourceApp + +`func (o *UserApp) GetSourceApp() UserAppSourceApp` + +GetSourceApp returns the SourceApp field if non-nil, zero value otherwise. + +### GetSourceAppOk + +`func (o *UserApp) GetSourceAppOk() (*UserAppSourceApp, bool)` + +GetSourceAppOk returns a tuple with the SourceApp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceApp + +`func (o *UserApp) SetSourceApp(v UserAppSourceApp)` + +SetSourceApp sets SourceApp field to given value. + +### HasSourceApp + +`func (o *UserApp) HasSourceApp() bool` + +HasSourceApp returns a boolean if a field has been set. + +### GetSource + +`func (o *UserApp) GetSource() UserAppSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *UserApp) GetSourceOk() (*UserAppSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *UserApp) SetSource(v UserAppSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *UserApp) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAccount + +`func (o *UserApp) GetAccount() UserAppAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *UserApp) GetAccountOk() (*UserAppAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *UserApp) SetAccount(v UserAppAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *UserApp) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### GetOwner + +`func (o *UserApp) GetOwner() UserAppOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *UserApp) GetOwnerOk() (*UserAppOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *UserApp) SetOwner(v UserAppOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *UserApp) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/UserAppAccount.md b/docs/tools/sdk/go/Reference/V2025/Models/UserAppAccount.md new file mode 100644 index 000000000..c1b3f1ca5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/UserAppAccount.md @@ -0,0 +1,116 @@ +--- +id: v2025-user-app-account +title: UserAppAccount +pagination_label: UserAppAccount +sidebar_label: UserAppAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserAppAccount', 'V2025UserAppAccount'] +slug: /tools/sdk/go/v2025/models/user-app-account +tags: ['SDK', 'Software Development Kit', 'UserAppAccount', 'V2025UserAppAccount'] +--- + +# UserAppAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the account ID | [optional] +**Type** | Pointer to **string** | It will always be \"ACCOUNT\" | [optional] +**Name** | Pointer to **string** | the account name | [optional] + +## Methods + +### NewUserAppAccount + +`func NewUserAppAccount() *UserAppAccount` + +NewUserAppAccount instantiates a new UserAppAccount 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 + +### NewUserAppAccountWithDefaults + +`func NewUserAppAccountWithDefaults() *UserAppAccount` + +NewUserAppAccountWithDefaults instantiates a new UserAppAccount 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 + +### GetId + +`func (o *UserAppAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserAppAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserAppAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserAppAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *UserAppAccount) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UserAppAccount) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *UserAppAccount) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *UserAppAccount) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *UserAppAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UserAppAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UserAppAccount) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *UserAppAccount) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/UserAppOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/UserAppOwner.md new file mode 100644 index 000000000..eddbac2e9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/UserAppOwner.md @@ -0,0 +1,142 @@ +--- +id: v2025-user-app-owner +title: UserAppOwner +pagination_label: UserAppOwner +sidebar_label: UserAppOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserAppOwner', 'V2025UserAppOwner'] +slug: /tools/sdk/go/v2025/models/user-app-owner +tags: ['SDK', 'Software Development Kit', 'UserAppOwner', 'V2025UserAppOwner'] +--- + +# UserAppOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity ID | [optional] +**Type** | Pointer to **string** | It will always be \"IDENTITY\" | [optional] +**Name** | Pointer to **string** | The identity name | [optional] +**Alias** | Pointer to **string** | The identity alias | [optional] + +## Methods + +### NewUserAppOwner + +`func NewUserAppOwner() *UserAppOwner` + +NewUserAppOwner instantiates a new UserAppOwner 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 + +### NewUserAppOwnerWithDefaults + +`func NewUserAppOwnerWithDefaults() *UserAppOwner` + +NewUserAppOwnerWithDefaults instantiates a new UserAppOwner 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 + +### GetId + +`func (o *UserAppOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserAppOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserAppOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserAppOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *UserAppOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UserAppOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *UserAppOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *UserAppOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *UserAppOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UserAppOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UserAppOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *UserAppOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAlias + +`func (o *UserAppOwner) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *UserAppOwner) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *UserAppOwner) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *UserAppOwner) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/UserAppSource.md b/docs/tools/sdk/go/Reference/V2025/Models/UserAppSource.md new file mode 100644 index 000000000..c2f63c284 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/UserAppSource.md @@ -0,0 +1,116 @@ +--- +id: v2025-user-app-source +title: UserAppSource +pagination_label: UserAppSource +sidebar_label: UserAppSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserAppSource', 'V2025UserAppSource'] +slug: /tools/sdk/go/v2025/models/user-app-source +tags: ['SDK', 'Software Development Kit', 'UserAppSource', 'V2025UserAppSource'] +--- + +# UserAppSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the source ID | [optional] +**Type** | Pointer to **string** | It will always be \"SOURCE\" | [optional] +**Name** | Pointer to **string** | the source name | [optional] + +## Methods + +### NewUserAppSource + +`func NewUserAppSource() *UserAppSource` + +NewUserAppSource instantiates a new UserAppSource 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 + +### NewUserAppSourceWithDefaults + +`func NewUserAppSourceWithDefaults() *UserAppSource` + +NewUserAppSourceWithDefaults instantiates a new UserAppSource 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 + +### GetId + +`func (o *UserAppSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserAppSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserAppSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserAppSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *UserAppSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UserAppSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *UserAppSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *UserAppSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *UserAppSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UserAppSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UserAppSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *UserAppSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/UserAppSourceApp.md b/docs/tools/sdk/go/Reference/V2025/Models/UserAppSourceApp.md new file mode 100644 index 000000000..4c1502c3d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/UserAppSourceApp.md @@ -0,0 +1,116 @@ +--- +id: v2025-user-app-source-app +title: UserAppSourceApp +pagination_label: UserAppSourceApp +sidebar_label: UserAppSourceApp +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UserAppSourceApp', 'V2025UserAppSourceApp'] +slug: /tools/sdk/go/v2025/models/user-app-source-app +tags: ['SDK', 'Software Development Kit', 'UserAppSourceApp', 'V2025UserAppSourceApp'] +--- + +# UserAppSourceApp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the source app ID | [optional] +**Type** | Pointer to **string** | It will always be \"APPLICATION\" | [optional] +**Name** | Pointer to **string** | the source app name | [optional] + +## Methods + +### NewUserAppSourceApp + +`func NewUserAppSourceApp() *UserAppSourceApp` + +NewUserAppSourceApp instantiates a new UserAppSourceApp 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 + +### NewUserAppSourceAppWithDefaults + +`func NewUserAppSourceAppWithDefaults() *UserAppSourceApp` + +NewUserAppSourceAppWithDefaults instantiates a new UserAppSourceApp 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 + +### GetId + +`func (o *UserAppSourceApp) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UserAppSourceApp) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UserAppSourceApp) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UserAppSourceApp) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *UserAppSourceApp) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UserAppSourceApp) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *UserAppSourceApp) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *UserAppSourceApp) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *UserAppSourceApp) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UserAppSourceApp) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UserAppSourceApp) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *UserAppSourceApp) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/V3ConnectorDto.md b/docs/tools/sdk/go/Reference/V2025/Models/V3ConnectorDto.md new file mode 100644 index 000000000..306d84f9e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/V3ConnectorDto.md @@ -0,0 +1,266 @@ +--- +id: v2025-v3-connector-dto +title: V3ConnectorDto +pagination_label: V3ConnectorDto +sidebar_label: V3ConnectorDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'V3ConnectorDto', 'V2025V3ConnectorDto'] +slug: /tools/sdk/go/v2025/models/v3-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3ConnectorDto', 'V2025V3ConnectorDto'] +--- + +# V3ConnectorDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The connector name | [optional] +**Type** | Pointer to **string** | The connector type | [optional] +**ScriptName** | Pointer to **string** | The connector script name | [optional] +**ClassName** | Pointer to **NullableString** | The connector class name. | [optional] +**Features** | Pointer to **[]string** | The list of features supported by the connector | [optional] +**DirectConnect** | Pointer to **bool** | true if the source is a direct connect source | [optional] [default to false] +**ConnectorMetadata** | Pointer to **map[string]interface{}** | A map containing metadata pertinent to the connector | [optional] +**Status** | Pointer to **string** | The connector status | [optional] + +## Methods + +### NewV3ConnectorDto + +`func NewV3ConnectorDto() *V3ConnectorDto` + +NewV3ConnectorDto instantiates a new V3ConnectorDto 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 + +### NewV3ConnectorDtoWithDefaults + +`func NewV3ConnectorDtoWithDefaults() *V3ConnectorDto` + +NewV3ConnectorDtoWithDefaults instantiates a new V3ConnectorDto 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 + +### GetName + +`func (o *V3ConnectorDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *V3ConnectorDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *V3ConnectorDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *V3ConnectorDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *V3ConnectorDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *V3ConnectorDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *V3ConnectorDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *V3ConnectorDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetScriptName + +`func (o *V3ConnectorDto) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *V3ConnectorDto) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *V3ConnectorDto) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + +### HasScriptName + +`func (o *V3ConnectorDto) HasScriptName() bool` + +HasScriptName returns a boolean if a field has been set. + +### GetClassName + +`func (o *V3ConnectorDto) GetClassName() string` + +GetClassName returns the ClassName field if non-nil, zero value otherwise. + +### GetClassNameOk + +`func (o *V3ConnectorDto) GetClassNameOk() (*string, bool)` + +GetClassNameOk returns a tuple with the ClassName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClassName + +`func (o *V3ConnectorDto) SetClassName(v string)` + +SetClassName sets ClassName field to given value. + +### HasClassName + +`func (o *V3ConnectorDto) HasClassName() bool` + +HasClassName returns a boolean if a field has been set. + +### SetClassNameNil + +`func (o *V3ConnectorDto) SetClassNameNil(b bool)` + + SetClassNameNil sets the value for ClassName to be an explicit nil + +### UnsetClassName +`func (o *V3ConnectorDto) UnsetClassName()` + +UnsetClassName ensures that no value is present for ClassName, not even an explicit nil +### GetFeatures + +`func (o *V3ConnectorDto) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *V3ConnectorDto) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *V3ConnectorDto) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *V3ConnectorDto) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### SetFeaturesNil + +`func (o *V3ConnectorDto) SetFeaturesNil(b bool)` + + SetFeaturesNil sets the value for Features to be an explicit nil + +### UnsetFeatures +`func (o *V3ConnectorDto) UnsetFeatures()` + +UnsetFeatures ensures that no value is present for Features, not even an explicit nil +### GetDirectConnect + +`func (o *V3ConnectorDto) GetDirectConnect() bool` + +GetDirectConnect returns the DirectConnect field if non-nil, zero value otherwise. + +### GetDirectConnectOk + +`func (o *V3ConnectorDto) GetDirectConnectOk() (*bool, bool)` + +GetDirectConnectOk returns a tuple with the DirectConnect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectConnect + +`func (o *V3ConnectorDto) SetDirectConnect(v bool)` + +SetDirectConnect sets DirectConnect field to given value. + +### HasDirectConnect + +`func (o *V3ConnectorDto) HasDirectConnect() bool` + +HasDirectConnect returns a boolean if a field has been set. + +### GetConnectorMetadata + +`func (o *V3ConnectorDto) GetConnectorMetadata() map[string]interface{}` + +GetConnectorMetadata returns the ConnectorMetadata field if non-nil, zero value otherwise. + +### GetConnectorMetadataOk + +`func (o *V3ConnectorDto) GetConnectorMetadataOk() (*map[string]interface{}, bool)` + +GetConnectorMetadataOk returns a tuple with the ConnectorMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorMetadata + +`func (o *V3ConnectorDto) SetConnectorMetadata(v map[string]interface{})` + +SetConnectorMetadata sets ConnectorMetadata field to given value. + +### HasConnectorMetadata + +`func (o *V3ConnectorDto) HasConnectorMetadata() bool` + +HasConnectorMetadata returns a boolean if a field has been set. + +### GetStatus + +`func (o *V3ConnectorDto) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *V3ConnectorDto) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *V3ConnectorDto) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *V3ConnectorDto) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/V3CreateConnectorDto.md b/docs/tools/sdk/go/Reference/V2025/Models/V3CreateConnectorDto.md new file mode 100644 index 000000000..aed527469 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/V3CreateConnectorDto.md @@ -0,0 +1,158 @@ +--- +id: v2025-v3-create-connector-dto +title: V3CreateConnectorDto +pagination_label: V3CreateConnectorDto +sidebar_label: V3CreateConnectorDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'V3CreateConnectorDto', 'V2025V3CreateConnectorDto'] +slug: /tools/sdk/go/v2025/models/v3-create-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3CreateConnectorDto', 'V2025V3CreateConnectorDto'] +--- + +# V3CreateConnectorDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints | +**Type** | Pointer to **string** | The connector type. If not specified will be defaulted to 'custom '+name | [optional] +**ClassName** | **string** | The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter | +**DirectConnect** | Pointer to **bool** | true if the source is a direct connect source | [optional] [default to true] +**Status** | Pointer to **string** | The connector status | [optional] + +## Methods + +### NewV3CreateConnectorDto + +`func NewV3CreateConnectorDto(name string, className string, ) *V3CreateConnectorDto` + +NewV3CreateConnectorDto instantiates a new V3CreateConnectorDto 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 + +### NewV3CreateConnectorDtoWithDefaults + +`func NewV3CreateConnectorDtoWithDefaults() *V3CreateConnectorDto` + +NewV3CreateConnectorDtoWithDefaults instantiates a new V3CreateConnectorDto 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 + +### GetName + +`func (o *V3CreateConnectorDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *V3CreateConnectorDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *V3CreateConnectorDto) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *V3CreateConnectorDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *V3CreateConnectorDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *V3CreateConnectorDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *V3CreateConnectorDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetClassName + +`func (o *V3CreateConnectorDto) GetClassName() string` + +GetClassName returns the ClassName field if non-nil, zero value otherwise. + +### GetClassNameOk + +`func (o *V3CreateConnectorDto) GetClassNameOk() (*string, bool)` + +GetClassNameOk returns a tuple with the ClassName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClassName + +`func (o *V3CreateConnectorDto) SetClassName(v string)` + +SetClassName sets ClassName field to given value. + + +### GetDirectConnect + +`func (o *V3CreateConnectorDto) GetDirectConnect() bool` + +GetDirectConnect returns the DirectConnect field if non-nil, zero value otherwise. + +### GetDirectConnectOk + +`func (o *V3CreateConnectorDto) GetDirectConnectOk() (*bool, bool)` + +GetDirectConnectOk returns a tuple with the DirectConnect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectConnect + +`func (o *V3CreateConnectorDto) SetDirectConnect(v bool)` + +SetDirectConnect sets DirectConnect field to given value. + +### HasDirectConnect + +`func (o *V3CreateConnectorDto) HasDirectConnect() bool` + +HasDirectConnect returns a boolean if a field has been set. + +### GetStatus + +`func (o *V3CreateConnectorDto) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *V3CreateConnectorDto) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *V3CreateConnectorDto) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *V3CreateConnectorDto) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/VAClusterStatusChangeEvent.md b/docs/tools/sdk/go/Reference/V2025/Models/VAClusterStatusChangeEvent.md new file mode 100644 index 000000000..b5bce3ec4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/VAClusterStatusChangeEvent.md @@ -0,0 +1,143 @@ +--- +id: v2025-va-cluster-status-change-event +title: VAClusterStatusChangeEvent +pagination_label: VAClusterStatusChangeEvent +sidebar_label: VAClusterStatusChangeEvent +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VAClusterStatusChangeEvent', 'V2025VAClusterStatusChangeEvent'] +slug: /tools/sdk/go/v2025/models/va-cluster-status-change-event +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEvent', 'V2025VAClusterStatusChangeEvent'] +--- + +# VAClusterStatusChangeEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | **SailPointTime** | The date and time the status change occurred. | +**Type** | **map[string]interface{}** | The type of the object that initiated this event. | +**Application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | +**HealthCheckResult** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | +**PreviousHealthCheckResult** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | + +## Methods + +### NewVAClusterStatusChangeEvent + +`func NewVAClusterStatusChangeEvent(created SailPointTime, type_ map[string]interface{}, application VAClusterStatusChangeEventApplication, healthCheckResult VAClusterStatusChangeEventHealthCheckResult, previousHealthCheckResult VAClusterStatusChangeEventPreviousHealthCheckResult, ) *VAClusterStatusChangeEvent` + +NewVAClusterStatusChangeEvent instantiates a new VAClusterStatusChangeEvent 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 + +### NewVAClusterStatusChangeEventWithDefaults + +`func NewVAClusterStatusChangeEventWithDefaults() *VAClusterStatusChangeEvent` + +NewVAClusterStatusChangeEventWithDefaults instantiates a new VAClusterStatusChangeEvent 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 + +### GetCreated + +`func (o *VAClusterStatusChangeEvent) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *VAClusterStatusChangeEvent) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *VAClusterStatusChangeEvent) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetType + +`func (o *VAClusterStatusChangeEvent) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *VAClusterStatusChangeEvent) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *VAClusterStatusChangeEvent) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + + +### GetApplication + +`func (o *VAClusterStatusChangeEvent) GetApplication() VAClusterStatusChangeEventApplication` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *VAClusterStatusChangeEvent) GetApplicationOk() (*VAClusterStatusChangeEventApplication, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *VAClusterStatusChangeEvent) SetApplication(v VAClusterStatusChangeEventApplication)` + +SetApplication sets Application field to given value. + + +### GetHealthCheckResult + +`func (o *VAClusterStatusChangeEvent) GetHealthCheckResult() VAClusterStatusChangeEventHealthCheckResult` + +GetHealthCheckResult returns the HealthCheckResult field if non-nil, zero value otherwise. + +### GetHealthCheckResultOk + +`func (o *VAClusterStatusChangeEvent) GetHealthCheckResultOk() (*VAClusterStatusChangeEventHealthCheckResult, bool)` + +GetHealthCheckResultOk returns a tuple with the HealthCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthCheckResult + +`func (o *VAClusterStatusChangeEvent) SetHealthCheckResult(v VAClusterStatusChangeEventHealthCheckResult)` + +SetHealthCheckResult sets HealthCheckResult field to given value. + + +### GetPreviousHealthCheckResult + +`func (o *VAClusterStatusChangeEvent) GetPreviousHealthCheckResult() VAClusterStatusChangeEventPreviousHealthCheckResult` + +GetPreviousHealthCheckResult returns the PreviousHealthCheckResult field if non-nil, zero value otherwise. + +### GetPreviousHealthCheckResultOk + +`func (o *VAClusterStatusChangeEvent) GetPreviousHealthCheckResultOk() (*VAClusterStatusChangeEventPreviousHealthCheckResult, bool)` + +GetPreviousHealthCheckResultOk returns a tuple with the PreviousHealthCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousHealthCheckResult + +`func (o *VAClusterStatusChangeEvent) SetPreviousHealthCheckResult(v VAClusterStatusChangeEventPreviousHealthCheckResult)` + +SetPreviousHealthCheckResult sets PreviousHealthCheckResult field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/VAClusterStatusChangeEventApplication.md b/docs/tools/sdk/go/Reference/V2025/Models/VAClusterStatusChangeEventApplication.md new file mode 100644 index 000000000..1a3779ba7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/VAClusterStatusChangeEventApplication.md @@ -0,0 +1,111 @@ +--- +id: v2025-va-cluster-status-change-event-application +title: VAClusterStatusChangeEventApplication +pagination_label: VAClusterStatusChangeEventApplication +sidebar_label: VAClusterStatusChangeEventApplication +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VAClusterStatusChangeEventApplication', 'V2025VAClusterStatusChangeEventApplication'] +slug: /tools/sdk/go/v2025/models/va-cluster-status-change-event-application +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventApplication', 'V2025VAClusterStatusChangeEventApplication'] +--- + +# VAClusterStatusChangeEventApplication + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The GUID of the application | +**Name** | **string** | The name of the application | +**Attributes** | **map[string]interface{}** | Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. | + +## Methods + +### NewVAClusterStatusChangeEventApplication + +`func NewVAClusterStatusChangeEventApplication(id string, name string, attributes map[string]interface{}, ) *VAClusterStatusChangeEventApplication` + +NewVAClusterStatusChangeEventApplication instantiates a new VAClusterStatusChangeEventApplication 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 + +### NewVAClusterStatusChangeEventApplicationWithDefaults + +`func NewVAClusterStatusChangeEventApplicationWithDefaults() *VAClusterStatusChangeEventApplication` + +NewVAClusterStatusChangeEventApplicationWithDefaults instantiates a new VAClusterStatusChangeEventApplication 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 + +### GetId + +`func (o *VAClusterStatusChangeEventApplication) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *VAClusterStatusChangeEventApplication) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *VAClusterStatusChangeEventApplication) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *VAClusterStatusChangeEventApplication) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *VAClusterStatusChangeEventApplication) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *VAClusterStatusChangeEventApplication) SetName(v string)` + +SetName sets Name field to given value. + + +### GetAttributes + +`func (o *VAClusterStatusChangeEventApplication) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *VAClusterStatusChangeEventApplication) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *VAClusterStatusChangeEventApplication) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *VAClusterStatusChangeEventApplication) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *VAClusterStatusChangeEventApplication) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/VAClusterStatusChangeEventHealthCheckResult.md b/docs/tools/sdk/go/Reference/V2025/Models/VAClusterStatusChangeEventHealthCheckResult.md new file mode 100644 index 000000000..66078a1d0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/VAClusterStatusChangeEventHealthCheckResult.md @@ -0,0 +1,101 @@ +--- +id: v2025-va-cluster-status-change-event-health-check-result +title: VAClusterStatusChangeEventHealthCheckResult +pagination_label: VAClusterStatusChangeEventHealthCheckResult +sidebar_label: VAClusterStatusChangeEventHealthCheckResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VAClusterStatusChangeEventHealthCheckResult', 'V2025VAClusterStatusChangeEventHealthCheckResult'] +slug: /tools/sdk/go/v2025/models/va-cluster-status-change-event-health-check-result +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventHealthCheckResult', 'V2025VAClusterStatusChangeEventHealthCheckResult'] +--- + +# VAClusterStatusChangeEventHealthCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | **string** | Detailed message of the result of the health check. | +**ResultType** | **string** | The type of the health check result. | +**Status** | **map[string]interface{}** | The status of the health check. | + +## Methods + +### NewVAClusterStatusChangeEventHealthCheckResult + +`func NewVAClusterStatusChangeEventHealthCheckResult(message string, resultType string, status map[string]interface{}, ) *VAClusterStatusChangeEventHealthCheckResult` + +NewVAClusterStatusChangeEventHealthCheckResult instantiates a new VAClusterStatusChangeEventHealthCheckResult 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 + +### NewVAClusterStatusChangeEventHealthCheckResultWithDefaults + +`func NewVAClusterStatusChangeEventHealthCheckResultWithDefaults() *VAClusterStatusChangeEventHealthCheckResult` + +NewVAClusterStatusChangeEventHealthCheckResultWithDefaults instantiates a new VAClusterStatusChangeEventHealthCheckResult 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 + +### GetMessage + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *VAClusterStatusChangeEventHealthCheckResult) SetMessage(v string)` + +SetMessage sets Message field to given value. + + +### GetResultType + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetResultType() string` + +GetResultType returns the ResultType field if non-nil, zero value otherwise. + +### GetResultTypeOk + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetResultTypeOk() (*string, bool)` + +GetResultTypeOk returns a tuple with the ResultType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultType + +`func (o *VAClusterStatusChangeEventHealthCheckResult) SetResultType(v string)` + +SetResultType sets ResultType field to given value. + + +### GetStatus + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *VAClusterStatusChangeEventHealthCheckResult) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *VAClusterStatusChangeEventHealthCheckResult) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md b/docs/tools/sdk/go/Reference/V2025/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md new file mode 100644 index 000000000..de9fad14e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md @@ -0,0 +1,101 @@ +--- +id: v2025-va-cluster-status-change-event-previous-health-check-result +title: VAClusterStatusChangeEventPreviousHealthCheckResult +pagination_label: VAClusterStatusChangeEventPreviousHealthCheckResult +sidebar_label: VAClusterStatusChangeEventPreviousHealthCheckResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VAClusterStatusChangeEventPreviousHealthCheckResult', 'V2025VAClusterStatusChangeEventPreviousHealthCheckResult'] +slug: /tools/sdk/go/v2025/models/va-cluster-status-change-event-previous-health-check-result +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventPreviousHealthCheckResult', 'V2025VAClusterStatusChangeEventPreviousHealthCheckResult'] +--- + +# VAClusterStatusChangeEventPreviousHealthCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | **string** | Detailed message of the result of the health check. | +**ResultType** | **string** | The type of the health check result. | +**Status** | **map[string]interface{}** | The status of the health check. | + +## Methods + +### NewVAClusterStatusChangeEventPreviousHealthCheckResult + +`func NewVAClusterStatusChangeEventPreviousHealthCheckResult(message string, resultType string, status map[string]interface{}, ) *VAClusterStatusChangeEventPreviousHealthCheckResult` + +NewVAClusterStatusChangeEventPreviousHealthCheckResult instantiates a new VAClusterStatusChangeEventPreviousHealthCheckResult 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 + +### NewVAClusterStatusChangeEventPreviousHealthCheckResultWithDefaults + +`func NewVAClusterStatusChangeEventPreviousHealthCheckResultWithDefaults() *VAClusterStatusChangeEventPreviousHealthCheckResult` + +NewVAClusterStatusChangeEventPreviousHealthCheckResultWithDefaults instantiates a new VAClusterStatusChangeEventPreviousHealthCheckResult 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 + +### GetMessage + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) SetMessage(v string)` + +SetMessage sets Message field to given value. + + +### GetResultType + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetResultType() string` + +GetResultType returns the ResultType field if non-nil, zero value otherwise. + +### GetResultTypeOk + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetResultTypeOk() (*string, bool)` + +GetResultTypeOk returns a tuple with the ResultType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResultType + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) SetResultType(v string)` + +SetResultType sets ResultType field to given value. + + +### GetStatus + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetStatus() map[string]interface{}` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) GetStatusOk() (*map[string]interface{}, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *VAClusterStatusChangeEventPreviousHealthCheckResult) SetStatus(v map[string]interface{})` + +SetStatus sets Status field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ValidateFilterInputDto.md b/docs/tools/sdk/go/Reference/V2025/Models/ValidateFilterInputDto.md new file mode 100644 index 000000000..3a94b2ef1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ValidateFilterInputDto.md @@ -0,0 +1,80 @@ +--- +id: v2025-validate-filter-input-dto +title: ValidateFilterInputDto +pagination_label: ValidateFilterInputDto +sidebar_label: ValidateFilterInputDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ValidateFilterInputDto', 'V2025ValidateFilterInputDto'] +slug: /tools/sdk/go/v2025/models/validate-filter-input-dto +tags: ['SDK', 'Software Development Kit', 'ValidateFilterInputDto', 'V2025ValidateFilterInputDto'] +--- + +# ValidateFilterInputDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | **map[string]interface{}** | Mock input to evaluate filter expression against. | +**Filter** | **string** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | + +## Methods + +### NewValidateFilterInputDto + +`func NewValidateFilterInputDto(input map[string]interface{}, filter string, ) *ValidateFilterInputDto` + +NewValidateFilterInputDto instantiates a new ValidateFilterInputDto 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 + +### NewValidateFilterInputDtoWithDefaults + +`func NewValidateFilterInputDtoWithDefaults() *ValidateFilterInputDto` + +NewValidateFilterInputDtoWithDefaults instantiates a new ValidateFilterInputDto 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 + +### GetInput + +`func (o *ValidateFilterInputDto) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *ValidateFilterInputDto) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *ValidateFilterInputDto) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + + +### GetFilter + +`func (o *ValidateFilterInputDto) GetFilter() string` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *ValidateFilterInputDto) GetFilterOk() (*string, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *ValidateFilterInputDto) SetFilter(v string)` + +SetFilter sets Filter field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ValidateFilterOutputDto.md b/docs/tools/sdk/go/Reference/V2025/Models/ValidateFilterOutputDto.md new file mode 100644 index 000000000..0b0109be2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ValidateFilterOutputDto.md @@ -0,0 +1,116 @@ +--- +id: v2025-validate-filter-output-dto +title: ValidateFilterOutputDto +pagination_label: ValidateFilterOutputDto +sidebar_label: ValidateFilterOutputDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ValidateFilterOutputDto', 'V2025ValidateFilterOutputDto'] +slug: /tools/sdk/go/v2025/models/validate-filter-output-dto +tags: ['SDK', 'Software Development Kit', 'ValidateFilterOutputDto', 'V2025ValidateFilterOutputDto'] +--- + +# ValidateFilterOutputDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsValid** | Pointer to **bool** | When this field is true, the filter expression is valid against the input. | [optional] [default to false] +**IsValidJSONPath** | Pointer to **bool** | When this field is true, the filter expression is using a valid JSON path. | [optional] [default to false] +**IsPathExist** | Pointer to **bool** | When this field is true, the filter expression is using an existing path. | [optional] [default to false] + +## Methods + +### NewValidateFilterOutputDto + +`func NewValidateFilterOutputDto() *ValidateFilterOutputDto` + +NewValidateFilterOutputDto instantiates a new ValidateFilterOutputDto 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 + +### NewValidateFilterOutputDtoWithDefaults + +`func NewValidateFilterOutputDtoWithDefaults() *ValidateFilterOutputDto` + +NewValidateFilterOutputDtoWithDefaults instantiates a new ValidateFilterOutputDto 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 + +### GetIsValid + +`func (o *ValidateFilterOutputDto) GetIsValid() bool` + +GetIsValid returns the IsValid field if non-nil, zero value otherwise. + +### GetIsValidOk + +`func (o *ValidateFilterOutputDto) GetIsValidOk() (*bool, bool)` + +GetIsValidOk returns a tuple with the IsValid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsValid + +`func (o *ValidateFilterOutputDto) SetIsValid(v bool)` + +SetIsValid sets IsValid field to given value. + +### HasIsValid + +`func (o *ValidateFilterOutputDto) HasIsValid() bool` + +HasIsValid returns a boolean if a field has been set. + +### GetIsValidJSONPath + +`func (o *ValidateFilterOutputDto) GetIsValidJSONPath() bool` + +GetIsValidJSONPath returns the IsValidJSONPath field if non-nil, zero value otherwise. + +### GetIsValidJSONPathOk + +`func (o *ValidateFilterOutputDto) GetIsValidJSONPathOk() (*bool, bool)` + +GetIsValidJSONPathOk returns a tuple with the IsValidJSONPath field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsValidJSONPath + +`func (o *ValidateFilterOutputDto) SetIsValidJSONPath(v bool)` + +SetIsValidJSONPath sets IsValidJSONPath field to given value. + +### HasIsValidJSONPath + +`func (o *ValidateFilterOutputDto) HasIsValidJSONPath() bool` + +HasIsValidJSONPath returns a boolean if a field has been set. + +### GetIsPathExist + +`func (o *ValidateFilterOutputDto) GetIsPathExist() bool` + +GetIsPathExist returns the IsPathExist field if non-nil, zero value otherwise. + +### GetIsPathExistOk + +`func (o *ValidateFilterOutputDto) GetIsPathExistOk() (*bool, bool)` + +GetIsPathExistOk returns a tuple with the IsPathExist field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsPathExist + +`func (o *ValidateFilterOutputDto) SetIsPathExist(v bool)` + +SetIsPathExist sets IsPathExist field to given value. + +### HasIsPathExist + +`func (o *ValidateFilterOutputDto) HasIsPathExist() bool` + +HasIsPathExist returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Value.md b/docs/tools/sdk/go/Reference/V2025/Models/Value.md new file mode 100644 index 000000000..c9cf58e9f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Value.md @@ -0,0 +1,90 @@ +--- +id: v2025-value +title: Value +pagination_label: Value +sidebar_label: Value +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Value', 'V2025Value'] +slug: /tools/sdk/go/v2025/models/value +tags: ['SDK', 'Software Development Kit', 'Value', 'V2025Value'] +--- + +# Value + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of attribute value | [optional] +**Value** | Pointer to **string** | The attribute value | [optional] + +## Methods + +### NewValue + +`func NewValue() *Value` + +NewValue instantiates a new Value 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 + +### NewValueWithDefaults + +`func NewValueWithDefaults() *Value` + +NewValueWithDefaults instantiates a new Value 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 + +### GetType + +`func (o *Value) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Value) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Value) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Value) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetValue + +`func (o *Value) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Value) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Value) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Value) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/VendorConnectorMapping.md b/docs/tools/sdk/go/Reference/V2025/Models/VendorConnectorMapping.md new file mode 100644 index 000000000..fa0f1c548 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/VendorConnectorMapping.md @@ -0,0 +1,312 @@ +--- +id: v2025-vendor-connector-mapping +title: VendorConnectorMapping +pagination_label: VendorConnectorMapping +sidebar_label: VendorConnectorMapping +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMapping', 'V2025VendorConnectorMapping'] +slug: /tools/sdk/go/v2025/models/vendor-connector-mapping +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMapping', 'V2025VendorConnectorMapping'] +--- + +# VendorConnectorMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique identifier for the vendor-connector mapping. | [optional] +**Vendor** | Pointer to **string** | The name of the vendor. | [optional] +**Connector** | Pointer to **string** | The name of the connector. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The creation timestamp of the mapping. | [optional] +**CreatedBy** | Pointer to **string** | The identifier of the user who created the mapping. | [optional] +**UpdatedAt** | Pointer to [**NullableVendorConnectorMappingUpdatedAt**](vendor-connector-mapping-updated-at) | | [optional] +**UpdatedBy** | Pointer to [**NullableVendorConnectorMappingUpdatedBy**](vendor-connector-mapping-updated-by) | | [optional] +**DeletedAt** | Pointer to [**NullableVendorConnectorMappingDeletedAt**](vendor-connector-mapping-deleted-at) | | [optional] +**DeletedBy** | Pointer to [**NullableVendorConnectorMappingDeletedBy**](vendor-connector-mapping-deleted-by) | | [optional] + +## Methods + +### NewVendorConnectorMapping + +`func NewVendorConnectorMapping() *VendorConnectorMapping` + +NewVendorConnectorMapping instantiates a new VendorConnectorMapping 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 + +### NewVendorConnectorMappingWithDefaults + +`func NewVendorConnectorMappingWithDefaults() *VendorConnectorMapping` + +NewVendorConnectorMappingWithDefaults instantiates a new VendorConnectorMapping 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 + +### GetId + +`func (o *VendorConnectorMapping) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *VendorConnectorMapping) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *VendorConnectorMapping) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *VendorConnectorMapping) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetVendor + +`func (o *VendorConnectorMapping) GetVendor() string` + +GetVendor returns the Vendor field if non-nil, zero value otherwise. + +### GetVendorOk + +`func (o *VendorConnectorMapping) GetVendorOk() (*string, bool)` + +GetVendorOk returns a tuple with the Vendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVendor + +`func (o *VendorConnectorMapping) SetVendor(v string)` + +SetVendor sets Vendor field to given value. + +### HasVendor + +`func (o *VendorConnectorMapping) HasVendor() bool` + +HasVendor returns a boolean if a field has been set. + +### GetConnector + +`func (o *VendorConnectorMapping) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *VendorConnectorMapping) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *VendorConnectorMapping) SetConnector(v string)` + +SetConnector sets Connector field to given value. + +### HasConnector + +`func (o *VendorConnectorMapping) HasConnector() bool` + +HasConnector returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *VendorConnectorMapping) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *VendorConnectorMapping) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *VendorConnectorMapping) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *VendorConnectorMapping) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetCreatedBy + +`func (o *VendorConnectorMapping) GetCreatedBy() string` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *VendorConnectorMapping) GetCreatedByOk() (*string, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *VendorConnectorMapping) SetCreatedBy(v string)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *VendorConnectorMapping) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetUpdatedAt + +`func (o *VendorConnectorMapping) GetUpdatedAt() VendorConnectorMappingUpdatedAt` + +GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise. + +### GetUpdatedAtOk + +`func (o *VendorConnectorMapping) GetUpdatedAtOk() (*VendorConnectorMappingUpdatedAt, bool)` + +GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedAt + +`func (o *VendorConnectorMapping) SetUpdatedAt(v VendorConnectorMappingUpdatedAt)` + +SetUpdatedAt sets UpdatedAt field to given value. + +### HasUpdatedAt + +`func (o *VendorConnectorMapping) HasUpdatedAt() bool` + +HasUpdatedAt returns a boolean if a field has been set. + +### SetUpdatedAtNil + +`func (o *VendorConnectorMapping) SetUpdatedAtNil(b bool)` + + SetUpdatedAtNil sets the value for UpdatedAt to be an explicit nil + +### UnsetUpdatedAt +`func (o *VendorConnectorMapping) UnsetUpdatedAt()` + +UnsetUpdatedAt ensures that no value is present for UpdatedAt, not even an explicit nil +### GetUpdatedBy + +`func (o *VendorConnectorMapping) GetUpdatedBy() VendorConnectorMappingUpdatedBy` + +GetUpdatedBy returns the UpdatedBy field if non-nil, zero value otherwise. + +### GetUpdatedByOk + +`func (o *VendorConnectorMapping) GetUpdatedByOk() (*VendorConnectorMappingUpdatedBy, bool)` + +GetUpdatedByOk returns a tuple with the UpdatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedBy + +`func (o *VendorConnectorMapping) SetUpdatedBy(v VendorConnectorMappingUpdatedBy)` + +SetUpdatedBy sets UpdatedBy field to given value. + +### HasUpdatedBy + +`func (o *VendorConnectorMapping) HasUpdatedBy() bool` + +HasUpdatedBy returns a boolean if a field has been set. + +### SetUpdatedByNil + +`func (o *VendorConnectorMapping) SetUpdatedByNil(b bool)` + + SetUpdatedByNil sets the value for UpdatedBy to be an explicit nil + +### UnsetUpdatedBy +`func (o *VendorConnectorMapping) UnsetUpdatedBy()` + +UnsetUpdatedBy ensures that no value is present for UpdatedBy, not even an explicit nil +### GetDeletedAt + +`func (o *VendorConnectorMapping) GetDeletedAt() VendorConnectorMappingDeletedAt` + +GetDeletedAt returns the DeletedAt field if non-nil, zero value otherwise. + +### GetDeletedAtOk + +`func (o *VendorConnectorMapping) GetDeletedAtOk() (*VendorConnectorMappingDeletedAt, bool)` + +GetDeletedAtOk returns a tuple with the DeletedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeletedAt + +`func (o *VendorConnectorMapping) SetDeletedAt(v VendorConnectorMappingDeletedAt)` + +SetDeletedAt sets DeletedAt field to given value. + +### HasDeletedAt + +`func (o *VendorConnectorMapping) HasDeletedAt() bool` + +HasDeletedAt returns a boolean if a field has been set. + +### SetDeletedAtNil + +`func (o *VendorConnectorMapping) SetDeletedAtNil(b bool)` + + SetDeletedAtNil sets the value for DeletedAt to be an explicit nil + +### UnsetDeletedAt +`func (o *VendorConnectorMapping) UnsetDeletedAt()` + +UnsetDeletedAt ensures that no value is present for DeletedAt, not even an explicit nil +### GetDeletedBy + +`func (o *VendorConnectorMapping) GetDeletedBy() VendorConnectorMappingDeletedBy` + +GetDeletedBy returns the DeletedBy field if non-nil, zero value otherwise. + +### GetDeletedByOk + +`func (o *VendorConnectorMapping) GetDeletedByOk() (*VendorConnectorMappingDeletedBy, bool)` + +GetDeletedByOk returns a tuple with the DeletedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeletedBy + +`func (o *VendorConnectorMapping) SetDeletedBy(v VendorConnectorMappingDeletedBy)` + +SetDeletedBy sets DeletedBy field to given value. + +### HasDeletedBy + +`func (o *VendorConnectorMapping) HasDeletedBy() bool` + +HasDeletedBy returns a boolean if a field has been set. + +### SetDeletedByNil + +`func (o *VendorConnectorMapping) SetDeletedByNil(b bool)` + + SetDeletedByNil sets the value for DeletedBy to be an explicit nil + +### UnsetDeletedBy +`func (o *VendorConnectorMapping) UnsetDeletedBy()` + +UnsetDeletedBy ensures that no value is present for DeletedBy, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/VendorConnectorMappingDeletedAt.md b/docs/tools/sdk/go/Reference/V2025/Models/VendorConnectorMappingDeletedAt.md new file mode 100644 index 000000000..771f63882 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/VendorConnectorMappingDeletedAt.md @@ -0,0 +1,90 @@ +--- +id: v2025-vendor-connector-mapping-deleted-at +title: VendorConnectorMappingDeletedAt +pagination_label: VendorConnectorMappingDeletedAt +sidebar_label: VendorConnectorMappingDeletedAt +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappingDeletedAt', 'V2025VendorConnectorMappingDeletedAt'] +slug: /tools/sdk/go/v2025/models/vendor-connector-mapping-deleted-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedAt', 'V2025VendorConnectorMappingDeletedAt'] +--- + +# VendorConnectorMappingDeletedAt + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Time** | Pointer to **SailPointTime** | The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable. | [optional] +**Valid** | Pointer to **bool** | A flag indicating if the 'Time' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to false] + +## Methods + +### NewVendorConnectorMappingDeletedAt + +`func NewVendorConnectorMappingDeletedAt() *VendorConnectorMappingDeletedAt` + +NewVendorConnectorMappingDeletedAt instantiates a new VendorConnectorMappingDeletedAt 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 + +### NewVendorConnectorMappingDeletedAtWithDefaults + +`func NewVendorConnectorMappingDeletedAtWithDefaults() *VendorConnectorMappingDeletedAt` + +NewVendorConnectorMappingDeletedAtWithDefaults instantiates a new VendorConnectorMappingDeletedAt 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 + +### GetTime + +`func (o *VendorConnectorMappingDeletedAt) GetTime() SailPointTime` + +GetTime returns the Time field if non-nil, zero value otherwise. + +### GetTimeOk + +`func (o *VendorConnectorMappingDeletedAt) GetTimeOk() (*SailPointTime, bool)` + +GetTimeOk returns a tuple with the Time field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTime + +`func (o *VendorConnectorMappingDeletedAt) SetTime(v SailPointTime)` + +SetTime sets Time field to given value. + +### HasTime + +`func (o *VendorConnectorMappingDeletedAt) HasTime() bool` + +HasTime returns a boolean if a field has been set. + +### GetValid + +`func (o *VendorConnectorMappingDeletedAt) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *VendorConnectorMappingDeletedAt) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *VendorConnectorMappingDeletedAt) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *VendorConnectorMappingDeletedAt) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/VendorConnectorMappingDeletedBy.md b/docs/tools/sdk/go/Reference/V2025/Models/VendorConnectorMappingDeletedBy.md new file mode 100644 index 000000000..b379677ca --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/VendorConnectorMappingDeletedBy.md @@ -0,0 +1,90 @@ +--- +id: v2025-vendor-connector-mapping-deleted-by +title: VendorConnectorMappingDeletedBy +pagination_label: VendorConnectorMappingDeletedBy +sidebar_label: VendorConnectorMappingDeletedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappingDeletedBy', 'V2025VendorConnectorMappingDeletedBy'] +slug: /tools/sdk/go/v2025/models/vendor-connector-mapping-deleted-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedBy', 'V2025VendorConnectorMappingDeletedBy'] +--- + +# VendorConnectorMappingDeletedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**String** | Pointer to **string** | The identifier of the user who deleted the mapping, if applicable. | [optional] +**Valid** | Pointer to **bool** | A flag indicating if the 'String' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to false] + +## Methods + +### NewVendorConnectorMappingDeletedBy + +`func NewVendorConnectorMappingDeletedBy() *VendorConnectorMappingDeletedBy` + +NewVendorConnectorMappingDeletedBy instantiates a new VendorConnectorMappingDeletedBy 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 + +### NewVendorConnectorMappingDeletedByWithDefaults + +`func NewVendorConnectorMappingDeletedByWithDefaults() *VendorConnectorMappingDeletedBy` + +NewVendorConnectorMappingDeletedByWithDefaults instantiates a new VendorConnectorMappingDeletedBy 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 + +### GetString + +`func (o *VendorConnectorMappingDeletedBy) GetString() string` + +GetString returns the String field if non-nil, zero value otherwise. + +### GetStringOk + +`func (o *VendorConnectorMappingDeletedBy) GetStringOk() (*string, bool)` + +GetStringOk returns a tuple with the String field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetString + +`func (o *VendorConnectorMappingDeletedBy) SetString(v string)` + +SetString sets String field to given value. + +### HasString + +`func (o *VendorConnectorMappingDeletedBy) HasString() bool` + +HasString returns a boolean if a field has been set. + +### GetValid + +`func (o *VendorConnectorMappingDeletedBy) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *VendorConnectorMappingDeletedBy) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *VendorConnectorMappingDeletedBy) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *VendorConnectorMappingDeletedBy) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/VendorConnectorMappingUpdatedAt.md b/docs/tools/sdk/go/Reference/V2025/Models/VendorConnectorMappingUpdatedAt.md new file mode 100644 index 000000000..b0cf230ea --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/VendorConnectorMappingUpdatedAt.md @@ -0,0 +1,90 @@ +--- +id: v2025-vendor-connector-mapping-updated-at +title: VendorConnectorMappingUpdatedAt +pagination_label: VendorConnectorMappingUpdatedAt +sidebar_label: VendorConnectorMappingUpdatedAt +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappingUpdatedAt', 'V2025VendorConnectorMappingUpdatedAt'] +slug: /tools/sdk/go/v2025/models/vendor-connector-mapping-updated-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedAt', 'V2025VendorConnectorMappingUpdatedAt'] +--- + +# VendorConnectorMappingUpdatedAt + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Time** | Pointer to **SailPointTime** | The timestamp when the mapping was last updated, represented in ISO 8601 format. | [optional] +**Valid** | Pointer to **bool** | A flag indicating if the 'Time' field is set and valid. | [optional] [default to false] + +## Methods + +### NewVendorConnectorMappingUpdatedAt + +`func NewVendorConnectorMappingUpdatedAt() *VendorConnectorMappingUpdatedAt` + +NewVendorConnectorMappingUpdatedAt instantiates a new VendorConnectorMappingUpdatedAt 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 + +### NewVendorConnectorMappingUpdatedAtWithDefaults + +`func NewVendorConnectorMappingUpdatedAtWithDefaults() *VendorConnectorMappingUpdatedAt` + +NewVendorConnectorMappingUpdatedAtWithDefaults instantiates a new VendorConnectorMappingUpdatedAt 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 + +### GetTime + +`func (o *VendorConnectorMappingUpdatedAt) GetTime() SailPointTime` + +GetTime returns the Time field if non-nil, zero value otherwise. + +### GetTimeOk + +`func (o *VendorConnectorMappingUpdatedAt) GetTimeOk() (*SailPointTime, bool)` + +GetTimeOk returns a tuple with the Time field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTime + +`func (o *VendorConnectorMappingUpdatedAt) SetTime(v SailPointTime)` + +SetTime sets Time field to given value. + +### HasTime + +`func (o *VendorConnectorMappingUpdatedAt) HasTime() bool` + +HasTime returns a boolean if a field has been set. + +### GetValid + +`func (o *VendorConnectorMappingUpdatedAt) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *VendorConnectorMappingUpdatedAt) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *VendorConnectorMappingUpdatedAt) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *VendorConnectorMappingUpdatedAt) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/VendorConnectorMappingUpdatedBy.md b/docs/tools/sdk/go/Reference/V2025/Models/VendorConnectorMappingUpdatedBy.md new file mode 100644 index 000000000..d390463ea --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/VendorConnectorMappingUpdatedBy.md @@ -0,0 +1,90 @@ +--- +id: v2025-vendor-connector-mapping-updated-by +title: VendorConnectorMappingUpdatedBy +pagination_label: VendorConnectorMappingUpdatedBy +sidebar_label: VendorConnectorMappingUpdatedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappingUpdatedBy', 'V2025VendorConnectorMappingUpdatedBy'] +slug: /tools/sdk/go/v2025/models/vendor-connector-mapping-updated-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedBy', 'V2025VendorConnectorMappingUpdatedBy'] +--- + +# VendorConnectorMappingUpdatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**String** | Pointer to **string** | The identifier of the user who last updated the mapping, if available. | [optional] +**Valid** | Pointer to **bool** | A flag indicating if the 'String' field is set and valid. | [optional] [default to false] + +## Methods + +### NewVendorConnectorMappingUpdatedBy + +`func NewVendorConnectorMappingUpdatedBy() *VendorConnectorMappingUpdatedBy` + +NewVendorConnectorMappingUpdatedBy instantiates a new VendorConnectorMappingUpdatedBy 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 + +### NewVendorConnectorMappingUpdatedByWithDefaults + +`func NewVendorConnectorMappingUpdatedByWithDefaults() *VendorConnectorMappingUpdatedBy` + +NewVendorConnectorMappingUpdatedByWithDefaults instantiates a new VendorConnectorMappingUpdatedBy 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 + +### GetString + +`func (o *VendorConnectorMappingUpdatedBy) GetString() string` + +GetString returns the String field if non-nil, zero value otherwise. + +### GetStringOk + +`func (o *VendorConnectorMappingUpdatedBy) GetStringOk() (*string, bool)` + +GetStringOk returns a tuple with the String field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetString + +`func (o *VendorConnectorMappingUpdatedBy) SetString(v string)` + +SetString sets String field to given value. + +### HasString + +`func (o *VendorConnectorMappingUpdatedBy) HasString() bool` + +HasString returns a boolean if a field has been set. + +### GetValid + +`func (o *VendorConnectorMappingUpdatedBy) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *VendorConnectorMappingUpdatedBy) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *VendorConnectorMappingUpdatedBy) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *VendorConnectorMappingUpdatedBy) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ViolationContext.md b/docs/tools/sdk/go/Reference/V2025/Models/ViolationContext.md new file mode 100644 index 000000000..4157a70b6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ViolationContext.md @@ -0,0 +1,90 @@ +--- +id: v2025-violation-context +title: ViolationContext +pagination_label: ViolationContext +sidebar_label: ViolationContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationContext', 'V2025ViolationContext'] +slug: /tools/sdk/go/v2025/models/violation-context +tags: ['SDK', 'Software Development Kit', 'ViolationContext', 'V2025ViolationContext'] +--- + +# ViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**ViolationContextPolicy**](violation-context-policy) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**ExceptionAccessCriteria**](exception-access-criteria) | | [optional] + +## Methods + +### NewViolationContext + +`func NewViolationContext() *ViolationContext` + +NewViolationContext instantiates a new ViolationContext 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 + +### NewViolationContextWithDefaults + +`func NewViolationContextWithDefaults() *ViolationContext` + +NewViolationContextWithDefaults instantiates a new ViolationContext 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 + +### GetPolicy + +`func (o *ViolationContext) GetPolicy() ViolationContextPolicy` + +GetPolicy returns the Policy field if non-nil, zero value otherwise. + +### GetPolicyOk + +`func (o *ViolationContext) GetPolicyOk() (*ViolationContextPolicy, bool)` + +GetPolicyOk returns a tuple with the Policy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicy + +`func (o *ViolationContext) SetPolicy(v ViolationContextPolicy)` + +SetPolicy sets Policy field to given value. + +### HasPolicy + +`func (o *ViolationContext) HasPolicy() bool` + +HasPolicy returns a boolean if a field has been set. + +### GetConflictingAccessCriteria + +`func (o *ViolationContext) GetConflictingAccessCriteria() ExceptionAccessCriteria` + +GetConflictingAccessCriteria returns the ConflictingAccessCriteria field if non-nil, zero value otherwise. + +### GetConflictingAccessCriteriaOk + +`func (o *ViolationContext) GetConflictingAccessCriteriaOk() (*ExceptionAccessCriteria, bool)` + +GetConflictingAccessCriteriaOk returns a tuple with the ConflictingAccessCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConflictingAccessCriteria + +`func (o *ViolationContext) SetConflictingAccessCriteria(v ExceptionAccessCriteria)` + +SetConflictingAccessCriteria sets ConflictingAccessCriteria field to given value. + +### HasConflictingAccessCriteria + +`func (o *ViolationContext) HasConflictingAccessCriteria() bool` + +HasConflictingAccessCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ViolationContextPolicy.md b/docs/tools/sdk/go/Reference/V2025/Models/ViolationContextPolicy.md new file mode 100644 index 000000000..65c599a0f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ViolationContextPolicy.md @@ -0,0 +1,116 @@ +--- +id: v2025-violation-context-policy +title: ViolationContextPolicy +pagination_label: ViolationContextPolicy +sidebar_label: ViolationContextPolicy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationContextPolicy', 'V2025ViolationContextPolicy'] +slug: /tools/sdk/go/v2025/models/violation-context-policy +tags: ['SDK', 'Software Development Kit', 'ViolationContextPolicy', 'V2025ViolationContextPolicy'] +--- + +# ViolationContextPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **map[string]interface{}** | The type of object that is referenced | [optional] +**Id** | Pointer to **string** | SOD policy ID. | [optional] +**Name** | Pointer to **string** | | [optional] + +## Methods + +### NewViolationContextPolicy + +`func NewViolationContextPolicy() *ViolationContextPolicy` + +NewViolationContextPolicy instantiates a new ViolationContextPolicy 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 + +### NewViolationContextPolicyWithDefaults + +`func NewViolationContextPolicyWithDefaults() *ViolationContextPolicy` + +NewViolationContextPolicyWithDefaults instantiates a new ViolationContextPolicy 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 + +### GetType + +`func (o *ViolationContextPolicy) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ViolationContextPolicy) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ViolationContextPolicy) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + +### HasType + +`func (o *ViolationContextPolicy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ViolationContextPolicy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ViolationContextPolicy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ViolationContextPolicy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ViolationContextPolicy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ViolationContextPolicy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ViolationContextPolicy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ViolationContextPolicy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ViolationContextPolicy) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ViolationOwnerAssignmentConfig.md b/docs/tools/sdk/go/Reference/V2025/Models/ViolationOwnerAssignmentConfig.md new file mode 100644 index 000000000..e126c305d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ViolationOwnerAssignmentConfig.md @@ -0,0 +1,110 @@ +--- +id: v2025-violation-owner-assignment-config +title: ViolationOwnerAssignmentConfig +pagination_label: ViolationOwnerAssignmentConfig +sidebar_label: ViolationOwnerAssignmentConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationOwnerAssignmentConfig', 'V2025ViolationOwnerAssignmentConfig'] +slug: /tools/sdk/go/v2025/models/violation-owner-assignment-config +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfig', 'V2025ViolationOwnerAssignmentConfig'] +--- + +# ViolationOwnerAssignmentConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssignmentRule** | Pointer to **NullableString** | Details about the violations owner. MANAGER - identity's manager STATIC - Governance Group or Identity | [optional] +**OwnerRef** | Pointer to [**NullableViolationOwnerAssignmentConfigOwnerRef**](violation-owner-assignment-config-owner-ref) | | [optional] + +## Methods + +### NewViolationOwnerAssignmentConfig + +`func NewViolationOwnerAssignmentConfig() *ViolationOwnerAssignmentConfig` + +NewViolationOwnerAssignmentConfig instantiates a new ViolationOwnerAssignmentConfig 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 + +### NewViolationOwnerAssignmentConfigWithDefaults + +`func NewViolationOwnerAssignmentConfigWithDefaults() *ViolationOwnerAssignmentConfig` + +NewViolationOwnerAssignmentConfigWithDefaults instantiates a new ViolationOwnerAssignmentConfig 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 + +### GetAssignmentRule + +`func (o *ViolationOwnerAssignmentConfig) GetAssignmentRule() string` + +GetAssignmentRule returns the AssignmentRule field if non-nil, zero value otherwise. + +### GetAssignmentRuleOk + +`func (o *ViolationOwnerAssignmentConfig) GetAssignmentRuleOk() (*string, bool)` + +GetAssignmentRuleOk returns a tuple with the AssignmentRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentRule + +`func (o *ViolationOwnerAssignmentConfig) SetAssignmentRule(v string)` + +SetAssignmentRule sets AssignmentRule field to given value. + +### HasAssignmentRule + +`func (o *ViolationOwnerAssignmentConfig) HasAssignmentRule() bool` + +HasAssignmentRule returns a boolean if a field has been set. + +### SetAssignmentRuleNil + +`func (o *ViolationOwnerAssignmentConfig) SetAssignmentRuleNil(b bool)` + + SetAssignmentRuleNil sets the value for AssignmentRule to be an explicit nil + +### UnsetAssignmentRule +`func (o *ViolationOwnerAssignmentConfig) UnsetAssignmentRule()` + +UnsetAssignmentRule ensures that no value is present for AssignmentRule, not even an explicit nil +### GetOwnerRef + +`func (o *ViolationOwnerAssignmentConfig) GetOwnerRef() ViolationOwnerAssignmentConfigOwnerRef` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *ViolationOwnerAssignmentConfig) GetOwnerRefOk() (*ViolationOwnerAssignmentConfigOwnerRef, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *ViolationOwnerAssignmentConfig) SetOwnerRef(v ViolationOwnerAssignmentConfigOwnerRef)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *ViolationOwnerAssignmentConfig) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### SetOwnerRefNil + +`func (o *ViolationOwnerAssignmentConfig) SetOwnerRefNil(b bool)` + + SetOwnerRefNil sets the value for OwnerRef to be an explicit nil + +### UnsetOwnerRef +`func (o *ViolationOwnerAssignmentConfig) UnsetOwnerRef()` + +UnsetOwnerRef ensures that no value is present for OwnerRef, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ViolationOwnerAssignmentConfigOwnerRef.md b/docs/tools/sdk/go/Reference/V2025/Models/ViolationOwnerAssignmentConfigOwnerRef.md new file mode 100644 index 000000000..34443a5ac --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ViolationOwnerAssignmentConfigOwnerRef.md @@ -0,0 +1,126 @@ +--- +id: v2025-violation-owner-assignment-config-owner-ref +title: ViolationOwnerAssignmentConfigOwnerRef +pagination_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationOwnerAssignmentConfigOwnerRef', 'V2025ViolationOwnerAssignmentConfigOwnerRef'] +slug: /tools/sdk/go/v2025/models/violation-owner-assignment-config-owner-ref +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfigOwnerRef', 'V2025ViolationOwnerAssignmentConfigOwnerRef'] +--- + +# ViolationOwnerAssignmentConfigOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **NullableString** | Owner type. | [optional] +**Id** | Pointer to **string** | Owner's ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] + +## Methods + +### NewViolationOwnerAssignmentConfigOwnerRef + +`func NewViolationOwnerAssignmentConfigOwnerRef() *ViolationOwnerAssignmentConfigOwnerRef` + +NewViolationOwnerAssignmentConfigOwnerRef instantiates a new ViolationOwnerAssignmentConfigOwnerRef 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 + +### NewViolationOwnerAssignmentConfigOwnerRefWithDefaults + +`func NewViolationOwnerAssignmentConfigOwnerRefWithDefaults() *ViolationOwnerAssignmentConfigOwnerRef` + +NewViolationOwnerAssignmentConfigOwnerRefWithDefaults instantiates a new ViolationOwnerAssignmentConfigOwnerRef 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 + +### GetType + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *ViolationOwnerAssignmentConfigOwnerRef) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetId + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/ViolationPrediction.md b/docs/tools/sdk/go/Reference/V2025/Models/ViolationPrediction.md new file mode 100644 index 000000000..918416520 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/ViolationPrediction.md @@ -0,0 +1,64 @@ +--- +id: v2025-violation-prediction +title: ViolationPrediction +pagination_label: ViolationPrediction +sidebar_label: ViolationPrediction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationPrediction', 'V2025ViolationPrediction'] +slug: /tools/sdk/go/v2025/models/violation-prediction +tags: ['SDK', 'Software Development Kit', 'ViolationPrediction', 'V2025ViolationPrediction'] +--- + +# ViolationPrediction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ViolationContexts** | Pointer to [**[]ViolationContext**](violation-context) | List of Violation Contexts | [optional] + +## Methods + +### NewViolationPrediction + +`func NewViolationPrediction() *ViolationPrediction` + +NewViolationPrediction instantiates a new ViolationPrediction 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 + +### NewViolationPredictionWithDefaults + +`func NewViolationPredictionWithDefaults() *ViolationPrediction` + +NewViolationPredictionWithDefaults instantiates a new ViolationPrediction 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 + +### GetViolationContexts + +`func (o *ViolationPrediction) GetViolationContexts() []ViolationContext` + +GetViolationContexts returns the ViolationContexts field if non-nil, zero value otherwise. + +### GetViolationContextsOk + +`func (o *ViolationPrediction) GetViolationContextsOk() (*[]ViolationContext, bool)` + +GetViolationContextsOk returns a tuple with the ViolationContexts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationContexts + +`func (o *ViolationPrediction) SetViolationContexts(v []ViolationContext)` + +SetViolationContexts sets ViolationContexts field to given value. + +### HasViolationContexts + +`func (o *ViolationPrediction) HasViolationContexts() bool` + +HasViolationContexts returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/VisibilityCriteria.md b/docs/tools/sdk/go/Reference/V2025/Models/VisibilityCriteria.md new file mode 100644 index 000000000..72e77da17 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/VisibilityCriteria.md @@ -0,0 +1,64 @@ +--- +id: v2025-visibility-criteria +title: VisibilityCriteria +pagination_label: VisibilityCriteria +sidebar_label: VisibilityCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VisibilityCriteria', 'V2025VisibilityCriteria'] +slug: /tools/sdk/go/v2025/models/visibility-criteria +tags: ['SDK', 'Software Development Kit', 'VisibilityCriteria', 'V2025VisibilityCriteria'] +--- + +# VisibilityCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | Pointer to [**Expression**](expression) | | [optional] + +## Methods + +### NewVisibilityCriteria + +`func NewVisibilityCriteria() *VisibilityCriteria` + +NewVisibilityCriteria instantiates a new VisibilityCriteria 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 + +### NewVisibilityCriteriaWithDefaults + +`func NewVisibilityCriteriaWithDefaults() *VisibilityCriteria` + +NewVisibilityCriteriaWithDefaults instantiates a new VisibilityCriteria 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 + +### GetExpression + +`func (o *VisibilityCriteria) GetExpression() Expression` + +GetExpression returns the Expression field if non-nil, zero value otherwise. + +### GetExpressionOk + +`func (o *VisibilityCriteria) GetExpressionOk() (*Expression, bool)` + +GetExpressionOk returns a tuple with the Expression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpression + +`func (o *VisibilityCriteria) SetExpression(v Expression)` + +SetExpression sets Expression field to given value. + +### HasExpression + +`func (o *VisibilityCriteria) HasExpression() bool` + +HasExpression returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkItemForward.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkItemForward.md new file mode 100644 index 000000000..2c851d6e2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkItemForward.md @@ -0,0 +1,106 @@ +--- +id: v2025-work-item-forward +title: WorkItemForward +pagination_label: WorkItemForward +sidebar_label: WorkItemForward +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemForward', 'V2025WorkItemForward'] +slug: /tools/sdk/go/v2025/models/work-item-forward +tags: ['SDK', 'Software Development Kit', 'WorkItemForward', 'V2025WorkItemForward'] +--- + +# WorkItemForward + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TargetOwnerId** | **string** | The ID of the identity to forward this work item to. | +**Comment** | **string** | Comments to send to the target owner | +**SendNotifications** | Pointer to **bool** | If true, send a notification to the target owner. | [optional] [default to true] + +## Methods + +### NewWorkItemForward + +`func NewWorkItemForward(targetOwnerId string, comment string, ) *WorkItemForward` + +NewWorkItemForward instantiates a new WorkItemForward 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 + +### NewWorkItemForwardWithDefaults + +`func NewWorkItemForwardWithDefaults() *WorkItemForward` + +NewWorkItemForwardWithDefaults instantiates a new WorkItemForward 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 + +### GetTargetOwnerId + +`func (o *WorkItemForward) GetTargetOwnerId() string` + +GetTargetOwnerId returns the TargetOwnerId field if non-nil, zero value otherwise. + +### GetTargetOwnerIdOk + +`func (o *WorkItemForward) GetTargetOwnerIdOk() (*string, bool)` + +GetTargetOwnerIdOk returns a tuple with the TargetOwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetOwnerId + +`func (o *WorkItemForward) SetTargetOwnerId(v string)` + +SetTargetOwnerId sets TargetOwnerId field to given value. + + +### GetComment + +`func (o *WorkItemForward) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *WorkItemForward) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *WorkItemForward) SetComment(v string)` + +SetComment sets Comment field to given value. + + +### GetSendNotifications + +`func (o *WorkItemForward) GetSendNotifications() bool` + +GetSendNotifications returns the SendNotifications field if non-nil, zero value otherwise. + +### GetSendNotificationsOk + +`func (o *WorkItemForward) GetSendNotificationsOk() (*bool, bool)` + +GetSendNotificationsOk returns a tuple with the SendNotifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSendNotifications + +`func (o *WorkItemForward) SetSendNotifications(v bool)` + +SetSendNotifications sets SendNotifications field to given value. + +### HasSendNotifications + +`func (o *WorkItemForward) HasSendNotifications() bool` + +HasSendNotifications returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkItemState.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkItemState.md new file mode 100644 index 000000000..52206a4e9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkItemState.md @@ -0,0 +1,29 @@ +--- +id: v2025-work-item-state +title: WorkItemState +pagination_label: WorkItemState +sidebar_label: WorkItemState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemState', 'V2025WorkItemState'] +slug: /tools/sdk/go/v2025/models/work-item-state +tags: ['SDK', 'Software Development Kit', 'WorkItemState', 'V2025WorkItemState'] +--- + +# WorkItemState + +## Enum + + +* `FINISHED` (value: `"Finished"`) + +* `REJECTED` (value: `"Rejected"`) + +* `RETURNED` (value: `"Returned"`) + +* `EXPIRED` (value: `"Expired"`) + +* `PENDING` (value: `"Pending"`) + +* `CANCELED` (value: `"Canceled"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkItemStateManualWorkItems.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkItemStateManualWorkItems.md new file mode 100644 index 000000000..b48e77cef --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkItemStateManualWorkItems.md @@ -0,0 +1,29 @@ +--- +id: v2025-work-item-state-manual-work-items +title: WorkItemStateManualWorkItems +pagination_label: WorkItemStateManualWorkItems +sidebar_label: WorkItemStateManualWorkItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemStateManualWorkItems', 'V2025WorkItemStateManualWorkItems'] +slug: /tools/sdk/go/v2025/models/work-item-state-manual-work-items +tags: ['SDK', 'Software Development Kit', 'WorkItemStateManualWorkItems', 'V2025WorkItemStateManualWorkItems'] +--- + +# WorkItemStateManualWorkItems + +## Enum + + +* `FINISHED` (value: `"Finished"`) + +* `REJECTED` (value: `"Rejected"`) + +* `RETURNED` (value: `"Returned"`) + +* `EXPIRED` (value: `"Expired"`) + +* `PENDING` (value: `"Pending"`) + +* `CANCELED` (value: `"Canceled"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkItemTypeManualWorkItems.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkItemTypeManualWorkItems.md new file mode 100644 index 000000000..cd9ea01b6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkItemTypeManualWorkItems.md @@ -0,0 +1,45 @@ +--- +id: v2025-work-item-type-manual-work-items +title: WorkItemTypeManualWorkItems +pagination_label: WorkItemTypeManualWorkItems +sidebar_label: WorkItemTypeManualWorkItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemTypeManualWorkItems', 'V2025WorkItemTypeManualWorkItems'] +slug: /tools/sdk/go/v2025/models/work-item-type-manual-work-items +tags: ['SDK', 'Software Development Kit', 'WorkItemTypeManualWorkItems', 'V2025WorkItemTypeManualWorkItems'] +--- + +# WorkItemTypeManualWorkItems + +## Enum + + +* `GENERIC` (value: `"Generic"`) + +* `CERTIFICATION` (value: `"Certification"`) + +* `REMEDIATION` (value: `"Remediation"`) + +* `DELEGATION` (value: `"Delegation"`) + +* `APPROVAL` (value: `"Approval"`) + +* `VIOLATION_REVIEW` (value: `"ViolationReview"`) + +* `FORM` (value: `"Form"`) + +* `POLICY_VIOLOATION` (value: `"PolicyVioloation"`) + +* `CHALLENGE` (value: `"Challenge"`) + +* `IMPACT_ANALYSIS` (value: `"ImpactAnalysis"`) + +* `SIGNOFF` (value: `"Signoff"`) + +* `EVENT` (value: `"Event"`) + +* `MANUAL_ACTION` (value: `"ManualAction"`) + +* `TEST` (value: `"Test"`) + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkItems.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkItems.md new file mode 100644 index 000000000..68e533aa7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkItems.md @@ -0,0 +1,570 @@ +--- +id: v2025-work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItems', 'V2025WorkItems'] +slug: /tools/sdk/go/v2025/models/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'V2025WorkItems'] +--- + +# WorkItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the work item | [optional] +**RequesterId** | Pointer to **NullableString** | ID of the requester | [optional] +**RequesterDisplayName** | Pointer to **NullableString** | The displayname of the requester | [optional] +**OwnerId** | Pointer to **NullableString** | The ID of the owner | [optional] +**OwnerName** | Pointer to **string** | The name of the owner | [optional] +**Created** | Pointer to **SailPointTime** | Time when the work item was created | [optional] +**Modified** | Pointer to **NullableTime** | Time when the work item was last updated | [optional] +**Description** | Pointer to **string** | The description of the work item | [optional] +**State** | Pointer to [**WorkItemStateManualWorkItems**](work-item-state-manual-work-items) | | [optional] +**Type** | Pointer to [**WorkItemTypeManualWorkItems**](work-item-type-manual-work-items) | | [optional] +**RemediationItems** | Pointer to [**[]RemediationItemDetails**](remediation-item-details) | A list of remediation items | [optional] +**ApprovalItems** | Pointer to [**[]ApprovalItemDetails**](approval-item-details) | A list of items that need to be approved | [optional] +**Name** | Pointer to **NullableString** | The work item name | [optional] +**Completed** | Pointer to **NullableTime** | The time at which the work item completed | [optional] +**NumItems** | Pointer to **NullableInt32** | The number of items in the work item | [optional] +**Form** | Pointer to [**WorkItemsForm**](work-items-form) | | [optional] +**Errors** | Pointer to **[]string** | An array of errors that ocurred during the work item | [optional] + +## Methods + +### NewWorkItems + +`func NewWorkItems() *WorkItems` + +NewWorkItems instantiates a new WorkItems 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 + +### NewWorkItemsWithDefaults + +`func NewWorkItemsWithDefaults() *WorkItems` + +NewWorkItemsWithDefaults instantiates a new WorkItems 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 + +### GetId + +`func (o *WorkItems) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkItems) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkItems) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkItems) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRequesterId + +`func (o *WorkItems) GetRequesterId() string` + +GetRequesterId returns the RequesterId field if non-nil, zero value otherwise. + +### GetRequesterIdOk + +`func (o *WorkItems) GetRequesterIdOk() (*string, bool)` + +GetRequesterIdOk returns a tuple with the RequesterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterId + +`func (o *WorkItems) SetRequesterId(v string)` + +SetRequesterId sets RequesterId field to given value. + +### HasRequesterId + +`func (o *WorkItems) HasRequesterId() bool` + +HasRequesterId returns a boolean if a field has been set. + +### SetRequesterIdNil + +`func (o *WorkItems) SetRequesterIdNil(b bool)` + + SetRequesterIdNil sets the value for RequesterId to be an explicit nil + +### UnsetRequesterId +`func (o *WorkItems) UnsetRequesterId()` + +UnsetRequesterId ensures that no value is present for RequesterId, not even an explicit nil +### GetRequesterDisplayName + +`func (o *WorkItems) GetRequesterDisplayName() string` + +GetRequesterDisplayName returns the RequesterDisplayName field if non-nil, zero value otherwise. + +### GetRequesterDisplayNameOk + +`func (o *WorkItems) GetRequesterDisplayNameOk() (*string, bool)` + +GetRequesterDisplayNameOk returns a tuple with the RequesterDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterDisplayName + +`func (o *WorkItems) SetRequesterDisplayName(v string)` + +SetRequesterDisplayName sets RequesterDisplayName field to given value. + +### HasRequesterDisplayName + +`func (o *WorkItems) HasRequesterDisplayName() bool` + +HasRequesterDisplayName returns a boolean if a field has been set. + +### SetRequesterDisplayNameNil + +`func (o *WorkItems) SetRequesterDisplayNameNil(b bool)` + + SetRequesterDisplayNameNil sets the value for RequesterDisplayName to be an explicit nil + +### UnsetRequesterDisplayName +`func (o *WorkItems) UnsetRequesterDisplayName()` + +UnsetRequesterDisplayName ensures that no value is present for RequesterDisplayName, not even an explicit nil +### GetOwnerId + +`func (o *WorkItems) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *WorkItems) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *WorkItems) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *WorkItems) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + +### SetOwnerIdNil + +`func (o *WorkItems) SetOwnerIdNil(b bool)` + + SetOwnerIdNil sets the value for OwnerId to be an explicit nil + +### UnsetOwnerId +`func (o *WorkItems) UnsetOwnerId()` + +UnsetOwnerId ensures that no value is present for OwnerId, not even an explicit nil +### GetOwnerName + +`func (o *WorkItems) GetOwnerName() string` + +GetOwnerName returns the OwnerName field if non-nil, zero value otherwise. + +### GetOwnerNameOk + +`func (o *WorkItems) GetOwnerNameOk() (*string, bool)` + +GetOwnerNameOk returns a tuple with the OwnerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerName + +`func (o *WorkItems) SetOwnerName(v string)` + +SetOwnerName sets OwnerName field to given value. + +### HasOwnerName + +`func (o *WorkItems) HasOwnerName() bool` + +HasOwnerName returns a boolean if a field has been set. + +### GetCreated + +`func (o *WorkItems) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *WorkItems) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *WorkItems) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *WorkItems) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *WorkItems) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *WorkItems) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *WorkItems) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *WorkItems) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *WorkItems) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *WorkItems) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDescription + +`func (o *WorkItems) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkItems) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkItems) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkItems) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetState + +`func (o *WorkItems) GetState() WorkItemStateManualWorkItems` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *WorkItems) GetStateOk() (*WorkItemStateManualWorkItems, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *WorkItems) SetState(v WorkItemStateManualWorkItems)` + +SetState sets State field to given value. + +### HasState + +`func (o *WorkItems) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetType + +`func (o *WorkItems) GetType() WorkItemTypeManualWorkItems` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkItems) GetTypeOk() (*WorkItemTypeManualWorkItems, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkItems) SetType(v WorkItemTypeManualWorkItems)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkItems) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRemediationItems + +`func (o *WorkItems) GetRemediationItems() []RemediationItemDetails` + +GetRemediationItems returns the RemediationItems field if non-nil, zero value otherwise. + +### GetRemediationItemsOk + +`func (o *WorkItems) GetRemediationItemsOk() (*[]RemediationItemDetails, bool)` + +GetRemediationItemsOk returns a tuple with the RemediationItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemediationItems + +`func (o *WorkItems) SetRemediationItems(v []RemediationItemDetails)` + +SetRemediationItems sets RemediationItems field to given value. + +### HasRemediationItems + +`func (o *WorkItems) HasRemediationItems() bool` + +HasRemediationItems returns a boolean if a field has been set. + +### SetRemediationItemsNil + +`func (o *WorkItems) SetRemediationItemsNil(b bool)` + + SetRemediationItemsNil sets the value for RemediationItems to be an explicit nil + +### UnsetRemediationItems +`func (o *WorkItems) UnsetRemediationItems()` + +UnsetRemediationItems ensures that no value is present for RemediationItems, not even an explicit nil +### GetApprovalItems + +`func (o *WorkItems) GetApprovalItems() []ApprovalItemDetails` + +GetApprovalItems returns the ApprovalItems field if non-nil, zero value otherwise. + +### GetApprovalItemsOk + +`func (o *WorkItems) GetApprovalItemsOk() (*[]ApprovalItemDetails, bool)` + +GetApprovalItemsOk returns a tuple with the ApprovalItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalItems + +`func (o *WorkItems) SetApprovalItems(v []ApprovalItemDetails)` + +SetApprovalItems sets ApprovalItems field to given value. + +### HasApprovalItems + +`func (o *WorkItems) HasApprovalItems() bool` + +HasApprovalItems returns a boolean if a field has been set. + +### SetApprovalItemsNil + +`func (o *WorkItems) SetApprovalItemsNil(b bool)` + + SetApprovalItemsNil sets the value for ApprovalItems to be an explicit nil + +### UnsetApprovalItems +`func (o *WorkItems) UnsetApprovalItems()` + +UnsetApprovalItems ensures that no value is present for ApprovalItems, not even an explicit nil +### GetName + +`func (o *WorkItems) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkItems) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkItems) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkItems) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *WorkItems) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *WorkItems) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCompleted + +`func (o *WorkItems) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *WorkItems) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *WorkItems) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *WorkItems) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *WorkItems) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *WorkItems) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetNumItems + +`func (o *WorkItems) GetNumItems() int32` + +GetNumItems returns the NumItems field if non-nil, zero value otherwise. + +### GetNumItemsOk + +`func (o *WorkItems) GetNumItemsOk() (*int32, bool)` + +GetNumItemsOk returns a tuple with the NumItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumItems + +`func (o *WorkItems) SetNumItems(v int32)` + +SetNumItems sets NumItems field to given value. + +### HasNumItems + +`func (o *WorkItems) HasNumItems() bool` + +HasNumItems returns a boolean if a field has been set. + +### SetNumItemsNil + +`func (o *WorkItems) SetNumItemsNil(b bool)` + + SetNumItemsNil sets the value for NumItems to be an explicit nil + +### UnsetNumItems +`func (o *WorkItems) UnsetNumItems()` + +UnsetNumItems ensures that no value is present for NumItems, not even an explicit nil +### GetForm + +`func (o *WorkItems) GetForm() WorkItemsForm` + +GetForm returns the Form field if non-nil, zero value otherwise. + +### GetFormOk + +`func (o *WorkItems) GetFormOk() (*WorkItemsForm, bool)` + +GetFormOk returns a tuple with the Form field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForm + +`func (o *WorkItems) SetForm(v WorkItemsForm)` + +SetForm sets Form field to given value. + +### HasForm + +`func (o *WorkItems) HasForm() bool` + +HasForm returns a boolean if a field has been set. + +### GetErrors + +`func (o *WorkItems) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *WorkItems) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *WorkItems) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *WorkItems) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkItemsCount.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkItemsCount.md new file mode 100644 index 000000000..8e353f749 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkItemsCount.md @@ -0,0 +1,64 @@ +--- +id: v2025-work-items-count +title: WorkItemsCount +pagination_label: WorkItemsCount +sidebar_label: WorkItemsCount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemsCount', 'V2025WorkItemsCount'] +slug: /tools/sdk/go/v2025/models/work-items-count +tags: ['SDK', 'Software Development Kit', 'WorkItemsCount', 'V2025WorkItemsCount'] +--- + +# WorkItemsCount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **int32** | The count of work items | [optional] + +## Methods + +### NewWorkItemsCount + +`func NewWorkItemsCount() *WorkItemsCount` + +NewWorkItemsCount instantiates a new WorkItemsCount 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 + +### NewWorkItemsCountWithDefaults + +`func NewWorkItemsCountWithDefaults() *WorkItemsCount` + +NewWorkItemsCountWithDefaults instantiates a new WorkItemsCount 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 + +### GetCount + +`func (o *WorkItemsCount) GetCount() int32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *WorkItemsCount) GetCountOk() (*int32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *WorkItemsCount) SetCount(v int32)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *WorkItemsCount) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkItemsForm.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkItemsForm.md new file mode 100644 index 000000000..84bdec54c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkItemsForm.md @@ -0,0 +1,234 @@ +--- +id: v2025-work-items-form +title: WorkItemsForm +pagination_label: WorkItemsForm +sidebar_label: WorkItemsForm +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemsForm', 'V2025WorkItemsForm'] +slug: /tools/sdk/go/v2025/models/work-items-form +tags: ['SDK', 'Software Development Kit', 'WorkItemsForm', 'V2025WorkItemsForm'] +--- + +# WorkItemsForm + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | ID of the form | [optional] +**Name** | Pointer to **NullableString** | Name of the form | [optional] +**Title** | Pointer to **NullableString** | The form title | [optional] +**Subtitle** | Pointer to **NullableString** | The form subtitle. | [optional] +**TargetUser** | Pointer to **string** | The name of the user that should be shown this form | [optional] +**Sections** | Pointer to [**[]SectionDetails**](section-details) | Sections of the form | [optional] + +## Methods + +### NewWorkItemsForm + +`func NewWorkItemsForm() *WorkItemsForm` + +NewWorkItemsForm instantiates a new WorkItemsForm 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 + +### NewWorkItemsFormWithDefaults + +`func NewWorkItemsFormWithDefaults() *WorkItemsForm` + +NewWorkItemsFormWithDefaults instantiates a new WorkItemsForm 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 + +### GetId + +`func (o *WorkItemsForm) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkItemsForm) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkItemsForm) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkItemsForm) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *WorkItemsForm) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *WorkItemsForm) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *WorkItemsForm) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkItemsForm) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkItemsForm) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkItemsForm) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *WorkItemsForm) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *WorkItemsForm) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetTitle + +`func (o *WorkItemsForm) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *WorkItemsForm) GetTitleOk() (*string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTitle + +`func (o *WorkItemsForm) SetTitle(v string)` + +SetTitle sets Title field to given value. + +### HasTitle + +`func (o *WorkItemsForm) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### SetTitleNil + +`func (o *WorkItemsForm) SetTitleNil(b bool)` + + SetTitleNil sets the value for Title to be an explicit nil + +### UnsetTitle +`func (o *WorkItemsForm) UnsetTitle()` + +UnsetTitle ensures that no value is present for Title, not even an explicit nil +### GetSubtitle + +`func (o *WorkItemsForm) GetSubtitle() string` + +GetSubtitle returns the Subtitle field if non-nil, zero value otherwise. + +### GetSubtitleOk + +`func (o *WorkItemsForm) GetSubtitleOk() (*string, bool)` + +GetSubtitleOk returns a tuple with the Subtitle field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubtitle + +`func (o *WorkItemsForm) SetSubtitle(v string)` + +SetSubtitle sets Subtitle field to given value. + +### HasSubtitle + +`func (o *WorkItemsForm) HasSubtitle() bool` + +HasSubtitle returns a boolean if a field has been set. + +### SetSubtitleNil + +`func (o *WorkItemsForm) SetSubtitleNil(b bool)` + + SetSubtitleNil sets the value for Subtitle to be an explicit nil + +### UnsetSubtitle +`func (o *WorkItemsForm) UnsetSubtitle()` + +UnsetSubtitle ensures that no value is present for Subtitle, not even an explicit nil +### GetTargetUser + +`func (o *WorkItemsForm) GetTargetUser() string` + +GetTargetUser returns the TargetUser field if non-nil, zero value otherwise. + +### GetTargetUserOk + +`func (o *WorkItemsForm) GetTargetUserOk() (*string, bool)` + +GetTargetUserOk returns a tuple with the TargetUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetUser + +`func (o *WorkItemsForm) SetTargetUser(v string)` + +SetTargetUser sets TargetUser field to given value. + +### HasTargetUser + +`func (o *WorkItemsForm) HasTargetUser() bool` + +HasTargetUser returns a boolean if a field has been set. + +### GetSections + +`func (o *WorkItemsForm) GetSections() []SectionDetails` + +GetSections returns the Sections field if non-nil, zero value otherwise. + +### GetSectionsOk + +`func (o *WorkItemsForm) GetSectionsOk() (*[]SectionDetails, bool)` + +GetSectionsOk returns a tuple with the Sections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSections + +`func (o *WorkItemsForm) SetSections(v []SectionDetails)` + +SetSections sets Sections field to given value. + +### HasSections + +`func (o *WorkItemsForm) HasSections() bool` + +HasSections returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkItemsSummary.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkItemsSummary.md new file mode 100644 index 000000000..9d5c3f857 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkItemsSummary.md @@ -0,0 +1,116 @@ +--- +id: v2025-work-items-summary +title: WorkItemsSummary +pagination_label: WorkItemsSummary +sidebar_label: WorkItemsSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemsSummary', 'V2025WorkItemsSummary'] +slug: /tools/sdk/go/v2025/models/work-items-summary +tags: ['SDK', 'Software Development Kit', 'WorkItemsSummary', 'V2025WorkItemsSummary'] +--- + +# WorkItemsSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Open** | Pointer to **int32** | The count of open work items | [optional] +**Completed** | Pointer to **int32** | The count of completed work items | [optional] +**Total** | Pointer to **int32** | The count of total work items | [optional] + +## Methods + +### NewWorkItemsSummary + +`func NewWorkItemsSummary() *WorkItemsSummary` + +NewWorkItemsSummary instantiates a new WorkItemsSummary 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 + +### NewWorkItemsSummaryWithDefaults + +`func NewWorkItemsSummaryWithDefaults() *WorkItemsSummary` + +NewWorkItemsSummaryWithDefaults instantiates a new WorkItemsSummary 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 + +### GetOpen + +`func (o *WorkItemsSummary) GetOpen() int32` + +GetOpen returns the Open field if non-nil, zero value otherwise. + +### GetOpenOk + +`func (o *WorkItemsSummary) GetOpenOk() (*int32, bool)` + +GetOpenOk returns a tuple with the Open field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOpen + +`func (o *WorkItemsSummary) SetOpen(v int32)` + +SetOpen sets Open field to given value. + +### HasOpen + +`func (o *WorkItemsSummary) HasOpen() bool` + +HasOpen returns a boolean if a field has been set. + +### GetCompleted + +`func (o *WorkItemsSummary) GetCompleted() int32` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *WorkItemsSummary) GetCompletedOk() (*int32, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *WorkItemsSummary) SetCompleted(v int32)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *WorkItemsSummary) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetTotal + +`func (o *WorkItemsSummary) GetTotal() int32` + +GetTotal returns the Total field if non-nil, zero value otherwise. + +### GetTotalOk + +`func (o *WorkItemsSummary) GetTotalOk() (*int32, bool)` + +GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotal + +`func (o *WorkItemsSummary) SetTotal(v int32)` + +SetTotal sets Total field to given value. + +### HasTotal + +`func (o *WorkItemsSummary) HasTotal() bool` + +HasTotal returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/Workflow.md b/docs/tools/sdk/go/Reference/V2025/Models/Workflow.md new file mode 100644 index 000000000..a6bc1c349 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/Workflow.md @@ -0,0 +1,376 @@ +--- +id: v2025-workflow +title: Workflow +pagination_label: Workflow +sidebar_label: Workflow +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Workflow', 'V2025Workflow'] +slug: /tools/sdk/go/v2025/models/workflow +tags: ['SDK', 'Software Development Kit', 'Workflow', 'V2025Workflow'] +--- + +# Workflow + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the workflow | [optional] +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **string** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **bool** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] +**Id** | Pointer to **string** | Workflow ID. This is a UUID generated upon creation. | [optional] +**ExecutionCount** | Pointer to **int32** | The number of times this workflow has been executed. | [optional] +**FailureCount** | Pointer to **int32** | The number of times this workflow has failed during execution. | [optional] +**Created** | Pointer to **SailPointTime** | The date and time the workflow was created. | [optional] +**Modified** | Pointer to **SailPointTime** | The date and time the workflow was modified. | [optional] +**ModifiedBy** | Pointer to [**WorkflowModifiedBy**](workflow-modified-by) | | [optional] +**Creator** | Pointer to [**WorkflowAllOfCreator**](workflow-all-of-creator) | | [optional] + +## Methods + +### NewWorkflow + +`func NewWorkflow() *Workflow` + +NewWorkflow instantiates a new Workflow 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 + +### NewWorkflowWithDefaults + +`func NewWorkflowWithDefaults() *Workflow` + +NewWorkflowWithDefaults instantiates a new Workflow 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 + +### GetName + +`func (o *Workflow) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Workflow) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Workflow) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Workflow) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOwner + +`func (o *Workflow) GetOwner() WorkflowBodyOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Workflow) GetOwnerOk() (*WorkflowBodyOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Workflow) SetOwner(v WorkflowBodyOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *Workflow) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDescription + +`func (o *Workflow) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Workflow) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Workflow) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Workflow) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDefinition + +`func (o *Workflow) GetDefinition() WorkflowDefinition` + +GetDefinition returns the Definition field if non-nil, zero value otherwise. + +### GetDefinitionOk + +`func (o *Workflow) GetDefinitionOk() (*WorkflowDefinition, bool)` + +GetDefinitionOk returns a tuple with the Definition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefinition + +`func (o *Workflow) SetDefinition(v WorkflowDefinition)` + +SetDefinition sets Definition field to given value. + +### HasDefinition + +`func (o *Workflow) HasDefinition() bool` + +HasDefinition returns a boolean if a field has been set. + +### GetEnabled + +`func (o *Workflow) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *Workflow) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *Workflow) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *Workflow) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetTrigger + +`func (o *Workflow) GetTrigger() WorkflowTrigger` + +GetTrigger returns the Trigger field if non-nil, zero value otherwise. + +### GetTriggerOk + +`func (o *Workflow) GetTriggerOk() (*WorkflowTrigger, bool)` + +GetTriggerOk returns a tuple with the Trigger field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrigger + +`func (o *Workflow) SetTrigger(v WorkflowTrigger)` + +SetTrigger sets Trigger field to given value. + +### HasTrigger + +`func (o *Workflow) HasTrigger() bool` + +HasTrigger returns a boolean if a field has been set. + +### GetId + +`func (o *Workflow) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Workflow) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Workflow) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Workflow) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetExecutionCount + +`func (o *Workflow) GetExecutionCount() int32` + +GetExecutionCount returns the ExecutionCount field if non-nil, zero value otherwise. + +### GetExecutionCountOk + +`func (o *Workflow) GetExecutionCountOk() (*int32, bool)` + +GetExecutionCountOk returns a tuple with the ExecutionCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExecutionCount + +`func (o *Workflow) SetExecutionCount(v int32)` + +SetExecutionCount sets ExecutionCount field to given value. + +### HasExecutionCount + +`func (o *Workflow) HasExecutionCount() bool` + +HasExecutionCount returns a boolean if a field has been set. + +### GetFailureCount + +`func (o *Workflow) GetFailureCount() int32` + +GetFailureCount returns the FailureCount field if non-nil, zero value otherwise. + +### GetFailureCountOk + +`func (o *Workflow) GetFailureCountOk() (*int32, bool)` + +GetFailureCountOk returns a tuple with the FailureCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFailureCount + +`func (o *Workflow) SetFailureCount(v int32)` + +SetFailureCount sets FailureCount field to given value. + +### HasFailureCount + +`func (o *Workflow) HasFailureCount() bool` + +HasFailureCount returns a boolean if a field has been set. + +### GetCreated + +`func (o *Workflow) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Workflow) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Workflow) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Workflow) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Workflow) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Workflow) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Workflow) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Workflow) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetModifiedBy + +`func (o *Workflow) GetModifiedBy() WorkflowModifiedBy` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *Workflow) GetModifiedByOk() (*WorkflowModifiedBy, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedBy + +`func (o *Workflow) SetModifiedBy(v WorkflowModifiedBy)` + +SetModifiedBy sets ModifiedBy field to given value. + +### HasModifiedBy + +`func (o *Workflow) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### GetCreator + +`func (o *Workflow) GetCreator() WorkflowAllOfCreator` + +GetCreator returns the Creator field if non-nil, zero value otherwise. + +### GetCreatorOk + +`func (o *Workflow) GetCreatorOk() (*WorkflowAllOfCreator, bool)` + +GetCreatorOk returns a tuple with the Creator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreator + +`func (o *Workflow) SetCreator(v WorkflowAllOfCreator)` + +SetCreator sets Creator field to given value. + +### HasCreator + +`func (o *Workflow) HasCreator() bool` + +HasCreator returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkflowAllOfCreator.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowAllOfCreator.md new file mode 100644 index 000000000..b6ec79b6f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowAllOfCreator.md @@ -0,0 +1,116 @@ +--- +id: v2025-workflow-all-of-creator +title: WorkflowAllOfCreator +pagination_label: WorkflowAllOfCreator +sidebar_label: WorkflowAllOfCreator +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowAllOfCreator', 'V2025WorkflowAllOfCreator'] +slug: /tools/sdk/go/v2025/models/workflow-all-of-creator +tags: ['SDK', 'Software Development Kit', 'WorkflowAllOfCreator', 'V2025WorkflowAllOfCreator'] +--- + +# WorkflowAllOfCreator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Workflow creator's DTO type. | [optional] +**Id** | Pointer to **string** | Workflow creator's identity ID. | [optional] +**Name** | Pointer to **string** | Workflow creator's display name. | [optional] + +## Methods + +### NewWorkflowAllOfCreator + +`func NewWorkflowAllOfCreator() *WorkflowAllOfCreator` + +NewWorkflowAllOfCreator instantiates a new WorkflowAllOfCreator 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 + +### NewWorkflowAllOfCreatorWithDefaults + +`func NewWorkflowAllOfCreatorWithDefaults() *WorkflowAllOfCreator` + +NewWorkflowAllOfCreatorWithDefaults instantiates a new WorkflowAllOfCreator 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 + +### GetType + +`func (o *WorkflowAllOfCreator) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowAllOfCreator) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowAllOfCreator) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowAllOfCreator) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkflowAllOfCreator) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowAllOfCreator) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowAllOfCreator) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowAllOfCreator) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowAllOfCreator) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowAllOfCreator) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowAllOfCreator) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowAllOfCreator) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkflowBody.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowBody.md new file mode 100644 index 000000000..385da44d8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowBody.md @@ -0,0 +1,194 @@ +--- +id: v2025-workflow-body +title: WorkflowBody +pagination_label: WorkflowBody +sidebar_label: WorkflowBody +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowBody', 'V2025WorkflowBody'] +slug: /tools/sdk/go/v2025/models/workflow-body +tags: ['SDK', 'Software Development Kit', 'WorkflowBody', 'V2025WorkflowBody'] +--- + +# WorkflowBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the workflow | [optional] +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **string** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **bool** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] + +## Methods + +### NewWorkflowBody + +`func NewWorkflowBody() *WorkflowBody` + +NewWorkflowBody instantiates a new WorkflowBody 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 + +### NewWorkflowBodyWithDefaults + +`func NewWorkflowBodyWithDefaults() *WorkflowBody` + +NewWorkflowBodyWithDefaults instantiates a new WorkflowBody 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 + +### GetName + +`func (o *WorkflowBody) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowBody) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowBody) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowBody) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOwner + +`func (o *WorkflowBody) GetOwner() WorkflowBodyOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *WorkflowBody) GetOwnerOk() (*WorkflowBodyOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *WorkflowBody) SetOwner(v WorkflowBodyOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *WorkflowBody) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkflowBody) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowBody) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowBody) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowBody) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDefinition + +`func (o *WorkflowBody) GetDefinition() WorkflowDefinition` + +GetDefinition returns the Definition field if non-nil, zero value otherwise. + +### GetDefinitionOk + +`func (o *WorkflowBody) GetDefinitionOk() (*WorkflowDefinition, bool)` + +GetDefinitionOk returns a tuple with the Definition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefinition + +`func (o *WorkflowBody) SetDefinition(v WorkflowDefinition)` + +SetDefinition sets Definition field to given value. + +### HasDefinition + +`func (o *WorkflowBody) HasDefinition() bool` + +HasDefinition returns a boolean if a field has been set. + +### GetEnabled + +`func (o *WorkflowBody) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *WorkflowBody) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *WorkflowBody) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *WorkflowBody) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetTrigger + +`func (o *WorkflowBody) GetTrigger() WorkflowTrigger` + +GetTrigger returns the Trigger field if non-nil, zero value otherwise. + +### GetTriggerOk + +`func (o *WorkflowBody) GetTriggerOk() (*WorkflowTrigger, bool)` + +GetTriggerOk returns a tuple with the Trigger field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrigger + +`func (o *WorkflowBody) SetTrigger(v WorkflowTrigger)` + +SetTrigger sets Trigger field to given value. + +### HasTrigger + +`func (o *WorkflowBody) HasTrigger() bool` + +HasTrigger returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkflowBodyOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowBodyOwner.md new file mode 100644 index 000000000..382eb4cc7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowBodyOwner.md @@ -0,0 +1,116 @@ +--- +id: v2025-workflow-body-owner +title: WorkflowBodyOwner +pagination_label: WorkflowBodyOwner +sidebar_label: WorkflowBodyOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowBodyOwner', 'V2025WorkflowBodyOwner'] +slug: /tools/sdk/go/v2025/models/workflow-body-owner +tags: ['SDK', 'Software Development Kit', 'WorkflowBodyOwner', 'V2025WorkflowBodyOwner'] +--- + +# WorkflowBodyOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of object that is referenced | [optional] +**Id** | Pointer to **string** | The unique ID of the object | [optional] +**Name** | Pointer to **string** | The name of the object | [optional] + +## Methods + +### NewWorkflowBodyOwner + +`func NewWorkflowBodyOwner() *WorkflowBodyOwner` + +NewWorkflowBodyOwner instantiates a new WorkflowBodyOwner 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 + +### NewWorkflowBodyOwnerWithDefaults + +`func NewWorkflowBodyOwnerWithDefaults() *WorkflowBodyOwner` + +NewWorkflowBodyOwnerWithDefaults instantiates a new WorkflowBodyOwner 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 + +### GetType + +`func (o *WorkflowBodyOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowBodyOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowBodyOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowBodyOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkflowBodyOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowBodyOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowBodyOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowBodyOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowBodyOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowBodyOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowBodyOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowBodyOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkflowDefinition.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowDefinition.md new file mode 100644 index 000000000..60acf1ce2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowDefinition.md @@ -0,0 +1,90 @@ +--- +id: v2025-workflow-definition +title: WorkflowDefinition +pagination_label: WorkflowDefinition +sidebar_label: WorkflowDefinition +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowDefinition', 'V2025WorkflowDefinition'] +slug: /tools/sdk/go/v2025/models/workflow-definition +tags: ['SDK', 'Software Development Kit', 'WorkflowDefinition', 'V2025WorkflowDefinition'] +--- + +# WorkflowDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **string** | The name of the starting step. | [optional] +**Steps** | Pointer to **map[string]interface{}** | One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. | [optional] + +## Methods + +### NewWorkflowDefinition + +`func NewWorkflowDefinition() *WorkflowDefinition` + +NewWorkflowDefinition instantiates a new WorkflowDefinition 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 + +### NewWorkflowDefinitionWithDefaults + +`func NewWorkflowDefinitionWithDefaults() *WorkflowDefinition` + +NewWorkflowDefinitionWithDefaults instantiates a new WorkflowDefinition 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 + +### GetStart + +`func (o *WorkflowDefinition) GetStart() string` + +GetStart returns the Start field if non-nil, zero value otherwise. + +### GetStartOk + +`func (o *WorkflowDefinition) GetStartOk() (*string, bool)` + +GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStart + +`func (o *WorkflowDefinition) SetStart(v string)` + +SetStart sets Start field to given value. + +### HasStart + +`func (o *WorkflowDefinition) HasStart() bool` + +HasStart returns a boolean if a field has been set. + +### GetSteps + +`func (o *WorkflowDefinition) GetSteps() map[string]interface{}` + +GetSteps returns the Steps field if non-nil, zero value otherwise. + +### GetStepsOk + +`func (o *WorkflowDefinition) GetStepsOk() (*map[string]interface{}, bool)` + +GetStepsOk returns a tuple with the Steps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSteps + +`func (o *WorkflowDefinition) SetSteps(v map[string]interface{})` + +SetSteps sets Steps field to given value. + +### HasSteps + +`func (o *WorkflowDefinition) HasSteps() bool` + +HasSteps returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkflowExecution.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowExecution.md new file mode 100644 index 000000000..9c4099284 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowExecution.md @@ -0,0 +1,194 @@ +--- +id: v2025-workflow-execution +title: WorkflowExecution +pagination_label: WorkflowExecution +sidebar_label: WorkflowExecution +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowExecution', 'V2025WorkflowExecution'] +slug: /tools/sdk/go/v2025/models/workflow-execution +tags: ['SDK', 'Software Development Kit', 'WorkflowExecution', 'V2025WorkflowExecution'] +--- + +# WorkflowExecution + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Workflow execution ID. | [optional] +**WorkflowId** | Pointer to **string** | Workflow ID. | [optional] +**RequestId** | Pointer to **string** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] +**StartTime** | Pointer to **SailPointTime** | Date/time when the workflow started. | [optional] +**CloseTime** | Pointer to **SailPointTime** | Date/time when the workflow ended. | [optional] +**Status** | Pointer to **string** | Workflow execution status. | [optional] + +## Methods + +### NewWorkflowExecution + +`func NewWorkflowExecution() *WorkflowExecution` + +NewWorkflowExecution instantiates a new WorkflowExecution 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 + +### NewWorkflowExecutionWithDefaults + +`func NewWorkflowExecutionWithDefaults() *WorkflowExecution` + +NewWorkflowExecutionWithDefaults instantiates a new WorkflowExecution 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 + +### GetId + +`func (o *WorkflowExecution) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowExecution) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowExecution) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowExecution) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetWorkflowId + +`func (o *WorkflowExecution) GetWorkflowId() string` + +GetWorkflowId returns the WorkflowId field if non-nil, zero value otherwise. + +### GetWorkflowIdOk + +`func (o *WorkflowExecution) GetWorkflowIdOk() (*string, bool)` + +GetWorkflowIdOk returns a tuple with the WorkflowId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWorkflowId + +`func (o *WorkflowExecution) SetWorkflowId(v string)` + +SetWorkflowId sets WorkflowId field to given value. + +### HasWorkflowId + +`func (o *WorkflowExecution) HasWorkflowId() bool` + +HasWorkflowId returns a boolean if a field has been set. + +### GetRequestId + +`func (o *WorkflowExecution) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *WorkflowExecution) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *WorkflowExecution) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *WorkflowExecution) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### GetStartTime + +`func (o *WorkflowExecution) GetStartTime() SailPointTime` + +GetStartTime returns the StartTime field if non-nil, zero value otherwise. + +### GetStartTimeOk + +`func (o *WorkflowExecution) GetStartTimeOk() (*SailPointTime, bool)` + +GetStartTimeOk returns a tuple with the StartTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartTime + +`func (o *WorkflowExecution) SetStartTime(v SailPointTime)` + +SetStartTime sets StartTime field to given value. + +### HasStartTime + +`func (o *WorkflowExecution) HasStartTime() bool` + +HasStartTime returns a boolean if a field has been set. + +### GetCloseTime + +`func (o *WorkflowExecution) GetCloseTime() SailPointTime` + +GetCloseTime returns the CloseTime field if non-nil, zero value otherwise. + +### GetCloseTimeOk + +`func (o *WorkflowExecution) GetCloseTimeOk() (*SailPointTime, bool)` + +GetCloseTimeOk returns a tuple with the CloseTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloseTime + +`func (o *WorkflowExecution) SetCloseTime(v SailPointTime)` + +SetCloseTime sets CloseTime field to given value. + +### HasCloseTime + +`func (o *WorkflowExecution) HasCloseTime() bool` + +HasCloseTime returns a boolean if a field has been set. + +### GetStatus + +`func (o *WorkflowExecution) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *WorkflowExecution) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *WorkflowExecution) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *WorkflowExecution) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkflowExecutionEvent.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowExecutionEvent.md new file mode 100644 index 000000000..55453e0b4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowExecutionEvent.md @@ -0,0 +1,116 @@ +--- +id: v2025-workflow-execution-event +title: WorkflowExecutionEvent +pagination_label: WorkflowExecutionEvent +sidebar_label: WorkflowExecutionEvent +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowExecutionEvent', 'V2025WorkflowExecutionEvent'] +slug: /tools/sdk/go/v2025/models/workflow-execution-event +tags: ['SDK', 'Software Development Kit', 'WorkflowExecutionEvent', 'V2025WorkflowExecutionEvent'] +--- + +# WorkflowExecutionEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of event | [optional] +**Timestamp** | Pointer to **SailPointTime** | The date-time when the event occurred | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Additional attributes associated with the event | [optional] + +## Methods + +### NewWorkflowExecutionEvent + +`func NewWorkflowExecutionEvent() *WorkflowExecutionEvent` + +NewWorkflowExecutionEvent instantiates a new WorkflowExecutionEvent 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 + +### NewWorkflowExecutionEventWithDefaults + +`func NewWorkflowExecutionEventWithDefaults() *WorkflowExecutionEvent` + +NewWorkflowExecutionEventWithDefaults instantiates a new WorkflowExecutionEvent 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 + +### GetType + +`func (o *WorkflowExecutionEvent) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowExecutionEvent) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowExecutionEvent) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowExecutionEvent) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetTimestamp + +`func (o *WorkflowExecutionEvent) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *WorkflowExecutionEvent) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *WorkflowExecutionEvent) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *WorkflowExecutionEvent) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + +### GetAttributes + +`func (o *WorkflowExecutionEvent) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *WorkflowExecutionEvent) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *WorkflowExecutionEvent) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *WorkflowExecutionEvent) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkflowLibraryAction.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowLibraryAction.md new file mode 100644 index 000000000..db9c915d6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowLibraryAction.md @@ -0,0 +1,360 @@ +--- +id: v2025-workflow-library-action +title: WorkflowLibraryAction +pagination_label: WorkflowLibraryAction +sidebar_label: WorkflowLibraryAction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryAction', 'V2025WorkflowLibraryAction'] +slug: /tools/sdk/go/v2025/models/workflow-library-action +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryAction', 'V2025WorkflowLibraryAction'] +--- + +# WorkflowLibraryAction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Action ID. This is a static namespaced ID for the action | [optional] +**Name** | Pointer to **string** | Action Name | [optional] +**Type** | Pointer to **string** | Action type | [optional] +**Description** | Pointer to **string** | Action Description | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the action accepts | [optional] +**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**Deprecated** | Pointer to **bool** | | [optional] +**DeprecatedBy** | Pointer to **SailPointTime** | | [optional] +**VersionNumber** | Pointer to **int32** | Version number | [optional] +**IsSimulationEnabled** | Pointer to **bool** | | [optional] +**IsDynamicSchema** | Pointer to **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] [default to false] +**OutputSchema** | Pointer to **map[string]interface{}** | Defines the output schema, if any, that this action produces. | [optional] + +## Methods + +### NewWorkflowLibraryAction + +`func NewWorkflowLibraryAction() *WorkflowLibraryAction` + +NewWorkflowLibraryAction instantiates a new WorkflowLibraryAction 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 + +### NewWorkflowLibraryActionWithDefaults + +`func NewWorkflowLibraryActionWithDefaults() *WorkflowLibraryAction` + +NewWorkflowLibraryActionWithDefaults instantiates a new WorkflowLibraryAction 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 + +### GetId + +`func (o *WorkflowLibraryAction) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowLibraryAction) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowLibraryAction) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowLibraryAction) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowLibraryAction) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowLibraryAction) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowLibraryAction) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowLibraryAction) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *WorkflowLibraryAction) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowLibraryAction) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowLibraryAction) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowLibraryAction) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkflowLibraryAction) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowLibraryAction) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowLibraryAction) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowLibraryAction) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetFormFields + +`func (o *WorkflowLibraryAction) GetFormFields() []WorkflowLibraryFormFields` + +GetFormFields returns the FormFields field if non-nil, zero value otherwise. + +### GetFormFieldsOk + +`func (o *WorkflowLibraryAction) GetFormFieldsOk() (*[]WorkflowLibraryFormFields, bool)` + +GetFormFieldsOk returns a tuple with the FormFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormFields + +`func (o *WorkflowLibraryAction) SetFormFields(v []WorkflowLibraryFormFields)` + +SetFormFields sets FormFields field to given value. + +### HasFormFields + +`func (o *WorkflowLibraryAction) HasFormFields() bool` + +HasFormFields returns a boolean if a field has been set. + +### SetFormFieldsNil + +`func (o *WorkflowLibraryAction) SetFormFieldsNil(b bool)` + + SetFormFieldsNil sets the value for FormFields to be an explicit nil + +### UnsetFormFields +`func (o *WorkflowLibraryAction) UnsetFormFields()` + +UnsetFormFields ensures that no value is present for FormFields, not even an explicit nil +### GetExampleOutput + +`func (o *WorkflowLibraryAction) GetExampleOutput() WorkflowLibraryActionExampleOutput` + +GetExampleOutput returns the ExampleOutput field if non-nil, zero value otherwise. + +### GetExampleOutputOk + +`func (o *WorkflowLibraryAction) GetExampleOutputOk() (*WorkflowLibraryActionExampleOutput, bool)` + +GetExampleOutputOk returns a tuple with the ExampleOutput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExampleOutput + +`func (o *WorkflowLibraryAction) SetExampleOutput(v WorkflowLibraryActionExampleOutput)` + +SetExampleOutput sets ExampleOutput field to given value. + +### HasExampleOutput + +`func (o *WorkflowLibraryAction) HasExampleOutput() bool` + +HasExampleOutput returns a boolean if a field has been set. + +### GetDeprecated + +`func (o *WorkflowLibraryAction) GetDeprecated() bool` + +GetDeprecated returns the Deprecated field if non-nil, zero value otherwise. + +### GetDeprecatedOk + +`func (o *WorkflowLibraryAction) GetDeprecatedOk() (*bool, bool)` + +GetDeprecatedOk returns a tuple with the Deprecated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecated + +`func (o *WorkflowLibraryAction) SetDeprecated(v bool)` + +SetDeprecated sets Deprecated field to given value. + +### HasDeprecated + +`func (o *WorkflowLibraryAction) HasDeprecated() bool` + +HasDeprecated returns a boolean if a field has been set. + +### GetDeprecatedBy + +`func (o *WorkflowLibraryAction) GetDeprecatedBy() SailPointTime` + +GetDeprecatedBy returns the DeprecatedBy field if non-nil, zero value otherwise. + +### GetDeprecatedByOk + +`func (o *WorkflowLibraryAction) GetDeprecatedByOk() (*SailPointTime, bool)` + +GetDeprecatedByOk returns a tuple with the DeprecatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecatedBy + +`func (o *WorkflowLibraryAction) SetDeprecatedBy(v SailPointTime)` + +SetDeprecatedBy sets DeprecatedBy field to given value. + +### HasDeprecatedBy + +`func (o *WorkflowLibraryAction) HasDeprecatedBy() bool` + +HasDeprecatedBy returns a boolean if a field has been set. + +### GetVersionNumber + +`func (o *WorkflowLibraryAction) GetVersionNumber() int32` + +GetVersionNumber returns the VersionNumber field if non-nil, zero value otherwise. + +### GetVersionNumberOk + +`func (o *WorkflowLibraryAction) GetVersionNumberOk() (*int32, bool)` + +GetVersionNumberOk returns a tuple with the VersionNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionNumber + +`func (o *WorkflowLibraryAction) SetVersionNumber(v int32)` + +SetVersionNumber sets VersionNumber field to given value. + +### HasVersionNumber + +`func (o *WorkflowLibraryAction) HasVersionNumber() bool` + +HasVersionNumber returns a boolean if a field has been set. + +### GetIsSimulationEnabled + +`func (o *WorkflowLibraryAction) GetIsSimulationEnabled() bool` + +GetIsSimulationEnabled returns the IsSimulationEnabled field if non-nil, zero value otherwise. + +### GetIsSimulationEnabledOk + +`func (o *WorkflowLibraryAction) GetIsSimulationEnabledOk() (*bool, bool)` + +GetIsSimulationEnabledOk returns a tuple with the IsSimulationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSimulationEnabled + +`func (o *WorkflowLibraryAction) SetIsSimulationEnabled(v bool)` + +SetIsSimulationEnabled sets IsSimulationEnabled field to given value. + +### HasIsSimulationEnabled + +`func (o *WorkflowLibraryAction) HasIsSimulationEnabled() bool` + +HasIsSimulationEnabled returns a boolean if a field has been set. + +### GetIsDynamicSchema + +`func (o *WorkflowLibraryAction) GetIsDynamicSchema() bool` + +GetIsDynamicSchema returns the IsDynamicSchema field if non-nil, zero value otherwise. + +### GetIsDynamicSchemaOk + +`func (o *WorkflowLibraryAction) GetIsDynamicSchemaOk() (*bool, bool)` + +GetIsDynamicSchemaOk returns a tuple with the IsDynamicSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDynamicSchema + +`func (o *WorkflowLibraryAction) SetIsDynamicSchema(v bool)` + +SetIsDynamicSchema sets IsDynamicSchema field to given value. + +### HasIsDynamicSchema + +`func (o *WorkflowLibraryAction) HasIsDynamicSchema() bool` + +HasIsDynamicSchema returns a boolean if a field has been set. + +### GetOutputSchema + +`func (o *WorkflowLibraryAction) GetOutputSchema() map[string]interface{}` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *WorkflowLibraryAction) GetOutputSchemaOk() (*map[string]interface{}, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *WorkflowLibraryAction) SetOutputSchema(v map[string]interface{})` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *WorkflowLibraryAction) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkflowLibraryActionExampleOutput.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowLibraryActionExampleOutput.md new file mode 100644 index 000000000..906395f03 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowLibraryActionExampleOutput.md @@ -0,0 +1,38 @@ +--- +id: v2025-workflow-library-action-example-output +title: WorkflowLibraryActionExampleOutput +pagination_label: WorkflowLibraryActionExampleOutput +sidebar_label: WorkflowLibraryActionExampleOutput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryActionExampleOutput', 'V2025WorkflowLibraryActionExampleOutput'] +slug: /tools/sdk/go/v2025/models/workflow-library-action-example-output +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryActionExampleOutput', 'V2025WorkflowLibraryActionExampleOutput'] +--- + +# WorkflowLibraryActionExampleOutput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewWorkflowLibraryActionExampleOutput + +`func NewWorkflowLibraryActionExampleOutput() *WorkflowLibraryActionExampleOutput` + +NewWorkflowLibraryActionExampleOutput instantiates a new WorkflowLibraryActionExampleOutput 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 + +### NewWorkflowLibraryActionExampleOutputWithDefaults + +`func NewWorkflowLibraryActionExampleOutputWithDefaults() *WorkflowLibraryActionExampleOutput` + +NewWorkflowLibraryActionExampleOutputWithDefaults instantiates a new WorkflowLibraryActionExampleOutput 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 + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkflowLibraryFormFields.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowLibraryFormFields.md new file mode 100644 index 000000000..bc12e9fa1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowLibraryFormFields.md @@ -0,0 +1,204 @@ +--- +id: v2025-workflow-library-form-fields +title: WorkflowLibraryFormFields +pagination_label: WorkflowLibraryFormFields +sidebar_label: WorkflowLibraryFormFields +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryFormFields', 'V2025WorkflowLibraryFormFields'] +slug: /tools/sdk/go/v2025/models/workflow-library-form-fields +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryFormFields', 'V2025WorkflowLibraryFormFields'] +--- + +# WorkflowLibraryFormFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Description of the form field | [optional] +**HelpText** | Pointer to **string** | Describes the form field in the UI | [optional] +**Label** | Pointer to **string** | A human readable name for this form field in the UI | [optional] +**Name** | Pointer to **string** | The name of the input attribute | [optional] +**Required** | Pointer to **bool** | Denotes if this field is a required attribute | [optional] [default to false] +**Type** | Pointer to **NullableString** | The type of the form field | [optional] + +## Methods + +### NewWorkflowLibraryFormFields + +`func NewWorkflowLibraryFormFields() *WorkflowLibraryFormFields` + +NewWorkflowLibraryFormFields instantiates a new WorkflowLibraryFormFields 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 + +### NewWorkflowLibraryFormFieldsWithDefaults + +`func NewWorkflowLibraryFormFieldsWithDefaults() *WorkflowLibraryFormFields` + +NewWorkflowLibraryFormFieldsWithDefaults instantiates a new WorkflowLibraryFormFields 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 + +### GetDescription + +`func (o *WorkflowLibraryFormFields) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowLibraryFormFields) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowLibraryFormFields) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowLibraryFormFields) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetHelpText + +`func (o *WorkflowLibraryFormFields) GetHelpText() string` + +GetHelpText returns the HelpText field if non-nil, zero value otherwise. + +### GetHelpTextOk + +`func (o *WorkflowLibraryFormFields) GetHelpTextOk() (*string, bool)` + +GetHelpTextOk returns a tuple with the HelpText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHelpText + +`func (o *WorkflowLibraryFormFields) SetHelpText(v string)` + +SetHelpText sets HelpText field to given value. + +### HasHelpText + +`func (o *WorkflowLibraryFormFields) HasHelpText() bool` + +HasHelpText returns a boolean if a field has been set. + +### GetLabel + +`func (o *WorkflowLibraryFormFields) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *WorkflowLibraryFormFields) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *WorkflowLibraryFormFields) SetLabel(v string)` + +SetLabel sets Label field to given value. + +### HasLabel + +`func (o *WorkflowLibraryFormFields) HasLabel() bool` + +HasLabel returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowLibraryFormFields) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowLibraryFormFields) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowLibraryFormFields) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowLibraryFormFields) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetRequired + +`func (o *WorkflowLibraryFormFields) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *WorkflowLibraryFormFields) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *WorkflowLibraryFormFields) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *WorkflowLibraryFormFields) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + +### GetType + +`func (o *WorkflowLibraryFormFields) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowLibraryFormFields) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowLibraryFormFields) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowLibraryFormFields) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *WorkflowLibraryFormFields) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *WorkflowLibraryFormFields) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkflowLibraryOperator.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowLibraryOperator.md new file mode 100644 index 000000000..7569cf010 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowLibraryOperator.md @@ -0,0 +1,282 @@ +--- +id: v2025-workflow-library-operator +title: WorkflowLibraryOperator +pagination_label: WorkflowLibraryOperator +sidebar_label: WorkflowLibraryOperator +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryOperator', 'V2025WorkflowLibraryOperator'] +slug: /tools/sdk/go/v2025/models/workflow-library-operator +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryOperator', 'V2025WorkflowLibraryOperator'] +--- + +# WorkflowLibraryOperator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Operator ID. | [optional] +**Name** | Pointer to **string** | Operator friendly name | [optional] +**Type** | Pointer to **string** | Operator type | [optional] +**Description** | Pointer to **string** | Description of the operator | [optional] +**IsDynamicSchema** | Pointer to **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**Deprecated** | Pointer to **bool** | | [optional] +**DeprecatedBy** | Pointer to **SailPointTime** | | [optional] +**IsSimulationEnabled** | Pointer to **bool** | | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] + +## Methods + +### NewWorkflowLibraryOperator + +`func NewWorkflowLibraryOperator() *WorkflowLibraryOperator` + +NewWorkflowLibraryOperator instantiates a new WorkflowLibraryOperator 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 + +### NewWorkflowLibraryOperatorWithDefaults + +`func NewWorkflowLibraryOperatorWithDefaults() *WorkflowLibraryOperator` + +NewWorkflowLibraryOperatorWithDefaults instantiates a new WorkflowLibraryOperator 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 + +### GetId + +`func (o *WorkflowLibraryOperator) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowLibraryOperator) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowLibraryOperator) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowLibraryOperator) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowLibraryOperator) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowLibraryOperator) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowLibraryOperator) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowLibraryOperator) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *WorkflowLibraryOperator) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowLibraryOperator) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowLibraryOperator) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowLibraryOperator) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkflowLibraryOperator) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowLibraryOperator) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowLibraryOperator) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowLibraryOperator) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIsDynamicSchema + +`func (o *WorkflowLibraryOperator) GetIsDynamicSchema() bool` + +GetIsDynamicSchema returns the IsDynamicSchema field if non-nil, zero value otherwise. + +### GetIsDynamicSchemaOk + +`func (o *WorkflowLibraryOperator) GetIsDynamicSchemaOk() (*bool, bool)` + +GetIsDynamicSchemaOk returns a tuple with the IsDynamicSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDynamicSchema + +`func (o *WorkflowLibraryOperator) SetIsDynamicSchema(v bool)` + +SetIsDynamicSchema sets IsDynamicSchema field to given value. + +### HasIsDynamicSchema + +`func (o *WorkflowLibraryOperator) HasIsDynamicSchema() bool` + +HasIsDynamicSchema returns a boolean if a field has been set. + +### GetDeprecated + +`func (o *WorkflowLibraryOperator) GetDeprecated() bool` + +GetDeprecated returns the Deprecated field if non-nil, zero value otherwise. + +### GetDeprecatedOk + +`func (o *WorkflowLibraryOperator) GetDeprecatedOk() (*bool, bool)` + +GetDeprecatedOk returns a tuple with the Deprecated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecated + +`func (o *WorkflowLibraryOperator) SetDeprecated(v bool)` + +SetDeprecated sets Deprecated field to given value. + +### HasDeprecated + +`func (o *WorkflowLibraryOperator) HasDeprecated() bool` + +HasDeprecated returns a boolean if a field has been set. + +### GetDeprecatedBy + +`func (o *WorkflowLibraryOperator) GetDeprecatedBy() SailPointTime` + +GetDeprecatedBy returns the DeprecatedBy field if non-nil, zero value otherwise. + +### GetDeprecatedByOk + +`func (o *WorkflowLibraryOperator) GetDeprecatedByOk() (*SailPointTime, bool)` + +GetDeprecatedByOk returns a tuple with the DeprecatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecatedBy + +`func (o *WorkflowLibraryOperator) SetDeprecatedBy(v SailPointTime)` + +SetDeprecatedBy sets DeprecatedBy field to given value. + +### HasDeprecatedBy + +`func (o *WorkflowLibraryOperator) HasDeprecatedBy() bool` + +HasDeprecatedBy returns a boolean if a field has been set. + +### GetIsSimulationEnabled + +`func (o *WorkflowLibraryOperator) GetIsSimulationEnabled() bool` + +GetIsSimulationEnabled returns the IsSimulationEnabled field if non-nil, zero value otherwise. + +### GetIsSimulationEnabledOk + +`func (o *WorkflowLibraryOperator) GetIsSimulationEnabledOk() (*bool, bool)` + +GetIsSimulationEnabledOk returns a tuple with the IsSimulationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSimulationEnabled + +`func (o *WorkflowLibraryOperator) SetIsSimulationEnabled(v bool)` + +SetIsSimulationEnabled sets IsSimulationEnabled field to given value. + +### HasIsSimulationEnabled + +`func (o *WorkflowLibraryOperator) HasIsSimulationEnabled() bool` + +HasIsSimulationEnabled returns a boolean if a field has been set. + +### GetFormFields + +`func (o *WorkflowLibraryOperator) GetFormFields() []WorkflowLibraryFormFields` + +GetFormFields returns the FormFields field if non-nil, zero value otherwise. + +### GetFormFieldsOk + +`func (o *WorkflowLibraryOperator) GetFormFieldsOk() (*[]WorkflowLibraryFormFields, bool)` + +GetFormFieldsOk returns a tuple with the FormFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormFields + +`func (o *WorkflowLibraryOperator) SetFormFields(v []WorkflowLibraryFormFields)` + +SetFormFields sets FormFields field to given value. + +### HasFormFields + +`func (o *WorkflowLibraryOperator) HasFormFields() bool` + +HasFormFields returns a boolean if a field has been set. + +### SetFormFieldsNil + +`func (o *WorkflowLibraryOperator) SetFormFieldsNil(b bool)` + + SetFormFieldsNil sets the value for FormFields to be an explicit nil + +### UnsetFormFields +`func (o *WorkflowLibraryOperator) UnsetFormFields()` + +UnsetFormFields ensures that no value is present for FormFields, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkflowLibraryTrigger.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowLibraryTrigger.md new file mode 100644 index 000000000..32ba0d0c9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowLibraryTrigger.md @@ -0,0 +1,344 @@ +--- +id: v2025-workflow-library-trigger +title: WorkflowLibraryTrigger +pagination_label: WorkflowLibraryTrigger +sidebar_label: WorkflowLibraryTrigger +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryTrigger', 'V2025WorkflowLibraryTrigger'] +slug: /tools/sdk/go/v2025/models/workflow-library-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryTrigger', 'V2025WorkflowLibraryTrigger'] +--- + +# WorkflowLibraryTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Trigger ID. This is a static namespaced ID for the trigger. | [optional] +**Type** | Pointer to **string** | Trigger type | [optional] +**Deprecated** | Pointer to **bool** | | [optional] +**DeprecatedBy** | Pointer to **SailPointTime** | | [optional] +**IsSimulationEnabled** | Pointer to **bool** | | [optional] +**OutputSchema** | Pointer to **map[string]interface{}** | Example output schema | [optional] +**Name** | Pointer to **string** | Trigger Name | [optional] +**Description** | Pointer to **string** | Trigger Description | [optional] +**IsDynamicSchema** | Pointer to **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] [default to false] +**InputExample** | Pointer to **map[string]interface{}** | Example trigger payload if applicable | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the trigger accepts | [optional] + +## Methods + +### NewWorkflowLibraryTrigger + +`func NewWorkflowLibraryTrigger() *WorkflowLibraryTrigger` + +NewWorkflowLibraryTrigger instantiates a new WorkflowLibraryTrigger 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 + +### NewWorkflowLibraryTriggerWithDefaults + +`func NewWorkflowLibraryTriggerWithDefaults() *WorkflowLibraryTrigger` + +NewWorkflowLibraryTriggerWithDefaults instantiates a new WorkflowLibraryTrigger 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 + +### GetId + +`func (o *WorkflowLibraryTrigger) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowLibraryTrigger) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowLibraryTrigger) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowLibraryTrigger) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *WorkflowLibraryTrigger) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowLibraryTrigger) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowLibraryTrigger) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowLibraryTrigger) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDeprecated + +`func (o *WorkflowLibraryTrigger) GetDeprecated() bool` + +GetDeprecated returns the Deprecated field if non-nil, zero value otherwise. + +### GetDeprecatedOk + +`func (o *WorkflowLibraryTrigger) GetDeprecatedOk() (*bool, bool)` + +GetDeprecatedOk returns a tuple with the Deprecated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecated + +`func (o *WorkflowLibraryTrigger) SetDeprecated(v bool)` + +SetDeprecated sets Deprecated field to given value. + +### HasDeprecated + +`func (o *WorkflowLibraryTrigger) HasDeprecated() bool` + +HasDeprecated returns a boolean if a field has been set. + +### GetDeprecatedBy + +`func (o *WorkflowLibraryTrigger) GetDeprecatedBy() SailPointTime` + +GetDeprecatedBy returns the DeprecatedBy field if non-nil, zero value otherwise. + +### GetDeprecatedByOk + +`func (o *WorkflowLibraryTrigger) GetDeprecatedByOk() (*SailPointTime, bool)` + +GetDeprecatedByOk returns a tuple with the DeprecatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecatedBy + +`func (o *WorkflowLibraryTrigger) SetDeprecatedBy(v SailPointTime)` + +SetDeprecatedBy sets DeprecatedBy field to given value. + +### HasDeprecatedBy + +`func (o *WorkflowLibraryTrigger) HasDeprecatedBy() bool` + +HasDeprecatedBy returns a boolean if a field has been set. + +### GetIsSimulationEnabled + +`func (o *WorkflowLibraryTrigger) GetIsSimulationEnabled() bool` + +GetIsSimulationEnabled returns the IsSimulationEnabled field if non-nil, zero value otherwise. + +### GetIsSimulationEnabledOk + +`func (o *WorkflowLibraryTrigger) GetIsSimulationEnabledOk() (*bool, bool)` + +GetIsSimulationEnabledOk returns a tuple with the IsSimulationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSimulationEnabled + +`func (o *WorkflowLibraryTrigger) SetIsSimulationEnabled(v bool)` + +SetIsSimulationEnabled sets IsSimulationEnabled field to given value. + +### HasIsSimulationEnabled + +`func (o *WorkflowLibraryTrigger) HasIsSimulationEnabled() bool` + +HasIsSimulationEnabled returns a boolean if a field has been set. + +### GetOutputSchema + +`func (o *WorkflowLibraryTrigger) GetOutputSchema() map[string]interface{}` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *WorkflowLibraryTrigger) GetOutputSchemaOk() (*map[string]interface{}, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *WorkflowLibraryTrigger) SetOutputSchema(v map[string]interface{})` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *WorkflowLibraryTrigger) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowLibraryTrigger) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowLibraryTrigger) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowLibraryTrigger) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowLibraryTrigger) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkflowLibraryTrigger) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowLibraryTrigger) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowLibraryTrigger) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowLibraryTrigger) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIsDynamicSchema + +`func (o *WorkflowLibraryTrigger) GetIsDynamicSchema() bool` + +GetIsDynamicSchema returns the IsDynamicSchema field if non-nil, zero value otherwise. + +### GetIsDynamicSchemaOk + +`func (o *WorkflowLibraryTrigger) GetIsDynamicSchemaOk() (*bool, bool)` + +GetIsDynamicSchemaOk returns a tuple with the IsDynamicSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDynamicSchema + +`func (o *WorkflowLibraryTrigger) SetIsDynamicSchema(v bool)` + +SetIsDynamicSchema sets IsDynamicSchema field to given value. + +### HasIsDynamicSchema + +`func (o *WorkflowLibraryTrigger) HasIsDynamicSchema() bool` + +HasIsDynamicSchema returns a boolean if a field has been set. + +### GetInputExample + +`func (o *WorkflowLibraryTrigger) GetInputExample() map[string]interface{}` + +GetInputExample returns the InputExample field if non-nil, zero value otherwise. + +### GetInputExampleOk + +`func (o *WorkflowLibraryTrigger) GetInputExampleOk() (*map[string]interface{}, bool)` + +GetInputExampleOk returns a tuple with the InputExample field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInputExample + +`func (o *WorkflowLibraryTrigger) SetInputExample(v map[string]interface{})` + +SetInputExample sets InputExample field to given value. + +### HasInputExample + +`func (o *WorkflowLibraryTrigger) HasInputExample() bool` + +HasInputExample returns a boolean if a field has been set. + +### SetInputExampleNil + +`func (o *WorkflowLibraryTrigger) SetInputExampleNil(b bool)` + + SetInputExampleNil sets the value for InputExample to be an explicit nil + +### UnsetInputExample +`func (o *WorkflowLibraryTrigger) UnsetInputExample()` + +UnsetInputExample ensures that no value is present for InputExample, not even an explicit nil +### GetFormFields + +`func (o *WorkflowLibraryTrigger) GetFormFields() []WorkflowLibraryFormFields` + +GetFormFields returns the FormFields field if non-nil, zero value otherwise. + +### GetFormFieldsOk + +`func (o *WorkflowLibraryTrigger) GetFormFieldsOk() (*[]WorkflowLibraryFormFields, bool)` + +GetFormFieldsOk returns a tuple with the FormFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormFields + +`func (o *WorkflowLibraryTrigger) SetFormFields(v []WorkflowLibraryFormFields)` + +SetFormFields sets FormFields field to given value. + +### HasFormFields + +`func (o *WorkflowLibraryTrigger) HasFormFields() bool` + +HasFormFields returns a boolean if a field has been set. + +### SetFormFieldsNil + +`func (o *WorkflowLibraryTrigger) SetFormFieldsNil(b bool)` + + SetFormFieldsNil sets the value for FormFields to be an explicit nil + +### UnsetFormFields +`func (o *WorkflowLibraryTrigger) UnsetFormFields()` + +UnsetFormFields ensures that no value is present for FormFields, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkflowModifiedBy.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowModifiedBy.md new file mode 100644 index 000000000..d01eae041 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowModifiedBy.md @@ -0,0 +1,116 @@ +--- +id: v2025-workflow-modified-by +title: WorkflowModifiedBy +pagination_label: WorkflowModifiedBy +sidebar_label: WorkflowModifiedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowModifiedBy', 'V2025WorkflowModifiedBy'] +slug: /tools/sdk/go/v2025/models/workflow-modified-by +tags: ['SDK', 'Software Development Kit', 'WorkflowModifiedBy', 'V2025WorkflowModifiedBy'] +--- + +# WorkflowModifiedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | | [optional] +**Id** | Pointer to **string** | Identity ID | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity. | [optional] + +## Methods + +### NewWorkflowModifiedBy + +`func NewWorkflowModifiedBy() *WorkflowModifiedBy` + +NewWorkflowModifiedBy instantiates a new WorkflowModifiedBy 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 + +### NewWorkflowModifiedByWithDefaults + +`func NewWorkflowModifiedByWithDefaults() *WorkflowModifiedBy` + +NewWorkflowModifiedByWithDefaults instantiates a new WorkflowModifiedBy 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 + +### GetType + +`func (o *WorkflowModifiedBy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowModifiedBy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowModifiedBy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowModifiedBy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkflowModifiedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowModifiedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowModifiedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowModifiedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowModifiedBy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowModifiedBy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowModifiedBy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowModifiedBy) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkflowOAuthClient.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowOAuthClient.md new file mode 100644 index 000000000..31a2f6ab7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowOAuthClient.md @@ -0,0 +1,116 @@ +--- +id: v2025-workflow-o-auth-client +title: WorkflowOAuthClient +pagination_label: WorkflowOAuthClient +sidebar_label: WorkflowOAuthClient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowOAuthClient', 'V2025WorkflowOAuthClient'] +slug: /tools/sdk/go/v2025/models/workflow-o-auth-client +tags: ['SDK', 'Software Development Kit', 'WorkflowOAuthClient', 'V2025WorkflowOAuthClient'] +--- + +# WorkflowOAuthClient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | OAuth client ID for the trigger. This is a UUID generated upon creation. | [optional] +**Secret** | Pointer to **string** | OAuthClient secret. | [optional] +**Url** | Pointer to **string** | URL for the external trigger to invoke | [optional] + +## Methods + +### NewWorkflowOAuthClient + +`func NewWorkflowOAuthClient() *WorkflowOAuthClient` + +NewWorkflowOAuthClient instantiates a new WorkflowOAuthClient 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 + +### NewWorkflowOAuthClientWithDefaults + +`func NewWorkflowOAuthClientWithDefaults() *WorkflowOAuthClient` + +NewWorkflowOAuthClientWithDefaults instantiates a new WorkflowOAuthClient 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 + +### GetId + +`func (o *WorkflowOAuthClient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowOAuthClient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowOAuthClient) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowOAuthClient) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSecret + +`func (o *WorkflowOAuthClient) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *WorkflowOAuthClient) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *WorkflowOAuthClient) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *WorkflowOAuthClient) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### GetUrl + +`func (o *WorkflowOAuthClient) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *WorkflowOAuthClient) GetUrlOk() (*string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrl + +`func (o *WorkflowOAuthClient) SetUrl(v string)` + +SetUrl sets Url field to given value. + +### HasUrl + +`func (o *WorkflowOAuthClient) HasUrl() bool` + +HasUrl returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkflowTrigger.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowTrigger.md new file mode 100644 index 000000000..a03b5d42b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkflowTrigger.md @@ -0,0 +1,126 @@ +--- +id: v2025-workflow-trigger +title: WorkflowTrigger +pagination_label: WorkflowTrigger +sidebar_label: WorkflowTrigger +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowTrigger', 'V2025WorkflowTrigger'] +slug: /tools/sdk/go/v2025/models/workflow-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowTrigger', 'V2025WorkflowTrigger'] +--- + +# WorkflowTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The trigger type | +**DisplayName** | Pointer to **NullableString** | | [optional] +**Attributes** | **map[string]interface{}** | Workflow Trigger Attributes. | + +## Methods + +### NewWorkflowTrigger + +`func NewWorkflowTrigger(type_ string, attributes map[string]interface{}, ) *WorkflowTrigger` + +NewWorkflowTrigger instantiates a new WorkflowTrigger 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 + +### NewWorkflowTriggerWithDefaults + +`func NewWorkflowTriggerWithDefaults() *WorkflowTrigger` + +NewWorkflowTriggerWithDefaults instantiates a new WorkflowTrigger 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 + +### GetType + +`func (o *WorkflowTrigger) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowTrigger) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowTrigger) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDisplayName + +`func (o *WorkflowTrigger) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *WorkflowTrigger) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *WorkflowTrigger) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *WorkflowTrigger) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### SetDisplayNameNil + +`func (o *WorkflowTrigger) SetDisplayNameNil(b bool)` + + SetDisplayNameNil sets the value for DisplayName to be an explicit nil + +### UnsetDisplayName +`func (o *WorkflowTrigger) UnsetDisplayName()` + +UnsetDisplayName ensures that no value is present for DisplayName, not even an explicit nil +### GetAttributes + +`func (o *WorkflowTrigger) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *WorkflowTrigger) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *WorkflowTrigger) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *WorkflowTrigger) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *WorkflowTrigger) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupBulkDeleteRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupBulkDeleteRequest.md new file mode 100644 index 000000000..4e281306a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupBulkDeleteRequest.md @@ -0,0 +1,64 @@ +--- +id: v2025-workgroup-bulk-delete-request +title: WorkgroupBulkDeleteRequest +pagination_label: WorkgroupBulkDeleteRequest +sidebar_label: WorkgroupBulkDeleteRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupBulkDeleteRequest', 'V2025WorkgroupBulkDeleteRequest'] +slug: /tools/sdk/go/v2025/models/workgroup-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'WorkgroupBulkDeleteRequest', 'V2025WorkgroupBulkDeleteRequest'] +--- + +# WorkgroupBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]string** | List of IDs of Governance Groups to be deleted. | [optional] + +## Methods + +### NewWorkgroupBulkDeleteRequest + +`func NewWorkgroupBulkDeleteRequest() *WorkgroupBulkDeleteRequest` + +NewWorkgroupBulkDeleteRequest instantiates a new WorkgroupBulkDeleteRequest 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 + +### NewWorkgroupBulkDeleteRequestWithDefaults + +`func NewWorkgroupBulkDeleteRequestWithDefaults() *WorkgroupBulkDeleteRequest` + +NewWorkgroupBulkDeleteRequestWithDefaults instantiates a new WorkgroupBulkDeleteRequest 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 + +### GetIds + +`func (o *WorkgroupBulkDeleteRequest) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *WorkgroupBulkDeleteRequest) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *WorkgroupBulkDeleteRequest) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *WorkgroupBulkDeleteRequest) HasIds() bool` + +HasIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupConnectionDto.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupConnectionDto.md new file mode 100644 index 000000000..4d88fa88b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupConnectionDto.md @@ -0,0 +1,90 @@ +--- +id: v2025-workgroup-connection-dto +title: WorkgroupConnectionDto +pagination_label: WorkgroupConnectionDto +sidebar_label: WorkgroupConnectionDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupConnectionDto', 'V2025WorkgroupConnectionDto'] +slug: /tools/sdk/go/v2025/models/workgroup-connection-dto +tags: ['SDK', 'Software Development Kit', 'WorkgroupConnectionDto', 'V2025WorkgroupConnectionDto'] +--- + +# WorkgroupConnectionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Object** | Pointer to [**WorkgroupConnectionDtoObject**](workgroup-connection-dto-object) | | [optional] +**ConnectionType** | Pointer to **string** | Connection Type. | [optional] + +## Methods + +### NewWorkgroupConnectionDto + +`func NewWorkgroupConnectionDto() *WorkgroupConnectionDto` + +NewWorkgroupConnectionDto instantiates a new WorkgroupConnectionDto 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 + +### NewWorkgroupConnectionDtoWithDefaults + +`func NewWorkgroupConnectionDtoWithDefaults() *WorkgroupConnectionDto` + +NewWorkgroupConnectionDtoWithDefaults instantiates a new WorkgroupConnectionDto 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 + +### GetObject + +`func (o *WorkgroupConnectionDto) GetObject() WorkgroupConnectionDtoObject` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *WorkgroupConnectionDto) GetObjectOk() (*WorkgroupConnectionDtoObject, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *WorkgroupConnectionDto) SetObject(v WorkgroupConnectionDtoObject)` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *WorkgroupConnectionDto) HasObject() bool` + +HasObject returns a boolean if a field has been set. + +### GetConnectionType + +`func (o *WorkgroupConnectionDto) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *WorkgroupConnectionDto) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *WorkgroupConnectionDto) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *WorkgroupConnectionDto) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupConnectionDtoObject.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupConnectionDtoObject.md new file mode 100644 index 000000000..ffcd6379e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupConnectionDtoObject.md @@ -0,0 +1,152 @@ +--- +id: v2025-workgroup-connection-dto-object +title: WorkgroupConnectionDtoObject +pagination_label: WorkgroupConnectionDtoObject +sidebar_label: WorkgroupConnectionDtoObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupConnectionDtoObject', 'V2025WorkgroupConnectionDtoObject'] +slug: /tools/sdk/go/v2025/models/workgroup-connection-dto-object +tags: ['SDK', 'Software Development Kit', 'WorkgroupConnectionDtoObject', 'V2025WorkgroupConnectionDtoObject'] +--- + +# WorkgroupConnectionDtoObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**ConnectedObjectType**](connected-object-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable name of Connected object | [optional] +**Description** | Pointer to **NullableString** | Description of the Connected object. | [optional] + +## Methods + +### NewWorkgroupConnectionDtoObject + +`func NewWorkgroupConnectionDtoObject() *WorkgroupConnectionDtoObject` + +NewWorkgroupConnectionDtoObject instantiates a new WorkgroupConnectionDtoObject 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 + +### NewWorkgroupConnectionDtoObjectWithDefaults + +`func NewWorkgroupConnectionDtoObjectWithDefaults() *WorkgroupConnectionDtoObject` + +NewWorkgroupConnectionDtoObjectWithDefaults instantiates a new WorkgroupConnectionDtoObject 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 + +### GetType + +`func (o *WorkgroupConnectionDtoObject) GetType() ConnectedObjectType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkgroupConnectionDtoObject) GetTypeOk() (*ConnectedObjectType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkgroupConnectionDtoObject) SetType(v ConnectedObjectType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkgroupConnectionDtoObject) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkgroupConnectionDtoObject) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupConnectionDtoObject) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupConnectionDtoObject) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkgroupConnectionDtoObject) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkgroupConnectionDtoObject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkgroupConnectionDtoObject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkgroupConnectionDtoObject) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkgroupConnectionDtoObject) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkgroupConnectionDtoObject) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkgroupConnectionDtoObject) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkgroupConnectionDtoObject) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkgroupConnectionDtoObject) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *WorkgroupConnectionDtoObject) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *WorkgroupConnectionDtoObject) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupDeleteItem.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupDeleteItem.md new file mode 100644 index 000000000..fe1a35922 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupDeleteItem.md @@ -0,0 +1,106 @@ +--- +id: v2025-workgroup-delete-item +title: WorkgroupDeleteItem +pagination_label: WorkgroupDeleteItem +sidebar_label: WorkgroupDeleteItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupDeleteItem', 'V2025WorkgroupDeleteItem'] +slug: /tools/sdk/go/v2025/models/workgroup-delete-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupDeleteItem', 'V2025WorkgroupDeleteItem'] +--- + +# WorkgroupDeleteItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Id of the Governance Group. | +**Status** | **int32** | The HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation. > 204 - Governance Group deleted successfully. > 409 - Governance Group is in use,hence can not be deleted. > 404 - Governance Group not found. | +**Description** | Pointer to **string** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Methods + +### NewWorkgroupDeleteItem + +`func NewWorkgroupDeleteItem(id string, status int32, ) *WorkgroupDeleteItem` + +NewWorkgroupDeleteItem instantiates a new WorkgroupDeleteItem 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 + +### NewWorkgroupDeleteItemWithDefaults + +`func NewWorkgroupDeleteItemWithDefaults() *WorkgroupDeleteItem` + +NewWorkgroupDeleteItemWithDefaults instantiates a new WorkgroupDeleteItem 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 + +### GetId + +`func (o *WorkgroupDeleteItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupDeleteItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupDeleteItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetStatus + +`func (o *WorkgroupDeleteItem) GetStatus() int32` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *WorkgroupDeleteItem) GetStatusOk() (*int32, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *WorkgroupDeleteItem) SetStatus(v int32)` + +SetStatus sets Status field to given value. + + +### GetDescription + +`func (o *WorkgroupDeleteItem) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkgroupDeleteItem) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkgroupDeleteItem) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkgroupDeleteItem) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupDto.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupDto.md new file mode 100644 index 000000000..80e9cf245 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupDto.md @@ -0,0 +1,246 @@ +--- +id: v2025-workgroup-dto +title: WorkgroupDto +pagination_label: WorkgroupDto +sidebar_label: WorkgroupDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupDto', 'V2025WorkgroupDto'] +slug: /tools/sdk/go/v2025/models/workgroup-dto +tags: ['SDK', 'Software Development Kit', 'WorkgroupDto', 'V2025WorkgroupDto'] +--- + +# WorkgroupDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Owner** | Pointer to [**WorkgroupDtoOwner**](workgroup-dto-owner) | | [optional] +**Id** | Pointer to **string** | Governance group ID. | [optional] [readonly] +**Name** | Pointer to **string** | Governance group name. | [optional] +**Description** | Pointer to **string** | Governance group description. | [optional] +**MemberCount** | Pointer to **int64** | Number of members in the governance group. | [optional] [readonly] +**ConnectionCount** | Pointer to **int64** | Number of connections in the governance group. | [optional] [readonly] +**Created** | Pointer to **SailPointTime** | | [optional] +**Modified** | Pointer to **SailPointTime** | | [optional] + +## Methods + +### NewWorkgroupDto + +`func NewWorkgroupDto() *WorkgroupDto` + +NewWorkgroupDto instantiates a new WorkgroupDto 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 + +### NewWorkgroupDtoWithDefaults + +`func NewWorkgroupDtoWithDefaults() *WorkgroupDto` + +NewWorkgroupDtoWithDefaults instantiates a new WorkgroupDto 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 + +### GetOwner + +`func (o *WorkgroupDto) GetOwner() WorkgroupDtoOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *WorkgroupDto) GetOwnerOk() (*WorkgroupDtoOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *WorkgroupDto) SetOwner(v WorkgroupDtoOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *WorkgroupDto) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetId + +`func (o *WorkgroupDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkgroupDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkgroupDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkgroupDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkgroupDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkgroupDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkgroupDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkgroupDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkgroupDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkgroupDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetMemberCount + +`func (o *WorkgroupDto) GetMemberCount() int64` + +GetMemberCount returns the MemberCount field if non-nil, zero value otherwise. + +### GetMemberCountOk + +`func (o *WorkgroupDto) GetMemberCountOk() (*int64, bool)` + +GetMemberCountOk returns a tuple with the MemberCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMemberCount + +`func (o *WorkgroupDto) SetMemberCount(v int64)` + +SetMemberCount sets MemberCount field to given value. + +### HasMemberCount + +`func (o *WorkgroupDto) HasMemberCount() bool` + +HasMemberCount returns a boolean if a field has been set. + +### GetConnectionCount + +`func (o *WorkgroupDto) GetConnectionCount() int64` + +GetConnectionCount returns the ConnectionCount field if non-nil, zero value otherwise. + +### GetConnectionCountOk + +`func (o *WorkgroupDto) GetConnectionCountOk() (*int64, bool)` + +GetConnectionCountOk returns a tuple with the ConnectionCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionCount + +`func (o *WorkgroupDto) SetConnectionCount(v int64)` + +SetConnectionCount sets ConnectionCount field to given value. + +### HasConnectionCount + +`func (o *WorkgroupDto) HasConnectionCount() bool` + +HasConnectionCount returns a boolean if a field has been set. + +### GetCreated + +`func (o *WorkgroupDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *WorkgroupDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *WorkgroupDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *WorkgroupDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *WorkgroupDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *WorkgroupDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *WorkgroupDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *WorkgroupDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupDtoOwner.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupDtoOwner.md new file mode 100644 index 000000000..2cf7a7eb5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupDtoOwner.md @@ -0,0 +1,168 @@ +--- +id: v2025-workgroup-dto-owner +title: WorkgroupDtoOwner +pagination_label: WorkgroupDtoOwner +sidebar_label: WorkgroupDtoOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupDtoOwner', 'V2025WorkgroupDtoOwner'] +slug: /tools/sdk/go/v2025/models/workgroup-dto-owner +tags: ['SDK', 'Software Development Kit', 'WorkgroupDtoOwner', 'V2025WorkgroupDtoOwner'] +--- + +# WorkgroupDtoOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's DTO type. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] +**DisplayName** | Pointer to **string** | The display name of the identity | [optional] [readonly] +**EmailAddress** | Pointer to **string** | The primary email address of the identity | [optional] [readonly] + +## Methods + +### NewWorkgroupDtoOwner + +`func NewWorkgroupDtoOwner() *WorkgroupDtoOwner` + +NewWorkgroupDtoOwner instantiates a new WorkgroupDtoOwner 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 + +### NewWorkgroupDtoOwnerWithDefaults + +`func NewWorkgroupDtoOwnerWithDefaults() *WorkgroupDtoOwner` + +NewWorkgroupDtoOwnerWithDefaults instantiates a new WorkgroupDtoOwner 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 + +### GetType + +`func (o *WorkgroupDtoOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkgroupDtoOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkgroupDtoOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkgroupDtoOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkgroupDtoOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupDtoOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupDtoOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkgroupDtoOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkgroupDtoOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkgroupDtoOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkgroupDtoOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkgroupDtoOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *WorkgroupDtoOwner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *WorkgroupDtoOwner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *WorkgroupDtoOwner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *WorkgroupDtoOwner) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetEmailAddress + +`func (o *WorkgroupDtoOwner) GetEmailAddress() string` + +GetEmailAddress returns the EmailAddress field if non-nil, zero value otherwise. + +### GetEmailAddressOk + +`func (o *WorkgroupDtoOwner) GetEmailAddressOk() (*string, bool)` + +GetEmailAddressOk returns a tuple with the EmailAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailAddress + +`func (o *WorkgroupDtoOwner) SetEmailAddress(v string)` + +SetEmailAddress sets EmailAddress field to given value. + +### HasEmailAddress + +`func (o *WorkgroupDtoOwner) HasEmailAddress() bool` + +HasEmailAddress returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupMemberAddItem.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupMemberAddItem.md new file mode 100644 index 000000000..687c8644c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupMemberAddItem.md @@ -0,0 +1,106 @@ +--- +id: v2025-workgroup-member-add-item +title: WorkgroupMemberAddItem +pagination_label: WorkgroupMemberAddItem +sidebar_label: WorkgroupMemberAddItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupMemberAddItem', 'V2025WorkgroupMemberAddItem'] +slug: /tools/sdk/go/v2025/models/workgroup-member-add-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupMemberAddItem', 'V2025WorkgroupMemberAddItem'] +--- + +# WorkgroupMemberAddItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Identifier of identity in bulk member add request. | +**Status** | **int32** | The HTTP response status code returned for an individual member that is requested for addition during a bulk add operation. The HTTP response status code returned for an individual Governance Group is requested for deletion. > 201 - Identity is added into Governance Group members list. > 409 - Identity is already member of Governance Group. | +**Description** | Pointer to **string** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Methods + +### NewWorkgroupMemberAddItem + +`func NewWorkgroupMemberAddItem(id string, status int32, ) *WorkgroupMemberAddItem` + +NewWorkgroupMemberAddItem instantiates a new WorkgroupMemberAddItem 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 + +### NewWorkgroupMemberAddItemWithDefaults + +`func NewWorkgroupMemberAddItemWithDefaults() *WorkgroupMemberAddItem` + +NewWorkgroupMemberAddItemWithDefaults instantiates a new WorkgroupMemberAddItem 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 + +### GetId + +`func (o *WorkgroupMemberAddItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupMemberAddItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupMemberAddItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetStatus + +`func (o *WorkgroupMemberAddItem) GetStatus() int32` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *WorkgroupMemberAddItem) GetStatusOk() (*int32, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *WorkgroupMemberAddItem) SetStatus(v int32)` + +SetStatus sets Status field to given value. + + +### GetDescription + +`func (o *WorkgroupMemberAddItem) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkgroupMemberAddItem) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkgroupMemberAddItem) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkgroupMemberAddItem) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupMemberDeleteItem.md b/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupMemberDeleteItem.md new file mode 100644 index 000000000..b415b4a9f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/WorkgroupMemberDeleteItem.md @@ -0,0 +1,106 @@ +--- +id: v2025-workgroup-member-delete-item +title: WorkgroupMemberDeleteItem +pagination_label: WorkgroupMemberDeleteItem +sidebar_label: WorkgroupMemberDeleteItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkgroupMemberDeleteItem', 'V2025WorkgroupMemberDeleteItem'] +slug: /tools/sdk/go/v2025/models/workgroup-member-delete-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupMemberDeleteItem', 'V2025WorkgroupMemberDeleteItem'] +--- + +# WorkgroupMemberDeleteItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Identifier of identity in bulk member add /remove request. | +**Status** | **int32** | The HTTP response status code returned for an individual member that is requested for deletion during a bulk delete operation. > 204 - Identity is removed from Governance Group members list. > 404 - Identity is not member of Governance Group. | +**Description** | Pointer to **string** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Methods + +### NewWorkgroupMemberDeleteItem + +`func NewWorkgroupMemberDeleteItem(id string, status int32, ) *WorkgroupMemberDeleteItem` + +NewWorkgroupMemberDeleteItem instantiates a new WorkgroupMemberDeleteItem 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 + +### NewWorkgroupMemberDeleteItemWithDefaults + +`func NewWorkgroupMemberDeleteItemWithDefaults() *WorkgroupMemberDeleteItem` + +NewWorkgroupMemberDeleteItemWithDefaults instantiates a new WorkgroupMemberDeleteItem 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 + +### GetId + +`func (o *WorkgroupMemberDeleteItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkgroupMemberDeleteItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkgroupMemberDeleteItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetStatus + +`func (o *WorkgroupMemberDeleteItem) GetStatus() int32` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *WorkgroupMemberDeleteItem) GetStatusOk() (*int32, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *WorkgroupMemberDeleteItem) SetStatus(v int32)` + +SetStatus sets Status field to given value. + + +### GetDescription + +`func (o *WorkgroupMemberDeleteItem) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkgroupMemberDeleteItem) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkgroupMemberDeleteItem) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkgroupMemberDeleteItem) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Index.md b/docs/tools/sdk/go/Reference/V3/Index.md new file mode 100644 index 000000000..685658f3d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Index.md @@ -0,0 +1,21 @@ +--- +id: v3 +title: V3 +pagination_label: V3 +sidebar_label: V3 +sidebar_position: 2 +sidebar_class_name: v3 +keywords: ['v3', 'Golang'] +description: Golang SDK reference V3. +slug: /tools/go/reference/v3 +tags: ['v3'] +--- + +Welcome to the Golang SDK documentation for the Identity Security Cloud (ISC) V3 API. This reference guide provides an overview of both methods and models, which will help you understand how to interact with the API effectively. + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/docs/tools/sdk/go/Reference/V3/Methods/AccessProfilesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/AccessProfilesAPI.md new file mode 100644 index 000000000..cece978ca --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/AccessProfilesAPI.md @@ -0,0 +1,683 @@ +--- +id: access-profiles +title: AccessProfiles +pagination_label: AccessProfiles +sidebar_label: AccessProfiles +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfiles', 'AccessProfiles'] +slug: /tools/sdk/go/v3/methods/access-profiles +tags: ['SDK', 'Software Development Kit', 'AccessProfiles', 'AccessProfiles'] +--- + +# AccessProfilesAPI + Use this API to implement and customize access profile functionality. +With this functionality in place, administrators can create access profiles and configure them for use throughout Identity Security Cloud, enabling users to get the access they need quickly and securely. + +Access profiles group entitlements, which represent access rights on sources. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +Identity Security Cloud uses access profiles in many features, including the following: + +- Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles. + +- Certifications: You can approve or revoke access profiles in certification campaigns, just like entitlements. + +- Access Requests: You can assign access profiles to applications, and when a user requests access to the app associated with an access profile and someone approves the request, access is granted to both the application and its associated access profile. + +- Roles: You can group one or more access profiles into a role to quickly assign access items based on an identity's role. + +In Identity Security Cloud, administrators can use the Access drop-down menu and select Access Profiles to view, configure, and delete existing access profiles, as well as create new ones. +Administrators can enable and disable an access profile, and they can also make the following configurations: + +- Manage Entitlements: Manage the profile's access by adding and removing entitlements. + +- Access Requests: Configure access profiles to be requestable and establish an approval process for any requests that the access profile be granted or revoked. +Do not configure an access profile to be requestable without first establishing a secure access request approval process for the access profile. + +- Multiple Account Options: Define the logic Identity Security Cloud uses to provision access to an identity with multiple accounts on the source. + +Refer to [Managing Access Profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) for more information about access profiles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-access-profile**](#create-access-profile) | **Post** `/access-profiles` | Create Access Profile +[**delete-access-profile**](#delete-access-profile) | **Delete** `/access-profiles/{id}` | Delete the specified Access Profile +[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **Post** `/access-profiles/bulk-delete` | Delete Access Profile(s) +[**get-access-profile**](#get-access-profile) | **Get** `/access-profiles/{id}` | Get an Access Profile +[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **Get** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements +[**list-access-profiles**](#list-access-profiles) | **Get** `/access-profiles` | List Access Profiles +[**patch-access-profile**](#patch-access-profile) | **Patch** `/access-profiles/{id}` | Patch a specified Access Profile + + +## create-access-profile +Create Access Profile +Create an access profile. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-profile) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAccessProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessProfile** | [**AccessProfile**](../models/access-profile) | | + +### Return type + +[**AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accessprofile := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + }`) // AccessProfile | + + + var accessProfile v3.AccessProfile + if err := json.Unmarshal(accessprofile, &accessProfile); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessProfilesAPI.CreateAccessProfile(context.Background()).AccessProfile(accessProfile).Execute() + //resp, r, err := apiClient.V3.AccessProfilesAPI.CreateAccessProfile(context.Background()).AccessProfile(accessProfile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.CreateAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.CreateAccessProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-access-profile +Delete the specified Access Profile +This API deletes an existing Access Profile. + +The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. + +A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-access-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Access Profile to delete | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccessProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Access Profile to delete # string | ID of the Access Profile to delete + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.AccessProfilesAPI.DeleteAccessProfile(context.Background(), id).Execute() + //r, err := apiClient.V3.AccessProfilesAPI.DeleteAccessProfile(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.DeleteAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-access-profiles-in-bulk +Delete Access Profile(s) +This endpoint initiates a bulk deletion of one or more access profiles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 access profiles per request. +By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. +A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they're able to administer. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-access-profiles-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccessProfilesInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessProfileBulkDeleteRequest** | [**AccessProfileBulkDeleteRequest**](../models/access-profile-bulk-delete-request) | | + +### Return type + +[**AccessProfileBulkDeleteResponse**](../models/access-profile-bulk-delete-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accessprofilebulkdeleterequest := []byte(`{ + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + }`) // AccessProfileBulkDeleteRequest | + + + var accessProfileBulkDeleteRequest v3.AccessProfileBulkDeleteRequest + if err := json.Unmarshal(accessprofilebulkdeleterequest, &accessProfileBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessProfilesAPI.DeleteAccessProfilesInBulk(context.Background()).AccessProfileBulkDeleteRequest(accessProfileBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V3.AccessProfilesAPI.DeleteAccessProfilesInBulk(context.Background()).AccessProfileBulkDeleteRequest(accessProfileBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.DeleteAccessProfilesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccessProfilesInBulk`: AccessProfileBulkDeleteResponse + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.DeleteAccessProfilesInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-profile +Get an Access Profile +This API returns an Access Profile by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Access Profile | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Access Profile # string | ID of the Access Profile + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessProfilesAPI.GetAccessProfile(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.AccessProfilesAPI.GetAccessProfile(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.GetAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.GetAccessProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-profile-entitlements +List Access Profile's Entitlements +Use this API to get a list of an access profile's entitlements. +A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-profile-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the access profile containing the entitlements. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessProfileEntitlementsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. | + **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, attribute, value, created, modified** | + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the access profile containing the entitlements. # string | ID of the access profile containing the entitlements. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessProfilesAPI.GetAccessProfileEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.AccessProfilesAPI.GetAccessProfileEntitlements(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.GetAccessProfileEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessProfileEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.GetAccessProfileEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-profiles +List Access Profiles +Get a list of access profiles. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-access-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessProfilesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **forSubadmin** | **string** | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. | + **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, created, modified** | + **forSegmentIds** | **string** | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. | + **includeUnsegmented** | **bool** | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. | [default to true] + +### Return type + +[**[]AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + forSubadmin := `8c190e6787aa4ed9a90bd9d5344523fb` // string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) # string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "SailPoint Support"` // 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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessProfilesAPI.ListAccessProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V3.AccessProfilesAPI.ListAccessProfiles(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.ListAccessProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessProfiles`: []AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.ListAccessProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-access-profile +Patch a specified Access Profile +This API updates an existing Access Profile. The following fields are patchable: + +**name** + +**description** + +**enabled** + +**owner** + +**requestable** + +**accessRequestConfig** + +**revokeRequestConfig** + +**segments** + +**entitlements** + +**provisioningCriteria** + +**source** (must be updated with entitlements belonging to new source in the same API call) + +If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example "Replace Source" in the examples dropdown. + +A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. +> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-access-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Access Profile to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAccessProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**AccessProfile**](../models/access-profile) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Access Profile to patch # string | ID of the Access Profile to patch + jsonpatchoperation := []byte(`[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessProfilesAPI.PatchAccessProfile(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.AccessProfilesAPI.PatchAccessProfile(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.PatchAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.PatchAccessProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/AccessRequestApprovalsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/AccessRequestApprovalsAPI.md new file mode 100644 index 000000000..38e1e6c70 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/AccessRequestApprovalsAPI.md @@ -0,0 +1,485 @@ +--- +id: access-request-approvals +title: AccessRequestApprovals +pagination_label: AccessRequestApprovals +sidebar_label: AccessRequestApprovals +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestApprovals', 'AccessRequestApprovals'] +slug: /tools/sdk/go/v3/methods/access-request-approvals +tags: ['SDK', 'Software Development Kit', 'AccessRequestApprovals', 'AccessRequestApprovals'] +--- + +# AccessRequestApprovalsAPI + Use this API to implement and customize access request approval functionality. +With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. +This enables more qualified users to review access requests and the others to spend their time on other tasks. + +In Identity Security Cloud, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. +For applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. +For roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. +If the administrator designates a governance group as the required approver, any governance group member can approve the requests. + +When a user submits an access request, Identity Security Cloud sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration. + +In Approvals in Identity Security Cloud, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. +If the required approver approves the request and is the only reviewer required, Identity Security Cloud grants or revokes access, based on the request. +If multiple reviewers are required, Identity Security Cloud sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. +The required approver can then view any completed access requests under the Reviewed tab. + +Refer to [Access Requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for more information about access request approvals. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-access-request**](#approve-access-request) | **Post** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval +[**forward-access-request**](#forward-access-request) | **Post** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval +[**get-access-request-approval-summary**](#get-access-request-approval-summary) | **Get** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number +[**list-completed-approvals**](#list-completed-approvals) | **Get** `/access-request-approvals/completed` | Completed Access Request Approvals List +[**list-pending-approvals**](#list-pending-approvals) | **Get** `/access-request-approvals/pending` | Pending Access Request Approvals List +[**reject-access-request**](#reject-access-request) | **Post** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval + + +## approve-access-request +Approve Access Request Approval +Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-access-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**approvalId** | **string** | Approval ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiApproveAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **commentDto** | [**CommentDto**](../models/comment-dto) | Reviewer's comment. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + commentdto := []byte(`{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + }`) // CommentDto | Reviewer's comment. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.ApproveAccessRequest(context.Background(), approvalId).Execute() + //resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.ApproveAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ApproveAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ApproveAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## forward-access-request +Forward Access Request Approval +Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/forward-access-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**approvalId** | **string** | Approval ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiForwardAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **forwardApprovalDto** | [**ForwardApprovalDto**](../models/forward-approval-dto) | Information about the forwarded approval. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + forwardapprovaldto := []byte(`{ + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" + }`) // ForwardApprovalDto | Information about the forwarded approval. + + + var forwardApprovalDto v3.ForwardApprovalDto + if err := json.Unmarshal(forwardapprovaldto, &forwardApprovalDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.ForwardAccessRequest(context.Background(), approvalId).ForwardApprovalDto(forwardApprovalDto).Execute() + //resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.ForwardAccessRequest(context.Background(), approvalId).ForwardApprovalDto(forwardApprovalDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ForwardAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ForwardAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ForwardAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-approval-summary +Get Access Requests Approvals Number +Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-request-approval-summary) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestApprovalSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. | + **fromDate** | **string** | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. | + +### Return type + +[**ApprovalSummary**](../models/approval-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + fromDate := `from-date=2020-03-19T19:59:11Z` // string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) # string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary(context.Background()).Execute() + //resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary(context.Background()).OwnerId(ownerId).FromDate(fromDate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestApprovalSummary`: ApprovalSummary + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-completed-approvals +Completed Access Request Approvals List +This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-completed-approvals) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCompletedApprovalsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* | + **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: **created, modified** | + +### Return type + +[**[]CompletedApproval**](../models/completed-approval) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "2c91808568c529c60168cca6f90c1313"` // 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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + sorters := `modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.ListCompletedApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.ListCompletedApprovals(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListCompletedApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCompletedApprovals`: []CompletedApproval + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListCompletedApprovals`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-pending-approvals +Pending Access Request Approvals List +This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-pending-approvals) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPendingApprovalsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* | + **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: **created, modified** | + +### Return type + +[**[]PendingApproval**](../models/pending-approval) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "2c91808568c529c60168cca6f90c1313"` // 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) + sorters := `modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.ListPendingApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.ListPendingApprovals(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListPendingApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPendingApprovals`: []PendingApproval + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListPendingApprovals`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reject-access-request +Reject Access Request Approval +Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-access-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**approvalId** | **string** | Approval ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRejectAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **commentDto** | [**CommentDto**](../models/comment-dto) | Reviewer's comment. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + commentdto := []byte(`{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + }`) // CommentDto | Reviewer's comment. + + + var commentDto v3.CommentDto + if err := json.Unmarshal(commentdto, &commentDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.RejectAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + //resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.RejectAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.RejectAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.RejectAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/AccessRequestsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/AccessRequestsAPI.md new file mode 100644 index 000000000..a9ae8eadf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/AccessRequestsAPI.md @@ -0,0 +1,633 @@ +--- +id: access-requests +title: AccessRequests +pagination_label: AccessRequests +sidebar_label: AccessRequests +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequests', 'AccessRequests'] +slug: /tools/sdk/go/v3/methods/access-requests +tags: ['SDK', 'Software Development Kit', 'AccessRequests', 'AccessRequests'] +--- + +# AccessRequestsAPI + Use this API to implement and customize access request functionality. +With this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked. +This allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools. + +Identity Security Cloud's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them. + +In the Request Center in Identity Security Cloud, users can view available applications, roles, and entitlements and request access to them. +If the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them. + +Users can use My Requests to track and/or cancel the requests. + +In My Team on the Identity Security Cloud Home, managers can submit requests to revoke their team members' access. +They can use the My Requests tab under Request Center to track and/or cancel the requests. + +Refer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-access-request**](#cancel-access-request) | **Post** `/access-requests/cancel` | Cancel Access Request +[**create-access-request**](#create-access-request) | **Post** `/access-requests` | Submit Access Request +[**get-access-request-config**](#get-access-request-config) | **Get** `/access-request-config` | Get Access Request Configuration +[**list-access-request-status**](#list-access-request-status) | **Get** `/access-request-status` | Access Request Status +[**set-access-request-config**](#set-access-request-config) | **Put** `/access-request-config` | Update Access Request Configuration + + +## cancel-access-request +Cancel Access Request +This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. +In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/cancel-access-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCancelAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cancelAccessRequest** | [**CancelAccessRequest**](../models/cancel-access-request) | | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + cancelaccessrequest := []byte(`{ + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + }`) // CancelAccessRequest | + + + var cancelAccessRequest v3.CancelAccessRequest + if err := json.Unmarshal(cancelaccessrequest, &cancelAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestsAPI.CancelAccessRequest(context.Background()).CancelAccessRequest(cancelAccessRequest).Execute() + //resp, r, err := apiClient.V3.AccessRequestsAPI.CancelAccessRequest(context.Background()).CancelAccessRequest(cancelAccessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CancelAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CancelAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CancelAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-access-request +Submit Access Request +Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. + +Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request +has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn't return an error +if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. + +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. + +There are two types of access request: + +__GRANT_ACCESS__ +* Can be requested for multiple identities in a single request. +* 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. +* 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. +* 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. +* 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. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAccessRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessRequest** | [**AccessRequest**](../models/access-request) | | + +### Return type + +[**AccessRequestResponse**](../models/access-request-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accessrequest := []byte(`{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } ] + }`) // AccessRequest | + + + var accessRequest v3.AccessRequest + if err := json.Unmarshal(accessrequest, &accessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestsAPI.CreateAccessRequest(context.Background()).AccessRequest(accessRequest).Execute() + //resp, r, err := apiClient.V3.AccessRequestsAPI.CreateAccessRequest(context.Background()).AccessRequest(accessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CreateAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessRequest`: AccessRequestResponse + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CreateAccessRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-access-request-config +Get Access Request Configuration +This endpoint returns the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-request-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccessRequestConfigRequest struct via the builder pattern + + +### Return type + +[**AccessRequestConfig**](../models/access-request-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestsAPI.GetAccessRequestConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.AccessRequestsAPI.GetAccessRequestConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.GetAccessRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestConfig`: AccessRequestConfig + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.GetAccessRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-access-request-status +Access Request Status +Use this API to return a list of access request statuses based on the specified query parameters. +If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. +Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-access-request-status) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccessRequestStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **requestedBy** | **string** | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **regardingIdentity** | **string** | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. | + **assignedTo** | **string** | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. | + **count** | **bool** | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. | [default to false] + **limit** | **int32** | Max number of results to return. | [default to 250] + **offset** | **int32** | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. | + **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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* | + **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: **created, modified, accountActivityItemId, name** | + **requestState** | **string** | Filter the results by the state of the request. The only valid value is *EXECUTING*. | + +### Return type + +[**[]RequestedItemStatus**](../models/requested-item-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + assignedTo := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + count := false // bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + limit := 100 // int32 | Max number of results to return. (optional) (default to 250) # int32 | Max number of results to return. (optional) (default to 250) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + filters := `accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"` // 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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + sorters := `created` // 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: **created, modified, accountActivityItemId, name** (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: **created, modified, accountActivityItemId, name** (optional) + requestState := `request-state=EXECUTING` // string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestsAPI.ListAccessRequestStatus(context.Background()).Execute() + //resp, r, err := apiClient.V3.AccessRequestsAPI.ListAccessRequestStatus(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).AssignedTo(assignedTo).Count(count).Limit(limit).Offset(offset).Filters(filters).Sorters(sorters).RequestState(requestState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.ListAccessRequestStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessRequestStatus`: []RequestedItemStatus + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.ListAccessRequestStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-access-request-config +Update Access Request Configuration +This endpoint replaces the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-access-request-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetAccessRequestConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accessRequestConfig** | [**AccessRequestConfig**](../models/access-request-config) | | + +### Return type + +[**AccessRequestConfig**](../models/access-request-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accessrequestconfig := []byte(`{ + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + }`) // AccessRequestConfig | + + + var accessRequestConfig v3.AccessRequestConfig + if err := json.Unmarshal(accessrequestconfig, &accessRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestsAPI.SetAccessRequestConfig(context.Background()).AccessRequestConfig(accessRequestConfig).Execute() + //resp, r, err := apiClient.V3.AccessRequestsAPI.SetAccessRequestConfig(context.Background()).AccessRequestConfig(accessRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.SetAccessRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetAccessRequestConfig`: AccessRequestConfig + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.SetAccessRequestConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/AccountActivitiesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/AccountActivitiesAPI.md new file mode 100644 index 000000000..8ca3ee7f4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/AccountActivitiesAPI.md @@ -0,0 +1,196 @@ +--- +id: account-activities +title: AccountActivities +pagination_label: AccountActivities +sidebar_label: AccountActivities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivities', 'AccountActivities'] +slug: /tools/sdk/go/v3/methods/account-activities +tags: ['SDK', 'Software Development Kit', 'AccountActivities', 'AccountActivities'] +--- + +# AccountActivitiesAPI + Use this API to implement account activity tracking functionality. +With this functionality in place, users can track source account activity in Identity Security Cloud, which greatly improves traceability in the system. + +An account activity refers to a log of each action performed on a source account. This is useful for auditing the changes performed on an account throughout its life. +In Identity Security Cloud's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. + +Account activity includes most actions Identity Security Cloud completes on source accounts. Users can search in Identity Security Cloud for the following account action types: + +- Access Request: These include any access requests the source account is involved in. + +- Account Attribute Updates: These include updates to a single attribute on an account on a source. + +- Account State Update: These include locking or unlocking actions on an account on a source. + +- Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification. + +- Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. +Identity Security Cloud replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. + +- Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. +When you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays. +Account Activity does not include attribute updates that occur as a result of aggregation. + +- Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. +These also include refreshes that occur whenever Identity Security Cloud assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. + +- Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. + +- Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state. + +- Password Change: These include password changes on sources. + +Refer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-account-activity**](#get-account-activity) | **Get** `/account-activities/{id}` | Get an Account Activity +[**list-account-activities**](#list-account-activities) | **Get** `/account-activities` | List Account Activities + + +## get-account-activity +Get an Account Activity +This gets a single account activity by its id. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-account-activity) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account activity id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountActivityRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccountActivity**](../models/account-activity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account activity id # string | The account activity id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountActivitiesAPI.GetAccountActivity(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.AccountActivitiesAPI.GetAccountActivity(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountActivitiesAPI.GetAccountActivity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccountActivity`: AccountActivity + fmt.Fprintf(os.Stdout, "Response from `AccountActivitiesAPI.GetAccountActivity`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-account-activities +List Account Activities +This gets a collection of account activities that satisfy the given query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-account-activities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccountActivitiesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **requestedBy** | **string** | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | + **regardingIdentity** | **string** | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* | + **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: **type, created, modified** | + +### Return type + +[**[]AccountActivity**](../models/account-activity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c91808568c529c60168cca6f90c1313` // string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c91808568c529c60168cca6f90c1313` // string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c91808568c529c60168cca6f90c1313` // string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `type eq "Identity Refresh"` // 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + sorters := `created` // 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: **type, created, modified** (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: **type, created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountActivitiesAPI.ListAccountActivities(context.Background()).Execute() + //resp, r, err := apiClient.V3.AccountActivitiesAPI.ListAccountActivities(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountActivitiesAPI.ListAccountActivities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccountActivities`: []AccountActivity + fmt.Fprintf(os.Stdout, "Response from `AccountActivitiesAPI.ListAccountActivities`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/AccountUsagesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/AccountUsagesAPI.md new file mode 100644 index 000000000..b2254bba7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/AccountUsagesAPI.md @@ -0,0 +1,97 @@ +--- +id: account-usages +title: AccountUsages +pagination_label: AccountUsages +sidebar_label: AccountUsages +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUsages', 'AccountUsages'] +slug: /tools/sdk/go/v3/methods/account-usages +tags: ['SDK', 'Software Development Kit', 'AccountUsages', 'AccountUsages'] +--- + +# AccountUsagesAPI + Use this API to implement account usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used. +This allows organizations to get the information they need to start optimizing and securing source account usage. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-usages-by-account-id**](#get-usages-by-account-id) | **Get** `/account-usages/{accountId}/summaries` | Returns account usage insights + + +## get-usages-by-account-id +Returns account usage insights +This API returns a summary of account usage insights for past 12 months. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-usages-by-account-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**accountId** | **string** | ID of IDN account | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetUsagesByAccountIdRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **date** | + +### Return type + +[**[]AccountUsage**](../models/account-usage) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accountId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of IDN account # string | ID of IDN account + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `-date` // 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: **date** (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: **date** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountUsagesAPI.GetUsagesByAccountId(context.Background(), accountId).Execute() + //resp, r, err := apiClient.V3.AccountUsagesAPI.GetUsagesByAccountId(context.Background(), accountId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountUsagesAPI.GetUsagesByAccountId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUsagesByAccountId`: []AccountUsage + fmt.Fprintf(os.Stdout, "Response from `AccountUsagesAPI.GetUsagesByAccountId`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/AccountsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/AccountsAPI.md new file mode 100644 index 000000000..a30b8e983 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/AccountsAPI.md @@ -0,0 +1,894 @@ +--- +id: accounts +title: Accounts +pagination_label: Accounts +sidebar_label: Accounts +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Accounts', 'Accounts'] +slug: /tools/sdk/go/v3/methods/accounts +tags: ['SDK', 'Software Development Kit', 'Accounts', 'Accounts'] +--- + +# AccountsAPI + Use this API to implement and customize account functionality. +With this functionality in place, administrators can manage users' access across sources in Identity Security Cloud. + +In Identity Security Cloud, an account refers to a user's account on a supported source. +This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. Identity Security Cloud loads accounts through the creation of sources in Identity Security Cloud. + +Administrators can correlate users' identities with the users' accounts on the different sources they use. +This allows Identity Security Cloud to govern the access of identities and all their correlated accounts securely and cohesively. + +To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. + +To view and edit source account statuses for an identity in Identity Security Cloud, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. +Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. + +Accounts can have the following statuses: + +- Enabled: The account is enabled. The user can access it. + +- Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in Identity Security Cloud. This can occur when an administrator disables the account or when the user's lifecycle state changes. + +- Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times. + +- Pending: The account is currently updating. This status typically lasts seconds. + +Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed. + +Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-account**](#create-account) | **Post** `/accounts` | Create Account +[**delete-account**](#delete-account) | **Delete** `/accounts/{id}` | Delete Account +[**disable-account**](#disable-account) | **Post** `/accounts/{id}/disable` | Disable Account +[**enable-account**](#enable-account) | **Post** `/accounts/{id}/enable` | Enable Account +[**get-account**](#get-account) | **Get** `/accounts/{id}` | Account Details +[**get-account-entitlements**](#get-account-entitlements) | **Get** `/accounts/{id}/entitlements` | Account Entitlements +[**list-accounts**](#list-accounts) | **Get** `/accounts` | Accounts List +[**put-account**](#put-account) | **Put** `/accounts/{id}` | Update Account +[**submit-reload-account**](#submit-reload-account) | **Post** `/accounts/{id}/reload` | Reload Account +[**unlock-account**](#unlock-account) | **Post** `/accounts/{id}/unlock` | Unlock Account +[**update-account**](#update-account) | **Patch** `/accounts/{id}` | Update Account + + +## create-account +Create Account +Submit an account creation task - the API then returns the task ID. + +You must include the `sourceId` where the account will be created in the `attributes` object. + +This endpoint creates an account on the source record in your ISC tenant. +This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. + +However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. +The endpoint doesn't actually provision the account on the target source, which means that if the account doesn't also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. + +By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-account) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accountAttributesCreate** | [**AccountAttributesCreate**](../models/account-attributes-create) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + accountattributescreate := []byte(`{ + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }`) // AccountAttributesCreate | + + + var accountAttributesCreate v3.AccountAttributesCreate + if err := json.Unmarshal(accountattributescreate, &accountAttributesCreate); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.CreateAccount(context.Background()).AccountAttributesCreate(accountAttributesCreate).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.CreateAccount(context.Background()).AccountAttributesCreate(accountAttributesCreate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.CreateAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.CreateAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-account +Delete Account +Use this API to delete an account. +This endpoint submits an account delete task and returns the task ID. +This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. +>**NOTE: You can only delete accounts from sources of the "DelimitedFile" type.** + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.DeleteAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.DeleteAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DeleteAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DeleteAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## disable-account +Disable Account +This API submits a task to disable the account and returns the task ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/disable-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDisableAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **accountToggleRequest** | [**AccountToggleRequest**](../models/account-toggle-request) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + accounttogglerequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }`) // AccountToggleRequest | + + + var accountToggleRequest v3.AccountToggleRequest + if err := json.Unmarshal(accounttogglerequest, &accountToggleRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.DisableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.DisableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DisableAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DisableAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## enable-account +Enable Account +This API submits a task to enable account and returns the task ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/enable-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiEnableAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **accountToggleRequest** | [**AccountToggleRequest**](../models/account-toggle-request) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + accounttogglerequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }`) // AccountToggleRequest | + + + var accountToggleRequest v3.AccountToggleRequest + if err := json.Unmarshal(accounttogglerequest, &accountToggleRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.EnableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.EnableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.EnableAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `EnableAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-account +Account Details +Use this API to return the details for a single account by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Account**](../models/account) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.GetAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.GetAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.GetAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccount`: Account + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.GetAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-account-entitlements +Account Entitlements +This API returns entitlements of the account. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-account-entitlements) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountEntitlementsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]Entitlement**](../models/entitlement) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.GetAccountEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.GetAccountEntitlements(context.Background(), id).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.GetAccountEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccountEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.GetAccountEntitlements`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-accounts +Accounts List +List accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-accounts) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListAccountsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **detailLevel** | **string** | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. | + **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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* | + **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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** | + +### Return type + +[**[]Account**](../models/account) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + detailLevel := `FULL` // string | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) # string | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + filters := `identityId eq "2c9180858082150f0180893dbaf44201"` // 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) + sorters := `id,name` // 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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.ListAccounts(context.Background()).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.ListAccounts(context.Background()).Limit(limit).Offset(offset).Count(count).DetailLevel(detailLevel).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.ListAccounts``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccounts`: []Account + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.ListAccounts`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-account +Update Account +Use this API to update an account with a PUT request. + +This endpoint submits an account update task and returns the task ID. + +>**Note: You can only use this PUT endpoint to update accounts from flat file sources.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **accountAttributes** | [**AccountAttributes**](../models/account-attributes) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + accountattributes := []byte(`{ + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }`) // AccountAttributes | + + + var accountAttributes v3.AccountAttributes + if err := json.Unmarshal(accountattributes, &accountAttributes); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.PutAccount(context.Background(), id).AccountAttributes(accountAttributes).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.PutAccount(context.Background(), id).AccountAttributes(accountAttributes).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.PutAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.PutAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-reload-account +Reload Account +This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/submit-reload-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitReloadAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.SubmitReloadAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.SubmitReloadAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.SubmitReloadAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitReloadAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.SubmitReloadAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## unlock-account +Unlock Account +This API submits a task to unlock an account and returns the task ID. +To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/unlock-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUnlockAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **accountUnlockRequest** | [**AccountUnlockRequest**](../models/account-unlock-request) | | + +### Return type + +[**AccountsAsyncResult**](../models/accounts-async-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account ID. # string | The account ID. + accountunlockrequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + }`) // AccountUnlockRequest | + + + var accountUnlockRequest v3.AccountUnlockRequest + if err := json.Unmarshal(accountunlockrequest, &accountUnlockRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.UnlockAccount(context.Background(), id).AccountUnlockRequest(accountUnlockRequest).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.UnlockAccount(context.Background(), id).AccountUnlockRequest(accountUnlockRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.UnlockAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UnlockAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.UnlockAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-account +Update Account +Use this API to update account details. + +This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields. +To reassign an account from one identity to another, replace the current `identityId` with a new value. +If the account you're assigning was provisioned by Identity Security Cloud (ISC), it's possible for ISC to create a new account +for the previous identity as soon as the account is moved. If the account you're assigning is authoritative, +this causes the previous identity to become uncorrelated and can even result in its deletion. +All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. + +>**Note:** The `attributes` field can only be modified for flat file accounts. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-account) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Account ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateAccountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **requestBody** | **[]map[string]interface{}** | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + requestbody := []byte(`[{op=remove, path=/identityId}]`) // []map[string]interface{} | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var requestBody v3.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.UpdateAccount(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.UpdateAccount(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.UpdateAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAccount`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.UpdateAccount`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/ApplicationDiscoveryAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/ApplicationDiscoveryAPI.md new file mode 100644 index 000000000..78a22af8e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/ApplicationDiscoveryAPI.md @@ -0,0 +1,216 @@ +--- +id: application-discovery +title: ApplicationDiscovery +pagination_label: ApplicationDiscovery +sidebar_label: ApplicationDiscovery +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApplicationDiscovery', 'ApplicationDiscovery'] +slug: /tools/sdk/go/v3/methods/application-discovery +tags: ['SDK', 'Software Development Kit', 'ApplicationDiscovery', 'ApplicationDiscovery'] +--- + +# ApplicationDiscoveryAPI + Use this API to implement application discovery functionality. +With this functionality in place, you can discover applications within your Okta connector and receive connector recommendations by manually uploading application names. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-discovered-applications**](#get-discovered-applications) | **Get** `/discovered-applications` | Get Discovered Applications for Tenant +[**get-manual-discover-applications-csv-template**](#get-manual-discover-applications-csv-template) | **Get** `/manual-discover-applications-template` | Download CSV Template for Discovery +[**send-manual-discover-applications-csv-template**](#send-manual-discover-applications-csv-template) | **Post** `/manual-discover-applications` | Upload CSV to Discover Applications + + +## get-discovered-applications +Get Discovered Applications for Tenant +Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-discovered-applications) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDiscoveredApplicationsRequest struct via the builder pattern + + +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] + **detail** | **string** | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. | + **filter** | **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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* | + **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, description, discoveredAt, discoverySource** | + +### Return type + +[**[]GetDiscoveredApplications200ResponseInner**](../models/get-discovered-applications200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + filter := `name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")` // 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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + sorters := `name` // 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, description, discoveredAt, discoverySource** (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, description, discoveredAt, discoverySource** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ApplicationDiscoveryAPI.GetDiscoveredApplications(context.Background()).Execute() + //resp, r, err := apiClient.V3.ApplicationDiscoveryAPI.GetDiscoveredApplications(context.Background()).Limit(limit).Offset(offset).Detail(detail).Filter(filter).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetDiscoveredApplications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDiscoveredApplications`: []GetDiscoveredApplications200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `ApplicationDiscoveryAPI.GetDiscoveredApplications`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-manual-discover-applications-csv-template +Download CSV Template for Discovery +Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. + +The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-manual-discover-applications-csv-template) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManualDiscoverApplicationsCsvTemplateRequest struct via the builder pattern + + +### Return type + +[**ManualDiscoverApplicationsTemplate**](../models/manual-discover-applications-template) + +### 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() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate(context.Background()).Execute() + //resp, r, err := apiClient.V3.ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManualDiscoverApplicationsCsvTemplate`: ManualDiscoverApplicationsTemplate + fmt.Fprintf(os.Stdout, "Response from `ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## send-manual-discover-applications-csv-template +Upload CSV to Discover Applications +Uploading a CSV file with application data for manual correlation to specific ISC connectors. +If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-manual-discover-applications-csv-template) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendManualDiscoverApplicationsCsvTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file** | ***os.File** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | + +### Return type + + (empty response body) + +### 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() { + file := BINARY_DATA_HERE // *os.File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # *os.File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate(context.Background()).File(file).Execute() + //r, err := apiClient.V3.ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate(context.Background()).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/AuthUsersAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/AuthUsersAPI.md new file mode 100644 index 000000000..26a584530 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/AuthUsersAPI.md @@ -0,0 +1,170 @@ +--- +id: auth-users +title: AuthUsers +pagination_label: AuthUsers +sidebar_label: AuthUsers +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuthUsers', 'AuthUsers'] +slug: /tools/sdk/go/v3/methods/auth-users +tags: ['SDK', 'Software Development Kit', 'AuthUsers', 'AuthUsers'] +--- + +# AuthUsersAPI + Use this API to implement user authentication system functionality. +With this functionality in place, users can get a user's authentication system details, including their capabilities, and modify those capabilities. +The user's capabilities refer to their access to different systems, or authorization, within the tenant, like access to certifications (CERT_ADMIN) or reports (REPORT_ADMIN). +These capabilities also determine a user's access to the different APIs. +This API provides users with a way to determine a user's access and make quick and easy changes to that access. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-auth-user**](#get-auth-user) | **Get** `/auth-users/{id}` | Auth User Details +[**patch-auth-user**](#patch-auth-user) | **Patch** `/auth-users/{id}` | Auth User Update + + +## get-auth-user +Auth User Details +Return the specified user's authentication system details. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-user) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Identity ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAuthUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**AuthUser**](../models/auth-user) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AuthUsersAPI.GetAuthUser(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.AuthUsersAPI.GetAuthUser(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthUsersAPI.GetAuthUser``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthUser`: AuthUser + fmt.Fprintf(os.Stdout, "Response from `AuthUsersAPI.GetAuthUser`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-auth-user +Auth User Update +Use a PATCH request to update an existing user in the authentication system. +Use this endpoint to modify these fields: + * `capabilities` + +A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-user) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Identity ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAuthUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +[**AuthUser**](../models/auth-user) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + jsonpatchoperation := []byte(`[{op=replace, path=/capabilities, value=[ORG_ADMIN]}]`) // []JsonPatchOperation | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AuthUsersAPI.PatchAuthUser(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.AuthUsersAPI.PatchAuthUser(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthUsersAPI.PatchAuthUser``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthUser`: AuthUser + fmt.Fprintf(os.Stdout, "Response from `AuthUsersAPI.PatchAuthUser`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/BrandingAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/BrandingAPI.md new file mode 100644 index 000000000..ae41d2749 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/BrandingAPI.md @@ -0,0 +1,374 @@ +--- +id: branding +title: Branding +pagination_label: Branding +sidebar_label: Branding +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Branding', 'Branding'] +slug: /tools/sdk/go/v3/methods/branding +tags: ['SDK', 'Software Development Kit', 'Branding', 'Branding'] +--- + +# BrandingAPI + Use this API to implement and customize branding functionality. +With this functionality in place, administrators can get and manage existing branding items, and they can also create new branding items and configure them for use throughout Identity Security Cloud. +The Branding APIs provide administrators with a way to customize branding items. +This customization includes details like their colors, logos, and other information. +Refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) for more information about certifications. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-branding-item**](#create-branding-item) | **Post** `/brandings` | Create a branding item +[**delete-branding**](#delete-branding) | **Delete** `/brandings/{name}` | Delete a branding item +[**get-branding**](#get-branding) | **Get** `/brandings/{name}` | Get a branding item +[**get-branding-list**](#get-branding-list) | **Get** `/brandings` | List of branding items +[**set-branding-item**](#set-branding-item) | **Put** `/brandings/{name}` | Update a branding item + + +## create-branding-item +Create a branding item +This API endpoint creates a branding item. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-branding-item) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateBrandingItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **string** | name of branding item | + **productName** | **string** | product name | + **actionButtonColor** | **string** | hex value of color for action button | + **activeLinkColor** | **string** | hex value of color for link | + **navigationColor** | **string** | hex value of color for navigation bar | + **emailFromAddress** | **string** | email from address | + **loginInformationalMessage** | **string** | login information message | + **fileStandard** | ***os.File** | png file with logo | + +### Return type + +[**BrandingItem**](../models/branding-item) + +### 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() { + name := `name_example` // string | name of branding item # string | name of branding item + productName := `productName_example` // string | product name # string | product name + actionButtonColor := `actionButtonColor_example` // string | hex value of color for action button (optional) # string | hex value of color for action button (optional) + activeLinkColor := `activeLinkColor_example` // string | hex value of color for link (optional) # string | hex value of color for link (optional) + navigationColor := `navigationColor_example` // string | hex value of color for navigation bar (optional) # string | hex value of color for navigation bar (optional) + emailFromAddress := `emailFromAddress_example` // string | email from address (optional) # string | email from address (optional) + loginInformationalMessage := `loginInformationalMessage_example` // string | login information message (optional) # string | login information message (optional) + fileStandard := BINARY_DATA_HERE // *os.File | png file with logo (optional) # *os.File | png file with logo (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.BrandingAPI.CreateBrandingItem(context.Background()).Name(name).ProductName(productName).Execute() + //resp, r, err := apiClient.V3.BrandingAPI.CreateBrandingItem(context.Background()).Name(name).ProductName(productName).ActionButtonColor(actionButtonColor).ActiveLinkColor(activeLinkColor).NavigationColor(navigationColor).EmailFromAddress(emailFromAddress).LoginInformationalMessage(loginInformationalMessage).FileStandard(fileStandard).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.CreateBrandingItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateBrandingItem`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.CreateBrandingItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-branding +Delete a branding item +This API endpoint delete information for an existing branding item by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-branding) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The name of the branding item to be deleted | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteBrandingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `default` // string | The name of the branding item to be deleted # string | The name of the branding item to be deleted + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.BrandingAPI.DeleteBranding(context.Background(), name).Execute() + //r, err := apiClient.V3.BrandingAPI.DeleteBranding(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.DeleteBranding``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-branding +Get a branding item +This API endpoint retrieves information for an existing branding item by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-branding) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The name of the branding item to be retrieved | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetBrandingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**BrandingItem**](../models/branding-item) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `default` // string | The name of the branding item to be retrieved # string | The name of the branding item to be retrieved + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.BrandingAPI.GetBranding(context.Background(), name).Execute() + //resp, r, err := apiClient.V3.BrandingAPI.GetBranding(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.GetBranding``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBranding`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.GetBranding`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-branding-list +List of branding items +This API endpoint returns a list of branding items. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-branding-list) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetBrandingListRequest struct via the builder pattern + + +### Return type + +[**[]BrandingItem**](../models/branding-item) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.BrandingAPI.GetBrandingList(context.Background()).Execute() + //resp, r, err := apiClient.V3.BrandingAPI.GetBrandingList(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.GetBrandingList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBrandingList`: []BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.GetBrandingList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-branding-item +Update a branding item +This API endpoint updates information for an existing branding item. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-branding-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | The name of the branding item to be retrieved | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetBrandingItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **name2** | **string** | name of branding item | + **productName** | **string** | product name | + **actionButtonColor** | **string** | hex value of color for action button | + **activeLinkColor** | **string** | hex value of color for link | + **navigationColor** | **string** | hex value of color for navigation bar | + **emailFromAddress** | **string** | email from address | + **loginInformationalMessage** | **string** | login information message | + **fileStandard** | ***os.File** | png file with logo | + +### Return type + +[**BrandingItem**](../models/branding-item) + +### 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() { + name := `default` // string | The name of the branding item to be retrieved # string | The name of the branding item to be retrieved + name2 := `name_example` // string | name of branding item # string | name of branding item + productName := `productName_example` // string | product name # string | product name + actionButtonColor := `actionButtonColor_example` // string | hex value of color for action button (optional) # string | hex value of color for action button (optional) + activeLinkColor := `activeLinkColor_example` // string | hex value of color for link (optional) # string | hex value of color for link (optional) + navigationColor := `navigationColor_example` // string | hex value of color for navigation bar (optional) # string | hex value of color for navigation bar (optional) + emailFromAddress := `emailFromAddress_example` // string | email from address (optional) # string | email from address (optional) + loginInformationalMessage := `loginInformationalMessage_example` // string | login information message (optional) # string | login information message (optional) + fileStandard := BINARY_DATA_HERE // *os.File | png file with logo (optional) # *os.File | png file with logo (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.BrandingAPI.SetBrandingItem(context.Background(), name).Name2(name2).ProductName(productName).Execute() + //resp, r, err := apiClient.V3.BrandingAPI.SetBrandingItem(context.Background(), name).Name2(name2).ProductName(productName).ActionButtonColor(actionButtonColor).ActiveLinkColor(activeLinkColor).NavigationColor(navigationColor).EmailFromAddress(emailFromAddress).LoginInformationalMessage(loginInformationalMessage).FileStandard(fileStandard).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.SetBrandingItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetBrandingItem`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.SetBrandingItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/CertificationCampaignFiltersAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/CertificationCampaignFiltersAPI.md new file mode 100644 index 000000000..a63471532 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/CertificationCampaignFiltersAPI.md @@ -0,0 +1,425 @@ +--- +id: certification-campaign-filters +title: CertificationCampaignFilters +pagination_label: CertificationCampaignFilters +sidebar_label: CertificationCampaignFilters +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationCampaignFilters', 'CertificationCampaignFilters'] +slug: /tools/sdk/go/v3/methods/certification-campaign-filters +tags: ['SDK', 'Software Development Kit', 'CertificationCampaignFilters', 'CertificationCampaignFilters'] +--- + +# CertificationCampaignFiltersAPI + Use this API to implement the certification campaign filter functionality. These filters can be used to create a certification campaign that includes a subset of your entitlements or users to certify. + +For example, if for a certification campaign an organization wants to certify only specific users or entitlements, then those can be included/excluded on the basis of campaign filters. + +For more information about creating a campaign filter, refer to [Creating a Campaign Filter](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#creating-a-campaign-filter) + +You can create campaign filters using any of the following criteria types: + +- Access Profile : This criteria type includes or excludes access profiles from a campaign. + +- Account Attribute : This criteria type includes or excludes certification items that match a specified value in an account attribute. + +- Entitlement : This criteria type includes or excludes entitlements from a campaign. + +- Identity : This criteria type includes or excludes specific identities from your campaign. + +- Identity Attribute : This criteria type includes or excludes identities based on whether they have an identity attribute that matches criteria you've chosen. + +- Role : This criteria type includes or excludes roles, as opposed to identities. + +- Source : This criteria type includes or excludes entitlements from a source you select. + +For more information about these criteria types, refer to [Types of Campaign Filters](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#types-of-campaign-filters) + +Once the campaign filter is created, it can be linked while creating the campaign. The generated campaign will have the items to review as per the campaign filter. + +For example, An inclusion campaign filter is created with a source of Source 1, an operation of Equals, and an entitlement of Entitlement 1. When this filter is selected, only users who have Entitlement 1 are included in the campaign, and only Entitlement 1 is shown in the certification. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-campaign-filter**](#create-campaign-filter) | **Post** `/campaign-filters` | Create Campaign Filter +[**delete-campaign-filters**](#delete-campaign-filters) | **Post** `/campaign-filters/delete` | Deletes Campaign Filters +[**get-campaign-filter-by-id**](#get-campaign-filter-by-id) | **Get** `/campaign-filters/{id}` | Get Campaign Filter by ID +[**list-campaign-filters**](#list-campaign-filters) | **Get** `/campaign-filters` | List Campaign Filters +[**update-campaign-filter**](#update-campaign-filter) | **Post** `/campaign-filters/{id}` | Updates a Campaign Filter + + +## create-campaign-filter +Create Campaign Filter +Use this API to create a campaign filter based on filter details and criteria. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-campaign-filter) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCampaignFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaignFilterDetails** | [**CampaignFilterDetails**](../models/campaign-filter-details) | | + +### Return type + +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + campaignfilterdetails := []byte(`{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + }`) // CampaignFilterDetails | + + + var campaignFilterDetails v3.CampaignFilterDetails + if err := json.Unmarshal(campaignfilterdetails, &campaignFilterDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignFiltersAPI.CreateCampaignFilter(context.Background()).CampaignFilterDetails(campaignFilterDetails).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignFiltersAPI.CreateCampaignFilter(context.Background()).CampaignFilterDetails(campaignFilterDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.CreateCampaignFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaignFilter`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.CreateCampaignFilter`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-campaign-filters +Deletes Campaign Filters +Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaign-filters) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCampaignFiltersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestBody** | **[]string** | A json list of IDs of campaign filters to delete. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestbody := []byte(``) // []string | A json list of IDs of campaign filters to delete. + + + var requestBody v3.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.CertificationCampaignFiltersAPI.DeleteCampaignFilters(context.Background()).RequestBody(requestBody).Execute() + //r, err := apiClient.V3.CertificationCampaignFiltersAPI.DeleteCampaignFilters(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.DeleteCampaignFilters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-campaign-filter-by-id +Get Campaign Filter by ID +Retrieves information for an existing campaign filter using the filter's ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-filter-by-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the campaign filter to be retrieved. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignFilterByIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `e9f9a1397b842fd5a65842087040d3ac` // string | The ID of the campaign filter to be retrieved. # string | The ID of the campaign filter to be retrieved. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignFiltersAPI.GetCampaignFilterById(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignFiltersAPI.GetCampaignFilterById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.GetCampaignFilterById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignFilterById`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.GetCampaignFilterById`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-campaign-filters +List Campaign Filters +Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-campaign-filters) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCampaignFiltersRequest struct via the builder pattern + + +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] + **start** | **int32** | Start/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] + **includeSystemFilters** | **bool** | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. | [default to true] + +### Return type + +[**ListCampaignFilters200Response**](../models/list-campaign-filters200-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + start := 0 // int32 | Start/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 | Start/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) + includeSystemFilters := true // bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to true) # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignFiltersAPI.ListCampaignFilters(context.Background()).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignFiltersAPI.ListCampaignFilters(context.Background()).Limit(limit).Start(start).IncludeSystemFilters(includeSystemFilters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.ListCampaignFilters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCampaignFilters`: ListCampaignFilters200Response + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.ListCampaignFilters`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-campaign-filter +Updates a Campaign Filter +Updates an existing campaign filter using the filter's ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-campaign-filter) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**filterId** | **string** | The ID of the campaign filter being modified. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateCampaignFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **campaignFilterDetails** | [**CampaignFilterDetails**](../models/campaign-filter-details) | A campaign filter details with updated field values. | + +### Return type + +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filterId := `e9f9a1397b842fd5a65842087040d3ac` // string | The ID of the campaign filter being modified. # string | The ID of the campaign filter being modified. + campaignfilterdetails := []byte(`{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + }`) // CampaignFilterDetails | A campaign filter details with updated field values. + + + var campaignFilterDetails v3.CampaignFilterDetails + if err := json.Unmarshal(campaignfilterdetails, &campaignFilterDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignFiltersAPI.UpdateCampaignFilter(context.Background(), filterId).CampaignFilterDetails(campaignFilterDetails).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignFiltersAPI.UpdateCampaignFilter(context.Background(), filterId).CampaignFilterDetails(campaignFilterDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.UpdateCampaignFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCampaignFilter`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.UpdateCampaignFilter`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/CertificationCampaignsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/CertificationCampaignsAPI.md new file mode 100644 index 000000000..4c05a04cf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/CertificationCampaignsAPI.md @@ -0,0 +1,1905 @@ +--- +id: certification-campaigns +title: CertificationCampaigns +pagination_label: CertificationCampaigns +sidebar_label: CertificationCampaigns +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationCampaigns', 'CertificationCampaigns'] +slug: /tools/sdk/go/v3/methods/certification-campaigns +tags: ['SDK', 'Software Development Kit', 'CertificationCampaigns', 'CertificationCampaigns'] +--- + +# CertificationCampaignsAPI + Use this API to implement certification campaign functionality. +With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use. +Certification campaigns provide Identity Security Cloud users with an interactive review process they can use to identify and verify access to systems. +Campaigns help organizations reduce risk of inappropriate access and satisfy audit requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers. +Once this campaign has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Identity Security Cloud provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns: + +You can create these types of campaigns without using any search queries in Identity Security Cloud: + +- ManagerCampaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access is certified by their managers. +You only need to provide a name and description to create one. + +- Source Owner Campaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners. +You only need to provide a name and description to create one. +You can specify the sources whose owners you want involved or just run it across all sources. + +For more information about these campaign types, refer to [Starting a Manager or Source Owner Campaign](https://documentation.sailpoint.com/saas/help/certs/starting_campaign.html). + +One useful way to create certification campaigns in Identity Security Cloud is to use a specific search and then run a campaign on the results returned by that search. +This allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns. +For example, you can search for all identities who are managed by "Amanda.Ross" and also have the access to the "Accounting" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified. + +You can use Identity Security Cloud search queries to create these types of campaigns: + +- Identities: Use this campaign type to review and revoke access items for specific identities. +You can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign. + +- Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them. +You can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign. + +- Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria. +You can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign. + +- Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in Identity Security Cloud. +You can use this campaign type to view all the uncorrelated accounts for a source and certify them. + +For more information about search-based campaigns, refer to [Starting a Campaign from Search](https://documentation.sailpoint.com/saas/help/certs/starting_search_campaign.html). + +Once you have generated your campaign, it becomes available for preview. +An administrator can review the campaign and make changes, or if it's ready and accurate, activate it. + +Once the campaign is active, organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed). + +When a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review. +Reviewers can then make decisions to grant or revoke access, as well as reassign the certification to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must "Sign Off" to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. +In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +The end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision. + +For more information about certifications and certification campaigns, refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html). + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**complete-campaign**](#complete-campaign) | **Post** `/campaigns/{id}/complete` | Complete a Campaign +[**create-campaign**](#create-campaign) | **Post** `/campaigns` | Create a campaign +[**create-campaign-template**](#create-campaign-template) | **Post** `/campaign-templates` | Create a Campaign Template +[**delete-campaign-template**](#delete-campaign-template) | **Delete** `/campaign-templates/{id}` | Delete a Campaign Template +[**delete-campaign-template-schedule**](#delete-campaign-template-schedule) | **Delete** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule +[**delete-campaigns**](#delete-campaigns) | **Post** `/campaigns/delete` | Delete Campaigns +[**get-active-campaigns**](#get-active-campaigns) | **Get** `/campaigns` | List Campaigns +[**get-campaign**](#get-campaign) | **Get** `/campaigns/{id}` | Get Campaign +[**get-campaign-reports**](#get-campaign-reports) | **Get** `/campaigns/{id}/reports` | Get Campaign Reports +[**get-campaign-reports-config**](#get-campaign-reports-config) | **Get** `/campaigns/reports-configuration` | Get Campaign Reports Configuration +[**get-campaign-template**](#get-campaign-template) | **Get** `/campaign-templates/{id}` | Get a Campaign Template +[**get-campaign-template-schedule**](#get-campaign-template-schedule) | **Get** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule +[**get-campaign-templates**](#get-campaign-templates) | **Get** `/campaign-templates` | List Campaign Templates +[**move**](#move) | **Post** `/campaigns/{id}/reassign` | Reassign Certifications +[**patch-campaign-template**](#patch-campaign-template) | **Patch** `/campaign-templates/{id}` | Update a Campaign Template +[**set-campaign-reports-config**](#set-campaign-reports-config) | **Put** `/campaigns/reports-configuration` | Set Campaign Reports Configuration +[**set-campaign-template-schedule**](#set-campaign-template-schedule) | **Put** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule +[**start-campaign**](#start-campaign) | **Post** `/campaigns/{id}/activate` | Activate a Campaign +[**start-campaign-remediation-scan**](#start-campaign-remediation-scan) | **Post** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan +[**start-campaign-report**](#start-campaign-report) | **Post** `/campaigns/{id}/run-report/{type}` | Run Campaign Report +[**start-generate-campaign-template**](#start-generate-campaign-template) | **Post** `/campaign-templates/{id}/generate` | Generate a Campaign from Template +[**update-campaign**](#update-campaign) | **Patch** `/campaigns/{id}` | Update a Campaign + + +## complete-campaign +Complete a Campaign +:::caution + +This endpoint will run successfully for any campaigns that are **past due**. + +This endpoint will return a content error if the campaign is **not past due**. + +::: + +Use this API to complete a certification campaign. This functionality is provided to admins so that they +can complete a certification even if all items have not been completed. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/complete-campaign) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Campaign ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompleteCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **campaignCompleteOptions** | [**CampaignCompleteOptions**](../models/campaign-complete-options) | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Campaign ID. # string | Campaign ID. + campaigncompleteoptions := []byte(`{ + "autoCompleteAction" : "REVOKE" + }`) // CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.CompleteCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.CompleteCampaign(context.Background(), id).CampaignCompleteOptions(campaignCompleteOptions).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CompleteCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompleteCampaign`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CompleteCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-campaign +Create a campaign +Use this API to create a certification campaign with the information provided in the request body. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-campaign) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaign** | [**Campaign**](../models/campaign) | | + +### Return type + +[**Campaign**](../models/campaign) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + campaign := []byte(`{ + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }`) // Campaign | + + + var campaign v3.Campaign + if err := json.Unmarshal(campaign, &campaign); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.CreateCampaign(context.Background()).Campaign(campaign).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.CreateCampaign(context.Background()).Campaign(campaign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CreateCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaign`: Campaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CreateCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-campaign-template +Create a Campaign Template +Use this API to create a certification campaign template based on campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-campaign-template) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaignTemplate** | [**CampaignTemplate**](../models/campaign-template) | | + +### Return type + +[**CampaignTemplate**](../models/campaign-template) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + campaigntemplate := []byte(`{ + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + }`) // CampaignTemplate | + + + var campaignTemplate v3.CampaignTemplate + if err := json.Unmarshal(campaigntemplate, &campaignTemplate); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.CreateCampaignTemplate(context.Background()).CampaignTemplate(campaignTemplate).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.CreateCampaignTemplate(context.Background()).CampaignTemplate(campaignTemplate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CreateCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CreateCampaignTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-campaign-template +Delete a Campaign Template +Use this API to delete a certification campaign template by ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template being deleted. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template being deleted. # string | ID of the campaign template being deleted. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.CertificationCampaignsAPI.DeleteCampaignTemplate(context.Background(), id).Execute() + //r, err := apiClient.V3.CertificationCampaignsAPI.DeleteCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-campaign-template-schedule +Delete Campaign Template Schedule +Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template whose schedule is being deleted. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCampaignTemplateScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template whose schedule is being deleted. # string | ID of the campaign template whose schedule is being deleted. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.CertificationCampaignsAPI.DeleteCampaignTemplateSchedule(context.Background(), id).Execute() + //r, err := apiClient.V3.CertificationCampaignsAPI.DeleteCampaignTemplateSchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-campaigns +Delete Campaigns +Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaigns) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCampaignsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaignsDeleteRequest** | [**CampaignsDeleteRequest**](../models/campaigns-delete-request) | IDs of the campaigns to delete. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + campaignsdeleterequest := []byte(`{ + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + }`) // CampaignsDeleteRequest | IDs of the campaigns to delete. + + + var campaignsDeleteRequest v3.CampaignsDeleteRequest + if err := json.Unmarshal(campaignsdeleterequest, &campaignsDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).CampaignsDeleteRequest(campaignsDeleteRequest).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).CampaignsDeleteRequest(campaignsDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaigns``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteCampaigns`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.DeleteCampaigns`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-active-campaigns +List Campaigns +Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetActiveCampaignsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **detail** | **string** | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **status**: *eq, in* | + **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, created** | + +### Return type + +[**[]GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Manager Campaign"` // 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* **status**: *eq, in* (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* **status**: *eq, in* (optional) + sorters := `name` // 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, created** (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, created** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetActiveCampaigns(context.Background()).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetActiveCampaigns(context.Background()).Detail(detail).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetActiveCampaigns``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetActiveCampaigns`: []GetActiveCampaigns200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetActiveCampaigns`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign +Get Campaign +Use this API to get information for an existing certification campaign by the campaign's ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign to be retrieved. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **detail** | **string** | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. | + +### Return type + +[**GetCampaign200Response**](../models/get-campaign200-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign to be retrieved. # string | ID of the campaign to be retrieved. + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaign(context.Background(), id).Detail(detail).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaign`: GetCampaign200Response + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-reports +Get Campaign Reports +Use this API to fetch all reports for a certification campaign by campaign ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign whose reports are being fetched. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignReportsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]CampaignReport**](../models/campaign-report) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign whose reports are being fetched. # string | ID of the campaign whose reports are being fetched. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignReports(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignReports(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignReports``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignReports`: []CampaignReport + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignReports`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-reports-config +Get Campaign Reports Configuration +Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignReportsConfigRequest struct via the builder pattern + + +### Return type + +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignReportsConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignReportsConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignReportsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignReportsConfig`: CampaignReportsConfig + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignReportsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-template +Get a Campaign Template +Use this API to fetch a certification campaign template by ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Requested campaign template's ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CampaignTemplate**](../models/campaign-template) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Requested campaign template's ID. # string | Requested campaign template's ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-template-schedule +Get Campaign Template Schedule +Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template whose schedule is being fetched. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignTemplateScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Schedule**](../models/schedule) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template whose schedule is being fetched. # string | ID of the campaign template whose schedule is being fetched. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignTemplateSchedule(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignTemplateSchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplateSchedule`: Schedule + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplateSchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-campaign-templates +List Campaign Templates +Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. + +The API returns all campaign templates matching the query parameters. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-templates) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCampaignTemplatesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, created, modified** | + **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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* | + +### Return type + +[**[]CampaignTemplate**](../models/campaign-template) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name` // 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, created, modified** (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, created, modified** (optional) + filters := `name eq "manager template"` // 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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignTemplates(context.Background()).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignTemplates(context.Background()).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplates`: []CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplates`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## move +Reassign Certifications +This API reassigns the specified certifications from one identity to another. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/move) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The certification campaign ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiMoveRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **adminReviewReassign** | [**AdminReviewReassign**](../models/admin-review-reassign) | | + +### Return type + +[**CertificationTask**](../models/certification-task) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification campaign ID # string | The certification campaign ID + adminreviewreassign := []byte(`{ + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + }`) // AdminReviewReassign | + + + var adminReviewReassign v3.AdminReviewReassign + if err := json.Unmarshal(adminreviewreassign, &adminReviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.Move(context.Background(), id).AdminReviewReassign(adminReviewReassign).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.Move(context.Background(), id).AdminReviewReassign(adminReviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.Move``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `Move`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.Move`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-campaign-template +Update a Campaign Template +Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template being modified. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) | + +### Return type + +[**CampaignTemplate**](../models/campaign-template) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template being modified. # string | ID of the campaign template being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/campaign/filter/id, value=ff80818155fe8c080155fe8d925b0316}]`) // []JsonPatchOperation | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.PatchCampaignTemplate(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.PatchCampaignTemplate(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.PatchCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.PatchCampaignTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-campaign-reports-config +Set Campaign Reports Configuration +Use this API to overwrite the configuration for campaign reports. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetCampaignReportsConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaignReportsConfig** | [**CampaignReportsConfig**](../models/campaign-reports-config) | Campaign report configuration. | + +### Return type + +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + campaignreportsconfig := []byte(`{ + "identityAttributeColumns" : [ "firstname", "lastname" ] + }`) // CampaignReportsConfig | Campaign report configuration. + + + var campaignReportsConfig v3.CampaignReportsConfig + if err := json.Unmarshal(campaignreportsconfig, &campaignReportsConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.SetCampaignReportsConfig(context.Background()).CampaignReportsConfig(campaignReportsConfig).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.SetCampaignReportsConfig(context.Background()).CampaignReportsConfig(campaignReportsConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.SetCampaignReportsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetCampaignReportsConfig`: CampaignReportsConfig + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.SetCampaignReportsConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-campaign-template-schedule +Set Campaign Template Schedule +Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template being scheduled. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetCampaignTemplateScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schedule** | [**Schedule**](../models/schedule) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template being scheduled. # string | ID of the campaign template being scheduled. + schedule := []byte(`{ + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + }`) // Schedule | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.CertificationCampaignsAPI.SetCampaignTemplateSchedule(context.Background(), id).Execute() + //r, err := apiClient.V3.CertificationCampaignsAPI.SetCampaignTemplateSchedule(context.Background(), id).Schedule(schedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.SetCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## start-campaign +Activate a Campaign +Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-campaign) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Campaign ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **activateCampaignOptions** | [**ActivateCampaignOptions**](../models/activate-campaign-options) | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Campaign ID. # string | Campaign ID. + activatecampaignoptions := []byte(`{ + "timeZone" : "-05:00" + }`) // ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.StartCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.StartCampaign(context.Background(), id).ActivateCampaignOptions(activateCampaignOptions).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaign`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-campaign-remediation-scan +Run Campaign Remediation Scan +Use this API to run a remediation scan task for a certification campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign the remediation scan is being run for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartCampaignRemediationScanRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign the remediation scan is being run for. # string | ID of the campaign the remediation scan is being run for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.StartCampaignRemediationScan(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.StartCampaignRemediationScan(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaignRemediationScan``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaignRemediationScan`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaignRemediationScan`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-campaign-report +Run Campaign Report +Use this API to run a report for a certification campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-campaign-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign the report is being run for. | +**type_** | [**ReportType**](../models/) | Type of the report to run. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartCampaignReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign the report is being run for. # string | ID of the campaign the report is being run for. + type_ := // ReportType | Type of the report to run. # ReportType | Type of the report to run. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.StartCampaignReport(context.Background(), id, type_).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.StartCampaignReport(context.Background(), id, type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaignReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaignReport`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaignReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-generate-campaign-template +Generate a Campaign from Template +Use this API to generate a new certification campaign from a campaign template. + +The campaign object contained in the template has special formatting applied to its name and description +fields that determine the generated campaign's name/description. Placeholders in those fields are +formatted with the current date and time upon generation. + +Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For +example, "%Y" inserts the current year, and a campaign template named "Campaign for %y" generates a +campaign called "Campaign for 2020" (assuming the year at generation time is 2020). + +Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-generate-campaign-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template to use for generation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartGenerateCampaignTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CampaignReference**](../models/campaign-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template to use for generation. # string | ID of the campaign template to use for generation. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.StartGenerateCampaignTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.StartGenerateCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartGenerateCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartGenerateCampaignTemplate`: CampaignReference + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartGenerateCampaignTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-campaign +Update a Campaign +Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-campaign) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the campaign template being modified. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateCampaignRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline | + +### Return type + +[**SlimCampaign**](../models/slim-campaign) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign template being modified. # string | ID of the campaign template being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]`) // []JsonPatchOperation | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.UpdateCampaign(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.UpdateCampaign(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.UpdateCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCampaign`: SlimCampaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.UpdateCampaign`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/CertificationSummariesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/CertificationSummariesAPI.md new file mode 100644 index 000000000..c0fc609eb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/CertificationSummariesAPI.md @@ -0,0 +1,329 @@ +--- +id: certification-summaries +title: CertificationSummaries +pagination_label: CertificationSummaries +sidebar_label: CertificationSummaries +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationSummaries', 'CertificationSummaries'] +slug: /tools/sdk/go/v3/methods/certification-summaries +tags: ['SDK', 'Software Development Kit', 'CertificationSummaries', 'CertificationSummaries'] +--- + +# CertificationSummariesAPI + Use this API to implement certification summary functionality. +With this functionality in place, administrators and designated certification reviewers can review summaries of identity certification campaigns and draw conclusions about the campaigns' scope, security, and effectiveness. +Implementing certification summary functionality improves organizations' ability to review their [certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) and helps them satisfy audit and regulatory requirements by enabling them to trace access changes and the decisions made in their review processes. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Certification summaries provide information about identity certification campaigns such as the identities involved, the number of decisions made, and the access changed. +For example, an administrator or designated certification reviewer can examine the Manager Certification campaign to get an overview of how many entitlement decisions are made in that campaign as opposed to role decisions, which identities would be affected by changes to the campaign, and how those identities' access would be affected. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-identity-access-summaries**](#get-identity-access-summaries) | **Get** `/certifications/{id}/access-summaries/{type}` | Access Summaries +[**get-identity-decision-summary**](#get-identity-decision-summary) | **Get** `/certifications/{id}/decision-summary` | Summary of Certification Decisions +[**get-identity-summaries**](#get-identity-summaries) | **Get** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification +[**get-identity-summary**](#get-identity-summary) | **Get** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity + + +## get-identity-access-summaries +Access Summaries +This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-access-summaries) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | +**type_** | **string** | The type of access review item to retrieve summaries for | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityAccessSummariesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* | + **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: **access.name** | + +### Return type + +[**[]AccessSummary**](../models/access-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + type_ := `ACCESS_PROFILE` // string | The type of access review item to retrieve summaries for # string | The type of access review item to retrieve summaries for + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "ef38f94347e94562b5bb8424a56397d8"` // 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters := `access.name` // 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: **access.name** (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: **access.name** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationSummariesAPI.GetIdentityAccessSummaries(context.Background(), id, type_).Execute() + //resp, r, err := apiClient.V3.CertificationSummariesAPI.GetIdentityAccessSummaries(context.Background(), id, type_).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentityAccessSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityAccessSummaries`: []AccessSummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentityAccessSummaries`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-decision-summary +Summary of Certification Decisions +This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-decision-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityDecisionSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **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: **identitySummary.id**: *eq, in* | + +### Return type + +[**IdentityCertDecisionSummary**](../models/identity-cert-decision-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification ID + filters := `identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"` // 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: **identitySummary.id**: *eq, in* (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: **identitySummary.id**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationSummariesAPI.GetIdentityDecisionSummary(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationSummariesAPI.GetIdentityDecisionSummary(context.Background(), id).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentityDecisionSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityDecisionSummary`: IdentityCertDecisionSummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentityDecisionSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-summaries +Identity Summaries for Campaign Certification +This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-summaries) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentitySummariesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **completed**: *eq, ne* **name**: *eq, sw* | + **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** | + +### Return type + +[**[]CertificationIdentitySummary**](../models/certification-identity-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **completed**: *eq, ne* **name**: *eq, sw* (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* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters := `name` // 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** (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** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationSummariesAPI.GetIdentitySummaries(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationSummariesAPI.GetIdentitySummaries(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentitySummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySummaries`: []CertificationIdentitySummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentitySummaries`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-summary +Summary for Identity +This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | +**identitySummaryId** | **string** | The identity summary ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentitySummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**CertificationIdentitySummary**](../models/certification-identity-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + identitySummaryId := `2c91808772a504f50172a9540e501ba8` // string | The identity summary ID # string | The identity summary ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationSummariesAPI.GetIdentitySummary(context.Background(), id, identitySummaryId).Execute() + //resp, r, err := apiClient.V3.CertificationSummariesAPI.GetIdentitySummary(context.Background(), id, identitySummaryId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentitySummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySummary`: CertificationIdentitySummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentitySummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/CertificationsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/CertificationsAPI.md new file mode 100644 index 000000000..0db095db6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/CertificationsAPI.md @@ -0,0 +1,875 @@ +--- +id: certifications +title: Certifications +pagination_label: Certifications +sidebar_label: Certifications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Certifications', 'Certifications'] +slug: /tools/sdk/go/v3/methods/certifications +tags: ['SDK', 'Software Development Kit', 'Certifications', 'Certifications'] +--- + +# CertificationsAPI + Use this API to implement certification functionality. +With this functionality in place, administrators and designated certification reviewers can review users' access certifications and decide whether to approve access, revoke it, or reassign the review to another reviewer. +Implementing certifications improves organizations' data security by reducing inappropriate access through a distributed review process and helping them satisfy audit and regulatory requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can select the 'Certifications' tab to view any of the certifications they either need to review or have already reviewed under the 'Active' and 'Completed' tabs, respectively. + +When a certification campaign is in progress, certification reviewers will see certifications listed under 'Active,' where they can review the involved identities. +Under the 'Decision' column on the right, next to each access item, reviewers can select the checkmark to approve access, select the 'X' to revoke access, or they can toggle the 'More Options' menu to reassign the certification to another reviewer and provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must select 'Sign Off' to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-certification-task**](#get-certification-task) | **Get** `/certification-tasks/{id}` | Certification Task by ID +[**get-identity-certification**](#get-identity-certification) | **Get** `/certifications/{id}` | Identity Certification by ID +[**get-identity-certification-item-permissions**](#get-identity-certification-item-permissions) | **Get** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item +[**get-pending-certification-tasks**](#get-pending-certification-tasks) | **Get** `/certification-tasks` | List of Pending Certification Tasks +[**list-certification-reviewers**](#list-certification-reviewers) | **Get** `/certifications/{id}/reviewers` | List of Reviewers for certification +[**list-identity-access-review-items**](#list-identity-access-review-items) | **Get** `/certifications/{id}/access-review-items` | List of Access Review Items +[**list-identity-certifications**](#list-identity-certifications) | **Get** `/certifications` | List Identity Campaign Certifications +[**make-identity-decision**](#make-identity-decision) | **Post** `/certifications/{id}/decide` | Decide on a Certification Item +[**reassign-identity-certifications**](#reassign-identity-certifications) | **Post** `/certifications/{id}/reassign` | Reassign Identities or Items +[**sign-off-identity-certification**](#sign-off-identity-certification) | **Post** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions +[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **Post** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously + + +## get-certification-task +Certification Task by ID +This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-certification-task) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The task ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCertificationTaskRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**CertificationTask**](../models/certification-task) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `63b32151-26c0-42f4-9299-8898dc1c9daa` // string | The task ID # string | The task ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.GetCertificationTask(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.GetCertificationTask(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetCertificationTask``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCertificationTask`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetCertificationTask`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-certification +Identity Certification by ID +This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-certification) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The certification id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityCertificationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification id # string | The certification id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.GetIdentityCertification(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.GetIdentityCertification(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertification`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertification`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-certification-item-permissions +Permissions for Entitlement Certification Item +This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-certification-item-permissions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**certificationId** | **string** | The certification ID | +**itemId** | **string** | The certification item ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityCertificationItemPermissionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]PermissionDto**](../models/permission-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + certificationId := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification ID + itemId := `2c91808671bcbab40171bd945d961227` // string | The certification item ID # string | The certification item ID + filters := `target eq "SYS.OBJAUTH2"` // 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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.GetIdentityCertificationItemPermissions(context.Background(), certificationId, itemId).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.GetIdentityCertificationItemPermissions(context.Background(), certificationId, itemId).Filters(filters).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertificationItemPermissions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertificationItemPermissions`: []PermissionDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertificationItemPermissions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-pending-certification-tasks +List of Pending Certification Tasks +This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-pending-certification-tasks) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPendingCertificationTasksRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **reviewerIdentity** | **string** | The ID of reviewer identity. *me* indicates the current user. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **targetId**: *eq, in* **type**: *eq, in* | + +### Return type + +[**[]CertificationTask**](../models/certification-task) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reviewerIdentity := `Ada.1de82e55078344` // string | The ID of reviewer identity. *me* indicates the current user. (optional) # string | The ID of reviewer identity. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `type eq "ADMIN_REASSIGN"` // 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* **targetId**: *eq, in* **type**: *eq, in* (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* **targetId**: *eq, in* **type**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.GetPendingCertificationTasks(context.Background()).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.GetPendingCertificationTasks(context.Background()).ReviewerIdentity(reviewerIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetPendingCertificationTasks``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPendingCertificationTasks`: []CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetPendingCertificationTasks`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-certification-reviewers +List of Reviewers for certification +This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-certification-reviewers) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCertificationReviewersRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **email**: *eq, sw* | + **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, email** | + +### Return type + +[**[]IdentityReferenceWithNameAndEmail**](../models/identity-reference-with-name-and-email) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Bob"` // 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* **email**: *eq, sw* (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* **email**: *eq, sw* (optional) + sorters := `name` // 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, email** (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, email** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.ListCertificationReviewers(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.ListCertificationReviewers(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListCertificationReviewers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCertificationReviewers`: []IdentityReferenceWithNameAndEmail + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListCertificationReviewers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-access-review-items +List of Access Review Items +This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-access-review-items) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityAccessReviewItemsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* | + **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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** | + **entitlements** | **string** | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. | + **accessProfiles** | **string** | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. | + **roles** | **string** | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. | + +### Return type + +[**[]AccessReviewItem**](../models/access-review-item) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters := `access.name,-accessProfile.sourceName` // 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) + entitlements := `identityEntitlement` // string | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) + accessProfiles := `accessProfile1` // string | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) + roles := `userRole` // string | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.ListIdentityAccessReviewItems(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.ListIdentityAccessReviewItems(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Entitlements(entitlements).AccessProfiles(accessProfiles).Roles(roles).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListIdentityAccessReviewItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityAccessReviewItems`: []AccessReviewItem + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListIdentityAccessReviewItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-certifications +List Identity Campaign Certifications +Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-certifications) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityCertificationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **reviewerIdentity** | **string** | Reviewer's identity. *me* indicates the current user. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *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, due, signed** | + +### Return type + +[**[]IdentityCertificationDto**](../models/identity-certification-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reviewerIdentity := `me` // string | Reviewer's identity. *me* indicates the current user. (optional) # string | Reviewer's identity. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) + sorters := `name,due` // 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, due, signed** (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, due, signed** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.ListIdentityCertifications(context.Background()).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.ListIdentityCertifications(context.Background()).ReviewerIdentity(reviewerIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListIdentityCertifications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityCertifications`: []IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListIdentityCertifications`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## make-identity-decision +Decide on a Certification Item +The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/make-identity-decision) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the identity campaign certification on which to make decisions | + +### Other Parameters + +Other parameters are passed through a pointer to a apiMakeIdentityDecisionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **reviewDecision** | [**[]ReviewDecision**](../models/review-decision) | A non-empty array of decisions to be made. | + +### Return type + +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the identity campaign certification on which to make decisions # string | The ID of the identity campaign certification on which to make decisions + reviewdecision := []byte(`[{id=ef38f94347e94562b5bb8424a56396b5, decision=APPROVE, bulk=true, comments=This user still needs access to this source.}, {id=ef38f94347e94562b5bb8424a56397d8, decision=APPROVE, bulk=true, comments=This user still needs access to this source too.}]`) // []ReviewDecision | A non-empty array of decisions to be made. + + + var reviewDecision v3.[]ReviewDecision + if err := json.Unmarshal(reviewdecision, &reviewDecision); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.MakeIdentityDecision(context.Background(), id).ReviewDecision(reviewDecision).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.MakeIdentityDecision(context.Background(), id).ReviewDecision(reviewDecision).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.MakeIdentityDecision``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `MakeIdentityDecision`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.MakeIdentityDecision`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reassign-identity-certifications +Reassign Identities or Items +This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/reassign-identity-certifications) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiReassignIdentityCertificationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **reviewReassign** | [**ReviewReassign**](../models/review-reassign) | | + +### Return type + +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + reviewreassign := []byte(`{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + }`) // ReviewReassign | + + + var reviewReassign v3.ReviewReassign + if err := json.Unmarshal(reviewreassign, &reviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.ReassignIdentityCertifications(context.Background(), id).ReviewReassign(reviewReassign).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.ReassignIdentityCertifications(context.Background(), id).ReviewReassign(reviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ReassignIdentityCertifications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ReassignIdentityCertifications`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ReassignIdentityCertifications`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## sign-off-identity-certification +Finalize Identity Certification Decisions +This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/sign-off-identity-certification) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSignOffIdentityCertificationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.SignOffIdentityCertification(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.SignOffIdentityCertification(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.SignOffIdentityCertification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SignOffIdentityCertification`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.SignOffIdentityCertification`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## submit-reassign-certs-async +Reassign Certifications Asynchronously +This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another +reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the +reassignment is complete. + +Reviewers for this certification can also call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/submit-reassign-certs-async) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The identity campaign certification ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitReassignCertsAsyncRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **reviewReassign** | [**ReviewReassign**](../models/review-reassign) | | + +### Return type + +[**CertificationTask**](../models/certification-task) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + reviewreassign := []byte(`{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + }`) // ReviewReassign | + + + var reviewReassign v3.ReviewReassign + if err := json.Unmarshal(reviewreassign, &reviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.SubmitReassignCertsAsync(context.Background(), id).ReviewReassign(reviewReassign).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.SubmitReassignCertsAsync(context.Background(), id).ReviewReassign(reviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.SubmitReassignCertsAsync``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitReassignCertsAsync`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.SubmitReassignCertsAsync`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/ConfigurationHubAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/ConfigurationHubAPI.md new file mode 100644 index 000000000..1aca691f5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/ConfigurationHubAPI.md @@ -0,0 +1,704 @@ +--- +id: configuration-hub +title: ConfigurationHub +pagination_label: ConfigurationHub +sidebar_label: ConfigurationHub +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConfigurationHub', 'ConfigurationHub'] +slug: /tools/sdk/go/v3/methods/configuration-hub +tags: ['SDK', 'Software Development Kit', 'ConfigurationHub', 'ConfigurationHub'] +--- + +# ConfigurationHubAPI + Upload configurations and manage object mappings between tenants. + +Configuration files can be managed and deployed using Configuration Hub by uploading a JSON file which contains configuration data. + +The function of object mapping allows objects with varying names and IDs to be compared. While objects are compared, a user can replace a value in the source tenant with a new value. Object mapping also helps in locating referenced objects to the source object during the drafting process. + +Refer to [Uploading a Configuration File](https://documentation.sailpoint.com/saas/help/confighub/config_hub.html#uploading-a-configuration-file) for more information about uploading Configuration Files + +Refer to [Mapping Objects](https://documentation.sailpoint.com/saas/help/confighub/config_hub.html#mapping-objects) for more information about object mappings. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-object-mapping**](#create-object-mapping) | **Post** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping +[**create-object-mappings**](#create-object-mappings) | **Post** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings +[**create-uploaded-configuration**](#create-uploaded-configuration) | **Post** `/configuration-hub/backups/uploads` | Upload a Configuration +[**delete-object-mapping**](#delete-object-mapping) | **Delete** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping +[**delete-uploaded-configuration**](#delete-uploaded-configuration) | **Delete** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration +[**get-object-mappings**](#get-object-mappings) | **Get** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings +[**get-uploaded-configuration**](#get-uploaded-configuration) | **Get** `/configuration-hub/backups/uploads/{id}` | Get an Uploaded Configuration +[**list-uploaded-configurations**](#list-uploaded-configurations) | **Get** `/configuration-hub/backups/uploads` | List Uploaded Configurations +[**update-object-mappings**](#update-object-mappings) | **Post** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings + + +## create-object-mapping +Creates an object mapping +This creates an object mapping between current org and source org. +Source org should be "default" when creating an object mapping that is not to be associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-object-mapping) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceOrg** | **string** | The name of the source org. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateObjectMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **objectMappingRequest** | [**ObjectMappingRequest**](../models/object-mapping-request) | The object mapping request body. | + +### Return type + +[**ObjectMappingResponse**](../models/object-mapping-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingrequest := []byte(`{ + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }`) // ObjectMappingRequest | The object mapping request body. + + + var objectMappingRequest v3.ObjectMappingRequest + if err := json.Unmarshal(objectmappingrequest, &objectMappingRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConfigurationHubAPI.CreateObjectMapping(context.Background(), sourceOrg).ObjectMappingRequest(objectMappingRequest).Execute() + //resp, r, err := apiClient.V3.ConfigurationHubAPI.CreateObjectMapping(context.Background(), sourceOrg).ObjectMappingRequest(objectMappingRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateObjectMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateObjectMapping`: ObjectMappingResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateObjectMapping`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-object-mappings +Bulk creates object mappings +This creates a set of object mappings (Max 25) between current org and source org. +Source org should be "default" when creating object mappings that are not to be associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-object-mappings) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceOrg** | **string** | The name of the source org. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateObjectMappingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **objectMappingBulkCreateRequest** | [**ObjectMappingBulkCreateRequest**](../models/object-mapping-bulk-create-request) | The bulk create object mapping request body. | + +### Return type + +[**ObjectMappingBulkCreateResponse**](../models/object-mapping-bulk-create-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingbulkcreaterequest := []byte(`{ + "newObjectsMappings" : [ { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }, { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } ] + }`) // ObjectMappingBulkCreateRequest | The bulk create object mapping request body. + + + var objectMappingBulkCreateRequest v3.ObjectMappingBulkCreateRequest + if err := json.Unmarshal(objectmappingbulkcreaterequest, &objectMappingBulkCreateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConfigurationHubAPI.CreateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkCreateRequest(objectMappingBulkCreateRequest).Execute() + //resp, r, err := apiClient.V3.ConfigurationHubAPI.CreateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkCreateRequest(objectMappingBulkCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateObjectMappings`: ObjectMappingBulkCreateResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateObjectMappings`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-uploaded-configuration +Upload a Configuration +This API uploads a JSON configuration file into a tenant. + +Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. + +Refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects) for more information about supported objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-uploaded-configuration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateUploadedConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **data** | ***os.File** | JSON file containing the objects to be imported. | + **name** | **string** | Name that will be assigned to the uploaded configuration file. | + +### Return type + +[**BackupResponse**](../models/backup-response) + +### 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() { + data := BINARY_DATA_HERE // *os.File | JSON file containing the objects to be imported. # *os.File | JSON file containing the objects to be imported. + name := `name_example` // string | Name that will be assigned to the uploaded configuration file. # string | Name that will be assigned to the uploaded configuration file. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConfigurationHubAPI.CreateUploadedConfiguration(context.Background()).Data(data).Name(name).Execute() + //resp, r, err := apiClient.V3.ConfigurationHubAPI.CreateUploadedConfiguration(context.Background()).Data(data).Name(name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateUploadedConfiguration`: BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateUploadedConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-object-mapping +Deletes an object mapping +This deletes an existing object mapping. +Source org should be "default" when deleting an object mapping that is not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-object-mapping) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceOrg** | **string** | The name of the source org. | +**objectMappingId** | **string** | The id of the object mapping to be deleted. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteObjectMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectMappingId := `3d6e0144-963f-4bd6-8d8d-d77b4e507ce4` // string | The id of the object mapping to be deleted. # string | The id of the object mapping to be deleted. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ConfigurationHubAPI.DeleteObjectMapping(context.Background(), sourceOrg, objectMappingId).Execute() + //r, err := apiClient.V3.ConfigurationHubAPI.DeleteObjectMapping(context.Background(), sourceOrg, objectMappingId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteObjectMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-uploaded-configuration +Delete an Uploaded Configuration +This API deletes an uploaded configuration based on Id. + +On success, this endpoint will return an empty response. + +The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-uploaded-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the uploaded configuration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteUploadedConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `3d0fe04b-57df-4a46-a83b-8f04b0f9d10b` // string | The id of the uploaded configuration. # string | The id of the uploaded configuration. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ConfigurationHubAPI.DeleteUploadedConfiguration(context.Background(), id).Execute() + //r, err := apiClient.V3.ConfigurationHubAPI.DeleteUploadedConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-object-mappings +Gets list of object mappings +This gets a list of existing object mappings between current org and source org. +Source org should be "default" when getting object mappings that are not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:read + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-object-mappings) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceOrg** | **string** | The name of the source org. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetObjectMappingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]ObjectMappingResponse**](../models/object-mapping-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConfigurationHubAPI.GetObjectMappings(context.Background(), sourceOrg).Execute() + //resp, r, err := apiClient.V3.ConfigurationHubAPI.GetObjectMappings(context.Background(), sourceOrg).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.GetObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetObjectMappings`: []ObjectMappingResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.GetObjectMappings`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-uploaded-configuration +Get an Uploaded Configuration +This API gets an existing uploaded configuration for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-uploaded-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The id of the uploaded configuration. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetUploadedConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**BackupResponse**](../models/backup-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `3d0fe04b-57df-4a46-a83b-8f04b0f9d10b` // string | The id of the uploaded configuration. # string | The id of the uploaded configuration. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConfigurationHubAPI.GetUploadedConfiguration(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.ConfigurationHubAPI.GetUploadedConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.GetUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUploadedConfiguration`: BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.GetUploadedConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-uploaded-configurations +List Uploaded Configurations +This API gets a list of existing uploaded configurations for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-uploaded-configurations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListUploadedConfigurationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **status**: *eq* | + +### Return type + +[**[]BackupResponse**](../models/backup-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `status eq "COMPLETE"` // 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: **status**: *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: **status**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConfigurationHubAPI.ListUploadedConfigurations(context.Background()).Execute() + //resp, r, err := apiClient.V3.ConfigurationHubAPI.ListUploadedConfigurations(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListUploadedConfigurations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListUploadedConfigurations`: []BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListUploadedConfigurations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-object-mappings +Bulk updates object mappings +This updates a set of object mappings, only enabled and targetValue fields can be updated. +Source org should be "default" when updating object mappings that are not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-object-mappings) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceOrg** | **string** | The name of the source org. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateObjectMappingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **objectMappingBulkPatchRequest** | [**ObjectMappingBulkPatchRequest**](../models/object-mapping-bulk-patch-request) | The object mapping request body. | + +### Return type + +[**ObjectMappingBulkPatchResponse**](../models/object-mapping-bulk-patch-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingbulkpatchrequest := []byte(`{ + "patches" : { + "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : true + } ], + "00bece34-f50d-4227-8878-76f620b5a971" : [ { + "op" : "replace", + "path" : "/targetValue", + "value" : "New Target Value" + } ] + } + }`) // ObjectMappingBulkPatchRequest | The object mapping request body. + + + var objectMappingBulkPatchRequest v3.ObjectMappingBulkPatchRequest + if err := json.Unmarshal(objectmappingbulkpatchrequest, &objectMappingBulkPatchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConfigurationHubAPI.UpdateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkPatchRequest(objectMappingBulkPatchRequest).Execute() + //resp, r, err := apiClient.V3.ConfigurationHubAPI.UpdateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkPatchRequest(objectMappingBulkPatchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.UpdateObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateObjectMappings`: ObjectMappingBulkPatchResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.UpdateObjectMappings`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/ConnectorsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/ConnectorsAPI.md new file mode 100644 index 000000000..8afc86d08 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/ConnectorsAPI.md @@ -0,0 +1,812 @@ +--- +id: connectors +title: Connectors +pagination_label: Connectors +sidebar_label: Connectors +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Connectors', 'Connectors'] +slug: /tools/sdk/go/v3/methods/connectors +tags: ['SDK', 'Software Development Kit', 'Connectors', 'Connectors'] +--- + +# ConnectorsAPI + Use this API to implement connector functionality. +With this functionality in place, administrators can view available connectors. + +Connectors are the bridges Identity Security Cloud uses to communicate with and aggregate data from sources. +For example, if it is necessary to set up a connection between Identity Security Cloud and the Active Directory source, a connector can bridge the two and enable Identity Security Cloud to synchronize data between the systems. +This ensures account entitlements and states are correct throughout the organization. + +In Identity Security Cloud, administrators can use the Connections drop-down menu and select Sources to view the available source connectors. + +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in Identity Security Cloud. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources. + +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about using connectors in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-custom-connector**](#create-custom-connector) | **Post** `/connectors` | Create Custom Connector +[**delete-custom-connector**](#delete-custom-connector) | **Delete** `/connectors/{scriptName}` | Delete Connector by Script Name +[**get-connector**](#get-connector) | **Get** `/connectors/{scriptName}` | Get Connector by Script Name +[**get-connector-list**](#get-connector-list) | **Get** `/connectors` | Get Connector List +[**get-connector-source-config**](#get-connector-source-config) | **Get** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration +[**get-connector-source-template**](#get-connector-source-template) | **Get** `/connectors/{scriptName}/source-template` | Get Connector Source Template +[**get-connector-translations**](#get-connector-translations) | **Get** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations +[**put-connector-source-config**](#put-connector-source-config) | **Put** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration +[**put-connector-source-template**](#put-connector-source-template) | **Put** `/connectors/{scriptName}/source-template` | Update Connector Source Template +[**put-connector-translations**](#put-connector-translations) | **Put** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations +[**update-connector**](#update-connector) | **Patch** `/connectors/{scriptName}` | Update Connector by Script Name + + +## create-custom-connector +Create Custom Connector +Create custom connector. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-custom-connector) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCustomConnectorRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **v3CreateConnectorDto** | [**V3CreateConnectorDto**](../models/v3-create-connector-dto) | | + +### Return type + +[**V3ConnectorDto**](../models/v3-connector-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + v3createconnectordto := []byte(`{ + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + }`) // V3CreateConnectorDto | + + + var v3CreateConnectorDto v3.V3CreateConnectorDto + if err := json.Unmarshal(v3createconnectordto, &v3CreateConnectorDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.CreateCustomConnector(context.Background()).V3CreateConnectorDto(v3CreateConnectorDto).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.CreateCustomConnector(context.Background()).V3CreateConnectorDto(v3CreateConnectorDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.CreateCustomConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCustomConnector`: V3ConnectorDto + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.CreateCustomConnector`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-custom-connector +Delete Connector by Script Name +Delete a custom connector that using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-custom-connector) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCustomConnectorRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ConnectorsAPI.DeleteCustomConnector(context.Background(), scriptName).Execute() + //r, err := apiClient.V3.ConnectorsAPI.DeleteCustomConnector(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.DeleteCustomConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-connector +Get Connector by Script Name +Fetches a connector that using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **locale** | **string** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | + +### Return type + +[**ConnectorDetail**](../models/connector-detail) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.GetConnector(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.GetConnector(context.Background(), scriptName).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnector`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnector`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-list +Get Connector List +Fetches list of connectors that have 'RELEASED' status using filtering and pagination. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-list) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **locale** | **string** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | + +### Return type + +[**[]V3ConnectorDto**](../models/v3-connector-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `directConnect eq "true"` // 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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.GetConnectorList(context.Background()).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.GetConnectorList(context.Background()).Filters(filters).Limit(limit).Offset(offset).Count(count).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorList`: []V3ConnectorDto + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorList`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-source-config +Get Connector Source Configuration +Fetches a connector's source config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-source-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorSourceConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.GetConnectorSourceConfig(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.GetConnectorSourceConfig(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorSourceConfig`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorSourceConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-source-template +Get Connector Source Template +Fetches a connector's source template using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-source-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorSourceTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.GetConnectorSourceTemplate(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.GetConnectorSourceTemplate(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorSourceTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorSourceTemplate`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorSourceTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-connector-translations +Get Connector Translations +Fetches a connector's translations using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-translations) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. | +**locale** | **string** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConnectorTranslationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.GetConnectorTranslations(context.Background(), scriptName, locale).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.GetConnectorTranslations(context.Background(), scriptName, locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorTranslations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorTranslations`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorTranslations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-connector-source-config +Update Connector Source Configuration +Update a connector's source config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-source-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutConnectorSourceConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | connector source config xml file | + +### Return type + +[**UpdateDetail**](../models/update-detail) + +### 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() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + file := BINARY_DATA_HERE // *os.File | connector source config xml file # *os.File | connector source config xml file + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.PutConnectorSourceConfig(context.Background(), scriptName).File(file).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.PutConnectorSourceConfig(context.Background(), scriptName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorSourceConfig`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorSourceConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-connector-source-template +Update Connector Source Template +Update a connector's source template using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-source-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutConnectorSourceTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | connector source template xml file | + +### Return type + +[**UpdateDetail**](../models/update-detail) + +### 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() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + file := BINARY_DATA_HERE // *os.File | connector source template xml file # *os.File | connector source template xml file + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.PutConnectorSourceTemplate(context.Background(), scriptName).File(file).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.PutConnectorSourceTemplate(context.Background(), scriptName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorSourceTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorSourceTemplate`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorSourceTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-connector-translations +Update Connector Translations +Update a connector's translations using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-translations) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. | +**locale** | **string** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutConnectorTranslationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**UpdateDetail**](../models/update-detail) + +### 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() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.PutConnectorTranslations(context.Background(), scriptName, locale).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.PutConnectorTranslations(context.Background(), scriptName, locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorTranslations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorTranslations`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorTranslations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-connector +Update Connector by Script Name +This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: + + +* connectorMetadata + +* applicationXml + +* correlationConfigXml + +* sourceConfigXml + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-connector) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateConnectorRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of connector detail update operations | + +### Return type + +[**ConnectorDetail**](../models/connector-detail) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | A list of connector detail update operations + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.UpdateConnector(context.Background(), scriptName).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.UpdateConnector(context.Background(), scriptName).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.UpdateConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateConnector`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.UpdateConnector`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/GlobalTenantSecuritySettingsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/GlobalTenantSecuritySettingsAPI.md new file mode 100644 index 000000000..76089f29e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/GlobalTenantSecuritySettingsAPI.md @@ -0,0 +1,605 @@ +--- +id: global-tenant-security-settings +title: GlobalTenantSecuritySettings +pagination_label: GlobalTenantSecuritySettings +sidebar_label: GlobalTenantSecuritySettings +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GlobalTenantSecuritySettings', 'GlobalTenantSecuritySettings'] +slug: /tools/sdk/go/v3/methods/global-tenant-security-settings +tags: ['SDK', 'Software Development Kit', 'GlobalTenantSecuritySettings', 'GlobalTenantSecuritySettings'] +--- + +# GlobalTenantSecuritySettingsAPI + Use this API to implement and customize global tenant security settings. +With this functionality in place, administrators can manage the global security settings that a tenant/org has. +This API can be used to configure the networks and Geographies allowed to access Identity Security Cloud URLs. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-auth-org-network-config**](#create-auth-org-network-config) | **Post** `/auth-org/network-config` | Create security network configuration. +[**get-auth-org-lockout-config**](#get-auth-org-lockout-config) | **Get** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. +[**get-auth-org-network-config**](#get-auth-org-network-config) | **Get** `/auth-org/network-config` | Get security network configuration. +[**get-auth-org-service-provider-config**](#get-auth-org-service-provider-config) | **Get** `/auth-org/service-provider-config` | Get Service Provider Configuration. +[**get-auth-org-session-config**](#get-auth-org-session-config) | **Get** `/auth-org/session-config` | Get Auth Org Session Configuration. +[**patch-auth-org-lockout-config**](#patch-auth-org-lockout-config) | **Patch** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration +[**patch-auth-org-network-config**](#patch-auth-org-network-config) | **Patch** `/auth-org/network-config` | Update security network configuration. +[**patch-auth-org-service-provider-config**](#patch-auth-org-service-provider-config) | **Patch** `/auth-org/service-provider-config` | Update Service Provider Configuration +[**patch-auth-org-session-config**](#patch-auth-org-session-config) | **Patch** `/auth-org/session-config` | Update Auth Org Session Configuration + + +## create-auth-org-network-config +Create security network configuration. +This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:manage' + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-auth-org-network-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateAuthOrgNetworkConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **networkConfiguration** | [**NetworkConfiguration**](../models/network-configuration) | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. | + +### Return type + +[**NetworkConfiguration**](../models/network-configuration) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + networkconfiguration := []byte(`{ + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] + }`) // NetworkConfiguration | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + + + var networkConfiguration v3.NetworkConfiguration + if err := json.Unmarshal(networkconfiguration, &networkConfiguration); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig(context.Background()).NetworkConfiguration(networkConfiguration).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig(context.Background()).NetworkConfiguration(networkConfiguration).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-auth-org-lockout-config +Get Auth Org Lockout Configuration. +This API returns the details of an org's lockout auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-lockout-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAuthOrgLockoutConfigRequest struct via the builder pattern + + +### Return type + +[**LockoutConfiguration**](../models/lockout-configuration) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgLockoutConfig`: LockoutConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-auth-org-network-config +Get security network configuration. +This API returns the details of an org's network auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-network-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAuthOrgNetworkConfigRequest struct via the builder pattern + + +### Return type + +[**NetworkConfiguration**](../models/network-configuration) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-auth-org-service-provider-config +Get Service Provider Configuration. +This API returns the details of an org's service provider auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-service-provider-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAuthOrgServiceProviderConfigRequest struct via the builder pattern + + +### Return type + +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgServiceProviderConfig`: ServiceProviderConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-auth-org-session-config +Get Auth Org Session Configuration. +This API returns the details of an org's session auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-session-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAuthOrgSessionConfigRequest struct via the builder pattern + + +### Return type + +[**SessionConfiguration**](../models/session-configuration) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgSessionConfig`: SessionConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-auth-org-lockout-config +Update Auth Org Lockout Configuration +This API updates an existing lockout configuration for an org using PATCH + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-lockout-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAuthOrgLockoutConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` | + +### Return type + +[**LockoutConfiguration**](../models/lockout-configuration) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}]`) // []JsonPatchOperation | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgLockoutConfig`: LockoutConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-auth-org-network-config +Update security network configuration. +This API updates an existing network configuration for an org using PATCH + Requires security scope of: 'sp:auth-org:manage' + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-network-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAuthOrgNetworkConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. | + +### Return type + +[**NetworkConfiguration**](../models/network-configuration) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/whitelisted, value=false,}, {op=add, path=/geolocation, value=[AF, HN, ES]}]`) // []JsonPatchOperation | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-auth-org-service-provider-config +Update Service Provider Configuration +This API updates an existing service provider configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-service-provider-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAuthOrgServiceProviderConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) | + +### Return type + +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}]`) // []JsonPatchOperation | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgServiceProviderConfig`: ServiceProviderConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-auth-org-session-config +Update Auth Org Session Configuration +This API updates an existing session configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-session-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchAuthOrgSessionConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` | + +### Return type + +[**SessionConfiguration**](../models/session-configuration) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}]`) // []JsonPatchOperation | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgSessionConfig`: SessionConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/IdentityProfilesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/IdentityProfilesAPI.md new file mode 100644 index 000000000..1aa2a7118 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/IdentityProfilesAPI.md @@ -0,0 +1,882 @@ +--- +id: identity-profiles +title: IdentityProfiles +pagination_label: IdentityProfiles +sidebar_label: IdentityProfiles +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfiles', 'IdentityProfiles'] +slug: /tools/sdk/go/v3/methods/identity-profiles +tags: ['SDK', 'Software Development Kit', 'IdentityProfiles', 'IdentityProfiles'] +--- + +# IdentityProfilesAPI + Use this API to implement identity profile functionality. +With this functionality in place, administrators can view identity profiles and their configurations. + +Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. + +In Identity Security Cloud, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. +This list shows some details about each identity profile, along with its status. +They can select an identity profile to view its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. + +Refer to [Creating Identity Profiles](https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html) for more information about identity profiles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-identity-profile**](#create-identity-profile) | **Post** `/identity-profiles` | Create Identity Profile +[**delete-identity-profile**](#delete-identity-profile) | **Delete** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile +[**delete-identity-profiles**](#delete-identity-profiles) | **Post** `/identity-profiles/bulk-delete` | Delete Identity Profiles +[**export-identity-profiles**](#export-identity-profiles) | **Get** `/identity-profiles/export` | Export Identity Profiles +[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **Get** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config +[**get-identity-profile**](#get-identity-profile) | **Get** `/identity-profiles/{identity-profile-id}` | Get Identity Profile +[**import-identity-profiles**](#import-identity-profiles) | **Post** `/identity-profiles/import` | Import Identity Profiles +[**list-identity-profiles**](#list-identity-profiles) | **Get** `/identity-profiles` | List Identity Profiles +[**show-identity-preview**](#show-identity-preview) | **Post** `/identity-profiles/identity-preview` | Generate Identity Profile Preview +[**sync-identity-profile**](#sync-identity-profile) | **Post** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile +[**update-identity-profile**](#update-identity-profile) | **Patch** `/identity-profiles/{identity-profile-id}` | Update Identity Profile + + +## create-identity-profile +Create Identity Profile +Creates an identity profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-identity-profile) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityProfile** | [**IdentityProfile**](../models/identity-profile) | | + +### Return type + +[**IdentityProfile**](../models/identity-profile) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityprofile := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + }`) // IdentityProfile | + + + var identityProfile v3.IdentityProfile + if err := json.Unmarshal(identityprofile, &identityProfile); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.CreateIdentityProfile(context.Background()).IdentityProfile(identityProfile).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.CreateIdentityProfile(context.Background()).IdentityProfile(identityProfile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.CreateIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.CreateIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-identity-profile +Delete Identity Profile +Delete an identity profile by ID. +On success, this endpoint will return a reference to the bulk delete task result. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-identity-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**TaskResultSimplified**](../models/task-result-simplified) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.DeleteIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.DeleteIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.DeleteIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteIdentityProfile`: TaskResultSimplified + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.DeleteIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-identity-profiles +Delete Identity Profiles +This deletes multiple Identity Profiles via a list of supplied IDs. + +On success, this endpoint will return a reference to the bulk delete task result. + +The following rights are required to access this endpoint: idn:identity-profile:delete + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-identity-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteIdentityProfilesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestBody** | **[]string** | Identity Profile bulk delete request body. | + +### Return type + +[**TaskResultSimplified**](../models/task-result-simplified) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestbody := []byte(``) // []string | Identity Profile bulk delete request body. + + + var requestBody v3.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.DeleteIdentityProfiles(context.Background()).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.DeleteIdentityProfiles(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.DeleteIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteIdentityProfiles`: TaskResultSimplified + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.DeleteIdentityProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## export-identity-profiles +Export Identity Profiles +This exports existing identity profiles in the format specified by the sp-config service. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/export-identity-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportIdentityProfilesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ne* **name**: *eq, ne* **priority**: *eq, ne* | + **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: **id, name, priority** | + +### Return type + +[**[]IdentityProfileExportedObject**](../models/identity-profile-exported-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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, ne* **name**: *eq, ne* **priority**: *eq, ne* (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, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + sorters := `id,name` // 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: **id, name, priority** (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: **id, name, priority** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.ExportIdentityProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.ExportIdentityProfiles(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ExportIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportIdentityProfiles`: []IdentityProfileExportedObject + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ExportIdentityProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-default-identity-attribute-config +Get default Identity Attribute Config +This returns the default identity attribute config. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-default-identity-attribute-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | The Identity Profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDefaultIdentityAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityAttributeConfig**](../models/identity-attribute-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | The Identity Profile ID. # string | The Identity Profile ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.GetDefaultIdentityAttributeConfig(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.GetDefaultIdentityAttributeConfig(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GetDefaultIdentityAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDefaultIdentityAttributeConfig`: IdentityAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GetDefaultIdentityAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-identity-profile +Get Identity Profile +Get a single identity profile by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**IdentityProfile**](../models/identity-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.GetIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.GetIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GetIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GetIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-identity-profiles +Import Identity Profiles +This imports previously exported identity profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/import-identity-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportIdentityProfilesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityProfileExportedObject** | [**[]IdentityProfileExportedObject**](../models/identity-profile-exported-object) | Previously exported Identity Profiles. | + +### Return type + +[**ObjectImportResult**](../models/object-import-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityprofileexportedobject := []byte(``) // []IdentityProfileExportedObject | Previously exported Identity Profiles. + + + var identityProfileExportedObject v3.[]IdentityProfileExportedObject + if err := json.Unmarshal(identityprofileexportedobject, &identityProfileExportedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.ImportIdentityProfiles(context.Background()).IdentityProfileExportedObject(identityProfileExportedObject).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.ImportIdentityProfiles(context.Background()).IdentityProfileExportedObject(identityProfileExportedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ImportIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportIdentityProfiles`: ObjectImportResult + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ImportIdentityProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-identity-profiles +List Identity Profiles +Get a list of identity profiles, based on the specified query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-profiles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListIdentityProfilesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* | + **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: **id, name, priority, created, modified, owner.id, owner.name** | + +### Return type + +[**[]IdentityProfile**](../models/identity-profile) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) + sorters := `id,name` // 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: **id, name, priority, created, modified, owner.id, owner.name** (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: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.ListIdentityProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.ListIdentityProfiles(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ListIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityProfiles`: []IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ListIdentityProfiles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## show-identity-preview +Generate Identity Profile Preview +Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. +This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/show-identity-preview) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiShowIdentityPreviewRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityPreviewRequest** | [**IdentityPreviewRequest**](../models/identity-preview-request) | Identity Preview request body. | + +### Return type + +[**IdentityPreviewResponse**](../models/identity-preview-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identitypreviewrequest := []byte(`{ + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + }`) // IdentityPreviewRequest | Identity Preview request body. + + + var identityPreviewRequest v3.IdentityPreviewRequest + if err := json.Unmarshal(identitypreviewrequest, &identityPreviewRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.ShowIdentityPreview(context.Background()).IdentityPreviewRequest(identityPreviewRequest).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.ShowIdentityPreview(context.Background()).IdentityPreviewRequest(identityPreviewRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ShowIdentityPreview``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ShowIdentityPreview`: IdentityPreviewResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ShowIdentityPreview`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## sync-identity-profile +Process identities under profile +Process identities under the profile +This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. +This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. +This operation will perform the following activities on all identities under the identity profile. +1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/sync-identity-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | The Identity Profile ID to be processed | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSyncIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | The Identity Profile ID to be processed # string | The Identity Profile ID to be processed + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.SyncIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.SyncIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.SyncIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SyncIdentityProfile`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.SyncIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-identity-profile +Update Identity Profile +Update a specified identity profile with this PATCH request. + +You cannot update these fields: +* id +* created +* modified +* identityCount +* identityRefreshRequired +* Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-identity-profile) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateIdentityProfileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +[**IdentityProfile**](../models/identity-profile) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + jsonpatchoperation := []byte(`[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]`) // []JsonPatchOperation | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.UpdateIdentityProfile(context.Background(), identityProfileId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.UpdateIdentityProfile(context.Background(), identityProfileId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.UpdateIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.UpdateIdentityProfile`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/Index.md b/docs/tools/sdk/go/Reference/V3/Methods/Index.md new file mode 100644 index 000000000..f8dfa766b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/Index.md @@ -0,0 +1,29 @@ +--- +id: methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_class_name: methods +keywords: ['go', 'Golang', 'sdk', 'methods'] +slug: /tools/sdk/go/v3/methods +tags: ['SDK', 'Software Development Kit', 'v3', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the Python SDK for **V3** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/docs/tools/sdk/go/Reference/V3/Methods/LifecycleStatesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/LifecycleStatesAPI.md new file mode 100644 index 000000000..8a55b41d9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/LifecycleStatesAPI.md @@ -0,0 +1,524 @@ +--- +id: lifecycle-states +title: LifecycleStates +pagination_label: LifecycleStates +sidebar_label: LifecycleStates +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LifecycleStates', 'LifecycleStates'] +slug: /tools/sdk/go/v3/methods/lifecycle-states +tags: ['SDK', 'Software Development Kit', 'LifecycleStates', 'LifecycleStates'] +--- + +# LifecycleStatesAPI + Use this API to implement and customize lifecycle state functionality. +With this functionality in place, administrators can create and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have. + +A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with Identity Security Cloud: 'Active' and 'Inactive.' +When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. +The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. +This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. + +Administrators can create a variety of custom lifecycle states. Refer to [Planning New Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#planning-new-lifecycle-states) for some custom lifecycle state ideas. + +Administrators must define the criteria for being in each lifecycle state, and they must define how Identity Security Cloud manages users' access to apps and sources for each lifecycle state. + +In Identity Security Cloud, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to either select the lifecycle state they want to modify or create a new lifecycle state. + +In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: + +- Enable/disable the lifecycle state for the identity profile. + +- Enable/disable source accounts for the identity profile's lifecycle state. + +- Add existing access profiles to grant to the identity profiles in that lifecycle state. + +- Create a new access profile to grant to the identity profile in that lifecycle state. + +Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. +To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. +For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states. + +During scheduled refreshes, Identity Security Cloud evaluates lifecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. +If the identities are missing access, Identity Security Cloud provisions that access. + +Administrators can also use the 'Provisioning' tab to configure email notifications for Identity Security Cloud to send whenever an identity with that identity profile has a lifecycle state change. +Refer to [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so. + +An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' +Refer to [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. + +Refer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-lifecycle-state**](#create-lifecycle-state) | **Post** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create Lifecycle State +[**delete-lifecycle-state**](#delete-lifecycle-state) | **Delete** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete Lifecycle State +[**get-lifecycle-state**](#get-lifecycle-state) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State +[**get-lifecycle-states**](#get-lifecycle-states) | **Get** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists LifecycleStates +[**set-lifecycle-state**](#set-lifecycle-state) | **Post** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State +[**update-lifecycle-states**](#update-lifecycle-states) | **Patch** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State + + +## create-lifecycle-state +Create Lifecycle State +Use this endpoint to create a lifecycle state. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-lifecycle-state) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateLifecycleStateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **lifecycleState** | [**LifecycleState**](../models/lifecycle-state) | Lifecycle state to be created. | + +### Return type + +[**LifecycleState**](../models/lifecycle-state) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile ID. + lifecyclestate := []byte(`{ + "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], + "emailNotificationOption" : { + "notifyManagers" : true, + "notifySpecificUsers" : true, + "emailAddressList" : [ "test@test.com", "test2@test.com" ], + "notifyAllAdmins" : true + }, + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Lifecycle description", + "accountActions" : [ { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }, { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } ], + "id" : "id12345", + "identityCount" : 42, + "technicalName" : "Technical Name", + "identityState" : "identityState", + "enabled" : true + }`) // LifecycleState | Lifecycle state to be created. + + + var lifecycleState v3.LifecycleState + if err := json.Unmarshal(lifecyclestate, &lifecycleState); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.LifecycleStatesAPI.CreateLifecycleState(context.Background(), identityProfileId).LifecycleState(lifecycleState).Execute() + //resp, r, err := apiClient.V3.LifecycleStatesAPI.CreateLifecycleState(context.Background(), identityProfileId).LifecycleState(lifecycleState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.CreateLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateLifecycleState`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.CreateLifecycleState`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-lifecycle-state +Delete Lifecycle State +Use this endpoint to delete the lifecycle state by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-lifecycle-state) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | +**lifecycleStateId** | **string** | Lifecycle state ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteLifecycleStateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**LifecyclestateDeleted**](../models/lifecyclestate-deleted) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.LifecycleStatesAPI.DeleteLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + //resp, r, err := apiClient.V3.LifecycleStatesAPI.DeleteLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.DeleteLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteLifecycleState`: LifecyclestateDeleted + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.DeleteLifecycleState`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-lifecycle-state +Get Lifecycle State +Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-lifecycle-state) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | +**lifecycleStateId** | **string** | Lifecycle state ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLifecycleStateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**LifecycleState**](../models/lifecycle-state) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.LifecycleStatesAPI.GetLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + //resp, r, err := apiClient.V3.LifecycleStatesAPI.GetLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.GetLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLifecycleState`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.GetLifecycleState`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-lifecycle-states +Lists LifecycleStates +Use this endpoint to list all lifecycle states by their associated identity profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-lifecycle-states) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLifecycleStatesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **created, modified** | + +### Return type + +[**[]LifecycleState**](../models/lifecycle-state) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `created,modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.LifecycleStatesAPI.GetLifecycleStates(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V3.LifecycleStatesAPI.GetLifecycleStates(context.Background(), identityProfileId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.GetLifecycleStates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLifecycleStates`: []LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.GetLifecycleStates`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-lifecycle-state +Set Lifecycle State +Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-lifecycle-state) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityId** | **string** | ID of the identity to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetLifecycleStateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **setLifecycleStateRequest** | [**SetLifecycleStateRequest**](../models/set-lifecycle-state-request) | | + +### Return type + +[**SetLifecycleState200Response**](../models/set-lifecycle-state200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identityId := `2c9180857893f1290178944561990364` // string | ID of the identity to update. # string | ID of the identity to update. + setlifecyclestaterequest := []byte(``) // SetLifecycleStateRequest | + + + var setLifecycleStateRequest v3.SetLifecycleStateRequest + if err := json.Unmarshal(setlifecyclestaterequest, &setLifecycleStateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.LifecycleStatesAPI.SetLifecycleState(context.Background(), identityId).SetLifecycleStateRequest(setLifecycleStateRequest).Execute() + //resp, r, err := apiClient.V3.LifecycleStatesAPI.SetLifecycleState(context.Background(), identityId).SetLifecycleStateRequest(setLifecycleStateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.SetLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetLifecycleState`: SetLifecycleState200Response + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.SetLifecycleState`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-lifecycle-states +Update Lifecycle State +Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-lifecycle-states) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**identityProfileId** | **string** | Identity profile ID. | +**lifecycleStateId** | **string** | Lifecycle state ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateLifecycleStatesRequest struct via the builder pattern + + +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 | + +### Return type + +[**LifecycleState**](../models/lifecycle-state) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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 + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.LifecycleStatesAPI.UpdateLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.LifecycleStatesAPI.UpdateLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.UpdateLifecycleStates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateLifecycleStates`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.UpdateLifecycleStates`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/MFAConfigurationAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/MFAConfigurationAPI.md new file mode 100644 index 000000000..bf1ab7552 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/MFAConfigurationAPI.md @@ -0,0 +1,555 @@ +--- +id: mfa-configuration +title: MFAConfiguration +pagination_label: MFAConfiguration +sidebar_label: MFAConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MFAConfiguration', 'MFAConfiguration'] +slug: /tools/sdk/go/v3/methods/mfa-configuration +tags: ['SDK', 'Software Development Kit', 'MFAConfiguration', 'MFAConfiguration'] +--- + +# MFAConfigurationAPI + Configure and test multifactor authentication (MFA) methods +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-mfa-config**](#delete-mfa-config) | **Delete** `/mfa/{method}/delete` | Delete MFA method configuration +[**get-mfa-duo-config**](#get-mfa-duo-config) | **Get** `/mfa/duo-web/config` | Configuration of Duo MFA method +[**get-mfa-kba-config**](#get-mfa-kba-config) | **Get** `/mfa/kba/config` | Configuration of KBA MFA method +[**get-mfa-okta-config**](#get-mfa-okta-config) | **Get** `/mfa/okta-verify/config` | Configuration of Okta MFA method +[**set-mfa-duo-config**](#set-mfa-duo-config) | **Put** `/mfa/duo-web/config` | Set Duo MFA configuration +[**set-mfakba-config**](#set-mfakba-config) | **Post** `/mfa/kba/config/answers` | Set MFA KBA configuration +[**set-mfa-okta-config**](#set-mfa-okta-config) | **Put** `/mfa/okta-verify/config` | Set Okta MFA configuration +[**test-mfa-config**](#test-mfa-config) | **Get** `/mfa/{method}/test` | MFA method's test configuration + + +## delete-mfa-config +Delete MFA method configuration +This API removes the configuration for the specified MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-mfa-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**method** | **string** | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteMFAConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**MfaOktaConfig**](../models/mfa-okta-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + method := `okta-verify` // string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAConfigurationAPI.DeleteMFAConfig(context.Background(), method).Execute() + //resp, r, err := apiClient.V3.MFAConfigurationAPI.DeleteMFAConfig(context.Background(), method).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.DeleteMFAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteMFAConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.DeleteMFAConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-mfa-duo-config +Configuration of Duo MFA method +This API returns the configuration of an Duo MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-mfa-duo-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMFADuoConfigRequest struct via the builder pattern + + +### Return type + +[**MfaDuoConfig**](../models/mfa-duo-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAConfigurationAPI.GetMFADuoConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.MFAConfigurationAPI.GetMFADuoConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFADuoConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFADuoConfig`: MfaDuoConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFADuoConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-mfa-kba-config +Configuration of KBA MFA method +This API returns the KBA configuration for MFA. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-mfa-kba-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMFAKbaConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **allLanguages** | **bool** | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false | + +### Return type + +[**[]KbaQuestion**](../models/kba-question) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + allLanguages := allLanguages=true // bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAConfigurationAPI.GetMFAKbaConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.MFAConfigurationAPI.GetMFAKbaConfig(context.Background()).AllLanguages(allLanguages).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFAKbaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFAKbaConfig`: []KbaQuestion + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFAKbaConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-mfa-okta-config +Configuration of Okta MFA method +This API returns the configuration of an Okta MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-mfa-okta-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMFAOktaConfigRequest struct via the builder pattern + + +### Return type + +[**MfaOktaConfig**](../models/mfa-okta-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAConfigurationAPI.GetMFAOktaConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.MFAConfigurationAPI.GetMFAOktaConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFAOktaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFAOktaConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFAOktaConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-mfa-duo-config +Set Duo MFA configuration +This API sets the configuration of an Duo MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-mfa-duo-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetMFADuoConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mfaDuoConfig** | [**MfaDuoConfig**](../models/mfa-duo-config) | | + +### Return type + +[**MfaDuoConfig**](../models/mfa-duo-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + mfaduoconfig := []byte(`{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }`) // MfaDuoConfig | + + + var mfaDuoConfig v3.MfaDuoConfig + if err := json.Unmarshal(mfaduoconfig, &mfaDuoConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAConfigurationAPI.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute() + //resp, r, err := apiClient.V3.MFAConfigurationAPI.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFADuoConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFADuoConfig`: MfaDuoConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFADuoConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-mfakba-config +Set MFA KBA configuration +This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-mfakba-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetMFAKBAConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **kbaAnswerRequestItem** | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | | + +### Return type + +[**[]KbaAnswerResponseItem**](../models/kba-answer-response-item) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + kbaanswerrequestitem := []byte(`[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]`) // []KbaAnswerRequestItem | + + + var kbaAnswerRequestItem v3.[]KbaAnswerRequestItem + if err := json.Unmarshal(kbaanswerrequestitem, &kbaAnswerRequestItem); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAConfigurationAPI.SetMFAKBAConfig(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + //resp, r, err := apiClient.V3.MFAConfigurationAPI.SetMFAKBAConfig(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFAKBAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFAKBAConfig`: []KbaAnswerResponseItem + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFAKBAConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-mfa-okta-config +Set Okta MFA configuration +This API sets the configuration of an Okta MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-mfa-okta-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetMFAOktaConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mfaOktaConfig** | [**MfaOktaConfig**](../models/mfa-okta-config) | | + +### Return type + +[**MfaOktaConfig**](../models/mfa-okta-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + mfaoktaconfig := []byte(`{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }`) // MfaOktaConfig | + + + var mfaOktaConfig v3.MfaOktaConfig + if err := json.Unmarshal(mfaoktaconfig, &mfaOktaConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAConfigurationAPI.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute() + //resp, r, err := apiClient.V3.MFAConfigurationAPI.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFAOktaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFAOktaConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFAOktaConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-mfa-config +MFA method's test configuration +This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/test-mfa-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**method** | **string** | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestMFAConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**MfaConfigTestResponse**](../models/mfa-config-test-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + method := `okta-verify` // string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAConfigurationAPI.TestMFAConfig(context.Background(), method).Execute() + //resp, r, err := apiClient.V3.MFAConfigurationAPI.TestMFAConfig(context.Background(), method).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.TestMFAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestMFAConfig`: MfaConfigTestResponse + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.TestMFAConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/MFAControllerAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/MFAControllerAPI.md new file mode 100644 index 000000000..d42f2e8f0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/MFAControllerAPI.md @@ -0,0 +1,453 @@ +--- +id: mfa-controller +title: MFAController +pagination_label: MFAController +sidebar_label: MFAController +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MFAController', 'MFAController'] +slug: /tools/sdk/go/v3/methods/mfa-controller +tags: ['SDK', 'Software Development Kit', 'MFAController', 'MFAController'] +--- + +# MFAControllerAPI + This API used for multifactor authentication functionality belong to gov-multi-auth service. This controller allow you to verify authentication by specified method +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-send-token**](#create-send-token) | **Post** `/mfa/token/send` | Create and send user token +[**ping-verification-status**](#ping-verification-status) | **Post** `/mfa/{method}/poll` | Polling MFA method by VerificationPollRequest +[**send-duo-verify-request**](#send-duo-verify-request) | **Post** `/mfa/duo-web/verify` | Verifying authentication via Duo method +[**send-kba-answers**](#send-kba-answers) | **Post** `/mfa/kba/authenticate` | Authenticate KBA provided MFA method +[**send-okta-verify-request**](#send-okta-verify-request) | **Post** `/mfa/okta-verify/verify` | Verifying authentication via Okta method +[**send-token-auth-request**](#send-token-auth-request) | **Post** `/mfa/token/authenticate` | Authenticate Token provided MFA method + + +## create-send-token +Create and send user token +This API send token request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-send-token) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSendTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sendTokenRequest** | [**SendTokenRequest**](../models/send-token-request) | | + +### Return type + +[**SendTokenResponse**](../models/send-token-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sendtokenrequest := []byte(`{ + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + }`) // SendTokenRequest | + + + var sendTokenRequest v3.SendTokenRequest + if err := json.Unmarshal(sendtokenrequest, &sendTokenRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAControllerAPI.CreateSendToken(context.Background()).SendTokenRequest(sendTokenRequest).Execute() + //resp, r, err := apiClient.V3.MFAControllerAPI.CreateSendToken(context.Background()).SendTokenRequest(sendTokenRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.CreateSendToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSendToken`: SendTokenResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.CreateSendToken`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## ping-verification-status +Polling MFA method by VerificationPollRequest +This API poll the VerificationPollRequest for the specified MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/ping-verification-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**method** | **string** | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPingVerificationStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **verificationPollRequest** | [**VerificationPollRequest**](../models/verification-poll-request) | | + +### Return type + +[**VerificationResponse**](../models/verification-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + method := `okta-verify` // string | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' # string | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + verificationpollrequest := []byte(`{ + "requestId" : "089899f13a8f4da7824996191587bab9" + }`) // VerificationPollRequest | + + + var verificationPollRequest v3.VerificationPollRequest + if err := json.Unmarshal(verificationpollrequest, &verificationPollRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAControllerAPI.PingVerificationStatus(context.Background(), method).VerificationPollRequest(verificationPollRequest).Execute() + //resp, r, err := apiClient.V3.MFAControllerAPI.PingVerificationStatus(context.Background(), method).VerificationPollRequest(verificationPollRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.PingVerificationStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PingVerificationStatus`: VerificationResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.PingVerificationStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## send-duo-verify-request +Verifying authentication via Duo method +This API Authenticates the user via Duo-Web MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-duo-verify-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendDuoVerifyRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **duoVerificationRequest** | [**DuoVerificationRequest**](../models/duo-verification-request) | | + +### Return type + +[**VerificationResponse**](../models/verification-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + duoverificationrequest := []byte(`{ + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + }`) // DuoVerificationRequest | + + + var duoVerificationRequest v3.DuoVerificationRequest + if err := json.Unmarshal(duoverificationrequest, &duoVerificationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAControllerAPI.SendDuoVerifyRequest(context.Background()).DuoVerificationRequest(duoVerificationRequest).Execute() + //resp, r, err := apiClient.V3.MFAControllerAPI.SendDuoVerifyRequest(context.Background()).DuoVerificationRequest(duoVerificationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.SendDuoVerifyRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendDuoVerifyRequest`: VerificationResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.SendDuoVerifyRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## send-kba-answers +Authenticate KBA provided MFA method +This API Authenticate user in KBA MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-kba-answers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendKbaAnswersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **kbaAnswerRequestItem** | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | | + +### Return type + +[**KbaAuthResponse**](../models/kba-auth-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + kbaanswerrequestitem := []byte(`[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]`) // []KbaAnswerRequestItem | + + + var kbaAnswerRequestItem v3.[]KbaAnswerRequestItem + if err := json.Unmarshal(kbaanswerrequestitem, &kbaAnswerRequestItem); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAControllerAPI.SendKbaAnswers(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + //resp, r, err := apiClient.V3.MFAControllerAPI.SendKbaAnswers(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.SendKbaAnswers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendKbaAnswers`: KbaAuthResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.SendKbaAnswers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## send-okta-verify-request +Verifying authentication via Okta method +This API Authenticates the user via Okta-Verify MFA method. Request requires a header called 'slpt-forwarding', and it must contain a remote IP Address of caller. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-okta-verify-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendOktaVerifyRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **oktaVerificationRequest** | [**OktaVerificationRequest**](../models/okta-verification-request) | | + +### Return type + +[**VerificationResponse**](../models/verification-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + oktaverificationrequest := []byte(`{ + "userId" : "example@mail.com" + }`) // OktaVerificationRequest | + + + var oktaVerificationRequest v3.OktaVerificationRequest + if err := json.Unmarshal(oktaverificationrequest, &oktaVerificationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAControllerAPI.SendOktaVerifyRequest(context.Background()).OktaVerificationRequest(oktaVerificationRequest).Execute() + //resp, r, err := apiClient.V3.MFAControllerAPI.SendOktaVerifyRequest(context.Background()).OktaVerificationRequest(oktaVerificationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.SendOktaVerifyRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendOktaVerifyRequest`: VerificationResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.SendOktaVerifyRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## send-token-auth-request +Authenticate Token provided MFA method +This API Authenticate user in Token MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-token-auth-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendTokenAuthRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tokenAuthRequest** | [**TokenAuthRequest**](../models/token-auth-request) | | + +### Return type + +[**TokenAuthResponse**](../models/token-auth-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + tokenauthrequest := []byte(`{ + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + }`) // TokenAuthRequest | + + + var tokenAuthRequest v3.TokenAuthRequest + if err := json.Unmarshal(tokenauthrequest, &tokenAuthRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAControllerAPI.SendTokenAuthRequest(context.Background()).TokenAuthRequest(tokenAuthRequest).Execute() + //resp, r, err := apiClient.V3.MFAControllerAPI.SendTokenAuthRequest(context.Background()).TokenAuthRequest(tokenAuthRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.SendTokenAuthRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendTokenAuthRequest`: TokenAuthResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.SendTokenAuthRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/ManagedClientsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/ManagedClientsAPI.md new file mode 100644 index 000000000..ee7cdb662 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/ManagedClientsAPI.md @@ -0,0 +1,441 @@ +--- +id: managed-clients +title: ManagedClients +pagination_label: ManagedClients +sidebar_label: ManagedClients +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClients', 'ManagedClients'] +slug: /tools/sdk/go/v3/methods/managed-clients +tags: ['SDK', 'Software Development Kit', 'ManagedClients', 'ManagedClients'] +--- + +# ManagedClientsAPI + Use this API to implement managed client functionality. +With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-managed-client**](#create-managed-client) | **Post** `/managed-clients` | Create Managed Client +[**delete-managed-client**](#delete-managed-client) | **Delete** `/managed-clients/{id}` | Delete Managed Client +[**get-managed-client**](#get-managed-client) | **Get** `/managed-clients/{id}` | Get Managed Client +[**get-managed-client-status**](#get-managed-client-status) | **Get** `/managed-clients/{id}/status` | Get Managed Client Status +[**get-managed-clients**](#get-managed-clients) | **Get** `/managed-clients` | Get Managed Clients +[**update-managed-client**](#update-managed-client) | **Patch** `/managed-clients/{id}` | Update Managed Client + + +## create-managed-client +Create Managed Client +Create a new managed client. +The API returns a result that includes the managed client ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-managed-client) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateManagedClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **managedClientRequest** | [**ManagedClientRequest**](../models/managed-client-request) | | + +### Return type + +[**ManagedClient**](../models/managed-client) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + managedclientrequest := []byte(`{ + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + }`) // ManagedClientRequest | + + + var managedClientRequest v3.ManagedClientRequest + if err := json.Unmarshal(managedclientrequest, &managedClientRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClientsAPI.CreateManagedClient(context.Background()).ManagedClientRequest(managedClientRequest).Execute() + //resp, r, err := apiClient.V3.ManagedClientsAPI.CreateManagedClient(context.Background()).ManagedClientRequest(managedClientRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.CreateManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.CreateManagedClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-managed-client +Delete Managed Client +Delete an existing managed client. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-managed-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed client ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteManagedClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ManagedClientsAPI.DeleteManagedClient(context.Background(), id).Execute() + //r, err := apiClient.V3.ManagedClientsAPI.DeleteManagedClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.DeleteManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-managed-client +Get Managed Client +Get managed client by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed client ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ManagedClient**](../models/managed-client) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClientsAPI.GetManagedClient(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.ManagedClientsAPI.GetManagedClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-managed-client-status +Get Managed Client Status +Get a managed client's status, using its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-client-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed client ID to get status for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClientStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **type_** | [**ManagedClientType**](../models/managed-client-type) | Managed client type to get status for. | + +### Return type + +[**ManagedClientStatus**](../models/managed-client-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `aClientId` // string | Managed client ID to get status for. # string | Managed client ID to get status for. + type_ := // ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClientsAPI.GetManagedClientStatus(context.Background(), id).Type_(type_).Execute() + //resp, r, err := apiClient.V3.ManagedClientsAPI.GetManagedClientStatus(context.Background(), id).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClientStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClientStatus`: ManagedClientStatus + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClientStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-managed-clients +Get Managed Clients +List managed clients. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-clients) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClientsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* | + +### Return type + +[**[]ManagedClient**](../models/managed-client) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "client name"` // 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* **name**: *eq* **clientId**: *eq* **clusterId**: *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* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClientsAPI.GetManagedClients(context.Background()).Execute() + //resp, r, err := apiClient.V3.ManagedClientsAPI.GetManagedClients(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClients``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClients`: []ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClients`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-managed-client +Update Managed Client +Update an existing managed client. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-managed-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed client ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateManagedClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | JSONPatch payload used to update the object. | + +### Return type + +[**ManagedClient**](../models/managed-client) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | JSONPatch payload used to update the object. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClientsAPI.UpdateManagedClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.ManagedClientsAPI.UpdateManagedClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.UpdateManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.UpdateManagedClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/ManagedClustersAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/ManagedClustersAPI.md new file mode 100644 index 000000000..67d8bd41b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/ManagedClustersAPI.md @@ -0,0 +1,519 @@ +--- +id: managed-clusters +title: ManagedClusters +pagination_label: ManagedClusters +sidebar_label: ManagedClusters +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusters', 'ManagedClusters'] +slug: /tools/sdk/go/v3/methods/managed-clusters +tags: ['SDK', 'Software Development Kit', 'ManagedClusters', 'ManagedClusters'] +--- + +# ManagedClustersAPI + Use this API to implement managed cluster functionality. +With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-managed-cluster**](#create-managed-cluster) | **Post** `/managed-clusters` | Create Create Managed Cluster +[**delete-managed-cluster**](#delete-managed-cluster) | **Delete** `/managed-clusters/{id}` | Delete Managed Cluster +[**get-client-log-configuration**](#get-client-log-configuration) | **Get** `/managed-clusters/{id}/log-config` | Get Managed Cluster Log Configuration +[**get-managed-cluster**](#get-managed-cluster) | **Get** `/managed-clusters/{id}` | Get Managed Cluster +[**get-managed-clusters**](#get-managed-clusters) | **Get** `/managed-clusters` | Get Managed Clusters +[**put-client-log-configuration**](#put-client-log-configuration) | **Put** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration +[**update-managed-cluster**](#update-managed-cluster) | **Patch** `/managed-clusters/{id}` | Update Managed Cluster + + +## create-managed-cluster +Create Create Managed Cluster +Create a new Managed Cluster. +The API returns a result that includes the managed cluster ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-managed-cluster) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateManagedClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **managedClusterRequest** | [**ManagedClusterRequest**](../models/managed-cluster-request) | | + +### Return type + +[**ManagedCluster**](../models/managed-cluster) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + managedclusterrequest := []byte(`{ + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + }`) // ManagedClusterRequest | + + + var managedClusterRequest v3.ManagedClusterRequest + if err := json.Unmarshal(managedclusterrequest, &managedClusterRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClustersAPI.CreateManagedCluster(context.Background()).ManagedClusterRequest(managedClusterRequest).Execute() + //resp, r, err := apiClient.V3.ManagedClustersAPI.CreateManagedCluster(context.Background()).ManagedClusterRequest(managedClusterRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.CreateManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.CreateManagedCluster`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-managed-cluster +Delete Managed Cluster +Delete an existing managed cluster. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-managed-cluster) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed cluster ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteManagedClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **removeClients** | **bool** | Flag to determine the need to delete a cluster with clients. | [default to false] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + removeClients := false // bool | Flag to determine the need to delete a cluster with clients. (optional) (default to false) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ManagedClustersAPI.DeleteManagedCluster(context.Background(), id).Execute() + //r, err := apiClient.V3.ManagedClustersAPI.DeleteManagedCluster(context.Background(), id).RemoveClients(removeClients).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.DeleteManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-client-log-configuration +Get Managed Cluster Log Configuration +Get a managed cluster's log configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-client-log-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of managed cluster to get log configuration for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetClientLogConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ClientLogConfiguration**](../models/client-log-configuration) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | ID of managed cluster to get log configuration for. # string | ID of managed cluster to get log configuration for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClustersAPI.GetClientLogConfiguration(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.ManagedClustersAPI.GetClientLogConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetClientLogConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetClientLogConfiguration`: ClientLogConfiguration + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetClientLogConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-managed-cluster +Get Managed Cluster +Get a managed cluster by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-cluster) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed cluster ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ManagedCluster**](../models/managed-cluster) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClustersAPI.GetManagedCluster(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.ManagedClustersAPI.GetManagedCluster(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetManagedCluster`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-managed-clusters +Get Managed Clusters +List current organization's managed clusters, based on request context. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-clusters) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetManagedClustersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **operational**: *eq* | + +### Return type + +[**[]ManagedCluster**](../models/managed-cluster) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `operational eq "operation"` // 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: **operational**: *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: **operational**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClustersAPI.GetManagedClusters(context.Background()).Execute() + //resp, r, err := apiClient.V3.ManagedClustersAPI.GetManagedClusters(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetManagedClusters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClusters`: []ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetManagedClusters`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-client-log-configuration +Update Managed Cluster Log Configuration +Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-client-log-configuration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the managed cluster to update the log configuration for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutClientLogConfigurationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **putClientLogConfigurationRequest** | [**PutClientLogConfigurationRequest**](../models/put-client-log-configuration-request) | Client log configuration for the given managed cluster. | + +### Return type + +[**ClientLogConfiguration**](../models/client-log-configuration) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | ID of the managed cluster to update the log configuration for. # string | ID of the managed cluster to update the log configuration for. + putclientlogconfigurationrequest := []byte(``) // PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + + + var putClientLogConfigurationRequest v3.PutClientLogConfigurationRequest + if err := json.Unmarshal(putclientlogconfigurationrequest, &putClientLogConfigurationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClustersAPI.PutClientLogConfiguration(context.Background(), id).PutClientLogConfigurationRequest(putClientLogConfigurationRequest).Execute() + //resp, r, err := apiClient.V3.ManagedClustersAPI.PutClientLogConfiguration(context.Background(), id).PutClientLogConfigurationRequest(putClientLogConfigurationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.PutClientLogConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutClientLogConfiguration`: ClientLogConfiguration + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.PutClientLogConfiguration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-managed-cluster +Update Managed Cluster +Update an existing managed cluster. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-managed-cluster) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Managed cluster ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateManagedClusterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | JSONPatch payload used to update the object. | + +### Return type + +[**ManagedCluster**](../models/managed-cluster) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | JSONPatch payload used to update the object. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClustersAPI.UpdateManagedCluster(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.ManagedClustersAPI.UpdateManagedCluster(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.UpdateManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.UpdateManagedCluster`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/NonEmployeeLifecycleManagementAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/NonEmployeeLifecycleManagementAPI.md new file mode 100644 index 000000000..e48b86aec --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/NonEmployeeLifecycleManagementAPI.md @@ -0,0 +1,2406 @@ +--- +id: non-employee-lifecycle-management +title: NonEmployeeLifecycleManagement +pagination_label: NonEmployeeLifecycleManagement +sidebar_label: NonEmployeeLifecycleManagement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeLifecycleManagement', 'NonEmployeeLifecycleManagement'] +slug: /tools/sdk/go/v3/methods/non-employee-lifecycle-management +tags: ['SDK', 'Software Development Kit', 'NonEmployeeLifecycleManagement', 'NonEmployeeLifecycleManagement'] +--- + +# NonEmployeeLifecycleManagementAPI + Use this API to implement non-employee lifecycle management functionality. +With this functionality in place, administrators can create non-employee records and configure them for use in their organizations. +This allows organizations to provide secure access to non-employees and control that access. + +The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. +Organizations can track non-employees' access and activity in Identity Security Cloud by creating and maintaining non-employee sources. +Organizations can have a maximum of 50 non-employee sources. + +By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following: + +- SailPoint is not responsible for storing sensitive data. +You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in Identity Security Cloud. + +- You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts. + +To manage non-employees in Identity Security Cloud, administrators must create a non-employee source and add accounts to the source. + +To create a non-employee source in Identity Security Cloud, administrators must use the Admin panel to go to Connections > Sources. +They must then specify 'Non-Employee' in the 'Source Type' field. +Refer to [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources. + +To add accounts to a non-employee source in Identity Security Cloud, administrators can select the non-employee source and add the accounts. +They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. + +Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. +To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. +Refer to [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources. + +Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. + +Refer to [Managing Non-Employee Sources and Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html) for more information about non-employee lifecycle management. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-non-employee-request**](#approve-non-employee-request) | **Post** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request +[**create-non-employee-record**](#create-non-employee-record) | **Post** `/non-employee-records` | Create Non-Employee Record +[**create-non-employee-request**](#create-non-employee-request) | **Post** `/non-employee-requests` | Create Non-Employee Request +[**create-non-employee-source**](#create-non-employee-source) | **Post** `/non-employee-sources` | Create Non-Employee Source +[**create-non-employee-source-schema-attributes**](#create-non-employee-source-schema-attributes) | **Post** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new Schema Attribute for Non-Employee Source +[**delete-non-employee-record**](#delete-non-employee-record) | **Delete** `/non-employee-records/{id}` | Delete Non-Employee Record +[**delete-non-employee-records-in-bulk**](#delete-non-employee-records-in-bulk) | **Post** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records +[**delete-non-employee-request**](#delete-non-employee-request) | **Delete** `/non-employee-requests/{id}` | Delete Non-Employee Request +[**delete-non-employee-schema-attribute**](#delete-non-employee-schema-attribute) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a Schema Attribute for Non-Employee Source +[**delete-non-employee-source**](#delete-non-employee-source) | **Delete** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source +[**delete-non-employee-source-schema-attributes**](#delete-non-employee-source-schema-attributes) | **Delete** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for Non-Employee Source +[**export-non-employee-records**](#export-non-employee-records) | **Get** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV +[**export-non-employee-source-schema-template**](#export-non-employee-source-schema-template) | **Get** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template +[**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-bulk-upload-status**](#get-non-employee-bulk-upload-status) | **Get** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Obtain the status of bulk upload on the source +[**get-non-employee-record**](#get-non-employee-record) | **Get** `/non-employee-records/{id}` | Get a Non-Employee Record +[**get-non-employee-request**](#get-non-employee-request) | **Get** `/non-employee-requests/{id}` | Get a Non-Employee Request +[**get-non-employee-request-summary**](#get-non-employee-request-summary) | **Get** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests +[**get-non-employee-schema-attribute**](#get-non-employee-schema-attribute) | **Get** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source +[**get-non-employee-source**](#get-non-employee-source) | **Get** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source +[**get-non-employee-source-schema-attributes**](#get-non-employee-source-schema-attributes) | **Get** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source +[**import-non-employee-records-in-bulk**](#import-non-employee-records-in-bulk) | **Post** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records +[**list-non-employee-approvals**](#list-non-employee-approvals) | **Get** `/non-employee-approvals` | Get List of Non-Employee Approval Requests +[**list-non-employee-records**](#list-non-employee-records) | **Get** `/non-employee-records` | List Non-Employee Records +[**list-non-employee-requests**](#list-non-employee-requests) | **Get** `/non-employee-requests` | List Non-Employee Requests +[**list-non-employee-sources**](#list-non-employee-sources) | **Get** `/non-employee-sources` | List Non-Employee Sources +[**patch-non-employee-record**](#patch-non-employee-record) | **Patch** `/non-employee-records/{id}` | Patch Non-Employee Record +[**patch-non-employee-schema-attribute**](#patch-non-employee-schema-attribute) | **Patch** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a Schema Attribute for Non-Employee Source +[**patch-non-employee-source**](#patch-non-employee-source) | **Patch** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source +[**reject-non-employee-request**](#reject-non-employee-request) | **Post** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request +[**update-non-employee-record**](#update-non-employee-record) | **Put** `/non-employee-records/{id}` | Update Non-Employee Record + + +## approve-non-employee-request +Approve a Non-Employee Request +Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-non-employee-request) + +### 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 apiApproveNonEmployeeRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **nonEmployeeApprovalDecision** | [**NonEmployeeApprovalDecision**](../models/non-employee-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" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + nonemployeeapprovaldecision := []byte(`{ + "comment" : "Approved by manager" + }`) // NonEmployeeApprovalDecision | + + + var nonEmployeeApprovalDecision v3.NonEmployeeApprovalDecision + if err := json.Unmarshal(nonemployeeapprovaldecision, &nonEmployeeApprovalDecision); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest(context.Background(), id).NonEmployeeApprovalDecision(nonEmployeeApprovalDecision).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest(context.Background(), id).NonEmployeeApprovalDecision(nonEmployeeApprovalDecision).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveNonEmployeeRequest`: NonEmployeeApprovalItem + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-non-employee-record +Create Non-Employee Record +This request will create a non-employee record. +Requires role context of `idn:nesr:create` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-record) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nonEmployeeRequestBody** | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | Non-Employee record creation request body. | + +### Return type + +[**NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-Employee record creation request body. + + + var nonEmployeeRequestBody v3.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-non-employee-request +Create Non-Employee Request +This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-request) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNonEmployeeRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nonEmployeeRequestBody** | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | Non-Employee creation request body | + +### Return type + +[**NonEmployeeRequest**](../models/non-employee-request) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-Employee creation request body + + + var nonEmployeeRequestBody v3.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeRequest`: NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-non-employee-source +Create Non-Employee Source +Create a non-employee source. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-source) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNonEmployeeSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **nonEmployeeSourceRequestBody** | [**NonEmployeeSourceRequestBody**](../models/non-employee-source-request-body) | Non-Employee source creation request body. | + +### Return type + +[**NonEmployeeSourceWithCloudExternalId**](../models/non-employee-source-with-cloud-external-id) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + nonemployeesourcerequestbody := []byte(`{ + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + }`) // NonEmployeeSourceRequestBody | Non-Employee source creation request body. + + + var nonEmployeeSourceRequestBody v3.NonEmployeeSourceRequestBody + if err := json.Unmarshal(nonemployeesourcerequestbody, &nonEmployeeSourceRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource(context.Background()).NonEmployeeSourceRequestBody(nonEmployeeSourceRequestBody).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource(context.Background()).NonEmployeeSourceRequestBody(nonEmployeeSourceRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeSource`: NonEmployeeSourceWithCloudExternalId + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-non-employee-source-schema-attributes +Create a new Schema Attribute for Non-Employee Source +This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. +Requires role context of `idn:nesr:create` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-source-schema-attributes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateNonEmployeeSourceSchemaAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **nonEmployeeSchemaAttributeBody** | [**NonEmployeeSchemaAttributeBody**](../models/non-employee-schema-attribute-body) | | + +### Return type + +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + nonemployeeschemaattributebody := []byte(`{ + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + }`) // NonEmployeeSchemaAttributeBody | + + + var nonEmployeeSchemaAttributeBody v3.NonEmployeeSchemaAttributeBody + if err := json.Unmarshal(nonemployeeschemaattributebody, &nonEmployeeSchemaAttributeBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).NonEmployeeSchemaAttributeBody(nonEmployeeSchemaAttributeBody).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).NonEmployeeSchemaAttributeBody(nonEmployeeSchemaAttributeBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeSourceSchemaAttributes`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-non-employee-record +Delete Non-Employee Record +This request will delete a non-employee record. +Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-record) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-Employee record id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-Employee record id (UUID) # string | Non-Employee record id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord(context.Background(), id).Execute() + //r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-records-in-bulk +Delete Multiple Non-Employee Records +This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-records-in-bulk) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeRecordsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **deleteNonEmployeeRecordsInBulkRequest** | [**DeleteNonEmployeeRecordsInBulkRequest**](../models/delete-non-employee-records-in-bulk-request) | Non-Employee bulk delete request body. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + deletenonemployeerecordsinbulkrequest := []byte(``) // DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. + + + var deleteNonEmployeeRecordsInBulkRequest v3.DeleteNonEmployeeRecordsInBulkRequest + if err := json.Unmarshal(deletenonemployeerecordsinbulkrequest, &deleteNonEmployeeRecordsInBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk(context.Background()).DeleteNonEmployeeRecordsInBulkRequest(deleteNonEmployeeRecordsInBulkRequest).Execute() + //r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk(context.Background()).DeleteNonEmployeeRecordsInBulkRequest(deleteNonEmployeeRecordsInBulkRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-request +Delete Non-Employee Request +This request will delete a non-employee request. +Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-Employee request id in the UUID format | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ac110005-7156-1150-8171-5b292e3e0084` // string | Non-Employee request id in the UUID format # string | Non-Employee request id in the UUID format + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest(context.Background(), id).Execute() + //r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-schema-attribute +Delete a Schema Attribute for Non-Employee Source +This end-point deletes a specific schema attribute for a non-employee source. +Requires role context of `idn:nesr:delete` + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-schema-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**attributeId** | **string** | The Schema Attribute Id (UUID) | +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeSchemaAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + //r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-source +Delete Non-Employee Source +This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-source) + +### 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 apiDeleteNonEmployeeSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id # string | Source Id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource(context.Background(), sourceId).Execute() + //r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-non-employee-source-schema-attributes +Delete all custom schema attributes for Non-Employee Source +This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-source-schema-attributes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNonEmployeeSourceSchemaAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + //r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[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. Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/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 := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id (UUID) # string | Source Id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ExportNonEmployeeRecords(context.Background(), id).Execute() + //r, err := apiClient.V3.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. Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/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 := `ef38f94347e94562b5bb8424a56397d8` // string | Source Id (UUID) # string | Source Id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ExportNonEmployeeSourceSchemaTemplate(context.Background(), id).Execute() + //r, err := apiClient.V3.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 +Gets a non-employee approval item detail. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they +can get any approval. + 2. The user owns the requested approval. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-approval) + +### 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 apiGetNonEmployeeApprovalRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeDetail** | **bool** | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* | + +### Return type + +[**NonEmployeeApprovalItemDetail**](../models/non-employee-approval-item-detail) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + includeDetail := true // bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval(context.Background(), id).IncludeDetail(includeDetail).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeApproval`: NonEmployeeApprovalItemDetail + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-approval-summary +Get Summary of Non-Employee Approval Requests +This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. + 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/v3/get-non-employee-approval-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**requestedFor** | **string** | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeApprovalSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeApprovalSummary**](../models/non-employee-approval-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary(context.Background(), requestedFor).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary(context.Background(), requestedFor).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeApprovalSummary`: NonEmployeeApprovalSummary + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-bulk-upload-status +Obtain the status of bulk upload on the source +The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. +Requires role context of `idn:nesr:read` + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-bulk-upload-status) + +### 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 apiGetNonEmployeeBulkUploadStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeBulkUploadStatus**](../models/non-employee-bulk-upload-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Source ID (UUID) # string | Source ID (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeBulkUploadStatus`: NonEmployeeBulkUploadStatus + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-record +Get a Non-Employee Record +This gets a non-employee record. +Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-record) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-Employee record id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-Employee record id (UUID) # string | Non-Employee record id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-request +Get a Non-Employee Request +This gets a non-employee request. +There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in this case the user +can get the non-employee request for any user. + 2. The user must be the owner of the non-employee request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-request) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-Employee request id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeRequestRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeRequest**](../models/non-employee-request) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ac110005-7156-1150-8171-5b292e3e0084` // string | Non-Employee request id (UUID) # string | Non-Employee request id (UUID) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRequest`: NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-request-summary +Get Summary of Non-Employee Requests +This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. + 2. The current user is an account manager, in which case "me" should be +provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-request-summary) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**requestedFor** | **string** | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeRequestSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeRequestSummary**](../models/non-employee-request-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary(context.Background(), requestedFor).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary(context.Background(), requestedFor).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRequestSummary`: NonEmployeeRequestSummary + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-schema-attribute +Get Schema Attribute Non-Employee Source +This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-schema-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**attributeId** | **string** | The Schema Attribute Id (UUID) | +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeSchemaAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeSchemaAttribute`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-source +Get a Non-Employee Source +This gets a non-employee source. There are two contextual uses for the requested-for path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request any source. + 2. The current user is an account manager, in which case the user can only +request sources that they own. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-source) + +### 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 apiGetNonEmployeeSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NonEmployeeSource**](../models/non-employee-source) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c91808b7c28b350017c2a2ec5790aa1` // string | Source Id # string | Source Id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeSource`: NonEmployeeSource + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-non-employee-source-schema-attributes +List Schema Attributes Non-Employee Source +This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. +Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-source-schema-attributes) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNonEmployeeSourceSchemaAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).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) + } + // response from `GetNonEmployeeSourceSchemaAttributes`: []NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-non-employee-records-in-bulk +Imports, or Updates, Non-Employee Records +This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/import-non-employee-records-in-bulk) + +### 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 apiImportNonEmployeeRecordsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **data** | ***os.File** | | + +### Return type + +[**NonEmployeeBulkUploadJob**](../models/non-employee-bulk-upload-job) + +### 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() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id (UUID) # string | Source Id (UUID) + data := BINARY_DATA_HERE // *os.File | # *os.File | + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk(context.Background(), id).Data(data).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk(context.Background(), id).Data(data).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportNonEmployeeRecordsInBulk`: NonEmployeeBulkUploadJob + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-non-employee-approvals +Get List of Non-Employee Approval Requests +This gets a list of non-employee approval requests. +There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they +can list the approvals for any approver. + 2. The user owns the requested approval. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-approvals) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNonEmployeeApprovalsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | The identity for whom the request was made. *me* indicates the current user. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **approvalStatus**: *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: **created, modified** | + +### Return type + +[**[]NonEmployeeApprovalItem**](../models/non-employee-approval-item) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity for whom the request was made. *me* indicates the current user. (optional) # string | The identity for whom the request was made. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `approvalStatus eq "Pending"` // 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: **approvalStatus**: *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: **approvalStatus**: *eq* (optional) + sorters := `created` // 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: **created, modified** (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: **created, modified** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals(context.Background()).RequestedFor(requestedFor).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeApprovals`: []NonEmployeeApprovalItem + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-non-employee-records +List Non-Employee Records +This gets a list of non-employee records. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. + 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-records) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNonEmployeeRecordsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** | + **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: **sourceId**: *eq* | + +### Return type + +[**[]NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `accountName,sourceId` // 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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + filters := `sourceId eq "2c91808568c529c60168cca6f90c1313"` // 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: **sourceId**: *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: **sourceId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords(context.Background()).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords(context.Background()).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeRecords`: []NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-non-employee-requests +List Non-Employee Requests +This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id. + 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 list of the non-employee requests in the source(s) he or she manages. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-requests) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNonEmployeeRequestsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestedFor** | **string** | The identity for whom the request was made. *me* indicates the current user. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** | + **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: **sourceId**: *eq* | + +### Return type + +[**[]NonEmployeeRequest**](../models/non-employee-request) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + requestedFor := `e136567de87e4d029e60b3c3c55db56d` // string | The identity for whom the request was made. *me* indicates the current user. # string | The identity for whom the request was made. *me* indicates the current user. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `created,approvalStatus` // 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + filters := `sourceId eq "2c91808568c529c60168cca6f90c1313"` // 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: **sourceId**: *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: **sourceId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests(context.Background()).RequestedFor(requestedFor).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests(context.Background()).RequestedFor(requestedFor).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeRequests`: []NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-non-employee-sources +List Non-Employee Sources +Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: + 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. + 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-sources) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListNonEmployeeSourcesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **requestedFor** | **string** | Identity the request was made for. Use 'me' to indicate the current user. | + **nonEmployeeCount** | **bool** | Flag that determines whether the API will return a non-employee count associated with the source. | [default to false] + **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, created, sourceId** | + +### Return type + +[**[]NonEmployeeSourceWithNECount**](../models/non-employee-source-with-ne-count) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + requestedFor := `me` // string | Identity the request was made for. Use 'me' to indicate the current user. (optional) # string | Identity the request was made for. Use 'me' to indicate the current user. (optional) + nonEmployeeCount := true // bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) + sorters := `name,created` // 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, created, sourceId** (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, created, sourceId** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources(context.Background()).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources(context.Background()).Limit(limit).Offset(offset).Count(count).RequestedFor(requestedFor).NonEmployeeCount(nonEmployeeCount).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeSources`: []NonEmployeeSourceWithNECount + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-non-employee-record +Patch Non-Employee Record +This request will patch a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they +update all available fields. + 2. The user is owner of the source, in this case they can only update the +end date. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-record) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-employee record id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. | + +### Return type + +[**NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-employee record id (UUID) # string | Non-employee record id (UUID) + jsonpatchoperation := []byte(`[{op=replace, path=/endDate, value=2019-08-23T18:40:35.772Z}]`) // []JsonPatchOperation | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-non-employee-schema-attribute +Patch a Schema Attribute for Non-Employee Source +This end-point patches a specific schema attribute for a non-employee SourceId. +Requires role context of `idn:nesr:update` + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-schema-attribute) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**attributeId** | **string** | The Schema Attribute Id (UUID) | +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchNonEmployeeSchemaAttributeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. | + +### Return type + +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + jsonpatchoperation := []byte(`[{op=replace, path=/label, value={new attribute label=null}}]`) // []JsonPatchOperation | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeSchemaAttribute`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-non-employee-source +Patch a Non-Employee Source +patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-source) + +### 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 apiPatchNonEmployeeSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +[**NonEmployeeSource**](../models/non-employee-source) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id # string | Source Id + jsonpatchoperation := []byte(`[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}]`) // []JsonPatchOperation | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource(context.Background(), sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource(context.Background(), sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeSource`: NonEmployeeSource + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reject-non-employee-request +Reject a Non-Employee Request +This endpoint will reject an approval item request and notify user. The current user must be the requested approver. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-non-employee-request) + +### 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" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + nonemployeerejectapprovaldecision := []byte(`{ + "comment" : "approved" + }`) // NonEmployeeRejectApprovalDecision | + + + var nonEmployeeRejectApprovalDecision v3.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.V3.NonEmployeeLifecycleManagementAPI.RejectNonEmployeeRequest(context.Background(), id).NonEmployeeRejectApprovalDecision(nonEmployeeRejectApprovalDecision).Execute() + //resp, r, err := apiClient.V3.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 +Update Non-Employee Record +This request will update a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they +update all available fields. + 2. The user is owner of the source, in this case they can only update the +end date. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-non-employee-record) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Non-employee record id (UUID) | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateNonEmployeeRecordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **nonEmployeeRequestBody** | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. | + +### Return type + +[**NonEmployeeRecord**](../models/non-employee-record) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-employee record id (UUID) # string | Non-employee record id (UUID) + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + + var nonEmployeeRequestBody v3.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord(context.Background(), id).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord(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, "Full HTTP response: %v\n", r) + } + // response from `UpdateNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/OAuthClientsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/OAuthClientsAPI.md new file mode 100644 index 000000000..6792ce144 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/OAuthClientsAPI.md @@ -0,0 +1,377 @@ +--- +id: o-auth-clients +title: OAuthClients +pagination_label: OAuthClients +sidebar_label: OAuthClients +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OAuthClients', 'OAuthClients'] +slug: /tools/sdk/go/v3/methods/o-auth-clients +tags: ['SDK', 'Software Development Kit', 'OAuthClients', 'OAuthClients'] +--- + +# OAuthClientsAPI + Use this API to implement OAuth client functionality. +With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the Identity Security Cloud REST API. +Refer to [Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information about OAuth and how it works with the Identity Security Cloud REST API. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-oauth-client**](#create-oauth-client) | **Post** `/oauth-clients` | Create OAuth Client +[**delete-oauth-client**](#delete-oauth-client) | **Delete** `/oauth-clients/{id}` | Delete OAuth Client +[**get-oauth-client**](#get-oauth-client) | **Get** `/oauth-clients/{id}` | Get OAuth Client +[**list-oauth-clients**](#list-oauth-clients) | **Get** `/oauth-clients` | List OAuth Clients +[**patch-oauth-client**](#patch-oauth-client) | **Patch** `/oauth-clients/{id}` | Patch OAuth Client + + +## create-oauth-client +Create OAuth Client +This creates an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-oauth-client) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateOauthClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createOAuthClientRequest** | [**CreateOAuthClientRequest**](../models/create-o-auth-client-request) | | + +### Return type + +[**CreateOAuthClientResponse**](../models/create-o-auth-client-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createoauthclientrequest := []byte(`{ + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + }`) // CreateOAuthClientRequest | + + + var createOAuthClientRequest v3.CreateOAuthClientRequest + if err := json.Unmarshal(createoauthclientrequest, &createOAuthClientRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.OAuthClientsAPI.CreateOauthClient(context.Background()).CreateOAuthClientRequest(createOAuthClientRequest).Execute() + //resp, r, err := apiClient.V3.OAuthClientsAPI.CreateOauthClient(context.Background()).CreateOAuthClientRequest(createOAuthClientRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.CreateOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateOauthClient`: CreateOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.CreateOauthClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-oauth-client +Delete OAuth Client +This deletes an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-oauth-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The OAuth client id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteOauthClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.OAuthClientsAPI.DeleteOauthClient(context.Background(), id).Execute() + //r, err := apiClient.V3.OAuthClientsAPI.DeleteOauthClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.DeleteOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-oauth-client +Get OAuth Client +This gets details of an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-oauth-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The OAuth client id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOauthClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.OAuthClientsAPI.GetOauthClient(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.OAuthClientsAPI.GetOauthClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.GetOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOauthClient`: GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.GetOauthClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-oauth-clients +List OAuth Clients +This gets a list of OAuth clients. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-oauth-clients) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListOauthClientsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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: **lastUsed**: *le, isnull* | + +### Return type + +[**[]GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + filters := `lastUsed le 2023-02-05T10:59:27.214Z` // 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.OAuthClientsAPI.ListOauthClients(context.Background()).Execute() + //resp, r, err := apiClient.V3.OAuthClientsAPI.ListOauthClients(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.ListOauthClients``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOauthClients`: []GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.ListOauthClients`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-oauth-client +Patch OAuth Client +This performs a targeted update to the field(s) of an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-oauth-client) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The OAuth client id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchOauthClientRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported | + +### Return type + +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + jsonpatchoperation := []byte(`[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}]`) // []JsonPatchOperation | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.OAuthClientsAPI.PatchOauthClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.OAuthClientsAPI.PatchOauthClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.PatchOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchOauthClient`: GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.PatchOauthClient`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/PasswordConfigurationAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/PasswordConfigurationAPI.md new file mode 100644 index 000000000..54e483068 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/PasswordConfigurationAPI.md @@ -0,0 +1,235 @@ +--- +id: password-configuration +title: PasswordConfiguration +pagination_label: PasswordConfiguration +sidebar_label: PasswordConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordConfiguration', 'PasswordConfiguration'] +slug: /tools/sdk/go/v3/methods/password-configuration +tags: ['SDK', 'Software Development Kit', 'PasswordConfiguration', 'PasswordConfiguration'] +--- + +# PasswordConfigurationAPI + Use this API to implement organization password configuration functionality. +With this functionality in place, organization administrators can create organization-specific password configurations. + +These configurations include details like custom password instructions, as well as digit token length and duration. + +Refer to [Configuring User Authentication for Password Resets](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html) for more information about organization password configuration functionality. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-org-config**](#create-password-org-config) | **Post** `/password-org-config` | Create Password Org Config +[**get-password-org-config**](#get-password-org-config) | **Get** `/password-org-config` | Get Password Org Config +[**put-password-org-config**](#put-password-org-config) | **Put** `/password-org-config` | Update Password Org Config + + +## create-password-org-config +Create Password Org Config +This API creates the password org config. Unspecified fields will use default value. +To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-password-org-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePasswordOrgConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordOrgConfig** | [**PasswordOrgConfig**](../models/password-org-config) | | + +### Return type + +[**PasswordOrgConfig**](../models/password-org-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordorgconfig := []byte(`{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }`) // PasswordOrgConfig | + + + var passwordOrgConfig v3.PasswordOrgConfig + if err := json.Unmarshal(passwordorgconfig, &passwordOrgConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordConfigurationAPI.CreatePasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + //resp, r, err := apiClient.V3.PasswordConfigurationAPI.CreatePasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.CreatePasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.CreatePasswordOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-password-org-config +Get Password Org Config +This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-org-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordOrgConfigRequest struct via the builder pattern + + +### Return type + +[**PasswordOrgConfig**](../models/password-org-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordConfigurationAPI.GetPasswordOrgConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.PasswordConfigurationAPI.GetPasswordOrgConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.GetPasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.GetPasswordOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-password-org-config +Update Password Org Config +This API updates the password org config for specified fields. Other fields will keep original value. +You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-password-org-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutPasswordOrgConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordOrgConfig** | [**PasswordOrgConfig**](../models/password-org-config) | | + +### Return type + +[**PasswordOrgConfig**](../models/password-org-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordorgconfig := []byte(`{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }`) // PasswordOrgConfig | + + + var passwordOrgConfig v3.PasswordOrgConfig + if err := json.Unmarshal(passwordorgconfig, &passwordOrgConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordConfigurationAPI.PutPasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + //resp, r, err := apiClient.V3.PasswordConfigurationAPI.PutPasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.PutPasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutPasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.PutPasswordOrgConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/PasswordDictionaryAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/PasswordDictionaryAPI.md new file mode 100644 index 000000000..c72bb85cd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/PasswordDictionaryAPI.md @@ -0,0 +1,241 @@ +--- +id: password-dictionary +title: PasswordDictionary +pagination_label: PasswordDictionary +sidebar_label: PasswordDictionary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordDictionary', 'PasswordDictionary'] +slug: /tools/sdk/go/v3/methods/password-dictionary +tags: ['SDK', 'Software Development Kit', 'PasswordDictionary', 'PasswordDictionary'] +--- + +# PasswordDictionaryAPI + Use this API to implement password dictionary functionality. +With this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords. + +A password dictionary is a list of words or characters that users are prevented from including in their passwords. +This can help protect users from themselves and force them to create passwords that are not easy to break. + +A password dictionary must meet the following requirements to for the API to handle them correctly: + +- It must be in .txt format. + +- All characters must be UTF-8 characters. + +- Each line must contain a single word or character with no spaces or whitespace characters. + +- It must contain at least one line other than the locale string. + +- Each line must not exceed 128 characters. + +- The file must not exceed 2500 lines. + +Administrators should also consider the following when they create their dictionaries: + +- Lines starting with a # represent comments. + +- All words in the password dictionary are case-insensitive. +For example, adding the word "password" to the dictionary also disallows the following: PASSWORD, Password, and PassWord. + +- The dictionary uses substring matching. +For example, adding the word "spring" to the dictionary also disallows the following: Spring124, 345SprinG, and 8spring. +Users can then select 'Change Password' to update their passwords. + +Administrators must do the following to create a password dictionary: + +- Create the text file that will contain the prohibited password values. + +- If the dictionary is not in English, they must add a locale string to the top line: locale:`languageCode`_`countryCode` + +The languageCode value refers to the language's 2-letter ISO 639-1 code. +The countryCode value refers to the country's 2-letter ISO 3166-1 code. + +Refer to this list https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html to see all the available ISO 639-1 language codes and ISO 3166-1 country codes. + +- Upload the .txt file to Identity Security Cloud with [Update Password Dictionary](https://developer.sailpoint.com/docs/api/v3/put-password-dictionary). Uploading a new file always overwrites the previous dictionary file. + +Administrators can then specify which password policies check new passwords against the password dictionary by doing the following: In the Admin panel, they can use the Password Mgmt dropdown menu to select Policies, select the policy, and select the 'Prevent use of words in this site's password dictionary' checkbox beside it. + +Refer to [Configuring Advanced Password Management Options](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html) for more information about password dictionaries. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-password-dictionary**](#get-password-dictionary) | **Get** `/password-dictionary` | Get Password Dictionary +[**put-password-dictionary**](#put-password-dictionary) | **Put** `/password-dictionary` | Update Password Dictionary + + +## get-password-dictionary +Get Password Dictionary +This gets password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-dictionary) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordDictionaryRequest struct via the builder pattern + + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordDictionaryAPI.GetPasswordDictionary(context.Background()).Execute() + //resp, r, err := apiClient.V3.PasswordDictionaryAPI.GetPasswordDictionary(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordDictionaryAPI.GetPasswordDictionary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordDictionary`: string + fmt.Fprintf(os.Stdout, "Response from `PasswordDictionaryAPI.GetPasswordDictionary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-password-dictionary +Update Password Dictionary +This updates password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-password-dictionary) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutPasswordDictionaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file** | ***os.File** | | + +### Return type + + (empty response body) + +### 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() { + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.PasswordDictionaryAPI.PutPasswordDictionary(context.Background()).Execute() + //r, err := apiClient.V3.PasswordDictionaryAPI.PutPasswordDictionary(context.Background()).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordDictionaryAPI.PutPasswordDictionary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/PasswordManagementAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/PasswordManagementAPI.md new file mode 100644 index 000000000..ac9247f03 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/PasswordManagementAPI.md @@ -0,0 +1,277 @@ +--- +id: password-management +title: PasswordManagement +pagination_label: PasswordManagement +sidebar_label: PasswordManagement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordManagement', 'PasswordManagement'] +slug: /tools/sdk/go/v3/methods/password-management +tags: ['SDK', 'Software Development Kit', 'PasswordManagement', 'PasswordManagement'] +--- + +# PasswordManagementAPI + Use this API to implement password management functionality. +With this functionality in place, users can manage their identity passwords for all their applications. + +In Identity Security Cloud, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. +Password Manager lists the user's identity's applications, possibly grouped to share passwords. +Users can then select 'Change Password' to update their passwords. + +Grouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. +Password Manager may list the applications and sources in the following groups: + +- Password Group: This refers to a group of applications that share a password. +For example, a user can use the same password for Google Drive, Google Mail, and YouTube. +Updating the password for the password group updates the password for all its included applications. + +- Multi-Application Source: This refers to a source with multiple applications that share a password. +For example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. +Updating the password for the multi-application source updates the password for all its included applications. + +- Applications: These are applications that do not share passwords with other applications. + +An organization may require some authentication for users to update their passwords. +Users may be required to answer security questions or use a third-party authenticator before they can confirm their updates. + +Refer to [Managing Passwords](https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html) for more information about password management. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-password-change-status**](#get-password-change-status) | **Get** `/password-change-status/{id}` | Get Password Change Request Status +[**query-password-info**](#query-password-info) | **Post** `/query-password-info` | Query Password Info +[**set-password**](#set-password) | **Post** `/set-password` | Set Identity's Password + + +## get-password-change-status +Get Password Change Request Status +This API returns the status of a password change request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-change-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Password change request ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordChangeStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**PasswordStatus**](../models/password-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `089899f13a8f4da7824996191587bab9` // string | Password change request ID # string | Password change request ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordManagementAPI.GetPasswordChangeStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.PasswordManagementAPI.GetPasswordChangeStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.GetPasswordChangeStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordChangeStatus`: PasswordStatus + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.GetPasswordChangeStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## query-password-info +Query Password Info +This API is used to query password related information. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/query-password-info) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiQueryPasswordInfoRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordInfoQueryDTO** | [**PasswordInfoQueryDTO**](../models/password-info-query-dto) | | + +### Return type + +[**PasswordInfo**](../models/password-info) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordinfoquerydto := []byte(`{ + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + }`) // PasswordInfoQueryDTO | + + + var passwordInfoQueryDTO v3.PasswordInfoQueryDTO + if err := json.Unmarshal(passwordinfoquerydto, &passwordInfoQueryDTO); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordManagementAPI.QueryPasswordInfo(context.Background()).PasswordInfoQueryDTO(passwordInfoQueryDTO).Execute() + //resp, r, err := apiClient.V3.PasswordManagementAPI.QueryPasswordInfo(context.Background()).PasswordInfoQueryDTO(passwordInfoQueryDTO).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.QueryPasswordInfo``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `QueryPasswordInfo`: PasswordInfo + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.QueryPasswordInfo`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-password +Set Identity's Password +This API is used to set a password for an identity. + +An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). + +>**Note: If you want to set an identity's source account password, you must enable `PASSWORD` as one of the source's features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** + +To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: + +```bash +echo -n "myPassword" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 +``` + +In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. + +To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. + +If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. + +You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-password) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetPasswordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordChangeRequest** | [**PasswordChangeRequest**](../models/password-change-request) | | + +### Return type + +[**PasswordChangeResponse**](../models/password-change-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordchangerequest := []byte(`{ + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + }`) // PasswordChangeRequest | + + + var passwordChangeRequest v3.PasswordChangeRequest + if err := json.Unmarshal(passwordchangerequest, &passwordChangeRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordManagementAPI.SetPassword(context.Background()).PasswordChangeRequest(passwordChangeRequest).Execute() + //resp, r, err := apiClient.V3.PasswordManagementAPI.SetPassword(context.Background()).PasswordChangeRequest(passwordChangeRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.SetPassword``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetPassword`: PasswordChangeResponse + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.SetPassword`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/PasswordPoliciesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/PasswordPoliciesAPI.md new file mode 100644 index 000000000..e9e2849a9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/PasswordPoliciesAPI.md @@ -0,0 +1,435 @@ +--- +id: password-policies +title: PasswordPolicies +pagination_label: PasswordPolicies +sidebar_label: PasswordPolicies +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordPolicies', 'PasswordPolicies'] +slug: /tools/sdk/go/v3/methods/password-policies +tags: ['SDK', 'Software Development Kit', 'PasswordPolicies', 'PasswordPolicies'] +--- + +# PasswordPoliciesAPI + Use these APIs to implement password policies functionality. +These APIs allow you to define the policy parameters for choosing passwords. + +IdentityNow comes with a default policy that you can modify to define the password requirements your users must meet to log in to IdentityNow, such as requiring a minimum password length, including special characters, and disallowing certain patterns. +If you have licensed Password Management, you can create additional password policies beyond the default one to manage passwords for supported sources in your org. + +In the Identity Security Cloud Admin panel, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/pwd_policies/pwd_policies.html) for more information about password policies. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-policy**](#create-password-policy) | **Post** `/password-policies` | Create Password Policy +[**delete-password-policy**](#delete-password-policy) | **Delete** `/password-policies/{id}` | Delete Password Policy by ID +[**get-password-policy-by-id**](#get-password-policy-by-id) | **Get** `/password-policies/{id}` | Get Password Policy by ID +[**list-password-policies**](#list-password-policies) | **Get** `/password-policies` | List Password Policies +[**set-password-policy**](#set-password-policy) | **Put** `/password-policies/{id}` | Update Password Policy by ID + + +## create-password-policy +Create Password Policy +This API creates the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-password-policy) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePasswordPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordPolicyV3Dto** | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | | + +### Return type + +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordpolicyv3dto := []byte(`{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }`) // PasswordPolicyV3Dto | + + + var passwordPolicyV3Dto v3.PasswordPolicyV3Dto + if err := json.Unmarshal(passwordpolicyv3dto, &passwordPolicyV3Dto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordPoliciesAPI.CreatePasswordPolicy(context.Background()).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + //resp, r, err := apiClient.V3.PasswordPoliciesAPI.CreatePasswordPolicy(context.Background()).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.CreatePasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordPolicy`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.CreatePasswordPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-password-policy +Delete Password Policy by ID +This API deletes the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-password-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password policy to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePasswordPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ff808081838d9e9d01838da6a03e0002` // string | The ID of password policy to delete. # string | The ID of password policy to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.PasswordPoliciesAPI.DeletePasswordPolicy(context.Background(), id).Execute() + //r, err := apiClient.V3.PasswordPoliciesAPI.DeletePasswordPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.DeletePasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-password-policy-by-id +Get Password Policy by ID +This API returns the password policy for the specified ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-policy-by-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password policy to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordPolicyByIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ff808081838d9e9d01838da6a03e0005` // string | The ID of password policy to retrieve. # string | The ID of password policy to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordPoliciesAPI.GetPasswordPolicyById(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.PasswordPoliciesAPI.GetPasswordPolicyById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.GetPasswordPolicyById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordPolicyById`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.GetPasswordPolicyById`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-password-policies +List Password Policies +This gets list of all Password Policies. +Requires role of ORG_ADMIN + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-password-policies) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPasswordPoliciesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordPoliciesAPI.ListPasswordPolicies(context.Background()).Execute() + //resp, r, err := apiClient.V3.PasswordPoliciesAPI.ListPasswordPolicies(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.ListPasswordPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPasswordPolicies`: []PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.ListPasswordPolicies`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-password-policy +Update Password Policy by ID +This API updates the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-password-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password policy to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetPasswordPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **passwordPolicyV3Dto** | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | | + +### Return type + +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ff808081838d9e9d01838da6a03e0007` // string | The ID of password policy to update. # string | The ID of password policy to update. + passwordpolicyv3dto := []byte(`{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }`) // PasswordPolicyV3Dto | + + + var passwordPolicyV3Dto v3.PasswordPolicyV3Dto + if err := json.Unmarshal(passwordpolicyv3dto, &passwordPolicyV3Dto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordPoliciesAPI.SetPasswordPolicy(context.Background(), id).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + //resp, r, err := apiClient.V3.PasswordPoliciesAPI.SetPasswordPolicy(context.Background(), id).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.SetPasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetPasswordPolicy`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.SetPasswordPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/PasswordSyncGroupsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/PasswordSyncGroupsAPI.md new file mode 100644 index 000000000..17f071079 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/PasswordSyncGroupsAPI.md @@ -0,0 +1,408 @@ +--- +id: password-sync-groups +title: PasswordSyncGroups +pagination_label: PasswordSyncGroups +sidebar_label: PasswordSyncGroups +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordSyncGroups', 'PasswordSyncGroups'] +slug: /tools/sdk/go/v3/methods/password-sync-groups +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroups', 'PasswordSyncGroups'] +--- + +# PasswordSyncGroupsAPI + Use this API to implement password sync group functionality. +With this functionality in place, administrators can group sources into password sync groups so that all their applications share the same password. +This allows users to update the password for all the applications in a sync group if they want, rather than updating each password individually. + +A password sync group is a group of applications that shares a password. +Administrators create these groups by grouping the applications' sources. +For example, an administrator can group the ActiveDirectory, GitHub, and G Suite sources together so that all those sources' applications can also be grouped to share a password. +A user can then update his or her password for ActiveDirectory, GitHub, Gmail, Google Drive, and Google Calendar all at once, rather then updating each one individually. + +The following are required for administrators to create a password sync group in Identity Security Cloud: + +- At least two direct connect sources connected to Identity Security Cloud and configured for Password Management. + +- Each authentication source in a sync group must have at least one application. Refer to [Adding and Resetting Application Passwords](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html#adding-and-resetting-application-passwords) for more information about adding applications to sources. + +- At least one password policy. Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/policies.html) for more information about password policies. + +In the Admin panel in Identity Security Cloud, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +To create a sync group, administrators must provide a name, choose a password policy to be enforced across the sources in the sync group, and select the sources to include in the sync group. + +Administrators can also delete sync groups in Identity Security Cloud, but they should know the following before they do: + +- Passwords related to the associated sources will become independent, so changing one will not change the others anymore. + +- Passwords for the sources' connected applications will also become independent. + +- Password policies assigned to the sync group are then assigned directly to the associated sources. +To change the password policy for a source, administrators must edit it directly. + +Once the password sync group has been created, users can update the password for the group in Password Manager. + +Refer to [Managing Password Sync Groups](https://documentation.sailpoint.com/saas/help/pwd/sync_grps.html) for more information about password sync groups. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-sync-group**](#create-password-sync-group) | **Post** `/password-sync-groups` | Create Password Sync Group +[**delete-password-sync-group**](#delete-password-sync-group) | **Delete** `/password-sync-groups/{id}` | Delete Password Sync Group by ID +[**get-password-sync-group**](#get-password-sync-group) | **Get** `/password-sync-groups/{id}` | Get Password Sync Group by ID +[**get-password-sync-groups**](#get-password-sync-groups) | **Get** `/password-sync-groups` | Get Password Sync Group List +[**update-password-sync-group**](#update-password-sync-group) | **Put** `/password-sync-groups/{id}` | Update Password Sync Group by ID + + +## create-password-sync-group +Create Password Sync Group +This API creates a password sync group based on the specifications provided. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-password-sync-group) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePasswordSyncGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **passwordSyncGroup** | [**PasswordSyncGroup**](../models/password-sync-group) | | + +### Return type + +[**PasswordSyncGroup**](../models/password-sync-group) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + passwordsyncgroup := []byte(`{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }`) // PasswordSyncGroup | + + + var passwordSyncGroup v3.PasswordSyncGroup + if err := json.Unmarshal(passwordsyncgroup, &passwordSyncGroup); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordSyncGroupsAPI.CreatePasswordSyncGroup(context.Background()).PasswordSyncGroup(passwordSyncGroup).Execute() + //resp, r, err := apiClient.V3.PasswordSyncGroupsAPI.CreatePasswordSyncGroup(context.Background()).PasswordSyncGroup(passwordSyncGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.CreatePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.CreatePasswordSyncGroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-password-sync-group +Delete Password Sync Group by ID +This API deletes the specified password sync group. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-password-sync-group) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password sync group to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePasswordSyncGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to delete. # string | The ID of password sync group to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.PasswordSyncGroupsAPI.DeletePasswordSyncGroup(context.Background(), id).Execute() + //r, err := apiClient.V3.PasswordSyncGroupsAPI.DeletePasswordSyncGroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.DeletePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-password-sync-group +Get Password Sync Group by ID +This API returns the sync group for the specified ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-sync-group) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password sync group to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordSyncGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**PasswordSyncGroup**](../models/password-sync-group) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to retrieve. # string | The ID of password sync group to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordSyncGroupsAPI.GetPasswordSyncGroup(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.PasswordSyncGroupsAPI.GetPasswordSyncGroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.GetPasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.GetPasswordSyncGroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-password-sync-groups +Get Password Sync Group List +This API returns a list of password sync groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-sync-groups) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPasswordSyncGroupsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]PasswordSyncGroup**](../models/password-sync-group) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordSyncGroupsAPI.GetPasswordSyncGroups(context.Background()).Execute() + //resp, r, err := apiClient.V3.PasswordSyncGroupsAPI.GetPasswordSyncGroups(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.GetPasswordSyncGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordSyncGroups`: []PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.GetPasswordSyncGroups`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-password-sync-group +Update Password Sync Group by ID +This API updates the specified password sync group. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-password-sync-group) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of password sync group to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdatePasswordSyncGroupRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **passwordSyncGroup** | [**PasswordSyncGroup**](../models/password-sync-group) | | + +### Return type + +[**PasswordSyncGroup**](../models/password-sync-group) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to update. # string | The ID of password sync group to update. + passwordsyncgroup := []byte(`{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }`) // PasswordSyncGroup | + + + var passwordSyncGroup v3.PasswordSyncGroup + if err := json.Unmarshal(passwordsyncgroup, &passwordSyncGroup); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordSyncGroupsAPI.UpdatePasswordSyncGroup(context.Background(), id).PasswordSyncGroup(passwordSyncGroup).Execute() + //resp, r, err := apiClient.V3.PasswordSyncGroupsAPI.UpdatePasswordSyncGroup(context.Background(), id).PasswordSyncGroup(passwordSyncGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.UpdatePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.UpdatePasswordSyncGroup`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/PersonalAccessTokensAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/PersonalAccessTokensAPI.md new file mode 100644 index 000000000..693f67a7c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/PersonalAccessTokensAPI.md @@ -0,0 +1,309 @@ +--- +id: personal-access-tokens +title: PersonalAccessTokens +pagination_label: PersonalAccessTokens +sidebar_label: PersonalAccessTokens +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PersonalAccessTokens', 'PersonalAccessTokens'] +slug: /tools/sdk/go/v3/methods/personal-access-tokens +tags: ['SDK', 'Software Development Kit', 'PersonalAccessTokens', 'PersonalAccessTokens'] +--- + +# PersonalAccessTokensAPI + Use this API to implement personal access token (PAT) functionality. +With this functionality in place, users can use PATs as an alternative to passwords for authentication in Identity Security Cloud. + +PATs embed user information into the client ID and secret. +This replaces the API clients' need to store and provide a username and password to establish a connection, improving Identity Security Cloud organizations' integration security. + +In Identity Security Cloud, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens. +They must then provide a description about the token's purpose. +They can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID. + +Refer to [Managing Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/generate_tokens.html) for more information about PATs. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-personal-access-token**](#create-personal-access-token) | **Post** `/personal-access-tokens` | Create Personal Access Token +[**delete-personal-access-token**](#delete-personal-access-token) | **Delete** `/personal-access-tokens/{id}` | Delete Personal Access Token +[**list-personal-access-tokens**](#list-personal-access-tokens) | **Get** `/personal-access-tokens` | List Personal Access Tokens +[**patch-personal-access-token**](#patch-personal-access-token) | **Patch** `/personal-access-tokens/{id}` | Patch Personal Access Token + + +## create-personal-access-token +Create Personal Access Token +This creates a personal access token. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-personal-access-token) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreatePersonalAccessTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createPersonalAccessTokenRequest** | [**CreatePersonalAccessTokenRequest**](../models/create-personal-access-token-request) | Name and scope of personal access token. | + +### Return type + +[**CreatePersonalAccessTokenResponse**](../models/create-personal-access-token-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createpersonalaccesstokenrequest := []byte(`{ + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + }`) // CreatePersonalAccessTokenRequest | Name and scope of personal access token. + + + var createPersonalAccessTokenRequest v3.CreatePersonalAccessTokenRequest + if err := json.Unmarshal(createpersonalaccesstokenrequest, &createPersonalAccessTokenRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PersonalAccessTokensAPI.CreatePersonalAccessToken(context.Background()).CreatePersonalAccessTokenRequest(createPersonalAccessTokenRequest).Execute() + //resp, r, err := apiClient.V3.PersonalAccessTokensAPI.CreatePersonalAccessToken(context.Background()).CreatePersonalAccessTokenRequest(createPersonalAccessTokenRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.CreatePersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePersonalAccessToken`: CreatePersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.CreatePersonalAccessToken`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-personal-access-token +Delete Personal Access Token +This deletes a personal access token. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-personal-access-token) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The personal access token id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeletePersonalAccessTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The personal access token id # string | The personal access token id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.PersonalAccessTokensAPI.DeletePersonalAccessToken(context.Background(), id).Execute() + //r, err := apiClient.V3.PersonalAccessTokensAPI.DeletePersonalAccessToken(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.DeletePersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## list-personal-access-tokens +List Personal Access Tokens +This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-personal-access-tokens) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListPersonalAccessTokensRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' | + **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: **lastUsed**: *le, isnull* | + +### Return type + +[**[]GetPersonalAccessTokenResponse**](../models/get-personal-access-token-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `2c9180867b50d088017b554662fb281e` // string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) # string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + filters := `lastUsed le 2023-02-05T10:59:27.214Z` // 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PersonalAccessTokensAPI.ListPersonalAccessTokens(context.Background()).Execute() + //resp, r, err := apiClient.V3.PersonalAccessTokensAPI.ListPersonalAccessTokens(context.Background()).OwnerId(ownerId).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.ListPersonalAccessTokens``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPersonalAccessTokens`: []GetPersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.ListPersonalAccessTokens`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-personal-access-token +Patch Personal Access Token +This performs a targeted update to the field(s) of a Personal Access Token. +Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-personal-access-token) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Personal Access Token id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchPersonalAccessTokenRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope | + +### Return type + +[**GetPersonalAccessTokenResponse**](../models/get-personal-access-token-response) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The Personal Access Token id # string | The Personal Access Token id + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}]`) // []JsonPatchOperation | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PersonalAccessTokensAPI.PatchPersonalAccessToken(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.PersonalAccessTokensAPI.PatchPersonalAccessToken(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.PatchPersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPersonalAccessToken`: GetPersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.PatchPersonalAccessToken`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/PublicIdentitiesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/PublicIdentitiesAPI.md new file mode 100644 index 000000000..8c6e0119c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/PublicIdentitiesAPI.md @@ -0,0 +1,95 @@ +--- +id: public-identities +title: PublicIdentities +pagination_label: PublicIdentities +sidebar_label: PublicIdentities +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentities', 'PublicIdentities'] +slug: /tools/sdk/go/v3/methods/public-identities +tags: ['SDK', 'Software Development Kit', 'PublicIdentities', 'PublicIdentities'] +--- + +# PublicIdentitiesAPI + Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/docs/api/v3/public-identities-config/) to enable non-administrators to view identities' publicly visible attributes. +With this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public. +This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-public-identities**](#get-public-identities) | **Get** `/public-identities` | Get list of public identities + + +## get-public-identities +Get list of public identities +Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-public-identities) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPublicIdentitiesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* | + **addCoreFilters** | **bool** | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. | [default to false] + **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** | + +### Return type + +[**[]PublicIdentity**](../models/public-identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `firstname eq "John"` // 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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) + addCoreFilters := false // bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to false) # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to false) + sorters := `name` // 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** (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** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PublicIdentitiesAPI.GetPublicIdentities(context.Background()).Execute() + //resp, r, err := apiClient.V3.PublicIdentitiesAPI.GetPublicIdentities(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).AddCoreFilters(addCoreFilters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesAPI.GetPublicIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPublicIdentities`: []PublicIdentity + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesAPI.GetPublicIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/PublicIdentitiesConfigAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/PublicIdentitiesConfigAPI.md new file mode 100644 index 000000000..8e2612ff3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/PublicIdentitiesConfigAPI.md @@ -0,0 +1,170 @@ +--- +id: public-identities-config +title: PublicIdentitiesConfig +pagination_label: PublicIdentitiesConfig +sidebar_label: PublicIdentitiesConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentitiesConfig', 'PublicIdentitiesConfig'] +slug: /tools/sdk/go/v3/methods/public-identities-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentitiesConfig', 'PublicIdentitiesConfig'] +--- + +# PublicIdentitiesConfigAPI + Use this API to implement public identity configuration functionality. +With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. +This can be helpful for approvers making approvals, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +By default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. +However, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc. +Administrators can use this API to make those necessary identity attributes public to non-administrators. + +For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. +If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/docs/api/v3/update-public-identity-config/) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-public-identity-config**](#get-public-identity-config) | **Get** `/public-identities-config` | Get the Public Identities Configuration +[**update-public-identity-config**](#update-public-identity-config) | **Put** `/public-identities-config` | Update the Public Identities Configuration + + +## get-public-identity-config +Get the Public Identities Configuration +Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-public-identity-config) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetPublicIdentityConfigRequest struct via the builder pattern + + +### Return type + +[**PublicIdentityConfig**](../models/public-identity-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PublicIdentitiesConfigAPI.GetPublicIdentityConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.PublicIdentitiesConfigAPI.GetPublicIdentityConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesConfigAPI.GetPublicIdentityConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPublicIdentityConfig`: PublicIdentityConfig + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesConfigAPI.GetPublicIdentityConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-public-identity-config +Update the Public Identities Configuration +Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-public-identity-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdatePublicIdentityConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **publicIdentityConfig** | [**PublicIdentityConfig**](../models/public-identity-config) | | + +### Return type + +[**PublicIdentityConfig**](../models/public-identity-config) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + publicidentityconfig := []byte(`{ + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }`) // PublicIdentityConfig | + + + var publicIdentityConfig v3.PublicIdentityConfig + if err := json.Unmarshal(publicidentityconfig, &publicIdentityConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig(context.Background()).PublicIdentityConfig(publicIdentityConfig).Execute() + //resp, r, err := apiClient.V3.PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig(context.Background()).PublicIdentityConfig(publicIdentityConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePublicIdentityConfig`: PublicIdentityConfig + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/ReportsDataExtractionAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/ReportsDataExtractionAPI.md new file mode 100644 index 000000000..a55ed990a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/ReportsDataExtractionAPI.md @@ -0,0 +1,304 @@ +--- +id: reports-data-extraction +title: ReportsDataExtraction +pagination_label: ReportsDataExtraction +sidebar_label: ReportsDataExtraction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportsDataExtraction', 'ReportsDataExtraction'] +slug: /tools/sdk/go/v3/methods/reports-data-extraction +tags: ['SDK', 'Software Development Kit', 'ReportsDataExtraction', 'ReportsDataExtraction'] +--- + +# ReportsDataExtractionAPI + Use this API to implement reports lifecycle managing and monitoring. +With this functionality in place, users can run reports, view their results, and cancel reports in progress. +This can be potentially helpful for auditing purposes. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-report**](#cancel-report) | **Post** `/reports/{id}/cancel` | Cancel Report +[**get-report**](#get-report) | **Get** `/reports/{taskResultId}` | Get Report File +[**get-report-result**](#get-report-result) | **Get** `/reports/{taskResultId}/result` | Get Report Result +[**start-report**](#start-report) | **Post** `/reports/run` | Run Report + + +## cancel-report +Cancel Report +Cancels a running report. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/cancel-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the running Report to cancel | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCancelReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `a1ed223247144cc29d23c632624b4767` // string | ID of the running Report to cancel # string | ID of the running Report to cancel + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ReportsDataExtractionAPI.CancelReport(context.Background(), id).Execute() + //r, err := apiClient.V3.ReportsDataExtractionAPI.CancelReport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.CancelReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-report +Get Report File +Gets a report in file format. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**taskResultId** | **string** | Unique identifier of the task result which handled report | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **fileFormat** | **string** | Output format of the requested report file | + **name** | **string** | preferred Report file name, by default will be used report name from task result. | + **auditable** | **bool** | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. | [default to false] + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/csv, application/pdf, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + taskResultId := `ef38f94347e94562b5bb8424a56397d8` // string | Unique identifier of the task result which handled report # string | Unique identifier of the task result which handled report + fileFormat := `csv` // string | Output format of the requested report file # string | Output format of the requested report file + name := `Identities Details Report` // string | preferred Report file name, by default will be used report name from task result. (optional) # string | preferred Report file name, by default will be used report name from task result. (optional) + auditable := true // bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to false) # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ReportsDataExtractionAPI.GetReport(context.Background(), taskResultId).FileFormat(fileFormat).Execute() + //resp, r, err := apiClient.V3.ReportsDataExtractionAPI.GetReport(context.Background(), taskResultId).FileFormat(fileFormat).Name(name).Auditable(auditable).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.GetReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.GetReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-report-result +Get Report Result +Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-report-result) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**taskResultId** | **string** | Unique identifier of the task result which handled report | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetReportResultRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **completed** | **bool** | state of task result to apply ordering when results are fetching from the DB | [default to false] + +### Return type + +[**ReportResults**](../models/report-results) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + taskResultId := `ef38f94347e94562b5bb8424a56397d8` // string | Unique identifier of the task result which handled report # string | Unique identifier of the task result which handled report + completed := true // bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to false) # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ReportsDataExtractionAPI.GetReportResult(context.Background(), taskResultId).Execute() + //resp, r, err := apiClient.V3.ReportsDataExtractionAPI.GetReportResult(context.Background(), taskResultId).Completed(completed).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.GetReportResult``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReportResult`: ReportResults + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.GetReportResult`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-report +Run Report +Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-report) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **reportDetails** | [**ReportDetails**](../models/report-details) | | + +### Return type + +[**TaskResultDetails**](../models/task-result-details) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reportdetails := []byte(`{ + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + }`) // ReportDetails | + + + var reportDetails v3.ReportDetails + if err := json.Unmarshal(reportdetails, &reportDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ReportsDataExtractionAPI.StartReport(context.Background()).ReportDetails(reportDetails).Execute() + //resp, r, err := apiClient.V3.ReportsDataExtractionAPI.StartReport(context.Background()).ReportDetails(reportDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.StartReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartReport`: TaskResultDetails + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.StartReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/RequestableObjectsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/RequestableObjectsAPI.md new file mode 100644 index 000000000..0e9a7c409 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/RequestableObjectsAPI.md @@ -0,0 +1,102 @@ +--- +id: requestable-objects +title: RequestableObjects +pagination_label: RequestableObjects +sidebar_label: RequestableObjects +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObjects', 'RequestableObjects'] +slug: /tools/sdk/go/v3/methods/requestable-objects +tags: ['SDK', 'Software Development Kit', 'RequestableObjects', 'RequestableObjects'] +--- + +# RequestableObjectsAPI + Use this API to implement requestable object functionality. +With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/docs/api/v3/access-requests/), along with their statuses. +This can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**list-requestable-objects**](#list-requestable-objects) | **Get** `/requestable-objects` | Requestable Objects List + + +## list-requestable-objects +Requestable Objects List +Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. +Any authenticated token can call this endpoint to see their requestable access items. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-requestable-objects) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListRequestableObjectsRequest struct via the builder pattern + + +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. | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, in, sw* | + **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** | + +### Return type + +[**[]RequestableObject**](../models/requestable-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +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) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw "bob"` // 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, in, sw* (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, in, sw* (optional) + sorters := `name` // 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** (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** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.RequestableObjectsAPI.ListRequestableObjects(context.Background()).Execute() + //resp, r, err := apiClient.V3.RequestableObjectsAPI.ListRequestableObjects(context.Background()).IdentityId(identityId).Types(types).Term(term).Statuses(statuses).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RequestableObjectsAPI.ListRequestableObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListRequestableObjects`: []RequestableObject + fmt.Fprintf(os.Stdout, "Response from `RequestableObjectsAPI.ListRequestableObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/RolesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/RolesAPI.md new file mode 100644 index 000000000..6ad7be7e0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/RolesAPI.md @@ -0,0 +1,743 @@ +--- +id: roles +title: Roles +pagination_label: Roles +sidebar_label: Roles +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Roles', 'Roles'] +slug: /tools/sdk/go/v3/methods/roles +tags: ['SDK', 'Software Development Kit', 'Roles', 'Roles'] +--- + +# RolesAPI + Use this API to implement and customize role functionality. +With this functionality in place, administrators can create roles and configure them for use throughout Identity Security Cloud. +Identity Security Cloud can use established criteria to automatically assign the roles to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. + +Entitlements represent the most granular level of access in Identity Security Cloud. +Access profiles represent the next level and often group entitlements. +Roles represent the broadest level of access and often group access profiles. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Roles often represent positions within organizations. +For example, an organization's accountant can access all the tools the organization's accountants need with the 'Accountant' role. +If the accountant switches to engineering, a qualified member of the organization can quickly revoke the accountant's 'Accountant' access and grant access to the 'Engineer' role instead, granting access to all the tools the organization's engineers need. + +In Identity Security Cloud, adminstrators can use the Access drop-down menu and select Roles to view, configure, and delete existing roles, as well as create new ones. +Administrators can enable and disable the role, and they can also make the following configurations: + +- Manage Access: Manage the role's access by adding or removing access profiles. + +- Define Assignment: Define the criteria Identity Security Cloud uses to assign the role to identities. +Use the first option, 'Standard Criteria,' to provide specific criteria for assignment like specific account attributes, entitlements, or identity attributes. +Use the second, 'Identity List,' to specify the identities for assignment. + +- Access Requests: Configure roles to be requestable and establish an approval process for any requests that the role be granted or revoked. +Do not configure a role to be requestable without establishing a secure access request approval process for that role first. + +Refer to [Working with Roles](https://documentation.sailpoint.com/saas/help/access/roles.html) for more information about roles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-role**](#create-role) | **Post** `/roles` | Create a Role +[**delete-bulk-roles**](#delete-bulk-roles) | **Post** `/roles/bulk-delete` | Delete Role(s) +[**delete-role**](#delete-role) | **Delete** `/roles/{id}` | Delete Role +[**get-role**](#get-role) | **Get** `/roles/{id}` | Get Role +[**get-role-assigned-identities**](#get-role-assigned-identities) | **Get** `/roles/{id}/assigned-identities` | List Identities assigned a Role +[**list-roles**](#list-roles) | **Get** `/roles` | List Roles +[**patch-role**](#patch-role) | **Patch** `/roles/{id}` | Patch Role + + +## create-role +Create a Role +This API creates a role. +In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-role) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **role** | [**Role**](../models/role) | | + +### Return type + +[**Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + role := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + }`) // Role | + + + var role v3.Role + if err := json.Unmarshal(role, &role); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.RolesAPI.CreateRole(context.Background()).Role(role).Execute() + //resp, r, err := apiClient.V3.RolesAPI.CreateRole(context.Background()).Role(role).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.CreateRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.CreateRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-bulk-roles +Delete Role(s) +This endpoint initiates a bulk deletion of one or more roles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 roles per request. +A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-bulk-roles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteBulkRolesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **roleBulkDeleteRequest** | [**RoleBulkDeleteRequest**](../models/role-bulk-delete-request) | | + +### Return type + +[**TaskResultDto**](../models/task-result-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + rolebulkdeleterequest := []byte(`{ + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + }`) // RoleBulkDeleteRequest | + + + var roleBulkDeleteRequest v3.RoleBulkDeleteRequest + if err := json.Unmarshal(rolebulkdeleterequest, &roleBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.RolesAPI.DeleteBulkRoles(context.Background()).RoleBulkDeleteRequest(roleBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V3.RolesAPI.DeleteBulkRoles(context.Background()).RoleBulkDeleteRequest(roleBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteBulkRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteBulkRoles`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.DeleteBulkRoles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-role +Delete Role +Delete a role by ID. + +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Role ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | Role ID. # string | Role ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.RolesAPI.DeleteRole(context.Background(), id).Execute() + //r, err := apiClient.V3.RolesAPI.DeleteRole(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-role +Get Role +Get a role by ID. +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Role ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | Role ID. # string | Role ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.RolesAPI.GetRole(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.RolesAPI.GetRole(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-role-assigned-identities +List Identities assigned a Role + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-role-assigned-identities) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Role for which the assigned Identities are to be listed | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRoleAssignedIdentitiesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* | + **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: **id, name, aliasName, email** | + +### Return type + +[**[]RoleIdentity**](../models/role-identity) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role for which the assigned Identities are to be listed # string | ID of the Role for which the assigned Identities are to be listed + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw Joe` // 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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + sorters := `aliasName,name` // 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: **id, name, aliasName, email** (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: **id, name, aliasName, email** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.RolesAPI.GetRoleAssignedIdentities(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.RolesAPI.GetRoleAssignedIdentities(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRoleAssignedIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleAssignedIdentities`: []RoleIdentity + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRoleAssignedIdentities`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-roles +List Roles +This API returns a list of Roles. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-roles) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListRolesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **forSubadmin** | **string** | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. | + **limit** | **int32** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to 50] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *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, created, modified** | + **forSegmentIds** | **string** | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. | + **includeUnsegmented** | **bool** | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. | [default to true] + +### Return type + +[**[]Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `requestable 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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.RolesAPI.ListRoles(context.Background()).Execute() + //resp, r, err := apiClient.V3.RolesAPI.ListRoles(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.ListRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListRoles`: []Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.ListRoles`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-role +Patch Role +Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: +* name +* description +* enabled +* owner +* accessProfiles +* entitlements +* membership +* requestable +* accessRequestConfig +* revokeRequestConfig +* segments +* accessModelMetadata + +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. + +The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are limited to 2000 characters. + +When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-role) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Role ID to patch | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchRoleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**Role**](../models/role) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808a7813090a017814121e121518` // string | Role ID to patch # string | Role ID to patch + jsonpatchoperation := []byte(`[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.RolesAPI.PatchRole(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.RolesAPI.PatchRole(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.PatchRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.PatchRole`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/SODPoliciesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/SODPoliciesAPI.md new file mode 100644 index 000000000..6538a8625 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/SODPoliciesAPI.md @@ -0,0 +1,1358 @@ +--- +id: sod-policies +title: SODPolicies +pagination_label: SODPolicies +sidebar_label: SODPolicies +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SODPolicies', 'SODPolicies'] +slug: /tools/sdk/go/v3/methods/sod-policies +tags: ['SDK', 'Software Development Kit', 'SODPolicies', 'SODPolicies'] +--- + +# SODPoliciesAPI + Use this API to implement and manage "separation of duties" (SOD) policies. +With SOD policy functionality in place, administrators can organize the access in their tenants to prevent individuals from gaining conflicting or excessive access. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +To create SOD policies in Identity Security Cloud, administrators use 'Search' and then access 'Policies'. +To create a policy, they must configure two lists of access items. Each access item can only be added to one of the two lists. +They can search for the entitlements they want to add to these access lists. + +>Note: You can have a maximum of 500 policies of any type (including general policies) in your organization. In each access-based SOD policy, you can have a maximum of 50 entitlements in each access list. + +Once a SOD policy is in place, if an identity has access items on both lists, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +To create a subscription to a SOD policy in Identity Security Cloud, administrators use 'Search' and then access 'Layers'. +They can create a subscription to the policy and schedule it to run at a regular interval. + +Refer to [Managing Policies](https://documentation.sailpoint.com/saas/help/sod/manage-policies.html) for more information about SOD policies. + +Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-sod-policy**](#create-sod-policy) | **Post** `/sod-policies` | Create SOD policy +[**delete-sod-policy**](#delete-sod-policy) | **Delete** `/sod-policies/{id}` | Delete SOD policy by ID +[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **Delete** `/sod-policies/{id}/schedule` | Delete SOD policy schedule +[**get-custom-violation-report**](#get-custom-violation-report) | **Get** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report +[**get-default-violation-report**](#get-default-violation-report) | **Get** `/sod-violation-report/{reportResultId}/download` | Download violation report +[**get-sod-all-report-run-status**](#get-sod-all-report-run-status) | **Get** `/sod-violation-report` | Get multi-report run task status +[**get-sod-policy**](#get-sod-policy) | **Get** `/sod-policies/{id}` | Get SOD policy by ID +[**get-sod-policy-schedule**](#get-sod-policy-schedule) | **Get** `/sod-policies/{id}/schedule` | Get SOD policy schedule +[**get-sod-violation-report-run-status**](#get-sod-violation-report-run-status) | **Get** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status +[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **Get** `/sod-policies/{id}/violation-report` | Get SOD violation report status +[**list-sod-policies**](#list-sod-policies) | **Get** `/sod-policies` | List SOD policies +[**patch-sod-policy**](#patch-sod-policy) | **Patch** `/sod-policies/{id}` | Patch SOD policy by ID +[**put-policy-schedule**](#put-policy-schedule) | **Put** `/sod-policies/{id}/schedule` | Update SOD Policy schedule +[**put-sod-policy**](#put-sod-policy) | **Put** `/sod-policies/{id}` | Update SOD policy by ID +[**start-evaluate-sod-policy**](#start-evaluate-sod-policy) | **Post** `/sod-policies/{id}/evaluate` | Evaluate one policy by ID +[**start-sod-all-policies-for-org**](#start-sod-all-policies-for-org) | **Post** `/sod-violation-report/run` | Runs all policies for org +[**start-sod-policy**](#start-sod-policy) | **Post** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report + + +## create-sod-policy +Create SOD policy +This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-sod-policy) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sodPolicy** | [**SodPolicy**](../models/sod-policy) | | + +### Return type + +[**SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sodpolicy := []byte(`{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }`) // SodPolicy | + + + var sodPolicy v3.SodPolicy + if err := json.Unmarshal(sodpolicy, &sodPolicy); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.CreateSodPolicy(context.Background()).SodPolicy(sodPolicy).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.CreateSodPolicy(context.Background()).SodPolicy(sodPolicy).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.CreateSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.CreateSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-sod-policy +Delete SOD policy by ID +This deletes a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD Policy to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **logical** | **bool** | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. | [default to true] + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD Policy to delete. # string | The ID of the SOD Policy to delete. + logical := true // bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to true) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SODPoliciesAPI.DeleteSodPolicy(context.Background(), id).Execute() + //r, err := apiClient.V3.SODPoliciesAPI.DeleteSodPolicy(context.Background(), id).Logical(logical).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.DeleteSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-sod-policy-schedule +Delete SOD policy schedule +This deletes schedule for a specified SOD policy by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-sod-policy-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy the schedule must be deleted for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSodPolicyScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy the schedule must be deleted for. # string | The ID of the SOD policy the schedule must be deleted for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SODPoliciesAPI.DeleteSodPolicySchedule(context.Background(), id).Execute() + //r, err := apiClient.V3.SODPoliciesAPI.DeleteSodPolicySchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.DeleteSodPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-custom-violation-report +Download custom violation report +This allows to download a specified named violation report for a given report reference. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-custom-violation-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**reportResultId** | **string** | The ID of the report reference to download. | +**fileName** | **string** | Custom Name for the file. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCustomViolationReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reportResultId := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the report reference to download. # string | The ID of the report reference to download. + fileName := `custom-name` // string | Custom Name for the file. # string | Custom Name for the file. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.GetCustomViolationReport(context.Background(), reportResultId, fileName).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.GetCustomViolationReport(context.Background(), reportResultId, fileName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetCustomViolationReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCustomViolationReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetCustomViolationReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-default-violation-report +Download violation report +This allows to download a violation report for a given report reference. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-default-violation-report) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**reportResultId** | **string** | The ID of the report reference to download. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDefaultViolationReportRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[***os.File**](https://pkg.go.dev/os) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reportResultId := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the report reference to download. # string | The ID of the report reference to download. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.GetDefaultViolationReport(context.Background(), reportResultId).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.GetDefaultViolationReport(context.Background(), reportResultId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetDefaultViolationReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDefaultViolationReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetDefaultViolationReport`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-all-report-run-status +Get multi-report run task status +This endpoint gets the status for a violation report for all policy run. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-all-report-run-status) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodAllReportRunStatusRequest struct via the builder pattern + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodAllReportRunStatus(context.Background()).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodAllReportRunStatus(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodAllReportRunStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodAllReportRunStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodAllReportRunStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-policy +Get SOD policy by ID +This gets specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD Policy to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD Policy to retrieve. # string | The ID of the SOD Policy to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-policy-schedule +Get SOD policy schedule +This endpoint gets a specified SOD policy's schedule. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-policy-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy schedule to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodPolicyScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy schedule to retrieve. # string | The ID of the SOD policy schedule to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodPolicySchedule(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodPolicySchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodPolicySchedule`: SodPolicySchedule + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodPolicySchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-violation-report-run-status +Get violation report run status +This gets the status for a violation report run task that has already been invoked. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-violation-report-run-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**reportResultId** | **string** | The ID of the report reference to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodViolationReportRunStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + reportResultId := `2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | The ID of the report reference to retrieve. # string | The ID of the report reference to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodViolationReportRunStatus(context.Background(), reportResultId).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodViolationReportRunStatus(context.Background(), reportResultId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodViolationReportRunStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodViolationReportRunStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodViolationReportRunStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-sod-violation-report-status +Get SOD violation report status +This gets the status for a violation report run task that has already been invoked. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-violation-report-status) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the violation report to retrieve status for. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSodViolationReportStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the violation report to retrieve status for. # string | The ID of the violation report to retrieve status for. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodViolationReportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodViolationReportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodViolationReportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodViolationReportStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodViolationReportStatus`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-sod-policies +List SOD policies +This gets list of all SOD policies. +Requires role of ORG_ADMIN + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-sod-policies) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSodPoliciesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, in* **state**: *eq, in* | + **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: **id, name, created, modified, description** | + +### Return type + +[**[]SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "bc693f07e7b645539626c25954c58554"` // 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, in* **state**: *eq, in* (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, in* **state**: *eq, in* (optional) + sorters := `id,name` // 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: **id, name, created, modified, description** (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: **id, name, created, modified, description** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.ListSodPolicies(context.Background()).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.ListSodPolicies(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.ListSodPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSodPolicies`: []SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.ListSodPolicies`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-sod-policy +Patch SOD policy by ID +Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Requires role of ORG_ADMIN. +This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy being modified. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria | + +### Return type + +[**SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c918083-5d19-1a86-015d-28455b4a2329` // string | The ID of the SOD policy being modified. # string | The ID of the SOD policy being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]`) // []JsonPatchOperation | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.PatchSodPolicy(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.PatchSodPolicy(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PatchSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PatchSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-policy-schedule +Update SOD Policy schedule +This updates schedule for a specified SOD policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-policy-schedule) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy to update its schedule. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutPolicyScheduleRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **sodPolicySchedule** | [**SodPolicySchedule**](../models/sod-policy-schedule) | | + +### Return type + +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy to update its schedule. # string | The ID of the SOD policy to update its schedule. + sodpolicyschedule := []byte(`{ + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }`) // SodPolicySchedule | + + + var sodPolicySchedule v3.SodPolicySchedule + if err := json.Unmarshal(sodpolicyschedule, &sodPolicySchedule); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.PutPolicySchedule(context.Background(), id).SodPolicySchedule(sodPolicySchedule).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.PutPolicySchedule(context.Background(), id).SodPolicySchedule(sodPolicySchedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PutPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutPolicySchedule`: SodPolicySchedule + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PutPolicySchedule`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-sod-policy +Update SOD policy by ID +This updates a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the SOD policy to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **sodPolicy** | [**SodPolicy**](../models/sod-policy) | | + +### Return type + +[**SodPolicy**](../models/sod-policy) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy to update. # string | The ID of the SOD policy to update. + sodpolicy := []byte(`{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }`) // SodPolicy | + + + var sodPolicy v3.SodPolicy + if err := json.Unmarshal(sodpolicy, &sodPolicy); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.PutSodPolicy(context.Background(), id).SodPolicy(sodPolicy).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.PutSodPolicy(context.Background(), id).SodPolicy(sodPolicy).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PutSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PutSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-evaluate-sod-policy +Evaluate one policy by ID +Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-evaluate-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The SOD policy ID to run. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartEvaluateSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The SOD policy ID to run. # string | The SOD policy ID to run. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.StartEvaluateSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.StartEvaluateSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartEvaluateSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartEvaluateSodPolicy`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartEvaluateSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-sod-all-policies-for-org +Runs all policies for org +Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-sod-all-policies-for-org) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartSodAllPoliciesForOrgRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **multiPolicyRequest** | [**MultiPolicyRequest**](../models/multi-policy-request) | | + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + multipolicyrequest := []byte(`{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }`) // MultiPolicyRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.StartSodAllPoliciesForOrg(context.Background()).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.StartSodAllPoliciesForOrg(context.Background()).MultiPolicyRequest(multiPolicyRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartSodAllPoliciesForOrg``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartSodAllPoliciesForOrg`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartSodAllPoliciesForOrg`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-sod-policy +Runs SOD policy violation report +This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-sod-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The SOD policy ID to run. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartSodPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ReportResultReference**](../models/report-result-reference) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The SOD policy ID to run. # string | The SOD policy ID to run. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.StartSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.StartSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartSodPolicy`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartSodPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/SODViolationsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/SODViolationsAPI.md new file mode 100644 index 000000000..fc41bf3b9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/SODViolationsAPI.md @@ -0,0 +1,186 @@ +--- +id: sod-violations +title: SODViolations +pagination_label: SODViolations +sidebar_label: SODViolations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SODViolations', 'SODViolations'] +slug: /tools/sdk/go/v3/methods/sod-violations +tags: ['SDK', 'Software Development Kit', 'SODViolations', 'SODViolations'] +--- + +# SODViolationsAPI + Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations. +With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +Once a SOD policy is in place, if an identity has conflicting access items, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. +This second option is a good way to prevent SOD violations from triggering at all. + +Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**start-predict-sod-violations**](#start-predict-sod-violations) | **Post** `/sod-violations/predict` | Predict SOD violations for identity. +[**start-violation-check**](#start-violation-check) | **Post** `/sod-violations/check` | Check SOD violations + + +## start-predict-sod-violations +Predict SOD violations for identity. +This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-predict-sod-violations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartPredictSodViolationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityWithNewAccess** | [**IdentityWithNewAccess**](../models/identity-with-new-access) | | + +### Return type + +[**ViolationPrediction**](../models/violation-prediction) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identitywithnewaccess := []byte(`{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }`) // IdentityWithNewAccess | + + + var identityWithNewAccess v3.IdentityWithNewAccess + if err := json.Unmarshal(identitywithnewaccess, &identityWithNewAccess); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODViolationsAPI.StartPredictSodViolations(context.Background()).IdentityWithNewAccess(identityWithNewAccess).Execute() + //resp, r, err := apiClient.V3.SODViolationsAPI.StartPredictSodViolations(context.Background()).IdentityWithNewAccess(identityWithNewAccess).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODViolationsAPI.StartPredictSodViolations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartPredictSodViolations`: ViolationPrediction + fmt.Fprintf(os.Stdout, "Response from `SODViolationsAPI.StartPredictSodViolations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## start-violation-check +Check SOD violations +This API initiates a SOD policy verification asynchronously. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-violation-check) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartViolationCheckRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identityWithNewAccess1** | [**IdentityWithNewAccess1**](../models/identity-with-new-access1) | | + +### Return type + +[**SodViolationCheck**](../models/sod-violation-check) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + identitywithnewaccess1 := []byte(`{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}`) // IdentityWithNewAccess1 | + + + var identityWithNewAccess1 v3.IdentityWithNewAccess1 + if err := json.Unmarshal(identitywithnewaccess1, &identityWithNewAccess1); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODViolationsAPI.StartViolationCheck(context.Background()).IdentityWithNewAccess1(identityWithNewAccess1).Execute() + //resp, r, err := apiClient.V3.SODViolationsAPI.StartViolationCheck(context.Background()).IdentityWithNewAccess1(identityWithNewAccess1).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODViolationsAPI.StartViolationCheck``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartViolationCheck`: SodViolationCheck + fmt.Fprintf(os.Stdout, "Response from `SODViolationsAPI.StartViolationCheck`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/SavedSearchAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/SavedSearchAPI.md new file mode 100644 index 000000000..bec95657e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/SavedSearchAPI.md @@ -0,0 +1,509 @@ +--- +id: saved-search +title: SavedSearch +pagination_label: SavedSearch +sidebar_label: SavedSearch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearch', 'SavedSearch'] +slug: /tools/sdk/go/v3/methods/saved-search +tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'SavedSearch'] +--- + +# SavedSearchAPI + Use this API to implement saved search functionality. +With saved search functionality in place, users can save search queries and then view those saved searches, as well as rerun them. + +Search queries in Identity Security Cloud can grow very long and specific, which can make reconstructing them difficult or tedious, so it can be especially helpful to save search queries. +It also opens the possibility to configure Identity Security Cloud to run the saved queries on a schedule, which is essential to detecting user information and access changes throughout an organization's tenant and across all its sources. +Refer to [Scheduled Search](https://developer.sailpoint.com/docs/api/v3/scheduled-search/) for more information about running saved searches on a schedule. + +In Identity Security Cloud, users can save searches under a name, and then they can access that saved search and run it again when they want. + +Refer to [Managing Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html) for more information about saving searches and using them. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-saved-search**](#create-saved-search) | **Post** `/saved-searches` | Create a saved search +[**delete-saved-search**](#delete-saved-search) | **Delete** `/saved-searches/{id}` | Delete document by ID +[**execute-saved-search**](#execute-saved-search) | **Post** `/saved-searches/{id}/execute` | Execute a saved search by ID +[**get-saved-search**](#get-saved-search) | **Get** `/saved-searches/{id}` | Return saved search by ID +[**list-saved-searches**](#list-saved-searches) | **Get** `/saved-searches` | A list of Saved Searches +[**put-saved-search**](#put-saved-search) | **Put** `/saved-searches/{id}` | Updates an existing saved search + + +## create-saved-search +Create a saved search +Creates a new saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-saved-search) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSavedSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createSavedSearchRequest** | [**CreateSavedSearchRequest**](../models/create-saved-search-request) | The saved search to persist. | + +### Return type + +[**SavedSearch**](../models/saved-search) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createsavedsearchrequest := []byte(``) // CreateSavedSearchRequest | The saved search to persist. + + + var createSavedSearchRequest v3.CreateSavedSearchRequest + if err := json.Unmarshal(createsavedsearchrequest, &createSavedSearchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SavedSearchAPI.CreateSavedSearch(context.Background()).CreateSavedSearchRequest(createSavedSearchRequest).Execute() + //resp, r, err := apiClient.V3.SavedSearchAPI.CreateSavedSearch(context.Background()).CreateSavedSearchRequest(createSavedSearchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.CreateSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.CreateSavedSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-saved-search +Delete document by ID +Deletes the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-saved-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSavedSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SavedSearchAPI.DeleteSavedSearch(context.Background(), id).Execute() + //r, err := apiClient.V3.SavedSearchAPI.DeleteSavedSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.DeleteSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## execute-saved-search +Execute a saved search by ID +Executes the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/execute-saved-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExecuteSavedSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **searchArguments** | [**SearchArguments**](../models/search-arguments) | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + searcharguments := []byte(`{ + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + }`) // SearchArguments | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + + + var searchArguments v3.SearchArguments + if err := json.Unmarshal(searcharguments, &searchArguments); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SavedSearchAPI.ExecuteSavedSearch(context.Background(), id).SearchArguments(searchArguments).Execute() + //r, err := apiClient.V3.SavedSearchAPI.ExecuteSavedSearch(context.Background(), id).SearchArguments(searchArguments).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.ExecuteSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-saved-search +Return saved search by ID +Returns the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-saved-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSavedSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SavedSearch**](../models/saved-search) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SavedSearchAPI.GetSavedSearch(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SavedSearchAPI.GetSavedSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.GetSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.GetSavedSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-saved-searches +A list of Saved Searches +Returns a list of saved searches. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-saved-searches) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSavedSearchesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **owner.id**: *eq* | + +### Return type + +[**[]SavedSearch**](../models/saved-search) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"` // 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: **owner.id**: *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: **owner.id**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SavedSearchAPI.ListSavedSearches(context.Background()).Execute() + //resp, r, err := apiClient.V3.SavedSearchAPI.ListSavedSearches(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.ListSavedSearches``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSavedSearches`: []SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.ListSavedSearches`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-saved-search +Updates an existing saved search +Updates an existing saved search. + +>**NOTE: You cannot update the `owner` of the saved search.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-saved-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSavedSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **savedSearch** | [**SavedSearch**](../models/saved-search) | The saved search to persist. | + +### Return type + +[**SavedSearch**](../models/saved-search) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + savedsearch := []byte(`{ + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + }`) // SavedSearch | The saved search to persist. + + + var savedSearch v3.SavedSearch + if err := json.Unmarshal(savedsearch, &savedSearch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SavedSearchAPI.PutSavedSearch(context.Background(), id).SavedSearch(savedSearch).Execute() + //resp, r, err := apiClient.V3.SavedSearchAPI.PutSavedSearch(context.Background(), id).SavedSearch(savedSearch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.PutSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.PutSavedSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/ScheduledSearchAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/ScheduledSearchAPI.md new file mode 100644 index 000000000..c2ef94456 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/ScheduledSearchAPI.md @@ -0,0 +1,513 @@ +--- +id: scheduled-search +title: ScheduledSearch +pagination_label: ScheduledSearch +sidebar_label: ScheduledSearch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledSearch', 'ScheduledSearch'] +slug: /tools/sdk/go/v3/methods/scheduled-search +tags: ['SDK', 'Software Development Kit', 'ScheduledSearch', 'ScheduledSearch'] +--- + +# ScheduledSearchAPI + Use this API to implement scheduled search functionality. +With scheduled search functionality in place, users can run saved search queries on their tenants on a schedule, and Identity Security Cloud emails them the search results. +Users can also share these search results with other users by email by adding those users as subscribers, or those users can subscribe themselves. + +One of the greatest benefits of saving searches is the ability to run those searches on a schedule. +This is essential for organizations to constantly detect any changes to user information or access throughout their tenants and across all their sources. +For example, the manager Amanda Ross can schedule a saved search "manager.name:amanda.ross AND attributes.location:austin" on a schedule to regularly stay aware of changes with the Austin employees reporting to her. +Identity Security Cloud emails her the search results when the search runs, so she can work on other tasks instead of actively running this search. + +In Identity Security Cloud, scheduling a search involves a subscription. +Users can create a subscription for a saved search and schedule it to run daily, weekly, or monthly (you can only use one schedule option at a time). +The user can add other identities as subscribers so when the scheduled search runs, the subscribers and the user all receive emails. + +By default, subscriptions exclude detailed results from the emails, for security purposes. +Including detailed results about user access in an email may expose sensitive information. +However, the subscription creator can choose to include the information in the emails. + +By default, Identity Security Cloud sends emails to the subscribers even when the searches do not return new results. +However, the subscription creator can choose to suppress these empty emails. + +Users can also subscribe to saved searches that already have existing subscriptions so they receive emails when the searches run. +A saved search can have up to 10 subscriptions configured at a time. + +The subscription creator can enable, disable, or delete the subscription. + +Refer to [Subscribing to Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html#subscribing-to-saved-searches) for more information about scheduling searches and subscribing to them. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-scheduled-search**](#create-scheduled-search) | **Post** `/scheduled-searches` | Create a new scheduled search +[**delete-scheduled-search**](#delete-scheduled-search) | **Delete** `/scheduled-searches/{id}` | Delete a Scheduled Search +[**get-scheduled-search**](#get-scheduled-search) | **Get** `/scheduled-searches/{id}` | Get a Scheduled Search +[**list-scheduled-search**](#list-scheduled-search) | **Get** `/scheduled-searches` | List scheduled searches +[**unsubscribe-scheduled-search**](#unsubscribe-scheduled-search) | **Post** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search +[**update-scheduled-search**](#update-scheduled-search) | **Put** `/scheduled-searches/{id}` | Update an existing Scheduled Search + + +## create-scheduled-search +Create a new scheduled search +Creates a new scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-scheduled-search) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createScheduledSearchRequest** | [**CreateScheduledSearchRequest**](../models/create-scheduled-search-request) | The scheduled search to persist. | + +### Return type + +[**ScheduledSearch**](../models/scheduled-search) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createscheduledsearchrequest := []byte(`{savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]}`) // CreateScheduledSearchRequest | The scheduled search to persist. + + + var createScheduledSearchRequest v3.CreateScheduledSearchRequest + if err := json.Unmarshal(createscheduledsearchrequest, &createScheduledSearchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ScheduledSearchAPI.CreateScheduledSearch(context.Background()).CreateScheduledSearchRequest(createScheduledSearchRequest).Execute() + //resp, r, err := apiClient.V3.ScheduledSearchAPI.CreateScheduledSearch(context.Background()).CreateScheduledSearchRequest(createScheduledSearchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.CreateScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.CreateScheduledSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-scheduled-search +Delete a Scheduled Search +Deletes the specified scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-scheduled-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ScheduledSearchAPI.DeleteScheduledSearch(context.Background(), id).Execute() + //r, err := apiClient.V3.ScheduledSearchAPI.DeleteScheduledSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.DeleteScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-scheduled-search +Get a Scheduled Search +Returns the specified scheduled search. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-scheduled-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ScheduledSearch**](../models/scheduled-search) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ScheduledSearchAPI.GetScheduledSearch(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.ScheduledSearchAPI.GetScheduledSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.GetScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.GetScheduledSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-scheduled-search +List scheduled searches +Returns a list of scheduled searches. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-scheduled-search) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **owner.id**: *eq* **savedSearchId**: *eq* | + +### Return type + +[**[]ScheduledSearch**](../models/scheduled-search) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"` // 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: **owner.id**: *eq* **savedSearchId**: *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: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ScheduledSearchAPI.ListScheduledSearch(context.Background()).Execute() + //resp, r, err := apiClient.V3.ScheduledSearchAPI.ListScheduledSearch(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.ListScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListScheduledSearch`: []ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.ListScheduledSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## unsubscribe-scheduled-search +Unsubscribe a recipient from Scheduled Search +Unsubscribes a recipient from the specified scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/unsubscribe-scheduled-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUnsubscribeScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **typedReference** | [**TypedReference**](../models/typed-reference) | The recipient to be removed from the scheduled search. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + typedreference := []byte(`{ + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }`) // TypedReference | The recipient to be removed from the scheduled search. + + + var typedReference v3.TypedReference + if err := json.Unmarshal(typedreference, &typedReference); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ScheduledSearchAPI.UnsubscribeScheduledSearch(context.Background(), id).TypedReference(typedReference).Execute() + //r, err := apiClient.V3.ScheduledSearchAPI.UnsubscribeScheduledSearch(context.Background(), id).TypedReference(typedReference).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.UnsubscribeScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## update-scheduled-search +Update an existing Scheduled Search +Updates an existing scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-scheduled-search) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateScheduledSearchRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **scheduledSearch** | [**ScheduledSearch**](../models/scheduled-search) | The scheduled search to persist. | + +### Return type + +[**ScheduledSearch**](../models/scheduled-search) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + scheduledsearch := []byte(`{ + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false + }`) // ScheduledSearch | The scheduled search to persist. + + + var scheduledSearch v3.ScheduledSearch + if err := json.Unmarshal(scheduledsearch, &scheduledSearch); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ScheduledSearchAPI.UpdateScheduledSearch(context.Background(), id).ScheduledSearch(scheduledSearch).Execute() + //resp, r, err := apiClient.V3.ScheduledSearchAPI.UpdateScheduledSearch(context.Background(), id).ScheduledSearch(scheduledSearch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.UpdateScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.UpdateScheduledSearch`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/SearchAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/SearchAPI.md new file mode 100644 index 000000000..75129c556 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/SearchAPI.md @@ -0,0 +1,677 @@ +--- +id: search +title: Search +pagination_label: Search +sidebar_label: Search +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Search', 'Search'] +slug: /tools/sdk/go/v3/methods/search +tags: ['SDK', 'Software Development Kit', 'Search', 'Search'] +--- + +# SearchAPI + Use this API to implement search functionality. +With search functionality in place, users can search their tenants for nearly any information from throughout their organizations. + +Identity Security Cloud enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using Identity Security Cloud's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about Identity Security Cloud's search and its different possibilities. + +The search feature uses Elasticsearch as a datastore and query engine. +The power of Elasticsearch makes this feature suitable for ad-hoc reporting. +However, data from the operational databases (ex. identities, roles, events, etc) has to be ingested into Elasticsearch. +This ingestion process introduces a latency from when the operational data is created to when it is available in search. +Depending on the system load, this can take a few seconds to a few minutes. +Please keep this latency in mind when you use search. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**search-aggregate**](#search-aggregate) | **Post** `/search/aggregate` | Perform a Search Query Aggregation +[**search-count**](#search-count) | **Post** `/search/count` | Count Documents Satisfying a Query +[**search-get**](#search-get) | **Get** `/search/{index}/{id}` | Get a Document by ID +[**search-post**](#search-post) | **Post** `/search` | Perform Search + + +## search-aggregate +Perform a Search Query Aggregation +Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/search-aggregate) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchAggregateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search** | [**Search**](../models/search) | | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**AggregationResult**](../models/aggregation-result) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json, text/csv + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + var search v3.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SearchAPI.SearchAggregate(context.Background()).Search(search).Execute() + //resp, r, err := apiClient.V3.SearchAPI.SearchAggregate(context.Background()).Search(search).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchAggregate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchAggregate`: AggregationResult + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchAggregate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-count +Count Documents Satisfying a Query +Performs a search with a provided query and returns the count of results in the X-Total-Count header. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/search-count) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchCountRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search** | [**Search**](../models/search) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + + + var search v3.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SearchAPI.SearchCount(context.Background()).Search(search).Execute() + //r, err := apiClient.V3.SearchAPI.SearchCount(context.Background()).Search(search).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchCount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## search-get +Get a Document by ID +Fetches a single document from the specified index, using the specified document ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/search-get) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**index** | **string** | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. | +**id** | **string** | ID of the requested document. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchGetRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + index := `identities` // string | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. # string | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SearchAPI.SearchGet(context.Background(), index, id).Execute() + //resp, r, err := apiClient.V3.SearchAPI.SearchGet(context.Background(), index, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchGet``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchGet`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchGet`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## search-post +Perform Search +Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/search-post) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSearchPostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search** | [**Search**](../models/search) | | + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +**[]map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + 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) + limit := 10000 // 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + var search v3.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SearchAPI.SearchPost(context.Background()).Search(search).Execute() + //resp, r, err := apiClient.V3.SearchAPI.SearchPost(context.Background()).Search(search).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchPost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchPost`: []map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchPost`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/SearchAttributeConfigurationAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/SearchAttributeConfigurationAPI.md new file mode 100644 index 000000000..498506cff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/SearchAttributeConfigurationAPI.md @@ -0,0 +1,388 @@ +--- +id: search-attribute-configuration +title: SearchAttributeConfiguration +pagination_label: SearchAttributeConfiguration +sidebar_label: SearchAttributeConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchAttributeConfiguration', 'SearchAttributeConfiguration'] +slug: /tools/sdk/go/v3/methods/search-attribute-configuration +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfiguration', 'SearchAttributeConfiguration'] +--- + +# SearchAttributeConfigurationAPI + Use this API to implement search attribute configuration functionality, along with [Search](https://developer.sailpoint.com/docs/api/v3/search). +With this functionality in place, administrators can create custom search attributes that and run extended searches based on those attributes to further narrow down their searches and get the information and insights they want. + +Identity Security Cloud (ISC) enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using ISC's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about ISC's search and its different possibilities. + +With Search Attribute Configuration, administrators can create, manage, and run searches based on the attributes they want to search. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-search-attribute-config**](#create-search-attribute-config) | **Post** `/accounts/search-attribute-config` | Create Extended Search Attributes +[**delete-search-attribute-config**](#delete-search-attribute-config) | **Delete** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute +[**get-search-attribute-config**](#get-search-attribute-config) | **Get** `/accounts/search-attribute-config` | List Extended Search Attributes +[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **Get** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute +[**patch-search-attribute-config**](#patch-search-attribute-config) | **Patch** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute + + +## create-search-attribute-config +Create Extended Search Attributes +Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. +>**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.** + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-search-attribute-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **searchAttributeConfig** | [**SearchAttributeConfig**](../models/search-attribute-config) | | + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + searchattributeconfig := []byte(`{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }`) // SearchAttributeConfig | + + + var searchAttributeConfig v3.SearchAttributeConfig + if err := json.Unmarshal(searchattributeconfig, &searchAttributeConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SearchAttributeConfigurationAPI.CreateSearchAttributeConfig(context.Background()).SearchAttributeConfig(searchAttributeConfig).Execute() + //resp, r, err := apiClient.V3.SearchAttributeConfigurationAPI.CreateSearchAttributeConfig(context.Background()).SearchAttributeConfig(searchAttributeConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.CreateSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSearchAttributeConfig`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.CreateSearchAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-search-attribute-config +Delete Extended Search Attribute +Delete an extended attribute configuration by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-search-attribute-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | Name of the extended search attribute configuration to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `newMailAttribute` // string | Name of the extended search attribute configuration to delete. # string | Name of the extended search attribute configuration to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig(context.Background(), name).Execute() + //r, err := apiClient.V3.SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-search-attribute-config +List Extended Search Attributes +Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-search-attribute-config) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSearchAttributeConfigRequest struct via the builder pattern + + +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 + +[**[]SearchAttributeConfig**](../models/search-attribute-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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.V3.SearchAttributeConfigurationAPI.GetSearchAttributeConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.SearchAttributeConfigurationAPI.GetSearchAttributeConfig(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.GetSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSearchAttributeConfig`: []SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.GetSearchAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-single-search-attribute-config +Get Extended Search Attribute +Get an extended attribute configuration by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-single-search-attribute-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | Name of the extended search attribute configuration to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSingleSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]SearchAttributeConfig**](../models/search-attribute-config) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `newMailAttribute` // string | Name of the extended search attribute configuration to retrieve. # string | Name of the extended search attribute configuration to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig(context.Background(), name).Execute() + //resp, r, err := apiClient.V3.SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSingleSearchAttributeConfig`: []SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-search-attribute-config +Update Extended Search Attribute +Update an existing search attribute configuration. +You can patch these fields: +* name * displayName * applicationAttributes + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-search-attribute-config) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**name** | **string** | Name of the search attribute configuration to patch. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSearchAttributeConfigRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**SearchAttributeConfig**](../models/search-attribute-config) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + name := `promotedMailAttribute` // string | Name of the search attribute configuration to patch. # string | Name of the search attribute configuration to patch. + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SearchAttributeConfigurationAPI.PatchSearchAttributeConfig(context.Background(), name).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.SearchAttributeConfigurationAPI.PatchSearchAttributeConfig(context.Background(), name).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.PatchSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSearchAttributeConfig`: SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.PatchSearchAttributeConfig`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/SegmentsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/SegmentsAPI.md new file mode 100644 index 000000000..903b7a950 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/SegmentsAPI.md @@ -0,0 +1,405 @@ +--- +id: segments +title: Segments +pagination_label: Segments +sidebar_label: Segments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Segments', 'Segments'] +slug: /tools/sdk/go/v3/methods/segments +tags: ['SDK', 'Software Development Kit', 'Segments', 'Segments'] +--- + +# SegmentsAPI + Use this API to implement and customize access request segment functionality. +With this functionality in place, administrators can create and manage access request segments. +Segments provide organizations with a way to make the access their users have even more granular - this can simply the access request process for the organization's users and improves security by reducing the risk of overprovisoning access. + +Segments represent sets of identities, all grouped by specified identity attributes, who are only able to see and access the access items associated with their segments. +For example, administrators could group all their organization's London office employees into one segment, "London Office Employees," by their shared location. +The administrators could then define the access items the London employees would need, and the identities in the "London Office Employees" would then only be able to see and access those items. + +In Identity Security Cloud, administrators can use the 'Access' drop-down menu and select 'Segments' to reach the 'Access Requests Segments' page. +This page lists all the existing access request segments, along with their statuses, enabled or disabled. +Administrators can use this page to create, edit, enable, disable, and delete segments. +To create a segment, an administrator must provide a name, define the identities grouped in the segment, and define the items the identities in the segment can access. +These items can be access profiles, roles, or entitlements. + +When administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items. + +Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-segment**](#create-segment) | **Post** `/segments` | Create Segment +[**delete-segment**](#delete-segment) | **Delete** `/segments/{id}` | Delete Segment by ID +[**get-segment**](#get-segment) | **Get** `/segments/{id}` | Get Segment by ID +[**list-segments**](#list-segments) | **Get** `/segments` | List Segments +[**patch-segment**](#patch-segment) | **Patch** `/segments/{id}` | Update Segment + + +## create-segment +Create Segment +This API creates a segment. +>**Note:** Segment definitions may take time to propagate to all identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-segment) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **segment** | [**Segment**](../models/segment) | | + +### Return type + +[**Segment**](../models/segment) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + segment := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }`) // Segment | + + + var segment v3.Segment + if err := json.Unmarshal(segment, &segment); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SegmentsAPI.CreateSegment(context.Background()).Segment(segment).Execute() + //resp, r, err := apiClient.V3.SegmentsAPI.CreateSegment(context.Background()).Segment(segment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.CreateSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.CreateSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-segment +Delete Segment by ID +This API deletes the segment specified by the given ID. +>**Note:** that segment deletion may take some time to become effective. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to delete. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to delete. # string | The segment ID to delete. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SegmentsAPI.DeleteSegment(context.Background(), id).Execute() + //r, err := apiClient.V3.SegmentsAPI.DeleteSegment(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.DeleteSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-segment +Get Segment by ID +This API returns the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Segment**](../models/segment) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to retrieve. # string | The segment ID to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SegmentsAPI.GetSegment(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SegmentsAPI.GetSegment(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.GetSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.GetSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-segments +List Segments +This API returns a list of all segments. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-segments) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSegmentsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]Segment**](../models/segment) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SegmentsAPI.ListSegments(context.Background()).Execute() + //resp, r, err := apiClient.V3.SegmentsAPI.ListSegments(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.ListSegments``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSegments`: []Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.ListSegments`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-segment +Update Segment +Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +>**Note:** Changes to a segment may take some time to propagate to all identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-segment) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The segment ID to modify. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchSegmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **requestBody** | **[]map[string]interface{}** | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active | + +### Return type + +[**Segment**](../models/segment) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to modify. # string | The segment ID to modify. + requestbody := []byte(`[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]`) // []map[string]interface{} | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + + + var requestBody v3.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SegmentsAPI.PatchSegment(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V3.SegmentsAPI.PatchSegment(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.PatchSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.PatchSegment`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/ServiceDeskIntegrationAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/ServiceDeskIntegrationAPI.md new file mode 100644 index 000000000..3539da057 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/ServiceDeskIntegrationAPI.md @@ -0,0 +1,786 @@ +--- +id: service-desk-integration +title: ServiceDeskIntegration +pagination_label: ServiceDeskIntegration +sidebar_label: ServiceDeskIntegration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskIntegration', 'ServiceDeskIntegration'] +slug: /tools/sdk/go/v3/methods/service-desk-integration +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegration', 'ServiceDeskIntegration'] +--- + +# ServiceDeskIntegrationAPI + Use this API to build an integration between Identity Security Cloud and a service desk ITSM (IT service management) solution. +Once an administrator builds this integration between Identity Security Cloud and a service desk, users can use Identity Security Cloud to raise and track tickets that are synchronized between Identity Security Cloud and the service desk. + +In Identity Security Cloud, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.' + +To create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. +Refer to [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in Identity Security Cloud. + +Administrators can create various service desk integrations, all with their own nuances. +The following service desk integrations are available: + +- [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud_sd/introduction.html) + +- [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server_sd/introduction.html) + +- [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html) + +- [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html) + +- [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) + +- [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html) + +- [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html) + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-service-desk-integration**](#create-service-desk-integration) | **Post** `/service-desk-integrations` | Create new Service Desk integration +[**delete-service-desk-integration**](#delete-service-desk-integration) | **Delete** `/service-desk-integrations/{id}` | Delete a Service Desk integration +[**get-service-desk-integration**](#get-service-desk-integration) | **Get** `/service-desk-integrations/{id}` | Get a Service Desk integration +[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **Get** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName +[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **Get** `/service-desk-integrations/types` | List Service Desk integration types +[**get-service-desk-integrations**](#get-service-desk-integrations) | **Get** `/service-desk-integrations` | List existing Service Desk integrations +[**get-status-check-details**](#get-status-check-details) | **Get** `/service-desk-integrations/status-check-configuration` | Get the time check configuration +[**patch-service-desk-integration**](#patch-service-desk-integration) | **Patch** `/service-desk-integrations/{id}` | Patch a Service Desk Integration +[**put-service-desk-integration**](#put-service-desk-integration) | **Put** `/service-desk-integrations/{id}` | Update a Service Desk integration +[**update-status-check-details**](#update-status-check-details) | **Put** `/service-desk-integrations/status-check-configuration` | Update the time check configuration + + +## create-service-desk-integration +Create new Service Desk integration +Create a new Service Desk integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-service-desk-integration) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **serviceDeskIntegrationDto** | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | The specifics of a new integration to create | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + servicedeskintegrationdto := []byte(`{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + }`) // ServiceDeskIntegrationDto | The specifics of a new integration to create + + + var serviceDeskIntegrationDto v3.ServiceDeskIntegrationDto + if err := json.Unmarshal(servicedeskintegrationdto, &serviceDeskIntegrationDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.CreateServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.CreateServiceDeskIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-service-desk-integration +Delete a Service Desk integration +Delete an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-service-desk-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of Service Desk integration to delete | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `anId` // string | ID of Service Desk integration to delete # string | ID of Service Desk integration to delete + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration(context.Background(), id).Execute() + //r, err := apiClient.V3.ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-service-desk-integration +Get a Service Desk integration +Get an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Service Desk integration to get | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `anId` // string | ID of the Service Desk integration to get # string | ID of the Service Desk integration to get + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetServiceDeskIntegration(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetServiceDeskIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-service-desk-integration-template +Service Desk integration template by scriptName +This API endpoint returns an existing Service Desk integration template by scriptName. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration-template) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**scriptName** | **string** | The scriptName value of the Service Desk integration template to get | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationTemplateRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ServiceDeskIntegrationTemplateDto**](../models/service-desk-integration-template-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + scriptName := `aScriptName` // string | The scriptName value of the Service Desk integration template to get # string | The scriptName value of the Service Desk integration template to get + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationTemplate`: ServiceDeskIntegrationTemplateDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-service-desk-integration-types +List Service Desk integration types +This API endpoint returns the current list of supported Service Desk integration types. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration-types) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationTypesRequest struct via the builder pattern + + +### Return type + +[**[]ServiceDeskIntegrationTemplateType**](../models/service-desk-integration-template-type) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes(context.Background()).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationTypes`: []ServiceDeskIntegrationTemplateType + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-service-desk-integrations +List existing Service Desk integrations +Get a list of Service Desk integration objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integrations) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **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** | + **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* **type**: *eq, in* **cluster**: *eq, in* | + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `name eq "John Doe"` // 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* **type**: *eq, in* **cluster**: *eq, in* (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* **type**: *eq, in* **cluster**: *eq, in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetServiceDeskIntegrations(context.Background()).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetServiceDeskIntegrations(context.Background()).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrations`: []ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrations`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-status-check-details +Get the time check configuration +Get the time check configuration of queued SDIM tickets. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-status-check-details) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetStatusCheckDetailsRequest struct via the builder pattern + + +### Return type + +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetStatusCheckDetails(context.Background()).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetStatusCheckDetails(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetStatusCheckDetails``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetStatusCheckDetails`: QueuedCheckConfigDetails + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetStatusCheckDetails`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-service-desk-integration +Patch a Service Desk Integration +Update an existing Service Desk integration by ID with a PATCH request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-service-desk-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Service Desk integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `anId` // string | ID of the Service Desk integration to update # string | ID of the Service Desk integration to update + jsonpatchoperation := []byte(``) // []JsonPatchOperation | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.PatchServiceDeskIntegration(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.PatchServiceDeskIntegration(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.PatchServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.PatchServiceDeskIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-service-desk-integration +Update a Service Desk integration +Update an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-service-desk-integration) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the Service Desk integration to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutServiceDeskIntegrationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **serviceDeskIntegrationDto** | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | The specifics of the integration to update | + +### Return type + +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `anId` // string | ID of the Service Desk integration to update # string | ID of the Service Desk integration to update + servicedeskintegrationdto := []byte(`{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + }`) // ServiceDeskIntegrationDto | The specifics of the integration to update + + + var serviceDeskIntegrationDto v3.ServiceDeskIntegrationDto + if err := json.Unmarshal(servicedeskintegrationdto, &serviceDeskIntegrationDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.PutServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.PutServiceDeskIntegration`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-status-check-details +Update the time check configuration +Update the time check configuration of queued SDIM tickets. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-status-check-details) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateStatusCheckDetailsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **queuedCheckConfigDetails** | [**QueuedCheckConfigDetails**](../models/queued-check-config-details) | The modified time check configuration | + +### Return type + +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + queuedcheckconfigdetails := []byte(`{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + }`) // QueuedCheckConfigDetails | The modified time check configuration + + + var queuedCheckConfigDetails v3.QueuedCheckConfigDetails + if err := json.Unmarshal(queuedcheckconfigdetails, &queuedCheckConfigDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.UpdateStatusCheckDetails``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateStatusCheckDetails`: QueuedCheckConfigDetails + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.UpdateStatusCheckDetails`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/SourceUsagesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/SourceUsagesAPI.md new file mode 100644 index 000000000..4dd0e0064 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/SourceUsagesAPI.md @@ -0,0 +1,164 @@ +--- +id: source-usages +title: SourceUsages +pagination_label: SourceUsages +sidebar_label: SourceUsages +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUsages', 'SourceUsages'] +slug: /tools/sdk/go/v3/methods/source-usages +tags: ['SDK', 'Software Development Kit', 'SourceUsages', 'SourceUsages'] +--- + +# SourceUsagesAPI + Use this API to implement source usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used. +This allows organizations to get the information they need to start optimizing and securing source usage. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-status-by-source-id**](#get-status-by-source-id) | **Get** `/source-usages/{sourceId}/status` | Finds status of source usage +[**get-usages-by-source-id**](#get-usages-by-source-id) | **Get** `/source-usages/{sourceId}/summaries` | Returns source usage insights + + +## get-status-by-source-id +Finds status of source usage +This API returns the status of the source usage insights setup by IDN source ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-status-by-source-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | ID of IDN source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetStatusBySourceIdRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SourceUsageStatus**](../models/source-usage-status) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | ID of IDN source # string | ID of IDN source + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourceUsagesAPI.GetStatusBySourceId(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.SourceUsagesAPI.GetStatusBySourceId(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourceUsagesAPI.GetStatusBySourceId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetStatusBySourceId`: SourceUsageStatus + fmt.Fprintf(os.Stdout, "Response from `SourceUsagesAPI.GetStatusBySourceId`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-usages-by-source-id +Returns source usage insights +This API returns a summary of source usage insights for past 12 months. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-usages-by-source-id) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | ID of IDN source | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetUsagesBySourceIdRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **date** | + +### Return type + +[**[]SourceUsage**](../models/source-usage) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | ID of IDN source # string | ID of IDN source + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `-date` // 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: **date** (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: **date** (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourceUsagesAPI.GetUsagesBySourceId(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.SourceUsagesAPI.GetUsagesBySourceId(context.Background(), sourceId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourceUsagesAPI.GetUsagesBySourceId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUsagesBySourceId`: []SourceUsage + fmt.Fprintf(os.Stdout, "Response from `SourceUsagesAPI.GetUsagesBySourceId`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/SourcesAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/SourcesAPI.md new file mode 100644 index 000000000..c381db3c1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/SourcesAPI.md @@ -0,0 +1,2330 @@ +--- +id: sources +title: Sources +pagination_label: Sources +sidebar_label: Sources +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Sources', 'Sources'] +slug: /tools/sdk/go/v3/methods/sources +tags: ['SDK', 'Software Development Kit', 'Sources', 'Sources'] +--- + +# SourcesAPI + Use this API to implement and customize source functionality. +With source functionality in place, organizations can use Identity Security Cloud to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way. + +[Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) refer to the Identity Security Cloud representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example. +Organizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records. +Connecting these sources to Identity Security Cloud makes it possible to manage user access across them all. +Then, if a new hire starts at an organization, Identity Security Cloud can grant the new hire access to all the sources they need. +If an employee moves to a new department and needs access to new sources but no longer needs access to others, Identity Security Cloud can grant the necessary access and revoke the unnecessary access for all the employee's various sources. +If an employee leaves the company, Identity Security Cloud can revoke access to all the employee's various source accounts immediately. +These are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure. + +In Identity Security Cloud, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so. +They can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups. +Admins go to Connections > Sources to see a list of the existing source representations in their organizations. +They can create new sources or select existing ones. + +To create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type. +Refer to [Configuring a Source](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source) for more information about the source configuration process. + +Identity Security Cloud connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in. +Different sources use different connectors to share data with Identity Security Cloud, and each connector's setup process is specific to that connector. +SailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors. +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about these SailPoint supported connectors. +Refer to the following links for more information about two useful connectors: + +- [JDBC Connector](https://documentation.sailpoint.com/connectors/jdbc/help/integrating_jdbc/introduction.html): This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity). + +- [Web Services Connector](https://documentation.sailpoint.com/connectors/webservices/help/integrating_webservices/introduction.html): This connector can directly connect to databases that support Web Services. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources. + +When admins select existing sources, they can view the following information about the source: + +- Associated connections (any associated identity profiles, apps, or references to the source in a transform). + +- Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources. + +- Associated entitlements (sets of access rights on sources). + +- Associated access profiles (groupings of entitlements). + +The user account data and the entitlements update with each data aggregation from the source. +Organizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their Identity Security Cloud tenants so an access change on a source is detected quickly in Identity Security Cloud. +Admins can view a history of these aggregations, and they can also run manual imports. +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about manual and scheduled aggregations. + +Admins can also make changes to determine which user account data Identity Security Cloud collects from the source and how it correlates that account data with identity data. +To define which account attributes the source shares with Identity Security Cloud, admins can edit the account schema on the source. +Refer to [Managing Source Account Schemas](https://documentation.sailpoint.com/saas/help/accounts/schema.html) for more information about source account schemas and how to edit them. +To define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source. +Refer to [Assigning Source Accounts to Identities](https://documentation.sailpoint.com/saas/help/accounts/correlation.html) for more information about this correlation process between source accounts and identities. + +Admins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform. +Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources. + +Well organized, mapped out connections between sources and Identity Security Cloud are essential to achieving comprehensive identity access governance across all the source systems organizations need. +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-provisioning-policy**](#create-provisioning-policy) | **Post** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy +[**create-source**](#create-source) | **Post** `/sources` | Creates a source in IdentityNow. +[**create-source-schema**](#create-source-schema) | **Post** `/sources/{sourceId}/schemas` | Create Schema on Source +[**delete-provisioning-policy**](#delete-provisioning-policy) | **Delete** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType +[**delete-source**](#delete-source) | **Delete** `/sources/{id}` | Delete Source by ID +[**delete-source-schema**](#delete-source-schema) | **Delete** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID +[**get-accounts-schema**](#get-accounts-schema) | **Get** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template +[**get-entitlements-schema**](#get-entitlements-schema) | **Get** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template +[**get-provisioning-policy**](#get-provisioning-policy) | **Get** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType +[**get-source**](#get-source) | **Get** `/sources/{id}` | Get Source by ID +[**get-source-connections**](#get-source-connections) | **Get** `/sources/{sourceId}/connections` | Get Source Connections by ID +[**get-source-health**](#get-source-health) | **Get** `/sources/{sourceId}/source-health` | Fetches source health by id +[**get-source-schema**](#get-source-schema) | **Get** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID +[**get-source-schemas**](#get-source-schemas) | **Get** `/sources/{sourceId}/schemas` | List Schemas on Source +[**import-accounts-schema**](#import-accounts-schema) | **Post** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template +[**import-connector-file**](#import-connector-file) | **Post** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source +[**import-entitlements-schema**](#import-entitlements-schema) | **Post** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template +[**list-provisioning-policies**](#list-provisioning-policies) | **Get** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies +[**list-sources**](#list-sources) | **Get** `/sources` | Lists all sources in IdentityNow. +[**put-provisioning-policy**](#put-provisioning-policy) | **Put** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType +[**put-source**](#put-source) | **Put** `/sources/{id}` | Update Source (Full) +[**put-source-schema**](#put-source-schema) | **Put** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) +[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **Post** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies +[**update-provisioning-policy**](#update-provisioning-policy) | **Patch** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy +[**update-source**](#update-source) | **Patch** `/sources/{id}` | Update Source (Partial) +[**update-source-schema**](#update-source-schema) | **Patch** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) + + +## create-provisioning-policy +Create Provisioning Policy +This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **provisioningPolicyDto** | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | | + +### Return type + +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id # string | The Source id + provisioningpolicydto := []byte(`{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }`) // ProvisioningPolicyDto | + + + var provisioningPolicyDto v3.ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.CreateProvisioningPolicy(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.CreateProvisioningPolicy(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateProvisioningPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-source +Creates a source in IdentityNow. +This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-source) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **source** | [**Source**](../models/source) | | + **provisionAsCsv** | **bool** | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. | + +### Return type + +[**Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + source := []byte(`{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }`) // Source | + provisionAsCsv := false // bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + + var source v3.Source + if err := json.Unmarshal(source, &source); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.CreateSource(context.Background()).Source(source).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.CreateSource(context.Background()).Source(source).ProvisionAsCsv(provisionAsCsv).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-source-schema +Create Schema on Source +Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-source-schema) + +### 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 apiCreateSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schema** | [**Schema**](../models/schema) | | + +### Return type + +[**Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + schema := []byte(`{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + }`) // Schema | + + + var schema v3.Schema + if err := json.Unmarshal(schema, &schema); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.CreateSourceSchema(context.Background(), sourceId).Schema(schema).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.CreateSourceSchema(context.Background(), sourceId).Schema(schema).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSourceSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-provisioning-policy +Delete Provisioning Policy by UsageType +Deletes the provisioning policy with the specified usage on an application. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source ID. | +**usageType** | [**UsageType**](../models/) | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SourcesAPI.DeleteProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + //r, err := apiClient.V3.SourcesAPI.DeleteProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-source +Delete Source by ID +Use this API to delete a specific source in Identity Security Cloud (ISC). +The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**DeleteSource202Response**](../models/delete-source202-response) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.DeleteSource(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.DeleteSource(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteSource`: DeleteSource202Response + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.DeleteSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-source-schema +Delete Source Schema by ID + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-source-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**schemaId** | **string** | The Schema id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SourcesAPI.DeleteSourceSchema(context.Background(), sourceId, schemaId).Execute() + //r, err := apiClient.V3.SourcesAPI.DeleteSourceSchema(context.Background(), sourceId, schemaId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-accounts-schema +Downloads source accounts schema template +This API downloads the CSV schema that defines the account attributes on a source. +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-accounts-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetAccountsSchemaRequest 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SourcesAPI.GetAccountsSchema(context.Background(), id).Execute() + //r, err := apiClient.V3.SourcesAPI.GetAccountsSchema(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetAccountsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-entitlements-schema +Downloads source entitlements schema template +This API downloads the CSV schema that defines the entitlement attributes on a source. + +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-entitlements-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetEntitlementsSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schemaName** | **string** | Name of entitlement schema | + +### 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + schemaName := `?schemaName=group` // string | Name of entitlement schema (optional) # string | Name of entitlement schema (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SourcesAPI.GetEntitlementsSchema(context.Background(), id).Execute() + //r, err := apiClient.V3.SourcesAPI.GetEntitlementsSchema(context.Background(), id).SchemaName(schemaName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetEntitlementsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-provisioning-policy +Get Provisioning Policy by UsageType +This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source ID. | +**usageType** | [**UsageType**](../models/) | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.GetProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.GetProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetProvisioningPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source +Get Source by ID +Use this API to get a source by a specified ID in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.GetSource(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.GetSource(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-connections +Get Source Connections by ID +Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-connections) + +### 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 apiGetSourceConnectionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SourceConnectionsDto**](../models/source-connections-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.GetSourceConnections(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.GetSourceConnections(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceConnections``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceConnections`: SourceConnectionsDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceConnections`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-health +Fetches source health by id +This endpoint fetches source health by source's id + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-health) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceHealthRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**SourceHealthDto**](../models/source-health-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.GetSourceHealth(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.GetSourceHealth(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceHealth``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceHealth`: SourceHealthDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceHealth`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-schema +Get Source Schema by ID +Get the Source Schema by ID in IdentityNow. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**schemaId** | **string** | The Schema id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.GetSourceSchema(context.Background(), sourceId, schemaId).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.GetSourceSchema(context.Background(), sourceId, schemaId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-source-schemas +List Schemas on Source +Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-schemas) + +### 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 apiGetSourceSchemasRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **includeTypes** | **string** | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. | + **includeNames** | **string** | A comma-separated list of schema names to filter result. | + +### Return type + +[**[]Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + includeTypes := `group` // string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) # string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + includeNames := `account` // string | A comma-separated list of schema names to filter result. (optional) # string | A comma-separated list of schema names to filter result. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).IncludeTypes(includeTypes).IncludeNames(includeNames).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchemas``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchemas`: []Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchemas`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-accounts-schema +Uploads source accounts schema template +This API uploads a source schema template file to configure a source's account attributes. + +To retrieve the file to modify and upload, log into Identity Now. + +Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** + +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v3/import-accounts-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportAccountsSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | | + +### Return type + +[**Schema**](../models/schema) + +### 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() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.ImportAccountsSchema(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.ImportAccountsSchema(context.Background(), id).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportAccountsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportAccountsSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportAccountsSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## import-connector-file +Upload connector file to source +This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/import-connector-file) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportConnectorFileRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **file** | ***os.File** | | + +### Return type + +[**Source**](../models/source) + +### 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 := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.ImportConnectorFile(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.ImportConnectorFile(context.Background(), sourceId).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportConnectorFile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportConnectorFile`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportConnectorFile`: %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. + +To retrieve the file to modify and upload, log into Identity Now. + +Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** + +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v3/import-entitlements-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportEntitlementsSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **schemaName** | **string** | Name of entitlement schema | + **file** | ***os.File** | | + +### Return type + +[**Schema**](../models/schema) + +### 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() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + schemaName := `?schemaName=group` // string | Name of entitlement schema (optional) # string | Name of entitlement schema (optional) + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.ImportEntitlementsSchema(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.ImportEntitlementsSchema(context.Background(), id).SchemaName(schemaName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportEntitlementsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportEntitlementsSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportEntitlementsSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-provisioning-policies +Lists ProvisioningPolicies +This end-point lists all the ProvisioningPolicies in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-provisioning-policies) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListProvisioningPoliciesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id # string | The Source id + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.ListProvisioningPolicies(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.ListProvisioningPolicies(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ListProvisioningPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListProvisioningPolicies`: []ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ListProvisioningPolicies`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-sources +Lists all sources in IdentityNow. +This end-point lists all the sources in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-sources) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListSourcesRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* | + **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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** | + **forSubadmin** | **string** | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. | + **includeIDNSource** | **bool** | Include the IdentityNow source in the response. | [default to false] + +### Return type + +[**[]Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Employees"` // 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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + sorters := `name` // 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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + forSubadmin := `name` // string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) # string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + includeIDNSource := true // bool | Include the IdentityNow source in the response. (optional) (default to false) # bool | Include the IdentityNow source in the response. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.ListSources(context.Background()).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.ListSources(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSubadmin(forSubadmin).IncludeIDNSource(includeIDNSource).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ListSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSources`: []Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ListSources`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-provisioning-policy +Update Provisioning Policy by UsageType +This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source ID. | +**usageType** | [**UsageType**](../models/) | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **provisioningPolicyDto** | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | | + +### Return type + +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + provisioningpolicydto := []byte(`{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }`) // ProvisioningPolicyDto | + + + var provisioningPolicyDto v3.ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.PutProvisioningPolicy(context.Background(), sourceId, usageType).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.PutProvisioningPolicy(context.Background(), sourceId, usageType).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutProvisioningPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-source +Update Source (Full) +Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. + +These fields are immutable, so they cannot be changed: + +* id +* type +* authoritative +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **source** | [**Source**](../models/source) | | + +### Return type + +[**Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + source := []byte(`{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }`) // Source | + + + var source v3.Source + if err := json.Unmarshal(source, &source); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.PutSource(context.Background(), id).Source(source).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.PutSource(context.Background(), id).Source(source).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-source-schema +Update Source Schema (Full) +This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. + +* id +* name +* created +* modified + +Any attempt to modify these fields will result in an error response with a status code of 400. + +> `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-source-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**schemaId** | **string** | The Schema id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **schema** | [**Schema**](../models/schema) | | + +### Return type + +[**Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + schema := []byte(`{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + }`) // Schema | + + + var schema v3.Schema + if err := json.Unmarshal(schema, &schema); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.PutSourceSchema(context.Background(), sourceId, schemaId).Schema(schema).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.PutSourceSchema(context.Background(), sourceId, schemaId).Schema(schema).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSourceSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-provisioning-policies-in-bulk +Bulk Update Provisioning Policies +This end-point updates a list of provisioning policies on the specified source in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-provisioning-policies-in-bulk) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateProvisioningPoliciesInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **provisioningPolicyDto** | [**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) | | + +### Return type + +[**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + provisioningpolicydto := []byte(``) // []ProvisioningPolicyDto | + + + var provisioningPolicyDto v3.[]ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.UpdateProvisioningPoliciesInBulk(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.UpdateProvisioningPoliciesInBulk(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateProvisioningPoliciesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateProvisioningPoliciesInBulk`: []ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateProvisioningPoliciesInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-provisioning-policy +Partial update of Provisioning Policy +This API selectively updates an existing Provisioning Policy using a JSONPatch payload. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-provisioning-policy) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**usageType** | [**UsageType**](../models/) | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateProvisioningPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | The JSONPatch payload used to update the schema. | + +### Return type + +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + jsonpatchoperation := []byte(`[{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schema. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.UpdateProvisioningPolicy(context.Background(), sourceId, usageType).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.UpdateProvisioningPolicy(context.Background(), sourceId, usageType).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateProvisioningPolicy`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-source +Update Source (Partial) +Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the +[JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +These fields are immutable, so they cannot be changed: + +* id +* type +* authoritative +* created +* modified +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-source) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Source ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSourceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). | + +### Return type + +[**Source**](../models/source) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=new description}]`) // []JsonPatchOperation | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.UpdateSource(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.UpdateSource(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSource`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-source-schema +Update Source Schema (Partial) +Use this API to selectively update an existing Schema using a JSONPatch payload. + +The following schema fields are immutable and cannot be updated: + +- id +- name +- created +- modified + + +To switch an account attribute to a group entitlement, you need to have the following in place: + +- `isEntitlement: true` +- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: +```json +{ + "name": "groups", + "type": "STRING", + "schema": { + "type": "CONNECTOR_SCHEMA", + "id": "2c9180887671ff8c01767b4671fc7d60", + "name": "group" + }, + "description": "The groups, roles etc. that reference account group objects", + "isMulti": true, + "isEntitlement": true, + "isGroup": true +} +``` + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-source-schema) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**sourceId** | **string** | The Source id. | +**schemaId** | **string** | The Schema id. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateSourceSchemaRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | The JSONPatch payload used to update the schema. | + +### Return type + +[**Schema**](../models/schema) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + jsonpatchoperation := []byte(`[{op=add, path=/attributes/-, value={name=location, type=STRING, schema=null, description=Employee location, isMulti=false, isEntitlement=false, isGroup=false}}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schema. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.UpdateSourceSchema(context.Background(), sourceId, schemaId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.UpdateSourceSchema(context.Background(), sourceId, schemaId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceSchema`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/TaggedObjectsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/TaggedObjectsAPI.md new file mode 100644 index 000000000..031711fc7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/TaggedObjectsAPI.md @@ -0,0 +1,678 @@ +--- +id: tagged-objects +title: TaggedObjects +pagination_label: TaggedObjects +sidebar_label: TaggedObjects +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaggedObjects', 'TaggedObjects'] +slug: /tools/sdk/go/v3/methods/tagged-objects +tags: ['SDK', 'Software Development Kit', 'TaggedObjects', 'TaggedObjects'] +--- + +# TaggedObjectsAPI + Use this API to implement object tagging functionality. +With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches Identity Security Cloud. + +In Identity Security Cloud, users can search their tenants for information and add tags objects they find. +Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future. + +For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. +Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. +The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. +When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag. + +With the API, you can tag even more different object types than you can in Identity Security Cloud (access profiles, entitlements, identities, and roles). +You can use the API to tag all these objects: + +- Access profiles + +- Applications + +- Certification campaigns + +- Entitlements + +- Identities + +- Roles + +- SOD (separation of duties) policies + +- Sources + +You can also use the API to directly find, create, and manage tagged objects without using search queries. + +There are limits to tags: + +- You can have up to 500 different tags in your tenant. + +- You can apply up to 30 tags to one object. + +- You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant. + +Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by Identity Security Cloud. + +These are the types of information often expressed in tags: + +- Affected departments + +- Compliance and regulatory categories + +- Remediation urgency levels + +- Risk levels + +Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-tagged-object**](#delete-tagged-object) | **Delete** `/tagged-objects/{type}/{id}` | Delete Object Tags +[**delete-tags-to-many-object**](#delete-tags-to-many-object) | **Post** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects +[**get-tagged-object**](#get-tagged-object) | **Get** `/tagged-objects/{type}/{id}` | Get Tagged Object +[**list-tagged-objects**](#list-tagged-objects) | **Get** `/tagged-objects` | List Tagged Objects +[**list-tagged-objects-by-type**](#list-tagged-objects-by-type) | **Get** `/tagged-objects/{type}` | List Tagged Objects by Type +[**put-tagged-object**](#put-tagged-object) | **Put** `/tagged-objects/{type}/{id}` | Update Tagged Object +[**set-tag-to-object**](#set-tag-to-object) | **Post** `/tagged-objects` | Add Tag to Object +[**set-tags-to-many-objects**](#set-tags-to-many-objects) | **Post** `/tagged-objects/bulk-add` | Tag Multiple Objects + + +## delete-tagged-object +Delete Object Tags +Delete all tags from a tagged object. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-tagged-object) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**type_** | **string** | The type of object to delete tags from. | +**id** | **string** | The ID of the object to delete tags from. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteTaggedObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `ROLE` // string | The type of object to delete tags from. # string | The type of object to delete tags from. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object to delete tags from. # string | The ID of the object to delete tags from. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.TaggedObjectsAPI.DeleteTaggedObject(context.Background(), type_, id).Execute() + //r, err := apiClient.V3.TaggedObjectsAPI.DeleteTaggedObject(context.Background(), type_, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.DeleteTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## delete-tags-to-many-object +Remove Tags from Multiple Objects +This API removes tags from multiple objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-tags-to-many-object) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteTagsToManyObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulkRemoveTaggedObject** | [**BulkRemoveTaggedObject**](../models/bulk-remove-tagged-object) | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + bulkremovetaggedobject := []byte(`{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // BulkRemoveTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + + var bulkRemoveTaggedObject v3.BulkRemoveTaggedObject + if err := json.Unmarshal(bulkremovetaggedobject, &bulkRemoveTaggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.TaggedObjectsAPI.DeleteTagsToManyObject(context.Background()).BulkRemoveTaggedObject(bulkRemoveTaggedObject).Execute() + //r, err := apiClient.V3.TaggedObjectsAPI.DeleteTagsToManyObject(context.Background()).BulkRemoveTaggedObject(bulkRemoveTaggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.DeleteTagsToManyObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-tagged-object +Get Tagged Object +This gets a tagged object for the specified type. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-tagged-object) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**type_** | **string** | The type of tagged object to retrieve. | +**id** | **string** | The ID of the object reference to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTaggedObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**TaggedObject**](../models/tagged-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `ROLE` // string | The type of tagged object to retrieve. # string | The type of tagged object to retrieve. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to retrieve. # string | The ID of the object reference to retrieve. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TaggedObjectsAPI.GetTaggedObject(context.Background(), type_, id).Execute() + //resp, r, err := apiClient.V3.TaggedObjectsAPI.GetTaggedObject(context.Background(), type_, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.GetTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaggedObject`: TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.GetTaggedObject`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-tagged-objects +List Tagged Objects +This API returns a list of all tagged objects. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-tagged-objects) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTaggedObjectsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* | + +### Return type + +[**[]TaggedObject**](../models/tagged-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `tagName eq "BU_FINANCE"` // 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TaggedObjectsAPI.ListTaggedObjects(context.Background()).Execute() + //resp, r, err := apiClient.V3.TaggedObjectsAPI.ListTaggedObjects(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.ListTaggedObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTaggedObjects`: []TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.ListTaggedObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-tagged-objects-by-type +List Tagged Objects by Type +This API returns a list of all tagged objects by type. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-tagged-objects-by-type) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**type_** | **string** | The type of tagged object to retrieve. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTaggedObjectsByTypeRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **objectRef.id**: *eq* **objectRef.type**: *eq* | + +### Return type + +[**[]TaggedObject**](../models/tagged-object) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `ROLE` // string | The type of tagged object to retrieve. # string | The type of tagged object to retrieve. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `objectRef.id eq "2c91808568c529c60168cca6f90c1313"` // 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: **objectRef.id**: *eq* **objectRef.type**: *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: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TaggedObjectsAPI.ListTaggedObjectsByType(context.Background(), type_).Execute() + //resp, r, err := apiClient.V3.TaggedObjectsAPI.ListTaggedObjectsByType(context.Background(), type_).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.ListTaggedObjectsByType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTaggedObjectsByType`: []TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.ListTaggedObjectsByType`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-tagged-object +Update Tagged Object +This updates a tagged object for the specified type. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-tagged-object) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**type_** | **string** | The type of tagged object to update. | +**id** | **string** | The ID of the object reference to update. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutTaggedObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **taggedObject** | [**TaggedObject**](../models/tagged-object) | | + +### Return type + +[**TaggedObject**](../models/tagged-object) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + type_ := `ROLE` // string | The type of tagged object to update. # string | The type of tagged object to update. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to update. # string | The ID of the object reference to update. + taggedobject := []byte(`{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // TaggedObject | + + + var taggedObject v3.TaggedObject + if err := json.Unmarshal(taggedobject, &taggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TaggedObjectsAPI.PutTaggedObject(context.Background(), type_, id).TaggedObject(taggedObject).Execute() + //resp, r, err := apiClient.V3.TaggedObjectsAPI.PutTaggedObject(context.Background(), type_, id).TaggedObject(taggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.PutTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutTaggedObject`: TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.PutTaggedObject`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## set-tag-to-object +Add Tag to Object +This adds a tag to an object. + +Any authenticated token may be used to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-tag-to-object) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetTagToObjectRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **taggedObject** | [**TaggedObject**](../models/tagged-object) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + taggedobject := []byte(`{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // TaggedObject | + + + var taggedObject v3.TaggedObject + if err := json.Unmarshal(taggedobject, &taggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.TaggedObjectsAPI.SetTagToObject(context.Background()).TaggedObject(taggedObject).Execute() + //r, err := apiClient.V3.TaggedObjectsAPI.SetTagToObject(context.Background()).TaggedObject(taggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.SetTagToObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## set-tags-to-many-objects +Tag Multiple Objects +This API adds tags to multiple objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-tags-to-many-objects) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiSetTagsToManyObjectsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulkAddTaggedObject** | [**BulkAddTaggedObject**](../models/bulk-add-tagged-object) | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. | + +### Return type + +[**[]BulkTaggedObjectResponse**](../models/bulk-tagged-object-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + bulkaddtaggedobject := []byte(`{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // BulkAddTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + + var bulkAddTaggedObject v3.BulkAddTaggedObject + if err := json.Unmarshal(bulkaddtaggedobject, &bulkAddTaggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TaggedObjectsAPI.SetTagsToManyObjects(context.Background()).BulkAddTaggedObject(bulkAddTaggedObject).Execute() + //resp, r, err := apiClient.V3.TaggedObjectsAPI.SetTagsToManyObjects(context.Background()).BulkAddTaggedObject(bulkAddTaggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.SetTagsToManyObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetTagsToManyObjects`: []BulkTaggedObjectResponse + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.SetTagsToManyObjects`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/TransformsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/TransformsAPI.md new file mode 100644 index 000000000..6afc04c84 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/TransformsAPI.md @@ -0,0 +1,373 @@ +--- +id: transforms +title: Transforms +pagination_label: Transforms +sidebar_label: Transforms +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Transforms', 'Transforms'] +slug: /tools/sdk/go/v3/methods/transforms +tags: ['SDK', 'Software Development Kit', 'Transforms', 'Transforms'] +--- + +# TransformsAPI + The purpose of this API is to expose functionality for the manipulation of Transform objects. +Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having +to write code. + +Refer to [Transforms](https://developer.sailpoint.com/docs/extensibility/transforms/) for more information about transforms. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-transform**](#create-transform) | **Post** `/transforms` | Create transform +[**delete-transform**](#delete-transform) | **Delete** `/transforms/{id}` | Delete a transform +[**get-transform**](#get-transform) | **Get** `/transforms/{id}` | Transform by ID +[**list-transforms**](#list-transforms) | **Get** `/transforms` | List transforms +[**update-transform**](#update-transform) | **Put** `/transforms/{id}` | Update a transform + + +## create-transform +Create transform +Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-transform) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateTransformRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transform** | [**Transform**](../models/transform) | The transform to be created. | + +### Return type + +[**TransformRead**](../models/transform-read) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + transform := []byte(`{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }`) // Transform | The transform to be created. + + + var transform v3.Transform + if err := json.Unmarshal(transform, &transform); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TransformsAPI.CreateTransform(context.Background()).Transform(transform).Execute() + //resp, r, err := apiClient.V3.TransformsAPI.CreateTransform(context.Background()).Transform(transform).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.CreateTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.CreateTransform`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-transform +Delete a transform +Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-transform) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the transform to delete | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteTransformRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to delete # string | ID of the transform to delete + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.TransformsAPI.DeleteTransform(context.Background(), id).Execute() + //r, err := apiClient.V3.TransformsAPI.DeleteTransform(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.DeleteTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-transform +Transform by ID +This API returns the transform specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-transform) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the transform to retrieve | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetTransformRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**TransformRead**](../models/transform-read) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to retrieve # string | ID of the transform to retrieve + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TransformsAPI.GetTransform(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.TransformsAPI.GetTransform(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.GetTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.GetTransform`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-transforms +List transforms +Gets a list of all saved transform objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-transforms) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListTransformsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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] + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **name** | **string** | Name of the transform to retrieve from the list. | + **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: **internal**: *eq* **name**: *eq, sw* | + +### Return type + +[**[]TransformRead**](../models/transform-read) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + name := `ExampleTransformName123` // string | Name of the transform to retrieve from the list. (optional) # string | Name of the transform to retrieve from the list. (optional) + filters := `name eq "Uppercase"` // 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: **internal**: *eq* **name**: *eq, sw* (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: **internal**: *eq* **name**: *eq, sw* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TransformsAPI.ListTransforms(context.Background()).Execute() + //resp, r, err := apiClient.V3.TransformsAPI.ListTransforms(context.Background()).Offset(offset).Limit(limit).Count(count).Name(name).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.ListTransforms``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTransforms`: []TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.ListTransforms`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## update-transform +Update a transform +Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-transform) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the transform to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateTransformRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **transform** | [**Transform**](../models/transform) | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. | + +### Return type + +[**TransformRead**](../models/transform-read) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to update # string | ID of the transform to update + transform := []byte(`{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }`) // Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TransformsAPI.UpdateTransform(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.TransformsAPI.UpdateTransform(context.Background(), id).Transform(transform).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.UpdateTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.UpdateTransform`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/VendorConnectorMappingsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/VendorConnectorMappingsAPI.md new file mode 100644 index 000000000..63b9c0e4f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/VendorConnectorMappingsAPI.md @@ -0,0 +1,262 @@ +--- +id: vendor-connector-mappings +title: VendorConnectorMappings +pagination_label: VendorConnectorMappings +sidebar_label: VendorConnectorMappings +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappings', 'VendorConnectorMappings'] +slug: /tools/sdk/go/v3/methods/vendor-connector-mappings +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappings', 'VendorConnectorMappings'] +--- + +# VendorConnectorMappingsAPI + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-vendor-connector-mapping**](#create-vendor-connector-mapping) | **Post** `/vendor-connector-mappings` | Create Vendor Connector Mapping +[**delete-vendor-connector-mapping**](#delete-vendor-connector-mapping) | **Delete** `/vendor-connector-mappings` | Delete Vendor Connector Mapping +[**get-vendor-connector-mappings**](#get-vendor-connector-mappings) | **Get** `/vendor-connector-mappings` | List Vendor Connector Mappings + + +## create-vendor-connector-mapping +Create Vendor Connector Mapping +Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-vendor-connector-mapping) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateVendorConnectorMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vendorConnectorMapping** | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | | + +### Return type + +[**VendorConnectorMapping**](../models/vendor-connector-mapping) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + vendorconnectormapping := []byte(`{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }`) // VendorConnectorMapping | + + + var vendorConnectorMapping v3.VendorConnectorMapping + if err := json.Unmarshal(vendorconnectormapping, &vendorConnectorMapping); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.VendorConnectorMappingsAPI.CreateVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + //resp, r, err := apiClient.V3.VendorConnectorMappingsAPI.CreateVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.CreateVendorConnectorMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateVendorConnectorMapping`: VendorConnectorMapping + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.CreateVendorConnectorMapping`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-vendor-connector-mapping +Delete Vendor Connector Mapping +Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-vendor-connector-mapping) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteVendorConnectorMappingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vendorConnectorMapping** | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | | + +### Return type + +[**DeleteVendorConnectorMapping200Response**](../models/delete-vendor-connector-mapping200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + vendorconnectormapping := []byte(`{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }`) // VendorConnectorMapping | + + + var vendorConnectorMapping v3.VendorConnectorMapping + if err := json.Unmarshal(vendorconnectormapping, &vendorConnectorMapping); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.VendorConnectorMappingsAPI.DeleteVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + //resp, r, err := apiClient.V3.VendorConnectorMappingsAPI.DeleteVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.DeleteVendorConnectorMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteVendorConnectorMapping`: DeleteVendorConnectorMapping200Response + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.DeleteVendorConnectorMapping`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-vendor-connector-mappings +List Vendor Connector Mappings +Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-vendor-connector-mappings) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetVendorConnectorMappingsRequest struct via the builder pattern + + +### Return type + +[**[]VendorConnectorMapping**](../models/vendor-connector-mapping) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.VendorConnectorMappingsAPI.GetVendorConnectorMappings(context.Background()).Execute() + //resp, r, err := apiClient.V3.VendorConnectorMappingsAPI.GetVendorConnectorMappings(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.GetVendorConnectorMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetVendorConnectorMappings`: []VendorConnectorMapping + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.GetVendorConnectorMappings`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/WorkItemsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/WorkItemsAPI.md new file mode 100644 index 000000000..081e7eade --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/WorkItemsAPI.md @@ -0,0 +1,922 @@ +--- +id: work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItems', 'WorkItems'] +slug: /tools/sdk/go/v3/methods/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'WorkItems'] +--- + +# WorkItemsAPI + Use this API to implement work item functionality. +With this functionality in place, users can manage their work items (tasks). + +Work items refer to the tasks users see in Identity Security Cloud's Task Manager. +They can see the pending work items they need to complete, as well as the work items they have already completed. +Task Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. +For example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. +Once the user completes the work item, the work item will be listed with his or her other completed work items. + +To complete work items, users can use their dashboards and select the 'My Tasks' widget. +The widget will list any work items they need to complete, and they can select the work item from the list to review its details. +When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. + +Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-approval-item**](#approve-approval-item) | **Post** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item +[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **Post** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items +[**complete-work-item**](#complete-work-item) | **Post** `/work-items/{id}` | Complete a Work Item +[**get-completed-work-items**](#get-completed-work-items) | **Get** `/work-items/completed` | Completed Work Items +[**get-count-completed-work-items**](#get-count-completed-work-items) | **Get** `/work-items/completed/count` | Count Completed Work Items +[**get-count-work-items**](#get-count-work-items) | **Get** `/work-items/count` | Count Work Items +[**get-work-item**](#get-work-item) | **Get** `/work-items/{id}` | Get a Work Item +[**get-work-items-summary**](#get-work-items-summary) | **Get** `/work-items/summary` | Work Items Summary +[**list-work-items**](#list-work-items) | **Get** `/work-items` | List Work Items +[**reject-approval-item**](#reject-approval-item) | **Post** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item +[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **Post** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items +[**send-work-item-forward**](#send-work-item-forward) | **Post** `/work-items/{id}/forward` | Forward a Work Item +[**submit-account-selection**](#submit-account-selection) | **Post** `/work-items/{id}/submit-account-selection` | Submit Account Selections + + +## approve-approval-item +Approve an Approval Item +This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-approval-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | +**approvalItemId** | **string** | The ID of the approval item. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiApproveApprovalItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveApprovalItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## approve-approval-items-in-bulk +Bulk approve Approval Items +This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-approval-items-in-bulk) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiApproveApprovalItemsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.ApproveApprovalItemsInBulk(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.ApproveApprovalItemsInBulk(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItemsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveApprovalItemsInBulk`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItemsInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## complete-work-item +Complete a Work Item +This API completes a work item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/complete-work-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCompleteWorkItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | **string** | Body is the request payload to create form definition request | + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + body := `body_example` // string | Body is the request payload to create form definition request (optional) # string | Body is the request payload to create form definition request (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.CompleteWorkItem(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.CompleteWorkItem(context.Background(), id).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.CompleteWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompleteWorkItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.CompleteWorkItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-completed-work-items +Completed Work Items +This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-completed-work-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCompletedWorkItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. | + **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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + +### Return type + +[**[]WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.GetCompletedWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.GetCompletedWorkItems(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCompletedWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCompletedWorkItems`: []WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCompletedWorkItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-count-completed-work-items +Count Completed Work Items +This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-count-completed-work-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCountCompletedWorkItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | ID of the work item owner. | + +### Return type + +[**WorkItemsCount**](../models/work-items-count) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.GetCountCompletedWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.GetCountCompletedWorkItems(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCountCompletedWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCountCompletedWorkItems`: WorkItemsCount + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCountCompletedWorkItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-count-work-items +Count Work Items +This gets a count of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-count-work-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCountWorkItemsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | ID of the work item owner. | + +### Return type + +[**WorkItemsCount**](../models/work-items-count) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.GetCountWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.GetCountWorkItems(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCountWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCountWorkItems`: WorkItemsCount + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCountWorkItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-work-item +Get a Work Item +This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-work-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | ID of the work item. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the work item. # string | ID of the work item. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.GetWorkItem(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.GetWorkItem(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetWorkItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-work-items-summary +Work Items Summary +This gets a summary of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-work-items-summary) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkItemsSummaryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ownerId** | **string** | ID of the work item owner. | + +### Return type + +[**WorkItemsSummary**](../models/work-items-summary) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.GetWorkItemsSummary(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.GetWorkItemsSummary(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetWorkItemsSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkItemsSummary`: WorkItemsSummary + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetWorkItemsSummary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-work-items +List Work Items +This gets a collection of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-work-items) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkItemsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **ownerId** | **string** | ID of the work item owner. | + +### Return type + +[**[]WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.ListWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.ListWorkItems(context.Background()).Limit(limit).Offset(offset).Count(count).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ListWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkItems`: []WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ListWorkItems`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reject-approval-item +Reject an Approval Item +This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-approval-item) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | +**approvalItemId** | **string** | The ID of the approval item. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRejectApprovalItemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.RejectApprovalItem(context.Background(), id, approvalItemId).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.RejectApprovalItem(context.Background(), id, approvalItemId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.RejectApprovalItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectApprovalItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.RejectApprovalItem`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## reject-approval-items-in-bulk +Bulk reject Approval Items +This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-approval-items-in-bulk) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRejectApprovalItemsInBulkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.RejectApprovalItemsInBulk(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.RejectApprovalItemsInBulk(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.RejectApprovalItemsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectApprovalItemsInBulk`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.RejectApprovalItemsInBulk`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## send-work-item-forward +Forward a Work Item +This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-work-item-forward) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSendWorkItemForwardRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **workItemForward** | [**WorkItemForward**](../models/work-item-forward) | | + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + workitemforward := []byte(`{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + }`) // WorkItemForward | + + + var workItemForward v3.WorkItemForward + if err := json.Unmarshal(workitemforward, &workItemForward); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.WorkItemsAPI.SendWorkItemForward(context.Background(), id).WorkItemForward(workItemForward).Execute() + //r, err := apiClient.V3.WorkItemsAPI.SendWorkItemForward(context.Background(), id).WorkItemForward(workItemForward).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.SendWorkItemForward``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## submit-account-selection +Submit Account Selections +This API submits account selections. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/submit-account-selection) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The ID of the work item | + +### Other Parameters + +Other parameters are passed through a pointer to a apiSubmitAccountSelectionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **requestBody** | **map[string]interface{}** | Account Selection Data map, keyed on fieldName | + +### Return type + +[**WorkItems**](../models/work-items) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + requestBody := {fieldName=fieldValue} // map[string]interface{} | Account Selection Data map, keyed on fieldName # map[string]interface{} | Account Selection Data map, keyed on fieldName + + + var requestBody v3.RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.SubmitAccountSelection(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.SubmitAccountSelection(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.SubmitAccountSelection``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitAccountSelection`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.SubmitAccountSelection`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Methods/WorkflowsAPI.md b/docs/tools/sdk/go/Reference/V3/Methods/WorkflowsAPI.md new file mode 100644 index 000000000..383ed96ac --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Methods/WorkflowsAPI.md @@ -0,0 +1,1307 @@ +--- +id: workflows +title: Workflows +pagination_label: Workflows +sidebar_label: Workflows +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Workflows', 'Workflows'] +slug: /tools/sdk/go/v3/methods/workflows +tags: ['SDK', 'Software Development Kit', 'Workflows', 'Workflows'] +--- + +# WorkflowsAPI + Workflows allow administrators to create custom automation scripts directly within Identity Security Cloud. These automation scripts respond to [event triggers](https://developer.sailpoint.com/docs/extensibility/event-triggers/#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the Identity Security Cloud UI. Workflows can be configured via a graphical user interface within Identity Security Cloud, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-workflow-execution**](#cancel-workflow-execution) | **Post** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID +[**create-external-execute-workflow**](#create-external-execute-workflow) | **Post** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger +[**create-workflow**](#create-workflow) | **Post** `/workflows` | Create Workflow +[**create-workflow-external-trigger**](#create-workflow-external-trigger) | **Post** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client +[**delete-workflow**](#delete-workflow) | **Delete** `/workflows/{id}` | Delete Workflow By Id +[**get-workflow**](#get-workflow) | **Get** `/workflows/{id}` | Get Workflow By Id +[**get-workflow-execution**](#get-workflow-execution) | **Get** `/workflow-executions/{id}` | Get Workflow Execution +[**get-workflow-execution-history**](#get-workflow-execution-history) | **Get** `/workflow-executions/{id}/history` | Get Workflow Execution History +[**get-workflow-executions**](#get-workflow-executions) | **Get** `/workflows/{id}/executions` | List Workflow Executions +[**list-complete-workflow-library**](#list-complete-workflow-library) | **Get** `/workflow-library` | List Complete Workflow Library +[**list-workflow-library-actions**](#list-workflow-library-actions) | **Get** `/workflow-library/actions` | List Workflow Library Actions +[**list-workflow-library-operators**](#list-workflow-library-operators) | **Get** `/workflow-library/operators` | List Workflow Library Operators +[**list-workflow-library-triggers**](#list-workflow-library-triggers) | **Get** `/workflow-library/triggers` | List Workflow Library Triggers +[**list-workflows**](#list-workflows) | **Get** `/workflows` | List Workflows +[**patch-workflow**](#patch-workflow) | **Patch** `/workflows/{id}` | Patch Workflow +[**put-workflow**](#put-workflow) | **Put** `/workflows/{id}` | Update Workflow +[**test-external-execute-workflow**](#test-external-execute-workflow) | **Post** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger +[**test-workflow**](#test-workflow) | **Post** `/workflows/{id}/test` | Test Workflow By Id + + +## cancel-workflow-execution +Cancel Workflow Execution by ID +Use this API to cancel a running workflow execution. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/cancel-workflow-execution) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | The workflow execution ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCancelWorkflowExecutionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | The workflow execution ID # string | The workflow execution ID + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.WorkflowsAPI.CancelWorkflowExecution(context.Background(), id).Execute() + //r, err := apiClient.V3.WorkflowsAPI.CancelWorkflowExecution(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CancelWorkflowExecution``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## create-external-execute-workflow +Execute Workflow via External Trigger +This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-external-execute-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateExternalExecuteWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **createExternalExecuteWorkflowRequest** | [**CreateExternalExecuteWorkflowRequest**](../models/create-external-execute-workflow-request) | | + +### Return type + +[**CreateExternalExecuteWorkflow200Response**](../models/create-external-execute-workflow200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + createexternalexecuteworkflowrequest := []byte(``) // CreateExternalExecuteWorkflowRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.CreateExternalExecuteWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.CreateExternalExecuteWorkflow(context.Background(), id).CreateExternalExecuteWorkflowRequest(createExternalExecuteWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateExternalExecuteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateExternalExecuteWorkflow`: CreateExternalExecuteWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateExternalExecuteWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-workflow +Create Workflow +Create a new workflow with the desired trigger and steps specified in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-workflow) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createWorkflowRequest** | [**CreateWorkflowRequest**](../models/create-workflow-request) | | + +### Return type + +[**Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + createworkflowrequest := []byte(`{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}`) // CreateWorkflowRequest | + + + var createWorkflowRequest v3.CreateWorkflowRequest + if err := json.Unmarshal(createworkflowrequest, &createWorkflowRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.CreateWorkflow(context.Background()).CreateWorkflowRequest(createWorkflowRequest).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.CreateWorkflow(context.Background()).CreateWorkflowRequest(createWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## create-workflow-external-trigger +Generate External Trigger OAuth Client +Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-workflow-external-trigger) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateWorkflowExternalTriggerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**WorkflowOAuthClient**](../models/workflow-o-auth-client) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.CreateWorkflowExternalTrigger(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.CreateWorkflowExternalTrigger(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateWorkflowExternalTrigger``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkflowExternalTrigger`: WorkflowOAuthClient + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateWorkflowExternalTrigger`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## delete-workflow +Delete Workflow By Id +Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the Workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.WorkflowsAPI.DeleteWorkflow(context.Background(), id).Execute() + //r, err := apiClient.V3.WorkflowsAPI.DeleteWorkflow(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.DeleteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +[[Back to top]](#) + +## get-workflow +Get Workflow By Id +Get a single workflow by id. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **workflowMetrics** | **bool** | disable workflow metrics | [default to true] + +### Return type + +[**Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + workflowMetrics := false // bool | disable workflow metrics (optional) (default to true) # bool | disable workflow metrics (optional) (default to true) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.GetWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.GetWorkflow(context.Background(), id).WorkflowMetrics(workflowMetrics).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-workflow-execution +Get Workflow Execution +Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-execution) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Workflow execution ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkflowExecutionRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +**map[string]interface{}** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Workflow execution ID. # string | Workflow execution ID. + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.GetWorkflowExecution(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.GetWorkflowExecution(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecution``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecution`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecution`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-workflow-execution-history +Get Workflow Execution History +Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-execution-history) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow execution | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkflowExecutionHistoryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]WorkflowExecutionEvent**](../models/workflow-execution-event) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow execution # string | Id of the workflow execution + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.GetWorkflowExecutionHistory(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.GetWorkflowExecutionHistory(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutionHistory``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecutionHistory`: []WorkflowExecutionEvent + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutionHistory`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## get-workflow-executions +List Workflow Executions +Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: +1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. +2. Get your workflow ID from the response. +3. You can then do either of the following: + + - Filter to find relevant workflow executions. + For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq "Failed"` + + - Paginate through results with the `offset` parameter. + For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. + Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-executions) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Workflow ID. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetWorkflowExecutionsRequest struct via the builder pattern + + +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] + **count** | **bool** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [default to false] + **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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* | + +### Return type + +[**[]WorkflowExecution**](../models/workflow-execution) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Workflow ID. # string | Workflow 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `status eq "Failed"` // 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: **start_time**: *eq, lt, le, gt, ge* **status**: *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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.GetWorkflowExecutions(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.GetWorkflowExecutions(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecutions`: []WorkflowExecution + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-complete-workflow-library +List Complete Workflow Library +This lists all triggers, actions, and operators in the library + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-complete-workflow-library) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListCompleteWorkflowLibraryRequest struct via the builder pattern + + +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 + +[**[]ListCompleteWorkflowLibrary200ResponseInner**](../models/list-complete-workflow-library200-response-inner) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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.V3.WorkflowsAPI.ListCompleteWorkflowLibrary(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.ListCompleteWorkflowLibrary(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListCompleteWorkflowLibrary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCompleteWorkflowLibrary`: []ListCompleteWorkflowLibrary200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListCompleteWorkflowLibrary`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workflow-library-actions +List Workflow Library Actions +This lists the workflow actions available to you. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflow-library-actions) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkflowLibraryActionsRequest struct via the builder pattern + + +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] + **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* | + +### Return type + +[**[]WorkflowLibraryAction**](../models/workflow-library-action) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + filters := `id eq "sp:create-campaign"` // 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* (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* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.ListWorkflowLibraryActions(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.ListWorkflowLibraryActions(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryActions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryActions`: []WorkflowLibraryAction + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryActions`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workflow-library-operators +List Workflow Library Operators +This lists the workflow operators available to you + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflow-library-operators) + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkflowLibraryOperatorsRequest struct via the builder pattern + + +### Return type + +[**[]WorkflowLibraryOperator**](../models/workflow-library-operator) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.ListWorkflowLibraryOperators(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.ListWorkflowLibraryOperators(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryOperators``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryOperators`: []WorkflowLibraryOperator + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryOperators`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workflow-library-triggers +List Workflow Library Triggers +This lists the workflow triggers available to you + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflow-library-triggers) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkflowLibraryTriggersRequest struct via the builder pattern + + +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] + **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* | + +### Return type + +[**[]WorkflowLibraryTrigger**](../models/workflow-library-trigger) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + 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) + filters := `id eq "idn:identity-attributes-changed"` // 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* (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* (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.ListWorkflowLibraryTriggers(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.ListWorkflowLibraryTriggers(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryTriggers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryTriggers`: []WorkflowLibraryTrigger + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryTriggers`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## list-workflows +List Workflows +List all workflows in the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflows) + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiListWorkflowsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **triggerId** | **string** | Trigger ID | + **connectorInstanceId** | **string** | Connector Instance ID | + **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 + +[**[]Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + triggerId := `idn:identity-created` // string | Trigger ID (optional) # string | Trigger ID (optional) + connectorInstanceId := `28541fec-bb81-4ad4-88ef-0f7d213adcad` // string | Connector Instance ID (optional) # string | Connector Instance ID (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) + 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.V3.WorkflowsAPI.ListWorkflows(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.ListWorkflows(context.Background()).TriggerId(triggerId).ConnectorInstanceId(connectorInstanceId).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflows``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflows`: []Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflows`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## patch-workflow +Patch Workflow +Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the Workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPatchWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **jsonPatchOperation** | [**[]JsonPatchOperation**](../models/json-patch-operation) | | + +### Return type + +[**Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.PatchWorkflow(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.PatchWorkflow(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PatchWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PatchWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## put-workflow +Update Workflow +Perform a full update of a workflow. The updated workflow object is returned in the response. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the Workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **workflowBody** | [**WorkflowBody**](../models/workflow-body) | | + +### Return type + +[**Workflow**](../models/workflow) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + workflowbody := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : "{}", + "type" : "EVENT" + }, + "enabled" : false + }`) // WorkflowBody | + + + var workflowBody v3.WorkflowBody + if err := json.Unmarshal(workflowbody, &workflowBody); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.PutWorkflow(context.Background(), id).WorkflowBody(workflowBody).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.PutWorkflow(context.Background(), id).WorkflowBody(workflowBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PutWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PutWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-external-execute-workflow +Test Workflow via External Trigger +Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/test-external-execute-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestExternalExecuteWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **testExternalExecuteWorkflowRequest** | [**TestExternalExecuteWorkflowRequest**](../models/test-external-execute-workflow-request) | | + +### Return type + +[**TestExternalExecuteWorkflow200Response**](../models/test-external-execute-workflow200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + + + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + testexternalexecuteworkflowrequest := []byte(``) // TestExternalExecuteWorkflowRequest | (optional) + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.TestExternalExecuteWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.TestExternalExecuteWorkflow(context.Background(), id).TestExternalExecuteWorkflowRequest(testExternalExecuteWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.TestExternalExecuteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestExternalExecuteWorkflow`: TestExternalExecuteWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.TestExternalExecuteWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + +## test-workflow +Test Workflow By Id +:::info + +Workflow must be disabled in order to use this endpoint. + +::: + +Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. + +This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. + +**This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/test-workflow) + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**id** | **string** | Id of the workflow | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTestWorkflowRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **testWorkflowRequest** | [**TestWorkflowRequest**](../models/test-workflow-request) | | + +### Return type + +[**TestWorkflow200Response**](../models/test-workflow200-response) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" +) + +func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + testworkflowrequest := []byte(`{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}`) // TestWorkflowRequest | + + + var testWorkflowRequest v3.TestWorkflowRequest + if err := json.Unmarshal(testworkflowrequest, &testWorkflowRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.TestWorkflow(context.Background(), id).TestWorkflowRequest(testWorkflowRequest).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.TestWorkflow(context.Background(), id).TestWorkflowRequest(testWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.TestWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestWorkflow`: TestWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.TestWorkflow`: %v\n", resp) +} +``` + +[[Back to top]](#) + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Access.md b/docs/tools/sdk/go/Reference/V3/Models/Access.md new file mode 100644 index 000000000..3a71b8401 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Access.md @@ -0,0 +1,152 @@ +--- +id: access +title: Access +pagination_label: Access +sidebar_label: Access +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Access', 'Access'] +slug: /tools/sdk/go/v3/models/access +tags: ['SDK', 'Software Development Kit', 'Access', 'Access'] +--- + +# Access + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] + +## Methods + +### NewAccess + +`func NewAccess() *Access` + +NewAccess instantiates a new Access 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 + +### NewAccessWithDefaults + +`func NewAccessWithDefaults() *Access` + +NewAccessWithDefaults instantiates a new Access 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 + +### GetId + +`func (o *Access) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Access) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Access) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Access) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Access) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Access) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Access) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Access) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *Access) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *Access) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *Access) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *Access) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *Access) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Access) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Access) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Access) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Access) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Access) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessApps.md b/docs/tools/sdk/go/Reference/V3/Models/AccessApps.md new file mode 100644 index 000000000..c6c5e5d7e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessApps.md @@ -0,0 +1,142 @@ +--- +id: access-apps +title: AccessApps +pagination_label: AccessApps +sidebar_label: AccessApps +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessApps', 'AccessApps'] +slug: /tools/sdk/go/v3/models/access-apps +tags: ['SDK', 'Software Development Kit', 'AccessApps', 'AccessApps'] +--- + +# AccessApps + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | Name of application | [optional] +**Description** | Pointer to **string** | Description of application. | [optional] +**Owner** | Pointer to [**AccessAppsOwner**](access-apps-owner) | | [optional] + +## Methods + +### NewAccessApps + +`func NewAccessApps() *AccessApps` + +NewAccessApps instantiates a new AccessApps 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 + +### NewAccessAppsWithDefaults + +`func NewAccessAppsWithDefaults() *AccessApps` + +NewAccessAppsWithDefaults instantiates a new AccessApps 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 + +### GetId + +`func (o *AccessApps) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessApps) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessApps) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessApps) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessApps) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessApps) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessApps) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessApps) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessApps) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessApps) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessApps) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessApps) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *AccessApps) GetOwner() AccessAppsOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *AccessApps) GetOwnerOk() (*AccessAppsOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *AccessApps) SetOwner(v AccessAppsOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *AccessApps) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessAppsOwner.md b/docs/tools/sdk/go/Reference/V3/Models/AccessAppsOwner.md new file mode 100644 index 000000000..efffc2c54 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessAppsOwner.md @@ -0,0 +1,142 @@ +--- +id: access-apps-owner +title: AccessAppsOwner +pagination_label: AccessAppsOwner +sidebar_label: AccessAppsOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessAppsOwner', 'AccessAppsOwner'] +slug: /tools/sdk/go/v3/models/access-apps-owner +tags: ['SDK', 'Software Development Kit', 'AccessAppsOwner', 'AccessAppsOwner'] +--- + +# AccessAppsOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's DTO type. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's display name. | [optional] +**Email** | Pointer to **string** | Owner's email. | [optional] + +## Methods + +### NewAccessAppsOwner + +`func NewAccessAppsOwner() *AccessAppsOwner` + +NewAccessAppsOwner instantiates a new AccessAppsOwner 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 + +### NewAccessAppsOwnerWithDefaults + +`func NewAccessAppsOwnerWithDefaults() *AccessAppsOwner` + +NewAccessAppsOwnerWithDefaults instantiates a new AccessAppsOwner 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 + +### GetType + +`func (o *AccessAppsOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessAppsOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessAppsOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessAppsOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessAppsOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessAppsOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessAppsOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessAppsOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessAppsOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessAppsOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessAppsOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessAppsOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *AccessAppsOwner) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *AccessAppsOwner) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *AccessAppsOwner) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *AccessAppsOwner) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessConstraint.md b/docs/tools/sdk/go/Reference/V3/Models/AccessConstraint.md new file mode 100644 index 000000000..0d28fd370 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessConstraint.md @@ -0,0 +1,106 @@ +--- +id: access-constraint +title: AccessConstraint +pagination_label: AccessConstraint +sidebar_label: AccessConstraint +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessConstraint', 'AccessConstraint'] +slug: /tools/sdk/go/v3/models/access-constraint +tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'AccessConstraint'] +--- + +# AccessConstraint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of Access | +**Ids** | Pointer to **[]string** | Must be set only if operator is SELECTED. | [optional] +**Operator** | **string** | Used to determine whether the scope of the campaign should be reduced for selected ids or all. | + +## Methods + +### NewAccessConstraint + +`func NewAccessConstraint(type_ string, operator string, ) *AccessConstraint` + +NewAccessConstraint instantiates a new AccessConstraint 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 + +### NewAccessConstraintWithDefaults + +`func NewAccessConstraintWithDefaults() *AccessConstraint` + +NewAccessConstraintWithDefaults instantiates a new AccessConstraint 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 + +### GetType + +`func (o *AccessConstraint) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessConstraint) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessConstraint) SetType(v string)` + +SetType sets Type field to given value. + + +### GetIds + +`func (o *AccessConstraint) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *AccessConstraint) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *AccessConstraint) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *AccessConstraint) HasIds() bool` + +HasIds returns a boolean if a field has been set. + +### GetOperator + +`func (o *AccessConstraint) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *AccessConstraint) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *AccessConstraint) SetOperator(v string)` + +SetOperator sets Operator field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessCriteria.md b/docs/tools/sdk/go/Reference/V3/Models/AccessCriteria.md new file mode 100644 index 000000000..5228e9e81 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: access-criteria +title: AccessCriteria +pagination_label: AccessCriteria +sidebar_label: AccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessCriteria', 'AccessCriteria'] +slug: /tools/sdk/go/v3/models/access-criteria +tags: ['SDK', 'Software Development Kit', 'AccessCriteria', 'AccessCriteria'] +--- + +# AccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Business name for the access construct list | [optional] +**CriteriaList** | Pointer to [**[]AccessCriteriaCriteriaListInner**](access-criteria-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional] + +## Methods + +### NewAccessCriteria + +`func NewAccessCriteria() *AccessCriteria` + +NewAccessCriteria instantiates a new AccessCriteria 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 + +### NewAccessCriteriaWithDefaults + +`func NewAccessCriteriaWithDefaults() *AccessCriteria` + +NewAccessCriteriaWithDefaults instantiates a new AccessCriteria 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 + +### GetName + +`func (o *AccessCriteria) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessCriteria) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessCriteria) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessCriteria) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCriteriaList + +`func (o *AccessCriteria) GetCriteriaList() []AccessCriteriaCriteriaListInner` + +GetCriteriaList returns the CriteriaList field if non-nil, zero value otherwise. + +### GetCriteriaListOk + +`func (o *AccessCriteria) GetCriteriaListOk() (*[]AccessCriteriaCriteriaListInner, bool)` + +GetCriteriaListOk returns a tuple with the CriteriaList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteriaList + +`func (o *AccessCriteria) SetCriteriaList(v []AccessCriteriaCriteriaListInner)` + +SetCriteriaList sets CriteriaList field to given value. + +### HasCriteriaList + +`func (o *AccessCriteria) HasCriteriaList() bool` + +HasCriteriaList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessCriteriaCriteriaListInner.md b/docs/tools/sdk/go/Reference/V3/Models/AccessCriteriaCriteriaListInner.md new file mode 100644 index 000000000..a3de972db --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessCriteriaCriteriaListInner.md @@ -0,0 +1,116 @@ +--- +id: access-criteria-criteria-list-inner +title: AccessCriteriaCriteriaListInner +pagination_label: AccessCriteriaCriteriaListInner +sidebar_label: AccessCriteriaCriteriaListInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessCriteriaCriteriaListInner', 'AccessCriteriaCriteriaListInner'] +slug: /tools/sdk/go/v3/models/access-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'AccessCriteriaCriteriaListInner'] +--- + +# AccessCriteriaCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the propery to which this reference applies to | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies to | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies to | [optional] + +## Methods + +### NewAccessCriteriaCriteriaListInner + +`func NewAccessCriteriaCriteriaListInner() *AccessCriteriaCriteriaListInner` + +NewAccessCriteriaCriteriaListInner instantiates a new AccessCriteriaCriteriaListInner 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 + +### NewAccessCriteriaCriteriaListInnerWithDefaults + +`func NewAccessCriteriaCriteriaListInnerWithDefaults() *AccessCriteriaCriteriaListInner` + +NewAccessCriteriaCriteriaListInnerWithDefaults instantiates a new AccessCriteriaCriteriaListInner 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 + +### GetType + +`func (o *AccessCriteriaCriteriaListInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessCriteriaCriteriaListInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessCriteriaCriteriaListInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessCriteriaCriteriaListInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessCriteriaCriteriaListInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessCriteriaCriteriaListInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessCriteriaCriteriaListInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessCriteriaCriteriaListInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessCriteriaCriteriaListInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessCriteriaCriteriaListInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessCriteriaCriteriaListInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessCriteriaCriteriaListInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessItemRequestedFor.md b/docs/tools/sdk/go/Reference/V3/Models/AccessItemRequestedFor.md new file mode 100644 index 000000000..2a4fd14a1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessItemRequestedFor.md @@ -0,0 +1,116 @@ +--- +id: access-item-requested-for +title: AccessItemRequestedFor +pagination_label: AccessItemRequestedFor +sidebar_label: AccessItemRequestedFor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRequestedFor', 'AccessItemRequestedFor'] +slug: /tools/sdk/go/v3/models/access-item-requested-for +tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedFor', 'AccessItemRequestedFor'] +--- + +# AccessItemRequestedFor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity the access item is requested for. | [optional] +**Id** | Pointer to **string** | ID of identity the access item is requested for. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity the access item is requested for. | [optional] + +## Methods + +### NewAccessItemRequestedFor + +`func NewAccessItemRequestedFor() *AccessItemRequestedFor` + +NewAccessItemRequestedFor instantiates a new AccessItemRequestedFor 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 + +### NewAccessItemRequestedForWithDefaults + +`func NewAccessItemRequestedForWithDefaults() *AccessItemRequestedFor` + +NewAccessItemRequestedForWithDefaults instantiates a new AccessItemRequestedFor 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 + +### GetType + +`func (o *AccessItemRequestedFor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRequestedFor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRequestedFor) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRequestedFor) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRequestedFor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRequestedFor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRequestedFor) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRequestedFor) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemRequestedFor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemRequestedFor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemRequestedFor) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemRequestedFor) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessItemRequester.md b/docs/tools/sdk/go/Reference/V3/Models/AccessItemRequester.md new file mode 100644 index 000000000..f355fc1ef --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessItemRequester.md @@ -0,0 +1,116 @@ +--- +id: access-item-requester +title: AccessItemRequester +pagination_label: AccessItemRequester +sidebar_label: AccessItemRequester +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemRequester', 'AccessItemRequester'] +slug: /tools/sdk/go/v3/models/access-item-requester +tags: ['SDK', 'Software Development Kit', 'AccessItemRequester', 'AccessItemRequester'] +--- + +# AccessItemRequester + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Access item requester's DTO type. | [optional] +**Id** | Pointer to **string** | Access item requester's identity ID. | [optional] +**Name** | Pointer to **string** | Access item owner's human-readable display name. | [optional] + +## Methods + +### NewAccessItemRequester + +`func NewAccessItemRequester() *AccessItemRequester` + +NewAccessItemRequester instantiates a new AccessItemRequester 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 + +### NewAccessItemRequesterWithDefaults + +`func NewAccessItemRequesterWithDefaults() *AccessItemRequester` + +NewAccessItemRequesterWithDefaults instantiates a new AccessItemRequester 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 + +### GetType + +`func (o *AccessItemRequester) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemRequester) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemRequester) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemRequester) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemRequester) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemRequester) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemRequester) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemRequester) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemRequester) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemRequester) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemRequester) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemRequester) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessItemReviewedBy.md b/docs/tools/sdk/go/Reference/V3/Models/AccessItemReviewedBy.md new file mode 100644 index 000000000..12e63896d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessItemReviewedBy.md @@ -0,0 +1,116 @@ +--- +id: access-item-reviewed-by +title: AccessItemReviewedBy +pagination_label: AccessItemReviewedBy +sidebar_label: AccessItemReviewedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessItemReviewedBy', 'AccessItemReviewedBy'] +slug: /tools/sdk/go/v3/models/access-item-reviewed-by +tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy', 'AccessItemReviewedBy'] +--- + +# AccessItemReviewedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity who reviewed the access item request. | [optional] +**Id** | Pointer to **string** | ID of identity who reviewed the access item request. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity who reviewed the access item request. | [optional] + +## Methods + +### NewAccessItemReviewedBy + +`func NewAccessItemReviewedBy() *AccessItemReviewedBy` + +NewAccessItemReviewedBy instantiates a new AccessItemReviewedBy 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 + +### NewAccessItemReviewedByWithDefaults + +`func NewAccessItemReviewedByWithDefaults() *AccessItemReviewedBy` + +NewAccessItemReviewedByWithDefaults instantiates a new AccessItemReviewedBy 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 + +### GetType + +`func (o *AccessItemReviewedBy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessItemReviewedBy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessItemReviewedBy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessItemReviewedBy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessItemReviewedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessItemReviewedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessItemReviewedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessItemReviewedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessItemReviewedBy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessItemReviewedBy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessItemReviewedBy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessItemReviewedBy) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessModelMetadata.md b/docs/tools/sdk/go/Reference/V3/Models/AccessModelMetadata.md new file mode 100644 index 000000000..690da3897 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessModelMetadata.md @@ -0,0 +1,246 @@ +--- +id: access-model-metadata +title: AccessModelMetadata +pagination_label: AccessModelMetadata +sidebar_label: AccessModelMetadata +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessModelMetadata', 'AccessModelMetadata'] +slug: /tools/sdk/go/v3/models/access-model-metadata +tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'AccessModelMetadata'] +--- + +# AccessModelMetadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | Unique identifier for the metadata type | [optional] +**Name** | Pointer to **string** | Human readable name of the metadata type | [optional] +**Multiselect** | Pointer to **bool** | Allows selecting multiple values | [optional] [default to false] +**Status** | Pointer to **string** | The state of the metadata item | [optional] +**Type** | Pointer to **string** | The type of the metadata item | [optional] +**ObjectTypes** | Pointer to **[]string** | The types of objects | [optional] +**Description** | Pointer to **string** | Describes the metadata item | [optional] +**Values** | Pointer to [**[]AccessModelMetadataValuesInner**](access-model-metadata-values-inner) | The value to assign to the metadata item | [optional] + +## Methods + +### NewAccessModelMetadata + +`func NewAccessModelMetadata() *AccessModelMetadata` + +NewAccessModelMetadata instantiates a new AccessModelMetadata 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 + +### NewAccessModelMetadataWithDefaults + +`func NewAccessModelMetadataWithDefaults() *AccessModelMetadata` + +NewAccessModelMetadataWithDefaults instantiates a new AccessModelMetadata 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 + +### GetKey + +`func (o *AccessModelMetadata) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *AccessModelMetadata) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *AccessModelMetadata) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *AccessModelMetadata) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *AccessModelMetadata) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessModelMetadata) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessModelMetadata) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessModelMetadata) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetMultiselect + +`func (o *AccessModelMetadata) GetMultiselect() bool` + +GetMultiselect returns the Multiselect field if non-nil, zero value otherwise. + +### GetMultiselectOk + +`func (o *AccessModelMetadata) GetMultiselectOk() (*bool, bool)` + +GetMultiselectOk returns a tuple with the Multiselect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultiselect + +`func (o *AccessModelMetadata) SetMultiselect(v bool)` + +SetMultiselect sets Multiselect field to given value. + +### HasMultiselect + +`func (o *AccessModelMetadata) HasMultiselect() bool` + +HasMultiselect returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccessModelMetadata) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccessModelMetadata) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccessModelMetadata) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccessModelMetadata) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetType + +`func (o *AccessModelMetadata) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessModelMetadata) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessModelMetadata) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessModelMetadata) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetObjectTypes + +`func (o *AccessModelMetadata) GetObjectTypes() []string` + +GetObjectTypes returns the ObjectTypes field if non-nil, zero value otherwise. + +### GetObjectTypesOk + +`func (o *AccessModelMetadata) GetObjectTypesOk() (*[]string, bool)` + +GetObjectTypesOk returns a tuple with the ObjectTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectTypes + +`func (o *AccessModelMetadata) SetObjectTypes(v []string)` + +SetObjectTypes sets ObjectTypes field to given value. + +### HasObjectTypes + +`func (o *AccessModelMetadata) HasObjectTypes() bool` + +HasObjectTypes returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessModelMetadata) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessModelMetadata) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessModelMetadata) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessModelMetadata) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetValues + +`func (o *AccessModelMetadata) GetValues() []AccessModelMetadataValuesInner` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *AccessModelMetadata) GetValuesOk() (*[]AccessModelMetadataValuesInner, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *AccessModelMetadata) SetValues(v []AccessModelMetadataValuesInner)` + +SetValues sets Values field to given value. + +### HasValues + +`func (o *AccessModelMetadata) HasValues() bool` + +HasValues returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessModelMetadataValuesInner.md b/docs/tools/sdk/go/Reference/V3/Models/AccessModelMetadataValuesInner.md new file mode 100644 index 000000000..929491d43 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessModelMetadataValuesInner.md @@ -0,0 +1,116 @@ +--- +id: access-model-metadata-values-inner +title: AccessModelMetadataValuesInner +pagination_label: AccessModelMetadataValuesInner +sidebar_label: AccessModelMetadataValuesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessModelMetadataValuesInner', 'AccessModelMetadataValuesInner'] +slug: /tools/sdk/go/v3/models/access-model-metadata-values-inner +tags: ['SDK', 'Software Development Kit', 'AccessModelMetadataValuesInner', 'AccessModelMetadataValuesInner'] +--- + +# AccessModelMetadataValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | The value to assign to the metdata item | [optional] +**Name** | Pointer to **string** | Display name of the value | [optional] +**Status** | Pointer to **string** | The status of the individual value | [optional] + +## Methods + +### NewAccessModelMetadataValuesInner + +`func NewAccessModelMetadataValuesInner() *AccessModelMetadataValuesInner` + +NewAccessModelMetadataValuesInner instantiates a new AccessModelMetadataValuesInner 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 + +### NewAccessModelMetadataValuesInnerWithDefaults + +`func NewAccessModelMetadataValuesInnerWithDefaults() *AccessModelMetadataValuesInner` + +NewAccessModelMetadataValuesInnerWithDefaults instantiates a new AccessModelMetadataValuesInner 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 + +### GetValue + +`func (o *AccessModelMetadataValuesInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AccessModelMetadataValuesInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AccessModelMetadataValuesInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AccessModelMetadataValuesInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetName + +`func (o *AccessModelMetadataValuesInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessModelMetadataValuesInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessModelMetadataValuesInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessModelMetadataValuesInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccessModelMetadataValuesInner) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccessModelMetadataValuesInner) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccessModelMetadataValuesInner) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccessModelMetadataValuesInner) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessProfile.md b/docs/tools/sdk/go/Reference/V3/Models/AccessProfile.md new file mode 100644 index 000000000..c537b18e6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessProfile.md @@ -0,0 +1,447 @@ +--- +id: access-profile +title: AccessProfile +pagination_label: AccessProfile +sidebar_label: AccessProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfile', 'AccessProfile'] +slug: /tools/sdk/go/v3/models/access-profile +tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'AccessProfile'] +--- + +# AccessProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Access profile ID. | [optional] [readonly] +**Name** | **string** | Access profile name. | +**Description** | Pointer to **NullableString** | Access profile description. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time when the access profile was created. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Date and time when the access profile was last modified. | [optional] [readonly] +**Enabled** | Pointer to **bool** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to false] +**Owner** | [**OwnerReference**](owner-reference) | | +**Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | +**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**Requestable** | Pointer to **bool** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to true] +**AccessRequestConfig** | Pointer to [**NullableRequestability**](requestability) | | [optional] +**RevocationRequestConfig** | Pointer to [**NullableRevocability**](revocability) | | [optional] +**Segments** | Pointer to **[]string** | List of segment IDs, if any, that the access profile is assigned to. | [optional] +**ProvisioningCriteria** | Pointer to [**NullableProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] + +## Methods + +### NewAccessProfile + +`func NewAccessProfile(name string, owner OwnerReference, source AccessProfileSourceRef, ) *AccessProfile` + +NewAccessProfile instantiates a new AccessProfile 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 + +### NewAccessProfileWithDefaults + +`func NewAccessProfileWithDefaults() *AccessProfile` + +NewAccessProfileWithDefaults instantiates a new AccessProfile 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 + +### GetId + +`func (o *AccessProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfile) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *AccessProfile) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfile) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfile) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfile) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessProfile) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessProfile) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCreated + +`func (o *AccessProfile) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccessProfile) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccessProfile) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccessProfile) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *AccessProfile) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccessProfile) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccessProfile) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccessProfile) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetEnabled + +`func (o *AccessProfile) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AccessProfile) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AccessProfile) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *AccessProfile) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetOwner + +`func (o *AccessProfile) GetOwner() OwnerReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *AccessProfile) GetOwnerOk() (*OwnerReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *AccessProfile) SetOwner(v OwnerReference)` + +SetOwner sets Owner field to given value. + + +### GetSource + +`func (o *AccessProfile) GetSource() AccessProfileSourceRef` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccessProfile) GetSourceOk() (*AccessProfileSourceRef, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccessProfile) SetSource(v AccessProfileSourceRef)` + +SetSource sets Source field to given value. + + +### GetEntitlements + +`func (o *AccessProfile) GetEntitlements() []EntitlementRef` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *AccessProfile) GetEntitlementsOk() (*[]EntitlementRef, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *AccessProfile) SetEntitlements(v []EntitlementRef)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *AccessProfile) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### SetEntitlementsNil + +`func (o *AccessProfile) SetEntitlementsNil(b bool)` + + SetEntitlementsNil sets the value for Entitlements to be an explicit nil + +### UnsetEntitlements +`func (o *AccessProfile) UnsetEntitlements()` + +UnsetEntitlements ensures that no value is present for Entitlements, not even an explicit nil +### GetRequestable + +`func (o *AccessProfile) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *AccessProfile) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *AccessProfile) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *AccessProfile) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetAccessRequestConfig + +`func (o *AccessProfile) GetAccessRequestConfig() Requestability` + +GetAccessRequestConfig returns the AccessRequestConfig field if non-nil, zero value otherwise. + +### GetAccessRequestConfigOk + +`func (o *AccessProfile) GetAccessRequestConfigOk() (*Requestability, bool)` + +GetAccessRequestConfigOk returns a tuple with the AccessRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestConfig + +`func (o *AccessProfile) SetAccessRequestConfig(v Requestability)` + +SetAccessRequestConfig sets AccessRequestConfig field to given value. + +### HasAccessRequestConfig + +`func (o *AccessProfile) HasAccessRequestConfig() bool` + +HasAccessRequestConfig returns a boolean if a field has been set. + +### SetAccessRequestConfigNil + +`func (o *AccessProfile) SetAccessRequestConfigNil(b bool)` + + SetAccessRequestConfigNil sets the value for AccessRequestConfig to be an explicit nil + +### UnsetAccessRequestConfig +`func (o *AccessProfile) UnsetAccessRequestConfig()` + +UnsetAccessRequestConfig ensures that no value is present for AccessRequestConfig, not even an explicit nil +### GetRevocationRequestConfig + +`func (o *AccessProfile) GetRevocationRequestConfig() Revocability` + +GetRevocationRequestConfig returns the RevocationRequestConfig field if non-nil, zero value otherwise. + +### GetRevocationRequestConfigOk + +`func (o *AccessProfile) GetRevocationRequestConfigOk() (*Revocability, bool)` + +GetRevocationRequestConfigOk returns a tuple with the RevocationRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocationRequestConfig + +`func (o *AccessProfile) SetRevocationRequestConfig(v Revocability)` + +SetRevocationRequestConfig sets RevocationRequestConfig field to given value. + +### HasRevocationRequestConfig + +`func (o *AccessProfile) HasRevocationRequestConfig() bool` + +HasRevocationRequestConfig returns a boolean if a field has been set. + +### SetRevocationRequestConfigNil + +`func (o *AccessProfile) SetRevocationRequestConfigNil(b bool)` + + SetRevocationRequestConfigNil sets the value for RevocationRequestConfig to be an explicit nil + +### UnsetRevocationRequestConfig +`func (o *AccessProfile) UnsetRevocationRequestConfig()` + +UnsetRevocationRequestConfig ensures that no value is present for RevocationRequestConfig, not even an explicit nil +### GetSegments + +`func (o *AccessProfile) GetSegments() []string` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *AccessProfile) GetSegmentsOk() (*[]string, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *AccessProfile) SetSegments(v []string)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *AccessProfile) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### SetSegmentsNil + +`func (o *AccessProfile) SetSegmentsNil(b bool)` + + SetSegmentsNil sets the value for Segments to be an explicit nil + +### UnsetSegments +`func (o *AccessProfile) UnsetSegments()` + +UnsetSegments ensures that no value is present for Segments, not even an explicit nil +### GetProvisioningCriteria + +`func (o *AccessProfile) GetProvisioningCriteria() ProvisioningCriteriaLevel1` + +GetProvisioningCriteria returns the ProvisioningCriteria field if non-nil, zero value otherwise. + +### GetProvisioningCriteriaOk + +`func (o *AccessProfile) GetProvisioningCriteriaOk() (*ProvisioningCriteriaLevel1, bool)` + +GetProvisioningCriteriaOk returns a tuple with the ProvisioningCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningCriteria + +`func (o *AccessProfile) SetProvisioningCriteria(v ProvisioningCriteriaLevel1)` + +SetProvisioningCriteria sets ProvisioningCriteria field to given value. + +### HasProvisioningCriteria + +`func (o *AccessProfile) HasProvisioningCriteria() bool` + +HasProvisioningCriteria returns a boolean if a field has been set. + +### SetProvisioningCriteriaNil + +`func (o *AccessProfile) SetProvisioningCriteriaNil(b bool)` + + SetProvisioningCriteriaNil sets the value for ProvisioningCriteria to be an explicit nil + +### UnsetProvisioningCriteria +`func (o *AccessProfile) UnsetProvisioningCriteria()` + +UnsetProvisioningCriteria ensures that no value is present for ProvisioningCriteria, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileApprovalScheme.md new file mode 100644 index 000000000..b7d15ff71 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileApprovalScheme.md @@ -0,0 +1,100 @@ +--- +id: access-profile-approval-scheme +title: AccessProfileApprovalScheme +pagination_label: AccessProfileApprovalScheme +sidebar_label: AccessProfileApprovalScheme +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileApprovalScheme', 'AccessProfileApprovalScheme'] +slug: /tools/sdk/go/v3/models/access-profile-approval-scheme +tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'AccessProfileApprovalScheme'] +--- + +# AccessProfileApprovalScheme + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApproverType** | Pointer to **string** | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | Pointer to **NullableString** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] + +## Methods + +### NewAccessProfileApprovalScheme + +`func NewAccessProfileApprovalScheme() *AccessProfileApprovalScheme` + +NewAccessProfileApprovalScheme instantiates a new AccessProfileApprovalScheme 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 + +### NewAccessProfileApprovalSchemeWithDefaults + +`func NewAccessProfileApprovalSchemeWithDefaults() *AccessProfileApprovalScheme` + +NewAccessProfileApprovalSchemeWithDefaults instantiates a new AccessProfileApprovalScheme 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 + +### GetApproverType + +`func (o *AccessProfileApprovalScheme) GetApproverType() string` + +GetApproverType returns the ApproverType field if non-nil, zero value otherwise. + +### GetApproverTypeOk + +`func (o *AccessProfileApprovalScheme) GetApproverTypeOk() (*string, bool)` + +GetApproverTypeOk returns a tuple with the ApproverType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverType + +`func (o *AccessProfileApprovalScheme) SetApproverType(v string)` + +SetApproverType sets ApproverType field to given value. + +### HasApproverType + +`func (o *AccessProfileApprovalScheme) HasApproverType() bool` + +HasApproverType returns a boolean if a field has been set. + +### GetApproverId + +`func (o *AccessProfileApprovalScheme) GetApproverId() string` + +GetApproverId returns the ApproverId field if non-nil, zero value otherwise. + +### GetApproverIdOk + +`func (o *AccessProfileApprovalScheme) GetApproverIdOk() (*string, bool)` + +GetApproverIdOk returns a tuple with the ApproverId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverId + +`func (o *AccessProfileApprovalScheme) SetApproverId(v string)` + +SetApproverId sets ApproverId field to given value. + +### HasApproverId + +`func (o *AccessProfileApprovalScheme) HasApproverId() bool` + +HasApproverId returns a boolean if a field has been set. + +### SetApproverIdNil + +`func (o *AccessProfileApprovalScheme) SetApproverIdNil(b bool)` + + SetApproverIdNil sets the value for ApproverId to be an explicit nil + +### UnsetApproverId +`func (o *AccessProfileApprovalScheme) UnsetApproverId()` + +UnsetApproverId ensures that no value is present for ApproverId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessProfileBulkDeleteRequest.md b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileBulkDeleteRequest.md new file mode 100644 index 000000000..bba02d680 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileBulkDeleteRequest.md @@ -0,0 +1,90 @@ +--- +id: access-profile-bulk-delete-request +title: AccessProfileBulkDeleteRequest +pagination_label: AccessProfileBulkDeleteRequest +sidebar_label: AccessProfileBulkDeleteRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileBulkDeleteRequest', 'AccessProfileBulkDeleteRequest'] +slug: /tools/sdk/go/v3/models/access-profile-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest', 'AccessProfileBulkDeleteRequest'] +--- + +# AccessProfileBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessProfileIds** | Pointer to **[]string** | List of IDs of Access Profiles to be deleted. | [optional] +**BestEffortOnly** | Pointer to **bool** | If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. | [optional] + +## Methods + +### NewAccessProfileBulkDeleteRequest + +`func NewAccessProfileBulkDeleteRequest() *AccessProfileBulkDeleteRequest` + +NewAccessProfileBulkDeleteRequest instantiates a new AccessProfileBulkDeleteRequest 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 + +### NewAccessProfileBulkDeleteRequestWithDefaults + +`func NewAccessProfileBulkDeleteRequestWithDefaults() *AccessProfileBulkDeleteRequest` + +NewAccessProfileBulkDeleteRequestWithDefaults instantiates a new AccessProfileBulkDeleteRequest 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 + +### GetAccessProfileIds + +`func (o *AccessProfileBulkDeleteRequest) GetAccessProfileIds() []string` + +GetAccessProfileIds returns the AccessProfileIds field if non-nil, zero value otherwise. + +### GetAccessProfileIdsOk + +`func (o *AccessProfileBulkDeleteRequest) GetAccessProfileIdsOk() (*[]string, bool)` + +GetAccessProfileIdsOk returns a tuple with the AccessProfileIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileIds + +`func (o *AccessProfileBulkDeleteRequest) SetAccessProfileIds(v []string)` + +SetAccessProfileIds sets AccessProfileIds field to given value. + +### HasAccessProfileIds + +`func (o *AccessProfileBulkDeleteRequest) HasAccessProfileIds() bool` + +HasAccessProfileIds returns a boolean if a field has been set. + +### GetBestEffortOnly + +`func (o *AccessProfileBulkDeleteRequest) GetBestEffortOnly() bool` + +GetBestEffortOnly returns the BestEffortOnly field if non-nil, zero value otherwise. + +### GetBestEffortOnlyOk + +`func (o *AccessProfileBulkDeleteRequest) GetBestEffortOnlyOk() (*bool, bool)` + +GetBestEffortOnlyOk returns a tuple with the BestEffortOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBestEffortOnly + +`func (o *AccessProfileBulkDeleteRequest) SetBestEffortOnly(v bool)` + +SetBestEffortOnly sets BestEffortOnly field to given value. + +### HasBestEffortOnly + +`func (o *AccessProfileBulkDeleteRequest) HasBestEffortOnly() bool` + +HasBestEffortOnly returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessProfileBulkDeleteResponse.md b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileBulkDeleteResponse.md new file mode 100644 index 000000000..f83c91190 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileBulkDeleteResponse.md @@ -0,0 +1,116 @@ +--- +id: access-profile-bulk-delete-response +title: AccessProfileBulkDeleteResponse +pagination_label: AccessProfileBulkDeleteResponse +sidebar_label: AccessProfileBulkDeleteResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileBulkDeleteResponse', 'AccessProfileBulkDeleteResponse'] +slug: /tools/sdk/go/v3/models/access-profile-bulk-delete-response +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse', 'AccessProfileBulkDeleteResponse'] +--- + +# AccessProfileBulkDeleteResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TaskId** | Pointer to **string** | ID of the task which is executing the bulk deletion. This can be passed to the **_/task-status** API to track status. | [optional] +**Pending** | Pointer to **[]string** | List of IDs of Access Profiles which are pending deletion. | [optional] +**InUse** | Pointer to [**[]AccessProfileUsage**](access-profile-usage) | List of usages of Access Profiles targeted for deletion. | [optional] + +## Methods + +### NewAccessProfileBulkDeleteResponse + +`func NewAccessProfileBulkDeleteResponse() *AccessProfileBulkDeleteResponse` + +NewAccessProfileBulkDeleteResponse instantiates a new AccessProfileBulkDeleteResponse 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 + +### NewAccessProfileBulkDeleteResponseWithDefaults + +`func NewAccessProfileBulkDeleteResponseWithDefaults() *AccessProfileBulkDeleteResponse` + +NewAccessProfileBulkDeleteResponseWithDefaults instantiates a new AccessProfileBulkDeleteResponse 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 + +### GetTaskId + +`func (o *AccessProfileBulkDeleteResponse) GetTaskId() string` + +GetTaskId returns the TaskId field if non-nil, zero value otherwise. + +### GetTaskIdOk + +`func (o *AccessProfileBulkDeleteResponse) GetTaskIdOk() (*string, bool)` + +GetTaskIdOk returns a tuple with the TaskId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskId + +`func (o *AccessProfileBulkDeleteResponse) SetTaskId(v string)` + +SetTaskId sets TaskId field to given value. + +### HasTaskId + +`func (o *AccessProfileBulkDeleteResponse) HasTaskId() bool` + +HasTaskId returns a boolean if a field has been set. + +### GetPending + +`func (o *AccessProfileBulkDeleteResponse) GetPending() []string` + +GetPending returns the Pending field if non-nil, zero value otherwise. + +### GetPendingOk + +`func (o *AccessProfileBulkDeleteResponse) GetPendingOk() (*[]string, bool)` + +GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPending + +`func (o *AccessProfileBulkDeleteResponse) SetPending(v []string)` + +SetPending sets Pending field to given value. + +### HasPending + +`func (o *AccessProfileBulkDeleteResponse) HasPending() bool` + +HasPending returns a boolean if a field has been set. + +### GetInUse + +`func (o *AccessProfileBulkDeleteResponse) GetInUse() []AccessProfileUsage` + +GetInUse returns the InUse field if non-nil, zero value otherwise. + +### GetInUseOk + +`func (o *AccessProfileBulkDeleteResponse) GetInUseOk() (*[]AccessProfileUsage, bool)` + +GetInUseOk returns a tuple with the InUse field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInUse + +`func (o *AccessProfileBulkDeleteResponse) SetInUse(v []AccessProfileUsage)` + +SetInUse sets InUse field to given value. + +### HasInUse + +`func (o *AccessProfileBulkDeleteResponse) HasInUse() bool` + +HasInUse returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessProfileDocument.md b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileDocument.md new file mode 100644 index 000000000..2a7dd8c99 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileDocument.md @@ -0,0 +1,500 @@ +--- +id: access-profile-document +title: AccessProfileDocument +pagination_label: AccessProfileDocument +sidebar_label: AccessProfileDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileDocument', 'AccessProfileDocument'] +slug: /tools/sdk/go/v3/models/access-profile-document +tags: ['SDK', 'Software Development Kit', 'AccessProfileDocument', 'AccessProfileDocument'] +--- + +# AccessProfileDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Access item's description. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **NullableTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Enabled** | Pointer to **bool** | Indicates whether the access item is currently enabled. | [optional] [default to false] +**Requestable** | Pointer to **bool** | Indicates whether the access item can be requested. | [optional] [default to true] +**RequestCommentsRequired** | Pointer to **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to false] +**Owner** | Pointer to [**BaseAccessOwner**](base-access-owner) | | [optional] +**Id** | **string** | Access profile's ID. | +**Name** | **string** | Access profile's name. | +**Source** | Pointer to [**AccessProfileDocumentAllOfSource**](access-profile-document-all-of-source) | | [optional] +**Entitlements** | Pointer to [**[]BaseEntitlement**](base-entitlement) | Entitlements the access profile has access to. | [optional] +**EntitlementCount** | Pointer to **int32** | Number of entitlements. | [optional] +**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the access profile. | [optional] +**SegmentCount** | Pointer to **int32** | Number of segments with the access profile. | [optional] +**Tags** | Pointer to **[]string** | Tags that have been applied to the object. | [optional] +**Apps** | Pointer to [**[]AccessApps**](access-apps) | Applications with the access profile | [optional] + +## Methods + +### NewAccessProfileDocument + +`func NewAccessProfileDocument(id string, name string, ) *AccessProfileDocument` + +NewAccessProfileDocument instantiates a new AccessProfileDocument 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 + +### NewAccessProfileDocumentWithDefaults + +`func NewAccessProfileDocumentWithDefaults() *AccessProfileDocument` + +NewAccessProfileDocumentWithDefaults instantiates a new AccessProfileDocument 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 + +### GetDescription + +`func (o *AccessProfileDocument) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileDocument) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileDocument) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileDocument) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetCreated + +`func (o *AccessProfileDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccessProfileDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccessProfileDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccessProfileDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *AccessProfileDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *AccessProfileDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *AccessProfileDocument) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccessProfileDocument) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccessProfileDocument) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccessProfileDocument) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *AccessProfileDocument) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *AccessProfileDocument) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *AccessProfileDocument) GetSynced() SailPointTime` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *AccessProfileDocument) GetSyncedOk() (*SailPointTime, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *AccessProfileDocument) SetSynced(v SailPointTime)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *AccessProfileDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### SetSyncedNil + +`func (o *AccessProfileDocument) SetSyncedNil(b bool)` + + SetSyncedNil sets the value for Synced to be an explicit nil + +### UnsetSynced +`func (o *AccessProfileDocument) UnsetSynced()` + +UnsetSynced ensures that no value is present for Synced, not even an explicit nil +### GetEnabled + +`func (o *AccessProfileDocument) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *AccessProfileDocument) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *AccessProfileDocument) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *AccessProfileDocument) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetRequestable + +`func (o *AccessProfileDocument) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *AccessProfileDocument) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *AccessProfileDocument) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *AccessProfileDocument) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetRequestCommentsRequired + +`func (o *AccessProfileDocument) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *AccessProfileDocument) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *AccessProfileDocument) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *AccessProfileDocument) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + +### GetOwner + +`func (o *AccessProfileDocument) GetOwner() BaseAccessOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *AccessProfileDocument) GetOwnerOk() (*BaseAccessOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *AccessProfileDocument) SetOwner(v BaseAccessOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *AccessProfileDocument) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetId + +`func (o *AccessProfileDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileDocument) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *AccessProfileDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileDocument) SetName(v string)` + +SetName sets Name field to given value. + + +### GetSource + +`func (o *AccessProfileDocument) GetSource() AccessProfileDocumentAllOfSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccessProfileDocument) GetSourceOk() (*AccessProfileDocumentAllOfSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccessProfileDocument) SetSource(v AccessProfileDocumentAllOfSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *AccessProfileDocument) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetEntitlements + +`func (o *AccessProfileDocument) GetEntitlements() []BaseEntitlement` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *AccessProfileDocument) GetEntitlementsOk() (*[]BaseEntitlement, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *AccessProfileDocument) SetEntitlements(v []BaseEntitlement)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *AccessProfileDocument) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *AccessProfileDocument) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *AccessProfileDocument) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *AccessProfileDocument) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *AccessProfileDocument) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetSegments + +`func (o *AccessProfileDocument) GetSegments() []BaseSegment` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *AccessProfileDocument) GetSegmentsOk() (*[]BaseSegment, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *AccessProfileDocument) SetSegments(v []BaseSegment)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *AccessProfileDocument) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### GetSegmentCount + +`func (o *AccessProfileDocument) GetSegmentCount() int32` + +GetSegmentCount returns the SegmentCount field if non-nil, zero value otherwise. + +### GetSegmentCountOk + +`func (o *AccessProfileDocument) GetSegmentCountOk() (*int32, bool)` + +GetSegmentCountOk returns a tuple with the SegmentCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegmentCount + +`func (o *AccessProfileDocument) SetSegmentCount(v int32)` + +SetSegmentCount sets SegmentCount field to given value. + +### HasSegmentCount + +`func (o *AccessProfileDocument) HasSegmentCount() bool` + +HasSegmentCount returns a boolean if a field has been set. + +### GetTags + +`func (o *AccessProfileDocument) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *AccessProfileDocument) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *AccessProfileDocument) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *AccessProfileDocument) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetApps + +`func (o *AccessProfileDocument) GetApps() []AccessApps` + +GetApps returns the Apps field if non-nil, zero value otherwise. + +### GetAppsOk + +`func (o *AccessProfileDocument) GetAppsOk() (*[]AccessApps, bool)` + +GetAppsOk returns a tuple with the Apps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApps + +`func (o *AccessProfileDocument) SetApps(v []AccessApps)` + +SetApps sets Apps field to given value. + +### HasApps + +`func (o *AccessProfileDocument) HasApps() bool` + +HasApps returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessProfileDocumentAllOfSource.md b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileDocumentAllOfSource.md new file mode 100644 index 000000000..3426237a7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileDocumentAllOfSource.md @@ -0,0 +1,90 @@ +--- +id: access-profile-document-all-of-source +title: AccessProfileDocumentAllOfSource +pagination_label: AccessProfileDocumentAllOfSource +sidebar_label: AccessProfileDocumentAllOfSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileDocumentAllOfSource', 'AccessProfileDocumentAllOfSource'] +slug: /tools/sdk/go/v3/models/access-profile-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'AccessProfileDocumentAllOfSource', 'AccessProfileDocumentAllOfSource'] +--- + +# AccessProfileDocumentAllOfSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Source's ID. | [optional] +**Name** | Pointer to **string** | Source's name. | [optional] + +## Methods + +### NewAccessProfileDocumentAllOfSource + +`func NewAccessProfileDocumentAllOfSource() *AccessProfileDocumentAllOfSource` + +NewAccessProfileDocumentAllOfSource instantiates a new AccessProfileDocumentAllOfSource 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 + +### NewAccessProfileDocumentAllOfSourceWithDefaults + +`func NewAccessProfileDocumentAllOfSourceWithDefaults() *AccessProfileDocumentAllOfSource` + +NewAccessProfileDocumentAllOfSourceWithDefaults instantiates a new AccessProfileDocumentAllOfSource 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 + +### GetId + +`func (o *AccessProfileDocumentAllOfSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileDocumentAllOfSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileDocumentAllOfSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileDocumentAllOfSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileDocumentAllOfSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileDocumentAllOfSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileDocumentAllOfSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileDocumentAllOfSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessProfileEntitlement.md b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileEntitlement.md new file mode 100644 index 000000000..de3392aa6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileEntitlement.md @@ -0,0 +1,308 @@ +--- +id: access-profile-entitlement +title: AccessProfileEntitlement +pagination_label: AccessProfileEntitlement +sidebar_label: AccessProfileEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileEntitlement', 'AccessProfileEntitlement'] +slug: /tools/sdk/go/v3/models/access-profile-entitlement +tags: ['SDK', 'Software Development Kit', 'AccessProfileEntitlement', 'AccessProfileEntitlement'] +--- + +# AccessProfileEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Source** | Pointer to [**Reference**](reference) | | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Privileged** | Pointer to **bool** | | [optional] +**Attribute** | Pointer to **string** | | [optional] +**Value** | Pointer to **string** | | [optional] +**Standalone** | Pointer to **bool** | | [optional] + +## Methods + +### NewAccessProfileEntitlement + +`func NewAccessProfileEntitlement() *AccessProfileEntitlement` + +NewAccessProfileEntitlement instantiates a new AccessProfileEntitlement 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 + +### NewAccessProfileEntitlementWithDefaults + +`func NewAccessProfileEntitlementWithDefaults() *AccessProfileEntitlement` + +NewAccessProfileEntitlementWithDefaults instantiates a new AccessProfileEntitlement 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 + +### GetId + +`func (o *AccessProfileEntitlement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileEntitlement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileEntitlement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileEntitlement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileEntitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileEntitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileEntitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileEntitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessProfileEntitlement) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessProfileEntitlement) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessProfileEntitlement) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessProfileEntitlement) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessProfileEntitlement) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileEntitlement) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileEntitlement) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileEntitlement) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessProfileEntitlement) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessProfileEntitlement) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSource + +`func (o *AccessProfileEntitlement) GetSource() Reference` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccessProfileEntitlement) GetSourceOk() (*Reference, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccessProfileEntitlement) SetSource(v Reference)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *AccessProfileEntitlement) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetType + +`func (o *AccessProfileEntitlement) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileEntitlement) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileEntitlement) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileEntitlement) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *AccessProfileEntitlement) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *AccessProfileEntitlement) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *AccessProfileEntitlement) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *AccessProfileEntitlement) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetAttribute + +`func (o *AccessProfileEntitlement) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *AccessProfileEntitlement) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *AccessProfileEntitlement) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *AccessProfileEntitlement) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *AccessProfileEntitlement) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AccessProfileEntitlement) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AccessProfileEntitlement) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AccessProfileEntitlement) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetStandalone + +`func (o *AccessProfileEntitlement) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *AccessProfileEntitlement) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *AccessProfileEntitlement) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + +### HasStandalone + +`func (o *AccessProfileEntitlement) HasStandalone() bool` + +HasStandalone returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessProfileRef.md b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileRef.md new file mode 100644 index 000000000..c059a6e46 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileRef.md @@ -0,0 +1,116 @@ +--- +id: access-profile-ref +title: AccessProfileRef +pagination_label: AccessProfileRef +sidebar_label: AccessProfileRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileRef', 'AccessProfileRef'] +slug: /tools/sdk/go/v3/models/access-profile-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'AccessProfileRef'] +--- + +# AccessProfileRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the Access Profile | [optional] +**Type** | Pointer to **string** | Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result. | [optional] +**Name** | Pointer to **string** | Human-readable display name of the Access Profile. This field is ignored on input. | [optional] + +## Methods + +### NewAccessProfileRef + +`func NewAccessProfileRef() *AccessProfileRef` + +NewAccessProfileRef instantiates a new AccessProfileRef 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 + +### NewAccessProfileRefWithDefaults + +`func NewAccessProfileRefWithDefaults() *AccessProfileRef` + +NewAccessProfileRefWithDefaults instantiates a new AccessProfileRef 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 + +### GetId + +`func (o *AccessProfileRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessProfileRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessProfileRole.md b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileRole.md new file mode 100644 index 000000000..a9484045d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileRole.md @@ -0,0 +1,256 @@ +--- +id: access-profile-role +title: AccessProfileRole +pagination_label: AccessProfileRole +sidebar_label: AccessProfileRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileRole', 'AccessProfileRole'] +slug: /tools/sdk/go/v3/models/access-profile-role +tags: ['SDK', 'Software Development Kit', 'AccessProfileRole', 'AccessProfileRole'] +--- + +# AccessProfileRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional] +**Disabled** | Pointer to **bool** | | [optional] +**Revocable** | Pointer to **bool** | | [optional] + +## Methods + +### NewAccessProfileRole + +`func NewAccessProfileRole() *AccessProfileRole` + +NewAccessProfileRole instantiates a new AccessProfileRole 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 + +### NewAccessProfileRoleWithDefaults + +`func NewAccessProfileRoleWithDefaults() *AccessProfileRole` + +NewAccessProfileRoleWithDefaults instantiates a new AccessProfileRole 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 + +### GetId + +`func (o *AccessProfileRole) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileRole) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileRole) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileRole) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileRole) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileRole) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileRole) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileRole) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessProfileRole) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessProfileRole) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessProfileRole) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessProfileRole) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessProfileRole) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileRole) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileRole) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileRole) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessProfileRole) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessProfileRole) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *AccessProfileRole) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileRole) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileRole) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileRole) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetOwner + +`func (o *AccessProfileRole) GetOwner() DisplayReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *AccessProfileRole) GetOwnerOk() (*DisplayReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *AccessProfileRole) SetOwner(v DisplayReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *AccessProfileRole) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDisabled + +`func (o *AccessProfileRole) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *AccessProfileRole) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *AccessProfileRole) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *AccessProfileRole) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetRevocable + +`func (o *AccessProfileRole) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *AccessProfileRole) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *AccessProfileRole) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *AccessProfileRole) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessProfileSourceRef.md b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileSourceRef.md new file mode 100644 index 000000000..083943497 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileSourceRef.md @@ -0,0 +1,116 @@ +--- +id: access-profile-source-ref +title: AccessProfileSourceRef +pagination_label: AccessProfileSourceRef +sidebar_label: AccessProfileSourceRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileSourceRef', 'AccessProfileSourceRef'] +slug: /tools/sdk/go/v3/models/access-profile-source-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'AccessProfileSourceRef'] +--- + +# AccessProfileSourceRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the source the access profile is associated with. | [optional] +**Type** | Pointer to **string** | Source's DTO type. | [optional] +**Name** | Pointer to **string** | Source name. | [optional] + +## Methods + +### NewAccessProfileSourceRef + +`func NewAccessProfileSourceRef() *AccessProfileSourceRef` + +NewAccessProfileSourceRef instantiates a new AccessProfileSourceRef 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 + +### NewAccessProfileSourceRefWithDefaults + +`func NewAccessProfileSourceRefWithDefaults() *AccessProfileSourceRef` + +NewAccessProfileSourceRefWithDefaults instantiates a new AccessProfileSourceRef 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 + +### GetId + +`func (o *AccessProfileSourceRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileSourceRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileSourceRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileSourceRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccessProfileSourceRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileSourceRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileSourceRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileSourceRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileSourceRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileSourceRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileSourceRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileSourceRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessProfileSummary.md b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileSummary.md new file mode 100644 index 000000000..ca4a8524d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileSummary.md @@ -0,0 +1,256 @@ +--- +id: access-profile-summary +title: AccessProfileSummary +pagination_label: AccessProfileSummary +sidebar_label: AccessProfileSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileSummary', 'AccessProfileSummary'] +slug: /tools/sdk/go/v3/models/access-profile-summary +tags: ['SDK', 'Software Development Kit', 'AccessProfileSummary', 'AccessProfileSummary'] +--- + +# AccessProfileSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Source** | Pointer to [**Reference**](reference) | | [optional] +**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional] +**Revocable** | Pointer to **bool** | | [optional] + +## Methods + +### NewAccessProfileSummary + +`func NewAccessProfileSummary() *AccessProfileSummary` + +NewAccessProfileSummary instantiates a new AccessProfileSummary 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 + +### NewAccessProfileSummaryWithDefaults + +`func NewAccessProfileSummaryWithDefaults() *AccessProfileSummary` + +NewAccessProfileSummaryWithDefaults instantiates a new AccessProfileSummary 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 + +### GetId + +`func (o *AccessProfileSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileSummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileSummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileSummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileSummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileSummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileSummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *AccessProfileSummary) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AccessProfileSummary) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AccessProfileSummary) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AccessProfileSummary) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *AccessProfileSummary) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AccessProfileSummary) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AccessProfileSummary) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AccessProfileSummary) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *AccessProfileSummary) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *AccessProfileSummary) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *AccessProfileSummary) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileSummary) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileSummary) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSource + +`func (o *AccessProfileSummary) GetSource() Reference` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccessProfileSummary) GetSourceOk() (*Reference, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccessProfileSummary) SetSource(v Reference)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *AccessProfileSummary) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetOwner + +`func (o *AccessProfileSummary) GetOwner() DisplayReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *AccessProfileSummary) GetOwnerOk() (*DisplayReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *AccessProfileSummary) SetOwner(v DisplayReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *AccessProfileSummary) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRevocable + +`func (o *AccessProfileSummary) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *AccessProfileSummary) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *AccessProfileSummary) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *AccessProfileSummary) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessProfileUsage.md b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileUsage.md new file mode 100644 index 000000000..e1241f05e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileUsage.md @@ -0,0 +1,90 @@ +--- +id: access-profile-usage +title: AccessProfileUsage +pagination_label: AccessProfileUsage +sidebar_label: AccessProfileUsage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileUsage', 'AccessProfileUsage'] +slug: /tools/sdk/go/v3/models/access-profile-usage +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'AccessProfileUsage'] +--- + +# AccessProfileUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessProfileId** | Pointer to **string** | ID of the Access Profile that is in use | [optional] +**UsedBy** | Pointer to [**[]AccessProfileUsageUsedByInner**](access-profile-usage-used-by-inner) | List of references to objects which are using the indicated Access Profile | [optional] + +## Methods + +### NewAccessProfileUsage + +`func NewAccessProfileUsage() *AccessProfileUsage` + +NewAccessProfileUsage instantiates a new AccessProfileUsage 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 + +### NewAccessProfileUsageWithDefaults + +`func NewAccessProfileUsageWithDefaults() *AccessProfileUsage` + +NewAccessProfileUsageWithDefaults instantiates a new AccessProfileUsage 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 + +### GetAccessProfileId + +`func (o *AccessProfileUsage) GetAccessProfileId() string` + +GetAccessProfileId returns the AccessProfileId field if non-nil, zero value otherwise. + +### GetAccessProfileIdOk + +`func (o *AccessProfileUsage) GetAccessProfileIdOk() (*string, bool)` + +GetAccessProfileIdOk returns a tuple with the AccessProfileId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileId + +`func (o *AccessProfileUsage) SetAccessProfileId(v string)` + +SetAccessProfileId sets AccessProfileId field to given value. + +### HasAccessProfileId + +`func (o *AccessProfileUsage) HasAccessProfileId() bool` + +HasAccessProfileId returns a boolean if a field has been set. + +### GetUsedBy + +`func (o *AccessProfileUsage) GetUsedBy() []AccessProfileUsageUsedByInner` + +GetUsedBy returns the UsedBy field if non-nil, zero value otherwise. + +### GetUsedByOk + +`func (o *AccessProfileUsage) GetUsedByOk() (*[]AccessProfileUsageUsedByInner, bool)` + +GetUsedByOk returns a tuple with the UsedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsedBy + +`func (o *AccessProfileUsage) SetUsedBy(v []AccessProfileUsageUsedByInner)` + +SetUsedBy sets UsedBy field to given value. + +### HasUsedBy + +`func (o *AccessProfileUsage) HasUsedBy() bool` + +HasUsedBy returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessProfileUsageUsedByInner.md b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileUsageUsedByInner.md new file mode 100644 index 000000000..942a637b9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessProfileUsageUsedByInner.md @@ -0,0 +1,116 @@ +--- +id: access-profile-usage-used-by-inner +title: AccessProfileUsageUsedByInner +pagination_label: AccessProfileUsageUsedByInner +sidebar_label: AccessProfileUsageUsedByInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessProfileUsageUsedByInner', 'AccessProfileUsageUsedByInner'] +slug: /tools/sdk/go/v3/models/access-profile-usage-used-by-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner', 'AccessProfileUsageUsedByInner'] +--- + +# AccessProfileUsageUsedByInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of role using the access profile. | [optional] +**Id** | Pointer to **string** | ID of role using the access profile. | [optional] +**Name** | Pointer to **string** | Display name of role using the access profile. | [optional] + +## Methods + +### NewAccessProfileUsageUsedByInner + +`func NewAccessProfileUsageUsedByInner() *AccessProfileUsageUsedByInner` + +NewAccessProfileUsageUsedByInner instantiates a new AccessProfileUsageUsedByInner 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 + +### NewAccessProfileUsageUsedByInnerWithDefaults + +`func NewAccessProfileUsageUsedByInnerWithDefaults() *AccessProfileUsageUsedByInner` + +NewAccessProfileUsageUsedByInnerWithDefaults instantiates a new AccessProfileUsageUsedByInner 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 + +### GetType + +`func (o *AccessProfileUsageUsedByInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessProfileUsageUsedByInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessProfileUsageUsedByInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessProfileUsageUsedByInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessProfileUsageUsedByInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessProfileUsageUsedByInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessProfileUsageUsedByInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessProfileUsageUsedByInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessProfileUsageUsedByInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessProfileUsageUsedByInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessProfileUsageUsedByInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessProfileUsageUsedByInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessRequest.md b/docs/tools/sdk/go/Reference/V3/Models/AccessRequest.md new file mode 100644 index 000000000..8a68beed3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessRequest.md @@ -0,0 +1,178 @@ +--- +id: access-request +title: AccessRequest +pagination_label: AccessRequest +sidebar_label: AccessRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequest', 'AccessRequest'] +slug: /tools/sdk/go/v3/models/access-request +tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'AccessRequest'] +--- + +# AccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedFor** | **[]string** | A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. | +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**RequestedForWithRequestedItems** | Pointer to [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] + +## Methods + +### NewAccessRequest + +`func NewAccessRequest(requestedFor []string, requestedItems []AccessRequestItem, ) *AccessRequest` + +NewAccessRequest instantiates a new AccessRequest 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 + +### NewAccessRequestWithDefaults + +`func NewAccessRequestWithDefaults() *AccessRequest` + +NewAccessRequestWithDefaults instantiates a new AccessRequest 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 + +### GetRequestedFor + +`func (o *AccessRequest) GetRequestedFor() []string` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequest) GetRequestedForOk() (*[]string, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequest) SetRequestedFor(v []string)` + +SetRequestedFor sets RequestedFor field to given value. + + +### GetRequestType + +`func (o *AccessRequest) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *AccessRequest) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *AccessRequest) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *AccessRequest) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *AccessRequest) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *AccessRequest) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetRequestedItems + +`func (o *AccessRequest) GetRequestedItems() []AccessRequestItem` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *AccessRequest) GetRequestedItemsOk() (*[]AccessRequestItem, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *AccessRequest) SetRequestedItems(v []AccessRequestItem)` + +SetRequestedItems sets RequestedItems field to given value. + + +### GetClientMetadata + +`func (o *AccessRequest) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccessRequest) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccessRequest) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccessRequest) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRequestedForWithRequestedItems + +`func (o *AccessRequest) GetRequestedForWithRequestedItems() []RequestedForDtoRef` + +GetRequestedForWithRequestedItems returns the RequestedForWithRequestedItems field if non-nil, zero value otherwise. + +### GetRequestedForWithRequestedItemsOk + +`func (o *AccessRequest) GetRequestedForWithRequestedItemsOk() (*[]RequestedForDtoRef, bool)` + +GetRequestedForWithRequestedItemsOk returns a tuple with the RequestedForWithRequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedForWithRequestedItems + +`func (o *AccessRequest) SetRequestedForWithRequestedItems(v []RequestedForDtoRef)` + +SetRequestedForWithRequestedItems sets RequestedForWithRequestedItems field to given value. + +### HasRequestedForWithRequestedItems + +`func (o *AccessRequest) HasRequestedForWithRequestedItems() bool` + +HasRequestedForWithRequestedItems returns a boolean if a field has been set. + +### SetRequestedForWithRequestedItemsNil + +`func (o *AccessRequest) SetRequestedForWithRequestedItemsNil(b bool)` + + SetRequestedForWithRequestedItemsNil sets the value for RequestedForWithRequestedItems to be an explicit nil + +### UnsetRequestedForWithRequestedItems +`func (o *AccessRequest) UnsetRequestedForWithRequestedItems()` + +UnsetRequestedForWithRequestedItems ensures that no value is present for RequestedForWithRequestedItems, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessRequestConfig.md b/docs/tools/sdk/go/Reference/V3/Models/AccessRequestConfig.md new file mode 100644 index 000000000..093eb83ed --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessRequestConfig.md @@ -0,0 +1,194 @@ +--- +id: access-request-config +title: AccessRequestConfig +pagination_label: AccessRequestConfig +sidebar_label: AccessRequestConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestConfig', 'AccessRequestConfig'] +slug: /tools/sdk/go/v3/models/access-request-config +tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig', 'AccessRequestConfig'] +--- + +# AccessRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalsMustBeExternal** | Pointer to **bool** | If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin. | [optional] [default to false] +**AutoApprovalEnabled** | Pointer to **bool** | If this is true and the requester and reviewer are the same, the request is automatically approved. | [optional] [default to false] +**ReauthorizationEnabled** | Pointer to **bool** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to false] +**RequestOnBehalfOfConfig** | Pointer to [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional] +**ApprovalReminderAndEscalationConfig** | Pointer to [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional] +**EntitlementRequestConfig** | Pointer to [**EntitlementRequestConfig**](entitlement-request-config) | | [optional] + +## Methods + +### NewAccessRequestConfig + +`func NewAccessRequestConfig() *AccessRequestConfig` + +NewAccessRequestConfig instantiates a new AccessRequestConfig 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 + +### NewAccessRequestConfigWithDefaults + +`func NewAccessRequestConfigWithDefaults() *AccessRequestConfig` + +NewAccessRequestConfigWithDefaults instantiates a new AccessRequestConfig 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 + +### GetApprovalsMustBeExternal + +`func (o *AccessRequestConfig) GetApprovalsMustBeExternal() bool` + +GetApprovalsMustBeExternal returns the ApprovalsMustBeExternal field if non-nil, zero value otherwise. + +### GetApprovalsMustBeExternalOk + +`func (o *AccessRequestConfig) GetApprovalsMustBeExternalOk() (*bool, bool)` + +GetApprovalsMustBeExternalOk returns a tuple with the ApprovalsMustBeExternal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalsMustBeExternal + +`func (o *AccessRequestConfig) SetApprovalsMustBeExternal(v bool)` + +SetApprovalsMustBeExternal sets ApprovalsMustBeExternal field to given value. + +### HasApprovalsMustBeExternal + +`func (o *AccessRequestConfig) HasApprovalsMustBeExternal() bool` + +HasApprovalsMustBeExternal returns a boolean if a field has been set. + +### GetAutoApprovalEnabled + +`func (o *AccessRequestConfig) GetAutoApprovalEnabled() bool` + +GetAutoApprovalEnabled returns the AutoApprovalEnabled field if non-nil, zero value otherwise. + +### GetAutoApprovalEnabledOk + +`func (o *AccessRequestConfig) GetAutoApprovalEnabledOk() (*bool, bool)` + +GetAutoApprovalEnabledOk returns a tuple with the AutoApprovalEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoApprovalEnabled + +`func (o *AccessRequestConfig) SetAutoApprovalEnabled(v bool)` + +SetAutoApprovalEnabled sets AutoApprovalEnabled field to given value. + +### HasAutoApprovalEnabled + +`func (o *AccessRequestConfig) HasAutoApprovalEnabled() bool` + +HasAutoApprovalEnabled returns a boolean if a field has been set. + +### GetReauthorizationEnabled + +`func (o *AccessRequestConfig) GetReauthorizationEnabled() bool` + +GetReauthorizationEnabled returns the ReauthorizationEnabled field if non-nil, zero value otherwise. + +### GetReauthorizationEnabledOk + +`func (o *AccessRequestConfig) GetReauthorizationEnabledOk() (*bool, bool)` + +GetReauthorizationEnabledOk returns a tuple with the ReauthorizationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReauthorizationEnabled + +`func (o *AccessRequestConfig) SetReauthorizationEnabled(v bool)` + +SetReauthorizationEnabled sets ReauthorizationEnabled field to given value. + +### HasReauthorizationEnabled + +`func (o *AccessRequestConfig) HasReauthorizationEnabled() bool` + +HasReauthorizationEnabled returns a boolean if a field has been set. + +### GetRequestOnBehalfOfConfig + +`func (o *AccessRequestConfig) GetRequestOnBehalfOfConfig() RequestOnBehalfOfConfig` + +GetRequestOnBehalfOfConfig returns the RequestOnBehalfOfConfig field if non-nil, zero value otherwise. + +### GetRequestOnBehalfOfConfigOk + +`func (o *AccessRequestConfig) GetRequestOnBehalfOfConfigOk() (*RequestOnBehalfOfConfig, bool)` + +GetRequestOnBehalfOfConfigOk returns a tuple with the RequestOnBehalfOfConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestOnBehalfOfConfig + +`func (o *AccessRequestConfig) SetRequestOnBehalfOfConfig(v RequestOnBehalfOfConfig)` + +SetRequestOnBehalfOfConfig sets RequestOnBehalfOfConfig field to given value. + +### HasRequestOnBehalfOfConfig + +`func (o *AccessRequestConfig) HasRequestOnBehalfOfConfig() bool` + +HasRequestOnBehalfOfConfig returns a boolean if a field has been set. + +### GetApprovalReminderAndEscalationConfig + +`func (o *AccessRequestConfig) GetApprovalReminderAndEscalationConfig() ApprovalReminderAndEscalationConfig` + +GetApprovalReminderAndEscalationConfig returns the ApprovalReminderAndEscalationConfig field if non-nil, zero value otherwise. + +### GetApprovalReminderAndEscalationConfigOk + +`func (o *AccessRequestConfig) GetApprovalReminderAndEscalationConfigOk() (*ApprovalReminderAndEscalationConfig, bool)` + +GetApprovalReminderAndEscalationConfigOk returns a tuple with the ApprovalReminderAndEscalationConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalReminderAndEscalationConfig + +`func (o *AccessRequestConfig) SetApprovalReminderAndEscalationConfig(v ApprovalReminderAndEscalationConfig)` + +SetApprovalReminderAndEscalationConfig sets ApprovalReminderAndEscalationConfig field to given value. + +### HasApprovalReminderAndEscalationConfig + +`func (o *AccessRequestConfig) HasApprovalReminderAndEscalationConfig() bool` + +HasApprovalReminderAndEscalationConfig returns a boolean if a field has been set. + +### GetEntitlementRequestConfig + +`func (o *AccessRequestConfig) GetEntitlementRequestConfig() EntitlementRequestConfig` + +GetEntitlementRequestConfig returns the EntitlementRequestConfig field if non-nil, zero value otherwise. + +### GetEntitlementRequestConfigOk + +`func (o *AccessRequestConfig) GetEntitlementRequestConfigOk() (*EntitlementRequestConfig, bool)` + +GetEntitlementRequestConfigOk returns a tuple with the EntitlementRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementRequestConfig + +`func (o *AccessRequestConfig) SetEntitlementRequestConfig(v EntitlementRequestConfig)` + +SetEntitlementRequestConfig sets EntitlementRequestConfig field to given value. + +### HasEntitlementRequestConfig + +`func (o *AccessRequestConfig) HasEntitlementRequestConfig() bool` + +HasEntitlementRequestConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessRequestItem.md b/docs/tools/sdk/go/Reference/V3/Models/AccessRequestItem.md new file mode 100644 index 000000000..ce3a836df --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessRequestItem.md @@ -0,0 +1,230 @@ +--- +id: access-request-item +title: AccessRequestItem +pagination_label: AccessRequestItem +sidebar_label: AccessRequestItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestItem', 'AccessRequestItem'] +slug: /tools/sdk/go/v3/models/access-request-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'AccessRequestItem'] +--- + +# AccessRequestItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of the item being requested. | +**Id** | **string** | ID of Role, Access Profile or Entitlement being requested. | +**Comment** | Pointer to **string** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | Pointer to **SailPointTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | Pointer to **NullableString** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | Pointer to **NullableString** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] + +## Methods + +### NewAccessRequestItem + +`func NewAccessRequestItem(type_ string, id string, ) *AccessRequestItem` + +NewAccessRequestItem instantiates a new AccessRequestItem 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 + +### NewAccessRequestItemWithDefaults + +`func NewAccessRequestItemWithDefaults() *AccessRequestItem` + +NewAccessRequestItemWithDefaults instantiates a new AccessRequestItem 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 + +### GetType + +`func (o *AccessRequestItem) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessRequestItem) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessRequestItem) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *AccessRequestItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessRequestItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessRequestItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetComment + +`func (o *AccessRequestItem) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *AccessRequestItem) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *AccessRequestItem) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *AccessRequestItem) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *AccessRequestItem) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccessRequestItem) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccessRequestItem) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccessRequestItem) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *AccessRequestItem) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccessRequestItem) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccessRequestItem) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccessRequestItem) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetAssignmentId + +`func (o *AccessRequestItem) GetAssignmentId() string` + +GetAssignmentId returns the AssignmentId field if non-nil, zero value otherwise. + +### GetAssignmentIdOk + +`func (o *AccessRequestItem) GetAssignmentIdOk() (*string, bool)` + +GetAssignmentIdOk returns a tuple with the AssignmentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentId + +`func (o *AccessRequestItem) SetAssignmentId(v string)` + +SetAssignmentId sets AssignmentId field to given value. + +### HasAssignmentId + +`func (o *AccessRequestItem) HasAssignmentId() bool` + +HasAssignmentId returns a boolean if a field has been set. + +### SetAssignmentIdNil + +`func (o *AccessRequestItem) SetAssignmentIdNil(b bool)` + + SetAssignmentIdNil sets the value for AssignmentId to be an explicit nil + +### UnsetAssignmentId +`func (o *AccessRequestItem) UnsetAssignmentId()` + +UnsetAssignmentId ensures that no value is present for AssignmentId, not even an explicit nil +### GetNativeIdentity + +`func (o *AccessRequestItem) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccessRequestItem) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccessRequestItem) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccessRequestItem) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### SetNativeIdentityNil + +`func (o *AccessRequestItem) SetNativeIdentityNil(b bool)` + + SetNativeIdentityNil sets the value for NativeIdentity to be an explicit nil + +### UnsetNativeIdentity +`func (o *AccessRequestItem) UnsetNativeIdentity()` + +UnsetNativeIdentity ensures that no value is present for NativeIdentity, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessRequestPhases.md b/docs/tools/sdk/go/Reference/V3/Models/AccessRequestPhases.md new file mode 100644 index 000000000..ebd2397f6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessRequestPhases.md @@ -0,0 +1,224 @@ +--- +id: access-request-phases +title: AccessRequestPhases +pagination_label: AccessRequestPhases +sidebar_label: AccessRequestPhases +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestPhases', 'AccessRequestPhases'] +slug: /tools/sdk/go/v3/models/access-request-phases +tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'AccessRequestPhases'] +--- + +# AccessRequestPhases + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Started** | Pointer to **SailPointTime** | The time that this phase started. | [optional] +**Finished** | Pointer to **NullableTime** | The time that this phase finished. | [optional] +**Name** | Pointer to **string** | The name of this phase. | [optional] +**State** | Pointer to **string** | The state of this phase. | [optional] +**Result** | Pointer to **NullableString** | The state of this phase. | [optional] +**PhaseReference** | Pointer to **NullableString** | A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. | [optional] + +## Methods + +### NewAccessRequestPhases + +`func NewAccessRequestPhases() *AccessRequestPhases` + +NewAccessRequestPhases instantiates a new AccessRequestPhases 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 + +### NewAccessRequestPhasesWithDefaults + +`func NewAccessRequestPhasesWithDefaults() *AccessRequestPhases` + +NewAccessRequestPhasesWithDefaults instantiates a new AccessRequestPhases 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 + +### GetStarted + +`func (o *AccessRequestPhases) GetStarted() SailPointTime` + +GetStarted returns the Started field if non-nil, zero value otherwise. + +### GetStartedOk + +`func (o *AccessRequestPhases) GetStartedOk() (*SailPointTime, bool)` + +GetStartedOk returns a tuple with the Started field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStarted + +`func (o *AccessRequestPhases) SetStarted(v SailPointTime)` + +SetStarted sets Started field to given value. + +### HasStarted + +`func (o *AccessRequestPhases) HasStarted() bool` + +HasStarted returns a boolean if a field has been set. + +### GetFinished + +`func (o *AccessRequestPhases) GetFinished() SailPointTime` + +GetFinished returns the Finished field if non-nil, zero value otherwise. + +### GetFinishedOk + +`func (o *AccessRequestPhases) GetFinishedOk() (*SailPointTime, bool)` + +GetFinishedOk returns a tuple with the Finished field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFinished + +`func (o *AccessRequestPhases) SetFinished(v SailPointTime)` + +SetFinished sets Finished field to given value. + +### HasFinished + +`func (o *AccessRequestPhases) HasFinished() bool` + +HasFinished returns a boolean if a field has been set. + +### SetFinishedNil + +`func (o *AccessRequestPhases) SetFinishedNil(b bool)` + + SetFinishedNil sets the value for Finished to be an explicit nil + +### UnsetFinished +`func (o *AccessRequestPhases) UnsetFinished()` + +UnsetFinished ensures that no value is present for Finished, not even an explicit nil +### GetName + +`func (o *AccessRequestPhases) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessRequestPhases) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessRequestPhases) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessRequestPhases) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetState + +`func (o *AccessRequestPhases) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *AccessRequestPhases) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *AccessRequestPhases) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *AccessRequestPhases) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetResult + +`func (o *AccessRequestPhases) GetResult() string` + +GetResult returns the Result field if non-nil, zero value otherwise. + +### GetResultOk + +`func (o *AccessRequestPhases) GetResultOk() (*string, bool)` + +GetResultOk returns a tuple with the Result field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResult + +`func (o *AccessRequestPhases) SetResult(v string)` + +SetResult sets Result field to given value. + +### HasResult + +`func (o *AccessRequestPhases) HasResult() bool` + +HasResult returns a boolean if a field has been set. + +### SetResultNil + +`func (o *AccessRequestPhases) SetResultNil(b bool)` + + SetResultNil sets the value for Result to be an explicit nil + +### UnsetResult +`func (o *AccessRequestPhases) UnsetResult()` + +UnsetResult ensures that no value is present for Result, not even an explicit nil +### GetPhaseReference + +`func (o *AccessRequestPhases) GetPhaseReference() string` + +GetPhaseReference returns the PhaseReference field if non-nil, zero value otherwise. + +### GetPhaseReferenceOk + +`func (o *AccessRequestPhases) GetPhaseReferenceOk() (*string, bool)` + +GetPhaseReferenceOk returns a tuple with the PhaseReference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhaseReference + +`func (o *AccessRequestPhases) SetPhaseReference(v string)` + +SetPhaseReference sets PhaseReference field to given value. + +### HasPhaseReference + +`func (o *AccessRequestPhases) HasPhaseReference() bool` + +HasPhaseReference returns a boolean if a field has been set. + +### SetPhaseReferenceNil + +`func (o *AccessRequestPhases) SetPhaseReferenceNil(b bool)` + + SetPhaseReferenceNil sets the value for PhaseReference to be an explicit nil + +### UnsetPhaseReference +`func (o *AccessRequestPhases) UnsetPhaseReference()` + +UnsetPhaseReference ensures that no value is present for PhaseReference, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessRequestResponse.md b/docs/tools/sdk/go/Reference/V3/Models/AccessRequestResponse.md new file mode 100644 index 000000000..9bb3bb7a4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessRequestResponse.md @@ -0,0 +1,90 @@ +--- +id: access-request-response +title: AccessRequestResponse +pagination_label: AccessRequestResponse +sidebar_label: AccessRequestResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestResponse', 'AccessRequestResponse'] +slug: /tools/sdk/go/v3/models/access-request-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'AccessRequestResponse'] +--- + +# AccessRequestResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewRequests** | Pointer to [**[]AccessRequestTracking**](access-request-tracking) | A list of new access request tracking data mapped to the values requested. | [optional] +**ExistingRequests** | Pointer to [**[]AccessRequestTracking**](access-request-tracking) | A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. | [optional] + +## Methods + +### NewAccessRequestResponse + +`func NewAccessRequestResponse() *AccessRequestResponse` + +NewAccessRequestResponse instantiates a new AccessRequestResponse 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 + +### NewAccessRequestResponseWithDefaults + +`func NewAccessRequestResponseWithDefaults() *AccessRequestResponse` + +NewAccessRequestResponseWithDefaults instantiates a new AccessRequestResponse 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 + +### GetNewRequests + +`func (o *AccessRequestResponse) GetNewRequests() []AccessRequestTracking` + +GetNewRequests returns the NewRequests field if non-nil, zero value otherwise. + +### GetNewRequestsOk + +`func (o *AccessRequestResponse) GetNewRequestsOk() (*[]AccessRequestTracking, bool)` + +GetNewRequestsOk returns a tuple with the NewRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewRequests + +`func (o *AccessRequestResponse) SetNewRequests(v []AccessRequestTracking)` + +SetNewRequests sets NewRequests field to given value. + +### HasNewRequests + +`func (o *AccessRequestResponse) HasNewRequests() bool` + +HasNewRequests returns a boolean if a field has been set. + +### GetExistingRequests + +`func (o *AccessRequestResponse) GetExistingRequests() []AccessRequestTracking` + +GetExistingRequests returns the ExistingRequests field if non-nil, zero value otherwise. + +### GetExistingRequestsOk + +`func (o *AccessRequestResponse) GetExistingRequestsOk() (*[]AccessRequestTracking, bool)` + +GetExistingRequestsOk returns a tuple with the ExistingRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExistingRequests + +`func (o *AccessRequestResponse) SetExistingRequests(v []AccessRequestTracking)` + +SetExistingRequests sets ExistingRequests field to given value. + +### HasExistingRequests + +`func (o *AccessRequestResponse) HasExistingRequests() bool` + +HasExistingRequests returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessRequestTracking.md b/docs/tools/sdk/go/Reference/V3/Models/AccessRequestTracking.md new file mode 100644 index 000000000..786d7d74a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessRequestTracking.md @@ -0,0 +1,142 @@ +--- +id: access-request-tracking +title: AccessRequestTracking +pagination_label: AccessRequestTracking +sidebar_label: AccessRequestTracking +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestTracking', 'AccessRequestTracking'] +slug: /tools/sdk/go/v3/models/access-request-tracking +tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'AccessRequestTracking'] +--- + +# AccessRequestTracking + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedFor** | Pointer to **string** | The identity id in which the access request is for. | [optional] +**RequestedItemsDetails** | Pointer to [**[]RequestedItemDetails**](requested-item-details) | The details of the item requested. | [optional] +**AttributesHash** | Pointer to **int32** | a hash representation of the access requested, useful for longer term tracking client side. | [optional] +**AccessRequestIds** | Pointer to **[]string** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [optional] + +## Methods + +### NewAccessRequestTracking + +`func NewAccessRequestTracking() *AccessRequestTracking` + +NewAccessRequestTracking instantiates a new AccessRequestTracking 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 + +### NewAccessRequestTrackingWithDefaults + +`func NewAccessRequestTrackingWithDefaults() *AccessRequestTracking` + +NewAccessRequestTrackingWithDefaults instantiates a new AccessRequestTracking 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 + +### GetRequestedFor + +`func (o *AccessRequestTracking) GetRequestedFor() string` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *AccessRequestTracking) GetRequestedForOk() (*string, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *AccessRequestTracking) SetRequestedFor(v string)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *AccessRequestTracking) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetRequestedItemsDetails + +`func (o *AccessRequestTracking) GetRequestedItemsDetails() []RequestedItemDetails` + +GetRequestedItemsDetails returns the RequestedItemsDetails field if non-nil, zero value otherwise. + +### GetRequestedItemsDetailsOk + +`func (o *AccessRequestTracking) GetRequestedItemsDetailsOk() (*[]RequestedItemDetails, bool)` + +GetRequestedItemsDetailsOk returns a tuple with the RequestedItemsDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItemsDetails + +`func (o *AccessRequestTracking) SetRequestedItemsDetails(v []RequestedItemDetails)` + +SetRequestedItemsDetails sets RequestedItemsDetails field to given value. + +### HasRequestedItemsDetails + +`func (o *AccessRequestTracking) HasRequestedItemsDetails() bool` + +HasRequestedItemsDetails returns a boolean if a field has been set. + +### GetAttributesHash + +`func (o *AccessRequestTracking) GetAttributesHash() int32` + +GetAttributesHash returns the AttributesHash field if non-nil, zero value otherwise. + +### GetAttributesHashOk + +`func (o *AccessRequestTracking) GetAttributesHashOk() (*int32, bool)` + +GetAttributesHashOk returns a tuple with the AttributesHash field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributesHash + +`func (o *AccessRequestTracking) SetAttributesHash(v int32)` + +SetAttributesHash sets AttributesHash field to given value. + +### HasAttributesHash + +`func (o *AccessRequestTracking) HasAttributesHash() bool` + +HasAttributesHash returns a boolean if a field has been set. + +### GetAccessRequestIds + +`func (o *AccessRequestTracking) GetAccessRequestIds() []string` + +GetAccessRequestIds returns the AccessRequestIds field if non-nil, zero value otherwise. + +### GetAccessRequestIdsOk + +`func (o *AccessRequestTracking) GetAccessRequestIdsOk() (*[]string, bool)` + +GetAccessRequestIdsOk returns a tuple with the AccessRequestIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestIds + +`func (o *AccessRequestTracking) SetAccessRequestIds(v []string)` + +SetAccessRequestIds sets AccessRequestIds field to given value. + +### HasAccessRequestIds + +`func (o *AccessRequestTracking) HasAccessRequestIds() bool` + +HasAccessRequestIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessRequestType.md b/docs/tools/sdk/go/Reference/V3/Models/AccessRequestType.md new file mode 100644 index 000000000..5b26f008c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessRequestType.md @@ -0,0 +1,21 @@ +--- +id: access-request-type +title: AccessRequestType +pagination_label: AccessRequestType +sidebar_label: AccessRequestType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessRequestType', 'AccessRequestType'] +slug: /tools/sdk/go/v3/models/access-request-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestType', 'AccessRequestType'] +--- + +# AccessRequestType + +## Enum + + +* `GRANT_ACCESS` (value: `"GRANT_ACCESS"`) + +* `REVOKE_ACCESS` (value: `"REVOKE_ACCESS"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessReviewItem.md b/docs/tools/sdk/go/Reference/V3/Models/AccessReviewItem.md new file mode 100644 index 000000000..3cbeb203a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessReviewItem.md @@ -0,0 +1,230 @@ +--- +id: access-review-item +title: AccessReviewItem +pagination_label: AccessReviewItem +sidebar_label: AccessReviewItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessReviewItem', 'AccessReviewItem'] +slug: /tools/sdk/go/v3/models/access-review-item +tags: ['SDK', 'Software Development Kit', 'AccessReviewItem', 'AccessReviewItem'] +--- + +# AccessReviewItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessSummary** | Pointer to [**AccessSummary**](access-summary) | | [optional] +**IdentitySummary** | Pointer to [**CertificationIdentitySummary**](certification-identity-summary) | | [optional] +**Id** | Pointer to **string** | The review item's id | [optional] +**Completed** | Pointer to **bool** | Whether the review item is complete | [optional] +**NewAccess** | Pointer to **bool** | Indicates whether the review item is for new access to a source | [optional] +**Decision** | Pointer to [**CertificationDecision**](certification-decision) | | [optional] +**Comments** | Pointer to **NullableString** | Comments for this review item | [optional] + +## Methods + +### NewAccessReviewItem + +`func NewAccessReviewItem() *AccessReviewItem` + +NewAccessReviewItem instantiates a new AccessReviewItem 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 + +### NewAccessReviewItemWithDefaults + +`func NewAccessReviewItemWithDefaults() *AccessReviewItem` + +NewAccessReviewItemWithDefaults instantiates a new AccessReviewItem 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 + +### GetAccessSummary + +`func (o *AccessReviewItem) GetAccessSummary() AccessSummary` + +GetAccessSummary returns the AccessSummary field if non-nil, zero value otherwise. + +### GetAccessSummaryOk + +`func (o *AccessReviewItem) GetAccessSummaryOk() (*AccessSummary, bool)` + +GetAccessSummaryOk returns a tuple with the AccessSummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessSummary + +`func (o *AccessReviewItem) SetAccessSummary(v AccessSummary)` + +SetAccessSummary sets AccessSummary field to given value. + +### HasAccessSummary + +`func (o *AccessReviewItem) HasAccessSummary() bool` + +HasAccessSummary returns a boolean if a field has been set. + +### GetIdentitySummary + +`func (o *AccessReviewItem) GetIdentitySummary() CertificationIdentitySummary` + +GetIdentitySummary returns the IdentitySummary field if non-nil, zero value otherwise. + +### GetIdentitySummaryOk + +`func (o *AccessReviewItem) GetIdentitySummaryOk() (*CertificationIdentitySummary, bool)` + +GetIdentitySummaryOk returns a tuple with the IdentitySummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitySummary + +`func (o *AccessReviewItem) SetIdentitySummary(v CertificationIdentitySummary)` + +SetIdentitySummary sets IdentitySummary field to given value. + +### HasIdentitySummary + +`func (o *AccessReviewItem) HasIdentitySummary() bool` + +HasIdentitySummary returns a boolean if a field has been set. + +### GetId + +`func (o *AccessReviewItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessReviewItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessReviewItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessReviewItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCompleted + +`func (o *AccessReviewItem) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *AccessReviewItem) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *AccessReviewItem) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *AccessReviewItem) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetNewAccess + +`func (o *AccessReviewItem) GetNewAccess() bool` + +GetNewAccess returns the NewAccess field if non-nil, zero value otherwise. + +### GetNewAccessOk + +`func (o *AccessReviewItem) GetNewAccessOk() (*bool, bool)` + +GetNewAccessOk returns a tuple with the NewAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewAccess + +`func (o *AccessReviewItem) SetNewAccess(v bool)` + +SetNewAccess sets NewAccess field to given value. + +### HasNewAccess + +`func (o *AccessReviewItem) HasNewAccess() bool` + +HasNewAccess returns a boolean if a field has been set. + +### GetDecision + +`func (o *AccessReviewItem) GetDecision() CertificationDecision` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *AccessReviewItem) GetDecisionOk() (*CertificationDecision, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *AccessReviewItem) SetDecision(v CertificationDecision)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *AccessReviewItem) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + +### GetComments + +`func (o *AccessReviewItem) GetComments() string` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *AccessReviewItem) GetCommentsOk() (*string, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *AccessReviewItem) SetComments(v string)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *AccessReviewItem) HasComments() bool` + +HasComments returns a boolean if a field has been set. + +### SetCommentsNil + +`func (o *AccessReviewItem) SetCommentsNil(b bool)` + + SetCommentsNil sets the value for Comments to be an explicit nil + +### UnsetComments +`func (o *AccessReviewItem) UnsetComments()` + +UnsetComments ensures that no value is present for Comments, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessReviewReassignment.md b/docs/tools/sdk/go/Reference/V3/Models/AccessReviewReassignment.md new file mode 100644 index 000000000..126e3fd46 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessReviewReassignment.md @@ -0,0 +1,101 @@ +--- +id: access-review-reassignment +title: AccessReviewReassignment +pagination_label: AccessReviewReassignment +sidebar_label: AccessReviewReassignment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessReviewReassignment', 'AccessReviewReassignment'] +slug: /tools/sdk/go/v3/models/access-review-reassignment +tags: ['SDK', 'Software Development Kit', 'AccessReviewReassignment', 'AccessReviewReassignment'] +--- + +# AccessReviewReassignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Reassign** | [**[]ReassignReference**](reassign-reference) | | +**ReassignTo** | **string** | The ID of the identity to which the certification is reassigned | +**Reason** | **string** | The reason comment for why the reassign was made | + +## Methods + +### NewAccessReviewReassignment + +`func NewAccessReviewReassignment(reassign []ReassignReference, reassignTo string, reason string, ) *AccessReviewReassignment` + +NewAccessReviewReassignment instantiates a new AccessReviewReassignment 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 + +### NewAccessReviewReassignmentWithDefaults + +`func NewAccessReviewReassignmentWithDefaults() *AccessReviewReassignment` + +NewAccessReviewReassignmentWithDefaults instantiates a new AccessReviewReassignment 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 + +### GetReassign + +`func (o *AccessReviewReassignment) GetReassign() []ReassignReference` + +GetReassign returns the Reassign field if non-nil, zero value otherwise. + +### GetReassignOk + +`func (o *AccessReviewReassignment) GetReassignOk() (*[]ReassignReference, bool)` + +GetReassignOk returns a tuple with the Reassign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassign + +`func (o *AccessReviewReassignment) SetReassign(v []ReassignReference)` + +SetReassign sets Reassign field to given value. + + +### GetReassignTo + +`func (o *AccessReviewReassignment) GetReassignTo() string` + +GetReassignTo returns the ReassignTo field if non-nil, zero value otherwise. + +### GetReassignToOk + +`func (o *AccessReviewReassignment) GetReassignToOk() (*string, bool)` + +GetReassignToOk returns a tuple with the ReassignTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignTo + +`func (o *AccessReviewReassignment) SetReassignTo(v string)` + +SetReassignTo sets ReassignTo field to given value. + + +### GetReason + +`func (o *AccessReviewReassignment) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *AccessReviewReassignment) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *AccessReviewReassignment) SetReason(v string)` + +SetReason sets Reason field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessSummary.md b/docs/tools/sdk/go/Reference/V3/Models/AccessSummary.md new file mode 100644 index 000000000..3d4056d3b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessSummary.md @@ -0,0 +1,162 @@ +--- +id: access-summary +title: AccessSummary +pagination_label: AccessSummary +sidebar_label: AccessSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessSummary', 'AccessSummary'] +slug: /tools/sdk/go/v3/models/access-summary +tags: ['SDK', 'Software Development Kit', 'AccessSummary', 'AccessSummary'] +--- + +# AccessSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Access** | Pointer to [**AccessSummaryAccess**](access-summary-access) | | [optional] +**Entitlement** | Pointer to [**NullableReviewableEntitlement**](reviewable-entitlement) | | [optional] +**AccessProfile** | Pointer to [**ReviewableAccessProfile**](reviewable-access-profile) | | [optional] +**Role** | Pointer to [**NullableReviewableRole**](reviewable-role) | | [optional] + +## Methods + +### NewAccessSummary + +`func NewAccessSummary() *AccessSummary` + +NewAccessSummary instantiates a new AccessSummary 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 + +### NewAccessSummaryWithDefaults + +`func NewAccessSummaryWithDefaults() *AccessSummary` + +NewAccessSummaryWithDefaults instantiates a new AccessSummary 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 + +### GetAccess + +`func (o *AccessSummary) GetAccess() AccessSummaryAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *AccessSummary) GetAccessOk() (*AccessSummaryAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *AccessSummary) SetAccess(v AccessSummaryAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *AccessSummary) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetEntitlement + +`func (o *AccessSummary) GetEntitlement() ReviewableEntitlement` + +GetEntitlement returns the Entitlement field if non-nil, zero value otherwise. + +### GetEntitlementOk + +`func (o *AccessSummary) GetEntitlementOk() (*ReviewableEntitlement, bool)` + +GetEntitlementOk returns a tuple with the Entitlement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlement + +`func (o *AccessSummary) SetEntitlement(v ReviewableEntitlement)` + +SetEntitlement sets Entitlement field to given value. + +### HasEntitlement + +`func (o *AccessSummary) HasEntitlement() bool` + +HasEntitlement returns a boolean if a field has been set. + +### SetEntitlementNil + +`func (o *AccessSummary) SetEntitlementNil(b bool)` + + SetEntitlementNil sets the value for Entitlement to be an explicit nil + +### UnsetEntitlement +`func (o *AccessSummary) UnsetEntitlement()` + +UnsetEntitlement ensures that no value is present for Entitlement, not even an explicit nil +### GetAccessProfile + +`func (o *AccessSummary) GetAccessProfile() ReviewableAccessProfile` + +GetAccessProfile returns the AccessProfile field if non-nil, zero value otherwise. + +### GetAccessProfileOk + +`func (o *AccessSummary) GetAccessProfileOk() (*ReviewableAccessProfile, bool)` + +GetAccessProfileOk returns a tuple with the AccessProfile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfile + +`func (o *AccessSummary) SetAccessProfile(v ReviewableAccessProfile)` + +SetAccessProfile sets AccessProfile field to given value. + +### HasAccessProfile + +`func (o *AccessSummary) HasAccessProfile() bool` + +HasAccessProfile returns a boolean if a field has been set. + +### GetRole + +`func (o *AccessSummary) GetRole() ReviewableRole` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *AccessSummary) GetRoleOk() (*ReviewableRole, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *AccessSummary) SetRole(v ReviewableRole)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *AccessSummary) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### SetRoleNil + +`func (o *AccessSummary) SetRoleNil(b bool)` + + SetRoleNil sets the value for Role to be an explicit nil + +### UnsetRole +`func (o *AccessSummary) UnsetRole()` + +UnsetRole ensures that no value is present for Role, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessSummaryAccess.md b/docs/tools/sdk/go/Reference/V3/Models/AccessSummaryAccess.md new file mode 100644 index 000000000..752c4a193 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessSummaryAccess.md @@ -0,0 +1,116 @@ +--- +id: access-summary-access +title: AccessSummaryAccess +pagination_label: AccessSummaryAccess +sidebar_label: AccessSummaryAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessSummaryAccess', 'AccessSummaryAccess'] +slug: /tools/sdk/go/v3/models/access-summary-access +tags: ['SDK', 'Software Development Kit', 'AccessSummaryAccess', 'AccessSummaryAccess'] +--- + +# AccessSummaryAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | The ID of the item being certified | [optional] +**Name** | Pointer to **string** | The name of the item being certified | [optional] + +## Methods + +### NewAccessSummaryAccess + +`func NewAccessSummaryAccess() *AccessSummaryAccess` + +NewAccessSummaryAccess instantiates a new AccessSummaryAccess 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 + +### NewAccessSummaryAccessWithDefaults + +`func NewAccessSummaryAccessWithDefaults() *AccessSummaryAccess` + +NewAccessSummaryAccessWithDefaults instantiates a new AccessSummaryAccess 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 + +### GetType + +`func (o *AccessSummaryAccess) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccessSummaryAccess) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccessSummaryAccess) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccessSummaryAccess) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccessSummaryAccess) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccessSummaryAccess) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccessSummaryAccess) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccessSummaryAccess) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccessSummaryAccess) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccessSummaryAccess) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccessSummaryAccess) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccessSummaryAccess) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccessType.md b/docs/tools/sdk/go/Reference/V3/Models/AccessType.md new file mode 100644 index 000000000..bb9a7d33f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccessType.md @@ -0,0 +1,21 @@ +--- +id: access-type +title: AccessType +pagination_label: AccessType +sidebar_label: AccessType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccessType', 'AccessType'] +slug: /tools/sdk/go/v3/models/access-type +tags: ['SDK', 'Software Development Kit', 'AccessType', 'AccessType'] +--- + +# AccessType + +## Enum + + +* `ONLINE` (value: `"ONLINE"`) + +* `OFFLINE` (value: `"OFFLINE"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Account.md b/docs/tools/sdk/go/Reference/V3/Models/Account.md new file mode 100644 index 000000000..b73e3b1b3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Account.md @@ -0,0 +1,816 @@ +--- +id: account +title: Account +pagination_label: Account +sidebar_label: Account +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Account', 'Account'] +slug: /tools/sdk/go/v3/models/account +tags: ['SDK', 'Software Development Kit', 'Account', 'Account'] +--- + +# Account + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**SourceId** | **string** | The unique ID of the source this account belongs to | +**SourceName** | **NullableString** | The display name of the source this account belongs to | +**IdentityId** | Pointer to **string** | The unique ID of the identity this account is correlated to | [optional] +**CloudLifecycleState** | Pointer to **NullableString** | The lifecycle state of the identity this account is correlated to | [optional] +**IdentityState** | Pointer to **NullableString** | The identity state of the identity this account is correlated to | [optional] +**ConnectionType** | Pointer to **NullableString** | The connection type of the source this account is from | [optional] +**IsMachine** | Pointer to **bool** | Indicates if the account is of machine type | [optional] [default to false] +**Recommendation** | Pointer to [**AccountAllOfRecommendation**](account-all-of-recommendation) | | [optional] +**Attributes** | **map[string]interface{}** | The account attributes that are aggregated | +**Authoritative** | **bool** | Indicates if this account is from an authoritative source | +**Description** | Pointer to **NullableString** | A description of the account | [optional] +**Disabled** | **bool** | Indicates if the account is currently disabled | +**Locked** | **bool** | Indicates if the account is currently locked | +**NativeIdentity** | **string** | The unique ID of the account generated by the source system | +**SystemAccount** | **bool** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | +**Uncorrelated** | **bool** | Indicates if this account is not correlated to an identity | +**Uuid** | Pointer to **NullableString** | The unique ID of the account as determined by the account schema | [optional] +**ManuallyCorrelated** | **bool** | Indicates if the account has been manually correlated to an identity | +**HasEntitlements** | **bool** | Indicates if the account has entitlements | +**Identity** | Pointer to [**AccountAllOfIdentity**](account-all-of-identity) | | [optional] +**SourceOwner** | Pointer to [**NullableAccountAllOfSourceOwner**](account-all-of-source-owner) | | [optional] +**Features** | Pointer to **NullableString** | A string list containing the owning source's features | [optional] +**Origin** | Pointer to **NullableString** | The origin of the account either aggregated or provisioned | [optional] +**OwnerIdentity** | Pointer to [**AccountAllOfOwnerIdentity**](account-all-of-owner-identity) | | [optional] + +## Methods + +### NewAccount + +`func NewAccount(name NullableString, sourceId string, sourceName NullableString, attributes map[string]interface{}, authoritative bool, disabled bool, locked bool, nativeIdentity string, systemAccount bool, uncorrelated bool, manuallyCorrelated bool, hasEntitlements bool, ) *Account` + +NewAccount instantiates a new Account 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 + +### NewAccountWithDefaults + +`func NewAccountWithDefaults() *Account` + +NewAccountWithDefaults instantiates a new Account 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 + +### GetId + +`func (o *Account) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Account) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Account) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Account) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Account) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Account) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Account) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *Account) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *Account) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *Account) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Account) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Account) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Account) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Account) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Account) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Account) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Account) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetSourceId + +`func (o *Account) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *Account) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *Account) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetSourceName + +`func (o *Account) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *Account) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *Account) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### SetSourceNameNil + +`func (o *Account) SetSourceNameNil(b bool)` + + SetSourceNameNil sets the value for SourceName to be an explicit nil + +### UnsetSourceName +`func (o *Account) UnsetSourceName()` + +UnsetSourceName ensures that no value is present for SourceName, not even an explicit nil +### GetIdentityId + +`func (o *Account) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *Account) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *Account) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *Account) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetCloudLifecycleState + +`func (o *Account) GetCloudLifecycleState() string` + +GetCloudLifecycleState returns the CloudLifecycleState field if non-nil, zero value otherwise. + +### GetCloudLifecycleStateOk + +`func (o *Account) GetCloudLifecycleStateOk() (*string, bool)` + +GetCloudLifecycleStateOk returns a tuple with the CloudLifecycleState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudLifecycleState + +`func (o *Account) SetCloudLifecycleState(v string)` + +SetCloudLifecycleState sets CloudLifecycleState field to given value. + +### HasCloudLifecycleState + +`func (o *Account) HasCloudLifecycleState() bool` + +HasCloudLifecycleState returns a boolean if a field has been set. + +### SetCloudLifecycleStateNil + +`func (o *Account) SetCloudLifecycleStateNil(b bool)` + + SetCloudLifecycleStateNil sets the value for CloudLifecycleState to be an explicit nil + +### UnsetCloudLifecycleState +`func (o *Account) UnsetCloudLifecycleState()` + +UnsetCloudLifecycleState ensures that no value is present for CloudLifecycleState, not even an explicit nil +### GetIdentityState + +`func (o *Account) GetIdentityState() string` + +GetIdentityState returns the IdentityState field if non-nil, zero value otherwise. + +### GetIdentityStateOk + +`func (o *Account) GetIdentityStateOk() (*string, bool)` + +GetIdentityStateOk returns a tuple with the IdentityState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityState + +`func (o *Account) SetIdentityState(v string)` + +SetIdentityState sets IdentityState field to given value. + +### HasIdentityState + +`func (o *Account) HasIdentityState() bool` + +HasIdentityState returns a boolean if a field has been set. + +### SetIdentityStateNil + +`func (o *Account) SetIdentityStateNil(b bool)` + + SetIdentityStateNil sets the value for IdentityState to be an explicit nil + +### UnsetIdentityState +`func (o *Account) UnsetIdentityState()` + +UnsetIdentityState ensures that no value is present for IdentityState, not even an explicit nil +### GetConnectionType + +`func (o *Account) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *Account) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *Account) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *Account) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + +### SetConnectionTypeNil + +`func (o *Account) SetConnectionTypeNil(b bool)` + + SetConnectionTypeNil sets the value for ConnectionType to be an explicit nil + +### UnsetConnectionType +`func (o *Account) UnsetConnectionType()` + +UnsetConnectionType ensures that no value is present for ConnectionType, not even an explicit nil +### GetIsMachine + +`func (o *Account) GetIsMachine() bool` + +GetIsMachine returns the IsMachine field if non-nil, zero value otherwise. + +### GetIsMachineOk + +`func (o *Account) GetIsMachineOk() (*bool, bool)` + +GetIsMachineOk returns a tuple with the IsMachine field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsMachine + +`func (o *Account) SetIsMachine(v bool)` + +SetIsMachine sets IsMachine field to given value. + +### HasIsMachine + +`func (o *Account) HasIsMachine() bool` + +HasIsMachine returns a boolean if a field has been set. + +### GetRecommendation + +`func (o *Account) GetRecommendation() AccountAllOfRecommendation` + +GetRecommendation returns the Recommendation field if non-nil, zero value otherwise. + +### GetRecommendationOk + +`func (o *Account) GetRecommendationOk() (*AccountAllOfRecommendation, bool)` + +GetRecommendationOk returns a tuple with the Recommendation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendation + +`func (o *Account) SetRecommendation(v AccountAllOfRecommendation)` + +SetRecommendation sets Recommendation field to given value. + +### HasRecommendation + +`func (o *Account) HasRecommendation() bool` + +HasRecommendation returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Account) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Account) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Account) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *Account) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *Account) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetAuthoritative + +`func (o *Account) GetAuthoritative() bool` + +GetAuthoritative returns the Authoritative field if non-nil, zero value otherwise. + +### GetAuthoritativeOk + +`func (o *Account) GetAuthoritativeOk() (*bool, bool)` + +GetAuthoritativeOk returns a tuple with the Authoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritative + +`func (o *Account) SetAuthoritative(v bool)` + +SetAuthoritative sets Authoritative field to given value. + + +### GetDescription + +`func (o *Account) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Account) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Account) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Account) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Account) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Account) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetDisabled + +`func (o *Account) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *Account) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *Account) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + + +### GetLocked + +`func (o *Account) GetLocked() bool` + +GetLocked returns the Locked field if non-nil, zero value otherwise. + +### GetLockedOk + +`func (o *Account) GetLockedOk() (*bool, bool)` + +GetLockedOk returns a tuple with the Locked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocked + +`func (o *Account) SetLocked(v bool)` + +SetLocked sets Locked field to given value. + + +### GetNativeIdentity + +`func (o *Account) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *Account) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *Account) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + + +### GetSystemAccount + +`func (o *Account) GetSystemAccount() bool` + +GetSystemAccount returns the SystemAccount field if non-nil, zero value otherwise. + +### GetSystemAccountOk + +`func (o *Account) GetSystemAccountOk() (*bool, bool)` + +GetSystemAccountOk returns a tuple with the SystemAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSystemAccount + +`func (o *Account) SetSystemAccount(v bool)` + +SetSystemAccount sets SystemAccount field to given value. + + +### GetUncorrelated + +`func (o *Account) GetUncorrelated() bool` + +GetUncorrelated returns the Uncorrelated field if non-nil, zero value otherwise. + +### GetUncorrelatedOk + +`func (o *Account) GetUncorrelatedOk() (*bool, bool)` + +GetUncorrelatedOk returns a tuple with the Uncorrelated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUncorrelated + +`func (o *Account) SetUncorrelated(v bool)` + +SetUncorrelated sets Uncorrelated field to given value. + + +### GetUuid + +`func (o *Account) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *Account) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *Account) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *Account) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *Account) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *Account) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetManuallyCorrelated + +`func (o *Account) GetManuallyCorrelated() bool` + +GetManuallyCorrelated returns the ManuallyCorrelated field if non-nil, zero value otherwise. + +### GetManuallyCorrelatedOk + +`func (o *Account) GetManuallyCorrelatedOk() (*bool, bool)` + +GetManuallyCorrelatedOk returns a tuple with the ManuallyCorrelated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyCorrelated + +`func (o *Account) SetManuallyCorrelated(v bool)` + +SetManuallyCorrelated sets ManuallyCorrelated field to given value. + + +### GetHasEntitlements + +`func (o *Account) GetHasEntitlements() bool` + +GetHasEntitlements returns the HasEntitlements field if non-nil, zero value otherwise. + +### GetHasEntitlementsOk + +`func (o *Account) GetHasEntitlementsOk() (*bool, bool)` + +GetHasEntitlementsOk returns a tuple with the HasEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasEntitlements + +`func (o *Account) SetHasEntitlements(v bool)` + +SetHasEntitlements sets HasEntitlements field to given value. + + +### GetIdentity + +`func (o *Account) GetIdentity() AccountAllOfIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *Account) GetIdentityOk() (*AccountAllOfIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *Account) SetIdentity(v AccountAllOfIdentity)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *Account) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetSourceOwner + +`func (o *Account) GetSourceOwner() AccountAllOfSourceOwner` + +GetSourceOwner returns the SourceOwner field if non-nil, zero value otherwise. + +### GetSourceOwnerOk + +`func (o *Account) GetSourceOwnerOk() (*AccountAllOfSourceOwner, bool)` + +GetSourceOwnerOk returns a tuple with the SourceOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceOwner + +`func (o *Account) SetSourceOwner(v AccountAllOfSourceOwner)` + +SetSourceOwner sets SourceOwner field to given value. + +### HasSourceOwner + +`func (o *Account) HasSourceOwner() bool` + +HasSourceOwner returns a boolean if a field has been set. + +### SetSourceOwnerNil + +`func (o *Account) SetSourceOwnerNil(b bool)` + + SetSourceOwnerNil sets the value for SourceOwner to be an explicit nil + +### UnsetSourceOwner +`func (o *Account) UnsetSourceOwner()` + +UnsetSourceOwner ensures that no value is present for SourceOwner, not even an explicit nil +### GetFeatures + +`func (o *Account) GetFeatures() string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *Account) GetFeaturesOk() (*string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *Account) SetFeatures(v string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *Account) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### SetFeaturesNil + +`func (o *Account) SetFeaturesNil(b bool)` + + SetFeaturesNil sets the value for Features to be an explicit nil + +### UnsetFeatures +`func (o *Account) UnsetFeatures()` + +UnsetFeatures ensures that no value is present for Features, not even an explicit nil +### GetOrigin + +`func (o *Account) GetOrigin() string` + +GetOrigin returns the Origin field if non-nil, zero value otherwise. + +### GetOriginOk + +`func (o *Account) GetOriginOk() (*string, bool)` + +GetOriginOk returns a tuple with the Origin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrigin + +`func (o *Account) SetOrigin(v string)` + +SetOrigin sets Origin field to given value. + +### HasOrigin + +`func (o *Account) HasOrigin() bool` + +HasOrigin returns a boolean if a field has been set. + +### SetOriginNil + +`func (o *Account) SetOriginNil(b bool)` + + SetOriginNil sets the value for Origin to be an explicit nil + +### UnsetOrigin +`func (o *Account) UnsetOrigin()` + +UnsetOrigin ensures that no value is present for Origin, not even an explicit nil +### GetOwnerIdentity + +`func (o *Account) GetOwnerIdentity() AccountAllOfOwnerIdentity` + +GetOwnerIdentity returns the OwnerIdentity field if non-nil, zero value otherwise. + +### GetOwnerIdentityOk + +`func (o *Account) GetOwnerIdentityOk() (*AccountAllOfOwnerIdentity, bool)` + +GetOwnerIdentityOk returns a tuple with the OwnerIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerIdentity + +`func (o *Account) SetOwnerIdentity(v AccountAllOfOwnerIdentity)` + +SetOwnerIdentity sets OwnerIdentity field to given value. + +### HasOwnerIdentity + +`func (o *Account) HasOwnerIdentity() bool` + +HasOwnerIdentity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountAction.md b/docs/tools/sdk/go/Reference/V3/Models/AccountAction.md new file mode 100644 index 000000000..1d57ebf90 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountAction.md @@ -0,0 +1,90 @@ +--- +id: account-action +title: AccountAction +pagination_label: AccountAction +sidebar_label: AccountAction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAction', 'AccountAction'] +slug: /tools/sdk/go/v3/models/account-action +tags: ['SDK', 'Software Development Kit', 'AccountAction', 'AccountAction'] +--- + +# AccountAction + +## Properties + +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] + +## Methods + +### NewAccountAction + +`func NewAccountAction() *AccountAction` + +NewAccountAction instantiates a new AccountAction 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 + +### NewAccountActionWithDefaults + +`func NewAccountActionWithDefaults() *AccountAction` + +NewAccountActionWithDefaults instantiates a new AccountAction 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 + +### GetAction + +`func (o *AccountAction) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *AccountAction) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *AccountAction) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *AccountAction) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetSourceIds + +`func (o *AccountAction) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *AccountAction) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *AccountAction) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *AccountAction) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountActivity.md b/docs/tools/sdk/go/Reference/V3/Models/AccountActivity.md new file mode 100644 index 000000000..f721625e5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountActivity.md @@ -0,0 +1,502 @@ +--- +id: account-activity +title: AccountActivity +pagination_label: AccountActivity +sidebar_label: AccountActivity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivity', 'AccountActivity'] +slug: /tools/sdk/go/v3/models/account-activity +tags: ['SDK', 'Software Development Kit', 'AccountActivity', 'AccountActivity'] +--- + +# AccountActivity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the account activity | [optional] +**Name** | Pointer to **string** | The name of the activity | [optional] +**Created** | Pointer to **SailPointTime** | When the activity was first created | [optional] +**Modified** | Pointer to **NullableTime** | When the activity was last modified | [optional] +**Completed** | Pointer to **NullableTime** | When the activity was completed | [optional] +**CompletionStatus** | Pointer to [**NullableCompletionStatus**](completion-status) | | [optional] +**Type** | Pointer to **NullableString** | The type of action the activity performed. Please see the following list of types. This list may grow over time. - CloudAutomated - IdentityAttributeUpdate - appRequest - LifecycleStateChange - AccountStateUpdate - AccountAttributeUpdate - CloudPasswordRequest - Attribute Synchronization Refresh - Certification - Identity Refresh - Lifecycle Change Refresh [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). | [optional] +**RequesterIdentitySummary** | Pointer to [**NullableIdentitySummary**](identity-summary) | | [optional] +**TargetIdentitySummary** | Pointer to [**NullableIdentitySummary**](identity-summary) | | [optional] +**Errors** | Pointer to **[]string** | A list of error messages, if any, that were encountered. | [optional] +**Warnings** | Pointer to **[]string** | A list of warning messages, if any, that were encountered. | [optional] +**Items** | Pointer to [**[]AccountActivityItem**](account-activity-item) | Individual actions performed as part of this account activity | [optional] +**ExecutionStatus** | Pointer to [**ExecutionStatus**](execution-status) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] + +## Methods + +### NewAccountActivity + +`func NewAccountActivity() *AccountActivity` + +NewAccountActivity instantiates a new AccountActivity 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 + +### NewAccountActivityWithDefaults + +`func NewAccountActivityWithDefaults() *AccountActivity` + +NewAccountActivityWithDefaults instantiates a new AccountActivity 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 + +### GetId + +`func (o *AccountActivity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountActivity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountActivity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountActivity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccountActivity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountActivity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountActivity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountActivity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *AccountActivity) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccountActivity) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccountActivity) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccountActivity) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *AccountActivity) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccountActivity) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccountActivity) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccountActivity) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *AccountActivity) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *AccountActivity) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetCompleted + +`func (o *AccountActivity) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *AccountActivity) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *AccountActivity) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *AccountActivity) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *AccountActivity) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *AccountActivity) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetCompletionStatus + +`func (o *AccountActivity) GetCompletionStatus() CompletionStatus` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *AccountActivity) GetCompletionStatusOk() (*CompletionStatus, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *AccountActivity) SetCompletionStatus(v CompletionStatus)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *AccountActivity) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + +### SetCompletionStatusNil + +`func (o *AccountActivity) SetCompletionStatusNil(b bool)` + + SetCompletionStatusNil sets the value for CompletionStatus to be an explicit nil + +### UnsetCompletionStatus +`func (o *AccountActivity) UnsetCompletionStatus()` + +UnsetCompletionStatus ensures that no value is present for CompletionStatus, not even an explicit nil +### GetType + +`func (o *AccountActivity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountActivity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountActivity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountActivity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *AccountActivity) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *AccountActivity) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetRequesterIdentitySummary + +`func (o *AccountActivity) GetRequesterIdentitySummary() IdentitySummary` + +GetRequesterIdentitySummary returns the RequesterIdentitySummary field if non-nil, zero value otherwise. + +### GetRequesterIdentitySummaryOk + +`func (o *AccountActivity) GetRequesterIdentitySummaryOk() (*IdentitySummary, bool)` + +GetRequesterIdentitySummaryOk returns a tuple with the RequesterIdentitySummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterIdentitySummary + +`func (o *AccountActivity) SetRequesterIdentitySummary(v IdentitySummary)` + +SetRequesterIdentitySummary sets RequesterIdentitySummary field to given value. + +### HasRequesterIdentitySummary + +`func (o *AccountActivity) HasRequesterIdentitySummary() bool` + +HasRequesterIdentitySummary returns a boolean if a field has been set. + +### SetRequesterIdentitySummaryNil + +`func (o *AccountActivity) SetRequesterIdentitySummaryNil(b bool)` + + SetRequesterIdentitySummaryNil sets the value for RequesterIdentitySummary to be an explicit nil + +### UnsetRequesterIdentitySummary +`func (o *AccountActivity) UnsetRequesterIdentitySummary()` + +UnsetRequesterIdentitySummary ensures that no value is present for RequesterIdentitySummary, not even an explicit nil +### GetTargetIdentitySummary + +`func (o *AccountActivity) GetTargetIdentitySummary() IdentitySummary` + +GetTargetIdentitySummary returns the TargetIdentitySummary field if non-nil, zero value otherwise. + +### GetTargetIdentitySummaryOk + +`func (o *AccountActivity) GetTargetIdentitySummaryOk() (*IdentitySummary, bool)` + +GetTargetIdentitySummaryOk returns a tuple with the TargetIdentitySummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetIdentitySummary + +`func (o *AccountActivity) SetTargetIdentitySummary(v IdentitySummary)` + +SetTargetIdentitySummary sets TargetIdentitySummary field to given value. + +### HasTargetIdentitySummary + +`func (o *AccountActivity) HasTargetIdentitySummary() bool` + +HasTargetIdentitySummary returns a boolean if a field has been set. + +### SetTargetIdentitySummaryNil + +`func (o *AccountActivity) SetTargetIdentitySummaryNil(b bool)` + + SetTargetIdentitySummaryNil sets the value for TargetIdentitySummary to be an explicit nil + +### UnsetTargetIdentitySummary +`func (o *AccountActivity) UnsetTargetIdentitySummary()` + +UnsetTargetIdentitySummary ensures that no value is present for TargetIdentitySummary, not even an explicit nil +### GetErrors + +`func (o *AccountActivity) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountActivity) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountActivity) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *AccountActivity) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### SetErrorsNil + +`func (o *AccountActivity) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *AccountActivity) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *AccountActivity) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *AccountActivity) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *AccountActivity) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *AccountActivity) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + +### SetWarningsNil + +`func (o *AccountActivity) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *AccountActivity) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetItems + +`func (o *AccountActivity) GetItems() []AccountActivityItem` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *AccountActivity) GetItemsOk() (*[]AccountActivityItem, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *AccountActivity) SetItems(v []AccountActivityItem)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *AccountActivity) HasItems() bool` + +HasItems returns a boolean if a field has been set. + +### SetItemsNil + +`func (o *AccountActivity) SetItemsNil(b bool)` + + SetItemsNil sets the value for Items to be an explicit nil + +### UnsetItems +`func (o *AccountActivity) UnsetItems()` + +UnsetItems ensures that no value is present for Items, not even an explicit nil +### GetExecutionStatus + +`func (o *AccountActivity) GetExecutionStatus() ExecutionStatus` + +GetExecutionStatus returns the ExecutionStatus field if non-nil, zero value otherwise. + +### GetExecutionStatusOk + +`func (o *AccountActivity) GetExecutionStatusOk() (*ExecutionStatus, bool)` + +GetExecutionStatusOk returns a tuple with the ExecutionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExecutionStatus + +`func (o *AccountActivity) SetExecutionStatus(v ExecutionStatus)` + +SetExecutionStatus sets ExecutionStatus field to given value. + +### HasExecutionStatus + +`func (o *AccountActivity) HasExecutionStatus() bool` + +HasExecutionStatus returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *AccountActivity) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccountActivity) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccountActivity) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccountActivity) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *AccountActivity) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *AccountActivity) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountActivityApprovalStatus.md b/docs/tools/sdk/go/Reference/V3/Models/AccountActivityApprovalStatus.md new file mode 100644 index 000000000..ddd63c59f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountActivityApprovalStatus.md @@ -0,0 +1,29 @@ +--- +id: account-activity-approval-status +title: AccountActivityApprovalStatus +pagination_label: AccountActivityApprovalStatus +sidebar_label: AccountActivityApprovalStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivityApprovalStatus', 'AccountActivityApprovalStatus'] +slug: /tools/sdk/go/v3/models/account-activity-approval-status +tags: ['SDK', 'Software Development Kit', 'AccountActivityApprovalStatus', 'AccountActivityApprovalStatus'] +--- + +# AccountActivityApprovalStatus + +## Enum + + +* `FINISHED` (value: `"FINISHED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `RETURNED` (value: `"RETURNED"`) + +* `EXPIRED` (value: `"EXPIRED"`) + +* `PENDING` (value: `"PENDING"`) + +* `CANCELED` (value: `"CANCELED"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountActivityDocument.md b/docs/tools/sdk/go/Reference/V3/Models/AccountActivityDocument.md new file mode 100644 index 000000000..52c6a277e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountActivityDocument.md @@ -0,0 +1,520 @@ +--- +id: account-activity-document +title: AccountActivityDocument +pagination_label: AccountActivityDocument +sidebar_label: AccountActivityDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivityDocument', 'AccountActivityDocument'] +slug: /tools/sdk/go/v3/models/account-activity-document +tags: ['SDK', 'Software Development Kit', 'AccountActivityDocument', 'AccountActivityDocument'] +--- + +# AccountActivityDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of account activity. | [optional] +**Action** | Pointer to **string** | Type of action performed in the activity. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Stage** | Pointer to **string** | Activity's current stage. | [optional] +**Status** | Pointer to **string** | Activity's current status. | [optional] +**Requester** | Pointer to [**ActivityIdentity**](activity-identity) | | [optional] +**Recipient** | Pointer to [**ActivityIdentity**](activity-identity) | | [optional] +**TrackingNumber** | Pointer to **string** | Account activity's tracking number. | [optional] +**Errors** | Pointer to **[]string** | Errors provided by the source while completing account actions. | [optional] +**Warnings** | Pointer to **[]string** | Warnings provided by the source while completing account actions. | [optional] +**Approvals** | Pointer to [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional] +**OriginalRequests** | Pointer to [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional] +**ExpansionItems** | Pointer to [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional] +**AccountRequests** | Pointer to [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional] +**Sources** | Pointer to **string** | Sources involved in the account activity. | [optional] + +## Methods + +### NewAccountActivityDocument + +`func NewAccountActivityDocument() *AccountActivityDocument` + +NewAccountActivityDocument instantiates a new AccountActivityDocument 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 + +### NewAccountActivityDocumentWithDefaults + +`func NewAccountActivityDocumentWithDefaults() *AccountActivityDocument` + +NewAccountActivityDocumentWithDefaults instantiates a new AccountActivityDocument 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 + +### GetId + +`func (o *AccountActivityDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountActivityDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountActivityDocument) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountActivityDocument) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAction + +`func (o *AccountActivityDocument) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *AccountActivityDocument) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *AccountActivityDocument) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *AccountActivityDocument) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetCreated + +`func (o *AccountActivityDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccountActivityDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccountActivityDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccountActivityDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *AccountActivityDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *AccountActivityDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *AccountActivityDocument) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccountActivityDocument) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccountActivityDocument) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccountActivityDocument) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *AccountActivityDocument) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *AccountActivityDocument) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *AccountActivityDocument) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *AccountActivityDocument) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *AccountActivityDocument) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *AccountActivityDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetStage + +`func (o *AccountActivityDocument) GetStage() string` + +GetStage returns the Stage field if non-nil, zero value otherwise. + +### GetStageOk + +`func (o *AccountActivityDocument) GetStageOk() (*string, bool)` + +GetStageOk returns a tuple with the Stage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStage + +`func (o *AccountActivityDocument) SetStage(v string)` + +SetStage sets Stage field to given value. + +### HasStage + +`func (o *AccountActivityDocument) HasStage() bool` + +HasStage returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccountActivityDocument) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountActivityDocument) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountActivityDocument) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccountActivityDocument) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetRequester + +`func (o *AccountActivityDocument) GetRequester() ActivityIdentity` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *AccountActivityDocument) GetRequesterOk() (*ActivityIdentity, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *AccountActivityDocument) SetRequester(v ActivityIdentity)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *AccountActivityDocument) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRecipient + +`func (o *AccountActivityDocument) GetRecipient() ActivityIdentity` + +GetRecipient returns the Recipient field if non-nil, zero value otherwise. + +### GetRecipientOk + +`func (o *AccountActivityDocument) GetRecipientOk() (*ActivityIdentity, bool)` + +GetRecipientOk returns a tuple with the Recipient field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipient + +`func (o *AccountActivityDocument) SetRecipient(v ActivityIdentity)` + +SetRecipient sets Recipient field to given value. + +### HasRecipient + +`func (o *AccountActivityDocument) HasRecipient() bool` + +HasRecipient returns a boolean if a field has been set. + +### GetTrackingNumber + +`func (o *AccountActivityDocument) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *AccountActivityDocument) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *AccountActivityDocument) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + +### HasTrackingNumber + +`func (o *AccountActivityDocument) HasTrackingNumber() bool` + +HasTrackingNumber returns a boolean if a field has been set. + +### GetErrors + +`func (o *AccountActivityDocument) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountActivityDocument) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountActivityDocument) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *AccountActivityDocument) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### SetErrorsNil + +`func (o *AccountActivityDocument) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *AccountActivityDocument) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *AccountActivityDocument) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *AccountActivityDocument) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *AccountActivityDocument) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *AccountActivityDocument) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + +### SetWarningsNil + +`func (o *AccountActivityDocument) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *AccountActivityDocument) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetApprovals + +`func (o *AccountActivityDocument) GetApprovals() []Approval` + +GetApprovals returns the Approvals field if non-nil, zero value otherwise. + +### GetApprovalsOk + +`func (o *AccountActivityDocument) GetApprovalsOk() (*[]Approval, bool)` + +GetApprovalsOk returns a tuple with the Approvals field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovals + +`func (o *AccountActivityDocument) SetApprovals(v []Approval)` + +SetApprovals sets Approvals field to given value. + +### HasApprovals + +`func (o *AccountActivityDocument) HasApprovals() bool` + +HasApprovals returns a boolean if a field has been set. + +### GetOriginalRequests + +`func (o *AccountActivityDocument) GetOriginalRequests() []OriginalRequest` + +GetOriginalRequests returns the OriginalRequests field if non-nil, zero value otherwise. + +### GetOriginalRequestsOk + +`func (o *AccountActivityDocument) GetOriginalRequestsOk() (*[]OriginalRequest, bool)` + +GetOriginalRequestsOk returns a tuple with the OriginalRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalRequests + +`func (o *AccountActivityDocument) SetOriginalRequests(v []OriginalRequest)` + +SetOriginalRequests sets OriginalRequests field to given value. + +### HasOriginalRequests + +`func (o *AccountActivityDocument) HasOriginalRequests() bool` + +HasOriginalRequests returns a boolean if a field has been set. + +### GetExpansionItems + +`func (o *AccountActivityDocument) GetExpansionItems() []ExpansionItem` + +GetExpansionItems returns the ExpansionItems field if non-nil, zero value otherwise. + +### GetExpansionItemsOk + +`func (o *AccountActivityDocument) GetExpansionItemsOk() (*[]ExpansionItem, bool)` + +GetExpansionItemsOk returns a tuple with the ExpansionItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpansionItems + +`func (o *AccountActivityDocument) SetExpansionItems(v []ExpansionItem)` + +SetExpansionItems sets ExpansionItems field to given value. + +### HasExpansionItems + +`func (o *AccountActivityDocument) HasExpansionItems() bool` + +HasExpansionItems returns a boolean if a field has been set. + +### GetAccountRequests + +`func (o *AccountActivityDocument) GetAccountRequests() []AccountRequest` + +GetAccountRequests returns the AccountRequests field if non-nil, zero value otherwise. + +### GetAccountRequestsOk + +`func (o *AccountActivityDocument) GetAccountRequestsOk() (*[]AccountRequest, bool)` + +GetAccountRequestsOk returns a tuple with the AccountRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountRequests + +`func (o *AccountActivityDocument) SetAccountRequests(v []AccountRequest)` + +SetAccountRequests sets AccountRequests field to given value. + +### HasAccountRequests + +`func (o *AccountActivityDocument) HasAccountRequests() bool` + +HasAccountRequests returns a boolean if a field has been set. + +### GetSources + +`func (o *AccountActivityDocument) GetSources() string` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *AccountActivityDocument) GetSourcesOk() (*string, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *AccountActivityDocument) SetSources(v string)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *AccountActivityDocument) HasSources() bool` + +HasSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountActivityItem.md b/docs/tools/sdk/go/Reference/V3/Models/AccountActivityItem.md new file mode 100644 index 000000000..6ee16e5e6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountActivityItem.md @@ -0,0 +1,564 @@ +--- +id: account-activity-item +title: AccountActivityItem +pagination_label: AccountActivityItem +sidebar_label: AccountActivityItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivityItem', 'AccountActivityItem'] +slug: /tools/sdk/go/v3/models/account-activity-item +tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'AccountActivityItem'] +--- + +# AccountActivityItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Item id | [optional] +**Name** | Pointer to **string** | Human-readable display name of item | [optional] +**Requested** | Pointer to **SailPointTime** | Date and time item was requested | [optional] +**ApprovalStatus** | Pointer to [**NullableAccountActivityApprovalStatus**](account-activity-approval-status) | | [optional] +**ProvisioningStatus** | Pointer to [**ProvisioningState**](provisioning-state) | | [optional] +**RequesterComment** | Pointer to [**NullableComment**](comment) | | [optional] +**ReviewerIdentitySummary** | Pointer to [**NullableIdentitySummary**](identity-summary) | | [optional] +**ReviewerComment** | Pointer to [**NullableComment**](comment) | | [optional] +**Operation** | Pointer to [**NullableAccountActivityItemOperation**](account-activity-item-operation) | | [optional] +**Attribute** | Pointer to **NullableString** | Attribute to which account activity applies | [optional] +**Value** | Pointer to **NullableString** | Value of attribute | [optional] +**NativeIdentity** | Pointer to **NullableString** | Native identity in the target system to which the account activity applies | [optional] +**SourceId** | Pointer to **string** | Id of Source to which account activity applies | [optional] +**AccountRequestInfo** | Pointer to [**NullableAccountRequestInfo**](account-request-info) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional] +**RemoveDate** | Pointer to **NullableTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] + +## Methods + +### NewAccountActivityItem + +`func NewAccountActivityItem() *AccountActivityItem` + +NewAccountActivityItem instantiates a new AccountActivityItem 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 + +### NewAccountActivityItemWithDefaults + +`func NewAccountActivityItemWithDefaults() *AccountActivityItem` + +NewAccountActivityItemWithDefaults instantiates a new AccountActivityItem 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 + +### GetId + +`func (o *AccountActivityItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountActivityItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountActivityItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountActivityItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccountActivityItem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountActivityItem) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountActivityItem) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountActivityItem) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetRequested + +`func (o *AccountActivityItem) GetRequested() SailPointTime` + +GetRequested returns the Requested field if non-nil, zero value otherwise. + +### GetRequestedOk + +`func (o *AccountActivityItem) GetRequestedOk() (*SailPointTime, bool)` + +GetRequestedOk returns a tuple with the Requested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequested + +`func (o *AccountActivityItem) SetRequested(v SailPointTime)` + +SetRequested sets Requested field to given value. + +### HasRequested + +`func (o *AccountActivityItem) HasRequested() bool` + +HasRequested returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *AccountActivityItem) GetApprovalStatus() AccountActivityApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *AccountActivityItem) GetApprovalStatusOk() (*AccountActivityApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *AccountActivityItem) SetApprovalStatus(v AccountActivityApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *AccountActivityItem) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### SetApprovalStatusNil + +`func (o *AccountActivityItem) SetApprovalStatusNil(b bool)` + + SetApprovalStatusNil sets the value for ApprovalStatus to be an explicit nil + +### UnsetApprovalStatus +`func (o *AccountActivityItem) UnsetApprovalStatus()` + +UnsetApprovalStatus ensures that no value is present for ApprovalStatus, not even an explicit nil +### GetProvisioningStatus + +`func (o *AccountActivityItem) GetProvisioningStatus() ProvisioningState` + +GetProvisioningStatus returns the ProvisioningStatus field if non-nil, zero value otherwise. + +### GetProvisioningStatusOk + +`func (o *AccountActivityItem) GetProvisioningStatusOk() (*ProvisioningState, bool)` + +GetProvisioningStatusOk returns a tuple with the ProvisioningStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningStatus + +`func (o *AccountActivityItem) SetProvisioningStatus(v ProvisioningState)` + +SetProvisioningStatus sets ProvisioningStatus field to given value. + +### HasProvisioningStatus + +`func (o *AccountActivityItem) HasProvisioningStatus() bool` + +HasProvisioningStatus returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *AccountActivityItem) GetRequesterComment() Comment` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *AccountActivityItem) GetRequesterCommentOk() (*Comment, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *AccountActivityItem) SetRequesterComment(v Comment)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *AccountActivityItem) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### SetRequesterCommentNil + +`func (o *AccountActivityItem) SetRequesterCommentNil(b bool)` + + SetRequesterCommentNil sets the value for RequesterComment to be an explicit nil + +### UnsetRequesterComment +`func (o *AccountActivityItem) UnsetRequesterComment()` + +UnsetRequesterComment ensures that no value is present for RequesterComment, not even an explicit nil +### GetReviewerIdentitySummary + +`func (o *AccountActivityItem) GetReviewerIdentitySummary() IdentitySummary` + +GetReviewerIdentitySummary returns the ReviewerIdentitySummary field if non-nil, zero value otherwise. + +### GetReviewerIdentitySummaryOk + +`func (o *AccountActivityItem) GetReviewerIdentitySummaryOk() (*IdentitySummary, bool)` + +GetReviewerIdentitySummaryOk returns a tuple with the ReviewerIdentitySummary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerIdentitySummary + +`func (o *AccountActivityItem) SetReviewerIdentitySummary(v IdentitySummary)` + +SetReviewerIdentitySummary sets ReviewerIdentitySummary field to given value. + +### HasReviewerIdentitySummary + +`func (o *AccountActivityItem) HasReviewerIdentitySummary() bool` + +HasReviewerIdentitySummary returns a boolean if a field has been set. + +### SetReviewerIdentitySummaryNil + +`func (o *AccountActivityItem) SetReviewerIdentitySummaryNil(b bool)` + + SetReviewerIdentitySummaryNil sets the value for ReviewerIdentitySummary to be an explicit nil + +### UnsetReviewerIdentitySummary +`func (o *AccountActivityItem) UnsetReviewerIdentitySummary()` + +UnsetReviewerIdentitySummary ensures that no value is present for ReviewerIdentitySummary, not even an explicit nil +### GetReviewerComment + +`func (o *AccountActivityItem) GetReviewerComment() Comment` + +GetReviewerComment returns the ReviewerComment field if non-nil, zero value otherwise. + +### GetReviewerCommentOk + +`func (o *AccountActivityItem) GetReviewerCommentOk() (*Comment, bool)` + +GetReviewerCommentOk returns a tuple with the ReviewerComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerComment + +`func (o *AccountActivityItem) SetReviewerComment(v Comment)` + +SetReviewerComment sets ReviewerComment field to given value. + +### HasReviewerComment + +`func (o *AccountActivityItem) HasReviewerComment() bool` + +HasReviewerComment returns a boolean if a field has been set. + +### SetReviewerCommentNil + +`func (o *AccountActivityItem) SetReviewerCommentNil(b bool)` + + SetReviewerCommentNil sets the value for ReviewerComment to be an explicit nil + +### UnsetReviewerComment +`func (o *AccountActivityItem) UnsetReviewerComment()` + +UnsetReviewerComment ensures that no value is present for ReviewerComment, not even an explicit nil +### GetOperation + +`func (o *AccountActivityItem) GetOperation() AccountActivityItemOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *AccountActivityItem) GetOperationOk() (*AccountActivityItemOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *AccountActivityItem) SetOperation(v AccountActivityItemOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *AccountActivityItem) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### SetOperationNil + +`func (o *AccountActivityItem) SetOperationNil(b bool)` + + SetOperationNil sets the value for Operation to be an explicit nil + +### UnsetOperation +`func (o *AccountActivityItem) UnsetOperation()` + +UnsetOperation ensures that no value is present for Operation, not even an explicit nil +### GetAttribute + +`func (o *AccountActivityItem) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *AccountActivityItem) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *AccountActivityItem) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *AccountActivityItem) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *AccountActivityItem) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *AccountActivityItem) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *AccountActivityItem) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AccountActivityItem) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AccountActivityItem) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AccountActivityItem) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *AccountActivityItem) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *AccountActivityItem) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetNativeIdentity + +`func (o *AccountActivityItem) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountActivityItem) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountActivityItem) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccountActivityItem) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### SetNativeIdentityNil + +`func (o *AccountActivityItem) SetNativeIdentityNil(b bool)` + + SetNativeIdentityNil sets the value for NativeIdentity to be an explicit nil + +### UnsetNativeIdentity +`func (o *AccountActivityItem) UnsetNativeIdentity()` + +UnsetNativeIdentity ensures that no value is present for NativeIdentity, not even an explicit nil +### GetSourceId + +`func (o *AccountActivityItem) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccountActivityItem) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccountActivityItem) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *AccountActivityItem) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetAccountRequestInfo + +`func (o *AccountActivityItem) GetAccountRequestInfo() AccountRequestInfo` + +GetAccountRequestInfo returns the AccountRequestInfo field if non-nil, zero value otherwise. + +### GetAccountRequestInfoOk + +`func (o *AccountActivityItem) GetAccountRequestInfoOk() (*AccountRequestInfo, bool)` + +GetAccountRequestInfoOk returns a tuple with the AccountRequestInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountRequestInfo + +`func (o *AccountActivityItem) SetAccountRequestInfo(v AccountRequestInfo)` + +SetAccountRequestInfo sets AccountRequestInfo field to given value. + +### HasAccountRequestInfo + +`func (o *AccountActivityItem) HasAccountRequestInfo() bool` + +HasAccountRequestInfo returns a boolean if a field has been set. + +### SetAccountRequestInfoNil + +`func (o *AccountActivityItem) SetAccountRequestInfoNil(b bool)` + + SetAccountRequestInfoNil sets the value for AccountRequestInfo to be an explicit nil + +### UnsetAccountRequestInfo +`func (o *AccountActivityItem) UnsetAccountRequestInfo()` + +UnsetAccountRequestInfo ensures that no value is present for AccountRequestInfo, not even an explicit nil +### GetClientMetadata + +`func (o *AccountActivityItem) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *AccountActivityItem) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *AccountActivityItem) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *AccountActivityItem) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *AccountActivityItem) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *AccountActivityItem) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetRemoveDate + +`func (o *AccountActivityItem) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *AccountActivityItem) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *AccountActivityItem) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *AccountActivityItem) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *AccountActivityItem) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *AccountActivityItem) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountActivityItemOperation.md b/docs/tools/sdk/go/Reference/V3/Models/AccountActivityItemOperation.md new file mode 100644 index 000000000..da079dd10 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountActivityItemOperation.md @@ -0,0 +1,37 @@ +--- +id: account-activity-item-operation +title: AccountActivityItemOperation +pagination_label: AccountActivityItemOperation +sidebar_label: AccountActivityItemOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivityItemOperation', 'AccountActivityItemOperation'] +slug: /tools/sdk/go/v3/models/account-activity-item-operation +tags: ['SDK', 'Software Development Kit', 'AccountActivityItemOperation', 'AccountActivityItemOperation'] +--- + +# AccountActivityItemOperation + +## Enum + + +* `ADD` (value: `"ADD"`) + +* `CREATE` (value: `"CREATE"`) + +* `MODIFY` (value: `"MODIFY"`) + +* `DELETE` (value: `"DELETE"`) + +* `DISABLE` (value: `"DISABLE"`) + +* `ENABLE` (value: `"ENABLE"`) + +* `UNLOCK` (value: `"UNLOCK"`) + +* `LOCK` (value: `"LOCK"`) + +* `REMOVE` (value: `"REMOVE"`) + +* `SET` (value: `"SET"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountActivitySearchedItem.md b/docs/tools/sdk/go/Reference/V3/Models/AccountActivitySearchedItem.md new file mode 100644 index 000000000..5baf7e14b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountActivitySearchedItem.md @@ -0,0 +1,520 @@ +--- +id: account-activity-searched-item +title: AccountActivitySearchedItem +pagination_label: AccountActivitySearchedItem +sidebar_label: AccountActivitySearchedItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountActivitySearchedItem', 'AccountActivitySearchedItem'] +slug: /tools/sdk/go/v3/models/account-activity-searched-item +tags: ['SDK', 'Software Development Kit', 'AccountActivitySearchedItem', 'AccountActivitySearchedItem'] +--- + +# AccountActivitySearchedItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of account activity. | [optional] +**Action** | Pointer to **string** | Type of action performed in the activity. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Stage** | Pointer to **string** | Activity's current stage. | [optional] +**Status** | Pointer to **string** | Activity's current status. | [optional] +**Requester** | Pointer to [**ActivityIdentity**](activity-identity) | | [optional] +**Recipient** | Pointer to [**ActivityIdentity**](activity-identity) | | [optional] +**TrackingNumber** | Pointer to **string** | Account activity's tracking number. | [optional] +**Errors** | Pointer to **[]string** | Errors provided by the source while completing account actions. | [optional] +**Warnings** | Pointer to **[]string** | Warnings provided by the source while completing account actions. | [optional] +**Approvals** | Pointer to [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional] +**OriginalRequests** | Pointer to [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional] +**ExpansionItems** | Pointer to [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional] +**AccountRequests** | Pointer to [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional] +**Sources** | Pointer to **string** | Sources involved in the account activity. | [optional] + +## Methods + +### NewAccountActivitySearchedItem + +`func NewAccountActivitySearchedItem() *AccountActivitySearchedItem` + +NewAccountActivitySearchedItem instantiates a new AccountActivitySearchedItem 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 + +### NewAccountActivitySearchedItemWithDefaults + +`func NewAccountActivitySearchedItemWithDefaults() *AccountActivitySearchedItem` + +NewAccountActivitySearchedItemWithDefaults instantiates a new AccountActivitySearchedItem 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 + +### GetId + +`func (o *AccountActivitySearchedItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountActivitySearchedItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountActivitySearchedItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountActivitySearchedItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAction + +`func (o *AccountActivitySearchedItem) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *AccountActivitySearchedItem) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *AccountActivitySearchedItem) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *AccountActivitySearchedItem) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetCreated + +`func (o *AccountActivitySearchedItem) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *AccountActivitySearchedItem) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *AccountActivitySearchedItem) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *AccountActivitySearchedItem) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *AccountActivitySearchedItem) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *AccountActivitySearchedItem) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *AccountActivitySearchedItem) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *AccountActivitySearchedItem) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *AccountActivitySearchedItem) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *AccountActivitySearchedItem) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *AccountActivitySearchedItem) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *AccountActivitySearchedItem) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *AccountActivitySearchedItem) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *AccountActivitySearchedItem) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *AccountActivitySearchedItem) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *AccountActivitySearchedItem) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetStage + +`func (o *AccountActivitySearchedItem) GetStage() string` + +GetStage returns the Stage field if non-nil, zero value otherwise. + +### GetStageOk + +`func (o *AccountActivitySearchedItem) GetStageOk() (*string, bool)` + +GetStageOk returns a tuple with the Stage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStage + +`func (o *AccountActivitySearchedItem) SetStage(v string)` + +SetStage sets Stage field to given value. + +### HasStage + +`func (o *AccountActivitySearchedItem) HasStage() bool` + +HasStage returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccountActivitySearchedItem) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountActivitySearchedItem) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountActivitySearchedItem) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccountActivitySearchedItem) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetRequester + +`func (o *AccountActivitySearchedItem) GetRequester() ActivityIdentity` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *AccountActivitySearchedItem) GetRequesterOk() (*ActivityIdentity, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *AccountActivitySearchedItem) SetRequester(v ActivityIdentity)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *AccountActivitySearchedItem) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRecipient + +`func (o *AccountActivitySearchedItem) GetRecipient() ActivityIdentity` + +GetRecipient returns the Recipient field if non-nil, zero value otherwise. + +### GetRecipientOk + +`func (o *AccountActivitySearchedItem) GetRecipientOk() (*ActivityIdentity, bool)` + +GetRecipientOk returns a tuple with the Recipient field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipient + +`func (o *AccountActivitySearchedItem) SetRecipient(v ActivityIdentity)` + +SetRecipient sets Recipient field to given value. + +### HasRecipient + +`func (o *AccountActivitySearchedItem) HasRecipient() bool` + +HasRecipient returns a boolean if a field has been set. + +### GetTrackingNumber + +`func (o *AccountActivitySearchedItem) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *AccountActivitySearchedItem) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *AccountActivitySearchedItem) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + +### HasTrackingNumber + +`func (o *AccountActivitySearchedItem) HasTrackingNumber() bool` + +HasTrackingNumber returns a boolean if a field has been set. + +### GetErrors + +`func (o *AccountActivitySearchedItem) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountActivitySearchedItem) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountActivitySearchedItem) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *AccountActivitySearchedItem) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### SetErrorsNil + +`func (o *AccountActivitySearchedItem) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *AccountActivitySearchedItem) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetWarnings + +`func (o *AccountActivitySearchedItem) GetWarnings() []string` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *AccountActivitySearchedItem) GetWarningsOk() (*[]string, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *AccountActivitySearchedItem) SetWarnings(v []string)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *AccountActivitySearchedItem) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + +### SetWarningsNil + +`func (o *AccountActivitySearchedItem) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *AccountActivitySearchedItem) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetApprovals + +`func (o *AccountActivitySearchedItem) GetApprovals() []Approval` + +GetApprovals returns the Approvals field if non-nil, zero value otherwise. + +### GetApprovalsOk + +`func (o *AccountActivitySearchedItem) GetApprovalsOk() (*[]Approval, bool)` + +GetApprovalsOk returns a tuple with the Approvals field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovals + +`func (o *AccountActivitySearchedItem) SetApprovals(v []Approval)` + +SetApprovals sets Approvals field to given value. + +### HasApprovals + +`func (o *AccountActivitySearchedItem) HasApprovals() bool` + +HasApprovals returns a boolean if a field has been set. + +### GetOriginalRequests + +`func (o *AccountActivitySearchedItem) GetOriginalRequests() []OriginalRequest` + +GetOriginalRequests returns the OriginalRequests field if non-nil, zero value otherwise. + +### GetOriginalRequestsOk + +`func (o *AccountActivitySearchedItem) GetOriginalRequestsOk() (*[]OriginalRequest, bool)` + +GetOriginalRequestsOk returns a tuple with the OriginalRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalRequests + +`func (o *AccountActivitySearchedItem) SetOriginalRequests(v []OriginalRequest)` + +SetOriginalRequests sets OriginalRequests field to given value. + +### HasOriginalRequests + +`func (o *AccountActivitySearchedItem) HasOriginalRequests() bool` + +HasOriginalRequests returns a boolean if a field has been set. + +### GetExpansionItems + +`func (o *AccountActivitySearchedItem) GetExpansionItems() []ExpansionItem` + +GetExpansionItems returns the ExpansionItems field if non-nil, zero value otherwise. + +### GetExpansionItemsOk + +`func (o *AccountActivitySearchedItem) GetExpansionItemsOk() (*[]ExpansionItem, bool)` + +GetExpansionItemsOk returns a tuple with the ExpansionItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpansionItems + +`func (o *AccountActivitySearchedItem) SetExpansionItems(v []ExpansionItem)` + +SetExpansionItems sets ExpansionItems field to given value. + +### HasExpansionItems + +`func (o *AccountActivitySearchedItem) HasExpansionItems() bool` + +HasExpansionItems returns a boolean if a field has been set. + +### GetAccountRequests + +`func (o *AccountActivitySearchedItem) GetAccountRequests() []AccountRequest` + +GetAccountRequests returns the AccountRequests field if non-nil, zero value otherwise. + +### GetAccountRequestsOk + +`func (o *AccountActivitySearchedItem) GetAccountRequestsOk() (*[]AccountRequest, bool)` + +GetAccountRequestsOk returns a tuple with the AccountRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountRequests + +`func (o *AccountActivitySearchedItem) SetAccountRequests(v []AccountRequest)` + +SetAccountRequests sets AccountRequests field to given value. + +### HasAccountRequests + +`func (o *AccountActivitySearchedItem) HasAccountRequests() bool` + +HasAccountRequests returns a boolean if a field has been set. + +### GetSources + +`func (o *AccountActivitySearchedItem) GetSources() string` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *AccountActivitySearchedItem) GetSourcesOk() (*string, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *AccountActivitySearchedItem) SetSources(v string)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *AccountActivitySearchedItem) HasSources() bool` + +HasSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountAllOfIdentity.md b/docs/tools/sdk/go/Reference/V3/Models/AccountAllOfIdentity.md new file mode 100644 index 000000000..ef585aa5b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountAllOfIdentity.md @@ -0,0 +1,116 @@ +--- +id: account-all-of-identity +title: AccountAllOfIdentity +pagination_label: AccountAllOfIdentity +sidebar_label: AccountAllOfIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAllOfIdentity', 'AccountAllOfIdentity'] +slug: /tools/sdk/go/v3/models/account-all-of-identity +tags: ['SDK', 'Software Development Kit', 'AccountAllOfIdentity', 'AccountAllOfIdentity'] +--- + +# AccountAllOfIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the identity | [optional] +**Type** | Pointer to **string** | The type of object being referenced | [optional] +**Name** | Pointer to **string** | display name of identity | [optional] + +## Methods + +### NewAccountAllOfIdentity + +`func NewAccountAllOfIdentity() *AccountAllOfIdentity` + +NewAccountAllOfIdentity instantiates a new AccountAllOfIdentity 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 + +### NewAccountAllOfIdentityWithDefaults + +`func NewAccountAllOfIdentityWithDefaults() *AccountAllOfIdentity` + +NewAccountAllOfIdentityWithDefaults instantiates a new AccountAllOfIdentity 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 + +### GetId + +`func (o *AccountAllOfIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAllOfIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAllOfIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountAllOfIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccountAllOfIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAllOfIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAllOfIdentity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountAllOfIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccountAllOfIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAllOfIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAllOfIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountAllOfIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountAllOfOwnerIdentity.md b/docs/tools/sdk/go/Reference/V3/Models/AccountAllOfOwnerIdentity.md new file mode 100644 index 000000000..b031a93bc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountAllOfOwnerIdentity.md @@ -0,0 +1,116 @@ +--- +id: account-all-of-owner-identity +title: AccountAllOfOwnerIdentity +pagination_label: AccountAllOfOwnerIdentity +sidebar_label: AccountAllOfOwnerIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAllOfOwnerIdentity', 'AccountAllOfOwnerIdentity'] +slug: /tools/sdk/go/v3/models/account-all-of-owner-identity +tags: ['SDK', 'Software Development Kit', 'AccountAllOfOwnerIdentity', 'AccountAllOfOwnerIdentity'] +--- + +# AccountAllOfOwnerIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewAccountAllOfOwnerIdentity + +`func NewAccountAllOfOwnerIdentity() *AccountAllOfOwnerIdentity` + +NewAccountAllOfOwnerIdentity instantiates a new AccountAllOfOwnerIdentity 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 + +### NewAccountAllOfOwnerIdentityWithDefaults + +`func NewAccountAllOfOwnerIdentityWithDefaults() *AccountAllOfOwnerIdentity` + +NewAccountAllOfOwnerIdentityWithDefaults instantiates a new AccountAllOfOwnerIdentity 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 + +### GetType + +`func (o *AccountAllOfOwnerIdentity) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAllOfOwnerIdentity) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAllOfOwnerIdentity) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountAllOfOwnerIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AccountAllOfOwnerIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAllOfOwnerIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAllOfOwnerIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountAllOfOwnerIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccountAllOfOwnerIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAllOfOwnerIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAllOfOwnerIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountAllOfOwnerIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountAllOfRecommendation.md b/docs/tools/sdk/go/Reference/V3/Models/AccountAllOfRecommendation.md new file mode 100644 index 000000000..012d3ab34 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountAllOfRecommendation.md @@ -0,0 +1,80 @@ +--- +id: account-all-of-recommendation +title: AccountAllOfRecommendation +pagination_label: AccountAllOfRecommendation +sidebar_label: AccountAllOfRecommendation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAllOfRecommendation', 'AccountAllOfRecommendation'] +slug: /tools/sdk/go/v3/models/account-all-of-recommendation +tags: ['SDK', 'Software Development Kit', 'AccountAllOfRecommendation', 'AccountAllOfRecommendation'] +--- + +# AccountAllOfRecommendation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Recommended type of account. | +**Method** | **string** | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | + +## Methods + +### NewAccountAllOfRecommendation + +`func NewAccountAllOfRecommendation(type_ string, method string, ) *AccountAllOfRecommendation` + +NewAccountAllOfRecommendation instantiates a new AccountAllOfRecommendation 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 + +### NewAccountAllOfRecommendationWithDefaults + +`func NewAccountAllOfRecommendationWithDefaults() *AccountAllOfRecommendation` + +NewAccountAllOfRecommendationWithDefaults instantiates a new AccountAllOfRecommendation 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 + +### GetType + +`func (o *AccountAllOfRecommendation) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAllOfRecommendation) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAllOfRecommendation) SetType(v string)` + +SetType sets Type field to given value. + + +### GetMethod + +`func (o *AccountAllOfRecommendation) GetMethod() string` + +GetMethod returns the Method field if non-nil, zero value otherwise. + +### GetMethodOk + +`func (o *AccountAllOfRecommendation) GetMethodOk() (*string, bool)` + +GetMethodOk returns a tuple with the Method field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMethod + +`func (o *AccountAllOfRecommendation) SetMethod(v string)` + +SetMethod sets Method field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountAllOfSourceOwner.md b/docs/tools/sdk/go/Reference/V3/Models/AccountAllOfSourceOwner.md new file mode 100644 index 000000000..3041b979f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountAllOfSourceOwner.md @@ -0,0 +1,116 @@ +--- +id: account-all-of-source-owner +title: AccountAllOfSourceOwner +pagination_label: AccountAllOfSourceOwner +sidebar_label: AccountAllOfSourceOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAllOfSourceOwner', 'AccountAllOfSourceOwner'] +slug: /tools/sdk/go/v3/models/account-all-of-source-owner +tags: ['SDK', 'Software Development Kit', 'AccountAllOfSourceOwner', 'AccountAllOfSourceOwner'] +--- + +# AccountAllOfSourceOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the identity | [optional] +**Type** | Pointer to **string** | The type of object being referenced | [optional] +**Name** | Pointer to **string** | display name of identity | [optional] + +## Methods + +### NewAccountAllOfSourceOwner + +`func NewAccountAllOfSourceOwner() *AccountAllOfSourceOwner` + +NewAccountAllOfSourceOwner instantiates a new AccountAllOfSourceOwner 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 + +### NewAccountAllOfSourceOwnerWithDefaults + +`func NewAccountAllOfSourceOwnerWithDefaults() *AccountAllOfSourceOwner` + +NewAccountAllOfSourceOwnerWithDefaults instantiates a new AccountAllOfSourceOwner 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 + +### GetId + +`func (o *AccountAllOfSourceOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountAllOfSourceOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountAllOfSourceOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountAllOfSourceOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AccountAllOfSourceOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountAllOfSourceOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountAllOfSourceOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountAllOfSourceOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *AccountAllOfSourceOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountAllOfSourceOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountAllOfSourceOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountAllOfSourceOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountAttributes.md b/docs/tools/sdk/go/Reference/V3/Models/AccountAttributes.md new file mode 100644 index 000000000..2ef7b62be --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountAttributes.md @@ -0,0 +1,59 @@ +--- +id: account-attributes +title: AccountAttributes +pagination_label: AccountAttributes +sidebar_label: AccountAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributes', 'AccountAttributes'] +slug: /tools/sdk/go/v3/models/account-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributes', 'AccountAttributes'] +--- + +# AccountAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | **map[string]interface{}** | The schema attribute values for the account | + +## Methods + +### NewAccountAttributes + +`func NewAccountAttributes(attributes map[string]interface{}, ) *AccountAttributes` + +NewAccountAttributes instantiates a new AccountAttributes 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 + +### NewAccountAttributesWithDefaults + +`func NewAccountAttributesWithDefaults() *AccountAttributes` + +NewAccountAttributesWithDefaults instantiates a new AccountAttributes 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 + +### GetAttributes + +`func (o *AccountAttributes) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AccountAttributes) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AccountAttributes) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountAttributesCreate.md b/docs/tools/sdk/go/Reference/V3/Models/AccountAttributesCreate.md new file mode 100644 index 000000000..d8f5703b2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountAttributesCreate.md @@ -0,0 +1,59 @@ +--- +id: account-attributes-create +title: AccountAttributesCreate +pagination_label: AccountAttributesCreate +sidebar_label: AccountAttributesCreate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesCreate', 'AccountAttributesCreate'] +slug: /tools/sdk/go/v3/models/account-attributes-create +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate', 'AccountAttributesCreate'] +--- + +# AccountAttributesCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | + +## Methods + +### NewAccountAttributesCreate + +`func NewAccountAttributesCreate(attributes AccountAttributesCreateAttributes, ) *AccountAttributesCreate` + +NewAccountAttributesCreate instantiates a new AccountAttributesCreate 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 + +### NewAccountAttributesCreateWithDefaults + +`func NewAccountAttributesCreateWithDefaults() *AccountAttributesCreate` + +NewAccountAttributesCreateWithDefaults instantiates a new AccountAttributesCreate 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 + +### GetAttributes + +`func (o *AccountAttributesCreate) GetAttributes() AccountAttributesCreateAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AccountAttributesCreate) GetAttributesOk() (*AccountAttributesCreateAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AccountAttributesCreate) SetAttributes(v AccountAttributesCreateAttributes)` + +SetAttributes sets Attributes field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountAttributesCreateAttributes.md b/docs/tools/sdk/go/Reference/V3/Models/AccountAttributesCreateAttributes.md new file mode 100644 index 000000000..d6c2da0c5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountAttributesCreateAttributes.md @@ -0,0 +1,59 @@ +--- +id: account-attributes-create-attributes +title: AccountAttributesCreateAttributes +pagination_label: AccountAttributesCreateAttributes +sidebar_label: AccountAttributesCreateAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountAttributesCreateAttributes', 'AccountAttributesCreateAttributes'] +slug: /tools/sdk/go/v3/models/account-attributes-create-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreateAttributes', 'AccountAttributesCreateAttributes'] +--- + +# AccountAttributesCreateAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | **string** | Target source to create an account | + +## Methods + +### NewAccountAttributesCreateAttributes + +`func NewAccountAttributesCreateAttributes(sourceId string, ) *AccountAttributesCreateAttributes` + +NewAccountAttributesCreateAttributes instantiates a new AccountAttributesCreateAttributes 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 + +### NewAccountAttributesCreateAttributesWithDefaults + +`func NewAccountAttributesCreateAttributesWithDefaults() *AccountAttributesCreateAttributes` + +NewAccountAttributesCreateAttributesWithDefaults instantiates a new AccountAttributesCreateAttributes 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 + +### GetSourceId + +`func (o *AccountAttributesCreateAttributes) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *AccountAttributesCreateAttributes) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *AccountAttributesCreateAttributes) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountItemRef.md b/docs/tools/sdk/go/Reference/V3/Models/AccountItemRef.md new file mode 100644 index 000000000..3f56968b8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountItemRef.md @@ -0,0 +1,100 @@ +--- +id: account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountItemRef', 'AccountItemRef'] +slug: /tools/sdk/go/v3/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'AccountItemRef'] +--- + +# AccountItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountUuid** | Pointer to **NullableString** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | Pointer to **string** | The 'distinguishedName' attribute for the account | [optional] + +## Methods + +### NewAccountItemRef + +`func NewAccountItemRef() *AccountItemRef` + +NewAccountItemRef instantiates a new AccountItemRef 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 + +### NewAccountItemRefWithDefaults + +`func NewAccountItemRefWithDefaults() *AccountItemRef` + +NewAccountItemRefWithDefaults instantiates a new AccountItemRef 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 + +### GetAccountUuid + +`func (o *AccountItemRef) GetAccountUuid() string` + +GetAccountUuid returns the AccountUuid field if non-nil, zero value otherwise. + +### GetAccountUuidOk + +`func (o *AccountItemRef) GetAccountUuidOk() (*string, bool)` + +GetAccountUuidOk returns a tuple with the AccountUuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountUuid + +`func (o *AccountItemRef) SetAccountUuid(v string)` + +SetAccountUuid sets AccountUuid field to given value. + +### HasAccountUuid + +`func (o *AccountItemRef) HasAccountUuid() bool` + +HasAccountUuid returns a boolean if a field has been set. + +### SetAccountUuidNil + +`func (o *AccountItemRef) SetAccountUuidNil(b bool)` + + SetAccountUuidNil sets the value for AccountUuid to be an explicit nil + +### UnsetAccountUuid +`func (o *AccountItemRef) UnsetAccountUuid()` + +UnsetAccountUuid ensures that no value is present for AccountUuid, not even an explicit nil +### GetNativeIdentity + +`func (o *AccountItemRef) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *AccountItemRef) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *AccountItemRef) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *AccountItemRef) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountRequest.md b/docs/tools/sdk/go/Reference/V3/Models/AccountRequest.md new file mode 100644 index 000000000..16976f675 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountRequest.md @@ -0,0 +1,194 @@ +--- +id: account-request +title: AccountRequest +pagination_label: AccountRequest +sidebar_label: AccountRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountRequest', 'AccountRequest'] +slug: /tools/sdk/go/v3/models/account-request +tags: ['SDK', 'Software Development Kit', 'AccountRequest', 'AccountRequest'] +--- + +# AccountRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **string** | Unique ID of the account | [optional] +**AttributeRequests** | Pointer to [**[]AttributeRequest**](attribute-request) | | [optional] +**Op** | Pointer to **string** | The operation that was performed | [optional] +**ProvisioningTarget** | Pointer to [**AccountSource**](account-source) | | [optional] +**Result** | Pointer to [**AccountRequestResult**](account-request-result) | | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] + +## Methods + +### NewAccountRequest + +`func NewAccountRequest() *AccountRequest` + +NewAccountRequest instantiates a new AccountRequest 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 + +### NewAccountRequestWithDefaults + +`func NewAccountRequestWithDefaults() *AccountRequest` + +NewAccountRequestWithDefaults instantiates a new AccountRequest 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 + +### GetAccountId + +`func (o *AccountRequest) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *AccountRequest) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *AccountRequest) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *AccountRequest) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetAttributeRequests + +`func (o *AccountRequest) GetAttributeRequests() []AttributeRequest` + +GetAttributeRequests returns the AttributeRequests field if non-nil, zero value otherwise. + +### GetAttributeRequestsOk + +`func (o *AccountRequest) GetAttributeRequestsOk() (*[]AttributeRequest, bool)` + +GetAttributeRequestsOk returns a tuple with the AttributeRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeRequests + +`func (o *AccountRequest) SetAttributeRequests(v []AttributeRequest)` + +SetAttributeRequests sets AttributeRequests field to given value. + +### HasAttributeRequests + +`func (o *AccountRequest) HasAttributeRequests() bool` + +HasAttributeRequests returns a boolean if a field has been set. + +### GetOp + +`func (o *AccountRequest) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *AccountRequest) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *AccountRequest) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *AccountRequest) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetProvisioningTarget + +`func (o *AccountRequest) GetProvisioningTarget() AccountSource` + +GetProvisioningTarget returns the ProvisioningTarget field if non-nil, zero value otherwise. + +### GetProvisioningTargetOk + +`func (o *AccountRequest) GetProvisioningTargetOk() (*AccountSource, bool)` + +GetProvisioningTargetOk returns a tuple with the ProvisioningTarget field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningTarget + +`func (o *AccountRequest) SetProvisioningTarget(v AccountSource)` + +SetProvisioningTarget sets ProvisioningTarget field to given value. + +### HasProvisioningTarget + +`func (o *AccountRequest) HasProvisioningTarget() bool` + +HasProvisioningTarget returns a boolean if a field has been set. + +### GetResult + +`func (o *AccountRequest) GetResult() AccountRequestResult` + +GetResult returns the Result field if non-nil, zero value otherwise. + +### GetResultOk + +`func (o *AccountRequest) GetResultOk() (*AccountRequestResult, bool)` + +GetResultOk returns a tuple with the Result field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResult + +`func (o *AccountRequest) SetResult(v AccountRequestResult)` + +SetResult sets Result field to given value. + +### HasResult + +`func (o *AccountRequest) HasResult() bool` + +HasResult returns a boolean if a field has been set. + +### GetSource + +`func (o *AccountRequest) GetSource() AccountSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *AccountRequest) GetSourceOk() (*AccountSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *AccountRequest) SetSource(v AccountSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *AccountRequest) HasSource() bool` + +HasSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountRequestInfo.md b/docs/tools/sdk/go/Reference/V3/Models/AccountRequestInfo.md new file mode 100644 index 000000000..9a9254e3d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountRequestInfo.md @@ -0,0 +1,116 @@ +--- +id: account-request-info +title: AccountRequestInfo +pagination_label: AccountRequestInfo +sidebar_label: AccountRequestInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountRequestInfo', 'AccountRequestInfo'] +slug: /tools/sdk/go/v3/models/account-request-info +tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'AccountRequestInfo'] +--- + +# AccountRequestInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedObjectId** | Pointer to **string** | Id of requested object | [optional] +**RequestedObjectName** | Pointer to **string** | Human-readable name of requested object | [optional] +**RequestedObjectType** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional] + +## Methods + +### NewAccountRequestInfo + +`func NewAccountRequestInfo() *AccountRequestInfo` + +NewAccountRequestInfo instantiates a new AccountRequestInfo 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 + +### NewAccountRequestInfoWithDefaults + +`func NewAccountRequestInfoWithDefaults() *AccountRequestInfo` + +NewAccountRequestInfoWithDefaults instantiates a new AccountRequestInfo 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 + +### GetRequestedObjectId + +`func (o *AccountRequestInfo) GetRequestedObjectId() string` + +GetRequestedObjectId returns the RequestedObjectId field if non-nil, zero value otherwise. + +### GetRequestedObjectIdOk + +`func (o *AccountRequestInfo) GetRequestedObjectIdOk() (*string, bool)` + +GetRequestedObjectIdOk returns a tuple with the RequestedObjectId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObjectId + +`func (o *AccountRequestInfo) SetRequestedObjectId(v string)` + +SetRequestedObjectId sets RequestedObjectId field to given value. + +### HasRequestedObjectId + +`func (o *AccountRequestInfo) HasRequestedObjectId() bool` + +HasRequestedObjectId returns a boolean if a field has been set. + +### GetRequestedObjectName + +`func (o *AccountRequestInfo) GetRequestedObjectName() string` + +GetRequestedObjectName returns the RequestedObjectName field if non-nil, zero value otherwise. + +### GetRequestedObjectNameOk + +`func (o *AccountRequestInfo) GetRequestedObjectNameOk() (*string, bool)` + +GetRequestedObjectNameOk returns a tuple with the RequestedObjectName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObjectName + +`func (o *AccountRequestInfo) SetRequestedObjectName(v string)` + +SetRequestedObjectName sets RequestedObjectName field to given value. + +### HasRequestedObjectName + +`func (o *AccountRequestInfo) HasRequestedObjectName() bool` + +HasRequestedObjectName returns a boolean if a field has been set. + +### GetRequestedObjectType + +`func (o *AccountRequestInfo) GetRequestedObjectType() RequestableObjectType` + +GetRequestedObjectType returns the RequestedObjectType field if non-nil, zero value otherwise. + +### GetRequestedObjectTypeOk + +`func (o *AccountRequestInfo) GetRequestedObjectTypeOk() (*RequestableObjectType, bool)` + +GetRequestedObjectTypeOk returns a tuple with the RequestedObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObjectType + +`func (o *AccountRequestInfo) SetRequestedObjectType(v RequestableObjectType)` + +SetRequestedObjectType sets RequestedObjectType field to given value. + +### HasRequestedObjectType + +`func (o *AccountRequestInfo) HasRequestedObjectType() bool` + +HasRequestedObjectType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountRequestResult.md b/docs/tools/sdk/go/Reference/V3/Models/AccountRequestResult.md new file mode 100644 index 000000000..12468007f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountRequestResult.md @@ -0,0 +1,126 @@ +--- +id: account-request-result +title: AccountRequestResult +pagination_label: AccountRequestResult +sidebar_label: AccountRequestResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountRequestResult', 'AccountRequestResult'] +slug: /tools/sdk/go/v3/models/account-request-result +tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'AccountRequestResult'] +--- + +# AccountRequestResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | Pointer to **[]string** | Error message. | [optional] +**Status** | Pointer to **string** | The status of the account request | [optional] +**TicketId** | Pointer to **NullableString** | ID of associated ticket. | [optional] + +## Methods + +### NewAccountRequestResult + +`func NewAccountRequestResult() *AccountRequestResult` + +NewAccountRequestResult instantiates a new AccountRequestResult 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 + +### NewAccountRequestResultWithDefaults + +`func NewAccountRequestResultWithDefaults() *AccountRequestResult` + +NewAccountRequestResultWithDefaults instantiates a new AccountRequestResult 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 + +### GetErrors + +`func (o *AccountRequestResult) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *AccountRequestResult) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *AccountRequestResult) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *AccountRequestResult) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### GetStatus + +`func (o *AccountRequestResult) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AccountRequestResult) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AccountRequestResult) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AccountRequestResult) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetTicketId + +`func (o *AccountRequestResult) GetTicketId() string` + +GetTicketId returns the TicketId field if non-nil, zero value otherwise. + +### GetTicketIdOk + +`func (o *AccountRequestResult) GetTicketIdOk() (*string, bool)` + +GetTicketIdOk returns a tuple with the TicketId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTicketId + +`func (o *AccountRequestResult) SetTicketId(v string)` + +SetTicketId sets TicketId field to given value. + +### HasTicketId + +`func (o *AccountRequestResult) HasTicketId() bool` + +HasTicketId returns a boolean if a field has been set. + +### SetTicketIdNil + +`func (o *AccountRequestResult) SetTicketIdNil(b bool)` + + SetTicketIdNil sets the value for TicketId to be an explicit nil + +### UnsetTicketId +`func (o *AccountRequestResult) UnsetTicketId()` + +UnsetTicketId ensures that no value is present for TicketId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountSource.md b/docs/tools/sdk/go/Reference/V3/Models/AccountSource.md new file mode 100644 index 000000000..2c3f8c0c9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountSource.md @@ -0,0 +1,116 @@ +--- +id: account-source +title: AccountSource +pagination_label: AccountSource +sidebar_label: AccountSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountSource', 'AccountSource'] +slug: /tools/sdk/go/v3/models/account-source +tags: ['SDK', 'Software Development Kit', 'AccountSource', 'AccountSource'] +--- + +# AccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**Type** | Pointer to **string** | Type of source returned. | [optional] + +## Methods + +### NewAccountSource + +`func NewAccountSource() *AccountSource` + +NewAccountSource instantiates a new AccountSource 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 + +### NewAccountSourceWithDefaults + +`func NewAccountSourceWithDefaults() *AccountSource` + +NewAccountSourceWithDefaults instantiates a new AccountSource 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 + +### GetId + +`func (o *AccountSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AccountSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AccountSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AccountSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AccountSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AccountSource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *AccountSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AccountSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AccountSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AccountSource) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountToggleRequest.md b/docs/tools/sdk/go/Reference/V3/Models/AccountToggleRequest.md new file mode 100644 index 000000000..e460236d4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountToggleRequest.md @@ -0,0 +1,90 @@ +--- +id: account-toggle-request +title: AccountToggleRequest +pagination_label: AccountToggleRequest +sidebar_label: AccountToggleRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountToggleRequest', 'AccountToggleRequest'] +slug: /tools/sdk/go/v3/models/account-toggle-request +tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'AccountToggleRequest'] +--- + +# AccountToggleRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExternalVerificationId** | Pointer to **string** | If set, an external process validates that the user wants to proceed with this request. | [optional] +**ForceProvisioning** | Pointer to **bool** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing 'true' for an unlocked account will add and process 'Unlock' operation by the workflow. | [optional] + +## Methods + +### NewAccountToggleRequest + +`func NewAccountToggleRequest() *AccountToggleRequest` + +NewAccountToggleRequest instantiates a new AccountToggleRequest 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 + +### NewAccountToggleRequestWithDefaults + +`func NewAccountToggleRequestWithDefaults() *AccountToggleRequest` + +NewAccountToggleRequestWithDefaults instantiates a new AccountToggleRequest 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 + +### GetExternalVerificationId + +`func (o *AccountToggleRequest) GetExternalVerificationId() string` + +GetExternalVerificationId returns the ExternalVerificationId field if non-nil, zero value otherwise. + +### GetExternalVerificationIdOk + +`func (o *AccountToggleRequest) GetExternalVerificationIdOk() (*string, bool)` + +GetExternalVerificationIdOk returns a tuple with the ExternalVerificationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExternalVerificationId + +`func (o *AccountToggleRequest) SetExternalVerificationId(v string)` + +SetExternalVerificationId sets ExternalVerificationId field to given value. + +### HasExternalVerificationId + +`func (o *AccountToggleRequest) HasExternalVerificationId() bool` + +HasExternalVerificationId returns a boolean if a field has been set. + +### GetForceProvisioning + +`func (o *AccountToggleRequest) GetForceProvisioning() bool` + +GetForceProvisioning returns the ForceProvisioning field if non-nil, zero value otherwise. + +### GetForceProvisioningOk + +`func (o *AccountToggleRequest) GetForceProvisioningOk() (*bool, bool)` + +GetForceProvisioningOk returns a tuple with the ForceProvisioning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForceProvisioning + +`func (o *AccountToggleRequest) SetForceProvisioning(v bool)` + +SetForceProvisioning sets ForceProvisioning field to given value. + +### HasForceProvisioning + +`func (o *AccountToggleRequest) HasForceProvisioning() bool` + +HasForceProvisioning returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountUnlockRequest.md b/docs/tools/sdk/go/Reference/V3/Models/AccountUnlockRequest.md new file mode 100644 index 000000000..1f6881af9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountUnlockRequest.md @@ -0,0 +1,116 @@ +--- +id: account-unlock-request +title: AccountUnlockRequest +pagination_label: AccountUnlockRequest +sidebar_label: AccountUnlockRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUnlockRequest', 'AccountUnlockRequest'] +slug: /tools/sdk/go/v3/models/account-unlock-request +tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'AccountUnlockRequest'] +--- + +# AccountUnlockRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExternalVerificationId** | Pointer to **string** | If set, an external process validates that the user wants to proceed with this request. | [optional] +**UnlockIDNAccount** | Pointer to **bool** | If set, the IDN account is unlocked after the workflow completes. | [optional] +**ForceProvisioning** | Pointer to **bool** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional] + +## Methods + +### NewAccountUnlockRequest + +`func NewAccountUnlockRequest() *AccountUnlockRequest` + +NewAccountUnlockRequest instantiates a new AccountUnlockRequest 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 + +### NewAccountUnlockRequestWithDefaults + +`func NewAccountUnlockRequestWithDefaults() *AccountUnlockRequest` + +NewAccountUnlockRequestWithDefaults instantiates a new AccountUnlockRequest 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 + +### GetExternalVerificationId + +`func (o *AccountUnlockRequest) GetExternalVerificationId() string` + +GetExternalVerificationId returns the ExternalVerificationId field if non-nil, zero value otherwise. + +### GetExternalVerificationIdOk + +`func (o *AccountUnlockRequest) GetExternalVerificationIdOk() (*string, bool)` + +GetExternalVerificationIdOk returns a tuple with the ExternalVerificationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExternalVerificationId + +`func (o *AccountUnlockRequest) SetExternalVerificationId(v string)` + +SetExternalVerificationId sets ExternalVerificationId field to given value. + +### HasExternalVerificationId + +`func (o *AccountUnlockRequest) HasExternalVerificationId() bool` + +HasExternalVerificationId returns a boolean if a field has been set. + +### GetUnlockIDNAccount + +`func (o *AccountUnlockRequest) GetUnlockIDNAccount() bool` + +GetUnlockIDNAccount returns the UnlockIDNAccount field if non-nil, zero value otherwise. + +### GetUnlockIDNAccountOk + +`func (o *AccountUnlockRequest) GetUnlockIDNAccountOk() (*bool, bool)` + +GetUnlockIDNAccountOk returns a tuple with the UnlockIDNAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnlockIDNAccount + +`func (o *AccountUnlockRequest) SetUnlockIDNAccount(v bool)` + +SetUnlockIDNAccount sets UnlockIDNAccount field to given value. + +### HasUnlockIDNAccount + +`func (o *AccountUnlockRequest) HasUnlockIDNAccount() bool` + +HasUnlockIDNAccount returns a boolean if a field has been set. + +### GetForceProvisioning + +`func (o *AccountUnlockRequest) GetForceProvisioning() bool` + +GetForceProvisioning returns the ForceProvisioning field if non-nil, zero value otherwise. + +### GetForceProvisioningOk + +`func (o *AccountUnlockRequest) GetForceProvisioningOk() (*bool, bool)` + +GetForceProvisioningOk returns a tuple with the ForceProvisioning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForceProvisioning + +`func (o *AccountUnlockRequest) SetForceProvisioning(v bool)` + +SetForceProvisioning sets ForceProvisioning field to given value. + +### HasForceProvisioning + +`func (o *AccountUnlockRequest) HasForceProvisioning() bool` + +HasForceProvisioning returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/go/Reference/V3/Models/AccountUsage.md new file mode 100644 index 000000000..44850d3f0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountUsage.md @@ -0,0 +1,90 @@ +--- +id: account-usage +title: AccountUsage +pagination_label: AccountUsage +sidebar_label: AccountUsage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountUsage', 'AccountUsage'] +slug: /tools/sdk/go/v3/models/account-usage +tags: ['SDK', 'Software Development Kit', 'AccountUsage', 'AccountUsage'] +--- + +# AccountUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **string** | The first day of the month for which activity is aggregated. | [optional] +**Count** | Pointer to **int64** | The number of days within the month that the account was active in a source. | [optional] + +## Methods + +### NewAccountUsage + +`func NewAccountUsage() *AccountUsage` + +NewAccountUsage instantiates a new AccountUsage 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 + +### NewAccountUsageWithDefaults + +`func NewAccountUsageWithDefaults() *AccountUsage` + +NewAccountUsageWithDefaults instantiates a new AccountUsage 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 + +### GetDate + +`func (o *AccountUsage) GetDate() string` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *AccountUsage) GetDateOk() (*string, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *AccountUsage) SetDate(v string)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *AccountUsage) HasDate() bool` + +HasDate returns a boolean if a field has been set. + +### GetCount + +`func (o *AccountUsage) GetCount() int64` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *AccountUsage) GetCountOk() (*int64, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *AccountUsage) SetCount(v int64)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *AccountUsage) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountsAsyncResult.md b/docs/tools/sdk/go/Reference/V3/Models/AccountsAsyncResult.md new file mode 100644 index 000000000..9db661bb1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountsAsyncResult.md @@ -0,0 +1,59 @@ +--- +id: accounts-async-result +title: AccountsAsyncResult +pagination_label: AccountsAsyncResult +sidebar_label: AccountsAsyncResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsAsyncResult', 'AccountsAsyncResult'] +slug: /tools/sdk/go/v3/models/accounts-async-result +tags: ['SDK', 'Software Development Kit', 'AccountsAsyncResult', 'AccountsAsyncResult'] +--- + +# AccountsAsyncResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | id of the task | + +## Methods + +### NewAccountsAsyncResult + +`func NewAccountsAsyncResult(id string, ) *AccountsAsyncResult` + +NewAccountsAsyncResult instantiates a new AccountsAsyncResult 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 + +### NewAccountsAsyncResultWithDefaults + +`func NewAccountsAsyncResultWithDefaults() *AccountsAsyncResult` + +NewAccountsAsyncResultWithDefaults instantiates a new AccountsAsyncResult 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 + +### GetId + +`func (o *AccountsAsyncResult) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AccountsAsyncResult) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AccountsAsyncResult) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AccountsExportReportArguments.md b/docs/tools/sdk/go/Reference/V3/Models/AccountsExportReportArguments.md new file mode 100644 index 000000000..20348fc75 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AccountsExportReportArguments.md @@ -0,0 +1,80 @@ +--- +id: accounts-export-report-arguments +title: AccountsExportReportArguments +pagination_label: AccountsExportReportArguments +sidebar_label: AccountsExportReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AccountsExportReportArguments', 'AccountsExportReportArguments'] +slug: /tools/sdk/go/v3/models/accounts-export-report-arguments +tags: ['SDK', 'Software Development Kit', 'AccountsExportReportArguments', 'AccountsExportReportArguments'] +--- + +# AccountsExportReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Application** | **string** | Source ID. | +**SourceName** | **string** | Source name. | + +## Methods + +### NewAccountsExportReportArguments + +`func NewAccountsExportReportArguments(application string, sourceName string, ) *AccountsExportReportArguments` + +NewAccountsExportReportArguments instantiates a new AccountsExportReportArguments 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 + +### NewAccountsExportReportArgumentsWithDefaults + +`func NewAccountsExportReportArgumentsWithDefaults() *AccountsExportReportArguments` + +NewAccountsExportReportArgumentsWithDefaults instantiates a new AccountsExportReportArguments 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 + +### GetApplication + +`func (o *AccountsExportReportArguments) GetApplication() string` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *AccountsExportReportArguments) GetApplicationOk() (*string, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *AccountsExportReportArguments) SetApplication(v string)` + +SetApplication sets Application field to given value. + + +### GetSourceName + +`func (o *AccountsExportReportArguments) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *AccountsExportReportArguments) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *AccountsExportReportArguments) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ActivateCampaignOptions.md b/docs/tools/sdk/go/Reference/V3/Models/ActivateCampaignOptions.md new file mode 100644 index 000000000..bf70ae1f9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ActivateCampaignOptions.md @@ -0,0 +1,64 @@ +--- +id: activate-campaign-options +title: ActivateCampaignOptions +pagination_label: ActivateCampaignOptions +sidebar_label: ActivateCampaignOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ActivateCampaignOptions', 'ActivateCampaignOptions'] +slug: /tools/sdk/go/v3/models/activate-campaign-options +tags: ['SDK', 'Software Development Kit', 'ActivateCampaignOptions', 'ActivateCampaignOptions'] +--- + +# ActivateCampaignOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TimeZone** | Pointer to **string** | The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. | [optional] [default to "Z"] + +## Methods + +### NewActivateCampaignOptions + +`func NewActivateCampaignOptions() *ActivateCampaignOptions` + +NewActivateCampaignOptions instantiates a new ActivateCampaignOptions 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 + +### NewActivateCampaignOptionsWithDefaults + +`func NewActivateCampaignOptionsWithDefaults() *ActivateCampaignOptions` + +NewActivateCampaignOptionsWithDefaults instantiates a new ActivateCampaignOptions 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 + +### GetTimeZone + +`func (o *ActivateCampaignOptions) GetTimeZone() string` + +GetTimeZone returns the TimeZone field if non-nil, zero value otherwise. + +### GetTimeZoneOk + +`func (o *ActivateCampaignOptions) GetTimeZoneOk() (*string, bool)` + +GetTimeZoneOk returns a tuple with the TimeZone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZone + +`func (o *ActivateCampaignOptions) SetTimeZone(v string)` + +SetTimeZone sets TimeZone field to given value. + +### HasTimeZone + +`func (o *ActivateCampaignOptions) HasTimeZone() bool` + +HasTimeZone returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ActivityIdentity.md b/docs/tools/sdk/go/Reference/V3/Models/ActivityIdentity.md new file mode 100644 index 000000000..bb72f87b3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ActivityIdentity.md @@ -0,0 +1,116 @@ +--- +id: activity-identity +title: ActivityIdentity +pagination_label: ActivityIdentity +sidebar_label: ActivityIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ActivityIdentity', 'ActivityIdentity'] +slug: /tools/sdk/go/v3/models/activity-identity +tags: ['SDK', 'Software Development Kit', 'ActivityIdentity', 'ActivityIdentity'] +--- + +# ActivityIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**Type** | Pointer to **string** | Type of object | [optional] + +## Methods + +### NewActivityIdentity + +`func NewActivityIdentity() *ActivityIdentity` + +NewActivityIdentity instantiates a new ActivityIdentity 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 + +### NewActivityIdentityWithDefaults + +`func NewActivityIdentityWithDefaults() *ActivityIdentity` + +NewActivityIdentityWithDefaults instantiates a new ActivityIdentity 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 + +### GetId + +`func (o *ActivityIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ActivityIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ActivityIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ActivityIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ActivityIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ActivityIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ActivityIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ActivityIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *ActivityIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ActivityIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ActivityIdentity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ActivityIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ActivityInsights.md b/docs/tools/sdk/go/Reference/V3/Models/ActivityInsights.md new file mode 100644 index 000000000..18b7a4e43 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ActivityInsights.md @@ -0,0 +1,116 @@ +--- +id: activity-insights +title: ActivityInsights +pagination_label: ActivityInsights +sidebar_label: ActivityInsights +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ActivityInsights', 'ActivityInsights'] +slug: /tools/sdk/go/v3/models/activity-insights +tags: ['SDK', 'Software Development Kit', 'ActivityInsights', 'ActivityInsights'] +--- + +# ActivityInsights + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountID** | Pointer to **string** | UUID of the account | [optional] +**UsageDays** | Pointer to **int32** | The number of days of activity | [optional] +**UsageDaysState** | Pointer to **string** | Status indicating if the activity is complete or unknown | [optional] + +## Methods + +### NewActivityInsights + +`func NewActivityInsights() *ActivityInsights` + +NewActivityInsights instantiates a new ActivityInsights 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 + +### NewActivityInsightsWithDefaults + +`func NewActivityInsightsWithDefaults() *ActivityInsights` + +NewActivityInsightsWithDefaults instantiates a new ActivityInsights 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 + +### GetAccountID + +`func (o *ActivityInsights) GetAccountID() string` + +GetAccountID returns the AccountID field if non-nil, zero value otherwise. + +### GetAccountIDOk + +`func (o *ActivityInsights) GetAccountIDOk() (*string, bool)` + +GetAccountIDOk returns a tuple with the AccountID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountID + +`func (o *ActivityInsights) SetAccountID(v string)` + +SetAccountID sets AccountID field to given value. + +### HasAccountID + +`func (o *ActivityInsights) HasAccountID() bool` + +HasAccountID returns a boolean if a field has been set. + +### GetUsageDays + +`func (o *ActivityInsights) GetUsageDays() int32` + +GetUsageDays returns the UsageDays field if non-nil, zero value otherwise. + +### GetUsageDaysOk + +`func (o *ActivityInsights) GetUsageDaysOk() (*int32, bool)` + +GetUsageDaysOk returns a tuple with the UsageDays field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsageDays + +`func (o *ActivityInsights) SetUsageDays(v int32)` + +SetUsageDays sets UsageDays field to given value. + +### HasUsageDays + +`func (o *ActivityInsights) HasUsageDays() bool` + +HasUsageDays returns a boolean if a field has been set. + +### GetUsageDaysState + +`func (o *ActivityInsights) GetUsageDaysState() string` + +GetUsageDaysState returns the UsageDaysState field if non-nil, zero value otherwise. + +### GetUsageDaysStateOk + +`func (o *ActivityInsights) GetUsageDaysStateOk() (*string, bool)` + +GetUsageDaysStateOk returns a tuple with the UsageDaysState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsageDaysState + +`func (o *ActivityInsights) SetUsageDaysState(v string)` + +SetUsageDaysState sets UsageDaysState field to given value. + +### HasUsageDaysState + +`func (o *ActivityInsights) HasUsageDaysState() bool` + +HasUsageDaysState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AdminReviewReassign.md b/docs/tools/sdk/go/Reference/V3/Models/AdminReviewReassign.md new file mode 100644 index 000000000..80b0b362d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AdminReviewReassign.md @@ -0,0 +1,116 @@ +--- +id: admin-review-reassign +title: AdminReviewReassign +pagination_label: AdminReviewReassign +sidebar_label: AdminReviewReassign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AdminReviewReassign', 'AdminReviewReassign'] +slug: /tools/sdk/go/v3/models/admin-review-reassign +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassign', 'AdminReviewReassign'] +--- + +# AdminReviewReassign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CertificationIds** | Pointer to **[]string** | List of certification IDs to reassign | [optional] +**ReassignTo** | Pointer to [**AdminReviewReassignReassignTo**](admin-review-reassign-reassign-to) | | [optional] +**Reason** | Pointer to **string** | Comment to explain why the certification was reassigned | [optional] + +## Methods + +### NewAdminReviewReassign + +`func NewAdminReviewReassign() *AdminReviewReassign` + +NewAdminReviewReassign instantiates a new AdminReviewReassign 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 + +### NewAdminReviewReassignWithDefaults + +`func NewAdminReviewReassignWithDefaults() *AdminReviewReassign` + +NewAdminReviewReassignWithDefaults instantiates a new AdminReviewReassign 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 + +### GetCertificationIds + +`func (o *AdminReviewReassign) GetCertificationIds() []string` + +GetCertificationIds returns the CertificationIds field if non-nil, zero value otherwise. + +### GetCertificationIdsOk + +`func (o *AdminReviewReassign) GetCertificationIdsOk() (*[]string, bool)` + +GetCertificationIdsOk returns a tuple with the CertificationIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificationIds + +`func (o *AdminReviewReassign) SetCertificationIds(v []string)` + +SetCertificationIds sets CertificationIds field to given value. + +### HasCertificationIds + +`func (o *AdminReviewReassign) HasCertificationIds() bool` + +HasCertificationIds returns a boolean if a field has been set. + +### GetReassignTo + +`func (o *AdminReviewReassign) GetReassignTo() AdminReviewReassignReassignTo` + +GetReassignTo returns the ReassignTo field if non-nil, zero value otherwise. + +### GetReassignToOk + +`func (o *AdminReviewReassign) GetReassignToOk() (*AdminReviewReassignReassignTo, bool)` + +GetReassignToOk returns a tuple with the ReassignTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignTo + +`func (o *AdminReviewReassign) SetReassignTo(v AdminReviewReassignReassignTo)` + +SetReassignTo sets ReassignTo field to given value. + +### HasReassignTo + +`func (o *AdminReviewReassign) HasReassignTo() bool` + +HasReassignTo returns a boolean if a field has been set. + +### GetReason + +`func (o *AdminReviewReassign) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *AdminReviewReassign) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *AdminReviewReassign) SetReason(v string)` + +SetReason sets Reason field to given value. + +### HasReason + +`func (o *AdminReviewReassign) HasReason() bool` + +HasReason returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AdminReviewReassignReassignTo.md b/docs/tools/sdk/go/Reference/V3/Models/AdminReviewReassignReassignTo.md new file mode 100644 index 000000000..8930d783a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AdminReviewReassignReassignTo.md @@ -0,0 +1,90 @@ +--- +id: admin-review-reassign-reassign-to +title: AdminReviewReassignReassignTo +pagination_label: AdminReviewReassignReassignTo +sidebar_label: AdminReviewReassignReassignTo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AdminReviewReassignReassignTo', 'AdminReviewReassignReassignTo'] +slug: /tools/sdk/go/v3/models/admin-review-reassign-reassign-to +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassignReassignTo', 'AdminReviewReassignReassignTo'] +--- + +# AdminReviewReassignReassignTo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity ID to which the review is being assigned. | [optional] +**Type** | Pointer to **string** | The type of the ID provided. | [optional] + +## Methods + +### NewAdminReviewReassignReassignTo + +`func NewAdminReviewReassignReassignTo() *AdminReviewReassignReassignTo` + +NewAdminReviewReassignReassignTo instantiates a new AdminReviewReassignReassignTo 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 + +### NewAdminReviewReassignReassignToWithDefaults + +`func NewAdminReviewReassignReassignToWithDefaults() *AdminReviewReassignReassignTo` + +NewAdminReviewReassignReassignToWithDefaults instantiates a new AdminReviewReassignReassignTo 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 + +### GetId + +`func (o *AdminReviewReassignReassignTo) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AdminReviewReassignReassignTo) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AdminReviewReassignReassignTo) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AdminReviewReassignReassignTo) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *AdminReviewReassignReassignTo) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AdminReviewReassignReassignTo) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AdminReviewReassignReassignTo) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AdminReviewReassignReassignTo) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AggregationResult.md b/docs/tools/sdk/go/Reference/V3/Models/AggregationResult.md new file mode 100644 index 000000000..9016b3526 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AggregationResult.md @@ -0,0 +1,90 @@ +--- +id: aggregation-result +title: AggregationResult +pagination_label: AggregationResult +sidebar_label: AggregationResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AggregationResult', 'AggregationResult'] +slug: /tools/sdk/go/v3/models/aggregation-result +tags: ['SDK', 'Software Development Kit', 'AggregationResult', 'AggregationResult'] +--- + +# AggregationResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Aggregations** | Pointer to **map[string]interface{}** | The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. | [optional] +**Hits** | Pointer to **[]map[string]interface{}** | The results of the aggregation search query. | [optional] + +## Methods + +### NewAggregationResult + +`func NewAggregationResult() *AggregationResult` + +NewAggregationResult instantiates a new AggregationResult 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 + +### NewAggregationResultWithDefaults + +`func NewAggregationResultWithDefaults() *AggregationResult` + +NewAggregationResultWithDefaults instantiates a new AggregationResult 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 + +### GetAggregations + +`func (o *AggregationResult) GetAggregations() map[string]interface{}` + +GetAggregations returns the Aggregations field if non-nil, zero value otherwise. + +### GetAggregationsOk + +`func (o *AggregationResult) GetAggregationsOk() (*map[string]interface{}, bool)` + +GetAggregationsOk returns a tuple with the Aggregations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregations + +`func (o *AggregationResult) SetAggregations(v map[string]interface{})` + +SetAggregations sets Aggregations field to given value. + +### HasAggregations + +`func (o *AggregationResult) HasAggregations() bool` + +HasAggregations returns a boolean if a field has been set. + +### GetHits + +`func (o *AggregationResult) GetHits() []map[string]interface{}` + +GetHits returns the Hits field if non-nil, zero value otherwise. + +### GetHitsOk + +`func (o *AggregationResult) GetHitsOk() (*[]map[string]interface{}, bool)` + +GetHitsOk returns a tuple with the Hits field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHits + +`func (o *AggregationResult) SetHits(v []map[string]interface{})` + +SetHits sets Hits field to given value. + +### HasHits + +`func (o *AggregationResult) HasHits() bool` + +HasHits returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AggregationType.md b/docs/tools/sdk/go/Reference/V3/Models/AggregationType.md new file mode 100644 index 000000000..10c194b75 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AggregationType.md @@ -0,0 +1,21 @@ +--- +id: aggregation-type +title: AggregationType +pagination_label: AggregationType +sidebar_label: AggregationType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AggregationType', 'AggregationType'] +slug: /tools/sdk/go/v3/models/aggregation-type +tags: ['SDK', 'Software Development Kit', 'AggregationType', 'AggregationType'] +--- + +# AggregationType + +## Enum + + +* `DSL` (value: `"DSL"`) + +* `SAILPOINT` (value: `"SAILPOINT"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Aggregations.md b/docs/tools/sdk/go/Reference/V3/Models/Aggregations.md new file mode 100644 index 000000000..88dfb7d67 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Aggregations.md @@ -0,0 +1,142 @@ +--- +id: aggregations +title: Aggregations +pagination_label: Aggregations +sidebar_label: Aggregations +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Aggregations', 'Aggregations'] +slug: /tools/sdk/go/v3/models/aggregations +tags: ['SDK', 'Software Development Kit', 'Aggregations', 'Aggregations'] +--- + +# Aggregations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional] +**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional] +**Filter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional] +**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional] + +## Methods + +### NewAggregations + +`func NewAggregations() *Aggregations` + +NewAggregations instantiates a new Aggregations 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 + +### NewAggregationsWithDefaults + +`func NewAggregationsWithDefaults() *Aggregations` + +NewAggregationsWithDefaults instantiates a new Aggregations 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 + +### GetNested + +`func (o *Aggregations) GetNested() NestedAggregation` + +GetNested returns the Nested field if non-nil, zero value otherwise. + +### GetNestedOk + +`func (o *Aggregations) GetNestedOk() (*NestedAggregation, bool)` + +GetNestedOk returns a tuple with the Nested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNested + +`func (o *Aggregations) SetNested(v NestedAggregation)` + +SetNested sets Nested field to given value. + +### HasNested + +`func (o *Aggregations) HasNested() bool` + +HasNested returns a boolean if a field has been set. + +### GetMetric + +`func (o *Aggregations) GetMetric() MetricAggregation` + +GetMetric returns the Metric field if non-nil, zero value otherwise. + +### GetMetricOk + +`func (o *Aggregations) GetMetricOk() (*MetricAggregation, bool)` + +GetMetricOk returns a tuple with the Metric field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetric + +`func (o *Aggregations) SetMetric(v MetricAggregation)` + +SetMetric sets Metric field to given value. + +### HasMetric + +`func (o *Aggregations) HasMetric() bool` + +HasMetric returns a boolean if a field has been set. + +### GetFilter + +`func (o *Aggregations) GetFilter() FilterAggregation` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *Aggregations) GetFilterOk() (*FilterAggregation, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *Aggregations) SetFilter(v FilterAggregation)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *Aggregations) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### GetBucket + +`func (o *Aggregations) GetBucket() BucketAggregation` + +GetBucket returns the Bucket field if non-nil, zero value otherwise. + +### GetBucketOk + +`func (o *Aggregations) GetBucketOk() (*BucketAggregation, bool)` + +GetBucketOk returns a tuple with the Bucket field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBucket + +`func (o *Aggregations) SetBucket(v BucketAggregation)` + +SetBucket sets Bucket field to given value. + +### HasBucket + +`func (o *Aggregations) HasBucket() bool` + +HasBucket returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/App.md b/docs/tools/sdk/go/Reference/V3/Models/App.md new file mode 100644 index 000000000..2546a2aa7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/App.md @@ -0,0 +1,142 @@ +--- +id: app +title: App +pagination_label: App +sidebar_label: App +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'App', 'App'] +slug: /tools/sdk/go/v3/models/app +tags: ['SDK', 'Software Development Kit', 'App', 'App'] +--- + +# App + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**Source** | Pointer to [**Reference**](reference) | | [optional] +**Account** | Pointer to [**AppAllOfAccount**](app-all-of-account) | | [optional] + +## Methods + +### NewApp + +`func NewApp() *App` + +NewApp instantiates a new App 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 + +### NewAppWithDefaults + +`func NewAppWithDefaults() *App` + +NewAppWithDefaults instantiates a new App 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 + +### GetId + +`func (o *App) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *App) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *App) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *App) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *App) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *App) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *App) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *App) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSource + +`func (o *App) GetSource() Reference` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *App) GetSourceOk() (*Reference, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *App) SetSource(v Reference)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *App) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAccount + +`func (o *App) GetAccount() AppAllOfAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *App) GetAccountOk() (*AppAllOfAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *App) SetAccount(v AppAllOfAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *App) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AppAllOfAccount.md b/docs/tools/sdk/go/Reference/V3/Models/AppAllOfAccount.md new file mode 100644 index 000000000..1ecfced03 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AppAllOfAccount.md @@ -0,0 +1,90 @@ +--- +id: app-all-of-account +title: AppAllOfAccount +pagination_label: AppAllOfAccount +sidebar_label: AppAllOfAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AppAllOfAccount', 'AppAllOfAccount'] +slug: /tools/sdk/go/v3/models/app-all-of-account +tags: ['SDK', 'Software Development Kit', 'AppAllOfAccount', 'AppAllOfAccount'] +--- + +# AppAllOfAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The SailPoint generated unique ID | [optional] +**AccountId** | Pointer to **string** | The account ID generated by the source | [optional] + +## Methods + +### NewAppAllOfAccount + +`func NewAppAllOfAccount() *AppAllOfAccount` + +NewAppAllOfAccount instantiates a new AppAllOfAccount 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 + +### NewAppAllOfAccountWithDefaults + +`func NewAppAllOfAccountWithDefaults() *AppAllOfAccount` + +NewAppAllOfAccountWithDefaults instantiates a new AppAllOfAccount 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 + +### GetId + +`func (o *AppAllOfAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AppAllOfAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AppAllOfAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AppAllOfAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccountId + +`func (o *AppAllOfAccount) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *AppAllOfAccount) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *AppAllOfAccount) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *AppAllOfAccount) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Approval.md b/docs/tools/sdk/go/Reference/V3/Models/Approval.md new file mode 100644 index 000000000..7d998d64f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Approval.md @@ -0,0 +1,204 @@ +--- +id: approval +title: Approval +pagination_label: Approval +sidebar_label: Approval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Approval', 'Approval'] +slug: /tools/sdk/go/v3/models/approval +tags: ['SDK', 'Software Development Kit', 'Approval', 'Approval'] +--- + +# Approval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comments** | Pointer to [**[]ApprovalComment**](approval-comment) | | [optional] +**Modified** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Owner** | Pointer to [**ActivityIdentity**](activity-identity) | | [optional] +**Result** | Pointer to **string** | The result of the approval | [optional] +**AttributeRequest** | Pointer to [**AttributeRequest**](attribute-request) | | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] + +## Methods + +### NewApproval + +`func NewApproval() *Approval` + +NewApproval instantiates a new Approval 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 + +### NewApprovalWithDefaults + +`func NewApprovalWithDefaults() *Approval` + +NewApprovalWithDefaults instantiates a new Approval 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 + +### GetComments + +`func (o *Approval) GetComments() []ApprovalComment` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *Approval) GetCommentsOk() (*[]ApprovalComment, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *Approval) SetComments(v []ApprovalComment)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *Approval) HasComments() bool` + +HasComments returns a boolean if a field has been set. + +### GetModified + +`func (o *Approval) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Approval) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Approval) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Approval) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *Approval) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *Approval) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetOwner + +`func (o *Approval) GetOwner() ActivityIdentity` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Approval) GetOwnerOk() (*ActivityIdentity, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Approval) SetOwner(v ActivityIdentity)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *Approval) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetResult + +`func (o *Approval) GetResult() string` + +GetResult returns the Result field if non-nil, zero value otherwise. + +### GetResultOk + +`func (o *Approval) GetResultOk() (*string, bool)` + +GetResultOk returns a tuple with the Result field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResult + +`func (o *Approval) SetResult(v string)` + +SetResult sets Result field to given value. + +### HasResult + +`func (o *Approval) HasResult() bool` + +HasResult returns a boolean if a field has been set. + +### GetAttributeRequest + +`func (o *Approval) GetAttributeRequest() AttributeRequest` + +GetAttributeRequest returns the AttributeRequest field if non-nil, zero value otherwise. + +### GetAttributeRequestOk + +`func (o *Approval) GetAttributeRequestOk() (*AttributeRequest, bool)` + +GetAttributeRequestOk returns a tuple with the AttributeRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeRequest + +`func (o *Approval) SetAttributeRequest(v AttributeRequest)` + +SetAttributeRequest sets AttributeRequest field to given value. + +### HasAttributeRequest + +`func (o *Approval) HasAttributeRequest() bool` + +HasAttributeRequest returns a boolean if a field has been set. + +### GetSource + +`func (o *Approval) GetSource() AccountSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *Approval) GetSourceOk() (*AccountSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *Approval) SetSource(v AccountSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *Approval) HasSource() bool` + +HasSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ApprovalComment.md b/docs/tools/sdk/go/Reference/V3/Models/ApprovalComment.md new file mode 100644 index 000000000..cc52e8a7f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ApprovalComment.md @@ -0,0 +1,126 @@ +--- +id: approval-comment +title: ApprovalComment +pagination_label: ApprovalComment +sidebar_label: ApprovalComment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalComment', 'ApprovalComment'] +slug: /tools/sdk/go/v3/models/approval-comment +tags: ['SDK', 'Software Development Kit', 'ApprovalComment', 'ApprovalComment'] +--- + +# ApprovalComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | The comment text | [optional] +**Commenter** | Pointer to **string** | The name of the commenter | [optional] +**Date** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] + +## Methods + +### NewApprovalComment + +`func NewApprovalComment() *ApprovalComment` + +NewApprovalComment instantiates a new ApprovalComment 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 + +### NewApprovalCommentWithDefaults + +`func NewApprovalCommentWithDefaults() *ApprovalComment` + +NewApprovalCommentWithDefaults instantiates a new ApprovalComment 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 + +### GetComment + +`func (o *ApprovalComment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ApprovalComment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ApprovalComment) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ApprovalComment) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetCommenter + +`func (o *ApprovalComment) GetCommenter() string` + +GetCommenter returns the Commenter field if non-nil, zero value otherwise. + +### GetCommenterOk + +`func (o *ApprovalComment) GetCommenterOk() (*string, bool)` + +GetCommenterOk returns a tuple with the Commenter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommenter + +`func (o *ApprovalComment) SetCommenter(v string)` + +SetCommenter sets Commenter field to given value. + +### HasCommenter + +`func (o *ApprovalComment) HasCommenter() bool` + +HasCommenter returns a boolean if a field has been set. + +### GetDate + +`func (o *ApprovalComment) GetDate() SailPointTime` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *ApprovalComment) GetDateOk() (*SailPointTime, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *ApprovalComment) SetDate(v SailPointTime)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *ApprovalComment) HasDate() bool` + +HasDate returns a boolean if a field has been set. + +### SetDateNil + +`func (o *ApprovalComment) SetDateNil(b bool)` + + SetDateNil sets the value for Date to be an explicit nil + +### UnsetDate +`func (o *ApprovalComment) UnsetDate()` + +UnsetDate ensures that no value is present for Date, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ApprovalForwardHistory.md b/docs/tools/sdk/go/Reference/V3/Models/ApprovalForwardHistory.md new file mode 100644 index 000000000..a15b152cf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ApprovalForwardHistory.md @@ -0,0 +1,214 @@ +--- +id: approval-forward-history +title: ApprovalForwardHistory +pagination_label: ApprovalForwardHistory +sidebar_label: ApprovalForwardHistory +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalForwardHistory', 'ApprovalForwardHistory'] +slug: /tools/sdk/go/v3/models/approval-forward-history +tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory', 'ApprovalForwardHistory'] +--- + +# ApprovalForwardHistory + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OldApproverName** | Pointer to **string** | Display name of approver from whom the approval was forwarded. | [optional] +**NewApproverName** | Pointer to **string** | Display name of approver to whom the approval was forwarded. | [optional] +**Comment** | Pointer to **NullableString** | Comment made while forwarding. | [optional] +**Modified** | Pointer to **SailPointTime** | Time at which approval was forwarded. | [optional] +**ForwarderName** | Pointer to **NullableString** | Display name of forwarder who forwarded the approval. | [optional] +**ReassignmentType** | Pointer to [**ReassignmentType**](reassignment-type) | | [optional] + +## Methods + +### NewApprovalForwardHistory + +`func NewApprovalForwardHistory() *ApprovalForwardHistory` + +NewApprovalForwardHistory instantiates a new ApprovalForwardHistory 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 + +### NewApprovalForwardHistoryWithDefaults + +`func NewApprovalForwardHistoryWithDefaults() *ApprovalForwardHistory` + +NewApprovalForwardHistoryWithDefaults instantiates a new ApprovalForwardHistory 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 + +### GetOldApproverName + +`func (o *ApprovalForwardHistory) GetOldApproverName() string` + +GetOldApproverName returns the OldApproverName field if non-nil, zero value otherwise. + +### GetOldApproverNameOk + +`func (o *ApprovalForwardHistory) GetOldApproverNameOk() (*string, bool)` + +GetOldApproverNameOk returns a tuple with the OldApproverName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOldApproverName + +`func (o *ApprovalForwardHistory) SetOldApproverName(v string)` + +SetOldApproverName sets OldApproverName field to given value. + +### HasOldApproverName + +`func (o *ApprovalForwardHistory) HasOldApproverName() bool` + +HasOldApproverName returns a boolean if a field has been set. + +### GetNewApproverName + +`func (o *ApprovalForwardHistory) GetNewApproverName() string` + +GetNewApproverName returns the NewApproverName field if non-nil, zero value otherwise. + +### GetNewApproverNameOk + +`func (o *ApprovalForwardHistory) GetNewApproverNameOk() (*string, bool)` + +GetNewApproverNameOk returns a tuple with the NewApproverName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewApproverName + +`func (o *ApprovalForwardHistory) SetNewApproverName(v string)` + +SetNewApproverName sets NewApproverName field to given value. + +### HasNewApproverName + +`func (o *ApprovalForwardHistory) HasNewApproverName() bool` + +HasNewApproverName returns a boolean if a field has been set. + +### GetComment + +`func (o *ApprovalForwardHistory) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ApprovalForwardHistory) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ApprovalForwardHistory) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ApprovalForwardHistory) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *ApprovalForwardHistory) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *ApprovalForwardHistory) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetModified + +`func (o *ApprovalForwardHistory) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ApprovalForwardHistory) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ApprovalForwardHistory) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ApprovalForwardHistory) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetForwarderName + +`func (o *ApprovalForwardHistory) GetForwarderName() string` + +GetForwarderName returns the ForwarderName field if non-nil, zero value otherwise. + +### GetForwarderNameOk + +`func (o *ApprovalForwardHistory) GetForwarderNameOk() (*string, bool)` + +GetForwarderNameOk returns a tuple with the ForwarderName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwarderName + +`func (o *ApprovalForwardHistory) SetForwarderName(v string)` + +SetForwarderName sets ForwarderName field to given value. + +### HasForwarderName + +`func (o *ApprovalForwardHistory) HasForwarderName() bool` + +HasForwarderName returns a boolean if a field has been set. + +### SetForwarderNameNil + +`func (o *ApprovalForwardHistory) SetForwarderNameNil(b bool)` + + SetForwarderNameNil sets the value for ForwarderName to be an explicit nil + +### UnsetForwarderName +`func (o *ApprovalForwardHistory) UnsetForwarderName()` + +UnsetForwarderName ensures that no value is present for ForwarderName, not even an explicit nil +### GetReassignmentType + +`func (o *ApprovalForwardHistory) GetReassignmentType() ReassignmentType` + +GetReassignmentType returns the ReassignmentType field if non-nil, zero value otherwise. + +### GetReassignmentTypeOk + +`func (o *ApprovalForwardHistory) GetReassignmentTypeOk() (*ReassignmentType, bool)` + +GetReassignmentTypeOk returns a tuple with the ReassignmentType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignmentType + +`func (o *ApprovalForwardHistory) SetReassignmentType(v ReassignmentType)` + +SetReassignmentType sets ReassignmentType field to given value. + +### HasReassignmentType + +`func (o *ApprovalForwardHistory) HasReassignmentType() bool` + +HasReassignmentType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ApprovalItemDetails.md b/docs/tools/sdk/go/Reference/V3/Models/ApprovalItemDetails.md new file mode 100644 index 000000000..d1bf691fb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ApprovalItemDetails.md @@ -0,0 +1,250 @@ +--- +id: approval-item-details +title: ApprovalItemDetails +pagination_label: ApprovalItemDetails +sidebar_label: ApprovalItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalItemDetails', 'ApprovalItemDetails'] +slug: /tools/sdk/go/v3/models/approval-item-details +tags: ['SDK', 'Software Development Kit', 'ApprovalItemDetails', 'ApprovalItemDetails'] +--- + +# ApprovalItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The approval item's ID | [optional] +**Account** | Pointer to **NullableString** | The account referenced by the approval item | [optional] +**Application** | Pointer to **string** | The name of the application/source | [optional] +**Name** | Pointer to **NullableString** | The attribute's name | [optional] +**Operation** | Pointer to **string** | The attribute's operation | [optional] +**Value** | Pointer to **NullableString** | The attribute's value | [optional] +**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional] + +## Methods + +### NewApprovalItemDetails + +`func NewApprovalItemDetails() *ApprovalItemDetails` + +NewApprovalItemDetails instantiates a new ApprovalItemDetails 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 + +### NewApprovalItemDetailsWithDefaults + +`func NewApprovalItemDetailsWithDefaults() *ApprovalItemDetails` + +NewApprovalItemDetailsWithDefaults instantiates a new ApprovalItemDetails 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 + +### GetId + +`func (o *ApprovalItemDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalItemDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalItemDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalItemDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccount + +`func (o *ApprovalItemDetails) GetAccount() string` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *ApprovalItemDetails) GetAccountOk() (*string, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *ApprovalItemDetails) SetAccount(v string)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *ApprovalItemDetails) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### SetAccountNil + +`func (o *ApprovalItemDetails) SetAccountNil(b bool)` + + SetAccountNil sets the value for Account to be an explicit nil + +### UnsetAccount +`func (o *ApprovalItemDetails) UnsetAccount()` + +UnsetAccount ensures that no value is present for Account, not even an explicit nil +### GetApplication + +`func (o *ApprovalItemDetails) GetApplication() string` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *ApprovalItemDetails) GetApplicationOk() (*string, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *ApprovalItemDetails) SetApplication(v string)` + +SetApplication sets Application field to given value. + +### HasApplication + +`func (o *ApprovalItemDetails) HasApplication() bool` + +HasApplication returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalItemDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalItemDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalItemDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalItemDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ApprovalItemDetails) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ApprovalItemDetails) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetOperation + +`func (o *ApprovalItemDetails) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ApprovalItemDetails) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ApprovalItemDetails) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ApprovalItemDetails) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetValue + +`func (o *ApprovalItemDetails) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ApprovalItemDetails) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ApprovalItemDetails) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ApprovalItemDetails) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ApprovalItemDetails) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ApprovalItemDetails) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetState + +`func (o *ApprovalItemDetails) GetState() WorkItemState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ApprovalItemDetails) GetStateOk() (*WorkItemState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ApprovalItemDetails) SetState(v WorkItemState)` + +SetState sets State field to given value. + +### HasState + +`func (o *ApprovalItemDetails) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ApprovalItems.md b/docs/tools/sdk/go/Reference/V3/Models/ApprovalItems.md new file mode 100644 index 000000000..33d76bcaa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ApprovalItems.md @@ -0,0 +1,250 @@ +--- +id: approval-items +title: ApprovalItems +pagination_label: ApprovalItems +sidebar_label: ApprovalItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalItems', 'ApprovalItems'] +slug: /tools/sdk/go/v3/models/approval-items +tags: ['SDK', 'Software Development Kit', 'ApprovalItems', 'ApprovalItems'] +--- + +# ApprovalItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The approval item's ID | [optional] +**Account** | Pointer to **NullableString** | The account referenced by the approval item | [optional] +**Application** | Pointer to **string** | The name of the application/source | [optional] +**Name** | Pointer to **NullableString** | The attribute's name | [optional] +**Operation** | Pointer to **string** | The attribute's operation | [optional] +**Value** | Pointer to **NullableString** | The attribute's value | [optional] +**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional] + +## Methods + +### NewApprovalItems + +`func NewApprovalItems() *ApprovalItems` + +NewApprovalItems instantiates a new ApprovalItems 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 + +### NewApprovalItemsWithDefaults + +`func NewApprovalItemsWithDefaults() *ApprovalItems` + +NewApprovalItemsWithDefaults instantiates a new ApprovalItems 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 + +### GetId + +`func (o *ApprovalItems) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalItems) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalItems) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalItems) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccount + +`func (o *ApprovalItems) GetAccount() string` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *ApprovalItems) GetAccountOk() (*string, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *ApprovalItems) SetAccount(v string)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *ApprovalItems) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### SetAccountNil + +`func (o *ApprovalItems) SetAccountNil(b bool)` + + SetAccountNil sets the value for Account to be an explicit nil + +### UnsetAccount +`func (o *ApprovalItems) UnsetAccount()` + +UnsetAccount ensures that no value is present for Account, not even an explicit nil +### GetApplication + +`func (o *ApprovalItems) GetApplication() string` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *ApprovalItems) GetApplicationOk() (*string, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *ApprovalItems) SetApplication(v string)` + +SetApplication sets Application field to given value. + +### HasApplication + +`func (o *ApprovalItems) HasApplication() bool` + +HasApplication returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalItems) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalItems) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalItems) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalItems) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ApprovalItems) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ApprovalItems) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetOperation + +`func (o *ApprovalItems) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ApprovalItems) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ApprovalItems) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ApprovalItems) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetValue + +`func (o *ApprovalItems) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ApprovalItems) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ApprovalItems) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ApprovalItems) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ApprovalItems) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ApprovalItems) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetState + +`func (o *ApprovalItems) GetState() WorkItemState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ApprovalItems) GetStateOk() (*WorkItemState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ApprovalItems) SetState(v WorkItemState)` + +SetState sets State field to given value. + +### HasState + +`func (o *ApprovalItems) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ApprovalReminderAndEscalationConfig.md b/docs/tools/sdk/go/Reference/V3/Models/ApprovalReminderAndEscalationConfig.md new file mode 100644 index 000000000..787fba438 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ApprovalReminderAndEscalationConfig.md @@ -0,0 +1,182 @@ +--- +id: approval-reminder-and-escalation-config +title: ApprovalReminderAndEscalationConfig +pagination_label: ApprovalReminderAndEscalationConfig +sidebar_label: ApprovalReminderAndEscalationConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalReminderAndEscalationConfig', 'ApprovalReminderAndEscalationConfig'] +slug: /tools/sdk/go/v3/models/approval-reminder-and-escalation-config +tags: ['SDK', 'Software Development Kit', 'ApprovalReminderAndEscalationConfig', 'ApprovalReminderAndEscalationConfig'] +--- + +# ApprovalReminderAndEscalationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DaysUntilEscalation** | Pointer to **NullableInt32** | Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. | [optional] +**DaysBetweenReminders** | Pointer to **NullableInt32** | Number of days to wait between reminder notifications. | [optional] +**MaxReminders** | Pointer to **NullableInt32** | Maximum number of reminder notification to send to the reviewer before approval escalation. | [optional] +**FallbackApproverRef** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] + +## Methods + +### NewApprovalReminderAndEscalationConfig + +`func NewApprovalReminderAndEscalationConfig() *ApprovalReminderAndEscalationConfig` + +NewApprovalReminderAndEscalationConfig instantiates a new ApprovalReminderAndEscalationConfig 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 + +### NewApprovalReminderAndEscalationConfigWithDefaults + +`func NewApprovalReminderAndEscalationConfigWithDefaults() *ApprovalReminderAndEscalationConfig` + +NewApprovalReminderAndEscalationConfigWithDefaults instantiates a new ApprovalReminderAndEscalationConfig 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 + +### GetDaysUntilEscalation + +`func (o *ApprovalReminderAndEscalationConfig) GetDaysUntilEscalation() int32` + +GetDaysUntilEscalation returns the DaysUntilEscalation field if non-nil, zero value otherwise. + +### GetDaysUntilEscalationOk + +`func (o *ApprovalReminderAndEscalationConfig) GetDaysUntilEscalationOk() (*int32, bool)` + +GetDaysUntilEscalationOk returns a tuple with the DaysUntilEscalation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDaysUntilEscalation + +`func (o *ApprovalReminderAndEscalationConfig) SetDaysUntilEscalation(v int32)` + +SetDaysUntilEscalation sets DaysUntilEscalation field to given value. + +### HasDaysUntilEscalation + +`func (o *ApprovalReminderAndEscalationConfig) HasDaysUntilEscalation() bool` + +HasDaysUntilEscalation returns a boolean if a field has been set. + +### SetDaysUntilEscalationNil + +`func (o *ApprovalReminderAndEscalationConfig) SetDaysUntilEscalationNil(b bool)` + + SetDaysUntilEscalationNil sets the value for DaysUntilEscalation to be an explicit nil + +### UnsetDaysUntilEscalation +`func (o *ApprovalReminderAndEscalationConfig) UnsetDaysUntilEscalation()` + +UnsetDaysUntilEscalation ensures that no value is present for DaysUntilEscalation, not even an explicit nil +### GetDaysBetweenReminders + +`func (o *ApprovalReminderAndEscalationConfig) GetDaysBetweenReminders() int32` + +GetDaysBetweenReminders returns the DaysBetweenReminders field if non-nil, zero value otherwise. + +### GetDaysBetweenRemindersOk + +`func (o *ApprovalReminderAndEscalationConfig) GetDaysBetweenRemindersOk() (*int32, bool)` + +GetDaysBetweenRemindersOk returns a tuple with the DaysBetweenReminders field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDaysBetweenReminders + +`func (o *ApprovalReminderAndEscalationConfig) SetDaysBetweenReminders(v int32)` + +SetDaysBetweenReminders sets DaysBetweenReminders field to given value. + +### HasDaysBetweenReminders + +`func (o *ApprovalReminderAndEscalationConfig) HasDaysBetweenReminders() bool` + +HasDaysBetweenReminders returns a boolean if a field has been set. + +### SetDaysBetweenRemindersNil + +`func (o *ApprovalReminderAndEscalationConfig) SetDaysBetweenRemindersNil(b bool)` + + SetDaysBetweenRemindersNil sets the value for DaysBetweenReminders to be an explicit nil + +### UnsetDaysBetweenReminders +`func (o *ApprovalReminderAndEscalationConfig) UnsetDaysBetweenReminders()` + +UnsetDaysBetweenReminders ensures that no value is present for DaysBetweenReminders, not even an explicit nil +### GetMaxReminders + +`func (o *ApprovalReminderAndEscalationConfig) GetMaxReminders() int32` + +GetMaxReminders returns the MaxReminders field if non-nil, zero value otherwise. + +### GetMaxRemindersOk + +`func (o *ApprovalReminderAndEscalationConfig) GetMaxRemindersOk() (*int32, bool)` + +GetMaxRemindersOk returns a tuple with the MaxReminders field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxReminders + +`func (o *ApprovalReminderAndEscalationConfig) SetMaxReminders(v int32)` + +SetMaxReminders sets MaxReminders field to given value. + +### HasMaxReminders + +`func (o *ApprovalReminderAndEscalationConfig) HasMaxReminders() bool` + +HasMaxReminders returns a boolean if a field has been set. + +### SetMaxRemindersNil + +`func (o *ApprovalReminderAndEscalationConfig) SetMaxRemindersNil(b bool)` + + SetMaxRemindersNil sets the value for MaxReminders to be an explicit nil + +### UnsetMaxReminders +`func (o *ApprovalReminderAndEscalationConfig) UnsetMaxReminders()` + +UnsetMaxReminders ensures that no value is present for MaxReminders, not even an explicit nil +### GetFallbackApproverRef + +`func (o *ApprovalReminderAndEscalationConfig) GetFallbackApproverRef() IdentityReferenceWithNameAndEmail` + +GetFallbackApproverRef returns the FallbackApproverRef field if non-nil, zero value otherwise. + +### GetFallbackApproverRefOk + +`func (o *ApprovalReminderAndEscalationConfig) GetFallbackApproverRefOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetFallbackApproverRefOk returns a tuple with the FallbackApproverRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFallbackApproverRef + +`func (o *ApprovalReminderAndEscalationConfig) SetFallbackApproverRef(v IdentityReferenceWithNameAndEmail)` + +SetFallbackApproverRef sets FallbackApproverRef field to given value. + +### HasFallbackApproverRef + +`func (o *ApprovalReminderAndEscalationConfig) HasFallbackApproverRef() bool` + +HasFallbackApproverRef returns a boolean if a field has been set. + +### SetFallbackApproverRefNil + +`func (o *ApprovalReminderAndEscalationConfig) SetFallbackApproverRefNil(b bool)` + + SetFallbackApproverRefNil sets the value for FallbackApproverRef to be an explicit nil + +### UnsetFallbackApproverRef +`func (o *ApprovalReminderAndEscalationConfig) UnsetFallbackApproverRef()` + +UnsetFallbackApproverRef ensures that no value is present for FallbackApproverRef, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ApprovalScheme.md b/docs/tools/sdk/go/Reference/V3/Models/ApprovalScheme.md new file mode 100644 index 000000000..fad32a2bc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ApprovalScheme.md @@ -0,0 +1,31 @@ +--- +id: approval-scheme +title: ApprovalScheme +pagination_label: ApprovalScheme +sidebar_label: ApprovalScheme +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalScheme', 'ApprovalScheme'] +slug: /tools/sdk/go/v3/models/approval-scheme +tags: ['SDK', 'Software Development Kit', 'ApprovalScheme', 'ApprovalScheme'] +--- + +# ApprovalScheme + +## Enum + + +* `APP_OWNER` (value: `"APP_OWNER"`) + +* `SOURCE_OWNER` (value: `"SOURCE_OWNER"`) + +* `MANAGER` (value: `"MANAGER"`) + +* `ROLE_OWNER` (value: `"ROLE_OWNER"`) + +* `ACCESS_PROFILE_OWNER` (value: `"ACCESS_PROFILE_OWNER"`) + +* `ENTITLEMENT_OWNER` (value: `"ENTITLEMENT_OWNER"`) + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ApprovalSchemeForRole.md b/docs/tools/sdk/go/Reference/V3/Models/ApprovalSchemeForRole.md new file mode 100644 index 000000000..1a912aa1a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ApprovalSchemeForRole.md @@ -0,0 +1,100 @@ +--- +id: approval-scheme-for-role +title: ApprovalSchemeForRole +pagination_label: ApprovalSchemeForRole +sidebar_label: ApprovalSchemeForRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalSchemeForRole', 'ApprovalSchemeForRole'] +slug: /tools/sdk/go/v3/models/approval-scheme-for-role +tags: ['SDK', 'Software Development Kit', 'ApprovalSchemeForRole', 'ApprovalSchemeForRole'] +--- + +# ApprovalSchemeForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApproverType** | Pointer to **string** | Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | Pointer to **NullableString** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] + +## Methods + +### NewApprovalSchemeForRole + +`func NewApprovalSchemeForRole() *ApprovalSchemeForRole` + +NewApprovalSchemeForRole instantiates a new ApprovalSchemeForRole 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 + +### NewApprovalSchemeForRoleWithDefaults + +`func NewApprovalSchemeForRoleWithDefaults() *ApprovalSchemeForRole` + +NewApprovalSchemeForRoleWithDefaults instantiates a new ApprovalSchemeForRole 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 + +### GetApproverType + +`func (o *ApprovalSchemeForRole) GetApproverType() string` + +GetApproverType returns the ApproverType field if non-nil, zero value otherwise. + +### GetApproverTypeOk + +`func (o *ApprovalSchemeForRole) GetApproverTypeOk() (*string, bool)` + +GetApproverTypeOk returns a tuple with the ApproverType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverType + +`func (o *ApprovalSchemeForRole) SetApproverType(v string)` + +SetApproverType sets ApproverType field to given value. + +### HasApproverType + +`func (o *ApprovalSchemeForRole) HasApproverType() bool` + +HasApproverType returns a boolean if a field has been set. + +### GetApproverId + +`func (o *ApprovalSchemeForRole) GetApproverId() string` + +GetApproverId returns the ApproverId field if non-nil, zero value otherwise. + +### GetApproverIdOk + +`func (o *ApprovalSchemeForRole) GetApproverIdOk() (*string, bool)` + +GetApproverIdOk returns a tuple with the ApproverId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproverId + +`func (o *ApprovalSchemeForRole) SetApproverId(v string)` + +SetApproverId sets ApproverId field to given value. + +### HasApproverId + +`func (o *ApprovalSchemeForRole) HasApproverId() bool` + +HasApproverId returns a boolean if a field has been set. + +### SetApproverIdNil + +`func (o *ApprovalSchemeForRole) SetApproverIdNil(b bool)` + + SetApproverIdNil sets the value for ApproverId to be an explicit nil + +### UnsetApproverId +`func (o *ApprovalSchemeForRole) UnsetApproverId()` + +UnsetApproverId ensures that no value is present for ApproverId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ApprovalStatus.md b/docs/tools/sdk/go/Reference/V3/Models/ApprovalStatus.md new file mode 100644 index 000000000..69a37e7ff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ApprovalStatus.md @@ -0,0 +1,27 @@ +--- +id: approval-status +title: ApprovalStatus +pagination_label: ApprovalStatus +sidebar_label: ApprovalStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalStatus', 'ApprovalStatus'] +slug: /tools/sdk/go/v3/models/approval-status +tags: ['SDK', 'Software Development Kit', 'ApprovalStatus', 'ApprovalStatus'] +--- + +# ApprovalStatus + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `PENDING` (value: `"PENDING"`) + +* `NOT_READY` (value: `"NOT_READY"`) + +* `CANCELLED` (value: `"CANCELLED"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ApprovalStatusDto.md b/docs/tools/sdk/go/Reference/V3/Models/ApprovalStatusDto.md new file mode 100644 index 000000000..6634339ec --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ApprovalStatusDto.md @@ -0,0 +1,348 @@ +--- +id: approval-status-dto +title: ApprovalStatusDto +pagination_label: ApprovalStatusDto +sidebar_label: ApprovalStatusDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalStatusDto', 'ApprovalStatusDto'] +slug: /tools/sdk/go/v3/models/approval-status-dto +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto', 'ApprovalStatusDto'] +--- + +# ApprovalStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalId** | Pointer to **NullableString** | Unique identifier for the approval. | [optional] +**Forwarded** | Pointer to **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to false] +**OriginalOwner** | Pointer to [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional] +**CurrentOwner** | Pointer to [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional] +**Modified** | Pointer to **NullableTime** | Time at which item was modified. | [optional] +**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**Scheme** | Pointer to [**ApprovalScheme**](approval-scheme) | | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | If the request failed, includes any error messages that were generated. | [optional] +**Comment** | Pointer to **NullableString** | Comment, if any, provided by the approver. | [optional] +**RemoveDate** | Pointer to **NullableTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] + +## Methods + +### NewApprovalStatusDto + +`func NewApprovalStatusDto() *ApprovalStatusDto` + +NewApprovalStatusDto instantiates a new ApprovalStatusDto 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 + +### NewApprovalStatusDtoWithDefaults + +`func NewApprovalStatusDtoWithDefaults() *ApprovalStatusDto` + +NewApprovalStatusDtoWithDefaults instantiates a new ApprovalStatusDto 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 + +### GetApprovalId + +`func (o *ApprovalStatusDto) GetApprovalId() string` + +GetApprovalId returns the ApprovalId field if non-nil, zero value otherwise. + +### GetApprovalIdOk + +`func (o *ApprovalStatusDto) GetApprovalIdOk() (*string, bool)` + +GetApprovalIdOk returns a tuple with the ApprovalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalId + +`func (o *ApprovalStatusDto) SetApprovalId(v string)` + +SetApprovalId sets ApprovalId field to given value. + +### HasApprovalId + +`func (o *ApprovalStatusDto) HasApprovalId() bool` + +HasApprovalId returns a boolean if a field has been set. + +### SetApprovalIdNil + +`func (o *ApprovalStatusDto) SetApprovalIdNil(b bool)` + + SetApprovalIdNil sets the value for ApprovalId to be an explicit nil + +### UnsetApprovalId +`func (o *ApprovalStatusDto) UnsetApprovalId()` + +UnsetApprovalId ensures that no value is present for ApprovalId, not even an explicit nil +### GetForwarded + +`func (o *ApprovalStatusDto) GetForwarded() bool` + +GetForwarded returns the Forwarded field if non-nil, zero value otherwise. + +### GetForwardedOk + +`func (o *ApprovalStatusDto) GetForwardedOk() (*bool, bool)` + +GetForwardedOk returns a tuple with the Forwarded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwarded + +`func (o *ApprovalStatusDto) SetForwarded(v bool)` + +SetForwarded sets Forwarded field to given value. + +### HasForwarded + +`func (o *ApprovalStatusDto) HasForwarded() bool` + +HasForwarded returns a boolean if a field has been set. + +### GetOriginalOwner + +`func (o *ApprovalStatusDto) GetOriginalOwner() ApprovalStatusDtoOriginalOwner` + +GetOriginalOwner returns the OriginalOwner field if non-nil, zero value otherwise. + +### GetOriginalOwnerOk + +`func (o *ApprovalStatusDto) GetOriginalOwnerOk() (*ApprovalStatusDtoOriginalOwner, bool)` + +GetOriginalOwnerOk returns a tuple with the OriginalOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalOwner + +`func (o *ApprovalStatusDto) SetOriginalOwner(v ApprovalStatusDtoOriginalOwner)` + +SetOriginalOwner sets OriginalOwner field to given value. + +### HasOriginalOwner + +`func (o *ApprovalStatusDto) HasOriginalOwner() bool` + +HasOriginalOwner returns a boolean if a field has been set. + +### GetCurrentOwner + +`func (o *ApprovalStatusDto) GetCurrentOwner() ApprovalStatusDtoCurrentOwner` + +GetCurrentOwner returns the CurrentOwner field if non-nil, zero value otherwise. + +### GetCurrentOwnerOk + +`func (o *ApprovalStatusDto) GetCurrentOwnerOk() (*ApprovalStatusDtoCurrentOwner, bool)` + +GetCurrentOwnerOk returns a tuple with the CurrentOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentOwner + +`func (o *ApprovalStatusDto) SetCurrentOwner(v ApprovalStatusDtoCurrentOwner)` + +SetCurrentOwner sets CurrentOwner field to given value. + +### HasCurrentOwner + +`func (o *ApprovalStatusDto) HasCurrentOwner() bool` + +HasCurrentOwner returns a boolean if a field has been set. + +### GetModified + +`func (o *ApprovalStatusDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ApprovalStatusDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ApprovalStatusDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ApprovalStatusDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *ApprovalStatusDto) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *ApprovalStatusDto) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetStatus + +`func (o *ApprovalStatusDto) GetStatus() ManualWorkItemState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ApprovalStatusDto) GetStatusOk() (*ManualWorkItemState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ApprovalStatusDto) SetStatus(v ManualWorkItemState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ApprovalStatusDto) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetScheme + +`func (o *ApprovalStatusDto) GetScheme() ApprovalScheme` + +GetScheme returns the Scheme field if non-nil, zero value otherwise. + +### GetSchemeOk + +`func (o *ApprovalStatusDto) GetSchemeOk() (*ApprovalScheme, bool)` + +GetSchemeOk returns a tuple with the Scheme field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheme + +`func (o *ApprovalStatusDto) SetScheme(v ApprovalScheme)` + +SetScheme sets Scheme field to given value. + +### HasScheme + +`func (o *ApprovalStatusDto) HasScheme() bool` + +HasScheme returns a boolean if a field has been set. + +### GetErrorMessages + +`func (o *ApprovalStatusDto) GetErrorMessages() []ErrorMessageDto` + +GetErrorMessages returns the ErrorMessages field if non-nil, zero value otherwise. + +### GetErrorMessagesOk + +`func (o *ApprovalStatusDto) GetErrorMessagesOk() (*[]ErrorMessageDto, bool)` + +GetErrorMessagesOk returns a tuple with the ErrorMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessages + +`func (o *ApprovalStatusDto) SetErrorMessages(v []ErrorMessageDto)` + +SetErrorMessages sets ErrorMessages field to given value. + +### HasErrorMessages + +`func (o *ApprovalStatusDto) HasErrorMessages() bool` + +HasErrorMessages returns a boolean if a field has been set. + +### SetErrorMessagesNil + +`func (o *ApprovalStatusDto) SetErrorMessagesNil(b bool)` + + SetErrorMessagesNil sets the value for ErrorMessages to be an explicit nil + +### UnsetErrorMessages +`func (o *ApprovalStatusDto) UnsetErrorMessages()` + +UnsetErrorMessages ensures that no value is present for ErrorMessages, not even an explicit nil +### GetComment + +`func (o *ApprovalStatusDto) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ApprovalStatusDto) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ApprovalStatusDto) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *ApprovalStatusDto) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *ApprovalStatusDto) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *ApprovalStatusDto) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetRemoveDate + +`func (o *ApprovalStatusDto) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *ApprovalStatusDto) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *ApprovalStatusDto) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *ApprovalStatusDto) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *ApprovalStatusDto) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *ApprovalStatusDto) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ApprovalStatusDtoCurrentOwner.md b/docs/tools/sdk/go/Reference/V3/Models/ApprovalStatusDtoCurrentOwner.md new file mode 100644 index 000000000..378cc2f21 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ApprovalStatusDtoCurrentOwner.md @@ -0,0 +1,116 @@ +--- +id: approval-status-dto-current-owner +title: ApprovalStatusDtoCurrentOwner +pagination_label: ApprovalStatusDtoCurrentOwner +sidebar_label: ApprovalStatusDtoCurrentOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalStatusDtoCurrentOwner', 'ApprovalStatusDtoCurrentOwner'] +slug: /tools/sdk/go/v3/models/approval-status-dto-current-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoCurrentOwner', 'ApprovalStatusDtoCurrentOwner'] +--- + +# ApprovalStatusDtoCurrentOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of identity who reviewed the access item request. | [optional] +**Id** | Pointer to **string** | ID of identity who reviewed the access item request. | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity who reviewed the access item request. | [optional] + +## Methods + +### NewApprovalStatusDtoCurrentOwner + +`func NewApprovalStatusDtoCurrentOwner() *ApprovalStatusDtoCurrentOwner` + +NewApprovalStatusDtoCurrentOwner instantiates a new ApprovalStatusDtoCurrentOwner 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 + +### NewApprovalStatusDtoCurrentOwnerWithDefaults + +`func NewApprovalStatusDtoCurrentOwnerWithDefaults() *ApprovalStatusDtoCurrentOwner` + +NewApprovalStatusDtoCurrentOwnerWithDefaults instantiates a new ApprovalStatusDtoCurrentOwner 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 + +### GetType + +`func (o *ApprovalStatusDtoCurrentOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ApprovalStatusDtoCurrentOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ApprovalStatusDtoCurrentOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ApprovalStatusDtoCurrentOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ApprovalStatusDtoCurrentOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalStatusDtoCurrentOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalStatusDtoCurrentOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalStatusDtoCurrentOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalStatusDtoCurrentOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalStatusDtoCurrentOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalStatusDtoCurrentOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalStatusDtoCurrentOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ApprovalStatusDtoOriginalOwner.md b/docs/tools/sdk/go/Reference/V3/Models/ApprovalStatusDtoOriginalOwner.md new file mode 100644 index 000000000..5818f0c8c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ApprovalStatusDtoOriginalOwner.md @@ -0,0 +1,116 @@ +--- +id: approval-status-dto-original-owner +title: ApprovalStatusDtoOriginalOwner +pagination_label: ApprovalStatusDtoOriginalOwner +sidebar_label: ApprovalStatusDtoOriginalOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalStatusDtoOriginalOwner', 'ApprovalStatusDtoOriginalOwner'] +slug: /tools/sdk/go/v3/models/approval-status-dto-original-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoOriginalOwner', 'ApprovalStatusDtoOriginalOwner'] +--- + +# ApprovalStatusDtoOriginalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of original approval owner's identity. | [optional] +**Id** | Pointer to **string** | ID of original approval owner's identity. | [optional] +**Name** | Pointer to **string** | Display name of original approval owner. | [optional] + +## Methods + +### NewApprovalStatusDtoOriginalOwner + +`func NewApprovalStatusDtoOriginalOwner() *ApprovalStatusDtoOriginalOwner` + +NewApprovalStatusDtoOriginalOwner instantiates a new ApprovalStatusDtoOriginalOwner 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 + +### NewApprovalStatusDtoOriginalOwnerWithDefaults + +`func NewApprovalStatusDtoOriginalOwnerWithDefaults() *ApprovalStatusDtoOriginalOwner` + +NewApprovalStatusDtoOriginalOwnerWithDefaults instantiates a new ApprovalStatusDtoOriginalOwner 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 + +### GetType + +`func (o *ApprovalStatusDtoOriginalOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ApprovalStatusDtoOriginalOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ApprovalStatusDtoOriginalOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ApprovalStatusDtoOriginalOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ApprovalStatusDtoOriginalOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApprovalStatusDtoOriginalOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ApprovalStatusDtoOriginalOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ApprovalStatusDtoOriginalOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ApprovalStatusDtoOriginalOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApprovalStatusDtoOriginalOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ApprovalStatusDtoOriginalOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ApprovalStatusDtoOriginalOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ApprovalSummary.md b/docs/tools/sdk/go/Reference/V3/Models/ApprovalSummary.md new file mode 100644 index 000000000..6afc538ba --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ApprovalSummary.md @@ -0,0 +1,116 @@ +--- +id: approval-summary +title: ApprovalSummary +pagination_label: ApprovalSummary +sidebar_label: ApprovalSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ApprovalSummary', 'ApprovalSummary'] +slug: /tools/sdk/go/v3/models/approval-summary +tags: ['SDK', 'Software Development Kit', 'ApprovalSummary', 'ApprovalSummary'] +--- + +# ApprovalSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Pending** | Pointer to **int32** | The number of pending access requests approvals. | [optional] +**Approved** | Pointer to **int32** | The number of approved access requests approvals. | [optional] +**Rejected** | Pointer to **int32** | The number of rejected access requests approvals. | [optional] + +## Methods + +### NewApprovalSummary + +`func NewApprovalSummary() *ApprovalSummary` + +NewApprovalSummary instantiates a new ApprovalSummary 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 + +### NewApprovalSummaryWithDefaults + +`func NewApprovalSummaryWithDefaults() *ApprovalSummary` + +NewApprovalSummaryWithDefaults instantiates a new ApprovalSummary 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 + +### GetPending + +`func (o *ApprovalSummary) GetPending() int32` + +GetPending returns the Pending field if non-nil, zero value otherwise. + +### GetPendingOk + +`func (o *ApprovalSummary) GetPendingOk() (*int32, bool)` + +GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPending + +`func (o *ApprovalSummary) SetPending(v int32)` + +SetPending sets Pending field to given value. + +### HasPending + +`func (o *ApprovalSummary) HasPending() bool` + +HasPending returns a boolean if a field has been set. + +### GetApproved + +`func (o *ApprovalSummary) GetApproved() int32` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *ApprovalSummary) GetApprovedOk() (*int32, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *ApprovalSummary) SetApproved(v int32)` + +SetApproved sets Approved field to given value. + +### HasApproved + +`func (o *ApprovalSummary) HasApproved() bool` + +HasApproved returns a boolean if a field has been set. + +### GetRejected + +`func (o *ApprovalSummary) GetRejected() int32` + +GetRejected returns the Rejected field if non-nil, zero value otherwise. + +### GetRejectedOk + +`func (o *ApprovalSummary) GetRejectedOk() (*int32, bool)` + +GetRejectedOk returns a tuple with the Rejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRejected + +`func (o *ApprovalSummary) SetRejected(v int32)` + +SetRejected sets Rejected field to given value. + +### HasRejected + +`func (o *ApprovalSummary) HasRejected() bool` + +HasRejected returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ArrayInner.md b/docs/tools/sdk/go/Reference/V3/Models/ArrayInner.md new file mode 100644 index 000000000..67f38fed8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ArrayInner.md @@ -0,0 +1,38 @@ +--- +id: array-inner +title: ArrayInner +pagination_label: ArrayInner +sidebar_label: ArrayInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ArrayInner', 'ArrayInner'] +slug: /tools/sdk/go/v3/models/array-inner +tags: ['SDK', 'Software Development Kit', 'ArrayInner', 'ArrayInner'] +--- + +# ArrayInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewArrayInner + +`func NewArrayInner() *ArrayInner` + +NewArrayInner instantiates a new ArrayInner 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 + +### NewArrayInnerWithDefaults + +`func NewArrayInnerWithDefaults() *ArrayInner` + +NewArrayInnerWithDefaults instantiates a new ArrayInner 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 + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AttributeDTO.md b/docs/tools/sdk/go/Reference/V3/Models/AttributeDTO.md new file mode 100644 index 000000000..bc361f5c3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AttributeDTO.md @@ -0,0 +1,266 @@ +--- +id: attribute-dto +title: AttributeDTO +pagination_label: AttributeDTO +sidebar_label: AttributeDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDTO', 'AttributeDTO'] +slug: /tools/sdk/go/v3/models/attribute-dto +tags: ['SDK', 'Software Development Kit', 'AttributeDTO', 'AttributeDTO'] +--- + +# AttributeDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [optional] +**Name** | Pointer to **string** | The display name of the key. | [optional] +**Multiselect** | Pointer to **bool** | Indicates whether the attribute can have multiple values. | [optional] [default to false] +**Status** | Pointer to **string** | The status of the Attribute. | [optional] +**Type** | Pointer to **string** | The type of the Attribute. This can be either \"custom\" or \"governance\". | [optional] +**ObjectTypes** | Pointer to **[]string** | An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. | [optional] +**Description** | Pointer to **string** | The description of the Attribute. | [optional] +**Values** | Pointer to [**[]AttributeValueDTO**](attribute-value-dto) | | [optional] + +## Methods + +### NewAttributeDTO + +`func NewAttributeDTO() *AttributeDTO` + +NewAttributeDTO instantiates a new AttributeDTO 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 + +### NewAttributeDTOWithDefaults + +`func NewAttributeDTOWithDefaults() *AttributeDTO` + +NewAttributeDTOWithDefaults instantiates a new AttributeDTO 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 + +### GetKey + +`func (o *AttributeDTO) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *AttributeDTO) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *AttributeDTO) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *AttributeDTO) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *AttributeDTO) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeDTO) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeDTO) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeDTO) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetMultiselect + +`func (o *AttributeDTO) GetMultiselect() bool` + +GetMultiselect returns the Multiselect field if non-nil, zero value otherwise. + +### GetMultiselectOk + +`func (o *AttributeDTO) GetMultiselectOk() (*bool, bool)` + +GetMultiselectOk returns a tuple with the Multiselect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMultiselect + +`func (o *AttributeDTO) SetMultiselect(v bool)` + +SetMultiselect sets Multiselect field to given value. + +### HasMultiselect + +`func (o *AttributeDTO) HasMultiselect() bool` + +HasMultiselect returns a boolean if a field has been set. + +### GetStatus + +`func (o *AttributeDTO) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AttributeDTO) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AttributeDTO) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AttributeDTO) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetType + +`func (o *AttributeDTO) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttributeDTO) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttributeDTO) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttributeDTO) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetObjectTypes + +`func (o *AttributeDTO) GetObjectTypes() []string` + +GetObjectTypes returns the ObjectTypes field if non-nil, zero value otherwise. + +### GetObjectTypesOk + +`func (o *AttributeDTO) GetObjectTypesOk() (*[]string, bool)` + +GetObjectTypesOk returns a tuple with the ObjectTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectTypes + +`func (o *AttributeDTO) SetObjectTypes(v []string)` + +SetObjectTypes sets ObjectTypes field to given value. + +### HasObjectTypes + +`func (o *AttributeDTO) HasObjectTypes() bool` + +HasObjectTypes returns a boolean if a field has been set. + +### SetObjectTypesNil + +`func (o *AttributeDTO) SetObjectTypesNil(b bool)` + + SetObjectTypesNil sets the value for ObjectTypes to be an explicit nil + +### UnsetObjectTypes +`func (o *AttributeDTO) UnsetObjectTypes()` + +UnsetObjectTypes ensures that no value is present for ObjectTypes, not even an explicit nil +### GetDescription + +`func (o *AttributeDTO) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AttributeDTO) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AttributeDTO) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AttributeDTO) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetValues + +`func (o *AttributeDTO) GetValues() []AttributeValueDTO` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *AttributeDTO) GetValuesOk() (*[]AttributeValueDTO, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *AttributeDTO) SetValues(v []AttributeValueDTO)` + +SetValues sets Values field to given value. + +### HasValues + +`func (o *AttributeDTO) HasValues() bool` + +HasValues returns a boolean if a field has been set. + +### SetValuesNil + +`func (o *AttributeDTO) SetValuesNil(b bool)` + + SetValuesNil sets the value for Values to be an explicit nil + +### UnsetValues +`func (o *AttributeDTO) UnsetValues()` + +UnsetValues ensures that no value is present for Values, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AttributeDTOList.md b/docs/tools/sdk/go/Reference/V3/Models/AttributeDTOList.md new file mode 100644 index 000000000..0a2056883 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AttributeDTOList.md @@ -0,0 +1,74 @@ +--- +id: attribute-dto-list +title: AttributeDTOList +pagination_label: AttributeDTOList +sidebar_label: AttributeDTOList +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDTOList', 'AttributeDTOList'] +slug: /tools/sdk/go/v3/models/attribute-dto-list +tags: ['SDK', 'Software Development Kit', 'AttributeDTOList', 'AttributeDTOList'] +--- + +# AttributeDTOList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]AttributeDTO**](attribute-dto) | | [optional] + +## Methods + +### NewAttributeDTOList + +`func NewAttributeDTOList() *AttributeDTOList` + +NewAttributeDTOList instantiates a new AttributeDTOList 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 + +### NewAttributeDTOListWithDefaults + +`func NewAttributeDTOListWithDefaults() *AttributeDTOList` + +NewAttributeDTOListWithDefaults instantiates a new AttributeDTOList 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 + +### GetAttributes + +`func (o *AttributeDTOList) GetAttributes() []AttributeDTO` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *AttributeDTOList) GetAttributesOk() (*[]AttributeDTO, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *AttributeDTOList) SetAttributes(v []AttributeDTO)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *AttributeDTOList) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributesNil + +`func (o *AttributeDTOList) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *AttributeDTOList) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AttributeDefinition.md b/docs/tools/sdk/go/Reference/V3/Models/AttributeDefinition.md new file mode 100644 index 000000000..4065bbeca --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AttributeDefinition.md @@ -0,0 +1,220 @@ +--- +id: attribute-definition +title: AttributeDefinition +pagination_label: AttributeDefinition +sidebar_label: AttributeDefinition +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDefinition', 'AttributeDefinition'] +slug: /tools/sdk/go/v3/models/attribute-definition +tags: ['SDK', 'Software Development Kit', 'AttributeDefinition', 'AttributeDefinition'] +--- + +# AttributeDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the attribute. | [optional] +**Type** | Pointer to [**AttributeDefinitionType**](attribute-definition-type) | | [optional] +**Schema** | Pointer to [**AttributeDefinitionSchema**](attribute-definition-schema) | | [optional] +**Description** | Pointer to **string** | A human-readable description of the attribute. | [optional] +**IsMulti** | Pointer to **bool** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to false] +**IsEntitlement** | Pointer to **bool** | Flag indicating whether or not the attribute is an entitlement. | [optional] [default to false] +**IsGroup** | Pointer to **bool** | Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. | [optional] [default to false] + +## Methods + +### NewAttributeDefinition + +`func NewAttributeDefinition() *AttributeDefinition` + +NewAttributeDefinition instantiates a new AttributeDefinition 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 + +### NewAttributeDefinitionWithDefaults + +`func NewAttributeDefinitionWithDefaults() *AttributeDefinition` + +NewAttributeDefinitionWithDefaults instantiates a new AttributeDefinition 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 + +### GetName + +`func (o *AttributeDefinition) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeDefinition) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeDefinition) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeDefinition) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *AttributeDefinition) GetType() AttributeDefinitionType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttributeDefinition) GetTypeOk() (*AttributeDefinitionType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttributeDefinition) SetType(v AttributeDefinitionType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttributeDefinition) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSchema + +`func (o *AttributeDefinition) GetSchema() AttributeDefinitionSchema` + +GetSchema returns the Schema field if non-nil, zero value otherwise. + +### GetSchemaOk + +`func (o *AttributeDefinition) GetSchemaOk() (*AttributeDefinitionSchema, bool)` + +GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchema + +`func (o *AttributeDefinition) SetSchema(v AttributeDefinitionSchema)` + +SetSchema sets Schema field to given value. + +### HasSchema + +`func (o *AttributeDefinition) HasSchema() bool` + +HasSchema returns a boolean if a field has been set. + +### GetDescription + +`func (o *AttributeDefinition) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AttributeDefinition) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *AttributeDefinition) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *AttributeDefinition) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIsMulti + +`func (o *AttributeDefinition) GetIsMulti() bool` + +GetIsMulti returns the IsMulti field if non-nil, zero value otherwise. + +### GetIsMultiOk + +`func (o *AttributeDefinition) GetIsMultiOk() (*bool, bool)` + +GetIsMultiOk returns a tuple with the IsMulti field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsMulti + +`func (o *AttributeDefinition) SetIsMulti(v bool)` + +SetIsMulti sets IsMulti field to given value. + +### HasIsMulti + +`func (o *AttributeDefinition) HasIsMulti() bool` + +HasIsMulti returns a boolean if a field has been set. + +### GetIsEntitlement + +`func (o *AttributeDefinition) GetIsEntitlement() bool` + +GetIsEntitlement returns the IsEntitlement field if non-nil, zero value otherwise. + +### GetIsEntitlementOk + +`func (o *AttributeDefinition) GetIsEntitlementOk() (*bool, bool)` + +GetIsEntitlementOk returns a tuple with the IsEntitlement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsEntitlement + +`func (o *AttributeDefinition) SetIsEntitlement(v bool)` + +SetIsEntitlement sets IsEntitlement field to given value. + +### HasIsEntitlement + +`func (o *AttributeDefinition) HasIsEntitlement() bool` + +HasIsEntitlement returns a boolean if a field has been set. + +### GetIsGroup + +`func (o *AttributeDefinition) GetIsGroup() bool` + +GetIsGroup returns the IsGroup field if non-nil, zero value otherwise. + +### GetIsGroupOk + +`func (o *AttributeDefinition) GetIsGroupOk() (*bool, bool)` + +GetIsGroupOk returns a tuple with the IsGroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsGroup + +`func (o *AttributeDefinition) SetIsGroup(v bool)` + +SetIsGroup sets IsGroup field to given value. + +### HasIsGroup + +`func (o *AttributeDefinition) HasIsGroup() bool` + +HasIsGroup returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AttributeDefinitionSchema.md b/docs/tools/sdk/go/Reference/V3/Models/AttributeDefinitionSchema.md new file mode 100644 index 000000000..8985bb98c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AttributeDefinitionSchema.md @@ -0,0 +1,116 @@ +--- +id: attribute-definition-schema +title: AttributeDefinitionSchema +pagination_label: AttributeDefinitionSchema +sidebar_label: AttributeDefinitionSchema +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDefinitionSchema', 'AttributeDefinitionSchema'] +slug: /tools/sdk/go/v3/models/attribute-definition-schema +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionSchema', 'AttributeDefinitionSchema'] +--- + +# AttributeDefinitionSchema + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of object being referenced | [optional] +**Id** | Pointer to **string** | The object ID this reference applies to. | [optional] +**Name** | Pointer to **string** | The human-readable display name of the object. | [optional] + +## Methods + +### NewAttributeDefinitionSchema + +`func NewAttributeDefinitionSchema() *AttributeDefinitionSchema` + +NewAttributeDefinitionSchema instantiates a new AttributeDefinitionSchema 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 + +### NewAttributeDefinitionSchemaWithDefaults + +`func NewAttributeDefinitionSchemaWithDefaults() *AttributeDefinitionSchema` + +NewAttributeDefinitionSchemaWithDefaults instantiates a new AttributeDefinitionSchema 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 + +### GetType + +`func (o *AttributeDefinitionSchema) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *AttributeDefinitionSchema) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *AttributeDefinitionSchema) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *AttributeDefinitionSchema) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *AttributeDefinitionSchema) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AttributeDefinitionSchema) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AttributeDefinitionSchema) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AttributeDefinitionSchema) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *AttributeDefinitionSchema) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeDefinitionSchema) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeDefinitionSchema) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeDefinitionSchema) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AttributeDefinitionType.md b/docs/tools/sdk/go/Reference/V3/Models/AttributeDefinitionType.md new file mode 100644 index 000000000..e5d013bdc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AttributeDefinitionType.md @@ -0,0 +1,27 @@ +--- +id: attribute-definition-type +title: AttributeDefinitionType +pagination_label: AttributeDefinitionType +sidebar_label: AttributeDefinitionType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeDefinitionType', 'AttributeDefinitionType'] +slug: /tools/sdk/go/v3/models/attribute-definition-type +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'AttributeDefinitionType'] +--- + +# AttributeDefinitionType + +## Enum + + +* `STRING` (value: `"STRING"`) + +* `LONG` (value: `"LONG"`) + +* `INT` (value: `"INT"`) + +* `BOOLEAN` (value: `"BOOLEAN"`) + +* `DATE` (value: `"DATE"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AttributeRequest.md b/docs/tools/sdk/go/Reference/V3/Models/AttributeRequest.md new file mode 100644 index 000000000..4431bb666 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AttributeRequest.md @@ -0,0 +1,116 @@ +--- +id: attribute-request +title: AttributeRequest +pagination_label: AttributeRequest +sidebar_label: AttributeRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeRequest', 'AttributeRequest'] +slug: /tools/sdk/go/v3/models/attribute-request +tags: ['SDK', 'Software Development Kit', 'AttributeRequest', 'AttributeRequest'] +--- + +# AttributeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Attribute name. | [optional] +**Op** | Pointer to **string** | Operation to perform on attribute. | [optional] +**Value** | Pointer to [**AttributeRequestValue**](attribute-request-value) | | [optional] + +## Methods + +### NewAttributeRequest + +`func NewAttributeRequest() *AttributeRequest` + +NewAttributeRequest instantiates a new AttributeRequest 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 + +### NewAttributeRequestWithDefaults + +`func NewAttributeRequestWithDefaults() *AttributeRequest` + +NewAttributeRequestWithDefaults instantiates a new AttributeRequest 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 + +### GetName + +`func (o *AttributeRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOp + +`func (o *AttributeRequest) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *AttributeRequest) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *AttributeRequest) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *AttributeRequest) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetValue + +`func (o *AttributeRequest) GetValue() AttributeRequestValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AttributeRequest) GetValueOk() (*AttributeRequestValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AttributeRequest) SetValue(v AttributeRequestValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AttributeRequest) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AttributeRequestValue.md b/docs/tools/sdk/go/Reference/V3/Models/AttributeRequestValue.md new file mode 100644 index 000000000..2d8a64282 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AttributeRequestValue.md @@ -0,0 +1,38 @@ +--- +id: attribute-request-value +title: AttributeRequestValue +pagination_label: AttributeRequestValue +sidebar_label: AttributeRequestValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeRequestValue', 'AttributeRequestValue'] +slug: /tools/sdk/go/v3/models/attribute-request-value +tags: ['SDK', 'Software Development Kit', 'AttributeRequestValue', 'AttributeRequestValue'] +--- + +# AttributeRequestValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewAttributeRequestValue + +`func NewAttributeRequestValue() *AttributeRequestValue` + +NewAttributeRequestValue instantiates a new AttributeRequestValue 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 + +### NewAttributeRequestValueWithDefaults + +`func NewAttributeRequestValueWithDefaults() *AttributeRequestValue` + +NewAttributeRequestValueWithDefaults instantiates a new AttributeRequestValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AttributeValueDTO.md b/docs/tools/sdk/go/Reference/V3/Models/AttributeValueDTO.md new file mode 100644 index 000000000..24bd8496b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AttributeValueDTO.md @@ -0,0 +1,116 @@ +--- +id: attribute-value-dto +title: AttributeValueDTO +pagination_label: AttributeValueDTO +sidebar_label: AttributeValueDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AttributeValueDTO', 'AttributeValueDTO'] +slug: /tools/sdk/go/v3/models/attribute-value-dto +tags: ['SDK', 'Software Development Kit', 'AttributeValueDTO', 'AttributeValueDTO'] +--- + +# AttributeValueDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [optional] +**Name** | Pointer to **string** | The display name of the Attribute value. | [optional] +**Status** | Pointer to **string** | The status of the Attribute value. | [optional] + +## Methods + +### NewAttributeValueDTO + +`func NewAttributeValueDTO() *AttributeValueDTO` + +NewAttributeValueDTO instantiates a new AttributeValueDTO 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 + +### NewAttributeValueDTOWithDefaults + +`func NewAttributeValueDTOWithDefaults() *AttributeValueDTO` + +NewAttributeValueDTOWithDefaults instantiates a new AttributeValueDTO 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 + +### GetValue + +`func (o *AttributeValueDTO) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AttributeValueDTO) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *AttributeValueDTO) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *AttributeValueDTO) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetName + +`func (o *AttributeValueDTO) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AttributeValueDTO) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *AttributeValueDTO) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *AttributeValueDTO) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *AttributeValueDTO) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *AttributeValueDTO) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *AttributeValueDTO) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *AttributeValueDTO) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/AuthUser.md b/docs/tools/sdk/go/Reference/V3/Models/AuthUser.md new file mode 100644 index 000000000..3ec0fa514 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/AuthUser.md @@ -0,0 +1,606 @@ +--- +id: auth-user +title: AuthUser +pagination_label: AuthUser +sidebar_label: AuthUser +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'AuthUser', 'AuthUser'] +slug: /tools/sdk/go/v3/models/auth-user +tags: ['SDK', 'Software Development Kit', 'AuthUser', 'AuthUser'] +--- + +# AuthUser + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Tenant** | Pointer to **string** | Tenant name. | [optional] +**Id** | Pointer to **string** | Identity ID. | [optional] +**Uid** | Pointer to **string** | Identity's unique identitifier. | [optional] +**Profile** | Pointer to **string** | ID of the auth profile associated with the auth user. | [optional] +**IdentificationNumber** | Pointer to **NullableString** | Auth user's employee number. | [optional] +**Email** | Pointer to **NullableString** | Auth user's email. | [optional] +**Phone** | Pointer to **NullableString** | Auth user's phone number. | [optional] +**WorkPhone** | Pointer to **NullableString** | Auth user's work phone number. | [optional] +**PersonalEmail** | Pointer to **NullableString** | Auth user's personal email. | [optional] +**Firstname** | Pointer to **NullableString** | Auth user's first name. | [optional] +**Lastname** | Pointer to **NullableString** | Auth user's last name. | [optional] +**DisplayName** | Pointer to **string** | Auth user's name in displayed format. | [optional] +**Alias** | Pointer to **string** | Auth user's alias. | [optional] +**LastPasswordChangeDate** | Pointer to **NullableTime** | Date of last password change. | [optional] +**LastLoginTimestamp** | Pointer to **int64** | Timestamp of the last login (long type value). | [optional] +**CurrentLoginTimestamp** | Pointer to **int64** | Timestamp of the current login (long type value). | [optional] +**LastUnlockTimestamp** | Pointer to **NullableTime** | The date and time when the user was last unlocked. | [optional] +**Capabilities** | Pointer to **[]string** | Array of the auth user's capabilities. | [optional] + +## Methods + +### NewAuthUser + +`func NewAuthUser() *AuthUser` + +NewAuthUser instantiates a new AuthUser 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 + +### NewAuthUserWithDefaults + +`func NewAuthUserWithDefaults() *AuthUser` + +NewAuthUserWithDefaults instantiates a new AuthUser 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 + +### GetTenant + +`func (o *AuthUser) GetTenant() string` + +GetTenant returns the Tenant field if non-nil, zero value otherwise. + +### GetTenantOk + +`func (o *AuthUser) GetTenantOk() (*string, bool)` + +GetTenantOk returns a tuple with the Tenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenant + +`func (o *AuthUser) SetTenant(v string)` + +SetTenant sets Tenant field to given value. + +### HasTenant + +`func (o *AuthUser) HasTenant() bool` + +HasTenant returns a boolean if a field has been set. + +### GetId + +`func (o *AuthUser) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AuthUser) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *AuthUser) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *AuthUser) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetUid + +`func (o *AuthUser) GetUid() string` + +GetUid returns the Uid field if non-nil, zero value otherwise. + +### GetUidOk + +`func (o *AuthUser) GetUidOk() (*string, bool)` + +GetUidOk returns a tuple with the Uid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUid + +`func (o *AuthUser) SetUid(v string)` + +SetUid sets Uid field to given value. + +### HasUid + +`func (o *AuthUser) HasUid() bool` + +HasUid returns a boolean if a field has been set. + +### GetProfile + +`func (o *AuthUser) GetProfile() string` + +GetProfile returns the Profile field if non-nil, zero value otherwise. + +### GetProfileOk + +`func (o *AuthUser) GetProfileOk() (*string, bool)` + +GetProfileOk returns a tuple with the Profile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProfile + +`func (o *AuthUser) SetProfile(v string)` + +SetProfile sets Profile field to given value. + +### HasProfile + +`func (o *AuthUser) HasProfile() bool` + +HasProfile returns a boolean if a field has been set. + +### GetIdentificationNumber + +`func (o *AuthUser) GetIdentificationNumber() string` + +GetIdentificationNumber returns the IdentificationNumber field if non-nil, zero value otherwise. + +### GetIdentificationNumberOk + +`func (o *AuthUser) GetIdentificationNumberOk() (*string, bool)` + +GetIdentificationNumberOk returns a tuple with the IdentificationNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentificationNumber + +`func (o *AuthUser) SetIdentificationNumber(v string)` + +SetIdentificationNumber sets IdentificationNumber field to given value. + +### HasIdentificationNumber + +`func (o *AuthUser) HasIdentificationNumber() bool` + +HasIdentificationNumber returns a boolean if a field has been set. + +### SetIdentificationNumberNil + +`func (o *AuthUser) SetIdentificationNumberNil(b bool)` + + SetIdentificationNumberNil sets the value for IdentificationNumber to be an explicit nil + +### UnsetIdentificationNumber +`func (o *AuthUser) UnsetIdentificationNumber()` + +UnsetIdentificationNumber ensures that no value is present for IdentificationNumber, not even an explicit nil +### GetEmail + +`func (o *AuthUser) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *AuthUser) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *AuthUser) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *AuthUser) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### SetEmailNil + +`func (o *AuthUser) SetEmailNil(b bool)` + + SetEmailNil sets the value for Email to be an explicit nil + +### UnsetEmail +`func (o *AuthUser) UnsetEmail()` + +UnsetEmail ensures that no value is present for Email, not even an explicit nil +### GetPhone + +`func (o *AuthUser) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *AuthUser) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *AuthUser) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *AuthUser) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### SetPhoneNil + +`func (o *AuthUser) SetPhoneNil(b bool)` + + SetPhoneNil sets the value for Phone to be an explicit nil + +### UnsetPhone +`func (o *AuthUser) UnsetPhone()` + +UnsetPhone ensures that no value is present for Phone, not even an explicit nil +### GetWorkPhone + +`func (o *AuthUser) GetWorkPhone() string` + +GetWorkPhone returns the WorkPhone field if non-nil, zero value otherwise. + +### GetWorkPhoneOk + +`func (o *AuthUser) GetWorkPhoneOk() (*string, bool)` + +GetWorkPhoneOk returns a tuple with the WorkPhone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWorkPhone + +`func (o *AuthUser) SetWorkPhone(v string)` + +SetWorkPhone sets WorkPhone field to given value. + +### HasWorkPhone + +`func (o *AuthUser) HasWorkPhone() bool` + +HasWorkPhone returns a boolean if a field has been set. + +### SetWorkPhoneNil + +`func (o *AuthUser) SetWorkPhoneNil(b bool)` + + SetWorkPhoneNil sets the value for WorkPhone to be an explicit nil + +### UnsetWorkPhone +`func (o *AuthUser) UnsetWorkPhone()` + +UnsetWorkPhone ensures that no value is present for WorkPhone, not even an explicit nil +### GetPersonalEmail + +`func (o *AuthUser) GetPersonalEmail() string` + +GetPersonalEmail returns the PersonalEmail field if non-nil, zero value otherwise. + +### GetPersonalEmailOk + +`func (o *AuthUser) GetPersonalEmailOk() (*string, bool)` + +GetPersonalEmailOk returns a tuple with the PersonalEmail field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPersonalEmail + +`func (o *AuthUser) SetPersonalEmail(v string)` + +SetPersonalEmail sets PersonalEmail field to given value. + +### HasPersonalEmail + +`func (o *AuthUser) HasPersonalEmail() bool` + +HasPersonalEmail returns a boolean if a field has been set. + +### SetPersonalEmailNil + +`func (o *AuthUser) SetPersonalEmailNil(b bool)` + + SetPersonalEmailNil sets the value for PersonalEmail to be an explicit nil + +### UnsetPersonalEmail +`func (o *AuthUser) UnsetPersonalEmail()` + +UnsetPersonalEmail ensures that no value is present for PersonalEmail, not even an explicit nil +### GetFirstname + +`func (o *AuthUser) GetFirstname() string` + +GetFirstname returns the Firstname field if non-nil, zero value otherwise. + +### GetFirstnameOk + +`func (o *AuthUser) GetFirstnameOk() (*string, bool)` + +GetFirstnameOk returns a tuple with the Firstname field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstname + +`func (o *AuthUser) SetFirstname(v string)` + +SetFirstname sets Firstname field to given value. + +### HasFirstname + +`func (o *AuthUser) HasFirstname() bool` + +HasFirstname returns a boolean if a field has been set. + +### SetFirstnameNil + +`func (o *AuthUser) SetFirstnameNil(b bool)` + + SetFirstnameNil sets the value for Firstname to be an explicit nil + +### UnsetFirstname +`func (o *AuthUser) UnsetFirstname()` + +UnsetFirstname ensures that no value is present for Firstname, not even an explicit nil +### GetLastname + +`func (o *AuthUser) GetLastname() string` + +GetLastname returns the Lastname field if non-nil, zero value otherwise. + +### GetLastnameOk + +`func (o *AuthUser) GetLastnameOk() (*string, bool)` + +GetLastnameOk returns a tuple with the Lastname field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastname + +`func (o *AuthUser) SetLastname(v string)` + +SetLastname sets Lastname field to given value. + +### HasLastname + +`func (o *AuthUser) HasLastname() bool` + +HasLastname returns a boolean if a field has been set. + +### SetLastnameNil + +`func (o *AuthUser) SetLastnameNil(b bool)` + + SetLastnameNil sets the value for Lastname to be an explicit nil + +### UnsetLastname +`func (o *AuthUser) UnsetLastname()` + +UnsetLastname ensures that no value is present for Lastname, not even an explicit nil +### GetDisplayName + +`func (o *AuthUser) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *AuthUser) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *AuthUser) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *AuthUser) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetAlias + +`func (o *AuthUser) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *AuthUser) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *AuthUser) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *AuthUser) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + +### GetLastPasswordChangeDate + +`func (o *AuthUser) GetLastPasswordChangeDate() SailPointTime` + +GetLastPasswordChangeDate returns the LastPasswordChangeDate field if non-nil, zero value otherwise. + +### GetLastPasswordChangeDateOk + +`func (o *AuthUser) GetLastPasswordChangeDateOk() (*SailPointTime, bool)` + +GetLastPasswordChangeDateOk returns a tuple with the LastPasswordChangeDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastPasswordChangeDate + +`func (o *AuthUser) SetLastPasswordChangeDate(v SailPointTime)` + +SetLastPasswordChangeDate sets LastPasswordChangeDate field to given value. + +### HasLastPasswordChangeDate + +`func (o *AuthUser) HasLastPasswordChangeDate() bool` + +HasLastPasswordChangeDate returns a boolean if a field has been set. + +### SetLastPasswordChangeDateNil + +`func (o *AuthUser) SetLastPasswordChangeDateNil(b bool)` + + SetLastPasswordChangeDateNil sets the value for LastPasswordChangeDate to be an explicit nil + +### UnsetLastPasswordChangeDate +`func (o *AuthUser) UnsetLastPasswordChangeDate()` + +UnsetLastPasswordChangeDate ensures that no value is present for LastPasswordChangeDate, not even an explicit nil +### GetLastLoginTimestamp + +`func (o *AuthUser) GetLastLoginTimestamp() int64` + +GetLastLoginTimestamp returns the LastLoginTimestamp field if non-nil, zero value otherwise. + +### GetLastLoginTimestampOk + +`func (o *AuthUser) GetLastLoginTimestampOk() (*int64, bool)` + +GetLastLoginTimestampOk returns a tuple with the LastLoginTimestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastLoginTimestamp + +`func (o *AuthUser) SetLastLoginTimestamp(v int64)` + +SetLastLoginTimestamp sets LastLoginTimestamp field to given value. + +### HasLastLoginTimestamp + +`func (o *AuthUser) HasLastLoginTimestamp() bool` + +HasLastLoginTimestamp returns a boolean if a field has been set. + +### GetCurrentLoginTimestamp + +`func (o *AuthUser) GetCurrentLoginTimestamp() int64` + +GetCurrentLoginTimestamp returns the CurrentLoginTimestamp field if non-nil, zero value otherwise. + +### GetCurrentLoginTimestampOk + +`func (o *AuthUser) GetCurrentLoginTimestampOk() (*int64, bool)` + +GetCurrentLoginTimestampOk returns a tuple with the CurrentLoginTimestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentLoginTimestamp + +`func (o *AuthUser) SetCurrentLoginTimestamp(v int64)` + +SetCurrentLoginTimestamp sets CurrentLoginTimestamp field to given value. + +### HasCurrentLoginTimestamp + +`func (o *AuthUser) HasCurrentLoginTimestamp() bool` + +HasCurrentLoginTimestamp returns a boolean if a field has been set. + +### GetLastUnlockTimestamp + +`func (o *AuthUser) GetLastUnlockTimestamp() SailPointTime` + +GetLastUnlockTimestamp returns the LastUnlockTimestamp field if non-nil, zero value otherwise. + +### GetLastUnlockTimestampOk + +`func (o *AuthUser) GetLastUnlockTimestampOk() (*SailPointTime, bool)` + +GetLastUnlockTimestampOk returns a tuple with the LastUnlockTimestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUnlockTimestamp + +`func (o *AuthUser) SetLastUnlockTimestamp(v SailPointTime)` + +SetLastUnlockTimestamp sets LastUnlockTimestamp field to given value. + +### HasLastUnlockTimestamp + +`func (o *AuthUser) HasLastUnlockTimestamp() bool` + +HasLastUnlockTimestamp returns a boolean if a field has been set. + +### SetLastUnlockTimestampNil + +`func (o *AuthUser) SetLastUnlockTimestampNil(b bool)` + + SetLastUnlockTimestampNil sets the value for LastUnlockTimestamp to be an explicit nil + +### UnsetLastUnlockTimestamp +`func (o *AuthUser) UnsetLastUnlockTimestamp()` + +UnsetLastUnlockTimestamp ensures that no value is present for LastUnlockTimestamp, not even an explicit nil +### GetCapabilities + +`func (o *AuthUser) GetCapabilities() []string` + +GetCapabilities returns the Capabilities field if non-nil, zero value otherwise. + +### GetCapabilitiesOk + +`func (o *AuthUser) GetCapabilitiesOk() (*[]string, bool)` + +GetCapabilitiesOk returns a tuple with the Capabilities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCapabilities + +`func (o *AuthUser) SetCapabilities(v []string)` + +SetCapabilities sets Capabilities field to given value. + +### HasCapabilities + +`func (o *AuthUser) HasCapabilities() bool` + +HasCapabilities returns a boolean if a field has been set. + +### SetCapabilitiesNil + +`func (o *AuthUser) SetCapabilitiesNil(b bool)` + + SetCapabilitiesNil sets the value for Capabilities to be an explicit nil + +### UnsetCapabilities +`func (o *AuthUser) UnsetCapabilities()` + +UnsetCapabilities ensures that no value is present for Capabilities, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BackupOptions.md b/docs/tools/sdk/go/Reference/V3/Models/BackupOptions.md new file mode 100644 index 000000000..e9b878d84 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BackupOptions.md @@ -0,0 +1,90 @@ +--- +id: backup-options +title: BackupOptions +pagination_label: BackupOptions +sidebar_label: BackupOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BackupOptions', 'BackupOptions'] +slug: /tools/sdk/go/v3/models/backup-options +tags: ['SDK', 'Software Development Kit', 'BackupOptions', 'BackupOptions'] +--- + +# BackupOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludeTypes** | Pointer to **[]string** | Object type names to be included in a Configuration Hub backup command. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportNames**](object-export-import-names) | Additional options targeting specific objects related to each item in the includeTypes field. | [optional] + +## Methods + +### NewBackupOptions + +`func NewBackupOptions() *BackupOptions` + +NewBackupOptions instantiates a new BackupOptions 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 + +### NewBackupOptionsWithDefaults + +`func NewBackupOptionsWithDefaults() *BackupOptions` + +NewBackupOptionsWithDefaults instantiates a new BackupOptions 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 + +### GetIncludeTypes + +`func (o *BackupOptions) GetIncludeTypes() []string` + +GetIncludeTypes returns the IncludeTypes field if non-nil, zero value otherwise. + +### GetIncludeTypesOk + +`func (o *BackupOptions) GetIncludeTypesOk() (*[]string, bool)` + +GetIncludeTypesOk returns a tuple with the IncludeTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeTypes + +`func (o *BackupOptions) SetIncludeTypes(v []string)` + +SetIncludeTypes sets IncludeTypes field to given value. + +### HasIncludeTypes + +`func (o *BackupOptions) HasIncludeTypes() bool` + +HasIncludeTypes returns a boolean if a field has been set. + +### GetObjectOptions + +`func (o *BackupOptions) GetObjectOptions() map[string]ObjectExportImportNames` + +GetObjectOptions returns the ObjectOptions field if non-nil, zero value otherwise. + +### GetObjectOptionsOk + +`func (o *BackupOptions) GetObjectOptionsOk() (*map[string]ObjectExportImportNames, bool)` + +GetObjectOptionsOk returns a tuple with the ObjectOptions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectOptions + +`func (o *BackupOptions) SetObjectOptions(v map[string]ObjectExportImportNames)` + +SetObjectOptions sets ObjectOptions field to given value. + +### HasObjectOptions + +`func (o *BackupOptions) HasObjectOptions() bool` + +HasObjectOptions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BackupResponse.md b/docs/tools/sdk/go/Reference/V3/Models/BackupResponse.md new file mode 100644 index 000000000..3ec46e9c8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BackupResponse.md @@ -0,0 +1,490 @@ +--- +id: backup-response +title: BackupResponse +pagination_label: BackupResponse +sidebar_label: BackupResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BackupResponse', 'BackupResponse'] +slug: /tools/sdk/go/v3/models/backup-response +tags: ['SDK', 'Software Development Kit', 'BackupResponse', 'BackupResponse'] +--- + +# BackupResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | Pointer to **string** | Unique id assigned to this backup. | [optional] +**Status** | Pointer to **string** | Status of the backup. | [optional] +**Type** | Pointer to **string** | Type of the job, will always be BACKUP for this type of job. | [optional] +**Tenant** | Pointer to **string** | The name of the tenant performing the upload | [optional] +**RequesterName** | Pointer to **string** | The name of the requester. | [optional] +**FileExists** | Pointer to **bool** | Whether or not a file was created and stored for this backup. | [optional] [default to true] +**Created** | Pointer to **SailPointTime** | The time the job was started. | [optional] +**Modified** | Pointer to **SailPointTime** | The time of the last update to the job. | [optional] +**Completed** | Pointer to **SailPointTime** | The time the job was completed. | [optional] +**Name** | Pointer to **string** | The name assigned to the upload file in the request body. | [optional] +**UserCanDelete** | Pointer to **bool** | Whether this backup can be deleted by a regular user. | [optional] [default to true] +**IsPartial** | Pointer to **bool** | Whether this backup contains all supported object types or only some of them. | [optional] [default to false] +**BackupType** | Pointer to **string** | Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. | [optional] +**Options** | Pointer to [**NullableBackupOptions**](backup-options) | | [optional] +**HydrationStatus** | Pointer to **string** | Whether the object details of this backup are ready. | [optional] +**TotalObjectCount** | Pointer to **int64** | Number of objects contained in this backup. | [optional] +**CloudStorageStatus** | Pointer to **string** | Whether this backup has been transferred to a customer storage location. | [optional] + +## Methods + +### NewBackupResponse + +`func NewBackupResponse() *BackupResponse` + +NewBackupResponse instantiates a new BackupResponse 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 + +### NewBackupResponseWithDefaults + +`func NewBackupResponseWithDefaults() *BackupResponse` + +NewBackupResponseWithDefaults instantiates a new BackupResponse 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 + +### GetJobId + +`func (o *BackupResponse) GetJobId() string` + +GetJobId returns the JobId field if non-nil, zero value otherwise. + +### GetJobIdOk + +`func (o *BackupResponse) GetJobIdOk() (*string, bool)` + +GetJobIdOk returns a tuple with the JobId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobId + +`func (o *BackupResponse) SetJobId(v string)` + +SetJobId sets JobId field to given value. + +### HasJobId + +`func (o *BackupResponse) HasJobId() bool` + +HasJobId returns a boolean if a field has been set. + +### GetStatus + +`func (o *BackupResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *BackupResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *BackupResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *BackupResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetType + +`func (o *BackupResponse) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BackupResponse) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BackupResponse) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BackupResponse) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetTenant + +`func (o *BackupResponse) GetTenant() string` + +GetTenant returns the Tenant field if non-nil, zero value otherwise. + +### GetTenantOk + +`func (o *BackupResponse) GetTenantOk() (*string, bool)` + +GetTenantOk returns a tuple with the Tenant field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenant + +`func (o *BackupResponse) SetTenant(v string)` + +SetTenant sets Tenant field to given value. + +### HasTenant + +`func (o *BackupResponse) HasTenant() bool` + +HasTenant returns a boolean if a field has been set. + +### GetRequesterName + +`func (o *BackupResponse) GetRequesterName() string` + +GetRequesterName returns the RequesterName field if non-nil, zero value otherwise. + +### GetRequesterNameOk + +`func (o *BackupResponse) GetRequesterNameOk() (*string, bool)` + +GetRequesterNameOk returns a tuple with the RequesterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterName + +`func (o *BackupResponse) SetRequesterName(v string)` + +SetRequesterName sets RequesterName field to given value. + +### HasRequesterName + +`func (o *BackupResponse) HasRequesterName() bool` + +HasRequesterName returns a boolean if a field has been set. + +### GetFileExists + +`func (o *BackupResponse) GetFileExists() bool` + +GetFileExists returns the FileExists field if non-nil, zero value otherwise. + +### GetFileExistsOk + +`func (o *BackupResponse) GetFileExistsOk() (*bool, bool)` + +GetFileExistsOk returns a tuple with the FileExists field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileExists + +`func (o *BackupResponse) SetFileExists(v bool)` + +SetFileExists sets FileExists field to given value. + +### HasFileExists + +`func (o *BackupResponse) HasFileExists() bool` + +HasFileExists returns a boolean if a field has been set. + +### GetCreated + +`func (o *BackupResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BackupResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BackupResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *BackupResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *BackupResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *BackupResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *BackupResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *BackupResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCompleted + +`func (o *BackupResponse) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *BackupResponse) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *BackupResponse) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *BackupResponse) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetName + +`func (o *BackupResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BackupResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BackupResponse) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BackupResponse) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetUserCanDelete + +`func (o *BackupResponse) GetUserCanDelete() bool` + +GetUserCanDelete returns the UserCanDelete field if non-nil, zero value otherwise. + +### GetUserCanDeleteOk + +`func (o *BackupResponse) GetUserCanDeleteOk() (*bool, bool)` + +GetUserCanDeleteOk returns a tuple with the UserCanDelete field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserCanDelete + +`func (o *BackupResponse) SetUserCanDelete(v bool)` + +SetUserCanDelete sets UserCanDelete field to given value. + +### HasUserCanDelete + +`func (o *BackupResponse) HasUserCanDelete() bool` + +HasUserCanDelete returns a boolean if a field has been set. + +### GetIsPartial + +`func (o *BackupResponse) GetIsPartial() bool` + +GetIsPartial returns the IsPartial field if non-nil, zero value otherwise. + +### GetIsPartialOk + +`func (o *BackupResponse) GetIsPartialOk() (*bool, bool)` + +GetIsPartialOk returns a tuple with the IsPartial field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsPartial + +`func (o *BackupResponse) SetIsPartial(v bool)` + +SetIsPartial sets IsPartial field to given value. + +### HasIsPartial + +`func (o *BackupResponse) HasIsPartial() bool` + +HasIsPartial returns a boolean if a field has been set. + +### GetBackupType + +`func (o *BackupResponse) GetBackupType() string` + +GetBackupType returns the BackupType field if non-nil, zero value otherwise. + +### GetBackupTypeOk + +`func (o *BackupResponse) GetBackupTypeOk() (*string, bool)` + +GetBackupTypeOk returns a tuple with the BackupType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBackupType + +`func (o *BackupResponse) SetBackupType(v string)` + +SetBackupType sets BackupType field to given value. + +### HasBackupType + +`func (o *BackupResponse) HasBackupType() bool` + +HasBackupType returns a boolean if a field has been set. + +### GetOptions + +`func (o *BackupResponse) GetOptions() BackupOptions` + +GetOptions returns the Options field if non-nil, zero value otherwise. + +### GetOptionsOk + +`func (o *BackupResponse) GetOptionsOk() (*BackupOptions, bool)` + +GetOptionsOk returns a tuple with the Options field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOptions + +`func (o *BackupResponse) SetOptions(v BackupOptions)` + +SetOptions sets Options field to given value. + +### HasOptions + +`func (o *BackupResponse) HasOptions() bool` + +HasOptions returns a boolean if a field has been set. + +### SetOptionsNil + +`func (o *BackupResponse) SetOptionsNil(b bool)` + + SetOptionsNil sets the value for Options to be an explicit nil + +### UnsetOptions +`func (o *BackupResponse) UnsetOptions()` + +UnsetOptions ensures that no value is present for Options, not even an explicit nil +### GetHydrationStatus + +`func (o *BackupResponse) GetHydrationStatus() string` + +GetHydrationStatus returns the HydrationStatus field if non-nil, zero value otherwise. + +### GetHydrationStatusOk + +`func (o *BackupResponse) GetHydrationStatusOk() (*string, bool)` + +GetHydrationStatusOk returns a tuple with the HydrationStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHydrationStatus + +`func (o *BackupResponse) SetHydrationStatus(v string)` + +SetHydrationStatus sets HydrationStatus field to given value. + +### HasHydrationStatus + +`func (o *BackupResponse) HasHydrationStatus() bool` + +HasHydrationStatus returns a boolean if a field has been set. + +### GetTotalObjectCount + +`func (o *BackupResponse) GetTotalObjectCount() int64` + +GetTotalObjectCount returns the TotalObjectCount field if non-nil, zero value otherwise. + +### GetTotalObjectCountOk + +`func (o *BackupResponse) GetTotalObjectCountOk() (*int64, bool)` + +GetTotalObjectCountOk returns a tuple with the TotalObjectCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalObjectCount + +`func (o *BackupResponse) SetTotalObjectCount(v int64)` + +SetTotalObjectCount sets TotalObjectCount field to given value. + +### HasTotalObjectCount + +`func (o *BackupResponse) HasTotalObjectCount() bool` + +HasTotalObjectCount returns a boolean if a field has been set. + +### GetCloudStorageStatus + +`func (o *BackupResponse) GetCloudStorageStatus() string` + +GetCloudStorageStatus returns the CloudStorageStatus field if non-nil, zero value otherwise. + +### GetCloudStorageStatusOk + +`func (o *BackupResponse) GetCloudStorageStatusOk() (*string, bool)` + +GetCloudStorageStatusOk returns a tuple with the CloudStorageStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudStorageStatus + +`func (o *BackupResponse) SetCloudStorageStatus(v string)` + +SetCloudStorageStatus sets CloudStorageStatus field to given value. + +### HasCloudStorageStatus + +`func (o *BackupResponse) HasCloudStorageStatus() bool` + +HasCloudStorageStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BaseAccess.md b/docs/tools/sdk/go/Reference/V3/Models/BaseAccess.md new file mode 100644 index 000000000..16184e9bc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BaseAccess.md @@ -0,0 +1,276 @@ +--- +id: base-access +title: BaseAccess +pagination_label: BaseAccess +sidebar_label: BaseAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseAccess', 'BaseAccess'] +slug: /tools/sdk/go/v3/models/base-access +tags: ['SDK', 'Software Development Kit', 'BaseAccess', 'BaseAccess'] +--- + +# BaseAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Access item's description. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **NullableTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Enabled** | Pointer to **bool** | Indicates whether the access item is currently enabled. | [optional] [default to false] +**Requestable** | Pointer to **bool** | Indicates whether the access item can be requested. | [optional] [default to true] +**RequestCommentsRequired** | Pointer to **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to false] +**Owner** | Pointer to [**BaseAccessOwner**](base-access-owner) | | [optional] + +## Methods + +### NewBaseAccess + +`func NewBaseAccess() *BaseAccess` + +NewBaseAccess instantiates a new BaseAccess 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 + +### NewBaseAccessWithDefaults + +`func NewBaseAccessWithDefaults() *BaseAccess` + +NewBaseAccessWithDefaults instantiates a new BaseAccess 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 + +### GetDescription + +`func (o *BaseAccess) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *BaseAccess) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *BaseAccess) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *BaseAccess) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetCreated + +`func (o *BaseAccess) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BaseAccess) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BaseAccess) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *BaseAccess) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *BaseAccess) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *BaseAccess) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *BaseAccess) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *BaseAccess) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *BaseAccess) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *BaseAccess) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *BaseAccess) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *BaseAccess) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *BaseAccess) GetSynced() SailPointTime` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *BaseAccess) GetSyncedOk() (*SailPointTime, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *BaseAccess) SetSynced(v SailPointTime)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *BaseAccess) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### SetSyncedNil + +`func (o *BaseAccess) SetSyncedNil(b bool)` + + SetSyncedNil sets the value for Synced to be an explicit nil + +### UnsetSynced +`func (o *BaseAccess) UnsetSynced()` + +UnsetSynced ensures that no value is present for Synced, not even an explicit nil +### GetEnabled + +`func (o *BaseAccess) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *BaseAccess) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *BaseAccess) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *BaseAccess) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetRequestable + +`func (o *BaseAccess) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *BaseAccess) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *BaseAccess) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *BaseAccess) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetRequestCommentsRequired + +`func (o *BaseAccess) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *BaseAccess) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *BaseAccess) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *BaseAccess) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + +### GetOwner + +`func (o *BaseAccess) GetOwner() BaseAccessOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *BaseAccess) GetOwnerOk() (*BaseAccessOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *BaseAccess) SetOwner(v BaseAccessOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *BaseAccess) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BaseAccessOwner.md b/docs/tools/sdk/go/Reference/V3/Models/BaseAccessOwner.md new file mode 100644 index 000000000..9dd5ebcba --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BaseAccessOwner.md @@ -0,0 +1,142 @@ +--- +id: base-access-owner +title: BaseAccessOwner +pagination_label: BaseAccessOwner +sidebar_label: BaseAccessOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseAccessOwner', 'BaseAccessOwner'] +slug: /tools/sdk/go/v3/models/base-access-owner +tags: ['SDK', 'Software Development Kit', 'BaseAccessOwner', 'BaseAccessOwner'] +--- + +# BaseAccessOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's DTO type. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's display name. | [optional] +**Email** | Pointer to **string** | Owner's email. | [optional] + +## Methods + +### NewBaseAccessOwner + +`func NewBaseAccessOwner() *BaseAccessOwner` + +NewBaseAccessOwner instantiates a new BaseAccessOwner 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 + +### NewBaseAccessOwnerWithDefaults + +`func NewBaseAccessOwnerWithDefaults() *BaseAccessOwner` + +NewBaseAccessOwnerWithDefaults instantiates a new BaseAccessOwner 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 + +### GetType + +`func (o *BaseAccessOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BaseAccessOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BaseAccessOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BaseAccessOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *BaseAccessOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseAccessOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseAccessOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseAccessOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseAccessOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseAccessOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseAccessOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseAccessOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *BaseAccessOwner) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *BaseAccessOwner) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *BaseAccessOwner) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *BaseAccessOwner) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BaseAccessProfile.md b/docs/tools/sdk/go/Reference/V3/Models/BaseAccessProfile.md new file mode 100644 index 000000000..67814a7fd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BaseAccessProfile.md @@ -0,0 +1,90 @@ +--- +id: base-access-profile +title: BaseAccessProfile +pagination_label: BaseAccessProfile +sidebar_label: BaseAccessProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseAccessProfile', 'BaseAccessProfile'] +slug: /tools/sdk/go/v3/models/base-access-profile +tags: ['SDK', 'Software Development Kit', 'BaseAccessProfile', 'BaseAccessProfile'] +--- + +# BaseAccessProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Access profile's unique ID. | [optional] +**Name** | Pointer to **string** | Access profile's display name. | [optional] + +## Methods + +### NewBaseAccessProfile + +`func NewBaseAccessProfile() *BaseAccessProfile` + +NewBaseAccessProfile instantiates a new BaseAccessProfile 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 + +### NewBaseAccessProfileWithDefaults + +`func NewBaseAccessProfileWithDefaults() *BaseAccessProfile` + +NewBaseAccessProfileWithDefaults instantiates a new BaseAccessProfile 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 + +### GetId + +`func (o *BaseAccessProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseAccessProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseAccessProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseAccessProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseAccessProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseAccessProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseAccessProfile) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseAccessProfile) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BaseAccount.md b/docs/tools/sdk/go/Reference/V3/Models/BaseAccount.md new file mode 100644 index 000000000..52eb828f5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BaseAccount.md @@ -0,0 +1,416 @@ +--- +id: base-account +title: BaseAccount +pagination_label: BaseAccount +sidebar_label: BaseAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseAccount', 'BaseAccount'] +slug: /tools/sdk/go/v3/models/base-account +tags: ['SDK', 'Software Development Kit', 'BaseAccount', 'BaseAccount'] +--- + +# BaseAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**AccountId** | Pointer to **string** | Account ID. | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] +**Disabled** | Pointer to **bool** | Indicates whether the account is disabled. | [optional] [default to false] +**Locked** | Pointer to **bool** | Indicates whether the account is locked. | [optional] [default to false] +**Privileged** | Pointer to **bool** | Indicates whether the account is privileged. | [optional] [default to false] +**ManuallyCorrelated** | Pointer to **bool** | Indicates whether the account has been manually correlated to an identity. | [optional] [default to false] +**PasswordLastSet** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**EntitlementAttributes** | Pointer to **map[string]interface{}** | Map or dictionary of key/value pairs. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**SupportsPasswordChange** | Pointer to **bool** | Indicates whether the account supports password change. | [optional] [default to false] +**AccountAttributes** | Pointer to **map[string]interface{}** | Map or dictionary of key/value pairs. | [optional] + +## Methods + +### NewBaseAccount + +`func NewBaseAccount() *BaseAccount` + +NewBaseAccount instantiates a new BaseAccount 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 + +### NewBaseAccountWithDefaults + +`func NewBaseAccountWithDefaults() *BaseAccount` + +NewBaseAccountWithDefaults instantiates a new BaseAccount 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 + +### GetId + +`func (o *BaseAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseAccount) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseAccount) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAccountId + +`func (o *BaseAccount) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *BaseAccount) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *BaseAccount) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *BaseAccount) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetSource + +`func (o *BaseAccount) GetSource() AccountSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *BaseAccount) GetSourceOk() (*AccountSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *BaseAccount) SetSource(v AccountSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *BaseAccount) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetDisabled + +`func (o *BaseAccount) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *BaseAccount) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *BaseAccount) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *BaseAccount) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetLocked + +`func (o *BaseAccount) GetLocked() bool` + +GetLocked returns the Locked field if non-nil, zero value otherwise. + +### GetLockedOk + +`func (o *BaseAccount) GetLockedOk() (*bool, bool)` + +GetLockedOk returns a tuple with the Locked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocked + +`func (o *BaseAccount) SetLocked(v bool)` + +SetLocked sets Locked field to given value. + +### HasLocked + +`func (o *BaseAccount) HasLocked() bool` + +HasLocked returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *BaseAccount) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *BaseAccount) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *BaseAccount) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *BaseAccount) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetManuallyCorrelated + +`func (o *BaseAccount) GetManuallyCorrelated() bool` + +GetManuallyCorrelated returns the ManuallyCorrelated field if non-nil, zero value otherwise. + +### GetManuallyCorrelatedOk + +`func (o *BaseAccount) GetManuallyCorrelatedOk() (*bool, bool)` + +GetManuallyCorrelatedOk returns a tuple with the ManuallyCorrelated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyCorrelated + +`func (o *BaseAccount) SetManuallyCorrelated(v bool)` + +SetManuallyCorrelated sets ManuallyCorrelated field to given value. + +### HasManuallyCorrelated + +`func (o *BaseAccount) HasManuallyCorrelated() bool` + +HasManuallyCorrelated returns a boolean if a field has been set. + +### GetPasswordLastSet + +`func (o *BaseAccount) GetPasswordLastSet() SailPointTime` + +GetPasswordLastSet returns the PasswordLastSet field if non-nil, zero value otherwise. + +### GetPasswordLastSetOk + +`func (o *BaseAccount) GetPasswordLastSetOk() (*SailPointTime, bool)` + +GetPasswordLastSetOk returns a tuple with the PasswordLastSet field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordLastSet + +`func (o *BaseAccount) SetPasswordLastSet(v SailPointTime)` + +SetPasswordLastSet sets PasswordLastSet field to given value. + +### HasPasswordLastSet + +`func (o *BaseAccount) HasPasswordLastSet() bool` + +HasPasswordLastSet returns a boolean if a field has been set. + +### SetPasswordLastSetNil + +`func (o *BaseAccount) SetPasswordLastSetNil(b bool)` + + SetPasswordLastSetNil sets the value for PasswordLastSet to be an explicit nil + +### UnsetPasswordLastSet +`func (o *BaseAccount) UnsetPasswordLastSet()` + +UnsetPasswordLastSet ensures that no value is present for PasswordLastSet, not even an explicit nil +### GetEntitlementAttributes + +`func (o *BaseAccount) GetEntitlementAttributes() map[string]interface{}` + +GetEntitlementAttributes returns the EntitlementAttributes field if non-nil, zero value otherwise. + +### GetEntitlementAttributesOk + +`func (o *BaseAccount) GetEntitlementAttributesOk() (*map[string]interface{}, bool)` + +GetEntitlementAttributesOk returns a tuple with the EntitlementAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementAttributes + +`func (o *BaseAccount) SetEntitlementAttributes(v map[string]interface{})` + +SetEntitlementAttributes sets EntitlementAttributes field to given value. + +### HasEntitlementAttributes + +`func (o *BaseAccount) HasEntitlementAttributes() bool` + +HasEntitlementAttributes returns a boolean if a field has been set. + +### SetEntitlementAttributesNil + +`func (o *BaseAccount) SetEntitlementAttributesNil(b bool)` + + SetEntitlementAttributesNil sets the value for EntitlementAttributes to be an explicit nil + +### UnsetEntitlementAttributes +`func (o *BaseAccount) UnsetEntitlementAttributes()` + +UnsetEntitlementAttributes ensures that no value is present for EntitlementAttributes, not even an explicit nil +### GetCreated + +`func (o *BaseAccount) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BaseAccount) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BaseAccount) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *BaseAccount) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *BaseAccount) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *BaseAccount) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetSupportsPasswordChange + +`func (o *BaseAccount) GetSupportsPasswordChange() bool` + +GetSupportsPasswordChange returns the SupportsPasswordChange field if non-nil, zero value otherwise. + +### GetSupportsPasswordChangeOk + +`func (o *BaseAccount) GetSupportsPasswordChangeOk() (*bool, bool)` + +GetSupportsPasswordChangeOk returns a tuple with the SupportsPasswordChange field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportsPasswordChange + +`func (o *BaseAccount) SetSupportsPasswordChange(v bool)` + +SetSupportsPasswordChange sets SupportsPasswordChange field to given value. + +### HasSupportsPasswordChange + +`func (o *BaseAccount) HasSupportsPasswordChange() bool` + +HasSupportsPasswordChange returns a boolean if a field has been set. + +### GetAccountAttributes + +`func (o *BaseAccount) GetAccountAttributes() map[string]interface{}` + +GetAccountAttributes returns the AccountAttributes field if non-nil, zero value otherwise. + +### GetAccountAttributesOk + +`func (o *BaseAccount) GetAccountAttributesOk() (*map[string]interface{}, bool)` + +GetAccountAttributesOk returns a tuple with the AccountAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountAttributes + +`func (o *BaseAccount) SetAccountAttributes(v map[string]interface{})` + +SetAccountAttributes sets AccountAttributes field to given value. + +### HasAccountAttributes + +`func (o *BaseAccount) HasAccountAttributes() bool` + +HasAccountAttributes returns a boolean if a field has been set. + +### SetAccountAttributesNil + +`func (o *BaseAccount) SetAccountAttributesNil(b bool)` + + SetAccountAttributesNil sets the value for AccountAttributes to be an explicit nil + +### UnsetAccountAttributes +`func (o *BaseAccount) UnsetAccountAttributes()` + +UnsetAccountAttributes ensures that no value is present for AccountAttributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BaseCommonDto.md b/docs/tools/sdk/go/Reference/V3/Models/BaseCommonDto.md new file mode 100644 index 000000000..3d1076167 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BaseCommonDto.md @@ -0,0 +1,147 @@ +--- +id: base-common-dto +title: BaseCommonDto +pagination_label: BaseCommonDto +sidebar_label: BaseCommonDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseCommonDto', 'BaseCommonDto'] +slug: /tools/sdk/go/v3/models/base-common-dto +tags: ['SDK', 'Software Development Kit', 'BaseCommonDto', 'BaseCommonDto'] +--- + +# BaseCommonDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] + +## Methods + +### NewBaseCommonDto + +`func NewBaseCommonDto(name NullableString, ) *BaseCommonDto` + +NewBaseCommonDto instantiates a new BaseCommonDto 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 + +### NewBaseCommonDtoWithDefaults + +`func NewBaseCommonDtoWithDefaults() *BaseCommonDto` + +NewBaseCommonDtoWithDefaults instantiates a new BaseCommonDto 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 + +### GetId + +`func (o *BaseCommonDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseCommonDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseCommonDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseCommonDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseCommonDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseCommonDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseCommonDto) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *BaseCommonDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *BaseCommonDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *BaseCommonDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *BaseCommonDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *BaseCommonDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *BaseCommonDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *BaseCommonDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *BaseCommonDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *BaseCommonDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *BaseCommonDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BaseDocument.md b/docs/tools/sdk/go/Reference/V3/Models/BaseDocument.md new file mode 100644 index 000000000..15da840dd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BaseDocument.md @@ -0,0 +1,80 @@ +--- +id: base-document +title: BaseDocument +pagination_label: BaseDocument +sidebar_label: BaseDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseDocument', 'BaseDocument'] +slug: /tools/sdk/go/v3/models/base-document +tags: ['SDK', 'Software Development Kit', 'BaseDocument', 'BaseDocument'] +--- + +# BaseDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the referenced object. | +**Name** | **string** | The human readable name of the referenced object. | + +## Methods + +### NewBaseDocument + +`func NewBaseDocument(id string, name string, ) *BaseDocument` + +NewBaseDocument instantiates a new BaseDocument 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 + +### NewBaseDocumentWithDefaults + +`func NewBaseDocumentWithDefaults() *BaseDocument` + +NewBaseDocumentWithDefaults instantiates a new BaseDocument 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 + +### GetId + +`func (o *BaseDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseDocument) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *BaseDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseDocument) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BaseEntitlement.md b/docs/tools/sdk/go/Reference/V3/Models/BaseEntitlement.md new file mode 100644 index 000000000..f4eb40970 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BaseEntitlement.md @@ -0,0 +1,256 @@ +--- +id: base-entitlement +title: BaseEntitlement +pagination_label: BaseEntitlement +sidebar_label: BaseEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseEntitlement', 'BaseEntitlement'] +slug: /tools/sdk/go/v3/models/base-entitlement +tags: ['SDK', 'Software Development Kit', 'BaseEntitlement', 'BaseEntitlement'] +--- + +# BaseEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasPermissions** | Pointer to **bool** | Indicates whether the entitlement has permissions. | [optional] [default to false] +**Description** | Pointer to **NullableString** | Entitlement's description. | [optional] +**Attribute** | Pointer to **string** | Entitlement attribute's name. | [optional] +**Value** | Pointer to **string** | Entitlement's value. | [optional] +**Schema** | Pointer to **string** | Entitlement's schema. | [optional] +**Privileged** | Pointer to **bool** | Indicates whether the entitlement is privileged. | [optional] [default to false] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **string** | Entitlement's name. | [optional] + +## Methods + +### NewBaseEntitlement + +`func NewBaseEntitlement() *BaseEntitlement` + +NewBaseEntitlement instantiates a new BaseEntitlement 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 + +### NewBaseEntitlementWithDefaults + +`func NewBaseEntitlementWithDefaults() *BaseEntitlement` + +NewBaseEntitlementWithDefaults instantiates a new BaseEntitlement 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 + +### GetHasPermissions + +`func (o *BaseEntitlement) GetHasPermissions() bool` + +GetHasPermissions returns the HasPermissions field if non-nil, zero value otherwise. + +### GetHasPermissionsOk + +`func (o *BaseEntitlement) GetHasPermissionsOk() (*bool, bool)` + +GetHasPermissionsOk returns a tuple with the HasPermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasPermissions + +`func (o *BaseEntitlement) SetHasPermissions(v bool)` + +SetHasPermissions sets HasPermissions field to given value. + +### HasHasPermissions + +`func (o *BaseEntitlement) HasHasPermissions() bool` + +HasHasPermissions returns a boolean if a field has been set. + +### GetDescription + +`func (o *BaseEntitlement) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *BaseEntitlement) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *BaseEntitlement) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *BaseEntitlement) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *BaseEntitlement) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *BaseEntitlement) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAttribute + +`func (o *BaseEntitlement) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *BaseEntitlement) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *BaseEntitlement) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *BaseEntitlement) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *BaseEntitlement) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *BaseEntitlement) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *BaseEntitlement) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *BaseEntitlement) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSchema + +`func (o *BaseEntitlement) GetSchema() string` + +GetSchema returns the Schema field if non-nil, zero value otherwise. + +### GetSchemaOk + +`func (o *BaseEntitlement) GetSchemaOk() (*string, bool)` + +GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchema + +`func (o *BaseEntitlement) SetSchema(v string)` + +SetSchema sets Schema field to given value. + +### HasSchema + +`func (o *BaseEntitlement) HasSchema() bool` + +HasSchema returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *BaseEntitlement) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *BaseEntitlement) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *BaseEntitlement) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *BaseEntitlement) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetId + +`func (o *BaseEntitlement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseEntitlement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseEntitlement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseEntitlement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseEntitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseEntitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseEntitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseEntitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BaseReferenceDto.md b/docs/tools/sdk/go/Reference/V3/Models/BaseReferenceDto.md new file mode 100644 index 000000000..0dcb2d890 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BaseReferenceDto.md @@ -0,0 +1,116 @@ +--- +id: base-reference-dto +title: BaseReferenceDto +pagination_label: BaseReferenceDto +sidebar_label: BaseReferenceDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseReferenceDto', 'BaseReferenceDto'] +slug: /tools/sdk/go/v3/models/base-reference-dto +tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto', 'BaseReferenceDto'] +--- + +# BaseReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewBaseReferenceDto + +`func NewBaseReferenceDto() *BaseReferenceDto` + +NewBaseReferenceDto instantiates a new BaseReferenceDto 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 + +### NewBaseReferenceDtoWithDefaults + +`func NewBaseReferenceDtoWithDefaults() *BaseReferenceDto` + +NewBaseReferenceDtoWithDefaults instantiates a new BaseReferenceDto 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 + +### GetType + +`func (o *BaseReferenceDto) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BaseReferenceDto) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BaseReferenceDto) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BaseReferenceDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *BaseReferenceDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseReferenceDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseReferenceDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseReferenceDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseReferenceDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseReferenceDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseReferenceDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseReferenceDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BaseSegment.md b/docs/tools/sdk/go/Reference/V3/Models/BaseSegment.md new file mode 100644 index 000000000..972602c19 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BaseSegment.md @@ -0,0 +1,90 @@ +--- +id: base-segment +title: BaseSegment +pagination_label: BaseSegment +sidebar_label: BaseSegment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BaseSegment', 'BaseSegment'] +slug: /tools/sdk/go/v3/models/base-segment +tags: ['SDK', 'Software Development Kit', 'BaseSegment', 'BaseSegment'] +--- + +# BaseSegment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Segment's unique ID. | [optional] +**Name** | Pointer to **string** | Segment's display name. | [optional] + +## Methods + +### NewBaseSegment + +`func NewBaseSegment() *BaseSegment` + +NewBaseSegment instantiates a new BaseSegment 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 + +### NewBaseSegmentWithDefaults + +`func NewBaseSegmentWithDefaults() *BaseSegment` + +NewBaseSegmentWithDefaults instantiates a new BaseSegment 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 + +### GetId + +`func (o *BaseSegment) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseSegment) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseSegment) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseSegment) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseSegment) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseSegment) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseSegment) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseSegment) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BeforeProvisioningRuleDto.md b/docs/tools/sdk/go/Reference/V3/Models/BeforeProvisioningRuleDto.md new file mode 100644 index 000000000..e983fe579 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BeforeProvisioningRuleDto.md @@ -0,0 +1,116 @@ +--- +id: before-provisioning-rule-dto +title: BeforeProvisioningRuleDto +pagination_label: BeforeProvisioningRuleDto +sidebar_label: BeforeProvisioningRuleDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BeforeProvisioningRuleDto', 'BeforeProvisioningRuleDto'] +slug: /tools/sdk/go/v3/models/before-provisioning-rule-dto +tags: ['SDK', 'Software Development Kit', 'BeforeProvisioningRuleDto', 'BeforeProvisioningRuleDto'] +--- + +# BeforeProvisioningRuleDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Before Provisioning Rule DTO type. | [optional] +**Id** | Pointer to **string** | Before Provisioning Rule ID. | [optional] +**Name** | Pointer to **string** | Rule display name. | [optional] + +## Methods + +### NewBeforeProvisioningRuleDto + +`func NewBeforeProvisioningRuleDto() *BeforeProvisioningRuleDto` + +NewBeforeProvisioningRuleDto instantiates a new BeforeProvisioningRuleDto 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 + +### NewBeforeProvisioningRuleDtoWithDefaults + +`func NewBeforeProvisioningRuleDtoWithDefaults() *BeforeProvisioningRuleDto` + +NewBeforeProvisioningRuleDtoWithDefaults instantiates a new BeforeProvisioningRuleDto 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 + +### GetType + +`func (o *BeforeProvisioningRuleDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BeforeProvisioningRuleDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BeforeProvisioningRuleDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BeforeProvisioningRuleDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *BeforeProvisioningRuleDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BeforeProvisioningRuleDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BeforeProvisioningRuleDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BeforeProvisioningRuleDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BeforeProvisioningRuleDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BeforeProvisioningRuleDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BeforeProvisioningRuleDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BeforeProvisioningRuleDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Bound.md b/docs/tools/sdk/go/Reference/V3/Models/Bound.md new file mode 100644 index 000000000..56c18a3f1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Bound.md @@ -0,0 +1,85 @@ +--- +id: bound +title: Bound +pagination_label: Bound +sidebar_label: Bound +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Bound', 'Bound'] +slug: /tools/sdk/go/v3/models/bound +tags: ['SDK', 'Software Development Kit', 'Bound', 'Bound'] +--- + +# Bound + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | **string** | The value of the range's endpoint. | +**Inclusive** | Pointer to **bool** | Indicates if the endpoint is included in the range. | [optional] [default to false] + +## Methods + +### NewBound + +`func NewBound(value string, ) *Bound` + +NewBound instantiates a new Bound 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 + +### NewBoundWithDefaults + +`func NewBoundWithDefaults() *Bound` + +NewBoundWithDefaults instantiates a new Bound 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 + +### GetValue + +`func (o *Bound) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Bound) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Bound) SetValue(v string)` + +SetValue sets Value field to given value. + + +### GetInclusive + +`func (o *Bound) GetInclusive() bool` + +GetInclusive returns the Inclusive field if non-nil, zero value otherwise. + +### GetInclusiveOk + +`func (o *Bound) GetInclusiveOk() (*bool, bool)` + +GetInclusiveOk returns a tuple with the Inclusive field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInclusive + +`func (o *Bound) SetInclusive(v bool)` + +SetInclusive sets Inclusive field to given value. + +### HasInclusive + +`func (o *Bound) HasInclusive() bool` + +HasInclusive returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BrandingItem.md b/docs/tools/sdk/go/Reference/V3/Models/BrandingItem.md new file mode 100644 index 000000000..967d57219 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BrandingItem.md @@ -0,0 +1,316 @@ +--- +id: branding-item +title: BrandingItem +pagination_label: BrandingItem +sidebar_label: BrandingItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BrandingItem', 'BrandingItem'] +slug: /tools/sdk/go/v3/models/branding-item +tags: ['SDK', 'Software Development Kit', 'BrandingItem', 'BrandingItem'] +--- + +# BrandingItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | name of branding item | [optional] +**ProductName** | Pointer to **NullableString** | product name | [optional] +**ActionButtonColor** | Pointer to **NullableString** | hex value of color for action button | [optional] +**ActiveLinkColor** | Pointer to **NullableString** | hex value of color for link | [optional] +**NavigationColor** | Pointer to **NullableString** | hex value of color for navigation bar | [optional] +**EmailFromAddress** | Pointer to **NullableString** | email from address | [optional] +**StandardLogoURL** | Pointer to **NullableString** | url to standard logo | [optional] +**LoginInformationalMessage** | Pointer to **NullableString** | login information message | [optional] + +## Methods + +### NewBrandingItem + +`func NewBrandingItem() *BrandingItem` + +NewBrandingItem instantiates a new BrandingItem 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 + +### NewBrandingItemWithDefaults + +`func NewBrandingItemWithDefaults() *BrandingItem` + +NewBrandingItemWithDefaults instantiates a new BrandingItem 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 + +### GetName + +`func (o *BrandingItem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BrandingItem) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BrandingItem) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BrandingItem) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetProductName + +`func (o *BrandingItem) GetProductName() string` + +GetProductName returns the ProductName field if non-nil, zero value otherwise. + +### GetProductNameOk + +`func (o *BrandingItem) GetProductNameOk() (*string, bool)` + +GetProductNameOk returns a tuple with the ProductName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductName + +`func (o *BrandingItem) SetProductName(v string)` + +SetProductName sets ProductName field to given value. + +### HasProductName + +`func (o *BrandingItem) HasProductName() bool` + +HasProductName returns a boolean if a field has been set. + +### SetProductNameNil + +`func (o *BrandingItem) SetProductNameNil(b bool)` + + SetProductNameNil sets the value for ProductName to be an explicit nil + +### UnsetProductName +`func (o *BrandingItem) UnsetProductName()` + +UnsetProductName ensures that no value is present for ProductName, not even an explicit nil +### GetActionButtonColor + +`func (o *BrandingItem) GetActionButtonColor() string` + +GetActionButtonColor returns the ActionButtonColor field if non-nil, zero value otherwise. + +### GetActionButtonColorOk + +`func (o *BrandingItem) GetActionButtonColorOk() (*string, bool)` + +GetActionButtonColorOk returns a tuple with the ActionButtonColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActionButtonColor + +`func (o *BrandingItem) SetActionButtonColor(v string)` + +SetActionButtonColor sets ActionButtonColor field to given value. + +### HasActionButtonColor + +`func (o *BrandingItem) HasActionButtonColor() bool` + +HasActionButtonColor returns a boolean if a field has been set. + +### SetActionButtonColorNil + +`func (o *BrandingItem) SetActionButtonColorNil(b bool)` + + SetActionButtonColorNil sets the value for ActionButtonColor to be an explicit nil + +### UnsetActionButtonColor +`func (o *BrandingItem) UnsetActionButtonColor()` + +UnsetActionButtonColor ensures that no value is present for ActionButtonColor, not even an explicit nil +### GetActiveLinkColor + +`func (o *BrandingItem) GetActiveLinkColor() string` + +GetActiveLinkColor returns the ActiveLinkColor field if non-nil, zero value otherwise. + +### GetActiveLinkColorOk + +`func (o *BrandingItem) GetActiveLinkColorOk() (*string, bool)` + +GetActiveLinkColorOk returns a tuple with the ActiveLinkColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActiveLinkColor + +`func (o *BrandingItem) SetActiveLinkColor(v string)` + +SetActiveLinkColor sets ActiveLinkColor field to given value. + +### HasActiveLinkColor + +`func (o *BrandingItem) HasActiveLinkColor() bool` + +HasActiveLinkColor returns a boolean if a field has been set. + +### SetActiveLinkColorNil + +`func (o *BrandingItem) SetActiveLinkColorNil(b bool)` + + SetActiveLinkColorNil sets the value for ActiveLinkColor to be an explicit nil + +### UnsetActiveLinkColor +`func (o *BrandingItem) UnsetActiveLinkColor()` + +UnsetActiveLinkColor ensures that no value is present for ActiveLinkColor, not even an explicit nil +### GetNavigationColor + +`func (o *BrandingItem) GetNavigationColor() string` + +GetNavigationColor returns the NavigationColor field if non-nil, zero value otherwise. + +### GetNavigationColorOk + +`func (o *BrandingItem) GetNavigationColorOk() (*string, bool)` + +GetNavigationColorOk returns a tuple with the NavigationColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNavigationColor + +`func (o *BrandingItem) SetNavigationColor(v string)` + +SetNavigationColor sets NavigationColor field to given value. + +### HasNavigationColor + +`func (o *BrandingItem) HasNavigationColor() bool` + +HasNavigationColor returns a boolean if a field has been set. + +### SetNavigationColorNil + +`func (o *BrandingItem) SetNavigationColorNil(b bool)` + + SetNavigationColorNil sets the value for NavigationColor to be an explicit nil + +### UnsetNavigationColor +`func (o *BrandingItem) UnsetNavigationColor()` + +UnsetNavigationColor ensures that no value is present for NavigationColor, not even an explicit nil +### GetEmailFromAddress + +`func (o *BrandingItem) GetEmailFromAddress() string` + +GetEmailFromAddress returns the EmailFromAddress field if non-nil, zero value otherwise. + +### GetEmailFromAddressOk + +`func (o *BrandingItem) GetEmailFromAddressOk() (*string, bool)` + +GetEmailFromAddressOk returns a tuple with the EmailFromAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailFromAddress + +`func (o *BrandingItem) SetEmailFromAddress(v string)` + +SetEmailFromAddress sets EmailFromAddress field to given value. + +### HasEmailFromAddress + +`func (o *BrandingItem) HasEmailFromAddress() bool` + +HasEmailFromAddress returns a boolean if a field has been set. + +### SetEmailFromAddressNil + +`func (o *BrandingItem) SetEmailFromAddressNil(b bool)` + + SetEmailFromAddressNil sets the value for EmailFromAddress to be an explicit nil + +### UnsetEmailFromAddress +`func (o *BrandingItem) UnsetEmailFromAddress()` + +UnsetEmailFromAddress ensures that no value is present for EmailFromAddress, not even an explicit nil +### GetStandardLogoURL + +`func (o *BrandingItem) GetStandardLogoURL() string` + +GetStandardLogoURL returns the StandardLogoURL field if non-nil, zero value otherwise. + +### GetStandardLogoURLOk + +`func (o *BrandingItem) GetStandardLogoURLOk() (*string, bool)` + +GetStandardLogoURLOk returns a tuple with the StandardLogoURL field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandardLogoURL + +`func (o *BrandingItem) SetStandardLogoURL(v string)` + +SetStandardLogoURL sets StandardLogoURL field to given value. + +### HasStandardLogoURL + +`func (o *BrandingItem) HasStandardLogoURL() bool` + +HasStandardLogoURL returns a boolean if a field has been set. + +### SetStandardLogoURLNil + +`func (o *BrandingItem) SetStandardLogoURLNil(b bool)` + + SetStandardLogoURLNil sets the value for StandardLogoURL to be an explicit nil + +### UnsetStandardLogoURL +`func (o *BrandingItem) UnsetStandardLogoURL()` + +UnsetStandardLogoURL ensures that no value is present for StandardLogoURL, not even an explicit nil +### GetLoginInformationalMessage + +`func (o *BrandingItem) GetLoginInformationalMessage() string` + +GetLoginInformationalMessage returns the LoginInformationalMessage field if non-nil, zero value otherwise. + +### GetLoginInformationalMessageOk + +`func (o *BrandingItem) GetLoginInformationalMessageOk() (*string, bool)` + +GetLoginInformationalMessageOk returns a tuple with the LoginInformationalMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginInformationalMessage + +`func (o *BrandingItem) SetLoginInformationalMessage(v string)` + +SetLoginInformationalMessage sets LoginInformationalMessage field to given value. + +### HasLoginInformationalMessage + +`func (o *BrandingItem) HasLoginInformationalMessage() bool` + +HasLoginInformationalMessage returns a boolean if a field has been set. + +### SetLoginInformationalMessageNil + +`func (o *BrandingItem) SetLoginInformationalMessageNil(b bool)` + + SetLoginInformationalMessageNil sets the value for LoginInformationalMessage to be an explicit nil + +### UnsetLoginInformationalMessage +`func (o *BrandingItem) UnsetLoginInformationalMessage()` + +UnsetLoginInformationalMessage ensures that no value is present for LoginInformationalMessage, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BrandingItemCreate.md b/docs/tools/sdk/go/Reference/V3/Models/BrandingItemCreate.md new file mode 100644 index 000000000..2c2412cf3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BrandingItemCreate.md @@ -0,0 +1,246 @@ +--- +id: branding-item-create +title: BrandingItemCreate +pagination_label: BrandingItemCreate +sidebar_label: BrandingItemCreate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BrandingItemCreate', 'BrandingItemCreate'] +slug: /tools/sdk/go/v3/models/branding-item-create +tags: ['SDK', 'Software Development Kit', 'BrandingItemCreate', 'BrandingItemCreate'] +--- + +# BrandingItemCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | name of branding item | +**ProductName** | **NullableString** | product name | +**ActionButtonColor** | Pointer to **string** | hex value of color for action button | [optional] +**ActiveLinkColor** | Pointer to **string** | hex value of color for link | [optional] +**NavigationColor** | Pointer to **string** | hex value of color for navigation bar | [optional] +**EmailFromAddress** | Pointer to **string** | email from address | [optional] +**LoginInformationalMessage** | Pointer to **string** | login information message | [optional] +**FileStandard** | Pointer to ***os.File** | png file with logo | [optional] + +## Methods + +### NewBrandingItemCreate + +`func NewBrandingItemCreate(name string, productName NullableString, ) *BrandingItemCreate` + +NewBrandingItemCreate instantiates a new BrandingItemCreate 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 + +### NewBrandingItemCreateWithDefaults + +`func NewBrandingItemCreateWithDefaults() *BrandingItemCreate` + +NewBrandingItemCreateWithDefaults instantiates a new BrandingItemCreate 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 + +### GetName + +`func (o *BrandingItemCreate) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BrandingItemCreate) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BrandingItemCreate) SetName(v string)` + +SetName sets Name field to given value. + + +### GetProductName + +`func (o *BrandingItemCreate) GetProductName() string` + +GetProductName returns the ProductName field if non-nil, zero value otherwise. + +### GetProductNameOk + +`func (o *BrandingItemCreate) GetProductNameOk() (*string, bool)` + +GetProductNameOk returns a tuple with the ProductName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProductName + +`func (o *BrandingItemCreate) SetProductName(v string)` + +SetProductName sets ProductName field to given value. + + +### SetProductNameNil + +`func (o *BrandingItemCreate) SetProductNameNil(b bool)` + + SetProductNameNil sets the value for ProductName to be an explicit nil + +### UnsetProductName +`func (o *BrandingItemCreate) UnsetProductName()` + +UnsetProductName ensures that no value is present for ProductName, not even an explicit nil +### GetActionButtonColor + +`func (o *BrandingItemCreate) GetActionButtonColor() string` + +GetActionButtonColor returns the ActionButtonColor field if non-nil, zero value otherwise. + +### GetActionButtonColorOk + +`func (o *BrandingItemCreate) GetActionButtonColorOk() (*string, bool)` + +GetActionButtonColorOk returns a tuple with the ActionButtonColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActionButtonColor + +`func (o *BrandingItemCreate) SetActionButtonColor(v string)` + +SetActionButtonColor sets ActionButtonColor field to given value. + +### HasActionButtonColor + +`func (o *BrandingItemCreate) HasActionButtonColor() bool` + +HasActionButtonColor returns a boolean if a field has been set. + +### GetActiveLinkColor + +`func (o *BrandingItemCreate) GetActiveLinkColor() string` + +GetActiveLinkColor returns the ActiveLinkColor field if non-nil, zero value otherwise. + +### GetActiveLinkColorOk + +`func (o *BrandingItemCreate) GetActiveLinkColorOk() (*string, bool)` + +GetActiveLinkColorOk returns a tuple with the ActiveLinkColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActiveLinkColor + +`func (o *BrandingItemCreate) SetActiveLinkColor(v string)` + +SetActiveLinkColor sets ActiveLinkColor field to given value. + +### HasActiveLinkColor + +`func (o *BrandingItemCreate) HasActiveLinkColor() bool` + +HasActiveLinkColor returns a boolean if a field has been set. + +### GetNavigationColor + +`func (o *BrandingItemCreate) GetNavigationColor() string` + +GetNavigationColor returns the NavigationColor field if non-nil, zero value otherwise. + +### GetNavigationColorOk + +`func (o *BrandingItemCreate) GetNavigationColorOk() (*string, bool)` + +GetNavigationColorOk returns a tuple with the NavigationColor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNavigationColor + +`func (o *BrandingItemCreate) SetNavigationColor(v string)` + +SetNavigationColor sets NavigationColor field to given value. + +### HasNavigationColor + +`func (o *BrandingItemCreate) HasNavigationColor() bool` + +HasNavigationColor returns a boolean if a field has been set. + +### GetEmailFromAddress + +`func (o *BrandingItemCreate) GetEmailFromAddress() string` + +GetEmailFromAddress returns the EmailFromAddress field if non-nil, zero value otherwise. + +### GetEmailFromAddressOk + +`func (o *BrandingItemCreate) GetEmailFromAddressOk() (*string, bool)` + +GetEmailFromAddressOk returns a tuple with the EmailFromAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailFromAddress + +`func (o *BrandingItemCreate) SetEmailFromAddress(v string)` + +SetEmailFromAddress sets EmailFromAddress field to given value. + +### HasEmailFromAddress + +`func (o *BrandingItemCreate) HasEmailFromAddress() bool` + +HasEmailFromAddress returns a boolean if a field has been set. + +### GetLoginInformationalMessage + +`func (o *BrandingItemCreate) GetLoginInformationalMessage() string` + +GetLoginInformationalMessage returns the LoginInformationalMessage field if non-nil, zero value otherwise. + +### GetLoginInformationalMessageOk + +`func (o *BrandingItemCreate) GetLoginInformationalMessageOk() (*string, bool)` + +GetLoginInformationalMessageOk returns a tuple with the LoginInformationalMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginInformationalMessage + +`func (o *BrandingItemCreate) SetLoginInformationalMessage(v string)` + +SetLoginInformationalMessage sets LoginInformationalMessage field to given value. + +### HasLoginInformationalMessage + +`func (o *BrandingItemCreate) HasLoginInformationalMessage() bool` + +HasLoginInformationalMessage returns a boolean if a field has been set. + +### GetFileStandard + +`func (o *BrandingItemCreate) GetFileStandard() *os.File` + +GetFileStandard returns the FileStandard field if non-nil, zero value otherwise. + +### GetFileStandardOk + +`func (o *BrandingItemCreate) GetFileStandardOk() (**os.File, bool)` + +GetFileStandardOk returns a tuple with the FileStandard field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileStandard + +`func (o *BrandingItemCreate) SetFileStandard(v *os.File)` + +SetFileStandard sets FileStandard field to given value. + +### HasFileStandard + +`func (o *BrandingItemCreate) HasFileStandard() bool` + +HasFileStandard returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BucketAggregation.md b/docs/tools/sdk/go/Reference/V3/Models/BucketAggregation.md new file mode 100644 index 000000000..38a857b46 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BucketAggregation.md @@ -0,0 +1,158 @@ +--- +id: bucket-aggregation +title: BucketAggregation +pagination_label: BucketAggregation +sidebar_label: BucketAggregation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BucketAggregation', 'BucketAggregation'] +slug: /tools/sdk/go/v3/models/bucket-aggregation +tags: ['SDK', 'Software Development Kit', 'BucketAggregation', 'BucketAggregation'] +--- + +# BucketAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the bucket aggregate to be included in the result. | +**Type** | Pointer to [**BucketType**](bucket-type) | | [optional] [default to BUCKETTYPE_TERMS] +**Field** | **string** | The field to bucket on. Prefix the field name with '@' to reference a nested object. | +**Size** | Pointer to **int32** | Maximum number of buckets to include. | [optional] +**MinDocCount** | Pointer to **int32** | Minimum number of documents a bucket should have. | [optional] + +## Methods + +### NewBucketAggregation + +`func NewBucketAggregation(name string, field string, ) *BucketAggregation` + +NewBucketAggregation instantiates a new BucketAggregation 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 + +### NewBucketAggregationWithDefaults + +`func NewBucketAggregationWithDefaults() *BucketAggregation` + +NewBucketAggregationWithDefaults instantiates a new BucketAggregation 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 + +### GetName + +`func (o *BucketAggregation) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BucketAggregation) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BucketAggregation) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *BucketAggregation) GetType() BucketType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *BucketAggregation) GetTypeOk() (*BucketType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *BucketAggregation) SetType(v BucketType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *BucketAggregation) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetField + +`func (o *BucketAggregation) GetField() string` + +GetField returns the Field field if non-nil, zero value otherwise. + +### GetFieldOk + +`func (o *BucketAggregation) GetFieldOk() (*string, bool)` + +GetFieldOk returns a tuple with the Field field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetField + +`func (o *BucketAggregation) SetField(v string)` + +SetField sets Field field to given value. + + +### GetSize + +`func (o *BucketAggregation) GetSize() int32` + +GetSize returns the Size field if non-nil, zero value otherwise. + +### GetSizeOk + +`func (o *BucketAggregation) GetSizeOk() (*int32, bool)` + +GetSizeOk returns a tuple with the Size field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSize + +`func (o *BucketAggregation) SetSize(v int32)` + +SetSize sets Size field to given value. + +### HasSize + +`func (o *BucketAggregation) HasSize() bool` + +HasSize returns a boolean if a field has been set. + +### GetMinDocCount + +`func (o *BucketAggregation) GetMinDocCount() int32` + +GetMinDocCount returns the MinDocCount field if non-nil, zero value otherwise. + +### GetMinDocCountOk + +`func (o *BucketAggregation) GetMinDocCountOk() (*int32, bool)` + +GetMinDocCountOk returns a tuple with the MinDocCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinDocCount + +`func (o *BucketAggregation) SetMinDocCount(v int32)` + +SetMinDocCount sets MinDocCount field to given value. + +### HasMinDocCount + +`func (o *BucketAggregation) HasMinDocCount() bool` + +HasMinDocCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BucketType.md b/docs/tools/sdk/go/Reference/V3/Models/BucketType.md new file mode 100644 index 000000000..762be2fa6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BucketType.md @@ -0,0 +1,19 @@ +--- +id: bucket-type +title: BucketType +pagination_label: BucketType +sidebar_label: BucketType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BucketType', 'BucketType'] +slug: /tools/sdk/go/v3/models/bucket-type +tags: ['SDK', 'Software Development Kit', 'BucketType', 'BucketType'] +--- + +# BucketType + +## Enum + + +* `TERMS` (value: `"TERMS"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BulkAddTaggedObject.md b/docs/tools/sdk/go/Reference/V3/Models/BulkAddTaggedObject.md new file mode 100644 index 000000000..545038295 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BulkAddTaggedObject.md @@ -0,0 +1,116 @@ +--- +id: bulk-add-tagged-object +title: BulkAddTaggedObject +pagination_label: BulkAddTaggedObject +sidebar_label: BulkAddTaggedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkAddTaggedObject', 'BulkAddTaggedObject'] +slug: /tools/sdk/go/v3/models/bulk-add-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkAddTaggedObject', 'BulkAddTaggedObject'] +--- + +# BulkAddTaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]string** | Label to be applied to an Object | [optional] +**Operation** | Pointer to **string** | If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. | [optional] [default to "APPEND"] + +## Methods + +### NewBulkAddTaggedObject + +`func NewBulkAddTaggedObject() *BulkAddTaggedObject` + +NewBulkAddTaggedObject instantiates a new BulkAddTaggedObject 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 + +### NewBulkAddTaggedObjectWithDefaults + +`func NewBulkAddTaggedObjectWithDefaults() *BulkAddTaggedObject` + +NewBulkAddTaggedObjectWithDefaults instantiates a new BulkAddTaggedObject 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 + +### GetObjectRefs + +`func (o *BulkAddTaggedObject) GetObjectRefs() []TaggedObjectDto` + +GetObjectRefs returns the ObjectRefs field if non-nil, zero value otherwise. + +### GetObjectRefsOk + +`func (o *BulkAddTaggedObject) GetObjectRefsOk() (*[]TaggedObjectDto, bool)` + +GetObjectRefsOk returns a tuple with the ObjectRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectRefs + +`func (o *BulkAddTaggedObject) SetObjectRefs(v []TaggedObjectDto)` + +SetObjectRefs sets ObjectRefs field to given value. + +### HasObjectRefs + +`func (o *BulkAddTaggedObject) HasObjectRefs() bool` + +HasObjectRefs returns a boolean if a field has been set. + +### GetTags + +`func (o *BulkAddTaggedObject) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *BulkAddTaggedObject) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *BulkAddTaggedObject) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *BulkAddTaggedObject) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetOperation + +`func (o *BulkAddTaggedObject) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *BulkAddTaggedObject) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *BulkAddTaggedObject) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *BulkAddTaggedObject) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BulkRemoveTaggedObject.md b/docs/tools/sdk/go/Reference/V3/Models/BulkRemoveTaggedObject.md new file mode 100644 index 000000000..010db2583 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BulkRemoveTaggedObject.md @@ -0,0 +1,90 @@ +--- +id: bulk-remove-tagged-object +title: BulkRemoveTaggedObject +pagination_label: BulkRemoveTaggedObject +sidebar_label: BulkRemoveTaggedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkRemoveTaggedObject', 'BulkRemoveTaggedObject'] +slug: /tools/sdk/go/v3/models/bulk-remove-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkRemoveTaggedObject', 'BulkRemoveTaggedObject'] +--- + +# BulkRemoveTaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]string** | Label to be applied to an Object | [optional] + +## Methods + +### NewBulkRemoveTaggedObject + +`func NewBulkRemoveTaggedObject() *BulkRemoveTaggedObject` + +NewBulkRemoveTaggedObject instantiates a new BulkRemoveTaggedObject 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 + +### NewBulkRemoveTaggedObjectWithDefaults + +`func NewBulkRemoveTaggedObjectWithDefaults() *BulkRemoveTaggedObject` + +NewBulkRemoveTaggedObjectWithDefaults instantiates a new BulkRemoveTaggedObject 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 + +### GetObjectRefs + +`func (o *BulkRemoveTaggedObject) GetObjectRefs() []TaggedObjectDto` + +GetObjectRefs returns the ObjectRefs field if non-nil, zero value otherwise. + +### GetObjectRefsOk + +`func (o *BulkRemoveTaggedObject) GetObjectRefsOk() (*[]TaggedObjectDto, bool)` + +GetObjectRefsOk returns a tuple with the ObjectRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectRefs + +`func (o *BulkRemoveTaggedObject) SetObjectRefs(v []TaggedObjectDto)` + +SetObjectRefs sets ObjectRefs field to given value. + +### HasObjectRefs + +`func (o *BulkRemoveTaggedObject) HasObjectRefs() bool` + +HasObjectRefs returns a boolean if a field has been set. + +### GetTags + +`func (o *BulkRemoveTaggedObject) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *BulkRemoveTaggedObject) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *BulkRemoveTaggedObject) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *BulkRemoveTaggedObject) HasTags() bool` + +HasTags returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/BulkTaggedObjectResponse.md b/docs/tools/sdk/go/Reference/V3/Models/BulkTaggedObjectResponse.md new file mode 100644 index 000000000..d61de3656 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/BulkTaggedObjectResponse.md @@ -0,0 +1,90 @@ +--- +id: bulk-tagged-object-response +title: BulkTaggedObjectResponse +pagination_label: BulkTaggedObjectResponse +sidebar_label: BulkTaggedObjectResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'BulkTaggedObjectResponse', 'BulkTaggedObjectResponse'] +slug: /tools/sdk/go/v3/models/bulk-tagged-object-response +tags: ['SDK', 'Software Development Kit', 'BulkTaggedObjectResponse', 'BulkTaggedObjectResponse'] +--- + +# BulkTaggedObjectResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]string** | Label to be applied to an Object | [optional] + +## Methods + +### NewBulkTaggedObjectResponse + +`func NewBulkTaggedObjectResponse() *BulkTaggedObjectResponse` + +NewBulkTaggedObjectResponse instantiates a new BulkTaggedObjectResponse 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 + +### NewBulkTaggedObjectResponseWithDefaults + +`func NewBulkTaggedObjectResponseWithDefaults() *BulkTaggedObjectResponse` + +NewBulkTaggedObjectResponseWithDefaults instantiates a new BulkTaggedObjectResponse 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 + +### GetObjectRefs + +`func (o *BulkTaggedObjectResponse) GetObjectRefs() []TaggedObjectDto` + +GetObjectRefs returns the ObjectRefs field if non-nil, zero value otherwise. + +### GetObjectRefsOk + +`func (o *BulkTaggedObjectResponse) GetObjectRefsOk() (*[]TaggedObjectDto, bool)` + +GetObjectRefsOk returns a tuple with the ObjectRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectRefs + +`func (o *BulkTaggedObjectResponse) SetObjectRefs(v []TaggedObjectDto)` + +SetObjectRefs sets ObjectRefs field to given value. + +### HasObjectRefs + +`func (o *BulkTaggedObjectResponse) HasObjectRefs() bool` + +HasObjectRefs returns a boolean if a field has been set. + +### GetTags + +`func (o *BulkTaggedObjectResponse) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *BulkTaggedObjectResponse) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *BulkTaggedObjectResponse) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *BulkTaggedObjectResponse) HasTags() bool` + +HasTags returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Campaign.md b/docs/tools/sdk/go/Reference/V3/Models/Campaign.md new file mode 100644 index 000000000..823caf777 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Campaign.md @@ -0,0 +1,631 @@ +--- +id: campaign +title: Campaign +pagination_label: Campaign +sidebar_label: Campaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Campaign', 'Campaign'] +slug: /tools/sdk/go/v3/models/campaign +tags: ['SDK', 'Software Development Kit', 'Campaign', 'Campaign'] +--- + +# Campaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the campaign | [optional] [readonly] +**Name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Description** | **NullableString** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Deadline** | Pointer to **SailPointTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **string** | The type of campaign. Could be extended in the future. | +**EmailNotificationEnabled** | Pointer to **bool** | Enables email notification for this campaign | [optional] [default to false] +**AutoRevokeAllowed** | Pointer to **bool** | Allows auto revoke for this campaign | [optional] [default to false] +**RecommendationsEnabled** | Pointer to **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to false] +**Status** | Pointer to **string** | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **SailPointTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Modified time of the campaign | [optional] [readonly] +**Filter** | Pointer to [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **bool** | Determines if comments on sunset date changes are required. | [optional] [default to true] +**SourceOwnerCampaignInfo** | Pointer to [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Methods + +### NewCampaign + +`func NewCampaign(name string, description NullableString, type_ string, ) *Campaign` + +NewCampaign instantiates a new Campaign 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 + +### NewCampaignWithDefaults + +`func NewCampaignWithDefaults() *Campaign` + +NewCampaignWithDefaults instantiates a new Campaign 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 + +### GetId + +`func (o *Campaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Campaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Campaign) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Campaign) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Campaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Campaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Campaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Campaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Campaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Campaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *Campaign) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Campaign) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetDeadline + +`func (o *Campaign) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *Campaign) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *Campaign) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *Campaign) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### GetType + +`func (o *Campaign) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Campaign) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Campaign) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEmailNotificationEnabled + +`func (o *Campaign) GetEmailNotificationEnabled() bool` + +GetEmailNotificationEnabled returns the EmailNotificationEnabled field if non-nil, zero value otherwise. + +### GetEmailNotificationEnabledOk + +`func (o *Campaign) GetEmailNotificationEnabledOk() (*bool, bool)` + +GetEmailNotificationEnabledOk returns a tuple with the EmailNotificationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationEnabled + +`func (o *Campaign) SetEmailNotificationEnabled(v bool)` + +SetEmailNotificationEnabled sets EmailNotificationEnabled field to given value. + +### HasEmailNotificationEnabled + +`func (o *Campaign) HasEmailNotificationEnabled() bool` + +HasEmailNotificationEnabled returns a boolean if a field has been set. + +### GetAutoRevokeAllowed + +`func (o *Campaign) GetAutoRevokeAllowed() bool` + +GetAutoRevokeAllowed returns the AutoRevokeAllowed field if non-nil, zero value otherwise. + +### GetAutoRevokeAllowedOk + +`func (o *Campaign) GetAutoRevokeAllowedOk() (*bool, bool)` + +GetAutoRevokeAllowedOk returns a tuple with the AutoRevokeAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoRevokeAllowed + +`func (o *Campaign) SetAutoRevokeAllowed(v bool)` + +SetAutoRevokeAllowed sets AutoRevokeAllowed field to given value. + +### HasAutoRevokeAllowed + +`func (o *Campaign) HasAutoRevokeAllowed() bool` + +HasAutoRevokeAllowed returns a boolean if a field has been set. + +### GetRecommendationsEnabled + +`func (o *Campaign) GetRecommendationsEnabled() bool` + +GetRecommendationsEnabled returns the RecommendationsEnabled field if non-nil, zero value otherwise. + +### GetRecommendationsEnabledOk + +`func (o *Campaign) GetRecommendationsEnabledOk() (*bool, bool)` + +GetRecommendationsEnabledOk returns a tuple with the RecommendationsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendationsEnabled + +`func (o *Campaign) SetRecommendationsEnabled(v bool)` + +SetRecommendationsEnabled sets RecommendationsEnabled field to given value. + +### HasRecommendationsEnabled + +`func (o *Campaign) HasRecommendationsEnabled() bool` + +HasRecommendationsEnabled returns a boolean if a field has been set. + +### GetStatus + +`func (o *Campaign) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Campaign) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Campaign) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Campaign) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetCorrelatedStatus + +`func (o *Campaign) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *Campaign) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *Campaign) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + +### HasCorrelatedStatus + +`func (o *Campaign) HasCorrelatedStatus() bool` + +HasCorrelatedStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *Campaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Campaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Campaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Campaign) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetTotalCertifications + +`func (o *Campaign) GetTotalCertifications() int32` + +GetTotalCertifications returns the TotalCertifications field if non-nil, zero value otherwise. + +### GetTotalCertificationsOk + +`func (o *Campaign) GetTotalCertificationsOk() (*int32, bool)` + +GetTotalCertificationsOk returns a tuple with the TotalCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCertifications + +`func (o *Campaign) SetTotalCertifications(v int32)` + +SetTotalCertifications sets TotalCertifications field to given value. + +### HasTotalCertifications + +`func (o *Campaign) HasTotalCertifications() bool` + +HasTotalCertifications returns a boolean if a field has been set. + +### GetCompletedCertifications + +`func (o *Campaign) GetCompletedCertifications() int32` + +GetCompletedCertifications returns the CompletedCertifications field if non-nil, zero value otherwise. + +### GetCompletedCertificationsOk + +`func (o *Campaign) GetCompletedCertificationsOk() (*int32, bool)` + +GetCompletedCertificationsOk returns a tuple with the CompletedCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedCertifications + +`func (o *Campaign) SetCompletedCertifications(v int32)` + +SetCompletedCertifications sets CompletedCertifications field to given value. + +### HasCompletedCertifications + +`func (o *Campaign) HasCompletedCertifications() bool` + +HasCompletedCertifications returns a boolean if a field has been set. + +### GetAlerts + +`func (o *Campaign) GetAlerts() []CampaignAlert` + +GetAlerts returns the Alerts field if non-nil, zero value otherwise. + +### GetAlertsOk + +`func (o *Campaign) GetAlertsOk() (*[]CampaignAlert, bool)` + +GetAlertsOk returns a tuple with the Alerts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlerts + +`func (o *Campaign) SetAlerts(v []CampaignAlert)` + +SetAlerts sets Alerts field to given value. + +### HasAlerts + +`func (o *Campaign) HasAlerts() bool` + +HasAlerts returns a boolean if a field has been set. + +### GetModified + +`func (o *Campaign) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Campaign) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Campaign) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Campaign) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetFilter + +`func (o *Campaign) GetFilter() CampaignAllOfFilter` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *Campaign) GetFilterOk() (*CampaignAllOfFilter, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *Campaign) SetFilter(v CampaignAllOfFilter)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *Campaign) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### GetSunsetCommentsRequired + +`func (o *Campaign) GetSunsetCommentsRequired() bool` + +GetSunsetCommentsRequired returns the SunsetCommentsRequired field if non-nil, zero value otherwise. + +### GetSunsetCommentsRequiredOk + +`func (o *Campaign) GetSunsetCommentsRequiredOk() (*bool, bool)` + +GetSunsetCommentsRequiredOk returns a tuple with the SunsetCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSunsetCommentsRequired + +`func (o *Campaign) SetSunsetCommentsRequired(v bool)` + +SetSunsetCommentsRequired sets SunsetCommentsRequired field to given value. + +### HasSunsetCommentsRequired + +`func (o *Campaign) HasSunsetCommentsRequired() bool` + +HasSunsetCommentsRequired returns a boolean if a field has been set. + +### GetSourceOwnerCampaignInfo + +`func (o *Campaign) GetSourceOwnerCampaignInfo() CampaignAllOfSourceOwnerCampaignInfo` + +GetSourceOwnerCampaignInfo returns the SourceOwnerCampaignInfo field if non-nil, zero value otherwise. + +### GetSourceOwnerCampaignInfoOk + +`func (o *Campaign) GetSourceOwnerCampaignInfoOk() (*CampaignAllOfSourceOwnerCampaignInfo, bool)` + +GetSourceOwnerCampaignInfoOk returns a tuple with the SourceOwnerCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceOwnerCampaignInfo + +`func (o *Campaign) SetSourceOwnerCampaignInfo(v CampaignAllOfSourceOwnerCampaignInfo)` + +SetSourceOwnerCampaignInfo sets SourceOwnerCampaignInfo field to given value. + +### HasSourceOwnerCampaignInfo + +`func (o *Campaign) HasSourceOwnerCampaignInfo() bool` + +HasSourceOwnerCampaignInfo returns a boolean if a field has been set. + +### GetSearchCampaignInfo + +`func (o *Campaign) GetSearchCampaignInfo() CampaignAllOfSearchCampaignInfo` + +GetSearchCampaignInfo returns the SearchCampaignInfo field if non-nil, zero value otherwise. + +### GetSearchCampaignInfoOk + +`func (o *Campaign) GetSearchCampaignInfoOk() (*CampaignAllOfSearchCampaignInfo, bool)` + +GetSearchCampaignInfoOk returns a tuple with the SearchCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchCampaignInfo + +`func (o *Campaign) SetSearchCampaignInfo(v CampaignAllOfSearchCampaignInfo)` + +SetSearchCampaignInfo sets SearchCampaignInfo field to given value. + +### HasSearchCampaignInfo + +`func (o *Campaign) HasSearchCampaignInfo() bool` + +HasSearchCampaignInfo returns a boolean if a field has been set. + +### GetRoleCompositionCampaignInfo + +`func (o *Campaign) GetRoleCompositionCampaignInfo() CampaignAllOfRoleCompositionCampaignInfo` + +GetRoleCompositionCampaignInfo returns the RoleCompositionCampaignInfo field if non-nil, zero value otherwise. + +### GetRoleCompositionCampaignInfoOk + +`func (o *Campaign) GetRoleCompositionCampaignInfoOk() (*CampaignAllOfRoleCompositionCampaignInfo, bool)` + +GetRoleCompositionCampaignInfoOk returns a tuple with the RoleCompositionCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleCompositionCampaignInfo + +`func (o *Campaign) SetRoleCompositionCampaignInfo(v CampaignAllOfRoleCompositionCampaignInfo)` + +SetRoleCompositionCampaignInfo sets RoleCompositionCampaignInfo field to given value. + +### HasRoleCompositionCampaignInfo + +`func (o *Campaign) HasRoleCompositionCampaignInfo() bool` + +HasRoleCompositionCampaignInfo returns a boolean if a field has been set. + +### GetMachineAccountCampaignInfo + +`func (o *Campaign) GetMachineAccountCampaignInfo() CampaignAllOfMachineAccountCampaignInfo` + +GetMachineAccountCampaignInfo returns the MachineAccountCampaignInfo field if non-nil, zero value otherwise. + +### GetMachineAccountCampaignInfoOk + +`func (o *Campaign) GetMachineAccountCampaignInfoOk() (*CampaignAllOfMachineAccountCampaignInfo, bool)` + +GetMachineAccountCampaignInfoOk returns a tuple with the MachineAccountCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMachineAccountCampaignInfo + +`func (o *Campaign) SetMachineAccountCampaignInfo(v CampaignAllOfMachineAccountCampaignInfo)` + +SetMachineAccountCampaignInfo sets MachineAccountCampaignInfo field to given value. + +### HasMachineAccountCampaignInfo + +`func (o *Campaign) HasMachineAccountCampaignInfo() bool` + +HasMachineAccountCampaignInfo returns a boolean if a field has been set. + +### GetSourcesWithOrphanEntitlements + +`func (o *Campaign) GetSourcesWithOrphanEntitlements() []CampaignAllOfSourcesWithOrphanEntitlements` + +GetSourcesWithOrphanEntitlements returns the SourcesWithOrphanEntitlements field if non-nil, zero value otherwise. + +### GetSourcesWithOrphanEntitlementsOk + +`func (o *Campaign) GetSourcesWithOrphanEntitlementsOk() (*[]CampaignAllOfSourcesWithOrphanEntitlements, bool)` + +GetSourcesWithOrphanEntitlementsOk returns a tuple with the SourcesWithOrphanEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourcesWithOrphanEntitlements + +`func (o *Campaign) SetSourcesWithOrphanEntitlements(v []CampaignAllOfSourcesWithOrphanEntitlements)` + +SetSourcesWithOrphanEntitlements sets SourcesWithOrphanEntitlements field to given value. + +### HasSourcesWithOrphanEntitlements + +`func (o *Campaign) HasSourcesWithOrphanEntitlements() bool` + +HasSourcesWithOrphanEntitlements returns a boolean if a field has been set. + +### GetMandatoryCommentRequirement + +`func (o *Campaign) GetMandatoryCommentRequirement() string` + +GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise. + +### GetMandatoryCommentRequirementOk + +`func (o *Campaign) GetMandatoryCommentRequirementOk() (*string, bool)` + +GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMandatoryCommentRequirement + +`func (o *Campaign) SetMandatoryCommentRequirement(v string)` + +SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value. + +### HasMandatoryCommentRequirement + +`func (o *Campaign) HasMandatoryCommentRequirement() bool` + +HasMandatoryCommentRequirement returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignAlert.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignAlert.md new file mode 100644 index 000000000..4f4dcdff2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignAlert.md @@ -0,0 +1,90 @@ +--- +id: campaign-alert +title: CampaignAlert +pagination_label: CampaignAlert +sidebar_label: CampaignAlert +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAlert', 'CampaignAlert'] +slug: /tools/sdk/go/v3/models/campaign-alert +tags: ['SDK', 'Software Development Kit', 'CampaignAlert', 'CampaignAlert'] +--- + +# CampaignAlert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Level** | Pointer to **string** | Denotes the level of the message | [optional] +**Localizations** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] + +## Methods + +### NewCampaignAlert + +`func NewCampaignAlert() *CampaignAlert` + +NewCampaignAlert instantiates a new CampaignAlert 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 + +### NewCampaignAlertWithDefaults + +`func NewCampaignAlertWithDefaults() *CampaignAlert` + +NewCampaignAlertWithDefaults instantiates a new CampaignAlert 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 + +### GetLevel + +`func (o *CampaignAlert) GetLevel() string` + +GetLevel returns the Level field if non-nil, zero value otherwise. + +### GetLevelOk + +`func (o *CampaignAlert) GetLevelOk() (*string, bool)` + +GetLevelOk returns a tuple with the Level field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLevel + +`func (o *CampaignAlert) SetLevel(v string)` + +SetLevel sets Level field to given value. + +### HasLevel + +`func (o *CampaignAlert) HasLevel() bool` + +HasLevel returns a boolean if a field has been set. + +### GetLocalizations + +`func (o *CampaignAlert) GetLocalizations() []ErrorMessageDto` + +GetLocalizations returns the Localizations field if non-nil, zero value otherwise. + +### GetLocalizationsOk + +`func (o *CampaignAlert) GetLocalizationsOk() (*[]ErrorMessageDto, bool)` + +GetLocalizationsOk returns a tuple with the Localizations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizations + +`func (o *CampaignAlert) SetLocalizations(v []ErrorMessageDto)` + +SetLocalizations sets Localizations field to given value. + +### HasLocalizations + +`func (o *CampaignAlert) HasLocalizations() bool` + +HasLocalizations returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfFilter.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfFilter.md new file mode 100644 index 000000000..bfa568fc2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfFilter.md @@ -0,0 +1,116 @@ +--- +id: campaign-all-of-filter +title: CampaignAllOfFilter +pagination_label: CampaignAllOfFilter +sidebar_label: CampaignAllOfFilter +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfFilter', 'CampaignAllOfFilter'] +slug: /tools/sdk/go/v3/models/campaign-all-of-filter +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfFilter', 'CampaignAllOfFilter'] +--- + +# CampaignAllOfFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of whatever type of filter is being used. | [optional] +**Type** | Pointer to **string** | Type of the filter | [optional] +**Name** | Pointer to **string** | Name of the filter | [optional] + +## Methods + +### NewCampaignAllOfFilter + +`func NewCampaignAllOfFilter() *CampaignAllOfFilter` + +NewCampaignAllOfFilter instantiates a new CampaignAllOfFilter 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 + +### NewCampaignAllOfFilterWithDefaults + +`func NewCampaignAllOfFilterWithDefaults() *CampaignAllOfFilter` + +NewCampaignAllOfFilterWithDefaults instantiates a new CampaignAllOfFilter 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 + +### GetId + +`func (o *CampaignAllOfFilter) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignAllOfFilter) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignAllOfFilter) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignAllOfFilter) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CampaignAllOfFilter) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfFilter) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfFilter) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignAllOfFilter) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignAllOfFilter) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignAllOfFilter) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignAllOfFilter) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignAllOfFilter) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfMachineAccountCampaignInfo.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfMachineAccountCampaignInfo.md new file mode 100644 index 000000000..0ab347df4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfMachineAccountCampaignInfo.md @@ -0,0 +1,90 @@ +--- +id: campaign-all-of-machine-account-campaign-info +title: CampaignAllOfMachineAccountCampaignInfo +pagination_label: CampaignAllOfMachineAccountCampaignInfo +sidebar_label: CampaignAllOfMachineAccountCampaignInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfMachineAccountCampaignInfo', 'CampaignAllOfMachineAccountCampaignInfo'] +slug: /tools/sdk/go/v3/models/campaign-all-of-machine-account-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfMachineAccountCampaignInfo', 'CampaignAllOfMachineAccountCampaignInfo'] +--- + +# CampaignAllOfMachineAccountCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceIds** | Pointer to **[]string** | The list of sources to be included in the campaign. | [optional] +**ReviewerType** | Pointer to **string** | The reviewer's type. | [optional] + +## Methods + +### NewCampaignAllOfMachineAccountCampaignInfo + +`func NewCampaignAllOfMachineAccountCampaignInfo() *CampaignAllOfMachineAccountCampaignInfo` + +NewCampaignAllOfMachineAccountCampaignInfo instantiates a new CampaignAllOfMachineAccountCampaignInfo 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 + +### NewCampaignAllOfMachineAccountCampaignInfoWithDefaults + +`func NewCampaignAllOfMachineAccountCampaignInfoWithDefaults() *CampaignAllOfMachineAccountCampaignInfo` + +NewCampaignAllOfMachineAccountCampaignInfoWithDefaults instantiates a new CampaignAllOfMachineAccountCampaignInfo 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 + +### GetSourceIds + +`func (o *CampaignAllOfMachineAccountCampaignInfo) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *CampaignAllOfMachineAccountCampaignInfo) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *CampaignAllOfMachineAccountCampaignInfo) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *CampaignAllOfMachineAccountCampaignInfo) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + +### GetReviewerType + +`func (o *CampaignAllOfMachineAccountCampaignInfo) GetReviewerType() string` + +GetReviewerType returns the ReviewerType field if non-nil, zero value otherwise. + +### GetReviewerTypeOk + +`func (o *CampaignAllOfMachineAccountCampaignInfo) GetReviewerTypeOk() (*string, bool)` + +GetReviewerTypeOk returns a tuple with the ReviewerType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerType + +`func (o *CampaignAllOfMachineAccountCampaignInfo) SetReviewerType(v string)` + +SetReviewerType sets ReviewerType field to given value. + +### HasReviewerType + +`func (o *CampaignAllOfMachineAccountCampaignInfo) HasReviewerType() bool` + +HasReviewerType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfRoleCompositionCampaignInfo.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfRoleCompositionCampaignInfo.md new file mode 100644 index 000000000..14d34f17c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfRoleCompositionCampaignInfo.md @@ -0,0 +1,163 @@ +--- +id: campaign-all-of-role-composition-campaign-info +title: CampaignAllOfRoleCompositionCampaignInfo +pagination_label: CampaignAllOfRoleCompositionCampaignInfo +sidebar_label: CampaignAllOfRoleCompositionCampaignInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfo', 'CampaignAllOfRoleCompositionCampaignInfo'] +slug: /tools/sdk/go/v3/models/campaign-all-of-role-composition-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfo', 'CampaignAllOfRoleCompositionCampaignInfo'] +--- + +# CampaignAllOfRoleCompositionCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Reviewer** | Pointer to [**CampaignAllOfSearchCampaignInfoReviewer**](campaign-all-of-search-campaign-info-reviewer) | | [optional] +**RoleIds** | Pointer to **[]string** | Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] +**RemediatorRef** | [**CampaignAllOfRoleCompositionCampaignInfoRemediatorRef**](campaign-all-of-role-composition-campaign-info-remediator-ref) | | +**Query** | Pointer to **string** | Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] +**Description** | Pointer to **string** | Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. | [optional] + +## Methods + +### NewCampaignAllOfRoleCompositionCampaignInfo + +`func NewCampaignAllOfRoleCompositionCampaignInfo(remediatorRef CampaignAllOfRoleCompositionCampaignInfoRemediatorRef, ) *CampaignAllOfRoleCompositionCampaignInfo` + +NewCampaignAllOfRoleCompositionCampaignInfo instantiates a new CampaignAllOfRoleCompositionCampaignInfo 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 + +### NewCampaignAllOfRoleCompositionCampaignInfoWithDefaults + +`func NewCampaignAllOfRoleCompositionCampaignInfoWithDefaults() *CampaignAllOfRoleCompositionCampaignInfo` + +NewCampaignAllOfRoleCompositionCampaignInfoWithDefaults instantiates a new CampaignAllOfRoleCompositionCampaignInfo 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 + +### GetReviewer + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetReviewer() CampaignAllOfSearchCampaignInfoReviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetReviewerOk() (*CampaignAllOfSearchCampaignInfoReviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetReviewer(v CampaignAllOfSearchCampaignInfoReviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetRoleIds + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetRoleIds() []string` + +GetRoleIds returns the RoleIds field if non-nil, zero value otherwise. + +### GetRoleIdsOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetRoleIdsOk() (*[]string, bool)` + +GetRoleIdsOk returns a tuple with the RoleIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleIds + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetRoleIds(v []string)` + +SetRoleIds sets RoleIds field to given value. + +### HasRoleIds + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) HasRoleIds() bool` + +HasRoleIds returns a boolean if a field has been set. + +### GetRemediatorRef + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetRemediatorRef() CampaignAllOfRoleCompositionCampaignInfoRemediatorRef` + +GetRemediatorRef returns the RemediatorRef field if non-nil, zero value otherwise. + +### GetRemediatorRefOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetRemediatorRefOk() (*CampaignAllOfRoleCompositionCampaignInfoRemediatorRef, bool)` + +GetRemediatorRefOk returns a tuple with the RemediatorRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemediatorRef + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetRemediatorRef(v CampaignAllOfRoleCompositionCampaignInfoRemediatorRef)` + +SetRemediatorRef sets RemediatorRef field to given value. + + +### GetQuery + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### GetDescription + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CampaignAllOfRoleCompositionCampaignInfo) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md new file mode 100644 index 000000000..2e3785965 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md @@ -0,0 +1,106 @@ +--- +id: campaign-all-of-role-composition-campaign-info-remediator-ref +title: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +pagination_label: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_label: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +slug: /tools/sdk/go/v3/models/campaign-all-of-role-composition-campaign-info-remediator-ref +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +--- + +# CampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Legal Remediator Type | +**Id** | **string** | The ID of the remediator. | +**Name** | Pointer to **string** | The name of the remediator. | [optional] [readonly] + +## Methods + +### NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +`func NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRef(type_ string, id string, ) *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef` + +NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRef instantiates a new CampaignAllOfRoleCompositionCampaignInfoRemediatorRef 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 + +### NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRefWithDefaults + +`func NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRefWithDefaults() *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef` + +NewCampaignAllOfRoleCompositionCampaignInfoRemediatorRefWithDefaults instantiates a new CampaignAllOfRoleCompositionCampaignInfoRemediatorRef 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 + +### GetType + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignAllOfRoleCompositionCampaignInfoRemediatorRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfSearchCampaignInfo.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfSearchCampaignInfo.md new file mode 100644 index 000000000..af9beff18 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfSearchCampaignInfo.md @@ -0,0 +1,189 @@ +--- +id: campaign-all-of-search-campaign-info +title: CampaignAllOfSearchCampaignInfo +pagination_label: CampaignAllOfSearchCampaignInfo +sidebar_label: CampaignAllOfSearchCampaignInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfSearchCampaignInfo', 'CampaignAllOfSearchCampaignInfo'] +slug: /tools/sdk/go/v3/models/campaign-all-of-search-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfo', 'CampaignAllOfSearchCampaignInfo'] +--- + +# CampaignAllOfSearchCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of search campaign represented. | +**Description** | Pointer to **string** | Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. | [optional] +**Reviewer** | Pointer to [**CampaignAllOfSearchCampaignInfoReviewer**](campaign-all-of-search-campaign-info-reviewer) | | [optional] +**Query** | Pointer to **string** | The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set. | [optional] +**IdentityIds** | Pointer to **[]string** | A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. | [optional] +**AccessConstraints** | Pointer to [**[]AccessConstraint**](access-constraint) | Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. | [optional] + +## Methods + +### NewCampaignAllOfSearchCampaignInfo + +`func NewCampaignAllOfSearchCampaignInfo(type_ string, ) *CampaignAllOfSearchCampaignInfo` + +NewCampaignAllOfSearchCampaignInfo instantiates a new CampaignAllOfSearchCampaignInfo 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 + +### NewCampaignAllOfSearchCampaignInfoWithDefaults + +`func NewCampaignAllOfSearchCampaignInfoWithDefaults() *CampaignAllOfSearchCampaignInfo` + +NewCampaignAllOfSearchCampaignInfoWithDefaults instantiates a new CampaignAllOfSearchCampaignInfo 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 + +### GetType + +`func (o *CampaignAllOfSearchCampaignInfo) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfSearchCampaignInfo) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDescription + +`func (o *CampaignAllOfSearchCampaignInfo) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignAllOfSearchCampaignInfo) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CampaignAllOfSearchCampaignInfo) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetReviewer + +`func (o *CampaignAllOfSearchCampaignInfo) GetReviewer() CampaignAllOfSearchCampaignInfoReviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetReviewerOk() (*CampaignAllOfSearchCampaignInfoReviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CampaignAllOfSearchCampaignInfo) SetReviewer(v CampaignAllOfSearchCampaignInfoReviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *CampaignAllOfSearchCampaignInfo) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetQuery + +`func (o *CampaignAllOfSearchCampaignInfo) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *CampaignAllOfSearchCampaignInfo) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *CampaignAllOfSearchCampaignInfo) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### GetIdentityIds + +`func (o *CampaignAllOfSearchCampaignInfo) GetIdentityIds() []string` + +GetIdentityIds returns the IdentityIds field if non-nil, zero value otherwise. + +### GetIdentityIdsOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetIdentityIdsOk() (*[]string, bool)` + +GetIdentityIdsOk returns a tuple with the IdentityIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityIds + +`func (o *CampaignAllOfSearchCampaignInfo) SetIdentityIds(v []string)` + +SetIdentityIds sets IdentityIds field to given value. + +### HasIdentityIds + +`func (o *CampaignAllOfSearchCampaignInfo) HasIdentityIds() bool` + +HasIdentityIds returns a boolean if a field has been set. + +### GetAccessConstraints + +`func (o *CampaignAllOfSearchCampaignInfo) GetAccessConstraints() []AccessConstraint` + +GetAccessConstraints returns the AccessConstraints field if non-nil, zero value otherwise. + +### GetAccessConstraintsOk + +`func (o *CampaignAllOfSearchCampaignInfo) GetAccessConstraintsOk() (*[]AccessConstraint, bool)` + +GetAccessConstraintsOk returns a tuple with the AccessConstraints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessConstraints + +`func (o *CampaignAllOfSearchCampaignInfo) SetAccessConstraints(v []AccessConstraint)` + +SetAccessConstraints sets AccessConstraints field to given value. + +### HasAccessConstraints + +`func (o *CampaignAllOfSearchCampaignInfo) HasAccessConstraints() bool` + +HasAccessConstraints returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfSearchCampaignInfoReviewer.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfSearchCampaignInfoReviewer.md new file mode 100644 index 000000000..c3d23a492 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfSearchCampaignInfoReviewer.md @@ -0,0 +1,116 @@ +--- +id: campaign-all-of-search-campaign-info-reviewer +title: CampaignAllOfSearchCampaignInfoReviewer +pagination_label: CampaignAllOfSearchCampaignInfoReviewer +sidebar_label: CampaignAllOfSearchCampaignInfoReviewer +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfSearchCampaignInfoReviewer', 'CampaignAllOfSearchCampaignInfoReviewer'] +slug: /tools/sdk/go/v3/models/campaign-all-of-search-campaign-info-reviewer +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfoReviewer', 'CampaignAllOfSearchCampaignInfoReviewer'] +--- + +# CampaignAllOfSearchCampaignInfoReviewer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The reviewer's DTO type. | [optional] +**Id** | Pointer to **string** | The reviewer's ID. | [optional] +**Name** | Pointer to **string** | The reviewer's name. | [optional] + +## Methods + +### NewCampaignAllOfSearchCampaignInfoReviewer + +`func NewCampaignAllOfSearchCampaignInfoReviewer() *CampaignAllOfSearchCampaignInfoReviewer` + +NewCampaignAllOfSearchCampaignInfoReviewer instantiates a new CampaignAllOfSearchCampaignInfoReviewer 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 + +### NewCampaignAllOfSearchCampaignInfoReviewerWithDefaults + +`func NewCampaignAllOfSearchCampaignInfoReviewerWithDefaults() *CampaignAllOfSearchCampaignInfoReviewer` + +NewCampaignAllOfSearchCampaignInfoReviewerWithDefaults instantiates a new CampaignAllOfSearchCampaignInfoReviewer 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 + +### GetType + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignAllOfSearchCampaignInfoReviewer) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfSourceOwnerCampaignInfo.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfSourceOwnerCampaignInfo.md new file mode 100644 index 000000000..6cc9128a5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfSourceOwnerCampaignInfo.md @@ -0,0 +1,64 @@ +--- +id: campaign-all-of-source-owner-campaign-info +title: CampaignAllOfSourceOwnerCampaignInfo +pagination_label: CampaignAllOfSourceOwnerCampaignInfo +sidebar_label: CampaignAllOfSourceOwnerCampaignInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfSourceOwnerCampaignInfo', 'CampaignAllOfSourceOwnerCampaignInfo'] +slug: /tools/sdk/go/v3/models/campaign-all-of-source-owner-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSourceOwnerCampaignInfo', 'CampaignAllOfSourceOwnerCampaignInfo'] +--- + +# CampaignAllOfSourceOwnerCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceIds** | Pointer to **[]string** | The list of sources to be included in the campaign. | [optional] + +## Methods + +### NewCampaignAllOfSourceOwnerCampaignInfo + +`func NewCampaignAllOfSourceOwnerCampaignInfo() *CampaignAllOfSourceOwnerCampaignInfo` + +NewCampaignAllOfSourceOwnerCampaignInfo instantiates a new CampaignAllOfSourceOwnerCampaignInfo 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 + +### NewCampaignAllOfSourceOwnerCampaignInfoWithDefaults + +`func NewCampaignAllOfSourceOwnerCampaignInfoWithDefaults() *CampaignAllOfSourceOwnerCampaignInfo` + +NewCampaignAllOfSourceOwnerCampaignInfoWithDefaults instantiates a new CampaignAllOfSourceOwnerCampaignInfo 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 + +### GetSourceIds + +`func (o *CampaignAllOfSourceOwnerCampaignInfo) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *CampaignAllOfSourceOwnerCampaignInfo) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *CampaignAllOfSourceOwnerCampaignInfo) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *CampaignAllOfSourceOwnerCampaignInfo) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfSourcesWithOrphanEntitlements.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfSourcesWithOrphanEntitlements.md new file mode 100644 index 000000000..3707773d6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignAllOfSourcesWithOrphanEntitlements.md @@ -0,0 +1,116 @@ +--- +id: campaign-all-of-sources-with-orphan-entitlements +title: CampaignAllOfSourcesWithOrphanEntitlements +pagination_label: CampaignAllOfSourcesWithOrphanEntitlements +sidebar_label: CampaignAllOfSourcesWithOrphanEntitlements +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignAllOfSourcesWithOrphanEntitlements', 'CampaignAllOfSourcesWithOrphanEntitlements'] +slug: /tools/sdk/go/v3/models/campaign-all-of-sources-with-orphan-entitlements +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSourcesWithOrphanEntitlements', 'CampaignAllOfSourcesWithOrphanEntitlements'] +--- + +# CampaignAllOfSourcesWithOrphanEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the source | [optional] +**Type** | Pointer to **string** | Type | [optional] +**Name** | Pointer to **string** | Name of the source | [optional] + +## Methods + +### NewCampaignAllOfSourcesWithOrphanEntitlements + +`func NewCampaignAllOfSourcesWithOrphanEntitlements() *CampaignAllOfSourcesWithOrphanEntitlements` + +NewCampaignAllOfSourcesWithOrphanEntitlements instantiates a new CampaignAllOfSourcesWithOrphanEntitlements 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 + +### NewCampaignAllOfSourcesWithOrphanEntitlementsWithDefaults + +`func NewCampaignAllOfSourcesWithOrphanEntitlementsWithDefaults() *CampaignAllOfSourcesWithOrphanEntitlements` + +NewCampaignAllOfSourcesWithOrphanEntitlementsWithDefaults instantiates a new CampaignAllOfSourcesWithOrphanEntitlements 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 + +### GetId + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignAllOfSourcesWithOrphanEntitlements) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignCompleteOptions.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignCompleteOptions.md new file mode 100644 index 000000000..bb8973b49 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignCompleteOptions.md @@ -0,0 +1,64 @@ +--- +id: campaign-complete-options +title: CampaignCompleteOptions +pagination_label: CampaignCompleteOptions +sidebar_label: CampaignCompleteOptions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignCompleteOptions', 'CampaignCompleteOptions'] +slug: /tools/sdk/go/v3/models/campaign-complete-options +tags: ['SDK', 'Software Development Kit', 'CampaignCompleteOptions', 'CampaignCompleteOptions'] +--- + +# CampaignCompleteOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AutoCompleteAction** | Pointer to **string** | Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. | [optional] [default to "APPROVE"] + +## Methods + +### NewCampaignCompleteOptions + +`func NewCampaignCompleteOptions() *CampaignCompleteOptions` + +NewCampaignCompleteOptions instantiates a new CampaignCompleteOptions 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 + +### NewCampaignCompleteOptionsWithDefaults + +`func NewCampaignCompleteOptionsWithDefaults() *CampaignCompleteOptions` + +NewCampaignCompleteOptionsWithDefaults instantiates a new CampaignCompleteOptions 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 + +### GetAutoCompleteAction + +`func (o *CampaignCompleteOptions) GetAutoCompleteAction() string` + +GetAutoCompleteAction returns the AutoCompleteAction field if non-nil, zero value otherwise. + +### GetAutoCompleteActionOk + +`func (o *CampaignCompleteOptions) GetAutoCompleteActionOk() (*string, bool)` + +GetAutoCompleteActionOk returns a tuple with the AutoCompleteAction field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoCompleteAction + +`func (o *CampaignCompleteOptions) SetAutoCompleteAction(v string)` + +SetAutoCompleteAction sets AutoCompleteAction field to given value. + +### HasAutoCompleteAction + +`func (o *CampaignCompleteOptions) HasAutoCompleteAction() bool` + +HasAutoCompleteAction returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignFilterDetails.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignFilterDetails.md new file mode 100644 index 000000000..468a9ccae --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignFilterDetails.md @@ -0,0 +1,205 @@ +--- +id: campaign-filter-details +title: CampaignFilterDetails +pagination_label: CampaignFilterDetails +sidebar_label: CampaignFilterDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignFilterDetails', 'CampaignFilterDetails'] +slug: /tools/sdk/go/v3/models/campaign-filter-details +tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetails', 'CampaignFilterDetails'] +--- + +# CampaignFilterDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the campaign filter | +**Name** | **string** | Campaign filter name. | +**Description** | Pointer to **string** | Campaign filter description. | [optional] +**Owner** | **NullableString** | Owner of the filter. This field automatically populates at creation time with the current user. | +**Mode** | **string** | Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria. | +**CriteriaList** | Pointer to [**[]CampaignFilterDetailsCriteriaListInner**](campaign-filter-details-criteria-list-inner) | List of criteria. | [optional] +**IsSystemFilter** | **bool** | If true, the filter is created by the system. If false, the filter is created by a user. | [default to false] + +## Methods + +### NewCampaignFilterDetails + +`func NewCampaignFilterDetails(id string, name string, owner NullableString, mode string, isSystemFilter bool, ) *CampaignFilterDetails` + +NewCampaignFilterDetails instantiates a new CampaignFilterDetails 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 + +### NewCampaignFilterDetailsWithDefaults + +`func NewCampaignFilterDetailsWithDefaults() *CampaignFilterDetails` + +NewCampaignFilterDetailsWithDefaults instantiates a new CampaignFilterDetails 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 + +### GetId + +`func (o *CampaignFilterDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignFilterDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignFilterDetails) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignFilterDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignFilterDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignFilterDetails) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CampaignFilterDetails) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignFilterDetails) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignFilterDetails) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CampaignFilterDetails) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *CampaignFilterDetails) GetOwner() string` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CampaignFilterDetails) GetOwnerOk() (*string, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CampaignFilterDetails) SetOwner(v string)` + +SetOwner sets Owner field to given value. + + +### SetOwnerNil + +`func (o *CampaignFilterDetails) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *CampaignFilterDetails) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetMode + +`func (o *CampaignFilterDetails) GetMode() string` + +GetMode returns the Mode field if non-nil, zero value otherwise. + +### GetModeOk + +`func (o *CampaignFilterDetails) GetModeOk() (*string, bool)` + +GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMode + +`func (o *CampaignFilterDetails) SetMode(v string)` + +SetMode sets Mode field to given value. + + +### GetCriteriaList + +`func (o *CampaignFilterDetails) GetCriteriaList() []CampaignFilterDetailsCriteriaListInner` + +GetCriteriaList returns the CriteriaList field if non-nil, zero value otherwise. + +### GetCriteriaListOk + +`func (o *CampaignFilterDetails) GetCriteriaListOk() (*[]CampaignFilterDetailsCriteriaListInner, bool)` + +GetCriteriaListOk returns a tuple with the CriteriaList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteriaList + +`func (o *CampaignFilterDetails) SetCriteriaList(v []CampaignFilterDetailsCriteriaListInner)` + +SetCriteriaList sets CriteriaList field to given value. + +### HasCriteriaList + +`func (o *CampaignFilterDetails) HasCriteriaList() bool` + +HasCriteriaList returns a boolean if a field has been set. + +### GetIsSystemFilter + +`func (o *CampaignFilterDetails) GetIsSystemFilter() bool` + +GetIsSystemFilter returns the IsSystemFilter field if non-nil, zero value otherwise. + +### GetIsSystemFilterOk + +`func (o *CampaignFilterDetails) GetIsSystemFilterOk() (*bool, bool)` + +GetIsSystemFilterOk returns a tuple with the IsSystemFilter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSystemFilter + +`func (o *CampaignFilterDetails) SetIsSystemFilter(v bool)` + +SetIsSystemFilter sets IsSystemFilter field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignFilterDetailsCriteriaListInner.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignFilterDetailsCriteriaListInner.md new file mode 100644 index 000000000..b6215f434 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignFilterDetailsCriteriaListInner.md @@ -0,0 +1,323 @@ +--- +id: campaign-filter-details-criteria-list-inner +title: CampaignFilterDetailsCriteriaListInner +pagination_label: CampaignFilterDetailsCriteriaListInner +sidebar_label: CampaignFilterDetailsCriteriaListInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignFilterDetailsCriteriaListInner', 'CampaignFilterDetailsCriteriaListInner'] +slug: /tools/sdk/go/v3/models/campaign-filter-details-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetailsCriteriaListInner', 'CampaignFilterDetailsCriteriaListInner'] +--- + +# CampaignFilterDetailsCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**CriteriaType**](criteria-type) | | +**Operation** | Pointer to [**NullableOperation**](operation) | | [optional] +**Property** | **NullableString** | Specified key from the type of criteria. | +**Value** | **NullableString** | Value for the specified key from the type of criteria. | +**NegateResult** | Pointer to **bool** | If true, the filter will negate the result of the criteria. | [optional] [default to false] +**ShortCircuit** | Pointer to **bool** | If true, the filter will short circuit the evaluation of the criteria. | [optional] [default to false] +**RecordChildMatches** | Pointer to **bool** | If true, the filter will record child matches for the criteria. | [optional] [default to false] +**Id** | Pointer to **NullableString** | The unique ID of the criteria. | [optional] +**SuppressMatchedItems** | Pointer to **bool** | If this value is true, then matched items will not only be excluded from the campaign, they will also not have archived certification items created. Such items will not appear in the exclusion report. | [optional] [default to false] +**Children** | Pointer to **[]map[string]interface{}** | List of child criteria. | [optional] + +## Methods + +### NewCampaignFilterDetailsCriteriaListInner + +`func NewCampaignFilterDetailsCriteriaListInner(type_ CriteriaType, property NullableString, value NullableString, ) *CampaignFilterDetailsCriteriaListInner` + +NewCampaignFilterDetailsCriteriaListInner instantiates a new CampaignFilterDetailsCriteriaListInner 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 + +### NewCampaignFilterDetailsCriteriaListInnerWithDefaults + +`func NewCampaignFilterDetailsCriteriaListInnerWithDefaults() *CampaignFilterDetailsCriteriaListInner` + +NewCampaignFilterDetailsCriteriaListInnerWithDefaults instantiates a new CampaignFilterDetailsCriteriaListInner 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 + +### GetType + +`func (o *CampaignFilterDetailsCriteriaListInner) GetType() CriteriaType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetTypeOk() (*CriteriaType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignFilterDetailsCriteriaListInner) SetType(v CriteriaType)` + +SetType sets Type field to given value. + + +### GetOperation + +`func (o *CampaignFilterDetailsCriteriaListInner) GetOperation() Operation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetOperationOk() (*Operation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *CampaignFilterDetailsCriteriaListInner) SetOperation(v Operation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *CampaignFilterDetailsCriteriaListInner) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### SetOperationNil + +`func (o *CampaignFilterDetailsCriteriaListInner) SetOperationNil(b bool)` + + SetOperationNil sets the value for Operation to be an explicit nil + +### UnsetOperation +`func (o *CampaignFilterDetailsCriteriaListInner) UnsetOperation()` + +UnsetOperation ensures that no value is present for Operation, not even an explicit nil +### GetProperty + +`func (o *CampaignFilterDetailsCriteriaListInner) GetProperty() string` + +GetProperty returns the Property field if non-nil, zero value otherwise. + +### GetPropertyOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetPropertyOk() (*string, bool)` + +GetPropertyOk returns a tuple with the Property field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperty + +`func (o *CampaignFilterDetailsCriteriaListInner) SetProperty(v string)` + +SetProperty sets Property field to given value. + + +### SetPropertyNil + +`func (o *CampaignFilterDetailsCriteriaListInner) SetPropertyNil(b bool)` + + SetPropertyNil sets the value for Property to be an explicit nil + +### UnsetProperty +`func (o *CampaignFilterDetailsCriteriaListInner) UnsetProperty()` + +UnsetProperty ensures that no value is present for Property, not even an explicit nil +### GetValue + +`func (o *CampaignFilterDetailsCriteriaListInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *CampaignFilterDetailsCriteriaListInner) SetValue(v string)` + +SetValue sets Value field to given value. + + +### SetValueNil + +`func (o *CampaignFilterDetailsCriteriaListInner) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *CampaignFilterDetailsCriteriaListInner) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetNegateResult + +`func (o *CampaignFilterDetailsCriteriaListInner) GetNegateResult() bool` + +GetNegateResult returns the NegateResult field if non-nil, zero value otherwise. + +### GetNegateResultOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetNegateResultOk() (*bool, bool)` + +GetNegateResultOk returns a tuple with the NegateResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNegateResult + +`func (o *CampaignFilterDetailsCriteriaListInner) SetNegateResult(v bool)` + +SetNegateResult sets NegateResult field to given value. + +### HasNegateResult + +`func (o *CampaignFilterDetailsCriteriaListInner) HasNegateResult() bool` + +HasNegateResult returns a boolean if a field has been set. + +### GetShortCircuit + +`func (o *CampaignFilterDetailsCriteriaListInner) GetShortCircuit() bool` + +GetShortCircuit returns the ShortCircuit field if non-nil, zero value otherwise. + +### GetShortCircuitOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetShortCircuitOk() (*bool, bool)` + +GetShortCircuitOk returns a tuple with the ShortCircuit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetShortCircuit + +`func (o *CampaignFilterDetailsCriteriaListInner) SetShortCircuit(v bool)` + +SetShortCircuit sets ShortCircuit field to given value. + +### HasShortCircuit + +`func (o *CampaignFilterDetailsCriteriaListInner) HasShortCircuit() bool` + +HasShortCircuit returns a boolean if a field has been set. + +### GetRecordChildMatches + +`func (o *CampaignFilterDetailsCriteriaListInner) GetRecordChildMatches() bool` + +GetRecordChildMatches returns the RecordChildMatches field if non-nil, zero value otherwise. + +### GetRecordChildMatchesOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetRecordChildMatchesOk() (*bool, bool)` + +GetRecordChildMatchesOk returns a tuple with the RecordChildMatches field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecordChildMatches + +`func (o *CampaignFilterDetailsCriteriaListInner) SetRecordChildMatches(v bool)` + +SetRecordChildMatches sets RecordChildMatches field to given value. + +### HasRecordChildMatches + +`func (o *CampaignFilterDetailsCriteriaListInner) HasRecordChildMatches() bool` + +HasRecordChildMatches returns a boolean if a field has been set. + +### GetId + +`func (o *CampaignFilterDetailsCriteriaListInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignFilterDetailsCriteriaListInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignFilterDetailsCriteriaListInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *CampaignFilterDetailsCriteriaListInner) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *CampaignFilterDetailsCriteriaListInner) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetSuppressMatchedItems + +`func (o *CampaignFilterDetailsCriteriaListInner) GetSuppressMatchedItems() bool` + +GetSuppressMatchedItems returns the SuppressMatchedItems field if non-nil, zero value otherwise. + +### GetSuppressMatchedItemsOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetSuppressMatchedItemsOk() (*bool, bool)` + +GetSuppressMatchedItemsOk returns a tuple with the SuppressMatchedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSuppressMatchedItems + +`func (o *CampaignFilterDetailsCriteriaListInner) SetSuppressMatchedItems(v bool)` + +SetSuppressMatchedItems sets SuppressMatchedItems field to given value. + +### HasSuppressMatchedItems + +`func (o *CampaignFilterDetailsCriteriaListInner) HasSuppressMatchedItems() bool` + +HasSuppressMatchedItems returns a boolean if a field has been set. + +### GetChildren + +`func (o *CampaignFilterDetailsCriteriaListInner) GetChildren() []map[string]interface{}` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *CampaignFilterDetailsCriteriaListInner) GetChildrenOk() (*[]map[string]interface{}, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *CampaignFilterDetailsCriteriaListInner) SetChildren(v []map[string]interface{})` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *CampaignFilterDetailsCriteriaListInner) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignReference.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignReference.md new file mode 100644 index 000000000..c47c03b81 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignReference.md @@ -0,0 +1,195 @@ +--- +id: campaign-reference +title: CampaignReference +pagination_label: CampaignReference +sidebar_label: CampaignReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignReference', 'CampaignReference'] +slug: /tools/sdk/go/v3/models/campaign-reference +tags: ['SDK', 'Software Development Kit', 'CampaignReference', 'CampaignReference'] +--- + +# CampaignReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the campaign. | +**Name** | **string** | The name of the campaign. | +**Type** | **string** | The type of object that is being referenced. | +**CampaignType** | **string** | The type of the campaign. | +**Description** | **NullableString** | The description of the campaign set by the admin who created it. | +**CorrelatedStatus** | **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | +**MandatoryCommentRequirement** | **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | + +## Methods + +### NewCampaignReference + +`func NewCampaignReference(id string, name string, type_ string, campaignType string, description NullableString, correlatedStatus string, mandatoryCommentRequirement string, ) *CampaignReference` + +NewCampaignReference instantiates a new CampaignReference 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 + +### NewCampaignReferenceWithDefaults + +`func NewCampaignReferenceWithDefaults() *CampaignReference` + +NewCampaignReferenceWithDefaults instantiates a new CampaignReference 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 + +### GetId + +`func (o *CampaignReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignReference) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *CampaignReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignReference) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *CampaignReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignReference) SetType(v string)` + +SetType sets Type field to given value. + + +### GetCampaignType + +`func (o *CampaignReference) GetCampaignType() string` + +GetCampaignType returns the CampaignType field if non-nil, zero value otherwise. + +### GetCampaignTypeOk + +`func (o *CampaignReference) GetCampaignTypeOk() (*string, bool)` + +GetCampaignTypeOk returns a tuple with the CampaignType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaignType + +`func (o *CampaignReference) SetCampaignType(v string)` + +SetCampaignType sets CampaignType field to given value. + + +### GetDescription + +`func (o *CampaignReference) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignReference) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignReference) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *CampaignReference) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CampaignReference) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCorrelatedStatus + +`func (o *CampaignReference) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *CampaignReference) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *CampaignReference) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + + +### GetMandatoryCommentRequirement + +`func (o *CampaignReference) GetMandatoryCommentRequirement() string` + +GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise. + +### GetMandatoryCommentRequirementOk + +`func (o *CampaignReference) GetMandatoryCommentRequirementOk() (*string, bool)` + +GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMandatoryCommentRequirement + +`func (o *CampaignReference) SetMandatoryCommentRequirement(v string)` + +SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignReport.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignReport.md new file mode 100644 index 000000000..2b8e683a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignReport.md @@ -0,0 +1,189 @@ +--- +id: campaign-report +title: CampaignReport +pagination_label: CampaignReport +sidebar_label: CampaignReport +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignReport', 'CampaignReport'] +slug: /tools/sdk/go/v3/models/campaign-report +tags: ['SDK', 'Software Development Kit', 'CampaignReport', 'CampaignReport'] +--- + +# CampaignReport + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **string** | Human-readable name of the SOD policy violation report result. | [optional] +**Status** | Pointer to **string** | Status of a SOD policy violation report. | [optional] +**ReportType** | [**ReportType**](report-type) | | +**LastRunAt** | Pointer to **SailPointTime** | The most recent date and time this report was run | [optional] [readonly] + +## Methods + +### NewCampaignReport + +`func NewCampaignReport(reportType ReportType, ) *CampaignReport` + +NewCampaignReport instantiates a new CampaignReport 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 + +### NewCampaignReportWithDefaults + +`func NewCampaignReportWithDefaults() *CampaignReport` + +NewCampaignReportWithDefaults instantiates a new CampaignReport 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 + +### GetType + +`func (o *CampaignReport) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignReport) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignReport) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignReport) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CampaignReport) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignReport) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignReport) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignReport) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignReport) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignReport) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignReport) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignReport) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *CampaignReport) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CampaignReport) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CampaignReport) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CampaignReport) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetReportType + +`func (o *CampaignReport) GetReportType() ReportType` + +GetReportType returns the ReportType field if non-nil, zero value otherwise. + +### GetReportTypeOk + +`func (o *CampaignReport) GetReportTypeOk() (*ReportType, bool)` + +GetReportTypeOk returns a tuple with the ReportType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportType + +`func (o *CampaignReport) SetReportType(v ReportType)` + +SetReportType sets ReportType field to given value. + + +### GetLastRunAt + +`func (o *CampaignReport) GetLastRunAt() SailPointTime` + +GetLastRunAt returns the LastRunAt field if non-nil, zero value otherwise. + +### GetLastRunAtOk + +`func (o *CampaignReport) GetLastRunAtOk() (*SailPointTime, bool)` + +GetLastRunAtOk returns a tuple with the LastRunAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastRunAt + +`func (o *CampaignReport) SetLastRunAt(v SailPointTime)` + +SetLastRunAt sets LastRunAt field to given value. + +### HasLastRunAt + +`func (o *CampaignReport) HasLastRunAt() bool` + +HasLastRunAt returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignReportsConfig.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignReportsConfig.md new file mode 100644 index 000000000..e83060925 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignReportsConfig.md @@ -0,0 +1,74 @@ +--- +id: campaign-reports-config +title: CampaignReportsConfig +pagination_label: CampaignReportsConfig +sidebar_label: CampaignReportsConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignReportsConfig', 'CampaignReportsConfig'] +slug: /tools/sdk/go/v3/models/campaign-reports-config +tags: ['SDK', 'Software Development Kit', 'CampaignReportsConfig', 'CampaignReportsConfig'] +--- + +# CampaignReportsConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttributeColumns** | Pointer to **[]string** | list of identity attribute columns | [optional] + +## Methods + +### NewCampaignReportsConfig + +`func NewCampaignReportsConfig() *CampaignReportsConfig` + +NewCampaignReportsConfig instantiates a new CampaignReportsConfig 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 + +### NewCampaignReportsConfigWithDefaults + +`func NewCampaignReportsConfigWithDefaults() *CampaignReportsConfig` + +NewCampaignReportsConfigWithDefaults instantiates a new CampaignReportsConfig 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 + +### GetIdentityAttributeColumns + +`func (o *CampaignReportsConfig) GetIdentityAttributeColumns() []string` + +GetIdentityAttributeColumns returns the IdentityAttributeColumns field if non-nil, zero value otherwise. + +### GetIdentityAttributeColumnsOk + +`func (o *CampaignReportsConfig) GetIdentityAttributeColumnsOk() (*[]string, bool)` + +GetIdentityAttributeColumnsOk returns a tuple with the IdentityAttributeColumns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeColumns + +`func (o *CampaignReportsConfig) SetIdentityAttributeColumns(v []string)` + +SetIdentityAttributeColumns sets IdentityAttributeColumns field to given value. + +### HasIdentityAttributeColumns + +`func (o *CampaignReportsConfig) HasIdentityAttributeColumns() bool` + +HasIdentityAttributeColumns returns a boolean if a field has been set. + +### SetIdentityAttributeColumnsNil + +`func (o *CampaignReportsConfig) SetIdentityAttributeColumnsNil(b bool)` + + SetIdentityAttributeColumnsNil sets the value for IdentityAttributeColumns to be an explicit nil + +### UnsetIdentityAttributeColumns +`func (o *CampaignReportsConfig) UnsetIdentityAttributeColumns()` + +UnsetIdentityAttributeColumns ensures that no value is present for IdentityAttributeColumns, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignTemplate.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignTemplate.md new file mode 100644 index 000000000..e84bec573 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignTemplate.md @@ -0,0 +1,257 @@ +--- +id: campaign-template +title: CampaignTemplate +pagination_label: CampaignTemplate +sidebar_label: CampaignTemplate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignTemplate', 'CampaignTemplate'] +slug: /tools/sdk/go/v3/models/campaign-template +tags: ['SDK', 'Software Development Kit', 'CampaignTemplate', 'CampaignTemplate'] +--- + +# CampaignTemplate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the campaign template | [optional] +**Name** | **string** | This template's name. Has no bearing on generated campaigns' names. | +**Description** | **string** | This template's description. Has no bearing on generated campaigns' descriptions. | +**Created** | **SailPointTime** | Creation date of Campaign Template | [readonly] +**Modified** | **NullableTime** | Modification date of Campaign Template | [readonly] +**Scheduled** | Pointer to **bool** | Indicates if this campaign template has been scheduled. | [optional] [readonly] [default to false] +**OwnerRef** | Pointer to [**CampaignTemplateOwnerRef**](campaign-template-owner-ref) | | [optional] +**DeadlineDuration** | Pointer to **string** | The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days). | [optional] +**Campaign** | [**Campaign**](campaign) | | + +## Methods + +### NewCampaignTemplate + +`func NewCampaignTemplate(name string, description string, created SailPointTime, modified NullableTime, campaign Campaign, ) *CampaignTemplate` + +NewCampaignTemplate instantiates a new CampaignTemplate 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 + +### NewCampaignTemplateWithDefaults + +`func NewCampaignTemplateWithDefaults() *CampaignTemplate` + +NewCampaignTemplateWithDefaults instantiates a new CampaignTemplate 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 + +### GetId + +`func (o *CampaignTemplate) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignTemplate) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignTemplate) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignTemplate) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignTemplate) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignTemplate) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignTemplate) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CampaignTemplate) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignTemplate) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CampaignTemplate) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetCreated + +`func (o *CampaignTemplate) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignTemplate) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CampaignTemplate) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CampaignTemplate) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CampaignTemplate) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CampaignTemplate) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### SetModifiedNil + +`func (o *CampaignTemplate) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CampaignTemplate) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetScheduled + +`func (o *CampaignTemplate) GetScheduled() bool` + +GetScheduled returns the Scheduled field if non-nil, zero value otherwise. + +### GetScheduledOk + +`func (o *CampaignTemplate) GetScheduledOk() (*bool, bool)` + +GetScheduledOk returns a tuple with the Scheduled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheduled + +`func (o *CampaignTemplate) SetScheduled(v bool)` + +SetScheduled sets Scheduled field to given value. + +### HasScheduled + +`func (o *CampaignTemplate) HasScheduled() bool` + +HasScheduled returns a boolean if a field has been set. + +### GetOwnerRef + +`func (o *CampaignTemplate) GetOwnerRef() CampaignTemplateOwnerRef` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *CampaignTemplate) GetOwnerRefOk() (*CampaignTemplateOwnerRef, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *CampaignTemplate) SetOwnerRef(v CampaignTemplateOwnerRef)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *CampaignTemplate) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### GetDeadlineDuration + +`func (o *CampaignTemplate) GetDeadlineDuration() string` + +GetDeadlineDuration returns the DeadlineDuration field if non-nil, zero value otherwise. + +### GetDeadlineDurationOk + +`func (o *CampaignTemplate) GetDeadlineDurationOk() (*string, bool)` + +GetDeadlineDurationOk returns a tuple with the DeadlineDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadlineDuration + +`func (o *CampaignTemplate) SetDeadlineDuration(v string)` + +SetDeadlineDuration sets DeadlineDuration field to given value. + +### HasDeadlineDuration + +`func (o *CampaignTemplate) HasDeadlineDuration() bool` + +HasDeadlineDuration returns a boolean if a field has been set. + +### GetCampaign + +`func (o *CampaignTemplate) GetCampaign() Campaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignTemplate) GetCampaignOk() (*Campaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *CampaignTemplate) SetCampaign(v Campaign)` + +SetCampaign sets Campaign field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignTemplateOwnerRef.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignTemplateOwnerRef.md new file mode 100644 index 000000000..3eb23c140 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignTemplateOwnerRef.md @@ -0,0 +1,142 @@ +--- +id: campaign-template-owner-ref +title: CampaignTemplateOwnerRef +pagination_label: CampaignTemplateOwnerRef +sidebar_label: CampaignTemplateOwnerRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignTemplateOwnerRef', 'CampaignTemplateOwnerRef'] +slug: /tools/sdk/go/v3/models/campaign-template-owner-ref +tags: ['SDK', 'Software Development Kit', 'CampaignTemplateOwnerRef', 'CampaignTemplateOwnerRef'] +--- + +# CampaignTemplateOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the owner | [optional] +**Type** | Pointer to **string** | Type of the owner | [optional] +**Name** | Pointer to **string** | Name of the owner | [optional] +**Email** | Pointer to **string** | Email of the owner | [optional] + +## Methods + +### NewCampaignTemplateOwnerRef + +`func NewCampaignTemplateOwnerRef() *CampaignTemplateOwnerRef` + +NewCampaignTemplateOwnerRef instantiates a new CampaignTemplateOwnerRef 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 + +### NewCampaignTemplateOwnerRefWithDefaults + +`func NewCampaignTemplateOwnerRefWithDefaults() *CampaignTemplateOwnerRef` + +NewCampaignTemplateOwnerRefWithDefaults instantiates a new CampaignTemplateOwnerRef 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 + +### GetId + +`func (o *CampaignTemplateOwnerRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignTemplateOwnerRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CampaignTemplateOwnerRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CampaignTemplateOwnerRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CampaignTemplateOwnerRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CampaignTemplateOwnerRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CampaignTemplateOwnerRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CampaignTemplateOwnerRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *CampaignTemplateOwnerRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignTemplateOwnerRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CampaignTemplateOwnerRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CampaignTemplateOwnerRef) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *CampaignTemplateOwnerRef) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *CampaignTemplateOwnerRef) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *CampaignTemplateOwnerRef) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *CampaignTemplateOwnerRef) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CampaignsDeleteRequest.md b/docs/tools/sdk/go/Reference/V3/Models/CampaignsDeleteRequest.md new file mode 100644 index 000000000..7661f03c3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CampaignsDeleteRequest.md @@ -0,0 +1,64 @@ +--- +id: campaigns-delete-request +title: CampaignsDeleteRequest +pagination_label: CampaignsDeleteRequest +sidebar_label: CampaignsDeleteRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CampaignsDeleteRequest', 'CampaignsDeleteRequest'] +slug: /tools/sdk/go/v3/models/campaigns-delete-request +tags: ['SDK', 'Software Development Kit', 'CampaignsDeleteRequest', 'CampaignsDeleteRequest'] +--- + +# CampaignsDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]string** | The ids of the campaigns to delete | [optional] + +## Methods + +### NewCampaignsDeleteRequest + +`func NewCampaignsDeleteRequest() *CampaignsDeleteRequest` + +NewCampaignsDeleteRequest instantiates a new CampaignsDeleteRequest 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 + +### NewCampaignsDeleteRequestWithDefaults + +`func NewCampaignsDeleteRequestWithDefaults() *CampaignsDeleteRequest` + +NewCampaignsDeleteRequestWithDefaults instantiates a new CampaignsDeleteRequest 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 + +### GetIds + +`func (o *CampaignsDeleteRequest) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *CampaignsDeleteRequest) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *CampaignsDeleteRequest) SetIds(v []string)` + +SetIds sets Ids field to given value. + +### HasIds + +`func (o *CampaignsDeleteRequest) HasIds() bool` + +HasIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CancelAccessRequest.md b/docs/tools/sdk/go/Reference/V3/Models/CancelAccessRequest.md new file mode 100644 index 000000000..f8baabe3f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CancelAccessRequest.md @@ -0,0 +1,80 @@ +--- +id: cancel-access-request +title: CancelAccessRequest +pagination_label: CancelAccessRequest +sidebar_label: CancelAccessRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CancelAccessRequest', 'CancelAccessRequest'] +slug: /tools/sdk/go/v3/models/cancel-access-request +tags: ['SDK', 'Software Development Kit', 'CancelAccessRequest', 'CancelAccessRequest'] +--- + +# CancelAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountActivityId** | **string** | This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. | +**Comment** | **string** | Reason for cancelling the pending access request. | + +## Methods + +### NewCancelAccessRequest + +`func NewCancelAccessRequest(accountActivityId string, comment string, ) *CancelAccessRequest` + +NewCancelAccessRequest instantiates a new CancelAccessRequest 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 + +### NewCancelAccessRequestWithDefaults + +`func NewCancelAccessRequestWithDefaults() *CancelAccessRequest` + +NewCancelAccessRequestWithDefaults instantiates a new CancelAccessRequest 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 + +### GetAccountActivityId + +`func (o *CancelAccessRequest) GetAccountActivityId() string` + +GetAccountActivityId returns the AccountActivityId field if non-nil, zero value otherwise. + +### GetAccountActivityIdOk + +`func (o *CancelAccessRequest) GetAccountActivityIdOk() (*string, bool)` + +GetAccountActivityIdOk returns a tuple with the AccountActivityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActivityId + +`func (o *CancelAccessRequest) SetAccountActivityId(v string)` + +SetAccountActivityId sets AccountActivityId field to given value. + + +### GetComment + +`func (o *CancelAccessRequest) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CancelAccessRequest) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CancelAccessRequest) SetComment(v string)` + +SetComment sets Comment field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CancelledRequestDetails.md b/docs/tools/sdk/go/Reference/V3/Models/CancelledRequestDetails.md new file mode 100644 index 000000000..9643c82d1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CancelledRequestDetails.md @@ -0,0 +1,116 @@ +--- +id: cancelled-request-details +title: CancelledRequestDetails +pagination_label: CancelledRequestDetails +sidebar_label: CancelledRequestDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CancelledRequestDetails', 'CancelledRequestDetails'] +slug: /tools/sdk/go/v3/models/cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails', 'CancelledRequestDetails'] +--- + +# CancelledRequestDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment made by the owner when cancelling the associated request. | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Modified** | Pointer to **SailPointTime** | Date comment was added by the owner when cancelling the associated request. | [optional] + +## Methods + +### NewCancelledRequestDetails + +`func NewCancelledRequestDetails() *CancelledRequestDetails` + +NewCancelledRequestDetails instantiates a new CancelledRequestDetails 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 + +### NewCancelledRequestDetailsWithDefaults + +`func NewCancelledRequestDetailsWithDefaults() *CancelledRequestDetails` + +NewCancelledRequestDetailsWithDefaults instantiates a new CancelledRequestDetails 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 + +### GetComment + +`func (o *CancelledRequestDetails) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CancelledRequestDetails) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CancelledRequestDetails) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CancelledRequestDetails) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetOwner + +`func (o *CancelledRequestDetails) GetOwner() OwnerDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CancelledRequestDetails) GetOwnerOk() (*OwnerDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CancelledRequestDetails) SetOwner(v OwnerDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *CancelledRequestDetails) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetModified + +`func (o *CancelledRequestDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CancelledRequestDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CancelledRequestDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CancelledRequestDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Certification.md b/docs/tools/sdk/go/Reference/V3/Models/Certification.md new file mode 100644 index 000000000..087ad0712 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Certification.md @@ -0,0 +1,520 @@ +--- +id: certification +title: Certification +pagination_label: Certification +sidebar_label: Certification +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Certification', 'Certification'] +slug: /tools/sdk/go/v3/models/certification +tags: ['SDK', 'Software Development Kit', 'Certification', 'Certification'] +--- + +# Certification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | id of the certification | [optional] +**Name** | Pointer to **string** | name of the certification | [optional] +**Campaign** | Pointer to [**CampaignReference**](campaign-reference) | | [optional] +**Completed** | Pointer to **bool** | Have all decisions been made? | [optional] +**IdentitiesCompleted** | Pointer to **int32** | The number of identities for whom all decisions have been made and are complete. | [optional] +**IdentitiesTotal** | Pointer to **int32** | The total number of identities in the Certification, both complete and incomplete. | [optional] +**Created** | Pointer to **SailPointTime** | created date | [optional] +**Modified** | Pointer to **SailPointTime** | modified date | [optional] +**DecisionsMade** | Pointer to **int32** | The number of approve/revoke/acknowledge decisions that have been made. | [optional] +**DecisionsTotal** | Pointer to **int32** | The total number of approve/revoke/acknowledge decisions. | [optional] +**Due** | Pointer to **NullableTime** | The due date of the certification. | [optional] +**Signed** | Pointer to **NullableTime** | The date the reviewer signed off on the Certification. | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] +**Reassignment** | Pointer to [**NullableReassignment**](reassignment) | | [optional] +**HasErrors** | Pointer to **bool** | Identifies if the certification has an error | [optional] +**ErrorMessage** | Pointer to **NullableString** | Description of the certification error | [optional] +**Phase** | Pointer to [**CertificationPhase**](certification-phase) | | [optional] + +## Methods + +### NewCertification + +`func NewCertification() *Certification` + +NewCertification instantiates a new Certification 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 + +### NewCertificationWithDefaults + +`func NewCertificationWithDefaults() *Certification` + +NewCertificationWithDefaults instantiates a new Certification 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 + +### GetId + +`func (o *Certification) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Certification) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Certification) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Certification) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Certification) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Certification) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Certification) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Certification) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCampaign + +`func (o *Certification) GetCampaign() CampaignReference` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *Certification) GetCampaignOk() (*CampaignReference, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *Certification) SetCampaign(v CampaignReference)` + +SetCampaign sets Campaign field to given value. + +### HasCampaign + +`func (o *Certification) HasCampaign() bool` + +HasCampaign returns a boolean if a field has been set. + +### GetCompleted + +`func (o *Certification) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *Certification) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *Certification) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *Certification) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetIdentitiesCompleted + +`func (o *Certification) GetIdentitiesCompleted() int32` + +GetIdentitiesCompleted returns the IdentitiesCompleted field if non-nil, zero value otherwise. + +### GetIdentitiesCompletedOk + +`func (o *Certification) GetIdentitiesCompletedOk() (*int32, bool)` + +GetIdentitiesCompletedOk returns a tuple with the IdentitiesCompleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesCompleted + +`func (o *Certification) SetIdentitiesCompleted(v int32)` + +SetIdentitiesCompleted sets IdentitiesCompleted field to given value. + +### HasIdentitiesCompleted + +`func (o *Certification) HasIdentitiesCompleted() bool` + +HasIdentitiesCompleted returns a boolean if a field has been set. + +### GetIdentitiesTotal + +`func (o *Certification) GetIdentitiesTotal() int32` + +GetIdentitiesTotal returns the IdentitiesTotal field if non-nil, zero value otherwise. + +### GetIdentitiesTotalOk + +`func (o *Certification) GetIdentitiesTotalOk() (*int32, bool)` + +GetIdentitiesTotalOk returns a tuple with the IdentitiesTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesTotal + +`func (o *Certification) SetIdentitiesTotal(v int32)` + +SetIdentitiesTotal sets IdentitiesTotal field to given value. + +### HasIdentitiesTotal + +`func (o *Certification) HasIdentitiesTotal() bool` + +HasIdentitiesTotal returns a boolean if a field has been set. + +### GetCreated + +`func (o *Certification) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Certification) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Certification) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Certification) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Certification) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Certification) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Certification) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Certification) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDecisionsMade + +`func (o *Certification) GetDecisionsMade() int32` + +GetDecisionsMade returns the DecisionsMade field if non-nil, zero value otherwise. + +### GetDecisionsMadeOk + +`func (o *Certification) GetDecisionsMadeOk() (*int32, bool)` + +GetDecisionsMadeOk returns a tuple with the DecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsMade + +`func (o *Certification) SetDecisionsMade(v int32)` + +SetDecisionsMade sets DecisionsMade field to given value. + +### HasDecisionsMade + +`func (o *Certification) HasDecisionsMade() bool` + +HasDecisionsMade returns a boolean if a field has been set. + +### GetDecisionsTotal + +`func (o *Certification) GetDecisionsTotal() int32` + +GetDecisionsTotal returns the DecisionsTotal field if non-nil, zero value otherwise. + +### GetDecisionsTotalOk + +`func (o *Certification) GetDecisionsTotalOk() (*int32, bool)` + +GetDecisionsTotalOk returns a tuple with the DecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsTotal + +`func (o *Certification) SetDecisionsTotal(v int32)` + +SetDecisionsTotal sets DecisionsTotal field to given value. + +### HasDecisionsTotal + +`func (o *Certification) HasDecisionsTotal() bool` + +HasDecisionsTotal returns a boolean if a field has been set. + +### GetDue + +`func (o *Certification) GetDue() SailPointTime` + +GetDue returns the Due field if non-nil, zero value otherwise. + +### GetDueOk + +`func (o *Certification) GetDueOk() (*SailPointTime, bool)` + +GetDueOk returns a tuple with the Due field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDue + +`func (o *Certification) SetDue(v SailPointTime)` + +SetDue sets Due field to given value. + +### HasDue + +`func (o *Certification) HasDue() bool` + +HasDue returns a boolean if a field has been set. + +### SetDueNil + +`func (o *Certification) SetDueNil(b bool)` + + SetDueNil sets the value for Due to be an explicit nil + +### UnsetDue +`func (o *Certification) UnsetDue()` + +UnsetDue ensures that no value is present for Due, not even an explicit nil +### GetSigned + +`func (o *Certification) GetSigned() SailPointTime` + +GetSigned returns the Signed field if non-nil, zero value otherwise. + +### GetSignedOk + +`func (o *Certification) GetSignedOk() (*SailPointTime, bool)` + +GetSignedOk returns a tuple with the Signed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigned + +`func (o *Certification) SetSigned(v SailPointTime)` + +SetSigned sets Signed field to given value. + +### HasSigned + +`func (o *Certification) HasSigned() bool` + +HasSigned returns a boolean if a field has been set. + +### SetSignedNil + +`func (o *Certification) SetSignedNil(b bool)` + + SetSignedNil sets the value for Signed to be an explicit nil + +### UnsetSigned +`func (o *Certification) UnsetSigned()` + +UnsetSigned ensures that no value is present for Signed, not even an explicit nil +### GetReviewer + +`func (o *Certification) GetReviewer() Reviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *Certification) GetReviewerOk() (*Reviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *Certification) SetReviewer(v Reviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *Certification) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetReassignment + +`func (o *Certification) GetReassignment() Reassignment` + +GetReassignment returns the Reassignment field if non-nil, zero value otherwise. + +### GetReassignmentOk + +`func (o *Certification) GetReassignmentOk() (*Reassignment, bool)` + +GetReassignmentOk returns a tuple with the Reassignment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignment + +`func (o *Certification) SetReassignment(v Reassignment)` + +SetReassignment sets Reassignment field to given value. + +### HasReassignment + +`func (o *Certification) HasReassignment() bool` + +HasReassignment returns a boolean if a field has been set. + +### SetReassignmentNil + +`func (o *Certification) SetReassignmentNil(b bool)` + + SetReassignmentNil sets the value for Reassignment to be an explicit nil + +### UnsetReassignment +`func (o *Certification) UnsetReassignment()` + +UnsetReassignment ensures that no value is present for Reassignment, not even an explicit nil +### GetHasErrors + +`func (o *Certification) GetHasErrors() bool` + +GetHasErrors returns the HasErrors field if non-nil, zero value otherwise. + +### GetHasErrorsOk + +`func (o *Certification) GetHasErrorsOk() (*bool, bool)` + +GetHasErrorsOk returns a tuple with the HasErrors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasErrors + +`func (o *Certification) SetHasErrors(v bool)` + +SetHasErrors sets HasErrors field to given value. + +### HasHasErrors + +`func (o *Certification) HasHasErrors() bool` + +HasHasErrors returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *Certification) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *Certification) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *Certification) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *Certification) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### SetErrorMessageNil + +`func (o *Certification) SetErrorMessageNil(b bool)` + + SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil + +### UnsetErrorMessage +`func (o *Certification) UnsetErrorMessage()` + +UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil +### GetPhase + +`func (o *Certification) GetPhase() CertificationPhase` + +GetPhase returns the Phase field if non-nil, zero value otherwise. + +### GetPhaseOk + +`func (o *Certification) GetPhaseOk() (*CertificationPhase, bool)` + +GetPhaseOk returns a tuple with the Phase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhase + +`func (o *Certification) SetPhase(v CertificationPhase)` + +SetPhase sets Phase field to given value. + +### HasPhase + +`func (o *Certification) HasPhase() bool` + +HasPhase returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CertificationDecision.md b/docs/tools/sdk/go/Reference/V3/Models/CertificationDecision.md new file mode 100644 index 000000000..f6680f042 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CertificationDecision.md @@ -0,0 +1,21 @@ +--- +id: certification-decision +title: CertificationDecision +pagination_label: CertificationDecision +sidebar_label: CertificationDecision +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationDecision', 'CertificationDecision'] +slug: /tools/sdk/go/v3/models/certification-decision +tags: ['SDK', 'Software Development Kit', 'CertificationDecision', 'CertificationDecision'] +--- + +# CertificationDecision + +## Enum + + +* `APPROVE` (value: `"APPROVE"`) + +* `REVOKE` (value: `"REVOKE"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CertificationIdentitySummary.md b/docs/tools/sdk/go/Reference/V3/Models/CertificationIdentitySummary.md new file mode 100644 index 000000000..8389c1bb0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CertificationIdentitySummary.md @@ -0,0 +1,142 @@ +--- +id: certification-identity-summary +title: CertificationIdentitySummary +pagination_label: CertificationIdentitySummary +sidebar_label: CertificationIdentitySummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationIdentitySummary', 'CertificationIdentitySummary'] +slug: /tools/sdk/go/v3/models/certification-identity-summary +tags: ['SDK', 'Software Development Kit', 'CertificationIdentitySummary', 'CertificationIdentitySummary'] +--- + +# CertificationIdentitySummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the identity summary | [optional] +**Name** | Pointer to **string** | Name of the linked identity | [optional] +**IdentityId** | Pointer to **string** | The ID of the identity being certified | [optional] +**Completed** | Pointer to **bool** | Indicates whether the review items for the linked identity's certification have been completed | [optional] + +## Methods + +### NewCertificationIdentitySummary + +`func NewCertificationIdentitySummary() *CertificationIdentitySummary` + +NewCertificationIdentitySummary instantiates a new CertificationIdentitySummary 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 + +### NewCertificationIdentitySummaryWithDefaults + +`func NewCertificationIdentitySummaryWithDefaults() *CertificationIdentitySummary` + +NewCertificationIdentitySummaryWithDefaults instantiates a new CertificationIdentitySummary 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 + +### GetId + +`func (o *CertificationIdentitySummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertificationIdentitySummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertificationIdentitySummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CertificationIdentitySummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CertificationIdentitySummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CertificationIdentitySummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CertificationIdentitySummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CertificationIdentitySummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *CertificationIdentitySummary) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *CertificationIdentitySummary) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *CertificationIdentitySummary) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *CertificationIdentitySummary) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetCompleted + +`func (o *CertificationIdentitySummary) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *CertificationIdentitySummary) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *CertificationIdentitySummary) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *CertificationIdentitySummary) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CertificationPhase.md b/docs/tools/sdk/go/Reference/V3/Models/CertificationPhase.md new file mode 100644 index 000000000..0d02c08cc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CertificationPhase.md @@ -0,0 +1,23 @@ +--- +id: certification-phase +title: CertificationPhase +pagination_label: CertificationPhase +sidebar_label: CertificationPhase +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationPhase', 'CertificationPhase'] +slug: /tools/sdk/go/v3/models/certification-phase +tags: ['SDK', 'Software Development Kit', 'CertificationPhase', 'CertificationPhase'] +--- + +# CertificationPhase + +## Enum + + +* `STAGED` (value: `"STAGED"`) + +* `ACTIVE` (value: `"ACTIVE"`) + +* `SIGNED` (value: `"SIGNED"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CertificationReference.md b/docs/tools/sdk/go/Reference/V3/Models/CertificationReference.md new file mode 100644 index 000000000..c00b74725 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CertificationReference.md @@ -0,0 +1,142 @@ +--- +id: certification-reference +title: CertificationReference +pagination_label: CertificationReference +sidebar_label: CertificationReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationReference', 'CertificationReference'] +slug: /tools/sdk/go/v3/models/certification-reference +tags: ['SDK', 'Software Development Kit', 'CertificationReference', 'CertificationReference'] +--- + +# CertificationReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the certification. | [optional] +**Name** | Pointer to **string** | The name of the certification. | [optional] +**Type** | Pointer to **string** | | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] + +## Methods + +### NewCertificationReference + +`func NewCertificationReference() *CertificationReference` + +NewCertificationReference instantiates a new CertificationReference 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 + +### NewCertificationReferenceWithDefaults + +`func NewCertificationReferenceWithDefaults() *CertificationReference` + +NewCertificationReferenceWithDefaults instantiates a new CertificationReference 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 + +### GetId + +`func (o *CertificationReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertificationReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertificationReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CertificationReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CertificationReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CertificationReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CertificationReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CertificationReference) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *CertificationReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CertificationReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CertificationReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CertificationReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetReviewer + +`func (o *CertificationReference) GetReviewer() Reviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CertificationReference) GetReviewerOk() (*Reviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CertificationReference) SetReviewer(v Reviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *CertificationReference) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CertificationTask.md b/docs/tools/sdk/go/Reference/V3/Models/CertificationTask.md new file mode 100644 index 000000000..abf1bff0e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CertificationTask.md @@ -0,0 +1,246 @@ +--- +id: certification-task +title: CertificationTask +pagination_label: CertificationTask +sidebar_label: CertificationTask +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CertificationTask', 'CertificationTask'] +slug: /tools/sdk/go/v3/models/certification-task +tags: ['SDK', 'Software Development Kit', 'CertificationTask', 'CertificationTask'] +--- + +# CertificationTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the certification task. | [optional] +**Type** | Pointer to **string** | The type of the certification task. More values may be added in the future. | [optional] +**TargetType** | Pointer to **string** | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [optional] +**TargetId** | Pointer to **string** | The ID of the item being operated on by this task. | [optional] +**Status** | Pointer to **string** | The status of the task. | [optional] +**Errors** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] +**ReassignmentTrailDTOs** | Pointer to [**[]ReassignmentTrailDTO**](reassignment-trail-dto) | Reassignment trails that lead to self certification identity | [optional] +**Created** | Pointer to **SailPointTime** | The date and time on which this task was created. | [optional] + +## Methods + +### NewCertificationTask + +`func NewCertificationTask() *CertificationTask` + +NewCertificationTask instantiates a new CertificationTask 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 + +### NewCertificationTaskWithDefaults + +`func NewCertificationTaskWithDefaults() *CertificationTask` + +NewCertificationTaskWithDefaults instantiates a new CertificationTask 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 + +### GetId + +`func (o *CertificationTask) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CertificationTask) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CertificationTask) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CertificationTask) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *CertificationTask) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CertificationTask) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CertificationTask) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CertificationTask) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetTargetType + +`func (o *CertificationTask) GetTargetType() string` + +GetTargetType returns the TargetType field if non-nil, zero value otherwise. + +### GetTargetTypeOk + +`func (o *CertificationTask) GetTargetTypeOk() (*string, bool)` + +GetTargetTypeOk returns a tuple with the TargetType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetType + +`func (o *CertificationTask) SetTargetType(v string)` + +SetTargetType sets TargetType field to given value. + +### HasTargetType + +`func (o *CertificationTask) HasTargetType() bool` + +HasTargetType returns a boolean if a field has been set. + +### GetTargetId + +`func (o *CertificationTask) GetTargetId() string` + +GetTargetId returns the TargetId field if non-nil, zero value otherwise. + +### GetTargetIdOk + +`func (o *CertificationTask) GetTargetIdOk() (*string, bool)` + +GetTargetIdOk returns a tuple with the TargetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetId + +`func (o *CertificationTask) SetTargetId(v string)` + +SetTargetId sets TargetId field to given value. + +### HasTargetId + +`func (o *CertificationTask) HasTargetId() bool` + +HasTargetId returns a boolean if a field has been set. + +### GetStatus + +`func (o *CertificationTask) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CertificationTask) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *CertificationTask) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *CertificationTask) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetErrors + +`func (o *CertificationTask) GetErrors() []ErrorMessageDto` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *CertificationTask) GetErrorsOk() (*[]ErrorMessageDto, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *CertificationTask) SetErrors(v []ErrorMessageDto)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *CertificationTask) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### GetReassignmentTrailDTOs + +`func (o *CertificationTask) GetReassignmentTrailDTOs() []ReassignmentTrailDTO` + +GetReassignmentTrailDTOs returns the ReassignmentTrailDTOs field if non-nil, zero value otherwise. + +### GetReassignmentTrailDTOsOk + +`func (o *CertificationTask) GetReassignmentTrailDTOsOk() (*[]ReassignmentTrailDTO, bool)` + +GetReassignmentTrailDTOsOk returns a tuple with the ReassignmentTrailDTOs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignmentTrailDTOs + +`func (o *CertificationTask) SetReassignmentTrailDTOs(v []ReassignmentTrailDTO)` + +SetReassignmentTrailDTOs sets ReassignmentTrailDTOs field to given value. + +### HasReassignmentTrailDTOs + +`func (o *CertificationTask) HasReassignmentTrailDTOs() bool` + +HasReassignmentTrailDTOs returns a boolean if a field has been set. + +### GetCreated + +`func (o *CertificationTask) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CertificationTask) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CertificationTask) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CertificationTask) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ClientLogConfiguration.md b/docs/tools/sdk/go/Reference/V3/Models/ClientLogConfiguration.md new file mode 100644 index 000000000..d0ffbc355 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ClientLogConfiguration.md @@ -0,0 +1,163 @@ +--- +id: client-log-configuration +title: ClientLogConfiguration +pagination_label: ClientLogConfiguration +sidebar_label: ClientLogConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClientLogConfiguration', 'ClientLogConfiguration'] +slug: /tools/sdk/go/v3/models/client-log-configuration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfiguration', 'ClientLogConfiguration'] +--- + +# ClientLogConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **string** | Log configuration's client ID | [optional] +**DurationMinutes** | Pointer to **int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**Expiration** | Pointer to **SailPointTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] +**RootLevel** | [**StandardLevel**](standard-level) | | +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Methods + +### NewClientLogConfiguration + +`func NewClientLogConfiguration(rootLevel StandardLevel, ) *ClientLogConfiguration` + +NewClientLogConfiguration instantiates a new ClientLogConfiguration 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 + +### NewClientLogConfigurationWithDefaults + +`func NewClientLogConfigurationWithDefaults() *ClientLogConfiguration` + +NewClientLogConfigurationWithDefaults instantiates a new ClientLogConfiguration 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 + +### GetClientId + +`func (o *ClientLogConfiguration) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ClientLogConfiguration) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ClientLogConfiguration) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + +### HasClientId + +`func (o *ClientLogConfiguration) HasClientId() bool` + +HasClientId returns a boolean if a field has been set. + +### GetDurationMinutes + +`func (o *ClientLogConfiguration) GetDurationMinutes() int32` + +GetDurationMinutes returns the DurationMinutes field if non-nil, zero value otherwise. + +### GetDurationMinutesOk + +`func (o *ClientLogConfiguration) GetDurationMinutesOk() (*int32, bool)` + +GetDurationMinutesOk returns a tuple with the DurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDurationMinutes + +`func (o *ClientLogConfiguration) SetDurationMinutes(v int32)` + +SetDurationMinutes sets DurationMinutes field to given value. + +### HasDurationMinutes + +`func (o *ClientLogConfiguration) HasDurationMinutes() bool` + +HasDurationMinutes returns a boolean if a field has been set. + +### GetExpiration + +`func (o *ClientLogConfiguration) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *ClientLogConfiguration) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *ClientLogConfiguration) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *ClientLogConfiguration) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + +### GetRootLevel + +`func (o *ClientLogConfiguration) GetRootLevel() StandardLevel` + +GetRootLevel returns the RootLevel field if non-nil, zero value otherwise. + +### GetRootLevelOk + +`func (o *ClientLogConfiguration) GetRootLevelOk() (*StandardLevel, bool)` + +GetRootLevelOk returns a tuple with the RootLevel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootLevel + +`func (o *ClientLogConfiguration) SetRootLevel(v StandardLevel)` + +SetRootLevel sets RootLevel field to given value. + + +### GetLogLevels + +`func (o *ClientLogConfiguration) GetLogLevels() map[string]StandardLevel` + +GetLogLevels returns the LogLevels field if non-nil, zero value otherwise. + +### GetLogLevelsOk + +`func (o *ClientLogConfiguration) GetLogLevelsOk() (*map[string]StandardLevel, bool)` + +GetLogLevelsOk returns a tuple with the LogLevels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogLevels + +`func (o *ClientLogConfiguration) SetLogLevels(v map[string]StandardLevel)` + +SetLogLevels sets LogLevels field to given value. + +### HasLogLevels + +`func (o *ClientLogConfiguration) HasLogLevels() bool` + +HasLogLevels returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ClientLogConfigurationDurationMinutes.md b/docs/tools/sdk/go/Reference/V3/Models/ClientLogConfigurationDurationMinutes.md new file mode 100644 index 000000000..dcaf0b008 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ClientLogConfigurationDurationMinutes.md @@ -0,0 +1,137 @@ +--- +id: client-log-configuration-duration-minutes +title: ClientLogConfigurationDurationMinutes +pagination_label: ClientLogConfigurationDurationMinutes +sidebar_label: ClientLogConfigurationDurationMinutes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClientLogConfigurationDurationMinutes', 'ClientLogConfigurationDurationMinutes'] +slug: /tools/sdk/go/v3/models/client-log-configuration-duration-minutes +tags: ['SDK', 'Software Development Kit', 'ClientLogConfigurationDurationMinutes', 'ClientLogConfigurationDurationMinutes'] +--- + +# ClientLogConfigurationDurationMinutes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **string** | Log configuration's client ID | [optional] +**DurationMinutes** | Pointer to **int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**RootLevel** | [**StandardLevel**](standard-level) | | +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Methods + +### NewClientLogConfigurationDurationMinutes + +`func NewClientLogConfigurationDurationMinutes(rootLevel StandardLevel, ) *ClientLogConfigurationDurationMinutes` + +NewClientLogConfigurationDurationMinutes instantiates a new ClientLogConfigurationDurationMinutes 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 + +### NewClientLogConfigurationDurationMinutesWithDefaults + +`func NewClientLogConfigurationDurationMinutesWithDefaults() *ClientLogConfigurationDurationMinutes` + +NewClientLogConfigurationDurationMinutesWithDefaults instantiates a new ClientLogConfigurationDurationMinutes 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 + +### GetClientId + +`func (o *ClientLogConfigurationDurationMinutes) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ClientLogConfigurationDurationMinutes) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ClientLogConfigurationDurationMinutes) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + +### HasClientId + +`func (o *ClientLogConfigurationDurationMinutes) HasClientId() bool` + +HasClientId returns a boolean if a field has been set. + +### GetDurationMinutes + +`func (o *ClientLogConfigurationDurationMinutes) GetDurationMinutes() int32` + +GetDurationMinutes returns the DurationMinutes field if non-nil, zero value otherwise. + +### GetDurationMinutesOk + +`func (o *ClientLogConfigurationDurationMinutes) GetDurationMinutesOk() (*int32, bool)` + +GetDurationMinutesOk returns a tuple with the DurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDurationMinutes + +`func (o *ClientLogConfigurationDurationMinutes) SetDurationMinutes(v int32)` + +SetDurationMinutes sets DurationMinutes field to given value. + +### HasDurationMinutes + +`func (o *ClientLogConfigurationDurationMinutes) HasDurationMinutes() bool` + +HasDurationMinutes returns a boolean if a field has been set. + +### GetRootLevel + +`func (o *ClientLogConfigurationDurationMinutes) GetRootLevel() StandardLevel` + +GetRootLevel returns the RootLevel field if non-nil, zero value otherwise. + +### GetRootLevelOk + +`func (o *ClientLogConfigurationDurationMinutes) GetRootLevelOk() (*StandardLevel, bool)` + +GetRootLevelOk returns a tuple with the RootLevel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootLevel + +`func (o *ClientLogConfigurationDurationMinutes) SetRootLevel(v StandardLevel)` + +SetRootLevel sets RootLevel field to given value. + + +### GetLogLevels + +`func (o *ClientLogConfigurationDurationMinutes) GetLogLevels() map[string]StandardLevel` + +GetLogLevels returns the LogLevels field if non-nil, zero value otherwise. + +### GetLogLevelsOk + +`func (o *ClientLogConfigurationDurationMinutes) GetLogLevelsOk() (*map[string]StandardLevel, bool)` + +GetLogLevelsOk returns a tuple with the LogLevels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogLevels + +`func (o *ClientLogConfigurationDurationMinutes) SetLogLevels(v map[string]StandardLevel)` + +SetLogLevels sets LogLevels field to given value. + +### HasLogLevels + +`func (o *ClientLogConfigurationDurationMinutes) HasLogLevels() bool` + +HasLogLevels returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ClientLogConfigurationExpiration.md b/docs/tools/sdk/go/Reference/V3/Models/ClientLogConfigurationExpiration.md new file mode 100644 index 000000000..779386548 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ClientLogConfigurationExpiration.md @@ -0,0 +1,137 @@ +--- +id: client-log-configuration-expiration +title: ClientLogConfigurationExpiration +pagination_label: ClientLogConfigurationExpiration +sidebar_label: ClientLogConfigurationExpiration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClientLogConfigurationExpiration', 'ClientLogConfigurationExpiration'] +slug: /tools/sdk/go/v3/models/client-log-configuration-expiration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfigurationExpiration', 'ClientLogConfigurationExpiration'] +--- + +# ClientLogConfigurationExpiration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **string** | Log configuration's client ID | [optional] +**Expiration** | Pointer to **SailPointTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] +**RootLevel** | [**StandardLevel**](standard-level) | | +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Methods + +### NewClientLogConfigurationExpiration + +`func NewClientLogConfigurationExpiration(rootLevel StandardLevel, ) *ClientLogConfigurationExpiration` + +NewClientLogConfigurationExpiration instantiates a new ClientLogConfigurationExpiration 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 + +### NewClientLogConfigurationExpirationWithDefaults + +`func NewClientLogConfigurationExpirationWithDefaults() *ClientLogConfigurationExpiration` + +NewClientLogConfigurationExpirationWithDefaults instantiates a new ClientLogConfigurationExpiration 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 + +### GetClientId + +`func (o *ClientLogConfigurationExpiration) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ClientLogConfigurationExpiration) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ClientLogConfigurationExpiration) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + +### HasClientId + +`func (o *ClientLogConfigurationExpiration) HasClientId() bool` + +HasClientId returns a boolean if a field has been set. + +### GetExpiration + +`func (o *ClientLogConfigurationExpiration) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *ClientLogConfigurationExpiration) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *ClientLogConfigurationExpiration) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *ClientLogConfigurationExpiration) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + +### GetRootLevel + +`func (o *ClientLogConfigurationExpiration) GetRootLevel() StandardLevel` + +GetRootLevel returns the RootLevel field if non-nil, zero value otherwise. + +### GetRootLevelOk + +`func (o *ClientLogConfigurationExpiration) GetRootLevelOk() (*StandardLevel, bool)` + +GetRootLevelOk returns a tuple with the RootLevel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootLevel + +`func (o *ClientLogConfigurationExpiration) SetRootLevel(v StandardLevel)` + +SetRootLevel sets RootLevel field to given value. + + +### GetLogLevels + +`func (o *ClientLogConfigurationExpiration) GetLogLevels() map[string]StandardLevel` + +GetLogLevels returns the LogLevels field if non-nil, zero value otherwise. + +### GetLogLevelsOk + +`func (o *ClientLogConfigurationExpiration) GetLogLevelsOk() (*map[string]StandardLevel, bool)` + +GetLogLevelsOk returns a tuple with the LogLevels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogLevels + +`func (o *ClientLogConfigurationExpiration) SetLogLevels(v map[string]StandardLevel)` + +SetLogLevels sets LogLevels field to given value. + +### HasLogLevels + +`func (o *ClientLogConfigurationExpiration) HasLogLevels() bool` + +HasLogLevels returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ClientType.md b/docs/tools/sdk/go/Reference/V3/Models/ClientType.md new file mode 100644 index 000000000..bc39c5d78 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ClientType.md @@ -0,0 +1,21 @@ +--- +id: client-type +title: ClientType +pagination_label: ClientType +sidebar_label: ClientType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ClientType', 'ClientType'] +slug: /tools/sdk/go/v3/models/client-type +tags: ['SDK', 'Software Development Kit', 'ClientType', 'ClientType'] +--- + +# ClientType + +## Enum + + +* `CONFIDENTIAL` (value: `"CONFIDENTIAL"`) + +* `PUBLIC` (value: `"PUBLIC"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Column.md b/docs/tools/sdk/go/Reference/V3/Models/Column.md new file mode 100644 index 000000000..025dc0e01 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Column.md @@ -0,0 +1,85 @@ +--- +id: column +title: Column +pagination_label: Column +sidebar_label: Column +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Column', 'Column'] +slug: /tools/sdk/go/v3/models/column +tags: ['SDK', 'Software Development Kit', 'Column', 'Column'] +--- + +# Column + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Field** | **string** | The name of the field. | +**Header** | Pointer to **string** | The value of the header. | [optional] + +## Methods + +### NewColumn + +`func NewColumn(field string, ) *Column` + +NewColumn instantiates a new Column 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 + +### NewColumnWithDefaults + +`func NewColumnWithDefaults() *Column` + +NewColumnWithDefaults instantiates a new Column 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 + +### GetField + +`func (o *Column) GetField() string` + +GetField returns the Field field if non-nil, zero value otherwise. + +### GetFieldOk + +`func (o *Column) GetFieldOk() (*string, bool)` + +GetFieldOk returns a tuple with the Field field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetField + +`func (o *Column) SetField(v string)` + +SetField sets Field field to given value. + + +### GetHeader + +`func (o *Column) GetHeader() string` + +GetHeader returns the Header field if non-nil, zero value otherwise. + +### GetHeaderOk + +`func (o *Column) GetHeaderOk() (*string, bool)` + +GetHeaderOk returns a tuple with the Header field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHeader + +`func (o *Column) SetHeader(v string)` + +SetHeader sets Header field to given value. + +### HasHeader + +`func (o *Column) HasHeader() bool` + +HasHeader returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Comment.md b/docs/tools/sdk/go/Reference/V3/Models/Comment.md new file mode 100644 index 000000000..24ac18fe9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Comment.md @@ -0,0 +1,142 @@ +--- +id: comment +title: Comment +pagination_label: Comment +sidebar_label: Comment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Comment', 'Comment'] +slug: /tools/sdk/go/v3/models/comment +tags: ['SDK', 'Software Development Kit', 'Comment', 'Comment'] +--- + +# Comment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommenterId** | Pointer to **string** | Id of the identity making the comment | [optional] +**CommenterName** | Pointer to **string** | Human-readable display name of the identity making the comment | [optional] +**Body** | Pointer to **string** | Content of the comment | [optional] +**Date** | Pointer to **SailPointTime** | Date and time comment was made | [optional] + +## Methods + +### NewComment + +`func NewComment() *Comment` + +NewComment instantiates a new Comment 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 + +### NewCommentWithDefaults + +`func NewCommentWithDefaults() *Comment` + +NewCommentWithDefaults instantiates a new Comment 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 + +### GetCommenterId + +`func (o *Comment) GetCommenterId() string` + +GetCommenterId returns the CommenterId field if non-nil, zero value otherwise. + +### GetCommenterIdOk + +`func (o *Comment) GetCommenterIdOk() (*string, bool)` + +GetCommenterIdOk returns a tuple with the CommenterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommenterId + +`func (o *Comment) SetCommenterId(v string)` + +SetCommenterId sets CommenterId field to given value. + +### HasCommenterId + +`func (o *Comment) HasCommenterId() bool` + +HasCommenterId returns a boolean if a field has been set. + +### GetCommenterName + +`func (o *Comment) GetCommenterName() string` + +GetCommenterName returns the CommenterName field if non-nil, zero value otherwise. + +### GetCommenterNameOk + +`func (o *Comment) GetCommenterNameOk() (*string, bool)` + +GetCommenterNameOk returns a tuple with the CommenterName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommenterName + +`func (o *Comment) SetCommenterName(v string)` + +SetCommenterName sets CommenterName field to given value. + +### HasCommenterName + +`func (o *Comment) HasCommenterName() bool` + +HasCommenterName returns a boolean if a field has been set. + +### GetBody + +`func (o *Comment) GetBody() string` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *Comment) GetBodyOk() (*string, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBody + +`func (o *Comment) SetBody(v string)` + +SetBody sets Body field to given value. + +### HasBody + +`func (o *Comment) HasBody() bool` + +HasBody returns a boolean if a field has been set. + +### GetDate + +`func (o *Comment) GetDate() SailPointTime` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *Comment) GetDateOk() (*SailPointTime, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *Comment) SetDate(v SailPointTime)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *Comment) HasDate() bool` + +HasDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CommentDto.md b/docs/tools/sdk/go/Reference/V3/Models/CommentDto.md new file mode 100644 index 000000000..445192e06 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CommentDto.md @@ -0,0 +1,126 @@ +--- +id: comment-dto +title: CommentDto +pagination_label: CommentDto +sidebar_label: CommentDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommentDto', 'CommentDto'] +slug: /tools/sdk/go/v3/models/comment-dto +tags: ['SDK', 'Software Development Kit', 'CommentDto', 'CommentDto'] +--- + +# CommentDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **NullableString** | Comment content. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Methods + +### NewCommentDto + +`func NewCommentDto() *CommentDto` + +NewCommentDto instantiates a new CommentDto 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 + +### NewCommentDtoWithDefaults + +`func NewCommentDtoWithDefaults() *CommentDto` + +NewCommentDtoWithDefaults instantiates a new CommentDto 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 + +### GetComment + +`func (o *CommentDto) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CommentDto) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CommentDto) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CommentDto) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *CommentDto) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *CommentDto) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetCreated + +`func (o *CommentDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CommentDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CommentDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CommentDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetAuthor + +`func (o *CommentDto) GetAuthor() CommentDtoAuthor` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *CommentDto) GetAuthorOk() (*CommentDtoAuthor, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *CommentDto) SetAuthor(v CommentDtoAuthor)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *CommentDto) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CommentDtoAuthor.md b/docs/tools/sdk/go/Reference/V3/Models/CommentDtoAuthor.md new file mode 100644 index 000000000..6df6a6dc7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CommentDtoAuthor.md @@ -0,0 +1,116 @@ +--- +id: comment-dto-author +title: CommentDtoAuthor +pagination_label: CommentDtoAuthor +sidebar_label: CommentDtoAuthor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CommentDtoAuthor', 'CommentDtoAuthor'] +slug: /tools/sdk/go/v3/models/comment-dto-author +tags: ['SDK', 'Software Development Kit', 'CommentDtoAuthor', 'CommentDtoAuthor'] +--- + +# CommentDtoAuthor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of object | [optional] +**Id** | Pointer to **string** | The unique ID of the object | [optional] +**Name** | Pointer to **string** | The display name of the object | [optional] + +## Methods + +### NewCommentDtoAuthor + +`func NewCommentDtoAuthor() *CommentDtoAuthor` + +NewCommentDtoAuthor instantiates a new CommentDtoAuthor 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 + +### NewCommentDtoAuthorWithDefaults + +`func NewCommentDtoAuthorWithDefaults() *CommentDtoAuthor` + +NewCommentDtoAuthorWithDefaults instantiates a new CommentDtoAuthor 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 + +### GetType + +`func (o *CommentDtoAuthor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CommentDtoAuthor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CommentDtoAuthor) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CommentDtoAuthor) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *CommentDtoAuthor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CommentDtoAuthor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CommentDtoAuthor) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CommentDtoAuthor) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CommentDtoAuthor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CommentDtoAuthor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CommentDtoAuthor) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CommentDtoAuthor) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CompletedApproval.md b/docs/tools/sdk/go/Reference/V3/Models/CompletedApproval.md new file mode 100644 index 000000000..b5dc6ae77 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CompletedApproval.md @@ -0,0 +1,722 @@ +--- +id: completed-approval +title: CompletedApproval +pagination_label: CompletedApproval +sidebar_label: CompletedApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApproval', 'CompletedApproval'] +slug: /tools/sdk/go/v3/models/completed-approval +tags: ['SDK', 'Software Development Kit', 'CompletedApproval', 'CompletedApproval'] +--- + +# CompletedApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The approval id. | [optional] +**Name** | Pointer to **string** | The name of the approval. | [optional] +**Created** | Pointer to **SailPointTime** | When the approval was created. | [optional] +**Modified** | Pointer to **SailPointTime** | When the approval was modified last time. | [optional] +**RequestCreated** | Pointer to **SailPointTime** | When the access-request was created. | [optional] +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**ReviewedBy** | Pointer to [**AccessItemReviewedBy**](access-item-reviewed-by) | | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**RequesterComment** | Pointer to [**CompletedApprovalRequesterComment**](completed-approval-requester-comment) | | [optional] +**ReviewerComment** | Pointer to [**CompletedApprovalReviewerComment**](completed-approval-reviewer-comment) | | [optional] +**PreviousReviewersComments** | Pointer to [**[]CommentDto**](comment-dto) | The history of the previous reviewers comments. | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**CommentRequiredWhenRejected** | Pointer to **bool** | When true the rejector has to provide comments when rejecting | [optional] [default to false] +**State** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] +**RemoveDate** | Pointer to **NullableTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**RemoveDateUpdateRequested** | Pointer to **bool** | If true, then the request was to change the remove date or sunset date. | [optional] [default to false] +**CurrentRemoveDate** | Pointer to **NullableTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**SodViolationContext** | Pointer to [**NullableSodViolationContextCheckCompleted**](sod-violation-context-check-completed) | | [optional] +**PreApprovalTriggerResult** | Pointer to [**NullableCompletedApprovalPreApprovalTriggerResult**](completed-approval-pre-approval-trigger-result) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs provided during the request. | [optional] +**RequestedAccounts** | Pointer to [**[]RequestedAccountRef**](requested-account-ref) | The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. | [optional] + +## Methods + +### NewCompletedApproval + +`func NewCompletedApproval() *CompletedApproval` + +NewCompletedApproval instantiates a new CompletedApproval 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 + +### NewCompletedApprovalWithDefaults + +`func NewCompletedApprovalWithDefaults() *CompletedApproval` + +NewCompletedApprovalWithDefaults instantiates a new CompletedApproval 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 + +### GetId + +`func (o *CompletedApproval) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CompletedApproval) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CompletedApproval) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CompletedApproval) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CompletedApproval) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CompletedApproval) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CompletedApproval) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CompletedApproval) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *CompletedApproval) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CompletedApproval) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CompletedApproval) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CompletedApproval) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *CompletedApproval) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CompletedApproval) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CompletedApproval) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CompletedApproval) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetRequestCreated + +`func (o *CompletedApproval) GetRequestCreated() SailPointTime` + +GetRequestCreated returns the RequestCreated field if non-nil, zero value otherwise. + +### GetRequestCreatedOk + +`func (o *CompletedApproval) GetRequestCreatedOk() (*SailPointTime, bool)` + +GetRequestCreatedOk returns a tuple with the RequestCreated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCreated + +`func (o *CompletedApproval) SetRequestCreated(v SailPointTime)` + +SetRequestCreated sets RequestCreated field to given value. + +### HasRequestCreated + +`func (o *CompletedApproval) HasRequestCreated() bool` + +HasRequestCreated returns a boolean if a field has been set. + +### GetRequestType + +`func (o *CompletedApproval) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *CompletedApproval) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *CompletedApproval) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *CompletedApproval) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *CompletedApproval) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *CompletedApproval) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetRequester + +`func (o *CompletedApproval) GetRequester() AccessItemRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *CompletedApproval) GetRequesterOk() (*AccessItemRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *CompletedApproval) SetRequester(v AccessItemRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *CompletedApproval) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRequestedFor + +`func (o *CompletedApproval) GetRequestedFor() RequestedItemStatusRequestedFor` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *CompletedApproval) GetRequestedForOk() (*RequestedItemStatusRequestedFor, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *CompletedApproval) SetRequestedFor(v RequestedItemStatusRequestedFor)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *CompletedApproval) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetReviewedBy + +`func (o *CompletedApproval) GetReviewedBy() AccessItemReviewedBy` + +GetReviewedBy returns the ReviewedBy field if non-nil, zero value otherwise. + +### GetReviewedByOk + +`func (o *CompletedApproval) GetReviewedByOk() (*AccessItemReviewedBy, bool)` + +GetReviewedByOk returns a tuple with the ReviewedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewedBy + +`func (o *CompletedApproval) SetReviewedBy(v AccessItemReviewedBy)` + +SetReviewedBy sets ReviewedBy field to given value. + +### HasReviewedBy + +`func (o *CompletedApproval) HasReviewedBy() bool` + +HasReviewedBy returns a boolean if a field has been set. + +### GetOwner + +`func (o *CompletedApproval) GetOwner() OwnerDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CompletedApproval) GetOwnerOk() (*OwnerDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CompletedApproval) SetOwner(v OwnerDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *CompletedApproval) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRequestedObject + +`func (o *CompletedApproval) GetRequestedObject() RequestableObjectReference` + +GetRequestedObject returns the RequestedObject field if non-nil, zero value otherwise. + +### GetRequestedObjectOk + +`func (o *CompletedApproval) GetRequestedObjectOk() (*RequestableObjectReference, bool)` + +GetRequestedObjectOk returns a tuple with the RequestedObject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObject + +`func (o *CompletedApproval) SetRequestedObject(v RequestableObjectReference)` + +SetRequestedObject sets RequestedObject field to given value. + +### HasRequestedObject + +`func (o *CompletedApproval) HasRequestedObject() bool` + +HasRequestedObject returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *CompletedApproval) GetRequesterComment() CompletedApprovalRequesterComment` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *CompletedApproval) GetRequesterCommentOk() (*CompletedApprovalRequesterComment, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *CompletedApproval) SetRequesterComment(v CompletedApprovalRequesterComment)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *CompletedApproval) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### GetReviewerComment + +`func (o *CompletedApproval) GetReviewerComment() CompletedApprovalReviewerComment` + +GetReviewerComment returns the ReviewerComment field if non-nil, zero value otherwise. + +### GetReviewerCommentOk + +`func (o *CompletedApproval) GetReviewerCommentOk() (*CompletedApprovalReviewerComment, bool)` + +GetReviewerCommentOk returns a tuple with the ReviewerComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewerComment + +`func (o *CompletedApproval) SetReviewerComment(v CompletedApprovalReviewerComment)` + +SetReviewerComment sets ReviewerComment field to given value. + +### HasReviewerComment + +`func (o *CompletedApproval) HasReviewerComment() bool` + +HasReviewerComment returns a boolean if a field has been set. + +### GetPreviousReviewersComments + +`func (o *CompletedApproval) GetPreviousReviewersComments() []CommentDto` + +GetPreviousReviewersComments returns the PreviousReviewersComments field if non-nil, zero value otherwise. + +### GetPreviousReviewersCommentsOk + +`func (o *CompletedApproval) GetPreviousReviewersCommentsOk() (*[]CommentDto, bool)` + +GetPreviousReviewersCommentsOk returns a tuple with the PreviousReviewersComments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousReviewersComments + +`func (o *CompletedApproval) SetPreviousReviewersComments(v []CommentDto)` + +SetPreviousReviewersComments sets PreviousReviewersComments field to given value. + +### HasPreviousReviewersComments + +`func (o *CompletedApproval) HasPreviousReviewersComments() bool` + +HasPreviousReviewersComments returns a boolean if a field has been set. + +### GetForwardHistory + +`func (o *CompletedApproval) GetForwardHistory() []ApprovalForwardHistory` + +GetForwardHistory returns the ForwardHistory field if non-nil, zero value otherwise. + +### GetForwardHistoryOk + +`func (o *CompletedApproval) GetForwardHistoryOk() (*[]ApprovalForwardHistory, bool)` + +GetForwardHistoryOk returns a tuple with the ForwardHistory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwardHistory + +`func (o *CompletedApproval) SetForwardHistory(v []ApprovalForwardHistory)` + +SetForwardHistory sets ForwardHistory field to given value. + +### HasForwardHistory + +`func (o *CompletedApproval) HasForwardHistory() bool` + +HasForwardHistory returns a boolean if a field has been set. + +### GetCommentRequiredWhenRejected + +`func (o *CompletedApproval) GetCommentRequiredWhenRejected() bool` + +GetCommentRequiredWhenRejected returns the CommentRequiredWhenRejected field if non-nil, zero value otherwise. + +### GetCommentRequiredWhenRejectedOk + +`func (o *CompletedApproval) GetCommentRequiredWhenRejectedOk() (*bool, bool)` + +GetCommentRequiredWhenRejectedOk returns a tuple with the CommentRequiredWhenRejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentRequiredWhenRejected + +`func (o *CompletedApproval) SetCommentRequiredWhenRejected(v bool)` + +SetCommentRequiredWhenRejected sets CommentRequiredWhenRejected field to given value. + +### HasCommentRequiredWhenRejected + +`func (o *CompletedApproval) HasCommentRequiredWhenRejected() bool` + +HasCommentRequiredWhenRejected returns a boolean if a field has been set. + +### GetState + +`func (o *CompletedApproval) GetState() CompletedApprovalState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *CompletedApproval) GetStateOk() (*CompletedApprovalState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *CompletedApproval) SetState(v CompletedApprovalState)` + +SetState sets State field to given value. + +### HasState + +`func (o *CompletedApproval) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *CompletedApproval) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *CompletedApproval) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *CompletedApproval) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *CompletedApproval) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *CompletedApproval) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *CompletedApproval) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil +### GetRemoveDateUpdateRequested + +`func (o *CompletedApproval) GetRemoveDateUpdateRequested() bool` + +GetRemoveDateUpdateRequested returns the RemoveDateUpdateRequested field if non-nil, zero value otherwise. + +### GetRemoveDateUpdateRequestedOk + +`func (o *CompletedApproval) GetRemoveDateUpdateRequestedOk() (*bool, bool)` + +GetRemoveDateUpdateRequestedOk returns a tuple with the RemoveDateUpdateRequested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDateUpdateRequested + +`func (o *CompletedApproval) SetRemoveDateUpdateRequested(v bool)` + +SetRemoveDateUpdateRequested sets RemoveDateUpdateRequested field to given value. + +### HasRemoveDateUpdateRequested + +`func (o *CompletedApproval) HasRemoveDateUpdateRequested() bool` + +HasRemoveDateUpdateRequested returns a boolean if a field has been set. + +### GetCurrentRemoveDate + +`func (o *CompletedApproval) GetCurrentRemoveDate() SailPointTime` + +GetCurrentRemoveDate returns the CurrentRemoveDate field if non-nil, zero value otherwise. + +### GetCurrentRemoveDateOk + +`func (o *CompletedApproval) GetCurrentRemoveDateOk() (*SailPointTime, bool)` + +GetCurrentRemoveDateOk returns a tuple with the CurrentRemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentRemoveDate + +`func (o *CompletedApproval) SetCurrentRemoveDate(v SailPointTime)` + +SetCurrentRemoveDate sets CurrentRemoveDate field to given value. + +### HasCurrentRemoveDate + +`func (o *CompletedApproval) HasCurrentRemoveDate() bool` + +HasCurrentRemoveDate returns a boolean if a field has been set. + +### SetCurrentRemoveDateNil + +`func (o *CompletedApproval) SetCurrentRemoveDateNil(b bool)` + + SetCurrentRemoveDateNil sets the value for CurrentRemoveDate to be an explicit nil + +### UnsetCurrentRemoveDate +`func (o *CompletedApproval) UnsetCurrentRemoveDate()` + +UnsetCurrentRemoveDate ensures that no value is present for CurrentRemoveDate, not even an explicit nil +### GetSodViolationContext + +`func (o *CompletedApproval) GetSodViolationContext() SodViolationContextCheckCompleted` + +GetSodViolationContext returns the SodViolationContext field if non-nil, zero value otherwise. + +### GetSodViolationContextOk + +`func (o *CompletedApproval) GetSodViolationContextOk() (*SodViolationContextCheckCompleted, bool)` + +GetSodViolationContextOk returns a tuple with the SodViolationContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodViolationContext + +`func (o *CompletedApproval) SetSodViolationContext(v SodViolationContextCheckCompleted)` + +SetSodViolationContext sets SodViolationContext field to given value. + +### HasSodViolationContext + +`func (o *CompletedApproval) HasSodViolationContext() bool` + +HasSodViolationContext returns a boolean if a field has been set. + +### SetSodViolationContextNil + +`func (o *CompletedApproval) SetSodViolationContextNil(b bool)` + + SetSodViolationContextNil sets the value for SodViolationContext to be an explicit nil + +### UnsetSodViolationContext +`func (o *CompletedApproval) UnsetSodViolationContext()` + +UnsetSodViolationContext ensures that no value is present for SodViolationContext, not even an explicit nil +### GetPreApprovalTriggerResult + +`func (o *CompletedApproval) GetPreApprovalTriggerResult() CompletedApprovalPreApprovalTriggerResult` + +GetPreApprovalTriggerResult returns the PreApprovalTriggerResult field if non-nil, zero value otherwise. + +### GetPreApprovalTriggerResultOk + +`func (o *CompletedApproval) GetPreApprovalTriggerResultOk() (*CompletedApprovalPreApprovalTriggerResult, bool)` + +GetPreApprovalTriggerResultOk returns a tuple with the PreApprovalTriggerResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreApprovalTriggerResult + +`func (o *CompletedApproval) SetPreApprovalTriggerResult(v CompletedApprovalPreApprovalTriggerResult)` + +SetPreApprovalTriggerResult sets PreApprovalTriggerResult field to given value. + +### HasPreApprovalTriggerResult + +`func (o *CompletedApproval) HasPreApprovalTriggerResult() bool` + +HasPreApprovalTriggerResult returns a boolean if a field has been set. + +### SetPreApprovalTriggerResultNil + +`func (o *CompletedApproval) SetPreApprovalTriggerResultNil(b bool)` + + SetPreApprovalTriggerResultNil sets the value for PreApprovalTriggerResult to be an explicit nil + +### UnsetPreApprovalTriggerResult +`func (o *CompletedApproval) UnsetPreApprovalTriggerResult()` + +UnsetPreApprovalTriggerResult ensures that no value is present for PreApprovalTriggerResult, not even an explicit nil +### GetClientMetadata + +`func (o *CompletedApproval) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *CompletedApproval) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *CompletedApproval) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *CompletedApproval) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRequestedAccounts + +`func (o *CompletedApproval) GetRequestedAccounts() []RequestedAccountRef` + +GetRequestedAccounts returns the RequestedAccounts field if non-nil, zero value otherwise. + +### GetRequestedAccountsOk + +`func (o *CompletedApproval) GetRequestedAccountsOk() (*[]RequestedAccountRef, bool)` + +GetRequestedAccountsOk returns a tuple with the RequestedAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedAccounts + +`func (o *CompletedApproval) SetRequestedAccounts(v []RequestedAccountRef)` + +SetRequestedAccounts sets RequestedAccounts field to given value. + +### HasRequestedAccounts + +`func (o *CompletedApproval) HasRequestedAccounts() bool` + +HasRequestedAccounts returns a boolean if a field has been set. + +### SetRequestedAccountsNil + +`func (o *CompletedApproval) SetRequestedAccountsNil(b bool)` + + SetRequestedAccountsNil sets the value for RequestedAccounts to be an explicit nil + +### UnsetRequestedAccounts +`func (o *CompletedApproval) UnsetRequestedAccounts()` + +UnsetRequestedAccounts ensures that no value is present for RequestedAccounts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CompletedApprovalPreApprovalTriggerResult.md b/docs/tools/sdk/go/Reference/V3/Models/CompletedApprovalPreApprovalTriggerResult.md new file mode 100644 index 000000000..d9239db7b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CompletedApprovalPreApprovalTriggerResult.md @@ -0,0 +1,142 @@ +--- +id: completed-approval-pre-approval-trigger-result +title: CompletedApprovalPreApprovalTriggerResult +pagination_label: CompletedApprovalPreApprovalTriggerResult +sidebar_label: CompletedApprovalPreApprovalTriggerResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApprovalPreApprovalTriggerResult', 'CompletedApprovalPreApprovalTriggerResult'] +slug: /tools/sdk/go/v3/models/completed-approval-pre-approval-trigger-result +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalPreApprovalTriggerResult', 'CompletedApprovalPreApprovalTriggerResult'] +--- + +# CompletedApprovalPreApprovalTriggerResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | The comment from the trigger | [optional] +**Decision** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] +**Reviewer** | Pointer to **string** | The name of the approver | [optional] +**Date** | Pointer to **SailPointTime** | The date and time the trigger decided on the request | [optional] + +## Methods + +### NewCompletedApprovalPreApprovalTriggerResult + +`func NewCompletedApprovalPreApprovalTriggerResult() *CompletedApprovalPreApprovalTriggerResult` + +NewCompletedApprovalPreApprovalTriggerResult instantiates a new CompletedApprovalPreApprovalTriggerResult 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 + +### NewCompletedApprovalPreApprovalTriggerResultWithDefaults + +`func NewCompletedApprovalPreApprovalTriggerResultWithDefaults() *CompletedApprovalPreApprovalTriggerResult` + +NewCompletedApprovalPreApprovalTriggerResultWithDefaults instantiates a new CompletedApprovalPreApprovalTriggerResult 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 + +### GetComment + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CompletedApprovalPreApprovalTriggerResult) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CompletedApprovalPreApprovalTriggerResult) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetDecision + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetDecision() CompletedApprovalState` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetDecisionOk() (*CompletedApprovalState, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *CompletedApprovalPreApprovalTriggerResult) SetDecision(v CompletedApprovalState)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *CompletedApprovalPreApprovalTriggerResult) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + +### GetReviewer + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetReviewer() string` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetReviewerOk() (*string, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *CompletedApprovalPreApprovalTriggerResult) SetReviewer(v string)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *CompletedApprovalPreApprovalTriggerResult) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetDate + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetDate() SailPointTime` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *CompletedApprovalPreApprovalTriggerResult) GetDateOk() (*SailPointTime, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *CompletedApprovalPreApprovalTriggerResult) SetDate(v SailPointTime)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *CompletedApprovalPreApprovalTriggerResult) HasDate() bool` + +HasDate returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CompletedApprovalRequesterComment.md b/docs/tools/sdk/go/Reference/V3/Models/CompletedApprovalRequesterComment.md new file mode 100644 index 000000000..0fac1adc5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CompletedApprovalRequesterComment.md @@ -0,0 +1,126 @@ +--- +id: completed-approval-requester-comment +title: CompletedApprovalRequesterComment +pagination_label: CompletedApprovalRequesterComment +sidebar_label: CompletedApprovalRequesterComment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApprovalRequesterComment', 'CompletedApprovalRequesterComment'] +slug: /tools/sdk/go/v3/models/completed-approval-requester-comment +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalRequesterComment', 'CompletedApprovalRequesterComment'] +--- + +# CompletedApprovalRequesterComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **NullableString** | Comment content. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Methods + +### NewCompletedApprovalRequesterComment + +`func NewCompletedApprovalRequesterComment() *CompletedApprovalRequesterComment` + +NewCompletedApprovalRequesterComment instantiates a new CompletedApprovalRequesterComment 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 + +### NewCompletedApprovalRequesterCommentWithDefaults + +`func NewCompletedApprovalRequesterCommentWithDefaults() *CompletedApprovalRequesterComment` + +NewCompletedApprovalRequesterCommentWithDefaults instantiates a new CompletedApprovalRequesterComment 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 + +### GetComment + +`func (o *CompletedApprovalRequesterComment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CompletedApprovalRequesterComment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CompletedApprovalRequesterComment) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CompletedApprovalRequesterComment) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *CompletedApprovalRequesterComment) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *CompletedApprovalRequesterComment) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetCreated + +`func (o *CompletedApprovalRequesterComment) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CompletedApprovalRequesterComment) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CompletedApprovalRequesterComment) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CompletedApprovalRequesterComment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetAuthor + +`func (o *CompletedApprovalRequesterComment) GetAuthor() CommentDtoAuthor` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *CompletedApprovalRequesterComment) GetAuthorOk() (*CommentDtoAuthor, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *CompletedApprovalRequesterComment) SetAuthor(v CommentDtoAuthor)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *CompletedApprovalRequesterComment) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CompletedApprovalReviewerComment.md b/docs/tools/sdk/go/Reference/V3/Models/CompletedApprovalReviewerComment.md new file mode 100644 index 000000000..8a81c51de --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CompletedApprovalReviewerComment.md @@ -0,0 +1,126 @@ +--- +id: completed-approval-reviewer-comment +title: CompletedApprovalReviewerComment +pagination_label: CompletedApprovalReviewerComment +sidebar_label: CompletedApprovalReviewerComment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApprovalReviewerComment', 'CompletedApprovalReviewerComment'] +slug: /tools/sdk/go/v3/models/completed-approval-reviewer-comment +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalReviewerComment', 'CompletedApprovalReviewerComment'] +--- + +# CompletedApprovalReviewerComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **NullableString** | Comment content. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Methods + +### NewCompletedApprovalReviewerComment + +`func NewCompletedApprovalReviewerComment() *CompletedApprovalReviewerComment` + +NewCompletedApprovalReviewerComment instantiates a new CompletedApprovalReviewerComment 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 + +### NewCompletedApprovalReviewerCommentWithDefaults + +`func NewCompletedApprovalReviewerCommentWithDefaults() *CompletedApprovalReviewerComment` + +NewCompletedApprovalReviewerCommentWithDefaults instantiates a new CompletedApprovalReviewerComment 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 + +### GetComment + +`func (o *CompletedApprovalReviewerComment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *CompletedApprovalReviewerComment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *CompletedApprovalReviewerComment) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *CompletedApprovalReviewerComment) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *CompletedApprovalReviewerComment) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *CompletedApprovalReviewerComment) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetCreated + +`func (o *CompletedApprovalReviewerComment) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CompletedApprovalReviewerComment) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CompletedApprovalReviewerComment) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CompletedApprovalReviewerComment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetAuthor + +`func (o *CompletedApprovalReviewerComment) GetAuthor() CommentDtoAuthor` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *CompletedApprovalReviewerComment) GetAuthorOk() (*CommentDtoAuthor, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *CompletedApprovalReviewerComment) SetAuthor(v CommentDtoAuthor)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *CompletedApprovalReviewerComment) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CompletedApprovalState.md b/docs/tools/sdk/go/Reference/V3/Models/CompletedApprovalState.md new file mode 100644 index 000000000..ce9f8c56b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CompletedApprovalState.md @@ -0,0 +1,21 @@ +--- +id: completed-approval-state +title: CompletedApprovalState +pagination_label: CompletedApprovalState +sidebar_label: CompletedApprovalState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletedApprovalState', 'CompletedApprovalState'] +slug: /tools/sdk/go/v3/models/completed-approval-state +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalState', 'CompletedApprovalState'] +--- + +# CompletedApprovalState + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CompletionStatus.md b/docs/tools/sdk/go/Reference/V3/Models/CompletionStatus.md new file mode 100644 index 000000000..5c7659087 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CompletionStatus.md @@ -0,0 +1,25 @@ +--- +id: completion-status +title: CompletionStatus +pagination_label: CompletionStatus +sidebar_label: CompletionStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CompletionStatus', 'CompletionStatus'] +slug: /tools/sdk/go/v3/models/completion-status +tags: ['SDK', 'Software Development Kit', 'CompletionStatus', 'CompletionStatus'] +--- + +# CompletionStatus + +## Enum + + +* `SUCCESS` (value: `"SUCCESS"`) + +* `FAILURE` (value: `"FAILURE"`) + +* `INCOMPLETE` (value: `"INCOMPLETE"`) + +* `PENDING` (value: `"PENDING"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ConflictingAccessCriteria.md b/docs/tools/sdk/go/Reference/V3/Models/ConflictingAccessCriteria.md new file mode 100644 index 000000000..df4ee1315 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ConflictingAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: conflicting-access-criteria +title: ConflictingAccessCriteria +pagination_label: ConflictingAccessCriteria +sidebar_label: ConflictingAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConflictingAccessCriteria', 'ConflictingAccessCriteria'] +slug: /tools/sdk/go/v3/models/conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'ConflictingAccessCriteria', 'ConflictingAccessCriteria'] +--- + +# ConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] +**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] + +## Methods + +### NewConflictingAccessCriteria + +`func NewConflictingAccessCriteria() *ConflictingAccessCriteria` + +NewConflictingAccessCriteria instantiates a new ConflictingAccessCriteria 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 + +### NewConflictingAccessCriteriaWithDefaults + +`func NewConflictingAccessCriteriaWithDefaults() *ConflictingAccessCriteria` + +NewConflictingAccessCriteriaWithDefaults instantiates a new ConflictingAccessCriteria 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 + +### GetLeftCriteria + +`func (o *ConflictingAccessCriteria) GetLeftCriteria() AccessCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *ConflictingAccessCriteria) GetLeftCriteriaOk() (*AccessCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *ConflictingAccessCriteria) SetLeftCriteria(v AccessCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *ConflictingAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *ConflictingAccessCriteria) GetRightCriteria() AccessCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *ConflictingAccessCriteria) GetRightCriteriaOk() (*AccessCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *ConflictingAccessCriteria) SetRightCriteria(v AccessCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *ConflictingAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ConnectorDetail.md b/docs/tools/sdk/go/Reference/V3/Models/ConnectorDetail.md new file mode 100644 index 000000000..2b715c40d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ConnectorDetail.md @@ -0,0 +1,464 @@ +--- +id: connector-detail +title: ConnectorDetail +pagination_label: ConnectorDetail +sidebar_label: ConnectorDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ConnectorDetail', 'ConnectorDetail'] +slug: /tools/sdk/go/v3/models/connector-detail +tags: ['SDK', 'Software Development Kit', 'ConnectorDetail', 'ConnectorDetail'] +--- + +# ConnectorDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The connector name | [optional] +**Type** | Pointer to **string** | The connector type | [optional] +**ClassName** | Pointer to **string** | The connector class name | [optional] +**ScriptName** | Pointer to **string** | The connector script name | [optional] +**ApplicationXml** | Pointer to **string** | The connector application xml | [optional] +**CorrelationConfigXml** | Pointer to **string** | The connector correlation config xml | [optional] +**SourceConfigXml** | Pointer to **string** | The connector source config xml | [optional] +**SourceConfig** | Pointer to **string** | The connector source config | [optional] +**SourceConfigFrom** | Pointer to **string** | The connector source config origin | [optional] +**S3Location** | Pointer to **string** | storage path key for this connector | [optional] +**UploadedFiles** | Pointer to **[]string** | The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. | [optional] +**FileUpload** | Pointer to **bool** | true if the source is file upload | [optional] [default to false] +**DirectConnect** | Pointer to **bool** | true if the source is a direct connect source | [optional] [default to false] +**TranslationProperties** | Pointer to **map[string]interface{}** | A map containing translation attributes by loacale key | [optional] +**ConnectorMetadata** | Pointer to **map[string]interface{}** | A map containing metadata pertinent to the UI to be used | [optional] +**Status** | Pointer to **string** | The connector status | [optional] + +## Methods + +### NewConnectorDetail + +`func NewConnectorDetail() *ConnectorDetail` + +NewConnectorDetail instantiates a new ConnectorDetail 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 + +### NewConnectorDetailWithDefaults + +`func NewConnectorDetailWithDefaults() *ConnectorDetail` + +NewConnectorDetailWithDefaults instantiates a new ConnectorDetail 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 + +### GetName + +`func (o *ConnectorDetail) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ConnectorDetail) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ConnectorDetail) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ConnectorDetail) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *ConnectorDetail) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ConnectorDetail) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ConnectorDetail) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ConnectorDetail) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetClassName + +`func (o *ConnectorDetail) GetClassName() string` + +GetClassName returns the ClassName field if non-nil, zero value otherwise. + +### GetClassNameOk + +`func (o *ConnectorDetail) GetClassNameOk() (*string, bool)` + +GetClassNameOk returns a tuple with the ClassName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClassName + +`func (o *ConnectorDetail) SetClassName(v string)` + +SetClassName sets ClassName field to given value. + +### HasClassName + +`func (o *ConnectorDetail) HasClassName() bool` + +HasClassName returns a boolean if a field has been set. + +### GetScriptName + +`func (o *ConnectorDetail) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *ConnectorDetail) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *ConnectorDetail) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + +### HasScriptName + +`func (o *ConnectorDetail) HasScriptName() bool` + +HasScriptName returns a boolean if a field has been set. + +### GetApplicationXml + +`func (o *ConnectorDetail) GetApplicationXml() string` + +GetApplicationXml returns the ApplicationXml field if non-nil, zero value otherwise. + +### GetApplicationXmlOk + +`func (o *ConnectorDetail) GetApplicationXmlOk() (*string, bool)` + +GetApplicationXmlOk returns a tuple with the ApplicationXml field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationXml + +`func (o *ConnectorDetail) SetApplicationXml(v string)` + +SetApplicationXml sets ApplicationXml field to given value. + +### HasApplicationXml + +`func (o *ConnectorDetail) HasApplicationXml() bool` + +HasApplicationXml returns a boolean if a field has been set. + +### GetCorrelationConfigXml + +`func (o *ConnectorDetail) GetCorrelationConfigXml() string` + +GetCorrelationConfigXml returns the CorrelationConfigXml field if non-nil, zero value otherwise. + +### GetCorrelationConfigXmlOk + +`func (o *ConnectorDetail) GetCorrelationConfigXmlOk() (*string, bool)` + +GetCorrelationConfigXmlOk returns a tuple with the CorrelationConfigXml field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelationConfigXml + +`func (o *ConnectorDetail) SetCorrelationConfigXml(v string)` + +SetCorrelationConfigXml sets CorrelationConfigXml field to given value. + +### HasCorrelationConfigXml + +`func (o *ConnectorDetail) HasCorrelationConfigXml() bool` + +HasCorrelationConfigXml returns a boolean if a field has been set. + +### GetSourceConfigXml + +`func (o *ConnectorDetail) GetSourceConfigXml() string` + +GetSourceConfigXml returns the SourceConfigXml field if non-nil, zero value otherwise. + +### GetSourceConfigXmlOk + +`func (o *ConnectorDetail) GetSourceConfigXmlOk() (*string, bool)` + +GetSourceConfigXmlOk returns a tuple with the SourceConfigXml field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceConfigXml + +`func (o *ConnectorDetail) SetSourceConfigXml(v string)` + +SetSourceConfigXml sets SourceConfigXml field to given value. + +### HasSourceConfigXml + +`func (o *ConnectorDetail) HasSourceConfigXml() bool` + +HasSourceConfigXml returns a boolean if a field has been set. + +### GetSourceConfig + +`func (o *ConnectorDetail) GetSourceConfig() string` + +GetSourceConfig returns the SourceConfig field if non-nil, zero value otherwise. + +### GetSourceConfigOk + +`func (o *ConnectorDetail) GetSourceConfigOk() (*string, bool)` + +GetSourceConfigOk returns a tuple with the SourceConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceConfig + +`func (o *ConnectorDetail) SetSourceConfig(v string)` + +SetSourceConfig sets SourceConfig field to given value. + +### HasSourceConfig + +`func (o *ConnectorDetail) HasSourceConfig() bool` + +HasSourceConfig returns a boolean if a field has been set. + +### GetSourceConfigFrom + +`func (o *ConnectorDetail) GetSourceConfigFrom() string` + +GetSourceConfigFrom returns the SourceConfigFrom field if non-nil, zero value otherwise. + +### GetSourceConfigFromOk + +`func (o *ConnectorDetail) GetSourceConfigFromOk() (*string, bool)` + +GetSourceConfigFromOk returns a tuple with the SourceConfigFrom field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceConfigFrom + +`func (o *ConnectorDetail) SetSourceConfigFrom(v string)` + +SetSourceConfigFrom sets SourceConfigFrom field to given value. + +### HasSourceConfigFrom + +`func (o *ConnectorDetail) HasSourceConfigFrom() bool` + +HasSourceConfigFrom returns a boolean if a field has been set. + +### GetS3Location + +`func (o *ConnectorDetail) GetS3Location() string` + +GetS3Location returns the S3Location field if non-nil, zero value otherwise. + +### GetS3LocationOk + +`func (o *ConnectorDetail) GetS3LocationOk() (*string, bool)` + +GetS3LocationOk returns a tuple with the S3Location field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetS3Location + +`func (o *ConnectorDetail) SetS3Location(v string)` + +SetS3Location sets S3Location field to given value. + +### HasS3Location + +`func (o *ConnectorDetail) HasS3Location() bool` + +HasS3Location returns a boolean if a field has been set. + +### GetUploadedFiles + +`func (o *ConnectorDetail) GetUploadedFiles() []string` + +GetUploadedFiles returns the UploadedFiles field if non-nil, zero value otherwise. + +### GetUploadedFilesOk + +`func (o *ConnectorDetail) GetUploadedFilesOk() (*[]string, bool)` + +GetUploadedFilesOk returns a tuple with the UploadedFiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUploadedFiles + +`func (o *ConnectorDetail) SetUploadedFiles(v []string)` + +SetUploadedFiles sets UploadedFiles field to given value. + +### HasUploadedFiles + +`func (o *ConnectorDetail) HasUploadedFiles() bool` + +HasUploadedFiles returns a boolean if a field has been set. + +### SetUploadedFilesNil + +`func (o *ConnectorDetail) SetUploadedFilesNil(b bool)` + + SetUploadedFilesNil sets the value for UploadedFiles to be an explicit nil + +### UnsetUploadedFiles +`func (o *ConnectorDetail) UnsetUploadedFiles()` + +UnsetUploadedFiles ensures that no value is present for UploadedFiles, not even an explicit nil +### GetFileUpload + +`func (o *ConnectorDetail) GetFileUpload() bool` + +GetFileUpload returns the FileUpload field if non-nil, zero value otherwise. + +### GetFileUploadOk + +`func (o *ConnectorDetail) GetFileUploadOk() (*bool, bool)` + +GetFileUploadOk returns a tuple with the FileUpload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFileUpload + +`func (o *ConnectorDetail) SetFileUpload(v bool)` + +SetFileUpload sets FileUpload field to given value. + +### HasFileUpload + +`func (o *ConnectorDetail) HasFileUpload() bool` + +HasFileUpload returns a boolean if a field has been set. + +### GetDirectConnect + +`func (o *ConnectorDetail) GetDirectConnect() bool` + +GetDirectConnect returns the DirectConnect field if non-nil, zero value otherwise. + +### GetDirectConnectOk + +`func (o *ConnectorDetail) GetDirectConnectOk() (*bool, bool)` + +GetDirectConnectOk returns a tuple with the DirectConnect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectConnect + +`func (o *ConnectorDetail) SetDirectConnect(v bool)` + +SetDirectConnect sets DirectConnect field to given value. + +### HasDirectConnect + +`func (o *ConnectorDetail) HasDirectConnect() bool` + +HasDirectConnect returns a boolean if a field has been set. + +### GetTranslationProperties + +`func (o *ConnectorDetail) GetTranslationProperties() map[string]interface{}` + +GetTranslationProperties returns the TranslationProperties field if non-nil, zero value otherwise. + +### GetTranslationPropertiesOk + +`func (o *ConnectorDetail) GetTranslationPropertiesOk() (*map[string]interface{}, bool)` + +GetTranslationPropertiesOk returns a tuple with the TranslationProperties field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTranslationProperties + +`func (o *ConnectorDetail) SetTranslationProperties(v map[string]interface{})` + +SetTranslationProperties sets TranslationProperties field to given value. + +### HasTranslationProperties + +`func (o *ConnectorDetail) HasTranslationProperties() bool` + +HasTranslationProperties returns a boolean if a field has been set. + +### GetConnectorMetadata + +`func (o *ConnectorDetail) GetConnectorMetadata() map[string]interface{}` + +GetConnectorMetadata returns the ConnectorMetadata field if non-nil, zero value otherwise. + +### GetConnectorMetadataOk + +`func (o *ConnectorDetail) GetConnectorMetadataOk() (*map[string]interface{}, bool)` + +GetConnectorMetadataOk returns a tuple with the ConnectorMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorMetadata + +`func (o *ConnectorDetail) SetConnectorMetadata(v map[string]interface{})` + +SetConnectorMetadata sets ConnectorMetadata field to given value. + +### HasConnectorMetadata + +`func (o *ConnectorDetail) HasConnectorMetadata() bool` + +HasConnectorMetadata returns a boolean if a field has been set. + +### GetStatus + +`func (o *ConnectorDetail) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ConnectorDetail) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ConnectorDetail) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ConnectorDetail) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CreateExternalExecuteWorkflow200Response.md b/docs/tools/sdk/go/Reference/V3/Models/CreateExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..d5ae90c04 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CreateExternalExecuteWorkflow200Response.md @@ -0,0 +1,90 @@ +--- +id: create-external-execute-workflow200-response +title: CreateExternalExecuteWorkflow200Response +pagination_label: CreateExternalExecuteWorkflow200Response +sidebar_label: CreateExternalExecuteWorkflow200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateExternalExecuteWorkflow200Response', 'CreateExternalExecuteWorkflow200Response'] +slug: /tools/sdk/go/v3/models/create-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflow200Response', 'CreateExternalExecuteWorkflow200Response'] +--- + +# CreateExternalExecuteWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**WorkflowExecutionId** | Pointer to **string** | The workflow execution id | [optional] +**Message** | Pointer to **string** | An error message if any errors occurred | [optional] + +## Methods + +### NewCreateExternalExecuteWorkflow200Response + +`func NewCreateExternalExecuteWorkflow200Response() *CreateExternalExecuteWorkflow200Response` + +NewCreateExternalExecuteWorkflow200Response instantiates a new CreateExternalExecuteWorkflow200Response 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 + +### NewCreateExternalExecuteWorkflow200ResponseWithDefaults + +`func NewCreateExternalExecuteWorkflow200ResponseWithDefaults() *CreateExternalExecuteWorkflow200Response` + +NewCreateExternalExecuteWorkflow200ResponseWithDefaults instantiates a new CreateExternalExecuteWorkflow200Response 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 + +### GetWorkflowExecutionId + +`func (o *CreateExternalExecuteWorkflow200Response) GetWorkflowExecutionId() string` + +GetWorkflowExecutionId returns the WorkflowExecutionId field if non-nil, zero value otherwise. + +### GetWorkflowExecutionIdOk + +`func (o *CreateExternalExecuteWorkflow200Response) GetWorkflowExecutionIdOk() (*string, bool)` + +GetWorkflowExecutionIdOk returns a tuple with the WorkflowExecutionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWorkflowExecutionId + +`func (o *CreateExternalExecuteWorkflow200Response) SetWorkflowExecutionId(v string)` + +SetWorkflowExecutionId sets WorkflowExecutionId field to given value. + +### HasWorkflowExecutionId + +`func (o *CreateExternalExecuteWorkflow200Response) HasWorkflowExecutionId() bool` + +HasWorkflowExecutionId returns a boolean if a field has been set. + +### GetMessage + +`func (o *CreateExternalExecuteWorkflow200Response) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *CreateExternalExecuteWorkflow200Response) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *CreateExternalExecuteWorkflow200Response) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *CreateExternalExecuteWorkflow200Response) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CreateExternalExecuteWorkflowRequest.md b/docs/tools/sdk/go/Reference/V3/Models/CreateExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..2c5971fe1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CreateExternalExecuteWorkflowRequest.md @@ -0,0 +1,64 @@ +--- +id: create-external-execute-workflow-request +title: CreateExternalExecuteWorkflowRequest +pagination_label: CreateExternalExecuteWorkflowRequest +sidebar_label: CreateExternalExecuteWorkflowRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateExternalExecuteWorkflowRequest', 'CreateExternalExecuteWorkflowRequest'] +slug: /tools/sdk/go/v3/models/create-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflowRequest', 'CreateExternalExecuteWorkflowRequest'] +--- + +# CreateExternalExecuteWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | Pointer to **map[string]interface{}** | The input for the workflow | [optional] + +## Methods + +### NewCreateExternalExecuteWorkflowRequest + +`func NewCreateExternalExecuteWorkflowRequest() *CreateExternalExecuteWorkflowRequest` + +NewCreateExternalExecuteWorkflowRequest instantiates a new CreateExternalExecuteWorkflowRequest 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 + +### NewCreateExternalExecuteWorkflowRequestWithDefaults + +`func NewCreateExternalExecuteWorkflowRequestWithDefaults() *CreateExternalExecuteWorkflowRequest` + +NewCreateExternalExecuteWorkflowRequestWithDefaults instantiates a new CreateExternalExecuteWorkflowRequest 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 + +### GetInput + +`func (o *CreateExternalExecuteWorkflowRequest) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *CreateExternalExecuteWorkflowRequest) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *CreateExternalExecuteWorkflowRequest) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + +### HasInput + +`func (o *CreateExternalExecuteWorkflowRequest) HasInput() bool` + +HasInput returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CreateOAuthClientRequest.md b/docs/tools/sdk/go/Reference/V3/Models/CreateOAuthClientRequest.md new file mode 100644 index 000000000..00ed671b5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CreateOAuthClientRequest.md @@ -0,0 +1,468 @@ +--- +id: create-o-auth-client-request +title: CreateOAuthClientRequest +pagination_label: CreateOAuthClientRequest +sidebar_label: CreateOAuthClientRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateOAuthClientRequest', 'CreateOAuthClientRequest'] +slug: /tools/sdk/go/v3/models/create-o-auth-client-request +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientRequest', 'CreateOAuthClientRequest'] +--- + +# CreateOAuthClientRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BusinessName** | Pointer to **NullableString** | The name of the business the API Client should belong to | [optional] +**HomepageUrl** | Pointer to **NullableString** | The homepage URL associated with the owner of the API Client | [optional] +**Name** | **NullableString** | A human-readable name for the API Client | +**Description** | **NullableString** | A description of the API Client | +**AccessTokenValiditySeconds** | **int32** | The number of seconds an access token generated for this API Client is valid for | +**RefreshTokenValiditySeconds** | Pointer to **int32** | The number of seconds a refresh token generated for this API Client is valid for | [optional] +**RedirectUris** | Pointer to **[]string** | A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. | [optional] +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | +**AccessType** | [**AccessType**](access-type) | | +**Type** | Pointer to [**ClientType**](client-type) | | [optional] +**Internal** | Pointer to **bool** | An indicator of whether the API Client can be used for requests internal within the product. | [optional] +**Enabled** | **bool** | An indicator of whether the API Client is enabled for use | +**StrongAuthSupported** | Pointer to **bool** | An indicator of whether the API Client supports strong authentication | [optional] +**ClaimsSupported** | Pointer to **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [optional] +**Scope** | Pointer to **[]string** | Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it. | [optional] + +## Methods + +### NewCreateOAuthClientRequest + +`func NewCreateOAuthClientRequest(name NullableString, description NullableString, accessTokenValiditySeconds int32, grantTypes []GrantType, accessType AccessType, enabled bool, ) *CreateOAuthClientRequest` + +NewCreateOAuthClientRequest instantiates a new CreateOAuthClientRequest 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 + +### NewCreateOAuthClientRequestWithDefaults + +`func NewCreateOAuthClientRequestWithDefaults() *CreateOAuthClientRequest` + +NewCreateOAuthClientRequestWithDefaults instantiates a new CreateOAuthClientRequest 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 + +### GetBusinessName + +`func (o *CreateOAuthClientRequest) GetBusinessName() string` + +GetBusinessName returns the BusinessName field if non-nil, zero value otherwise. + +### GetBusinessNameOk + +`func (o *CreateOAuthClientRequest) GetBusinessNameOk() (*string, bool)` + +GetBusinessNameOk returns a tuple with the BusinessName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBusinessName + +`func (o *CreateOAuthClientRequest) SetBusinessName(v string)` + +SetBusinessName sets BusinessName field to given value. + +### HasBusinessName + +`func (o *CreateOAuthClientRequest) HasBusinessName() bool` + +HasBusinessName returns a boolean if a field has been set. + +### SetBusinessNameNil + +`func (o *CreateOAuthClientRequest) SetBusinessNameNil(b bool)` + + SetBusinessNameNil sets the value for BusinessName to be an explicit nil + +### UnsetBusinessName +`func (o *CreateOAuthClientRequest) UnsetBusinessName()` + +UnsetBusinessName ensures that no value is present for BusinessName, not even an explicit nil +### GetHomepageUrl + +`func (o *CreateOAuthClientRequest) GetHomepageUrl() string` + +GetHomepageUrl returns the HomepageUrl field if non-nil, zero value otherwise. + +### GetHomepageUrlOk + +`func (o *CreateOAuthClientRequest) GetHomepageUrlOk() (*string, bool)` + +GetHomepageUrlOk returns a tuple with the HomepageUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHomepageUrl + +`func (o *CreateOAuthClientRequest) SetHomepageUrl(v string)` + +SetHomepageUrl sets HomepageUrl field to given value. + +### HasHomepageUrl + +`func (o *CreateOAuthClientRequest) HasHomepageUrl() bool` + +HasHomepageUrl returns a boolean if a field has been set. + +### SetHomepageUrlNil + +`func (o *CreateOAuthClientRequest) SetHomepageUrlNil(b bool)` + + SetHomepageUrlNil sets the value for HomepageUrl to be an explicit nil + +### UnsetHomepageUrl +`func (o *CreateOAuthClientRequest) UnsetHomepageUrl()` + +UnsetHomepageUrl ensures that no value is present for HomepageUrl, not even an explicit nil +### GetName + +`func (o *CreateOAuthClientRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateOAuthClientRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateOAuthClientRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *CreateOAuthClientRequest) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *CreateOAuthClientRequest) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *CreateOAuthClientRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateOAuthClientRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateOAuthClientRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *CreateOAuthClientRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CreateOAuthClientRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAccessTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *CreateOAuthClientRequest) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + + +### GetRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) GetRefreshTokenValiditySeconds() int32` + +GetRefreshTokenValiditySeconds returns the RefreshTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetRefreshTokenValiditySecondsOk + +`func (o *CreateOAuthClientRequest) GetRefreshTokenValiditySecondsOk() (*int32, bool)` + +GetRefreshTokenValiditySecondsOk returns a tuple with the RefreshTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) SetRefreshTokenValiditySeconds(v int32)` + +SetRefreshTokenValiditySeconds sets RefreshTokenValiditySeconds field to given value. + +### HasRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientRequest) HasRefreshTokenValiditySeconds() bool` + +HasRefreshTokenValiditySeconds returns a boolean if a field has been set. + +### GetRedirectUris + +`func (o *CreateOAuthClientRequest) GetRedirectUris() []string` + +GetRedirectUris returns the RedirectUris field if non-nil, zero value otherwise. + +### GetRedirectUrisOk + +`func (o *CreateOAuthClientRequest) GetRedirectUrisOk() (*[]string, bool)` + +GetRedirectUrisOk returns a tuple with the RedirectUris field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedirectUris + +`func (o *CreateOAuthClientRequest) SetRedirectUris(v []string)` + +SetRedirectUris sets RedirectUris field to given value. + +### HasRedirectUris + +`func (o *CreateOAuthClientRequest) HasRedirectUris() bool` + +HasRedirectUris returns a boolean if a field has been set. + +### SetRedirectUrisNil + +`func (o *CreateOAuthClientRequest) SetRedirectUrisNil(b bool)` + + SetRedirectUrisNil sets the value for RedirectUris to be an explicit nil + +### UnsetRedirectUris +`func (o *CreateOAuthClientRequest) UnsetRedirectUris()` + +UnsetRedirectUris ensures that no value is present for RedirectUris, not even an explicit nil +### GetGrantTypes + +`func (o *CreateOAuthClientRequest) GetGrantTypes() []GrantType` + +GetGrantTypes returns the GrantTypes field if non-nil, zero value otherwise. + +### GetGrantTypesOk + +`func (o *CreateOAuthClientRequest) GetGrantTypesOk() (*[]GrantType, bool)` + +GetGrantTypesOk returns a tuple with the GrantTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantTypes + +`func (o *CreateOAuthClientRequest) SetGrantTypes(v []GrantType)` + +SetGrantTypes sets GrantTypes field to given value. + + +### SetGrantTypesNil + +`func (o *CreateOAuthClientRequest) SetGrantTypesNil(b bool)` + + SetGrantTypesNil sets the value for GrantTypes to be an explicit nil + +### UnsetGrantTypes +`func (o *CreateOAuthClientRequest) UnsetGrantTypes()` + +UnsetGrantTypes ensures that no value is present for GrantTypes, not even an explicit nil +### GetAccessType + +`func (o *CreateOAuthClientRequest) GetAccessType() AccessType` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *CreateOAuthClientRequest) GetAccessTypeOk() (*AccessType, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *CreateOAuthClientRequest) SetAccessType(v AccessType)` + +SetAccessType sets AccessType field to given value. + + +### GetType + +`func (o *CreateOAuthClientRequest) GetType() ClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CreateOAuthClientRequest) GetTypeOk() (*ClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CreateOAuthClientRequest) SetType(v ClientType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *CreateOAuthClientRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetInternal + +`func (o *CreateOAuthClientRequest) GetInternal() bool` + +GetInternal returns the Internal field if non-nil, zero value otherwise. + +### GetInternalOk + +`func (o *CreateOAuthClientRequest) GetInternalOk() (*bool, bool)` + +GetInternalOk returns a tuple with the Internal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternal + +`func (o *CreateOAuthClientRequest) SetInternal(v bool)` + +SetInternal sets Internal field to given value. + +### HasInternal + +`func (o *CreateOAuthClientRequest) HasInternal() bool` + +HasInternal returns a boolean if a field has been set. + +### GetEnabled + +`func (o *CreateOAuthClientRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CreateOAuthClientRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *CreateOAuthClientRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetStrongAuthSupported + +`func (o *CreateOAuthClientRequest) GetStrongAuthSupported() bool` + +GetStrongAuthSupported returns the StrongAuthSupported field if non-nil, zero value otherwise. + +### GetStrongAuthSupportedOk + +`func (o *CreateOAuthClientRequest) GetStrongAuthSupportedOk() (*bool, bool)` + +GetStrongAuthSupportedOk returns a tuple with the StrongAuthSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStrongAuthSupported + +`func (o *CreateOAuthClientRequest) SetStrongAuthSupported(v bool)` + +SetStrongAuthSupported sets StrongAuthSupported field to given value. + +### HasStrongAuthSupported + +`func (o *CreateOAuthClientRequest) HasStrongAuthSupported() bool` + +HasStrongAuthSupported returns a boolean if a field has been set. + +### GetClaimsSupported + +`func (o *CreateOAuthClientRequest) GetClaimsSupported() bool` + +GetClaimsSupported returns the ClaimsSupported field if non-nil, zero value otherwise. + +### GetClaimsSupportedOk + +`func (o *CreateOAuthClientRequest) GetClaimsSupportedOk() (*bool, bool)` + +GetClaimsSupportedOk returns a tuple with the ClaimsSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClaimsSupported + +`func (o *CreateOAuthClientRequest) SetClaimsSupported(v bool)` + +SetClaimsSupported sets ClaimsSupported field to given value. + +### HasClaimsSupported + +`func (o *CreateOAuthClientRequest) HasClaimsSupported() bool` + +HasClaimsSupported returns a boolean if a field has been set. + +### GetScope + +`func (o *CreateOAuthClientRequest) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *CreateOAuthClientRequest) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *CreateOAuthClientRequest) SetScope(v []string)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *CreateOAuthClientRequest) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### SetScopeNil + +`func (o *CreateOAuthClientRequest) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *CreateOAuthClientRequest) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CreateOAuthClientResponse.md b/docs/tools/sdk/go/Reference/V3/Models/CreateOAuthClientResponse.md new file mode 100644 index 000000000..a90a27b28 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CreateOAuthClientResponse.md @@ -0,0 +1,447 @@ +--- +id: create-o-auth-client-response +title: CreateOAuthClientResponse +pagination_label: CreateOAuthClientResponse +sidebar_label: CreateOAuthClientResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateOAuthClientResponse', 'CreateOAuthClientResponse'] +slug: /tools/sdk/go/v3/models/create-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientResponse', 'CreateOAuthClientResponse'] +--- + +# CreateOAuthClientResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the OAuth client | +**Secret** | **string** | Secret of the OAuth client (This field is only returned on the intial create call.) | +**BusinessName** | **string** | The name of the business the API Client should belong to | +**HomepageUrl** | **string** | The homepage URL associated with the owner of the API Client | +**Name** | **string** | A human-readable name for the API Client | +**Description** | **string** | A description of the API Client | +**AccessTokenValiditySeconds** | **int32** | The number of seconds an access token generated for this API Client is valid for | +**RefreshTokenValiditySeconds** | **int32** | The number of seconds a refresh token generated for this API Client is valid for | +**RedirectUris** | **[]string** | A list of the approved redirect URIs used with the authorization_code flow | +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | +**AccessType** | [**AccessType**](access-type) | | +**Type** | [**ClientType**](client-type) | | +**Internal** | **bool** | An indicator of whether the API Client can be used for requests internal to IDN | +**Enabled** | **bool** | An indicator of whether the API Client is enabled for use | +**StrongAuthSupported** | **bool** | An indicator of whether the API Client supports strong authentication | +**ClaimsSupported** | **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | +**Created** | **SailPointTime** | The date and time, down to the millisecond, when the API Client was created | +**Modified** | **SailPointTime** | The date and time, down to the millisecond, when the API Client was last updated | +**Scope** | **[]string** | Scopes of the API Client. | + +## Methods + +### NewCreateOAuthClientResponse + +`func NewCreateOAuthClientResponse(id string, secret string, businessName string, homepageUrl string, name string, description string, accessTokenValiditySeconds int32, refreshTokenValiditySeconds int32, redirectUris []string, grantTypes []GrantType, accessType AccessType, type_ ClientType, internal bool, enabled bool, strongAuthSupported bool, claimsSupported bool, created SailPointTime, modified SailPointTime, scope []string, ) *CreateOAuthClientResponse` + +NewCreateOAuthClientResponse instantiates a new CreateOAuthClientResponse 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 + +### NewCreateOAuthClientResponseWithDefaults + +`func NewCreateOAuthClientResponseWithDefaults() *CreateOAuthClientResponse` + +NewCreateOAuthClientResponseWithDefaults instantiates a new CreateOAuthClientResponse 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 + +### GetId + +`func (o *CreateOAuthClientResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CreateOAuthClientResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CreateOAuthClientResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetSecret + +`func (o *CreateOAuthClientResponse) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *CreateOAuthClientResponse) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *CreateOAuthClientResponse) SetSecret(v string)` + +SetSecret sets Secret field to given value. + + +### GetBusinessName + +`func (o *CreateOAuthClientResponse) GetBusinessName() string` + +GetBusinessName returns the BusinessName field if non-nil, zero value otherwise. + +### GetBusinessNameOk + +`func (o *CreateOAuthClientResponse) GetBusinessNameOk() (*string, bool)` + +GetBusinessNameOk returns a tuple with the BusinessName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBusinessName + +`func (o *CreateOAuthClientResponse) SetBusinessName(v string)` + +SetBusinessName sets BusinessName field to given value. + + +### GetHomepageUrl + +`func (o *CreateOAuthClientResponse) GetHomepageUrl() string` + +GetHomepageUrl returns the HomepageUrl field if non-nil, zero value otherwise. + +### GetHomepageUrlOk + +`func (o *CreateOAuthClientResponse) GetHomepageUrlOk() (*string, bool)` + +GetHomepageUrlOk returns a tuple with the HomepageUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHomepageUrl + +`func (o *CreateOAuthClientResponse) SetHomepageUrl(v string)` + +SetHomepageUrl sets HomepageUrl field to given value. + + +### GetName + +`func (o *CreateOAuthClientResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateOAuthClientResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateOAuthClientResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *CreateOAuthClientResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateOAuthClientResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateOAuthClientResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetAccessTokenValiditySeconds + +`func (o *CreateOAuthClientResponse) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *CreateOAuthClientResponse) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *CreateOAuthClientResponse) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + + +### GetRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientResponse) GetRefreshTokenValiditySeconds() int32` + +GetRefreshTokenValiditySeconds returns the RefreshTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetRefreshTokenValiditySecondsOk + +`func (o *CreateOAuthClientResponse) GetRefreshTokenValiditySecondsOk() (*int32, bool)` + +GetRefreshTokenValiditySecondsOk returns a tuple with the RefreshTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenValiditySeconds + +`func (o *CreateOAuthClientResponse) SetRefreshTokenValiditySeconds(v int32)` + +SetRefreshTokenValiditySeconds sets RefreshTokenValiditySeconds field to given value. + + +### GetRedirectUris + +`func (o *CreateOAuthClientResponse) GetRedirectUris() []string` + +GetRedirectUris returns the RedirectUris field if non-nil, zero value otherwise. + +### GetRedirectUrisOk + +`func (o *CreateOAuthClientResponse) GetRedirectUrisOk() (*[]string, bool)` + +GetRedirectUrisOk returns a tuple with the RedirectUris field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedirectUris + +`func (o *CreateOAuthClientResponse) SetRedirectUris(v []string)` + +SetRedirectUris sets RedirectUris field to given value. + + +### GetGrantTypes + +`func (o *CreateOAuthClientResponse) GetGrantTypes() []GrantType` + +GetGrantTypes returns the GrantTypes field if non-nil, zero value otherwise. + +### GetGrantTypesOk + +`func (o *CreateOAuthClientResponse) GetGrantTypesOk() (*[]GrantType, bool)` + +GetGrantTypesOk returns a tuple with the GrantTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantTypes + +`func (o *CreateOAuthClientResponse) SetGrantTypes(v []GrantType)` + +SetGrantTypes sets GrantTypes field to given value. + + +### GetAccessType + +`func (o *CreateOAuthClientResponse) GetAccessType() AccessType` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *CreateOAuthClientResponse) GetAccessTypeOk() (*AccessType, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *CreateOAuthClientResponse) SetAccessType(v AccessType)` + +SetAccessType sets AccessType field to given value. + + +### GetType + +`func (o *CreateOAuthClientResponse) GetType() ClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CreateOAuthClientResponse) GetTypeOk() (*ClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CreateOAuthClientResponse) SetType(v ClientType)` + +SetType sets Type field to given value. + + +### GetInternal + +`func (o *CreateOAuthClientResponse) GetInternal() bool` + +GetInternal returns the Internal field if non-nil, zero value otherwise. + +### GetInternalOk + +`func (o *CreateOAuthClientResponse) GetInternalOk() (*bool, bool)` + +GetInternalOk returns a tuple with the Internal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternal + +`func (o *CreateOAuthClientResponse) SetInternal(v bool)` + +SetInternal sets Internal field to given value. + + +### GetEnabled + +`func (o *CreateOAuthClientResponse) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CreateOAuthClientResponse) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *CreateOAuthClientResponse) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetStrongAuthSupported + +`func (o *CreateOAuthClientResponse) GetStrongAuthSupported() bool` + +GetStrongAuthSupported returns the StrongAuthSupported field if non-nil, zero value otherwise. + +### GetStrongAuthSupportedOk + +`func (o *CreateOAuthClientResponse) GetStrongAuthSupportedOk() (*bool, bool)` + +GetStrongAuthSupportedOk returns a tuple with the StrongAuthSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStrongAuthSupported + +`func (o *CreateOAuthClientResponse) SetStrongAuthSupported(v bool)` + +SetStrongAuthSupported sets StrongAuthSupported field to given value. + + +### GetClaimsSupported + +`func (o *CreateOAuthClientResponse) GetClaimsSupported() bool` + +GetClaimsSupported returns the ClaimsSupported field if non-nil, zero value otherwise. + +### GetClaimsSupportedOk + +`func (o *CreateOAuthClientResponse) GetClaimsSupportedOk() (*bool, bool)` + +GetClaimsSupportedOk returns a tuple with the ClaimsSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClaimsSupported + +`func (o *CreateOAuthClientResponse) SetClaimsSupported(v bool)` + +SetClaimsSupported sets ClaimsSupported field to given value. + + +### GetCreated + +`func (o *CreateOAuthClientResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CreateOAuthClientResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CreateOAuthClientResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *CreateOAuthClientResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CreateOAuthClientResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CreateOAuthClientResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetScope + +`func (o *CreateOAuthClientResponse) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *CreateOAuthClientResponse) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *CreateOAuthClientResponse) SetScope(v []string)` + +SetScope sets Scope field to given value. + + +### SetScopeNil + +`func (o *CreateOAuthClientResponse) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *CreateOAuthClientResponse) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CreatePersonalAccessTokenRequest.md b/docs/tools/sdk/go/Reference/V3/Models/CreatePersonalAccessTokenRequest.md new file mode 100644 index 000000000..53041db99 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CreatePersonalAccessTokenRequest.md @@ -0,0 +1,121 @@ +--- +id: create-personal-access-token-request +title: CreatePersonalAccessTokenRequest +pagination_label: CreatePersonalAccessTokenRequest +sidebar_label: CreatePersonalAccessTokenRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreatePersonalAccessTokenRequest', 'CreatePersonalAccessTokenRequest'] +slug: /tools/sdk/go/v3/models/create-personal-access-token-request +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenRequest', 'CreatePersonalAccessTokenRequest'] +--- + +# CreatePersonalAccessTokenRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | +**Scope** | Pointer to **[]string** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it. | [optional] +**AccessTokenValiditySeconds** | Pointer to **int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] + +## Methods + +### NewCreatePersonalAccessTokenRequest + +`func NewCreatePersonalAccessTokenRequest(name string, ) *CreatePersonalAccessTokenRequest` + +NewCreatePersonalAccessTokenRequest instantiates a new CreatePersonalAccessTokenRequest 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 + +### NewCreatePersonalAccessTokenRequestWithDefaults + +`func NewCreatePersonalAccessTokenRequestWithDefaults() *CreatePersonalAccessTokenRequest` + +NewCreatePersonalAccessTokenRequestWithDefaults instantiates a new CreatePersonalAccessTokenRequest 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 + +### GetName + +`func (o *CreatePersonalAccessTokenRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreatePersonalAccessTokenRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreatePersonalAccessTokenRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetScope + +`func (o *CreatePersonalAccessTokenRequest) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *CreatePersonalAccessTokenRequest) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *CreatePersonalAccessTokenRequest) SetScope(v []string)` + +SetScope sets Scope field to given value. + +### HasScope + +`func (o *CreatePersonalAccessTokenRequest) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### SetScopeNil + +`func (o *CreatePersonalAccessTokenRequest) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *CreatePersonalAccessTokenRequest) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil +### GetAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenRequest) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *CreatePersonalAccessTokenRequest) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenRequest) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + +### HasAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenRequest) HasAccessTokenValiditySeconds() bool` + +HasAccessTokenValiditySeconds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CreatePersonalAccessTokenResponse.md b/docs/tools/sdk/go/Reference/V3/Models/CreatePersonalAccessTokenResponse.md new file mode 100644 index 000000000..9a63500e2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CreatePersonalAccessTokenResponse.md @@ -0,0 +1,195 @@ +--- +id: create-personal-access-token-response +title: CreatePersonalAccessTokenResponse +pagination_label: CreatePersonalAccessTokenResponse +sidebar_label: CreatePersonalAccessTokenResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreatePersonalAccessTokenResponse', 'CreatePersonalAccessTokenResponse'] +slug: /tools/sdk/go/v3/models/create-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenResponse', 'CreatePersonalAccessTokenResponse'] +--- + +# CreatePersonalAccessTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The ID of the personal access token (to be used as the username for Basic Auth). | +**Secret** | **string** | The secret of the personal access token (to be used as the password for Basic Auth). | +**Scope** | **[]string** | Scopes of the personal access token. | +**Name** | **string** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | +**Owner** | [**PatOwner**](pat-owner) | | +**Created** | **SailPointTime** | The date and time, down to the millisecond, when this personal access token was created. | +**AccessTokenValiditySeconds** | **int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | + +## Methods + +### NewCreatePersonalAccessTokenResponse + +`func NewCreatePersonalAccessTokenResponse(id string, secret string, scope []string, name string, owner PatOwner, created SailPointTime, accessTokenValiditySeconds int32, ) *CreatePersonalAccessTokenResponse` + +NewCreatePersonalAccessTokenResponse instantiates a new CreatePersonalAccessTokenResponse 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 + +### NewCreatePersonalAccessTokenResponseWithDefaults + +`func NewCreatePersonalAccessTokenResponseWithDefaults() *CreatePersonalAccessTokenResponse` + +NewCreatePersonalAccessTokenResponseWithDefaults instantiates a new CreatePersonalAccessTokenResponse 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 + +### GetId + +`func (o *CreatePersonalAccessTokenResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CreatePersonalAccessTokenResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CreatePersonalAccessTokenResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetSecret + +`func (o *CreatePersonalAccessTokenResponse) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *CreatePersonalAccessTokenResponse) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *CreatePersonalAccessTokenResponse) SetSecret(v string)` + +SetSecret sets Secret field to given value. + + +### GetScope + +`func (o *CreatePersonalAccessTokenResponse) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *CreatePersonalAccessTokenResponse) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *CreatePersonalAccessTokenResponse) SetScope(v []string)` + +SetScope sets Scope field to given value. + + +### SetScopeNil + +`func (o *CreatePersonalAccessTokenResponse) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *CreatePersonalAccessTokenResponse) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil +### GetName + +`func (o *CreatePersonalAccessTokenResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreatePersonalAccessTokenResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreatePersonalAccessTokenResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetOwner + +`func (o *CreatePersonalAccessTokenResponse) GetOwner() PatOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CreatePersonalAccessTokenResponse) GetOwnerOk() (*PatOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CreatePersonalAccessTokenResponse) SetOwner(v PatOwner)` + +SetOwner sets Owner field to given value. + + +### GetCreated + +`func (o *CreatePersonalAccessTokenResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CreatePersonalAccessTokenResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CreatePersonalAccessTokenResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenResponse) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *CreatePersonalAccessTokenResponse) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *CreatePersonalAccessTokenResponse) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CreateSavedSearchRequest.md b/docs/tools/sdk/go/Reference/V3/Models/CreateSavedSearchRequest.md new file mode 100644 index 000000000..a785a7b8f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CreateSavedSearchRequest.md @@ -0,0 +1,384 @@ +--- +id: create-saved-search-request +title: CreateSavedSearchRequest +pagination_label: CreateSavedSearchRequest +sidebar_label: CreateSavedSearchRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateSavedSearchRequest', 'CreateSavedSearchRequest'] +slug: /tools/sdk/go/v3/models/create-saved-search-request +tags: ['SDK', 'Software Development Kit', 'CreateSavedSearchRequest', 'CreateSavedSearchRequest'] +--- + +# CreateSavedSearchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the saved search. | [optional] +**Description** | Pointer to **NullableString** | The description of the saved search. | [optional] +**Created** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | +**Columns** | Pointer to [**map[string][]Column**](https://go.dev/tour/moretypes/6) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**Query** | **string** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | +**Fields** | Pointer to **[]string** | The fields to be searched against in a multi-field query. | [optional] +**OrderBy** | Pointer to **map[string][]string** | Sort by index. This takes precedence over the `sort` property. | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. | [optional] +**Filters** | Pointer to [**NullableSavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] + +## Methods + +### NewCreateSavedSearchRequest + +`func NewCreateSavedSearchRequest(indices []Index, query string, ) *CreateSavedSearchRequest` + +NewCreateSavedSearchRequest instantiates a new CreateSavedSearchRequest 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 + +### NewCreateSavedSearchRequestWithDefaults + +`func NewCreateSavedSearchRequestWithDefaults() *CreateSavedSearchRequest` + +NewCreateSavedSearchRequestWithDefaults instantiates a new CreateSavedSearchRequest 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 + +### GetName + +`func (o *CreateSavedSearchRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateSavedSearchRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateSavedSearchRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CreateSavedSearchRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *CreateSavedSearchRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateSavedSearchRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateSavedSearchRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CreateSavedSearchRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *CreateSavedSearchRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CreateSavedSearchRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCreated + +`func (o *CreateSavedSearchRequest) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CreateSavedSearchRequest) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CreateSavedSearchRequest) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CreateSavedSearchRequest) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *CreateSavedSearchRequest) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *CreateSavedSearchRequest) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *CreateSavedSearchRequest) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CreateSavedSearchRequest) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CreateSavedSearchRequest) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CreateSavedSearchRequest) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CreateSavedSearchRequest) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CreateSavedSearchRequest) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetIndices + +`func (o *CreateSavedSearchRequest) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *CreateSavedSearchRequest) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *CreateSavedSearchRequest) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + + +### GetColumns + +`func (o *CreateSavedSearchRequest) GetColumns() map[string][]Column` + +GetColumns returns the Columns field if non-nil, zero value otherwise. + +### GetColumnsOk + +`func (o *CreateSavedSearchRequest) GetColumnsOk() (*map[string][]Column, bool)` + +GetColumnsOk returns a tuple with the Columns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumns + +`func (o *CreateSavedSearchRequest) SetColumns(v map[string][]Column)` + +SetColumns sets Columns field to given value. + +### HasColumns + +`func (o *CreateSavedSearchRequest) HasColumns() bool` + +HasColumns returns a boolean if a field has been set. + +### GetQuery + +`func (o *CreateSavedSearchRequest) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *CreateSavedSearchRequest) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *CreateSavedSearchRequest) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetFields + +`func (o *CreateSavedSearchRequest) GetFields() []string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *CreateSavedSearchRequest) GetFieldsOk() (*[]string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *CreateSavedSearchRequest) SetFields(v []string)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *CreateSavedSearchRequest) HasFields() bool` + +HasFields returns a boolean if a field has been set. + +### SetFieldsNil + +`func (o *CreateSavedSearchRequest) SetFieldsNil(b bool)` + + SetFieldsNil sets the value for Fields to be an explicit nil + +### UnsetFields +`func (o *CreateSavedSearchRequest) UnsetFields()` + +UnsetFields ensures that no value is present for Fields, not even an explicit nil +### GetOrderBy + +`func (o *CreateSavedSearchRequest) GetOrderBy() map[string][]string` + +GetOrderBy returns the OrderBy field if non-nil, zero value otherwise. + +### GetOrderByOk + +`func (o *CreateSavedSearchRequest) GetOrderByOk() (*map[string][]string, bool)` + +GetOrderByOk returns a tuple with the OrderBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderBy + +`func (o *CreateSavedSearchRequest) SetOrderBy(v map[string][]string)` + +SetOrderBy sets OrderBy field to given value. + +### HasOrderBy + +`func (o *CreateSavedSearchRequest) HasOrderBy() bool` + +HasOrderBy returns a boolean if a field has been set. + +### SetOrderByNil + +`func (o *CreateSavedSearchRequest) SetOrderByNil(b bool)` + + SetOrderByNil sets the value for OrderBy to be an explicit nil + +### UnsetOrderBy +`func (o *CreateSavedSearchRequest) UnsetOrderBy()` + +UnsetOrderBy ensures that no value is present for OrderBy, not even an explicit nil +### GetSort + +`func (o *CreateSavedSearchRequest) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *CreateSavedSearchRequest) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *CreateSavedSearchRequest) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *CreateSavedSearchRequest) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### SetSortNil + +`func (o *CreateSavedSearchRequest) SetSortNil(b bool)` + + SetSortNil sets the value for Sort to be an explicit nil + +### UnsetSort +`func (o *CreateSavedSearchRequest) UnsetSort()` + +UnsetSort ensures that no value is present for Sort, not even an explicit nil +### GetFilters + +`func (o *CreateSavedSearchRequest) GetFilters() SavedSearchDetailFilters` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *CreateSavedSearchRequest) GetFiltersOk() (*SavedSearchDetailFilters, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *CreateSavedSearchRequest) SetFilters(v SavedSearchDetailFilters)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *CreateSavedSearchRequest) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### SetFiltersNil + +`func (o *CreateSavedSearchRequest) SetFiltersNil(b bool)` + + SetFiltersNil sets the value for Filters to be an explicit nil + +### UnsetFilters +`func (o *CreateSavedSearchRequest) UnsetFilters()` + +UnsetFilters ensures that no value is present for Filters, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CreateScheduledSearchRequest.md b/docs/tools/sdk/go/Reference/V3/Models/CreateScheduledSearchRequest.md new file mode 100644 index 000000000..8fb847765 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CreateScheduledSearchRequest.md @@ -0,0 +1,323 @@ +--- +id: create-scheduled-search-request +title: CreateScheduledSearchRequest +pagination_label: CreateScheduledSearchRequest +sidebar_label: CreateScheduledSearchRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateScheduledSearchRequest', 'CreateScheduledSearchRequest'] +slug: /tools/sdk/go/v3/models/create-scheduled-search-request +tags: ['SDK', 'Software Development Kit', 'CreateScheduledSearchRequest', 'CreateScheduledSearchRequest'] +--- + +# CreateScheduledSearchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **NullableString** | The name of the scheduled search. | [optional] +**Description** | Pointer to **NullableString** | The description of the scheduled search. | [optional] +**SavedSearchId** | **string** | The ID of the saved search that will be executed. | +**Created** | Pointer to **NullableTime** | The date the scheduled search was initially created. | [optional] [readonly] +**Modified** | Pointer to **NullableTime** | The last date the scheduled search was modified. | [optional] [readonly] +**Schedule** | [**Schedule1**](schedule1) | | +**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | +**Enabled** | Pointer to **bool** | Indicates if the scheduled search is enabled. | [optional] [default to false] +**EmailEmptyResults** | Pointer to **bool** | Indicates if email generation should occur when search returns no results. | [optional] [default to false] +**DisplayQueryDetails** | Pointer to **bool** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to false] + +## Methods + +### NewCreateScheduledSearchRequest + +`func NewCreateScheduledSearchRequest(savedSearchId string, schedule Schedule1, recipients []SearchScheduleRecipientsInner, ) *CreateScheduledSearchRequest` + +NewCreateScheduledSearchRequest instantiates a new CreateScheduledSearchRequest 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 + +### NewCreateScheduledSearchRequestWithDefaults + +`func NewCreateScheduledSearchRequestWithDefaults() *CreateScheduledSearchRequest` + +NewCreateScheduledSearchRequestWithDefaults instantiates a new CreateScheduledSearchRequest 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 + +### GetName + +`func (o *CreateScheduledSearchRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateScheduledSearchRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateScheduledSearchRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *CreateScheduledSearchRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *CreateScheduledSearchRequest) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *CreateScheduledSearchRequest) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *CreateScheduledSearchRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateScheduledSearchRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateScheduledSearchRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CreateScheduledSearchRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *CreateScheduledSearchRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *CreateScheduledSearchRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSavedSearchId + +`func (o *CreateScheduledSearchRequest) GetSavedSearchId() string` + +GetSavedSearchId returns the SavedSearchId field if non-nil, zero value otherwise. + +### GetSavedSearchIdOk + +`func (o *CreateScheduledSearchRequest) GetSavedSearchIdOk() (*string, bool)` + +GetSavedSearchIdOk returns a tuple with the SavedSearchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSavedSearchId + +`func (o *CreateScheduledSearchRequest) SetSavedSearchId(v string)` + +SetSavedSearchId sets SavedSearchId field to given value. + + +### GetCreated + +`func (o *CreateScheduledSearchRequest) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CreateScheduledSearchRequest) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CreateScheduledSearchRequest) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CreateScheduledSearchRequest) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *CreateScheduledSearchRequest) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *CreateScheduledSearchRequest) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *CreateScheduledSearchRequest) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CreateScheduledSearchRequest) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *CreateScheduledSearchRequest) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *CreateScheduledSearchRequest) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *CreateScheduledSearchRequest) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *CreateScheduledSearchRequest) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSchedule + +`func (o *CreateScheduledSearchRequest) GetSchedule() Schedule1` + +GetSchedule returns the Schedule field if non-nil, zero value otherwise. + +### GetScheduleOk + +`func (o *CreateScheduledSearchRequest) GetScheduleOk() (*Schedule1, bool)` + +GetScheduleOk returns a tuple with the Schedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchedule + +`func (o *CreateScheduledSearchRequest) SetSchedule(v Schedule1)` + +SetSchedule sets Schedule field to given value. + + +### GetRecipients + +`func (o *CreateScheduledSearchRequest) GetRecipients() []SearchScheduleRecipientsInner` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *CreateScheduledSearchRequest) GetRecipientsOk() (*[]SearchScheduleRecipientsInner, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *CreateScheduledSearchRequest) SetRecipients(v []SearchScheduleRecipientsInner)` + +SetRecipients sets Recipients field to given value. + + +### GetEnabled + +`func (o *CreateScheduledSearchRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CreateScheduledSearchRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *CreateScheduledSearchRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *CreateScheduledSearchRequest) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEmailEmptyResults + +`func (o *CreateScheduledSearchRequest) GetEmailEmptyResults() bool` + +GetEmailEmptyResults returns the EmailEmptyResults field if non-nil, zero value otherwise. + +### GetEmailEmptyResultsOk + +`func (o *CreateScheduledSearchRequest) GetEmailEmptyResultsOk() (*bool, bool)` + +GetEmailEmptyResultsOk returns a tuple with the EmailEmptyResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEmptyResults + +`func (o *CreateScheduledSearchRequest) SetEmailEmptyResults(v bool)` + +SetEmailEmptyResults sets EmailEmptyResults field to given value. + +### HasEmailEmptyResults + +`func (o *CreateScheduledSearchRequest) HasEmailEmptyResults() bool` + +HasEmailEmptyResults returns a boolean if a field has been set. + +### GetDisplayQueryDetails + +`func (o *CreateScheduledSearchRequest) GetDisplayQueryDetails() bool` + +GetDisplayQueryDetails returns the DisplayQueryDetails field if non-nil, zero value otherwise. + +### GetDisplayQueryDetailsOk + +`func (o *CreateScheduledSearchRequest) GetDisplayQueryDetailsOk() (*bool, bool)` + +GetDisplayQueryDetailsOk returns a tuple with the DisplayQueryDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayQueryDetails + +`func (o *CreateScheduledSearchRequest) SetDisplayQueryDetails(v bool)` + +SetDisplayQueryDetails sets DisplayQueryDetails field to given value. + +### HasDisplayQueryDetails + +`func (o *CreateScheduledSearchRequest) HasDisplayQueryDetails() bool` + +HasDisplayQueryDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CreateUploadedConfigurationRequest.md b/docs/tools/sdk/go/Reference/V3/Models/CreateUploadedConfigurationRequest.md new file mode 100644 index 000000000..f57e40541 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CreateUploadedConfigurationRequest.md @@ -0,0 +1,80 @@ +--- +id: create-uploaded-configuration-request +title: CreateUploadedConfigurationRequest +pagination_label: CreateUploadedConfigurationRequest +sidebar_label: CreateUploadedConfigurationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateUploadedConfigurationRequest', 'CreateUploadedConfigurationRequest'] +slug: /tools/sdk/go/v3/models/create-uploaded-configuration-request +tags: ['SDK', 'Software Development Kit', 'CreateUploadedConfigurationRequest', 'CreateUploadedConfigurationRequest'] +--- + +# CreateUploadedConfigurationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | ***os.File** | JSON file containing the objects to be imported. | +**Name** | **string** | Name that will be assigned to the uploaded configuration file. | + +## Methods + +### NewCreateUploadedConfigurationRequest + +`func NewCreateUploadedConfigurationRequest(data *os.File, name string, ) *CreateUploadedConfigurationRequest` + +NewCreateUploadedConfigurationRequest instantiates a new CreateUploadedConfigurationRequest 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 + +### NewCreateUploadedConfigurationRequestWithDefaults + +`func NewCreateUploadedConfigurationRequestWithDefaults() *CreateUploadedConfigurationRequest` + +NewCreateUploadedConfigurationRequestWithDefaults instantiates a new CreateUploadedConfigurationRequest 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 + +### GetData + +`func (o *CreateUploadedConfigurationRequest) GetData() *os.File` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *CreateUploadedConfigurationRequest) GetDataOk() (**os.File, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *CreateUploadedConfigurationRequest) SetData(v *os.File)` + +SetData sets Data field to given value. + + +### GetName + +`func (o *CreateUploadedConfigurationRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateUploadedConfigurationRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateUploadedConfigurationRequest) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CreateWorkflowRequest.md b/docs/tools/sdk/go/Reference/V3/Models/CreateWorkflowRequest.md new file mode 100644 index 000000000..b025dfd87 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CreateWorkflowRequest.md @@ -0,0 +1,189 @@ +--- +id: create-workflow-request +title: CreateWorkflowRequest +pagination_label: CreateWorkflowRequest +sidebar_label: CreateWorkflowRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CreateWorkflowRequest', 'CreateWorkflowRequest'] +slug: /tools/sdk/go/v3/models/create-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateWorkflowRequest', 'CreateWorkflowRequest'] +--- + +# CreateWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the workflow | +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **string** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **bool** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] + +## Methods + +### NewCreateWorkflowRequest + +`func NewCreateWorkflowRequest(name string, ) *CreateWorkflowRequest` + +NewCreateWorkflowRequest instantiates a new CreateWorkflowRequest 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 + +### NewCreateWorkflowRequestWithDefaults + +`func NewCreateWorkflowRequestWithDefaults() *CreateWorkflowRequest` + +NewCreateWorkflowRequestWithDefaults instantiates a new CreateWorkflowRequest 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 + +### GetName + +`func (o *CreateWorkflowRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateWorkflowRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateWorkflowRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetOwner + +`func (o *CreateWorkflowRequest) GetOwner() WorkflowBodyOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *CreateWorkflowRequest) GetOwnerOk() (*WorkflowBodyOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *CreateWorkflowRequest) SetOwner(v WorkflowBodyOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *CreateWorkflowRequest) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDescription + +`func (o *CreateWorkflowRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CreateWorkflowRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *CreateWorkflowRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *CreateWorkflowRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDefinition + +`func (o *CreateWorkflowRequest) GetDefinition() WorkflowDefinition` + +GetDefinition returns the Definition field if non-nil, zero value otherwise. + +### GetDefinitionOk + +`func (o *CreateWorkflowRequest) GetDefinitionOk() (*WorkflowDefinition, bool)` + +GetDefinitionOk returns a tuple with the Definition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefinition + +`func (o *CreateWorkflowRequest) SetDefinition(v WorkflowDefinition)` + +SetDefinition sets Definition field to given value. + +### HasDefinition + +`func (o *CreateWorkflowRequest) HasDefinition() bool` + +HasDefinition returns a boolean if a field has been set. + +### GetEnabled + +`func (o *CreateWorkflowRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CreateWorkflowRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *CreateWorkflowRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *CreateWorkflowRequest) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetTrigger + +`func (o *CreateWorkflowRequest) GetTrigger() WorkflowTrigger` + +GetTrigger returns the Trigger field if non-nil, zero value otherwise. + +### GetTriggerOk + +`func (o *CreateWorkflowRequest) GetTriggerOk() (*WorkflowTrigger, bool)` + +GetTriggerOk returns a tuple with the Trigger field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrigger + +`func (o *CreateWorkflowRequest) SetTrigger(v WorkflowTrigger)` + +SetTrigger sets Trigger field to given value. + +### HasTrigger + +`func (o *CreateWorkflowRequest) HasTrigger() bool` + +HasTrigger returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/CriteriaType.md b/docs/tools/sdk/go/Reference/V3/Models/CriteriaType.md new file mode 100644 index 000000000..184254d20 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/CriteriaType.md @@ -0,0 +1,39 @@ +--- +id: criteria-type +title: CriteriaType +pagination_label: CriteriaType +sidebar_label: CriteriaType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'CriteriaType', 'CriteriaType'] +slug: /tools/sdk/go/v3/models/criteria-type +tags: ['SDK', 'Software Development Kit', 'CriteriaType', 'CriteriaType'] +--- + +# CriteriaType + +## Enum + + +* `COMPOSITE` (value: `"COMPOSITE"`) + +* `ROLE` (value: `"ROLE"`) + +* `IDENTITY` (value: `"IDENTITY"`) + +* `IDENTITY_ATTRIBUTE` (value: `"IDENTITY_ATTRIBUTE"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `SOURCE` (value: `"SOURCE"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `AGGREGATED_ENTITLEMENT` (value: `"AGGREGATED_ENTITLEMENT"`) + +* `INVALID_CERTIFIABLE_ENTITY` (value: `"INVALID_CERTIFIABLE_ENTITY"`) + +* `INVALID_CERTIFIABLE_BUNDLE` (value: `"INVALID_CERTIFIABLE_BUNDLE"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/DataAccess.md b/docs/tools/sdk/go/Reference/V3/Models/DataAccess.md new file mode 100644 index 000000000..7ea1f856b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/DataAccess.md @@ -0,0 +1,116 @@ +--- +id: data-access +title: DataAccess +pagination_label: DataAccess +sidebar_label: DataAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DataAccess', 'DataAccess'] +slug: /tools/sdk/go/v3/models/data-access +tags: ['SDK', 'Software Development Kit', 'DataAccess', 'DataAccess'] +--- + +# DataAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policies** | Pointer to [**[]DataAccessPoliciesInner**](data-access-policies-inner) | List of classification policies that apply to resources the entitlement \\ groups has access to | [optional] +**Categories** | Pointer to [**[]DataAccessCategoriesInner**](data-access-categories-inner) | List of classification categories that apply to resources the entitlement \\ groups has access to | [optional] +**ImpactScore** | Pointer to [**DataAccessImpactScore**](data-access-impact-score) | | [optional] + +## Methods + +### NewDataAccess + +`func NewDataAccess() *DataAccess` + +NewDataAccess instantiates a new DataAccess 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 + +### NewDataAccessWithDefaults + +`func NewDataAccessWithDefaults() *DataAccess` + +NewDataAccessWithDefaults instantiates a new DataAccess 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 + +### GetPolicies + +`func (o *DataAccess) GetPolicies() []DataAccessPoliciesInner` + +GetPolicies returns the Policies field if non-nil, zero value otherwise. + +### GetPoliciesOk + +`func (o *DataAccess) GetPoliciesOk() (*[]DataAccessPoliciesInner, bool)` + +GetPoliciesOk returns a tuple with the Policies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicies + +`func (o *DataAccess) SetPolicies(v []DataAccessPoliciesInner)` + +SetPolicies sets Policies field to given value. + +### HasPolicies + +`func (o *DataAccess) HasPolicies() bool` + +HasPolicies returns a boolean if a field has been set. + +### GetCategories + +`func (o *DataAccess) GetCategories() []DataAccessCategoriesInner` + +GetCategories returns the Categories field if non-nil, zero value otherwise. + +### GetCategoriesOk + +`func (o *DataAccess) GetCategoriesOk() (*[]DataAccessCategoriesInner, bool)` + +GetCategoriesOk returns a tuple with the Categories field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCategories + +`func (o *DataAccess) SetCategories(v []DataAccessCategoriesInner)` + +SetCategories sets Categories field to given value. + +### HasCategories + +`func (o *DataAccess) HasCategories() bool` + +HasCategories returns a boolean if a field has been set. + +### GetImpactScore + +`func (o *DataAccess) GetImpactScore() DataAccessImpactScore` + +GetImpactScore returns the ImpactScore field if non-nil, zero value otherwise. + +### GetImpactScoreOk + +`func (o *DataAccess) GetImpactScoreOk() (*DataAccessImpactScore, bool)` + +GetImpactScoreOk returns a tuple with the ImpactScore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImpactScore + +`func (o *DataAccess) SetImpactScore(v DataAccessImpactScore)` + +SetImpactScore sets ImpactScore field to given value. + +### HasImpactScore + +`func (o *DataAccess) HasImpactScore() bool` + +HasImpactScore returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/DataAccessCategoriesInner.md b/docs/tools/sdk/go/Reference/V3/Models/DataAccessCategoriesInner.md new file mode 100644 index 000000000..5d0af4ea7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/DataAccessCategoriesInner.md @@ -0,0 +1,90 @@ +--- +id: data-access-categories-inner +title: DataAccessCategoriesInner +pagination_label: DataAccessCategoriesInner +sidebar_label: DataAccessCategoriesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DataAccessCategoriesInner', 'DataAccessCategoriesInner'] +slug: /tools/sdk/go/v3/models/data-access-categories-inner +tags: ['SDK', 'Software Development Kit', 'DataAccessCategoriesInner', 'DataAccessCategoriesInner'] +--- + +# DataAccessCategoriesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | Value of the category | [optional] +**MatchCount** | Pointer to **int32** | Number of matched for each category | [optional] + +## Methods + +### NewDataAccessCategoriesInner + +`func NewDataAccessCategoriesInner() *DataAccessCategoriesInner` + +NewDataAccessCategoriesInner instantiates a new DataAccessCategoriesInner 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 + +### NewDataAccessCategoriesInnerWithDefaults + +`func NewDataAccessCategoriesInnerWithDefaults() *DataAccessCategoriesInner` + +NewDataAccessCategoriesInnerWithDefaults instantiates a new DataAccessCategoriesInner 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 + +### GetValue + +`func (o *DataAccessCategoriesInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *DataAccessCategoriesInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *DataAccessCategoriesInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *DataAccessCategoriesInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetMatchCount + +`func (o *DataAccessCategoriesInner) GetMatchCount() int32` + +GetMatchCount returns the MatchCount field if non-nil, zero value otherwise. + +### GetMatchCountOk + +`func (o *DataAccessCategoriesInner) GetMatchCountOk() (*int32, bool)` + +GetMatchCountOk returns a tuple with the MatchCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchCount + +`func (o *DataAccessCategoriesInner) SetMatchCount(v int32)` + +SetMatchCount sets MatchCount field to given value. + +### HasMatchCount + +`func (o *DataAccessCategoriesInner) HasMatchCount() bool` + +HasMatchCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/DataAccessImpactScore.md b/docs/tools/sdk/go/Reference/V3/Models/DataAccessImpactScore.md new file mode 100644 index 000000000..2f6b7cc9c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/DataAccessImpactScore.md @@ -0,0 +1,64 @@ +--- +id: data-access-impact-score +title: DataAccessImpactScore +pagination_label: DataAccessImpactScore +sidebar_label: DataAccessImpactScore +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DataAccessImpactScore', 'DataAccessImpactScore'] +slug: /tools/sdk/go/v3/models/data-access-impact-score +tags: ['SDK', 'Software Development Kit', 'DataAccessImpactScore', 'DataAccessImpactScore'] +--- + +# DataAccessImpactScore + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | Impact Score for this data | [optional] + +## Methods + +### NewDataAccessImpactScore + +`func NewDataAccessImpactScore() *DataAccessImpactScore` + +NewDataAccessImpactScore instantiates a new DataAccessImpactScore 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 + +### NewDataAccessImpactScoreWithDefaults + +`func NewDataAccessImpactScoreWithDefaults() *DataAccessImpactScore` + +NewDataAccessImpactScoreWithDefaults instantiates a new DataAccessImpactScore 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 + +### GetValue + +`func (o *DataAccessImpactScore) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *DataAccessImpactScore) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *DataAccessImpactScore) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *DataAccessImpactScore) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/DataAccessPoliciesInner.md b/docs/tools/sdk/go/Reference/V3/Models/DataAccessPoliciesInner.md new file mode 100644 index 000000000..41602371a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/DataAccessPoliciesInner.md @@ -0,0 +1,64 @@ +--- +id: data-access-policies-inner +title: DataAccessPoliciesInner +pagination_label: DataAccessPoliciesInner +sidebar_label: DataAccessPoliciesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DataAccessPoliciesInner', 'DataAccessPoliciesInner'] +slug: /tools/sdk/go/v3/models/data-access-policies-inner +tags: ['SDK', 'Software Development Kit', 'DataAccessPoliciesInner', 'DataAccessPoliciesInner'] +--- + +# DataAccessPoliciesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | Value of the policy | [optional] + +## Methods + +### NewDataAccessPoliciesInner + +`func NewDataAccessPoliciesInner() *DataAccessPoliciesInner` + +NewDataAccessPoliciesInner instantiates a new DataAccessPoliciesInner 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 + +### NewDataAccessPoliciesInnerWithDefaults + +`func NewDataAccessPoliciesInnerWithDefaults() *DataAccessPoliciesInner` + +NewDataAccessPoliciesInnerWithDefaults instantiates a new DataAccessPoliciesInner 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 + +### GetValue + +`func (o *DataAccessPoliciesInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *DataAccessPoliciesInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *DataAccessPoliciesInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *DataAccessPoliciesInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/DeleteNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/go/Reference/V3/Models/DeleteNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..1929f50f1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/DeleteNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,59 @@ +--- +id: delete-non-employee-records-in-bulk-request +title: DeleteNonEmployeeRecordsInBulkRequest +pagination_label: DeleteNonEmployeeRecordsInBulkRequest +sidebar_label: DeleteNonEmployeeRecordsInBulkRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DeleteNonEmployeeRecordsInBulkRequest', 'DeleteNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/go/v3/models/delete-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'DeleteNonEmployeeRecordsInBulkRequest', 'DeleteNonEmployeeRecordsInBulkRequest'] +--- + +# DeleteNonEmployeeRecordsInBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | **[]string** | List of non-employee ids. | + +## Methods + +### NewDeleteNonEmployeeRecordsInBulkRequest + +`func NewDeleteNonEmployeeRecordsInBulkRequest(ids []string, ) *DeleteNonEmployeeRecordsInBulkRequest` + +NewDeleteNonEmployeeRecordsInBulkRequest instantiates a new DeleteNonEmployeeRecordsInBulkRequest 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 + +### NewDeleteNonEmployeeRecordsInBulkRequestWithDefaults + +`func NewDeleteNonEmployeeRecordsInBulkRequestWithDefaults() *DeleteNonEmployeeRecordsInBulkRequest` + +NewDeleteNonEmployeeRecordsInBulkRequestWithDefaults instantiates a new DeleteNonEmployeeRecordsInBulkRequest 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 + +### GetIds + +`func (o *DeleteNonEmployeeRecordsInBulkRequest) GetIds() []string` + +GetIds returns the Ids field if non-nil, zero value otherwise. + +### GetIdsOk + +`func (o *DeleteNonEmployeeRecordsInBulkRequest) GetIdsOk() (*[]string, bool)` + +GetIdsOk returns a tuple with the Ids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIds + +`func (o *DeleteNonEmployeeRecordsInBulkRequest) SetIds(v []string)` + +SetIds sets Ids field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/DeleteSource202Response.md b/docs/tools/sdk/go/Reference/V3/Models/DeleteSource202Response.md new file mode 100644 index 000000000..50be53ddd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/DeleteSource202Response.md @@ -0,0 +1,116 @@ +--- +id: delete-source202-response +title: DeleteSource202Response +pagination_label: DeleteSource202Response +sidebar_label: DeleteSource202Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DeleteSource202Response', 'DeleteSource202Response'] +slug: /tools/sdk/go/v3/models/delete-source202-response +tags: ['SDK', 'Software Development Kit', 'DeleteSource202Response', 'DeleteSource202Response'] +--- + +# DeleteSource202Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Task result ID. | [optional] +**Name** | Pointer to **string** | Task result's human-readable display name (this should be null/empty). | [optional] + +## Methods + +### NewDeleteSource202Response + +`func NewDeleteSource202Response() *DeleteSource202Response` + +NewDeleteSource202Response instantiates a new DeleteSource202Response 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 + +### NewDeleteSource202ResponseWithDefaults + +`func NewDeleteSource202ResponseWithDefaults() *DeleteSource202Response` + +NewDeleteSource202ResponseWithDefaults instantiates a new DeleteSource202Response 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 + +### GetType + +`func (o *DeleteSource202Response) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DeleteSource202Response) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DeleteSource202Response) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DeleteSource202Response) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *DeleteSource202Response) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DeleteSource202Response) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DeleteSource202Response) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DeleteSource202Response) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *DeleteSource202Response) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DeleteSource202Response) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DeleteSource202Response) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DeleteSource202Response) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/DeleteVendorConnectorMapping200Response.md b/docs/tools/sdk/go/Reference/V3/Models/DeleteVendorConnectorMapping200Response.md new file mode 100644 index 000000000..59c8fec2a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/DeleteVendorConnectorMapping200Response.md @@ -0,0 +1,64 @@ +--- +id: delete-vendor-connector-mapping200-response +title: DeleteVendorConnectorMapping200Response +pagination_label: DeleteVendorConnectorMapping200Response +sidebar_label: DeleteVendorConnectorMapping200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DeleteVendorConnectorMapping200Response', 'DeleteVendorConnectorMapping200Response'] +slug: /tools/sdk/go/v3/models/delete-vendor-connector-mapping200-response +tags: ['SDK', 'Software Development Kit', 'DeleteVendorConnectorMapping200Response', 'DeleteVendorConnectorMapping200Response'] +--- + +# DeleteVendorConnectorMapping200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **int32** | The number of vendor connector mappings successfully deleted. | [optional] + +## Methods + +### NewDeleteVendorConnectorMapping200Response + +`func NewDeleteVendorConnectorMapping200Response() *DeleteVendorConnectorMapping200Response` + +NewDeleteVendorConnectorMapping200Response instantiates a new DeleteVendorConnectorMapping200Response 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 + +### NewDeleteVendorConnectorMapping200ResponseWithDefaults + +`func NewDeleteVendorConnectorMapping200ResponseWithDefaults() *DeleteVendorConnectorMapping200Response` + +NewDeleteVendorConnectorMapping200ResponseWithDefaults instantiates a new DeleteVendorConnectorMapping200Response 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 + +### GetCount + +`func (o *DeleteVendorConnectorMapping200Response) GetCount() int32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *DeleteVendorConnectorMapping200Response) GetCountOk() (*int32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *DeleteVendorConnectorMapping200Response) SetCount(v int32)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *DeleteVendorConnectorMapping200Response) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/DependantAppConnections.md b/docs/tools/sdk/go/Reference/V3/Models/DependantAppConnections.md new file mode 100644 index 000000000..82d92c12a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/DependantAppConnections.md @@ -0,0 +1,272 @@ +--- +id: dependant-app-connections +title: DependantAppConnections +pagination_label: DependantAppConnections +sidebar_label: DependantAppConnections +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DependantAppConnections', 'DependantAppConnections'] +slug: /tools/sdk/go/v3/models/dependant-app-connections +tags: ['SDK', 'Software Development Kit', 'DependantAppConnections', 'DependantAppConnections'] +--- + +# DependantAppConnections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CloudAppId** | Pointer to **string** | Id of the connected Application | [optional] +**Description** | Pointer to **string** | Description of the connected Application | [optional] +**Enabled** | Pointer to **bool** | Is the Application enabled | [optional] [default to true] +**ProvisionRequestEnabled** | Pointer to **bool** | Is Provisioning enabled for connected Application | [optional] [default to true] +**AccountSource** | Pointer to [**DependantAppConnectionsAccountSource**](dependant-app-connections-account-source) | | [optional] +**LauncherCount** | Pointer to **int64** | The amount of launchers for connected Application (long type) | [optional] +**MatchAllAccount** | Pointer to **bool** | Is Provisioning enabled for connected Application | [optional] [default to false] +**Owner** | Pointer to [**[]BaseReferenceDto**](base-reference-dto) | The owner of the connected Application | [optional] +**AppCenterEnabled** | Pointer to **bool** | Is App Center enabled for connected Application | [optional] [default to false] + +## Methods + +### NewDependantAppConnections + +`func NewDependantAppConnections() *DependantAppConnections` + +NewDependantAppConnections instantiates a new DependantAppConnections 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 + +### NewDependantAppConnectionsWithDefaults + +`func NewDependantAppConnectionsWithDefaults() *DependantAppConnections` + +NewDependantAppConnectionsWithDefaults instantiates a new DependantAppConnections 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 + +### GetCloudAppId + +`func (o *DependantAppConnections) GetCloudAppId() string` + +GetCloudAppId returns the CloudAppId field if non-nil, zero value otherwise. + +### GetCloudAppIdOk + +`func (o *DependantAppConnections) GetCloudAppIdOk() (*string, bool)` + +GetCloudAppIdOk returns a tuple with the CloudAppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudAppId + +`func (o *DependantAppConnections) SetCloudAppId(v string)` + +SetCloudAppId sets CloudAppId field to given value. + +### HasCloudAppId + +`func (o *DependantAppConnections) HasCloudAppId() bool` + +HasCloudAppId returns a boolean if a field has been set. + +### GetDescription + +`func (o *DependantAppConnections) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *DependantAppConnections) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *DependantAppConnections) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *DependantAppConnections) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetEnabled + +`func (o *DependantAppConnections) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *DependantAppConnections) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *DependantAppConnections) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *DependantAppConnections) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetProvisionRequestEnabled + +`func (o *DependantAppConnections) GetProvisionRequestEnabled() bool` + +GetProvisionRequestEnabled returns the ProvisionRequestEnabled field if non-nil, zero value otherwise. + +### GetProvisionRequestEnabledOk + +`func (o *DependantAppConnections) GetProvisionRequestEnabledOk() (*bool, bool)` + +GetProvisionRequestEnabledOk returns a tuple with the ProvisionRequestEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionRequestEnabled + +`func (o *DependantAppConnections) SetProvisionRequestEnabled(v bool)` + +SetProvisionRequestEnabled sets ProvisionRequestEnabled field to given value. + +### HasProvisionRequestEnabled + +`func (o *DependantAppConnections) HasProvisionRequestEnabled() bool` + +HasProvisionRequestEnabled returns a boolean if a field has been set. + +### GetAccountSource + +`func (o *DependantAppConnections) GetAccountSource() DependantAppConnectionsAccountSource` + +GetAccountSource returns the AccountSource field if non-nil, zero value otherwise. + +### GetAccountSourceOk + +`func (o *DependantAppConnections) GetAccountSourceOk() (*DependantAppConnectionsAccountSource, bool)` + +GetAccountSourceOk returns a tuple with the AccountSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSource + +`func (o *DependantAppConnections) SetAccountSource(v DependantAppConnectionsAccountSource)` + +SetAccountSource sets AccountSource field to given value. + +### HasAccountSource + +`func (o *DependantAppConnections) HasAccountSource() bool` + +HasAccountSource returns a boolean if a field has been set. + +### GetLauncherCount + +`func (o *DependantAppConnections) GetLauncherCount() int64` + +GetLauncherCount returns the LauncherCount field if non-nil, zero value otherwise. + +### GetLauncherCountOk + +`func (o *DependantAppConnections) GetLauncherCountOk() (*int64, bool)` + +GetLauncherCountOk returns a tuple with the LauncherCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncherCount + +`func (o *DependantAppConnections) SetLauncherCount(v int64)` + +SetLauncherCount sets LauncherCount field to given value. + +### HasLauncherCount + +`func (o *DependantAppConnections) HasLauncherCount() bool` + +HasLauncherCount returns a boolean if a field has been set. + +### GetMatchAllAccount + +`func (o *DependantAppConnections) GetMatchAllAccount() bool` + +GetMatchAllAccount returns the MatchAllAccount field if non-nil, zero value otherwise. + +### GetMatchAllAccountOk + +`func (o *DependantAppConnections) GetMatchAllAccountOk() (*bool, bool)` + +GetMatchAllAccountOk returns a tuple with the MatchAllAccount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAllAccount + +`func (o *DependantAppConnections) SetMatchAllAccount(v bool)` + +SetMatchAllAccount sets MatchAllAccount field to given value. + +### HasMatchAllAccount + +`func (o *DependantAppConnections) HasMatchAllAccount() bool` + +HasMatchAllAccount returns a boolean if a field has been set. + +### GetOwner + +`func (o *DependantAppConnections) GetOwner() []BaseReferenceDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *DependantAppConnections) GetOwnerOk() (*[]BaseReferenceDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *DependantAppConnections) SetOwner(v []BaseReferenceDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *DependantAppConnections) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetAppCenterEnabled + +`func (o *DependantAppConnections) GetAppCenterEnabled() bool` + +GetAppCenterEnabled returns the AppCenterEnabled field if non-nil, zero value otherwise. + +### GetAppCenterEnabledOk + +`func (o *DependantAppConnections) GetAppCenterEnabledOk() (*bool, bool)` + +GetAppCenterEnabledOk returns a tuple with the AppCenterEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppCenterEnabled + +`func (o *DependantAppConnections) SetAppCenterEnabled(v bool)` + +SetAppCenterEnabled sets AppCenterEnabled field to given value. + +### HasAppCenterEnabled + +`func (o *DependantAppConnections) HasAppCenterEnabled() bool` + +HasAppCenterEnabled returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/DependantAppConnectionsAccountSource.md b/docs/tools/sdk/go/Reference/V3/Models/DependantAppConnectionsAccountSource.md new file mode 100644 index 000000000..2df4f4747 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/DependantAppConnectionsAccountSource.md @@ -0,0 +1,90 @@ +--- +id: dependant-app-connections-account-source +title: DependantAppConnectionsAccountSource +pagination_label: DependantAppConnectionsAccountSource +sidebar_label: DependantAppConnectionsAccountSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DependantAppConnectionsAccountSource', 'DependantAppConnectionsAccountSource'] +slug: /tools/sdk/go/v3/models/dependant-app-connections-account-source +tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSource', 'DependantAppConnectionsAccountSource'] +--- + +# DependantAppConnectionsAccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UseForPasswordManagement** | Pointer to **bool** | Use this Account Source for password management | [optional] [default to false] +**PasswordPolicies** | Pointer to [**[]DependantAppConnectionsAccountSourcePasswordPoliciesInner**](dependant-app-connections-account-source-password-policies-inner) | A list of Password Policies for this Account Source | [optional] + +## Methods + +### NewDependantAppConnectionsAccountSource + +`func NewDependantAppConnectionsAccountSource() *DependantAppConnectionsAccountSource` + +NewDependantAppConnectionsAccountSource instantiates a new DependantAppConnectionsAccountSource 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 + +### NewDependantAppConnectionsAccountSourceWithDefaults + +`func NewDependantAppConnectionsAccountSourceWithDefaults() *DependantAppConnectionsAccountSource` + +NewDependantAppConnectionsAccountSourceWithDefaults instantiates a new DependantAppConnectionsAccountSource 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 + +### GetUseForPasswordManagement + +`func (o *DependantAppConnectionsAccountSource) GetUseForPasswordManagement() bool` + +GetUseForPasswordManagement returns the UseForPasswordManagement field if non-nil, zero value otherwise. + +### GetUseForPasswordManagementOk + +`func (o *DependantAppConnectionsAccountSource) GetUseForPasswordManagementOk() (*bool, bool)` + +GetUseForPasswordManagementOk returns a tuple with the UseForPasswordManagement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseForPasswordManagement + +`func (o *DependantAppConnectionsAccountSource) SetUseForPasswordManagement(v bool)` + +SetUseForPasswordManagement sets UseForPasswordManagement field to given value. + +### HasUseForPasswordManagement + +`func (o *DependantAppConnectionsAccountSource) HasUseForPasswordManagement() bool` + +HasUseForPasswordManagement returns a boolean if a field has been set. + +### GetPasswordPolicies + +`func (o *DependantAppConnectionsAccountSource) GetPasswordPolicies() []DependantAppConnectionsAccountSourcePasswordPoliciesInner` + +GetPasswordPolicies returns the PasswordPolicies field if non-nil, zero value otherwise. + +### GetPasswordPoliciesOk + +`func (o *DependantAppConnectionsAccountSource) GetPasswordPoliciesOk() (*[]DependantAppConnectionsAccountSourcePasswordPoliciesInner, bool)` + +GetPasswordPoliciesOk returns a tuple with the PasswordPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicies + +`func (o *DependantAppConnectionsAccountSource) SetPasswordPolicies(v []DependantAppConnectionsAccountSourcePasswordPoliciesInner)` + +SetPasswordPolicies sets PasswordPolicies field to given value. + +### HasPasswordPolicies + +`func (o *DependantAppConnectionsAccountSource) HasPasswordPolicies() bool` + +HasPasswordPolicies returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md b/docs/tools/sdk/go/Reference/V3/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md new file mode 100644 index 000000000..e67150b62 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md @@ -0,0 +1,116 @@ +--- +id: dependant-app-connections-account-source-password-policies-inner +title: DependantAppConnectionsAccountSourcePasswordPoliciesInner +pagination_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner +sidebar_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner'] +slug: /tools/sdk/go/v3/models/dependant-app-connections-account-source-password-policies-inner +tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner'] +--- + +# DependantAppConnectionsAccountSourcePasswordPoliciesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewDependantAppConnectionsAccountSourcePasswordPoliciesInner + +`func NewDependantAppConnectionsAccountSourcePasswordPoliciesInner() *DependantAppConnectionsAccountSourcePasswordPoliciesInner` + +NewDependantAppConnectionsAccountSourcePasswordPoliciesInner instantiates a new DependantAppConnectionsAccountSourcePasswordPoliciesInner 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 + +### NewDependantAppConnectionsAccountSourcePasswordPoliciesInnerWithDefaults + +`func NewDependantAppConnectionsAccountSourcePasswordPoliciesInnerWithDefaults() *DependantAppConnectionsAccountSourcePasswordPoliciesInner` + +NewDependantAppConnectionsAccountSourcePasswordPoliciesInnerWithDefaults instantiates a new DependantAppConnectionsAccountSourcePasswordPoliciesInner 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 + +### GetType + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DependantAppConnectionsAccountSourcePasswordPoliciesInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/DependantConnectionsMissingDto.md b/docs/tools/sdk/go/Reference/V3/Models/DependantConnectionsMissingDto.md new file mode 100644 index 000000000..5e5557383 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/DependantConnectionsMissingDto.md @@ -0,0 +1,90 @@ +--- +id: dependant-connections-missing-dto +title: DependantConnectionsMissingDto +pagination_label: DependantConnectionsMissingDto +sidebar_label: DependantConnectionsMissingDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DependantConnectionsMissingDto', 'DependantConnectionsMissingDto'] +slug: /tools/sdk/go/v3/models/dependant-connections-missing-dto +tags: ['SDK', 'Software Development Kit', 'DependantConnectionsMissingDto', 'DependantConnectionsMissingDto'] +--- + +# DependantConnectionsMissingDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DependencyType** | Pointer to **string** | The type of dependency type that is missing in the SourceConnections | [optional] +**Reason** | Pointer to **string** | The reason why this dependency is missing | [optional] + +## Methods + +### NewDependantConnectionsMissingDto + +`func NewDependantConnectionsMissingDto() *DependantConnectionsMissingDto` + +NewDependantConnectionsMissingDto instantiates a new DependantConnectionsMissingDto 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 + +### NewDependantConnectionsMissingDtoWithDefaults + +`func NewDependantConnectionsMissingDtoWithDefaults() *DependantConnectionsMissingDto` + +NewDependantConnectionsMissingDtoWithDefaults instantiates a new DependantConnectionsMissingDto 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 + +### GetDependencyType + +`func (o *DependantConnectionsMissingDto) GetDependencyType() string` + +GetDependencyType returns the DependencyType field if non-nil, zero value otherwise. + +### GetDependencyTypeOk + +`func (o *DependantConnectionsMissingDto) GetDependencyTypeOk() (*string, bool)` + +GetDependencyTypeOk returns a tuple with the DependencyType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDependencyType + +`func (o *DependantConnectionsMissingDto) SetDependencyType(v string)` + +SetDependencyType sets DependencyType field to given value. + +### HasDependencyType + +`func (o *DependantConnectionsMissingDto) HasDependencyType() bool` + +HasDependencyType returns a boolean if a field has been set. + +### GetReason + +`func (o *DependantConnectionsMissingDto) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *DependantConnectionsMissingDto) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *DependantConnectionsMissingDto) SetReason(v string)` + +SetReason sets Reason field to given value. + +### HasReason + +`func (o *DependantConnectionsMissingDto) HasReason() bool` + +HasReason returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/DimensionRef.md b/docs/tools/sdk/go/Reference/V3/Models/DimensionRef.md new file mode 100644 index 000000000..769ac1dd4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/DimensionRef.md @@ -0,0 +1,116 @@ +--- +id: dimension-ref +title: DimensionRef +pagination_label: DimensionRef +sidebar_label: DimensionRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DimensionRef', 'DimensionRef'] +slug: /tools/sdk/go/v3/models/dimension-ref +tags: ['SDK', 'Software Development Kit', 'DimensionRef', 'DimensionRef'] +--- + +# DimensionRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of the object to which this reference applies | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewDimensionRef + +`func NewDimensionRef() *DimensionRef` + +NewDimensionRef instantiates a new DimensionRef 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 + +### NewDimensionRefWithDefaults + +`func NewDimensionRefWithDefaults() *DimensionRef` + +NewDimensionRefWithDefaults instantiates a new DimensionRef 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 + +### GetType + +`func (o *DimensionRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *DimensionRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *DimensionRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *DimensionRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *DimensionRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DimensionRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DimensionRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DimensionRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *DimensionRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DimensionRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DimensionRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DimensionRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/DisplayReference.md b/docs/tools/sdk/go/Reference/V3/Models/DisplayReference.md new file mode 100644 index 000000000..bcde3f720 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/DisplayReference.md @@ -0,0 +1,116 @@ +--- +id: display-reference +title: DisplayReference +pagination_label: DisplayReference +sidebar_label: DisplayReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DisplayReference', 'DisplayReference'] +slug: /tools/sdk/go/v3/models/display-reference +tags: ['SDK', 'Software Development Kit', 'DisplayReference', 'DisplayReference'] +--- + +# DisplayReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] + +## Methods + +### NewDisplayReference + +`func NewDisplayReference() *DisplayReference` + +NewDisplayReference instantiates a new DisplayReference 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 + +### NewDisplayReferenceWithDefaults + +`func NewDisplayReferenceWithDefaults() *DisplayReference` + +NewDisplayReferenceWithDefaults instantiates a new DisplayReference 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 + +### GetId + +`func (o *DisplayReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DisplayReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DisplayReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DisplayReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *DisplayReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *DisplayReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *DisplayReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *DisplayReference) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *DisplayReference) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *DisplayReference) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *DisplayReference) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *DisplayReference) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/DtoType.md b/docs/tools/sdk/go/Reference/V3/Models/DtoType.md new file mode 100644 index 000000000..5c8f21eed --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/DtoType.md @@ -0,0 +1,75 @@ +--- +id: dto-type +title: DtoType +pagination_label: DtoType +sidebar_label: DtoType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DtoType', 'DtoType'] +slug: /tools/sdk/go/v3/models/dto-type +tags: ['SDK', 'Software Development Kit', 'DtoType', 'DtoType'] +--- + +# DtoType + +## Enum + + +* `ACCOUNT_CORRELATION_CONFIG` (value: `"ACCOUNT_CORRELATION_CONFIG"`) + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ACCESS_REQUEST_APPROVAL` (value: `"ACCESS_REQUEST_APPROVAL"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `APPLICATION` (value: `"APPLICATION"`) + +* `CAMPAIGN` (value: `"CAMPAIGN"`) + +* `CAMPAIGN_FILTER` (value: `"CAMPAIGN_FILTER"`) + +* `CERTIFICATION` (value: `"CERTIFICATION"`) + +* `CLUSTER` (value: `"CLUSTER"`) + +* `CONNECTOR_SCHEMA` (value: `"CONNECTOR_SCHEMA"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + +* `IDENTITY` (value: `"IDENTITY"`) + +* `IDENTITY_PROFILE` (value: `"IDENTITY_PROFILE"`) + +* `IDENTITY_REQUEST` (value: `"IDENTITY_REQUEST"`) + +* `MACHINE_IDENTITY` (value: `"MACHINE_IDENTITY"`) + +* `LIFECYCLE_STATE` (value: `"LIFECYCLE_STATE"`) + +* `PASSWORD_POLICY` (value: `"PASSWORD_POLICY"`) + +* `ROLE` (value: `"ROLE"`) + +* `RULE` (value: `"RULE"`) + +* `SOD_POLICY` (value: `"SOD_POLICY"`) + +* `SOURCE` (value: `"SOURCE"`) + +* `TAG` (value: `"TAG"`) + +* `TAG_CATEGORY` (value: `"TAG_CATEGORY"`) + +* `TASK_RESULT` (value: `"TASK_RESULT"`) + +* `REPORT_RESULT` (value: `"REPORT_RESULT"`) + +* `SOD_VIOLATION` (value: `"SOD_VIOLATION"`) + +* `ACCOUNT_ACTIVITY` (value: `"ACCOUNT_ACTIVITY"`) + +* `WORKGROUP` (value: `"WORKGROUP"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/DuoVerificationRequest.md b/docs/tools/sdk/go/Reference/V3/Models/DuoVerificationRequest.md new file mode 100644 index 000000000..64eddfda6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/DuoVerificationRequest.md @@ -0,0 +1,80 @@ +--- +id: duo-verification-request +title: DuoVerificationRequest +pagination_label: DuoVerificationRequest +sidebar_label: DuoVerificationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'DuoVerificationRequest', 'DuoVerificationRequest'] +slug: /tools/sdk/go/v3/models/duo-verification-request +tags: ['SDK', 'Software Development Kit', 'DuoVerificationRequest', 'DuoVerificationRequest'] +--- + +# DuoVerificationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **string** | User id for Verification request. | +**SignedResponse** | **string** | User id for Verification request. | + +## Methods + +### NewDuoVerificationRequest + +`func NewDuoVerificationRequest(userId string, signedResponse string, ) *DuoVerificationRequest` + +NewDuoVerificationRequest instantiates a new DuoVerificationRequest 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 + +### NewDuoVerificationRequestWithDefaults + +`func NewDuoVerificationRequestWithDefaults() *DuoVerificationRequest` + +NewDuoVerificationRequestWithDefaults instantiates a new DuoVerificationRequest 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 + +### GetUserId + +`func (o *DuoVerificationRequest) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *DuoVerificationRequest) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *DuoVerificationRequest) SetUserId(v string)` + +SetUserId sets UserId field to given value. + + +### GetSignedResponse + +`func (o *DuoVerificationRequest) GetSignedResponse() string` + +GetSignedResponse returns the SignedResponse field if non-nil, zero value otherwise. + +### GetSignedResponseOk + +`func (o *DuoVerificationRequest) GetSignedResponseOk() (*string, bool)` + +GetSignedResponseOk returns a tuple with the SignedResponse field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSignedResponse + +`func (o *DuoVerificationRequest) SetSignedResponse(v string)` + +SetSignedResponse sets SignedResponse field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/EmailNotificationOption.md b/docs/tools/sdk/go/Reference/V3/Models/EmailNotificationOption.md new file mode 100644 index 000000000..e38bedb4c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/EmailNotificationOption.md @@ -0,0 +1,142 @@ +--- +id: email-notification-option +title: EmailNotificationOption +pagination_label: EmailNotificationOption +sidebar_label: EmailNotificationOption +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EmailNotificationOption', 'EmailNotificationOption'] +slug: /tools/sdk/go/v3/models/email-notification-option +tags: ['SDK', 'Software Development Kit', 'EmailNotificationOption', 'EmailNotificationOption'] +--- + +# EmailNotificationOption + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NotifyManagers** | Pointer to **bool** | If true, then the manager is notified of the lifecycle state change. | [optional] [default to false] +**NotifyAllAdmins** | Pointer to **bool** | If true, then all the admins are notified of the lifecycle state change. | [optional] [default to false] +**NotifySpecificUsers** | Pointer to **bool** | If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change. | [optional] [default to false] +**EmailAddressList** | Pointer to **[]string** | List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change. | [optional] + +## Methods + +### NewEmailNotificationOption + +`func NewEmailNotificationOption() *EmailNotificationOption` + +NewEmailNotificationOption instantiates a new EmailNotificationOption 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 + +### NewEmailNotificationOptionWithDefaults + +`func NewEmailNotificationOptionWithDefaults() *EmailNotificationOption` + +NewEmailNotificationOptionWithDefaults instantiates a new EmailNotificationOption 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 + +### GetNotifyManagers + +`func (o *EmailNotificationOption) GetNotifyManagers() bool` + +GetNotifyManagers returns the NotifyManagers field if non-nil, zero value otherwise. + +### GetNotifyManagersOk + +`func (o *EmailNotificationOption) GetNotifyManagersOk() (*bool, bool)` + +GetNotifyManagersOk returns a tuple with the NotifyManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifyManagers + +`func (o *EmailNotificationOption) SetNotifyManagers(v bool)` + +SetNotifyManagers sets NotifyManagers field to given value. + +### HasNotifyManagers + +`func (o *EmailNotificationOption) HasNotifyManagers() bool` + +HasNotifyManagers returns a boolean if a field has been set. + +### GetNotifyAllAdmins + +`func (o *EmailNotificationOption) GetNotifyAllAdmins() bool` + +GetNotifyAllAdmins returns the NotifyAllAdmins field if non-nil, zero value otherwise. + +### GetNotifyAllAdminsOk + +`func (o *EmailNotificationOption) GetNotifyAllAdminsOk() (*bool, bool)` + +GetNotifyAllAdminsOk returns a tuple with the NotifyAllAdmins field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifyAllAdmins + +`func (o *EmailNotificationOption) SetNotifyAllAdmins(v bool)` + +SetNotifyAllAdmins sets NotifyAllAdmins field to given value. + +### HasNotifyAllAdmins + +`func (o *EmailNotificationOption) HasNotifyAllAdmins() bool` + +HasNotifyAllAdmins returns a boolean if a field has been set. + +### GetNotifySpecificUsers + +`func (o *EmailNotificationOption) GetNotifySpecificUsers() bool` + +GetNotifySpecificUsers returns the NotifySpecificUsers field if non-nil, zero value otherwise. + +### GetNotifySpecificUsersOk + +`func (o *EmailNotificationOption) GetNotifySpecificUsersOk() (*bool, bool)` + +GetNotifySpecificUsersOk returns a tuple with the NotifySpecificUsers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNotifySpecificUsers + +`func (o *EmailNotificationOption) SetNotifySpecificUsers(v bool)` + +SetNotifySpecificUsers sets NotifySpecificUsers field to given value. + +### HasNotifySpecificUsers + +`func (o *EmailNotificationOption) HasNotifySpecificUsers() bool` + +HasNotifySpecificUsers returns a boolean if a field has been set. + +### GetEmailAddressList + +`func (o *EmailNotificationOption) GetEmailAddressList() []string` + +GetEmailAddressList returns the EmailAddressList field if non-nil, zero value otherwise. + +### GetEmailAddressListOk + +`func (o *EmailNotificationOption) GetEmailAddressListOk() (*[]string, bool)` + +GetEmailAddressListOk returns a tuple with the EmailAddressList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailAddressList + +`func (o *EmailNotificationOption) SetEmailAddressList(v []string)` + +SetEmailAddressList sets EmailAddressList field to given value. + +### HasEmailAddressList + +`func (o *EmailNotificationOption) HasEmailAddressList() bool` + +HasEmailAddressList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Entitlement.md b/docs/tools/sdk/go/Reference/V3/Models/Entitlement.md new file mode 100644 index 000000000..1d51788dc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Entitlement.md @@ -0,0 +1,546 @@ +--- +id: entitlement +title: Entitlement +pagination_label: Entitlement +sidebar_label: Entitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Entitlement', 'Entitlement'] +slug: /tools/sdk/go/v3/models/entitlement +tags: ['SDK', 'Software Development Kit', 'Entitlement', 'Entitlement'] +--- + +# Entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The entitlement id | [optional] +**Name** | Pointer to **string** | The entitlement name | [optional] +**Attribute** | Pointer to **string** | The entitlement attribute name | [optional] +**Value** | Pointer to **string** | The value of the entitlement | [optional] +**SourceSchemaObjectType** | Pointer to **string** | The object type of the entitlement from the source schema | [optional] +**Description** | Pointer to **NullableString** | The description of the entitlement | [optional] +**Privileged** | Pointer to **bool** | True if the entitlement is privileged | [optional] +**CloudGoverned** | Pointer to **bool** | True if the entitlement is cloud governed | [optional] +**Requestable** | Pointer to **bool** | True if the entitlement is able to be directly requested | [optional] [default to false] +**Owner** | Pointer to [**NullableEntitlementOwner**](entitlement-owner) | | [optional] +**ManuallyUpdatedFields** | Pointer to **map[string]interface{}** | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [optional] +**AccessModelMetadata** | Pointer to [**EntitlementAccessModelMetadata**](entitlement-access-model-metadata) | | [optional] +**Created** | Pointer to **SailPointTime** | Time when the entitlement was created | [optional] +**Modified** | Pointer to **SailPointTime** | Time when the entitlement was last modified | [optional] +**Source** | Pointer to [**EntitlementSource**](entitlement-source) | | [optional] +**Attributes** | Pointer to **map[string]interface{}** | A map of free-form key-value pairs from the source system | [optional] +**Segments** | Pointer to **[]string** | List of IDs of segments, if any, to which this Entitlement is assigned. | [optional] +**DirectPermissions** | Pointer to [**[]PermissionDto**](permission-dto) | | [optional] + +## Methods + +### NewEntitlement + +`func NewEntitlement() *Entitlement` + +NewEntitlement instantiates a new Entitlement 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 + +### NewEntitlementWithDefaults + +`func NewEntitlementWithDefaults() *Entitlement` + +NewEntitlementWithDefaults instantiates a new Entitlement 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 + +### GetId + +`func (o *Entitlement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Entitlement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Entitlement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Entitlement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Entitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Entitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Entitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Entitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAttribute + +`func (o *Entitlement) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *Entitlement) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *Entitlement) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *Entitlement) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *Entitlement) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Entitlement) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Entitlement) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Entitlement) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSourceSchemaObjectType + +`func (o *Entitlement) GetSourceSchemaObjectType() string` + +GetSourceSchemaObjectType returns the SourceSchemaObjectType field if non-nil, zero value otherwise. + +### GetSourceSchemaObjectTypeOk + +`func (o *Entitlement) GetSourceSchemaObjectTypeOk() (*string, bool)` + +GetSourceSchemaObjectTypeOk returns a tuple with the SourceSchemaObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceSchemaObjectType + +`func (o *Entitlement) SetSourceSchemaObjectType(v string)` + +SetSourceSchemaObjectType sets SourceSchemaObjectType field to given value. + +### HasSourceSchemaObjectType + +`func (o *Entitlement) HasSourceSchemaObjectType() bool` + +HasSourceSchemaObjectType returns a boolean if a field has been set. + +### GetDescription + +`func (o *Entitlement) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Entitlement) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Entitlement) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Entitlement) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Entitlement) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Entitlement) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetPrivileged + +`func (o *Entitlement) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *Entitlement) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *Entitlement) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *Entitlement) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetCloudGoverned + +`func (o *Entitlement) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *Entitlement) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *Entitlement) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + +### HasCloudGoverned + +`func (o *Entitlement) HasCloudGoverned() bool` + +HasCloudGoverned returns a boolean if a field has been set. + +### GetRequestable + +`func (o *Entitlement) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *Entitlement) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *Entitlement) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *Entitlement) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetOwner + +`func (o *Entitlement) GetOwner() EntitlementOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Entitlement) GetOwnerOk() (*EntitlementOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Entitlement) SetOwner(v EntitlementOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *Entitlement) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *Entitlement) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *Entitlement) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetManuallyUpdatedFields + +`func (o *Entitlement) GetManuallyUpdatedFields() map[string]interface{}` + +GetManuallyUpdatedFields returns the ManuallyUpdatedFields field if non-nil, zero value otherwise. + +### GetManuallyUpdatedFieldsOk + +`func (o *Entitlement) GetManuallyUpdatedFieldsOk() (*map[string]interface{}, bool)` + +GetManuallyUpdatedFieldsOk returns a tuple with the ManuallyUpdatedFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyUpdatedFields + +`func (o *Entitlement) SetManuallyUpdatedFields(v map[string]interface{})` + +SetManuallyUpdatedFields sets ManuallyUpdatedFields field to given value. + +### HasManuallyUpdatedFields + +`func (o *Entitlement) HasManuallyUpdatedFields() bool` + +HasManuallyUpdatedFields returns a boolean if a field has been set. + +### SetManuallyUpdatedFieldsNil + +`func (o *Entitlement) SetManuallyUpdatedFieldsNil(b bool)` + + SetManuallyUpdatedFieldsNil sets the value for ManuallyUpdatedFields to be an explicit nil + +### UnsetManuallyUpdatedFields +`func (o *Entitlement) UnsetManuallyUpdatedFields()` + +UnsetManuallyUpdatedFields ensures that no value is present for ManuallyUpdatedFields, not even an explicit nil +### GetAccessModelMetadata + +`func (o *Entitlement) GetAccessModelMetadata() EntitlementAccessModelMetadata` + +GetAccessModelMetadata returns the AccessModelMetadata field if non-nil, zero value otherwise. + +### GetAccessModelMetadataOk + +`func (o *Entitlement) GetAccessModelMetadataOk() (*EntitlementAccessModelMetadata, bool)` + +GetAccessModelMetadataOk returns a tuple with the AccessModelMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessModelMetadata + +`func (o *Entitlement) SetAccessModelMetadata(v EntitlementAccessModelMetadata)` + +SetAccessModelMetadata sets AccessModelMetadata field to given value. + +### HasAccessModelMetadata + +`func (o *Entitlement) HasAccessModelMetadata() bool` + +HasAccessModelMetadata returns a boolean if a field has been set. + +### GetCreated + +`func (o *Entitlement) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Entitlement) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Entitlement) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Entitlement) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Entitlement) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Entitlement) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Entitlement) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Entitlement) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetSource + +`func (o *Entitlement) GetSource() EntitlementSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *Entitlement) GetSourceOk() (*EntitlementSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *Entitlement) SetSource(v EntitlementSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *Entitlement) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Entitlement) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Entitlement) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Entitlement) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Entitlement) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetSegments + +`func (o *Entitlement) GetSegments() []string` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *Entitlement) GetSegmentsOk() (*[]string, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *Entitlement) SetSegments(v []string)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *Entitlement) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### SetSegmentsNil + +`func (o *Entitlement) SetSegmentsNil(b bool)` + + SetSegmentsNil sets the value for Segments to be an explicit nil + +### UnsetSegments +`func (o *Entitlement) UnsetSegments()` + +UnsetSegments ensures that no value is present for Segments, not even an explicit nil +### GetDirectPermissions + +`func (o *Entitlement) GetDirectPermissions() []PermissionDto` + +GetDirectPermissions returns the DirectPermissions field if non-nil, zero value otherwise. + +### GetDirectPermissionsOk + +`func (o *Entitlement) GetDirectPermissionsOk() (*[]PermissionDto, bool)` + +GetDirectPermissionsOk returns a tuple with the DirectPermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectPermissions + +`func (o *Entitlement) SetDirectPermissions(v []PermissionDto)` + +SetDirectPermissions sets DirectPermissions field to given value. + +### HasDirectPermissions + +`func (o *Entitlement) HasDirectPermissions() bool` + +HasDirectPermissions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/EntitlementAccessModelMetadata.md b/docs/tools/sdk/go/Reference/V3/Models/EntitlementAccessModelMetadata.md new file mode 100644 index 000000000..4bf48e521 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/EntitlementAccessModelMetadata.md @@ -0,0 +1,64 @@ +--- +id: entitlement-access-model-metadata +title: EntitlementAccessModelMetadata +pagination_label: EntitlementAccessModelMetadata +sidebar_label: EntitlementAccessModelMetadata +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementAccessModelMetadata', 'EntitlementAccessModelMetadata'] +slug: /tools/sdk/go/v3/models/entitlement-access-model-metadata +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadata', 'EntitlementAccessModelMetadata'] +--- + +# EntitlementAccessModelMetadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]AccessModelMetadata**](access-model-metadata) | | [optional] + +## Methods + +### NewEntitlementAccessModelMetadata + +`func NewEntitlementAccessModelMetadata() *EntitlementAccessModelMetadata` + +NewEntitlementAccessModelMetadata instantiates a new EntitlementAccessModelMetadata 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 + +### NewEntitlementAccessModelMetadataWithDefaults + +`func NewEntitlementAccessModelMetadataWithDefaults() *EntitlementAccessModelMetadata` + +NewEntitlementAccessModelMetadataWithDefaults instantiates a new EntitlementAccessModelMetadata 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 + +### GetAttributes + +`func (o *EntitlementAccessModelMetadata) GetAttributes() []AccessModelMetadata` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *EntitlementAccessModelMetadata) GetAttributesOk() (*[]AccessModelMetadata, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *EntitlementAccessModelMetadata) SetAttributes(v []AccessModelMetadata)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *EntitlementAccessModelMetadata) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/EntitlementDocument.md b/docs/tools/sdk/go/Reference/V3/Models/EntitlementDocument.md new file mode 100644 index 000000000..50a558ab6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/EntitlementDocument.md @@ -0,0 +1,656 @@ +--- +id: entitlement-document +title: EntitlementDocument +pagination_label: EntitlementDocument +sidebar_label: EntitlementDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementDocument', 'EntitlementDocument'] +slug: /tools/sdk/go/v3/models/entitlement-document +tags: ['SDK', 'Software Development Kit', 'EntitlementDocument', 'EntitlementDocument'] +--- + +# EntitlementDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the referenced object. | +**Name** | **string** | The human readable name of the referenced object. | +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**DisplayName** | Pointer to **string** | Entitlement's display name. | [optional] +**Source** | Pointer to [**EntitlementDocumentAllOfSource**](entitlement-document-all-of-source) | | [optional] +**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the entitlement. | [optional] +**SegmentCount** | Pointer to **int32** | Number of segments with the role. | [optional] +**Requestable** | Pointer to **bool** | Indicates whether the entitlement is requestable. | [optional] [default to false] +**CloudGoverned** | Pointer to **bool** | Indicates whether the entitlement is cloud governed. | [optional] [default to false] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Privileged** | Pointer to **bool** | Indicates whether the entitlement is privileged. | [optional] [default to false] +**Tags** | Pointer to **[]string** | Tags that have been applied to the object. | [optional] +**Attribute** | Pointer to **string** | Attribute information for the entitlement. | [optional] +**Value** | Pointer to **string** | Value of the entitlement. | [optional] +**SourceSchemaObjectType** | Pointer to **string** | Source schema object type of the entitlement. | [optional] +**Schema** | Pointer to **string** | Schema type of the entitlement. | [optional] +**Hash** | Pointer to **string** | Read-only calculated hash value of an entitlement. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Attributes of the entitlement. | [optional] +**TruncatedAttributes** | Pointer to **[]string** | Truncated attributes of the entitlement. | [optional] +**ContainsDataAccess** | Pointer to **bool** | Indicates whether the entitlement contains data access. | [optional] [default to false] +**ManuallyUpdatedFields** | Pointer to [**NullableEntitlementDocumentAllOfManuallyUpdatedFields**](entitlement-document-all-of-manually-updated-fields) | | [optional] +**Permissions** | Pointer to [**[]EntitlementDocumentAllOfPermissions**](entitlement-document-all-of-permissions) | | [optional] + +## Methods + +### NewEntitlementDocument + +`func NewEntitlementDocument(id string, name string, ) *EntitlementDocument` + +NewEntitlementDocument instantiates a new EntitlementDocument 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 + +### NewEntitlementDocumentWithDefaults + +`func NewEntitlementDocumentWithDefaults() *EntitlementDocument` + +NewEntitlementDocumentWithDefaults instantiates a new EntitlementDocument 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 + +### GetId + +`func (o *EntitlementDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementDocument) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *EntitlementDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementDocument) SetName(v string)` + +SetName sets Name field to given value. + + +### GetModified + +`func (o *EntitlementDocument) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *EntitlementDocument) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *EntitlementDocument) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *EntitlementDocument) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *EntitlementDocument) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *EntitlementDocument) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *EntitlementDocument) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *EntitlementDocument) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *EntitlementDocument) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *EntitlementDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *EntitlementDocument) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *EntitlementDocument) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *EntitlementDocument) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *EntitlementDocument) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetSource + +`func (o *EntitlementDocument) GetSource() EntitlementDocumentAllOfSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *EntitlementDocument) GetSourceOk() (*EntitlementDocumentAllOfSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *EntitlementDocument) SetSource(v EntitlementDocumentAllOfSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *EntitlementDocument) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetSegments + +`func (o *EntitlementDocument) GetSegments() []BaseSegment` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *EntitlementDocument) GetSegmentsOk() (*[]BaseSegment, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *EntitlementDocument) SetSegments(v []BaseSegment)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *EntitlementDocument) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### GetSegmentCount + +`func (o *EntitlementDocument) GetSegmentCount() int32` + +GetSegmentCount returns the SegmentCount field if non-nil, zero value otherwise. + +### GetSegmentCountOk + +`func (o *EntitlementDocument) GetSegmentCountOk() (*int32, bool)` + +GetSegmentCountOk returns a tuple with the SegmentCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegmentCount + +`func (o *EntitlementDocument) SetSegmentCount(v int32)` + +SetSegmentCount sets SegmentCount field to given value. + +### HasSegmentCount + +`func (o *EntitlementDocument) HasSegmentCount() bool` + +HasSegmentCount returns a boolean if a field has been set. + +### GetRequestable + +`func (o *EntitlementDocument) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *EntitlementDocument) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *EntitlementDocument) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *EntitlementDocument) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetCloudGoverned + +`func (o *EntitlementDocument) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *EntitlementDocument) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *EntitlementDocument) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + +### HasCloudGoverned + +`func (o *EntitlementDocument) HasCloudGoverned() bool` + +HasCloudGoverned returns a boolean if a field has been set. + +### GetCreated + +`func (o *EntitlementDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *EntitlementDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *EntitlementDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *EntitlementDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *EntitlementDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *EntitlementDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetPrivileged + +`func (o *EntitlementDocument) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *EntitlementDocument) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *EntitlementDocument) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *EntitlementDocument) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetTags + +`func (o *EntitlementDocument) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *EntitlementDocument) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *EntitlementDocument) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *EntitlementDocument) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetAttribute + +`func (o *EntitlementDocument) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *EntitlementDocument) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *EntitlementDocument) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *EntitlementDocument) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *EntitlementDocument) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *EntitlementDocument) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *EntitlementDocument) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *EntitlementDocument) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSourceSchemaObjectType + +`func (o *EntitlementDocument) GetSourceSchemaObjectType() string` + +GetSourceSchemaObjectType returns the SourceSchemaObjectType field if non-nil, zero value otherwise. + +### GetSourceSchemaObjectTypeOk + +`func (o *EntitlementDocument) GetSourceSchemaObjectTypeOk() (*string, bool)` + +GetSourceSchemaObjectTypeOk returns a tuple with the SourceSchemaObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceSchemaObjectType + +`func (o *EntitlementDocument) SetSourceSchemaObjectType(v string)` + +SetSourceSchemaObjectType sets SourceSchemaObjectType field to given value. + +### HasSourceSchemaObjectType + +`func (o *EntitlementDocument) HasSourceSchemaObjectType() bool` + +HasSourceSchemaObjectType returns a boolean if a field has been set. + +### GetSchema + +`func (o *EntitlementDocument) GetSchema() string` + +GetSchema returns the Schema field if non-nil, zero value otherwise. + +### GetSchemaOk + +`func (o *EntitlementDocument) GetSchemaOk() (*string, bool)` + +GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchema + +`func (o *EntitlementDocument) SetSchema(v string)` + +SetSchema sets Schema field to given value. + +### HasSchema + +`func (o *EntitlementDocument) HasSchema() bool` + +HasSchema returns a boolean if a field has been set. + +### GetHash + +`func (o *EntitlementDocument) GetHash() string` + +GetHash returns the Hash field if non-nil, zero value otherwise. + +### GetHashOk + +`func (o *EntitlementDocument) GetHashOk() (*string, bool)` + +GetHashOk returns a tuple with the Hash field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHash + +`func (o *EntitlementDocument) SetHash(v string)` + +SetHash sets Hash field to given value. + +### HasHash + +`func (o *EntitlementDocument) HasHash() bool` + +HasHash returns a boolean if a field has been set. + +### GetAttributes + +`func (o *EntitlementDocument) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *EntitlementDocument) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *EntitlementDocument) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *EntitlementDocument) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetTruncatedAttributes + +`func (o *EntitlementDocument) GetTruncatedAttributes() []string` + +GetTruncatedAttributes returns the TruncatedAttributes field if non-nil, zero value otherwise. + +### GetTruncatedAttributesOk + +`func (o *EntitlementDocument) GetTruncatedAttributesOk() (*[]string, bool)` + +GetTruncatedAttributesOk returns a tuple with the TruncatedAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTruncatedAttributes + +`func (o *EntitlementDocument) SetTruncatedAttributes(v []string)` + +SetTruncatedAttributes sets TruncatedAttributes field to given value. + +### HasTruncatedAttributes + +`func (o *EntitlementDocument) HasTruncatedAttributes() bool` + +HasTruncatedAttributes returns a boolean if a field has been set. + +### GetContainsDataAccess + +`func (o *EntitlementDocument) GetContainsDataAccess() bool` + +GetContainsDataAccess returns the ContainsDataAccess field if non-nil, zero value otherwise. + +### GetContainsDataAccessOk + +`func (o *EntitlementDocument) GetContainsDataAccessOk() (*bool, bool)` + +GetContainsDataAccessOk returns a tuple with the ContainsDataAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainsDataAccess + +`func (o *EntitlementDocument) SetContainsDataAccess(v bool)` + +SetContainsDataAccess sets ContainsDataAccess field to given value. + +### HasContainsDataAccess + +`func (o *EntitlementDocument) HasContainsDataAccess() bool` + +HasContainsDataAccess returns a boolean if a field has been set. + +### GetManuallyUpdatedFields + +`func (o *EntitlementDocument) GetManuallyUpdatedFields() EntitlementDocumentAllOfManuallyUpdatedFields` + +GetManuallyUpdatedFields returns the ManuallyUpdatedFields field if non-nil, zero value otherwise. + +### GetManuallyUpdatedFieldsOk + +`func (o *EntitlementDocument) GetManuallyUpdatedFieldsOk() (*EntitlementDocumentAllOfManuallyUpdatedFields, bool)` + +GetManuallyUpdatedFieldsOk returns a tuple with the ManuallyUpdatedFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManuallyUpdatedFields + +`func (o *EntitlementDocument) SetManuallyUpdatedFields(v EntitlementDocumentAllOfManuallyUpdatedFields)` + +SetManuallyUpdatedFields sets ManuallyUpdatedFields field to given value. + +### HasManuallyUpdatedFields + +`func (o *EntitlementDocument) HasManuallyUpdatedFields() bool` + +HasManuallyUpdatedFields returns a boolean if a field has been set. + +### SetManuallyUpdatedFieldsNil + +`func (o *EntitlementDocument) SetManuallyUpdatedFieldsNil(b bool)` + + SetManuallyUpdatedFieldsNil sets the value for ManuallyUpdatedFields to be an explicit nil + +### UnsetManuallyUpdatedFields +`func (o *EntitlementDocument) UnsetManuallyUpdatedFields()` + +UnsetManuallyUpdatedFields ensures that no value is present for ManuallyUpdatedFields, not even an explicit nil +### GetPermissions + +`func (o *EntitlementDocument) GetPermissions() []EntitlementDocumentAllOfPermissions` + +GetPermissions returns the Permissions field if non-nil, zero value otherwise. + +### GetPermissionsOk + +`func (o *EntitlementDocument) GetPermissionsOk() (*[]EntitlementDocumentAllOfPermissions, bool)` + +GetPermissionsOk returns a tuple with the Permissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPermissions + +`func (o *EntitlementDocument) SetPermissions(v []EntitlementDocumentAllOfPermissions)` + +SetPermissions sets Permissions field to given value. + +### HasPermissions + +`func (o *EntitlementDocument) HasPermissions() bool` + +HasPermissions returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md b/docs/tools/sdk/go/Reference/V3/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md new file mode 100644 index 000000000..c6b954e7f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md @@ -0,0 +1,90 @@ +--- +id: entitlement-document-all-of-manually-updated-fields +title: EntitlementDocumentAllOfManuallyUpdatedFields +pagination_label: EntitlementDocumentAllOfManuallyUpdatedFields +sidebar_label: EntitlementDocumentAllOfManuallyUpdatedFields +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'EntitlementDocumentAllOfManuallyUpdatedFields'] +slug: /tools/sdk/go/v3/models/entitlement-document-all-of-manually-updated-fields +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'EntitlementDocumentAllOfManuallyUpdatedFields'] +--- + +# EntitlementDocumentAllOfManuallyUpdatedFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DESCRIPTION** | Pointer to **bool** | | [optional] [default to false] +**DISPLAY_NAME** | Pointer to **bool** | | [optional] [default to false] + +## Methods + +### NewEntitlementDocumentAllOfManuallyUpdatedFields + +`func NewEntitlementDocumentAllOfManuallyUpdatedFields() *EntitlementDocumentAllOfManuallyUpdatedFields` + +NewEntitlementDocumentAllOfManuallyUpdatedFields instantiates a new EntitlementDocumentAllOfManuallyUpdatedFields 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 + +### NewEntitlementDocumentAllOfManuallyUpdatedFieldsWithDefaults + +`func NewEntitlementDocumentAllOfManuallyUpdatedFieldsWithDefaults() *EntitlementDocumentAllOfManuallyUpdatedFields` + +NewEntitlementDocumentAllOfManuallyUpdatedFieldsWithDefaults instantiates a new EntitlementDocumentAllOfManuallyUpdatedFields 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 + +### GetDESCRIPTION + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) GetDESCRIPTION() bool` + +GetDESCRIPTION returns the DESCRIPTION field if non-nil, zero value otherwise. + +### GetDESCRIPTIONOk + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) GetDESCRIPTIONOk() (*bool, bool)` + +GetDESCRIPTIONOk returns a tuple with the DESCRIPTION field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDESCRIPTION + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) SetDESCRIPTION(v bool)` + +SetDESCRIPTION sets DESCRIPTION field to given value. + +### HasDESCRIPTION + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) HasDESCRIPTION() bool` + +HasDESCRIPTION returns a boolean if a field has been set. + +### GetDISPLAY_NAME + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) GetDISPLAY_NAME() bool` + +GetDISPLAY_NAME returns the DISPLAY_NAME field if non-nil, zero value otherwise. + +### GetDISPLAY_NAMEOk + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) GetDISPLAY_NAMEOk() (*bool, bool)` + +GetDISPLAY_NAMEOk returns a tuple with the DISPLAY_NAME field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDISPLAY_NAME + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) SetDISPLAY_NAME(v bool)` + +SetDISPLAY_NAME sets DISPLAY_NAME field to given value. + +### HasDISPLAY_NAME + +`func (o *EntitlementDocumentAllOfManuallyUpdatedFields) HasDISPLAY_NAME() bool` + +HasDISPLAY_NAME returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/EntitlementDocumentAllOfPermissions.md b/docs/tools/sdk/go/Reference/V3/Models/EntitlementDocumentAllOfPermissions.md new file mode 100644 index 000000000..9481405de --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/EntitlementDocumentAllOfPermissions.md @@ -0,0 +1,90 @@ +--- +id: entitlement-document-all-of-permissions +title: EntitlementDocumentAllOfPermissions +pagination_label: EntitlementDocumentAllOfPermissions +sidebar_label: EntitlementDocumentAllOfPermissions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementDocumentAllOfPermissions', 'EntitlementDocumentAllOfPermissions'] +slug: /tools/sdk/go/v3/models/entitlement-document-all-of-permissions +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfPermissions', 'EntitlementDocumentAllOfPermissions'] +--- + +# EntitlementDocumentAllOfPermissions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Target** | Pointer to **string** | The target the permission would grants rights on. | [optional] +**Rights** | Pointer to **[]string** | All the rights (e.g. actions) that this permission allows on the target | [optional] + +## Methods + +### NewEntitlementDocumentAllOfPermissions + +`func NewEntitlementDocumentAllOfPermissions() *EntitlementDocumentAllOfPermissions` + +NewEntitlementDocumentAllOfPermissions instantiates a new EntitlementDocumentAllOfPermissions 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 + +### NewEntitlementDocumentAllOfPermissionsWithDefaults + +`func NewEntitlementDocumentAllOfPermissionsWithDefaults() *EntitlementDocumentAllOfPermissions` + +NewEntitlementDocumentAllOfPermissionsWithDefaults instantiates a new EntitlementDocumentAllOfPermissions 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 + +### GetTarget + +`func (o *EntitlementDocumentAllOfPermissions) GetTarget() string` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *EntitlementDocumentAllOfPermissions) GetTargetOk() (*string, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *EntitlementDocumentAllOfPermissions) SetTarget(v string)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *EntitlementDocumentAllOfPermissions) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + +### GetRights + +`func (o *EntitlementDocumentAllOfPermissions) GetRights() []string` + +GetRights returns the Rights field if non-nil, zero value otherwise. + +### GetRightsOk + +`func (o *EntitlementDocumentAllOfPermissions) GetRightsOk() (*[]string, bool)` + +GetRightsOk returns a tuple with the Rights field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRights + +`func (o *EntitlementDocumentAllOfPermissions) SetRights(v []string)` + +SetRights sets Rights field to given value. + +### HasRights + +`func (o *EntitlementDocumentAllOfPermissions) HasRights() bool` + +HasRights returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/EntitlementDocumentAllOfSource.md b/docs/tools/sdk/go/Reference/V3/Models/EntitlementDocumentAllOfSource.md new file mode 100644 index 000000000..692658aa6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/EntitlementDocumentAllOfSource.md @@ -0,0 +1,116 @@ +--- +id: entitlement-document-all-of-source +title: EntitlementDocumentAllOfSource +pagination_label: EntitlementDocumentAllOfSource +sidebar_label: EntitlementDocumentAllOfSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementDocumentAllOfSource', 'EntitlementDocumentAllOfSource'] +slug: /tools/sdk/go/v3/models/entitlement-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfSource', 'EntitlementDocumentAllOfSource'] +--- + +# EntitlementDocumentAllOfSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of entitlement's source. | [optional] +**Name** | Pointer to **string** | Display name of entitlement's source. | [optional] +**Type** | Pointer to **string** | Type of object. | [optional] + +## Methods + +### NewEntitlementDocumentAllOfSource + +`func NewEntitlementDocumentAllOfSource() *EntitlementDocumentAllOfSource` + +NewEntitlementDocumentAllOfSource instantiates a new EntitlementDocumentAllOfSource 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 + +### NewEntitlementDocumentAllOfSourceWithDefaults + +`func NewEntitlementDocumentAllOfSourceWithDefaults() *EntitlementDocumentAllOfSource` + +NewEntitlementDocumentAllOfSourceWithDefaults instantiates a new EntitlementDocumentAllOfSource 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 + +### GetId + +`func (o *EntitlementDocumentAllOfSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementDocumentAllOfSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementDocumentAllOfSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementDocumentAllOfSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementDocumentAllOfSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementDocumentAllOfSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementDocumentAllOfSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementDocumentAllOfSource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *EntitlementDocumentAllOfSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementDocumentAllOfSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementDocumentAllOfSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementDocumentAllOfSource) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/EntitlementOwner.md b/docs/tools/sdk/go/Reference/V3/Models/EntitlementOwner.md new file mode 100644 index 000000000..20fa16f78 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/EntitlementOwner.md @@ -0,0 +1,116 @@ +--- +id: entitlement-owner +title: EntitlementOwner +pagination_label: EntitlementOwner +sidebar_label: EntitlementOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementOwner', 'EntitlementOwner'] +slug: /tools/sdk/go/v3/models/entitlement-owner +tags: ['SDK', 'Software Development Kit', 'EntitlementOwner', 'EntitlementOwner'] +--- + +# EntitlementOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The identity ID | [optional] +**Type** | Pointer to **string** | The type of object | [optional] +**Name** | Pointer to **string** | The display name of the identity | [optional] + +## Methods + +### NewEntitlementOwner + +`func NewEntitlementOwner() *EntitlementOwner` + +NewEntitlementOwner instantiates a new EntitlementOwner 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 + +### NewEntitlementOwnerWithDefaults + +`func NewEntitlementOwnerWithDefaults() *EntitlementOwner` + +NewEntitlementOwnerWithDefaults instantiates a new EntitlementOwner 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 + +### GetId + +`func (o *EntitlementOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *EntitlementOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/EntitlementRef.md b/docs/tools/sdk/go/Reference/V3/Models/EntitlementRef.md new file mode 100644 index 000000000..bc2e6ab9c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/EntitlementRef.md @@ -0,0 +1,126 @@ +--- +id: entitlement-ref +title: EntitlementRef +pagination_label: EntitlementRef +sidebar_label: EntitlementRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementRef', 'EntitlementRef'] +slug: /tools/sdk/go/v3/models/entitlement-ref +tags: ['SDK', 'Software Development Kit', 'EntitlementRef', 'EntitlementRef'] +--- + +# EntitlementRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Entitlement's DTO type. | [optional] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **NullableString** | Entitlement's display name. | [optional] + +## Methods + +### NewEntitlementRef + +`func NewEntitlementRef() *EntitlementRef` + +NewEntitlementRef instantiates a new EntitlementRef 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 + +### NewEntitlementRefWithDefaults + +`func NewEntitlementRefWithDefaults() *EntitlementRef` + +NewEntitlementRefWithDefaults instantiates a new EntitlementRef 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 + +### GetType + +`func (o *EntitlementRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *EntitlementRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementRef) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *EntitlementRef) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *EntitlementRef) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/EntitlementRef1.md b/docs/tools/sdk/go/Reference/V3/Models/EntitlementRef1.md new file mode 100644 index 000000000..90631d993 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/EntitlementRef1.md @@ -0,0 +1,116 @@ +--- +id: entitlement-ref1 +title: EntitlementRef1 +pagination_label: EntitlementRef1 +sidebar_label: EntitlementRef1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementRef1', 'EntitlementRef1'] +slug: /tools/sdk/go/v3/models/entitlement-ref1 +tags: ['SDK', 'Software Development Kit', 'EntitlementRef1', 'EntitlementRef1'] +--- + +# EntitlementRef1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Entitlement's DTO type. | [optional] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **string** | Entitlement's display name. | [optional] + +## Methods + +### NewEntitlementRef1 + +`func NewEntitlementRef1() *EntitlementRef1` + +NewEntitlementRef1 instantiates a new EntitlementRef1 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 + +### NewEntitlementRef1WithDefaults + +`func NewEntitlementRef1WithDefaults() *EntitlementRef1` + +NewEntitlementRef1WithDefaults instantiates a new EntitlementRef1 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 + +### GetType + +`func (o *EntitlementRef1) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementRef1) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementRef1) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementRef1) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *EntitlementRef1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementRef1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementRef1) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementRef1) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementRef1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementRef1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementRef1) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementRef1) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/EntitlementRequestConfig.md b/docs/tools/sdk/go/Reference/V3/Models/EntitlementRequestConfig.md new file mode 100644 index 000000000..a22d14493 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/EntitlementRequestConfig.md @@ -0,0 +1,152 @@ +--- +id: entitlement-request-config +title: EntitlementRequestConfig +pagination_label: EntitlementRequestConfig +sidebar_label: EntitlementRequestConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementRequestConfig', 'EntitlementRequestConfig'] +slug: /tools/sdk/go/v3/models/entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig', 'EntitlementRequestConfig'] +--- + +# EntitlementRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AllowEntitlementRequest** | Pointer to **bool** | If this is true, entitlement requests are allowed. | [optional] [default to false] +**RequestCommentsRequired** | Pointer to **bool** | If this is true, comments are required to submit entitlement requests. | [optional] [default to false] +**DeniedCommentsRequired** | Pointer to **bool** | If this is true, comments are required to reject entitlement requests. | [optional] [default to false] +**GrantRequestApprovalSchemes** | Pointer to **NullableString** | Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"`workgroup:{id}`\". You can use multiple governance groups (workgroups). | [optional] [default to "sourceOwner"] + +## Methods + +### NewEntitlementRequestConfig + +`func NewEntitlementRequestConfig() *EntitlementRequestConfig` + +NewEntitlementRequestConfig instantiates a new EntitlementRequestConfig 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 + +### NewEntitlementRequestConfigWithDefaults + +`func NewEntitlementRequestConfigWithDefaults() *EntitlementRequestConfig` + +NewEntitlementRequestConfigWithDefaults instantiates a new EntitlementRequestConfig 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 + +### GetAllowEntitlementRequest + +`func (o *EntitlementRequestConfig) GetAllowEntitlementRequest() bool` + +GetAllowEntitlementRequest returns the AllowEntitlementRequest field if non-nil, zero value otherwise. + +### GetAllowEntitlementRequestOk + +`func (o *EntitlementRequestConfig) GetAllowEntitlementRequestOk() (*bool, bool)` + +GetAllowEntitlementRequestOk returns a tuple with the AllowEntitlementRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllowEntitlementRequest + +`func (o *EntitlementRequestConfig) SetAllowEntitlementRequest(v bool)` + +SetAllowEntitlementRequest sets AllowEntitlementRequest field to given value. + +### HasAllowEntitlementRequest + +`func (o *EntitlementRequestConfig) HasAllowEntitlementRequest() bool` + +HasAllowEntitlementRequest returns a boolean if a field has been set. + +### GetRequestCommentsRequired + +`func (o *EntitlementRequestConfig) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *EntitlementRequestConfig) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *EntitlementRequestConfig) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *EntitlementRequestConfig) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + +### GetDeniedCommentsRequired + +`func (o *EntitlementRequestConfig) GetDeniedCommentsRequired() bool` + +GetDeniedCommentsRequired returns the DeniedCommentsRequired field if non-nil, zero value otherwise. + +### GetDeniedCommentsRequiredOk + +`func (o *EntitlementRequestConfig) GetDeniedCommentsRequiredOk() (*bool, bool)` + +GetDeniedCommentsRequiredOk returns a tuple with the DeniedCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeniedCommentsRequired + +`func (o *EntitlementRequestConfig) SetDeniedCommentsRequired(v bool)` + +SetDeniedCommentsRequired sets DeniedCommentsRequired field to given value. + +### HasDeniedCommentsRequired + +`func (o *EntitlementRequestConfig) HasDeniedCommentsRequired() bool` + +HasDeniedCommentsRequired returns a boolean if a field has been set. + +### GetGrantRequestApprovalSchemes + +`func (o *EntitlementRequestConfig) GetGrantRequestApprovalSchemes() string` + +GetGrantRequestApprovalSchemes returns the GrantRequestApprovalSchemes field if non-nil, zero value otherwise. + +### GetGrantRequestApprovalSchemesOk + +`func (o *EntitlementRequestConfig) GetGrantRequestApprovalSchemesOk() (*string, bool)` + +GetGrantRequestApprovalSchemesOk returns a tuple with the GrantRequestApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantRequestApprovalSchemes + +`func (o *EntitlementRequestConfig) SetGrantRequestApprovalSchemes(v string)` + +SetGrantRequestApprovalSchemes sets GrantRequestApprovalSchemes field to given value. + +### HasGrantRequestApprovalSchemes + +`func (o *EntitlementRequestConfig) HasGrantRequestApprovalSchemes() bool` + +HasGrantRequestApprovalSchemes returns a boolean if a field has been set. + +### SetGrantRequestApprovalSchemesNil + +`func (o *EntitlementRequestConfig) SetGrantRequestApprovalSchemesNil(b bool)` + + SetGrantRequestApprovalSchemesNil sets the value for GrantRequestApprovalSchemes to be an explicit nil + +### UnsetGrantRequestApprovalSchemes +`func (o *EntitlementRequestConfig) UnsetGrantRequestApprovalSchemes()` + +UnsetGrantRequestApprovalSchemes ensures that no value is present for GrantRequestApprovalSchemes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/EntitlementSource.md b/docs/tools/sdk/go/Reference/V3/Models/EntitlementSource.md new file mode 100644 index 000000000..11de10a0b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/EntitlementSource.md @@ -0,0 +1,116 @@ +--- +id: entitlement-source +title: EntitlementSource +pagination_label: EntitlementSource +sidebar_label: EntitlementSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementSource', 'EntitlementSource'] +slug: /tools/sdk/go/v3/models/entitlement-source +tags: ['SDK', 'Software Development Kit', 'EntitlementSource', 'EntitlementSource'] +--- + +# EntitlementSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The source ID | [optional] +**Type** | Pointer to **string** | The source type, will always be \"SOURCE\" | [optional] +**Name** | Pointer to **string** | The source name | [optional] + +## Methods + +### NewEntitlementSource + +`func NewEntitlementSource() *EntitlementSource` + +NewEntitlementSource instantiates a new EntitlementSource 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 + +### NewEntitlementSourceWithDefaults + +`func NewEntitlementSourceWithDefaults() *EntitlementSource` + +NewEntitlementSourceWithDefaults instantiates a new EntitlementSource 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 + +### GetId + +`func (o *EntitlementSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *EntitlementSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/EntitlementSummary.md b/docs/tools/sdk/go/Reference/V3/Models/EntitlementSummary.md new file mode 100644 index 000000000..474294000 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/EntitlementSummary.md @@ -0,0 +1,308 @@ +--- +id: entitlement-summary +title: EntitlementSummary +pagination_label: EntitlementSummary +sidebar_label: EntitlementSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EntitlementSummary', 'EntitlementSummary'] +slug: /tools/sdk/go/v3/models/entitlement-summary +tags: ['SDK', 'Software Development Kit', 'EntitlementSummary', 'EntitlementSummary'] +--- + +# EntitlementSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Source** | Pointer to [**Reference**](reference) | | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Privileged** | Pointer to **bool** | | [optional] +**Attribute** | Pointer to **string** | | [optional] +**Value** | Pointer to **string** | | [optional] +**Standalone** | Pointer to **bool** | | [optional] + +## Methods + +### NewEntitlementSummary + +`func NewEntitlementSummary() *EntitlementSummary` + +NewEntitlementSummary instantiates a new EntitlementSummary 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 + +### NewEntitlementSummaryWithDefaults + +`func NewEntitlementSummaryWithDefaults() *EntitlementSummary` + +NewEntitlementSummaryWithDefaults instantiates a new EntitlementSummary 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 + +### GetId + +`func (o *EntitlementSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntitlementSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EntitlementSummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EntitlementSummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EntitlementSummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EntitlementSummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EntitlementSummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EntitlementSummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *EntitlementSummary) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *EntitlementSummary) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *EntitlementSummary) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *EntitlementSummary) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *EntitlementSummary) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *EntitlementSummary) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *EntitlementSummary) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *EntitlementSummary) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *EntitlementSummary) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *EntitlementSummary) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSource + +`func (o *EntitlementSummary) GetSource() Reference` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *EntitlementSummary) GetSourceOk() (*Reference, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *EntitlementSummary) SetSource(v Reference)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *EntitlementSummary) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetType + +`func (o *EntitlementSummary) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EntitlementSummary) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EntitlementSummary) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EntitlementSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *EntitlementSummary) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *EntitlementSummary) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *EntitlementSummary) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *EntitlementSummary) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetAttribute + +`func (o *EntitlementSummary) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *EntitlementSummary) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *EntitlementSummary) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *EntitlementSummary) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *EntitlementSummary) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *EntitlementSummary) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *EntitlementSummary) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *EntitlementSummary) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetStandalone + +`func (o *EntitlementSummary) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *EntitlementSummary) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *EntitlementSummary) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + +### HasStandalone + +`func (o *EntitlementSummary) HasStandalone() bool` + +HasStandalone returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ErrorMessageDto.md b/docs/tools/sdk/go/Reference/V3/Models/ErrorMessageDto.md new file mode 100644 index 000000000..ec5dc8fad --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ErrorMessageDto.md @@ -0,0 +1,136 @@ +--- +id: error-message-dto +title: ErrorMessageDto +pagination_label: ErrorMessageDto +sidebar_label: ErrorMessageDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ErrorMessageDto', 'ErrorMessageDto'] +slug: /tools/sdk/go/v3/models/error-message-dto +tags: ['SDK', 'Software Development Kit', 'ErrorMessageDto', 'ErrorMessageDto'] +--- + +# ErrorMessageDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | Pointer to **NullableString** | The locale for the message text, a BCP 47 language tag. | [optional] +**LocaleOrigin** | Pointer to [**NullableLocaleOrigin**](locale-origin) | | [optional] +**Text** | Pointer to **string** | Actual text of the error message in the indicated locale. | [optional] + +## Methods + +### NewErrorMessageDto + +`func NewErrorMessageDto() *ErrorMessageDto` + +NewErrorMessageDto instantiates a new ErrorMessageDto 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 + +### NewErrorMessageDtoWithDefaults + +`func NewErrorMessageDtoWithDefaults() *ErrorMessageDto` + +NewErrorMessageDtoWithDefaults instantiates a new ErrorMessageDto 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 + +### GetLocale + +`func (o *ErrorMessageDto) GetLocale() string` + +GetLocale returns the Locale field if non-nil, zero value otherwise. + +### GetLocaleOk + +`func (o *ErrorMessageDto) GetLocaleOk() (*string, bool)` + +GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocale + +`func (o *ErrorMessageDto) SetLocale(v string)` + +SetLocale sets Locale field to given value. + +### HasLocale + +`func (o *ErrorMessageDto) HasLocale() bool` + +HasLocale returns a boolean if a field has been set. + +### SetLocaleNil + +`func (o *ErrorMessageDto) SetLocaleNil(b bool)` + + SetLocaleNil sets the value for Locale to be an explicit nil + +### UnsetLocale +`func (o *ErrorMessageDto) UnsetLocale()` + +UnsetLocale ensures that no value is present for Locale, not even an explicit nil +### GetLocaleOrigin + +`func (o *ErrorMessageDto) GetLocaleOrigin() LocaleOrigin` + +GetLocaleOrigin returns the LocaleOrigin field if non-nil, zero value otherwise. + +### GetLocaleOriginOk + +`func (o *ErrorMessageDto) GetLocaleOriginOk() (*LocaleOrigin, bool)` + +GetLocaleOriginOk returns a tuple with the LocaleOrigin field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocaleOrigin + +`func (o *ErrorMessageDto) SetLocaleOrigin(v LocaleOrigin)` + +SetLocaleOrigin sets LocaleOrigin field to given value. + +### HasLocaleOrigin + +`func (o *ErrorMessageDto) HasLocaleOrigin() bool` + +HasLocaleOrigin returns a boolean if a field has been set. + +### SetLocaleOriginNil + +`func (o *ErrorMessageDto) SetLocaleOriginNil(b bool)` + + SetLocaleOriginNil sets the value for LocaleOrigin to be an explicit nil + +### UnsetLocaleOrigin +`func (o *ErrorMessageDto) UnsetLocaleOrigin()` + +UnsetLocaleOrigin ensures that no value is present for LocaleOrigin, not even an explicit nil +### GetText + +`func (o *ErrorMessageDto) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *ErrorMessageDto) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *ErrorMessageDto) SetText(v string)` + +SetText sets Text field to given value. + +### HasText + +`func (o *ErrorMessageDto) HasText() bool` + +HasText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ErrorResponseDto.md b/docs/tools/sdk/go/Reference/V3/Models/ErrorResponseDto.md new file mode 100644 index 000000000..08a27577b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ErrorResponseDto.md @@ -0,0 +1,142 @@ +--- +id: error-response-dto +title: ErrorResponseDto +pagination_label: ErrorResponseDto +sidebar_label: ErrorResponseDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ErrorResponseDto', 'ErrorResponseDto'] +slug: /tools/sdk/go/v3/models/error-response-dto +tags: ['SDK', 'Software Development Kit', 'ErrorResponseDto', 'ErrorResponseDto'] +--- + +# ErrorResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **string** | Fine-grained error code providing more detail of the error. | [optional] +**TrackingId** | Pointer to **string** | Unique tracking id for the error. | [optional] +**Messages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Generic localized reason for error | [optional] +**Causes** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [optional] + +## Methods + +### NewErrorResponseDto + +`func NewErrorResponseDto() *ErrorResponseDto` + +NewErrorResponseDto instantiates a new ErrorResponseDto 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 + +### NewErrorResponseDtoWithDefaults + +`func NewErrorResponseDtoWithDefaults() *ErrorResponseDto` + +NewErrorResponseDtoWithDefaults instantiates a new ErrorResponseDto 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 + +### GetDetailCode + +`func (o *ErrorResponseDto) GetDetailCode() string` + +GetDetailCode returns the DetailCode field if non-nil, zero value otherwise. + +### GetDetailCodeOk + +`func (o *ErrorResponseDto) GetDetailCodeOk() (*string, bool)` + +GetDetailCodeOk returns a tuple with the DetailCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetailCode + +`func (o *ErrorResponseDto) SetDetailCode(v string)` + +SetDetailCode sets DetailCode field to given value. + +### HasDetailCode + +`func (o *ErrorResponseDto) HasDetailCode() bool` + +HasDetailCode returns a boolean if a field has been set. + +### GetTrackingId + +`func (o *ErrorResponseDto) GetTrackingId() string` + +GetTrackingId returns the TrackingId field if non-nil, zero value otherwise. + +### GetTrackingIdOk + +`func (o *ErrorResponseDto) GetTrackingIdOk() (*string, bool)` + +GetTrackingIdOk returns a tuple with the TrackingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingId + +`func (o *ErrorResponseDto) SetTrackingId(v string)` + +SetTrackingId sets TrackingId field to given value. + +### HasTrackingId + +`func (o *ErrorResponseDto) HasTrackingId() bool` + +HasTrackingId returns a boolean if a field has been set. + +### GetMessages + +`func (o *ErrorResponseDto) GetMessages() []ErrorMessageDto` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *ErrorResponseDto) GetMessagesOk() (*[]ErrorMessageDto, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *ErrorResponseDto) SetMessages(v []ErrorMessageDto)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *ErrorResponseDto) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetCauses + +`func (o *ErrorResponseDto) GetCauses() []ErrorMessageDto` + +GetCauses returns the Causes field if non-nil, zero value otherwise. + +### GetCausesOk + +`func (o *ErrorResponseDto) GetCausesOk() (*[]ErrorMessageDto, bool)` + +GetCausesOk returns a tuple with the Causes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCauses + +`func (o *ErrorResponseDto) SetCauses(v []ErrorMessageDto)` + +SetCauses sets Causes field to given value. + +### HasCauses + +`func (o *ErrorResponseDto) HasCauses() bool` + +HasCauses returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Event.md b/docs/tools/sdk/go/Reference/V3/Models/Event.md new file mode 100644 index 000000000..9dda7aa7c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Event.md @@ -0,0 +1,490 @@ +--- +id: event +title: Event +pagination_label: Event +sidebar_label: Event +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Event', 'Event'] +slug: /tools/sdk/go/v3/models/event +tags: ['SDK', 'Software Development Kit', 'Event', 'Event'] +--- + +# Event + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the entitlement. | [optional] +**Name** | Pointer to **string** | Name of the entitlement. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Action** | Pointer to **string** | Name of the event as it's displayed in audit reports. | [optional] +**Type** | Pointer to **string** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**Actor** | Pointer to [**EventActor**](event-actor) | | [optional] +**Target** | Pointer to [**EventTarget**](event-target) | | [optional] +**Stack** | Pointer to **string** | The event's stack. | [optional] +**TrackingNumber** | Pointer to **string** | ID of the group of events. | [optional] +**IpAddress** | Pointer to **string** | Target system's IP address. | [optional] +**Details** | Pointer to **string** | ID of event's details. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Attributes involved in the event. | [optional] +**Objects** | Pointer to **[]string** | Objects the event is happening to. | [optional] +**Operation** | Pointer to **string** | Operation, or action, performed during the event. | [optional] +**Status** | Pointer to **string** | Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. | [optional] +**TechnicalName** | Pointer to **string** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] + +## Methods + +### NewEvent + +`func NewEvent() *Event` + +NewEvent instantiates a new Event 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 + +### NewEventWithDefaults + +`func NewEventWithDefaults() *Event` + +NewEventWithDefaults instantiates a new Event 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 + +### GetId + +`func (o *Event) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Event) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Event) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Event) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Event) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Event) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Event) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Event) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *Event) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Event) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Event) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Event) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *Event) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *Event) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetSynced + +`func (o *Event) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *Event) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *Event) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *Event) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetAction + +`func (o *Event) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *Event) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *Event) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *Event) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetType + +`func (o *Event) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Event) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Event) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Event) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetActor + +`func (o *Event) GetActor() EventActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *Event) GetActorOk() (*EventActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *Event) SetActor(v EventActor)` + +SetActor sets Actor field to given value. + +### HasActor + +`func (o *Event) HasActor() bool` + +HasActor returns a boolean if a field has been set. + +### GetTarget + +`func (o *Event) GetTarget() EventTarget` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *Event) GetTargetOk() (*EventTarget, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *Event) SetTarget(v EventTarget)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *Event) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + +### GetStack + +`func (o *Event) GetStack() string` + +GetStack returns the Stack field if non-nil, zero value otherwise. + +### GetStackOk + +`func (o *Event) GetStackOk() (*string, bool)` + +GetStackOk returns a tuple with the Stack field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStack + +`func (o *Event) SetStack(v string)` + +SetStack sets Stack field to given value. + +### HasStack + +`func (o *Event) HasStack() bool` + +HasStack returns a boolean if a field has been set. + +### GetTrackingNumber + +`func (o *Event) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *Event) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *Event) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + +### HasTrackingNumber + +`func (o *Event) HasTrackingNumber() bool` + +HasTrackingNumber returns a boolean if a field has been set. + +### GetIpAddress + +`func (o *Event) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *Event) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *Event) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + +### HasIpAddress + +`func (o *Event) HasIpAddress() bool` + +HasIpAddress returns a boolean if a field has been set. + +### GetDetails + +`func (o *Event) GetDetails() string` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *Event) GetDetailsOk() (*string, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *Event) SetDetails(v string)` + +SetDetails sets Details field to given value. + +### HasDetails + +`func (o *Event) HasDetails() bool` + +HasDetails returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Event) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Event) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Event) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Event) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetObjects + +`func (o *Event) GetObjects() []string` + +GetObjects returns the Objects field if non-nil, zero value otherwise. + +### GetObjectsOk + +`func (o *Event) GetObjectsOk() (*[]string, bool)` + +GetObjectsOk returns a tuple with the Objects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjects + +`func (o *Event) SetObjects(v []string)` + +SetObjects sets Objects field to given value. + +### HasObjects + +`func (o *Event) HasObjects() bool` + +HasObjects returns a boolean if a field has been set. + +### GetOperation + +`func (o *Event) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *Event) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *Event) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *Event) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetStatus + +`func (o *Event) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Event) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Event) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Event) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetTechnicalName + +`func (o *Event) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *Event) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *Event) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + +### HasTechnicalName + +`func (o *Event) HasTechnicalName() bool` + +HasTechnicalName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/EventActor.md b/docs/tools/sdk/go/Reference/V3/Models/EventActor.md new file mode 100644 index 000000000..a26c23e7e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/EventActor.md @@ -0,0 +1,64 @@ +--- +id: event-actor +title: EventActor +pagination_label: EventActor +sidebar_label: EventActor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EventActor', 'EventActor'] +slug: /tools/sdk/go/v3/models/event-actor +tags: ['SDK', 'Software Development Kit', 'EventActor', 'EventActor'] +--- + +# EventActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the actor that generated the event. | [optional] + +## Methods + +### NewEventActor + +`func NewEventActor() *EventActor` + +NewEventActor instantiates a new EventActor 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 + +### NewEventActorWithDefaults + +`func NewEventActorWithDefaults() *EventActor` + +NewEventActorWithDefaults instantiates a new EventActor 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 + +### GetName + +`func (o *EventActor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EventActor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EventActor) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EventActor) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/EventDocument.md b/docs/tools/sdk/go/Reference/V3/Models/EventDocument.md new file mode 100644 index 000000000..d53cc92e1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/EventDocument.md @@ -0,0 +1,490 @@ +--- +id: event-document +title: EventDocument +pagination_label: EventDocument +sidebar_label: EventDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EventDocument', 'EventDocument'] +slug: /tools/sdk/go/v3/models/event-document +tags: ['SDK', 'Software Development Kit', 'EventDocument', 'EventDocument'] +--- + +# EventDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the entitlement. | [optional] +**Name** | Pointer to **string** | Name of the entitlement. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Action** | Pointer to **string** | Name of the event as it's displayed in audit reports. | [optional] +**Type** | Pointer to **string** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**Actor** | Pointer to [**EventActor**](event-actor) | | [optional] +**Target** | Pointer to [**EventTarget**](event-target) | | [optional] +**Stack** | Pointer to **string** | The event's stack. | [optional] +**TrackingNumber** | Pointer to **string** | ID of the group of events. | [optional] +**IpAddress** | Pointer to **string** | Target system's IP address. | [optional] +**Details** | Pointer to **string** | ID of event's details. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Attributes involved in the event. | [optional] +**Objects** | Pointer to **[]string** | Objects the event is happening to. | [optional] +**Operation** | Pointer to **string** | Operation, or action, performed during the event. | [optional] +**Status** | Pointer to **string** | Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. | [optional] +**TechnicalName** | Pointer to **string** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] + +## Methods + +### NewEventDocument + +`func NewEventDocument() *EventDocument` + +NewEventDocument instantiates a new EventDocument 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 + +### NewEventDocumentWithDefaults + +`func NewEventDocumentWithDefaults() *EventDocument` + +NewEventDocumentWithDefaults instantiates a new EventDocument 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 + +### GetId + +`func (o *EventDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EventDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EventDocument) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *EventDocument) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *EventDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EventDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EventDocument) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EventDocument) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *EventDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *EventDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *EventDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *EventDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *EventDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *EventDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetSynced + +`func (o *EventDocument) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *EventDocument) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *EventDocument) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *EventDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetAction + +`func (o *EventDocument) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *EventDocument) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *EventDocument) SetAction(v string)` + +SetAction sets Action field to given value. + +### HasAction + +`func (o *EventDocument) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### GetType + +`func (o *EventDocument) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *EventDocument) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *EventDocument) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *EventDocument) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetActor + +`func (o *EventDocument) GetActor() EventActor` + +GetActor returns the Actor field if non-nil, zero value otherwise. + +### GetActorOk + +`func (o *EventDocument) GetActorOk() (*EventActor, bool)` + +GetActorOk returns a tuple with the Actor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActor + +`func (o *EventDocument) SetActor(v EventActor)` + +SetActor sets Actor field to given value. + +### HasActor + +`func (o *EventDocument) HasActor() bool` + +HasActor returns a boolean if a field has been set. + +### GetTarget + +`func (o *EventDocument) GetTarget() EventTarget` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *EventDocument) GetTargetOk() (*EventTarget, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *EventDocument) SetTarget(v EventTarget)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *EventDocument) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + +### GetStack + +`func (o *EventDocument) GetStack() string` + +GetStack returns the Stack field if non-nil, zero value otherwise. + +### GetStackOk + +`func (o *EventDocument) GetStackOk() (*string, bool)` + +GetStackOk returns a tuple with the Stack field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStack + +`func (o *EventDocument) SetStack(v string)` + +SetStack sets Stack field to given value. + +### HasStack + +`func (o *EventDocument) HasStack() bool` + +HasStack returns a boolean if a field has been set. + +### GetTrackingNumber + +`func (o *EventDocument) GetTrackingNumber() string` + +GetTrackingNumber returns the TrackingNumber field if non-nil, zero value otherwise. + +### GetTrackingNumberOk + +`func (o *EventDocument) GetTrackingNumberOk() (*string, bool)` + +GetTrackingNumberOk returns a tuple with the TrackingNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingNumber + +`func (o *EventDocument) SetTrackingNumber(v string)` + +SetTrackingNumber sets TrackingNumber field to given value. + +### HasTrackingNumber + +`func (o *EventDocument) HasTrackingNumber() bool` + +HasTrackingNumber returns a boolean if a field has been set. + +### GetIpAddress + +`func (o *EventDocument) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *EventDocument) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *EventDocument) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + +### HasIpAddress + +`func (o *EventDocument) HasIpAddress() bool` + +HasIpAddress returns a boolean if a field has been set. + +### GetDetails + +`func (o *EventDocument) GetDetails() string` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *EventDocument) GetDetailsOk() (*string, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *EventDocument) SetDetails(v string)` + +SetDetails sets Details field to given value. + +### HasDetails + +`func (o *EventDocument) HasDetails() bool` + +HasDetails returns a boolean if a field has been set. + +### GetAttributes + +`func (o *EventDocument) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *EventDocument) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *EventDocument) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *EventDocument) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetObjects + +`func (o *EventDocument) GetObjects() []string` + +GetObjects returns the Objects field if non-nil, zero value otherwise. + +### GetObjectsOk + +`func (o *EventDocument) GetObjectsOk() (*[]string, bool)` + +GetObjectsOk returns a tuple with the Objects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjects + +`func (o *EventDocument) SetObjects(v []string)` + +SetObjects sets Objects field to given value. + +### HasObjects + +`func (o *EventDocument) HasObjects() bool` + +HasObjects returns a boolean if a field has been set. + +### GetOperation + +`func (o *EventDocument) GetOperation() string` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *EventDocument) GetOperationOk() (*string, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *EventDocument) SetOperation(v string)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *EventDocument) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetStatus + +`func (o *EventDocument) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *EventDocument) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *EventDocument) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *EventDocument) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetTechnicalName + +`func (o *EventDocument) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *EventDocument) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *EventDocument) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + +### HasTechnicalName + +`func (o *EventDocument) HasTechnicalName() bool` + +HasTechnicalName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/EventTarget.md b/docs/tools/sdk/go/Reference/V3/Models/EventTarget.md new file mode 100644 index 000000000..d77e08c40 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/EventTarget.md @@ -0,0 +1,64 @@ +--- +id: event-target +title: EventTarget +pagination_label: EventTarget +sidebar_label: EventTarget +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'EventTarget', 'EventTarget'] +slug: /tools/sdk/go/v3/models/event-target +tags: ['SDK', 'Software Development Kit', 'EventTarget', 'EventTarget'] +--- + +# EventTarget + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the target, or recipient, of the event. | [optional] + +## Methods + +### NewEventTarget + +`func NewEventTarget() *EventTarget` + +NewEventTarget instantiates a new EventTarget 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 + +### NewEventTargetWithDefaults + +`func NewEventTargetWithDefaults() *EventTarget` + +NewEventTargetWithDefaults instantiates a new EventTarget 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 + +### GetName + +`func (o *EventTarget) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EventTarget) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EventTarget) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *EventTarget) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ExceptionAccessCriteria.md b/docs/tools/sdk/go/Reference/V3/Models/ExceptionAccessCriteria.md new file mode 100644 index 000000000..3df3bba11 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ExceptionAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: exception-access-criteria +title: ExceptionAccessCriteria +pagination_label: ExceptionAccessCriteria +sidebar_label: ExceptionAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExceptionAccessCriteria', 'ExceptionAccessCriteria'] +slug: /tools/sdk/go/v3/models/exception-access-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionAccessCriteria', 'ExceptionAccessCriteria'] +--- + +# ExceptionAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] +**RightCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] + +## Methods + +### NewExceptionAccessCriteria + +`func NewExceptionAccessCriteria() *ExceptionAccessCriteria` + +NewExceptionAccessCriteria instantiates a new ExceptionAccessCriteria 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 + +### NewExceptionAccessCriteriaWithDefaults + +`func NewExceptionAccessCriteriaWithDefaults() *ExceptionAccessCriteria` + +NewExceptionAccessCriteriaWithDefaults instantiates a new ExceptionAccessCriteria 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 + +### GetLeftCriteria + +`func (o *ExceptionAccessCriteria) GetLeftCriteria() ExceptionCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *ExceptionAccessCriteria) GetLeftCriteriaOk() (*ExceptionCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *ExceptionAccessCriteria) SetLeftCriteria(v ExceptionCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *ExceptionAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *ExceptionAccessCriteria) GetRightCriteria() ExceptionCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *ExceptionAccessCriteria) GetRightCriteriaOk() (*ExceptionCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *ExceptionAccessCriteria) SetRightCriteria(v ExceptionCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *ExceptionAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ExceptionCriteria.md b/docs/tools/sdk/go/Reference/V3/Models/ExceptionCriteria.md new file mode 100644 index 000000000..a46206e04 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ExceptionCriteria.md @@ -0,0 +1,64 @@ +--- +id: exception-criteria +title: ExceptionCriteria +pagination_label: ExceptionCriteria +sidebar_label: ExceptionCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExceptionCriteria', 'ExceptionCriteria'] +slug: /tools/sdk/go/v3/models/exception-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteria', 'ExceptionCriteria'] +--- + +# ExceptionCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]ExceptionCriteriaCriteriaListInner**](exception-criteria-criteria-list-inner) | List of exception criteria. There is a min of 1 and max of 50 items in the list. | [optional] + +## Methods + +### NewExceptionCriteria + +`func NewExceptionCriteria() *ExceptionCriteria` + +NewExceptionCriteria instantiates a new ExceptionCriteria 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 + +### NewExceptionCriteriaWithDefaults + +`func NewExceptionCriteriaWithDefaults() *ExceptionCriteria` + +NewExceptionCriteriaWithDefaults instantiates a new ExceptionCriteria 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 + +### GetCriteriaList + +`func (o *ExceptionCriteria) GetCriteriaList() []ExceptionCriteriaCriteriaListInner` + +GetCriteriaList returns the CriteriaList field if non-nil, zero value otherwise. + +### GetCriteriaListOk + +`func (o *ExceptionCriteria) GetCriteriaListOk() (*[]ExceptionCriteriaCriteriaListInner, bool)` + +GetCriteriaListOk returns a tuple with the CriteriaList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteriaList + +`func (o *ExceptionCriteria) SetCriteriaList(v []ExceptionCriteriaCriteriaListInner)` + +SetCriteriaList sets CriteriaList field to given value. + +### HasCriteriaList + +`func (o *ExceptionCriteria) HasCriteriaList() bool` + +HasCriteriaList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ExceptionCriteriaAccess.md b/docs/tools/sdk/go/Reference/V3/Models/ExceptionCriteriaAccess.md new file mode 100644 index 000000000..0160bc635 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ExceptionCriteriaAccess.md @@ -0,0 +1,142 @@ +--- +id: exception-criteria-access +title: ExceptionCriteriaAccess +pagination_label: ExceptionCriteriaAccess +sidebar_label: ExceptionCriteriaAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExceptionCriteriaAccess', 'ExceptionCriteriaAccess'] +slug: /tools/sdk/go/v3/models/exception-criteria-access +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaAccess', 'ExceptionCriteriaAccess'] +--- + +# ExceptionCriteriaAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] +**Existing** | Pointer to **bool** | Whether the subject identity already had that access or not | [optional] [default to false] + +## Methods + +### NewExceptionCriteriaAccess + +`func NewExceptionCriteriaAccess() *ExceptionCriteriaAccess` + +NewExceptionCriteriaAccess instantiates a new ExceptionCriteriaAccess 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 + +### NewExceptionCriteriaAccessWithDefaults + +`func NewExceptionCriteriaAccessWithDefaults() *ExceptionCriteriaAccess` + +NewExceptionCriteriaAccessWithDefaults instantiates a new ExceptionCriteriaAccess 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 + +### GetType + +`func (o *ExceptionCriteriaAccess) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ExceptionCriteriaAccess) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ExceptionCriteriaAccess) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ExceptionCriteriaAccess) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ExceptionCriteriaAccess) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ExceptionCriteriaAccess) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ExceptionCriteriaAccess) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ExceptionCriteriaAccess) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ExceptionCriteriaAccess) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ExceptionCriteriaAccess) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ExceptionCriteriaAccess) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ExceptionCriteriaAccess) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetExisting + +`func (o *ExceptionCriteriaAccess) GetExisting() bool` + +GetExisting returns the Existing field if non-nil, zero value otherwise. + +### GetExistingOk + +`func (o *ExceptionCriteriaAccess) GetExistingOk() (*bool, bool)` + +GetExistingOk returns a tuple with the Existing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExisting + +`func (o *ExceptionCriteriaAccess) SetExisting(v bool)` + +SetExisting sets Existing field to given value. + +### HasExisting + +`func (o *ExceptionCriteriaAccess) HasExisting() bool` + +HasExisting returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ExceptionCriteriaCriteriaListInner.md b/docs/tools/sdk/go/Reference/V3/Models/ExceptionCriteriaCriteriaListInner.md new file mode 100644 index 000000000..4ba760db5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ExceptionCriteriaCriteriaListInner.md @@ -0,0 +1,142 @@ +--- +id: exception-criteria-criteria-list-inner +title: ExceptionCriteriaCriteriaListInner +pagination_label: ExceptionCriteriaCriteriaListInner +sidebar_label: ExceptionCriteriaCriteriaListInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExceptionCriteriaCriteriaListInner', 'ExceptionCriteriaCriteriaListInner'] +slug: /tools/sdk/go/v3/models/exception-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaCriteriaListInner', 'ExceptionCriteriaCriteriaListInner'] +--- + +# ExceptionCriteriaCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **map[string]interface{}** | The type of object that is referenced | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] +**Existing** | Pointer to **bool** | Whether the subject identity already had that access or not | [optional] [default to false] + +## Methods + +### NewExceptionCriteriaCriteriaListInner + +`func NewExceptionCriteriaCriteriaListInner() *ExceptionCriteriaCriteriaListInner` + +NewExceptionCriteriaCriteriaListInner instantiates a new ExceptionCriteriaCriteriaListInner 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 + +### NewExceptionCriteriaCriteriaListInnerWithDefaults + +`func NewExceptionCriteriaCriteriaListInnerWithDefaults() *ExceptionCriteriaCriteriaListInner` + +NewExceptionCriteriaCriteriaListInnerWithDefaults instantiates a new ExceptionCriteriaCriteriaListInner 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 + +### GetType + +`func (o *ExceptionCriteriaCriteriaListInner) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ExceptionCriteriaCriteriaListInner) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ExceptionCriteriaCriteriaListInner) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + +### HasType + +`func (o *ExceptionCriteriaCriteriaListInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ExceptionCriteriaCriteriaListInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ExceptionCriteriaCriteriaListInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ExceptionCriteriaCriteriaListInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ExceptionCriteriaCriteriaListInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ExceptionCriteriaCriteriaListInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ExceptionCriteriaCriteriaListInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ExceptionCriteriaCriteriaListInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ExceptionCriteriaCriteriaListInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetExisting + +`func (o *ExceptionCriteriaCriteriaListInner) GetExisting() bool` + +GetExisting returns the Existing field if non-nil, zero value otherwise. + +### GetExistingOk + +`func (o *ExceptionCriteriaCriteriaListInner) GetExistingOk() (*bool, bool)` + +GetExistingOk returns a tuple with the Existing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExisting + +`func (o *ExceptionCriteriaCriteriaListInner) SetExisting(v bool)` + +SetExisting sets Existing field to given value. + +### HasExisting + +`func (o *ExceptionCriteriaCriteriaListInner) HasExisting() bool` + +HasExisting returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ExecutionStatus.md b/docs/tools/sdk/go/Reference/V3/Models/ExecutionStatus.md new file mode 100644 index 000000000..f54d17911 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ExecutionStatus.md @@ -0,0 +1,25 @@ +--- +id: execution-status +title: ExecutionStatus +pagination_label: ExecutionStatus +sidebar_label: ExecutionStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExecutionStatus', 'ExecutionStatus'] +slug: /tools/sdk/go/v3/models/execution-status +tags: ['SDK', 'Software Development Kit', 'ExecutionStatus', 'ExecutionStatus'] +--- + +# ExecutionStatus + +## Enum + + +* `EXECUTING` (value: `"EXECUTING"`) + +* `VERIFYING` (value: `"VERIFYING"`) + +* `TERMINATED` (value: `"TERMINATED"`) + +* `COMPLETED` (value: `"COMPLETED"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ExpansionItem.md b/docs/tools/sdk/go/Reference/V3/Models/ExpansionItem.md new file mode 100644 index 000000000..cea3d4ea2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ExpansionItem.md @@ -0,0 +1,220 @@ +--- +id: expansion-item +title: ExpansionItem +pagination_label: ExpansionItem +sidebar_label: ExpansionItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExpansionItem', 'ExpansionItem'] +slug: /tools/sdk/go/v3/models/expansion-item +tags: ['SDK', 'Software Development Kit', 'ExpansionItem', 'ExpansionItem'] +--- + +# ExpansionItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **string** | The ID of the account | [optional] +**Cause** | Pointer to **string** | Cause of the expansion item. | [optional] +**Name** | Pointer to **string** | The name of the item | [optional] +**AttributeRequest** | Pointer to [**AttributeRequest**](attribute-request) | | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] +**Id** | Pointer to **string** | ID of the expansion item | [optional] +**State** | Pointer to **string** | State of the expansion item | [optional] + +## Methods + +### NewExpansionItem + +`func NewExpansionItem() *ExpansionItem` + +NewExpansionItem instantiates a new ExpansionItem 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 + +### NewExpansionItemWithDefaults + +`func NewExpansionItemWithDefaults() *ExpansionItem` + +NewExpansionItemWithDefaults instantiates a new ExpansionItem 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 + +### GetAccountId + +`func (o *ExpansionItem) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *ExpansionItem) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *ExpansionItem) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *ExpansionItem) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetCause + +`func (o *ExpansionItem) GetCause() string` + +GetCause returns the Cause field if non-nil, zero value otherwise. + +### GetCauseOk + +`func (o *ExpansionItem) GetCauseOk() (*string, bool)` + +GetCauseOk returns a tuple with the Cause field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCause + +`func (o *ExpansionItem) SetCause(v string)` + +SetCause sets Cause field to given value. + +### HasCause + +`func (o *ExpansionItem) HasCause() bool` + +HasCause returns a boolean if a field has been set. + +### GetName + +`func (o *ExpansionItem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ExpansionItem) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ExpansionItem) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ExpansionItem) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAttributeRequest + +`func (o *ExpansionItem) GetAttributeRequest() AttributeRequest` + +GetAttributeRequest returns the AttributeRequest field if non-nil, zero value otherwise. + +### GetAttributeRequestOk + +`func (o *ExpansionItem) GetAttributeRequestOk() (*AttributeRequest, bool)` + +GetAttributeRequestOk returns a tuple with the AttributeRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeRequest + +`func (o *ExpansionItem) SetAttributeRequest(v AttributeRequest)` + +SetAttributeRequest sets AttributeRequest field to given value. + +### HasAttributeRequest + +`func (o *ExpansionItem) HasAttributeRequest() bool` + +HasAttributeRequest returns a boolean if a field has been set. + +### GetSource + +`func (o *ExpansionItem) GetSource() AccountSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *ExpansionItem) GetSourceOk() (*AccountSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *ExpansionItem) SetSource(v AccountSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *ExpansionItem) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetId + +`func (o *ExpansionItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ExpansionItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ExpansionItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ExpansionItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetState + +`func (o *ExpansionItem) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *ExpansionItem) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *ExpansionItem) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *ExpansionItem) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Expression.md b/docs/tools/sdk/go/Reference/V3/Models/Expression.md new file mode 100644 index 000000000..a28071d07 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Expression.md @@ -0,0 +1,172 @@ +--- +id: expression +title: Expression +pagination_label: Expression +sidebar_label: Expression +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Expression', 'Expression'] +slug: /tools/sdk/go/v3/models/expression +tags: ['SDK', 'Software Development Kit', 'Expression', 'Expression'] +--- + +# Expression + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **string** | Operator for the expression | [optional] +**Attribute** | Pointer to **NullableString** | Name for the attribute | [optional] +**Value** | Pointer to [**NullableValue**](value) | | [optional] +**Children** | Pointer to [**[]ExpressionChildrenInner**](expression-children-inner) | List of expressions | [optional] + +## Methods + +### NewExpression + +`func NewExpression() *Expression` + +NewExpression instantiates a new Expression 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 + +### NewExpressionWithDefaults + +`func NewExpressionWithDefaults() *Expression` + +NewExpressionWithDefaults instantiates a new Expression 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 + +### GetOperator + +`func (o *Expression) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *Expression) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *Expression) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *Expression) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetAttribute + +`func (o *Expression) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *Expression) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *Expression) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *Expression) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *Expression) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *Expression) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *Expression) GetValue() Value` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Expression) GetValueOk() (*Value, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Expression) SetValue(v Value)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Expression) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *Expression) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *Expression) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *Expression) GetChildren() []ExpressionChildrenInner` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *Expression) GetChildrenOk() (*[]ExpressionChildrenInner, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *Expression) SetChildren(v []ExpressionChildrenInner)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *Expression) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *Expression) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *Expression) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ExpressionChildrenInner.md b/docs/tools/sdk/go/Reference/V3/Models/ExpressionChildrenInner.md new file mode 100644 index 000000000..117cd9b36 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ExpressionChildrenInner.md @@ -0,0 +1,172 @@ +--- +id: expression-children-inner +title: ExpressionChildrenInner +pagination_label: ExpressionChildrenInner +sidebar_label: ExpressionChildrenInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ExpressionChildrenInner', 'ExpressionChildrenInner'] +slug: /tools/sdk/go/v3/models/expression-children-inner +tags: ['SDK', 'Software Development Kit', 'ExpressionChildrenInner', 'ExpressionChildrenInner'] +--- + +# ExpressionChildrenInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **string** | Operator for the expression | [optional] +**Attribute** | Pointer to **NullableString** | Name for the attribute | [optional] +**Value** | Pointer to [**NullableValue**](value) | | [optional] +**Children** | Pointer to **NullableString** | There cannot be anymore nested children. This will always be null. | [optional] + +## Methods + +### NewExpressionChildrenInner + +`func NewExpressionChildrenInner() *ExpressionChildrenInner` + +NewExpressionChildrenInner instantiates a new ExpressionChildrenInner 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 + +### NewExpressionChildrenInnerWithDefaults + +`func NewExpressionChildrenInnerWithDefaults() *ExpressionChildrenInner` + +NewExpressionChildrenInnerWithDefaults instantiates a new ExpressionChildrenInner 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 + +### GetOperator + +`func (o *ExpressionChildrenInner) GetOperator() string` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *ExpressionChildrenInner) GetOperatorOk() (*string, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *ExpressionChildrenInner) SetOperator(v string)` + +SetOperator sets Operator field to given value. + +### HasOperator + +`func (o *ExpressionChildrenInner) HasOperator() bool` + +HasOperator returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ExpressionChildrenInner) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ExpressionChildrenInner) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ExpressionChildrenInner) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ExpressionChildrenInner) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *ExpressionChildrenInner) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *ExpressionChildrenInner) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *ExpressionChildrenInner) GetValue() Value` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ExpressionChildrenInner) GetValueOk() (*Value, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ExpressionChildrenInner) SetValue(v Value)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ExpressionChildrenInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ExpressionChildrenInner) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ExpressionChildrenInner) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *ExpressionChildrenInner) GetChildren() string` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *ExpressionChildrenInner) GetChildrenOk() (*string, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *ExpressionChildrenInner) SetChildren(v string)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *ExpressionChildrenInner) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *ExpressionChildrenInner) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *ExpressionChildrenInner) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/FederationProtocolDetails.md b/docs/tools/sdk/go/Reference/V3/Models/FederationProtocolDetails.md new file mode 100644 index 000000000..6af0f8629 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/FederationProtocolDetails.md @@ -0,0 +1,90 @@ +--- +id: federation-protocol-details +title: FederationProtocolDetails +pagination_label: FederationProtocolDetails +sidebar_label: FederationProtocolDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FederationProtocolDetails', 'FederationProtocolDetails'] +slug: /tools/sdk/go/v3/models/federation-protocol-details +tags: ['SDK', 'Software Development Kit', 'FederationProtocolDetails', 'FederationProtocolDetails'] +--- + +# FederationProtocolDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | Pointer to **string** | Federation protocol role | [optional] +**EntityId** | Pointer to **string** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] + +## Methods + +### NewFederationProtocolDetails + +`func NewFederationProtocolDetails() *FederationProtocolDetails` + +NewFederationProtocolDetails instantiates a new FederationProtocolDetails 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 + +### NewFederationProtocolDetailsWithDefaults + +`func NewFederationProtocolDetailsWithDefaults() *FederationProtocolDetails` + +NewFederationProtocolDetailsWithDefaults instantiates a new FederationProtocolDetails 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 + +### GetRole + +`func (o *FederationProtocolDetails) GetRole() string` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *FederationProtocolDetails) GetRoleOk() (*string, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *FederationProtocolDetails) SetRole(v string)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *FederationProtocolDetails) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetEntityId + +`func (o *FederationProtocolDetails) GetEntityId() string` + +GetEntityId returns the EntityId field if non-nil, zero value otherwise. + +### GetEntityIdOk + +`func (o *FederationProtocolDetails) GetEntityIdOk() (*string, bool)` + +GetEntityIdOk returns a tuple with the EntityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntityId + +`func (o *FederationProtocolDetails) SetEntityId(v string)` + +SetEntityId sets EntityId field to given value. + +### HasEntityId + +`func (o *FederationProtocolDetails) HasEntityId() bool` + +HasEntityId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/FieldDetailsDto.md b/docs/tools/sdk/go/Reference/V3/Models/FieldDetailsDto.md new file mode 100644 index 000000000..27c3b3f80 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/FieldDetailsDto.md @@ -0,0 +1,194 @@ +--- +id: field-details-dto +title: FieldDetailsDto +pagination_label: FieldDetailsDto +sidebar_label: FieldDetailsDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FieldDetailsDto', 'FieldDetailsDto'] +slug: /tools/sdk/go/v3/models/field-details-dto +tags: ['SDK', 'Software Development Kit', 'FieldDetailsDto', 'FieldDetailsDto'] +--- + +# FieldDetailsDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the attribute. | [optional] +**Transform** | Pointer to **map[string]interface{}** | The transform to apply to the field | [optional] [default to {}] +**Attributes** | Pointer to **map[string]interface{}** | Attributes required for the transform | [optional] +**IsRequired** | Pointer to **bool** | Flag indicating whether or not the attribute is required. | [optional] [readonly] [default to false] +**Type** | Pointer to **string** | The type of the attribute. | [optional] +**IsMultiValued** | Pointer to **bool** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to false] + +## Methods + +### NewFieldDetailsDto + +`func NewFieldDetailsDto() *FieldDetailsDto` + +NewFieldDetailsDto instantiates a new FieldDetailsDto 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 + +### NewFieldDetailsDtoWithDefaults + +`func NewFieldDetailsDtoWithDefaults() *FieldDetailsDto` + +NewFieldDetailsDtoWithDefaults instantiates a new FieldDetailsDto 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 + +### GetName + +`func (o *FieldDetailsDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FieldDetailsDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FieldDetailsDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FieldDetailsDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetTransform + +`func (o *FieldDetailsDto) GetTransform() map[string]interface{}` + +GetTransform returns the Transform field if non-nil, zero value otherwise. + +### GetTransformOk + +`func (o *FieldDetailsDto) GetTransformOk() (*map[string]interface{}, bool)` + +GetTransformOk returns a tuple with the Transform field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTransform + +`func (o *FieldDetailsDto) SetTransform(v map[string]interface{})` + +SetTransform sets Transform field to given value. + +### HasTransform + +`func (o *FieldDetailsDto) HasTransform() bool` + +HasTransform returns a boolean if a field has been set. + +### GetAttributes + +`func (o *FieldDetailsDto) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *FieldDetailsDto) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *FieldDetailsDto) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *FieldDetailsDto) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetIsRequired + +`func (o *FieldDetailsDto) GetIsRequired() bool` + +GetIsRequired returns the IsRequired field if non-nil, zero value otherwise. + +### GetIsRequiredOk + +`func (o *FieldDetailsDto) GetIsRequiredOk() (*bool, bool)` + +GetIsRequiredOk returns a tuple with the IsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsRequired + +`func (o *FieldDetailsDto) SetIsRequired(v bool)` + +SetIsRequired sets IsRequired field to given value. + +### HasIsRequired + +`func (o *FieldDetailsDto) HasIsRequired() bool` + +HasIsRequired returns a boolean if a field has been set. + +### GetType + +`func (o *FieldDetailsDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FieldDetailsDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FieldDetailsDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FieldDetailsDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetIsMultiValued + +`func (o *FieldDetailsDto) GetIsMultiValued() bool` + +GetIsMultiValued returns the IsMultiValued field if non-nil, zero value otherwise. + +### GetIsMultiValuedOk + +`func (o *FieldDetailsDto) GetIsMultiValuedOk() (*bool, bool)` + +GetIsMultiValuedOk returns a tuple with the IsMultiValued field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsMultiValued + +`func (o *FieldDetailsDto) SetIsMultiValued(v bool)` + +SetIsMultiValued sets IsMultiValued field to given value. + +### HasIsMultiValued + +`func (o *FieldDetailsDto) HasIsMultiValued() bool` + +HasIsMultiValued returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Filter.md b/docs/tools/sdk/go/Reference/V3/Models/Filter.md new file mode 100644 index 000000000..ea7f91001 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Filter.md @@ -0,0 +1,142 @@ +--- +id: filter +title: Filter +pagination_label: Filter +sidebar_label: Filter +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Filter', 'Filter'] +slug: /tools/sdk/go/v3/models/filter +tags: ['SDK', 'Software Development Kit', 'Filter', 'Filter'] +--- + +# Filter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**FilterType**](filter-type) | | [optional] +**Range** | Pointer to [**Range**](range) | | [optional] +**Terms** | Pointer to **[]string** | The terms to be filtered. | [optional] +**Exclude** | Pointer to **bool** | Indicates if the filter excludes results. | [optional] [default to false] + +## Methods + +### NewFilter + +`func NewFilter() *Filter` + +NewFilter instantiates a new Filter 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 + +### NewFilterWithDefaults + +`func NewFilterWithDefaults() *Filter` + +NewFilterWithDefaults instantiates a new Filter 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 + +### GetType + +`func (o *Filter) GetType() FilterType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Filter) GetTypeOk() (*FilterType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Filter) SetType(v FilterType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Filter) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRange + +`func (o *Filter) GetRange() Range` + +GetRange returns the Range field if non-nil, zero value otherwise. + +### GetRangeOk + +`func (o *Filter) GetRangeOk() (*Range, bool)` + +GetRangeOk returns a tuple with the Range field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRange + +`func (o *Filter) SetRange(v Range)` + +SetRange sets Range field to given value. + +### HasRange + +`func (o *Filter) HasRange() bool` + +HasRange returns a boolean if a field has been set. + +### GetTerms + +`func (o *Filter) GetTerms() []string` + +GetTerms returns the Terms field if non-nil, zero value otherwise. + +### GetTermsOk + +`func (o *Filter) GetTermsOk() (*[]string, bool)` + +GetTermsOk returns a tuple with the Terms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerms + +`func (o *Filter) SetTerms(v []string)` + +SetTerms sets Terms field to given value. + +### HasTerms + +`func (o *Filter) HasTerms() bool` + +HasTerms returns a boolean if a field has been set. + +### GetExclude + +`func (o *Filter) GetExclude() bool` + +GetExclude returns the Exclude field if non-nil, zero value otherwise. + +### GetExcludeOk + +`func (o *Filter) GetExcludeOk() (*bool, bool)` + +GetExcludeOk returns a tuple with the Exclude field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExclude + +`func (o *Filter) SetExclude(v bool)` + +SetExclude sets Exclude field to given value. + +### HasExclude + +`func (o *Filter) HasExclude() bool` + +HasExclude returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/FilterAggregation.md b/docs/tools/sdk/go/Reference/V3/Models/FilterAggregation.md new file mode 100644 index 000000000..07ffc6a67 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/FilterAggregation.md @@ -0,0 +1,127 @@ +--- +id: filter-aggregation +title: FilterAggregation +pagination_label: FilterAggregation +sidebar_label: FilterAggregation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FilterAggregation', 'FilterAggregation'] +slug: /tools/sdk/go/v3/models/filter-aggregation +tags: ['SDK', 'Software Development Kit', 'FilterAggregation', 'FilterAggregation'] +--- + +# FilterAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the filter aggregate to be included in the result. | +**Type** | Pointer to [**SearchFilterType**](search-filter-type) | | [optional] [default to SEARCHFILTERTYPE_TERM] +**Field** | **string** | The search field to apply the filter to. Prefix the field name with '@' to reference a nested object. | +**Value** | **string** | The value to filter on. | + +## Methods + +### NewFilterAggregation + +`func NewFilterAggregation(name string, field string, value string, ) *FilterAggregation` + +NewFilterAggregation instantiates a new FilterAggregation 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 + +### NewFilterAggregationWithDefaults + +`func NewFilterAggregationWithDefaults() *FilterAggregation` + +NewFilterAggregationWithDefaults instantiates a new FilterAggregation 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 + +### GetName + +`func (o *FilterAggregation) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FilterAggregation) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FilterAggregation) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *FilterAggregation) GetType() SearchFilterType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FilterAggregation) GetTypeOk() (*SearchFilterType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *FilterAggregation) SetType(v SearchFilterType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *FilterAggregation) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetField + +`func (o *FilterAggregation) GetField() string` + +GetField returns the Field field if non-nil, zero value otherwise. + +### GetFieldOk + +`func (o *FilterAggregation) GetFieldOk() (*string, bool)` + +GetFieldOk returns a tuple with the Field field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetField + +`func (o *FilterAggregation) SetField(v string)` + +SetField sets Field field to given value. + + +### GetValue + +`func (o *FilterAggregation) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *FilterAggregation) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *FilterAggregation) SetValue(v string)` + +SetValue sets Value field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/FilterType.md b/docs/tools/sdk/go/Reference/V3/Models/FilterType.md new file mode 100644 index 000000000..45d6bb6a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/FilterType.md @@ -0,0 +1,23 @@ +--- +id: filter-type +title: FilterType +pagination_label: FilterType +sidebar_label: FilterType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FilterType', 'FilterType'] +slug: /tools/sdk/go/v3/models/filter-type +tags: ['SDK', 'Software Development Kit', 'FilterType', 'FilterType'] +--- + +# FilterType + +## Enum + + +* `EXISTS` (value: `"EXISTS"`) + +* `RANGE` (value: `"RANGE"`) + +* `TERMS` (value: `"TERMS"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/FormDetails.md b/docs/tools/sdk/go/Reference/V3/Models/FormDetails.md new file mode 100644 index 000000000..59f9afbc9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/FormDetails.md @@ -0,0 +1,214 @@ +--- +id: form-details +title: FormDetails +pagination_label: FormDetails +sidebar_label: FormDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormDetails', 'FormDetails'] +slug: /tools/sdk/go/v3/models/form-details +tags: ['SDK', 'Software Development Kit', 'FormDetails', 'FormDetails'] +--- + +# FormDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | ID of the form | [optional] +**Name** | Pointer to **NullableString** | Name of the form | [optional] +**Title** | Pointer to **string** | The form title | [optional] +**Subtitle** | Pointer to **string** | The form subtitle. | [optional] +**TargetUser** | Pointer to **string** | The name of the user that should be shown this form | [optional] +**Sections** | Pointer to [**[]SectionDetails**](section-details) | Sections of the form | [optional] + +## Methods + +### NewFormDetails + +`func NewFormDetails() *FormDetails` + +NewFormDetails instantiates a new FormDetails 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 + +### NewFormDetailsWithDefaults + +`func NewFormDetailsWithDefaults() *FormDetails` + +NewFormDetailsWithDefaults instantiates a new FormDetails 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 + +### GetId + +`func (o *FormDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FormDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FormDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FormDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *FormDetails) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *FormDetails) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *FormDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *FormDetails) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *FormDetails) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetTitle + +`func (o *FormDetails) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *FormDetails) GetTitleOk() (*string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTitle + +`func (o *FormDetails) SetTitle(v string)` + +SetTitle sets Title field to given value. + +### HasTitle + +`func (o *FormDetails) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### GetSubtitle + +`func (o *FormDetails) GetSubtitle() string` + +GetSubtitle returns the Subtitle field if non-nil, zero value otherwise. + +### GetSubtitleOk + +`func (o *FormDetails) GetSubtitleOk() (*string, bool)` + +GetSubtitleOk returns a tuple with the Subtitle field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubtitle + +`func (o *FormDetails) SetSubtitle(v string)` + +SetSubtitle sets Subtitle field to given value. + +### HasSubtitle + +`func (o *FormDetails) HasSubtitle() bool` + +HasSubtitle returns a boolean if a field has been set. + +### GetTargetUser + +`func (o *FormDetails) GetTargetUser() string` + +GetTargetUser returns the TargetUser field if non-nil, zero value otherwise. + +### GetTargetUserOk + +`func (o *FormDetails) GetTargetUserOk() (*string, bool)` + +GetTargetUserOk returns a tuple with the TargetUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetUser + +`func (o *FormDetails) SetTargetUser(v string)` + +SetTargetUser sets TargetUser field to given value. + +### HasTargetUser + +`func (o *FormDetails) HasTargetUser() bool` + +HasTargetUser returns a boolean if a field has been set. + +### GetSections + +`func (o *FormDetails) GetSections() []SectionDetails` + +GetSections returns the Sections field if non-nil, zero value otherwise. + +### GetSectionsOk + +`func (o *FormDetails) GetSectionsOk() (*[]SectionDetails, bool)` + +GetSectionsOk returns a tuple with the Sections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSections + +`func (o *FormDetails) SetSections(v []SectionDetails)` + +SetSections sets Sections field to given value. + +### HasSections + +`func (o *FormDetails) HasSections() bool` + +HasSections returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/FormItemDetails.md b/docs/tools/sdk/go/Reference/V3/Models/FormItemDetails.md new file mode 100644 index 000000000..6af04823e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/FormItemDetails.md @@ -0,0 +1,64 @@ +--- +id: form-item-details +title: FormItemDetails +pagination_label: FormItemDetails +sidebar_label: FormItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FormItemDetails', 'FormItemDetails'] +slug: /tools/sdk/go/v3/models/form-item-details +tags: ['SDK', 'Software Development Kit', 'FormItemDetails', 'FormItemDetails'] +--- + +# FormItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the FormItem | [optional] + +## Methods + +### NewFormItemDetails + +`func NewFormItemDetails() *FormItemDetails` + +NewFormItemDetails instantiates a new FormItemDetails 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 + +### NewFormItemDetailsWithDefaults + +`func NewFormItemDetailsWithDefaults() *FormItemDetails` + +NewFormItemDetailsWithDefaults instantiates a new FormItemDetails 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 + +### GetName + +`func (o *FormItemDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FormItemDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FormItemDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FormItemDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ForwardApprovalDto.md b/docs/tools/sdk/go/Reference/V3/Models/ForwardApprovalDto.md new file mode 100644 index 000000000..113701e3e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ForwardApprovalDto.md @@ -0,0 +1,80 @@ +--- +id: forward-approval-dto +title: ForwardApprovalDto +pagination_label: ForwardApprovalDto +sidebar_label: ForwardApprovalDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ForwardApprovalDto', 'ForwardApprovalDto'] +slug: /tools/sdk/go/v3/models/forward-approval-dto +tags: ['SDK', 'Software Development Kit', 'ForwardApprovalDto', 'ForwardApprovalDto'] +--- + +# ForwardApprovalDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewOwnerId** | **string** | The Id of the new owner | +**Comment** | **string** | The comment provided by the forwarder | + +## Methods + +### NewForwardApprovalDto + +`func NewForwardApprovalDto(newOwnerId string, comment string, ) *ForwardApprovalDto` + +NewForwardApprovalDto instantiates a new ForwardApprovalDto 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 + +### NewForwardApprovalDtoWithDefaults + +`func NewForwardApprovalDtoWithDefaults() *ForwardApprovalDto` + +NewForwardApprovalDtoWithDefaults instantiates a new ForwardApprovalDto 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 + +### GetNewOwnerId + +`func (o *ForwardApprovalDto) GetNewOwnerId() string` + +GetNewOwnerId returns the NewOwnerId field if non-nil, zero value otherwise. + +### GetNewOwnerIdOk + +`func (o *ForwardApprovalDto) GetNewOwnerIdOk() (*string, bool)` + +GetNewOwnerIdOk returns a tuple with the NewOwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewOwnerId + +`func (o *ForwardApprovalDto) SetNewOwnerId(v string)` + +SetNewOwnerId sets NewOwnerId field to given value. + + +### GetComment + +`func (o *ForwardApprovalDto) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *ForwardApprovalDto) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *ForwardApprovalDto) SetComment(v string)` + +SetComment sets Comment field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/FullDiscoveredApplications.md b/docs/tools/sdk/go/Reference/V3/Models/FullDiscoveredApplications.md new file mode 100644 index 000000000..3d1933fda --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/FullDiscoveredApplications.md @@ -0,0 +1,298 @@ +--- +id: full-discovered-applications +title: FullDiscoveredApplications +pagination_label: FullDiscoveredApplications +sidebar_label: FullDiscoveredApplications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'FullDiscoveredApplications', 'FullDiscoveredApplications'] +slug: /tools/sdk/go/v3/models/full-discovered-applications +tags: ['SDK', 'Software Development Kit', 'FullDiscoveredApplications', 'FullDiscoveredApplications'] +--- + +# FullDiscoveredApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **string** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **string** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **string** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **string** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]string** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **SailPointTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **string** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [optional] +**AssociatedSources** | Pointer to **[]string** | List of associated sources related to this discovered application. | [optional] + +## Methods + +### NewFullDiscoveredApplications + +`func NewFullDiscoveredApplications() *FullDiscoveredApplications` + +NewFullDiscoveredApplications instantiates a new FullDiscoveredApplications 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 + +### NewFullDiscoveredApplicationsWithDefaults + +`func NewFullDiscoveredApplicationsWithDefaults() *FullDiscoveredApplications` + +NewFullDiscoveredApplicationsWithDefaults instantiates a new FullDiscoveredApplications 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 + +### GetId + +`func (o *FullDiscoveredApplications) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FullDiscoveredApplications) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FullDiscoveredApplications) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FullDiscoveredApplications) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FullDiscoveredApplications) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FullDiscoveredApplications) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FullDiscoveredApplications) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FullDiscoveredApplications) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDiscoverySource + +`func (o *FullDiscoveredApplications) GetDiscoverySource() string` + +GetDiscoverySource returns the DiscoverySource field if non-nil, zero value otherwise. + +### GetDiscoverySourceOk + +`func (o *FullDiscoveredApplications) GetDiscoverySourceOk() (*string, bool)` + +GetDiscoverySourceOk returns a tuple with the DiscoverySource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoverySource + +`func (o *FullDiscoveredApplications) SetDiscoverySource(v string)` + +SetDiscoverySource sets DiscoverySource field to given value. + +### HasDiscoverySource + +`func (o *FullDiscoveredApplications) HasDiscoverySource() bool` + +HasDiscoverySource returns a boolean if a field has been set. + +### GetDiscoveredVendor + +`func (o *FullDiscoveredApplications) GetDiscoveredVendor() string` + +GetDiscoveredVendor returns the DiscoveredVendor field if non-nil, zero value otherwise. + +### GetDiscoveredVendorOk + +`func (o *FullDiscoveredApplications) GetDiscoveredVendorOk() (*string, bool)` + +GetDiscoveredVendorOk returns a tuple with the DiscoveredVendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredVendor + +`func (o *FullDiscoveredApplications) SetDiscoveredVendor(v string)` + +SetDiscoveredVendor sets DiscoveredVendor field to given value. + +### HasDiscoveredVendor + +`func (o *FullDiscoveredApplications) HasDiscoveredVendor() bool` + +HasDiscoveredVendor returns a boolean if a field has been set. + +### GetDescription + +`func (o *FullDiscoveredApplications) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *FullDiscoveredApplications) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *FullDiscoveredApplications) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *FullDiscoveredApplications) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetRecommendedConnectors + +`func (o *FullDiscoveredApplications) GetRecommendedConnectors() []string` + +GetRecommendedConnectors returns the RecommendedConnectors field if non-nil, zero value otherwise. + +### GetRecommendedConnectorsOk + +`func (o *FullDiscoveredApplications) GetRecommendedConnectorsOk() (*[]string, bool)` + +GetRecommendedConnectorsOk returns a tuple with the RecommendedConnectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendedConnectors + +`func (o *FullDiscoveredApplications) SetRecommendedConnectors(v []string)` + +SetRecommendedConnectors sets RecommendedConnectors field to given value. + +### HasRecommendedConnectors + +`func (o *FullDiscoveredApplications) HasRecommendedConnectors() bool` + +HasRecommendedConnectors returns a boolean if a field has been set. + +### GetDiscoveredAt + +`func (o *FullDiscoveredApplications) GetDiscoveredAt() SailPointTime` + +GetDiscoveredAt returns the DiscoveredAt field if non-nil, zero value otherwise. + +### GetDiscoveredAtOk + +`func (o *FullDiscoveredApplications) GetDiscoveredAtOk() (*SailPointTime, bool)` + +GetDiscoveredAtOk returns a tuple with the DiscoveredAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredAt + +`func (o *FullDiscoveredApplications) SetDiscoveredAt(v SailPointTime)` + +SetDiscoveredAt sets DiscoveredAt field to given value. + +### HasDiscoveredAt + +`func (o *FullDiscoveredApplications) HasDiscoveredAt() bool` + +HasDiscoveredAt returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *FullDiscoveredApplications) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *FullDiscoveredApplications) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *FullDiscoveredApplications) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *FullDiscoveredApplications) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetStatus + +`func (o *FullDiscoveredApplications) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *FullDiscoveredApplications) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *FullDiscoveredApplications) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *FullDiscoveredApplications) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetAssociatedSources + +`func (o *FullDiscoveredApplications) GetAssociatedSources() []string` + +GetAssociatedSources returns the AssociatedSources field if non-nil, zero value otherwise. + +### GetAssociatedSourcesOk + +`func (o *FullDiscoveredApplications) GetAssociatedSourcesOk() (*[]string, bool)` + +GetAssociatedSourcesOk returns a tuple with the AssociatedSources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociatedSources + +`func (o *FullDiscoveredApplications) SetAssociatedSources(v []string)` + +SetAssociatedSources sets AssociatedSources field to given value. + +### HasAssociatedSources + +`func (o *FullDiscoveredApplications) HasAssociatedSources() bool` + +HasAssociatedSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/GetActiveCampaigns200ResponseInner.md b/docs/tools/sdk/go/Reference/V3/Models/GetActiveCampaigns200ResponseInner.md new file mode 100644 index 000000000..9c05294e4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/GetActiveCampaigns200ResponseInner.md @@ -0,0 +1,631 @@ +--- +id: get-active-campaigns200-response-inner +title: GetActiveCampaigns200ResponseInner +pagination_label: GetActiveCampaigns200ResponseInner +sidebar_label: GetActiveCampaigns200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetActiveCampaigns200ResponseInner', 'GetActiveCampaigns200ResponseInner'] +slug: /tools/sdk/go/v3/models/get-active-campaigns200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetActiveCampaigns200ResponseInner', 'GetActiveCampaigns200ResponseInner'] +--- + +# GetActiveCampaigns200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the campaign | [optional] [readonly] +**Name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Description** | **NullableString** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Deadline** | Pointer to **SailPointTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **string** | The type of campaign. Could be extended in the future. | +**EmailNotificationEnabled** | Pointer to **bool** | Enables email notification for this campaign | [optional] [default to false] +**AutoRevokeAllowed** | Pointer to **bool** | Allows auto revoke for this campaign | [optional] [default to false] +**RecommendationsEnabled** | Pointer to **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to false] +**Status** | Pointer to **string** | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **SailPointTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Modified time of the campaign | [optional] [readonly] +**Filter** | Pointer to [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **bool** | Determines if comments on sunset date changes are required. | [optional] [default to true] +**SourceOwnerCampaignInfo** | Pointer to [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Methods + +### NewGetActiveCampaigns200ResponseInner + +`func NewGetActiveCampaigns200ResponseInner(name string, description NullableString, type_ string, ) *GetActiveCampaigns200ResponseInner` + +NewGetActiveCampaigns200ResponseInner instantiates a new GetActiveCampaigns200ResponseInner 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 + +### NewGetActiveCampaigns200ResponseInnerWithDefaults + +`func NewGetActiveCampaigns200ResponseInnerWithDefaults() *GetActiveCampaigns200ResponseInner` + +NewGetActiveCampaigns200ResponseInnerWithDefaults instantiates a new GetActiveCampaigns200ResponseInner 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 + +### GetId + +`func (o *GetActiveCampaigns200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetActiveCampaigns200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetActiveCampaigns200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetActiveCampaigns200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *GetActiveCampaigns200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetActiveCampaigns200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetActiveCampaigns200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *GetActiveCampaigns200ResponseInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *GetActiveCampaigns200ResponseInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *GetActiveCampaigns200ResponseInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *GetActiveCampaigns200ResponseInner) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *GetActiveCampaigns200ResponseInner) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetDeadline + +`func (o *GetActiveCampaigns200ResponseInner) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *GetActiveCampaigns200ResponseInner) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *GetActiveCampaigns200ResponseInner) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *GetActiveCampaigns200ResponseInner) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### GetType + +`func (o *GetActiveCampaigns200ResponseInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *GetActiveCampaigns200ResponseInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *GetActiveCampaigns200ResponseInner) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEmailNotificationEnabled + +`func (o *GetActiveCampaigns200ResponseInner) GetEmailNotificationEnabled() bool` + +GetEmailNotificationEnabled returns the EmailNotificationEnabled field if non-nil, zero value otherwise. + +### GetEmailNotificationEnabledOk + +`func (o *GetActiveCampaigns200ResponseInner) GetEmailNotificationEnabledOk() (*bool, bool)` + +GetEmailNotificationEnabledOk returns a tuple with the EmailNotificationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationEnabled + +`func (o *GetActiveCampaigns200ResponseInner) SetEmailNotificationEnabled(v bool)` + +SetEmailNotificationEnabled sets EmailNotificationEnabled field to given value. + +### HasEmailNotificationEnabled + +`func (o *GetActiveCampaigns200ResponseInner) HasEmailNotificationEnabled() bool` + +HasEmailNotificationEnabled returns a boolean if a field has been set. + +### GetAutoRevokeAllowed + +`func (o *GetActiveCampaigns200ResponseInner) GetAutoRevokeAllowed() bool` + +GetAutoRevokeAllowed returns the AutoRevokeAllowed field if non-nil, zero value otherwise. + +### GetAutoRevokeAllowedOk + +`func (o *GetActiveCampaigns200ResponseInner) GetAutoRevokeAllowedOk() (*bool, bool)` + +GetAutoRevokeAllowedOk returns a tuple with the AutoRevokeAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoRevokeAllowed + +`func (o *GetActiveCampaigns200ResponseInner) SetAutoRevokeAllowed(v bool)` + +SetAutoRevokeAllowed sets AutoRevokeAllowed field to given value. + +### HasAutoRevokeAllowed + +`func (o *GetActiveCampaigns200ResponseInner) HasAutoRevokeAllowed() bool` + +HasAutoRevokeAllowed returns a boolean if a field has been set. + +### GetRecommendationsEnabled + +`func (o *GetActiveCampaigns200ResponseInner) GetRecommendationsEnabled() bool` + +GetRecommendationsEnabled returns the RecommendationsEnabled field if non-nil, zero value otherwise. + +### GetRecommendationsEnabledOk + +`func (o *GetActiveCampaigns200ResponseInner) GetRecommendationsEnabledOk() (*bool, bool)` + +GetRecommendationsEnabledOk returns a tuple with the RecommendationsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendationsEnabled + +`func (o *GetActiveCampaigns200ResponseInner) SetRecommendationsEnabled(v bool)` + +SetRecommendationsEnabled sets RecommendationsEnabled field to given value. + +### HasRecommendationsEnabled + +`func (o *GetActiveCampaigns200ResponseInner) HasRecommendationsEnabled() bool` + +HasRecommendationsEnabled returns a boolean if a field has been set. + +### GetStatus + +`func (o *GetActiveCampaigns200ResponseInner) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GetActiveCampaigns200ResponseInner) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GetActiveCampaigns200ResponseInner) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GetActiveCampaigns200ResponseInner) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetCorrelatedStatus + +`func (o *GetActiveCampaigns200ResponseInner) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *GetActiveCampaigns200ResponseInner) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *GetActiveCampaigns200ResponseInner) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + +### HasCorrelatedStatus + +`func (o *GetActiveCampaigns200ResponseInner) HasCorrelatedStatus() bool` + +HasCorrelatedStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *GetActiveCampaigns200ResponseInner) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GetActiveCampaigns200ResponseInner) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *GetActiveCampaigns200ResponseInner) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *GetActiveCampaigns200ResponseInner) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetTotalCertifications + +`func (o *GetActiveCampaigns200ResponseInner) GetTotalCertifications() int32` + +GetTotalCertifications returns the TotalCertifications field if non-nil, zero value otherwise. + +### GetTotalCertificationsOk + +`func (o *GetActiveCampaigns200ResponseInner) GetTotalCertificationsOk() (*int32, bool)` + +GetTotalCertificationsOk returns a tuple with the TotalCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCertifications + +`func (o *GetActiveCampaigns200ResponseInner) SetTotalCertifications(v int32)` + +SetTotalCertifications sets TotalCertifications field to given value. + +### HasTotalCertifications + +`func (o *GetActiveCampaigns200ResponseInner) HasTotalCertifications() bool` + +HasTotalCertifications returns a boolean if a field has been set. + +### GetCompletedCertifications + +`func (o *GetActiveCampaigns200ResponseInner) GetCompletedCertifications() int32` + +GetCompletedCertifications returns the CompletedCertifications field if non-nil, zero value otherwise. + +### GetCompletedCertificationsOk + +`func (o *GetActiveCampaigns200ResponseInner) GetCompletedCertificationsOk() (*int32, bool)` + +GetCompletedCertificationsOk returns a tuple with the CompletedCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedCertifications + +`func (o *GetActiveCampaigns200ResponseInner) SetCompletedCertifications(v int32)` + +SetCompletedCertifications sets CompletedCertifications field to given value. + +### HasCompletedCertifications + +`func (o *GetActiveCampaigns200ResponseInner) HasCompletedCertifications() bool` + +HasCompletedCertifications returns a boolean if a field has been set. + +### GetAlerts + +`func (o *GetActiveCampaigns200ResponseInner) GetAlerts() []CampaignAlert` + +GetAlerts returns the Alerts field if non-nil, zero value otherwise. + +### GetAlertsOk + +`func (o *GetActiveCampaigns200ResponseInner) GetAlertsOk() (*[]CampaignAlert, bool)` + +GetAlertsOk returns a tuple with the Alerts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlerts + +`func (o *GetActiveCampaigns200ResponseInner) SetAlerts(v []CampaignAlert)` + +SetAlerts sets Alerts field to given value. + +### HasAlerts + +`func (o *GetActiveCampaigns200ResponseInner) HasAlerts() bool` + +HasAlerts returns a boolean if a field has been set. + +### GetModified + +`func (o *GetActiveCampaigns200ResponseInner) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *GetActiveCampaigns200ResponseInner) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *GetActiveCampaigns200ResponseInner) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *GetActiveCampaigns200ResponseInner) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetFilter + +`func (o *GetActiveCampaigns200ResponseInner) GetFilter() CampaignAllOfFilter` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *GetActiveCampaigns200ResponseInner) GetFilterOk() (*CampaignAllOfFilter, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *GetActiveCampaigns200ResponseInner) SetFilter(v CampaignAllOfFilter)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *GetActiveCampaigns200ResponseInner) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### GetSunsetCommentsRequired + +`func (o *GetActiveCampaigns200ResponseInner) GetSunsetCommentsRequired() bool` + +GetSunsetCommentsRequired returns the SunsetCommentsRequired field if non-nil, zero value otherwise. + +### GetSunsetCommentsRequiredOk + +`func (o *GetActiveCampaigns200ResponseInner) GetSunsetCommentsRequiredOk() (*bool, bool)` + +GetSunsetCommentsRequiredOk returns a tuple with the SunsetCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSunsetCommentsRequired + +`func (o *GetActiveCampaigns200ResponseInner) SetSunsetCommentsRequired(v bool)` + +SetSunsetCommentsRequired sets SunsetCommentsRequired field to given value. + +### HasSunsetCommentsRequired + +`func (o *GetActiveCampaigns200ResponseInner) HasSunsetCommentsRequired() bool` + +HasSunsetCommentsRequired returns a boolean if a field has been set. + +### GetSourceOwnerCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) GetSourceOwnerCampaignInfo() CampaignAllOfSourceOwnerCampaignInfo` + +GetSourceOwnerCampaignInfo returns the SourceOwnerCampaignInfo field if non-nil, zero value otherwise. + +### GetSourceOwnerCampaignInfoOk + +`func (o *GetActiveCampaigns200ResponseInner) GetSourceOwnerCampaignInfoOk() (*CampaignAllOfSourceOwnerCampaignInfo, bool)` + +GetSourceOwnerCampaignInfoOk returns a tuple with the SourceOwnerCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceOwnerCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) SetSourceOwnerCampaignInfo(v CampaignAllOfSourceOwnerCampaignInfo)` + +SetSourceOwnerCampaignInfo sets SourceOwnerCampaignInfo field to given value. + +### HasSourceOwnerCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) HasSourceOwnerCampaignInfo() bool` + +HasSourceOwnerCampaignInfo returns a boolean if a field has been set. + +### GetSearchCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) GetSearchCampaignInfo() CampaignAllOfSearchCampaignInfo` + +GetSearchCampaignInfo returns the SearchCampaignInfo field if non-nil, zero value otherwise. + +### GetSearchCampaignInfoOk + +`func (o *GetActiveCampaigns200ResponseInner) GetSearchCampaignInfoOk() (*CampaignAllOfSearchCampaignInfo, bool)` + +GetSearchCampaignInfoOk returns a tuple with the SearchCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) SetSearchCampaignInfo(v CampaignAllOfSearchCampaignInfo)` + +SetSearchCampaignInfo sets SearchCampaignInfo field to given value. + +### HasSearchCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) HasSearchCampaignInfo() bool` + +HasSearchCampaignInfo returns a boolean if a field has been set. + +### GetRoleCompositionCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) GetRoleCompositionCampaignInfo() CampaignAllOfRoleCompositionCampaignInfo` + +GetRoleCompositionCampaignInfo returns the RoleCompositionCampaignInfo field if non-nil, zero value otherwise. + +### GetRoleCompositionCampaignInfoOk + +`func (o *GetActiveCampaigns200ResponseInner) GetRoleCompositionCampaignInfoOk() (*CampaignAllOfRoleCompositionCampaignInfo, bool)` + +GetRoleCompositionCampaignInfoOk returns a tuple with the RoleCompositionCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleCompositionCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) SetRoleCompositionCampaignInfo(v CampaignAllOfRoleCompositionCampaignInfo)` + +SetRoleCompositionCampaignInfo sets RoleCompositionCampaignInfo field to given value. + +### HasRoleCompositionCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) HasRoleCompositionCampaignInfo() bool` + +HasRoleCompositionCampaignInfo returns a boolean if a field has been set. + +### GetMachineAccountCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) GetMachineAccountCampaignInfo() CampaignAllOfMachineAccountCampaignInfo` + +GetMachineAccountCampaignInfo returns the MachineAccountCampaignInfo field if non-nil, zero value otherwise. + +### GetMachineAccountCampaignInfoOk + +`func (o *GetActiveCampaigns200ResponseInner) GetMachineAccountCampaignInfoOk() (*CampaignAllOfMachineAccountCampaignInfo, bool)` + +GetMachineAccountCampaignInfoOk returns a tuple with the MachineAccountCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMachineAccountCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) SetMachineAccountCampaignInfo(v CampaignAllOfMachineAccountCampaignInfo)` + +SetMachineAccountCampaignInfo sets MachineAccountCampaignInfo field to given value. + +### HasMachineAccountCampaignInfo + +`func (o *GetActiveCampaigns200ResponseInner) HasMachineAccountCampaignInfo() bool` + +HasMachineAccountCampaignInfo returns a boolean if a field has been set. + +### GetSourcesWithOrphanEntitlements + +`func (o *GetActiveCampaigns200ResponseInner) GetSourcesWithOrphanEntitlements() []CampaignAllOfSourcesWithOrphanEntitlements` + +GetSourcesWithOrphanEntitlements returns the SourcesWithOrphanEntitlements field if non-nil, zero value otherwise. + +### GetSourcesWithOrphanEntitlementsOk + +`func (o *GetActiveCampaigns200ResponseInner) GetSourcesWithOrphanEntitlementsOk() (*[]CampaignAllOfSourcesWithOrphanEntitlements, bool)` + +GetSourcesWithOrphanEntitlementsOk returns a tuple with the SourcesWithOrphanEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourcesWithOrphanEntitlements + +`func (o *GetActiveCampaigns200ResponseInner) SetSourcesWithOrphanEntitlements(v []CampaignAllOfSourcesWithOrphanEntitlements)` + +SetSourcesWithOrphanEntitlements sets SourcesWithOrphanEntitlements field to given value. + +### HasSourcesWithOrphanEntitlements + +`func (o *GetActiveCampaigns200ResponseInner) HasSourcesWithOrphanEntitlements() bool` + +HasSourcesWithOrphanEntitlements returns a boolean if a field has been set. + +### GetMandatoryCommentRequirement + +`func (o *GetActiveCampaigns200ResponseInner) GetMandatoryCommentRequirement() string` + +GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise. + +### GetMandatoryCommentRequirementOk + +`func (o *GetActiveCampaigns200ResponseInner) GetMandatoryCommentRequirementOk() (*string, bool)` + +GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMandatoryCommentRequirement + +`func (o *GetActiveCampaigns200ResponseInner) SetMandatoryCommentRequirement(v string)` + +SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value. + +### HasMandatoryCommentRequirement + +`func (o *GetActiveCampaigns200ResponseInner) HasMandatoryCommentRequirement() bool` + +HasMandatoryCommentRequirement returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/GetCampaign200Response.md b/docs/tools/sdk/go/Reference/V3/Models/GetCampaign200Response.md new file mode 100644 index 000000000..698e28bd7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/GetCampaign200Response.md @@ -0,0 +1,631 @@ +--- +id: get-campaign200-response +title: GetCampaign200Response +pagination_label: GetCampaign200Response +sidebar_label: GetCampaign200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetCampaign200Response', 'GetCampaign200Response'] +slug: /tools/sdk/go/v3/models/get-campaign200-response +tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'GetCampaign200Response'] +--- + +# GetCampaign200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the campaign | [optional] [readonly] +**Name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Description** | **NullableString** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Deadline** | Pointer to **SailPointTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **string** | The type of campaign. Could be extended in the future. | +**EmailNotificationEnabled** | Pointer to **bool** | Enables email notification for this campaign | [optional] [default to false] +**AutoRevokeAllowed** | Pointer to **bool** | Allows auto revoke for this campaign | [optional] [default to false] +**RecommendationsEnabled** | Pointer to **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to false] +**Status** | Pointer to **string** | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **SailPointTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Modified time of the campaign | [optional] [readonly] +**Filter** | Pointer to [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **bool** | Determines if comments on sunset date changes are required. | [optional] [default to true] +**SourceOwnerCampaignInfo** | Pointer to [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Methods + +### NewGetCampaign200Response + +`func NewGetCampaign200Response(name string, description NullableString, type_ string, ) *GetCampaign200Response` + +NewGetCampaign200Response instantiates a new GetCampaign200Response 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 + +### NewGetCampaign200ResponseWithDefaults + +`func NewGetCampaign200ResponseWithDefaults() *GetCampaign200Response` + +NewGetCampaign200ResponseWithDefaults instantiates a new GetCampaign200Response 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 + +### GetId + +`func (o *GetCampaign200Response) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetCampaign200Response) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetCampaign200Response) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetCampaign200Response) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *GetCampaign200Response) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetCampaign200Response) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetCampaign200Response) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *GetCampaign200Response) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *GetCampaign200Response) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *GetCampaign200Response) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *GetCampaign200Response) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *GetCampaign200Response) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetDeadline + +`func (o *GetCampaign200Response) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *GetCampaign200Response) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *GetCampaign200Response) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *GetCampaign200Response) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### GetType + +`func (o *GetCampaign200Response) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *GetCampaign200Response) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *GetCampaign200Response) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEmailNotificationEnabled + +`func (o *GetCampaign200Response) GetEmailNotificationEnabled() bool` + +GetEmailNotificationEnabled returns the EmailNotificationEnabled field if non-nil, zero value otherwise. + +### GetEmailNotificationEnabledOk + +`func (o *GetCampaign200Response) GetEmailNotificationEnabledOk() (*bool, bool)` + +GetEmailNotificationEnabledOk returns a tuple with the EmailNotificationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationEnabled + +`func (o *GetCampaign200Response) SetEmailNotificationEnabled(v bool)` + +SetEmailNotificationEnabled sets EmailNotificationEnabled field to given value. + +### HasEmailNotificationEnabled + +`func (o *GetCampaign200Response) HasEmailNotificationEnabled() bool` + +HasEmailNotificationEnabled returns a boolean if a field has been set. + +### GetAutoRevokeAllowed + +`func (o *GetCampaign200Response) GetAutoRevokeAllowed() bool` + +GetAutoRevokeAllowed returns the AutoRevokeAllowed field if non-nil, zero value otherwise. + +### GetAutoRevokeAllowedOk + +`func (o *GetCampaign200Response) GetAutoRevokeAllowedOk() (*bool, bool)` + +GetAutoRevokeAllowedOk returns a tuple with the AutoRevokeAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoRevokeAllowed + +`func (o *GetCampaign200Response) SetAutoRevokeAllowed(v bool)` + +SetAutoRevokeAllowed sets AutoRevokeAllowed field to given value. + +### HasAutoRevokeAllowed + +`func (o *GetCampaign200Response) HasAutoRevokeAllowed() bool` + +HasAutoRevokeAllowed returns a boolean if a field has been set. + +### GetRecommendationsEnabled + +`func (o *GetCampaign200Response) GetRecommendationsEnabled() bool` + +GetRecommendationsEnabled returns the RecommendationsEnabled field if non-nil, zero value otherwise. + +### GetRecommendationsEnabledOk + +`func (o *GetCampaign200Response) GetRecommendationsEnabledOk() (*bool, bool)` + +GetRecommendationsEnabledOk returns a tuple with the RecommendationsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendationsEnabled + +`func (o *GetCampaign200Response) SetRecommendationsEnabled(v bool)` + +SetRecommendationsEnabled sets RecommendationsEnabled field to given value. + +### HasRecommendationsEnabled + +`func (o *GetCampaign200Response) HasRecommendationsEnabled() bool` + +HasRecommendationsEnabled returns a boolean if a field has been set. + +### GetStatus + +`func (o *GetCampaign200Response) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GetCampaign200Response) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GetCampaign200Response) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GetCampaign200Response) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetCorrelatedStatus + +`func (o *GetCampaign200Response) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *GetCampaign200Response) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *GetCampaign200Response) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + +### HasCorrelatedStatus + +`func (o *GetCampaign200Response) HasCorrelatedStatus() bool` + +HasCorrelatedStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *GetCampaign200Response) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GetCampaign200Response) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *GetCampaign200Response) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *GetCampaign200Response) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetTotalCertifications + +`func (o *GetCampaign200Response) GetTotalCertifications() int32` + +GetTotalCertifications returns the TotalCertifications field if non-nil, zero value otherwise. + +### GetTotalCertificationsOk + +`func (o *GetCampaign200Response) GetTotalCertificationsOk() (*int32, bool)` + +GetTotalCertificationsOk returns a tuple with the TotalCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCertifications + +`func (o *GetCampaign200Response) SetTotalCertifications(v int32)` + +SetTotalCertifications sets TotalCertifications field to given value. + +### HasTotalCertifications + +`func (o *GetCampaign200Response) HasTotalCertifications() bool` + +HasTotalCertifications returns a boolean if a field has been set. + +### GetCompletedCertifications + +`func (o *GetCampaign200Response) GetCompletedCertifications() int32` + +GetCompletedCertifications returns the CompletedCertifications field if non-nil, zero value otherwise. + +### GetCompletedCertificationsOk + +`func (o *GetCampaign200Response) GetCompletedCertificationsOk() (*int32, bool)` + +GetCompletedCertificationsOk returns a tuple with the CompletedCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedCertifications + +`func (o *GetCampaign200Response) SetCompletedCertifications(v int32)` + +SetCompletedCertifications sets CompletedCertifications field to given value. + +### HasCompletedCertifications + +`func (o *GetCampaign200Response) HasCompletedCertifications() bool` + +HasCompletedCertifications returns a boolean if a field has been set. + +### GetAlerts + +`func (o *GetCampaign200Response) GetAlerts() []CampaignAlert` + +GetAlerts returns the Alerts field if non-nil, zero value otherwise. + +### GetAlertsOk + +`func (o *GetCampaign200Response) GetAlertsOk() (*[]CampaignAlert, bool)` + +GetAlertsOk returns a tuple with the Alerts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlerts + +`func (o *GetCampaign200Response) SetAlerts(v []CampaignAlert)` + +SetAlerts sets Alerts field to given value. + +### HasAlerts + +`func (o *GetCampaign200Response) HasAlerts() bool` + +HasAlerts returns a boolean if a field has been set. + +### GetModified + +`func (o *GetCampaign200Response) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *GetCampaign200Response) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *GetCampaign200Response) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *GetCampaign200Response) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetFilter + +`func (o *GetCampaign200Response) GetFilter() CampaignAllOfFilter` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *GetCampaign200Response) GetFilterOk() (*CampaignAllOfFilter, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *GetCampaign200Response) SetFilter(v CampaignAllOfFilter)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *GetCampaign200Response) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### GetSunsetCommentsRequired + +`func (o *GetCampaign200Response) GetSunsetCommentsRequired() bool` + +GetSunsetCommentsRequired returns the SunsetCommentsRequired field if non-nil, zero value otherwise. + +### GetSunsetCommentsRequiredOk + +`func (o *GetCampaign200Response) GetSunsetCommentsRequiredOk() (*bool, bool)` + +GetSunsetCommentsRequiredOk returns a tuple with the SunsetCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSunsetCommentsRequired + +`func (o *GetCampaign200Response) SetSunsetCommentsRequired(v bool)` + +SetSunsetCommentsRequired sets SunsetCommentsRequired field to given value. + +### HasSunsetCommentsRequired + +`func (o *GetCampaign200Response) HasSunsetCommentsRequired() bool` + +HasSunsetCommentsRequired returns a boolean if a field has been set. + +### GetSourceOwnerCampaignInfo + +`func (o *GetCampaign200Response) GetSourceOwnerCampaignInfo() CampaignAllOfSourceOwnerCampaignInfo` + +GetSourceOwnerCampaignInfo returns the SourceOwnerCampaignInfo field if non-nil, zero value otherwise. + +### GetSourceOwnerCampaignInfoOk + +`func (o *GetCampaign200Response) GetSourceOwnerCampaignInfoOk() (*CampaignAllOfSourceOwnerCampaignInfo, bool)` + +GetSourceOwnerCampaignInfoOk returns a tuple with the SourceOwnerCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceOwnerCampaignInfo + +`func (o *GetCampaign200Response) SetSourceOwnerCampaignInfo(v CampaignAllOfSourceOwnerCampaignInfo)` + +SetSourceOwnerCampaignInfo sets SourceOwnerCampaignInfo field to given value. + +### HasSourceOwnerCampaignInfo + +`func (o *GetCampaign200Response) HasSourceOwnerCampaignInfo() bool` + +HasSourceOwnerCampaignInfo returns a boolean if a field has been set. + +### GetSearchCampaignInfo + +`func (o *GetCampaign200Response) GetSearchCampaignInfo() CampaignAllOfSearchCampaignInfo` + +GetSearchCampaignInfo returns the SearchCampaignInfo field if non-nil, zero value otherwise. + +### GetSearchCampaignInfoOk + +`func (o *GetCampaign200Response) GetSearchCampaignInfoOk() (*CampaignAllOfSearchCampaignInfo, bool)` + +GetSearchCampaignInfoOk returns a tuple with the SearchCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchCampaignInfo + +`func (o *GetCampaign200Response) SetSearchCampaignInfo(v CampaignAllOfSearchCampaignInfo)` + +SetSearchCampaignInfo sets SearchCampaignInfo field to given value. + +### HasSearchCampaignInfo + +`func (o *GetCampaign200Response) HasSearchCampaignInfo() bool` + +HasSearchCampaignInfo returns a boolean if a field has been set. + +### GetRoleCompositionCampaignInfo + +`func (o *GetCampaign200Response) GetRoleCompositionCampaignInfo() CampaignAllOfRoleCompositionCampaignInfo` + +GetRoleCompositionCampaignInfo returns the RoleCompositionCampaignInfo field if non-nil, zero value otherwise. + +### GetRoleCompositionCampaignInfoOk + +`func (o *GetCampaign200Response) GetRoleCompositionCampaignInfoOk() (*CampaignAllOfRoleCompositionCampaignInfo, bool)` + +GetRoleCompositionCampaignInfoOk returns a tuple with the RoleCompositionCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleCompositionCampaignInfo + +`func (o *GetCampaign200Response) SetRoleCompositionCampaignInfo(v CampaignAllOfRoleCompositionCampaignInfo)` + +SetRoleCompositionCampaignInfo sets RoleCompositionCampaignInfo field to given value. + +### HasRoleCompositionCampaignInfo + +`func (o *GetCampaign200Response) HasRoleCompositionCampaignInfo() bool` + +HasRoleCompositionCampaignInfo returns a boolean if a field has been set. + +### GetMachineAccountCampaignInfo + +`func (o *GetCampaign200Response) GetMachineAccountCampaignInfo() CampaignAllOfMachineAccountCampaignInfo` + +GetMachineAccountCampaignInfo returns the MachineAccountCampaignInfo field if non-nil, zero value otherwise. + +### GetMachineAccountCampaignInfoOk + +`func (o *GetCampaign200Response) GetMachineAccountCampaignInfoOk() (*CampaignAllOfMachineAccountCampaignInfo, bool)` + +GetMachineAccountCampaignInfoOk returns a tuple with the MachineAccountCampaignInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMachineAccountCampaignInfo + +`func (o *GetCampaign200Response) SetMachineAccountCampaignInfo(v CampaignAllOfMachineAccountCampaignInfo)` + +SetMachineAccountCampaignInfo sets MachineAccountCampaignInfo field to given value. + +### HasMachineAccountCampaignInfo + +`func (o *GetCampaign200Response) HasMachineAccountCampaignInfo() bool` + +HasMachineAccountCampaignInfo returns a boolean if a field has been set. + +### GetSourcesWithOrphanEntitlements + +`func (o *GetCampaign200Response) GetSourcesWithOrphanEntitlements() []CampaignAllOfSourcesWithOrphanEntitlements` + +GetSourcesWithOrphanEntitlements returns the SourcesWithOrphanEntitlements field if non-nil, zero value otherwise. + +### GetSourcesWithOrphanEntitlementsOk + +`func (o *GetCampaign200Response) GetSourcesWithOrphanEntitlementsOk() (*[]CampaignAllOfSourcesWithOrphanEntitlements, bool)` + +GetSourcesWithOrphanEntitlementsOk returns a tuple with the SourcesWithOrphanEntitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourcesWithOrphanEntitlements + +`func (o *GetCampaign200Response) SetSourcesWithOrphanEntitlements(v []CampaignAllOfSourcesWithOrphanEntitlements)` + +SetSourcesWithOrphanEntitlements sets SourcesWithOrphanEntitlements field to given value. + +### HasSourcesWithOrphanEntitlements + +`func (o *GetCampaign200Response) HasSourcesWithOrphanEntitlements() bool` + +HasSourcesWithOrphanEntitlements returns a boolean if a field has been set. + +### GetMandatoryCommentRequirement + +`func (o *GetCampaign200Response) GetMandatoryCommentRequirement() string` + +GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise. + +### GetMandatoryCommentRequirementOk + +`func (o *GetCampaign200Response) GetMandatoryCommentRequirementOk() (*string, bool)` + +GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMandatoryCommentRequirement + +`func (o *GetCampaign200Response) SetMandatoryCommentRequirement(v string)` + +SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value. + +### HasMandatoryCommentRequirement + +`func (o *GetCampaign200Response) HasMandatoryCommentRequirement() bool` + +HasMandatoryCommentRequirement returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/GetDiscoveredApplications200ResponseInner.md b/docs/tools/sdk/go/Reference/V3/Models/GetDiscoveredApplications200ResponseInner.md new file mode 100644 index 000000000..61552fe33 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/GetDiscoveredApplications200ResponseInner.md @@ -0,0 +1,298 @@ +--- +id: get-discovered-applications200-response-inner +title: GetDiscoveredApplications200ResponseInner +pagination_label: GetDiscoveredApplications200ResponseInner +sidebar_label: GetDiscoveredApplications200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetDiscoveredApplications200ResponseInner', 'GetDiscoveredApplications200ResponseInner'] +slug: /tools/sdk/go/v3/models/get-discovered-applications200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetDiscoveredApplications200ResponseInner', 'GetDiscoveredApplications200ResponseInner'] +--- + +# GetDiscoveredApplications200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **string** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **string** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **string** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **string** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]string** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **SailPointTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **string** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [optional] +**AssociatedSources** | Pointer to **[]string** | List of associated sources related to this discovered application. | [optional] + +## Methods + +### NewGetDiscoveredApplications200ResponseInner + +`func NewGetDiscoveredApplications200ResponseInner() *GetDiscoveredApplications200ResponseInner` + +NewGetDiscoveredApplications200ResponseInner instantiates a new GetDiscoveredApplications200ResponseInner 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 + +### NewGetDiscoveredApplications200ResponseInnerWithDefaults + +`func NewGetDiscoveredApplications200ResponseInnerWithDefaults() *GetDiscoveredApplications200ResponseInner` + +NewGetDiscoveredApplications200ResponseInnerWithDefaults instantiates a new GetDiscoveredApplications200ResponseInner 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 + +### GetId + +`func (o *GetDiscoveredApplications200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetDiscoveredApplications200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetDiscoveredApplications200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *GetDiscoveredApplications200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetDiscoveredApplications200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *GetDiscoveredApplications200ResponseInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDiscoverySource + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoverySource() string` + +GetDiscoverySource returns the DiscoverySource field if non-nil, zero value otherwise. + +### GetDiscoverySourceOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoverySourceOk() (*string, bool)` + +GetDiscoverySourceOk returns a tuple with the DiscoverySource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoverySource + +`func (o *GetDiscoveredApplications200ResponseInner) SetDiscoverySource(v string)` + +SetDiscoverySource sets DiscoverySource field to given value. + +### HasDiscoverySource + +`func (o *GetDiscoveredApplications200ResponseInner) HasDiscoverySource() bool` + +HasDiscoverySource returns a boolean if a field has been set. + +### GetDiscoveredVendor + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoveredVendor() string` + +GetDiscoveredVendor returns the DiscoveredVendor field if non-nil, zero value otherwise. + +### GetDiscoveredVendorOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoveredVendorOk() (*string, bool)` + +GetDiscoveredVendorOk returns a tuple with the DiscoveredVendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredVendor + +`func (o *GetDiscoveredApplications200ResponseInner) SetDiscoveredVendor(v string)` + +SetDiscoveredVendor sets DiscoveredVendor field to given value. + +### HasDiscoveredVendor + +`func (o *GetDiscoveredApplications200ResponseInner) HasDiscoveredVendor() bool` + +HasDiscoveredVendor returns a boolean if a field has been set. + +### GetDescription + +`func (o *GetDiscoveredApplications200ResponseInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *GetDiscoveredApplications200ResponseInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *GetDiscoveredApplications200ResponseInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetRecommendedConnectors + +`func (o *GetDiscoveredApplications200ResponseInner) GetRecommendedConnectors() []string` + +GetRecommendedConnectors returns the RecommendedConnectors field if non-nil, zero value otherwise. + +### GetRecommendedConnectorsOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetRecommendedConnectorsOk() (*[]string, bool)` + +GetRecommendedConnectorsOk returns a tuple with the RecommendedConnectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendedConnectors + +`func (o *GetDiscoveredApplications200ResponseInner) SetRecommendedConnectors(v []string)` + +SetRecommendedConnectors sets RecommendedConnectors field to given value. + +### HasRecommendedConnectors + +`func (o *GetDiscoveredApplications200ResponseInner) HasRecommendedConnectors() bool` + +HasRecommendedConnectors returns a boolean if a field has been set. + +### GetDiscoveredAt + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoveredAt() SailPointTime` + +GetDiscoveredAt returns the DiscoveredAt field if non-nil, zero value otherwise. + +### GetDiscoveredAtOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetDiscoveredAtOk() (*SailPointTime, bool)` + +GetDiscoveredAtOk returns a tuple with the DiscoveredAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredAt + +`func (o *GetDiscoveredApplications200ResponseInner) SetDiscoveredAt(v SailPointTime)` + +SetDiscoveredAt sets DiscoveredAt field to given value. + +### HasDiscoveredAt + +`func (o *GetDiscoveredApplications200ResponseInner) HasDiscoveredAt() bool` + +HasDiscoveredAt returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *GetDiscoveredApplications200ResponseInner) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *GetDiscoveredApplications200ResponseInner) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *GetDiscoveredApplications200ResponseInner) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetStatus + +`func (o *GetDiscoveredApplications200ResponseInner) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *GetDiscoveredApplications200ResponseInner) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *GetDiscoveredApplications200ResponseInner) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetAssociatedSources + +`func (o *GetDiscoveredApplications200ResponseInner) GetAssociatedSources() []string` + +GetAssociatedSources returns the AssociatedSources field if non-nil, zero value otherwise. + +### GetAssociatedSourcesOk + +`func (o *GetDiscoveredApplications200ResponseInner) GetAssociatedSourcesOk() (*[]string, bool)` + +GetAssociatedSourcesOk returns a tuple with the AssociatedSources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssociatedSources + +`func (o *GetDiscoveredApplications200ResponseInner) SetAssociatedSources(v []string)` + +SetAssociatedSources sets AssociatedSources field to given value. + +### HasAssociatedSources + +`func (o *GetDiscoveredApplications200ResponseInner) HasAssociatedSources() bool` + +HasAssociatedSources returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/GetOAuthClientResponse.md b/docs/tools/sdk/go/Reference/V3/Models/GetOAuthClientResponse.md new file mode 100644 index 000000000..2eb75b352 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/GetOAuthClientResponse.md @@ -0,0 +1,574 @@ +--- +id: get-o-auth-client-response +title: GetOAuthClientResponse +pagination_label: GetOAuthClientResponse +sidebar_label: GetOAuthClientResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetOAuthClientResponse', 'GetOAuthClientResponse'] +slug: /tools/sdk/go/v3/models/get-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'GetOAuthClientResponse', 'GetOAuthClientResponse'] +--- + +# GetOAuthClientResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ID of the OAuth client | +**BusinessName** | **NullableString** | The name of the business the API Client should belong to | +**HomepageUrl** | **NullableString** | The homepage URL associated with the owner of the API Client | +**Name** | **string** | A human-readable name for the API Client | +**Description** | **NullableString** | A description of the API Client | +**AccessTokenValiditySeconds** | **int32** | The number of seconds an access token generated for this API Client is valid for | +**RefreshTokenValiditySeconds** | **int32** | The number of seconds a refresh token generated for this API Client is valid for | +**RedirectUris** | **[]string** | A list of the approved redirect URIs used with the authorization_code flow | +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | +**AccessType** | [**AccessType**](access-type) | | +**Type** | [**ClientType**](client-type) | | +**Internal** | **bool** | An indicator of whether the API Client can be used for requests internal to IDN | +**Enabled** | **bool** | An indicator of whether the API Client is enabled for use | +**StrongAuthSupported** | **bool** | An indicator of whether the API Client supports strong authentication | +**ClaimsSupported** | **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | +**Created** | **SailPointTime** | The date and time, down to the millisecond, when the API Client was created | +**Modified** | **SailPointTime** | The date and time, down to the millisecond, when the API Client was last updated | +**Secret** | Pointer to **NullableString** | | [optional] +**Metadata** | Pointer to **NullableString** | | [optional] +**LastUsed** | Pointer to **NullableTime** | The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. | [optional] +**Scope** | **[]string** | Scopes of the API Client. | + +## Methods + +### NewGetOAuthClientResponse + +`func NewGetOAuthClientResponse(id string, businessName NullableString, homepageUrl NullableString, name string, description NullableString, accessTokenValiditySeconds int32, refreshTokenValiditySeconds int32, redirectUris []string, grantTypes []GrantType, accessType AccessType, type_ ClientType, internal bool, enabled bool, strongAuthSupported bool, claimsSupported bool, created SailPointTime, modified SailPointTime, scope []string, ) *GetOAuthClientResponse` + +NewGetOAuthClientResponse instantiates a new GetOAuthClientResponse 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 + +### NewGetOAuthClientResponseWithDefaults + +`func NewGetOAuthClientResponseWithDefaults() *GetOAuthClientResponse` + +NewGetOAuthClientResponseWithDefaults instantiates a new GetOAuthClientResponse 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 + +### GetId + +`func (o *GetOAuthClientResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetOAuthClientResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetOAuthClientResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetBusinessName + +`func (o *GetOAuthClientResponse) GetBusinessName() string` + +GetBusinessName returns the BusinessName field if non-nil, zero value otherwise. + +### GetBusinessNameOk + +`func (o *GetOAuthClientResponse) GetBusinessNameOk() (*string, bool)` + +GetBusinessNameOk returns a tuple with the BusinessName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBusinessName + +`func (o *GetOAuthClientResponse) SetBusinessName(v string)` + +SetBusinessName sets BusinessName field to given value. + + +### SetBusinessNameNil + +`func (o *GetOAuthClientResponse) SetBusinessNameNil(b bool)` + + SetBusinessNameNil sets the value for BusinessName to be an explicit nil + +### UnsetBusinessName +`func (o *GetOAuthClientResponse) UnsetBusinessName()` + +UnsetBusinessName ensures that no value is present for BusinessName, not even an explicit nil +### GetHomepageUrl + +`func (o *GetOAuthClientResponse) GetHomepageUrl() string` + +GetHomepageUrl returns the HomepageUrl field if non-nil, zero value otherwise. + +### GetHomepageUrlOk + +`func (o *GetOAuthClientResponse) GetHomepageUrlOk() (*string, bool)` + +GetHomepageUrlOk returns a tuple with the HomepageUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHomepageUrl + +`func (o *GetOAuthClientResponse) SetHomepageUrl(v string)` + +SetHomepageUrl sets HomepageUrl field to given value. + + +### SetHomepageUrlNil + +`func (o *GetOAuthClientResponse) SetHomepageUrlNil(b bool)` + + SetHomepageUrlNil sets the value for HomepageUrl to be an explicit nil + +### UnsetHomepageUrl +`func (o *GetOAuthClientResponse) UnsetHomepageUrl()` + +UnsetHomepageUrl ensures that no value is present for HomepageUrl, not even an explicit nil +### GetName + +`func (o *GetOAuthClientResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetOAuthClientResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetOAuthClientResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *GetOAuthClientResponse) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *GetOAuthClientResponse) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *GetOAuthClientResponse) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *GetOAuthClientResponse) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *GetOAuthClientResponse) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAccessTokenValiditySeconds + +`func (o *GetOAuthClientResponse) GetAccessTokenValiditySeconds() int32` + +GetAccessTokenValiditySeconds returns the AccessTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetAccessTokenValiditySecondsOk + +`func (o *GetOAuthClientResponse) GetAccessTokenValiditySecondsOk() (*int32, bool)` + +GetAccessTokenValiditySecondsOk returns a tuple with the AccessTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessTokenValiditySeconds + +`func (o *GetOAuthClientResponse) SetAccessTokenValiditySeconds(v int32)` + +SetAccessTokenValiditySeconds sets AccessTokenValiditySeconds field to given value. + + +### GetRefreshTokenValiditySeconds + +`func (o *GetOAuthClientResponse) GetRefreshTokenValiditySeconds() int32` + +GetRefreshTokenValiditySeconds returns the RefreshTokenValiditySeconds field if non-nil, zero value otherwise. + +### GetRefreshTokenValiditySecondsOk + +`func (o *GetOAuthClientResponse) GetRefreshTokenValiditySecondsOk() (*int32, bool)` + +GetRefreshTokenValiditySecondsOk returns a tuple with the RefreshTokenValiditySeconds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRefreshTokenValiditySeconds + +`func (o *GetOAuthClientResponse) SetRefreshTokenValiditySeconds(v int32)` + +SetRefreshTokenValiditySeconds sets RefreshTokenValiditySeconds field to given value. + + +### GetRedirectUris + +`func (o *GetOAuthClientResponse) GetRedirectUris() []string` + +GetRedirectUris returns the RedirectUris field if non-nil, zero value otherwise. + +### GetRedirectUrisOk + +`func (o *GetOAuthClientResponse) GetRedirectUrisOk() (*[]string, bool)` + +GetRedirectUrisOk returns a tuple with the RedirectUris field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedirectUris + +`func (o *GetOAuthClientResponse) SetRedirectUris(v []string)` + +SetRedirectUris sets RedirectUris field to given value. + + +### SetRedirectUrisNil + +`func (o *GetOAuthClientResponse) SetRedirectUrisNil(b bool)` + + SetRedirectUrisNil sets the value for RedirectUris to be an explicit nil + +### UnsetRedirectUris +`func (o *GetOAuthClientResponse) UnsetRedirectUris()` + +UnsetRedirectUris ensures that no value is present for RedirectUris, not even an explicit nil +### GetGrantTypes + +`func (o *GetOAuthClientResponse) GetGrantTypes() []GrantType` + +GetGrantTypes returns the GrantTypes field if non-nil, zero value otherwise. + +### GetGrantTypesOk + +`func (o *GetOAuthClientResponse) GetGrantTypesOk() (*[]GrantType, bool)` + +GetGrantTypesOk returns a tuple with the GrantTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGrantTypes + +`func (o *GetOAuthClientResponse) SetGrantTypes(v []GrantType)` + +SetGrantTypes sets GrantTypes field to given value. + + +### GetAccessType + +`func (o *GetOAuthClientResponse) GetAccessType() AccessType` + +GetAccessType returns the AccessType field if non-nil, zero value otherwise. + +### GetAccessTypeOk + +`func (o *GetOAuthClientResponse) GetAccessTypeOk() (*AccessType, bool)` + +GetAccessTypeOk returns a tuple with the AccessType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessType + +`func (o *GetOAuthClientResponse) SetAccessType(v AccessType)` + +SetAccessType sets AccessType field to given value. + + +### GetType + +`func (o *GetOAuthClientResponse) GetType() ClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *GetOAuthClientResponse) GetTypeOk() (*ClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *GetOAuthClientResponse) SetType(v ClientType)` + +SetType sets Type field to given value. + + +### GetInternal + +`func (o *GetOAuthClientResponse) GetInternal() bool` + +GetInternal returns the Internal field if non-nil, zero value otherwise. + +### GetInternalOk + +`func (o *GetOAuthClientResponse) GetInternalOk() (*bool, bool)` + +GetInternalOk returns a tuple with the Internal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternal + +`func (o *GetOAuthClientResponse) SetInternal(v bool)` + +SetInternal sets Internal field to given value. + + +### GetEnabled + +`func (o *GetOAuthClientResponse) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *GetOAuthClientResponse) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *GetOAuthClientResponse) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + + +### GetStrongAuthSupported + +`func (o *GetOAuthClientResponse) GetStrongAuthSupported() bool` + +GetStrongAuthSupported returns the StrongAuthSupported field if non-nil, zero value otherwise. + +### GetStrongAuthSupportedOk + +`func (o *GetOAuthClientResponse) GetStrongAuthSupportedOk() (*bool, bool)` + +GetStrongAuthSupportedOk returns a tuple with the StrongAuthSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStrongAuthSupported + +`func (o *GetOAuthClientResponse) SetStrongAuthSupported(v bool)` + +SetStrongAuthSupported sets StrongAuthSupported field to given value. + + +### GetClaimsSupported + +`func (o *GetOAuthClientResponse) GetClaimsSupported() bool` + +GetClaimsSupported returns the ClaimsSupported field if non-nil, zero value otherwise. + +### GetClaimsSupportedOk + +`func (o *GetOAuthClientResponse) GetClaimsSupportedOk() (*bool, bool)` + +GetClaimsSupportedOk returns a tuple with the ClaimsSupported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClaimsSupported + +`func (o *GetOAuthClientResponse) SetClaimsSupported(v bool)` + +SetClaimsSupported sets ClaimsSupported field to given value. + + +### GetCreated + +`func (o *GetOAuthClientResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GetOAuthClientResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *GetOAuthClientResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetModified + +`func (o *GetOAuthClientResponse) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *GetOAuthClientResponse) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *GetOAuthClientResponse) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + + +### GetSecret + +`func (o *GetOAuthClientResponse) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *GetOAuthClientResponse) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *GetOAuthClientResponse) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *GetOAuthClientResponse) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### SetSecretNil + +`func (o *GetOAuthClientResponse) SetSecretNil(b bool)` + + SetSecretNil sets the value for Secret to be an explicit nil + +### UnsetSecret +`func (o *GetOAuthClientResponse) UnsetSecret()` + +UnsetSecret ensures that no value is present for Secret, not even an explicit nil +### GetMetadata + +`func (o *GetOAuthClientResponse) GetMetadata() string` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetOAuthClientResponse) GetMetadataOk() (*string, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetOAuthClientResponse) SetMetadata(v string)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetOAuthClientResponse) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### SetMetadataNil + +`func (o *GetOAuthClientResponse) SetMetadataNil(b bool)` + + SetMetadataNil sets the value for Metadata to be an explicit nil + +### UnsetMetadata +`func (o *GetOAuthClientResponse) UnsetMetadata()` + +UnsetMetadata ensures that no value is present for Metadata, not even an explicit nil +### GetLastUsed + +`func (o *GetOAuthClientResponse) GetLastUsed() SailPointTime` + +GetLastUsed returns the LastUsed field if non-nil, zero value otherwise. + +### GetLastUsedOk + +`func (o *GetOAuthClientResponse) GetLastUsedOk() (*SailPointTime, bool)` + +GetLastUsedOk returns a tuple with the LastUsed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUsed + +`func (o *GetOAuthClientResponse) SetLastUsed(v SailPointTime)` + +SetLastUsed sets LastUsed field to given value. + +### HasLastUsed + +`func (o *GetOAuthClientResponse) HasLastUsed() bool` + +HasLastUsed returns a boolean if a field has been set. + +### SetLastUsedNil + +`func (o *GetOAuthClientResponse) SetLastUsedNil(b bool)` + + SetLastUsedNil sets the value for LastUsed to be an explicit nil + +### UnsetLastUsed +`func (o *GetOAuthClientResponse) UnsetLastUsed()` + +UnsetLastUsed ensures that no value is present for LastUsed, not even an explicit nil +### GetScope + +`func (o *GetOAuthClientResponse) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *GetOAuthClientResponse) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *GetOAuthClientResponse) SetScope(v []string)` + +SetScope sets Scope field to given value. + + +### SetScopeNil + +`func (o *GetOAuthClientResponse) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *GetOAuthClientResponse) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/GetPersonalAccessTokenResponse.md b/docs/tools/sdk/go/Reference/V3/Models/GetPersonalAccessTokenResponse.md new file mode 100644 index 000000000..db13db5e0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/GetPersonalAccessTokenResponse.md @@ -0,0 +1,215 @@ +--- +id: get-personal-access-token-response +title: GetPersonalAccessTokenResponse +pagination_label: GetPersonalAccessTokenResponse +sidebar_label: GetPersonalAccessTokenResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetPersonalAccessTokenResponse', 'GetPersonalAccessTokenResponse'] +slug: /tools/sdk/go/v3/models/get-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'GetPersonalAccessTokenResponse', 'GetPersonalAccessTokenResponse'] +--- + +# GetPersonalAccessTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The ID of the personal access token (to be used as the username for Basic Auth). | +**Name** | **string** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | +**Scope** | **[]string** | Scopes of the personal access token. | +**Owner** | [**PatOwner**](pat-owner) | | +**Created** | **SailPointTime** | The date and time, down to the millisecond, when this personal access token was created. | +**LastUsed** | Pointer to **NullableTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional] +**Managed** | Pointer to **bool** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to false] + +## Methods + +### NewGetPersonalAccessTokenResponse + +`func NewGetPersonalAccessTokenResponse(id string, name string, scope []string, owner PatOwner, created SailPointTime, ) *GetPersonalAccessTokenResponse` + +NewGetPersonalAccessTokenResponse instantiates a new GetPersonalAccessTokenResponse 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 + +### NewGetPersonalAccessTokenResponseWithDefaults + +`func NewGetPersonalAccessTokenResponseWithDefaults() *GetPersonalAccessTokenResponse` + +NewGetPersonalAccessTokenResponseWithDefaults instantiates a new GetPersonalAccessTokenResponse 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 + +### GetId + +`func (o *GetPersonalAccessTokenResponse) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetPersonalAccessTokenResponse) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetPersonalAccessTokenResponse) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *GetPersonalAccessTokenResponse) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetPersonalAccessTokenResponse) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetPersonalAccessTokenResponse) SetName(v string)` + +SetName sets Name field to given value. + + +### GetScope + +`func (o *GetPersonalAccessTokenResponse) GetScope() []string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *GetPersonalAccessTokenResponse) GetScopeOk() (*[]string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScope + +`func (o *GetPersonalAccessTokenResponse) SetScope(v []string)` + +SetScope sets Scope field to given value. + + +### SetScopeNil + +`func (o *GetPersonalAccessTokenResponse) SetScopeNil(b bool)` + + SetScopeNil sets the value for Scope to be an explicit nil + +### UnsetScope +`func (o *GetPersonalAccessTokenResponse) UnsetScope()` + +UnsetScope ensures that no value is present for Scope, not even an explicit nil +### GetOwner + +`func (o *GetPersonalAccessTokenResponse) GetOwner() PatOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *GetPersonalAccessTokenResponse) GetOwnerOk() (*PatOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *GetPersonalAccessTokenResponse) SetOwner(v PatOwner)` + +SetOwner sets Owner field to given value. + + +### GetCreated + +`func (o *GetPersonalAccessTokenResponse) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GetPersonalAccessTokenResponse) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *GetPersonalAccessTokenResponse) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + + +### GetLastUsed + +`func (o *GetPersonalAccessTokenResponse) GetLastUsed() SailPointTime` + +GetLastUsed returns the LastUsed field if non-nil, zero value otherwise. + +### GetLastUsedOk + +`func (o *GetPersonalAccessTokenResponse) GetLastUsedOk() (*SailPointTime, bool)` + +GetLastUsedOk returns a tuple with the LastUsed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUsed + +`func (o *GetPersonalAccessTokenResponse) SetLastUsed(v SailPointTime)` + +SetLastUsed sets LastUsed field to given value. + +### HasLastUsed + +`func (o *GetPersonalAccessTokenResponse) HasLastUsed() bool` + +HasLastUsed returns a boolean if a field has been set. + +### SetLastUsedNil + +`func (o *GetPersonalAccessTokenResponse) SetLastUsedNil(b bool)` + + SetLastUsedNil sets the value for LastUsed to be an explicit nil + +### UnsetLastUsed +`func (o *GetPersonalAccessTokenResponse) UnsetLastUsed()` + +UnsetLastUsed ensures that no value is present for LastUsed, not even an explicit nil +### GetManaged + +`func (o *GetPersonalAccessTokenResponse) GetManaged() bool` + +GetManaged returns the Managed field if non-nil, zero value otherwise. + +### GetManagedOk + +`func (o *GetPersonalAccessTokenResponse) GetManagedOk() (*bool, bool)` + +GetManagedOk returns a tuple with the Managed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManaged + +`func (o *GetPersonalAccessTokenResponse) SetManaged(v bool)` + +SetManaged sets Managed field to given value. + +### HasManaged + +`func (o *GetPersonalAccessTokenResponse) HasManaged() bool` + +HasManaged returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/GetVendorConnectorMappings405Response.md b/docs/tools/sdk/go/Reference/V3/Models/GetVendorConnectorMappings405Response.md new file mode 100644 index 000000000..2de1bc224 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/GetVendorConnectorMappings405Response.md @@ -0,0 +1,116 @@ +--- +id: get-vendor-connector-mappings405-response +title: GetVendorConnectorMappings405Response +pagination_label: GetVendorConnectorMappings405Response +sidebar_label: GetVendorConnectorMappings405Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GetVendorConnectorMappings405Response', 'GetVendorConnectorMappings405Response'] +slug: /tools/sdk/go/v3/models/get-vendor-connector-mappings405-response +tags: ['SDK', 'Software Development Kit', 'GetVendorConnectorMappings405Response', 'GetVendorConnectorMappings405Response'] +--- + +# GetVendorConnectorMappings405Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ErrorName** | Pointer to **map[string]interface{}** | A message describing the error | [optional] +**ErrorMessage** | Pointer to **map[string]interface{}** | Description of the error | [optional] +**TrackingId** | Pointer to **string** | Unique tracking id for the error. | [optional] + +## Methods + +### NewGetVendorConnectorMappings405Response + +`func NewGetVendorConnectorMappings405Response() *GetVendorConnectorMappings405Response` + +NewGetVendorConnectorMappings405Response instantiates a new GetVendorConnectorMappings405Response 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 + +### NewGetVendorConnectorMappings405ResponseWithDefaults + +`func NewGetVendorConnectorMappings405ResponseWithDefaults() *GetVendorConnectorMappings405Response` + +NewGetVendorConnectorMappings405ResponseWithDefaults instantiates a new GetVendorConnectorMappings405Response 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 + +### GetErrorName + +`func (o *GetVendorConnectorMappings405Response) GetErrorName() map[string]interface{}` + +GetErrorName returns the ErrorName field if non-nil, zero value otherwise. + +### GetErrorNameOk + +`func (o *GetVendorConnectorMappings405Response) GetErrorNameOk() (*map[string]interface{}, bool)` + +GetErrorNameOk returns a tuple with the ErrorName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorName + +`func (o *GetVendorConnectorMappings405Response) SetErrorName(v map[string]interface{})` + +SetErrorName sets ErrorName field to given value. + +### HasErrorName + +`func (o *GetVendorConnectorMappings405Response) HasErrorName() bool` + +HasErrorName returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *GetVendorConnectorMappings405Response) GetErrorMessage() map[string]interface{}` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *GetVendorConnectorMappings405Response) GetErrorMessageOk() (*map[string]interface{}, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *GetVendorConnectorMappings405Response) SetErrorMessage(v map[string]interface{})` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *GetVendorConnectorMappings405Response) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetTrackingId + +`func (o *GetVendorConnectorMappings405Response) GetTrackingId() string` + +GetTrackingId returns the TrackingId field if non-nil, zero value otherwise. + +### GetTrackingIdOk + +`func (o *GetVendorConnectorMappings405Response) GetTrackingIdOk() (*string, bool)` + +GetTrackingIdOk returns a tuple with the TrackingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrackingId + +`func (o *GetVendorConnectorMappings405Response) SetTrackingId(v string)` + +SetTrackingId sets TrackingId field to given value. + +### HasTrackingId + +`func (o *GetVendorConnectorMappings405Response) HasTrackingId() bool` + +HasTrackingId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/GrantType.md b/docs/tools/sdk/go/Reference/V3/Models/GrantType.md new file mode 100644 index 000000000..504682be5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/GrantType.md @@ -0,0 +1,23 @@ +--- +id: grant-type +title: GrantType +pagination_label: GrantType +sidebar_label: GrantType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'GrantType', 'GrantType'] +slug: /tools/sdk/go/v3/models/grant-type +tags: ['SDK', 'Software Development Kit', 'GrantType', 'GrantType'] +--- + +# GrantType + +## Enum + + +* `CLIENT_CREDENTIALS` (value: `"CLIENT_CREDENTIALS"`) + +* `AUTHORIZATION_CODE` (value: `"AUTHORIZATION_CODE"`) + +* `REFRESH_TOKEN` (value: `"REFRESH_TOKEN"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentitiesDetailsReportArguments.md b/docs/tools/sdk/go/Reference/V3/Models/IdentitiesDetailsReportArguments.md new file mode 100644 index 000000000..c07ac0ce7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentitiesDetailsReportArguments.md @@ -0,0 +1,59 @@ +--- +id: identities-details-report-arguments +title: IdentitiesDetailsReportArguments +pagination_label: IdentitiesDetailsReportArguments +sidebar_label: IdentitiesDetailsReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitiesDetailsReportArguments', 'IdentitiesDetailsReportArguments'] +slug: /tools/sdk/go/v3/models/identities-details-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentitiesDetailsReportArguments', 'IdentitiesDetailsReportArguments'] +--- + +# IdentitiesDetailsReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelatedOnly** | **bool** | Flag to specify if only correlated identities are included in report. | [default to false] + +## Methods + +### NewIdentitiesDetailsReportArguments + +`func NewIdentitiesDetailsReportArguments(correlatedOnly bool, ) *IdentitiesDetailsReportArguments` + +NewIdentitiesDetailsReportArguments instantiates a new IdentitiesDetailsReportArguments 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 + +### NewIdentitiesDetailsReportArgumentsWithDefaults + +`func NewIdentitiesDetailsReportArgumentsWithDefaults() *IdentitiesDetailsReportArguments` + +NewIdentitiesDetailsReportArgumentsWithDefaults instantiates a new IdentitiesDetailsReportArguments 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 + +### GetCorrelatedOnly + +`func (o *IdentitiesDetailsReportArguments) GetCorrelatedOnly() bool` + +GetCorrelatedOnly returns the CorrelatedOnly field if non-nil, zero value otherwise. + +### GetCorrelatedOnlyOk + +`func (o *IdentitiesDetailsReportArguments) GetCorrelatedOnlyOk() (*bool, bool)` + +GetCorrelatedOnlyOk returns a tuple with the CorrelatedOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedOnly + +`func (o *IdentitiesDetailsReportArguments) SetCorrelatedOnly(v bool)` + +SetCorrelatedOnly sets CorrelatedOnly field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentitiesReportArguments.md b/docs/tools/sdk/go/Reference/V3/Models/IdentitiesReportArguments.md new file mode 100644 index 000000000..03fc3103f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentitiesReportArguments.md @@ -0,0 +1,64 @@ +--- +id: identities-report-arguments +title: IdentitiesReportArguments +pagination_label: IdentitiesReportArguments +sidebar_label: IdentitiesReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitiesReportArguments', 'IdentitiesReportArguments'] +slug: /tools/sdk/go/v3/models/identities-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentitiesReportArguments', 'IdentitiesReportArguments'] +--- + +# IdentitiesReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelatedOnly** | Pointer to **bool** | Flag to specify if only correlated identities are included in report. | [optional] [default to false] + +## Methods + +### NewIdentitiesReportArguments + +`func NewIdentitiesReportArguments() *IdentitiesReportArguments` + +NewIdentitiesReportArguments instantiates a new IdentitiesReportArguments 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 + +### NewIdentitiesReportArgumentsWithDefaults + +`func NewIdentitiesReportArgumentsWithDefaults() *IdentitiesReportArguments` + +NewIdentitiesReportArgumentsWithDefaults instantiates a new IdentitiesReportArguments 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 + +### GetCorrelatedOnly + +`func (o *IdentitiesReportArguments) GetCorrelatedOnly() bool` + +GetCorrelatedOnly returns the CorrelatedOnly field if non-nil, zero value otherwise. + +### GetCorrelatedOnlyOk + +`func (o *IdentitiesReportArguments) GetCorrelatedOnlyOk() (*bool, bool)` + +GetCorrelatedOnlyOk returns a tuple with the CorrelatedOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedOnly + +`func (o *IdentitiesReportArguments) SetCorrelatedOnly(v bool)` + +SetCorrelatedOnly sets CorrelatedOnly field to given value. + +### HasCorrelatedOnly + +`func (o *IdentitiesReportArguments) HasCorrelatedOnly() bool` + +HasCorrelatedOnly returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityAccess.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityAccess.md new file mode 100644 index 000000000..c5e3c0209 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityAccess.md @@ -0,0 +1,386 @@ +--- +id: identity-access +title: IdentityAccess +pagination_label: IdentityAccess +sidebar_label: IdentityAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAccess', 'IdentityAccess'] +slug: /tools/sdk/go/v3/models/identity-access +tags: ['SDK', 'Software Development Kit', 'IdentityAccess', 'IdentityAccess'] +--- + +# IdentityAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Source** | Pointer to [**Reference**](reference) | | [optional] +**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional] +**Revocable** | Pointer to **bool** | | [optional] +**Privileged** | Pointer to **bool** | | [optional] +**Attribute** | Pointer to **string** | | [optional] +**Value** | Pointer to **string** | | [optional] +**Standalone** | Pointer to **bool** | | [optional] +**Disabled** | Pointer to **bool** | | [optional] + +## Methods + +### NewIdentityAccess + +`func NewIdentityAccess() *IdentityAccess` + +NewIdentityAccess instantiates a new IdentityAccess 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 + +### NewIdentityAccessWithDefaults + +`func NewIdentityAccessWithDefaults() *IdentityAccess` + +NewIdentityAccessWithDefaults instantiates a new IdentityAccess 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 + +### GetId + +`func (o *IdentityAccess) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityAccess) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityAccess) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityAccess) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityAccess) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityAccess) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityAccess) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityAccess) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *IdentityAccess) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityAccess) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityAccess) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityAccess) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *IdentityAccess) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *IdentityAccess) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *IdentityAccess) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *IdentityAccess) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *IdentityAccess) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *IdentityAccess) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *IdentityAccess) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityAccess) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityAccess) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityAccess) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetSource + +`func (o *IdentityAccess) GetSource() Reference` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *IdentityAccess) GetSourceOk() (*Reference, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *IdentityAccess) SetSource(v Reference)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *IdentityAccess) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetOwner + +`func (o *IdentityAccess) GetOwner() DisplayReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *IdentityAccess) GetOwnerOk() (*DisplayReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *IdentityAccess) SetOwner(v DisplayReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *IdentityAccess) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRevocable + +`func (o *IdentityAccess) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *IdentityAccess) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *IdentityAccess) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *IdentityAccess) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *IdentityAccess) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *IdentityAccess) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *IdentityAccess) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *IdentityAccess) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetAttribute + +`func (o *IdentityAccess) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *IdentityAccess) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *IdentityAccess) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *IdentityAccess) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *IdentityAccess) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *IdentityAccess) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *IdentityAccess) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *IdentityAccess) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetStandalone + +`func (o *IdentityAccess) GetStandalone() bool` + +GetStandalone returns the Standalone field if non-nil, zero value otherwise. + +### GetStandaloneOk + +`func (o *IdentityAccess) GetStandaloneOk() (*bool, bool)` + +GetStandaloneOk returns a tuple with the Standalone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStandalone + +`func (o *IdentityAccess) SetStandalone(v bool)` + +SetStandalone sets Standalone field to given value. + +### HasStandalone + +`func (o *IdentityAccess) HasStandalone() bool` + +HasStandalone returns a boolean if a field has been set. + +### GetDisabled + +`func (o *IdentityAccess) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *IdentityAccess) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *IdentityAccess) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *IdentityAccess) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityAttributeConfig.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityAttributeConfig.md new file mode 100644 index 000000000..514e5dc83 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityAttributeConfig.md @@ -0,0 +1,90 @@ +--- +id: identity-attribute-config +title: IdentityAttributeConfig +pagination_label: IdentityAttributeConfig +sidebar_label: IdentityAttributeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributeConfig', 'IdentityAttributeConfig'] +slug: /tools/sdk/go/v3/models/identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'IdentityAttributeConfig'] +--- + +# IdentityAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to false] +**AttributeTransforms** | Pointer to [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] + +## Methods + +### NewIdentityAttributeConfig + +`func NewIdentityAttributeConfig() *IdentityAttributeConfig` + +NewIdentityAttributeConfig instantiates a new IdentityAttributeConfig 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 + +### NewIdentityAttributeConfigWithDefaults + +`func NewIdentityAttributeConfigWithDefaults() *IdentityAttributeConfig` + +NewIdentityAttributeConfigWithDefaults instantiates a new IdentityAttributeConfig 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 + +### GetEnabled + +`func (o *IdentityAttributeConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *IdentityAttributeConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *IdentityAttributeConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *IdentityAttributeConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetAttributeTransforms + +`func (o *IdentityAttributeConfig) GetAttributeTransforms() []IdentityAttributeTransform` + +GetAttributeTransforms returns the AttributeTransforms field if non-nil, zero value otherwise. + +### GetAttributeTransformsOk + +`func (o *IdentityAttributeConfig) GetAttributeTransformsOk() (*[]IdentityAttributeTransform, bool)` + +GetAttributeTransformsOk returns a tuple with the AttributeTransforms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeTransforms + +`func (o *IdentityAttributeConfig) SetAttributeTransforms(v []IdentityAttributeTransform)` + +SetAttributeTransforms sets AttributeTransforms field to given value. + +### HasAttributeTransforms + +`func (o *IdentityAttributeConfig) HasAttributeTransforms() bool` + +HasAttributeTransforms returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityAttributePreview.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityAttributePreview.md new file mode 100644 index 000000000..358ceec4c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityAttributePreview.md @@ -0,0 +1,142 @@ +--- +id: identity-attribute-preview +title: IdentityAttributePreview +pagination_label: IdentityAttributePreview +sidebar_label: IdentityAttributePreview +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributePreview', 'IdentityAttributePreview'] +slug: /tools/sdk/go/v3/models/identity-attribute-preview +tags: ['SDK', 'Software Development Kit', 'IdentityAttributePreview', 'IdentityAttributePreview'] +--- + +# IdentityAttributePreview + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the attribute that is being previewed. | [optional] +**Value** | Pointer to **string** | Value that was derived during the preview. | [optional] +**PreviousValue** | Pointer to **string** | The value of the attribute before the preview. | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] + +## Methods + +### NewIdentityAttributePreview + +`func NewIdentityAttributePreview() *IdentityAttributePreview` + +NewIdentityAttributePreview instantiates a new IdentityAttributePreview 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 + +### NewIdentityAttributePreviewWithDefaults + +`func NewIdentityAttributePreviewWithDefaults() *IdentityAttributePreview` + +NewIdentityAttributePreviewWithDefaults instantiates a new IdentityAttributePreview 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 + +### GetName + +`func (o *IdentityAttributePreview) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityAttributePreview) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityAttributePreview) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityAttributePreview) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValue + +`func (o *IdentityAttributePreview) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *IdentityAttributePreview) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *IdentityAttributePreview) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *IdentityAttributePreview) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetPreviousValue + +`func (o *IdentityAttributePreview) GetPreviousValue() string` + +GetPreviousValue returns the PreviousValue field if non-nil, zero value otherwise. + +### GetPreviousValueOk + +`func (o *IdentityAttributePreview) GetPreviousValueOk() (*string, bool)` + +GetPreviousValueOk returns a tuple with the PreviousValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousValue + +`func (o *IdentityAttributePreview) SetPreviousValue(v string)` + +SetPreviousValue sets PreviousValue field to given value. + +### HasPreviousValue + +`func (o *IdentityAttributePreview) HasPreviousValue() bool` + +HasPreviousValue returns a boolean if a field has been set. + +### GetErrorMessages + +`func (o *IdentityAttributePreview) GetErrorMessages() []ErrorMessageDto` + +GetErrorMessages returns the ErrorMessages field if non-nil, zero value otherwise. + +### GetErrorMessagesOk + +`func (o *IdentityAttributePreview) GetErrorMessagesOk() (*[]ErrorMessageDto, bool)` + +GetErrorMessagesOk returns a tuple with the ErrorMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessages + +`func (o *IdentityAttributePreview) SetErrorMessages(v []ErrorMessageDto)` + +SetErrorMessages sets ErrorMessages field to given value. + +### HasErrorMessages + +`func (o *IdentityAttributePreview) HasErrorMessages() bool` + +HasErrorMessages returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityAttributeTransform.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityAttributeTransform.md new file mode 100644 index 000000000..5b50c9077 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityAttributeTransform.md @@ -0,0 +1,90 @@ +--- +id: identity-attribute-transform +title: IdentityAttributeTransform +pagination_label: IdentityAttributeTransform +sidebar_label: IdentityAttributeTransform +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityAttributeTransform', 'IdentityAttributeTransform'] +slug: /tools/sdk/go/v3/models/identity-attribute-transform +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'IdentityAttributeTransform'] +--- + +# IdentityAttributeTransform + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttributeName** | Pointer to **string** | Identity attribute's name. | [optional] +**TransformDefinition** | Pointer to [**TransformDefinition**](transform-definition) | | [optional] + +## Methods + +### NewIdentityAttributeTransform + +`func NewIdentityAttributeTransform() *IdentityAttributeTransform` + +NewIdentityAttributeTransform instantiates a new IdentityAttributeTransform 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 + +### NewIdentityAttributeTransformWithDefaults + +`func NewIdentityAttributeTransformWithDefaults() *IdentityAttributeTransform` + +NewIdentityAttributeTransformWithDefaults instantiates a new IdentityAttributeTransform 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 + +### GetIdentityAttributeName + +`func (o *IdentityAttributeTransform) GetIdentityAttributeName() string` + +GetIdentityAttributeName returns the IdentityAttributeName field if non-nil, zero value otherwise. + +### GetIdentityAttributeNameOk + +`func (o *IdentityAttributeTransform) GetIdentityAttributeNameOk() (*string, bool)` + +GetIdentityAttributeNameOk returns a tuple with the IdentityAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeName + +`func (o *IdentityAttributeTransform) SetIdentityAttributeName(v string)` + +SetIdentityAttributeName sets IdentityAttributeName field to given value. + +### HasIdentityAttributeName + +`func (o *IdentityAttributeTransform) HasIdentityAttributeName() bool` + +HasIdentityAttributeName returns a boolean if a field has been set. + +### GetTransformDefinition + +`func (o *IdentityAttributeTransform) GetTransformDefinition() TransformDefinition` + +GetTransformDefinition returns the TransformDefinition field if non-nil, zero value otherwise. + +### GetTransformDefinitionOk + +`func (o *IdentityAttributeTransform) GetTransformDefinitionOk() (*TransformDefinition, bool)` + +GetTransformDefinitionOk returns a tuple with the TransformDefinition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTransformDefinition + +`func (o *IdentityAttributeTransform) SetTransformDefinition(v TransformDefinition)` + +SetTransformDefinition sets TransformDefinition field to given value. + +### HasTransformDefinition + +`func (o *IdentityAttributeTransform) HasTransformDefinition() bool` + +HasTransformDefinition returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityCertDecisionSummary.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityCertDecisionSummary.md new file mode 100644 index 000000000..b30c53cbf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityCertDecisionSummary.md @@ -0,0 +1,454 @@ +--- +id: identity-cert-decision-summary +title: IdentityCertDecisionSummary +pagination_label: IdentityCertDecisionSummary +sidebar_label: IdentityCertDecisionSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCertDecisionSummary', 'IdentityCertDecisionSummary'] +slug: /tools/sdk/go/v3/models/identity-cert-decision-summary +tags: ['SDK', 'Software Development Kit', 'IdentityCertDecisionSummary', 'IdentityCertDecisionSummary'] +--- + +# IdentityCertDecisionSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EntitlementDecisionsMade** | Pointer to **int32** | Number of entitlement decisions that have been made | [optional] +**AccessProfileDecisionsMade** | Pointer to **int32** | Number of access profile decisions that have been made | [optional] +**RoleDecisionsMade** | Pointer to **int32** | Number of role decisions that have been made | [optional] +**AccountDecisionsMade** | Pointer to **int32** | Number of account decisions that have been made | [optional] +**EntitlementDecisionsTotal** | Pointer to **int32** | The total number of entitlement decisions on the certification, both complete and incomplete | [optional] +**AccessProfileDecisionsTotal** | Pointer to **int32** | The total number of access profile decisions on the certification, both complete and incomplete | [optional] +**RoleDecisionsTotal** | Pointer to **int32** | The total number of role decisions on the certification, both complete and incomplete | [optional] +**AccountDecisionsTotal** | Pointer to **int32** | The total number of account decisions on the certification, both complete and incomplete | [optional] +**EntitlementsApproved** | Pointer to **int32** | The number of entitlement decisions that have been made which were approved | [optional] +**EntitlementsRevoked** | Pointer to **int32** | The number of entitlement decisions that have been made which were revoked | [optional] +**AccessProfilesApproved** | Pointer to **int32** | The number of access profile decisions that have been made which were approved | [optional] +**AccessProfilesRevoked** | Pointer to **int32** | The number of access profile decisions that have been made which were revoked | [optional] +**RolesApproved** | Pointer to **int32** | The number of role decisions that have been made which were approved | [optional] +**RolesRevoked** | Pointer to **int32** | The number of role decisions that have been made which were revoked | [optional] +**AccountsApproved** | Pointer to **int32** | The number of account decisions that have been made which were approved | [optional] +**AccountsRevoked** | Pointer to **int32** | The number of account decisions that have been made which were revoked | [optional] + +## Methods + +### NewIdentityCertDecisionSummary + +`func NewIdentityCertDecisionSummary() *IdentityCertDecisionSummary` + +NewIdentityCertDecisionSummary instantiates a new IdentityCertDecisionSummary 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 + +### NewIdentityCertDecisionSummaryWithDefaults + +`func NewIdentityCertDecisionSummaryWithDefaults() *IdentityCertDecisionSummary` + +NewIdentityCertDecisionSummaryWithDefaults instantiates a new IdentityCertDecisionSummary 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 + +### GetEntitlementDecisionsMade + +`func (o *IdentityCertDecisionSummary) GetEntitlementDecisionsMade() int32` + +GetEntitlementDecisionsMade returns the EntitlementDecisionsMade field if non-nil, zero value otherwise. + +### GetEntitlementDecisionsMadeOk + +`func (o *IdentityCertDecisionSummary) GetEntitlementDecisionsMadeOk() (*int32, bool)` + +GetEntitlementDecisionsMadeOk returns a tuple with the EntitlementDecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementDecisionsMade + +`func (o *IdentityCertDecisionSummary) SetEntitlementDecisionsMade(v int32)` + +SetEntitlementDecisionsMade sets EntitlementDecisionsMade field to given value. + +### HasEntitlementDecisionsMade + +`func (o *IdentityCertDecisionSummary) HasEntitlementDecisionsMade() bool` + +HasEntitlementDecisionsMade returns a boolean if a field has been set. + +### GetAccessProfileDecisionsMade + +`func (o *IdentityCertDecisionSummary) GetAccessProfileDecisionsMade() int32` + +GetAccessProfileDecisionsMade returns the AccessProfileDecisionsMade field if non-nil, zero value otherwise. + +### GetAccessProfileDecisionsMadeOk + +`func (o *IdentityCertDecisionSummary) GetAccessProfileDecisionsMadeOk() (*int32, bool)` + +GetAccessProfileDecisionsMadeOk returns a tuple with the AccessProfileDecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileDecisionsMade + +`func (o *IdentityCertDecisionSummary) SetAccessProfileDecisionsMade(v int32)` + +SetAccessProfileDecisionsMade sets AccessProfileDecisionsMade field to given value. + +### HasAccessProfileDecisionsMade + +`func (o *IdentityCertDecisionSummary) HasAccessProfileDecisionsMade() bool` + +HasAccessProfileDecisionsMade returns a boolean if a field has been set. + +### GetRoleDecisionsMade + +`func (o *IdentityCertDecisionSummary) GetRoleDecisionsMade() int32` + +GetRoleDecisionsMade returns the RoleDecisionsMade field if non-nil, zero value otherwise. + +### GetRoleDecisionsMadeOk + +`func (o *IdentityCertDecisionSummary) GetRoleDecisionsMadeOk() (*int32, bool)` + +GetRoleDecisionsMadeOk returns a tuple with the RoleDecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleDecisionsMade + +`func (o *IdentityCertDecisionSummary) SetRoleDecisionsMade(v int32)` + +SetRoleDecisionsMade sets RoleDecisionsMade field to given value. + +### HasRoleDecisionsMade + +`func (o *IdentityCertDecisionSummary) HasRoleDecisionsMade() bool` + +HasRoleDecisionsMade returns a boolean if a field has been set. + +### GetAccountDecisionsMade + +`func (o *IdentityCertDecisionSummary) GetAccountDecisionsMade() int32` + +GetAccountDecisionsMade returns the AccountDecisionsMade field if non-nil, zero value otherwise. + +### GetAccountDecisionsMadeOk + +`func (o *IdentityCertDecisionSummary) GetAccountDecisionsMadeOk() (*int32, bool)` + +GetAccountDecisionsMadeOk returns a tuple with the AccountDecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountDecisionsMade + +`func (o *IdentityCertDecisionSummary) SetAccountDecisionsMade(v int32)` + +SetAccountDecisionsMade sets AccountDecisionsMade field to given value. + +### HasAccountDecisionsMade + +`func (o *IdentityCertDecisionSummary) HasAccountDecisionsMade() bool` + +HasAccountDecisionsMade returns a boolean if a field has been set. + +### GetEntitlementDecisionsTotal + +`func (o *IdentityCertDecisionSummary) GetEntitlementDecisionsTotal() int32` + +GetEntitlementDecisionsTotal returns the EntitlementDecisionsTotal field if non-nil, zero value otherwise. + +### GetEntitlementDecisionsTotalOk + +`func (o *IdentityCertDecisionSummary) GetEntitlementDecisionsTotalOk() (*int32, bool)` + +GetEntitlementDecisionsTotalOk returns a tuple with the EntitlementDecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementDecisionsTotal + +`func (o *IdentityCertDecisionSummary) SetEntitlementDecisionsTotal(v int32)` + +SetEntitlementDecisionsTotal sets EntitlementDecisionsTotal field to given value. + +### HasEntitlementDecisionsTotal + +`func (o *IdentityCertDecisionSummary) HasEntitlementDecisionsTotal() bool` + +HasEntitlementDecisionsTotal returns a boolean if a field has been set. + +### GetAccessProfileDecisionsTotal + +`func (o *IdentityCertDecisionSummary) GetAccessProfileDecisionsTotal() int32` + +GetAccessProfileDecisionsTotal returns the AccessProfileDecisionsTotal field if non-nil, zero value otherwise. + +### GetAccessProfileDecisionsTotalOk + +`func (o *IdentityCertDecisionSummary) GetAccessProfileDecisionsTotalOk() (*int32, bool)` + +GetAccessProfileDecisionsTotalOk returns a tuple with the AccessProfileDecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileDecisionsTotal + +`func (o *IdentityCertDecisionSummary) SetAccessProfileDecisionsTotal(v int32)` + +SetAccessProfileDecisionsTotal sets AccessProfileDecisionsTotal field to given value. + +### HasAccessProfileDecisionsTotal + +`func (o *IdentityCertDecisionSummary) HasAccessProfileDecisionsTotal() bool` + +HasAccessProfileDecisionsTotal returns a boolean if a field has been set. + +### GetRoleDecisionsTotal + +`func (o *IdentityCertDecisionSummary) GetRoleDecisionsTotal() int32` + +GetRoleDecisionsTotal returns the RoleDecisionsTotal field if non-nil, zero value otherwise. + +### GetRoleDecisionsTotalOk + +`func (o *IdentityCertDecisionSummary) GetRoleDecisionsTotalOk() (*int32, bool)` + +GetRoleDecisionsTotalOk returns a tuple with the RoleDecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleDecisionsTotal + +`func (o *IdentityCertDecisionSummary) SetRoleDecisionsTotal(v int32)` + +SetRoleDecisionsTotal sets RoleDecisionsTotal field to given value. + +### HasRoleDecisionsTotal + +`func (o *IdentityCertDecisionSummary) HasRoleDecisionsTotal() bool` + +HasRoleDecisionsTotal returns a boolean if a field has been set. + +### GetAccountDecisionsTotal + +`func (o *IdentityCertDecisionSummary) GetAccountDecisionsTotal() int32` + +GetAccountDecisionsTotal returns the AccountDecisionsTotal field if non-nil, zero value otherwise. + +### GetAccountDecisionsTotalOk + +`func (o *IdentityCertDecisionSummary) GetAccountDecisionsTotalOk() (*int32, bool)` + +GetAccountDecisionsTotalOk returns a tuple with the AccountDecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountDecisionsTotal + +`func (o *IdentityCertDecisionSummary) SetAccountDecisionsTotal(v int32)` + +SetAccountDecisionsTotal sets AccountDecisionsTotal field to given value. + +### HasAccountDecisionsTotal + +`func (o *IdentityCertDecisionSummary) HasAccountDecisionsTotal() bool` + +HasAccountDecisionsTotal returns a boolean if a field has been set. + +### GetEntitlementsApproved + +`func (o *IdentityCertDecisionSummary) GetEntitlementsApproved() int32` + +GetEntitlementsApproved returns the EntitlementsApproved field if non-nil, zero value otherwise. + +### GetEntitlementsApprovedOk + +`func (o *IdentityCertDecisionSummary) GetEntitlementsApprovedOk() (*int32, bool)` + +GetEntitlementsApprovedOk returns a tuple with the EntitlementsApproved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementsApproved + +`func (o *IdentityCertDecisionSummary) SetEntitlementsApproved(v int32)` + +SetEntitlementsApproved sets EntitlementsApproved field to given value. + +### HasEntitlementsApproved + +`func (o *IdentityCertDecisionSummary) HasEntitlementsApproved() bool` + +HasEntitlementsApproved returns a boolean if a field has been set. + +### GetEntitlementsRevoked + +`func (o *IdentityCertDecisionSummary) GetEntitlementsRevoked() int32` + +GetEntitlementsRevoked returns the EntitlementsRevoked field if non-nil, zero value otherwise. + +### GetEntitlementsRevokedOk + +`func (o *IdentityCertDecisionSummary) GetEntitlementsRevokedOk() (*int32, bool)` + +GetEntitlementsRevokedOk returns a tuple with the EntitlementsRevoked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementsRevoked + +`func (o *IdentityCertDecisionSummary) SetEntitlementsRevoked(v int32)` + +SetEntitlementsRevoked sets EntitlementsRevoked field to given value. + +### HasEntitlementsRevoked + +`func (o *IdentityCertDecisionSummary) HasEntitlementsRevoked() bool` + +HasEntitlementsRevoked returns a boolean if a field has been set. + +### GetAccessProfilesApproved + +`func (o *IdentityCertDecisionSummary) GetAccessProfilesApproved() int32` + +GetAccessProfilesApproved returns the AccessProfilesApproved field if non-nil, zero value otherwise. + +### GetAccessProfilesApprovedOk + +`func (o *IdentityCertDecisionSummary) GetAccessProfilesApprovedOk() (*int32, bool)` + +GetAccessProfilesApprovedOk returns a tuple with the AccessProfilesApproved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfilesApproved + +`func (o *IdentityCertDecisionSummary) SetAccessProfilesApproved(v int32)` + +SetAccessProfilesApproved sets AccessProfilesApproved field to given value. + +### HasAccessProfilesApproved + +`func (o *IdentityCertDecisionSummary) HasAccessProfilesApproved() bool` + +HasAccessProfilesApproved returns a boolean if a field has been set. + +### GetAccessProfilesRevoked + +`func (o *IdentityCertDecisionSummary) GetAccessProfilesRevoked() int32` + +GetAccessProfilesRevoked returns the AccessProfilesRevoked field if non-nil, zero value otherwise. + +### GetAccessProfilesRevokedOk + +`func (o *IdentityCertDecisionSummary) GetAccessProfilesRevokedOk() (*int32, bool)` + +GetAccessProfilesRevokedOk returns a tuple with the AccessProfilesRevoked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfilesRevoked + +`func (o *IdentityCertDecisionSummary) SetAccessProfilesRevoked(v int32)` + +SetAccessProfilesRevoked sets AccessProfilesRevoked field to given value. + +### HasAccessProfilesRevoked + +`func (o *IdentityCertDecisionSummary) HasAccessProfilesRevoked() bool` + +HasAccessProfilesRevoked returns a boolean if a field has been set. + +### GetRolesApproved + +`func (o *IdentityCertDecisionSummary) GetRolesApproved() int32` + +GetRolesApproved returns the RolesApproved field if non-nil, zero value otherwise. + +### GetRolesApprovedOk + +`func (o *IdentityCertDecisionSummary) GetRolesApprovedOk() (*int32, bool)` + +GetRolesApprovedOk returns a tuple with the RolesApproved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRolesApproved + +`func (o *IdentityCertDecisionSummary) SetRolesApproved(v int32)` + +SetRolesApproved sets RolesApproved field to given value. + +### HasRolesApproved + +`func (o *IdentityCertDecisionSummary) HasRolesApproved() bool` + +HasRolesApproved returns a boolean if a field has been set. + +### GetRolesRevoked + +`func (o *IdentityCertDecisionSummary) GetRolesRevoked() int32` + +GetRolesRevoked returns the RolesRevoked field if non-nil, zero value otherwise. + +### GetRolesRevokedOk + +`func (o *IdentityCertDecisionSummary) GetRolesRevokedOk() (*int32, bool)` + +GetRolesRevokedOk returns a tuple with the RolesRevoked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRolesRevoked + +`func (o *IdentityCertDecisionSummary) SetRolesRevoked(v int32)` + +SetRolesRevoked sets RolesRevoked field to given value. + +### HasRolesRevoked + +`func (o *IdentityCertDecisionSummary) HasRolesRevoked() bool` + +HasRolesRevoked returns a boolean if a field has been set. + +### GetAccountsApproved + +`func (o *IdentityCertDecisionSummary) GetAccountsApproved() int32` + +GetAccountsApproved returns the AccountsApproved field if non-nil, zero value otherwise. + +### GetAccountsApprovedOk + +`func (o *IdentityCertDecisionSummary) GetAccountsApprovedOk() (*int32, bool)` + +GetAccountsApprovedOk returns a tuple with the AccountsApproved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountsApproved + +`func (o *IdentityCertDecisionSummary) SetAccountsApproved(v int32)` + +SetAccountsApproved sets AccountsApproved field to given value. + +### HasAccountsApproved + +`func (o *IdentityCertDecisionSummary) HasAccountsApproved() bool` + +HasAccountsApproved returns a boolean if a field has been set. + +### GetAccountsRevoked + +`func (o *IdentityCertDecisionSummary) GetAccountsRevoked() int32` + +GetAccountsRevoked returns the AccountsRevoked field if non-nil, zero value otherwise. + +### GetAccountsRevokedOk + +`func (o *IdentityCertDecisionSummary) GetAccountsRevokedOk() (*int32, bool)` + +GetAccountsRevokedOk returns a tuple with the AccountsRevoked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountsRevoked + +`func (o *IdentityCertDecisionSummary) SetAccountsRevoked(v int32)` + +SetAccountsRevoked sets AccountsRevoked field to given value. + +### HasAccountsRevoked + +`func (o *IdentityCertDecisionSummary) HasAccountsRevoked() bool` + +HasAccountsRevoked returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityCertificationDto.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityCertificationDto.md new file mode 100644 index 000000000..4e43e28ca --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityCertificationDto.md @@ -0,0 +1,520 @@ +--- +id: identity-certification-dto +title: IdentityCertificationDto +pagination_label: IdentityCertificationDto +sidebar_label: IdentityCertificationDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityCertificationDto', 'IdentityCertificationDto'] +slug: /tools/sdk/go/v3/models/identity-certification-dto +tags: ['SDK', 'Software Development Kit', 'IdentityCertificationDto', 'IdentityCertificationDto'] +--- + +# IdentityCertificationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | id of the certification | [optional] +**Name** | Pointer to **string** | name of the certification | [optional] +**Campaign** | Pointer to [**CampaignReference**](campaign-reference) | | [optional] +**Completed** | Pointer to **bool** | Have all decisions been made? | [optional] +**IdentitiesCompleted** | Pointer to **int32** | The number of identities for whom all decisions have been made and are complete. | [optional] +**IdentitiesTotal** | Pointer to **int32** | The total number of identities in the Certification, both complete and incomplete. | [optional] +**Created** | Pointer to **SailPointTime** | created date | [optional] +**Modified** | Pointer to **SailPointTime** | modified date | [optional] +**DecisionsMade** | Pointer to **int32** | The number of approve/revoke/acknowledge decisions that have been made. | [optional] +**DecisionsTotal** | Pointer to **int32** | The total number of approve/revoke/acknowledge decisions. | [optional] +**Due** | Pointer to **NullableTime** | The due date of the certification. | [optional] +**Signed** | Pointer to **NullableTime** | The date the reviewer signed off on the Certification. | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] +**Reassignment** | Pointer to [**NullableReassignment**](reassignment) | | [optional] +**HasErrors** | Pointer to **bool** | Identifies if the certification has an error | [optional] +**ErrorMessage** | Pointer to **NullableString** | Description of the certification error | [optional] +**Phase** | Pointer to [**CertificationPhase**](certification-phase) | | [optional] + +## Methods + +### NewIdentityCertificationDto + +`func NewIdentityCertificationDto() *IdentityCertificationDto` + +NewIdentityCertificationDto instantiates a new IdentityCertificationDto 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 + +### NewIdentityCertificationDtoWithDefaults + +`func NewIdentityCertificationDtoWithDefaults() *IdentityCertificationDto` + +NewIdentityCertificationDtoWithDefaults instantiates a new IdentityCertificationDto 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 + +### GetId + +`func (o *IdentityCertificationDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityCertificationDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityCertificationDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityCertificationDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityCertificationDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityCertificationDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityCertificationDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityCertificationDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCampaign + +`func (o *IdentityCertificationDto) GetCampaign() CampaignReference` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *IdentityCertificationDto) GetCampaignOk() (*CampaignReference, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCampaign + +`func (o *IdentityCertificationDto) SetCampaign(v CampaignReference)` + +SetCampaign sets Campaign field to given value. + +### HasCampaign + +`func (o *IdentityCertificationDto) HasCampaign() bool` + +HasCampaign returns a boolean if a field has been set. + +### GetCompleted + +`func (o *IdentityCertificationDto) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *IdentityCertificationDto) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *IdentityCertificationDto) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *IdentityCertificationDto) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetIdentitiesCompleted + +`func (o *IdentityCertificationDto) GetIdentitiesCompleted() int32` + +GetIdentitiesCompleted returns the IdentitiesCompleted field if non-nil, zero value otherwise. + +### GetIdentitiesCompletedOk + +`func (o *IdentityCertificationDto) GetIdentitiesCompletedOk() (*int32, bool)` + +GetIdentitiesCompletedOk returns a tuple with the IdentitiesCompleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesCompleted + +`func (o *IdentityCertificationDto) SetIdentitiesCompleted(v int32)` + +SetIdentitiesCompleted sets IdentitiesCompleted field to given value. + +### HasIdentitiesCompleted + +`func (o *IdentityCertificationDto) HasIdentitiesCompleted() bool` + +HasIdentitiesCompleted returns a boolean if a field has been set. + +### GetIdentitiesTotal + +`func (o *IdentityCertificationDto) GetIdentitiesTotal() int32` + +GetIdentitiesTotal returns the IdentitiesTotal field if non-nil, zero value otherwise. + +### GetIdentitiesTotalOk + +`func (o *IdentityCertificationDto) GetIdentitiesTotalOk() (*int32, bool)` + +GetIdentitiesTotalOk returns a tuple with the IdentitiesTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentitiesTotal + +`func (o *IdentityCertificationDto) SetIdentitiesTotal(v int32)` + +SetIdentitiesTotal sets IdentitiesTotal field to given value. + +### HasIdentitiesTotal + +`func (o *IdentityCertificationDto) HasIdentitiesTotal() bool` + +HasIdentitiesTotal returns a boolean if a field has been set. + +### GetCreated + +`func (o *IdentityCertificationDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *IdentityCertificationDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *IdentityCertificationDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *IdentityCertificationDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *IdentityCertificationDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *IdentityCertificationDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *IdentityCertificationDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *IdentityCertificationDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDecisionsMade + +`func (o *IdentityCertificationDto) GetDecisionsMade() int32` + +GetDecisionsMade returns the DecisionsMade field if non-nil, zero value otherwise. + +### GetDecisionsMadeOk + +`func (o *IdentityCertificationDto) GetDecisionsMadeOk() (*int32, bool)` + +GetDecisionsMadeOk returns a tuple with the DecisionsMade field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsMade + +`func (o *IdentityCertificationDto) SetDecisionsMade(v int32)` + +SetDecisionsMade sets DecisionsMade field to given value. + +### HasDecisionsMade + +`func (o *IdentityCertificationDto) HasDecisionsMade() bool` + +HasDecisionsMade returns a boolean if a field has been set. + +### GetDecisionsTotal + +`func (o *IdentityCertificationDto) GetDecisionsTotal() int32` + +GetDecisionsTotal returns the DecisionsTotal field if non-nil, zero value otherwise. + +### GetDecisionsTotalOk + +`func (o *IdentityCertificationDto) GetDecisionsTotalOk() (*int32, bool)` + +GetDecisionsTotalOk returns a tuple with the DecisionsTotal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecisionsTotal + +`func (o *IdentityCertificationDto) SetDecisionsTotal(v int32)` + +SetDecisionsTotal sets DecisionsTotal field to given value. + +### HasDecisionsTotal + +`func (o *IdentityCertificationDto) HasDecisionsTotal() bool` + +HasDecisionsTotal returns a boolean if a field has been set. + +### GetDue + +`func (o *IdentityCertificationDto) GetDue() SailPointTime` + +GetDue returns the Due field if non-nil, zero value otherwise. + +### GetDueOk + +`func (o *IdentityCertificationDto) GetDueOk() (*SailPointTime, bool)` + +GetDueOk returns a tuple with the Due field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDue + +`func (o *IdentityCertificationDto) SetDue(v SailPointTime)` + +SetDue sets Due field to given value. + +### HasDue + +`func (o *IdentityCertificationDto) HasDue() bool` + +HasDue returns a boolean if a field has been set. + +### SetDueNil + +`func (o *IdentityCertificationDto) SetDueNil(b bool)` + + SetDueNil sets the value for Due to be an explicit nil + +### UnsetDue +`func (o *IdentityCertificationDto) UnsetDue()` + +UnsetDue ensures that no value is present for Due, not even an explicit nil +### GetSigned + +`func (o *IdentityCertificationDto) GetSigned() SailPointTime` + +GetSigned returns the Signed field if non-nil, zero value otherwise. + +### GetSignedOk + +`func (o *IdentityCertificationDto) GetSignedOk() (*SailPointTime, bool)` + +GetSignedOk returns a tuple with the Signed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSigned + +`func (o *IdentityCertificationDto) SetSigned(v SailPointTime)` + +SetSigned sets Signed field to given value. + +### HasSigned + +`func (o *IdentityCertificationDto) HasSigned() bool` + +HasSigned returns a boolean if a field has been set. + +### SetSignedNil + +`func (o *IdentityCertificationDto) SetSignedNil(b bool)` + + SetSignedNil sets the value for Signed to be an explicit nil + +### UnsetSigned +`func (o *IdentityCertificationDto) UnsetSigned()` + +UnsetSigned ensures that no value is present for Signed, not even an explicit nil +### GetReviewer + +`func (o *IdentityCertificationDto) GetReviewer() Reviewer` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *IdentityCertificationDto) GetReviewerOk() (*Reviewer, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *IdentityCertificationDto) SetReviewer(v Reviewer)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *IdentityCertificationDto) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetReassignment + +`func (o *IdentityCertificationDto) GetReassignment() Reassignment` + +GetReassignment returns the Reassignment field if non-nil, zero value otherwise. + +### GetReassignmentOk + +`func (o *IdentityCertificationDto) GetReassignmentOk() (*Reassignment, bool)` + +GetReassignmentOk returns a tuple with the Reassignment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignment + +`func (o *IdentityCertificationDto) SetReassignment(v Reassignment)` + +SetReassignment sets Reassignment field to given value. + +### HasReassignment + +`func (o *IdentityCertificationDto) HasReassignment() bool` + +HasReassignment returns a boolean if a field has been set. + +### SetReassignmentNil + +`func (o *IdentityCertificationDto) SetReassignmentNil(b bool)` + + SetReassignmentNil sets the value for Reassignment to be an explicit nil + +### UnsetReassignment +`func (o *IdentityCertificationDto) UnsetReassignment()` + +UnsetReassignment ensures that no value is present for Reassignment, not even an explicit nil +### GetHasErrors + +`func (o *IdentityCertificationDto) GetHasErrors() bool` + +GetHasErrors returns the HasErrors field if non-nil, zero value otherwise. + +### GetHasErrorsOk + +`func (o *IdentityCertificationDto) GetHasErrorsOk() (*bool, bool)` + +GetHasErrorsOk returns a tuple with the HasErrors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasErrors + +`func (o *IdentityCertificationDto) SetHasErrors(v bool)` + +SetHasErrors sets HasErrors field to given value. + +### HasHasErrors + +`func (o *IdentityCertificationDto) HasHasErrors() bool` + +HasHasErrors returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *IdentityCertificationDto) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *IdentityCertificationDto) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *IdentityCertificationDto) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *IdentityCertificationDto) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### SetErrorMessageNil + +`func (o *IdentityCertificationDto) SetErrorMessageNil(b bool)` + + SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil + +### UnsetErrorMessage +`func (o *IdentityCertificationDto) UnsetErrorMessage()` + +UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil +### GetPhase + +`func (o *IdentityCertificationDto) GetPhase() CertificationPhase` + +GetPhase returns the Phase field if non-nil, zero value otherwise. + +### GetPhaseOk + +`func (o *IdentityCertificationDto) GetPhaseOk() (*CertificationPhase, bool)` + +GetPhaseOk returns a tuple with the Phase field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhase + +`func (o *IdentityCertificationDto) SetPhase(v CertificationPhase)` + +SetPhase sets Phase field to given value. + +### HasPhase + +`func (o *IdentityCertificationDto) HasPhase() bool` + +HasPhase returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityDocument.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityDocument.md new file mode 100644 index 000000000..1ac26f12b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityDocument.md @@ -0,0 +1,1066 @@ +--- +id: identity-document +title: IdentityDocument +pagination_label: IdentityDocument +sidebar_label: IdentityDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDocument', 'IdentityDocument'] +slug: /tools/sdk/go/v3/models/identity-document +tags: ['SDK', 'Software Development Kit', 'IdentityDocument', 'IdentityDocument'] +--- + +# IdentityDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique ID of the referenced object. | +**Name** | **string** | The human readable name of the referenced object. | +**DisplayName** | Pointer to **string** | Identity's display name. | [optional] +**FirstName** | Pointer to **string** | Identity's first name. | [optional] +**LastName** | Pointer to **string** | Identity's last name. | [optional] +**Email** | Pointer to **string** | Identity's primary email address. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Phone** | Pointer to **string** | Identity's phone number. | [optional] +**Synced** | Pointer to **string** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Inactive** | Pointer to **bool** | Indicates whether the identity is inactive. | [optional] [default to false] +**Protected** | Pointer to **bool** | Indicates whether the identity is protected. | [optional] [default to false] +**Status** | Pointer to **string** | Identity's status in SailPoint. | [optional] +**EmployeeNumber** | Pointer to **string** | Identity's employee number. | [optional] +**Manager** | Pointer to [**NullableIdentityDocumentAllOfManager**](identity-document-all-of-manager) | | [optional] +**IsManager** | Pointer to **bool** | Indicates whether the identity is a manager of other identities. | [optional] +**IdentityProfile** | Pointer to [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional] +**Source** | Pointer to [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Map or dictionary of key/value pairs. | [optional] +**Disabled** | Pointer to **bool** | Indicates whether the identity is disabled. | [optional] [default to false] +**Locked** | Pointer to **bool** | Indicates whether the identity is locked. | [optional] [default to false] +**ProcessingState** | Pointer to **NullableString** | Identity's processing state. | [optional] +**ProcessingDetails** | Pointer to [**ProcessingDetails**](processing-details) | | [optional] +**Accounts** | Pointer to [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional] +**AccountCount** | Pointer to **int32** | Number of accounts associated with the identity. | [optional] +**Apps** | Pointer to [**[]App**](app) | List of applications the identity has access to. | [optional] +**AppCount** | Pointer to **int32** | Number of applications the identity has access to. | [optional] +**Access** | Pointer to [**[]IdentityAccess**](identity-access) | List of access items assigned to the identity. | [optional] +**AccessCount** | Pointer to **int32** | Number of access items assigned to the identity. | [optional] +**EntitlementCount** | Pointer to **int32** | Number of entitlements assigned to the identity. | [optional] +**RoleCount** | Pointer to **int32** | Number of roles assigned to the identity. | [optional] +**AccessProfileCount** | Pointer to **int32** | Number of access profiles assigned to the identity. | [optional] +**Owns** | Pointer to [**[]Owns**](owns) | Access items the identity owns. | [optional] +**OwnsCount** | Pointer to **int32** | Number of access items the identity owns. | [optional] +**Tags** | Pointer to **[]string** | Tags that have been applied to the object. | [optional] +**TagsCount** | Pointer to **int32** | Number of tags on the identity. | [optional] +**VisibleSegments** | Pointer to **[]string** | List of segments that the identity is in. | [optional] +**VisibleSegmentCount** | Pointer to **int32** | Number of segments the identity is in. | [optional] + +## Methods + +### NewIdentityDocument + +`func NewIdentityDocument(id string, name string, ) *IdentityDocument` + +NewIdentityDocument instantiates a new IdentityDocument 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 + +### NewIdentityDocumentWithDefaults + +`func NewIdentityDocumentWithDefaults() *IdentityDocument` + +NewIdentityDocumentWithDefaults instantiates a new IdentityDocument 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 + +### GetId + +`func (o *IdentityDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityDocument) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *IdentityDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityDocument) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDisplayName + +`func (o *IdentityDocument) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityDocument) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityDocument) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityDocument) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *IdentityDocument) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *IdentityDocument) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *IdentityDocument) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *IdentityDocument) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### GetLastName + +`func (o *IdentityDocument) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *IdentityDocument) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *IdentityDocument) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *IdentityDocument) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### GetEmail + +`func (o *IdentityDocument) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *IdentityDocument) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *IdentityDocument) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *IdentityDocument) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetCreated + +`func (o *IdentityDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *IdentityDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *IdentityDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *IdentityDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *IdentityDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *IdentityDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *IdentityDocument) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *IdentityDocument) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *IdentityDocument) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *IdentityDocument) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *IdentityDocument) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *IdentityDocument) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetPhone + +`func (o *IdentityDocument) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *IdentityDocument) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *IdentityDocument) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *IdentityDocument) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### GetSynced + +`func (o *IdentityDocument) GetSynced() string` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *IdentityDocument) GetSyncedOk() (*string, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *IdentityDocument) SetSynced(v string)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *IdentityDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### GetInactive + +`func (o *IdentityDocument) GetInactive() bool` + +GetInactive returns the Inactive field if non-nil, zero value otherwise. + +### GetInactiveOk + +`func (o *IdentityDocument) GetInactiveOk() (*bool, bool)` + +GetInactiveOk returns a tuple with the Inactive field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInactive + +`func (o *IdentityDocument) SetInactive(v bool)` + +SetInactive sets Inactive field to given value. + +### HasInactive + +`func (o *IdentityDocument) HasInactive() bool` + +HasInactive returns a boolean if a field has been set. + +### GetProtected + +`func (o *IdentityDocument) GetProtected() bool` + +GetProtected returns the Protected field if non-nil, zero value otherwise. + +### GetProtectedOk + +`func (o *IdentityDocument) GetProtectedOk() (*bool, bool)` + +GetProtectedOk returns a tuple with the Protected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProtected + +`func (o *IdentityDocument) SetProtected(v bool)` + +SetProtected sets Protected field to given value. + +### HasProtected + +`func (o *IdentityDocument) HasProtected() bool` + +HasProtected returns a boolean if a field has been set. + +### GetStatus + +`func (o *IdentityDocument) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *IdentityDocument) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *IdentityDocument) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *IdentityDocument) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetEmployeeNumber + +`func (o *IdentityDocument) GetEmployeeNumber() string` + +GetEmployeeNumber returns the EmployeeNumber field if non-nil, zero value otherwise. + +### GetEmployeeNumberOk + +`func (o *IdentityDocument) GetEmployeeNumberOk() (*string, bool)` + +GetEmployeeNumberOk returns a tuple with the EmployeeNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmployeeNumber + +`func (o *IdentityDocument) SetEmployeeNumber(v string)` + +SetEmployeeNumber sets EmployeeNumber field to given value. + +### HasEmployeeNumber + +`func (o *IdentityDocument) HasEmployeeNumber() bool` + +HasEmployeeNumber returns a boolean if a field has been set. + +### GetManager + +`func (o *IdentityDocument) GetManager() IdentityDocumentAllOfManager` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *IdentityDocument) GetManagerOk() (*IdentityDocumentAllOfManager, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *IdentityDocument) SetManager(v IdentityDocumentAllOfManager)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *IdentityDocument) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### SetManagerNil + +`func (o *IdentityDocument) SetManagerNil(b bool)` + + SetManagerNil sets the value for Manager to be an explicit nil + +### UnsetManager +`func (o *IdentityDocument) UnsetManager()` + +UnsetManager ensures that no value is present for Manager, not even an explicit nil +### GetIsManager + +`func (o *IdentityDocument) GetIsManager() bool` + +GetIsManager returns the IsManager field if non-nil, zero value otherwise. + +### GetIsManagerOk + +`func (o *IdentityDocument) GetIsManagerOk() (*bool, bool)` + +GetIsManagerOk returns a tuple with the IsManager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsManager + +`func (o *IdentityDocument) SetIsManager(v bool)` + +SetIsManager sets IsManager field to given value. + +### HasIsManager + +`func (o *IdentityDocument) HasIsManager() bool` + +HasIsManager returns a boolean if a field has been set. + +### GetIdentityProfile + +`func (o *IdentityDocument) GetIdentityProfile() IdentityDocumentAllOfIdentityProfile` + +GetIdentityProfile returns the IdentityProfile field if non-nil, zero value otherwise. + +### GetIdentityProfileOk + +`func (o *IdentityDocument) GetIdentityProfileOk() (*IdentityDocumentAllOfIdentityProfile, bool)` + +GetIdentityProfileOk returns a tuple with the IdentityProfile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityProfile + +`func (o *IdentityDocument) SetIdentityProfile(v IdentityDocumentAllOfIdentityProfile)` + +SetIdentityProfile sets IdentityProfile field to given value. + +### HasIdentityProfile + +`func (o *IdentityDocument) HasIdentityProfile() bool` + +HasIdentityProfile returns a boolean if a field has been set. + +### GetSource + +`func (o *IdentityDocument) GetSource() IdentityDocumentAllOfSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *IdentityDocument) GetSourceOk() (*IdentityDocumentAllOfSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *IdentityDocument) SetSource(v IdentityDocumentAllOfSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *IdentityDocument) HasSource() bool` + +HasSource returns a boolean if a field has been set. + +### GetAttributes + +`func (o *IdentityDocument) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *IdentityDocument) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *IdentityDocument) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *IdentityDocument) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetDisabled + +`func (o *IdentityDocument) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *IdentityDocument) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *IdentityDocument) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *IdentityDocument) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetLocked + +`func (o *IdentityDocument) GetLocked() bool` + +GetLocked returns the Locked field if non-nil, zero value otherwise. + +### GetLockedOk + +`func (o *IdentityDocument) GetLockedOk() (*bool, bool)` + +GetLockedOk returns a tuple with the Locked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocked + +`func (o *IdentityDocument) SetLocked(v bool)` + +SetLocked sets Locked field to given value. + +### HasLocked + +`func (o *IdentityDocument) HasLocked() bool` + +HasLocked returns a boolean if a field has been set. + +### GetProcessingState + +`func (o *IdentityDocument) GetProcessingState() string` + +GetProcessingState returns the ProcessingState field if non-nil, zero value otherwise. + +### GetProcessingStateOk + +`func (o *IdentityDocument) GetProcessingStateOk() (*string, bool)` + +GetProcessingStateOk returns a tuple with the ProcessingState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessingState + +`func (o *IdentityDocument) SetProcessingState(v string)` + +SetProcessingState sets ProcessingState field to given value. + +### HasProcessingState + +`func (o *IdentityDocument) HasProcessingState() bool` + +HasProcessingState returns a boolean if a field has been set. + +### SetProcessingStateNil + +`func (o *IdentityDocument) SetProcessingStateNil(b bool)` + + SetProcessingStateNil sets the value for ProcessingState to be an explicit nil + +### UnsetProcessingState +`func (o *IdentityDocument) UnsetProcessingState()` + +UnsetProcessingState ensures that no value is present for ProcessingState, not even an explicit nil +### GetProcessingDetails + +`func (o *IdentityDocument) GetProcessingDetails() ProcessingDetails` + +GetProcessingDetails returns the ProcessingDetails field if non-nil, zero value otherwise. + +### GetProcessingDetailsOk + +`func (o *IdentityDocument) GetProcessingDetailsOk() (*ProcessingDetails, bool)` + +GetProcessingDetailsOk returns a tuple with the ProcessingDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessingDetails + +`func (o *IdentityDocument) SetProcessingDetails(v ProcessingDetails)` + +SetProcessingDetails sets ProcessingDetails field to given value. + +### HasProcessingDetails + +`func (o *IdentityDocument) HasProcessingDetails() bool` + +HasProcessingDetails returns a boolean if a field has been set. + +### GetAccounts + +`func (o *IdentityDocument) GetAccounts() []BaseAccount` + +GetAccounts returns the Accounts field if non-nil, zero value otherwise. + +### GetAccountsOk + +`func (o *IdentityDocument) GetAccountsOk() (*[]BaseAccount, bool)` + +GetAccountsOk returns a tuple with the Accounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccounts + +`func (o *IdentityDocument) SetAccounts(v []BaseAccount)` + +SetAccounts sets Accounts field to given value. + +### HasAccounts + +`func (o *IdentityDocument) HasAccounts() bool` + +HasAccounts returns a boolean if a field has been set. + +### GetAccountCount + +`func (o *IdentityDocument) GetAccountCount() int32` + +GetAccountCount returns the AccountCount field if non-nil, zero value otherwise. + +### GetAccountCountOk + +`func (o *IdentityDocument) GetAccountCountOk() (*int32, bool)` + +GetAccountCountOk returns a tuple with the AccountCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCount + +`func (o *IdentityDocument) SetAccountCount(v int32)` + +SetAccountCount sets AccountCount field to given value. + +### HasAccountCount + +`func (o *IdentityDocument) HasAccountCount() bool` + +HasAccountCount returns a boolean if a field has been set. + +### GetApps + +`func (o *IdentityDocument) GetApps() []App` + +GetApps returns the Apps field if non-nil, zero value otherwise. + +### GetAppsOk + +`func (o *IdentityDocument) GetAppsOk() (*[]App, bool)` + +GetAppsOk returns a tuple with the Apps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApps + +`func (o *IdentityDocument) SetApps(v []App)` + +SetApps sets Apps field to given value. + +### HasApps + +`func (o *IdentityDocument) HasApps() bool` + +HasApps returns a boolean if a field has been set. + +### GetAppCount + +`func (o *IdentityDocument) GetAppCount() int32` + +GetAppCount returns the AppCount field if non-nil, zero value otherwise. + +### GetAppCountOk + +`func (o *IdentityDocument) GetAppCountOk() (*int32, bool)` + +GetAppCountOk returns a tuple with the AppCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAppCount + +`func (o *IdentityDocument) SetAppCount(v int32)` + +SetAppCount sets AppCount field to given value. + +### HasAppCount + +`func (o *IdentityDocument) HasAppCount() bool` + +HasAppCount returns a boolean if a field has been set. + +### GetAccess + +`func (o *IdentityDocument) GetAccess() []IdentityAccess` + +GetAccess returns the Access field if non-nil, zero value otherwise. + +### GetAccessOk + +`func (o *IdentityDocument) GetAccessOk() (*[]IdentityAccess, bool)` + +GetAccessOk returns a tuple with the Access field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccess + +`func (o *IdentityDocument) SetAccess(v []IdentityAccess)` + +SetAccess sets Access field to given value. + +### HasAccess + +`func (o *IdentityDocument) HasAccess() bool` + +HasAccess returns a boolean if a field has been set. + +### GetAccessCount + +`func (o *IdentityDocument) GetAccessCount() int32` + +GetAccessCount returns the AccessCount field if non-nil, zero value otherwise. + +### GetAccessCountOk + +`func (o *IdentityDocument) GetAccessCountOk() (*int32, bool)` + +GetAccessCountOk returns a tuple with the AccessCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessCount + +`func (o *IdentityDocument) SetAccessCount(v int32)` + +SetAccessCount sets AccessCount field to given value. + +### HasAccessCount + +`func (o *IdentityDocument) HasAccessCount() bool` + +HasAccessCount returns a boolean if a field has been set. + +### GetEntitlementCount + +`func (o *IdentityDocument) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *IdentityDocument) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *IdentityDocument) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *IdentityDocument) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### GetRoleCount + +`func (o *IdentityDocument) GetRoleCount() int32` + +GetRoleCount returns the RoleCount field if non-nil, zero value otherwise. + +### GetRoleCountOk + +`func (o *IdentityDocument) GetRoleCountOk() (*int32, bool)` + +GetRoleCountOk returns a tuple with the RoleCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleCount + +`func (o *IdentityDocument) SetRoleCount(v int32)` + +SetRoleCount sets RoleCount field to given value. + +### HasRoleCount + +`func (o *IdentityDocument) HasRoleCount() bool` + +HasRoleCount returns a boolean if a field has been set. + +### GetAccessProfileCount + +`func (o *IdentityDocument) GetAccessProfileCount() int32` + +GetAccessProfileCount returns the AccessProfileCount field if non-nil, zero value otherwise. + +### GetAccessProfileCountOk + +`func (o *IdentityDocument) GetAccessProfileCountOk() (*int32, bool)` + +GetAccessProfileCountOk returns a tuple with the AccessProfileCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileCount + +`func (o *IdentityDocument) SetAccessProfileCount(v int32)` + +SetAccessProfileCount sets AccessProfileCount field to given value. + +### HasAccessProfileCount + +`func (o *IdentityDocument) HasAccessProfileCount() bool` + +HasAccessProfileCount returns a boolean if a field has been set. + +### GetOwns + +`func (o *IdentityDocument) GetOwns() []Owns` + +GetOwns returns the Owns field if non-nil, zero value otherwise. + +### GetOwnsOk + +`func (o *IdentityDocument) GetOwnsOk() (*[]Owns, bool)` + +GetOwnsOk returns a tuple with the Owns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwns + +`func (o *IdentityDocument) SetOwns(v []Owns)` + +SetOwns sets Owns field to given value. + +### HasOwns + +`func (o *IdentityDocument) HasOwns() bool` + +HasOwns returns a boolean if a field has been set. + +### GetOwnsCount + +`func (o *IdentityDocument) GetOwnsCount() int32` + +GetOwnsCount returns the OwnsCount field if non-nil, zero value otherwise. + +### GetOwnsCountOk + +`func (o *IdentityDocument) GetOwnsCountOk() (*int32, bool)` + +GetOwnsCountOk returns a tuple with the OwnsCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnsCount + +`func (o *IdentityDocument) SetOwnsCount(v int32)` + +SetOwnsCount sets OwnsCount field to given value. + +### HasOwnsCount + +`func (o *IdentityDocument) HasOwnsCount() bool` + +HasOwnsCount returns a boolean if a field has been set. + +### GetTags + +`func (o *IdentityDocument) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *IdentityDocument) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *IdentityDocument) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *IdentityDocument) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetTagsCount + +`func (o *IdentityDocument) GetTagsCount() int32` + +GetTagsCount returns the TagsCount field if non-nil, zero value otherwise. + +### GetTagsCountOk + +`func (o *IdentityDocument) GetTagsCountOk() (*int32, bool)` + +GetTagsCountOk returns a tuple with the TagsCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTagsCount + +`func (o *IdentityDocument) SetTagsCount(v int32)` + +SetTagsCount sets TagsCount field to given value. + +### HasTagsCount + +`func (o *IdentityDocument) HasTagsCount() bool` + +HasTagsCount returns a boolean if a field has been set. + +### GetVisibleSegments + +`func (o *IdentityDocument) GetVisibleSegments() []string` + +GetVisibleSegments returns the VisibleSegments field if non-nil, zero value otherwise. + +### GetVisibleSegmentsOk + +`func (o *IdentityDocument) GetVisibleSegmentsOk() (*[]string, bool)` + +GetVisibleSegmentsOk returns a tuple with the VisibleSegments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVisibleSegments + +`func (o *IdentityDocument) SetVisibleSegments(v []string)` + +SetVisibleSegments sets VisibleSegments field to given value. + +### HasVisibleSegments + +`func (o *IdentityDocument) HasVisibleSegments() bool` + +HasVisibleSegments returns a boolean if a field has been set. + +### SetVisibleSegmentsNil + +`func (o *IdentityDocument) SetVisibleSegmentsNil(b bool)` + + SetVisibleSegmentsNil sets the value for VisibleSegments to be an explicit nil + +### UnsetVisibleSegments +`func (o *IdentityDocument) UnsetVisibleSegments()` + +UnsetVisibleSegments ensures that no value is present for VisibleSegments, not even an explicit nil +### GetVisibleSegmentCount + +`func (o *IdentityDocument) GetVisibleSegmentCount() int32` + +GetVisibleSegmentCount returns the VisibleSegmentCount field if non-nil, zero value otherwise. + +### GetVisibleSegmentCountOk + +`func (o *IdentityDocument) GetVisibleSegmentCountOk() (*int32, bool)` + +GetVisibleSegmentCountOk returns a tuple with the VisibleSegmentCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVisibleSegmentCount + +`func (o *IdentityDocument) SetVisibleSegmentCount(v int32)` + +SetVisibleSegmentCount sets VisibleSegmentCount field to given value. + +### HasVisibleSegmentCount + +`func (o *IdentityDocument) HasVisibleSegmentCount() bool` + +HasVisibleSegmentCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityDocumentAllOfIdentityProfile.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityDocumentAllOfIdentityProfile.md new file mode 100644 index 000000000..8481fbe1b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityDocumentAllOfIdentityProfile.md @@ -0,0 +1,90 @@ +--- +id: identity-document-all-of-identity-profile +title: IdentityDocumentAllOfIdentityProfile +pagination_label: IdentityDocumentAllOfIdentityProfile +sidebar_label: IdentityDocumentAllOfIdentityProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDocumentAllOfIdentityProfile', 'IdentityDocumentAllOfIdentityProfile'] +slug: /tools/sdk/go/v3/models/identity-document-all-of-identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfIdentityProfile', 'IdentityDocumentAllOfIdentityProfile'] +--- + +# IdentityDocumentAllOfIdentityProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Identity profile's ID. | [optional] +**Name** | Pointer to **string** | Identity profile's name. | [optional] + +## Methods + +### NewIdentityDocumentAllOfIdentityProfile + +`func NewIdentityDocumentAllOfIdentityProfile() *IdentityDocumentAllOfIdentityProfile` + +NewIdentityDocumentAllOfIdentityProfile instantiates a new IdentityDocumentAllOfIdentityProfile 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 + +### NewIdentityDocumentAllOfIdentityProfileWithDefaults + +`func NewIdentityDocumentAllOfIdentityProfileWithDefaults() *IdentityDocumentAllOfIdentityProfile` + +NewIdentityDocumentAllOfIdentityProfileWithDefaults instantiates a new IdentityDocumentAllOfIdentityProfile 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 + +### GetId + +`func (o *IdentityDocumentAllOfIdentityProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityDocumentAllOfIdentityProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityDocumentAllOfIdentityProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityDocumentAllOfIdentityProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityDocumentAllOfIdentityProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityDocumentAllOfIdentityProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityDocumentAllOfIdentityProfile) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityDocumentAllOfIdentityProfile) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityDocumentAllOfManager.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityDocumentAllOfManager.md new file mode 100644 index 000000000..b63359062 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityDocumentAllOfManager.md @@ -0,0 +1,116 @@ +--- +id: identity-document-all-of-manager +title: IdentityDocumentAllOfManager +pagination_label: IdentityDocumentAllOfManager +sidebar_label: IdentityDocumentAllOfManager +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDocumentAllOfManager', 'IdentityDocumentAllOfManager'] +slug: /tools/sdk/go/v3/models/identity-document-all-of-manager +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfManager', 'IdentityDocumentAllOfManager'] +--- + +# IdentityDocumentAllOfManager + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of identity's manager. | [optional] +**Name** | Pointer to **string** | Name of identity's manager. | [optional] +**DisplayName** | Pointer to **string** | Display name of identity's manager. | [optional] + +## Methods + +### NewIdentityDocumentAllOfManager + +`func NewIdentityDocumentAllOfManager() *IdentityDocumentAllOfManager` + +NewIdentityDocumentAllOfManager instantiates a new IdentityDocumentAllOfManager 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 + +### NewIdentityDocumentAllOfManagerWithDefaults + +`func NewIdentityDocumentAllOfManagerWithDefaults() *IdentityDocumentAllOfManager` + +NewIdentityDocumentAllOfManagerWithDefaults instantiates a new IdentityDocumentAllOfManager 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 + +### GetId + +`func (o *IdentityDocumentAllOfManager) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityDocumentAllOfManager) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityDocumentAllOfManager) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityDocumentAllOfManager) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityDocumentAllOfManager) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityDocumentAllOfManager) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityDocumentAllOfManager) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityDocumentAllOfManager) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *IdentityDocumentAllOfManager) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *IdentityDocumentAllOfManager) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *IdentityDocumentAllOfManager) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *IdentityDocumentAllOfManager) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityDocumentAllOfSource.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityDocumentAllOfSource.md new file mode 100644 index 000000000..6206a52fd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityDocumentAllOfSource.md @@ -0,0 +1,90 @@ +--- +id: identity-document-all-of-source +title: IdentityDocumentAllOfSource +pagination_label: IdentityDocumentAllOfSource +sidebar_label: IdentityDocumentAllOfSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityDocumentAllOfSource', 'IdentityDocumentAllOfSource'] +slug: /tools/sdk/go/v3/models/identity-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfSource', 'IdentityDocumentAllOfSource'] +--- + +# IdentityDocumentAllOfSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of identity's source. | [optional] +**Name** | Pointer to **string** | Display name of identity's source. | [optional] + +## Methods + +### NewIdentityDocumentAllOfSource + +`func NewIdentityDocumentAllOfSource() *IdentityDocumentAllOfSource` + +NewIdentityDocumentAllOfSource instantiates a new IdentityDocumentAllOfSource 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 + +### NewIdentityDocumentAllOfSourceWithDefaults + +`func NewIdentityDocumentAllOfSourceWithDefaults() *IdentityDocumentAllOfSource` + +NewIdentityDocumentAllOfSourceWithDefaults instantiates a new IdentityDocumentAllOfSource 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 + +### GetId + +`func (o *IdentityDocumentAllOfSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityDocumentAllOfSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityDocumentAllOfSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityDocumentAllOfSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityDocumentAllOfSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityDocumentAllOfSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityDocumentAllOfSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityDocumentAllOfSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityExceptionReportReference.md new file mode 100644 index 000000000..9e6b5ece4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityExceptionReportReference.md @@ -0,0 +1,90 @@ +--- +id: identity-exception-report-reference +title: IdentityExceptionReportReference +pagination_label: IdentityExceptionReportReference +sidebar_label: IdentityExceptionReportReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityExceptionReportReference', 'IdentityExceptionReportReference'] +slug: /tools/sdk/go/v3/models/identity-exception-report-reference +tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'IdentityExceptionReportReference'] +--- + +# IdentityExceptionReportReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TaskResultId** | Pointer to **string** | Task result ID. | [optional] +**ReportName** | Pointer to **string** | Report name. | [optional] + +## Methods + +### NewIdentityExceptionReportReference + +`func NewIdentityExceptionReportReference() *IdentityExceptionReportReference` + +NewIdentityExceptionReportReference instantiates a new IdentityExceptionReportReference 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 + +### NewIdentityExceptionReportReferenceWithDefaults + +`func NewIdentityExceptionReportReferenceWithDefaults() *IdentityExceptionReportReference` + +NewIdentityExceptionReportReferenceWithDefaults instantiates a new IdentityExceptionReportReference 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 + +### GetTaskResultId + +`func (o *IdentityExceptionReportReference) GetTaskResultId() string` + +GetTaskResultId returns the TaskResultId field if non-nil, zero value otherwise. + +### GetTaskResultIdOk + +`func (o *IdentityExceptionReportReference) GetTaskResultIdOk() (*string, bool)` + +GetTaskResultIdOk returns a tuple with the TaskResultId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskResultId + +`func (o *IdentityExceptionReportReference) SetTaskResultId(v string)` + +SetTaskResultId sets TaskResultId field to given value. + +### HasTaskResultId + +`func (o *IdentityExceptionReportReference) HasTaskResultId() bool` + +HasTaskResultId returns a boolean if a field has been set. + +### GetReportName + +`func (o *IdentityExceptionReportReference) GetReportName() string` + +GetReportName returns the ReportName field if non-nil, zero value otherwise. + +### GetReportNameOk + +`func (o *IdentityExceptionReportReference) GetReportNameOk() (*string, bool)` + +GetReportNameOk returns a tuple with the ReportName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportName + +`func (o *IdentityExceptionReportReference) SetReportName(v string)` + +SetReportName sets ReportName field to given value. + +### HasReportName + +`func (o *IdentityExceptionReportReference) HasReportName() bool` + +HasReportName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityPreviewRequest.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityPreviewRequest.md new file mode 100644 index 000000000..1400ab967 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityPreviewRequest.md @@ -0,0 +1,90 @@ +--- +id: identity-preview-request +title: IdentityPreviewRequest +pagination_label: IdentityPreviewRequest +sidebar_label: IdentityPreviewRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityPreviewRequest', 'IdentityPreviewRequest'] +slug: /tools/sdk/go/v3/models/identity-preview-request +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewRequest', 'IdentityPreviewRequest'] +--- + +# IdentityPreviewRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | The Identity id | [optional] +**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] + +## Methods + +### NewIdentityPreviewRequest + +`func NewIdentityPreviewRequest() *IdentityPreviewRequest` + +NewIdentityPreviewRequest instantiates a new IdentityPreviewRequest 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 + +### NewIdentityPreviewRequestWithDefaults + +`func NewIdentityPreviewRequestWithDefaults() *IdentityPreviewRequest` + +NewIdentityPreviewRequestWithDefaults instantiates a new IdentityPreviewRequest 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 + +### GetIdentityId + +`func (o *IdentityPreviewRequest) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *IdentityPreviewRequest) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *IdentityPreviewRequest) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *IdentityPreviewRequest) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetIdentityAttributeConfig + +`func (o *IdentityPreviewRequest) GetIdentityAttributeConfig() IdentityAttributeConfig` + +GetIdentityAttributeConfig returns the IdentityAttributeConfig field if non-nil, zero value otherwise. + +### GetIdentityAttributeConfigOk + +`func (o *IdentityPreviewRequest) GetIdentityAttributeConfigOk() (*IdentityAttributeConfig, bool)` + +GetIdentityAttributeConfigOk returns a tuple with the IdentityAttributeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeConfig + +`func (o *IdentityPreviewRequest) SetIdentityAttributeConfig(v IdentityAttributeConfig)` + +SetIdentityAttributeConfig sets IdentityAttributeConfig field to given value. + +### HasIdentityAttributeConfig + +`func (o *IdentityPreviewRequest) HasIdentityAttributeConfig() bool` + +HasIdentityAttributeConfig returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityPreviewResponse.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityPreviewResponse.md new file mode 100644 index 000000000..120b5add8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityPreviewResponse.md @@ -0,0 +1,90 @@ +--- +id: identity-preview-response +title: IdentityPreviewResponse +pagination_label: IdentityPreviewResponse +sidebar_label: IdentityPreviewResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityPreviewResponse', 'IdentityPreviewResponse'] +slug: /tools/sdk/go/v3/models/identity-preview-response +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponse', 'IdentityPreviewResponse'] +--- + +# IdentityPreviewResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**IdentityPreviewResponseIdentity**](identity-preview-response-identity) | | [optional] +**PreviewAttributes** | Pointer to [**[]IdentityAttributePreview**](identity-attribute-preview) | | [optional] + +## Methods + +### NewIdentityPreviewResponse + +`func NewIdentityPreviewResponse() *IdentityPreviewResponse` + +NewIdentityPreviewResponse instantiates a new IdentityPreviewResponse 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 + +### NewIdentityPreviewResponseWithDefaults + +`func NewIdentityPreviewResponseWithDefaults() *IdentityPreviewResponse` + +NewIdentityPreviewResponseWithDefaults instantiates a new IdentityPreviewResponse 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 + +### GetIdentity + +`func (o *IdentityPreviewResponse) GetIdentity() IdentityPreviewResponseIdentity` + +GetIdentity returns the Identity field if non-nil, zero value otherwise. + +### GetIdentityOk + +`func (o *IdentityPreviewResponse) GetIdentityOk() (*IdentityPreviewResponseIdentity, bool)` + +GetIdentityOk returns a tuple with the Identity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentity + +`func (o *IdentityPreviewResponse) SetIdentity(v IdentityPreviewResponseIdentity)` + +SetIdentity sets Identity field to given value. + +### HasIdentity + +`func (o *IdentityPreviewResponse) HasIdentity() bool` + +HasIdentity returns a boolean if a field has been set. + +### GetPreviewAttributes + +`func (o *IdentityPreviewResponse) GetPreviewAttributes() []IdentityAttributePreview` + +GetPreviewAttributes returns the PreviewAttributes field if non-nil, zero value otherwise. + +### GetPreviewAttributesOk + +`func (o *IdentityPreviewResponse) GetPreviewAttributesOk() (*[]IdentityAttributePreview, bool)` + +GetPreviewAttributesOk returns a tuple with the PreviewAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviewAttributes + +`func (o *IdentityPreviewResponse) SetPreviewAttributes(v []IdentityAttributePreview)` + +SetPreviewAttributes sets PreviewAttributes field to given value. + +### HasPreviewAttributes + +`func (o *IdentityPreviewResponse) HasPreviewAttributes() bool` + +HasPreviewAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityPreviewResponseIdentity.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityPreviewResponseIdentity.md new file mode 100644 index 000000000..46116d49e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityPreviewResponseIdentity.md @@ -0,0 +1,116 @@ +--- +id: identity-preview-response-identity +title: IdentityPreviewResponseIdentity +pagination_label: IdentityPreviewResponseIdentity +sidebar_label: IdentityPreviewResponseIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityPreviewResponseIdentity', 'IdentityPreviewResponseIdentity'] +slug: /tools/sdk/go/v3/models/identity-preview-response-identity +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponseIdentity', 'IdentityPreviewResponseIdentity'] +--- + +# IdentityPreviewResponseIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Identity's DTO type. | [optional] +**Id** | Pointer to **string** | Identity ID. | [optional] +**Name** | Pointer to **string** | Identity's display name. | [optional] + +## Methods + +### NewIdentityPreviewResponseIdentity + +`func NewIdentityPreviewResponseIdentity() *IdentityPreviewResponseIdentity` + +NewIdentityPreviewResponseIdentity instantiates a new IdentityPreviewResponseIdentity 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 + +### NewIdentityPreviewResponseIdentityWithDefaults + +`func NewIdentityPreviewResponseIdentityWithDefaults() *IdentityPreviewResponseIdentity` + +NewIdentityPreviewResponseIdentityWithDefaults instantiates a new IdentityPreviewResponseIdentity 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 + +### GetType + +`func (o *IdentityPreviewResponseIdentity) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityPreviewResponseIdentity) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityPreviewResponseIdentity) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityPreviewResponseIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityPreviewResponseIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityPreviewResponseIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityPreviewResponseIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityPreviewResponseIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityPreviewResponseIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityPreviewResponseIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityPreviewResponseIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityPreviewResponseIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityProfile.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityProfile.md new file mode 100644 index 000000000..e995b2d33 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityProfile.md @@ -0,0 +1,406 @@ +--- +id: identity-profile +title: IdentityProfile +pagination_label: IdentityProfile +sidebar_label: IdentityProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfile', 'IdentityProfile'] +slug: /tools/sdk/go/v3/models/identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityProfile', 'IdentityProfile'] +--- + +# IdentityProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Description** | Pointer to **NullableString** | Identity profile's description. | [optional] +**Owner** | Pointer to [**NullableIdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] +**Priority** | Pointer to **int64** | Identity profile's priority. | [optional] +**AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | +**IdentityRefreshRequired** | Pointer to **bool** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to false] +**IdentityCount** | Pointer to **int32** | Number of identities belonging to the identity profile. | [optional] +**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] +**IdentityExceptionReportReference** | Pointer to [**NullableIdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] +**HasTimeBasedAttr** | Pointer to **bool** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to false] + +## Methods + +### NewIdentityProfile + +`func NewIdentityProfile(name NullableString, authoritativeSource IdentityProfileAllOfAuthoritativeSource, ) *IdentityProfile` + +NewIdentityProfile instantiates a new IdentityProfile 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 + +### NewIdentityProfileWithDefaults + +`func NewIdentityProfileWithDefaults() *IdentityProfile` + +NewIdentityProfileWithDefaults instantiates a new IdentityProfile 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 + +### GetId + +`func (o *IdentityProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfile) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *IdentityProfile) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *IdentityProfile) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *IdentityProfile) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *IdentityProfile) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *IdentityProfile) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *IdentityProfile) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *IdentityProfile) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *IdentityProfile) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *IdentityProfile) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *IdentityProfile) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *IdentityProfile) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *IdentityProfile) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *IdentityProfile) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *IdentityProfile) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *IdentityProfile) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *IdentityProfile) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwner + +`func (o *IdentityProfile) GetOwner() IdentityProfileAllOfOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *IdentityProfile) GetOwnerOk() (*IdentityProfileAllOfOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *IdentityProfile) SetOwner(v IdentityProfileAllOfOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *IdentityProfile) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *IdentityProfile) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *IdentityProfile) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetPriority + +`func (o *IdentityProfile) GetPriority() int64` + +GetPriority returns the Priority field if non-nil, zero value otherwise. + +### GetPriorityOk + +`func (o *IdentityProfile) GetPriorityOk() (*int64, 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 *IdentityProfile) SetPriority(v int64)` + +SetPriority sets Priority field to given value. + +### HasPriority + +`func (o *IdentityProfile) HasPriority() bool` + +HasPriority returns a boolean if a field has been set. + +### GetAuthoritativeSource + +`func (o *IdentityProfile) GetAuthoritativeSource() IdentityProfileAllOfAuthoritativeSource` + +GetAuthoritativeSource returns the AuthoritativeSource field if non-nil, zero value otherwise. + +### GetAuthoritativeSourceOk + +`func (o *IdentityProfile) GetAuthoritativeSourceOk() (*IdentityProfileAllOfAuthoritativeSource, bool)` + +GetAuthoritativeSourceOk returns a tuple with the AuthoritativeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritativeSource + +`func (o *IdentityProfile) SetAuthoritativeSource(v IdentityProfileAllOfAuthoritativeSource)` + +SetAuthoritativeSource sets AuthoritativeSource field to given value. + + +### GetIdentityRefreshRequired + +`func (o *IdentityProfile) GetIdentityRefreshRequired() bool` + +GetIdentityRefreshRequired returns the IdentityRefreshRequired field if non-nil, zero value otherwise. + +### GetIdentityRefreshRequiredOk + +`func (o *IdentityProfile) GetIdentityRefreshRequiredOk() (*bool, bool)` + +GetIdentityRefreshRequiredOk returns a tuple with the IdentityRefreshRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityRefreshRequired + +`func (o *IdentityProfile) SetIdentityRefreshRequired(v bool)` + +SetIdentityRefreshRequired sets IdentityRefreshRequired field to given value. + +### HasIdentityRefreshRequired + +`func (o *IdentityProfile) HasIdentityRefreshRequired() bool` + +HasIdentityRefreshRequired returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *IdentityProfile) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *IdentityProfile) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *IdentityProfile) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *IdentityProfile) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetIdentityAttributeConfig + +`func (o *IdentityProfile) GetIdentityAttributeConfig() IdentityAttributeConfig` + +GetIdentityAttributeConfig returns the IdentityAttributeConfig field if non-nil, zero value otherwise. + +### GetIdentityAttributeConfigOk + +`func (o *IdentityProfile) GetIdentityAttributeConfigOk() (*IdentityAttributeConfig, bool)` + +GetIdentityAttributeConfigOk returns a tuple with the IdentityAttributeConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeConfig + +`func (o *IdentityProfile) SetIdentityAttributeConfig(v IdentityAttributeConfig)` + +SetIdentityAttributeConfig sets IdentityAttributeConfig field to given value. + +### HasIdentityAttributeConfig + +`func (o *IdentityProfile) HasIdentityAttributeConfig() bool` + +HasIdentityAttributeConfig returns a boolean if a field has been set. + +### GetIdentityExceptionReportReference + +`func (o *IdentityProfile) GetIdentityExceptionReportReference() IdentityExceptionReportReference` + +GetIdentityExceptionReportReference returns the IdentityExceptionReportReference field if non-nil, zero value otherwise. + +### GetIdentityExceptionReportReferenceOk + +`func (o *IdentityProfile) GetIdentityExceptionReportReferenceOk() (*IdentityExceptionReportReference, bool)` + +GetIdentityExceptionReportReferenceOk returns a tuple with the IdentityExceptionReportReference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityExceptionReportReference + +`func (o *IdentityProfile) SetIdentityExceptionReportReference(v IdentityExceptionReportReference)` + +SetIdentityExceptionReportReference sets IdentityExceptionReportReference field to given value. + +### HasIdentityExceptionReportReference + +`func (o *IdentityProfile) HasIdentityExceptionReportReference() bool` + +HasIdentityExceptionReportReference returns a boolean if a field has been set. + +### SetIdentityExceptionReportReferenceNil + +`func (o *IdentityProfile) SetIdentityExceptionReportReferenceNil(b bool)` + + SetIdentityExceptionReportReferenceNil sets the value for IdentityExceptionReportReference to be an explicit nil + +### UnsetIdentityExceptionReportReference +`func (o *IdentityProfile) UnsetIdentityExceptionReportReference()` + +UnsetIdentityExceptionReportReference ensures that no value is present for IdentityExceptionReportReference, not even an explicit nil +### GetHasTimeBasedAttr + +`func (o *IdentityProfile) GetHasTimeBasedAttr() bool` + +GetHasTimeBasedAttr returns the HasTimeBasedAttr field if non-nil, zero value otherwise. + +### GetHasTimeBasedAttrOk + +`func (o *IdentityProfile) GetHasTimeBasedAttrOk() (*bool, bool)` + +GetHasTimeBasedAttrOk returns a tuple with the HasTimeBasedAttr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasTimeBasedAttr + +`func (o *IdentityProfile) SetHasTimeBasedAttr(v bool)` + +SetHasTimeBasedAttr sets HasTimeBasedAttr field to given value. + +### HasHasTimeBasedAttr + +`func (o *IdentityProfile) HasHasTimeBasedAttr() bool` + +HasHasTimeBasedAttr returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md new file mode 100644 index 000000000..29ae0139d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -0,0 +1,116 @@ +--- +id: identity-profile-all-of-authoritative-source +title: IdentityProfileAllOfAuthoritativeSource +pagination_label: IdentityProfileAllOfAuthoritativeSource +sidebar_label: IdentityProfileAllOfAuthoritativeSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileAllOfAuthoritativeSource', 'IdentityProfileAllOfAuthoritativeSource'] +slug: /tools/sdk/go/v3/models/identity-profile-all-of-authoritative-source +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSource', 'IdentityProfileAllOfAuthoritativeSource'] +--- + +# IdentityProfileAllOfAuthoritativeSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Authoritative source's object type. | [optional] +**Id** | Pointer to **string** | Authoritative source's ID. | [optional] +**Name** | Pointer to **string** | Authoritative source's name. | [optional] + +## Methods + +### NewIdentityProfileAllOfAuthoritativeSource + +`func NewIdentityProfileAllOfAuthoritativeSource() *IdentityProfileAllOfAuthoritativeSource` + +NewIdentityProfileAllOfAuthoritativeSource instantiates a new IdentityProfileAllOfAuthoritativeSource 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 + +### NewIdentityProfileAllOfAuthoritativeSourceWithDefaults + +`func NewIdentityProfileAllOfAuthoritativeSourceWithDefaults() *IdentityProfileAllOfAuthoritativeSource` + +NewIdentityProfileAllOfAuthoritativeSourceWithDefaults instantiates a new IdentityProfileAllOfAuthoritativeSource 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 + +### GetType + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityProfileAllOfAuthoritativeSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityProfileAllOfAuthoritativeSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfileAllOfAuthoritativeSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfileAllOfAuthoritativeSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfileAllOfAuthoritativeSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfileAllOfAuthoritativeSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityProfileAllOfAuthoritativeSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityProfileAllOfOwner.md new file mode 100644 index 000000000..eeae11378 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityProfileAllOfOwner.md @@ -0,0 +1,116 @@ +--- +id: identity-profile-all-of-owner +title: IdentityProfileAllOfOwner +pagination_label: IdentityProfileAllOfOwner +sidebar_label: IdentityProfileAllOfOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileAllOfOwner', 'IdentityProfileAllOfOwner'] +slug: /tools/sdk/go/v3/models/identity-profile-all-of-owner +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'IdentityProfileAllOfOwner'] +--- + +# IdentityProfileAllOfOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's object type. | [optional] +**Id** | Pointer to **string** | Owner's ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] + +## Methods + +### NewIdentityProfileAllOfOwner + +`func NewIdentityProfileAllOfOwner() *IdentityProfileAllOfOwner` + +NewIdentityProfileAllOfOwner instantiates a new IdentityProfileAllOfOwner 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 + +### NewIdentityProfileAllOfOwnerWithDefaults + +`func NewIdentityProfileAllOfOwnerWithDefaults() *IdentityProfileAllOfOwner` + +NewIdentityProfileAllOfOwnerWithDefaults instantiates a new IdentityProfileAllOfOwner 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 + +### GetType + +`func (o *IdentityProfileAllOfOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityProfileAllOfOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityProfileAllOfOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityProfileAllOfOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityProfileAllOfOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfileAllOfOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfileAllOfOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfileAllOfOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfileAllOfOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfileAllOfOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfileAllOfOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityProfileAllOfOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityProfileExportedObject.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityProfileExportedObject.md new file mode 100644 index 000000000..f1e93de43 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityProfileExportedObject.md @@ -0,0 +1,116 @@ +--- +id: identity-profile-exported-object +title: IdentityProfileExportedObject +pagination_label: IdentityProfileExportedObject +sidebar_label: IdentityProfileExportedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileExportedObject', 'IdentityProfileExportedObject'] +slug: /tools/sdk/go/v3/models/identity-profile-exported-object +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObject', 'IdentityProfileExportedObject'] +--- + +# IdentityProfileExportedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **int32** | Version or object from the target service. | [optional] +**Self** | Pointer to [**IdentityProfileExportedObjectSelf**](identity-profile-exported-object-self) | | [optional] +**Object** | Pointer to [**IdentityProfile**](identity-profile) | | [optional] + +## Methods + +### NewIdentityProfileExportedObject + +`func NewIdentityProfileExportedObject() *IdentityProfileExportedObject` + +NewIdentityProfileExportedObject instantiates a new IdentityProfileExportedObject 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 + +### NewIdentityProfileExportedObjectWithDefaults + +`func NewIdentityProfileExportedObjectWithDefaults() *IdentityProfileExportedObject` + +NewIdentityProfileExportedObjectWithDefaults instantiates a new IdentityProfileExportedObject 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 + +### GetVersion + +`func (o *IdentityProfileExportedObject) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *IdentityProfileExportedObject) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *IdentityProfileExportedObject) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *IdentityProfileExportedObject) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### GetSelf + +`func (o *IdentityProfileExportedObject) GetSelf() IdentityProfileExportedObjectSelf` + +GetSelf returns the Self field if non-nil, zero value otherwise. + +### GetSelfOk + +`func (o *IdentityProfileExportedObject) GetSelfOk() (*IdentityProfileExportedObjectSelf, bool)` + +GetSelfOk returns a tuple with the Self field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelf + +`func (o *IdentityProfileExportedObject) SetSelf(v IdentityProfileExportedObjectSelf)` + +SetSelf sets Self field to given value. + +### HasSelf + +`func (o *IdentityProfileExportedObject) HasSelf() bool` + +HasSelf returns a boolean if a field has been set. + +### GetObject + +`func (o *IdentityProfileExportedObject) GetObject() IdentityProfile` + +GetObject returns the Object field if non-nil, zero value otherwise. + +### GetObjectOk + +`func (o *IdentityProfileExportedObject) GetObjectOk() (*IdentityProfile, bool)` + +GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObject + +`func (o *IdentityProfileExportedObject) SetObject(v IdentityProfile)` + +SetObject sets Object field to given value. + +### HasObject + +`func (o *IdentityProfileExportedObject) HasObject() bool` + +HasObject returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityProfileExportedObjectSelf.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityProfileExportedObjectSelf.md new file mode 100644 index 000000000..88f2b921a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityProfileExportedObjectSelf.md @@ -0,0 +1,116 @@ +--- +id: identity-profile-exported-object-self +title: IdentityProfileExportedObjectSelf +pagination_label: IdentityProfileExportedObjectSelf +sidebar_label: IdentityProfileExportedObjectSelf +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileExportedObjectSelf', 'IdentityProfileExportedObjectSelf'] +slug: /tools/sdk/go/v3/models/identity-profile-exported-object-self +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObjectSelf', 'IdentityProfileExportedObjectSelf'] +--- + +# IdentityProfileExportedObjectSelf + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Exported object's DTO type. | [optional] +**Id** | Pointer to **string** | Exported object's ID. | [optional] +**Name** | Pointer to **string** | Exported object's display name. | [optional] + +## Methods + +### NewIdentityProfileExportedObjectSelf + +`func NewIdentityProfileExportedObjectSelf() *IdentityProfileExportedObjectSelf` + +NewIdentityProfileExportedObjectSelf instantiates a new IdentityProfileExportedObjectSelf 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 + +### NewIdentityProfileExportedObjectSelfWithDefaults + +`func NewIdentityProfileExportedObjectSelfWithDefaults() *IdentityProfileExportedObjectSelf` + +NewIdentityProfileExportedObjectSelfWithDefaults instantiates a new IdentityProfileExportedObjectSelf 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 + +### GetType + +`func (o *IdentityProfileExportedObjectSelf) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityProfileExportedObjectSelf) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityProfileExportedObjectSelf) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityProfileExportedObjectSelf) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityProfileExportedObjectSelf) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfileExportedObjectSelf) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfileExportedObjectSelf) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfileExportedObjectSelf) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfileExportedObjectSelf) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfileExportedObjectSelf) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfileExportedObjectSelf) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityProfileExportedObjectSelf) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityProfileIdentityErrorReportArguments.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityProfileIdentityErrorReportArguments.md new file mode 100644 index 000000000..9eaf49dc0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityProfileIdentityErrorReportArguments.md @@ -0,0 +1,59 @@ +--- +id: identity-profile-identity-error-report-arguments +title: IdentityProfileIdentityErrorReportArguments +pagination_label: IdentityProfileIdentityErrorReportArguments +sidebar_label: IdentityProfileIdentityErrorReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfileIdentityErrorReportArguments', 'IdentityProfileIdentityErrorReportArguments'] +slug: /tools/sdk/go/v3/models/identity-profile-identity-error-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentityProfileIdentityErrorReportArguments', 'IdentityProfileIdentityErrorReportArguments'] +--- + +# IdentityProfileIdentityErrorReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuthoritativeSource** | **string** | Source ID. | + +## Methods + +### NewIdentityProfileIdentityErrorReportArguments + +`func NewIdentityProfileIdentityErrorReportArguments(authoritativeSource string, ) *IdentityProfileIdentityErrorReportArguments` + +NewIdentityProfileIdentityErrorReportArguments instantiates a new IdentityProfileIdentityErrorReportArguments 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 + +### NewIdentityProfileIdentityErrorReportArgumentsWithDefaults + +`func NewIdentityProfileIdentityErrorReportArgumentsWithDefaults() *IdentityProfileIdentityErrorReportArguments` + +NewIdentityProfileIdentityErrorReportArgumentsWithDefaults instantiates a new IdentityProfileIdentityErrorReportArguments 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 + +### GetAuthoritativeSource + +`func (o *IdentityProfileIdentityErrorReportArguments) GetAuthoritativeSource() string` + +GetAuthoritativeSource returns the AuthoritativeSource field if non-nil, zero value otherwise. + +### GetAuthoritativeSourceOk + +`func (o *IdentityProfileIdentityErrorReportArguments) GetAuthoritativeSourceOk() (*string, bool)` + +GetAuthoritativeSourceOk returns a tuple with the AuthoritativeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritativeSource + +`func (o *IdentityProfileIdentityErrorReportArguments) SetAuthoritativeSource(v string)` + +SetAuthoritativeSource sets AuthoritativeSource field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityProfilesConnections.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityProfilesConnections.md new file mode 100644 index 000000000..66d159f3f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityProfilesConnections.md @@ -0,0 +1,116 @@ +--- +id: identity-profiles-connections +title: IdentityProfilesConnections +pagination_label: IdentityProfilesConnections +sidebar_label: IdentityProfilesConnections +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityProfilesConnections', 'IdentityProfilesConnections'] +slug: /tools/sdk/go/v3/models/identity-profiles-connections +tags: ['SDK', 'Software Development Kit', 'IdentityProfilesConnections', 'IdentityProfilesConnections'] +--- + +# IdentityProfilesConnections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the IdentityProfile this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the IdentityProfile to which this reference applies | [optional] +**IdentityCount** | Pointer to **int64** | The Number of Identities managed by this IdentityProfile | [optional] + +## Methods + +### NewIdentityProfilesConnections + +`func NewIdentityProfilesConnections() *IdentityProfilesConnections` + +NewIdentityProfilesConnections instantiates a new IdentityProfilesConnections 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 + +### NewIdentityProfilesConnectionsWithDefaults + +`func NewIdentityProfilesConnectionsWithDefaults() *IdentityProfilesConnections` + +NewIdentityProfilesConnectionsWithDefaults instantiates a new IdentityProfilesConnections 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 + +### GetId + +`func (o *IdentityProfilesConnections) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityProfilesConnections) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityProfilesConnections) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityProfilesConnections) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityProfilesConnections) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityProfilesConnections) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityProfilesConnections) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityProfilesConnections) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *IdentityProfilesConnections) GetIdentityCount() int64` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *IdentityProfilesConnections) GetIdentityCountOk() (*int64, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *IdentityProfilesConnections) SetIdentityCount(v int64)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *IdentityProfilesConnections) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityReference.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityReference.md new file mode 100644 index 000000000..87a05b60d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityReference.md @@ -0,0 +1,116 @@ +--- +id: identity-reference +title: IdentityReference +pagination_label: IdentityReference +sidebar_label: IdentityReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityReference', 'IdentityReference'] +slug: /tools/sdk/go/v3/models/identity-reference +tags: ['SDK', 'Software Development Kit', 'IdentityReference', 'IdentityReference'] +--- + +# IdentityReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | Identity id | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity. | [optional] + +## Methods + +### NewIdentityReference + +`func NewIdentityReference() *IdentityReference` + +NewIdentityReference instantiates a new IdentityReference 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 + +### NewIdentityReferenceWithDefaults + +`func NewIdentityReferenceWithDefaults() *IdentityReference` + +NewIdentityReferenceWithDefaults instantiates a new IdentityReference 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 + +### GetType + +`func (o *IdentityReference) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityReference) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityReference) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityReference) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityReferenceWithNameAndEmail.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityReferenceWithNameAndEmail.md new file mode 100644 index 000000000..8b93dc0d4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityReferenceWithNameAndEmail.md @@ -0,0 +1,142 @@ +--- +id: identity-reference-with-name-and-email +title: IdentityReferenceWithNameAndEmail +pagination_label: IdentityReferenceWithNameAndEmail +sidebar_label: IdentityReferenceWithNameAndEmail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityReferenceWithNameAndEmail', 'IdentityReferenceWithNameAndEmail'] +slug: /tools/sdk/go/v3/models/identity-reference-with-name-and-email +tags: ['SDK', 'Software Development Kit', 'IdentityReferenceWithNameAndEmail', 'IdentityReferenceWithNameAndEmail'] +--- + +# IdentityReferenceWithNameAndEmail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type can only be IDENTITY. This is read-only. | [optional] +**Id** | Pointer to **string** | Identity ID. | [optional] +**Name** | Pointer to **string** | Identity's human-readable display name. This is read-only. | [optional] +**Email** | Pointer to **string** | Identity's email address. This is read-only. | [optional] + +## Methods + +### NewIdentityReferenceWithNameAndEmail + +`func NewIdentityReferenceWithNameAndEmail() *IdentityReferenceWithNameAndEmail` + +NewIdentityReferenceWithNameAndEmail instantiates a new IdentityReferenceWithNameAndEmail 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 + +### NewIdentityReferenceWithNameAndEmailWithDefaults + +`func NewIdentityReferenceWithNameAndEmailWithDefaults() *IdentityReferenceWithNameAndEmail` + +NewIdentityReferenceWithNameAndEmailWithDefaults instantiates a new IdentityReferenceWithNameAndEmail 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 + +### GetType + +`func (o *IdentityReferenceWithNameAndEmail) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityReferenceWithNameAndEmail) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityReferenceWithNameAndEmail) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityReferenceWithNameAndEmail) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityReferenceWithNameAndEmail) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityReferenceWithNameAndEmail) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityReferenceWithNameAndEmail) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityReferenceWithNameAndEmail) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityReferenceWithNameAndEmail) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityReferenceWithNameAndEmail) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityReferenceWithNameAndEmail) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityReferenceWithNameAndEmail) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *IdentityReferenceWithNameAndEmail) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *IdentityReferenceWithNameAndEmail) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *IdentityReferenceWithNameAndEmail) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *IdentityReferenceWithNameAndEmail) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentitySummary.md b/docs/tools/sdk/go/Reference/V3/Models/IdentitySummary.md new file mode 100644 index 000000000..8920dd7c8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentitySummary.md @@ -0,0 +1,142 @@ +--- +id: identity-summary +title: IdentitySummary +pagination_label: IdentitySummary +sidebar_label: IdentitySummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentitySummary', 'IdentitySummary'] +slug: /tools/sdk/go/v3/models/identity-summary +tags: ['SDK', 'Software Development Kit', 'IdentitySummary', 'IdentitySummary'] +--- + +# IdentitySummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of this identity summary | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity | [optional] +**IdentityId** | Pointer to **string** | ID of the identity that this summary represents | [optional] +**Completed** | Pointer to **bool** | Indicates if all access items for this summary have been decided on | [optional] [default to false] + +## Methods + +### NewIdentitySummary + +`func NewIdentitySummary() *IdentitySummary` + +NewIdentitySummary instantiates a new IdentitySummary 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 + +### NewIdentitySummaryWithDefaults + +`func NewIdentitySummaryWithDefaults() *IdentitySummary` + +NewIdentitySummaryWithDefaults instantiates a new IdentitySummary 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 + +### GetId + +`func (o *IdentitySummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentitySummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentitySummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentitySummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentitySummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentitySummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentitySummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentitySummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetIdentityId + +`func (o *IdentitySummary) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *IdentitySummary) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *IdentitySummary) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *IdentitySummary) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetCompleted + +`func (o *IdentitySummary) GetCompleted() bool` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *IdentitySummary) GetCompletedOk() (*bool, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *IdentitySummary) SetCompleted(v bool)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *IdentitySummary) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityWithNewAccess.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityWithNewAccess.md new file mode 100644 index 000000000..760d206ec --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityWithNewAccess.md @@ -0,0 +1,80 @@ +--- +id: identity-with-new-access +title: IdentityWithNewAccess +pagination_label: IdentityWithNewAccess +sidebar_label: IdentityWithNewAccess +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityWithNewAccess', 'IdentityWithNewAccess'] +slug: /tools/sdk/go/v3/models/identity-with-new-access +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess', 'IdentityWithNewAccess'] +--- + +# IdentityWithNewAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **string** | Identity id to be checked. | +**AccessRefs** | [**[]IdentityWithNewAccessAccessRefsInner**](identity-with-new-access-access-refs-inner) | The list of entitlements to consider for possible violations in a preventive check. | + +## Methods + +### NewIdentityWithNewAccess + +`func NewIdentityWithNewAccess(identityId string, accessRefs []IdentityWithNewAccessAccessRefsInner, ) *IdentityWithNewAccess` + +NewIdentityWithNewAccess instantiates a new IdentityWithNewAccess 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 + +### NewIdentityWithNewAccessWithDefaults + +`func NewIdentityWithNewAccessWithDefaults() *IdentityWithNewAccess` + +NewIdentityWithNewAccessWithDefaults instantiates a new IdentityWithNewAccess 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 + +### GetIdentityId + +`func (o *IdentityWithNewAccess) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *IdentityWithNewAccess) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *IdentityWithNewAccess) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetAccessRefs + +`func (o *IdentityWithNewAccess) GetAccessRefs() []IdentityWithNewAccessAccessRefsInner` + +GetAccessRefs returns the AccessRefs field if non-nil, zero value otherwise. + +### GetAccessRefsOk + +`func (o *IdentityWithNewAccess) GetAccessRefsOk() (*[]IdentityWithNewAccessAccessRefsInner, bool)` + +GetAccessRefsOk returns a tuple with the AccessRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRefs + +`func (o *IdentityWithNewAccess) SetAccessRefs(v []IdentityWithNewAccessAccessRefsInner)` + +SetAccessRefs sets AccessRefs field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityWithNewAccess1.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityWithNewAccess1.md new file mode 100644 index 000000000..f8ad1035a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityWithNewAccess1.md @@ -0,0 +1,106 @@ +--- +id: identity-with-new-access1 +title: IdentityWithNewAccess1 +pagination_label: IdentityWithNewAccess1 +sidebar_label: IdentityWithNewAccess1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityWithNewAccess1', 'IdentityWithNewAccess1'] +slug: /tools/sdk/go/v3/models/identity-with-new-access1 +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess1', 'IdentityWithNewAccess1'] +--- + +# IdentityWithNewAccess1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **string** | Set of identity IDs to be checked. | +**AccessRefs** | [**[]EntitlementRef1**](entitlement-ref1) | The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. | +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] + +## Methods + +### NewIdentityWithNewAccess1 + +`func NewIdentityWithNewAccess1(identityId string, accessRefs []EntitlementRef1, ) *IdentityWithNewAccess1` + +NewIdentityWithNewAccess1 instantiates a new IdentityWithNewAccess1 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 + +### NewIdentityWithNewAccess1WithDefaults + +`func NewIdentityWithNewAccess1WithDefaults() *IdentityWithNewAccess1` + +NewIdentityWithNewAccess1WithDefaults instantiates a new IdentityWithNewAccess1 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 + +### GetIdentityId + +`func (o *IdentityWithNewAccess1) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *IdentityWithNewAccess1) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *IdentityWithNewAccess1) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetAccessRefs + +`func (o *IdentityWithNewAccess1) GetAccessRefs() []EntitlementRef1` + +GetAccessRefs returns the AccessRefs field if non-nil, zero value otherwise. + +### GetAccessRefsOk + +`func (o *IdentityWithNewAccess1) GetAccessRefsOk() (*[]EntitlementRef1, bool)` + +GetAccessRefsOk returns a tuple with the AccessRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRefs + +`func (o *IdentityWithNewAccess1) SetAccessRefs(v []EntitlementRef1)` + +SetAccessRefs sets AccessRefs field to given value. + + +### GetClientMetadata + +`func (o *IdentityWithNewAccess1) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *IdentityWithNewAccess1) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *IdentityWithNewAccess1) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *IdentityWithNewAccess1) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/go/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md new file mode 100644 index 000000000..aa0ff810c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md @@ -0,0 +1,116 @@ +--- +id: identity-with-new-access-access-refs-inner +title: IdentityWithNewAccessAccessRefsInner +pagination_label: IdentityWithNewAccessAccessRefsInner +sidebar_label: IdentityWithNewAccessAccessRefsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdentityWithNewAccessAccessRefsInner', 'IdentityWithNewAccessAccessRefsInner'] +slug: /tools/sdk/go/v3/models/identity-with-new-access-access-refs-inner +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccessAccessRefsInner', 'IdentityWithNewAccessAccessRefsInner'] +--- + +# IdentityWithNewAccessAccessRefsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Entitlement's DTO type. | [optional] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **string** | Entitlement's display name. | [optional] + +## Methods + +### NewIdentityWithNewAccessAccessRefsInner + +`func NewIdentityWithNewAccessAccessRefsInner() *IdentityWithNewAccessAccessRefsInner` + +NewIdentityWithNewAccessAccessRefsInner instantiates a new IdentityWithNewAccessAccessRefsInner 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 + +### NewIdentityWithNewAccessAccessRefsInnerWithDefaults + +`func NewIdentityWithNewAccessAccessRefsInnerWithDefaults() *IdentityWithNewAccessAccessRefsInner` + +NewIdentityWithNewAccessAccessRefsInnerWithDefaults instantiates a new IdentityWithNewAccessAccessRefsInner 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 + +### GetType + +`func (o *IdentityWithNewAccessAccessRefsInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *IdentityWithNewAccessAccessRefsInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *IdentityWithNewAccessAccessRefsInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *IdentityWithNewAccessAccessRefsInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *IdentityWithNewAccessAccessRefsInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IdentityWithNewAccessAccessRefsInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IdentityWithNewAccessAccessRefsInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IdentityWithNewAccessAccessRefsInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IdentityWithNewAccessAccessRefsInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IdentityWithNewAccessAccessRefsInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IdentityWithNewAccessAccessRefsInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IdentityWithNewAccessAccessRefsInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/IdpDetails.md b/docs/tools/sdk/go/Reference/V3/Models/IdpDetails.md new file mode 100644 index 000000000..dc391bcb0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/IdpDetails.md @@ -0,0 +1,397 @@ +--- +id: idp-details +title: IdpDetails +pagination_label: IdpDetails +sidebar_label: IdpDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'IdpDetails', 'IdpDetails'] +slug: /tools/sdk/go/v3/models/idp-details +tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'IdpDetails'] +--- + +# IdpDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | Pointer to **string** | Federation protocol role | [optional] +**EntityId** | Pointer to **string** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Binding** | Pointer to **string** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**AuthnContext** | Pointer to **string** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**LogoutUrl** | Pointer to **string** | The IDP logout URL. Used with IDP configurations. | [optional] +**IncludeAuthnContext** | Pointer to **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to false] +**NameId** | Pointer to **string** | The name id format to use. Used with IDP configurations. | [optional] +**JitConfiguration** | Pointer to [**JITConfiguration**](jit-configuration) | | [optional] +**Cert** | Pointer to **string** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**LoginUrlPost** | Pointer to **string** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**LoginUrlRedirect** | Pointer to **string** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**MappingAttribute** | **string** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | +**CertificateExpirationDate** | Pointer to **string** | The expiration date extracted from the certificate. | [optional] +**CertificateName** | Pointer to **string** | The name extracted from the certificate. | [optional] + +## Methods + +### NewIdpDetails + +`func NewIdpDetails(mappingAttribute string, ) *IdpDetails` + +NewIdpDetails instantiates a new IdpDetails 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 + +### NewIdpDetailsWithDefaults + +`func NewIdpDetailsWithDefaults() *IdpDetails` + +NewIdpDetailsWithDefaults instantiates a new IdpDetails 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 + +### GetRole + +`func (o *IdpDetails) GetRole() string` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *IdpDetails) GetRoleOk() (*string, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *IdpDetails) SetRole(v string)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *IdpDetails) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetEntityId + +`func (o *IdpDetails) GetEntityId() string` + +GetEntityId returns the EntityId field if non-nil, zero value otherwise. + +### GetEntityIdOk + +`func (o *IdpDetails) GetEntityIdOk() (*string, bool)` + +GetEntityIdOk returns a tuple with the EntityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntityId + +`func (o *IdpDetails) SetEntityId(v string)` + +SetEntityId sets EntityId field to given value. + +### HasEntityId + +`func (o *IdpDetails) HasEntityId() bool` + +HasEntityId returns a boolean if a field has been set. + +### GetBinding + +`func (o *IdpDetails) GetBinding() string` + +GetBinding returns the Binding field if non-nil, zero value otherwise. + +### GetBindingOk + +`func (o *IdpDetails) GetBindingOk() (*string, bool)` + +GetBindingOk returns a tuple with the Binding field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBinding + +`func (o *IdpDetails) SetBinding(v string)` + +SetBinding sets Binding field to given value. + +### HasBinding + +`func (o *IdpDetails) HasBinding() bool` + +HasBinding returns a boolean if a field has been set. + +### GetAuthnContext + +`func (o *IdpDetails) GetAuthnContext() string` + +GetAuthnContext returns the AuthnContext field if non-nil, zero value otherwise. + +### GetAuthnContextOk + +`func (o *IdpDetails) GetAuthnContextOk() (*string, bool)` + +GetAuthnContextOk returns a tuple with the AuthnContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthnContext + +`func (o *IdpDetails) SetAuthnContext(v string)` + +SetAuthnContext sets AuthnContext field to given value. + +### HasAuthnContext + +`func (o *IdpDetails) HasAuthnContext() bool` + +HasAuthnContext returns a boolean if a field has been set. + +### GetLogoutUrl + +`func (o *IdpDetails) GetLogoutUrl() string` + +GetLogoutUrl returns the LogoutUrl field if non-nil, zero value otherwise. + +### GetLogoutUrlOk + +`func (o *IdpDetails) GetLogoutUrlOk() (*string, bool)` + +GetLogoutUrlOk returns a tuple with the LogoutUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogoutUrl + +`func (o *IdpDetails) SetLogoutUrl(v string)` + +SetLogoutUrl sets LogoutUrl field to given value. + +### HasLogoutUrl + +`func (o *IdpDetails) HasLogoutUrl() bool` + +HasLogoutUrl returns a boolean if a field has been set. + +### GetIncludeAuthnContext + +`func (o *IdpDetails) GetIncludeAuthnContext() bool` + +GetIncludeAuthnContext returns the IncludeAuthnContext field if non-nil, zero value otherwise. + +### GetIncludeAuthnContextOk + +`func (o *IdpDetails) GetIncludeAuthnContextOk() (*bool, bool)` + +GetIncludeAuthnContextOk returns a tuple with the IncludeAuthnContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeAuthnContext + +`func (o *IdpDetails) SetIncludeAuthnContext(v bool)` + +SetIncludeAuthnContext sets IncludeAuthnContext field to given value. + +### HasIncludeAuthnContext + +`func (o *IdpDetails) HasIncludeAuthnContext() bool` + +HasIncludeAuthnContext returns a boolean if a field has been set. + +### GetNameId + +`func (o *IdpDetails) GetNameId() string` + +GetNameId returns the NameId field if non-nil, zero value otherwise. + +### GetNameIdOk + +`func (o *IdpDetails) GetNameIdOk() (*string, bool)` + +GetNameIdOk returns a tuple with the NameId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNameId + +`func (o *IdpDetails) SetNameId(v string)` + +SetNameId sets NameId field to given value. + +### HasNameId + +`func (o *IdpDetails) HasNameId() bool` + +HasNameId returns a boolean if a field has been set. + +### GetJitConfiguration + +`func (o *IdpDetails) GetJitConfiguration() JITConfiguration` + +GetJitConfiguration returns the JitConfiguration field if non-nil, zero value otherwise. + +### GetJitConfigurationOk + +`func (o *IdpDetails) GetJitConfigurationOk() (*JITConfiguration, bool)` + +GetJitConfigurationOk returns a tuple with the JitConfiguration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJitConfiguration + +`func (o *IdpDetails) SetJitConfiguration(v JITConfiguration)` + +SetJitConfiguration sets JitConfiguration field to given value. + +### HasJitConfiguration + +`func (o *IdpDetails) HasJitConfiguration() bool` + +HasJitConfiguration returns a boolean if a field has been set. + +### GetCert + +`func (o *IdpDetails) GetCert() string` + +GetCert returns the Cert field if non-nil, zero value otherwise. + +### GetCertOk + +`func (o *IdpDetails) GetCertOk() (*string, bool)` + +GetCertOk returns a tuple with the Cert field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCert + +`func (o *IdpDetails) SetCert(v string)` + +SetCert sets Cert field to given value. + +### HasCert + +`func (o *IdpDetails) HasCert() bool` + +HasCert returns a boolean if a field has been set. + +### GetLoginUrlPost + +`func (o *IdpDetails) GetLoginUrlPost() string` + +GetLoginUrlPost returns the LoginUrlPost field if non-nil, zero value otherwise. + +### GetLoginUrlPostOk + +`func (o *IdpDetails) GetLoginUrlPostOk() (*string, bool)` + +GetLoginUrlPostOk returns a tuple with the LoginUrlPost field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginUrlPost + +`func (o *IdpDetails) SetLoginUrlPost(v string)` + +SetLoginUrlPost sets LoginUrlPost field to given value. + +### HasLoginUrlPost + +`func (o *IdpDetails) HasLoginUrlPost() bool` + +HasLoginUrlPost returns a boolean if a field has been set. + +### GetLoginUrlRedirect + +`func (o *IdpDetails) GetLoginUrlRedirect() string` + +GetLoginUrlRedirect returns the LoginUrlRedirect field if non-nil, zero value otherwise. + +### GetLoginUrlRedirectOk + +`func (o *IdpDetails) GetLoginUrlRedirectOk() (*string, bool)` + +GetLoginUrlRedirectOk returns a tuple with the LoginUrlRedirect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginUrlRedirect + +`func (o *IdpDetails) SetLoginUrlRedirect(v string)` + +SetLoginUrlRedirect sets LoginUrlRedirect field to given value. + +### HasLoginUrlRedirect + +`func (o *IdpDetails) HasLoginUrlRedirect() bool` + +HasLoginUrlRedirect returns a boolean if a field has been set. + +### GetMappingAttribute + +`func (o *IdpDetails) GetMappingAttribute() string` + +GetMappingAttribute returns the MappingAttribute field if non-nil, zero value otherwise. + +### GetMappingAttributeOk + +`func (o *IdpDetails) GetMappingAttributeOk() (*string, bool)` + +GetMappingAttributeOk returns a tuple with the MappingAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMappingAttribute + +`func (o *IdpDetails) SetMappingAttribute(v string)` + +SetMappingAttribute sets MappingAttribute field to given value. + + +### GetCertificateExpirationDate + +`func (o *IdpDetails) GetCertificateExpirationDate() string` + +GetCertificateExpirationDate returns the CertificateExpirationDate field if non-nil, zero value otherwise. + +### GetCertificateExpirationDateOk + +`func (o *IdpDetails) GetCertificateExpirationDateOk() (*string, bool)` + +GetCertificateExpirationDateOk returns a tuple with the CertificateExpirationDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificateExpirationDate + +`func (o *IdpDetails) SetCertificateExpirationDate(v string)` + +SetCertificateExpirationDate sets CertificateExpirationDate field to given value. + +### HasCertificateExpirationDate + +`func (o *IdpDetails) HasCertificateExpirationDate() bool` + +HasCertificateExpirationDate returns a boolean if a field has been set. + +### GetCertificateName + +`func (o *IdpDetails) GetCertificateName() string` + +GetCertificateName returns the CertificateName field if non-nil, zero value otherwise. + +### GetCertificateNameOk + +`func (o *IdpDetails) GetCertificateNameOk() (*string, bool)` + +GetCertificateNameOk returns a tuple with the CertificateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificateName + +`func (o *IdpDetails) SetCertificateName(v string)` + +SetCertificateName sets CertificateName field to given value. + +### HasCertificateName + +`func (o *IdpDetails) HasCertificateName() bool` + +HasCertificateName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ImportNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/go/Reference/V3/Models/ImportNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..a8aec27ff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ImportNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,59 @@ +--- +id: import-non-employee-records-in-bulk-request +title: ImportNonEmployeeRecordsInBulkRequest +pagination_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportNonEmployeeRecordsInBulkRequest', 'ImportNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/go/v3/models/import-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'ImportNonEmployeeRecordsInBulkRequest', 'ImportNonEmployeeRecordsInBulkRequest'] +--- + +# ImportNonEmployeeRecordsInBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | ***os.File** | | + +## Methods + +### NewImportNonEmployeeRecordsInBulkRequest + +`func NewImportNonEmployeeRecordsInBulkRequest(data *os.File, ) *ImportNonEmployeeRecordsInBulkRequest` + +NewImportNonEmployeeRecordsInBulkRequest instantiates a new ImportNonEmployeeRecordsInBulkRequest 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 + +### NewImportNonEmployeeRecordsInBulkRequestWithDefaults + +`func NewImportNonEmployeeRecordsInBulkRequestWithDefaults() *ImportNonEmployeeRecordsInBulkRequest` + +NewImportNonEmployeeRecordsInBulkRequestWithDefaults instantiates a new ImportNonEmployeeRecordsInBulkRequest 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 + +### GetData + +`func (o *ImportNonEmployeeRecordsInBulkRequest) GetData() *os.File` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *ImportNonEmployeeRecordsInBulkRequest) GetDataOk() (**os.File, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *ImportNonEmployeeRecordsInBulkRequest) SetData(v *os.File)` + +SetData sets Data field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ImportObject.md b/docs/tools/sdk/go/Reference/V3/Models/ImportObject.md new file mode 100644 index 000000000..d05dc6921 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ImportObject.md @@ -0,0 +1,116 @@ +--- +id: import-object +title: ImportObject +pagination_label: ImportObject +sidebar_label: ImportObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ImportObject', 'ImportObject'] +slug: /tools/sdk/go/v3/models/import-object +tags: ['SDK', 'Software Development Kit', 'ImportObject', 'ImportObject'] +--- + +# ImportObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of object created or updated by import. | [optional] +**Id** | Pointer to **string** | ID of object created or updated by import. | [optional] +**Name** | Pointer to **string** | Display name of object created or updated by import. | [optional] + +## Methods + +### NewImportObject + +`func NewImportObject() *ImportObject` + +NewImportObject instantiates a new ImportObject 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 + +### NewImportObjectWithDefaults + +`func NewImportObjectWithDefaults() *ImportObject` + +NewImportObjectWithDefaults instantiates a new ImportObject 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 + +### GetType + +`func (o *ImportObject) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ImportObject) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ImportObject) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ImportObject) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ImportObject) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ImportObject) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ImportObject) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ImportObject) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ImportObject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ImportObject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ImportObject) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ImportObject) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Index.md b/docs/tools/sdk/go/Reference/V3/Models/Index.md new file mode 100644 index 000000000..fe1b1b34c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Index.md @@ -0,0 +1,18 @@ +--- +id: models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 3 +sidebar_class_name: models +keywords: ['go', 'Golang', 'sdk', 'models'] +slug: /tools/sdk/go/v3/models +tags: ['SDK', 'Software Development Kit', 'v3', 'models'] +--- + +The Python SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. \ No newline at end of file diff --git a/docs/tools/sdk/go/Reference/V3/Models/Indices.md b/docs/tools/sdk/go/Reference/V3/Models/Indices.md new file mode 100644 index 000000000..89a7582fd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Indices.md @@ -0,0 +1,31 @@ +--- +id: index +title: Index +pagination_label: Index +sidebar_label: Index +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Index', 'Index'] +slug: /tools/sdk/go/v3/models/index +tags: ['SDK', 'Software Development Kit', 'Index', 'Index'] +--- + +# Index + +## Enum + + +* `ACCESSPROFILES` (value: `"accessprofiles"`) + +* `ACCOUNTACTIVITIES` (value: `"accountactivities"`) + +* `ENTITLEMENTS` (value: `"entitlements"`) + +* `EVENTS` (value: `"events"`) + +* `IDENTITIES` (value: `"identities"`) + +* `ROLES` (value: `"roles"`) + +* `STAR` (value: `"*"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/InnerHit.md b/docs/tools/sdk/go/Reference/V3/Models/InnerHit.md new file mode 100644 index 000000000..723811f35 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/InnerHit.md @@ -0,0 +1,80 @@ +--- +id: inner-hit +title: InnerHit +pagination_label: InnerHit +sidebar_label: InnerHit +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'InnerHit', 'InnerHit'] +slug: /tools/sdk/go/v3/models/inner-hit +tags: ['SDK', 'Software Development Kit', 'InnerHit', 'InnerHit'] +--- + +# InnerHit + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **string** | The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | +**Type** | **string** | The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps. | + +## Methods + +### NewInnerHit + +`func NewInnerHit(query string, type_ string, ) *InnerHit` + +NewInnerHit instantiates a new InnerHit 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 + +### NewInnerHitWithDefaults + +`func NewInnerHitWithDefaults() *InnerHit` + +NewInnerHitWithDefaults instantiates a new InnerHit 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 + +### GetQuery + +`func (o *InnerHit) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *InnerHit) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *InnerHit) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetType + +`func (o *InnerHit) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *InnerHit) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *InnerHit) SetType(v string)` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/JITConfiguration.md b/docs/tools/sdk/go/Reference/V3/Models/JITConfiguration.md new file mode 100644 index 000000000..a3a210dbc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/JITConfiguration.md @@ -0,0 +1,116 @@ +--- +id: jit-configuration +title: JITConfiguration +pagination_label: JITConfiguration +sidebar_label: JITConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'JITConfiguration', 'JITConfiguration'] +slug: /tools/sdk/go/v3/models/jit-configuration +tags: ['SDK', 'Software Development Kit', 'JITConfiguration', 'JITConfiguration'] +--- + +# JITConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | The indicator for just-in-time provisioning enabled | [optional] [default to false] +**SourceId** | Pointer to **string** | the sourceId that mapped to just-in-time provisioning configuration | [optional] +**SourceAttributeMappings** | Pointer to **map[string]string** | A mapping of identity profile attribute names to SAML assertion attribute names | [optional] + +## Methods + +### NewJITConfiguration + +`func NewJITConfiguration() *JITConfiguration` + +NewJITConfiguration instantiates a new JITConfiguration 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 + +### NewJITConfigurationWithDefaults + +`func NewJITConfigurationWithDefaults() *JITConfiguration` + +NewJITConfigurationWithDefaults instantiates a new JITConfiguration 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 + +### GetEnabled + +`func (o *JITConfiguration) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *JITConfiguration) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *JITConfiguration) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *JITConfiguration) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetSourceId + +`func (o *JITConfiguration) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *JITConfiguration) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *JITConfiguration) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *JITConfiguration) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetSourceAttributeMappings + +`func (o *JITConfiguration) GetSourceAttributeMappings() map[string]string` + +GetSourceAttributeMappings returns the SourceAttributeMappings field if non-nil, zero value otherwise. + +### GetSourceAttributeMappingsOk + +`func (o *JITConfiguration) GetSourceAttributeMappingsOk() (*map[string]string, bool)` + +GetSourceAttributeMappingsOk returns a tuple with the SourceAttributeMappings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceAttributeMappings + +`func (o *JITConfiguration) SetSourceAttributeMappings(v map[string]string)` + +SetSourceAttributeMappings sets SourceAttributeMappings field to given value. + +### HasSourceAttributeMappings + +`func (o *JITConfiguration) HasSourceAttributeMappings() bool` + +HasSourceAttributeMappings returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/JsonPatchOperation.md b/docs/tools/sdk/go/Reference/V3/Models/JsonPatchOperation.md new file mode 100644 index 000000000..442aeefac --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/JsonPatchOperation.md @@ -0,0 +1,106 @@ +--- +id: json-patch-operation +title: JsonPatchOperation +pagination_label: JsonPatchOperation +sidebar_label: JsonPatchOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'JsonPatchOperation', 'JsonPatchOperation'] +slug: /tools/sdk/go/v3/models/json-patch-operation +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperation', 'JsonPatchOperation'] +--- + +# JsonPatchOperation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **string** | The operation to be performed | +**Path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | +**Value** | Pointer to [**JsonPatchOperationValue**](json-patch-operation-value) | | [optional] + +## Methods + +### NewJsonPatchOperation + +`func NewJsonPatchOperation(op string, path string, ) *JsonPatchOperation` + +NewJsonPatchOperation instantiates a new JsonPatchOperation 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 + +### NewJsonPatchOperationWithDefaults + +`func NewJsonPatchOperationWithDefaults() *JsonPatchOperation` + +NewJsonPatchOperationWithDefaults instantiates a new JsonPatchOperation 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 + +### GetOp + +`func (o *JsonPatchOperation) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *JsonPatchOperation) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *JsonPatchOperation) SetOp(v string)` + +SetOp sets Op field to given value. + + +### GetPath + +`func (o *JsonPatchOperation) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *JsonPatchOperation) GetPathOk() (*string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPath + +`func (o *JsonPatchOperation) SetPath(v string)` + +SetPath sets Path field to given value. + + +### GetValue + +`func (o *JsonPatchOperation) GetValue() JsonPatchOperationValue` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *JsonPatchOperation) GetValueOk() (*JsonPatchOperationValue, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *JsonPatchOperation) SetValue(v JsonPatchOperationValue)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *JsonPatchOperation) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/JsonPatchOperationValue.md b/docs/tools/sdk/go/Reference/V3/Models/JsonPatchOperationValue.md new file mode 100644 index 000000000..0bb4135de --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/JsonPatchOperationValue.md @@ -0,0 +1,38 @@ +--- +id: json-patch-operation-value +title: JsonPatchOperationValue +pagination_label: JsonPatchOperationValue +sidebar_label: JsonPatchOperationValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'JsonPatchOperationValue', 'JsonPatchOperationValue'] +slug: /tools/sdk/go/v3/models/json-patch-operation-value +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperationValue', 'JsonPatchOperationValue'] +--- + +# JsonPatchOperationValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewJsonPatchOperationValue + +`func NewJsonPatchOperationValue() *JsonPatchOperationValue` + +NewJsonPatchOperationValue instantiates a new JsonPatchOperationValue 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 + +### NewJsonPatchOperationValueWithDefaults + +`func NewJsonPatchOperationValueWithDefaults() *JsonPatchOperationValue` + +NewJsonPatchOperationValueWithDefaults instantiates a new JsonPatchOperationValue 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 + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/KbaAnswerRequestItem.md b/docs/tools/sdk/go/Reference/V3/Models/KbaAnswerRequestItem.md new file mode 100644 index 000000000..5352acd5c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/KbaAnswerRequestItem.md @@ -0,0 +1,80 @@ +--- +id: kba-answer-request-item +title: KbaAnswerRequestItem +pagination_label: KbaAnswerRequestItem +sidebar_label: KbaAnswerRequestItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'KbaAnswerRequestItem', 'KbaAnswerRequestItem'] +slug: /tools/sdk/go/v3/models/kba-answer-request-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerRequestItem', 'KbaAnswerRequestItem'] +--- + +# KbaAnswerRequestItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Question Id | +**Answer** | **string** | An answer for the KBA question | + +## Methods + +### NewKbaAnswerRequestItem + +`func NewKbaAnswerRequestItem(id string, answer string, ) *KbaAnswerRequestItem` + +NewKbaAnswerRequestItem instantiates a new KbaAnswerRequestItem 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 + +### NewKbaAnswerRequestItemWithDefaults + +`func NewKbaAnswerRequestItemWithDefaults() *KbaAnswerRequestItem` + +NewKbaAnswerRequestItemWithDefaults instantiates a new KbaAnswerRequestItem 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 + +### GetId + +`func (o *KbaAnswerRequestItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *KbaAnswerRequestItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *KbaAnswerRequestItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetAnswer + +`func (o *KbaAnswerRequestItem) GetAnswer() string` + +GetAnswer returns the Answer field if non-nil, zero value otherwise. + +### GetAnswerOk + +`func (o *KbaAnswerRequestItem) GetAnswerOk() (*string, bool)` + +GetAnswerOk returns a tuple with the Answer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAnswer + +`func (o *KbaAnswerRequestItem) SetAnswer(v string)` + +SetAnswer sets Answer field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/KbaAnswerResponseItem.md b/docs/tools/sdk/go/Reference/V3/Models/KbaAnswerResponseItem.md new file mode 100644 index 000000000..5d92a9054 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/KbaAnswerResponseItem.md @@ -0,0 +1,101 @@ +--- +id: kba-answer-response-item +title: KbaAnswerResponseItem +pagination_label: KbaAnswerResponseItem +sidebar_label: KbaAnswerResponseItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'KbaAnswerResponseItem', 'KbaAnswerResponseItem'] +slug: /tools/sdk/go/v3/models/kba-answer-response-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerResponseItem', 'KbaAnswerResponseItem'] +--- + +# KbaAnswerResponseItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Question Id | +**Question** | **string** | Question description | +**HasAnswer** | **bool** | Denotes whether the KBA question has an answer configured for the current user | + +## Methods + +### NewKbaAnswerResponseItem + +`func NewKbaAnswerResponseItem(id string, question string, hasAnswer bool, ) *KbaAnswerResponseItem` + +NewKbaAnswerResponseItem instantiates a new KbaAnswerResponseItem 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 + +### NewKbaAnswerResponseItemWithDefaults + +`func NewKbaAnswerResponseItemWithDefaults() *KbaAnswerResponseItem` + +NewKbaAnswerResponseItemWithDefaults instantiates a new KbaAnswerResponseItem 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 + +### GetId + +`func (o *KbaAnswerResponseItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *KbaAnswerResponseItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *KbaAnswerResponseItem) SetId(v string)` + +SetId sets Id field to given value. + + +### GetQuestion + +`func (o *KbaAnswerResponseItem) GetQuestion() string` + +GetQuestion returns the Question field if non-nil, zero value otherwise. + +### GetQuestionOk + +`func (o *KbaAnswerResponseItem) GetQuestionOk() (*string, bool)` + +GetQuestionOk returns a tuple with the Question field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuestion + +`func (o *KbaAnswerResponseItem) SetQuestion(v string)` + +SetQuestion sets Question field to given value. + + +### GetHasAnswer + +`func (o *KbaAnswerResponseItem) GetHasAnswer() bool` + +GetHasAnswer returns the HasAnswer field if non-nil, zero value otherwise. + +### GetHasAnswerOk + +`func (o *KbaAnswerResponseItem) GetHasAnswerOk() (*bool, bool)` + +GetHasAnswerOk returns a tuple with the HasAnswer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasAnswer + +`func (o *KbaAnswerResponseItem) SetHasAnswer(v bool)` + +SetHasAnswer sets HasAnswer field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/KbaAuthResponse.md b/docs/tools/sdk/go/Reference/V3/Models/KbaAuthResponse.md new file mode 100644 index 000000000..964debaf1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/KbaAuthResponse.md @@ -0,0 +1,90 @@ +--- +id: kba-auth-response +title: KbaAuthResponse +pagination_label: KbaAuthResponse +sidebar_label: KbaAuthResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'KbaAuthResponse', 'KbaAuthResponse'] +slug: /tools/sdk/go/v3/models/kba-auth-response +tags: ['SDK', 'Software Development Kit', 'KbaAuthResponse', 'KbaAuthResponse'] +--- + +# KbaAuthResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**KbaAuthResponseItems** | Pointer to [**[]KbaAuthResponseItem**](kba-auth-response-item) | | [optional] +**Status** | Pointer to **string** | MFA Authentication status | [optional] + +## Methods + +### NewKbaAuthResponse + +`func NewKbaAuthResponse() *KbaAuthResponse` + +NewKbaAuthResponse instantiates a new KbaAuthResponse 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 + +### NewKbaAuthResponseWithDefaults + +`func NewKbaAuthResponseWithDefaults() *KbaAuthResponse` + +NewKbaAuthResponseWithDefaults instantiates a new KbaAuthResponse 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 + +### GetKbaAuthResponseItems + +`func (o *KbaAuthResponse) GetKbaAuthResponseItems() []KbaAuthResponseItem` + +GetKbaAuthResponseItems returns the KbaAuthResponseItems field if non-nil, zero value otherwise. + +### GetKbaAuthResponseItemsOk + +`func (o *KbaAuthResponse) GetKbaAuthResponseItemsOk() (*[]KbaAuthResponseItem, bool)` + +GetKbaAuthResponseItemsOk returns a tuple with the KbaAuthResponseItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKbaAuthResponseItems + +`func (o *KbaAuthResponse) SetKbaAuthResponseItems(v []KbaAuthResponseItem)` + +SetKbaAuthResponseItems sets KbaAuthResponseItems field to given value. + +### HasKbaAuthResponseItems + +`func (o *KbaAuthResponse) HasKbaAuthResponseItems() bool` + +HasKbaAuthResponseItems returns a boolean if a field has been set. + +### GetStatus + +`func (o *KbaAuthResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *KbaAuthResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *KbaAuthResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *KbaAuthResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/KbaAuthResponseItem.md b/docs/tools/sdk/go/Reference/V3/Models/KbaAuthResponseItem.md new file mode 100644 index 000000000..7793acdb8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/KbaAuthResponseItem.md @@ -0,0 +1,110 @@ +--- +id: kba-auth-response-item +title: KbaAuthResponseItem +pagination_label: KbaAuthResponseItem +sidebar_label: KbaAuthResponseItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'KbaAuthResponseItem', 'KbaAuthResponseItem'] +slug: /tools/sdk/go/v3/models/kba-auth-response-item +tags: ['SDK', 'Software Development Kit', 'KbaAuthResponseItem', 'KbaAuthResponseItem'] +--- + +# KbaAuthResponseItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**QuestionId** | Pointer to **NullableString** | The KBA question id | [optional] +**IsVerified** | Pointer to **NullableBool** | Return true if verified | [optional] + +## Methods + +### NewKbaAuthResponseItem + +`func NewKbaAuthResponseItem() *KbaAuthResponseItem` + +NewKbaAuthResponseItem instantiates a new KbaAuthResponseItem 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 + +### NewKbaAuthResponseItemWithDefaults + +`func NewKbaAuthResponseItemWithDefaults() *KbaAuthResponseItem` + +NewKbaAuthResponseItemWithDefaults instantiates a new KbaAuthResponseItem 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 + +### GetQuestionId + +`func (o *KbaAuthResponseItem) GetQuestionId() string` + +GetQuestionId returns the QuestionId field if non-nil, zero value otherwise. + +### GetQuestionIdOk + +`func (o *KbaAuthResponseItem) GetQuestionIdOk() (*string, bool)` + +GetQuestionIdOk returns a tuple with the QuestionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuestionId + +`func (o *KbaAuthResponseItem) SetQuestionId(v string)` + +SetQuestionId sets QuestionId field to given value. + +### HasQuestionId + +`func (o *KbaAuthResponseItem) HasQuestionId() bool` + +HasQuestionId returns a boolean if a field has been set. + +### SetQuestionIdNil + +`func (o *KbaAuthResponseItem) SetQuestionIdNil(b bool)` + + SetQuestionIdNil sets the value for QuestionId to be an explicit nil + +### UnsetQuestionId +`func (o *KbaAuthResponseItem) UnsetQuestionId()` + +UnsetQuestionId ensures that no value is present for QuestionId, not even an explicit nil +### GetIsVerified + +`func (o *KbaAuthResponseItem) GetIsVerified() bool` + +GetIsVerified returns the IsVerified field if non-nil, zero value otherwise. + +### GetIsVerifiedOk + +`func (o *KbaAuthResponseItem) GetIsVerifiedOk() (*bool, bool)` + +GetIsVerifiedOk returns a tuple with the IsVerified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsVerified + +`func (o *KbaAuthResponseItem) SetIsVerified(v bool)` + +SetIsVerified sets IsVerified field to given value. + +### HasIsVerified + +`func (o *KbaAuthResponseItem) HasIsVerified() bool` + +HasIsVerified returns a boolean if a field has been set. + +### SetIsVerifiedNil + +`func (o *KbaAuthResponseItem) SetIsVerifiedNil(b bool)` + + SetIsVerifiedNil sets the value for IsVerified to be an explicit nil + +### UnsetIsVerified +`func (o *KbaAuthResponseItem) UnsetIsVerified()` + +UnsetIsVerified ensures that no value is present for IsVerified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/KbaQuestion.md b/docs/tools/sdk/go/Reference/V3/Models/KbaQuestion.md new file mode 100644 index 000000000..a761cf28c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/KbaQuestion.md @@ -0,0 +1,122 @@ +--- +id: kba-question +title: KbaQuestion +pagination_label: KbaQuestion +sidebar_label: KbaQuestion +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'KbaQuestion', 'KbaQuestion'] +slug: /tools/sdk/go/v3/models/kba-question +tags: ['SDK', 'Software Development Kit', 'KbaQuestion', 'KbaQuestion'] +--- + +# KbaQuestion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | KBA Question Id | +**Text** | **string** | KBA Question description | +**HasAnswer** | **bool** | Denotes whether the KBA question has an answer configured for any user in the tenant | +**NumAnswers** | **int32** | Denotes the number of KBA configurations for this question | + +## Methods + +### NewKbaQuestion + +`func NewKbaQuestion(id string, text string, hasAnswer bool, numAnswers int32, ) *KbaQuestion` + +NewKbaQuestion instantiates a new KbaQuestion 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 + +### NewKbaQuestionWithDefaults + +`func NewKbaQuestionWithDefaults() *KbaQuestion` + +NewKbaQuestionWithDefaults instantiates a new KbaQuestion 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 + +### GetId + +`func (o *KbaQuestion) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *KbaQuestion) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *KbaQuestion) SetId(v string)` + +SetId sets Id field to given value. + + +### GetText + +`func (o *KbaQuestion) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *KbaQuestion) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *KbaQuestion) SetText(v string)` + +SetText sets Text field to given value. + + +### GetHasAnswer + +`func (o *KbaQuestion) GetHasAnswer() bool` + +GetHasAnswer returns the HasAnswer field if non-nil, zero value otherwise. + +### GetHasAnswerOk + +`func (o *KbaQuestion) GetHasAnswerOk() (*bool, bool)` + +GetHasAnswerOk returns a tuple with the HasAnswer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasAnswer + +`func (o *KbaQuestion) SetHasAnswer(v bool)` + +SetHasAnswer sets HasAnswer field to given value. + + +### GetNumAnswers + +`func (o *KbaQuestion) GetNumAnswers() int32` + +GetNumAnswers returns the NumAnswers field if non-nil, zero value otherwise. + +### GetNumAnswersOk + +`func (o *KbaQuestion) GetNumAnswersOk() (*int32, bool)` + +GetNumAnswersOk returns a tuple with the NumAnswers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumAnswers + +`func (o *KbaQuestion) SetNumAnswers(v int32)` + +SetNumAnswers sets NumAnswers field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/LifecycleState.md b/docs/tools/sdk/go/Reference/V3/Models/LifecycleState.md new file mode 100644 index 000000000..b1aa45fb1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/LifecycleState.md @@ -0,0 +1,360 @@ +--- +id: lifecycle-state +title: LifecycleState +pagination_label: LifecycleState +sidebar_label: LifecycleState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LifecycleState', 'LifecycleState'] +slug: /tools/sdk/go/v3/models/lifecycle-state +tags: ['SDK', 'Software Development Kit', 'LifecycleState', 'LifecycleState'] +--- + +# LifecycleState + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Enabled** | Pointer to **bool** | Indicates whether the lifecycle state is enabled or disabled. | [optional] [default to false] +**TechnicalName** | **string** | The lifecycle state's technical name. This is for internal use. | +**Description** | Pointer to **string** | Lifecycle state's description. | [optional] +**IdentityCount** | Pointer to **int32** | Number of identities that have the lifecycle state. | [optional] [readonly] +**EmailNotificationOption** | Pointer to [**EmailNotificationOption**](email-notification-option) | | [optional] +**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] + +## Methods + +### NewLifecycleState + +`func NewLifecycleState(name NullableString, technicalName string, ) *LifecycleState` + +NewLifecycleState instantiates a new LifecycleState 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 + +### NewLifecycleStateWithDefaults + +`func NewLifecycleStateWithDefaults() *LifecycleState` + +NewLifecycleStateWithDefaults instantiates a new LifecycleState 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 + +### GetId + +`func (o *LifecycleState) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LifecycleState) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LifecycleState) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LifecycleState) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *LifecycleState) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LifecycleState) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *LifecycleState) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *LifecycleState) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *LifecycleState) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *LifecycleState) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LifecycleState) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *LifecycleState) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *LifecycleState) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *LifecycleState) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *LifecycleState) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *LifecycleState) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *LifecycleState) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetEnabled + +`func (o *LifecycleState) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *LifecycleState) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *LifecycleState) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *LifecycleState) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetTechnicalName + +`func (o *LifecycleState) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *LifecycleState) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *LifecycleState) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + + +### GetDescription + +`func (o *LifecycleState) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *LifecycleState) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *LifecycleState) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *LifecycleState) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIdentityCount + +`func (o *LifecycleState) GetIdentityCount() int32` + +GetIdentityCount returns the IdentityCount field if non-nil, zero value otherwise. + +### GetIdentityCountOk + +`func (o *LifecycleState) GetIdentityCountOk() (*int32, bool)` + +GetIdentityCountOk returns a tuple with the IdentityCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityCount + +`func (o *LifecycleState) SetIdentityCount(v int32)` + +SetIdentityCount sets IdentityCount field to given value. + +### HasIdentityCount + +`func (o *LifecycleState) HasIdentityCount() bool` + +HasIdentityCount returns a boolean if a field has been set. + +### GetEmailNotificationOption + +`func (o *LifecycleState) GetEmailNotificationOption() EmailNotificationOption` + +GetEmailNotificationOption returns the EmailNotificationOption field if non-nil, zero value otherwise. + +### GetEmailNotificationOptionOk + +`func (o *LifecycleState) GetEmailNotificationOptionOk() (*EmailNotificationOption, bool)` + +GetEmailNotificationOptionOk returns a tuple with the EmailNotificationOption field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationOption + +`func (o *LifecycleState) SetEmailNotificationOption(v EmailNotificationOption)` + +SetEmailNotificationOption sets EmailNotificationOption field to given value. + +### HasEmailNotificationOption + +`func (o *LifecycleState) HasEmailNotificationOption() bool` + +HasEmailNotificationOption returns a boolean if a field has been set. + +### GetAccountActions + +`func (o *LifecycleState) GetAccountActions() []AccountAction` + +GetAccountActions returns the AccountActions field if non-nil, zero value otherwise. + +### GetAccountActionsOk + +`func (o *LifecycleState) GetAccountActionsOk() (*[]AccountAction, bool)` + +GetAccountActionsOk returns a tuple with the AccountActions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActions + +`func (o *LifecycleState) SetAccountActions(v []AccountAction)` + +SetAccountActions sets AccountActions field to given value. + +### HasAccountActions + +`func (o *LifecycleState) HasAccountActions() bool` + +HasAccountActions returns a boolean if a field has been set. + +### GetAccessProfileIds + +`func (o *LifecycleState) GetAccessProfileIds() []string` + +GetAccessProfileIds returns the AccessProfileIds field if non-nil, zero value otherwise. + +### GetAccessProfileIdsOk + +`func (o *LifecycleState) GetAccessProfileIdsOk() (*[]string, bool)` + +GetAccessProfileIdsOk returns a tuple with the AccessProfileIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileIds + +`func (o *LifecycleState) SetAccessProfileIds(v []string)` + +SetAccessProfileIds sets AccessProfileIds field to given value. + +### HasAccessProfileIds + +`func (o *LifecycleState) HasAccessProfileIds() bool` + +HasAccessProfileIds returns a boolean if a field has been set. + +### GetIdentityState + +`func (o *LifecycleState) GetIdentityState() string` + +GetIdentityState returns the IdentityState field if non-nil, zero value otherwise. + +### GetIdentityStateOk + +`func (o *LifecycleState) GetIdentityStateOk() (*string, bool)` + +GetIdentityStateOk returns a tuple with the IdentityState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityState + +`func (o *LifecycleState) SetIdentityState(v string)` + +SetIdentityState sets IdentityState field to given value. + +### HasIdentityState + +`func (o *LifecycleState) HasIdentityState() bool` + +HasIdentityState returns a boolean if a field has been set. + +### SetIdentityStateNil + +`func (o *LifecycleState) SetIdentityStateNil(b bool)` + + SetIdentityStateNil sets the value for IdentityState to be an explicit nil + +### UnsetIdentityState +`func (o *LifecycleState) UnsetIdentityState()` + +UnsetIdentityState ensures that no value is present for IdentityState, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/LifecyclestateDeleted.md b/docs/tools/sdk/go/Reference/V3/Models/LifecyclestateDeleted.md new file mode 100644 index 000000000..559583403 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/LifecyclestateDeleted.md @@ -0,0 +1,116 @@ +--- +id: lifecyclestate-deleted +title: LifecyclestateDeleted +pagination_label: LifecyclestateDeleted +sidebar_label: LifecyclestateDeleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LifecyclestateDeleted', 'LifecyclestateDeleted'] +slug: /tools/sdk/go/v3/models/lifecyclestate-deleted +tags: ['SDK', 'Software Development Kit', 'LifecyclestateDeleted', 'LifecyclestateDeleted'] +--- + +# LifecyclestateDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Deleted lifecycle state's DTO type. | [optional] +**Id** | Pointer to **string** | Deleted lifecycle state ID. | [optional] +**Name** | Pointer to **string** | Deleted lifecycle state's display name. | [optional] + +## Methods + +### NewLifecyclestateDeleted + +`func NewLifecyclestateDeleted() *LifecyclestateDeleted` + +NewLifecyclestateDeleted instantiates a new LifecyclestateDeleted 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 + +### NewLifecyclestateDeletedWithDefaults + +`func NewLifecyclestateDeletedWithDefaults() *LifecyclestateDeleted` + +NewLifecyclestateDeletedWithDefaults instantiates a new LifecyclestateDeleted 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 + +### GetType + +`func (o *LifecyclestateDeleted) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LifecyclestateDeleted) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LifecyclestateDeleted) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LifecyclestateDeleted) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *LifecyclestateDeleted) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LifecyclestateDeleted) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LifecyclestateDeleted) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LifecyclestateDeleted) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *LifecyclestateDeleted) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LifecyclestateDeleted) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *LifecyclestateDeleted) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *LifecyclestateDeleted) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ListAccessProfiles401Response.md b/docs/tools/sdk/go/Reference/V3/Models/ListAccessProfiles401Response.md new file mode 100644 index 000000000..15ccb992f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ListAccessProfiles401Response.md @@ -0,0 +1,64 @@ +--- +id: list-access-profiles401-response +title: ListAccessProfiles401Response +pagination_label: ListAccessProfiles401Response +sidebar_label: ListAccessProfiles401Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListAccessProfiles401Response', 'ListAccessProfiles401Response'] +slug: /tools/sdk/go/v3/models/list-access-profiles401-response +tags: ['SDK', 'Software Development Kit', 'ListAccessProfiles401Response', 'ListAccessProfiles401Response'] +--- + +# ListAccessProfiles401Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Error** | Pointer to **map[string]interface{}** | A message describing the error | [optional] + +## Methods + +### NewListAccessProfiles401Response + +`func NewListAccessProfiles401Response() *ListAccessProfiles401Response` + +NewListAccessProfiles401Response instantiates a new ListAccessProfiles401Response 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 + +### NewListAccessProfiles401ResponseWithDefaults + +`func NewListAccessProfiles401ResponseWithDefaults() *ListAccessProfiles401Response` + +NewListAccessProfiles401ResponseWithDefaults instantiates a new ListAccessProfiles401Response 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 + +### GetError + +`func (o *ListAccessProfiles401Response) GetError() map[string]interface{}` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *ListAccessProfiles401Response) GetErrorOk() (*map[string]interface{}, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *ListAccessProfiles401Response) SetError(v map[string]interface{})` + +SetError sets Error field to given value. + +### HasError + +`func (o *ListAccessProfiles401Response) HasError() bool` + +HasError returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ListAccessProfiles429Response.md b/docs/tools/sdk/go/Reference/V3/Models/ListAccessProfiles429Response.md new file mode 100644 index 000000000..ae156a939 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ListAccessProfiles429Response.md @@ -0,0 +1,64 @@ +--- +id: list-access-profiles429-response +title: ListAccessProfiles429Response +pagination_label: ListAccessProfiles429Response +sidebar_label: ListAccessProfiles429Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListAccessProfiles429Response', 'ListAccessProfiles429Response'] +slug: /tools/sdk/go/v3/models/list-access-profiles429-response +tags: ['SDK', 'Software Development Kit', 'ListAccessProfiles429Response', 'ListAccessProfiles429Response'] +--- + +# ListAccessProfiles429Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **map[string]interface{}** | A message describing the error | [optional] + +## Methods + +### NewListAccessProfiles429Response + +`func NewListAccessProfiles429Response() *ListAccessProfiles429Response` + +NewListAccessProfiles429Response instantiates a new ListAccessProfiles429Response 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 + +### NewListAccessProfiles429ResponseWithDefaults + +`func NewListAccessProfiles429ResponseWithDefaults() *ListAccessProfiles429Response` + +NewListAccessProfiles429ResponseWithDefaults instantiates a new ListAccessProfiles429Response 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 + +### GetMessage + +`func (o *ListAccessProfiles429Response) GetMessage() map[string]interface{}` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *ListAccessProfiles429Response) GetMessageOk() (*map[string]interface{}, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *ListAccessProfiles429Response) SetMessage(v map[string]interface{})` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *ListAccessProfiles429Response) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ListCampaignFilters200Response.md b/docs/tools/sdk/go/Reference/V3/Models/ListCampaignFilters200Response.md new file mode 100644 index 000000000..be3f2e058 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ListCampaignFilters200Response.md @@ -0,0 +1,90 @@ +--- +id: list-campaign-filters200-response +title: ListCampaignFilters200Response +pagination_label: ListCampaignFilters200Response +sidebar_label: ListCampaignFilters200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListCampaignFilters200Response', 'ListCampaignFilters200Response'] +slug: /tools/sdk/go/v3/models/list-campaign-filters200-response +tags: ['SDK', 'Software Development Kit', 'ListCampaignFilters200Response', 'ListCampaignFilters200Response'] +--- + +# ListCampaignFilters200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Items** | Pointer to [**[]CampaignFilterDetails**](campaign-filter-details) | List of campaign filters. | [optional] +**Count** | Pointer to **int32** | Number of filters returned. | [optional] + +## Methods + +### NewListCampaignFilters200Response + +`func NewListCampaignFilters200Response() *ListCampaignFilters200Response` + +NewListCampaignFilters200Response instantiates a new ListCampaignFilters200Response 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 + +### NewListCampaignFilters200ResponseWithDefaults + +`func NewListCampaignFilters200ResponseWithDefaults() *ListCampaignFilters200Response` + +NewListCampaignFilters200ResponseWithDefaults instantiates a new ListCampaignFilters200Response 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 + +### GetItems + +`func (o *ListCampaignFilters200Response) GetItems() []CampaignFilterDetails` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *ListCampaignFilters200Response) GetItemsOk() (*[]CampaignFilterDetails, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *ListCampaignFilters200Response) SetItems(v []CampaignFilterDetails)` + +SetItems sets Items field to given value. + +### HasItems + +`func (o *ListCampaignFilters200Response) HasItems() bool` + +HasItems returns a boolean if a field has been set. + +### GetCount + +`func (o *ListCampaignFilters200Response) GetCount() int32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *ListCampaignFilters200Response) GetCountOk() (*int32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *ListCampaignFilters200Response) SetCount(v int32)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *ListCampaignFilters200Response) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ListCompleteWorkflowLibrary200ResponseInner.md b/docs/tools/sdk/go/Reference/V3/Models/ListCompleteWorkflowLibrary200ResponseInner.md new file mode 100644 index 000000000..568e5e4ba --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ListCompleteWorkflowLibrary200ResponseInner.md @@ -0,0 +1,396 @@ +--- +id: list-complete-workflow-library200-response-inner +title: ListCompleteWorkflowLibrary200ResponseInner +pagination_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ListCompleteWorkflowLibrary200ResponseInner', 'ListCompleteWorkflowLibrary200ResponseInner'] +slug: /tools/sdk/go/v3/models/list-complete-workflow-library200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListCompleteWorkflowLibrary200ResponseInner', 'ListCompleteWorkflowLibrary200ResponseInner'] +--- + +# ListCompleteWorkflowLibrary200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Operator ID. | [optional] +**Name** | Pointer to **string** | Operator friendly name | [optional] +**Type** | Pointer to **string** | Operator type | [optional] +**Description** | Pointer to **string** | Description of the operator | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] +**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**Deprecated** | Pointer to **bool** | | [optional] +**DeprecatedBy** | Pointer to **SailPointTime** | | [optional] +**VersionNumber** | Pointer to **int32** | Version number | [optional] +**IsSimulationEnabled** | Pointer to **bool** | | [optional] +**IsDynamicSchema** | Pointer to **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**OutputSchema** | Pointer to **map[string]interface{}** | Example output schema | [optional] +**InputExample** | Pointer to **map[string]interface{}** | Example trigger payload if applicable | [optional] + +## Methods + +### NewListCompleteWorkflowLibrary200ResponseInner + +`func NewListCompleteWorkflowLibrary200ResponseInner() *ListCompleteWorkflowLibrary200ResponseInner` + +NewListCompleteWorkflowLibrary200ResponseInner instantiates a new ListCompleteWorkflowLibrary200ResponseInner 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 + +### NewListCompleteWorkflowLibrary200ResponseInnerWithDefaults + +`func NewListCompleteWorkflowLibrary200ResponseInnerWithDefaults() *ListCompleteWorkflowLibrary200ResponseInner` + +NewListCompleteWorkflowLibrary200ResponseInnerWithDefaults instantiates a new ListCompleteWorkflowLibrary200ResponseInner 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 + +### GetId + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDescription + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetFormFields + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetFormFields() []WorkflowLibraryFormFields` + +GetFormFields returns the FormFields field if non-nil, zero value otherwise. + +### GetFormFieldsOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetFormFieldsOk() (*[]WorkflowLibraryFormFields, bool)` + +GetFormFieldsOk returns a tuple with the FormFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormFields + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetFormFields(v []WorkflowLibraryFormFields)` + +SetFormFields sets FormFields field to given value. + +### HasFormFields + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasFormFields() bool` + +HasFormFields returns a boolean if a field has been set. + +### SetFormFieldsNil + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetFormFieldsNil(b bool)` + + SetFormFieldsNil sets the value for FormFields to be an explicit nil + +### UnsetFormFields +`func (o *ListCompleteWorkflowLibrary200ResponseInner) UnsetFormFields()` + +UnsetFormFields ensures that no value is present for FormFields, not even an explicit nil +### GetExampleOutput + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetExampleOutput() WorkflowLibraryActionExampleOutput` + +GetExampleOutput returns the ExampleOutput field if non-nil, zero value otherwise. + +### GetExampleOutputOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetExampleOutputOk() (*WorkflowLibraryActionExampleOutput, bool)` + +GetExampleOutputOk returns a tuple with the ExampleOutput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExampleOutput + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetExampleOutput(v WorkflowLibraryActionExampleOutput)` + +SetExampleOutput sets ExampleOutput field to given value. + +### HasExampleOutput + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasExampleOutput() bool` + +HasExampleOutput returns a boolean if a field has been set. + +### GetDeprecated + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDeprecated() bool` + +GetDeprecated returns the Deprecated field if non-nil, zero value otherwise. + +### GetDeprecatedOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDeprecatedOk() (*bool, bool)` + +GetDeprecatedOk returns a tuple with the Deprecated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecated + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetDeprecated(v bool)` + +SetDeprecated sets Deprecated field to given value. + +### HasDeprecated + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasDeprecated() bool` + +HasDeprecated returns a boolean if a field has been set. + +### GetDeprecatedBy + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDeprecatedBy() SailPointTime` + +GetDeprecatedBy returns the DeprecatedBy field if non-nil, zero value otherwise. + +### GetDeprecatedByOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetDeprecatedByOk() (*SailPointTime, bool)` + +GetDeprecatedByOk returns a tuple with the DeprecatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecatedBy + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetDeprecatedBy(v SailPointTime)` + +SetDeprecatedBy sets DeprecatedBy field to given value. + +### HasDeprecatedBy + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasDeprecatedBy() bool` + +HasDeprecatedBy returns a boolean if a field has been set. + +### GetVersionNumber + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetVersionNumber() int32` + +GetVersionNumber returns the VersionNumber field if non-nil, zero value otherwise. + +### GetVersionNumberOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetVersionNumberOk() (*int32, bool)` + +GetVersionNumberOk returns a tuple with the VersionNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionNumber + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetVersionNumber(v int32)` + +SetVersionNumber sets VersionNumber field to given value. + +### HasVersionNumber + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasVersionNumber() bool` + +HasVersionNumber returns a boolean if a field has been set. + +### GetIsSimulationEnabled + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIsSimulationEnabled() bool` + +GetIsSimulationEnabled returns the IsSimulationEnabled field if non-nil, zero value otherwise. + +### GetIsSimulationEnabledOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIsSimulationEnabledOk() (*bool, bool)` + +GetIsSimulationEnabledOk returns a tuple with the IsSimulationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSimulationEnabled + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetIsSimulationEnabled(v bool)` + +SetIsSimulationEnabled sets IsSimulationEnabled field to given value. + +### HasIsSimulationEnabled + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasIsSimulationEnabled() bool` + +HasIsSimulationEnabled returns a boolean if a field has been set. + +### GetIsDynamicSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIsDynamicSchema() bool` + +GetIsDynamicSchema returns the IsDynamicSchema field if non-nil, zero value otherwise. + +### GetIsDynamicSchemaOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetIsDynamicSchemaOk() (*bool, bool)` + +GetIsDynamicSchemaOk returns a tuple with the IsDynamicSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDynamicSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetIsDynamicSchema(v bool)` + +SetIsDynamicSchema sets IsDynamicSchema field to given value. + +### HasIsDynamicSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasIsDynamicSchema() bool` + +HasIsDynamicSchema returns a boolean if a field has been set. + +### GetOutputSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetOutputSchema() map[string]interface{}` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetOutputSchemaOk() (*map[string]interface{}, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetOutputSchema(v map[string]interface{})` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + +### GetInputExample + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetInputExample() map[string]interface{}` + +GetInputExample returns the InputExample field if non-nil, zero value otherwise. + +### GetInputExampleOk + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) GetInputExampleOk() (*map[string]interface{}, bool)` + +GetInputExampleOk returns a tuple with the InputExample field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInputExample + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetInputExample(v map[string]interface{})` + +SetInputExample sets InputExample field to given value. + +### HasInputExample + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) HasInputExample() bool` + +HasInputExample returns a boolean if a field has been set. + +### SetInputExampleNil + +`func (o *ListCompleteWorkflowLibrary200ResponseInner) SetInputExampleNil(b bool)` + + SetInputExampleNil sets the value for InputExample to be an explicit nil + +### UnsetInputExample +`func (o *ListCompleteWorkflowLibrary200ResponseInner) UnsetInputExample()` + +UnsetInputExample ensures that no value is present for InputExample, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/LocaleOrigin.md b/docs/tools/sdk/go/Reference/V3/Models/LocaleOrigin.md new file mode 100644 index 000000000..22b10abf9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/LocaleOrigin.md @@ -0,0 +1,21 @@ +--- +id: locale-origin +title: LocaleOrigin +pagination_label: LocaleOrigin +sidebar_label: LocaleOrigin +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LocaleOrigin', 'LocaleOrigin'] +slug: /tools/sdk/go/v3/models/locale-origin +tags: ['SDK', 'Software Development Kit', 'LocaleOrigin', 'LocaleOrigin'] +--- + +# LocaleOrigin + +## Enum + + +* `DEFAULT` (value: `"DEFAULT"`) + +* `REQUEST` (value: `"REQUEST"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/LockoutConfiguration.md b/docs/tools/sdk/go/Reference/V3/Models/LockoutConfiguration.md new file mode 100644 index 000000000..255d6f460 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/LockoutConfiguration.md @@ -0,0 +1,116 @@ +--- +id: lockout-configuration +title: LockoutConfiguration +pagination_label: LockoutConfiguration +sidebar_label: LockoutConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'LockoutConfiguration', 'LockoutConfiguration'] +slug: /tools/sdk/go/v3/models/lockout-configuration +tags: ['SDK', 'Software Development Kit', 'LockoutConfiguration', 'LockoutConfiguration'] +--- + +# LockoutConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaximumAttempts** | Pointer to **int32** | The maximum attempts allowed before lockout occurs. | [optional] +**LockoutDuration** | Pointer to **int32** | The total time in minutes a user will be locked out. | [optional] +**LockoutWindow** | Pointer to **int32** | A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. | [optional] + +## Methods + +### NewLockoutConfiguration + +`func NewLockoutConfiguration() *LockoutConfiguration` + +NewLockoutConfiguration instantiates a new LockoutConfiguration 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 + +### NewLockoutConfigurationWithDefaults + +`func NewLockoutConfigurationWithDefaults() *LockoutConfiguration` + +NewLockoutConfigurationWithDefaults instantiates a new LockoutConfiguration 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 + +### GetMaximumAttempts + +`func (o *LockoutConfiguration) GetMaximumAttempts() int32` + +GetMaximumAttempts returns the MaximumAttempts field if non-nil, zero value otherwise. + +### GetMaximumAttemptsOk + +`func (o *LockoutConfiguration) GetMaximumAttemptsOk() (*int32, bool)` + +GetMaximumAttemptsOk returns a tuple with the MaximumAttempts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaximumAttempts + +`func (o *LockoutConfiguration) SetMaximumAttempts(v int32)` + +SetMaximumAttempts sets MaximumAttempts field to given value. + +### HasMaximumAttempts + +`func (o *LockoutConfiguration) HasMaximumAttempts() bool` + +HasMaximumAttempts returns a boolean if a field has been set. + +### GetLockoutDuration + +`func (o *LockoutConfiguration) GetLockoutDuration() int32` + +GetLockoutDuration returns the LockoutDuration field if non-nil, zero value otherwise. + +### GetLockoutDurationOk + +`func (o *LockoutConfiguration) GetLockoutDurationOk() (*int32, bool)` + +GetLockoutDurationOk returns a tuple with the LockoutDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLockoutDuration + +`func (o *LockoutConfiguration) SetLockoutDuration(v int32)` + +SetLockoutDuration sets LockoutDuration field to given value. + +### HasLockoutDuration + +`func (o *LockoutConfiguration) HasLockoutDuration() bool` + +HasLockoutDuration returns a boolean if a field has been set. + +### GetLockoutWindow + +`func (o *LockoutConfiguration) GetLockoutWindow() int32` + +GetLockoutWindow returns the LockoutWindow field if non-nil, zero value otherwise. + +### GetLockoutWindowOk + +`func (o *LockoutConfiguration) GetLockoutWindowOk() (*int32, bool)` + +GetLockoutWindowOk returns a tuple with the LockoutWindow field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLockoutWindow + +`func (o *LockoutConfiguration) SetLockoutWindow(v int32)` + +SetLockoutWindow sets LockoutWindow field to given value. + +### HasLockoutWindow + +`func (o *LockoutConfiguration) HasLockoutWindow() bool` + +HasLockoutWindow returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManagedClient.md b/docs/tools/sdk/go/Reference/V3/Models/ManagedClient.md new file mode 100644 index 000000000..6962fd4b8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManagedClient.md @@ -0,0 +1,734 @@ +--- +id: managed-client +title: ManagedClient +pagination_label: ManagedClient +sidebar_label: ManagedClient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClient', 'ManagedClient'] +slug: /tools/sdk/go/v3/models/managed-client +tags: ['SDK', 'Software Development Kit', 'ManagedClient', 'ManagedClient'] +--- + +# ManagedClient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | ManagedClient ID | [optional] [readonly] +**AlertKey** | Pointer to **NullableString** | ManagedClient alert key | [optional] [readonly] +**ApiGatewayBaseUrl** | Pointer to **NullableString** | | [optional] +**Cookbook** | Pointer to **NullableString** | | [optional] +**CcId** | Pointer to **NullableInt64** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] +**ClientId** | **string** | The client ID used in API management | +**ClusterId** | **string** | Cluster ID that the ManagedClient is linked to | +**Description** | **string** | ManagedClient description | [default to ""] +**IpAddress** | Pointer to **NullableString** | The public IP address of the ManagedClient | [optional] [readonly] +**LastSeen** | Pointer to **NullableTime** | When the ManagedClient was last seen by the server | [optional] [readonly] +**Name** | Pointer to **NullableString** | ManagedClient name | [optional] [default to "VA-$clientId"] +**SinceLastSeen** | Pointer to **NullableString** | Milliseconds since the ManagedClient has polled the server | [optional] [readonly] +**Status** | Pointer to **NullableString** | Status of the ManagedClient | [optional] [readonly] +**Type** | **string** | Type of the ManagedClient (VA, CCG) | +**ClusterType** | Pointer to **NullableString** | Cluster Type of the ManagedClient | [optional] [readonly] +**VaDownloadUrl** | Pointer to **NullableString** | ManagedClient VA download URL | [optional] [readonly] +**VaVersion** | Pointer to **NullableString** | Version that the ManagedClient's VA is running | [optional] [readonly] +**Secret** | Pointer to **NullableString** | Client's apiKey | [optional] +**CreatedAt** | Pointer to **NullableTime** | The date/time this ManagedClient was created | [optional] +**UpdatedAt** | Pointer to **NullableTime** | The date/time this ManagedClient was last updated | [optional] +**ProvisionStatus** | Pointer to **NullableString** | The provisioning status of the ManagedClient | [optional] [readonly] + +## Methods + +### NewManagedClient + +`func NewManagedClient(clientId string, clusterId string, description string, type_ string, ) *ManagedClient` + +NewManagedClient instantiates a new ManagedClient 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 + +### NewManagedClientWithDefaults + +`func NewManagedClientWithDefaults() *ManagedClient` + +NewManagedClientWithDefaults instantiates a new ManagedClient 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 + +### GetId + +`func (o *ManagedClient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManagedClient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManagedClient) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ManagedClient) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *ManagedClient) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *ManagedClient) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetAlertKey + +`func (o *ManagedClient) GetAlertKey() string` + +GetAlertKey returns the AlertKey field if non-nil, zero value otherwise. + +### GetAlertKeyOk + +`func (o *ManagedClient) GetAlertKeyOk() (*string, bool)` + +GetAlertKeyOk returns a tuple with the AlertKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertKey + +`func (o *ManagedClient) SetAlertKey(v string)` + +SetAlertKey sets AlertKey field to given value. + +### HasAlertKey + +`func (o *ManagedClient) HasAlertKey() bool` + +HasAlertKey returns a boolean if a field has been set. + +### SetAlertKeyNil + +`func (o *ManagedClient) SetAlertKeyNil(b bool)` + + SetAlertKeyNil sets the value for AlertKey to be an explicit nil + +### UnsetAlertKey +`func (o *ManagedClient) UnsetAlertKey()` + +UnsetAlertKey ensures that no value is present for AlertKey, not even an explicit nil +### GetApiGatewayBaseUrl + +`func (o *ManagedClient) GetApiGatewayBaseUrl() string` + +GetApiGatewayBaseUrl returns the ApiGatewayBaseUrl field if non-nil, zero value otherwise. + +### GetApiGatewayBaseUrlOk + +`func (o *ManagedClient) GetApiGatewayBaseUrlOk() (*string, bool)` + +GetApiGatewayBaseUrlOk returns a tuple with the ApiGatewayBaseUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApiGatewayBaseUrl + +`func (o *ManagedClient) SetApiGatewayBaseUrl(v string)` + +SetApiGatewayBaseUrl sets ApiGatewayBaseUrl field to given value. + +### HasApiGatewayBaseUrl + +`func (o *ManagedClient) HasApiGatewayBaseUrl() bool` + +HasApiGatewayBaseUrl returns a boolean if a field has been set. + +### SetApiGatewayBaseUrlNil + +`func (o *ManagedClient) SetApiGatewayBaseUrlNil(b bool)` + + SetApiGatewayBaseUrlNil sets the value for ApiGatewayBaseUrl to be an explicit nil + +### UnsetApiGatewayBaseUrl +`func (o *ManagedClient) UnsetApiGatewayBaseUrl()` + +UnsetApiGatewayBaseUrl ensures that no value is present for ApiGatewayBaseUrl, not even an explicit nil +### GetCookbook + +`func (o *ManagedClient) GetCookbook() string` + +GetCookbook returns the Cookbook field if non-nil, zero value otherwise. + +### GetCookbookOk + +`func (o *ManagedClient) GetCookbookOk() (*string, bool)` + +GetCookbookOk returns a tuple with the Cookbook field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCookbook + +`func (o *ManagedClient) SetCookbook(v string)` + +SetCookbook sets Cookbook field to given value. + +### HasCookbook + +`func (o *ManagedClient) HasCookbook() bool` + +HasCookbook returns a boolean if a field has been set. + +### SetCookbookNil + +`func (o *ManagedClient) SetCookbookNil(b bool)` + + SetCookbookNil sets the value for Cookbook to be an explicit nil + +### UnsetCookbook +`func (o *ManagedClient) UnsetCookbook()` + +UnsetCookbook ensures that no value is present for Cookbook, not even an explicit nil +### GetCcId + +`func (o *ManagedClient) GetCcId() int64` + +GetCcId returns the CcId field if non-nil, zero value otherwise. + +### GetCcIdOk + +`func (o *ManagedClient) GetCcIdOk() (*int64, bool)` + +GetCcIdOk returns a tuple with the CcId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCcId + +`func (o *ManagedClient) SetCcId(v int64)` + +SetCcId sets CcId field to given value. + +### HasCcId + +`func (o *ManagedClient) HasCcId() bool` + +HasCcId returns a boolean if a field has been set. + +### SetCcIdNil + +`func (o *ManagedClient) SetCcIdNil(b bool)` + + SetCcIdNil sets the value for CcId to be an explicit nil + +### UnsetCcId +`func (o *ManagedClient) UnsetCcId()` + +UnsetCcId ensures that no value is present for CcId, not even an explicit nil +### GetClientId + +`func (o *ManagedClient) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *ManagedClient) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *ManagedClient) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + + +### GetClusterId + +`func (o *ManagedClient) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *ManagedClient) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *ManagedClient) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + + +### GetDescription + +`func (o *ManagedClient) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManagedClient) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManagedClient) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetIpAddress + +`func (o *ManagedClient) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *ManagedClient) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *ManagedClient) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + +### HasIpAddress + +`func (o *ManagedClient) HasIpAddress() bool` + +HasIpAddress returns a boolean if a field has been set. + +### SetIpAddressNil + +`func (o *ManagedClient) SetIpAddressNil(b bool)` + + SetIpAddressNil sets the value for IpAddress to be an explicit nil + +### UnsetIpAddress +`func (o *ManagedClient) UnsetIpAddress()` + +UnsetIpAddress ensures that no value is present for IpAddress, not even an explicit nil +### GetLastSeen + +`func (o *ManagedClient) GetLastSeen() SailPointTime` + +GetLastSeen returns the LastSeen field if non-nil, zero value otherwise. + +### GetLastSeenOk + +`func (o *ManagedClient) GetLastSeenOk() (*SailPointTime, bool)` + +GetLastSeenOk returns a tuple with the LastSeen field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastSeen + +`func (o *ManagedClient) SetLastSeen(v SailPointTime)` + +SetLastSeen sets LastSeen field to given value. + +### HasLastSeen + +`func (o *ManagedClient) HasLastSeen() bool` + +HasLastSeen returns a boolean if a field has been set. + +### SetLastSeenNil + +`func (o *ManagedClient) SetLastSeenNil(b bool)` + + SetLastSeenNil sets the value for LastSeen to be an explicit nil + +### UnsetLastSeen +`func (o *ManagedClient) UnsetLastSeen()` + +UnsetLastSeen ensures that no value is present for LastSeen, not even an explicit nil +### GetName + +`func (o *ManagedClient) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedClient) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedClient) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManagedClient) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ManagedClient) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ManagedClient) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetSinceLastSeen + +`func (o *ManagedClient) GetSinceLastSeen() string` + +GetSinceLastSeen returns the SinceLastSeen field if non-nil, zero value otherwise. + +### GetSinceLastSeenOk + +`func (o *ManagedClient) GetSinceLastSeenOk() (*string, bool)` + +GetSinceLastSeenOk returns a tuple with the SinceLastSeen field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSinceLastSeen + +`func (o *ManagedClient) SetSinceLastSeen(v string)` + +SetSinceLastSeen sets SinceLastSeen field to given value. + +### HasSinceLastSeen + +`func (o *ManagedClient) HasSinceLastSeen() bool` + +HasSinceLastSeen returns a boolean if a field has been set. + +### SetSinceLastSeenNil + +`func (o *ManagedClient) SetSinceLastSeenNil(b bool)` + + SetSinceLastSeenNil sets the value for SinceLastSeen to be an explicit nil + +### UnsetSinceLastSeen +`func (o *ManagedClient) UnsetSinceLastSeen()` + +UnsetSinceLastSeen ensures that no value is present for SinceLastSeen, not even an explicit nil +### GetStatus + +`func (o *ManagedClient) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManagedClient) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManagedClient) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ManagedClient) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatusNil + +`func (o *ManagedClient) SetStatusNil(b bool)` + + SetStatusNil sets the value for Status to be an explicit nil + +### UnsetStatus +`func (o *ManagedClient) UnsetStatus()` + +UnsetStatus ensures that no value is present for Status, not even an explicit nil +### GetType + +`func (o *ManagedClient) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClient) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClient) SetType(v string)` + +SetType sets Type field to given value. + + +### GetClusterType + +`func (o *ManagedClient) GetClusterType() string` + +GetClusterType returns the ClusterType field if non-nil, zero value otherwise. + +### GetClusterTypeOk + +`func (o *ManagedClient) GetClusterTypeOk() (*string, bool)` + +GetClusterTypeOk returns a tuple with the ClusterType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterType + +`func (o *ManagedClient) SetClusterType(v string)` + +SetClusterType sets ClusterType field to given value. + +### HasClusterType + +`func (o *ManagedClient) HasClusterType() bool` + +HasClusterType returns a boolean if a field has been set. + +### SetClusterTypeNil + +`func (o *ManagedClient) SetClusterTypeNil(b bool)` + + SetClusterTypeNil sets the value for ClusterType to be an explicit nil + +### UnsetClusterType +`func (o *ManagedClient) UnsetClusterType()` + +UnsetClusterType ensures that no value is present for ClusterType, not even an explicit nil +### GetVaDownloadUrl + +`func (o *ManagedClient) GetVaDownloadUrl() string` + +GetVaDownloadUrl returns the VaDownloadUrl field if non-nil, zero value otherwise. + +### GetVaDownloadUrlOk + +`func (o *ManagedClient) GetVaDownloadUrlOk() (*string, bool)` + +GetVaDownloadUrlOk returns a tuple with the VaDownloadUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVaDownloadUrl + +`func (o *ManagedClient) SetVaDownloadUrl(v string)` + +SetVaDownloadUrl sets VaDownloadUrl field to given value. + +### HasVaDownloadUrl + +`func (o *ManagedClient) HasVaDownloadUrl() bool` + +HasVaDownloadUrl returns a boolean if a field has been set. + +### SetVaDownloadUrlNil + +`func (o *ManagedClient) SetVaDownloadUrlNil(b bool)` + + SetVaDownloadUrlNil sets the value for VaDownloadUrl to be an explicit nil + +### UnsetVaDownloadUrl +`func (o *ManagedClient) UnsetVaDownloadUrl()` + +UnsetVaDownloadUrl ensures that no value is present for VaDownloadUrl, not even an explicit nil +### GetVaVersion + +`func (o *ManagedClient) GetVaVersion() string` + +GetVaVersion returns the VaVersion field if non-nil, zero value otherwise. + +### GetVaVersionOk + +`func (o *ManagedClient) GetVaVersionOk() (*string, bool)` + +GetVaVersionOk returns a tuple with the VaVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVaVersion + +`func (o *ManagedClient) SetVaVersion(v string)` + +SetVaVersion sets VaVersion field to given value. + +### HasVaVersion + +`func (o *ManagedClient) HasVaVersion() bool` + +HasVaVersion returns a boolean if a field has been set. + +### SetVaVersionNil + +`func (o *ManagedClient) SetVaVersionNil(b bool)` + + SetVaVersionNil sets the value for VaVersion to be an explicit nil + +### UnsetVaVersion +`func (o *ManagedClient) UnsetVaVersion()` + +UnsetVaVersion ensures that no value is present for VaVersion, not even an explicit nil +### GetSecret + +`func (o *ManagedClient) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *ManagedClient) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *ManagedClient) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *ManagedClient) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### SetSecretNil + +`func (o *ManagedClient) SetSecretNil(b bool)` + + SetSecretNil sets the value for Secret to be an explicit nil + +### UnsetSecret +`func (o *ManagedClient) UnsetSecret()` + +UnsetSecret ensures that no value is present for Secret, not even an explicit nil +### GetCreatedAt + +`func (o *ManagedClient) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *ManagedClient) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *ManagedClient) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *ManagedClient) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### SetCreatedAtNil + +`func (o *ManagedClient) SetCreatedAtNil(b bool)` + + SetCreatedAtNil sets the value for CreatedAt to be an explicit nil + +### UnsetCreatedAt +`func (o *ManagedClient) UnsetCreatedAt()` + +UnsetCreatedAt ensures that no value is present for CreatedAt, not even an explicit nil +### GetUpdatedAt + +`func (o *ManagedClient) GetUpdatedAt() SailPointTime` + +GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise. + +### GetUpdatedAtOk + +`func (o *ManagedClient) GetUpdatedAtOk() (*SailPointTime, bool)` + +GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedAt + +`func (o *ManagedClient) SetUpdatedAt(v SailPointTime)` + +SetUpdatedAt sets UpdatedAt field to given value. + +### HasUpdatedAt + +`func (o *ManagedClient) HasUpdatedAt() bool` + +HasUpdatedAt returns a boolean if a field has been set. + +### SetUpdatedAtNil + +`func (o *ManagedClient) SetUpdatedAtNil(b bool)` + + SetUpdatedAtNil sets the value for UpdatedAt to be an explicit nil + +### UnsetUpdatedAt +`func (o *ManagedClient) UnsetUpdatedAt()` + +UnsetUpdatedAt ensures that no value is present for UpdatedAt, not even an explicit nil +### GetProvisionStatus + +`func (o *ManagedClient) GetProvisionStatus() string` + +GetProvisionStatus returns the ProvisionStatus field if non-nil, zero value otherwise. + +### GetProvisionStatusOk + +`func (o *ManagedClient) GetProvisionStatusOk() (*string, bool)` + +GetProvisionStatusOk returns a tuple with the ProvisionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisionStatus + +`func (o *ManagedClient) SetProvisionStatus(v string)` + +SetProvisionStatus sets ProvisionStatus field to given value. + +### HasProvisionStatus + +`func (o *ManagedClient) HasProvisionStatus() bool` + +HasProvisionStatus returns a boolean if a field has been set. + +### SetProvisionStatusNil + +`func (o *ManagedClient) SetProvisionStatusNil(b bool)` + + SetProvisionStatusNil sets the value for ProvisionStatus to be an explicit nil + +### UnsetProvisionStatus +`func (o *ManagedClient) UnsetProvisionStatus()` + +UnsetProvisionStatus ensures that no value is present for ProvisionStatus, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManagedClientRequest.md b/docs/tools/sdk/go/Reference/V3/Models/ManagedClientRequest.md new file mode 100644 index 000000000..461a38626 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManagedClientRequest.md @@ -0,0 +1,167 @@ +--- +id: managed-client-request +title: ManagedClientRequest +pagination_label: ManagedClientRequest +sidebar_label: ManagedClientRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClientRequest', 'ManagedClientRequest'] +slug: /tools/sdk/go/v3/models/managed-client-request +tags: ['SDK', 'Software Development Kit', 'ManagedClientRequest', 'ManagedClientRequest'] +--- + +# ManagedClientRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterId** | **string** | Cluster ID that the ManagedClient is linked to | +**Description** | Pointer to **NullableString** | description for the ManagedClient to create | [optional] +**Name** | Pointer to **NullableString** | name for the ManagedClient to create | [optional] +**Type** | Pointer to **NullableString** | Type of the ManagedClient (VA, CCG) to create | [optional] + +## Methods + +### NewManagedClientRequest + +`func NewManagedClientRequest(clusterId string, ) *ManagedClientRequest` + +NewManagedClientRequest instantiates a new ManagedClientRequest 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 + +### NewManagedClientRequestWithDefaults + +`func NewManagedClientRequestWithDefaults() *ManagedClientRequest` + +NewManagedClientRequestWithDefaults instantiates a new ManagedClientRequest 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 + +### GetClusterId + +`func (o *ManagedClientRequest) GetClusterId() string` + +GetClusterId returns the ClusterId field if non-nil, zero value otherwise. + +### GetClusterIdOk + +`func (o *ManagedClientRequest) GetClusterIdOk() (*string, bool)` + +GetClusterIdOk returns a tuple with the ClusterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterId + +`func (o *ManagedClientRequest) SetClusterId(v string)` + +SetClusterId sets ClusterId field to given value. + + +### GetDescription + +`func (o *ManagedClientRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManagedClientRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManagedClientRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ManagedClientRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ManagedClientRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ManagedClientRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetName + +`func (o *ManagedClientRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedClientRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedClientRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManagedClientRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ManagedClientRequest) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ManagedClientRequest) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetType + +`func (o *ManagedClientRequest) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClientRequest) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClientRequest) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManagedClientRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *ManagedClientRequest) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *ManagedClientRequest) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManagedClientStatus.md b/docs/tools/sdk/go/Reference/V3/Models/ManagedClientStatus.md new file mode 100644 index 000000000..95caf5204 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManagedClientStatus.md @@ -0,0 +1,132 @@ +--- +id: managed-client-status +title: ManagedClientStatus +pagination_label: ManagedClientStatus +sidebar_label: ManagedClientStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClientStatus', 'ManagedClientStatus'] +slug: /tools/sdk/go/v3/models/managed-client-status +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatus', 'ManagedClientStatus'] +--- + +# ManagedClientStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Body** | **map[string]interface{}** | ManagedClientStatus body information | +**Status** | [**ManagedClientStatusCode**](managed-client-status-code) | | +**Type** | [**NullableManagedClientType**](managed-client-type) | | +**Timestamp** | **SailPointTime** | timestamp on the Client Status update | + +## Methods + +### NewManagedClientStatus + +`func NewManagedClientStatus(body map[string]interface{}, status ManagedClientStatusCode, type_ NullableManagedClientType, timestamp SailPointTime, ) *ManagedClientStatus` + +NewManagedClientStatus instantiates a new ManagedClientStatus 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 + +### NewManagedClientStatusWithDefaults + +`func NewManagedClientStatusWithDefaults() *ManagedClientStatus` + +NewManagedClientStatusWithDefaults instantiates a new ManagedClientStatus 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 + +### GetBody + +`func (o *ManagedClientStatus) GetBody() map[string]interface{}` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *ManagedClientStatus) GetBodyOk() (*map[string]interface{}, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBody + +`func (o *ManagedClientStatus) SetBody(v map[string]interface{})` + +SetBody sets Body field to given value. + + +### GetStatus + +`func (o *ManagedClientStatus) GetStatus() ManagedClientStatusCode` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManagedClientStatus) GetStatusOk() (*ManagedClientStatusCode, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManagedClientStatus) SetStatus(v ManagedClientStatusCode)` + +SetStatus sets Status field to given value. + + +### GetType + +`func (o *ManagedClientStatus) GetType() ManagedClientType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClientStatus) GetTypeOk() (*ManagedClientType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClientStatus) SetType(v ManagedClientType)` + +SetType sets Type field to given value. + + +### SetTypeNil + +`func (o *ManagedClientStatus) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *ManagedClientStatus) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetTimestamp + +`func (o *ManagedClientStatus) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *ManagedClientStatus) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *ManagedClientStatus) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManagedClientStatusCode.md b/docs/tools/sdk/go/Reference/V3/Models/ManagedClientStatusCode.md new file mode 100644 index 000000000..02698c626 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManagedClientStatusCode.md @@ -0,0 +1,31 @@ +--- +id: managed-client-status-code +title: ManagedClientStatusCode +pagination_label: ManagedClientStatusCode +sidebar_label: ManagedClientStatusCode +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClientStatusCode', 'ManagedClientStatusCode'] +slug: /tools/sdk/go/v3/models/managed-client-status-code +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatusCode', 'ManagedClientStatusCode'] +--- + +# ManagedClientStatusCode + +## Enum + + +* `NORMAL` (value: `"NORMAL"`) + +* `UNDEFINED` (value: `"UNDEFINED"`) + +* `NOT_CONFIGURED` (value: `"NOT_CONFIGURED"`) + +* `CONFIGURING` (value: `"CONFIGURING"`) + +* `WARNING` (value: `"WARNING"`) + +* `ERROR` (value: `"ERROR"`) + +* `FAILED` (value: `"FAILED"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManagedClientType.md b/docs/tools/sdk/go/Reference/V3/Models/ManagedClientType.md new file mode 100644 index 000000000..7658aaf15 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManagedClientType.md @@ -0,0 +1,25 @@ +--- +id: managed-client-type +title: ManagedClientType +pagination_label: ManagedClientType +sidebar_label: ManagedClientType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClientType', 'ManagedClientType'] +slug: /tools/sdk/go/v3/models/managed-client-type +tags: ['SDK', 'Software Development Kit', 'ManagedClientType', 'ManagedClientType'] +--- + +# ManagedClientType + +## Enum + + +* `CCG` (value: `"CCG"`) + +* `VA` (value: `"VA"`) + +* `INTERNAL` (value: `"INTERNAL"`) + +* `IIQ_HARVESTER` (value: `"IIQ_HARVESTER"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManagedCluster.md b/docs/tools/sdk/go/Reference/V3/Models/ManagedCluster.md new file mode 100644 index 000000000..ef3dc5b45 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManagedCluster.md @@ -0,0 +1,743 @@ +--- +id: managed-cluster +title: ManagedCluster +pagination_label: ManagedCluster +sidebar_label: ManagedCluster +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedCluster', 'ManagedCluster'] +slug: /tools/sdk/go/v3/models/managed-cluster +tags: ['SDK', 'Software Development Kit', 'ManagedCluster', 'ManagedCluster'] +--- + +# ManagedCluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | ManagedCluster ID | +**Name** | Pointer to **string** | ManagedCluster name | [optional] +**Pod** | Pointer to **string** | ManagedCluster pod | [optional] +**Org** | Pointer to **string** | ManagedCluster org | [optional] +**Type** | Pointer to [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**Configuration** | Pointer to **map[string]string** | ManagedProcess configuration map | [optional] +**KeyPair** | Pointer to [**ManagedClusterKeyPair**](managed-cluster-key-pair) | | [optional] +**Attributes** | Pointer to [**ManagedClusterAttributes**](managed-cluster-attributes) | | [optional] +**Description** | Pointer to **string** | ManagedCluster description | [optional] [default to "q"] +**Redis** | Pointer to [**ManagedClusterRedis**](managed-cluster-redis) | | [optional] +**ClientType** | [**NullableManagedClientType**](managed-client-type) | | +**CcgVersion** | **string** | CCG version used by the ManagedCluster | +**PinnedConfig** | Pointer to **bool** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to false] +**LogConfiguration** | Pointer to [**NullableClientLogConfiguration**](client-log-configuration) | | [optional] +**Operational** | Pointer to **bool** | Whether or not the cluster is operational or not | [optional] [default to false] +**Status** | Pointer to **string** | Cluster status | [optional] +**PublicKeyCertificate** | Pointer to **NullableString** | Public key certificate | [optional] +**PublicKeyThumbprint** | Pointer to **NullableString** | Public key thumbprint | [optional] +**PublicKey** | Pointer to **NullableString** | Public key | [optional] +**AlertKey** | Pointer to **string** | Key describing any immediate cluster alerts | [optional] +**ClientIds** | Pointer to **[]string** | List of clients in a cluster | [optional] +**ServiceCount** | Pointer to **int32** | Number of services bound to a cluster | [optional] [default to 0] +**CcId** | Pointer to **string** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to "0"] +**CreatedAt** | Pointer to **NullableTime** | The date/time this cluster was created | [optional] +**UpdatedAt** | Pointer to **NullableTime** | The date/time this cluster was last updated | [optional] + +## Methods + +### NewManagedCluster + +`func NewManagedCluster(id string, clientType NullableManagedClientType, ccgVersion string, ) *ManagedCluster` + +NewManagedCluster instantiates a new ManagedCluster 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 + +### NewManagedClusterWithDefaults + +`func NewManagedClusterWithDefaults() *ManagedCluster` + +NewManagedClusterWithDefaults instantiates a new ManagedCluster 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 + +### GetId + +`func (o *ManagedCluster) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManagedCluster) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManagedCluster) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *ManagedCluster) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedCluster) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedCluster) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManagedCluster) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPod + +`func (o *ManagedCluster) GetPod() string` + +GetPod returns the Pod field if non-nil, zero value otherwise. + +### GetPodOk + +`func (o *ManagedCluster) GetPodOk() (*string, bool)` + +GetPodOk returns a tuple with the Pod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPod + +`func (o *ManagedCluster) SetPod(v string)` + +SetPod sets Pod field to given value. + +### HasPod + +`func (o *ManagedCluster) HasPod() bool` + +HasPod returns a boolean if a field has been set. + +### GetOrg + +`func (o *ManagedCluster) GetOrg() string` + +GetOrg returns the Org field if non-nil, zero value otherwise. + +### GetOrgOk + +`func (o *ManagedCluster) GetOrgOk() (*string, bool)` + +GetOrgOk returns a tuple with the Org field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrg + +`func (o *ManagedCluster) SetOrg(v string)` + +SetOrg sets Org field to given value. + +### HasOrg + +`func (o *ManagedCluster) HasOrg() bool` + +HasOrg returns a boolean if a field has been set. + +### GetType + +`func (o *ManagedCluster) GetType() ManagedClusterTypes` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedCluster) GetTypeOk() (*ManagedClusterTypes, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedCluster) SetType(v ManagedClusterTypes)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManagedCluster) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConfiguration + +`func (o *ManagedCluster) GetConfiguration() map[string]string` + +GetConfiguration returns the Configuration field if non-nil, zero value otherwise. + +### GetConfigurationOk + +`func (o *ManagedCluster) GetConfigurationOk() (*map[string]string, bool)` + +GetConfigurationOk returns a tuple with the Configuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfiguration + +`func (o *ManagedCluster) SetConfiguration(v map[string]string)` + +SetConfiguration sets Configuration field to given value. + +### HasConfiguration + +`func (o *ManagedCluster) HasConfiguration() bool` + +HasConfiguration returns a boolean if a field has been set. + +### GetKeyPair + +`func (o *ManagedCluster) GetKeyPair() ManagedClusterKeyPair` + +GetKeyPair returns the KeyPair field if non-nil, zero value otherwise. + +### GetKeyPairOk + +`func (o *ManagedCluster) GetKeyPairOk() (*ManagedClusterKeyPair, bool)` + +GetKeyPairOk returns a tuple with the KeyPair field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKeyPair + +`func (o *ManagedCluster) SetKeyPair(v ManagedClusterKeyPair)` + +SetKeyPair sets KeyPair field to given value. + +### HasKeyPair + +`func (o *ManagedCluster) HasKeyPair() bool` + +HasKeyPair returns a boolean if a field has been set. + +### GetAttributes + +`func (o *ManagedCluster) GetAttributes() ManagedClusterAttributes` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ManagedCluster) GetAttributesOk() (*ManagedClusterAttributes, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ManagedCluster) SetAttributes(v ManagedClusterAttributes)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *ManagedCluster) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetDescription + +`func (o *ManagedCluster) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManagedCluster) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManagedCluster) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ManagedCluster) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetRedis + +`func (o *ManagedCluster) GetRedis() ManagedClusterRedis` + +GetRedis returns the Redis field if non-nil, zero value otherwise. + +### GetRedisOk + +`func (o *ManagedCluster) GetRedisOk() (*ManagedClusterRedis, bool)` + +GetRedisOk returns a tuple with the Redis field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedis + +`func (o *ManagedCluster) SetRedis(v ManagedClusterRedis)` + +SetRedis sets Redis field to given value. + +### HasRedis + +`func (o *ManagedCluster) HasRedis() bool` + +HasRedis returns a boolean if a field has been set. + +### GetClientType + +`func (o *ManagedCluster) GetClientType() ManagedClientType` + +GetClientType returns the ClientType field if non-nil, zero value otherwise. + +### GetClientTypeOk + +`func (o *ManagedCluster) GetClientTypeOk() (*ManagedClientType, bool)` + +GetClientTypeOk returns a tuple with the ClientType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientType + +`func (o *ManagedCluster) SetClientType(v ManagedClientType)` + +SetClientType sets ClientType field to given value. + + +### SetClientTypeNil + +`func (o *ManagedCluster) SetClientTypeNil(b bool)` + + SetClientTypeNil sets the value for ClientType to be an explicit nil + +### UnsetClientType +`func (o *ManagedCluster) UnsetClientType()` + +UnsetClientType ensures that no value is present for ClientType, not even an explicit nil +### GetCcgVersion + +`func (o *ManagedCluster) GetCcgVersion() string` + +GetCcgVersion returns the CcgVersion field if non-nil, zero value otherwise. + +### GetCcgVersionOk + +`func (o *ManagedCluster) GetCcgVersionOk() (*string, bool)` + +GetCcgVersionOk returns a tuple with the CcgVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCcgVersion + +`func (o *ManagedCluster) SetCcgVersion(v string)` + +SetCcgVersion sets CcgVersion field to given value. + + +### GetPinnedConfig + +`func (o *ManagedCluster) GetPinnedConfig() bool` + +GetPinnedConfig returns the PinnedConfig field if non-nil, zero value otherwise. + +### GetPinnedConfigOk + +`func (o *ManagedCluster) GetPinnedConfigOk() (*bool, bool)` + +GetPinnedConfigOk returns a tuple with the PinnedConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPinnedConfig + +`func (o *ManagedCluster) SetPinnedConfig(v bool)` + +SetPinnedConfig sets PinnedConfig field to given value. + +### HasPinnedConfig + +`func (o *ManagedCluster) HasPinnedConfig() bool` + +HasPinnedConfig returns a boolean if a field has been set. + +### GetLogConfiguration + +`func (o *ManagedCluster) GetLogConfiguration() ClientLogConfiguration` + +GetLogConfiguration returns the LogConfiguration field if non-nil, zero value otherwise. + +### GetLogConfigurationOk + +`func (o *ManagedCluster) GetLogConfigurationOk() (*ClientLogConfiguration, bool)` + +GetLogConfigurationOk returns a tuple with the LogConfiguration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogConfiguration + +`func (o *ManagedCluster) SetLogConfiguration(v ClientLogConfiguration)` + +SetLogConfiguration sets LogConfiguration field to given value. + +### HasLogConfiguration + +`func (o *ManagedCluster) HasLogConfiguration() bool` + +HasLogConfiguration returns a boolean if a field has been set. + +### SetLogConfigurationNil + +`func (o *ManagedCluster) SetLogConfigurationNil(b bool)` + + SetLogConfigurationNil sets the value for LogConfiguration to be an explicit nil + +### UnsetLogConfiguration +`func (o *ManagedCluster) UnsetLogConfiguration()` + +UnsetLogConfiguration ensures that no value is present for LogConfiguration, not even an explicit nil +### GetOperational + +`func (o *ManagedCluster) GetOperational() bool` + +GetOperational returns the Operational field if non-nil, zero value otherwise. + +### GetOperationalOk + +`func (o *ManagedCluster) GetOperationalOk() (*bool, bool)` + +GetOperationalOk returns a tuple with the Operational field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperational + +`func (o *ManagedCluster) SetOperational(v bool)` + +SetOperational sets Operational field to given value. + +### HasOperational + +`func (o *ManagedCluster) HasOperational() bool` + +HasOperational returns a boolean if a field has been set. + +### GetStatus + +`func (o *ManagedCluster) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManagedCluster) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManagedCluster) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ManagedCluster) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetPublicKeyCertificate + +`func (o *ManagedCluster) GetPublicKeyCertificate() string` + +GetPublicKeyCertificate returns the PublicKeyCertificate field if non-nil, zero value otherwise. + +### GetPublicKeyCertificateOk + +`func (o *ManagedCluster) GetPublicKeyCertificateOk() (*string, bool)` + +GetPublicKeyCertificateOk returns a tuple with the PublicKeyCertificate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyCertificate + +`func (o *ManagedCluster) SetPublicKeyCertificate(v string)` + +SetPublicKeyCertificate sets PublicKeyCertificate field to given value. + +### HasPublicKeyCertificate + +`func (o *ManagedCluster) HasPublicKeyCertificate() bool` + +HasPublicKeyCertificate returns a boolean if a field has been set. + +### SetPublicKeyCertificateNil + +`func (o *ManagedCluster) SetPublicKeyCertificateNil(b bool)` + + SetPublicKeyCertificateNil sets the value for PublicKeyCertificate to be an explicit nil + +### UnsetPublicKeyCertificate +`func (o *ManagedCluster) UnsetPublicKeyCertificate()` + +UnsetPublicKeyCertificate ensures that no value is present for PublicKeyCertificate, not even an explicit nil +### GetPublicKeyThumbprint + +`func (o *ManagedCluster) GetPublicKeyThumbprint() string` + +GetPublicKeyThumbprint returns the PublicKeyThumbprint field if non-nil, zero value otherwise. + +### GetPublicKeyThumbprintOk + +`func (o *ManagedCluster) GetPublicKeyThumbprintOk() (*string, bool)` + +GetPublicKeyThumbprintOk returns a tuple with the PublicKeyThumbprint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyThumbprint + +`func (o *ManagedCluster) SetPublicKeyThumbprint(v string)` + +SetPublicKeyThumbprint sets PublicKeyThumbprint field to given value. + +### HasPublicKeyThumbprint + +`func (o *ManagedCluster) HasPublicKeyThumbprint() bool` + +HasPublicKeyThumbprint returns a boolean if a field has been set. + +### SetPublicKeyThumbprintNil + +`func (o *ManagedCluster) SetPublicKeyThumbprintNil(b bool)` + + SetPublicKeyThumbprintNil sets the value for PublicKeyThumbprint to be an explicit nil + +### UnsetPublicKeyThumbprint +`func (o *ManagedCluster) UnsetPublicKeyThumbprint()` + +UnsetPublicKeyThumbprint ensures that no value is present for PublicKeyThumbprint, not even an explicit nil +### GetPublicKey + +`func (o *ManagedCluster) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *ManagedCluster) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *ManagedCluster) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *ManagedCluster) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### SetPublicKeyNil + +`func (o *ManagedCluster) SetPublicKeyNil(b bool)` + + SetPublicKeyNil sets the value for PublicKey to be an explicit nil + +### UnsetPublicKey +`func (o *ManagedCluster) UnsetPublicKey()` + +UnsetPublicKey ensures that no value is present for PublicKey, not even an explicit nil +### GetAlertKey + +`func (o *ManagedCluster) GetAlertKey() string` + +GetAlertKey returns the AlertKey field if non-nil, zero value otherwise. + +### GetAlertKeyOk + +`func (o *ManagedCluster) GetAlertKeyOk() (*string, bool)` + +GetAlertKeyOk returns a tuple with the AlertKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlertKey + +`func (o *ManagedCluster) SetAlertKey(v string)` + +SetAlertKey sets AlertKey field to given value. + +### HasAlertKey + +`func (o *ManagedCluster) HasAlertKey() bool` + +HasAlertKey returns a boolean if a field has been set. + +### GetClientIds + +`func (o *ManagedCluster) GetClientIds() []string` + +GetClientIds returns the ClientIds field if non-nil, zero value otherwise. + +### GetClientIdsOk + +`func (o *ManagedCluster) GetClientIdsOk() (*[]string, bool)` + +GetClientIdsOk returns a tuple with the ClientIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientIds + +`func (o *ManagedCluster) SetClientIds(v []string)` + +SetClientIds sets ClientIds field to given value. + +### HasClientIds + +`func (o *ManagedCluster) HasClientIds() bool` + +HasClientIds returns a boolean if a field has been set. + +### GetServiceCount + +`func (o *ManagedCluster) GetServiceCount() int32` + +GetServiceCount returns the ServiceCount field if non-nil, zero value otherwise. + +### GetServiceCountOk + +`func (o *ManagedCluster) GetServiceCountOk() (*int32, bool)` + +GetServiceCountOk returns a tuple with the ServiceCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServiceCount + +`func (o *ManagedCluster) SetServiceCount(v int32)` + +SetServiceCount sets ServiceCount field to given value. + +### HasServiceCount + +`func (o *ManagedCluster) HasServiceCount() bool` + +HasServiceCount returns a boolean if a field has been set. + +### GetCcId + +`func (o *ManagedCluster) GetCcId() string` + +GetCcId returns the CcId field if non-nil, zero value otherwise. + +### GetCcIdOk + +`func (o *ManagedCluster) GetCcIdOk() (*string, bool)` + +GetCcIdOk returns a tuple with the CcId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCcId + +`func (o *ManagedCluster) SetCcId(v string)` + +SetCcId sets CcId field to given value. + +### HasCcId + +`func (o *ManagedCluster) HasCcId() bool` + +HasCcId returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *ManagedCluster) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *ManagedCluster) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *ManagedCluster) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *ManagedCluster) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### SetCreatedAtNil + +`func (o *ManagedCluster) SetCreatedAtNil(b bool)` + + SetCreatedAtNil sets the value for CreatedAt to be an explicit nil + +### UnsetCreatedAt +`func (o *ManagedCluster) UnsetCreatedAt()` + +UnsetCreatedAt ensures that no value is present for CreatedAt, not even an explicit nil +### GetUpdatedAt + +`func (o *ManagedCluster) GetUpdatedAt() SailPointTime` + +GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise. + +### GetUpdatedAtOk + +`func (o *ManagedCluster) GetUpdatedAtOk() (*SailPointTime, bool)` + +GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedAt + +`func (o *ManagedCluster) SetUpdatedAt(v SailPointTime)` + +SetUpdatedAt sets UpdatedAt field to given value. + +### HasUpdatedAt + +`func (o *ManagedCluster) HasUpdatedAt() bool` + +HasUpdatedAt returns a boolean if a field has been set. + +### SetUpdatedAtNil + +`func (o *ManagedCluster) SetUpdatedAtNil(b bool)` + + SetUpdatedAtNil sets the value for UpdatedAt to be an explicit nil + +### UnsetUpdatedAt +`func (o *ManagedCluster) UnsetUpdatedAt()` + +UnsetUpdatedAt ensures that no value is present for UpdatedAt, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterAttributes.md b/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterAttributes.md new file mode 100644 index 000000000..b3873a0b2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterAttributes.md @@ -0,0 +1,100 @@ +--- +id: managed-cluster-attributes +title: ManagedClusterAttributes +pagination_label: ManagedClusterAttributes +sidebar_label: ManagedClusterAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterAttributes', 'ManagedClusterAttributes'] +slug: /tools/sdk/go/v3/models/managed-cluster-attributes +tags: ['SDK', 'Software Development Kit', 'ManagedClusterAttributes', 'ManagedClusterAttributes'] +--- + +# ManagedClusterAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Queue** | Pointer to [**ManagedClusterQueue**](managed-cluster-queue) | | [optional] +**Keystore** | Pointer to **NullableString** | ManagedCluster keystore for spConnectCluster type | [optional] + +## Methods + +### NewManagedClusterAttributes + +`func NewManagedClusterAttributes() *ManagedClusterAttributes` + +NewManagedClusterAttributes instantiates a new ManagedClusterAttributes 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 + +### NewManagedClusterAttributesWithDefaults + +`func NewManagedClusterAttributesWithDefaults() *ManagedClusterAttributes` + +NewManagedClusterAttributesWithDefaults instantiates a new ManagedClusterAttributes 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 + +### GetQueue + +`func (o *ManagedClusterAttributes) GetQueue() ManagedClusterQueue` + +GetQueue returns the Queue field if non-nil, zero value otherwise. + +### GetQueueOk + +`func (o *ManagedClusterAttributes) GetQueueOk() (*ManagedClusterQueue, bool)` + +GetQueueOk returns a tuple with the Queue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueue + +`func (o *ManagedClusterAttributes) SetQueue(v ManagedClusterQueue)` + +SetQueue sets Queue field to given value. + +### HasQueue + +`func (o *ManagedClusterAttributes) HasQueue() bool` + +HasQueue returns a boolean if a field has been set. + +### GetKeystore + +`func (o *ManagedClusterAttributes) GetKeystore() string` + +GetKeystore returns the Keystore field if non-nil, zero value otherwise. + +### GetKeystoreOk + +`func (o *ManagedClusterAttributes) GetKeystoreOk() (*string, bool)` + +GetKeystoreOk returns a tuple with the Keystore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKeystore + +`func (o *ManagedClusterAttributes) SetKeystore(v string)` + +SetKeystore sets Keystore field to given value. + +### HasKeystore + +`func (o *ManagedClusterAttributes) HasKeystore() bool` + +HasKeystore returns a boolean if a field has been set. + +### SetKeystoreNil + +`func (o *ManagedClusterAttributes) SetKeystoreNil(b bool)` + + SetKeystoreNil sets the value for Keystore to be an explicit nil + +### UnsetKeystore +`func (o *ManagedClusterAttributes) UnsetKeystore()` + +UnsetKeystore ensures that no value is present for Keystore, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterKeyPair.md b/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterKeyPair.md new file mode 100644 index 000000000..7767dc919 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterKeyPair.md @@ -0,0 +1,146 @@ +--- +id: managed-cluster-key-pair +title: ManagedClusterKeyPair +pagination_label: ManagedClusterKeyPair +sidebar_label: ManagedClusterKeyPair +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterKeyPair', 'ManagedClusterKeyPair'] +slug: /tools/sdk/go/v3/models/managed-cluster-key-pair +tags: ['SDK', 'Software Development Kit', 'ManagedClusterKeyPair', 'ManagedClusterKeyPair'] +--- + +# ManagedClusterKeyPair + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PublicKey** | Pointer to **NullableString** | ManagedCluster publicKey | [optional] +**PublicKeyThumbprint** | Pointer to **NullableString** | ManagedCluster publicKeyThumbprint | [optional] +**PublicKeyCertificate** | Pointer to **NullableString** | ManagedCluster publicKeyCertificate | [optional] + +## Methods + +### NewManagedClusterKeyPair + +`func NewManagedClusterKeyPair() *ManagedClusterKeyPair` + +NewManagedClusterKeyPair instantiates a new ManagedClusterKeyPair 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 + +### NewManagedClusterKeyPairWithDefaults + +`func NewManagedClusterKeyPairWithDefaults() *ManagedClusterKeyPair` + +NewManagedClusterKeyPairWithDefaults instantiates a new ManagedClusterKeyPair 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 + +### GetPublicKey + +`func (o *ManagedClusterKeyPair) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *ManagedClusterKeyPair) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *ManagedClusterKeyPair) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *ManagedClusterKeyPair) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### SetPublicKeyNil + +`func (o *ManagedClusterKeyPair) SetPublicKeyNil(b bool)` + + SetPublicKeyNil sets the value for PublicKey to be an explicit nil + +### UnsetPublicKey +`func (o *ManagedClusterKeyPair) UnsetPublicKey()` + +UnsetPublicKey ensures that no value is present for PublicKey, not even an explicit nil +### GetPublicKeyThumbprint + +`func (o *ManagedClusterKeyPair) GetPublicKeyThumbprint() string` + +GetPublicKeyThumbprint returns the PublicKeyThumbprint field if non-nil, zero value otherwise. + +### GetPublicKeyThumbprintOk + +`func (o *ManagedClusterKeyPair) GetPublicKeyThumbprintOk() (*string, bool)` + +GetPublicKeyThumbprintOk returns a tuple with the PublicKeyThumbprint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyThumbprint + +`func (o *ManagedClusterKeyPair) SetPublicKeyThumbprint(v string)` + +SetPublicKeyThumbprint sets PublicKeyThumbprint field to given value. + +### HasPublicKeyThumbprint + +`func (o *ManagedClusterKeyPair) HasPublicKeyThumbprint() bool` + +HasPublicKeyThumbprint returns a boolean if a field has been set. + +### SetPublicKeyThumbprintNil + +`func (o *ManagedClusterKeyPair) SetPublicKeyThumbprintNil(b bool)` + + SetPublicKeyThumbprintNil sets the value for PublicKeyThumbprint to be an explicit nil + +### UnsetPublicKeyThumbprint +`func (o *ManagedClusterKeyPair) UnsetPublicKeyThumbprint()` + +UnsetPublicKeyThumbprint ensures that no value is present for PublicKeyThumbprint, not even an explicit nil +### GetPublicKeyCertificate + +`func (o *ManagedClusterKeyPair) GetPublicKeyCertificate() string` + +GetPublicKeyCertificate returns the PublicKeyCertificate field if non-nil, zero value otherwise. + +### GetPublicKeyCertificateOk + +`func (o *ManagedClusterKeyPair) GetPublicKeyCertificateOk() (*string, bool)` + +GetPublicKeyCertificateOk returns a tuple with the PublicKeyCertificate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyCertificate + +`func (o *ManagedClusterKeyPair) SetPublicKeyCertificate(v string)` + +SetPublicKeyCertificate sets PublicKeyCertificate field to given value. + +### HasPublicKeyCertificate + +`func (o *ManagedClusterKeyPair) HasPublicKeyCertificate() bool` + +HasPublicKeyCertificate returns a boolean if a field has been set. + +### SetPublicKeyCertificateNil + +`func (o *ManagedClusterKeyPair) SetPublicKeyCertificateNil(b bool)` + + SetPublicKeyCertificateNil sets the value for PublicKeyCertificate to be an explicit nil + +### UnsetPublicKeyCertificate +`func (o *ManagedClusterKeyPair) UnsetPublicKeyCertificate()` + +UnsetPublicKeyCertificate ensures that no value is present for PublicKeyCertificate, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterQueue.md b/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterQueue.md new file mode 100644 index 000000000..24dca58ba --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterQueue.md @@ -0,0 +1,90 @@ +--- +id: managed-cluster-queue +title: ManagedClusterQueue +pagination_label: ManagedClusterQueue +sidebar_label: ManagedClusterQueue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterQueue', 'ManagedClusterQueue'] +slug: /tools/sdk/go/v3/models/managed-cluster-queue +tags: ['SDK', 'Software Development Kit', 'ManagedClusterQueue', 'ManagedClusterQueue'] +--- + +# ManagedClusterQueue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | ManagedCluster queue name | [optional] +**Region** | Pointer to **string** | ManagedCluster queue aws region | [optional] + +## Methods + +### NewManagedClusterQueue + +`func NewManagedClusterQueue() *ManagedClusterQueue` + +NewManagedClusterQueue instantiates a new ManagedClusterQueue 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 + +### NewManagedClusterQueueWithDefaults + +`func NewManagedClusterQueueWithDefaults() *ManagedClusterQueue` + +NewManagedClusterQueueWithDefaults instantiates a new ManagedClusterQueue 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 + +### GetName + +`func (o *ManagedClusterQueue) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedClusterQueue) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedClusterQueue) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManagedClusterQueue) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetRegion + +`func (o *ManagedClusterQueue) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *ManagedClusterQueue) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *ManagedClusterQueue) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *ManagedClusterQueue) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterRedis.md b/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterRedis.md new file mode 100644 index 000000000..5cfeba865 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterRedis.md @@ -0,0 +1,90 @@ +--- +id: managed-cluster-redis +title: ManagedClusterRedis +pagination_label: ManagedClusterRedis +sidebar_label: ManagedClusterRedis +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterRedis', 'ManagedClusterRedis'] +slug: /tools/sdk/go/v3/models/managed-cluster-redis +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRedis', 'ManagedClusterRedis'] +--- + +# ManagedClusterRedis + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RedisHost** | Pointer to **string** | ManagedCluster redisHost | [optional] +**RedisPort** | Pointer to **int32** | ManagedCluster redisPort | [optional] + +## Methods + +### NewManagedClusterRedis + +`func NewManagedClusterRedis() *ManagedClusterRedis` + +NewManagedClusterRedis instantiates a new ManagedClusterRedis 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 + +### NewManagedClusterRedisWithDefaults + +`func NewManagedClusterRedisWithDefaults() *ManagedClusterRedis` + +NewManagedClusterRedisWithDefaults instantiates a new ManagedClusterRedis 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 + +### GetRedisHost + +`func (o *ManagedClusterRedis) GetRedisHost() string` + +GetRedisHost returns the RedisHost field if non-nil, zero value otherwise. + +### GetRedisHostOk + +`func (o *ManagedClusterRedis) GetRedisHostOk() (*string, bool)` + +GetRedisHostOk returns a tuple with the RedisHost field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedisHost + +`func (o *ManagedClusterRedis) SetRedisHost(v string)` + +SetRedisHost sets RedisHost field to given value. + +### HasRedisHost + +`func (o *ManagedClusterRedis) HasRedisHost() bool` + +HasRedisHost returns a boolean if a field has been set. + +### GetRedisPort + +`func (o *ManagedClusterRedis) GetRedisPort() int32` + +GetRedisPort returns the RedisPort field if non-nil, zero value otherwise. + +### GetRedisPortOk + +`func (o *ManagedClusterRedis) GetRedisPortOk() (*int32, bool)` + +GetRedisPortOk returns a tuple with the RedisPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRedisPort + +`func (o *ManagedClusterRedis) SetRedisPort(v int32)` + +SetRedisPort sets RedisPort field to given value. + +### HasRedisPort + +`func (o *ManagedClusterRedis) HasRedisPort() bool` + +HasRedisPort returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterRequest.md b/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterRequest.md new file mode 100644 index 000000000..6da20ace2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterRequest.md @@ -0,0 +1,147 @@ +--- +id: managed-cluster-request +title: ManagedClusterRequest +pagination_label: ManagedClusterRequest +sidebar_label: ManagedClusterRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterRequest', 'ManagedClusterRequest'] +slug: /tools/sdk/go/v3/models/managed-cluster-request +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRequest', 'ManagedClusterRequest'] +--- + +# ManagedClusterRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | ManagedCluster name | +**Type** | Pointer to [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**Configuration** | Pointer to **map[string]string** | ManagedProcess configuration map | [optional] +**Description** | Pointer to **NullableString** | ManagedCluster description | [optional] + +## Methods + +### NewManagedClusterRequest + +`func NewManagedClusterRequest(name string, ) *ManagedClusterRequest` + +NewManagedClusterRequest instantiates a new ManagedClusterRequest 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 + +### NewManagedClusterRequestWithDefaults + +`func NewManagedClusterRequestWithDefaults() *ManagedClusterRequest` + +NewManagedClusterRequestWithDefaults instantiates a new ManagedClusterRequest 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 + +### GetName + +`func (o *ManagedClusterRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManagedClusterRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManagedClusterRequest) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *ManagedClusterRequest) GetType() ManagedClusterTypes` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManagedClusterRequest) GetTypeOk() (*ManagedClusterTypes, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManagedClusterRequest) SetType(v ManagedClusterTypes)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManagedClusterRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConfiguration + +`func (o *ManagedClusterRequest) GetConfiguration() map[string]string` + +GetConfiguration returns the Configuration field if non-nil, zero value otherwise. + +### GetConfigurationOk + +`func (o *ManagedClusterRequest) GetConfigurationOk() (*map[string]string, bool)` + +GetConfigurationOk returns a tuple with the Configuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfiguration + +`func (o *ManagedClusterRequest) SetConfiguration(v map[string]string)` + +SetConfiguration sets Configuration field to given value. + +### HasConfiguration + +`func (o *ManagedClusterRequest) HasConfiguration() bool` + +HasConfiguration returns a boolean if a field has been set. + +### GetDescription + +`func (o *ManagedClusterRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManagedClusterRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManagedClusterRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ManagedClusterRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ManagedClusterRequest) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ManagedClusterRequest) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterTypes.md b/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterTypes.md new file mode 100644 index 000000000..95758d285 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManagedClusterTypes.md @@ -0,0 +1,21 @@ +--- +id: managed-cluster-types +title: ManagedClusterTypes +pagination_label: ManagedClusterTypes +sidebar_label: ManagedClusterTypes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagedClusterTypes', 'ManagedClusterTypes'] +slug: /tools/sdk/go/v3/models/managed-cluster-types +tags: ['SDK', 'Software Development Kit', 'ManagedClusterTypes', 'ManagedClusterTypes'] +--- + +# ManagedClusterTypes + +## Enum + + +* `IDN` (value: `"idn"`) + +* `IAI` (value: `"iai"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManagerCorrelationMapping.md b/docs/tools/sdk/go/Reference/V3/Models/ManagerCorrelationMapping.md new file mode 100644 index 000000000..60f7804b8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManagerCorrelationMapping.md @@ -0,0 +1,90 @@ +--- +id: manager-correlation-mapping +title: ManagerCorrelationMapping +pagination_label: ManagerCorrelationMapping +sidebar_label: ManagerCorrelationMapping +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManagerCorrelationMapping', 'ManagerCorrelationMapping'] +slug: /tools/sdk/go/v3/models/manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'ManagerCorrelationMapping', 'ManagerCorrelationMapping'] +--- + +# ManagerCorrelationMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountAttributeName** | Pointer to **string** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**IdentityAttributeName** | Pointer to **string** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] + +## Methods + +### NewManagerCorrelationMapping + +`func NewManagerCorrelationMapping() *ManagerCorrelationMapping` + +NewManagerCorrelationMapping instantiates a new ManagerCorrelationMapping 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 + +### NewManagerCorrelationMappingWithDefaults + +`func NewManagerCorrelationMappingWithDefaults() *ManagerCorrelationMapping` + +NewManagerCorrelationMappingWithDefaults instantiates a new ManagerCorrelationMapping 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 + +### GetAccountAttributeName + +`func (o *ManagerCorrelationMapping) GetAccountAttributeName() string` + +GetAccountAttributeName returns the AccountAttributeName field if non-nil, zero value otherwise. + +### GetAccountAttributeNameOk + +`func (o *ManagerCorrelationMapping) GetAccountAttributeNameOk() (*string, bool)` + +GetAccountAttributeNameOk returns a tuple with the AccountAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountAttributeName + +`func (o *ManagerCorrelationMapping) SetAccountAttributeName(v string)` + +SetAccountAttributeName sets AccountAttributeName field to given value. + +### HasAccountAttributeName + +`func (o *ManagerCorrelationMapping) HasAccountAttributeName() bool` + +HasAccountAttributeName returns a boolean if a field has been set. + +### GetIdentityAttributeName + +`func (o *ManagerCorrelationMapping) GetIdentityAttributeName() string` + +GetIdentityAttributeName returns the IdentityAttributeName field if non-nil, zero value otherwise. + +### GetIdentityAttributeNameOk + +`func (o *ManagerCorrelationMapping) GetIdentityAttributeNameOk() (*string, bool)` + +GetIdentityAttributeNameOk returns a tuple with the IdentityAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeName + +`func (o *ManagerCorrelationMapping) SetIdentityAttributeName(v string)` + +SetIdentityAttributeName sets IdentityAttributeName field to given value. + +### HasIdentityAttributeName + +`func (o *ManagerCorrelationMapping) HasIdentityAttributeName() bool` + +HasIdentityAttributeName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManualDiscoverApplications.md b/docs/tools/sdk/go/Reference/V3/Models/ManualDiscoverApplications.md new file mode 100644 index 000000000..f21514490 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManualDiscoverApplications.md @@ -0,0 +1,59 @@ +--- +id: manual-discover-applications +title: ManualDiscoverApplications +pagination_label: ManualDiscoverApplications +sidebar_label: ManualDiscoverApplications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualDiscoverApplications', 'ManualDiscoverApplications'] +slug: /tools/sdk/go/v3/models/manual-discover-applications +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplications', 'ManualDiscoverApplications'] +--- + +# ManualDiscoverApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | ***os.File** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | + +## Methods + +### NewManualDiscoverApplications + +`func NewManualDiscoverApplications(file *os.File, ) *ManualDiscoverApplications` + +NewManualDiscoverApplications instantiates a new ManualDiscoverApplications 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 + +### NewManualDiscoverApplicationsWithDefaults + +`func NewManualDiscoverApplicationsWithDefaults() *ManualDiscoverApplications` + +NewManualDiscoverApplicationsWithDefaults instantiates a new ManualDiscoverApplications 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 + +### GetFile + +`func (o *ManualDiscoverApplications) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *ManualDiscoverApplications) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *ManualDiscoverApplications) SetFile(v *os.File)` + +SetFile sets File field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManualDiscoverApplicationsTemplate.md b/docs/tools/sdk/go/Reference/V3/Models/ManualDiscoverApplicationsTemplate.md new file mode 100644 index 000000000..d2f3d2e4c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManualDiscoverApplicationsTemplate.md @@ -0,0 +1,90 @@ +--- +id: manual-discover-applications-template +title: ManualDiscoverApplicationsTemplate +pagination_label: ManualDiscoverApplicationsTemplate +sidebar_label: ManualDiscoverApplicationsTemplate +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualDiscoverApplicationsTemplate', 'ManualDiscoverApplicationsTemplate'] +slug: /tools/sdk/go/v3/models/manual-discover-applications-template +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplicationsTemplate', 'ManualDiscoverApplicationsTemplate'] +--- + +# ManualDiscoverApplicationsTemplate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationName** | Pointer to **string** | Name of the application. | [optional] +**Description** | Pointer to **string** | Description of the application. | [optional] + +## Methods + +### NewManualDiscoverApplicationsTemplate + +`func NewManualDiscoverApplicationsTemplate() *ManualDiscoverApplicationsTemplate` + +NewManualDiscoverApplicationsTemplate instantiates a new ManualDiscoverApplicationsTemplate 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 + +### NewManualDiscoverApplicationsTemplateWithDefaults + +`func NewManualDiscoverApplicationsTemplateWithDefaults() *ManualDiscoverApplicationsTemplate` + +NewManualDiscoverApplicationsTemplateWithDefaults instantiates a new ManualDiscoverApplicationsTemplate 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 + +### GetApplicationName + +`func (o *ManualDiscoverApplicationsTemplate) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *ManualDiscoverApplicationsTemplate) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *ManualDiscoverApplicationsTemplate) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *ManualDiscoverApplicationsTemplate) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ManualDiscoverApplicationsTemplate) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ManualDiscoverApplicationsTemplate) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ManualDiscoverApplicationsTemplate) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ManualDiscoverApplicationsTemplate) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManualWorkItemDetails.md b/docs/tools/sdk/go/Reference/V3/Models/ManualWorkItemDetails.md new file mode 100644 index 000000000..1dfec9a2a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManualWorkItemDetails.md @@ -0,0 +1,224 @@ +--- +id: manual-work-item-details +title: ManualWorkItemDetails +pagination_label: ManualWorkItemDetails +sidebar_label: ManualWorkItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualWorkItemDetails', 'ManualWorkItemDetails'] +slug: /tools/sdk/go/v3/models/manual-work-item-details +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetails', 'ManualWorkItemDetails'] +--- + +# ManualWorkItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Forwarded** | Pointer to **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to false] +**OriginalOwner** | Pointer to [**NullableManualWorkItemDetailsOriginalOwner**](manual-work-item-details-original-owner) | | [optional] +**CurrentOwner** | Pointer to [**NullableManualWorkItemDetailsCurrentOwner**](manual-work-item-details-current-owner) | | [optional] +**Modified** | Pointer to **SailPointTime** | Time at which item was modified. | [optional] +**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] + +## Methods + +### NewManualWorkItemDetails + +`func NewManualWorkItemDetails() *ManualWorkItemDetails` + +NewManualWorkItemDetails instantiates a new ManualWorkItemDetails 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 + +### NewManualWorkItemDetailsWithDefaults + +`func NewManualWorkItemDetailsWithDefaults() *ManualWorkItemDetails` + +NewManualWorkItemDetailsWithDefaults instantiates a new ManualWorkItemDetails 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 + +### GetForwarded + +`func (o *ManualWorkItemDetails) GetForwarded() bool` + +GetForwarded returns the Forwarded field if non-nil, zero value otherwise. + +### GetForwardedOk + +`func (o *ManualWorkItemDetails) GetForwardedOk() (*bool, bool)` + +GetForwardedOk returns a tuple with the Forwarded field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwarded + +`func (o *ManualWorkItemDetails) SetForwarded(v bool)` + +SetForwarded sets Forwarded field to given value. + +### HasForwarded + +`func (o *ManualWorkItemDetails) HasForwarded() bool` + +HasForwarded returns a boolean if a field has been set. + +### GetOriginalOwner + +`func (o *ManualWorkItemDetails) GetOriginalOwner() ManualWorkItemDetailsOriginalOwner` + +GetOriginalOwner returns the OriginalOwner field if non-nil, zero value otherwise. + +### GetOriginalOwnerOk + +`func (o *ManualWorkItemDetails) GetOriginalOwnerOk() (*ManualWorkItemDetailsOriginalOwner, bool)` + +GetOriginalOwnerOk returns a tuple with the OriginalOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOriginalOwner + +`func (o *ManualWorkItemDetails) SetOriginalOwner(v ManualWorkItemDetailsOriginalOwner)` + +SetOriginalOwner sets OriginalOwner field to given value. + +### HasOriginalOwner + +`func (o *ManualWorkItemDetails) HasOriginalOwner() bool` + +HasOriginalOwner returns a boolean if a field has been set. + +### SetOriginalOwnerNil + +`func (o *ManualWorkItemDetails) SetOriginalOwnerNil(b bool)` + + SetOriginalOwnerNil sets the value for OriginalOwner to be an explicit nil + +### UnsetOriginalOwner +`func (o *ManualWorkItemDetails) UnsetOriginalOwner()` + +UnsetOriginalOwner ensures that no value is present for OriginalOwner, not even an explicit nil +### GetCurrentOwner + +`func (o *ManualWorkItemDetails) GetCurrentOwner() ManualWorkItemDetailsCurrentOwner` + +GetCurrentOwner returns the CurrentOwner field if non-nil, zero value otherwise. + +### GetCurrentOwnerOk + +`func (o *ManualWorkItemDetails) GetCurrentOwnerOk() (*ManualWorkItemDetailsCurrentOwner, bool)` + +GetCurrentOwnerOk returns a tuple with the CurrentOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentOwner + +`func (o *ManualWorkItemDetails) SetCurrentOwner(v ManualWorkItemDetailsCurrentOwner)` + +SetCurrentOwner sets CurrentOwner field to given value. + +### HasCurrentOwner + +`func (o *ManualWorkItemDetails) HasCurrentOwner() bool` + +HasCurrentOwner returns a boolean if a field has been set. + +### SetCurrentOwnerNil + +`func (o *ManualWorkItemDetails) SetCurrentOwnerNil(b bool)` + + SetCurrentOwnerNil sets the value for CurrentOwner to be an explicit nil + +### UnsetCurrentOwner +`func (o *ManualWorkItemDetails) UnsetCurrentOwner()` + +UnsetCurrentOwner ensures that no value is present for CurrentOwner, not even an explicit nil +### GetModified + +`func (o *ManualWorkItemDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ManualWorkItemDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ManualWorkItemDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ManualWorkItemDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetStatus + +`func (o *ManualWorkItemDetails) GetStatus() ManualWorkItemState` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ManualWorkItemDetails) GetStatusOk() (*ManualWorkItemState, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ManualWorkItemDetails) SetStatus(v ManualWorkItemState)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ManualWorkItemDetails) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetForwardHistory + +`func (o *ManualWorkItemDetails) GetForwardHistory() []ApprovalForwardHistory` + +GetForwardHistory returns the ForwardHistory field if non-nil, zero value otherwise. + +### GetForwardHistoryOk + +`func (o *ManualWorkItemDetails) GetForwardHistoryOk() (*[]ApprovalForwardHistory, bool)` + +GetForwardHistoryOk returns a tuple with the ForwardHistory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwardHistory + +`func (o *ManualWorkItemDetails) SetForwardHistory(v []ApprovalForwardHistory)` + +SetForwardHistory sets ForwardHistory field to given value. + +### HasForwardHistory + +`func (o *ManualWorkItemDetails) HasForwardHistory() bool` + +HasForwardHistory returns a boolean if a field has been set. + +### SetForwardHistoryNil + +`func (o *ManualWorkItemDetails) SetForwardHistoryNil(b bool)` + + SetForwardHistoryNil sets the value for ForwardHistory to be an explicit nil + +### UnsetForwardHistory +`func (o *ManualWorkItemDetails) UnsetForwardHistory()` + +UnsetForwardHistory ensures that no value is present for ForwardHistory, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManualWorkItemDetailsCurrentOwner.md b/docs/tools/sdk/go/Reference/V3/Models/ManualWorkItemDetailsCurrentOwner.md new file mode 100644 index 000000000..e05dcc92e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManualWorkItemDetailsCurrentOwner.md @@ -0,0 +1,116 @@ +--- +id: manual-work-item-details-current-owner +title: ManualWorkItemDetailsCurrentOwner +pagination_label: ManualWorkItemDetailsCurrentOwner +sidebar_label: ManualWorkItemDetailsCurrentOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualWorkItemDetailsCurrentOwner', 'ManualWorkItemDetailsCurrentOwner'] +slug: /tools/sdk/go/v3/models/manual-work-item-details-current-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsCurrentOwner', 'ManualWorkItemDetailsCurrentOwner'] +--- + +# ManualWorkItemDetailsCurrentOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of current work item owner's identity. | [optional] +**Id** | Pointer to **string** | ID of current work item owner's identity. | [optional] +**Name** | Pointer to **string** | Display name of current work item owner. | [optional] + +## Methods + +### NewManualWorkItemDetailsCurrentOwner + +`func NewManualWorkItemDetailsCurrentOwner() *ManualWorkItemDetailsCurrentOwner` + +NewManualWorkItemDetailsCurrentOwner instantiates a new ManualWorkItemDetailsCurrentOwner 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 + +### NewManualWorkItemDetailsCurrentOwnerWithDefaults + +`func NewManualWorkItemDetailsCurrentOwnerWithDefaults() *ManualWorkItemDetailsCurrentOwner` + +NewManualWorkItemDetailsCurrentOwnerWithDefaults instantiates a new ManualWorkItemDetailsCurrentOwner 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 + +### GetType + +`func (o *ManualWorkItemDetailsCurrentOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManualWorkItemDetailsCurrentOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManualWorkItemDetailsCurrentOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManualWorkItemDetailsCurrentOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ManualWorkItemDetailsCurrentOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManualWorkItemDetailsCurrentOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManualWorkItemDetailsCurrentOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ManualWorkItemDetailsCurrentOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ManualWorkItemDetailsCurrentOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManualWorkItemDetailsCurrentOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManualWorkItemDetailsCurrentOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManualWorkItemDetailsCurrentOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManualWorkItemDetailsOriginalOwner.md b/docs/tools/sdk/go/Reference/V3/Models/ManualWorkItemDetailsOriginalOwner.md new file mode 100644 index 000000000..c1cfb9960 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManualWorkItemDetailsOriginalOwner.md @@ -0,0 +1,116 @@ +--- +id: manual-work-item-details-original-owner +title: ManualWorkItemDetailsOriginalOwner +pagination_label: ManualWorkItemDetailsOriginalOwner +sidebar_label: ManualWorkItemDetailsOriginalOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualWorkItemDetailsOriginalOwner', 'ManualWorkItemDetailsOriginalOwner'] +slug: /tools/sdk/go/v3/models/manual-work-item-details-original-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsOriginalOwner', 'ManualWorkItemDetailsOriginalOwner'] +--- + +# ManualWorkItemDetailsOriginalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of original work item owner's identity. | [optional] +**Id** | Pointer to **string** | ID of original work item owner's identity. | [optional] +**Name** | Pointer to **string** | Display name of original work item owner. | [optional] + +## Methods + +### NewManualWorkItemDetailsOriginalOwner + +`func NewManualWorkItemDetailsOriginalOwner() *ManualWorkItemDetailsOriginalOwner` + +NewManualWorkItemDetailsOriginalOwner instantiates a new ManualWorkItemDetailsOriginalOwner 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 + +### NewManualWorkItemDetailsOriginalOwnerWithDefaults + +`func NewManualWorkItemDetailsOriginalOwnerWithDefaults() *ManualWorkItemDetailsOriginalOwner` + +NewManualWorkItemDetailsOriginalOwnerWithDefaults instantiates a new ManualWorkItemDetailsOriginalOwner 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 + +### GetType + +`func (o *ManualWorkItemDetailsOriginalOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ManualWorkItemDetailsOriginalOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ManualWorkItemDetailsOriginalOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ManualWorkItemDetailsOriginalOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ManualWorkItemDetailsOriginalOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ManualWorkItemDetailsOriginalOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ManualWorkItemDetailsOriginalOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ManualWorkItemDetailsOriginalOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ManualWorkItemDetailsOriginalOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ManualWorkItemDetailsOriginalOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ManualWorkItemDetailsOriginalOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ManualWorkItemDetailsOriginalOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ManualWorkItemState.md b/docs/tools/sdk/go/Reference/V3/Models/ManualWorkItemState.md new file mode 100644 index 000000000..ea4eca7a7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ManualWorkItemState.md @@ -0,0 +1,29 @@ +--- +id: manual-work-item-state +title: ManualWorkItemState +pagination_label: ManualWorkItemState +sidebar_label: ManualWorkItemState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ManualWorkItemState', 'ManualWorkItemState'] +slug: /tools/sdk/go/v3/models/manual-work-item-state +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemState', 'ManualWorkItemState'] +--- + +# ManualWorkItemState + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `EXPIRED` (value: `"EXPIRED"`) + +* `CANCELLED` (value: `"CANCELLED"`) + +* `ARCHIVED` (value: `"ARCHIVED"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/MetricAggregation.md b/docs/tools/sdk/go/Reference/V3/Models/MetricAggregation.md new file mode 100644 index 000000000..e58838df7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/MetricAggregation.md @@ -0,0 +1,106 @@ +--- +id: metric-aggregation +title: MetricAggregation +pagination_label: MetricAggregation +sidebar_label: MetricAggregation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MetricAggregation', 'MetricAggregation'] +slug: /tools/sdk/go/v3/models/metric-aggregation +tags: ['SDK', 'Software Development Kit', 'MetricAggregation', 'MetricAggregation'] +--- + +# MetricAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the metric aggregate to be included in the result. If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. | +**Type** | Pointer to [**MetricType**](metric-type) | | [optional] [default to METRICTYPE_UNIQUE_COUNT] +**Field** | **string** | The field the calculation is performed on. Prefix the field name with '@' to reference a nested object. | + +## Methods + +### NewMetricAggregation + +`func NewMetricAggregation(name string, field string, ) *MetricAggregation` + +NewMetricAggregation instantiates a new MetricAggregation 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 + +### NewMetricAggregationWithDefaults + +`func NewMetricAggregationWithDefaults() *MetricAggregation` + +NewMetricAggregationWithDefaults instantiates a new MetricAggregation 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 + +### GetName + +`func (o *MetricAggregation) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MetricAggregation) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MetricAggregation) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *MetricAggregation) GetType() MetricType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *MetricAggregation) GetTypeOk() (*MetricType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *MetricAggregation) SetType(v MetricType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *MetricAggregation) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetField + +`func (o *MetricAggregation) GetField() string` + +GetField returns the Field field if non-nil, zero value otherwise. + +### GetFieldOk + +`func (o *MetricAggregation) GetFieldOk() (*string, bool)` + +GetFieldOk returns a tuple with the Field field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetField + +`func (o *MetricAggregation) SetField(v string)` + +SetField sets Field field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/MetricType.md b/docs/tools/sdk/go/Reference/V3/Models/MetricType.md new file mode 100644 index 000000000..e6876617c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/MetricType.md @@ -0,0 +1,31 @@ +--- +id: metric-type +title: MetricType +pagination_label: MetricType +sidebar_label: MetricType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MetricType', 'MetricType'] +slug: /tools/sdk/go/v3/models/metric-type +tags: ['SDK', 'Software Development Kit', 'MetricType', 'MetricType'] +--- + +# MetricType + +## Enum + + +* `COUNT` (value: `"COUNT"`) + +* `UNIQUE_COUNT` (value: `"UNIQUE_COUNT"`) + +* `AVG` (value: `"AVG"`) + +* `SUM` (value: `"SUM"`) + +* `MEDIAN` (value: `"MEDIAN"`) + +* `MIN` (value: `"MIN"`) + +* `MAX` (value: `"MAX"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/MfaConfigTestResponse.md b/docs/tools/sdk/go/Reference/V3/Models/MfaConfigTestResponse.md new file mode 100644 index 000000000..9647af4ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/MfaConfigTestResponse.md @@ -0,0 +1,90 @@ +--- +id: mfa-config-test-response +title: MfaConfigTestResponse +pagination_label: MfaConfigTestResponse +sidebar_label: MfaConfigTestResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MfaConfigTestResponse', 'MfaConfigTestResponse'] +slug: /tools/sdk/go/v3/models/mfa-config-test-response +tags: ['SDK', 'Software Development Kit', 'MfaConfigTestResponse', 'MfaConfigTestResponse'] +--- + +# MfaConfigTestResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **string** | The configuration test result. | [optional] [readonly] +**Error** | Pointer to **string** | The error message to indicate the failure of configuration test. | [optional] [readonly] + +## Methods + +### NewMfaConfigTestResponse + +`func NewMfaConfigTestResponse() *MfaConfigTestResponse` + +NewMfaConfigTestResponse instantiates a new MfaConfigTestResponse 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 + +### NewMfaConfigTestResponseWithDefaults + +`func NewMfaConfigTestResponseWithDefaults() *MfaConfigTestResponse` + +NewMfaConfigTestResponseWithDefaults instantiates a new MfaConfigTestResponse 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 + +### GetState + +`func (o *MfaConfigTestResponse) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *MfaConfigTestResponse) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *MfaConfigTestResponse) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *MfaConfigTestResponse) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetError + +`func (o *MfaConfigTestResponse) GetError() string` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *MfaConfigTestResponse) GetErrorOk() (*string, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *MfaConfigTestResponse) SetError(v string)` + +SetError sets Error field to given value. + +### HasError + +`func (o *MfaConfigTestResponse) HasError() bool` + +HasError returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/MfaDuoConfig.md b/docs/tools/sdk/go/Reference/V3/Models/MfaDuoConfig.md new file mode 100644 index 000000000..6b4dbc59d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/MfaDuoConfig.md @@ -0,0 +1,244 @@ +--- +id: mfa-duo-config +title: MfaDuoConfig +pagination_label: MfaDuoConfig +sidebar_label: MfaDuoConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MfaDuoConfig', 'MfaDuoConfig'] +slug: /tools/sdk/go/v3/models/mfa-duo-config +tags: ['SDK', 'Software Development Kit', 'MfaDuoConfig', 'MfaDuoConfig'] +--- + +# MfaDuoConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MfaMethod** | Pointer to **NullableString** | Mfa method name | [optional] +**Enabled** | Pointer to **bool** | If MFA method is enabled. | [optional] [default to false] +**Host** | Pointer to **NullableString** | The server host name or IP address of the MFA provider. | [optional] +**AccessKey** | Pointer to **NullableString** | The secret key for authenticating requests to the MFA provider. | [optional] +**IdentityAttribute** | Pointer to **NullableString** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] +**ConfigProperties** | Pointer to **map[string]interface{}** | A map with additional config properties for the given MFA method - duo-web. | [optional] + +## Methods + +### NewMfaDuoConfig + +`func NewMfaDuoConfig() *MfaDuoConfig` + +NewMfaDuoConfig instantiates a new MfaDuoConfig 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 + +### NewMfaDuoConfigWithDefaults + +`func NewMfaDuoConfigWithDefaults() *MfaDuoConfig` + +NewMfaDuoConfigWithDefaults instantiates a new MfaDuoConfig 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 + +### GetMfaMethod + +`func (o *MfaDuoConfig) GetMfaMethod() string` + +GetMfaMethod returns the MfaMethod field if non-nil, zero value otherwise. + +### GetMfaMethodOk + +`func (o *MfaDuoConfig) GetMfaMethodOk() (*string, bool)` + +GetMfaMethodOk returns a tuple with the MfaMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMfaMethod + +`func (o *MfaDuoConfig) SetMfaMethod(v string)` + +SetMfaMethod sets MfaMethod field to given value. + +### HasMfaMethod + +`func (o *MfaDuoConfig) HasMfaMethod() bool` + +HasMfaMethod returns a boolean if a field has been set. + +### SetMfaMethodNil + +`func (o *MfaDuoConfig) SetMfaMethodNil(b bool)` + + SetMfaMethodNil sets the value for MfaMethod to be an explicit nil + +### UnsetMfaMethod +`func (o *MfaDuoConfig) UnsetMfaMethod()` + +UnsetMfaMethod ensures that no value is present for MfaMethod, not even an explicit nil +### GetEnabled + +`func (o *MfaDuoConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *MfaDuoConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *MfaDuoConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *MfaDuoConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetHost + +`func (o *MfaDuoConfig) GetHost() string` + +GetHost returns the Host field if non-nil, zero value otherwise. + +### GetHostOk + +`func (o *MfaDuoConfig) GetHostOk() (*string, bool)` + +GetHostOk returns a tuple with the Host field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHost + +`func (o *MfaDuoConfig) SetHost(v string)` + +SetHost sets Host field to given value. + +### HasHost + +`func (o *MfaDuoConfig) HasHost() bool` + +HasHost returns a boolean if a field has been set. + +### SetHostNil + +`func (o *MfaDuoConfig) SetHostNil(b bool)` + + SetHostNil sets the value for Host to be an explicit nil + +### UnsetHost +`func (o *MfaDuoConfig) UnsetHost()` + +UnsetHost ensures that no value is present for Host, not even an explicit nil +### GetAccessKey + +`func (o *MfaDuoConfig) GetAccessKey() string` + +GetAccessKey returns the AccessKey field if non-nil, zero value otherwise. + +### GetAccessKeyOk + +`func (o *MfaDuoConfig) GetAccessKeyOk() (*string, bool)` + +GetAccessKeyOk returns a tuple with the AccessKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessKey + +`func (o *MfaDuoConfig) SetAccessKey(v string)` + +SetAccessKey sets AccessKey field to given value. + +### HasAccessKey + +`func (o *MfaDuoConfig) HasAccessKey() bool` + +HasAccessKey returns a boolean if a field has been set. + +### SetAccessKeyNil + +`func (o *MfaDuoConfig) SetAccessKeyNil(b bool)` + + SetAccessKeyNil sets the value for AccessKey to be an explicit nil + +### UnsetAccessKey +`func (o *MfaDuoConfig) UnsetAccessKey()` + +UnsetAccessKey ensures that no value is present for AccessKey, not even an explicit nil +### GetIdentityAttribute + +`func (o *MfaDuoConfig) GetIdentityAttribute() string` + +GetIdentityAttribute returns the IdentityAttribute field if non-nil, zero value otherwise. + +### GetIdentityAttributeOk + +`func (o *MfaDuoConfig) GetIdentityAttributeOk() (*string, bool)` + +GetIdentityAttributeOk returns a tuple with the IdentityAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttribute + +`func (o *MfaDuoConfig) SetIdentityAttribute(v string)` + +SetIdentityAttribute sets IdentityAttribute field to given value. + +### HasIdentityAttribute + +`func (o *MfaDuoConfig) HasIdentityAttribute() bool` + +HasIdentityAttribute returns a boolean if a field has been set. + +### SetIdentityAttributeNil + +`func (o *MfaDuoConfig) SetIdentityAttributeNil(b bool)` + + SetIdentityAttributeNil sets the value for IdentityAttribute to be an explicit nil + +### UnsetIdentityAttribute +`func (o *MfaDuoConfig) UnsetIdentityAttribute()` + +UnsetIdentityAttribute ensures that no value is present for IdentityAttribute, not even an explicit nil +### GetConfigProperties + +`func (o *MfaDuoConfig) GetConfigProperties() map[string]interface{}` + +GetConfigProperties returns the ConfigProperties field if non-nil, zero value otherwise. + +### GetConfigPropertiesOk + +`func (o *MfaDuoConfig) GetConfigPropertiesOk() (*map[string]interface{}, bool)` + +GetConfigPropertiesOk returns a tuple with the ConfigProperties field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigProperties + +`func (o *MfaDuoConfig) SetConfigProperties(v map[string]interface{})` + +SetConfigProperties sets ConfigProperties field to given value. + +### HasConfigProperties + +`func (o *MfaDuoConfig) HasConfigProperties() bool` + +HasConfigProperties returns a boolean if a field has been set. + +### SetConfigPropertiesNil + +`func (o *MfaDuoConfig) SetConfigPropertiesNil(b bool)` + + SetConfigPropertiesNil sets the value for ConfigProperties to be an explicit nil + +### UnsetConfigProperties +`func (o *MfaDuoConfig) UnsetConfigProperties()` + +UnsetConfigProperties ensures that no value is present for ConfigProperties, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/MfaOktaConfig.md b/docs/tools/sdk/go/Reference/V3/Models/MfaOktaConfig.md new file mode 100644 index 000000000..6ae57bf69 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/MfaOktaConfig.md @@ -0,0 +1,208 @@ +--- +id: mfa-okta-config +title: MfaOktaConfig +pagination_label: MfaOktaConfig +sidebar_label: MfaOktaConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MfaOktaConfig', 'MfaOktaConfig'] +slug: /tools/sdk/go/v3/models/mfa-okta-config +tags: ['SDK', 'Software Development Kit', 'MfaOktaConfig', 'MfaOktaConfig'] +--- + +# MfaOktaConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MfaMethod** | Pointer to **NullableString** | Mfa method name | [optional] +**Enabled** | Pointer to **bool** | If MFA method is enabled. | [optional] [default to false] +**Host** | Pointer to **NullableString** | The server host name or IP address of the MFA provider. | [optional] +**AccessKey** | Pointer to **NullableString** | The secret key for authenticating requests to the MFA provider. | [optional] +**IdentityAttribute** | Pointer to **NullableString** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] + +## Methods + +### NewMfaOktaConfig + +`func NewMfaOktaConfig() *MfaOktaConfig` + +NewMfaOktaConfig instantiates a new MfaOktaConfig 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 + +### NewMfaOktaConfigWithDefaults + +`func NewMfaOktaConfigWithDefaults() *MfaOktaConfig` + +NewMfaOktaConfigWithDefaults instantiates a new MfaOktaConfig 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 + +### GetMfaMethod + +`func (o *MfaOktaConfig) GetMfaMethod() string` + +GetMfaMethod returns the MfaMethod field if non-nil, zero value otherwise. + +### GetMfaMethodOk + +`func (o *MfaOktaConfig) GetMfaMethodOk() (*string, bool)` + +GetMfaMethodOk returns a tuple with the MfaMethod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMfaMethod + +`func (o *MfaOktaConfig) SetMfaMethod(v string)` + +SetMfaMethod sets MfaMethod field to given value. + +### HasMfaMethod + +`func (o *MfaOktaConfig) HasMfaMethod() bool` + +HasMfaMethod returns a boolean if a field has been set. + +### SetMfaMethodNil + +`func (o *MfaOktaConfig) SetMfaMethodNil(b bool)` + + SetMfaMethodNil sets the value for MfaMethod to be an explicit nil + +### UnsetMfaMethod +`func (o *MfaOktaConfig) UnsetMfaMethod()` + +UnsetMfaMethod ensures that no value is present for MfaMethod, not even an explicit nil +### GetEnabled + +`func (o *MfaOktaConfig) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *MfaOktaConfig) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *MfaOktaConfig) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *MfaOktaConfig) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetHost + +`func (o *MfaOktaConfig) GetHost() string` + +GetHost returns the Host field if non-nil, zero value otherwise. + +### GetHostOk + +`func (o *MfaOktaConfig) GetHostOk() (*string, bool)` + +GetHostOk returns a tuple with the Host field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHost + +`func (o *MfaOktaConfig) SetHost(v string)` + +SetHost sets Host field to given value. + +### HasHost + +`func (o *MfaOktaConfig) HasHost() bool` + +HasHost returns a boolean if a field has been set. + +### SetHostNil + +`func (o *MfaOktaConfig) SetHostNil(b bool)` + + SetHostNil sets the value for Host to be an explicit nil + +### UnsetHost +`func (o *MfaOktaConfig) UnsetHost()` + +UnsetHost ensures that no value is present for Host, not even an explicit nil +### GetAccessKey + +`func (o *MfaOktaConfig) GetAccessKey() string` + +GetAccessKey returns the AccessKey field if non-nil, zero value otherwise. + +### GetAccessKeyOk + +`func (o *MfaOktaConfig) GetAccessKeyOk() (*string, bool)` + +GetAccessKeyOk returns a tuple with the AccessKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessKey + +`func (o *MfaOktaConfig) SetAccessKey(v string)` + +SetAccessKey sets AccessKey field to given value. + +### HasAccessKey + +`func (o *MfaOktaConfig) HasAccessKey() bool` + +HasAccessKey returns a boolean if a field has been set. + +### SetAccessKeyNil + +`func (o *MfaOktaConfig) SetAccessKeyNil(b bool)` + + SetAccessKeyNil sets the value for AccessKey to be an explicit nil + +### UnsetAccessKey +`func (o *MfaOktaConfig) UnsetAccessKey()` + +UnsetAccessKey ensures that no value is present for AccessKey, not even an explicit nil +### GetIdentityAttribute + +`func (o *MfaOktaConfig) GetIdentityAttribute() string` + +GetIdentityAttribute returns the IdentityAttribute field if non-nil, zero value otherwise. + +### GetIdentityAttributeOk + +`func (o *MfaOktaConfig) GetIdentityAttributeOk() (*string, bool)` + +GetIdentityAttributeOk returns a tuple with the IdentityAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttribute + +`func (o *MfaOktaConfig) SetIdentityAttribute(v string)` + +SetIdentityAttribute sets IdentityAttribute field to given value. + +### HasIdentityAttribute + +`func (o *MfaOktaConfig) HasIdentityAttribute() bool` + +HasIdentityAttribute returns a boolean if a field has been set. + +### SetIdentityAttributeNil + +`func (o *MfaOktaConfig) SetIdentityAttributeNil(b bool)` + + SetIdentityAttributeNil sets the value for IdentityAttribute to be an explicit nil + +### UnsetIdentityAttribute +`func (o *MfaOktaConfig) UnsetIdentityAttribute()` + +UnsetIdentityAttribute ensures that no value is present for IdentityAttribute, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/MultiPolicyRequest.md b/docs/tools/sdk/go/Reference/V3/Models/MultiPolicyRequest.md new file mode 100644 index 000000000..5f5fe1239 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/MultiPolicyRequest.md @@ -0,0 +1,64 @@ +--- +id: multi-policy-request +title: MultiPolicyRequest +pagination_label: MultiPolicyRequest +sidebar_label: MultiPolicyRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'MultiPolicyRequest', 'MultiPolicyRequest'] +slug: /tools/sdk/go/v3/models/multi-policy-request +tags: ['SDK', 'Software Development Kit', 'MultiPolicyRequest', 'MultiPolicyRequest'] +--- + +# MultiPolicyRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FilteredPolicyList** | Pointer to **[]string** | Multi-policy report will be run for this list of ids | [optional] + +## Methods + +### NewMultiPolicyRequest + +`func NewMultiPolicyRequest() *MultiPolicyRequest` + +NewMultiPolicyRequest instantiates a new MultiPolicyRequest 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 + +### NewMultiPolicyRequestWithDefaults + +`func NewMultiPolicyRequestWithDefaults() *MultiPolicyRequest` + +NewMultiPolicyRequestWithDefaults instantiates a new MultiPolicyRequest 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 + +### GetFilteredPolicyList + +`func (o *MultiPolicyRequest) GetFilteredPolicyList() []string` + +GetFilteredPolicyList returns the FilteredPolicyList field if non-nil, zero value otherwise. + +### GetFilteredPolicyListOk + +`func (o *MultiPolicyRequest) GetFilteredPolicyListOk() (*[]string, bool)` + +GetFilteredPolicyListOk returns a tuple with the FilteredPolicyList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilteredPolicyList + +`func (o *MultiPolicyRequest) SetFilteredPolicyList(v []string)` + +SetFilteredPolicyList sets FilteredPolicyList field to given value. + +### HasFilteredPolicyList + +`func (o *MultiPolicyRequest) HasFilteredPolicyList() bool` + +HasFilteredPolicyList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NestedAggregation.md b/docs/tools/sdk/go/Reference/V3/Models/NestedAggregation.md new file mode 100644 index 000000000..f928baf0e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NestedAggregation.md @@ -0,0 +1,80 @@ +--- +id: nested-aggregation +title: NestedAggregation +pagination_label: NestedAggregation +sidebar_label: NestedAggregation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NestedAggregation', 'NestedAggregation'] +slug: /tools/sdk/go/v3/models/nested-aggregation +tags: ['SDK', 'Software Development Kit', 'NestedAggregation', 'NestedAggregation'] +--- + +# NestedAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The name of the nested aggregate to be included in the result. | +**Type** | **string** | The type of the nested object. | + +## Methods + +### NewNestedAggregation + +`func NewNestedAggregation(name string, type_ string, ) *NestedAggregation` + +NewNestedAggregation instantiates a new NestedAggregation 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 + +### NewNestedAggregationWithDefaults + +`func NewNestedAggregationWithDefaults() *NestedAggregation` + +NewNestedAggregationWithDefaults instantiates a new NestedAggregation 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 + +### GetName + +`func (o *NestedAggregation) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NestedAggregation) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NestedAggregation) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *NestedAggregation) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NestedAggregation) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NestedAggregation) SetType(v string)` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NetworkConfiguration.md b/docs/tools/sdk/go/Reference/V3/Models/NetworkConfiguration.md new file mode 100644 index 000000000..49251e5f0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NetworkConfiguration.md @@ -0,0 +1,136 @@ +--- +id: network-configuration +title: NetworkConfiguration +pagination_label: NetworkConfiguration +sidebar_label: NetworkConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NetworkConfiguration', 'NetworkConfiguration'] +slug: /tools/sdk/go/v3/models/network-configuration +tags: ['SDK', 'Software Development Kit', 'NetworkConfiguration', 'NetworkConfiguration'] +--- + +# NetworkConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Range** | Pointer to **[]string** | The collection of ip ranges. | [optional] +**Geolocation** | Pointer to **[]string** | The collection of country codes. | [optional] +**Whitelisted** | Pointer to **bool** | Denotes whether the provided lists are whitelisted or blacklisted for geo location. | [optional] [default to false] + +## Methods + +### NewNetworkConfiguration + +`func NewNetworkConfiguration() *NetworkConfiguration` + +NewNetworkConfiguration instantiates a new NetworkConfiguration 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 + +### NewNetworkConfigurationWithDefaults + +`func NewNetworkConfigurationWithDefaults() *NetworkConfiguration` + +NewNetworkConfigurationWithDefaults instantiates a new NetworkConfiguration 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 + +### GetRange + +`func (o *NetworkConfiguration) GetRange() []string` + +GetRange returns the Range field if non-nil, zero value otherwise. + +### GetRangeOk + +`func (o *NetworkConfiguration) GetRangeOk() (*[]string, bool)` + +GetRangeOk returns a tuple with the Range field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRange + +`func (o *NetworkConfiguration) SetRange(v []string)` + +SetRange sets Range field to given value. + +### HasRange + +`func (o *NetworkConfiguration) HasRange() bool` + +HasRange returns a boolean if a field has been set. + +### SetRangeNil + +`func (o *NetworkConfiguration) SetRangeNil(b bool)` + + SetRangeNil sets the value for Range to be an explicit nil + +### UnsetRange +`func (o *NetworkConfiguration) UnsetRange()` + +UnsetRange ensures that no value is present for Range, not even an explicit nil +### GetGeolocation + +`func (o *NetworkConfiguration) GetGeolocation() []string` + +GetGeolocation returns the Geolocation field if non-nil, zero value otherwise. + +### GetGeolocationOk + +`func (o *NetworkConfiguration) GetGeolocationOk() (*[]string, bool)` + +GetGeolocationOk returns a tuple with the Geolocation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGeolocation + +`func (o *NetworkConfiguration) SetGeolocation(v []string)` + +SetGeolocation sets Geolocation field to given value. + +### HasGeolocation + +`func (o *NetworkConfiguration) HasGeolocation() bool` + +HasGeolocation returns a boolean if a field has been set. + +### SetGeolocationNil + +`func (o *NetworkConfiguration) SetGeolocationNil(b bool)` + + SetGeolocationNil sets the value for Geolocation to be an explicit nil + +### UnsetGeolocation +`func (o *NetworkConfiguration) UnsetGeolocation()` + +UnsetGeolocation ensures that no value is present for Geolocation, not even an explicit nil +### GetWhitelisted + +`func (o *NetworkConfiguration) GetWhitelisted() bool` + +GetWhitelisted returns the Whitelisted field if non-nil, zero value otherwise. + +### GetWhitelistedOk + +`func (o *NetworkConfiguration) GetWhitelistedOk() (*bool, bool)` + +GetWhitelistedOk returns a tuple with the Whitelisted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWhitelisted + +`func (o *NetworkConfiguration) SetWhitelisted(v bool)` + +SetWhitelisted sets Whitelisted field to given value. + +### HasWhitelisted + +`func (o *NetworkConfiguration) HasWhitelisted() bool` + +HasWhitelisted returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeApprovalDecision.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeApprovalDecision.md new file mode 100644 index 000000000..654933fe5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeApprovalDecision.md @@ -0,0 +1,64 @@ +--- +id: non-employee-approval-decision +title: NonEmployeeApprovalDecision +pagination_label: NonEmployeeApprovalDecision +sidebar_label: NonEmployeeApprovalDecision +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalDecision', 'NonEmployeeApprovalDecision'] +slug: /tools/sdk/go/v3/models/non-employee-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalDecision', 'NonEmployeeApprovalDecision'] +--- + +# NonEmployeeApprovalDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment on the approval item. | [optional] + +## Methods + +### NewNonEmployeeApprovalDecision + +`func NewNonEmployeeApprovalDecision() *NonEmployeeApprovalDecision` + +NewNonEmployeeApprovalDecision instantiates a new NonEmployeeApprovalDecision 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 + +### NewNonEmployeeApprovalDecisionWithDefaults + +`func NewNonEmployeeApprovalDecisionWithDefaults() *NonEmployeeApprovalDecision` + +NewNonEmployeeApprovalDecisionWithDefaults instantiates a new NonEmployeeApprovalDecision 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 + +### GetComment + +`func (o *NonEmployeeApprovalDecision) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeApprovalDecision) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeApprovalDecision) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeApprovalDecision) HasComment() bool` + +HasComment returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeApprovalItem.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeApprovalItem.md new file mode 100644 index 000000000..c15d3c2ab --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeApprovalItem.md @@ -0,0 +1,272 @@ +--- +id: non-employee-approval-item +title: NonEmployeeApprovalItem +pagination_label: NonEmployeeApprovalItem +sidebar_label: NonEmployeeApprovalItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalItem', 'NonEmployeeApprovalItem'] +slug: /tools/sdk/go/v3/models/non-employee-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItem', 'NonEmployeeApprovalItem'] +--- + +# NonEmployeeApprovalItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **string** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **float32** | Approval order | [optional] +**Comment** | Pointer to **string** | comment of approver | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestLite**](non-employee-request-lite) | | [optional] + +## Methods + +### NewNonEmployeeApprovalItem + +`func NewNonEmployeeApprovalItem() *NonEmployeeApprovalItem` + +NewNonEmployeeApprovalItem instantiates a new NonEmployeeApprovalItem 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 + +### NewNonEmployeeApprovalItemWithDefaults + +`func NewNonEmployeeApprovalItemWithDefaults() *NonEmployeeApprovalItem` + +NewNonEmployeeApprovalItemWithDefaults instantiates a new NonEmployeeApprovalItem 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 + +### GetId + +`func (o *NonEmployeeApprovalItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeApprovalItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeApprovalItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeApprovalItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetApprover + +`func (o *NonEmployeeApprovalItem) GetApprover() NonEmployeeIdentityReferenceWithId` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *NonEmployeeApprovalItem) GetApproverOk() (*NonEmployeeIdentityReferenceWithId, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *NonEmployeeApprovalItem) SetApprover(v NonEmployeeIdentityReferenceWithId)` + +SetApprover sets Approver field to given value. + +### HasApprover + +`func (o *NonEmployeeApprovalItem) HasApprover() bool` + +HasApprover returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeApprovalItem) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeApprovalItem) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeApprovalItem) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeApprovalItem) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeApprovalItem) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeApprovalItem) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeApprovalItem) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeApprovalItem) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetApprovalOrder + +`func (o *NonEmployeeApprovalItem) GetApprovalOrder() float32` + +GetApprovalOrder returns the ApprovalOrder field if non-nil, zero value otherwise. + +### GetApprovalOrderOk + +`func (o *NonEmployeeApprovalItem) GetApprovalOrderOk() (*float32, bool)` + +GetApprovalOrderOk returns a tuple with the ApprovalOrder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalOrder + +`func (o *NonEmployeeApprovalItem) SetApprovalOrder(v float32)` + +SetApprovalOrder sets ApprovalOrder field to given value. + +### HasApprovalOrder + +`func (o *NonEmployeeApprovalItem) HasApprovalOrder() bool` + +HasApprovalOrder returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeApprovalItem) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeApprovalItem) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeApprovalItem) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeApprovalItem) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeApprovalItem) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeApprovalItem) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeApprovalItem) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeApprovalItem) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeApprovalItem) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeApprovalItem) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeApprovalItem) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeApprovalItem) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetNonEmployeeRequest + +`func (o *NonEmployeeApprovalItem) GetNonEmployeeRequest() NonEmployeeRequestLite` + +GetNonEmployeeRequest returns the NonEmployeeRequest field if non-nil, zero value otherwise. + +### GetNonEmployeeRequestOk + +`func (o *NonEmployeeApprovalItem) GetNonEmployeeRequestOk() (*NonEmployeeRequestLite, bool)` + +GetNonEmployeeRequestOk returns a tuple with the NonEmployeeRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeRequest + +`func (o *NonEmployeeApprovalItem) SetNonEmployeeRequest(v NonEmployeeRequestLite)` + +SetNonEmployeeRequest sets NonEmployeeRequest field to given value. + +### HasNonEmployeeRequest + +`func (o *NonEmployeeApprovalItem) HasNonEmployeeRequest() bool` + +HasNonEmployeeRequest returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeApprovalItemBase.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeApprovalItemBase.md new file mode 100644 index 000000000..702d614f6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeApprovalItemBase.md @@ -0,0 +1,246 @@ +--- +id: non-employee-approval-item-base +title: NonEmployeeApprovalItemBase +pagination_label: NonEmployeeApprovalItemBase +sidebar_label: NonEmployeeApprovalItemBase +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalItemBase', 'NonEmployeeApprovalItemBase'] +slug: /tools/sdk/go/v3/models/non-employee-approval-item-base +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemBase', 'NonEmployeeApprovalItemBase'] +--- + +# NonEmployeeApprovalItemBase + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **string** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **float32** | Approval order | [optional] +**Comment** | Pointer to **string** | comment of approver | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeApprovalItemBase + +`func NewNonEmployeeApprovalItemBase() *NonEmployeeApprovalItemBase` + +NewNonEmployeeApprovalItemBase instantiates a new NonEmployeeApprovalItemBase 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 + +### NewNonEmployeeApprovalItemBaseWithDefaults + +`func NewNonEmployeeApprovalItemBaseWithDefaults() *NonEmployeeApprovalItemBase` + +NewNonEmployeeApprovalItemBaseWithDefaults instantiates a new NonEmployeeApprovalItemBase 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 + +### GetId + +`func (o *NonEmployeeApprovalItemBase) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeApprovalItemBase) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeApprovalItemBase) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeApprovalItemBase) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetApprover + +`func (o *NonEmployeeApprovalItemBase) GetApprover() NonEmployeeIdentityReferenceWithId` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *NonEmployeeApprovalItemBase) GetApproverOk() (*NonEmployeeIdentityReferenceWithId, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *NonEmployeeApprovalItemBase) SetApprover(v NonEmployeeIdentityReferenceWithId)` + +SetApprover sets Approver field to given value. + +### HasApprover + +`func (o *NonEmployeeApprovalItemBase) HasApprover() bool` + +HasApprover returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeApprovalItemBase) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeApprovalItemBase) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeApprovalItemBase) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeApprovalItemBase) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeApprovalItemBase) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeApprovalItemBase) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeApprovalItemBase) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeApprovalItemBase) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetApprovalOrder + +`func (o *NonEmployeeApprovalItemBase) GetApprovalOrder() float32` + +GetApprovalOrder returns the ApprovalOrder field if non-nil, zero value otherwise. + +### GetApprovalOrderOk + +`func (o *NonEmployeeApprovalItemBase) GetApprovalOrderOk() (*float32, bool)` + +GetApprovalOrderOk returns a tuple with the ApprovalOrder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalOrder + +`func (o *NonEmployeeApprovalItemBase) SetApprovalOrder(v float32)` + +SetApprovalOrder sets ApprovalOrder field to given value. + +### HasApprovalOrder + +`func (o *NonEmployeeApprovalItemBase) HasApprovalOrder() bool` + +HasApprovalOrder returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeApprovalItemBase) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeApprovalItemBase) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeApprovalItemBase) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeApprovalItemBase) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeApprovalItemBase) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeApprovalItemBase) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeApprovalItemBase) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeApprovalItemBase) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeApprovalItemBase) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeApprovalItemBase) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeApprovalItemBase) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeApprovalItemBase) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeApprovalItemDetail.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeApprovalItemDetail.md new file mode 100644 index 000000000..c2079e4df --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeApprovalItemDetail.md @@ -0,0 +1,272 @@ +--- +id: non-employee-approval-item-detail +title: NonEmployeeApprovalItemDetail +pagination_label: NonEmployeeApprovalItemDetail +sidebar_label: NonEmployeeApprovalItemDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalItemDetail', 'NonEmployeeApprovalItemDetail'] +slug: /tools/sdk/go/v3/models/non-employee-approval-item-detail +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemDetail', 'NonEmployeeApprovalItemDetail'] +--- + +# NonEmployeeApprovalItemDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **string** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **float32** | Approval order | [optional] +**Comment** | Pointer to **string** | comment of approver | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestWithoutApprovalItem**](non-employee-request-without-approval-item) | | [optional] + +## Methods + +### NewNonEmployeeApprovalItemDetail + +`func NewNonEmployeeApprovalItemDetail() *NonEmployeeApprovalItemDetail` + +NewNonEmployeeApprovalItemDetail instantiates a new NonEmployeeApprovalItemDetail 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 + +### NewNonEmployeeApprovalItemDetailWithDefaults + +`func NewNonEmployeeApprovalItemDetailWithDefaults() *NonEmployeeApprovalItemDetail` + +NewNonEmployeeApprovalItemDetailWithDefaults instantiates a new NonEmployeeApprovalItemDetail 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 + +### GetId + +`func (o *NonEmployeeApprovalItemDetail) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeApprovalItemDetail) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeApprovalItemDetail) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeApprovalItemDetail) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetApprover + +`func (o *NonEmployeeApprovalItemDetail) GetApprover() NonEmployeeIdentityReferenceWithId` + +GetApprover returns the Approver field if non-nil, zero value otherwise. + +### GetApproverOk + +`func (o *NonEmployeeApprovalItemDetail) GetApproverOk() (*NonEmployeeIdentityReferenceWithId, bool)` + +GetApproverOk returns a tuple with the Approver field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprover + +`func (o *NonEmployeeApprovalItemDetail) SetApprover(v NonEmployeeIdentityReferenceWithId)` + +SetApprover sets Approver field to given value. + +### HasApprover + +`func (o *NonEmployeeApprovalItemDetail) HasApprover() bool` + +HasApprover returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeApprovalItemDetail) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeApprovalItemDetail) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeApprovalItemDetail) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeApprovalItemDetail) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeApprovalItemDetail) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeApprovalItemDetail) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeApprovalItemDetail) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeApprovalItemDetail) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetApprovalOrder + +`func (o *NonEmployeeApprovalItemDetail) GetApprovalOrder() float32` + +GetApprovalOrder returns the ApprovalOrder field if non-nil, zero value otherwise. + +### GetApprovalOrderOk + +`func (o *NonEmployeeApprovalItemDetail) GetApprovalOrderOk() (*float32, bool)` + +GetApprovalOrderOk returns a tuple with the ApprovalOrder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalOrder + +`func (o *NonEmployeeApprovalItemDetail) SetApprovalOrder(v float32)` + +SetApprovalOrder sets ApprovalOrder field to given value. + +### HasApprovalOrder + +`func (o *NonEmployeeApprovalItemDetail) HasApprovalOrder() bool` + +HasApprovalOrder returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeApprovalItemDetail) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeApprovalItemDetail) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeApprovalItemDetail) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeApprovalItemDetail) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeApprovalItemDetail) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeApprovalItemDetail) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeApprovalItemDetail) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeApprovalItemDetail) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeApprovalItemDetail) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeApprovalItemDetail) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeApprovalItemDetail) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeApprovalItemDetail) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetNonEmployeeRequest + +`func (o *NonEmployeeApprovalItemDetail) GetNonEmployeeRequest() NonEmployeeRequestWithoutApprovalItem` + +GetNonEmployeeRequest returns the NonEmployeeRequest field if non-nil, zero value otherwise. + +### GetNonEmployeeRequestOk + +`func (o *NonEmployeeApprovalItemDetail) GetNonEmployeeRequestOk() (*NonEmployeeRequestWithoutApprovalItem, bool)` + +GetNonEmployeeRequestOk returns a tuple with the NonEmployeeRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeRequest + +`func (o *NonEmployeeApprovalItemDetail) SetNonEmployeeRequest(v NonEmployeeRequestWithoutApprovalItem)` + +SetNonEmployeeRequest sets NonEmployeeRequest field to given value. + +### HasNonEmployeeRequest + +`func (o *NonEmployeeApprovalItemDetail) HasNonEmployeeRequest() bool` + +HasNonEmployeeRequest returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeApprovalSummary.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeApprovalSummary.md new file mode 100644 index 000000000..7c04cc41c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeApprovalSummary.md @@ -0,0 +1,116 @@ +--- +id: non-employee-approval-summary +title: NonEmployeeApprovalSummary +pagination_label: NonEmployeeApprovalSummary +sidebar_label: NonEmployeeApprovalSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeApprovalSummary', 'NonEmployeeApprovalSummary'] +slug: /tools/sdk/go/v3/models/non-employee-approval-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalSummary', 'NonEmployeeApprovalSummary'] +--- + +# NonEmployeeApprovalSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | Pointer to **int32** | The number of approved non-employee approval requests. | [optional] +**Pending** | Pointer to **int32** | The number of pending non-employee approval requests. | [optional] +**Rejected** | Pointer to **int32** | The number of rejected non-employee approval requests. | [optional] + +## Methods + +### NewNonEmployeeApprovalSummary + +`func NewNonEmployeeApprovalSummary() *NonEmployeeApprovalSummary` + +NewNonEmployeeApprovalSummary instantiates a new NonEmployeeApprovalSummary 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 + +### NewNonEmployeeApprovalSummaryWithDefaults + +`func NewNonEmployeeApprovalSummaryWithDefaults() *NonEmployeeApprovalSummary` + +NewNonEmployeeApprovalSummaryWithDefaults instantiates a new NonEmployeeApprovalSummary 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 + +### GetApproved + +`func (o *NonEmployeeApprovalSummary) GetApproved() int32` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *NonEmployeeApprovalSummary) GetApprovedOk() (*int32, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *NonEmployeeApprovalSummary) SetApproved(v int32)` + +SetApproved sets Approved field to given value. + +### HasApproved + +`func (o *NonEmployeeApprovalSummary) HasApproved() bool` + +HasApproved returns a boolean if a field has been set. + +### GetPending + +`func (o *NonEmployeeApprovalSummary) GetPending() int32` + +GetPending returns the Pending field if non-nil, zero value otherwise. + +### GetPendingOk + +`func (o *NonEmployeeApprovalSummary) GetPendingOk() (*int32, bool)` + +GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPending + +`func (o *NonEmployeeApprovalSummary) SetPending(v int32)` + +SetPending sets Pending field to given value. + +### HasPending + +`func (o *NonEmployeeApprovalSummary) HasPending() bool` + +HasPending returns a boolean if a field has been set. + +### GetRejected + +`func (o *NonEmployeeApprovalSummary) GetRejected() int32` + +GetRejected returns the Rejected field if non-nil, zero value otherwise. + +### GetRejectedOk + +`func (o *NonEmployeeApprovalSummary) GetRejectedOk() (*int32, bool)` + +GetRejectedOk returns a tuple with the Rejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRejected + +`func (o *NonEmployeeApprovalSummary) SetRejected(v int32)` + +SetRejected sets Rejected field to given value. + +### HasRejected + +`func (o *NonEmployeeApprovalSummary) HasRejected() bool` + +HasRejected returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeBulkUploadJob.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeBulkUploadJob.md new file mode 100644 index 000000000..b0b7e5510 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeBulkUploadJob.md @@ -0,0 +1,168 @@ +--- +id: non-employee-bulk-upload-job +title: NonEmployeeBulkUploadJob +pagination_label: NonEmployeeBulkUploadJob +sidebar_label: NonEmployeeBulkUploadJob +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeBulkUploadJob', 'NonEmployeeBulkUploadJob'] +slug: /tools/sdk/go/v3/models/non-employee-bulk-upload-job +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadJob', 'NonEmployeeBulkUploadJob'] +--- + +# NonEmployeeBulkUploadJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The bulk upload job's ID. (UUID) | [optional] +**SourceId** | Pointer to **string** | The ID of the source to bulk-upload non-employees to. (UUID) | [optional] +**Created** | Pointer to **SailPointTime** | The date-time the job was submitted. | [optional] +**Modified** | Pointer to **SailPointTime** | The date-time that the job was last updated. | [optional] +**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. | [optional] + +## Methods + +### NewNonEmployeeBulkUploadJob + +`func NewNonEmployeeBulkUploadJob() *NonEmployeeBulkUploadJob` + +NewNonEmployeeBulkUploadJob instantiates a new NonEmployeeBulkUploadJob 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 + +### NewNonEmployeeBulkUploadJobWithDefaults + +`func NewNonEmployeeBulkUploadJobWithDefaults() *NonEmployeeBulkUploadJob` + +NewNonEmployeeBulkUploadJobWithDefaults instantiates a new NonEmployeeBulkUploadJob 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 + +### GetId + +`func (o *NonEmployeeBulkUploadJob) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeBulkUploadJob) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeBulkUploadJob) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeBulkUploadJob) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeBulkUploadJob) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeBulkUploadJob) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeBulkUploadJob) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeBulkUploadJob) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeBulkUploadJob) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeBulkUploadJob) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeBulkUploadJob) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeBulkUploadJob) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeBulkUploadJob) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeBulkUploadJob) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeBulkUploadJob) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeBulkUploadJob) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetStatus + +`func (o *NonEmployeeBulkUploadJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *NonEmployeeBulkUploadJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *NonEmployeeBulkUploadJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *NonEmployeeBulkUploadJob) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeBulkUploadStatus.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeBulkUploadStatus.md new file mode 100644 index 000000000..a8dc7cdb1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeBulkUploadStatus.md @@ -0,0 +1,64 @@ +--- +id: non-employee-bulk-upload-status +title: NonEmployeeBulkUploadStatus +pagination_label: NonEmployeeBulkUploadStatus +sidebar_label: NonEmployeeBulkUploadStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeBulkUploadStatus', 'NonEmployeeBulkUploadStatus'] +slug: /tools/sdk/go/v3/models/non-employee-bulk-upload-status +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadStatus', 'NonEmployeeBulkUploadStatus'] +--- + +# NonEmployeeBulkUploadStatus + +## Properties + +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] + +## Methods + +### NewNonEmployeeBulkUploadStatus + +`func NewNonEmployeeBulkUploadStatus() *NonEmployeeBulkUploadStatus` + +NewNonEmployeeBulkUploadStatus instantiates a new NonEmployeeBulkUploadStatus 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 + +### NewNonEmployeeBulkUploadStatusWithDefaults + +`func NewNonEmployeeBulkUploadStatusWithDefaults() *NonEmployeeBulkUploadStatus` + +NewNonEmployeeBulkUploadStatusWithDefaults instantiates a new NonEmployeeBulkUploadStatus 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 + +### GetStatus + +`func (o *NonEmployeeBulkUploadStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *NonEmployeeBulkUploadStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *NonEmployeeBulkUploadStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *NonEmployeeBulkUploadStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeIdentityDtoType.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeIdentityDtoType.md new file mode 100644 index 000000000..8465884e6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeIdentityDtoType.md @@ -0,0 +1,21 @@ +--- +id: non-employee-identity-dto-type +title: NonEmployeeIdentityDtoType +pagination_label: NonEmployeeIdentityDtoType +sidebar_label: NonEmployeeIdentityDtoType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeIdentityDtoType', 'NonEmployeeIdentityDtoType'] +slug: /tools/sdk/go/v3/models/non-employee-identity-dto-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdentityDtoType', 'NonEmployeeIdentityDtoType'] +--- + +# NonEmployeeIdentityDtoType + +## Enum + + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + +* `IDENTITY` (value: `"IDENTITY"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeIdentityReferenceWithId.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeIdentityReferenceWithId.md new file mode 100644 index 000000000..4df1c17c0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeIdentityReferenceWithId.md @@ -0,0 +1,90 @@ +--- +id: non-employee-identity-reference-with-id +title: NonEmployeeIdentityReferenceWithId +pagination_label: NonEmployeeIdentityReferenceWithId +sidebar_label: NonEmployeeIdentityReferenceWithId +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeIdentityReferenceWithId', 'NonEmployeeIdentityReferenceWithId'] +slug: /tools/sdk/go/v3/models/non-employee-identity-reference-with-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdentityReferenceWithId', 'NonEmployeeIdentityReferenceWithId'] +--- + +# NonEmployeeIdentityReferenceWithId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**NonEmployeeIdentityDtoType**](non-employee-identity-dto-type) | | [optional] +**Id** | Pointer to **string** | Identity id | [optional] + +## Methods + +### NewNonEmployeeIdentityReferenceWithId + +`func NewNonEmployeeIdentityReferenceWithId() *NonEmployeeIdentityReferenceWithId` + +NewNonEmployeeIdentityReferenceWithId instantiates a new NonEmployeeIdentityReferenceWithId 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 + +### NewNonEmployeeIdentityReferenceWithIdWithDefaults + +`func NewNonEmployeeIdentityReferenceWithIdWithDefaults() *NonEmployeeIdentityReferenceWithId` + +NewNonEmployeeIdentityReferenceWithIdWithDefaults instantiates a new NonEmployeeIdentityReferenceWithId 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 + +### GetType + +`func (o *NonEmployeeIdentityReferenceWithId) GetType() NonEmployeeIdentityDtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NonEmployeeIdentityReferenceWithId) GetTypeOk() (*NonEmployeeIdentityDtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NonEmployeeIdentityReferenceWithId) SetType(v NonEmployeeIdentityDtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *NonEmployeeIdentityReferenceWithId) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *NonEmployeeIdentityReferenceWithId) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeIdentityReferenceWithId) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeIdentityReferenceWithId) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeIdentityReferenceWithId) HasId() bool` + +HasId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeIdnUserRequest.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeIdnUserRequest.md new file mode 100644 index 000000000..f259c7f48 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeIdnUserRequest.md @@ -0,0 +1,59 @@ +--- +id: non-employee-idn-user-request +title: NonEmployeeIdnUserRequest +pagination_label: NonEmployeeIdnUserRequest +sidebar_label: NonEmployeeIdnUserRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeIdnUserRequest', 'NonEmployeeIdnUserRequest'] +slug: /tools/sdk/go/v3/models/non-employee-idn-user-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdnUserRequest', 'NonEmployeeIdnUserRequest'] +--- + +# NonEmployeeIdnUserRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Identity id. | + +## Methods + +### NewNonEmployeeIdnUserRequest + +`func NewNonEmployeeIdnUserRequest(id string, ) *NonEmployeeIdnUserRequest` + +NewNonEmployeeIdnUserRequest instantiates a new NonEmployeeIdnUserRequest 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 + +### NewNonEmployeeIdnUserRequestWithDefaults + +`func NewNonEmployeeIdnUserRequestWithDefaults() *NonEmployeeIdnUserRequest` + +NewNonEmployeeIdnUserRequestWithDefaults instantiates a new NonEmployeeIdnUserRequest 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 + +### GetId + +`func (o *NonEmployeeIdnUserRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeIdnUserRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeIdnUserRequest) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRecord.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRecord.md new file mode 100644 index 000000000..5ffedd3a1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRecord.md @@ -0,0 +1,376 @@ +--- +id: non-employee-record +title: NonEmployeeRecord +pagination_label: NonEmployeeRecord +sidebar_label: NonEmployeeRecord +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRecord', 'NonEmployeeRecord'] +slug: /tools/sdk/go/v3/models/non-employee-record +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRecord', 'NonEmployeeRecord'] +--- + +# NonEmployeeRecord + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee record id. | [optional] +**AccountName** | Pointer to **string** | Requested identity account name. | [optional] +**FirstName** | Pointer to **string** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **string** | Non-Employee's last name. | [optional] +**Email** | Pointer to **string** | Non-Employee's email. | [optional] +**Phone** | Pointer to **string** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **string** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**SourceId** | Pointer to **string** | Non-Employee's source id. | [optional] +**Data** | Pointer to **map[string]string** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**StartDate** | Pointer to **SailPointTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **SailPointTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeRecord + +`func NewNonEmployeeRecord() *NonEmployeeRecord` + +NewNonEmployeeRecord instantiates a new NonEmployeeRecord 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 + +### NewNonEmployeeRecordWithDefaults + +`func NewNonEmployeeRecordWithDefaults() *NonEmployeeRecord` + +NewNonEmployeeRecordWithDefaults instantiates a new NonEmployeeRecord 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 + +### GetId + +`func (o *NonEmployeeRecord) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeRecord) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeRecord) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeRecord) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeRecord) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeRecord) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeRecord) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeRecord) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *NonEmployeeRecord) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *NonEmployeeRecord) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *NonEmployeeRecord) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *NonEmployeeRecord) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### GetLastName + +`func (o *NonEmployeeRecord) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *NonEmployeeRecord) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *NonEmployeeRecord) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *NonEmployeeRecord) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### GetEmail + +`func (o *NonEmployeeRecord) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *NonEmployeeRecord) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *NonEmployeeRecord) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *NonEmployeeRecord) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetPhone + +`func (o *NonEmployeeRecord) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *NonEmployeeRecord) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *NonEmployeeRecord) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *NonEmployeeRecord) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### GetManager + +`func (o *NonEmployeeRecord) GetManager() string` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *NonEmployeeRecord) GetManagerOk() (*string, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *NonEmployeeRecord) SetManager(v string)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *NonEmployeeRecord) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeRecord) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeRecord) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeRecord) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeRecord) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetData + +`func (o *NonEmployeeRecord) GetData() map[string]string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *NonEmployeeRecord) GetDataOk() (*map[string]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *NonEmployeeRecord) SetData(v map[string]string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *NonEmployeeRecord) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetStartDate + +`func (o *NonEmployeeRecord) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NonEmployeeRecord) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *NonEmployeeRecord) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *NonEmployeeRecord) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *NonEmployeeRecord) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *NonEmployeeRecord) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *NonEmployeeRecord) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *NonEmployeeRecord) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeRecord) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeRecord) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeRecord) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeRecord) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeRecord) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeRecord) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeRecord) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeRecord) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRejectApprovalDecision.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRejectApprovalDecision.md new file mode 100644 index 000000000..a5a70d71d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRejectApprovalDecision.md @@ -0,0 +1,59 @@ +--- +id: non-employee-reject-approval-decision +title: NonEmployeeRejectApprovalDecision +pagination_label: NonEmployeeRejectApprovalDecision +sidebar_label: NonEmployeeRejectApprovalDecision +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRejectApprovalDecision', 'NonEmployeeRejectApprovalDecision'] +slug: /tools/sdk/go/v3/models/non-employee-reject-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRejectApprovalDecision', 'NonEmployeeRejectApprovalDecision'] +--- + +# NonEmployeeRejectApprovalDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | **string** | Comment on the approval item. | + +## Methods + +### NewNonEmployeeRejectApprovalDecision + +`func NewNonEmployeeRejectApprovalDecision(comment string, ) *NonEmployeeRejectApprovalDecision` + +NewNonEmployeeRejectApprovalDecision instantiates a new NonEmployeeRejectApprovalDecision 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 + +### NewNonEmployeeRejectApprovalDecisionWithDefaults + +`func NewNonEmployeeRejectApprovalDecisionWithDefaults() *NonEmployeeRejectApprovalDecision` + +NewNonEmployeeRejectApprovalDecisionWithDefaults instantiates a new NonEmployeeRejectApprovalDecision 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 + +### GetComment + +`func (o *NonEmployeeRejectApprovalDecision) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeRejectApprovalDecision) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeRejectApprovalDecision) SetComment(v string)` + +SetComment sets Comment field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRequest.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRequest.md new file mode 100644 index 000000000..c164cf3f5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRequest.md @@ -0,0 +1,558 @@ +--- +id: non-employee-request +title: NonEmployeeRequest +pagination_label: NonEmployeeRequest +sidebar_label: NonEmployeeRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequest', 'NonEmployeeRequest'] +slug: /tools/sdk/go/v3/models/non-employee-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequest', 'NonEmployeeRequest'] +--- + +# NonEmployeeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**AccountName** | Pointer to **string** | Requested identity account name. | [optional] +**FirstName** | Pointer to **string** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **string** | Non-Employee's last name. | [optional] +**Email** | Pointer to **string** | Non-Employee's email. | [optional] +**Phone** | Pointer to **string** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **string** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLite**](non-employee-source-lite) | | [optional] +**Data** | Pointer to **map[string]string** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**ApprovalItems** | Pointer to [**[]NonEmployeeApprovalItemBase**](non-employee-approval-item-base) | List of approval item for the request | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**Comment** | Pointer to **string** | Comment of requester | [optional] +**CompletionDate** | Pointer to **SailPointTime** | When the request was completely approved. | [optional] +**StartDate** | Pointer to **SailPointTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **SailPointTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeRequest + +`func NewNonEmployeeRequest() *NonEmployeeRequest` + +NewNonEmployeeRequest instantiates a new NonEmployeeRequest 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 + +### NewNonEmployeeRequestWithDefaults + +`func NewNonEmployeeRequestWithDefaults() *NonEmployeeRequest` + +NewNonEmployeeRequestWithDefaults instantiates a new NonEmployeeRequest 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 + +### GetId + +`func (o *NonEmployeeRequest) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeRequest) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeRequest) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeRequest) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeRequest) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeRequest) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeRequest) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeRequest) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeRequest) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeRequest) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeRequest) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeRequest) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeRequest) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeRequest) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeRequest) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeRequest) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeRequest) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeRequest) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeRequest) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeRequest) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *NonEmployeeRequest) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *NonEmployeeRequest) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *NonEmployeeRequest) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *NonEmployeeRequest) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### GetLastName + +`func (o *NonEmployeeRequest) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *NonEmployeeRequest) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *NonEmployeeRequest) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *NonEmployeeRequest) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### GetEmail + +`func (o *NonEmployeeRequest) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *NonEmployeeRequest) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *NonEmployeeRequest) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *NonEmployeeRequest) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetPhone + +`func (o *NonEmployeeRequest) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *NonEmployeeRequest) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *NonEmployeeRequest) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *NonEmployeeRequest) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### GetManager + +`func (o *NonEmployeeRequest) GetManager() string` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *NonEmployeeRequest) GetManagerOk() (*string, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *NonEmployeeRequest) SetManager(v string)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *NonEmployeeRequest) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### GetNonEmployeeSource + +`func (o *NonEmployeeRequest) GetNonEmployeeSource() NonEmployeeSourceLite` + +GetNonEmployeeSource returns the NonEmployeeSource field if non-nil, zero value otherwise. + +### GetNonEmployeeSourceOk + +`func (o *NonEmployeeRequest) GetNonEmployeeSourceOk() (*NonEmployeeSourceLite, bool)` + +GetNonEmployeeSourceOk returns a tuple with the NonEmployeeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeSource + +`func (o *NonEmployeeRequest) SetNonEmployeeSource(v NonEmployeeSourceLite)` + +SetNonEmployeeSource sets NonEmployeeSource field to given value. + +### HasNonEmployeeSource + +`func (o *NonEmployeeRequest) HasNonEmployeeSource() bool` + +HasNonEmployeeSource returns a boolean if a field has been set. + +### GetData + +`func (o *NonEmployeeRequest) GetData() map[string]string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *NonEmployeeRequest) GetDataOk() (*map[string]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *NonEmployeeRequest) SetData(v map[string]string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *NonEmployeeRequest) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetApprovalItems + +`func (o *NonEmployeeRequest) GetApprovalItems() []NonEmployeeApprovalItemBase` + +GetApprovalItems returns the ApprovalItems field if non-nil, zero value otherwise. + +### GetApprovalItemsOk + +`func (o *NonEmployeeRequest) GetApprovalItemsOk() (*[]NonEmployeeApprovalItemBase, bool)` + +GetApprovalItemsOk returns a tuple with the ApprovalItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalItems + +`func (o *NonEmployeeRequest) SetApprovalItems(v []NonEmployeeApprovalItemBase)` + +SetApprovalItems sets ApprovalItems field to given value. + +### HasApprovalItems + +`func (o *NonEmployeeRequest) HasApprovalItems() bool` + +HasApprovalItems returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeRequest) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeRequest) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeRequest) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeRequest) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeRequest) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeRequest) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeRequest) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeRequest) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetCompletionDate + +`func (o *NonEmployeeRequest) GetCompletionDate() SailPointTime` + +GetCompletionDate returns the CompletionDate field if non-nil, zero value otherwise. + +### GetCompletionDateOk + +`func (o *NonEmployeeRequest) GetCompletionDateOk() (*SailPointTime, bool)` + +GetCompletionDateOk returns a tuple with the CompletionDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionDate + +`func (o *NonEmployeeRequest) SetCompletionDate(v SailPointTime)` + +SetCompletionDate sets CompletionDate field to given value. + +### HasCompletionDate + +`func (o *NonEmployeeRequest) HasCompletionDate() bool` + +HasCompletionDate returns a boolean if a field has been set. + +### GetStartDate + +`func (o *NonEmployeeRequest) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NonEmployeeRequest) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *NonEmployeeRequest) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *NonEmployeeRequest) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *NonEmployeeRequest) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *NonEmployeeRequest) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *NonEmployeeRequest) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *NonEmployeeRequest) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeRequest) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeRequest) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeRequest) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeRequest) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeRequest) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeRequest) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeRequest) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeRequest) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRequestBody.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRequestBody.md new file mode 100644 index 000000000..1ba5334a8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRequestBody.md @@ -0,0 +1,253 @@ +--- +id: non-employee-request-body +title: NonEmployeeRequestBody +pagination_label: NonEmployeeRequestBody +sidebar_label: NonEmployeeRequestBody +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequestBody', 'NonEmployeeRequestBody'] +slug: /tools/sdk/go/v3/models/non-employee-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestBody', 'NonEmployeeRequestBody'] +--- + +# NonEmployeeRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountName** | **string** | Requested identity account name. | +**FirstName** | **string** | Non-Employee's first name. | +**LastName** | **string** | Non-Employee's last name. | +**Email** | **string** | Non-Employee's email. | +**Phone** | **string** | Non-Employee's phone. | +**Manager** | **string** | The account ID of a valid identity to serve as this non-employee's manager. | +**SourceId** | **string** | Non-Employee's source id. | +**Data** | Pointer to **map[string]string** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**StartDate** | **SailPointTime** | Non-Employee employment start date. | +**EndDate** | **SailPointTime** | Non-Employee employment end date. | + +## Methods + +### NewNonEmployeeRequestBody + +`func NewNonEmployeeRequestBody(accountName string, firstName string, lastName string, email string, phone string, manager string, sourceId string, startDate SailPointTime, endDate SailPointTime, ) *NonEmployeeRequestBody` + +NewNonEmployeeRequestBody instantiates a new NonEmployeeRequestBody 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 + +### NewNonEmployeeRequestBodyWithDefaults + +`func NewNonEmployeeRequestBodyWithDefaults() *NonEmployeeRequestBody` + +NewNonEmployeeRequestBodyWithDefaults instantiates a new NonEmployeeRequestBody 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 + +### GetAccountName + +`func (o *NonEmployeeRequestBody) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeRequestBody) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeRequestBody) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + + +### GetFirstName + +`func (o *NonEmployeeRequestBody) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *NonEmployeeRequestBody) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *NonEmployeeRequestBody) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + + +### GetLastName + +`func (o *NonEmployeeRequestBody) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *NonEmployeeRequestBody) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *NonEmployeeRequestBody) SetLastName(v string)` + +SetLastName sets LastName field to given value. + + +### GetEmail + +`func (o *NonEmployeeRequestBody) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *NonEmployeeRequestBody) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *NonEmployeeRequestBody) SetEmail(v string)` + +SetEmail sets Email field to given value. + + +### GetPhone + +`func (o *NonEmployeeRequestBody) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *NonEmployeeRequestBody) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *NonEmployeeRequestBody) SetPhone(v string)` + +SetPhone sets Phone field to given value. + + +### GetManager + +`func (o *NonEmployeeRequestBody) GetManager() string` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *NonEmployeeRequestBody) GetManagerOk() (*string, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *NonEmployeeRequestBody) SetManager(v string)` + +SetManager sets Manager field to given value. + + +### GetSourceId + +`func (o *NonEmployeeRequestBody) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeRequestBody) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeRequestBody) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + + +### GetData + +`func (o *NonEmployeeRequestBody) GetData() map[string]string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *NonEmployeeRequestBody) GetDataOk() (*map[string]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *NonEmployeeRequestBody) SetData(v map[string]string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *NonEmployeeRequestBody) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetStartDate + +`func (o *NonEmployeeRequestBody) GetStartDate() SailPointTime` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NonEmployeeRequestBody) GetStartDateOk() (*SailPointTime, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *NonEmployeeRequestBody) SetStartDate(v SailPointTime)` + +SetStartDate sets StartDate field to given value. + + +### GetEndDate + +`func (o *NonEmployeeRequestBody) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *NonEmployeeRequestBody) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *NonEmployeeRequestBody) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRequestLite.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRequestLite.md new file mode 100644 index 000000000..9a4b77b08 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRequestLite.md @@ -0,0 +1,90 @@ +--- +id: non-employee-request-lite +title: NonEmployeeRequestLite +pagination_label: NonEmployeeRequestLite +sidebar_label: NonEmployeeRequestLite +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequestLite', 'NonEmployeeRequestLite'] +slug: /tools/sdk/go/v3/models/non-employee-request-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestLite', 'NonEmployeeRequestLite'] +--- + +# NonEmployeeRequestLite + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee request id. | [optional] +**Requester** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] + +## Methods + +### NewNonEmployeeRequestLite + +`func NewNonEmployeeRequestLite() *NonEmployeeRequestLite` + +NewNonEmployeeRequestLite instantiates a new NonEmployeeRequestLite 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 + +### NewNonEmployeeRequestLiteWithDefaults + +`func NewNonEmployeeRequestLiteWithDefaults() *NonEmployeeRequestLite` + +NewNonEmployeeRequestLiteWithDefaults instantiates a new NonEmployeeRequestLite 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 + +### GetId + +`func (o *NonEmployeeRequestLite) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeRequestLite) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeRequestLite) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeRequestLite) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRequester + +`func (o *NonEmployeeRequestLite) GetRequester() NonEmployeeIdentityReferenceWithId` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *NonEmployeeRequestLite) GetRequesterOk() (*NonEmployeeIdentityReferenceWithId, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *NonEmployeeRequestLite) SetRequester(v NonEmployeeIdentityReferenceWithId)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *NonEmployeeRequestLite) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRequestSummary.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRequestSummary.md new file mode 100644 index 000000000..94614f534 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRequestSummary.md @@ -0,0 +1,142 @@ +--- +id: non-employee-request-summary +title: NonEmployeeRequestSummary +pagination_label: NonEmployeeRequestSummary +sidebar_label: NonEmployeeRequestSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequestSummary', 'NonEmployeeRequestSummary'] +slug: /tools/sdk/go/v3/models/non-employee-request-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestSummary', 'NonEmployeeRequestSummary'] +--- + +# NonEmployeeRequestSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | Pointer to **int32** | The number of approved non-employee requests on all sources that *requested-for* user manages. | [optional] +**Rejected** | Pointer to **int32** | The number of rejected non-employee requests on all sources that *requested-for* user manages. | [optional] +**Pending** | Pointer to **int32** | The number of pending non-employee requests on all sources that *requested-for* user manages. | [optional] +**NonEmployeeCount** | Pointer to **int32** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] + +## Methods + +### NewNonEmployeeRequestSummary + +`func NewNonEmployeeRequestSummary() *NonEmployeeRequestSummary` + +NewNonEmployeeRequestSummary instantiates a new NonEmployeeRequestSummary 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 + +### NewNonEmployeeRequestSummaryWithDefaults + +`func NewNonEmployeeRequestSummaryWithDefaults() *NonEmployeeRequestSummary` + +NewNonEmployeeRequestSummaryWithDefaults instantiates a new NonEmployeeRequestSummary 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 + +### GetApproved + +`func (o *NonEmployeeRequestSummary) GetApproved() int32` + +GetApproved returns the Approved field if non-nil, zero value otherwise. + +### GetApprovedOk + +`func (o *NonEmployeeRequestSummary) GetApprovedOk() (*int32, bool)` + +GetApprovedOk returns a tuple with the Approved field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApproved + +`func (o *NonEmployeeRequestSummary) SetApproved(v int32)` + +SetApproved sets Approved field to given value. + +### HasApproved + +`func (o *NonEmployeeRequestSummary) HasApproved() bool` + +HasApproved returns a boolean if a field has been set. + +### GetRejected + +`func (o *NonEmployeeRequestSummary) GetRejected() int32` + +GetRejected returns the Rejected field if non-nil, zero value otherwise. + +### GetRejectedOk + +`func (o *NonEmployeeRequestSummary) GetRejectedOk() (*int32, bool)` + +GetRejectedOk returns a tuple with the Rejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRejected + +`func (o *NonEmployeeRequestSummary) SetRejected(v int32)` + +SetRejected sets Rejected field to given value. + +### HasRejected + +`func (o *NonEmployeeRequestSummary) HasRejected() bool` + +HasRejected returns a boolean if a field has been set. + +### GetPending + +`func (o *NonEmployeeRequestSummary) GetPending() int32` + +GetPending returns the Pending field if non-nil, zero value otherwise. + +### GetPendingOk + +`func (o *NonEmployeeRequestSummary) GetPendingOk() (*int32, bool)` + +GetPendingOk returns a tuple with the Pending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPending + +`func (o *NonEmployeeRequestSummary) SetPending(v int32)` + +SetPending sets Pending field to given value. + +### HasPending + +`func (o *NonEmployeeRequestSummary) HasPending() bool` + +HasPending returns a boolean if a field has been set. + +### GetNonEmployeeCount + +`func (o *NonEmployeeRequestSummary) GetNonEmployeeCount() int32` + +GetNonEmployeeCount returns the NonEmployeeCount field if non-nil, zero value otherwise. + +### GetNonEmployeeCountOk + +`func (o *NonEmployeeRequestSummary) GetNonEmployeeCountOk() (*int32, bool)` + +GetNonEmployeeCountOk returns a tuple with the NonEmployeeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeCount + +`func (o *NonEmployeeRequestSummary) SetNonEmployeeCount(v int32)` + +SetNonEmployeeCount sets NonEmployeeCount field to given value. + +### HasNonEmployeeCount + +`func (o *NonEmployeeRequestSummary) HasNonEmployeeCount() bool` + +HasNonEmployeeCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md new file mode 100644 index 000000000..5f69f5937 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -0,0 +1,480 @@ +--- +id: non-employee-request-without-approval-item +title: NonEmployeeRequestWithoutApprovalItem +pagination_label: NonEmployeeRequestWithoutApprovalItem +sidebar_label: NonEmployeeRequestWithoutApprovalItem +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeRequestWithoutApprovalItem', 'NonEmployeeRequestWithoutApprovalItem'] +slug: /tools/sdk/go/v3/models/non-employee-request-without-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestWithoutApprovalItem', 'NonEmployeeRequestWithoutApprovalItem'] +--- + +# NonEmployeeRequestWithoutApprovalItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee request id. | [optional] +**Requester** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **string** | Requested identity account name. | [optional] +**FirstName** | Pointer to **string** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **string** | Non-Employee's last name. | [optional] +**Email** | Pointer to **string** | Non-Employee's email. | [optional] +**Phone** | Pointer to **string** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **string** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLiteWithSchemaAttributes**](non-employee-source-lite-with-schema-attributes) | | [optional] +**Data** | Pointer to **map[string]string** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**Comment** | Pointer to **string** | Comment of requester | [optional] +**CompletionDate** | Pointer to **SailPointTime** | When the request was completely approved. | [optional] +**StartDate** | Pointer to **string** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **string** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeRequestWithoutApprovalItem + +`func NewNonEmployeeRequestWithoutApprovalItem() *NonEmployeeRequestWithoutApprovalItem` + +NewNonEmployeeRequestWithoutApprovalItem instantiates a new NonEmployeeRequestWithoutApprovalItem 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 + +### NewNonEmployeeRequestWithoutApprovalItemWithDefaults + +`func NewNonEmployeeRequestWithoutApprovalItemWithDefaults() *NonEmployeeRequestWithoutApprovalItem` + +NewNonEmployeeRequestWithoutApprovalItemWithDefaults instantiates a new NonEmployeeRequestWithoutApprovalItem 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 + +### GetId + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRequester + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetRequester() NonEmployeeIdentityReferenceWithId` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetRequesterOk() (*NonEmployeeIdentityReferenceWithId, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetRequester(v NonEmployeeIdentityReferenceWithId)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetAccountName + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + +### GetFirstName + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetFirstName() string` + +GetFirstName returns the FirstName field if non-nil, zero value otherwise. + +### GetFirstNameOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetFirstNameOk() (*string, bool)` + +GetFirstNameOk returns a tuple with the FirstName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstName + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetFirstName(v string)` + +SetFirstName sets FirstName field to given value. + +### HasFirstName + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasFirstName() bool` + +HasFirstName returns a boolean if a field has been set. + +### GetLastName + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetLastName() string` + +GetLastName returns the LastName field if non-nil, zero value otherwise. + +### GetLastNameOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetLastNameOk() (*string, bool)` + +GetLastNameOk returns a tuple with the LastName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastName + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetLastName(v string)` + +SetLastName sets LastName field to given value. + +### HasLastName + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasLastName() bool` + +HasLastName returns a boolean if a field has been set. + +### GetEmail + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetPhone + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetPhone() string` + +GetPhone returns the Phone field if non-nil, zero value otherwise. + +### GetPhoneOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetPhoneOk() (*string, bool)` + +GetPhoneOk returns a tuple with the Phone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPhone + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetPhone(v string)` + +SetPhone sets Phone field to given value. + +### HasPhone + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasPhone() bool` + +HasPhone returns a boolean if a field has been set. + +### GetManager + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetManager() string` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetManagerOk() (*string, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetManager(v string)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### GetNonEmployeeSource + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetNonEmployeeSource() NonEmployeeSourceLiteWithSchemaAttributes` + +GetNonEmployeeSource returns the NonEmployeeSource field if non-nil, zero value otherwise. + +### GetNonEmployeeSourceOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetNonEmployeeSourceOk() (*NonEmployeeSourceLiteWithSchemaAttributes, bool)` + +GetNonEmployeeSourceOk returns a tuple with the NonEmployeeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeSource + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetNonEmployeeSource(v NonEmployeeSourceLiteWithSchemaAttributes)` + +SetNonEmployeeSource sets NonEmployeeSource field to given value. + +### HasNonEmployeeSource + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasNonEmployeeSource() bool` + +HasNonEmployeeSource returns a boolean if a field has been set. + +### GetData + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetData() map[string]string` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetDataOk() (*map[string]string, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetData + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetData(v map[string]string)` + +SetData sets Data field to given value. + +### HasData + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasData() bool` + +HasData returns a boolean if a field has been set. + +### GetApprovalStatus + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetApprovalStatus() ApprovalStatus` + +GetApprovalStatus returns the ApprovalStatus field if non-nil, zero value otherwise. + +### GetApprovalStatusOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetApprovalStatusOk() (*ApprovalStatus, bool)` + +GetApprovalStatusOk returns a tuple with the ApprovalStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalStatus + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetApprovalStatus(v ApprovalStatus)` + +SetApprovalStatus sets ApprovalStatus field to given value. + +### HasApprovalStatus + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasApprovalStatus() bool` + +HasApprovalStatus returns a boolean if a field has been set. + +### GetComment + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetCompletionDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCompletionDate() SailPointTime` + +GetCompletionDate returns the CompletionDate field if non-nil, zero value otherwise. + +### GetCompletionDateOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCompletionDateOk() (*SailPointTime, bool)` + +GetCompletionDateOk returns a tuple with the CompletionDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetCompletionDate(v SailPointTime)` + +SetCompletionDate sets CompletionDate field to given value. + +### HasCompletionDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasCompletionDate() bool` + +HasCompletionDate returns a boolean if a field has been set. + +### GetStartDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetStartDate() string` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetStartDateOk() (*string, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetStartDate(v string)` + +SetStartDate sets StartDate field to given value. + +### HasStartDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### GetEndDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetEndDate() string` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetEndDateOk() (*string, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetEndDate(v string)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeRequestWithoutApprovalItem) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeRequestWithoutApprovalItem) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeRequestWithoutApprovalItem) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSchemaAttribute.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSchemaAttribute.md new file mode 100644 index 000000000..acd87bb6e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSchemaAttribute.md @@ -0,0 +1,283 @@ +--- +id: non-employee-schema-attribute +title: NonEmployeeSchemaAttribute +pagination_label: NonEmployeeSchemaAttribute +sidebar_label: NonEmployeeSchemaAttribute +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSchemaAttribute', 'NonEmployeeSchemaAttribute'] +slug: /tools/sdk/go/v3/models/non-employee-schema-attribute +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttribute', 'NonEmployeeSchemaAttribute'] +--- + +# NonEmployeeSchemaAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Schema Attribute Id | [optional] +**System** | Pointer to **bool** | True if this schema attribute is mandatory on all non-employees sources. | [optional] [default to false] +**Modified** | Pointer to **SailPointTime** | When the schema attribute was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the schema attribute was created. | [optional] +**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] +**Required** | Pointer to **bool** | If true, the schema attribute is required for all non-employees in the source | [optional] [default to false] + +## Methods + +### NewNonEmployeeSchemaAttribute + +`func NewNonEmployeeSchemaAttribute(type_ NonEmployeeSchemaAttributeType, label string, technicalName string, ) *NonEmployeeSchemaAttribute` + +NewNonEmployeeSchemaAttribute instantiates a new NonEmployeeSchemaAttribute 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 + +### NewNonEmployeeSchemaAttributeWithDefaults + +`func NewNonEmployeeSchemaAttributeWithDefaults() *NonEmployeeSchemaAttribute` + +NewNonEmployeeSchemaAttributeWithDefaults instantiates a new NonEmployeeSchemaAttribute 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 + +### GetId + +`func (o *NonEmployeeSchemaAttribute) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSchemaAttribute) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSchemaAttribute) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSchemaAttribute) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSystem + +`func (o *NonEmployeeSchemaAttribute) GetSystem() bool` + +GetSystem returns the System field if non-nil, zero value otherwise. + +### GetSystemOk + +`func (o *NonEmployeeSchemaAttribute) GetSystemOk() (*bool, bool)` + +GetSystemOk returns a tuple with the System field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSystem + +`func (o *NonEmployeeSchemaAttribute) SetSystem(v bool)` + +SetSystem sets System field to given value. + +### HasSystem + +`func (o *NonEmployeeSchemaAttribute) HasSystem() bool` + +HasSystem returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeSchemaAttribute) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeSchemaAttribute) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeSchemaAttribute) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeSchemaAttribute) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeSchemaAttribute) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeSchemaAttribute) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeSchemaAttribute) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeSchemaAttribute) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetType + +`func (o *NonEmployeeSchemaAttribute) GetType() NonEmployeeSchemaAttributeType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NonEmployeeSchemaAttribute) GetTypeOk() (*NonEmployeeSchemaAttributeType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NonEmployeeSchemaAttribute) SetType(v NonEmployeeSchemaAttributeType)` + +SetType sets Type field to given value. + + +### GetLabel + +`func (o *NonEmployeeSchemaAttribute) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *NonEmployeeSchemaAttribute) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *NonEmployeeSchemaAttribute) SetLabel(v string)` + +SetLabel sets Label field to given value. + + +### GetTechnicalName + +`func (o *NonEmployeeSchemaAttribute) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *NonEmployeeSchemaAttribute) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *NonEmployeeSchemaAttribute) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + + +### GetHelpText + +`func (o *NonEmployeeSchemaAttribute) GetHelpText() string` + +GetHelpText returns the HelpText field if non-nil, zero value otherwise. + +### GetHelpTextOk + +`func (o *NonEmployeeSchemaAttribute) GetHelpTextOk() (*string, bool)` + +GetHelpTextOk returns a tuple with the HelpText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHelpText + +`func (o *NonEmployeeSchemaAttribute) SetHelpText(v string)` + +SetHelpText sets HelpText field to given value. + +### HasHelpText + +`func (o *NonEmployeeSchemaAttribute) HasHelpText() bool` + +HasHelpText returns a boolean if a field has been set. + +### GetPlaceholder + +`func (o *NonEmployeeSchemaAttribute) GetPlaceholder() string` + +GetPlaceholder returns the Placeholder field if non-nil, zero value otherwise. + +### GetPlaceholderOk + +`func (o *NonEmployeeSchemaAttribute) GetPlaceholderOk() (*string, bool)` + +GetPlaceholderOk returns a tuple with the Placeholder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPlaceholder + +`func (o *NonEmployeeSchemaAttribute) SetPlaceholder(v string)` + +SetPlaceholder sets Placeholder field to given value. + +### HasPlaceholder + +`func (o *NonEmployeeSchemaAttribute) HasPlaceholder() bool` + +HasPlaceholder returns a boolean if a field has been set. + +### GetRequired + +`func (o *NonEmployeeSchemaAttribute) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *NonEmployeeSchemaAttribute) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *NonEmployeeSchemaAttribute) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *NonEmployeeSchemaAttribute) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSchemaAttributeBody.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSchemaAttributeBody.md new file mode 100644 index 000000000..cb8da2148 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSchemaAttributeBody.md @@ -0,0 +1,179 @@ +--- +id: non-employee-schema-attribute-body +title: NonEmployeeSchemaAttributeBody +pagination_label: NonEmployeeSchemaAttributeBody +sidebar_label: NonEmployeeSchemaAttributeBody +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSchemaAttributeBody', 'NonEmployeeSchemaAttributeBody'] +slug: /tools/sdk/go/v3/models/non-employee-schema-attribute-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeBody', 'NonEmployeeSchemaAttributeBody'] +--- + +# NonEmployeeSchemaAttributeBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of the attribute. Only type 'TEXT' is supported for custom attributes. | +**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] +**Required** | Pointer to **bool** | If true, the schema attribute is required for all non-employees in the source | [optional] + +## Methods + +### NewNonEmployeeSchemaAttributeBody + +`func NewNonEmployeeSchemaAttributeBody(type_ string, label string, technicalName string, ) *NonEmployeeSchemaAttributeBody` + +NewNonEmployeeSchemaAttributeBody instantiates a new NonEmployeeSchemaAttributeBody 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 + +### NewNonEmployeeSchemaAttributeBodyWithDefaults + +`func NewNonEmployeeSchemaAttributeBodyWithDefaults() *NonEmployeeSchemaAttributeBody` + +NewNonEmployeeSchemaAttributeBodyWithDefaults instantiates a new NonEmployeeSchemaAttributeBody 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 + +### GetType + +`func (o *NonEmployeeSchemaAttributeBody) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NonEmployeeSchemaAttributeBody) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NonEmployeeSchemaAttributeBody) SetType(v string)` + +SetType sets Type field to given value. + + +### GetLabel + +`func (o *NonEmployeeSchemaAttributeBody) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *NonEmployeeSchemaAttributeBody) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *NonEmployeeSchemaAttributeBody) SetLabel(v string)` + +SetLabel sets Label field to given value. + + +### GetTechnicalName + +`func (o *NonEmployeeSchemaAttributeBody) GetTechnicalName() string` + +GetTechnicalName returns the TechnicalName field if non-nil, zero value otherwise. + +### GetTechnicalNameOk + +`func (o *NonEmployeeSchemaAttributeBody) GetTechnicalNameOk() (*string, bool)` + +GetTechnicalNameOk returns a tuple with the TechnicalName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTechnicalName + +`func (o *NonEmployeeSchemaAttributeBody) SetTechnicalName(v string)` + +SetTechnicalName sets TechnicalName field to given value. + + +### GetHelpText + +`func (o *NonEmployeeSchemaAttributeBody) GetHelpText() string` + +GetHelpText returns the HelpText field if non-nil, zero value otherwise. + +### GetHelpTextOk + +`func (o *NonEmployeeSchemaAttributeBody) GetHelpTextOk() (*string, bool)` + +GetHelpTextOk returns a tuple with the HelpText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHelpText + +`func (o *NonEmployeeSchemaAttributeBody) SetHelpText(v string)` + +SetHelpText sets HelpText field to given value. + +### HasHelpText + +`func (o *NonEmployeeSchemaAttributeBody) HasHelpText() bool` + +HasHelpText returns a boolean if a field has been set. + +### GetPlaceholder + +`func (o *NonEmployeeSchemaAttributeBody) GetPlaceholder() string` + +GetPlaceholder returns the Placeholder field if non-nil, zero value otherwise. + +### GetPlaceholderOk + +`func (o *NonEmployeeSchemaAttributeBody) GetPlaceholderOk() (*string, bool)` + +GetPlaceholderOk returns a tuple with the Placeholder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPlaceholder + +`func (o *NonEmployeeSchemaAttributeBody) SetPlaceholder(v string)` + +SetPlaceholder sets Placeholder field to given value. + +### HasPlaceholder + +`func (o *NonEmployeeSchemaAttributeBody) HasPlaceholder() bool` + +HasPlaceholder returns a boolean if a field has been set. + +### GetRequired + +`func (o *NonEmployeeSchemaAttributeBody) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *NonEmployeeSchemaAttributeBody) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *NonEmployeeSchemaAttributeBody) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *NonEmployeeSchemaAttributeBody) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSchemaAttributeType.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSchemaAttributeType.md new file mode 100644 index 000000000..e33a0d97e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSchemaAttributeType.md @@ -0,0 +1,23 @@ +--- +id: non-employee-schema-attribute-type +title: NonEmployeeSchemaAttributeType +pagination_label: NonEmployeeSchemaAttributeType +sidebar_label: NonEmployeeSchemaAttributeType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSchemaAttributeType', 'NonEmployeeSchemaAttributeType'] +slug: /tools/sdk/go/v3/models/non-employee-schema-attribute-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeType', 'NonEmployeeSchemaAttributeType'] +--- + +# NonEmployeeSchemaAttributeType + +## Enum + + +* `TEXT` (value: `"TEXT"`) + +* `DATE` (value: `"DATE"`) + +* `IDENTITY` (value: `"IDENTITY"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSource.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSource.md new file mode 100644 index 000000000..7133da61c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSource.md @@ -0,0 +1,246 @@ +--- +id: non-employee-source +title: NonEmployeeSource +pagination_label: NonEmployeeSource +sidebar_label: NonEmployeeSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSource', 'NonEmployeeSource'] +slug: /tools/sdk/go/v3/models/non-employee-source +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSource', 'NonEmployeeSource'] +--- + +# NonEmployeeSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] + +## Methods + +### NewNonEmployeeSource + +`func NewNonEmployeeSource() *NonEmployeeSource` + +NewNonEmployeeSource instantiates a new NonEmployeeSource 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 + +### NewNonEmployeeSourceWithDefaults + +`func NewNonEmployeeSourceWithDefaults() *NonEmployeeSource` + +NewNonEmployeeSourceWithDefaults instantiates a new NonEmployeeSource 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 + +### GetId + +`func (o *NonEmployeeSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSource) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSource) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSource) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSource) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSource) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSource) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSource) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSource) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetApprovers + +`func (o *NonEmployeeSource) GetApprovers() []NonEmployeeIdentityReferenceWithId` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *NonEmployeeSource) GetApproversOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *NonEmployeeSource) SetApprovers(v []NonEmployeeIdentityReferenceWithId)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *NonEmployeeSource) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetAccountManagers + +`func (o *NonEmployeeSource) GetAccountManagers() []NonEmployeeIdentityReferenceWithId` + +GetAccountManagers returns the AccountManagers field if non-nil, zero value otherwise. + +### GetAccountManagersOk + +`func (o *NonEmployeeSource) GetAccountManagersOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetAccountManagersOk returns a tuple with the AccountManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountManagers + +`func (o *NonEmployeeSource) SetAccountManagers(v []NonEmployeeIdentityReferenceWithId)` + +SetAccountManagers sets AccountManagers field to given value. + +### HasAccountManagers + +`func (o *NonEmployeeSource) HasAccountManagers() bool` + +HasAccountManagers returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeSource) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeSource) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeSource) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeSource) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeSource) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeSource) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeSource) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeSource) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSourceLite.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSourceLite.md new file mode 100644 index 000000000..c18f10744 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSourceLite.md @@ -0,0 +1,142 @@ +--- +id: non-employee-source-lite +title: NonEmployeeSourceLite +pagination_label: NonEmployeeSourceLite +sidebar_label: NonEmployeeSourceLite +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceLite', 'NonEmployeeSourceLite'] +slug: /tools/sdk/go/v3/models/non-employee-source-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLite', 'NonEmployeeSourceLite'] +--- + +# NonEmployeeSourceLite + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] + +## Methods + +### NewNonEmployeeSourceLite + +`func NewNonEmployeeSourceLite() *NonEmployeeSourceLite` + +NewNonEmployeeSourceLite instantiates a new NonEmployeeSourceLite 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 + +### NewNonEmployeeSourceLiteWithDefaults + +`func NewNonEmployeeSourceLiteWithDefaults() *NonEmployeeSourceLite` + +NewNonEmployeeSourceLiteWithDefaults instantiates a new NonEmployeeSourceLite 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 + +### GetId + +`func (o *NonEmployeeSourceLite) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSourceLite) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSourceLite) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSourceLite) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSourceLite) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSourceLite) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSourceLite) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSourceLite) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSourceLite) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceLite) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceLite) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSourceLite) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSourceLite) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceLite) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceLite) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSourceLite) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSourceLiteWithSchemaAttributes.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSourceLiteWithSchemaAttributes.md new file mode 100644 index 000000000..0a7fab041 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSourceLiteWithSchemaAttributes.md @@ -0,0 +1,168 @@ +--- +id: non-employee-source-lite-with-schema-attributes +title: NonEmployeeSourceLiteWithSchemaAttributes +pagination_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceLiteWithSchemaAttributes', 'NonEmployeeSourceLiteWithSchemaAttributes'] +slug: /tools/sdk/go/v3/models/non-employee-source-lite-with-schema-attributes +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLiteWithSchemaAttributes', 'NonEmployeeSourceLiteWithSchemaAttributes'] +--- + +# NonEmployeeSourceLiteWithSchemaAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**SchemaAttributes** | Pointer to [**[]NonEmployeeSchemaAttribute**](non-employee-schema-attribute) | List of schema attributes associated with this non-employee source. | [optional] + +## Methods + +### NewNonEmployeeSourceLiteWithSchemaAttributes + +`func NewNonEmployeeSourceLiteWithSchemaAttributes() *NonEmployeeSourceLiteWithSchemaAttributes` + +NewNonEmployeeSourceLiteWithSchemaAttributes instantiates a new NonEmployeeSourceLiteWithSchemaAttributes 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 + +### NewNonEmployeeSourceLiteWithSchemaAttributesWithDefaults + +`func NewNonEmployeeSourceLiteWithSchemaAttributesWithDefaults() *NonEmployeeSourceLiteWithSchemaAttributes` + +NewNonEmployeeSourceLiteWithSchemaAttributesWithDefaults instantiates a new NonEmployeeSourceLiteWithSchemaAttributes 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 + +### GetId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetSchemaAttributes + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetSchemaAttributes() []NonEmployeeSchemaAttribute` + +GetSchemaAttributes returns the SchemaAttributes field if non-nil, zero value otherwise. + +### GetSchemaAttributesOk + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) GetSchemaAttributesOk() (*[]NonEmployeeSchemaAttribute, bool)` + +GetSchemaAttributesOk returns a tuple with the SchemaAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchemaAttributes + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) SetSchemaAttributes(v []NonEmployeeSchemaAttribute)` + +SetSchemaAttributes sets SchemaAttributes field to given value. + +### HasSchemaAttributes + +`func (o *NonEmployeeSourceLiteWithSchemaAttributes) HasSchemaAttributes() bool` + +HasSchemaAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSourceRequestBody.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSourceRequestBody.md new file mode 100644 index 000000000..6126a518f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSourceRequestBody.md @@ -0,0 +1,179 @@ +--- +id: non-employee-source-request-body +title: NonEmployeeSourceRequestBody +pagination_label: NonEmployeeSourceRequestBody +sidebar_label: NonEmployeeSourceRequestBody +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceRequestBody', 'NonEmployeeSourceRequestBody'] +slug: /tools/sdk/go/v3/models/non-employee-source-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceRequestBody', 'NonEmployeeSourceRequestBody'] +--- + +# NonEmployeeSourceRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Name of non-employee source. | +**Description** | **string** | Description of non-employee source. | +**Owner** | [**NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | | +**ManagementWorkgroup** | Pointer to **string** | The ID for the management workgroup that contains source sub-admins | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of approvers. | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of account managers. | [optional] + +## Methods + +### NewNonEmployeeSourceRequestBody + +`func NewNonEmployeeSourceRequestBody(name string, description string, owner NonEmployeeIdnUserRequest, ) *NonEmployeeSourceRequestBody` + +NewNonEmployeeSourceRequestBody instantiates a new NonEmployeeSourceRequestBody 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 + +### NewNonEmployeeSourceRequestBodyWithDefaults + +`func NewNonEmployeeSourceRequestBodyWithDefaults() *NonEmployeeSourceRequestBody` + +NewNonEmployeeSourceRequestBodyWithDefaults instantiates a new NonEmployeeSourceRequestBody 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 + +### GetName + +`func (o *NonEmployeeSourceRequestBody) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceRequestBody) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceRequestBody) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *NonEmployeeSourceRequestBody) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceRequestBody) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceRequestBody) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetOwner + +`func (o *NonEmployeeSourceRequestBody) GetOwner() NonEmployeeIdnUserRequest` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *NonEmployeeSourceRequestBody) GetOwnerOk() (*NonEmployeeIdnUserRequest, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *NonEmployeeSourceRequestBody) SetOwner(v NonEmployeeIdnUserRequest)` + +SetOwner sets Owner field to given value. + + +### GetManagementWorkgroup + +`func (o *NonEmployeeSourceRequestBody) GetManagementWorkgroup() string` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *NonEmployeeSourceRequestBody) GetManagementWorkgroupOk() (*string, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *NonEmployeeSourceRequestBody) SetManagementWorkgroup(v string)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *NonEmployeeSourceRequestBody) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### GetApprovers + +`func (o *NonEmployeeSourceRequestBody) GetApprovers() []NonEmployeeIdnUserRequest` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *NonEmployeeSourceRequestBody) GetApproversOk() (*[]NonEmployeeIdnUserRequest, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *NonEmployeeSourceRequestBody) SetApprovers(v []NonEmployeeIdnUserRequest)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *NonEmployeeSourceRequestBody) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetAccountManagers + +`func (o *NonEmployeeSourceRequestBody) GetAccountManagers() []NonEmployeeIdnUserRequest` + +GetAccountManagers returns the AccountManagers field if non-nil, zero value otherwise. + +### GetAccountManagersOk + +`func (o *NonEmployeeSourceRequestBody) GetAccountManagersOk() (*[]NonEmployeeIdnUserRequest, bool)` + +GetAccountManagersOk returns a tuple with the AccountManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountManagers + +`func (o *NonEmployeeSourceRequestBody) SetAccountManagers(v []NonEmployeeIdnUserRequest)` + +SetAccountManagers sets AccountManagers field to given value. + +### HasAccountManagers + +`func (o *NonEmployeeSourceRequestBody) HasAccountManagers() bool` + +HasAccountManagers returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSourceWithCloudExternalId.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSourceWithCloudExternalId.md new file mode 100644 index 000000000..375fed78d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSourceWithCloudExternalId.md @@ -0,0 +1,272 @@ +--- +id: non-employee-source-with-cloud-external-id +title: NonEmployeeSourceWithCloudExternalId +pagination_label: NonEmployeeSourceWithCloudExternalId +sidebar_label: NonEmployeeSourceWithCloudExternalId +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceWithCloudExternalId', 'NonEmployeeSourceWithCloudExternalId'] +slug: /tools/sdk/go/v3/models/non-employee-source-with-cloud-external-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithCloudExternalId', 'NonEmployeeSourceWithCloudExternalId'] +--- + +# NonEmployeeSourceWithCloudExternalId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**CloudExternalId** | Pointer to **string** | Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. | [optional] + +## Methods + +### NewNonEmployeeSourceWithCloudExternalId + +`func NewNonEmployeeSourceWithCloudExternalId() *NonEmployeeSourceWithCloudExternalId` + +NewNonEmployeeSourceWithCloudExternalId instantiates a new NonEmployeeSourceWithCloudExternalId 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 + +### NewNonEmployeeSourceWithCloudExternalIdWithDefaults + +`func NewNonEmployeeSourceWithCloudExternalIdWithDefaults() *NonEmployeeSourceWithCloudExternalId` + +NewNonEmployeeSourceWithCloudExternalIdWithDefaults instantiates a new NonEmployeeSourceWithCloudExternalId 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 + +### GetId + +`func (o *NonEmployeeSourceWithCloudExternalId) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSourceWithCloudExternalId) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSourceWithCloudExternalId) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSourceWithCloudExternalId) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSourceWithCloudExternalId) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSourceWithCloudExternalId) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSourceWithCloudExternalId) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceWithCloudExternalId) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSourceWithCloudExternalId) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSourceWithCloudExternalId) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceWithCloudExternalId) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSourceWithCloudExternalId) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetApprovers + +`func (o *NonEmployeeSourceWithCloudExternalId) GetApprovers() []NonEmployeeIdentityReferenceWithId` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetApproversOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *NonEmployeeSourceWithCloudExternalId) SetApprovers(v []NonEmployeeIdentityReferenceWithId)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *NonEmployeeSourceWithCloudExternalId) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetAccountManagers + +`func (o *NonEmployeeSourceWithCloudExternalId) GetAccountManagers() []NonEmployeeIdentityReferenceWithId` + +GetAccountManagers returns the AccountManagers field if non-nil, zero value otherwise. + +### GetAccountManagersOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetAccountManagersOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetAccountManagersOk returns a tuple with the AccountManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountManagers + +`func (o *NonEmployeeSourceWithCloudExternalId) SetAccountManagers(v []NonEmployeeIdentityReferenceWithId)` + +SetAccountManagers sets AccountManagers field to given value. + +### HasAccountManagers + +`func (o *NonEmployeeSourceWithCloudExternalId) HasAccountManagers() bool` + +HasAccountManagers returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeSourceWithCloudExternalId) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeSourceWithCloudExternalId) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeSourceWithCloudExternalId) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeSourceWithCloudExternalId) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeSourceWithCloudExternalId) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeSourceWithCloudExternalId) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetCloudExternalId + +`func (o *NonEmployeeSourceWithCloudExternalId) GetCloudExternalId() string` + +GetCloudExternalId returns the CloudExternalId field if non-nil, zero value otherwise. + +### GetCloudExternalIdOk + +`func (o *NonEmployeeSourceWithCloudExternalId) GetCloudExternalIdOk() (*string, bool)` + +GetCloudExternalIdOk returns a tuple with the CloudExternalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudExternalId + +`func (o *NonEmployeeSourceWithCloudExternalId) SetCloudExternalId(v string)` + +SetCloudExternalId sets CloudExternalId field to given value. + +### HasCloudExternalId + +`func (o *NonEmployeeSourceWithCloudExternalId) HasCloudExternalId() bool` + +HasCloudExternalId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSourceWithNECount.md new file mode 100644 index 000000000..c411a1b40 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/NonEmployeeSourceWithNECount.md @@ -0,0 +1,282 @@ +--- +id: non-employee-source-with-ne-count +title: NonEmployeeSourceWithNECount +pagination_label: NonEmployeeSourceWithNECount +sidebar_label: NonEmployeeSourceWithNECount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'NonEmployeeSourceWithNECount', 'NonEmployeeSourceWithNECount'] +slug: /tools/sdk/go/v3/models/non-employee-source-with-ne-count +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithNECount', 'NonEmployeeSourceWithNECount'] +--- + +# NonEmployeeSourceWithNECount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **string** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **string** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **string** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **SailPointTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**NonEmployeeCount** | Pointer to **NullableInt32** | Number of non-employee records associated with this source. This value is 'NULL' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional] + +## Methods + +### NewNonEmployeeSourceWithNECount + +`func NewNonEmployeeSourceWithNECount() *NonEmployeeSourceWithNECount` + +NewNonEmployeeSourceWithNECount instantiates a new NonEmployeeSourceWithNECount 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 + +### NewNonEmployeeSourceWithNECountWithDefaults + +`func NewNonEmployeeSourceWithNECountWithDefaults() *NonEmployeeSourceWithNECount` + +NewNonEmployeeSourceWithNECountWithDefaults instantiates a new NonEmployeeSourceWithNECount 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 + +### GetId + +`func (o *NonEmployeeSourceWithNECount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NonEmployeeSourceWithNECount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NonEmployeeSourceWithNECount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NonEmployeeSourceWithNECount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *NonEmployeeSourceWithNECount) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *NonEmployeeSourceWithNECount) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *NonEmployeeSourceWithNECount) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *NonEmployeeSourceWithNECount) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetName + +`func (o *NonEmployeeSourceWithNECount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NonEmployeeSourceWithNECount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NonEmployeeSourceWithNECount) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NonEmployeeSourceWithNECount) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *NonEmployeeSourceWithNECount) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NonEmployeeSourceWithNECount) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *NonEmployeeSourceWithNECount) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *NonEmployeeSourceWithNECount) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetApprovers + +`func (o *NonEmployeeSourceWithNECount) GetApprovers() []NonEmployeeIdentityReferenceWithId` + +GetApprovers returns the Approvers field if non-nil, zero value otherwise. + +### GetApproversOk + +`func (o *NonEmployeeSourceWithNECount) GetApproversOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetApproversOk returns a tuple with the Approvers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovers + +`func (o *NonEmployeeSourceWithNECount) SetApprovers(v []NonEmployeeIdentityReferenceWithId)` + +SetApprovers sets Approvers field to given value. + +### HasApprovers + +`func (o *NonEmployeeSourceWithNECount) HasApprovers() bool` + +HasApprovers returns a boolean if a field has been set. + +### GetAccountManagers + +`func (o *NonEmployeeSourceWithNECount) GetAccountManagers() []NonEmployeeIdentityReferenceWithId` + +GetAccountManagers returns the AccountManagers field if non-nil, zero value otherwise. + +### GetAccountManagersOk + +`func (o *NonEmployeeSourceWithNECount) GetAccountManagersOk() (*[]NonEmployeeIdentityReferenceWithId, bool)` + +GetAccountManagersOk returns a tuple with the AccountManagers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountManagers + +`func (o *NonEmployeeSourceWithNECount) SetAccountManagers(v []NonEmployeeIdentityReferenceWithId)` + +SetAccountManagers sets AccountManagers field to given value. + +### HasAccountManagers + +`func (o *NonEmployeeSourceWithNECount) HasAccountManagers() bool` + +HasAccountManagers returns a boolean if a field has been set. + +### GetModified + +`func (o *NonEmployeeSourceWithNECount) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NonEmployeeSourceWithNECount) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *NonEmployeeSourceWithNECount) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *NonEmployeeSourceWithNECount) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCreated + +`func (o *NonEmployeeSourceWithNECount) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *NonEmployeeSourceWithNECount) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *NonEmployeeSourceWithNECount) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *NonEmployeeSourceWithNECount) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetNonEmployeeCount + +`func (o *NonEmployeeSourceWithNECount) GetNonEmployeeCount() int32` + +GetNonEmployeeCount returns the NonEmployeeCount field if non-nil, zero value otherwise. + +### GetNonEmployeeCountOk + +`func (o *NonEmployeeSourceWithNECount) GetNonEmployeeCountOk() (*int32, bool)` + +GetNonEmployeeCountOk returns a tuple with the NonEmployeeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNonEmployeeCount + +`func (o *NonEmployeeSourceWithNECount) SetNonEmployeeCount(v int32)` + +SetNonEmployeeCount sets NonEmployeeCount field to given value. + +### HasNonEmployeeCount + +`func (o *NonEmployeeSourceWithNECount) HasNonEmployeeCount() bool` + +HasNonEmployeeCount returns a boolean if a field has been set. + +### SetNonEmployeeCountNil + +`func (o *NonEmployeeSourceWithNECount) SetNonEmployeeCountNil(b bool)` + + SetNonEmployeeCountNil sets the value for NonEmployeeCount to be an explicit nil + +### UnsetNonEmployeeCount +`func (o *NonEmployeeSourceWithNECount) UnsetNonEmployeeCount()` + +UnsetNonEmployeeCount ensures that no value is present for NonEmployeeCount, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ObjectExportImportNames.md b/docs/tools/sdk/go/Reference/V3/Models/ObjectExportImportNames.md new file mode 100644 index 000000000..d7973d2f3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ObjectExportImportNames.md @@ -0,0 +1,64 @@ +--- +id: object-export-import-names +title: ObjectExportImportNames +pagination_label: ObjectExportImportNames +sidebar_label: ObjectExportImportNames +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectExportImportNames', 'ObjectExportImportNames'] +slug: /tools/sdk/go/v3/models/object-export-import-names +tags: ['SDK', 'Software Development Kit', 'ObjectExportImportNames', 'ObjectExportImportNames'] +--- + +# ObjectExportImportNames + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludedNames** | Pointer to **[]string** | Object names to be included in a backup. | [optional] + +## Methods + +### NewObjectExportImportNames + +`func NewObjectExportImportNames() *ObjectExportImportNames` + +NewObjectExportImportNames instantiates a new ObjectExportImportNames 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 + +### NewObjectExportImportNamesWithDefaults + +`func NewObjectExportImportNamesWithDefaults() *ObjectExportImportNames` + +NewObjectExportImportNamesWithDefaults instantiates a new ObjectExportImportNames 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 + +### GetIncludedNames + +`func (o *ObjectExportImportNames) GetIncludedNames() []string` + +GetIncludedNames returns the IncludedNames field if non-nil, zero value otherwise. + +### GetIncludedNamesOk + +`func (o *ObjectExportImportNames) GetIncludedNamesOk() (*[]string, bool)` + +GetIncludedNamesOk returns a tuple with the IncludedNames field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludedNames + +`func (o *ObjectExportImportNames) SetIncludedNames(v []string)` + +SetIncludedNames sets IncludedNames field to given value. + +### HasIncludedNames + +`func (o *ObjectExportImportNames) HasIncludedNames() bool` + +HasIncludedNames returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ObjectImportResult.md b/docs/tools/sdk/go/Reference/V3/Models/ObjectImportResult.md new file mode 100644 index 000000000..8d621d559 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ObjectImportResult.md @@ -0,0 +1,122 @@ +--- +id: object-import-result +title: ObjectImportResult +pagination_label: ObjectImportResult +sidebar_label: ObjectImportResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectImportResult', 'ObjectImportResult'] +slug: /tools/sdk/go/v3/models/object-import-result +tags: ['SDK', 'Software Development Kit', 'ObjectImportResult', 'ObjectImportResult'] +--- + +# ObjectImportResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Infos** | [**[]SpConfigMessage**](sp-config-message) | Informational messages returned from the target service on import. | +**Warnings** | [**[]SpConfigMessage**](sp-config-message) | Warning messages returned from the target service on import. | +**Errors** | [**[]SpConfigMessage**](sp-config-message) | Error messages returned from the target service on import. | +**ImportedObjects** | [**[]ImportObject**](import-object) | References to objects that were created or updated by the import. | + +## Methods + +### NewObjectImportResult + +`func NewObjectImportResult(infos []SpConfigMessage, warnings []SpConfigMessage, errors []SpConfigMessage, importedObjects []ImportObject, ) *ObjectImportResult` + +NewObjectImportResult instantiates a new ObjectImportResult 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 + +### NewObjectImportResultWithDefaults + +`func NewObjectImportResultWithDefaults() *ObjectImportResult` + +NewObjectImportResultWithDefaults instantiates a new ObjectImportResult 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 + +### GetInfos + +`func (o *ObjectImportResult) GetInfos() []SpConfigMessage` + +GetInfos returns the Infos field if non-nil, zero value otherwise. + +### GetInfosOk + +`func (o *ObjectImportResult) GetInfosOk() (*[]SpConfigMessage, bool)` + +GetInfosOk returns a tuple with the Infos field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInfos + +`func (o *ObjectImportResult) SetInfos(v []SpConfigMessage)` + +SetInfos sets Infos field to given value. + + +### GetWarnings + +`func (o *ObjectImportResult) GetWarnings() []SpConfigMessage` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *ObjectImportResult) GetWarningsOk() (*[]SpConfigMessage, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *ObjectImportResult) SetWarnings(v []SpConfigMessage)` + +SetWarnings sets Warnings field to given value. + + +### GetErrors + +`func (o *ObjectImportResult) GetErrors() []SpConfigMessage` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *ObjectImportResult) GetErrorsOk() (*[]SpConfigMessage, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *ObjectImportResult) SetErrors(v []SpConfigMessage)` + +SetErrors sets Errors field to given value. + + +### GetImportedObjects + +`func (o *ObjectImportResult) GetImportedObjects() []ImportObject` + +GetImportedObjects returns the ImportedObjects field if non-nil, zero value otherwise. + +### GetImportedObjectsOk + +`func (o *ObjectImportResult) GetImportedObjectsOk() (*[]ImportObject, bool)` + +GetImportedObjectsOk returns a tuple with the ImportedObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImportedObjects + +`func (o *ObjectImportResult) SetImportedObjects(v []ImportObject)` + +SetImportedObjects sets ImportedObjects field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingBulkCreateRequest.md b/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingBulkCreateRequest.md new file mode 100644 index 000000000..bb0999079 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingBulkCreateRequest.md @@ -0,0 +1,59 @@ +--- +id: object-mapping-bulk-create-request +title: ObjectMappingBulkCreateRequest +pagination_label: ObjectMappingBulkCreateRequest +sidebar_label: ObjectMappingBulkCreateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingBulkCreateRequest', 'ObjectMappingBulkCreateRequest'] +slug: /tools/sdk/go/v3/models/object-mapping-bulk-create-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkCreateRequest', 'ObjectMappingBulkCreateRequest'] +--- + +# ObjectMappingBulkCreateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewObjectsMappings** | [**[]ObjectMappingRequest**](object-mapping-request) | | + +## Methods + +### NewObjectMappingBulkCreateRequest + +`func NewObjectMappingBulkCreateRequest(newObjectsMappings []ObjectMappingRequest, ) *ObjectMappingBulkCreateRequest` + +NewObjectMappingBulkCreateRequest instantiates a new ObjectMappingBulkCreateRequest 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 + +### NewObjectMappingBulkCreateRequestWithDefaults + +`func NewObjectMappingBulkCreateRequestWithDefaults() *ObjectMappingBulkCreateRequest` + +NewObjectMappingBulkCreateRequestWithDefaults instantiates a new ObjectMappingBulkCreateRequest 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 + +### GetNewObjectsMappings + +`func (o *ObjectMappingBulkCreateRequest) GetNewObjectsMappings() []ObjectMappingRequest` + +GetNewObjectsMappings returns the NewObjectsMappings field if non-nil, zero value otherwise. + +### GetNewObjectsMappingsOk + +`func (o *ObjectMappingBulkCreateRequest) GetNewObjectsMappingsOk() (*[]ObjectMappingRequest, bool)` + +GetNewObjectsMappingsOk returns a tuple with the NewObjectsMappings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewObjectsMappings + +`func (o *ObjectMappingBulkCreateRequest) SetNewObjectsMappings(v []ObjectMappingRequest)` + +SetNewObjectsMappings sets NewObjectsMappings field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingBulkCreateResponse.md b/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingBulkCreateResponse.md new file mode 100644 index 000000000..425e716d9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingBulkCreateResponse.md @@ -0,0 +1,64 @@ +--- +id: object-mapping-bulk-create-response +title: ObjectMappingBulkCreateResponse +pagination_label: ObjectMappingBulkCreateResponse +sidebar_label: ObjectMappingBulkCreateResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingBulkCreateResponse', 'ObjectMappingBulkCreateResponse'] +slug: /tools/sdk/go/v3/models/object-mapping-bulk-create-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkCreateResponse', 'ObjectMappingBulkCreateResponse'] +--- + +# ObjectMappingBulkCreateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddedObjects** | Pointer to [**[]ObjectMappingResponse**](object-mapping-response) | | [optional] + +## Methods + +### NewObjectMappingBulkCreateResponse + +`func NewObjectMappingBulkCreateResponse() *ObjectMappingBulkCreateResponse` + +NewObjectMappingBulkCreateResponse instantiates a new ObjectMappingBulkCreateResponse 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 + +### NewObjectMappingBulkCreateResponseWithDefaults + +`func NewObjectMappingBulkCreateResponseWithDefaults() *ObjectMappingBulkCreateResponse` + +NewObjectMappingBulkCreateResponseWithDefaults instantiates a new ObjectMappingBulkCreateResponse 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 + +### GetAddedObjects + +`func (o *ObjectMappingBulkCreateResponse) GetAddedObjects() []ObjectMappingResponse` + +GetAddedObjects returns the AddedObjects field if non-nil, zero value otherwise. + +### GetAddedObjectsOk + +`func (o *ObjectMappingBulkCreateResponse) GetAddedObjectsOk() (*[]ObjectMappingResponse, bool)` + +GetAddedObjectsOk returns a tuple with the AddedObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAddedObjects + +`func (o *ObjectMappingBulkCreateResponse) SetAddedObjects(v []ObjectMappingResponse)` + +SetAddedObjects sets AddedObjects field to given value. + +### HasAddedObjects + +`func (o *ObjectMappingBulkCreateResponse) HasAddedObjects() bool` + +HasAddedObjects returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingBulkPatchRequest.md b/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingBulkPatchRequest.md new file mode 100644 index 000000000..9979f2901 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingBulkPatchRequest.md @@ -0,0 +1,59 @@ +--- +id: object-mapping-bulk-patch-request +title: ObjectMappingBulkPatchRequest +pagination_label: ObjectMappingBulkPatchRequest +sidebar_label: ObjectMappingBulkPatchRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingBulkPatchRequest', 'ObjectMappingBulkPatchRequest'] +slug: /tools/sdk/go/v3/models/object-mapping-bulk-patch-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchRequest', 'ObjectMappingBulkPatchRequest'] +--- + +# ObjectMappingBulkPatchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Patches** | [**map[string][]JsonPatchOperation**](https://go.dev/tour/moretypes/6) | Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. | + +## Methods + +### NewObjectMappingBulkPatchRequest + +`func NewObjectMappingBulkPatchRequest(patches map[string][]JsonPatchOperation, ) *ObjectMappingBulkPatchRequest` + +NewObjectMappingBulkPatchRequest instantiates a new ObjectMappingBulkPatchRequest 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 + +### NewObjectMappingBulkPatchRequestWithDefaults + +`func NewObjectMappingBulkPatchRequestWithDefaults() *ObjectMappingBulkPatchRequest` + +NewObjectMappingBulkPatchRequestWithDefaults instantiates a new ObjectMappingBulkPatchRequest 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 + +### GetPatches + +`func (o *ObjectMappingBulkPatchRequest) GetPatches() map[string][]JsonPatchOperation` + +GetPatches returns the Patches field if non-nil, zero value otherwise. + +### GetPatchesOk + +`func (o *ObjectMappingBulkPatchRequest) GetPatchesOk() (*map[string][]JsonPatchOperation, bool)` + +GetPatchesOk returns a tuple with the Patches field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPatches + +`func (o *ObjectMappingBulkPatchRequest) SetPatches(v map[string][]JsonPatchOperation)` + +SetPatches sets Patches field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingBulkPatchResponse.md b/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingBulkPatchResponse.md new file mode 100644 index 000000000..7114597eb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingBulkPatchResponse.md @@ -0,0 +1,64 @@ +--- +id: object-mapping-bulk-patch-response +title: ObjectMappingBulkPatchResponse +pagination_label: ObjectMappingBulkPatchResponse +sidebar_label: ObjectMappingBulkPatchResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingBulkPatchResponse', 'ObjectMappingBulkPatchResponse'] +slug: /tools/sdk/go/v3/models/object-mapping-bulk-patch-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchResponse', 'ObjectMappingBulkPatchResponse'] +--- + +# ObjectMappingBulkPatchResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PatchedObjects** | Pointer to [**[]ObjectMappingResponse**](object-mapping-response) | | [optional] + +## Methods + +### NewObjectMappingBulkPatchResponse + +`func NewObjectMappingBulkPatchResponse() *ObjectMappingBulkPatchResponse` + +NewObjectMappingBulkPatchResponse instantiates a new ObjectMappingBulkPatchResponse 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 + +### NewObjectMappingBulkPatchResponseWithDefaults + +`func NewObjectMappingBulkPatchResponseWithDefaults() *ObjectMappingBulkPatchResponse` + +NewObjectMappingBulkPatchResponseWithDefaults instantiates a new ObjectMappingBulkPatchResponse 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 + +### GetPatchedObjects + +`func (o *ObjectMappingBulkPatchResponse) GetPatchedObjects() []ObjectMappingResponse` + +GetPatchedObjects returns the PatchedObjects field if non-nil, zero value otherwise. + +### GetPatchedObjectsOk + +`func (o *ObjectMappingBulkPatchResponse) GetPatchedObjectsOk() (*[]ObjectMappingResponse, bool)` + +GetPatchedObjectsOk returns a tuple with the PatchedObjects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPatchedObjects + +`func (o *ObjectMappingBulkPatchResponse) SetPatchedObjects(v []ObjectMappingResponse)` + +SetPatchedObjects sets PatchedObjects field to given value. + +### HasPatchedObjects + +`func (o *ObjectMappingBulkPatchResponse) HasPatchedObjects() bool` + +HasPatchedObjects returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingRequest.md b/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingRequest.md new file mode 100644 index 000000000..9b56c7604 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingRequest.md @@ -0,0 +1,148 @@ +--- +id: object-mapping-request +title: ObjectMappingRequest +pagination_label: ObjectMappingRequest +sidebar_label: ObjectMappingRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingRequest', 'ObjectMappingRequest'] +slug: /tools/sdk/go/v3/models/object-mapping-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingRequest', 'ObjectMappingRequest'] +--- + +# ObjectMappingRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectType** | **string** | Type of the object the mapping value applies to, must be one from enum | +**JsonPath** | **string** | JSONPath expression denoting the path within the object where the mapping value should be applied | +**SourceValue** | **string** | Original value at the jsonPath location within the object | +**TargetValue** | **string** | Value to be assigned at the jsonPath location within the object | +**Enabled** | Pointer to **bool** | Whether or not this object mapping is enabled | [optional] [default to false] + +## Methods + +### NewObjectMappingRequest + +`func NewObjectMappingRequest(objectType string, jsonPath string, sourceValue string, targetValue string, ) *ObjectMappingRequest` + +NewObjectMappingRequest instantiates a new ObjectMappingRequest 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 + +### NewObjectMappingRequestWithDefaults + +`func NewObjectMappingRequestWithDefaults() *ObjectMappingRequest` + +NewObjectMappingRequestWithDefaults instantiates a new ObjectMappingRequest 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 + +### GetObjectType + +`func (o *ObjectMappingRequest) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *ObjectMappingRequest) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *ObjectMappingRequest) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + + +### GetJsonPath + +`func (o *ObjectMappingRequest) GetJsonPath() string` + +GetJsonPath returns the JsonPath field if non-nil, zero value otherwise. + +### GetJsonPathOk + +`func (o *ObjectMappingRequest) GetJsonPathOk() (*string, bool)` + +GetJsonPathOk returns a tuple with the JsonPath field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJsonPath + +`func (o *ObjectMappingRequest) SetJsonPath(v string)` + +SetJsonPath sets JsonPath field to given value. + + +### GetSourceValue + +`func (o *ObjectMappingRequest) GetSourceValue() string` + +GetSourceValue returns the SourceValue field if non-nil, zero value otherwise. + +### GetSourceValueOk + +`func (o *ObjectMappingRequest) GetSourceValueOk() (*string, bool)` + +GetSourceValueOk returns a tuple with the SourceValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceValue + +`func (o *ObjectMappingRequest) SetSourceValue(v string)` + +SetSourceValue sets SourceValue field to given value. + + +### GetTargetValue + +`func (o *ObjectMappingRequest) GetTargetValue() string` + +GetTargetValue returns the TargetValue field if non-nil, zero value otherwise. + +### GetTargetValueOk + +`func (o *ObjectMappingRequest) GetTargetValueOk() (*string, bool)` + +GetTargetValueOk returns a tuple with the TargetValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetValue + +`func (o *ObjectMappingRequest) SetTargetValue(v string)` + +SetTargetValue sets TargetValue field to given value. + + +### GetEnabled + +`func (o *ObjectMappingRequest) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ObjectMappingRequest) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ObjectMappingRequest) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ObjectMappingRequest) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingResponse.md b/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingResponse.md new file mode 100644 index 000000000..f36e51542 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ObjectMappingResponse.md @@ -0,0 +1,246 @@ +--- +id: object-mapping-response +title: ObjectMappingResponse +pagination_label: ObjectMappingResponse +sidebar_label: ObjectMappingResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ObjectMappingResponse', 'ObjectMappingResponse'] +slug: /tools/sdk/go/v3/models/object-mapping-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingResponse', 'ObjectMappingResponse'] +--- + +# ObjectMappingResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectMappingId** | Pointer to **string** | Id of the object mapping | [optional] +**ObjectType** | Pointer to **string** | Type of the object the mapping value applies to | [optional] +**JsonPath** | Pointer to **string** | JSONPath expression denoting the path within the object where the mapping value should be applied | [optional] +**SourceValue** | Pointer to **string** | Original value at the jsonPath location within the object | [optional] +**TargetValue** | Pointer to **string** | Value to be assigned at the jsonPath location within the object | [optional] +**Enabled** | Pointer to **bool** | Whether or not this object mapping is enabled | [optional] [default to false] +**Created** | Pointer to **string** | Object mapping creation timestamp | [optional] +**Modified** | Pointer to **string** | Object mapping latest update timestamp | [optional] + +## Methods + +### NewObjectMappingResponse + +`func NewObjectMappingResponse() *ObjectMappingResponse` + +NewObjectMappingResponse instantiates a new ObjectMappingResponse 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 + +### NewObjectMappingResponseWithDefaults + +`func NewObjectMappingResponseWithDefaults() *ObjectMappingResponse` + +NewObjectMappingResponseWithDefaults instantiates a new ObjectMappingResponse 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 + +### GetObjectMappingId + +`func (o *ObjectMappingResponse) GetObjectMappingId() string` + +GetObjectMappingId returns the ObjectMappingId field if non-nil, zero value otherwise. + +### GetObjectMappingIdOk + +`func (o *ObjectMappingResponse) GetObjectMappingIdOk() (*string, bool)` + +GetObjectMappingIdOk returns a tuple with the ObjectMappingId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectMappingId + +`func (o *ObjectMappingResponse) SetObjectMappingId(v string)` + +SetObjectMappingId sets ObjectMappingId field to given value. + +### HasObjectMappingId + +`func (o *ObjectMappingResponse) HasObjectMappingId() bool` + +HasObjectMappingId returns a boolean if a field has been set. + +### GetObjectType + +`func (o *ObjectMappingResponse) GetObjectType() string` + +GetObjectType returns the ObjectType field if non-nil, zero value otherwise. + +### GetObjectTypeOk + +`func (o *ObjectMappingResponse) GetObjectTypeOk() (*string, bool)` + +GetObjectTypeOk returns a tuple with the ObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectType + +`func (o *ObjectMappingResponse) SetObjectType(v string)` + +SetObjectType sets ObjectType field to given value. + +### HasObjectType + +`func (o *ObjectMappingResponse) HasObjectType() bool` + +HasObjectType returns a boolean if a field has been set. + +### GetJsonPath + +`func (o *ObjectMappingResponse) GetJsonPath() string` + +GetJsonPath returns the JsonPath field if non-nil, zero value otherwise. + +### GetJsonPathOk + +`func (o *ObjectMappingResponse) GetJsonPathOk() (*string, bool)` + +GetJsonPathOk returns a tuple with the JsonPath field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJsonPath + +`func (o *ObjectMappingResponse) SetJsonPath(v string)` + +SetJsonPath sets JsonPath field to given value. + +### HasJsonPath + +`func (o *ObjectMappingResponse) HasJsonPath() bool` + +HasJsonPath returns a boolean if a field has been set. + +### GetSourceValue + +`func (o *ObjectMappingResponse) GetSourceValue() string` + +GetSourceValue returns the SourceValue field if non-nil, zero value otherwise. + +### GetSourceValueOk + +`func (o *ObjectMappingResponse) GetSourceValueOk() (*string, bool)` + +GetSourceValueOk returns a tuple with the SourceValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceValue + +`func (o *ObjectMappingResponse) SetSourceValue(v string)` + +SetSourceValue sets SourceValue field to given value. + +### HasSourceValue + +`func (o *ObjectMappingResponse) HasSourceValue() bool` + +HasSourceValue returns a boolean if a field has been set. + +### GetTargetValue + +`func (o *ObjectMappingResponse) GetTargetValue() string` + +GetTargetValue returns the TargetValue field if non-nil, zero value otherwise. + +### GetTargetValueOk + +`func (o *ObjectMappingResponse) GetTargetValueOk() (*string, bool)` + +GetTargetValueOk returns a tuple with the TargetValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetValue + +`func (o *ObjectMappingResponse) SetTargetValue(v string)` + +SetTargetValue sets TargetValue field to given value. + +### HasTargetValue + +`func (o *ObjectMappingResponse) HasTargetValue() bool` + +HasTargetValue returns a boolean if a field has been set. + +### GetEnabled + +`func (o *ObjectMappingResponse) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ObjectMappingResponse) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ObjectMappingResponse) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ObjectMappingResponse) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetCreated + +`func (o *ObjectMappingResponse) GetCreated() string` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ObjectMappingResponse) GetCreatedOk() (*string, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ObjectMappingResponse) SetCreated(v string)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ObjectMappingResponse) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *ObjectMappingResponse) GetModified() string` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ObjectMappingResponse) GetModifiedOk() (*string, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ObjectMappingResponse) SetModified(v string)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ObjectMappingResponse) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/OktaVerificationRequest.md b/docs/tools/sdk/go/Reference/V3/Models/OktaVerificationRequest.md new file mode 100644 index 000000000..4a7f7db7d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/OktaVerificationRequest.md @@ -0,0 +1,59 @@ +--- +id: okta-verification-request +title: OktaVerificationRequest +pagination_label: OktaVerificationRequest +sidebar_label: OktaVerificationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OktaVerificationRequest', 'OktaVerificationRequest'] +slug: /tools/sdk/go/v3/models/okta-verification-request +tags: ['SDK', 'Software Development Kit', 'OktaVerificationRequest', 'OktaVerificationRequest'] +--- + +# OktaVerificationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **string** | User identifier for Verification request. The value of the user's attribute. | + +## Methods + +### NewOktaVerificationRequest + +`func NewOktaVerificationRequest(userId string, ) *OktaVerificationRequest` + +NewOktaVerificationRequest instantiates a new OktaVerificationRequest 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 + +### NewOktaVerificationRequestWithDefaults + +`func NewOktaVerificationRequestWithDefaults() *OktaVerificationRequest` + +NewOktaVerificationRequestWithDefaults instantiates a new OktaVerificationRequest 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 + +### GetUserId + +`func (o *OktaVerificationRequest) GetUserId() string` + +GetUserId returns the UserId field if non-nil, zero value otherwise. + +### GetUserIdOk + +`func (o *OktaVerificationRequest) GetUserIdOk() (*string, bool)` + +GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserId + +`func (o *OktaVerificationRequest) SetUserId(v string)` + +SetUserId sets UserId field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Operation.md b/docs/tools/sdk/go/Reference/V3/Models/Operation.md new file mode 100644 index 000000000..81dfe3781 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Operation.md @@ -0,0 +1,31 @@ +--- +id: operation +title: Operation +pagination_label: Operation +sidebar_label: Operation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Operation', 'Operation'] +slug: /tools/sdk/go/v3/models/operation +tags: ['SDK', 'Software Development Kit', 'Operation', 'Operation'] +--- + +# Operation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `STARTS_WITH` (value: `"STARTS_WITH"`) + +* `ENDS_WITH` (value: `"ENDS_WITH"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/OriginalRequest.md b/docs/tools/sdk/go/Reference/V3/Models/OriginalRequest.md new file mode 100644 index 000000000..4ace0dc00 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/OriginalRequest.md @@ -0,0 +1,168 @@ +--- +id: original-request +title: OriginalRequest +pagination_label: OriginalRequest +sidebar_label: OriginalRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OriginalRequest', 'OriginalRequest'] +slug: /tools/sdk/go/v3/models/original-request +tags: ['SDK', 'Software Development Kit', 'OriginalRequest', 'OriginalRequest'] +--- + +# OriginalRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **string** | Account ID. | [optional] +**Result** | Pointer to [**Result**](result) | | [optional] +**AttributeRequests** | Pointer to [**[]AttributeRequest**](attribute-request) | Attribute changes requested for account. | [optional] +**Op** | Pointer to **string** | Operation used. | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] + +## Methods + +### NewOriginalRequest + +`func NewOriginalRequest() *OriginalRequest` + +NewOriginalRequest instantiates a new OriginalRequest 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 + +### NewOriginalRequestWithDefaults + +`func NewOriginalRequestWithDefaults() *OriginalRequest` + +NewOriginalRequestWithDefaults instantiates a new OriginalRequest 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 + +### GetAccountId + +`func (o *OriginalRequest) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *OriginalRequest) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *OriginalRequest) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *OriginalRequest) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetResult + +`func (o *OriginalRequest) GetResult() Result` + +GetResult returns the Result field if non-nil, zero value otherwise. + +### GetResultOk + +`func (o *OriginalRequest) GetResultOk() (*Result, bool)` + +GetResultOk returns a tuple with the Result field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResult + +`func (o *OriginalRequest) SetResult(v Result)` + +SetResult sets Result field to given value. + +### HasResult + +`func (o *OriginalRequest) HasResult() bool` + +HasResult returns a boolean if a field has been set. + +### GetAttributeRequests + +`func (o *OriginalRequest) GetAttributeRequests() []AttributeRequest` + +GetAttributeRequests returns the AttributeRequests field if non-nil, zero value otherwise. + +### GetAttributeRequestsOk + +`func (o *OriginalRequest) GetAttributeRequestsOk() (*[]AttributeRequest, bool)` + +GetAttributeRequestsOk returns a tuple with the AttributeRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeRequests + +`func (o *OriginalRequest) SetAttributeRequests(v []AttributeRequest)` + +SetAttributeRequests sets AttributeRequests field to given value. + +### HasAttributeRequests + +`func (o *OriginalRequest) HasAttributeRequests() bool` + +HasAttributeRequests returns a boolean if a field has been set. + +### GetOp + +`func (o *OriginalRequest) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *OriginalRequest) GetOpOk() (*string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOp + +`func (o *OriginalRequest) SetOp(v string)` + +SetOp sets Op field to given value. + +### HasOp + +`func (o *OriginalRequest) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### GetSource + +`func (o *OriginalRequest) GetSource() AccountSource` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *OriginalRequest) GetSourceOk() (*AccountSource, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *OriginalRequest) SetSource(v AccountSource)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *OriginalRequest) HasSource() bool` + +HasSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/OrphanIdentitiesReportArguments.md b/docs/tools/sdk/go/Reference/V3/Models/OrphanIdentitiesReportArguments.md new file mode 100644 index 000000000..aee062336 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/OrphanIdentitiesReportArguments.md @@ -0,0 +1,64 @@ +--- +id: orphan-identities-report-arguments +title: OrphanIdentitiesReportArguments +pagination_label: OrphanIdentitiesReportArguments +sidebar_label: OrphanIdentitiesReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OrphanIdentitiesReportArguments', 'OrphanIdentitiesReportArguments'] +slug: /tools/sdk/go/v3/models/orphan-identities-report-arguments +tags: ['SDK', 'Software Development Kit', 'OrphanIdentitiesReportArguments', 'OrphanIdentitiesReportArguments'] +--- + +# OrphanIdentitiesReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SelectedFormats** | Pointer to **[]string** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] + +## Methods + +### NewOrphanIdentitiesReportArguments + +`func NewOrphanIdentitiesReportArguments() *OrphanIdentitiesReportArguments` + +NewOrphanIdentitiesReportArguments instantiates a new OrphanIdentitiesReportArguments 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 + +### NewOrphanIdentitiesReportArgumentsWithDefaults + +`func NewOrphanIdentitiesReportArgumentsWithDefaults() *OrphanIdentitiesReportArguments` + +NewOrphanIdentitiesReportArgumentsWithDefaults instantiates a new OrphanIdentitiesReportArguments 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 + +### GetSelectedFormats + +`func (o *OrphanIdentitiesReportArguments) GetSelectedFormats() []string` + +GetSelectedFormats returns the SelectedFormats field if non-nil, zero value otherwise. + +### GetSelectedFormatsOk + +`func (o *OrphanIdentitiesReportArguments) GetSelectedFormatsOk() (*[]string, bool)` + +GetSelectedFormatsOk returns a tuple with the SelectedFormats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectedFormats + +`func (o *OrphanIdentitiesReportArguments) SetSelectedFormats(v []string)` + +SetSelectedFormats sets SelectedFormats field to given value. + +### HasSelectedFormats + +`func (o *OrphanIdentitiesReportArguments) HasSelectedFormats() bool` + +HasSelectedFormats returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/OwnerDto.md b/docs/tools/sdk/go/Reference/V3/Models/OwnerDto.md new file mode 100644 index 000000000..789a203b5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/OwnerDto.md @@ -0,0 +1,116 @@ +--- +id: owner-dto +title: OwnerDto +pagination_label: OwnerDto +sidebar_label: OwnerDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OwnerDto', 'OwnerDto'] +slug: /tools/sdk/go/v3/models/owner-dto +tags: ['SDK', 'Software Development Kit', 'OwnerDto', 'OwnerDto'] +--- + +# OwnerDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner's DTO type. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] + +## Methods + +### NewOwnerDto + +`func NewOwnerDto() *OwnerDto` + +NewOwnerDto instantiates a new OwnerDto 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 + +### NewOwnerDtoWithDefaults + +`func NewOwnerDtoWithDefaults() *OwnerDto` + +NewOwnerDtoWithDefaults instantiates a new OwnerDto 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 + +### GetType + +`func (o *OwnerDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OwnerDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OwnerDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OwnerDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *OwnerDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OwnerDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OwnerDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OwnerDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OwnerDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OwnerDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OwnerDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OwnerDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/OwnerReference.md b/docs/tools/sdk/go/Reference/V3/Models/OwnerReference.md new file mode 100644 index 000000000..1b2d7c341 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/OwnerReference.md @@ -0,0 +1,116 @@ +--- +id: owner-reference +title: OwnerReference +pagination_label: OwnerReference +sidebar_label: OwnerReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OwnerReference', 'OwnerReference'] +slug: /tools/sdk/go/v3/models/owner-reference +tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'OwnerReference'] +--- + +# OwnerReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**Id** | Pointer to **string** | Owner's identity ID. | [optional] +**Name** | Pointer to **string** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] + +## Methods + +### NewOwnerReference + +`func NewOwnerReference() *OwnerReference` + +NewOwnerReference instantiates a new OwnerReference 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 + +### NewOwnerReferenceWithDefaults + +`func NewOwnerReferenceWithDefaults() *OwnerReference` + +NewOwnerReferenceWithDefaults instantiates a new OwnerReference 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 + +### GetType + +`func (o *OwnerReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OwnerReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OwnerReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OwnerReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *OwnerReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OwnerReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OwnerReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OwnerReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OwnerReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OwnerReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OwnerReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OwnerReference) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/OwnerReferenceSegments.md b/docs/tools/sdk/go/Reference/V3/Models/OwnerReferenceSegments.md new file mode 100644 index 000000000..793577c2d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/OwnerReferenceSegments.md @@ -0,0 +1,116 @@ +--- +id: owner-reference-segments +title: OwnerReferenceSegments +pagination_label: OwnerReferenceSegments +sidebar_label: OwnerReferenceSegments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'OwnerReferenceSegments', 'OwnerReferenceSegments'] +slug: /tools/sdk/go/v3/models/owner-reference-segments +tags: ['SDK', 'Software Development Kit', 'OwnerReferenceSegments', 'OwnerReferenceSegments'] +--- + +# OwnerReferenceSegments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**Id** | Pointer to **string** | Identity id | [optional] +**Name** | Pointer to **string** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] + +## Methods + +### NewOwnerReferenceSegments + +`func NewOwnerReferenceSegments() *OwnerReferenceSegments` + +NewOwnerReferenceSegments instantiates a new OwnerReferenceSegments 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 + +### NewOwnerReferenceSegmentsWithDefaults + +`func NewOwnerReferenceSegmentsWithDefaults() *OwnerReferenceSegments` + +NewOwnerReferenceSegmentsWithDefaults instantiates a new OwnerReferenceSegments 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 + +### GetType + +`func (o *OwnerReferenceSegments) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OwnerReferenceSegments) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *OwnerReferenceSegments) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *OwnerReferenceSegments) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *OwnerReferenceSegments) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OwnerReferenceSegments) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OwnerReferenceSegments) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OwnerReferenceSegments) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OwnerReferenceSegments) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OwnerReferenceSegments) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OwnerReferenceSegments) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OwnerReferenceSegments) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Owns.md b/docs/tools/sdk/go/Reference/V3/Models/Owns.md new file mode 100644 index 000000000..b65466476 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Owns.md @@ -0,0 +1,220 @@ +--- +id: owns +title: Owns +pagination_label: Owns +sidebar_label: Owns +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Owns', 'Owns'] +slug: /tools/sdk/go/v3/models/owns +tags: ['SDK', 'Software Development Kit', 'Owns', 'Owns'] +--- + +# Owns + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Sources** | Pointer to [**[]Reference**](reference) | | [optional] +**Entitlements** | Pointer to [**[]Reference**](reference) | | [optional] +**AccessProfiles** | Pointer to [**[]Reference**](reference) | | [optional] +**Roles** | Pointer to [**[]Reference**](reference) | | [optional] +**Apps** | Pointer to [**[]Reference**](reference) | | [optional] +**GovernanceGroups** | Pointer to [**[]Reference**](reference) | | [optional] +**FallbackApprover** | Pointer to **bool** | | [optional] + +## Methods + +### NewOwns + +`func NewOwns() *Owns` + +NewOwns instantiates a new Owns 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 + +### NewOwnsWithDefaults + +`func NewOwnsWithDefaults() *Owns` + +NewOwnsWithDefaults instantiates a new Owns 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 + +### GetSources + +`func (o *Owns) GetSources() []Reference` + +GetSources returns the Sources field if non-nil, zero value otherwise. + +### GetSourcesOk + +`func (o *Owns) GetSourcesOk() (*[]Reference, bool)` + +GetSourcesOk returns a tuple with the Sources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSources + +`func (o *Owns) SetSources(v []Reference)` + +SetSources sets Sources field to given value. + +### HasSources + +`func (o *Owns) HasSources() bool` + +HasSources returns a boolean if a field has been set. + +### GetEntitlements + +`func (o *Owns) GetEntitlements() []Reference` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *Owns) GetEntitlementsOk() (*[]Reference, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *Owns) SetEntitlements(v []Reference)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *Owns) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetAccessProfiles + +`func (o *Owns) GetAccessProfiles() []Reference` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *Owns) GetAccessProfilesOk() (*[]Reference, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *Owns) SetAccessProfiles(v []Reference)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *Owns) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### GetRoles + +`func (o *Owns) GetRoles() []Reference` + +GetRoles returns the Roles field if non-nil, zero value otherwise. + +### GetRolesOk + +`func (o *Owns) GetRolesOk() (*[]Reference, bool)` + +GetRolesOk returns a tuple with the Roles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoles + +`func (o *Owns) SetRoles(v []Reference)` + +SetRoles sets Roles field to given value. + +### HasRoles + +`func (o *Owns) HasRoles() bool` + +HasRoles returns a boolean if a field has been set. + +### GetApps + +`func (o *Owns) GetApps() []Reference` + +GetApps returns the Apps field if non-nil, zero value otherwise. + +### GetAppsOk + +`func (o *Owns) GetAppsOk() (*[]Reference, bool)` + +GetAppsOk returns a tuple with the Apps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApps + +`func (o *Owns) SetApps(v []Reference)` + +SetApps sets Apps field to given value. + +### HasApps + +`func (o *Owns) HasApps() bool` + +HasApps returns a boolean if a field has been set. + +### GetGovernanceGroups + +`func (o *Owns) GetGovernanceGroups() []Reference` + +GetGovernanceGroups returns the GovernanceGroups field if non-nil, zero value otherwise. + +### GetGovernanceGroupsOk + +`func (o *Owns) GetGovernanceGroupsOk() (*[]Reference, bool)` + +GetGovernanceGroupsOk returns a tuple with the GovernanceGroups field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceGroups + +`func (o *Owns) SetGovernanceGroups(v []Reference)` + +SetGovernanceGroups sets GovernanceGroups field to given value. + +### HasGovernanceGroups + +`func (o *Owns) HasGovernanceGroups() bool` + +HasGovernanceGroups returns a boolean if a field has been set. + +### GetFallbackApprover + +`func (o *Owns) GetFallbackApprover() bool` + +GetFallbackApprover returns the FallbackApprover field if non-nil, zero value otherwise. + +### GetFallbackApproverOk + +`func (o *Owns) GetFallbackApproverOk() (*bool, bool)` + +GetFallbackApproverOk returns a tuple with the FallbackApprover field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFallbackApprover + +`func (o *Owns) SetFallbackApprover(v bool)` + +SetFallbackApprover sets FallbackApprover field to given value. + +### HasFallbackApprover + +`func (o *Owns) HasFallbackApprover() bool` + +HasFallbackApprover returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PasswordChangeRequest.md b/docs/tools/sdk/go/Reference/V3/Models/PasswordChangeRequest.md new file mode 100644 index 000000000..f7916aa9c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PasswordChangeRequest.md @@ -0,0 +1,168 @@ +--- +id: password-change-request +title: PasswordChangeRequest +pagination_label: PasswordChangeRequest +sidebar_label: PasswordChangeRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordChangeRequest', 'PasswordChangeRequest'] +slug: /tools/sdk/go/v3/models/password-change-request +tags: ['SDK', 'Software Development Kit', 'PasswordChangeRequest', 'PasswordChangeRequest'] +--- + +# PasswordChangeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | The identity ID that requested the password change | [optional] +**EncryptedPassword** | Pointer to **string** | The RSA encrypted password | [optional] +**PublicKeyId** | Pointer to **string** | The encryption key ID | [optional] +**AccountId** | Pointer to **string** | Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**SourceId** | Pointer to **string** | The ID of the source for which identity is requesting the password change | [optional] + +## Methods + +### NewPasswordChangeRequest + +`func NewPasswordChangeRequest() *PasswordChangeRequest` + +NewPasswordChangeRequest instantiates a new PasswordChangeRequest 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 + +### NewPasswordChangeRequestWithDefaults + +`func NewPasswordChangeRequestWithDefaults() *PasswordChangeRequest` + +NewPasswordChangeRequestWithDefaults instantiates a new PasswordChangeRequest 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 + +### GetIdentityId + +`func (o *PasswordChangeRequest) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *PasswordChangeRequest) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *PasswordChangeRequest) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *PasswordChangeRequest) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetEncryptedPassword + +`func (o *PasswordChangeRequest) GetEncryptedPassword() string` + +GetEncryptedPassword returns the EncryptedPassword field if non-nil, zero value otherwise. + +### GetEncryptedPasswordOk + +`func (o *PasswordChangeRequest) GetEncryptedPasswordOk() (*string, bool)` + +GetEncryptedPasswordOk returns a tuple with the EncryptedPassword field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEncryptedPassword + +`func (o *PasswordChangeRequest) SetEncryptedPassword(v string)` + +SetEncryptedPassword sets EncryptedPassword field to given value. + +### HasEncryptedPassword + +`func (o *PasswordChangeRequest) HasEncryptedPassword() bool` + +HasEncryptedPassword returns a boolean if a field has been set. + +### GetPublicKeyId + +`func (o *PasswordChangeRequest) GetPublicKeyId() string` + +GetPublicKeyId returns the PublicKeyId field if non-nil, zero value otherwise. + +### GetPublicKeyIdOk + +`func (o *PasswordChangeRequest) GetPublicKeyIdOk() (*string, bool)` + +GetPublicKeyIdOk returns a tuple with the PublicKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyId + +`func (o *PasswordChangeRequest) SetPublicKeyId(v string)` + +SetPublicKeyId sets PublicKeyId field to given value. + +### HasPublicKeyId + +`func (o *PasswordChangeRequest) HasPublicKeyId() bool` + +HasPublicKeyId returns a boolean if a field has been set. + +### GetAccountId + +`func (o *PasswordChangeRequest) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *PasswordChangeRequest) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *PasswordChangeRequest) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *PasswordChangeRequest) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *PasswordChangeRequest) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *PasswordChangeRequest) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *PasswordChangeRequest) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *PasswordChangeRequest) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PasswordChangeResponse.md b/docs/tools/sdk/go/Reference/V3/Models/PasswordChangeResponse.md new file mode 100644 index 000000000..6e011965e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PasswordChangeResponse.md @@ -0,0 +1,100 @@ +--- +id: password-change-response +title: PasswordChangeResponse +pagination_label: PasswordChangeResponse +sidebar_label: PasswordChangeResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordChangeResponse', 'PasswordChangeResponse'] +slug: /tools/sdk/go/v3/models/password-change-response +tags: ['SDK', 'Software Development Kit', 'PasswordChangeResponse', 'PasswordChangeResponse'] +--- + +# PasswordChangeResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **NullableString** | The password change request ID | [optional] +**State** | Pointer to **string** | Password change state | [optional] + +## Methods + +### NewPasswordChangeResponse + +`func NewPasswordChangeResponse() *PasswordChangeResponse` + +NewPasswordChangeResponse instantiates a new PasswordChangeResponse 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 + +### NewPasswordChangeResponseWithDefaults + +`func NewPasswordChangeResponseWithDefaults() *PasswordChangeResponse` + +NewPasswordChangeResponseWithDefaults instantiates a new PasswordChangeResponse 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 + +### GetRequestId + +`func (o *PasswordChangeResponse) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *PasswordChangeResponse) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *PasswordChangeResponse) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *PasswordChangeResponse) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *PasswordChangeResponse) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *PasswordChangeResponse) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetState + +`func (o *PasswordChangeResponse) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *PasswordChangeResponse) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *PasswordChangeResponse) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *PasswordChangeResponse) HasState() bool` + +HasState returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PasswordInfo.md b/docs/tools/sdk/go/Reference/V3/Models/PasswordInfo.md new file mode 100644 index 000000000..fa543101e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PasswordInfo.md @@ -0,0 +1,194 @@ +--- +id: password-info +title: PasswordInfo +pagination_label: PasswordInfo +sidebar_label: PasswordInfo +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordInfo', 'PasswordInfo'] +slug: /tools/sdk/go/v3/models/password-info +tags: ['SDK', 'Software Development Kit', 'PasswordInfo', 'PasswordInfo'] +--- + +# PasswordInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **string** | Identity ID | [optional] +**SourceId** | Pointer to **string** | source ID | [optional] +**PublicKeyId** | Pointer to **string** | public key ID | [optional] +**PublicKey** | Pointer to **string** | User's public key with Base64 encoding | [optional] +**Accounts** | Pointer to [**[]PasswordInfoAccount**](password-info-account) | Account info related to queried identity and source | [optional] +**Policies** | Pointer to **[]string** | Password constraints | [optional] + +## Methods + +### NewPasswordInfo + +`func NewPasswordInfo() *PasswordInfo` + +NewPasswordInfo instantiates a new PasswordInfo 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 + +### NewPasswordInfoWithDefaults + +`func NewPasswordInfoWithDefaults() *PasswordInfo` + +NewPasswordInfoWithDefaults instantiates a new PasswordInfo 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 + +### GetIdentityId + +`func (o *PasswordInfo) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *PasswordInfo) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *PasswordInfo) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + +### HasIdentityId + +`func (o *PasswordInfo) HasIdentityId() bool` + +HasIdentityId returns a boolean if a field has been set. + +### GetSourceId + +`func (o *PasswordInfo) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *PasswordInfo) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *PasswordInfo) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *PasswordInfo) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetPublicKeyId + +`func (o *PasswordInfo) GetPublicKeyId() string` + +GetPublicKeyId returns the PublicKeyId field if non-nil, zero value otherwise. + +### GetPublicKeyIdOk + +`func (o *PasswordInfo) GetPublicKeyIdOk() (*string, bool)` + +GetPublicKeyIdOk returns a tuple with the PublicKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKeyId + +`func (o *PasswordInfo) SetPublicKeyId(v string)` + +SetPublicKeyId sets PublicKeyId field to given value. + +### HasPublicKeyId + +`func (o *PasswordInfo) HasPublicKeyId() bool` + +HasPublicKeyId returns a boolean if a field has been set. + +### GetPublicKey + +`func (o *PasswordInfo) GetPublicKey() string` + +GetPublicKey returns the PublicKey field if non-nil, zero value otherwise. + +### GetPublicKeyOk + +`func (o *PasswordInfo) GetPublicKeyOk() (*string, bool)` + +GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicKey + +`func (o *PasswordInfo) SetPublicKey(v string)` + +SetPublicKey sets PublicKey field to given value. + +### HasPublicKey + +`func (o *PasswordInfo) HasPublicKey() bool` + +HasPublicKey returns a boolean if a field has been set. + +### GetAccounts + +`func (o *PasswordInfo) GetAccounts() []PasswordInfoAccount` + +GetAccounts returns the Accounts field if non-nil, zero value otherwise. + +### GetAccountsOk + +`func (o *PasswordInfo) GetAccountsOk() (*[]PasswordInfoAccount, bool)` + +GetAccountsOk returns a tuple with the Accounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccounts + +`func (o *PasswordInfo) SetAccounts(v []PasswordInfoAccount)` + +SetAccounts sets Accounts field to given value. + +### HasAccounts + +`func (o *PasswordInfo) HasAccounts() bool` + +HasAccounts returns a boolean if a field has been set. + +### GetPolicies + +`func (o *PasswordInfo) GetPolicies() []string` + +GetPolicies returns the Policies field if non-nil, zero value otherwise. + +### GetPoliciesOk + +`func (o *PasswordInfo) GetPoliciesOk() (*[]string, bool)` + +GetPoliciesOk returns a tuple with the Policies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicies + +`func (o *PasswordInfo) SetPolicies(v []string)` + +SetPolicies sets Policies field to given value. + +### HasPolicies + +`func (o *PasswordInfo) HasPolicies() bool` + +HasPolicies returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PasswordInfoAccount.md b/docs/tools/sdk/go/Reference/V3/Models/PasswordInfoAccount.md new file mode 100644 index 000000000..bd6a10aa7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PasswordInfoAccount.md @@ -0,0 +1,90 @@ +--- +id: password-info-account +title: PasswordInfoAccount +pagination_label: PasswordInfoAccount +sidebar_label: PasswordInfoAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordInfoAccount', 'PasswordInfoAccount'] +slug: /tools/sdk/go/v3/models/password-info-account +tags: ['SDK', 'Software Development Kit', 'PasswordInfoAccount', 'PasswordInfoAccount'] +--- + +# PasswordInfoAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **string** | Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**AccountName** | Pointer to **string** | Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 | [optional] + +## Methods + +### NewPasswordInfoAccount + +`func NewPasswordInfoAccount() *PasswordInfoAccount` + +NewPasswordInfoAccount instantiates a new PasswordInfoAccount 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 + +### NewPasswordInfoAccountWithDefaults + +`func NewPasswordInfoAccountWithDefaults() *PasswordInfoAccount` + +NewPasswordInfoAccountWithDefaults instantiates a new PasswordInfoAccount 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 + +### GetAccountId + +`func (o *PasswordInfoAccount) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *PasswordInfoAccount) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *PasswordInfoAccount) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *PasswordInfoAccount) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### GetAccountName + +`func (o *PasswordInfoAccount) GetAccountName() string` + +GetAccountName returns the AccountName field if non-nil, zero value otherwise. + +### GetAccountNameOk + +`func (o *PasswordInfoAccount) GetAccountNameOk() (*string, bool)` + +GetAccountNameOk returns a tuple with the AccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountName + +`func (o *PasswordInfoAccount) SetAccountName(v string)` + +SetAccountName sets AccountName field to given value. + +### HasAccountName + +`func (o *PasswordInfoAccount) HasAccountName() bool` + +HasAccountName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PasswordInfoQueryDTO.md b/docs/tools/sdk/go/Reference/V3/Models/PasswordInfoQueryDTO.md new file mode 100644 index 000000000..bdc25d857 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PasswordInfoQueryDTO.md @@ -0,0 +1,90 @@ +--- +id: password-info-query-dto +title: PasswordInfoQueryDTO +pagination_label: PasswordInfoQueryDTO +sidebar_label: PasswordInfoQueryDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordInfoQueryDTO', 'PasswordInfoQueryDTO'] +slug: /tools/sdk/go/v3/models/password-info-query-dto +tags: ['SDK', 'Software Development Kit', 'PasswordInfoQueryDTO', 'PasswordInfoQueryDTO'] +--- + +# PasswordInfoQueryDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserName** | Pointer to **string** | The login name of the user | [optional] +**SourceName** | Pointer to **string** | The display name of the source | [optional] + +## Methods + +### NewPasswordInfoQueryDTO + +`func NewPasswordInfoQueryDTO() *PasswordInfoQueryDTO` + +NewPasswordInfoQueryDTO instantiates a new PasswordInfoQueryDTO 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 + +### NewPasswordInfoQueryDTOWithDefaults + +`func NewPasswordInfoQueryDTOWithDefaults() *PasswordInfoQueryDTO` + +NewPasswordInfoQueryDTOWithDefaults instantiates a new PasswordInfoQueryDTO 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 + +### GetUserName + +`func (o *PasswordInfoQueryDTO) GetUserName() string` + +GetUserName returns the UserName field if non-nil, zero value otherwise. + +### GetUserNameOk + +`func (o *PasswordInfoQueryDTO) GetUserNameOk() (*string, bool)` + +GetUserNameOk returns a tuple with the UserName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserName + +`func (o *PasswordInfoQueryDTO) SetUserName(v string)` + +SetUserName sets UserName field to given value. + +### HasUserName + +`func (o *PasswordInfoQueryDTO) HasUserName() bool` + +HasUserName returns a boolean if a field has been set. + +### GetSourceName + +`func (o *PasswordInfoQueryDTO) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *PasswordInfoQueryDTO) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *PasswordInfoQueryDTO) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *PasswordInfoQueryDTO) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PasswordOrgConfig.md b/docs/tools/sdk/go/Reference/V3/Models/PasswordOrgConfig.md new file mode 100644 index 000000000..a6478301b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PasswordOrgConfig.md @@ -0,0 +1,142 @@ +--- +id: password-org-config +title: PasswordOrgConfig +pagination_label: PasswordOrgConfig +sidebar_label: PasswordOrgConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordOrgConfig', 'PasswordOrgConfig'] +slug: /tools/sdk/go/v3/models/password-org-config +tags: ['SDK', 'Software Development Kit', 'PasswordOrgConfig', 'PasswordOrgConfig'] +--- + +# PasswordOrgConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomInstructionsEnabled** | Pointer to **bool** | Indicator whether custom password instructions feature is enabled. The default value is false. | [optional] [default to false] +**DigitTokenEnabled** | Pointer to **bool** | Indicator whether \"digit token\" feature is enabled. The default value is false. | [optional] [default to false] +**DigitTokenDurationMinutes** | Pointer to **int32** | The duration of \"digit token\" in minutes. The default value is 5. | [optional] [default to 5] +**DigitTokenLength** | Pointer to **int32** | The length of \"digit token\". The default value is 6. | [optional] [default to 6] + +## Methods + +### NewPasswordOrgConfig + +`func NewPasswordOrgConfig() *PasswordOrgConfig` + +NewPasswordOrgConfig instantiates a new PasswordOrgConfig 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 + +### NewPasswordOrgConfigWithDefaults + +`func NewPasswordOrgConfigWithDefaults() *PasswordOrgConfig` + +NewPasswordOrgConfigWithDefaults instantiates a new PasswordOrgConfig 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 + +### GetCustomInstructionsEnabled + +`func (o *PasswordOrgConfig) GetCustomInstructionsEnabled() bool` + +GetCustomInstructionsEnabled returns the CustomInstructionsEnabled field if non-nil, zero value otherwise. + +### GetCustomInstructionsEnabledOk + +`func (o *PasswordOrgConfig) GetCustomInstructionsEnabledOk() (*bool, bool)` + +GetCustomInstructionsEnabledOk returns a tuple with the CustomInstructionsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomInstructionsEnabled + +`func (o *PasswordOrgConfig) SetCustomInstructionsEnabled(v bool)` + +SetCustomInstructionsEnabled sets CustomInstructionsEnabled field to given value. + +### HasCustomInstructionsEnabled + +`func (o *PasswordOrgConfig) HasCustomInstructionsEnabled() bool` + +HasCustomInstructionsEnabled returns a boolean if a field has been set. + +### GetDigitTokenEnabled + +`func (o *PasswordOrgConfig) GetDigitTokenEnabled() bool` + +GetDigitTokenEnabled returns the DigitTokenEnabled field if non-nil, zero value otherwise. + +### GetDigitTokenEnabledOk + +`func (o *PasswordOrgConfig) GetDigitTokenEnabledOk() (*bool, bool)` + +GetDigitTokenEnabledOk returns a tuple with the DigitTokenEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDigitTokenEnabled + +`func (o *PasswordOrgConfig) SetDigitTokenEnabled(v bool)` + +SetDigitTokenEnabled sets DigitTokenEnabled field to given value. + +### HasDigitTokenEnabled + +`func (o *PasswordOrgConfig) HasDigitTokenEnabled() bool` + +HasDigitTokenEnabled returns a boolean if a field has been set. + +### GetDigitTokenDurationMinutes + +`func (o *PasswordOrgConfig) GetDigitTokenDurationMinutes() int32` + +GetDigitTokenDurationMinutes returns the DigitTokenDurationMinutes field if non-nil, zero value otherwise. + +### GetDigitTokenDurationMinutesOk + +`func (o *PasswordOrgConfig) GetDigitTokenDurationMinutesOk() (*int32, bool)` + +GetDigitTokenDurationMinutesOk returns a tuple with the DigitTokenDurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDigitTokenDurationMinutes + +`func (o *PasswordOrgConfig) SetDigitTokenDurationMinutes(v int32)` + +SetDigitTokenDurationMinutes sets DigitTokenDurationMinutes field to given value. + +### HasDigitTokenDurationMinutes + +`func (o *PasswordOrgConfig) HasDigitTokenDurationMinutes() bool` + +HasDigitTokenDurationMinutes returns a boolean if a field has been set. + +### GetDigitTokenLength + +`func (o *PasswordOrgConfig) GetDigitTokenLength() int32` + +GetDigitTokenLength returns the DigitTokenLength field if non-nil, zero value otherwise. + +### GetDigitTokenLengthOk + +`func (o *PasswordOrgConfig) GetDigitTokenLengthOk() (*int32, bool)` + +GetDigitTokenLengthOk returns a tuple with the DigitTokenLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDigitTokenLength + +`func (o *PasswordOrgConfig) SetDigitTokenLength(v int32)` + +SetDigitTokenLength sets DigitTokenLength field to given value. + +### HasDigitTokenLength + +`func (o *PasswordOrgConfig) HasDigitTokenLength() bool` + +HasDigitTokenLength returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PasswordPolicyV3Dto.md b/docs/tools/sdk/go/Reference/V3/Models/PasswordPolicyV3Dto.md new file mode 100644 index 000000000..9f66f1e67 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PasswordPolicyV3Dto.md @@ -0,0 +1,884 @@ +--- +id: password-policy-v3-dto +title: PasswordPolicyV3Dto +pagination_label: PasswordPolicyV3Dto +sidebar_label: PasswordPolicyV3Dto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordPolicyV3Dto', 'PasswordPolicyV3Dto'] +slug: /tools/sdk/go/v3/models/password-policy-v3-dto +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyV3Dto', 'PasswordPolicyV3Dto'] +--- + +# PasswordPolicyV3Dto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The password policy Id. | [optional] +**Description** | Pointer to **NullableString** | Description for current password policy. | [optional] +**Name** | Pointer to **string** | The name of the password policy. | [optional] +**DateCreated** | Pointer to **SailPointTime** | Date the Password Policy was created. | [optional] +**LastUpdated** | Pointer to **NullableTime** | Date the Password Policy was updated. | [optional] +**FirstExpirationReminder** | Pointer to **int64** | The number of days before expiration remaninder. | [optional] +**AccountIdMinWordLength** | Pointer to **int64** | The minimun length of account Id. By default is equals to -1. | [optional] +**AccountNameMinWordLength** | Pointer to **int64** | The minimun length of account name. By default is equals to -1. | [optional] +**MinAlpha** | Pointer to **int64** | Maximum alpha. By default is equals to 0. | [optional] +**MinCharacterTypes** | Pointer to **int64** | MinCharacterTypes. By default is equals to -1. | [optional] +**MaxLength** | Pointer to **int64** | Maximum length of the password. | [optional] +**MinLength** | Pointer to **int64** | Minimum length of the password. By default is equals to 0. | [optional] +**MaxRepeatedChars** | Pointer to **int64** | Maximum repetition of the same character in the password. By default is equals to -1. | [optional] +**MinLower** | Pointer to **int64** | Minimum amount of lower case character in the password. By default is equals to 0. | [optional] +**MinNumeric** | Pointer to **int64** | Minimum amount of numeric characters in the password. By default is equals to 0. | [optional] +**MinSpecial** | Pointer to **int64** | Minimum amount of special symbols in the password. By default is equals to 0. | [optional] +**MinUpper** | Pointer to **int64** | Minimum amount of upper case symbols in the password. By default is equals to 0. | [optional] +**PasswordExpiration** | Pointer to **int64** | Number of days before current password expires. By default is equals to 90. | [optional] +**DefaultPolicy** | Pointer to **bool** | Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. | [optional] [default to false] +**EnablePasswdExpiration** | Pointer to **bool** | Defines whether this policy is enabled to expire or not. This field is false by default. | [optional] [default to false] +**RequireStrongAuthn** | Pointer to **bool** | Defines whether this policy require strong Auth or not. This field is false by default. | [optional] [default to false] +**RequireStrongAuthOffNetwork** | Pointer to **bool** | Defines whether this policy require strong Auth of network or not. This field is false by default. | [optional] [default to false] +**RequireStrongAuthUntrustedGeographies** | Pointer to **bool** | Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. | [optional] [default to false] +**UseAccountAttributes** | Pointer to **bool** | Defines whether this policy uses account attributes or not. This field is false by default. | [optional] [default to false] +**UseDictionary** | Pointer to **bool** | Defines whether this policy uses dictionary or not. This field is false by default. | [optional] [default to false] +**UseIdentityAttributes** | Pointer to **bool** | Defines whether this policy uses identity attributes or not. This field is false by default. | [optional] [default to false] +**ValidateAgainstAccountId** | Pointer to **bool** | Defines whether this policy validate against account id or not. This field is false by default. | [optional] [default to false] +**ValidateAgainstAccountName** | Pointer to **bool** | Defines whether this policy validate against account name or not. This field is false by default. | [optional] [default to false] +**Created** | Pointer to **NullableString** | | [optional] +**Modified** | Pointer to **NullableString** | | [optional] +**SourceIds** | Pointer to **[]string** | List of sources IDs managed by this password policy. | [optional] + +## Methods + +### NewPasswordPolicyV3Dto + +`func NewPasswordPolicyV3Dto() *PasswordPolicyV3Dto` + +NewPasswordPolicyV3Dto instantiates a new PasswordPolicyV3Dto 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 + +### NewPasswordPolicyV3DtoWithDefaults + +`func NewPasswordPolicyV3DtoWithDefaults() *PasswordPolicyV3Dto` + +NewPasswordPolicyV3DtoWithDefaults instantiates a new PasswordPolicyV3Dto 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 + +### GetId + +`func (o *PasswordPolicyV3Dto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PasswordPolicyV3Dto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PasswordPolicyV3Dto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PasswordPolicyV3Dto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetDescription + +`func (o *PasswordPolicyV3Dto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *PasswordPolicyV3Dto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *PasswordPolicyV3Dto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *PasswordPolicyV3Dto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *PasswordPolicyV3Dto) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *PasswordPolicyV3Dto) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetName + +`func (o *PasswordPolicyV3Dto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PasswordPolicyV3Dto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PasswordPolicyV3Dto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PasswordPolicyV3Dto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDateCreated + +`func (o *PasswordPolicyV3Dto) GetDateCreated() SailPointTime` + +GetDateCreated returns the DateCreated field if non-nil, zero value otherwise. + +### GetDateCreatedOk + +`func (o *PasswordPolicyV3Dto) GetDateCreatedOk() (*SailPointTime, bool)` + +GetDateCreatedOk returns a tuple with the DateCreated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDateCreated + +`func (o *PasswordPolicyV3Dto) SetDateCreated(v SailPointTime)` + +SetDateCreated sets DateCreated field to given value. + +### HasDateCreated + +`func (o *PasswordPolicyV3Dto) HasDateCreated() bool` + +HasDateCreated returns a boolean if a field has been set. + +### GetLastUpdated + +`func (o *PasswordPolicyV3Dto) GetLastUpdated() SailPointTime` + +GetLastUpdated returns the LastUpdated field if non-nil, zero value otherwise. + +### GetLastUpdatedOk + +`func (o *PasswordPolicyV3Dto) GetLastUpdatedOk() (*SailPointTime, bool)` + +GetLastUpdatedOk returns a tuple with the LastUpdated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastUpdated + +`func (o *PasswordPolicyV3Dto) SetLastUpdated(v SailPointTime)` + +SetLastUpdated sets LastUpdated field to given value. + +### HasLastUpdated + +`func (o *PasswordPolicyV3Dto) HasLastUpdated() bool` + +HasLastUpdated returns a boolean if a field has been set. + +### SetLastUpdatedNil + +`func (o *PasswordPolicyV3Dto) SetLastUpdatedNil(b bool)` + + SetLastUpdatedNil sets the value for LastUpdated to be an explicit nil + +### UnsetLastUpdated +`func (o *PasswordPolicyV3Dto) UnsetLastUpdated()` + +UnsetLastUpdated ensures that no value is present for LastUpdated, not even an explicit nil +### GetFirstExpirationReminder + +`func (o *PasswordPolicyV3Dto) GetFirstExpirationReminder() int64` + +GetFirstExpirationReminder returns the FirstExpirationReminder field if non-nil, zero value otherwise. + +### GetFirstExpirationReminderOk + +`func (o *PasswordPolicyV3Dto) GetFirstExpirationReminderOk() (*int64, bool)` + +GetFirstExpirationReminderOk returns a tuple with the FirstExpirationReminder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirstExpirationReminder + +`func (o *PasswordPolicyV3Dto) SetFirstExpirationReminder(v int64)` + +SetFirstExpirationReminder sets FirstExpirationReminder field to given value. + +### HasFirstExpirationReminder + +`func (o *PasswordPolicyV3Dto) HasFirstExpirationReminder() bool` + +HasFirstExpirationReminder returns a boolean if a field has been set. + +### GetAccountIdMinWordLength + +`func (o *PasswordPolicyV3Dto) GetAccountIdMinWordLength() int64` + +GetAccountIdMinWordLength returns the AccountIdMinWordLength field if non-nil, zero value otherwise. + +### GetAccountIdMinWordLengthOk + +`func (o *PasswordPolicyV3Dto) GetAccountIdMinWordLengthOk() (*int64, bool)` + +GetAccountIdMinWordLengthOk returns a tuple with the AccountIdMinWordLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountIdMinWordLength + +`func (o *PasswordPolicyV3Dto) SetAccountIdMinWordLength(v int64)` + +SetAccountIdMinWordLength sets AccountIdMinWordLength field to given value. + +### HasAccountIdMinWordLength + +`func (o *PasswordPolicyV3Dto) HasAccountIdMinWordLength() bool` + +HasAccountIdMinWordLength returns a boolean if a field has been set. + +### GetAccountNameMinWordLength + +`func (o *PasswordPolicyV3Dto) GetAccountNameMinWordLength() int64` + +GetAccountNameMinWordLength returns the AccountNameMinWordLength field if non-nil, zero value otherwise. + +### GetAccountNameMinWordLengthOk + +`func (o *PasswordPolicyV3Dto) GetAccountNameMinWordLengthOk() (*int64, bool)` + +GetAccountNameMinWordLengthOk returns a tuple with the AccountNameMinWordLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountNameMinWordLength + +`func (o *PasswordPolicyV3Dto) SetAccountNameMinWordLength(v int64)` + +SetAccountNameMinWordLength sets AccountNameMinWordLength field to given value. + +### HasAccountNameMinWordLength + +`func (o *PasswordPolicyV3Dto) HasAccountNameMinWordLength() bool` + +HasAccountNameMinWordLength returns a boolean if a field has been set. + +### GetMinAlpha + +`func (o *PasswordPolicyV3Dto) GetMinAlpha() int64` + +GetMinAlpha returns the MinAlpha field if non-nil, zero value otherwise. + +### GetMinAlphaOk + +`func (o *PasswordPolicyV3Dto) GetMinAlphaOk() (*int64, bool)` + +GetMinAlphaOk returns a tuple with the MinAlpha field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinAlpha + +`func (o *PasswordPolicyV3Dto) SetMinAlpha(v int64)` + +SetMinAlpha sets MinAlpha field to given value. + +### HasMinAlpha + +`func (o *PasswordPolicyV3Dto) HasMinAlpha() bool` + +HasMinAlpha returns a boolean if a field has been set. + +### GetMinCharacterTypes + +`func (o *PasswordPolicyV3Dto) GetMinCharacterTypes() int64` + +GetMinCharacterTypes returns the MinCharacterTypes field if non-nil, zero value otherwise. + +### GetMinCharacterTypesOk + +`func (o *PasswordPolicyV3Dto) GetMinCharacterTypesOk() (*int64, bool)` + +GetMinCharacterTypesOk returns a tuple with the MinCharacterTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinCharacterTypes + +`func (o *PasswordPolicyV3Dto) SetMinCharacterTypes(v int64)` + +SetMinCharacterTypes sets MinCharacterTypes field to given value. + +### HasMinCharacterTypes + +`func (o *PasswordPolicyV3Dto) HasMinCharacterTypes() bool` + +HasMinCharacterTypes returns a boolean if a field has been set. + +### GetMaxLength + +`func (o *PasswordPolicyV3Dto) GetMaxLength() int64` + +GetMaxLength returns the MaxLength field if non-nil, zero value otherwise. + +### GetMaxLengthOk + +`func (o *PasswordPolicyV3Dto) GetMaxLengthOk() (*int64, bool)` + +GetMaxLengthOk returns a tuple with the MaxLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxLength + +`func (o *PasswordPolicyV3Dto) SetMaxLength(v int64)` + +SetMaxLength sets MaxLength field to given value. + +### HasMaxLength + +`func (o *PasswordPolicyV3Dto) HasMaxLength() bool` + +HasMaxLength returns a boolean if a field has been set. + +### GetMinLength + +`func (o *PasswordPolicyV3Dto) GetMinLength() int64` + +GetMinLength returns the MinLength field if non-nil, zero value otherwise. + +### GetMinLengthOk + +`func (o *PasswordPolicyV3Dto) GetMinLengthOk() (*int64, bool)` + +GetMinLengthOk returns a tuple with the MinLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinLength + +`func (o *PasswordPolicyV3Dto) SetMinLength(v int64)` + +SetMinLength sets MinLength field to given value. + +### HasMinLength + +`func (o *PasswordPolicyV3Dto) HasMinLength() bool` + +HasMinLength returns a boolean if a field has been set. + +### GetMaxRepeatedChars + +`func (o *PasswordPolicyV3Dto) GetMaxRepeatedChars() int64` + +GetMaxRepeatedChars returns the MaxRepeatedChars field if non-nil, zero value otherwise. + +### GetMaxRepeatedCharsOk + +`func (o *PasswordPolicyV3Dto) GetMaxRepeatedCharsOk() (*int64, bool)` + +GetMaxRepeatedCharsOk returns a tuple with the MaxRepeatedChars field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxRepeatedChars + +`func (o *PasswordPolicyV3Dto) SetMaxRepeatedChars(v int64)` + +SetMaxRepeatedChars sets MaxRepeatedChars field to given value. + +### HasMaxRepeatedChars + +`func (o *PasswordPolicyV3Dto) HasMaxRepeatedChars() bool` + +HasMaxRepeatedChars returns a boolean if a field has been set. + +### GetMinLower + +`func (o *PasswordPolicyV3Dto) GetMinLower() int64` + +GetMinLower returns the MinLower field if non-nil, zero value otherwise. + +### GetMinLowerOk + +`func (o *PasswordPolicyV3Dto) GetMinLowerOk() (*int64, bool)` + +GetMinLowerOk returns a tuple with the MinLower field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinLower + +`func (o *PasswordPolicyV3Dto) SetMinLower(v int64)` + +SetMinLower sets MinLower field to given value. + +### HasMinLower + +`func (o *PasswordPolicyV3Dto) HasMinLower() bool` + +HasMinLower returns a boolean if a field has been set. + +### GetMinNumeric + +`func (o *PasswordPolicyV3Dto) GetMinNumeric() int64` + +GetMinNumeric returns the MinNumeric field if non-nil, zero value otherwise. + +### GetMinNumericOk + +`func (o *PasswordPolicyV3Dto) GetMinNumericOk() (*int64, bool)` + +GetMinNumericOk returns a tuple with the MinNumeric field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinNumeric + +`func (o *PasswordPolicyV3Dto) SetMinNumeric(v int64)` + +SetMinNumeric sets MinNumeric field to given value. + +### HasMinNumeric + +`func (o *PasswordPolicyV3Dto) HasMinNumeric() bool` + +HasMinNumeric returns a boolean if a field has been set. + +### GetMinSpecial + +`func (o *PasswordPolicyV3Dto) GetMinSpecial() int64` + +GetMinSpecial returns the MinSpecial field if non-nil, zero value otherwise. + +### GetMinSpecialOk + +`func (o *PasswordPolicyV3Dto) GetMinSpecialOk() (*int64, bool)` + +GetMinSpecialOk returns a tuple with the MinSpecial field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinSpecial + +`func (o *PasswordPolicyV3Dto) SetMinSpecial(v int64)` + +SetMinSpecial sets MinSpecial field to given value. + +### HasMinSpecial + +`func (o *PasswordPolicyV3Dto) HasMinSpecial() bool` + +HasMinSpecial returns a boolean if a field has been set. + +### GetMinUpper + +`func (o *PasswordPolicyV3Dto) GetMinUpper() int64` + +GetMinUpper returns the MinUpper field if non-nil, zero value otherwise. + +### GetMinUpperOk + +`func (o *PasswordPolicyV3Dto) GetMinUpperOk() (*int64, bool)` + +GetMinUpperOk returns a tuple with the MinUpper field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMinUpper + +`func (o *PasswordPolicyV3Dto) SetMinUpper(v int64)` + +SetMinUpper sets MinUpper field to given value. + +### HasMinUpper + +`func (o *PasswordPolicyV3Dto) HasMinUpper() bool` + +HasMinUpper returns a boolean if a field has been set. + +### GetPasswordExpiration + +`func (o *PasswordPolicyV3Dto) GetPasswordExpiration() int64` + +GetPasswordExpiration returns the PasswordExpiration field if non-nil, zero value otherwise. + +### GetPasswordExpirationOk + +`func (o *PasswordPolicyV3Dto) GetPasswordExpirationOk() (*int64, bool)` + +GetPasswordExpirationOk returns a tuple with the PasswordExpiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordExpiration + +`func (o *PasswordPolicyV3Dto) SetPasswordExpiration(v int64)` + +SetPasswordExpiration sets PasswordExpiration field to given value. + +### HasPasswordExpiration + +`func (o *PasswordPolicyV3Dto) HasPasswordExpiration() bool` + +HasPasswordExpiration returns a boolean if a field has been set. + +### GetDefaultPolicy + +`func (o *PasswordPolicyV3Dto) GetDefaultPolicy() bool` + +GetDefaultPolicy returns the DefaultPolicy field if non-nil, zero value otherwise. + +### GetDefaultPolicyOk + +`func (o *PasswordPolicyV3Dto) GetDefaultPolicyOk() (*bool, bool)` + +GetDefaultPolicyOk returns a tuple with the DefaultPolicy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaultPolicy + +`func (o *PasswordPolicyV3Dto) SetDefaultPolicy(v bool)` + +SetDefaultPolicy sets DefaultPolicy field to given value. + +### HasDefaultPolicy + +`func (o *PasswordPolicyV3Dto) HasDefaultPolicy() bool` + +HasDefaultPolicy returns a boolean if a field has been set. + +### GetEnablePasswdExpiration + +`func (o *PasswordPolicyV3Dto) GetEnablePasswdExpiration() bool` + +GetEnablePasswdExpiration returns the EnablePasswdExpiration field if non-nil, zero value otherwise. + +### GetEnablePasswdExpirationOk + +`func (o *PasswordPolicyV3Dto) GetEnablePasswdExpirationOk() (*bool, bool)` + +GetEnablePasswdExpirationOk returns a tuple with the EnablePasswdExpiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnablePasswdExpiration + +`func (o *PasswordPolicyV3Dto) SetEnablePasswdExpiration(v bool)` + +SetEnablePasswdExpiration sets EnablePasswdExpiration field to given value. + +### HasEnablePasswdExpiration + +`func (o *PasswordPolicyV3Dto) HasEnablePasswdExpiration() bool` + +HasEnablePasswdExpiration returns a boolean if a field has been set. + +### GetRequireStrongAuthn + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthn() bool` + +GetRequireStrongAuthn returns the RequireStrongAuthn field if non-nil, zero value otherwise. + +### GetRequireStrongAuthnOk + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthnOk() (*bool, bool)` + +GetRequireStrongAuthnOk returns a tuple with the RequireStrongAuthn field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequireStrongAuthn + +`func (o *PasswordPolicyV3Dto) SetRequireStrongAuthn(v bool)` + +SetRequireStrongAuthn sets RequireStrongAuthn field to given value. + +### HasRequireStrongAuthn + +`func (o *PasswordPolicyV3Dto) HasRequireStrongAuthn() bool` + +HasRequireStrongAuthn returns a boolean if a field has been set. + +### GetRequireStrongAuthOffNetwork + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthOffNetwork() bool` + +GetRequireStrongAuthOffNetwork returns the RequireStrongAuthOffNetwork field if non-nil, zero value otherwise. + +### GetRequireStrongAuthOffNetworkOk + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthOffNetworkOk() (*bool, bool)` + +GetRequireStrongAuthOffNetworkOk returns a tuple with the RequireStrongAuthOffNetwork field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequireStrongAuthOffNetwork + +`func (o *PasswordPolicyV3Dto) SetRequireStrongAuthOffNetwork(v bool)` + +SetRequireStrongAuthOffNetwork sets RequireStrongAuthOffNetwork field to given value. + +### HasRequireStrongAuthOffNetwork + +`func (o *PasswordPolicyV3Dto) HasRequireStrongAuthOffNetwork() bool` + +HasRequireStrongAuthOffNetwork returns a boolean if a field has been set. + +### GetRequireStrongAuthUntrustedGeographies + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthUntrustedGeographies() bool` + +GetRequireStrongAuthUntrustedGeographies returns the RequireStrongAuthUntrustedGeographies field if non-nil, zero value otherwise. + +### GetRequireStrongAuthUntrustedGeographiesOk + +`func (o *PasswordPolicyV3Dto) GetRequireStrongAuthUntrustedGeographiesOk() (*bool, bool)` + +GetRequireStrongAuthUntrustedGeographiesOk returns a tuple with the RequireStrongAuthUntrustedGeographies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequireStrongAuthUntrustedGeographies + +`func (o *PasswordPolicyV3Dto) SetRequireStrongAuthUntrustedGeographies(v bool)` + +SetRequireStrongAuthUntrustedGeographies sets RequireStrongAuthUntrustedGeographies field to given value. + +### HasRequireStrongAuthUntrustedGeographies + +`func (o *PasswordPolicyV3Dto) HasRequireStrongAuthUntrustedGeographies() bool` + +HasRequireStrongAuthUntrustedGeographies returns a boolean if a field has been set. + +### GetUseAccountAttributes + +`func (o *PasswordPolicyV3Dto) GetUseAccountAttributes() bool` + +GetUseAccountAttributes returns the UseAccountAttributes field if non-nil, zero value otherwise. + +### GetUseAccountAttributesOk + +`func (o *PasswordPolicyV3Dto) GetUseAccountAttributesOk() (*bool, bool)` + +GetUseAccountAttributesOk returns a tuple with the UseAccountAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseAccountAttributes + +`func (o *PasswordPolicyV3Dto) SetUseAccountAttributes(v bool)` + +SetUseAccountAttributes sets UseAccountAttributes field to given value. + +### HasUseAccountAttributes + +`func (o *PasswordPolicyV3Dto) HasUseAccountAttributes() bool` + +HasUseAccountAttributes returns a boolean if a field has been set. + +### GetUseDictionary + +`func (o *PasswordPolicyV3Dto) GetUseDictionary() bool` + +GetUseDictionary returns the UseDictionary field if non-nil, zero value otherwise. + +### GetUseDictionaryOk + +`func (o *PasswordPolicyV3Dto) GetUseDictionaryOk() (*bool, bool)` + +GetUseDictionaryOk returns a tuple with the UseDictionary field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseDictionary + +`func (o *PasswordPolicyV3Dto) SetUseDictionary(v bool)` + +SetUseDictionary sets UseDictionary field to given value. + +### HasUseDictionary + +`func (o *PasswordPolicyV3Dto) HasUseDictionary() bool` + +HasUseDictionary returns a boolean if a field has been set. + +### GetUseIdentityAttributes + +`func (o *PasswordPolicyV3Dto) GetUseIdentityAttributes() bool` + +GetUseIdentityAttributes returns the UseIdentityAttributes field if non-nil, zero value otherwise. + +### GetUseIdentityAttributesOk + +`func (o *PasswordPolicyV3Dto) GetUseIdentityAttributesOk() (*bool, bool)` + +GetUseIdentityAttributesOk returns a tuple with the UseIdentityAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseIdentityAttributes + +`func (o *PasswordPolicyV3Dto) SetUseIdentityAttributes(v bool)` + +SetUseIdentityAttributes sets UseIdentityAttributes field to given value. + +### HasUseIdentityAttributes + +`func (o *PasswordPolicyV3Dto) HasUseIdentityAttributes() bool` + +HasUseIdentityAttributes returns a boolean if a field has been set. + +### GetValidateAgainstAccountId + +`func (o *PasswordPolicyV3Dto) GetValidateAgainstAccountId() bool` + +GetValidateAgainstAccountId returns the ValidateAgainstAccountId field if non-nil, zero value otherwise. + +### GetValidateAgainstAccountIdOk + +`func (o *PasswordPolicyV3Dto) GetValidateAgainstAccountIdOk() (*bool, bool)` + +GetValidateAgainstAccountIdOk returns a tuple with the ValidateAgainstAccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValidateAgainstAccountId + +`func (o *PasswordPolicyV3Dto) SetValidateAgainstAccountId(v bool)` + +SetValidateAgainstAccountId sets ValidateAgainstAccountId field to given value. + +### HasValidateAgainstAccountId + +`func (o *PasswordPolicyV3Dto) HasValidateAgainstAccountId() bool` + +HasValidateAgainstAccountId returns a boolean if a field has been set. + +### GetValidateAgainstAccountName + +`func (o *PasswordPolicyV3Dto) GetValidateAgainstAccountName() bool` + +GetValidateAgainstAccountName returns the ValidateAgainstAccountName field if non-nil, zero value otherwise. + +### GetValidateAgainstAccountNameOk + +`func (o *PasswordPolicyV3Dto) GetValidateAgainstAccountNameOk() (*bool, bool)` + +GetValidateAgainstAccountNameOk returns a tuple with the ValidateAgainstAccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValidateAgainstAccountName + +`func (o *PasswordPolicyV3Dto) SetValidateAgainstAccountName(v bool)` + +SetValidateAgainstAccountName sets ValidateAgainstAccountName field to given value. + +### HasValidateAgainstAccountName + +`func (o *PasswordPolicyV3Dto) HasValidateAgainstAccountName() bool` + +HasValidateAgainstAccountName returns a boolean if a field has been set. + +### GetCreated + +`func (o *PasswordPolicyV3Dto) GetCreated() string` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *PasswordPolicyV3Dto) GetCreatedOk() (*string, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *PasswordPolicyV3Dto) SetCreated(v string)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *PasswordPolicyV3Dto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *PasswordPolicyV3Dto) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *PasswordPolicyV3Dto) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *PasswordPolicyV3Dto) GetModified() string` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PasswordPolicyV3Dto) GetModifiedOk() (*string, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PasswordPolicyV3Dto) SetModified(v string)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PasswordPolicyV3Dto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *PasswordPolicyV3Dto) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *PasswordPolicyV3Dto) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSourceIds + +`func (o *PasswordPolicyV3Dto) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *PasswordPolicyV3Dto) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *PasswordPolicyV3Dto) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *PasswordPolicyV3Dto) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PasswordStatus.md b/docs/tools/sdk/go/Reference/V3/Models/PasswordStatus.md new file mode 100644 index 000000000..3b974d0d4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PasswordStatus.md @@ -0,0 +1,152 @@ +--- +id: password-status +title: PasswordStatus +pagination_label: PasswordStatus +sidebar_label: PasswordStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordStatus', 'PasswordStatus'] +slug: /tools/sdk/go/v3/models/password-status +tags: ['SDK', 'Software Development Kit', 'PasswordStatus', 'PasswordStatus'] +--- + +# PasswordStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **NullableString** | The password change request ID | [optional] +**State** | Pointer to **string** | Password change state | [optional] +**Errors** | Pointer to **[]string** | The errors during the password change request | [optional] +**SourceIds** | Pointer to **[]string** | List of source IDs in the password change request | [optional] + +## Methods + +### NewPasswordStatus + +`func NewPasswordStatus() *PasswordStatus` + +NewPasswordStatus instantiates a new PasswordStatus 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 + +### NewPasswordStatusWithDefaults + +`func NewPasswordStatusWithDefaults() *PasswordStatus` + +NewPasswordStatusWithDefaults instantiates a new PasswordStatus 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 + +### GetRequestId + +`func (o *PasswordStatus) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *PasswordStatus) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *PasswordStatus) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *PasswordStatus) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *PasswordStatus) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *PasswordStatus) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetState + +`func (o *PasswordStatus) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *PasswordStatus) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *PasswordStatus) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *PasswordStatus) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetErrors + +`func (o *PasswordStatus) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *PasswordStatus) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *PasswordStatus) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *PasswordStatus) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### GetSourceIds + +`func (o *PasswordStatus) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *PasswordStatus) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *PasswordStatus) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *PasswordStatus) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PasswordSyncGroup.md b/docs/tools/sdk/go/Reference/V3/Models/PasswordSyncGroup.md new file mode 100644 index 000000000..7de33769c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PasswordSyncGroup.md @@ -0,0 +1,214 @@ +--- +id: password-sync-group +title: PasswordSyncGroup +pagination_label: PasswordSyncGroup +sidebar_label: PasswordSyncGroup +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PasswordSyncGroup', 'PasswordSyncGroup'] +slug: /tools/sdk/go/v3/models/password-sync-group +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroup', 'PasswordSyncGroup'] +--- + +# PasswordSyncGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the sync group | [optional] +**Name** | Pointer to **string** | Name of the sync group | [optional] +**PasswordPolicyId** | Pointer to **string** | ID of the password policy | [optional] +**SourceIds** | Pointer to **[]string** | List of password managed sources IDs | [optional] +**Created** | Pointer to **NullableTime** | The date and time this sync group was created | [optional] +**Modified** | Pointer to **NullableTime** | The date and time this sync group was last modified | [optional] + +## Methods + +### NewPasswordSyncGroup + +`func NewPasswordSyncGroup() *PasswordSyncGroup` + +NewPasswordSyncGroup instantiates a new PasswordSyncGroup 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 + +### NewPasswordSyncGroupWithDefaults + +`func NewPasswordSyncGroupWithDefaults() *PasswordSyncGroup` + +NewPasswordSyncGroupWithDefaults instantiates a new PasswordSyncGroup 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 + +### GetId + +`func (o *PasswordSyncGroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PasswordSyncGroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PasswordSyncGroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PasswordSyncGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *PasswordSyncGroup) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PasswordSyncGroup) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PasswordSyncGroup) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PasswordSyncGroup) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPasswordPolicyId + +`func (o *PasswordSyncGroup) GetPasswordPolicyId() string` + +GetPasswordPolicyId returns the PasswordPolicyId field if non-nil, zero value otherwise. + +### GetPasswordPolicyIdOk + +`func (o *PasswordSyncGroup) GetPasswordPolicyIdOk() (*string, bool)` + +GetPasswordPolicyIdOk returns a tuple with the PasswordPolicyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicyId + +`func (o *PasswordSyncGroup) SetPasswordPolicyId(v string)` + +SetPasswordPolicyId sets PasswordPolicyId field to given value. + +### HasPasswordPolicyId + +`func (o *PasswordSyncGroup) HasPasswordPolicyId() bool` + +HasPasswordPolicyId returns a boolean if a field has been set. + +### GetSourceIds + +`func (o *PasswordSyncGroup) GetSourceIds() []string` + +GetSourceIds returns the SourceIds field if non-nil, zero value otherwise. + +### GetSourceIdsOk + +`func (o *PasswordSyncGroup) GetSourceIdsOk() (*[]string, bool)` + +GetSourceIdsOk returns a tuple with the SourceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceIds + +`func (o *PasswordSyncGroup) SetSourceIds(v []string)` + +SetSourceIds sets SourceIds field to given value. + +### HasSourceIds + +`func (o *PasswordSyncGroup) HasSourceIds() bool` + +HasSourceIds returns a boolean if a field has been set. + +### GetCreated + +`func (o *PasswordSyncGroup) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *PasswordSyncGroup) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *PasswordSyncGroup) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *PasswordSyncGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *PasswordSyncGroup) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *PasswordSyncGroup) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *PasswordSyncGroup) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PasswordSyncGroup) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PasswordSyncGroup) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PasswordSyncGroup) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *PasswordSyncGroup) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *PasswordSyncGroup) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PatOwner.md b/docs/tools/sdk/go/Reference/V3/Models/PatOwner.md new file mode 100644 index 000000000..4fd52fd15 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PatOwner.md @@ -0,0 +1,116 @@ +--- +id: pat-owner +title: PatOwner +pagination_label: PatOwner +sidebar_label: PatOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PatOwner', 'PatOwner'] +slug: /tools/sdk/go/v3/models/pat-owner +tags: ['SDK', 'Software Development Kit', 'PatOwner', 'PatOwner'] +--- + +# PatOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Personal access token owner's DTO type. | [optional] +**Id** | Pointer to **string** | Personal access token owner's identity ID. | [optional] +**Name** | Pointer to **string** | Personal access token owner's human-readable display name. | [optional] + +## Methods + +### NewPatOwner + +`func NewPatOwner() *PatOwner` + +NewPatOwner instantiates a new PatOwner 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 + +### NewPatOwnerWithDefaults + +`func NewPatOwnerWithDefaults() *PatOwner` + +NewPatOwnerWithDefaults instantiates a new PatOwner 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 + +### GetType + +`func (o *PatOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *PatOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *PatOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *PatOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *PatOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PatOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PatOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PatOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *PatOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PatOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PatOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PatOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PendingApproval.md b/docs/tools/sdk/go/Reference/V3/Models/PendingApproval.md new file mode 100644 index 000000000..7644926b9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PendingApproval.md @@ -0,0 +1,650 @@ +--- +id: pending-approval +title: PendingApproval +pagination_label: PendingApproval +sidebar_label: PendingApproval +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PendingApproval', 'PendingApproval'] +slug: /tools/sdk/go/v3/models/pending-approval +tags: ['SDK', 'Software Development Kit', 'PendingApproval', 'PendingApproval'] +--- + +# PendingApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The approval id. | [optional] +**AccessRequestId** | Pointer to **string** | This is the access request id. | [optional] +**Name** | Pointer to **string** | The name of the approval. | [optional] +**Created** | Pointer to **SailPointTime** | When the approval was created. | [optional] +**Modified** | Pointer to **SailPointTime** | When the approval was modified last time. | [optional] +**RequestCreated** | Pointer to **SailPointTime** | When the access-request was created. | [optional] +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**AccessItemRequestedFor**](access-item-requested-for) | | [optional] +**Owner** | Pointer to [**PendingApprovalOwner**](pending-approval-owner) | | [optional] +**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**RequesterComment** | Pointer to [**CommentDto**](comment-dto) | | [optional] +**PreviousReviewersComments** | Pointer to [**[]CommentDto**](comment-dto) | The history of the previous reviewers comments. | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**CommentRequiredWhenRejected** | Pointer to **bool** | When true the rejector has to provide comments when rejecting | [optional] [default to false] +**ActionInProcess** | Pointer to [**PendingApprovalAction**](pending-approval-action) | | [optional] +**RemoveDate** | Pointer to **SailPointTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**RemoveDateUpdateRequested** | Pointer to **bool** | If true, then the request is to change the remove date or sunset date. | [optional] [default to false] +**CurrentRemoveDate** | Pointer to **SailPointTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**SodViolationContext** | Pointer to [**NullableSodViolationContextCheckCompleted**](sod-violation-context-check-completed) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional] +**RequestedAccounts** | Pointer to [**[]RequestedAccountRef**](requested-account-ref) | The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. | [optional] + +## Methods + +### NewPendingApproval + +`func NewPendingApproval() *PendingApproval` + +NewPendingApproval instantiates a new PendingApproval 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 + +### NewPendingApprovalWithDefaults + +`func NewPendingApprovalWithDefaults() *PendingApproval` + +NewPendingApprovalWithDefaults instantiates a new PendingApproval 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 + +### GetId + +`func (o *PendingApproval) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PendingApproval) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PendingApproval) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PendingApproval) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAccessRequestId + +`func (o *PendingApproval) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *PendingApproval) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *PendingApproval) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + +### HasAccessRequestId + +`func (o *PendingApproval) HasAccessRequestId() bool` + +HasAccessRequestId returns a boolean if a field has been set. + +### GetName + +`func (o *PendingApproval) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PendingApproval) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PendingApproval) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PendingApproval) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *PendingApproval) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *PendingApproval) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *PendingApproval) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *PendingApproval) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *PendingApproval) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PendingApproval) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PendingApproval) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PendingApproval) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetRequestCreated + +`func (o *PendingApproval) GetRequestCreated() SailPointTime` + +GetRequestCreated returns the RequestCreated field if non-nil, zero value otherwise. + +### GetRequestCreatedOk + +`func (o *PendingApproval) GetRequestCreatedOk() (*SailPointTime, bool)` + +GetRequestCreatedOk returns a tuple with the RequestCreated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCreated + +`func (o *PendingApproval) SetRequestCreated(v SailPointTime)` + +SetRequestCreated sets RequestCreated field to given value. + +### HasRequestCreated + +`func (o *PendingApproval) HasRequestCreated() bool` + +HasRequestCreated returns a boolean if a field has been set. + +### GetRequestType + +`func (o *PendingApproval) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *PendingApproval) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *PendingApproval) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *PendingApproval) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *PendingApproval) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *PendingApproval) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetRequester + +`func (o *PendingApproval) GetRequester() AccessItemRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *PendingApproval) GetRequesterOk() (*AccessItemRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *PendingApproval) SetRequester(v AccessItemRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *PendingApproval) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRequestedFor + +`func (o *PendingApproval) GetRequestedFor() AccessItemRequestedFor` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *PendingApproval) GetRequestedForOk() (*AccessItemRequestedFor, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *PendingApproval) SetRequestedFor(v AccessItemRequestedFor)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *PendingApproval) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetOwner + +`func (o *PendingApproval) GetOwner() PendingApprovalOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *PendingApproval) GetOwnerOk() (*PendingApprovalOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *PendingApproval) SetOwner(v PendingApprovalOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *PendingApproval) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRequestedObject + +`func (o *PendingApproval) GetRequestedObject() RequestableObjectReference` + +GetRequestedObject returns the RequestedObject field if non-nil, zero value otherwise. + +### GetRequestedObjectOk + +`func (o *PendingApproval) GetRequestedObjectOk() (*RequestableObjectReference, bool)` + +GetRequestedObjectOk returns a tuple with the RequestedObject field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedObject + +`func (o *PendingApproval) SetRequestedObject(v RequestableObjectReference)` + +SetRequestedObject sets RequestedObject field to given value. + +### HasRequestedObject + +`func (o *PendingApproval) HasRequestedObject() bool` + +HasRequestedObject returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *PendingApproval) GetRequesterComment() CommentDto` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *PendingApproval) GetRequesterCommentOk() (*CommentDto, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *PendingApproval) SetRequesterComment(v CommentDto)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *PendingApproval) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### GetPreviousReviewersComments + +`func (o *PendingApproval) GetPreviousReviewersComments() []CommentDto` + +GetPreviousReviewersComments returns the PreviousReviewersComments field if non-nil, zero value otherwise. + +### GetPreviousReviewersCommentsOk + +`func (o *PendingApproval) GetPreviousReviewersCommentsOk() (*[]CommentDto, bool)` + +GetPreviousReviewersCommentsOk returns a tuple with the PreviousReviewersComments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousReviewersComments + +`func (o *PendingApproval) SetPreviousReviewersComments(v []CommentDto)` + +SetPreviousReviewersComments sets PreviousReviewersComments field to given value. + +### HasPreviousReviewersComments + +`func (o *PendingApproval) HasPreviousReviewersComments() bool` + +HasPreviousReviewersComments returns a boolean if a field has been set. + +### GetForwardHistory + +`func (o *PendingApproval) GetForwardHistory() []ApprovalForwardHistory` + +GetForwardHistory returns the ForwardHistory field if non-nil, zero value otherwise. + +### GetForwardHistoryOk + +`func (o *PendingApproval) GetForwardHistoryOk() (*[]ApprovalForwardHistory, bool)` + +GetForwardHistoryOk returns a tuple with the ForwardHistory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForwardHistory + +`func (o *PendingApproval) SetForwardHistory(v []ApprovalForwardHistory)` + +SetForwardHistory sets ForwardHistory field to given value. + +### HasForwardHistory + +`func (o *PendingApproval) HasForwardHistory() bool` + +HasForwardHistory returns a boolean if a field has been set. + +### GetCommentRequiredWhenRejected + +`func (o *PendingApproval) GetCommentRequiredWhenRejected() bool` + +GetCommentRequiredWhenRejected returns the CommentRequiredWhenRejected field if non-nil, zero value otherwise. + +### GetCommentRequiredWhenRejectedOk + +`func (o *PendingApproval) GetCommentRequiredWhenRejectedOk() (*bool, bool)` + +GetCommentRequiredWhenRejectedOk returns a tuple with the CommentRequiredWhenRejected field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentRequiredWhenRejected + +`func (o *PendingApproval) SetCommentRequiredWhenRejected(v bool)` + +SetCommentRequiredWhenRejected sets CommentRequiredWhenRejected field to given value. + +### HasCommentRequiredWhenRejected + +`func (o *PendingApproval) HasCommentRequiredWhenRejected() bool` + +HasCommentRequiredWhenRejected returns a boolean if a field has been set. + +### GetActionInProcess + +`func (o *PendingApproval) GetActionInProcess() PendingApprovalAction` + +GetActionInProcess returns the ActionInProcess field if non-nil, zero value otherwise. + +### GetActionInProcessOk + +`func (o *PendingApproval) GetActionInProcessOk() (*PendingApprovalAction, bool)` + +GetActionInProcessOk returns a tuple with the ActionInProcess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActionInProcess + +`func (o *PendingApproval) SetActionInProcess(v PendingApprovalAction)` + +SetActionInProcess sets ActionInProcess field to given value. + +### HasActionInProcess + +`func (o *PendingApproval) HasActionInProcess() bool` + +HasActionInProcess returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *PendingApproval) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *PendingApproval) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *PendingApproval) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *PendingApproval) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetRemoveDateUpdateRequested + +`func (o *PendingApproval) GetRemoveDateUpdateRequested() bool` + +GetRemoveDateUpdateRequested returns the RemoveDateUpdateRequested field if non-nil, zero value otherwise. + +### GetRemoveDateUpdateRequestedOk + +`func (o *PendingApproval) GetRemoveDateUpdateRequestedOk() (*bool, bool)` + +GetRemoveDateUpdateRequestedOk returns a tuple with the RemoveDateUpdateRequested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDateUpdateRequested + +`func (o *PendingApproval) SetRemoveDateUpdateRequested(v bool)` + +SetRemoveDateUpdateRequested sets RemoveDateUpdateRequested field to given value. + +### HasRemoveDateUpdateRequested + +`func (o *PendingApproval) HasRemoveDateUpdateRequested() bool` + +HasRemoveDateUpdateRequested returns a boolean if a field has been set. + +### GetCurrentRemoveDate + +`func (o *PendingApproval) GetCurrentRemoveDate() SailPointTime` + +GetCurrentRemoveDate returns the CurrentRemoveDate field if non-nil, zero value otherwise. + +### GetCurrentRemoveDateOk + +`func (o *PendingApproval) GetCurrentRemoveDateOk() (*SailPointTime, bool)` + +GetCurrentRemoveDateOk returns a tuple with the CurrentRemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrentRemoveDate + +`func (o *PendingApproval) SetCurrentRemoveDate(v SailPointTime)` + +SetCurrentRemoveDate sets CurrentRemoveDate field to given value. + +### HasCurrentRemoveDate + +`func (o *PendingApproval) HasCurrentRemoveDate() bool` + +HasCurrentRemoveDate returns a boolean if a field has been set. + +### GetSodViolationContext + +`func (o *PendingApproval) GetSodViolationContext() SodViolationContextCheckCompleted` + +GetSodViolationContext returns the SodViolationContext field if non-nil, zero value otherwise. + +### GetSodViolationContextOk + +`func (o *PendingApproval) GetSodViolationContextOk() (*SodViolationContextCheckCompleted, bool)` + +GetSodViolationContextOk returns a tuple with the SodViolationContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodViolationContext + +`func (o *PendingApproval) SetSodViolationContext(v SodViolationContextCheckCompleted)` + +SetSodViolationContext sets SodViolationContext field to given value. + +### HasSodViolationContext + +`func (o *PendingApproval) HasSodViolationContext() bool` + +HasSodViolationContext returns a boolean if a field has been set. + +### SetSodViolationContextNil + +`func (o *PendingApproval) SetSodViolationContextNil(b bool)` + + SetSodViolationContextNil sets the value for SodViolationContext to be an explicit nil + +### UnsetSodViolationContext +`func (o *PendingApproval) UnsetSodViolationContext()` + +UnsetSodViolationContext ensures that no value is present for SodViolationContext, not even an explicit nil +### GetClientMetadata + +`func (o *PendingApproval) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *PendingApproval) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *PendingApproval) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *PendingApproval) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *PendingApproval) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *PendingApproval) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetRequestedAccounts + +`func (o *PendingApproval) GetRequestedAccounts() []RequestedAccountRef` + +GetRequestedAccounts returns the RequestedAccounts field if non-nil, zero value otherwise. + +### GetRequestedAccountsOk + +`func (o *PendingApproval) GetRequestedAccountsOk() (*[]RequestedAccountRef, bool)` + +GetRequestedAccountsOk returns a tuple with the RequestedAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedAccounts + +`func (o *PendingApproval) SetRequestedAccounts(v []RequestedAccountRef)` + +SetRequestedAccounts sets RequestedAccounts field to given value. + +### HasRequestedAccounts + +`func (o *PendingApproval) HasRequestedAccounts() bool` + +HasRequestedAccounts returns a boolean if a field has been set. + +### SetRequestedAccountsNil + +`func (o *PendingApproval) SetRequestedAccountsNil(b bool)` + + SetRequestedAccountsNil sets the value for RequestedAccounts to be an explicit nil + +### UnsetRequestedAccounts +`func (o *PendingApproval) UnsetRequestedAccounts()` + +UnsetRequestedAccounts ensures that no value is present for RequestedAccounts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PendingApprovalAction.md b/docs/tools/sdk/go/Reference/V3/Models/PendingApprovalAction.md new file mode 100644 index 000000000..4cfb12f1a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PendingApprovalAction.md @@ -0,0 +1,23 @@ +--- +id: pending-approval-action +title: PendingApprovalAction +pagination_label: PendingApprovalAction +sidebar_label: PendingApprovalAction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PendingApprovalAction', 'PendingApprovalAction'] +slug: /tools/sdk/go/v3/models/pending-approval-action +tags: ['SDK', 'Software Development Kit', 'PendingApprovalAction', 'PendingApprovalAction'] +--- + +# PendingApprovalAction + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `FORWARDED` (value: `"FORWARDED"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PendingApprovalOwner.md b/docs/tools/sdk/go/Reference/V3/Models/PendingApprovalOwner.md new file mode 100644 index 000000000..2bfbb2516 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PendingApprovalOwner.md @@ -0,0 +1,116 @@ +--- +id: pending-approval-owner +title: PendingApprovalOwner +pagination_label: PendingApprovalOwner +sidebar_label: PendingApprovalOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PendingApprovalOwner', 'PendingApprovalOwner'] +slug: /tools/sdk/go/v3/models/pending-approval-owner +tags: ['SDK', 'Software Development Kit', 'PendingApprovalOwner', 'PendingApprovalOwner'] +--- + +# PendingApprovalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Access item owner's DTO type. | [optional] +**Id** | Pointer to **string** | Access item owner's identity ID. | [optional] +**Name** | Pointer to **string** | Access item owner's human-readable display name. | [optional] + +## Methods + +### NewPendingApprovalOwner + +`func NewPendingApprovalOwner() *PendingApprovalOwner` + +NewPendingApprovalOwner instantiates a new PendingApprovalOwner 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 + +### NewPendingApprovalOwnerWithDefaults + +`func NewPendingApprovalOwnerWithDefaults() *PendingApprovalOwner` + +NewPendingApprovalOwnerWithDefaults instantiates a new PendingApprovalOwner 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 + +### GetType + +`func (o *PendingApprovalOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *PendingApprovalOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *PendingApprovalOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *PendingApprovalOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *PendingApprovalOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PendingApprovalOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PendingApprovalOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PendingApprovalOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *PendingApprovalOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PendingApprovalOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PendingApprovalOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PendingApprovalOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PermissionDto.md b/docs/tools/sdk/go/Reference/V3/Models/PermissionDto.md new file mode 100644 index 000000000..b7f4499ef --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PermissionDto.md @@ -0,0 +1,90 @@ +--- +id: permission-dto +title: PermissionDto +pagination_label: PermissionDto +sidebar_label: PermissionDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PermissionDto', 'PermissionDto'] +slug: /tools/sdk/go/v3/models/permission-dto +tags: ['SDK', 'Software Development Kit', 'PermissionDto', 'PermissionDto'] +--- + +# PermissionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Rights** | Pointer to **[]string** | All the rights (e.g. actions) that this permission allows on the target | [optional] [readonly] +**Target** | Pointer to **string** | The target the permission would grants rights on. | [optional] [readonly] + +## Methods + +### NewPermissionDto + +`func NewPermissionDto() *PermissionDto` + +NewPermissionDto instantiates a new PermissionDto 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 + +### NewPermissionDtoWithDefaults + +`func NewPermissionDtoWithDefaults() *PermissionDto` + +NewPermissionDtoWithDefaults instantiates a new PermissionDto 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 + +### GetRights + +`func (o *PermissionDto) GetRights() []string` + +GetRights returns the Rights field if non-nil, zero value otherwise. + +### GetRightsOk + +`func (o *PermissionDto) GetRightsOk() (*[]string, bool)` + +GetRightsOk returns a tuple with the Rights field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRights + +`func (o *PermissionDto) SetRights(v []string)` + +SetRights sets Rights field to given value. + +### HasRights + +`func (o *PermissionDto) HasRights() bool` + +HasRights returns a boolean if a field has been set. + +### GetTarget + +`func (o *PermissionDto) GetTarget() string` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *PermissionDto) GetTargetOk() (*string, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTarget + +`func (o *PermissionDto) SetTarget(v string)` + +SetTarget sets Target field to given value. + +### HasTarget + +`func (o *PermissionDto) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PreApprovalTriggerDetails.md b/docs/tools/sdk/go/Reference/V3/Models/PreApprovalTriggerDetails.md new file mode 100644 index 000000000..b50ca1c43 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PreApprovalTriggerDetails.md @@ -0,0 +1,116 @@ +--- +id: pre-approval-trigger-details +title: PreApprovalTriggerDetails +pagination_label: PreApprovalTriggerDetails +sidebar_label: PreApprovalTriggerDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PreApprovalTriggerDetails', 'PreApprovalTriggerDetails'] +slug: /tools/sdk/go/v3/models/pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'PreApprovalTriggerDetails', 'PreApprovalTriggerDetails'] +--- + +# PreApprovalTriggerDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment left for the pre-approval decision | [optional] +**Reviewer** | Pointer to **string** | The reviewer of the pre-approval decision | [optional] +**Decision** | Pointer to **string** | The decision of the pre-approval trigger | [optional] + +## Methods + +### NewPreApprovalTriggerDetails + +`func NewPreApprovalTriggerDetails() *PreApprovalTriggerDetails` + +NewPreApprovalTriggerDetails instantiates a new PreApprovalTriggerDetails 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 + +### NewPreApprovalTriggerDetailsWithDefaults + +`func NewPreApprovalTriggerDetailsWithDefaults() *PreApprovalTriggerDetails` + +NewPreApprovalTriggerDetailsWithDefaults instantiates a new PreApprovalTriggerDetails 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 + +### GetComment + +`func (o *PreApprovalTriggerDetails) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *PreApprovalTriggerDetails) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *PreApprovalTriggerDetails) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *PreApprovalTriggerDetails) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetReviewer + +`func (o *PreApprovalTriggerDetails) GetReviewer() string` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *PreApprovalTriggerDetails) GetReviewerOk() (*string, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *PreApprovalTriggerDetails) SetReviewer(v string)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *PreApprovalTriggerDetails) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetDecision + +`func (o *PreApprovalTriggerDetails) GetDecision() string` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *PreApprovalTriggerDetails) GetDecisionOk() (*string, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *PreApprovalTriggerDetails) SetDecision(v string)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *PreApprovalTriggerDetails) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ProcessingDetails.md b/docs/tools/sdk/go/Reference/V3/Models/ProcessingDetails.md new file mode 100644 index 000000000..72ce953e2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ProcessingDetails.md @@ -0,0 +1,178 @@ +--- +id: processing-details +title: ProcessingDetails +pagination_label: ProcessingDetails +sidebar_label: ProcessingDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProcessingDetails', 'ProcessingDetails'] +slug: /tools/sdk/go/v3/models/processing-details +tags: ['SDK', 'Software Development Kit', 'ProcessingDetails', 'ProcessingDetails'] +--- + +# ProcessingDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Stage** | Pointer to **string** | | [optional] +**RetryCount** | Pointer to **int32** | | [optional] +**StackTrace** | Pointer to **string** | | [optional] +**Message** | Pointer to **string** | | [optional] + +## Methods + +### NewProcessingDetails + +`func NewProcessingDetails() *ProcessingDetails` + +NewProcessingDetails instantiates a new ProcessingDetails 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 + +### NewProcessingDetailsWithDefaults + +`func NewProcessingDetailsWithDefaults() *ProcessingDetails` + +NewProcessingDetailsWithDefaults instantiates a new ProcessingDetails 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 + +### GetDate + +`func (o *ProcessingDetails) GetDate() SailPointTime` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *ProcessingDetails) GetDateOk() (*SailPointTime, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *ProcessingDetails) SetDate(v SailPointTime)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *ProcessingDetails) HasDate() bool` + +HasDate returns a boolean if a field has been set. + +### SetDateNil + +`func (o *ProcessingDetails) SetDateNil(b bool)` + + SetDateNil sets the value for Date to be an explicit nil + +### UnsetDate +`func (o *ProcessingDetails) UnsetDate()` + +UnsetDate ensures that no value is present for Date, not even an explicit nil +### GetStage + +`func (o *ProcessingDetails) GetStage() string` + +GetStage returns the Stage field if non-nil, zero value otherwise. + +### GetStageOk + +`func (o *ProcessingDetails) GetStageOk() (*string, bool)` + +GetStageOk returns a tuple with the Stage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStage + +`func (o *ProcessingDetails) SetStage(v string)` + +SetStage sets Stage field to given value. + +### HasStage + +`func (o *ProcessingDetails) HasStage() bool` + +HasStage returns a boolean if a field has been set. + +### GetRetryCount + +`func (o *ProcessingDetails) GetRetryCount() int32` + +GetRetryCount returns the RetryCount field if non-nil, zero value otherwise. + +### GetRetryCountOk + +`func (o *ProcessingDetails) GetRetryCountOk() (*int32, bool)` + +GetRetryCountOk returns a tuple with the RetryCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRetryCount + +`func (o *ProcessingDetails) SetRetryCount(v int32)` + +SetRetryCount sets RetryCount field to given value. + +### HasRetryCount + +`func (o *ProcessingDetails) HasRetryCount() bool` + +HasRetryCount returns a boolean if a field has been set. + +### GetStackTrace + +`func (o *ProcessingDetails) GetStackTrace() string` + +GetStackTrace returns the StackTrace field if non-nil, zero value otherwise. + +### GetStackTraceOk + +`func (o *ProcessingDetails) GetStackTraceOk() (*string, bool)` + +GetStackTraceOk returns a tuple with the StackTrace field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStackTrace + +`func (o *ProcessingDetails) SetStackTrace(v string)` + +SetStackTrace sets StackTrace field to given value. + +### HasStackTrace + +`func (o *ProcessingDetails) HasStackTrace() bool` + +HasStackTrace returns a boolean if a field has been set. + +### GetMessage + +`func (o *ProcessingDetails) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *ProcessingDetails) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *ProcessingDetails) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *ProcessingDetails) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ProvisioningConfig.md b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningConfig.md new file mode 100644 index 000000000..0eea01c27 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningConfig.md @@ -0,0 +1,178 @@ +--- +id: provisioning-config +title: ProvisioningConfig +pagination_label: ProvisioningConfig +sidebar_label: ProvisioningConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningConfig', 'ProvisioningConfig'] +slug: /tools/sdk/go/v3/models/provisioning-config +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig', 'ProvisioningConfig'] +--- + +# ProvisioningConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UniversalManager** | Pointer to **bool** | Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. | [optional] [readonly] [default to false] +**ManagedResourceRefs** | Pointer to [**[]ServiceDeskSource**](service-desk-source) | References to sources for the Service Desk integration template. May only be specified if universalManager is false. | [optional] +**PlanInitializerScript** | Pointer to [**NullableProvisioningConfigPlanInitializerScript**](provisioning-config-plan-initializer-script) | | [optional] +**NoProvisioningRequests** | Pointer to **bool** | Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. | [optional] [default to false] +**ProvisioningRequestExpiration** | Pointer to **int32** | When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. | [optional] + +## Methods + +### NewProvisioningConfig + +`func NewProvisioningConfig() *ProvisioningConfig` + +NewProvisioningConfig instantiates a new ProvisioningConfig 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 + +### NewProvisioningConfigWithDefaults + +`func NewProvisioningConfigWithDefaults() *ProvisioningConfig` + +NewProvisioningConfigWithDefaults instantiates a new ProvisioningConfig 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 + +### GetUniversalManager + +`func (o *ProvisioningConfig) GetUniversalManager() bool` + +GetUniversalManager returns the UniversalManager field if non-nil, zero value otherwise. + +### GetUniversalManagerOk + +`func (o *ProvisioningConfig) GetUniversalManagerOk() (*bool, bool)` + +GetUniversalManagerOk returns a tuple with the UniversalManager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUniversalManager + +`func (o *ProvisioningConfig) SetUniversalManager(v bool)` + +SetUniversalManager sets UniversalManager field to given value. + +### HasUniversalManager + +`func (o *ProvisioningConfig) HasUniversalManager() bool` + +HasUniversalManager returns a boolean if a field has been set. + +### GetManagedResourceRefs + +`func (o *ProvisioningConfig) GetManagedResourceRefs() []ServiceDeskSource` + +GetManagedResourceRefs returns the ManagedResourceRefs field if non-nil, zero value otherwise. + +### GetManagedResourceRefsOk + +`func (o *ProvisioningConfig) GetManagedResourceRefsOk() (*[]ServiceDeskSource, bool)` + +GetManagedResourceRefsOk returns a tuple with the ManagedResourceRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagedResourceRefs + +`func (o *ProvisioningConfig) SetManagedResourceRefs(v []ServiceDeskSource)` + +SetManagedResourceRefs sets ManagedResourceRefs field to given value. + +### HasManagedResourceRefs + +`func (o *ProvisioningConfig) HasManagedResourceRefs() bool` + +HasManagedResourceRefs returns a boolean if a field has been set. + +### GetPlanInitializerScript + +`func (o *ProvisioningConfig) GetPlanInitializerScript() ProvisioningConfigPlanInitializerScript` + +GetPlanInitializerScript returns the PlanInitializerScript field if non-nil, zero value otherwise. + +### GetPlanInitializerScriptOk + +`func (o *ProvisioningConfig) GetPlanInitializerScriptOk() (*ProvisioningConfigPlanInitializerScript, bool)` + +GetPlanInitializerScriptOk returns a tuple with the PlanInitializerScript field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPlanInitializerScript + +`func (o *ProvisioningConfig) SetPlanInitializerScript(v ProvisioningConfigPlanInitializerScript)` + +SetPlanInitializerScript sets PlanInitializerScript field to given value. + +### HasPlanInitializerScript + +`func (o *ProvisioningConfig) HasPlanInitializerScript() bool` + +HasPlanInitializerScript returns a boolean if a field has been set. + +### SetPlanInitializerScriptNil + +`func (o *ProvisioningConfig) SetPlanInitializerScriptNil(b bool)` + + SetPlanInitializerScriptNil sets the value for PlanInitializerScript to be an explicit nil + +### UnsetPlanInitializerScript +`func (o *ProvisioningConfig) UnsetPlanInitializerScript()` + +UnsetPlanInitializerScript ensures that no value is present for PlanInitializerScript, not even an explicit nil +### GetNoProvisioningRequests + +`func (o *ProvisioningConfig) GetNoProvisioningRequests() bool` + +GetNoProvisioningRequests returns the NoProvisioningRequests field if non-nil, zero value otherwise. + +### GetNoProvisioningRequestsOk + +`func (o *ProvisioningConfig) GetNoProvisioningRequestsOk() (*bool, bool)` + +GetNoProvisioningRequestsOk returns a tuple with the NoProvisioningRequests field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNoProvisioningRequests + +`func (o *ProvisioningConfig) SetNoProvisioningRequests(v bool)` + +SetNoProvisioningRequests sets NoProvisioningRequests field to given value. + +### HasNoProvisioningRequests + +`func (o *ProvisioningConfig) HasNoProvisioningRequests() bool` + +HasNoProvisioningRequests returns a boolean if a field has been set. + +### GetProvisioningRequestExpiration + +`func (o *ProvisioningConfig) GetProvisioningRequestExpiration() int32` + +GetProvisioningRequestExpiration returns the ProvisioningRequestExpiration field if non-nil, zero value otherwise. + +### GetProvisioningRequestExpirationOk + +`func (o *ProvisioningConfig) GetProvisioningRequestExpirationOk() (*int32, bool)` + +GetProvisioningRequestExpirationOk returns a tuple with the ProvisioningRequestExpiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningRequestExpiration + +`func (o *ProvisioningConfig) SetProvisioningRequestExpiration(v int32)` + +SetProvisioningRequestExpiration sets ProvisioningRequestExpiration field to given value. + +### HasProvisioningRequestExpiration + +`func (o *ProvisioningConfig) HasProvisioningRequestExpiration() bool` + +HasProvisioningRequestExpiration returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ProvisioningConfigPlanInitializerScript.md b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningConfigPlanInitializerScript.md new file mode 100644 index 000000000..473afb38d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningConfigPlanInitializerScript.md @@ -0,0 +1,64 @@ +--- +id: provisioning-config-plan-initializer-script +title: ProvisioningConfigPlanInitializerScript +pagination_label: ProvisioningConfigPlanInitializerScript +sidebar_label: ProvisioningConfigPlanInitializerScript +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningConfigPlanInitializerScript', 'ProvisioningConfigPlanInitializerScript'] +slug: /tools/sdk/go/v3/models/provisioning-config-plan-initializer-script +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfigPlanInitializerScript', 'ProvisioningConfigPlanInitializerScript'] +--- + +# ProvisioningConfigPlanInitializerScript + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | Pointer to **string** | This is a Rule that allows provisioning instruction changes. | [optional] + +## Methods + +### NewProvisioningConfigPlanInitializerScript + +`func NewProvisioningConfigPlanInitializerScript() *ProvisioningConfigPlanInitializerScript` + +NewProvisioningConfigPlanInitializerScript instantiates a new ProvisioningConfigPlanInitializerScript 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 + +### NewProvisioningConfigPlanInitializerScriptWithDefaults + +`func NewProvisioningConfigPlanInitializerScriptWithDefaults() *ProvisioningConfigPlanInitializerScript` + +NewProvisioningConfigPlanInitializerScriptWithDefaults instantiates a new ProvisioningConfigPlanInitializerScript 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 + +### GetSource + +`func (o *ProvisioningConfigPlanInitializerScript) GetSource() string` + +GetSource returns the Source field if non-nil, zero value otherwise. + +### GetSourceOk + +`func (o *ProvisioningConfigPlanInitializerScript) GetSourceOk() (*string, bool)` + +GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSource + +`func (o *ProvisioningConfigPlanInitializerScript) SetSource(v string)` + +SetSource sets Source field to given value. + +### HasSource + +`func (o *ProvisioningConfigPlanInitializerScript) HasSource() bool` + +HasSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningCriteriaLevel1.md new file mode 100644 index 000000000..a0d11176b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningCriteriaLevel1.md @@ -0,0 +1,172 @@ +--- +id: provisioning-criteria-level1 +title: ProvisioningCriteriaLevel1 +pagination_label: ProvisioningCriteriaLevel1 +sidebar_label: ProvisioningCriteriaLevel1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCriteriaLevel1', 'ProvisioningCriteriaLevel1'] +slug: /tools/sdk/go/v3/models/provisioning-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'ProvisioningCriteriaLevel1'] +--- + +# ProvisioningCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **NullableString** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | Pointer to **NullableString** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | Pointer to [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Methods + +### NewProvisioningCriteriaLevel1 + +`func NewProvisioningCriteriaLevel1() *ProvisioningCriteriaLevel1` + +NewProvisioningCriteriaLevel1 instantiates a new ProvisioningCriteriaLevel1 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 + +### NewProvisioningCriteriaLevel1WithDefaults + +`func NewProvisioningCriteriaLevel1WithDefaults() *ProvisioningCriteriaLevel1` + +NewProvisioningCriteriaLevel1WithDefaults instantiates a new ProvisioningCriteriaLevel1 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 + +### GetOperation + +`func (o *ProvisioningCriteriaLevel1) GetOperation() ProvisioningCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ProvisioningCriteriaLevel1) GetOperationOk() (*ProvisioningCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ProvisioningCriteriaLevel1) SetOperation(v ProvisioningCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ProvisioningCriteriaLevel1) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ProvisioningCriteriaLevel1) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ProvisioningCriteriaLevel1) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ProvisioningCriteriaLevel1) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ProvisioningCriteriaLevel1) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *ProvisioningCriteriaLevel1) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *ProvisioningCriteriaLevel1) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *ProvisioningCriteriaLevel1) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ProvisioningCriteriaLevel1) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ProvisioningCriteriaLevel1) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ProvisioningCriteriaLevel1) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ProvisioningCriteriaLevel1) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ProvisioningCriteriaLevel1) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *ProvisioningCriteriaLevel1) GetChildren() []ProvisioningCriteriaLevel2` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *ProvisioningCriteriaLevel1) GetChildrenOk() (*[]ProvisioningCriteriaLevel2, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *ProvisioningCriteriaLevel1) SetChildren(v []ProvisioningCriteriaLevel2)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *ProvisioningCriteriaLevel1) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *ProvisioningCriteriaLevel1) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *ProvisioningCriteriaLevel1) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningCriteriaLevel2.md new file mode 100644 index 000000000..9c3a628c9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningCriteriaLevel2.md @@ -0,0 +1,172 @@ +--- +id: provisioning-criteria-level2 +title: ProvisioningCriteriaLevel2 +pagination_label: ProvisioningCriteriaLevel2 +sidebar_label: ProvisioningCriteriaLevel2 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCriteriaLevel2', 'ProvisioningCriteriaLevel2'] +slug: /tools/sdk/go/v3/models/provisioning-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'ProvisioningCriteriaLevel2'] +--- + +# ProvisioningCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **NullableString** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | Pointer to **NullableString** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | Pointer to [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Methods + +### NewProvisioningCriteriaLevel2 + +`func NewProvisioningCriteriaLevel2() *ProvisioningCriteriaLevel2` + +NewProvisioningCriteriaLevel2 instantiates a new ProvisioningCriteriaLevel2 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 + +### NewProvisioningCriteriaLevel2WithDefaults + +`func NewProvisioningCriteriaLevel2WithDefaults() *ProvisioningCriteriaLevel2` + +NewProvisioningCriteriaLevel2WithDefaults instantiates a new ProvisioningCriteriaLevel2 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 + +### GetOperation + +`func (o *ProvisioningCriteriaLevel2) GetOperation() ProvisioningCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ProvisioningCriteriaLevel2) GetOperationOk() (*ProvisioningCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ProvisioningCriteriaLevel2) SetOperation(v ProvisioningCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ProvisioningCriteriaLevel2) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ProvisioningCriteriaLevel2) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ProvisioningCriteriaLevel2) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ProvisioningCriteriaLevel2) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ProvisioningCriteriaLevel2) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *ProvisioningCriteriaLevel2) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *ProvisioningCriteriaLevel2) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *ProvisioningCriteriaLevel2) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ProvisioningCriteriaLevel2) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ProvisioningCriteriaLevel2) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ProvisioningCriteriaLevel2) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ProvisioningCriteriaLevel2) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ProvisioningCriteriaLevel2) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *ProvisioningCriteriaLevel2) GetChildren() []ProvisioningCriteriaLevel3` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *ProvisioningCriteriaLevel2) GetChildrenOk() (*[]ProvisioningCriteriaLevel3, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *ProvisioningCriteriaLevel2) SetChildren(v []ProvisioningCriteriaLevel3)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *ProvisioningCriteriaLevel2) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *ProvisioningCriteriaLevel2) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *ProvisioningCriteriaLevel2) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningCriteriaLevel3.md new file mode 100644 index 000000000..9d1586503 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningCriteriaLevel3.md @@ -0,0 +1,172 @@ +--- +id: provisioning-criteria-level3 +title: ProvisioningCriteriaLevel3 +pagination_label: ProvisioningCriteriaLevel3 +sidebar_label: ProvisioningCriteriaLevel3 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCriteriaLevel3', 'ProvisioningCriteriaLevel3'] +slug: /tools/sdk/go/v3/models/provisioning-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'ProvisioningCriteriaLevel3'] +--- + +# ProvisioningCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **NullableString** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | Pointer to **NullableString** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | Pointer to **NullableString** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Methods + +### NewProvisioningCriteriaLevel3 + +`func NewProvisioningCriteriaLevel3() *ProvisioningCriteriaLevel3` + +NewProvisioningCriteriaLevel3 instantiates a new ProvisioningCriteriaLevel3 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 + +### NewProvisioningCriteriaLevel3WithDefaults + +`func NewProvisioningCriteriaLevel3WithDefaults() *ProvisioningCriteriaLevel3` + +NewProvisioningCriteriaLevel3WithDefaults instantiates a new ProvisioningCriteriaLevel3 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 + +### GetOperation + +`func (o *ProvisioningCriteriaLevel3) GetOperation() ProvisioningCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *ProvisioningCriteriaLevel3) GetOperationOk() (*ProvisioningCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *ProvisioningCriteriaLevel3) SetOperation(v ProvisioningCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *ProvisioningCriteriaLevel3) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetAttribute + +`func (o *ProvisioningCriteriaLevel3) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *ProvisioningCriteriaLevel3) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *ProvisioningCriteriaLevel3) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *ProvisioningCriteriaLevel3) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### SetAttributeNil + +`func (o *ProvisioningCriteriaLevel3) SetAttributeNil(b bool)` + + SetAttributeNil sets the value for Attribute to be an explicit nil + +### UnsetAttribute +`func (o *ProvisioningCriteriaLevel3) UnsetAttribute()` + +UnsetAttribute ensures that no value is present for Attribute, not even an explicit nil +### GetValue + +`func (o *ProvisioningCriteriaLevel3) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ProvisioningCriteriaLevel3) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ProvisioningCriteriaLevel3) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ProvisioningCriteriaLevel3) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ProvisioningCriteriaLevel3) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ProvisioningCriteriaLevel3) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetChildren + +`func (o *ProvisioningCriteriaLevel3) GetChildren() string` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *ProvisioningCriteriaLevel3) GetChildrenOk() (*string, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *ProvisioningCriteriaLevel3) SetChildren(v string)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *ProvisioningCriteriaLevel3) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *ProvisioningCriteriaLevel3) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *ProvisioningCriteriaLevel3) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningCriteriaOperation.md new file mode 100644 index 000000000..022d028a9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningCriteriaOperation.md @@ -0,0 +1,29 @@ +--- +id: provisioning-criteria-operation +title: ProvisioningCriteriaOperation +pagination_label: ProvisioningCriteriaOperation +sidebar_label: ProvisioningCriteriaOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningCriteriaOperation', 'ProvisioningCriteriaOperation'] +slug: /tools/sdk/go/v3/models/provisioning-criteria-operation +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'ProvisioningCriteriaOperation'] +--- + +# ProvisioningCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `HAS` (value: `"HAS"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ProvisioningDetails.md b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningDetails.md new file mode 100644 index 000000000..347f729b8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningDetails.md @@ -0,0 +1,64 @@ +--- +id: provisioning-details +title: ProvisioningDetails +pagination_label: ProvisioningDetails +sidebar_label: ProvisioningDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningDetails', 'ProvisioningDetails'] +slug: /tools/sdk/go/v3/models/provisioning-details +tags: ['SDK', 'Software Development Kit', 'ProvisioningDetails', 'ProvisioningDetails'] +--- + +# ProvisioningDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrderedSubPhaseReferences** | Pointer to **string** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. | [optional] + +## Methods + +### NewProvisioningDetails + +`func NewProvisioningDetails() *ProvisioningDetails` + +NewProvisioningDetails instantiates a new ProvisioningDetails 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 + +### NewProvisioningDetailsWithDefaults + +`func NewProvisioningDetailsWithDefaults() *ProvisioningDetails` + +NewProvisioningDetailsWithDefaults instantiates a new ProvisioningDetails 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 + +### GetOrderedSubPhaseReferences + +`func (o *ProvisioningDetails) GetOrderedSubPhaseReferences() string` + +GetOrderedSubPhaseReferences returns the OrderedSubPhaseReferences field if non-nil, zero value otherwise. + +### GetOrderedSubPhaseReferencesOk + +`func (o *ProvisioningDetails) GetOrderedSubPhaseReferencesOk() (*string, bool)` + +GetOrderedSubPhaseReferencesOk returns a tuple with the OrderedSubPhaseReferences field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderedSubPhaseReferences + +`func (o *ProvisioningDetails) SetOrderedSubPhaseReferences(v string)` + +SetOrderedSubPhaseReferences sets OrderedSubPhaseReferences field to given value. + +### HasOrderedSubPhaseReferences + +`func (o *ProvisioningDetails) HasOrderedSubPhaseReferences() bool` + +HasOrderedSubPhaseReferences returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ProvisioningPolicy.md b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningPolicy.md new file mode 100644 index 000000000..92c640ea4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningPolicy.md @@ -0,0 +1,147 @@ +--- +id: provisioning-policy +title: ProvisioningPolicy +pagination_label: ProvisioningPolicy +sidebar_label: ProvisioningPolicy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningPolicy', 'ProvisioningPolicy'] +slug: /tools/sdk/go/v3/models/provisioning-policy +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicy', 'ProvisioningPolicy'] +--- + +# ProvisioningPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **NullableString** | the provisioning policy name | +**Description** | Pointer to **string** | the description of the provisioning policy | [optional] +**UsageType** | Pointer to [**UsageType**](usage-type) | | [optional] +**Fields** | Pointer to [**[]FieldDetailsDto**](field-details-dto) | | [optional] + +## Methods + +### NewProvisioningPolicy + +`func NewProvisioningPolicy(name NullableString, ) *ProvisioningPolicy` + +NewProvisioningPolicy instantiates a new ProvisioningPolicy 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 + +### NewProvisioningPolicyWithDefaults + +`func NewProvisioningPolicyWithDefaults() *ProvisioningPolicy` + +NewProvisioningPolicyWithDefaults instantiates a new ProvisioningPolicy 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 + +### GetName + +`func (o *ProvisioningPolicy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningPolicy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningPolicy) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *ProvisioningPolicy) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ProvisioningPolicy) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *ProvisioningPolicy) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ProvisioningPolicy) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ProvisioningPolicy) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ProvisioningPolicy) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetUsageType + +`func (o *ProvisioningPolicy) GetUsageType() UsageType` + +GetUsageType returns the UsageType field if non-nil, zero value otherwise. + +### GetUsageTypeOk + +`func (o *ProvisioningPolicy) GetUsageTypeOk() (*UsageType, bool)` + +GetUsageTypeOk returns a tuple with the UsageType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsageType + +`func (o *ProvisioningPolicy) SetUsageType(v UsageType)` + +SetUsageType sets UsageType field to given value. + +### HasUsageType + +`func (o *ProvisioningPolicy) HasUsageType() bool` + +HasUsageType returns a boolean if a field has been set. + +### GetFields + +`func (o *ProvisioningPolicy) GetFields() []FieldDetailsDto` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *ProvisioningPolicy) GetFieldsOk() (*[]FieldDetailsDto, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *ProvisioningPolicy) SetFields(v []FieldDetailsDto)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *ProvisioningPolicy) HasFields() bool` + +HasFields returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ProvisioningPolicyDto.md b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningPolicyDto.md new file mode 100644 index 000000000..a6acfb936 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningPolicyDto.md @@ -0,0 +1,147 @@ +--- +id: provisioning-policy-dto +title: ProvisioningPolicyDto +pagination_label: ProvisioningPolicyDto +sidebar_label: ProvisioningPolicyDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningPolicyDto', 'ProvisioningPolicyDto'] +slug: /tools/sdk/go/v3/models/provisioning-policy-dto +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicyDto', 'ProvisioningPolicyDto'] +--- + +# ProvisioningPolicyDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **NullableString** | the provisioning policy name | +**Description** | Pointer to **string** | the description of the provisioning policy | [optional] +**UsageType** | Pointer to [**UsageType**](usage-type) | | [optional] +**Fields** | Pointer to [**[]FieldDetailsDto**](field-details-dto) | | [optional] + +## Methods + +### NewProvisioningPolicyDto + +`func NewProvisioningPolicyDto(name NullableString, ) *ProvisioningPolicyDto` + +NewProvisioningPolicyDto instantiates a new ProvisioningPolicyDto 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 + +### NewProvisioningPolicyDtoWithDefaults + +`func NewProvisioningPolicyDtoWithDefaults() *ProvisioningPolicyDto` + +NewProvisioningPolicyDtoWithDefaults instantiates a new ProvisioningPolicyDto 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 + +### GetName + +`func (o *ProvisioningPolicyDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ProvisioningPolicyDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ProvisioningPolicyDto) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *ProvisioningPolicyDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ProvisioningPolicyDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *ProvisioningPolicyDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ProvisioningPolicyDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ProvisioningPolicyDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ProvisioningPolicyDto) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetUsageType + +`func (o *ProvisioningPolicyDto) GetUsageType() UsageType` + +GetUsageType returns the UsageType field if non-nil, zero value otherwise. + +### GetUsageTypeOk + +`func (o *ProvisioningPolicyDto) GetUsageTypeOk() (*UsageType, bool)` + +GetUsageTypeOk returns a tuple with the UsageType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsageType + +`func (o *ProvisioningPolicyDto) SetUsageType(v UsageType)` + +SetUsageType sets UsageType field to given value. + +### HasUsageType + +`func (o *ProvisioningPolicyDto) HasUsageType() bool` + +HasUsageType returns a boolean if a field has been set. + +### GetFields + +`func (o *ProvisioningPolicyDto) GetFields() []FieldDetailsDto` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *ProvisioningPolicyDto) GetFieldsOk() (*[]FieldDetailsDto, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *ProvisioningPolicyDto) SetFields(v []FieldDetailsDto)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *ProvisioningPolicyDto) HasFields() bool` + +HasFields returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ProvisioningState.md b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningState.md new file mode 100644 index 000000000..b08029a17 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ProvisioningState.md @@ -0,0 +1,29 @@ +--- +id: provisioning-state +title: ProvisioningState +pagination_label: ProvisioningState +sidebar_label: ProvisioningState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ProvisioningState', 'ProvisioningState'] +slug: /tools/sdk/go/v3/models/provisioning-state +tags: ['SDK', 'Software Development Kit', 'ProvisioningState', 'ProvisioningState'] +--- + +# ProvisioningState + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `FINISHED` (value: `"FINISHED"`) + +* `UNVERIFIABLE` (value: `"UNVERIFIABLE"`) + +* `COMMITED` (value: `"COMMITED"`) + +* `FAILED` (value: `"FAILED"`) + +* `RETRY` (value: `"RETRY"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PublicIdentity.md b/docs/tools/sdk/go/Reference/V3/Models/PublicIdentity.md new file mode 100644 index 000000000..d7461397e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PublicIdentity.md @@ -0,0 +1,286 @@ +--- +id: public-identity +title: PublicIdentity +pagination_label: PublicIdentity +sidebar_label: PublicIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentity', 'PublicIdentity'] +slug: /tools/sdk/go/v3/models/public-identity +tags: ['SDK', 'Software Development Kit', 'PublicIdentity', 'PublicIdentity'] +--- + +# PublicIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Identity id | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity. | [optional] +**Alias** | Pointer to **string** | Alternate unique identifier for the identity. | [optional] +**Email** | Pointer to **NullableString** | Email address of identity. | [optional] +**Status** | Pointer to **NullableString** | The lifecycle status for the identity | [optional] +**IdentityState** | Pointer to **NullableString** | The current state of the identity, which determines how Identity Security Cloud interacts with the identity. An identity that is Active will be included identity picklists in Request Center, identity processing, and more. Identities that are Inactive will be excluded from these features. | [optional] +**Manager** | Pointer to [**NullableIdentityReference**](identity-reference) | | [optional] +**Attributes** | Pointer to [**[]PublicIdentityAttributesInner**](public-identity-attributes-inner) | The public identity attributes of the identity | [optional] + +## Methods + +### NewPublicIdentity + +`func NewPublicIdentity() *PublicIdentity` + +NewPublicIdentity instantiates a new PublicIdentity 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 + +### NewPublicIdentityWithDefaults + +`func NewPublicIdentityWithDefaults() *PublicIdentity` + +NewPublicIdentityWithDefaults instantiates a new PublicIdentity 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 + +### GetId + +`func (o *PublicIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PublicIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PublicIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PublicIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *PublicIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PublicIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PublicIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PublicIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetAlias + +`func (o *PublicIdentity) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *PublicIdentity) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *PublicIdentity) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *PublicIdentity) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + +### GetEmail + +`func (o *PublicIdentity) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *PublicIdentity) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *PublicIdentity) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *PublicIdentity) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### SetEmailNil + +`func (o *PublicIdentity) SetEmailNil(b bool)` + + SetEmailNil sets the value for Email to be an explicit nil + +### UnsetEmail +`func (o *PublicIdentity) UnsetEmail()` + +UnsetEmail ensures that no value is present for Email, not even an explicit nil +### GetStatus + +`func (o *PublicIdentity) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *PublicIdentity) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *PublicIdentity) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *PublicIdentity) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatusNil + +`func (o *PublicIdentity) SetStatusNil(b bool)` + + SetStatusNil sets the value for Status to be an explicit nil + +### UnsetStatus +`func (o *PublicIdentity) UnsetStatus()` + +UnsetStatus ensures that no value is present for Status, not even an explicit nil +### GetIdentityState + +`func (o *PublicIdentity) GetIdentityState() string` + +GetIdentityState returns the IdentityState field if non-nil, zero value otherwise. + +### GetIdentityStateOk + +`func (o *PublicIdentity) GetIdentityStateOk() (*string, bool)` + +GetIdentityStateOk returns a tuple with the IdentityState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityState + +`func (o *PublicIdentity) SetIdentityState(v string)` + +SetIdentityState sets IdentityState field to given value. + +### HasIdentityState + +`func (o *PublicIdentity) HasIdentityState() bool` + +HasIdentityState returns a boolean if a field has been set. + +### SetIdentityStateNil + +`func (o *PublicIdentity) SetIdentityStateNil(b bool)` + + SetIdentityStateNil sets the value for IdentityState to be an explicit nil + +### UnsetIdentityState +`func (o *PublicIdentity) UnsetIdentityState()` + +UnsetIdentityState ensures that no value is present for IdentityState, not even an explicit nil +### GetManager + +`func (o *PublicIdentity) GetManager() IdentityReference` + +GetManager returns the Manager field if non-nil, zero value otherwise. + +### GetManagerOk + +`func (o *PublicIdentity) GetManagerOk() (*IdentityReference, bool)` + +GetManagerOk returns a tuple with the Manager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManager + +`func (o *PublicIdentity) SetManager(v IdentityReference)` + +SetManager sets Manager field to given value. + +### HasManager + +`func (o *PublicIdentity) HasManager() bool` + +HasManager returns a boolean if a field has been set. + +### SetManagerNil + +`func (o *PublicIdentity) SetManagerNil(b bool)` + + SetManagerNil sets the value for Manager to be an explicit nil + +### UnsetManager +`func (o *PublicIdentity) UnsetManager()` + +UnsetManager ensures that no value is present for Manager, not even an explicit nil +### GetAttributes + +`func (o *PublicIdentity) GetAttributes() []PublicIdentityAttributesInner` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *PublicIdentity) GetAttributesOk() (*[]PublicIdentityAttributesInner, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *PublicIdentity) SetAttributes(v []PublicIdentityAttributesInner)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *PublicIdentity) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PublicIdentityAttributeConfig.md b/docs/tools/sdk/go/Reference/V3/Models/PublicIdentityAttributeConfig.md new file mode 100644 index 000000000..fee1baf37 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PublicIdentityAttributeConfig.md @@ -0,0 +1,90 @@ +--- +id: public-identity-attribute-config +title: PublicIdentityAttributeConfig +pagination_label: PublicIdentityAttributeConfig +sidebar_label: PublicIdentityAttributeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentityAttributeConfig', 'PublicIdentityAttributeConfig'] +slug: /tools/sdk/go/v3/models/public-identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributeConfig', 'PublicIdentityAttributeConfig'] +--- + +# PublicIdentityAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The attribute key | [optional] +**Name** | Pointer to **string** | The attribute display name | [optional] + +## Methods + +### NewPublicIdentityAttributeConfig + +`func NewPublicIdentityAttributeConfig() *PublicIdentityAttributeConfig` + +NewPublicIdentityAttributeConfig instantiates a new PublicIdentityAttributeConfig 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 + +### NewPublicIdentityAttributeConfigWithDefaults + +`func NewPublicIdentityAttributeConfigWithDefaults() *PublicIdentityAttributeConfig` + +NewPublicIdentityAttributeConfigWithDefaults instantiates a new PublicIdentityAttributeConfig 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 + +### GetKey + +`func (o *PublicIdentityAttributeConfig) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *PublicIdentityAttributeConfig) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *PublicIdentityAttributeConfig) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *PublicIdentityAttributeConfig) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *PublicIdentityAttributeConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PublicIdentityAttributeConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PublicIdentityAttributeConfig) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PublicIdentityAttributeConfig) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PublicIdentityAttributesInner.md b/docs/tools/sdk/go/Reference/V3/Models/PublicIdentityAttributesInner.md new file mode 100644 index 000000000..bd7d674aa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PublicIdentityAttributesInner.md @@ -0,0 +1,126 @@ +--- +id: public-identity-attributes-inner +title: PublicIdentityAttributesInner +pagination_label: PublicIdentityAttributesInner +sidebar_label: PublicIdentityAttributesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentityAttributesInner', 'PublicIdentityAttributesInner'] +slug: /tools/sdk/go/v3/models/public-identity-attributes-inner +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributesInner', 'PublicIdentityAttributesInner'] +--- + +# PublicIdentityAttributesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **string** | The attribute key | [optional] +**Name** | Pointer to **string** | Human-readable display name of the attribute | [optional] +**Value** | Pointer to **NullableString** | The attribute value | [optional] + +## Methods + +### NewPublicIdentityAttributesInner + +`func NewPublicIdentityAttributesInner() *PublicIdentityAttributesInner` + +NewPublicIdentityAttributesInner instantiates a new PublicIdentityAttributesInner 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 + +### NewPublicIdentityAttributesInnerWithDefaults + +`func NewPublicIdentityAttributesInnerWithDefaults() *PublicIdentityAttributesInner` + +NewPublicIdentityAttributesInnerWithDefaults instantiates a new PublicIdentityAttributesInner 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 + +### GetKey + +`func (o *PublicIdentityAttributesInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *PublicIdentityAttributesInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *PublicIdentityAttributesInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *PublicIdentityAttributesInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetName + +`func (o *PublicIdentityAttributesInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *PublicIdentityAttributesInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *PublicIdentityAttributesInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *PublicIdentityAttributesInner) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetValue + +`func (o *PublicIdentityAttributesInner) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *PublicIdentityAttributesInner) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *PublicIdentityAttributesInner) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *PublicIdentityAttributesInner) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *PublicIdentityAttributesInner) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *PublicIdentityAttributesInner) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PublicIdentityConfig.md b/docs/tools/sdk/go/Reference/V3/Models/PublicIdentityConfig.md new file mode 100644 index 000000000..5dc565887 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PublicIdentityConfig.md @@ -0,0 +1,136 @@ +--- +id: public-identity-config +title: PublicIdentityConfig +pagination_label: PublicIdentityConfig +sidebar_label: PublicIdentityConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PublicIdentityConfig', 'PublicIdentityConfig'] +slug: /tools/sdk/go/v3/models/public-identity-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityConfig', 'PublicIdentityConfig'] +--- + +# PublicIdentityConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]PublicIdentityAttributeConfig**](public-identity-attribute-config) | Up to 5 identity attributes that will be available to everyone in the org for all users in the org. | [optional] +**Modified** | Pointer to **NullableTime** | When this configuration was last modified. | [optional] +**ModifiedBy** | Pointer to [**NullableIdentityReference**](identity-reference) | | [optional] + +## Methods + +### NewPublicIdentityConfig + +`func NewPublicIdentityConfig() *PublicIdentityConfig` + +NewPublicIdentityConfig instantiates a new PublicIdentityConfig 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 + +### NewPublicIdentityConfigWithDefaults + +`func NewPublicIdentityConfigWithDefaults() *PublicIdentityConfig` + +NewPublicIdentityConfigWithDefaults instantiates a new PublicIdentityConfig 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 + +### GetAttributes + +`func (o *PublicIdentityConfig) GetAttributes() []PublicIdentityAttributeConfig` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *PublicIdentityConfig) GetAttributesOk() (*[]PublicIdentityAttributeConfig, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *PublicIdentityConfig) SetAttributes(v []PublicIdentityAttributeConfig)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *PublicIdentityConfig) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetModified + +`func (o *PublicIdentityConfig) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *PublicIdentityConfig) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *PublicIdentityConfig) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *PublicIdentityConfig) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *PublicIdentityConfig) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *PublicIdentityConfig) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetModifiedBy + +`func (o *PublicIdentityConfig) GetModifiedBy() IdentityReference` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *PublicIdentityConfig) GetModifiedByOk() (*IdentityReference, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedBy + +`func (o *PublicIdentityConfig) SetModifiedBy(v IdentityReference)` + +SetModifiedBy sets ModifiedBy field to given value. + +### HasModifiedBy + +`func (o *PublicIdentityConfig) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### SetModifiedByNil + +`func (o *PublicIdentityConfig) SetModifiedByNil(b bool)` + + SetModifiedByNil sets the value for ModifiedBy to be an explicit nil + +### UnsetModifiedBy +`func (o *PublicIdentityConfig) UnsetModifiedBy()` + +UnsetModifiedBy ensures that no value is present for ModifiedBy, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PutClientLogConfigurationRequest.md b/docs/tools/sdk/go/Reference/V3/Models/PutClientLogConfigurationRequest.md new file mode 100644 index 000000000..c957f6804 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PutClientLogConfigurationRequest.md @@ -0,0 +1,163 @@ +--- +id: put-client-log-configuration-request +title: PutClientLogConfigurationRequest +pagination_label: PutClientLogConfigurationRequest +sidebar_label: PutClientLogConfigurationRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PutClientLogConfigurationRequest', 'PutClientLogConfigurationRequest'] +slug: /tools/sdk/go/v3/models/put-client-log-configuration-request +tags: ['SDK', 'Software Development Kit', 'PutClientLogConfigurationRequest', 'PutClientLogConfigurationRequest'] +--- + +# PutClientLogConfigurationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **string** | Log configuration's client ID | [optional] +**DurationMinutes** | Pointer to **int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**RootLevel** | [**StandardLevel**](standard-level) | | +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] +**Expiration** | Pointer to **SailPointTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] + +## Methods + +### NewPutClientLogConfigurationRequest + +`func NewPutClientLogConfigurationRequest(rootLevel StandardLevel, ) *PutClientLogConfigurationRequest` + +NewPutClientLogConfigurationRequest instantiates a new PutClientLogConfigurationRequest 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 + +### NewPutClientLogConfigurationRequestWithDefaults + +`func NewPutClientLogConfigurationRequestWithDefaults() *PutClientLogConfigurationRequest` + +NewPutClientLogConfigurationRequestWithDefaults instantiates a new PutClientLogConfigurationRequest 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 + +### GetClientId + +`func (o *PutClientLogConfigurationRequest) GetClientId() string` + +GetClientId returns the ClientId field if non-nil, zero value otherwise. + +### GetClientIdOk + +`func (o *PutClientLogConfigurationRequest) GetClientIdOk() (*string, bool)` + +GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientId + +`func (o *PutClientLogConfigurationRequest) SetClientId(v string)` + +SetClientId sets ClientId field to given value. + +### HasClientId + +`func (o *PutClientLogConfigurationRequest) HasClientId() bool` + +HasClientId returns a boolean if a field has been set. + +### GetDurationMinutes + +`func (o *PutClientLogConfigurationRequest) GetDurationMinutes() int32` + +GetDurationMinutes returns the DurationMinutes field if non-nil, zero value otherwise. + +### GetDurationMinutesOk + +`func (o *PutClientLogConfigurationRequest) GetDurationMinutesOk() (*int32, bool)` + +GetDurationMinutesOk returns a tuple with the DurationMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDurationMinutes + +`func (o *PutClientLogConfigurationRequest) SetDurationMinutes(v int32)` + +SetDurationMinutes sets DurationMinutes field to given value. + +### HasDurationMinutes + +`func (o *PutClientLogConfigurationRequest) HasDurationMinutes() bool` + +HasDurationMinutes returns a boolean if a field has been set. + +### GetRootLevel + +`func (o *PutClientLogConfigurationRequest) GetRootLevel() StandardLevel` + +GetRootLevel returns the RootLevel field if non-nil, zero value otherwise. + +### GetRootLevelOk + +`func (o *PutClientLogConfigurationRequest) GetRootLevelOk() (*StandardLevel, bool)` + +GetRootLevelOk returns a tuple with the RootLevel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootLevel + +`func (o *PutClientLogConfigurationRequest) SetRootLevel(v StandardLevel)` + +SetRootLevel sets RootLevel field to given value. + + +### GetLogLevels + +`func (o *PutClientLogConfigurationRequest) GetLogLevels() map[string]StandardLevel` + +GetLogLevels returns the LogLevels field if non-nil, zero value otherwise. + +### GetLogLevelsOk + +`func (o *PutClientLogConfigurationRequest) GetLogLevelsOk() (*map[string]StandardLevel, bool)` + +GetLogLevelsOk returns a tuple with the LogLevels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogLevels + +`func (o *PutClientLogConfigurationRequest) SetLogLevels(v map[string]StandardLevel)` + +SetLogLevels sets LogLevels field to given value. + +### HasLogLevels + +`func (o *PutClientLogConfigurationRequest) HasLogLevels() bool` + +HasLogLevels returns a boolean if a field has been set. + +### GetExpiration + +`func (o *PutClientLogConfigurationRequest) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *PutClientLogConfigurationRequest) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *PutClientLogConfigurationRequest) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *PutClientLogConfigurationRequest) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PutConnectorSourceConfigRequest.md b/docs/tools/sdk/go/Reference/V3/Models/PutConnectorSourceConfigRequest.md new file mode 100644 index 000000000..d1a2bfa73 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PutConnectorSourceConfigRequest.md @@ -0,0 +1,59 @@ +--- +id: put-connector-source-config-request +title: PutConnectorSourceConfigRequest +pagination_label: PutConnectorSourceConfigRequest +sidebar_label: PutConnectorSourceConfigRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PutConnectorSourceConfigRequest', 'PutConnectorSourceConfigRequest'] +slug: /tools/sdk/go/v3/models/put-connector-source-config-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceConfigRequest', 'PutConnectorSourceConfigRequest'] +--- + +# PutConnectorSourceConfigRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | ***os.File** | connector source config xml file | + +## Methods + +### NewPutConnectorSourceConfigRequest + +`func NewPutConnectorSourceConfigRequest(file *os.File, ) *PutConnectorSourceConfigRequest` + +NewPutConnectorSourceConfigRequest instantiates a new PutConnectorSourceConfigRequest 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 + +### NewPutConnectorSourceConfigRequestWithDefaults + +`func NewPutConnectorSourceConfigRequestWithDefaults() *PutConnectorSourceConfigRequest` + +NewPutConnectorSourceConfigRequestWithDefaults instantiates a new PutConnectorSourceConfigRequest 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 + +### GetFile + +`func (o *PutConnectorSourceConfigRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *PutConnectorSourceConfigRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *PutConnectorSourceConfigRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PutConnectorSourceTemplateRequest.md b/docs/tools/sdk/go/Reference/V3/Models/PutConnectorSourceTemplateRequest.md new file mode 100644 index 000000000..7dceb840f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PutConnectorSourceTemplateRequest.md @@ -0,0 +1,59 @@ +--- +id: put-connector-source-template-request +title: PutConnectorSourceTemplateRequest +pagination_label: PutConnectorSourceTemplateRequest +sidebar_label: PutConnectorSourceTemplateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PutConnectorSourceTemplateRequest', 'PutConnectorSourceTemplateRequest'] +slug: /tools/sdk/go/v3/models/put-connector-source-template-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceTemplateRequest', 'PutConnectorSourceTemplateRequest'] +--- + +# PutConnectorSourceTemplateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | ***os.File** | connector source template xml file | + +## Methods + +### NewPutConnectorSourceTemplateRequest + +`func NewPutConnectorSourceTemplateRequest(file *os.File, ) *PutConnectorSourceTemplateRequest` + +NewPutConnectorSourceTemplateRequest instantiates a new PutConnectorSourceTemplateRequest 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 + +### NewPutConnectorSourceTemplateRequestWithDefaults + +`func NewPutConnectorSourceTemplateRequestWithDefaults() *PutConnectorSourceTemplateRequest` + +NewPutConnectorSourceTemplateRequestWithDefaults instantiates a new PutConnectorSourceTemplateRequest 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 + +### GetFile + +`func (o *PutConnectorSourceTemplateRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *PutConnectorSourceTemplateRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *PutConnectorSourceTemplateRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/PutPasswordDictionaryRequest.md b/docs/tools/sdk/go/Reference/V3/Models/PutPasswordDictionaryRequest.md new file mode 100644 index 000000000..5d32d290e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/PutPasswordDictionaryRequest.md @@ -0,0 +1,64 @@ +--- +id: put-password-dictionary-request +title: PutPasswordDictionaryRequest +pagination_label: PutPasswordDictionaryRequest +sidebar_label: PutPasswordDictionaryRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'PutPasswordDictionaryRequest', 'PutPasswordDictionaryRequest'] +slug: /tools/sdk/go/v3/models/put-password-dictionary-request +tags: ['SDK', 'Software Development Kit', 'PutPasswordDictionaryRequest', 'PutPasswordDictionaryRequest'] +--- + +# PutPasswordDictionaryRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | Pointer to ***os.File** | | [optional] + +## Methods + +### NewPutPasswordDictionaryRequest + +`func NewPutPasswordDictionaryRequest() *PutPasswordDictionaryRequest` + +NewPutPasswordDictionaryRequest instantiates a new PutPasswordDictionaryRequest 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 + +### NewPutPasswordDictionaryRequestWithDefaults + +`func NewPutPasswordDictionaryRequestWithDefaults() *PutPasswordDictionaryRequest` + +NewPutPasswordDictionaryRequestWithDefaults instantiates a new PutPasswordDictionaryRequest 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 + +### GetFile + +`func (o *PutPasswordDictionaryRequest) GetFile() *os.File` + +GetFile returns the File field if non-nil, zero value otherwise. + +### GetFileOk + +`func (o *PutPasswordDictionaryRequest) GetFileOk() (**os.File, bool)` + +GetFileOk returns a tuple with the File field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFile + +`func (o *PutPasswordDictionaryRequest) SetFile(v *os.File)` + +SetFile sets File field to given value. + +### HasFile + +`func (o *PutPasswordDictionaryRequest) HasFile() bool` + +HasFile returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Query.md b/docs/tools/sdk/go/Reference/V3/Models/Query.md new file mode 100644 index 000000000..a25246874 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Query.md @@ -0,0 +1,142 @@ +--- +id: query +title: Query +pagination_label: Query +sidebar_label: Query +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Query', 'Query'] +slug: /tools/sdk/go/v3/models/query +tags: ['SDK', 'Software Development Kit', 'Query', 'Query'] +--- + +# Query + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | Pointer to **string** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [optional] +**Fields** | Pointer to **string** | The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of \"a*\" to be applied to \"name\", \"firstName\", and the \"source.name\". The response will include all results matching the \"a*\" query found in those three fields. A field's availability depends on the indices being searched. For example, if you are searching \"identities\", you can apply your search to the \"firstName\" field, but you couldn't use \"firstName\" with a search on \"access profiles\". Refer to the response schema for the respective lists of available fields. | [optional] +**TimeZone** | Pointer to **string** | The time zone to be applied to any range query related to dates. | [optional] +**InnerHit** | Pointer to [**InnerHit**](inner-hit) | | [optional] + +## Methods + +### NewQuery + +`func NewQuery() *Query` + +NewQuery instantiates a new Query 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 + +### NewQueryWithDefaults + +`func NewQueryWithDefaults() *Query` + +NewQueryWithDefaults instantiates a new Query 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 + +### GetQuery + +`func (o *Query) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *Query) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *Query) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *Query) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### GetFields + +`func (o *Query) GetFields() string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *Query) GetFieldsOk() (*string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *Query) SetFields(v string)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *Query) HasFields() bool` + +HasFields returns a boolean if a field has been set. + +### GetTimeZone + +`func (o *Query) GetTimeZone() string` + +GetTimeZone returns the TimeZone field if non-nil, zero value otherwise. + +### GetTimeZoneOk + +`func (o *Query) GetTimeZoneOk() (*string, bool)` + +GetTimeZoneOk returns a tuple with the TimeZone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZone + +`func (o *Query) SetTimeZone(v string)` + +SetTimeZone sets TimeZone field to given value. + +### HasTimeZone + +`func (o *Query) HasTimeZone() bool` + +HasTimeZone returns a boolean if a field has been set. + +### GetInnerHit + +`func (o *Query) GetInnerHit() InnerHit` + +GetInnerHit returns the InnerHit field if non-nil, zero value otherwise. + +### GetInnerHitOk + +`func (o *Query) GetInnerHitOk() (*InnerHit, bool)` + +GetInnerHitOk returns a tuple with the InnerHit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInnerHit + +`func (o *Query) SetInnerHit(v InnerHit)` + +SetInnerHit sets InnerHit field to given value. + +### HasInnerHit + +`func (o *Query) HasInnerHit() bool` + +HasInnerHit returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/QueryResultFilter.md b/docs/tools/sdk/go/Reference/V3/Models/QueryResultFilter.md new file mode 100644 index 000000000..c0db7e7ad --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/QueryResultFilter.md @@ -0,0 +1,90 @@ +--- +id: query-result-filter +title: QueryResultFilter +pagination_label: QueryResultFilter +sidebar_label: QueryResultFilter +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'QueryResultFilter', 'QueryResultFilter'] +slug: /tools/sdk/go/v3/models/query-result-filter +tags: ['SDK', 'Software Development Kit', 'QueryResultFilter', 'QueryResultFilter'] +--- + +# QueryResultFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Includes** | Pointer to **[]string** | The list of field names to include in the result documents. | [optional] +**Excludes** | Pointer to **[]string** | The list of field names to exclude from the result documents. | [optional] + +## Methods + +### NewQueryResultFilter + +`func NewQueryResultFilter() *QueryResultFilter` + +NewQueryResultFilter instantiates a new QueryResultFilter 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 + +### NewQueryResultFilterWithDefaults + +`func NewQueryResultFilterWithDefaults() *QueryResultFilter` + +NewQueryResultFilterWithDefaults instantiates a new QueryResultFilter 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 + +### GetIncludes + +`func (o *QueryResultFilter) GetIncludes() []string` + +GetIncludes returns the Includes field if non-nil, zero value otherwise. + +### GetIncludesOk + +`func (o *QueryResultFilter) GetIncludesOk() (*[]string, bool)` + +GetIncludesOk returns a tuple with the Includes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludes + +`func (o *QueryResultFilter) SetIncludes(v []string)` + +SetIncludes sets Includes field to given value. + +### HasIncludes + +`func (o *QueryResultFilter) HasIncludes() bool` + +HasIncludes returns a boolean if a field has been set. + +### GetExcludes + +`func (o *QueryResultFilter) GetExcludes() []string` + +GetExcludes returns the Excludes field if non-nil, zero value otherwise. + +### GetExcludesOk + +`func (o *QueryResultFilter) GetExcludesOk() (*[]string, bool)` + +GetExcludesOk returns a tuple with the Excludes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExcludes + +`func (o *QueryResultFilter) SetExcludes(v []string)` + +SetExcludes sets Excludes field to given value. + +### HasExcludes + +`func (o *QueryResultFilter) HasExcludes() bool` + +HasExcludes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/QueryType.md b/docs/tools/sdk/go/Reference/V3/Models/QueryType.md new file mode 100644 index 000000000..69a69ea8c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/QueryType.md @@ -0,0 +1,25 @@ +--- +id: query-type +title: QueryType +pagination_label: QueryType +sidebar_label: QueryType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'QueryType', 'QueryType'] +slug: /tools/sdk/go/v3/models/query-type +tags: ['SDK', 'Software Development Kit', 'QueryType', 'QueryType'] +--- + +# QueryType + +## Enum + + +* `DSL` (value: `"DSL"`) + +* `SAILPOINT` (value: `"SAILPOINT"`) + +* `TEXT` (value: `"TEXT"`) + +* `TYPEAHEAD` (value: `"TYPEAHEAD"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/QueuedCheckConfigDetails.md b/docs/tools/sdk/go/Reference/V3/Models/QueuedCheckConfigDetails.md new file mode 100644 index 000000000..941cb552f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/QueuedCheckConfigDetails.md @@ -0,0 +1,80 @@ +--- +id: queued-check-config-details +title: QueuedCheckConfigDetails +pagination_label: QueuedCheckConfigDetails +sidebar_label: QueuedCheckConfigDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'QueuedCheckConfigDetails', 'QueuedCheckConfigDetails'] +slug: /tools/sdk/go/v3/models/queued-check-config-details +tags: ['SDK', 'Software Development Kit', 'QueuedCheckConfigDetails', 'QueuedCheckConfigDetails'] +--- + +# QueuedCheckConfigDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProvisioningStatusCheckIntervalMinutes** | **string** | Interval in minutes between status checks | +**ProvisioningMaxStatusCheckDays** | **string** | Maximum number of days to check | + +## Methods + +### NewQueuedCheckConfigDetails + +`func NewQueuedCheckConfigDetails(provisioningStatusCheckIntervalMinutes string, provisioningMaxStatusCheckDays string, ) *QueuedCheckConfigDetails` + +NewQueuedCheckConfigDetails instantiates a new QueuedCheckConfigDetails 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 + +### NewQueuedCheckConfigDetailsWithDefaults + +`func NewQueuedCheckConfigDetailsWithDefaults() *QueuedCheckConfigDetails` + +NewQueuedCheckConfigDetailsWithDefaults instantiates a new QueuedCheckConfigDetails 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 + +### GetProvisioningStatusCheckIntervalMinutes + +`func (o *QueuedCheckConfigDetails) GetProvisioningStatusCheckIntervalMinutes() string` + +GetProvisioningStatusCheckIntervalMinutes returns the ProvisioningStatusCheckIntervalMinutes field if non-nil, zero value otherwise. + +### GetProvisioningStatusCheckIntervalMinutesOk + +`func (o *QueuedCheckConfigDetails) GetProvisioningStatusCheckIntervalMinutesOk() (*string, bool)` + +GetProvisioningStatusCheckIntervalMinutesOk returns a tuple with the ProvisioningStatusCheckIntervalMinutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningStatusCheckIntervalMinutes + +`func (o *QueuedCheckConfigDetails) SetProvisioningStatusCheckIntervalMinutes(v string)` + +SetProvisioningStatusCheckIntervalMinutes sets ProvisioningStatusCheckIntervalMinutes field to given value. + + +### GetProvisioningMaxStatusCheckDays + +`func (o *QueuedCheckConfigDetails) GetProvisioningMaxStatusCheckDays() string` + +GetProvisioningMaxStatusCheckDays returns the ProvisioningMaxStatusCheckDays field if non-nil, zero value otherwise. + +### GetProvisioningMaxStatusCheckDaysOk + +`func (o *QueuedCheckConfigDetails) GetProvisioningMaxStatusCheckDaysOk() (*string, bool)` + +GetProvisioningMaxStatusCheckDaysOk returns a tuple with the ProvisioningMaxStatusCheckDays field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningMaxStatusCheckDays + +`func (o *QueuedCheckConfigDetails) SetProvisioningMaxStatusCheckDays(v string)` + +SetProvisioningMaxStatusCheckDays sets ProvisioningMaxStatusCheckDays field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Range.md b/docs/tools/sdk/go/Reference/V3/Models/Range.md new file mode 100644 index 000000000..b895f494d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Range.md @@ -0,0 +1,90 @@ +--- +id: range +title: Range +pagination_label: Range +sidebar_label: Range +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Range', 'Range'] +slug: /tools/sdk/go/v3/models/range +tags: ['SDK', 'Software Development Kit', 'Range', 'Range'] +--- + +# Range + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Lower** | Pointer to [**Bound**](bound) | | [optional] +**Upper** | Pointer to [**Bound**](bound) | | [optional] + +## Methods + +### NewRange + +`func NewRange() *Range` + +NewRange instantiates a new Range 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 + +### NewRangeWithDefaults + +`func NewRangeWithDefaults() *Range` + +NewRangeWithDefaults instantiates a new Range 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 + +### GetLower + +`func (o *Range) GetLower() Bound` + +GetLower returns the Lower field if non-nil, zero value otherwise. + +### GetLowerOk + +`func (o *Range) GetLowerOk() (*Bound, bool)` + +GetLowerOk returns a tuple with the Lower field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLower + +`func (o *Range) SetLower(v Bound)` + +SetLower sets Lower field to given value. + +### HasLower + +`func (o *Range) HasLower() bool` + +HasLower returns a boolean if a field has been set. + +### GetUpper + +`func (o *Range) GetUpper() Bound` + +GetUpper returns the Upper field if non-nil, zero value otherwise. + +### GetUpperOk + +`func (o *Range) GetUpperOk() (*Bound, bool)` + +GetUpperOk returns a tuple with the Upper field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpper + +`func (o *Range) SetUpper(v Bound)` + +SetUpper sets Upper field to given value. + +### HasUpper + +`func (o *Range) HasUpper() bool` + +HasUpper returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReassignReference.md b/docs/tools/sdk/go/Reference/V3/Models/ReassignReference.md new file mode 100644 index 000000000..cc4ed343a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReassignReference.md @@ -0,0 +1,80 @@ +--- +id: reassign-reference +title: ReassignReference +pagination_label: ReassignReference +sidebar_label: ReassignReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignReference', 'ReassignReference'] +slug: /tools/sdk/go/v3/models/reassign-reference +tags: ['SDK', 'Software Development Kit', 'ReassignReference', 'ReassignReference'] +--- + +# ReassignReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The ID of item or identity being reassigned. | +**Type** | **string** | The type of item or identity being reassigned. | + +## Methods + +### NewReassignReference + +`func NewReassignReference(id string, type_ string, ) *ReassignReference` + +NewReassignReference instantiates a new ReassignReference 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 + +### NewReassignReferenceWithDefaults + +`func NewReassignReferenceWithDefaults() *ReassignReference` + +NewReassignReferenceWithDefaults instantiates a new ReassignReference 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 + +### GetId + +`func (o *ReassignReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReassignReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReassignReference) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *ReassignReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReassignReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReassignReference) SetType(v string)` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Reassignment.md b/docs/tools/sdk/go/Reference/V3/Models/Reassignment.md new file mode 100644 index 000000000..3a6acd9b2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Reassignment.md @@ -0,0 +1,90 @@ +--- +id: reassignment +title: Reassignment +pagination_label: Reassignment +sidebar_label: Reassignment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Reassignment', 'Reassignment'] +slug: /tools/sdk/go/v3/models/reassignment +tags: ['SDK', 'Software Development Kit', 'Reassignment', 'Reassignment'] +--- + +# Reassignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**From** | Pointer to [**CertificationReference**](certification-reference) | | [optional] +**Comment** | Pointer to **string** | The comment entered when the Certification was reassigned | [optional] + +## Methods + +### NewReassignment + +`func NewReassignment() *Reassignment` + +NewReassignment instantiates a new Reassignment 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 + +### NewReassignmentWithDefaults + +`func NewReassignmentWithDefaults() *Reassignment` + +NewReassignmentWithDefaults instantiates a new Reassignment 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 + +### GetFrom + +`func (o *Reassignment) GetFrom() CertificationReference` + +GetFrom returns the From field if non-nil, zero value otherwise. + +### GetFromOk + +`func (o *Reassignment) GetFromOk() (*CertificationReference, bool)` + +GetFromOk returns a tuple with the From field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrom + +`func (o *Reassignment) SetFrom(v CertificationReference)` + +SetFrom sets From field to given value. + +### HasFrom + +`func (o *Reassignment) HasFrom() bool` + +HasFrom returns a boolean if a field has been set. + +### GetComment + +`func (o *Reassignment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *Reassignment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *Reassignment) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *Reassignment) HasComment() bool` + +HasComment returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReassignmentReference.md b/docs/tools/sdk/go/Reference/V3/Models/ReassignmentReference.md new file mode 100644 index 000000000..e450c3f6e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReassignmentReference.md @@ -0,0 +1,80 @@ +--- +id: reassignment-reference +title: ReassignmentReference +pagination_label: ReassignmentReference +sidebar_label: ReassignmentReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignmentReference', 'ReassignmentReference'] +slug: /tools/sdk/go/v3/models/reassignment-reference +tags: ['SDK', 'Software Development Kit', 'ReassignmentReference', 'ReassignmentReference'] +--- + +# ReassignmentReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The ID of item or identity being reassigned. | +**Type** | **string** | The type of item or identity being reassigned. | + +## Methods + +### NewReassignmentReference + +`func NewReassignmentReference(id string, type_ string, ) *ReassignmentReference` + +NewReassignmentReference instantiates a new ReassignmentReference 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 + +### NewReassignmentReferenceWithDefaults + +`func NewReassignmentReferenceWithDefaults() *ReassignmentReference` + +NewReassignmentReferenceWithDefaults instantiates a new ReassignmentReference 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 + +### GetId + +`func (o *ReassignmentReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReassignmentReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReassignmentReference) SetId(v string)` + +SetId sets Id field to given value. + + +### GetType + +`func (o *ReassignmentReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReassignmentReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReassignmentReference) SetType(v string)` + +SetType sets Type field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReassignmentTrailDTO.md b/docs/tools/sdk/go/Reference/V3/Models/ReassignmentTrailDTO.md new file mode 100644 index 000000000..2e8ddb41b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReassignmentTrailDTO.md @@ -0,0 +1,116 @@ +--- +id: reassignment-trail-dto +title: ReassignmentTrailDTO +pagination_label: ReassignmentTrailDTO +sidebar_label: ReassignmentTrailDTO +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignmentTrailDTO', 'ReassignmentTrailDTO'] +slug: /tools/sdk/go/v3/models/reassignment-trail-dto +tags: ['SDK', 'Software Development Kit', 'ReassignmentTrailDTO', 'ReassignmentTrailDTO'] +--- + +# ReassignmentTrailDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PreviousOwner** | Pointer to **string** | The ID of previous owner identity. | [optional] +**NewOwner** | Pointer to **string** | The ID of new owner identity. | [optional] +**ReassignmentType** | Pointer to **string** | The type of reassignment. | [optional] + +## Methods + +### NewReassignmentTrailDTO + +`func NewReassignmentTrailDTO() *ReassignmentTrailDTO` + +NewReassignmentTrailDTO instantiates a new ReassignmentTrailDTO 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 + +### NewReassignmentTrailDTOWithDefaults + +`func NewReassignmentTrailDTOWithDefaults() *ReassignmentTrailDTO` + +NewReassignmentTrailDTOWithDefaults instantiates a new ReassignmentTrailDTO 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 + +### GetPreviousOwner + +`func (o *ReassignmentTrailDTO) GetPreviousOwner() string` + +GetPreviousOwner returns the PreviousOwner field if non-nil, zero value otherwise. + +### GetPreviousOwnerOk + +`func (o *ReassignmentTrailDTO) GetPreviousOwnerOk() (*string, bool)` + +GetPreviousOwnerOk returns a tuple with the PreviousOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreviousOwner + +`func (o *ReassignmentTrailDTO) SetPreviousOwner(v string)` + +SetPreviousOwner sets PreviousOwner field to given value. + +### HasPreviousOwner + +`func (o *ReassignmentTrailDTO) HasPreviousOwner() bool` + +HasPreviousOwner returns a boolean if a field has been set. + +### GetNewOwner + +`func (o *ReassignmentTrailDTO) GetNewOwner() string` + +GetNewOwner returns the NewOwner field if non-nil, zero value otherwise. + +### GetNewOwnerOk + +`func (o *ReassignmentTrailDTO) GetNewOwnerOk() (*string, bool)` + +GetNewOwnerOk returns a tuple with the NewOwner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNewOwner + +`func (o *ReassignmentTrailDTO) SetNewOwner(v string)` + +SetNewOwner sets NewOwner field to given value. + +### HasNewOwner + +`func (o *ReassignmentTrailDTO) HasNewOwner() bool` + +HasNewOwner returns a boolean if a field has been set. + +### GetReassignmentType + +`func (o *ReassignmentTrailDTO) GetReassignmentType() string` + +GetReassignmentType returns the ReassignmentType field if non-nil, zero value otherwise. + +### GetReassignmentTypeOk + +`func (o *ReassignmentTrailDTO) GetReassignmentTypeOk() (*string, bool)` + +GetReassignmentTypeOk returns a tuple with the ReassignmentType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignmentType + +`func (o *ReassignmentTrailDTO) SetReassignmentType(v string)` + +SetReassignmentType sets ReassignmentType field to given value. + +### HasReassignmentType + +`func (o *ReassignmentTrailDTO) HasReassignmentType() bool` + +HasReassignmentType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReassignmentType.md b/docs/tools/sdk/go/Reference/V3/Models/ReassignmentType.md new file mode 100644 index 000000000..a0b56e370 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReassignmentType.md @@ -0,0 +1,25 @@ +--- +id: reassignment-type +title: ReassignmentType +pagination_label: ReassignmentType +sidebar_label: ReassignmentType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReassignmentType', 'ReassignmentType'] +slug: /tools/sdk/go/v3/models/reassignment-type +tags: ['SDK', 'Software Development Kit', 'ReassignmentType', 'ReassignmentType'] +--- + +# ReassignmentType + +## Enum + + +* `MANUAL_REASSIGNMENT` (value: `"MANUAL_REASSIGNMENT"`) + +* `AUTOMATIC_REASSIGNMENT` (value: `"AUTOMATIC_REASSIGNMENT"`) + +* `AUTO_ESCALATION` (value: `"AUTO_ESCALATION"`) + +* `SELF_REVIEW_DELEGATION` (value: `"SELF_REVIEW_DELEGATION"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Recommendation.md b/docs/tools/sdk/go/Reference/V3/Models/Recommendation.md new file mode 100644 index 000000000..c9d24921f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Recommendation.md @@ -0,0 +1,80 @@ +--- +id: recommendation +title: Recommendation +pagination_label: Recommendation +sidebar_label: Recommendation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Recommendation', 'Recommendation'] +slug: /tools/sdk/go/v3/models/recommendation +tags: ['SDK', 'Software Development Kit', 'Recommendation', 'Recommendation'] +--- + +# Recommendation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Recommended type of account. | +**Method** | **string** | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | + +## Methods + +### NewRecommendation + +`func NewRecommendation(type_ string, method string, ) *Recommendation` + +NewRecommendation instantiates a new Recommendation 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 + +### NewRecommendationWithDefaults + +`func NewRecommendationWithDefaults() *Recommendation` + +NewRecommendationWithDefaults instantiates a new Recommendation 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 + +### GetType + +`func (o *Recommendation) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Recommendation) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Recommendation) SetType(v string)` + +SetType sets Type field to given value. + + +### GetMethod + +`func (o *Recommendation) GetMethod() string` + +GetMethod returns the Method field if non-nil, zero value otherwise. + +### GetMethodOk + +`func (o *Recommendation) GetMethodOk() (*string, bool)` + +GetMethodOk returns a tuple with the Method field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMethod + +`func (o *Recommendation) SetMethod(v string)` + +SetMethod sets Method field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Reference.md b/docs/tools/sdk/go/Reference/V3/Models/Reference.md new file mode 100644 index 000000000..f322773b7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Reference.md @@ -0,0 +1,90 @@ +--- +id: reference +title: Reference +pagination_label: Reference +sidebar_label: Reference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Reference', 'Reference'] +slug: /tools/sdk/go/v3/models/reference +tags: ['SDK', 'Software Development Kit', 'Reference', 'Reference'] +--- + +# Reference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] + +## Methods + +### NewReference + +`func NewReference() *Reference` + +NewReference instantiates a new Reference 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 + +### NewReferenceWithDefaults + +`func NewReferenceWithDefaults() *Reference` + +NewReferenceWithDefaults instantiates a new Reference 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 + +### GetId + +`func (o *Reference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Reference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Reference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Reference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Reference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Reference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Reference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Reference) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RemediationItemDetails.md b/docs/tools/sdk/go/Reference/V3/Models/RemediationItemDetails.md new file mode 100644 index 000000000..b9d650566 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RemediationItemDetails.md @@ -0,0 +1,272 @@ +--- +id: remediation-item-details +title: RemediationItemDetails +pagination_label: RemediationItemDetails +sidebar_label: RemediationItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RemediationItemDetails', 'RemediationItemDetails'] +slug: /tools/sdk/go/v3/models/remediation-item-details +tags: ['SDK', 'Software Development Kit', 'RemediationItemDetails', 'RemediationItemDetails'] +--- + +# RemediationItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the certification | [optional] +**TargetId** | Pointer to **string** | The ID of the certification target | [optional] +**TargetName** | Pointer to **string** | The name of the certification target | [optional] +**TargetDisplayName** | Pointer to **string** | The display name of the certification target | [optional] +**ApplicationName** | Pointer to **string** | The name of the application/source | [optional] +**AttributeName** | Pointer to **string** | The name of the attribute being certified | [optional] +**AttributeOperation** | Pointer to **string** | The operation of the certification on the attribute | [optional] +**AttributeValue** | Pointer to **string** | The value of the attribute being certified | [optional] +**NativeIdentity** | Pointer to **string** | The native identity of the target | [optional] + +## Methods + +### NewRemediationItemDetails + +`func NewRemediationItemDetails() *RemediationItemDetails` + +NewRemediationItemDetails instantiates a new RemediationItemDetails 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 + +### NewRemediationItemDetailsWithDefaults + +`func NewRemediationItemDetailsWithDefaults() *RemediationItemDetails` + +NewRemediationItemDetailsWithDefaults instantiates a new RemediationItemDetails 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 + +### GetId + +`func (o *RemediationItemDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RemediationItemDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RemediationItemDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RemediationItemDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetTargetId + +`func (o *RemediationItemDetails) GetTargetId() string` + +GetTargetId returns the TargetId field if non-nil, zero value otherwise. + +### GetTargetIdOk + +`func (o *RemediationItemDetails) GetTargetIdOk() (*string, bool)` + +GetTargetIdOk returns a tuple with the TargetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetId + +`func (o *RemediationItemDetails) SetTargetId(v string)` + +SetTargetId sets TargetId field to given value. + +### HasTargetId + +`func (o *RemediationItemDetails) HasTargetId() bool` + +HasTargetId returns a boolean if a field has been set. + +### GetTargetName + +`func (o *RemediationItemDetails) GetTargetName() string` + +GetTargetName returns the TargetName field if non-nil, zero value otherwise. + +### GetTargetNameOk + +`func (o *RemediationItemDetails) GetTargetNameOk() (*string, bool)` + +GetTargetNameOk returns a tuple with the TargetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetName + +`func (o *RemediationItemDetails) SetTargetName(v string)` + +SetTargetName sets TargetName field to given value. + +### HasTargetName + +`func (o *RemediationItemDetails) HasTargetName() bool` + +HasTargetName returns a boolean if a field has been set. + +### GetTargetDisplayName + +`func (o *RemediationItemDetails) GetTargetDisplayName() string` + +GetTargetDisplayName returns the TargetDisplayName field if non-nil, zero value otherwise. + +### GetTargetDisplayNameOk + +`func (o *RemediationItemDetails) GetTargetDisplayNameOk() (*string, bool)` + +GetTargetDisplayNameOk returns a tuple with the TargetDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetDisplayName + +`func (o *RemediationItemDetails) SetTargetDisplayName(v string)` + +SetTargetDisplayName sets TargetDisplayName field to given value. + +### HasTargetDisplayName + +`func (o *RemediationItemDetails) HasTargetDisplayName() bool` + +HasTargetDisplayName returns a boolean if a field has been set. + +### GetApplicationName + +`func (o *RemediationItemDetails) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *RemediationItemDetails) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *RemediationItemDetails) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *RemediationItemDetails) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *RemediationItemDetails) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *RemediationItemDetails) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *RemediationItemDetails) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *RemediationItemDetails) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + +### GetAttributeOperation + +`func (o *RemediationItemDetails) GetAttributeOperation() string` + +GetAttributeOperation returns the AttributeOperation field if non-nil, zero value otherwise. + +### GetAttributeOperationOk + +`func (o *RemediationItemDetails) GetAttributeOperationOk() (*string, bool)` + +GetAttributeOperationOk returns a tuple with the AttributeOperation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeOperation + +`func (o *RemediationItemDetails) SetAttributeOperation(v string)` + +SetAttributeOperation sets AttributeOperation field to given value. + +### HasAttributeOperation + +`func (o *RemediationItemDetails) HasAttributeOperation() bool` + +HasAttributeOperation returns a boolean if a field has been set. + +### GetAttributeValue + +`func (o *RemediationItemDetails) GetAttributeValue() string` + +GetAttributeValue returns the AttributeValue field if non-nil, zero value otherwise. + +### GetAttributeValueOk + +`func (o *RemediationItemDetails) GetAttributeValueOk() (*string, bool)` + +GetAttributeValueOk returns a tuple with the AttributeValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeValue + +`func (o *RemediationItemDetails) SetAttributeValue(v string)` + +SetAttributeValue sets AttributeValue field to given value. + +### HasAttributeValue + +`func (o *RemediationItemDetails) HasAttributeValue() bool` + +HasAttributeValue returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *RemediationItemDetails) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *RemediationItemDetails) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *RemediationItemDetails) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *RemediationItemDetails) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RemediationItems.md b/docs/tools/sdk/go/Reference/V3/Models/RemediationItems.md new file mode 100644 index 000000000..5336cae9e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RemediationItems.md @@ -0,0 +1,272 @@ +--- +id: remediation-items +title: RemediationItems +pagination_label: RemediationItems +sidebar_label: RemediationItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RemediationItems', 'RemediationItems'] +slug: /tools/sdk/go/v3/models/remediation-items +tags: ['SDK', 'Software Development Kit', 'RemediationItems', 'RemediationItems'] +--- + +# RemediationItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the certification | [optional] +**TargetId** | Pointer to **string** | The ID of the certification target | [optional] +**TargetName** | Pointer to **string** | The name of the certification target | [optional] +**TargetDisplayName** | Pointer to **string** | The display name of the certification target | [optional] +**ApplicationName** | Pointer to **string** | The name of the application/source | [optional] +**AttributeName** | Pointer to **string** | The name of the attribute being certified | [optional] +**AttributeOperation** | Pointer to **string** | The operation of the certification on the attribute | [optional] +**AttributeValue** | Pointer to **string** | The value of the attribute being certified | [optional] +**NativeIdentity** | Pointer to **string** | The native identity of the target | [optional] + +## Methods + +### NewRemediationItems + +`func NewRemediationItems() *RemediationItems` + +NewRemediationItems instantiates a new RemediationItems 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 + +### NewRemediationItemsWithDefaults + +`func NewRemediationItemsWithDefaults() *RemediationItems` + +NewRemediationItemsWithDefaults instantiates a new RemediationItems 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 + +### GetId + +`func (o *RemediationItems) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RemediationItems) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RemediationItems) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RemediationItems) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetTargetId + +`func (o *RemediationItems) GetTargetId() string` + +GetTargetId returns the TargetId field if non-nil, zero value otherwise. + +### GetTargetIdOk + +`func (o *RemediationItems) GetTargetIdOk() (*string, bool)` + +GetTargetIdOk returns a tuple with the TargetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetId + +`func (o *RemediationItems) SetTargetId(v string)` + +SetTargetId sets TargetId field to given value. + +### HasTargetId + +`func (o *RemediationItems) HasTargetId() bool` + +HasTargetId returns a boolean if a field has been set. + +### GetTargetName + +`func (o *RemediationItems) GetTargetName() string` + +GetTargetName returns the TargetName field if non-nil, zero value otherwise. + +### GetTargetNameOk + +`func (o *RemediationItems) GetTargetNameOk() (*string, bool)` + +GetTargetNameOk returns a tuple with the TargetName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetName + +`func (o *RemediationItems) SetTargetName(v string)` + +SetTargetName sets TargetName field to given value. + +### HasTargetName + +`func (o *RemediationItems) HasTargetName() bool` + +HasTargetName returns a boolean if a field has been set. + +### GetTargetDisplayName + +`func (o *RemediationItems) GetTargetDisplayName() string` + +GetTargetDisplayName returns the TargetDisplayName field if non-nil, zero value otherwise. + +### GetTargetDisplayNameOk + +`func (o *RemediationItems) GetTargetDisplayNameOk() (*string, bool)` + +GetTargetDisplayNameOk returns a tuple with the TargetDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetDisplayName + +`func (o *RemediationItems) SetTargetDisplayName(v string)` + +SetTargetDisplayName sets TargetDisplayName field to given value. + +### HasTargetDisplayName + +`func (o *RemediationItems) HasTargetDisplayName() bool` + +HasTargetDisplayName returns a boolean if a field has been set. + +### GetApplicationName + +`func (o *RemediationItems) GetApplicationName() string` + +GetApplicationName returns the ApplicationName field if non-nil, zero value otherwise. + +### GetApplicationNameOk + +`func (o *RemediationItems) GetApplicationNameOk() (*string, bool)` + +GetApplicationNameOk returns a tuple with the ApplicationName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationName + +`func (o *RemediationItems) SetApplicationName(v string)` + +SetApplicationName sets ApplicationName field to given value. + +### HasApplicationName + +`func (o *RemediationItems) HasApplicationName() bool` + +HasApplicationName returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *RemediationItems) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *RemediationItems) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *RemediationItems) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *RemediationItems) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + +### GetAttributeOperation + +`func (o *RemediationItems) GetAttributeOperation() string` + +GetAttributeOperation returns the AttributeOperation field if non-nil, zero value otherwise. + +### GetAttributeOperationOk + +`func (o *RemediationItems) GetAttributeOperationOk() (*string, bool)` + +GetAttributeOperationOk returns a tuple with the AttributeOperation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeOperation + +`func (o *RemediationItems) SetAttributeOperation(v string)` + +SetAttributeOperation sets AttributeOperation field to given value. + +### HasAttributeOperation + +`func (o *RemediationItems) HasAttributeOperation() bool` + +HasAttributeOperation returns a boolean if a field has been set. + +### GetAttributeValue + +`func (o *RemediationItems) GetAttributeValue() string` + +GetAttributeValue returns the AttributeValue field if non-nil, zero value otherwise. + +### GetAttributeValueOk + +`func (o *RemediationItems) GetAttributeValueOk() (*string, bool)` + +GetAttributeValueOk returns a tuple with the AttributeValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeValue + +`func (o *RemediationItems) SetAttributeValue(v string)` + +SetAttributeValue sets AttributeValue field to given value. + +### HasAttributeValue + +`func (o *RemediationItems) HasAttributeValue() bool` + +HasAttributeValue returns a boolean if a field has been set. + +### GetNativeIdentity + +`func (o *RemediationItems) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *RemediationItems) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *RemediationItems) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *RemediationItems) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReportDetails.md b/docs/tools/sdk/go/Reference/V3/Models/ReportDetails.md new file mode 100644 index 000000000..0caa5d7fc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReportDetails.md @@ -0,0 +1,90 @@ +--- +id: report-details +title: ReportDetails +pagination_label: ReportDetails +sidebar_label: ReportDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportDetails', 'ReportDetails'] +slug: /tools/sdk/go/v3/models/report-details +tags: ['SDK', 'Software Development Kit', 'ReportDetails', 'ReportDetails'] +--- + +# ReportDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReportType** | Pointer to **string** | Use this property to define what report should be processed in the RDE service. | [optional] +**Arguments** | Pointer to [**ReportDetailsArguments**](report-details-arguments) | | [optional] + +## Methods + +### NewReportDetails + +`func NewReportDetails() *ReportDetails` + +NewReportDetails instantiates a new ReportDetails 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 + +### NewReportDetailsWithDefaults + +`func NewReportDetailsWithDefaults() *ReportDetails` + +NewReportDetailsWithDefaults instantiates a new ReportDetails 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 + +### GetReportType + +`func (o *ReportDetails) GetReportType() string` + +GetReportType returns the ReportType field if non-nil, zero value otherwise. + +### GetReportTypeOk + +`func (o *ReportDetails) GetReportTypeOk() (*string, bool)` + +GetReportTypeOk returns a tuple with the ReportType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportType + +`func (o *ReportDetails) SetReportType(v string)` + +SetReportType sets ReportType field to given value. + +### HasReportType + +`func (o *ReportDetails) HasReportType() bool` + +HasReportType returns a boolean if a field has been set. + +### GetArguments + +`func (o *ReportDetails) GetArguments() ReportDetailsArguments` + +GetArguments returns the Arguments field if non-nil, zero value otherwise. + +### GetArgumentsOk + +`func (o *ReportDetails) GetArgumentsOk() (*ReportDetailsArguments, bool)` + +GetArgumentsOk returns a tuple with the Arguments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArguments + +`func (o *ReportDetails) SetArguments(v ReportDetailsArguments)` + +SetArguments sets Arguments field to given value. + +### HasArguments + +`func (o *ReportDetails) HasArguments() bool` + +HasArguments returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReportDetailsArguments.md b/docs/tools/sdk/go/Reference/V3/Models/ReportDetailsArguments.md new file mode 100644 index 000000000..64079051e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReportDetailsArguments.md @@ -0,0 +1,247 @@ +--- +id: report-details-arguments +title: ReportDetailsArguments +pagination_label: ReportDetailsArguments +sidebar_label: ReportDetailsArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportDetailsArguments', 'ReportDetailsArguments'] +slug: /tools/sdk/go/v3/models/report-details-arguments +tags: ['SDK', 'Software Development Kit', 'ReportDetailsArguments', 'ReportDetailsArguments'] +--- + +# ReportDetailsArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Application** | **string** | Source ID. | +**SourceName** | **string** | Source name. | +**CorrelatedOnly** | **bool** | Flag to specify if only correlated identities are included in report. | [default to false] +**AuthoritativeSource** | **string** | Source ID. | +**SelectedFormats** | Pointer to **[]string** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] +**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**Query** | **string** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | +**Columns** | Pointer to **string** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] + +## Methods + +### NewReportDetailsArguments + +`func NewReportDetailsArguments(application string, sourceName string, correlatedOnly bool, authoritativeSource string, query string, ) *ReportDetailsArguments` + +NewReportDetailsArguments instantiates a new ReportDetailsArguments 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 + +### NewReportDetailsArgumentsWithDefaults + +`func NewReportDetailsArgumentsWithDefaults() *ReportDetailsArguments` + +NewReportDetailsArgumentsWithDefaults instantiates a new ReportDetailsArguments 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 + +### GetApplication + +`func (o *ReportDetailsArguments) GetApplication() string` + +GetApplication returns the Application field if non-nil, zero value otherwise. + +### GetApplicationOk + +`func (o *ReportDetailsArguments) GetApplicationOk() (*string, bool)` + +GetApplicationOk returns a tuple with the Application field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplication + +`func (o *ReportDetailsArguments) SetApplication(v string)` + +SetApplication sets Application field to given value. + + +### GetSourceName + +`func (o *ReportDetailsArguments) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *ReportDetailsArguments) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *ReportDetailsArguments) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + + +### GetCorrelatedOnly + +`func (o *ReportDetailsArguments) GetCorrelatedOnly() bool` + +GetCorrelatedOnly returns the CorrelatedOnly field if non-nil, zero value otherwise. + +### GetCorrelatedOnlyOk + +`func (o *ReportDetailsArguments) GetCorrelatedOnlyOk() (*bool, bool)` + +GetCorrelatedOnlyOk returns a tuple with the CorrelatedOnly field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedOnly + +`func (o *ReportDetailsArguments) SetCorrelatedOnly(v bool)` + +SetCorrelatedOnly sets CorrelatedOnly field to given value. + + +### GetAuthoritativeSource + +`func (o *ReportDetailsArguments) GetAuthoritativeSource() string` + +GetAuthoritativeSource returns the AuthoritativeSource field if non-nil, zero value otherwise. + +### GetAuthoritativeSourceOk + +`func (o *ReportDetailsArguments) GetAuthoritativeSourceOk() (*string, bool)` + +GetAuthoritativeSourceOk returns a tuple with the AuthoritativeSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritativeSource + +`func (o *ReportDetailsArguments) SetAuthoritativeSource(v string)` + +SetAuthoritativeSource sets AuthoritativeSource field to given value. + + +### GetSelectedFormats + +`func (o *ReportDetailsArguments) GetSelectedFormats() []string` + +GetSelectedFormats returns the SelectedFormats field if non-nil, zero value otherwise. + +### GetSelectedFormatsOk + +`func (o *ReportDetailsArguments) GetSelectedFormatsOk() (*[]string, bool)` + +GetSelectedFormatsOk returns a tuple with the SelectedFormats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectedFormats + +`func (o *ReportDetailsArguments) SetSelectedFormats(v []string)` + +SetSelectedFormats sets SelectedFormats field to given value. + +### HasSelectedFormats + +`func (o *ReportDetailsArguments) HasSelectedFormats() bool` + +HasSelectedFormats returns a boolean if a field has been set. + +### GetIndices + +`func (o *ReportDetailsArguments) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *ReportDetailsArguments) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *ReportDetailsArguments) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + +### HasIndices + +`func (o *ReportDetailsArguments) HasIndices() bool` + +HasIndices returns a boolean if a field has been set. + +### GetQuery + +`func (o *ReportDetailsArguments) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *ReportDetailsArguments) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *ReportDetailsArguments) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetColumns + +`func (o *ReportDetailsArguments) GetColumns() string` + +GetColumns returns the Columns field if non-nil, zero value otherwise. + +### GetColumnsOk + +`func (o *ReportDetailsArguments) GetColumnsOk() (*string, bool)` + +GetColumnsOk returns a tuple with the Columns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumns + +`func (o *ReportDetailsArguments) SetColumns(v string)` + +SetColumns sets Columns field to given value. + +### HasColumns + +`func (o *ReportDetailsArguments) HasColumns() bool` + +HasColumns returns a boolean if a field has been set. + +### GetSort + +`func (o *ReportDetailsArguments) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *ReportDetailsArguments) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *ReportDetailsArguments) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *ReportDetailsArguments) HasSort() bool` + +HasSort returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReportResultReference.md b/docs/tools/sdk/go/Reference/V3/Models/ReportResultReference.md new file mode 100644 index 000000000..0c822fd10 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReportResultReference.md @@ -0,0 +1,142 @@ +--- +id: report-result-reference +title: ReportResultReference +pagination_label: ReportResultReference +sidebar_label: ReportResultReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportResultReference', 'ReportResultReference'] +slug: /tools/sdk/go/v3/models/report-result-reference +tags: ['SDK', 'Software Development Kit', 'ReportResultReference', 'ReportResultReference'] +--- + +# ReportResultReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **string** | Human-readable name of the SOD policy violation report result. | [optional] +**Status** | Pointer to **string** | Status of a SOD policy violation report. | [optional] + +## Methods + +### NewReportResultReference + +`func NewReportResultReference() *ReportResultReference` + +NewReportResultReference instantiates a new ReportResultReference 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 + +### NewReportResultReferenceWithDefaults + +`func NewReportResultReferenceWithDefaults() *ReportResultReference` + +NewReportResultReferenceWithDefaults instantiates a new ReportResultReference 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 + +### GetType + +`func (o *ReportResultReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReportResultReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReportResultReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ReportResultReference) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ReportResultReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReportResultReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReportResultReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReportResultReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ReportResultReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ReportResultReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ReportResultReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ReportResultReference) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetStatus + +`func (o *ReportResultReference) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ReportResultReference) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ReportResultReference) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ReportResultReference) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReportResults.md b/docs/tools/sdk/go/Reference/V3/Models/ReportResults.md new file mode 100644 index 000000000..7a26481c0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReportResults.md @@ -0,0 +1,246 @@ +--- +id: report-results +title: ReportResults +pagination_label: ReportResults +sidebar_label: ReportResults +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportResults', 'ReportResults'] +slug: /tools/sdk/go/v3/models/report-results +tags: ['SDK', 'Software Development Kit', 'ReportResults', 'ReportResults'] +--- + +# ReportResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReportType** | Pointer to **string** | Use this property to define what report should be processed in the RDE service. | [optional] +**TaskDefName** | Pointer to **string** | Name of the task definition which is started to process requesting report. Usually the same as report name | [optional] +**Id** | Pointer to **string** | Unique task definition identifier. | [optional] +**Created** | Pointer to **SailPointTime** | Report processing start date | [optional] +**Status** | Pointer to **string** | Report current state or result status. | [optional] +**Duration** | Pointer to **int64** | Report processing time in ms. | [optional] +**Rows** | Pointer to **int64** | Report size in rows. | [optional] +**AvailableFormats** | Pointer to **[]string** | Output report file formats. This are formats for calling get endpoint as a query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] + +## Methods + +### NewReportResults + +`func NewReportResults() *ReportResults` + +NewReportResults instantiates a new ReportResults 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 + +### NewReportResultsWithDefaults + +`func NewReportResultsWithDefaults() *ReportResults` + +NewReportResultsWithDefaults instantiates a new ReportResults 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 + +### GetReportType + +`func (o *ReportResults) GetReportType() string` + +GetReportType returns the ReportType field if non-nil, zero value otherwise. + +### GetReportTypeOk + +`func (o *ReportResults) GetReportTypeOk() (*string, bool)` + +GetReportTypeOk returns a tuple with the ReportType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportType + +`func (o *ReportResults) SetReportType(v string)` + +SetReportType sets ReportType field to given value. + +### HasReportType + +`func (o *ReportResults) HasReportType() bool` + +HasReportType returns a boolean if a field has been set. + +### GetTaskDefName + +`func (o *ReportResults) GetTaskDefName() string` + +GetTaskDefName returns the TaskDefName field if non-nil, zero value otherwise. + +### GetTaskDefNameOk + +`func (o *ReportResults) GetTaskDefNameOk() (*string, bool)` + +GetTaskDefNameOk returns a tuple with the TaskDefName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTaskDefName + +`func (o *ReportResults) SetTaskDefName(v string)` + +SetTaskDefName sets TaskDefName field to given value. + +### HasTaskDefName + +`func (o *ReportResults) HasTaskDefName() bool` + +HasTaskDefName returns a boolean if a field has been set. + +### GetId + +`func (o *ReportResults) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReportResults) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReportResults) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReportResults) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCreated + +`func (o *ReportResults) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ReportResults) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ReportResults) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ReportResults) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetStatus + +`func (o *ReportResults) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ReportResults) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ReportResults) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ReportResults) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetDuration + +`func (o *ReportResults) GetDuration() int64` + +GetDuration returns the Duration field if non-nil, zero value otherwise. + +### GetDurationOk + +`func (o *ReportResults) GetDurationOk() (*int64, bool)` + +GetDurationOk returns a tuple with the Duration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDuration + +`func (o *ReportResults) SetDuration(v int64)` + +SetDuration sets Duration field to given value. + +### HasDuration + +`func (o *ReportResults) HasDuration() bool` + +HasDuration returns a boolean if a field has been set. + +### GetRows + +`func (o *ReportResults) GetRows() int64` + +GetRows returns the Rows field if non-nil, zero value otherwise. + +### GetRowsOk + +`func (o *ReportResults) GetRowsOk() (*int64, bool)` + +GetRowsOk returns a tuple with the Rows field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRows + +`func (o *ReportResults) SetRows(v int64)` + +SetRows sets Rows field to given value. + +### HasRows + +`func (o *ReportResults) HasRows() bool` + +HasRows returns a boolean if a field has been set. + +### GetAvailableFormats + +`func (o *ReportResults) GetAvailableFormats() []string` + +GetAvailableFormats returns the AvailableFormats field if non-nil, zero value otherwise. + +### GetAvailableFormatsOk + +`func (o *ReportResults) GetAvailableFormatsOk() (*[]string, bool)` + +GetAvailableFormatsOk returns a tuple with the AvailableFormats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAvailableFormats + +`func (o *ReportResults) SetAvailableFormats(v []string)` + +SetAvailableFormats sets AvailableFormats field to given value. + +### HasAvailableFormats + +`func (o *ReportResults) HasAvailableFormats() bool` + +HasAvailableFormats returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReportType.md b/docs/tools/sdk/go/Reference/V3/Models/ReportType.md new file mode 100644 index 000000000..abdc589cf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReportType.md @@ -0,0 +1,25 @@ +--- +id: report-type +title: ReportType +pagination_label: ReportType +sidebar_label: ReportType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReportType', 'ReportType'] +slug: /tools/sdk/go/v3/models/report-type +tags: ['SDK', 'Software Development Kit', 'ReportType', 'ReportType'] +--- + +# ReportType + +## Enum + + +* `CAMPAIGN_COMPOSITION_REPORT` (value: `"CAMPAIGN_COMPOSITION_REPORT"`) + +* `CAMPAIGN_REMEDIATION_STATUS_REPORT` (value: `"CAMPAIGN_REMEDIATION_STATUS_REPORT"`) + +* `CAMPAIGN_STATUS_REPORT` (value: `"CAMPAIGN_STATUS_REPORT"`) + +* `CERTIFICATION_SIGNOFF_REPORT` (value: `"CERTIFICATION_SIGNOFF_REPORT"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestOnBehalfOfConfig.md b/docs/tools/sdk/go/Reference/V3/Models/RequestOnBehalfOfConfig.md new file mode 100644 index 000000000..5039ccca7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestOnBehalfOfConfig.md @@ -0,0 +1,90 @@ +--- +id: request-on-behalf-of-config +title: RequestOnBehalfOfConfig +pagination_label: RequestOnBehalfOfConfig +sidebar_label: RequestOnBehalfOfConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestOnBehalfOfConfig', 'RequestOnBehalfOfConfig'] +slug: /tools/sdk/go/v3/models/request-on-behalf-of-config +tags: ['SDK', 'Software Development Kit', 'RequestOnBehalfOfConfig', 'RequestOnBehalfOfConfig'] +--- + +# RequestOnBehalfOfConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AllowRequestOnBehalfOfAnyoneByAnyone** | Pointer to **bool** | If this is true, anyone can request access for anyone. | [optional] [default to false] +**AllowRequestOnBehalfOfEmployeeByManager** | Pointer to **bool** | If this is true, a manager can request access for his or her direct reports. | [optional] [default to false] + +## Methods + +### NewRequestOnBehalfOfConfig + +`func NewRequestOnBehalfOfConfig() *RequestOnBehalfOfConfig` + +NewRequestOnBehalfOfConfig instantiates a new RequestOnBehalfOfConfig 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 + +### NewRequestOnBehalfOfConfigWithDefaults + +`func NewRequestOnBehalfOfConfigWithDefaults() *RequestOnBehalfOfConfig` + +NewRequestOnBehalfOfConfigWithDefaults instantiates a new RequestOnBehalfOfConfig 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 + +### GetAllowRequestOnBehalfOfAnyoneByAnyone + +`func (o *RequestOnBehalfOfConfig) GetAllowRequestOnBehalfOfAnyoneByAnyone() bool` + +GetAllowRequestOnBehalfOfAnyoneByAnyone returns the AllowRequestOnBehalfOfAnyoneByAnyone field if non-nil, zero value otherwise. + +### GetAllowRequestOnBehalfOfAnyoneByAnyoneOk + +`func (o *RequestOnBehalfOfConfig) GetAllowRequestOnBehalfOfAnyoneByAnyoneOk() (*bool, bool)` + +GetAllowRequestOnBehalfOfAnyoneByAnyoneOk returns a tuple with the AllowRequestOnBehalfOfAnyoneByAnyone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllowRequestOnBehalfOfAnyoneByAnyone + +`func (o *RequestOnBehalfOfConfig) SetAllowRequestOnBehalfOfAnyoneByAnyone(v bool)` + +SetAllowRequestOnBehalfOfAnyoneByAnyone sets AllowRequestOnBehalfOfAnyoneByAnyone field to given value. + +### HasAllowRequestOnBehalfOfAnyoneByAnyone + +`func (o *RequestOnBehalfOfConfig) HasAllowRequestOnBehalfOfAnyoneByAnyone() bool` + +HasAllowRequestOnBehalfOfAnyoneByAnyone returns a boolean if a field has been set. + +### GetAllowRequestOnBehalfOfEmployeeByManager + +`func (o *RequestOnBehalfOfConfig) GetAllowRequestOnBehalfOfEmployeeByManager() bool` + +GetAllowRequestOnBehalfOfEmployeeByManager returns the AllowRequestOnBehalfOfEmployeeByManager field if non-nil, zero value otherwise. + +### GetAllowRequestOnBehalfOfEmployeeByManagerOk + +`func (o *RequestOnBehalfOfConfig) GetAllowRequestOnBehalfOfEmployeeByManagerOk() (*bool, bool)` + +GetAllowRequestOnBehalfOfEmployeeByManagerOk returns a tuple with the AllowRequestOnBehalfOfEmployeeByManager field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAllowRequestOnBehalfOfEmployeeByManager + +`func (o *RequestOnBehalfOfConfig) SetAllowRequestOnBehalfOfEmployeeByManager(v bool)` + +SetAllowRequestOnBehalfOfEmployeeByManager sets AllowRequestOnBehalfOfEmployeeByManager field to given value. + +### HasAllowRequestOnBehalfOfEmployeeByManager + +`func (o *RequestOnBehalfOfConfig) HasAllowRequestOnBehalfOfEmployeeByManager() bool` + +HasAllowRequestOnBehalfOfEmployeeByManager returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Requestability.md b/docs/tools/sdk/go/Reference/V3/Models/Requestability.md new file mode 100644 index 000000000..516e53c45 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Requestability.md @@ -0,0 +1,182 @@ +--- +id: requestability +title: Requestability +pagination_label: Requestability +sidebar_label: Requestability +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Requestability', 'Requestability'] +slug: /tools/sdk/go/v3/models/requestability +tags: ['SDK', 'Software Development Kit', 'Requestability', 'Requestability'] +--- + +# Requestability + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **NullableBool** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to false] +**DenialCommentsRequired** | Pointer to **NullableBool** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to false] +**ReauthorizationRequired** | Pointer to **NullableBool** | Indicates whether reauthorization is required for the request. | [optional] [default to false] +**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] + +## Methods + +### NewRequestability + +`func NewRequestability() *Requestability` + +NewRequestability instantiates a new Requestability 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 + +### NewRequestabilityWithDefaults + +`func NewRequestabilityWithDefaults() *Requestability` + +NewRequestabilityWithDefaults instantiates a new Requestability 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 + +### GetCommentsRequired + +`func (o *Requestability) GetCommentsRequired() bool` + +GetCommentsRequired returns the CommentsRequired field if non-nil, zero value otherwise. + +### GetCommentsRequiredOk + +`func (o *Requestability) GetCommentsRequiredOk() (*bool, bool)` + +GetCommentsRequiredOk returns a tuple with the CommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentsRequired + +`func (o *Requestability) SetCommentsRequired(v bool)` + +SetCommentsRequired sets CommentsRequired field to given value. + +### HasCommentsRequired + +`func (o *Requestability) HasCommentsRequired() bool` + +HasCommentsRequired returns a boolean if a field has been set. + +### SetCommentsRequiredNil + +`func (o *Requestability) SetCommentsRequiredNil(b bool)` + + SetCommentsRequiredNil sets the value for CommentsRequired to be an explicit nil + +### UnsetCommentsRequired +`func (o *Requestability) UnsetCommentsRequired()` + +UnsetCommentsRequired ensures that no value is present for CommentsRequired, not even an explicit nil +### GetDenialCommentsRequired + +`func (o *Requestability) GetDenialCommentsRequired() bool` + +GetDenialCommentsRequired returns the DenialCommentsRequired field if non-nil, zero value otherwise. + +### GetDenialCommentsRequiredOk + +`func (o *Requestability) GetDenialCommentsRequiredOk() (*bool, bool)` + +GetDenialCommentsRequiredOk returns a tuple with the DenialCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenialCommentsRequired + +`func (o *Requestability) SetDenialCommentsRequired(v bool)` + +SetDenialCommentsRequired sets DenialCommentsRequired field to given value. + +### HasDenialCommentsRequired + +`func (o *Requestability) HasDenialCommentsRequired() bool` + +HasDenialCommentsRequired returns a boolean if a field has been set. + +### SetDenialCommentsRequiredNil + +`func (o *Requestability) SetDenialCommentsRequiredNil(b bool)` + + SetDenialCommentsRequiredNil sets the value for DenialCommentsRequired to be an explicit nil + +### UnsetDenialCommentsRequired +`func (o *Requestability) UnsetDenialCommentsRequired()` + +UnsetDenialCommentsRequired ensures that no value is present for DenialCommentsRequired, not even an explicit nil +### GetReauthorizationRequired + +`func (o *Requestability) GetReauthorizationRequired() bool` + +GetReauthorizationRequired returns the ReauthorizationRequired field if non-nil, zero value otherwise. + +### GetReauthorizationRequiredOk + +`func (o *Requestability) GetReauthorizationRequiredOk() (*bool, bool)` + +GetReauthorizationRequiredOk returns a tuple with the ReauthorizationRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReauthorizationRequired + +`func (o *Requestability) SetReauthorizationRequired(v bool)` + +SetReauthorizationRequired sets ReauthorizationRequired field to given value. + +### HasReauthorizationRequired + +`func (o *Requestability) HasReauthorizationRequired() bool` + +HasReauthorizationRequired returns a boolean if a field has been set. + +### SetReauthorizationRequiredNil + +`func (o *Requestability) SetReauthorizationRequiredNil(b bool)` + + SetReauthorizationRequiredNil sets the value for ReauthorizationRequired to be an explicit nil + +### UnsetReauthorizationRequired +`func (o *Requestability) UnsetReauthorizationRequired()` + +UnsetReauthorizationRequired ensures that no value is present for ReauthorizationRequired, not even an explicit nil +### GetApprovalSchemes + +`func (o *Requestability) GetApprovalSchemes() []AccessProfileApprovalScheme` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *Requestability) GetApprovalSchemesOk() (*[]AccessProfileApprovalScheme, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *Requestability) SetApprovalSchemes(v []AccessProfileApprovalScheme)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *Requestability) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + +### SetApprovalSchemesNil + +`func (o *Requestability) SetApprovalSchemesNil(b bool)` + + SetApprovalSchemesNil sets the value for ApprovalSchemes to be an explicit nil + +### UnsetApprovalSchemes +`func (o *Requestability) UnsetApprovalSchemes()` + +UnsetApprovalSchemes ensures that no value is present for ApprovalSchemes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestabilityForRole.md b/docs/tools/sdk/go/Reference/V3/Models/RequestabilityForRole.md new file mode 100644 index 000000000..171f7f407 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestabilityForRole.md @@ -0,0 +1,172 @@ +--- +id: requestability-for-role +title: RequestabilityForRole +pagination_label: RequestabilityForRole +sidebar_label: RequestabilityForRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestabilityForRole', 'RequestabilityForRole'] +slug: /tools/sdk/go/v3/models/requestability-for-role +tags: ['SDK', 'Software Development Kit', 'RequestabilityForRole', 'RequestabilityForRole'] +--- + +# RequestabilityForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **NullableBool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to false] +**DenialCommentsRequired** | Pointer to **NullableBool** | Whether an approver must provide comments when denying the request | [optional] [default to false] +**ReauthorizationRequired** | Pointer to **NullableBool** | Indicates whether reauthorization is required for the request. | [optional] [default to false] +**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] + +## Methods + +### NewRequestabilityForRole + +`func NewRequestabilityForRole() *RequestabilityForRole` + +NewRequestabilityForRole instantiates a new RequestabilityForRole 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 + +### NewRequestabilityForRoleWithDefaults + +`func NewRequestabilityForRoleWithDefaults() *RequestabilityForRole` + +NewRequestabilityForRoleWithDefaults instantiates a new RequestabilityForRole 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 + +### GetCommentsRequired + +`func (o *RequestabilityForRole) GetCommentsRequired() bool` + +GetCommentsRequired returns the CommentsRequired field if non-nil, zero value otherwise. + +### GetCommentsRequiredOk + +`func (o *RequestabilityForRole) GetCommentsRequiredOk() (*bool, bool)` + +GetCommentsRequiredOk returns a tuple with the CommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentsRequired + +`func (o *RequestabilityForRole) SetCommentsRequired(v bool)` + +SetCommentsRequired sets CommentsRequired field to given value. + +### HasCommentsRequired + +`func (o *RequestabilityForRole) HasCommentsRequired() bool` + +HasCommentsRequired returns a boolean if a field has been set. + +### SetCommentsRequiredNil + +`func (o *RequestabilityForRole) SetCommentsRequiredNil(b bool)` + + SetCommentsRequiredNil sets the value for CommentsRequired to be an explicit nil + +### UnsetCommentsRequired +`func (o *RequestabilityForRole) UnsetCommentsRequired()` + +UnsetCommentsRequired ensures that no value is present for CommentsRequired, not even an explicit nil +### GetDenialCommentsRequired + +`func (o *RequestabilityForRole) GetDenialCommentsRequired() bool` + +GetDenialCommentsRequired returns the DenialCommentsRequired field if non-nil, zero value otherwise. + +### GetDenialCommentsRequiredOk + +`func (o *RequestabilityForRole) GetDenialCommentsRequiredOk() (*bool, bool)` + +GetDenialCommentsRequiredOk returns a tuple with the DenialCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenialCommentsRequired + +`func (o *RequestabilityForRole) SetDenialCommentsRequired(v bool)` + +SetDenialCommentsRequired sets DenialCommentsRequired field to given value. + +### HasDenialCommentsRequired + +`func (o *RequestabilityForRole) HasDenialCommentsRequired() bool` + +HasDenialCommentsRequired returns a boolean if a field has been set. + +### SetDenialCommentsRequiredNil + +`func (o *RequestabilityForRole) SetDenialCommentsRequiredNil(b bool)` + + SetDenialCommentsRequiredNil sets the value for DenialCommentsRequired to be an explicit nil + +### UnsetDenialCommentsRequired +`func (o *RequestabilityForRole) UnsetDenialCommentsRequired()` + +UnsetDenialCommentsRequired ensures that no value is present for DenialCommentsRequired, not even an explicit nil +### GetReauthorizationRequired + +`func (o *RequestabilityForRole) GetReauthorizationRequired() bool` + +GetReauthorizationRequired returns the ReauthorizationRequired field if non-nil, zero value otherwise. + +### GetReauthorizationRequiredOk + +`func (o *RequestabilityForRole) GetReauthorizationRequiredOk() (*bool, bool)` + +GetReauthorizationRequiredOk returns a tuple with the ReauthorizationRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReauthorizationRequired + +`func (o *RequestabilityForRole) SetReauthorizationRequired(v bool)` + +SetReauthorizationRequired sets ReauthorizationRequired field to given value. + +### HasReauthorizationRequired + +`func (o *RequestabilityForRole) HasReauthorizationRequired() bool` + +HasReauthorizationRequired returns a boolean if a field has been set. + +### SetReauthorizationRequiredNil + +`func (o *RequestabilityForRole) SetReauthorizationRequiredNil(b bool)` + + SetReauthorizationRequiredNil sets the value for ReauthorizationRequired to be an explicit nil + +### UnsetReauthorizationRequired +`func (o *RequestabilityForRole) UnsetReauthorizationRequired()` + +UnsetReauthorizationRequired ensures that no value is present for ReauthorizationRequired, not even an explicit nil +### GetApprovalSchemes + +`func (o *RequestabilityForRole) GetApprovalSchemes() []ApprovalSchemeForRole` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *RequestabilityForRole) GetApprovalSchemesOk() (*[]ApprovalSchemeForRole, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *RequestabilityForRole) SetApprovalSchemes(v []ApprovalSchemeForRole)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *RequestabilityForRole) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestableObject.md b/docs/tools/sdk/go/Reference/V3/Models/RequestableObject.md new file mode 100644 index 000000000..10286c958 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestableObject.md @@ -0,0 +1,338 @@ +--- +id: requestable-object +title: RequestableObject +pagination_label: RequestableObject +sidebar_label: RequestableObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObject', 'RequestableObject'] +slug: /tools/sdk/go/v3/models/requestable-object +tags: ['SDK', 'Software Development Kit', 'RequestableObject', 'RequestableObject'] +--- + +# RequestableObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the requestable object itself | [optional] +**Name** | Pointer to **string** | Human-readable display name of the requestable object | [optional] +**Created** | Pointer to **SailPointTime** | The time when the requestable object was created | [optional] +**Modified** | Pointer to **NullableTime** | The time when the requestable object was last modified | [optional] +**Description** | Pointer to **NullableString** | Description of the requestable object. | [optional] +**Type** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional] +**RequestStatus** | Pointer to [**RequestableObjectRequestStatus**](requestable-object-request-status) | | [optional] +**IdentityRequestId** | Pointer to **NullableString** | If *requestStatus* is *PENDING*, indicates the id of the associated account activity. | [optional] +**OwnerRef** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**RequestCommentsRequired** | Pointer to **bool** | Whether the requester must provide comments when requesting the object. | [optional] + +## Methods + +### NewRequestableObject + +`func NewRequestableObject() *RequestableObject` + +NewRequestableObject instantiates a new RequestableObject 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 + +### NewRequestableObjectWithDefaults + +`func NewRequestableObjectWithDefaults() *RequestableObject` + +NewRequestableObjectWithDefaults instantiates a new RequestableObject 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 + +### GetId + +`func (o *RequestableObject) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestableObject) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestableObject) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestableObject) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RequestableObject) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestableObject) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestableObject) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestableObject) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *RequestableObject) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RequestableObject) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RequestableObject) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RequestableObject) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *RequestableObject) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RequestableObject) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RequestableObject) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RequestableObject) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *RequestableObject) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *RequestableObject) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDescription + +`func (o *RequestableObject) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RequestableObject) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RequestableObject) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RequestableObject) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RequestableObject) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RequestableObject) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *RequestableObject) GetType() RequestableObjectType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestableObject) GetTypeOk() (*RequestableObjectType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestableObject) SetType(v RequestableObjectType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestableObject) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRequestStatus + +`func (o *RequestableObject) GetRequestStatus() RequestableObjectRequestStatus` + +GetRequestStatus returns the RequestStatus field if non-nil, zero value otherwise. + +### GetRequestStatusOk + +`func (o *RequestableObject) GetRequestStatusOk() (*RequestableObjectRequestStatus, bool)` + +GetRequestStatusOk returns a tuple with the RequestStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestStatus + +`func (o *RequestableObject) SetRequestStatus(v RequestableObjectRequestStatus)` + +SetRequestStatus sets RequestStatus field to given value. + +### HasRequestStatus + +`func (o *RequestableObject) HasRequestStatus() bool` + +HasRequestStatus returns a boolean if a field has been set. + +### GetIdentityRequestId + +`func (o *RequestableObject) GetIdentityRequestId() string` + +GetIdentityRequestId returns the IdentityRequestId field if non-nil, zero value otherwise. + +### GetIdentityRequestIdOk + +`func (o *RequestableObject) GetIdentityRequestIdOk() (*string, bool)` + +GetIdentityRequestIdOk returns a tuple with the IdentityRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityRequestId + +`func (o *RequestableObject) SetIdentityRequestId(v string)` + +SetIdentityRequestId sets IdentityRequestId field to given value. + +### HasIdentityRequestId + +`func (o *RequestableObject) HasIdentityRequestId() bool` + +HasIdentityRequestId returns a boolean if a field has been set. + +### SetIdentityRequestIdNil + +`func (o *RequestableObject) SetIdentityRequestIdNil(b bool)` + + SetIdentityRequestIdNil sets the value for IdentityRequestId to be an explicit nil + +### UnsetIdentityRequestId +`func (o *RequestableObject) UnsetIdentityRequestId()` + +UnsetIdentityRequestId ensures that no value is present for IdentityRequestId, not even an explicit nil +### GetOwnerRef + +`func (o *RequestableObject) GetOwnerRef() IdentityReferenceWithNameAndEmail` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *RequestableObject) GetOwnerRefOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *RequestableObject) SetOwnerRef(v IdentityReferenceWithNameAndEmail)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *RequestableObject) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### SetOwnerRefNil + +`func (o *RequestableObject) SetOwnerRefNil(b bool)` + + SetOwnerRefNil sets the value for OwnerRef to be an explicit nil + +### UnsetOwnerRef +`func (o *RequestableObject) UnsetOwnerRef()` + +UnsetOwnerRef ensures that no value is present for OwnerRef, not even an explicit nil +### GetRequestCommentsRequired + +`func (o *RequestableObject) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *RequestableObject) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *RequestableObject) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *RequestableObject) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestableObjectReference.md b/docs/tools/sdk/go/Reference/V3/Models/RequestableObjectReference.md new file mode 100644 index 000000000..1451a07ca --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestableObjectReference.md @@ -0,0 +1,142 @@ +--- +id: requestable-object-reference +title: RequestableObjectReference +pagination_label: RequestableObjectReference +sidebar_label: RequestableObjectReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObjectReference', 'RequestableObjectReference'] +slug: /tools/sdk/go/v3/models/requestable-object-reference +tags: ['SDK', 'Software Development Kit', 'RequestableObjectReference', 'RequestableObjectReference'] +--- + +# RequestableObjectReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the object. | [optional] +**Name** | Pointer to **string** | Name of the object. | [optional] +**Description** | Pointer to **string** | Description of the object. | [optional] +**Type** | Pointer to **string** | Type of the object. | [optional] + +## Methods + +### NewRequestableObjectReference + +`func NewRequestableObjectReference() *RequestableObjectReference` + +NewRequestableObjectReference instantiates a new RequestableObjectReference 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 + +### NewRequestableObjectReferenceWithDefaults + +`func NewRequestableObjectReferenceWithDefaults() *RequestableObjectReference` + +NewRequestableObjectReferenceWithDefaults instantiates a new RequestableObjectReference 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 + +### GetId + +`func (o *RequestableObjectReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestableObjectReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestableObjectReference) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestableObjectReference) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RequestableObjectReference) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestableObjectReference) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestableObjectReference) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestableObjectReference) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RequestableObjectReference) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RequestableObjectReference) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RequestableObjectReference) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RequestableObjectReference) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetType + +`func (o *RequestableObjectReference) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestableObjectReference) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestableObjectReference) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestableObjectReference) HasType() bool` + +HasType returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestableObjectRequestStatus.md b/docs/tools/sdk/go/Reference/V3/Models/RequestableObjectRequestStatus.md new file mode 100644 index 000000000..f37547fc2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestableObjectRequestStatus.md @@ -0,0 +1,23 @@ +--- +id: requestable-object-request-status +title: RequestableObjectRequestStatus +pagination_label: RequestableObjectRequestStatus +sidebar_label: RequestableObjectRequestStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObjectRequestStatus', 'RequestableObjectRequestStatus'] +slug: /tools/sdk/go/v3/models/requestable-object-request-status +tags: ['SDK', 'Software Development Kit', 'RequestableObjectRequestStatus', 'RequestableObjectRequestStatus'] +--- + +# RequestableObjectRequestStatus + +## Enum + + +* `AVAILABLE` (value: `"AVAILABLE"`) + +* `PENDING` (value: `"PENDING"`) + +* `ASSIGNED` (value: `"ASSIGNED"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestableObjectType.md b/docs/tools/sdk/go/Reference/V3/Models/RequestableObjectType.md new file mode 100644 index 000000000..40efc650b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestableObjectType.md @@ -0,0 +1,23 @@ +--- +id: requestable-object-type +title: RequestableObjectType +pagination_label: RequestableObjectType +sidebar_label: RequestableObjectType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestableObjectType', 'RequestableObjectType'] +slug: /tools/sdk/go/v3/models/requestable-object-type +tags: ['SDK', 'Software Development Kit', 'RequestableObjectType', 'RequestableObjectType'] +--- + +# RequestableObjectType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestedAccountRef.md b/docs/tools/sdk/go/Reference/V3/Models/RequestedAccountRef.md new file mode 100644 index 000000000..d576efbd9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestedAccountRef.md @@ -0,0 +1,188 @@ +--- +id: requested-account-ref +title: RequestedAccountRef +pagination_label: RequestedAccountRef +sidebar_label: RequestedAccountRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedAccountRef', 'RequestedAccountRef'] +slug: /tools/sdk/go/v3/models/requested-account-ref +tags: ['SDK', 'Software Development Kit', 'RequestedAccountRef', 'RequestedAccountRef'] +--- + +# RequestedAccountRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Display name of the account for the user | [optional] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**AccountUuid** | Pointer to **NullableString** | The uuid for the account | [optional] +**AccountId** | Pointer to **NullableString** | The native identity for the account | [optional] +**SourceName** | Pointer to **string** | Display name of the source for the account | [optional] + +## Methods + +### NewRequestedAccountRef + +`func NewRequestedAccountRef() *RequestedAccountRef` + +NewRequestedAccountRef instantiates a new RequestedAccountRef 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 + +### NewRequestedAccountRefWithDefaults + +`func NewRequestedAccountRefWithDefaults() *RequestedAccountRef` + +NewRequestedAccountRefWithDefaults instantiates a new RequestedAccountRef 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 + +### GetName + +`func (o *RequestedAccountRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestedAccountRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestedAccountRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestedAccountRef) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *RequestedAccountRef) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedAccountRef) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedAccountRef) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedAccountRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetAccountUuid + +`func (o *RequestedAccountRef) GetAccountUuid() string` + +GetAccountUuid returns the AccountUuid field if non-nil, zero value otherwise. + +### GetAccountUuidOk + +`func (o *RequestedAccountRef) GetAccountUuidOk() (*string, bool)` + +GetAccountUuidOk returns a tuple with the AccountUuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountUuid + +`func (o *RequestedAccountRef) SetAccountUuid(v string)` + +SetAccountUuid sets AccountUuid field to given value. + +### HasAccountUuid + +`func (o *RequestedAccountRef) HasAccountUuid() bool` + +HasAccountUuid returns a boolean if a field has been set. + +### SetAccountUuidNil + +`func (o *RequestedAccountRef) SetAccountUuidNil(b bool)` + + SetAccountUuidNil sets the value for AccountUuid to be an explicit nil + +### UnsetAccountUuid +`func (o *RequestedAccountRef) UnsetAccountUuid()` + +UnsetAccountUuid ensures that no value is present for AccountUuid, not even an explicit nil +### GetAccountId + +`func (o *RequestedAccountRef) GetAccountId() string` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *RequestedAccountRef) GetAccountIdOk() (*string, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountId + +`func (o *RequestedAccountRef) SetAccountId(v string)` + +SetAccountId sets AccountId field to given value. + +### HasAccountId + +`func (o *RequestedAccountRef) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountIdNil + +`func (o *RequestedAccountRef) SetAccountIdNil(b bool)` + + SetAccountIdNil sets the value for AccountId to be an explicit nil + +### UnsetAccountId +`func (o *RequestedAccountRef) UnsetAccountId()` + +UnsetAccountId ensures that no value is present for AccountId, not even an explicit nil +### GetSourceName + +`func (o *RequestedAccountRef) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *RequestedAccountRef) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *RequestedAccountRef) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *RequestedAccountRef) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestedForDtoRef.md b/docs/tools/sdk/go/Reference/V3/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..9a18f5178 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestedForDtoRef.md @@ -0,0 +1,80 @@ +--- +id: requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedForDtoRef', 'RequestedForDtoRef'] +slug: /tools/sdk/go/v3/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'RequestedForDtoRef'] +--- + +# RequestedForDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **string** | The identity id for which the access is requested | +**RequestedItems** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | + +## Methods + +### NewRequestedForDtoRef + +`func NewRequestedForDtoRef(identityId string, requestedItems []RequestedItemDtoRef, ) *RequestedForDtoRef` + +NewRequestedForDtoRef instantiates a new RequestedForDtoRef 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 + +### NewRequestedForDtoRefWithDefaults + +`func NewRequestedForDtoRefWithDefaults() *RequestedForDtoRef` + +NewRequestedForDtoRefWithDefaults instantiates a new RequestedForDtoRef 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 + +### GetIdentityId + +`func (o *RequestedForDtoRef) GetIdentityId() string` + +GetIdentityId returns the IdentityId field if non-nil, zero value otherwise. + +### GetIdentityIdOk + +`func (o *RequestedForDtoRef) GetIdentityIdOk() (*string, bool)` + +GetIdentityIdOk returns a tuple with the IdentityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityId + +`func (o *RequestedForDtoRef) SetIdentityId(v string)` + +SetIdentityId sets IdentityId field to given value. + + +### GetRequestedItems + +`func (o *RequestedForDtoRef) GetRequestedItems() []RequestedItemDtoRef` + +GetRequestedItems returns the RequestedItems field if non-nil, zero value otherwise. + +### GetRequestedItemsOk + +`func (o *RequestedForDtoRef) GetRequestedItemsOk() (*[]RequestedItemDtoRef, bool)` + +GetRequestedItemsOk returns a tuple with the RequestedItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedItems + +`func (o *RequestedForDtoRef) SetRequestedItems(v []RequestedItemDtoRef)` + +SetRequestedItems sets RequestedItems field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestedItemDetails.md b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemDetails.md new file mode 100644 index 000000000..a264bb813 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemDetails.md @@ -0,0 +1,90 @@ +--- +id: requested-item-details +title: RequestedItemDetails +pagination_label: RequestedItemDetails +sidebar_label: RequestedItemDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemDetails', 'RequestedItemDetails'] +slug: /tools/sdk/go/v3/models/requested-item-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemDetails', 'RequestedItemDetails'] +--- + +# RequestedItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of access item requested. | [optional] +**Id** | Pointer to **string** | The id of the access item requested. | [optional] + +## Methods + +### NewRequestedItemDetails + +`func NewRequestedItemDetails() *RequestedItemDetails` + +NewRequestedItemDetails instantiates a new RequestedItemDetails 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 + +### NewRequestedItemDetailsWithDefaults + +`func NewRequestedItemDetailsWithDefaults() *RequestedItemDetails` + +NewRequestedItemDetailsWithDefaults instantiates a new RequestedItemDetails 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 + +### GetType + +`func (o *RequestedItemDetails) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemDetails) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemDetails) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedItemDetails) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RequestedItemDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestedItemDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestedItemDtoRef.md b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..5a1e8ffe4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemDtoRef.md @@ -0,0 +1,266 @@ +--- +id: requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemDtoRef', 'RequestedItemDtoRef'] +slug: /tools/sdk/go/v3/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'RequestedItemDtoRef'] +--- + +# RequestedItemDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of the item being requested. | +**Id** | **string** | ID of Role, Access Profile or Entitlement being requested. | +**Comment** | Pointer to **string** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | Pointer to **SailPointTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | Pointer to **NullableString** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | Pointer to **NullableString** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**AccountSelection** | Pointer to [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] + +## Methods + +### NewRequestedItemDtoRef + +`func NewRequestedItemDtoRef(type_ string, id string, ) *RequestedItemDtoRef` + +NewRequestedItemDtoRef instantiates a new RequestedItemDtoRef 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 + +### NewRequestedItemDtoRefWithDefaults + +`func NewRequestedItemDtoRefWithDefaults() *RequestedItemDtoRef` + +NewRequestedItemDtoRefWithDefaults instantiates a new RequestedItemDtoRef 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 + +### GetType + +`func (o *RequestedItemDtoRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemDtoRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemDtoRef) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *RequestedItemDtoRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemDtoRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemDtoRef) SetId(v string)` + +SetId sets Id field to given value. + + +### GetComment + +`func (o *RequestedItemDtoRef) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *RequestedItemDtoRef) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *RequestedItemDtoRef) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *RequestedItemDtoRef) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *RequestedItemDtoRef) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *RequestedItemDtoRef) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *RequestedItemDtoRef) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *RequestedItemDtoRef) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### GetRemoveDate + +`func (o *RequestedItemDtoRef) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *RequestedItemDtoRef) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *RequestedItemDtoRef) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *RequestedItemDtoRef) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### GetAssignmentId + +`func (o *RequestedItemDtoRef) GetAssignmentId() string` + +GetAssignmentId returns the AssignmentId field if non-nil, zero value otherwise. + +### GetAssignmentIdOk + +`func (o *RequestedItemDtoRef) GetAssignmentIdOk() (*string, bool)` + +GetAssignmentIdOk returns a tuple with the AssignmentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentId + +`func (o *RequestedItemDtoRef) SetAssignmentId(v string)` + +SetAssignmentId sets AssignmentId field to given value. + +### HasAssignmentId + +`func (o *RequestedItemDtoRef) HasAssignmentId() bool` + +HasAssignmentId returns a boolean if a field has been set. + +### SetAssignmentIdNil + +`func (o *RequestedItemDtoRef) SetAssignmentIdNil(b bool)` + + SetAssignmentIdNil sets the value for AssignmentId to be an explicit nil + +### UnsetAssignmentId +`func (o *RequestedItemDtoRef) UnsetAssignmentId()` + +UnsetAssignmentId ensures that no value is present for AssignmentId, not even an explicit nil +### GetNativeIdentity + +`func (o *RequestedItemDtoRef) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *RequestedItemDtoRef) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *RequestedItemDtoRef) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *RequestedItemDtoRef) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### SetNativeIdentityNil + +`func (o *RequestedItemDtoRef) SetNativeIdentityNil(b bool)` + + SetNativeIdentityNil sets the value for NativeIdentity to be an explicit nil + +### UnsetNativeIdentity +`func (o *RequestedItemDtoRef) UnsetNativeIdentity()` + +UnsetNativeIdentity ensures that no value is present for NativeIdentity, not even an explicit nil +### GetAccountSelection + +`func (o *RequestedItemDtoRef) GetAccountSelection() []SourceItemRef` + +GetAccountSelection returns the AccountSelection field if non-nil, zero value otherwise. + +### GetAccountSelectionOk + +`func (o *RequestedItemDtoRef) GetAccountSelectionOk() (*[]SourceItemRef, bool)` + +GetAccountSelectionOk returns a tuple with the AccountSelection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountSelection + +`func (o *RequestedItemDtoRef) SetAccountSelection(v []SourceItemRef)` + +SetAccountSelection sets AccountSelection field to given value. + +### HasAccountSelection + +`func (o *RequestedItemDtoRef) HasAccountSelection() bool` + +HasAccountSelection returns a boolean if a field has been set. + +### SetAccountSelectionNil + +`func (o *RequestedItemDtoRef) SetAccountSelectionNil(b bool)` + + SetAccountSelectionNil sets the value for AccountSelection to be an explicit nil + +### UnsetAccountSelection +`func (o *RequestedItemDtoRef) UnsetAccountSelection()` + +UnsetAccountSelection ensures that no value is present for AccountSelection, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatus.md b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatus.md new file mode 100644 index 000000000..85bb85335 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatus.md @@ -0,0 +1,834 @@ +--- +id: requested-item-status +title: RequestedItemStatus +pagination_label: RequestedItemStatus +sidebar_label: RequestedItemStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatus', 'RequestedItemStatus'] +slug: /tools/sdk/go/v3/models/requested-item-status +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'RequestedItemStatus'] +--- + +# RequestedItemStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the access request. | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the item being requested. | [optional] +**Type** | Pointer to **NullableString** | Type of requested object. | [optional] +**CancelledRequestDetails** | Pointer to [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional] +**ErrorMessages** | Pointer to [**[][]ErrorMessageDto**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional] +**State** | Pointer to [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional] +**ApprovalDetails** | Pointer to [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional] +**ApprovalIds** | Pointer to **[]string** | List of approval IDs associated with the request. | [optional] +**ManualWorkItemDetails** | Pointer to [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional] +**AccountActivityItemId** | Pointer to **string** | Id of associated account activity item. | [optional] +**RequestType** | Pointer to [**NullableAccessRequestType**](access-request-type) | | [optional] +**Modified** | Pointer to **NullableTime** | When the request was last modified. | [optional] +**Created** | Pointer to **SailPointTime** | When the request was created. | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**RequesterComment** | Pointer to [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional] +**SodViolationContext** | Pointer to [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional] +**ProvisioningDetails** | Pointer to [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional] +**PreApprovalTriggerDetails** | Pointer to [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional] +**AccessRequestPhases** | Pointer to [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional] +**Description** | Pointer to **NullableString** | Description associated to the requested object. | [optional] +**RemoveDate** | Pointer to **NullableTime** | When the role access is scheduled for removal. | [optional] +**Cancelable** | Pointer to **bool** | True if the request can be canceled. | [optional] [default to false] +**AccessRequestId** | Pointer to **string** | This is the account activity id. | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] +**RequestedAccounts** | Pointer to [**[]RequestedAccountRef**](requested-account-ref) | The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. | [optional] + +## Methods + +### NewRequestedItemStatus + +`func NewRequestedItemStatus() *RequestedItemStatus` + +NewRequestedItemStatus instantiates a new RequestedItemStatus 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 + +### NewRequestedItemStatusWithDefaults + +`func NewRequestedItemStatusWithDefaults() *RequestedItemStatus` + +NewRequestedItemStatusWithDefaults instantiates a new RequestedItemStatus 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 + +### GetId + +`func (o *RequestedItemStatus) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemStatus) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemStatus) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestedItemStatus) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RequestedItemStatus) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestedItemStatus) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestedItemStatus) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestedItemStatus) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RequestedItemStatus) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RequestedItemStatus) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetType + +`func (o *RequestedItemStatus) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemStatus) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemStatus) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedItemStatus) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *RequestedItemStatus) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *RequestedItemStatus) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetCancelledRequestDetails + +`func (o *RequestedItemStatus) GetCancelledRequestDetails() RequestedItemStatusCancelledRequestDetails` + +GetCancelledRequestDetails returns the CancelledRequestDetails field if non-nil, zero value otherwise. + +### GetCancelledRequestDetailsOk + +`func (o *RequestedItemStatus) GetCancelledRequestDetailsOk() (*RequestedItemStatusCancelledRequestDetails, bool)` + +GetCancelledRequestDetailsOk returns a tuple with the CancelledRequestDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCancelledRequestDetails + +`func (o *RequestedItemStatus) SetCancelledRequestDetails(v RequestedItemStatusCancelledRequestDetails)` + +SetCancelledRequestDetails sets CancelledRequestDetails field to given value. + +### HasCancelledRequestDetails + +`func (o *RequestedItemStatus) HasCancelledRequestDetails() bool` + +HasCancelledRequestDetails returns a boolean if a field has been set. + +### GetErrorMessages + +`func (o *RequestedItemStatus) GetErrorMessages() [][]ErrorMessageDto` + +GetErrorMessages returns the ErrorMessages field if non-nil, zero value otherwise. + +### GetErrorMessagesOk + +`func (o *RequestedItemStatus) GetErrorMessagesOk() (*[][]ErrorMessageDto, bool)` + +GetErrorMessagesOk returns a tuple with the ErrorMessages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessages + +`func (o *RequestedItemStatus) SetErrorMessages(v [][]ErrorMessageDto)` + +SetErrorMessages sets ErrorMessages field to given value. + +### HasErrorMessages + +`func (o *RequestedItemStatus) HasErrorMessages() bool` + +HasErrorMessages returns a boolean if a field has been set. + +### SetErrorMessagesNil + +`func (o *RequestedItemStatus) SetErrorMessagesNil(b bool)` + + SetErrorMessagesNil sets the value for ErrorMessages to be an explicit nil + +### UnsetErrorMessages +`func (o *RequestedItemStatus) UnsetErrorMessages()` + +UnsetErrorMessages ensures that no value is present for ErrorMessages, not even an explicit nil +### GetState + +`func (o *RequestedItemStatus) GetState() RequestedItemStatusRequestState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *RequestedItemStatus) GetStateOk() (*RequestedItemStatusRequestState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *RequestedItemStatus) SetState(v RequestedItemStatusRequestState)` + +SetState sets State field to given value. + +### HasState + +`func (o *RequestedItemStatus) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetApprovalDetails + +`func (o *RequestedItemStatus) GetApprovalDetails() []ApprovalStatusDto` + +GetApprovalDetails returns the ApprovalDetails field if non-nil, zero value otherwise. + +### GetApprovalDetailsOk + +`func (o *RequestedItemStatus) GetApprovalDetailsOk() (*[]ApprovalStatusDto, bool)` + +GetApprovalDetailsOk returns a tuple with the ApprovalDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalDetails + +`func (o *RequestedItemStatus) SetApprovalDetails(v []ApprovalStatusDto)` + +SetApprovalDetails sets ApprovalDetails field to given value. + +### HasApprovalDetails + +`func (o *RequestedItemStatus) HasApprovalDetails() bool` + +HasApprovalDetails returns a boolean if a field has been set. + +### GetApprovalIds + +`func (o *RequestedItemStatus) GetApprovalIds() []string` + +GetApprovalIds returns the ApprovalIds field if non-nil, zero value otherwise. + +### GetApprovalIdsOk + +`func (o *RequestedItemStatus) GetApprovalIdsOk() (*[]string, bool)` + +GetApprovalIdsOk returns a tuple with the ApprovalIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalIds + +`func (o *RequestedItemStatus) SetApprovalIds(v []string)` + +SetApprovalIds sets ApprovalIds field to given value. + +### HasApprovalIds + +`func (o *RequestedItemStatus) HasApprovalIds() bool` + +HasApprovalIds returns a boolean if a field has been set. + +### SetApprovalIdsNil + +`func (o *RequestedItemStatus) SetApprovalIdsNil(b bool)` + + SetApprovalIdsNil sets the value for ApprovalIds to be an explicit nil + +### UnsetApprovalIds +`func (o *RequestedItemStatus) UnsetApprovalIds()` + +UnsetApprovalIds ensures that no value is present for ApprovalIds, not even an explicit nil +### GetManualWorkItemDetails + +`func (o *RequestedItemStatus) GetManualWorkItemDetails() []ManualWorkItemDetails` + +GetManualWorkItemDetails returns the ManualWorkItemDetails field if non-nil, zero value otherwise. + +### GetManualWorkItemDetailsOk + +`func (o *RequestedItemStatus) GetManualWorkItemDetailsOk() (*[]ManualWorkItemDetails, bool)` + +GetManualWorkItemDetailsOk returns a tuple with the ManualWorkItemDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManualWorkItemDetails + +`func (o *RequestedItemStatus) SetManualWorkItemDetails(v []ManualWorkItemDetails)` + +SetManualWorkItemDetails sets ManualWorkItemDetails field to given value. + +### HasManualWorkItemDetails + +`func (o *RequestedItemStatus) HasManualWorkItemDetails() bool` + +HasManualWorkItemDetails returns a boolean if a field has been set. + +### SetManualWorkItemDetailsNil + +`func (o *RequestedItemStatus) SetManualWorkItemDetailsNil(b bool)` + + SetManualWorkItemDetailsNil sets the value for ManualWorkItemDetails to be an explicit nil + +### UnsetManualWorkItemDetails +`func (o *RequestedItemStatus) UnsetManualWorkItemDetails()` + +UnsetManualWorkItemDetails ensures that no value is present for ManualWorkItemDetails, not even an explicit nil +### GetAccountActivityItemId + +`func (o *RequestedItemStatus) GetAccountActivityItemId() string` + +GetAccountActivityItemId returns the AccountActivityItemId field if non-nil, zero value otherwise. + +### GetAccountActivityItemIdOk + +`func (o *RequestedItemStatus) GetAccountActivityItemIdOk() (*string, bool)` + +GetAccountActivityItemIdOk returns a tuple with the AccountActivityItemId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActivityItemId + +`func (o *RequestedItemStatus) SetAccountActivityItemId(v string)` + +SetAccountActivityItemId sets AccountActivityItemId field to given value. + +### HasAccountActivityItemId + +`func (o *RequestedItemStatus) HasAccountActivityItemId() bool` + +HasAccountActivityItemId returns a boolean if a field has been set. + +### GetRequestType + +`func (o *RequestedItemStatus) GetRequestType() AccessRequestType` + +GetRequestType returns the RequestType field if non-nil, zero value otherwise. + +### GetRequestTypeOk + +`func (o *RequestedItemStatus) GetRequestTypeOk() (*AccessRequestType, bool)` + +GetRequestTypeOk returns a tuple with the RequestType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestType + +`func (o *RequestedItemStatus) SetRequestType(v AccessRequestType)` + +SetRequestType sets RequestType field to given value. + +### HasRequestType + +`func (o *RequestedItemStatus) HasRequestType() bool` + +HasRequestType returns a boolean if a field has been set. + +### SetRequestTypeNil + +`func (o *RequestedItemStatus) SetRequestTypeNil(b bool)` + + SetRequestTypeNil sets the value for RequestType to be an explicit nil + +### UnsetRequestType +`func (o *RequestedItemStatus) UnsetRequestType()` + +UnsetRequestType ensures that no value is present for RequestType, not even an explicit nil +### GetModified + +`func (o *RequestedItemStatus) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RequestedItemStatus) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RequestedItemStatus) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RequestedItemStatus) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *RequestedItemStatus) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *RequestedItemStatus) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetCreated + +`func (o *RequestedItemStatus) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RequestedItemStatus) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RequestedItemStatus) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RequestedItemStatus) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetRequester + +`func (o *RequestedItemStatus) GetRequester() AccessItemRequester` + +GetRequester returns the Requester field if non-nil, zero value otherwise. + +### GetRequesterOk + +`func (o *RequestedItemStatus) GetRequesterOk() (*AccessItemRequester, bool)` + +GetRequesterOk returns a tuple with the Requester field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequester + +`func (o *RequestedItemStatus) SetRequester(v AccessItemRequester)` + +SetRequester sets Requester field to given value. + +### HasRequester + +`func (o *RequestedItemStatus) HasRequester() bool` + +HasRequester returns a boolean if a field has been set. + +### GetRequestedFor + +`func (o *RequestedItemStatus) GetRequestedFor() RequestedItemStatusRequestedFor` + +GetRequestedFor returns the RequestedFor field if non-nil, zero value otherwise. + +### GetRequestedForOk + +`func (o *RequestedItemStatus) GetRequestedForOk() (*RequestedItemStatusRequestedFor, bool)` + +GetRequestedForOk returns a tuple with the RequestedFor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedFor + +`func (o *RequestedItemStatus) SetRequestedFor(v RequestedItemStatusRequestedFor)` + +SetRequestedFor sets RequestedFor field to given value. + +### HasRequestedFor + +`func (o *RequestedItemStatus) HasRequestedFor() bool` + +HasRequestedFor returns a boolean if a field has been set. + +### GetRequesterComment + +`func (o *RequestedItemStatus) GetRequesterComment() RequestedItemStatusRequesterComment` + +GetRequesterComment returns the RequesterComment field if non-nil, zero value otherwise. + +### GetRequesterCommentOk + +`func (o *RequestedItemStatus) GetRequesterCommentOk() (*RequestedItemStatusRequesterComment, bool)` + +GetRequesterCommentOk returns a tuple with the RequesterComment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterComment + +`func (o *RequestedItemStatus) SetRequesterComment(v RequestedItemStatusRequesterComment)` + +SetRequesterComment sets RequesterComment field to given value. + +### HasRequesterComment + +`func (o *RequestedItemStatus) HasRequesterComment() bool` + +HasRequesterComment returns a boolean if a field has been set. + +### GetSodViolationContext + +`func (o *RequestedItemStatus) GetSodViolationContext() RequestedItemStatusSodViolationContext` + +GetSodViolationContext returns the SodViolationContext field if non-nil, zero value otherwise. + +### GetSodViolationContextOk + +`func (o *RequestedItemStatus) GetSodViolationContextOk() (*RequestedItemStatusSodViolationContext, bool)` + +GetSodViolationContextOk returns a tuple with the SodViolationContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSodViolationContext + +`func (o *RequestedItemStatus) SetSodViolationContext(v RequestedItemStatusSodViolationContext)` + +SetSodViolationContext sets SodViolationContext field to given value. + +### HasSodViolationContext + +`func (o *RequestedItemStatus) HasSodViolationContext() bool` + +HasSodViolationContext returns a boolean if a field has been set. + +### GetProvisioningDetails + +`func (o *RequestedItemStatus) GetProvisioningDetails() RequestedItemStatusProvisioningDetails` + +GetProvisioningDetails returns the ProvisioningDetails field if non-nil, zero value otherwise. + +### GetProvisioningDetailsOk + +`func (o *RequestedItemStatus) GetProvisioningDetailsOk() (*RequestedItemStatusProvisioningDetails, bool)` + +GetProvisioningDetailsOk returns a tuple with the ProvisioningDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningDetails + +`func (o *RequestedItemStatus) SetProvisioningDetails(v RequestedItemStatusProvisioningDetails)` + +SetProvisioningDetails sets ProvisioningDetails field to given value. + +### HasProvisioningDetails + +`func (o *RequestedItemStatus) HasProvisioningDetails() bool` + +HasProvisioningDetails returns a boolean if a field has been set. + +### GetPreApprovalTriggerDetails + +`func (o *RequestedItemStatus) GetPreApprovalTriggerDetails() RequestedItemStatusPreApprovalTriggerDetails` + +GetPreApprovalTriggerDetails returns the PreApprovalTriggerDetails field if non-nil, zero value otherwise. + +### GetPreApprovalTriggerDetailsOk + +`func (o *RequestedItemStatus) GetPreApprovalTriggerDetailsOk() (*RequestedItemStatusPreApprovalTriggerDetails, bool)` + +GetPreApprovalTriggerDetailsOk returns a tuple with the PreApprovalTriggerDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPreApprovalTriggerDetails + +`func (o *RequestedItemStatus) SetPreApprovalTriggerDetails(v RequestedItemStatusPreApprovalTriggerDetails)` + +SetPreApprovalTriggerDetails sets PreApprovalTriggerDetails field to given value. + +### HasPreApprovalTriggerDetails + +`func (o *RequestedItemStatus) HasPreApprovalTriggerDetails() bool` + +HasPreApprovalTriggerDetails returns a boolean if a field has been set. + +### GetAccessRequestPhases + +`func (o *RequestedItemStatus) GetAccessRequestPhases() []AccessRequestPhases` + +GetAccessRequestPhases returns the AccessRequestPhases field if non-nil, zero value otherwise. + +### GetAccessRequestPhasesOk + +`func (o *RequestedItemStatus) GetAccessRequestPhasesOk() (*[]AccessRequestPhases, bool)` + +GetAccessRequestPhasesOk returns a tuple with the AccessRequestPhases field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestPhases + +`func (o *RequestedItemStatus) SetAccessRequestPhases(v []AccessRequestPhases)` + +SetAccessRequestPhases sets AccessRequestPhases field to given value. + +### HasAccessRequestPhases + +`func (o *RequestedItemStatus) HasAccessRequestPhases() bool` + +HasAccessRequestPhases returns a boolean if a field has been set. + +### SetAccessRequestPhasesNil + +`func (o *RequestedItemStatus) SetAccessRequestPhasesNil(b bool)` + + SetAccessRequestPhasesNil sets the value for AccessRequestPhases to be an explicit nil + +### UnsetAccessRequestPhases +`func (o *RequestedItemStatus) UnsetAccessRequestPhases()` + +UnsetAccessRequestPhases ensures that no value is present for AccessRequestPhases, not even an explicit nil +### GetDescription + +`func (o *RequestedItemStatus) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RequestedItemStatus) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RequestedItemStatus) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RequestedItemStatus) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RequestedItemStatus) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RequestedItemStatus) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetRemoveDate + +`func (o *RequestedItemStatus) GetRemoveDate() SailPointTime` + +GetRemoveDate returns the RemoveDate field if non-nil, zero value otherwise. + +### GetRemoveDateOk + +`func (o *RequestedItemStatus) GetRemoveDateOk() (*SailPointTime, bool)` + +GetRemoveDateOk returns a tuple with the RemoveDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemoveDate + +`func (o *RequestedItemStatus) SetRemoveDate(v SailPointTime)` + +SetRemoveDate sets RemoveDate field to given value. + +### HasRemoveDate + +`func (o *RequestedItemStatus) HasRemoveDate() bool` + +HasRemoveDate returns a boolean if a field has been set. + +### SetRemoveDateNil + +`func (o *RequestedItemStatus) SetRemoveDateNil(b bool)` + + SetRemoveDateNil sets the value for RemoveDate to be an explicit nil + +### UnsetRemoveDate +`func (o *RequestedItemStatus) UnsetRemoveDate()` + +UnsetRemoveDate ensures that no value is present for RemoveDate, not even an explicit nil +### GetCancelable + +`func (o *RequestedItemStatus) GetCancelable() bool` + +GetCancelable returns the Cancelable field if non-nil, zero value otherwise. + +### GetCancelableOk + +`func (o *RequestedItemStatus) GetCancelableOk() (*bool, bool)` + +GetCancelableOk returns a tuple with the Cancelable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCancelable + +`func (o *RequestedItemStatus) SetCancelable(v bool)` + +SetCancelable sets Cancelable field to given value. + +### HasCancelable + +`func (o *RequestedItemStatus) HasCancelable() bool` + +HasCancelable returns a boolean if a field has been set. + +### GetAccessRequestId + +`func (o *RequestedItemStatus) GetAccessRequestId() string` + +GetAccessRequestId returns the AccessRequestId field if non-nil, zero value otherwise. + +### GetAccessRequestIdOk + +`func (o *RequestedItemStatus) GetAccessRequestIdOk() (*string, bool)` + +GetAccessRequestIdOk returns a tuple with the AccessRequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestId + +`func (o *RequestedItemStatus) SetAccessRequestId(v string)` + +SetAccessRequestId sets AccessRequestId field to given value. + +### HasAccessRequestId + +`func (o *RequestedItemStatus) HasAccessRequestId() bool` + +HasAccessRequestId returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *RequestedItemStatus) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *RequestedItemStatus) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *RequestedItemStatus) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *RequestedItemStatus) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *RequestedItemStatus) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *RequestedItemStatus) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetRequestedAccounts + +`func (o *RequestedItemStatus) GetRequestedAccounts() []RequestedAccountRef` + +GetRequestedAccounts returns the RequestedAccounts field if non-nil, zero value otherwise. + +### GetRequestedAccountsOk + +`func (o *RequestedItemStatus) GetRequestedAccountsOk() (*[]RequestedAccountRef, bool)` + +GetRequestedAccountsOk returns a tuple with the RequestedAccounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedAccounts + +`func (o *RequestedItemStatus) SetRequestedAccounts(v []RequestedAccountRef)` + +SetRequestedAccounts sets RequestedAccounts field to given value. + +### HasRequestedAccounts + +`func (o *RequestedItemStatus) HasRequestedAccounts() bool` + +HasRequestedAccounts returns a boolean if a field has been set. + +### SetRequestedAccountsNil + +`func (o *RequestedItemStatus) SetRequestedAccountsNil(b bool)` + + SetRequestedAccountsNil sets the value for RequestedAccounts to be an explicit nil + +### UnsetRequestedAccounts +`func (o *RequestedItemStatus) UnsetRequestedAccounts()` + +UnsetRequestedAccounts ensures that no value is present for RequestedAccounts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusCancelledRequestDetails.md b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusCancelledRequestDetails.md new file mode 100644 index 000000000..646205527 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusCancelledRequestDetails.md @@ -0,0 +1,116 @@ +--- +id: requested-item-status-cancelled-request-details +title: RequestedItemStatusCancelledRequestDetails +pagination_label: RequestedItemStatusCancelledRequestDetails +sidebar_label: RequestedItemStatusCancelledRequestDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusCancelledRequestDetails', 'RequestedItemStatusCancelledRequestDetails'] +slug: /tools/sdk/go/v3/models/requested-item-status-cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusCancelledRequestDetails', 'RequestedItemStatusCancelledRequestDetails'] +--- + +# RequestedItemStatusCancelledRequestDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment made by the owner when cancelling the associated request. | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Modified** | Pointer to **SailPointTime** | Date comment was added by the owner when cancelling the associated request. | [optional] + +## Methods + +### NewRequestedItemStatusCancelledRequestDetails + +`func NewRequestedItemStatusCancelledRequestDetails() *RequestedItemStatusCancelledRequestDetails` + +NewRequestedItemStatusCancelledRequestDetails instantiates a new RequestedItemStatusCancelledRequestDetails 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 + +### NewRequestedItemStatusCancelledRequestDetailsWithDefaults + +`func NewRequestedItemStatusCancelledRequestDetailsWithDefaults() *RequestedItemStatusCancelledRequestDetails` + +NewRequestedItemStatusCancelledRequestDetailsWithDefaults instantiates a new RequestedItemStatusCancelledRequestDetails 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 + +### GetComment + +`func (o *RequestedItemStatusCancelledRequestDetails) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *RequestedItemStatusCancelledRequestDetails) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *RequestedItemStatusCancelledRequestDetails) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *RequestedItemStatusCancelledRequestDetails) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetOwner + +`func (o *RequestedItemStatusCancelledRequestDetails) GetOwner() OwnerDto` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *RequestedItemStatusCancelledRequestDetails) GetOwnerOk() (*OwnerDto, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *RequestedItemStatusCancelledRequestDetails) SetOwner(v OwnerDto)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *RequestedItemStatusCancelledRequestDetails) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetModified + +`func (o *RequestedItemStatusCancelledRequestDetails) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RequestedItemStatusCancelledRequestDetails) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RequestedItemStatusCancelledRequestDetails) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RequestedItemStatusCancelledRequestDetails) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusPreApprovalTriggerDetails.md b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusPreApprovalTriggerDetails.md new file mode 100644 index 000000000..cee96ccc0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusPreApprovalTriggerDetails.md @@ -0,0 +1,116 @@ +--- +id: requested-item-status-pre-approval-trigger-details +title: RequestedItemStatusPreApprovalTriggerDetails +pagination_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusPreApprovalTriggerDetails', 'RequestedItemStatusPreApprovalTriggerDetails'] +slug: /tools/sdk/go/v3/models/requested-item-status-pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusPreApprovalTriggerDetails', 'RequestedItemStatusPreApprovalTriggerDetails'] +--- + +# RequestedItemStatusPreApprovalTriggerDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **string** | Comment left for the pre-approval decision | [optional] +**Reviewer** | Pointer to **string** | The reviewer of the pre-approval decision | [optional] +**Decision** | Pointer to **string** | The decision of the pre-approval trigger | [optional] + +## Methods + +### NewRequestedItemStatusPreApprovalTriggerDetails + +`func NewRequestedItemStatusPreApprovalTriggerDetails() *RequestedItemStatusPreApprovalTriggerDetails` + +NewRequestedItemStatusPreApprovalTriggerDetails instantiates a new RequestedItemStatusPreApprovalTriggerDetails 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 + +### NewRequestedItemStatusPreApprovalTriggerDetailsWithDefaults + +`func NewRequestedItemStatusPreApprovalTriggerDetailsWithDefaults() *RequestedItemStatusPreApprovalTriggerDetails` + +NewRequestedItemStatusPreApprovalTriggerDetailsWithDefaults instantiates a new RequestedItemStatusPreApprovalTriggerDetails 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 + +### GetComment + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetReviewer + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetReviewer() string` + +GetReviewer returns the Reviewer field if non-nil, zero value otherwise. + +### GetReviewerOk + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetReviewerOk() (*string, bool)` + +GetReviewerOk returns a tuple with the Reviewer field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReviewer + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) SetReviewer(v string)` + +SetReviewer sets Reviewer field to given value. + +### HasReviewer + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) HasReviewer() bool` + +HasReviewer returns a boolean if a field has been set. + +### GetDecision + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetDecision() string` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) GetDecisionOk() (*string, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) SetDecision(v string)` + +SetDecision sets Decision field to given value. + +### HasDecision + +`func (o *RequestedItemStatusPreApprovalTriggerDetails) HasDecision() bool` + +HasDecision returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusProvisioningDetails.md b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusProvisioningDetails.md new file mode 100644 index 000000000..72ad4be17 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusProvisioningDetails.md @@ -0,0 +1,64 @@ +--- +id: requested-item-status-provisioning-details +title: RequestedItemStatusProvisioningDetails +pagination_label: RequestedItemStatusProvisioningDetails +sidebar_label: RequestedItemStatusProvisioningDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusProvisioningDetails', 'RequestedItemStatusProvisioningDetails'] +slug: /tools/sdk/go/v3/models/requested-item-status-provisioning-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusProvisioningDetails', 'RequestedItemStatusProvisioningDetails'] +--- + +# RequestedItemStatusProvisioningDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrderedSubPhaseReferences** | Pointer to **string** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. | [optional] + +## Methods + +### NewRequestedItemStatusProvisioningDetails + +`func NewRequestedItemStatusProvisioningDetails() *RequestedItemStatusProvisioningDetails` + +NewRequestedItemStatusProvisioningDetails instantiates a new RequestedItemStatusProvisioningDetails 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 + +### NewRequestedItemStatusProvisioningDetailsWithDefaults + +`func NewRequestedItemStatusProvisioningDetailsWithDefaults() *RequestedItemStatusProvisioningDetails` + +NewRequestedItemStatusProvisioningDetailsWithDefaults instantiates a new RequestedItemStatusProvisioningDetails 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 + +### GetOrderedSubPhaseReferences + +`func (o *RequestedItemStatusProvisioningDetails) GetOrderedSubPhaseReferences() string` + +GetOrderedSubPhaseReferences returns the OrderedSubPhaseReferences field if non-nil, zero value otherwise. + +### GetOrderedSubPhaseReferencesOk + +`func (o *RequestedItemStatusProvisioningDetails) GetOrderedSubPhaseReferencesOk() (*string, bool)` + +GetOrderedSubPhaseReferencesOk returns a tuple with the OrderedSubPhaseReferences field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderedSubPhaseReferences + +`func (o *RequestedItemStatusProvisioningDetails) SetOrderedSubPhaseReferences(v string)` + +SetOrderedSubPhaseReferences sets OrderedSubPhaseReferences field to given value. + +### HasOrderedSubPhaseReferences + +`func (o *RequestedItemStatusProvisioningDetails) HasOrderedSubPhaseReferences() bool` + +HasOrderedSubPhaseReferences returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusRequestState.md b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusRequestState.md new file mode 100644 index 000000000..0f84bb655 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusRequestState.md @@ -0,0 +1,35 @@ +--- +id: requested-item-status-request-state +title: RequestedItemStatusRequestState +pagination_label: RequestedItemStatusRequestState +sidebar_label: RequestedItemStatusRequestState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusRequestState', 'RequestedItemStatusRequestState'] +slug: /tools/sdk/go/v3/models/requested-item-status-request-state +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestState', 'RequestedItemStatusRequestState'] +--- + +# RequestedItemStatusRequestState + +## Enum + + +* `EXECUTING` (value: `"EXECUTING"`) + +* `REQUEST_COMPLETED` (value: `"REQUEST_COMPLETED"`) + +* `CANCELLED` (value: `"CANCELLED"`) + +* `TERMINATED` (value: `"TERMINATED"`) + +* `PROVISIONING_VERIFICATION_PENDING` (value: `"PROVISIONING_VERIFICATION_PENDING"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `PROVISIONING_FAILED` (value: `"PROVISIONING_FAILED"`) + +* `NOT_ALL_ITEMS_PROVISIONED` (value: `"NOT_ALL_ITEMS_PROVISIONED"`) + +* `ERROR` (value: `"ERROR"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusRequestedFor.md b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusRequestedFor.md new file mode 100644 index 000000000..cf0fd8dc8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusRequestedFor.md @@ -0,0 +1,116 @@ +--- +id: requested-item-status-requested-for +title: RequestedItemStatusRequestedFor +pagination_label: RequestedItemStatusRequestedFor +sidebar_label: RequestedItemStatusRequestedFor +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusRequestedFor', 'RequestedItemStatusRequestedFor'] +slug: /tools/sdk/go/v3/models/requested-item-status-requested-for +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestedFor', 'RequestedItemStatusRequestedFor'] +--- + +# RequestedItemStatusRequestedFor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the object to which this reference applies | [optional] +**Id** | Pointer to **string** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **string** | Human-readable display name of the object to which this reference applies | [optional] + +## Methods + +### NewRequestedItemStatusRequestedFor + +`func NewRequestedItemStatusRequestedFor() *RequestedItemStatusRequestedFor` + +NewRequestedItemStatusRequestedFor instantiates a new RequestedItemStatusRequestedFor 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 + +### NewRequestedItemStatusRequestedForWithDefaults + +`func NewRequestedItemStatusRequestedForWithDefaults() *RequestedItemStatusRequestedFor` + +NewRequestedItemStatusRequestedForWithDefaults instantiates a new RequestedItemStatusRequestedFor 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 + +### GetType + +`func (o *RequestedItemStatusRequestedFor) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RequestedItemStatusRequestedFor) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RequestedItemStatusRequestedFor) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RequestedItemStatusRequestedFor) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RequestedItemStatusRequestedFor) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RequestedItemStatusRequestedFor) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RequestedItemStatusRequestedFor) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RequestedItemStatusRequestedFor) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RequestedItemStatusRequestedFor) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RequestedItemStatusRequestedFor) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RequestedItemStatusRequestedFor) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RequestedItemStatusRequestedFor) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusRequesterComment.md b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusRequesterComment.md new file mode 100644 index 000000000..ab10698b7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusRequesterComment.md @@ -0,0 +1,126 @@ +--- +id: requested-item-status-requester-comment +title: RequestedItemStatusRequesterComment +pagination_label: RequestedItemStatusRequesterComment +sidebar_label: RequestedItemStatusRequesterComment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusRequesterComment', 'RequestedItemStatusRequesterComment'] +slug: /tools/sdk/go/v3/models/requested-item-status-requester-comment +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequesterComment', 'RequestedItemStatusRequesterComment'] +--- + +# RequestedItemStatusRequesterComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **NullableString** | Comment content. | [optional] +**Created** | Pointer to **SailPointTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Methods + +### NewRequestedItemStatusRequesterComment + +`func NewRequestedItemStatusRequesterComment() *RequestedItemStatusRequesterComment` + +NewRequestedItemStatusRequesterComment instantiates a new RequestedItemStatusRequesterComment 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 + +### NewRequestedItemStatusRequesterCommentWithDefaults + +`func NewRequestedItemStatusRequesterCommentWithDefaults() *RequestedItemStatusRequesterComment` + +NewRequestedItemStatusRequesterCommentWithDefaults instantiates a new RequestedItemStatusRequesterComment 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 + +### GetComment + +`func (o *RequestedItemStatusRequesterComment) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *RequestedItemStatusRequesterComment) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *RequestedItemStatusRequesterComment) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *RequestedItemStatusRequesterComment) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### SetCommentNil + +`func (o *RequestedItemStatusRequesterComment) SetCommentNil(b bool)` + + SetCommentNil sets the value for Comment to be an explicit nil + +### UnsetComment +`func (o *RequestedItemStatusRequesterComment) UnsetComment()` + +UnsetComment ensures that no value is present for Comment, not even an explicit nil +### GetCreated + +`func (o *RequestedItemStatusRequesterComment) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RequestedItemStatusRequesterComment) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RequestedItemStatusRequesterComment) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RequestedItemStatusRequesterComment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetAuthor + +`func (o *RequestedItemStatusRequesterComment) GetAuthor() CommentDtoAuthor` + +GetAuthor returns the Author field if non-nil, zero value otherwise. + +### GetAuthorOk + +`func (o *RequestedItemStatusRequesterComment) GetAuthorOk() (*CommentDtoAuthor, bool)` + +GetAuthorOk returns a tuple with the Author field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthor + +`func (o *RequestedItemStatusRequesterComment) SetAuthor(v CommentDtoAuthor)` + +SetAuthor sets Author field to given value. + +### HasAuthor + +`func (o *RequestedItemStatusRequesterComment) HasAuthor() bool` + +HasAuthor returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusSodViolationContext.md b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusSodViolationContext.md new file mode 100644 index 000000000..57cd360b7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RequestedItemStatusSodViolationContext.md @@ -0,0 +1,136 @@ +--- +id: requested-item-status-sod-violation-context +title: RequestedItemStatusSodViolationContext +pagination_label: RequestedItemStatusSodViolationContext +sidebar_label: RequestedItemStatusSodViolationContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RequestedItemStatusSodViolationContext', 'RequestedItemStatusSodViolationContext'] +slug: /tools/sdk/go/v3/models/requested-item-status-sod-violation-context +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusSodViolationContext', 'RequestedItemStatusSodViolationContext'] +--- + +# RequestedItemStatusSodViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **NullableString** | The status of SOD violation check | [optional] +**Uuid** | Pointer to **NullableString** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] + +## Methods + +### NewRequestedItemStatusSodViolationContext + +`func NewRequestedItemStatusSodViolationContext() *RequestedItemStatusSodViolationContext` + +NewRequestedItemStatusSodViolationContext instantiates a new RequestedItemStatusSodViolationContext 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 + +### NewRequestedItemStatusSodViolationContextWithDefaults + +`func NewRequestedItemStatusSodViolationContextWithDefaults() *RequestedItemStatusSodViolationContext` + +NewRequestedItemStatusSodViolationContextWithDefaults instantiates a new RequestedItemStatusSodViolationContext 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 + +### GetState + +`func (o *RequestedItemStatusSodViolationContext) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *RequestedItemStatusSodViolationContext) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *RequestedItemStatusSodViolationContext) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *RequestedItemStatusSodViolationContext) HasState() bool` + +HasState returns a boolean if a field has been set. + +### SetStateNil + +`func (o *RequestedItemStatusSodViolationContext) SetStateNil(b bool)` + + SetStateNil sets the value for State to be an explicit nil + +### UnsetState +`func (o *RequestedItemStatusSodViolationContext) UnsetState()` + +UnsetState ensures that no value is present for State, not even an explicit nil +### GetUuid + +`func (o *RequestedItemStatusSodViolationContext) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *RequestedItemStatusSodViolationContext) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *RequestedItemStatusSodViolationContext) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *RequestedItemStatusSodViolationContext) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *RequestedItemStatusSodViolationContext) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *RequestedItemStatusSodViolationContext) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetViolationCheckResult + +`func (o *RequestedItemStatusSodViolationContext) GetViolationCheckResult() SodViolationCheckResult` + +GetViolationCheckResult returns the ViolationCheckResult field if non-nil, zero value otherwise. + +### GetViolationCheckResultOk + +`func (o *RequestedItemStatusSodViolationContext) GetViolationCheckResultOk() (*SodViolationCheckResult, bool)` + +GetViolationCheckResultOk returns a tuple with the ViolationCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationCheckResult + +`func (o *RequestedItemStatusSodViolationContext) SetViolationCheckResult(v SodViolationCheckResult)` + +SetViolationCheckResult sets ViolationCheckResult field to given value. + +### HasViolationCheckResult + +`func (o *RequestedItemStatusSodViolationContext) HasViolationCheckResult() bool` + +HasViolationCheckResult returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Result.md b/docs/tools/sdk/go/Reference/V3/Models/Result.md new file mode 100644 index 000000000..c70d603e3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Result.md @@ -0,0 +1,64 @@ +--- +id: result +title: Result +pagination_label: Result +sidebar_label: Result +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Result', 'Result'] +slug: /tools/sdk/go/v3/models/result +tags: ['SDK', 'Software Development Kit', 'Result', 'Result'] +--- + +# Result + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | Request result status | [optional] + +## Methods + +### NewResult + +`func NewResult() *Result` + +NewResult instantiates a new Result 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 + +### NewResultWithDefaults + +`func NewResultWithDefaults() *Result` + +NewResultWithDefaults instantiates a new Result 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 + +### GetStatus + +`func (o *Result) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Result) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Result) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Result) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReviewDecision.md b/docs/tools/sdk/go/Reference/V3/Models/ReviewDecision.md new file mode 100644 index 000000000..c8483383b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReviewDecision.md @@ -0,0 +1,179 @@ +--- +id: review-decision +title: ReviewDecision +pagination_label: ReviewDecision +sidebar_label: ReviewDecision +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewDecision', 'ReviewDecision'] +slug: /tools/sdk/go/v3/models/review-decision +tags: ['SDK', 'Software Development Kit', 'ReviewDecision', 'ReviewDecision'] +--- + +# ReviewDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The id of the review decision | +**Decision** | [**CertificationDecision**](certification-decision) | | +**ProposedEndDate** | Pointer to **SailPointTime** | The date at which a user's access should be taken away. Should only be set for `REVOKE` decisions. | [optional] +**Bulk** | **bool** | Indicates whether decision should be marked as part of a larger bulk decision | +**Recommendation** | Pointer to [**ReviewRecommendation**](review-recommendation) | | [optional] +**Comments** | Pointer to **string** | Comments recorded when the decision was made | [optional] + +## Methods + +### NewReviewDecision + +`func NewReviewDecision(id string, decision CertificationDecision, bulk bool, ) *ReviewDecision` + +NewReviewDecision instantiates a new ReviewDecision 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 + +### NewReviewDecisionWithDefaults + +`func NewReviewDecisionWithDefaults() *ReviewDecision` + +NewReviewDecisionWithDefaults instantiates a new ReviewDecision 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 + +### GetId + +`func (o *ReviewDecision) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewDecision) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewDecision) SetId(v string)` + +SetId sets Id field to given value. + + +### GetDecision + +`func (o *ReviewDecision) GetDecision() CertificationDecision` + +GetDecision returns the Decision field if non-nil, zero value otherwise. + +### GetDecisionOk + +`func (o *ReviewDecision) GetDecisionOk() (*CertificationDecision, bool)` + +GetDecisionOk returns a tuple with the Decision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDecision + +`func (o *ReviewDecision) SetDecision(v CertificationDecision)` + +SetDecision sets Decision field to given value. + + +### GetProposedEndDate + +`func (o *ReviewDecision) GetProposedEndDate() SailPointTime` + +GetProposedEndDate returns the ProposedEndDate field if non-nil, zero value otherwise. + +### GetProposedEndDateOk + +`func (o *ReviewDecision) GetProposedEndDateOk() (*SailPointTime, bool)` + +GetProposedEndDateOk returns a tuple with the ProposedEndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProposedEndDate + +`func (o *ReviewDecision) SetProposedEndDate(v SailPointTime)` + +SetProposedEndDate sets ProposedEndDate field to given value. + +### HasProposedEndDate + +`func (o *ReviewDecision) HasProposedEndDate() bool` + +HasProposedEndDate returns a boolean if a field has been set. + +### GetBulk + +`func (o *ReviewDecision) GetBulk() bool` + +GetBulk returns the Bulk field if non-nil, zero value otherwise. + +### GetBulkOk + +`func (o *ReviewDecision) GetBulkOk() (*bool, bool)` + +GetBulkOk returns a tuple with the Bulk field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBulk + +`func (o *ReviewDecision) SetBulk(v bool)` + +SetBulk sets Bulk field to given value. + + +### GetRecommendation + +`func (o *ReviewDecision) GetRecommendation() ReviewRecommendation` + +GetRecommendation returns the Recommendation field if non-nil, zero value otherwise. + +### GetRecommendationOk + +`func (o *ReviewDecision) GetRecommendationOk() (*ReviewRecommendation, bool)` + +GetRecommendationOk returns a tuple with the Recommendation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendation + +`func (o *ReviewDecision) SetRecommendation(v ReviewRecommendation)` + +SetRecommendation sets Recommendation field to given value. + +### HasRecommendation + +`func (o *ReviewDecision) HasRecommendation() bool` + +HasRecommendation returns a boolean if a field has been set. + +### GetComments + +`func (o *ReviewDecision) GetComments() string` + +GetComments returns the Comments field if non-nil, zero value otherwise. + +### GetCommentsOk + +`func (o *ReviewDecision) GetCommentsOk() (*string, bool)` + +GetCommentsOk returns a tuple with the Comments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComments + +`func (o *ReviewDecision) SetComments(v string)` + +SetComments sets Comments field to given value. + +### HasComments + +`func (o *ReviewDecision) HasComments() bool` + +HasComments returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReviewReassign.md b/docs/tools/sdk/go/Reference/V3/Models/ReviewReassign.md new file mode 100644 index 000000000..bb855576c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReviewReassign.md @@ -0,0 +1,101 @@ +--- +id: review-reassign +title: ReviewReassign +pagination_label: ReviewReassign +sidebar_label: ReviewReassign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewReassign', 'ReviewReassign'] +slug: /tools/sdk/go/v3/models/review-reassign +tags: ['SDK', 'Software Development Kit', 'ReviewReassign', 'ReviewReassign'] +--- + +# ReviewReassign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Reassign** | [**[]ReassignReference**](reassign-reference) | | +**ReassignTo** | **string** | The ID of the identity to which the certification is reassigned | +**Reason** | **string** | The reason comment for why the reassign was made | + +## Methods + +### NewReviewReassign + +`func NewReviewReassign(reassign []ReassignReference, reassignTo string, reason string, ) *ReviewReassign` + +NewReviewReassign instantiates a new ReviewReassign 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 + +### NewReviewReassignWithDefaults + +`func NewReviewReassignWithDefaults() *ReviewReassign` + +NewReviewReassignWithDefaults instantiates a new ReviewReassign 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 + +### GetReassign + +`func (o *ReviewReassign) GetReassign() []ReassignReference` + +GetReassign returns the Reassign field if non-nil, zero value otherwise. + +### GetReassignOk + +`func (o *ReviewReassign) GetReassignOk() (*[]ReassignReference, bool)` + +GetReassignOk returns a tuple with the Reassign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassign + +`func (o *ReviewReassign) SetReassign(v []ReassignReference)` + +SetReassign sets Reassign field to given value. + + +### GetReassignTo + +`func (o *ReviewReassign) GetReassignTo() string` + +GetReassignTo returns the ReassignTo field if non-nil, zero value otherwise. + +### GetReassignToOk + +`func (o *ReviewReassign) GetReassignToOk() (*string, bool)` + +GetReassignToOk returns a tuple with the ReassignTo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReassignTo + +`func (o *ReviewReassign) SetReassignTo(v string)` + +SetReassignTo sets ReassignTo field to given value. + + +### GetReason + +`func (o *ReviewReassign) GetReason() string` + +GetReason returns the Reason field if non-nil, zero value otherwise. + +### GetReasonOk + +`func (o *ReviewReassign) GetReasonOk() (*string, bool)` + +GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReason + +`func (o *ReviewReassign) SetReason(v string)` + +SetReason sets Reason field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReviewRecommendation.md b/docs/tools/sdk/go/Reference/V3/Models/ReviewRecommendation.md new file mode 100644 index 000000000..651ab70eb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReviewRecommendation.md @@ -0,0 +1,126 @@ +--- +id: review-recommendation +title: ReviewRecommendation +pagination_label: ReviewRecommendation +sidebar_label: ReviewRecommendation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewRecommendation', 'ReviewRecommendation'] +slug: /tools/sdk/go/v3/models/review-recommendation +tags: ['SDK', 'Software Development Kit', 'ReviewRecommendation', 'ReviewRecommendation'] +--- + +# ReviewRecommendation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Recommendation** | Pointer to **NullableString** | The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. | [optional] +**Reasons** | Pointer to **[]string** | A list of reasons for the recommendation. | [optional] +**Timestamp** | Pointer to **SailPointTime** | The time at which the recommendation was recorded. | [optional] + +## Methods + +### NewReviewRecommendation + +`func NewReviewRecommendation() *ReviewRecommendation` + +NewReviewRecommendation instantiates a new ReviewRecommendation 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 + +### NewReviewRecommendationWithDefaults + +`func NewReviewRecommendationWithDefaults() *ReviewRecommendation` + +NewReviewRecommendationWithDefaults instantiates a new ReviewRecommendation 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 + +### GetRecommendation + +`func (o *ReviewRecommendation) GetRecommendation() string` + +GetRecommendation returns the Recommendation field if non-nil, zero value otherwise. + +### GetRecommendationOk + +`func (o *ReviewRecommendation) GetRecommendationOk() (*string, bool)` + +GetRecommendationOk returns a tuple with the Recommendation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendation + +`func (o *ReviewRecommendation) SetRecommendation(v string)` + +SetRecommendation sets Recommendation field to given value. + +### HasRecommendation + +`func (o *ReviewRecommendation) HasRecommendation() bool` + +HasRecommendation returns a boolean if a field has been set. + +### SetRecommendationNil + +`func (o *ReviewRecommendation) SetRecommendationNil(b bool)` + + SetRecommendationNil sets the value for Recommendation to be an explicit nil + +### UnsetRecommendation +`func (o *ReviewRecommendation) UnsetRecommendation()` + +UnsetRecommendation ensures that no value is present for Recommendation, not even an explicit nil +### GetReasons + +`func (o *ReviewRecommendation) GetReasons() []string` + +GetReasons returns the Reasons field if non-nil, zero value otherwise. + +### GetReasonsOk + +`func (o *ReviewRecommendation) GetReasonsOk() (*[]string, bool)` + +GetReasonsOk returns a tuple with the Reasons field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReasons + +`func (o *ReviewRecommendation) SetReasons(v []string)` + +SetReasons sets Reasons field to given value. + +### HasReasons + +`func (o *ReviewRecommendation) HasReasons() bool` + +HasReasons returns a boolean if a field has been set. + +### GetTimestamp + +`func (o *ReviewRecommendation) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *ReviewRecommendation) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *ReviewRecommendation) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *ReviewRecommendation) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReviewableAccessProfile.md b/docs/tools/sdk/go/Reference/V3/Models/ReviewableAccessProfile.md new file mode 100644 index 000000000..8db8f1e37 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReviewableAccessProfile.md @@ -0,0 +1,318 @@ +--- +id: reviewable-access-profile +title: ReviewableAccessProfile +pagination_label: ReviewableAccessProfile +sidebar_label: ReviewableAccessProfile +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewableAccessProfile', 'ReviewableAccessProfile'] +slug: /tools/sdk/go/v3/models/reviewable-access-profile +tags: ['SDK', 'Software Development Kit', 'ReviewableAccessProfile', 'ReviewableAccessProfile'] +--- + +# ReviewableAccessProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the Access Profile | [optional] +**Name** | Pointer to **string** | Name of the Access Profile | [optional] +**Description** | Pointer to **string** | Information about the Access Profile | [optional] +**Privileged** | Pointer to **bool** | Indicates if the entitlement is a privileged entitlement | [optional] +**CloudGoverned** | Pointer to **bool** | True if the entitlement is cloud governed | [optional] +**EndDate** | Pointer to **NullableTime** | The date at which a user's access expires | [optional] +**Owner** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**Entitlements** | Pointer to [**[]ReviewableEntitlement**](reviewable-entitlement) | A list of entitlements associated with this Access Profile | [optional] +**Created** | Pointer to **SailPointTime** | Date the Access Profile was created. | [optional] +**Modified** | Pointer to **SailPointTime** | Date the Access Profile was last modified. | [optional] + +## Methods + +### NewReviewableAccessProfile + +`func NewReviewableAccessProfile() *ReviewableAccessProfile` + +NewReviewableAccessProfile instantiates a new ReviewableAccessProfile 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 + +### NewReviewableAccessProfileWithDefaults + +`func NewReviewableAccessProfileWithDefaults() *ReviewableAccessProfile` + +NewReviewableAccessProfileWithDefaults instantiates a new ReviewableAccessProfile 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 + +### GetId + +`func (o *ReviewableAccessProfile) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewableAccessProfile) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewableAccessProfile) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReviewableAccessProfile) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ReviewableAccessProfile) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ReviewableAccessProfile) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ReviewableAccessProfile) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ReviewableAccessProfile) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ReviewableAccessProfile) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ReviewableAccessProfile) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ReviewableAccessProfile) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ReviewableAccessProfile) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *ReviewableAccessProfile) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *ReviewableAccessProfile) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *ReviewableAccessProfile) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *ReviewableAccessProfile) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetCloudGoverned + +`func (o *ReviewableAccessProfile) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *ReviewableAccessProfile) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *ReviewableAccessProfile) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + +### HasCloudGoverned + +`func (o *ReviewableAccessProfile) HasCloudGoverned() bool` + +HasCloudGoverned returns a boolean if a field has been set. + +### GetEndDate + +`func (o *ReviewableAccessProfile) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *ReviewableAccessProfile) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *ReviewableAccessProfile) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *ReviewableAccessProfile) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### SetEndDateNil + +`func (o *ReviewableAccessProfile) SetEndDateNil(b bool)` + + SetEndDateNil sets the value for EndDate to be an explicit nil + +### UnsetEndDate +`func (o *ReviewableAccessProfile) UnsetEndDate()` + +UnsetEndDate ensures that no value is present for EndDate, not even an explicit nil +### GetOwner + +`func (o *ReviewableAccessProfile) GetOwner() IdentityReferenceWithNameAndEmail` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *ReviewableAccessProfile) GetOwnerOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *ReviewableAccessProfile) SetOwner(v IdentityReferenceWithNameAndEmail)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *ReviewableAccessProfile) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *ReviewableAccessProfile) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *ReviewableAccessProfile) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetEntitlements + +`func (o *ReviewableAccessProfile) GetEntitlements() []ReviewableEntitlement` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *ReviewableAccessProfile) GetEntitlementsOk() (*[]ReviewableEntitlement, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *ReviewableAccessProfile) SetEntitlements(v []ReviewableEntitlement)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *ReviewableAccessProfile) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetCreated + +`func (o *ReviewableAccessProfile) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ReviewableAccessProfile) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ReviewableAccessProfile) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ReviewableAccessProfile) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *ReviewableAccessProfile) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ReviewableAccessProfile) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ReviewableAccessProfile) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ReviewableAccessProfile) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReviewableEntitlement.md b/docs/tools/sdk/go/Reference/V3/Models/ReviewableEntitlement.md new file mode 100644 index 000000000..fe27e8d46 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReviewableEntitlement.md @@ -0,0 +1,546 @@ +--- +id: reviewable-entitlement +title: ReviewableEntitlement +pagination_label: ReviewableEntitlement +sidebar_label: ReviewableEntitlement +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewableEntitlement', 'ReviewableEntitlement'] +slug: /tools/sdk/go/v3/models/reviewable-entitlement +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlement', 'ReviewableEntitlement'] +--- + +# ReviewableEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id for the entitlement | [optional] +**Name** | Pointer to **string** | The name of the entitlement | [optional] +**Description** | Pointer to **NullableString** | Information about the entitlement | [optional] +**Privileged** | Pointer to **bool** | Indicates if the entitlement is a privileged entitlement | [optional] [default to false] +**Owner** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**AttributeName** | Pointer to **string** | The name of the attribute on the source | [optional] +**AttributeValue** | Pointer to **string** | The value of the attribute on the source | [optional] +**SourceSchemaObjectType** | Pointer to **string** | The schema object type on the source used to represent the entitlement and its attributes | [optional] +**SourceName** | Pointer to **string** | The name of the source for which this entitlement belongs | [optional] +**SourceType** | Pointer to **string** | The type of the source for which the entitlement belongs | [optional] +**SourceId** | Pointer to **string** | The ID of the source for which the entitlement belongs | [optional] +**HasPermissions** | Pointer to **bool** | Indicates if the entitlement has permissions | [optional] [default to false] +**IsPermission** | Pointer to **bool** | Indicates if the entitlement is a representation of an account permission | [optional] [default to false] +**Revocable** | Pointer to **bool** | Indicates whether the entitlement can be revoked | [optional] [default to false] +**CloudGoverned** | Pointer to **bool** | True if the entitlement is cloud governed | [optional] [default to false] +**ContainsDataAccess** | Pointer to **bool** | True if the entitlement has DAS data | [optional] [default to false] +**DataAccess** | Pointer to [**NullableDataAccess**](data-access) | | [optional] +**Account** | Pointer to [**NullableReviewableEntitlementAccount**](reviewable-entitlement-account) | | [optional] + +## Methods + +### NewReviewableEntitlement + +`func NewReviewableEntitlement() *ReviewableEntitlement` + +NewReviewableEntitlement instantiates a new ReviewableEntitlement 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 + +### NewReviewableEntitlementWithDefaults + +`func NewReviewableEntitlementWithDefaults() *ReviewableEntitlement` + +NewReviewableEntitlementWithDefaults instantiates a new ReviewableEntitlement 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 + +### GetId + +`func (o *ReviewableEntitlement) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewableEntitlement) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewableEntitlement) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReviewableEntitlement) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ReviewableEntitlement) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ReviewableEntitlement) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ReviewableEntitlement) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ReviewableEntitlement) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ReviewableEntitlement) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ReviewableEntitlement) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ReviewableEntitlement) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ReviewableEntitlement) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ReviewableEntitlement) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ReviewableEntitlement) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetPrivileged + +`func (o *ReviewableEntitlement) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *ReviewableEntitlement) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *ReviewableEntitlement) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *ReviewableEntitlement) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetOwner + +`func (o *ReviewableEntitlement) GetOwner() IdentityReferenceWithNameAndEmail` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *ReviewableEntitlement) GetOwnerOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *ReviewableEntitlement) SetOwner(v IdentityReferenceWithNameAndEmail)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *ReviewableEntitlement) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *ReviewableEntitlement) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *ReviewableEntitlement) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetAttributeName + +`func (o *ReviewableEntitlement) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *ReviewableEntitlement) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *ReviewableEntitlement) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *ReviewableEntitlement) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + +### GetAttributeValue + +`func (o *ReviewableEntitlement) GetAttributeValue() string` + +GetAttributeValue returns the AttributeValue field if non-nil, zero value otherwise. + +### GetAttributeValueOk + +`func (o *ReviewableEntitlement) GetAttributeValueOk() (*string, bool)` + +GetAttributeValueOk returns a tuple with the AttributeValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeValue + +`func (o *ReviewableEntitlement) SetAttributeValue(v string)` + +SetAttributeValue sets AttributeValue field to given value. + +### HasAttributeValue + +`func (o *ReviewableEntitlement) HasAttributeValue() bool` + +HasAttributeValue returns a boolean if a field has been set. + +### GetSourceSchemaObjectType + +`func (o *ReviewableEntitlement) GetSourceSchemaObjectType() string` + +GetSourceSchemaObjectType returns the SourceSchemaObjectType field if non-nil, zero value otherwise. + +### GetSourceSchemaObjectTypeOk + +`func (o *ReviewableEntitlement) GetSourceSchemaObjectTypeOk() (*string, bool)` + +GetSourceSchemaObjectTypeOk returns a tuple with the SourceSchemaObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceSchemaObjectType + +`func (o *ReviewableEntitlement) SetSourceSchemaObjectType(v string)` + +SetSourceSchemaObjectType sets SourceSchemaObjectType field to given value. + +### HasSourceSchemaObjectType + +`func (o *ReviewableEntitlement) HasSourceSchemaObjectType() bool` + +HasSourceSchemaObjectType returns a boolean if a field has been set. + +### GetSourceName + +`func (o *ReviewableEntitlement) GetSourceName() string` + +GetSourceName returns the SourceName field if non-nil, zero value otherwise. + +### GetSourceNameOk + +`func (o *ReviewableEntitlement) GetSourceNameOk() (*string, bool)` + +GetSourceNameOk returns a tuple with the SourceName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceName + +`func (o *ReviewableEntitlement) SetSourceName(v string)` + +SetSourceName sets SourceName field to given value. + +### HasSourceName + +`func (o *ReviewableEntitlement) HasSourceName() bool` + +HasSourceName returns a boolean if a field has been set. + +### GetSourceType + +`func (o *ReviewableEntitlement) GetSourceType() string` + +GetSourceType returns the SourceType field if non-nil, zero value otherwise. + +### GetSourceTypeOk + +`func (o *ReviewableEntitlement) GetSourceTypeOk() (*string, bool)` + +GetSourceTypeOk returns a tuple with the SourceType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceType + +`func (o *ReviewableEntitlement) SetSourceType(v string)` + +SetSourceType sets SourceType field to given value. + +### HasSourceType + +`func (o *ReviewableEntitlement) HasSourceType() bool` + +HasSourceType returns a boolean if a field has been set. + +### GetSourceId + +`func (o *ReviewableEntitlement) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *ReviewableEntitlement) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *ReviewableEntitlement) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *ReviewableEntitlement) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### GetHasPermissions + +`func (o *ReviewableEntitlement) GetHasPermissions() bool` + +GetHasPermissions returns the HasPermissions field if non-nil, zero value otherwise. + +### GetHasPermissionsOk + +`func (o *ReviewableEntitlement) GetHasPermissionsOk() (*bool, bool)` + +GetHasPermissionsOk returns a tuple with the HasPermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasPermissions + +`func (o *ReviewableEntitlement) SetHasPermissions(v bool)` + +SetHasPermissions sets HasPermissions field to given value. + +### HasHasPermissions + +`func (o *ReviewableEntitlement) HasHasPermissions() bool` + +HasHasPermissions returns a boolean if a field has been set. + +### GetIsPermission + +`func (o *ReviewableEntitlement) GetIsPermission() bool` + +GetIsPermission returns the IsPermission field if non-nil, zero value otherwise. + +### GetIsPermissionOk + +`func (o *ReviewableEntitlement) GetIsPermissionOk() (*bool, bool)` + +GetIsPermissionOk returns a tuple with the IsPermission field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsPermission + +`func (o *ReviewableEntitlement) SetIsPermission(v bool)` + +SetIsPermission sets IsPermission field to given value. + +### HasIsPermission + +`func (o *ReviewableEntitlement) HasIsPermission() bool` + +HasIsPermission returns a boolean if a field has been set. + +### GetRevocable + +`func (o *ReviewableEntitlement) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *ReviewableEntitlement) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *ReviewableEntitlement) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *ReviewableEntitlement) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + +### GetCloudGoverned + +`func (o *ReviewableEntitlement) GetCloudGoverned() bool` + +GetCloudGoverned returns the CloudGoverned field if non-nil, zero value otherwise. + +### GetCloudGovernedOk + +`func (o *ReviewableEntitlement) GetCloudGovernedOk() (*bool, bool)` + +GetCloudGovernedOk returns a tuple with the CloudGoverned field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloudGoverned + +`func (o *ReviewableEntitlement) SetCloudGoverned(v bool)` + +SetCloudGoverned sets CloudGoverned field to given value. + +### HasCloudGoverned + +`func (o *ReviewableEntitlement) HasCloudGoverned() bool` + +HasCloudGoverned returns a boolean if a field has been set. + +### GetContainsDataAccess + +`func (o *ReviewableEntitlement) GetContainsDataAccess() bool` + +GetContainsDataAccess returns the ContainsDataAccess field if non-nil, zero value otherwise. + +### GetContainsDataAccessOk + +`func (o *ReviewableEntitlement) GetContainsDataAccessOk() (*bool, bool)` + +GetContainsDataAccessOk returns a tuple with the ContainsDataAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContainsDataAccess + +`func (o *ReviewableEntitlement) SetContainsDataAccess(v bool)` + +SetContainsDataAccess sets ContainsDataAccess field to given value. + +### HasContainsDataAccess + +`func (o *ReviewableEntitlement) HasContainsDataAccess() bool` + +HasContainsDataAccess returns a boolean if a field has been set. + +### GetDataAccess + +`func (o *ReviewableEntitlement) GetDataAccess() DataAccess` + +GetDataAccess returns the DataAccess field if non-nil, zero value otherwise. + +### GetDataAccessOk + +`func (o *ReviewableEntitlement) GetDataAccessOk() (*DataAccess, bool)` + +GetDataAccessOk returns a tuple with the DataAccess field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataAccess + +`func (o *ReviewableEntitlement) SetDataAccess(v DataAccess)` + +SetDataAccess sets DataAccess field to given value. + +### HasDataAccess + +`func (o *ReviewableEntitlement) HasDataAccess() bool` + +HasDataAccess returns a boolean if a field has been set. + +### SetDataAccessNil + +`func (o *ReviewableEntitlement) SetDataAccessNil(b bool)` + + SetDataAccessNil sets the value for DataAccess to be an explicit nil + +### UnsetDataAccess +`func (o *ReviewableEntitlement) UnsetDataAccess()` + +UnsetDataAccess ensures that no value is present for DataAccess, not even an explicit nil +### GetAccount + +`func (o *ReviewableEntitlement) GetAccount() ReviewableEntitlementAccount` + +GetAccount returns the Account field if non-nil, zero value otherwise. + +### GetAccountOk + +`func (o *ReviewableEntitlement) GetAccountOk() (*ReviewableEntitlementAccount, bool)` + +GetAccountOk returns a tuple with the Account field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccount + +`func (o *ReviewableEntitlement) SetAccount(v ReviewableEntitlementAccount)` + +SetAccount sets Account field to given value. + +### HasAccount + +`func (o *ReviewableEntitlement) HasAccount() bool` + +HasAccount returns a boolean if a field has been set. + +### SetAccountNil + +`func (o *ReviewableEntitlement) SetAccountNil(b bool)` + + SetAccountNil sets the value for Account to be an explicit nil + +### UnsetAccount +`func (o *ReviewableEntitlement) UnsetAccount()` + +UnsetAccount ensures that no value is present for Account, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReviewableEntitlementAccount.md b/docs/tools/sdk/go/Reference/V3/Models/ReviewableEntitlementAccount.md new file mode 100644 index 000000000..9b58af5da --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReviewableEntitlementAccount.md @@ -0,0 +1,420 @@ +--- +id: reviewable-entitlement-account +title: ReviewableEntitlementAccount +pagination_label: ReviewableEntitlementAccount +sidebar_label: ReviewableEntitlementAccount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewableEntitlementAccount', 'ReviewableEntitlementAccount'] +slug: /tools/sdk/go/v3/models/reviewable-entitlement-account +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlementAccount', 'ReviewableEntitlementAccount'] +--- + +# ReviewableEntitlementAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NativeIdentity** | Pointer to **string** | The native identity for this account | [optional] +**Disabled** | Pointer to **bool** | Indicates whether this account is currently disabled | [optional] [default to false] +**Locked** | Pointer to **bool** | Indicates whether this account is currently locked | [optional] [default to false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **NullableString** | The id associated with the account | [optional] +**Name** | Pointer to **NullableString** | The account name | [optional] +**Created** | Pointer to **NullableTime** | When the account was created | [optional] +**Modified** | Pointer to **NullableTime** | When the account was last modified | [optional] +**ActivityInsights** | Pointer to [**ActivityInsights**](activity-insights) | | [optional] +**Description** | Pointer to **NullableString** | Information about the account | [optional] +**GovernanceGroupId** | Pointer to **NullableString** | The id associated with the machine Account Governance Group | [optional] +**Owner** | Pointer to [**NullableReviewableEntitlementAccountOwner**](reviewable-entitlement-account-owner) | | [optional] + +## Methods + +### NewReviewableEntitlementAccount + +`func NewReviewableEntitlementAccount() *ReviewableEntitlementAccount` + +NewReviewableEntitlementAccount instantiates a new ReviewableEntitlementAccount 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 + +### NewReviewableEntitlementAccountWithDefaults + +`func NewReviewableEntitlementAccountWithDefaults() *ReviewableEntitlementAccount` + +NewReviewableEntitlementAccountWithDefaults instantiates a new ReviewableEntitlementAccount 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 + +### GetNativeIdentity + +`func (o *ReviewableEntitlementAccount) GetNativeIdentity() string` + +GetNativeIdentity returns the NativeIdentity field if non-nil, zero value otherwise. + +### GetNativeIdentityOk + +`func (o *ReviewableEntitlementAccount) GetNativeIdentityOk() (*string, bool)` + +GetNativeIdentityOk returns a tuple with the NativeIdentity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeIdentity + +`func (o *ReviewableEntitlementAccount) SetNativeIdentity(v string)` + +SetNativeIdentity sets NativeIdentity field to given value. + +### HasNativeIdentity + +`func (o *ReviewableEntitlementAccount) HasNativeIdentity() bool` + +HasNativeIdentity returns a boolean if a field has been set. + +### GetDisabled + +`func (o *ReviewableEntitlementAccount) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *ReviewableEntitlementAccount) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *ReviewableEntitlementAccount) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *ReviewableEntitlementAccount) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetLocked + +`func (o *ReviewableEntitlementAccount) GetLocked() bool` + +GetLocked returns the Locked field if non-nil, zero value otherwise. + +### GetLockedOk + +`func (o *ReviewableEntitlementAccount) GetLockedOk() (*bool, bool)` + +GetLockedOk returns a tuple with the Locked field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocked + +`func (o *ReviewableEntitlementAccount) SetLocked(v bool)` + +SetLocked sets Locked field to given value. + +### HasLocked + +`func (o *ReviewableEntitlementAccount) HasLocked() bool` + +HasLocked returns a boolean if a field has been set. + +### GetType + +`func (o *ReviewableEntitlementAccount) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReviewableEntitlementAccount) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReviewableEntitlementAccount) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ReviewableEntitlementAccount) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ReviewableEntitlementAccount) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewableEntitlementAccount) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewableEntitlementAccount) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReviewableEntitlementAccount) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *ReviewableEntitlementAccount) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *ReviewableEntitlementAccount) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *ReviewableEntitlementAccount) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ReviewableEntitlementAccount) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ReviewableEntitlementAccount) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ReviewableEntitlementAccount) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ReviewableEntitlementAccount) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ReviewableEntitlementAccount) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *ReviewableEntitlementAccount) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ReviewableEntitlementAccount) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ReviewableEntitlementAccount) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ReviewableEntitlementAccount) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *ReviewableEntitlementAccount) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *ReviewableEntitlementAccount) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *ReviewableEntitlementAccount) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ReviewableEntitlementAccount) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ReviewableEntitlementAccount) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ReviewableEntitlementAccount) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *ReviewableEntitlementAccount) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *ReviewableEntitlementAccount) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetActivityInsights + +`func (o *ReviewableEntitlementAccount) GetActivityInsights() ActivityInsights` + +GetActivityInsights returns the ActivityInsights field if non-nil, zero value otherwise. + +### GetActivityInsightsOk + +`func (o *ReviewableEntitlementAccount) GetActivityInsightsOk() (*ActivityInsights, bool)` + +GetActivityInsightsOk returns a tuple with the ActivityInsights field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActivityInsights + +`func (o *ReviewableEntitlementAccount) SetActivityInsights(v ActivityInsights)` + +SetActivityInsights sets ActivityInsights field to given value. + +### HasActivityInsights + +`func (o *ReviewableEntitlementAccount) HasActivityInsights() bool` + +HasActivityInsights returns a boolean if a field has been set. + +### GetDescription + +`func (o *ReviewableEntitlementAccount) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ReviewableEntitlementAccount) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ReviewableEntitlementAccount) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ReviewableEntitlementAccount) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ReviewableEntitlementAccount) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ReviewableEntitlementAccount) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetGovernanceGroupId + +`func (o *ReviewableEntitlementAccount) GetGovernanceGroupId() string` + +GetGovernanceGroupId returns the GovernanceGroupId field if non-nil, zero value otherwise. + +### GetGovernanceGroupIdOk + +`func (o *ReviewableEntitlementAccount) GetGovernanceGroupIdOk() (*string, bool)` + +GetGovernanceGroupIdOk returns a tuple with the GovernanceGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGovernanceGroupId + +`func (o *ReviewableEntitlementAccount) SetGovernanceGroupId(v string)` + +SetGovernanceGroupId sets GovernanceGroupId field to given value. + +### HasGovernanceGroupId + +`func (o *ReviewableEntitlementAccount) HasGovernanceGroupId() bool` + +HasGovernanceGroupId returns a boolean if a field has been set. + +### SetGovernanceGroupIdNil + +`func (o *ReviewableEntitlementAccount) SetGovernanceGroupIdNil(b bool)` + + SetGovernanceGroupIdNil sets the value for GovernanceGroupId to be an explicit nil + +### UnsetGovernanceGroupId +`func (o *ReviewableEntitlementAccount) UnsetGovernanceGroupId()` + +UnsetGovernanceGroupId ensures that no value is present for GovernanceGroupId, not even an explicit nil +### GetOwner + +`func (o *ReviewableEntitlementAccount) GetOwner() ReviewableEntitlementAccountOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *ReviewableEntitlementAccount) GetOwnerOk() (*ReviewableEntitlementAccountOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *ReviewableEntitlementAccount) SetOwner(v ReviewableEntitlementAccountOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *ReviewableEntitlementAccount) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *ReviewableEntitlementAccount) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *ReviewableEntitlementAccount) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReviewableEntitlementAccountOwner.md b/docs/tools/sdk/go/Reference/V3/Models/ReviewableEntitlementAccountOwner.md new file mode 100644 index 000000000..0cd4712a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReviewableEntitlementAccountOwner.md @@ -0,0 +1,136 @@ +--- +id: reviewable-entitlement-account-owner +title: ReviewableEntitlementAccountOwner +pagination_label: ReviewableEntitlementAccountOwner +sidebar_label: ReviewableEntitlementAccountOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewableEntitlementAccountOwner', 'ReviewableEntitlementAccountOwner'] +slug: /tools/sdk/go/v3/models/reviewable-entitlement-account-owner +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlementAccountOwner', 'ReviewableEntitlementAccountOwner'] +--- + +# ReviewableEntitlementAccountOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | The id associated with the machine account owner | [optional] +**Type** | Pointer to **string** | An enumeration of the types of Owner supported within the IdentityNow infrastructure. | [optional] +**DisplayName** | Pointer to **NullableString** | The machine account owner's display name | [optional] + +## Methods + +### NewReviewableEntitlementAccountOwner + +`func NewReviewableEntitlementAccountOwner() *ReviewableEntitlementAccountOwner` + +NewReviewableEntitlementAccountOwner instantiates a new ReviewableEntitlementAccountOwner 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 + +### NewReviewableEntitlementAccountOwnerWithDefaults + +`func NewReviewableEntitlementAccountOwnerWithDefaults() *ReviewableEntitlementAccountOwner` + +NewReviewableEntitlementAccountOwnerWithDefaults instantiates a new ReviewableEntitlementAccountOwner 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 + +### GetId + +`func (o *ReviewableEntitlementAccountOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewableEntitlementAccountOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewableEntitlementAccountOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReviewableEntitlementAccountOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *ReviewableEntitlementAccountOwner) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *ReviewableEntitlementAccountOwner) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetType + +`func (o *ReviewableEntitlementAccountOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ReviewableEntitlementAccountOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ReviewableEntitlementAccountOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ReviewableEntitlementAccountOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *ReviewableEntitlementAccountOwner) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *ReviewableEntitlementAccountOwner) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *ReviewableEntitlementAccountOwner) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *ReviewableEntitlementAccountOwner) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### SetDisplayNameNil + +`func (o *ReviewableEntitlementAccountOwner) SetDisplayNameNil(b bool)` + + SetDisplayNameNil sets the value for DisplayName to be an explicit nil + +### UnsetDisplayName +`func (o *ReviewableEntitlementAccountOwner) UnsetDisplayName()` + +UnsetDisplayName ensures that no value is present for DisplayName, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ReviewableRole.md b/docs/tools/sdk/go/Reference/V3/Models/ReviewableRole.md new file mode 100644 index 000000000..0b2d1c4ec --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ReviewableRole.md @@ -0,0 +1,282 @@ +--- +id: reviewable-role +title: ReviewableRole +pagination_label: ReviewableRole +sidebar_label: ReviewableRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ReviewableRole', 'ReviewableRole'] +slug: /tools/sdk/go/v3/models/reviewable-role +tags: ['SDK', 'Software Development Kit', 'ReviewableRole', 'ReviewableRole'] +--- + +# ReviewableRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id for the Role | [optional] +**Name** | Pointer to **string** | The name of the Role | [optional] +**Description** | Pointer to **string** | Information about the Role | [optional] +**Privileged** | Pointer to **bool** | Indicates if the entitlement is a privileged entitlement | [optional] +**Owner** | Pointer to [**NullableIdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**Revocable** | Pointer to **bool** | Indicates whether the Role can be revoked or requested | [optional] +**EndDate** | Pointer to **SailPointTime** | The date when a user's access expires. | [optional] +**AccessProfiles** | Pointer to [**[]ReviewableAccessProfile**](reviewable-access-profile) | The list of Access Profiles associated with this Role | [optional] +**Entitlements** | Pointer to [**[]ReviewableEntitlement**](reviewable-entitlement) | The list of entitlements associated with this Role | [optional] + +## Methods + +### NewReviewableRole + +`func NewReviewableRole() *ReviewableRole` + +NewReviewableRole instantiates a new ReviewableRole 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 + +### NewReviewableRoleWithDefaults + +`func NewReviewableRoleWithDefaults() *ReviewableRole` + +NewReviewableRoleWithDefaults instantiates a new ReviewableRole 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 + +### GetId + +`func (o *ReviewableRole) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ReviewableRole) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ReviewableRole) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ReviewableRole) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ReviewableRole) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ReviewableRole) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ReviewableRole) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ReviewableRole) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *ReviewableRole) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ReviewableRole) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ReviewableRole) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ReviewableRole) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *ReviewableRole) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *ReviewableRole) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *ReviewableRole) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *ReviewableRole) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetOwner + +`func (o *ReviewableRole) GetOwner() IdentityReferenceWithNameAndEmail` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *ReviewableRole) GetOwnerOk() (*IdentityReferenceWithNameAndEmail, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *ReviewableRole) SetOwner(v IdentityReferenceWithNameAndEmail)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *ReviewableRole) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *ReviewableRole) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *ReviewableRole) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetRevocable + +`func (o *ReviewableRole) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *ReviewableRole) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *ReviewableRole) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *ReviewableRole) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + +### GetEndDate + +`func (o *ReviewableRole) GetEndDate() SailPointTime` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *ReviewableRole) GetEndDateOk() (*SailPointTime, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndDate + +`func (o *ReviewableRole) SetEndDate(v SailPointTime)` + +SetEndDate sets EndDate field to given value. + +### HasEndDate + +`func (o *ReviewableRole) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### GetAccessProfiles + +`func (o *ReviewableRole) GetAccessProfiles() []ReviewableAccessProfile` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *ReviewableRole) GetAccessProfilesOk() (*[]ReviewableAccessProfile, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *ReviewableRole) SetAccessProfiles(v []ReviewableAccessProfile)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *ReviewableRole) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### GetEntitlements + +`func (o *ReviewableRole) GetEntitlements() []ReviewableEntitlement` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *ReviewableRole) GetEntitlementsOk() (*[]ReviewableEntitlement, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *ReviewableRole) SetEntitlements(v []ReviewableEntitlement)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *ReviewableRole) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Reviewer.md b/docs/tools/sdk/go/Reference/V3/Models/Reviewer.md new file mode 100644 index 000000000..084b97cc1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Reviewer.md @@ -0,0 +1,214 @@ +--- +id: reviewer +title: Reviewer +pagination_label: Reviewer +sidebar_label: Reviewer +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Reviewer', 'Reviewer'] +slug: /tools/sdk/go/v3/models/reviewer +tags: ['SDK', 'Software Development Kit', 'Reviewer', 'Reviewer'] +--- + +# Reviewer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the reviewer. | [optional] +**Name** | Pointer to **string** | The name of the reviewer. | [optional] +**Email** | Pointer to **string** | The email of the reviewing identity. | [optional] +**Type** | Pointer to **string** | The type of the reviewing identity. | [optional] +**Created** | Pointer to **NullableTime** | The created date of the reviewing identity. | [optional] +**Modified** | Pointer to **NullableTime** | The modified date of the reviewing identity. | [optional] + +## Methods + +### NewReviewer + +`func NewReviewer() *Reviewer` + +NewReviewer instantiates a new Reviewer 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 + +### NewReviewerWithDefaults + +`func NewReviewerWithDefaults() *Reviewer` + +NewReviewerWithDefaults instantiates a new Reviewer 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 + +### GetId + +`func (o *Reviewer) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Reviewer) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Reviewer) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Reviewer) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Reviewer) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Reviewer) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Reviewer) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Reviewer) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *Reviewer) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *Reviewer) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *Reviewer) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *Reviewer) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetType + +`func (o *Reviewer) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Reviewer) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Reviewer) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Reviewer) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetCreated + +`func (o *Reviewer) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Reviewer) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Reviewer) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Reviewer) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *Reviewer) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *Reviewer) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *Reviewer) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Reviewer) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Reviewer) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Reviewer) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *Reviewer) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *Reviewer) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Revocability.md b/docs/tools/sdk/go/Reference/V3/Models/Revocability.md new file mode 100644 index 000000000..f98f7c475 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Revocability.md @@ -0,0 +1,74 @@ +--- +id: revocability +title: Revocability +pagination_label: Revocability +sidebar_label: Revocability +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Revocability', 'Revocability'] +slug: /tools/sdk/go/v3/models/revocability +tags: ['SDK', 'Software Development Kit', 'Revocability', 'Revocability'] +--- + +# Revocability + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] + +## Methods + +### NewRevocability + +`func NewRevocability() *Revocability` + +NewRevocability instantiates a new Revocability 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 + +### NewRevocabilityWithDefaults + +`func NewRevocabilityWithDefaults() *Revocability` + +NewRevocabilityWithDefaults instantiates a new Revocability 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 + +### GetApprovalSchemes + +`func (o *Revocability) GetApprovalSchemes() []AccessProfileApprovalScheme` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *Revocability) GetApprovalSchemesOk() (*[]AccessProfileApprovalScheme, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *Revocability) SetApprovalSchemes(v []AccessProfileApprovalScheme)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *Revocability) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + +### SetApprovalSchemesNil + +`func (o *Revocability) SetApprovalSchemesNil(b bool)` + + SetApprovalSchemesNil sets the value for ApprovalSchemes to be an explicit nil + +### UnsetApprovalSchemes +`func (o *Revocability) UnsetApprovalSchemes()` + +UnsetApprovalSchemes ensures that no value is present for ApprovalSchemes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RevocabilityForRole.md b/docs/tools/sdk/go/Reference/V3/Models/RevocabilityForRole.md new file mode 100644 index 000000000..5787cd0dd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RevocabilityForRole.md @@ -0,0 +1,136 @@ +--- +id: revocability-for-role +title: RevocabilityForRole +pagination_label: RevocabilityForRole +sidebar_label: RevocabilityForRole +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RevocabilityForRole', 'RevocabilityForRole'] +slug: /tools/sdk/go/v3/models/revocability-for-role +tags: ['SDK', 'Software Development Kit', 'RevocabilityForRole', 'RevocabilityForRole'] +--- + +# RevocabilityForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **NullableBool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to false] +**DenialCommentsRequired** | Pointer to **NullableBool** | Whether an approver must provide comments when denying the request | [optional] [default to false] +**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the revocation request | [optional] + +## Methods + +### NewRevocabilityForRole + +`func NewRevocabilityForRole() *RevocabilityForRole` + +NewRevocabilityForRole instantiates a new RevocabilityForRole 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 + +### NewRevocabilityForRoleWithDefaults + +`func NewRevocabilityForRoleWithDefaults() *RevocabilityForRole` + +NewRevocabilityForRoleWithDefaults instantiates a new RevocabilityForRole 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 + +### GetCommentsRequired + +`func (o *RevocabilityForRole) GetCommentsRequired() bool` + +GetCommentsRequired returns the CommentsRequired field if non-nil, zero value otherwise. + +### GetCommentsRequiredOk + +`func (o *RevocabilityForRole) GetCommentsRequiredOk() (*bool, bool)` + +GetCommentsRequiredOk returns a tuple with the CommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCommentsRequired + +`func (o *RevocabilityForRole) SetCommentsRequired(v bool)` + +SetCommentsRequired sets CommentsRequired field to given value. + +### HasCommentsRequired + +`func (o *RevocabilityForRole) HasCommentsRequired() bool` + +HasCommentsRequired returns a boolean if a field has been set. + +### SetCommentsRequiredNil + +`func (o *RevocabilityForRole) SetCommentsRequiredNil(b bool)` + + SetCommentsRequiredNil sets the value for CommentsRequired to be an explicit nil + +### UnsetCommentsRequired +`func (o *RevocabilityForRole) UnsetCommentsRequired()` + +UnsetCommentsRequired ensures that no value is present for CommentsRequired, not even an explicit nil +### GetDenialCommentsRequired + +`func (o *RevocabilityForRole) GetDenialCommentsRequired() bool` + +GetDenialCommentsRequired returns the DenialCommentsRequired field if non-nil, zero value otherwise. + +### GetDenialCommentsRequiredOk + +`func (o *RevocabilityForRole) GetDenialCommentsRequiredOk() (*bool, bool)` + +GetDenialCommentsRequiredOk returns a tuple with the DenialCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDenialCommentsRequired + +`func (o *RevocabilityForRole) SetDenialCommentsRequired(v bool)` + +SetDenialCommentsRequired sets DenialCommentsRequired field to given value. + +### HasDenialCommentsRequired + +`func (o *RevocabilityForRole) HasDenialCommentsRequired() bool` + +HasDenialCommentsRequired returns a boolean if a field has been set. + +### SetDenialCommentsRequiredNil + +`func (o *RevocabilityForRole) SetDenialCommentsRequiredNil(b bool)` + + SetDenialCommentsRequiredNil sets the value for DenialCommentsRequired to be an explicit nil + +### UnsetDenialCommentsRequired +`func (o *RevocabilityForRole) UnsetDenialCommentsRequired()` + +UnsetDenialCommentsRequired ensures that no value is present for DenialCommentsRequired, not even an explicit nil +### GetApprovalSchemes + +`func (o *RevocabilityForRole) GetApprovalSchemes() []ApprovalSchemeForRole` + +GetApprovalSchemes returns the ApprovalSchemes field if non-nil, zero value otherwise. + +### GetApprovalSchemesOk + +`func (o *RevocabilityForRole) GetApprovalSchemesOk() (*[]ApprovalSchemeForRole, bool)` + +GetApprovalSchemesOk returns a tuple with the ApprovalSchemes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalSchemes + +`func (o *RevocabilityForRole) SetApprovalSchemes(v []ApprovalSchemeForRole)` + +SetApprovalSchemes sets ApprovalSchemes field to given value. + +### HasApprovalSchemes + +`func (o *RevocabilityForRole) HasApprovalSchemes() bool` + +HasApprovalSchemes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Role.md b/docs/tools/sdk/go/Reference/V3/Models/Role.md new file mode 100644 index 000000000..4f9f23c74 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Role.md @@ -0,0 +1,566 @@ +--- +id: role +title: Role +pagination_label: Role +sidebar_label: Role +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Role', 'Role'] +slug: /tools/sdk/go/v3/models/role +tags: ['SDK', 'Software Development Kit', 'Role', 'Role'] +--- + +# Role + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. | [optional] +**Name** | **string** | The human-readable display name of the Role | +**Created** | Pointer to **SailPointTime** | Date the Role was created | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Date the Role was last modified. | [optional] [readonly] +**Description** | Pointer to **NullableString** | A human-readable description of the Role | [optional] +**Owner** | [**OwnerReference**](owner-reference) | | +**AccessProfiles** | Pointer to [**[]AccessProfileRef**](access-profile-ref) | | [optional] +**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | | [optional] +**Membership** | Pointer to [**NullableRoleMembershipSelector**](role-membership-selector) | | [optional] +**LegacyMembershipInfo** | Pointer to **map[string]interface{}** | This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. | [optional] +**Enabled** | Pointer to **bool** | Whether the Role is enabled or not. | [optional] [default to false] +**Requestable** | Pointer to **bool** | Whether the Role can be the target of access requests. | [optional] [default to false] +**AccessRequestConfig** | Pointer to [**RequestabilityForRole**](requestability-for-role) | | [optional] +**RevocationRequestConfig** | Pointer to [**RevocabilityForRole**](revocability-for-role) | | [optional] +**Segments** | Pointer to **[]string** | List of IDs of segments, if any, to which this Role is assigned. | [optional] +**Dimensional** | Pointer to **NullableBool** | Whether the Role is dimensional. | [optional] [default to false] +**DimensionRefs** | Pointer to [**[]DimensionRef**](dimension-ref) | List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. | [optional] +**AccessModelMetadata** | Pointer to [**AttributeDTOList**](attribute-dto-list) | | [optional] + +## Methods + +### NewRole + +`func NewRole(name string, owner OwnerReference, ) *Role` + +NewRole instantiates a new Role 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 + +### NewRoleWithDefaults + +`func NewRoleWithDefaults() *Role` + +NewRoleWithDefaults instantiates a new Role 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 + +### GetId + +`func (o *Role) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Role) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Role) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Role) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Role) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Role) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Role) SetName(v string)` + +SetName sets Name field to given value. + + +### GetCreated + +`func (o *Role) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Role) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Role) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Role) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Role) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Role) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Role) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Role) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *Role) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Role) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Role) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Role) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *Role) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *Role) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwner + +`func (o *Role) GetOwner() OwnerReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Role) GetOwnerOk() (*OwnerReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Role) SetOwner(v OwnerReference)` + +SetOwner sets Owner field to given value. + + +### GetAccessProfiles + +`func (o *Role) GetAccessProfiles() []AccessProfileRef` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *Role) GetAccessProfilesOk() (*[]AccessProfileRef, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *Role) SetAccessProfiles(v []AccessProfileRef)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *Role) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### SetAccessProfilesNil + +`func (o *Role) SetAccessProfilesNil(b bool)` + + SetAccessProfilesNil sets the value for AccessProfiles to be an explicit nil + +### UnsetAccessProfiles +`func (o *Role) UnsetAccessProfiles()` + +UnsetAccessProfiles ensures that no value is present for AccessProfiles, not even an explicit nil +### GetEntitlements + +`func (o *Role) GetEntitlements() []EntitlementRef` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *Role) GetEntitlementsOk() (*[]EntitlementRef, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *Role) SetEntitlements(v []EntitlementRef)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *Role) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### GetMembership + +`func (o *Role) GetMembership() RoleMembershipSelector` + +GetMembership returns the Membership field if non-nil, zero value otherwise. + +### GetMembershipOk + +`func (o *Role) GetMembershipOk() (*RoleMembershipSelector, bool)` + +GetMembershipOk returns a tuple with the Membership field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMembership + +`func (o *Role) SetMembership(v RoleMembershipSelector)` + +SetMembership sets Membership field to given value. + +### HasMembership + +`func (o *Role) HasMembership() bool` + +HasMembership returns a boolean if a field has been set. + +### SetMembershipNil + +`func (o *Role) SetMembershipNil(b bool)` + + SetMembershipNil sets the value for Membership to be an explicit nil + +### UnsetMembership +`func (o *Role) UnsetMembership()` + +UnsetMembership ensures that no value is present for Membership, not even an explicit nil +### GetLegacyMembershipInfo + +`func (o *Role) GetLegacyMembershipInfo() map[string]interface{}` + +GetLegacyMembershipInfo returns the LegacyMembershipInfo field if non-nil, zero value otherwise. + +### GetLegacyMembershipInfoOk + +`func (o *Role) GetLegacyMembershipInfoOk() (*map[string]interface{}, bool)` + +GetLegacyMembershipInfoOk returns a tuple with the LegacyMembershipInfo field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyMembershipInfo + +`func (o *Role) SetLegacyMembershipInfo(v map[string]interface{})` + +SetLegacyMembershipInfo sets LegacyMembershipInfo field to given value. + +### HasLegacyMembershipInfo + +`func (o *Role) HasLegacyMembershipInfo() bool` + +HasLegacyMembershipInfo returns a boolean if a field has been set. + +### SetLegacyMembershipInfoNil + +`func (o *Role) SetLegacyMembershipInfoNil(b bool)` + + SetLegacyMembershipInfoNil sets the value for LegacyMembershipInfo to be an explicit nil + +### UnsetLegacyMembershipInfo +`func (o *Role) UnsetLegacyMembershipInfo()` + +UnsetLegacyMembershipInfo ensures that no value is present for LegacyMembershipInfo, not even an explicit nil +### GetEnabled + +`func (o *Role) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *Role) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *Role) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *Role) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetRequestable + +`func (o *Role) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *Role) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *Role) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *Role) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetAccessRequestConfig + +`func (o *Role) GetAccessRequestConfig() RequestabilityForRole` + +GetAccessRequestConfig returns the AccessRequestConfig field if non-nil, zero value otherwise. + +### GetAccessRequestConfigOk + +`func (o *Role) GetAccessRequestConfigOk() (*RequestabilityForRole, bool)` + +GetAccessRequestConfigOk returns a tuple with the AccessRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessRequestConfig + +`func (o *Role) SetAccessRequestConfig(v RequestabilityForRole)` + +SetAccessRequestConfig sets AccessRequestConfig field to given value. + +### HasAccessRequestConfig + +`func (o *Role) HasAccessRequestConfig() bool` + +HasAccessRequestConfig returns a boolean if a field has been set. + +### GetRevocationRequestConfig + +`func (o *Role) GetRevocationRequestConfig() RevocabilityForRole` + +GetRevocationRequestConfig returns the RevocationRequestConfig field if non-nil, zero value otherwise. + +### GetRevocationRequestConfigOk + +`func (o *Role) GetRevocationRequestConfigOk() (*RevocabilityForRole, bool)` + +GetRevocationRequestConfigOk returns a tuple with the RevocationRequestConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocationRequestConfig + +`func (o *Role) SetRevocationRequestConfig(v RevocabilityForRole)` + +SetRevocationRequestConfig sets RevocationRequestConfig field to given value. + +### HasRevocationRequestConfig + +`func (o *Role) HasRevocationRequestConfig() bool` + +HasRevocationRequestConfig returns a boolean if a field has been set. + +### GetSegments + +`func (o *Role) GetSegments() []string` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *Role) GetSegmentsOk() (*[]string, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *Role) SetSegments(v []string)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *Role) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### SetSegmentsNil + +`func (o *Role) SetSegmentsNil(b bool)` + + SetSegmentsNil sets the value for Segments to be an explicit nil + +### UnsetSegments +`func (o *Role) UnsetSegments()` + +UnsetSegments ensures that no value is present for Segments, not even an explicit nil +### GetDimensional + +`func (o *Role) GetDimensional() bool` + +GetDimensional returns the Dimensional field if non-nil, zero value otherwise. + +### GetDimensionalOk + +`func (o *Role) GetDimensionalOk() (*bool, bool)` + +GetDimensionalOk returns a tuple with the Dimensional field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensional + +`func (o *Role) SetDimensional(v bool)` + +SetDimensional sets Dimensional field to given value. + +### HasDimensional + +`func (o *Role) HasDimensional() bool` + +HasDimensional returns a boolean if a field has been set. + +### SetDimensionalNil + +`func (o *Role) SetDimensionalNil(b bool)` + + SetDimensionalNil sets the value for Dimensional to be an explicit nil + +### UnsetDimensional +`func (o *Role) UnsetDimensional()` + +UnsetDimensional ensures that no value is present for Dimensional, not even an explicit nil +### GetDimensionRefs + +`func (o *Role) GetDimensionRefs() []DimensionRef` + +GetDimensionRefs returns the DimensionRefs field if non-nil, zero value otherwise. + +### GetDimensionRefsOk + +`func (o *Role) GetDimensionRefsOk() (*[]DimensionRef, bool)` + +GetDimensionRefsOk returns a tuple with the DimensionRefs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensionRefs + +`func (o *Role) SetDimensionRefs(v []DimensionRef)` + +SetDimensionRefs sets DimensionRefs field to given value. + +### HasDimensionRefs + +`func (o *Role) HasDimensionRefs() bool` + +HasDimensionRefs returns a boolean if a field has been set. + +### SetDimensionRefsNil + +`func (o *Role) SetDimensionRefsNil(b bool)` + + SetDimensionRefsNil sets the value for DimensionRefs to be an explicit nil + +### UnsetDimensionRefs +`func (o *Role) UnsetDimensionRefs()` + +UnsetDimensionRefs ensures that no value is present for DimensionRefs, not even an explicit nil +### GetAccessModelMetadata + +`func (o *Role) GetAccessModelMetadata() AttributeDTOList` + +GetAccessModelMetadata returns the AccessModelMetadata field if non-nil, zero value otherwise. + +### GetAccessModelMetadataOk + +`func (o *Role) GetAccessModelMetadataOk() (*AttributeDTOList, bool)` + +GetAccessModelMetadataOk returns a tuple with the AccessModelMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessModelMetadata + +`func (o *Role) SetAccessModelMetadata(v AttributeDTOList)` + +SetAccessModelMetadata sets AccessModelMetadata field to given value. + +### HasAccessModelMetadata + +`func (o *Role) HasAccessModelMetadata() bool` + +HasAccessModelMetadata returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleAssignmentSourceType.md b/docs/tools/sdk/go/Reference/V3/Models/RoleAssignmentSourceType.md new file mode 100644 index 000000000..0e22658ac --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleAssignmentSourceType.md @@ -0,0 +1,21 @@ +--- +id: role-assignment-source-type +title: RoleAssignmentSourceType +pagination_label: RoleAssignmentSourceType +sidebar_label: RoleAssignmentSourceType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleAssignmentSourceType', 'RoleAssignmentSourceType'] +slug: /tools/sdk/go/v3/models/role-assignment-source-type +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentSourceType', 'RoleAssignmentSourceType'] +--- + +# RoleAssignmentSourceType + +## Enum + + +* `ACCESS_REQUEST` (value: `"ACCESS_REQUEST"`) + +* `ROLE_MEMBERSHIP` (value: `"ROLE_MEMBERSHIP"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleBulkDeleteRequest.md b/docs/tools/sdk/go/Reference/V3/Models/RoleBulkDeleteRequest.md new file mode 100644 index 000000000..b139ad3c9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleBulkDeleteRequest.md @@ -0,0 +1,59 @@ +--- +id: role-bulk-delete-request +title: RoleBulkDeleteRequest +pagination_label: RoleBulkDeleteRequest +sidebar_label: RoleBulkDeleteRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleBulkDeleteRequest', 'RoleBulkDeleteRequest'] +slug: /tools/sdk/go/v3/models/role-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'RoleBulkDeleteRequest', 'RoleBulkDeleteRequest'] +--- + +# RoleBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleIds** | **[]string** | List of IDs of Roles to be deleted. | + +## Methods + +### NewRoleBulkDeleteRequest + +`func NewRoleBulkDeleteRequest(roleIds []string, ) *RoleBulkDeleteRequest` + +NewRoleBulkDeleteRequest instantiates a new RoleBulkDeleteRequest 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 + +### NewRoleBulkDeleteRequestWithDefaults + +`func NewRoleBulkDeleteRequestWithDefaults() *RoleBulkDeleteRequest` + +NewRoleBulkDeleteRequestWithDefaults instantiates a new RoleBulkDeleteRequest 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 + +### GetRoleIds + +`func (o *RoleBulkDeleteRequest) GetRoleIds() []string` + +GetRoleIds returns the RoleIds field if non-nil, zero value otherwise. + +### GetRoleIdsOk + +`func (o *RoleBulkDeleteRequest) GetRoleIdsOk() (*[]string, bool)` + +GetRoleIdsOk returns a tuple with the RoleIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleIds + +`func (o *RoleBulkDeleteRequest) SetRoleIds(v []string)` + +SetRoleIds sets RoleIds field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaKey.md b/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaKey.md new file mode 100644 index 000000000..32d3eeef3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaKey.md @@ -0,0 +1,116 @@ +--- +id: role-criteria-key +title: RoleCriteriaKey +pagination_label: RoleCriteriaKey +sidebar_label: RoleCriteriaKey +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaKey', 'RoleCriteriaKey'] +slug: /tools/sdk/go/v3/models/role-criteria-key +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKey', 'RoleCriteriaKey'] +--- + +# RoleCriteriaKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**RoleCriteriaKeyType**](role-criteria-key-type) | | +**Property** | **string** | The name of the attribute or entitlement to which the associated criteria applies. | +**SourceId** | Pointer to **NullableString** | ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT | [optional] + +## Methods + +### NewRoleCriteriaKey + +`func NewRoleCriteriaKey(type_ RoleCriteriaKeyType, property string, ) *RoleCriteriaKey` + +NewRoleCriteriaKey instantiates a new RoleCriteriaKey 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 + +### NewRoleCriteriaKeyWithDefaults + +`func NewRoleCriteriaKeyWithDefaults() *RoleCriteriaKey` + +NewRoleCriteriaKeyWithDefaults instantiates a new RoleCriteriaKey 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 + +### GetType + +`func (o *RoleCriteriaKey) GetType() RoleCriteriaKeyType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleCriteriaKey) GetTypeOk() (*RoleCriteriaKeyType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleCriteriaKey) SetType(v RoleCriteriaKeyType)` + +SetType sets Type field to given value. + + +### GetProperty + +`func (o *RoleCriteriaKey) GetProperty() string` + +GetProperty returns the Property field if non-nil, zero value otherwise. + +### GetPropertyOk + +`func (o *RoleCriteriaKey) GetPropertyOk() (*string, bool)` + +GetPropertyOk returns a tuple with the Property field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperty + +`func (o *RoleCriteriaKey) SetProperty(v string)` + +SetProperty sets Property field to given value. + + +### GetSourceId + +`func (o *RoleCriteriaKey) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *RoleCriteriaKey) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *RoleCriteriaKey) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *RoleCriteriaKey) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### SetSourceIdNil + +`func (o *RoleCriteriaKey) SetSourceIdNil(b bool)` + + SetSourceIdNil sets the value for SourceId to be an explicit nil + +### UnsetSourceId +`func (o *RoleCriteriaKey) UnsetSourceId()` + +UnsetSourceId ensures that no value is present for SourceId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaKeyType.md b/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaKeyType.md new file mode 100644 index 000000000..07eb6fdac --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaKeyType.md @@ -0,0 +1,23 @@ +--- +id: role-criteria-key-type +title: RoleCriteriaKeyType +pagination_label: RoleCriteriaKeyType +sidebar_label: RoleCriteriaKeyType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaKeyType', 'RoleCriteriaKeyType'] +slug: /tools/sdk/go/v3/models/role-criteria-key-type +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKeyType', 'RoleCriteriaKeyType'] +--- + +# RoleCriteriaKeyType + +## Enum + + +* `IDENTITY` (value: `"IDENTITY"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaLevel1.md b/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaLevel1.md new file mode 100644 index 000000000..8396d72b5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaLevel1.md @@ -0,0 +1,172 @@ +--- +id: role-criteria-level1 +title: RoleCriteriaLevel1 +pagination_label: RoleCriteriaLevel1 +sidebar_label: RoleCriteriaLevel1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaLevel1', 'RoleCriteriaLevel1'] +slug: /tools/sdk/go/v3/models/role-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel1', 'RoleCriteriaLevel1'] +--- + +# RoleCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableRoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **NullableString** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]RoleCriteriaLevel2**](role-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Methods + +### NewRoleCriteriaLevel1 + +`func NewRoleCriteriaLevel1() *RoleCriteriaLevel1` + +NewRoleCriteriaLevel1 instantiates a new RoleCriteriaLevel1 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 + +### NewRoleCriteriaLevel1WithDefaults + +`func NewRoleCriteriaLevel1WithDefaults() *RoleCriteriaLevel1` + +NewRoleCriteriaLevel1WithDefaults instantiates a new RoleCriteriaLevel1 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 + +### GetOperation + +`func (o *RoleCriteriaLevel1) GetOperation() RoleCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleCriteriaLevel1) GetOperationOk() (*RoleCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleCriteriaLevel1) SetOperation(v RoleCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *RoleCriteriaLevel1) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *RoleCriteriaLevel1) GetKey() RoleCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *RoleCriteriaLevel1) GetKeyOk() (*RoleCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *RoleCriteriaLevel1) SetKey(v RoleCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *RoleCriteriaLevel1) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *RoleCriteriaLevel1) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *RoleCriteriaLevel1) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *RoleCriteriaLevel1) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *RoleCriteriaLevel1) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *RoleCriteriaLevel1) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *RoleCriteriaLevel1) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + +### SetStringValueNil + +`func (o *RoleCriteriaLevel1) SetStringValueNil(b bool)` + + SetStringValueNil sets the value for StringValue to be an explicit nil + +### UnsetStringValue +`func (o *RoleCriteriaLevel1) UnsetStringValue()` + +UnsetStringValue ensures that no value is present for StringValue, not even an explicit nil +### GetChildren + +`func (o *RoleCriteriaLevel1) GetChildren() []RoleCriteriaLevel2` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *RoleCriteriaLevel1) GetChildrenOk() (*[]RoleCriteriaLevel2, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *RoleCriteriaLevel1) SetChildren(v []RoleCriteriaLevel2)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *RoleCriteriaLevel1) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *RoleCriteriaLevel1) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *RoleCriteriaLevel1) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaLevel2.md b/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaLevel2.md new file mode 100644 index 000000000..fb9bba15c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaLevel2.md @@ -0,0 +1,172 @@ +--- +id: role-criteria-level2 +title: RoleCriteriaLevel2 +pagination_label: RoleCriteriaLevel2 +sidebar_label: RoleCriteriaLevel2 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaLevel2', 'RoleCriteriaLevel2'] +slug: /tools/sdk/go/v3/models/role-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel2', 'RoleCriteriaLevel2'] +--- + +# RoleCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableRoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **NullableString** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]RoleCriteriaLevel3**](role-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Methods + +### NewRoleCriteriaLevel2 + +`func NewRoleCriteriaLevel2() *RoleCriteriaLevel2` + +NewRoleCriteriaLevel2 instantiates a new RoleCriteriaLevel2 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 + +### NewRoleCriteriaLevel2WithDefaults + +`func NewRoleCriteriaLevel2WithDefaults() *RoleCriteriaLevel2` + +NewRoleCriteriaLevel2WithDefaults instantiates a new RoleCriteriaLevel2 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 + +### GetOperation + +`func (o *RoleCriteriaLevel2) GetOperation() RoleCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleCriteriaLevel2) GetOperationOk() (*RoleCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleCriteriaLevel2) SetOperation(v RoleCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *RoleCriteriaLevel2) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *RoleCriteriaLevel2) GetKey() RoleCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *RoleCriteriaLevel2) GetKeyOk() (*RoleCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *RoleCriteriaLevel2) SetKey(v RoleCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *RoleCriteriaLevel2) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *RoleCriteriaLevel2) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *RoleCriteriaLevel2) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *RoleCriteriaLevel2) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *RoleCriteriaLevel2) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *RoleCriteriaLevel2) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *RoleCriteriaLevel2) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + +### SetStringValueNil + +`func (o *RoleCriteriaLevel2) SetStringValueNil(b bool)` + + SetStringValueNil sets the value for StringValue to be an explicit nil + +### UnsetStringValue +`func (o *RoleCriteriaLevel2) UnsetStringValue()` + +UnsetStringValue ensures that no value is present for StringValue, not even an explicit nil +### GetChildren + +`func (o *RoleCriteriaLevel2) GetChildren() []RoleCriteriaLevel3` + +GetChildren returns the Children field if non-nil, zero value otherwise. + +### GetChildrenOk + +`func (o *RoleCriteriaLevel2) GetChildrenOk() (*[]RoleCriteriaLevel3, bool)` + +GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChildren + +`func (o *RoleCriteriaLevel2) SetChildren(v []RoleCriteriaLevel3)` + +SetChildren sets Children field to given value. + +### HasChildren + +`func (o *RoleCriteriaLevel2) HasChildren() bool` + +HasChildren returns a boolean if a field has been set. + +### SetChildrenNil + +`func (o *RoleCriteriaLevel2) SetChildrenNil(b bool)` + + SetChildrenNil sets the value for Children to be an explicit nil + +### UnsetChildren +`func (o *RoleCriteriaLevel2) UnsetChildren()` + +UnsetChildren ensures that no value is present for Children, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaLevel3.md b/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaLevel3.md new file mode 100644 index 000000000..285190212 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaLevel3.md @@ -0,0 +1,126 @@ +--- +id: role-criteria-level3 +title: RoleCriteriaLevel3 +pagination_label: RoleCriteriaLevel3 +sidebar_label: RoleCriteriaLevel3 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaLevel3', 'RoleCriteriaLevel3'] +slug: /tools/sdk/go/v3/models/role-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel3', 'RoleCriteriaLevel3'] +--- + +# RoleCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**NullableRoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **string** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] + +## Methods + +### NewRoleCriteriaLevel3 + +`func NewRoleCriteriaLevel3() *RoleCriteriaLevel3` + +NewRoleCriteriaLevel3 instantiates a new RoleCriteriaLevel3 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 + +### NewRoleCriteriaLevel3WithDefaults + +`func NewRoleCriteriaLevel3WithDefaults() *RoleCriteriaLevel3` + +NewRoleCriteriaLevel3WithDefaults instantiates a new RoleCriteriaLevel3 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 + +### GetOperation + +`func (o *RoleCriteriaLevel3) GetOperation() RoleCriteriaOperation` + +GetOperation returns the Operation field if non-nil, zero value otherwise. + +### GetOperationOk + +`func (o *RoleCriteriaLevel3) GetOperationOk() (*RoleCriteriaOperation, bool)` + +GetOperationOk returns a tuple with the Operation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperation + +`func (o *RoleCriteriaLevel3) SetOperation(v RoleCriteriaOperation)` + +SetOperation sets Operation field to given value. + +### HasOperation + +`func (o *RoleCriteriaLevel3) HasOperation() bool` + +HasOperation returns a boolean if a field has been set. + +### GetKey + +`func (o *RoleCriteriaLevel3) GetKey() RoleCriteriaKey` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *RoleCriteriaLevel3) GetKeyOk() (*RoleCriteriaKey, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *RoleCriteriaLevel3) SetKey(v RoleCriteriaKey)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *RoleCriteriaLevel3) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### SetKeyNil + +`func (o *RoleCriteriaLevel3) SetKeyNil(b bool)` + + SetKeyNil sets the value for Key to be an explicit nil + +### UnsetKey +`func (o *RoleCriteriaLevel3) UnsetKey()` + +UnsetKey ensures that no value is present for Key, not even an explicit nil +### GetStringValue + +`func (o *RoleCriteriaLevel3) GetStringValue() string` + +GetStringValue returns the StringValue field if non-nil, zero value otherwise. + +### GetStringValueOk + +`func (o *RoleCriteriaLevel3) GetStringValueOk() (*string, bool)` + +GetStringValueOk returns a tuple with the StringValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStringValue + +`func (o *RoleCriteriaLevel3) SetStringValue(v string)` + +SetStringValue sets StringValue field to given value. + +### HasStringValue + +`func (o *RoleCriteriaLevel3) HasStringValue() bool` + +HasStringValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaOperation.md b/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaOperation.md new file mode 100644 index 000000000..1f38bf678 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleCriteriaOperation.md @@ -0,0 +1,31 @@ +--- +id: role-criteria-operation +title: RoleCriteriaOperation +pagination_label: RoleCriteriaOperation +sidebar_label: RoleCriteriaOperation +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleCriteriaOperation', 'RoleCriteriaOperation'] +slug: /tools/sdk/go/v3/models/role-criteria-operation +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaOperation', 'RoleCriteriaOperation'] +--- + +# RoleCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `STARTS_WITH` (value: `"STARTS_WITH"`) + +* `ENDS_WITH` (value: `"ENDS_WITH"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleDocument.md b/docs/tools/sdk/go/Reference/V3/Models/RoleDocument.md new file mode 100644 index 000000000..4adef5cc1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleDocument.md @@ -0,0 +1,694 @@ +--- +id: role-document +title: RoleDocument +pagination_label: RoleDocument +sidebar_label: RoleDocument +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleDocument', 'RoleDocument'] +slug: /tools/sdk/go/v3/models/role-document +tags: ['SDK', 'Software Development Kit', 'RoleDocument', 'RoleDocument'] +--- + +# RoleDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Access item's description. | [optional] +**Created** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | Pointer to **NullableTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **NullableTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Enabled** | Pointer to **bool** | Indicates whether the access item is currently enabled. | [optional] [default to false] +**Requestable** | Pointer to **bool** | Indicates whether the access item can be requested. | [optional] [default to true] +**RequestCommentsRequired** | Pointer to **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to false] +**Owner** | Pointer to [**BaseAccessOwner**](base-access-owner) | | [optional] +**Id** | **string** | ID of the role. | +**Name** | **string** | Name of the role. | +**AccessProfiles** | Pointer to [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional] +**AccessProfileCount** | Pointer to **NullableInt32** | Number of access profiles included with the role. | [optional] +**Tags** | Pointer to **[]string** | Tags that have been applied to the object. | [optional] +**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] +**SegmentCount** | Pointer to **NullableInt32** | Number of segments with the role. | [optional] +**Entitlements** | Pointer to [**[]RoleDocumentAllOfEntitlements**](role-document-all-of-entitlements) | Entitlements included with the role. | [optional] +**EntitlementCount** | Pointer to **NullableInt32** | Number of entitlements included with the role. | [optional] +**Dimensional** | Pointer to **bool** | | [optional] [default to false] +**DimensionSchemaAttributeCount** | Pointer to **NullableInt32** | Number of dimension attributes included with the role. | [optional] +**DimensionSchemaAttributes** | Pointer to [**[]RoleDocumentAllOfDimensionSchemaAttributes**](role-document-all-of-dimension-schema-attributes) | Dimension attributes included with the role. | [optional] +**Dimensions** | Pointer to [**[]RoleDocumentAllOfDimensions**](role-document-all-of-dimensions) | | [optional] + +## Methods + +### NewRoleDocument + +`func NewRoleDocument(id string, name string, ) *RoleDocument` + +NewRoleDocument instantiates a new RoleDocument 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 + +### NewRoleDocumentWithDefaults + +`func NewRoleDocumentWithDefaults() *RoleDocument` + +NewRoleDocumentWithDefaults instantiates a new RoleDocument 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 + +### GetDescription + +`func (o *RoleDocument) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleDocument) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleDocument) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleDocument) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetCreated + +`func (o *RoleDocument) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RoleDocument) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *RoleDocument) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *RoleDocument) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *RoleDocument) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *RoleDocument) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *RoleDocument) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *RoleDocument) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *RoleDocument) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *RoleDocument) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *RoleDocument) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *RoleDocument) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSynced + +`func (o *RoleDocument) GetSynced() SailPointTime` + +GetSynced returns the Synced field if non-nil, zero value otherwise. + +### GetSyncedOk + +`func (o *RoleDocument) GetSyncedOk() (*SailPointTime, bool)` + +GetSyncedOk returns a tuple with the Synced field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSynced + +`func (o *RoleDocument) SetSynced(v SailPointTime)` + +SetSynced sets Synced field to given value. + +### HasSynced + +`func (o *RoleDocument) HasSynced() bool` + +HasSynced returns a boolean if a field has been set. + +### SetSyncedNil + +`func (o *RoleDocument) SetSyncedNil(b bool)` + + SetSyncedNil sets the value for Synced to be an explicit nil + +### UnsetSynced +`func (o *RoleDocument) UnsetSynced()` + +UnsetSynced ensures that no value is present for Synced, not even an explicit nil +### GetEnabled + +`func (o *RoleDocument) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *RoleDocument) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *RoleDocument) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *RoleDocument) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetRequestable + +`func (o *RoleDocument) GetRequestable() bool` + +GetRequestable returns the Requestable field if non-nil, zero value otherwise. + +### GetRequestableOk + +`func (o *RoleDocument) GetRequestableOk() (*bool, bool)` + +GetRequestableOk returns a tuple with the Requestable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestable + +`func (o *RoleDocument) SetRequestable(v bool)` + +SetRequestable sets Requestable field to given value. + +### HasRequestable + +`func (o *RoleDocument) HasRequestable() bool` + +HasRequestable returns a boolean if a field has been set. + +### GetRequestCommentsRequired + +`func (o *RoleDocument) GetRequestCommentsRequired() bool` + +GetRequestCommentsRequired returns the RequestCommentsRequired field if non-nil, zero value otherwise. + +### GetRequestCommentsRequiredOk + +`func (o *RoleDocument) GetRequestCommentsRequiredOk() (*bool, bool)` + +GetRequestCommentsRequiredOk returns a tuple with the RequestCommentsRequired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestCommentsRequired + +`func (o *RoleDocument) SetRequestCommentsRequired(v bool)` + +SetRequestCommentsRequired sets RequestCommentsRequired field to given value. + +### HasRequestCommentsRequired + +`func (o *RoleDocument) HasRequestCommentsRequired() bool` + +HasRequestCommentsRequired returns a boolean if a field has been set. + +### GetOwner + +`func (o *RoleDocument) GetOwner() BaseAccessOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *RoleDocument) GetOwnerOk() (*BaseAccessOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *RoleDocument) SetOwner(v BaseAccessOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *RoleDocument) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetId + +`func (o *RoleDocument) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleDocument) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleDocument) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *RoleDocument) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleDocument) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleDocument) SetName(v string)` + +SetName sets Name field to given value. + + +### GetAccessProfiles + +`func (o *RoleDocument) GetAccessProfiles() []BaseAccessProfile` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *RoleDocument) GetAccessProfilesOk() (*[]BaseAccessProfile, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *RoleDocument) SetAccessProfiles(v []BaseAccessProfile)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *RoleDocument) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### SetAccessProfilesNil + +`func (o *RoleDocument) SetAccessProfilesNil(b bool)` + + SetAccessProfilesNil sets the value for AccessProfiles to be an explicit nil + +### UnsetAccessProfiles +`func (o *RoleDocument) UnsetAccessProfiles()` + +UnsetAccessProfiles ensures that no value is present for AccessProfiles, not even an explicit nil +### GetAccessProfileCount + +`func (o *RoleDocument) GetAccessProfileCount() int32` + +GetAccessProfileCount returns the AccessProfileCount field if non-nil, zero value otherwise. + +### GetAccessProfileCountOk + +`func (o *RoleDocument) GetAccessProfileCountOk() (*int32, bool)` + +GetAccessProfileCountOk returns a tuple with the AccessProfileCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfileCount + +`func (o *RoleDocument) SetAccessProfileCount(v int32)` + +SetAccessProfileCount sets AccessProfileCount field to given value. + +### HasAccessProfileCount + +`func (o *RoleDocument) HasAccessProfileCount() bool` + +HasAccessProfileCount returns a boolean if a field has been set. + +### SetAccessProfileCountNil + +`func (o *RoleDocument) SetAccessProfileCountNil(b bool)` + + SetAccessProfileCountNil sets the value for AccessProfileCount to be an explicit nil + +### UnsetAccessProfileCount +`func (o *RoleDocument) UnsetAccessProfileCount()` + +UnsetAccessProfileCount ensures that no value is present for AccessProfileCount, not even an explicit nil +### GetTags + +`func (o *RoleDocument) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *RoleDocument) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *RoleDocument) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *RoleDocument) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetSegments + +`func (o *RoleDocument) GetSegments() []BaseSegment` + +GetSegments returns the Segments field if non-nil, zero value otherwise. + +### GetSegmentsOk + +`func (o *RoleDocument) GetSegmentsOk() (*[]BaseSegment, bool)` + +GetSegmentsOk returns a tuple with the Segments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegments + +`func (o *RoleDocument) SetSegments(v []BaseSegment)` + +SetSegments sets Segments field to given value. + +### HasSegments + +`func (o *RoleDocument) HasSegments() bool` + +HasSegments returns a boolean if a field has been set. + +### SetSegmentsNil + +`func (o *RoleDocument) SetSegmentsNil(b bool)` + + SetSegmentsNil sets the value for Segments to be an explicit nil + +### UnsetSegments +`func (o *RoleDocument) UnsetSegments()` + +UnsetSegments ensures that no value is present for Segments, not even an explicit nil +### GetSegmentCount + +`func (o *RoleDocument) GetSegmentCount() int32` + +GetSegmentCount returns the SegmentCount field if non-nil, zero value otherwise. + +### GetSegmentCountOk + +`func (o *RoleDocument) GetSegmentCountOk() (*int32, bool)` + +GetSegmentCountOk returns a tuple with the SegmentCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSegmentCount + +`func (o *RoleDocument) SetSegmentCount(v int32)` + +SetSegmentCount sets SegmentCount field to given value. + +### HasSegmentCount + +`func (o *RoleDocument) HasSegmentCount() bool` + +HasSegmentCount returns a boolean if a field has been set. + +### SetSegmentCountNil + +`func (o *RoleDocument) SetSegmentCountNil(b bool)` + + SetSegmentCountNil sets the value for SegmentCount to be an explicit nil + +### UnsetSegmentCount +`func (o *RoleDocument) UnsetSegmentCount()` + +UnsetSegmentCount ensures that no value is present for SegmentCount, not even an explicit nil +### GetEntitlements + +`func (o *RoleDocument) GetEntitlements() []RoleDocumentAllOfEntitlements` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *RoleDocument) GetEntitlementsOk() (*[]RoleDocumentAllOfEntitlements, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *RoleDocument) SetEntitlements(v []RoleDocumentAllOfEntitlements)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *RoleDocument) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### SetEntitlementsNil + +`func (o *RoleDocument) SetEntitlementsNil(b bool)` + + SetEntitlementsNil sets the value for Entitlements to be an explicit nil + +### UnsetEntitlements +`func (o *RoleDocument) UnsetEntitlements()` + +UnsetEntitlements ensures that no value is present for Entitlements, not even an explicit nil +### GetEntitlementCount + +`func (o *RoleDocument) GetEntitlementCount() int32` + +GetEntitlementCount returns the EntitlementCount field if non-nil, zero value otherwise. + +### GetEntitlementCountOk + +`func (o *RoleDocument) GetEntitlementCountOk() (*int32, bool)` + +GetEntitlementCountOk returns a tuple with the EntitlementCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlementCount + +`func (o *RoleDocument) SetEntitlementCount(v int32)` + +SetEntitlementCount sets EntitlementCount field to given value. + +### HasEntitlementCount + +`func (o *RoleDocument) HasEntitlementCount() bool` + +HasEntitlementCount returns a boolean if a field has been set. + +### SetEntitlementCountNil + +`func (o *RoleDocument) SetEntitlementCountNil(b bool)` + + SetEntitlementCountNil sets the value for EntitlementCount to be an explicit nil + +### UnsetEntitlementCount +`func (o *RoleDocument) UnsetEntitlementCount()` + +UnsetEntitlementCount ensures that no value is present for EntitlementCount, not even an explicit nil +### GetDimensional + +`func (o *RoleDocument) GetDimensional() bool` + +GetDimensional returns the Dimensional field if non-nil, zero value otherwise. + +### GetDimensionalOk + +`func (o *RoleDocument) GetDimensionalOk() (*bool, bool)` + +GetDimensionalOk returns a tuple with the Dimensional field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensional + +`func (o *RoleDocument) SetDimensional(v bool)` + +SetDimensional sets Dimensional field to given value. + +### HasDimensional + +`func (o *RoleDocument) HasDimensional() bool` + +HasDimensional returns a boolean if a field has been set. + +### GetDimensionSchemaAttributeCount + +`func (o *RoleDocument) GetDimensionSchemaAttributeCount() int32` + +GetDimensionSchemaAttributeCount returns the DimensionSchemaAttributeCount field if non-nil, zero value otherwise. + +### GetDimensionSchemaAttributeCountOk + +`func (o *RoleDocument) GetDimensionSchemaAttributeCountOk() (*int32, bool)` + +GetDimensionSchemaAttributeCountOk returns a tuple with the DimensionSchemaAttributeCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensionSchemaAttributeCount + +`func (o *RoleDocument) SetDimensionSchemaAttributeCount(v int32)` + +SetDimensionSchemaAttributeCount sets DimensionSchemaAttributeCount field to given value. + +### HasDimensionSchemaAttributeCount + +`func (o *RoleDocument) HasDimensionSchemaAttributeCount() bool` + +HasDimensionSchemaAttributeCount returns a boolean if a field has been set. + +### SetDimensionSchemaAttributeCountNil + +`func (o *RoleDocument) SetDimensionSchemaAttributeCountNil(b bool)` + + SetDimensionSchemaAttributeCountNil sets the value for DimensionSchemaAttributeCount to be an explicit nil + +### UnsetDimensionSchemaAttributeCount +`func (o *RoleDocument) UnsetDimensionSchemaAttributeCount()` + +UnsetDimensionSchemaAttributeCount ensures that no value is present for DimensionSchemaAttributeCount, not even an explicit nil +### GetDimensionSchemaAttributes + +`func (o *RoleDocument) GetDimensionSchemaAttributes() []RoleDocumentAllOfDimensionSchemaAttributes` + +GetDimensionSchemaAttributes returns the DimensionSchemaAttributes field if non-nil, zero value otherwise. + +### GetDimensionSchemaAttributesOk + +`func (o *RoleDocument) GetDimensionSchemaAttributesOk() (*[]RoleDocumentAllOfDimensionSchemaAttributes, bool)` + +GetDimensionSchemaAttributesOk returns a tuple with the DimensionSchemaAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensionSchemaAttributes + +`func (o *RoleDocument) SetDimensionSchemaAttributes(v []RoleDocumentAllOfDimensionSchemaAttributes)` + +SetDimensionSchemaAttributes sets DimensionSchemaAttributes field to given value. + +### HasDimensionSchemaAttributes + +`func (o *RoleDocument) HasDimensionSchemaAttributes() bool` + +HasDimensionSchemaAttributes returns a boolean if a field has been set. + +### SetDimensionSchemaAttributesNil + +`func (o *RoleDocument) SetDimensionSchemaAttributesNil(b bool)` + + SetDimensionSchemaAttributesNil sets the value for DimensionSchemaAttributes to be an explicit nil + +### UnsetDimensionSchemaAttributes +`func (o *RoleDocument) UnsetDimensionSchemaAttributes()` + +UnsetDimensionSchemaAttributes ensures that no value is present for DimensionSchemaAttributes, not even an explicit nil +### GetDimensions + +`func (o *RoleDocument) GetDimensions() []RoleDocumentAllOfDimensions` + +GetDimensions returns the Dimensions field if non-nil, zero value otherwise. + +### GetDimensionsOk + +`func (o *RoleDocument) GetDimensionsOk() (*[]RoleDocumentAllOfDimensions, bool)` + +GetDimensionsOk returns a tuple with the Dimensions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDimensions + +`func (o *RoleDocument) SetDimensions(v []RoleDocumentAllOfDimensions)` + +SetDimensions sets Dimensions field to given value. + +### HasDimensions + +`func (o *RoleDocument) HasDimensions() bool` + +HasDimensions returns a boolean if a field has been set. + +### SetDimensionsNil + +`func (o *RoleDocument) SetDimensionsNil(b bool)` + + SetDimensionsNil sets the value for Dimensions to be an explicit nil + +### UnsetDimensions +`func (o *RoleDocument) UnsetDimensions()` + +UnsetDimensions ensures that no value is present for Dimensions, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleDocumentAllOfDimensionSchemaAttributes.md b/docs/tools/sdk/go/Reference/V3/Models/RoleDocumentAllOfDimensionSchemaAttributes.md new file mode 100644 index 000000000..5d51eb2c6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleDocumentAllOfDimensionSchemaAttributes.md @@ -0,0 +1,116 @@ +--- +id: role-document-all-of-dimension-schema-attributes +title: RoleDocumentAllOfDimensionSchemaAttributes +pagination_label: RoleDocumentAllOfDimensionSchemaAttributes +sidebar_label: RoleDocumentAllOfDimensionSchemaAttributes +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleDocumentAllOfDimensionSchemaAttributes', 'RoleDocumentAllOfDimensionSchemaAttributes'] +slug: /tools/sdk/go/v3/models/role-document-all-of-dimension-schema-attributes +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfDimensionSchemaAttributes', 'RoleDocumentAllOfDimensionSchemaAttributes'] +--- + +# RoleDocumentAllOfDimensionSchemaAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Derived** | Pointer to **bool** | | [optional] [default to true] +**DisplayName** | Pointer to **string** | Displayname of the dimension attribute. | [optional] +**Name** | Pointer to **string** | Name of the dimension attribute. | [optional] + +## Methods + +### NewRoleDocumentAllOfDimensionSchemaAttributes + +`func NewRoleDocumentAllOfDimensionSchemaAttributes() *RoleDocumentAllOfDimensionSchemaAttributes` + +NewRoleDocumentAllOfDimensionSchemaAttributes instantiates a new RoleDocumentAllOfDimensionSchemaAttributes 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 + +### NewRoleDocumentAllOfDimensionSchemaAttributesWithDefaults + +`func NewRoleDocumentAllOfDimensionSchemaAttributesWithDefaults() *RoleDocumentAllOfDimensionSchemaAttributes` + +NewRoleDocumentAllOfDimensionSchemaAttributesWithDefaults instantiates a new RoleDocumentAllOfDimensionSchemaAttributes 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 + +### GetDerived + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetDerived() bool` + +GetDerived returns the Derived field if non-nil, zero value otherwise. + +### GetDerivedOk + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetDerivedOk() (*bool, bool)` + +GetDerivedOk returns a tuple with the Derived field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDerived + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) SetDerived(v bool)` + +SetDerived sets Derived field to given value. + +### HasDerived + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) HasDerived() bool` + +HasDerived returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleDocumentAllOfDimensionSchemaAttributes) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleDocumentAllOfDimensions.md b/docs/tools/sdk/go/Reference/V3/Models/RoleDocumentAllOfDimensions.md new file mode 100644 index 000000000..500404fe5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleDocumentAllOfDimensions.md @@ -0,0 +1,198 @@ +--- +id: role-document-all-of-dimensions +title: RoleDocumentAllOfDimensions +pagination_label: RoleDocumentAllOfDimensions +sidebar_label: RoleDocumentAllOfDimensions +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleDocumentAllOfDimensions', 'RoleDocumentAllOfDimensions'] +slug: /tools/sdk/go/v3/models/role-document-all-of-dimensions +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfDimensions', 'RoleDocumentAllOfDimensions'] +--- + +# RoleDocumentAllOfDimensions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique ID of the dimension. | [optional] +**Name** | Pointer to **string** | Name of the dimension. | [optional] +**Description** | Pointer to **NullableString** | Description of the dimension. | [optional] +**Entitlements** | Pointer to [**[]RoleDocumentAllOfEntitlements1**](role-document-all-of-entitlements1) | Entitlements included with the role. | [optional] +**AccessProfiles** | Pointer to [**[]BaseAccessProfile**](base-access-profile) | Access profiles included in the dimension. | [optional] + +## Methods + +### NewRoleDocumentAllOfDimensions + +`func NewRoleDocumentAllOfDimensions() *RoleDocumentAllOfDimensions` + +NewRoleDocumentAllOfDimensions instantiates a new RoleDocumentAllOfDimensions 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 + +### NewRoleDocumentAllOfDimensionsWithDefaults + +`func NewRoleDocumentAllOfDimensionsWithDefaults() *RoleDocumentAllOfDimensions` + +NewRoleDocumentAllOfDimensionsWithDefaults instantiates a new RoleDocumentAllOfDimensions 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 + +### GetId + +`func (o *RoleDocumentAllOfDimensions) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleDocumentAllOfDimensions) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleDocumentAllOfDimensions) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleDocumentAllOfDimensions) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleDocumentAllOfDimensions) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleDocumentAllOfDimensions) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleDocumentAllOfDimensions) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleDocumentAllOfDimensions) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleDocumentAllOfDimensions) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleDocumentAllOfDimensions) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleDocumentAllOfDimensions) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleDocumentAllOfDimensions) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleDocumentAllOfDimensions) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleDocumentAllOfDimensions) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetEntitlements + +`func (o *RoleDocumentAllOfDimensions) GetEntitlements() []RoleDocumentAllOfEntitlements1` + +GetEntitlements returns the Entitlements field if non-nil, zero value otherwise. + +### GetEntitlementsOk + +`func (o *RoleDocumentAllOfDimensions) GetEntitlementsOk() (*[]RoleDocumentAllOfEntitlements1, bool)` + +GetEntitlementsOk returns a tuple with the Entitlements field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntitlements + +`func (o *RoleDocumentAllOfDimensions) SetEntitlements(v []RoleDocumentAllOfEntitlements1)` + +SetEntitlements sets Entitlements field to given value. + +### HasEntitlements + +`func (o *RoleDocumentAllOfDimensions) HasEntitlements() bool` + +HasEntitlements returns a boolean if a field has been set. + +### SetEntitlementsNil + +`func (o *RoleDocumentAllOfDimensions) SetEntitlementsNil(b bool)` + + SetEntitlementsNil sets the value for Entitlements to be an explicit nil + +### UnsetEntitlements +`func (o *RoleDocumentAllOfDimensions) UnsetEntitlements()` + +UnsetEntitlements ensures that no value is present for Entitlements, not even an explicit nil +### GetAccessProfiles + +`func (o *RoleDocumentAllOfDimensions) GetAccessProfiles() []BaseAccessProfile` + +GetAccessProfiles returns the AccessProfiles field if non-nil, zero value otherwise. + +### GetAccessProfilesOk + +`func (o *RoleDocumentAllOfDimensions) GetAccessProfilesOk() (*[]BaseAccessProfile, bool)` + +GetAccessProfilesOk returns a tuple with the AccessProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccessProfiles + +`func (o *RoleDocumentAllOfDimensions) SetAccessProfiles(v []BaseAccessProfile)` + +SetAccessProfiles sets AccessProfiles field to given value. + +### HasAccessProfiles + +`func (o *RoleDocumentAllOfDimensions) HasAccessProfiles() bool` + +HasAccessProfiles returns a boolean if a field has been set. + +### SetAccessProfilesNil + +`func (o *RoleDocumentAllOfDimensions) SetAccessProfilesNil(b bool)` + + SetAccessProfilesNil sets the value for AccessProfiles to be an explicit nil + +### UnsetAccessProfiles +`func (o *RoleDocumentAllOfDimensions) UnsetAccessProfiles()` + +UnsetAccessProfiles ensures that no value is present for AccessProfiles, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleDocumentAllOfEntitlements.md b/docs/tools/sdk/go/Reference/V3/Models/RoleDocumentAllOfEntitlements.md new file mode 100644 index 000000000..a02eb6ab3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleDocumentAllOfEntitlements.md @@ -0,0 +1,308 @@ +--- +id: role-document-all-of-entitlements +title: RoleDocumentAllOfEntitlements +pagination_label: RoleDocumentAllOfEntitlements +sidebar_label: RoleDocumentAllOfEntitlements +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleDocumentAllOfEntitlements', 'RoleDocumentAllOfEntitlements'] +slug: /tools/sdk/go/v3/models/role-document-all-of-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfEntitlements', 'RoleDocumentAllOfEntitlements'] +--- + +# RoleDocumentAllOfEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasPermissions** | Pointer to **bool** | Indicates whether the entitlement has permissions. | [optional] [default to false] +**Description** | Pointer to **NullableString** | Entitlement's description. | [optional] +**Attribute** | Pointer to **string** | Entitlement attribute's name. | [optional] +**Value** | Pointer to **string** | Entitlement's value. | [optional] +**Schema** | Pointer to **string** | Entitlement's schema. | [optional] +**Privileged** | Pointer to **bool** | Indicates whether the entitlement is privileged. | [optional] [default to false] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **string** | Entitlement's name. | [optional] +**SourceSchemaObjectType** | Pointer to **string** | Schema objectType. | [optional] +**Hash** | Pointer to **string** | Read-only calculated hash value of an entitlement. | [optional] + +## Methods + +### NewRoleDocumentAllOfEntitlements + +`func NewRoleDocumentAllOfEntitlements() *RoleDocumentAllOfEntitlements` + +NewRoleDocumentAllOfEntitlements instantiates a new RoleDocumentAllOfEntitlements 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 + +### NewRoleDocumentAllOfEntitlementsWithDefaults + +`func NewRoleDocumentAllOfEntitlementsWithDefaults() *RoleDocumentAllOfEntitlements` + +NewRoleDocumentAllOfEntitlementsWithDefaults instantiates a new RoleDocumentAllOfEntitlements 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 + +### GetHasPermissions + +`func (o *RoleDocumentAllOfEntitlements) GetHasPermissions() bool` + +GetHasPermissions returns the HasPermissions field if non-nil, zero value otherwise. + +### GetHasPermissionsOk + +`func (o *RoleDocumentAllOfEntitlements) GetHasPermissionsOk() (*bool, bool)` + +GetHasPermissionsOk returns a tuple with the HasPermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasPermissions + +`func (o *RoleDocumentAllOfEntitlements) SetHasPermissions(v bool)` + +SetHasPermissions sets HasPermissions field to given value. + +### HasHasPermissions + +`func (o *RoleDocumentAllOfEntitlements) HasHasPermissions() bool` + +HasHasPermissions returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleDocumentAllOfEntitlements) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleDocumentAllOfEntitlements) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleDocumentAllOfEntitlements) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleDocumentAllOfEntitlements) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleDocumentAllOfEntitlements) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleDocumentAllOfEntitlements) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAttribute + +`func (o *RoleDocumentAllOfEntitlements) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleDocumentAllOfEntitlements) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleDocumentAllOfEntitlements) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleDocumentAllOfEntitlements) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *RoleDocumentAllOfEntitlements) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *RoleDocumentAllOfEntitlements) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *RoleDocumentAllOfEntitlements) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *RoleDocumentAllOfEntitlements) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSchema + +`func (o *RoleDocumentAllOfEntitlements) GetSchema() string` + +GetSchema returns the Schema field if non-nil, zero value otherwise. + +### GetSchemaOk + +`func (o *RoleDocumentAllOfEntitlements) GetSchemaOk() (*string, bool)` + +GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchema + +`func (o *RoleDocumentAllOfEntitlements) SetSchema(v string)` + +SetSchema sets Schema field to given value. + +### HasSchema + +`func (o *RoleDocumentAllOfEntitlements) HasSchema() bool` + +HasSchema returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *RoleDocumentAllOfEntitlements) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *RoleDocumentAllOfEntitlements) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *RoleDocumentAllOfEntitlements) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *RoleDocumentAllOfEntitlements) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetId + +`func (o *RoleDocumentAllOfEntitlements) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleDocumentAllOfEntitlements) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleDocumentAllOfEntitlements) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleDocumentAllOfEntitlements) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleDocumentAllOfEntitlements) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleDocumentAllOfEntitlements) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleDocumentAllOfEntitlements) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleDocumentAllOfEntitlements) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements) GetSourceSchemaObjectType() string` + +GetSourceSchemaObjectType returns the SourceSchemaObjectType field if non-nil, zero value otherwise. + +### GetSourceSchemaObjectTypeOk + +`func (o *RoleDocumentAllOfEntitlements) GetSourceSchemaObjectTypeOk() (*string, bool)` + +GetSourceSchemaObjectTypeOk returns a tuple with the SourceSchemaObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements) SetSourceSchemaObjectType(v string)` + +SetSourceSchemaObjectType sets SourceSchemaObjectType field to given value. + +### HasSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements) HasSourceSchemaObjectType() bool` + +HasSourceSchemaObjectType returns a boolean if a field has been set. + +### GetHash + +`func (o *RoleDocumentAllOfEntitlements) GetHash() string` + +GetHash returns the Hash field if non-nil, zero value otherwise. + +### GetHashOk + +`func (o *RoleDocumentAllOfEntitlements) GetHashOk() (*string, bool)` + +GetHashOk returns a tuple with the Hash field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHash + +`func (o *RoleDocumentAllOfEntitlements) SetHash(v string)` + +SetHash sets Hash field to given value. + +### HasHash + +`func (o *RoleDocumentAllOfEntitlements) HasHash() bool` + +HasHash returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleDocumentAllOfEntitlements1.md b/docs/tools/sdk/go/Reference/V3/Models/RoleDocumentAllOfEntitlements1.md new file mode 100644 index 000000000..84622e19f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleDocumentAllOfEntitlements1.md @@ -0,0 +1,308 @@ +--- +id: role-document-all-of-entitlements1 +title: RoleDocumentAllOfEntitlements1 +pagination_label: RoleDocumentAllOfEntitlements1 +sidebar_label: RoleDocumentAllOfEntitlements1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleDocumentAllOfEntitlements1', 'RoleDocumentAllOfEntitlements1'] +slug: /tools/sdk/go/v3/models/role-document-all-of-entitlements1 +tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfEntitlements1', 'RoleDocumentAllOfEntitlements1'] +--- + +# RoleDocumentAllOfEntitlements1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasPermissions** | Pointer to **bool** | Indicates whether the entitlement has permissions. | [optional] [default to false] +**Description** | Pointer to **NullableString** | Entitlement's description. | [optional] +**Attribute** | Pointer to **string** | Entitlement attribute's name. | [optional] +**Value** | Pointer to **string** | Entitlement's value. | [optional] +**Schema** | Pointer to **string** | Entitlement's schema. | [optional] +**Privileged** | Pointer to **bool** | Indicates whether the entitlement is privileged. | [optional] [default to false] +**Id** | Pointer to **string** | Entitlement's ID. | [optional] +**Name** | Pointer to **string** | Entitlement's name. | [optional] +**SourceSchemaObjectType** | Pointer to **string** | Schema objectType. | [optional] +**Hash** | Pointer to **string** | Read-only calculated hash value of an entitlement. | [optional] + +## Methods + +### NewRoleDocumentAllOfEntitlements1 + +`func NewRoleDocumentAllOfEntitlements1() *RoleDocumentAllOfEntitlements1` + +NewRoleDocumentAllOfEntitlements1 instantiates a new RoleDocumentAllOfEntitlements1 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 + +### NewRoleDocumentAllOfEntitlements1WithDefaults + +`func NewRoleDocumentAllOfEntitlements1WithDefaults() *RoleDocumentAllOfEntitlements1` + +NewRoleDocumentAllOfEntitlements1WithDefaults instantiates a new RoleDocumentAllOfEntitlements1 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 + +### GetHasPermissions + +`func (o *RoleDocumentAllOfEntitlements1) GetHasPermissions() bool` + +GetHasPermissions returns the HasPermissions field if non-nil, zero value otherwise. + +### GetHasPermissionsOk + +`func (o *RoleDocumentAllOfEntitlements1) GetHasPermissionsOk() (*bool, bool)` + +GetHasPermissionsOk returns a tuple with the HasPermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasPermissions + +`func (o *RoleDocumentAllOfEntitlements1) SetHasPermissions(v bool)` + +SetHasPermissions sets HasPermissions field to given value. + +### HasHasPermissions + +`func (o *RoleDocumentAllOfEntitlements1) HasHasPermissions() bool` + +HasHasPermissions returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleDocumentAllOfEntitlements1) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleDocumentAllOfEntitlements1) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleDocumentAllOfEntitlements1) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleDocumentAllOfEntitlements1) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleDocumentAllOfEntitlements1) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleDocumentAllOfEntitlements1) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetAttribute + +`func (o *RoleDocumentAllOfEntitlements1) GetAttribute() string` + +GetAttribute returns the Attribute field if non-nil, zero value otherwise. + +### GetAttributeOk + +`func (o *RoleDocumentAllOfEntitlements1) GetAttributeOk() (*string, bool)` + +GetAttributeOk returns a tuple with the Attribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttribute + +`func (o *RoleDocumentAllOfEntitlements1) SetAttribute(v string)` + +SetAttribute sets Attribute field to given value. + +### HasAttribute + +`func (o *RoleDocumentAllOfEntitlements1) HasAttribute() bool` + +HasAttribute returns a boolean if a field has been set. + +### GetValue + +`func (o *RoleDocumentAllOfEntitlements1) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *RoleDocumentAllOfEntitlements1) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *RoleDocumentAllOfEntitlements1) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *RoleDocumentAllOfEntitlements1) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetSchema + +`func (o *RoleDocumentAllOfEntitlements1) GetSchema() string` + +GetSchema returns the Schema field if non-nil, zero value otherwise. + +### GetSchemaOk + +`func (o *RoleDocumentAllOfEntitlements1) GetSchemaOk() (*string, bool)` + +GetSchemaOk returns a tuple with the Schema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchema + +`func (o *RoleDocumentAllOfEntitlements1) SetSchema(v string)` + +SetSchema sets Schema field to given value. + +### HasSchema + +`func (o *RoleDocumentAllOfEntitlements1) HasSchema() bool` + +HasSchema returns a boolean if a field has been set. + +### GetPrivileged + +`func (o *RoleDocumentAllOfEntitlements1) GetPrivileged() bool` + +GetPrivileged returns the Privileged field if non-nil, zero value otherwise. + +### GetPrivilegedOk + +`func (o *RoleDocumentAllOfEntitlements1) GetPrivilegedOk() (*bool, bool)` + +GetPrivilegedOk returns a tuple with the Privileged field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivileged + +`func (o *RoleDocumentAllOfEntitlements1) SetPrivileged(v bool)` + +SetPrivileged sets Privileged field to given value. + +### HasPrivileged + +`func (o *RoleDocumentAllOfEntitlements1) HasPrivileged() bool` + +HasPrivileged returns a boolean if a field has been set. + +### GetId + +`func (o *RoleDocumentAllOfEntitlements1) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleDocumentAllOfEntitlements1) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleDocumentAllOfEntitlements1) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleDocumentAllOfEntitlements1) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleDocumentAllOfEntitlements1) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleDocumentAllOfEntitlements1) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleDocumentAllOfEntitlements1) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleDocumentAllOfEntitlements1) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements1) GetSourceSchemaObjectType() string` + +GetSourceSchemaObjectType returns the SourceSchemaObjectType field if non-nil, zero value otherwise. + +### GetSourceSchemaObjectTypeOk + +`func (o *RoleDocumentAllOfEntitlements1) GetSourceSchemaObjectTypeOk() (*string, bool)` + +GetSourceSchemaObjectTypeOk returns a tuple with the SourceSchemaObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements1) SetSourceSchemaObjectType(v string)` + +SetSourceSchemaObjectType sets SourceSchemaObjectType field to given value. + +### HasSourceSchemaObjectType + +`func (o *RoleDocumentAllOfEntitlements1) HasSourceSchemaObjectType() bool` + +HasSourceSchemaObjectType returns a boolean if a field has been set. + +### GetHash + +`func (o *RoleDocumentAllOfEntitlements1) GetHash() string` + +GetHash returns the Hash field if non-nil, zero value otherwise. + +### GetHashOk + +`func (o *RoleDocumentAllOfEntitlements1) GetHashOk() (*string, bool)` + +GetHashOk returns a tuple with the Hash field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHash + +`func (o *RoleDocumentAllOfEntitlements1) SetHash(v string)` + +SetHash sets Hash field to given value. + +### HasHash + +`func (o *RoleDocumentAllOfEntitlements1) HasHash() bool` + +HasHash returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleIdentity.md b/docs/tools/sdk/go/Reference/V3/Models/RoleIdentity.md new file mode 100644 index 000000000..2b8c7da80 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleIdentity.md @@ -0,0 +1,168 @@ +--- +id: role-identity +title: RoleIdentity +pagination_label: RoleIdentity +sidebar_label: RoleIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleIdentity', 'RoleIdentity'] +slug: /tools/sdk/go/v3/models/role-identity +tags: ['SDK', 'Software Development Kit', 'RoleIdentity', 'RoleIdentity'] +--- + +# RoleIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The ID of the Identity | [optional] +**AliasName** | Pointer to **string** | The alias / username of the Identity | [optional] +**Name** | Pointer to **string** | The human-readable display name of the Identity | [optional] +**Email** | Pointer to **string** | Email address of the Identity | [optional] +**RoleAssignmentSource** | Pointer to [**RoleAssignmentSourceType**](role-assignment-source-type) | | [optional] + +## Methods + +### NewRoleIdentity + +`func NewRoleIdentity() *RoleIdentity` + +NewRoleIdentity instantiates a new RoleIdentity 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 + +### NewRoleIdentityWithDefaults + +`func NewRoleIdentityWithDefaults() *RoleIdentity` + +NewRoleIdentityWithDefaults instantiates a new RoleIdentity 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 + +### GetId + +`func (o *RoleIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAliasName + +`func (o *RoleIdentity) GetAliasName() string` + +GetAliasName returns the AliasName field if non-nil, zero value otherwise. + +### GetAliasNameOk + +`func (o *RoleIdentity) GetAliasNameOk() (*string, bool)` + +GetAliasNameOk returns a tuple with the AliasName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAliasName + +`func (o *RoleIdentity) SetAliasName(v string)` + +SetAliasName sets AliasName field to given value. + +### HasAliasName + +`func (o *RoleIdentity) HasAliasName() bool` + +HasAliasName returns a boolean if a field has been set. + +### GetName + +`func (o *RoleIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetEmail + +`func (o *RoleIdentity) GetEmail() string` + +GetEmail returns the Email field if non-nil, zero value otherwise. + +### GetEmailOk + +`func (o *RoleIdentity) GetEmailOk() (*string, bool)` + +GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmail + +`func (o *RoleIdentity) SetEmail(v string)` + +SetEmail sets Email field to given value. + +### HasEmail + +`func (o *RoleIdentity) HasEmail() bool` + +HasEmail returns a boolean if a field has been set. + +### GetRoleAssignmentSource + +`func (o *RoleIdentity) GetRoleAssignmentSource() RoleAssignmentSourceType` + +GetRoleAssignmentSource returns the RoleAssignmentSource field if non-nil, zero value otherwise. + +### GetRoleAssignmentSourceOk + +`func (o *RoleIdentity) GetRoleAssignmentSourceOk() (*RoleAssignmentSourceType, bool)` + +GetRoleAssignmentSourceOk returns a tuple with the RoleAssignmentSource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRoleAssignmentSource + +`func (o *RoleIdentity) SetRoleAssignmentSource(v RoleAssignmentSourceType)` + +SetRoleAssignmentSource sets RoleAssignmentSource field to given value. + +### HasRoleAssignmentSource + +`func (o *RoleIdentity) HasRoleAssignmentSource() bool` + +HasRoleAssignmentSource returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleMembershipIdentity.md b/docs/tools/sdk/go/Reference/V3/Models/RoleMembershipIdentity.md new file mode 100644 index 000000000..00b67770b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleMembershipIdentity.md @@ -0,0 +1,162 @@ +--- +id: role-membership-identity +title: RoleMembershipIdentity +pagination_label: RoleMembershipIdentity +sidebar_label: RoleMembershipIdentity +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMembershipIdentity', 'RoleMembershipIdentity'] +slug: /tools/sdk/go/v3/models/role-membership-identity +tags: ['SDK', 'Software Development Kit', 'RoleMembershipIdentity', 'RoleMembershipIdentity'] +--- + +# RoleMembershipIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | Identity id | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the Identity. | [optional] +**AliasName** | Pointer to **NullableString** | User name of the Identity | [optional] + +## Methods + +### NewRoleMembershipIdentity + +`func NewRoleMembershipIdentity() *RoleMembershipIdentity` + +NewRoleMembershipIdentity instantiates a new RoleMembershipIdentity 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 + +### NewRoleMembershipIdentityWithDefaults + +`func NewRoleMembershipIdentityWithDefaults() *RoleMembershipIdentity` + +NewRoleMembershipIdentityWithDefaults instantiates a new RoleMembershipIdentity 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 + +### GetType + +`func (o *RoleMembershipIdentity) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMembershipIdentity) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMembershipIdentity) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMembershipIdentity) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *RoleMembershipIdentity) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleMembershipIdentity) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleMembershipIdentity) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleMembershipIdentity) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleMembershipIdentity) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleMembershipIdentity) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleMembershipIdentity) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleMembershipIdentity) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *RoleMembershipIdentity) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *RoleMembershipIdentity) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetAliasName + +`func (o *RoleMembershipIdentity) GetAliasName() string` + +GetAliasName returns the AliasName field if non-nil, zero value otherwise. + +### GetAliasNameOk + +`func (o *RoleMembershipIdentity) GetAliasNameOk() (*string, bool)` + +GetAliasNameOk returns a tuple with the AliasName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAliasName + +`func (o *RoleMembershipIdentity) SetAliasName(v string)` + +SetAliasName sets AliasName field to given value. + +### HasAliasName + +`func (o *RoleMembershipIdentity) HasAliasName() bool` + +HasAliasName returns a boolean if a field has been set. + +### SetAliasNameNil + +`func (o *RoleMembershipIdentity) SetAliasNameNil(b bool)` + + SetAliasNameNil sets the value for AliasName to be an explicit nil + +### UnsetAliasName +`func (o *RoleMembershipIdentity) UnsetAliasName()` + +UnsetAliasName ensures that no value is present for AliasName, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleMembershipSelector.md b/docs/tools/sdk/go/Reference/V3/Models/RoleMembershipSelector.md new file mode 100644 index 000000000..b7a29efca --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleMembershipSelector.md @@ -0,0 +1,136 @@ +--- +id: role-membership-selector +title: RoleMembershipSelector +pagination_label: RoleMembershipSelector +sidebar_label: RoleMembershipSelector +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMembershipSelector', 'RoleMembershipSelector'] +slug: /tools/sdk/go/v3/models/role-membership-selector +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelector', 'RoleMembershipSelector'] +--- + +# RoleMembershipSelector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**RoleMembershipSelectorType**](role-membership-selector-type) | | [optional] +**Criteria** | Pointer to [**NullableRoleCriteriaLevel1**](role-criteria-level1) | | [optional] +**Identities** | Pointer to [**[]RoleMembershipIdentity**](role-membership-identity) | Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. | [optional] + +## Methods + +### NewRoleMembershipSelector + +`func NewRoleMembershipSelector() *RoleMembershipSelector` + +NewRoleMembershipSelector instantiates a new RoleMembershipSelector 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 + +### NewRoleMembershipSelectorWithDefaults + +`func NewRoleMembershipSelectorWithDefaults() *RoleMembershipSelector` + +NewRoleMembershipSelectorWithDefaults instantiates a new RoleMembershipSelector 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 + +### GetType + +`func (o *RoleMembershipSelector) GetType() RoleMembershipSelectorType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleMembershipSelector) GetTypeOk() (*RoleMembershipSelectorType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleMembershipSelector) SetType(v RoleMembershipSelectorType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleMembershipSelector) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetCriteria + +`func (o *RoleMembershipSelector) GetCriteria() RoleCriteriaLevel1` + +GetCriteria returns the Criteria field if non-nil, zero value otherwise. + +### GetCriteriaOk + +`func (o *RoleMembershipSelector) GetCriteriaOk() (*RoleCriteriaLevel1, bool)` + +GetCriteriaOk returns a tuple with the Criteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteria + +`func (o *RoleMembershipSelector) SetCriteria(v RoleCriteriaLevel1)` + +SetCriteria sets Criteria field to given value. + +### HasCriteria + +`func (o *RoleMembershipSelector) HasCriteria() bool` + +HasCriteria returns a boolean if a field has been set. + +### SetCriteriaNil + +`func (o *RoleMembershipSelector) SetCriteriaNil(b bool)` + + SetCriteriaNil sets the value for Criteria to be an explicit nil + +### UnsetCriteria +`func (o *RoleMembershipSelector) UnsetCriteria()` + +UnsetCriteria ensures that no value is present for Criteria, not even an explicit nil +### GetIdentities + +`func (o *RoleMembershipSelector) GetIdentities() []RoleMembershipIdentity` + +GetIdentities returns the Identities field if non-nil, zero value otherwise. + +### GetIdentitiesOk + +`func (o *RoleMembershipSelector) GetIdentitiesOk() (*[]RoleMembershipIdentity, bool)` + +GetIdentitiesOk returns a tuple with the Identities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentities + +`func (o *RoleMembershipSelector) SetIdentities(v []RoleMembershipIdentity)` + +SetIdentities sets Identities field to given value. + +### HasIdentities + +`func (o *RoleMembershipSelector) HasIdentities() bool` + +HasIdentities returns a boolean if a field has been set. + +### SetIdentitiesNil + +`func (o *RoleMembershipSelector) SetIdentitiesNil(b bool)` + + SetIdentitiesNil sets the value for Identities to be an explicit nil + +### UnsetIdentities +`func (o *RoleMembershipSelector) UnsetIdentities()` + +UnsetIdentities ensures that no value is present for Identities, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleMembershipSelectorType.md b/docs/tools/sdk/go/Reference/V3/Models/RoleMembershipSelectorType.md new file mode 100644 index 000000000..f846e3eae --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleMembershipSelectorType.md @@ -0,0 +1,21 @@ +--- +id: role-membership-selector-type +title: RoleMembershipSelectorType +pagination_label: RoleMembershipSelectorType +sidebar_label: RoleMembershipSelectorType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleMembershipSelectorType', 'RoleMembershipSelectorType'] +slug: /tools/sdk/go/v3/models/role-membership-selector-type +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelectorType', 'RoleMembershipSelectorType'] +--- + +# RoleMembershipSelectorType + +## Enum + + +* `STANDARD` (value: `"STANDARD"`) + +* `IDENTITY_LIST` (value: `"IDENTITY_LIST"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/RoleSummary.md b/docs/tools/sdk/go/Reference/V3/Models/RoleSummary.md new file mode 100644 index 000000000..b5923cf77 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/RoleSummary.md @@ -0,0 +1,256 @@ +--- +id: role-summary +title: RoleSummary +pagination_label: RoleSummary +sidebar_label: RoleSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'RoleSummary', 'RoleSummary'] +slug: /tools/sdk/go/v3/models/role-summary +tags: ['SDK', 'Software Development Kit', 'RoleSummary', 'RoleSummary'] +--- + +# RoleSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of the referenced object. | [optional] +**Name** | Pointer to **string** | The human readable name of the referenced object. | [optional] +**DisplayName** | Pointer to **string** | | [optional] +**Description** | Pointer to **NullableString** | Description of access item. | [optional] +**Type** | Pointer to **string** | Type of the access item. | [optional] +**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional] +**Disabled** | Pointer to **bool** | | [optional] +**Revocable** | Pointer to **bool** | | [optional] + +## Methods + +### NewRoleSummary + +`func NewRoleSummary() *RoleSummary` + +NewRoleSummary instantiates a new RoleSummary 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 + +### NewRoleSummaryWithDefaults + +`func NewRoleSummaryWithDefaults() *RoleSummary` + +NewRoleSummaryWithDefaults instantiates a new RoleSummary 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 + +### GetId + +`func (o *RoleSummary) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RoleSummary) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RoleSummary) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RoleSummary) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RoleSummary) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RoleSummary) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RoleSummary) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RoleSummary) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *RoleSummary) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *RoleSummary) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *RoleSummary) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *RoleSummary) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetDescription + +`func (o *RoleSummary) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RoleSummary) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *RoleSummary) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *RoleSummary) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *RoleSummary) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *RoleSummary) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetType + +`func (o *RoleSummary) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *RoleSummary) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *RoleSummary) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *RoleSummary) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetOwner + +`func (o *RoleSummary) GetOwner() DisplayReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *RoleSummary) GetOwnerOk() (*DisplayReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *RoleSummary) SetOwner(v DisplayReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *RoleSummary) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDisabled + +`func (o *RoleSummary) GetDisabled() bool` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *RoleSummary) GetDisabledOk() (*bool, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisabled + +`func (o *RoleSummary) SetDisabled(v bool)` + +SetDisabled sets Disabled field to given value. + +### HasDisabled + +`func (o *RoleSummary) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### GetRevocable + +`func (o *RoleSummary) GetRevocable() bool` + +GetRevocable returns the Revocable field if non-nil, zero value otherwise. + +### GetRevocableOk + +`func (o *RoleSummary) GetRevocableOk() (*bool, bool)` + +GetRevocableOk returns a tuple with the Revocable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRevocable + +`func (o *RoleSummary) SetRevocable(v bool)` + +SetRevocable sets Revocable field to given value. + +### HasRevocable + +`func (o *RoleSummary) HasRevocable() bool` + +HasRevocable returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SavedSearch.md b/docs/tools/sdk/go/Reference/V3/Models/SavedSearch.md new file mode 100644 index 000000000..c396bf8b0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SavedSearch.md @@ -0,0 +1,488 @@ +--- +id: saved-search +title: SavedSearch +pagination_label: SavedSearch +sidebar_label: SavedSearch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearch', 'SavedSearch'] +slug: /tools/sdk/go/v3/models/saved-search +tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'SavedSearch'] +--- + +# SavedSearch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the saved search. | [optional] +**Description** | Pointer to **NullableString** | The description of the saved search. | [optional] +**Created** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | +**Columns** | Pointer to [**map[string][]Column**](https://go.dev/tour/moretypes/6) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**Query** | **string** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | +**Fields** | Pointer to **[]string** | The fields to be searched against in a multi-field query. | [optional] +**OrderBy** | Pointer to **map[string][]string** | Sort by index. This takes precedence over the `sort` property. | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. | [optional] +**Filters** | Pointer to [**NullableSavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] +**Id** | Pointer to **string** | The saved search ID. | [optional] +**Owner** | Pointer to [**TypedReference**](typed-reference) | | [optional] +**OwnerId** | Pointer to **string** | The ID of the identity that owns this saved search. | [optional] +**Public** | Pointer to **bool** | Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. | [optional] [default to false] + +## Methods + +### NewSavedSearch + +`func NewSavedSearch(indices []Index, query string, ) *SavedSearch` + +NewSavedSearch instantiates a new SavedSearch 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 + +### NewSavedSearchWithDefaults + +`func NewSavedSearchWithDefaults() *SavedSearch` + +NewSavedSearchWithDefaults instantiates a new SavedSearch 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 + +### GetName + +`func (o *SavedSearch) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SavedSearch) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SavedSearch) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SavedSearch) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *SavedSearch) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SavedSearch) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SavedSearch) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SavedSearch) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *SavedSearch) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *SavedSearch) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetCreated + +`func (o *SavedSearch) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SavedSearch) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SavedSearch) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SavedSearch) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *SavedSearch) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *SavedSearch) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *SavedSearch) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SavedSearch) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SavedSearch) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SavedSearch) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *SavedSearch) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *SavedSearch) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetIndices + +`func (o *SavedSearch) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *SavedSearch) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *SavedSearch) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + + +### GetColumns + +`func (o *SavedSearch) GetColumns() map[string][]Column` + +GetColumns returns the Columns field if non-nil, zero value otherwise. + +### GetColumnsOk + +`func (o *SavedSearch) GetColumnsOk() (*map[string][]Column, bool)` + +GetColumnsOk returns a tuple with the Columns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumns + +`func (o *SavedSearch) SetColumns(v map[string][]Column)` + +SetColumns sets Columns field to given value. + +### HasColumns + +`func (o *SavedSearch) HasColumns() bool` + +HasColumns returns a boolean if a field has been set. + +### GetQuery + +`func (o *SavedSearch) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SavedSearch) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SavedSearch) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetFields + +`func (o *SavedSearch) GetFields() []string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *SavedSearch) GetFieldsOk() (*[]string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *SavedSearch) SetFields(v []string)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *SavedSearch) HasFields() bool` + +HasFields returns a boolean if a field has been set. + +### SetFieldsNil + +`func (o *SavedSearch) SetFieldsNil(b bool)` + + SetFieldsNil sets the value for Fields to be an explicit nil + +### UnsetFields +`func (o *SavedSearch) UnsetFields()` + +UnsetFields ensures that no value is present for Fields, not even an explicit nil +### GetOrderBy + +`func (o *SavedSearch) GetOrderBy() map[string][]string` + +GetOrderBy returns the OrderBy field if non-nil, zero value otherwise. + +### GetOrderByOk + +`func (o *SavedSearch) GetOrderByOk() (*map[string][]string, bool)` + +GetOrderByOk returns a tuple with the OrderBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderBy + +`func (o *SavedSearch) SetOrderBy(v map[string][]string)` + +SetOrderBy sets OrderBy field to given value. + +### HasOrderBy + +`func (o *SavedSearch) HasOrderBy() bool` + +HasOrderBy returns a boolean if a field has been set. + +### SetOrderByNil + +`func (o *SavedSearch) SetOrderByNil(b bool)` + + SetOrderByNil sets the value for OrderBy to be an explicit nil + +### UnsetOrderBy +`func (o *SavedSearch) UnsetOrderBy()` + +UnsetOrderBy ensures that no value is present for OrderBy, not even an explicit nil +### GetSort + +`func (o *SavedSearch) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *SavedSearch) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *SavedSearch) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *SavedSearch) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### SetSortNil + +`func (o *SavedSearch) SetSortNil(b bool)` + + SetSortNil sets the value for Sort to be an explicit nil + +### UnsetSort +`func (o *SavedSearch) UnsetSort()` + +UnsetSort ensures that no value is present for Sort, not even an explicit nil +### GetFilters + +`func (o *SavedSearch) GetFilters() SavedSearchDetailFilters` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *SavedSearch) GetFiltersOk() (*SavedSearchDetailFilters, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *SavedSearch) SetFilters(v SavedSearchDetailFilters)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *SavedSearch) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### SetFiltersNil + +`func (o *SavedSearch) SetFiltersNil(b bool)` + + SetFiltersNil sets the value for Filters to be an explicit nil + +### UnsetFilters +`func (o *SavedSearch) UnsetFilters()` + +UnsetFilters ensures that no value is present for Filters, not even an explicit nil +### GetId + +`func (o *SavedSearch) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SavedSearch) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SavedSearch) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SavedSearch) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetOwner + +`func (o *SavedSearch) GetOwner() TypedReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *SavedSearch) GetOwnerOk() (*TypedReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *SavedSearch) SetOwner(v TypedReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *SavedSearch) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetOwnerId + +`func (o *SavedSearch) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *SavedSearch) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *SavedSearch) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *SavedSearch) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + +### GetPublic + +`func (o *SavedSearch) GetPublic() bool` + +GetPublic returns the Public field if non-nil, zero value otherwise. + +### GetPublicOk + +`func (o *SavedSearch) GetPublicOk() (*bool, bool)` + +GetPublicOk returns a tuple with the Public field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublic + +`func (o *SavedSearch) SetPublic(v bool)` + +SetPublic sets Public field to given value. + +### HasPublic + +`func (o *SavedSearch) HasPublic() bool` + +HasPublic returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SavedSearchDetail.md b/docs/tools/sdk/go/Reference/V3/Models/SavedSearchDetail.md new file mode 100644 index 000000000..a305d2ed3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SavedSearchDetail.md @@ -0,0 +1,322 @@ +--- +id: saved-search-detail +title: SavedSearchDetail +pagination_label: SavedSearchDetail +sidebar_label: SavedSearchDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchDetail', 'SavedSearchDetail'] +slug: /tools/sdk/go/v3/models/saved-search-detail +tags: ['SDK', 'Software Development Kit', 'SavedSearchDetail', 'SavedSearchDetail'] +--- + +# SavedSearchDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | +**Columns** | Pointer to [**map[string][]Column**](https://go.dev/tour/moretypes/6) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**Query** | **string** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | +**Fields** | Pointer to **[]string** | The fields to be searched against in a multi-field query. | [optional] +**OrderBy** | Pointer to **map[string][]string** | Sort by index. This takes precedence over the `sort` property. | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. | [optional] +**Filters** | Pointer to [**NullableSavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] + +## Methods + +### NewSavedSearchDetail + +`func NewSavedSearchDetail(indices []Index, query string, ) *SavedSearchDetail` + +NewSavedSearchDetail instantiates a new SavedSearchDetail 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 + +### NewSavedSearchDetailWithDefaults + +`func NewSavedSearchDetailWithDefaults() *SavedSearchDetail` + +NewSavedSearchDetailWithDefaults instantiates a new SavedSearchDetail 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 + +### GetCreated + +`func (o *SavedSearchDetail) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SavedSearchDetail) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SavedSearchDetail) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SavedSearchDetail) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *SavedSearchDetail) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *SavedSearchDetail) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *SavedSearchDetail) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SavedSearchDetail) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SavedSearchDetail) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SavedSearchDetail) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *SavedSearchDetail) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *SavedSearchDetail) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetIndices + +`func (o *SavedSearchDetail) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *SavedSearchDetail) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *SavedSearchDetail) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + + +### GetColumns + +`func (o *SavedSearchDetail) GetColumns() map[string][]Column` + +GetColumns returns the Columns field if non-nil, zero value otherwise. + +### GetColumnsOk + +`func (o *SavedSearchDetail) GetColumnsOk() (*map[string][]Column, bool)` + +GetColumnsOk returns a tuple with the Columns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumns + +`func (o *SavedSearchDetail) SetColumns(v map[string][]Column)` + +SetColumns sets Columns field to given value. + +### HasColumns + +`func (o *SavedSearchDetail) HasColumns() bool` + +HasColumns returns a boolean if a field has been set. + +### GetQuery + +`func (o *SavedSearchDetail) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SavedSearchDetail) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SavedSearchDetail) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetFields + +`func (o *SavedSearchDetail) GetFields() []string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *SavedSearchDetail) GetFieldsOk() (*[]string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *SavedSearchDetail) SetFields(v []string)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *SavedSearchDetail) HasFields() bool` + +HasFields returns a boolean if a field has been set. + +### SetFieldsNil + +`func (o *SavedSearchDetail) SetFieldsNil(b bool)` + + SetFieldsNil sets the value for Fields to be an explicit nil + +### UnsetFields +`func (o *SavedSearchDetail) UnsetFields()` + +UnsetFields ensures that no value is present for Fields, not even an explicit nil +### GetOrderBy + +`func (o *SavedSearchDetail) GetOrderBy() map[string][]string` + +GetOrderBy returns the OrderBy field if non-nil, zero value otherwise. + +### GetOrderByOk + +`func (o *SavedSearchDetail) GetOrderByOk() (*map[string][]string, bool)` + +GetOrderByOk returns a tuple with the OrderBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrderBy + +`func (o *SavedSearchDetail) SetOrderBy(v map[string][]string)` + +SetOrderBy sets OrderBy field to given value. + +### HasOrderBy + +`func (o *SavedSearchDetail) HasOrderBy() bool` + +HasOrderBy returns a boolean if a field has been set. + +### SetOrderByNil + +`func (o *SavedSearchDetail) SetOrderByNil(b bool)` + + SetOrderByNil sets the value for OrderBy to be an explicit nil + +### UnsetOrderBy +`func (o *SavedSearchDetail) UnsetOrderBy()` + +UnsetOrderBy ensures that no value is present for OrderBy, not even an explicit nil +### GetSort + +`func (o *SavedSearchDetail) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *SavedSearchDetail) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *SavedSearchDetail) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *SavedSearchDetail) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### SetSortNil + +`func (o *SavedSearchDetail) SetSortNil(b bool)` + + SetSortNil sets the value for Sort to be an explicit nil + +### UnsetSort +`func (o *SavedSearchDetail) UnsetSort()` + +UnsetSort ensures that no value is present for Sort, not even an explicit nil +### GetFilters + +`func (o *SavedSearchDetail) GetFilters() SavedSearchDetailFilters` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *SavedSearchDetail) GetFiltersOk() (*SavedSearchDetailFilters, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *SavedSearchDetail) SetFilters(v SavedSearchDetailFilters)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *SavedSearchDetail) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### SetFiltersNil + +`func (o *SavedSearchDetail) SetFiltersNil(b bool)` + + SetFiltersNil sets the value for Filters to be an explicit nil + +### UnsetFilters +`func (o *SavedSearchDetail) UnsetFilters()` + +UnsetFilters ensures that no value is present for Filters, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SavedSearchDetailFilters.md b/docs/tools/sdk/go/Reference/V3/Models/SavedSearchDetailFilters.md new file mode 100644 index 000000000..aecee29ab --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SavedSearchDetailFilters.md @@ -0,0 +1,142 @@ +--- +id: saved-search-detail-filters +title: SavedSearchDetailFilters +pagination_label: SavedSearchDetailFilters +sidebar_label: SavedSearchDetailFilters +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchDetailFilters', 'SavedSearchDetailFilters'] +slug: /tools/sdk/go/v3/models/saved-search-detail-filters +tags: ['SDK', 'Software Development Kit', 'SavedSearchDetailFilters', 'SavedSearchDetailFilters'] +--- + +# SavedSearchDetailFilters + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**FilterType**](filter-type) | | [optional] +**Range** | Pointer to [**Range**](range) | | [optional] +**Terms** | Pointer to **[]string** | The terms to be filtered. | [optional] +**Exclude** | Pointer to **bool** | Indicates if the filter excludes results. | [optional] [default to false] + +## Methods + +### NewSavedSearchDetailFilters + +`func NewSavedSearchDetailFilters() *SavedSearchDetailFilters` + +NewSavedSearchDetailFilters instantiates a new SavedSearchDetailFilters 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 + +### NewSavedSearchDetailFiltersWithDefaults + +`func NewSavedSearchDetailFiltersWithDefaults() *SavedSearchDetailFilters` + +NewSavedSearchDetailFiltersWithDefaults instantiates a new SavedSearchDetailFilters 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 + +### GetType + +`func (o *SavedSearchDetailFilters) GetType() FilterType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SavedSearchDetailFilters) GetTypeOk() (*FilterType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SavedSearchDetailFilters) SetType(v FilterType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SavedSearchDetailFilters) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRange + +`func (o *SavedSearchDetailFilters) GetRange() Range` + +GetRange returns the Range field if non-nil, zero value otherwise. + +### GetRangeOk + +`func (o *SavedSearchDetailFilters) GetRangeOk() (*Range, bool)` + +GetRangeOk returns a tuple with the Range field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRange + +`func (o *SavedSearchDetailFilters) SetRange(v Range)` + +SetRange sets Range field to given value. + +### HasRange + +`func (o *SavedSearchDetailFilters) HasRange() bool` + +HasRange returns a boolean if a field has been set. + +### GetTerms + +`func (o *SavedSearchDetailFilters) GetTerms() []string` + +GetTerms returns the Terms field if non-nil, zero value otherwise. + +### GetTermsOk + +`func (o *SavedSearchDetailFilters) GetTermsOk() (*[]string, bool)` + +GetTermsOk returns a tuple with the Terms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerms + +`func (o *SavedSearchDetailFilters) SetTerms(v []string)` + +SetTerms sets Terms field to given value. + +### HasTerms + +`func (o *SavedSearchDetailFilters) HasTerms() bool` + +HasTerms returns a boolean if a field has been set. + +### GetExclude + +`func (o *SavedSearchDetailFilters) GetExclude() bool` + +GetExclude returns the Exclude field if non-nil, zero value otherwise. + +### GetExcludeOk + +`func (o *SavedSearchDetailFilters) GetExcludeOk() (*bool, bool)` + +GetExcludeOk returns a tuple with the Exclude field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExclude + +`func (o *SavedSearchDetailFilters) SetExclude(v bool)` + +SetExclude sets Exclude field to given value. + +### HasExclude + +`func (o *SavedSearchDetailFilters) HasExclude() bool` + +HasExclude returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SavedSearchName.md b/docs/tools/sdk/go/Reference/V3/Models/SavedSearchName.md new file mode 100644 index 000000000..965354d01 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SavedSearchName.md @@ -0,0 +1,100 @@ +--- +id: saved-search-name +title: SavedSearchName +pagination_label: SavedSearchName +sidebar_label: SavedSearchName +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SavedSearchName', 'SavedSearchName'] +slug: /tools/sdk/go/v3/models/saved-search-name +tags: ['SDK', 'Software Development Kit', 'SavedSearchName', 'SavedSearchName'] +--- + +# SavedSearchName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the saved search. | [optional] +**Description** | Pointer to **NullableString** | The description of the saved search. | [optional] + +## Methods + +### NewSavedSearchName + +`func NewSavedSearchName() *SavedSearchName` + +NewSavedSearchName instantiates a new SavedSearchName 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 + +### NewSavedSearchNameWithDefaults + +`func NewSavedSearchNameWithDefaults() *SavedSearchName` + +NewSavedSearchNameWithDefaults instantiates a new SavedSearchName 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 + +### GetName + +`func (o *SavedSearchName) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SavedSearchName) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SavedSearchName) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SavedSearchName) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *SavedSearchName) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SavedSearchName) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SavedSearchName) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SavedSearchName) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *SavedSearchName) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *SavedSearchName) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Schedule.md b/docs/tools/sdk/go/Reference/V3/Models/Schedule.md new file mode 100644 index 000000000..46e2a0aa7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Schedule.md @@ -0,0 +1,204 @@ +--- +id: schedule +title: Schedule +pagination_label: Schedule +sidebar_label: Schedule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule', 'Schedule'] +slug: /tools/sdk/go/v3/models/schedule +tags: ['SDK', 'Software Development Kit', 'Schedule', 'Schedule'] +--- + +# Schedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set. | +**Months** | Pointer to [**NullableScheduleMonths**](schedule-months) | | [optional] +**Days** | Pointer to [**ScheduleDays**](schedule-days) | | [optional] +**Hours** | [**ScheduleHours**](schedule-hours) | | +**Expiration** | Pointer to **NullableTime** | Specifies the time after which this schedule will no longer occur. | [optional] +**TimeZoneId** | Pointer to **string** | The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST. | [optional] + +## Methods + +### NewSchedule + +`func NewSchedule(type_ string, hours ScheduleHours, ) *Schedule` + +NewSchedule instantiates a new Schedule 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 + +### NewScheduleWithDefaults + +`func NewScheduleWithDefaults() *Schedule` + +NewScheduleWithDefaults instantiates a new Schedule 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 + +### GetType + +`func (o *Schedule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Schedule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Schedule) SetType(v string)` + +SetType sets Type field to given value. + + +### GetMonths + +`func (o *Schedule) GetMonths() ScheduleMonths` + +GetMonths returns the Months field if non-nil, zero value otherwise. + +### GetMonthsOk + +`func (o *Schedule) GetMonthsOk() (*ScheduleMonths, bool)` + +GetMonthsOk returns a tuple with the Months field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMonths + +`func (o *Schedule) SetMonths(v ScheduleMonths)` + +SetMonths sets Months field to given value. + +### HasMonths + +`func (o *Schedule) HasMonths() bool` + +HasMonths returns a boolean if a field has been set. + +### SetMonthsNil + +`func (o *Schedule) SetMonthsNil(b bool)` + + SetMonthsNil sets the value for Months to be an explicit nil + +### UnsetMonths +`func (o *Schedule) UnsetMonths()` + +UnsetMonths ensures that no value is present for Months, not even an explicit nil +### GetDays + +`func (o *Schedule) GetDays() ScheduleDays` + +GetDays returns the Days field if non-nil, zero value otherwise. + +### GetDaysOk + +`func (o *Schedule) GetDaysOk() (*ScheduleDays, bool)` + +GetDaysOk returns a tuple with the Days field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDays + +`func (o *Schedule) SetDays(v ScheduleDays)` + +SetDays sets Days field to given value. + +### HasDays + +`func (o *Schedule) HasDays() bool` + +HasDays returns a boolean if a field has been set. + +### GetHours + +`func (o *Schedule) GetHours() ScheduleHours` + +GetHours returns the Hours field if non-nil, zero value otherwise. + +### GetHoursOk + +`func (o *Schedule) GetHoursOk() (*ScheduleHours, bool)` + +GetHoursOk returns a tuple with the Hours field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHours + +`func (o *Schedule) SetHours(v ScheduleHours)` + +SetHours sets Hours field to given value. + + +### GetExpiration + +`func (o *Schedule) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *Schedule) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *Schedule) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *Schedule) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + +### SetExpirationNil + +`func (o *Schedule) SetExpirationNil(b bool)` + + SetExpirationNil sets the value for Expiration to be an explicit nil + +### UnsetExpiration +`func (o *Schedule) UnsetExpiration()` + +UnsetExpiration ensures that no value is present for Expiration, not even an explicit nil +### GetTimeZoneId + +`func (o *Schedule) GetTimeZoneId() string` + +GetTimeZoneId returns the TimeZoneId field if non-nil, zero value otherwise. + +### GetTimeZoneIdOk + +`func (o *Schedule) GetTimeZoneIdOk() (*string, bool)` + +GetTimeZoneIdOk returns a tuple with the TimeZoneId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZoneId + +`func (o *Schedule) SetTimeZoneId(v string)` + +SetTimeZoneId sets TimeZoneId field to given value. + +### HasTimeZoneId + +`func (o *Schedule) HasTimeZoneId() bool` + +HasTimeZoneId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Schedule1.md b/docs/tools/sdk/go/Reference/V3/Models/Schedule1.md new file mode 100644 index 000000000..1147cb909 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Schedule1.md @@ -0,0 +1,204 @@ +--- +id: schedule1 +title: Schedule1 +pagination_label: Schedule1 +sidebar_label: Schedule1 +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule1', 'Schedule1'] +slug: /tools/sdk/go/v3/models/schedule1 +tags: ['SDK', 'Software Development Kit', 'Schedule1', 'Schedule1'] +--- + +# Schedule1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**ScheduleType**](schedule-type) | | +**Months** | Pointer to [**Schedule1Months**](schedule1-months) | | [optional] +**Days** | Pointer to [**Schedule1Days**](schedule1-days) | | [optional] +**Hours** | [**Schedule1Hours**](schedule1-hours) | | +**Expiration** | Pointer to **NullableTime** | A date-time in ISO-8601 format | [optional] +**TimeZoneId** | Pointer to **NullableString** | The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used. | [optional] + +## Methods + +### NewSchedule1 + +`func NewSchedule1(type_ ScheduleType, hours Schedule1Hours, ) *Schedule1` + +NewSchedule1 instantiates a new Schedule1 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 + +### NewSchedule1WithDefaults + +`func NewSchedule1WithDefaults() *Schedule1` + +NewSchedule1WithDefaults instantiates a new Schedule1 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 + +### GetType + +`func (o *Schedule1) GetType() ScheduleType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Schedule1) GetTypeOk() (*ScheduleType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Schedule1) SetType(v ScheduleType)` + +SetType sets Type field to given value. + + +### GetMonths + +`func (o *Schedule1) GetMonths() Schedule1Months` + +GetMonths returns the Months field if non-nil, zero value otherwise. + +### GetMonthsOk + +`func (o *Schedule1) GetMonthsOk() (*Schedule1Months, bool)` + +GetMonthsOk returns a tuple with the Months field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMonths + +`func (o *Schedule1) SetMonths(v Schedule1Months)` + +SetMonths sets Months field to given value. + +### HasMonths + +`func (o *Schedule1) HasMonths() bool` + +HasMonths returns a boolean if a field has been set. + +### GetDays + +`func (o *Schedule1) GetDays() Schedule1Days` + +GetDays returns the Days field if non-nil, zero value otherwise. + +### GetDaysOk + +`func (o *Schedule1) GetDaysOk() (*Schedule1Days, bool)` + +GetDaysOk returns a tuple with the Days field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDays + +`func (o *Schedule1) SetDays(v Schedule1Days)` + +SetDays sets Days field to given value. + +### HasDays + +`func (o *Schedule1) HasDays() bool` + +HasDays returns a boolean if a field has been set. + +### GetHours + +`func (o *Schedule1) GetHours() Schedule1Hours` + +GetHours returns the Hours field if non-nil, zero value otherwise. + +### GetHoursOk + +`func (o *Schedule1) GetHoursOk() (*Schedule1Hours, bool)` + +GetHoursOk returns a tuple with the Hours field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHours + +`func (o *Schedule1) SetHours(v Schedule1Hours)` + +SetHours sets Hours field to given value. + + +### GetExpiration + +`func (o *Schedule1) GetExpiration() SailPointTime` + +GetExpiration returns the Expiration field if non-nil, zero value otherwise. + +### GetExpirationOk + +`func (o *Schedule1) GetExpirationOk() (*SailPointTime, bool)` + +GetExpirationOk returns a tuple with the Expiration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpiration + +`func (o *Schedule1) SetExpiration(v SailPointTime)` + +SetExpiration sets Expiration field to given value. + +### HasExpiration + +`func (o *Schedule1) HasExpiration() bool` + +HasExpiration returns a boolean if a field has been set. + +### SetExpirationNil + +`func (o *Schedule1) SetExpirationNil(b bool)` + + SetExpirationNil sets the value for Expiration to be an explicit nil + +### UnsetExpiration +`func (o *Schedule1) UnsetExpiration()` + +UnsetExpiration ensures that no value is present for Expiration, not even an explicit nil +### GetTimeZoneId + +`func (o *Schedule1) GetTimeZoneId() string` + +GetTimeZoneId returns the TimeZoneId field if non-nil, zero value otherwise. + +### GetTimeZoneIdOk + +`func (o *Schedule1) GetTimeZoneIdOk() (*string, bool)` + +GetTimeZoneIdOk returns a tuple with the TimeZoneId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimeZoneId + +`func (o *Schedule1) SetTimeZoneId(v string)` + +SetTimeZoneId sets TimeZoneId field to given value. + +### HasTimeZoneId + +`func (o *Schedule1) HasTimeZoneId() bool` + +HasTimeZoneId returns a boolean if a field has been set. + +### SetTimeZoneIdNil + +`func (o *Schedule1) SetTimeZoneIdNil(b bool)` + + SetTimeZoneIdNil sets the value for TimeZoneId to be an explicit nil + +### UnsetTimeZoneId +`func (o *Schedule1) UnsetTimeZoneId()` + +UnsetTimeZoneId ensures that no value is present for TimeZoneId, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Schedule1Days.md b/docs/tools/sdk/go/Reference/V3/Models/Schedule1Days.md new file mode 100644 index 000000000..59b830352 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Schedule1Days.md @@ -0,0 +1,116 @@ +--- +id: schedule1-days +title: Schedule1Days +pagination_label: Schedule1Days +sidebar_label: Schedule1Days +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule1Days', 'Schedule1Days'] +slug: /tools/sdk/go/v3/models/schedule1-days +tags: ['SDK', 'Software Development Kit', 'Schedule1Days', 'Schedule1Days'] +--- + +# Schedule1Days + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**SelectorType**](selector-type) | | +**Values** | **[]string** | The selected values. | +**Interval** | Pointer to **NullableInt32** | The selected interval for RANGE selectors. | [optional] + +## Methods + +### NewSchedule1Days + +`func NewSchedule1Days(type_ SelectorType, values []string, ) *Schedule1Days` + +NewSchedule1Days instantiates a new Schedule1Days 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 + +### NewSchedule1DaysWithDefaults + +`func NewSchedule1DaysWithDefaults() *Schedule1Days` + +NewSchedule1DaysWithDefaults instantiates a new Schedule1Days 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 + +### GetType + +`func (o *Schedule1Days) GetType() SelectorType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Schedule1Days) GetTypeOk() (*SelectorType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Schedule1Days) SetType(v SelectorType)` + +SetType sets Type field to given value. + + +### GetValues + +`func (o *Schedule1Days) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *Schedule1Days) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *Schedule1Days) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### GetInterval + +`func (o *Schedule1Days) GetInterval() int32` + +GetInterval returns the Interval field if non-nil, zero value otherwise. + +### GetIntervalOk + +`func (o *Schedule1Days) GetIntervalOk() (*int32, bool)` + +GetIntervalOk returns a tuple with the Interval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterval + +`func (o *Schedule1Days) SetInterval(v int32)` + +SetInterval sets Interval field to given value. + +### HasInterval + +`func (o *Schedule1Days) HasInterval() bool` + +HasInterval returns a boolean if a field has been set. + +### SetIntervalNil + +`func (o *Schedule1Days) SetIntervalNil(b bool)` + + SetIntervalNil sets the value for Interval to be an explicit nil + +### UnsetInterval +`func (o *Schedule1Days) UnsetInterval()` + +UnsetInterval ensures that no value is present for Interval, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Schedule1Hours.md b/docs/tools/sdk/go/Reference/V3/Models/Schedule1Hours.md new file mode 100644 index 000000000..ee58c1377 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Schedule1Hours.md @@ -0,0 +1,116 @@ +--- +id: schedule1-hours +title: Schedule1Hours +pagination_label: Schedule1Hours +sidebar_label: Schedule1Hours +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule1Hours', 'Schedule1Hours'] +slug: /tools/sdk/go/v3/models/schedule1-hours +tags: ['SDK', 'Software Development Kit', 'Schedule1Hours', 'Schedule1Hours'] +--- + +# Schedule1Hours + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**SelectorType**](selector-type) | | +**Values** | **[]string** | The selected values. | +**Interval** | Pointer to **NullableInt32** | The selected interval for RANGE selectors. | [optional] + +## Methods + +### NewSchedule1Hours + +`func NewSchedule1Hours(type_ SelectorType, values []string, ) *Schedule1Hours` + +NewSchedule1Hours instantiates a new Schedule1Hours 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 + +### NewSchedule1HoursWithDefaults + +`func NewSchedule1HoursWithDefaults() *Schedule1Hours` + +NewSchedule1HoursWithDefaults instantiates a new Schedule1Hours 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 + +### GetType + +`func (o *Schedule1Hours) GetType() SelectorType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Schedule1Hours) GetTypeOk() (*SelectorType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Schedule1Hours) SetType(v SelectorType)` + +SetType sets Type field to given value. + + +### GetValues + +`func (o *Schedule1Hours) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *Schedule1Hours) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *Schedule1Hours) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### GetInterval + +`func (o *Schedule1Hours) GetInterval() int32` + +GetInterval returns the Interval field if non-nil, zero value otherwise. + +### GetIntervalOk + +`func (o *Schedule1Hours) GetIntervalOk() (*int32, bool)` + +GetIntervalOk returns a tuple with the Interval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterval + +`func (o *Schedule1Hours) SetInterval(v int32)` + +SetInterval sets Interval field to given value. + +### HasInterval + +`func (o *Schedule1Hours) HasInterval() bool` + +HasInterval returns a boolean if a field has been set. + +### SetIntervalNil + +`func (o *Schedule1Hours) SetIntervalNil(b bool)` + + SetIntervalNil sets the value for Interval to be an explicit nil + +### UnsetInterval +`func (o *Schedule1Hours) UnsetInterval()` + +UnsetInterval ensures that no value is present for Interval, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Schedule1Months.md b/docs/tools/sdk/go/Reference/V3/Models/Schedule1Months.md new file mode 100644 index 000000000..3042d597b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Schedule1Months.md @@ -0,0 +1,116 @@ +--- +id: schedule1-months +title: Schedule1Months +pagination_label: Schedule1Months +sidebar_label: Schedule1Months +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schedule1Months', 'Schedule1Months'] +slug: /tools/sdk/go/v3/models/schedule1-months +tags: ['SDK', 'Software Development Kit', 'Schedule1Months', 'Schedule1Months'] +--- + +# Schedule1Months + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**SelectorType**](selector-type) | | +**Values** | **[]string** | The selected values. | +**Interval** | Pointer to **NullableInt32** | The selected interval for RANGE selectors. | [optional] + +## Methods + +### NewSchedule1Months + +`func NewSchedule1Months(type_ SelectorType, values []string, ) *Schedule1Months` + +NewSchedule1Months instantiates a new Schedule1Months 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 + +### NewSchedule1MonthsWithDefaults + +`func NewSchedule1MonthsWithDefaults() *Schedule1Months` + +NewSchedule1MonthsWithDefaults instantiates a new Schedule1Months 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 + +### GetType + +`func (o *Schedule1Months) GetType() SelectorType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Schedule1Months) GetTypeOk() (*SelectorType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Schedule1Months) SetType(v SelectorType)` + +SetType sets Type field to given value. + + +### GetValues + +`func (o *Schedule1Months) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *Schedule1Months) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *Schedule1Months) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### GetInterval + +`func (o *Schedule1Months) GetInterval() int32` + +GetInterval returns the Interval field if non-nil, zero value otherwise. + +### GetIntervalOk + +`func (o *Schedule1Months) GetIntervalOk() (*int32, bool)` + +GetIntervalOk returns a tuple with the Interval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterval + +`func (o *Schedule1Months) SetInterval(v int32)` + +SetInterval sets Interval field to given value. + +### HasInterval + +`func (o *Schedule1Months) HasInterval() bool` + +HasInterval returns a boolean if a field has been set. + +### SetIntervalNil + +`func (o *Schedule1Months) SetIntervalNil(b bool)` + + SetIntervalNil sets the value for Interval to be an explicit nil + +### UnsetInterval +`func (o *Schedule1Months) UnsetInterval()` + +UnsetInterval ensures that no value is present for Interval, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ScheduleDays.md b/docs/tools/sdk/go/Reference/V3/Models/ScheduleDays.md new file mode 100644 index 000000000..a1e960af5 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ScheduleDays.md @@ -0,0 +1,116 @@ +--- +id: schedule-days +title: ScheduleDays +pagination_label: ScheduleDays +sidebar_label: ScheduleDays +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduleDays', 'ScheduleDays'] +slug: /tools/sdk/go/v3/models/schedule-days +tags: ['SDK', 'Software Development Kit', 'ScheduleDays', 'ScheduleDays'] +--- + +# ScheduleDays + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Enum type to specify days value | +**Values** | **[]string** | Values of the days based on the enum type mentioned above | +**Interval** | Pointer to **NullableInt64** | Interval between the cert generations | [optional] + +## Methods + +### NewScheduleDays + +`func NewScheduleDays(type_ string, values []string, ) *ScheduleDays` + +NewScheduleDays instantiates a new ScheduleDays 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 + +### NewScheduleDaysWithDefaults + +`func NewScheduleDaysWithDefaults() *ScheduleDays` + +NewScheduleDaysWithDefaults instantiates a new ScheduleDays 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 + +### GetType + +`func (o *ScheduleDays) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ScheduleDays) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ScheduleDays) SetType(v string)` + +SetType sets Type field to given value. + + +### GetValues + +`func (o *ScheduleDays) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *ScheduleDays) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *ScheduleDays) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### GetInterval + +`func (o *ScheduleDays) GetInterval() int64` + +GetInterval returns the Interval field if non-nil, zero value otherwise. + +### GetIntervalOk + +`func (o *ScheduleDays) GetIntervalOk() (*int64, bool)` + +GetIntervalOk returns a tuple with the Interval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterval + +`func (o *ScheduleDays) SetInterval(v int64)` + +SetInterval sets Interval field to given value. + +### HasInterval + +`func (o *ScheduleDays) HasInterval() bool` + +HasInterval returns a boolean if a field has been set. + +### SetIntervalNil + +`func (o *ScheduleDays) SetIntervalNil(b bool)` + + SetIntervalNil sets the value for Interval to be an explicit nil + +### UnsetInterval +`func (o *ScheduleDays) UnsetInterval()` + +UnsetInterval ensures that no value is present for Interval, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ScheduleHours.md b/docs/tools/sdk/go/Reference/V3/Models/ScheduleHours.md new file mode 100644 index 000000000..db09fe2a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ScheduleHours.md @@ -0,0 +1,116 @@ +--- +id: schedule-hours +title: ScheduleHours +pagination_label: ScheduleHours +sidebar_label: ScheduleHours +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduleHours', 'ScheduleHours'] +slug: /tools/sdk/go/v3/models/schedule-hours +tags: ['SDK', 'Software Development Kit', 'ScheduleHours', 'ScheduleHours'] +--- + +# ScheduleHours + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Enum type to specify hours value | +**Values** | **[]string** | Values of the days based on the enum type mentioned above | +**Interval** | Pointer to **NullableInt64** | Interval between the cert generations | [optional] + +## Methods + +### NewScheduleHours + +`func NewScheduleHours(type_ string, values []string, ) *ScheduleHours` + +NewScheduleHours instantiates a new ScheduleHours 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 + +### NewScheduleHoursWithDefaults + +`func NewScheduleHoursWithDefaults() *ScheduleHours` + +NewScheduleHoursWithDefaults instantiates a new ScheduleHours 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 + +### GetType + +`func (o *ScheduleHours) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ScheduleHours) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ScheduleHours) SetType(v string)` + +SetType sets Type field to given value. + + +### GetValues + +`func (o *ScheduleHours) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *ScheduleHours) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *ScheduleHours) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### GetInterval + +`func (o *ScheduleHours) GetInterval() int64` + +GetInterval returns the Interval field if non-nil, zero value otherwise. + +### GetIntervalOk + +`func (o *ScheduleHours) GetIntervalOk() (*int64, bool)` + +GetIntervalOk returns a tuple with the Interval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterval + +`func (o *ScheduleHours) SetInterval(v int64)` + +SetInterval sets Interval field to given value. + +### HasInterval + +`func (o *ScheduleHours) HasInterval() bool` + +HasInterval returns a boolean if a field has been set. + +### SetIntervalNil + +`func (o *ScheduleHours) SetIntervalNil(b bool)` + + SetIntervalNil sets the value for Interval to be an explicit nil + +### UnsetInterval +`func (o *ScheduleHours) UnsetInterval()` + +UnsetInterval ensures that no value is present for Interval, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ScheduleMonths.md b/docs/tools/sdk/go/Reference/V3/Models/ScheduleMonths.md new file mode 100644 index 000000000..b2006f7f2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ScheduleMonths.md @@ -0,0 +1,106 @@ +--- +id: schedule-months +title: ScheduleMonths +pagination_label: ScheduleMonths +sidebar_label: ScheduleMonths +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduleMonths', 'ScheduleMonths'] +slug: /tools/sdk/go/v3/models/schedule-months +tags: ['SDK', 'Software Development Kit', 'ScheduleMonths', 'ScheduleMonths'] +--- + +# ScheduleMonths + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Enum type to specify months value | +**Values** | **[]string** | Values of the months based on the enum type mentioned above | +**Interval** | Pointer to **int64** | Interval between the cert generations | [optional] + +## Methods + +### NewScheduleMonths + +`func NewScheduleMonths(type_ string, values []string, ) *ScheduleMonths` + +NewScheduleMonths instantiates a new ScheduleMonths 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 + +### NewScheduleMonthsWithDefaults + +`func NewScheduleMonthsWithDefaults() *ScheduleMonths` + +NewScheduleMonthsWithDefaults instantiates a new ScheduleMonths 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 + +### GetType + +`func (o *ScheduleMonths) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ScheduleMonths) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ScheduleMonths) SetType(v string)` + +SetType sets Type field to given value. + + +### GetValues + +`func (o *ScheduleMonths) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *ScheduleMonths) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *ScheduleMonths) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### GetInterval + +`func (o *ScheduleMonths) GetInterval() int64` + +GetInterval returns the Interval field if non-nil, zero value otherwise. + +### GetIntervalOk + +`func (o *ScheduleMonths) GetIntervalOk() (*int64, bool)` + +GetIntervalOk returns a tuple with the Interval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterval + +`func (o *ScheduleMonths) SetInterval(v int64)` + +SetInterval sets Interval field to given value. + +### HasInterval + +`func (o *ScheduleMonths) HasInterval() bool` + +HasInterval returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ScheduleType.md b/docs/tools/sdk/go/Reference/V3/Models/ScheduleType.md new file mode 100644 index 000000000..72964abe4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ScheduleType.md @@ -0,0 +1,27 @@ +--- +id: schedule-type +title: ScheduleType +pagination_label: ScheduleType +sidebar_label: ScheduleType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduleType', 'ScheduleType'] +slug: /tools/sdk/go/v3/models/schedule-type +tags: ['SDK', 'Software Development Kit', 'ScheduleType', 'ScheduleType'] +--- + +# ScheduleType + +## Enum + + +* `DAILY` (value: `"DAILY"`) + +* `WEEKLY` (value: `"WEEKLY"`) + +* `MONTHLY` (value: `"MONTHLY"`) + +* `CALENDAR` (value: `"CALENDAR"`) + +* `ANNUALLY` (value: `"ANNUALLY"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ScheduledSearch.md b/docs/tools/sdk/go/Reference/V3/Models/ScheduledSearch.md new file mode 100644 index 000000000..e7ac18993 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ScheduledSearch.md @@ -0,0 +1,386 @@ +--- +id: scheduled-search +title: ScheduledSearch +pagination_label: ScheduledSearch +sidebar_label: ScheduledSearch +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledSearch', 'ScheduledSearch'] +slug: /tools/sdk/go/v3/models/scheduled-search +tags: ['SDK', 'Software Development Kit', 'ScheduledSearch', 'ScheduledSearch'] +--- + +# ScheduledSearch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **NullableString** | The name of the scheduled search. | [optional] +**Description** | Pointer to **NullableString** | The description of the scheduled search. | [optional] +**SavedSearchId** | **string** | The ID of the saved search that will be executed. | +**Created** | Pointer to **NullableTime** | The date the scheduled search was initially created. | [optional] [readonly] +**Modified** | Pointer to **NullableTime** | The last date the scheduled search was modified. | [optional] [readonly] +**Schedule** | [**Schedule1**](schedule1) | | +**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | +**Enabled** | Pointer to **bool** | Indicates if the scheduled search is enabled. | [optional] [default to false] +**EmailEmptyResults** | Pointer to **bool** | Indicates if email generation should occur when search returns no results. | [optional] [default to false] +**DisplayQueryDetails** | Pointer to **bool** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to false] +**Id** | **string** | The scheduled search ID. | [readonly] +**Owner** | [**ScheduledSearchAllOfOwner**](scheduled-search-all-of-owner) | | +**OwnerId** | **string** | The ID of the scheduled search owner. Please use the `id` in the `owner` object instead. | [readonly] + +## Methods + +### NewScheduledSearch + +`func NewScheduledSearch(savedSearchId string, schedule Schedule1, recipients []SearchScheduleRecipientsInner, id string, owner ScheduledSearchAllOfOwner, ownerId string, ) *ScheduledSearch` + +NewScheduledSearch instantiates a new ScheduledSearch 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 + +### NewScheduledSearchWithDefaults + +`func NewScheduledSearchWithDefaults() *ScheduledSearch` + +NewScheduledSearchWithDefaults instantiates a new ScheduledSearch 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 + +### GetName + +`func (o *ScheduledSearch) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ScheduledSearch) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ScheduledSearch) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ScheduledSearch) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ScheduledSearch) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ScheduledSearch) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *ScheduledSearch) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ScheduledSearch) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ScheduledSearch) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ScheduledSearch) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ScheduledSearch) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ScheduledSearch) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetSavedSearchId + +`func (o *ScheduledSearch) GetSavedSearchId() string` + +GetSavedSearchId returns the SavedSearchId field if non-nil, zero value otherwise. + +### GetSavedSearchIdOk + +`func (o *ScheduledSearch) GetSavedSearchIdOk() (*string, bool)` + +GetSavedSearchIdOk returns a tuple with the SavedSearchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSavedSearchId + +`func (o *ScheduledSearch) SetSavedSearchId(v string)` + +SetSavedSearchId sets SavedSearchId field to given value. + + +### GetCreated + +`func (o *ScheduledSearch) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ScheduledSearch) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ScheduledSearch) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ScheduledSearch) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *ScheduledSearch) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *ScheduledSearch) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *ScheduledSearch) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ScheduledSearch) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ScheduledSearch) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ScheduledSearch) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *ScheduledSearch) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *ScheduledSearch) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSchedule + +`func (o *ScheduledSearch) GetSchedule() Schedule1` + +GetSchedule returns the Schedule field if non-nil, zero value otherwise. + +### GetScheduleOk + +`func (o *ScheduledSearch) GetScheduleOk() (*Schedule1, bool)` + +GetScheduleOk returns a tuple with the Schedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchedule + +`func (o *ScheduledSearch) SetSchedule(v Schedule1)` + +SetSchedule sets Schedule field to given value. + + +### GetRecipients + +`func (o *ScheduledSearch) GetRecipients() []SearchScheduleRecipientsInner` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *ScheduledSearch) GetRecipientsOk() (*[]SearchScheduleRecipientsInner, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *ScheduledSearch) SetRecipients(v []SearchScheduleRecipientsInner)` + +SetRecipients sets Recipients field to given value. + + +### GetEnabled + +`func (o *ScheduledSearch) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ScheduledSearch) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ScheduledSearch) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ScheduledSearch) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEmailEmptyResults + +`func (o *ScheduledSearch) GetEmailEmptyResults() bool` + +GetEmailEmptyResults returns the EmailEmptyResults field if non-nil, zero value otherwise. + +### GetEmailEmptyResultsOk + +`func (o *ScheduledSearch) GetEmailEmptyResultsOk() (*bool, bool)` + +GetEmailEmptyResultsOk returns a tuple with the EmailEmptyResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEmptyResults + +`func (o *ScheduledSearch) SetEmailEmptyResults(v bool)` + +SetEmailEmptyResults sets EmailEmptyResults field to given value. + +### HasEmailEmptyResults + +`func (o *ScheduledSearch) HasEmailEmptyResults() bool` + +HasEmailEmptyResults returns a boolean if a field has been set. + +### GetDisplayQueryDetails + +`func (o *ScheduledSearch) GetDisplayQueryDetails() bool` + +GetDisplayQueryDetails returns the DisplayQueryDetails field if non-nil, zero value otherwise. + +### GetDisplayQueryDetailsOk + +`func (o *ScheduledSearch) GetDisplayQueryDetailsOk() (*bool, bool)` + +GetDisplayQueryDetailsOk returns a tuple with the DisplayQueryDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayQueryDetails + +`func (o *ScheduledSearch) SetDisplayQueryDetails(v bool)` + +SetDisplayQueryDetails sets DisplayQueryDetails field to given value. + +### HasDisplayQueryDetails + +`func (o *ScheduledSearch) HasDisplayQueryDetails() bool` + +HasDisplayQueryDetails returns a boolean if a field has been set. + +### GetId + +`func (o *ScheduledSearch) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ScheduledSearch) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ScheduledSearch) SetId(v string)` + +SetId sets Id field to given value. + + +### GetOwner + +`func (o *ScheduledSearch) GetOwner() ScheduledSearchAllOfOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *ScheduledSearch) GetOwnerOk() (*ScheduledSearchAllOfOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *ScheduledSearch) SetOwner(v ScheduledSearchAllOfOwner)` + +SetOwner sets Owner field to given value. + + +### GetOwnerId + +`func (o *ScheduledSearch) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *ScheduledSearch) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *ScheduledSearch) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ScheduledSearchAllOfOwner.md b/docs/tools/sdk/go/Reference/V3/Models/ScheduledSearchAllOfOwner.md new file mode 100644 index 000000000..3ce26a564 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ScheduledSearchAllOfOwner.md @@ -0,0 +1,80 @@ +--- +id: scheduled-search-all-of-owner +title: ScheduledSearchAllOfOwner +pagination_label: ScheduledSearchAllOfOwner +sidebar_label: ScheduledSearchAllOfOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledSearchAllOfOwner', 'ScheduledSearchAllOfOwner'] +slug: /tools/sdk/go/v3/models/scheduled-search-all-of-owner +tags: ['SDK', 'Software Development Kit', 'ScheduledSearchAllOfOwner', 'ScheduledSearchAllOfOwner'] +--- + +# ScheduledSearchAllOfOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of object being referenced | +**Id** | **string** | The ID of the referenced object | + +## Methods + +### NewScheduledSearchAllOfOwner + +`func NewScheduledSearchAllOfOwner(type_ string, id string, ) *ScheduledSearchAllOfOwner` + +NewScheduledSearchAllOfOwner instantiates a new ScheduledSearchAllOfOwner 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 + +### NewScheduledSearchAllOfOwnerWithDefaults + +`func NewScheduledSearchAllOfOwnerWithDefaults() *ScheduledSearchAllOfOwner` + +NewScheduledSearchAllOfOwnerWithDefaults instantiates a new ScheduledSearchAllOfOwner 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 + +### GetType + +`func (o *ScheduledSearchAllOfOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ScheduledSearchAllOfOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ScheduledSearchAllOfOwner) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *ScheduledSearchAllOfOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ScheduledSearchAllOfOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ScheduledSearchAllOfOwner) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ScheduledSearchName.md b/docs/tools/sdk/go/Reference/V3/Models/ScheduledSearchName.md new file mode 100644 index 000000000..18853c151 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ScheduledSearchName.md @@ -0,0 +1,110 @@ +--- +id: scheduled-search-name +title: ScheduledSearchName +pagination_label: ScheduledSearchName +sidebar_label: ScheduledSearchName +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ScheduledSearchName', 'ScheduledSearchName'] +slug: /tools/sdk/go/v3/models/scheduled-search-name +tags: ['SDK', 'Software Development Kit', 'ScheduledSearchName', 'ScheduledSearchName'] +--- + +# ScheduledSearchName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **NullableString** | The name of the scheduled search. | [optional] +**Description** | Pointer to **NullableString** | The description of the scheduled search. | [optional] + +## Methods + +### NewScheduledSearchName + +`func NewScheduledSearchName() *ScheduledSearchName` + +NewScheduledSearchName instantiates a new ScheduledSearchName 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 + +### NewScheduledSearchNameWithDefaults + +`func NewScheduledSearchNameWithDefaults() *ScheduledSearchName` + +NewScheduledSearchNameWithDefaults instantiates a new ScheduledSearchName 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 + +### GetName + +`func (o *ScheduledSearchName) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ScheduledSearchName) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ScheduledSearchName) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ScheduledSearchName) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ScheduledSearchName) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ScheduledSearchName) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetDescription + +`func (o *ScheduledSearchName) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ScheduledSearchName) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ScheduledSearchName) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *ScheduledSearchName) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *ScheduledSearchName) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *ScheduledSearchName) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Schema.md b/docs/tools/sdk/go/Reference/V3/Models/Schema.md new file mode 100644 index 000000000..6c9b497d2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Schema.md @@ -0,0 +1,350 @@ +--- +id: schema +title: Schema +pagination_label: Schema +sidebar_label: Schema +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Schema', 'Schema'] +slug: /tools/sdk/go/v3/models/schema +tags: ['SDK', 'Software Development Kit', 'Schema', 'Schema'] +--- + +# Schema + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The id of the Schema. | [optional] +**Name** | Pointer to **string** | The name of the Schema. | [optional] +**NativeObjectType** | Pointer to **string** | The name of the object type on the native system that the schema represents. | [optional] +**IdentityAttribute** | Pointer to **string** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional] +**DisplayAttribute** | Pointer to **string** | The name of the attribute used to calculate the display value for an object in the schema. | [optional] +**HierarchyAttribute** | Pointer to **string** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional] +**IncludePermissions** | Pointer to **bool** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] +**Features** | Pointer to **[]string** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Configuration** | Pointer to **map[string]interface{}** | Holds any extra configuration data that the schema may require. | [optional] +**Attributes** | Pointer to [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional] +**Created** | Pointer to **SailPointTime** | The date the Schema was created. | [optional] +**Modified** | Pointer to **SailPointTime** | The date the Schema was last modified. | [optional] + +## Methods + +### NewSchema + +`func NewSchema() *Schema` + +NewSchema instantiates a new Schema 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 + +### NewSchemaWithDefaults + +`func NewSchemaWithDefaults() *Schema` + +NewSchemaWithDefaults instantiates a new Schema 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 + +### GetId + +`func (o *Schema) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Schema) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Schema) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Schema) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Schema) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Schema) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Schema) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Schema) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetNativeObjectType + +`func (o *Schema) GetNativeObjectType() string` + +GetNativeObjectType returns the NativeObjectType field if non-nil, zero value otherwise. + +### GetNativeObjectTypeOk + +`func (o *Schema) GetNativeObjectTypeOk() (*string, bool)` + +GetNativeObjectTypeOk returns a tuple with the NativeObjectType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNativeObjectType + +`func (o *Schema) SetNativeObjectType(v string)` + +SetNativeObjectType sets NativeObjectType field to given value. + +### HasNativeObjectType + +`func (o *Schema) HasNativeObjectType() bool` + +HasNativeObjectType returns a boolean if a field has been set. + +### GetIdentityAttribute + +`func (o *Schema) GetIdentityAttribute() string` + +GetIdentityAttribute returns the IdentityAttribute field if non-nil, zero value otherwise. + +### GetIdentityAttributeOk + +`func (o *Schema) GetIdentityAttributeOk() (*string, bool)` + +GetIdentityAttributeOk returns a tuple with the IdentityAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttribute + +`func (o *Schema) SetIdentityAttribute(v string)` + +SetIdentityAttribute sets IdentityAttribute field to given value. + +### HasIdentityAttribute + +`func (o *Schema) HasIdentityAttribute() bool` + +HasIdentityAttribute returns a boolean if a field has been set. + +### GetDisplayAttribute + +`func (o *Schema) GetDisplayAttribute() string` + +GetDisplayAttribute returns the DisplayAttribute field if non-nil, zero value otherwise. + +### GetDisplayAttributeOk + +`func (o *Schema) GetDisplayAttributeOk() (*string, bool)` + +GetDisplayAttributeOk returns a tuple with the DisplayAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayAttribute + +`func (o *Schema) SetDisplayAttribute(v string)` + +SetDisplayAttribute sets DisplayAttribute field to given value. + +### HasDisplayAttribute + +`func (o *Schema) HasDisplayAttribute() bool` + +HasDisplayAttribute returns a boolean if a field has been set. + +### GetHierarchyAttribute + +`func (o *Schema) GetHierarchyAttribute() string` + +GetHierarchyAttribute returns the HierarchyAttribute field if non-nil, zero value otherwise. + +### GetHierarchyAttributeOk + +`func (o *Schema) GetHierarchyAttributeOk() (*string, bool)` + +GetHierarchyAttributeOk returns a tuple with the HierarchyAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHierarchyAttribute + +`func (o *Schema) SetHierarchyAttribute(v string)` + +SetHierarchyAttribute sets HierarchyAttribute field to given value. + +### HasHierarchyAttribute + +`func (o *Schema) HasHierarchyAttribute() bool` + +HasHierarchyAttribute returns a boolean if a field has been set. + +### GetIncludePermissions + +`func (o *Schema) GetIncludePermissions() bool` + +GetIncludePermissions returns the IncludePermissions field if non-nil, zero value otherwise. + +### GetIncludePermissionsOk + +`func (o *Schema) GetIncludePermissionsOk() (*bool, bool)` + +GetIncludePermissionsOk returns a tuple with the IncludePermissions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludePermissions + +`func (o *Schema) SetIncludePermissions(v bool)` + +SetIncludePermissions sets IncludePermissions field to given value. + +### HasIncludePermissions + +`func (o *Schema) HasIncludePermissions() bool` + +HasIncludePermissions returns a boolean if a field has been set. + +### GetFeatures + +`func (o *Schema) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *Schema) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *Schema) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *Schema) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### GetConfiguration + +`func (o *Schema) GetConfiguration() map[string]interface{}` + +GetConfiguration returns the Configuration field if non-nil, zero value otherwise. + +### GetConfigurationOk + +`func (o *Schema) GetConfigurationOk() (*map[string]interface{}, bool)` + +GetConfigurationOk returns a tuple with the Configuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfiguration + +`func (o *Schema) SetConfiguration(v map[string]interface{})` + +SetConfiguration sets Configuration field to given value. + +### HasConfiguration + +`func (o *Schema) HasConfiguration() bool` + +HasConfiguration returns a boolean if a field has been set. + +### GetAttributes + +`func (o *Schema) GetAttributes() []AttributeDefinition` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Schema) GetAttributesOk() (*[]AttributeDefinition, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Schema) SetAttributes(v []AttributeDefinition)` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *Schema) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetCreated + +`func (o *Schema) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Schema) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Schema) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Schema) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Schema) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Schema) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Schema) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Schema) HasModified() bool` + +HasModified returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Search.md b/docs/tools/sdk/go/Reference/V3/Models/Search.md new file mode 100644 index 000000000..411909e5f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Search.md @@ -0,0 +1,454 @@ +--- +id: search +title: Search +pagination_label: Search +sidebar_label: Search +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Search', 'Search'] +slug: /tools/sdk/go/v3/models/search +tags: ['SDK', 'Software Development Kit', 'Search', 'Search'] +--- + +# Search + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**QueryType** | Pointer to [**QueryType**](query-type) | | [optional] [default to QUERYTYPE_SAILPOINT] +**QueryVersion** | Pointer to **string** | | [optional] +**Query** | Pointer to [**Query**](query) | | [optional] +**QueryDsl** | Pointer to **map[string]interface{}** | The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. | [optional] +**TextQuery** | Pointer to [**TextQuery**](text-query) | | [optional] +**TypeAheadQuery** | Pointer to [**TypeAheadQuery**](type-ahead-query) | | [optional] +**IncludeNested** | Pointer to **bool** | Indicates whether nested objects from returned search results should be included. | [optional] [default to true] +**QueryResultFilter** | Pointer to [**QueryResultFilter**](query-result-filter) | | [optional] +**AggregationType** | Pointer to [**AggregationType**](aggregation-type) | | [optional] [default to AGGREGATIONTYPE_DSL] +**AggregationsVersion** | Pointer to **string** | | [optional] +**AggregationsDsl** | Pointer to **map[string]interface{}** | The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. | [optional] +**Aggregations** | Pointer to [**SearchAggregationSpecification**](search-aggregation-specification) | | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] +**SearchAfter** | Pointer to **[]string** | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [\"displayName\", \"id\"]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is \"John Doe\", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like [\"John Doe\",\"2c91808375d8e80a0175e1f88a575221\"] | [optional] +**Filters** | Pointer to [**map[string]Filter**](filter) | The filters to be applied for each filtered field name. | [optional] + +## Methods + +### NewSearch + +`func NewSearch() *Search` + +NewSearch instantiates a new Search 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 + +### NewSearchWithDefaults + +`func NewSearchWithDefaults() *Search` + +NewSearchWithDefaults instantiates a new Search 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 + +### GetIndices + +`func (o *Search) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *Search) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *Search) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + +### HasIndices + +`func (o *Search) HasIndices() bool` + +HasIndices returns a boolean if a field has been set. + +### GetQueryType + +`func (o *Search) GetQueryType() QueryType` + +GetQueryType returns the QueryType field if non-nil, zero value otherwise. + +### GetQueryTypeOk + +`func (o *Search) GetQueryTypeOk() (*QueryType, bool)` + +GetQueryTypeOk returns a tuple with the QueryType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueryType + +`func (o *Search) SetQueryType(v QueryType)` + +SetQueryType sets QueryType field to given value. + +### HasQueryType + +`func (o *Search) HasQueryType() bool` + +HasQueryType returns a boolean if a field has been set. + +### GetQueryVersion + +`func (o *Search) GetQueryVersion() string` + +GetQueryVersion returns the QueryVersion field if non-nil, zero value otherwise. + +### GetQueryVersionOk + +`func (o *Search) GetQueryVersionOk() (*string, bool)` + +GetQueryVersionOk returns a tuple with the QueryVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueryVersion + +`func (o *Search) SetQueryVersion(v string)` + +SetQueryVersion sets QueryVersion field to given value. + +### HasQueryVersion + +`func (o *Search) HasQueryVersion() bool` + +HasQueryVersion returns a boolean if a field has been set. + +### GetQuery + +`func (o *Search) GetQuery() Query` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *Search) GetQueryOk() (*Query, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *Search) SetQuery(v Query)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *Search) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### GetQueryDsl + +`func (o *Search) GetQueryDsl() map[string]interface{}` + +GetQueryDsl returns the QueryDsl field if non-nil, zero value otherwise. + +### GetQueryDslOk + +`func (o *Search) GetQueryDslOk() (*map[string]interface{}, bool)` + +GetQueryDslOk returns a tuple with the QueryDsl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueryDsl + +`func (o *Search) SetQueryDsl(v map[string]interface{})` + +SetQueryDsl sets QueryDsl field to given value. + +### HasQueryDsl + +`func (o *Search) HasQueryDsl() bool` + +HasQueryDsl returns a boolean if a field has been set. + +### GetTextQuery + +`func (o *Search) GetTextQuery() TextQuery` + +GetTextQuery returns the TextQuery field if non-nil, zero value otherwise. + +### GetTextQueryOk + +`func (o *Search) GetTextQueryOk() (*TextQuery, bool)` + +GetTextQueryOk returns a tuple with the TextQuery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTextQuery + +`func (o *Search) SetTextQuery(v TextQuery)` + +SetTextQuery sets TextQuery field to given value. + +### HasTextQuery + +`func (o *Search) HasTextQuery() bool` + +HasTextQuery returns a boolean if a field has been set. + +### GetTypeAheadQuery + +`func (o *Search) GetTypeAheadQuery() TypeAheadQuery` + +GetTypeAheadQuery returns the TypeAheadQuery field if non-nil, zero value otherwise. + +### GetTypeAheadQueryOk + +`func (o *Search) GetTypeAheadQueryOk() (*TypeAheadQuery, bool)` + +GetTypeAheadQueryOk returns a tuple with the TypeAheadQuery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTypeAheadQuery + +`func (o *Search) SetTypeAheadQuery(v TypeAheadQuery)` + +SetTypeAheadQuery sets TypeAheadQuery field to given value. + +### HasTypeAheadQuery + +`func (o *Search) HasTypeAheadQuery() bool` + +HasTypeAheadQuery returns a boolean if a field has been set. + +### GetIncludeNested + +`func (o *Search) GetIncludeNested() bool` + +GetIncludeNested returns the IncludeNested field if non-nil, zero value otherwise. + +### GetIncludeNestedOk + +`func (o *Search) GetIncludeNestedOk() (*bool, bool)` + +GetIncludeNestedOk returns a tuple with the IncludeNested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeNested + +`func (o *Search) SetIncludeNested(v bool)` + +SetIncludeNested sets IncludeNested field to given value. + +### HasIncludeNested + +`func (o *Search) HasIncludeNested() bool` + +HasIncludeNested returns a boolean if a field has been set. + +### GetQueryResultFilter + +`func (o *Search) GetQueryResultFilter() QueryResultFilter` + +GetQueryResultFilter returns the QueryResultFilter field if non-nil, zero value otherwise. + +### GetQueryResultFilterOk + +`func (o *Search) GetQueryResultFilterOk() (*QueryResultFilter, bool)` + +GetQueryResultFilterOk returns a tuple with the QueryResultFilter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueryResultFilter + +`func (o *Search) SetQueryResultFilter(v QueryResultFilter)` + +SetQueryResultFilter sets QueryResultFilter field to given value. + +### HasQueryResultFilter + +`func (o *Search) HasQueryResultFilter() bool` + +HasQueryResultFilter returns a boolean if a field has been set. + +### GetAggregationType + +`func (o *Search) GetAggregationType() AggregationType` + +GetAggregationType returns the AggregationType field if non-nil, zero value otherwise. + +### GetAggregationTypeOk + +`func (o *Search) GetAggregationTypeOk() (*AggregationType, bool)` + +GetAggregationTypeOk returns a tuple with the AggregationType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationType + +`func (o *Search) SetAggregationType(v AggregationType)` + +SetAggregationType sets AggregationType field to given value. + +### HasAggregationType + +`func (o *Search) HasAggregationType() bool` + +HasAggregationType returns a boolean if a field has been set. + +### GetAggregationsVersion + +`func (o *Search) GetAggregationsVersion() string` + +GetAggregationsVersion returns the AggregationsVersion field if non-nil, zero value otherwise. + +### GetAggregationsVersionOk + +`func (o *Search) GetAggregationsVersionOk() (*string, bool)` + +GetAggregationsVersionOk returns a tuple with the AggregationsVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationsVersion + +`func (o *Search) SetAggregationsVersion(v string)` + +SetAggregationsVersion sets AggregationsVersion field to given value. + +### HasAggregationsVersion + +`func (o *Search) HasAggregationsVersion() bool` + +HasAggregationsVersion returns a boolean if a field has been set. + +### GetAggregationsDsl + +`func (o *Search) GetAggregationsDsl() map[string]interface{}` + +GetAggregationsDsl returns the AggregationsDsl field if non-nil, zero value otherwise. + +### GetAggregationsDslOk + +`func (o *Search) GetAggregationsDslOk() (*map[string]interface{}, bool)` + +GetAggregationsDslOk returns a tuple with the AggregationsDsl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregationsDsl + +`func (o *Search) SetAggregationsDsl(v map[string]interface{})` + +SetAggregationsDsl sets AggregationsDsl field to given value. + +### HasAggregationsDsl + +`func (o *Search) HasAggregationsDsl() bool` + +HasAggregationsDsl returns a boolean if a field has been set. + +### GetAggregations + +`func (o *Search) GetAggregations() SearchAggregationSpecification` + +GetAggregations returns the Aggregations field if non-nil, zero value otherwise. + +### GetAggregationsOk + +`func (o *Search) GetAggregationsOk() (*SearchAggregationSpecification, bool)` + +GetAggregationsOk returns a tuple with the Aggregations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregations + +`func (o *Search) SetAggregations(v SearchAggregationSpecification)` + +SetAggregations sets Aggregations field to given value. + +### HasAggregations + +`func (o *Search) HasAggregations() bool` + +HasAggregations returns a boolean if a field has been set. + +### GetSort + +`func (o *Search) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *Search) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *Search) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *Search) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### GetSearchAfter + +`func (o *Search) GetSearchAfter() []string` + +GetSearchAfter returns the SearchAfter field if non-nil, zero value otherwise. + +### GetSearchAfterOk + +`func (o *Search) GetSearchAfterOk() (*[]string, bool)` + +GetSearchAfterOk returns a tuple with the SearchAfter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchAfter + +`func (o *Search) SetSearchAfter(v []string)` + +SetSearchAfter sets SearchAfter field to given value. + +### HasSearchAfter + +`func (o *Search) HasSearchAfter() bool` + +HasSearchAfter returns a boolean if a field has been set. + +### GetFilters + +`func (o *Search) GetFilters() map[string]Filter` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *Search) GetFiltersOk() (*map[string]Filter, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *Search) SetFilters(v map[string]Filter)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *Search) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SearchAggregationSpecification.md b/docs/tools/sdk/go/Reference/V3/Models/SearchAggregationSpecification.md new file mode 100644 index 000000000..e0820fe2e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SearchAggregationSpecification.md @@ -0,0 +1,168 @@ +--- +id: search-aggregation-specification +title: SearchAggregationSpecification +pagination_label: SearchAggregationSpecification +sidebar_label: SearchAggregationSpecification +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchAggregationSpecification', 'SearchAggregationSpecification'] +slug: /tools/sdk/go/v3/models/search-aggregation-specification +tags: ['SDK', 'Software Development Kit', 'SearchAggregationSpecification', 'SearchAggregationSpecification'] +--- + +# SearchAggregationSpecification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional] +**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional] +**Filter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional] +**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional] +**SubAggregation** | Pointer to [**SubSearchAggregationSpecification**](sub-search-aggregation-specification) | | [optional] + +## Methods + +### NewSearchAggregationSpecification + +`func NewSearchAggregationSpecification() *SearchAggregationSpecification` + +NewSearchAggregationSpecification instantiates a new SearchAggregationSpecification 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 + +### NewSearchAggregationSpecificationWithDefaults + +`func NewSearchAggregationSpecificationWithDefaults() *SearchAggregationSpecification` + +NewSearchAggregationSpecificationWithDefaults instantiates a new SearchAggregationSpecification 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 + +### GetNested + +`func (o *SearchAggregationSpecification) GetNested() NestedAggregation` + +GetNested returns the Nested field if non-nil, zero value otherwise. + +### GetNestedOk + +`func (o *SearchAggregationSpecification) GetNestedOk() (*NestedAggregation, bool)` + +GetNestedOk returns a tuple with the Nested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNested + +`func (o *SearchAggregationSpecification) SetNested(v NestedAggregation)` + +SetNested sets Nested field to given value. + +### HasNested + +`func (o *SearchAggregationSpecification) HasNested() bool` + +HasNested returns a boolean if a field has been set. + +### GetMetric + +`func (o *SearchAggregationSpecification) GetMetric() MetricAggregation` + +GetMetric returns the Metric field if non-nil, zero value otherwise. + +### GetMetricOk + +`func (o *SearchAggregationSpecification) GetMetricOk() (*MetricAggregation, bool)` + +GetMetricOk returns a tuple with the Metric field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetric + +`func (o *SearchAggregationSpecification) SetMetric(v MetricAggregation)` + +SetMetric sets Metric field to given value. + +### HasMetric + +`func (o *SearchAggregationSpecification) HasMetric() bool` + +HasMetric returns a boolean if a field has been set. + +### GetFilter + +`func (o *SearchAggregationSpecification) GetFilter() FilterAggregation` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *SearchAggregationSpecification) GetFilterOk() (*FilterAggregation, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *SearchAggregationSpecification) SetFilter(v FilterAggregation)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *SearchAggregationSpecification) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### GetBucket + +`func (o *SearchAggregationSpecification) GetBucket() BucketAggregation` + +GetBucket returns the Bucket field if non-nil, zero value otherwise. + +### GetBucketOk + +`func (o *SearchAggregationSpecification) GetBucketOk() (*BucketAggregation, bool)` + +GetBucketOk returns a tuple with the Bucket field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBucket + +`func (o *SearchAggregationSpecification) SetBucket(v BucketAggregation)` + +SetBucket sets Bucket field to given value. + +### HasBucket + +`func (o *SearchAggregationSpecification) HasBucket() bool` + +HasBucket returns a boolean if a field has been set. + +### GetSubAggregation + +`func (o *SearchAggregationSpecification) GetSubAggregation() SubSearchAggregationSpecification` + +GetSubAggregation returns the SubAggregation field if non-nil, zero value otherwise. + +### GetSubAggregationOk + +`func (o *SearchAggregationSpecification) GetSubAggregationOk() (*SubSearchAggregationSpecification, bool)` + +GetSubAggregationOk returns a tuple with the SubAggregation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubAggregation + +`func (o *SearchAggregationSpecification) SetSubAggregation(v SubSearchAggregationSpecification)` + +SetSubAggregation sets SubAggregation field to given value. + +### HasSubAggregation + +`func (o *SearchAggregationSpecification) HasSubAggregation() bool` + +HasSubAggregation returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SearchArguments.md b/docs/tools/sdk/go/Reference/V3/Models/SearchArguments.md new file mode 100644 index 000000000..a802685e6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SearchArguments.md @@ -0,0 +1,116 @@ +--- +id: search-arguments +title: SearchArguments +pagination_label: SearchArguments +sidebar_label: SearchArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchArguments', 'SearchArguments'] +slug: /tools/sdk/go/v3/models/search-arguments +tags: ['SDK', 'Software Development Kit', 'SearchArguments', 'SearchArguments'] +--- + +# SearchArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ScheduleId** | Pointer to **string** | The ID of the scheduled search that triggered the saved search execution. | [optional] +**Owner** | Pointer to [**TypedReference**](typed-reference) | The owner of the scheduled search being tested. | [optional] +**Recipients** | Pointer to [**[]TypedReference**](typed-reference) | The email recipients of the scheduled search being tested. | [optional] + +## Methods + +### NewSearchArguments + +`func NewSearchArguments() *SearchArguments` + +NewSearchArguments instantiates a new SearchArguments 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 + +### NewSearchArgumentsWithDefaults + +`func NewSearchArgumentsWithDefaults() *SearchArguments` + +NewSearchArgumentsWithDefaults instantiates a new SearchArguments 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 + +### GetScheduleId + +`func (o *SearchArguments) GetScheduleId() string` + +GetScheduleId returns the ScheduleId field if non-nil, zero value otherwise. + +### GetScheduleIdOk + +`func (o *SearchArguments) GetScheduleIdOk() (*string, bool)` + +GetScheduleIdOk returns a tuple with the ScheduleId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheduleId + +`func (o *SearchArguments) SetScheduleId(v string)` + +SetScheduleId sets ScheduleId field to given value. + +### HasScheduleId + +`func (o *SearchArguments) HasScheduleId() bool` + +HasScheduleId returns a boolean if a field has been set. + +### GetOwner + +`func (o *SearchArguments) GetOwner() TypedReference` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *SearchArguments) GetOwnerOk() (*TypedReference, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *SearchArguments) SetOwner(v TypedReference)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *SearchArguments) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetRecipients + +`func (o *SearchArguments) GetRecipients() []TypedReference` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *SearchArguments) GetRecipientsOk() (*[]TypedReference, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *SearchArguments) SetRecipients(v []TypedReference)` + +SetRecipients sets Recipients field to given value. + +### HasRecipients + +`func (o *SearchArguments) HasRecipients() bool` + +HasRecipients returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SearchAttributeConfig.md b/docs/tools/sdk/go/Reference/V3/Models/SearchAttributeConfig.md new file mode 100644 index 000000000..50a34cd16 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SearchAttributeConfig.md @@ -0,0 +1,116 @@ +--- +id: search-attribute-config +title: SearchAttributeConfig +pagination_label: SearchAttributeConfig +sidebar_label: SearchAttributeConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchAttributeConfig', 'SearchAttributeConfig'] +slug: /tools/sdk/go/v3/models/search-attribute-config +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfig', 'SearchAttributeConfig'] +--- + +# SearchAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the new attribute | [optional] +**DisplayName** | Pointer to **string** | The display name of the new attribute | [optional] +**ApplicationAttributes** | Pointer to **map[string]interface{}** | Map of application id and their associated attribute. | [optional] + +## Methods + +### NewSearchAttributeConfig + +`func NewSearchAttributeConfig() *SearchAttributeConfig` + +NewSearchAttributeConfig instantiates a new SearchAttributeConfig 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 + +### NewSearchAttributeConfigWithDefaults + +`func NewSearchAttributeConfigWithDefaults() *SearchAttributeConfig` + +NewSearchAttributeConfigWithDefaults instantiates a new SearchAttributeConfig 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 + +### GetName + +`func (o *SearchAttributeConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SearchAttributeConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SearchAttributeConfig) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SearchAttributeConfig) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDisplayName + +`func (o *SearchAttributeConfig) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *SearchAttributeConfig) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *SearchAttributeConfig) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *SearchAttributeConfig) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### GetApplicationAttributes + +`func (o *SearchAttributeConfig) GetApplicationAttributes() map[string]interface{}` + +GetApplicationAttributes returns the ApplicationAttributes field if non-nil, zero value otherwise. + +### GetApplicationAttributesOk + +`func (o *SearchAttributeConfig) GetApplicationAttributesOk() (*map[string]interface{}, bool)` + +GetApplicationAttributesOk returns a tuple with the ApplicationAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApplicationAttributes + +`func (o *SearchAttributeConfig) SetApplicationAttributes(v map[string]interface{})` + +SetApplicationAttributes sets ApplicationAttributes field to given value. + +### HasApplicationAttributes + +`func (o *SearchAttributeConfig) HasApplicationAttributes() bool` + +HasApplicationAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SearchExportReportArguments.md b/docs/tools/sdk/go/Reference/V3/Models/SearchExportReportArguments.md new file mode 100644 index 000000000..a406c00e3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SearchExportReportArguments.md @@ -0,0 +1,137 @@ +--- +id: search-export-report-arguments +title: SearchExportReportArguments +pagination_label: SearchExportReportArguments +sidebar_label: SearchExportReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchExportReportArguments', 'SearchExportReportArguments'] +slug: /tools/sdk/go/v3/models/search-export-report-arguments +tags: ['SDK', 'Software Development Kit', 'SearchExportReportArguments', 'SearchExportReportArguments'] +--- + +# SearchExportReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**Query** | **string** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | +**Columns** | Pointer to **string** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] +**Sort** | Pointer to **[]string** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] + +## Methods + +### NewSearchExportReportArguments + +`func NewSearchExportReportArguments(query string, ) *SearchExportReportArguments` + +NewSearchExportReportArguments instantiates a new SearchExportReportArguments 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 + +### NewSearchExportReportArgumentsWithDefaults + +`func NewSearchExportReportArgumentsWithDefaults() *SearchExportReportArguments` + +NewSearchExportReportArgumentsWithDefaults instantiates a new SearchExportReportArguments 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 + +### GetIndices + +`func (o *SearchExportReportArguments) GetIndices() []Index` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *SearchExportReportArguments) GetIndicesOk() (*[]Index, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *SearchExportReportArguments) SetIndices(v []Index)` + +SetIndices sets Indices field to given value. + +### HasIndices + +`func (o *SearchExportReportArguments) HasIndices() bool` + +HasIndices returns a boolean if a field has been set. + +### GetQuery + +`func (o *SearchExportReportArguments) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SearchExportReportArguments) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SearchExportReportArguments) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetColumns + +`func (o *SearchExportReportArguments) GetColumns() string` + +GetColumns returns the Columns field if non-nil, zero value otherwise. + +### GetColumnsOk + +`func (o *SearchExportReportArguments) GetColumnsOk() (*string, bool)` + +GetColumnsOk returns a tuple with the Columns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetColumns + +`func (o *SearchExportReportArguments) SetColumns(v string)` + +SetColumns sets Columns field to given value. + +### HasColumns + +`func (o *SearchExportReportArguments) HasColumns() bool` + +HasColumns returns a boolean if a field has been set. + +### GetSort + +`func (o *SearchExportReportArguments) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *SearchExportReportArguments) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *SearchExportReportArguments) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *SearchExportReportArguments) HasSort() bool` + +HasSort returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SearchFilterType.md b/docs/tools/sdk/go/Reference/V3/Models/SearchFilterType.md new file mode 100644 index 000000000..38ea3defc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SearchFilterType.md @@ -0,0 +1,19 @@ +--- +id: search-filter-type +title: SearchFilterType +pagination_label: SearchFilterType +sidebar_label: SearchFilterType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchFilterType', 'SearchFilterType'] +slug: /tools/sdk/go/v3/models/search-filter-type +tags: ['SDK', 'Software Development Kit', 'SearchFilterType', 'SearchFilterType'] +--- + +# SearchFilterType + +## Enum + + +* `TERM` (value: `"TERM"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SearchSchedule.md b/docs/tools/sdk/go/Reference/V3/Models/SearchSchedule.md new file mode 100644 index 000000000..ccd679321 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SearchSchedule.md @@ -0,0 +1,251 @@ +--- +id: search-schedule +title: SearchSchedule +pagination_label: SearchSchedule +sidebar_label: SearchSchedule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchSchedule', 'SearchSchedule'] +slug: /tools/sdk/go/v3/models/search-schedule +tags: ['SDK', 'Software Development Kit', 'SearchSchedule', 'SearchSchedule'] +--- + +# SearchSchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SavedSearchId** | **string** | The ID of the saved search that will be executed. | +**Created** | Pointer to **NullableTime** | The date the scheduled search was initially created. | [optional] [readonly] +**Modified** | Pointer to **NullableTime** | The last date the scheduled search was modified. | [optional] [readonly] +**Schedule** | [**Schedule1**](schedule1) | | +**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | +**Enabled** | Pointer to **bool** | Indicates if the scheduled search is enabled. | [optional] [default to false] +**EmailEmptyResults** | Pointer to **bool** | Indicates if email generation should occur when search returns no results. | [optional] [default to false] +**DisplayQueryDetails** | Pointer to **bool** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to false] + +## Methods + +### NewSearchSchedule + +`func NewSearchSchedule(savedSearchId string, schedule Schedule1, recipients []SearchScheduleRecipientsInner, ) *SearchSchedule` + +NewSearchSchedule instantiates a new SearchSchedule 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 + +### NewSearchScheduleWithDefaults + +`func NewSearchScheduleWithDefaults() *SearchSchedule` + +NewSearchScheduleWithDefaults instantiates a new SearchSchedule 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 + +### GetSavedSearchId + +`func (o *SearchSchedule) GetSavedSearchId() string` + +GetSavedSearchId returns the SavedSearchId field if non-nil, zero value otherwise. + +### GetSavedSearchIdOk + +`func (o *SearchSchedule) GetSavedSearchIdOk() (*string, bool)` + +GetSavedSearchIdOk returns a tuple with the SavedSearchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSavedSearchId + +`func (o *SearchSchedule) SetSavedSearchId(v string)` + +SetSavedSearchId sets SavedSearchId field to given value. + + +### GetCreated + +`func (o *SearchSchedule) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SearchSchedule) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SearchSchedule) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SearchSchedule) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreatedNil + +`func (o *SearchSchedule) SetCreatedNil(b bool)` + + SetCreatedNil sets the value for Created to be an explicit nil + +### UnsetCreated +`func (o *SearchSchedule) UnsetCreated()` + +UnsetCreated ensures that no value is present for Created, not even an explicit nil +### GetModified + +`func (o *SearchSchedule) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SearchSchedule) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SearchSchedule) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SearchSchedule) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *SearchSchedule) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *SearchSchedule) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetSchedule + +`func (o *SearchSchedule) GetSchedule() Schedule1` + +GetSchedule returns the Schedule field if non-nil, zero value otherwise. + +### GetScheduleOk + +`func (o *SearchSchedule) GetScheduleOk() (*Schedule1, bool)` + +GetScheduleOk returns a tuple with the Schedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchedule + +`func (o *SearchSchedule) SetSchedule(v Schedule1)` + +SetSchedule sets Schedule field to given value. + + +### GetRecipients + +`func (o *SearchSchedule) GetRecipients() []SearchScheduleRecipientsInner` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *SearchSchedule) GetRecipientsOk() (*[]SearchScheduleRecipientsInner, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *SearchSchedule) SetRecipients(v []SearchScheduleRecipientsInner)` + +SetRecipients sets Recipients field to given value. + + +### GetEnabled + +`func (o *SearchSchedule) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *SearchSchedule) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *SearchSchedule) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *SearchSchedule) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetEmailEmptyResults + +`func (o *SearchSchedule) GetEmailEmptyResults() bool` + +GetEmailEmptyResults returns the EmailEmptyResults field if non-nil, zero value otherwise. + +### GetEmailEmptyResultsOk + +`func (o *SearchSchedule) GetEmailEmptyResultsOk() (*bool, bool)` + +GetEmailEmptyResultsOk returns a tuple with the EmailEmptyResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEmptyResults + +`func (o *SearchSchedule) SetEmailEmptyResults(v bool)` + +SetEmailEmptyResults sets EmailEmptyResults field to given value. + +### HasEmailEmptyResults + +`func (o *SearchSchedule) HasEmailEmptyResults() bool` + +HasEmailEmptyResults returns a boolean if a field has been set. + +### GetDisplayQueryDetails + +`func (o *SearchSchedule) GetDisplayQueryDetails() bool` + +GetDisplayQueryDetails returns the DisplayQueryDetails field if non-nil, zero value otherwise. + +### GetDisplayQueryDetailsOk + +`func (o *SearchSchedule) GetDisplayQueryDetailsOk() (*bool, bool)` + +GetDisplayQueryDetailsOk returns a tuple with the DisplayQueryDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayQueryDetails + +`func (o *SearchSchedule) SetDisplayQueryDetails(v bool)` + +SetDisplayQueryDetails sets DisplayQueryDetails field to given value. + +### HasDisplayQueryDetails + +`func (o *SearchSchedule) HasDisplayQueryDetails() bool` + +HasDisplayQueryDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SearchScheduleRecipientsInner.md b/docs/tools/sdk/go/Reference/V3/Models/SearchScheduleRecipientsInner.md new file mode 100644 index 000000000..24c60c0e3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SearchScheduleRecipientsInner.md @@ -0,0 +1,80 @@ +--- +id: search-schedule-recipients-inner +title: SearchScheduleRecipientsInner +pagination_label: SearchScheduleRecipientsInner +sidebar_label: SearchScheduleRecipientsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchScheduleRecipientsInner', 'SearchScheduleRecipientsInner'] +slug: /tools/sdk/go/v3/models/search-schedule-recipients-inner +tags: ['SDK', 'Software Development Kit', 'SearchScheduleRecipientsInner', 'SearchScheduleRecipientsInner'] +--- + +# SearchScheduleRecipientsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The type of object being referenced | +**Id** | **string** | The ID of the referenced object | + +## Methods + +### NewSearchScheduleRecipientsInner + +`func NewSearchScheduleRecipientsInner(type_ string, id string, ) *SearchScheduleRecipientsInner` + +NewSearchScheduleRecipientsInner instantiates a new SearchScheduleRecipientsInner 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 + +### NewSearchScheduleRecipientsInnerWithDefaults + +`func NewSearchScheduleRecipientsInnerWithDefaults() *SearchScheduleRecipientsInner` + +NewSearchScheduleRecipientsInnerWithDefaults instantiates a new SearchScheduleRecipientsInner 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 + +### GetType + +`func (o *SearchScheduleRecipientsInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SearchScheduleRecipientsInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SearchScheduleRecipientsInner) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *SearchScheduleRecipientsInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SearchScheduleRecipientsInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SearchScheduleRecipientsInner) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SectionDetails.md b/docs/tools/sdk/go/Reference/V3/Models/SectionDetails.md new file mode 100644 index 000000000..471bd0951 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SectionDetails.md @@ -0,0 +1,116 @@ +--- +id: section-details +title: SectionDetails +pagination_label: SectionDetails +sidebar_label: SectionDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SectionDetails', 'SectionDetails'] +slug: /tools/sdk/go/v3/models/section-details +tags: ['SDK', 'Software Development Kit', 'SectionDetails', 'SectionDetails'] +--- + +# SectionDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Name of the FormItem | [optional] +**Label** | Pointer to **string** | Label of the section | [optional] +**FormItems** | Pointer to **[]map[string]interface{}** | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [optional] + +## Methods + +### NewSectionDetails + +`func NewSectionDetails() *SectionDetails` + +NewSectionDetails instantiates a new SectionDetails 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 + +### NewSectionDetailsWithDefaults + +`func NewSectionDetailsWithDefaults() *SectionDetails` + +NewSectionDetailsWithDefaults instantiates a new SectionDetails 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 + +### GetName + +`func (o *SectionDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SectionDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SectionDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SectionDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetLabel + +`func (o *SectionDetails) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *SectionDetails) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *SectionDetails) SetLabel(v string)` + +SetLabel sets Label field to given value. + +### HasLabel + +`func (o *SectionDetails) HasLabel() bool` + +HasLabel returns a boolean if a field has been set. + +### GetFormItems + +`func (o *SectionDetails) GetFormItems() []map[string]interface{}` + +GetFormItems returns the FormItems field if non-nil, zero value otherwise. + +### GetFormItemsOk + +`func (o *SectionDetails) GetFormItemsOk() (*[]map[string]interface{}, bool)` + +GetFormItemsOk returns a tuple with the FormItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormItems + +`func (o *SectionDetails) SetFormItems(v []map[string]interface{})` + +SetFormItems sets FormItems field to given value. + +### HasFormItems + +`func (o *SectionDetails) HasFormItems() bool` + +HasFormItems returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Segment.md b/docs/tools/sdk/go/Reference/V3/Models/Segment.md new file mode 100644 index 000000000..c5d757c49 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Segment.md @@ -0,0 +1,256 @@ +--- +id: segment +title: Segment +pagination_label: Segment +sidebar_label: Segment +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Segment', 'Segment'] +slug: /tools/sdk/go/v3/models/segment +tags: ['SDK', 'Software Development Kit', 'Segment', 'Segment'] +--- + +# Segment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The segment's ID. | [optional] +**Name** | Pointer to **string** | The segment's business name. | [optional] +**Created** | Pointer to **SailPointTime** | The time when the segment is created. | [optional] +**Modified** | Pointer to **SailPointTime** | The time when the segment is modified. | [optional] +**Description** | Pointer to **string** | The segment's optional description. | [optional] +**Owner** | Pointer to [**NullableOwnerReferenceSegments**](owner-reference-segments) | | [optional] +**VisibilityCriteria** | Pointer to [**SegmentVisibilityCriteria**](segment-visibility-criteria) | | [optional] +**Active** | Pointer to **bool** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to false] + +## Methods + +### NewSegment + +`func NewSegment() *Segment` + +NewSegment instantiates a new Segment 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 + +### NewSegmentWithDefaults + +`func NewSegmentWithDefaults() *Segment` + +NewSegmentWithDefaults instantiates a new Segment 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 + +### GetId + +`func (o *Segment) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Segment) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Segment) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Segment) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Segment) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Segment) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Segment) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Segment) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *Segment) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Segment) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Segment) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Segment) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Segment) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Segment) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Segment) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Segment) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *Segment) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Segment) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Segment) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Segment) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *Segment) GetOwner() OwnerReferenceSegments` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Segment) GetOwnerOk() (*OwnerReferenceSegments, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Segment) SetOwner(v OwnerReferenceSegments)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *Segment) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### SetOwnerNil + +`func (o *Segment) SetOwnerNil(b bool)` + + SetOwnerNil sets the value for Owner to be an explicit nil + +### UnsetOwner +`func (o *Segment) UnsetOwner()` + +UnsetOwner ensures that no value is present for Owner, not even an explicit nil +### GetVisibilityCriteria + +`func (o *Segment) GetVisibilityCriteria() SegmentVisibilityCriteria` + +GetVisibilityCriteria returns the VisibilityCriteria field if non-nil, zero value otherwise. + +### GetVisibilityCriteriaOk + +`func (o *Segment) GetVisibilityCriteriaOk() (*SegmentVisibilityCriteria, bool)` + +GetVisibilityCriteriaOk returns a tuple with the VisibilityCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVisibilityCriteria + +`func (o *Segment) SetVisibilityCriteria(v SegmentVisibilityCriteria)` + +SetVisibilityCriteria sets VisibilityCriteria field to given value. + +### HasVisibilityCriteria + +`func (o *Segment) HasVisibilityCriteria() bool` + +HasVisibilityCriteria returns a boolean if a field has been set. + +### GetActive + +`func (o *Segment) GetActive() bool` + +GetActive returns the Active field if non-nil, zero value otherwise. + +### GetActiveOk + +`func (o *Segment) GetActiveOk() (*bool, bool)` + +GetActiveOk returns a tuple with the Active field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActive + +`func (o *Segment) SetActive(v bool)` + +SetActive sets Active field to given value. + +### HasActive + +`func (o *Segment) HasActive() bool` + +HasActive returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SegmentVisibilityCriteria.md b/docs/tools/sdk/go/Reference/V3/Models/SegmentVisibilityCriteria.md new file mode 100644 index 000000000..d9fefd293 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SegmentVisibilityCriteria.md @@ -0,0 +1,64 @@ +--- +id: segment-visibility-criteria +title: SegmentVisibilityCriteria +pagination_label: SegmentVisibilityCriteria +sidebar_label: SegmentVisibilityCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SegmentVisibilityCriteria', 'SegmentVisibilityCriteria'] +slug: /tools/sdk/go/v3/models/segment-visibility-criteria +tags: ['SDK', 'Software Development Kit', 'SegmentVisibilityCriteria', 'SegmentVisibilityCriteria'] +--- + +# SegmentVisibilityCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | Pointer to [**Expression**](expression) | | [optional] + +## Methods + +### NewSegmentVisibilityCriteria + +`func NewSegmentVisibilityCriteria() *SegmentVisibilityCriteria` + +NewSegmentVisibilityCriteria instantiates a new SegmentVisibilityCriteria 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 + +### NewSegmentVisibilityCriteriaWithDefaults + +`func NewSegmentVisibilityCriteriaWithDefaults() *SegmentVisibilityCriteria` + +NewSegmentVisibilityCriteriaWithDefaults instantiates a new SegmentVisibilityCriteria 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 + +### GetExpression + +`func (o *SegmentVisibilityCriteria) GetExpression() Expression` + +GetExpression returns the Expression field if non-nil, zero value otherwise. + +### GetExpressionOk + +`func (o *SegmentVisibilityCriteria) GetExpressionOk() (*Expression, bool)` + +GetExpressionOk returns a tuple with the Expression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpression + +`func (o *SegmentVisibilityCriteria) SetExpression(v Expression)` + +SetExpression sets Expression field to given value. + +### HasExpression + +`func (o *SegmentVisibilityCriteria) HasExpression() bool` + +HasExpression returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Selector.md b/docs/tools/sdk/go/Reference/V3/Models/Selector.md new file mode 100644 index 000000000..64fd91763 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Selector.md @@ -0,0 +1,116 @@ +--- +id: selector +title: Selector +pagination_label: Selector +sidebar_label: Selector +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Selector', 'Selector'] +slug: /tools/sdk/go/v3/models/selector +tags: ['SDK', 'Software Development Kit', 'Selector', 'Selector'] +--- + +# Selector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**SelectorType**](selector-type) | | +**Values** | **[]string** | The selected values. | +**Interval** | Pointer to **NullableInt32** | The selected interval for RANGE selectors. | [optional] + +## Methods + +### NewSelector + +`func NewSelector(type_ SelectorType, values []string, ) *Selector` + +NewSelector instantiates a new Selector 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 + +### NewSelectorWithDefaults + +`func NewSelectorWithDefaults() *Selector` + +NewSelectorWithDefaults instantiates a new Selector 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 + +### GetType + +`func (o *Selector) GetType() SelectorType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Selector) GetTypeOk() (*SelectorType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Selector) SetType(v SelectorType)` + +SetType sets Type field to given value. + + +### GetValues + +`func (o *Selector) GetValues() []string` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *Selector) GetValuesOk() (*[]string, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *Selector) SetValues(v []string)` + +SetValues sets Values field to given value. + + +### GetInterval + +`func (o *Selector) GetInterval() int32` + +GetInterval returns the Interval field if non-nil, zero value otherwise. + +### GetIntervalOk + +`func (o *Selector) GetIntervalOk() (*int32, bool)` + +GetIntervalOk returns a tuple with the Interval field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInterval + +`func (o *Selector) SetInterval(v int32)` + +SetInterval sets Interval field to given value. + +### HasInterval + +`func (o *Selector) HasInterval() bool` + +HasInterval returns a boolean if a field has been set. + +### SetIntervalNil + +`func (o *Selector) SetIntervalNil(b bool)` + + SetIntervalNil sets the value for Interval to be an explicit nil + +### UnsetInterval +`func (o *Selector) UnsetInterval()` + +UnsetInterval ensures that no value is present for Interval, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SelectorType.md b/docs/tools/sdk/go/Reference/V3/Models/SelectorType.md new file mode 100644 index 000000000..66d40e17d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SelectorType.md @@ -0,0 +1,21 @@ +--- +id: selector-type +title: SelectorType +pagination_label: SelectorType +sidebar_label: SelectorType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SelectorType', 'SelectorType'] +slug: /tools/sdk/go/v3/models/selector-type +tags: ['SDK', 'Software Development Kit', 'SelectorType', 'SelectorType'] +--- + +# SelectorType + +## Enum + + +* `LIST` (value: `"LIST"`) + +* `RANGE` (value: `"RANGE"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SendTokenRequest.md b/docs/tools/sdk/go/Reference/V3/Models/SendTokenRequest.md new file mode 100644 index 000000000..dd97025c2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SendTokenRequest.md @@ -0,0 +1,80 @@ +--- +id: send-token-request +title: SendTokenRequest +pagination_label: SendTokenRequest +sidebar_label: SendTokenRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SendTokenRequest', 'SendTokenRequest'] +slug: /tools/sdk/go/v3/models/send-token-request +tags: ['SDK', 'Software Development Kit', 'SendTokenRequest', 'SendTokenRequest'] +--- + +# SendTokenRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserAlias** | **string** | User alias from table spt_identity field named 'name' | +**DeliveryType** | **string** | Token delivery type | + +## Methods + +### NewSendTokenRequest + +`func NewSendTokenRequest(userAlias string, deliveryType string, ) *SendTokenRequest` + +NewSendTokenRequest instantiates a new SendTokenRequest 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 + +### NewSendTokenRequestWithDefaults + +`func NewSendTokenRequestWithDefaults() *SendTokenRequest` + +NewSendTokenRequestWithDefaults instantiates a new SendTokenRequest 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 + +### GetUserAlias + +`func (o *SendTokenRequest) GetUserAlias() string` + +GetUserAlias returns the UserAlias field if non-nil, zero value otherwise. + +### GetUserAliasOk + +`func (o *SendTokenRequest) GetUserAliasOk() (*string, bool)` + +GetUserAliasOk returns a tuple with the UserAlias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserAlias + +`func (o *SendTokenRequest) SetUserAlias(v string)` + +SetUserAlias sets UserAlias field to given value. + + +### GetDeliveryType + +`func (o *SendTokenRequest) GetDeliveryType() string` + +GetDeliveryType returns the DeliveryType field if non-nil, zero value otherwise. + +### GetDeliveryTypeOk + +`func (o *SendTokenRequest) GetDeliveryTypeOk() (*string, bool)` + +GetDeliveryTypeOk returns a tuple with the DeliveryType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeliveryType + +`func (o *SendTokenRequest) SetDeliveryType(v string)` + +SetDeliveryType sets DeliveryType field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SendTokenResponse.md b/docs/tools/sdk/go/Reference/V3/Models/SendTokenResponse.md new file mode 100644 index 000000000..68db1c2d4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SendTokenResponse.md @@ -0,0 +1,136 @@ +--- +id: send-token-response +title: SendTokenResponse +pagination_label: SendTokenResponse +sidebar_label: SendTokenResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SendTokenResponse', 'SendTokenResponse'] +slug: /tools/sdk/go/v3/models/send-token-response +tags: ['SDK', 'Software Development Kit', 'SendTokenResponse', 'SendTokenResponse'] +--- + +# SendTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **NullableString** | The token request ID | [optional] +**Status** | Pointer to **string** | Status of sending token | [optional] +**ErrorMessage** | Pointer to **NullableString** | Error messages from token send request | [optional] + +## Methods + +### NewSendTokenResponse + +`func NewSendTokenResponse() *SendTokenResponse` + +NewSendTokenResponse instantiates a new SendTokenResponse 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 + +### NewSendTokenResponseWithDefaults + +`func NewSendTokenResponseWithDefaults() *SendTokenResponse` + +NewSendTokenResponseWithDefaults instantiates a new SendTokenResponse 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 + +### GetRequestId + +`func (o *SendTokenResponse) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *SendTokenResponse) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *SendTokenResponse) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *SendTokenResponse) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *SendTokenResponse) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *SendTokenResponse) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetStatus + +`func (o *SendTokenResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SendTokenResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SendTokenResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SendTokenResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *SendTokenResponse) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *SendTokenResponse) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *SendTokenResponse) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *SendTokenResponse) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### SetErrorMessageNil + +`func (o *SendTokenResponse) SetErrorMessageNil(b bool)` + + SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil + +### UnsetErrorMessage +`func (o *SendTokenResponse) UnsetErrorMessage()` + +UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ServiceDeskIntegrationDto.md b/docs/tools/sdk/go/Reference/V3/Models/ServiceDeskIntegrationDto.md new file mode 100644 index 000000000..61f4bdaf0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ServiceDeskIntegrationDto.md @@ -0,0 +1,366 @@ +--- +id: service-desk-integration-dto +title: ServiceDeskIntegrationDto +pagination_label: ServiceDeskIntegrationDto +sidebar_label: ServiceDeskIntegrationDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskIntegrationDto', 'ServiceDeskIntegrationDto'] +slug: /tools/sdk/go/v3/models/service-desk-integration-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationDto', 'ServiceDeskIntegrationDto'] +--- + +# ServiceDeskIntegrationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the Service Desk integration | [optional] +**Name** | **string** | Service Desk integration's name. The name must be unique. | +**Created** | Pointer to **SailPointTime** | The date and time the Service Desk integration was created | [optional] +**Modified** | Pointer to **SailPointTime** | The date and time the Service Desk integration was last modified | [optional] +**Description** | **string** | Service Desk integration's description. | +**Type** | **string** | Service Desk integration types: - ServiceNowSDIM - ServiceNow | [default to "ServiceNowSDIM"] +**OwnerRef** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**ClusterRef** | Pointer to [**SourceClusterDto**](source-cluster-dto) | | [optional] +**Cluster** | Pointer to **NullableString** | Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). | [optional] +**ManagedSources** | Pointer to **[]string** | Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). | [optional] +**ProvisioningConfig** | Pointer to [**ProvisioningConfig**](provisioning-config) | | [optional] +**Attributes** | **map[string]interface{}** | Service Desk integration's attributes. Validation constraints enforced by the implementation. | +**BeforeProvisioningRule** | Pointer to [**BeforeProvisioningRuleDto**](before-provisioning-rule-dto) | | [optional] + +## Methods + +### NewServiceDeskIntegrationDto + +`func NewServiceDeskIntegrationDto(name string, description string, type_ string, attributes map[string]interface{}, ) *ServiceDeskIntegrationDto` + +NewServiceDeskIntegrationDto instantiates a new ServiceDeskIntegrationDto 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 + +### NewServiceDeskIntegrationDtoWithDefaults + +`func NewServiceDeskIntegrationDtoWithDefaults() *ServiceDeskIntegrationDto` + +NewServiceDeskIntegrationDtoWithDefaults instantiates a new ServiceDeskIntegrationDto 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 + +### GetId + +`func (o *ServiceDeskIntegrationDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServiceDeskIntegrationDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServiceDeskIntegrationDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServiceDeskIntegrationDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ServiceDeskIntegrationDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServiceDeskIntegrationDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServiceDeskIntegrationDto) SetName(v string)` + +SetName sets Name field to given value. + + +### GetCreated + +`func (o *ServiceDeskIntegrationDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ServiceDeskIntegrationDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ServiceDeskIntegrationDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ServiceDeskIntegrationDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *ServiceDeskIntegrationDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ServiceDeskIntegrationDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ServiceDeskIntegrationDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ServiceDeskIntegrationDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *ServiceDeskIntegrationDto) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ServiceDeskIntegrationDto) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *ServiceDeskIntegrationDto) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### GetType + +`func (o *ServiceDeskIntegrationDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServiceDeskIntegrationDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServiceDeskIntegrationDto) SetType(v string)` + +SetType sets Type field to given value. + + +### GetOwnerRef + +`func (o *ServiceDeskIntegrationDto) GetOwnerRef() OwnerDto` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *ServiceDeskIntegrationDto) GetOwnerRefOk() (*OwnerDto, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *ServiceDeskIntegrationDto) SetOwnerRef(v OwnerDto)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *ServiceDeskIntegrationDto) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### GetClusterRef + +`func (o *ServiceDeskIntegrationDto) GetClusterRef() SourceClusterDto` + +GetClusterRef returns the ClusterRef field if non-nil, zero value otherwise. + +### GetClusterRefOk + +`func (o *ServiceDeskIntegrationDto) GetClusterRefOk() (*SourceClusterDto, bool)` + +GetClusterRefOk returns a tuple with the ClusterRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClusterRef + +`func (o *ServiceDeskIntegrationDto) SetClusterRef(v SourceClusterDto)` + +SetClusterRef sets ClusterRef field to given value. + +### HasClusterRef + +`func (o *ServiceDeskIntegrationDto) HasClusterRef() bool` + +HasClusterRef returns a boolean if a field has been set. + +### GetCluster + +`func (o *ServiceDeskIntegrationDto) GetCluster() string` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *ServiceDeskIntegrationDto) GetClusterOk() (*string, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *ServiceDeskIntegrationDto) SetCluster(v string)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *ServiceDeskIntegrationDto) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### SetClusterNil + +`func (o *ServiceDeskIntegrationDto) SetClusterNil(b bool)` + + SetClusterNil sets the value for Cluster to be an explicit nil + +### UnsetCluster +`func (o *ServiceDeskIntegrationDto) UnsetCluster()` + +UnsetCluster ensures that no value is present for Cluster, not even an explicit nil +### GetManagedSources + +`func (o *ServiceDeskIntegrationDto) GetManagedSources() []string` + +GetManagedSources returns the ManagedSources field if non-nil, zero value otherwise. + +### GetManagedSourcesOk + +`func (o *ServiceDeskIntegrationDto) GetManagedSourcesOk() (*[]string, bool)` + +GetManagedSourcesOk returns a tuple with the ManagedSources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagedSources + +`func (o *ServiceDeskIntegrationDto) SetManagedSources(v []string)` + +SetManagedSources sets ManagedSources field to given value. + +### HasManagedSources + +`func (o *ServiceDeskIntegrationDto) HasManagedSources() bool` + +HasManagedSources returns a boolean if a field has been set. + +### GetProvisioningConfig + +`func (o *ServiceDeskIntegrationDto) GetProvisioningConfig() ProvisioningConfig` + +GetProvisioningConfig returns the ProvisioningConfig field if non-nil, zero value otherwise. + +### GetProvisioningConfigOk + +`func (o *ServiceDeskIntegrationDto) GetProvisioningConfigOk() (*ProvisioningConfig, bool)` + +GetProvisioningConfigOk returns a tuple with the ProvisioningConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningConfig + +`func (o *ServiceDeskIntegrationDto) SetProvisioningConfig(v ProvisioningConfig)` + +SetProvisioningConfig sets ProvisioningConfig field to given value. + +### HasProvisioningConfig + +`func (o *ServiceDeskIntegrationDto) HasProvisioningConfig() bool` + +HasProvisioningConfig returns a boolean if a field has been set. + +### GetAttributes + +`func (o *ServiceDeskIntegrationDto) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ServiceDeskIntegrationDto) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ServiceDeskIntegrationDto) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetBeforeProvisioningRule + +`func (o *ServiceDeskIntegrationDto) GetBeforeProvisioningRule() BeforeProvisioningRuleDto` + +GetBeforeProvisioningRule returns the BeforeProvisioningRule field if non-nil, zero value otherwise. + +### GetBeforeProvisioningRuleOk + +`func (o *ServiceDeskIntegrationDto) GetBeforeProvisioningRuleOk() (*BeforeProvisioningRuleDto, bool)` + +GetBeforeProvisioningRuleOk returns a tuple with the BeforeProvisioningRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBeforeProvisioningRule + +`func (o *ServiceDeskIntegrationDto) SetBeforeProvisioningRule(v BeforeProvisioningRuleDto)` + +SetBeforeProvisioningRule sets BeforeProvisioningRule field to given value. + +### HasBeforeProvisioningRule + +`func (o *ServiceDeskIntegrationDto) HasBeforeProvisioningRule() bool` + +HasBeforeProvisioningRule returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ServiceDeskIntegrationTemplateDto.md b/docs/tools/sdk/go/Reference/V3/Models/ServiceDeskIntegrationTemplateDto.md new file mode 100644 index 000000000..d0c15b972 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ServiceDeskIntegrationTemplateDto.md @@ -0,0 +1,210 @@ +--- +id: service-desk-integration-template-dto +title: ServiceDeskIntegrationTemplateDto +pagination_label: ServiceDeskIntegrationTemplateDto +sidebar_label: ServiceDeskIntegrationTemplateDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskIntegrationTemplateDto', 'ServiceDeskIntegrationTemplateDto'] +slug: /tools/sdk/go/v3/models/service-desk-integration-template-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateDto', 'ServiceDeskIntegrationTemplateDto'] +--- + +# ServiceDeskIntegrationTemplateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | System-generated unique ID of the Object | [optional] [readonly] +**Name** | **NullableString** | Name of the Object | +**Created** | Pointer to **SailPointTime** | Creation date of the Object | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | Last modification date of the Object | [optional] [readonly] +**Type** | **string** | The 'type' property specifies the type of the Service Desk integration template. | [default to "Web Service SDIM"] +**Attributes** | **map[string]interface{}** | The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. | +**ProvisioningConfig** | [**ProvisioningConfig**](provisioning-config) | | + +## Methods + +### NewServiceDeskIntegrationTemplateDto + +`func NewServiceDeskIntegrationTemplateDto(name NullableString, type_ string, attributes map[string]interface{}, provisioningConfig ProvisioningConfig, ) *ServiceDeskIntegrationTemplateDto` + +NewServiceDeskIntegrationTemplateDto instantiates a new ServiceDeskIntegrationTemplateDto 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 + +### NewServiceDeskIntegrationTemplateDtoWithDefaults + +`func NewServiceDeskIntegrationTemplateDtoWithDefaults() *ServiceDeskIntegrationTemplateDto` + +NewServiceDeskIntegrationTemplateDtoWithDefaults instantiates a new ServiceDeskIntegrationTemplateDto 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 + +### GetId + +`func (o *ServiceDeskIntegrationTemplateDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServiceDeskIntegrationTemplateDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServiceDeskIntegrationTemplateDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ServiceDeskIntegrationTemplateDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServiceDeskIntegrationTemplateDto) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *ServiceDeskIntegrationTemplateDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ServiceDeskIntegrationTemplateDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCreated + +`func (o *ServiceDeskIntegrationTemplateDto) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *ServiceDeskIntegrationTemplateDto) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *ServiceDeskIntegrationTemplateDto) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *ServiceDeskIntegrationTemplateDto) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *ServiceDeskIntegrationTemplateDto) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *ServiceDeskIntegrationTemplateDto) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetType + +`func (o *ServiceDeskIntegrationTemplateDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServiceDeskIntegrationTemplateDto) SetType(v string)` + +SetType sets Type field to given value. + + +### GetAttributes + +`func (o *ServiceDeskIntegrationTemplateDto) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *ServiceDeskIntegrationTemplateDto) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### GetProvisioningConfig + +`func (o *ServiceDeskIntegrationTemplateDto) GetProvisioningConfig() ProvisioningConfig` + +GetProvisioningConfig returns the ProvisioningConfig field if non-nil, zero value otherwise. + +### GetProvisioningConfigOk + +`func (o *ServiceDeskIntegrationTemplateDto) GetProvisioningConfigOk() (*ProvisioningConfig, bool)` + +GetProvisioningConfigOk returns a tuple with the ProvisioningConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningConfig + +`func (o *ServiceDeskIntegrationTemplateDto) SetProvisioningConfig(v ProvisioningConfig)` + +SetProvisioningConfig sets ProvisioningConfig field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ServiceDeskIntegrationTemplateType.md b/docs/tools/sdk/go/Reference/V3/Models/ServiceDeskIntegrationTemplateType.md new file mode 100644 index 000000000..599dbf1c6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ServiceDeskIntegrationTemplateType.md @@ -0,0 +1,106 @@ +--- +id: service-desk-integration-template-type +title: ServiceDeskIntegrationTemplateType +pagination_label: ServiceDeskIntegrationTemplateType +sidebar_label: ServiceDeskIntegrationTemplateType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskIntegrationTemplateType', 'ServiceDeskIntegrationTemplateType'] +slug: /tools/sdk/go/v3/models/service-desk-integration-template-type +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateType', 'ServiceDeskIntegrationTemplateType'] +--- + +# ServiceDeskIntegrationTemplateType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | This is the name of the type. | [optional] +**Type** | **string** | This is the type value for the type. | +**ScriptName** | **string** | This is the scriptName attribute value for the type. | + +## Methods + +### NewServiceDeskIntegrationTemplateType + +`func NewServiceDeskIntegrationTemplateType(type_ string, scriptName string, ) *ServiceDeskIntegrationTemplateType` + +NewServiceDeskIntegrationTemplateType instantiates a new ServiceDeskIntegrationTemplateType 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 + +### NewServiceDeskIntegrationTemplateTypeWithDefaults + +`func NewServiceDeskIntegrationTemplateTypeWithDefaults() *ServiceDeskIntegrationTemplateType` + +NewServiceDeskIntegrationTemplateTypeWithDefaults instantiates a new ServiceDeskIntegrationTemplateType 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 + +### GetName + +`func (o *ServiceDeskIntegrationTemplateType) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServiceDeskIntegrationTemplateType) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServiceDeskIntegrationTemplateType) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ServiceDeskIntegrationTemplateType) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *ServiceDeskIntegrationTemplateType) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServiceDeskIntegrationTemplateType) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServiceDeskIntegrationTemplateType) SetType(v string)` + +SetType sets Type field to given value. + + +### GetScriptName + +`func (o *ServiceDeskIntegrationTemplateType) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *ServiceDeskIntegrationTemplateType) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *ServiceDeskIntegrationTemplateType) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ServiceDeskSource.md b/docs/tools/sdk/go/Reference/V3/Models/ServiceDeskSource.md new file mode 100644 index 000000000..ff7b83682 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ServiceDeskSource.md @@ -0,0 +1,116 @@ +--- +id: service-desk-source +title: ServiceDeskSource +pagination_label: ServiceDeskSource +sidebar_label: ServiceDeskSource +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceDeskSource', 'ServiceDeskSource'] +slug: /tools/sdk/go/v3/models/service-desk-source +tags: ['SDK', 'Software Development Kit', 'ServiceDeskSource', 'ServiceDeskSource'] +--- + +# ServiceDeskSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type of source for service desk integration template. | [optional] +**Id** | Pointer to **string** | ID of source for service desk integration template. | [optional] +**Name** | Pointer to **string** | Human-readable name of source for service desk integration template. | [optional] + +## Methods + +### NewServiceDeskSource + +`func NewServiceDeskSource() *ServiceDeskSource` + +NewServiceDeskSource instantiates a new ServiceDeskSource 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 + +### NewServiceDeskSourceWithDefaults + +`func NewServiceDeskSourceWithDefaults() *ServiceDeskSource` + +NewServiceDeskSourceWithDefaults instantiates a new ServiceDeskSource 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 + +### GetType + +`func (o *ServiceDeskSource) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServiceDeskSource) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServiceDeskSource) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ServiceDeskSource) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ServiceDeskSource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ServiceDeskSource) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ServiceDeskSource) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ServiceDeskSource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ServiceDeskSource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ServiceDeskSource) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ServiceDeskSource) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ServiceDeskSource) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ServiceProviderConfiguration.md b/docs/tools/sdk/go/Reference/V3/Models/ServiceProviderConfiguration.md new file mode 100644 index 000000000..67c6b849b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ServiceProviderConfiguration.md @@ -0,0 +1,142 @@ +--- +id: service-provider-configuration +title: ServiceProviderConfiguration +pagination_label: ServiceProviderConfiguration +sidebar_label: ServiceProviderConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceProviderConfiguration', 'ServiceProviderConfiguration'] +slug: /tools/sdk/go/v3/models/service-provider-configuration +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfiguration', 'ServiceProviderConfiguration'] +--- + +# ServiceProviderConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **bool** | This determines whether or not the SAML authentication flow is enabled for an org | [optional] [default to false] +**BypassIdp** | Pointer to **bool** | This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. | [optional] [default to false] +**SamlConfigurationValid** | Pointer to **bool** | This indicates whether or not the SAML configuration is valid. | [optional] [default to false] +**FederationProtocolDetails** | Pointer to [**[]ServiceProviderConfigurationFederationProtocolDetailsInner**](service-provider-configuration-federation-protocol-details-inner) | A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer's identity provider and a customer's SailPoint instance (i.e., the service provider). | [optional] + +## Methods + +### NewServiceProviderConfiguration + +`func NewServiceProviderConfiguration() *ServiceProviderConfiguration` + +NewServiceProviderConfiguration instantiates a new ServiceProviderConfiguration 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 + +### NewServiceProviderConfigurationWithDefaults + +`func NewServiceProviderConfigurationWithDefaults() *ServiceProviderConfiguration` + +NewServiceProviderConfigurationWithDefaults instantiates a new ServiceProviderConfiguration 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 + +### GetEnabled + +`func (o *ServiceProviderConfiguration) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *ServiceProviderConfiguration) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *ServiceProviderConfiguration) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *ServiceProviderConfiguration) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetBypassIdp + +`func (o *ServiceProviderConfiguration) GetBypassIdp() bool` + +GetBypassIdp returns the BypassIdp field if non-nil, zero value otherwise. + +### GetBypassIdpOk + +`func (o *ServiceProviderConfiguration) GetBypassIdpOk() (*bool, bool)` + +GetBypassIdpOk returns a tuple with the BypassIdp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBypassIdp + +`func (o *ServiceProviderConfiguration) SetBypassIdp(v bool)` + +SetBypassIdp sets BypassIdp field to given value. + +### HasBypassIdp + +`func (o *ServiceProviderConfiguration) HasBypassIdp() bool` + +HasBypassIdp returns a boolean if a field has been set. + +### GetSamlConfigurationValid + +`func (o *ServiceProviderConfiguration) GetSamlConfigurationValid() bool` + +GetSamlConfigurationValid returns the SamlConfigurationValid field if non-nil, zero value otherwise. + +### GetSamlConfigurationValidOk + +`func (o *ServiceProviderConfiguration) GetSamlConfigurationValidOk() (*bool, bool)` + +GetSamlConfigurationValidOk returns a tuple with the SamlConfigurationValid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSamlConfigurationValid + +`func (o *ServiceProviderConfiguration) SetSamlConfigurationValid(v bool)` + +SetSamlConfigurationValid sets SamlConfigurationValid field to given value. + +### HasSamlConfigurationValid + +`func (o *ServiceProviderConfiguration) HasSamlConfigurationValid() bool` + +HasSamlConfigurationValid returns a boolean if a field has been set. + +### GetFederationProtocolDetails + +`func (o *ServiceProviderConfiguration) GetFederationProtocolDetails() []ServiceProviderConfigurationFederationProtocolDetailsInner` + +GetFederationProtocolDetails returns the FederationProtocolDetails field if non-nil, zero value otherwise. + +### GetFederationProtocolDetailsOk + +`func (o *ServiceProviderConfiguration) GetFederationProtocolDetailsOk() (*[]ServiceProviderConfigurationFederationProtocolDetailsInner, bool)` + +GetFederationProtocolDetailsOk returns a tuple with the FederationProtocolDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFederationProtocolDetails + +`func (o *ServiceProviderConfiguration) SetFederationProtocolDetails(v []ServiceProviderConfigurationFederationProtocolDetailsInner)` + +SetFederationProtocolDetails sets FederationProtocolDetails field to given value. + +### HasFederationProtocolDetails + +`func (o *ServiceProviderConfiguration) HasFederationProtocolDetails() bool` + +HasFederationProtocolDetails returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/go/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md new file mode 100644 index 000000000..3ba7ee602 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -0,0 +1,470 @@ +--- +id: service-provider-configuration-federation-protocol-details-inner +title: ServiceProviderConfigurationFederationProtocolDetailsInner +pagination_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'ServiceProviderConfigurationFederationProtocolDetailsInner'] +slug: /tools/sdk/go/v3/models/service-provider-configuration-federation-protocol-details-inner +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'ServiceProviderConfigurationFederationProtocolDetailsInner'] +--- + +# ServiceProviderConfigurationFederationProtocolDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | Pointer to **string** | Federation protocol role | [optional] +**EntityId** | Pointer to **string** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Binding** | Pointer to **string** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**AuthnContext** | Pointer to **string** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**LogoutUrl** | Pointer to **string** | The IDP logout URL. Used with IDP configurations. | [optional] +**IncludeAuthnContext** | Pointer to **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to false] +**NameId** | Pointer to **string** | The name id format to use. Used with IDP configurations. | [optional] +**JitConfiguration** | Pointer to [**JITConfiguration**](jit-configuration) | | [optional] +**Cert** | Pointer to **string** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**LoginUrlPost** | Pointer to **string** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**LoginUrlRedirect** | Pointer to **string** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**MappingAttribute** | **string** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | +**CertificateExpirationDate** | Pointer to **string** | The expiration date extracted from the certificate. | [optional] +**CertificateName** | Pointer to **string** | The name extracted from the certificate. | [optional] +**Alias** | Pointer to **string** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**CallbackUrl** | **string** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | +**LegacyAcsUrl** | Pointer to **string** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] + +## Methods + +### NewServiceProviderConfigurationFederationProtocolDetailsInner + +`func NewServiceProviderConfigurationFederationProtocolDetailsInner(mappingAttribute string, callbackUrl string, ) *ServiceProviderConfigurationFederationProtocolDetailsInner` + +NewServiceProviderConfigurationFederationProtocolDetailsInner instantiates a new ServiceProviderConfigurationFederationProtocolDetailsInner 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 + +### NewServiceProviderConfigurationFederationProtocolDetailsInnerWithDefaults + +`func NewServiceProviderConfigurationFederationProtocolDetailsInnerWithDefaults() *ServiceProviderConfigurationFederationProtocolDetailsInner` + +NewServiceProviderConfigurationFederationProtocolDetailsInnerWithDefaults instantiates a new ServiceProviderConfigurationFederationProtocolDetailsInner 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 + +### GetRole + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetRole() string` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetRoleOk() (*string, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetRole(v string)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetEntityId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetEntityId() string` + +GetEntityId returns the EntityId field if non-nil, zero value otherwise. + +### GetEntityIdOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetEntityIdOk() (*string, bool)` + +GetEntityIdOk returns a tuple with the EntityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntityId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetEntityId(v string)` + +SetEntityId sets EntityId field to given value. + +### HasEntityId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasEntityId() bool` + +HasEntityId returns a boolean if a field has been set. + +### GetBinding + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetBinding() string` + +GetBinding returns the Binding field if non-nil, zero value otherwise. + +### GetBindingOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetBindingOk() (*string, bool)` + +GetBindingOk returns a tuple with the Binding field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBinding + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetBinding(v string)` + +SetBinding sets Binding field to given value. + +### HasBinding + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasBinding() bool` + +HasBinding returns a boolean if a field has been set. + +### GetAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetAuthnContext() string` + +GetAuthnContext returns the AuthnContext field if non-nil, zero value otherwise. + +### GetAuthnContextOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetAuthnContextOk() (*string, bool)` + +GetAuthnContextOk returns a tuple with the AuthnContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetAuthnContext(v string)` + +SetAuthnContext sets AuthnContext field to given value. + +### HasAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasAuthnContext() bool` + +HasAuthnContext returns a boolean if a field has been set. + +### GetLogoutUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLogoutUrl() string` + +GetLogoutUrl returns the LogoutUrl field if non-nil, zero value otherwise. + +### GetLogoutUrlOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLogoutUrlOk() (*string, bool)` + +GetLogoutUrlOk returns a tuple with the LogoutUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLogoutUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetLogoutUrl(v string)` + +SetLogoutUrl sets LogoutUrl field to given value. + +### HasLogoutUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasLogoutUrl() bool` + +HasLogoutUrl returns a boolean if a field has been set. + +### GetIncludeAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetIncludeAuthnContext() bool` + +GetIncludeAuthnContext returns the IncludeAuthnContext field if non-nil, zero value otherwise. + +### GetIncludeAuthnContextOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetIncludeAuthnContextOk() (*bool, bool)` + +GetIncludeAuthnContextOk returns a tuple with the IncludeAuthnContext field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetIncludeAuthnContext(v bool)` + +SetIncludeAuthnContext sets IncludeAuthnContext field to given value. + +### HasIncludeAuthnContext + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasIncludeAuthnContext() bool` + +HasIncludeAuthnContext returns a boolean if a field has been set. + +### GetNameId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetNameId() string` + +GetNameId returns the NameId field if non-nil, zero value otherwise. + +### GetNameIdOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetNameIdOk() (*string, bool)` + +GetNameIdOk returns a tuple with the NameId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNameId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetNameId(v string)` + +SetNameId sets NameId field to given value. + +### HasNameId + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasNameId() bool` + +HasNameId returns a boolean if a field has been set. + +### GetJitConfiguration + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetJitConfiguration() JITConfiguration` + +GetJitConfiguration returns the JitConfiguration field if non-nil, zero value otherwise. + +### GetJitConfigurationOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetJitConfigurationOk() (*JITConfiguration, bool)` + +GetJitConfigurationOk returns a tuple with the JitConfiguration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJitConfiguration + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetJitConfiguration(v JITConfiguration)` + +SetJitConfiguration sets JitConfiguration field to given value. + +### HasJitConfiguration + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasJitConfiguration() bool` + +HasJitConfiguration returns a boolean if a field has been set. + +### GetCert + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCert() string` + +GetCert returns the Cert field if non-nil, zero value otherwise. + +### GetCertOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCertOk() (*string, bool)` + +GetCertOk returns a tuple with the Cert field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCert + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetCert(v string)` + +SetCert sets Cert field to given value. + +### HasCert + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasCert() bool` + +HasCert returns a boolean if a field has been set. + +### GetLoginUrlPost + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLoginUrlPost() string` + +GetLoginUrlPost returns the LoginUrlPost field if non-nil, zero value otherwise. + +### GetLoginUrlPostOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLoginUrlPostOk() (*string, bool)` + +GetLoginUrlPostOk returns a tuple with the LoginUrlPost field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginUrlPost + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetLoginUrlPost(v string)` + +SetLoginUrlPost sets LoginUrlPost field to given value. + +### HasLoginUrlPost + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasLoginUrlPost() bool` + +HasLoginUrlPost returns a boolean if a field has been set. + +### GetLoginUrlRedirect + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLoginUrlRedirect() string` + +GetLoginUrlRedirect returns the LoginUrlRedirect field if non-nil, zero value otherwise. + +### GetLoginUrlRedirectOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLoginUrlRedirectOk() (*string, bool)` + +GetLoginUrlRedirectOk returns a tuple with the LoginUrlRedirect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLoginUrlRedirect + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetLoginUrlRedirect(v string)` + +SetLoginUrlRedirect sets LoginUrlRedirect field to given value. + +### HasLoginUrlRedirect + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasLoginUrlRedirect() bool` + +HasLoginUrlRedirect returns a boolean if a field has been set. + +### GetMappingAttribute + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetMappingAttribute() string` + +GetMappingAttribute returns the MappingAttribute field if non-nil, zero value otherwise. + +### GetMappingAttributeOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetMappingAttributeOk() (*string, bool)` + +GetMappingAttributeOk returns a tuple with the MappingAttribute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMappingAttribute + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetMappingAttribute(v string)` + +SetMappingAttribute sets MappingAttribute field to given value. + + +### GetCertificateExpirationDate + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCertificateExpirationDate() string` + +GetCertificateExpirationDate returns the CertificateExpirationDate field if non-nil, zero value otherwise. + +### GetCertificateExpirationDateOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCertificateExpirationDateOk() (*string, bool)` + +GetCertificateExpirationDateOk returns a tuple with the CertificateExpirationDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificateExpirationDate + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetCertificateExpirationDate(v string)` + +SetCertificateExpirationDate sets CertificateExpirationDate field to given value. + +### HasCertificateExpirationDate + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasCertificateExpirationDate() bool` + +HasCertificateExpirationDate returns a boolean if a field has been set. + +### GetCertificateName + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCertificateName() string` + +GetCertificateName returns the CertificateName field if non-nil, zero value otherwise. + +### GetCertificateNameOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCertificateNameOk() (*string, bool)` + +GetCertificateNameOk returns a tuple with the CertificateName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCertificateName + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetCertificateName(v string)` + +SetCertificateName sets CertificateName field to given value. + +### HasCertificateName + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasCertificateName() bool` + +HasCertificateName returns a boolean if a field has been set. + +### GetAlias + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + +### GetCallbackUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCallbackUrl() string` + +GetCallbackUrl returns the CallbackUrl field if non-nil, zero value otherwise. + +### GetCallbackUrlOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetCallbackUrlOk() (*string, bool)` + +GetCallbackUrlOk returns a tuple with the CallbackUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCallbackUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetCallbackUrl(v string)` + +SetCallbackUrl sets CallbackUrl field to given value. + + +### GetLegacyAcsUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLegacyAcsUrl() string` + +GetLegacyAcsUrl returns the LegacyAcsUrl field if non-nil, zero value otherwise. + +### GetLegacyAcsUrlOk + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) GetLegacyAcsUrlOk() (*string, bool)` + +GetLegacyAcsUrlOk returns a tuple with the LegacyAcsUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyAcsUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) SetLegacyAcsUrl(v string)` + +SetLegacyAcsUrl sets LegacyAcsUrl field to given value. + +### HasLegacyAcsUrl + +`func (o *ServiceProviderConfigurationFederationProtocolDetailsInner) HasLegacyAcsUrl() bool` + +HasLegacyAcsUrl returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SessionConfiguration.md b/docs/tools/sdk/go/Reference/V3/Models/SessionConfiguration.md new file mode 100644 index 000000000..a8aafb96b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SessionConfiguration.md @@ -0,0 +1,116 @@ +--- +id: session-configuration +title: SessionConfiguration +pagination_label: SessionConfiguration +sidebar_label: SessionConfiguration +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SessionConfiguration', 'SessionConfiguration'] +slug: /tools/sdk/go/v3/models/session-configuration +tags: ['SDK', 'Software Development Kit', 'SessionConfiguration', 'SessionConfiguration'] +--- + +# SessionConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxIdleTime** | Pointer to **int32** | The maximum time in minutes a session can be idle. | [optional] +**RememberMe** | Pointer to **bool** | Denotes if 'remember me' is enabled. | [optional] [default to false] +**MaxSessionTime** | Pointer to **int32** | The maximum allowable session time in minutes. | [optional] + +## Methods + +### NewSessionConfiguration + +`func NewSessionConfiguration() *SessionConfiguration` + +NewSessionConfiguration instantiates a new SessionConfiguration 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 + +### NewSessionConfigurationWithDefaults + +`func NewSessionConfigurationWithDefaults() *SessionConfiguration` + +NewSessionConfigurationWithDefaults instantiates a new SessionConfiguration 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 + +### GetMaxIdleTime + +`func (o *SessionConfiguration) GetMaxIdleTime() int32` + +GetMaxIdleTime returns the MaxIdleTime field if non-nil, zero value otherwise. + +### GetMaxIdleTimeOk + +`func (o *SessionConfiguration) GetMaxIdleTimeOk() (*int32, bool)` + +GetMaxIdleTimeOk returns a tuple with the MaxIdleTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxIdleTime + +`func (o *SessionConfiguration) SetMaxIdleTime(v int32)` + +SetMaxIdleTime sets MaxIdleTime field to given value. + +### HasMaxIdleTime + +`func (o *SessionConfiguration) HasMaxIdleTime() bool` + +HasMaxIdleTime returns a boolean if a field has been set. + +### GetRememberMe + +`func (o *SessionConfiguration) GetRememberMe() bool` + +GetRememberMe returns the RememberMe field if non-nil, zero value otherwise. + +### GetRememberMeOk + +`func (o *SessionConfiguration) GetRememberMeOk() (*bool, bool)` + +GetRememberMeOk returns a tuple with the RememberMe field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRememberMe + +`func (o *SessionConfiguration) SetRememberMe(v bool)` + +SetRememberMe sets RememberMe field to given value. + +### HasRememberMe + +`func (o *SessionConfiguration) HasRememberMe() bool` + +HasRememberMe returns a boolean if a field has been set. + +### GetMaxSessionTime + +`func (o *SessionConfiguration) GetMaxSessionTime() int32` + +GetMaxSessionTime returns the MaxSessionTime field if non-nil, zero value otherwise. + +### GetMaxSessionTimeOk + +`func (o *SessionConfiguration) GetMaxSessionTimeOk() (*int32, bool)` + +GetMaxSessionTimeOk returns a tuple with the MaxSessionTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxSessionTime + +`func (o *SessionConfiguration) SetMaxSessionTime(v int32)` + +SetMaxSessionTime sets MaxSessionTime field to given value. + +### HasMaxSessionTime + +`func (o *SessionConfiguration) HasMaxSessionTime() bool` + +HasMaxSessionTime returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SetLifecycleState200Response.md b/docs/tools/sdk/go/Reference/V3/Models/SetLifecycleState200Response.md new file mode 100644 index 000000000..48696b7ba --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SetLifecycleState200Response.md @@ -0,0 +1,64 @@ +--- +id: set-lifecycle-state200-response +title: SetLifecycleState200Response +pagination_label: SetLifecycleState200Response +sidebar_label: SetLifecycleState200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SetLifecycleState200Response', 'SetLifecycleState200Response'] +slug: /tools/sdk/go/v3/models/set-lifecycle-state200-response +tags: ['SDK', 'Software Development Kit', 'SetLifecycleState200Response', 'SetLifecycleState200Response'] +--- + +# SetLifecycleState200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountActivityId** | Pointer to **string** | ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/v3/get-account-activity/). The response will contain relevant information about the IdentityRequest, such as its status. | [optional] + +## Methods + +### NewSetLifecycleState200Response + +`func NewSetLifecycleState200Response() *SetLifecycleState200Response` + +NewSetLifecycleState200Response instantiates a new SetLifecycleState200Response 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 + +### NewSetLifecycleState200ResponseWithDefaults + +`func NewSetLifecycleState200ResponseWithDefaults() *SetLifecycleState200Response` + +NewSetLifecycleState200ResponseWithDefaults instantiates a new SetLifecycleState200Response 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 + +### GetAccountActivityId + +`func (o *SetLifecycleState200Response) GetAccountActivityId() string` + +GetAccountActivityId returns the AccountActivityId field if non-nil, zero value otherwise. + +### GetAccountActivityIdOk + +`func (o *SetLifecycleState200Response) GetAccountActivityIdOk() (*string, bool)` + +GetAccountActivityIdOk returns a tuple with the AccountActivityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountActivityId + +`func (o *SetLifecycleState200Response) SetAccountActivityId(v string)` + +SetAccountActivityId sets AccountActivityId field to given value. + +### HasAccountActivityId + +`func (o *SetLifecycleState200Response) HasAccountActivityId() bool` + +HasAccountActivityId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SetLifecycleStateRequest.md b/docs/tools/sdk/go/Reference/V3/Models/SetLifecycleStateRequest.md new file mode 100644 index 000000000..f09145839 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SetLifecycleStateRequest.md @@ -0,0 +1,64 @@ +--- +id: set-lifecycle-state-request +title: SetLifecycleStateRequest +pagination_label: SetLifecycleStateRequest +sidebar_label: SetLifecycleStateRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SetLifecycleStateRequest', 'SetLifecycleStateRequest'] +slug: /tools/sdk/go/v3/models/set-lifecycle-state-request +tags: ['SDK', 'Software Development Kit', 'SetLifecycleStateRequest', 'SetLifecycleStateRequest'] +--- + +# SetLifecycleStateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LifecycleStateId** | Pointer to **string** | ID of the lifecycle state to set. | [optional] + +## Methods + +### NewSetLifecycleStateRequest + +`func NewSetLifecycleStateRequest() *SetLifecycleStateRequest` + +NewSetLifecycleStateRequest instantiates a new SetLifecycleStateRequest 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 + +### NewSetLifecycleStateRequestWithDefaults + +`func NewSetLifecycleStateRequestWithDefaults() *SetLifecycleStateRequest` + +NewSetLifecycleStateRequestWithDefaults instantiates a new SetLifecycleStateRequest 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 + +### GetLifecycleStateId + +`func (o *SetLifecycleStateRequest) GetLifecycleStateId() string` + +GetLifecycleStateId returns the LifecycleStateId field if non-nil, zero value otherwise. + +### GetLifecycleStateIdOk + +`func (o *SetLifecycleStateRequest) GetLifecycleStateIdOk() (*string, bool)` + +GetLifecycleStateIdOk returns a tuple with the LifecycleStateId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLifecycleStateId + +`func (o *SetLifecycleStateRequest) SetLifecycleStateId(v string)` + +SetLifecycleStateId sets LifecycleStateId field to given value. + +### HasLifecycleStateId + +`func (o *SetLifecycleStateRequest) HasLifecycleStateId() bool` + +HasLifecycleStateId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SlimCampaign.md b/docs/tools/sdk/go/Reference/V3/Models/SlimCampaign.md new file mode 100644 index 000000000..aea501cd6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SlimCampaign.md @@ -0,0 +1,397 @@ +--- +id: slim-campaign +title: SlimCampaign +pagination_label: SlimCampaign +sidebar_label: SlimCampaign +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SlimCampaign', 'SlimCampaign'] +slug: /tools/sdk/go/v3/models/slim-campaign +tags: ['SDK', 'Software Development Kit', 'SlimCampaign', 'SlimCampaign'] +--- + +# SlimCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the campaign | [optional] [readonly] +**Name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Description** | **NullableString** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | +**Deadline** | Pointer to **SailPointTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **string** | The type of campaign. Could be extended in the future. | +**EmailNotificationEnabled** | Pointer to **bool** | Enables email notification for this campaign | [optional] [default to false] +**AutoRevokeAllowed** | Pointer to **bool** | Allows auto revoke for this campaign | [optional] [default to false] +**RecommendationsEnabled** | Pointer to **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to false] +**Status** | Pointer to **string** | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **SailPointTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] + +## Methods + +### NewSlimCampaign + +`func NewSlimCampaign(name string, description NullableString, type_ string, ) *SlimCampaign` + +NewSlimCampaign instantiates a new SlimCampaign 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 + +### NewSlimCampaignWithDefaults + +`func NewSlimCampaignWithDefaults() *SlimCampaign` + +NewSlimCampaignWithDefaults instantiates a new SlimCampaign 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 + +### GetId + +`func (o *SlimCampaign) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SlimCampaign) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SlimCampaign) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SlimCampaign) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SlimCampaign) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SlimCampaign) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SlimCampaign) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *SlimCampaign) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SlimCampaign) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SlimCampaign) SetDescription(v string)` + +SetDescription sets Description field to given value. + + +### SetDescriptionNil + +`func (o *SlimCampaign) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *SlimCampaign) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetDeadline + +`func (o *SlimCampaign) GetDeadline() SailPointTime` + +GetDeadline returns the Deadline field if non-nil, zero value otherwise. + +### GetDeadlineOk + +`func (o *SlimCampaign) GetDeadlineOk() (*SailPointTime, bool)` + +GetDeadlineOk returns a tuple with the Deadline field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeadline + +`func (o *SlimCampaign) SetDeadline(v SailPointTime)` + +SetDeadline sets Deadline field to given value. + +### HasDeadline + +`func (o *SlimCampaign) HasDeadline() bool` + +HasDeadline returns a boolean if a field has been set. + +### GetType + +`func (o *SlimCampaign) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SlimCampaign) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SlimCampaign) SetType(v string)` + +SetType sets Type field to given value. + + +### GetEmailNotificationEnabled + +`func (o *SlimCampaign) GetEmailNotificationEnabled() bool` + +GetEmailNotificationEnabled returns the EmailNotificationEnabled field if non-nil, zero value otherwise. + +### GetEmailNotificationEnabledOk + +`func (o *SlimCampaign) GetEmailNotificationEnabledOk() (*bool, bool)` + +GetEmailNotificationEnabledOk returns a tuple with the EmailNotificationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailNotificationEnabled + +`func (o *SlimCampaign) SetEmailNotificationEnabled(v bool)` + +SetEmailNotificationEnabled sets EmailNotificationEnabled field to given value. + +### HasEmailNotificationEnabled + +`func (o *SlimCampaign) HasEmailNotificationEnabled() bool` + +HasEmailNotificationEnabled returns a boolean if a field has been set. + +### GetAutoRevokeAllowed + +`func (o *SlimCampaign) GetAutoRevokeAllowed() bool` + +GetAutoRevokeAllowed returns the AutoRevokeAllowed field if non-nil, zero value otherwise. + +### GetAutoRevokeAllowedOk + +`func (o *SlimCampaign) GetAutoRevokeAllowedOk() (*bool, bool)` + +GetAutoRevokeAllowedOk returns a tuple with the AutoRevokeAllowed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutoRevokeAllowed + +`func (o *SlimCampaign) SetAutoRevokeAllowed(v bool)` + +SetAutoRevokeAllowed sets AutoRevokeAllowed field to given value. + +### HasAutoRevokeAllowed + +`func (o *SlimCampaign) HasAutoRevokeAllowed() bool` + +HasAutoRevokeAllowed returns a boolean if a field has been set. + +### GetRecommendationsEnabled + +`func (o *SlimCampaign) GetRecommendationsEnabled() bool` + +GetRecommendationsEnabled returns the RecommendationsEnabled field if non-nil, zero value otherwise. + +### GetRecommendationsEnabledOk + +`func (o *SlimCampaign) GetRecommendationsEnabledOk() (*bool, bool)` + +GetRecommendationsEnabledOk returns a tuple with the RecommendationsEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendationsEnabled + +`func (o *SlimCampaign) SetRecommendationsEnabled(v bool)` + +SetRecommendationsEnabled sets RecommendationsEnabled field to given value. + +### HasRecommendationsEnabled + +`func (o *SlimCampaign) HasRecommendationsEnabled() bool` + +HasRecommendationsEnabled returns a boolean if a field has been set. + +### GetStatus + +`func (o *SlimCampaign) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SlimCampaign) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SlimCampaign) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SlimCampaign) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetCorrelatedStatus + +`func (o *SlimCampaign) GetCorrelatedStatus() string` + +GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise. + +### GetCorrelatedStatusOk + +`func (o *SlimCampaign) GetCorrelatedStatusOk() (*string, bool)` + +GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelatedStatus + +`func (o *SlimCampaign) SetCorrelatedStatus(v string)` + +SetCorrelatedStatus sets CorrelatedStatus field to given value. + +### HasCorrelatedStatus + +`func (o *SlimCampaign) HasCorrelatedStatus() bool` + +HasCorrelatedStatus returns a boolean if a field has been set. + +### GetCreated + +`func (o *SlimCampaign) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SlimCampaign) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SlimCampaign) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SlimCampaign) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetTotalCertifications + +`func (o *SlimCampaign) GetTotalCertifications() int32` + +GetTotalCertifications returns the TotalCertifications field if non-nil, zero value otherwise. + +### GetTotalCertificationsOk + +`func (o *SlimCampaign) GetTotalCertificationsOk() (*int32, bool)` + +GetTotalCertificationsOk returns a tuple with the TotalCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCertifications + +`func (o *SlimCampaign) SetTotalCertifications(v int32)` + +SetTotalCertifications sets TotalCertifications field to given value. + +### HasTotalCertifications + +`func (o *SlimCampaign) HasTotalCertifications() bool` + +HasTotalCertifications returns a boolean if a field has been set. + +### GetCompletedCertifications + +`func (o *SlimCampaign) GetCompletedCertifications() int32` + +GetCompletedCertifications returns the CompletedCertifications field if non-nil, zero value otherwise. + +### GetCompletedCertificationsOk + +`func (o *SlimCampaign) GetCompletedCertificationsOk() (*int32, bool)` + +GetCompletedCertificationsOk returns a tuple with the CompletedCertifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletedCertifications + +`func (o *SlimCampaign) SetCompletedCertifications(v int32)` + +SetCompletedCertifications sets CompletedCertifications field to given value. + +### HasCompletedCertifications + +`func (o *SlimCampaign) HasCompletedCertifications() bool` + +HasCompletedCertifications returns a boolean if a field has been set. + +### GetAlerts + +`func (o *SlimCampaign) GetAlerts() []CampaignAlert` + +GetAlerts returns the Alerts field if non-nil, zero value otherwise. + +### GetAlertsOk + +`func (o *SlimCampaign) GetAlertsOk() (*[]CampaignAlert, bool)` + +GetAlertsOk returns a tuple with the Alerts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlerts + +`func (o *SlimCampaign) SetAlerts(v []CampaignAlert)` + +SetAlerts sets Alerts field to given value. + +### HasAlerts + +`func (o *SlimCampaign) HasAlerts() bool` + +HasAlerts returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SlimDiscoveredApplications.md b/docs/tools/sdk/go/Reference/V3/Models/SlimDiscoveredApplications.md new file mode 100644 index 000000000..846e10bff --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SlimDiscoveredApplications.md @@ -0,0 +1,272 @@ +--- +id: slim-discovered-applications +title: SlimDiscoveredApplications +pagination_label: SlimDiscoveredApplications +sidebar_label: SlimDiscoveredApplications +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SlimDiscoveredApplications', 'SlimDiscoveredApplications'] +slug: /tools/sdk/go/v3/models/slim-discovered-applications +tags: ['SDK', 'Software Development Kit', 'SlimDiscoveredApplications', 'SlimDiscoveredApplications'] +--- + +# SlimDiscoveredApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **string** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **string** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **string** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **string** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]string** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **SailPointTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **string** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [optional] + +## Methods + +### NewSlimDiscoveredApplications + +`func NewSlimDiscoveredApplications() *SlimDiscoveredApplications` + +NewSlimDiscoveredApplications instantiates a new SlimDiscoveredApplications 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 + +### NewSlimDiscoveredApplicationsWithDefaults + +`func NewSlimDiscoveredApplicationsWithDefaults() *SlimDiscoveredApplications` + +NewSlimDiscoveredApplicationsWithDefaults instantiates a new SlimDiscoveredApplications 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 + +### GetId + +`func (o *SlimDiscoveredApplications) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SlimDiscoveredApplications) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SlimDiscoveredApplications) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SlimDiscoveredApplications) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SlimDiscoveredApplications) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SlimDiscoveredApplications) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SlimDiscoveredApplications) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SlimDiscoveredApplications) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDiscoverySource + +`func (o *SlimDiscoveredApplications) GetDiscoverySource() string` + +GetDiscoverySource returns the DiscoverySource field if non-nil, zero value otherwise. + +### GetDiscoverySourceOk + +`func (o *SlimDiscoveredApplications) GetDiscoverySourceOk() (*string, bool)` + +GetDiscoverySourceOk returns a tuple with the DiscoverySource field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoverySource + +`func (o *SlimDiscoveredApplications) SetDiscoverySource(v string)` + +SetDiscoverySource sets DiscoverySource field to given value. + +### HasDiscoverySource + +`func (o *SlimDiscoveredApplications) HasDiscoverySource() bool` + +HasDiscoverySource returns a boolean if a field has been set. + +### GetDiscoveredVendor + +`func (o *SlimDiscoveredApplications) GetDiscoveredVendor() string` + +GetDiscoveredVendor returns the DiscoveredVendor field if non-nil, zero value otherwise. + +### GetDiscoveredVendorOk + +`func (o *SlimDiscoveredApplications) GetDiscoveredVendorOk() (*string, bool)` + +GetDiscoveredVendorOk returns a tuple with the DiscoveredVendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredVendor + +`func (o *SlimDiscoveredApplications) SetDiscoveredVendor(v string)` + +SetDiscoveredVendor sets DiscoveredVendor field to given value. + +### HasDiscoveredVendor + +`func (o *SlimDiscoveredApplications) HasDiscoveredVendor() bool` + +HasDiscoveredVendor returns a boolean if a field has been set. + +### GetDescription + +`func (o *SlimDiscoveredApplications) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SlimDiscoveredApplications) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SlimDiscoveredApplications) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SlimDiscoveredApplications) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetRecommendedConnectors + +`func (o *SlimDiscoveredApplications) GetRecommendedConnectors() []string` + +GetRecommendedConnectors returns the RecommendedConnectors field if non-nil, zero value otherwise. + +### GetRecommendedConnectorsOk + +`func (o *SlimDiscoveredApplications) GetRecommendedConnectorsOk() (*[]string, bool)` + +GetRecommendedConnectorsOk returns a tuple with the RecommendedConnectors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecommendedConnectors + +`func (o *SlimDiscoveredApplications) SetRecommendedConnectors(v []string)` + +SetRecommendedConnectors sets RecommendedConnectors field to given value. + +### HasRecommendedConnectors + +`func (o *SlimDiscoveredApplications) HasRecommendedConnectors() bool` + +HasRecommendedConnectors returns a boolean if a field has been set. + +### GetDiscoveredAt + +`func (o *SlimDiscoveredApplications) GetDiscoveredAt() SailPointTime` + +GetDiscoveredAt returns the DiscoveredAt field if non-nil, zero value otherwise. + +### GetDiscoveredAtOk + +`func (o *SlimDiscoveredApplications) GetDiscoveredAtOk() (*SailPointTime, bool)` + +GetDiscoveredAtOk returns a tuple with the DiscoveredAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoveredAt + +`func (o *SlimDiscoveredApplications) SetDiscoveredAt(v SailPointTime)` + +SetDiscoveredAt sets DiscoveredAt field to given value. + +### HasDiscoveredAt + +`func (o *SlimDiscoveredApplications) HasDiscoveredAt() bool` + +HasDiscoveredAt returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *SlimDiscoveredApplications) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *SlimDiscoveredApplications) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *SlimDiscoveredApplications) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *SlimDiscoveredApplications) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetStatus + +`func (o *SlimDiscoveredApplications) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SlimDiscoveredApplications) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SlimDiscoveredApplications) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SlimDiscoveredApplications) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SodExemptCriteria.md b/docs/tools/sdk/go/Reference/V3/Models/SodExemptCriteria.md new file mode 100644 index 000000000..d5d060ced --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SodExemptCriteria.md @@ -0,0 +1,142 @@ +--- +id: sod-exempt-criteria +title: SodExemptCriteria +pagination_label: SodExemptCriteria +sidebar_label: SodExemptCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodExemptCriteria', 'SodExemptCriteria'] +slug: /tools/sdk/go/v3/models/sod-exempt-criteria +tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria', 'SodExemptCriteria'] +--- + +# SodExemptCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Existing** | Pointer to **bool** | If the entitlement already belonged to the user or not. | [optional] [default to false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **string** | Entitlement ID | [optional] +**Name** | Pointer to **string** | Entitlement name | [optional] + +## Methods + +### NewSodExemptCriteria + +`func NewSodExemptCriteria() *SodExemptCriteria` + +NewSodExemptCriteria instantiates a new SodExemptCriteria 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 + +### NewSodExemptCriteriaWithDefaults + +`func NewSodExemptCriteriaWithDefaults() *SodExemptCriteria` + +NewSodExemptCriteriaWithDefaults instantiates a new SodExemptCriteria 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 + +### GetExisting + +`func (o *SodExemptCriteria) GetExisting() bool` + +GetExisting returns the Existing field if non-nil, zero value otherwise. + +### GetExistingOk + +`func (o *SodExemptCriteria) GetExistingOk() (*bool, bool)` + +GetExistingOk returns a tuple with the Existing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExisting + +`func (o *SodExemptCriteria) SetExisting(v bool)` + +SetExisting sets Existing field to given value. + +### HasExisting + +`func (o *SodExemptCriteria) HasExisting() bool` + +HasExisting returns a boolean if a field has been set. + +### GetType + +`func (o *SodExemptCriteria) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodExemptCriteria) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodExemptCriteria) SetType(v DtoType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodExemptCriteria) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodExemptCriteria) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodExemptCriteria) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodExemptCriteria) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodExemptCriteria) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodExemptCriteria) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodExemptCriteria) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodExemptCriteria) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodExemptCriteria) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SodPolicy.md b/docs/tools/sdk/go/Reference/V3/Models/SodPolicy.md new file mode 100644 index 000000000..8c6975adf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SodPolicy.md @@ -0,0 +1,556 @@ +--- +id: sod-policy +title: SodPolicy +pagination_label: SodPolicy +sidebar_label: SodPolicy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicy', 'SodPolicy'] +slug: /tools/sdk/go/v3/models/sod-policy +tags: ['SDK', 'Software Development Kit', 'SodPolicy', 'SodPolicy'] +--- + +# SodPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Policy id | [optional] [readonly] +**Name** | Pointer to **string** | Policy Business Name | [optional] +**Created** | Pointer to **SailPointTime** | The time when this SOD policy is created. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | The time when this SOD policy is modified. | [optional] [readonly] +**Description** | Pointer to **NullableString** | Optional description of the SOD policy | [optional] +**OwnerRef** | Pointer to [**SodPolicyOwnerRef**](sod-policy-owner-ref) | | [optional] +**ExternalPolicyReference** | Pointer to **NullableString** | Optional External Policy Reference | [optional] +**PolicyQuery** | Pointer to **string** | Search query of the SOD policy | [optional] +**CompensatingControls** | Pointer to **NullableString** | Optional compensating controls(Mitigating Controls) | [optional] +**CorrectionAdvice** | Pointer to **NullableString** | Optional correction advice | [optional] +**State** | Pointer to **string** | whether the policy is enforced or not | [optional] +**Tags** | Pointer to **[]string** | tags for this policy object | [optional] +**CreatorId** | Pointer to **string** | Policy's creator ID | [optional] [readonly] +**ModifierId** | Pointer to **NullableString** | Policy's modifier ID | [optional] [readonly] +**ViolationOwnerAssignmentConfig** | Pointer to [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional] +**Scheduled** | Pointer to **bool** | defines whether a policy has been scheduled or not | [optional] [default to false] +**Type** | Pointer to **string** | whether a policy is query based or conflicting access based | [optional] [default to "GENERAL"] +**ConflictingAccessCriteria** | Pointer to [**SodPolicyConflictingAccessCriteria**](sod-policy-conflicting-access-criteria) | | [optional] + +## Methods + +### NewSodPolicy + +`func NewSodPolicy() *SodPolicy` + +NewSodPolicy instantiates a new SodPolicy 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 + +### NewSodPolicyWithDefaults + +`func NewSodPolicyWithDefaults() *SodPolicy` + +NewSodPolicyWithDefaults instantiates a new SodPolicy 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 + +### GetId + +`func (o *SodPolicy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodPolicy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodPolicy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodPolicy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodPolicy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodPolicy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodPolicy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodPolicy) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *SodPolicy) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SodPolicy) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SodPolicy) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SodPolicy) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SodPolicy) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SodPolicy) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SodPolicy) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SodPolicy) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *SodPolicy) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SodPolicy) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SodPolicy) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SodPolicy) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescriptionNil + +`func (o *SodPolicy) SetDescriptionNil(b bool)` + + SetDescriptionNil sets the value for Description to be an explicit nil + +### UnsetDescription +`func (o *SodPolicy) UnsetDescription()` + +UnsetDescription ensures that no value is present for Description, not even an explicit nil +### GetOwnerRef + +`func (o *SodPolicy) GetOwnerRef() SodPolicyOwnerRef` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *SodPolicy) GetOwnerRefOk() (*SodPolicyOwnerRef, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *SodPolicy) SetOwnerRef(v SodPolicyOwnerRef)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *SodPolicy) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### GetExternalPolicyReference + +`func (o *SodPolicy) GetExternalPolicyReference() string` + +GetExternalPolicyReference returns the ExternalPolicyReference field if non-nil, zero value otherwise. + +### GetExternalPolicyReferenceOk + +`func (o *SodPolicy) GetExternalPolicyReferenceOk() (*string, bool)` + +GetExternalPolicyReferenceOk returns a tuple with the ExternalPolicyReference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExternalPolicyReference + +`func (o *SodPolicy) SetExternalPolicyReference(v string)` + +SetExternalPolicyReference sets ExternalPolicyReference field to given value. + +### HasExternalPolicyReference + +`func (o *SodPolicy) HasExternalPolicyReference() bool` + +HasExternalPolicyReference returns a boolean if a field has been set. + +### SetExternalPolicyReferenceNil + +`func (o *SodPolicy) SetExternalPolicyReferenceNil(b bool)` + + SetExternalPolicyReferenceNil sets the value for ExternalPolicyReference to be an explicit nil + +### UnsetExternalPolicyReference +`func (o *SodPolicy) UnsetExternalPolicyReference()` + +UnsetExternalPolicyReference ensures that no value is present for ExternalPolicyReference, not even an explicit nil +### GetPolicyQuery + +`func (o *SodPolicy) GetPolicyQuery() string` + +GetPolicyQuery returns the PolicyQuery field if non-nil, zero value otherwise. + +### GetPolicyQueryOk + +`func (o *SodPolicy) GetPolicyQueryOk() (*string, bool)` + +GetPolicyQueryOk returns a tuple with the PolicyQuery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicyQuery + +`func (o *SodPolicy) SetPolicyQuery(v string)` + +SetPolicyQuery sets PolicyQuery field to given value. + +### HasPolicyQuery + +`func (o *SodPolicy) HasPolicyQuery() bool` + +HasPolicyQuery returns a boolean if a field has been set. + +### GetCompensatingControls + +`func (o *SodPolicy) GetCompensatingControls() string` + +GetCompensatingControls returns the CompensatingControls field if non-nil, zero value otherwise. + +### GetCompensatingControlsOk + +`func (o *SodPolicy) GetCompensatingControlsOk() (*string, bool)` + +GetCompensatingControlsOk returns a tuple with the CompensatingControls field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompensatingControls + +`func (o *SodPolicy) SetCompensatingControls(v string)` + +SetCompensatingControls sets CompensatingControls field to given value. + +### HasCompensatingControls + +`func (o *SodPolicy) HasCompensatingControls() bool` + +HasCompensatingControls returns a boolean if a field has been set. + +### SetCompensatingControlsNil + +`func (o *SodPolicy) SetCompensatingControlsNil(b bool)` + + SetCompensatingControlsNil sets the value for CompensatingControls to be an explicit nil + +### UnsetCompensatingControls +`func (o *SodPolicy) UnsetCompensatingControls()` + +UnsetCompensatingControls ensures that no value is present for CompensatingControls, not even an explicit nil +### GetCorrectionAdvice + +`func (o *SodPolicy) GetCorrectionAdvice() string` + +GetCorrectionAdvice returns the CorrectionAdvice field if non-nil, zero value otherwise. + +### GetCorrectionAdviceOk + +`func (o *SodPolicy) GetCorrectionAdviceOk() (*string, bool)` + +GetCorrectionAdviceOk returns a tuple with the CorrectionAdvice field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrectionAdvice + +`func (o *SodPolicy) SetCorrectionAdvice(v string)` + +SetCorrectionAdvice sets CorrectionAdvice field to given value. + +### HasCorrectionAdvice + +`func (o *SodPolicy) HasCorrectionAdvice() bool` + +HasCorrectionAdvice returns a boolean if a field has been set. + +### SetCorrectionAdviceNil + +`func (o *SodPolicy) SetCorrectionAdviceNil(b bool)` + + SetCorrectionAdviceNil sets the value for CorrectionAdvice to be an explicit nil + +### UnsetCorrectionAdvice +`func (o *SodPolicy) UnsetCorrectionAdvice()` + +UnsetCorrectionAdvice ensures that no value is present for CorrectionAdvice, not even an explicit nil +### GetState + +`func (o *SodPolicy) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *SodPolicy) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *SodPolicy) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *SodPolicy) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetTags + +`func (o *SodPolicy) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *SodPolicy) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *SodPolicy) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *SodPolicy) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### GetCreatorId + +`func (o *SodPolicy) GetCreatorId() string` + +GetCreatorId returns the CreatorId field if non-nil, zero value otherwise. + +### GetCreatorIdOk + +`func (o *SodPolicy) GetCreatorIdOk() (*string, bool)` + +GetCreatorIdOk returns a tuple with the CreatorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatorId + +`func (o *SodPolicy) SetCreatorId(v string)` + +SetCreatorId sets CreatorId field to given value. + +### HasCreatorId + +`func (o *SodPolicy) HasCreatorId() bool` + +HasCreatorId returns a boolean if a field has been set. + +### GetModifierId + +`func (o *SodPolicy) GetModifierId() string` + +GetModifierId returns the ModifierId field if non-nil, zero value otherwise. + +### GetModifierIdOk + +`func (o *SodPolicy) GetModifierIdOk() (*string, bool)` + +GetModifierIdOk returns a tuple with the ModifierId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifierId + +`func (o *SodPolicy) SetModifierId(v string)` + +SetModifierId sets ModifierId field to given value. + +### HasModifierId + +`func (o *SodPolicy) HasModifierId() bool` + +HasModifierId returns a boolean if a field has been set. + +### SetModifierIdNil + +`func (o *SodPolicy) SetModifierIdNil(b bool)` + + SetModifierIdNil sets the value for ModifierId to be an explicit nil + +### UnsetModifierId +`func (o *SodPolicy) UnsetModifierId()` + +UnsetModifierId ensures that no value is present for ModifierId, not even an explicit nil +### GetViolationOwnerAssignmentConfig + +`func (o *SodPolicy) GetViolationOwnerAssignmentConfig() ViolationOwnerAssignmentConfig` + +GetViolationOwnerAssignmentConfig returns the ViolationOwnerAssignmentConfig field if non-nil, zero value otherwise. + +### GetViolationOwnerAssignmentConfigOk + +`func (o *SodPolicy) GetViolationOwnerAssignmentConfigOk() (*ViolationOwnerAssignmentConfig, bool)` + +GetViolationOwnerAssignmentConfigOk returns a tuple with the ViolationOwnerAssignmentConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationOwnerAssignmentConfig + +`func (o *SodPolicy) SetViolationOwnerAssignmentConfig(v ViolationOwnerAssignmentConfig)` + +SetViolationOwnerAssignmentConfig sets ViolationOwnerAssignmentConfig field to given value. + +### HasViolationOwnerAssignmentConfig + +`func (o *SodPolicy) HasViolationOwnerAssignmentConfig() bool` + +HasViolationOwnerAssignmentConfig returns a boolean if a field has been set. + +### GetScheduled + +`func (o *SodPolicy) GetScheduled() bool` + +GetScheduled returns the Scheduled field if non-nil, zero value otherwise. + +### GetScheduledOk + +`func (o *SodPolicy) GetScheduledOk() (*bool, bool)` + +GetScheduledOk returns a tuple with the Scheduled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScheduled + +`func (o *SodPolicy) SetScheduled(v bool)` + +SetScheduled sets Scheduled field to given value. + +### HasScheduled + +`func (o *SodPolicy) HasScheduled() bool` + +HasScheduled returns a boolean if a field has been set. + +### GetType + +`func (o *SodPolicy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodPolicy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodPolicy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodPolicy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConflictingAccessCriteria + +`func (o *SodPolicy) GetConflictingAccessCriteria() SodPolicyConflictingAccessCriteria` + +GetConflictingAccessCriteria returns the ConflictingAccessCriteria field if non-nil, zero value otherwise. + +### GetConflictingAccessCriteriaOk + +`func (o *SodPolicy) GetConflictingAccessCriteriaOk() (*SodPolicyConflictingAccessCriteria, bool)` + +GetConflictingAccessCriteriaOk returns a tuple with the ConflictingAccessCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConflictingAccessCriteria + +`func (o *SodPolicy) SetConflictingAccessCriteria(v SodPolicyConflictingAccessCriteria)` + +SetConflictingAccessCriteria sets ConflictingAccessCriteria field to given value. + +### HasConflictingAccessCriteria + +`func (o *SodPolicy) HasConflictingAccessCriteria() bool` + +HasConflictingAccessCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SodPolicyConflictingAccessCriteria.md b/docs/tools/sdk/go/Reference/V3/Models/SodPolicyConflictingAccessCriteria.md new file mode 100644 index 000000000..2ecfee71d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SodPolicyConflictingAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: sod-policy-conflicting-access-criteria +title: SodPolicyConflictingAccessCriteria +pagination_label: SodPolicyConflictingAccessCriteria +sidebar_label: SodPolicyConflictingAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicyConflictingAccessCriteria', 'SodPolicyConflictingAccessCriteria'] +slug: /tools/sdk/go/v3/models/sod-policy-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodPolicyConflictingAccessCriteria', 'SodPolicyConflictingAccessCriteria'] +--- + +# SodPolicyConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] +**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] + +## Methods + +### NewSodPolicyConflictingAccessCriteria + +`func NewSodPolicyConflictingAccessCriteria() *SodPolicyConflictingAccessCriteria` + +NewSodPolicyConflictingAccessCriteria instantiates a new SodPolicyConflictingAccessCriteria 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 + +### NewSodPolicyConflictingAccessCriteriaWithDefaults + +`func NewSodPolicyConflictingAccessCriteriaWithDefaults() *SodPolicyConflictingAccessCriteria` + +NewSodPolicyConflictingAccessCriteriaWithDefaults instantiates a new SodPolicyConflictingAccessCriteria 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 + +### GetLeftCriteria + +`func (o *SodPolicyConflictingAccessCriteria) GetLeftCriteria() AccessCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *SodPolicyConflictingAccessCriteria) GetLeftCriteriaOk() (*AccessCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *SodPolicyConflictingAccessCriteria) SetLeftCriteria(v AccessCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *SodPolicyConflictingAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *SodPolicyConflictingAccessCriteria) GetRightCriteria() AccessCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *SodPolicyConflictingAccessCriteria) GetRightCriteriaOk() (*AccessCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *SodPolicyConflictingAccessCriteria) SetRightCriteria(v AccessCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *SodPolicyConflictingAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SodPolicyDto.md b/docs/tools/sdk/go/Reference/V3/Models/SodPolicyDto.md new file mode 100644 index 000000000..28f6e0291 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SodPolicyDto.md @@ -0,0 +1,116 @@ +--- +id: sod-policy-dto +title: SodPolicyDto +pagination_label: SodPolicyDto +sidebar_label: SodPolicyDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicyDto', 'SodPolicyDto'] +slug: /tools/sdk/go/v3/models/sod-policy-dto +tags: ['SDK', 'Software Development Kit', 'SodPolicyDto', 'SodPolicyDto'] +--- + +# SodPolicyDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy ID. | [optional] +**Name** | Pointer to **string** | SOD policy display name. | [optional] + +## Methods + +### NewSodPolicyDto + +`func NewSodPolicyDto() *SodPolicyDto` + +NewSodPolicyDto instantiates a new SodPolicyDto 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 + +### NewSodPolicyDtoWithDefaults + +`func NewSodPolicyDtoWithDefaults() *SodPolicyDto` + +NewSodPolicyDtoWithDefaults instantiates a new SodPolicyDto 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 + +### GetType + +`func (o *SodPolicyDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodPolicyDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodPolicyDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodPolicyDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodPolicyDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodPolicyDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodPolicyDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodPolicyDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodPolicyDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodPolicyDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodPolicyDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodPolicyDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SodPolicyOwnerRef.md b/docs/tools/sdk/go/Reference/V3/Models/SodPolicyOwnerRef.md new file mode 100644 index 000000000..e102059f1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SodPolicyOwnerRef.md @@ -0,0 +1,116 @@ +--- +id: sod-policy-owner-ref +title: SodPolicyOwnerRef +pagination_label: SodPolicyOwnerRef +sidebar_label: SodPolicyOwnerRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicyOwnerRef', 'SodPolicyOwnerRef'] +slug: /tools/sdk/go/v3/models/sod-policy-owner-ref +tags: ['SDK', 'Software Development Kit', 'SodPolicyOwnerRef', 'SodPolicyOwnerRef'] +--- + +# SodPolicyOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Owner type. | [optional] +**Id** | Pointer to **string** | Owner's ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] + +## Methods + +### NewSodPolicyOwnerRef + +`func NewSodPolicyOwnerRef() *SodPolicyOwnerRef` + +NewSodPolicyOwnerRef instantiates a new SodPolicyOwnerRef 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 + +### NewSodPolicyOwnerRefWithDefaults + +`func NewSodPolicyOwnerRefWithDefaults() *SodPolicyOwnerRef` + +NewSodPolicyOwnerRefWithDefaults instantiates a new SodPolicyOwnerRef 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 + +### GetType + +`func (o *SodPolicyOwnerRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodPolicyOwnerRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodPolicyOwnerRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodPolicyOwnerRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodPolicyOwnerRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodPolicyOwnerRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodPolicyOwnerRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodPolicyOwnerRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodPolicyOwnerRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodPolicyOwnerRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodPolicyOwnerRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodPolicyOwnerRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SodPolicySchedule.md b/docs/tools/sdk/go/Reference/V3/Models/SodPolicySchedule.md new file mode 100644 index 000000000..bb4596fa9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SodPolicySchedule.md @@ -0,0 +1,272 @@ +--- +id: sod-policy-schedule +title: SodPolicySchedule +pagination_label: SodPolicySchedule +sidebar_label: SodPolicySchedule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodPolicySchedule', 'SodPolicySchedule'] +slug: /tools/sdk/go/v3/models/sod-policy-schedule +tags: ['SDK', 'Software Development Kit', 'SodPolicySchedule', 'SodPolicySchedule'] +--- + +# SodPolicySchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | SOD Policy schedule name | [optional] +**Created** | Pointer to **SailPointTime** | The time when this SOD policy schedule is created. | [optional] [readonly] +**Modified** | Pointer to **SailPointTime** | The time when this SOD policy schedule is modified. | [optional] [readonly] +**Description** | Pointer to **string** | SOD Policy schedule description | [optional] +**Schedule** | Pointer to [**Schedule1**](schedule1) | | [optional] +**Recipients** | Pointer to [**[]SodRecipient**](sod-recipient) | | [optional] +**EmailEmptyResults** | Pointer to **bool** | Indicates if empty results need to be emailed | [optional] [default to false] +**CreatorId** | Pointer to **string** | Policy's creator ID | [optional] [readonly] +**ModifierId** | Pointer to **string** | Policy's modifier ID | [optional] [readonly] + +## Methods + +### NewSodPolicySchedule + +`func NewSodPolicySchedule() *SodPolicySchedule` + +NewSodPolicySchedule instantiates a new SodPolicySchedule 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 + +### NewSodPolicyScheduleWithDefaults + +`func NewSodPolicyScheduleWithDefaults() *SodPolicySchedule` + +NewSodPolicyScheduleWithDefaults instantiates a new SodPolicySchedule 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 + +### GetName + +`func (o *SodPolicySchedule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodPolicySchedule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodPolicySchedule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodPolicySchedule) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCreated + +`func (o *SodPolicySchedule) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SodPolicySchedule) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SodPolicySchedule) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SodPolicySchedule) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *SodPolicySchedule) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *SodPolicySchedule) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *SodPolicySchedule) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *SodPolicySchedule) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetDescription + +`func (o *SodPolicySchedule) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *SodPolicySchedule) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *SodPolicySchedule) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *SodPolicySchedule) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetSchedule + +`func (o *SodPolicySchedule) GetSchedule() Schedule1` + +GetSchedule returns the Schedule field if non-nil, zero value otherwise. + +### GetScheduleOk + +`func (o *SodPolicySchedule) GetScheduleOk() (*Schedule1, bool)` + +GetScheduleOk returns a tuple with the Schedule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchedule + +`func (o *SodPolicySchedule) SetSchedule(v Schedule1)` + +SetSchedule sets Schedule field to given value. + +### HasSchedule + +`func (o *SodPolicySchedule) HasSchedule() bool` + +HasSchedule returns a boolean if a field has been set. + +### GetRecipients + +`func (o *SodPolicySchedule) GetRecipients() []SodRecipient` + +GetRecipients returns the Recipients field if non-nil, zero value otherwise. + +### GetRecipientsOk + +`func (o *SodPolicySchedule) GetRecipientsOk() (*[]SodRecipient, bool)` + +GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRecipients + +`func (o *SodPolicySchedule) SetRecipients(v []SodRecipient)` + +SetRecipients sets Recipients field to given value. + +### HasRecipients + +`func (o *SodPolicySchedule) HasRecipients() bool` + +HasRecipients returns a boolean if a field has been set. + +### GetEmailEmptyResults + +`func (o *SodPolicySchedule) GetEmailEmptyResults() bool` + +GetEmailEmptyResults returns the EmailEmptyResults field if non-nil, zero value otherwise. + +### GetEmailEmptyResultsOk + +`func (o *SodPolicySchedule) GetEmailEmptyResultsOk() (*bool, bool)` + +GetEmailEmptyResultsOk returns a tuple with the EmailEmptyResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEmailEmptyResults + +`func (o *SodPolicySchedule) SetEmailEmptyResults(v bool)` + +SetEmailEmptyResults sets EmailEmptyResults field to given value. + +### HasEmailEmptyResults + +`func (o *SodPolicySchedule) HasEmailEmptyResults() bool` + +HasEmailEmptyResults returns a boolean if a field has been set. + +### GetCreatorId + +`func (o *SodPolicySchedule) GetCreatorId() string` + +GetCreatorId returns the CreatorId field if non-nil, zero value otherwise. + +### GetCreatorIdOk + +`func (o *SodPolicySchedule) GetCreatorIdOk() (*string, bool)` + +GetCreatorIdOk returns a tuple with the CreatorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatorId + +`func (o *SodPolicySchedule) SetCreatorId(v string)` + +SetCreatorId sets CreatorId field to given value. + +### HasCreatorId + +`func (o *SodPolicySchedule) HasCreatorId() bool` + +HasCreatorId returns a boolean if a field has been set. + +### GetModifierId + +`func (o *SodPolicySchedule) GetModifierId() string` + +GetModifierId returns the ModifierId field if non-nil, zero value otherwise. + +### GetModifierIdOk + +`func (o *SodPolicySchedule) GetModifierIdOk() (*string, bool)` + +GetModifierIdOk returns a tuple with the ModifierId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifierId + +`func (o *SodPolicySchedule) SetModifierId(v string)` + +SetModifierId sets ModifierId field to given value. + +### HasModifierId + +`func (o *SodPolicySchedule) HasModifierId() bool` + +HasModifierId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SodRecipient.md b/docs/tools/sdk/go/Reference/V3/Models/SodRecipient.md new file mode 100644 index 000000000..efe44572c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SodRecipient.md @@ -0,0 +1,116 @@ +--- +id: sod-recipient +title: SodRecipient +pagination_label: SodRecipient +sidebar_label: SodRecipient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodRecipient', 'SodRecipient'] +slug: /tools/sdk/go/v3/models/sod-recipient +tags: ['SDK', 'Software Development Kit', 'SodRecipient', 'SodRecipient'] +--- + +# SodRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy recipient DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy recipient's identity ID. | [optional] +**Name** | Pointer to **string** | SOD policy recipient's display name. | [optional] + +## Methods + +### NewSodRecipient + +`func NewSodRecipient() *SodRecipient` + +NewSodRecipient instantiates a new SodRecipient 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 + +### NewSodRecipientWithDefaults + +`func NewSodRecipientWithDefaults() *SodRecipient` + +NewSodRecipientWithDefaults instantiates a new SodRecipient 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 + +### GetType + +`func (o *SodRecipient) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodRecipient) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodRecipient) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodRecipient) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodRecipient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodRecipient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodRecipient) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodRecipient) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodRecipient) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodRecipient) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodRecipient) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodRecipient) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SodReportResultDto.md b/docs/tools/sdk/go/Reference/V3/Models/SodReportResultDto.md new file mode 100644 index 000000000..1b9cbe25d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SodReportResultDto.md @@ -0,0 +1,116 @@ +--- +id: sod-report-result-dto +title: SodReportResultDto +pagination_label: SodReportResultDto +sidebar_label: SodReportResultDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodReportResultDto', 'SodReportResultDto'] +slug: /tools/sdk/go/v3/models/sod-report-result-dto +tags: ['SDK', 'Software Development Kit', 'SodReportResultDto', 'SodReportResultDto'] +--- + +# SodReportResultDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **string** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **string** | Human-readable name of the SOD policy violation report result. | [optional] + +## Methods + +### NewSodReportResultDto + +`func NewSodReportResultDto() *SodReportResultDto` + +NewSodReportResultDto instantiates a new SodReportResultDto 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 + +### NewSodReportResultDtoWithDefaults + +`func NewSodReportResultDtoWithDefaults() *SodReportResultDto` + +NewSodReportResultDtoWithDefaults instantiates a new SodReportResultDto 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 + +### GetType + +`func (o *SodReportResultDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SodReportResultDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SodReportResultDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SodReportResultDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SodReportResultDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SodReportResultDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SodReportResultDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SodReportResultDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SodReportResultDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SodReportResultDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SodReportResultDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SodReportResultDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SodViolationCheck.md b/docs/tools/sdk/go/Reference/V3/Models/SodViolationCheck.md new file mode 100644 index 000000000..11f37b964 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SodViolationCheck.md @@ -0,0 +1,85 @@ +--- +id: sod-violation-check +title: SodViolationCheck +pagination_label: SodViolationCheck +sidebar_label: SodViolationCheck +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationCheck', 'SodViolationCheck'] +slug: /tools/sdk/go/v3/models/sod-violation-check +tags: ['SDK', 'Software Development Kit', 'SodViolationCheck', 'SodViolationCheck'] +--- + +# SodViolationCheck + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | **string** | The id of the original request | +**Created** | Pointer to **SailPointTime** | The date-time when this request was created. | [optional] [readonly] + +## Methods + +### NewSodViolationCheck + +`func NewSodViolationCheck(requestId string, ) *SodViolationCheck` + +NewSodViolationCheck instantiates a new SodViolationCheck 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 + +### NewSodViolationCheckWithDefaults + +`func NewSodViolationCheckWithDefaults() *SodViolationCheck` + +NewSodViolationCheckWithDefaults instantiates a new SodViolationCheck 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 + +### GetRequestId + +`func (o *SodViolationCheck) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *SodViolationCheck) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *SodViolationCheck) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + + +### GetCreated + +`func (o *SodViolationCheck) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *SodViolationCheck) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *SodViolationCheck) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *SodViolationCheck) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SodViolationCheckResult.md b/docs/tools/sdk/go/Reference/V3/Models/SodViolationCheckResult.md new file mode 100644 index 000000000..d9c8ed72e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SodViolationCheckResult.md @@ -0,0 +1,172 @@ +--- +id: sod-violation-check-result +title: SodViolationCheckResult +pagination_label: SodViolationCheckResult +sidebar_label: SodViolationCheckResult +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationCheckResult', 'SodViolationCheckResult'] +slug: /tools/sdk/go/v3/models/sod-violation-check-result +tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult', 'SodViolationCheckResult'] +--- + +# SodViolationCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to [**ErrorMessageDto**](error-message-dto) | | [optional] +**ClientMetadata** | Pointer to **map[string]string** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] +**ViolationContexts** | Pointer to [**[]SodViolationContext**](sod-violation-context) | | [optional] +**ViolatedPolicies** | Pointer to [**[]SodPolicyDto**](sod-policy-dto) | A list of the SOD policies that were violated. | [optional] + +## Methods + +### NewSodViolationCheckResult + +`func NewSodViolationCheckResult() *SodViolationCheckResult` + +NewSodViolationCheckResult instantiates a new SodViolationCheckResult 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 + +### NewSodViolationCheckResultWithDefaults + +`func NewSodViolationCheckResultWithDefaults() *SodViolationCheckResult` + +NewSodViolationCheckResultWithDefaults instantiates a new SodViolationCheckResult 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 + +### GetMessage + +`func (o *SodViolationCheckResult) GetMessage() ErrorMessageDto` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *SodViolationCheckResult) GetMessageOk() (*ErrorMessageDto, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *SodViolationCheckResult) SetMessage(v ErrorMessageDto)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *SodViolationCheckResult) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetClientMetadata + +`func (o *SodViolationCheckResult) GetClientMetadata() map[string]string` + +GetClientMetadata returns the ClientMetadata field if non-nil, zero value otherwise. + +### GetClientMetadataOk + +`func (o *SodViolationCheckResult) GetClientMetadataOk() (*map[string]string, bool)` + +GetClientMetadataOk returns a tuple with the ClientMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClientMetadata + +`func (o *SodViolationCheckResult) SetClientMetadata(v map[string]string)` + +SetClientMetadata sets ClientMetadata field to given value. + +### HasClientMetadata + +`func (o *SodViolationCheckResult) HasClientMetadata() bool` + +HasClientMetadata returns a boolean if a field has been set. + +### SetClientMetadataNil + +`func (o *SodViolationCheckResult) SetClientMetadataNil(b bool)` + + SetClientMetadataNil sets the value for ClientMetadata to be an explicit nil + +### UnsetClientMetadata +`func (o *SodViolationCheckResult) UnsetClientMetadata()` + +UnsetClientMetadata ensures that no value is present for ClientMetadata, not even an explicit nil +### GetViolationContexts + +`func (o *SodViolationCheckResult) GetViolationContexts() []SodViolationContext` + +GetViolationContexts returns the ViolationContexts field if non-nil, zero value otherwise. + +### GetViolationContextsOk + +`func (o *SodViolationCheckResult) GetViolationContextsOk() (*[]SodViolationContext, bool)` + +GetViolationContextsOk returns a tuple with the ViolationContexts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationContexts + +`func (o *SodViolationCheckResult) SetViolationContexts(v []SodViolationContext)` + +SetViolationContexts sets ViolationContexts field to given value. + +### HasViolationContexts + +`func (o *SodViolationCheckResult) HasViolationContexts() bool` + +HasViolationContexts returns a boolean if a field has been set. + +### SetViolationContextsNil + +`func (o *SodViolationCheckResult) SetViolationContextsNil(b bool)` + + SetViolationContextsNil sets the value for ViolationContexts to be an explicit nil + +### UnsetViolationContexts +`func (o *SodViolationCheckResult) UnsetViolationContexts()` + +UnsetViolationContexts ensures that no value is present for ViolationContexts, not even an explicit nil +### GetViolatedPolicies + +`func (o *SodViolationCheckResult) GetViolatedPolicies() []SodPolicyDto` + +GetViolatedPolicies returns the ViolatedPolicies field if non-nil, zero value otherwise. + +### GetViolatedPoliciesOk + +`func (o *SodViolationCheckResult) GetViolatedPoliciesOk() (*[]SodPolicyDto, bool)` + +GetViolatedPoliciesOk returns a tuple with the ViolatedPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolatedPolicies + +`func (o *SodViolationCheckResult) SetViolatedPolicies(v []SodPolicyDto)` + +SetViolatedPolicies sets ViolatedPolicies field to given value. + +### HasViolatedPolicies + +`func (o *SodViolationCheckResult) HasViolatedPolicies() bool` + +HasViolatedPolicies returns a boolean if a field has been set. + +### SetViolatedPoliciesNil + +`func (o *SodViolationCheckResult) SetViolatedPoliciesNil(b bool)` + + SetViolatedPoliciesNil sets the value for ViolatedPolicies to be an explicit nil + +### UnsetViolatedPolicies +`func (o *SodViolationCheckResult) UnsetViolatedPolicies()` + +UnsetViolatedPolicies ensures that no value is present for ViolatedPolicies, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SodViolationContext.md b/docs/tools/sdk/go/Reference/V3/Models/SodViolationContext.md new file mode 100644 index 000000000..d62462e25 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SodViolationContext.md @@ -0,0 +1,90 @@ +--- +id: sod-violation-context +title: SodViolationContext +pagination_label: SodViolationContext +sidebar_label: SodViolationContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContext', 'SodViolationContext'] +slug: /tools/sdk/go/v3/models/sod-violation-context +tags: ['SDK', 'Software Development Kit', 'SodViolationContext', 'SodViolationContext'] +--- + +# SodViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**SodPolicyDto**](sod-policy-dto) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteria**](sod-violation-context-conflicting-access-criteria) | | [optional] + +## Methods + +### NewSodViolationContext + +`func NewSodViolationContext() *SodViolationContext` + +NewSodViolationContext instantiates a new SodViolationContext 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 + +### NewSodViolationContextWithDefaults + +`func NewSodViolationContextWithDefaults() *SodViolationContext` + +NewSodViolationContextWithDefaults instantiates a new SodViolationContext 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 + +### GetPolicy + +`func (o *SodViolationContext) GetPolicy() SodPolicyDto` + +GetPolicy returns the Policy field if non-nil, zero value otherwise. + +### GetPolicyOk + +`func (o *SodViolationContext) GetPolicyOk() (*SodPolicyDto, bool)` + +GetPolicyOk returns a tuple with the Policy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicy + +`func (o *SodViolationContext) SetPolicy(v SodPolicyDto)` + +SetPolicy sets Policy field to given value. + +### HasPolicy + +`func (o *SodViolationContext) HasPolicy() bool` + +HasPolicy returns a boolean if a field has been set. + +### GetConflictingAccessCriteria + +`func (o *SodViolationContext) GetConflictingAccessCriteria() SodViolationContextConflictingAccessCriteria` + +GetConflictingAccessCriteria returns the ConflictingAccessCriteria field if non-nil, zero value otherwise. + +### GetConflictingAccessCriteriaOk + +`func (o *SodViolationContext) GetConflictingAccessCriteriaOk() (*SodViolationContextConflictingAccessCriteria, bool)` + +GetConflictingAccessCriteriaOk returns a tuple with the ConflictingAccessCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConflictingAccessCriteria + +`func (o *SodViolationContext) SetConflictingAccessCriteria(v SodViolationContextConflictingAccessCriteria)` + +SetConflictingAccessCriteria sets ConflictingAccessCriteria field to given value. + +### HasConflictingAccessCriteria + +`func (o *SodViolationContext) HasConflictingAccessCriteria() bool` + +HasConflictingAccessCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SodViolationContextCheckCompleted.md b/docs/tools/sdk/go/Reference/V3/Models/SodViolationContextCheckCompleted.md new file mode 100644 index 000000000..7a57d59b7 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SodViolationContextCheckCompleted.md @@ -0,0 +1,136 @@ +--- +id: sod-violation-context-check-completed +title: SodViolationContextCheckCompleted +pagination_label: SodViolationContextCheckCompleted +sidebar_label: SodViolationContextCheckCompleted +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContextCheckCompleted', 'SodViolationContextCheckCompleted'] +slug: /tools/sdk/go/v3/models/sod-violation-context-check-completed +tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted', 'SodViolationContextCheckCompleted'] +--- + +# SodViolationContextCheckCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **NullableString** | The status of SOD violation check | [optional] +**Uuid** | Pointer to **NullableString** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] + +## Methods + +### NewSodViolationContextCheckCompleted + +`func NewSodViolationContextCheckCompleted() *SodViolationContextCheckCompleted` + +NewSodViolationContextCheckCompleted instantiates a new SodViolationContextCheckCompleted 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 + +### NewSodViolationContextCheckCompletedWithDefaults + +`func NewSodViolationContextCheckCompletedWithDefaults() *SodViolationContextCheckCompleted` + +NewSodViolationContextCheckCompletedWithDefaults instantiates a new SodViolationContextCheckCompleted 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 + +### GetState + +`func (o *SodViolationContextCheckCompleted) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *SodViolationContextCheckCompleted) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *SodViolationContextCheckCompleted) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *SodViolationContextCheckCompleted) HasState() bool` + +HasState returns a boolean if a field has been set. + +### SetStateNil + +`func (o *SodViolationContextCheckCompleted) SetStateNil(b bool)` + + SetStateNil sets the value for State to be an explicit nil + +### UnsetState +`func (o *SodViolationContextCheckCompleted) UnsetState()` + +UnsetState ensures that no value is present for State, not even an explicit nil +### GetUuid + +`func (o *SodViolationContextCheckCompleted) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *SodViolationContextCheckCompleted) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *SodViolationContextCheckCompleted) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *SodViolationContextCheckCompleted) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + +### SetUuidNil + +`func (o *SodViolationContextCheckCompleted) SetUuidNil(b bool)` + + SetUuidNil sets the value for Uuid to be an explicit nil + +### UnsetUuid +`func (o *SodViolationContextCheckCompleted) UnsetUuid()` + +UnsetUuid ensures that no value is present for Uuid, not even an explicit nil +### GetViolationCheckResult + +`func (o *SodViolationContextCheckCompleted) GetViolationCheckResult() SodViolationCheckResult` + +GetViolationCheckResult returns the ViolationCheckResult field if non-nil, zero value otherwise. + +### GetViolationCheckResultOk + +`func (o *SodViolationContextCheckCompleted) GetViolationCheckResultOk() (*SodViolationCheckResult, bool)` + +GetViolationCheckResultOk returns a tuple with the ViolationCheckResult field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationCheckResult + +`func (o *SodViolationContextCheckCompleted) SetViolationCheckResult(v SodViolationCheckResult)` + +SetViolationCheckResult sets ViolationCheckResult field to given value. + +### HasViolationCheckResult + +`func (o *SodViolationContextCheckCompleted) HasViolationCheckResult() bool` + +HasViolationCheckResult returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SodViolationContextConflictingAccessCriteria.md b/docs/tools/sdk/go/Reference/V3/Models/SodViolationContextConflictingAccessCriteria.md new file mode 100644 index 000000000..0da88624e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SodViolationContextConflictingAccessCriteria.md @@ -0,0 +1,90 @@ +--- +id: sod-violation-context-conflicting-access-criteria +title: SodViolationContextConflictingAccessCriteria +pagination_label: SodViolationContextConflictingAccessCriteria +sidebar_label: SodViolationContextConflictingAccessCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContextConflictingAccessCriteria', 'SodViolationContextConflictingAccessCriteria'] +slug: /tools/sdk/go/v3/models/sod-violation-context-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteria', 'SodViolationContextConflictingAccessCriteria'] +--- + +# SodViolationContextConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] +**RightCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] + +## Methods + +### NewSodViolationContextConflictingAccessCriteria + +`func NewSodViolationContextConflictingAccessCriteria() *SodViolationContextConflictingAccessCriteria` + +NewSodViolationContextConflictingAccessCriteria instantiates a new SodViolationContextConflictingAccessCriteria 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 + +### NewSodViolationContextConflictingAccessCriteriaWithDefaults + +`func NewSodViolationContextConflictingAccessCriteriaWithDefaults() *SodViolationContextConflictingAccessCriteria` + +NewSodViolationContextConflictingAccessCriteriaWithDefaults instantiates a new SodViolationContextConflictingAccessCriteria 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 + +### GetLeftCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) GetLeftCriteria() SodViolationContextConflictingAccessCriteriaLeftCriteria` + +GetLeftCriteria returns the LeftCriteria field if non-nil, zero value otherwise. + +### GetLeftCriteriaOk + +`func (o *SodViolationContextConflictingAccessCriteria) GetLeftCriteriaOk() (*SodViolationContextConflictingAccessCriteriaLeftCriteria, bool)` + +GetLeftCriteriaOk returns a tuple with the LeftCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeftCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) SetLeftCriteria(v SodViolationContextConflictingAccessCriteriaLeftCriteria)` + +SetLeftCriteria sets LeftCriteria field to given value. + +### HasLeftCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) HasLeftCriteria() bool` + +HasLeftCriteria returns a boolean if a field has been set. + +### GetRightCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) GetRightCriteria() SodViolationContextConflictingAccessCriteriaLeftCriteria` + +GetRightCriteria returns the RightCriteria field if non-nil, zero value otherwise. + +### GetRightCriteriaOk + +`func (o *SodViolationContextConflictingAccessCriteria) GetRightCriteriaOk() (*SodViolationContextConflictingAccessCriteriaLeftCriteria, bool)` + +GetRightCriteriaOk returns a tuple with the RightCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRightCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) SetRightCriteria(v SodViolationContextConflictingAccessCriteriaLeftCriteria)` + +SetRightCriteria sets RightCriteria field to given value. + +### HasRightCriteria + +`func (o *SodViolationContextConflictingAccessCriteria) HasRightCriteria() bool` + +HasRightCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/go/Reference/V3/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md new file mode 100644 index 000000000..61437af73 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md @@ -0,0 +1,64 @@ +--- +id: sod-violation-context-conflicting-access-criteria-left-criteria +title: SodViolationContextConflictingAccessCriteriaLeftCriteria +pagination_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'SodViolationContextConflictingAccessCriteriaLeftCriteria'] +slug: /tools/sdk/go/v3/models/sod-violation-context-conflicting-access-criteria-left-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'SodViolationContextConflictingAccessCriteriaLeftCriteria'] +--- + +# SodViolationContextConflictingAccessCriteriaLeftCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]SodExemptCriteria**](sod-exempt-criteria) | | [optional] + +## Methods + +### NewSodViolationContextConflictingAccessCriteriaLeftCriteria + +`func NewSodViolationContextConflictingAccessCriteriaLeftCriteria() *SodViolationContextConflictingAccessCriteriaLeftCriteria` + +NewSodViolationContextConflictingAccessCriteriaLeftCriteria instantiates a new SodViolationContextConflictingAccessCriteriaLeftCriteria 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 + +### NewSodViolationContextConflictingAccessCriteriaLeftCriteriaWithDefaults + +`func NewSodViolationContextConflictingAccessCriteriaLeftCriteriaWithDefaults() *SodViolationContextConflictingAccessCriteriaLeftCriteria` + +NewSodViolationContextConflictingAccessCriteriaLeftCriteriaWithDefaults instantiates a new SodViolationContextConflictingAccessCriteriaLeftCriteria 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 + +### GetCriteriaList + +`func (o *SodViolationContextConflictingAccessCriteriaLeftCriteria) GetCriteriaList() []SodExemptCriteria` + +GetCriteriaList returns the CriteriaList field if non-nil, zero value otherwise. + +### GetCriteriaListOk + +`func (o *SodViolationContextConflictingAccessCriteriaLeftCriteria) GetCriteriaListOk() (*[]SodExemptCriteria, bool)` + +GetCriteriaListOk returns a tuple with the CriteriaList field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCriteriaList + +`func (o *SodViolationContextConflictingAccessCriteriaLeftCriteria) SetCriteriaList(v []SodExemptCriteria)` + +SetCriteriaList sets CriteriaList field to given value. + +### HasCriteriaList + +`func (o *SodViolationContextConflictingAccessCriteriaLeftCriteria) HasCriteriaList() bool` + +HasCriteriaList returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Source.md b/docs/tools/sdk/go/Reference/V3/Models/Source.md new file mode 100644 index 000000000..a9a725c23 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Source.md @@ -0,0 +1,909 @@ +--- +id: source +title: Source +pagination_label: Source +sidebar_label: Source +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Source', 'Source'] +slug: /tools/sdk/go/v3/models/source +tags: ['SDK', 'Software Development Kit', 'Source', 'Source'] +--- + +# Source + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Source ID. | [optional] [readonly] +**Name** | **string** | Source's human-readable name. | +**Description** | Pointer to **string** | Source's human-readable description. | [optional] +**Owner** | [**SourceOwner**](source-owner) | | +**Cluster** | Pointer to [**NullableSourceCluster**](source-cluster) | | [optional] +**AccountCorrelationConfig** | Pointer to [**NullableSourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional] +**AccountCorrelationRule** | Pointer to [**NullableSourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional] +**ManagerCorrelationMapping** | Pointer to [**SourceManagerCorrelationMapping**](source-manager-correlation-mapping) | | [optional] +**ManagerCorrelationRule** | Pointer to [**NullableSourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional] +**BeforeProvisioningRule** | Pointer to [**NullableSourceBeforeProvisioningRule**](source-before-provisioning-rule) | | [optional] +**Schemas** | Pointer to [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional] +**PasswordPolicies** | Pointer to [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**Features** | Pointer to **[]string** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Type** | Pointer to **string** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Connector** | **string** | Connector script name. | +**ConnectorClass** | Pointer to **string** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**ConnectorAttributes** | Pointer to **map[string]interface{}** | Connector specific configuration. This configuration will differ from type to type. | [optional] +**DeleteThreshold** | Pointer to **int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**Authoritative** | Pointer to **bool** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to false] +**ManagementWorkgroup** | Pointer to [**NullableSourceManagementWorkgroup**](source-management-workgroup) | | [optional] +**Healthy** | Pointer to **bool** | When this is true, it indicates that the source is healthy. | [optional] [default to false] +**Status** | Pointer to **string** | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**Since** | Pointer to **string** | Timestamp that shows when a source health check was last performed. | [optional] +**ConnectorId** | Pointer to **string** | Connector ID | [optional] +**ConnectorName** | Pointer to **string** | Name of the connector that was chosen during source creation. | [optional] +**ConnectionType** | Pointer to **string** | Type of connection (direct or file). | [optional] +**ConnectorImplementationId** | Pointer to **string** | Connector implementation ID. | [optional] +**Created** | Pointer to **SailPointTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **SailPointTime** | Date-time when the source was last modified. | [optional] +**CredentialProviderEnabled** | Pointer to **bool** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to false] +**Category** | Pointer to **NullableString** | Source category (e.g. null, CredentialProvider). | [optional] + +## Methods + +### NewSource + +`func NewSource(name string, owner SourceOwner, connector string, ) *Source` + +NewSource instantiates a new Source 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 + +### NewSourceWithDefaults + +`func NewSourceWithDefaults() *Source` + +NewSourceWithDefaults instantiates a new Source 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 + +### GetId + +`func (o *Source) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Source) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Source) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Source) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Source) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Source) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Source) SetName(v string)` + +SetName sets Name field to given value. + + +### GetDescription + +`func (o *Source) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Source) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Source) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Source) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetOwner + +`func (o *Source) GetOwner() SourceOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Source) GetOwnerOk() (*SourceOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Source) SetOwner(v SourceOwner)` + +SetOwner sets Owner field to given value. + + +### GetCluster + +`func (o *Source) GetCluster() SourceCluster` + +GetCluster returns the Cluster field if non-nil, zero value otherwise. + +### GetClusterOk + +`func (o *Source) GetClusterOk() (*SourceCluster, bool)` + +GetClusterOk returns a tuple with the Cluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCluster + +`func (o *Source) SetCluster(v SourceCluster)` + +SetCluster sets Cluster field to given value. + +### HasCluster + +`func (o *Source) HasCluster() bool` + +HasCluster returns a boolean if a field has been set. + +### SetClusterNil + +`func (o *Source) SetClusterNil(b bool)` + + SetClusterNil sets the value for Cluster to be an explicit nil + +### UnsetCluster +`func (o *Source) UnsetCluster()` + +UnsetCluster ensures that no value is present for Cluster, not even an explicit nil +### GetAccountCorrelationConfig + +`func (o *Source) GetAccountCorrelationConfig() SourceAccountCorrelationConfig` + +GetAccountCorrelationConfig returns the AccountCorrelationConfig field if non-nil, zero value otherwise. + +### GetAccountCorrelationConfigOk + +`func (o *Source) GetAccountCorrelationConfigOk() (*SourceAccountCorrelationConfig, bool)` + +GetAccountCorrelationConfigOk returns a tuple with the AccountCorrelationConfig field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationConfig + +`func (o *Source) SetAccountCorrelationConfig(v SourceAccountCorrelationConfig)` + +SetAccountCorrelationConfig sets AccountCorrelationConfig field to given value. + +### HasAccountCorrelationConfig + +`func (o *Source) HasAccountCorrelationConfig() bool` + +HasAccountCorrelationConfig returns a boolean if a field has been set. + +### SetAccountCorrelationConfigNil + +`func (o *Source) SetAccountCorrelationConfigNil(b bool)` + + SetAccountCorrelationConfigNil sets the value for AccountCorrelationConfig to be an explicit nil + +### UnsetAccountCorrelationConfig +`func (o *Source) UnsetAccountCorrelationConfig()` + +UnsetAccountCorrelationConfig ensures that no value is present for AccountCorrelationConfig, not even an explicit nil +### GetAccountCorrelationRule + +`func (o *Source) GetAccountCorrelationRule() SourceAccountCorrelationRule` + +GetAccountCorrelationRule returns the AccountCorrelationRule field if non-nil, zero value otherwise. + +### GetAccountCorrelationRuleOk + +`func (o *Source) GetAccountCorrelationRuleOk() (*SourceAccountCorrelationRule, bool)` + +GetAccountCorrelationRuleOk returns a tuple with the AccountCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountCorrelationRule + +`func (o *Source) SetAccountCorrelationRule(v SourceAccountCorrelationRule)` + +SetAccountCorrelationRule sets AccountCorrelationRule field to given value. + +### HasAccountCorrelationRule + +`func (o *Source) HasAccountCorrelationRule() bool` + +HasAccountCorrelationRule returns a boolean if a field has been set. + +### SetAccountCorrelationRuleNil + +`func (o *Source) SetAccountCorrelationRuleNil(b bool)` + + SetAccountCorrelationRuleNil sets the value for AccountCorrelationRule to be an explicit nil + +### UnsetAccountCorrelationRule +`func (o *Source) UnsetAccountCorrelationRule()` + +UnsetAccountCorrelationRule ensures that no value is present for AccountCorrelationRule, not even an explicit nil +### GetManagerCorrelationMapping + +`func (o *Source) GetManagerCorrelationMapping() SourceManagerCorrelationMapping` + +GetManagerCorrelationMapping returns the ManagerCorrelationMapping field if non-nil, zero value otherwise. + +### GetManagerCorrelationMappingOk + +`func (o *Source) GetManagerCorrelationMappingOk() (*SourceManagerCorrelationMapping, bool)` + +GetManagerCorrelationMappingOk returns a tuple with the ManagerCorrelationMapping field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationMapping + +`func (o *Source) SetManagerCorrelationMapping(v SourceManagerCorrelationMapping)` + +SetManagerCorrelationMapping sets ManagerCorrelationMapping field to given value. + +### HasManagerCorrelationMapping + +`func (o *Source) HasManagerCorrelationMapping() bool` + +HasManagerCorrelationMapping returns a boolean if a field has been set. + +### GetManagerCorrelationRule + +`func (o *Source) GetManagerCorrelationRule() SourceManagerCorrelationRule` + +GetManagerCorrelationRule returns the ManagerCorrelationRule field if non-nil, zero value otherwise. + +### GetManagerCorrelationRuleOk + +`func (o *Source) GetManagerCorrelationRuleOk() (*SourceManagerCorrelationRule, bool)` + +GetManagerCorrelationRuleOk returns a tuple with the ManagerCorrelationRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagerCorrelationRule + +`func (o *Source) SetManagerCorrelationRule(v SourceManagerCorrelationRule)` + +SetManagerCorrelationRule sets ManagerCorrelationRule field to given value. + +### HasManagerCorrelationRule + +`func (o *Source) HasManagerCorrelationRule() bool` + +HasManagerCorrelationRule returns a boolean if a field has been set. + +### SetManagerCorrelationRuleNil + +`func (o *Source) SetManagerCorrelationRuleNil(b bool)` + + SetManagerCorrelationRuleNil sets the value for ManagerCorrelationRule to be an explicit nil + +### UnsetManagerCorrelationRule +`func (o *Source) UnsetManagerCorrelationRule()` + +UnsetManagerCorrelationRule ensures that no value is present for ManagerCorrelationRule, not even an explicit nil +### GetBeforeProvisioningRule + +`func (o *Source) GetBeforeProvisioningRule() SourceBeforeProvisioningRule` + +GetBeforeProvisioningRule returns the BeforeProvisioningRule field if non-nil, zero value otherwise. + +### GetBeforeProvisioningRuleOk + +`func (o *Source) GetBeforeProvisioningRuleOk() (*SourceBeforeProvisioningRule, bool)` + +GetBeforeProvisioningRuleOk returns a tuple with the BeforeProvisioningRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBeforeProvisioningRule + +`func (o *Source) SetBeforeProvisioningRule(v SourceBeforeProvisioningRule)` + +SetBeforeProvisioningRule sets BeforeProvisioningRule field to given value. + +### HasBeforeProvisioningRule + +`func (o *Source) HasBeforeProvisioningRule() bool` + +HasBeforeProvisioningRule returns a boolean if a field has been set. + +### SetBeforeProvisioningRuleNil + +`func (o *Source) SetBeforeProvisioningRuleNil(b bool)` + + SetBeforeProvisioningRuleNil sets the value for BeforeProvisioningRule to be an explicit nil + +### UnsetBeforeProvisioningRule +`func (o *Source) UnsetBeforeProvisioningRule()` + +UnsetBeforeProvisioningRule ensures that no value is present for BeforeProvisioningRule, not even an explicit nil +### GetSchemas + +`func (o *Source) GetSchemas() []SourceSchemasInner` + +GetSchemas returns the Schemas field if non-nil, zero value otherwise. + +### GetSchemasOk + +`func (o *Source) GetSchemasOk() (*[]SourceSchemasInner, bool)` + +GetSchemasOk returns a tuple with the Schemas field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSchemas + +`func (o *Source) SetSchemas(v []SourceSchemasInner)` + +SetSchemas sets Schemas field to given value. + +### HasSchemas + +`func (o *Source) HasSchemas() bool` + +HasSchemas returns a boolean if a field has been set. + +### GetPasswordPolicies + +`func (o *Source) GetPasswordPolicies() []SourcePasswordPoliciesInner` + +GetPasswordPolicies returns the PasswordPolicies field if non-nil, zero value otherwise. + +### GetPasswordPoliciesOk + +`func (o *Source) GetPasswordPoliciesOk() (*[]SourcePasswordPoliciesInner, bool)` + +GetPasswordPoliciesOk returns a tuple with the PasswordPolicies field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPasswordPolicies + +`func (o *Source) SetPasswordPolicies(v []SourcePasswordPoliciesInner)` + +SetPasswordPolicies sets PasswordPolicies field to given value. + +### HasPasswordPolicies + +`func (o *Source) HasPasswordPolicies() bool` + +HasPasswordPolicies returns a boolean if a field has been set. + +### SetPasswordPoliciesNil + +`func (o *Source) SetPasswordPoliciesNil(b bool)` + + SetPasswordPoliciesNil sets the value for PasswordPolicies to be an explicit nil + +### UnsetPasswordPolicies +`func (o *Source) UnsetPasswordPolicies()` + +UnsetPasswordPolicies ensures that no value is present for PasswordPolicies, not even an explicit nil +### GetFeatures + +`func (o *Source) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *Source) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *Source) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *Source) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### GetType + +`func (o *Source) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Source) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Source) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Source) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetConnector + +`func (o *Source) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *Source) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *Source) SetConnector(v string)` + +SetConnector sets Connector field to given value. + + +### GetConnectorClass + +`func (o *Source) GetConnectorClass() string` + +GetConnectorClass returns the ConnectorClass field if non-nil, zero value otherwise. + +### GetConnectorClassOk + +`func (o *Source) GetConnectorClassOk() (*string, bool)` + +GetConnectorClassOk returns a tuple with the ConnectorClass field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorClass + +`func (o *Source) SetConnectorClass(v string)` + +SetConnectorClass sets ConnectorClass field to given value. + +### HasConnectorClass + +`func (o *Source) HasConnectorClass() bool` + +HasConnectorClass returns a boolean if a field has been set. + +### GetConnectorAttributes + +`func (o *Source) GetConnectorAttributes() map[string]interface{}` + +GetConnectorAttributes returns the ConnectorAttributes field if non-nil, zero value otherwise. + +### GetConnectorAttributesOk + +`func (o *Source) GetConnectorAttributesOk() (*map[string]interface{}, bool)` + +GetConnectorAttributesOk returns a tuple with the ConnectorAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorAttributes + +`func (o *Source) SetConnectorAttributes(v map[string]interface{})` + +SetConnectorAttributes sets ConnectorAttributes field to given value. + +### HasConnectorAttributes + +`func (o *Source) HasConnectorAttributes() bool` + +HasConnectorAttributes returns a boolean if a field has been set. + +### GetDeleteThreshold + +`func (o *Source) GetDeleteThreshold() int32` + +GetDeleteThreshold returns the DeleteThreshold field if non-nil, zero value otherwise. + +### GetDeleteThresholdOk + +`func (o *Source) GetDeleteThresholdOk() (*int32, bool)` + +GetDeleteThresholdOk returns a tuple with the DeleteThreshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleteThreshold + +`func (o *Source) SetDeleteThreshold(v int32)` + +SetDeleteThreshold sets DeleteThreshold field to given value. + +### HasDeleteThreshold + +`func (o *Source) HasDeleteThreshold() bool` + +HasDeleteThreshold returns a boolean if a field has been set. + +### GetAuthoritative + +`func (o *Source) GetAuthoritative() bool` + +GetAuthoritative returns the Authoritative field if non-nil, zero value otherwise. + +### GetAuthoritativeOk + +`func (o *Source) GetAuthoritativeOk() (*bool, bool)` + +GetAuthoritativeOk returns a tuple with the Authoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAuthoritative + +`func (o *Source) SetAuthoritative(v bool)` + +SetAuthoritative sets Authoritative field to given value. + +### HasAuthoritative + +`func (o *Source) HasAuthoritative() bool` + +HasAuthoritative returns a boolean if a field has been set. + +### GetManagementWorkgroup + +`func (o *Source) GetManagementWorkgroup() SourceManagementWorkgroup` + +GetManagementWorkgroup returns the ManagementWorkgroup field if non-nil, zero value otherwise. + +### GetManagementWorkgroupOk + +`func (o *Source) GetManagementWorkgroupOk() (*SourceManagementWorkgroup, bool)` + +GetManagementWorkgroupOk returns a tuple with the ManagementWorkgroup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetManagementWorkgroup + +`func (o *Source) SetManagementWorkgroup(v SourceManagementWorkgroup)` + +SetManagementWorkgroup sets ManagementWorkgroup field to given value. + +### HasManagementWorkgroup + +`func (o *Source) HasManagementWorkgroup() bool` + +HasManagementWorkgroup returns a boolean if a field has been set. + +### SetManagementWorkgroupNil + +`func (o *Source) SetManagementWorkgroupNil(b bool)` + + SetManagementWorkgroupNil sets the value for ManagementWorkgroup to be an explicit nil + +### UnsetManagementWorkgroup +`func (o *Source) UnsetManagementWorkgroup()` + +UnsetManagementWorkgroup ensures that no value is present for ManagementWorkgroup, not even an explicit nil +### GetHealthy + +`func (o *Source) GetHealthy() bool` + +GetHealthy returns the Healthy field if non-nil, zero value otherwise. + +### GetHealthyOk + +`func (o *Source) GetHealthyOk() (*bool, bool)` + +GetHealthyOk returns a tuple with the Healthy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHealthy + +`func (o *Source) SetHealthy(v bool)` + +SetHealthy sets Healthy field to given value. + +### HasHealthy + +`func (o *Source) HasHealthy() bool` + +HasHealthy returns a boolean if a field has been set. + +### GetStatus + +`func (o *Source) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Source) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Source) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Source) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSince + +`func (o *Source) GetSince() string` + +GetSince returns the Since field if non-nil, zero value otherwise. + +### GetSinceOk + +`func (o *Source) GetSinceOk() (*string, bool)` + +GetSinceOk returns a tuple with the Since field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSince + +`func (o *Source) SetSince(v string)` + +SetSince sets Since field to given value. + +### HasSince + +`func (o *Source) HasSince() bool` + +HasSince returns a boolean if a field has been set. + +### GetConnectorId + +`func (o *Source) GetConnectorId() string` + +GetConnectorId returns the ConnectorId field if non-nil, zero value otherwise. + +### GetConnectorIdOk + +`func (o *Source) GetConnectorIdOk() (*string, bool)` + +GetConnectorIdOk returns a tuple with the ConnectorId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorId + +`func (o *Source) SetConnectorId(v string)` + +SetConnectorId sets ConnectorId field to given value. + +### HasConnectorId + +`func (o *Source) HasConnectorId() bool` + +HasConnectorId returns a boolean if a field has been set. + +### GetConnectorName + +`func (o *Source) GetConnectorName() string` + +GetConnectorName returns the ConnectorName field if non-nil, zero value otherwise. + +### GetConnectorNameOk + +`func (o *Source) GetConnectorNameOk() (*string, bool)` + +GetConnectorNameOk returns a tuple with the ConnectorName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorName + +`func (o *Source) SetConnectorName(v string)` + +SetConnectorName sets ConnectorName field to given value. + +### HasConnectorName + +`func (o *Source) HasConnectorName() bool` + +HasConnectorName returns a boolean if a field has been set. + +### GetConnectionType + +`func (o *Source) GetConnectionType() string` + +GetConnectionType returns the ConnectionType field if non-nil, zero value otherwise. + +### GetConnectionTypeOk + +`func (o *Source) GetConnectionTypeOk() (*string, bool)` + +GetConnectionTypeOk returns a tuple with the ConnectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectionType + +`func (o *Source) SetConnectionType(v string)` + +SetConnectionType sets ConnectionType field to given value. + +### HasConnectionType + +`func (o *Source) HasConnectionType() bool` + +HasConnectionType returns a boolean if a field has been set. + +### GetConnectorImplementationId + +`func (o *Source) GetConnectorImplementationId() string` + +GetConnectorImplementationId returns the ConnectorImplementationId field if non-nil, zero value otherwise. + +### GetConnectorImplementationIdOk + +`func (o *Source) GetConnectorImplementationIdOk() (*string, bool)` + +GetConnectorImplementationIdOk returns a tuple with the ConnectorImplementationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorImplementationId + +`func (o *Source) SetConnectorImplementationId(v string)` + +SetConnectorImplementationId sets ConnectorImplementationId field to given value. + +### HasConnectorImplementationId + +`func (o *Source) HasConnectorImplementationId() bool` + +HasConnectorImplementationId returns a boolean if a field has been set. + +### GetCreated + +`func (o *Source) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Source) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Source) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Source) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Source) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Source) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Source) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Source) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetCredentialProviderEnabled + +`func (o *Source) GetCredentialProviderEnabled() bool` + +GetCredentialProviderEnabled returns the CredentialProviderEnabled field if non-nil, zero value otherwise. + +### GetCredentialProviderEnabledOk + +`func (o *Source) GetCredentialProviderEnabledOk() (*bool, bool)` + +GetCredentialProviderEnabledOk returns a tuple with the CredentialProviderEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialProviderEnabled + +`func (o *Source) SetCredentialProviderEnabled(v bool)` + +SetCredentialProviderEnabled sets CredentialProviderEnabled field to given value. + +### HasCredentialProviderEnabled + +`func (o *Source) HasCredentialProviderEnabled() bool` + +HasCredentialProviderEnabled returns a boolean if a field has been set. + +### GetCategory + +`func (o *Source) GetCategory() string` + +GetCategory returns the Category field if non-nil, zero value otherwise. + +### GetCategoryOk + +`func (o *Source) GetCategoryOk() (*string, bool)` + +GetCategoryOk returns a tuple with the Category field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCategory + +`func (o *Source) SetCategory(v string)` + +SetCategory sets Category field to given value. + +### HasCategory + +`func (o *Source) HasCategory() bool` + +HasCategory returns a boolean if a field has been set. + +### SetCategoryNil + +`func (o *Source) SetCategoryNil(b bool)` + + SetCategoryNil sets the value for Category to be an explicit nil + +### UnsetCategory +`func (o *Source) UnsetCategory()` + +UnsetCategory ensures that no value is present for Category, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SourceAccountCorrelationConfig.md b/docs/tools/sdk/go/Reference/V3/Models/SourceAccountCorrelationConfig.md new file mode 100644 index 000000000..eb47eeb97 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SourceAccountCorrelationConfig.md @@ -0,0 +1,116 @@ +--- +id: source-account-correlation-config +title: SourceAccountCorrelationConfig +pagination_label: SourceAccountCorrelationConfig +sidebar_label: SourceAccountCorrelationConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountCorrelationConfig', 'SourceAccountCorrelationConfig'] +slug: /tools/sdk/go/v3/models/source-account-correlation-config +tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationConfig', 'SourceAccountCorrelationConfig'] +--- + +# SourceAccountCorrelationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Account correlation config ID. | [optional] +**Name** | Pointer to **string** | Account correlation config's human-readable display name. | [optional] + +## Methods + +### NewSourceAccountCorrelationConfig + +`func NewSourceAccountCorrelationConfig() *SourceAccountCorrelationConfig` + +NewSourceAccountCorrelationConfig instantiates a new SourceAccountCorrelationConfig 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 + +### NewSourceAccountCorrelationConfigWithDefaults + +`func NewSourceAccountCorrelationConfigWithDefaults() *SourceAccountCorrelationConfig` + +NewSourceAccountCorrelationConfigWithDefaults instantiates a new SourceAccountCorrelationConfig 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 + +### GetType + +`func (o *SourceAccountCorrelationConfig) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceAccountCorrelationConfig) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceAccountCorrelationConfig) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceAccountCorrelationConfig) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceAccountCorrelationConfig) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountCorrelationConfig) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountCorrelationConfig) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceAccountCorrelationConfig) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAccountCorrelationConfig) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAccountCorrelationConfig) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAccountCorrelationConfig) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAccountCorrelationConfig) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SourceAccountCorrelationRule.md b/docs/tools/sdk/go/Reference/V3/Models/SourceAccountCorrelationRule.md new file mode 100644 index 000000000..37fe4f82a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SourceAccountCorrelationRule.md @@ -0,0 +1,116 @@ +--- +id: source-account-correlation-rule +title: SourceAccountCorrelationRule +pagination_label: SourceAccountCorrelationRule +sidebar_label: SourceAccountCorrelationRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceAccountCorrelationRule', 'SourceAccountCorrelationRule'] +slug: /tools/sdk/go/v3/models/source-account-correlation-rule +tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationRule', 'SourceAccountCorrelationRule'] +--- + +# SourceAccountCorrelationRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Rule ID. | [optional] +**Name** | Pointer to **string** | Rule's human-readable display name. | [optional] + +## Methods + +### NewSourceAccountCorrelationRule + +`func NewSourceAccountCorrelationRule() *SourceAccountCorrelationRule` + +NewSourceAccountCorrelationRule instantiates a new SourceAccountCorrelationRule 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 + +### NewSourceAccountCorrelationRuleWithDefaults + +`func NewSourceAccountCorrelationRuleWithDefaults() *SourceAccountCorrelationRule` + +NewSourceAccountCorrelationRuleWithDefaults instantiates a new SourceAccountCorrelationRule 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 + +### GetType + +`func (o *SourceAccountCorrelationRule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceAccountCorrelationRule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceAccountCorrelationRule) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceAccountCorrelationRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceAccountCorrelationRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceAccountCorrelationRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceAccountCorrelationRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceAccountCorrelationRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceAccountCorrelationRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceAccountCorrelationRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceAccountCorrelationRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceAccountCorrelationRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SourceBeforeProvisioningRule.md b/docs/tools/sdk/go/Reference/V3/Models/SourceBeforeProvisioningRule.md new file mode 100644 index 000000000..7f8c74d84 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SourceBeforeProvisioningRule.md @@ -0,0 +1,116 @@ +--- +id: source-before-provisioning-rule +title: SourceBeforeProvisioningRule +pagination_label: SourceBeforeProvisioningRule +sidebar_label: SourceBeforeProvisioningRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceBeforeProvisioningRule', 'SourceBeforeProvisioningRule'] +slug: /tools/sdk/go/v3/models/source-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'SourceBeforeProvisioningRule', 'SourceBeforeProvisioningRule'] +--- + +# SourceBeforeProvisioningRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Rule ID. | [optional] +**Name** | Pointer to **string** | Rule's human-readable display name. | [optional] + +## Methods + +### NewSourceBeforeProvisioningRule + +`func NewSourceBeforeProvisioningRule() *SourceBeforeProvisioningRule` + +NewSourceBeforeProvisioningRule instantiates a new SourceBeforeProvisioningRule 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 + +### NewSourceBeforeProvisioningRuleWithDefaults + +`func NewSourceBeforeProvisioningRuleWithDefaults() *SourceBeforeProvisioningRule` + +NewSourceBeforeProvisioningRuleWithDefaults instantiates a new SourceBeforeProvisioningRule 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 + +### GetType + +`func (o *SourceBeforeProvisioningRule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceBeforeProvisioningRule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceBeforeProvisioningRule) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceBeforeProvisioningRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceBeforeProvisioningRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceBeforeProvisioningRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceBeforeProvisioningRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceBeforeProvisioningRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceBeforeProvisioningRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceBeforeProvisioningRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceBeforeProvisioningRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceBeforeProvisioningRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SourceCluster.md b/docs/tools/sdk/go/Reference/V3/Models/SourceCluster.md new file mode 100644 index 000000000..a2570b171 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SourceCluster.md @@ -0,0 +1,101 @@ +--- +id: source-cluster +title: SourceCluster +pagination_label: SourceCluster +sidebar_label: SourceCluster +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceCluster', 'SourceCluster'] +slug: /tools/sdk/go/v3/models/source-cluster +tags: ['SDK', 'Software Development Kit', 'SourceCluster', 'SourceCluster'] +--- + +# SourceCluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | Type of object being referenced. | +**Id** | **string** | Cluster ID. | +**Name** | **string** | Cluster's human-readable display name. | + +## Methods + +### NewSourceCluster + +`func NewSourceCluster(type_ string, id string, name string, ) *SourceCluster` + +NewSourceCluster instantiates a new SourceCluster 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 + +### NewSourceClusterWithDefaults + +`func NewSourceClusterWithDefaults() *SourceCluster` + +NewSourceClusterWithDefaults instantiates a new SourceCluster 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 + +### GetType + +`func (o *SourceCluster) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceCluster) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceCluster) SetType(v string)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *SourceCluster) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceCluster) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceCluster) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *SourceCluster) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceCluster) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceCluster) SetName(v string)` + +SetName sets Name field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SourceClusterDto.md b/docs/tools/sdk/go/Reference/V3/Models/SourceClusterDto.md new file mode 100644 index 000000000..a4a4f4f71 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SourceClusterDto.md @@ -0,0 +1,116 @@ +--- +id: source-cluster-dto +title: SourceClusterDto +pagination_label: SourceClusterDto +sidebar_label: SourceClusterDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceClusterDto', 'SourceClusterDto'] +slug: /tools/sdk/go/v3/models/source-cluster-dto +tags: ['SDK', 'Software Development Kit', 'SourceClusterDto', 'SourceClusterDto'] +--- + +# SourceClusterDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Source cluster DTO type. | [optional] +**Id** | Pointer to **string** | Source cluster ID. | [optional] +**Name** | Pointer to **string** | Source cluster display name. | [optional] + +## Methods + +### NewSourceClusterDto + +`func NewSourceClusterDto() *SourceClusterDto` + +NewSourceClusterDto instantiates a new SourceClusterDto 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 + +### NewSourceClusterDtoWithDefaults + +`func NewSourceClusterDtoWithDefaults() *SourceClusterDto` + +NewSourceClusterDtoWithDefaults instantiates a new SourceClusterDto 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 + +### GetType + +`func (o *SourceClusterDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceClusterDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceClusterDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceClusterDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceClusterDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceClusterDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceClusterDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceClusterDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceClusterDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceClusterDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceClusterDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceClusterDto) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SourceConnectionsDto.md b/docs/tools/sdk/go/Reference/V3/Models/SourceConnectionsDto.md new file mode 100644 index 000000000..b30ab34a3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SourceConnectionsDto.md @@ -0,0 +1,220 @@ +--- +id: source-connections-dto +title: SourceConnectionsDto +pagination_label: SourceConnectionsDto +sidebar_label: SourceConnectionsDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceConnectionsDto', 'SourceConnectionsDto'] +slug: /tools/sdk/go/v3/models/source-connections-dto +tags: ['SDK', 'Software Development Kit', 'SourceConnectionsDto', 'SourceConnectionsDto'] +--- + +# SourceConnectionsDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityProfiles** | Pointer to [**[]IdentityProfilesConnections**](identity-profiles-connections) | The IdentityProfile attached to this source | [optional] +**CredentialProfiles** | Pointer to **[]string** | Name of the CredentialProfile attached to this source | [optional] +**SourceAttributes** | Pointer to **[]string** | The attributes attached to this source | [optional] +**MappingProfiles** | Pointer to **[]string** | The profiles attached to this source | [optional] +**DependentCustomTransforms** | Pointer to [**[]TransformRead**](transform-read) | A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName. | [optional] +**DependentApps** | Pointer to [**[]DependantAppConnections**](dependant-app-connections) | | [optional] +**MissingDependents** | Pointer to [**[]DependantConnectionsMissingDto**](dependant-connections-missing-dto) | | [optional] + +## Methods + +### NewSourceConnectionsDto + +`func NewSourceConnectionsDto() *SourceConnectionsDto` + +NewSourceConnectionsDto instantiates a new SourceConnectionsDto 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 + +### NewSourceConnectionsDtoWithDefaults + +`func NewSourceConnectionsDtoWithDefaults() *SourceConnectionsDto` + +NewSourceConnectionsDtoWithDefaults instantiates a new SourceConnectionsDto 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 + +### GetIdentityProfiles + +`func (o *SourceConnectionsDto) GetIdentityProfiles() []IdentityProfilesConnections` + +GetIdentityProfiles returns the IdentityProfiles field if non-nil, zero value otherwise. + +### GetIdentityProfilesOk + +`func (o *SourceConnectionsDto) GetIdentityProfilesOk() (*[]IdentityProfilesConnections, bool)` + +GetIdentityProfilesOk returns a tuple with the IdentityProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityProfiles + +`func (o *SourceConnectionsDto) SetIdentityProfiles(v []IdentityProfilesConnections)` + +SetIdentityProfiles sets IdentityProfiles field to given value. + +### HasIdentityProfiles + +`func (o *SourceConnectionsDto) HasIdentityProfiles() bool` + +HasIdentityProfiles returns a boolean if a field has been set. + +### GetCredentialProfiles + +`func (o *SourceConnectionsDto) GetCredentialProfiles() []string` + +GetCredentialProfiles returns the CredentialProfiles field if non-nil, zero value otherwise. + +### GetCredentialProfilesOk + +`func (o *SourceConnectionsDto) GetCredentialProfilesOk() (*[]string, bool)` + +GetCredentialProfilesOk returns a tuple with the CredentialProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentialProfiles + +`func (o *SourceConnectionsDto) SetCredentialProfiles(v []string)` + +SetCredentialProfiles sets CredentialProfiles field to given value. + +### HasCredentialProfiles + +`func (o *SourceConnectionsDto) HasCredentialProfiles() bool` + +HasCredentialProfiles returns a boolean if a field has been set. + +### GetSourceAttributes + +`func (o *SourceConnectionsDto) GetSourceAttributes() []string` + +GetSourceAttributes returns the SourceAttributes field if non-nil, zero value otherwise. + +### GetSourceAttributesOk + +`func (o *SourceConnectionsDto) GetSourceAttributesOk() (*[]string, bool)` + +GetSourceAttributesOk returns a tuple with the SourceAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceAttributes + +`func (o *SourceConnectionsDto) SetSourceAttributes(v []string)` + +SetSourceAttributes sets SourceAttributes field to given value. + +### HasSourceAttributes + +`func (o *SourceConnectionsDto) HasSourceAttributes() bool` + +HasSourceAttributes returns a boolean if a field has been set. + +### GetMappingProfiles + +`func (o *SourceConnectionsDto) GetMappingProfiles() []string` + +GetMappingProfiles returns the MappingProfiles field if non-nil, zero value otherwise. + +### GetMappingProfilesOk + +`func (o *SourceConnectionsDto) GetMappingProfilesOk() (*[]string, bool)` + +GetMappingProfilesOk returns a tuple with the MappingProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMappingProfiles + +`func (o *SourceConnectionsDto) SetMappingProfiles(v []string)` + +SetMappingProfiles sets MappingProfiles field to given value. + +### HasMappingProfiles + +`func (o *SourceConnectionsDto) HasMappingProfiles() bool` + +HasMappingProfiles returns a boolean if a field has been set. + +### GetDependentCustomTransforms + +`func (o *SourceConnectionsDto) GetDependentCustomTransforms() []TransformRead` + +GetDependentCustomTransforms returns the DependentCustomTransforms field if non-nil, zero value otherwise. + +### GetDependentCustomTransformsOk + +`func (o *SourceConnectionsDto) GetDependentCustomTransformsOk() (*[]TransformRead, bool)` + +GetDependentCustomTransformsOk returns a tuple with the DependentCustomTransforms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDependentCustomTransforms + +`func (o *SourceConnectionsDto) SetDependentCustomTransforms(v []TransformRead)` + +SetDependentCustomTransforms sets DependentCustomTransforms field to given value. + +### HasDependentCustomTransforms + +`func (o *SourceConnectionsDto) HasDependentCustomTransforms() bool` + +HasDependentCustomTransforms returns a boolean if a field has been set. + +### GetDependentApps + +`func (o *SourceConnectionsDto) GetDependentApps() []DependantAppConnections` + +GetDependentApps returns the DependentApps field if non-nil, zero value otherwise. + +### GetDependentAppsOk + +`func (o *SourceConnectionsDto) GetDependentAppsOk() (*[]DependantAppConnections, bool)` + +GetDependentAppsOk returns a tuple with the DependentApps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDependentApps + +`func (o *SourceConnectionsDto) SetDependentApps(v []DependantAppConnections)` + +SetDependentApps sets DependentApps field to given value. + +### HasDependentApps + +`func (o *SourceConnectionsDto) HasDependentApps() bool` + +HasDependentApps returns a boolean if a field has been set. + +### GetMissingDependents + +`func (o *SourceConnectionsDto) GetMissingDependents() []DependantConnectionsMissingDto` + +GetMissingDependents returns the MissingDependents field if non-nil, zero value otherwise. + +### GetMissingDependentsOk + +`func (o *SourceConnectionsDto) GetMissingDependentsOk() (*[]DependantConnectionsMissingDto, bool)` + +GetMissingDependentsOk returns a tuple with the MissingDependents field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMissingDependents + +`func (o *SourceConnectionsDto) SetMissingDependents(v []DependantConnectionsMissingDto)` + +SetMissingDependents sets MissingDependents field to given value. + +### HasMissingDependents + +`func (o *SourceConnectionsDto) HasMissingDependents() bool` + +HasMissingDependents returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SourceHealthDto.md b/docs/tools/sdk/go/Reference/V3/Models/SourceHealthDto.md new file mode 100644 index 000000000..e0de48e1f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SourceHealthDto.md @@ -0,0 +1,298 @@ +--- +id: source-health-dto +title: SourceHealthDto +pagination_label: SourceHealthDto +sidebar_label: SourceHealthDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceHealthDto', 'SourceHealthDto'] +slug: /tools/sdk/go/v3/models/source-health-dto +tags: ['SDK', 'Software Development Kit', 'SourceHealthDto', 'SourceHealthDto'] +--- + +# SourceHealthDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | the id of the Source | [optional] [readonly] +**Type** | Pointer to **string** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Name** | Pointer to **string** | the name of the source | [optional] +**Org** | Pointer to **string** | source's org | [optional] +**IsAuthoritative** | Pointer to **bool** | Is the source authoritative | [optional] +**IsCluster** | Pointer to **bool** | Is the source in a cluster | [optional] +**Hostname** | Pointer to **string** | source's hostname | [optional] +**Pod** | Pointer to **string** | source's pod | [optional] +**IqServiceVersion** | Pointer to **string** | The version of the iqService | [optional] +**Status** | Pointer to **string** | connection test result | [optional] + +## Methods + +### NewSourceHealthDto + +`func NewSourceHealthDto() *SourceHealthDto` + +NewSourceHealthDto instantiates a new SourceHealthDto 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 + +### NewSourceHealthDtoWithDefaults + +`func NewSourceHealthDtoWithDefaults() *SourceHealthDto` + +NewSourceHealthDtoWithDefaults instantiates a new SourceHealthDto 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 + +### GetId + +`func (o *SourceHealthDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceHealthDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceHealthDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceHealthDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *SourceHealthDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceHealthDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceHealthDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceHealthDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetName + +`func (o *SourceHealthDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceHealthDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceHealthDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceHealthDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOrg + +`func (o *SourceHealthDto) GetOrg() string` + +GetOrg returns the Org field if non-nil, zero value otherwise. + +### GetOrgOk + +`func (o *SourceHealthDto) GetOrgOk() (*string, bool)` + +GetOrgOk returns a tuple with the Org field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOrg + +`func (o *SourceHealthDto) SetOrg(v string)` + +SetOrg sets Org field to given value. + +### HasOrg + +`func (o *SourceHealthDto) HasOrg() bool` + +HasOrg returns a boolean if a field has been set. + +### GetIsAuthoritative + +`func (o *SourceHealthDto) GetIsAuthoritative() bool` + +GetIsAuthoritative returns the IsAuthoritative field if non-nil, zero value otherwise. + +### GetIsAuthoritativeOk + +`func (o *SourceHealthDto) GetIsAuthoritativeOk() (*bool, bool)` + +GetIsAuthoritativeOk returns a tuple with the IsAuthoritative field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsAuthoritative + +`func (o *SourceHealthDto) SetIsAuthoritative(v bool)` + +SetIsAuthoritative sets IsAuthoritative field to given value. + +### HasIsAuthoritative + +`func (o *SourceHealthDto) HasIsAuthoritative() bool` + +HasIsAuthoritative returns a boolean if a field has been set. + +### GetIsCluster + +`func (o *SourceHealthDto) GetIsCluster() bool` + +GetIsCluster returns the IsCluster field if non-nil, zero value otherwise. + +### GetIsClusterOk + +`func (o *SourceHealthDto) GetIsClusterOk() (*bool, bool)` + +GetIsClusterOk returns a tuple with the IsCluster field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsCluster + +`func (o *SourceHealthDto) SetIsCluster(v bool)` + +SetIsCluster sets IsCluster field to given value. + +### HasIsCluster + +`func (o *SourceHealthDto) HasIsCluster() bool` + +HasIsCluster returns a boolean if a field has been set. + +### GetHostname + +`func (o *SourceHealthDto) GetHostname() string` + +GetHostname returns the Hostname field if non-nil, zero value otherwise. + +### GetHostnameOk + +`func (o *SourceHealthDto) GetHostnameOk() (*string, bool)` + +GetHostnameOk returns a tuple with the Hostname field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostname + +`func (o *SourceHealthDto) SetHostname(v string)` + +SetHostname sets Hostname field to given value. + +### HasHostname + +`func (o *SourceHealthDto) HasHostname() bool` + +HasHostname returns a boolean if a field has been set. + +### GetPod + +`func (o *SourceHealthDto) GetPod() string` + +GetPod returns the Pod field if non-nil, zero value otherwise. + +### GetPodOk + +`func (o *SourceHealthDto) GetPodOk() (*string, bool)` + +GetPodOk returns a tuple with the Pod field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPod + +`func (o *SourceHealthDto) SetPod(v string)` + +SetPod sets Pod field to given value. + +### HasPod + +`func (o *SourceHealthDto) HasPod() bool` + +HasPod returns a boolean if a field has been set. + +### GetIqServiceVersion + +`func (o *SourceHealthDto) GetIqServiceVersion() string` + +GetIqServiceVersion returns the IqServiceVersion field if non-nil, zero value otherwise. + +### GetIqServiceVersionOk + +`func (o *SourceHealthDto) GetIqServiceVersionOk() (*string, bool)` + +GetIqServiceVersionOk returns a tuple with the IqServiceVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIqServiceVersion + +`func (o *SourceHealthDto) SetIqServiceVersion(v string)` + +SetIqServiceVersion sets IqServiceVersion field to given value. + +### HasIqServiceVersion + +`func (o *SourceHealthDto) HasIqServiceVersion() bool` + +HasIqServiceVersion returns a boolean if a field has been set. + +### GetStatus + +`func (o *SourceHealthDto) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SourceHealthDto) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SourceHealthDto) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SourceHealthDto) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SourceItemRef.md b/docs/tools/sdk/go/Reference/V3/Models/SourceItemRef.md new file mode 100644 index 000000000..5a766dfaa --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SourceItemRef.md @@ -0,0 +1,110 @@ +--- +id: source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceItemRef', 'SourceItemRef'] +slug: /tools/sdk/go/v3/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'SourceItemRef'] +--- + +# SourceItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | Pointer to **NullableString** | The id for the source on which account selections are made | [optional] +**Accounts** | Pointer to [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] + +## Methods + +### NewSourceItemRef + +`func NewSourceItemRef() *SourceItemRef` + +NewSourceItemRef instantiates a new SourceItemRef 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 + +### NewSourceItemRefWithDefaults + +`func NewSourceItemRefWithDefaults() *SourceItemRef` + +NewSourceItemRefWithDefaults instantiates a new SourceItemRef 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 + +### GetSourceId + +`func (o *SourceItemRef) GetSourceId() string` + +GetSourceId returns the SourceId field if non-nil, zero value otherwise. + +### GetSourceIdOk + +`func (o *SourceItemRef) GetSourceIdOk() (*string, bool)` + +GetSourceIdOk returns a tuple with the SourceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSourceId + +`func (o *SourceItemRef) SetSourceId(v string)` + +SetSourceId sets SourceId field to given value. + +### HasSourceId + +`func (o *SourceItemRef) HasSourceId() bool` + +HasSourceId returns a boolean if a field has been set. + +### SetSourceIdNil + +`func (o *SourceItemRef) SetSourceIdNil(b bool)` + + SetSourceIdNil sets the value for SourceId to be an explicit nil + +### UnsetSourceId +`func (o *SourceItemRef) UnsetSourceId()` + +UnsetSourceId ensures that no value is present for SourceId, not even an explicit nil +### GetAccounts + +`func (o *SourceItemRef) GetAccounts() []AccountItemRef` + +GetAccounts returns the Accounts field if non-nil, zero value otherwise. + +### GetAccountsOk + +`func (o *SourceItemRef) GetAccountsOk() (*[]AccountItemRef, bool)` + +GetAccountsOk returns a tuple with the Accounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccounts + +`func (o *SourceItemRef) SetAccounts(v []AccountItemRef)` + +SetAccounts sets Accounts field to given value. + +### HasAccounts + +`func (o *SourceItemRef) HasAccounts() bool` + +HasAccounts returns a boolean if a field has been set. + +### SetAccountsNil + +`func (o *SourceItemRef) SetAccountsNil(b bool)` + + SetAccountsNil sets the value for Accounts to be an explicit nil + +### UnsetAccounts +`func (o *SourceItemRef) UnsetAccounts()` + +UnsetAccounts ensures that no value is present for Accounts, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SourceManagementWorkgroup.md b/docs/tools/sdk/go/Reference/V3/Models/SourceManagementWorkgroup.md new file mode 100644 index 000000000..843ca6aa9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SourceManagementWorkgroup.md @@ -0,0 +1,116 @@ +--- +id: source-management-workgroup +title: SourceManagementWorkgroup +pagination_label: SourceManagementWorkgroup +sidebar_label: SourceManagementWorkgroup +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceManagementWorkgroup', 'SourceManagementWorkgroup'] +slug: /tools/sdk/go/v3/models/source-management-workgroup +tags: ['SDK', 'Software Development Kit', 'SourceManagementWorkgroup', 'SourceManagementWorkgroup'] +--- + +# SourceManagementWorkgroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Management workgroup ID. | [optional] +**Name** | Pointer to **string** | Management workgroup's human-readable display name. | [optional] + +## Methods + +### NewSourceManagementWorkgroup + +`func NewSourceManagementWorkgroup() *SourceManagementWorkgroup` + +NewSourceManagementWorkgroup instantiates a new SourceManagementWorkgroup 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 + +### NewSourceManagementWorkgroupWithDefaults + +`func NewSourceManagementWorkgroupWithDefaults() *SourceManagementWorkgroup` + +NewSourceManagementWorkgroupWithDefaults instantiates a new SourceManagementWorkgroup 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 + +### GetType + +`func (o *SourceManagementWorkgroup) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceManagementWorkgroup) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceManagementWorkgroup) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceManagementWorkgroup) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceManagementWorkgroup) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceManagementWorkgroup) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceManagementWorkgroup) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceManagementWorkgroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceManagementWorkgroup) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceManagementWorkgroup) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceManagementWorkgroup) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceManagementWorkgroup) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SourceManagerCorrelationMapping.md b/docs/tools/sdk/go/Reference/V3/Models/SourceManagerCorrelationMapping.md new file mode 100644 index 000000000..757e37927 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SourceManagerCorrelationMapping.md @@ -0,0 +1,90 @@ +--- +id: source-manager-correlation-mapping +title: SourceManagerCorrelationMapping +pagination_label: SourceManagerCorrelationMapping +sidebar_label: SourceManagerCorrelationMapping +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceManagerCorrelationMapping', 'SourceManagerCorrelationMapping'] +slug: /tools/sdk/go/v3/models/source-manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationMapping', 'SourceManagerCorrelationMapping'] +--- + +# SourceManagerCorrelationMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountAttributeName** | Pointer to **string** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**IdentityAttributeName** | Pointer to **string** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] + +## Methods + +### NewSourceManagerCorrelationMapping + +`func NewSourceManagerCorrelationMapping() *SourceManagerCorrelationMapping` + +NewSourceManagerCorrelationMapping instantiates a new SourceManagerCorrelationMapping 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 + +### NewSourceManagerCorrelationMappingWithDefaults + +`func NewSourceManagerCorrelationMappingWithDefaults() *SourceManagerCorrelationMapping` + +NewSourceManagerCorrelationMappingWithDefaults instantiates a new SourceManagerCorrelationMapping 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 + +### GetAccountAttributeName + +`func (o *SourceManagerCorrelationMapping) GetAccountAttributeName() string` + +GetAccountAttributeName returns the AccountAttributeName field if non-nil, zero value otherwise. + +### GetAccountAttributeNameOk + +`func (o *SourceManagerCorrelationMapping) GetAccountAttributeNameOk() (*string, bool)` + +GetAccountAttributeNameOk returns a tuple with the AccountAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountAttributeName + +`func (o *SourceManagerCorrelationMapping) SetAccountAttributeName(v string)` + +SetAccountAttributeName sets AccountAttributeName field to given value. + +### HasAccountAttributeName + +`func (o *SourceManagerCorrelationMapping) HasAccountAttributeName() bool` + +HasAccountAttributeName returns a boolean if a field has been set. + +### GetIdentityAttributeName + +`func (o *SourceManagerCorrelationMapping) GetIdentityAttributeName() string` + +GetIdentityAttributeName returns the IdentityAttributeName field if non-nil, zero value otherwise. + +### GetIdentityAttributeNameOk + +`func (o *SourceManagerCorrelationMapping) GetIdentityAttributeNameOk() (*string, bool)` + +GetIdentityAttributeNameOk returns a tuple with the IdentityAttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityAttributeName + +`func (o *SourceManagerCorrelationMapping) SetIdentityAttributeName(v string)` + +SetIdentityAttributeName sets IdentityAttributeName field to given value. + +### HasIdentityAttributeName + +`func (o *SourceManagerCorrelationMapping) HasIdentityAttributeName() bool` + +HasIdentityAttributeName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SourceManagerCorrelationRule.md b/docs/tools/sdk/go/Reference/V3/Models/SourceManagerCorrelationRule.md new file mode 100644 index 000000000..a28a24f48 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SourceManagerCorrelationRule.md @@ -0,0 +1,116 @@ +--- +id: source-manager-correlation-rule +title: SourceManagerCorrelationRule +pagination_label: SourceManagerCorrelationRule +sidebar_label: SourceManagerCorrelationRule +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceManagerCorrelationRule', 'SourceManagerCorrelationRule'] +slug: /tools/sdk/go/v3/models/source-manager-correlation-rule +tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationRule', 'SourceManagerCorrelationRule'] +--- + +# SourceManagerCorrelationRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Rule ID. | [optional] +**Name** | Pointer to **string** | Rule's human-readable display name. | [optional] + +## Methods + +### NewSourceManagerCorrelationRule + +`func NewSourceManagerCorrelationRule() *SourceManagerCorrelationRule` + +NewSourceManagerCorrelationRule instantiates a new SourceManagerCorrelationRule 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 + +### NewSourceManagerCorrelationRuleWithDefaults + +`func NewSourceManagerCorrelationRuleWithDefaults() *SourceManagerCorrelationRule` + +NewSourceManagerCorrelationRuleWithDefaults instantiates a new SourceManagerCorrelationRule 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 + +### GetType + +`func (o *SourceManagerCorrelationRule) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceManagerCorrelationRule) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceManagerCorrelationRule) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceManagerCorrelationRule) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceManagerCorrelationRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceManagerCorrelationRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceManagerCorrelationRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceManagerCorrelationRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceManagerCorrelationRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceManagerCorrelationRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceManagerCorrelationRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceManagerCorrelationRule) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SourceOwner.md b/docs/tools/sdk/go/Reference/V3/Models/SourceOwner.md new file mode 100644 index 000000000..ab7ba7742 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SourceOwner.md @@ -0,0 +1,116 @@ +--- +id: source-owner +title: SourceOwner +pagination_label: SourceOwner +sidebar_label: SourceOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceOwner', 'SourceOwner'] +slug: /tools/sdk/go/v3/models/source-owner +tags: ['SDK', 'Software Development Kit', 'SourceOwner', 'SourceOwner'] +--- + +# SourceOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Owner identity's ID. | [optional] +**Name** | Pointer to **string** | Owner identity's human-readable display name. | [optional] + +## Methods + +### NewSourceOwner + +`func NewSourceOwner() *SourceOwner` + +NewSourceOwner instantiates a new SourceOwner 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 + +### NewSourceOwnerWithDefaults + +`func NewSourceOwnerWithDefaults() *SourceOwner` + +NewSourceOwnerWithDefaults instantiates a new SourceOwner 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 + +### GetType + +`func (o *SourceOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SourcePasswordPoliciesInner.md b/docs/tools/sdk/go/Reference/V3/Models/SourcePasswordPoliciesInner.md new file mode 100644 index 000000000..34e082f3f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SourcePasswordPoliciesInner.md @@ -0,0 +1,116 @@ +--- +id: source-password-policies-inner +title: SourcePasswordPoliciesInner +pagination_label: SourcePasswordPoliciesInner +sidebar_label: SourcePasswordPoliciesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourcePasswordPoliciesInner', 'SourcePasswordPoliciesInner'] +slug: /tools/sdk/go/v3/models/source-password-policies-inner +tags: ['SDK', 'Software Development Kit', 'SourcePasswordPoliciesInner', 'SourcePasswordPoliciesInner'] +--- + +# SourcePasswordPoliciesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Policy ID. | [optional] +**Name** | Pointer to **string** | Policy's human-readable display name. | [optional] + +## Methods + +### NewSourcePasswordPoliciesInner + +`func NewSourcePasswordPoliciesInner() *SourcePasswordPoliciesInner` + +NewSourcePasswordPoliciesInner instantiates a new SourcePasswordPoliciesInner 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 + +### NewSourcePasswordPoliciesInnerWithDefaults + +`func NewSourcePasswordPoliciesInnerWithDefaults() *SourcePasswordPoliciesInner` + +NewSourcePasswordPoliciesInnerWithDefaults instantiates a new SourcePasswordPoliciesInner 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 + +### GetType + +`func (o *SourcePasswordPoliciesInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourcePasswordPoliciesInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourcePasswordPoliciesInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourcePasswordPoliciesInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourcePasswordPoliciesInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourcePasswordPoliciesInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourcePasswordPoliciesInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourcePasswordPoliciesInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourcePasswordPoliciesInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourcePasswordPoliciesInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourcePasswordPoliciesInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourcePasswordPoliciesInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SourceSchemasInner.md b/docs/tools/sdk/go/Reference/V3/Models/SourceSchemasInner.md new file mode 100644 index 000000000..dd3f637cd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SourceSchemasInner.md @@ -0,0 +1,116 @@ +--- +id: source-schemas-inner +title: SourceSchemasInner +pagination_label: SourceSchemasInner +sidebar_label: SourceSchemasInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceSchemasInner', 'SourceSchemasInner'] +slug: /tools/sdk/go/v3/models/source-schemas-inner +tags: ['SDK', 'Software Development Kit', 'SourceSchemasInner', 'SourceSchemasInner'] +--- + +# SourceSchemasInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of object being referenced. | [optional] +**Id** | Pointer to **string** | Schema ID. | [optional] +**Name** | Pointer to **string** | Schema's human-readable display name. | [optional] + +## Methods + +### NewSourceSchemasInner + +`func NewSourceSchemasInner() *SourceSchemasInner` + +NewSourceSchemasInner instantiates a new SourceSchemasInner 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 + +### NewSourceSchemasInnerWithDefaults + +`func NewSourceSchemasInnerWithDefaults() *SourceSchemasInner` + +NewSourceSchemasInnerWithDefaults instantiates a new SourceSchemasInner 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 + +### GetType + +`func (o *SourceSchemasInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SourceSchemasInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SourceSchemasInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SourceSchemasInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *SourceSchemasInner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *SourceSchemasInner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *SourceSchemasInner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *SourceSchemasInner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *SourceSchemasInner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SourceSchemasInner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SourceSchemasInner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SourceSchemasInner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/go/Reference/V3/Models/SourceUsage.md new file mode 100644 index 000000000..54ae08fba --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SourceUsage.md @@ -0,0 +1,90 @@ +--- +id: source-usage +title: SourceUsage +pagination_label: SourceUsage +sidebar_label: SourceUsage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUsage', 'SourceUsage'] +slug: /tools/sdk/go/v3/models/source-usage +tags: ['SDK', 'Software Development Kit', 'SourceUsage', 'SourceUsage'] +--- + +# SourceUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **string** | The first day of the month for which activity is aggregated. | [optional] +**Count** | Pointer to **float32** | The average number of days that accounts were active within this source, for the month. | [optional] + +## Methods + +### NewSourceUsage + +`func NewSourceUsage() *SourceUsage` + +NewSourceUsage instantiates a new SourceUsage 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 + +### NewSourceUsageWithDefaults + +`func NewSourceUsageWithDefaults() *SourceUsage` + +NewSourceUsageWithDefaults instantiates a new SourceUsage 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 + +### GetDate + +`func (o *SourceUsage) GetDate() string` + +GetDate returns the Date field if non-nil, zero value otherwise. + +### GetDateOk + +`func (o *SourceUsage) GetDateOk() (*string, bool)` + +GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDate + +`func (o *SourceUsage) SetDate(v string)` + +SetDate sets Date field to given value. + +### HasDate + +`func (o *SourceUsage) HasDate() bool` + +HasDate returns a boolean if a field has been set. + +### GetCount + +`func (o *SourceUsage) GetCount() float32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *SourceUsage) GetCountOk() (*float32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *SourceUsage) SetCount(v float32)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *SourceUsage) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SourceUsageStatus.md b/docs/tools/sdk/go/Reference/V3/Models/SourceUsageStatus.md new file mode 100644 index 000000000..b45b5db97 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SourceUsageStatus.md @@ -0,0 +1,64 @@ +--- +id: source-usage-status +title: SourceUsageStatus +pagination_label: SourceUsageStatus +sidebar_label: SourceUsageStatus +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SourceUsageStatus', 'SourceUsageStatus'] +slug: /tools/sdk/go/v3/models/source-usage-status +tags: ['SDK', 'Software Development Kit', 'SourceUsageStatus', 'SourceUsageStatus'] +--- + +# SourceUsageStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. | [optional] + +## Methods + +### NewSourceUsageStatus + +`func NewSourceUsageStatus() *SourceUsageStatus` + +NewSourceUsageStatus instantiates a new SourceUsageStatus 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 + +### NewSourceUsageStatusWithDefaults + +`func NewSourceUsageStatusWithDefaults() *SourceUsageStatus` + +NewSourceUsageStatusWithDefaults instantiates a new SourceUsageStatus 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 + +### GetStatus + +`func (o *SourceUsageStatus) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *SourceUsageStatus) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *SourceUsageStatus) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *SourceUsageStatus) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SpConfigMessage.md b/docs/tools/sdk/go/Reference/V3/Models/SpConfigMessage.md new file mode 100644 index 000000000..e5cac49f1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SpConfigMessage.md @@ -0,0 +1,101 @@ +--- +id: sp-config-message +title: SpConfigMessage +pagination_label: SpConfigMessage +sidebar_label: SpConfigMessage +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpConfigMessage', 'SpConfigMessage'] +slug: /tools/sdk/go/v3/models/sp-config-message +tags: ['SDK', 'Software Development Kit', 'SpConfigMessage', 'SpConfigMessage'] +--- + +# SpConfigMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **string** | Message key. | +**Text** | **string** | Message text. | +**Details** | **map[string]interface{}** | Message details if any, in key:value pairs. | + +## Methods + +### NewSpConfigMessage + +`func NewSpConfigMessage(key string, text string, details map[string]interface{}, ) *SpConfigMessage` + +NewSpConfigMessage instantiates a new SpConfigMessage 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 + +### NewSpConfigMessageWithDefaults + +`func NewSpConfigMessageWithDefaults() *SpConfigMessage` + +NewSpConfigMessageWithDefaults instantiates a new SpConfigMessage 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 + +### GetKey + +`func (o *SpConfigMessage) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *SpConfigMessage) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *SpConfigMessage) SetKey(v string)` + +SetKey sets Key field to given value. + + +### GetText + +`func (o *SpConfigMessage) GetText() string` + +GetText returns the Text field if non-nil, zero value otherwise. + +### GetTextOk + +`func (o *SpConfigMessage) GetTextOk() (*string, bool)` + +GetTextOk returns a tuple with the Text field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetText + +`func (o *SpConfigMessage) SetText(v string)` + +SetText sets Text field to given value. + + +### GetDetails + +`func (o *SpConfigMessage) GetDetails() map[string]interface{}` + +GetDetails returns the Details field if non-nil, zero value otherwise. + +### GetDetailsOk + +`func (o *SpConfigMessage) GetDetailsOk() (*map[string]interface{}, bool)` + +GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetails + +`func (o *SpConfigMessage) SetDetails(v map[string]interface{})` + +SetDetails sets Details field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SpDetails.md b/docs/tools/sdk/go/Reference/V3/Models/SpDetails.md new file mode 100644 index 000000000..e104fa177 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SpDetails.md @@ -0,0 +1,163 @@ +--- +id: sp-details +title: SpDetails +pagination_label: SpDetails +sidebar_label: SpDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SpDetails', 'SpDetails'] +slug: /tools/sdk/go/v3/models/sp-details +tags: ['SDK', 'Software Development Kit', 'SpDetails', 'SpDetails'] +--- + +# SpDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | Pointer to **string** | Federation protocol role | [optional] +**EntityId** | Pointer to **string** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Alias** | Pointer to **string** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**CallbackUrl** | **string** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | +**LegacyAcsUrl** | Pointer to **string** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] + +## Methods + +### NewSpDetails + +`func NewSpDetails(callbackUrl string, ) *SpDetails` + +NewSpDetails instantiates a new SpDetails 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 + +### NewSpDetailsWithDefaults + +`func NewSpDetailsWithDefaults() *SpDetails` + +NewSpDetailsWithDefaults instantiates a new SpDetails 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 + +### GetRole + +`func (o *SpDetails) GetRole() string` + +GetRole returns the Role field if non-nil, zero value otherwise. + +### GetRoleOk + +`func (o *SpDetails) GetRoleOk() (*string, bool)` + +GetRoleOk returns a tuple with the Role field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRole + +`func (o *SpDetails) SetRole(v string)` + +SetRole sets Role field to given value. + +### HasRole + +`func (o *SpDetails) HasRole() bool` + +HasRole returns a boolean if a field has been set. + +### GetEntityId + +`func (o *SpDetails) GetEntityId() string` + +GetEntityId returns the EntityId field if non-nil, zero value otherwise. + +### GetEntityIdOk + +`func (o *SpDetails) GetEntityIdOk() (*string, bool)` + +GetEntityIdOk returns a tuple with the EntityId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEntityId + +`func (o *SpDetails) SetEntityId(v string)` + +SetEntityId sets EntityId field to given value. + +### HasEntityId + +`func (o *SpDetails) HasEntityId() bool` + +HasEntityId returns a boolean if a field has been set. + +### GetAlias + +`func (o *SpDetails) GetAlias() string` + +GetAlias returns the Alias field if non-nil, zero value otherwise. + +### GetAliasOk + +`func (o *SpDetails) GetAliasOk() (*string, bool)` + +GetAliasOk returns a tuple with the Alias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAlias + +`func (o *SpDetails) SetAlias(v string)` + +SetAlias sets Alias field to given value. + +### HasAlias + +`func (o *SpDetails) HasAlias() bool` + +HasAlias returns a boolean if a field has been set. + +### GetCallbackUrl + +`func (o *SpDetails) GetCallbackUrl() string` + +GetCallbackUrl returns the CallbackUrl field if non-nil, zero value otherwise. + +### GetCallbackUrlOk + +`func (o *SpDetails) GetCallbackUrlOk() (*string, bool)` + +GetCallbackUrlOk returns a tuple with the CallbackUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCallbackUrl + +`func (o *SpDetails) SetCallbackUrl(v string)` + +SetCallbackUrl sets CallbackUrl field to given value. + + +### GetLegacyAcsUrl + +`func (o *SpDetails) GetLegacyAcsUrl() string` + +GetLegacyAcsUrl returns the LegacyAcsUrl field if non-nil, zero value otherwise. + +### GetLegacyAcsUrlOk + +`func (o *SpDetails) GetLegacyAcsUrlOk() (*string, bool)` + +GetLegacyAcsUrlOk returns a tuple with the LegacyAcsUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLegacyAcsUrl + +`func (o *SpDetails) SetLegacyAcsUrl(v string)` + +SetLegacyAcsUrl sets LegacyAcsUrl field to given value. + +### HasLegacyAcsUrl + +`func (o *SpDetails) HasLegacyAcsUrl() bool` + +HasLegacyAcsUrl returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/StandardLevel.md b/docs/tools/sdk/go/Reference/V3/Models/StandardLevel.md new file mode 100644 index 000000000..c592d9dd6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/StandardLevel.md @@ -0,0 +1,31 @@ +--- +id: standard-level +title: StandardLevel +pagination_label: StandardLevel +sidebar_label: StandardLevel +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'StandardLevel', 'StandardLevel'] +slug: /tools/sdk/go/v3/models/standard-level +tags: ['SDK', 'Software Development Kit', 'StandardLevel', 'StandardLevel'] +--- + +# StandardLevel + +## Enum + + +* `FALSE` (value: `"false"`) + +* `FATAL` (value: `"FATAL"`) + +* `ERROR` (value: `"ERROR"`) + +* `WARN` (value: `"WARN"`) + +* `INFO` (value: `"INFO"`) + +* `DEBUG` (value: `"DEBUG"`) + +* `TRACE` (value: `"TRACE"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/SubSearchAggregationSpecification.md b/docs/tools/sdk/go/Reference/V3/Models/SubSearchAggregationSpecification.md new file mode 100644 index 000000000..138593f75 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/SubSearchAggregationSpecification.md @@ -0,0 +1,168 @@ +--- +id: sub-search-aggregation-specification +title: SubSearchAggregationSpecification +pagination_label: SubSearchAggregationSpecification +sidebar_label: SubSearchAggregationSpecification +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SubSearchAggregationSpecification', 'SubSearchAggregationSpecification'] +slug: /tools/sdk/go/v3/models/sub-search-aggregation-specification +tags: ['SDK', 'Software Development Kit', 'SubSearchAggregationSpecification', 'SubSearchAggregationSpecification'] +--- + +# SubSearchAggregationSpecification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional] +**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional] +**Filter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional] +**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional] +**SubAggregation** | Pointer to [**Aggregations**](aggregations) | | [optional] + +## Methods + +### NewSubSearchAggregationSpecification + +`func NewSubSearchAggregationSpecification() *SubSearchAggregationSpecification` + +NewSubSearchAggregationSpecification instantiates a new SubSearchAggregationSpecification 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 + +### NewSubSearchAggregationSpecificationWithDefaults + +`func NewSubSearchAggregationSpecificationWithDefaults() *SubSearchAggregationSpecification` + +NewSubSearchAggregationSpecificationWithDefaults instantiates a new SubSearchAggregationSpecification 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 + +### GetNested + +`func (o *SubSearchAggregationSpecification) GetNested() NestedAggregation` + +GetNested returns the Nested field if non-nil, zero value otherwise. + +### GetNestedOk + +`func (o *SubSearchAggregationSpecification) GetNestedOk() (*NestedAggregation, bool)` + +GetNestedOk returns a tuple with the Nested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNested + +`func (o *SubSearchAggregationSpecification) SetNested(v NestedAggregation)` + +SetNested sets Nested field to given value. + +### HasNested + +`func (o *SubSearchAggregationSpecification) HasNested() bool` + +HasNested returns a boolean if a field has been set. + +### GetMetric + +`func (o *SubSearchAggregationSpecification) GetMetric() MetricAggregation` + +GetMetric returns the Metric field if non-nil, zero value otherwise. + +### GetMetricOk + +`func (o *SubSearchAggregationSpecification) GetMetricOk() (*MetricAggregation, bool)` + +GetMetricOk returns a tuple with the Metric field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetric + +`func (o *SubSearchAggregationSpecification) SetMetric(v MetricAggregation)` + +SetMetric sets Metric field to given value. + +### HasMetric + +`func (o *SubSearchAggregationSpecification) HasMetric() bool` + +HasMetric returns a boolean if a field has been set. + +### GetFilter + +`func (o *SubSearchAggregationSpecification) GetFilter() FilterAggregation` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *SubSearchAggregationSpecification) GetFilterOk() (*FilterAggregation, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilter + +`func (o *SubSearchAggregationSpecification) SetFilter(v FilterAggregation)` + +SetFilter sets Filter field to given value. + +### HasFilter + +`func (o *SubSearchAggregationSpecification) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### GetBucket + +`func (o *SubSearchAggregationSpecification) GetBucket() BucketAggregation` + +GetBucket returns the Bucket field if non-nil, zero value otherwise. + +### GetBucketOk + +`func (o *SubSearchAggregationSpecification) GetBucketOk() (*BucketAggregation, bool)` + +GetBucketOk returns a tuple with the Bucket field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBucket + +`func (o *SubSearchAggregationSpecification) SetBucket(v BucketAggregation)` + +SetBucket sets Bucket field to given value. + +### HasBucket + +`func (o *SubSearchAggregationSpecification) HasBucket() bool` + +HasBucket returns a boolean if a field has been set. + +### GetSubAggregation + +`func (o *SubSearchAggregationSpecification) GetSubAggregation() Aggregations` + +GetSubAggregation returns the SubAggregation field if non-nil, zero value otherwise. + +### GetSubAggregationOk + +`func (o *SubSearchAggregationSpecification) GetSubAggregationOk() (*Aggregations, bool)` + +GetSubAggregationOk returns a tuple with the SubAggregation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubAggregation + +`func (o *SubSearchAggregationSpecification) SetSubAggregation(v Aggregations)` + +SetSubAggregation sets SubAggregation field to given value. + +### HasSubAggregation + +`func (o *SubSearchAggregationSpecification) HasSubAggregation() bool` + +HasSubAggregation returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TaggedObject.md b/docs/tools/sdk/go/Reference/V3/Models/TaggedObject.md new file mode 100644 index 000000000..5e86aa405 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TaggedObject.md @@ -0,0 +1,90 @@ +--- +id: tagged-object +title: TaggedObject +pagination_label: TaggedObject +sidebar_label: TaggedObject +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaggedObject', 'TaggedObject'] +slug: /tools/sdk/go/v3/models/tagged-object +tags: ['SDK', 'Software Development Kit', 'TaggedObject', 'TaggedObject'] +--- + +# TaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRef** | Pointer to [**TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]string** | Labels to be applied to an Object | [optional] + +## Methods + +### NewTaggedObject + +`func NewTaggedObject() *TaggedObject` + +NewTaggedObject instantiates a new TaggedObject 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 + +### NewTaggedObjectWithDefaults + +`func NewTaggedObjectWithDefaults() *TaggedObject` + +NewTaggedObjectWithDefaults instantiates a new TaggedObject 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 + +### GetObjectRef + +`func (o *TaggedObject) GetObjectRef() TaggedObjectDto` + +GetObjectRef returns the ObjectRef field if non-nil, zero value otherwise. + +### GetObjectRefOk + +`func (o *TaggedObject) GetObjectRefOk() (*TaggedObjectDto, bool)` + +GetObjectRefOk returns a tuple with the ObjectRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetObjectRef + +`func (o *TaggedObject) SetObjectRef(v TaggedObjectDto)` + +SetObjectRef sets ObjectRef field to given value. + +### HasObjectRef + +`func (o *TaggedObject) HasObjectRef() bool` + +HasObjectRef returns a boolean if a field has been set. + +### GetTags + +`func (o *TaggedObject) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *TaggedObject) GetTagsOk() (*[]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTags + +`func (o *TaggedObject) SetTags(v []string)` + +SetTags sets Tags field to given value. + +### HasTags + +`func (o *TaggedObject) HasTags() bool` + +HasTags returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TaggedObjectDto.md b/docs/tools/sdk/go/Reference/V3/Models/TaggedObjectDto.md new file mode 100644 index 000000000..4e1cafd52 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TaggedObjectDto.md @@ -0,0 +1,126 @@ +--- +id: tagged-object-dto +title: TaggedObjectDto +pagination_label: TaggedObjectDto +sidebar_label: TaggedObjectDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaggedObjectDto', 'TaggedObjectDto'] +slug: /tools/sdk/go/v3/models/tagged-object-dto +tags: ['SDK', 'Software Development Kit', 'TaggedObjectDto', 'TaggedObjectDto'] +--- + +# TaggedObjectDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | DTO type | [optional] +**Id** | Pointer to **string** | ID of the object this reference applies to | [optional] +**Name** | Pointer to **NullableString** | Human-readable display name of the object this reference applies to | [optional] + +## Methods + +### NewTaggedObjectDto + +`func NewTaggedObjectDto() *TaggedObjectDto` + +NewTaggedObjectDto instantiates a new TaggedObjectDto 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 + +### NewTaggedObjectDtoWithDefaults + +`func NewTaggedObjectDtoWithDefaults() *TaggedObjectDto` + +NewTaggedObjectDtoWithDefaults instantiates a new TaggedObjectDto 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 + +### GetType + +`func (o *TaggedObjectDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaggedObjectDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaggedObjectDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaggedObjectDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *TaggedObjectDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaggedObjectDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaggedObjectDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaggedObjectDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TaggedObjectDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaggedObjectDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaggedObjectDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TaggedObjectDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *TaggedObjectDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *TaggedObjectDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TaskResultDetails.md b/docs/tools/sdk/go/Reference/V3/Models/TaskResultDetails.md new file mode 100644 index 000000000..2bbb9b0ee --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TaskResultDetails.md @@ -0,0 +1,452 @@ +--- +id: task-result-details +title: TaskResultDetails +pagination_label: TaskResultDetails +sidebar_label: TaskResultDetails +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultDetails', 'TaskResultDetails'] +slug: /tools/sdk/go/v3/models/task-result-details +tags: ['SDK', 'Software Development Kit', 'TaskResultDetails', 'TaskResultDetails'] +--- + +# TaskResultDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task. | [optional] +**Id** | Pointer to **string** | Unique task definition identifier. | [optional] +**ReportType** | Pointer to **string** | Use this property to define what report should be processed in the RDE service. | [optional] +**Description** | Pointer to **string** | Description of the report purpose and/or contents. | [optional] +**ParentName** | Pointer to **NullableString** | Name of the parent task/report if exists. | [optional] +**Launcher** | Pointer to **string** | Name of the report processing initiator. | [optional] +**Created** | Pointer to **SailPointTime** | Report creation date | [optional] +**Launched** | Pointer to **NullableTime** | Report start date | [optional] +**Completed** | Pointer to **NullableTime** | Report completion date | [optional] +**CompletionStatus** | Pointer to **NullableString** | Report completion status. | [optional] +**Messages** | Pointer to [**[]TaskResultDetailsMessagesInner**](task-result-details-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**Returns** | Pointer to [**[]TaskResultDetailsReturnsInner**](task-result-details-returns-inner) | Task definition results, if necessary. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Extra attributes map(dictionary) needed for the report. | [optional] +**Progress** | Pointer to **NullableString** | Current report state. | [optional] + +## Methods + +### NewTaskResultDetails + +`func NewTaskResultDetails() *TaskResultDetails` + +NewTaskResultDetails instantiates a new TaskResultDetails 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 + +### NewTaskResultDetailsWithDefaults + +`func NewTaskResultDetailsWithDefaults() *TaskResultDetails` + +NewTaskResultDetailsWithDefaults instantiates a new TaskResultDetails 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 + +### GetType + +`func (o *TaskResultDetails) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskResultDetails) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskResultDetails) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaskResultDetails) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *TaskResultDetails) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskResultDetails) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskResultDetails) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaskResultDetails) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetReportType + +`func (o *TaskResultDetails) GetReportType() string` + +GetReportType returns the ReportType field if non-nil, zero value otherwise. + +### GetReportTypeOk + +`func (o *TaskResultDetails) GetReportTypeOk() (*string, bool)` + +GetReportTypeOk returns a tuple with the ReportType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReportType + +`func (o *TaskResultDetails) SetReportType(v string)` + +SetReportType sets ReportType field to given value. + +### HasReportType + +`func (o *TaskResultDetails) HasReportType() bool` + +HasReportType returns a boolean if a field has been set. + +### GetDescription + +`func (o *TaskResultDetails) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TaskResultDetails) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TaskResultDetails) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *TaskResultDetails) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetParentName + +`func (o *TaskResultDetails) GetParentName() string` + +GetParentName returns the ParentName field if non-nil, zero value otherwise. + +### GetParentNameOk + +`func (o *TaskResultDetails) GetParentNameOk() (*string, bool)` + +GetParentNameOk returns a tuple with the ParentName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParentName + +`func (o *TaskResultDetails) SetParentName(v string)` + +SetParentName sets ParentName field to given value. + +### HasParentName + +`func (o *TaskResultDetails) HasParentName() bool` + +HasParentName returns a boolean if a field has been set. + +### SetParentNameNil + +`func (o *TaskResultDetails) SetParentNameNil(b bool)` + + SetParentNameNil sets the value for ParentName to be an explicit nil + +### UnsetParentName +`func (o *TaskResultDetails) UnsetParentName()` + +UnsetParentName ensures that no value is present for ParentName, not even an explicit nil +### GetLauncher + +`func (o *TaskResultDetails) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *TaskResultDetails) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *TaskResultDetails) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + +### HasLauncher + +`func (o *TaskResultDetails) HasLauncher() bool` + +HasLauncher returns a boolean if a field has been set. + +### GetCreated + +`func (o *TaskResultDetails) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *TaskResultDetails) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *TaskResultDetails) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *TaskResultDetails) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetLaunched + +`func (o *TaskResultDetails) GetLaunched() SailPointTime` + +GetLaunched returns the Launched field if non-nil, zero value otherwise. + +### GetLaunchedOk + +`func (o *TaskResultDetails) GetLaunchedOk() (*SailPointTime, bool)` + +GetLaunchedOk returns a tuple with the Launched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunched + +`func (o *TaskResultDetails) SetLaunched(v SailPointTime)` + +SetLaunched sets Launched field to given value. + +### HasLaunched + +`func (o *TaskResultDetails) HasLaunched() bool` + +HasLaunched returns a boolean if a field has been set. + +### SetLaunchedNil + +`func (o *TaskResultDetails) SetLaunchedNil(b bool)` + + SetLaunchedNil sets the value for Launched to be an explicit nil + +### UnsetLaunched +`func (o *TaskResultDetails) UnsetLaunched()` + +UnsetLaunched ensures that no value is present for Launched, not even an explicit nil +### GetCompleted + +`func (o *TaskResultDetails) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *TaskResultDetails) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *TaskResultDetails) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *TaskResultDetails) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *TaskResultDetails) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *TaskResultDetails) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetCompletionStatus + +`func (o *TaskResultDetails) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *TaskResultDetails) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *TaskResultDetails) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *TaskResultDetails) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + +### SetCompletionStatusNil + +`func (o *TaskResultDetails) SetCompletionStatusNil(b bool)` + + SetCompletionStatusNil sets the value for CompletionStatus to be an explicit nil + +### UnsetCompletionStatus +`func (o *TaskResultDetails) UnsetCompletionStatus()` + +UnsetCompletionStatus ensures that no value is present for CompletionStatus, not even an explicit nil +### GetMessages + +`func (o *TaskResultDetails) GetMessages() []TaskResultDetailsMessagesInner` + +GetMessages returns the Messages field if non-nil, zero value otherwise. + +### GetMessagesOk + +`func (o *TaskResultDetails) GetMessagesOk() (*[]TaskResultDetailsMessagesInner, bool)` + +GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessages + +`func (o *TaskResultDetails) SetMessages(v []TaskResultDetailsMessagesInner)` + +SetMessages sets Messages field to given value. + +### HasMessages + +`func (o *TaskResultDetails) HasMessages() bool` + +HasMessages returns a boolean if a field has been set. + +### GetReturns + +`func (o *TaskResultDetails) GetReturns() []TaskResultDetailsReturnsInner` + +GetReturns returns the Returns field if non-nil, zero value otherwise. + +### GetReturnsOk + +`func (o *TaskResultDetails) GetReturnsOk() (*[]TaskResultDetailsReturnsInner, bool)` + +GetReturnsOk returns a tuple with the Returns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReturns + +`func (o *TaskResultDetails) SetReturns(v []TaskResultDetailsReturnsInner)` + +SetReturns sets Returns field to given value. + +### HasReturns + +`func (o *TaskResultDetails) HasReturns() bool` + +HasReturns returns a boolean if a field has been set. + +### GetAttributes + +`func (o *TaskResultDetails) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TaskResultDetails) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TaskResultDetails) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *TaskResultDetails) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### GetProgress + +`func (o *TaskResultDetails) GetProgress() string` + +GetProgress returns the Progress field if non-nil, zero value otherwise. + +### GetProgressOk + +`func (o *TaskResultDetails) GetProgressOk() (*string, bool)` + +GetProgressOk returns a tuple with the Progress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProgress + +`func (o *TaskResultDetails) SetProgress(v string)` + +SetProgress sets Progress field to given value. + +### HasProgress + +`func (o *TaskResultDetails) HasProgress() bool` + +HasProgress returns a boolean if a field has been set. + +### SetProgressNil + +`func (o *TaskResultDetails) SetProgressNil(b bool)` + + SetProgressNil sets the value for Progress to be an explicit nil + +### UnsetProgress +`func (o *TaskResultDetails) UnsetProgress()` + +UnsetProgress ensures that no value is present for Progress, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TaskResultDetailsMessagesInner.md b/docs/tools/sdk/go/Reference/V3/Models/TaskResultDetailsMessagesInner.md new file mode 100644 index 000000000..044b347da --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TaskResultDetailsMessagesInner.md @@ -0,0 +1,168 @@ +--- +id: task-result-details-messages-inner +title: TaskResultDetailsMessagesInner +pagination_label: TaskResultDetailsMessagesInner +sidebar_label: TaskResultDetailsMessagesInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultDetailsMessagesInner', 'TaskResultDetailsMessagesInner'] +slug: /tools/sdk/go/v3/models/task-result-details-messages-inner +tags: ['SDK', 'Software Development Kit', 'TaskResultDetailsMessagesInner', 'TaskResultDetailsMessagesInner'] +--- + +# TaskResultDetailsMessagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the message. | [optional] +**Error** | Pointer to **bool** | Flag whether message is an error. | [optional] [default to false] +**Warning** | Pointer to **bool** | Flag whether message is a warning. | [optional] [default to false] +**Key** | Pointer to **string** | Message string identifier. | [optional] +**LocalizedText** | Pointer to **string** | Message context with the locale based language. | [optional] + +## Methods + +### NewTaskResultDetailsMessagesInner + +`func NewTaskResultDetailsMessagesInner() *TaskResultDetailsMessagesInner` + +NewTaskResultDetailsMessagesInner instantiates a new TaskResultDetailsMessagesInner 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 + +### NewTaskResultDetailsMessagesInnerWithDefaults + +`func NewTaskResultDetailsMessagesInnerWithDefaults() *TaskResultDetailsMessagesInner` + +NewTaskResultDetailsMessagesInnerWithDefaults instantiates a new TaskResultDetailsMessagesInner 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 + +### GetType + +`func (o *TaskResultDetailsMessagesInner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskResultDetailsMessagesInner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskResultDetailsMessagesInner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaskResultDetailsMessagesInner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetError + +`func (o *TaskResultDetailsMessagesInner) GetError() bool` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *TaskResultDetailsMessagesInner) GetErrorOk() (*bool, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *TaskResultDetailsMessagesInner) SetError(v bool)` + +SetError sets Error field to given value. + +### HasError + +`func (o *TaskResultDetailsMessagesInner) HasError() bool` + +HasError returns a boolean if a field has been set. + +### GetWarning + +`func (o *TaskResultDetailsMessagesInner) GetWarning() bool` + +GetWarning returns the Warning field if non-nil, zero value otherwise. + +### GetWarningOk + +`func (o *TaskResultDetailsMessagesInner) GetWarningOk() (*bool, bool)` + +GetWarningOk returns a tuple with the Warning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarning + +`func (o *TaskResultDetailsMessagesInner) SetWarning(v bool)` + +SetWarning sets Warning field to given value. + +### HasWarning + +`func (o *TaskResultDetailsMessagesInner) HasWarning() bool` + +HasWarning returns a boolean if a field has been set. + +### GetKey + +`func (o *TaskResultDetailsMessagesInner) GetKey() string` + +GetKey returns the Key field if non-nil, zero value otherwise. + +### GetKeyOk + +`func (o *TaskResultDetailsMessagesInner) GetKeyOk() (*string, bool)` + +GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetKey + +`func (o *TaskResultDetailsMessagesInner) SetKey(v string)` + +SetKey sets Key field to given value. + +### HasKey + +`func (o *TaskResultDetailsMessagesInner) HasKey() bool` + +HasKey returns a boolean if a field has been set. + +### GetLocalizedText + +`func (o *TaskResultDetailsMessagesInner) GetLocalizedText() string` + +GetLocalizedText returns the LocalizedText field if non-nil, zero value otherwise. + +### GetLocalizedTextOk + +`func (o *TaskResultDetailsMessagesInner) GetLocalizedTextOk() (*string, bool)` + +GetLocalizedTextOk returns a tuple with the LocalizedText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocalizedText + +`func (o *TaskResultDetailsMessagesInner) SetLocalizedText(v string)` + +SetLocalizedText sets LocalizedText field to given value. + +### HasLocalizedText + +`func (o *TaskResultDetailsMessagesInner) HasLocalizedText() bool` + +HasLocalizedText returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TaskResultDetailsReturnsInner.md b/docs/tools/sdk/go/Reference/V3/Models/TaskResultDetailsReturnsInner.md new file mode 100644 index 000000000..e7d4d2279 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TaskResultDetailsReturnsInner.md @@ -0,0 +1,90 @@ +--- +id: task-result-details-returns-inner +title: TaskResultDetailsReturnsInner +pagination_label: TaskResultDetailsReturnsInner +sidebar_label: TaskResultDetailsReturnsInner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultDetailsReturnsInner', 'TaskResultDetailsReturnsInner'] +slug: /tools/sdk/go/v3/models/task-result-details-returns-inner +tags: ['SDK', 'Software Development Kit', 'TaskResultDetailsReturnsInner', 'TaskResultDetailsReturnsInner'] +--- + +# TaskResultDetailsReturnsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayLabel** | Pointer to **string** | Attribute description. | [optional] +**AttributeName** | Pointer to **string** | System or database attribute name. | [optional] + +## Methods + +### NewTaskResultDetailsReturnsInner + +`func NewTaskResultDetailsReturnsInner() *TaskResultDetailsReturnsInner` + +NewTaskResultDetailsReturnsInner instantiates a new TaskResultDetailsReturnsInner 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 + +### NewTaskResultDetailsReturnsInnerWithDefaults + +`func NewTaskResultDetailsReturnsInnerWithDefaults() *TaskResultDetailsReturnsInner` + +NewTaskResultDetailsReturnsInnerWithDefaults instantiates a new TaskResultDetailsReturnsInner 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 + +### GetDisplayLabel + +`func (o *TaskResultDetailsReturnsInner) GetDisplayLabel() string` + +GetDisplayLabel returns the DisplayLabel field if non-nil, zero value otherwise. + +### GetDisplayLabelOk + +`func (o *TaskResultDetailsReturnsInner) GetDisplayLabelOk() (*string, bool)` + +GetDisplayLabelOk returns a tuple with the DisplayLabel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayLabel + +`func (o *TaskResultDetailsReturnsInner) SetDisplayLabel(v string)` + +SetDisplayLabel sets DisplayLabel field to given value. + +### HasDisplayLabel + +`func (o *TaskResultDetailsReturnsInner) HasDisplayLabel() bool` + +HasDisplayLabel returns a boolean if a field has been set. + +### GetAttributeName + +`func (o *TaskResultDetailsReturnsInner) GetAttributeName() string` + +GetAttributeName returns the AttributeName field if non-nil, zero value otherwise. + +### GetAttributeNameOk + +`func (o *TaskResultDetailsReturnsInner) GetAttributeNameOk() (*string, bool)` + +GetAttributeNameOk returns a tuple with the AttributeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributeName + +`func (o *TaskResultDetailsReturnsInner) SetAttributeName(v string)` + +SetAttributeName sets AttributeName field to given value. + +### HasAttributeName + +`func (o *TaskResultDetailsReturnsInner) HasAttributeName() bool` + +HasAttributeName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TaskResultDto.md b/docs/tools/sdk/go/Reference/V3/Models/TaskResultDto.md new file mode 100644 index 000000000..352947718 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TaskResultDto.md @@ -0,0 +1,126 @@ +--- +id: task-result-dto +title: TaskResultDto +pagination_label: TaskResultDto +sidebar_label: TaskResultDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultDto', 'TaskResultDto'] +slug: /tools/sdk/go/v3/models/task-result-dto +tags: ['SDK', 'Software Development Kit', 'TaskResultDto', 'TaskResultDto'] +--- + +# TaskResultDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Task result DTO type. | [optional] +**Id** | Pointer to **string** | Task result ID. | [optional] +**Name** | Pointer to **NullableString** | Task result display name. | [optional] + +## Methods + +### NewTaskResultDto + +`func NewTaskResultDto() *TaskResultDto` + +NewTaskResultDto instantiates a new TaskResultDto 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 + +### NewTaskResultDtoWithDefaults + +`func NewTaskResultDtoWithDefaults() *TaskResultDto` + +NewTaskResultDtoWithDefaults instantiates a new TaskResultDto 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 + +### GetType + +`func (o *TaskResultDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TaskResultDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TaskResultDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TaskResultDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *TaskResultDto) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskResultDto) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskResultDto) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaskResultDto) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TaskResultDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaskResultDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaskResultDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TaskResultDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *TaskResultDto) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *TaskResultDto) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TaskResultSimplified.md b/docs/tools/sdk/go/Reference/V3/Models/TaskResultSimplified.md new file mode 100644 index 000000000..1fd9c1ca0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TaskResultSimplified.md @@ -0,0 +1,220 @@ +--- +id: task-result-simplified +title: TaskResultSimplified +pagination_label: TaskResultSimplified +sidebar_label: TaskResultSimplified +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TaskResultSimplified', 'TaskResultSimplified'] +slug: /tools/sdk/go/v3/models/task-result-simplified +tags: ['SDK', 'Software Development Kit', 'TaskResultSimplified', 'TaskResultSimplified'] +--- + +# TaskResultSimplified + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Task identifier | [optional] +**Name** | Pointer to **string** | Task name | [optional] +**Description** | Pointer to **string** | Task description | [optional] +**Launcher** | Pointer to **string** | User or process who launched the task | [optional] +**Completed** | Pointer to **SailPointTime** | Date time of completion | [optional] +**Launched** | Pointer to **SailPointTime** | Date time when the task was launched | [optional] +**CompletionStatus** | Pointer to **string** | Task result status | [optional] + +## Methods + +### NewTaskResultSimplified + +`func NewTaskResultSimplified() *TaskResultSimplified` + +NewTaskResultSimplified instantiates a new TaskResultSimplified 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 + +### NewTaskResultSimplifiedWithDefaults + +`func NewTaskResultSimplifiedWithDefaults() *TaskResultSimplified` + +NewTaskResultSimplifiedWithDefaults instantiates a new TaskResultSimplified 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 + +### GetId + +`func (o *TaskResultSimplified) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TaskResultSimplified) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TaskResultSimplified) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TaskResultSimplified) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TaskResultSimplified) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TaskResultSimplified) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TaskResultSimplified) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TaskResultSimplified) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *TaskResultSimplified) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *TaskResultSimplified) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *TaskResultSimplified) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *TaskResultSimplified) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetLauncher + +`func (o *TaskResultSimplified) GetLauncher() string` + +GetLauncher returns the Launcher field if non-nil, zero value otherwise. + +### GetLauncherOk + +`func (o *TaskResultSimplified) GetLauncherOk() (*string, bool)` + +GetLauncherOk returns a tuple with the Launcher field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLauncher + +`func (o *TaskResultSimplified) SetLauncher(v string)` + +SetLauncher sets Launcher field to given value. + +### HasLauncher + +`func (o *TaskResultSimplified) HasLauncher() bool` + +HasLauncher returns a boolean if a field has been set. + +### GetCompleted + +`func (o *TaskResultSimplified) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *TaskResultSimplified) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *TaskResultSimplified) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *TaskResultSimplified) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetLaunched + +`func (o *TaskResultSimplified) GetLaunched() SailPointTime` + +GetLaunched returns the Launched field if non-nil, zero value otherwise. + +### GetLaunchedOk + +`func (o *TaskResultSimplified) GetLaunchedOk() (*SailPointTime, bool)` + +GetLaunchedOk returns a tuple with the Launched field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLaunched + +`func (o *TaskResultSimplified) SetLaunched(v SailPointTime)` + +SetLaunched sets Launched field to given value. + +### HasLaunched + +`func (o *TaskResultSimplified) HasLaunched() bool` + +HasLaunched returns a boolean if a field has been set. + +### GetCompletionStatus + +`func (o *TaskResultSimplified) GetCompletionStatus() string` + +GetCompletionStatus returns the CompletionStatus field if non-nil, zero value otherwise. + +### GetCompletionStatusOk + +`func (o *TaskResultSimplified) GetCompletionStatusOk() (*string, bool)` + +GetCompletionStatusOk returns a tuple with the CompletionStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompletionStatus + +`func (o *TaskResultSimplified) SetCompletionStatus(v string)` + +SetCompletionStatus sets CompletionStatus field to given value. + +### HasCompletionStatus + +`func (o *TaskResultSimplified) HasCompletionStatus() bool` + +HasCompletionStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TestExternalExecuteWorkflow200Response.md b/docs/tools/sdk/go/Reference/V3/Models/TestExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..5f9a85827 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TestExternalExecuteWorkflow200Response.md @@ -0,0 +1,64 @@ +--- +id: test-external-execute-workflow200-response +title: TestExternalExecuteWorkflow200Response +pagination_label: TestExternalExecuteWorkflow200Response +sidebar_label: TestExternalExecuteWorkflow200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestExternalExecuteWorkflow200Response', 'TestExternalExecuteWorkflow200Response'] +slug: /tools/sdk/go/v3/models/test-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflow200Response', 'TestExternalExecuteWorkflow200Response'] +--- + +# TestExternalExecuteWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Payload** | Pointer to **map[string]interface{}** | The input that was received | [optional] + +## Methods + +### NewTestExternalExecuteWorkflow200Response + +`func NewTestExternalExecuteWorkflow200Response() *TestExternalExecuteWorkflow200Response` + +NewTestExternalExecuteWorkflow200Response instantiates a new TestExternalExecuteWorkflow200Response 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 + +### NewTestExternalExecuteWorkflow200ResponseWithDefaults + +`func NewTestExternalExecuteWorkflow200ResponseWithDefaults() *TestExternalExecuteWorkflow200Response` + +NewTestExternalExecuteWorkflow200ResponseWithDefaults instantiates a new TestExternalExecuteWorkflow200Response 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 + +### GetPayload + +`func (o *TestExternalExecuteWorkflow200Response) GetPayload() map[string]interface{}` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *TestExternalExecuteWorkflow200Response) GetPayloadOk() (*map[string]interface{}, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPayload + +`func (o *TestExternalExecuteWorkflow200Response) SetPayload(v map[string]interface{})` + +SetPayload sets Payload field to given value. + +### HasPayload + +`func (o *TestExternalExecuteWorkflow200Response) HasPayload() bool` + +HasPayload returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TestExternalExecuteWorkflowRequest.md b/docs/tools/sdk/go/Reference/V3/Models/TestExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..e89bafff3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TestExternalExecuteWorkflowRequest.md @@ -0,0 +1,64 @@ +--- +id: test-external-execute-workflow-request +title: TestExternalExecuteWorkflowRequest +pagination_label: TestExternalExecuteWorkflowRequest +sidebar_label: TestExternalExecuteWorkflowRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestExternalExecuteWorkflowRequest', 'TestExternalExecuteWorkflowRequest'] +slug: /tools/sdk/go/v3/models/test-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflowRequest', 'TestExternalExecuteWorkflowRequest'] +--- + +# TestExternalExecuteWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | Pointer to **map[string]interface{}** | The test input for the workflow | [optional] + +## Methods + +### NewTestExternalExecuteWorkflowRequest + +`func NewTestExternalExecuteWorkflowRequest() *TestExternalExecuteWorkflowRequest` + +NewTestExternalExecuteWorkflowRequest instantiates a new TestExternalExecuteWorkflowRequest 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 + +### NewTestExternalExecuteWorkflowRequestWithDefaults + +`func NewTestExternalExecuteWorkflowRequestWithDefaults() *TestExternalExecuteWorkflowRequest` + +NewTestExternalExecuteWorkflowRequestWithDefaults instantiates a new TestExternalExecuteWorkflowRequest 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 + +### GetInput + +`func (o *TestExternalExecuteWorkflowRequest) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *TestExternalExecuteWorkflowRequest) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *TestExternalExecuteWorkflowRequest) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + +### HasInput + +`func (o *TestExternalExecuteWorkflowRequest) HasInput() bool` + +HasInput returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TestWorkflow200Response.md b/docs/tools/sdk/go/Reference/V3/Models/TestWorkflow200Response.md new file mode 100644 index 000000000..a9a4de16e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TestWorkflow200Response.md @@ -0,0 +1,64 @@ +--- +id: test-workflow200-response +title: TestWorkflow200Response +pagination_label: TestWorkflow200Response +sidebar_label: TestWorkflow200Response +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestWorkflow200Response', 'TestWorkflow200Response'] +slug: /tools/sdk/go/v3/models/test-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestWorkflow200Response', 'TestWorkflow200Response'] +--- + +# TestWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**WorkflowExecutionId** | Pointer to **string** | The workflow execution id | [optional] + +## Methods + +### NewTestWorkflow200Response + +`func NewTestWorkflow200Response() *TestWorkflow200Response` + +NewTestWorkflow200Response instantiates a new TestWorkflow200Response 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 + +### NewTestWorkflow200ResponseWithDefaults + +`func NewTestWorkflow200ResponseWithDefaults() *TestWorkflow200Response` + +NewTestWorkflow200ResponseWithDefaults instantiates a new TestWorkflow200Response 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 + +### GetWorkflowExecutionId + +`func (o *TestWorkflow200Response) GetWorkflowExecutionId() string` + +GetWorkflowExecutionId returns the WorkflowExecutionId field if non-nil, zero value otherwise. + +### GetWorkflowExecutionIdOk + +`func (o *TestWorkflow200Response) GetWorkflowExecutionIdOk() (*string, bool)` + +GetWorkflowExecutionIdOk returns a tuple with the WorkflowExecutionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWorkflowExecutionId + +`func (o *TestWorkflow200Response) SetWorkflowExecutionId(v string)` + +SetWorkflowExecutionId sets WorkflowExecutionId field to given value. + +### HasWorkflowExecutionId + +`func (o *TestWorkflow200Response) HasWorkflowExecutionId() bool` + +HasWorkflowExecutionId returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TestWorkflowRequest.md b/docs/tools/sdk/go/Reference/V3/Models/TestWorkflowRequest.md new file mode 100644 index 000000000..f3843db84 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TestWorkflowRequest.md @@ -0,0 +1,59 @@ +--- +id: test-workflow-request +title: TestWorkflowRequest +pagination_label: TestWorkflowRequest +sidebar_label: TestWorkflowRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TestWorkflowRequest', 'TestWorkflowRequest'] +slug: /tools/sdk/go/v3/models/test-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestWorkflowRequest', 'TestWorkflowRequest'] +--- + +# TestWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Input** | **map[string]interface{}** | The test input for the workflow. | + +## Methods + +### NewTestWorkflowRequest + +`func NewTestWorkflowRequest(input map[string]interface{}, ) *TestWorkflowRequest` + +NewTestWorkflowRequest instantiates a new TestWorkflowRequest 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 + +### NewTestWorkflowRequestWithDefaults + +`func NewTestWorkflowRequestWithDefaults() *TestWorkflowRequest` + +NewTestWorkflowRequestWithDefaults instantiates a new TestWorkflowRequest 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 + +### GetInput + +`func (o *TestWorkflowRequest) GetInput() map[string]interface{}` + +GetInput returns the Input field if non-nil, zero value otherwise. + +### GetInputOk + +`func (o *TestWorkflowRequest) GetInputOk() (*map[string]interface{}, bool)` + +GetInputOk returns a tuple with the Input field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInput + +`func (o *TestWorkflowRequest) SetInput(v map[string]interface{})` + +SetInput sets Input field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TextQuery.md b/docs/tools/sdk/go/Reference/V3/Models/TextQuery.md new file mode 100644 index 000000000..20645d734 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TextQuery.md @@ -0,0 +1,132 @@ +--- +id: text-query +title: TextQuery +pagination_label: TextQuery +sidebar_label: TextQuery +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TextQuery', 'TextQuery'] +slug: /tools/sdk/go/v3/models/text-query +tags: ['SDK', 'Software Development Kit', 'TextQuery', 'TextQuery'] +--- + +# TextQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Terms** | **[]string** | Words or characters that specify a particular thing to be searched for. | +**Fields** | **[]string** | The fields to be searched. | +**MatchAny** | Pointer to **bool** | Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. | [optional] [default to false] +**Contains** | Pointer to **bool** | Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. | [optional] [default to false] + +## Methods + +### NewTextQuery + +`func NewTextQuery(terms []string, fields []string, ) *TextQuery` + +NewTextQuery instantiates a new TextQuery 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 + +### NewTextQueryWithDefaults + +`func NewTextQueryWithDefaults() *TextQuery` + +NewTextQueryWithDefaults instantiates a new TextQuery 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 + +### GetTerms + +`func (o *TextQuery) GetTerms() []string` + +GetTerms returns the Terms field if non-nil, zero value otherwise. + +### GetTermsOk + +`func (o *TextQuery) GetTermsOk() (*[]string, bool)` + +GetTermsOk returns a tuple with the Terms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerms + +`func (o *TextQuery) SetTerms(v []string)` + +SetTerms sets Terms field to given value. + + +### GetFields + +`func (o *TextQuery) GetFields() []string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *TextQuery) GetFieldsOk() (*[]string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *TextQuery) SetFields(v []string)` + +SetFields sets Fields field to given value. + + +### GetMatchAny + +`func (o *TextQuery) GetMatchAny() bool` + +GetMatchAny returns the MatchAny field if non-nil, zero value otherwise. + +### GetMatchAnyOk + +`func (o *TextQuery) GetMatchAnyOk() (*bool, bool)` + +GetMatchAnyOk returns a tuple with the MatchAny field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAny + +`func (o *TextQuery) SetMatchAny(v bool)` + +SetMatchAny sets MatchAny field to given value. + +### HasMatchAny + +`func (o *TextQuery) HasMatchAny() bool` + +HasMatchAny returns a boolean if a field has been set. + +### GetContains + +`func (o *TextQuery) GetContains() bool` + +GetContains returns the Contains field if non-nil, zero value otherwise. + +### GetContainsOk + +`func (o *TextQuery) GetContainsOk() (*bool, bool)` + +GetContainsOk returns a tuple with the Contains field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContains + +`func (o *TextQuery) SetContains(v bool)` + +SetContains sets Contains field to given value. + +### HasContains + +`func (o *TextQuery) HasContains() bool` + +HasContains returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TokenAuthRequest.md b/docs/tools/sdk/go/Reference/V3/Models/TokenAuthRequest.md new file mode 100644 index 000000000..cd137eef9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TokenAuthRequest.md @@ -0,0 +1,101 @@ +--- +id: token-auth-request +title: TokenAuthRequest +pagination_label: TokenAuthRequest +sidebar_label: TokenAuthRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TokenAuthRequest', 'TokenAuthRequest'] +slug: /tools/sdk/go/v3/models/token-auth-request +tags: ['SDK', 'Software Development Kit', 'TokenAuthRequest', 'TokenAuthRequest'] +--- + +# TokenAuthRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Token** | **string** | Token value | +**UserAlias** | **string** | User alias from table spt_identity field named 'name' | +**DeliveryType** | **string** | Token delivery type | + +## Methods + +### NewTokenAuthRequest + +`func NewTokenAuthRequest(token string, userAlias string, deliveryType string, ) *TokenAuthRequest` + +NewTokenAuthRequest instantiates a new TokenAuthRequest 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 + +### NewTokenAuthRequestWithDefaults + +`func NewTokenAuthRequestWithDefaults() *TokenAuthRequest` + +NewTokenAuthRequestWithDefaults instantiates a new TokenAuthRequest 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 + +### GetToken + +`func (o *TokenAuthRequest) GetToken() string` + +GetToken returns the Token field if non-nil, zero value otherwise. + +### GetTokenOk + +`func (o *TokenAuthRequest) GetTokenOk() (*string, bool)` + +GetTokenOk returns a tuple with the Token field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetToken + +`func (o *TokenAuthRequest) SetToken(v string)` + +SetToken sets Token field to given value. + + +### GetUserAlias + +`func (o *TokenAuthRequest) GetUserAlias() string` + +GetUserAlias returns the UserAlias field if non-nil, zero value otherwise. + +### GetUserAliasOk + +`func (o *TokenAuthRequest) GetUserAliasOk() (*string, bool)` + +GetUserAliasOk returns a tuple with the UserAlias field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserAlias + +`func (o *TokenAuthRequest) SetUserAlias(v string)` + +SetUserAlias sets UserAlias field to given value. + + +### GetDeliveryType + +`func (o *TokenAuthRequest) GetDeliveryType() string` + +GetDeliveryType returns the DeliveryType field if non-nil, zero value otherwise. + +### GetDeliveryTypeOk + +`func (o *TokenAuthRequest) GetDeliveryTypeOk() (*string, bool)` + +GetDeliveryTypeOk returns a tuple with the DeliveryType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeliveryType + +`func (o *TokenAuthRequest) SetDeliveryType(v string)` + +SetDeliveryType sets DeliveryType field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TokenAuthResponse.md b/docs/tools/sdk/go/Reference/V3/Models/TokenAuthResponse.md new file mode 100644 index 000000000..0d608b472 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TokenAuthResponse.md @@ -0,0 +1,64 @@ +--- +id: token-auth-response +title: TokenAuthResponse +pagination_label: TokenAuthResponse +sidebar_label: TokenAuthResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TokenAuthResponse', 'TokenAuthResponse'] +slug: /tools/sdk/go/v3/models/token-auth-response +tags: ['SDK', 'Software Development Kit', 'TokenAuthResponse', 'TokenAuthResponse'] +--- + +# TokenAuthResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | MFA Authentication status | [optional] + +## Methods + +### NewTokenAuthResponse + +`func NewTokenAuthResponse() *TokenAuthResponse` + +NewTokenAuthResponse instantiates a new TokenAuthResponse 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 + +### NewTokenAuthResponseWithDefaults + +`func NewTokenAuthResponseWithDefaults() *TokenAuthResponse` + +NewTokenAuthResponseWithDefaults instantiates a new TokenAuthResponse 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 + +### GetStatus + +`func (o *TokenAuthResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *TokenAuthResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *TokenAuthResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *TokenAuthResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Transform.md b/docs/tools/sdk/go/Reference/V3/Models/Transform.md new file mode 100644 index 000000000..832de9f43 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Transform.md @@ -0,0 +1,111 @@ +--- +id: transform +title: Transform +pagination_label: Transform +sidebar_label: Transform +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Transform', 'Transform'] +slug: /tools/sdk/go/v3/models/transform +tags: ['SDK', 'Software Development Kit', 'Transform', 'Transform'] +--- + +# Transform + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Unique name of this transform | +**Type** | **string** | The type of transform operation | +**Attributes** | **map[string]interface{}** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | + +## Methods + +### NewTransform + +`func NewTransform(name string, type_ string, attributes map[string]interface{}, ) *Transform` + +NewTransform instantiates a new Transform 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 + +### NewTransformWithDefaults + +`func NewTransformWithDefaults() *Transform` + +NewTransformWithDefaults instantiates a new Transform 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 + +### GetName + +`func (o *Transform) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Transform) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Transform) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *Transform) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Transform) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Transform) SetType(v string)` + +SetType sets Type field to given value. + + +### GetAttributes + +`func (o *Transform) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Transform) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *Transform) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *Transform) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *Transform) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TransformDefinition.md b/docs/tools/sdk/go/Reference/V3/Models/TransformDefinition.md new file mode 100644 index 000000000..7d9489b98 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TransformDefinition.md @@ -0,0 +1,90 @@ +--- +id: transform-definition +title: TransformDefinition +pagination_label: TransformDefinition +sidebar_label: TransformDefinition +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TransformDefinition', 'TransformDefinition'] +slug: /tools/sdk/go/v3/models/transform-definition +tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'TransformDefinition'] +--- + +# TransformDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Transform definition type. | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Arbitrary key-value pairs to store any metadata for the object | [optional] + +## Methods + +### NewTransformDefinition + +`func NewTransformDefinition() *TransformDefinition` + +NewTransformDefinition instantiates a new TransformDefinition 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 + +### NewTransformDefinitionWithDefaults + +`func NewTransformDefinitionWithDefaults() *TransformDefinition` + +NewTransformDefinitionWithDefaults instantiates a new TransformDefinition 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 + +### GetType + +`func (o *TransformDefinition) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TransformDefinition) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TransformDefinition) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *TransformDefinition) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetAttributes + +`func (o *TransformDefinition) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TransformDefinition) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TransformDefinition) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *TransformDefinition) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TransformRead.md b/docs/tools/sdk/go/Reference/V3/Models/TransformRead.md new file mode 100644 index 000000000..10de49edc --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TransformRead.md @@ -0,0 +1,153 @@ +--- +id: transform-read +title: TransformRead +pagination_label: TransformRead +sidebar_label: TransformRead +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TransformRead', 'TransformRead'] +slug: /tools/sdk/go/v3/models/transform-read +tags: ['SDK', 'Software Development Kit', 'TransformRead', 'TransformRead'] +--- + +# TransformRead + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | Unique name of this transform | +**Type** | **string** | The type of transform operation | +**Attributes** | **map[string]interface{}** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | +**Id** | **string** | Unique ID of this transform | +**Internal** | **bool** | Indicates whether this is an internal SailPoint-created transform or a customer-created transform | [default to false] + +## Methods + +### NewTransformRead + +`func NewTransformRead(name string, type_ string, attributes map[string]interface{}, id string, internal bool, ) *TransformRead` + +NewTransformRead instantiates a new TransformRead 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 + +### NewTransformReadWithDefaults + +`func NewTransformReadWithDefaults() *TransformRead` + +NewTransformReadWithDefaults instantiates a new TransformRead 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 + +### GetName + +`func (o *TransformRead) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TransformRead) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TransformRead) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *TransformRead) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TransformRead) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TransformRead) SetType(v string)` + +SetType sets Type field to given value. + + +### GetAttributes + +`func (o *TransformRead) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *TransformRead) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *TransformRead) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *TransformRead) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *TransformRead) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil +### GetId + +`func (o *TransformRead) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TransformRead) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TransformRead) SetId(v string)` + +SetId sets Id field to given value. + + +### GetInternal + +`func (o *TransformRead) GetInternal() bool` + +GetInternal returns the Internal field if non-nil, zero value otherwise. + +### GetInternalOk + +`func (o *TransformRead) GetInternalOk() (*bool, bool)` + +GetInternalOk returns a tuple with the Internal field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInternal + +`func (o *TransformRead) SetInternal(v bool)` + +SetInternal sets Internal field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TypeAheadQuery.md b/docs/tools/sdk/go/Reference/V3/Models/TypeAheadQuery.md new file mode 100644 index 000000000..57be23629 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TypeAheadQuery.md @@ -0,0 +1,210 @@ +--- +id: type-ahead-query +title: TypeAheadQuery +pagination_label: TypeAheadQuery +sidebar_label: TypeAheadQuery +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TypeAheadQuery', 'TypeAheadQuery'] +slug: /tools/sdk/go/v3/models/type-ahead-query +tags: ['SDK', 'Software Development Kit', 'TypeAheadQuery', 'TypeAheadQuery'] +--- + +# TypeAheadQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **string** | The type ahead query string used to construct a phrase prefix match query. | +**Field** | **string** | The field on which to perform the type ahead search. | +**NestedType** | Pointer to **string** | The nested type. | [optional] +**MaxExpansions** | Pointer to **int32** | The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000. | [optional] [default to 10] +**Size** | Pointer to **int32** | The max amount of records the search will return. | [optional] [default to 100] +**Sort** | Pointer to **string** | The sort order of the returned records. | [optional] [default to "desc"] +**SortByValue** | Pointer to **bool** | The flag that defines the sort type, by count or value. | [optional] [default to false] + +## Methods + +### NewTypeAheadQuery + +`func NewTypeAheadQuery(query string, field string, ) *TypeAheadQuery` + +NewTypeAheadQuery instantiates a new TypeAheadQuery 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 + +### NewTypeAheadQueryWithDefaults + +`func NewTypeAheadQueryWithDefaults() *TypeAheadQuery` + +NewTypeAheadQueryWithDefaults instantiates a new TypeAheadQuery 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 + +### GetQuery + +`func (o *TypeAheadQuery) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *TypeAheadQuery) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *TypeAheadQuery) SetQuery(v string)` + +SetQuery sets Query field to given value. + + +### GetField + +`func (o *TypeAheadQuery) GetField() string` + +GetField returns the Field field if non-nil, zero value otherwise. + +### GetFieldOk + +`func (o *TypeAheadQuery) GetFieldOk() (*string, bool)` + +GetFieldOk returns a tuple with the Field field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetField + +`func (o *TypeAheadQuery) SetField(v string)` + +SetField sets Field field to given value. + + +### GetNestedType + +`func (o *TypeAheadQuery) GetNestedType() string` + +GetNestedType returns the NestedType field if non-nil, zero value otherwise. + +### GetNestedTypeOk + +`func (o *TypeAheadQuery) GetNestedTypeOk() (*string, bool)` + +GetNestedTypeOk returns a tuple with the NestedType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNestedType + +`func (o *TypeAheadQuery) SetNestedType(v string)` + +SetNestedType sets NestedType field to given value. + +### HasNestedType + +`func (o *TypeAheadQuery) HasNestedType() bool` + +HasNestedType returns a boolean if a field has been set. + +### GetMaxExpansions + +`func (o *TypeAheadQuery) GetMaxExpansions() int32` + +GetMaxExpansions returns the MaxExpansions field if non-nil, zero value otherwise. + +### GetMaxExpansionsOk + +`func (o *TypeAheadQuery) GetMaxExpansionsOk() (*int32, bool)` + +GetMaxExpansionsOk returns a tuple with the MaxExpansions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaxExpansions + +`func (o *TypeAheadQuery) SetMaxExpansions(v int32)` + +SetMaxExpansions sets MaxExpansions field to given value. + +### HasMaxExpansions + +`func (o *TypeAheadQuery) HasMaxExpansions() bool` + +HasMaxExpansions returns a boolean if a field has been set. + +### GetSize + +`func (o *TypeAheadQuery) GetSize() int32` + +GetSize returns the Size field if non-nil, zero value otherwise. + +### GetSizeOk + +`func (o *TypeAheadQuery) GetSizeOk() (*int32, bool)` + +GetSizeOk returns a tuple with the Size field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSize + +`func (o *TypeAheadQuery) SetSize(v int32)` + +SetSize sets Size field to given value. + +### HasSize + +`func (o *TypeAheadQuery) HasSize() bool` + +HasSize returns a boolean if a field has been set. + +### GetSort + +`func (o *TypeAheadQuery) GetSort() string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *TypeAheadQuery) GetSortOk() (*string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *TypeAheadQuery) SetSort(v string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *TypeAheadQuery) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### GetSortByValue + +`func (o *TypeAheadQuery) GetSortByValue() bool` + +GetSortByValue returns the SortByValue field if non-nil, zero value otherwise. + +### GetSortByValueOk + +`func (o *TypeAheadQuery) GetSortByValueOk() (*bool, bool)` + +GetSortByValueOk returns a tuple with the SortByValue field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSortByValue + +`func (o *TypeAheadQuery) SetSortByValue(v bool)` + +SetSortByValue sets SortByValue field to given value. + +### HasSortByValue + +`func (o *TypeAheadQuery) HasSortByValue() bool` + +HasSortByValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/TypedReference.md b/docs/tools/sdk/go/Reference/V3/Models/TypedReference.md new file mode 100644 index 000000000..dce3edede --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/TypedReference.md @@ -0,0 +1,80 @@ +--- +id: typed-reference +title: TypedReference +pagination_label: TypedReference +sidebar_label: TypedReference +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'TypedReference', 'TypedReference'] +slug: /tools/sdk/go/v3/models/typed-reference +tags: ['SDK', 'Software Development Kit', 'TypedReference', 'TypedReference'] +--- + +# TypedReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**DtoType**](dto-type) | | +**Id** | **string** | The id of the object. | + +## Methods + +### NewTypedReference + +`func NewTypedReference(type_ DtoType, id string, ) *TypedReference` + +NewTypedReference instantiates a new TypedReference 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 + +### NewTypedReferenceWithDefaults + +`func NewTypedReferenceWithDefaults() *TypedReference` + +NewTypedReferenceWithDefaults instantiates a new TypedReference 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 + +### GetType + +`func (o *TypedReference) GetType() DtoType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *TypedReference) GetTypeOk() (*DtoType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *TypedReference) SetType(v DtoType)` + +SetType sets Type field to given value. + + +### GetId + +`func (o *TypedReference) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TypedReference) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TypedReference) SetId(v string)` + +SetId sets Id field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/UncorrelatedAccountsReportArguments.md b/docs/tools/sdk/go/Reference/V3/Models/UncorrelatedAccountsReportArguments.md new file mode 100644 index 000000000..06b4adbd8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/UncorrelatedAccountsReportArguments.md @@ -0,0 +1,64 @@ +--- +id: uncorrelated-accounts-report-arguments +title: UncorrelatedAccountsReportArguments +pagination_label: UncorrelatedAccountsReportArguments +sidebar_label: UncorrelatedAccountsReportArguments +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UncorrelatedAccountsReportArguments', 'UncorrelatedAccountsReportArguments'] +slug: /tools/sdk/go/v3/models/uncorrelated-accounts-report-arguments +tags: ['SDK', 'Software Development Kit', 'UncorrelatedAccountsReportArguments', 'UncorrelatedAccountsReportArguments'] +--- + +# UncorrelatedAccountsReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SelectedFormats** | Pointer to **[]string** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] + +## Methods + +### NewUncorrelatedAccountsReportArguments + +`func NewUncorrelatedAccountsReportArguments() *UncorrelatedAccountsReportArguments` + +NewUncorrelatedAccountsReportArguments instantiates a new UncorrelatedAccountsReportArguments 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 + +### NewUncorrelatedAccountsReportArgumentsWithDefaults + +`func NewUncorrelatedAccountsReportArgumentsWithDefaults() *UncorrelatedAccountsReportArguments` + +NewUncorrelatedAccountsReportArgumentsWithDefaults instantiates a new UncorrelatedAccountsReportArguments 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 + +### GetSelectedFormats + +`func (o *UncorrelatedAccountsReportArguments) GetSelectedFormats() []string` + +GetSelectedFormats returns the SelectedFormats field if non-nil, zero value otherwise. + +### GetSelectedFormatsOk + +`func (o *UncorrelatedAccountsReportArguments) GetSelectedFormatsOk() (*[]string, bool)` + +GetSelectedFormatsOk returns a tuple with the SelectedFormats field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSelectedFormats + +`func (o *UncorrelatedAccountsReportArguments) SetSelectedFormats(v []string)` + +SetSelectedFormats sets SelectedFormats field to given value. + +### HasSelectedFormats + +`func (o *UncorrelatedAccountsReportArguments) HasSelectedFormats() bool` + +HasSelectedFormats returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/UpdateDetail.md b/docs/tools/sdk/go/Reference/V3/Models/UpdateDetail.md new file mode 100644 index 000000000..3bc0fd93c --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/UpdateDetail.md @@ -0,0 +1,152 @@ +--- +id: update-detail +title: UpdateDetail +pagination_label: UpdateDetail +sidebar_label: UpdateDetail +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UpdateDetail', 'UpdateDetail'] +slug: /tools/sdk/go/v3/models/update-detail +tags: ['SDK', 'Software Development Kit', 'UpdateDetail', 'UpdateDetail'] +--- + +# UpdateDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **string** | The detailed message for an update. Typically the relevent error message when status is error. | [optional] +**ScriptName** | Pointer to **string** | The connector script name | [optional] +**UpdatedFiles** | Pointer to **[]string** | The list of updated files supported by the connector | [optional] +**Status** | Pointer to **string** | The connector update status | [optional] + +## Methods + +### NewUpdateDetail + +`func NewUpdateDetail() *UpdateDetail` + +NewUpdateDetail instantiates a new UpdateDetail 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 + +### NewUpdateDetailWithDefaults + +`func NewUpdateDetailWithDefaults() *UpdateDetail` + +NewUpdateDetailWithDefaults instantiates a new UpdateDetail 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 + +### GetMessage + +`func (o *UpdateDetail) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *UpdateDetail) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *UpdateDetail) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *UpdateDetail) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### GetScriptName + +`func (o *UpdateDetail) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *UpdateDetail) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *UpdateDetail) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + +### HasScriptName + +`func (o *UpdateDetail) HasScriptName() bool` + +HasScriptName returns a boolean if a field has been set. + +### GetUpdatedFiles + +`func (o *UpdateDetail) GetUpdatedFiles() []string` + +GetUpdatedFiles returns the UpdatedFiles field if non-nil, zero value otherwise. + +### GetUpdatedFilesOk + +`func (o *UpdateDetail) GetUpdatedFilesOk() (*[]string, bool)` + +GetUpdatedFilesOk returns a tuple with the UpdatedFiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedFiles + +`func (o *UpdateDetail) SetUpdatedFiles(v []string)` + +SetUpdatedFiles sets UpdatedFiles field to given value. + +### HasUpdatedFiles + +`func (o *UpdateDetail) HasUpdatedFiles() bool` + +HasUpdatedFiles returns a boolean if a field has been set. + +### SetUpdatedFilesNil + +`func (o *UpdateDetail) SetUpdatedFilesNil(b bool)` + + SetUpdatedFilesNil sets the value for UpdatedFiles to be an explicit nil + +### UnsetUpdatedFiles +`func (o *UpdateDetail) UnsetUpdatedFiles()` + +UnsetUpdatedFiles ensures that no value is present for UpdatedFiles, not even an explicit nil +### GetStatus + +`func (o *UpdateDetail) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *UpdateDetail) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *UpdateDetail) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *UpdateDetail) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/UsageType.md b/docs/tools/sdk/go/Reference/V3/Models/UsageType.md new file mode 100644 index 000000000..3ed2a6253 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/UsageType.md @@ -0,0 +1,49 @@ +--- +id: usage-type +title: UsageType +pagination_label: UsageType +sidebar_label: UsageType +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'UsageType', 'UsageType'] +slug: /tools/sdk/go/v3/models/usage-type +tags: ['SDK', 'Software Development Kit', 'UsageType', 'UsageType'] +--- + +# UsageType + +## Enum + + +* `CREATE` (value: `"CREATE"`) + +* `UPDATE` (value: `"UPDATE"`) + +* `ENABLE` (value: `"ENABLE"`) + +* `DISABLE` (value: `"DISABLE"`) + +* `DELETE` (value: `"DELETE"`) + +* `ASSIGN` (value: `"ASSIGN"`) + +* `UNASSIGN` (value: `"UNASSIGN"`) + +* `CREATE_GROUP` (value: `"CREATE_GROUP"`) + +* `UPDATE_GROUP` (value: `"UPDATE_GROUP"`) + +* `DELETE_GROUP` (value: `"DELETE_GROUP"`) + +* `REGISTER` (value: `"REGISTER"`) + +* `CREATE_IDENTITY` (value: `"CREATE_IDENTITY"`) + +* `UPDATE_IDENTITY` (value: `"UPDATE_IDENTITY"`) + +* `EDIT_GROUP` (value: `"EDIT_GROUP"`) + +* `UNLOCK` (value: `"UNLOCK"`) + +* `CHANGE_PASSWORD` (value: `"CHANGE_PASSWORD"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/V3ConnectorDto.md b/docs/tools/sdk/go/Reference/V3/Models/V3ConnectorDto.md new file mode 100644 index 000000000..534365edd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/V3ConnectorDto.md @@ -0,0 +1,266 @@ +--- +id: v3-connector-dto +title: V3ConnectorDto +pagination_label: V3ConnectorDto +sidebar_label: V3ConnectorDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'V3ConnectorDto', 'V3ConnectorDto'] +slug: /tools/sdk/go/v3/models/v3-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3ConnectorDto', 'V3ConnectorDto'] +--- + +# V3ConnectorDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The connector name | [optional] +**Type** | Pointer to **string** | The connector type | [optional] +**ScriptName** | Pointer to **string** | The connector script name | [optional] +**ClassName** | Pointer to **NullableString** | The connector class name. | [optional] +**Features** | Pointer to **[]string** | The list of features supported by the connector | [optional] +**DirectConnect** | Pointer to **bool** | true if the source is a direct connect source | [optional] [default to false] +**ConnectorMetadata** | Pointer to **map[string]interface{}** | A map containing metadata pertinent to the connector | [optional] +**Status** | Pointer to **string** | The connector status | [optional] + +## Methods + +### NewV3ConnectorDto + +`func NewV3ConnectorDto() *V3ConnectorDto` + +NewV3ConnectorDto instantiates a new V3ConnectorDto 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 + +### NewV3ConnectorDtoWithDefaults + +`func NewV3ConnectorDtoWithDefaults() *V3ConnectorDto` + +NewV3ConnectorDtoWithDefaults instantiates a new V3ConnectorDto 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 + +### GetName + +`func (o *V3ConnectorDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *V3ConnectorDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *V3ConnectorDto) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *V3ConnectorDto) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *V3ConnectorDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *V3ConnectorDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *V3ConnectorDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *V3ConnectorDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetScriptName + +`func (o *V3ConnectorDto) GetScriptName() string` + +GetScriptName returns the ScriptName field if non-nil, zero value otherwise. + +### GetScriptNameOk + +`func (o *V3ConnectorDto) GetScriptNameOk() (*string, bool)` + +GetScriptNameOk returns a tuple with the ScriptName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScriptName + +`func (o *V3ConnectorDto) SetScriptName(v string)` + +SetScriptName sets ScriptName field to given value. + +### HasScriptName + +`func (o *V3ConnectorDto) HasScriptName() bool` + +HasScriptName returns a boolean if a field has been set. + +### GetClassName + +`func (o *V3ConnectorDto) GetClassName() string` + +GetClassName returns the ClassName field if non-nil, zero value otherwise. + +### GetClassNameOk + +`func (o *V3ConnectorDto) GetClassNameOk() (*string, bool)` + +GetClassNameOk returns a tuple with the ClassName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClassName + +`func (o *V3ConnectorDto) SetClassName(v string)` + +SetClassName sets ClassName field to given value. + +### HasClassName + +`func (o *V3ConnectorDto) HasClassName() bool` + +HasClassName returns a boolean if a field has been set. + +### SetClassNameNil + +`func (o *V3ConnectorDto) SetClassNameNil(b bool)` + + SetClassNameNil sets the value for ClassName to be an explicit nil + +### UnsetClassName +`func (o *V3ConnectorDto) UnsetClassName()` + +UnsetClassName ensures that no value is present for ClassName, not even an explicit nil +### GetFeatures + +`func (o *V3ConnectorDto) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *V3ConnectorDto) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *V3ConnectorDto) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *V3ConnectorDto) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### SetFeaturesNil + +`func (o *V3ConnectorDto) SetFeaturesNil(b bool)` + + SetFeaturesNil sets the value for Features to be an explicit nil + +### UnsetFeatures +`func (o *V3ConnectorDto) UnsetFeatures()` + +UnsetFeatures ensures that no value is present for Features, not even an explicit nil +### GetDirectConnect + +`func (o *V3ConnectorDto) GetDirectConnect() bool` + +GetDirectConnect returns the DirectConnect field if non-nil, zero value otherwise. + +### GetDirectConnectOk + +`func (o *V3ConnectorDto) GetDirectConnectOk() (*bool, bool)` + +GetDirectConnectOk returns a tuple with the DirectConnect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectConnect + +`func (o *V3ConnectorDto) SetDirectConnect(v bool)` + +SetDirectConnect sets DirectConnect field to given value. + +### HasDirectConnect + +`func (o *V3ConnectorDto) HasDirectConnect() bool` + +HasDirectConnect returns a boolean if a field has been set. + +### GetConnectorMetadata + +`func (o *V3ConnectorDto) GetConnectorMetadata() map[string]interface{}` + +GetConnectorMetadata returns the ConnectorMetadata field if non-nil, zero value otherwise. + +### GetConnectorMetadataOk + +`func (o *V3ConnectorDto) GetConnectorMetadataOk() (*map[string]interface{}, bool)` + +GetConnectorMetadataOk returns a tuple with the ConnectorMetadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnectorMetadata + +`func (o *V3ConnectorDto) SetConnectorMetadata(v map[string]interface{})` + +SetConnectorMetadata sets ConnectorMetadata field to given value. + +### HasConnectorMetadata + +`func (o *V3ConnectorDto) HasConnectorMetadata() bool` + +HasConnectorMetadata returns a boolean if a field has been set. + +### GetStatus + +`func (o *V3ConnectorDto) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *V3ConnectorDto) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *V3ConnectorDto) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *V3ConnectorDto) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/V3CreateConnectorDto.md b/docs/tools/sdk/go/Reference/V3/Models/V3CreateConnectorDto.md new file mode 100644 index 000000000..1fce940c4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/V3CreateConnectorDto.md @@ -0,0 +1,158 @@ +--- +id: v3-create-connector-dto +title: V3CreateConnectorDto +pagination_label: V3CreateConnectorDto +sidebar_label: V3CreateConnectorDto +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'V3CreateConnectorDto', 'V3CreateConnectorDto'] +slug: /tools/sdk/go/v3/models/v3-create-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3CreateConnectorDto', 'V3CreateConnectorDto'] +--- + +# V3CreateConnectorDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints | +**Type** | Pointer to **string** | The connector type. If not specified will be defaulted to 'custom '+name | [optional] +**ClassName** | **string** | The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter | +**DirectConnect** | Pointer to **bool** | true if the source is a direct connect source | [optional] [default to true] +**Status** | Pointer to **string** | The connector status | [optional] + +## Methods + +### NewV3CreateConnectorDto + +`func NewV3CreateConnectorDto(name string, className string, ) *V3CreateConnectorDto` + +NewV3CreateConnectorDto instantiates a new V3CreateConnectorDto 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 + +### NewV3CreateConnectorDtoWithDefaults + +`func NewV3CreateConnectorDtoWithDefaults() *V3CreateConnectorDto` + +NewV3CreateConnectorDtoWithDefaults instantiates a new V3CreateConnectorDto 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 + +### GetName + +`func (o *V3CreateConnectorDto) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *V3CreateConnectorDto) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *V3CreateConnectorDto) SetName(v string)` + +SetName sets Name field to given value. + + +### GetType + +`func (o *V3CreateConnectorDto) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *V3CreateConnectorDto) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *V3CreateConnectorDto) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *V3CreateConnectorDto) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetClassName + +`func (o *V3CreateConnectorDto) GetClassName() string` + +GetClassName returns the ClassName field if non-nil, zero value otherwise. + +### GetClassNameOk + +`func (o *V3CreateConnectorDto) GetClassNameOk() (*string, bool)` + +GetClassNameOk returns a tuple with the ClassName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetClassName + +`func (o *V3CreateConnectorDto) SetClassName(v string)` + +SetClassName sets ClassName field to given value. + + +### GetDirectConnect + +`func (o *V3CreateConnectorDto) GetDirectConnect() bool` + +GetDirectConnect returns the DirectConnect field if non-nil, zero value otherwise. + +### GetDirectConnectOk + +`func (o *V3CreateConnectorDto) GetDirectConnectOk() (*bool, bool)` + +GetDirectConnectOk returns a tuple with the DirectConnect field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDirectConnect + +`func (o *V3CreateConnectorDto) SetDirectConnect(v bool)` + +SetDirectConnect sets DirectConnect field to given value. + +### HasDirectConnect + +`func (o *V3CreateConnectorDto) HasDirectConnect() bool` + +HasDirectConnect returns a boolean if a field has been set. + +### GetStatus + +`func (o *V3CreateConnectorDto) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *V3CreateConnectorDto) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *V3CreateConnectorDto) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *V3CreateConnectorDto) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Value.md b/docs/tools/sdk/go/Reference/V3/Models/Value.md new file mode 100644 index 000000000..aa595e041 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Value.md @@ -0,0 +1,90 @@ +--- +id: value +title: Value +pagination_label: Value +sidebar_label: Value +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Value', 'Value'] +slug: /tools/sdk/go/v3/models/value +tags: ['SDK', 'Software Development Kit', 'Value', 'Value'] +--- + +# Value + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of attribute value | [optional] +**Value** | Pointer to **string** | The attribute value | [optional] + +## Methods + +### NewValue + +`func NewValue() *Value` + +NewValue instantiates a new Value 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 + +### NewValueWithDefaults + +`func NewValueWithDefaults() *Value` + +NewValueWithDefaults instantiates a new Value 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 + +### GetType + +`func (o *Value) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Value) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Value) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Value) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetValue + +`func (o *Value) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Value) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Value) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Value) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/VendorConnectorMapping.md b/docs/tools/sdk/go/Reference/V3/Models/VendorConnectorMapping.md new file mode 100644 index 000000000..f90d13b41 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/VendorConnectorMapping.md @@ -0,0 +1,312 @@ +--- +id: vendor-connector-mapping +title: VendorConnectorMapping +pagination_label: VendorConnectorMapping +sidebar_label: VendorConnectorMapping +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMapping', 'VendorConnectorMapping'] +slug: /tools/sdk/go/v3/models/vendor-connector-mapping +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMapping', 'VendorConnectorMapping'] +--- + +# VendorConnectorMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique identifier for the vendor-connector mapping. | [optional] +**Vendor** | Pointer to **string** | The name of the vendor. | [optional] +**Connector** | Pointer to **string** | The name of the connector. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The creation timestamp of the mapping. | [optional] +**CreatedBy** | Pointer to **string** | The identifier of the user who created the mapping. | [optional] +**UpdatedAt** | Pointer to [**NullableVendorConnectorMappingUpdatedAt**](vendor-connector-mapping-updated-at) | | [optional] +**UpdatedBy** | Pointer to [**NullableVendorConnectorMappingUpdatedBy**](vendor-connector-mapping-updated-by) | | [optional] +**DeletedAt** | Pointer to [**NullableVendorConnectorMappingDeletedAt**](vendor-connector-mapping-deleted-at) | | [optional] +**DeletedBy** | Pointer to [**NullableVendorConnectorMappingDeletedBy**](vendor-connector-mapping-deleted-by) | | [optional] + +## Methods + +### NewVendorConnectorMapping + +`func NewVendorConnectorMapping() *VendorConnectorMapping` + +NewVendorConnectorMapping instantiates a new VendorConnectorMapping 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 + +### NewVendorConnectorMappingWithDefaults + +`func NewVendorConnectorMappingWithDefaults() *VendorConnectorMapping` + +NewVendorConnectorMappingWithDefaults instantiates a new VendorConnectorMapping 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 + +### GetId + +`func (o *VendorConnectorMapping) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *VendorConnectorMapping) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *VendorConnectorMapping) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *VendorConnectorMapping) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetVendor + +`func (o *VendorConnectorMapping) GetVendor() string` + +GetVendor returns the Vendor field if non-nil, zero value otherwise. + +### GetVendorOk + +`func (o *VendorConnectorMapping) GetVendorOk() (*string, bool)` + +GetVendorOk returns a tuple with the Vendor field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVendor + +`func (o *VendorConnectorMapping) SetVendor(v string)` + +SetVendor sets Vendor field to given value. + +### HasVendor + +`func (o *VendorConnectorMapping) HasVendor() bool` + +HasVendor returns a boolean if a field has been set. + +### GetConnector + +`func (o *VendorConnectorMapping) GetConnector() string` + +GetConnector returns the Connector field if non-nil, zero value otherwise. + +### GetConnectorOk + +`func (o *VendorConnectorMapping) GetConnectorOk() (*string, bool)` + +GetConnectorOk returns a tuple with the Connector field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConnector + +`func (o *VendorConnectorMapping) SetConnector(v string)` + +SetConnector sets Connector field to given value. + +### HasConnector + +`func (o *VendorConnectorMapping) HasConnector() bool` + +HasConnector returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *VendorConnectorMapping) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *VendorConnectorMapping) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *VendorConnectorMapping) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *VendorConnectorMapping) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetCreatedBy + +`func (o *VendorConnectorMapping) GetCreatedBy() string` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *VendorConnectorMapping) GetCreatedByOk() (*string, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedBy + +`func (o *VendorConnectorMapping) SetCreatedBy(v string)` + +SetCreatedBy sets CreatedBy field to given value. + +### HasCreatedBy + +`func (o *VendorConnectorMapping) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### GetUpdatedAt + +`func (o *VendorConnectorMapping) GetUpdatedAt() VendorConnectorMappingUpdatedAt` + +GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise. + +### GetUpdatedAtOk + +`func (o *VendorConnectorMapping) GetUpdatedAtOk() (*VendorConnectorMappingUpdatedAt, bool)` + +GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedAt + +`func (o *VendorConnectorMapping) SetUpdatedAt(v VendorConnectorMappingUpdatedAt)` + +SetUpdatedAt sets UpdatedAt field to given value. + +### HasUpdatedAt + +`func (o *VendorConnectorMapping) HasUpdatedAt() bool` + +HasUpdatedAt returns a boolean if a field has been set. + +### SetUpdatedAtNil + +`func (o *VendorConnectorMapping) SetUpdatedAtNil(b bool)` + + SetUpdatedAtNil sets the value for UpdatedAt to be an explicit nil + +### UnsetUpdatedAt +`func (o *VendorConnectorMapping) UnsetUpdatedAt()` + +UnsetUpdatedAt ensures that no value is present for UpdatedAt, not even an explicit nil +### GetUpdatedBy + +`func (o *VendorConnectorMapping) GetUpdatedBy() VendorConnectorMappingUpdatedBy` + +GetUpdatedBy returns the UpdatedBy field if non-nil, zero value otherwise. + +### GetUpdatedByOk + +`func (o *VendorConnectorMapping) GetUpdatedByOk() (*VendorConnectorMappingUpdatedBy, bool)` + +GetUpdatedByOk returns a tuple with the UpdatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedBy + +`func (o *VendorConnectorMapping) SetUpdatedBy(v VendorConnectorMappingUpdatedBy)` + +SetUpdatedBy sets UpdatedBy field to given value. + +### HasUpdatedBy + +`func (o *VendorConnectorMapping) HasUpdatedBy() bool` + +HasUpdatedBy returns a boolean if a field has been set. + +### SetUpdatedByNil + +`func (o *VendorConnectorMapping) SetUpdatedByNil(b bool)` + + SetUpdatedByNil sets the value for UpdatedBy to be an explicit nil + +### UnsetUpdatedBy +`func (o *VendorConnectorMapping) UnsetUpdatedBy()` + +UnsetUpdatedBy ensures that no value is present for UpdatedBy, not even an explicit nil +### GetDeletedAt + +`func (o *VendorConnectorMapping) GetDeletedAt() VendorConnectorMappingDeletedAt` + +GetDeletedAt returns the DeletedAt field if non-nil, zero value otherwise. + +### GetDeletedAtOk + +`func (o *VendorConnectorMapping) GetDeletedAtOk() (*VendorConnectorMappingDeletedAt, bool)` + +GetDeletedAtOk returns a tuple with the DeletedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeletedAt + +`func (o *VendorConnectorMapping) SetDeletedAt(v VendorConnectorMappingDeletedAt)` + +SetDeletedAt sets DeletedAt field to given value. + +### HasDeletedAt + +`func (o *VendorConnectorMapping) HasDeletedAt() bool` + +HasDeletedAt returns a boolean if a field has been set. + +### SetDeletedAtNil + +`func (o *VendorConnectorMapping) SetDeletedAtNil(b bool)` + + SetDeletedAtNil sets the value for DeletedAt to be an explicit nil + +### UnsetDeletedAt +`func (o *VendorConnectorMapping) UnsetDeletedAt()` + +UnsetDeletedAt ensures that no value is present for DeletedAt, not even an explicit nil +### GetDeletedBy + +`func (o *VendorConnectorMapping) GetDeletedBy() VendorConnectorMappingDeletedBy` + +GetDeletedBy returns the DeletedBy field if non-nil, zero value otherwise. + +### GetDeletedByOk + +`func (o *VendorConnectorMapping) GetDeletedByOk() (*VendorConnectorMappingDeletedBy, bool)` + +GetDeletedByOk returns a tuple with the DeletedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeletedBy + +`func (o *VendorConnectorMapping) SetDeletedBy(v VendorConnectorMappingDeletedBy)` + +SetDeletedBy sets DeletedBy field to given value. + +### HasDeletedBy + +`func (o *VendorConnectorMapping) HasDeletedBy() bool` + +HasDeletedBy returns a boolean if a field has been set. + +### SetDeletedByNil + +`func (o *VendorConnectorMapping) SetDeletedByNil(b bool)` + + SetDeletedByNil sets the value for DeletedBy to be an explicit nil + +### UnsetDeletedBy +`func (o *VendorConnectorMapping) UnsetDeletedBy()` + +UnsetDeletedBy ensures that no value is present for DeletedBy, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/VendorConnectorMappingDeletedAt.md b/docs/tools/sdk/go/Reference/V3/Models/VendorConnectorMappingDeletedAt.md new file mode 100644 index 000000000..9a4a84192 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/VendorConnectorMappingDeletedAt.md @@ -0,0 +1,90 @@ +--- +id: vendor-connector-mapping-deleted-at +title: VendorConnectorMappingDeletedAt +pagination_label: VendorConnectorMappingDeletedAt +sidebar_label: VendorConnectorMappingDeletedAt +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappingDeletedAt', 'VendorConnectorMappingDeletedAt'] +slug: /tools/sdk/go/v3/models/vendor-connector-mapping-deleted-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedAt', 'VendorConnectorMappingDeletedAt'] +--- + +# VendorConnectorMappingDeletedAt + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Time** | Pointer to **SailPointTime** | The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable. | [optional] +**Valid** | Pointer to **bool** | A flag indicating if the 'Time' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to false] + +## Methods + +### NewVendorConnectorMappingDeletedAt + +`func NewVendorConnectorMappingDeletedAt() *VendorConnectorMappingDeletedAt` + +NewVendorConnectorMappingDeletedAt instantiates a new VendorConnectorMappingDeletedAt 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 + +### NewVendorConnectorMappingDeletedAtWithDefaults + +`func NewVendorConnectorMappingDeletedAtWithDefaults() *VendorConnectorMappingDeletedAt` + +NewVendorConnectorMappingDeletedAtWithDefaults instantiates a new VendorConnectorMappingDeletedAt 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 + +### GetTime + +`func (o *VendorConnectorMappingDeletedAt) GetTime() SailPointTime` + +GetTime returns the Time field if non-nil, zero value otherwise. + +### GetTimeOk + +`func (o *VendorConnectorMappingDeletedAt) GetTimeOk() (*SailPointTime, bool)` + +GetTimeOk returns a tuple with the Time field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTime + +`func (o *VendorConnectorMappingDeletedAt) SetTime(v SailPointTime)` + +SetTime sets Time field to given value. + +### HasTime + +`func (o *VendorConnectorMappingDeletedAt) HasTime() bool` + +HasTime returns a boolean if a field has been set. + +### GetValid + +`func (o *VendorConnectorMappingDeletedAt) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *VendorConnectorMappingDeletedAt) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *VendorConnectorMappingDeletedAt) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *VendorConnectorMappingDeletedAt) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/VendorConnectorMappingDeletedBy.md b/docs/tools/sdk/go/Reference/V3/Models/VendorConnectorMappingDeletedBy.md new file mode 100644 index 000000000..c7c1085ba --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/VendorConnectorMappingDeletedBy.md @@ -0,0 +1,90 @@ +--- +id: vendor-connector-mapping-deleted-by +title: VendorConnectorMappingDeletedBy +pagination_label: VendorConnectorMappingDeletedBy +sidebar_label: VendorConnectorMappingDeletedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappingDeletedBy', 'VendorConnectorMappingDeletedBy'] +slug: /tools/sdk/go/v3/models/vendor-connector-mapping-deleted-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedBy', 'VendorConnectorMappingDeletedBy'] +--- + +# VendorConnectorMappingDeletedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**String** | Pointer to **string** | The identifier of the user who deleted the mapping, if applicable. | [optional] +**Valid** | Pointer to **bool** | A flag indicating if the 'String' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to false] + +## Methods + +### NewVendorConnectorMappingDeletedBy + +`func NewVendorConnectorMappingDeletedBy() *VendorConnectorMappingDeletedBy` + +NewVendorConnectorMappingDeletedBy instantiates a new VendorConnectorMappingDeletedBy 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 + +### NewVendorConnectorMappingDeletedByWithDefaults + +`func NewVendorConnectorMappingDeletedByWithDefaults() *VendorConnectorMappingDeletedBy` + +NewVendorConnectorMappingDeletedByWithDefaults instantiates a new VendorConnectorMappingDeletedBy 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 + +### GetString + +`func (o *VendorConnectorMappingDeletedBy) GetString() string` + +GetString returns the String field if non-nil, zero value otherwise. + +### GetStringOk + +`func (o *VendorConnectorMappingDeletedBy) GetStringOk() (*string, bool)` + +GetStringOk returns a tuple with the String field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetString + +`func (o *VendorConnectorMappingDeletedBy) SetString(v string)` + +SetString sets String field to given value. + +### HasString + +`func (o *VendorConnectorMappingDeletedBy) HasString() bool` + +HasString returns a boolean if a field has been set. + +### GetValid + +`func (o *VendorConnectorMappingDeletedBy) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *VendorConnectorMappingDeletedBy) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *VendorConnectorMappingDeletedBy) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *VendorConnectorMappingDeletedBy) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/VendorConnectorMappingUpdatedAt.md b/docs/tools/sdk/go/Reference/V3/Models/VendorConnectorMappingUpdatedAt.md new file mode 100644 index 000000000..8d2b55ac6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/VendorConnectorMappingUpdatedAt.md @@ -0,0 +1,90 @@ +--- +id: vendor-connector-mapping-updated-at +title: VendorConnectorMappingUpdatedAt +pagination_label: VendorConnectorMappingUpdatedAt +sidebar_label: VendorConnectorMappingUpdatedAt +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappingUpdatedAt', 'VendorConnectorMappingUpdatedAt'] +slug: /tools/sdk/go/v3/models/vendor-connector-mapping-updated-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedAt', 'VendorConnectorMappingUpdatedAt'] +--- + +# VendorConnectorMappingUpdatedAt + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Time** | Pointer to **SailPointTime** | The timestamp when the mapping was last updated, represented in ISO 8601 format. | [optional] +**Valid** | Pointer to **bool** | A flag indicating if the 'Time' field is set and valid. | [optional] [default to false] + +## Methods + +### NewVendorConnectorMappingUpdatedAt + +`func NewVendorConnectorMappingUpdatedAt() *VendorConnectorMappingUpdatedAt` + +NewVendorConnectorMappingUpdatedAt instantiates a new VendorConnectorMappingUpdatedAt 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 + +### NewVendorConnectorMappingUpdatedAtWithDefaults + +`func NewVendorConnectorMappingUpdatedAtWithDefaults() *VendorConnectorMappingUpdatedAt` + +NewVendorConnectorMappingUpdatedAtWithDefaults instantiates a new VendorConnectorMappingUpdatedAt 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 + +### GetTime + +`func (o *VendorConnectorMappingUpdatedAt) GetTime() SailPointTime` + +GetTime returns the Time field if non-nil, zero value otherwise. + +### GetTimeOk + +`func (o *VendorConnectorMappingUpdatedAt) GetTimeOk() (*SailPointTime, bool)` + +GetTimeOk returns a tuple with the Time field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTime + +`func (o *VendorConnectorMappingUpdatedAt) SetTime(v SailPointTime)` + +SetTime sets Time field to given value. + +### HasTime + +`func (o *VendorConnectorMappingUpdatedAt) HasTime() bool` + +HasTime returns a boolean if a field has been set. + +### GetValid + +`func (o *VendorConnectorMappingUpdatedAt) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *VendorConnectorMappingUpdatedAt) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *VendorConnectorMappingUpdatedAt) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *VendorConnectorMappingUpdatedAt) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/VendorConnectorMappingUpdatedBy.md b/docs/tools/sdk/go/Reference/V3/Models/VendorConnectorMappingUpdatedBy.md new file mode 100644 index 000000000..c06b4d1f3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/VendorConnectorMappingUpdatedBy.md @@ -0,0 +1,90 @@ +--- +id: vendor-connector-mapping-updated-by +title: VendorConnectorMappingUpdatedBy +pagination_label: VendorConnectorMappingUpdatedBy +sidebar_label: VendorConnectorMappingUpdatedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VendorConnectorMappingUpdatedBy', 'VendorConnectorMappingUpdatedBy'] +slug: /tools/sdk/go/v3/models/vendor-connector-mapping-updated-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedBy', 'VendorConnectorMappingUpdatedBy'] +--- + +# VendorConnectorMappingUpdatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**String** | Pointer to **string** | The identifier of the user who last updated the mapping, if available. | [optional] +**Valid** | Pointer to **bool** | A flag indicating if the 'String' field is set and valid. | [optional] [default to false] + +## Methods + +### NewVendorConnectorMappingUpdatedBy + +`func NewVendorConnectorMappingUpdatedBy() *VendorConnectorMappingUpdatedBy` + +NewVendorConnectorMappingUpdatedBy instantiates a new VendorConnectorMappingUpdatedBy 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 + +### NewVendorConnectorMappingUpdatedByWithDefaults + +`func NewVendorConnectorMappingUpdatedByWithDefaults() *VendorConnectorMappingUpdatedBy` + +NewVendorConnectorMappingUpdatedByWithDefaults instantiates a new VendorConnectorMappingUpdatedBy 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 + +### GetString + +`func (o *VendorConnectorMappingUpdatedBy) GetString() string` + +GetString returns the String field if non-nil, zero value otherwise. + +### GetStringOk + +`func (o *VendorConnectorMappingUpdatedBy) GetStringOk() (*string, bool)` + +GetStringOk returns a tuple with the String field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetString + +`func (o *VendorConnectorMappingUpdatedBy) SetString(v string)` + +SetString sets String field to given value. + +### HasString + +`func (o *VendorConnectorMappingUpdatedBy) HasString() bool` + +HasString returns a boolean if a field has been set. + +### GetValid + +`func (o *VendorConnectorMappingUpdatedBy) GetValid() bool` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *VendorConnectorMappingUpdatedBy) GetValidOk() (*bool, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValid + +`func (o *VendorConnectorMappingUpdatedBy) SetValid(v bool)` + +SetValid sets Valid field to given value. + +### HasValid + +`func (o *VendorConnectorMappingUpdatedBy) HasValid() bool` + +HasValid returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/VerificationPollRequest.md b/docs/tools/sdk/go/Reference/V3/Models/VerificationPollRequest.md new file mode 100644 index 000000000..b16c2c639 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/VerificationPollRequest.md @@ -0,0 +1,59 @@ +--- +id: verification-poll-request +title: VerificationPollRequest +pagination_label: VerificationPollRequest +sidebar_label: VerificationPollRequest +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VerificationPollRequest', 'VerificationPollRequest'] +slug: /tools/sdk/go/v3/models/verification-poll-request +tags: ['SDK', 'Software Development Kit', 'VerificationPollRequest', 'VerificationPollRequest'] +--- + +# VerificationPollRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | **string** | Verification request Id | + +## Methods + +### NewVerificationPollRequest + +`func NewVerificationPollRequest(requestId string, ) *VerificationPollRequest` + +NewVerificationPollRequest instantiates a new VerificationPollRequest 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 + +### NewVerificationPollRequestWithDefaults + +`func NewVerificationPollRequestWithDefaults() *VerificationPollRequest` + +NewVerificationPollRequestWithDefaults instantiates a new VerificationPollRequest 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 + +### GetRequestId + +`func (o *VerificationPollRequest) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *VerificationPollRequest) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *VerificationPollRequest) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/VerificationResponse.md b/docs/tools/sdk/go/Reference/V3/Models/VerificationResponse.md new file mode 100644 index 000000000..2dc560045 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/VerificationResponse.md @@ -0,0 +1,136 @@ +--- +id: verification-response +title: VerificationResponse +pagination_label: VerificationResponse +sidebar_label: VerificationResponse +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VerificationResponse', 'VerificationResponse'] +slug: /tools/sdk/go/v3/models/verification-response +tags: ['SDK', 'Software Development Kit', 'VerificationResponse', 'VerificationResponse'] +--- + +# VerificationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **NullableString** | The verificationPollRequest request ID | [optional] +**Status** | Pointer to **string** | MFA Authentication status | [optional] +**Error** | Pointer to **NullableString** | Error messages from MFA verification request | [optional] + +## Methods + +### NewVerificationResponse + +`func NewVerificationResponse() *VerificationResponse` + +NewVerificationResponse instantiates a new VerificationResponse 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 + +### NewVerificationResponseWithDefaults + +`func NewVerificationResponseWithDefaults() *VerificationResponse` + +NewVerificationResponseWithDefaults instantiates a new VerificationResponse 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 + +### GetRequestId + +`func (o *VerificationResponse) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *VerificationResponse) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *VerificationResponse) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *VerificationResponse) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### SetRequestIdNil + +`func (o *VerificationResponse) SetRequestIdNil(b bool)` + + SetRequestIdNil sets the value for RequestId to be an explicit nil + +### UnsetRequestId +`func (o *VerificationResponse) UnsetRequestId()` + +UnsetRequestId ensures that no value is present for RequestId, not even an explicit nil +### GetStatus + +`func (o *VerificationResponse) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *VerificationResponse) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *VerificationResponse) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *VerificationResponse) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetError + +`func (o *VerificationResponse) GetError() string` + +GetError returns the Error field if non-nil, zero value otherwise. + +### GetErrorOk + +`func (o *VerificationResponse) GetErrorOk() (*string, bool)` + +GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetError + +`func (o *VerificationResponse) SetError(v string)` + +SetError sets Error field to given value. + +### HasError + +`func (o *VerificationResponse) HasError() bool` + +HasError returns a boolean if a field has been set. + +### SetErrorNil + +`func (o *VerificationResponse) SetErrorNil(b bool)` + + SetErrorNil sets the value for Error to be an explicit nil + +### UnsetError +`func (o *VerificationResponse) UnsetError()` + +UnsetError ensures that no value is present for Error, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ViolationContext.md b/docs/tools/sdk/go/Reference/V3/Models/ViolationContext.md new file mode 100644 index 000000000..2aee5d558 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ViolationContext.md @@ -0,0 +1,90 @@ +--- +id: violation-context +title: ViolationContext +pagination_label: ViolationContext +sidebar_label: ViolationContext +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationContext', 'ViolationContext'] +slug: /tools/sdk/go/v3/models/violation-context +tags: ['SDK', 'Software Development Kit', 'ViolationContext', 'ViolationContext'] +--- + +# ViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**ViolationContextPolicy**](violation-context-policy) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**ExceptionAccessCriteria**](exception-access-criteria) | | [optional] + +## Methods + +### NewViolationContext + +`func NewViolationContext() *ViolationContext` + +NewViolationContext instantiates a new ViolationContext 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 + +### NewViolationContextWithDefaults + +`func NewViolationContextWithDefaults() *ViolationContext` + +NewViolationContextWithDefaults instantiates a new ViolationContext 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 + +### GetPolicy + +`func (o *ViolationContext) GetPolicy() ViolationContextPolicy` + +GetPolicy returns the Policy field if non-nil, zero value otherwise. + +### GetPolicyOk + +`func (o *ViolationContext) GetPolicyOk() (*ViolationContextPolicy, bool)` + +GetPolicyOk returns a tuple with the Policy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPolicy + +`func (o *ViolationContext) SetPolicy(v ViolationContextPolicy)` + +SetPolicy sets Policy field to given value. + +### HasPolicy + +`func (o *ViolationContext) HasPolicy() bool` + +HasPolicy returns a boolean if a field has been set. + +### GetConflictingAccessCriteria + +`func (o *ViolationContext) GetConflictingAccessCriteria() ExceptionAccessCriteria` + +GetConflictingAccessCriteria returns the ConflictingAccessCriteria field if non-nil, zero value otherwise. + +### GetConflictingAccessCriteriaOk + +`func (o *ViolationContext) GetConflictingAccessCriteriaOk() (*ExceptionAccessCriteria, bool)` + +GetConflictingAccessCriteriaOk returns a tuple with the ConflictingAccessCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConflictingAccessCriteria + +`func (o *ViolationContext) SetConflictingAccessCriteria(v ExceptionAccessCriteria)` + +SetConflictingAccessCriteria sets ConflictingAccessCriteria field to given value. + +### HasConflictingAccessCriteria + +`func (o *ViolationContext) HasConflictingAccessCriteria() bool` + +HasConflictingAccessCriteria returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ViolationContextPolicy.md b/docs/tools/sdk/go/Reference/V3/Models/ViolationContextPolicy.md new file mode 100644 index 000000000..3dd683f04 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ViolationContextPolicy.md @@ -0,0 +1,116 @@ +--- +id: violation-context-policy +title: ViolationContextPolicy +pagination_label: ViolationContextPolicy +sidebar_label: ViolationContextPolicy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationContextPolicy', 'ViolationContextPolicy'] +slug: /tools/sdk/go/v3/models/violation-context-policy +tags: ['SDK', 'Software Development Kit', 'ViolationContextPolicy', 'ViolationContextPolicy'] +--- + +# ViolationContextPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **map[string]interface{}** | The type of object that is referenced | [optional] +**Id** | Pointer to **string** | SOD policy ID. | [optional] +**Name** | Pointer to **string** | | [optional] + +## Methods + +### NewViolationContextPolicy + +`func NewViolationContextPolicy() *ViolationContextPolicy` + +NewViolationContextPolicy instantiates a new ViolationContextPolicy 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 + +### NewViolationContextPolicyWithDefaults + +`func NewViolationContextPolicyWithDefaults() *ViolationContextPolicy` + +NewViolationContextPolicyWithDefaults instantiates a new ViolationContextPolicy 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 + +### GetType + +`func (o *ViolationContextPolicy) GetType() map[string]interface{}` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ViolationContextPolicy) GetTypeOk() (*map[string]interface{}, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ViolationContextPolicy) SetType(v map[string]interface{})` + +SetType sets Type field to given value. + +### HasType + +`func (o *ViolationContextPolicy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *ViolationContextPolicy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ViolationContextPolicy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ViolationContextPolicy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ViolationContextPolicy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ViolationContextPolicy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ViolationContextPolicy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ViolationContextPolicy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ViolationContextPolicy) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ViolationOwnerAssignmentConfig.md b/docs/tools/sdk/go/Reference/V3/Models/ViolationOwnerAssignmentConfig.md new file mode 100644 index 000000000..a1038b79d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ViolationOwnerAssignmentConfig.md @@ -0,0 +1,110 @@ +--- +id: violation-owner-assignment-config +title: ViolationOwnerAssignmentConfig +pagination_label: ViolationOwnerAssignmentConfig +sidebar_label: ViolationOwnerAssignmentConfig +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationOwnerAssignmentConfig', 'ViolationOwnerAssignmentConfig'] +slug: /tools/sdk/go/v3/models/violation-owner-assignment-config +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfig', 'ViolationOwnerAssignmentConfig'] +--- + +# ViolationOwnerAssignmentConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssignmentRule** | Pointer to **NullableString** | Details about the violations owner. MANAGER - identity's manager STATIC - Governance Group or Identity | [optional] +**OwnerRef** | Pointer to [**NullableViolationOwnerAssignmentConfigOwnerRef**](violation-owner-assignment-config-owner-ref) | | [optional] + +## Methods + +### NewViolationOwnerAssignmentConfig + +`func NewViolationOwnerAssignmentConfig() *ViolationOwnerAssignmentConfig` + +NewViolationOwnerAssignmentConfig instantiates a new ViolationOwnerAssignmentConfig 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 + +### NewViolationOwnerAssignmentConfigWithDefaults + +`func NewViolationOwnerAssignmentConfigWithDefaults() *ViolationOwnerAssignmentConfig` + +NewViolationOwnerAssignmentConfigWithDefaults instantiates a new ViolationOwnerAssignmentConfig 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 + +### GetAssignmentRule + +`func (o *ViolationOwnerAssignmentConfig) GetAssignmentRule() string` + +GetAssignmentRule returns the AssignmentRule field if non-nil, zero value otherwise. + +### GetAssignmentRuleOk + +`func (o *ViolationOwnerAssignmentConfig) GetAssignmentRuleOk() (*string, bool)` + +GetAssignmentRuleOk returns a tuple with the AssignmentRule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignmentRule + +`func (o *ViolationOwnerAssignmentConfig) SetAssignmentRule(v string)` + +SetAssignmentRule sets AssignmentRule field to given value. + +### HasAssignmentRule + +`func (o *ViolationOwnerAssignmentConfig) HasAssignmentRule() bool` + +HasAssignmentRule returns a boolean if a field has been set. + +### SetAssignmentRuleNil + +`func (o *ViolationOwnerAssignmentConfig) SetAssignmentRuleNil(b bool)` + + SetAssignmentRuleNil sets the value for AssignmentRule to be an explicit nil + +### UnsetAssignmentRule +`func (o *ViolationOwnerAssignmentConfig) UnsetAssignmentRule()` + +UnsetAssignmentRule ensures that no value is present for AssignmentRule, not even an explicit nil +### GetOwnerRef + +`func (o *ViolationOwnerAssignmentConfig) GetOwnerRef() ViolationOwnerAssignmentConfigOwnerRef` + +GetOwnerRef returns the OwnerRef field if non-nil, zero value otherwise. + +### GetOwnerRefOk + +`func (o *ViolationOwnerAssignmentConfig) GetOwnerRefOk() (*ViolationOwnerAssignmentConfigOwnerRef, bool)` + +GetOwnerRefOk returns a tuple with the OwnerRef field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerRef + +`func (o *ViolationOwnerAssignmentConfig) SetOwnerRef(v ViolationOwnerAssignmentConfigOwnerRef)` + +SetOwnerRef sets OwnerRef field to given value. + +### HasOwnerRef + +`func (o *ViolationOwnerAssignmentConfig) HasOwnerRef() bool` + +HasOwnerRef returns a boolean if a field has been set. + +### SetOwnerRefNil + +`func (o *ViolationOwnerAssignmentConfig) SetOwnerRefNil(b bool)` + + SetOwnerRefNil sets the value for OwnerRef to be an explicit nil + +### UnsetOwnerRef +`func (o *ViolationOwnerAssignmentConfig) UnsetOwnerRef()` + +UnsetOwnerRef ensures that no value is present for OwnerRef, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ViolationOwnerAssignmentConfigOwnerRef.md b/docs/tools/sdk/go/Reference/V3/Models/ViolationOwnerAssignmentConfigOwnerRef.md new file mode 100644 index 000000000..c4e7a88c1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ViolationOwnerAssignmentConfigOwnerRef.md @@ -0,0 +1,126 @@ +--- +id: violation-owner-assignment-config-owner-ref +title: ViolationOwnerAssignmentConfigOwnerRef +pagination_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationOwnerAssignmentConfigOwnerRef', 'ViolationOwnerAssignmentConfigOwnerRef'] +slug: /tools/sdk/go/v3/models/violation-owner-assignment-config-owner-ref +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfigOwnerRef', 'ViolationOwnerAssignmentConfigOwnerRef'] +--- + +# ViolationOwnerAssignmentConfigOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **NullableString** | Owner type. | [optional] +**Id** | Pointer to **string** | Owner's ID. | [optional] +**Name** | Pointer to **string** | Owner's name. | [optional] + +## Methods + +### NewViolationOwnerAssignmentConfigOwnerRef + +`func NewViolationOwnerAssignmentConfigOwnerRef() *ViolationOwnerAssignmentConfigOwnerRef` + +NewViolationOwnerAssignmentConfigOwnerRef instantiates a new ViolationOwnerAssignmentConfigOwnerRef 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 + +### NewViolationOwnerAssignmentConfigOwnerRefWithDefaults + +`func NewViolationOwnerAssignmentConfigOwnerRefWithDefaults() *ViolationOwnerAssignmentConfigOwnerRef` + +NewViolationOwnerAssignmentConfigOwnerRefWithDefaults instantiates a new ViolationOwnerAssignmentConfigOwnerRef 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 + +### GetType + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *ViolationOwnerAssignmentConfigOwnerRef) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil +### GetId + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ViolationOwnerAssignmentConfigOwnerRef) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/ViolationPrediction.md b/docs/tools/sdk/go/Reference/V3/Models/ViolationPrediction.md new file mode 100644 index 000000000..a1f5dfc22 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/ViolationPrediction.md @@ -0,0 +1,64 @@ +--- +id: violation-prediction +title: ViolationPrediction +pagination_label: ViolationPrediction +sidebar_label: ViolationPrediction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'ViolationPrediction', 'ViolationPrediction'] +slug: /tools/sdk/go/v3/models/violation-prediction +tags: ['SDK', 'Software Development Kit', 'ViolationPrediction', 'ViolationPrediction'] +--- + +# ViolationPrediction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ViolationContexts** | Pointer to [**[]ViolationContext**](violation-context) | List of Violation Contexts | [optional] + +## Methods + +### NewViolationPrediction + +`func NewViolationPrediction() *ViolationPrediction` + +NewViolationPrediction instantiates a new ViolationPrediction 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 + +### NewViolationPredictionWithDefaults + +`func NewViolationPredictionWithDefaults() *ViolationPrediction` + +NewViolationPredictionWithDefaults instantiates a new ViolationPrediction 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 + +### GetViolationContexts + +`func (o *ViolationPrediction) GetViolationContexts() []ViolationContext` + +GetViolationContexts returns the ViolationContexts field if non-nil, zero value otherwise. + +### GetViolationContextsOk + +`func (o *ViolationPrediction) GetViolationContextsOk() (*[]ViolationContext, bool)` + +GetViolationContextsOk returns a tuple with the ViolationContexts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetViolationContexts + +`func (o *ViolationPrediction) SetViolationContexts(v []ViolationContext)` + +SetViolationContexts sets ViolationContexts field to given value. + +### HasViolationContexts + +`func (o *ViolationPrediction) HasViolationContexts() bool` + +HasViolationContexts returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/VisibilityCriteria.md b/docs/tools/sdk/go/Reference/V3/Models/VisibilityCriteria.md new file mode 100644 index 000000000..eaacf3db6 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/VisibilityCriteria.md @@ -0,0 +1,64 @@ +--- +id: visibility-criteria +title: VisibilityCriteria +pagination_label: VisibilityCriteria +sidebar_label: VisibilityCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'VisibilityCriteria', 'VisibilityCriteria'] +slug: /tools/sdk/go/v3/models/visibility-criteria +tags: ['SDK', 'Software Development Kit', 'VisibilityCriteria', 'VisibilityCriteria'] +--- + +# VisibilityCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | Pointer to [**Expression**](expression) | | [optional] + +## Methods + +### NewVisibilityCriteria + +`func NewVisibilityCriteria() *VisibilityCriteria` + +NewVisibilityCriteria instantiates a new VisibilityCriteria 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 + +### NewVisibilityCriteriaWithDefaults + +`func NewVisibilityCriteriaWithDefaults() *VisibilityCriteria` + +NewVisibilityCriteriaWithDefaults instantiates a new VisibilityCriteria 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 + +### GetExpression + +`func (o *VisibilityCriteria) GetExpression() Expression` + +GetExpression returns the Expression field if non-nil, zero value otherwise. + +### GetExpressionOk + +`func (o *VisibilityCriteria) GetExpressionOk() (*Expression, bool)` + +GetExpressionOk returns a tuple with the Expression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExpression + +`func (o *VisibilityCriteria) SetExpression(v Expression)` + +SetExpression sets Expression field to given value. + +### HasExpression + +`func (o *VisibilityCriteria) HasExpression() bool` + +HasExpression returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkItemForward.md b/docs/tools/sdk/go/Reference/V3/Models/WorkItemForward.md new file mode 100644 index 000000000..b7f115150 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkItemForward.md @@ -0,0 +1,106 @@ +--- +id: work-item-forward +title: WorkItemForward +pagination_label: WorkItemForward +sidebar_label: WorkItemForward +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemForward', 'WorkItemForward'] +slug: /tools/sdk/go/v3/models/work-item-forward +tags: ['SDK', 'Software Development Kit', 'WorkItemForward', 'WorkItemForward'] +--- + +# WorkItemForward + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TargetOwnerId** | **string** | The ID of the identity to forward this work item to. | +**Comment** | **string** | Comments to send to the target owner | +**SendNotifications** | Pointer to **bool** | If true, send a notification to the target owner. | [optional] [default to true] + +## Methods + +### NewWorkItemForward + +`func NewWorkItemForward(targetOwnerId string, comment string, ) *WorkItemForward` + +NewWorkItemForward instantiates a new WorkItemForward 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 + +### NewWorkItemForwardWithDefaults + +`func NewWorkItemForwardWithDefaults() *WorkItemForward` + +NewWorkItemForwardWithDefaults instantiates a new WorkItemForward 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 + +### GetTargetOwnerId + +`func (o *WorkItemForward) GetTargetOwnerId() string` + +GetTargetOwnerId returns the TargetOwnerId field if non-nil, zero value otherwise. + +### GetTargetOwnerIdOk + +`func (o *WorkItemForward) GetTargetOwnerIdOk() (*string, bool)` + +GetTargetOwnerIdOk returns a tuple with the TargetOwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetOwnerId + +`func (o *WorkItemForward) SetTargetOwnerId(v string)` + +SetTargetOwnerId sets TargetOwnerId field to given value. + + +### GetComment + +`func (o *WorkItemForward) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *WorkItemForward) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *WorkItemForward) SetComment(v string)` + +SetComment sets Comment field to given value. + + +### GetSendNotifications + +`func (o *WorkItemForward) GetSendNotifications() bool` + +GetSendNotifications returns the SendNotifications field if non-nil, zero value otherwise. + +### GetSendNotificationsOk + +`func (o *WorkItemForward) GetSendNotificationsOk() (*bool, bool)` + +GetSendNotificationsOk returns a tuple with the SendNotifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSendNotifications + +`func (o *WorkItemForward) SetSendNotifications(v bool)` + +SetSendNotifications sets SendNotifications field to given value. + +### HasSendNotifications + +`func (o *WorkItemForward) HasSendNotifications() bool` + +HasSendNotifications returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkItemState.md b/docs/tools/sdk/go/Reference/V3/Models/WorkItemState.md new file mode 100644 index 000000000..7c436b221 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkItemState.md @@ -0,0 +1,29 @@ +--- +id: work-item-state +title: WorkItemState +pagination_label: WorkItemState +sidebar_label: WorkItemState +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemState', 'WorkItemState'] +slug: /tools/sdk/go/v3/models/work-item-state +tags: ['SDK', 'Software Development Kit', 'WorkItemState', 'WorkItemState'] +--- + +# WorkItemState + +## Enum + + +* `FINISHED` (value: `"Finished"`) + +* `REJECTED` (value: `"Rejected"`) + +* `RETURNED` (value: `"Returned"`) + +* `EXPIRED` (value: `"Expired"`) + +* `PENDING` (value: `"Pending"`) + +* `CANCELED` (value: `"Canceled"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkItemStateManualWorkItems.md b/docs/tools/sdk/go/Reference/V3/Models/WorkItemStateManualWorkItems.md new file mode 100644 index 000000000..fc9035fe1 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkItemStateManualWorkItems.md @@ -0,0 +1,29 @@ +--- +id: work-item-state-manual-work-items +title: WorkItemStateManualWorkItems +pagination_label: WorkItemStateManualWorkItems +sidebar_label: WorkItemStateManualWorkItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemStateManualWorkItems', 'WorkItemStateManualWorkItems'] +slug: /tools/sdk/go/v3/models/work-item-state-manual-work-items +tags: ['SDK', 'Software Development Kit', 'WorkItemStateManualWorkItems', 'WorkItemStateManualWorkItems'] +--- + +# WorkItemStateManualWorkItems + +## Enum + + +* `FINISHED` (value: `"Finished"`) + +* `REJECTED` (value: `"Rejected"`) + +* `RETURNED` (value: `"Returned"`) + +* `EXPIRED` (value: `"Expired"`) + +* `PENDING` (value: `"Pending"`) + +* `CANCELED` (value: `"Canceled"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkItemTypeManualWorkItems.md b/docs/tools/sdk/go/Reference/V3/Models/WorkItemTypeManualWorkItems.md new file mode 100644 index 000000000..74fcba8eb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkItemTypeManualWorkItems.md @@ -0,0 +1,45 @@ +--- +id: work-item-type-manual-work-items +title: WorkItemTypeManualWorkItems +pagination_label: WorkItemTypeManualWorkItems +sidebar_label: WorkItemTypeManualWorkItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemTypeManualWorkItems', 'WorkItemTypeManualWorkItems'] +slug: /tools/sdk/go/v3/models/work-item-type-manual-work-items +tags: ['SDK', 'Software Development Kit', 'WorkItemTypeManualWorkItems', 'WorkItemTypeManualWorkItems'] +--- + +# WorkItemTypeManualWorkItems + +## Enum + + +* `GENERIC` (value: `"Generic"`) + +* `CERTIFICATION` (value: `"Certification"`) + +* `REMEDIATION` (value: `"Remediation"`) + +* `DELEGATION` (value: `"Delegation"`) + +* `APPROVAL` (value: `"Approval"`) + +* `VIOLATION_REVIEW` (value: `"ViolationReview"`) + +* `FORM` (value: `"Form"`) + +* `POLICY_VIOLOATION` (value: `"PolicyVioloation"`) + +* `CHALLENGE` (value: `"Challenge"`) + +* `IMPACT_ANALYSIS` (value: `"ImpactAnalysis"`) + +* `SIGNOFF` (value: `"Signoff"`) + +* `EVENT` (value: `"Event"`) + +* `MANUAL_ACTION` (value: `"ManualAction"`) + +* `TEST` (value: `"Test"`) + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkItems.md b/docs/tools/sdk/go/Reference/V3/Models/WorkItems.md new file mode 100644 index 000000000..0c4647194 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkItems.md @@ -0,0 +1,570 @@ +--- +id: work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItems', 'WorkItems'] +slug: /tools/sdk/go/v3/models/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'WorkItems'] +--- + +# WorkItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the work item | [optional] +**RequesterId** | Pointer to **NullableString** | ID of the requester | [optional] +**RequesterDisplayName** | Pointer to **NullableString** | The displayname of the requester | [optional] +**OwnerId** | Pointer to **NullableString** | The ID of the owner | [optional] +**OwnerName** | Pointer to **string** | The name of the owner | [optional] +**Created** | Pointer to **SailPointTime** | Time when the work item was created | [optional] +**Modified** | Pointer to **NullableTime** | Time when the work item was last updated | [optional] +**Description** | Pointer to **string** | The description of the work item | [optional] +**State** | Pointer to [**WorkItemStateManualWorkItems**](work-item-state-manual-work-items) | | [optional] +**Type** | Pointer to [**WorkItemTypeManualWorkItems**](work-item-type-manual-work-items) | | [optional] +**RemediationItems** | Pointer to [**[]RemediationItemDetails**](remediation-item-details) | A list of remediation items | [optional] +**ApprovalItems** | Pointer to [**[]ApprovalItemDetails**](approval-item-details) | A list of items that need to be approved | [optional] +**Name** | Pointer to **NullableString** | The work item name | [optional] +**Completed** | Pointer to **NullableTime** | The time at which the work item completed | [optional] +**NumItems** | Pointer to **NullableInt32** | The number of items in the work item | [optional] +**Form** | Pointer to [**WorkItemsForm**](work-items-form) | | [optional] +**Errors** | Pointer to **[]string** | An array of errors that ocurred during the work item | [optional] + +## Methods + +### NewWorkItems + +`func NewWorkItems() *WorkItems` + +NewWorkItems instantiates a new WorkItems 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 + +### NewWorkItemsWithDefaults + +`func NewWorkItemsWithDefaults() *WorkItems` + +NewWorkItemsWithDefaults instantiates a new WorkItems 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 + +### GetId + +`func (o *WorkItems) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkItems) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkItems) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkItems) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetRequesterId + +`func (o *WorkItems) GetRequesterId() string` + +GetRequesterId returns the RequesterId field if non-nil, zero value otherwise. + +### GetRequesterIdOk + +`func (o *WorkItems) GetRequesterIdOk() (*string, bool)` + +GetRequesterIdOk returns a tuple with the RequesterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterId + +`func (o *WorkItems) SetRequesterId(v string)` + +SetRequesterId sets RequesterId field to given value. + +### HasRequesterId + +`func (o *WorkItems) HasRequesterId() bool` + +HasRequesterId returns a boolean if a field has been set. + +### SetRequesterIdNil + +`func (o *WorkItems) SetRequesterIdNil(b bool)` + + SetRequesterIdNil sets the value for RequesterId to be an explicit nil + +### UnsetRequesterId +`func (o *WorkItems) UnsetRequesterId()` + +UnsetRequesterId ensures that no value is present for RequesterId, not even an explicit nil +### GetRequesterDisplayName + +`func (o *WorkItems) GetRequesterDisplayName() string` + +GetRequesterDisplayName returns the RequesterDisplayName field if non-nil, zero value otherwise. + +### GetRequesterDisplayNameOk + +`func (o *WorkItems) GetRequesterDisplayNameOk() (*string, bool)` + +GetRequesterDisplayNameOk returns a tuple with the RequesterDisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequesterDisplayName + +`func (o *WorkItems) SetRequesterDisplayName(v string)` + +SetRequesterDisplayName sets RequesterDisplayName field to given value. + +### HasRequesterDisplayName + +`func (o *WorkItems) HasRequesterDisplayName() bool` + +HasRequesterDisplayName returns a boolean if a field has been set. + +### SetRequesterDisplayNameNil + +`func (o *WorkItems) SetRequesterDisplayNameNil(b bool)` + + SetRequesterDisplayNameNil sets the value for RequesterDisplayName to be an explicit nil + +### UnsetRequesterDisplayName +`func (o *WorkItems) UnsetRequesterDisplayName()` + +UnsetRequesterDisplayName ensures that no value is present for RequesterDisplayName, not even an explicit nil +### GetOwnerId + +`func (o *WorkItems) GetOwnerId() string` + +GetOwnerId returns the OwnerId field if non-nil, zero value otherwise. + +### GetOwnerIdOk + +`func (o *WorkItems) GetOwnerIdOk() (*string, bool)` + +GetOwnerIdOk returns a tuple with the OwnerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerId + +`func (o *WorkItems) SetOwnerId(v string)` + +SetOwnerId sets OwnerId field to given value. + +### HasOwnerId + +`func (o *WorkItems) HasOwnerId() bool` + +HasOwnerId returns a boolean if a field has been set. + +### SetOwnerIdNil + +`func (o *WorkItems) SetOwnerIdNil(b bool)` + + SetOwnerIdNil sets the value for OwnerId to be an explicit nil + +### UnsetOwnerId +`func (o *WorkItems) UnsetOwnerId()` + +UnsetOwnerId ensures that no value is present for OwnerId, not even an explicit nil +### GetOwnerName + +`func (o *WorkItems) GetOwnerName() string` + +GetOwnerName returns the OwnerName field if non-nil, zero value otherwise. + +### GetOwnerNameOk + +`func (o *WorkItems) GetOwnerNameOk() (*string, bool)` + +GetOwnerNameOk returns a tuple with the OwnerName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwnerName + +`func (o *WorkItems) SetOwnerName(v string)` + +SetOwnerName sets OwnerName field to given value. + +### HasOwnerName + +`func (o *WorkItems) HasOwnerName() bool` + +HasOwnerName returns a boolean if a field has been set. + +### GetCreated + +`func (o *WorkItems) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *WorkItems) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *WorkItems) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *WorkItems) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *WorkItems) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *WorkItems) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *WorkItems) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *WorkItems) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModifiedNil + +`func (o *WorkItems) SetModifiedNil(b bool)` + + SetModifiedNil sets the value for Modified to be an explicit nil + +### UnsetModified +`func (o *WorkItems) UnsetModified()` + +UnsetModified ensures that no value is present for Modified, not even an explicit nil +### GetDescription + +`func (o *WorkItems) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkItems) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkItems) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkItems) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetState + +`func (o *WorkItems) GetState() WorkItemStateManualWorkItems` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *WorkItems) GetStateOk() (*WorkItemStateManualWorkItems, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *WorkItems) SetState(v WorkItemStateManualWorkItems)` + +SetState sets State field to given value. + +### HasState + +`func (o *WorkItems) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetType + +`func (o *WorkItems) GetType() WorkItemTypeManualWorkItems` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkItems) GetTypeOk() (*WorkItemTypeManualWorkItems, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkItems) SetType(v WorkItemTypeManualWorkItems)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkItems) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRemediationItems + +`func (o *WorkItems) GetRemediationItems() []RemediationItemDetails` + +GetRemediationItems returns the RemediationItems field if non-nil, zero value otherwise. + +### GetRemediationItemsOk + +`func (o *WorkItems) GetRemediationItemsOk() (*[]RemediationItemDetails, bool)` + +GetRemediationItemsOk returns a tuple with the RemediationItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRemediationItems + +`func (o *WorkItems) SetRemediationItems(v []RemediationItemDetails)` + +SetRemediationItems sets RemediationItems field to given value. + +### HasRemediationItems + +`func (o *WorkItems) HasRemediationItems() bool` + +HasRemediationItems returns a boolean if a field has been set. + +### SetRemediationItemsNil + +`func (o *WorkItems) SetRemediationItemsNil(b bool)` + + SetRemediationItemsNil sets the value for RemediationItems to be an explicit nil + +### UnsetRemediationItems +`func (o *WorkItems) UnsetRemediationItems()` + +UnsetRemediationItems ensures that no value is present for RemediationItems, not even an explicit nil +### GetApprovalItems + +`func (o *WorkItems) GetApprovalItems() []ApprovalItemDetails` + +GetApprovalItems returns the ApprovalItems field if non-nil, zero value otherwise. + +### GetApprovalItemsOk + +`func (o *WorkItems) GetApprovalItemsOk() (*[]ApprovalItemDetails, bool)` + +GetApprovalItemsOk returns a tuple with the ApprovalItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetApprovalItems + +`func (o *WorkItems) SetApprovalItems(v []ApprovalItemDetails)` + +SetApprovalItems sets ApprovalItems field to given value. + +### HasApprovalItems + +`func (o *WorkItems) HasApprovalItems() bool` + +HasApprovalItems returns a boolean if a field has been set. + +### SetApprovalItemsNil + +`func (o *WorkItems) SetApprovalItemsNil(b bool)` + + SetApprovalItemsNil sets the value for ApprovalItems to be an explicit nil + +### UnsetApprovalItems +`func (o *WorkItems) UnsetApprovalItems()` + +UnsetApprovalItems ensures that no value is present for ApprovalItems, not even an explicit nil +### GetName + +`func (o *WorkItems) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkItems) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkItems) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkItems) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *WorkItems) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *WorkItems) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCompleted + +`func (o *WorkItems) GetCompleted() SailPointTime` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *WorkItems) GetCompletedOk() (*SailPointTime, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *WorkItems) SetCompleted(v SailPointTime)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *WorkItems) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### SetCompletedNil + +`func (o *WorkItems) SetCompletedNil(b bool)` + + SetCompletedNil sets the value for Completed to be an explicit nil + +### UnsetCompleted +`func (o *WorkItems) UnsetCompleted()` + +UnsetCompleted ensures that no value is present for Completed, not even an explicit nil +### GetNumItems + +`func (o *WorkItems) GetNumItems() int32` + +GetNumItems returns the NumItems field if non-nil, zero value otherwise. + +### GetNumItemsOk + +`func (o *WorkItems) GetNumItemsOk() (*int32, bool)` + +GetNumItemsOk returns a tuple with the NumItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumItems + +`func (o *WorkItems) SetNumItems(v int32)` + +SetNumItems sets NumItems field to given value. + +### HasNumItems + +`func (o *WorkItems) HasNumItems() bool` + +HasNumItems returns a boolean if a field has been set. + +### SetNumItemsNil + +`func (o *WorkItems) SetNumItemsNil(b bool)` + + SetNumItemsNil sets the value for NumItems to be an explicit nil + +### UnsetNumItems +`func (o *WorkItems) UnsetNumItems()` + +UnsetNumItems ensures that no value is present for NumItems, not even an explicit nil +### GetForm + +`func (o *WorkItems) GetForm() WorkItemsForm` + +GetForm returns the Form field if non-nil, zero value otherwise. + +### GetFormOk + +`func (o *WorkItems) GetFormOk() (*WorkItemsForm, bool)` + +GetFormOk returns a tuple with the Form field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetForm + +`func (o *WorkItems) SetForm(v WorkItemsForm)` + +SetForm sets Form field to given value. + +### HasForm + +`func (o *WorkItems) HasForm() bool` + +HasForm returns a boolean if a field has been set. + +### GetErrors + +`func (o *WorkItems) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *WorkItems) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *WorkItems) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *WorkItems) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkItemsCount.md b/docs/tools/sdk/go/Reference/V3/Models/WorkItemsCount.md new file mode 100644 index 000000000..d58106aea --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkItemsCount.md @@ -0,0 +1,64 @@ +--- +id: work-items-count +title: WorkItemsCount +pagination_label: WorkItemsCount +sidebar_label: WorkItemsCount +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemsCount', 'WorkItemsCount'] +slug: /tools/sdk/go/v3/models/work-items-count +tags: ['SDK', 'Software Development Kit', 'WorkItemsCount', 'WorkItemsCount'] +--- + +# WorkItemsCount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **int32** | The count of work items | [optional] + +## Methods + +### NewWorkItemsCount + +`func NewWorkItemsCount() *WorkItemsCount` + +NewWorkItemsCount instantiates a new WorkItemsCount 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 + +### NewWorkItemsCountWithDefaults + +`func NewWorkItemsCountWithDefaults() *WorkItemsCount` + +NewWorkItemsCountWithDefaults instantiates a new WorkItemsCount 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 + +### GetCount + +`func (o *WorkItemsCount) GetCount() int32` + +GetCount returns the Count field if non-nil, zero value otherwise. + +### GetCountOk + +`func (o *WorkItemsCount) GetCountOk() (*int32, bool)` + +GetCountOk returns a tuple with the Count field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCount + +`func (o *WorkItemsCount) SetCount(v int32)` + +SetCount sets Count field to given value. + +### HasCount + +`func (o *WorkItemsCount) HasCount() bool` + +HasCount returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkItemsForm.md b/docs/tools/sdk/go/Reference/V3/Models/WorkItemsForm.md new file mode 100644 index 000000000..b56738edb --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkItemsForm.md @@ -0,0 +1,214 @@ +--- +id: work-items-form +title: WorkItemsForm +pagination_label: WorkItemsForm +sidebar_label: WorkItemsForm +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemsForm', 'WorkItemsForm'] +slug: /tools/sdk/go/v3/models/work-items-form +tags: ['SDK', 'Software Development Kit', 'WorkItemsForm', 'WorkItemsForm'] +--- + +# WorkItemsForm + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **NullableString** | ID of the form | [optional] +**Name** | Pointer to **NullableString** | Name of the form | [optional] +**Title** | Pointer to **string** | The form title | [optional] +**Subtitle** | Pointer to **string** | The form subtitle. | [optional] +**TargetUser** | Pointer to **string** | The name of the user that should be shown this form | [optional] +**Sections** | Pointer to [**[]SectionDetails**](section-details) | Sections of the form | [optional] + +## Methods + +### NewWorkItemsForm + +`func NewWorkItemsForm() *WorkItemsForm` + +NewWorkItemsForm instantiates a new WorkItemsForm 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 + +### NewWorkItemsFormWithDefaults + +`func NewWorkItemsFormWithDefaults() *WorkItemsForm` + +NewWorkItemsFormWithDefaults instantiates a new WorkItemsForm 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 + +### GetId + +`func (o *WorkItemsForm) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkItemsForm) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkItemsForm) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkItemsForm) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *WorkItemsForm) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *WorkItemsForm) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil +### GetName + +`func (o *WorkItemsForm) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkItemsForm) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkItemsForm) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkItemsForm) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *WorkItemsForm) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *WorkItemsForm) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetTitle + +`func (o *WorkItemsForm) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *WorkItemsForm) GetTitleOk() (*string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTitle + +`func (o *WorkItemsForm) SetTitle(v string)` + +SetTitle sets Title field to given value. + +### HasTitle + +`func (o *WorkItemsForm) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### GetSubtitle + +`func (o *WorkItemsForm) GetSubtitle() string` + +GetSubtitle returns the Subtitle field if non-nil, zero value otherwise. + +### GetSubtitleOk + +`func (o *WorkItemsForm) GetSubtitleOk() (*string, bool)` + +GetSubtitleOk returns a tuple with the Subtitle field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubtitle + +`func (o *WorkItemsForm) SetSubtitle(v string)` + +SetSubtitle sets Subtitle field to given value. + +### HasSubtitle + +`func (o *WorkItemsForm) HasSubtitle() bool` + +HasSubtitle returns a boolean if a field has been set. + +### GetTargetUser + +`func (o *WorkItemsForm) GetTargetUser() string` + +GetTargetUser returns the TargetUser field if non-nil, zero value otherwise. + +### GetTargetUserOk + +`func (o *WorkItemsForm) GetTargetUserOk() (*string, bool)` + +GetTargetUserOk returns a tuple with the TargetUser field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTargetUser + +`func (o *WorkItemsForm) SetTargetUser(v string)` + +SetTargetUser sets TargetUser field to given value. + +### HasTargetUser + +`func (o *WorkItemsForm) HasTargetUser() bool` + +HasTargetUser returns a boolean if a field has been set. + +### GetSections + +`func (o *WorkItemsForm) GetSections() []SectionDetails` + +GetSections returns the Sections field if non-nil, zero value otherwise. + +### GetSectionsOk + +`func (o *WorkItemsForm) GetSectionsOk() (*[]SectionDetails, bool)` + +GetSectionsOk returns a tuple with the Sections field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSections + +`func (o *WorkItemsForm) SetSections(v []SectionDetails)` + +SetSections sets Sections field to given value. + +### HasSections + +`func (o *WorkItemsForm) HasSections() bool` + +HasSections returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkItemsSummary.md b/docs/tools/sdk/go/Reference/V3/Models/WorkItemsSummary.md new file mode 100644 index 000000000..6c0171171 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkItemsSummary.md @@ -0,0 +1,116 @@ +--- +id: work-items-summary +title: WorkItemsSummary +pagination_label: WorkItemsSummary +sidebar_label: WorkItemsSummary +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkItemsSummary', 'WorkItemsSummary'] +slug: /tools/sdk/go/v3/models/work-items-summary +tags: ['SDK', 'Software Development Kit', 'WorkItemsSummary', 'WorkItemsSummary'] +--- + +# WorkItemsSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Open** | Pointer to **int32** | The count of open work items | [optional] +**Completed** | Pointer to **int32** | The count of completed work items | [optional] +**Total** | Pointer to **int32** | The count of total work items | [optional] + +## Methods + +### NewWorkItemsSummary + +`func NewWorkItemsSummary() *WorkItemsSummary` + +NewWorkItemsSummary instantiates a new WorkItemsSummary 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 + +### NewWorkItemsSummaryWithDefaults + +`func NewWorkItemsSummaryWithDefaults() *WorkItemsSummary` + +NewWorkItemsSummaryWithDefaults instantiates a new WorkItemsSummary 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 + +### GetOpen + +`func (o *WorkItemsSummary) GetOpen() int32` + +GetOpen returns the Open field if non-nil, zero value otherwise. + +### GetOpenOk + +`func (o *WorkItemsSummary) GetOpenOk() (*int32, bool)` + +GetOpenOk returns a tuple with the Open field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOpen + +`func (o *WorkItemsSummary) SetOpen(v int32)` + +SetOpen sets Open field to given value. + +### HasOpen + +`func (o *WorkItemsSummary) HasOpen() bool` + +HasOpen returns a boolean if a field has been set. + +### GetCompleted + +`func (o *WorkItemsSummary) GetCompleted() int32` + +GetCompleted returns the Completed field if non-nil, zero value otherwise. + +### GetCompletedOk + +`func (o *WorkItemsSummary) GetCompletedOk() (*int32, bool)` + +GetCompletedOk returns a tuple with the Completed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompleted + +`func (o *WorkItemsSummary) SetCompleted(v int32)` + +SetCompleted sets Completed field to given value. + +### HasCompleted + +`func (o *WorkItemsSummary) HasCompleted() bool` + +HasCompleted returns a boolean if a field has been set. + +### GetTotal + +`func (o *WorkItemsSummary) GetTotal() int32` + +GetTotal returns the Total field if non-nil, zero value otherwise. + +### GetTotalOk + +`func (o *WorkItemsSummary) GetTotalOk() (*int32, bool)` + +GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotal + +`func (o *WorkItemsSummary) SetTotal(v int32)` + +SetTotal sets Total field to given value. + +### HasTotal + +`func (o *WorkItemsSummary) HasTotal() bool` + +HasTotal returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/Workflow.md b/docs/tools/sdk/go/Reference/V3/Models/Workflow.md new file mode 100644 index 000000000..68cc8833d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/Workflow.md @@ -0,0 +1,376 @@ +--- +id: workflow +title: Workflow +pagination_label: Workflow +sidebar_label: Workflow +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'Workflow', 'Workflow'] +slug: /tools/sdk/go/v3/models/workflow +tags: ['SDK', 'Software Development Kit', 'Workflow', 'Workflow'] +--- + +# Workflow + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the workflow | [optional] +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **string** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **bool** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] +**Id** | Pointer to **string** | Workflow ID. This is a UUID generated upon creation. | [optional] +**ExecutionCount** | Pointer to **int32** | The number of times this workflow has been executed. | [optional] +**FailureCount** | Pointer to **int32** | The number of times this workflow has failed during execution. | [optional] +**Created** | Pointer to **SailPointTime** | The date and time the workflow was created. | [optional] +**Modified** | Pointer to **SailPointTime** | The date and time the workflow was modified. | [optional] +**ModifiedBy** | Pointer to [**WorkflowModifiedBy**](workflow-modified-by) | | [optional] +**Creator** | Pointer to [**WorkflowAllOfCreator**](workflow-all-of-creator) | | [optional] + +## Methods + +### NewWorkflow + +`func NewWorkflow() *Workflow` + +NewWorkflow instantiates a new Workflow 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 + +### NewWorkflowWithDefaults + +`func NewWorkflowWithDefaults() *Workflow` + +NewWorkflowWithDefaults instantiates a new Workflow 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 + +### GetName + +`func (o *Workflow) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Workflow) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Workflow) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Workflow) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOwner + +`func (o *Workflow) GetOwner() WorkflowBodyOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *Workflow) GetOwnerOk() (*WorkflowBodyOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *Workflow) SetOwner(v WorkflowBodyOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *Workflow) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDescription + +`func (o *Workflow) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Workflow) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Workflow) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Workflow) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDefinition + +`func (o *Workflow) GetDefinition() WorkflowDefinition` + +GetDefinition returns the Definition field if non-nil, zero value otherwise. + +### GetDefinitionOk + +`func (o *Workflow) GetDefinitionOk() (*WorkflowDefinition, bool)` + +GetDefinitionOk returns a tuple with the Definition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefinition + +`func (o *Workflow) SetDefinition(v WorkflowDefinition)` + +SetDefinition sets Definition field to given value. + +### HasDefinition + +`func (o *Workflow) HasDefinition() bool` + +HasDefinition returns a boolean if a field has been set. + +### GetEnabled + +`func (o *Workflow) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *Workflow) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *Workflow) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *Workflow) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetTrigger + +`func (o *Workflow) GetTrigger() WorkflowTrigger` + +GetTrigger returns the Trigger field if non-nil, zero value otherwise. + +### GetTriggerOk + +`func (o *Workflow) GetTriggerOk() (*WorkflowTrigger, bool)` + +GetTriggerOk returns a tuple with the Trigger field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrigger + +`func (o *Workflow) SetTrigger(v WorkflowTrigger)` + +SetTrigger sets Trigger field to given value. + +### HasTrigger + +`func (o *Workflow) HasTrigger() bool` + +HasTrigger returns a boolean if a field has been set. + +### GetId + +`func (o *Workflow) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Workflow) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Workflow) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Workflow) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetExecutionCount + +`func (o *Workflow) GetExecutionCount() int32` + +GetExecutionCount returns the ExecutionCount field if non-nil, zero value otherwise. + +### GetExecutionCountOk + +`func (o *Workflow) GetExecutionCountOk() (*int32, bool)` + +GetExecutionCountOk returns a tuple with the ExecutionCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExecutionCount + +`func (o *Workflow) SetExecutionCount(v int32)` + +SetExecutionCount sets ExecutionCount field to given value. + +### HasExecutionCount + +`func (o *Workflow) HasExecutionCount() bool` + +HasExecutionCount returns a boolean if a field has been set. + +### GetFailureCount + +`func (o *Workflow) GetFailureCount() int32` + +GetFailureCount returns the FailureCount field if non-nil, zero value otherwise. + +### GetFailureCountOk + +`func (o *Workflow) GetFailureCountOk() (*int32, bool)` + +GetFailureCountOk returns a tuple with the FailureCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFailureCount + +`func (o *Workflow) SetFailureCount(v int32)` + +SetFailureCount sets FailureCount field to given value. + +### HasFailureCount + +`func (o *Workflow) HasFailureCount() bool` + +HasFailureCount returns a boolean if a field has been set. + +### GetCreated + +`func (o *Workflow) GetCreated() SailPointTime` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Workflow) GetCreatedOk() (*SailPointTime, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *Workflow) SetCreated(v SailPointTime)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *Workflow) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetModified + +`func (o *Workflow) GetModified() SailPointTime` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Workflow) GetModifiedOk() (*SailPointTime, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModified + +`func (o *Workflow) SetModified(v SailPointTime)` + +SetModified sets Modified field to given value. + +### HasModified + +`func (o *Workflow) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### GetModifiedBy + +`func (o *Workflow) GetModifiedBy() WorkflowModifiedBy` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *Workflow) GetModifiedByOk() (*WorkflowModifiedBy, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModifiedBy + +`func (o *Workflow) SetModifiedBy(v WorkflowModifiedBy)` + +SetModifiedBy sets ModifiedBy field to given value. + +### HasModifiedBy + +`func (o *Workflow) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### GetCreator + +`func (o *Workflow) GetCreator() WorkflowAllOfCreator` + +GetCreator returns the Creator field if non-nil, zero value otherwise. + +### GetCreatorOk + +`func (o *Workflow) GetCreatorOk() (*WorkflowAllOfCreator, bool)` + +GetCreatorOk returns a tuple with the Creator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreator + +`func (o *Workflow) SetCreator(v WorkflowAllOfCreator)` + +SetCreator sets Creator field to given value. + +### HasCreator + +`func (o *Workflow) HasCreator() bool` + +HasCreator returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkflowAllOfCreator.md b/docs/tools/sdk/go/Reference/V3/Models/WorkflowAllOfCreator.md new file mode 100644 index 000000000..567dedc52 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkflowAllOfCreator.md @@ -0,0 +1,116 @@ +--- +id: workflow-all-of-creator +title: WorkflowAllOfCreator +pagination_label: WorkflowAllOfCreator +sidebar_label: WorkflowAllOfCreator +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowAllOfCreator', 'WorkflowAllOfCreator'] +slug: /tools/sdk/go/v3/models/workflow-all-of-creator +tags: ['SDK', 'Software Development Kit', 'WorkflowAllOfCreator', 'WorkflowAllOfCreator'] +--- + +# WorkflowAllOfCreator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Workflow creator's DTO type. | [optional] +**Id** | Pointer to **string** | Workflow creator's identity ID. | [optional] +**Name** | Pointer to **string** | Workflow creator's display name. | [optional] + +## Methods + +### NewWorkflowAllOfCreator + +`func NewWorkflowAllOfCreator() *WorkflowAllOfCreator` + +NewWorkflowAllOfCreator instantiates a new WorkflowAllOfCreator 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 + +### NewWorkflowAllOfCreatorWithDefaults + +`func NewWorkflowAllOfCreatorWithDefaults() *WorkflowAllOfCreator` + +NewWorkflowAllOfCreatorWithDefaults instantiates a new WorkflowAllOfCreator 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 + +### GetType + +`func (o *WorkflowAllOfCreator) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowAllOfCreator) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowAllOfCreator) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowAllOfCreator) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkflowAllOfCreator) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowAllOfCreator) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowAllOfCreator) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowAllOfCreator) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowAllOfCreator) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowAllOfCreator) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowAllOfCreator) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowAllOfCreator) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkflowBody.md b/docs/tools/sdk/go/Reference/V3/Models/WorkflowBody.md new file mode 100644 index 000000000..dc8e650fe --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkflowBody.md @@ -0,0 +1,194 @@ +--- +id: workflow-body +title: WorkflowBody +pagination_label: WorkflowBody +sidebar_label: WorkflowBody +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowBody', 'WorkflowBody'] +slug: /tools/sdk/go/v3/models/workflow-body +tags: ['SDK', 'Software Development Kit', 'WorkflowBody', 'WorkflowBody'] +--- + +# WorkflowBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the workflow | [optional] +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **string** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **bool** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] + +## Methods + +### NewWorkflowBody + +`func NewWorkflowBody() *WorkflowBody` + +NewWorkflowBody instantiates a new WorkflowBody 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 + +### NewWorkflowBodyWithDefaults + +`func NewWorkflowBodyWithDefaults() *WorkflowBody` + +NewWorkflowBodyWithDefaults instantiates a new WorkflowBody 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 + +### GetName + +`func (o *WorkflowBody) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowBody) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowBody) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowBody) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetOwner + +`func (o *WorkflowBody) GetOwner() WorkflowBodyOwner` + +GetOwner returns the Owner field if non-nil, zero value otherwise. + +### GetOwnerOk + +`func (o *WorkflowBody) GetOwnerOk() (*WorkflowBodyOwner, bool)` + +GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOwner + +`func (o *WorkflowBody) SetOwner(v WorkflowBodyOwner)` + +SetOwner sets Owner field to given value. + +### HasOwner + +`func (o *WorkflowBody) HasOwner() bool` + +HasOwner returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkflowBody) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowBody) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowBody) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowBody) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetDefinition + +`func (o *WorkflowBody) GetDefinition() WorkflowDefinition` + +GetDefinition returns the Definition field if non-nil, zero value otherwise. + +### GetDefinitionOk + +`func (o *WorkflowBody) GetDefinitionOk() (*WorkflowDefinition, bool)` + +GetDefinitionOk returns a tuple with the Definition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefinition + +`func (o *WorkflowBody) SetDefinition(v WorkflowDefinition)` + +SetDefinition sets Definition field to given value. + +### HasDefinition + +`func (o *WorkflowBody) HasDefinition() bool` + +HasDefinition returns a boolean if a field has been set. + +### GetEnabled + +`func (o *WorkflowBody) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *WorkflowBody) GetEnabledOk() (*bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnabled + +`func (o *WorkflowBody) SetEnabled(v bool)` + +SetEnabled sets Enabled field to given value. + +### HasEnabled + +`func (o *WorkflowBody) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### GetTrigger + +`func (o *WorkflowBody) GetTrigger() WorkflowTrigger` + +GetTrigger returns the Trigger field if non-nil, zero value otherwise. + +### GetTriggerOk + +`func (o *WorkflowBody) GetTriggerOk() (*WorkflowTrigger, bool)` + +GetTriggerOk returns a tuple with the Trigger field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTrigger + +`func (o *WorkflowBody) SetTrigger(v WorkflowTrigger)` + +SetTrigger sets Trigger field to given value. + +### HasTrigger + +`func (o *WorkflowBody) HasTrigger() bool` + +HasTrigger returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkflowBodyOwner.md b/docs/tools/sdk/go/Reference/V3/Models/WorkflowBodyOwner.md new file mode 100644 index 000000000..2a539a285 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkflowBodyOwner.md @@ -0,0 +1,116 @@ +--- +id: workflow-body-owner +title: WorkflowBodyOwner +pagination_label: WorkflowBodyOwner +sidebar_label: WorkflowBodyOwner +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowBodyOwner', 'WorkflowBodyOwner'] +slug: /tools/sdk/go/v3/models/workflow-body-owner +tags: ['SDK', 'Software Development Kit', 'WorkflowBodyOwner', 'WorkflowBodyOwner'] +--- + +# WorkflowBodyOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of object that is referenced | [optional] +**Id** | Pointer to **string** | The unique ID of the object | [optional] +**Name** | Pointer to **string** | The name of the object | [optional] + +## Methods + +### NewWorkflowBodyOwner + +`func NewWorkflowBodyOwner() *WorkflowBodyOwner` + +NewWorkflowBodyOwner instantiates a new WorkflowBodyOwner 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 + +### NewWorkflowBodyOwnerWithDefaults + +`func NewWorkflowBodyOwnerWithDefaults() *WorkflowBodyOwner` + +NewWorkflowBodyOwnerWithDefaults instantiates a new WorkflowBodyOwner 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 + +### GetType + +`func (o *WorkflowBodyOwner) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowBodyOwner) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowBodyOwner) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowBodyOwner) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkflowBodyOwner) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowBodyOwner) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowBodyOwner) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowBodyOwner) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowBodyOwner) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowBodyOwner) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowBodyOwner) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowBodyOwner) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkflowDefinition.md b/docs/tools/sdk/go/Reference/V3/Models/WorkflowDefinition.md new file mode 100644 index 000000000..8f2d78379 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkflowDefinition.md @@ -0,0 +1,90 @@ +--- +id: workflow-definition +title: WorkflowDefinition +pagination_label: WorkflowDefinition +sidebar_label: WorkflowDefinition +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowDefinition', 'WorkflowDefinition'] +slug: /tools/sdk/go/v3/models/workflow-definition +tags: ['SDK', 'Software Development Kit', 'WorkflowDefinition', 'WorkflowDefinition'] +--- + +# WorkflowDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **string** | The name of the starting step. | [optional] +**Steps** | Pointer to **map[string]interface{}** | One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. | [optional] + +## Methods + +### NewWorkflowDefinition + +`func NewWorkflowDefinition() *WorkflowDefinition` + +NewWorkflowDefinition instantiates a new WorkflowDefinition 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 + +### NewWorkflowDefinitionWithDefaults + +`func NewWorkflowDefinitionWithDefaults() *WorkflowDefinition` + +NewWorkflowDefinitionWithDefaults instantiates a new WorkflowDefinition 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 + +### GetStart + +`func (o *WorkflowDefinition) GetStart() string` + +GetStart returns the Start field if non-nil, zero value otherwise. + +### GetStartOk + +`func (o *WorkflowDefinition) GetStartOk() (*string, bool)` + +GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStart + +`func (o *WorkflowDefinition) SetStart(v string)` + +SetStart sets Start field to given value. + +### HasStart + +`func (o *WorkflowDefinition) HasStart() bool` + +HasStart returns a boolean if a field has been set. + +### GetSteps + +`func (o *WorkflowDefinition) GetSteps() map[string]interface{}` + +GetSteps returns the Steps field if non-nil, zero value otherwise. + +### GetStepsOk + +`func (o *WorkflowDefinition) GetStepsOk() (*map[string]interface{}, bool)` + +GetStepsOk returns a tuple with the Steps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSteps + +`func (o *WorkflowDefinition) SetSteps(v map[string]interface{})` + +SetSteps sets Steps field to given value. + +### HasSteps + +`func (o *WorkflowDefinition) HasSteps() bool` + +HasSteps returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkflowExecution.md b/docs/tools/sdk/go/Reference/V3/Models/WorkflowExecution.md new file mode 100644 index 000000000..38f6ceb6e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkflowExecution.md @@ -0,0 +1,194 @@ +--- +id: workflow-execution +title: WorkflowExecution +pagination_label: WorkflowExecution +sidebar_label: WorkflowExecution +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowExecution', 'WorkflowExecution'] +slug: /tools/sdk/go/v3/models/workflow-execution +tags: ['SDK', 'Software Development Kit', 'WorkflowExecution', 'WorkflowExecution'] +--- + +# WorkflowExecution + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Workflow execution ID. | [optional] +**WorkflowId** | Pointer to **string** | Workflow ID. | [optional] +**RequestId** | Pointer to **string** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] +**StartTime** | Pointer to **SailPointTime** | Date/time when the workflow started. | [optional] +**CloseTime** | Pointer to **SailPointTime** | Date/time when the workflow ended. | [optional] +**Status** | Pointer to **string** | Workflow execution status. | [optional] + +## Methods + +### NewWorkflowExecution + +`func NewWorkflowExecution() *WorkflowExecution` + +NewWorkflowExecution instantiates a new WorkflowExecution 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 + +### NewWorkflowExecutionWithDefaults + +`func NewWorkflowExecutionWithDefaults() *WorkflowExecution` + +NewWorkflowExecutionWithDefaults instantiates a new WorkflowExecution 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 + +### GetId + +`func (o *WorkflowExecution) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowExecution) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowExecution) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowExecution) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetWorkflowId + +`func (o *WorkflowExecution) GetWorkflowId() string` + +GetWorkflowId returns the WorkflowId field if non-nil, zero value otherwise. + +### GetWorkflowIdOk + +`func (o *WorkflowExecution) GetWorkflowIdOk() (*string, bool)` + +GetWorkflowIdOk returns a tuple with the WorkflowId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWorkflowId + +`func (o *WorkflowExecution) SetWorkflowId(v string)` + +SetWorkflowId sets WorkflowId field to given value. + +### HasWorkflowId + +`func (o *WorkflowExecution) HasWorkflowId() bool` + +HasWorkflowId returns a boolean if a field has been set. + +### GetRequestId + +`func (o *WorkflowExecution) GetRequestId() string` + +GetRequestId returns the RequestId field if non-nil, zero value otherwise. + +### GetRequestIdOk + +`func (o *WorkflowExecution) GetRequestIdOk() (*string, bool)` + +GetRequestIdOk returns a tuple with the RequestId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestId + +`func (o *WorkflowExecution) SetRequestId(v string)` + +SetRequestId sets RequestId field to given value. + +### HasRequestId + +`func (o *WorkflowExecution) HasRequestId() bool` + +HasRequestId returns a boolean if a field has been set. + +### GetStartTime + +`func (o *WorkflowExecution) GetStartTime() SailPointTime` + +GetStartTime returns the StartTime field if non-nil, zero value otherwise. + +### GetStartTimeOk + +`func (o *WorkflowExecution) GetStartTimeOk() (*SailPointTime, bool)` + +GetStartTimeOk returns a tuple with the StartTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartTime + +`func (o *WorkflowExecution) SetStartTime(v SailPointTime)` + +SetStartTime sets StartTime field to given value. + +### HasStartTime + +`func (o *WorkflowExecution) HasStartTime() bool` + +HasStartTime returns a boolean if a field has been set. + +### GetCloseTime + +`func (o *WorkflowExecution) GetCloseTime() SailPointTime` + +GetCloseTime returns the CloseTime field if non-nil, zero value otherwise. + +### GetCloseTimeOk + +`func (o *WorkflowExecution) GetCloseTimeOk() (*SailPointTime, bool)` + +GetCloseTimeOk returns a tuple with the CloseTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCloseTime + +`func (o *WorkflowExecution) SetCloseTime(v SailPointTime)` + +SetCloseTime sets CloseTime field to given value. + +### HasCloseTime + +`func (o *WorkflowExecution) HasCloseTime() bool` + +HasCloseTime returns a boolean if a field has been set. + +### GetStatus + +`func (o *WorkflowExecution) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *WorkflowExecution) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *WorkflowExecution) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *WorkflowExecution) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkflowExecutionEvent.md b/docs/tools/sdk/go/Reference/V3/Models/WorkflowExecutionEvent.md new file mode 100644 index 000000000..781e38891 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkflowExecutionEvent.md @@ -0,0 +1,116 @@ +--- +id: workflow-execution-event +title: WorkflowExecutionEvent +pagination_label: WorkflowExecutionEvent +sidebar_label: WorkflowExecutionEvent +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowExecutionEvent', 'WorkflowExecutionEvent'] +slug: /tools/sdk/go/v3/models/workflow-execution-event +tags: ['SDK', 'Software Development Kit', 'WorkflowExecutionEvent', 'WorkflowExecutionEvent'] +--- + +# WorkflowExecutionEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of event | [optional] +**Timestamp** | Pointer to **SailPointTime** | The date-time when the event occurred | [optional] +**Attributes** | Pointer to **map[string]interface{}** | Additional attributes associated with the event | [optional] + +## Methods + +### NewWorkflowExecutionEvent + +`func NewWorkflowExecutionEvent() *WorkflowExecutionEvent` + +NewWorkflowExecutionEvent instantiates a new WorkflowExecutionEvent 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 + +### NewWorkflowExecutionEventWithDefaults + +`func NewWorkflowExecutionEventWithDefaults() *WorkflowExecutionEvent` + +NewWorkflowExecutionEventWithDefaults instantiates a new WorkflowExecutionEvent 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 + +### GetType + +`func (o *WorkflowExecutionEvent) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowExecutionEvent) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowExecutionEvent) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowExecutionEvent) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetTimestamp + +`func (o *WorkflowExecutionEvent) GetTimestamp() SailPointTime` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *WorkflowExecutionEvent) GetTimestampOk() (*SailPointTime, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *WorkflowExecutionEvent) SetTimestamp(v SailPointTime)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *WorkflowExecutionEvent) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + +### GetAttributes + +`func (o *WorkflowExecutionEvent) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *WorkflowExecutionEvent) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *WorkflowExecutionEvent) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + +### HasAttributes + +`func (o *WorkflowExecutionEvent) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkflowLibraryAction.md b/docs/tools/sdk/go/Reference/V3/Models/WorkflowLibraryAction.md new file mode 100644 index 000000000..4e4a5de35 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkflowLibraryAction.md @@ -0,0 +1,360 @@ +--- +id: workflow-library-action +title: WorkflowLibraryAction +pagination_label: WorkflowLibraryAction +sidebar_label: WorkflowLibraryAction +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryAction', 'WorkflowLibraryAction'] +slug: /tools/sdk/go/v3/models/workflow-library-action +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryAction', 'WorkflowLibraryAction'] +--- + +# WorkflowLibraryAction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Action ID. This is a static namespaced ID for the action | [optional] +**Name** | Pointer to **string** | Action Name | [optional] +**Type** | Pointer to **string** | Action type | [optional] +**Description** | Pointer to **string** | Action Description | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the action accepts | [optional] +**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**Deprecated** | Pointer to **bool** | | [optional] +**DeprecatedBy** | Pointer to **SailPointTime** | | [optional] +**VersionNumber** | Pointer to **int32** | Version number | [optional] +**IsSimulationEnabled** | Pointer to **bool** | | [optional] +**IsDynamicSchema** | Pointer to **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] [default to false] +**OutputSchema** | Pointer to **map[string]interface{}** | Defines the output schema, if any, that this action produces. | [optional] + +## Methods + +### NewWorkflowLibraryAction + +`func NewWorkflowLibraryAction() *WorkflowLibraryAction` + +NewWorkflowLibraryAction instantiates a new WorkflowLibraryAction 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 + +### NewWorkflowLibraryActionWithDefaults + +`func NewWorkflowLibraryActionWithDefaults() *WorkflowLibraryAction` + +NewWorkflowLibraryActionWithDefaults instantiates a new WorkflowLibraryAction 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 + +### GetId + +`func (o *WorkflowLibraryAction) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowLibraryAction) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowLibraryAction) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowLibraryAction) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowLibraryAction) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowLibraryAction) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowLibraryAction) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowLibraryAction) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *WorkflowLibraryAction) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowLibraryAction) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowLibraryAction) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowLibraryAction) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkflowLibraryAction) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowLibraryAction) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowLibraryAction) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowLibraryAction) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetFormFields + +`func (o *WorkflowLibraryAction) GetFormFields() []WorkflowLibraryFormFields` + +GetFormFields returns the FormFields field if non-nil, zero value otherwise. + +### GetFormFieldsOk + +`func (o *WorkflowLibraryAction) GetFormFieldsOk() (*[]WorkflowLibraryFormFields, bool)` + +GetFormFieldsOk returns a tuple with the FormFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormFields + +`func (o *WorkflowLibraryAction) SetFormFields(v []WorkflowLibraryFormFields)` + +SetFormFields sets FormFields field to given value. + +### HasFormFields + +`func (o *WorkflowLibraryAction) HasFormFields() bool` + +HasFormFields returns a boolean if a field has been set. + +### SetFormFieldsNil + +`func (o *WorkflowLibraryAction) SetFormFieldsNil(b bool)` + + SetFormFieldsNil sets the value for FormFields to be an explicit nil + +### UnsetFormFields +`func (o *WorkflowLibraryAction) UnsetFormFields()` + +UnsetFormFields ensures that no value is present for FormFields, not even an explicit nil +### GetExampleOutput + +`func (o *WorkflowLibraryAction) GetExampleOutput() WorkflowLibraryActionExampleOutput` + +GetExampleOutput returns the ExampleOutput field if non-nil, zero value otherwise. + +### GetExampleOutputOk + +`func (o *WorkflowLibraryAction) GetExampleOutputOk() (*WorkflowLibraryActionExampleOutput, bool)` + +GetExampleOutputOk returns a tuple with the ExampleOutput field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetExampleOutput + +`func (o *WorkflowLibraryAction) SetExampleOutput(v WorkflowLibraryActionExampleOutput)` + +SetExampleOutput sets ExampleOutput field to given value. + +### HasExampleOutput + +`func (o *WorkflowLibraryAction) HasExampleOutput() bool` + +HasExampleOutput returns a boolean if a field has been set. + +### GetDeprecated + +`func (o *WorkflowLibraryAction) GetDeprecated() bool` + +GetDeprecated returns the Deprecated field if non-nil, zero value otherwise. + +### GetDeprecatedOk + +`func (o *WorkflowLibraryAction) GetDeprecatedOk() (*bool, bool)` + +GetDeprecatedOk returns a tuple with the Deprecated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecated + +`func (o *WorkflowLibraryAction) SetDeprecated(v bool)` + +SetDeprecated sets Deprecated field to given value. + +### HasDeprecated + +`func (o *WorkflowLibraryAction) HasDeprecated() bool` + +HasDeprecated returns a boolean if a field has been set. + +### GetDeprecatedBy + +`func (o *WorkflowLibraryAction) GetDeprecatedBy() SailPointTime` + +GetDeprecatedBy returns the DeprecatedBy field if non-nil, zero value otherwise. + +### GetDeprecatedByOk + +`func (o *WorkflowLibraryAction) GetDeprecatedByOk() (*SailPointTime, bool)` + +GetDeprecatedByOk returns a tuple with the DeprecatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecatedBy + +`func (o *WorkflowLibraryAction) SetDeprecatedBy(v SailPointTime)` + +SetDeprecatedBy sets DeprecatedBy field to given value. + +### HasDeprecatedBy + +`func (o *WorkflowLibraryAction) HasDeprecatedBy() bool` + +HasDeprecatedBy returns a boolean if a field has been set. + +### GetVersionNumber + +`func (o *WorkflowLibraryAction) GetVersionNumber() int32` + +GetVersionNumber returns the VersionNumber field if non-nil, zero value otherwise. + +### GetVersionNumberOk + +`func (o *WorkflowLibraryAction) GetVersionNumberOk() (*int32, bool)` + +GetVersionNumberOk returns a tuple with the VersionNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersionNumber + +`func (o *WorkflowLibraryAction) SetVersionNumber(v int32)` + +SetVersionNumber sets VersionNumber field to given value. + +### HasVersionNumber + +`func (o *WorkflowLibraryAction) HasVersionNumber() bool` + +HasVersionNumber returns a boolean if a field has been set. + +### GetIsSimulationEnabled + +`func (o *WorkflowLibraryAction) GetIsSimulationEnabled() bool` + +GetIsSimulationEnabled returns the IsSimulationEnabled field if non-nil, zero value otherwise. + +### GetIsSimulationEnabledOk + +`func (o *WorkflowLibraryAction) GetIsSimulationEnabledOk() (*bool, bool)` + +GetIsSimulationEnabledOk returns a tuple with the IsSimulationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSimulationEnabled + +`func (o *WorkflowLibraryAction) SetIsSimulationEnabled(v bool)` + +SetIsSimulationEnabled sets IsSimulationEnabled field to given value. + +### HasIsSimulationEnabled + +`func (o *WorkflowLibraryAction) HasIsSimulationEnabled() bool` + +HasIsSimulationEnabled returns a boolean if a field has been set. + +### GetIsDynamicSchema + +`func (o *WorkflowLibraryAction) GetIsDynamicSchema() bool` + +GetIsDynamicSchema returns the IsDynamicSchema field if non-nil, zero value otherwise. + +### GetIsDynamicSchemaOk + +`func (o *WorkflowLibraryAction) GetIsDynamicSchemaOk() (*bool, bool)` + +GetIsDynamicSchemaOk returns a tuple with the IsDynamicSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDynamicSchema + +`func (o *WorkflowLibraryAction) SetIsDynamicSchema(v bool)` + +SetIsDynamicSchema sets IsDynamicSchema field to given value. + +### HasIsDynamicSchema + +`func (o *WorkflowLibraryAction) HasIsDynamicSchema() bool` + +HasIsDynamicSchema returns a boolean if a field has been set. + +### GetOutputSchema + +`func (o *WorkflowLibraryAction) GetOutputSchema() map[string]interface{}` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *WorkflowLibraryAction) GetOutputSchemaOk() (*map[string]interface{}, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *WorkflowLibraryAction) SetOutputSchema(v map[string]interface{})` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *WorkflowLibraryAction) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkflowLibraryActionExampleOutput.md b/docs/tools/sdk/go/Reference/V3/Models/WorkflowLibraryActionExampleOutput.md new file mode 100644 index 000000000..50fc2a5c4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkflowLibraryActionExampleOutput.md @@ -0,0 +1,38 @@ +--- +id: workflow-library-action-example-output +title: WorkflowLibraryActionExampleOutput +pagination_label: WorkflowLibraryActionExampleOutput +sidebar_label: WorkflowLibraryActionExampleOutput +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryActionExampleOutput', 'WorkflowLibraryActionExampleOutput'] +slug: /tools/sdk/go/v3/models/workflow-library-action-example-output +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryActionExampleOutput', 'WorkflowLibraryActionExampleOutput'] +--- + +# WorkflowLibraryActionExampleOutput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Methods + +### NewWorkflowLibraryActionExampleOutput + +`func NewWorkflowLibraryActionExampleOutput() *WorkflowLibraryActionExampleOutput` + +NewWorkflowLibraryActionExampleOutput instantiates a new WorkflowLibraryActionExampleOutput 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 + +### NewWorkflowLibraryActionExampleOutputWithDefaults + +`func NewWorkflowLibraryActionExampleOutputWithDefaults() *WorkflowLibraryActionExampleOutput` + +NewWorkflowLibraryActionExampleOutputWithDefaults instantiates a new WorkflowLibraryActionExampleOutput 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 + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkflowLibraryFormFields.md b/docs/tools/sdk/go/Reference/V3/Models/WorkflowLibraryFormFields.md new file mode 100644 index 000000000..bece6f9d3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkflowLibraryFormFields.md @@ -0,0 +1,204 @@ +--- +id: workflow-library-form-fields +title: WorkflowLibraryFormFields +pagination_label: WorkflowLibraryFormFields +sidebar_label: WorkflowLibraryFormFields +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryFormFields', 'WorkflowLibraryFormFields'] +slug: /tools/sdk/go/v3/models/workflow-library-form-fields +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryFormFields', 'WorkflowLibraryFormFields'] +--- + +# WorkflowLibraryFormFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Description of the form field | [optional] +**HelpText** | Pointer to **string** | Describes the form field in the UI | [optional] +**Label** | Pointer to **string** | A human readable name for this form field in the UI | [optional] +**Name** | Pointer to **string** | The name of the input attribute | [optional] +**Required** | Pointer to **bool** | Denotes if this field is a required attribute | [optional] [default to false] +**Type** | Pointer to **NullableString** | The type of the form field | [optional] + +## Methods + +### NewWorkflowLibraryFormFields + +`func NewWorkflowLibraryFormFields() *WorkflowLibraryFormFields` + +NewWorkflowLibraryFormFields instantiates a new WorkflowLibraryFormFields 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 + +### NewWorkflowLibraryFormFieldsWithDefaults + +`func NewWorkflowLibraryFormFieldsWithDefaults() *WorkflowLibraryFormFields` + +NewWorkflowLibraryFormFieldsWithDefaults instantiates a new WorkflowLibraryFormFields 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 + +### GetDescription + +`func (o *WorkflowLibraryFormFields) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowLibraryFormFields) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowLibraryFormFields) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowLibraryFormFields) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetHelpText + +`func (o *WorkflowLibraryFormFields) GetHelpText() string` + +GetHelpText returns the HelpText field if non-nil, zero value otherwise. + +### GetHelpTextOk + +`func (o *WorkflowLibraryFormFields) GetHelpTextOk() (*string, bool)` + +GetHelpTextOk returns a tuple with the HelpText field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHelpText + +`func (o *WorkflowLibraryFormFields) SetHelpText(v string)` + +SetHelpText sets HelpText field to given value. + +### HasHelpText + +`func (o *WorkflowLibraryFormFields) HasHelpText() bool` + +HasHelpText returns a boolean if a field has been set. + +### GetLabel + +`func (o *WorkflowLibraryFormFields) GetLabel() string` + +GetLabel returns the Label field if non-nil, zero value otherwise. + +### GetLabelOk + +`func (o *WorkflowLibraryFormFields) GetLabelOk() (*string, bool)` + +GetLabelOk returns a tuple with the Label field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLabel + +`func (o *WorkflowLibraryFormFields) SetLabel(v string)` + +SetLabel sets Label field to given value. + +### HasLabel + +`func (o *WorkflowLibraryFormFields) HasLabel() bool` + +HasLabel returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowLibraryFormFields) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowLibraryFormFields) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowLibraryFormFields) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowLibraryFormFields) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetRequired + +`func (o *WorkflowLibraryFormFields) GetRequired() bool` + +GetRequired returns the Required field if non-nil, zero value otherwise. + +### GetRequiredOk + +`func (o *WorkflowLibraryFormFields) GetRequiredOk() (*bool, bool)` + +GetRequiredOk returns a tuple with the Required field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequired + +`func (o *WorkflowLibraryFormFields) SetRequired(v bool)` + +SetRequired sets Required field to given value. + +### HasRequired + +`func (o *WorkflowLibraryFormFields) HasRequired() bool` + +HasRequired returns a boolean if a field has been set. + +### GetType + +`func (o *WorkflowLibraryFormFields) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowLibraryFormFields) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowLibraryFormFields) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowLibraryFormFields) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetTypeNil + +`func (o *WorkflowLibraryFormFields) SetTypeNil(b bool)` + + SetTypeNil sets the value for Type to be an explicit nil + +### UnsetType +`func (o *WorkflowLibraryFormFields) UnsetType()` + +UnsetType ensures that no value is present for Type, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkflowLibraryOperator.md b/docs/tools/sdk/go/Reference/V3/Models/WorkflowLibraryOperator.md new file mode 100644 index 000000000..c64f4c122 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkflowLibraryOperator.md @@ -0,0 +1,282 @@ +--- +id: workflow-library-operator +title: WorkflowLibraryOperator +pagination_label: WorkflowLibraryOperator +sidebar_label: WorkflowLibraryOperator +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryOperator', 'WorkflowLibraryOperator'] +slug: /tools/sdk/go/v3/models/workflow-library-operator +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryOperator', 'WorkflowLibraryOperator'] +--- + +# WorkflowLibraryOperator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Operator ID. | [optional] +**Name** | Pointer to **string** | Operator friendly name | [optional] +**Type** | Pointer to **string** | Operator type | [optional] +**Description** | Pointer to **string** | Description of the operator | [optional] +**IsDynamicSchema** | Pointer to **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**Deprecated** | Pointer to **bool** | | [optional] +**DeprecatedBy** | Pointer to **SailPointTime** | | [optional] +**IsSimulationEnabled** | Pointer to **bool** | | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] + +## Methods + +### NewWorkflowLibraryOperator + +`func NewWorkflowLibraryOperator() *WorkflowLibraryOperator` + +NewWorkflowLibraryOperator instantiates a new WorkflowLibraryOperator 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 + +### NewWorkflowLibraryOperatorWithDefaults + +`func NewWorkflowLibraryOperatorWithDefaults() *WorkflowLibraryOperator` + +NewWorkflowLibraryOperatorWithDefaults instantiates a new WorkflowLibraryOperator 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 + +### GetId + +`func (o *WorkflowLibraryOperator) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowLibraryOperator) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowLibraryOperator) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowLibraryOperator) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowLibraryOperator) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowLibraryOperator) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowLibraryOperator) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowLibraryOperator) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *WorkflowLibraryOperator) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowLibraryOperator) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowLibraryOperator) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowLibraryOperator) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkflowLibraryOperator) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowLibraryOperator) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowLibraryOperator) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowLibraryOperator) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIsDynamicSchema + +`func (o *WorkflowLibraryOperator) GetIsDynamicSchema() bool` + +GetIsDynamicSchema returns the IsDynamicSchema field if non-nil, zero value otherwise. + +### GetIsDynamicSchemaOk + +`func (o *WorkflowLibraryOperator) GetIsDynamicSchemaOk() (*bool, bool)` + +GetIsDynamicSchemaOk returns a tuple with the IsDynamicSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDynamicSchema + +`func (o *WorkflowLibraryOperator) SetIsDynamicSchema(v bool)` + +SetIsDynamicSchema sets IsDynamicSchema field to given value. + +### HasIsDynamicSchema + +`func (o *WorkflowLibraryOperator) HasIsDynamicSchema() bool` + +HasIsDynamicSchema returns a boolean if a field has been set. + +### GetDeprecated + +`func (o *WorkflowLibraryOperator) GetDeprecated() bool` + +GetDeprecated returns the Deprecated field if non-nil, zero value otherwise. + +### GetDeprecatedOk + +`func (o *WorkflowLibraryOperator) GetDeprecatedOk() (*bool, bool)` + +GetDeprecatedOk returns a tuple with the Deprecated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecated + +`func (o *WorkflowLibraryOperator) SetDeprecated(v bool)` + +SetDeprecated sets Deprecated field to given value. + +### HasDeprecated + +`func (o *WorkflowLibraryOperator) HasDeprecated() bool` + +HasDeprecated returns a boolean if a field has been set. + +### GetDeprecatedBy + +`func (o *WorkflowLibraryOperator) GetDeprecatedBy() SailPointTime` + +GetDeprecatedBy returns the DeprecatedBy field if non-nil, zero value otherwise. + +### GetDeprecatedByOk + +`func (o *WorkflowLibraryOperator) GetDeprecatedByOk() (*SailPointTime, bool)` + +GetDeprecatedByOk returns a tuple with the DeprecatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecatedBy + +`func (o *WorkflowLibraryOperator) SetDeprecatedBy(v SailPointTime)` + +SetDeprecatedBy sets DeprecatedBy field to given value. + +### HasDeprecatedBy + +`func (o *WorkflowLibraryOperator) HasDeprecatedBy() bool` + +HasDeprecatedBy returns a boolean if a field has been set. + +### GetIsSimulationEnabled + +`func (o *WorkflowLibraryOperator) GetIsSimulationEnabled() bool` + +GetIsSimulationEnabled returns the IsSimulationEnabled field if non-nil, zero value otherwise. + +### GetIsSimulationEnabledOk + +`func (o *WorkflowLibraryOperator) GetIsSimulationEnabledOk() (*bool, bool)` + +GetIsSimulationEnabledOk returns a tuple with the IsSimulationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSimulationEnabled + +`func (o *WorkflowLibraryOperator) SetIsSimulationEnabled(v bool)` + +SetIsSimulationEnabled sets IsSimulationEnabled field to given value. + +### HasIsSimulationEnabled + +`func (o *WorkflowLibraryOperator) HasIsSimulationEnabled() bool` + +HasIsSimulationEnabled returns a boolean if a field has been set. + +### GetFormFields + +`func (o *WorkflowLibraryOperator) GetFormFields() []WorkflowLibraryFormFields` + +GetFormFields returns the FormFields field if non-nil, zero value otherwise. + +### GetFormFieldsOk + +`func (o *WorkflowLibraryOperator) GetFormFieldsOk() (*[]WorkflowLibraryFormFields, bool)` + +GetFormFieldsOk returns a tuple with the FormFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormFields + +`func (o *WorkflowLibraryOperator) SetFormFields(v []WorkflowLibraryFormFields)` + +SetFormFields sets FormFields field to given value. + +### HasFormFields + +`func (o *WorkflowLibraryOperator) HasFormFields() bool` + +HasFormFields returns a boolean if a field has been set. + +### SetFormFieldsNil + +`func (o *WorkflowLibraryOperator) SetFormFieldsNil(b bool)` + + SetFormFieldsNil sets the value for FormFields to be an explicit nil + +### UnsetFormFields +`func (o *WorkflowLibraryOperator) UnsetFormFields()` + +UnsetFormFields ensures that no value is present for FormFields, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkflowLibraryTrigger.md b/docs/tools/sdk/go/Reference/V3/Models/WorkflowLibraryTrigger.md new file mode 100644 index 000000000..58aab6dbf --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkflowLibraryTrigger.md @@ -0,0 +1,344 @@ +--- +id: workflow-library-trigger +title: WorkflowLibraryTrigger +pagination_label: WorkflowLibraryTrigger +sidebar_label: WorkflowLibraryTrigger +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowLibraryTrigger', 'WorkflowLibraryTrigger'] +slug: /tools/sdk/go/v3/models/workflow-library-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryTrigger', 'WorkflowLibraryTrigger'] +--- + +# WorkflowLibraryTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Trigger ID. This is a static namespaced ID for the trigger. | [optional] +**Type** | Pointer to **string** | Trigger type | [optional] +**Deprecated** | Pointer to **bool** | | [optional] +**DeprecatedBy** | Pointer to **SailPointTime** | | [optional] +**IsSimulationEnabled** | Pointer to **bool** | | [optional] +**OutputSchema** | Pointer to **map[string]interface{}** | Example output schema | [optional] +**Name** | Pointer to **string** | Trigger Name | [optional] +**Description** | Pointer to **string** | Trigger Description | [optional] +**IsDynamicSchema** | Pointer to **bool** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] [default to false] +**InputExample** | Pointer to **map[string]interface{}** | Example trigger payload if applicable | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the trigger accepts | [optional] + +## Methods + +### NewWorkflowLibraryTrigger + +`func NewWorkflowLibraryTrigger() *WorkflowLibraryTrigger` + +NewWorkflowLibraryTrigger instantiates a new WorkflowLibraryTrigger 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 + +### NewWorkflowLibraryTriggerWithDefaults + +`func NewWorkflowLibraryTriggerWithDefaults() *WorkflowLibraryTrigger` + +NewWorkflowLibraryTriggerWithDefaults instantiates a new WorkflowLibraryTrigger 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 + +### GetId + +`func (o *WorkflowLibraryTrigger) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowLibraryTrigger) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowLibraryTrigger) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowLibraryTrigger) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *WorkflowLibraryTrigger) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowLibraryTrigger) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowLibraryTrigger) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowLibraryTrigger) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetDeprecated + +`func (o *WorkflowLibraryTrigger) GetDeprecated() bool` + +GetDeprecated returns the Deprecated field if non-nil, zero value otherwise. + +### GetDeprecatedOk + +`func (o *WorkflowLibraryTrigger) GetDeprecatedOk() (*bool, bool)` + +GetDeprecatedOk returns a tuple with the Deprecated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecated + +`func (o *WorkflowLibraryTrigger) SetDeprecated(v bool)` + +SetDeprecated sets Deprecated field to given value. + +### HasDeprecated + +`func (o *WorkflowLibraryTrigger) HasDeprecated() bool` + +HasDeprecated returns a boolean if a field has been set. + +### GetDeprecatedBy + +`func (o *WorkflowLibraryTrigger) GetDeprecatedBy() SailPointTime` + +GetDeprecatedBy returns the DeprecatedBy field if non-nil, zero value otherwise. + +### GetDeprecatedByOk + +`func (o *WorkflowLibraryTrigger) GetDeprecatedByOk() (*SailPointTime, bool)` + +GetDeprecatedByOk returns a tuple with the DeprecatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeprecatedBy + +`func (o *WorkflowLibraryTrigger) SetDeprecatedBy(v SailPointTime)` + +SetDeprecatedBy sets DeprecatedBy field to given value. + +### HasDeprecatedBy + +`func (o *WorkflowLibraryTrigger) HasDeprecatedBy() bool` + +HasDeprecatedBy returns a boolean if a field has been set. + +### GetIsSimulationEnabled + +`func (o *WorkflowLibraryTrigger) GetIsSimulationEnabled() bool` + +GetIsSimulationEnabled returns the IsSimulationEnabled field if non-nil, zero value otherwise. + +### GetIsSimulationEnabledOk + +`func (o *WorkflowLibraryTrigger) GetIsSimulationEnabledOk() (*bool, bool)` + +GetIsSimulationEnabledOk returns a tuple with the IsSimulationEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSimulationEnabled + +`func (o *WorkflowLibraryTrigger) SetIsSimulationEnabled(v bool)` + +SetIsSimulationEnabled sets IsSimulationEnabled field to given value. + +### HasIsSimulationEnabled + +`func (o *WorkflowLibraryTrigger) HasIsSimulationEnabled() bool` + +HasIsSimulationEnabled returns a boolean if a field has been set. + +### GetOutputSchema + +`func (o *WorkflowLibraryTrigger) GetOutputSchema() map[string]interface{}` + +GetOutputSchema returns the OutputSchema field if non-nil, zero value otherwise. + +### GetOutputSchemaOk + +`func (o *WorkflowLibraryTrigger) GetOutputSchemaOk() (*map[string]interface{}, bool)` + +GetOutputSchemaOk returns a tuple with the OutputSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOutputSchema + +`func (o *WorkflowLibraryTrigger) SetOutputSchema(v map[string]interface{})` + +SetOutputSchema sets OutputSchema field to given value. + +### HasOutputSchema + +`func (o *WorkflowLibraryTrigger) HasOutputSchema() bool` + +HasOutputSchema returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowLibraryTrigger) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowLibraryTrigger) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowLibraryTrigger) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowLibraryTrigger) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetDescription + +`func (o *WorkflowLibraryTrigger) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WorkflowLibraryTrigger) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *WorkflowLibraryTrigger) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *WorkflowLibraryTrigger) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetIsDynamicSchema + +`func (o *WorkflowLibraryTrigger) GetIsDynamicSchema() bool` + +GetIsDynamicSchema returns the IsDynamicSchema field if non-nil, zero value otherwise. + +### GetIsDynamicSchemaOk + +`func (o *WorkflowLibraryTrigger) GetIsDynamicSchemaOk() (*bool, bool)` + +GetIsDynamicSchemaOk returns a tuple with the IsDynamicSchema field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsDynamicSchema + +`func (o *WorkflowLibraryTrigger) SetIsDynamicSchema(v bool)` + +SetIsDynamicSchema sets IsDynamicSchema field to given value. + +### HasIsDynamicSchema + +`func (o *WorkflowLibraryTrigger) HasIsDynamicSchema() bool` + +HasIsDynamicSchema returns a boolean if a field has been set. + +### GetInputExample + +`func (o *WorkflowLibraryTrigger) GetInputExample() map[string]interface{}` + +GetInputExample returns the InputExample field if non-nil, zero value otherwise. + +### GetInputExampleOk + +`func (o *WorkflowLibraryTrigger) GetInputExampleOk() (*map[string]interface{}, bool)` + +GetInputExampleOk returns a tuple with the InputExample field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInputExample + +`func (o *WorkflowLibraryTrigger) SetInputExample(v map[string]interface{})` + +SetInputExample sets InputExample field to given value. + +### HasInputExample + +`func (o *WorkflowLibraryTrigger) HasInputExample() bool` + +HasInputExample returns a boolean if a field has been set. + +### SetInputExampleNil + +`func (o *WorkflowLibraryTrigger) SetInputExampleNil(b bool)` + + SetInputExampleNil sets the value for InputExample to be an explicit nil + +### UnsetInputExample +`func (o *WorkflowLibraryTrigger) UnsetInputExample()` + +UnsetInputExample ensures that no value is present for InputExample, not even an explicit nil +### GetFormFields + +`func (o *WorkflowLibraryTrigger) GetFormFields() []WorkflowLibraryFormFields` + +GetFormFields returns the FormFields field if non-nil, zero value otherwise. + +### GetFormFieldsOk + +`func (o *WorkflowLibraryTrigger) GetFormFieldsOk() (*[]WorkflowLibraryFormFields, bool)` + +GetFormFieldsOk returns a tuple with the FormFields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFormFields + +`func (o *WorkflowLibraryTrigger) SetFormFields(v []WorkflowLibraryFormFields)` + +SetFormFields sets FormFields field to given value. + +### HasFormFields + +`func (o *WorkflowLibraryTrigger) HasFormFields() bool` + +HasFormFields returns a boolean if a field has been set. + +### SetFormFieldsNil + +`func (o *WorkflowLibraryTrigger) SetFormFieldsNil(b bool)` + + SetFormFieldsNil sets the value for FormFields to be an explicit nil + +### UnsetFormFields +`func (o *WorkflowLibraryTrigger) UnsetFormFields()` + +UnsetFormFields ensures that no value is present for FormFields, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkflowModifiedBy.md b/docs/tools/sdk/go/Reference/V3/Models/WorkflowModifiedBy.md new file mode 100644 index 000000000..c679873d3 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkflowModifiedBy.md @@ -0,0 +1,116 @@ +--- +id: workflow-modified-by +title: WorkflowModifiedBy +pagination_label: WorkflowModifiedBy +sidebar_label: WorkflowModifiedBy +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowModifiedBy', 'WorkflowModifiedBy'] +slug: /tools/sdk/go/v3/models/workflow-modified-by +tags: ['SDK', 'Software Development Kit', 'WorkflowModifiedBy', 'WorkflowModifiedBy'] +--- + +# WorkflowModifiedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | | [optional] +**Id** | Pointer to **string** | Identity ID | [optional] +**Name** | Pointer to **string** | Human-readable display name of identity. | [optional] + +## Methods + +### NewWorkflowModifiedBy + +`func NewWorkflowModifiedBy() *WorkflowModifiedBy` + +NewWorkflowModifiedBy instantiates a new WorkflowModifiedBy 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 + +### NewWorkflowModifiedByWithDefaults + +`func NewWorkflowModifiedByWithDefaults() *WorkflowModifiedBy` + +NewWorkflowModifiedByWithDefaults instantiates a new WorkflowModifiedBy 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 + +### GetType + +`func (o *WorkflowModifiedBy) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowModifiedBy) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowModifiedBy) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *WorkflowModifiedBy) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetId + +`func (o *WorkflowModifiedBy) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowModifiedBy) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowModifiedBy) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowModifiedBy) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *WorkflowModifiedBy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *WorkflowModifiedBy) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *WorkflowModifiedBy) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *WorkflowModifiedBy) HasName() bool` + +HasName returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkflowOAuthClient.md b/docs/tools/sdk/go/Reference/V3/Models/WorkflowOAuthClient.md new file mode 100644 index 000000000..6950ae59b --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkflowOAuthClient.md @@ -0,0 +1,116 @@ +--- +id: workflow-o-auth-client +title: WorkflowOAuthClient +pagination_label: WorkflowOAuthClient +sidebar_label: WorkflowOAuthClient +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowOAuthClient', 'WorkflowOAuthClient'] +slug: /tools/sdk/go/v3/models/workflow-o-auth-client +tags: ['SDK', 'Software Development Kit', 'WorkflowOAuthClient', 'WorkflowOAuthClient'] +--- + +# WorkflowOAuthClient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | OAuth client ID for the trigger. This is a UUID generated upon creation. | [optional] +**Secret** | Pointer to **string** | OAuthClient secret. | [optional] +**Url** | Pointer to **string** | URL for the external trigger to invoke | [optional] + +## Methods + +### NewWorkflowOAuthClient + +`func NewWorkflowOAuthClient() *WorkflowOAuthClient` + +NewWorkflowOAuthClient instantiates a new WorkflowOAuthClient 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 + +### NewWorkflowOAuthClientWithDefaults + +`func NewWorkflowOAuthClientWithDefaults() *WorkflowOAuthClient` + +NewWorkflowOAuthClientWithDefaults instantiates a new WorkflowOAuthClient 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 + +### GetId + +`func (o *WorkflowOAuthClient) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *WorkflowOAuthClient) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *WorkflowOAuthClient) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *WorkflowOAuthClient) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetSecret + +`func (o *WorkflowOAuthClient) GetSecret() string` + +GetSecret returns the Secret field if non-nil, zero value otherwise. + +### GetSecretOk + +`func (o *WorkflowOAuthClient) GetSecretOk() (*string, bool)` + +GetSecretOk returns a tuple with the Secret field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecret + +`func (o *WorkflowOAuthClient) SetSecret(v string)` + +SetSecret sets Secret field to given value. + +### HasSecret + +`func (o *WorkflowOAuthClient) HasSecret() bool` + +HasSecret returns a boolean if a field has been set. + +### GetUrl + +`func (o *WorkflowOAuthClient) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *WorkflowOAuthClient) GetUrlOk() (*string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrl + +`func (o *WorkflowOAuthClient) SetUrl(v string)` + +SetUrl sets Url field to given value. + +### HasUrl + +`func (o *WorkflowOAuthClient) HasUrl() bool` + +HasUrl returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V3/Models/WorkflowTrigger.md b/docs/tools/sdk/go/Reference/V3/Models/WorkflowTrigger.md new file mode 100644 index 000000000..8eb5c7173 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V3/Models/WorkflowTrigger.md @@ -0,0 +1,126 @@ +--- +id: workflow-trigger +title: WorkflowTrigger +pagination_label: WorkflowTrigger +sidebar_label: WorkflowTrigger +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'WorkflowTrigger', 'WorkflowTrigger'] +slug: /tools/sdk/go/v3/models/workflow-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowTrigger', 'WorkflowTrigger'] +--- + +# WorkflowTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | The trigger type | +**DisplayName** | Pointer to **NullableString** | | [optional] +**Attributes** | **map[string]interface{}** | Workflow Trigger Attributes. | + +## Methods + +### NewWorkflowTrigger + +`func NewWorkflowTrigger(type_ string, attributes map[string]interface{}, ) *WorkflowTrigger` + +NewWorkflowTrigger instantiates a new WorkflowTrigger 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 + +### NewWorkflowTriggerWithDefaults + +`func NewWorkflowTriggerWithDefaults() *WorkflowTrigger` + +NewWorkflowTriggerWithDefaults instantiates a new WorkflowTrigger 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 + +### GetType + +`func (o *WorkflowTrigger) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *WorkflowTrigger) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *WorkflowTrigger) SetType(v string)` + +SetType sets Type field to given value. + + +### GetDisplayName + +`func (o *WorkflowTrigger) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *WorkflowTrigger) GetDisplayNameOk() (*string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisplayName + +`func (o *WorkflowTrigger) SetDisplayName(v string)` + +SetDisplayName sets DisplayName field to given value. + +### HasDisplayName + +`func (o *WorkflowTrigger) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### SetDisplayNameNil + +`func (o *WorkflowTrigger) SetDisplayNameNil(b bool)` + + SetDisplayNameNil sets the value for DisplayName to be an explicit nil + +### UnsetDisplayName +`func (o *WorkflowTrigger) UnsetDisplayName()` + +UnsetDisplayName ensures that no value is present for DisplayName, not even an explicit nil +### GetAttributes + +`func (o *WorkflowTrigger) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *WorkflowTrigger) GetAttributesOk() (*map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAttributes + +`func (o *WorkflowTrigger) SetAttributes(v map[string]interface{})` + +SetAttributes sets Attributes field to given value. + + +### SetAttributesNil + +`func (o *WorkflowTrigger) SetAttributesNil(b bool)` + + SetAttributesNil sets the value for Attributes to be an explicit nil + +### UnsetAttributes +`func (o *WorkflowTrigger) UnsetAttributes()` + +UnsetAttributes ensures that no value is present for Attributes, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/index.md b/docs/tools/sdk/go/Reference/index.md new file mode 100644 index 000000000..a38e49f09 --- /dev/null +++ b/docs/tools/sdk/go/Reference/index.md @@ -0,0 +1,29 @@ +--- +id: reference +title: Golang SDK Reference +pagination_label: Reference +sidebar_label: Reference +sidebar_position: 9 +sidebar_class_name: reference +keywords: ['reference'] +description: Golang SDK reference. +slug: /tools/go/reference +tags: ['Reference'] +--- + +Welcome to the **Golang SDK Reference**. This reference guide provides detailed documentation about how to use the SDK to interact with the Identity Security Cloud (ISC) API, including available methods and models for each API version (Beta, V3, and V2024). Whether you're automating workflows, managing resources, or integrating with other systems, this reference guide will help you effectively leverage the Golang SDK. + +### What You'll Find Here: +- **[Beta Method Reference](/docs/tools/sdk/go/beta/methods)** – List of available Beta cmdlets, their parameters, and expected outputs. +- **[Beta Model Definitions](/docs/tools/sdk/go/beta/models)** – Descriptions of Beta objects and data structures the SDK uses. +- **Usage Examples** – Practical Golang scripts demonstrating common tasks. + +Use this reference guide as a companion while scripting and automating tasks. If you're new to the SDK, check out [Installation & Setup](/docs/tools/sdk/go) before you get started. + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/package.json b/package.json index 4f8690ebb..e8319af60 100644 --- a/package.json +++ b/package.json @@ -19,16 +19,16 @@ "gen-api-docs-all": "npm run merge-all-code-examples && npm run gen-all-api-specs-code-examples && docusaurus gen-api-docs:version isc_versioned:all --plugin-id isc-api && docusaurus gen-api-docs isc_versioned --plugin-id isc-api && docusaurus gen-api-docs iiq --plugin-id iiq-api && docusaurus gen-api-docs nerm --plugin-id nerm-api", "clean-api-docs-all": "docusaurus clean-api-docs isc_versioned --plugin-id isc-api && docusaurus clean-api-docs:version isc_versioned:all --plugin-id isc-api && docusaurus clean-api-docs iiq --plugin-id iiq-api && docusaurus clean-api-docs nerm --plugin-id nerm-api", "rebuild-docs": "npm run clean-api-docs-all && npm run gen-api-docs-all", - "beta-merge-code-examples": "node src/components/mergeoverlayfiles.js static/code-examples/beta/python_code_examples_overlay.yaml static/code-examples/beta/powershell_code_examples_overlay.yaml", + "beta-merge-code-examples": "node src/components/mergeoverlayfiles.js static/code-examples/beta/python_code_examples_overlay.yaml static/code-examples/beta/powershell_code_examples_overlay.yaml static/code-examples/beta/go_code_examples_overlay.yaml", "speecy-beta-spec": "speccy resolve --quiet static/api-specs/idn/sailpoint-api.beta.yaml -o static/code-examples/beta/beta.yaml", "overlay-code-examples-beta": "node src/components/overlay.js static/code-examples/beta/beta.yaml static/code-examples/beta/merged_code_examples.yaml", - "v3-merge-code-examples": "node src/components/mergeoverlayfiles.js static/code-examples/v3/python_code_examples_overlay.yaml static/code-examples/v3/powershell_code_examples_overlay.yaml", + "v3-merge-code-examples": "node src/components/mergeoverlayfiles.js static/code-examples/v3/python_code_examples_overlay.yaml static/code-examples/v3/powershell_code_examples_overlay.yaml static/code-examples/v3/go_code_examples_overlay.yaml", "speecy-v3-spec": "speccy resolve --quiet static/api-specs/idn/sailpoint-api.v3.yaml -o static/code-examples/v3/v3.yaml", "overlay-code-examples-v3": "node src/components/overlay.js static/code-examples/v3/v3.yaml static/code-examples/v3/merged_code_examples.yaml", - "v2024-merge-code-examples": "node src/components/mergeoverlayfiles.js static/code-examples/v2024/python_code_examples_overlay.yaml static/code-examples/v2024/powershell_code_examples_overlay.yaml", + "v2024-merge-code-examples": "node src/components/mergeoverlayfiles.js static/code-examples/v2024/python_code_examples_overlay.yaml static/code-examples/v2024/powershell_code_examples_overlay.yaml static/code-examples/v2024/go_code_examples_overlay.yaml", "speecy-v2024-spec": "speccy resolve --quiet static/api-specs/idn/sailpoint-api.v2024.yaml -o static/code-examples/v2024/v2024.yaml", "overlay-code-examples-v2024": "node src/components/overlay.js static/code-examples/v2024/v2024.yaml static/code-examples/v2024/merged_code_examples.yaml", - "v2025-merge-code-examples": "node src/components/mergeoverlayfiles.js static/code-examples/v2025/python_code_examples_overlay.yaml static/code-examples/v2025/powershell_code_examples_overlay.yaml", + "v2025-merge-code-examples": "node src/components/mergeoverlayfiles.js static/code-examples/v2025/python_code_examples_overlay.yaml static/code-examples/v2025/powershell_code_examples_overlay.yaml static/code-examples/v2025/go_code_examples_overlay.yaml", "speecy-v2025-spec": "speccy resolve --quiet static/api-specs/idn/sailpoint-api.v2025.yaml -o static/code-examples/v2025/v2025.yaml", "overlay-code-examples-v2025": "node src/components/overlay.js static/code-examples/v2025/v2025.yaml static/code-examples/v2025/merged_code_examples.yaml", "gen-all-api-specs-code-examples": "npm run speecy-beta-spec && npm run overlay-code-examples-beta && npm run speecy-v3-spec && npm run overlay-code-examples-v3 && npm run speecy-v2024-spec && npm run overlay-code-examples-v2024 && npm run speecy-v2025-spec && npm run overlay-code-examples-v2025", @@ -78,16 +78,16 @@ "@docusaurus/core": "3.7.0", "@docusaurus/module-type-aliases": "3.7.0", "@docusaurus/preset-classic": "3.7.0", - "@docusaurus/types": "3.7.0", "@docusaurus/tsconfig": "3.7.0", - "typescript": "~5.6.2", + "@docusaurus/types": "3.7.0", "dotenv": "^16.4.5", "esbuild": "^0.25.0", "husky": "^8.0.2", + "js-yaml": "^4.1.0", "prettier": "2.8.0", "pretty-quick": "^3.1.3", "speccy": "^0.8.7", - "js-yaml": "^4.1.0" + "typescript": "~5.6.2" }, "browserslist": { "production": [ diff --git a/src/components/mergeoverlayfiles.js b/src/components/mergeoverlayfiles.js index 942d2b85c..c526b6f21 100644 --- a/src/components/mergeoverlayfiles.js +++ b/src/components/mergeoverlayfiles.js @@ -1,86 +1,49 @@ -const fs = require('fs'); +const fs = require('fs'); const yaml = require('js-yaml'); const path = require('path'); // Get file paths from command line arguments -const pythonFilePath = process.argv[2]; -const powershellFilePath = process.argv[3]; +const [powershellFilePath, pythonFilePath, goFilePath] = process.argv.slice(2); -// Check if the correct number of arguments is passed -if (!pythonFilePath || !powershellFilePath) { - console.error('Please provide the paths for the Python and PowerShell YAML files.'); +// Check that all three arguments are provided +if (!powershellFilePath || !pythonFilePath || !goFilePath) { + console.error('Usage: node merge.js '); process.exit(1); } -// Read both YAML files -const powershellFile = fs.readFileSync(powershellFilePath, 'utf8'); -const pythonFile = fs.readFileSync(pythonFilePath, 'utf8'); +// Read & parse all three YAML files +const powershellData = yaml.load(fs.readFileSync(powershellFilePath, 'utf8')); +const pythonData = yaml.load(fs.readFileSync(pythonFilePath, 'utf8')); +const goData = yaml.load(fs.readFileSync(goFilePath, 'utf8')); -// Parse both YAML files -const powershellData = yaml.load(powershellFile); -const pythonData = yaml.load(pythonFile); +// Merge logic (collects all three in one pass) +const mergeCodeSamples = (...allData) => { + const merged = {}; -// Function to merge xCodeSamples for the same path and method -const mergeCodeSamples = (powershellData, pythonData) => { - // Create a map to keep track of paths and methods, and merged samples - const mergedData = {}; - - // Iterate over both files - [powershellData, pythonData].forEach(fileData => { - fileData.forEach(item => { - const path = item.path; - const method = item.method; - - // Initialize the path and method if not already in mergedData - if (!mergedData[path]) { - mergedData[path] = {}; + allData.forEach(fileData => { + (fileData || []).forEach(item => { + const key = `${item.path}|${item.method}`; + if (!merged[key]) { + merged[key] = { path: item.path, method: item.method, xCodeSample: [] }; } - - if (!mergedData[path][method]) { - mergedData[path][method] = { - path: item.path, - method: item.method, - xCodeSample: [] - }; - } - - // Add the xCodeSample data, if it exists - if (item.xCodeSample) { - mergedData[path][method].xCodeSample.push(...item.xCodeSample); + if (Array.isArray(item.xCodeSample)) { + merged[key].xCodeSample.push(...item.xCodeSample); } }); }); - // Convert the merged data back to an array format (flatten the structure) - const mergedArray = []; - Object.keys(mergedData).forEach(path => { - Object.keys(mergedData[path]).forEach(method => { - mergedArray.push(mergedData[path][method]); - }); - }); - - return mergedArray; + return Object.values(merged); }; -// Merge the data -const mergedCode = mergeCodeSamples(powershellData, pythonData); +// Perform the merge +const mergedArray = mergeCodeSamples(powershellData, pythonData, goData); -// Convert the merged data to YAML format with lineWidth: -1 to avoid block-style strings -const mergedYaml = yaml.dump(mergedCode, { - lineWidth: -1 // Avoid wrapping strings into block-style format -}); +// Dump back to YAML without line-wrapping +const mergedYaml = yaml.dump(mergedArray, { lineWidth: -1 }); -// Derive the output directory and file name -const pythonFileDir = path.dirname(pythonFilePath); -const powershellFileDir = path.dirname(powershellFilePath); +// Write to output next to the Go file (you can choose a different base dir if you like) +const outDir = path.dirname(goFilePath); +const outPath = path.join(outDir, 'merged_code_examples.yaml'); +fs.writeFileSync(outPath, mergedYaml, 'utf8'); -// Find the common directory (use the Python file's directory as the base) -const commonDir = pythonFileDir; - -// Create the output file path -const outputFilePath = path.join(commonDir, 'merged_code_examples.yaml'); - -// Write the merged result to the output file -fs.writeFileSync(outputFilePath, mergedYaml, 'utf8'); - -console.log(`Merged YAML file has been saved to ${outputFilePath}`); +console.log(`Merged YAML written to ${outPath}`); diff --git a/src/theme/ApiExplorer/CodeSnippets/languages.ts b/src/theme/ApiExplorer/CodeSnippets/languages.ts index 524d52939..af65d1f4f 100644 --- a/src/theme/ApiExplorer/CodeSnippets/languages.ts +++ b/src/theme/ApiExplorer/CodeSnippets/languages.ts @@ -93,7 +93,7 @@ export function generateLanguageSet() { }, variant: variants[0], variants: variants, - tag: language.key === 'powershell' || language.key === 'python' ? 'sailpoint-sdk' : '', // Only add the "sailpoint-sdk" tag for PowerShell or Python + tag: ['powershell', 'python', 'go'].includes(language.key) ? 'sailpoint-sdk' : '', }); }); diff --git a/static/code-examples/beta/go_code_examples_overlay.yaml b/static/code-examples/beta/go_code_examples_overlay.yaml new file mode 100644 index 000000000..e226423b8 --- /dev/null +++ b/static/code-examples/beta/go_code_examples_overlay.yaml @@ -0,0 +1,23247 @@ +- path: /access-model-metadata/attributes/{key} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-model-metadata#get-access-model-metadata-attribute + source: | + 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() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessModelMetadataAPI.GetAccessModelMetadataAttribute(context.Background(), key).Execute() + //resp, r, err := apiClient.Beta.AccessModelMetadataAPI.GetAccessModelMetadataAttribute(context.Background(), key).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.GetAccessModelMetadataAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessModelMetadataAttribute`: AttributeDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.GetAccessModelMetadataAttribute`: %v\n", resp) + } +- path: /access-model-metadata/attributes/{key}/values/{value} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-model-metadata#get-access-model-metadata-attribute-value + source: | + 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() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + value := `public` // string | Technical name of the Attribute value. # string | Technical name of the Attribute value. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue(context.Background(), key, value).Execute() + //resp, r, err := apiClient.Beta.AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue(context.Background(), key, value).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessModelMetadataAttributeValue`: AttributeValueDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue`: %v\n", resp) + } +- path: /access-model-metadata/attributes + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-model-metadata#list-access-model-metadata-attribute + source: | + 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() { + filters := `name eq "Privacy"` // 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessModelMetadataAPI.ListAccessModelMetadataAttribute(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccessModelMetadataAPI.ListAccessModelMetadataAttribute(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.ListAccessModelMetadataAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessModelMetadataAttribute`: []AttributeDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.ListAccessModelMetadataAttribute`: %v\n", resp) + } +- path: /access-model-metadata/attributes/{key}/values + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-model-metadata#list-access-model-metadata-attribute-value + source: | + 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() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue(context.Background(), key).Execute() + //resp, r, err := apiClient.Beta.AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue(context.Background(), key).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessModelMetadataAttributeValue`: []AttributeValueDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue`: %v\n", resp) + } +- path: /access-profiles + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-profiles#create-access-profile + source: | + 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() { + accessprofile := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + }`) // AccessProfile | + + + var accessProfile beta.AccessProfile + if err := json.Unmarshal(accessprofile, &accessProfile); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessProfilesAPI.CreateAccessProfile(context.Background()).AccessProfile(accessProfile).Execute() + //resp, r, err := apiClient.Beta.AccessProfilesAPI.CreateAccessProfile(context.Background()).AccessProfile(accessProfile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.CreateAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.CreateAccessProfile`: %v\n", resp) + } +- path: /access-profiles/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-profiles#delete-access-profile + source: | + 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 := `2c91808a7813090a017814121919ecca` // string | ID of the Access Profile to delete # string | ID of the Access Profile to delete + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.AccessProfilesAPI.DeleteAccessProfile(context.Background(), id).Execute() + //r, err := apiClient.Beta.AccessProfilesAPI.DeleteAccessProfile(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.DeleteAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /access-profiles/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-profiles#delete-access-profiles-in-bulk + source: | + 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() { + accessprofilebulkdeleterequest := []byte(`{ + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + }`) // AccessProfileBulkDeleteRequest | + + + var accessProfileBulkDeleteRequest beta.AccessProfileBulkDeleteRequest + if err := json.Unmarshal(accessprofilebulkdeleterequest, &accessProfileBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessProfilesAPI.DeleteAccessProfilesInBulk(context.Background()).AccessProfileBulkDeleteRequest(accessProfileBulkDeleteRequest).Execute() + //resp, r, err := apiClient.Beta.AccessProfilesAPI.DeleteAccessProfilesInBulk(context.Background()).AccessProfileBulkDeleteRequest(accessProfileBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.DeleteAccessProfilesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccessProfilesInBulk`: AccessProfileBulkDeleteResponse + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.DeleteAccessProfilesInBulk`: %v\n", resp) + } +- path: /access-profiles/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-profiles#get-access-profile + source: | + 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 := `2c9180837ca6693d017ca8d097500149` // string | ID of the Access Profile # string | ID of the Access Profile + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessProfilesAPI.GetAccessProfile(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AccessProfilesAPI.GetAccessProfile(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.GetAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.GetAccessProfile`: %v\n", resp) + } +- path: /access-profiles/{id}/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-profiles#get-access-profile-entitlements + source: | + 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 := `2c91808a7813090a017814121919ecca` // string | ID of the access profile containing the entitlements. # string | ID of the access profile containing the entitlements. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessProfilesAPI.GetAccessProfileEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AccessProfilesAPI.GetAccessProfileEntitlements(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.GetAccessProfileEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessProfileEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.GetAccessProfileEntitlements`: %v\n", resp) + } +- path: /access-profiles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-profiles#list-access-profiles + source: | + 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() { + forSubadmin := `8c190e6787aa4ed9a90bd9d5344523fb` // string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) # string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "SailPoint Support"` // 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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessProfilesAPI.ListAccessProfiles(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccessProfilesAPI.ListAccessProfiles(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.ListAccessProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessProfiles`: []AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.ListAccessProfiles`: %v\n", resp) + } +- path: /access-profiles/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-profiles#patch-access-profile + source: | + 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 := `2c91808a7813090a017814121919ecca` // string | ID of the Access Profile to patch # string | ID of the Access Profile to patch + jsonpatchoperation := []byte(`[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]`) // []JsonPatchOperation | + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessProfilesAPI.PatchAccessProfile(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.AccessProfilesAPI.PatchAccessProfile(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.PatchAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.PatchAccessProfile`: %v\n", resp) + } +- path: /access-profiles/bulk-update-requestable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-profiles#update-access-profiles-in-bulk + source: | + 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() { + accessprofilebulkupdaterequestinner := []byte(`[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]`) // []AccessProfileBulkUpdateRequestInner | + + + var accessProfileBulkUpdateRequestInner beta.[]AccessProfileBulkUpdateRequestInner + if err := json.Unmarshal(accessprofilebulkupdaterequestinner, &accessProfileBulkUpdateRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessProfilesAPI.UpdateAccessProfilesInBulk(context.Background()).AccessProfileBulkUpdateRequestInner(accessProfileBulkUpdateRequestInner).Execute() + //resp, r, err := apiClient.Beta.AccessProfilesAPI.UpdateAccessProfilesInBulk(context.Background()).AccessProfileBulkUpdateRequestInner(accessProfileBulkUpdateRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.UpdateAccessProfilesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAccessProfilesInBulk`: []AccessProfileUpdateItem + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.UpdateAccessProfilesInBulk`: %v\n", resp) + } +- path: /access-request-approvals/{approvalId}/approve + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-request-approvals#approve-access-request + source: | + 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() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + commentdto := []byte(`{ + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + }`) // CommentDto | Reviewer's comment. + + + var commentDto beta.CommentDto + if err := json.Unmarshal(commentdto, &commentDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.ApproveAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + //resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.ApproveAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ApproveAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ApproveAccessRequest`: %v\n", resp) + } +- path: /access-request-approvals/{approvalId}/forward + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-request-approvals#forward-access-request + source: | + 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() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + forwardapprovaldto := []byte(`{ + "newOwnerId" : "newOwnerId", + "comment" : "comment" + }`) // ForwardApprovalDto | Information about the forwarded approval. + + + var forwardApprovalDto beta.ForwardApprovalDto + if err := json.Unmarshal(forwardapprovaldto, &forwardApprovalDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.ForwardAccessRequest(context.Background(), approvalId).ForwardApprovalDto(forwardApprovalDto).Execute() + //resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.ForwardAccessRequest(context.Background(), approvalId).ForwardApprovalDto(forwardApprovalDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ForwardAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ForwardAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ForwardAccessRequest`: %v\n", resp) + } +- path: /access-request-approvals/approval-summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-request-approvals#get-access-request-approval-summary + source: | + 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() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + fromDate := `from-date=2020-03-19T19:59:11Z` // string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) # string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary(context.Background()).OwnerId(ownerId).FromDate(fromDate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestApprovalSummary`: ApprovalSummary + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary`: %v\n", resp) + } +- path: /access-request-approvals/completed + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-request-approvals#list-completed-approvals + source: | + 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() { + ownerId := `ownerId_example` // string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `filters_example` // 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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + sorters := `sorters_example` // 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: **created, modified** (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: **created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.ListCompletedApprovals(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.ListCompletedApprovals(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListCompletedApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCompletedApprovals`: []CompletedApproval + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListCompletedApprovals`: %v\n", resp) + } +- path: /access-request-approvals/pending + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-request-approvals#list-pending-approvals + source: | + 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() { + ownerId := `ownerId_example` // string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `filters_example` // 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) + sorters := `sorters_example` // 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: **created, modified** (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: **created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.ListPendingApprovals(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.ListPendingApprovals(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListPendingApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPendingApprovals`: []PendingApproval + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListPendingApprovals`: %v\n", resp) + } +- path: /access-request-approvals/{approvalId}/reject + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-request-approvals#reject-access-request + source: | + 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() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + commentdto := []byte(`{ + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + }`) // CommentDto | Reviewer's comment. + + + var commentDto beta.CommentDto + if err := json.Unmarshal(commentdto, &commentDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.RejectAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + //resp, r, err := apiClient.Beta.AccessRequestApprovalsAPI.RejectAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.RejectAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.RejectAccessRequest`: %v\n", resp) + } +- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-request-identity-metrics#get-access-request-identity-metrics + source: | + 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() { + identityId := `7025c863-c270-4ba6-beea-edf3cb091573` // string | Manager's identity ID. # string | Manager's identity ID. + requestedObjectId := `2db501be-f0fb-4cc5-a695-334133c52891` // string | Requested access item's ID. # string | Requested access item's ID. + type_ := `ENTITLEMENT` // string | Requested access item's type. # string | Requested access item's type. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics(context.Background(), identityId, requestedObjectId, type_).Execute() + //resp, r, err := apiClient.Beta.AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics(context.Background(), identityId, requestedObjectId, type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestIdentityMetrics`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics`: %v\n", resp) + } +- path: /access-requests/cancel + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-requests#cancel-access-request + source: | + 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() { + cancelaccessrequest := []byte(`{ + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + }`) // CancelAccessRequest | + + + var cancelAccessRequest beta.CancelAccessRequest + if err := json.Unmarshal(cancelaccessrequest, &cancelAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestsAPI.CancelAccessRequest(context.Background()).CancelAccessRequest(cancelAccessRequest).Execute() + //resp, r, err := apiClient.Beta.AccessRequestsAPI.CancelAccessRequest(context.Background()).CancelAccessRequest(cancelAccessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CancelAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CancelAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CancelAccessRequest`: %v\n", resp) + } +- path: /access-requests/close + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-requests#close-access-request + source: | + 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() { + closeaccessrequest := []byte(`{ + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + }`) // CloseAccessRequest | + + + var closeAccessRequest beta.CloseAccessRequest + if err := json.Unmarshal(closeaccessrequest, &closeAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestsAPI.CloseAccessRequest(context.Background()).CloseAccessRequest(closeAccessRequest).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `CloseAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CloseAccessRequest`: %v\n", resp) + } +- path: /access-requests + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-requests#create-access-request + source: | + 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() { + accessrequest := []byte(`{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } ] + }`) // AccessRequest | + + + var accessRequest beta.AccessRequest + if err := json.Unmarshal(accessrequest, &accessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestsAPI.CreateAccessRequest(context.Background()).AccessRequest(accessRequest).Execute() + //resp, r, err := apiClient.Beta.AccessRequestsAPI.CreateAccessRequest(context.Background()).AccessRequest(accessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CreateAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessRequest`: AccessRequestResponse + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CreateAccessRequest`: %v\n", resp) + } +- path: /access-request-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-requests#get-access-request-config + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestsAPI.GetAccessRequestConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccessRequestsAPI.GetAccessRequestConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.GetAccessRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestConfig`: AccessRequestConfig + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.GetAccessRequestConfig`: %v\n", resp) + } +- path: /access-request-status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-requests#list-access-request-status + source: | + 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() { + requestedFor := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + assignedTo := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + count := false // bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + limit := 100 // int32 | Max number of results to return. (optional) (default to 250) # int32 | Max number of results to return. (optional) (default to 250) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + filters := `accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"` // 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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + sorters := `created` // 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: **created, modified, accountActivityItemId, name** (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: **created, modified, accountActivityItemId, name** (optional) + requestState := `request-state=EXECUTING` // string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestsAPI.ListAccessRequestStatus(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccessRequestsAPI.ListAccessRequestStatus(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).AssignedTo(assignedTo).Count(count).Limit(limit).Offset(offset).Filters(filters).Sorters(sorters).RequestState(requestState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.ListAccessRequestStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessRequestStatus`: []RequestedItemStatus + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.ListAccessRequestStatus`: %v\n", resp) + } +- path: /access-request-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/access-requests#set-access-request-config + source: | + 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() { + accessrequestconfig := []byte(`{ + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + }`) // AccessRequestConfig | + + + var accessRequestConfig beta.AccessRequestConfig + if err := json.Unmarshal(accessrequestconfig, &accessRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccessRequestsAPI.SetAccessRequestConfig(context.Background()).AccessRequestConfig(accessRequestConfig).Execute() + //resp, r, err := apiClient.Beta.AccessRequestsAPI.SetAccessRequestConfig(context.Background()).AccessRequestConfig(accessRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.SetAccessRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetAccessRequestConfig`: AccessRequestConfig + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.SetAccessRequestConfig`: %v\n", resp) + } +- path: /account-activities/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/account-activities#get-account-activity + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The account activity id # string | The account activity id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountActivitiesAPI.GetAccountActivity(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AccountActivitiesAPI.GetAccountActivity(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountActivitiesAPI.GetAccountActivity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccountActivity`: CancelableAccountActivity + fmt.Fprintf(os.Stdout, "Response from `AccountActivitiesAPI.GetAccountActivity`: %v\n", resp) + } +- path: /account-activities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/account-activities#list-account-activities + source: | + 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() { + requestedFor := `requestedFor_example` // string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `requestedBy_example` // string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `regardingIdentity_example` // string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + type_ := `type__example` // string | The type of account activity. (optional) # string | The type of account activity. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `filters_example` // 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: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (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: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + sorters := `sorters_example` // 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: **type, created, modified** (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: **type, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountActivitiesAPI.ListAccountActivities(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccountActivitiesAPI.ListAccountActivities(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).Type_(type_).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountActivitiesAPI.ListAccountActivities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccountActivities`: []CancelableAccountActivity + fmt.Fprintf(os.Stdout, "Response from `AccountActivitiesAPI.ListAccountActivities`: %v\n", resp) + } +- path: /account-aggregations/{id}/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/account-aggregations#get-account-aggregation-status + source: | + 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 := `2c91808477a6b0c60177a81146b8110b` // string | The account aggregation id # string | The account aggregation id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountAggregationsAPI.GetAccountAggregationStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `GetAccountAggregationStatus`: AccountAggregationStatus + fmt.Fprintf(os.Stdout, "Response from `AccountAggregationsAPI.GetAccountAggregationStatus`: %v\n", resp) + } +- path: /accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/accounts#create-account + source: | + 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() { + accountattributescreate := []byte(`{ + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }`) // AccountAttributesCreate | + + + var accountAttributesCreate beta.AccountAttributesCreate + if err := json.Unmarshal(accountattributescreate, &accountAttributesCreate); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.CreateAccount(context.Background()).AccountAttributesCreate(accountAttributesCreate).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.CreateAccount(context.Background()).AccountAttributesCreate(accountAttributesCreate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.CreateAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.CreateAccount`: %v\n", resp) + } +- path: /accounts/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/accounts#delete-account + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.DeleteAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.DeleteAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DeleteAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DeleteAccount`: %v\n", resp) + } +- path: /accounts/{id}/remove + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/accounts#delete-account-async + source: | + 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 := `c350d6aa4f104c61b062cb632421ad10` // string | The account id # string | The account id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.DeleteAccountAsync(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `DeleteAccountAsync`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DeleteAccountAsync`: %v\n", resp) + } +- path: /accounts/{id}/disable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/accounts#disable-account + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + accounttogglerequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }`) // AccountToggleRequest | + + + var accountToggleRequest beta.AccountToggleRequest + if err := json.Unmarshal(accounttogglerequest, &accountToggleRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.DisableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.DisableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DisableAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DisableAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccount`: %v\n", resp) + } +- path: /identities-accounts/{id}/disable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/accounts#disable-account-for-identity + source: | + 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 := `2c91808384203c2d018437e631158309` // string | The identity id. # string | The identity id. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.DisableAccountForIdentity(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `DisableAccountForIdentity`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccountForIdentity`: %v\n", resp) + } +- path: /identities-accounts/disable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/accounts#disable-accounts-for-identities + source: | + 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() { + identitiesaccountsbulkrequest := []byte(`{ + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + }`) // IdentitiesAccountsBulkRequest | + + + var identitiesAccountsBulkRequest beta.IdentitiesAccountsBulkRequest + if err := json.Unmarshal(identitiesaccountsbulkrequest, &identitiesAccountsBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.DisableAccountsForIdentities(context.Background()).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `DisableAccountsForIdentities`: []BulkIdentitiesAccountsResponse + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccountsForIdentities`: %v\n", resp) + } +- path: /accounts/{id}/enable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/accounts#enable-account + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + accounttogglerequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }`) // AccountToggleRequest | + + + var accountToggleRequest beta.AccountToggleRequest + if err := json.Unmarshal(accounttogglerequest, &accountToggleRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.EnableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.EnableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.EnableAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `EnableAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccount`: %v\n", resp) + } +- path: /identities-accounts/{id}/enable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/accounts#enable-account-for-identity + source: | + 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 := `2c91808384203c2d018437e631158309` // string | The identity id. # string | The identity id. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.EnableAccountForIdentity(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `EnableAccountForIdentity`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccountForIdentity`: %v\n", resp) + } +- path: /identities-accounts/enable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/accounts#enable-accounts-for-identities + source: | + 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() { + identitiesaccountsbulkrequest := []byte(`{ + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + }`) // IdentitiesAccountsBulkRequest | + + + var identitiesAccountsBulkRequest beta.IdentitiesAccountsBulkRequest + if err := json.Unmarshal(identitiesaccountsbulkrequest, &identitiesAccountsBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.EnableAccountsForIdentities(context.Background()).IdentitiesAccountsBulkRequest(identitiesAccountsBulkRequest).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `EnableAccountsForIdentities`: []BulkIdentitiesAccountsResponse + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccountsForIdentities`: %v\n", resp) + } +- path: /accounts/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/accounts#get-account + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.GetAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.GetAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.GetAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccount`: Account + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.GetAccount`: %v\n", resp) + } +- path: /accounts/{id}/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/accounts#get-account-entitlements + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.GetAccountEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.GetAccountEntitlements(context.Background(), id).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.GetAccountEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccountEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.GetAccountEntitlements`: %v\n", resp) + } +- path: /accounts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/accounts#list-accounts + source: | + 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() { + detailLevel := `FULL` // string | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) # string | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `identityId eq "2c9180858082150f0180893dbaf44201"` // 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (optional) + sorters := `id,name` // 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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.ListAccounts(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.ListAccounts(context.Background()).DetailLevel(detailLevel).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.ListAccounts``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccounts`: []Account + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.ListAccounts`: %v\n", resp) + } +- path: /accounts/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/accounts#put-account + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + accountattributes := []byte(`{ + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }`) // AccountAttributes | + + + var accountAttributes beta.AccountAttributes + if err := json.Unmarshal(accountattributes, &accountAttributes); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.PutAccount(context.Background(), id).AccountAttributes(accountAttributes).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.PutAccount(context.Background(), id).AccountAttributes(accountAttributes).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.PutAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.PutAccount`: %v\n", resp) + } +- path: /accounts/{id}/reload + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/accounts#submit-reload-account + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.SubmitReloadAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.SubmitReloadAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.SubmitReloadAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitReloadAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.SubmitReloadAccount`: %v\n", resp) + } +- path: /accounts/{id}/unlock + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/accounts#unlock-account + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The account ID. # string | The account ID. + accountunlockrequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + }`) // AccountUnlockRequest | + + + var accountUnlockRequest beta.AccountUnlockRequest + if err := json.Unmarshal(accountunlockrequest, &accountUnlockRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.UnlockAccount(context.Background(), id).AccountUnlockRequest(accountUnlockRequest).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.UnlockAccount(context.Background(), id).AccountUnlockRequest(accountUnlockRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.UnlockAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UnlockAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.UnlockAccount`: %v\n", resp) + } +- path: /accounts/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/accounts#update-account + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + requestbody := []byte(`{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}`) // []map[string]interface{} | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var requestBody beta.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountsAPI.UpdateAccount(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.Beta.AccountsAPI.UpdateAccount(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.UpdateAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAccount`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.UpdateAccount`: %v\n", resp) + } +- path: /account-usages/{accountId}/summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/account-usages#get-usages-by-account-id + source: | + 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() { + accountId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of IDN account # string | ID of IDN account + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `-date` // 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: **date** (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: **date** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AccountUsagesAPI.GetUsagesByAccountId(context.Background(), accountId).Execute() + //resp, r, err := apiClient.Beta.AccountUsagesAPI.GetUsagesByAccountId(context.Background(), accountId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountUsagesAPI.GetUsagesByAccountId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUsagesByAccountId`: []AccountUsage + fmt.Fprintf(os.Stdout, "Response from `AccountUsagesAPI.GetUsagesByAccountId`: %v\n", resp) + } +- path: /discovered-applications/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/application-discovery#get-discovered-application-by-id + source: | + 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 := `123e4567-e89b-12d3-a456-426655440000` // string | Discovered application's ID. # string | Discovered application's ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.ApplicationDiscoveryAPI.GetDiscoveredApplicationByID(context.Background(), id).Execute() + //r, err := apiClient.Beta.ApplicationDiscoveryAPI.GetDiscoveredApplicationByID(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetDiscoveredApplicationByID``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /discovered-applications + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/application-discovery#get-discovered-applications + source: | + 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() { + 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) + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + filter := `name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")` // 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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + sorters := `name` // 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, description, discoveredAt, discoverySource** (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, description, discoveredAt, discoverySource** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ApplicationDiscoveryAPI.GetDiscoveredApplications(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ApplicationDiscoveryAPI.GetDiscoveredApplications(context.Background()).Limit(limit).Offset(offset).Detail(detail).Filter(filter).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetDiscoveredApplications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDiscoveredApplications`: []GetDiscoveredApplications200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `ApplicationDiscoveryAPI.GetDiscoveredApplications`: %v\n", resp) + } +- path: /manual-discover-applications-template + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManualDiscoverApplicationsCsvTemplate`: ManualDiscoverApplicationsTemplate + fmt.Fprintf(os.Stdout, "Response from `ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate`: %v\n", resp) + } +- path: /discovered-applications/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/application-discovery#patch-discovered-application-by-id + source: | + 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 := `123e4567-e89b-12d3-a456-426655440000` // string | Discovered application's ID. # string | Discovered application's ID. + jsonpatchoperations := []byte(`[{op=replace, path=/dismissed, value=true}]`) // []JsonPatchOperations | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.ApplicationDiscoveryAPI.PatchDiscoveredApplicationByID(context.Background(), id).Execute() + //r, err := apiClient.Beta.ApplicationDiscoveryAPI.PatchDiscoveredApplicationByID(context.Background(), id).JsonPatchOperations(jsonPatchOperations).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.PatchDiscoveredApplicationByID``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /manual-discover-applications + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + 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() { + file := BINARY_DATA_HERE // *os.File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # *os.File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate(context.Background()).File(file).Execute() + //r, err := apiClient.Beta.ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate(context.Background()).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /generic-approvals/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/approvals#get-approval + source: | + 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 := `38453251-6be2-5f8f-df93-5ce19e295837` // string | ID of the approval that to be returned. # string | ID of the approval that to be returned. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ApprovalsAPI.GetApproval(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.ApprovalsAPI.GetApproval(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApprovalsAPI.GetApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetApproval`: Approval + fmt.Fprintf(os.Stdout, "Response from `ApprovalsAPI.GetApproval`: %v\n", resp) + } +- path: /generic-approvals + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/approvals#get-approvals + source: | + 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() { + mine := true // bool | Returns the list of approvals for the current caller. (optional) # bool | Returns the list of approvals for the current caller. (optional) + requesterId := `17e633e7d57e481569df76323169deb6a` // string | Returns the list of approvals for a given requester ID. (optional) # string | Returns the list of approvals for a given requester ID. (optional) + filters := `filters=status eq PENDING` // 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: **status**: *eq* **referenceType**: *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: **status**: *eq* **referenceType**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ApprovalsAPI.GetApprovals(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ApprovalsAPI.GetApprovals(context.Background()).Mine(mine).RequesterId(requesterId).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApprovalsAPI.GetApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetApprovals`: []Approval + fmt.Fprintf(os.Stdout, "Response from `ApprovalsAPI.GetApprovals`: %v\n", resp) + } +- path: /source-apps + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/apps#create-source-app + source: | + 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() { + sourceappcreatedto := []byte(`{ + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true + }`) // SourceAppCreateDto | + + + var sourceAppCreateDto beta.SourceAppCreateDto + if err := json.Unmarshal(sourceappcreatedto, &sourceAppCreateDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.CreateSourceApp(context.Background()).SourceAppCreateDto(sourceAppCreateDto).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.CreateSourceApp(context.Background()).SourceAppCreateDto(sourceAppCreateDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.CreateSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.CreateSourceApp`: %v\n", resp) + } +- path: /source-apps/{id}/access-profiles/bulk-remove + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/apps#delete-access-profiles-from-source-app-by-bulk + source: | + 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 := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + requestbody := []byte(``) // []string | + 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) + + + var requestBody beta.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.DeleteAccessProfilesFromSourceAppByBulk(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.DeleteAccessProfilesFromSourceAppByBulk(context.Background(), id).RequestBody(requestBody).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.DeleteAccessProfilesFromSourceAppByBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccessProfilesFromSourceAppByBulk`: []AccessProfileDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.DeleteAccessProfilesFromSourceAppByBulk`: %v\n", resp) + } +- path: /source-apps/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/apps#delete-source-app + source: | + 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 := `2c9180835d191a86015d28455b4a2329` // string | source app ID. # string | source app ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.DeleteSourceApp(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.DeleteSourceApp(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.DeleteSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.DeleteSourceApp`: %v\n", resp) + } +- path: /source-apps/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/apps#get-source-app + source: | + 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 := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.GetSourceApp(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.GetSourceApp(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.GetSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.GetSourceApp`: %v\n", resp) + } +- path: /source-apps/{id}/access-profiles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/apps#list-access-profiles-for-source-app + source: | + 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 := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + 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) + filters := `name eq "developer access profile"` // 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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.ListAccessProfilesForSourceApp(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.ListAccessProfilesForSourceApp(context.Background(), id).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAccessProfilesForSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessProfilesForSourceApp`: []AccessProfileDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAccessProfilesForSourceApp`: %v\n", resp) + } +- path: /source-apps/all + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/apps#list-all-source-app + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, owner.id, accountSource.id** (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: **id, name, created, modified, owner.id, accountSource.id** (optional) + filters := `enabled eq true` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.ListAllSourceApp(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.ListAllSourceApp(context.Background()).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAllSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAllSourceApp`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAllSourceApp`: %v\n", resp) + } +- path: /user-apps/all + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/apps#list-all-user-apps + source: | + 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() { + filters := `name eq "user app name"` // 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.AppsAPI.ListAllUserApps(context.Background()).Filters(filters).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.ListAllUserApps(context.Background()).Filters(filters).Limit(limit).Count(count).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAllUserApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAllUserApps`: []UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAllUserApps`: %v\n", resp) + } +- path: /source-apps/assigned + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/apps#list-assigned-source-app + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, accountSource.id** (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: **id, name, created, modified, accountSource.id** (optional) + filters := `name eq "source app name"` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.ListAssignedSourceApp(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.ListAssignedSourceApp(context.Background()).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAssignedSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAssignedSourceApp`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAssignedSourceApp`: %v\n", resp) + } +- path: /user-apps/{id}/available-accounts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/apps#list-available-accounts-for-user-app + source: | + 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 := `2c91808a7813090a017814121e121518` // string | ID of the user app # string | ID of the user app + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.AppsAPI.ListAvailableAccountsForUserApp(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.ListAvailableAccountsForUserApp(context.Background(), id).Limit(limit).Count(count).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAvailableAccountsForUserApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAvailableAccountsForUserApp`: []AppAccountDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAvailableAccountsForUserApp`: %v\n", resp) + } +- path: /source-apps + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/apps#list-available-source-apps + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, owner.id, accountSource.id** (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: **id, name, created, modified, owner.id, accountSource.id** (optional) + filters := `name eq "source app name"` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.ListAvailableSourceApps(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.ListAvailableSourceApps(context.Background()).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAvailableSourceApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAvailableSourceApps`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAvailableSourceApps`: %v\n", resp) + } +- path: /user-apps + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/apps#list-owned-user-apps + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + filters := `name eq "user app name"` // 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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.ListOwnedUserApps(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.ListOwnedUserApps(context.Background()).Limit(limit).Count(count).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListOwnedUserApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOwnedUserApps`: []UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListOwnedUserApps`: %v\n", resp) + } +- path: /source-apps/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/apps#patch-source-app + source: | + 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 := `2c91808a7813090a017814121e121518` // string | ID of the source app to patch # string | ID of the source app to patch + jsonpatchoperation := []byte(`[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]`) // []JsonPatchOperation | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.PatchSourceApp(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.PatchSourceApp(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.PatchSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSourceApp`: SourceAppPatchDto + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.PatchSourceApp`: %v\n", resp) + } +- path: /user-apps/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/apps#patch-user-app + source: | + 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 := `2c91808a7813090a017814121e121518` // string | ID of the user app to patch # string | ID of the user app to patch + jsonpatchoperation := []byte(``) // []JsonPatchOperation | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AppsAPI.PatchUserApp(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AppsAPI.PatchUserApp(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.PatchUserApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchUserApp`: UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.PatchUserApp`: %v\n", resp) + } +- path: /source-apps/bulk-update + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/apps#update-source-apps-in-bulk + source: | + 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() { + sourceappbulkupdaterequest := []byte(`{ + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] + }`) // SourceAppBulkUpdateRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.AppsAPI.UpdateSourceAppsInBulk(context.Background()).Execute() + //r, err := apiClient.Beta.AppsAPI.UpdateSourceAppsInBulk(context.Background()).SourceAppBulkUpdateRequest(sourceAppBulkUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.UpdateSourceAppsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /auth-profiles/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/auth-profile#get-profile-config + source: | + 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 := `2c91808a7813090a017814121919ecca` // string | ID of the Auth Profile to get. # string | ID of the Auth Profile to get. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AuthProfileAPI.GetProfileConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.AuthProfileAPI.GetProfileConfig(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.GetProfileConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProfileConfig`: AuthProfile + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.GetProfileConfig`: %v\n", resp) + } +- path: /auth-profiles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/auth-profile#get-profile-config-list + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AuthProfileAPI.GetProfileConfigList(context.Background()).Execute() + //resp, r, err := apiClient.Beta.AuthProfileAPI.GetProfileConfigList(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.GetProfileConfigList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProfileConfigList`: []AuthProfileSummary + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.GetProfileConfigList`: %v\n", resp) + } +- path: /auth-profiles/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/auth-profile#patch-profile-config + source: | + 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 := `2c91808a7813090a017814121919ecca` // string | ID of the Auth Profile to patch. # string | ID of the Auth Profile to patch. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.AuthProfileAPI.PatchProfileConfig(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.AuthProfileAPI.PatchProfileConfig(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.PatchProfileConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchProfileConfig`: AuthProfile + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.PatchProfileConfig`: %v\n", resp) + } +- path: /campaigns/{id}/complete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#complete-campaign + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | Campaign ID. # string | Campaign ID. + completecampaignoptions := []byte(`{ + "autoCompleteAction" : "REVOKE" + }`) // CompleteCampaignOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.CompleteCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.CompleteCampaign(context.Background(), id).CompleteCampaignOptions(completeCampaignOptions).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CompleteCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompleteCampaign`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CompleteCampaign`: %v\n", resp) + } +- path: /campaigns + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#create-campaign + source: | + 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() { + campaign := []byte(`{ + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }`) // Campaign | + + + var campaign beta.Campaign + if err := json.Unmarshal(campaign, &campaign); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.CreateCampaign(context.Background()).Campaign(campaign).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.CreateCampaign(context.Background()).Campaign(campaign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CreateCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaign`: Campaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CreateCampaign`: %v\n", resp) + } +- path: /campaign-templates + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#create-campaign-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + beta "github.com/sailpoint-oss/golang-sdk/v2/api_beta" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + campaigntemplate := []byte(`{ + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + }`) // CampaignTemplate | + + + var campaignTemplate beta.CampaignTemplate + if err := json.Unmarshal(campaigntemplate, &campaignTemplate); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.CreateCampaignTemplate(context.Background()).CampaignTemplate(campaignTemplate).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.CreateCampaignTemplate(context.Background()).CampaignTemplate(campaignTemplate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CreateCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CreateCampaignTemplate`: %v\n", resp) + } +- path: /campaign-templates/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#delete-campaign-template + source: | + 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 := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template being deleted. # string | ID of the campaign template being deleted. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.CertificationCampaignsAPI.DeleteCampaignTemplate(context.Background(), id).Execute() + //r, err := apiClient.Beta.CertificationCampaignsAPI.DeleteCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /campaign-templates/{id}/schedule + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#delete-campaign-template-schedule + source: | + 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 := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template whose schedule is being deleted. # string | ID of the campaign template whose schedule is being deleted. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.CertificationCampaignsAPI.DeleteCampaignTemplateSchedule(context.Background(), id).Execute() + //r, err := apiClient.Beta.CertificationCampaignsAPI.DeleteCampaignTemplateSchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /campaigns/delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#delete-campaigns + source: | + 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() { + deletecampaignsrequest := []byte(`{ + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + }`) // DeleteCampaignsRequest | IDs of the campaigns to delete. + + + var deleteCampaignsRequest beta.DeleteCampaignsRequest + if err := json.Unmarshal(deletecampaignsrequest, &deleteCampaignsRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).DeleteCampaignsRequest(deleteCampaignsRequest).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).DeleteCampaignsRequest(deleteCampaignsRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaigns``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteCampaigns`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.DeleteCampaigns`: %v\n", resp) + } +- path: /campaigns + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#get-active-campaigns + source: | + 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() { + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Manager Campaign"` // 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* **status**: *eq, in* (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* **status**: *eq, in* (optional) + sorters := `name` // 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, created** (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, created** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetActiveCampaigns(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetActiveCampaigns(context.Background()).Detail(detail).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetActiveCampaigns``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetActiveCampaigns`: []GetActiveCampaigns200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetActiveCampaigns`: %v\n", resp) + } +- path: /campaigns/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#get-campaign + source: | + 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 := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign to be retrieved. # string | ID of the campaign to be retrieved. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaign(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaign`: Slimcampaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaign`: %v\n", resp) + } +- path: /campaigns/{id}/reports + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#get-campaign-reports + source: | + 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 := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign whose reports are being fetched. # string | ID of the campaign whose reports are being fetched. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignReports(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignReports(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignReports``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignReports`: []CampaignReport + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignReports`: %v\n", resp) + } +- path: /campaigns/reports-configuration + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#get-campaign-reports-config + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignReportsConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignReportsConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignReportsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignReportsConfig`: CampaignReportsConfig + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignReportsConfig`: %v\n", resp) + } +- path: /campaign-templates/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#get-campaign-template + source: | + 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 := `2c9180835d191a86015d28455b4a2329` // string | Requested campaign template's ID. # string | Requested campaign template's ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplate`: %v\n", resp) + } +- path: /campaign-templates/{id}/schedule + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#get-campaign-template-schedule + source: | + 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 := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template whose schedule is being fetched. # string | ID of the campaign template whose schedule is being fetched. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignTemplateSchedule(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignTemplateSchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplateSchedule`: Schedule + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplateSchedule`: %v\n", resp) + } +- path: /campaign-templates + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#get-campaign-templates + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name` // 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, created, modified** (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, created, modified** (optional) + filters := `name eq "manager template"` // 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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignTemplates(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.GetCampaignTemplates(context.Background()).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplates`: []CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplates`: %v\n", resp) + } +- path: /campaigns/{id}/reassign + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#move + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The certification campaign ID # string | The certification campaign ID + adminreviewreassign := []byte(`{ + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + }`) // AdminReviewReassign | + + + var adminReviewReassign beta.AdminReviewReassign + if err := json.Unmarshal(adminreviewreassign, &adminReviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.Move(context.Background(), id).AdminReviewReassign(adminReviewReassign).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.Move(context.Background(), id).AdminReviewReassign(adminReviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.Move``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `Move`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.Move`: %v\n", resp) + } +- path: /campaign-templates/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#patch-campaign-template + source: | + 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 := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template being modified. # string | ID of the campaign template being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/campaign/filter/id, value=ff80818155fe8c080155fe8d925b0316}]`) // []JsonPatchOperation | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.PatchCampaignTemplate(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.PatchCampaignTemplate(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.PatchCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.PatchCampaignTemplate`: %v\n", resp) + } +- path: /campaigns/reports-configuration + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#set-campaign-reports-config + source: | + 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() { + campaignreportsconfig := []byte(`{ + "identityAttributeColumns" : [ "firstname", "lastname" ] + }`) // CampaignReportsConfig | Campaign report configuration. + + + var campaignReportsConfig beta.CampaignReportsConfig + if err := json.Unmarshal(campaignreportsconfig, &campaignReportsConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.SetCampaignReportsConfig(context.Background()).CampaignReportsConfig(campaignReportsConfig).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.SetCampaignReportsConfig(context.Background()).CampaignReportsConfig(campaignReportsConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.SetCampaignReportsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetCampaignReportsConfig`: CampaignReportsConfig + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.SetCampaignReportsConfig`: %v\n", resp) + } +- path: /campaign-templates/{id}/schedule + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#set-campaign-template-schedule + source: | + 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 := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template being scheduled. # string | ID of the campaign template being scheduled. + schedule := []byte(`{ + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + }`) // Schedule | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.CertificationCampaignsAPI.SetCampaignTemplateSchedule(context.Background(), id).Execute() + //r, err := apiClient.Beta.CertificationCampaignsAPI.SetCampaignTemplateSchedule(context.Background(), id).Schedule(schedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.SetCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /campaigns/{id}/activate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#start-campaign + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | Campaign ID. # string | Campaign ID. + activatecampaignoptions := []byte(`{ + "timeZone" : "-05:00" + }`) // ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.StartCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.StartCampaign(context.Background(), id).ActivateCampaignOptions(activateCampaignOptions).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaign`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaign`: %v\n", resp) + } +- path: /campaigns/{id}/run-remediation-scan + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#start-campaign-remediation-scan + source: | + 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 := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign the remediation scan is being run for. # string | ID of the campaign the remediation scan is being run for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.StartCampaignRemediationScan(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.StartCampaignRemediationScan(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaignRemediationScan``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaignRemediationScan`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaignRemediationScan`: %v\n", resp) + } +- path: /campaigns/{id}/run-report/{type} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#start-campaign-report + source: | + 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 := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign the report is being run for. # string | ID of the campaign the report is being run for. + type_ := // ReportType | Type of report to run. # ReportType | Type of report to run. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.StartCampaignReport(context.Background(), id, type_).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.StartCampaignReport(context.Background(), id, type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaignReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaignReport`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaignReport`: %v\n", resp) + } +- path: /campaign-templates/{id}/generate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#start-generate-campaign-template + source: | + 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 := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template to use for generation. # string | ID of the campaign template to use for generation. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.StartGenerateCampaignTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.StartGenerateCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartGenerateCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartGenerateCampaignTemplate`: CampaignReference + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartGenerateCampaignTemplate`: %v\n", resp) + } +- path: /campaigns/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certification-campaigns#update-campaign + source: | + 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 := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign being modified. # string | ID of the campaign being modified. + requestbody := []byte(`[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]`) // []map[string]interface{} | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + + + var requestBody beta.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationCampaignsAPI.UpdateCampaign(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.Beta.CertificationCampaignsAPI.UpdateCampaign(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.UpdateCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCampaign`: Slimcampaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.UpdateCampaign`: %v\n", resp) + } +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certifications#get-identity-certification-item-permissions + source: | + 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() { + certificationId := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification ID + itemId := `2c91808671bcbab40171bd945d961227` // string | The certification item ID # string | The certification item ID + filters := `target eq "SYS.OBJAUTH2"` // 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: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (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: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationsAPI.GetIdentityCertificationItemPermissions(context.Background(), certificationId, itemId).Execute() + //resp, r, err := apiClient.Beta.CertificationsAPI.GetIdentityCertificationItemPermissions(context.Background(), certificationId, itemId).Filters(filters).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertificationItemPermissions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertificationItemPermissions`: []PermissionDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertificationItemPermissions`: %v\n", resp) + } +- path: /certifications/{id}/tasks-pending + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certifications#get-identity-certification-pending-tasks + source: | + 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 | The identity campaign certification ID # string | The identity campaign certification ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationsAPI.GetIdentityCertificationPendingTasks(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationsAPI.GetIdentityCertificationPendingTasks(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertificationPendingTasks``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertificationPendingTasks`: []IdentityCertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertificationPendingTasks`: %v\n", resp) + } +- path: /certifications/{id}/tasks/{taskId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certifications#get-identity-certification-task-status + source: | + 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 | The identity campaign certification ID # string | The identity campaign certification ID + taskId := `taskId_example` // string | The certification task ID # string | The certification task ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationsAPI.GetIdentityCertificationTaskStatus(context.Background(), id, taskId).Execute() + //resp, r, err := apiClient.Beta.CertificationsAPI.GetIdentityCertificationTaskStatus(context.Background(), id, taskId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertificationTaskStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertificationTaskStatus`: IdentityCertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertificationTaskStatus`: %v\n", resp) + } +- path: /certifications/{id}/reviewers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certifications#list-certification-reviewers + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Bob"` // 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* **email**: *eq, sw* (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* **email**: *eq, sw* (optional) + sorters := `name` // 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, email** (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, email** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationsAPI.ListCertificationReviewers(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.CertificationsAPI.ListCertificationReviewers(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListCertificationReviewers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCertificationReviewers`: []IdentityReferenceWithNameAndEmail + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListCertificationReviewers`: %v\n", resp) + } +- path: /certifications + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certifications#list-certifications + source: | + 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() { + reviewerIdentitiy := `reviewerIdentitiy_example` // string | The ID of reviewer identity. *me* indicates the current user. (optional) # string | The ID of reviewer identity. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `filters_example` // 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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (optional) + sorters := `sorters_example` // 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, due, signed** (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, due, signed** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationsAPI.ListCertifications(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CertificationsAPI.ListCertifications(context.Background()).ReviewerIdentitiy(reviewerIdentitiy).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListCertifications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCertifications`: []CertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListCertifications`: %v\n", resp) + } +- path: /certifications/{id}/reassign-async + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/certifications#submit-reassign-certs-async + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + reviewreassign := []byte(`{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + }`) // ReviewReassign | + + + var reviewReassign beta.ReviewReassign + if err := json.Unmarshal(reviewreassign, &reviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CertificationsAPI.SubmitReassignCertsAsync(context.Background(), id).ReviewReassign(reviewReassign).Execute() + //resp, r, err := apiClient.Beta.CertificationsAPI.SubmitReassignCertsAsync(context.Background(), id).ReviewReassign(reviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.SubmitReassignCertsAsync``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitReassignCertsAsync`: IdentityCertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.SubmitReassignCertsAsync`: %v\n", resp) + } +- path: /connector-rules + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/connector-rule-management#create-connector-rule + source: | + 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() { + connectorrulecreaterequest := []byte(`{ + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "type" : "BuildMap" + }`) // ConnectorRuleCreateRequest | The connector rule to create + + + var connectorRuleCreateRequest beta.ConnectorRuleCreateRequest + if err := json.Unmarshal(connectorrulecreaterequest, &connectorRuleCreateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.CreateConnectorRule(context.Background()).ConnectorRuleCreateRequest(connectorRuleCreateRequest).Execute() + //resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.CreateConnectorRule(context.Background()).ConnectorRuleCreateRequest(connectorRuleCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.CreateConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.CreateConnectorRule`: %v\n", resp) + } +- path: /connector-rules/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/connector-rule-management#delete-connector-rule + source: | + 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to delete # string | ID of the connector rule to delete + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.ConnectorRuleManagementAPI.DeleteConnectorRule(context.Background(), id).Execute() + //r, err := apiClient.Beta.ConnectorRuleManagementAPI.DeleteConnectorRule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.DeleteConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /connector-rules/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/connector-rule-management#get-connector-rule + source: | + 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to retrieve # string | ID of the connector rule to retrieve + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.GetConnectorRule(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.GetConnectorRule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.GetConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.GetConnectorRule`: %v\n", resp) + } +- path: /connector-rules + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/connector-rule-management#get-connector-rule-list + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.GetConnectorRuleList(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.GetConnectorRuleList(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.GetConnectorRuleList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorRuleList`: []ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.GetConnectorRuleList`: %v\n", resp) + } +- path: /connector-rules/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/connector-rule-management#update-connector-rule + source: | + 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to update # string | ID of the connector rule to update + connectorruleupdaterequest := []byte(`{ + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", + "type" : "BuildMap" + }`) // ConnectorRuleUpdateRequest | The connector rule with updated data (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.UpdateConnectorRule(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.UpdateConnectorRule(context.Background(), id).ConnectorRuleUpdateRequest(connectorRuleUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.UpdateConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.UpdateConnectorRule`: %v\n", resp) + } +- path: /connector-rules/validate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/connector-rule-management#validate-connector-rule + source: | + 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() { + sourcecode := []byte(`{ + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }`) // SourceCode | The code to validate + + + var sourceCode beta.SourceCode + if err := json.Unmarshal(sourcecode, &sourceCode); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.ValidateConnectorRule(context.Background()).SourceCode(sourceCode).Execute() + //resp, r, err := apiClient.Beta.ConnectorRuleManagementAPI.ValidateConnectorRule(context.Background()).SourceCode(sourceCode).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.ValidateConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ValidateConnectorRule`: ConnectorRuleValidationResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.ValidateConnectorRule`: %v\n", resp) + } +- path: /connectors + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/connectors#get-connector-list + source: | + 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() { + filters := `directConnect eq "true"` // 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: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* (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: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ConnectorsAPI.GetConnectorList(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ConnectorsAPI.GetConnectorList(context.Background()).Filters(filters).Limit(limit).Offset(offset).Count(count).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorList`: []V3ConnectorDto + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorList`: %v\n", resp) + } +- path: /form-definitions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#create-form-definition + source: | + 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() { + createformdefinitionrequest := []byte(`{ + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + }`) // CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormDefinition(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormDefinition(context.Background()).CreateFormDefinitionRequest(createFormDefinitionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinition`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinition`: %v\n", resp) + } +- path: /form-definitions/template + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#create-form-definition-by-template + source: | + 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() { + createformdefinitionrequest := []byte(`{ + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + }`) // CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormDefinitionByTemplate(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormDefinitionByTemplate(context.Background()).CreateFormDefinitionRequest(createFormDefinitionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinitionByTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinitionByTemplate`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinitionByTemplate`: %v\n", resp) + } +- path: /form-definitions/forms-action-dynamic-schema + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#create-form-definition-dynamic-schema + source: | + 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() { + body := []byte(`{ + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 + }`) // FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormDefinitionDynamicSchema(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormDefinitionDynamicSchema(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinitionDynamicSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinitionDynamicSchema`: FormDefinitionDynamicSchemaResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinitionDynamicSchema`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID}/upload + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#create-form-definition-file-request + source: | + 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() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | FormDefinitionID String specifying FormDefinitionID # string | FormDefinitionID String specifying FormDefinitionID + file := BINARY_DATA_HERE // *os.File | File specifying the multipart # *os.File | File specifying the multipart + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormDefinitionFileRequest(context.Background(), formDefinitionID).File(file).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormDefinitionFileRequest(context.Background(), formDefinitionID).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinitionFileRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinitionFileRequest`: FormDefinitionFileUploadResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinitionFileRequest`: %v\n", resp) + } +- path: /form-instances + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#create-form-instance + source: | + 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() { + body := []byte(`{ + "formInput" : { + "input1" : "Sales" + }, + "standAloneForm" : false, + "createdBy" : { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "WORKFLOW_EXECUTION" + }, + "recipients" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + } ], + "expire" : "2023-08-12T20:14:57.74486Z", + "formDefinitionId" : "00000000-0000-0000-0000-000000000000", + "state" : "ASSIGNED", + "ttl" : 1571827560 + }`) // CreateFormInstanceRequest | Body is the request payload to create a form instance (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormInstance(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.CreateFormInstance(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormInstance`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormInstance`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#delete-form-definition + source: | + 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() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.DeleteFormDefinition(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.DeleteFormDefinition(context.Background(), formDefinitionID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.DeleteFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteFormDefinition`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.DeleteFormDefinition`: %v\n", resp) + } +- path: /form-definitions/export + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#export-form-definitions-by-tenant + source: | + 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() { + offset := 0 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `name sw "my form"` // 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + sorters := `name` // 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, description, created, modified** (optional) (default to "name") # 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, description, created, modified** (optional) (default to "name") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.ExportFormDefinitionsByTenant(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.ExportFormDefinitionsByTenant(context.Background()).Offset(offset).Limit(limit).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ExportFormDefinitionsByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportFormDefinitionsByTenant`: []ExportFormDefinitionsByTenant200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ExportFormDefinitionsByTenant`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID}/file/{fileID} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#get-file-from-s3 + source: | + 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() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | FormDefinitionID Form definition ID # string | FormDefinitionID Form definition ID + fileID := `00000031N0J7R2B57M8YG73J7M.png` // string | FileID String specifying the hashed name of the uploaded file we are retrieving. # string | FileID String specifying the hashed name of the uploaded file we are retrieving. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.GetFileFromS3(context.Background(), formDefinitionID, fileID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.GetFileFromS3(context.Background(), formDefinitionID, fileID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFileFromS3``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFileFromS3`: *os.File + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFileFromS3`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#get-form-definition-by-key + source: | + 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() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.GetFormDefinitionByKey(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.GetFormDefinitionByKey(context.Background(), formDefinitionID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormDefinitionByKey``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormDefinitionByKey`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormDefinitionByKey`: %v\n", resp) + } +- path: /form-instances/{formInstanceID} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#get-form-instance-by-key + source: | + 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() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.GetFormInstanceByKey(context.Background(), formInstanceID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.GetFormInstanceByKey(context.Background(), formInstanceID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormInstanceByKey``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormInstanceByKey`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormInstanceByKey`: %v\n", resp) + } +- path: /form-instances/{formInstanceID}/file/{fileID} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#get-form-instance-file + source: | + 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() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | FormInstanceID Form instance ID # string | FormInstanceID Form instance ID + fileID := `00000031N0J7R2B57M8YG73J7M.png` // string | FileID String specifying the hashed name of the uploaded file we are retrieving. # string | FileID String specifying the hashed name of the uploaded file we are retrieving. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.GetFormInstanceFile(context.Background(), formInstanceID, fileID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.GetFormInstanceFile(context.Background(), formInstanceID, fileID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormInstanceFile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormInstanceFile`: *os.File + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormInstanceFile`: %v\n", resp) + } +- path: /form-definitions/import + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#import-form-definitions + source: | + 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() { + body := []byte(`[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]`) // []ImportFormDefinitionsRequestInner | Body is the request payload to import form definitions (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.ImportFormDefinitions(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.ImportFormDefinitions(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ImportFormDefinitions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportFormDefinitions`: ImportFormDefinitions202Response + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ImportFormDefinitions`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#patch-form-definition + source: | + 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() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + body := []byte(`[{op=replace, path=/description, value=test-description}]`) // []map[string]map[string]interface{} | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.PatchFormDefinition(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.PatchFormDefinition(context.Background(), formDefinitionID).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.PatchFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchFormDefinition`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.PatchFormDefinition`: %v\n", resp) + } +- path: /form-instances/{formInstanceID} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#patch-form-instance + source: | + 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() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + body := []byte(`[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]`) // []map[string]map[string]interface{} | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.PatchFormInstance(context.Background(), formInstanceID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.PatchFormInstance(context.Background(), formInstanceID).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.PatchFormInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchFormInstance`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.PatchFormInstance`: %v\n", resp) + } +- path: /form-definitions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#search-form-definitions-by-tenant + source: | + 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() { + offset := 250 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `name sw "my form"` // 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + sorters := `name` // 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, description, created, modified** (optional) (default to "name") # 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, description, created, modified** (optional) (default to "name") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.SearchFormDefinitionsByTenant(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.SearchFormDefinitionsByTenant(context.Background()).Offset(offset).Limit(limit).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormDefinitionsByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormDefinitionsByTenant`: ListFormDefinitionsByTenantResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormDefinitionsByTenant`: %v\n", resp) + } +- path: /form-instances/{formInstanceID}/data-source/{formElementID} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#search-form-element-data-by-element-id + source: | + 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() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + formElementID := `1` // string | Form element ID # string | Form element ID + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `value eq "ID01"` // 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) + query := `support` // string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.SearchFormElementDataByElementID(context.Background(), formInstanceID, formElementID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.SearchFormElementDataByElementID(context.Background(), formInstanceID, formElementID).Limit(limit).Filters(filters).Query(query).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormElementDataByElementID``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormElementDataByElementID`: ListFormElementDataByElementIDResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormElementDataByElementID`: %v\n", resp) + } +- path: /form-instances + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#search-form-instances-by-tenant + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.SearchFormInstancesByTenant(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.SearchFormInstancesByTenant(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormInstancesByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormInstancesByTenant`: []FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormInstancesByTenant`: %v\n", resp) + } +- path: /form-definitions/predefined-select-options + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#search-pre-defined-select-options + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.SearchPreDefinedSelectOptions(context.Background()).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.SearchPreDefinedSelectOptions(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchPreDefinedSelectOptions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchPreDefinedSelectOptions`: ListPredefinedSelectOptionsResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchPreDefinedSelectOptions`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID}/data-source + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-forms#show-preview-data-source + source: | + 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() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + limit := 10 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) + filters := `value eq "ID01"` // 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) + query := `ac` // string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) + formelementpreviewrequest := []byte(`{ + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } + }`) // FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomFormsAPI.ShowPreviewDataSource(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.Beta.CustomFormsAPI.ShowPreviewDataSource(context.Background(), formDefinitionID).Limit(limit).Filters(filters).Query(query).FormElementPreviewRequest(formElementPreviewRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ShowPreviewDataSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ShowPreviewDataSource`: PreviewDataSourceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ShowPreviewDataSource`: %v\n", resp) + } +- path: /custom-password-instructions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-password-instructions#create-custom-password-instructions + source: | + 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() { + custompasswordinstruction := []byte(`{ + "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", + "pageId" : "change-password:enter-password", + "locale" : "en" + }`) // CustomPasswordInstruction | + + + var customPasswordInstruction beta.CustomPasswordInstruction + if err := json.Unmarshal(custompasswordinstruction, &customPasswordInstruction); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions(context.Background()).CustomPasswordInstruction(customPasswordInstruction).Execute() + //resp, r, err := apiClient.Beta.CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions(context.Background()).CustomPasswordInstruction(customPasswordInstruction).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCustomPasswordInstructions`: CustomPasswordInstruction + fmt.Fprintf(os.Stdout, "Response from `CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions`: %v\n", resp) + } +- path: /custom-password-instructions/{pageId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-password-instructions#delete-custom-password-instructions + source: | + 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() { + pageId := `mfa:select` // string | The page ID of custom password instructions to delete. # string | The page ID of custom password instructions to delete. + locale := `locale_example` // string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions(context.Background(), pageId).Execute() + //r, err := apiClient.Beta.CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions(context.Background(), pageId).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /custom-password-instructions/{pageId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/custom-password-instructions#get-custom-password-instructions + source: | + 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() { + pageId := `mfa:select` // string | The page ID of custom password instructions to query. # string | The page ID of custom password instructions to query. + locale := `locale_example` // string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.CustomPasswordInstructionsAPI.GetCustomPasswordInstructions(context.Background(), pageId).Execute() + //resp, r, err := apiClient.Beta.CustomPasswordInstructionsAPI.GetCustomPasswordInstructions(context.Background(), pageId).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.GetCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCustomPasswordInstructions`: CustomPasswordInstruction + fmt.Fprintf(os.Stdout, "Response from `CustomPasswordInstructionsAPI.GetCustomPasswordInstructions`: %v\n", resp) + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/entitlements#create-access-model-metadata-for-entitlement + source: | + 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 := `2c91808c74ff913f0175097daa9d59cd` // string | The entitlement id. # string | The entitlement id. + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.CreateAccessModelMetadataForEntitlement(context.Background(), id, attributeKey, attributeValue).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.CreateAccessModelMetadataForEntitlement(context.Background(), id, attributeKey, attributeValue).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.CreateAccessModelMetadataForEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessModelMetadataForEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.CreateAccessModelMetadataForEntitlement`: %v\n", resp) + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/entitlements#delete-access-model-metadata-from-entitlement + source: | + 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 := `2c91808c74ff913f0175097daa9d59cd` // string | The entitlement id. # string | The entitlement id. + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement(context.Background(), id, attributeKey, attributeValue).Execute() + //r, err := apiClient.Beta.EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement(context.Background(), id, attributeKey, attributeValue).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /entitlements/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/entitlements#get-entitlement + source: | + 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 := `2c91808874ff91550175097daaec161c` // string | The entitlement ID # string | The entitlement ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.GetEntitlement(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.GetEntitlement(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.GetEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.GetEntitlement`: %v\n", resp) + } +- path: /entitlements/{id}/entitlement-request-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/entitlements#get-entitlement-request-config + source: | + 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 := `2c91808874ff91550175097daaec161c` // string | Entitlement Id # string | Entitlement Id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.GetEntitlementRequestConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.GetEntitlementRequestConfig(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.GetEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementRequestConfig`: EntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.GetEntitlementRequestConfig`: %v\n", resp) + } +- path: /entitlements/aggregate/sources/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/entitlements#import-entitlements-by-source + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | Source Id # string | Source Id + csvFile := 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.Beta.EntitlementsAPI.ImportEntitlementsBySource(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.ImportEntitlementsBySource(context.Background(), id).CsvFile(csvFile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ImportEntitlementsBySource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportEntitlementsBySource`: LoadEntitlementTask + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ImportEntitlementsBySource`: %v\n", resp) + } +- path: /entitlements/{id}/children + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/entitlements#list-entitlement-children + source: | + 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 := `2c91808874ff91550175097daaec161c` // string | Entitlement Id # string | Entitlement 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id** (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: **id, name, created, modified, type, attribute, value, source.id** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.ListEntitlementChildren(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.ListEntitlementChildren(context.Background(), id).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlementChildren``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlementChildren`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlementChildren`: %v\n", resp) + } +- path: /entitlements/{id}/parents + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/entitlements#list-entitlement-parents + source: | + 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 := `2c91808c74ff913f0175097daa9d59cd` // string | Entitlement Id # string | Entitlement 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id** (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: **id, name, created, modified, type, attribute, value, source.id** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.ListEntitlementParents(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.ListEntitlementParents(context.Background(), id).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlementParents``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlementParents`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlementParents`: %v\n", resp) + } +- path: /entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/entitlements#list-entitlements + source: | + 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() { + accountId := `ef38f94347e94562b5bb8424a56397d8` // string | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional) # string | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional) + segmentedForIdentity := `me` // string | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) # string | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) + forSegmentIds := `041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649` // string | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) # string | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) + includeUnsegmented := true // bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to true) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id, requestable** (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: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.ListEntitlements(context.Background()).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.ListEntitlements(context.Background()).AccountId(accountId).SegmentedForIdentity(segmentedForIdentity).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlements`: %v\n", resp) + } +- path: /entitlements/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/entitlements#patch-entitlement + source: | + 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 := `2c91808a7813090a017814121e121518` // string | ID of the entitlement to patch # string | ID of the entitlement to patch + jsonpatchoperation := []byte(`[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]`) // []JsonPatchOperation | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.PatchEntitlement(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.PatchEntitlement(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.PatchEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.PatchEntitlement`: %v\n", resp) + } +- path: /entitlements/{id}/entitlement-request-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/entitlements#put-entitlement-request-config + source: | + 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 := `2c91808a7813090a017814121e121518` // string | Entitlement ID # string | Entitlement ID + entitlementrequestconfig := []byte(`{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }`) // EntitlementRequestConfig | + + + var entitlementRequestConfig beta.EntitlementRequestConfig + if err := json.Unmarshal(entitlementrequestconfig, &entitlementRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.PutEntitlementRequestConfig(context.Background(), id).EntitlementRequestConfig(entitlementRequestConfig).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.PutEntitlementRequestConfig(context.Background(), id).EntitlementRequestConfig(entitlementRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.PutEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutEntitlementRequestConfig`: EntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.PutEntitlementRequestConfig`: %v\n", resp) + } +- path: /entitlements/reset/sources/{sourceId} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/entitlements#reset-source-entitlements + source: | + 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() { + sourceId := `2c91808a7813090a017814121919ecca` // string | ID of source for the entitlement reset # string | ID of source for the entitlement reset + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.EntitlementsAPI.ResetSourceEntitlements(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.EntitlementsAPI.ResetSourceEntitlements(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ResetSourceEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ResetSourceEntitlements`: EntitlementSourceResetBaseReferenceDto + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ResetSourceEntitlements`: %v\n", resp) + } +- path: /entitlements/bulk-update + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/entitlements#update-entitlements-in-bulk + source: | + 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() { + entitlementbulkupdaterequest := []byte(`{ + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] + }`) // EntitlementBulkUpdateRequest | + + + var entitlementBulkUpdateRequest beta.EntitlementBulkUpdateRequest + if err := json.Unmarshal(entitlementbulkupdaterequest, &entitlementBulkUpdateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.EntitlementsAPI.UpdateEntitlementsInBulk(context.Background()).EntitlementBulkUpdateRequest(entitlementBulkUpdateRequest).Execute() + //r, err := apiClient.Beta.EntitlementsAPI.UpdateEntitlementsInBulk(context.Background()).EntitlementBulkUpdateRequest(entitlementBulkUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.UpdateEntitlementsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /workgroups + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/governance-groups#create-workgroup + source: | + 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() { + workgroupdto := []byte(`{ + "owner" : { + "emailAddress" : "support@sailpoint.com", + "displayName" : "Support", + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "connectionCount" : 1641498673000, + "created" : "2022-01-06T19:51:13Z", + "memberCount" : 1641498673000, + "name" : "DB Access Governance Group", + "description" : "Description of the Governance Group", + "modified" : "2022-01-06T19:51:13Z", + "id" : "2c91808568c529c60168cca6f90c1313" + }`) // WorkgroupDto | + + + var workgroupDto beta.WorkgroupDto + if err := json.Unmarshal(workgroupdto, &workgroupDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.CreateWorkgroup(context.Background()).WorkgroupDto(workgroupDto).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.CreateWorkgroup(context.Background()).WorkgroupDto(workgroupDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.CreateWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.CreateWorkgroup`: %v\n", resp) + } +- path: /workgroups/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/governance-groups#delete-workgroup + source: | + 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 := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.GovernanceGroupsAPI.DeleteWorkgroup(context.Background(), id).Execute() + //r, err := apiClient.Beta.GovernanceGroupsAPI.DeleteWorkgroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /workgroups/{workgroupId}/members/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/governance-groups#delete-workgroup-members + source: | + 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() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + bulkworkgroupmembersrequestinner := []byte(``) // []BulkWorkgroupMembersRequestInner | List of identities to be removed from a Governance Group members list. + + + var bulkWorkgroupMembersRequestInner beta.[]BulkWorkgroupMembersRequestInner + if err := json.Unmarshal(bulkworkgroupmembersrequestinner, &bulkWorkgroupMembersRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.DeleteWorkgroupMembers(context.Background(), workgroupId).BulkWorkgroupMembersRequestInner(bulkWorkgroupMembersRequestInner).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.DeleteWorkgroupMembers(context.Background(), workgroupId).BulkWorkgroupMembersRequestInner(bulkWorkgroupMembersRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteWorkgroupMembers`: []WorkgroupMemberDeleteItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.DeleteWorkgroupMembers`: %v\n", resp) + } +- path: /workgroups/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/governance-groups#delete-workgroups-in-bulk + source: | + 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() { + workgroupbulkdeleterequest := []byte(`{ + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + }`) // WorkgroupBulkDeleteRequest | + + + var workgroupBulkDeleteRequest beta.WorkgroupBulkDeleteRequest + if err := json.Unmarshal(workgroupbulkdeleterequest, &workgroupBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.DeleteWorkgroupsInBulk(context.Background()).WorkgroupBulkDeleteRequest(workgroupBulkDeleteRequest).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.DeleteWorkgroupsInBulk(context.Background()).WorkgroupBulkDeleteRequest(workgroupBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroupsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteWorkgroupsInBulk`: []WorkgroupDeleteItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.DeleteWorkgroupsInBulk`: %v\n", resp) + } +- path: /workgroups/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/governance-groups#get-workgroup + source: | + 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 := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.GetWorkgroup(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.GetWorkgroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.GetWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.GetWorkgroup`: %v\n", resp) + } +- path: /workgroups/{workgroupId}/connections + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/governance-groups#list-connections + source: | + 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() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.ListConnections(context.Background(), workgroupId).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.ListConnections(context.Background(), workgroupId).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListConnections``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListConnections`: []WorkgroupConnectionDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListConnections`: %v\n", resp) + } +- path: /workgroups/{workgroupId}/members + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/governance-groups#list-workgroup-members + source: | + 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() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.ListWorkgroupMembers(context.Background(), workgroupId).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.ListWorkgroupMembers(context.Background(), workgroupId).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkgroupMembers`: []ListWorkgroupMembers200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListWorkgroupMembers`: %v\n", resp) + } +- path: /workgroups + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/governance-groups#list-workgroups + source: | + 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() { + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw "Test"` // 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, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (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, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) + sorters := `name,-modified` // 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, created, modified, id, description** (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, created, modified, id, description** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.ListWorkgroups(context.Background()).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.ListWorkgroups(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListWorkgroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkgroups`: []WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListWorkgroups`: %v\n", resp) + } +- path: /workgroups/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/governance-groups#patch-workgroup + source: | + 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 := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Governance Group new description.}]`) // []JsonPatchOperation | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.PatchWorkgroup(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.PatchWorkgroup(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.PatchWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.PatchWorkgroup`: %v\n", resp) + } +- path: /workgroups/{workgroupId}/members/bulk-add + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/governance-groups#update-workgroup-members + source: | + 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() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + bulkworkgroupmembersrequestinner := []byte(``) // []BulkWorkgroupMembersRequestInner | List of identities to be added to a Governance Group members list. + + + var bulkWorkgroupMembersRequestInner beta.[]BulkWorkgroupMembersRequestInner + if err := json.Unmarshal(bulkworkgroupmembersrequestinner, &bulkWorkgroupMembersRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.GovernanceGroupsAPI.UpdateWorkgroupMembers(context.Background(), workgroupId).BulkWorkgroupMembersRequestInner(bulkWorkgroupMembersRequestInner).Execute() + //resp, r, err := apiClient.Beta.GovernanceGroupsAPI.UpdateWorkgroupMembers(context.Background(), workgroupId).BulkWorkgroupMembersRequestInner(bulkWorkgroupMembersRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.UpdateWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateWorkgroupMembers`: []WorkgroupMemberAddItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.UpdateWorkgroupMembers`: %v\n", resp) + } +- path: /ai-access-request-recommendations/ignored-items + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item + source: | + 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() { + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity. + + + var accessRequestRecommendationActionItemDto beta.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem(context.Background()).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem(context.Background()).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsIgnoredItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem`: %v\n", resp) + } +- path: /ai-access-request-recommendations/requested-items + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item + source: | + 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() { + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity. + + + var accessRequestRecommendationActionItemDto beta.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem(context.Background()).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem(context.Background()).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsRequestedItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem`: %v\n", resp) + } +- path: /ai-access-request-recommendations/viewed-items + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item + source: | + 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() { + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity. + + + var accessRequestRecommendationActionItemDto beta.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem(context.Background()).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem(context.Background()).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsViewedItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem`: %v\n", resp) + } +- path: /ai-access-request-recommendations/viewed-items/bulk-create + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items + source: | + 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() { + accessrequestrecommendationactionitemdto := []byte(``) // []AccessRequestRecommendationActionItemDto | The recommended access items that were viewed for an identity. + + + var accessRequestRecommendationActionItemDto beta.[]AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems(context.Background()).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems(context.Background()).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsViewedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems`: %v\n", resp) + } +- path: /ai-access-request-recommendations + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-access-request-recommendations#get-access-request-recommendations + source: | + 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() { + identityId := `2c91808570313110017040b06f344ec9` // string | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") # string | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") + limit := 15 // int32 | Max number of results to return. (optional) (default to 15) # int32 | Max number of results to return. (optional) (default to 15) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + includeTranslationMessages := false // bool | If *true* it will populate a list of translation messages in the response. (optional) (default to false) # bool | If *true* it will populate a list of translation messages in the response. (optional) (default to false) + filters := `access.name co "admin"` // 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) + sorters := `access.name` // 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations(context.Background()).IdentityId(identityId).Limit(limit).Offset(offset).Count(count).IncludeTranslationMessages(includeTranslationMessages).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendations`: []AccessRequestRecommendationItemDetail + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations`: %v\n", resp) + } +- path: /ai-access-request-recommendations/ignored-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `identityId eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsIgnoredItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems`: %v\n", resp) + } +- path: /ai-access-request-recommendations/requested-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsRequestedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems`: %v\n", resp) + } +- path: /ai-access-request-recommendations/viewed-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsViewedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems`: %v\n", resp) + } +- path: /common-access + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-common-access#create-common-access + source: | + 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() { + commonaccessitemrequest := []byte(`{ + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" + }`) // CommonAccessItemRequest | + + + var commonAccessItemRequest beta.CommonAccessItemRequest + if err := json.Unmarshal(commonaccessitemrequest, &commonAccessItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAICommonAccessAPI.CreateCommonAccess(context.Background()).CommonAccessItemRequest(commonAccessItemRequest).Execute() + //resp, r, err := apiClient.Beta.IAICommonAccessAPI.CreateCommonAccess(context.Background()).CommonAccessItemRequest(commonAccessItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.CreateCommonAccess``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCommonAccess`: CommonAccessItemResponse + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.CreateCommonAccess`: %v\n", resp) + } +- path: /common-access + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-common-access#get-common-access + source: | + 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() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.type eq "ROLE"` // 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) + sorters := `access.name` // 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: **access.name, status** By default the common access items are sorted by name, ascending. (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: **access.name, status** By default the common access items are sorted by name, ascending. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAICommonAccessAPI.GetCommonAccess(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAICommonAccessAPI.GetCommonAccess(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.GetCommonAccess``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCommonAccess`: []CommonAccessResponse + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.GetCommonAccess`: %v\n", resp) + } +- path: /common-access/update-status + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-common-access#update-common-access-status-in-bulk + source: | + 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() { + commonaccessidstatus := []byte(``) // []CommonAccessIDStatus | Confirm or deny in bulk the common access ids that are (or aren't) common access + + + var commonAccessIDStatus beta.[]CommonAccessIDStatus + if err := json.Unmarshal(commonaccessidstatus, &commonAccessIDStatus); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAICommonAccessAPI.UpdateCommonAccessStatusInBulk(context.Background()).CommonAccessIDStatus(commonAccessIDStatus).Execute() + //resp, r, err := apiClient.Beta.IAICommonAccessAPI.UpdateCommonAccessStatusInBulk(context.Background()).CommonAccessIDStatus(commonAccessIDStatus).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.UpdateCommonAccessStatusInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCommonAccessStatusInBulk`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.UpdateCommonAccessStatusInBulk`: %v\n", resp) + } +- path: /translation-catalogs/{catalog-id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-message-catalogs#get-message-catalogs + source: | + 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() { + catalogId := `recommender` // string | The ID of the message catalog. # string | The ID of the message catalog. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIMessageCatalogsAPI.GetMessageCatalogs(context.Background(), catalogId).Execute() + //resp, r, err := apiClient.Beta.IAIMessageCatalogsAPI.GetMessageCatalogs(context.Background(), catalogId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIMessageCatalogsAPI.GetMessageCatalogs``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMessageCatalogs`: []MessageCatalogDto + fmt.Fprintf(os.Stdout, "Response from `IAIMessageCatalogsAPI.GetMessageCatalogs`: %v\n", resp) + } +- path: /outliers/export + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-outliers#export-outliers-zip + source: | + 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() { + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIOutliersAPI.ExportOutliersZip(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIOutliersAPI.ExportOutliersZip(context.Background()).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.ExportOutliersZip``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportOutliersZip`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.ExportOutliersZip`: %v\n", resp) + } +- path: /outlier-summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-outliers#get-identity-outlier-snapshots + source: | + 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() { + 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) + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + filters := `snapshotDate ge "2022-02-07T20:13:29.356648026Z"` // 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: **snapshotDate**: *ge, le* (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: **snapshotDate**: *ge, le* (optional) + sorters := `snapshotDate` // 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: **snapshotDate** (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: **snapshotDate** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIOutliersAPI.GetIdentityOutlierSnapshots(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIOutliersAPI.GetIdentityOutlierSnapshots(context.Background()).Limit(limit).Offset(offset).Type_(type_).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetIdentityOutlierSnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityOutlierSnapshots`: []OutlierSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetIdentityOutlierSnapshots`: %v\n", resp) + } +- path: /outliers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-outliers#get-identity-outliers + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + filters := `attributes.displayName sw "John" and certStatus 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) + sorters := `attributes.displayName,firstDetectionDate,-score` // 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: **firstDetectionDate, attributes, score** (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: **firstDetectionDate, attributes, score** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIOutliersAPI.GetIdentityOutliers(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIOutliersAPI.GetIdentityOutliers(context.Background()).Limit(limit).Offset(offset).Count(count).Type_(type_).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityOutliers`: []Outlier + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetIdentityOutliers`: %v\n", resp) + } +- path: /outlier-summaries/latest + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-outliers#get-latest-identity-outlier-snapshots + source: | + 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() { + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIOutliersAPI.GetLatestIdentityOutlierSnapshots(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIOutliersAPI.GetLatestIdentityOutlierSnapshots(context.Background()).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetLatestIdentityOutlierSnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLatestIdentityOutlierSnapshots`: []LatestOutlierSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetLatestIdentityOutlierSnapshots`: %v\n", resp) + } +- path: /outlier-feature-summaries/{outlierFeatureId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-outliers#get-outlier-contributing-feature-summary + source: | + 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() { + outlierFeatureId := `04654b66-7561-4090-94f9-abee0722a1af` // string | Contributing feature id # string | Contributing feature id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIOutliersAPI.GetOutlierContributingFeatureSummary(context.Background(), outlierFeatureId).Execute() + //resp, r, err := apiClient.Beta.IAIOutliersAPI.GetOutlierContributingFeatureSummary(context.Background(), outlierFeatureId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetOutlierContributingFeatureSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOutlierContributingFeatureSummary`: OutlierFeatureSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetOutlierContributingFeatureSummary`: %v\n", resp) + } +- path: /outliers/{outlierId}/contributing-features + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-outliers#get-peer-group-outliers-contributing-features + source: | + 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() { + outlierId := `2c918085842e69ae018432d22ccb212f` // string | The outlier id # string | The outlier 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + includeTranslationMessages := `include-translation-messages=` // string | Whether or not to include translation messages object in returned response (optional) # string | Whether or not to include translation messages object in returned response (optional) + sorters := `importance` // 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: **importance** (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: **importance** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures(context.Background(), outlierId).Execute() + //resp, r, err := apiClient.Beta.IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures(context.Background(), outlierId).Limit(limit).Offset(offset).Count(count).IncludeTranslationMessages(includeTranslationMessages).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPeerGroupOutliersContributingFeatures`: []OutlierContributingFeature + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures`: %v\n", resp) + } +- path: /outliers/ignore + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-outliers#ignore-identity-outliers + source: | + 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() { + requestbody := []byte(``) // []string | + + + var requestBody beta.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.IAIOutliersAPI.IgnoreIdentityOutliers(context.Background()).RequestBody(requestBody).Execute() + //r, err := apiClient.Beta.IAIOutliersAPI.IgnoreIdentityOutliers(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.IgnoreIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-outliers#list-outliers-contributing-feature-access-items + source: | + 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() { + outlierId := `2c918085842e69ae018432d22ccb212f` // string | The outlier id # string | The outlier id + contributingFeatureName := `entitlement_count` // string | The name of contributing feature # string | The name of contributing feature + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + accessType := `ENTITLEMENT` // string | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) # string | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) + sorters := `displayName` // 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: **displayName** (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: **displayName** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIOutliersAPI.ListOutliersContributingFeatureAccessItems(context.Background(), outlierId, contributingFeatureName).Execute() + //resp, r, err := apiClient.Beta.IAIOutliersAPI.ListOutliersContributingFeatureAccessItems(context.Background(), outlierId, contributingFeatureName).Limit(limit).Offset(offset).Count(count).AccessType(accessType).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.ListOutliersContributingFeatureAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOutliersContributingFeatureAccessItems`: []OutliersContributingFeatureAccessItems + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.ListOutliersContributingFeatureAccessItems`: %v\n", resp) + } +- path: /outliers/unignore + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-outliers#un-ignore-identity-outliers + source: | + 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() { + requestbody := []byte(``) // []string | + + + var requestBody beta.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.IAIOutliersAPI.UnIgnoreIdentityOutliers(context.Background()).RequestBody(requestBody).Execute() + //r, err := apiClient.Beta.IAIOutliersAPI.UnIgnoreIdentityOutliers(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.UnIgnoreIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /peer-group-strategies/{strategy}/identity-outliers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-peer-group-strategies#get-peer-group-outliers + source: | + 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() { + strategy := `entitlement` // string | The strategy used to create peer groups. Currently, 'entitlement' is supported. # string | The strategy used to create peer groups. Currently, 'entitlement' is supported. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers(context.Background(), strategy).Execute() + //resp, r, err := apiClient.Beta.IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers(context.Background(), strategy).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPeerGroupOutliers`: []PeerGroupMember + fmt.Fprintf(os.Stdout, "Response from `IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers`: %v\n", resp) + } +- path: /recommendations/request + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-recommendations#get-recommendations + source: | + 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() { + recommendationrequestdto := []byte(`{ + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true + }`) // RecommendationRequestDto | + + + var recommendationRequestDto beta.RecommendationRequestDto + if err := json.Unmarshal(recommendationrequestdto, &recommendationRequestDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRecommendationsAPI.GetRecommendations(context.Background()).RecommendationRequestDto(recommendationRequestDto).Execute() + //resp, r, err := apiClient.Beta.IAIRecommendationsAPI.GetRecommendations(context.Background()).RecommendationRequestDto(recommendationRequestDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.GetRecommendations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRecommendations`: RecommendationResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.GetRecommendations`: %v\n", resp) + } +- path: /recommendations/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-recommendations#get-recommendations-config + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRecommendationsAPI.GetRecommendationsConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIRecommendationsAPI.GetRecommendationsConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.GetRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRecommendationsConfig`: RecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.GetRecommendationsConfig`: %v\n", resp) + } +- path: /recommendations/config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-recommendations#update-recommendations-config + source: | + 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() { + recommendationconfigdto := []byte(`{ + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + }`) // RecommendationConfigDto | + + + var recommendationConfigDto beta.RecommendationConfigDto + if err := json.Unmarshal(recommendationconfigdto, &recommendationConfigDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRecommendationsAPI.UpdateRecommendationsConfig(context.Background()).RecommendationConfigDto(recommendationConfigDto).Execute() + //resp, r, err := apiClient.Beta.IAIRecommendationsAPI.UpdateRecommendationsConfig(context.Background()).RecommendationConfigDto(recommendationConfigDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.UpdateRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRecommendationsConfig`: RecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.UpdateRecommendationsConfig`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#create-potential-role-provision-request + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + minEntitlementPopularity := 56 // int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) # int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to true) # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to true) + roleminingpotentialroleprovisionrequest := []byte(`{ + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false + }`) // RoleMiningPotentialRoleProvisionRequest | Required information to create a new role (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest(context.Background(), sessionId, potentialRoleId).MinEntitlementPopularity(minEntitlementPopularity).IncludeCommonAccess(includeCommonAccess).RoleMiningPotentialRoleProvisionRequest(roleMiningPotentialRoleProvisionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePotentialRoleProvisionRequest`: RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest`: %v\n", resp) + } +- path: /role-mining-sessions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#create-role-mining-sessions + source: | + 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() { + roleminingsessiondto := []byte(`{ + "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", + "prescribedPruneThreshold" : 10, + "pruneThreshold" : 50, + "saved" : true, + "potentialRolesReadyCount" : 0, + "scope" : { + "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], + "attributeFilterCriteria" : { + "displayName" : { + "untranslated" : "Location: Miami" + }, + "ariaLabel" : { + "untranslated" : "Location: Miami" + }, + "data" : { + "displayName" : { + "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" + }, + "name" : "location", + "operator" : "EQUALS", + "values" : [ "Miami" ] + } + }, + "criteria" : "source.name:DataScienceDataset" + }, + "potentialRoleCount" : 0, + "name" : "Saved RM Session - 07/10", + "minNumIdentitiesInPotentialRole" : 20, + "identityCount" : 0, + "type" : "SPECIALIZED" + }`) // RoleMiningSessionDto | Role mining session parameters + + + var roleMiningSessionDto beta.RoleMiningSessionDto + if err := json.Unmarshal(roleminingsessiondto, &roleMiningSessionDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.CreateRoleMiningSessions(context.Background()).RoleMiningSessionDto(roleMiningSessionDto).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.CreateRoleMiningSessions(context.Background()).RoleMiningSessionDto(roleMiningSessionDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.CreateRoleMiningSessions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRoleMiningSessions`: RoleMiningSessionResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.CreateRoleMiningSessions`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#download-role-mining-potential-role-zip + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + exportId := `4940ffd4-836f-48a3-b2b0-6d498c3fdf40` // string | The id of a previously run export job for this potential role # string | The id of a previously run export job for this potential role + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip(context.Background(), sessionId, potentialRoleId, exportId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip(context.Background(), sessionId, potentialRoleId, exportId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DownloadRoleMiningPotentialRoleZip`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#export-role-mining-potential-role + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.ExportRoleMiningPotentialRole(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.ExportRoleMiningPotentialRole(context.Background(), sessionId, potentialRoleId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRole`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#export-role-mining-potential-role-async + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + roleminingpotentialroleexportrequest := []byte(`{ + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true + }`) // RoleMiningPotentialRoleExportRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync(context.Background(), sessionId, potentialRoleId).RoleMiningPotentialRoleExportRequest(roleMiningPotentialRoleExportRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRoleAsync`: RoleMiningPotentialRoleExportResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#export-role-mining-potential-role-status + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + exportId := `4940ffd4-836f-48a3-b2b0-6d498c3fdf40` // string | The id of a previously run export job for this potential role # string | The id of a previously run export job for this potential role + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus(context.Background(), sessionId, potentialRoleId, exportId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus(context.Background(), sessionId, potentialRoleId, exportId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRoleStatus`: RoleMiningPotentialRoleExportResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus`: %v\n", resp) + } +- path: /role-mining-potential-roles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#get-all-potential-role-summaries + source: | + 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() { + sorters := `createdDate` // 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: **createdDate, identityCount, entitlementCount, freshness, quality** (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: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) + filters := `(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))` // 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetAllPotentialRoleSummaries(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetAllPotentialRoleSummaries(context.Background()).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetAllPotentialRoleSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAllPotentialRoleSummaries`: []RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetAllPotentialRoleSummaries`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#get-entitlement-distribution-potential-role + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included or not (optional) # bool | Boolean determining whether common access entitlements will be included or not (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole(context.Background(), sessionId, potentialRoleId).IncludeCommonAccess(includeCommonAccess).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementDistributionPotentialRole`: map[string]int32 + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#get-entitlements-potential-role + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included or not (optional) (default to true) # bool | Boolean determining whether common access entitlements will be included or not (optional) (default to true) + sorters := `popularity` // 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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) + filters := `applicationName sw "AD"` // 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).IncludeCommonAccess(includeCommonAccess).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementsPotentialRole`: []RoleMiningEntitlement + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetEntitlementsPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#get-excluded-entitlements-potential-role + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + sorters := `populariity` // 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: **popularity** (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: **popularity** (optional) + filters := `applicationName sw "AD"` // 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetExcludedEntitlementsPotentialRole`: []RoleMiningEntitlement + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#get-identities-potential-role + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + sorters := `name` // 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** (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** (optional) + filters := `filters_example` // 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: **name**: *sw* (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: **name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetIdentitiesPotentialRole(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetIdentitiesPotentialRole(context.Background(), sessionId, potentialRoleId).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetIdentitiesPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitiesPotentialRole`: []RoleMiningIdentity + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetIdentitiesPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#get-potential-role + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRole(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRole(context.Background(), sessionId, potentialRoleId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#get-potential-role-applications + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `62f28d91-7d9f-4d17-be15-666d5b41d77f` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + filters := `applicationName sw "test"` // 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: **applicationName**: *sw* (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: **applicationName**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRoleApplications(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRoleApplications(context.Background(), sessionId, potentialRoleId).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleApplications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleApplications`: []RoleMiningPotentialRoleApplication + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleApplications`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#get-potential-role-entitlements + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `62f28d91-7d9f-4d17-be15-666d5b41d77f` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + filters := `entitlementRef.name sw "test"` // 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: **entitlementRef.name**: *sw* (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: **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRoleEntitlements(context.Background(), sessionId, potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRoleEntitlements(context.Background(), sessionId, potentialRoleId).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleEntitlements`: []RoleMiningPotentialRoleEntitlements + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleEntitlements`: %v\n", resp) + } +- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#get-potential-role-source-identity-usage + source: | + 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() { + potentialRoleId := `e0cc5d7d-bf7f-4f81-b2af-8885b09d9923` // string | A potential role id # string | A potential role id + sourceId := `2c9180877620c1460176267f336a106f` // string | A source id # string | A source id + sorters := `-usageCount` // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (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 is supported for the following fields: **displayName, email, usageCount** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage(context.Background(), potentialRoleId, sourceId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage(context.Background(), potentialRoleId, sourceId).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleSourceIdentityUsage`: []RoleMiningPotentialRoleSourceUsage + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#get-potential-role-summaries + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + sorters := `createdDate` // 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: **createdDate** (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: **createdDate** (optional) + filters := `(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))` // 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRoleSummaries(context.Background(), sessionId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetPotentialRoleSummaries(context.Background(), sessionId).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleSummaries`: []RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleSummaries`: %v\n", resp) + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#get-role-mining-potential-role + source: | + 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() { + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id # string | A potential role id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetRoleMiningPotentialRole(context.Background(), potentialRoleId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetRoleMiningPotentialRole(context.Background(), potentialRoleId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#get-role-mining-session + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id to be retrieved. # string | The role mining session id to be retrieved. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetRoleMiningSession(context.Background(), sessionId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetRoleMiningSession(context.Background(), sessionId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSession``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSession`: RoleMiningSessionResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSession`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#get-role-mining-session-status + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetRoleMiningSessionStatus(context.Background(), sessionId).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetRoleMiningSessionStatus(context.Background(), sessionId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSessionStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSessionStatus`: RoleMiningSessionStatus + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSessionStatus`: %v\n", resp) + } +- path: /role-mining-sessions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#get-role-mining-sessions + source: | + 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() { + filters := `saved eq "true" and name sw "RM Session"` // 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: **saved**: *eq* **name**: *eq, sw* (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: **saved**: *eq* **name**: *eq, sw* (optional) + sorters := `createdBy,createdDate` // 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: **createdBy, createdDate** (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: **createdBy, createdDate** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetRoleMiningSessions(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetRoleMiningSessions(context.Background()).Filters(filters).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSessions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSessions`: []RoleMiningSessionResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSessions`: %v\n", resp) + } +- path: /role-mining-potential-roles/saved + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#get-saved-potential-roles + source: | + 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() { + sorters := `modified` // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (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 is supported for the following fields: **modified** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetSavedPotentialRoles(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.GetSavedPotentialRoles(context.Background()).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetSavedPotentialRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSavedPotentialRoles`: []RoleMiningSessionDraftRoleDto + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetSavedPotentialRoles`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#patch-potential-role + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The potential role summary id # string | The potential role summary id + patchpotentialrolerequestinner := []byte(`[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]`) // []PatchPotentialRoleRequestInner | + + + var patchPotentialRoleRequestInner beta.[]PatchPotentialRoleRequestInner + if err := json.Unmarshal(patchpotentialrolerequestinner, &patchPotentialRoleRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.PatchPotentialRole(context.Background(), sessionId, potentialRoleId).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.PatchPotentialRole(context.Background(), sessionId, potentialRoleId).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPotentialRole`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchPotentialRole`: %v\n", resp) + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#patch-role-mining-potential-role + source: | + 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() { + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The potential role summary id # string | The potential role summary id + patchpotentialrolerequestinner := []byte(`[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]`) // []PatchPotentialRoleRequestInner | + + + var patchPotentialRoleRequestInner beta.[]PatchPotentialRoleRequestInner + if err := json.Unmarshal(patchpotentialrolerequestinner, &patchPotentialRoleRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.PatchRoleMiningPotentialRole(context.Background(), potentialRoleId).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.PatchRoleMiningPotentialRole(context.Background(), potentialRoleId).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchRoleMiningPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchRoleMiningPotentialRole`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchRoleMiningPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#patch-role-mining-session + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id to be patched # string | The role mining session id to be patched + jsonpatchoperation := []byte(`[{op=replace, path=/pruneThreshold, value=83}, {op=replace, path=/minNumIdentitiesInPotentialRole, value=10}, {op=replace, path=/saved, value=false}, {op=replace, path=/name, value=RM Session - 07/10/22}, {op=add, path=/name, value=RM Session - 07/10/22}]`) // []JsonPatchOperation | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.PatchRoleMiningSession(context.Background(), sessionId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.PatchRoleMiningSession(context.Background(), sessionId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchRoleMiningSession``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchRoleMiningSession`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchRoleMiningSession`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/iai-role-mining#update-entitlements-potential-role + source: | + 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() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + roleminingpotentialroleeditentitlements := []byte(`{ + "ids" : [ "entId1", "entId2" ], + "exclude" : true + }`) // RoleMiningPotentialRoleEditEntitlements | Role mining session parameters + + + var roleMiningPotentialRoleEditEntitlements beta.RoleMiningPotentialRoleEditEntitlements + if err := json.Unmarshal(roleminingpotentialroleeditentitlements, &roleMiningPotentialRoleEditEntitlements); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IAIRoleMiningAPI.UpdateEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).RoleMiningPotentialRoleEditEntitlements(roleMiningPotentialRoleEditEntitlements).Execute() + //resp, r, err := apiClient.Beta.IAIRoleMiningAPI.UpdateEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).RoleMiningPotentialRoleEditEntitlements(roleMiningPotentialRoleEditEntitlements).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.UpdateEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateEntitlementsPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.UpdateEntitlementsPotentialRole`: %v\n", resp) + } +- path: /icons/{objectType}/{objectId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/icons#delete-icon + source: | + 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() { + objectType := `application` // string | Object type # string | Object type + objectId := `a291e870-48c3-4953-b656-fb5ce2a93169` // string | Object id. # string | Object id. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.IconsAPI.DeleteIcon(context.Background(), objectType, objectId).Execute() + //r, err := apiClient.Beta.IconsAPI.DeleteIcon(context.Background(), objectType, objectId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IconsAPI.DeleteIcon``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /icons/{objectType}/{objectId} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/icons#set-icon + source: | + 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() { + objectType := `application` // string | Object type # string | Object type + objectId := `a291e870-48c3-4953-b656-fb5ce2a93169` // string | Object id. # string | Object id. + image := BINARY_DATA_HERE // *os.File | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] # *os.File | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IconsAPI.SetIcon(context.Background(), objectType, objectId).Image(image).Execute() + //resp, r, err := apiClient.Beta.IconsAPI.SetIcon(context.Background(), objectType, objectId).Image(image).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IconsAPI.SetIcon``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetIcon`: SetIcon200Response + fmt.Fprintf(os.Stdout, "Response from `IconsAPI.SetIcon`: %v\n", resp) + } +- path: /identities/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identities#delete-identity + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | Identity Id # string | Identity Id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.IdentitiesAPI.DeleteIdentity(context.Background(), id).Execute() + //r, err := apiClient.Beta.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) + } + } +- path: /identities/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identities#get-identity + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | Identity Id # string | Identity Id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentitiesAPI.GetIdentity(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `GetIdentity`: Identity + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetIdentity`: %v\n", resp) + } +- path: /identities/{identityId}/ownership + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identities#get-identity-ownership-details + source: | + 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() { + identityId := `ff8081814d2a8036014d701f3fbf53fa` // string | Identity ID. # string | Identity ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentitiesAPI.GetIdentityOwnershipDetails(context.Background(), identityId).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `GetIdentityOwnershipDetails`: IdentityOwnershipAssociationDetails + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetIdentityOwnershipDetails`: %v\n", resp) + } +- path: /identities/{identityId}/role-assignments/{assignmentId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identities#get-role-assignment + source: | + 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() { + identityId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity Id # string | Identity Id + assignmentId := `1cbb0705b38c4226b1334eadd8874086` // string | Assignment Id # string | Assignment Id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentitiesAPI.GetRoleAssignment(context.Background(), identityId, assignmentId).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `GetRoleAssignment`: RoleAssignmentDto + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetRoleAssignment`: %v\n", resp) + } +- path: /identities/{identityId}/role-assignments + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identities#get-role-assignments + source: | + 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() { + identityId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity Id to get the role assignments for # string | Identity Id to get the role assignments for + 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) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentitiesAPI.GetRoleAssignments(context.Background(), identityId).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `GetRoleAssignments`: []GetRoleAssignments200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetRoleAssignments`: %v\n", resp) + } +- path: /identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identities#list-identities + source: | + 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() { + 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") + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.IdentitiesAPI.ListIdentities(context.Background()).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `ListIdentities`: []Identity + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.ListIdentities`: %v\n", resp) + } +- path: /identities/{identityId}/reset + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identities#reset-identity + source: | + 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() { + identityId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity Id # string | Identity Id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.IdentitiesAPI.ResetIdentity(context.Background(), identityId).Execute() + //r, err := apiClient.Beta.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) + } + } +- path: /identities/{id}/verification/account/send + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identities#send-identity-verification-account-token + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + sendaccountverificationrequest := []byte(`{ + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" + }`) // SendAccountVerificationRequest | + + + var sendAccountVerificationRequest beta.SendAccountVerificationRequest + if err := json.Unmarshal(sendaccountverificationrequest, &sendAccountVerificationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.IdentitiesAPI.SendIdentityVerificationAccountToken(context.Background(), id).SendAccountVerificationRequest(sendAccountVerificationRequest).Execute() + //r, err := apiClient.Beta.IdentitiesAPI.SendIdentityVerificationAccountToken(context.Background(), id).SendAccountVerificationRequest(sendAccountVerificationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.SendIdentityVerificationAccountToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /identities/invite + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identities#start-identities-invite + source: | + 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() { + inviteidentitiesrequest := []byte(`{ + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false + }`) // InviteIdentitiesRequest | + + + var inviteIdentitiesRequest beta.InviteIdentitiesRequest + if err := json.Unmarshal(inviteidentitiesrequest, &inviteIdentitiesRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentitiesAPI.StartIdentitiesInvite(context.Background()).InviteIdentitiesRequest(inviteIdentitiesRequest).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `StartIdentitiesInvite`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.StartIdentitiesInvite`: %v\n", resp) + } +- path: /identities/process + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identities#start-identity-processing + source: | + 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() { + processidentitiesrequest := []byte(`{ + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + }`) // ProcessIdentitiesRequest | + + + var processIdentitiesRequest beta.ProcessIdentitiesRequest + if err := json.Unmarshal(processidentitiesrequest, &processIdentitiesRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentitiesAPI.StartIdentityProcessing(context.Background()).ProcessIdentitiesRequest(processIdentitiesRequest).Execute() + //resp, r, err := apiClient.Beta.IdentitiesAPI.StartIdentityProcessing(context.Background()).ProcessIdentitiesRequest(processIdentitiesRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.StartIdentityProcessing``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartIdentityProcessing`: TaskResultResponse + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.StartIdentityProcessing`: %v\n", resp) + } +- path: /identities/{identityId}/synchronize-attributes + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identities#synchronize-attributes-for-identity + source: | + 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() { + identityId := `identityId_example` // string | The Identity id # string | The Identity id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentitiesAPI.SynchronizeAttributesForIdentity(context.Background(), identityId).Execute() + //resp, r, err := apiClient.Beta.IdentitiesAPI.SynchronizeAttributesForIdentity(context.Background(), identityId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.SynchronizeAttributesForIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SynchronizeAttributesForIdentity`: IdentitySyncJob + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.SynchronizeAttributesForIdentity`: %v\n", resp) + } +- path: /identity-attributes + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-attributes#create-identity-attribute + source: | + 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() { + identityattribute := []byte(`{ + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + }`) // IdentityAttribute | + + + var identityAttribute beta.IdentityAttribute + if err := json.Unmarshal(identityattribute, &identityAttribute); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityAttributesAPI.CreateIdentityAttribute(context.Background()).IdentityAttribute(identityAttribute).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `CreateIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.CreateIdentityAttribute`: %v\n", resp) + } +- path: /identity-attributes/{name} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-attributes#delete-identity-attribute + source: | + 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() { + name := `displayName` // string | The attribute's technical name. # string | The attribute's technical name. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.IdentityAttributesAPI.DeleteIdentityAttribute(context.Background(), name).Execute() + //r, err := apiClient.Beta.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) + } + } +- path: /identity-attributes/bulk-delete + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-attributes#delete-identity-attributes-in-bulk + source: | + 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() { + identityattributenames := []byte(`{ + "ids" : [ "name", "displayName" ] + }`) // IdentityAttributeNames | + + + var identityAttributeNames beta.IdentityAttributeNames + if err := json.Unmarshal(identityattributenames, &identityAttributeNames); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.IdentityAttributesAPI.DeleteIdentityAttributesInBulk(context.Background()).IdentityAttributeNames(identityAttributeNames).Execute() + //r, err := apiClient.Beta.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) + } + } +- path: /identity-attributes/{name} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-attributes#get-identity-attribute + source: | + 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() { + name := `displayName` // string | The attribute's technical name. # string | The attribute's technical name. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityAttributesAPI.GetIdentityAttribute(context.Background(), name).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `GetIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.GetIdentityAttribute`: %v\n", resp) + } +- path: /identity-attributes + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-attributes#list-identity-attributes + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityAttributesAPI.ListIdentityAttributes(context.Background()).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `ListIdentityAttributes`: []IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.ListIdentityAttributes`: %v\n", resp) + } +- path: /identity-attributes/{name} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-attributes#put-identity-attribute + source: | + 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() { + name := `displayName` // string | The attribute's technical name. # string | The attribute's technical name. + identityattribute := []byte(`{ + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + }`) // IdentityAttribute | + + + var identityAttribute beta.IdentityAttribute + if err := json.Unmarshal(identityattribute, &identityAttribute); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityAttributesAPI.PutIdentityAttribute(context.Background(), name).IdentityAttribute(identityAttribute).Execute() + //resp, r, err := apiClient.Beta.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) + } + // response from `PutIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.PutIdentityAttribute`: %v\n", resp) + } +- path: /historical-identities/{id}/compare + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-history#compare-identity-snapshots + source: | + 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + snapshot1 := `2007-03-01T13:00:00Z` // string | The snapshot 1 of identity (optional) # string | The snapshot 1 of identity (optional) + snapshot2 := `2008-03-01T13:00:00Z` // string | The snapshot 2 of identity (optional) # string | The snapshot 2 of identity (optional) + accessitemtypes := []byte(``) // []string | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.CompareIdentitySnapshots(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.CompareIdentitySnapshots(context.Background(), id).Snapshot1(snapshot1).Snapshot2(snapshot2).AccessItemTypes(accessItemTypes).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.CompareIdentitySnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompareIdentitySnapshots`: []IdentityCompareResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.CompareIdentitySnapshots`: %v\n", resp) + } +- path: /historical-identities/{id}/compare/{accessType} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-history#compare-identity-snapshots-access-type + source: | + 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + accessType := `role` // string | The specific type which needs to be compared # string | The specific type which needs to be compared + accessAssociated := 2007-03-01T13:00:00Z // bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) # bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) + snapshot1 := `2008-03-01T13:00:00Z` // string | The snapshot 1 of identity (optional) # string | The snapshot 1 of identity (optional) + snapshot2 := `2009-03-01T13:00:00Z` // string | The snapshot 2 of identity (optional) # string | The snapshot 2 of identity (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.CompareIdentitySnapshotsAccessType(context.Background(), id, accessType).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.CompareIdentitySnapshotsAccessType(context.Background(), id, accessType).AccessAssociated(accessAssociated).Snapshot1(snapshot1).Snapshot2(snapshot2).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.CompareIdentitySnapshotsAccessType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompareIdentitySnapshotsAccessType`: []AccessItemDiff + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.CompareIdentitySnapshotsAccessType`: %v\n", resp) + } +- path: /historical-identities/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-history#get-historical-identity + source: | + 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetHistoricalIdentity(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetHistoricalIdentity(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetHistoricalIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetHistoricalIdentity`: IdentityHistoryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetHistoricalIdentity`: %v\n", resp) + } +- path: /historical-identities/{id}/events + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-history#get-historical-identity-events + source: | + 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + from := `2024-03-01T13:00:00Z` // string | The optional instant until which access events are returned (optional) # string | The optional instant until which access events are returned (optional) + eventtypes := []byte(`[AccessAddedEvent, AccessRemovedEvent]`) // []string | An optional list of event types to return. If null or empty, all events are returned (optional) + accessitemtypes := []byte(`[entitlement, account]`) // []string | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetHistoricalIdentityEvents(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetHistoricalIdentityEvents(context.Background(), id).From(from).EventTypes(eventTypes).AccessItemTypes(accessItemTypes).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetHistoricalIdentityEvents``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetHistoricalIdentityEvents`: []GetHistoricalIdentityEvents200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetHistoricalIdentityEvents`: %v\n", resp) + } +- path: /historical-identities/{id}/snapshots/{date} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-history#get-identity-snapshot + source: | + 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + date := `2007-03-01T13:00:00Z` // string | The specified date # string | The specified date + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetIdentitySnapshot(context.Background(), id, date).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetIdentitySnapshot(context.Background(), id, date).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentitySnapshot``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySnapshot`: IdentityHistoryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentitySnapshot`: %v\n", resp) + } +- path: /historical-identities/{id}/snapshot-summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-history#get-identity-snapshot-summary + source: | + 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + before := `2007-03-01T13:00:00Z` // string | The date before which snapshot summary is required (optional) # string | The date before which snapshot summary is required (optional) + interval := `interval_example` // string | The interval indicating day or month. Defaults to month if not specified (optional) # string | The interval indicating day or month. Defaults to month if not specified (optional) + timeZone := `UTC` // string | The time zone. Defaults to UTC if not provided (optional) # string | The time zone. Defaults to UTC if not provided (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetIdentitySnapshotSummary(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetIdentitySnapshotSummary(context.Background(), id).Before(before).Interval(interval).TimeZone(timeZone).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentitySnapshotSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySnapshotSummary`: []MetricResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentitySnapshotSummary`: %v\n", resp) + } +- path: /historical-identities/{id}/start-date + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-history#get-identity-start-date + source: | + 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetIdentityStartDate(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.GetIdentityStartDate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentityStartDate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityStartDate`: string + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentityStartDate`: %v\n", resp) + } +- path: /historical-identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-history#list-historical-identities + source: | + 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() { + startsWithQuery := `Ada` // string | This param is used for starts-with search for first, last and display name of the identity (optional) # string | This param is used for starts-with search for first, last and display name of the identity (optional) + isDeleted := true // bool | Indicates if we want to only list down deleted identities or not. (optional) # bool | Indicates if we want to only list down deleted identities or not. (optional) + isActive := true // bool | Indicates if we want to only list active or inactive identities. (optional) # bool | Indicates if we want to only list active or inactive identities. (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) + 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.IdentityHistoryAPI.ListHistoricalIdentities(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.ListHistoricalIdentities(context.Background()).StartsWithQuery(startsWithQuery).IsDeleted(isDeleted).IsActive(isActive).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListHistoricalIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListHistoricalIdentities`: []IdentityListItem + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListHistoricalIdentities`: %v\n", resp) + } +- path: /historical-identities/{id}/access-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-history#list-identity-access-items + source: | + 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + type_ := `account` // string | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) # string | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) + filters := `source eq "DataScienceDataset"` // 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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (optional) + sorters := `name` // 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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) + query := `Dr. Arden` // string | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (optional) # string | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.IdentityHistoryAPI.ListIdentityAccessItems(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.ListIdentityAccessItems(context.Background(), id).Type_(type_).Filters(filters).Sorters(sorters).Query(query).Limit(limit).Count(count).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentityAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityAccessItems`: []ListIdentityAccessItems200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentityAccessItems`: %v\n", resp) + } +- path: /historical-identities/{id}/snapshots/{date}/access-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-history#list-identity-snapshot-access-items + source: | + 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | Identity ID. # string | Identity ID. + date := `2007-03-01T13:00:00Z` // string | Specified date. # string | Specified date. + type_ := `account` // string | Access item type. (optional) # string | Access item type. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.ListIdentitySnapshotAccessItems(context.Background(), id, date).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.ListIdentitySnapshotAccessItems(context.Background(), id, date).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentitySnapshotAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentitySnapshotAccessItems`: []ListIdentityAccessItems200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentitySnapshotAccessItems`: %v\n", resp) + } +- path: /historical-identities/{id}/snapshots + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-history#list-identity-snapshots + source: | + 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 := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + start := `2007-03-01T13:00:00Z` // string | The specified start date (optional) # string | The specified start date (optional) + interval := `interval_example` // string | The interval indicating the range in day or month for the specified interval-name (optional) # string | The interval indicating the range in day or month for the specified interval-name (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityHistoryAPI.ListIdentitySnapshots(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.IdentityHistoryAPI.ListIdentitySnapshots(context.Background(), id).Start(start).Interval(interval).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentitySnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentitySnapshots`: []IdentitySnapshotSummaryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentitySnapshots`: %v\n", resp) + } +- path: /identity-profiles + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-profiles#create-identity-profile + source: | + 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() { + identityprofile := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2023-01-03T21:16:22.432Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "id" : "id12345" + }`) // IdentityProfile | + + + var identityProfile beta.IdentityProfile + if err := json.Unmarshal(identityprofile, &identityProfile); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.CreateIdentityProfile(context.Background()).IdentityProfile(identityProfile).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.CreateIdentityProfile(context.Background()).IdentityProfile(identityProfile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.CreateIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.CreateIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-profiles#delete-identity-profile + source: | + 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() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.DeleteIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.DeleteIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.DeleteIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteIdentityProfile`: TaskResultSimplified + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.DeleteIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-profiles#delete-identity-profiles + source: | + 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() { + requestbody := []byte(``) // []string | Identity Profile bulk delete request body. + + + var requestBody beta.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.DeleteIdentityProfiles(context.Background()).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.DeleteIdentityProfiles(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.DeleteIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteIdentityProfiles`: TaskResultSimplified + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.DeleteIdentityProfiles`: %v\n", resp) + } +- path: /identity-profiles/export + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-profiles#export-identity-profiles + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq 8c190e6787aa4ed9a90bd9d5344523fb` // 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, ne* **name**: *eq, ne* **priority**: *eq, ne* (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, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + sorters := `name,-priority` // 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: **id, name, priority** (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: **id, name, priority** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.ExportIdentityProfiles(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.ExportIdentityProfiles(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ExportIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportIdentityProfiles`: []IdentityProfileExportedObject + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ExportIdentityProfiles`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-profiles#get-default-identity-attribute-config + source: | + 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() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | The Identity Profile ID # string | The Identity Profile ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.GetDefaultIdentityAttributeConfig(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.GetDefaultIdentityAttributeConfig(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GetDefaultIdentityAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDefaultIdentityAttributeConfig`: IdentityAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GetDefaultIdentityAttributeConfig`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-profiles#get-identity-profile + source: | + 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() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.GetIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.GetIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GetIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GetIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/import + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-profiles#import-identity-profiles + source: | + 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() { + identityprofileexportedobject := []byte(``) // []IdentityProfileExportedObject | Previously exported Identity Profiles. + + + var identityProfileExportedObject beta.[]IdentityProfileExportedObject + if err := json.Unmarshal(identityprofileexportedobject, &identityProfileExportedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.ImportIdentityProfiles(context.Background()).IdentityProfileExportedObject(identityProfileExportedObject).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.ImportIdentityProfiles(context.Background()).IdentityProfileExportedObject(identityProfileExportedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ImportIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportIdentityProfiles`: ObjectImportResult + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ImportIdentityProfiles`: %v\n", resp) + } +- path: /identity-profiles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-profiles#list-identity-profiles + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq 8c190e6787aa4ed9a90bd9d5344523fb` // 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) + sorters := `name,-priority` // 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: **id, name, priority, created, modified, owner.id, owner.name** (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: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.ListIdentityProfiles(context.Background()).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.ListIdentityProfiles(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ListIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityProfiles`: []IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ListIdentityProfiles`: %v\n", resp) + } +- path: /identity-profiles/identity-preview + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-profiles#show-generate-identity-preview + source: | + 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() { + identitypreviewrequest := []byte(`{ + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + }`) // IdentityPreviewRequest | Identity Preview request body. + + + var identityPreviewRequest beta.IdentityPreviewRequest + if err := json.Unmarshal(identitypreviewrequest, &identityPreviewRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.ShowGenerateIdentityPreview(context.Background()).IdentityPreviewRequest(identityPreviewRequest).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.ShowGenerateIdentityPreview(context.Background()).IdentityPreviewRequest(identityPreviewRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ShowGenerateIdentityPreview``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ShowGenerateIdentityPreview`: IdentityPreviewResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ShowGenerateIdentityPreview`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/process-identities + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-profiles#sync-identity-profile + source: | + 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() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | The Identity Profile ID to be processed # string | The Identity Profile ID to be processed + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.SyncIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.SyncIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.SyncIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SyncIdentityProfile`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.SyncIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/identity-profiles#update-identity-profile + source: | + 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() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + jsonpatchoperation := []byte(`[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]`) // []JsonPatchOperation | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.IdentityProfilesAPI.UpdateIdentityProfile(context.Background(), identityProfileId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.IdentityProfilesAPI.UpdateIdentityProfile(context.Background(), identityProfileId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.UpdateIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.UpdateIdentityProfile`: %v\n", resp) + } +- path: /launchers + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/launchers#create-launcher + source: | + 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() { + launcherrequest := []byte(`{ + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + }`) // LauncherRequest | Payload to create a Launcher + + + var launcherRequest beta.LauncherRequest + if err := json.Unmarshal(launcherrequest, &launcherRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.LaunchersAPI.CreateLauncher(context.Background()).LauncherRequest(launcherRequest).Execute() + //resp, r, err := apiClient.Beta.LaunchersAPI.CreateLauncher(context.Background()).LauncherRequest(launcherRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LaunchersAPI.CreateLauncher``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateLauncher`: Launcher + fmt.Fprintf(os.Stdout, "Response from `LaunchersAPI.CreateLauncher`: %v\n", resp) + } +- path: /launchers/{launcherID} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/launchers#delete-launcher + source: | + 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() { + launcherID := `e3012408-8b61-4564-ad41-c5ec131c325b` // string | ID of the Launcher to be deleted # string | ID of the Launcher to be deleted + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.LaunchersAPI.DeleteLauncher(context.Background(), launcherID).Execute() + //r, err := apiClient.Beta.LaunchersAPI.DeleteLauncher(context.Background(), launcherID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LaunchersAPI.DeleteLauncher``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /launchers/{launcherID} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/launchers#get-launcher + source: | + 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() { + launcherID := `e3012408-8b61-4564-ad41-c5ec131c325b` // string | ID of the Launcher to be retrieved # string | ID of the Launcher to be retrieved + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.LaunchersAPI.GetLauncher(context.Background(), launcherID).Execute() + //resp, r, err := apiClient.Beta.LaunchersAPI.GetLauncher(context.Background(), launcherID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LaunchersAPI.GetLauncher``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLauncher`: Launcher + fmt.Fprintf(os.Stdout, "Response from `LaunchersAPI.GetLauncher`: %v\n", resp) + } +- path: /launchers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/launchers#get-launchers + source: | + 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() { + filters := `disabled eq "true"` // 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: **description**: *sw* **disabled**: *eq* **name**: *sw* (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: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) + next := `eyJuZXh0IjoxMjN9Cg==` // string | Pagination marker (optional) # string | Pagination marker (optional) + limit := 42 // int32 | Number of Launchers to return (optional) (default to 10) # int32 | Number of Launchers to return (optional) (default to 10) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.LaunchersAPI.GetLaunchers(context.Background()).Execute() + //resp, r, err := apiClient.Beta.LaunchersAPI.GetLaunchers(context.Background()).Filters(filters).Next(next).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LaunchersAPI.GetLaunchers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLaunchers`: GetLaunchers200Response + fmt.Fprintf(os.Stdout, "Response from `LaunchersAPI.GetLaunchers`: %v\n", resp) + } +- path: /launchers/{launcherID} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/launchers#put-launcher + source: | + 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() { + launcherID := `e3012408-8b61-4564-ad41-c5ec131c325b` // string | ID of the Launcher to be replaced # string | ID of the Launcher to be replaced + launcherrequest := []byte(`{ + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + }`) // LauncherRequest | Payload to replace Launcher + + + var launcherRequest beta.LauncherRequest + if err := json.Unmarshal(launcherrequest, &launcherRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.LaunchersAPI.PutLauncher(context.Background(), launcherID).LauncherRequest(launcherRequest).Execute() + //resp, r, err := apiClient.Beta.LaunchersAPI.PutLauncher(context.Background(), launcherID).LauncherRequest(launcherRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LaunchersAPI.PutLauncher``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutLauncher`: Launcher + fmt.Fprintf(os.Stdout, "Response from `LaunchersAPI.PutLauncher`: %v\n", resp) + } +- path: /beta/launchers/{launcherID}/launch + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/launchers#start-launcher + source: | + 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() { + launcherID := `e3012408-8b61-4564-ad41-c5ec131c325b` // string | ID of the Launcher to be launched # string | ID of the Launcher to be launched + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.LaunchersAPI.StartLauncher(context.Background(), launcherID).Execute() + //resp, r, err := apiClient.Beta.LaunchersAPI.StartLauncher(context.Background(), launcherID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LaunchersAPI.StartLauncher``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartLauncher`: StartLauncher200Response + fmt.Fprintf(os.Stdout, "Response from `LaunchersAPI.StartLauncher`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/lifecycle-states#get-lifecycle-states + source: | + 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() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity Profile ID. # string | Identity Profile ID. + lifecycleStateId := `ef38f94347e94562b5bb8424a56397d8` // string | Lifecycle State ID. # string | Lifecycle State ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.LifecycleStatesAPI.GetLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).Execute() + //resp, r, err := apiClient.Beta.LifecycleStatesAPI.GetLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.GetLifecycleStates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLifecycleStates`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.GetLifecycleStates`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/lifecycle-states#update-lifecycle-states + source: | + 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() { + 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 + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.LifecycleStatesAPI.UpdateLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.LifecycleStatesAPI.UpdateLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.UpdateLifecycleStates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateLifecycleStates`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.UpdateLifecycleStates`: %v\n", resp) + } +- path: /managed-clients/{id}/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/managed-clients#get-managed-client-status + source: | + 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 := `aClientId` // string | ID of the Managed Client Status to get # string | ID of the Managed Client Status to get + type_ := // ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ManagedClientsAPI.GetManagedClientStatus(context.Background(), id).Type_(type_).Execute() + //resp, r, err := apiClient.Beta.ManagedClientsAPI.GetManagedClientStatus(context.Background(), id).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClientStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClientStatus`: ManagedClientStatus + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClientStatus`: %v\n", resp) + } +- path: /managed-clients/{id}/status + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/managed-clients#update-managed-client-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + beta "github.com/sailpoint-oss/golang-sdk/v2/api_beta" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `aClientId` // string | ID of the Managed Client Status to update # string | ID of the Managed Client Status to update + managedclientstatus := []byte(`{ + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + }`) // ManagedClientStatus | + + + var managedClientStatus beta.ManagedClientStatus + if err := json.Unmarshal(managedclientstatus, &managedClientStatus); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ManagedClientsAPI.UpdateManagedClientStatus(context.Background(), id).ManagedClientStatus(managedClientStatus).Execute() + //resp, r, err := apiClient.Beta.ManagedClientsAPI.UpdateManagedClientStatus(context.Background(), id).ManagedClientStatus(managedClientStatus).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.UpdateManagedClientStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedClientStatus`: ManagedClientStatusAggResponse + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.UpdateManagedClientStatus`: %v\n", resp) + } +- path: /managed-clusters/{id}/log-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/managed-clusters#get-client-log-configuration + source: | + 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 := `aClusterId` // string | ID of ManagedCluster to get log configuration for # string | ID of ManagedCluster to get log configuration for + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ManagedClustersAPI.GetClientLogConfiguration(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.ManagedClustersAPI.GetClientLogConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetClientLogConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetClientLogConfiguration`: ClientLogConfiguration + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetClientLogConfiguration`: %v\n", resp) + } +- path: /managed-clusters/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/managed-clusters#get-managed-cluster + source: | + 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 := `aClusterId` // string | ID of the ManagedCluster to get # string | ID of the ManagedCluster to get + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ManagedClustersAPI.GetManagedCluster(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.ManagedClustersAPI.GetManagedCluster(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetManagedCluster`: %v\n", resp) + } +- path: /managed-clusters + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/managed-clusters#get-managed-clusters + source: | + 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() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `operational eq operation` // 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: **operational**: *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: **operational**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ManagedClustersAPI.GetManagedClusters(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ManagedClustersAPI.GetManagedClusters(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetManagedClusters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClusters`: []ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetManagedClusters`: %v\n", resp) + } +- path: /managed-clusters/{id}/log-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/managed-clusters#put-client-log-configuration + source: | + 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 := `aClusterId` // string | ID of ManagedCluster to update log configuration for # string | ID of ManagedCluster to update log configuration for + clientlogconfiguration := []byte(`{ + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + }`) // ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ManagedClustersAPI.PutClientLogConfiguration(context.Background(), id).ClientLogConfiguration(clientLogConfiguration).Execute() + //resp, r, err := apiClient.Beta.ManagedClustersAPI.PutClientLogConfiguration(context.Background(), id).ClientLogConfiguration(clientLogConfiguration).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.PutClientLogConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutClientLogConfiguration`: ClientLogConfiguration + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.PutClientLogConfiguration`: %v\n", resp) + } +- path: /mfa/{method}/delete + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/mfa-configuration#delete-mfa-config + source: | + 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() { + method := `okta-verify` // string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAConfigurationAPI.DeleteMFAConfig(context.Background(), method).Execute() + //resp, r, err := apiClient.Beta.MFAConfigurationAPI.DeleteMFAConfig(context.Background(), method).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.DeleteMFAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteMFAConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.DeleteMFAConfig`: %v\n", resp) + } +- path: /mfa/duo-web/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/mfa-configuration#get-mfa-duo-config + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAConfigurationAPI.GetMFADuoConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.MFAConfigurationAPI.GetMFADuoConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFADuoConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFADuoConfig`: MfaDuoConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFADuoConfig`: %v\n", resp) + } +- path: /mfa/kba/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/mfa-configuration#get-mfa-kba-config + source: | + 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() { + allLanguages := allLanguages=true // bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAConfigurationAPI.GetMFAKbaConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.MFAConfigurationAPI.GetMFAKbaConfig(context.Background()).AllLanguages(allLanguages).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFAKbaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFAKbaConfig`: []KbaQuestion + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFAKbaConfig`: %v\n", resp) + } +- path: /mfa/okta-verify/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/mfa-configuration#get-mfa-okta-config + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAConfigurationAPI.GetMFAOktaConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.MFAConfigurationAPI.GetMFAOktaConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFAOktaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFAOktaConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFAOktaConfig`: %v\n", resp) + } +- path: /mfa/duo-web/config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/mfa-configuration#set-mfa-duo-config + source: | + 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() { + mfaduoconfig := []byte(`{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }`) // MfaDuoConfig | + + + var mfaDuoConfig beta.MfaDuoConfig + if err := json.Unmarshal(mfaduoconfig, &mfaDuoConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAConfigurationAPI.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute() + //resp, r, err := apiClient.Beta.MFAConfigurationAPI.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFADuoConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFADuoConfig`: MfaDuoConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFADuoConfig`: %v\n", resp) + } +- path: /mfa/kba/config/answers + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/mfa-configuration#set-mfakba-config + source: | + 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() { + kbaanswerrequestitem := []byte(`[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]`) // []KbaAnswerRequestItem | + + + var kbaAnswerRequestItem beta.[]KbaAnswerRequestItem + if err := json.Unmarshal(kbaanswerrequestitem, &kbaAnswerRequestItem); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAConfigurationAPI.SetMFAKBAConfig(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + //resp, r, err := apiClient.Beta.MFAConfigurationAPI.SetMFAKBAConfig(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFAKBAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFAKBAConfig`: []KbaAnswerResponseItem + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFAKBAConfig`: %v\n", resp) + } +- path: /mfa/okta-verify/config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/mfa-configuration#set-mfa-okta-config + source: | + 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() { + mfaoktaconfig := []byte(`{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }`) // MfaOktaConfig | + + + var mfaOktaConfig beta.MfaOktaConfig + if err := json.Unmarshal(mfaoktaconfig, &mfaOktaConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAConfigurationAPI.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute() + //resp, r, err := apiClient.Beta.MFAConfigurationAPI.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFAOktaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFAOktaConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFAOktaConfig`: %v\n", resp) + } +- path: /mfa/{method}/test + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/mfa-configuration#test-mfa-config + source: | + 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() { + method := `okta-verify` // string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAConfigurationAPI.TestMFAConfig(context.Background(), method).Execute() + //resp, r, err := apiClient.Beta.MFAConfigurationAPI.TestMFAConfig(context.Background(), method).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.TestMFAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestMFAConfig`: MfaConfigTestResponse + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.TestMFAConfig`: %v\n", resp) + } +- path: /mfa/token/send + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/mfa-controller#create-send-token + source: | + 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() { + sendtokenrequest := []byte(`{ + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + }`) // SendTokenRequest | + + + var sendTokenRequest beta.SendTokenRequest + if err := json.Unmarshal(sendtokenrequest, &sendTokenRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAControllerAPI.CreateSendToken(context.Background()).SendTokenRequest(sendTokenRequest).Execute() + //resp, r, err := apiClient.Beta.MFAControllerAPI.CreateSendToken(context.Background()).SendTokenRequest(sendTokenRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.CreateSendToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSendToken`: SendTokenResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.CreateSendToken`: %v\n", resp) + } +- path: /mfa/{method}/poll + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/mfa-controller#ping-verification-status + source: | + 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() { + method := `okta-verify` // string | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' # string | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + verificationpollrequest := []byte(`{ + "requestId" : "089899f13a8f4da7824996191587bab9" + }`) // VerificationPollRequest | + + + var verificationPollRequest beta.VerificationPollRequest + if err := json.Unmarshal(verificationpollrequest, &verificationPollRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAControllerAPI.PingVerificationStatus(context.Background(), method).VerificationPollRequest(verificationPollRequest).Execute() + //resp, r, err := apiClient.Beta.MFAControllerAPI.PingVerificationStatus(context.Background(), method).VerificationPollRequest(verificationPollRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.PingVerificationStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PingVerificationStatus`: VerificationResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.PingVerificationStatus`: %v\n", resp) + } +- path: /mfa/duo-web/verify + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/mfa-controller#send-duo-verify-request + source: | + 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() { + duoverificationrequest := []byte(`{ + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + }`) // DuoVerificationRequest | + + + var duoVerificationRequest beta.DuoVerificationRequest + if err := json.Unmarshal(duoverificationrequest, &duoVerificationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAControllerAPI.SendDuoVerifyRequest(context.Background()).DuoVerificationRequest(duoVerificationRequest).Execute() + //resp, r, err := apiClient.Beta.MFAControllerAPI.SendDuoVerifyRequest(context.Background()).DuoVerificationRequest(duoVerificationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.SendDuoVerifyRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendDuoVerifyRequest`: VerificationResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.SendDuoVerifyRequest`: %v\n", resp) + } +- path: /mfa/kba/authenticate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/mfa-controller#send-kba-answers + source: | + 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() { + kbaanswerrequestitem := []byte(`[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]`) // []KbaAnswerRequestItem | + + + var kbaAnswerRequestItem beta.[]KbaAnswerRequestItem + if err := json.Unmarshal(kbaanswerrequestitem, &kbaAnswerRequestItem); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAControllerAPI.SendKbaAnswers(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + //resp, r, err := apiClient.Beta.MFAControllerAPI.SendKbaAnswers(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.SendKbaAnswers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendKbaAnswers`: KbaAuthResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.SendKbaAnswers`: %v\n", resp) + } +- path: /mfa/okta-verify/verify + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/mfa-controller#send-okta-verify-request + source: | + 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() { + oktaverificationrequest := []byte(`{ + "userId" : "example@mail.com" + }`) // OktaVerificationRequest | + + + var oktaVerificationRequest beta.OktaVerificationRequest + if err := json.Unmarshal(oktaverificationrequest, &oktaVerificationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAControllerAPI.SendOktaVerifyRequest(context.Background()).OktaVerificationRequest(oktaVerificationRequest).Execute() + //resp, r, err := apiClient.Beta.MFAControllerAPI.SendOktaVerifyRequest(context.Background()).OktaVerificationRequest(oktaVerificationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.SendOktaVerifyRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendOktaVerifyRequest`: VerificationResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.SendOktaVerifyRequest`: %v\n", resp) + } +- path: /mfa/token/authenticate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/mfa-controller#send-token-auth-request + source: | + 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() { + tokenauthrequest := []byte(`{ + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + }`) // TokenAuthRequest | + + + var tokenAuthRequest beta.TokenAuthRequest + if err := json.Unmarshal(tokenauthrequest, &tokenAuthRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MFAControllerAPI.SendTokenAuthRequest(context.Background()).TokenAuthRequest(tokenAuthRequest).Execute() + //resp, r, err := apiClient.Beta.MFAControllerAPI.SendTokenAuthRequest(context.Background()).TokenAuthRequest(tokenAuthRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.SendTokenAuthRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendTokenAuthRequest`: TokenAuthResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.SendTokenAuthRequest`: %v\n", resp) + } +- path: /multihosts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/multi-host-integration#create-multi-host-integration + source: | + 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() { + multihostintegrationscreate := []byte(`{ + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + }`) // MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create + + + var multiHostIntegrationsCreate beta.MultiHostIntegrationsCreate + if err := json.Unmarshal(multihostintegrationscreate, &multiHostIntegrationsCreate); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.CreateMultiHostIntegration(context.Background()).MultiHostIntegrationsCreate(multiHostIntegrationsCreate).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.CreateMultiHostIntegration(context.Background()).MultiHostIntegrationsCreate(multiHostIntegrationsCreate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.CreateMultiHostIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateMultiHostIntegration`: MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.CreateMultiHostIntegration`: %v\n", resp) + } +- path: /multihosts/{multihostId} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/multi-host-integration#create-sources-within-multi-host + source: | + 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() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration. # string | ID of the Multi-Host Integration. + multihostintegrationscreatesources := []byte(``) // []MultiHostIntegrationsCreateSources | The specifics of the sources to create within Multi-Host Integration. + + + var multiHostIntegrationsCreateSources beta.[]MultiHostIntegrationsCreateSources + if err := json.Unmarshal(multihostintegrationscreatesources, &multiHostIntegrationsCreateSources); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.MultiHostIntegrationAPI.CreateSourcesWithinMultiHost(context.Background(), multihostId).MultiHostIntegrationsCreateSources(multiHostIntegrationsCreateSources).Execute() + //r, err := apiClient.Beta.MultiHostIntegrationAPI.CreateSourcesWithinMultiHost(context.Background(), multihostId).MultiHostIntegrationsCreateSources(multiHostIntegrationsCreateSources).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.CreateSourcesWithinMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /multihosts/{multihostId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/multi-host-integration#delete-multi-host + source: | + 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() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of Multi-Host Integration to delete. # string | ID of Multi-Host Integration to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.MultiHostIntegrationAPI.DeleteMultiHost(context.Background(), multihostId).Execute() + //r, err := apiClient.Beta.MultiHostIntegrationAPI.DeleteMultiHost(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.DeleteMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /multihosts/{multihostId}/acctAggregationGroups + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/multi-host-integration#get-acct-aggregation-groups + source: | + 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() { + multihostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetAcctAggregationGroups(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetAcctAggregationGroups(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetAcctAggregationGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAcctAggregationGroups`: MultiHostIntegrationsAggScheduleUpdate + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetAcctAggregationGroups`: %v\n", resp) + } +- path: /multihosts/{multiHostId}/entitlementAggregationGroups + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/multi-host-integration#get-entitlement-aggregation-groups + source: | + 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() { + multiHostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetEntitlementAggregationGroups(context.Background(), multiHostId).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetEntitlementAggregationGroups(context.Background(), multiHostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetEntitlementAggregationGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementAggregationGroups`: MultiHostIntegrationsAggScheduleUpdate + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetEntitlementAggregationGroups`: %v\n", resp) + } +- path: /multihosts/{multihostId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/multi-host-integration#get-multi-host-integrations + source: | + 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() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration. # string | ID of the Multi-Host Integration. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetMultiHostIntegrations(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetMultiHostIntegrations(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostIntegrations`: MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostIntegrations`: %v\n", resp) + } +- path: /multihosts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/multi-host-integration#get-multi-host-integrations-list + source: | + 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() { + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `id eq 2c91808b6ef1d43e016efba0ce470904` // 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: **type**: *in* **forSubAdminId**: *in* (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: **type**: *in* **forSubAdminId**: *in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetMultiHostIntegrationsList(context.Background()).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetMultiHostIntegrationsList(context.Background()).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).ForSubadmin(forSubadmin).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostIntegrationsList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostIntegrationsList`: []MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostIntegrationsList`: %v\n", resp) + } +- path: /multihosts/{multiHostId}/sources/errors + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/multi-host-integration#get-multi-host-source-creation-errors + source: | + 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() { + multiHostId := `004091cb79b04636b88662afa50a4440` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors(context.Background(), multiHostId).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors(context.Background(), multiHostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostSourceCreationErrors`: []SourceCreationErrors + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors`: %v\n", resp) + } +- path: /multihosts/types + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/multi-host-integration#get-multihost-integration-types + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetMultihostIntegrationTypes(context.Background()).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetMultihostIntegrationTypes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultihostIntegrationTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultihostIntegrationTypes`: []MultiHostIntegrationTemplateType + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultihostIntegrationTypes`: %v\n", resp) + } +- path: /multihosts/{multihostId}/sources + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/multi-host-integration#get-sources-within-multi-host + source: | + 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() { + multihostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `id eq 2c91808b6ef1d43e016efba0ce470904` // 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**: *in* (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**: *in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetSourcesWithinMultiHost(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.GetSourcesWithinMultiHost(context.Background(), multihostId).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetSourcesWithinMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourcesWithinMultiHost`: []MultiHostSources + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetSourcesWithinMultiHost`: %v\n", resp) + } +- path: /multihosts/{multihostId}/sources/testConnection + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/multi-host-integration#test-connection-multi-host-sources + source: | + 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() { + multihostId := `2c91808568c529c60168cca6f90c1324` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.MultiHostIntegrationAPI.TestConnectionMultiHostSources(context.Background(), multihostId).Execute() + //r, err := apiClient.Beta.MultiHostIntegrationAPI.TestConnectionMultiHostSources(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.TestConnectionMultiHostSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /multihosts/{multihostId}/sources/{sourceId}/testConnection + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/multi-host-integration#test-source-connection-multihost + source: | + 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() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + sourceId := `2c91808568c529f60168cca6f90c1324` // string | ID of the source within the Multi-Host Integration # string | ID of the source within the Multi-Host Integration + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.TestSourceConnectionMultihost(context.Background(), multihostId, sourceId).Execute() + //resp, r, err := apiClient.Beta.MultiHostIntegrationAPI.TestSourceConnectionMultihost(context.Background(), multihostId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.TestSourceConnectionMultihost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConnectionMultihost`: TestSourceConnectionMultihost200Response + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.TestSourceConnectionMultihost`: %v\n", resp) + } +- path: /multihosts/{multihostId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/multi-host-integration#update-multi-host-sources + source: | + 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() { + multihostId := `anId` // string | ID of the Multi-Host Integration to update. # string | ID of the Multi-Host Integration to update. + updatemultihostsourcesrequestinner := []byte(`[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]`) // []UpdateMultiHostSourcesRequestInner | This endpoint allows you to update a Multi-Host Integration. + + + var updateMultiHostSourcesRequestInner beta.[]UpdateMultiHostSourcesRequestInner + if err := json.Unmarshal(updatemultihostsourcesrequestinner, &updateMultiHostSourcesRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.MultiHostIntegrationAPI.UpdateMultiHostSources(context.Background(), multihostId).UpdateMultiHostSourcesRequestInner(updateMultiHostSourcesRequestInner).Execute() + //r, err := apiClient.Beta.MultiHostIntegrationAPI.UpdateMultiHostSources(context.Background(), multihostId).UpdateMultiHostSourcesRequestInner(updateMultiHostSourcesRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.UpdateMultiHostSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-approvals/{id}/approve + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + 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) + nonemployeeapprovaldecision := []byte(`{ + "comment" : "comment" + }`) // NonEmployeeApprovalDecision | + + + var nonEmployeeApprovalDecision beta.NonEmployeeApprovalDecision + if err := json.Unmarshal(nonemployeeapprovaldecision, &nonEmployeeApprovalDecision); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest(context.Background(), id).NonEmployeeApprovalDecision(nonEmployeeApprovalDecision).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest(context.Background(), id).NonEmployeeApprovalDecision(nonEmployeeApprovalDecision).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveNonEmployeeRequest`: NonEmployeeApprovalItem + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest`: %v\n", resp) + } +- path: /non-employee-records + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + beta "github.com/sailpoint-oss/golang-sdk/v2/api_beta" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-Employee record creation request body. + + + var nonEmployeeRequestBody beta.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord`: %v\n", resp) + } +- path: /non-employee-requests + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + beta "github.com/sailpoint-oss/golang-sdk/v2/api_beta" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-Employee creation request body + + + var nonEmployeeRequestBody beta.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeRequest`: NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest`: %v\n", resp) + } +- path: /non-employee-sources + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + 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() { + nonemployeesourcerequestbody := []byte(`{ + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + }`) // NonEmployeeSourceRequestBody | Non-Employee source creation request body. + + + var nonEmployeeSourceRequestBody beta.NonEmployeeSourceRequestBody + if err := json.Unmarshal(nonemployeesourcerequestbody, &nonEmployeeSourceRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource(context.Background()).NonEmployeeSourceRequestBody(nonEmployeeSourceRequestBody).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource(context.Background()).NonEmployeeSourceRequestBody(nonEmployeeSourceRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeSource`: NonEmployeeSourceWithCloudExternalId + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + 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() { + sourceId := `2c91808b6ef1d43e016efba0ce470904` // string | The Source id # string | The Source id + nonemployeeschemaattributebody := []byte(`{ + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + }`) // NonEmployeeSchemaAttributeBody | + + + var nonEmployeeSchemaAttributeBody beta.NonEmployeeSchemaAttributeBody + if err := json.Unmarshal(nonemployeeschemaattributebody, &nonEmployeeSchemaAttributeBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).NonEmployeeSchemaAttributeBody(nonEmployeeSchemaAttributeBody).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).NonEmployeeSchemaAttributeBody(nonEmployeeSchemaAttributeBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeSourceSchemaAttributes`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes`: %v\n", resp) + } +- path: /non-employee-records/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + 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 record id (UUID) # string | Non-Employee record id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord(context.Background(), id).Execute() + //r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-records/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#delete-non-employee-record-in-bulk + source: | + 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() { + deletenonemployeerecordinbulkrequest := []byte(``) // DeleteNonEmployeeRecordInBulkRequest | Non-Employee bulk delete request body. + + + var deleteNonEmployeeRecordInBulkRequest beta.DeleteNonEmployeeRecordInBulkRequest + if err := json.Unmarshal(deletenonemployeerecordinbulkrequest, &deleteNonEmployeeRecordInBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordInBulk(context.Background()).DeleteNonEmployeeRecordInBulkRequest(deleteNonEmployeeRecordInBulkRequest).Execute() + //r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordInBulk(context.Background()).DeleteNonEmployeeRecordInBulkRequest(deleteNonEmployeeRecordInBulkRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-requests/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + 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 request id in the UUID format # string | Non-Employee request id in the UUID format + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest(context.Background(), id).Execute() + //r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + 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() { + attributeId := `2c91808b6ef1d43e016efba0ce470904` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `2c91808b6ef1d43e016efba0ce470904` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + //r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-sources/{sourceId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + 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() { + sourceId := `2c91808b6ef1d43e016efba0ce470904` // string | Source Id # string | Source Id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource(context.Background(), sourceId).Execute() + //r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + 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() { + sourceId := `2c91808b6ef1d43e016efba0ce470904` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + //r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-sources/{id}/non-employees/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + 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 := `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) + } + } +- path: /non-employee-sources/{id}/schema-attributes-template/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + 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 := `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) + } + } +- path: /non-employee-approvals/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + 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 := `ac10d20a-841e-1e7d-8184-32d2e22c0179` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + includeDetail := `include-detail=false` // string | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # string | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval(context.Background(), id).IncludeDetail(includeDetail).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeApproval`: NonEmployeeApprovalItemDetail + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval`: %v\n", resp) + } +- path: /non-employee-approvals/summary/{requested-for} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + 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() { + requestedFor := `ac10d20a-841e-1e7d-8184-32d2e22c0179` // string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary(context.Background(), requestedFor).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary(context.Background(), requestedFor).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeApprovalSummary`: NonEmployeeApprovalSummary + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary`: %v\n", resp) + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + 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 := `2c918085842e69ae018432d22ccb212f` // string | Source ID (UUID) # string | Source ID (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeBulkUploadStatus`: NonEmployeeBulkUploadStatus + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus`: %v\n", resp) + } +- path: /non-employee-records/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + 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 record id (UUID) # string | Non-Employee record id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord`: %v\n", resp) + } +- path: /non-employee-requests/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + 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 request id (UUID) # string | Non-Employee request id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRequest`: NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest`: %v\n", resp) + } +- path: /non-employee-requests/summary/{requested-for} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + 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() { + requestedFor := `ac10d20a-841e-1e7d-8184-32d2e22c0179` // string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary(context.Background(), requestedFor).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary(context.Background(), requestedFor).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRequestSummary`: NonEmployeeRequestSummary + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + 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() { + attributeId := `2c918085842e69ae018432d22ccb212f` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `2c918085842e69ae018432d22ccb212f` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeSchemaAttribute`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + 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() { + sourceId := `2c91808b7c28b350017c2a2ec5790aa1` // string | Source Id # string | Source Id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeSource`: NonEmployeeSource + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + 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() { + sourceId := `2c918085842e69ae018432d22ccb212f` // string | The Source id # string | The Source id + + + + + 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() + 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) + } + // response from `GetNonEmployeeSourceSchemaAttributes`: []NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes`: %v\n", resp) + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + 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 := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id (UUID) # string | Source Id (UUID) + data := BINARY_DATA_HERE // *os.File | # *os.File | + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk(context.Background(), id).Data(data).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk(context.Background(), id).Data(data).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportNonEmployeeRecordsInBulk`: NonEmployeeBulkUploadJob + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk`: %v\n", resp) + } +- path: /non-employee-approvals + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#list-non-employee-approval + source: | + 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() { + requestedFor := `ac10d20a-841e-1e7d-8184-32d2e22c0179` // string | The identity for whom the request was made. *me* indicates the current user. (optional) # string | The identity for whom the request was made. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `approvalStatus eq "PENDING"` // 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: **approvalStatus**: *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: **approvalStatus**: *eq* (optional) + sorters := `created` // 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: **created, modified** (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: **created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ListNonEmployeeApproval(context.Background()).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ListNonEmployeeApproval(context.Background()).RequestedFor(requestedFor).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeApproval`: []NonEmployeeApprovalItem + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeApproval`: %v\n", resp) + } +- path: /non-employee-records + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#list-non-employee-records + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `accountName,sourceId` // 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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + filters := `sourceId eq "2c91808568c529c60168cca6f90c1313"` // 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: **sourceId**: *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: **sourceId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords(context.Background()).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords(context.Background()).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeRecords`: []NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords`: %v\n", resp) + } +- path: /non-employee-requests + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + 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() { + requestedFor := `me` // string | The identity for whom the request was made. *me* indicates the current user. # string | The identity for whom the request was made. *me* indicates the current user. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `approvalStatus,firstName` // 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + filters := `sourceId eq "2c91808568c529c60168cca6f90c1313"` // 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: **sourceId**: *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: **sourceId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests(context.Background()).RequestedFor(requestedFor).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests(context.Background()).RequestedFor(requestedFor).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeRequests`: []NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests`: %v\n", resp) + } +- path: /non-employee-sources + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#list-non-employee-sources + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + requestedFor := `me` // string | Identity the request was made for. Use 'me' to indicate the current user. (optional) # string | Identity the request was made for. Use 'me' to indicate the current user. (optional) + nonEmployeeCount := false // bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) + sorters := `name,created` // 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, created, sourceId** (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, created, sourceId** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources(context.Background()).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources(context.Background()).Limit(limit).Offset(offset).Count(count).RequestedFor(requestedFor).NonEmployeeCount(nonEmployeeCount).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeSources`: []NonEmployeeSourceWithNECount + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources`: %v\n", resp) + } +- path: /non-employee-records/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + 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 record id (UUID) # string | Non-employee record id (UUID) + jsonpatchoperation := []byte(`[{op=replace, path=/endDate, value={2019-08-23T18:40:35.772Z=null}}]`) // []JsonPatchOperation | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + 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() { + attributeId := `2c91808b6ef1d43e016efba0ce470904` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `2c91808b6ef1d43e016efba0ce470904` // string | The Source id # string | The Source id + jsonpatchoperation := []byte(`[{op=replace, path=/label, value={new attribute label=null}}]`) // []JsonPatchOperation | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeSchemaAttribute`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + 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() { + sourceId := `2c91808b6ef1d43e016efba0ce470904` // string | Source Id # string | Source Id + jsonpatchoperation := []byte(`[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}]`) // []JsonPatchOperation | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource(context.Background(), sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource(context.Background(), sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeSource`: NonEmployeeSource + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource`: %v\n", resp) + } +- path: /non-employee-approvals/{id}/reject + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + 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) + } +- path: /non-employee-records/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + 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 record id (UUID) # string | Non-employee record id (UUID) + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + + var nonEmployeeRequestBody beta.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + 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() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord``: %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) + } +- path: /verified-domains + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/notifications#create-domain-dkim + source: | + 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() { + domainaddress := []byte(`{ + "domain" : "sailpoint.com" + }`) // DomainAddress | + + + var domainAddress beta.DomainAddress + if err := json.Unmarshal(domainaddress, &domainAddress); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.CreateDomainDkim(context.Background()).DomainAddress(domainAddress).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.CreateDomainDkim(context.Background()).DomainAddress(domainAddress).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateDomainDkim``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDomainDkim`: DomainStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateDomainDkim`: %v\n", resp) + } +- path: /notification-templates + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/notifications#create-notification-template + source: | + 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() { + templatedto := []byte(`{ + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" + }`) // TemplateDto | + + + var templateDto beta.TemplateDto + if err := json.Unmarshal(templatedto, &templateDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.CreateNotificationTemplate(context.Background()).TemplateDto(templateDto).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.CreateNotificationTemplate(context.Background()).TemplateDto(templateDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateNotificationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNotificationTemplate`: TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateNotificationTemplate`: %v\n", resp) + } +- path: /verified-from-addresses + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/notifications#create-verified-from-address + source: | + 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() { + emailstatusdto := []byte(`{ + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + }`) // EmailStatusDto | + + + var emailStatusDto beta.EmailStatusDto + if err := json.Unmarshal(emailstatusdto, &emailStatusDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.CreateVerifiedFromAddress(context.Background()).EmailStatusDto(emailStatusDto).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.CreateVerifiedFromAddress(context.Background()).EmailStatusDto(emailStatusDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateVerifiedFromAddress``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateVerifiedFromAddress`: EmailStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateVerifiedFromAddress`: %v\n", resp) + } +- path: /notification-templates/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/notifications#delete-notification-templates-in-bulk + source: | + 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() { + templatebulkdeletedto := []byte(``) // []TemplateBulkDeleteDto | + + + var templateBulkDeleteDto beta.[]TemplateBulkDeleteDto + if err := json.Unmarshal(templatebulkdeletedto, &templateBulkDeleteDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NotificationsAPI.DeleteNotificationTemplatesInBulk(context.Background()).TemplateBulkDeleteDto(templateBulkDeleteDto).Execute() + //r, err := apiClient.Beta.NotificationsAPI.DeleteNotificationTemplatesInBulk(context.Background()).TemplateBulkDeleteDto(templateBulkDeleteDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.DeleteNotificationTemplatesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /verified-from-addresses/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/notifications#delete-verified-from-address + source: | + 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 | # string | + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NotificationsAPI.DeleteVerifiedFromAddress(context.Background(), id).Execute() + //r, err := apiClient.Beta.NotificationsAPI.DeleteVerifiedFromAddress(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.DeleteVerifiedFromAddress``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /verified-domains + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/notifications#get-dkim-attributes + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.GetDkimAttributes(context.Background()).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.GetDkimAttributes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetDkimAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDkimAttributes`: []DkimAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetDkimAttributes`: %v\n", resp) + } +- path: /mail-from-attributes/{identityId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/notifications#get-mail-from-attributes + source: | + 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() { + identityId := `bobsmith@sailpoint.com` // string | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # string | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.GetMailFromAttributes(context.Background(), identityId).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.GetMailFromAttributes(context.Background(), identityId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetMailFromAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMailFromAttributes`: MailFromAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetMailFromAttributes`: %v\n", resp) + } +- path: /notification-templates/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/notifications#get-notification-template + source: | + 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 := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Notification Template # string | Id of the Notification Template + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.GetNotificationTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.GetNotificationTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetNotificationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNotificationTemplate`: []TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetNotificationTemplate`: %v\n", resp) + } +- path: /notification-template-context + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/notifications#get-notifications-template-context + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.GetNotificationsTemplateContext(context.Background()).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.GetNotificationsTemplateContext(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetNotificationsTemplateContext``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNotificationsTemplateContext`: NotificationTemplateContext + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetNotificationsTemplateContext`: %v\n", resp) + } +- path: /verified-from-addresses + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/notifications#list-from-addresses + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `email eq "john.doe@company.com"` // 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: **email**: *eq, ge, le, sw* (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: **email**: *eq, ge, le, sw* (optional) + sorters := `email` // 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: **email** (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: **email** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.ListFromAddresses(context.Background()).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.ListFromAddresses(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListFromAddresses``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListFromAddresses`: []EmailStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListFromAddresses`: %v\n", resp) + } +- path: /notification-preferences/{key} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/notifications#list-notification-preferences + source: | + 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() { + key := `cloud_manual_work_item_summary` // string | The notification key. # string | The notification key. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.ListNotificationPreferences(context.Background(), key).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.ListNotificationPreferences(context.Background(), key).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationPreferences``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationPreferences`: []PreferencesDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationPreferences`: %v\n", resp) + } +- path: /notification-template-defaults + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/notifications#list-notification-template-defaults + source: | + 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() { + 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) + filters := `key eq "cloud_manual_work_item_summary"` // 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.ListNotificationTemplateDefaults(context.Background()).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.ListNotificationTemplateDefaults(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationTemplateDefaults``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationTemplateDefaults`: []TemplateDtoDefault + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationTemplateDefaults`: %v\n", resp) + } +- path: /notification-templates + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/notifications#list-notification-templates + source: | + 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() { + 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) + filters := `medium eq "EMAIL"` // 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.ListNotificationTemplates(context.Background()).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.ListNotificationTemplates(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationTemplates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationTemplates`: []TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationTemplates`: %v\n", resp) + } +- path: /mail-from-attributes + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/notifications#put-mail-from-attributes + source: | + 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() { + mailfromattributesdto := []byte(`{ + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + }`) // MailFromAttributesDto | + + + var mailFromAttributesDto beta.MailFromAttributesDto + if err := json.Unmarshal(mailfromattributesdto, &mailFromAttributesDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.NotificationsAPI.PutMailFromAttributes(context.Background()).MailFromAttributesDto(mailFromAttributesDto).Execute() + //resp, r, err := apiClient.Beta.NotificationsAPI.PutMailFromAttributes(context.Background()).MailFromAttributesDto(mailFromAttributesDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.PutMailFromAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutMailFromAttributes`: MailFromAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.PutMailFromAttributes`: %v\n", resp) + } +- path: /send-test-notification + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/notifications#send-test-notification + source: | + 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() { + sendtestnotificationrequestdto := []byte(`{ + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + }`) // SendTestNotificationRequestDto | + + + var sendTestNotificationRequestDto beta.SendTestNotificationRequestDto + if err := json.Unmarshal(sendtestnotificationrequestdto, &sendTestNotificationRequestDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.NotificationsAPI.SendTestNotification(context.Background()).SendTestNotificationRequestDto(sendTestNotificationRequestDto).Execute() + //r, err := apiClient.Beta.NotificationsAPI.SendTestNotification(context.Background()).SendTestNotificationRequestDto(sendTestNotificationRequestDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.SendTestNotification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /oauth-clients + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/o-auth-clients#create-oauth-client + source: | + 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() { + createoauthclientrequest := []byte(`{ + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345", "http://localhost:67890" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + }`) // CreateOAuthClientRequest | + + + var createOAuthClientRequest beta.CreateOAuthClientRequest + if err := json.Unmarshal(createoauthclientrequest, &createOAuthClientRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.OAuthClientsAPI.CreateOauthClient(context.Background()).CreateOAuthClientRequest(createOAuthClientRequest).Execute() + //resp, r, err := apiClient.Beta.OAuthClientsAPI.CreateOauthClient(context.Background()).CreateOAuthClientRequest(createOAuthClientRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.CreateOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateOauthClient`: CreateOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.CreateOauthClient`: %v\n", resp) + } +- path: /oauth-clients/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/o-auth-clients#delete-oauth-client + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.OAuthClientsAPI.DeleteOauthClient(context.Background(), id).Execute() + //r, err := apiClient.Beta.OAuthClientsAPI.DeleteOauthClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.DeleteOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /oauth-clients/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/o-auth-clients#get-oauth-client + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.OAuthClientsAPI.GetOauthClient(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.OAuthClientsAPI.GetOauthClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.GetOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOauthClient`: GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.GetOauthClient`: %v\n", resp) + } +- path: /oauth-clients + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/o-auth-clients#list-oauth-clients + source: | + 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() { + filters := `lastUsed le 2023-02-05T10:59:27.214Z` // 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.OAuthClientsAPI.ListOauthClients(context.Background()).Execute() + //resp, r, err := apiClient.Beta.OAuthClientsAPI.ListOauthClients(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.ListOauthClients``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOauthClients`: []GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.ListOauthClients`: %v\n", resp) + } +- path: /oauth-clients/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/o-auth-clients#patch-oauth-client + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + jsonpatchoperation := []byte(`[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}]`) // []JsonPatchOperation | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.OAuthClientsAPI.PatchOauthClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.OAuthClientsAPI.PatchOauthClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.PatchOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchOauthClient`: GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.PatchOauthClient`: %v\n", resp) + } +- path: /org-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/org-config#get-org-config + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.OrgConfigAPI.GetOrgConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.OrgConfigAPI.GetOrgConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.GetOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOrgConfig`: OrgConfig + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.GetOrgConfig`: %v\n", resp) + } +- path: /org-config/valid-time-zones + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/org-config#get-valid-time-zones + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.OrgConfigAPI.GetValidTimeZones(context.Background()).Execute() + //resp, r, err := apiClient.Beta.OrgConfigAPI.GetValidTimeZones(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.GetValidTimeZones``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetValidTimeZones`: []string + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.GetValidTimeZones`: %v\n", resp) + } +- path: /org-config + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/org-config#patch-org-config + source: | + 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() { + jsonpatchoperation := []byte(`[{op=replace, path=/timeZone, value=America/Toronto}]`) // []JsonPatchOperation | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.OrgConfigAPI.PatchOrgConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.OrgConfigAPI.PatchOrgConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.PatchOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchOrgConfig`: OrgConfig + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.PatchOrgConfig`: %v\n", resp) + } +- path: /password-org-config + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-configuration#create-password-org-config + source: | + 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() { + passwordorgconfig := []byte(`{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }`) // PasswordOrgConfig | + + + var passwordOrgConfig beta.PasswordOrgConfig + if err := json.Unmarshal(passwordorgconfig, &passwordOrgConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordConfigurationAPI.CreatePasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + //resp, r, err := apiClient.Beta.PasswordConfigurationAPI.CreatePasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.CreatePasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.CreatePasswordOrgConfig`: %v\n", resp) + } +- path: /password-org-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-configuration#get-password-org-config + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordConfigurationAPI.GetPasswordOrgConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.PasswordConfigurationAPI.GetPasswordOrgConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.GetPasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.GetPasswordOrgConfig`: %v\n", resp) + } +- path: /password-org-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-configuration#put-password-org-config + source: | + 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() { + passwordorgconfig := []byte(`{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }`) // PasswordOrgConfig | + + + var passwordOrgConfig beta.PasswordOrgConfig + if err := json.Unmarshal(passwordorgconfig, &passwordOrgConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordConfigurationAPI.PutPasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + //resp, r, err := apiClient.Beta.PasswordConfigurationAPI.PutPasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.PutPasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutPasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.PutPasswordOrgConfig`: %v\n", resp) + } +- path: /password-dictionary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-dictionary#get-password-dictionary + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordDictionaryAPI.GetPasswordDictionary(context.Background()).Execute() + //resp, r, err := apiClient.Beta.PasswordDictionaryAPI.GetPasswordDictionary(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordDictionaryAPI.GetPasswordDictionary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordDictionary`: string + fmt.Fprintf(os.Stdout, "Response from `PasswordDictionaryAPI.GetPasswordDictionary`: %v\n", resp) + } +- path: /password-dictionary + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-dictionary#put-password-dictionary + source: | + 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() { + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.PasswordDictionaryAPI.PutPasswordDictionary(context.Background()).Execute() + //r, err := apiClient.Beta.PasswordDictionaryAPI.PutPasswordDictionary(context.Background()).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordDictionaryAPI.PutPasswordDictionary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /generate-password-reset-token/digit + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-management#create-digit-token + source: | + 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() { + passworddigittokenreset := []byte(`{ + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + }`) // PasswordDigitTokenReset | + + + var passwordDigitTokenReset beta.PasswordDigitTokenReset + if err := json.Unmarshal(passworddigittokenreset, &passwordDigitTokenReset); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordManagementAPI.CreateDigitToken(context.Background()).PasswordDigitTokenReset(passwordDigitTokenReset).Execute() + //resp, r, err := apiClient.Beta.PasswordManagementAPI.CreateDigitToken(context.Background()).PasswordDigitTokenReset(passwordDigitTokenReset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.CreateDigitToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDigitToken`: PasswordDigitToken + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.CreateDigitToken`: %v\n", resp) + } +- path: /password-change-status/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-management#get-identity-password-change-status + source: | + 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 | # string | + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordManagementAPI.GetIdentityPasswordChangeStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.PasswordManagementAPI.GetIdentityPasswordChangeStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.GetIdentityPasswordChangeStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityPasswordChangeStatus`: PasswordStatus + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.GetIdentityPasswordChangeStatus`: %v\n", resp) + } +- path: /query-password-info + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-management#query-password-info + source: | + 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() { + passwordinfoquerydto := []byte(`{ + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + }`) // PasswordInfoQueryDTO | + + + var passwordInfoQueryDTO beta.PasswordInfoQueryDTO + if err := json.Unmarshal(passwordinfoquerydto, &passwordInfoQueryDTO); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordManagementAPI.QueryPasswordInfo(context.Background()).PasswordInfoQueryDTO(passwordInfoQueryDTO).Execute() + //resp, r, err := apiClient.Beta.PasswordManagementAPI.QueryPasswordInfo(context.Background()).PasswordInfoQueryDTO(passwordInfoQueryDTO).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.QueryPasswordInfo``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `QueryPasswordInfo`: PasswordInfo + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.QueryPasswordInfo`: %v\n", resp) + } +- path: /set-password + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-management#set-identity-password + source: | + 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() { + passwordchangerequest := []byte(`{ + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + }`) // PasswordChangeRequest | + + + var passwordChangeRequest beta.PasswordChangeRequest + if err := json.Unmarshal(passwordchangerequest, &passwordChangeRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordManagementAPI.SetIdentityPassword(context.Background()).PasswordChangeRequest(passwordChangeRequest).Execute() + //resp, r, err := apiClient.Beta.PasswordManagementAPI.SetIdentityPassword(context.Background()).PasswordChangeRequest(passwordChangeRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.SetIdentityPassword``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetIdentityPassword`: PasswordChangeResponse + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.SetIdentityPassword`: %v\n", resp) + } +- path: /password-policies + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-policies#create-password-policy + source: | + 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() { + passwordpolicyv3dto := []byte(`{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }`) // PasswordPolicyV3Dto | + + + var passwordPolicyV3Dto beta.PasswordPolicyV3Dto + if err := json.Unmarshal(passwordpolicyv3dto, &passwordPolicyV3Dto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordPoliciesAPI.CreatePasswordPolicy(context.Background()).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + //resp, r, err := apiClient.Beta.PasswordPoliciesAPI.CreatePasswordPolicy(context.Background()).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.CreatePasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordPolicy`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.CreatePasswordPolicy`: %v\n", resp) + } +- path: /password-policies/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-policies#delete-password-policy + source: | + 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 := `ff808081838d9e9d01838da6a03e0002` // string | The ID of password policy to delete. # string | The ID of password policy to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.PasswordPoliciesAPI.DeletePasswordPolicy(context.Background(), id).Execute() + //r, err := apiClient.Beta.PasswordPoliciesAPI.DeletePasswordPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.DeletePasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /password-policies/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-policies#get-password-policy-by-id + source: | + 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 := `ff808081838d9e9d01838da6a03e0005` // string | The ID of password policy to retrieve. # string | The ID of password policy to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordPoliciesAPI.GetPasswordPolicyById(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.PasswordPoliciesAPI.GetPasswordPolicyById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.GetPasswordPolicyById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordPolicyById`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.GetPasswordPolicyById`: %v\n", resp) + } +- path: /password-policies + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-policies#list-password-policies + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordPoliciesAPI.ListPasswordPolicies(context.Background()).Execute() + //resp, r, err := apiClient.Beta.PasswordPoliciesAPI.ListPasswordPolicies(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.ListPasswordPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPasswordPolicies`: []PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.ListPasswordPolicies`: %v\n", resp) + } +- path: /password-policies/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-policies#set-password-policy + source: | + 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 := `ff808081838d9e9d01838da6a03e0007` // string | The ID of password policy to update. # string | The ID of password policy to update. + passwordpolicyv3dto := []byte(`{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }`) // PasswordPolicyV3Dto | + + + var passwordPolicyV3Dto beta.PasswordPolicyV3Dto + if err := json.Unmarshal(passwordpolicyv3dto, &passwordPolicyV3Dto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordPoliciesAPI.SetPasswordPolicy(context.Background(), id).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + //resp, r, err := apiClient.Beta.PasswordPoliciesAPI.SetPasswordPolicy(context.Background(), id).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.SetPasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetPasswordPolicy`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.SetPasswordPolicy`: %v\n", resp) + } +- path: /password-sync-groups + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-sync-groups#create-password-sync-group + source: | + 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() { + passwordsyncgroup := []byte(`{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }`) // PasswordSyncGroup | + + + var passwordSyncGroup beta.PasswordSyncGroup + if err := json.Unmarshal(passwordsyncgroup, &passwordSyncGroup); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordSyncGroupsAPI.CreatePasswordSyncGroup(context.Background()).PasswordSyncGroup(passwordSyncGroup).Execute() + //resp, r, err := apiClient.Beta.PasswordSyncGroupsAPI.CreatePasswordSyncGroup(context.Background()).PasswordSyncGroup(passwordSyncGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.CreatePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.CreatePasswordSyncGroup`: %v\n", resp) + } +- path: /password-sync-groups/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-sync-groups#delete-password-sync-group + source: | + 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 := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to delete. # string | The ID of password sync group to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.PasswordSyncGroupsAPI.DeletePasswordSyncGroup(context.Background(), id).Execute() + //r, err := apiClient.Beta.PasswordSyncGroupsAPI.DeletePasswordSyncGroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.DeletePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /password-sync-groups/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-sync-groups#get-password-sync-group + source: | + 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 := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to retrieve. # string | The ID of password sync group to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordSyncGroupsAPI.GetPasswordSyncGroup(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.PasswordSyncGroupsAPI.GetPasswordSyncGroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.GetPasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.GetPasswordSyncGroup`: %v\n", resp) + } +- path: /password-sync-groups + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-sync-groups#get-password-sync-groups + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordSyncGroupsAPI.GetPasswordSyncGroups(context.Background()).Execute() + //resp, r, err := apiClient.Beta.PasswordSyncGroupsAPI.GetPasswordSyncGroups(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.GetPasswordSyncGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordSyncGroups`: []PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.GetPasswordSyncGroups`: %v\n", resp) + } +- path: /password-sync-groups/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/password-sync-groups#update-password-sync-group + source: | + 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 := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to update. # string | The ID of password sync group to update. + passwordsyncgroup := []byte(`{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }`) // PasswordSyncGroup | + + + var passwordSyncGroup beta.PasswordSyncGroup + if err := json.Unmarshal(passwordsyncgroup, &passwordSyncGroup); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PasswordSyncGroupsAPI.UpdatePasswordSyncGroup(context.Background(), id).PasswordSyncGroup(passwordSyncGroup).Execute() + //resp, r, err := apiClient.Beta.PasswordSyncGroupsAPI.UpdatePasswordSyncGroup(context.Background(), id).PasswordSyncGroup(passwordSyncGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.UpdatePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.UpdatePasswordSyncGroup`: %v\n", resp) + } +- path: /personal-access-tokens + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/personal-access-tokens#create-personal-access-token + source: | + 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() { + createpersonalaccesstokenrequest := []byte(`{ + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + }`) // CreatePersonalAccessTokenRequest | Name and scope of personal access token. + + + var createPersonalAccessTokenRequest beta.CreatePersonalAccessTokenRequest + if err := json.Unmarshal(createpersonalaccesstokenrequest, &createPersonalAccessTokenRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PersonalAccessTokensAPI.CreatePersonalAccessToken(context.Background()).CreatePersonalAccessTokenRequest(createPersonalAccessTokenRequest).Execute() + //resp, r, err := apiClient.Beta.PersonalAccessTokensAPI.CreatePersonalAccessToken(context.Background()).CreatePersonalAccessTokenRequest(createPersonalAccessTokenRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.CreatePersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePersonalAccessToken`: CreatePersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.CreatePersonalAccessToken`: %v\n", resp) + } +- path: /personal-access-tokens/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/personal-access-tokens#delete-personal-access-token + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The personal access token id # string | The personal access token id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.PersonalAccessTokensAPI.DeletePersonalAccessToken(context.Background(), id).Execute() + //r, err := apiClient.Beta.PersonalAccessTokensAPI.DeletePersonalAccessToken(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.DeletePersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /personal-access-tokens + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/personal-access-tokens#list-personal-access-tokens + source: | + 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() { + ownerId := `2c9180867b50d088017b554662fb281e` // string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) # string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + filters := `lastUsed le 2023-02-05T10:59:27.214Z` // 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PersonalAccessTokensAPI.ListPersonalAccessTokens(context.Background()).Execute() + //resp, r, err := apiClient.Beta.PersonalAccessTokensAPI.ListPersonalAccessTokens(context.Background()).OwnerId(ownerId).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.ListPersonalAccessTokens``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPersonalAccessTokens`: []GetPersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.ListPersonalAccessTokens`: %v\n", resp) + } +- path: /personal-access-tokens/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/personal-access-tokens#patch-personal-access-token + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The Personal Access Token id # string | The Personal Access Token id + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}]`) // []JsonPatchOperation | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PersonalAccessTokensAPI.PatchPersonalAccessToken(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.PersonalAccessTokensAPI.PatchPersonalAccessToken(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.PatchPersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPersonalAccessToken`: GetPersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.PatchPersonalAccessToken`: %v\n", resp) + } +- path: /public-identities-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/public-identities-config#get-public-identity-config + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PublicIdentitiesConfigAPI.GetPublicIdentityConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.PublicIdentitiesConfigAPI.GetPublicIdentityConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesConfigAPI.GetPublicIdentityConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPublicIdentityConfig`: PublicIdentityConfig + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesConfigAPI.GetPublicIdentityConfig`: %v\n", resp) + } +- path: /public-identities-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/public-identities-config#update-public-identity-config + source: | + 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() { + publicidentityconfig := []byte(`{ + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }`) // PublicIdentityConfig | + + + var publicIdentityConfig beta.PublicIdentityConfig + if err := json.Unmarshal(publicidentityconfig, &publicIdentityConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig(context.Background()).PublicIdentityConfig(publicIdentityConfig).Execute() + //resp, r, err := apiClient.Beta.PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig(context.Background()).PublicIdentityConfig(publicIdentityConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePublicIdentityConfig`: PublicIdentityConfig + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig`: %v\n", resp) + } +- path: /requestable-objects + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/requestable-objects#list-requestable-objects + source: | + 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() { + 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) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw "bob"` // 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, in, sw* (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, in, sw* (optional) + sorters := `name` // 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** (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** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RequestableObjectsAPI.ListRequestableObjects(context.Background()).Execute() + //resp, r, err := apiClient.Beta.RequestableObjectsAPI.ListRequestableObjects(context.Background()).IdentityId(identityId).Types(types).Term(term).Statuses(statuses).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RequestableObjectsAPI.ListRequestableObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListRequestableObjects`: []RequestableObject + fmt.Fprintf(os.Stdout, "Response from `RequestableObjectsAPI.ListRequestableObjects`: %v\n", resp) + } +- path: /role-insights/requests + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/role-insights#create-role-insight-requests + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.CreateRoleInsightRequests(context.Background()).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.CreateRoleInsightRequests(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.CreateRoleInsightRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRoleInsightRequests`: RoleInsightsResponse + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.CreateRoleInsightRequests`: %v\n", resp) + } +- path: /role-insights/{insightId}/entitlement-changes/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/role-insights#download-role-insights-entitlements-changes + source: | + 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() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight id + sorters := `identitiesWithAccess` // 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + filters := `name sw "r"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges(context.Background(), insightId).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges(context.Background(), insightId).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DownloadRoleInsightsEntitlementsChanges`: string + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges`: %v\n", resp) + } +- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/role-insights#get-entitlement-changes-identities + source: | + 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() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight id + entitlementId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The entitlement id # string | The entitlement id + hasEntitlement := true // bool | Identity has this entitlement or not (optional) (default to false) # bool | Identity has this entitlement or not (optional) (default to false) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name` // 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** (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** (optional) + filters := `name sw "Jan"` // 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: **name**: *sw* (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: **name**: *sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.GetEntitlementChangesIdentities(context.Background(), insightId, entitlementId).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.GetEntitlementChangesIdentities(context.Background(), insightId, entitlementId).HasEntitlement(hasEntitlement).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetEntitlementChangesIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementChangesIdentities`: []RoleInsightsIdentities + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetEntitlementChangesIdentities`: %v\n", resp) + } +- path: /role-insights/{insightId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/role-insights#get-role-insight + source: | + 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() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsight(context.Background(), insightId).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsight(context.Background(), insightId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsight``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsight`: RoleInsight + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsight`: %v\n", resp) + } +- path: /role-insights + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/role-insights#get-role-insights + source: | + 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() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `numberOfUpdates` // 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + filters := `name sw "John"` // 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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsights(context.Background()).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsights(context.Background()).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsights``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsights`: []RoleInsight + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsights`: %v\n", resp) + } +- path: /role-insights/{insightId}/current-entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/role-insights#get-role-insights-current-entitlements + source: | + 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() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight id + filters := `name sw "r"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsightsCurrentEntitlements(context.Background(), insightId).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsightsCurrentEntitlements(context.Background(), insightId).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsCurrentEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsCurrentEntitlements`: []RoleInsightsEntitlement + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsCurrentEntitlements`: %v\n", resp) + } +- path: /role-insights/{insightId}/entitlement-changes + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/role-insights#get-role-insights-entitlements-changes + source: | + 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() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight id + sorters := `sorters_example` // 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: **identitiesWithAccess, name** (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: **identitiesWithAccess, name** (optional) + filters := `name sw "Admin"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsightsEntitlementsChanges(context.Background(), insightId).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsightsEntitlementsChanges(context.Background(), insightId).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsEntitlementsChanges``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsEntitlementsChanges`: []RoleInsightsEntitlementChanges + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsEntitlementsChanges`: %v\n", resp) + } +- path: /role-insights/requests/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/role-insights#get-role-insights-requests + source: | + 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 := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insights request id # string | The role insights request id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsightsRequests(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsightsRequests(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsRequests`: RoleInsightsResponse + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsRequests`: %v\n", resp) + } +- path: /role-insights/summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/role-insights#get-role-insights-summary + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsightsSummary(context.Background()).Execute() + //resp, r, err := apiClient.Beta.RoleInsightsAPI.GetRoleInsightsSummary(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsSummary`: RoleInsightsSummary + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsSummary`: %v\n", resp) + } +- path: /roles + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/roles#create-role + source: | + 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() { + role := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + }`) // Role | + + + var role beta.Role + if err := json.Unmarshal(role, &role); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RolesAPI.CreateRole(context.Background()).Role(role).Execute() + //resp, r, err := apiClient.Beta.RolesAPI.CreateRole(context.Background()).Role(role).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.CreateRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.CreateRole`: %v\n", resp) + } +- path: /roles/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/roles#delete-bulk-roles + source: | + 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() { + rolebulkdeleterequest := []byte(`{ + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + }`) // RoleBulkDeleteRequest | + + + var roleBulkDeleteRequest beta.RoleBulkDeleteRequest + if err := json.Unmarshal(rolebulkdeleterequest, &roleBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RolesAPI.DeleteBulkRoles(context.Background()).RoleBulkDeleteRequest(roleBulkDeleteRequest).Execute() + //resp, r, err := apiClient.Beta.RolesAPI.DeleteBulkRoles(context.Background()).RoleBulkDeleteRequest(roleBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteBulkRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteBulkRoles`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.DeleteBulkRoles`: %v\n", resp) + } +- path: /roles/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/roles#delete-role + source: | + 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 := `2c91808a7813090a017814121e121518` // string | ID of the Role # string | ID of the Role + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.RolesAPI.DeleteRole(context.Background(), id).Execute() + //r, err := apiClient.Beta.RolesAPI.DeleteRole(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /roles/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/roles#get-role + source: | + 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 := `2c91808a7813090a017814121e121518` // string | ID of the Role # string | ID of the Role + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RolesAPI.GetRole(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.RolesAPI.GetRole(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRole`: %v\n", resp) + } +- path: /roles/{id}/assigned-identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/roles#get-role-assigned-identities + source: | + 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 := `2c91808a7813090a017814121e121518` // string | ID of the Role for which the assigned Identities are to be listed # string | ID of the Role for which the assigned Identities are to be listed + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw Joe` // 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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + sorters := `aliasName,name` // 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: **id, name, aliasName, email** (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: **id, name, aliasName, email** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RolesAPI.GetRoleAssignedIdentities(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.RolesAPI.GetRoleAssignedIdentities(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRoleAssignedIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleAssignedIdentities`: []RoleIdentity + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRoleAssignedIdentities`: %v\n", resp) + } +- path: /roles/{id}/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/roles#get-role-entitlements + source: | + 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 := `2c91808a7813090a017814121919ecca` // string | Containing role's ID. # string | Containing role's ID. + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RolesAPI.GetRoleEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.RolesAPI.GetRoleEntitlements(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRoleEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRoleEntitlements`: %v\n", resp) + } +- path: /roles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/roles#list-roles + source: | + 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() { + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `requestable 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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RolesAPI.ListRoles(context.Background()).Execute() + //resp, r, err := apiClient.Beta.RolesAPI.ListRoles(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.ListRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListRoles`: []Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.ListRoles`: %v\n", resp) + } +- path: /roles/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/roles#patch-role + source: | + 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 := `2c91808a7813090a017814121e121518` // string | ID of the Role to patch # string | ID of the Role to patch + jsonpatchoperation := []byte(`[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]`) // []JsonPatchOperation | + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.RolesAPI.PatchRole(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.RolesAPI.PatchRole(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.PatchRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.PatchRole`: %v\n", resp) + } +- path: /accounts/search-attribute-config + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + 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() { + searchattributeconfig := []byte(`{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }`) // SearchAttributeConfig | + + + var searchAttributeConfig beta.SearchAttributeConfig + if err := json.Unmarshal(searchattributeconfig, &searchAttributeConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SearchAttributeConfigurationAPI.CreateSearchAttributeConfig(context.Background()).SearchAttributeConfig(searchAttributeConfig).Execute() + //resp, r, err := apiClient.Beta.SearchAttributeConfigurationAPI.CreateSearchAttributeConfig(context.Background()).SearchAttributeConfig(searchAttributeConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.CreateSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSearchAttributeConfig`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.CreateSearchAttributeConfig`: %v\n", resp) + } +- path: /accounts/search-attribute-config/{name} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + 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() { + name := `newMailAttribute` // string | Name of the extended search attribute configuration to delete. # string | Name of the extended search attribute configuration to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig(context.Background(), name).Execute() + //r, err := apiClient.Beta.SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /accounts/search-attribute-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + 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() { + 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.SearchAttributeConfigurationAPI.GetSearchAttributeConfig(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SearchAttributeConfigurationAPI.GetSearchAttributeConfig(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.GetSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSearchAttributeConfig`: []SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.GetSearchAttributeConfig`: %v\n", resp) + } +- path: /accounts/search-attribute-config/{name} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + 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() { + name := `newMailAttribute` // string | Name of the extended search attribute configuration to get. # string | Name of the extended search attribute configuration to get. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig(context.Background(), name).Execute() + //resp, r, err := apiClient.Beta.SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSingleSearchAttributeConfig`: []SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig`: %v\n", resp) + } +- path: /accounts/search-attribute-config/{name} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + 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() { + name := `promotedMailAttribute` // string | Name of the extended search attribute configuration to patch. # string | Name of the extended search attribute configuration to patch. + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]`) // []JsonPatchOperation | + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SearchAttributeConfigurationAPI.PatchSearchAttributeConfig(context.Background(), name).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.SearchAttributeConfigurationAPI.PatchSearchAttributeConfig(context.Background(), name).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.PatchSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSearchAttributeConfig`: SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.PatchSearchAttributeConfig`: %v\n", resp) + } +- path: /segments + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/segments#create-segment + source: | + 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() { + segment := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }`) // Segment | + + + var segment beta.Segment + if err := json.Unmarshal(segment, &segment); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SegmentsAPI.CreateSegment(context.Background()).Segment(segment).Execute() + //resp, r, err := apiClient.Beta.SegmentsAPI.CreateSegment(context.Background()).Segment(segment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.CreateSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.CreateSegment`: %v\n", resp) + } +- path: /segments/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/segments#delete-segment + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to delete. # string | The segment ID to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SegmentsAPI.DeleteSegment(context.Background(), id).Execute() + //r, err := apiClient.Beta.SegmentsAPI.DeleteSegment(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.DeleteSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /segments/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/segments#get-segment + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to retrieve. # string | The segment ID to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SegmentsAPI.GetSegment(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SegmentsAPI.GetSegment(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.GetSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.GetSegment`: %v\n", resp) + } +- path: /segments + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/segments#list-segments + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SegmentsAPI.ListSegments(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SegmentsAPI.ListSegments(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.ListSegments``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSegments`: []Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.ListSegments`: %v\n", resp) + } +- path: /segments/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/segments#patch-segment + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to modify. # string | The segment ID to modify. + requestbody := []byte(`[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]`) // []map[string]interface{} | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + + + var requestBody beta.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SegmentsAPI.PatchSegment(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.Beta.SegmentsAPI.PatchSegment(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.PatchSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.PatchSegment`: %v\n", resp) + } +- path: /service-desk-integrations + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/service-desk-integration#create-service-desk-integration + source: | + 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() { + servicedeskintegrationdto := []byte(`{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + }`) // ServiceDeskIntegrationDto | The specifics of a new integration to create + + + var serviceDeskIntegrationDto beta.ServiceDeskIntegrationDto + if err := json.Unmarshal(servicedeskintegrationdto, &serviceDeskIntegrationDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.CreateServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.CreateServiceDeskIntegration`: %v\n", resp) + } +- path: /service-desk-integrations/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + 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 := `anId` // string | ID of Service Desk integration to delete # string | ID of Service Desk integration to delete + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration(context.Background(), id).Execute() + //r, err := apiClient.Beta.ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /service-desk-integrations/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/service-desk-integration#get-service-desk-integration + source: | + 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 := `anId` // string | ID of the Service Desk integration to get # string | ID of the Service Desk integration to get + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetServiceDeskIntegration(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetServiceDeskIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegration`: %v\n", resp) + } +- path: /service-desk-integrations + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/service-desk-integration#get-service-desk-integration-list + source: | + 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() { + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `id eq 2c91808b6ef1d43e016efba0ce470904` // 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* **type**: *eq, in* **cluster**: *eq, in* (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* **type**: *eq, in* **cluster**: *eq, in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationList(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationList(context.Background()).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationList`: []ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationList`: %v\n", resp) + } +- path: /service-desk-integrations/templates/{scriptName} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + 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() { + scriptName := `aScriptName` // string | The scriptName value of the Service Desk integration template to get # string | The scriptName value of the Service Desk integration template to get + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationTemplate`: ServiceDeskIntegrationTemplateDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate`: %v\n", resp) + } +- path: /service-desk-integrations/types + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationTypes`: []ServiceDeskIntegrationTemplateType + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes`: %v\n", resp) + } +- path: /service-desk-integrations/status-check-configuration + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/service-desk-integration#get-status-check-details + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetStatusCheckDetails(context.Background()).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.GetStatusCheckDetails(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetStatusCheckDetails``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetStatusCheckDetails`: QueuedCheckConfigDetails + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetStatusCheckDetails`: %v\n", resp) + } +- path: /service-desk-integrations/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + 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 := `anId` // string | ID of the Service Desk integration to update # string | ID of the Service Desk integration to update + jsonpatchoperation := []byte(``) // []JsonPatchOperation | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.PatchServiceDeskIntegration(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.PatchServiceDeskIntegration(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.PatchServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.PatchServiceDeskIntegration`: %v\n", resp) + } +- path: /service-desk-integrations/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/service-desk-integration#put-service-desk-integration + source: | + 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 := `anId` // string | ID of the Service Desk integration to update # string | ID of the Service Desk integration to update + servicedeskintegrationdto := []byte(`{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + }`) // ServiceDeskIntegrationDto | The specifics of the integration to update + + + var serviceDeskIntegrationDto beta.ServiceDeskIntegrationDto + if err := json.Unmarshal(servicedeskintegrationdto, &serviceDeskIntegrationDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.PutServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.PutServiceDeskIntegration`: %v\n", resp) + } +- path: /service-desk-integrations/status-check-configuration + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/service-desk-integration#update-status-check-details + source: | + 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() { + queuedcheckconfigdetails := []byte(`{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + }`) // QueuedCheckConfigDetails | The modified time check configuration + + + var queuedCheckConfigDetails beta.QueuedCheckConfigDetails + if err := json.Unmarshal(queuedcheckconfigdetails, &queuedCheckConfigDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute() + //resp, r, err := apiClient.Beta.ServiceDeskIntegrationAPI.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.UpdateStatusCheckDetails``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateStatusCheckDetails`: QueuedCheckConfigDetails + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.UpdateStatusCheckDetails`: %v\n", resp) + } +- path: /sim-integrations + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sim-integrations#create-sim-integration + source: | + 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() { + simintegrationdetails := []byte(`{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }`) // SimIntegrationDetails | DTO containing the details of the SIM integration + + + var simIntegrationDetails beta.SimIntegrationDetails + if err := json.Unmarshal(simintegrationdetails, &simIntegrationDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SIMIntegrationsAPI.CreateSIMIntegration(context.Background()).SimIntegrationDetails(simIntegrationDetails).Execute() + //resp, r, err := apiClient.Beta.SIMIntegrationsAPI.CreateSIMIntegration(context.Background()).SimIntegrationDetails(simIntegrationDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.CreateSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.CreateSIMIntegration`: %v\n", resp) + } +- path: /sim-integrations/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sim-integrations#delete-sim-integration + source: | + 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 := `12345` // string | The id of the integration to delete. # string | The id of the integration to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SIMIntegrationsAPI.DeleteSIMIntegration(context.Background(), id).Execute() + //r, err := apiClient.Beta.SIMIntegrationsAPI.DeleteSIMIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.DeleteSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sim-integrations/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sim-integrations#get-sim-integration + source: | + 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 := `12345` // string | The id of the integration. # string | The id of the integration. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SIMIntegrationsAPI.GetSIMIntegration(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SIMIntegrationsAPI.GetSIMIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.GetSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.GetSIMIntegration`: %v\n", resp) + } +- path: /sim-integrations + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sim-integrations#get-sim-integrations + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SIMIntegrationsAPI.GetSIMIntegrations(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SIMIntegrationsAPI.GetSIMIntegrations(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.GetSIMIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSIMIntegrations`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.GetSIMIntegrations`: %v\n", resp) + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sim-integrations#patch-before-provisioning-rule + source: | + 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 := `12345` // string | SIM integration id # string | SIM integration id + jsonpatch := []byte(`"[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]"`) // JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + + + var jsonPatch beta.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SIMIntegrationsAPI.PatchBeforeProvisioningRule(context.Background(), id).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.Beta.SIMIntegrationsAPI.PatchBeforeProvisioningRule(context.Background(), id).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PatchBeforeProvisioningRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchBeforeProvisioningRule`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PatchBeforeProvisioningRule`: %v\n", resp) + } +- path: /sim-integrations/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sim-integrations#patch-sim-attributes + source: | + 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 := `12345` // string | SIM integration id # string | SIM integration id + jsonpatch := []byte(`"[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]"`) // JsonPatch | The JsonPatch object that describes the changes of SIM + + + var jsonPatch beta.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SIMIntegrationsAPI.PatchSIMAttributes(context.Background(), id).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.Beta.SIMIntegrationsAPI.PatchSIMAttributes(context.Background(), id).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PatchSIMAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSIMAttributes`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PatchSIMAttributes`: %v\n", resp) + } +- path: /sim-integrations/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sim-integrations#put-sim-integration + source: | + 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 := `12345` // string | The id of the integration. # string | The id of the integration. + simintegrationdetails := []byte(`{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }`) // SimIntegrationDetails | The full DTO of the integration containing the updated model + + + var simIntegrationDetails beta.SimIntegrationDetails + if err := json.Unmarshal(simintegrationdetails, &simIntegrationDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SIMIntegrationsAPI.PutSIMIntegration(context.Background(), id).SimIntegrationDetails(simIntegrationDetails).Execute() + //resp, r, err := apiClient.Beta.SIMIntegrationsAPI.PutSIMIntegration(context.Background(), id).SimIntegrationDetails(simIntegrationDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PutSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PutSIMIntegration`: %v\n", resp) + } +- path: /sod-policies + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-policies#create-sod-policy + source: | + 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() { + sodpolicy := []byte(`{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }`) // SodPolicy | + + + var sodPolicy beta.SodPolicy + if err := json.Unmarshal(sodpolicy, &sodPolicy); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.CreateSodPolicy(context.Background()).SodPolicy(sodPolicy).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.CreateSodPolicy(context.Background()).SodPolicy(sodPolicy).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.CreateSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.CreateSodPolicy`: %v\n", resp) + } +- path: /sod-policies/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-policies#delete-sod-policy + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the SOD Policy to delete. # string | The ID of the SOD Policy to delete. + logical := true // bool | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to true) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SODPoliciesAPI.DeleteSodPolicy(context.Background(), id).Execute() + //r, err := apiClient.Beta.SODPoliciesAPI.DeleteSodPolicy(context.Background(), id).Logical(logical).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.DeleteSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sod-policies/{id}/schedule + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-policies#delete-sod-policy-schedule + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the SOD policy the schedule must be deleted for. # string | The ID of the SOD policy the schedule must be deleted for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SODPoliciesAPI.DeleteSodPolicySchedule(context.Background(), id).Execute() + //r, err := apiClient.Beta.SODPoliciesAPI.DeleteSodPolicySchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.DeleteSodPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-policies#get-custom-violation-report + source: | + 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() { + reportResultId := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the report reference to download. # string | The ID of the report reference to download. + fileName := `custom-name` // string | Custom Name for the file. # string | Custom Name for the file. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.GetCustomViolationReport(context.Background(), reportResultId, fileName).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.GetCustomViolationReport(context.Background(), reportResultId, fileName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetCustomViolationReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCustomViolationReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetCustomViolationReport`: %v\n", resp) + } +- path: /sod-violation-report/{reportResultId}/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-policies#get-default-violation-report + source: | + 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() { + reportResultId := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the report reference to download. # string | The ID of the report reference to download. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.GetDefaultViolationReport(context.Background(), reportResultId).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.GetDefaultViolationReport(context.Background(), reportResultId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetDefaultViolationReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDefaultViolationReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetDefaultViolationReport`: %v\n", resp) + } +- path: /sod-violation-report + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-policies#get-sod-all-report-run-status + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodAllReportRunStatus(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodAllReportRunStatus(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodAllReportRunStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodAllReportRunStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodAllReportRunStatus`: %v\n", resp) + } +- path: /sod-policies/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-policies#get-sod-policy + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to retrieve. # string | The ID of the object reference to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodPolicy`: %v\n", resp) + } +- path: /sod-policies/{id}/schedule + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-policies#get-sod-policy-schedule + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to retrieve. # string | The ID of the object reference to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodPolicySchedule(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodPolicySchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodPolicySchedule`: SodPolicySchedule + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodPolicySchedule`: %v\n", resp) + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-policies#get-sod-violation-report-run-status + source: | + 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() { + reportResultId := `2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | The ID of the report reference to retrieve. # string | The ID of the report reference to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodViolationReportRunStatus(context.Background(), reportResultId).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodViolationReportRunStatus(context.Background(), reportResultId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodViolationReportRunStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodViolationReportRunStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodViolationReportRunStatus`: %v\n", resp) + } +- path: /sod-policies/{id}/violation-report + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-policies#get-sod-violation-report-status + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to retrieve. # string | The ID of the object reference to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodViolationReportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.GetSodViolationReportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodViolationReportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodViolationReportStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodViolationReportStatus`: %v\n", resp) + } +- path: /sod-policies + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-policies#list-sod-policies + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "bc693f07e7b645539626c25954c58554"` // 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, in* **state**: *eq, in* (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, in* **state**: *eq, in* (optional) + sorters := `id,name` // 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: **id, name, created, modified, description** (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: **id, name, created, modified, description** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.ListSodPolicies(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.ListSodPolicies(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.ListSodPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSodPolicies`: []SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.ListSodPolicies`: %v\n", resp) + } +- path: /sod-policies/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-policies#patch-sod-policy + source: | + 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 := `2c9180835d191a86015d28455b4a2329` // string | The ID of the SOD policy being modified. # string | The ID of the SOD policy being modified. + requestbody := []byte(`[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]`) // []map[string]interface{} | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + + + var requestBody beta.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.PatchSodPolicy(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.PatchSodPolicy(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PatchSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PatchSodPolicy`: %v\n", resp) + } +- path: /sod-policies/{id}/schedule + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-policies#put-policy-schedule + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the SOD policy to update its schedule. # string | The ID of the SOD policy to update its schedule. + sodpolicyschedule := []byte(`{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }`) // SodPolicySchedule | + + + var sodPolicySchedule beta.SodPolicySchedule + if err := json.Unmarshal(sodpolicyschedule, &sodPolicySchedule); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.PutPolicySchedule(context.Background(), id).SodPolicySchedule(sodPolicySchedule).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.PutPolicySchedule(context.Background(), id).SodPolicySchedule(sodPolicySchedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PutPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutPolicySchedule`: SodPolicySchedule + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PutPolicySchedule`: %v\n", resp) + } +- path: /sod-policies/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-policies#put-sod-policy + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the SOD policy to update. # string | The ID of the SOD policy to update. + sodpolicy := []byte(`{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }`) // SodPolicy | + + + var sodPolicy beta.SodPolicy + if err := json.Unmarshal(sodpolicy, &sodPolicy); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.PutSodPolicy(context.Background(), id).SodPolicy(sodPolicy).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.PutSodPolicy(context.Background(), id).SodPolicy(sodPolicy).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PutSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PutSodPolicy`: %v\n", resp) + } +- path: /sod-violation-report/run + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-policies#start-sod-all-policies-for-org + source: | + 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() { + multipolicyrequest := []byte(`{ + "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] + }`) // MultiPolicyRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.StartSodAllPoliciesForOrg(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.StartSodAllPoliciesForOrg(context.Background()).MultiPolicyRequest(multiPolicyRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartSodAllPoliciesForOrg``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartSodAllPoliciesForOrg`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartSodAllPoliciesForOrg`: %v\n", resp) + } +- path: /sod-policies/{id}/violation-report/run + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-policies#start-sod-policy + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The SOD policy ID to run. # string | The SOD policy ID to run. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODPoliciesAPI.StartSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SODPoliciesAPI.StartSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartSodPolicy`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartSodPolicy`: %v\n", resp) + } +- path: /sod-violations/predict + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sod-violations#start-predict-sod-violations + source: | + 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() { + identitywithnewaccess := []byte(`{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }`) // IdentityWithNewAccess | + + + var identityWithNewAccess beta.IdentityWithNewAccess + if err := json.Unmarshal(identitywithnewaccess, &identityWithNewAccess); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SODViolationsAPI.StartPredictSodViolations(context.Background()).IdentityWithNewAccess(identityWithNewAccess).Execute() + //resp, r, err := apiClient.Beta.SODViolationsAPI.StartPredictSodViolations(context.Background()).IdentityWithNewAccess(identityWithNewAccess).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODViolationsAPI.StartPredictSodViolations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartPredictSodViolations`: ViolationPrediction + fmt.Fprintf(os.Stdout, "Response from `SODViolationsAPI.StartPredictSodViolations`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#create-provisioning-policy + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id # string | The Source id + provisioningpolicydto := []byte(`{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }`) // ProvisioningPolicyDto | + + + var provisioningPolicyDto beta.ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.CreateProvisioningPolicy(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.CreateProvisioningPolicy(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateProvisioningPolicy`: %v\n", resp) + } +- path: /sources + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#create-source + source: | + 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() { + source := []byte(`{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }`) // Source | + provisionAsCsv := false // bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + + var source beta.Source + if err := json.Unmarshal(source, &source); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.CreateSource(context.Background()).Source(source).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.CreateSource(context.Background()).Source(source).ProvisionAsCsv(provisionAsCsv).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSource`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#create-source-schema + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + schema := []byte(`{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + }`) // Schema | + + + var schema beta.Schema + if err := json.Unmarshal(schema, &schema); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.CreateSourceSchema(context.Background(), sourceId).Schema(schema).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.CreateSourceSchema(context.Background(), sourceId).Schema(schema).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSourceSchema`: %v\n", resp) + } +- path: /sources/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#delete + source: | + 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 := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.Delete(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.Delete(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.Delete``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `Delete`: Delete202Response + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.Delete`: %v\n", resp) + } +- path: /sources/{sourceId}/remove-accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#delete-accounts-async + source: | + 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() { + sourceId := `ebbf35756e1140699ce52b233121384a` // string | The source id # string | The source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.DeleteAccountsAsync(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.DeleteAccountsAsync(context.Background(), sourceId).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) + } + // response from `DeleteAccountsAsync`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.DeleteAccountsAsync`: %v\n", resp) + } +- path: /sources/{sourceId}/native-change-detection-config + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#delete-native-change-detection-config + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SourcesAPI.DeleteNativeChangeDetectionConfig(context.Background(), sourceId).Execute() + //r, err := apiClient.Beta.SourcesAPI.DeleteNativeChangeDetectionConfig(context.Background(), sourceId).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) + } + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#delete-provisioning-policy + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SourcesAPI.DeleteProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + //r, err := apiClient.Beta.SourcesAPI.DeleteProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#delete-source-schema + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema ID. # string | The Schema ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SourcesAPI.DeleteSourceSchema(context.Background(), sourceId, schemaId).Execute() + //r, err := apiClient.Beta.SourcesAPI.DeleteSourceSchema(context.Background(), sourceId, schemaId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{sourceId}/correlation-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#get-correlation-config + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetCorrelationConfig(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetCorrelationConfig(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCorrelationConfig`: CorrelationConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetCorrelationConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/native-change-detection-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#get-native-change-detection-config + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetNativeChangeDetectionConfig(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetNativeChangeDetectionConfig(context.Background(), sourceId).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) + } + // response from `GetNativeChangeDetectionConfig`: NativeChangeDetectionConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetNativeChangeDetectionConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#get-provisioning-policy + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetProvisioningPolicy`: %v\n", resp) + } +- path: /sources/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#get-source + source: | + 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 := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetSource(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetSource(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSource`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas/accounts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#get-source-accounts-schema + source: | + 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() { + sourceId := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SourcesAPI.GetSourceAccountsSchema(context.Background(), sourceId).Execute() + //r, err := apiClient.Beta.SourcesAPI.GetSourceAccountsSchema(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceAccountsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{id}/attribute-sync-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#get-source-attr-sync-config + source: | + 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 := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetSourceAttrSyncConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetSourceAttrSyncConfig(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceAttrSyncConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceAttrSyncConfig`: AttrSyncSourceConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceAttrSyncConfig`: %v\n", resp) + } +- path: /sources/{id}/connectors/source-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#get-source-config + source: | + 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 | The Source id # string | The Source id + locale := `locale_example` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetSourceConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetSourceConfig(context.Background(), id).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceConfig`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/entitlement-request-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#get-source-entitlement-request-config + source: | + 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() { + sourceId := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetSourceEntitlementRequestConfig(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetSourceEntitlementRequestConfig(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceEntitlementRequestConfig`: SourceEntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceEntitlementRequestConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#get-source-entitlements-schema + source: | + 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() { + sourceId := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + schemaName := `?schemaName=group` // string | Name of entitlement schema (optional) # string | Name of entitlement schema (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.SourcesAPI.GetSourceEntitlementsSchema(context.Background(), sourceId).Execute() + //r, err := apiClient.Beta.SourcesAPI.GetSourceEntitlementsSchema(context.Background(), sourceId).SchemaName(schemaName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceEntitlementsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#get-source-schema + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema ID. # string | The Schema ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetSourceSchema(context.Background(), sourceId, schemaId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetSourceSchema(context.Background(), sourceId, schemaId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchema`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#get-source-schemas + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + includeTypes := `group` // string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) # string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + includeNames := `account` // string | A comma-separated list of schema names to filter result. (optional) # string | A comma-separated list of schema names to filter result. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).IncludeTypes(includeTypes).IncludeNames(includeNames).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchemas``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchemas`: []Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchemas`: %v\n", resp) + } +- path: /sources/{sourceId}/load-accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#import-accounts + source: | + 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() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | Source Id # string | Source Id + 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) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.ImportAccounts(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.ImportAccounts(context.Background(), sourceId).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) + } + // response from `ImportAccounts`: LoadAccountsTask + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportAccounts`: %v\n", resp) + } +- path: /sources/{sourceId}/load-entitlements + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#import-entitlements + source: | + 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() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | Source Id # string | Source Id + 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.Beta.SourcesAPI.ImportEntitlements(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.ImportEntitlements(context.Background(), sourceId).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) + } +- path: /sources/{sourceId}/schemas/accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#import-source-accounts-schema + source: | + 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() { + sourceId := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.ImportSourceAccountsSchema(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.ImportSourceAccountsSchema(context.Background(), sourceId).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportSourceAccountsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportSourceAccountsSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportSourceAccountsSchema`: %v\n", resp) + } +- path: /sources/{sourceId}/upload-connector-file + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#import-source-connector-file + source: | + 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() { + sourceId := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.ImportSourceConnectorFile(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.ImportSourceConnectorFile(context.Background(), sourceId).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportSourceConnectorFile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportSourceConnectorFile`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportSourceConnectorFile`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas/entitlements + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#import-source-entitlements-schema + source: | + 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() { + sourceId := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + schemaName := `?schemaName=group` // string | Name of entitlement schema (optional) # string | Name of entitlement schema (optional) + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.ImportSourceEntitlementsSchema(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.ImportSourceEntitlementsSchema(context.Background(), sourceId).SchemaName(schemaName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportSourceEntitlementsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportSourceEntitlementsSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportSourceEntitlementsSchema`: %v\n", resp) + } +- path: /sources/{sourceId}/load-uncorrelated-accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#import-uncorrelated-accounts + source: | + 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() { + sourceId := `75dbec1ebe154d5785da27b95e1dd5d7` // string | Source Id # string | Source Id + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.ImportUncorrelatedAccounts(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.ImportUncorrelatedAccounts(context.Background(), sourceId).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) + } + // response from `ImportUncorrelatedAccounts`: LoadUncorrelatedAccountsTask + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportUncorrelatedAccounts`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#list-provisioning-policies + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.ListProvisioningPolicies(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.ListProvisioningPolicies(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ListProvisioningPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListProvisioningPolicies`: []ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ListProvisioningPolicies`: %v\n", resp) + } +- path: /sources + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#list-sources + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Employees"` // 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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq* **modified**: *eq* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq* **modified**: *eq* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + sorters := `name` // 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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + forSubadmin := `name` // string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) # string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + includeIDNSource := true // bool | Include the IdentityNow source in the response. (optional) (default to false) # bool | Include the IdentityNow source in the response. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.ListSources(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.ListSources(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSubadmin(forSubadmin).IncludeIDNSource(includeIDNSource).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ListSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSources`: []Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ListSources`: %v\n", resp) + } +- path: /sources/{sourceId}/connector/peek-resource-objects + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#peek-resource-objects + source: | + 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() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + resourceobjectsrequest := []byte(`{ + "maxCount" : 100, + "objectType" : "group" + }`) // ResourceObjectsRequest | + + + var resourceObjectsRequest beta.ResourceObjectsRequest + if err := json.Unmarshal(resourceobjectsrequest, &resourceObjectsRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.PeekResourceObjects(context.Background(), sourceId).ResourceObjectsRequest(resourceObjectsRequest).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.PeekResourceObjects(context.Background(), sourceId).ResourceObjectsRequest(resourceObjectsRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PeekResourceObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PeekResourceObjects`: ResourceObjectsResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PeekResourceObjects`: %v\n", resp) + } +- path: /sources/{sourceId}/connector/ping-cluster + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#ping-cluster + source: | + 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() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.PingCluster(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.PingCluster(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PingCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PingCluster`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PingCluster`: %v\n", resp) + } +- path: /sources/{sourceId}/correlation-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#put-correlation-config + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + correlationconfig := []byte(`{ + "attributeAssignments" : [ { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + }, { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + } ], + "name" : "Source [source] Account Correlation", + "id" : "2c9180835d191a86015d28455b4a2329" + }`) // CorrelationConfig | + + + var correlationConfig beta.CorrelationConfig + if err := json.Unmarshal(correlationconfig, &correlationConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.PutCorrelationConfig(context.Background(), sourceId).CorrelationConfig(correlationConfig).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.PutCorrelationConfig(context.Background(), sourceId).CorrelationConfig(correlationConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutCorrelationConfig`: CorrelationConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutCorrelationConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/native-change-detection-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#put-native-change-detection-config + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + nativechangedetectionconfig := []byte(`{ + "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], + "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true + }`) // NativeChangeDetectionConfig | + + + var nativeChangeDetectionConfig beta.NativeChangeDetectionConfig + if err := json.Unmarshal(nativechangedetectionconfig, &nativeChangeDetectionConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.PutNativeChangeDetectionConfig(context.Background(), sourceId).NativeChangeDetectionConfig(nativeChangeDetectionConfig).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.PutNativeChangeDetectionConfig(context.Background(), sourceId).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) + } + // response from `PutNativeChangeDetectionConfig`: NativeChangeDetectionConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutNativeChangeDetectionConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#put-provisioning-policy + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + provisioningpolicydto := []byte(`{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }`) // ProvisioningPolicyDto | + + + var provisioningPolicyDto beta.ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.PutProvisioningPolicy(context.Background(), sourceId, usageType).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.PutProvisioningPolicy(context.Background(), sourceId, usageType).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutProvisioningPolicy`: %v\n", resp) + } +- path: /sources/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#put-source + source: | + 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 := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + source := []byte(`{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }`) // Source | + + + var source beta.Source + if err := json.Unmarshal(source, &source); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.PutSource(context.Background(), id).Source(source).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.PutSource(context.Background(), id).Source(source).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSource`: %v\n", resp) + } +- path: /sources/{id}/attribute-sync-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#put-source-attr-sync-config + source: | + 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 := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + attrsyncsourceconfig := []byte(`{ + "attributes" : [ { + "name" : "email", + "displayName" : "Email", + "enabled" : true, + "target" : "mail" + }, { + "name" : "firstname", + "displayName" : "First Name", + "enabled" : false, + "target" : "givenName" + } ], + "source" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + } + }`) // AttrSyncSourceConfig | + + + var attrSyncSourceConfig beta.AttrSyncSourceConfig + if err := json.Unmarshal(attrsyncsourceconfig, &attrSyncSourceConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.PutSourceAttrSyncConfig(context.Background(), id).AttrSyncSourceConfig(attrSyncSourceConfig).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.PutSourceAttrSyncConfig(context.Background(), id).AttrSyncSourceConfig(attrSyncSourceConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSourceAttrSyncConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSourceAttrSyncConfig`: AttrSyncSourceConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSourceAttrSyncConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#put-source-schema + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema ID. # string | The Schema ID. + schema := []byte(`{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + }`) // Schema | + + + var schema beta.Schema + if err := json.Unmarshal(schema, &schema); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.PutSourceSchema(context.Background(), sourceId, schemaId).Schema(schema).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.PutSourceSchema(context.Background(), sourceId, schemaId).Schema(schema).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSourceSchema`: %v\n", resp) + } +- path: /sources/{sourceId}/synchronize-attributes + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#sync-attributes-for-source + source: | + 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() { + sourceId := `sourceId_example` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.SyncAttributesForSource(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.SyncAttributesForSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.SyncAttributesForSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SyncAttributesForSource`: SourceSyncJob + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.SyncAttributesForSource`: %v\n", resp) + } +- path: /sources/{sourceId}/connector/test-configuration + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#test-source-configuration + source: | + 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() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.TestSourceConfiguration(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.TestSourceConfiguration(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.TestSourceConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConfiguration`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.TestSourceConfiguration`: %v\n", resp) + } +- path: /sources/{sourceId}/connector/check-connection + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#test-source-connection + source: | + 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() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source. # string | The ID of the Source. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.TestSourceConnection(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.TestSourceConnection(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.TestSourceConnection``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConnection`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.TestSourceConnection`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#update-provisioning-policies-in-bulk + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + provisioningpolicydto := []byte(``) // []ProvisioningPolicyDto | + + + var provisioningPolicyDto beta.[]ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.UpdateProvisioningPoliciesInBulk(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.UpdateProvisioningPoliciesInBulk(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateProvisioningPoliciesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateProvisioningPoliciesInBulk`: []ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateProvisioningPoliciesInBulk`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#update-provisioning-policy + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + jsonpatchoperation := []byte(`[{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schema. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.UpdateProvisioningPolicy(context.Background(), sourceId, usageType).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.UpdateProvisioningPolicy(context.Background(), sourceId, usageType).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateProvisioningPolicy`: %v\n", resp) + } +- path: /sources/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#update-source + source: | + 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 := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=new description}]`) // []JsonPatchOperation | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.UpdateSource(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.UpdateSource(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSource`: %v\n", resp) + } +- path: /sources/{sourceId}/entitlement-request-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#update-source-entitlement-request-config + source: | + 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() { + sourceId := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + sourceentitlementrequestconfig := []byte(`{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }`) // SourceEntitlementRequestConfig | + + + var sourceEntitlementRequestConfig beta.SourceEntitlementRequestConfig + if err := json.Unmarshal(sourceentitlementrequestconfig, &sourceEntitlementRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.UpdateSourceEntitlementRequestConfig(context.Background(), sourceId).SourceEntitlementRequestConfig(sourceEntitlementRequestConfig).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.UpdateSourceEntitlementRequestConfig(context.Background(), sourceId).SourceEntitlementRequestConfig(sourceEntitlementRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceEntitlementRequestConfig`: SourceEntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceEntitlementRequestConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sources#update-source-schema + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + jsonpatchoperation := []byte(`[{op=replace, path=/displayAttribute, value={new-display-attribute=null}}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schema. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourcesAPI.UpdateSourceSchema(context.Background(), sourceId, schemaId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.SourcesAPI.UpdateSourceSchema(context.Background(), sourceId, schemaId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceSchema`: %v\n", resp) + } +- path: /source-usages/{sourceId}/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/source-usages#get-status-by-source-id + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | ID of IDN source # string | ID of IDN source + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourceUsagesAPI.GetStatusBySourceId(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourceUsagesAPI.GetStatusBySourceId(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourceUsagesAPI.GetStatusBySourceId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetStatusBySourceId`: SourceUsageStatus + fmt.Fprintf(os.Stdout, "Response from `SourceUsagesAPI.GetStatusBySourceId`: %v\n", resp) + } +- path: /source-usages/{sourceId}/summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/source-usages#get-usages-by-source-id + source: | + 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() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | ID of IDN source # string | ID of IDN source + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `-date` // 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: **date** (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: **date** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SourceUsagesAPI.GetUsagesBySourceId(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.Beta.SourceUsagesAPI.GetUsagesBySourceId(context.Background(), sourceId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourceUsagesAPI.GetUsagesBySourceId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUsagesBySourceId`: []SourceUsage + fmt.Fprintf(os.Stdout, "Response from `SourceUsagesAPI.GetUsagesBySourceId`: %v\n", resp) + } +- path: /sp-config/export + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sp-config#export-sp-config + source: | + 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() { + exportpayload := []byte(`{ + "description" : "Export Job 1 Test" + }`) // ExportPayload | Export options control what will be included in the export. + + + var exportPayload beta.ExportPayload + if err := json.Unmarshal(exportpayload, &exportPayload); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SPConfigAPI.ExportSpConfig(context.Background()).ExportPayload(exportPayload).Execute() + //resp, r, err := apiClient.Beta.SPConfigAPI.ExportSpConfig(context.Background()).ExportPayload(exportPayload).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ExportSpConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportSpConfig`: SpConfigExportJob + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ExportSpConfig`: %v\n", resp) + } +- path: /sp-config/export/{id}/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sp-config#get-sp-config-export + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the export job whose results will be downloaded. # string | The ID of the export job whose results will be downloaded. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SPConfigAPI.GetSpConfigExport(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SPConfigAPI.GetSpConfigExport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigExport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigExport`: SpConfigExportResults + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigExport`: %v\n", resp) + } +- path: /sp-config/export/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sp-config#get-sp-config-export-status + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the export job whose status will be returned. # string | The ID of the export job whose status will be returned. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SPConfigAPI.GetSpConfigExportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SPConfigAPI.GetSpConfigExportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigExportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigExportStatus`: SpConfigExportJobStatus + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigExportStatus`: %v\n", resp) + } +- path: /sp-config/import/{id}/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sp-config#get-sp-config-import + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the import job whose results will be downloaded. # string | The ID of the import job whose results will be downloaded. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SPConfigAPI.GetSpConfigImport(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SPConfigAPI.GetSpConfigImport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigImport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigImport`: SpConfigImportResults + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigImport`: %v\n", resp) + } +- path: /sp-config/import/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sp-config#get-sp-config-import-status + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the import job whose status will be returned. # string | The ID of the import job whose status will be returned. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SPConfigAPI.GetSpConfigImportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.SPConfigAPI.GetSpConfigImportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigImportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigImportStatus`: SpConfigImportJobStatus + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigImportStatus`: %v\n", resp) + } +- path: /sp-config/import + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sp-config#import-sp-config + source: | + 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() { + data := BINARY_DATA_HERE // *os.File | JSON file containing the objects to be imported. # *os.File | JSON file containing the objects to be imported. + preview := true // bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to false) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to false) + options := []byte(``) // ImportOptions | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SPConfigAPI.ImportSpConfig(context.Background()).Data(data).Execute() + //resp, r, err := apiClient.Beta.SPConfigAPI.ImportSpConfig(context.Background()).Data(data).Preview(preview).Options(options).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ImportSpConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportSpConfig`: SpConfigJob + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ImportSpConfig`: %v\n", resp) + } +- path: /sp-config/config-objects + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/sp-config#list-sp-config-objects + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SPConfigAPI.ListSpConfigObjects(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SPConfigAPI.ListSpConfigObjects(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ListSpConfigObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSpConfigObjects`: []SpConfigObject + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ListSpConfigObjects`: %v\n", resp) + } +- path: /suggested-entitlement-description-batches/{batchId}/stats + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/suggested-entitlement-description#get-sed-batch-stats + source: | + 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() { + batchId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | Batch Id # string | Batch Id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.GetSedBatchStats(context.Background(), batchId).Execute() + //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.GetSedBatchStats(context.Background(), batchId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatchStats``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSedBatchStats`: SedBatchStats + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatchStats`: %v\n", resp) + } +- path: /suggested-entitlement-description-batches + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/suggested-entitlement-description#get-sed-batches + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatches``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSedBatches`: SedBatchStatus + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatches`: %v\n", resp) + } +- path: /suggested-entitlement-descriptions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/suggested-entitlement-description#list-seds + source: | + 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() { + limit := limit=25 // int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) # int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) + filters := `displayName co "Read and Write"` // 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) + sorters := `sorters=displayName` // 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: **displayName, sourceName, status** (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: **displayName, sourceName, status** (optional) + count := count=true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) + countOnly := count-only=true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) + requestedByAnyone := requested-by-anyone=true // bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) + showPendingStatusOnly := show-pending-status-only=true // bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.ListSeds(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.ListSeds(context.Background()).Limit(limit).Filters(filters).Sorters(sorters).Count(count).CountOnly(countOnly).RequestedByAnyone(requestedByAnyone).ShowPendingStatusOnly(showPendingStatusOnly).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.ListSeds``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSeds`: []Sed + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.ListSeds`: %v\n", resp) + } +- path: /suggested-entitlement-descriptions + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/suggested-entitlement-description#patch-sed + source: | + 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 := `ebab396f-0af1-4050-89b7-dafc63ec70e7` // string | id is sed id # string | id is sed id + sedpatch := []byte(``) // []SedPatch | Sed Patch Request + + + var sedPatch beta.[]SedPatch + if err := json.Unmarshal(sedpatch, &sedPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.PatchSed(context.Background(), id).SedPatch(sedPatch).Execute() + //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.PatchSed(context.Background(), id).SedPatch(sedPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.PatchSed``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSed`: Sed + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.PatchSed`: %v\n", resp) + } +- path: /suggested-entitlement-description-approvals + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/suggested-entitlement-description#submit-sed-approval + source: | + 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() { + sedapproval := []byte(``) // []SedApproval | Sed Approval + + + var sedApproval beta.[]SedApproval + if err := json.Unmarshal(sedapproval, &sedApproval); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.SubmitSedApproval(context.Background()).SedApproval(sedApproval).Execute() + //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.SubmitSedApproval(context.Background()).SedApproval(sedApproval).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedApproval`: []SedApprovalStatus + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedApproval`: %v\n", resp) + } +- path: /suggested-entitlement-description-assignments + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/suggested-entitlement-description#submit-sed-assignment + source: | + 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() { + sedassignment := []byte(`{ + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] + }`) // SedAssignment | Sed Assignment Request + + + var sedAssignment beta.SedAssignment + if err := json.Unmarshal(sedassignment, &sedAssignment); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.SubmitSedAssignment(context.Background()).SedAssignment(sedAssignment).Execute() + //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.SubmitSedAssignment(context.Background()).SedAssignment(sedAssignment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedAssignment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedAssignment`: SedAssignmentResponse + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedAssignment`: %v\n", resp) + } +- path: /suggested-entitlement-description-batches + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/suggested-entitlement-description#submit-sed-batch-request + source: | + 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() { + sedbatchrequest := []byte(`{ + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + }`) // SedBatchRequest | Sed Batch Request (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest(context.Background()).SedBatchRequest(sedBatchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedBatchRequest`: SedBatchResponse + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest`: %v\n", resp) + } +- path: /tagged-objects/{type}/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/tagged-objects#delete-tagged-object + source: | + 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() { + type_ := `ROLE` // string | The type of object to delete tags from. # string | The type of object to delete tags from. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object to delete tags from. # string | The ID of the object to delete tags from. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.TaggedObjectsAPI.DeleteTaggedObject(context.Background(), type_, id).Execute() + //r, err := apiClient.Beta.TaggedObjectsAPI.DeleteTaggedObject(context.Background(), type_, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.DeleteTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /tagged-objects/bulk-remove + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/tagged-objects#delete-tags-to-many-object + source: | + 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() { + bulktaggedobject := []byte(`{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + + var bulkTaggedObject beta.BulkTaggedObject + if err := json.Unmarshal(bulktaggedobject, &bulkTaggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.TaggedObjectsAPI.DeleteTagsToManyObject(context.Background()).BulkTaggedObject(bulkTaggedObject).Execute() + //r, err := apiClient.Beta.TaggedObjectsAPI.DeleteTagsToManyObject(context.Background()).BulkTaggedObject(bulkTaggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.DeleteTagsToManyObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /tagged-objects/{type}/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/tagged-objects#get-tagged-object + source: | + 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() { + type_ := `ROLE` // string | The type of tagged object to retrieve. # string | The type of tagged object to retrieve. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to retrieve. # string | The ID of the object reference to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaggedObjectsAPI.GetTaggedObject(context.Background(), type_, id).Execute() + //resp, r, err := apiClient.Beta.TaggedObjectsAPI.GetTaggedObject(context.Background(), type_, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.GetTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaggedObject`: TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.GetTaggedObject`: %v\n", resp) + } +- path: /tagged-objects + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/tagged-objects#list-tagged-objects + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `tagName eq "BU_FINANCE"` // 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaggedObjectsAPI.ListTaggedObjects(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TaggedObjectsAPI.ListTaggedObjects(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.ListTaggedObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTaggedObjects`: []TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.ListTaggedObjects`: %v\n", resp) + } +- path: /tagged-objects/{type} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/tagged-objects#list-tagged-objects-by-type + source: | + 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() { + type_ := `ROLE` // string | The type of tagged object to retrieve. # string | The type of tagged object to retrieve. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `objectRef.id eq "2c91808568c529c60168cca6f90c1313"` // 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: **objectRef.id**: *eq* **objectRef.type**: *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: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaggedObjectsAPI.ListTaggedObjectsByType(context.Background(), type_).Execute() + //resp, r, err := apiClient.Beta.TaggedObjectsAPI.ListTaggedObjectsByType(context.Background(), type_).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.ListTaggedObjectsByType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTaggedObjectsByType`: []TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.ListTaggedObjectsByType`: %v\n", resp) + } +- path: /tagged-objects/{type}/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/tagged-objects#put-tagged-object + source: | + 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() { + type_ := `ROLE` // string | The type of tagged object to update. # string | The type of tagged object to update. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to update. # string | The ID of the object reference to update. + taggedobject := []byte(`{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // TaggedObject | + + + var taggedObject beta.TaggedObject + if err := json.Unmarshal(taggedobject, &taggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaggedObjectsAPI.PutTaggedObject(context.Background(), type_, id).TaggedObject(taggedObject).Execute() + //resp, r, err := apiClient.Beta.TaggedObjectsAPI.PutTaggedObject(context.Background(), type_, id).TaggedObject(taggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.PutTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutTaggedObject`: TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.PutTaggedObject`: %v\n", resp) + } +- path: /tagged-objects + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/tagged-objects#set-tag-to-object + source: | + 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() { + taggedobject := []byte(`{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // TaggedObject | + + + var taggedObject beta.TaggedObject + if err := json.Unmarshal(taggedobject, &taggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.TaggedObjectsAPI.SetTagToObject(context.Background()).TaggedObject(taggedObject).Execute() + //r, err := apiClient.Beta.TaggedObjectsAPI.SetTagToObject(context.Background()).TaggedObject(taggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.SetTagToObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /tagged-objects/bulk-add + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/tagged-objects#set-tags-to-many-objects + source: | + 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() { + bulktaggedobject := []byte(`{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + + var bulkTaggedObject beta.BulkTaggedObject + if err := json.Unmarshal(bulktaggedobject, &bulkTaggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaggedObjectsAPI.SetTagsToManyObjects(context.Background()).BulkTaggedObject(bulkTaggedObject).Execute() + //resp, r, err := apiClient.Beta.TaggedObjectsAPI.SetTagsToManyObjects(context.Background()).BulkTaggedObject(bulkTaggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.SetTagsToManyObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetTagsToManyObjects`: BulkTaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.SetTagsToManyObjects`: %v\n", resp) + } +- path: /tags + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/tags#create-tag + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + beta "github.com/sailpoint-oss/golang-sdk/v2/api_beta" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + tag := []byte(`{ + "created" : "2022-05-04T14:48:49Z", + "tagCategoryRefs" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "name" : "PCI", + "modified" : "2022-07-14T16:31:11Z", + "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" + }`) // Tag | + + + var tag beta.Tag + if err := json.Unmarshal(tag, &tag); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TagsAPI.CreateTag(context.Background()).Tag(tag).Execute() + //resp, r, err := apiClient.Beta.TagsAPI.CreateTag(context.Background()).Tag(tag).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TagsAPI.CreateTag``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateTag`: Tag + fmt.Fprintf(os.Stdout, "Response from `TagsAPI.CreateTag`: %v\n", resp) + } +- path: /tags/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/tags#delete-tag-by-id + source: | + 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 := `329d96cf-3bdb-40a9-988a-b5037ab89022` // string | The ID of the object reference to delete. # string | The ID of the object reference to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.TagsAPI.DeleteTagById(context.Background(), id).Execute() + //r, err := apiClient.Beta.TagsAPI.DeleteTagById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TagsAPI.DeleteTagById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /tags/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/tags#get-tag-by-id + source: | + 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 := `329d96cf-3bdb-40a9-988a-b5037ab89022` // string | The ID of the object reference to retrieve. # string | The ID of the object reference to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TagsAPI.GetTagById(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.TagsAPI.GetTagById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TagsAPI.GetTagById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTagById`: Tag + fmt.Fprintf(os.Stdout, "Response from `TagsAPI.GetTagById`: %v\n", resp) + } +- path: /tags + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/tags#list-tags + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db"` // 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, in, sw* (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, in, sw* (optional) + sorters := `name,-modified` // 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: **id, name, created, modified** (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: **id, name, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TagsAPI.ListTags(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TagsAPI.ListTags(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TagsAPI.ListTags``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTags`: []Tag + fmt.Fprintf(os.Stdout, "Response from `TagsAPI.ListTags`: %v\n", resp) + } +- path: /task-status/pending-tasks + method: Head + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/task-management#get-pending-task-headers + source: | + 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() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.TaskManagementAPI.GetPendingTaskHeaders(context.Background()).Execute() + //r, err := apiClient.Beta.TaskManagementAPI.GetPendingTaskHeaders(context.Background()).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetPendingTaskHeaders``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /task-status/pending-tasks + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/task-management#get-pending-tasks + source: | + 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() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaskManagementAPI.GetPendingTasks(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TaskManagementAPI.GetPendingTasks(context.Background()).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetPendingTasks``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPendingTasks`: []TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetPendingTasks`: %v\n", resp) + } +- path: /task-status/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/task-management#get-task-status + source: | + 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 := `00eebcf881994e419d72e757fd30dc0e` // string | Task ID. # string | Task ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaskManagementAPI.GetTaskStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.TaskManagementAPI.GetTaskStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetTaskStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaskStatus`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetTaskStatus`: %v\n", resp) + } +- path: /task-status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/task-management#get-task-status-list + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `completionStatus eq "Success"` // 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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) + sorters := `-created` // 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: **created** (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: **created** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaskManagementAPI.GetTaskStatusList(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TaskManagementAPI.GetTaskStatusList(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetTaskStatusList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaskStatusList`: []TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetTaskStatusList`: %v\n", resp) + } +- path: /task-status/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/task-management#update-task-status + source: | + 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 := `00eebcf881994e419d72e757fd30dc0e` // string | Task ID. # string | Task ID. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | The JSONPatch payload used to update the object. + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TaskManagementAPI.UpdateTaskStatus(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.TaskManagementAPI.UpdateTaskStatus(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.UpdateTaskStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateTaskStatus`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.UpdateTaskStatus`: %v\n", resp) + } +- path: /tenant + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/tenant#get-tenant + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TenantAPI.GetTenant(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TenantAPI.GetTenant(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TenantAPI.GetTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenant`: Tenant + fmt.Fprintf(os.Stdout, "Response from `TenantAPI.GetTenant`: %v\n", resp) + } +- path: /transforms + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/transforms#create-transform + source: | + 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() { + transform := []byte(`{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }`) // Transform | The transform to be created. + + + var transform beta.Transform + if err := json.Unmarshal(transform, &transform); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TransformsAPI.CreateTransform(context.Background()).Transform(transform).Execute() + //resp, r, err := apiClient.Beta.TransformsAPI.CreateTransform(context.Background()).Transform(transform).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.CreateTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.CreateTransform`: %v\n", resp) + } +- path: /transforms/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/transforms#delete-transform + source: | + 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 := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to delete # string | ID of the transform to delete + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.TransformsAPI.DeleteTransform(context.Background(), id).Execute() + //r, err := apiClient.Beta.TransformsAPI.DeleteTransform(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.DeleteTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /transforms/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/transforms#get-transform + source: | + 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 := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to retrieve # string | ID of the transform to retrieve + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TransformsAPI.GetTransform(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.TransformsAPI.GetTransform(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.GetTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.GetTransform`: %v\n", resp) + } +- path: /transforms + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/transforms#list-transforms + source: | + 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() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + name := `ExampleTransformName123` // string | Name of the transform to retrieve from the list. (optional) # string | Name of the transform to retrieve from the list. (optional) + filters := `name eq "Uppercase"` // 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: **internal**: *eq* **name**: *eq, sw* (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: **internal**: *eq* **name**: *eq, sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TransformsAPI.ListTransforms(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TransformsAPI.ListTransforms(context.Background()).Offset(offset).Limit(limit).Count(count).Name(name).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.ListTransforms``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTransforms`: []TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.ListTransforms`: %v\n", resp) + } +- path: /transforms/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/transforms#update-transform + source: | + 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 := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to update # string | ID of the transform to update + transform := []byte(`{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }`) // Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TransformsAPI.UpdateTransform(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.TransformsAPI.UpdateTransform(context.Background(), id).Transform(transform).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.UpdateTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.UpdateTransform`: %v\n", resp) + } +- path: /trigger-invocations/{id}/complete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/triggers#complete-trigger-invocation + source: | + 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 := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | The ID of the invocation to complete. # string | The ID of the invocation to complete. + completeinvocation := []byte(`{ + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + }`) // CompleteInvocation | + + + var completeInvocation beta.CompleteInvocation + if err := json.Unmarshal(completeinvocation, &completeInvocation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.TriggersAPI.CompleteTriggerInvocation(context.Background(), id).CompleteInvocation(completeInvocation).Execute() + //r, err := apiClient.Beta.TriggersAPI.CompleteTriggerInvocation(context.Background(), id).CompleteInvocation(completeInvocation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.CompleteTriggerInvocation``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /trigger-subscriptions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/triggers#create-subscription + source: | + 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() { + subscriptionpostrequest := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "triggerId" : "idn:access-requested", + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + }`) // SubscriptionPostRequest | + + + var subscriptionPostRequest beta.SubscriptionPostRequest + if err := json.Unmarshal(subscriptionpostrequest, &subscriptionPostRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TriggersAPI.CreateSubscription(context.Background()).SubscriptionPostRequest(subscriptionPostRequest).Execute() + //resp, r, err := apiClient.Beta.TriggersAPI.CreateSubscription(context.Background()).SubscriptionPostRequest(subscriptionPostRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.CreateSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.CreateSubscription`: %v\n", resp) + } +- path: /trigger-subscriptions/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/triggers#delete-subscription + source: | + 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 := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | Subscription ID # string | Subscription ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.TriggersAPI.DeleteSubscription(context.Background(), id).Execute() + //r, err := apiClient.Beta.TriggersAPI.DeleteSubscription(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.DeleteSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /trigger-subscriptions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/triggers#list-subscriptions + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"` // 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* **triggerId**: *eq* **type**: *eq, le* (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* **triggerId**: *eq* **type**: *eq, le* (optional) + sorters := `triggerName` // 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: **triggerId, triggerName** (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: **triggerId, triggerName** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TriggersAPI.ListSubscriptions(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TriggersAPI.ListSubscriptions(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListSubscriptions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSubscriptions`: []Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListSubscriptions`: %v\n", resp) + } +- path: /trigger-invocations/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/triggers#list-trigger-invocation-status + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `triggerId eq "idn:access-request-dynamic-approver"` // 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: **triggerId**: *eq* **subscriptionId**: *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: **triggerId**: *eq* **subscriptionId**: *eq* (optional) + sorters := `created` // 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: **triggerId, subscriptionName, created, completed** (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: **triggerId, subscriptionName, created, completed** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TriggersAPI.ListTriggerInvocationStatus(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TriggersAPI.ListTriggerInvocationStatus(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListTriggerInvocationStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTriggerInvocationStatus`: []InvocationStatus + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListTriggerInvocationStatus`: %v\n", resp) + } +- path: /triggers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/triggers#list-triggers + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "idn:access-request-post-approval"` // 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, ge, le* (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, ge, le* (optional) + sorters := `name` // 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: **id, name** (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: **id, name** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TriggersAPI.ListTriggers(context.Background()).Execute() + //resp, r, err := apiClient.Beta.TriggersAPI.ListTriggers(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListTriggers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTriggers`: []Trigger + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListTriggers`: %v\n", resp) + } +- path: /trigger-subscriptions/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/triggers#patch-subscription + source: | + 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 := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | ID of the Subscription to patch # string | ID of the Subscription to patch + subscriptionpatchrequestinner := []byte(``) // []SubscriptionPatchRequestInner | + + + var subscriptionPatchRequestInner beta.[]SubscriptionPatchRequestInner + if err := json.Unmarshal(subscriptionpatchrequestinner, &subscriptionPatchRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TriggersAPI.PatchSubscription(context.Background(), id).SubscriptionPatchRequestInner(subscriptionPatchRequestInner).Execute() + //resp, r, err := apiClient.Beta.TriggersAPI.PatchSubscription(context.Background(), id).SubscriptionPatchRequestInner(subscriptionPatchRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.PatchSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.PatchSubscription`: %v\n", resp) + } +- path: /trigger-invocations/test + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/triggers#start-test-trigger-invocation + source: | + 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() { + testinvocation := []byte(`{ + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } + }`) // TestInvocation | + + + var testInvocation beta.TestInvocation + if err := json.Unmarshal(testinvocation, &testInvocation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TriggersAPI.StartTestTriggerInvocation(context.Background()).TestInvocation(testInvocation).Execute() + //resp, r, err := apiClient.Beta.TriggersAPI.StartTestTriggerInvocation(context.Background()).TestInvocation(testInvocation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.StartTestTriggerInvocation``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartTestTriggerInvocation`: []Invocation + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.StartTestTriggerInvocation`: %v\n", resp) + } +- path: /trigger-subscriptions/validate-filter + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/triggers#test-subscription-filter + source: | + 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() { + validatefilterinputdto := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + }`) // ValidateFilterInputDto | + + + var validateFilterInputDto beta.ValidateFilterInputDto + if err := json.Unmarshal(validatefilterinputdto, &validateFilterInputDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TriggersAPI.TestSubscriptionFilter(context.Background()).ValidateFilterInputDto(validateFilterInputDto).Execute() + //resp, r, err := apiClient.Beta.TriggersAPI.TestSubscriptionFilter(context.Background()).ValidateFilterInputDto(validateFilterInputDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.TestSubscriptionFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSubscriptionFilter`: ValidateFilterOutputDto + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.TestSubscriptionFilter`: %v\n", resp) + } +- path: /trigger-subscriptions/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/triggers#update-subscription + source: | + 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 := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | Subscription ID # string | Subscription ID + subscriptionputrequest := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + }`) // SubscriptionPutRequest | + + + var subscriptionPutRequest beta.SubscriptionPutRequest + if err := json.Unmarshal(subscriptionputrequest, &subscriptionPutRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.TriggersAPI.UpdateSubscription(context.Background(), id).SubscriptionPutRequest(subscriptionPutRequest).Execute() + //resp, r, err := apiClient.Beta.TriggersAPI.UpdateSubscription(context.Background(), id).SubscriptionPutRequest(subscriptionPutRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.UpdateSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.UpdateSubscription`: %v\n", resp) + } +- path: /ui-metadata/tenant + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/ui-metadata#get-tenant-ui-metadata + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.UIMetadataAPI.GetTenantUiMetadata(context.Background()).Execute() + //resp, r, err := apiClient.Beta.UIMetadataAPI.GetTenantUiMetadata(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `UIMetadataAPI.GetTenantUiMetadata``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenantUiMetadata`: TenantUiMetadataItemResponse + fmt.Fprintf(os.Stdout, "Response from `UIMetadataAPI.GetTenantUiMetadata`: %v\n", resp) + } +- path: /ui-metadata/tenant + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/ui-metadata#set-tenant-ui-metadata + source: | + 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() { + tenantuimetadataitemupdaterequest := []byte(`{ + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" + }`) // TenantUiMetadataItemUpdateRequest | + + + var tenantUiMetadataItemUpdateRequest beta.TenantUiMetadataItemUpdateRequest + if err := json.Unmarshal(tenantuimetadataitemupdaterequest, &tenantUiMetadataItemUpdateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.UIMetadataAPI.SetTenantUiMetadata(context.Background()).TenantUiMetadataItemUpdateRequest(tenantUiMetadataItemUpdateRequest).Execute() + //resp, r, err := apiClient.Beta.UIMetadataAPI.SetTenantUiMetadata(context.Background()).TenantUiMetadataItemUpdateRequest(tenantUiMetadataItemUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `UIMetadataAPI.SetTenantUiMetadata``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetTenantUiMetadata`: TenantUiMetadataItemResponse + fmt.Fprintf(os.Stdout, "Response from `UIMetadataAPI.SetTenantUiMetadata`: %v\n", resp) + } +- path: /vendor-connector-mappings + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + 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() { + vendorconnectormapping := []byte(`{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }`) // VendorConnectorMapping | + + + var vendorConnectorMapping beta.VendorConnectorMapping + if err := json.Unmarshal(vendorconnectormapping, &vendorConnectorMapping); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.VendorConnectorMappingsAPI.CreateVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + //resp, r, err := apiClient.Beta.VendorConnectorMappingsAPI.CreateVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.CreateVendorConnectorMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateVendorConnectorMapping`: VendorConnectorMapping + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.CreateVendorConnectorMapping`: %v\n", resp) + } +- path: /vendor-connector-mappings + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + 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() { + vendorconnectormapping := []byte(`{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }`) // VendorConnectorMapping | + + + var vendorConnectorMapping beta.VendorConnectorMapping + if err := json.Unmarshal(vendorconnectormapping, &vendorConnectorMapping); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.VendorConnectorMappingsAPI.DeleteVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + //resp, r, err := apiClient.Beta.VendorConnectorMappingsAPI.DeleteVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.DeleteVendorConnectorMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteVendorConnectorMapping`: DeleteVendorConnectorMapping200Response + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.DeleteVendorConnectorMapping`: %v\n", resp) + } +- path: /vendor-connector-mappings + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.VendorConnectorMappingsAPI.GetVendorConnectorMappings(context.Background()).Execute() + //resp, r, err := apiClient.Beta.VendorConnectorMappingsAPI.GetVendorConnectorMappings(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.GetVendorConnectorMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetVendorConnectorMappings`: []VendorConnectorMapping + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.GetVendorConnectorMappings`: %v\n", resp) + } +- path: /workflow-executions/{id}/cancel + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#cancel-workflow-execution + source: | + 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 := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | The workflow execution ID # string | The workflow execution ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.WorkflowsAPI.CancelWorkflowExecution(context.Background(), id).Execute() + //r, err := apiClient.Beta.WorkflowsAPI.CancelWorkflowExecution(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CancelWorkflowExecution``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /workflows + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#create-workflow + source: | + 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() { + createworkflowrequest := []byte(`{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}`) // CreateWorkflowRequest | + + + var createWorkflowRequest beta.CreateWorkflowRequest + if err := json.Unmarshal(createworkflowrequest, &createWorkflowRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.CreateWorkflow(context.Background()).CreateWorkflowRequest(createWorkflowRequest).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.CreateWorkflow(context.Background()).CreateWorkflowRequest(createWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateWorkflow`: %v\n", resp) + } +- path: /workflows/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#delete-workflow + source: | + 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 := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.WorkflowsAPI.DeleteWorkflow(context.Background(), id).Execute() + //r, err := apiClient.Beta.WorkflowsAPI.DeleteWorkflow(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.DeleteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /workflows/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#get-workflow + source: | + 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 := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + workflowMetrics := false // bool | disable workflow metrics (optional) (default to true) # bool | disable workflow metrics (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.GetWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.GetWorkflow(context.Background(), id).WorkflowMetrics(workflowMetrics).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflow`: %v\n", resp) + } +- path: /workflow-executions/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#get-workflow-execution + source: | + 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 := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Workflow execution ID. # string | Workflow execution ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.GetWorkflowExecution(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.GetWorkflowExecution(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecution``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecution`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecution`: %v\n", resp) + } +- path: /workflow-executions/{id}/history + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#get-workflow-execution-history + source: | + 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 := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow execution # string | Id of the workflow execution + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.GetWorkflowExecutionHistory(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.GetWorkflowExecutionHistory(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutionHistory``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecutionHistory`: []WorkflowExecutionEvent + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutionHistory`: %v\n", resp) + } +- path: /workflows/{id}/executions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#get-workflow-executions + source: | + 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 := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Workflow ID. # string | Workflow 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `status eq "Failed"` // 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: **startTime**: *eq, lt, le, gt, ge* **status**: *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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.GetWorkflowExecutions(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.GetWorkflowExecutions(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecutions`: []WorkflowExecution + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutions`: %v\n", resp) + } +- path: /workflow-library + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#list-complete-workflow-library + source: | + 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() { + 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.WorkflowsAPI.ListCompleteWorkflowLibrary(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.ListCompleteWorkflowLibrary(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListCompleteWorkflowLibrary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCompleteWorkflowLibrary`: []ListCompleteWorkflowLibrary200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListCompleteWorkflowLibrary`: %v\n", resp) + } +- path: /workflow-library/actions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#list-workflow-library-actions + source: | + 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() { + 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) + filters := `id eq "sp:create-campaign"` // 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* (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* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.ListWorkflowLibraryActions(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.ListWorkflowLibraryActions(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryActions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryActions`: []WorkflowLibraryAction + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryActions`: %v\n", resp) + } +- path: /workflow-library/operators + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#list-workflow-library-operators + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.ListWorkflowLibraryOperators(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.ListWorkflowLibraryOperators(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryOperators``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryOperators`: []WorkflowLibraryOperator + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryOperators`: %v\n", resp) + } +- path: /workflow-library/triggers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#list-workflow-library-triggers + source: | + 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() { + 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) + filters := `id eq "idn:identity-attributes-changed"` // 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* (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* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.ListWorkflowLibraryTriggers(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.ListWorkflowLibraryTriggers(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryTriggers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryTriggers`: []WorkflowLibraryTrigger + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryTriggers`: %v\n", resp) + } +- path: /workflows + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#list-workflows + source: | + 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() { + 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) + triggerId := `idn:identity-created` // string | Trigger ID (optional) # string | Trigger ID (optional) + connectorInstanceId := `28541fec-bb81-4ad4-88ef-0f7d213adcad` // string | Connector Instance ID (optional) # string | Connector Instance ID (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.ListWorkflows(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.ListWorkflows(context.Background()).Limit(limit).Offset(offset).TriggerId(triggerId).ConnectorInstanceId(connectorInstanceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflows``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflows`: []Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflows`: %v\n", resp) + } +- path: /workflows/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#patch-workflow + source: | + 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 := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]`) // []JsonPatchOperation | + + + var jsonPatchOperation beta.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.PatchWorkflow(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.PatchWorkflow(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PatchWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PatchWorkflow`: %v\n", resp) + } +- path: /workflows/execute/external/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#post-external-execute-workflow + source: | + 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 := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + postexternalexecuteworkflowrequest := []byte(``) // PostExternalExecuteWorkflowRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.PostExternalExecuteWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.PostExternalExecuteWorkflow(context.Background(), id).PostExternalExecuteWorkflowRequest(postExternalExecuteWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PostExternalExecuteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PostExternalExecuteWorkflow`: PostExternalExecuteWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PostExternalExecuteWorkflow`: %v\n", resp) + } +- path: /workflows/{id}/external/oauth-clients + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#post-workflow-external-trigger + source: | + 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 := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.PostWorkflowExternalTrigger(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.PostWorkflowExternalTrigger(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PostWorkflowExternalTrigger``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PostWorkflowExternalTrigger`: WorkflowOAuthClient + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PostWorkflowExternalTrigger`: %v\n", resp) + } +- path: /workflows/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#put-workflow + source: | + 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 := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + workflowbody := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : "{}", + "type" : "EVENT" + }, + "enabled" : false + }`) // WorkflowBody | + + + var workflowBody beta.WorkflowBody + if err := json.Unmarshal(workflowbody, &workflowBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.PutWorkflow(context.Background(), id).WorkflowBody(workflowBody).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.PutWorkflow(context.Background(), id).WorkflowBody(workflowBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PutWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PutWorkflow`: %v\n", resp) + } +- path: /workflows/execute/external/{id}/test + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#test-external-execute-workflow + source: | + 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 := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + testexternalexecuteworkflowrequest := []byte(``) // TestExternalExecuteWorkflowRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.TestExternalExecuteWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.TestExternalExecuteWorkflow(context.Background(), id).TestExternalExecuteWorkflowRequest(testExternalExecuteWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.TestExternalExecuteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestExternalExecuteWorkflow`: TestExternalExecuteWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.TestExternalExecuteWorkflow`: %v\n", resp) + } +- path: /workflows/{id}/test + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/workflows#test-workflow + source: | + 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 := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + testworkflowrequest := []byte(`{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}`) // TestWorkflowRequest | + + + var testWorkflowRequest beta.TestWorkflowRequest + if err := json.Unmarshal(testworkflowrequest, &testWorkflowRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkflowsAPI.TestWorkflow(context.Background(), id).TestWorkflowRequest(testWorkflowRequest).Execute() + //resp, r, err := apiClient.Beta.WorkflowsAPI.TestWorkflow(context.Background(), id).TestWorkflowRequest(testWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.TestWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestWorkflow`: TestWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.TestWorkflow`: %v\n", resp) + } +- path: /work-items/{id}/approve/{approvalItemId} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-items#approve-approval-item + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveApprovalItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItem`: %v\n", resp) + } +- path: /work-items/bulk-approve/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-items#approve-approval-items-in-bulk + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.ApproveApprovalItemsInBulk(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.ApproveApprovalItemsInBulk(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItemsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveApprovalItemsInBulk`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItemsInBulk`: %v\n", resp) + } +- path: /work-items/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-items#complete-work-item + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + body := `body_example` // string | Body is the request payload to create form definition request (optional) # string | Body is the request payload to create form definition request (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.CompleteWorkItem(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.CompleteWorkItem(context.Background(), id).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.CompleteWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompleteWorkItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.CompleteWorkItem`: %v\n", resp) + } +- path: /work-items/completed + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-items#get-completed-work-items + source: | + 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() { + ownerId := `2c91808571bcfcf80171c23e4b4221fc` // string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.GetCompletedWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.GetCompletedWorkItems(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCompletedWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCompletedWorkItems`: []WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCompletedWorkItems`: %v\n", resp) + } +- path: /work-items/completed/count + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-items#get-count-completed-work-items + source: | + 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() { + ownerId := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (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) + 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.WorkItemsAPI.GetCountCompletedWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.GetCountCompletedWorkItems(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCountCompletedWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCountCompletedWorkItems`: []WorkItemsCount + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCountCompletedWorkItems`: %v\n", resp) + } +- path: /work-items/count + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-items#get-count-work-items + source: | + 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() { + ownerId := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.GetCountWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.GetCountWorkItems(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCountWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCountWorkItems`: WorkItemsCount + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCountWorkItems`: %v\n", resp) + } +- path: /work-items/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-items#get-work-item + source: | + 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 := `2c9180835d191a86015d28455b4a2329` // string | ID of the work item. # string | ID of the work item. + ownerId := `2c9180835d191a86015d28455b4a2329` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.GetWorkItem(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.GetWorkItem(context.Background(), id).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkItem`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetWorkItem`: %v\n", resp) + } +- path: /work-items/summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-items#get-work-items-summary + source: | + 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() { + ownerId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.GetWorkItemsSummary(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.GetWorkItemsSummary(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetWorkItemsSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkItemsSummary`: WorkItemsSummary + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetWorkItemsSummary`: %v\n", resp) + } +- path: /work-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-items#list-work-items + source: | + 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() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + ownerId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.ListWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.ListWorkItems(context.Background()).Limit(limit).Offset(offset).Count(count).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ListWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkItems`: []WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ListWorkItems`: %v\n", resp) + } +- path: /work-items/{id}/reject/{approvalItemId} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-items#reject-approval-item + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.RejectApprovalItem(context.Background(), id, approvalItemId).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.RejectApprovalItem(context.Background(), id, approvalItemId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.RejectApprovalItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectApprovalItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.RejectApprovalItem`: %v\n", resp) + } +- path: /work-items/bulk-reject/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-items#reject-approval-items-in-bulk + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.RejectApprovalItemsInBulk(context.Background(), id).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.RejectApprovalItemsInBulk(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.RejectApprovalItemsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectApprovalItemsInBulk`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.RejectApprovalItemsInBulk`: %v\n", resp) + } +- path: /work-items/{id}/submit-account-selection + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-items#submit-account-selection + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + requestBody := {fieldName=fieldValue} // map[string]interface{} | Account Selection Data map, keyed on fieldName # map[string]interface{} | Account Selection Data map, keyed on fieldName + + + var requestBody beta.RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkItemsAPI.SubmitAccountSelection(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.Beta.WorkItemsAPI.SubmitAccountSelection(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.SubmitAccountSelection``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitAccountSelection`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.SubmitAccountSelection`: %v\n", resp) + } +- path: /work-items/{id}/forward + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-items#submit-forward-work-item + source: | + 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 := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + workitemforward := []byte(`{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + }`) // WorkItemForward | + + + var workItemForward beta.WorkItemForward + if err := json.Unmarshal(workitemforward, &workItemForward); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.WorkItemsAPI.SubmitForwardWorkItem(context.Background(), id).WorkItemForward(workItemForward).Execute() + //r, err := apiClient.Beta.WorkItemsAPI.SubmitForwardWorkItem(context.Background(), id).WorkItemForward(workItemForward).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.SubmitForwardWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /reassignment-configurations + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-reassignment#create-reassignment-configuration + source: | + 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() { + configurationitemrequest := []byte(`{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }`) // ConfigurationItemRequest | + + + var configurationItemRequest beta.ConfigurationItemRequest + if err := json.Unmarshal(configurationitemrequest, &configurationItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkReassignmentAPI.CreateReassignmentConfiguration(context.Background()).ConfigurationItemRequest(configurationItemRequest).Execute() + //resp, r, err := apiClient.Beta.WorkReassignmentAPI.CreateReassignmentConfiguration(context.Background()).ConfigurationItemRequest(configurationItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.CreateReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateReassignmentConfiguration`: ConfigurationItemResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.CreateReassignmentConfiguration`: %v\n", resp) + } +- path: /reassignment-configurations/{identityId}/{configType} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-reassignment#delete-reassignment-configuration + source: | + 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() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique identity id + configType := // ConfigTypeEnum | # ConfigTypeEnum | + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.Beta.WorkReassignmentAPI.DeleteReassignmentConfiguration(context.Background(), identityId, configType).Execute() + //r, err := apiClient.Beta.WorkReassignmentAPI.DeleteReassignmentConfiguration(context.Background(), identityId, configType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.DeleteReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + 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() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique identity id + configType := accessRequests // ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type + exclusionfilters := []byte(`SELF_REVIEW_DELEGATION`) // []string | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkReassignmentAPI.GetEvaluateReassignmentConfiguration(context.Background(), identityId, configType).Execute() + //resp, r, err := apiClient.Beta.WorkReassignmentAPI.GetEvaluateReassignmentConfiguration(context.Background(), identityId, configType).ExclusionFilters(exclusionFilters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetEvaluateReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEvaluateReassignmentConfiguration`: []EvaluateResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetEvaluateReassignmentConfiguration`: %v\n", resp) + } +- path: /reassignment-configurations/types + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-reassignment#get-reassignment-config-types + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkReassignmentAPI.GetReassignmentConfigTypes(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkReassignmentAPI.GetReassignmentConfigTypes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetReassignmentConfigTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReassignmentConfigTypes`: []ConfigType + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetReassignmentConfigTypes`: %v\n", resp) + } +- path: /reassignment-configurations/{identityId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-reassignment#get-reassignment-configuration + source: | + 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() { + identityId := `2c91808781a71ddb0181b9090b5c504f` // string | unique identity id # string | unique identity id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkReassignmentAPI.GetReassignmentConfiguration(context.Background(), identityId).Execute() + //resp, r, err := apiClient.Beta.WorkReassignmentAPI.GetReassignmentConfiguration(context.Background(), identityId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReassignmentConfiguration`: ConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetReassignmentConfiguration`: %v\n", resp) + } +- path: /reassignment-configurations/tenant-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-reassignment#get-tenant-config-configuration + source: | + 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() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkReassignmentAPI.GetTenantConfigConfiguration(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkReassignmentAPI.GetTenantConfigConfiguration(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetTenantConfigConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenantConfigConfiguration`: TenantConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetTenantConfigConfiguration`: %v\n", resp) + } +- path: /reassignment-configurations + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-reassignment#list-reassignment-configurations + source: | + 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() { + limit := 20 // int32 | Max number of results to return. (optional) (default to 20) # int32 | Max number of results to return. (optional) (default to 20) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkReassignmentAPI.ListReassignmentConfigurations(context.Background()).Execute() + //resp, r, err := apiClient.Beta.WorkReassignmentAPI.ListReassignmentConfigurations(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.ListReassignmentConfigurations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListReassignmentConfigurations`: []ConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.ListReassignmentConfigurations`: %v\n", resp) + } +- path: /reassignment-configurations/{identityId} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-reassignment#put-reassignment-config + source: | + 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() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique identity id + configurationitemrequest := []byte(`{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }`) // ConfigurationItemRequest | + + + var configurationItemRequest beta.ConfigurationItemRequest + if err := json.Unmarshal(configurationitemrequest, &configurationItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkReassignmentAPI.PutReassignmentConfig(context.Background(), identityId).ConfigurationItemRequest(configurationItemRequest).Execute() + //resp, r, err := apiClient.Beta.WorkReassignmentAPI.PutReassignmentConfig(context.Background(), identityId).ConfigurationItemRequest(configurationItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.PutReassignmentConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutReassignmentConfig`: ConfigurationItemResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.PutReassignmentConfig`: %v\n", resp) + } +- path: /reassignment-configurations/tenant-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/beta/methods/work-reassignment#put-tenant-configuration + source: | + 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() { + tenantconfigurationrequest := []byte(`{ + "configDetails" : { + "disabled" : true + } + }`) // TenantConfigurationRequest | + + + var tenantConfigurationRequest beta.TenantConfigurationRequest + if err := json.Unmarshal(tenantconfigurationrequest, &tenantConfigurationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.Beta.WorkReassignmentAPI.PutTenantConfiguration(context.Background()).TenantConfigurationRequest(tenantConfigurationRequest).Execute() + //resp, r, err := apiClient.Beta.WorkReassignmentAPI.PutTenantConfiguration(context.Background()).TenantConfigurationRequest(tenantConfigurationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.PutTenantConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutTenantConfiguration`: TenantConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.PutTenantConfiguration`: %v\n", resp) + } diff --git a/static/code-examples/v2024/go_code_examples_overlay.yaml b/static/code-examples/v2024/go_code_examples_overlay.yaml new file mode 100644 index 000000000..ad8e54245 --- /dev/null +++ b/static/code-examples/v2024/go_code_examples_overlay.yaml @@ -0,0 +1,29556 @@ +- path: /access-model-metadata/attributes/{key} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-model-metadata#get-access-model-metadata-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + 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.AccessModelMetadataAPI.GetAccessModelMetadataAttribute(context.Background(), key).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AccessModelMetadataAPI.GetAccessModelMetadataAttribute(context.Background(), key).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.GetAccessModelMetadataAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessModelMetadataAttribute`: AttributeDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.GetAccessModelMetadataAttribute`: %v\n", resp) + } +- path: /access-model-metadata/attributes/{key}/values/{value} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-model-metadata#get-access-model-metadata-attribute-value + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + value := `public` // string | Technical name of the Attribute value. # string | Technical name of the Attribute value. + 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.AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue(context.Background(), key, value).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue(context.Background(), key, value).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessModelMetadataAttributeValue`: AttributeValueDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue`: %v\n", resp) + } +- path: /access-model-metadata/attributes + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-model-metadata#list-access-model-metadata-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 := `name eq "Privacy"` // 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessModelMetadataAPI.ListAccessModelMetadataAttribute(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AccessModelMetadataAPI.ListAccessModelMetadataAttribute(context.Background()).XSailPointExperimental(xSailPointExperimental).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.ListAccessModelMetadataAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessModelMetadataAttribute`: []AttributeDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.ListAccessModelMetadataAttribute`: %v\n", resp) + } +- path: /access-model-metadata/attributes/{key}/values + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-model-metadata#list-access-model-metadata-attribute-value + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + 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.AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue(context.Background(), key).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue(context.Background(), key).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessModelMetadataAttributeValue`: []AttributeValueDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue`: %v\n", resp) + } +- path: /access-profiles + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-profiles#create-access-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accessprofile := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + }`) // AccessProfile | + + + var accessProfile v2024.AccessProfile + if err := json.Unmarshal(accessprofile, &accessProfile); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessProfilesAPI.CreateAccessProfile(context.Background()).AccessProfile(accessProfile).Execute() + //resp, r, err := apiClient.V2024.AccessProfilesAPI.CreateAccessProfile(context.Background()).AccessProfile(accessProfile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.CreateAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.CreateAccessProfile`: %v\n", resp) + } +- path: /access-profiles/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-profiles#delete-access-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Access Profile to delete # string | ID of the Access Profile to delete + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.AccessProfilesAPI.DeleteAccessProfile(context.Background(), id).Execute() + //r, err := apiClient.V2024.AccessProfilesAPI.DeleteAccessProfile(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.DeleteAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /access-profiles/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-profiles#delete-access-profiles-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accessprofilebulkdeleterequest := []byte(`{ + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + }`) // AccessProfileBulkDeleteRequest | + + + var accessProfileBulkDeleteRequest v2024.AccessProfileBulkDeleteRequest + if err := json.Unmarshal(accessprofilebulkdeleterequest, &accessProfileBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessProfilesAPI.DeleteAccessProfilesInBulk(context.Background()).AccessProfileBulkDeleteRequest(accessProfileBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V2024.AccessProfilesAPI.DeleteAccessProfilesInBulk(context.Background()).AccessProfileBulkDeleteRequest(accessProfileBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.DeleteAccessProfilesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccessProfilesInBulk`: AccessProfileBulkDeleteResponse + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.DeleteAccessProfilesInBulk`: %v\n", resp) + } +- path: /access-profiles/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-profiles#get-access-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Access Profile # string | ID of the Access Profile + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessProfilesAPI.GetAccessProfile(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.AccessProfilesAPI.GetAccessProfile(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.GetAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.GetAccessProfile`: %v\n", resp) + } +- path: /access-profiles/{id}/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-profiles#get-access-profile-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the access profile containing the entitlements. # string | ID of the access profile containing the entitlements. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessProfilesAPI.GetAccessProfileEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.AccessProfilesAPI.GetAccessProfileEntitlements(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.GetAccessProfileEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessProfileEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.GetAccessProfileEntitlements`: %v\n", resp) + } +- path: /access-profiles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-profiles#list-access-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + forSubadmin := `8c190e6787aa4ed9a90bd9d5344523fb` // string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) # string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "SailPoint Support"` // 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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessProfilesAPI.ListAccessProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccessProfilesAPI.ListAccessProfiles(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.ListAccessProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessProfiles`: []AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.ListAccessProfiles`: %v\n", resp) + } +- path: /access-profiles/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-profiles#patch-access-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Access Profile to patch # string | ID of the Access Profile to patch + jsonpatchoperation := []byte(`[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessProfilesAPI.PatchAccessProfile(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.AccessProfilesAPI.PatchAccessProfile(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.PatchAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.PatchAccessProfile`: %v\n", resp) + } +- path: /access-profiles/bulk-update-requestable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-profiles#update-access-profiles-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + accessprofilebulkupdaterequestinner := []byte(`[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]`) // []AccessProfileBulkUpdateRequestInner | + + + var accessProfileBulkUpdateRequestInner v2024.[]AccessProfileBulkUpdateRequestInner + if err := json.Unmarshal(accessprofilebulkupdaterequestinner, &accessProfileBulkUpdateRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessProfilesAPI.UpdateAccessProfilesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessProfileBulkUpdateRequestInner(accessProfileBulkUpdateRequestInner).Execute() + //resp, r, err := apiClient.V2024.AccessProfilesAPI.UpdateAccessProfilesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessProfileBulkUpdateRequestInner(accessProfileBulkUpdateRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.UpdateAccessProfilesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAccessProfilesInBulk`: []AccessProfileUpdateItem + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.UpdateAccessProfilesInBulk`: %v\n", resp) + } +- path: /access-request-approvals/{approvalId}/approve + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-request-approvals#approve-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + commentdto := []byte(`{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + }`) // CommentDto | Reviewer's comment. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ApproveAccessRequest(context.Background(), approvalId).Execute() + //resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ApproveAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ApproveAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ApproveAccessRequest`: %v\n", resp) + } +- path: /access-request-approvals/{approvalId}/forward + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-request-approvals#forward-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + forwardapprovaldto := []byte(`{ + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" + }`) // ForwardApprovalDto | Information about the forwarded approval. + + + var forwardApprovalDto v2024.ForwardApprovalDto + if err := json.Unmarshal(forwardapprovaldto, &forwardApprovalDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ForwardAccessRequest(context.Background(), approvalId).ForwardApprovalDto(forwardApprovalDto).Execute() + //resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ForwardAccessRequest(context.Background(), approvalId).ForwardApprovalDto(forwardApprovalDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ForwardAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ForwardAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ForwardAccessRequest`: %v\n", resp) + } +- path: /access-request-approvals/approval-summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-request-approvals#get-access-request-approval-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + fromDate := `from-date=2020-03-19T19:59:11Z` // string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) # string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary(context.Background()).OwnerId(ownerId).FromDate(fromDate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestApprovalSummary`: ApprovalSummary + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary`: %v\n", resp) + } +- path: /access-request-approvals/{accessRequestId}/approvers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-request-approvals#list-access-request-approvers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accessRequestId := `2c91808568c529c60168cca6f90c1313` // string | Access Request ID. # string | Access Request ID. + limit := 100 // int32 | Max number of results to return. (optional) (default to 250) # int32 | Max number of results to return. (optional) (default to 250) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + count := false // bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ListAccessRequestApprovers(context.Background(), accessRequestId).Execute() + //resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ListAccessRequestApprovers(context.Background(), accessRequestId).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListAccessRequestApprovers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessRequestApprovers`: []AccessRequestApproversListResponse + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListAccessRequestApprovers`: %v\n", resp) + } +- path: /access-request-approvals/completed + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-request-approvals#list-completed-approvals + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "2c91808568c529c60168cca6f90c1313"` // 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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + sorters := `modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ListCompletedApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ListCompletedApprovals(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListCompletedApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCompletedApprovals`: []CompletedApproval + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListCompletedApprovals`: %v\n", resp) + } +- path: /access-request-approvals/pending + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-request-approvals#list-pending-approvals + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "2c91808568c529c60168cca6f90c1313"` // 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) + sorters := `modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ListPendingApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.ListPendingApprovals(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListPendingApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPendingApprovals`: []PendingApproval + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListPendingApprovals`: %v\n", resp) + } +- path: /access-request-approvals/{approvalId}/reject + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-request-approvals#reject-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + commentdto := []byte(`{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + }`) // CommentDto | Reviewer's comment. + + + var commentDto v2024.CommentDto + if err := json.Unmarshal(commentdto, &commentDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.RejectAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + //resp, r, err := apiClient.V2024.AccessRequestApprovalsAPI.RejectAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.RejectAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.RejectAccessRequest`: %v\n", resp) + } +- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-request-identity-metrics#get-access-request-identity-metrics + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `7025c863-c270-4ba6-beea-edf3cb091573` // string | Manager's identity ID. # string | Manager's identity ID. + requestedObjectId := `2db501be-f0fb-4cc5-a695-334133c52891` // string | Requested access item's ID. # string | Requested access item's ID. + type_ := `ENTITLEMENT` // string | Requested access item's type. # string | Requested access item's type. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics(context.Background(), identityId, requestedObjectId, type_).Execute() + //resp, r, err := apiClient.V2024.AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics(context.Background(), identityId, requestedObjectId, type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestIdentityMetrics`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics`: %v\n", resp) + } +- path: /access-request-approvals/bulk-approve + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-requests#approve-bulk-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + bulkapproveaccessrequest := []byte(`{ + "comment" : "I approve these request items", + "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] + }`) // BulkApproveAccessRequest | + + + var bulkApproveAccessRequest v2024.BulkApproveAccessRequest + if err := json.Unmarshal(bulkapproveaccessrequest, &bulkApproveAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.ApproveBulkAccessRequest(context.Background()).BulkApproveAccessRequest(bulkApproveAccessRequest).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.ApproveBulkAccessRequest(context.Background()).BulkApproveAccessRequest(bulkApproveAccessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.ApproveBulkAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveBulkAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.ApproveBulkAccessRequest`: %v\n", resp) + } +- path: /access-requests/cancel + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-requests#cancel-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + cancelaccessrequest := []byte(`{ + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + }`) // CancelAccessRequest | + + + var cancelAccessRequest v2024.CancelAccessRequest + if err := json.Unmarshal(cancelaccessrequest, &cancelAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.CancelAccessRequest(context.Background()).CancelAccessRequest(cancelAccessRequest).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.CancelAccessRequest(context.Background()).CancelAccessRequest(cancelAccessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CancelAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CancelAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CancelAccessRequest`: %v\n", resp) + } +- path: /access-requests/bulk-cancel + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-requests#cancel-access-request-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + bulkcancelaccessrequest := []byte(`{ + "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], + "comment" : "I requested this role by mistake." + }`) // BulkCancelAccessRequest | + + + var bulkCancelAccessRequest v2024.BulkCancelAccessRequest + if err := json.Unmarshal(bulkcancelaccessrequest, &bulkCancelAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.CancelAccessRequestInBulk(context.Background()).BulkCancelAccessRequest(bulkCancelAccessRequest).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.CancelAccessRequestInBulk(context.Background()).BulkCancelAccessRequest(bulkCancelAccessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CancelAccessRequestInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CancelAccessRequestInBulk`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CancelAccessRequestInBulk`: %v\n", resp) + } +- path: /access-requests/close + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-requests#close-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + }`) // CloseAccessRequest | + + + var closeAccessRequest v2024.CloseAccessRequest + if err := json.Unmarshal(closeaccessrequest, &closeAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + 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() + 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) + } + // response from `CloseAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CloseAccessRequest`: %v\n", resp) + } +- path: /access-requests + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-requests#create-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accessrequest := []byte(`{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } ] + }`) // AccessRequest | + + + var accessRequest v2024.AccessRequest + if err := json.Unmarshal(accessrequest, &accessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.CreateAccessRequest(context.Background()).AccessRequest(accessRequest).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.CreateAccessRequest(context.Background()).AccessRequest(accessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CreateAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessRequest`: AccessRequestResponse + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CreateAccessRequest`: %v\n", resp) + } +- path: /access-request-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-requests#get-access-request-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.GetAccessRequestConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.GetAccessRequestConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.GetAccessRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestConfig`: AccessRequestConfig + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.GetAccessRequestConfig`: %v\n", resp) + } +- path: /access-request-status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-requests#list-access-request-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + assignedTo := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + count := false // bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + limit := 100 // int32 | Max number of results to return. (optional) (default to 250) # int32 | Max number of results to return. (optional) (default to 250) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + filters := `accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"` // 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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + sorters := `created` // 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: **created, modified, accountActivityItemId, name** (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: **created, modified, accountActivityItemId, name** (optional) + requestState := `request-state=EXECUTING` // string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.ListAccessRequestStatus(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.ListAccessRequestStatus(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).AssignedTo(assignedTo).Count(count).Limit(limit).Offset(offset).Filters(filters).Sorters(sorters).RequestState(requestState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.ListAccessRequestStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessRequestStatus`: []RequestedItemStatus + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.ListAccessRequestStatus`: %v\n", resp) + } +- path: /access-request-administration + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-requests#list-administrators-access-request-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + assignedTo := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + count := false // bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + limit := 100 // int32 | Max number of results to return. (optional) (default to 250) # int32 | Max number of results to return. (optional) (default to 250) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + filters := `accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"` // 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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + sorters := `created` // 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: **created, modified, accountActivityItemId, name, accessRequestId** (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: **created, modified, accountActivityItemId, name, accessRequestId** (optional) + requestState := `request-state=EXECUTING` // string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.ListAdministratorsAccessRequestStatus(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.ListAdministratorsAccessRequestStatus(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).AssignedTo(assignedTo).Count(count).Limit(limit).Offset(offset).Filters(filters).Sorters(sorters).RequestState(requestState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.ListAdministratorsAccessRequestStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAdministratorsAccessRequestStatus`: []AccessRequestAdminItemStatus + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.ListAdministratorsAccessRequestStatus`: %v\n", resp) + } +- path: /access-requests/accounts-selection + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-requests#load-account-selections + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accountsselectionrequest := []byte(`{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }`) // AccountsSelectionRequest | + + + var accountsSelectionRequest v2024.AccountsSelectionRequest + if err := json.Unmarshal(accountsselectionrequest, &accountsSelectionRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.LoadAccountSelections(context.Background()).AccountsSelectionRequest(accountsSelectionRequest).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.LoadAccountSelections(context.Background()).AccountsSelectionRequest(accountsSelectionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.LoadAccountSelections``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `LoadAccountSelections`: AccountsSelectionResponse + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.LoadAccountSelections`: %v\n", resp) + } +- path: /access-request-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/access-requests#set-access-request-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accessrequestconfig := []byte(`{ + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + }`) // AccessRequestConfig | + + + var accessRequestConfig v2024.AccessRequestConfig + if err := json.Unmarshal(accessrequestconfig, &accessRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccessRequestsAPI.SetAccessRequestConfig(context.Background()).AccessRequestConfig(accessRequestConfig).Execute() + //resp, r, err := apiClient.V2024.AccessRequestsAPI.SetAccessRequestConfig(context.Background()).AccessRequestConfig(accessRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.SetAccessRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetAccessRequestConfig`: AccessRequestConfig + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.SetAccessRequestConfig`: %v\n", resp) + } +- path: /account-activities/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/account-activities#get-account-activity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account activity id # string | The account activity id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountActivitiesAPI.GetAccountActivity(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.AccountActivitiesAPI.GetAccountActivity(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountActivitiesAPI.GetAccountActivity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccountActivity`: AccountActivity + fmt.Fprintf(os.Stdout, "Response from `AccountActivitiesAPI.GetAccountActivity`: %v\n", resp) + } +- path: /account-activities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/account-activities#list-account-activities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c91808568c529c60168cca6f90c1313` // string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c91808568c529c60168cca6f90c1313` // string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c91808568c529c60168cca6f90c1313` // string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `type eq "Identity Refresh"` // 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + sorters := `created` // 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: **type, created, modified** (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: **type, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountActivitiesAPI.ListAccountActivities(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccountActivitiesAPI.ListAccountActivities(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountActivitiesAPI.ListAccountActivities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccountActivities`: []AccountActivity + fmt.Fprintf(os.Stdout, "Response from `AccountActivitiesAPI.ListAccountActivities`: %v\n", resp) + } +- path: /account-aggregations/{id}/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/account-aggregations#get-account-aggregation-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `GetAccountAggregationStatus`: AccountAggregationStatus + fmt.Fprintf(os.Stdout, "Response from `AccountAggregationsAPI.GetAccountAggregationStatus`: %v\n", resp) + } +- path: /accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/accounts#create-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accountattributescreate := []byte(`{ + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }`) // AccountAttributesCreate | + + + var accountAttributesCreate v2024.AccountAttributesCreate + if err := json.Unmarshal(accountattributescreate, &accountAttributesCreate); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.CreateAccount(context.Background()).AccountAttributesCreate(accountAttributesCreate).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.CreateAccount(context.Background()).AccountAttributesCreate(accountAttributesCreate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.CreateAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.CreateAccount`: %v\n", resp) + } +- path: /accounts/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/accounts#delete-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.DeleteAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.DeleteAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DeleteAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DeleteAccount`: %v\n", resp) + } +- path: /accounts/{id}/remove + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/accounts#delete-account-async + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `DeleteAccountAsync`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DeleteAccountAsync`: %v\n", resp) + } +- path: /accounts/{id}/disable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/accounts#disable-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + accounttogglerequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }`) // AccountToggleRequest | + + + var accountToggleRequest v2024.AccountToggleRequest + if err := json.Unmarshal(accounttogglerequest, &accountToggleRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.DisableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.DisableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DisableAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DisableAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccount`: %v\n", resp) + } +- path: /identities-accounts/{id}/disable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/accounts#disable-account-for-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `DisableAccountForIdentity`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccountForIdentity`: %v\n", resp) + } +- path: /identities-accounts/disable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/accounts#disable-accounts-for-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 | + + + var identitiesAccountsBulkRequest v2024.IdentitiesAccountsBulkRequest + if err := json.Unmarshal(identitiesaccountsbulkrequest, &identitiesAccountsBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + 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() + 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) + } + // response from `DisableAccountsForIdentities`: []BulkIdentitiesAccountsResponse + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccountsForIdentities`: %v\n", resp) + } +- path: /accounts/{id}/enable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/accounts#enable-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + accounttogglerequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }`) // AccountToggleRequest | + + + var accountToggleRequest v2024.AccountToggleRequest + if err := json.Unmarshal(accounttogglerequest, &accountToggleRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.EnableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.EnableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.EnableAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `EnableAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccount`: %v\n", resp) + } +- path: /identities-accounts/{id}/enable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/accounts#enable-account-for-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `EnableAccountForIdentity`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccountForIdentity`: %v\n", resp) + } +- path: /identities-accounts/enable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/accounts#enable-accounts-for-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 | + + + var identitiesAccountsBulkRequest v2024.IdentitiesAccountsBulkRequest + if err := json.Unmarshal(identitiesaccountsbulkrequest, &identitiesAccountsBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + 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() + 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) + } + // response from `EnableAccountsForIdentities`: []BulkIdentitiesAccountsResponse + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccountsForIdentities`: %v\n", resp) + } +- path: /accounts/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/accounts#get-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.GetAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.GetAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.GetAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccount`: Account + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.GetAccount`: %v\n", resp) + } +- path: /accounts/{id}/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/accounts#get-account-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.GetAccountEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.GetAccountEntitlements(context.Background(), id).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.GetAccountEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccountEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.GetAccountEntitlements`: %v\n", resp) + } +- path: /accounts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/accounts#list-accounts + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + detailLevel := `FULL` // string | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) # string | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + filters := `identityId eq "2c9180858082150f0180893dbaf44201"` // 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) + sorters := `id,name` // 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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.ListAccounts(context.Background()).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.ListAccounts(context.Background()).Limit(limit).Offset(offset).Count(count).DetailLevel(detailLevel).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.ListAccounts``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccounts`: []Account + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.ListAccounts`: %v\n", resp) + } +- path: /accounts/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/accounts#put-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + accountattributes := []byte(`{ + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }`) // AccountAttributes | + + + var accountAttributes v2024.AccountAttributes + if err := json.Unmarshal(accountattributes, &accountAttributes); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.PutAccount(context.Background(), id).AccountAttributes(accountAttributes).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.PutAccount(context.Background(), id).AccountAttributes(accountAttributes).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.PutAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.PutAccount`: %v\n", resp) + } +- path: /accounts/{id}/reload + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/accounts#submit-reload-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.SubmitReloadAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.SubmitReloadAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.SubmitReloadAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitReloadAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.SubmitReloadAccount`: %v\n", resp) + } +- path: /accounts/{id}/unlock + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/accounts#unlock-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account ID. # string | The account ID. + accountunlockrequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + }`) // AccountUnlockRequest | + + + var accountUnlockRequest v2024.AccountUnlockRequest + if err := json.Unmarshal(accountunlockrequest, &accountUnlockRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.UnlockAccount(context.Background(), id).AccountUnlockRequest(accountUnlockRequest).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.UnlockAccount(context.Background(), id).AccountUnlockRequest(accountUnlockRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.UnlockAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UnlockAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.UnlockAccount`: %v\n", resp) + } +- path: /accounts/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/accounts#update-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + requestbody := []byte(`[{op=remove, path=/identityId}]`) // []map[string]interface{} | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountsAPI.UpdateAccount(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2024.AccountsAPI.UpdateAccount(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.UpdateAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAccount`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.UpdateAccount`: %v\n", resp) + } +- path: /account-usages/{accountId}/summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/account-usages#get-usages-by-account-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accountId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of IDN account # string | ID of IDN account + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `-date` // 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: **date** (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: **date** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AccountUsagesAPI.GetUsagesByAccountId(context.Background(), accountId).Execute() + //resp, r, err := apiClient.V2024.AccountUsagesAPI.GetUsagesByAccountId(context.Background(), accountId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountUsagesAPI.GetUsagesByAccountId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUsagesByAccountId`: []AccountUsage + fmt.Fprintf(os.Stdout, "Response from `AccountUsagesAPI.GetUsagesByAccountId`: %v\n", resp) + } +- path: /discovered-applications + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/application-discovery#get-discovered-applications + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + filter := `name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")` // 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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + sorters := `name` // 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, description, discoveredAt, discoverySource** (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, description, discoveredAt, discoverySource** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ApplicationDiscoveryAPI.GetDiscoveredApplications(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ApplicationDiscoveryAPI.GetDiscoveredApplications(context.Background()).Limit(limit).Offset(offset).Detail(detail).Filter(filter).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetDiscoveredApplications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDiscoveredApplications`: []GetDiscoveredApplications200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `ApplicationDiscoveryAPI.GetDiscoveredApplications`: %v\n", resp) + } +- path: /manual-discover-applications-template + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManualDiscoverApplicationsCsvTemplate`: ManualDiscoverApplicationsTemplate + fmt.Fprintf(os.Stdout, "Response from `ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate`: %v\n", resp) + } +- path: /manual-discover-applications + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + file := BINARY_DATA_HERE // *os.File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # *os.File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate(context.Background()).File(file).Execute() + //r, err := apiClient.V2024.ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate(context.Background()).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /generic-approvals/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/approvals#get-approval + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `38453251-6be2-5f8f-df93-5ce19e295837` // string | ID of the approval that is to be returned # string | ID of the approval that is to be returned + 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.ApprovalsAPI.GetApproval(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.ApprovalsAPI.GetApproval(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApprovalsAPI.GetApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetApproval`: Approval + fmt.Fprintf(os.Stdout, "Response from `ApprovalsAPI.GetApproval`: %v\n", resp) + } +- path: /generic-approvals + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/approvals#get-approvals + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + mine := true // bool | Returns the list of approvals for the current caller (optional) # bool | Returns the list of approvals for the current caller (optional) + requesterId := `17e633e7d57e481569df76323169deb6a` // string | Returns the list of approvals for a given requester ID (optional) # string | Returns the list of approvals for a given requester ID (optional) + filters := `filters=status eq PENDING` // 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: **status**: *eq* **referenceType**: *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: **status**: *eq* **referenceType**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ApprovalsAPI.GetApprovals(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.ApprovalsAPI.GetApprovals(context.Background()).XSailPointExperimental(xSailPointExperimental).Mine(mine).RequesterId(requesterId).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApprovalsAPI.GetApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetApprovals`: []Approval + fmt.Fprintf(os.Stdout, "Response from `ApprovalsAPI.GetApprovals`: %v\n", resp) + } +- path: /source-apps + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/apps#create-source-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + sourceappcreatedto := []byte(`{ + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true + }`) // SourceAppCreateDto | + + + var sourceAppCreateDto v2024.SourceAppCreateDto + if err := json.Unmarshal(sourceappcreatedto, &sourceAppCreateDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.CreateSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceAppCreateDto(sourceAppCreateDto).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.CreateSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceAppCreateDto(sourceAppCreateDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.CreateSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.CreateSourceApp`: %v\n", resp) + } +- path: /source-apps/{id}/access-profiles/bulk-remove + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/apps#delete-access-profiles-from-source-app-by-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + 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") + requestbody := []byte(`[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]`) // []string | + 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) + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.DeleteAccessProfilesFromSourceAppByBulk(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.DeleteAccessProfilesFromSourceAppByBulk(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.DeleteAccessProfilesFromSourceAppByBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccessProfilesFromSourceAppByBulk`: []AccessProfileDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.DeleteAccessProfilesFromSourceAppByBulk`: %v\n", resp) + } +- path: /source-apps/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/apps#delete-source-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | source app ID. # string | source app 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.AppsAPI.DeleteSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.DeleteSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.DeleteSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.DeleteSourceApp`: %v\n", resp) + } +- path: /source-apps/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/apps#get-source-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + 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.AppsAPI.GetSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.GetSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.GetSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.GetSourceApp`: %v\n", resp) + } +- path: /source-apps/{id}/access-profiles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/apps#list-access-profiles-for-source-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + 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") + 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) + filters := `name eq "developer access profile"` // 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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.ListAccessProfilesForSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.ListAccessProfilesForSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAccessProfilesForSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessProfilesForSourceApp`: []AccessProfileDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAccessProfilesForSourceApp`: %v\n", resp) + } +- path: /source-apps/all + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/apps#list-all-source-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, owner.id, accountSource.id** (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: **id, name, created, modified, owner.id, accountSource.id** (optional) + filters := `enabled eq true` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.ListAllSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.ListAllSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAllSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAllSourceApp`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAllSourceApp`: %v\n", resp) + } +- path: /user-apps/all + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/apps#list-all-user-apps + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filters := `name eq "user app name"` // 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.V2024.AppsAPI.ListAllUserApps(context.Background()).Filters(filters).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.ListAllUserApps(context.Background()).Filters(filters).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAllUserApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAllUserApps`: []UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAllUserApps`: %v\n", resp) + } +- path: /source-apps/assigned + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/apps#list-assigned-source-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, accountSource.id** (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: **id, name, created, modified, accountSource.id** (optional) + filters := `name eq "source app name"` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.ListAssignedSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.ListAssignedSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAssignedSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAssignedSourceApp`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAssignedSourceApp`: %v\n", resp) + } +- path: /user-apps/{id}/available-accounts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/apps#list-available-accounts-for-user-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the user app # string | ID of the user app + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.ListAvailableAccountsForUserApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.ListAvailableAccountsForUserApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAvailableAccountsForUserApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAvailableAccountsForUserApp`: []AppAccountDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAvailableAccountsForUserApp`: %v\n", resp) + } +- path: /source-apps + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/apps#list-available-source-apps + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, owner.id, accountSource.id** (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: **id, name, created, modified, owner.id, accountSource.id** (optional) + filters := `name eq "source app name"` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.ListAvailableSourceApps(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.ListAvailableSourceApps(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAvailableSourceApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAvailableSourceApps`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAvailableSourceApps`: %v\n", resp) + } +- path: /user-apps + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/apps#list-owned-user-apps + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + filters := `name eq "user app name"` // 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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.ListOwnedUserApps(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.ListOwnedUserApps(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListOwnedUserApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOwnedUserApps`: []UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListOwnedUserApps`: %v\n", resp) + } +- path: /source-apps/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/apps#patch-source-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app to patch # string | ID of the source app to patch + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]`) // []JsonPatchOperation | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.PatchSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.PatchSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.PatchSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSourceApp`: SourceAppPatchDto + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.PatchSourceApp`: %v\n", resp) + } +- path: /user-apps/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/apps#patch-user-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the user app to patch # string | ID of the user app to patch + 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") + jsonpatchoperation := []byte(``) // []JsonPatchOperation | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AppsAPI.PatchUserApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AppsAPI.PatchUserApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.PatchUserApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchUserApp`: UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.PatchUserApp`: %v\n", resp) + } +- path: /source-apps/bulk-update + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/apps#update-source-apps-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + sourceappbulkupdaterequest := []byte(`{ + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] + }`) // SourceAppBulkUpdateRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.AppsAPI.UpdateSourceAppsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.AppsAPI.UpdateSourceAppsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceAppBulkUpdateRequest(sourceAppBulkUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.UpdateSourceAppsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /auth-profiles/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/auth-profile#get-profile-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + id := `2c91808a7813090a017814121919ecca` // string | ID of the Auth Profile to patch. # string | ID of the Auth Profile to patch. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AuthProfileAPI.GetProfileConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AuthProfileAPI.GetProfileConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.GetProfileConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProfileConfig`: AuthProfile + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.GetProfileConfig`: %v\n", resp) + } +- path: /auth-profiles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/auth-profile#get-profile-config-list + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AuthProfileAPI.GetProfileConfigList(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.AuthProfileAPI.GetProfileConfigList(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.GetProfileConfigList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProfileConfigList`: []AuthProfileSummary + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.GetProfileConfigList`: %v\n", resp) + } +- path: /auth-profiles/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/auth-profile#patch-profile-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Auth Profile to patch. # string | ID of the Auth Profile to patch. + 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") + jsonpatchoperation := []byte(``) // []JsonPatchOperation | + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AuthProfileAPI.PatchProfileConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.AuthProfileAPI.PatchProfileConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.PatchProfileConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchProfileConfig`: AuthProfile + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.PatchProfileConfig`: %v\n", resp) + } +- path: /auth-users/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/auth-users#get-auth-user + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AuthUsersAPI.GetAuthUser(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.AuthUsersAPI.GetAuthUser(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthUsersAPI.GetAuthUser``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthUser`: AuthUser + fmt.Fprintf(os.Stdout, "Response from `AuthUsersAPI.GetAuthUser`: %v\n", resp) + } +- path: /auth-users/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/auth-users#patch-auth-user + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + jsonpatchoperation := []byte(`[{op=replace, path=/capabilities, value=[ORG_ADMIN]}]`) // []JsonPatchOperation | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.AuthUsersAPI.PatchAuthUser(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.AuthUsersAPI.PatchAuthUser(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthUsersAPI.PatchAuthUser``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthUser`: AuthUser + fmt.Fprintf(os.Stdout, "Response from `AuthUsersAPI.PatchAuthUser`: %v\n", resp) + } +- path: /brandings + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/branding#create-branding-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `name_example` // string | name of branding item # string | name of branding item + productName := `productName_example` // string | product name # string | product name + actionButtonColor := `actionButtonColor_example` // string | hex value of color for action button (optional) # string | hex value of color for action button (optional) + activeLinkColor := `activeLinkColor_example` // string | hex value of color for link (optional) # string | hex value of color for link (optional) + navigationColor := `navigationColor_example` // string | hex value of color for navigation bar (optional) # string | hex value of color for navigation bar (optional) + emailFromAddress := `emailFromAddress_example` // string | email from address (optional) # string | email from address (optional) + loginInformationalMessage := `loginInformationalMessage_example` // string | login information message (optional) # string | login information message (optional) + fileStandard := BINARY_DATA_HERE // *os.File | png file with logo (optional) # *os.File | png file with logo (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.BrandingAPI.CreateBrandingItem(context.Background()).Name(name).ProductName(productName).Execute() + //resp, r, err := apiClient.V2024.BrandingAPI.CreateBrandingItem(context.Background()).Name(name).ProductName(productName).ActionButtonColor(actionButtonColor).ActiveLinkColor(activeLinkColor).NavigationColor(navigationColor).EmailFromAddress(emailFromAddress).LoginInformationalMessage(loginInformationalMessage).FileStandard(fileStandard).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.CreateBrandingItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateBrandingItem`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.CreateBrandingItem`: %v\n", resp) + } +- path: /brandings/{name} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/branding#delete-branding + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `default` // string | The name of the branding item to be deleted # string | The name of the branding item to be deleted + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.BrandingAPI.DeleteBranding(context.Background(), name).Execute() + //r, err := apiClient.V2024.BrandingAPI.DeleteBranding(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.DeleteBranding``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /brandings/{name} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/branding#get-branding + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `default` // string | The name of the branding item to be retrieved # string | The name of the branding item to be retrieved + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.BrandingAPI.GetBranding(context.Background(), name).Execute() + //resp, r, err := apiClient.V2024.BrandingAPI.GetBranding(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.GetBranding``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBranding`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.GetBranding`: %v\n", resp) + } +- path: /brandings + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/branding#get-branding-list + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.BrandingAPI.GetBrandingList(context.Background()).Execute() + //resp, r, err := apiClient.V2024.BrandingAPI.GetBrandingList(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.GetBrandingList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBrandingList`: []BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.GetBrandingList`: %v\n", resp) + } +- path: /brandings/{name} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/branding#set-branding-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `default` // string | The name of the branding item to be retrieved # string | The name of the branding item to be retrieved + name2 := `name_example` // string | name of branding item # string | name of branding item + productName := `productName_example` // string | product name # string | product name + actionButtonColor := `actionButtonColor_example` // string | hex value of color for action button (optional) # string | hex value of color for action button (optional) + activeLinkColor := `activeLinkColor_example` // string | hex value of color for link (optional) # string | hex value of color for link (optional) + navigationColor := `navigationColor_example` // string | hex value of color for navigation bar (optional) # string | hex value of color for navigation bar (optional) + emailFromAddress := `emailFromAddress_example` // string | email from address (optional) # string | email from address (optional) + loginInformationalMessage := `loginInformationalMessage_example` // string | login information message (optional) # string | login information message (optional) + fileStandard := BINARY_DATA_HERE // *os.File | png file with logo (optional) # *os.File | png file with logo (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.BrandingAPI.SetBrandingItem(context.Background(), name).Name2(name2).ProductName(productName).Execute() + //resp, r, err := apiClient.V2024.BrandingAPI.SetBrandingItem(context.Background(), name).Name2(name2).ProductName(productName).ActionButtonColor(actionButtonColor).ActiveLinkColor(activeLinkColor).NavigationColor(navigationColor).EmailFromAddress(emailFromAddress).LoginInformationalMessage(loginInformationalMessage).FileStandard(fileStandard).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.SetBrandingItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetBrandingItem`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.SetBrandingItem`: %v\n", resp) + } +- path: /campaign-filters + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaign-filters#create-campaign-filter + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + campaignfilterdetails := []byte(`{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + }`) // CampaignFilterDetails | + + + var campaignFilterDetails v2024.CampaignFilterDetails + if err := json.Unmarshal(campaignfilterdetails, &campaignFilterDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignFiltersAPI.CreateCampaignFilter(context.Background()).CampaignFilterDetails(campaignFilterDetails).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignFiltersAPI.CreateCampaignFilter(context.Background()).CampaignFilterDetails(campaignFilterDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.CreateCampaignFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaignFilter`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.CreateCampaignFilter`: %v\n", resp) + } +- path: /campaign-filters/delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaign-filters#delete-campaign-filters + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestbody := []byte(``) // []string | A json list of IDs of campaign filters to delete. + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.CertificationCampaignFiltersAPI.DeleteCampaignFilters(context.Background()).RequestBody(requestBody).Execute() + //r, err := apiClient.V2024.CertificationCampaignFiltersAPI.DeleteCampaignFilters(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.DeleteCampaignFilters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /campaign-filters/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaign-filters#get-campaign-filter-by-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e9f9a1397b842fd5a65842087040d3ac` // string | The ID of the campaign filter to be retrieved. # string | The ID of the campaign filter to be retrieved. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignFiltersAPI.GetCampaignFilterById(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignFiltersAPI.GetCampaignFilterById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.GetCampaignFilterById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignFilterById`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.GetCampaignFilterById`: %v\n", resp) + } +- path: /campaign-filters + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaign-filters#list-campaign-filters + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + start := 0 // int32 | Start/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 | Start/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) + includeSystemFilters := true // bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to true) # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignFiltersAPI.ListCampaignFilters(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignFiltersAPI.ListCampaignFilters(context.Background()).Limit(limit).Start(start).IncludeSystemFilters(includeSystemFilters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.ListCampaignFilters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCampaignFilters`: ListCampaignFilters200Response + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.ListCampaignFilters`: %v\n", resp) + } +- path: /campaign-filters/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaign-filters#update-campaign-filter + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filterId := `e9f9a1397b842fd5a65842087040d3ac` // string | The ID of the campaign filter being modified. # string | The ID of the campaign filter being modified. + campaignfilterdetails := []byte(`{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + }`) // CampaignFilterDetails | A campaign filter details with updated field values. + + + var campaignFilterDetails v2024.CampaignFilterDetails + if err := json.Unmarshal(campaignfilterdetails, &campaignFilterDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignFiltersAPI.UpdateCampaignFilter(context.Background(), filterId).CampaignFilterDetails(campaignFilterDetails).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignFiltersAPI.UpdateCampaignFilter(context.Background(), filterId).CampaignFilterDetails(campaignFilterDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.UpdateCampaignFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCampaignFilter`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.UpdateCampaignFilter`: %v\n", resp) + } +- path: /campaigns/{id}/complete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#complete-campaign + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Campaign ID. # string | Campaign ID. + campaigncompleteoptions := []byte(`{ + "autoCompleteAction" : "REVOKE" + }`) // CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.CompleteCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.CompleteCampaign(context.Background(), id).CampaignCompleteOptions(campaignCompleteOptions).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CompleteCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompleteCampaign`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CompleteCampaign`: %v\n", resp) + } +- path: /campaigns + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#create-campaign + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + campaign := []byte(`{ + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }`) // Campaign | + + + var campaign v2024.Campaign + if err := json.Unmarshal(campaign, &campaign); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.CreateCampaign(context.Background()).Campaign(campaign).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.CreateCampaign(context.Background()).Campaign(campaign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CreateCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaign`: Campaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CreateCampaign`: %v\n", resp) + } +- path: /campaign-templates + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#create-campaign-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + campaigntemplate := []byte(`{ + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + }`) // CampaignTemplate | + + + var campaignTemplate v2024.CampaignTemplate + if err := json.Unmarshal(campaigntemplate, &campaignTemplate); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.CreateCampaignTemplate(context.Background()).CampaignTemplate(campaignTemplate).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.CreateCampaignTemplate(context.Background()).CampaignTemplate(campaignTemplate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CreateCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CreateCampaignTemplate`: %v\n", resp) + } +- path: /campaign-templates/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#delete-campaign-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template being deleted. # string | ID of the campaign template being deleted. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.CertificationCampaignsAPI.DeleteCampaignTemplate(context.Background(), id).Execute() + //r, err := apiClient.V2024.CertificationCampaignsAPI.DeleteCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /campaign-templates/{id}/schedule + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#delete-campaign-template-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template whose schedule is being deleted. # string | ID of the campaign template whose schedule is being deleted. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.CertificationCampaignsAPI.DeleteCampaignTemplateSchedule(context.Background(), id).Execute() + //r, err := apiClient.V2024.CertificationCampaignsAPI.DeleteCampaignTemplateSchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /campaigns/delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#delete-campaigns + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + campaignsdeleterequest := []byte(`{ + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + }`) // CampaignsDeleteRequest | IDs of the campaigns to delete. + + + var campaignsDeleteRequest v2024.CampaignsDeleteRequest + if err := json.Unmarshal(campaignsdeleterequest, &campaignsDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).CampaignsDeleteRequest(campaignsDeleteRequest).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).CampaignsDeleteRequest(campaignsDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaigns``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteCampaigns`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.DeleteCampaigns`: %v\n", resp) + } +- path: /campaigns + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#get-active-campaigns + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Manager Campaign"` // 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* **status**: *eq, in* (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* **status**: *eq, in* (optional) + sorters := `name` // 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, created** (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, created** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetActiveCampaigns(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetActiveCampaigns(context.Background()).Detail(detail).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetActiveCampaigns``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetActiveCampaigns`: []GetActiveCampaigns200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetActiveCampaigns`: %v\n", resp) + } +- path: /campaigns/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#get-campaign + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign to be retrieved. # string | ID of the campaign to be retrieved. + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaign(context.Background(), id).Detail(detail).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaign`: GetCampaign200Response + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaign`: %v\n", resp) + } +- path: /campaigns/{id}/reports + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#get-campaign-reports + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign whose reports are being fetched. # string | ID of the campaign whose reports are being fetched. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignReports(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignReports(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignReports``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignReports`: []CampaignReport + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignReports`: %v\n", resp) + } +- path: /campaigns/reports-configuration + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#get-campaign-reports-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignReportsConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignReportsConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignReportsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignReportsConfig`: CampaignReportsConfig + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignReportsConfig`: %v\n", resp) + } +- path: /campaign-templates/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#get-campaign-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Requested campaign template's ID. # string | Requested campaign template's ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplate`: %v\n", resp) + } +- path: /campaign-templates/{id}/schedule + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#get-campaign-template-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template whose schedule is being fetched. # string | ID of the campaign template whose schedule is being fetched. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignTemplateSchedule(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignTemplateSchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplateSchedule`: Schedule + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplateSchedule`: %v\n", resp) + } +- path: /campaign-templates + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#get-campaign-templates + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name` // 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, created, modified** (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, created, modified** (optional) + filters := `name eq "manager template"` // 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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignTemplates(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.GetCampaignTemplates(context.Background()).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplates`: []CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplates`: %v\n", resp) + } +- path: /campaigns/{id}/reassign + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#move + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification campaign ID # string | The certification campaign ID + adminreviewreassign := []byte(`{ + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + }`) // AdminReviewReassign | + + + var adminReviewReassign v2024.AdminReviewReassign + if err := json.Unmarshal(adminreviewreassign, &adminReviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.Move(context.Background(), id).AdminReviewReassign(adminReviewReassign).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.Move(context.Background(), id).AdminReviewReassign(adminReviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.Move``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `Move`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.Move`: %v\n", resp) + } +- path: /campaign-templates/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#patch-campaign-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template being modified. # string | ID of the campaign template being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/campaign/filter/id, value=ff80818155fe8c080155fe8d925b0316}]`) // []JsonPatchOperation | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.PatchCampaignTemplate(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.PatchCampaignTemplate(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.PatchCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.PatchCampaignTemplate`: %v\n", resp) + } +- path: /campaigns/reports-configuration + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#set-campaign-reports-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + campaignreportsconfig := []byte(`{ + "identityAttributeColumns" : [ "firstname", "lastname" ] + }`) // CampaignReportsConfig | Campaign report configuration. + + + var campaignReportsConfig v2024.CampaignReportsConfig + if err := json.Unmarshal(campaignreportsconfig, &campaignReportsConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.SetCampaignReportsConfig(context.Background()).CampaignReportsConfig(campaignReportsConfig).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.SetCampaignReportsConfig(context.Background()).CampaignReportsConfig(campaignReportsConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.SetCampaignReportsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetCampaignReportsConfig`: CampaignReportsConfig + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.SetCampaignReportsConfig`: %v\n", resp) + } +- path: /campaign-templates/{id}/schedule + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#set-campaign-template-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template being scheduled. # string | ID of the campaign template being scheduled. + schedule := []byte(`{ + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + }`) // Schedule | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.CertificationCampaignsAPI.SetCampaignTemplateSchedule(context.Background(), id).Execute() + //r, err := apiClient.V2024.CertificationCampaignsAPI.SetCampaignTemplateSchedule(context.Background(), id).Schedule(schedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.SetCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /campaigns/{id}/activate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#start-campaign + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Campaign ID. # string | Campaign ID. + activatecampaignoptions := []byte(`{ + "timeZone" : "-05:00" + }`) // ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.StartCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.StartCampaign(context.Background(), id).ActivateCampaignOptions(activateCampaignOptions).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaign`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaign`: %v\n", resp) + } +- path: /campaigns/{id}/run-remediation-scan + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#start-campaign-remediation-scan + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign the remediation scan is being run for. # string | ID of the campaign the remediation scan is being run for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.StartCampaignRemediationScan(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.StartCampaignRemediationScan(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaignRemediationScan``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaignRemediationScan`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaignRemediationScan`: %v\n", resp) + } +- path: /campaigns/{id}/run-report/{type} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#start-campaign-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign the report is being run for. # string | ID of the campaign the report is being run for. + type_ := // ReportType | Type of the report to run. # ReportType | Type of the report to run. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.StartCampaignReport(context.Background(), id, type_).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.StartCampaignReport(context.Background(), id, type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaignReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaignReport`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaignReport`: %v\n", resp) + } +- path: /campaign-templates/{id}/generate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#start-generate-campaign-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template to use for generation. # string | ID of the campaign template to use for generation. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.StartGenerateCampaignTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.StartGenerateCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartGenerateCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartGenerateCampaignTemplate`: CampaignReference + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartGenerateCampaignTemplate`: %v\n", resp) + } +- path: /campaigns/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-campaigns#update-campaign + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign template being modified. # string | ID of the campaign template being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]`) // []JsonPatchOperation | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationCampaignsAPI.UpdateCampaign(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.CertificationCampaignsAPI.UpdateCampaign(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.UpdateCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCampaign`: SlimCampaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.UpdateCampaign`: %v\n", resp) + } +- path: /certification-tasks/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certifications#get-certification-task + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `63b32151-26c0-42f4-9299-8898dc1c9daa` // string | The task ID # string | The task ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.GetCertificationTask(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.GetCertificationTask(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetCertificationTask``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCertificationTask`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetCertificationTask`: %v\n", resp) + } +- path: /certifications/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certifications#get-identity-certification + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification id # string | The certification id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.GetIdentityCertification(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.GetIdentityCertification(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertification`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertification`: %v\n", resp) + } +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certifications#get-identity-certification-item-permissions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + certificationId := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification ID + itemId := `2c91808671bcbab40171bd945d961227` // string | The certification item ID # string | The certification item ID + filters := `target eq "SYS.OBJAUTH2"` // 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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.GetIdentityCertificationItemPermissions(context.Background(), certificationId, itemId).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.GetIdentityCertificationItemPermissions(context.Background(), certificationId, itemId).Filters(filters).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertificationItemPermissions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertificationItemPermissions`: []PermissionDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertificationItemPermissions`: %v\n", resp) + } +- path: /certification-tasks + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certifications#get-pending-certification-tasks + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reviewerIdentity := `Ada.1de82e55078344` // string | The ID of reviewer identity. *me* indicates the current user. (optional) # string | The ID of reviewer identity. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `type eq "ADMIN_REASSIGN"` // 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* **targetId**: *eq, in* **type**: *eq, in* (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* **targetId**: *eq, in* **type**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.GetPendingCertificationTasks(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.GetPendingCertificationTasks(context.Background()).ReviewerIdentity(reviewerIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetPendingCertificationTasks``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPendingCertificationTasks`: []CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetPendingCertificationTasks`: %v\n", resp) + } +- path: /certifications/{id}/reviewers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certifications#list-certification-reviewers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Bob"` // 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* **email**: *eq, sw* (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* **email**: *eq, sw* (optional) + sorters := `name` // 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, email** (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, email** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.ListCertificationReviewers(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.ListCertificationReviewers(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListCertificationReviewers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCertificationReviewers`: []IdentityReferenceWithNameAndEmail + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListCertificationReviewers`: %v\n", resp) + } +- path: /certifications/{id}/access-review-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certifications#list-identity-access-review-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters := `access.name,-accessProfile.sourceName` // 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) + entitlements := `identityEntitlement` // string | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) + accessProfiles := `accessProfile1` // string | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) + roles := `userRole` // string | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.ListIdentityAccessReviewItems(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.ListIdentityAccessReviewItems(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Entitlements(entitlements).AccessProfiles(accessProfiles).Roles(roles).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListIdentityAccessReviewItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityAccessReviewItems`: []AccessReviewItem + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListIdentityAccessReviewItems`: %v\n", resp) + } +- path: /certifications + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certifications#list-identity-certifications + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reviewerIdentity := `me` // string | Reviewer's identity. *me* indicates the current user. (optional) # string | Reviewer's identity. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) + sorters := `name,due` // 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, due, signed** (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, due, signed** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.ListIdentityCertifications(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.ListIdentityCertifications(context.Background()).ReviewerIdentity(reviewerIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListIdentityCertifications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityCertifications`: []IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListIdentityCertifications`: %v\n", resp) + } +- path: /certifications/{id}/decide + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certifications#make-identity-decision + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the identity campaign certification on which to make decisions # string | The ID of the identity campaign certification on which to make decisions + reviewdecision := []byte(`[{id=ef38f94347e94562b5bb8424a56396b5, decision=APPROVE, bulk=true, comments=This user still needs access to this source.}, {id=ef38f94347e94562b5bb8424a56397d8, decision=APPROVE, bulk=true, comments=This user still needs access to this source too.}]`) // []ReviewDecision | A non-empty array of decisions to be made. + + + var reviewDecision v2024.[]ReviewDecision + if err := json.Unmarshal(reviewdecision, &reviewDecision); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.MakeIdentityDecision(context.Background(), id).ReviewDecision(reviewDecision).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.MakeIdentityDecision(context.Background(), id).ReviewDecision(reviewDecision).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.MakeIdentityDecision``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `MakeIdentityDecision`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.MakeIdentityDecision`: %v\n", resp) + } +- path: /certifications/{id}/reassign + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certifications#reassign-identity-certifications + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + reviewreassign := []byte(`{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + }`) // ReviewReassign | + + + var reviewReassign v2024.ReviewReassign + if err := json.Unmarshal(reviewreassign, &reviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.ReassignIdentityCertifications(context.Background(), id).ReviewReassign(reviewReassign).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.ReassignIdentityCertifications(context.Background(), id).ReviewReassign(reviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ReassignIdentityCertifications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ReassignIdentityCertifications`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ReassignIdentityCertifications`: %v\n", resp) + } +- path: /certifications/{id}/sign-off + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certifications#sign-off-identity-certification + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.SignOffIdentityCertification(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.SignOffIdentityCertification(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.SignOffIdentityCertification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SignOffIdentityCertification`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.SignOffIdentityCertification`: %v\n", resp) + } +- path: /certifications/{id}/reassign-async + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certifications#submit-reassign-certs-async + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + reviewreassign := []byte(`{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + }`) // ReviewReassign | + + + var reviewReassign v2024.ReviewReassign + if err := json.Unmarshal(reviewreassign, &reviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationsAPI.SubmitReassignCertsAsync(context.Background(), id).ReviewReassign(reviewReassign).Execute() + //resp, r, err := apiClient.V2024.CertificationsAPI.SubmitReassignCertsAsync(context.Background(), id).ReviewReassign(reviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.SubmitReassignCertsAsync``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitReassignCertsAsync`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.SubmitReassignCertsAsync`: %v\n", resp) + } +- path: /certifications/{id}/access-summaries/{type} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + type_ := `ACCESS_PROFILE` // string | The type of access review item to retrieve summaries for # string | The type of access review item to retrieve summaries for + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "ef38f94347e94562b5bb8424a56397d8"` // 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters := `access.name` // 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: **access.name** (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: **access.name** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationSummariesAPI.GetIdentityAccessSummaries(context.Background(), id, type_).Execute() + //resp, r, err := apiClient.V2024.CertificationSummariesAPI.GetIdentityAccessSummaries(context.Background(), id, type_).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentityAccessSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityAccessSummaries`: []AccessSummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentityAccessSummaries`: %v\n", resp) + } +- path: /certifications/{id}/decision-summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification ID + filters := `identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"` // 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: **identitySummary.id**: *eq, in* (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: **identitySummary.id**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationSummariesAPI.GetIdentityDecisionSummary(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationSummariesAPI.GetIdentityDecisionSummary(context.Background(), id).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentityDecisionSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityDecisionSummary`: IdentityCertDecisionSummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentityDecisionSummary`: %v\n", resp) + } +- path: /certifications/{id}/identity-summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-summaries#get-identity-summaries + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **completed**: *eq, ne* **name**: *eq, sw* (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* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters := `name` // 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** (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** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationSummariesAPI.GetIdentitySummaries(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.CertificationSummariesAPI.GetIdentitySummaries(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentitySummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySummaries`: []CertificationIdentitySummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentitySummaries`: %v\n", resp) + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/certification-summaries#get-identity-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + identitySummaryId := `2c91808772a504f50172a9540e501ba8` // string | The identity summary ID # string | The identity summary ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CertificationSummariesAPI.GetIdentitySummary(context.Background(), id, identitySummaryId).Execute() + //resp, r, err := apiClient.V2024.CertificationSummariesAPI.GetIdentitySummary(context.Background(), id, identitySummaryId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentitySummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySummary`: CertificationIdentitySummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentitySummary`: %v\n", resp) + } +- path: /configuration-hub/deploys + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#create-deploy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + deployrequest := []byte(`{ + "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" + }`) // DeployRequest | The deploy request body. + + + var deployRequest v2024.DeployRequest + if err := json.Unmarshal(deployrequest, &deployRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateDeploy(context.Background()).DeployRequest(deployRequest).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateDeploy(context.Background()).DeployRequest(deployRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateDeploy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDeploy`: DeployResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateDeploy`: %v\n", resp) + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#create-object-mapping + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingrequest := []byte(`{ + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }`) // ObjectMappingRequest | The object mapping request body. + + + var objectMappingRequest v2024.ObjectMappingRequest + if err := json.Unmarshal(objectmappingrequest, &objectMappingRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateObjectMapping(context.Background(), sourceOrg).ObjectMappingRequest(objectMappingRequest).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateObjectMapping(context.Background(), sourceOrg).ObjectMappingRequest(objectMappingRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateObjectMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateObjectMapping`: ObjectMappingResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateObjectMapping`: %v\n", resp) + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#create-object-mappings + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingbulkcreaterequest := []byte(`{ + "newObjectsMappings" : [ { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }, { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } ] + }`) // ObjectMappingBulkCreateRequest | The bulk create object mapping request body. + + + var objectMappingBulkCreateRequest v2024.ObjectMappingBulkCreateRequest + if err := json.Unmarshal(objectmappingbulkcreaterequest, &objectMappingBulkCreateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkCreateRequest(objectMappingBulkCreateRequest).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkCreateRequest(objectMappingBulkCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateObjectMappings`: ObjectMappingBulkCreateResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateObjectMappings`: %v\n", resp) + } +- path: /configuration-hub/scheduled-actions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#create-scheduled-action + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scheduledactionpayload := []byte(`{ + "cronString" : "0 0 12 * * * *", + "timeZoneId" : "America/Chicago", + "startTime" : "2024-08-16T14:16:58.389Z", + "jobType" : "BACKUP", + "content" : { + "sourceTenant" : "tenant-name", + "draftId" : "9012b87d-48ca-439a-868f-2160001da8c3", + "name" : "Daily Backup", + "backupOptions" : { + "includeTypes" : [ "ROLE", "IDENTITY_PROFILE" ], + "objectOptions" : { + "SOURCE" : { + "includedNames" : [ "Source1", "Source2" ] + }, + "ROLE" : { + "includedNames" : [ "Admin Role", "User Role" ] + } + } + }, + "sourceBackupId" : "5678b87d-48ca-439a-868f-2160001da8c2" + } + }`) // ScheduledActionPayload | The scheduled action creation request body. + + + var scheduledActionPayload v2024.ScheduledActionPayload + if err := json.Unmarshal(scheduledactionpayload, &scheduledActionPayload); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateScheduledAction(context.Background()).ScheduledActionPayload(scheduledActionPayload).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateScheduledAction(context.Background()).ScheduledActionPayload(scheduledActionPayload).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateScheduledAction``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateScheduledAction`: ScheduledActionResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateScheduledAction`: %v\n", resp) + } +- path: /configuration-hub/backups/uploads + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#create-uploaded-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + data := BINARY_DATA_HERE // *os.File | JSON file containing the objects to be imported. # *os.File | JSON file containing the objects to be imported. + name := `name_example` // string | Name that will be assigned to the uploaded configuration file. # string | Name that will be assigned to the uploaded configuration file. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateUploadedConfiguration(context.Background()).Data(data).Name(name).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.CreateUploadedConfiguration(context.Background()).Data(data).Name(name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateUploadedConfiguration`: BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateUploadedConfiguration`: %v\n", resp) + } +- path: /configuration-hub/backups/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#delete-backup + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `07659d7d-2cce-47c0-9e49-185787ee565a` // string | The id of the backup to delete. # string | The id of the backup to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ConfigurationHubAPI.DeleteBackup(context.Background(), id).Execute() + //r, err := apiClient.V2024.ConfigurationHubAPI.DeleteBackup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteBackup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /configuration-hub/drafts/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#delete-draft + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `07659d7d-2cce-47c0-9e49-185787ee565a` // string | The id of the draft to delete. # string | The id of the draft to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ConfigurationHubAPI.DeleteDraft(context.Background(), id).Execute() + //r, err := apiClient.V2024.ConfigurationHubAPI.DeleteDraft(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteDraft``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#delete-object-mapping + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectMappingId := `3d6e0144-963f-4bd6-8d8d-d77b4e507ce4` // string | The id of the object mapping to be deleted. # string | The id of the object mapping to be deleted. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ConfigurationHubAPI.DeleteObjectMapping(context.Background(), sourceOrg, objectMappingId).Execute() + //r, err := apiClient.V2024.ConfigurationHubAPI.DeleteObjectMapping(context.Background(), sourceOrg, objectMappingId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteObjectMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /configuration-hub/scheduled-actions/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#delete-scheduled-action + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scheduledActionId := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | The ID of the scheduled action. # string | The ID of the scheduled action. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ConfigurationHubAPI.DeleteScheduledAction(context.Background(), scheduledActionId).Execute() + //r, err := apiClient.V2024.ConfigurationHubAPI.DeleteScheduledAction(context.Background(), scheduledActionId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteScheduledAction``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /configuration-hub/backups/uploads/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#delete-uploaded-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `3d0fe04b-57df-4a46-a83b-8f04b0f9d10b` // string | The id of the uploaded configuration. # string | The id of the uploaded configuration. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ConfigurationHubAPI.DeleteUploadedConfiguration(context.Background(), id).Execute() + //r, err := apiClient.V2024.ConfigurationHubAPI.DeleteUploadedConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /configuration-hub/deploys/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#get-deploy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `3d0fe04b-57df-4a46-a83b-8f04b0f9d10b` // string | The id of the deploy. # string | The id of the deploy. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.GetDeploy(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.GetDeploy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.GetDeploy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDeploy`: DeployResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.GetDeploy`: %v\n", resp) + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#get-object-mappings + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.GetObjectMappings(context.Background(), sourceOrg).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.GetObjectMappings(context.Background(), sourceOrg).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.GetObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetObjectMappings`: []ObjectMappingResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.GetObjectMappings`: %v\n", resp) + } +- path: /configuration-hub/backups/uploads/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#get-uploaded-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `3d0fe04b-57df-4a46-a83b-8f04b0f9d10b` // string | The id of the uploaded configuration. # string | The id of the uploaded configuration. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.GetUploadedConfiguration(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.GetUploadedConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.GetUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUploadedConfiguration`: BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.GetUploadedConfiguration`: %v\n", resp) + } +- path: /configuration-hub/backups + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#list-backups + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filters := `status eq "COMPLETE"` // 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: **status**: *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: **status**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListBackups(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListBackups(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListBackups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListBackups`: []BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListBackups`: %v\n", resp) + } +- path: /configuration-hub/deploys + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#list-deploys + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListDeploys(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListDeploys(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListDeploys``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDeploys`: ListDeploys200Response + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListDeploys`: %v\n", resp) + } +- path: /configuration-hub/drafts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#list-drafts + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filters := `status eq "COMPLETE"` // 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: **status**: *eq* **approvalStatus**: *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: **status**: *eq* **approvalStatus**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListDrafts(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListDrafts(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListDrafts``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDrafts`: []DraftResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListDrafts`: %v\n", resp) + } +- path: /configuration-hub/scheduled-actions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#list-scheduled-actions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListScheduledActions(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListScheduledActions(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListScheduledActions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListScheduledActions`: []ScheduledActionResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListScheduledActions`: %v\n", resp) + } +- path: /configuration-hub/backups/uploads + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#list-uploaded-configurations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filters := `status eq "COMPLETE"` // 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: **status**: *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: **status**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListUploadedConfigurations(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.ListUploadedConfigurations(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListUploadedConfigurations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListUploadedConfigurations`: []BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListUploadedConfigurations`: %v\n", resp) + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#update-object-mappings + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingbulkpatchrequest := []byte(`{ + "patches" : { + "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : true + } ], + "00bece34-f50d-4227-8878-76f620b5a971" : [ { + "op" : "replace", + "path" : "/targetValue", + "value" : "New Target Value" + } ] + } + }`) // ObjectMappingBulkPatchRequest | The object mapping request body. + + + var objectMappingBulkPatchRequest v2024.ObjectMappingBulkPatchRequest + if err := json.Unmarshal(objectmappingbulkpatchrequest, &objectMappingBulkPatchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.UpdateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkPatchRequest(objectMappingBulkPatchRequest).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.UpdateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkPatchRequest(objectMappingBulkPatchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.UpdateObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateObjectMappings`: ObjectMappingBulkPatchResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.UpdateObjectMappings`: %v\n", resp) + } +- path: /configuration-hub/scheduled-actions/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/configuration-hub#update-scheduled-action + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scheduledActionId := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | The ID of the scheduled action. # string | The ID of the scheduled action. + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | The JSON Patch document containing the changes to apply to the scheduled action. + + + var jsonPatch v2024.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConfigurationHubAPI.UpdateScheduledAction(context.Background(), scheduledActionId).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2024.ConfigurationHubAPI.UpdateScheduledAction(context.Background(), scheduledActionId).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.UpdateScheduledAction``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateScheduledAction`: ScheduledActionResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.UpdateScheduledAction`: %v\n", resp) + } +- path: /connector-customizers + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connector-customizers#create-connector-customizer + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + connectorcustomizercreaterequest := []byte(`{ + "name" : "My Custom Connector" + }`) // ConnectorCustomizerCreateRequest | Connector customizer to create. + + + var connectorCustomizerCreateRequest v2024.ConnectorCustomizerCreateRequest + if err := json.Unmarshal(connectorcustomizercreaterequest, &connectorCustomizerCreateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.CreateConnectorCustomizer(context.Background()).ConnectorCustomizerCreateRequest(connectorCustomizerCreateRequest).Execute() + //resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.CreateConnectorCustomizer(context.Background()).ConnectorCustomizerCreateRequest(connectorCustomizerCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.CreateConnectorCustomizer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateConnectorCustomizer`: ConnectorCustomizerCreateResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.CreateConnectorCustomizer`: %v\n", resp) + } +- path: /connector-customizers/{id}/versions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connector-customizers#create-connector-customizer-version + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | The id of the connector customizer. # string | The id of the connector customizer. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.CreateConnectorCustomizerVersion(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.CreateConnectorCustomizerVersion(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.CreateConnectorCustomizerVersion``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateConnectorCustomizerVersion`: ConnectorCustomizerVersionCreateResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.CreateConnectorCustomizerVersion`: %v\n", resp) + } +- path: /connector-customizers/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connector-customizers#delete-connector-customizer + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | ID of the connector customizer to delete. # string | ID of the connector customizer to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ConnectorCustomizersAPI.DeleteConnectorCustomizer(context.Background(), id).Execute() + //r, err := apiClient.V2024.ConnectorCustomizersAPI.DeleteConnectorCustomizer(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.DeleteConnectorCustomizer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /connector-customizers/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connector-customizers#get-connector-customizer + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | ID of the connector customizer to get. # string | ID of the connector customizer to get. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.GetConnectorCustomizer(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.GetConnectorCustomizer(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.GetConnectorCustomizer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorCustomizer`: ConnectorCustomizersResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.GetConnectorCustomizer`: %v\n", resp) + } +- path: /connector-customizers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connector-customizers#list-connector-customizers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.ListConnectorCustomizers(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.ListConnectorCustomizers(context.Background()).Offset(offset).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.ListConnectorCustomizers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListConnectorCustomizers`: []ConnectorCustomizersResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.ListConnectorCustomizers`: %v\n", resp) + } +- path: /connector-customizers/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connector-customizers#put-connector-customizer + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | ID of the connector customizer to update. # string | ID of the connector customizer to update. + connectorcustomizerupdaterequest := []byte(`{ + "name" : "My Custom Connector" + }`) // ConnectorCustomizerUpdateRequest | Connector rule with updated data. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.PutConnectorCustomizer(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ConnectorCustomizersAPI.PutConnectorCustomizer(context.Background(), id).ConnectorCustomizerUpdateRequest(connectorCustomizerUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.PutConnectorCustomizer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorCustomizer`: ConnectorCustomizerUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.PutConnectorCustomizer`: %v\n", resp) + } +- path: /connector-rules + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connector-rule-management#create-connector-rule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + connectorrulecreaterequest := []byte(`{ + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "type" : "BuildMap" + }`) // ConnectorRuleCreateRequest | Connector rule to create. + + + var connectorRuleCreateRequest v2024.ConnectorRuleCreateRequest + if err := json.Unmarshal(connectorrulecreaterequest, &connectorRuleCreateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.CreateConnectorRule(context.Background()).ConnectorRuleCreateRequest(connectorRuleCreateRequest).Execute() + //resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.CreateConnectorRule(context.Background()).ConnectorRuleCreateRequest(connectorRuleCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.CreateConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.CreateConnectorRule`: %v\n", resp) + } +- path: /connector-rules/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connector-rule-management#delete-connector-rule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to delete. # string | ID of the connector rule to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ConnectorRuleManagementAPI.DeleteConnectorRule(context.Background(), id).Execute() + //r, err := apiClient.V2024.ConnectorRuleManagementAPI.DeleteConnectorRule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.DeleteConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /connector-rules/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connector-rule-management#get-connector-rule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to get. # string | ID of the connector rule to get. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.GetConnectorRule(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.GetConnectorRule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.GetConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.GetConnectorRule`: %v\n", resp) + } +- path: /connector-rules + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connector-rule-management#get-connector-rule-list + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.GetConnectorRuleList(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.GetConnectorRuleList(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.GetConnectorRuleList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorRuleList`: []ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.GetConnectorRuleList`: %v\n", resp) + } +- path: /connector-rules/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connector-rule-management#put-connector-rule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to update. # string | ID of the connector rule to update. + connectorruleupdaterequest := []byte(`{ + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", + "type" : "BuildMap" + }`) // ConnectorRuleUpdateRequest | Connector rule with updated data. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.PutConnectorRule(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.PutConnectorRule(context.Background(), id).ConnectorRuleUpdateRequest(connectorRuleUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.PutConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.PutConnectorRule`: %v\n", resp) + } +- path: /connector-rules/validate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connector-rule-management#test-connector-rule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourcecode := []byte(`{ + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }`) // SourceCode | Code to validate. + + + var sourceCode v2024.SourceCode + if err := json.Unmarshal(sourcecode, &sourceCode); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.TestConnectorRule(context.Background()).SourceCode(sourceCode).Execute() + //resp, r, err := apiClient.V2024.ConnectorRuleManagementAPI.TestConnectorRule(context.Background()).SourceCode(sourceCode).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.TestConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestConnectorRule`: ConnectorRuleValidationResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.TestConnectorRule`: %v\n", resp) + } +- path: /connectors + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connectors#create-custom-connector + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + v3createconnectordto := []byte(`{ + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + }`) // V3CreateConnectorDto | + + + var v3CreateConnectorDto v2024.V3CreateConnectorDto + if err := json.Unmarshal(v3createconnectordto, &v3CreateConnectorDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.CreateCustomConnector(context.Background()).V3CreateConnectorDto(v3CreateConnectorDto).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.CreateCustomConnector(context.Background()).V3CreateConnectorDto(v3CreateConnectorDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.CreateCustomConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCustomConnector`: V3ConnectorDto + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.CreateCustomConnector`: %v\n", resp) + } +- path: /connectors/{scriptName} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connectors#delete-custom-connector + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ConnectorsAPI.DeleteCustomConnector(context.Background(), scriptName).Execute() + //r, err := apiClient.V2024.ConnectorsAPI.DeleteCustomConnector(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.DeleteCustomConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /connectors/{scriptName} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connectors#get-connector + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnector(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnector(context.Background(), scriptName).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnector`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnector`: %v\n", resp) + } +- path: /connectors/{scriptName}/correlation-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connectors#get-connector-correlation-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorCorrelationConfig(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorCorrelationConfig(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorCorrelationConfig`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorCorrelationConfig`: %v\n", resp) + } +- path: /connectors + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connectors#get-connector-list + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filters := `directConnect eq "true"` // 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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorList(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorList(context.Background()).Filters(filters).Limit(limit).Offset(offset).Count(count).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorList`: []V3ConnectorDto + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorList`: %v\n", resp) + } +- path: /connectors/{scriptName}/source-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connectors#get-connector-source-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorSourceConfig(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorSourceConfig(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorSourceConfig`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorSourceConfig`: %v\n", resp) + } +- path: /connectors/{scriptName}/source-template + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connectors#get-connector-source-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorSourceTemplate(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorSourceTemplate(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorSourceTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorSourceTemplate`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorSourceTemplate`: %v\n", resp) + } +- path: /connectors/{scriptName}/translations/{locale} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connectors#get-connector-translations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorTranslations(context.Background(), scriptName, locale).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.GetConnectorTranslations(context.Background(), scriptName, locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorTranslations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorTranslations`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorTranslations`: %v\n", resp) + } +- path: /connectors/{scriptName}/correlation-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connectors#put-connector-correlation-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + file := BINARY_DATA_HERE // *os.File | connector correlation config xml file # *os.File | connector correlation config xml file + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.PutConnectorCorrelationConfig(context.Background(), scriptName).File(file).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.PutConnectorCorrelationConfig(context.Background(), scriptName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorCorrelationConfig`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorCorrelationConfig`: %v\n", resp) + } +- path: /connectors/{scriptName}/source-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connectors#put-connector-source-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + file := BINARY_DATA_HERE // *os.File | connector source config xml file # *os.File | connector source config xml file + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.PutConnectorSourceConfig(context.Background(), scriptName).File(file).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.PutConnectorSourceConfig(context.Background(), scriptName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorSourceConfig`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorSourceConfig`: %v\n", resp) + } +- path: /connectors/{scriptName}/source-template + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connectors#put-connector-source-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + file := BINARY_DATA_HERE // *os.File | connector source template xml file # *os.File | connector source template xml file + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.PutConnectorSourceTemplate(context.Background(), scriptName).File(file).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.PutConnectorSourceTemplate(context.Background(), scriptName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorSourceTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorSourceTemplate`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorSourceTemplate`: %v\n", resp) + } +- path: /connectors/{scriptName}/translations/{locale} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connectors#put-connector-translations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.PutConnectorTranslations(context.Background(), scriptName, locale).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.PutConnectorTranslations(context.Background(), scriptName, locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorTranslations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorTranslations`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorTranslations`: %v\n", resp) + } +- path: /connectors/{scriptName} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/connectors#update-connector + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | A list of connector detail update operations + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ConnectorsAPI.UpdateConnector(context.Background(), scriptName).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.ConnectorsAPI.UpdateConnector(context.Background(), scriptName).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.UpdateConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateConnector`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.UpdateConnector`: %v\n", resp) + } +- path: /form-definitions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#create-form-definition + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + body := []byte(`{ + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + }`) // CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.CreateFormDefinition(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.CreateFormDefinition(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinition`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinition`: %v\n", resp) + } +- path: /form-definitions/forms-action-dynamic-schema + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#create-form-definition-dynamic-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + body := []byte(`{ + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 + }`) // FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.CreateFormDefinitionDynamicSchema(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.CreateFormDefinitionDynamicSchema(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinitionDynamicSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinitionDynamicSchema`: FormDefinitionDynamicSchemaResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinitionDynamicSchema`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID}/upload + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#create-form-definition-file-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | FormDefinitionID String specifying FormDefinitionID # string | FormDefinitionID String specifying FormDefinitionID + file := BINARY_DATA_HERE // *os.File | File specifying the multipart # *os.File | File specifying the multipart + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.CreateFormDefinitionFileRequest(context.Background(), formDefinitionID).File(file).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.CreateFormDefinitionFileRequest(context.Background(), formDefinitionID).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinitionFileRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinitionFileRequest`: FormDefinitionFileUploadResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinitionFileRequest`: %v\n", resp) + } +- path: /form-instances + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#create-form-instance + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + body := []byte(`{ + "formInput" : { + "input1" : "Sales" + }, + "standAloneForm" : false, + "createdBy" : { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "WORKFLOW_EXECUTION" + }, + "recipients" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + } ], + "expire" : "2023-08-12T20:14:57.74486Z", + "formDefinitionId" : "00000000-0000-0000-0000-000000000000", + "state" : "ASSIGNED", + "ttl" : 1571827560 + }`) // CreateFormInstanceRequest | Body is the request payload to create a form instance (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.CreateFormInstance(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.CreateFormInstance(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormInstance`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormInstance`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#delete-form-definition + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.DeleteFormDefinition(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.DeleteFormDefinition(context.Background(), formDefinitionID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.DeleteFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteFormDefinition`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.DeleteFormDefinition`: %v\n", resp) + } +- path: /form-definitions/export + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#export-form-definitions-by-tenant + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + offset := 0 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `name sw "my form"` // 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + sorters := `name` // 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, description, created, modified** (optional) (default to "name") # 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, description, created, modified** (optional) (default to "name") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.ExportFormDefinitionsByTenant(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.ExportFormDefinitionsByTenant(context.Background()).Offset(offset).Limit(limit).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ExportFormDefinitionsByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportFormDefinitionsByTenant`: []ExportFormDefinitionsByTenant200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ExportFormDefinitionsByTenant`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID}/file/{fileID} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#get-file-from-s3 + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | FormDefinitionID Form definition ID # string | FormDefinitionID Form definition ID + fileID := `00000031N0J7R2B57M8YG73J7M.png` // string | FileID String specifying the hashed name of the uploaded file we are retrieving. # string | FileID String specifying the hashed name of the uploaded file we are retrieving. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.GetFileFromS3(context.Background(), formDefinitionID, fileID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.GetFileFromS3(context.Background(), formDefinitionID, fileID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFileFromS3``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFileFromS3`: *os.File + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFileFromS3`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#get-form-definition-by-key + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.GetFormDefinitionByKey(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.GetFormDefinitionByKey(context.Background(), formDefinitionID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormDefinitionByKey``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormDefinitionByKey`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormDefinitionByKey`: %v\n", resp) + } +- path: /form-instances/{formInstanceID} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#get-form-instance-by-key + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.GetFormInstanceByKey(context.Background(), formInstanceID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.GetFormInstanceByKey(context.Background(), formInstanceID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormInstanceByKey``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormInstanceByKey`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormInstanceByKey`: %v\n", resp) + } +- path: /form-instances/{formInstanceID}/file/{fileID} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#get-form-instance-file + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | FormInstanceID Form instance ID # string | FormInstanceID Form instance ID + fileID := `00000031N0J7R2B57M8YG73J7M.png` // string | FileID String specifying the hashed name of the uploaded file we are retrieving. # string | FileID String specifying the hashed name of the uploaded file we are retrieving. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.GetFormInstanceFile(context.Background(), formInstanceID, fileID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.GetFormInstanceFile(context.Background(), formInstanceID, fileID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormInstanceFile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormInstanceFile`: *os.File + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormInstanceFile`: %v\n", resp) + } +- path: /form-definitions/import + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#import-form-definitions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + body := []byte(`[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]`) // []ImportFormDefinitionsRequestInner | Body is the request payload to import form definitions (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.ImportFormDefinitions(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.ImportFormDefinitions(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ImportFormDefinitions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportFormDefinitions`: ImportFormDefinitions202Response + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ImportFormDefinitions`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#patch-form-definition + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + body := []byte(`[{op=replace, path=/description, value=test-description}]`) // []map[string]map[string]interface{} | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.PatchFormDefinition(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.PatchFormDefinition(context.Background(), formDefinitionID).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.PatchFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchFormDefinition`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.PatchFormDefinition`: %v\n", resp) + } +- path: /form-instances/{formInstanceID} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#patch-form-instance + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + body := []byte(`[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]`) // []map[string]map[string]interface{} | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.PatchFormInstance(context.Background(), formInstanceID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.PatchFormInstance(context.Background(), formInstanceID).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.PatchFormInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchFormInstance`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.PatchFormInstance`: %v\n", resp) + } +- path: /form-definitions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#search-form-definitions-by-tenant + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + offset := 250 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `name sw "my form"` // 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + sorters := `name` // 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, description, created, modified** (optional) (default to "name") # 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, description, created, modified** (optional) (default to "name") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.SearchFormDefinitionsByTenant(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.SearchFormDefinitionsByTenant(context.Background()).Offset(offset).Limit(limit).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormDefinitionsByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormDefinitionsByTenant`: ListFormDefinitionsByTenantResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormDefinitionsByTenant`: %v\n", resp) + } +- path: /form-instances/{formInstanceID}/data-source/{formElementID} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#search-form-element-data-by-element-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + formElementID := `1` // string | Form element ID # string | Form element ID + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `value eq "ID01"` // 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) + query := `support` // string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.SearchFormElementDataByElementID(context.Background(), formInstanceID, formElementID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.SearchFormElementDataByElementID(context.Background(), formInstanceID, formElementID).Limit(limit).Filters(filters).Query(query).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormElementDataByElementID``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormElementDataByElementID`: ListFormElementDataByElementIDResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormElementDataByElementID`: %v\n", resp) + } +- path: /form-instances + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#search-form-instances-by-tenant + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.SearchFormInstancesByTenant(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.SearchFormInstancesByTenant(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormInstancesByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormInstancesByTenant`: []ListFormInstancesByTenantResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormInstancesByTenant`: %v\n", resp) + } +- path: /form-definitions/predefined-select-options + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#search-pre-defined-select-options + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.SearchPreDefinedSelectOptions(context.Background()).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.SearchPreDefinedSelectOptions(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchPreDefinedSelectOptions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchPreDefinedSelectOptions`: ListPredefinedSelectOptionsResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchPreDefinedSelectOptions`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID}/data-source + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-forms#show-preview-data-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + limit := 10 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) + filters := `value eq "ID01"` // 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) + query := `ac` // string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) + formelementpreviewrequest := []byte(`{ + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } + }`) // FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomFormsAPI.ShowPreviewDataSource(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.V2024.CustomFormsAPI.ShowPreviewDataSource(context.Background(), formDefinitionID).Limit(limit).Filters(filters).Query(query).FormElementPreviewRequest(formElementPreviewRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ShowPreviewDataSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ShowPreviewDataSource`: PreviewDataSourceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ShowPreviewDataSource`: %v\n", resp) + } +- path: /custom-password-instructions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-password-instructions#create-custom-password-instructions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + custompasswordinstruction := []byte(`{ + "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", + "pageId" : "change-password:enter-password", + "locale" : "en" + }`) // CustomPasswordInstruction | + + + var customPasswordInstruction v2024.CustomPasswordInstruction + if err := json.Unmarshal(custompasswordinstruction, &customPasswordInstruction); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions(context.Background()).XSailPointExperimental(xSailPointExperimental).CustomPasswordInstruction(customPasswordInstruction).Execute() + //resp, r, err := apiClient.V2024.CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions(context.Background()).XSailPointExperimental(xSailPointExperimental).CustomPasswordInstruction(customPasswordInstruction).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCustomPasswordInstructions`: CustomPasswordInstruction + fmt.Fprintf(os.Stdout, "Response from `CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions`: %v\n", resp) + } +- path: /custom-password-instructions/{pageId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-password-instructions#delete-custom-password-instructions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + pageId := `mfa:select` // string | The page ID of custom password instructions to delete. # string | The page ID of custom password instructions to delete. + 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") + locale := `locale_example` // string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions(context.Background(), pageId).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions(context.Background(), pageId).XSailPointExperimental(xSailPointExperimental).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /custom-password-instructions/{pageId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/custom-password-instructions#get-custom-password-instructions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + pageId := `mfa:select` // string | The page ID of custom password instructions to query. # string | The page ID of custom password instructions to query. + 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") + locale := `locale_example` // string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.CustomPasswordInstructionsAPI.GetCustomPasswordInstructions(context.Background(), pageId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.CustomPasswordInstructionsAPI.GetCustomPasswordInstructions(context.Background(), pageId).XSailPointExperimental(xSailPointExperimental).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.GetCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCustomPasswordInstructions`: CustomPasswordInstruction + fmt.Fprintf(os.Stdout, "Response from `CustomPasswordInstructionsAPI.GetCustomPasswordInstructions`: %v\n", resp) + } +- path: /data-segments + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/data-segmentation#create-data-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + datasegment := []byte(``) // DataSegment | + + + var dataSegment v2024.DataSegment + if err := json.Unmarshal(datasegment, &dataSegment); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DataSegmentationAPI.CreateDataSegment(context.Background()).DataSegment(dataSegment).Execute() + //resp, r, err := apiClient.V2024.DataSegmentationAPI.CreateDataSegment(context.Background()).DataSegment(dataSegment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.CreateDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDataSegment`: DataSegment + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.CreateDataSegment`: %v\n", resp) + } +- path: /data-segments/{segmentId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/data-segmentation#delete-data-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The segment ID to delete. # string | The segment ID to delete. + 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") + published := false // bool | This determines which version of the segment to delete (optional) (default to false) # bool | This determines which version of the segment to delete (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.DataSegmentationAPI.DeleteDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.DataSegmentationAPI.DeleteDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Published(published).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.DeleteDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /data-segments/{segmentId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/data-segmentation#get-data-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The segment ID to retrieve. # string | The segment ID to retrieve. + 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.DataSegmentationAPI.GetDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.DataSegmentationAPI.GetDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.GetDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDataSegment`: DataSegment + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.GetDataSegment`: %v\n", resp) + } +- path: /data-segments/membership/{identityId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/data-segmentation#get-data-segment-identity-membership + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The identity ID to retrieve the segments they are in. # string | The identity ID to retrieve the segments they are in. + 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.DataSegmentationAPI.GetDataSegmentIdentityMembership(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.DataSegmentationAPI.GetDataSegmentIdentityMembership(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.GetDataSegmentIdentityMembership``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDataSegmentIdentityMembership`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.GetDataSegmentIdentityMembership`: %v\n", resp) + } +- path: /data-segments/user-enabled/{identityId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/data-segmentation#get-data-segmentation-enabled-for-user + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The identity ID to retrieve if segmentation is enabled for the identity. # string | The identity ID to retrieve if segmentation is enabled for the identity. + 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.DataSegmentationAPI.GetDataSegmentationEnabledForUser(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.DataSegmentationAPI.GetDataSegmentationEnabledForUser(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.GetDataSegmentationEnabledForUser``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDataSegmentationEnabledForUser`: bool + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.GetDataSegmentationEnabledForUser`: %v\n", resp) + } +- path: /data-segments + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/data-segmentation#list-data-segments + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + enabled := true // bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to true) # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to true) + unique := false // bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to false) # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to false) + published := true // bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to true) # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to true) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq ""` // 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, sw* **name**: *eq, in, sw* (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, sw* **name**: *eq, in, sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DataSegmentationAPI.ListDataSegments(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.DataSegmentationAPI.ListDataSegments(context.Background()).XSailPointExperimental(xSailPointExperimental).Enabled(enabled).Unique(unique).Published(published).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.ListDataSegments``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDataSegments`: []DataSegment + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.ListDataSegments`: %v\n", resp) + } +- path: /data-segments/{segmentId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/data-segmentation#patch-data-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The segment ID to modify. # string | The segment ID to modify. + 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") + requestbody := []byte(`[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]`) // []map[string]interface{} | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DataSegmentationAPI.PatchDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2024.DataSegmentationAPI.PatchDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.PatchDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchDataSegment`: DataSegment + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.PatchDataSegment`: %v\n", resp) + } +- path: /data-segments/{segmentId} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/data-segmentation#publish-data-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + requestbody := []byte(``) // []string | A list of segment ids that you wish to publish + publishAll := true // bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to true) # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to true) + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.DataSegmentationAPI.PublishDataSegment(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //r, err := apiClient.V2024.DataSegmentationAPI.PublishDataSegment(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).PublishAll(publishAll).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.PublishDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /roles/{roleId}/dimensions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/dimensions#create-dimension + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimension := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "name" : "Dimension 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "id" : "2c918086749d78830174a1a40e121518", + "membership" : { + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, + "type" : "STANDARD" + }, + "parentId" : "2c918086749d78830174a1a40e121518" + }`) // Dimension | + + + var dimension v2024.Dimension + if err := json.Unmarshal(dimension, &dimension); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DimensionsAPI.CreateDimension(context.Background(), roleId).Dimension(dimension).Execute() + //resp, r, err := apiClient.V2024.DimensionsAPI.CreateDimension(context.Background(), roleId).Dimension(dimension).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.CreateDimension``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDimension`: Dimension + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.CreateDimension`: %v\n", resp) + } +- path: /roles/{roleId}/dimensions/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/dimensions#delete-bulk-dimensions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimensions. # string | Parent Role Id of the dimensions. + dimensionbulkdeleterequest := []byte(`{ + "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + }`) // DimensionBulkDeleteRequest | + + + var dimensionBulkDeleteRequest v2024.DimensionBulkDeleteRequest + if err := json.Unmarshal(dimensionbulkdeleterequest, &dimensionBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DimensionsAPI.DeleteBulkDimensions(context.Background(), roleId).DimensionBulkDeleteRequest(dimensionBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V2024.DimensionsAPI.DeleteBulkDimensions(context.Background(), roleId).DimensionBulkDeleteRequest(dimensionBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.DeleteBulkDimensions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteBulkDimensions`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.DeleteBulkDimensions`: %v\n", resp) + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/dimensions#delete-dimension + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.DimensionsAPI.DeleteDimension(context.Background(), roleId, dimensionId).Execute() + //r, err := apiClient.V2024.DimensionsAPI.DeleteDimension(context.Background(), roleId, dimensionId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.DeleteDimension``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/dimensions#get-dimension + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DimensionsAPI.GetDimension(context.Background(), roleId, dimensionId).Execute() + //resp, r, err := apiClient.V2024.DimensionsAPI.GetDimension(context.Background(), roleId, dimensionId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.GetDimension``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDimension`: Dimension + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.GetDimension`: %v\n", resp) + } +- path: /roles/{roleId}/dimensions/{dimensionId}/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/dimensions#get-dimension-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DimensionsAPI.GetDimensionEntitlements(context.Background(), roleId, dimensionId).Execute() + //resp, r, err := apiClient.V2024.DimensionsAPI.GetDimensionEntitlements(context.Background(), roleId, dimensionId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.GetDimensionEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDimensionEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.GetDimensionEntitlements`: %v\n", resp) + } +- path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/dimensions#list-dimension-access-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `source.id eq "2c91808982f979270182f99e386d00fa"` // 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DimensionsAPI.ListDimensionAccessProfiles(context.Background(), roleId, dimensionId).Execute() + //resp, r, err := apiClient.V2024.DimensionsAPI.ListDimensionAccessProfiles(context.Background(), roleId, dimensionId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.ListDimensionAccessProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDimensionAccessProfiles`: []AccessProfile + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.ListDimensionAccessProfiles`: %v\n", resp) + } +- path: /roles/{roleId}/dimensions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/dimensions#list-dimensions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq '2c918086749d78830174a1a40e121518'` // 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DimensionsAPI.ListDimensions(context.Background(), roleId).Execute() + //resp, r, err := apiClient.V2024.DimensionsAPI.ListDimensions(context.Background(), roleId).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.ListDimensions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDimensions`: []Dimension + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.ListDimensions`: %v\n", resp) + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/dimensions#patch-dimension + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Test Description}, {op=replace, path=/name, value=new name}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.DimensionsAPI.PatchDimension(context.Background(), roleId, dimensionId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.DimensionsAPI.PatchDimension(context.Background(), roleId, dimensionId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.PatchDimension``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchDimension`: Dimension + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.PatchDimension`: %v\n", resp) + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/entitlements#create-access-model-metadata-for-entitlement + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | The entitlement id. # string | The entitlement id. + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + 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.EntitlementsAPI.CreateAccessModelMetadataForEntitlement(context.Background(), id, attributeKey, attributeValue).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.CreateAccessModelMetadataForEntitlement(context.Background(), id, attributeKey, attributeValue).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.CreateAccessModelMetadataForEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessModelMetadataForEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.CreateAccessModelMetadataForEntitlement`: %v\n", resp) + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/entitlements#delete-access-model-metadata-from-entitlement + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | The entitlement id. # string | The entitlement id. + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + 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.EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement(context.Background(), id, attributeKey, attributeValue).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement(context.Background(), id, attributeKey, attributeValue).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /entitlements/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/entitlements#get-entitlement + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808874ff91550175097daaec161c` // string | The entitlement ID # string | The entitlement 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.EntitlementsAPI.GetEntitlement(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.GetEntitlement(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.GetEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.GetEntitlement`: %v\n", resp) + } +- path: /entitlements/{id}/entitlement-request-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/entitlements#get-entitlement-request-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808874ff91550175097daaec161c` // string | Entitlement Id # string | Entitlement 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.EntitlementsAPI.GetEntitlementRequestConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.GetEntitlementRequestConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.GetEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementRequestConfig`: EntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.GetEntitlementRequestConfig`: %v\n", resp) + } +- path: /entitlements/aggregate/sources/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/entitlements#import-entitlements-by-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + csvFile := 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.EntitlementsAPI.ImportEntitlementsBySource(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.ImportEntitlementsBySource(context.Background(), id).XSailPointExperimental(xSailPointExperimental).CsvFile(csvFile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ImportEntitlementsBySource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportEntitlementsBySource`: LoadEntitlementTask + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ImportEntitlementsBySource`: %v\n", resp) + } +- path: /entitlements/{id}/children + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/entitlements#list-entitlement-children + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808874ff91550175097daaec161c` // string | Entitlement Id # string | Entitlement 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id** (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: **id, name, created, modified, type, attribute, value, source.id** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.EntitlementsAPI.ListEntitlementChildren(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.ListEntitlementChildren(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlementChildren``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlementChildren`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlementChildren`: %v\n", resp) + } +- path: /entitlements/{id}/parents + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/entitlements#list-entitlement-parents + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | Entitlement Id # string | Entitlement 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id** (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: **id, name, created, modified, type, attribute, value, source.id** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.EntitlementsAPI.ListEntitlementParents(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.ListEntitlementParents(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlementParents``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlementParents`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlementParents`: %v\n", resp) + } +- path: /entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/entitlements#list-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + accountId := `ef38f94347e94562b5bb8424a56397d8` // string | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) # string | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) + segmentedForIdentity := `me` // string | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) # string | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) + forSegmentIds := `041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649` // string | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) # string | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) + includeUnsegmented := true // bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to true) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id, requestable** (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: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.EntitlementsAPI.ListEntitlements(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.ListEntitlements(context.Background()).XSailPointExperimental(xSailPointExperimental).AccountId(accountId).SegmentedForIdentity(segmentedForIdentity).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlements`: %v\n", resp) + } +- path: /entitlements/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/entitlements#patch-entitlement + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the entitlement to patch # string | ID of the entitlement to patch + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]`) // []JsonPatchOperation | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.EntitlementsAPI.PatchEntitlement(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.PatchEntitlement(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.PatchEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.PatchEntitlement`: %v\n", resp) + } +- path: /entitlements/{id}/entitlement-request-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/entitlements#put-entitlement-request-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | Entitlement ID # string | Entitlement 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") + entitlementrequestconfig := []byte(`{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }`) // EntitlementRequestConfig | + + + var entitlementRequestConfig v2024.EntitlementRequestConfig + if err := json.Unmarshal(entitlementrequestconfig, &entitlementRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.EntitlementsAPI.PutEntitlementRequestConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).EntitlementRequestConfig(entitlementRequestConfig).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.PutEntitlementRequestConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).EntitlementRequestConfig(entitlementRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.PutEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutEntitlementRequestConfig`: EntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.PutEntitlementRequestConfig`: %v\n", resp) + } +- path: /entitlements/reset/sources/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/entitlements#reset-source-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of source for the entitlement reset # string | ID of source for the entitlement reset + 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.EntitlementsAPI.ResetSourceEntitlements(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.EntitlementsAPI.ResetSourceEntitlements(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ResetSourceEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ResetSourceEntitlements`: EntitlementSourceResetBaseReferenceDto + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ResetSourceEntitlements`: %v\n", resp) + } +- path: /entitlements/bulk-update + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/entitlements#update-entitlements-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + entitlementbulkupdaterequest := []byte(`{ + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] + }`) // EntitlementBulkUpdateRequest | + + + var entitlementBulkUpdateRequest v2024.EntitlementBulkUpdateRequest + if err := json.Unmarshal(entitlementbulkupdaterequest, &entitlementBulkUpdateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.EntitlementsAPI.UpdateEntitlementsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).EntitlementBulkUpdateRequest(entitlementBulkUpdateRequest).Execute() + //r, err := apiClient.V2024.EntitlementsAPI.UpdateEntitlementsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).EntitlementBulkUpdateRequest(entitlementBulkUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.UpdateEntitlementsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /auth-org/network-config + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/global-tenant-security-settings#create-auth-org-network-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + networkconfiguration := []byte(`{ + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] + }`) // NetworkConfiguration | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + + + var networkConfiguration v2024.NetworkConfiguration + if err := json.Unmarshal(networkconfiguration, &networkConfiguration); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig(context.Background()).NetworkConfiguration(networkConfiguration).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig(context.Background()).NetworkConfiguration(networkConfiguration).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig`: %v\n", resp) + } +- path: /auth-org/lockout-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgLockoutConfig`: LockoutConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig`: %v\n", resp) + } +- path: /auth-org/network-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/global-tenant-security-settings#get-auth-org-network-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig`: %v\n", resp) + } +- path: /auth-org/service-provider-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgServiceProviderConfig`: ServiceProviderConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig`: %v\n", resp) + } +- path: /auth-org/session-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgSessionConfig`: SessionConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig`: %v\n", resp) + } +- path: /auth-org/lockout-config + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}]`) // []JsonPatchOperation | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgLockoutConfig`: LockoutConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig`: %v\n", resp) + } +- path: /auth-org/network-config + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/global-tenant-security-settings#patch-auth-org-network-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/whitelisted, value=false,}, {op=add, path=/geolocation, value=[AF, HN, ES]}]`) // []JsonPatchOperation | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig`: %v\n", resp) + } +- path: /auth-org/service-provider-config + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}]`) // []JsonPatchOperation | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgServiceProviderConfig`: ServiceProviderConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig`: %v\n", resp) + } +- path: /auth-org/session-config + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}]`) // []JsonPatchOperation | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgSessionConfig`: SessionConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig`: %v\n", resp) + } +- path: /workgroups + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/governance-groups#create-workgroup + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + workgroupdto := []byte(`{ + "owner" : { + "emailAddress" : "support@sailpoint.com", + "displayName" : "Support", + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "connectionCount" : 1641498673000, + "created" : "2022-01-06T19:51:13Z", + "memberCount" : 1641498673000, + "name" : "DB Access Governance Group", + "description" : "Description of the Governance Group", + "modified" : "2022-01-06T19:51:13Z", + "id" : "2c91808568c529c60168cca6f90c1313" + }`) // WorkgroupDto | + + + var workgroupDto v2024.WorkgroupDto + if err := json.Unmarshal(workgroupdto, &workgroupDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GovernanceGroupsAPI.CreateWorkgroup(context.Background()).XSailPointExperimental(xSailPointExperimental).WorkgroupDto(workgroupDto).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.CreateWorkgroup(context.Background()).XSailPointExperimental(xSailPointExperimental).WorkgroupDto(workgroupDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.CreateWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.CreateWorkgroup`: %v\n", resp) + } +- path: /workgroups/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/governance-groups#delete-workgroup + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + 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.GovernanceGroupsAPI.DeleteWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.GovernanceGroupsAPI.DeleteWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /workgroups/{workgroupId}/members/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/governance-groups#delete-workgroup-members + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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") + identitypreviewresponseidentity := []byte(``) // []IdentityPreviewResponseIdentity | List of identities to be removed from a Governance Group members list. + + + var identityPreviewResponseIdentity v2024.[]IdentityPreviewResponseIdentity + if err := json.Unmarshal(identitypreviewresponseidentity, &identityPreviewResponseIdentity); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GovernanceGroupsAPI.DeleteWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).IdentityPreviewResponseIdentity(identityPreviewResponseIdentity).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.DeleteWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).IdentityPreviewResponseIdentity(identityPreviewResponseIdentity).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteWorkgroupMembers`: []WorkgroupMemberDeleteItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.DeleteWorkgroupMembers`: %v\n", resp) + } +- path: /workgroups/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/governance-groups#delete-workgroups-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + workgroupbulkdeleterequest := []byte(`{ + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + }`) // WorkgroupBulkDeleteRequest | + + + var workgroupBulkDeleteRequest v2024.WorkgroupBulkDeleteRequest + if err := json.Unmarshal(workgroupbulkdeleterequest, &workgroupBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GovernanceGroupsAPI.DeleteWorkgroupsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).WorkgroupBulkDeleteRequest(workgroupBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.DeleteWorkgroupsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).WorkgroupBulkDeleteRequest(workgroupBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroupsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteWorkgroupsInBulk`: []WorkgroupDeleteItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.DeleteWorkgroupsInBulk`: %v\n", resp) + } +- path: /workgroups/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/governance-groups#get-workgroup + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + 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.GovernanceGroupsAPI.GetWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.GetWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.GetWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.GetWorkgroup`: %v\n", resp) + } +- path: /workgroups/{workgroupId}/connections + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/governance-groups#list-connections + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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") + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GovernanceGroupsAPI.ListConnections(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.ListConnections(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListConnections``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListConnections`: []WorkgroupConnectionDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListConnections`: %v\n", resp) + } +- path: /workgroups/{workgroupId}/members + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/governance-groups#list-workgroup-members + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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") + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GovernanceGroupsAPI.ListWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.ListWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkgroupMembers`: []ListWorkgroupMembers200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListWorkgroupMembers`: %v\n", resp) + } +- path: /workgroups + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/governance-groups#list-workgroups + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw "Test"` // 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, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (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, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) + sorters := `name,-modified` // 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, created, modified, id, description** (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, created, modified, id, description** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GovernanceGroupsAPI.ListWorkgroups(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.ListWorkgroups(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListWorkgroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkgroups`: []WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListWorkgroups`: %v\n", resp) + } +- path: /workgroups/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/governance-groups#patch-workgroup + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Governance Group new description.}]`) // []JsonPatchOperation | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GovernanceGroupsAPI.PatchWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.PatchWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.PatchWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.PatchWorkgroup`: %v\n", resp) + } +- path: /workgroups/{workgroupId}/members/bulk-add + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/governance-groups#update-workgroup-members + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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") + identitypreviewresponseidentity := []byte(``) // []IdentityPreviewResponseIdentity | List of identities to be added to a Governance Group members list. + + + var identityPreviewResponseIdentity v2024.[]IdentityPreviewResponseIdentity + if err := json.Unmarshal(identitypreviewresponseidentity, &identityPreviewResponseIdentity); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.GovernanceGroupsAPI.UpdateWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).IdentityPreviewResponseIdentity(identityPreviewResponseIdentity).Execute() + //resp, r, err := apiClient.V2024.GovernanceGroupsAPI.UpdateWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).IdentityPreviewResponseIdentity(identityPreviewResponseIdentity).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.UpdateWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateWorkgroupMembers`: []WorkgroupMemberAddItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.UpdateWorkgroupMembers`: %v\n", resp) + } +- path: /ai-access-request-recommendations/ignored-items + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity. + + + var accessRequestRecommendationActionItemDto v2024.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsIgnoredItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem`: %v\n", resp) + } +- path: /ai-access-request-recommendations/requested-items + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity. + + + var accessRequestRecommendationActionItemDto v2024.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsRequestedItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem`: %v\n", resp) + } +- path: /ai-access-request-recommendations/viewed-items + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity. + + + var accessRequestRecommendationActionItemDto v2024.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsViewedItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem`: %v\n", resp) + } +- path: /ai-access-request-recommendations/viewed-items/bulk-create + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + accessrequestrecommendationactionitemdto := []byte(``) // []AccessRequestRecommendationActionItemDto | The recommended access items that were viewed for an identity. + + + var accessRequestRecommendationActionItemDto v2024.[]AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsViewedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems`: %v\n", resp) + } +- path: /ai-access-request-recommendations + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + identityId := `2c91808570313110017040b06f344ec9` // string | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") # string | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") + limit := 15 // int32 | Max number of results to return. (optional) (default to 15) # int32 | Max number of results to return. (optional) (default to 15) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + includeTranslationMessages := false // bool | If *true* it will populate a list of translation messages in the response. (optional) (default to false) # bool | If *true* it will populate a list of translation messages in the response. (optional) (default to false) + filters := `access.name co "admin"` // 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) + sorters := `access.name` // 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityId(identityId).Limit(limit).Offset(offset).Count(count).IncludeTranslationMessages(includeTranslationMessages).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendations`: []AccessRequestRecommendationItemDetail + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations`: %v\n", resp) + } +- path: /ai-access-request-recommendations/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsConfig`: AccessRequestRecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsConfig`: %v\n", resp) + } +- path: /ai-access-request-recommendations/ignored-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `identityId eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsIgnoredItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems`: %v\n", resp) + } +- path: /ai-access-request-recommendations/requested-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsRequestedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems`: %v\n", resp) + } +- path: /ai-access-request-recommendations/viewed-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsViewedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems`: %v\n", resp) + } +- path: /ai-access-request-recommendations/config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-access-request-recommendations#set-access-request-recommendations-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + accessrequestrecommendationconfigdto := []byte(`{ + "scoreThreshold" : 0.5, + "startDateAttribute" : "startDate", + "restrictionAttribute" : "location", + "moverAttribute" : "isMover", + "joinerAttribute" : "isJoiner", + "useRestrictionAttribute" : true + }`) // AccessRequestRecommendationConfigDto | The desired configurations for Access Request Recommender for the tenant. + + + var accessRequestRecommendationConfigDto v2024.AccessRequestRecommendationConfigDto + if err := json.Unmarshal(accessrequestrecommendationconfigdto, &accessRequestRecommendationConfigDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.SetAccessRequestRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationConfigDto(accessRequestRecommendationConfigDto).Execute() + //resp, r, err := apiClient.V2024.IAIAccessRequestRecommendationsAPI.SetAccessRequestRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationConfigDto(accessRequestRecommendationConfigDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.SetAccessRequestRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetAccessRequestRecommendationsConfig`: AccessRequestRecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.SetAccessRequestRecommendationsConfig`: %v\n", resp) + } +- path: /common-access + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-common-access#create-common-access + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + commonaccessitemrequest := []byte(`{ + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" + }`) // CommonAccessItemRequest | + + + var commonAccessItemRequest v2024.CommonAccessItemRequest + if err := json.Unmarshal(commonaccessitemrequest, &commonAccessItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAICommonAccessAPI.CreateCommonAccess(context.Background()).XSailPointExperimental(xSailPointExperimental).CommonAccessItemRequest(commonAccessItemRequest).Execute() + //resp, r, err := apiClient.V2024.IAICommonAccessAPI.CreateCommonAccess(context.Background()).XSailPointExperimental(xSailPointExperimental).CommonAccessItemRequest(commonAccessItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.CreateCommonAccess``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCommonAccess`: CommonAccessItemResponse + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.CreateCommonAccess`: %v\n", resp) + } +- path: /common-access + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-common-access#get-common-access + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.type eq "ROLE"` // 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) + sorters := `access.name` // 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: **access.name, status** By default the common access items are sorted by name, ascending. (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: **access.name, status** By default the common access items are sorted by name, ascending. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAICommonAccessAPI.GetCommonAccess(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAICommonAccessAPI.GetCommonAccess(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.GetCommonAccess``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCommonAccess`: []CommonAccessResponse + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.GetCommonAccess`: %v\n", resp) + } +- path: /common-access/update-status + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-common-access#update-common-access-status-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + commonaccessidstatus := []byte(``) // []CommonAccessIDStatus | Confirm or deny in bulk the common access ids that are (or aren't) common access + + + var commonAccessIDStatus v2024.[]CommonAccessIDStatus + if err := json.Unmarshal(commonaccessidstatus, &commonAccessIDStatus); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAICommonAccessAPI.UpdateCommonAccessStatusInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).CommonAccessIDStatus(commonAccessIDStatus).Execute() + //resp, r, err := apiClient.V2024.IAICommonAccessAPI.UpdateCommonAccessStatusInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).CommonAccessIDStatus(commonAccessIDStatus).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.UpdateCommonAccessStatusInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCommonAccessStatusInBulk`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.UpdateCommonAccessStatusInBulk`: %v\n", resp) + } +- path: /outliers/export + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-outliers#export-outliers-zip + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIOutliersAPI.ExportOutliersZip(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIOutliersAPI.ExportOutliersZip(context.Background()).XSailPointExperimental(xSailPointExperimental).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.ExportOutliersZip``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportOutliersZip`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.ExportOutliersZip`: %v\n", resp) + } +- path: /outlier-summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-outliers#get-identity-outlier-snapshots + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + filters := `snapshotDate ge "2022-02-07T20:13:29.356648026Z"` // 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: **snapshotDate**: *ge, le* (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: **snapshotDate**: *ge, le* (optional) + sorters := `snapshotDate` // 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: **snapshotDate** (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: **snapshotDate** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIOutliersAPI.GetIdentityOutlierSnapshots(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIOutliersAPI.GetIdentityOutlierSnapshots(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Type_(type_).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetIdentityOutlierSnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityOutlierSnapshots`: []OutlierSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetIdentityOutlierSnapshots`: %v\n", resp) + } +- path: /outliers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-outliers#get-identity-outliers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + filters := `attributes.displayName sw "John" and certStatus 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) + sorters := `attributes.displayName,firstDetectionDate,-score` // 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: **firstDetectionDate, attributes, score** (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: **firstDetectionDate, attributes, score** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIOutliersAPI.GetIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIOutliersAPI.GetIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Type_(type_).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityOutliers`: []Outlier + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetIdentityOutliers`: %v\n", resp) + } +- path: /outlier-summaries/latest + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-outliers#get-latest-identity-outlier-snapshots + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIOutliersAPI.GetLatestIdentityOutlierSnapshots(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIOutliersAPI.GetLatestIdentityOutlierSnapshots(context.Background()).XSailPointExperimental(xSailPointExperimental).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetLatestIdentityOutlierSnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLatestIdentityOutlierSnapshots`: []LatestOutlierSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetLatestIdentityOutlierSnapshots`: %v\n", resp) + } +- path: /outlier-feature-summaries/{outlierFeatureId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-outliers#get-outlier-contributing-feature-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + outlierFeatureId := `04654b66-7561-4090-94f9-abee0722a1af` // string | Contributing feature id # string | Contributing feature 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.IAIOutliersAPI.GetOutlierContributingFeatureSummary(context.Background(), outlierFeatureId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIOutliersAPI.GetOutlierContributingFeatureSummary(context.Background(), outlierFeatureId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetOutlierContributingFeatureSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOutlierContributingFeatureSummary`: OutlierFeatureSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetOutlierContributingFeatureSummary`: %v\n", resp) + } +- path: /outliers/{outlierId}/contributing-features + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-outliers#get-peer-group-outliers-contributing-features + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + outlierId := `2c918085842e69ae018432d22ccb212f` // string | The outlier id # string | The outlier 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + includeTranslationMessages := `include-translation-messages=` // string | Whether or not to include translation messages object in returned response (optional) # string | Whether or not to include translation messages object in returned response (optional) + sorters := `importance` // 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: **importance** (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: **importance** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures(context.Background(), outlierId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures(context.Background(), outlierId).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).IncludeTranslationMessages(includeTranslationMessages).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPeerGroupOutliersContributingFeatures`: []OutlierContributingFeature + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures`: %v\n", resp) + } +- path: /outliers/ignore + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-outliers#ignore-identity-outliers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + requestbody := []byte(``) // []string | + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.IAIOutliersAPI.IgnoreIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //r, err := apiClient.V2024.IAIOutliersAPI.IgnoreIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.IgnoreIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-outliers#list-outliers-contributing-feature-access-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + outlierId := `2c918085842e69ae018432d22ccb212f` // string | The outlier id # string | The outlier id + contributingFeatureName := `entitlement_count` // string | The name of contributing feature # string | The name of contributing feature + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + accessType := `ENTITLEMENT` // string | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) # string | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) + sorters := `displayName` // 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: **displayName** (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: **displayName** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIOutliersAPI.ListOutliersContributingFeatureAccessItems(context.Background(), outlierId, contributingFeatureName).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIOutliersAPI.ListOutliersContributingFeatureAccessItems(context.Background(), outlierId, contributingFeatureName).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).AccessType(accessType).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.ListOutliersContributingFeatureAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOutliersContributingFeatureAccessItems`: []OutliersContributingFeatureAccessItems + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.ListOutliersContributingFeatureAccessItems`: %v\n", resp) + } +- path: /outliers/unignore + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-outliers#un-ignore-identity-outliers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + requestbody := []byte(``) // []string | + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.IAIOutliersAPI.UnIgnoreIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //r, err := apiClient.V2024.IAIOutliersAPI.UnIgnoreIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.UnIgnoreIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /peer-group-strategies/{strategy}/identity-outliers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-peer-group-strategies#get-peer-group-outliers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + strategy := `entitlement` // string | The strategy used to create peer groups. Currently, 'entitlement' is supported. # string | The strategy used to create peer groups. Currently, 'entitlement' is supported. + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers(context.Background(), strategy).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers(context.Background(), strategy).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPeerGroupOutliers`: []PeerGroupMember + fmt.Fprintf(os.Stdout, "Response from `IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers`: %v\n", resp) + } +- path: /recommendations/request + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-recommendations#get-recommendations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + recommendationrequestdto := []byte(`{ + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true + }`) // RecommendationRequestDto | + + + var recommendationRequestDto v2024.RecommendationRequestDto + if err := json.Unmarshal(recommendationrequestdto, &recommendationRequestDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRecommendationsAPI.GetRecommendations(context.Background()).XSailPointExperimental(xSailPointExperimental).RecommendationRequestDto(recommendationRequestDto).Execute() + //resp, r, err := apiClient.V2024.IAIRecommendationsAPI.GetRecommendations(context.Background()).XSailPointExperimental(xSailPointExperimental).RecommendationRequestDto(recommendationRequestDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.GetRecommendations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRecommendations`: RecommendationResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.GetRecommendations`: %v\n", resp) + } +- path: /recommendations/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-recommendations#get-recommendations-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRecommendationsAPI.GetRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRecommendationsAPI.GetRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.GetRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRecommendationsConfig`: RecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.GetRecommendationsConfig`: %v\n", resp) + } +- path: /recommendations/config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-recommendations#update-recommendations-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + recommendationconfigdto := []byte(`{ + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + }`) // RecommendationConfigDto | + + + var recommendationConfigDto v2024.RecommendationConfigDto + if err := json.Unmarshal(recommendationconfigdto, &recommendationConfigDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRecommendationsAPI.UpdateRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).RecommendationConfigDto(recommendationConfigDto).Execute() + //resp, r, err := apiClient.V2024.IAIRecommendationsAPI.UpdateRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).RecommendationConfigDto(recommendationConfigDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.UpdateRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRecommendationsConfig`: RecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.UpdateRecommendationsConfig`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#create-potential-role-provision-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + minEntitlementPopularity := 56 // int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) # int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to true) # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to true) + roleminingpotentialroleprovisionrequest := []byte(`{ + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false + }`) // RoleMiningPotentialRoleProvisionRequest | Required information to create a new role (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).MinEntitlementPopularity(minEntitlementPopularity).IncludeCommonAccess(includeCommonAccess).RoleMiningPotentialRoleProvisionRequest(roleMiningPotentialRoleProvisionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePotentialRoleProvisionRequest`: RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest`: %v\n", resp) + } +- path: /role-mining-sessions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#create-role-mining-sessions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + roleminingsessiondto := []byte(`{ + "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", + "prescribedPruneThreshold" : 10, + "pruneThreshold" : 50, + "saved" : true, + "potentialRolesReadyCount" : 0, + "scope" : { + "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], + "attributeFilterCriteria" : { + "displayName" : { + "untranslated" : "Location: Miami" + }, + "ariaLabel" : { + "untranslated" : "Location: Miami" + }, + "data" : { + "displayName" : { + "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" + }, + "name" : "location", + "operator" : "EQUALS", + "values" : [ "Miami" ] + } + }, + "criteria" : "source.name:DataScienceDataset" + }, + "potentialRoleCount" : 0, + "name" : "Saved RM Session - 07/10", + "minNumIdentitiesInPotentialRole" : 20, + "identityCount" : 0, + "type" : "SPECIALIZED" + }`) // RoleMiningSessionDto | Role mining session parameters + + + var roleMiningSessionDto v2024.RoleMiningSessionDto + if err := json.Unmarshal(roleminingsessiondto, &roleMiningSessionDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.CreateRoleMiningSessions(context.Background()).XSailPointExperimental(xSailPointExperimental).RoleMiningSessionDto(roleMiningSessionDto).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.CreateRoleMiningSessions(context.Background()).XSailPointExperimental(xSailPointExperimental).RoleMiningSessionDto(roleMiningSessionDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.CreateRoleMiningSessions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRoleMiningSessions`: RoleMiningSessionResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.CreateRoleMiningSessions`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#download-role-mining-potential-role-zip + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + exportId := `4940ffd4-836f-48a3-b2b0-6d498c3fdf40` // string | The id of a previously run export job for this potential role # string | The id of a previously run export job for this potential role + 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.IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip(context.Background(), sessionId, potentialRoleId, exportId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip(context.Background(), sessionId, potentialRoleId, exportId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DownloadRoleMiningPotentialRoleZip`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#export-role-mining-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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.IAIRoleMiningAPI.ExportRoleMiningPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.ExportRoleMiningPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRole`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#export-role-mining-potential-role-async + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + roleminingpotentialroleexportrequest := []byte(`{ + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true + }`) // RoleMiningPotentialRoleExportRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).RoleMiningPotentialRoleExportRequest(roleMiningPotentialRoleExportRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRoleAsync`: RoleMiningPotentialRoleExportResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#export-role-mining-potential-role-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + exportId := `4940ffd4-836f-48a3-b2b0-6d498c3fdf40` // string | The id of a previously run export job for this potential role # string | The id of a previously run export job for this potential role + 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.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus(context.Background(), sessionId, potentialRoleId, exportId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus(context.Background(), sessionId, potentialRoleId, exportId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRoleStatus`: RoleMiningPotentialRoleExportResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus`: %v\n", resp) + } +- path: /role-mining-potential-roles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#get-all-potential-role-summaries + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + sorters := `createdDate` // 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: **createdDate, identityCount, entitlementCount, freshness, quality** (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: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) + filters := `(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))` // 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetAllPotentialRoleSummaries(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetAllPotentialRoleSummaries(context.Background()).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetAllPotentialRoleSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAllPotentialRoleSummaries`: []RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetAllPotentialRoleSummaries`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#get-entitlement-distribution-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included or not (optional) # bool | Boolean determining whether common access entitlements will be included or not (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).IncludeCommonAccess(includeCommonAccess).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementDistributionPotentialRole`: map[string]int32 + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#get-entitlements-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included or not (optional) (default to true) # bool | Boolean determining whether common access entitlements will be included or not (optional) (default to true) + sorters := `popularity` // 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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) + filters := `applicationName sw "AD"` // 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).IncludeCommonAccess(includeCommonAccess).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementsPotentialRole`: []RoleMiningEntitlement + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetEntitlementsPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#get-excluded-entitlements-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + sorters := `populariity` // 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: **popularity** (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: **popularity** (optional) + filters := `applicationName sw "AD"` // 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetExcludedEntitlementsPotentialRole`: []RoleMiningEntitlement + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#get-identities-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + sorters := `name` // 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** (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** (optional) + filters := `filters_example` // 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: **name**: *sw* (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: **name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetIdentitiesPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetIdentitiesPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetIdentitiesPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitiesPotentialRole`: []RoleMiningIdentity + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetIdentitiesPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#get-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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.IAIRoleMiningAPI.GetPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#get-potential-role-applications + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `62f28d91-7d9f-4d17-be15-666d5b41d77f` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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 := `applicationName sw "test"` // 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: **applicationName**: *sw* (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: **applicationName**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRoleApplications(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRoleApplications(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleApplications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleApplications`: []RoleMiningPotentialRoleApplication + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleApplications`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#get-potential-role-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `62f28d91-7d9f-4d17-be15-666d5b41d77f` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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 := `entitlementRef.name sw "test"` // 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: **entitlementRef.name**: *sw* (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: **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRoleEntitlements(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRoleEntitlements(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleEntitlements`: []RoleMiningPotentialRoleEntitlements + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleEntitlements`: %v\n", resp) + } +- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#get-potential-role-source-identity-usage + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + potentialRoleId := `e0cc5d7d-bf7f-4f81-b2af-8885b09d9923` // string | A potential role id # string | A potential role id + sourceId := `2c9180877620c1460176267f336a106f` // string | A source id # string | A 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") + sorters := `-usageCount` // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (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 is supported for the following fields: **displayName, email, usageCount** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage(context.Background(), potentialRoleId, sourceId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage(context.Background(), potentialRoleId, sourceId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleSourceIdentityUsage`: []RoleMiningPotentialRoleSourceUsage + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#get-potential-role-summaries + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session 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") + sorters := `createdDate` // 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: **createdDate** (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: **createdDate** (optional) + filters := `(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))` // 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRoleSummaries(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetPotentialRoleSummaries(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleSummaries`: []RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleSummaries`: %v\n", resp) + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#get-role-mining-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id # string | A potential role 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.IAIRoleMiningAPI.GetRoleMiningPotentialRole(context.Background(), potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetRoleMiningPotentialRole(context.Background(), potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#get-role-mining-session + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id to be retrieved. # string | The role mining session id to be retrieved. + 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.IAIRoleMiningAPI.GetRoleMiningSession(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetRoleMiningSession(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSession``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSession`: RoleMiningSessionResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSession`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#get-role-mining-session-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session 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.IAIRoleMiningAPI.GetRoleMiningSessionStatus(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetRoleMiningSessionStatus(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSessionStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSessionStatus`: RoleMiningSessionStatus + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSessionStatus`: %v\n", resp) + } +- path: /role-mining-sessions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#get-role-mining-sessions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 := `saved eq "true" and name sw "RM Session"` // 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: **saved**: *eq* **name**: *eq, sw* (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: **saved**: *eq* **name**: *eq, sw* (optional) + sorters := `createdBy,createdDate` // 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: **createdBy, createdDate** (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: **createdBy, createdDate** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetRoleMiningSessions(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetRoleMiningSessions(context.Background()).XSailPointExperimental(xSailPointExperimental).Filters(filters).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSessions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSessions`: []RoleMiningSessionDto + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSessions`: %v\n", resp) + } +- path: /role-mining-potential-roles/saved + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#get-saved-potential-roles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + sorters := `modified` // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (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 is supported for the following fields: **modified** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetSavedPotentialRoles(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.GetSavedPotentialRoles(context.Background()).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetSavedPotentialRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSavedPotentialRoles`: []RoleMiningSessionDraftRoleDto + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetSavedPotentialRoles`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#patch-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The potential role summary id # string | The potential role summary 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") + patchpotentialrolerequestinner := []byte(`[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]`) // []PatchPotentialRoleRequestInner | + + + var patchPotentialRoleRequestInner v2024.[]PatchPotentialRoleRequestInner + if err := json.Unmarshal(patchpotentialrolerequestinner, &patchPotentialRoleRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.PatchPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.PatchPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPotentialRole`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchPotentialRole`: %v\n", resp) + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#patch-potential-role-0 + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The potential role summary id # string | The potential role summary 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") + patchpotentialrolerequestinner := []byte(`[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]`) // []PatchPotentialRoleRequestInner | + + + var patchPotentialRoleRequestInner v2024.[]PatchPotentialRoleRequestInner + if err := json.Unmarshal(patchpotentialrolerequestinner, &patchPotentialRoleRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.PatchPotentialRole_0(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.PatchPotentialRole_0(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchPotentialRole_0``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPotentialRole_0`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchPotentialRole_0`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#patch-role-mining-session + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id to be patched # string | The role mining session id to be patched + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/pruneThreshold, value=83}, {op=replace, path=/minNumIdentitiesInPotentialRole, value=10}, {op=replace, path=/saved, value=false}, {op=replace, path=/name, value=RM Session - 07/10/22}, {op=add, path=/name, value=RM Session - 07/10/22}]`) // []JsonPatchOperation | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.PatchRoleMiningSession(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.PatchRoleMiningSession(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchRoleMiningSession``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchRoleMiningSession`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchRoleMiningSession`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/iai-role-mining#update-entitlements-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + roleminingpotentialroleeditentitlements := []byte(`{ + "ids" : [ "entId1", "entId2" ], + "exclude" : true + }`) // RoleMiningPotentialRoleEditEntitlements | Role mining session parameters + + + var roleMiningPotentialRoleEditEntitlements v2024.RoleMiningPotentialRoleEditEntitlements + if err := json.Unmarshal(roleminingpotentialroleeditentitlements, &roleMiningPotentialRoleEditEntitlements); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IAIRoleMiningAPI.UpdateEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).RoleMiningPotentialRoleEditEntitlements(roleMiningPotentialRoleEditEntitlements).Execute() + //resp, r, err := apiClient.V2024.IAIRoleMiningAPI.UpdateEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).RoleMiningPotentialRoleEditEntitlements(roleMiningPotentialRoleEditEntitlements).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.UpdateEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateEntitlementsPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.UpdateEntitlementsPotentialRole`: %v\n", resp) + } +- path: /icons/{objectType}/{objectId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/icons#delete-icon + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + objectType := `application` // string | Object type. Available options ['application'] # string | Object type. Available options ['application'] + objectId := `a291e870-48c3-4953-b656-fb5ce2a93169` // string | Object id. # string | Object 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.IconsAPI.DeleteIcon(context.Background(), objectType, objectId).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.IconsAPI.DeleteIcon(context.Background(), objectType, objectId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IconsAPI.DeleteIcon``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /icons/{objectType}/{objectId} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/icons#set-icon + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + objectType := `application` // string | Object type. Available options ['application'] # string | Object type. Available options ['application'] + objectId := `a291e870-48c3-4953-b656-fb5ce2a93169` // string | Object id. # string | Object 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") + image := BINARY_DATA_HERE // *os.File | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] # *os.File | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IconsAPI.SetIcon(context.Background(), objectType, objectId).XSailPointExperimental(xSailPointExperimental).Image(image).Execute() + //resp, r, err := apiClient.V2024.IconsAPI.SetIcon(context.Background(), objectType, objectId).XSailPointExperimental(xSailPointExperimental).Image(image).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IconsAPI.SetIcon``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetIcon`: SetIcon200Response + fmt.Fprintf(os.Stdout, "Response from `IconsAPI.SetIcon`: %v\n", resp) + } +- path: /identities/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identities#delete-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + } +- path: /identities/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identities#get-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `GetIdentity`: Identity + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetIdentity`: %v\n", resp) + } +- path: /identities/{identityId}/ownership + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identities#get-identity-ownership-details + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `GetIdentityOwnershipDetails`: IdentityOwnershipAssociationDetails + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetIdentityOwnershipDetails`: %v\n", resp) + } +- path: /identities/{identityId}/role-assignments/{assignmentId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identities#get-role-assignment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `GetRoleAssignment`: RoleAssignmentDto + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetRoleAssignment`: %v\n", resp) + } +- path: /identities/{identityId}/role-assignments + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identities#get-role-assignments + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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) + + + + + 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() + 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) + } + // response from `GetRoleAssignments`: []GetRoleAssignments200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetRoleAssignments`: %v\n", resp) + } +- path: /identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identities#list-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.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() + 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) + } + // response from `ListIdentities`: []Identity + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.ListIdentities`: %v\n", resp) + } +- path: /identities/{id}/reset + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identities#reset-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + } +- path: /identities/{id}/verification/account/send + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identities#send-identity-verification-account-token + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + sendaccountverificationrequest := []byte(`{ + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" + }`) // SendAccountVerificationRequest | + + + var sendAccountVerificationRequest v2024.SendAccountVerificationRequest + if err := json.Unmarshal(sendaccountverificationrequest, &sendAccountVerificationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.IdentitiesAPI.SendIdentityVerificationAccountToken(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SendAccountVerificationRequest(sendAccountVerificationRequest).Execute() + //r, err := apiClient.V2024.IdentitiesAPI.SendIdentityVerificationAccountToken(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SendAccountVerificationRequest(sendAccountVerificationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.SendIdentityVerificationAccountToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /identities/invite + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identities#start-identities-invite + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 + }`) // InviteIdentitiesRequest | + + + var inviteIdentitiesRequest v2024.InviteIdentitiesRequest + if err := json.Unmarshal(inviteidentitiesrequest, &inviteIdentitiesRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + 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() + 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) + } + // response from `StartIdentitiesInvite`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.StartIdentitiesInvite`: %v\n", resp) + } +- path: /identities/process + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identities#start-identity-processing + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + processidentitiesrequest := []byte(`{ + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + }`) // ProcessIdentitiesRequest | + + + var processIdentitiesRequest v2024.ProcessIdentitiesRequest + if err := json.Unmarshal(processidentitiesrequest, &processIdentitiesRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentitiesAPI.StartIdentityProcessing(context.Background()).XSailPointExperimental(xSailPointExperimental).ProcessIdentitiesRequest(processIdentitiesRequest).Execute() + //resp, r, err := apiClient.V2024.IdentitiesAPI.StartIdentityProcessing(context.Background()).XSailPointExperimental(xSailPointExperimental).ProcessIdentitiesRequest(processIdentitiesRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.StartIdentityProcessing``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartIdentityProcessing`: TaskResultResponse + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.StartIdentityProcessing`: %v\n", resp) + } +- path: /identities/{identityId}/synchronize-attributes + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identities#synchronize-attributes-for-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `identityId_example` // 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.IdentitiesAPI.SynchronizeAttributesForIdentity(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentitiesAPI.SynchronizeAttributesForIdentity(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.SynchronizeAttributesForIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SynchronizeAttributesForIdentity`: IdentitySyncJob + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.SynchronizeAttributesForIdentity`: %v\n", resp) + } +- path: /identity-attributes + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-attributes#create-identity-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + }`) // IdentityAttribute | + + + var identityAttribute v2024.IdentityAttribute + if err := json.Unmarshal(identityattribute, &identityAttribute); err != nil { + fmt.Println("Error:", err) + return + } + + + + 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() + 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) + } + // response from `CreateIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.CreateIdentityAttribute`: %v\n", resp) + } +- path: /identity-attributes/{name} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-attributes#delete-identity-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + } +- path: /identity-attributes/bulk-delete + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-attributes#delete-identity-attributes-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 | + + + var identityAttributeNames v2024.IdentityAttributeNames + if err := json.Unmarshal(identityattributenames, &identityAttributeNames); err != nil { + fmt.Println("Error:", err) + return + } + + + + 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() + 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) + } + } +- path: /identity-attributes/{name} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-attributes#get-identity-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `GetIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.GetIdentityAttribute`: %v\n", resp) + } +- path: /identity-attributes + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-attributes#list-identity-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + 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() + 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) + } + // response from `ListIdentityAttributes`: []IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.ListIdentityAttributes`: %v\n", resp) + } +- path: /identity-attributes/{name} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-attributes#put-identity-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + }`) // IdentityAttribute | + + + var identityAttribute v2024.IdentityAttribute + if err := json.Unmarshal(identityattribute, &identityAttribute); err != nil { + fmt.Println("Error:", err) + return + } + + + + 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() + 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) + } + // response from `PutIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.PutIdentityAttribute`: %v\n", resp) + } +- path: /historical-identities/{id}/compare + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-history#compare-identity-snapshots + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + snapshot1 := `2007-03-01T13:00:00Z` // string | The snapshot 1 of identity (optional) # string | The snapshot 1 of identity (optional) + snapshot2 := `2008-03-01T13:00:00Z` // string | The snapshot 2 of identity (optional) # string | The snapshot 2 of identity (optional) + accessitemtypes := []byte(``) // []string | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityHistoryAPI.CompareIdentitySnapshots(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.CompareIdentitySnapshots(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Snapshot1(snapshot1).Snapshot2(snapshot2).AccessItemTypes(accessItemTypes).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.CompareIdentitySnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompareIdentitySnapshots`: []IdentityCompareResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.CompareIdentitySnapshots`: %v\n", resp) + } +- path: /historical-identities/{id}/compare/{access-type} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-history#compare-identity-snapshots-access-type + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + accessType := `role` // string | The specific type which needs to be compared # string | The specific type which needs to be compared + 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") + accessAssociated := 2007-03-01T13:00:00Z // bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) # bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) + snapshot1 := `2008-03-01T13:00:00Z` // string | The snapshot 1 of identity (optional) # string | The snapshot 1 of identity (optional) + snapshot2 := `2009-03-01T13:00:00Z` // string | The snapshot 2 of identity (optional) # string | The snapshot 2 of identity (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityHistoryAPI.CompareIdentitySnapshotsAccessType(context.Background(), id, accessType).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.CompareIdentitySnapshotsAccessType(context.Background(), id, accessType).XSailPointExperimental(xSailPointExperimental).AccessAssociated(accessAssociated).Snapshot1(snapshot1).Snapshot2(snapshot2).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.CompareIdentitySnapshotsAccessType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompareIdentitySnapshotsAccessType`: []AccessItemDiff + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.CompareIdentitySnapshotsAccessType`: %v\n", resp) + } +- path: /historical-identities/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-history#get-historical-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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.IdentityHistoryAPI.GetHistoricalIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.GetHistoricalIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetHistoricalIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetHistoricalIdentity`: IdentityHistoryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetHistoricalIdentity`: %v\n", resp) + } +- path: /historical-identities/{id}/events + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-history#get-historical-identity-events + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + from := `2024-03-01T13:00:00Z` // string | The optional instant until which access events are returned (optional) # string | The optional instant until which access events are returned (optional) + eventtypes := []byte(`[AccessAddedEvent, AccessRemovedEvent]`) // []string | An optional list of event types to return. If null or empty, all events are returned (optional) + accessitemtypes := []byte(`[entitlement, account]`) // []string | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityHistoryAPI.GetHistoricalIdentityEvents(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.GetHistoricalIdentityEvents(context.Background(), id).XSailPointExperimental(xSailPointExperimental).From(from).EventTypes(eventTypes).AccessItemTypes(accessItemTypes).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetHistoricalIdentityEvents``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetHistoricalIdentityEvents`: []GetHistoricalIdentityEvents200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetHistoricalIdentityEvents`: %v\n", resp) + } +- path: /historical-identities/{id}/snapshots/{date} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-history#get-identity-snapshot + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + date := `2007-03-01T13:00:00Z` // string | The specified date # string | The specified date + 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.IdentityHistoryAPI.GetIdentitySnapshot(context.Background(), id, date).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.GetIdentitySnapshot(context.Background(), id, date).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentitySnapshot``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySnapshot`: IdentityHistoryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentitySnapshot`: %v\n", resp) + } +- path: /historical-identities/{id}/snapshot-summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-history#get-identity-snapshot-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + before := `2007-03-01T13:00:00Z` // string | The date before which snapshot summary is required (optional) # string | The date before which snapshot summary is required (optional) + interval := `interval_example` // string | The interval indicating day or month. Defaults to month if not specified (optional) # string | The interval indicating day or month. Defaults to month if not specified (optional) + timeZone := `UTC` // string | The time zone. Defaults to UTC if not provided (optional) # string | The time zone. Defaults to UTC if not provided (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityHistoryAPI.GetIdentitySnapshotSummary(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.GetIdentitySnapshotSummary(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Before(before).Interval(interval).TimeZone(timeZone).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentitySnapshotSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySnapshotSummary`: []MetricResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentitySnapshotSummary`: %v\n", resp) + } +- path: /historical-identities/{id}/start-date + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-history#get-identity-start-date + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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.IdentityHistoryAPI.GetIdentityStartDate(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.GetIdentityStartDate(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentityStartDate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityStartDate`: string + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentityStartDate`: %v\n", resp) + } +- path: /historical-identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-history#list-historical-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + startsWithQuery := `Ada` // string | This param is used for starts-with search for first, last and display name of the identity (optional) # string | This param is used for starts-with search for first, last and display name of the identity (optional) + isDeleted := true // bool | Indicates if we want to only list down deleted identities or not. (optional) # bool | Indicates if we want to only list down deleted identities or not. (optional) + isActive := true // bool | Indicates if we want to only list active or inactive identities. (optional) # bool | Indicates if we want to only list active or inactive identities. (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) + 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.V2024.IdentityHistoryAPI.ListHistoricalIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.ListHistoricalIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).StartsWithQuery(startsWithQuery).IsDeleted(isDeleted).IsActive(isActive).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListHistoricalIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListHistoricalIdentities`: []IdentityListItem + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListHistoricalIdentities`: %v\n", resp) + } +- path: /historical-identities/{id}/access-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-history#list-identity-access-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + type_ := `account` // string | The type of access item for the identity. If not provided, it defaults to account (optional) # string | The type of access item for the identity. If not provided, it defaults to account (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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.V2024.IdentityHistoryAPI.ListIdentityAccessItems(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.ListIdentityAccessItems(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Type_(type_).Limit(limit).Count(count).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentityAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityAccessItems`: []ListIdentityAccessItems200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentityAccessItems`: %v\n", resp) + } +- path: /historical-identities/{id}/snapshots/{date}/access-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-history#list-identity-snapshot-access-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + date := `2007-03-01T13:00:00Z` // string | The specified date # string | The specified date + 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") + type_ := `account` // string | The access item type (optional) # string | The access item type (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityHistoryAPI.ListIdentitySnapshotAccessItems(context.Background(), id, date).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.ListIdentitySnapshotAccessItems(context.Background(), id, date).XSailPointExperimental(xSailPointExperimental).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentitySnapshotAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentitySnapshotAccessItems`: []ListIdentityAccessItems200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentitySnapshotAccessItems`: %v\n", resp) + } +- path: /historical-identities/{id}/snapshots + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-history#list-identity-snapshots + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + start := `2007-03-01T13:00:00Z` // string | The specified start date (optional) # string | The specified start date (optional) + interval := `interval_example` // string | The interval indicating the range in day or month for the specified interval-name (optional) # string | The interval indicating the range in day or month for the specified interval-name (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityHistoryAPI.ListIdentitySnapshots(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.IdentityHistoryAPI.ListIdentitySnapshots(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Start(start).Interval(interval).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentitySnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentitySnapshots`: []IdentitySnapshotSummaryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentitySnapshots`: %v\n", resp) + } +- path: /identity-profiles + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-profiles#create-identity-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityprofile := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + }`) // IdentityProfile | + + + var identityProfile v2024.IdentityProfile + if err := json.Unmarshal(identityprofile, &identityProfile); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.CreateIdentityProfile(context.Background()).IdentityProfile(identityProfile).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.CreateIdentityProfile(context.Background()).IdentityProfile(identityProfile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.CreateIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.CreateIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-profiles#delete-identity-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.DeleteIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.DeleteIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.DeleteIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteIdentityProfile`: TaskResultSimplified + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.DeleteIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-profiles#delete-identity-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestbody := []byte(``) // []string | Identity Profile bulk delete request body. + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.DeleteIdentityProfiles(context.Background()).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.DeleteIdentityProfiles(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.DeleteIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteIdentityProfiles`: TaskResultSimplified + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.DeleteIdentityProfiles`: %v\n", resp) + } +- path: /identity-profiles/export + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-profiles#export-identity-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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, ne* **name**: *eq, ne* **priority**: *eq, ne* (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, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + sorters := `id,name` // 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: **id, name, priority** (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: **id, name, priority** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.ExportIdentityProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.ExportIdentityProfiles(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ExportIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportIdentityProfiles`: []IdentityProfileExportedObject + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ExportIdentityProfiles`: %v\n", resp) + } +- path: /identity-profiles/identity-preview + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-profiles#generate-identity-preview + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + identitypreviewrequest := []byte(`{ + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + }`) // IdentityPreviewRequest | Identity Preview request body. + + + var identityPreviewRequest v2024.IdentityPreviewRequest + if err := json.Unmarshal(identitypreviewrequest, &identityPreviewRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.GenerateIdentityPreview(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityPreviewRequest(identityPreviewRequest).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.GenerateIdentityPreview(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityPreviewRequest(identityPreviewRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GenerateIdentityPreview``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GenerateIdentityPreview`: IdentityPreviewResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GenerateIdentityPreview`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-profiles#get-default-identity-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | The Identity Profile ID. # string | The Identity Profile ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.GetDefaultIdentityAttributeConfig(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.GetDefaultIdentityAttributeConfig(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GetDefaultIdentityAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDefaultIdentityAttributeConfig`: IdentityAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GetDefaultIdentityAttributeConfig`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-profiles#get-identity-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.GetIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.GetIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GetIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GetIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/import + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-profiles#import-identity-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityprofileexportedobject := []byte(``) // []IdentityProfileExportedObject | Previously exported Identity Profiles. + + + var identityProfileExportedObject v2024.[]IdentityProfileExportedObject + if err := json.Unmarshal(identityprofileexportedobject, &identityProfileExportedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.ImportIdentityProfiles(context.Background()).IdentityProfileExportedObject(identityProfileExportedObject).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.ImportIdentityProfiles(context.Background()).IdentityProfileExportedObject(identityProfileExportedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ImportIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportIdentityProfiles`: ObjectImportResult + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ImportIdentityProfiles`: %v\n", resp) + } +- path: /identity-profiles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-profiles#list-identity-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) + sorters := `id,name` // 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: **id, name, priority, created, modified, owner.id, owner.name** (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: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.ListIdentityProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.ListIdentityProfiles(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ListIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityProfiles`: []IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ListIdentityProfiles`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/process-identities + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-profiles#sync-identity-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | The Identity Profile ID to be processed # string | The Identity Profile ID to be processed + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.SyncIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.SyncIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.SyncIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SyncIdentityProfile`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.SyncIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/identity-profiles#update-identity-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + jsonpatchoperation := []byte(`[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]`) // []JsonPatchOperation | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.IdentityProfilesAPI.UpdateIdentityProfile(context.Background(), identityProfileId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.IdentityProfilesAPI.UpdateIdentityProfile(context.Background(), identityProfileId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.UpdateIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.UpdateIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/lifecycle-states#create-lifecycle-state + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile ID. + lifecyclestate := []byte(`{ + "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], + "emailNotificationOption" : { + "notifyManagers" : true, + "notifySpecificUsers" : true, + "emailAddressList" : [ "test@test.com", "test2@test.com" ], + "notifyAllAdmins" : true + }, + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Lifecycle description", + "accountActions" : [ { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }, { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } ], + "id" : "id12345", + "identityCount" : 42, + "technicalName" : "Technical Name", + "identityState" : "identityState", + "enabled" : true + }`) // LifecycleState | Lifecycle state to be created. + + + var lifecycleState v2024.LifecycleState + if err := json.Unmarshal(lifecyclestate, &lifecycleState); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.LifecycleStatesAPI.CreateLifecycleState(context.Background(), identityProfileId).LifecycleState(lifecycleState).Execute() + //resp, r, err := apiClient.V2024.LifecycleStatesAPI.CreateLifecycleState(context.Background(), identityProfileId).LifecycleState(lifecycleState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.CreateLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateLifecycleState`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.CreateLifecycleState`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/lifecycle-states#delete-lifecycle-state + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.LifecycleStatesAPI.DeleteLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + //resp, r, err := apiClient.V2024.LifecycleStatesAPI.DeleteLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.DeleteLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteLifecycleState`: LifecyclestateDeleted + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.DeleteLifecycleState`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/lifecycle-states#get-lifecycle-state + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.LifecycleStatesAPI.GetLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + //resp, r, err := apiClient.V2024.LifecycleStatesAPI.GetLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.GetLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLifecycleState`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.GetLifecycleState`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/lifecycle-states#get-lifecycle-states + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `created,modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.LifecycleStatesAPI.GetLifecycleStates(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2024.LifecycleStatesAPI.GetLifecycleStates(context.Background(), identityProfileId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.GetLifecycleStates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLifecycleStates`: []LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.GetLifecycleStates`: %v\n", resp) + } +- path: /identities/{identity-id}/set-lifecycle-state + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/lifecycle-states#set-lifecycle-state + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `2c9180857893f1290178944561990364` // string | ID of the identity to update. # string | ID of the identity to update. + setlifecyclestaterequest := []byte(``) // SetLifecycleStateRequest | + + + var setLifecycleStateRequest v2024.SetLifecycleStateRequest + if err := json.Unmarshal(setlifecyclestaterequest, &setLifecycleStateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.LifecycleStatesAPI.SetLifecycleState(context.Background(), identityId).SetLifecycleStateRequest(setLifecycleStateRequest).Execute() + //resp, r, err := apiClient.V2024.LifecycleStatesAPI.SetLifecycleState(context.Background(), identityId).SetLifecycleStateRequest(setLifecycleStateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.SetLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetLifecycleState`: SetLifecycleState200Response + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.SetLifecycleState`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/lifecycle-states#update-lifecycle-states + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.LifecycleStatesAPI.UpdateLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.LifecycleStatesAPI.UpdateLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.UpdateLifecycleStates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateLifecycleStates`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.UpdateLifecycleStates`: %v\n", resp) + } +- path: /accounts/{id}/classify + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/machine-account-classify#send-classify-machine-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + classificationMode := `forceMachine` // string | Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. (optional) (default to "default") # string | Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. (optional) (default to "default") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineAccountClassifyAPI.SendClassifyMachineAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.MachineAccountClassifyAPI.SendClassifyMachineAccount(context.Background(), id).ClassificationMode(classificationMode).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountClassifyAPI.SendClassifyMachineAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendClassifyMachineAccount`: SendClassifyMachineAccount200Response + fmt.Fprintf(os.Stdout, "Response from `MachineAccountClassifyAPI.SendClassifyMachineAccount`: %v\n", resp) + } +- path: /sources/{sourceId}/machine-account-mappings + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/machine-account-mappings#create-machine-account-mappings + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source ID. # string | Source ID. + attributemappings := []byte(`{ + "transformDefinition" : { + "attributes" : { + "input" : { + "attributes" : { + "name" : "8d3e0094e99445de98eef6c75e25jc04", + "attributeName" : "givenName", + "sourceName" : "delimited-src" + }, + "type" : "accountAttribute" + } + }, + "id" : "ToUpper", + "type" : "reference" + }, + "target" : { + "sourceId" : "2c9180835d2e5168015d32f890ca1581", + "attributeName" : "businessApplication", + "type" : "IDENTITY" + } + }`) // AttributeMappings | + + + var attributeMappings v2024.AttributeMappings + if err := json.Unmarshal(attributemappings, &attributeMappings); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineAccountMappingsAPI.CreateMachineAccountMappings(context.Background(), id).AttributeMappings(attributeMappings).Execute() + //resp, r, err := apiClient.V2024.MachineAccountMappingsAPI.CreateMachineAccountMappings(context.Background(), id).AttributeMappings(attributeMappings).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountMappingsAPI.CreateMachineAccountMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateMachineAccountMappings`: []AttributeMappings + fmt.Fprintf(os.Stdout, "Response from `MachineAccountMappingsAPI.CreateMachineAccountMappings`: %v\n", resp) + } +- path: /sources/{sourceId}/machine-account-mappings + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/machine-account-mappings#delete-machine-account-mappings + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | source ID. # string | source ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.MachineAccountMappingsAPI.DeleteMachineAccountMappings(context.Background(), id).Execute() + //r, err := apiClient.V2024.MachineAccountMappingsAPI.DeleteMachineAccountMappings(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountMappingsAPI.DeleteMachineAccountMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{sourceId}/machine-account-mappings + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/machine-account-mappings#list-machine-account-mappings + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source ID # string | 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.V2024.MachineAccountMappingsAPI.ListMachineAccountMappings(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.MachineAccountMappingsAPI.ListMachineAccountMappings(context.Background(), id).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountMappingsAPI.ListMachineAccountMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListMachineAccountMappings`: []AttributeMappings + fmt.Fprintf(os.Stdout, "Response from `MachineAccountMappingsAPI.ListMachineAccountMappings`: %v\n", resp) + } +- path: /sources/{sourceId}/machine-mappings + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/machine-account-mappings#set-machine-account-mappings + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source ID. # string | Source ID. + attributemappings := []byte(`{ + "transformDefinition" : { + "attributes" : { + "input" : { + "attributes" : { + "name" : "8d3e0094e99445de98eef6c75e25jc04", + "attributeName" : "givenName", + "sourceName" : "delimited-src" + }, + "type" : "accountAttribute" + } + }, + "id" : "ToUpper", + "type" : "reference" + }, + "target" : { + "sourceId" : "2c9180835d2e5168015d32f890ca1581", + "attributeName" : "businessApplication", + "type" : "IDENTITY" + } + }`) // AttributeMappings | + + + var attributeMappings v2024.AttributeMappings + if err := json.Unmarshal(attributemappings, &attributeMappings); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineAccountMappingsAPI.SetMachineAccountMappings(context.Background(), id).AttributeMappings(attributeMappings).Execute() + //resp, r, err := apiClient.V2024.MachineAccountMappingsAPI.SetMachineAccountMappings(context.Background(), id).AttributeMappings(attributeMappings).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountMappingsAPI.SetMachineAccountMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMachineAccountMappings`: []AttributeMappings + fmt.Fprintf(os.Stdout, "Response from `MachineAccountMappingsAPI.SetMachineAccountMappings`: %v\n", resp) + } +- path: /machine-accounts/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/machine-accounts#get-machine-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Account ID. # string | Machine 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.MachineAccountsAPI.GetMachineAccount(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.MachineAccountsAPI.GetMachineAccount(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountsAPI.GetMachineAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMachineAccount`: MachineAccount + fmt.Fprintf(os.Stdout, "Response from `MachineAccountsAPI.GetMachineAccount`: %v\n", resp) + } +- path: /machine-accounts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/machine-accounts#list-machine-accounts + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `identityId eq "2c9180858082150f0180893dbaf44201"` // 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, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *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, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) + sorters := `id,name` // 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: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (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: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineAccountsAPI.ListMachineAccounts(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.MachineAccountsAPI.ListMachineAccounts(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountsAPI.ListMachineAccounts``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListMachineAccounts`: []MachineAccount + fmt.Fprintf(os.Stdout, "Response from `MachineAccountsAPI.ListMachineAccounts`: %v\n", resp) + } +- path: /machine-accounts/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/machine-accounts#update-machine-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Account ID. # string | Machine 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") + requestbody := []byte(`[{op=add, path=/environment, value=test}]`) // []map[string]interface{} | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineAccountsAPI.UpdateMachineAccount(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2024.MachineAccountsAPI.UpdateMachineAccount(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountsAPI.UpdateMachineAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateMachineAccount`: MachineAccount + fmt.Fprintf(os.Stdout, "Response from `MachineAccountsAPI.UpdateMachineAccount`: %v\n", resp) + } +- path: /sources/{sourceId}/machine-classification-config + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/machine-classification-config#delete-machine-classification-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source ID. # string | Source ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.MachineClassificationConfigAPI.DeleteMachineClassificationConfig(context.Background(), id).Execute() + //r, err := apiClient.V2024.MachineClassificationConfigAPI.DeleteMachineClassificationConfig(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineClassificationConfigAPI.DeleteMachineClassificationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{sourceId}/machine-classification-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/machine-classification-config#get-machine-classification-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source ID # string | Source ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineClassificationConfigAPI.GetMachineClassificationConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.MachineClassificationConfigAPI.GetMachineClassificationConfig(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineClassificationConfigAPI.GetMachineClassificationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMachineClassificationConfig`: MachineClassificationConfig + fmt.Fprintf(os.Stdout, "Response from `MachineClassificationConfigAPI.GetMachineClassificationConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/machine-classification-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/machine-classification-config#set-machine-classification-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source ID. # string | Source ID. + machineclassificationconfig := []byte(`{ + "criteria" : "criteria", + "created" : "2017-07-11T18:45:37.098Z", + "modified" : "2018-06-25T20:22:28.104Z", + "classificationMethod" : "SOURCE", + "enabled" : true + }`) // MachineClassificationConfig | + + + var machineClassificationConfig v2024.MachineClassificationConfig + if err := json.Unmarshal(machineclassificationconfig, &machineClassificationConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineClassificationConfigAPI.SetMachineClassificationConfig(context.Background(), id).MachineClassificationConfig(machineClassificationConfig).Execute() + //resp, r, err := apiClient.V2024.MachineClassificationConfigAPI.SetMachineClassificationConfig(context.Background(), id).MachineClassificationConfig(machineClassificationConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineClassificationConfigAPI.SetMachineClassificationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMachineClassificationConfig`: MachineClassificationConfig + fmt.Fprintf(os.Stdout, "Response from `MachineClassificationConfigAPI.SetMachineClassificationConfig`: %v\n", resp) + } +- path: /machine-identities + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/machine-identities#create-machine-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + machineidentity := []byte(`{ + "created" : "2015-05-28T14:07:17Z", + "businessApplication" : "ADService", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "", + "attributes" : "{\"Region\":\"EU\"}", + "id" : "id12345", + "manuallyEdited" : true + }`) // MachineIdentity | + + + var machineIdentity v2024.MachineIdentity + if err := json.Unmarshal(machineidentity, &machineIdentity); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineIdentitiesAPI.CreateMachineIdentity(context.Background()).XSailPointExperimental(xSailPointExperimental).MachineIdentity(machineIdentity).Execute() + //resp, r, err := apiClient.V2024.MachineIdentitiesAPI.CreateMachineIdentity(context.Background()).XSailPointExperimental(xSailPointExperimental).MachineIdentity(machineIdentity).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.CreateMachineIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateMachineIdentity`: MachineIdentity + fmt.Fprintf(os.Stdout, "Response from `MachineIdentitiesAPI.CreateMachineIdentity`: %v\n", resp) + } +- path: /machine-identities/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/machine-identities#delete-machine-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Identity ID # string | Machine 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.MachineIdentitiesAPI.DeleteMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.MachineIdentitiesAPI.DeleteMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.DeleteMachineIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /machine-identities/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/machine-identities#get-machine-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Identity ID # string | Machine 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.MachineIdentitiesAPI.GetMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.MachineIdentitiesAPI.GetMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.GetMachineIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMachineIdentity`: MachineIdentity + fmt.Fprintf(os.Stdout, "Response from `MachineIdentitiesAPI.GetMachineIdentity`: %v\n", resp) + } +- path: /machine-identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/machine-identities#list-machine-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 := `identityId eq "2c9180858082150f0180893dbaf44201"` // 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) + sorters := `businessApplication` // 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: **businessApplication, name** (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: **businessApplication, name** (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.V2024.MachineIdentitiesAPI.ListMachineIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.MachineIdentitiesAPI.ListMachineIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).Filters(filters).Sorters(sorters).Count(count).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.ListMachineIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListMachineIdentities`: []MachineIdentity + fmt.Fprintf(os.Stdout, "Response from `MachineIdentitiesAPI.ListMachineIdentities`: %v\n", resp) + } +- path: /machine-identities/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/machine-identities#update-machine-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Identity ID. # string | Machine 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") + requestbody := []byte(`[{op=add, path=/attributes/securityRisk, value=medium}]`) // []map[string]interface{} | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MachineIdentitiesAPI.UpdateMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2024.MachineIdentitiesAPI.UpdateMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.UpdateMachineIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateMachineIdentity`: MachineIdentity + fmt.Fprintf(os.Stdout, "Response from `MachineIdentitiesAPI.UpdateMachineIdentity`: %v\n", resp) + } +- path: /managed-clients + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-clients#create-managed-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + managedclientrequest := []byte(`{ + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + }`) // ManagedClientRequest | + + + var managedClientRequest v2024.ManagedClientRequest + if err := json.Unmarshal(managedclientrequest, &managedClientRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClientsAPI.CreateManagedClient(context.Background()).ManagedClientRequest(managedClientRequest).Execute() + //resp, r, err := apiClient.V2024.ManagedClientsAPI.CreateManagedClient(context.Background()).ManagedClientRequest(managedClientRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.CreateManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.CreateManagedClient`: %v\n", resp) + } +- path: /managed-clients/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-clients#delete-managed-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ManagedClientsAPI.DeleteManagedClient(context.Background(), id).Execute() + //r, err := apiClient.V2024.ManagedClientsAPI.DeleteManagedClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.DeleteManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /managed-clients/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-clients#get-managed-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClientsAPI.GetManagedClient(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ManagedClientsAPI.GetManagedClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClient`: %v\n", resp) + } +- path: /managed-clients/{id}/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-clients#get-managed-client-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `aClientId` // string | Managed client ID to get status for. # string | Managed client ID to get status for. + type_ := // ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClientsAPI.GetManagedClientStatus(context.Background(), id).Type_(type_).Execute() + //resp, r, err := apiClient.V2024.ManagedClientsAPI.GetManagedClientStatus(context.Background(), id).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClientStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClientStatus`: ManagedClientStatus + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClientStatus`: %v\n", resp) + } +- path: /managed-clients + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-clients#get-managed-clients + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "client name"` // 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* **name**: *eq* **clientId**: *eq* **clusterId**: *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* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClientsAPI.GetManagedClients(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ManagedClientsAPI.GetManagedClients(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClients``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClients`: []ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClients`: %v\n", resp) + } +- path: /managed-clients/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-clients#update-managed-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | JSONPatch payload used to update the object. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClientsAPI.UpdateManagedClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.ManagedClientsAPI.UpdateManagedClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.UpdateManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.UpdateManagedClient`: %v\n", resp) + } +- path: /managed-clusters + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-clusters#create-managed-cluster + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + managedclusterrequest := []byte(`{ + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + }`) // ManagedClusterRequest | + + + var managedClusterRequest v2024.ManagedClusterRequest + if err := json.Unmarshal(managedclusterrequest, &managedClusterRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClustersAPI.CreateManagedCluster(context.Background()).ManagedClusterRequest(managedClusterRequest).Execute() + //resp, r, err := apiClient.V2024.ManagedClustersAPI.CreateManagedCluster(context.Background()).ManagedClusterRequest(managedClusterRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.CreateManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.CreateManagedCluster`: %v\n", resp) + } +- path: /managed-clusters/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-clusters#delete-managed-cluster + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + removeClients := false // bool | Flag to determine the need to delete a cluster with clients. (optional) (default to false) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ManagedClustersAPI.DeleteManagedCluster(context.Background(), id).Execute() + //r, err := apiClient.V2024.ManagedClustersAPI.DeleteManagedCluster(context.Background(), id).RemoveClients(removeClients).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.DeleteManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /managed-clusters/{id}/log-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-clusters#get-client-log-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | ID of managed cluster to get log configuration for. # string | ID of managed cluster to get log configuration for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClustersAPI.GetClientLogConfiguration(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ManagedClustersAPI.GetClientLogConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetClientLogConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetClientLogConfiguration`: ClientLogConfiguration + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetClientLogConfiguration`: %v\n", resp) + } +- path: /managed-clusters/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-clusters#get-managed-cluster + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClustersAPI.GetManagedCluster(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ManagedClustersAPI.GetManagedCluster(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetManagedCluster`: %v\n", resp) + } +- path: /managed-clusters + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-clusters#get-managed-clusters + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `operational eq "operation"` // 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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClustersAPI.GetManagedClusters(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ManagedClustersAPI.GetManagedClusters(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetManagedClusters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClusters`: []ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetManagedClusters`: %v\n", resp) + } +- path: /managed-clusters/{id}/log-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-clusters#put-client-log-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | ID of the managed cluster to update the log configuration for. # string | ID of the managed cluster to update the log configuration for. + putclientlogconfigurationrequest := []byte(``) // PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + + + var putClientLogConfigurationRequest v2024.PutClientLogConfigurationRequest + if err := json.Unmarshal(putclientlogconfigurationrequest, &putClientLogConfigurationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClustersAPI.PutClientLogConfiguration(context.Background(), id).PutClientLogConfigurationRequest(putClientLogConfigurationRequest).Execute() + //resp, r, err := apiClient.V2024.ManagedClustersAPI.PutClientLogConfiguration(context.Background(), id).PutClientLogConfigurationRequest(putClientLogConfigurationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.PutClientLogConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutClientLogConfiguration`: ClientLogConfiguration + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.PutClientLogConfiguration`: %v\n", resp) + } +- path: /managed-clusters/{id}/manualUpgrade + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-clusters#update + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | ID of managed cluster to trigger manual upgrade. # string | ID of managed cluster to trigger manual upgrade. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClustersAPI.Update(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ManagedClustersAPI.Update(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.Update``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `Update`: ClusterManualUpgrade + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.Update`: %v\n", resp) + } +- path: /managed-clusters/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-clusters#update-managed-cluster + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | JSONPatch payload used to update the object. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClustersAPI.UpdateManagedCluster(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.ManagedClustersAPI.UpdateManagedCluster(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.UpdateManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.UpdateManagedCluster`: %v\n", resp) + } +- path: /managed-cluster-types + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-cluster-types#create-managed-cluster-type + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + managedclustertype := []byte(`{ + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + }`) // ManagedClusterType | + + + var managedClusterType v2024.ManagedClusterType + if err := json.Unmarshal(managedclustertype, &managedClusterType); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClusterTypesAPI.CreateManagedClusterType(context.Background()).ManagedClusterType(managedClusterType).Execute() + //resp, r, err := apiClient.V2024.ManagedClusterTypesAPI.CreateManagedClusterType(context.Background()).ManagedClusterType(managedClusterType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.CreateManagedClusterType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateManagedClusterType`: ManagedClusterType + fmt.Fprintf(os.Stdout, "Response from `ManagedClusterTypesAPI.CreateManagedClusterType`: %v\n", resp) + } +- path: /managed-cluster-types/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-cluster-types#delete-managed-cluster-type + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `aClusterTypeId` // string | The Managed Cluster Type ID # string | The Managed Cluster Type ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ManagedClusterTypesAPI.DeleteManagedClusterType(context.Background(), id).Execute() + //r, err := apiClient.V2024.ManagedClusterTypesAPI.DeleteManagedClusterType(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.DeleteManagedClusterType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /managed-cluster-types/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-cluster-types#get-managed-cluster-type + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `aClusterTypeId` // string | The Managed Cluster Type ID # string | The Managed Cluster Type ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClusterTypesAPI.GetManagedClusterType(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ManagedClusterTypesAPI.GetManagedClusterType(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.GetManagedClusterType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClusterType`: ManagedClusterType + fmt.Fprintf(os.Stdout, "Response from `ManagedClusterTypesAPI.GetManagedClusterType`: %v\n", resp) + } +- path: /managed-cluster-types + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-cluster-types#get-managed-cluster-types + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + type_ := `IDN` // string | Type descriptor (optional) # string | Type descriptor (optional) + pod := `megapod-useast1` // string | Pinned pod (or default) (optional) # string | Pinned pod (or default) (optional) + org := `denali-xyz` // string | Pinned org (or default) (optional) # string | Pinned org (or default) (optional) + 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) + 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) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClusterTypesAPI.GetManagedClusterTypes(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ManagedClusterTypesAPI.GetManagedClusterTypes(context.Background()).Type_(type_).Pod(pod).Org(org).Offset(offset).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.GetManagedClusterTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClusterTypes`: []ManagedClusterType + fmt.Fprintf(os.Stdout, "Response from `ManagedClusterTypesAPI.GetManagedClusterTypes`: %v\n", resp) + } +- path: /managed-cluster-types/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/managed-cluster-types#update-managed-cluster-type + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `aClusterTypeId` // string | The Managed Cluster Type ID # string | The Managed Cluster Type ID + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | The JSONPatch payload used to update the schema. + + + var jsonPatch v2024.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ManagedClusterTypesAPI.UpdateManagedClusterType(context.Background(), id).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2024.ManagedClusterTypesAPI.UpdateManagedClusterType(context.Background(), id).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.UpdateManagedClusterType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedClusterType`: ManagedClusterType + fmt.Fprintf(os.Stdout, "Response from `ManagedClusterTypesAPI.UpdateManagedClusterType`: %v\n", resp) + } +- path: /mfa/duo-web/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/mfa-configuration#get-mfa-duo-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MFAConfigurationAPI.GetMFADuoConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.MFAConfigurationAPI.GetMFADuoConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFADuoConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFADuoConfig`: MfaDuoConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFADuoConfig`: %v\n", resp) + } +- path: /mfa/kba/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/mfa-configuration#get-mfa-kba-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + allLanguages := allLanguages=true // bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MFAConfigurationAPI.GetMFAKbaConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.MFAConfigurationAPI.GetMFAKbaConfig(context.Background()).AllLanguages(allLanguages).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFAKbaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFAKbaConfig`: []KbaQuestion + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFAKbaConfig`: %v\n", resp) + } +- path: /mfa/okta-verify/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/mfa-configuration#get-mfa-okta-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MFAConfigurationAPI.GetMFAOktaConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.MFAConfigurationAPI.GetMFAOktaConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFAOktaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFAOktaConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFAOktaConfig`: %v\n", resp) + } +- path: /mfa/duo-web/config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/mfa-configuration#set-mfa-duo-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + mfaduoconfig := []byte(`{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }`) // MfaDuoConfig | + + + var mfaDuoConfig v2024.MfaDuoConfig + if err := json.Unmarshal(mfaduoconfig, &mfaDuoConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MFAConfigurationAPI.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute() + //resp, r, err := apiClient.V2024.MFAConfigurationAPI.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFADuoConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFADuoConfig`: MfaDuoConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFADuoConfig`: %v\n", resp) + } +- path: /mfa/kba/config/answers + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/mfa-configuration#set-mfakba-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + kbaanswerrequestitem := []byte(`[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]`) // []KbaAnswerRequestItem | + + + var kbaAnswerRequestItem v2024.[]KbaAnswerRequestItem + if err := json.Unmarshal(kbaanswerrequestitem, &kbaAnswerRequestItem); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MFAConfigurationAPI.SetMFAKBAConfig(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + //resp, r, err := apiClient.V2024.MFAConfigurationAPI.SetMFAKBAConfig(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFAKBAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFAKBAConfig`: []KbaAnswerResponseItem + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFAKBAConfig`: %v\n", resp) + } +- path: /mfa/okta-verify/config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/mfa-configuration#set-mfa-okta-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + mfaoktaconfig := []byte(`{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }`) // MfaOktaConfig | + + + var mfaOktaConfig v2024.MfaOktaConfig + if err := json.Unmarshal(mfaoktaconfig, &mfaOktaConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MFAConfigurationAPI.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute() + //resp, r, err := apiClient.V2024.MFAConfigurationAPI.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFAOktaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFAOktaConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFAOktaConfig`: %v\n", resp) + } +- path: /mfa/{method}/test + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/mfa-configuration#test-mfa-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + method := `okta-verify` // string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MFAConfigurationAPI.TestMFAConfig(context.Background(), method).Execute() + //resp, r, err := apiClient.V2024.MFAConfigurationAPI.TestMFAConfig(context.Background(), method).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.TestMFAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestMFAConfig`: MfaConfigTestResponse + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.TestMFAConfig`: %v\n", resp) + } +- path: /multihosts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/multi-host-integration#create-multi-host-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostintegrationscreate := []byte(`{ + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + }`) // MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create + + + var multiHostIntegrationsCreate v2024.MultiHostIntegrationsCreate + if err := json.Unmarshal(multihostintegrationscreate, &multiHostIntegrationsCreate); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.CreateMultiHostIntegration(context.Background()).MultiHostIntegrationsCreate(multiHostIntegrationsCreate).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.CreateMultiHostIntegration(context.Background()).MultiHostIntegrationsCreate(multiHostIntegrationsCreate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.CreateMultiHostIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateMultiHostIntegration`: MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.CreateMultiHostIntegration`: %v\n", resp) + } +- path: /multihosts/{multihostId} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/multi-host-integration#create-sources-within-multi-host + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration. # string | ID of the Multi-Host Integration. + multihostintegrationscreatesources := []byte(``) // []MultiHostIntegrationsCreateSources | The specifics of the sources to create within Multi-Host Integration. + + + var multiHostIntegrationsCreateSources v2024.[]MultiHostIntegrationsCreateSources + if err := json.Unmarshal(multihostintegrationscreatesources, &multiHostIntegrationsCreateSources); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.MultiHostIntegrationAPI.CreateSourcesWithinMultiHost(context.Background(), multihostId).MultiHostIntegrationsCreateSources(multiHostIntegrationsCreateSources).Execute() + //r, err := apiClient.V2024.MultiHostIntegrationAPI.CreateSourcesWithinMultiHost(context.Background(), multihostId).MultiHostIntegrationsCreateSources(multiHostIntegrationsCreateSources).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.CreateSourcesWithinMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /multihosts/{multihostId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/multi-host-integration#delete-multi-host + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of Multi-Host Integration to delete. # string | ID of Multi-Host Integration to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.MultiHostIntegrationAPI.DeleteMultiHost(context.Background(), multihostId).Execute() + //r, err := apiClient.V2024.MultiHostIntegrationAPI.DeleteMultiHost(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.DeleteMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /multihosts/{multihostId}/acctAggregationGroups + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/multi-host-integration#get-acct-aggregation-groups + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + 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) + 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) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetAcctAggregationGroups(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetAcctAggregationGroups(context.Background(), multihostId).Offset(offset).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetAcctAggregationGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAcctAggregationGroups`: []MultiHostIntegrationsAggScheduleUpdate + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetAcctAggregationGroups`: %v\n", resp) + } +- path: /multihosts/{multiHostId}/entitlementAggregationGroups + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/multi-host-integration#get-entitlement-aggregation-groups + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multiHostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + 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) + 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) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetEntitlementAggregationGroups(context.Background(), multiHostId).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetEntitlementAggregationGroups(context.Background(), multiHostId).Offset(offset).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetEntitlementAggregationGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementAggregationGroups`: []MultiHostIntegrationsAggScheduleUpdate + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetEntitlementAggregationGroups`: %v\n", resp) + } +- path: /multihosts/{multihostId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/multi-host-integration#get-multi-host-integrations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration. # string | ID of the Multi-Host Integration. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetMultiHostIntegrations(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetMultiHostIntegrations(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostIntegrations`: MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostIntegrations`: %v\n", resp) + } +- path: /multihosts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/multi-host-integration#get-multi-host-integrations-list + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `id eq 2c91808b6ef1d43e016efba0ce470904` // 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: **type**: *in* **forSubAdminId**: *in* (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: **type**: *in* **forSubAdminId**: *in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetMultiHostIntegrationsList(context.Background()).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetMultiHostIntegrationsList(context.Background()).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).ForSubadmin(forSubadmin).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostIntegrationsList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostIntegrationsList`: []MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostIntegrationsList`: %v\n", resp) + } +- path: /multihosts/{multiHostId}/sources/errors + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/multi-host-integration#get-multi-host-source-creation-errors + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multiHostId := `004091cb79b04636b88662afa50a4440` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors(context.Background(), multiHostId).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors(context.Background(), multiHostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostSourceCreationErrors`: []SourceCreationErrors + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors`: %v\n", resp) + } +- path: /multihosts/types + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/multi-host-integration#get-multihost-integration-types + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetMultihostIntegrationTypes(context.Background()).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetMultihostIntegrationTypes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultihostIntegrationTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultihostIntegrationTypes`: []MultiHostIntegrationTemplateType + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultihostIntegrationTypes`: %v\n", resp) + } +- path: /multihosts/{multihostId}/sources + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/multi-host-integration#get-sources-within-multi-host + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `id eq 2c91808b6ef1d43e016efba0ce470904` // 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**: *in* (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**: *in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetSourcesWithinMultiHost(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.GetSourcesWithinMultiHost(context.Background(), multihostId).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetSourcesWithinMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourcesWithinMultiHost`: []MultiHostSources + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetSourcesWithinMultiHost`: %v\n", resp) + } +- path: /multihosts/{multihostId}/sources/testConnection + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/multi-host-integration#test-connection-multi-host-sources + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostId := `2c91808568c529c60168cca6f90c1324` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.MultiHostIntegrationAPI.TestConnectionMultiHostSources(context.Background(), multihostId).Execute() + //r, err := apiClient.V2024.MultiHostIntegrationAPI.TestConnectionMultiHostSources(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.TestConnectionMultiHostSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /multihosts/{multihostId}/sources/{sourceId}/testConnection + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/multi-host-integration#test-source-connection-multihost + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + sourceId := `2c91808568c529f60168cca6f90c1324` // string | ID of the source within the Multi-Host Integration # string | ID of the source within the Multi-Host Integration + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.TestSourceConnectionMultihost(context.Background(), multihostId, sourceId).Execute() + //resp, r, err := apiClient.V2024.MultiHostIntegrationAPI.TestSourceConnectionMultihost(context.Background(), multihostId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.TestSourceConnectionMultihost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConnectionMultihost`: TestSourceConnectionMultihost200Response + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.TestSourceConnectionMultihost`: %v\n", resp) + } +- path: /multihosts/{multihostId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/multi-host-integration#update-multi-host-sources + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostId := `anId` // string | ID of the Multi-Host Integration to update. # string | ID of the Multi-Host Integration to update. + updatemultihostsourcesrequestinner := []byte(`[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]`) // []UpdateMultiHostSourcesRequestInner | This endpoint allows you to update a Multi-Host Integration. + + + var updateMultiHostSourcesRequestInner v2024.[]UpdateMultiHostSourcesRequestInner + if err := json.Unmarshal(updatemultihostsourcesrequestinner, &updateMultiHostSourcesRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.MultiHostIntegrationAPI.UpdateMultiHostSources(context.Background(), multihostId).UpdateMultiHostSourcesRequestInner(updateMultiHostSourcesRequestInner).Execute() + //r, err := apiClient.V2024.MultiHostIntegrationAPI.UpdateMultiHostSources(context.Background(), multihostId).UpdateMultiHostSourcesRequestInner(updateMultiHostSourcesRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.UpdateMultiHostSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-approvals/{id}/approve + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + nonemployeeapprovaldecision := []byte(`{ + "comment" : "Approved by manager" + }`) // NonEmployeeApprovalDecision | + + + var nonEmployeeApprovalDecision v2024.NonEmployeeApprovalDecision + if err := json.Unmarshal(nonemployeeapprovaldecision, &nonEmployeeApprovalDecision); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest(context.Background(), id).NonEmployeeApprovalDecision(nonEmployeeApprovalDecision).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest(context.Background(), id).NonEmployeeApprovalDecision(nonEmployeeApprovalDecision).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveNonEmployeeRequest`: NonEmployeeApprovalItem + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest`: %v\n", resp) + } +- path: /non-employee-records + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-Employee record creation request body. + + + var nonEmployeeRequestBody v2024.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord`: %v\n", resp) + } +- path: /non-employee-requests + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-Employee creation request body + + + var nonEmployeeRequestBody v2024.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeRequest`: NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest`: %v\n", resp) + } +- path: /non-employee-sources + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + nonemployeesourcerequestbody := []byte(`{ + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + }`) // NonEmployeeSourceRequestBody | Non-Employee source creation request body. + + + var nonEmployeeSourceRequestBody v2024.NonEmployeeSourceRequestBody + if err := json.Unmarshal(nonemployeesourcerequestbody, &nonEmployeeSourceRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource(context.Background()).NonEmployeeSourceRequestBody(nonEmployeeSourceRequestBody).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource(context.Background()).NonEmployeeSourceRequestBody(nonEmployeeSourceRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeSource`: NonEmployeeSourceWithCloudExternalId + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + nonemployeeschemaattributebody := []byte(`{ + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + }`) // NonEmployeeSchemaAttributeBody | + + + var nonEmployeeSchemaAttributeBody v2024.NonEmployeeSchemaAttributeBody + if err := json.Unmarshal(nonemployeeschemaattributebody, &nonEmployeeSchemaAttributeBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).NonEmployeeSchemaAttributeBody(nonEmployeeSchemaAttributeBody).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).NonEmployeeSchemaAttributeBody(nonEmployeeSchemaAttributeBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeSourceSchemaAttributes`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes`: %v\n", resp) + } +- path: /non-employee-records/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-Employee record id (UUID) # string | Non-Employee record id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord(context.Background(), id).Execute() + //r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-records/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + deletenonemployeerecordsinbulkrequest := []byte(``) // DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. + + + var deleteNonEmployeeRecordsInBulkRequest v2024.DeleteNonEmployeeRecordsInBulkRequest + if err := json.Unmarshal(deletenonemployeerecordsinbulkrequest, &deleteNonEmployeeRecordsInBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk(context.Background()).DeleteNonEmployeeRecordsInBulkRequest(deleteNonEmployeeRecordsInBulkRequest).Execute() + //r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk(context.Background()).DeleteNonEmployeeRecordsInBulkRequest(deleteNonEmployeeRecordsInBulkRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-requests/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ac110005-7156-1150-8171-5b292e3e0084` // string | Non-Employee request id in the UUID format # string | Non-Employee request id in the UUID format + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest(context.Background(), id).Execute() + //r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + //r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-sources/{sourceId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id # string | Source Id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource(context.Background(), sourceId).Execute() + //r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + //r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-sources/{id}/non-employees/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id (UUID) # string | Source Id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ExportNonEmployeeRecords(context.Background(), id).Execute() + //r, err := apiClient.V2024.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) + } + } +- path: /non-employee-sources/{id}/schema-attributes-template/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source Id (UUID) # string | Source Id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ExportNonEmployeeSourceSchemaTemplate(context.Background(), id).Execute() + //r, err := apiClient.V2024.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) + } + } +- path: /non-employee-approvals/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + includeDetail := true // bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval(context.Background(), id).IncludeDetail(includeDetail).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeApproval`: NonEmployeeApprovalItemDetail + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval`: %v\n", resp) + } +- path: /non-employee-approvals/summary/{requested-for} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary(context.Background(), requestedFor).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary(context.Background(), requestedFor).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeApprovalSummary`: NonEmployeeApprovalSummary + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary`: %v\n", resp) + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Source ID (UUID) # string | Source ID (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeBulkUploadStatus`: NonEmployeeBulkUploadStatus + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus`: %v\n", resp) + } +- path: /non-employee-records/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-Employee record id (UUID) # string | Non-Employee record id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord`: %v\n", resp) + } +- path: /non-employee-requests/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ac110005-7156-1150-8171-5b292e3e0084` // string | Non-Employee request id (UUID) # string | Non-Employee request id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRequest`: NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest`: %v\n", resp) + } +- path: /non-employee-requests/summary/{requested-for} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary(context.Background(), requestedFor).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary(context.Background(), requestedFor).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRequestSummary`: NonEmployeeRequestSummary + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeSchemaAttribute`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c91808b7c28b350017c2a2ec5790aa1` // string | Source Id # string | Source Id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeSource`: NonEmployeeSource + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).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) + } + // response from `GetNonEmployeeSourceSchemaAttributes`: []NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes`: %v\n", resp) + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id (UUID) # string | Source Id (UUID) + data := BINARY_DATA_HERE // *os.File | # *os.File | + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk(context.Background(), id).Data(data).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk(context.Background(), id).Data(data).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportNonEmployeeRecordsInBulk`: NonEmployeeBulkUploadJob + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk`: %v\n", resp) + } +- path: /non-employee-approvals + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#list-non-employee-approvals + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity for whom the request was made. *me* indicates the current user. (optional) # string | The identity for whom the request was made. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `approvalStatus eq "Pending"` // 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: **approvalStatus**: *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: **approvalStatus**: *eq* (optional) + sorters := `created` // 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: **created, modified** (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: **created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals(context.Background()).RequestedFor(requestedFor).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeApprovals`: []NonEmployeeApprovalItem + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals`: %v\n", resp) + } +- path: /non-employee-records + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#list-non-employee-records + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `accountName,sourceId` // 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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + filters := `sourceId eq "2c91808568c529c60168cca6f90c1313"` // 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: **sourceId**: *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: **sourceId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords(context.Background()).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords(context.Background()).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeRecords`: []NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords`: %v\n", resp) + } +- path: /non-employee-requests + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `e136567de87e4d029e60b3c3c55db56d` // string | The identity for whom the request was made. *me* indicates the current user. # string | The identity for whom the request was made. *me* indicates the current user. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `created,approvalStatus` // 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + filters := `sourceId eq "2c91808568c529c60168cca6f90c1313"` // 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: **sourceId**: *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: **sourceId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests(context.Background()).RequestedFor(requestedFor).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests(context.Background()).RequestedFor(requestedFor).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeRequests`: []NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests`: %v\n", resp) + } +- path: /non-employee-sources + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#list-non-employee-sources + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + requestedFor := `me` // string | Identity the request was made for. Use 'me' to indicate the current user. (optional) # string | Identity the request was made for. Use 'me' to indicate the current user. (optional) + nonEmployeeCount := true // bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) + sorters := `name,created` // 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, created, sourceId** (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, created, sourceId** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources(context.Background()).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources(context.Background()).Limit(limit).Offset(offset).Count(count).RequestedFor(requestedFor).NonEmployeeCount(nonEmployeeCount).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeSources`: []NonEmployeeSourceWithNECount + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources`: %v\n", resp) + } +- path: /non-employee-records/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-employee record id (UUID) # string | Non-employee record id (UUID) + jsonpatchoperation := []byte(`[{op=replace, path=/endDate, value=2019-08-23T18:40:35.772Z}]`) // []JsonPatchOperation | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + jsonpatchoperation := []byte(`[{op=replace, path=/label, value={new attribute label=null}}]`) // []JsonPatchOperation | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeSchemaAttribute`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id # string | Source Id + jsonpatchoperation := []byte(`[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}]`) // []JsonPatchOperation | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource(context.Background(), sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource(context.Background(), sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeSource`: NonEmployeeSource + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource`: %v\n", resp) + } +- path: /non-employee-approvals/{id}/reject + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + nonemployeerejectapprovaldecision := []byte(`{ + "comment" : "approved" + }`) // NonEmployeeRejectApprovalDecision | + + + var nonEmployeeRejectApprovalDecision v2024.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.V2024.NonEmployeeLifecycleManagementAPI.RejectNonEmployeeRequest(context.Background(), id).NonEmployeeRejectApprovalDecision(nonEmployeeRejectApprovalDecision).Execute() + //resp, r, err := apiClient.V2024.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) + } +- path: /non-employee-records/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-employee record id (UUID) # string | Non-employee record id (UUID) + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + + var nonEmployeeRequestBody v2024.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord(context.Background(), id).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V2024.NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord(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, "Full HTTP response: %v\n", r) + } + // response from `UpdateNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord`: %v\n", resp) + } +- path: /verified-domains + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/notifications#create-domain-dkim + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + domainaddress := []byte(`{ + "domain" : "sailpoint.com" + }`) // DomainAddress | + + + var domainAddress v2024.DomainAddress + if err := json.Unmarshal(domainaddress, &domainAddress); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.CreateDomainDkim(context.Background()).XSailPointExperimental(xSailPointExperimental).DomainAddress(domainAddress).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.CreateDomainDkim(context.Background()).XSailPointExperimental(xSailPointExperimental).DomainAddress(domainAddress).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateDomainDkim``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDomainDkim`: DomainStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateDomainDkim`: %v\n", resp) + } +- path: /notification-templates + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/notifications#create-notification-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + templatedto := []byte(`{ + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" + }`) // TemplateDto | + + + var templateDto v2024.TemplateDto + if err := json.Unmarshal(templatedto, &templateDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.CreateNotificationTemplate(context.Background()).XSailPointExperimental(xSailPointExperimental).TemplateDto(templateDto).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.CreateNotificationTemplate(context.Background()).XSailPointExperimental(xSailPointExperimental).TemplateDto(templateDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateNotificationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNotificationTemplate`: TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateNotificationTemplate`: %v\n", resp) + } +- path: /verified-from-addresses + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/notifications#create-verified-from-address + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + emailstatusdto := []byte(`{ + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + }`) // EmailStatusDto | + + + var emailStatusDto v2024.EmailStatusDto + if err := json.Unmarshal(emailstatusdto, &emailStatusDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.CreateVerifiedFromAddress(context.Background()).XSailPointExperimental(xSailPointExperimental).EmailStatusDto(emailStatusDto).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.CreateVerifiedFromAddress(context.Background()).XSailPointExperimental(xSailPointExperimental).EmailStatusDto(emailStatusDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateVerifiedFromAddress``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateVerifiedFromAddress`: EmailStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateVerifiedFromAddress`: %v\n", resp) + } +- path: /notification-templates/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/notifications#delete-notification-templates-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + templatebulkdeletedto := []byte(``) // []TemplateBulkDeleteDto | + + + var templateBulkDeleteDto v2024.[]TemplateBulkDeleteDto + if err := json.Unmarshal(templatebulkdeletedto, &templateBulkDeleteDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NotificationsAPI.DeleteNotificationTemplatesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).TemplateBulkDeleteDto(templateBulkDeleteDto).Execute() + //r, err := apiClient.V2024.NotificationsAPI.DeleteNotificationTemplatesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).TemplateBulkDeleteDto(templateBulkDeleteDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.DeleteNotificationTemplatesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /verified-from-addresses/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/notifications#delete-verified-from-address + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `id_example` // string | # string | + 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.NotificationsAPI.DeleteVerifiedFromAddress(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.NotificationsAPI.DeleteVerifiedFromAddress(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.DeleteVerifiedFromAddress``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /verified-domains + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/notifications#get-dkim-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.GetDkimAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.GetDkimAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetDkimAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDkimAttributes`: []DkimAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetDkimAttributes`: %v\n", resp) + } +- path: /mail-from-attributes/{identity} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/notifications#get-mail-from-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `bobsmith@sailpoint.com` // string | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # string | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + 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.NotificationsAPI.GetMailFromAttributes(context.Background()).Id(id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.GetMailFromAttributes(context.Background()).Id(id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetMailFromAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMailFromAttributes`: MailFromAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetMailFromAttributes`: %v\n", resp) + } +- path: /notification-templates/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/notifications#get-notification-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Notification Template # string | Id of the Notification Template + 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.NotificationsAPI.GetNotificationTemplate(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.GetNotificationTemplate(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetNotificationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNotificationTemplate`: TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetNotificationTemplate`: %v\n", resp) + } +- path: /notification-template-context + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/notifications#get-notifications-template-context + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.GetNotificationsTemplateContext(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.GetNotificationsTemplateContext(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetNotificationsTemplateContext``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNotificationsTemplateContext`: NotificationTemplateContext + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetNotificationsTemplateContext`: %v\n", resp) + } +- path: /verified-from-addresses + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/notifications#list-from-addresses + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `email eq "john.doe@company.com"` // 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: **email**: *eq, ge, le, sw* (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: **email**: *eq, ge, le, sw* (optional) + sorters := `email` // 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: **email** (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: **email** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.ListFromAddresses(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.ListFromAddresses(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListFromAddresses``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListFromAddresses`: []EmailStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListFromAddresses`: %v\n", resp) + } +- path: /notification-preferences/{key} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/notifications#list-notification-preferences + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.ListNotificationPreferences(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.ListNotificationPreferences(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationPreferences``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationPreferences`: PreferencesDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationPreferences`: %v\n", resp) + } +- path: /notification-template-defaults + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/notifications#list-notification-template-defaults + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + filters := `key eq "cloud_manual_work_item_summary"` // 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.ListNotificationTemplateDefaults(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.ListNotificationTemplateDefaults(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationTemplateDefaults``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationTemplateDefaults`: []TemplateDtoDefault + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationTemplateDefaults`: %v\n", resp) + } +- path: /notification-templates + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/notifications#list-notification-templates + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + filters := `medium eq "EMAIL"` // 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.ListNotificationTemplates(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.ListNotificationTemplates(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationTemplates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationTemplates`: []TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationTemplates`: %v\n", resp) + } +- path: /mail-from-attributes + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/notifications#put-mail-from-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + mailfromattributesdto := []byte(`{ + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + }`) // MailFromAttributesDto | + + + var mailFromAttributesDto v2024.MailFromAttributesDto + if err := json.Unmarshal(mailfromattributesdto, &mailFromAttributesDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.NotificationsAPI.PutMailFromAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).MailFromAttributesDto(mailFromAttributesDto).Execute() + //resp, r, err := apiClient.V2024.NotificationsAPI.PutMailFromAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).MailFromAttributesDto(mailFromAttributesDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.PutMailFromAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutMailFromAttributes`: MailFromAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.PutMailFromAttributes`: %v\n", resp) + } +- path: /send-test-notification + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/notifications#send-test-notification + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + sendtestnotificationrequestdto := []byte(`{ + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + }`) // SendTestNotificationRequestDto | + + + var sendTestNotificationRequestDto v2024.SendTestNotificationRequestDto + if err := json.Unmarshal(sendtestnotificationrequestdto, &sendTestNotificationRequestDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.NotificationsAPI.SendTestNotification(context.Background()).XSailPointExperimental(xSailPointExperimental).SendTestNotificationRequestDto(sendTestNotificationRequestDto).Execute() + //r, err := apiClient.V2024.NotificationsAPI.SendTestNotification(context.Background()).XSailPointExperimental(xSailPointExperimental).SendTestNotificationRequestDto(sendTestNotificationRequestDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.SendTestNotification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /oauth-clients + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/o-auth-clients#create-oauth-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + createoauthclientrequest := []byte(`{ + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + }`) // CreateOAuthClientRequest | + + + var createOAuthClientRequest v2024.CreateOAuthClientRequest + if err := json.Unmarshal(createoauthclientrequest, &createOAuthClientRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.OAuthClientsAPI.CreateOauthClient(context.Background()).CreateOAuthClientRequest(createOAuthClientRequest).Execute() + //resp, r, err := apiClient.V2024.OAuthClientsAPI.CreateOauthClient(context.Background()).CreateOAuthClientRequest(createOAuthClientRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.CreateOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateOauthClient`: CreateOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.CreateOauthClient`: %v\n", resp) + } +- path: /oauth-clients/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/o-auth-clients#delete-oauth-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.OAuthClientsAPI.DeleteOauthClient(context.Background(), id).Execute() + //r, err := apiClient.V2024.OAuthClientsAPI.DeleteOauthClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.DeleteOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /oauth-clients/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/o-auth-clients#get-oauth-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.OAuthClientsAPI.GetOauthClient(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.OAuthClientsAPI.GetOauthClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.GetOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOauthClient`: GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.GetOauthClient`: %v\n", resp) + } +- path: /oauth-clients + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/o-auth-clients#list-oauth-clients + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filters := `lastUsed le 2023-02-05T10:59:27.214Z` // 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.OAuthClientsAPI.ListOauthClients(context.Background()).Execute() + //resp, r, err := apiClient.V2024.OAuthClientsAPI.ListOauthClients(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.ListOauthClients``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOauthClients`: []GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.ListOauthClients`: %v\n", resp) + } +- path: /oauth-clients/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/o-auth-clients#patch-oauth-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + jsonpatchoperation := []byte(`[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}]`) // []JsonPatchOperation | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.OAuthClientsAPI.PatchOauthClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.OAuthClientsAPI.PatchOauthClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.PatchOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchOauthClient`: GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.PatchOauthClient`: %v\n", resp) + } +- path: /org-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/org-config#get-org-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.OrgConfigAPI.GetOrgConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.OrgConfigAPI.GetOrgConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.GetOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOrgConfig`: OrgConfig + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.GetOrgConfig`: %v\n", resp) + } +- path: /org-config/valid-time-zones + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/org-config#get-valid-time-zones + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.OrgConfigAPI.GetValidTimeZones(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.OrgConfigAPI.GetValidTimeZones(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.GetValidTimeZones``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetValidTimeZones`: []string + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.GetValidTimeZones`: %v\n", resp) + } +- path: /org-config + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/org-config#patch-org-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/timeZone, value=America/Toronto}]`) // []JsonPatchOperation | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.OrgConfigAPI.PatchOrgConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.OrgConfigAPI.PatchOrgConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.PatchOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchOrgConfig`: OrgConfig + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.PatchOrgConfig`: %v\n", resp) + } +- path: /password-org-config + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-configuration#create-password-org-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordorgconfig := []byte(`{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }`) // PasswordOrgConfig | + + + var passwordOrgConfig v2024.PasswordOrgConfig + if err := json.Unmarshal(passwordorgconfig, &passwordOrgConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordConfigurationAPI.CreatePasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + //resp, r, err := apiClient.V2024.PasswordConfigurationAPI.CreatePasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.CreatePasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.CreatePasswordOrgConfig`: %v\n", resp) + } +- path: /password-org-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-configuration#get-password-org-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordConfigurationAPI.GetPasswordOrgConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.PasswordConfigurationAPI.GetPasswordOrgConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.GetPasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.GetPasswordOrgConfig`: %v\n", resp) + } +- path: /password-org-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-configuration#put-password-org-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordorgconfig := []byte(`{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }`) // PasswordOrgConfig | + + + var passwordOrgConfig v2024.PasswordOrgConfig + if err := json.Unmarshal(passwordorgconfig, &passwordOrgConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordConfigurationAPI.PutPasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + //resp, r, err := apiClient.V2024.PasswordConfigurationAPI.PutPasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.PutPasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutPasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.PutPasswordOrgConfig`: %v\n", resp) + } +- path: /password-dictionary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-dictionary#get-password-dictionary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordDictionaryAPI.GetPasswordDictionary(context.Background()).Execute() + //resp, r, err := apiClient.V2024.PasswordDictionaryAPI.GetPasswordDictionary(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordDictionaryAPI.GetPasswordDictionary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordDictionary`: string + fmt.Fprintf(os.Stdout, "Response from `PasswordDictionaryAPI.GetPasswordDictionary`: %v\n", resp) + } +- path: /password-dictionary + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-dictionary#put-password-dictionary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.PasswordDictionaryAPI.PutPasswordDictionary(context.Background()).Execute() + //r, err := apiClient.V2024.PasswordDictionaryAPI.PutPasswordDictionary(context.Background()).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordDictionaryAPI.PutPasswordDictionary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /generate-password-reset-token/digit + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-management#create-digit-token + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + passworddigittokenreset := []byte(`{ + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + }`) // PasswordDigitTokenReset | + + + var passwordDigitTokenReset v2024.PasswordDigitTokenReset + if err := json.Unmarshal(passworddigittokenreset, &passwordDigitTokenReset); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordManagementAPI.CreateDigitToken(context.Background()).XSailPointExperimental(xSailPointExperimental).PasswordDigitTokenReset(passwordDigitTokenReset).Execute() + //resp, r, err := apiClient.V2024.PasswordManagementAPI.CreateDigitToken(context.Background()).XSailPointExperimental(xSailPointExperimental).PasswordDigitTokenReset(passwordDigitTokenReset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.CreateDigitToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDigitToken`: PasswordDigitToken + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.CreateDigitToken`: %v\n", resp) + } +- path: /password-change-status/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-management#get-password-change-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `089899f13a8f4da7824996191587bab9` // string | Password change request ID # string | Password change request ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordManagementAPI.GetPasswordChangeStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.PasswordManagementAPI.GetPasswordChangeStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.GetPasswordChangeStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordChangeStatus`: PasswordStatus + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.GetPasswordChangeStatus`: %v\n", resp) + } +- path: /query-password-info + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-management#query-password-info + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordinfoquerydto := []byte(`{ + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + }`) // PasswordInfoQueryDTO | + + + var passwordInfoQueryDTO v2024.PasswordInfoQueryDTO + if err := json.Unmarshal(passwordinfoquerydto, &passwordInfoQueryDTO); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordManagementAPI.QueryPasswordInfo(context.Background()).PasswordInfoQueryDTO(passwordInfoQueryDTO).Execute() + //resp, r, err := apiClient.V2024.PasswordManagementAPI.QueryPasswordInfo(context.Background()).PasswordInfoQueryDTO(passwordInfoQueryDTO).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.QueryPasswordInfo``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `QueryPasswordInfo`: PasswordInfo + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.QueryPasswordInfo`: %v\n", resp) + } +- path: /set-password + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-management#set-password + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordchangerequest := []byte(`{ + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + }`) // PasswordChangeRequest | + + + var passwordChangeRequest v2024.PasswordChangeRequest + if err := json.Unmarshal(passwordchangerequest, &passwordChangeRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordManagementAPI.SetPassword(context.Background()).PasswordChangeRequest(passwordChangeRequest).Execute() + //resp, r, err := apiClient.V2024.PasswordManagementAPI.SetPassword(context.Background()).PasswordChangeRequest(passwordChangeRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.SetPassword``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetPassword`: PasswordChangeResponse + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.SetPassword`: %v\n", resp) + } +- path: /password-policies + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-policies#create-password-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordpolicyv3dto := []byte(`{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : 1939056206564, + "validateAgainstAccountId" : false, + "dateCreated" : 1639056206564, + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }`) // PasswordPolicyV3Dto | + + + var passwordPolicyV3Dto v2024.PasswordPolicyV3Dto + if err := json.Unmarshal(passwordpolicyv3dto, &passwordPolicyV3Dto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordPoliciesAPI.CreatePasswordPolicy(context.Background()).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + //resp, r, err := apiClient.V2024.PasswordPoliciesAPI.CreatePasswordPolicy(context.Background()).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.CreatePasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordPolicy`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.CreatePasswordPolicy`: %v\n", resp) + } +- path: /password-policies/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-policies#delete-password-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ff808081838d9e9d01838da6a03e0002` // string | The ID of password policy to delete. # string | The ID of password policy to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.PasswordPoliciesAPI.DeletePasswordPolicy(context.Background(), id).Execute() + //r, err := apiClient.V2024.PasswordPoliciesAPI.DeletePasswordPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.DeletePasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /password-policies/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-policies#get-password-policy-by-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ff808081838d9e9d01838da6a03e0005` // string | The ID of password policy to retrieve. # string | The ID of password policy to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordPoliciesAPI.GetPasswordPolicyById(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.PasswordPoliciesAPI.GetPasswordPolicyById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.GetPasswordPolicyById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordPolicyById`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.GetPasswordPolicyById`: %v\n", resp) + } +- path: /password-policies + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-policies#list-password-policies + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordPoliciesAPI.ListPasswordPolicies(context.Background()).Execute() + //resp, r, err := apiClient.V2024.PasswordPoliciesAPI.ListPasswordPolicies(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.ListPasswordPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPasswordPolicies`: []PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.ListPasswordPolicies`: %v\n", resp) + } +- path: /password-policies/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-policies#set-password-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ff808081838d9e9d01838da6a03e0007` // string | The ID of password policy to update. # string | The ID of password policy to update. + passwordpolicyv3dto := []byte(`{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : 1939056206564, + "validateAgainstAccountId" : false, + "dateCreated" : 1639056206564, + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }`) // PasswordPolicyV3Dto | + + + var passwordPolicyV3Dto v2024.PasswordPolicyV3Dto + if err := json.Unmarshal(passwordpolicyv3dto, &passwordPolicyV3Dto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordPoliciesAPI.SetPasswordPolicy(context.Background(), id).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + //resp, r, err := apiClient.V2024.PasswordPoliciesAPI.SetPasswordPolicy(context.Background(), id).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.SetPasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetPasswordPolicy`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.SetPasswordPolicy`: %v\n", resp) + } +- path: /password-sync-groups + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-sync-groups#create-password-sync-group + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordsyncgroup := []byte(`{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }`) // PasswordSyncGroup | + + + var passwordSyncGroup v2024.PasswordSyncGroup + if err := json.Unmarshal(passwordsyncgroup, &passwordSyncGroup); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordSyncGroupsAPI.CreatePasswordSyncGroup(context.Background()).PasswordSyncGroup(passwordSyncGroup).Execute() + //resp, r, err := apiClient.V2024.PasswordSyncGroupsAPI.CreatePasswordSyncGroup(context.Background()).PasswordSyncGroup(passwordSyncGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.CreatePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.CreatePasswordSyncGroup`: %v\n", resp) + } +- path: /password-sync-groups/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-sync-groups#delete-password-sync-group + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to delete. # string | The ID of password sync group to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.PasswordSyncGroupsAPI.DeletePasswordSyncGroup(context.Background(), id).Execute() + //r, err := apiClient.V2024.PasswordSyncGroupsAPI.DeletePasswordSyncGroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.DeletePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /password-sync-groups/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-sync-groups#get-password-sync-group + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to retrieve. # string | The ID of password sync group to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordSyncGroupsAPI.GetPasswordSyncGroup(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.PasswordSyncGroupsAPI.GetPasswordSyncGroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.GetPasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.GetPasswordSyncGroup`: %v\n", resp) + } +- path: /password-sync-groups + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-sync-groups#get-password-sync-groups + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordSyncGroupsAPI.GetPasswordSyncGroups(context.Background()).Execute() + //resp, r, err := apiClient.V2024.PasswordSyncGroupsAPI.GetPasswordSyncGroups(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.GetPasswordSyncGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordSyncGroups`: []PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.GetPasswordSyncGroups`: %v\n", resp) + } +- path: /password-sync-groups/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/password-sync-groups#update-password-sync-group + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to update. # string | The ID of password sync group to update. + passwordsyncgroup := []byte(`{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }`) // PasswordSyncGroup | + + + var passwordSyncGroup v2024.PasswordSyncGroup + if err := json.Unmarshal(passwordsyncgroup, &passwordSyncGroup); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PasswordSyncGroupsAPI.UpdatePasswordSyncGroup(context.Background(), id).PasswordSyncGroup(passwordSyncGroup).Execute() + //resp, r, err := apiClient.V2024.PasswordSyncGroupsAPI.UpdatePasswordSyncGroup(context.Background(), id).PasswordSyncGroup(passwordSyncGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.UpdatePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.UpdatePasswordSyncGroup`: %v\n", resp) + } +- path: /personal-access-tokens + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/personal-access-tokens#create-personal-access-token + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + createpersonalaccesstokenrequest := []byte(`{ + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + }`) // CreatePersonalAccessTokenRequest | Name and scope of personal access token. + + + var createPersonalAccessTokenRequest v2024.CreatePersonalAccessTokenRequest + if err := json.Unmarshal(createpersonalaccesstokenrequest, &createPersonalAccessTokenRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PersonalAccessTokensAPI.CreatePersonalAccessToken(context.Background()).CreatePersonalAccessTokenRequest(createPersonalAccessTokenRequest).Execute() + //resp, r, err := apiClient.V2024.PersonalAccessTokensAPI.CreatePersonalAccessToken(context.Background()).CreatePersonalAccessTokenRequest(createPersonalAccessTokenRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.CreatePersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePersonalAccessToken`: CreatePersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.CreatePersonalAccessToken`: %v\n", resp) + } +- path: /personal-access-tokens/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/personal-access-tokens#delete-personal-access-token + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The personal access token id # string | The personal access token id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.PersonalAccessTokensAPI.DeletePersonalAccessToken(context.Background(), id).Execute() + //r, err := apiClient.V2024.PersonalAccessTokensAPI.DeletePersonalAccessToken(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.DeletePersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /personal-access-tokens + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/personal-access-tokens#list-personal-access-tokens + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `2c9180867b50d088017b554662fb281e` // string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) # string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + filters := `lastUsed le 2023-02-05T10:59:27.214Z` // 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PersonalAccessTokensAPI.ListPersonalAccessTokens(context.Background()).Execute() + //resp, r, err := apiClient.V2024.PersonalAccessTokensAPI.ListPersonalAccessTokens(context.Background()).OwnerId(ownerId).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.ListPersonalAccessTokens``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPersonalAccessTokens`: []GetPersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.ListPersonalAccessTokens`: %v\n", resp) + } +- path: /personal-access-tokens/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/personal-access-tokens#patch-personal-access-token + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The Personal Access Token id # string | The Personal Access Token id + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}]`) // []JsonPatchOperation | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PersonalAccessTokensAPI.PatchPersonalAccessToken(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.PersonalAccessTokensAPI.PatchPersonalAccessToken(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.PatchPersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPersonalAccessToken`: GetPersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.PatchPersonalAccessToken`: %v\n", resp) + } +- path: /public-identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/public-identities#get-public-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `firstname eq "John"` // 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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) + addCoreFilters := false // bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to false) # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to false) + sorters := `name` // 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** (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** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PublicIdentitiesAPI.GetPublicIdentities(context.Background()).Execute() + //resp, r, err := apiClient.V2024.PublicIdentitiesAPI.GetPublicIdentities(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).AddCoreFilters(addCoreFilters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesAPI.GetPublicIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPublicIdentities`: []PublicIdentity + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesAPI.GetPublicIdentities`: %v\n", resp) + } +- path: /public-identities-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/public-identities-config#get-public-identity-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PublicIdentitiesConfigAPI.GetPublicIdentityConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2024.PublicIdentitiesConfigAPI.GetPublicIdentityConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesConfigAPI.GetPublicIdentityConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPublicIdentityConfig`: PublicIdentityConfig + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesConfigAPI.GetPublicIdentityConfig`: %v\n", resp) + } +- path: /public-identities-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/public-identities-config#update-public-identity-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + publicidentityconfig := []byte(`{ + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }`) // PublicIdentityConfig | + + + var publicIdentityConfig v2024.PublicIdentityConfig + if err := json.Unmarshal(publicidentityconfig, &publicIdentityConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig(context.Background()).PublicIdentityConfig(publicIdentityConfig).Execute() + //resp, r, err := apiClient.V2024.PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig(context.Background()).PublicIdentityConfig(publicIdentityConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePublicIdentityConfig`: PublicIdentityConfig + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig`: %v\n", resp) + } +- path: /reports/{id}/cancel + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/reports-data-extraction#cancel-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `a1ed223247144cc29d23c632624b4767` // string | ID of the running Report to cancel # string | ID of the running Report to cancel + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ReportsDataExtractionAPI.CancelReport(context.Background(), id).Execute() + //r, err := apiClient.V2024.ReportsDataExtractionAPI.CancelReport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.CancelReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /reports/{taskResultId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/reports-data-extraction#get-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + taskResultId := `ef38f94347e94562b5bb8424a56397d8` // string | Unique identifier of the task result which handled report # string | Unique identifier of the task result which handled report + fileFormat := `csv` // string | Output format of the requested report file # string | Output format of the requested report file + name := `Identities Details Report` // string | preferred Report file name, by default will be used report name from task result. (optional) # string | preferred Report file name, by default will be used report name from task result. (optional) + auditable := true // bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to false) # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ReportsDataExtractionAPI.GetReport(context.Background(), taskResultId).FileFormat(fileFormat).Execute() + //resp, r, err := apiClient.V2024.ReportsDataExtractionAPI.GetReport(context.Background(), taskResultId).FileFormat(fileFormat).Name(name).Auditable(auditable).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.GetReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.GetReport`: %v\n", resp) + } +- path: /reports/{taskResultId}/result + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/reports-data-extraction#get-report-result + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + taskResultId := `ef38f94347e94562b5bb8424a56397d8` // string | Unique identifier of the task result which handled report # string | Unique identifier of the task result which handled report + completed := true // bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to false) # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ReportsDataExtractionAPI.GetReportResult(context.Background(), taskResultId).Execute() + //resp, r, err := apiClient.V2024.ReportsDataExtractionAPI.GetReportResult(context.Background(), taskResultId).Completed(completed).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.GetReportResult``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReportResult`: ReportResults + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.GetReportResult`: %v\n", resp) + } +- path: /reports/run + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/reports-data-extraction#start-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reportdetails := []byte(`{ + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + }`) // ReportDetails | + + + var reportDetails v2024.ReportDetails + if err := json.Unmarshal(reportdetails, &reportDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ReportsDataExtractionAPI.StartReport(context.Background()).ReportDetails(reportDetails).Execute() + //resp, r, err := apiClient.V2024.ReportsDataExtractionAPI.StartReport(context.Background()).ReportDetails(reportDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.StartReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartReport`: TaskResultDetails + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.StartReport`: %v\n", resp) + } +- path: /requestable-objects + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/requestable-objects#list-requestable-objects + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw "bob"` // 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, in, sw* (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, in, sw* (optional) + sorters := `name` // 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** (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** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RequestableObjectsAPI.ListRequestableObjects(context.Background()).Execute() + //resp, r, err := apiClient.V2024.RequestableObjectsAPI.ListRequestableObjects(context.Background()).IdentityId(identityId).Types(types).Term(term).Statuses(statuses).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RequestableObjectsAPI.ListRequestableObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListRequestableObjects`: []RequestableObject + fmt.Fprintf(os.Stdout, "Response from `RequestableObjectsAPI.ListRequestableObjects`: %v\n", resp) + } +- path: /role-insights/requests + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/role-insights#create-role-insight-requests + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RoleInsightsAPI.CreateRoleInsightRequests(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.CreateRoleInsightRequests(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.CreateRoleInsightRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRoleInsightRequests`: RoleInsightsResponse + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.CreateRoleInsightRequests`: %v\n", resp) + } +- path: /role-insights/{insightId}/entitlement-changes/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/role-insights#download-role-insights-entitlements-changes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight 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") + sorters := `identitiesWithAccess` // 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + filters := `name sw "r"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DownloadRoleInsightsEntitlementsChanges`: string + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges`: %v\n", resp) + } +- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/role-insights#get-entitlement-changes-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight id + entitlementId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The entitlement id # string | The entitlement 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") + hasEntitlement := true // bool | Identity has this entitlement or not (optional) (default to false) # bool | Identity has this entitlement or not (optional) (default to false) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name` // 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** (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** (optional) + filters := `name sw "Jan"` // 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: **name**: *sw* (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: **name**: *sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RoleInsightsAPI.GetEntitlementChangesIdentities(context.Background(), insightId, entitlementId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.GetEntitlementChangesIdentities(context.Background(), insightId, entitlementId).XSailPointExperimental(xSailPointExperimental).HasEntitlement(hasEntitlement).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetEntitlementChangesIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementChangesIdentities`: []RoleInsightsIdentities + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetEntitlementChangesIdentities`: %v\n", resp) + } +- path: /role-insights/{insightId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/role-insights#get-role-insight + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight 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.RoleInsightsAPI.GetRoleInsight(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsight(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsight``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsight`: RoleInsight + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsight`: %v\n", resp) + } +- path: /role-insights + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/role-insights#get-role-insights + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `numberOfUpdates` // 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + filters := `name sw "John"` // 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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsights(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsights(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsights``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsights`: []RoleInsight + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsights`: %v\n", resp) + } +- path: /role-insights/{insightId}/current-entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/role-insights#get-role-insights-current-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight 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") + filters := `name sw "r"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsightsCurrentEntitlements(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsightsCurrentEntitlements(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsCurrentEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsCurrentEntitlements`: []RoleInsightsEntitlement + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsCurrentEntitlements`: %v\n", resp) + } +- path: /role-insights/{insightId}/entitlement-changes + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/role-insights#get-role-insights-entitlements-changes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight 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") + sorters := `sorters_example` // 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: **identitiesWithAccess, name** (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: **identitiesWithAccess, name** (optional) + filters := `name sw "Admin"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsightsEntitlementsChanges(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsightsEntitlementsChanges(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsEntitlementsChanges``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsEntitlementsChanges`: []RoleInsightsEntitlementChanges + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsEntitlementsChanges`: %v\n", resp) + } +- path: /role-insights/requests/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/role-insights#get-role-insights-requests + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insights request id # string | The role insights request 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.RoleInsightsAPI.GetRoleInsightsRequests(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsightsRequests(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsRequests`: RoleInsightsResponse + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsRequests`: %v\n", resp) + } +- path: /role-insights/summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/role-insights#get-role-insights-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsightsSummary(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RoleInsightsAPI.GetRoleInsightsSummary(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsSummary`: RoleInsightsSummary + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsSummary`: %v\n", resp) + } +- path: /roles + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/roles#create-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + role := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + }`) // Role | + + + var role v2024.Role + if err := json.Unmarshal(role, &role); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.CreateRole(context.Background()).Role(role).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.CreateRole(context.Background()).Role(role).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.CreateRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.CreateRole`: %v\n", resp) + } +- path: /roles/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/roles#delete-bulk-roles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + rolebulkdeleterequest := []byte(`{ + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + }`) // RoleBulkDeleteRequest | + + + var roleBulkDeleteRequest v2024.RoleBulkDeleteRequest + if err := json.Unmarshal(rolebulkdeleterequest, &roleBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.DeleteBulkRoles(context.Background()).RoleBulkDeleteRequest(roleBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.DeleteBulkRoles(context.Background()).RoleBulkDeleteRequest(roleBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteBulkRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteBulkRoles`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.DeleteBulkRoles`: %v\n", resp) + } +- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/roles#delete-metadata-from-role-by-key-and-value + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | The role's id. # string | The role's id. + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.RolesAPI.DeleteMetadataFromRoleByKeyAndValue(context.Background(), id, attributeKey, attributeValue).Execute() + //r, err := apiClient.V2024.RolesAPI.DeleteMetadataFromRoleByKeyAndValue(context.Background(), id, attributeKey, attributeValue).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteMetadataFromRoleByKeyAndValue``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /roles/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/roles#delete-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role # string | ID of the Role + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.RolesAPI.DeleteRole(context.Background(), id).Execute() + //r, err := apiClient.V2024.RolesAPI.DeleteRole(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /roles/access-model-metadata/bulk-update + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/roles#get-bulk-update-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.GetBulkUpdateStatus(context.Background()).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.GetBulkUpdateStatus(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetBulkUpdateStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBulkUpdateStatus`: []RoleGetAllBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetBulkUpdateStatus`: %v\n", resp) + } +- path: /roles/access-model-metadata/bulk-update/id + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/roles#get-bulk-update-status-by-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c24359c389374d0fb8585698a2189e3d` // string | The Id of the bulk update task. # string | The Id of the bulk update task. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.GetBulkUpdateStatusById(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.GetBulkUpdateStatusById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetBulkUpdateStatusById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBulkUpdateStatusById`: RoleBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetBulkUpdateStatusById`: %v\n", resp) + } +- path: /roles/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/roles#get-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role # string | ID of the Role + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.GetRole(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.GetRole(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRole`: %v\n", resp) + } +- path: /roles/{id}/assigned-identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/roles#get-role-assigned-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role for which the assigned Identities are to be listed # string | ID of the Role for which the assigned Identities are to be listed + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw Joe` // 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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + sorters := `aliasName,name` // 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: **id, name, aliasName, email** (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: **id, name, aliasName, email** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.GetRoleAssignedIdentities(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.GetRoleAssignedIdentities(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRoleAssignedIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleAssignedIdentities`: []RoleIdentity + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRoleAssignedIdentities`: %v\n", resp) + } +- path: /roles/{id}/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/roles#get-role-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121919ecca` // string | Containing role's ID. # string | Containing role's 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") + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.GetRoleEntitlements(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.GetRoleEntitlements(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRoleEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRoleEntitlements`: %v\n", resp) + } +- path: /roles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/roles#list-roles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `requestable 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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.ListRoles(context.Background()).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.ListRoles(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.ListRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListRoles`: []Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.ListRoles`: %v\n", resp) + } +- path: /roles/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/roles#patch-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role to patch # string | ID of the Role to patch + jsonpatchoperation := []byte(`[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.PatchRole(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.PatchRole(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.PatchRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.PatchRole`: %v\n", resp) + } +- path: /roles/filter + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/roles#search-roles-by-filter + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit := 50 // 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 50) # 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 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) + rolelistfilterdto := []byte(`{ + "ammKeyValues" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "secret" ] + } ], + "filters" : "dimensional eq false" + }`) // RoleListFilterDTO | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.SearchRolesByFilter(context.Background()).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.SearchRolesByFilter(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).RoleListFilterDTO(roleListFilterDTO).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.SearchRolesByFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchRolesByFilter`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.SearchRolesByFilter`: %v\n", resp) + } +- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/roles#update-attribute-key-and-value-to-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c24359c389374d0fb8585698a2189e3d` // string | The Id of a role # string | The Id of a role + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.UpdateAttributeKeyAndValueToRole(context.Background(), id, attributeKey, attributeValue).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.UpdateAttributeKeyAndValueToRole(context.Background(), id, attributeKey, attributeValue).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.UpdateAttributeKeyAndValueToRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAttributeKeyAndValueToRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.UpdateAttributeKeyAndValueToRole`: %v\n", resp) + } +- path: /roles/access-model-metadata/bulk-update/filter + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/roles#update-roles-metadata-by-filter + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + rolemetadatabulkupdatebyfilterrequest := []byte(`{ + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "filters" : " requestable eq false", + "replaceScope" : "ALL", + "operation" : "REPLACE" + }`) // RoleMetadataBulkUpdateByFilterRequest | + + + var roleMetadataBulkUpdateByFilterRequest v2024.RoleMetadataBulkUpdateByFilterRequest + if err := json.Unmarshal(rolemetadatabulkupdatebyfilterrequest, &roleMetadataBulkUpdateByFilterRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.UpdateRolesMetadataByFilter(context.Background()).RoleMetadataBulkUpdateByFilterRequest(roleMetadataBulkUpdateByFilterRequest).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.UpdateRolesMetadataByFilter(context.Background()).RoleMetadataBulkUpdateByFilterRequest(roleMetadataBulkUpdateByFilterRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.UpdateRolesMetadataByFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRolesMetadataByFilter`: RoleBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.UpdateRolesMetadataByFilter`: %v\n", resp) + } +- path: /roles/access-model-metadata/bulk-update/ids + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/roles#update-roles-metadata-by-ids + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + rolemetadatabulkupdatebyidrequest := []byte(`{ + "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + }`) // RoleMetadataBulkUpdateByIdRequest | + + + var roleMetadataBulkUpdateByIdRequest v2024.RoleMetadataBulkUpdateByIdRequest + if err := json.Unmarshal(rolemetadatabulkupdatebyidrequest, &roleMetadataBulkUpdateByIdRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.UpdateRolesMetadataByIds(context.Background()).RoleMetadataBulkUpdateByIdRequest(roleMetadataBulkUpdateByIdRequest).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.UpdateRolesMetadataByIds(context.Background()).RoleMetadataBulkUpdateByIdRequest(roleMetadataBulkUpdateByIdRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.UpdateRolesMetadataByIds``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRolesMetadataByIds`: RoleBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.UpdateRolesMetadataByIds`: %v\n", resp) + } +- path: /roles/access-model-metadata/bulk-update/query + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/roles#update-roles-metadata-by-query + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + rolemetadatabulkupdatebyqueryrequest := []byte(`{ + "query" : { + "query\"" : { + "indices" : [ "roles" ], + "queryType" : "TEXT", + "textQuery" : { + "terms" : [ "test123" ], + "fields" : [ "id" ], + "matchAny" : false, + "contains" : true + }, + "includeNested" : false + } + }, + "values" : [ { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + }, { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + }`) // RoleMetadataBulkUpdateByQueryRequest | + + + var roleMetadataBulkUpdateByQueryRequest v2024.RoleMetadataBulkUpdateByQueryRequest + if err := json.Unmarshal(rolemetadatabulkupdatebyqueryrequest, &roleMetadataBulkUpdateByQueryRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.RolesAPI.UpdateRolesMetadataByQuery(context.Background()).RoleMetadataBulkUpdateByQueryRequest(roleMetadataBulkUpdateByQueryRequest).Execute() + //resp, r, err := apiClient.V2024.RolesAPI.UpdateRolesMetadataByQuery(context.Background()).RoleMetadataBulkUpdateByQueryRequest(roleMetadataBulkUpdateByQueryRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.UpdateRolesMetadataByQuery``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRolesMetadataByQuery`: RoleBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.UpdateRolesMetadataByQuery`: %v\n", resp) + } +- path: /saved-searches + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/saved-search#create-saved-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + createsavedsearchrequest := []byte(``) // CreateSavedSearchRequest | The saved search to persist. + + + var createSavedSearchRequest v2024.CreateSavedSearchRequest + if err := json.Unmarshal(createsavedsearchrequest, &createSavedSearchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SavedSearchAPI.CreateSavedSearch(context.Background()).CreateSavedSearchRequest(createSavedSearchRequest).Execute() + //resp, r, err := apiClient.V2024.SavedSearchAPI.CreateSavedSearch(context.Background()).CreateSavedSearchRequest(createSavedSearchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.CreateSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.CreateSavedSearch`: %v\n", resp) + } +- path: /saved-searches/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/saved-search#delete-saved-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SavedSearchAPI.DeleteSavedSearch(context.Background(), id).Execute() + //r, err := apiClient.V2024.SavedSearchAPI.DeleteSavedSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.DeleteSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /saved-searches/{id}/execute + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/saved-search#execute-saved-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + searcharguments := []byte(`{ + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + }`) // SearchArguments | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + + + var searchArguments v2024.SearchArguments + if err := json.Unmarshal(searcharguments, &searchArguments); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SavedSearchAPI.ExecuteSavedSearch(context.Background(), id).SearchArguments(searchArguments).Execute() + //r, err := apiClient.V2024.SavedSearchAPI.ExecuteSavedSearch(context.Background(), id).SearchArguments(searchArguments).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.ExecuteSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /saved-searches/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/saved-search#get-saved-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SavedSearchAPI.GetSavedSearch(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SavedSearchAPI.GetSavedSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.GetSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.GetSavedSearch`: %v\n", resp) + } +- path: /saved-searches + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/saved-search#list-saved-searches + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"` // 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: **owner.id**: *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: **owner.id**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SavedSearchAPI.ListSavedSearches(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SavedSearchAPI.ListSavedSearches(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.ListSavedSearches``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSavedSearches`: []SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.ListSavedSearches`: %v\n", resp) + } +- path: /saved-searches/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/saved-search#put-saved-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + savedsearch := []byte(`{ + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + }`) // SavedSearch | The saved search to persist. + + + var savedSearch v2024.SavedSearch + if err := json.Unmarshal(savedsearch, &savedSearch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SavedSearchAPI.PutSavedSearch(context.Background(), id).SavedSearch(savedSearch).Execute() + //resp, r, err := apiClient.V2024.SavedSearchAPI.PutSavedSearch(context.Background(), id).SavedSearch(savedSearch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.PutSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.PutSavedSearch`: %v\n", resp) + } +- path: /scheduled-searches + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/scheduled-search#create-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + createscheduledsearchrequest := []byte(`{savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]}`) // CreateScheduledSearchRequest | The scheduled search to persist. + + + var createScheduledSearchRequest v2024.CreateScheduledSearchRequest + if err := json.Unmarshal(createscheduledsearchrequest, &createScheduledSearchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ScheduledSearchAPI.CreateScheduledSearch(context.Background()).CreateScheduledSearchRequest(createScheduledSearchRequest).Execute() + //resp, r, err := apiClient.V2024.ScheduledSearchAPI.CreateScheduledSearch(context.Background()).CreateScheduledSearchRequest(createScheduledSearchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.CreateScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.CreateScheduledSearch`: %v\n", resp) + } +- path: /scheduled-searches/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/scheduled-search#delete-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ScheduledSearchAPI.DeleteScheduledSearch(context.Background(), id).Execute() + //r, err := apiClient.V2024.ScheduledSearchAPI.DeleteScheduledSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.DeleteScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /scheduled-searches/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/scheduled-search#get-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ScheduledSearchAPI.GetScheduledSearch(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ScheduledSearchAPI.GetScheduledSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.GetScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.GetScheduledSearch`: %v\n", resp) + } +- path: /scheduled-searches + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/scheduled-search#list-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"` // 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: **owner.id**: *eq* **savedSearchId**: *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: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ScheduledSearchAPI.ListScheduledSearch(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ScheduledSearchAPI.ListScheduledSearch(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.ListScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListScheduledSearch`: []ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.ListScheduledSearch`: %v\n", resp) + } +- path: /scheduled-searches/{id}/unsubscribe + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/scheduled-search#unsubscribe-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + typedreference := []byte(`{ + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }`) // TypedReference | The recipient to be removed from the scheduled search. + + + var typedReference v2024.TypedReference + if err := json.Unmarshal(typedreference, &typedReference); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ScheduledSearchAPI.UnsubscribeScheduledSearch(context.Background(), id).TypedReference(typedReference).Execute() + //r, err := apiClient.V2024.ScheduledSearchAPI.UnsubscribeScheduledSearch(context.Background(), id).TypedReference(typedReference).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.UnsubscribeScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /scheduled-searches/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/scheduled-search#update-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + scheduledsearch := []byte(`{ + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false + }`) // ScheduledSearch | The scheduled search to persist. + + + var scheduledSearch v2024.ScheduledSearch + if err := json.Unmarshal(scheduledsearch, &scheduledSearch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ScheduledSearchAPI.UpdateScheduledSearch(context.Background(), id).ScheduledSearch(scheduledSearch).Execute() + //resp, r, err := apiClient.V2024.ScheduledSearchAPI.UpdateScheduledSearch(context.Background(), id).ScheduledSearch(scheduledSearch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.UpdateScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.UpdateScheduledSearch`: %v\n", resp) + } +- path: /search/aggregate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/search#search-aggregate + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + var search v2024.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SearchAPI.SearchAggregate(context.Background()).Search(search).Execute() + //resp, r, err := apiClient.V2024.SearchAPI.SearchAggregate(context.Background()).Search(search).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchAggregate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchAggregate`: AggregationResult + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchAggregate`: %v\n", resp) + } +- path: /search/count + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/search#search-count + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + + + var search v2024.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SearchAPI.SearchCount(context.Background()).Search(search).Execute() + //r, err := apiClient.V2024.SearchAPI.SearchCount(context.Background()).Search(search).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchCount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /search/{index}/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/search#search-get + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + index := `identities` // string | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. # string | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SearchAPI.SearchGet(context.Background(), index, id).Execute() + //resp, r, err := apiClient.V2024.SearchAPI.SearchGet(context.Background(), index, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchGet``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchGet`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchGet`: %v\n", resp) + } +- path: /search + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/search#search-post + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + 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) + limit := 10000 // 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + var search v2024.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SearchAPI.SearchPost(context.Background()).Search(search).Execute() + //resp, r, err := apiClient.V2024.SearchAPI.SearchPost(context.Background()).Search(search).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchPost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchPost`: []map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchPost`: %v\n", resp) + } +- path: /accounts/search-attribute-config + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/search-attribute-configuration#create-search-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + searchattributeconfig := []byte(`{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }`) // SearchAttributeConfig | + + + var searchAttributeConfig v2024.SearchAttributeConfig + if err := json.Unmarshal(searchattributeconfig, &searchAttributeConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SearchAttributeConfigurationAPI.CreateSearchAttributeConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).SearchAttributeConfig(searchAttributeConfig).Execute() + //resp, r, err := apiClient.V2024.SearchAttributeConfigurationAPI.CreateSearchAttributeConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).SearchAttributeConfig(searchAttributeConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.CreateSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSearchAttributeConfig`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.CreateSearchAttributeConfig`: %v\n", resp) + } +- path: /accounts/search-attribute-config/{name} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/search-attribute-configuration#delete-search-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `newMailAttribute` // string | Name of the extended search attribute configuration to delete. # string | Name of the extended search attribute configuration to delete. + 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.SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /accounts/search-attribute-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/search-attribute-configuration#get-search-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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.V2024.SearchAttributeConfigurationAPI.GetSearchAttributeConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.SearchAttributeConfigurationAPI.GetSearchAttributeConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.GetSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSearchAttributeConfig`: []SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.GetSearchAttributeConfig`: %v\n", resp) + } +- path: /accounts/search-attribute-config/{name} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `newMailAttribute` // string | Name of the extended search attribute configuration to get. # string | Name of the extended search attribute configuration to get. + 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.SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSingleSearchAttributeConfig`: SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig`: %v\n", resp) + } +- path: /accounts/search-attribute-config/{name} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/search-attribute-configuration#patch-search-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `promotedMailAttribute` // string | Name of the search attribute configuration to patch. # string | Name of the search attribute configuration to patch. + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SearchAttributeConfigurationAPI.PatchSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.SearchAttributeConfigurationAPI.PatchSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.PatchSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSearchAttributeConfig`: SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.PatchSearchAttributeConfig`: %v\n", resp) + } +- path: /segments + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/segments#create-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + segment := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }`) // Segment | + + + var segment v2024.Segment + if err := json.Unmarshal(segment, &segment); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SegmentsAPI.CreateSegment(context.Background()).Segment(segment).Execute() + //resp, r, err := apiClient.V2024.SegmentsAPI.CreateSegment(context.Background()).Segment(segment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.CreateSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.CreateSegment`: %v\n", resp) + } +- path: /segments/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/segments#delete-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to delete. # string | The segment ID to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SegmentsAPI.DeleteSegment(context.Background(), id).Execute() + //r, err := apiClient.V2024.SegmentsAPI.DeleteSegment(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.DeleteSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /segments/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/segments#get-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to retrieve. # string | The segment ID to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SegmentsAPI.GetSegment(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SegmentsAPI.GetSegment(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.GetSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.GetSegment`: %v\n", resp) + } +- path: /segments + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/segments#list-segments + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SegmentsAPI.ListSegments(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SegmentsAPI.ListSegments(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.ListSegments``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSegments`: []Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.ListSegments`: %v\n", resp) + } +- path: /segments/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/segments#patch-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to modify. # string | The segment ID to modify. + requestbody := []byte(`[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]`) // []map[string]interface{} | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + + + var requestBody v2024.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SegmentsAPI.PatchSegment(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2024.SegmentsAPI.PatchSegment(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.PatchSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.PatchSegment`: %v\n", resp) + } +- path: /service-desk-integrations + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/service-desk-integration#create-service-desk-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + servicedeskintegrationdto := []byte(`{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + }`) // ServiceDeskIntegrationDto | The specifics of a new integration to create + + + var serviceDeskIntegrationDto v2024.ServiceDeskIntegrationDto + if err := json.Unmarshal(servicedeskintegrationdto, &serviceDeskIntegrationDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.CreateServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.CreateServiceDeskIntegration`: %v\n", resp) + } +- path: /service-desk-integrations/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/service-desk-integration#delete-service-desk-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `anId` // string | ID of Service Desk integration to delete # string | ID of Service Desk integration to delete + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration(context.Background(), id).Execute() + //r, err := apiClient.V2024.ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /service-desk-integrations/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/service-desk-integration#get-service-desk-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `anId` // string | ID of the Service Desk integration to get # string | ID of the Service Desk integration to get + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetServiceDeskIntegration(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetServiceDeskIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegration`: %v\n", resp) + } +- path: /service-desk-integrations/templates/{scriptName} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/service-desk-integration#get-service-desk-integration-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the Service Desk integration template to get # string | The scriptName value of the Service Desk integration template to get + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationTemplate`: ServiceDeskIntegrationTemplateDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate`: %v\n", resp) + } +- path: /service-desk-integrations/types + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/service-desk-integration#get-service-desk-integration-types + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationTypes`: []ServiceDeskIntegrationTemplateType + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes`: %v\n", resp) + } +- path: /service-desk-integrations + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/service-desk-integration#get-service-desk-integrations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `name eq "John Doe"` // 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* **type**: *eq, in* **cluster**: *eq, in* (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* **type**: *eq, in* **cluster**: *eq, in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetServiceDeskIntegrations(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetServiceDeskIntegrations(context.Background()).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrations`: []ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrations`: %v\n", resp) + } +- path: /service-desk-integrations/status-check-configuration + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/service-desk-integration#get-status-check-details + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetStatusCheckDetails(context.Background()).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.GetStatusCheckDetails(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetStatusCheckDetails``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetStatusCheckDetails`: QueuedCheckConfigDetails + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetStatusCheckDetails`: %v\n", resp) + } +- path: /service-desk-integrations/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/service-desk-integration#patch-service-desk-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `anId` // string | ID of the Service Desk integration to update # string | ID of the Service Desk integration to update + jsonpatchoperation := []byte(``) // []JsonPatchOperation | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.PatchServiceDeskIntegration(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.PatchServiceDeskIntegration(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.PatchServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.PatchServiceDeskIntegration`: %v\n", resp) + } +- path: /service-desk-integrations/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/service-desk-integration#put-service-desk-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `anId` // string | ID of the Service Desk integration to update # string | ID of the Service Desk integration to update + servicedeskintegrationdto := []byte(`{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + }`) // ServiceDeskIntegrationDto | The specifics of the integration to update + + + var serviceDeskIntegrationDto v2024.ServiceDeskIntegrationDto + if err := json.Unmarshal(servicedeskintegrationdto, &serviceDeskIntegrationDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.PutServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.PutServiceDeskIntegration`: %v\n", resp) + } +- path: /service-desk-integrations/status-check-configuration + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/service-desk-integration#update-status-check-details + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + queuedcheckconfigdetails := []byte(`{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + }`) // QueuedCheckConfigDetails | The modified time check configuration + + + var queuedCheckConfigDetails v2024.QueuedCheckConfigDetails + if err := json.Unmarshal(queuedcheckconfigdetails, &queuedCheckConfigDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute() + //resp, r, err := apiClient.V2024.ServiceDeskIntegrationAPI.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.UpdateStatusCheckDetails``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateStatusCheckDetails`: QueuedCheckConfigDetails + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.UpdateStatusCheckDetails`: %v\n", resp) + } +- path: /sim-integrations + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sim-integrations#create-sim-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + simintegrationdetails := []byte(`{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }`) // SimIntegrationDetails | DTO containing the details of the SIM integration + + + var simIntegrationDetails v2024.SimIntegrationDetails + if err := json.Unmarshal(simintegrationdetails, &simIntegrationDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SIMIntegrationsAPI.CreateSIMIntegration(context.Background()).XSailPointExperimental(xSailPointExperimental).SimIntegrationDetails(simIntegrationDetails).Execute() + //resp, r, err := apiClient.V2024.SIMIntegrationsAPI.CreateSIMIntegration(context.Background()).XSailPointExperimental(xSailPointExperimental).SimIntegrationDetails(simIntegrationDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.CreateSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.CreateSIMIntegration`: %v\n", resp) + } +- path: /sim-integrations/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sim-integrations#delete-sim-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `12345` // string | The id of the integration to delete. # string | The id of the integration to delete. + 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.SIMIntegrationsAPI.DeleteSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.SIMIntegrationsAPI.DeleteSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.DeleteSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sim-integrations/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sim-integrations#get-sim-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `12345` // string | The id of the integration. # string | The id of the integration. + 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.SIMIntegrationsAPI.GetSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.SIMIntegrationsAPI.GetSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.GetSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.GetSIMIntegration`: %v\n", resp) + } +- path: /sim-integrations + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sim-integrations#get-sim-integrations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SIMIntegrationsAPI.GetSIMIntegrations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.SIMIntegrationsAPI.GetSIMIntegrations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.GetSIMIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSIMIntegrations`: []ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.GetSIMIntegrations`: %v\n", resp) + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sim-integrations#patch-before-provisioning-rule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `12345` // string | SIM integration id # string | SIM integration 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") + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + + + var jsonPatch v2024.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SIMIntegrationsAPI.PatchBeforeProvisioningRule(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2024.SIMIntegrationsAPI.PatchBeforeProvisioningRule(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PatchBeforeProvisioningRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchBeforeProvisioningRule`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PatchBeforeProvisioningRule`: %v\n", resp) + } +- path: /sim-integrations/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sim-integrations#patch-sim-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `12345` // string | SIM integration id # string | SIM integration 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") + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | The JsonPatch object that describes the changes of SIM + + + var jsonPatch v2024.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SIMIntegrationsAPI.PatchSIMAttributes(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2024.SIMIntegrationsAPI.PatchSIMAttributes(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PatchSIMAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSIMAttributes`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PatchSIMAttributes`: %v\n", resp) + } +- path: /sim-integrations/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sim-integrations#put-sim-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `12345` // string | The id of the integration. # string | The id of the integration. + 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") + simintegrationdetails := []byte(`{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }`) // SimIntegrationDetails | The full DTO of the integration containing the updated model + + + var simIntegrationDetails v2024.SimIntegrationDetails + if err := json.Unmarshal(simintegrationdetails, &simIntegrationDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SIMIntegrationsAPI.PutSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SimIntegrationDetails(simIntegrationDetails).Execute() + //resp, r, err := apiClient.V2024.SIMIntegrationsAPI.PutSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SimIntegrationDetails(simIntegrationDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PutSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PutSIMIntegration`: %v\n", resp) + } +- path: /sod-policies + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#create-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sodpolicy := []byte(`{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }`) // SodPolicy | + + + var sodPolicy v2024.SodPolicy + if err := json.Unmarshal(sodpolicy, &sodPolicy); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.CreateSodPolicy(context.Background()).SodPolicy(sodPolicy).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.CreateSodPolicy(context.Background()).SodPolicy(sodPolicy).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.CreateSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.CreateSodPolicy`: %v\n", resp) + } +- path: /sod-policies/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#delete-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD Policy to delete. # string | The ID of the SOD Policy to delete. + logical := true // bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to true) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SODPoliciesAPI.DeleteSodPolicy(context.Background(), id).Execute() + //r, err := apiClient.V2024.SODPoliciesAPI.DeleteSodPolicy(context.Background(), id).Logical(logical).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.DeleteSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sod-policies/{id}/schedule + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#delete-sod-policy-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy the schedule must be deleted for. # string | The ID of the SOD policy the schedule must be deleted for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SODPoliciesAPI.DeleteSodPolicySchedule(context.Background(), id).Execute() + //r, err := apiClient.V2024.SODPoliciesAPI.DeleteSodPolicySchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.DeleteSodPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#get-custom-violation-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reportResultId := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the report reference to download. # string | The ID of the report reference to download. + fileName := `custom-name` // string | Custom Name for the file. # string | Custom Name for the file. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.GetCustomViolationReport(context.Background(), reportResultId, fileName).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.GetCustomViolationReport(context.Background(), reportResultId, fileName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetCustomViolationReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCustomViolationReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetCustomViolationReport`: %v\n", resp) + } +- path: /sod-violation-report/{reportResultId}/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#get-default-violation-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reportResultId := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the report reference to download. # string | The ID of the report reference to download. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.GetDefaultViolationReport(context.Background(), reportResultId).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.GetDefaultViolationReport(context.Background(), reportResultId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetDefaultViolationReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDefaultViolationReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetDefaultViolationReport`: %v\n", resp) + } +- path: /sod-violation-report + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodAllReportRunStatus(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodAllReportRunStatus(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodAllReportRunStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodAllReportRunStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodAllReportRunStatus`: %v\n", resp) + } +- path: /sod-policies/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#get-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD Policy to retrieve. # string | The ID of the SOD Policy to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodPolicy`: %v\n", resp) + } +- path: /sod-policies/{id}/schedule + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#get-sod-policy-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy schedule to retrieve. # string | The ID of the SOD policy schedule to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodPolicySchedule(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodPolicySchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodPolicySchedule`: SodPolicySchedule + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodPolicySchedule`: %v\n", resp) + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#get-sod-violation-report-run-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reportResultId := `2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | The ID of the report reference to retrieve. # string | The ID of the report reference to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodViolationReportRunStatus(context.Background(), reportResultId).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodViolationReportRunStatus(context.Background(), reportResultId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodViolationReportRunStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodViolationReportRunStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodViolationReportRunStatus`: %v\n", resp) + } +- path: /sod-policies/{id}/violation-report + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#get-sod-violation-report-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the violation report to retrieve status for. # string | The ID of the violation report to retrieve status for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodViolationReportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.GetSodViolationReportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodViolationReportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodViolationReportStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodViolationReportStatus`: %v\n", resp) + } +- path: /sod-policies + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#list-sod-policies + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "bc693f07e7b645539626c25954c58554"` // 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, in* **state**: *eq, in* (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, in* **state**: *eq, in* (optional) + sorters := `id,name` // 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: **id, name, created, modified, description** (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: **id, name, created, modified, description** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.ListSodPolicies(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.ListSodPolicies(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.ListSodPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSodPolicies`: []SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.ListSodPolicies`: %v\n", resp) + } +- path: /sod-policies/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#patch-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c918083-5d19-1a86-015d-28455b4a2329` // string | The ID of the SOD policy being modified. # string | The ID of the SOD policy being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]`) // []JsonPatchOperation | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.PatchSodPolicy(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.PatchSodPolicy(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PatchSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PatchSodPolicy`: %v\n", resp) + } +- path: /sod-policies/{id}/schedule + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#put-policy-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy to update its schedule. # string | The ID of the SOD policy to update its schedule. + sodpolicyschedule := []byte(`{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }`) // SodPolicySchedule | + + + var sodPolicySchedule v2024.SodPolicySchedule + if err := json.Unmarshal(sodpolicyschedule, &sodPolicySchedule); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.PutPolicySchedule(context.Background(), id).SodPolicySchedule(sodPolicySchedule).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.PutPolicySchedule(context.Background(), id).SodPolicySchedule(sodPolicySchedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PutPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutPolicySchedule`: SodPolicySchedule + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PutPolicySchedule`: %v\n", resp) + } +- path: /sod-policies/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#put-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy to update. # string | The ID of the SOD policy to update. + sodpolicy := []byte(`{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }`) // SodPolicy | + + + var sodPolicy v2024.SodPolicy + if err := json.Unmarshal(sodpolicy, &sodPolicy); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.PutSodPolicy(context.Background(), id).SodPolicy(sodPolicy).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.PutSodPolicy(context.Background(), id).SodPolicy(sodPolicy).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PutSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PutSodPolicy`: %v\n", resp) + } +- path: /sod-policies/{id}/evaluate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#start-evaluate-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The SOD policy ID to run. # string | The SOD policy ID to run. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.StartEvaluateSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.StartEvaluateSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartEvaluateSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartEvaluateSodPolicy`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartEvaluateSodPolicy`: %v\n", resp) + } +- path: /sod-violation-report/run + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multipolicyrequest := []byte(`{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }`) // MultiPolicyRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.StartSodAllPoliciesForOrg(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.StartSodAllPoliciesForOrg(context.Background()).MultiPolicyRequest(multiPolicyRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartSodAllPoliciesForOrg``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartSodAllPoliciesForOrg`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartSodAllPoliciesForOrg`: %v\n", resp) + } +- path: /sod-policies/{id}/violation-report/run + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-policies#start-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The SOD policy ID to run. # string | The SOD policy ID to run. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODPoliciesAPI.StartSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SODPoliciesAPI.StartSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartSodPolicy`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartSodPolicy`: %v\n", resp) + } +- path: /sod-violations/predict + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-violations#start-predict-sod-violations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identitywithnewaccess := []byte(`{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }`) // IdentityWithNewAccess | + + + var identityWithNewAccess v2024.IdentityWithNewAccess + if err := json.Unmarshal(identitywithnewaccess, &identityWithNewAccess); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODViolationsAPI.StartPredictSodViolations(context.Background()).IdentityWithNewAccess(identityWithNewAccess).Execute() + //resp, r, err := apiClient.V2024.SODViolationsAPI.StartPredictSodViolations(context.Background()).IdentityWithNewAccess(identityWithNewAccess).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODViolationsAPI.StartPredictSodViolations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartPredictSodViolations`: ViolationPrediction + fmt.Fprintf(os.Stdout, "Response from `SODViolationsAPI.StartPredictSodViolations`: %v\n", resp) + } +- path: /sod-violations/check + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sod-violations#start-violation-check + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identitywithnewaccess1 := []byte(`{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}`) // IdentityWithNewAccess1 | + + + var identityWithNewAccess1 v2024.IdentityWithNewAccess1 + if err := json.Unmarshal(identitywithnewaccess1, &identityWithNewAccess1); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SODViolationsAPI.StartViolationCheck(context.Background()).IdentityWithNewAccess1(identityWithNewAccess1).Execute() + //resp, r, err := apiClient.V2024.SODViolationsAPI.StartViolationCheck(context.Background()).IdentityWithNewAccess1(identityWithNewAccess1).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODViolationsAPI.StartViolationCheck``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartViolationCheck`: SodViolationCheck + fmt.Fprintf(os.Stdout, "Response from `SODViolationsAPI.StartViolationCheck`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#create-provisioning-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id # string | The Source id + provisioningpolicydto := []byte(`{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }`) // ProvisioningPolicyDto | + + + var provisioningPolicyDto v2024.ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.CreateProvisioningPolicy(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.CreateProvisioningPolicy(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateProvisioningPolicy`: %v\n", resp) + } +- path: /sources + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#create-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + source := []byte(`{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }`) // Source | + provisionAsCsv := false // bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + + var source v2024.Source + if err := json.Unmarshal(source, &source); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.CreateSource(context.Background()).Source(source).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.CreateSource(context.Background()).Source(source).ProvisionAsCsv(provisionAsCsv).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSource`: %v\n", resp) + } +- path: /sources/{sourceId}/schedules + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#create-source-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + schedule1 := []byte(``) // Schedule1 | + + + var schedule1 v2024.Schedule1 + if err := json.Unmarshal(schedule1, &schedule1); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.CreateSourceSchedule(context.Background(), sourceId).Schedule1(schedule1).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.CreateSourceSchedule(context.Background(), sourceId).Schedule1(schedule1).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSourceSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceSchedule`: Schedule1 + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSourceSchedule`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#create-source-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + schema := []byte(`{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + }`) // Schema | + + + var schema v2024.Schema + if err := json.Unmarshal(schema, &schema); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.CreateSourceSchema(context.Background(), sourceId).Schema(schema).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.CreateSourceSchema(context.Background(), sourceId).Schema(schema).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSourceSchema`: %v\n", resp) + } +- path: /sources/{id}/remove-accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#delete-accounts-async + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `DeleteAccountsAsync`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.DeleteAccountsAsync`: %v\n", resp) + } +- path: /sources/{sourceId}/native-change-detection-config + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#delete-native-change-detection-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#delete-provisioning-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SourcesAPI.DeleteProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + //r, err := apiClient.V2024.SourcesAPI.DeleteProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#delete-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.DeleteSource(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.DeleteSource(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteSource`: DeleteSource202Response + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.DeleteSource`: %v\n", resp) + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#delete-source-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + scheduleType := `ACCOUNT_AGGREGATION` // string | The Schedule type. # string | The Schedule type. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SourcesAPI.DeleteSourceSchedule(context.Background(), sourceId, scheduleType).Execute() + //r, err := apiClient.V2024.SourcesAPI.DeleteSourceSchedule(context.Background(), sourceId, scheduleType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSourceSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#delete-source-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SourcesAPI.DeleteSourceSchema(context.Background(), sourceId, schemaId).Execute() + //r, err := apiClient.V2024.SourcesAPI.DeleteSourceSchema(context.Background(), sourceId, schemaId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{id}/schemas/accounts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#get-accounts-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SourcesAPI.GetAccountsSchema(context.Background(), id).Execute() + //r, err := apiClient.V2024.SourcesAPI.GetAccountsSchema(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetAccountsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{id}/correlation-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#get-correlation-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetCorrelationConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetCorrelationConfig(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCorrelationConfig`: CorrelationConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetCorrelationConfig`: %v\n", resp) + } +- path: /sources/{id}/schemas/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#get-entitlements-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + schemaName := `?schemaName=group` // string | Name of entitlement schema (optional) # string | Name of entitlement schema (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.SourcesAPI.GetEntitlementsSchema(context.Background(), id).Execute() + //r, err := apiClient.V2024.SourcesAPI.GetEntitlementsSchema(context.Background(), id).SchemaName(schemaName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetEntitlementsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{sourceId}/native-change-detection-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#get-native-change-detection-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `GetNativeChangeDetectionConfig`: NativeChangeDetectionConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetNativeChangeDetectionConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#get-provisioning-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetProvisioningPolicy`: %v\n", resp) + } +- path: /sources/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#get-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSource(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSource(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSource`: %v\n", resp) + } +- path: /sources/{id}/attribute-sync-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#get-source-attr-sync-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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.GetSourceAttrSyncConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceAttrSyncConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceAttrSyncConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceAttrSyncConfig`: AttrSyncSourceConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceAttrSyncConfig`: %v\n", resp) + } +- path: /sources/{id}/connectors/source-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#get-source-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `cef3ee201db947c5912551015ba0c679` // string | The Source id # string | The Source id + locale := `en` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSourceConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceConfig(context.Background(), id).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceConfig`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/connections + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#get-source-connections + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSourceConnections(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceConnections(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceConnections``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceConnections`: SourceConnectionsDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceConnections`: %v\n", resp) + } +- path: /sources/{id}/entitlement-request-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#get-source-entitlement-request-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSourceEntitlementRequestConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceEntitlementRequestConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceEntitlementRequestConfig`: SourceEntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceEntitlementRequestConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/source-health + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#get-source-health + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSourceHealth(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceHealth(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceHealth``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceHealth`: SourceHealthDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceHealth`: %v\n", resp) + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#get-source-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + scheduleType := `ACCOUNT_AGGREGATION` // string | The Schedule type. # string | The Schedule type. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSourceSchedule(context.Background(), sourceId, scheduleType).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceSchedule(context.Background(), sourceId, scheduleType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchedule`: Schedule1 + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchedule`: %v\n", resp) + } +- path: /sources/{sourceId}/schedules + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#get-source-schedules + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSourceSchedules(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceSchedules(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchedules``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchedules`: []Schedule1 + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchedules`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#get-source-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSourceSchema(context.Background(), sourceId, schemaId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceSchema(context.Background(), sourceId, schemaId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchema`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#get-source-schemas + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + includeTypes := `group` // string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) # string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + includeNames := `account` // string | A comma-separated list of schema names to filter result. (optional) # string | A comma-separated list of schema names to filter result. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).IncludeTypes(includeTypes).IncludeNames(includeNames).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchemas``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchemas`: []Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchemas`: %v\n", resp) + } +- path: /sources/{id}/load-accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#import-accounts + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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) + + + + + 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() + 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) + } + // response from `ImportAccounts`: LoadAccountsTask + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportAccounts`: %v\n", resp) + } +- path: /sources/{id}/schemas/accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#import-accounts-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.ImportAccountsSchema(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.ImportAccountsSchema(context.Background(), id).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportAccountsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportAccountsSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportAccountsSchema`: %v\n", resp) + } +- path: /sources/{sourceId}/upload-connector-file + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#import-connector-file + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.ImportConnectorFile(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.ImportConnectorFile(context.Background(), sourceId).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportConnectorFile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportConnectorFile`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportConnectorFile`: %v\n", resp) + } +- path: /sources/{id}/schemas/entitlements + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#import-entitlements-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + schemaName := `?schemaName=group` // string | Name of entitlement schema (optional) # string | Name of entitlement schema (optional) + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.ImportEntitlementsSchema(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.ImportEntitlementsSchema(context.Background(), id).SchemaName(schemaName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportEntitlementsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportEntitlementsSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportEntitlementsSchema`: %v\n", resp) + } +- path: /sources/{id}/load-uncorrelated-accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#import-uncorrelated-accounts + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `ImportUncorrelatedAccounts`: LoadUncorrelatedAccountsTask + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportUncorrelatedAccounts`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#list-provisioning-policies + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.ListProvisioningPolicies(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.ListProvisioningPolicies(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ListProvisioningPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListProvisioningPolicies`: []ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ListProvisioningPolicies`: %v\n", resp) + } +- path: /sources + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#list-sources + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Employees"` // 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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + sorters := `name` // 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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + forSubadmin := `name` // string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) # string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + includeIDNSource := true // bool | Include the IdentityNow source in the response. (optional) (default to false) # bool | Include the IdentityNow source in the response. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.ListSources(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.ListSources(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSubadmin(forSubadmin).IncludeIDNSource(includeIDNSource).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ListSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSources`: []Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ListSources`: %v\n", resp) + } +- path: /sources/{sourceId}/connector/ping-cluster + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#ping-cluster + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.PingCluster(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.PingCluster(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PingCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PingCluster`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PingCluster`: %v\n", resp) + } +- path: /sources/{id}/correlation-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#put-correlation-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + correlationconfig := []byte(`{ + "attributeAssignments" : [ { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + }, { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + } ], + "name" : "Source [source] Account Correlation", + "id" : "2c9180835d191a86015d28455b4a2329" + }`) // CorrelationConfig | + + + var correlationConfig v2024.CorrelationConfig + if err := json.Unmarshal(correlationconfig, &correlationConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.PutCorrelationConfig(context.Background(), id).CorrelationConfig(correlationConfig).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.PutCorrelationConfig(context.Background(), id).CorrelationConfig(correlationConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutCorrelationConfig`: CorrelationConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutCorrelationConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/native-change-detection-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#put-native-change-detection-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true + }`) // NativeChangeDetectionConfig | + + + var nativeChangeDetectionConfig v2024.NativeChangeDetectionConfig + if err := json.Unmarshal(nativechangedetectionconfig, &nativeChangeDetectionConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + 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() + 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) + } + // response from `PutNativeChangeDetectionConfig`: NativeChangeDetectionConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutNativeChangeDetectionConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#put-provisioning-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + provisioningpolicydto := []byte(`{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }`) // ProvisioningPolicyDto | + + + var provisioningPolicyDto v2024.ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.PutProvisioningPolicy(context.Background(), sourceId, usageType).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.PutProvisioningPolicy(context.Background(), sourceId, usageType).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutProvisioningPolicy`: %v\n", resp) + } +- path: /sources/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#put-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + source := []byte(`{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }`) // Source | + + + var source v2024.Source + if err := json.Unmarshal(source, &source); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.PutSource(context.Background(), id).Source(source).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.PutSource(context.Background(), id).Source(source).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSource`: %v\n", resp) + } +- path: /sources/{id}/attribute-sync-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#put-source-attr-sync-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + attrsyncsourceconfig := []byte(`{ + "attributes" : [ { + "name" : "email", + "displayName" : "Email", + "enabled" : true, + "target" : "mail" + }, { + "name" : "firstname", + "displayName" : "First Name", + "enabled" : false, + "target" : "givenName" + } ], + "source" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + } + }`) // AttrSyncSourceConfig | + + + var attrSyncSourceConfig v2024.AttrSyncSourceConfig + if err := json.Unmarshal(attrsyncsourceconfig, &attrSyncSourceConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.PutSourceAttrSyncConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).AttrSyncSourceConfig(attrSyncSourceConfig).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.PutSourceAttrSyncConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).AttrSyncSourceConfig(attrSyncSourceConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSourceAttrSyncConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSourceAttrSyncConfig`: AttrSyncSourceConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSourceAttrSyncConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#put-source-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + schema := []byte(`{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + }`) // Schema | + + + var schema v2024.Schema + if err := json.Unmarshal(schema, &schema); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.PutSourceSchema(context.Background(), sourceId, schemaId).Schema(schema).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.PutSourceSchema(context.Background(), sourceId, schemaId).Schema(schema).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSourceSchema`: %v\n", resp) + } +- path: /sources/{sourceId}/connector/peek-resource-objects + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#search-resource-objects + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + resourceobjectsrequest := []byte(`{ + "maxCount" : 100, + "objectType" : "group" + }`) // ResourceObjectsRequest | + + + var resourceObjectsRequest v2024.ResourceObjectsRequest + if err := json.Unmarshal(resourceobjectsrequest, &resourceObjectsRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.SearchResourceObjects(context.Background(), sourceId).ResourceObjectsRequest(resourceObjectsRequest).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.SearchResourceObjects(context.Background(), sourceId).ResourceObjectsRequest(resourceObjectsRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.SearchResourceObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchResourceObjects`: ResourceObjectsResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.SearchResourceObjects`: %v\n", resp) + } +- path: /sources/{id}/synchronize-attributes + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#sync-attributes-for-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `id_example` // 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.SyncAttributesForSource(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.SyncAttributesForSource(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.SyncAttributesForSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SyncAttributesForSource`: SourceSyncJob + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.SyncAttributesForSource`: %v\n", resp) + } +- path: /sources/{sourceId}/connector/test-configuration + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#test-source-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.TestSourceConfiguration(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.TestSourceConfiguration(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.TestSourceConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConfiguration`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.TestSourceConfiguration`: %v\n", resp) + } +- path: /sources/{sourceId}/connector/check-connection + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#test-source-connection + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source. # string | The ID of the Source. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.TestSourceConnection(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.TestSourceConnection(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.TestSourceConnection``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConnection`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.TestSourceConnection`: %v\n", resp) + } +- path: /sources/{sourceId}/password-policies + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#update-password-policy-holders + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + passwordpolicyholdersdtoinner := []byte(``) // []PasswordPolicyHoldersDtoInner | + + + var passwordPolicyHoldersDtoInner v2024.[]PasswordPolicyHoldersDtoInner + if err := json.Unmarshal(passwordpolicyholdersdtoinner, &passwordPolicyHoldersDtoInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.UpdatePasswordPolicyHolders(context.Background(), sourceId).PasswordPolicyHoldersDtoInner(passwordPolicyHoldersDtoInner).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.UpdatePasswordPolicyHolders(context.Background(), sourceId).PasswordPolicyHoldersDtoInner(passwordPolicyHoldersDtoInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdatePasswordPolicyHolders``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePasswordPolicyHolders`: []PasswordPolicyHoldersDtoInner + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdatePasswordPolicyHolders`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#update-provisioning-policies-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + provisioningpolicydto := []byte(``) // []ProvisioningPolicyDto | + + + var provisioningPolicyDto v2024.[]ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.UpdateProvisioningPoliciesInBulk(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.UpdateProvisioningPoliciesInBulk(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateProvisioningPoliciesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateProvisioningPoliciesInBulk`: []ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateProvisioningPoliciesInBulk`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#update-provisioning-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + jsonpatchoperation := []byte(`[{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schema. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.UpdateProvisioningPolicy(context.Background(), sourceId, usageType).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.UpdateProvisioningPolicy(context.Background(), sourceId, usageType).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateProvisioningPolicy`: %v\n", resp) + } +- path: /sources/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#update-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=new description}]`) // []JsonPatchOperation | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.UpdateSource(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.UpdateSource(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSource`: %v\n", resp) + } +- path: /sources/{id}/entitlement-request-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#update-source-entitlement-request-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + sourceentitlementrequestconfig := []byte(`{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }`) // SourceEntitlementRequestConfig | + + + var sourceEntitlementRequestConfig v2024.SourceEntitlementRequestConfig + if err := json.Unmarshal(sourceentitlementrequestconfig, &sourceEntitlementRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.UpdateSourceEntitlementRequestConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceEntitlementRequestConfig(sourceEntitlementRequestConfig).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.UpdateSourceEntitlementRequestConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceEntitlementRequestConfig(sourceEntitlementRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceEntitlementRequestConfig`: SourceEntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceEntitlementRequestConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#update-source-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + scheduleType := `ACCOUNT_AGGREGATION` // string | The Schedule type. # string | The Schedule type. + jsonpatchoperation := []byte(`[{op=replace, path=/cronExpression, value=0 0 6 * * ?}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schedule. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.UpdateSourceSchedule(context.Background(), sourceId, scheduleType).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.UpdateSourceSchedule(context.Background(), sourceId, scheduleType).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceSchedule`: Schedule1 + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceSchedule`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sources#update-source-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + jsonpatchoperation := []byte(`[{op=add, path=/attributes/-, value={name=location, type=STRING, schema=null, description=Employee location, isMulti=false, isEntitlement=false, isGroup=false}}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schema. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourcesAPI.UpdateSourceSchema(context.Background(), sourceId, schemaId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.SourcesAPI.UpdateSourceSchema(context.Background(), sourceId, schemaId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceSchema`: %v\n", resp) + } +- path: /source-usages/{sourceId}/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/source-usages#get-status-by-source-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | ID of IDN source # string | ID of IDN source + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourceUsagesAPI.GetStatusBySourceId(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourceUsagesAPI.GetStatusBySourceId(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourceUsagesAPI.GetStatusBySourceId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetStatusBySourceId`: SourceUsageStatus + fmt.Fprintf(os.Stdout, "Response from `SourceUsagesAPI.GetStatusBySourceId`: %v\n", resp) + } +- path: /source-usages/{sourceId}/summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/source-usages#get-usages-by-source-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | ID of IDN source # string | ID of IDN source + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `-date` // 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: **date** (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: **date** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SourceUsagesAPI.GetUsagesBySourceId(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2024.SourceUsagesAPI.GetUsagesBySourceId(context.Background(), sourceId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourceUsagesAPI.GetUsagesBySourceId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUsagesBySourceId`: []SourceUsage + fmt.Fprintf(os.Stdout, "Response from `SourceUsagesAPI.GetUsagesBySourceId`: %v\n", resp) + } +- path: /sp-config/export + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sp-config#export-sp-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + exportpayload := []byte(`{ + "description" : "Export Job 1 Test" + }`) // ExportPayload | Export options control what will be included in the export. + + + var exportPayload v2024.ExportPayload + if err := json.Unmarshal(exportpayload, &exportPayload); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SPConfigAPI.ExportSpConfig(context.Background()).ExportPayload(exportPayload).Execute() + //resp, r, err := apiClient.V2024.SPConfigAPI.ExportSpConfig(context.Background()).ExportPayload(exportPayload).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ExportSpConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportSpConfig`: SpConfigExportJob + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ExportSpConfig`: %v\n", resp) + } +- path: /sp-config/export/{id}/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sp-config#get-sp-config-export + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the export job whose results will be downloaded. # string | The ID of the export job whose results will be downloaded. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SPConfigAPI.GetSpConfigExport(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SPConfigAPI.GetSpConfigExport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigExport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigExport`: SpConfigExportResults + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigExport`: %v\n", resp) + } +- path: /sp-config/export/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sp-config#get-sp-config-export-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the export job whose status will be returned. # string | The ID of the export job whose status will be returned. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SPConfigAPI.GetSpConfigExportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SPConfigAPI.GetSpConfigExportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigExportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigExportStatus`: SpConfigExportJobStatus + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigExportStatus`: %v\n", resp) + } +- path: /sp-config/import/{id}/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sp-config#get-sp-config-import + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the import job whose results will be downloaded. # string | The ID of the import job whose results will be downloaded. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SPConfigAPI.GetSpConfigImport(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SPConfigAPI.GetSpConfigImport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigImport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigImport`: SpConfigImportResults + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigImport`: %v\n", resp) + } +- path: /sp-config/import/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sp-config#get-sp-config-import-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the import job whose status will be returned. # string | The ID of the import job whose status will be returned. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SPConfigAPI.GetSpConfigImportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.SPConfigAPI.GetSpConfigImportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigImportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigImportStatus`: SpConfigImportJobStatus + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigImportStatus`: %v\n", resp) + } +- path: /sp-config/import + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sp-config#import-sp-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + data := BINARY_DATA_HERE // *os.File | JSON file containing the objects to be imported. # *os.File | JSON file containing the objects to be imported. + preview := true // bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to false) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to false) + options := []byte(``) // ImportOptions | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SPConfigAPI.ImportSpConfig(context.Background()).Data(data).Execute() + //resp, r, err := apiClient.V2024.SPConfigAPI.ImportSpConfig(context.Background()).Data(data).Preview(preview).Options(options).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ImportSpConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportSpConfig`: SpConfigJob + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ImportSpConfig`: %v\n", resp) + } +- path: /sp-config/config-objects + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/sp-config#list-sp-config-objects + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SPConfigAPI.ListSpConfigObjects(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SPConfigAPI.ListSpConfigObjects(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ListSpConfigObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSpConfigObjects`: []SpConfigObject + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ListSpConfigObjects`: %v\n", resp) + } +- path: /suggested-entitlement-description-batches/{batchId}/stats + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/suggested-entitlement-description#get-sed-batch-stats + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + batchId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | Batch Id # string | Batch Id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.GetSedBatchStats(context.Background(), batchId).Execute() + //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.GetSedBatchStats(context.Background(), batchId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatchStats``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSedBatchStats`: SedBatchStats + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatchStats`: %v\n", resp) + } +- path: /suggested-entitlement-description-batches + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/suggested-entitlement-description#get-sed-batches + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatches``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSedBatches`: SedBatchStatus + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatches`: %v\n", resp) + } +- path: /suggested-entitlement-descriptions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/suggested-entitlement-description#list-seds + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `displayName co "Read and Write"` // 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) + sorters := `sorters=displayName` // 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: **displayName, sourceName, status** (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: **displayName, sourceName, status** (optional) + countOnly := count-only=true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) + requestedByAnyone := requested-by-anyone=true // bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to false) # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to false) + showPendingStatusOnly := show-pending-status-only=true // bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to false) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.ListSeds(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.ListSeds(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).CountOnly(countOnly).RequestedByAnyone(requestedByAnyone).ShowPendingStatusOnly(showPendingStatusOnly).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.ListSeds``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSeds`: []Sed + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.ListSeds`: %v\n", resp) + } +- path: /suggested-entitlement-descriptions + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/suggested-entitlement-description#patch-sed + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ebab396f-0af1-4050-89b7-dafc63ec70e7` // string | id is sed id # string | id is sed id + sedpatch := []byte(``) // []SedPatch | Sed Patch Request + + + var sedPatch v2024.[]SedPatch + if err := json.Unmarshal(sedpatch, &sedPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.PatchSed(context.Background(), id).SedPatch(sedPatch).Execute() + //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.PatchSed(context.Background(), id).SedPatch(sedPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.PatchSed``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSed`: Sed + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.PatchSed`: %v\n", resp) + } +- path: /suggested-entitlement-description-approvals + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/suggested-entitlement-description#submit-sed-approval + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sedapproval := []byte(``) // []SedApproval | Sed Approval + + + var sedApproval v2024.[]SedApproval + if err := json.Unmarshal(sedapproval, &sedApproval); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.SubmitSedApproval(context.Background()).SedApproval(sedApproval).Execute() + //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.SubmitSedApproval(context.Background()).SedApproval(sedApproval).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedApproval`: []SedApprovalStatus + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedApproval`: %v\n", resp) + } +- path: /suggested-entitlement-description-assignments + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/suggested-entitlement-description#submit-sed-assignment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sedassignment := []byte(`{ + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] + }`) // SedAssignment | Sed Assignment Request + + + var sedAssignment v2024.SedAssignment + if err := json.Unmarshal(sedassignment, &sedAssignment); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.SubmitSedAssignment(context.Background()).SedAssignment(sedAssignment).Execute() + //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.SubmitSedAssignment(context.Background()).SedAssignment(sedAssignment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedAssignment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedAssignment`: SedAssignmentResponse + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedAssignment`: %v\n", resp) + } +- path: /suggested-entitlement-description-batches + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/suggested-entitlement-description#submit-sed-batch-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sedbatchrequest := []byte(`{ + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + }`) // SedBatchRequest | Sed Batch Request (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest(context.Background()).SedBatchRequest(sedBatchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedBatchRequest`: SedBatchResponse + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest`: %v\n", resp) + } +- path: /tagged-objects/{type}/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/tagged-objects#delete-tagged-object + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + type_ := `ROLE` // string | The type of object to delete tags from. # string | The type of object to delete tags from. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object to delete tags from. # string | The ID of the object to delete tags from. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.TaggedObjectsAPI.DeleteTaggedObject(context.Background(), type_, id).Execute() + //r, err := apiClient.V2024.TaggedObjectsAPI.DeleteTaggedObject(context.Background(), type_, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.DeleteTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /tagged-objects/bulk-remove + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/tagged-objects#delete-tags-to-many-object + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + bulkremovetaggedobject := []byte(`{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // BulkRemoveTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + + var bulkRemoveTaggedObject v2024.BulkRemoveTaggedObject + if err := json.Unmarshal(bulkremovetaggedobject, &bulkRemoveTaggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.TaggedObjectsAPI.DeleteTagsToManyObject(context.Background()).BulkRemoveTaggedObject(bulkRemoveTaggedObject).Execute() + //r, err := apiClient.V2024.TaggedObjectsAPI.DeleteTagsToManyObject(context.Background()).BulkRemoveTaggedObject(bulkRemoveTaggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.DeleteTagsToManyObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /tagged-objects/{type}/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/tagged-objects#get-tagged-object + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + type_ := `ROLE` // string | The type of tagged object to retrieve. # string | The type of tagged object to retrieve. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to retrieve. # string | The ID of the object reference to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TaggedObjectsAPI.GetTaggedObject(context.Background(), type_, id).Execute() + //resp, r, err := apiClient.V2024.TaggedObjectsAPI.GetTaggedObject(context.Background(), type_, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.GetTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaggedObject`: TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.GetTaggedObject`: %v\n", resp) + } +- path: /tagged-objects + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/tagged-objects#list-tagged-objects + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `tagName eq "BU_FINANCE"` // 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TaggedObjectsAPI.ListTaggedObjects(context.Background()).Execute() + //resp, r, err := apiClient.V2024.TaggedObjectsAPI.ListTaggedObjects(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.ListTaggedObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTaggedObjects`: []TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.ListTaggedObjects`: %v\n", resp) + } +- path: /tagged-objects/{type} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/tagged-objects#list-tagged-objects-by-type + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + type_ := `ROLE` // string | The type of tagged object to retrieve. # string | The type of tagged object to retrieve. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `objectRef.id eq "2c91808568c529c60168cca6f90c1313"` // 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: **objectRef.id**: *eq* **objectRef.type**: *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: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TaggedObjectsAPI.ListTaggedObjectsByType(context.Background(), type_).Execute() + //resp, r, err := apiClient.V2024.TaggedObjectsAPI.ListTaggedObjectsByType(context.Background(), type_).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.ListTaggedObjectsByType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTaggedObjectsByType`: []TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.ListTaggedObjectsByType`: %v\n", resp) + } +- path: /tagged-objects/{type}/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/tagged-objects#put-tagged-object + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + type_ := `ROLE` // string | The type of tagged object to update. # string | The type of tagged object to update. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to update. # string | The ID of the object reference to update. + taggedobject := []byte(`{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // TaggedObject | + + + var taggedObject v2024.TaggedObject + if err := json.Unmarshal(taggedobject, &taggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TaggedObjectsAPI.PutTaggedObject(context.Background(), type_, id).TaggedObject(taggedObject).Execute() + //resp, r, err := apiClient.V2024.TaggedObjectsAPI.PutTaggedObject(context.Background(), type_, id).TaggedObject(taggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.PutTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutTaggedObject`: TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.PutTaggedObject`: %v\n", resp) + } +- path: /tagged-objects + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/tagged-objects#set-tag-to-object + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + taggedobject := []byte(`{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // TaggedObject | + + + var taggedObject v2024.TaggedObject + if err := json.Unmarshal(taggedobject, &taggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.TaggedObjectsAPI.SetTagToObject(context.Background()).TaggedObject(taggedObject).Execute() + //r, err := apiClient.V2024.TaggedObjectsAPI.SetTagToObject(context.Background()).TaggedObject(taggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.SetTagToObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /tagged-objects/bulk-add + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/tagged-objects#set-tags-to-many-objects + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + bulkaddtaggedobject := []byte(`{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // BulkAddTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + + var bulkAddTaggedObject v2024.BulkAddTaggedObject + if err := json.Unmarshal(bulkaddtaggedobject, &bulkAddTaggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TaggedObjectsAPI.SetTagsToManyObjects(context.Background()).BulkAddTaggedObject(bulkAddTaggedObject).Execute() + //resp, r, err := apiClient.V2024.TaggedObjectsAPI.SetTagsToManyObjects(context.Background()).BulkAddTaggedObject(bulkAddTaggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.SetTagsToManyObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetTagsToManyObjects`: []BulkTaggedObjectResponse + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.SetTagsToManyObjects`: %v\n", resp) + } +- path: /task-status/pending-tasks + method: Head + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/task-management#get-pending-task-headers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.TaskManagementAPI.GetPendingTaskHeaders(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.TaskManagementAPI.GetPendingTaskHeaders(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetPendingTaskHeaders``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /task-status/pending-tasks + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/task-management#get-pending-tasks + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TaskManagementAPI.GetPendingTasks(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.TaskManagementAPI.GetPendingTasks(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetPendingTasks``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPendingTasks`: []TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetPendingTasks`: %v\n", resp) + } +- path: /task-status/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/task-management#get-task-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `00eebcf881994e419d72e757fd30dc0e` // string | Task ID. # string | Task 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.TaskManagementAPI.GetTaskStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.TaskManagementAPI.GetTaskStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetTaskStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaskStatus`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetTaskStatus`: %v\n", resp) + } +- path: /task-status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/task-management#get-task-status-list + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `completionStatus eq "Success"` // 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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) + sorters := `-created` // 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: **created** (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: **created** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TaskManagementAPI.GetTaskStatusList(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.TaskManagementAPI.GetTaskStatusList(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetTaskStatusList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaskStatusList`: []TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetTaskStatusList`: %v\n", resp) + } +- path: /task-status/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/task-management#update-task-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `00eebcf881994e419d72e757fd30dc0e` // string | Task ID. # string | Task 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") + jsonpatchoperation := []byte(``) // []JsonPatchOperation | The JSONPatch payload used to update the object. + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TaskManagementAPI.UpdateTaskStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.TaskManagementAPI.UpdateTaskStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.UpdateTaskStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateTaskStatus`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.UpdateTaskStatus`: %v\n", resp) + } +- path: /tenant + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/tenant#get-tenant + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TenantAPI.GetTenant(context.Background()).Execute() + //resp, r, err := apiClient.V2024.TenantAPI.GetTenant(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TenantAPI.GetTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenant`: Tenant + fmt.Fprintf(os.Stdout, "Response from `TenantAPI.GetTenant`: %v\n", resp) + } +- path: /tenant-context + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/tenant-context#get-tenant-context + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TenantContextAPI.GetTenantContext(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.TenantContextAPI.GetTenantContext(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TenantContextAPI.GetTenantContext``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenantContext`: []GetTenantContext200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `TenantContextAPI.GetTenantContext`: %v\n", resp) + } +- path: /tenant-context + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/tenant-context#patch-tenant-context + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + jsonpatchoperation := []byte(`{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }`) // JsonPatchOperation | + + + var jsonPatchOperation v2024.JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.TenantContextAPI.PatchTenantContext(context.Background()).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //r, err := apiClient.V2024.TenantContextAPI.PatchTenantContext(context.Background()).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TenantContextAPI.PatchTenantContext``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /transforms + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/transforms#create-transform + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + transform := []byte(`{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }`) // Transform | The transform to be created. + + + var transform v2024.Transform + if err := json.Unmarshal(transform, &transform); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TransformsAPI.CreateTransform(context.Background()).Transform(transform).Execute() + //resp, r, err := apiClient.V2024.TransformsAPI.CreateTransform(context.Background()).Transform(transform).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.CreateTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.CreateTransform`: %v\n", resp) + } +- path: /transforms/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/transforms#delete-transform + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to delete # string | ID of the transform to delete + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.TransformsAPI.DeleteTransform(context.Background(), id).Execute() + //r, err := apiClient.V2024.TransformsAPI.DeleteTransform(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.DeleteTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /transforms/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/transforms#get-transform + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to retrieve # string | ID of the transform to retrieve + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TransformsAPI.GetTransform(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.TransformsAPI.GetTransform(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.GetTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.GetTransform`: %v\n", resp) + } +- path: /transforms + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/transforms#list-transforms + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + name := `ExampleTransformName123` // string | Name of the transform to retrieve from the list. (optional) # string | Name of the transform to retrieve from the list. (optional) + filters := `name eq "Uppercase"` // 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: **internal**: *eq* **name**: *eq, sw* (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: **internal**: *eq* **name**: *eq, sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TransformsAPI.ListTransforms(context.Background()).Execute() + //resp, r, err := apiClient.V2024.TransformsAPI.ListTransforms(context.Background()).Offset(offset).Limit(limit).Count(count).Name(name).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.ListTransforms``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTransforms`: []TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.ListTransforms`: %v\n", resp) + } +- path: /transforms/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/transforms#update-transform + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to update # string | ID of the transform to update + transform := []byte(`{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }`) // Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TransformsAPI.UpdateTransform(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.TransformsAPI.UpdateTransform(context.Background(), id).Transform(transform).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.UpdateTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.UpdateTransform`: %v\n", resp) + } +- path: /trigger-invocations/{id}/complete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/triggers#complete-trigger-invocation + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | The ID of the invocation to complete. # string | The ID of the invocation to complete. + 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") + completeinvocation := []byte(`{ + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + }`) // CompleteInvocation | + + + var completeInvocation v2024.CompleteInvocation + if err := json.Unmarshal(completeinvocation, &completeInvocation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.TriggersAPI.CompleteTriggerInvocation(context.Background(), id).XSailPointExperimental(xSailPointExperimental).CompleteInvocation(completeInvocation).Execute() + //r, err := apiClient.V2024.TriggersAPI.CompleteTriggerInvocation(context.Background(), id).XSailPointExperimental(xSailPointExperimental).CompleteInvocation(completeInvocation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.CompleteTriggerInvocation``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /trigger-subscriptions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/triggers#create-subscription + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + subscriptionpostrequest := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "triggerId" : "idn:access-requested", + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + }`) // SubscriptionPostRequest | + + + var subscriptionPostRequest v2024.SubscriptionPostRequest + if err := json.Unmarshal(subscriptionpostrequest, &subscriptionPostRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TriggersAPI.CreateSubscription(context.Background()).XSailPointExperimental(xSailPointExperimental).SubscriptionPostRequest(subscriptionPostRequest).Execute() + //resp, r, err := apiClient.V2024.TriggersAPI.CreateSubscription(context.Background()).XSailPointExperimental(xSailPointExperimental).SubscriptionPostRequest(subscriptionPostRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.CreateSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.CreateSubscription`: %v\n", resp) + } +- path: /trigger-subscriptions/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/triggers#delete-subscription + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | Subscription ID # string | Subscription 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.TriggersAPI.DeleteSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.TriggersAPI.DeleteSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.DeleteSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /trigger-subscriptions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/triggers#list-subscriptions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"` // 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* **triggerId**: *eq* **type**: *eq, le* (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* **triggerId**: *eq* **type**: *eq, le* (optional) + sorters := `triggerName` // 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: **triggerId, triggerName** (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: **triggerId, triggerName** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TriggersAPI.ListSubscriptions(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.TriggersAPI.ListSubscriptions(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListSubscriptions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSubscriptions`: []Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListSubscriptions`: %v\n", resp) + } +- path: /trigger-invocations/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/triggers#list-trigger-invocation-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `triggerId eq "idn:access-request-dynamic-approver"` // 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: **triggerId**: *eq* **subscriptionId**: *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: **triggerId**: *eq* **subscriptionId**: *eq* (optional) + sorters := `created` // 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: **triggerId, subscriptionName, created, completed** (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: **triggerId, subscriptionName, created, completed** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TriggersAPI.ListTriggerInvocationStatus(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.TriggersAPI.ListTriggerInvocationStatus(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListTriggerInvocationStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTriggerInvocationStatus`: []InvocationStatus + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListTriggerInvocationStatus`: %v\n", resp) + } +- path: /triggers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/triggers#list-triggers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "idn:access-request-post-approval"` // 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, ge, le* (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, ge, le* (optional) + sorters := `name` // 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: **id, name** (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: **id, name** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TriggersAPI.ListTriggers(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.TriggersAPI.ListTriggers(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListTriggers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTriggers`: []Trigger + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListTriggers`: %v\n", resp) + } +- path: /trigger-subscriptions/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/triggers#patch-subscription + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | ID of the Subscription to patch # string | ID of the Subscription to patch + 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") + subscriptionpatchrequestinner := []byte(``) // []SubscriptionPatchRequestInner | + + + var subscriptionPatchRequestInner v2024.[]SubscriptionPatchRequestInner + if err := json.Unmarshal(subscriptionpatchrequestinner, &subscriptionPatchRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TriggersAPI.PatchSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SubscriptionPatchRequestInner(subscriptionPatchRequestInner).Execute() + //resp, r, err := apiClient.V2024.TriggersAPI.PatchSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SubscriptionPatchRequestInner(subscriptionPatchRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.PatchSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.PatchSubscription`: %v\n", resp) + } +- path: /trigger-invocations/test + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/triggers#start-test-trigger-invocation + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + testinvocation := []byte(`{ + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } + }`) // TestInvocation | + + + var testInvocation v2024.TestInvocation + if err := json.Unmarshal(testinvocation, &testInvocation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TriggersAPI.StartTestTriggerInvocation(context.Background()).XSailPointExperimental(xSailPointExperimental).TestInvocation(testInvocation).Execute() + //resp, r, err := apiClient.V2024.TriggersAPI.StartTestTriggerInvocation(context.Background()).XSailPointExperimental(xSailPointExperimental).TestInvocation(testInvocation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.StartTestTriggerInvocation``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartTestTriggerInvocation`: []Invocation + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.StartTestTriggerInvocation`: %v\n", resp) + } +- path: /trigger-subscriptions/validate-filter + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/triggers#test-subscription-filter + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + validatefilterinputdto := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + }`) // ValidateFilterInputDto | + + + var validateFilterInputDto v2024.ValidateFilterInputDto + if err := json.Unmarshal(validatefilterinputdto, &validateFilterInputDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TriggersAPI.TestSubscriptionFilter(context.Background()).XSailPointExperimental(xSailPointExperimental).ValidateFilterInputDto(validateFilterInputDto).Execute() + //resp, r, err := apiClient.V2024.TriggersAPI.TestSubscriptionFilter(context.Background()).XSailPointExperimental(xSailPointExperimental).ValidateFilterInputDto(validateFilterInputDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.TestSubscriptionFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSubscriptionFilter`: ValidateFilterOutputDto + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.TestSubscriptionFilter`: %v\n", resp) + } +- path: /trigger-subscriptions/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/triggers#update-subscription + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | Subscription ID # string | Subscription 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") + subscriptionputrequest := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + }`) // SubscriptionPutRequest | + + + var subscriptionPutRequest v2024.SubscriptionPutRequest + if err := json.Unmarshal(subscriptionputrequest, &subscriptionPutRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.TriggersAPI.UpdateSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SubscriptionPutRequest(subscriptionPutRequest).Execute() + //resp, r, err := apiClient.V2024.TriggersAPI.UpdateSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SubscriptionPutRequest(subscriptionPutRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.UpdateSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.UpdateSubscription`: %v\n", resp) + } +- path: /ui-metadata/tenant + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/ui-metadata#get-tenant-ui-metadata + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.UIMetadataAPI.GetTenantUiMetadata(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.UIMetadataAPI.GetTenantUiMetadata(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `UIMetadataAPI.GetTenantUiMetadata``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenantUiMetadata`: TenantUiMetadataItemResponse + fmt.Fprintf(os.Stdout, "Response from `UIMetadataAPI.GetTenantUiMetadata`: %v\n", resp) + } +- path: /ui-metadata/tenant + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/ui-metadata#set-tenant-ui-metadata + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + tenantuimetadataitemupdaterequest := []byte(`{ + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" + }`) // TenantUiMetadataItemUpdateRequest | + + + var tenantUiMetadataItemUpdateRequest v2024.TenantUiMetadataItemUpdateRequest + if err := json.Unmarshal(tenantuimetadataitemupdaterequest, &tenantUiMetadataItemUpdateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.UIMetadataAPI.SetTenantUiMetadata(context.Background()).XSailPointExperimental(xSailPointExperimental).TenantUiMetadataItemUpdateRequest(tenantUiMetadataItemUpdateRequest).Execute() + //resp, r, err := apiClient.V2024.UIMetadataAPI.SetTenantUiMetadata(context.Background()).XSailPointExperimental(xSailPointExperimental).TenantUiMetadataItemUpdateRequest(tenantUiMetadataItemUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `UIMetadataAPI.SetTenantUiMetadata``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetTenantUiMetadata`: TenantUiMetadataItemResponse + fmt.Fprintf(os.Stdout, "Response from `UIMetadataAPI.SetTenantUiMetadata`: %v\n", resp) + } +- path: /vendor-connector-mappings + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + vendorconnectormapping := []byte(`{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }`) // VendorConnectorMapping | + + + var vendorConnectorMapping v2024.VendorConnectorMapping + if err := json.Unmarshal(vendorconnectormapping, &vendorConnectorMapping); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.VendorConnectorMappingsAPI.CreateVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + //resp, r, err := apiClient.V2024.VendorConnectorMappingsAPI.CreateVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.CreateVendorConnectorMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateVendorConnectorMapping`: VendorConnectorMapping + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.CreateVendorConnectorMapping`: %v\n", resp) + } +- path: /vendor-connector-mappings + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + vendorconnectormapping := []byte(`{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }`) // VendorConnectorMapping | + + + var vendorConnectorMapping v2024.VendorConnectorMapping + if err := json.Unmarshal(vendorconnectormapping, &vendorConnectorMapping); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.VendorConnectorMappingsAPI.DeleteVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + //resp, r, err := apiClient.V2024.VendorConnectorMappingsAPI.DeleteVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.DeleteVendorConnectorMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteVendorConnectorMapping`: DeleteVendorConnectorMapping200Response + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.DeleteVendorConnectorMapping`: %v\n", resp) + } +- path: /vendor-connector-mappings + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.VendorConnectorMappingsAPI.GetVendorConnectorMappings(context.Background()).Execute() + //resp, r, err := apiClient.V2024.VendorConnectorMappingsAPI.GetVendorConnectorMappings(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.GetVendorConnectorMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetVendorConnectorMappings`: []VendorConnectorMapping + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.GetVendorConnectorMappings`: %v\n", resp) + } +- path: /workflow-executions/{id}/cancel + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#cancel-workflow-execution + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | The workflow execution ID # string | The workflow execution ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.WorkflowsAPI.CancelWorkflowExecution(context.Background(), id).Execute() + //r, err := apiClient.V2024.WorkflowsAPI.CancelWorkflowExecution(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CancelWorkflowExecution``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /workflows/execute/external/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#create-external-execute-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + createexternalexecuteworkflowrequest := []byte(``) // CreateExternalExecuteWorkflowRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.CreateExternalExecuteWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.CreateExternalExecuteWorkflow(context.Background(), id).CreateExternalExecuteWorkflowRequest(createExternalExecuteWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateExternalExecuteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateExternalExecuteWorkflow`: CreateExternalExecuteWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateExternalExecuteWorkflow`: %v\n", resp) + } +- path: /workflows + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#create-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + createworkflowrequest := []byte(`{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}`) // CreateWorkflowRequest | + + + var createWorkflowRequest v2024.CreateWorkflowRequest + if err := json.Unmarshal(createworkflowrequest, &createWorkflowRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.CreateWorkflow(context.Background()).CreateWorkflowRequest(createWorkflowRequest).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.CreateWorkflow(context.Background()).CreateWorkflowRequest(createWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateWorkflow`: %v\n", resp) + } +- path: /workflows/{id}/external/oauth-clients + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#create-workflow-external-trigger + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.CreateWorkflowExternalTrigger(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.CreateWorkflowExternalTrigger(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateWorkflowExternalTrigger``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkflowExternalTrigger`: WorkflowOAuthClient + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateWorkflowExternalTrigger`: %v\n", resp) + } +- path: /workflows/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#delete-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.WorkflowsAPI.DeleteWorkflow(context.Background(), id).Execute() + //r, err := apiClient.V2024.WorkflowsAPI.DeleteWorkflow(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.DeleteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /workflows/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#get-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.GetWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.GetWorkflow(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflow`: %v\n", resp) + } +- path: /workflow-executions/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#get-workflow-execution + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Workflow execution ID. # string | Workflow execution ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.GetWorkflowExecution(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.GetWorkflowExecution(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecution``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecution`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecution`: %v\n", resp) + } +- path: /workflow-executions/{id}/history + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#get-workflow-execution-history + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow execution # string | Id of the workflow execution + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.GetWorkflowExecutionHistory(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.GetWorkflowExecutionHistory(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutionHistory``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecutionHistory`: []WorkflowExecutionEvent + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutionHistory`: %v\n", resp) + } +- path: /workflows/{id}/executions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#get-workflow-executions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Workflow ID. # string | Workflow 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `status eq "Failed"` // 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: **start_time**: *eq, lt, le, gt, ge* **status**: *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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.GetWorkflowExecutions(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.GetWorkflowExecutions(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecutions`: []WorkflowExecution + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutions`: %v\n", resp) + } +- path: /workflow-library + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#list-complete-workflow-library + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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.V2024.WorkflowsAPI.ListCompleteWorkflowLibrary(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.ListCompleteWorkflowLibrary(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListCompleteWorkflowLibrary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCompleteWorkflowLibrary`: []ListCompleteWorkflowLibrary200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListCompleteWorkflowLibrary`: %v\n", resp) + } +- path: /workflow-library/actions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#list-workflow-library-actions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + filters := `id eq "sp:create-campaign"` // 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* (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* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.ListWorkflowLibraryActions(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.ListWorkflowLibraryActions(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryActions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryActions`: []WorkflowLibraryAction + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryActions`: %v\n", resp) + } +- path: /workflow-library/operators + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#list-workflow-library-operators + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.ListWorkflowLibraryOperators(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.ListWorkflowLibraryOperators(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryOperators``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryOperators`: []WorkflowLibraryOperator + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryOperators`: %v\n", resp) + } +- path: /workflow-library/triggers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#list-workflow-library-triggers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + filters := `id eq "idn:identity-attributes-changed"` // 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* (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* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.ListWorkflowLibraryTriggers(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.ListWorkflowLibraryTriggers(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryTriggers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryTriggers`: []WorkflowLibraryTrigger + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryTriggers`: %v\n", resp) + } +- path: /workflows + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#list-workflows + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.ListWorkflows(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.ListWorkflows(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflows``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflows`: []Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflows`: %v\n", resp) + } +- path: /workflows/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#patch-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2024.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.PatchWorkflow(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.PatchWorkflow(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PatchWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PatchWorkflow`: %v\n", resp) + } +- path: /workflows/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#put-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + workflowbody := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : "{}", + "type" : "EVENT" + }, + "enabled" : false + }`) // WorkflowBody | + + + var workflowBody v2024.WorkflowBody + if err := json.Unmarshal(workflowbody, &workflowBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.PutWorkflow(context.Background(), id).WorkflowBody(workflowBody).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.PutWorkflow(context.Background(), id).WorkflowBody(workflowBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PutWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PutWorkflow`: %v\n", resp) + } +- path: /workflows/execute/external/{id}/test + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#test-external-execute-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + testexternalexecuteworkflowrequest := []byte(``) // TestExternalExecuteWorkflowRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.TestExternalExecuteWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.TestExternalExecuteWorkflow(context.Background(), id).TestExternalExecuteWorkflowRequest(testExternalExecuteWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.TestExternalExecuteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestExternalExecuteWorkflow`: TestExternalExecuteWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.TestExternalExecuteWorkflow`: %v\n", resp) + } +- path: /workflows/{id}/test + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/workflows#test-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + testworkflowrequest := []byte(`{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}`) // TestWorkflowRequest | + + + var testWorkflowRequest v2024.TestWorkflowRequest + if err := json.Unmarshal(testworkflowrequest, &testWorkflowRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkflowsAPI.TestWorkflow(context.Background(), id).TestWorkflowRequest(testWorkflowRequest).Execute() + //resp, r, err := apiClient.V2024.WorkflowsAPI.TestWorkflow(context.Background(), id).TestWorkflowRequest(testWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.TestWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestWorkflow`: TestWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.TestWorkflow`: %v\n", resp) + } +- path: /work-items/{id}/approve/{approvalItemId} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-items#approve-approval-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveApprovalItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItem`: %v\n", resp) + } +- path: /work-items/bulk-approve/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-items#approve-approval-items-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.ApproveApprovalItemsInBulk(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.ApproveApprovalItemsInBulk(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItemsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveApprovalItemsInBulk`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItemsInBulk`: %v\n", resp) + } +- path: /work-items/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-items#complete-work-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + body := `body_example` // string | Body is the request payload to create form definition request (optional) # string | Body is the request payload to create form definition request (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.CompleteWorkItem(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.CompleteWorkItem(context.Background(), id).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.CompleteWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompleteWorkItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.CompleteWorkItem`: %v\n", resp) + } +- path: /work-items/{id}/forward + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-items#forward-work-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + 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") + workitemforward := []byte(`{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + }`) // WorkItemForward | + + + var workItemForward v2024.WorkItemForward + if err := json.Unmarshal(workitemforward, &workItemForward); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2024.WorkItemsAPI.ForwardWorkItem(context.Background(), id).XSailPointExperimental(xSailPointExperimental).WorkItemForward(workItemForward).Execute() + //r, err := apiClient.V2024.WorkItemsAPI.ForwardWorkItem(context.Background(), id).XSailPointExperimental(xSailPointExperimental).WorkItemForward(workItemForward).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ForwardWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /work-items/completed + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-items#get-completed-work-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.GetCompletedWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.GetCompletedWorkItems(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCompletedWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCompletedWorkItems`: []WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCompletedWorkItems`: %v\n", resp) + } +- path: /work-items/completed/count + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-items#get-count-completed-work-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + ownerId := `ownerId_example` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.GetCountCompletedWorkItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.GetCountCompletedWorkItems(context.Background()).XSailPointExperimental(xSailPointExperimental).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCountCompletedWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCountCompletedWorkItems`: WorkItemsCount + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCountCompletedWorkItems`: %v\n", resp) + } +- path: /work-items/count + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-items#get-count-work-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.GetCountWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.GetCountWorkItems(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCountWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCountWorkItems`: WorkItemsCount + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCountWorkItems`: %v\n", resp) + } +- path: /work-items/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-items#get-work-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the work item. # string | ID of the work item. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.GetWorkItem(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.GetWorkItem(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetWorkItem`: %v\n", resp) + } +- path: /work-items/summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-items#get-work-items-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.GetWorkItemsSummary(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.GetWorkItemsSummary(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetWorkItemsSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkItemsSummary`: WorkItemsSummary + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetWorkItemsSummary`: %v\n", resp) + } +- path: /work-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-items#list-work-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.ListWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.ListWorkItems(context.Background()).Limit(limit).Offset(offset).Count(count).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ListWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkItems`: []WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ListWorkItems`: %v\n", resp) + } +- path: /work-items/{id}/reject/{approvalItemId} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-items#reject-approval-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.RejectApprovalItem(context.Background(), id, approvalItemId).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.RejectApprovalItem(context.Background(), id, approvalItemId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.RejectApprovalItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectApprovalItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.RejectApprovalItem`: %v\n", resp) + } +- path: /work-items/bulk-reject/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-items#reject-approval-items-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.RejectApprovalItemsInBulk(context.Background(), id).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.RejectApprovalItemsInBulk(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.RejectApprovalItemsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectApprovalItemsInBulk`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.RejectApprovalItemsInBulk`: %v\n", resp) + } +- path: /work-items/{id}/submit-account-selection + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-items#submit-account-selection + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + requestBody := {fieldName=fieldValue} // map[string]interface{} | Account Selection Data map, keyed on fieldName # map[string]interface{} | Account Selection Data map, keyed on fieldName + + + var requestBody v2024.RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkItemsAPI.SubmitAccountSelection(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2024.WorkItemsAPI.SubmitAccountSelection(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.SubmitAccountSelection``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitAccountSelection`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.SubmitAccountSelection`: %v\n", resp) + } +- path: /reassignment-configurations + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-reassignment#create-reassignment-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + configurationitemrequest := []byte(`{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }`) // ConfigurationItemRequest | + + + var configurationItemRequest v2024.ConfigurationItemRequest + if err := json.Unmarshal(configurationitemrequest, &configurationItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkReassignmentAPI.CreateReassignmentConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).ConfigurationItemRequest(configurationItemRequest).Execute() + //resp, r, err := apiClient.V2024.WorkReassignmentAPI.CreateReassignmentConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).ConfigurationItemRequest(configurationItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.CreateReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateReassignmentConfiguration`: ConfigurationItemResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.CreateReassignmentConfiguration`: %v\n", resp) + } +- path: /reassignment-configurations/{identityId}/{configType} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-reassignment#delete-reassignment-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique identity id + configType := // ConfigTypeEnum | # ConfigTypeEnum | + 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.WorkReassignmentAPI.DeleteReassignmentConfiguration(context.Background(), identityId, configType).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2024.WorkReassignmentAPI.DeleteReassignmentConfiguration(context.Background(), identityId, configType).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.DeleteReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique identity id + configType := accessRequests // ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type + 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") + exclusionfilters := []byte(`SELF_REVIEW_DELEGATION`) // []string | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkReassignmentAPI.GetEvaluateReassignmentConfiguration(context.Background(), identityId, configType).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.WorkReassignmentAPI.GetEvaluateReassignmentConfiguration(context.Background(), identityId, configType).XSailPointExperimental(xSailPointExperimental).ExclusionFilters(exclusionFilters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetEvaluateReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEvaluateReassignmentConfiguration`: []EvaluateResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetEvaluateReassignmentConfiguration`: %v\n", resp) + } +- path: /reassignment-configurations/types + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-reassignment#get-reassignment-config-types + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkReassignmentAPI.GetReassignmentConfigTypes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.WorkReassignmentAPI.GetReassignmentConfigTypes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetReassignmentConfigTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReassignmentConfigTypes`: []ConfigType + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetReassignmentConfigTypes`: %v\n", resp) + } +- path: /reassignment-configurations/{identityId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-reassignment#get-reassignment-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `2c91808781a71ddb0181b9090b5c504f` // string | unique identity id # string | unique 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.WorkReassignmentAPI.GetReassignmentConfiguration(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.WorkReassignmentAPI.GetReassignmentConfiguration(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReassignmentConfiguration`: ConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetReassignmentConfiguration`: %v\n", resp) + } +- path: /reassignment-configurations/tenant-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-reassignment#get-tenant-config-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkReassignmentAPI.GetTenantConfigConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.WorkReassignmentAPI.GetTenantConfigConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetTenantConfigConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenantConfigConfiguration`: TenantConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetTenantConfigConfiguration`: %v\n", resp) + } +- path: /reassignment-configurations + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-reassignment#list-reassignment-configurations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkReassignmentAPI.ListReassignmentConfigurations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2024.WorkReassignmentAPI.ListReassignmentConfigurations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.ListReassignmentConfigurations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListReassignmentConfigurations`: []ConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.ListReassignmentConfigurations`: %v\n", resp) + } +- path: /reassignment-configurations/{identityId} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-reassignment#put-reassignment-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique 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") + configurationitemrequest := []byte(`{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }`) // ConfigurationItemRequest | + + + var configurationItemRequest v2024.ConfigurationItemRequest + if err := json.Unmarshal(configurationitemrequest, &configurationItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkReassignmentAPI.PutReassignmentConfig(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).ConfigurationItemRequest(configurationItemRequest).Execute() + //resp, r, err := apiClient.V2024.WorkReassignmentAPI.PutReassignmentConfig(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).ConfigurationItemRequest(configurationItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.PutReassignmentConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutReassignmentConfig`: ConfigurationItemResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.PutReassignmentConfig`: %v\n", resp) + } +- path: /reassignment-configurations/tenant-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2024/methods/work-reassignment#put-tenant-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + tenantconfigurationrequest := []byte(`{ + "configDetails" : { + "disabled" : true + } + }`) // TenantConfigurationRequest | + + + var tenantConfigurationRequest v2024.TenantConfigurationRequest + if err := json.Unmarshal(tenantconfigurationrequest, &tenantConfigurationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2024.WorkReassignmentAPI.PutTenantConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).TenantConfigurationRequest(tenantConfigurationRequest).Execute() + //resp, r, err := apiClient.V2024.WorkReassignmentAPI.PutTenantConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).TenantConfigurationRequest(tenantConfigurationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.PutTenantConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutTenantConfiguration`: TenantConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.PutTenantConfiguration`: %v\n", resp) + } diff --git a/static/code-examples/v2025/go_code_examples_overlay.yaml b/static/code-examples/v2025/go_code_examples_overlay.yaml new file mode 100644 index 000000000..c26c2c899 --- /dev/null +++ b/static/code-examples/v2025/go_code_examples_overlay.yaml @@ -0,0 +1,29243 @@ +- path: /access-model-metadata/attributes/{key} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-model-metadata#get-access-model-metadata-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + 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.AccessModelMetadataAPI.GetAccessModelMetadataAttribute(context.Background(), key).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AccessModelMetadataAPI.GetAccessModelMetadataAttribute(context.Background(), key).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.GetAccessModelMetadataAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessModelMetadataAttribute`: AttributeDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.GetAccessModelMetadataAttribute`: %v\n", resp) + } +- path: /access-model-metadata/attributes/{key}/values/{value} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-model-metadata#get-access-model-metadata-attribute-value + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + value := `public` // string | Technical name of the Attribute value. # string | Technical name of the Attribute value. + 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.AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue(context.Background(), key, value).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue(context.Background(), key, value).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessModelMetadataAttributeValue`: AttributeValueDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.GetAccessModelMetadataAttributeValue`: %v\n", resp) + } +- path: /access-model-metadata/attributes + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-model-metadata#list-access-model-metadata-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 := `name eq "Privacy"` // 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessModelMetadataAPI.ListAccessModelMetadataAttribute(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AccessModelMetadataAPI.ListAccessModelMetadataAttribute(context.Background()).XSailPointExperimental(xSailPointExperimental).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.ListAccessModelMetadataAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessModelMetadataAttribute`: []AttributeDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.ListAccessModelMetadataAttribute`: %v\n", resp) + } +- path: /access-model-metadata/attributes/{key}/values + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-model-metadata#list-access-model-metadata-attribute-value + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + key := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + 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.AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue(context.Background(), key).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue(context.Background(), key).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessModelMetadataAttributeValue`: []AttributeValueDTO + fmt.Fprintf(os.Stdout, "Response from `AccessModelMetadataAPI.ListAccessModelMetadataAttributeValue`: %v\n", resp) + } +- path: /access-profiles + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-profiles#create-access-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accessprofile := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + }`) // AccessProfile | + + + var accessProfile v2025.AccessProfile + if err := json.Unmarshal(accessprofile, &accessProfile); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessProfilesAPI.CreateAccessProfile(context.Background()).AccessProfile(accessProfile).Execute() + //resp, r, err := apiClient.V2025.AccessProfilesAPI.CreateAccessProfile(context.Background()).AccessProfile(accessProfile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.CreateAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.CreateAccessProfile`: %v\n", resp) + } +- path: /access-profiles/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-profiles#delete-access-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Access Profile to delete # string | ID of the Access Profile to delete + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.AccessProfilesAPI.DeleteAccessProfile(context.Background(), id).Execute() + //r, err := apiClient.V2025.AccessProfilesAPI.DeleteAccessProfile(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.DeleteAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /access-profiles/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-profiles#delete-access-profiles-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accessprofilebulkdeleterequest := []byte(`{ + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + }`) // AccessProfileBulkDeleteRequest | + + + var accessProfileBulkDeleteRequest v2025.AccessProfileBulkDeleteRequest + if err := json.Unmarshal(accessprofilebulkdeleterequest, &accessProfileBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessProfilesAPI.DeleteAccessProfilesInBulk(context.Background()).AccessProfileBulkDeleteRequest(accessProfileBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V2025.AccessProfilesAPI.DeleteAccessProfilesInBulk(context.Background()).AccessProfileBulkDeleteRequest(accessProfileBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.DeleteAccessProfilesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccessProfilesInBulk`: AccessProfileBulkDeleteResponse + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.DeleteAccessProfilesInBulk`: %v\n", resp) + } +- path: /access-profiles/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-profiles#get-access-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Access Profile # string | ID of the Access Profile + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessProfilesAPI.GetAccessProfile(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.AccessProfilesAPI.GetAccessProfile(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.GetAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.GetAccessProfile`: %v\n", resp) + } +- path: /access-profiles/{id}/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-profiles#get-access-profile-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the access profile containing the entitlements. # string | ID of the access profile containing the entitlements. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessProfilesAPI.GetAccessProfileEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.AccessProfilesAPI.GetAccessProfileEntitlements(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.GetAccessProfileEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessProfileEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.GetAccessProfileEntitlements`: %v\n", resp) + } +- path: /access-profiles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-profiles#list-access-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + forSubadmin := `8c190e6787aa4ed9a90bd9d5344523fb` // string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) # string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "SailPoint Support"` // 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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessProfilesAPI.ListAccessProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccessProfilesAPI.ListAccessProfiles(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.ListAccessProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessProfiles`: []AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.ListAccessProfiles`: %v\n", resp) + } +- path: /access-profiles/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-profiles#patch-access-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Access Profile to patch # string | ID of the Access Profile to patch + jsonpatchoperation := []byte(`[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessProfilesAPI.PatchAccessProfile(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.AccessProfilesAPI.PatchAccessProfile(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.PatchAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.PatchAccessProfile`: %v\n", resp) + } +- path: /access-profiles/bulk-update-requestable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-profiles#update-access-profiles-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + accessprofilebulkupdaterequestinner := []byte(`[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]`) // []AccessProfileBulkUpdateRequestInner | + + + var accessProfileBulkUpdateRequestInner v2025.[]AccessProfileBulkUpdateRequestInner + if err := json.Unmarshal(accessprofilebulkupdaterequestinner, &accessProfileBulkUpdateRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessProfilesAPI.UpdateAccessProfilesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessProfileBulkUpdateRequestInner(accessProfileBulkUpdateRequestInner).Execute() + //resp, r, err := apiClient.V2025.AccessProfilesAPI.UpdateAccessProfilesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessProfileBulkUpdateRequestInner(accessProfileBulkUpdateRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.UpdateAccessProfilesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAccessProfilesInBulk`: []AccessProfileUpdateItem + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.UpdateAccessProfilesInBulk`: %v\n", resp) + } +- path: /access-request-approvals/{approvalId}/approve + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-request-approvals#approve-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + commentdto := []byte(`{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + }`) // CommentDto | Reviewer's comment. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ApproveAccessRequest(context.Background(), approvalId).Execute() + //resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ApproveAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ApproveAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ApproveAccessRequest`: %v\n", resp) + } +- path: /access-request-approvals/{approvalId}/forward + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-request-approvals#forward-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + forwardapprovaldto := []byte(`{ + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" + }`) // ForwardApprovalDto | Information about the forwarded approval. + + + var forwardApprovalDto v2025.ForwardApprovalDto + if err := json.Unmarshal(forwardapprovaldto, &forwardApprovalDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ForwardAccessRequest(context.Background(), approvalId).ForwardApprovalDto(forwardApprovalDto).Execute() + //resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ForwardAccessRequest(context.Background(), approvalId).ForwardApprovalDto(forwardApprovalDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ForwardAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ForwardAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ForwardAccessRequest`: %v\n", resp) + } +- path: /access-request-approvals/approval-summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-request-approvals#get-access-request-approval-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + fromDate := `from-date=2020-03-19T19:59:11Z` // string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) # string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary(context.Background()).OwnerId(ownerId).FromDate(fromDate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestApprovalSummary`: ApprovalSummary + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary`: %v\n", resp) + } +- path: /access-request-approvals/{accessRequestId}/approvers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-request-approvals#list-access-request-approvers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accessRequestId := `2c91808568c529c60168cca6f90c1313` // string | Access Request ID. # string | Access Request ID. + limit := 100 // int32 | Max number of results to return. (optional) (default to 250) # int32 | Max number of results to return. (optional) (default to 250) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + count := false // bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ListAccessRequestApprovers(context.Background(), accessRequestId).Execute() + //resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ListAccessRequestApprovers(context.Background(), accessRequestId).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListAccessRequestApprovers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessRequestApprovers`: []AccessRequestApproversListResponse + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListAccessRequestApprovers`: %v\n", resp) + } +- path: /access-request-approvals/completed + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-request-approvals#list-completed-approvals + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "2c91808568c529c60168cca6f90c1313"` // 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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + sorters := `modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ListCompletedApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ListCompletedApprovals(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListCompletedApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCompletedApprovals`: []CompletedApproval + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListCompletedApprovals`: %v\n", resp) + } +- path: /access-request-approvals/pending + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-request-approvals#list-pending-approvals + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "2c91808568c529c60168cca6f90c1313"` // 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) + sorters := `modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ListPendingApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.ListPendingApprovals(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListPendingApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPendingApprovals`: []PendingApproval + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListPendingApprovals`: %v\n", resp) + } +- path: /access-request-approvals/{approvalId}/reject + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-request-approvals#reject-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + commentdto := []byte(`{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + }`) // CommentDto | Reviewer's comment. + + + var commentDto v2025.CommentDto + if err := json.Unmarshal(commentdto, &commentDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.RejectAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + //resp, r, err := apiClient.V2025.AccessRequestApprovalsAPI.RejectAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.RejectAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.RejectAccessRequest`: %v\n", resp) + } +- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-request-identity-metrics#get-access-request-identity-metrics + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `7025c863-c270-4ba6-beea-edf3cb091573` // string | Manager's identity ID. # string | Manager's identity ID. + requestedObjectId := `2db501be-f0fb-4cc5-a695-334133c52891` // string | Requested access item's ID. # string | Requested access item's ID. + type_ := `ENTITLEMENT` // string | Requested access item's type. # string | Requested access item's type. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics(context.Background(), identityId, requestedObjectId, type_).Execute() + //resp, r, err := apiClient.V2025.AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics(context.Background(), identityId, requestedObjectId, type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestIdentityMetrics`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestIdentityMetricsAPI.GetAccessRequestIdentityMetrics`: %v\n", resp) + } +- path: /access-request-approvals/bulk-approve + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-requests#approve-bulk-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + bulkapproveaccessrequest := []byte(`{ + "comment" : "I approve these request items", + "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] + }`) // BulkApproveAccessRequest | + + + var bulkApproveAccessRequest v2025.BulkApproveAccessRequest + if err := json.Unmarshal(bulkapproveaccessrequest, &bulkApproveAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.ApproveBulkAccessRequest(context.Background()).BulkApproveAccessRequest(bulkApproveAccessRequest).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.ApproveBulkAccessRequest(context.Background()).BulkApproveAccessRequest(bulkApproveAccessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.ApproveBulkAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveBulkAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.ApproveBulkAccessRequest`: %v\n", resp) + } +- path: /access-requests/cancel + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-requests#cancel-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + cancelaccessrequest := []byte(`{ + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + }`) // CancelAccessRequest | + + + var cancelAccessRequest v2025.CancelAccessRequest + if err := json.Unmarshal(cancelaccessrequest, &cancelAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.CancelAccessRequest(context.Background()).CancelAccessRequest(cancelAccessRequest).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.CancelAccessRequest(context.Background()).CancelAccessRequest(cancelAccessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CancelAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CancelAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CancelAccessRequest`: %v\n", resp) + } +- path: /access-requests/bulk-cancel + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-requests#cancel-access-request-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + bulkcancelaccessrequest := []byte(`{ + "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], + "comment" : "I requested this role by mistake." + }`) // BulkCancelAccessRequest | + + + var bulkCancelAccessRequest v2025.BulkCancelAccessRequest + if err := json.Unmarshal(bulkcancelaccessrequest, &bulkCancelAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.CancelAccessRequestInBulk(context.Background()).BulkCancelAccessRequest(bulkCancelAccessRequest).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.CancelAccessRequestInBulk(context.Background()).BulkCancelAccessRequest(bulkCancelAccessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CancelAccessRequestInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CancelAccessRequestInBulk`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CancelAccessRequestInBulk`: %v\n", resp) + } +- path: /access-requests/close + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-requests#close-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + }`) // CloseAccessRequest | + + + var closeAccessRequest v2025.CloseAccessRequest + if err := json.Unmarshal(closeaccessrequest, &closeAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + 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() + 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) + } + // response from `CloseAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CloseAccessRequest`: %v\n", resp) + } +- path: /access-requests + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-requests#create-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accessrequest := []byte(`{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } ] + }`) // AccessRequest | + + + var accessRequest v2025.AccessRequest + if err := json.Unmarshal(accessrequest, &accessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.CreateAccessRequest(context.Background()).AccessRequest(accessRequest).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.CreateAccessRequest(context.Background()).AccessRequest(accessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CreateAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessRequest`: AccessRequestResponse + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CreateAccessRequest`: %v\n", resp) + } +- path: /access-request-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-requests#get-access-request-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.GetAccessRequestConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.GetAccessRequestConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.GetAccessRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestConfig`: AccessRequestConfig + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.GetAccessRequestConfig`: %v\n", resp) + } +- path: /access-requests/revocable-objects + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-requests#get-entitlement-details-for-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + identityId := `7025c863c2704ba6beeaedf3cb091573` // string | The identity ID. # string | The identity ID. + entitlementId := `ef38f94347e94562b5bb8424a56397d8` // string | The entitlement ID # string | The entitlement ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.GetEntitlementDetailsForIdentity(context.Background(), identityId, entitlementId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.GetEntitlementDetailsForIdentity(context.Background(), identityId, entitlementId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.GetEntitlementDetailsForIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementDetailsForIdentity`: IdentityEntitlementDetails + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.GetEntitlementDetailsForIdentity`: %v\n", resp) + } +- path: /access-request-status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-requests#list-access-request-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + assignedTo := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + count := false // bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + limit := 100 // int32 | Max number of results to return. (optional) (default to 250) # int32 | Max number of results to return. (optional) (default to 250) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + filters := `accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"` // 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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + sorters := `created` // 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: **created, modified, accountActivityItemId, name** (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: **created, modified, accountActivityItemId, name** (optional) + requestState := `request-state=EXECUTING` // string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.ListAccessRequestStatus(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.ListAccessRequestStatus(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).AssignedTo(assignedTo).Count(count).Limit(limit).Offset(offset).Filters(filters).Sorters(sorters).RequestState(requestState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.ListAccessRequestStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessRequestStatus`: []RequestedItemStatus + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.ListAccessRequestStatus`: %v\n", resp) + } +- path: /access-request-administration + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-requests#list-administrators-access-request-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + assignedTo := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + count := false // bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + limit := 100 // int32 | Max number of results to return. (optional) (default to 250) # int32 | Max number of results to return. (optional) (default to 250) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + filters := `accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"` // 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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + sorters := `created` // 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: **created, modified, accountActivityItemId, name, accessRequestId** (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: **created, modified, accountActivityItemId, name, accessRequestId** (optional) + requestState := `request-state=EXECUTING` // string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.ListAdministratorsAccessRequestStatus(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.ListAdministratorsAccessRequestStatus(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).AssignedTo(assignedTo).Count(count).Limit(limit).Offset(offset).Filters(filters).Sorters(sorters).RequestState(requestState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.ListAdministratorsAccessRequestStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAdministratorsAccessRequestStatus`: []AccessRequestAdminItemStatus + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.ListAdministratorsAccessRequestStatus`: %v\n", resp) + } +- path: /access-requests/accounts-selection + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-requests#load-account-selections + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accountsselectionrequest := []byte(`{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }`) // AccountsSelectionRequest | + + + var accountsSelectionRequest v2025.AccountsSelectionRequest + if err := json.Unmarshal(accountsselectionrequest, &accountsSelectionRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.LoadAccountSelections(context.Background()).AccountsSelectionRequest(accountsSelectionRequest).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.LoadAccountSelections(context.Background()).AccountsSelectionRequest(accountsSelectionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.LoadAccountSelections``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `LoadAccountSelections`: AccountsSelectionResponse + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.LoadAccountSelections`: %v\n", resp) + } +- path: /access-request-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/access-requests#set-access-request-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accessrequestconfig := []byte(`{ + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + }`) // AccessRequestConfig | + + + var accessRequestConfig v2025.AccessRequestConfig + if err := json.Unmarshal(accessrequestconfig, &accessRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccessRequestsAPI.SetAccessRequestConfig(context.Background()).AccessRequestConfig(accessRequestConfig).Execute() + //resp, r, err := apiClient.V2025.AccessRequestsAPI.SetAccessRequestConfig(context.Background()).AccessRequestConfig(accessRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.SetAccessRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetAccessRequestConfig`: AccessRequestConfig + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.SetAccessRequestConfig`: %v\n", resp) + } +- path: /account-activities/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/account-activities#get-account-activity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account activity id # string | The account activity id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountActivitiesAPI.GetAccountActivity(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.AccountActivitiesAPI.GetAccountActivity(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountActivitiesAPI.GetAccountActivity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccountActivity`: AccountActivity + fmt.Fprintf(os.Stdout, "Response from `AccountActivitiesAPI.GetAccountActivity`: %v\n", resp) + } +- path: /account-activities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/account-activities#list-account-activities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c91808568c529c60168cca6f90c1313` // string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c91808568c529c60168cca6f90c1313` // string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c91808568c529c60168cca6f90c1313` // string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `type eq "Identity Refresh"` // 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + sorters := `created` // 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: **type, created, modified** (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: **type, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountActivitiesAPI.ListAccountActivities(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccountActivitiesAPI.ListAccountActivities(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountActivitiesAPI.ListAccountActivities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccountActivities`: []AccountActivity + fmt.Fprintf(os.Stdout, "Response from `AccountActivitiesAPI.ListAccountActivities`: %v\n", resp) + } +- path: /account-aggregations/{id}/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/account-aggregations#get-account-aggregation-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `GetAccountAggregationStatus`: AccountAggregationStatus + fmt.Fprintf(os.Stdout, "Response from `AccountAggregationsAPI.GetAccountAggregationStatus`: %v\n", resp) + } +- path: /accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/accounts#create-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accountattributescreate := []byte(`{ + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }`) // AccountAttributesCreate | + + + var accountAttributesCreate v2025.AccountAttributesCreate + if err := json.Unmarshal(accountattributescreate, &accountAttributesCreate); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.CreateAccount(context.Background()).AccountAttributesCreate(accountAttributesCreate).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.CreateAccount(context.Background()).AccountAttributesCreate(accountAttributesCreate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.CreateAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.CreateAccount`: %v\n", resp) + } +- path: /accounts/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/accounts#delete-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.DeleteAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.DeleteAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DeleteAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DeleteAccount`: %v\n", resp) + } +- path: /accounts/{id}/remove + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/accounts#delete-account-async + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `DeleteAccountAsync`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DeleteAccountAsync`: %v\n", resp) + } +- path: /accounts/{id}/disable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/accounts#disable-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + accounttogglerequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }`) // AccountToggleRequest | + + + var accountToggleRequest v2025.AccountToggleRequest + if err := json.Unmarshal(accounttogglerequest, &accountToggleRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.DisableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.DisableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DisableAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DisableAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccount`: %v\n", resp) + } +- path: /identities-accounts/{id}/disable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/accounts#disable-account-for-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `DisableAccountForIdentity`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccountForIdentity`: %v\n", resp) + } +- path: /identities-accounts/disable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/accounts#disable-accounts-for-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 | + + + var identitiesAccountsBulkRequest v2025.IdentitiesAccountsBulkRequest + if err := json.Unmarshal(identitiesaccountsbulkrequest, &identitiesAccountsBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + 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() + 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) + } + // response from `DisableAccountsForIdentities`: []BulkIdentitiesAccountsResponse + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccountsForIdentities`: %v\n", resp) + } +- path: /accounts/{id}/enable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/accounts#enable-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + accounttogglerequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }`) // AccountToggleRequest | + + + var accountToggleRequest v2025.AccountToggleRequest + if err := json.Unmarshal(accounttogglerequest, &accountToggleRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.EnableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.EnableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.EnableAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `EnableAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccount`: %v\n", resp) + } +- path: /identities-accounts/{id}/enable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/accounts#enable-account-for-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `EnableAccountForIdentity`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccountForIdentity`: %v\n", resp) + } +- path: /identities-accounts/enable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/accounts#enable-accounts-for-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 | + + + var identitiesAccountsBulkRequest v2025.IdentitiesAccountsBulkRequest + if err := json.Unmarshal(identitiesaccountsbulkrequest, &identitiesAccountsBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + 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() + 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) + } + // response from `EnableAccountsForIdentities`: []BulkIdentitiesAccountsResponse + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccountsForIdentities`: %v\n", resp) + } +- path: /accounts/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/accounts#get-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.GetAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.GetAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.GetAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccount`: Account + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.GetAccount`: %v\n", resp) + } +- path: /accounts/{id}/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/accounts#get-account-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.GetAccountEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.GetAccountEntitlements(context.Background(), id).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.GetAccountEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccountEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.GetAccountEntitlements`: %v\n", resp) + } +- path: /accounts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/accounts#list-accounts + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + detailLevel := `FULL` // string | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) # string | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + filters := `identityId eq "2c9180858082150f0180893dbaf44201"` // 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) + sorters := `id,name` // 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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.ListAccounts(context.Background()).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.ListAccounts(context.Background()).Limit(limit).Offset(offset).Count(count).DetailLevel(detailLevel).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.ListAccounts``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccounts`: []Account + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.ListAccounts`: %v\n", resp) + } +- path: /accounts/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/accounts#put-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + accountattributes := []byte(`{ + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }`) // AccountAttributes | + + + var accountAttributes v2025.AccountAttributes + if err := json.Unmarshal(accountattributes, &accountAttributes); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.PutAccount(context.Background(), id).AccountAttributes(accountAttributes).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.PutAccount(context.Background(), id).AccountAttributes(accountAttributes).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.PutAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.PutAccount`: %v\n", resp) + } +- path: /accounts/{id}/reload + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/accounts#submit-reload-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.SubmitReloadAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.SubmitReloadAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.SubmitReloadAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitReloadAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.SubmitReloadAccount`: %v\n", resp) + } +- path: /accounts/{id}/unlock + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/accounts#unlock-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account ID. # string | The account ID. + accountunlockrequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + }`) // AccountUnlockRequest | + + + var accountUnlockRequest v2025.AccountUnlockRequest + if err := json.Unmarshal(accountunlockrequest, &accountUnlockRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.UnlockAccount(context.Background(), id).AccountUnlockRequest(accountUnlockRequest).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.UnlockAccount(context.Background(), id).AccountUnlockRequest(accountUnlockRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.UnlockAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UnlockAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.UnlockAccount`: %v\n", resp) + } +- path: /accounts/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/accounts#update-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + requestbody := []byte(`[{op=remove, path=/identityId}]`) // []map[string]interface{} | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountsAPI.UpdateAccount(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2025.AccountsAPI.UpdateAccount(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.UpdateAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAccount`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.UpdateAccount`: %v\n", resp) + } +- path: /account-usages/{accountId}/summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/account-usages#get-usages-by-account-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accountId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of IDN account # string | ID of IDN account + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `-date` // 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: **date** (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: **date** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AccountUsagesAPI.GetUsagesByAccountId(context.Background(), accountId).Execute() + //resp, r, err := apiClient.V2025.AccountUsagesAPI.GetUsagesByAccountId(context.Background(), accountId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountUsagesAPI.GetUsagesByAccountId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUsagesByAccountId`: []AccountUsage + fmt.Fprintf(os.Stdout, "Response from `AccountUsagesAPI.GetUsagesByAccountId`: %v\n", resp) + } +- path: /discovered-applications + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/application-discovery#get-discovered-applications + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + filter := `name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")` // 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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + sorters := `name` // 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, description, discoveredAt, discoverySource** (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, description, discoveredAt, discoverySource** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ApplicationDiscoveryAPI.GetDiscoveredApplications(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ApplicationDiscoveryAPI.GetDiscoveredApplications(context.Background()).Limit(limit).Offset(offset).Detail(detail).Filter(filter).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetDiscoveredApplications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDiscoveredApplications`: []GetDiscoveredApplications200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `ApplicationDiscoveryAPI.GetDiscoveredApplications`: %v\n", resp) + } +- path: /manual-discover-applications-template + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManualDiscoverApplicationsCsvTemplate`: ManualDiscoverApplicationsTemplate + fmt.Fprintf(os.Stdout, "Response from `ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate`: %v\n", resp) + } +- path: /manual-discover-applications + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + file := BINARY_DATA_HERE // *os.File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # *os.File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate(context.Background()).File(file).Execute() + //r, err := apiClient.V2025.ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate(context.Background()).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /generic-approvals/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/approvals#get-approval + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `38453251-6be2-5f8f-df93-5ce19e295837` // string | ID of the approval that is to be returned # string | ID of the approval that is to be returned + 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.ApprovalsAPI.GetApproval(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.ApprovalsAPI.GetApproval(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApprovalsAPI.GetApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetApproval`: Approval + fmt.Fprintf(os.Stdout, "Response from `ApprovalsAPI.GetApproval`: %v\n", resp) + } +- path: /generic-approvals + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/approvals#get-approvals + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + mine := true // bool | Returns the list of approvals for the current caller (optional) # bool | Returns the list of approvals for the current caller (optional) + requesterId := `17e633e7d57e481569df76323169deb6a` // string | Returns the list of approvals for a given requester ID (optional) # string | Returns the list of approvals for a given requester ID (optional) + filters := `filters=status eq PENDING` // 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: **status**: *eq* **referenceType**: *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: **status**: *eq* **referenceType**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ApprovalsAPI.GetApprovals(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.ApprovalsAPI.GetApprovals(context.Background()).XSailPointExperimental(xSailPointExperimental).Mine(mine).RequesterId(requesterId).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApprovalsAPI.GetApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetApprovals`: []Approval + fmt.Fprintf(os.Stdout, "Response from `ApprovalsAPI.GetApprovals`: %v\n", resp) + } +- path: /source-apps + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/apps#create-source-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + sourceappcreatedto := []byte(`{ + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true + }`) // SourceAppCreateDto | + + + var sourceAppCreateDto v2025.SourceAppCreateDto + if err := json.Unmarshal(sourceappcreatedto, &sourceAppCreateDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.CreateSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceAppCreateDto(sourceAppCreateDto).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.CreateSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceAppCreateDto(sourceAppCreateDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.CreateSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.CreateSourceApp`: %v\n", resp) + } +- path: /source-apps/{id}/access-profiles/bulk-remove + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/apps#delete-access-profiles-from-source-app-by-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + 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") + requestbody := []byte(`[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]`) // []string | + 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) + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.DeleteAccessProfilesFromSourceAppByBulk(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.DeleteAccessProfilesFromSourceAppByBulk(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.DeleteAccessProfilesFromSourceAppByBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccessProfilesFromSourceAppByBulk`: []AccessProfileDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.DeleteAccessProfilesFromSourceAppByBulk`: %v\n", resp) + } +- path: /source-apps/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/apps#delete-source-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | source app ID. # string | source app 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.AppsAPI.DeleteSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.DeleteSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.DeleteSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.DeleteSourceApp`: %v\n", resp) + } +- path: /source-apps/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/apps#get-source-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + 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.AppsAPI.GetSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.GetSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.GetSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceApp`: SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.GetSourceApp`: %v\n", resp) + } +- path: /source-apps/{id}/access-profiles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/apps#list-access-profiles-for-source-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app # string | ID of the source app + 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") + 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) + filters := `name eq "developer access profile"` // 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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.ListAccessProfilesForSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.ListAccessProfilesForSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAccessProfilesForSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessProfilesForSourceApp`: []AccessProfileDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAccessProfilesForSourceApp`: %v\n", resp) + } +- path: /source-apps/all + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/apps#list-all-source-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, owner.id, accountSource.id** (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: **id, name, created, modified, owner.id, accountSource.id** (optional) + filters := `enabled eq true` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.ListAllSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.ListAllSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAllSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAllSourceApp`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAllSourceApp`: %v\n", resp) + } +- path: /user-apps/all + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/apps#list-all-user-apps + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filters := `name eq "user app name"` // 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.V2025.AppsAPI.ListAllUserApps(context.Background()).Filters(filters).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.ListAllUserApps(context.Background()).Filters(filters).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAllUserApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAllUserApps`: []UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAllUserApps`: %v\n", resp) + } +- path: /source-apps/assigned + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/apps#list-assigned-source-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, accountSource.id** (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: **id, name, created, modified, accountSource.id** (optional) + filters := `name eq "source app name"` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.ListAssignedSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.ListAssignedSourceApp(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAssignedSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAssignedSourceApp`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAssignedSourceApp`: %v\n", resp) + } +- path: /user-apps/{id}/available-accounts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/apps#list-available-accounts-for-user-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the user app # string | ID of the user app + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.ListAvailableAccountsForUserApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.ListAvailableAccountsForUserApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAvailableAccountsForUserApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAvailableAccountsForUserApp`: []AppAccountDetails + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAvailableAccountsForUserApp`: %v\n", resp) + } +- path: /source-apps + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/apps#list-available-source-apps + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + sorters := `name,-modified` // 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: **id, name, created, modified, owner.id, accountSource.id** (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: **id, name, created, modified, owner.id, accountSource.id** (optional) + filters := `name eq "source app name"` // 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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.ListAvailableSourceApps(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.ListAvailableSourceApps(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListAvailableSourceApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAvailableSourceApps`: []SourceApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListAvailableSourceApps`: %v\n", resp) + } +- path: /user-apps + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/apps#list-owned-user-apps + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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) + filters := `name eq "user app name"` // 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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.ListOwnedUserApps(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.ListOwnedUserApps(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Count(count).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.ListOwnedUserApps``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOwnedUserApps`: []UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.ListOwnedUserApps`: %v\n", resp) + } +- path: /source-apps/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/apps#patch-source-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the source app to patch # string | ID of the source app to patch + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]`) // []JsonPatchOperation | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.PatchSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.PatchSourceApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.PatchSourceApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSourceApp`: SourceAppPatchDto + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.PatchSourceApp`: %v\n", resp) + } +- path: /user-apps/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/apps#patch-user-app + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the user app to patch # string | ID of the user app to patch + 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") + jsonpatchoperation := []byte(``) // []JsonPatchOperation | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AppsAPI.PatchUserApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AppsAPI.PatchUserApp(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.PatchUserApp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchUserApp`: UserApp + fmt.Fprintf(os.Stdout, "Response from `AppsAPI.PatchUserApp`: %v\n", resp) + } +- path: /source-apps/bulk-update + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/apps#update-source-apps-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + sourceappbulkupdaterequest := []byte(`{ + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] + }`) // SourceAppBulkUpdateRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.AppsAPI.UpdateSourceAppsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.AppsAPI.UpdateSourceAppsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceAppBulkUpdateRequest(sourceAppBulkUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AppsAPI.UpdateSourceAppsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /auth-profiles/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/auth-profile#get-profile-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + id := `2c91808a7813090a017814121919ecca` // string | ID of the Auth Profile to patch. # string | ID of the Auth Profile to patch. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AuthProfileAPI.GetProfileConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AuthProfileAPI.GetProfileConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.GetProfileConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProfileConfig`: AuthProfile + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.GetProfileConfig`: %v\n", resp) + } +- path: /auth-profiles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/auth-profile#get-profile-config-list + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AuthProfileAPI.GetProfileConfigList(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.AuthProfileAPI.GetProfileConfigList(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.GetProfileConfigList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProfileConfigList`: []AuthProfileSummary + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.GetProfileConfigList`: %v\n", resp) + } +- path: /auth-profiles/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/auth-profile#patch-profile-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Auth Profile to patch. # string | ID of the Auth Profile to patch. + 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") + jsonpatchoperation := []byte(``) // []JsonPatchOperation | + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AuthProfileAPI.PatchProfileConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.AuthProfileAPI.PatchProfileConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthProfileAPI.PatchProfileConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchProfileConfig`: AuthProfile + fmt.Fprintf(os.Stdout, "Response from `AuthProfileAPI.PatchProfileConfig`: %v\n", resp) + } +- path: /auth-users/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/auth-users#get-auth-user + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AuthUsersAPI.GetAuthUser(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.AuthUsersAPI.GetAuthUser(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthUsersAPI.GetAuthUser``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthUser`: AuthUser + fmt.Fprintf(os.Stdout, "Response from `AuthUsersAPI.GetAuthUser`: %v\n", resp) + } +- path: /auth-users/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/auth-users#patch-auth-user + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + jsonpatchoperation := []byte(`[{op=replace, path=/capabilities, value=[ORG_ADMIN]}]`) // []JsonPatchOperation | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.AuthUsersAPI.PatchAuthUser(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.AuthUsersAPI.PatchAuthUser(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthUsersAPI.PatchAuthUser``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthUser`: AuthUser + fmt.Fprintf(os.Stdout, "Response from `AuthUsersAPI.PatchAuthUser`: %v\n", resp) + } +- path: /brandings + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/branding#create-branding-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `name_example` // string | name of branding item # string | name of branding item + productName := `productName_example` // string | product name # string | product name + actionButtonColor := `actionButtonColor_example` // string | hex value of color for action button (optional) # string | hex value of color for action button (optional) + activeLinkColor := `activeLinkColor_example` // string | hex value of color for link (optional) # string | hex value of color for link (optional) + navigationColor := `navigationColor_example` // string | hex value of color for navigation bar (optional) # string | hex value of color for navigation bar (optional) + emailFromAddress := `emailFromAddress_example` // string | email from address (optional) # string | email from address (optional) + loginInformationalMessage := `loginInformationalMessage_example` // string | login information message (optional) # string | login information message (optional) + fileStandard := BINARY_DATA_HERE // *os.File | png file with logo (optional) # *os.File | png file with logo (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.BrandingAPI.CreateBrandingItem(context.Background()).Name(name).ProductName(productName).Execute() + //resp, r, err := apiClient.V2025.BrandingAPI.CreateBrandingItem(context.Background()).Name(name).ProductName(productName).ActionButtonColor(actionButtonColor).ActiveLinkColor(activeLinkColor).NavigationColor(navigationColor).EmailFromAddress(emailFromAddress).LoginInformationalMessage(loginInformationalMessage).FileStandard(fileStandard).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.CreateBrandingItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateBrandingItem`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.CreateBrandingItem`: %v\n", resp) + } +- path: /brandings/{name} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/branding#delete-branding + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `default` // string | The name of the branding item to be deleted # string | The name of the branding item to be deleted + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.BrandingAPI.DeleteBranding(context.Background(), name).Execute() + //r, err := apiClient.V2025.BrandingAPI.DeleteBranding(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.DeleteBranding``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /brandings/{name} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/branding#get-branding + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `default` // string | The name of the branding item to be retrieved # string | The name of the branding item to be retrieved + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.BrandingAPI.GetBranding(context.Background(), name).Execute() + //resp, r, err := apiClient.V2025.BrandingAPI.GetBranding(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.GetBranding``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBranding`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.GetBranding`: %v\n", resp) + } +- path: /brandings + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/branding#get-branding-list + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.BrandingAPI.GetBrandingList(context.Background()).Execute() + //resp, r, err := apiClient.V2025.BrandingAPI.GetBrandingList(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.GetBrandingList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBrandingList`: []BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.GetBrandingList`: %v\n", resp) + } +- path: /brandings/{name} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/branding#set-branding-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `default` // string | The name of the branding item to be retrieved # string | The name of the branding item to be retrieved + name2 := `name_example` // string | name of branding item # string | name of branding item + productName := `productName_example` // string | product name # string | product name + actionButtonColor := `actionButtonColor_example` // string | hex value of color for action button (optional) # string | hex value of color for action button (optional) + activeLinkColor := `activeLinkColor_example` // string | hex value of color for link (optional) # string | hex value of color for link (optional) + navigationColor := `navigationColor_example` // string | hex value of color for navigation bar (optional) # string | hex value of color for navigation bar (optional) + emailFromAddress := `emailFromAddress_example` // string | email from address (optional) # string | email from address (optional) + loginInformationalMessage := `loginInformationalMessage_example` // string | login information message (optional) # string | login information message (optional) + fileStandard := BINARY_DATA_HERE // *os.File | png file with logo (optional) # *os.File | png file with logo (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.BrandingAPI.SetBrandingItem(context.Background(), name).Name2(name2).ProductName(productName).Execute() + //resp, r, err := apiClient.V2025.BrandingAPI.SetBrandingItem(context.Background(), name).Name2(name2).ProductName(productName).ActionButtonColor(actionButtonColor).ActiveLinkColor(activeLinkColor).NavigationColor(navigationColor).EmailFromAddress(emailFromAddress).LoginInformationalMessage(loginInformationalMessage).FileStandard(fileStandard).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.SetBrandingItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetBrandingItem`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.SetBrandingItem`: %v\n", resp) + } +- path: /campaign-filters + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaign-filters#create-campaign-filter + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + campaignfilterdetails := []byte(`{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + }`) // CampaignFilterDetails | + + + var campaignFilterDetails v2025.CampaignFilterDetails + if err := json.Unmarshal(campaignfilterdetails, &campaignFilterDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignFiltersAPI.CreateCampaignFilter(context.Background()).CampaignFilterDetails(campaignFilterDetails).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignFiltersAPI.CreateCampaignFilter(context.Background()).CampaignFilterDetails(campaignFilterDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.CreateCampaignFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaignFilter`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.CreateCampaignFilter`: %v\n", resp) + } +- path: /campaign-filters/delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaign-filters#delete-campaign-filters + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestbody := []byte(``) // []string | A json list of IDs of campaign filters to delete. + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.CertificationCampaignFiltersAPI.DeleteCampaignFilters(context.Background()).RequestBody(requestBody).Execute() + //r, err := apiClient.V2025.CertificationCampaignFiltersAPI.DeleteCampaignFilters(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.DeleteCampaignFilters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /campaign-filters/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaign-filters#get-campaign-filter-by-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e9f9a1397b842fd5a65842087040d3ac` // string | The ID of the campaign filter to be retrieved. # string | The ID of the campaign filter to be retrieved. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignFiltersAPI.GetCampaignFilterById(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignFiltersAPI.GetCampaignFilterById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.GetCampaignFilterById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignFilterById`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.GetCampaignFilterById`: %v\n", resp) + } +- path: /campaign-filters + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaign-filters#list-campaign-filters + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + start := 0 // int32 | Start/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 | Start/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) + includeSystemFilters := true // bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to true) # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignFiltersAPI.ListCampaignFilters(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignFiltersAPI.ListCampaignFilters(context.Background()).Limit(limit).Start(start).IncludeSystemFilters(includeSystemFilters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.ListCampaignFilters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCampaignFilters`: ListCampaignFilters200Response + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.ListCampaignFilters`: %v\n", resp) + } +- path: /campaign-filters/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaign-filters#update-campaign-filter + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filterId := `e9f9a1397b842fd5a65842087040d3ac` // string | The ID of the campaign filter being modified. # string | The ID of the campaign filter being modified. + campaignfilterdetails := []byte(`{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + }`) // CampaignFilterDetails | A campaign filter details with updated field values. + + + var campaignFilterDetails v2025.CampaignFilterDetails + if err := json.Unmarshal(campaignfilterdetails, &campaignFilterDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignFiltersAPI.UpdateCampaignFilter(context.Background(), filterId).CampaignFilterDetails(campaignFilterDetails).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignFiltersAPI.UpdateCampaignFilter(context.Background(), filterId).CampaignFilterDetails(campaignFilterDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.UpdateCampaignFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCampaignFilter`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.UpdateCampaignFilter`: %v\n", resp) + } +- path: /campaigns/{id}/complete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#complete-campaign + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Campaign ID. # string | Campaign ID. + campaigncompleteoptions := []byte(`{ + "autoCompleteAction" : "REVOKE" + }`) // CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.CompleteCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.CompleteCampaign(context.Background(), id).CampaignCompleteOptions(campaignCompleteOptions).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CompleteCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompleteCampaign`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CompleteCampaign`: %v\n", resp) + } +- path: /campaigns + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#create-campaign + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + campaign := []byte(`{ + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }`) // Campaign | + + + var campaign v2025.Campaign + if err := json.Unmarshal(campaign, &campaign); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.CreateCampaign(context.Background()).Campaign(campaign).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.CreateCampaign(context.Background()).Campaign(campaign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CreateCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaign`: Campaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CreateCampaign`: %v\n", resp) + } +- path: /campaign-templates + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#create-campaign-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + campaigntemplate := []byte(`{ + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "reviewerId" : "2c91808568c529c60168cca6f90c1313", + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + }`) // CampaignTemplate | + + + var campaignTemplate v2025.CampaignTemplate + if err := json.Unmarshal(campaigntemplate, &campaignTemplate); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.CreateCampaignTemplate(context.Background()).CampaignTemplate(campaignTemplate).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.CreateCampaignTemplate(context.Background()).CampaignTemplate(campaignTemplate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CreateCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CreateCampaignTemplate`: %v\n", resp) + } +- path: /campaign-templates/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#delete-campaign-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template being deleted. # string | ID of the campaign template being deleted. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.CertificationCampaignsAPI.DeleteCampaignTemplate(context.Background(), id).Execute() + //r, err := apiClient.V2025.CertificationCampaignsAPI.DeleteCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /campaign-templates/{id}/schedule + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#delete-campaign-template-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template whose schedule is being deleted. # string | ID of the campaign template whose schedule is being deleted. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.CertificationCampaignsAPI.DeleteCampaignTemplateSchedule(context.Background(), id).Execute() + //r, err := apiClient.V2025.CertificationCampaignsAPI.DeleteCampaignTemplateSchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /campaigns/delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#delete-campaigns + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + campaignsdeleterequest := []byte(`{ + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + }`) // CampaignsDeleteRequest | IDs of the campaigns to delete. + + + var campaignsDeleteRequest v2025.CampaignsDeleteRequest + if err := json.Unmarshal(campaignsdeleterequest, &campaignsDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).CampaignsDeleteRequest(campaignsDeleteRequest).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).CampaignsDeleteRequest(campaignsDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaigns``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteCampaigns`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.DeleteCampaigns`: %v\n", resp) + } +- path: /campaigns + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#get-active-campaigns + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Manager Campaign"` // 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* **status**: *eq, in* (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* **status**: *eq, in* (optional) + sorters := `name` // 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, created** (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, created** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetActiveCampaigns(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetActiveCampaigns(context.Background()).Detail(detail).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetActiveCampaigns``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetActiveCampaigns`: []GetActiveCampaigns200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetActiveCampaigns`: %v\n", resp) + } +- path: /campaigns/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#get-campaign + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign to be retrieved. # string | ID of the campaign to be retrieved. + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaign(context.Background(), id).Detail(detail).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaign`: GetCampaign200Response + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaign`: %v\n", resp) + } +- path: /campaigns/{id}/reports + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#get-campaign-reports + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign whose reports are being fetched. # string | ID of the campaign whose reports are being fetched. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignReports(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignReports(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignReports``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignReports`: []CampaignReport + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignReports`: %v\n", resp) + } +- path: /campaigns/reports-configuration + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#get-campaign-reports-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignReportsConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignReportsConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignReportsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignReportsConfig`: CampaignReportsConfig + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignReportsConfig`: %v\n", resp) + } +- path: /campaign-templates/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#get-campaign-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Requested campaign template's ID. # string | Requested campaign template's ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplate`: %v\n", resp) + } +- path: /campaign-templates/{id}/schedule + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#get-campaign-template-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template whose schedule is being fetched. # string | ID of the campaign template whose schedule is being fetched. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignTemplateSchedule(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignTemplateSchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplateSchedule`: Schedule + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplateSchedule`: %v\n", resp) + } +- path: /campaign-templates + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#get-campaign-templates + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name` // 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, created, modified** (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, created, modified** (optional) + filters := `name eq "manager template"` // 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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignTemplates(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.GetCampaignTemplates(context.Background()).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplates`: []CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplates`: %v\n", resp) + } +- path: /campaigns/{id}/reassign + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#move + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification campaign ID # string | The certification campaign ID + adminreviewreassign := []byte(`{ + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + }`) // AdminReviewReassign | + + + var adminReviewReassign v2025.AdminReviewReassign + if err := json.Unmarshal(adminreviewreassign, &adminReviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.Move(context.Background(), id).AdminReviewReassign(adminReviewReassign).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.Move(context.Background(), id).AdminReviewReassign(adminReviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.Move``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `Move`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.Move`: %v\n", resp) + } +- path: /campaign-templates/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#patch-campaign-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template being modified. # string | ID of the campaign template being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/campaign/filter/id, value=ff80818155fe8c080155fe8d925b0316}]`) // []JsonPatchOperation | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.PatchCampaignTemplate(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.PatchCampaignTemplate(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.PatchCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.PatchCampaignTemplate`: %v\n", resp) + } +- path: /campaigns/reports-configuration + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#set-campaign-reports-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + campaignreportsconfig := []byte(`{ + "identityAttributeColumns" : [ "firstname", "lastname" ] + }`) // CampaignReportsConfig | Campaign report configuration. + + + var campaignReportsConfig v2025.CampaignReportsConfig + if err := json.Unmarshal(campaignreportsconfig, &campaignReportsConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.SetCampaignReportsConfig(context.Background()).CampaignReportsConfig(campaignReportsConfig).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.SetCampaignReportsConfig(context.Background()).CampaignReportsConfig(campaignReportsConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.SetCampaignReportsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetCampaignReportsConfig`: CampaignReportsConfig + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.SetCampaignReportsConfig`: %v\n", resp) + } +- path: /campaign-templates/{id}/schedule + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#set-campaign-template-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template being scheduled. # string | ID of the campaign template being scheduled. + schedule := []byte(`{ + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + }`) // Schedule | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.CertificationCampaignsAPI.SetCampaignTemplateSchedule(context.Background(), id).Execute() + //r, err := apiClient.V2025.CertificationCampaignsAPI.SetCampaignTemplateSchedule(context.Background(), id).Schedule(schedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.SetCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /campaigns/{id}/activate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#start-campaign + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Campaign ID. # string | Campaign ID. + activatecampaignoptions := []byte(`{ + "timeZone" : "-05:00" + }`) // ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.StartCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.StartCampaign(context.Background(), id).ActivateCampaignOptions(activateCampaignOptions).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaign`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaign`: %v\n", resp) + } +- path: /campaigns/{id}/run-remediation-scan + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#start-campaign-remediation-scan + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign the remediation scan is being run for. # string | ID of the campaign the remediation scan is being run for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.StartCampaignRemediationScan(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.StartCampaignRemediationScan(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaignRemediationScan``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaignRemediationScan`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaignRemediationScan`: %v\n", resp) + } +- path: /campaigns/{id}/run-report/{type} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#start-campaign-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign the report is being run for. # string | ID of the campaign the report is being run for. + type_ := // ReportType | Type of the report to run. # ReportType | Type of the report to run. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.StartCampaignReport(context.Background(), id, type_).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.StartCampaignReport(context.Background(), id, type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaignReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaignReport`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaignReport`: %v\n", resp) + } +- path: /campaign-templates/{id}/generate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#start-generate-campaign-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template to use for generation. # string | ID of the campaign template to use for generation. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.StartGenerateCampaignTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.StartGenerateCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartGenerateCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartGenerateCampaignTemplate`: CampaignReference + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartGenerateCampaignTemplate`: %v\n", resp) + } +- path: /campaigns/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-campaigns#update-campaign + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign template being modified. # string | ID of the campaign template being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]`) // []JsonPatchOperation | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationCampaignsAPI.UpdateCampaign(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.CertificationCampaignsAPI.UpdateCampaign(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.UpdateCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCampaign`: SlimCampaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.UpdateCampaign`: %v\n", resp) + } +- path: /certification-tasks/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certifications#get-certification-task + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `63b32151-26c0-42f4-9299-8898dc1c9daa` // string | The task ID # string | The task ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.GetCertificationTask(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.GetCertificationTask(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetCertificationTask``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCertificationTask`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetCertificationTask`: %v\n", resp) + } +- path: /certifications/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certifications#get-identity-certification + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification id # string | The certification id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.GetIdentityCertification(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.GetIdentityCertification(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertification`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertification`: %v\n", resp) + } +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certifications#get-identity-certification-item-permissions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + certificationId := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification ID + itemId := `2c91808671bcbab40171bd945d961227` // string | The certification item ID # string | The certification item ID + filters := `target eq "SYS.OBJAUTH2"` // 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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.GetIdentityCertificationItemPermissions(context.Background(), certificationId, itemId).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.GetIdentityCertificationItemPermissions(context.Background(), certificationId, itemId).Filters(filters).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertificationItemPermissions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertificationItemPermissions`: []PermissionDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertificationItemPermissions`: %v\n", resp) + } +- path: /certification-tasks + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certifications#get-pending-certification-tasks + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reviewerIdentity := `Ada.1de82e55078344` // string | The ID of reviewer identity. *me* indicates the current user. (optional) # string | The ID of reviewer identity. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `type eq "ADMIN_REASSIGN"` // 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* **targetId**: *eq, in* **type**: *eq, in* (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* **targetId**: *eq, in* **type**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.GetPendingCertificationTasks(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.GetPendingCertificationTasks(context.Background()).ReviewerIdentity(reviewerIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetPendingCertificationTasks``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPendingCertificationTasks`: []CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetPendingCertificationTasks`: %v\n", resp) + } +- path: /certifications/{id}/reviewers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certifications#list-certification-reviewers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Bob"` // 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* **email**: *eq, sw* (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* **email**: *eq, sw* (optional) + sorters := `name` // 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, email** (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, email** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.ListCertificationReviewers(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.ListCertificationReviewers(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListCertificationReviewers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCertificationReviewers`: []IdentityReferenceWithNameAndEmail + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListCertificationReviewers`: %v\n", resp) + } +- path: /certifications/{id}/access-review-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certifications#list-identity-access-review-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters := `access.name,-accessProfile.sourceName` // 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) + entitlements := `identityEntitlement` // string | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) + accessProfiles := `accessProfile1` // string | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) + roles := `userRole` // string | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.ListIdentityAccessReviewItems(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.ListIdentityAccessReviewItems(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Entitlements(entitlements).AccessProfiles(accessProfiles).Roles(roles).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListIdentityAccessReviewItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityAccessReviewItems`: []AccessReviewItem + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListIdentityAccessReviewItems`: %v\n", resp) + } +- path: /certifications + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certifications#list-identity-certifications + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reviewerIdentity := `me` // string | Reviewer's identity. *me* indicates the current user. (optional) # string | Reviewer's identity. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) + sorters := `name,due` // 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, due, signed** (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, due, signed** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.ListIdentityCertifications(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.ListIdentityCertifications(context.Background()).ReviewerIdentity(reviewerIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListIdentityCertifications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityCertifications`: []IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListIdentityCertifications`: %v\n", resp) + } +- path: /certifications/{id}/decide + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certifications#make-identity-decision + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the identity campaign certification on which to make decisions # string | The ID of the identity campaign certification on which to make decisions + reviewdecision := []byte(`[{id=ef38f94347e94562b5bb8424a56396b5, decision=APPROVE, bulk=true, comments=This user still needs access to this source.}, {id=ef38f94347e94562b5bb8424a56397d8, decision=APPROVE, bulk=true, comments=This user still needs access to this source too.}]`) // []ReviewDecision | A non-empty array of decisions to be made. + + + var reviewDecision v2025.[]ReviewDecision + if err := json.Unmarshal(reviewdecision, &reviewDecision); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.MakeIdentityDecision(context.Background(), id).ReviewDecision(reviewDecision).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.MakeIdentityDecision(context.Background(), id).ReviewDecision(reviewDecision).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.MakeIdentityDecision``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `MakeIdentityDecision`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.MakeIdentityDecision`: %v\n", resp) + } +- path: /certifications/{id}/reassign + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certifications#reassign-identity-certifications + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + reviewreassign := []byte(`{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + }`) // ReviewReassign | + + + var reviewReassign v2025.ReviewReassign + if err := json.Unmarshal(reviewreassign, &reviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.ReassignIdentityCertifications(context.Background(), id).ReviewReassign(reviewReassign).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.ReassignIdentityCertifications(context.Background(), id).ReviewReassign(reviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ReassignIdentityCertifications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ReassignIdentityCertifications`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ReassignIdentityCertifications`: %v\n", resp) + } +- path: /certifications/{id}/sign-off + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certifications#sign-off-identity-certification + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.SignOffIdentityCertification(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.SignOffIdentityCertification(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.SignOffIdentityCertification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SignOffIdentityCertification`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.SignOffIdentityCertification`: %v\n", resp) + } +- path: /certifications/{id}/reassign-async + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certifications#submit-reassign-certs-async + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + reviewreassign := []byte(`{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + }`) // ReviewReassign | + + + var reviewReassign v2025.ReviewReassign + if err := json.Unmarshal(reviewreassign, &reviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationsAPI.SubmitReassignCertsAsync(context.Background(), id).ReviewReassign(reviewReassign).Execute() + //resp, r, err := apiClient.V2025.CertificationsAPI.SubmitReassignCertsAsync(context.Background(), id).ReviewReassign(reviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.SubmitReassignCertsAsync``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitReassignCertsAsync`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.SubmitReassignCertsAsync`: %v\n", resp) + } +- path: /certifications/{id}/access-summaries/{type} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-summaries#get-identity-access-summaries + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + type_ := `ACCESS_PROFILE` // string | The type of access review item to retrieve summaries for # string | The type of access review item to retrieve summaries for + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "ef38f94347e94562b5bb8424a56397d8"` // 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters := `access.name` // 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: **access.name** (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: **access.name** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationSummariesAPI.GetIdentityAccessSummaries(context.Background(), id, type_).Execute() + //resp, r, err := apiClient.V2025.CertificationSummariesAPI.GetIdentityAccessSummaries(context.Background(), id, type_).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentityAccessSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityAccessSummaries`: []AccessSummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentityAccessSummaries`: %v\n", resp) + } +- path: /certifications/{id}/decision-summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-summaries#get-identity-decision-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification ID + filters := `identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"` // 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: **identitySummary.id**: *eq, in* (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: **identitySummary.id**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationSummariesAPI.GetIdentityDecisionSummary(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationSummariesAPI.GetIdentityDecisionSummary(context.Background(), id).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentityDecisionSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityDecisionSummary`: IdentityCertDecisionSummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentityDecisionSummary`: %v\n", resp) + } +- path: /certifications/{id}/identity-summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-summaries#get-identity-summaries + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **completed**: *eq, ne* **name**: *eq, sw* (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* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters := `name` // 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** (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** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationSummariesAPI.GetIdentitySummaries(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.CertificationSummariesAPI.GetIdentitySummaries(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentitySummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySummaries`: []CertificationIdentitySummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentitySummaries`: %v\n", resp) + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/certification-summaries#get-identity-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + identitySummaryId := `2c91808772a504f50172a9540e501ba8` // string | The identity summary ID # string | The identity summary ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CertificationSummariesAPI.GetIdentitySummary(context.Background(), id, identitySummaryId).Execute() + //resp, r, err := apiClient.V2025.CertificationSummariesAPI.GetIdentitySummary(context.Background(), id, identitySummaryId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentitySummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySummary`: CertificationIdentitySummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentitySummary`: %v\n", resp) + } +- path: /configuration-hub/deploys + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#create-deploy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + deployrequest := []byte(`{ + "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" + }`) // DeployRequest | The deploy request body. + + + var deployRequest v2025.DeployRequest + if err := json.Unmarshal(deployrequest, &deployRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateDeploy(context.Background()).DeployRequest(deployRequest).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateDeploy(context.Background()).DeployRequest(deployRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateDeploy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDeploy`: DeployResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateDeploy`: %v\n", resp) + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#create-object-mapping + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingrequest := []byte(`{ + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }`) // ObjectMappingRequest | The object mapping request body. + + + var objectMappingRequest v2025.ObjectMappingRequest + if err := json.Unmarshal(objectmappingrequest, &objectMappingRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateObjectMapping(context.Background(), sourceOrg).ObjectMappingRequest(objectMappingRequest).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateObjectMapping(context.Background(), sourceOrg).ObjectMappingRequest(objectMappingRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateObjectMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateObjectMapping`: ObjectMappingResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateObjectMapping`: %v\n", resp) + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#create-object-mappings + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingbulkcreaterequest := []byte(`{ + "newObjectsMappings" : [ { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }, { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } ] + }`) // ObjectMappingBulkCreateRequest | The bulk create object mapping request body. + + + var objectMappingBulkCreateRequest v2025.ObjectMappingBulkCreateRequest + if err := json.Unmarshal(objectmappingbulkcreaterequest, &objectMappingBulkCreateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkCreateRequest(objectMappingBulkCreateRequest).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkCreateRequest(objectMappingBulkCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateObjectMappings`: ObjectMappingBulkCreateResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateObjectMappings`: %v\n", resp) + } +- path: /configuration-hub/scheduled-actions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#create-scheduled-action + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scheduledactionpayload := []byte(`{ + "cronString" : "0 0 * * * *", + "timeZoneId" : "America/Chicago", + "startTime" : "2024-08-16T14:16:58.389Z", + "jobType" : "BACKUP", + "content" : { + "sourceTenant" : "tenant-name", + "draftId" : "9012b87d-48ca-439a-868f-2160001da8c3", + "name" : "Daily Backup", + "backupOptions" : { + "includeTypes" : [ "ROLE", "IDENTITY_PROFILE" ], + "objectOptions" : { + "SOURCE" : { + "includedNames" : [ "Source1", "Source2" ] + }, + "ROLE" : { + "includedNames" : [ "Admin Role", "User Role" ] + } + } + }, + "sourceBackupId" : "5678b87d-48ca-439a-868f-2160001da8c2" + } + }`) // ScheduledActionPayload | The scheduled action creation request body. + + + var scheduledActionPayload v2025.ScheduledActionPayload + if err := json.Unmarshal(scheduledactionpayload, &scheduledActionPayload); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateScheduledAction(context.Background()).ScheduledActionPayload(scheduledActionPayload).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateScheduledAction(context.Background()).ScheduledActionPayload(scheduledActionPayload).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateScheduledAction``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateScheduledAction`: ScheduledActionResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateScheduledAction`: %v\n", resp) + } +- path: /configuration-hub/backups/uploads + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#create-uploaded-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + data := BINARY_DATA_HERE // *os.File | JSON file containing the objects to be imported. # *os.File | JSON file containing the objects to be imported. + name := `name_example` // string | Name that will be assigned to the uploaded configuration file. # string | Name that will be assigned to the uploaded configuration file. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateUploadedConfiguration(context.Background()).Data(data).Name(name).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.CreateUploadedConfiguration(context.Background()).Data(data).Name(name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateUploadedConfiguration`: BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateUploadedConfiguration`: %v\n", resp) + } +- path: /configuration-hub/backups/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#delete-backup + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `07659d7d-2cce-47c0-9e49-185787ee565a` // string | The id of the backup to delete. # string | The id of the backup to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ConfigurationHubAPI.DeleteBackup(context.Background(), id).Execute() + //r, err := apiClient.V2025.ConfigurationHubAPI.DeleteBackup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteBackup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /configuration-hub/drafts/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#delete-draft + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `07659d7d-2cce-47c0-9e49-185787ee565a` // string | The id of the draft to delete. # string | The id of the draft to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ConfigurationHubAPI.DeleteDraft(context.Background(), id).Execute() + //r, err := apiClient.V2025.ConfigurationHubAPI.DeleteDraft(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteDraft``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#delete-object-mapping + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectMappingId := `3d6e0144-963f-4bd6-8d8d-d77b4e507ce4` // string | The id of the object mapping to be deleted. # string | The id of the object mapping to be deleted. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ConfigurationHubAPI.DeleteObjectMapping(context.Background(), sourceOrg, objectMappingId).Execute() + //r, err := apiClient.V2025.ConfigurationHubAPI.DeleteObjectMapping(context.Background(), sourceOrg, objectMappingId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteObjectMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /configuration-hub/scheduled-actions/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#delete-scheduled-action + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scheduledActionId := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | The ID of the scheduled action. # string | The ID of the scheduled action. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ConfigurationHubAPI.DeleteScheduledAction(context.Background(), scheduledActionId).Execute() + //r, err := apiClient.V2025.ConfigurationHubAPI.DeleteScheduledAction(context.Background(), scheduledActionId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteScheduledAction``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /configuration-hub/backups/uploads/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#delete-uploaded-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `3d0fe04b-57df-4a46-a83b-8f04b0f9d10b` // string | The id of the uploaded configuration. # string | The id of the uploaded configuration. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ConfigurationHubAPI.DeleteUploadedConfiguration(context.Background(), id).Execute() + //r, err := apiClient.V2025.ConfigurationHubAPI.DeleteUploadedConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /configuration-hub/deploys/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#get-deploy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `3d0fe04b-57df-4a46-a83b-8f04b0f9d10b` // string | The id of the deploy. # string | The id of the deploy. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.GetDeploy(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.GetDeploy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.GetDeploy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDeploy`: DeployResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.GetDeploy`: %v\n", resp) + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#get-object-mappings + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.GetObjectMappings(context.Background(), sourceOrg).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.GetObjectMappings(context.Background(), sourceOrg).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.GetObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetObjectMappings`: []ObjectMappingResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.GetObjectMappings`: %v\n", resp) + } +- path: /configuration-hub/backups/uploads/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#get-uploaded-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `3d0fe04b-57df-4a46-a83b-8f04b0f9d10b` // string | The id of the uploaded configuration. # string | The id of the uploaded configuration. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.GetUploadedConfiguration(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.GetUploadedConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.GetUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUploadedConfiguration`: BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.GetUploadedConfiguration`: %v\n", resp) + } +- path: /configuration-hub/backups + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#list-backups + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filters := `status eq "COMPLETE"` // 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: **status**: *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: **status**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListBackups(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListBackups(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListBackups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListBackups`: []BackupResponse1 + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListBackups`: %v\n", resp) + } +- path: /configuration-hub/deploys + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#list-deploys + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListDeploys(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListDeploys(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListDeploys``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDeploys`: ListDeploys200Response + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListDeploys`: %v\n", resp) + } +- path: /configuration-hub/drafts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#list-drafts + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filters := `status eq "COMPLETE"` // 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: **status**: *eq* **approvalStatus**: *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: **status**: *eq* **approvalStatus**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListDrafts(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListDrafts(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListDrafts``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDrafts`: []DraftResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListDrafts`: %v\n", resp) + } +- path: /configuration-hub/scheduled-actions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#list-scheduled-actions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListScheduledActions(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListScheduledActions(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListScheduledActions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListScheduledActions`: []ScheduledActionResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListScheduledActions`: %v\n", resp) + } +- path: /configuration-hub/backups/uploads + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#list-uploaded-configurations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filters := `status eq "COMPLETE"` // 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: **status**: *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: **status**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListUploadedConfigurations(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.ListUploadedConfigurations(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListUploadedConfigurations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListUploadedConfigurations`: []BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListUploadedConfigurations`: %v\n", resp) + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#update-object-mappings + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingbulkpatchrequest := []byte(`{ + "patches" : { + "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : true + } ], + "00bece34-f50d-4227-8878-76f620b5a971" : [ { + "op" : "replace", + "path" : "/targetValue", + "value" : "New Target Value" + } ] + } + }`) // ObjectMappingBulkPatchRequest | The object mapping request body. + + + var objectMappingBulkPatchRequest v2025.ObjectMappingBulkPatchRequest + if err := json.Unmarshal(objectmappingbulkpatchrequest, &objectMappingBulkPatchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.UpdateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkPatchRequest(objectMappingBulkPatchRequest).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.UpdateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkPatchRequest(objectMappingBulkPatchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.UpdateObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateObjectMappings`: ObjectMappingBulkPatchResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.UpdateObjectMappings`: %v\n", resp) + } +- path: /configuration-hub/scheduled-actions/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/configuration-hub#update-scheduled-action + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scheduledActionId := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | The ID of the scheduled action. # string | The ID of the scheduled action. + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | The JSON Patch document containing the changes to apply to the scheduled action. + + + var jsonPatch v2025.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConfigurationHubAPI.UpdateScheduledAction(context.Background(), scheduledActionId).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2025.ConfigurationHubAPI.UpdateScheduledAction(context.Background(), scheduledActionId).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.UpdateScheduledAction``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateScheduledAction`: ScheduledActionResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.UpdateScheduledAction`: %v\n", resp) + } +- path: /connector-customizers + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connector-customizers#create-connector-customizer + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + connectorcustomizercreaterequest := []byte(`{ + "name" : "My Custom Connector" + }`) // ConnectorCustomizerCreateRequest | Connector customizer to create. + + + var connectorCustomizerCreateRequest v2025.ConnectorCustomizerCreateRequest + if err := json.Unmarshal(connectorcustomizercreaterequest, &connectorCustomizerCreateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.CreateConnectorCustomizer(context.Background()).ConnectorCustomizerCreateRequest(connectorCustomizerCreateRequest).Execute() + //resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.CreateConnectorCustomizer(context.Background()).ConnectorCustomizerCreateRequest(connectorCustomizerCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.CreateConnectorCustomizer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateConnectorCustomizer`: ConnectorCustomizerCreateResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.CreateConnectorCustomizer`: %v\n", resp) + } +- path: /connector-customizers/{id}/versions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connector-customizers#create-connector-customizer-version + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | The id of the connector customizer. # string | The id of the connector customizer. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.CreateConnectorCustomizerVersion(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.CreateConnectorCustomizerVersion(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.CreateConnectorCustomizerVersion``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateConnectorCustomizerVersion`: ConnectorCustomizerVersionCreateResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.CreateConnectorCustomizerVersion`: %v\n", resp) + } +- path: /connector-customizers/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connector-customizers#delete-connector-customizer + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | ID of the connector customizer to delete. # string | ID of the connector customizer to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ConnectorCustomizersAPI.DeleteConnectorCustomizer(context.Background(), id).Execute() + //r, err := apiClient.V2025.ConnectorCustomizersAPI.DeleteConnectorCustomizer(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.DeleteConnectorCustomizer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /connector-customizers/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connector-customizers#get-connector-customizer + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | ID of the connector customizer to get. # string | ID of the connector customizer to get. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.GetConnectorCustomizer(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.GetConnectorCustomizer(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.GetConnectorCustomizer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorCustomizer`: ConnectorCustomizersResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.GetConnectorCustomizer`: %v\n", resp) + } +- path: /connector-customizers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connector-customizers#list-connector-customizers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.ListConnectorCustomizers(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.ListConnectorCustomizers(context.Background()).Offset(offset).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.ListConnectorCustomizers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListConnectorCustomizers`: []ConnectorCustomizersResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.ListConnectorCustomizers`: %v\n", resp) + } +- path: /connector-customizers/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connector-customizers#put-connector-customizer + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | ID of the connector customizer to update. # string | ID of the connector customizer to update. + connectorcustomizerupdaterequest := []byte(`{ + "name" : "My Custom Connector" + }`) // ConnectorCustomizerUpdateRequest | Connector rule with updated data. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.PutConnectorCustomizer(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ConnectorCustomizersAPI.PutConnectorCustomizer(context.Background(), id).ConnectorCustomizerUpdateRequest(connectorCustomizerUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorCustomizersAPI.PutConnectorCustomizer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorCustomizer`: ConnectorCustomizerUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorCustomizersAPI.PutConnectorCustomizer`: %v\n", resp) + } +- path: /connector-rules + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connector-rule-management#create-connector-rule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + connectorrulecreaterequest := []byte(`{ + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "type" : "BuildMap" + }`) // ConnectorRuleCreateRequest | Connector rule to create. + + + var connectorRuleCreateRequest v2025.ConnectorRuleCreateRequest + if err := json.Unmarshal(connectorrulecreaterequest, &connectorRuleCreateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.CreateConnectorRule(context.Background()).ConnectorRuleCreateRequest(connectorRuleCreateRequest).Execute() + //resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.CreateConnectorRule(context.Background()).ConnectorRuleCreateRequest(connectorRuleCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.CreateConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.CreateConnectorRule`: %v\n", resp) + } +- path: /connector-rules/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connector-rule-management#delete-connector-rule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to delete. # string | ID of the connector rule to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ConnectorRuleManagementAPI.DeleteConnectorRule(context.Background(), id).Execute() + //r, err := apiClient.V2025.ConnectorRuleManagementAPI.DeleteConnectorRule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.DeleteConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /connector-rules/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connector-rule-management#get-connector-rule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to get. # string | ID of the connector rule to get. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.GetConnectorRule(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.GetConnectorRule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.GetConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.GetConnectorRule`: %v\n", resp) + } +- path: /connector-rules + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connector-rule-management#get-connector-rule-list + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.GetConnectorRuleList(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.GetConnectorRuleList(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.GetConnectorRuleList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorRuleList`: []ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.GetConnectorRuleList`: %v\n", resp) + } +- path: /connector-rules/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connector-rule-management#put-connector-rule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | ID of the connector rule to update. # string | ID of the connector rule to update. + connectorruleupdaterequest := []byte(`{ + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", + "type" : "BuildMap" + }`) // ConnectorRuleUpdateRequest | Connector rule with updated data. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.PutConnectorRule(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.PutConnectorRule(context.Background(), id).ConnectorRuleUpdateRequest(connectorRuleUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.PutConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorRule`: ConnectorRuleResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.PutConnectorRule`: %v\n", resp) + } +- path: /connector-rules/validate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connector-rule-management#test-connector-rule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourcecode := []byte(`{ + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }`) // SourceCode | Code to validate. + + + var sourceCode v2025.SourceCode + if err := json.Unmarshal(sourcecode, &sourceCode); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.TestConnectorRule(context.Background()).SourceCode(sourceCode).Execute() + //resp, r, err := apiClient.V2025.ConnectorRuleManagementAPI.TestConnectorRule(context.Background()).SourceCode(sourceCode).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorRuleManagementAPI.TestConnectorRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestConnectorRule`: ConnectorRuleValidationResponse + fmt.Fprintf(os.Stdout, "Response from `ConnectorRuleManagementAPI.TestConnectorRule`: %v\n", resp) + } +- path: /connectors + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connectors#create-custom-connector + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + v3createconnectordto := []byte(`{ + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + }`) // V3CreateConnectorDto | + + + var v3CreateConnectorDto v2025.V3CreateConnectorDto + if err := json.Unmarshal(v3createconnectordto, &v3CreateConnectorDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.CreateCustomConnector(context.Background()).V3CreateConnectorDto(v3CreateConnectorDto).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.CreateCustomConnector(context.Background()).V3CreateConnectorDto(v3CreateConnectorDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.CreateCustomConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCustomConnector`: V3ConnectorDto + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.CreateCustomConnector`: %v\n", resp) + } +- path: /connectors/{scriptName} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connectors#delete-custom-connector + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ConnectorsAPI.DeleteCustomConnector(context.Background(), scriptName).Execute() + //r, err := apiClient.V2025.ConnectorsAPI.DeleteCustomConnector(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.DeleteCustomConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /connectors/{scriptName} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connectors#get-connector + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnector(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnector(context.Background(), scriptName).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnector`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnector`: %v\n", resp) + } +- path: /connectors/{scriptName}/correlation-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connectors#get-connector-correlation-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorCorrelationConfig(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorCorrelationConfig(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorCorrelationConfig`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorCorrelationConfig`: %v\n", resp) + } +- path: /connectors + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connectors#get-connector-list + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filters := `directConnect eq "true"` // 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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorList(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorList(context.Background()).Filters(filters).Limit(limit).Offset(offset).Count(count).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorList`: []V3ConnectorDto + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorList`: %v\n", resp) + } +- path: /connectors/{scriptName}/source-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connectors#get-connector-source-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorSourceConfig(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorSourceConfig(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorSourceConfig`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorSourceConfig`: %v\n", resp) + } +- path: /connectors/{scriptName}/source-template + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connectors#get-connector-source-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorSourceTemplate(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorSourceTemplate(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorSourceTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorSourceTemplate`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorSourceTemplate`: %v\n", resp) + } +- path: /connectors/{scriptName}/translations/{locale} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connectors#get-connector-translations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorTranslations(context.Background(), scriptName, locale).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.GetConnectorTranslations(context.Background(), scriptName, locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorTranslations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorTranslations`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorTranslations`: %v\n", resp) + } +- path: /connectors/{scriptName}/correlation-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connectors#put-connector-correlation-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + file := BINARY_DATA_HERE // *os.File | connector correlation config xml file # *os.File | connector correlation config xml file + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.PutConnectorCorrelationConfig(context.Background(), scriptName).File(file).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.PutConnectorCorrelationConfig(context.Background(), scriptName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorCorrelationConfig`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorCorrelationConfig`: %v\n", resp) + } +- path: /connectors/{scriptName}/source-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connectors#put-connector-source-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + file := BINARY_DATA_HERE // *os.File | connector source config xml file # *os.File | connector source config xml file + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.PutConnectorSourceConfig(context.Background(), scriptName).File(file).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.PutConnectorSourceConfig(context.Background(), scriptName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorSourceConfig`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorSourceConfig`: %v\n", resp) + } +- path: /connectors/{scriptName}/source-template + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connectors#put-connector-source-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + file := BINARY_DATA_HERE // *os.File | connector source template xml file # *os.File | connector source template xml file + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.PutConnectorSourceTemplate(context.Background(), scriptName).File(file).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.PutConnectorSourceTemplate(context.Background(), scriptName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorSourceTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorSourceTemplate`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorSourceTemplate`: %v\n", resp) + } +- path: /connectors/{scriptName}/translations/{locale} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connectors#put-connector-translations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.PutConnectorTranslations(context.Background(), scriptName, locale).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.PutConnectorTranslations(context.Background(), scriptName, locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorTranslations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorTranslations`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorTranslations`: %v\n", resp) + } +- path: /connectors/{scriptName} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/connectors#update-connector + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | A list of connector detail update operations + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ConnectorsAPI.UpdateConnector(context.Background(), scriptName).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.ConnectorsAPI.UpdateConnector(context.Background(), scriptName).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.UpdateConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateConnector`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.UpdateConnector`: %v\n", resp) + } +- path: /form-definitions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#create-form-definition + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + body := []byte(`{ + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + }`) // CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.CreateFormDefinition(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.CreateFormDefinition(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinition`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinition`: %v\n", resp) + } +- path: /form-definitions/forms-action-dynamic-schema + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#create-form-definition-dynamic-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + body := []byte(`{ + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 + }`) // FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.CreateFormDefinitionDynamicSchema(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.CreateFormDefinitionDynamicSchema(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinitionDynamicSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinitionDynamicSchema`: FormDefinitionDynamicSchemaResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinitionDynamicSchema`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID}/upload + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#create-form-definition-file-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | FormDefinitionID String specifying FormDefinitionID # string | FormDefinitionID String specifying FormDefinitionID + file := BINARY_DATA_HERE // *os.File | File specifying the multipart # *os.File | File specifying the multipart + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.CreateFormDefinitionFileRequest(context.Background(), formDefinitionID).File(file).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.CreateFormDefinitionFileRequest(context.Background(), formDefinitionID).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormDefinitionFileRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormDefinitionFileRequest`: FormDefinitionFileUploadResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormDefinitionFileRequest`: %v\n", resp) + } +- path: /form-instances + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#create-form-instance + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + body := []byte(`{ + "formInput" : { + "input1" : "Sales" + }, + "standAloneForm" : false, + "createdBy" : { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "WORKFLOW_EXECUTION" + }, + "recipients" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + } ], + "expire" : "2023-08-12T20:14:57.74486Z", + "formDefinitionId" : "00000000-0000-0000-0000-000000000000", + "state" : "ASSIGNED", + "ttl" : 1571827560 + }`) // CreateFormInstanceRequest | Body is the request payload to create a form instance (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.CreateFormInstance(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.CreateFormInstance(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.CreateFormInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFormInstance`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.CreateFormInstance`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#delete-form-definition + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.DeleteFormDefinition(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.DeleteFormDefinition(context.Background(), formDefinitionID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.DeleteFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteFormDefinition`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.DeleteFormDefinition`: %v\n", resp) + } +- path: /form-definitions/export + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#export-form-definitions-by-tenant + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + offset := 0 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `name sw "my form"` // 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + sorters := `name` // 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, description, created, modified** (optional) (default to "name") # 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, description, created, modified** (optional) (default to "name") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.ExportFormDefinitionsByTenant(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.ExportFormDefinitionsByTenant(context.Background()).Offset(offset).Limit(limit).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ExportFormDefinitionsByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportFormDefinitionsByTenant`: []ExportFormDefinitionsByTenant200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ExportFormDefinitionsByTenant`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID}/file/{fileID} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#get-file-from-s3 + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | FormDefinitionID Form definition ID # string | FormDefinitionID Form definition ID + fileID := `00000031N0J7R2B57M8YG73J7M.png` // string | FileID String specifying the hashed name of the uploaded file we are retrieving. # string | FileID String specifying the hashed name of the uploaded file we are retrieving. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.GetFileFromS3(context.Background(), formDefinitionID, fileID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.GetFileFromS3(context.Background(), formDefinitionID, fileID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFileFromS3``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFileFromS3`: *os.File + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFileFromS3`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#get-form-definition-by-key + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.GetFormDefinitionByKey(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.GetFormDefinitionByKey(context.Background(), formDefinitionID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormDefinitionByKey``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormDefinitionByKey`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormDefinitionByKey`: %v\n", resp) + } +- path: /form-instances/{formInstanceID} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#get-form-instance-by-key + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.GetFormInstanceByKey(context.Background(), formInstanceID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.GetFormInstanceByKey(context.Background(), formInstanceID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormInstanceByKey``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormInstanceByKey`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormInstanceByKey`: %v\n", resp) + } +- path: /form-instances/{formInstanceID}/file/{fileID} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#get-form-instance-file + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | FormInstanceID Form instance ID # string | FormInstanceID Form instance ID + fileID := `00000031N0J7R2B57M8YG73J7M.png` // string | FileID String specifying the hashed name of the uploaded file we are retrieving. # string | FileID String specifying the hashed name of the uploaded file we are retrieving. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.GetFormInstanceFile(context.Background(), formInstanceID, fileID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.GetFormInstanceFile(context.Background(), formInstanceID, fileID).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.GetFormInstanceFile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFormInstanceFile`: *os.File + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.GetFormInstanceFile`: %v\n", resp) + } +- path: /form-definitions/import + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#import-form-definitions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + body := []byte(`[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]`) // []ImportFormDefinitionsRequestInner | Body is the request payload to import form definitions (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.ImportFormDefinitions(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.ImportFormDefinitions(context.Background()).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ImportFormDefinitions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportFormDefinitions`: ImportFormDefinitions202Response + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ImportFormDefinitions`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#patch-form-definition + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + body := []byte(`[{op=replace, path=/description, value=test-description}]`) // []map[string]map[string]interface{} | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.PatchFormDefinition(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.PatchFormDefinition(context.Background(), formDefinitionID).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.PatchFormDefinition``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchFormDefinition`: FormDefinitionResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.PatchFormDefinition`: %v\n", resp) + } +- path: /form-instances/{formInstanceID} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#patch-form-instance + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + body := []byte(`[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]`) // []map[string]map[string]interface{} | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.PatchFormInstance(context.Background(), formInstanceID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.PatchFormInstance(context.Background(), formInstanceID).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.PatchFormInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchFormInstance`: FormInstanceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.PatchFormInstance`: %v\n", resp) + } +- path: /form-definitions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#search-form-definitions-by-tenant + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + offset := 250 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `name sw "my form"` // 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + sorters := `name` // 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, description, created, modified** (optional) (default to "name") # 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, description, created, modified** (optional) (default to "name") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.SearchFormDefinitionsByTenant(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.SearchFormDefinitionsByTenant(context.Background()).Offset(offset).Limit(limit).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormDefinitionsByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormDefinitionsByTenant`: ListFormDefinitionsByTenantResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormDefinitionsByTenant`: %v\n", resp) + } +- path: /form-instances/{formInstanceID}/data-source/{formElementID} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#search-form-element-data-by-element-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formInstanceID := `00000000-0000-0000-0000-000000000000` // string | Form instance ID # string | Form instance ID + formElementID := `1` // string | Form element ID # string | Form element ID + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters := `value eq "ID01"` // 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) + query := `support` // string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.SearchFormElementDataByElementID(context.Background(), formInstanceID, formElementID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.SearchFormElementDataByElementID(context.Background(), formInstanceID, formElementID).Limit(limit).Filters(filters).Query(query).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormElementDataByElementID``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormElementDataByElementID`: ListFormElementDataByElementIDResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormElementDataByElementID`: %v\n", resp) + } +- path: /form-instances + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#search-form-instances-by-tenant + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.SearchFormInstancesByTenant(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.SearchFormInstancesByTenant(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchFormInstancesByTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchFormInstancesByTenant`: []ListFormInstancesByTenantResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchFormInstancesByTenant`: %v\n", resp) + } +- path: /form-definitions/predefined-select-options + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#search-pre-defined-select-options + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.SearchPreDefinedSelectOptions(context.Background()).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.SearchPreDefinedSelectOptions(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.SearchPreDefinedSelectOptions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchPreDefinedSelectOptions`: ListPredefinedSelectOptionsResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.SearchPreDefinedSelectOptions`: %v\n", resp) + } +- path: /form-definitions/{formDefinitionID}/data-source + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-forms#show-preview-data-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + formDefinitionID := `00000000-0000-0000-0000-000000000000` // string | Form definition ID # string | Form definition ID + limit := 10 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) + filters := `value eq "ID01"` // 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) + query := `ac` // string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) + formelementpreviewrequest := []byte(`{ + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } + }`) // FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomFormsAPI.ShowPreviewDataSource(context.Background(), formDefinitionID).Execute() + //resp, r, err := apiClient.V2025.CustomFormsAPI.ShowPreviewDataSource(context.Background(), formDefinitionID).Limit(limit).Filters(filters).Query(query).FormElementPreviewRequest(formElementPreviewRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomFormsAPI.ShowPreviewDataSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ShowPreviewDataSource`: PreviewDataSourceResponse + fmt.Fprintf(os.Stdout, "Response from `CustomFormsAPI.ShowPreviewDataSource`: %v\n", resp) + } +- path: /custom-password-instructions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-password-instructions#create-custom-password-instructions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + custompasswordinstruction := []byte(`{ + "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", + "pageId" : "change-password:enter-password", + "locale" : "en" + }`) // CustomPasswordInstruction | + + + var customPasswordInstruction v2025.CustomPasswordInstruction + if err := json.Unmarshal(custompasswordinstruction, &customPasswordInstruction); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions(context.Background()).XSailPointExperimental(xSailPointExperimental).CustomPasswordInstruction(customPasswordInstruction).Execute() + //resp, r, err := apiClient.V2025.CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions(context.Background()).XSailPointExperimental(xSailPointExperimental).CustomPasswordInstruction(customPasswordInstruction).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCustomPasswordInstructions`: CustomPasswordInstruction + fmt.Fprintf(os.Stdout, "Response from `CustomPasswordInstructionsAPI.CreateCustomPasswordInstructions`: %v\n", resp) + } +- path: /custom-password-instructions/{pageId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-password-instructions#delete-custom-password-instructions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + pageId := `mfa:select` // string | The page ID of custom password instructions to delete. # string | The page ID of custom password instructions to delete. + 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") + locale := `locale_example` // string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions(context.Background(), pageId).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions(context.Background(), pageId).XSailPointExperimental(xSailPointExperimental).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.DeleteCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /custom-password-instructions/{pageId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/custom-password-instructions#get-custom-password-instructions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + pageId := `mfa:select` // string | The page ID of custom password instructions to query. # string | The page ID of custom password instructions to query. + 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") + locale := `locale_example` // string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.CustomPasswordInstructionsAPI.GetCustomPasswordInstructions(context.Background(), pageId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.CustomPasswordInstructionsAPI.GetCustomPasswordInstructions(context.Background(), pageId).XSailPointExperimental(xSailPointExperimental).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CustomPasswordInstructionsAPI.GetCustomPasswordInstructions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCustomPasswordInstructions`: CustomPasswordInstruction + fmt.Fprintf(os.Stdout, "Response from `CustomPasswordInstructionsAPI.GetCustomPasswordInstructions`: %v\n", resp) + } +- path: /data-segments + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/data-segmentation#create-data-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + datasegment := []byte(``) // DataSegment | + + + var dataSegment v2025.DataSegment + if err := json.Unmarshal(datasegment, &dataSegment); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DataSegmentationAPI.CreateDataSegment(context.Background()).DataSegment(dataSegment).Execute() + //resp, r, err := apiClient.V2025.DataSegmentationAPI.CreateDataSegment(context.Background()).DataSegment(dataSegment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.CreateDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDataSegment`: DataSegment + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.CreateDataSegment`: %v\n", resp) + } +- path: /data-segments/{segmentId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/data-segmentation#delete-data-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The segment ID to delete. # string | The segment ID to delete. + 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") + published := false // bool | This determines which version of the segment to delete (optional) (default to false) # bool | This determines which version of the segment to delete (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.DataSegmentationAPI.DeleteDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.DataSegmentationAPI.DeleteDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Published(published).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.DeleteDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /data-segments/{segmentId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/data-segmentation#get-data-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The segment ID to retrieve. # string | The segment ID to retrieve. + 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.DataSegmentationAPI.GetDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.DataSegmentationAPI.GetDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.GetDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDataSegment`: DataSegment + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.GetDataSegment`: %v\n", resp) + } +- path: /data-segments/membership/{identityId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/data-segmentation#get-data-segment-identity-membership + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The identity ID to retrieve the segments they are in. # string | The identity ID to retrieve the segments they are in. + 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.DataSegmentationAPI.GetDataSegmentIdentityMembership(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.DataSegmentationAPI.GetDataSegmentIdentityMembership(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.GetDataSegmentIdentityMembership``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDataSegmentIdentityMembership`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.GetDataSegmentIdentityMembership`: %v\n", resp) + } +- path: /data-segments/user-enabled/{identityId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/data-segmentation#get-data-segmentation-enabled-for-user + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The identity ID to retrieve if segmentation is enabled for the identity. # string | The identity ID to retrieve if segmentation is enabled for the identity. + 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.DataSegmentationAPI.GetDataSegmentationEnabledForUser(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.DataSegmentationAPI.GetDataSegmentationEnabledForUser(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.GetDataSegmentationEnabledForUser``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDataSegmentationEnabledForUser`: bool + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.GetDataSegmentationEnabledForUser`: %v\n", resp) + } +- path: /data-segments + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/data-segmentation#list-data-segments + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + enabled := true // bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to true) # bool | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to true) + unique := false // bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to false) # bool | This returns only one record if set to true and that would be the published record if exists. (optional) (default to false) + published := true // bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to true) # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to true) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq ""` // 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, sw* **name**: *eq, in, sw* (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, sw* **name**: *eq, in, sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DataSegmentationAPI.ListDataSegments(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.DataSegmentationAPI.ListDataSegments(context.Background()).XSailPointExperimental(xSailPointExperimental).Enabled(enabled).Unique(unique).Published(published).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.ListDataSegments``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDataSegments`: []DataSegment + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.ListDataSegments`: %v\n", resp) + } +- path: /data-segments/{segmentId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/data-segmentation#patch-data-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The segment ID to modify. # string | The segment ID to modify. + 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") + requestbody := []byte(`[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]`) // []map[string]interface{} | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DataSegmentationAPI.PatchDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2025.DataSegmentationAPI.PatchDataSegment(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.PatchDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchDataSegment`: DataSegment + fmt.Fprintf(os.Stdout, "Response from `DataSegmentationAPI.PatchDataSegment`: %v\n", resp) + } +- path: /data-segments/{segmentId} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/data-segmentation#publish-data-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + requestbody := []byte(``) // []string | A list of segment ids that you wish to publish + publishAll := true // bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to true) # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to true) + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.DataSegmentationAPI.PublishDataSegment(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //r, err := apiClient.V2025.DataSegmentationAPI.PublishDataSegment(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).PublishAll(publishAll).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DataSegmentationAPI.PublishDataSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /roles/{roleId}/dimensions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/dimensions#create-dimension + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimension := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "name" : "Dimension 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "id" : "2c918086749d78830174a1a40e121518", + "membership" : { + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, + "type" : "STANDARD" + }, + "parentId" : "2c918086749d78830174a1a40e121518" + }`) // Dimension | + + + var dimension v2025.Dimension + if err := json.Unmarshal(dimension, &dimension); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DimensionsAPI.CreateDimension(context.Background(), roleId).Dimension(dimension).Execute() + //resp, r, err := apiClient.V2025.DimensionsAPI.CreateDimension(context.Background(), roleId).Dimension(dimension).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.CreateDimension``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDimension`: Dimension + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.CreateDimension`: %v\n", resp) + } +- path: /roles/{roleId}/dimensions/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/dimensions#delete-bulk-dimensions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimensions. # string | Parent Role Id of the dimensions. + dimensionbulkdeleterequest := []byte(`{ + "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + }`) // DimensionBulkDeleteRequest | + + + var dimensionBulkDeleteRequest v2025.DimensionBulkDeleteRequest + if err := json.Unmarshal(dimensionbulkdeleterequest, &dimensionBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DimensionsAPI.DeleteBulkDimensions(context.Background(), roleId).DimensionBulkDeleteRequest(dimensionBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V2025.DimensionsAPI.DeleteBulkDimensions(context.Background(), roleId).DimensionBulkDeleteRequest(dimensionBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.DeleteBulkDimensions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteBulkDimensions`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.DeleteBulkDimensions`: %v\n", resp) + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/dimensions#delete-dimension + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.DimensionsAPI.DeleteDimension(context.Background(), roleId, dimensionId).Execute() + //r, err := apiClient.V2025.DimensionsAPI.DeleteDimension(context.Background(), roleId, dimensionId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.DeleteDimension``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/dimensions#get-dimension + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DimensionsAPI.GetDimension(context.Background(), roleId, dimensionId).Execute() + //resp, r, err := apiClient.V2025.DimensionsAPI.GetDimension(context.Background(), roleId, dimensionId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.GetDimension``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDimension`: Dimension + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.GetDimension`: %v\n", resp) + } +- path: /roles/{roleId}/dimensions/{dimensionId}/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/dimensions#get-dimension-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DimensionsAPI.GetDimensionEntitlements(context.Background(), roleId, dimensionId).Execute() + //resp, r, err := apiClient.V2025.DimensionsAPI.GetDimensionEntitlements(context.Background(), roleId, dimensionId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.GetDimensionEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDimensionEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.GetDimensionEntitlements`: %v\n", resp) + } +- path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/dimensions#list-dimension-access-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `source.id eq "2c91808982f979270182f99e386d00fa"` // 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DimensionsAPI.ListDimensionAccessProfiles(context.Background(), roleId, dimensionId).Execute() + //resp, r, err := apiClient.V2025.DimensionsAPI.ListDimensionAccessProfiles(context.Background(), roleId, dimensionId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.ListDimensionAccessProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDimensionAccessProfiles`: []AccessProfile + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.ListDimensionAccessProfiles`: %v\n", resp) + } +- path: /roles/{roleId}/dimensions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/dimensions#list-dimensions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq '2c918086749d78830174a1a40e121518'` // 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DimensionsAPI.ListDimensions(context.Background(), roleId).Execute() + //resp, r, err := apiClient.V2025.DimensionsAPI.ListDimensions(context.Background(), roleId).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.ListDimensions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListDimensions`: []Dimension + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.ListDimensions`: %v\n", resp) + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/dimensions#patch-dimension + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + roleId := `6603fba3004f43c687610a29195252ce` // string | Parent Role Id of the dimension. # string | Parent Role Id of the dimension. + dimensionId := `2c9180835d191a86015d28455b4a2329` // string | Id of the Dimension # string | Id of the Dimension + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Test Description}, {op=replace, path=/name, value=new name}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.DimensionsAPI.PatchDimension(context.Background(), roleId, dimensionId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.DimensionsAPI.PatchDimension(context.Background(), roleId, dimensionId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DimensionsAPI.PatchDimension``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchDimension`: Dimension + fmt.Fprintf(os.Stdout, "Response from `DimensionsAPI.PatchDimension`: %v\n", resp) + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/entitlements#create-access-model-metadata-for-entitlement + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | The entitlement id. # string | The entitlement id. + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + 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.EntitlementsAPI.CreateAccessModelMetadataForEntitlement(context.Background(), id, attributeKey, attributeValue).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.CreateAccessModelMetadataForEntitlement(context.Background(), id, attributeKey, attributeValue).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.CreateAccessModelMetadataForEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessModelMetadataForEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.CreateAccessModelMetadataForEntitlement`: %v\n", resp) + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/entitlements#delete-access-model-metadata-from-entitlement + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | The entitlement id. # string | The entitlement id. + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + 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.V2025.EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement(context.Background(), id, attributeKey, attributeValue).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement(context.Background(), id, attributeKey, attributeValue).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.DeleteAccessModelMetadataFromEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /entitlements/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/entitlements#get-entitlement + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808874ff91550175097daaec161c` // string | The entitlement ID # string | The entitlement 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.EntitlementsAPI.GetEntitlement(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.GetEntitlement(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.GetEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.GetEntitlement`: %v\n", resp) + } +- path: /entitlements/{id}/entitlement-request-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/entitlements#get-entitlement-request-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808874ff91550175097daaec161c` // string | Entitlement Id # string | Entitlement 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.EntitlementsAPI.GetEntitlementRequestConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.GetEntitlementRequestConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.GetEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementRequestConfig`: EntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.GetEntitlementRequestConfig`: %v\n", resp) + } +- path: /entitlements/aggregate/sources/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/entitlements#import-entitlements-by-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + csvFile := 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.V2025.EntitlementsAPI.ImportEntitlementsBySource(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.ImportEntitlementsBySource(context.Background(), id).XSailPointExperimental(xSailPointExperimental).CsvFile(csvFile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ImportEntitlementsBySource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportEntitlementsBySource`: LoadEntitlementTask + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ImportEntitlementsBySource`: %v\n", resp) + } +- path: /entitlements/{id}/children + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/entitlements#list-entitlement-children + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808874ff91550175097daaec161c` // string | Entitlement Id # string | Entitlement 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id** (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: **id, name, created, modified, type, attribute, value, source.id** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.EntitlementsAPI.ListEntitlementChildren(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.ListEntitlementChildren(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlementChildren``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlementChildren`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlementChildren`: %v\n", resp) + } +- path: /entitlements/{id}/parents + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/entitlements#list-entitlement-parents + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | Entitlement Id # string | Entitlement 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id** (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: **id, name, created, modified, type, attribute, value, source.id** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.EntitlementsAPI.ListEntitlementParents(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.ListEntitlementParents(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlementParents``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlementParents`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlementParents`: %v\n", resp) + } +- path: /entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/entitlements#list-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + accountId := `ef38f94347e94562b5bb8424a56397d8` // string | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) # string | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) + segmentedForIdentity := `me` // string | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) # string | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) + forSegmentIds := `041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649` // string | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) # string | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) + includeUnsegmented := true // bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to true) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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: **id, name, created, modified, type, attribute, value, source.id, requestable** (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: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) + filters := `attribute eq "memberOf"` // 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.EntitlementsAPI.ListEntitlements(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.ListEntitlements(context.Background()).XSailPointExperimental(xSailPointExperimental).AccountId(accountId).SegmentedForIdentity(segmentedForIdentity).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ListEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ListEntitlements`: %v\n", resp) + } +- path: /entitlements/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/entitlements#patch-entitlement + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the entitlement to patch # string | ID of the entitlement to patch + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]`) // []JsonPatchOperation | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.EntitlementsAPI.PatchEntitlement(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.PatchEntitlement(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.PatchEntitlement``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchEntitlement`: Entitlement + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.PatchEntitlement`: %v\n", resp) + } +- path: /entitlements/{id}/entitlement-request-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/entitlements#put-entitlement-request-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | Entitlement ID # string | Entitlement 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") + entitlementrequestconfig := []byte(`{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }`) // EntitlementRequestConfig | + + + var entitlementRequestConfig v2025.EntitlementRequestConfig + if err := json.Unmarshal(entitlementrequestconfig, &entitlementRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.EntitlementsAPI.PutEntitlementRequestConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).EntitlementRequestConfig(entitlementRequestConfig).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.PutEntitlementRequestConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).EntitlementRequestConfig(entitlementRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.PutEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutEntitlementRequestConfig`: EntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.PutEntitlementRequestConfig`: %v\n", resp) + } +- path: /entitlements/reset/sources/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/entitlements#reset-source-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of source for the entitlement reset # string | ID of source for the entitlement reset + 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.EntitlementsAPI.ResetSourceEntitlements(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.EntitlementsAPI.ResetSourceEntitlements(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.ResetSourceEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ResetSourceEntitlements`: EntitlementSourceResetBaseReferenceDto + fmt.Fprintf(os.Stdout, "Response from `EntitlementsAPI.ResetSourceEntitlements`: %v\n", resp) + } +- path: /entitlements/bulk-update + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/entitlements#update-entitlements-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + entitlementbulkupdaterequest := []byte(`{ + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] + }`) // EntitlementBulkUpdateRequest | + + + var entitlementBulkUpdateRequest v2025.EntitlementBulkUpdateRequest + if err := json.Unmarshal(entitlementbulkupdaterequest, &entitlementBulkUpdateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.EntitlementsAPI.UpdateEntitlementsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).EntitlementBulkUpdateRequest(entitlementBulkUpdateRequest).Execute() + //r, err := apiClient.V2025.EntitlementsAPI.UpdateEntitlementsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).EntitlementBulkUpdateRequest(entitlementBulkUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `EntitlementsAPI.UpdateEntitlementsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /auth-org/network-config + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/global-tenant-security-settings#create-auth-org-network-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + networkconfiguration := []byte(`{ + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] + }`) // NetworkConfiguration | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + + + var networkConfiguration v2025.NetworkConfiguration + if err := json.Unmarshal(networkconfiguration, &networkConfiguration); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig(context.Background()).NetworkConfiguration(networkConfiguration).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig(context.Background()).NetworkConfiguration(networkConfiguration).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig`: %v\n", resp) + } +- path: /auth-org/lockout-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgLockoutConfig`: LockoutConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig`: %v\n", resp) + } +- path: /auth-org/network-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/global-tenant-security-settings#get-auth-org-network-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig`: %v\n", resp) + } +- path: /auth-org/service-provider-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgServiceProviderConfig`: ServiceProviderConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig`: %v\n", resp) + } +- path: /auth-org/session-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgSessionConfig`: SessionConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig`: %v\n", resp) + } +- path: /auth-org/lockout-config + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}]`) // []JsonPatchOperation | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgLockoutConfig`: LockoutConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig`: %v\n", resp) + } +- path: /auth-org/network-config + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/global-tenant-security-settings#patch-auth-org-network-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/whitelisted, value=false,}, {op=add, path=/geolocation, value=[AF, HN, ES]}]`) // []JsonPatchOperation | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig`: %v\n", resp) + } +- path: /auth-org/service-provider-config + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}]`) // []JsonPatchOperation | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgServiceProviderConfig`: ServiceProviderConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig`: %v\n", resp) + } +- path: /auth-org/session-config + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}]`) // []JsonPatchOperation | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgSessionConfig`: SessionConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig`: %v\n", resp) + } +- path: /workgroups + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/governance-groups#create-workgroup + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + workgroupdto := []byte(`{ + "owner" : { + "emailAddress" : "support@sailpoint.com", + "displayName" : "Support", + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "connectionCount" : 1641498673000, + "created" : "2022-01-06T19:51:13Z", + "memberCount" : 1641498673000, + "name" : "DB Access Governance Group", + "description" : "Description of the Governance Group", + "modified" : "2022-01-06T19:51:13Z", + "id" : "2c91808568c529c60168cca6f90c1313" + }`) // WorkgroupDto | + + + var workgroupDto v2025.WorkgroupDto + if err := json.Unmarshal(workgroupdto, &workgroupDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GovernanceGroupsAPI.CreateWorkgroup(context.Background()).XSailPointExperimental(xSailPointExperimental).WorkgroupDto(workgroupDto).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.CreateWorkgroup(context.Background()).XSailPointExperimental(xSailPointExperimental).WorkgroupDto(workgroupDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.CreateWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.CreateWorkgroup`: %v\n", resp) + } +- path: /workgroups/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/governance-groups#delete-workgroup + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + 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.V2025.GovernanceGroupsAPI.DeleteWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.GovernanceGroupsAPI.DeleteWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /workgroups/{workgroupId}/members/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/governance-groups#delete-workgroup-members + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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") + identitypreviewresponseidentity := []byte(``) // []IdentityPreviewResponseIdentity | List of identities to be removed from a Governance Group members list. + + + var identityPreviewResponseIdentity v2025.[]IdentityPreviewResponseIdentity + if err := json.Unmarshal(identitypreviewresponseidentity, &identityPreviewResponseIdentity); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GovernanceGroupsAPI.DeleteWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).IdentityPreviewResponseIdentity(identityPreviewResponseIdentity).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.DeleteWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).IdentityPreviewResponseIdentity(identityPreviewResponseIdentity).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteWorkgroupMembers`: []WorkgroupMemberDeleteItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.DeleteWorkgroupMembers`: %v\n", resp) + } +- path: /workgroups/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/governance-groups#delete-workgroups-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + workgroupbulkdeleterequest := []byte(`{ + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + }`) // WorkgroupBulkDeleteRequest | + + + var workgroupBulkDeleteRequest v2025.WorkgroupBulkDeleteRequest + if err := json.Unmarshal(workgroupbulkdeleterequest, &workgroupBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GovernanceGroupsAPI.DeleteWorkgroupsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).WorkgroupBulkDeleteRequest(workgroupBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.DeleteWorkgroupsInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).WorkgroupBulkDeleteRequest(workgroupBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.DeleteWorkgroupsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteWorkgroupsInBulk`: []WorkgroupDeleteItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.DeleteWorkgroupsInBulk`: %v\n", resp) + } +- path: /workgroups/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/governance-groups#get-workgroup + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + 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.GovernanceGroupsAPI.GetWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.GetWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.GetWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.GetWorkgroup`: %v\n", resp) + } +- path: /workgroups/{workgroupId}/connections + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/governance-groups#list-connections + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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") + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GovernanceGroupsAPI.ListConnections(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.ListConnections(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListConnections``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListConnections`: []WorkgroupConnectionDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListConnections`: %v\n", resp) + } +- path: /workgroups/{workgroupId}/members + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/governance-groups#list-workgroup-members + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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") + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GovernanceGroupsAPI.ListWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.ListWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkgroupMembers`: []ListWorkgroupMembers200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListWorkgroupMembers`: %v\n", resp) + } +- path: /workgroups + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/governance-groups#list-workgroups + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw "Test"` // 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, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (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, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) + sorters := `name,-modified` // 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, created, modified, id, description** (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, created, modified, id, description** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GovernanceGroupsAPI.ListWorkgroups(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.ListWorkgroups(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.ListWorkgroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkgroups`: []WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.ListWorkgroups`: %v\n", resp) + } +- path: /workgroups/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/governance-groups#patch-workgroup + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Governance Group # string | ID of the Governance Group + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Governance Group new description.}]`) // []JsonPatchOperation | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GovernanceGroupsAPI.PatchWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.PatchWorkgroup(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.PatchWorkgroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchWorkgroup`: WorkgroupDto + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.PatchWorkgroup`: %v\n", resp) + } +- path: /workgroups/{workgroupId}/members/bulk-add + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/governance-groups#update-workgroup-members + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + workgroupId := `2c91808a7813090a017814121919ecca` // string | ID of the Governance Group. # string | ID of the Governance Group. + 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") + identitypreviewresponseidentity := []byte(``) // []IdentityPreviewResponseIdentity | List of identities to be added to a Governance Group members list. + + + var identityPreviewResponseIdentity v2025.[]IdentityPreviewResponseIdentity + if err := json.Unmarshal(identitypreviewresponseidentity, &identityPreviewResponseIdentity); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.GovernanceGroupsAPI.UpdateWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).IdentityPreviewResponseIdentity(identityPreviewResponseIdentity).Execute() + //resp, r, err := apiClient.V2025.GovernanceGroupsAPI.UpdateWorkgroupMembers(context.Background(), workgroupId).XSailPointExperimental(xSailPointExperimental).IdentityPreviewResponseIdentity(identityPreviewResponseIdentity).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsAPI.UpdateWorkgroupMembers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateWorkgroupMembers`: []WorkgroupMemberAddItem + fmt.Fprintf(os.Stdout, "Response from `GovernanceGroupsAPI.UpdateWorkgroupMembers`: %v\n", resp) + } +- path: /ai-access-request-recommendations/ignored-items + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity. + + + var accessRequestRecommendationActionItemDto v2025.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsIgnoredItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsIgnoredItem`: %v\n", resp) + } +- path: /ai-access-request-recommendations/requested-items + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity. + + + var accessRequestRecommendationActionItemDto v2025.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsRequestedItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsRequestedItem`: %v\n", resp) + } +- path: /ai-access-request-recommendations/viewed-items + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + accessrequestrecommendationactionitemdto := []byte(`{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }`) // AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity. + + + var accessRequestRecommendationActionItemDto v2025.AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsViewedItem`: AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItem`: %v\n", resp) + } +- path: /ai-access-request-recommendations/viewed-items/bulk-create + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + accessrequestrecommendationactionitemdto := []byte(``) // []AccessRequestRecommendationActionItemDto | The recommended access items that were viewed for an identity. + + + var accessRequestRecommendationActionItemDto v2025.[]AccessRequestRecommendationActionItemDto + if err := json.Unmarshal(accessrequestrecommendationactionitemdto, &accessRequestRecommendationActionItemDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationActionItemDto(accessRequestRecommendationActionItemDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddAccessRequestRecommendationsViewedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.AddAccessRequestRecommendationsViewedItems`: %v\n", resp) + } +- path: /ai-access-request-recommendations + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + identityId := `2c91808570313110017040b06f344ec9` // string | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") # string | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") + limit := 15 // int32 | Max number of results to return. (optional) (default to 15) # int32 | Max number of results to return. (optional) (default to 15) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + includeTranslationMessages := false // bool | If *true* it will populate a list of translation messages in the response. (optional) (default to false) # bool | If *true* it will populate a list of translation messages in the response. (optional) (default to false) + filters := `access.name co "admin"` // 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) + sorters := `access.name` // 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityId(identityId).Limit(limit).Offset(offset).Count(count).IncludeTranslationMessages(includeTranslationMessages).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendations`: []AccessRequestRecommendationItemDetail + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendations`: %v\n", resp) + } +- path: /ai-access-request-recommendations/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsConfig`: AccessRequestRecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsConfig`: %v\n", resp) + } +- path: /ai-access-request-recommendations/ignored-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `identityId eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsIgnoredItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsIgnoredItems`: %v\n", resp) + } +- path: /ai-access-request-recommendations/requested-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsRequestedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsRequestedItems`: %v\n", resp) + } +- path: /ai-access-request-recommendations/viewed-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "2c9180846b0a0583016b299f210c1314"` // 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters := `access.id` // 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestRecommendationsViewedItems`: []AccessRequestRecommendationActionItemResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.GetAccessRequestRecommendationsViewedItems`: %v\n", resp) + } +- path: /ai-access-request-recommendations/config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-access-request-recommendations#set-access-request-recommendations-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + accessrequestrecommendationconfigdto := []byte(`{ + "scoreThreshold" : 0.5, + "startDateAttribute" : "startDate", + "restrictionAttribute" : "location", + "moverAttribute" : "isMover", + "joinerAttribute" : "isJoiner", + "useRestrictionAttribute" : true + }`) // AccessRequestRecommendationConfigDto | The desired configurations for Access Request Recommender for the tenant. + + + var accessRequestRecommendationConfigDto v2025.AccessRequestRecommendationConfigDto + if err := json.Unmarshal(accessrequestrecommendationconfigdto, &accessRequestRecommendationConfigDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.SetAccessRequestRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationConfigDto(accessRequestRecommendationConfigDto).Execute() + //resp, r, err := apiClient.V2025.IAIAccessRequestRecommendationsAPI.SetAccessRequestRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).AccessRequestRecommendationConfigDto(accessRequestRecommendationConfigDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIAccessRequestRecommendationsAPI.SetAccessRequestRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetAccessRequestRecommendationsConfig`: AccessRequestRecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIAccessRequestRecommendationsAPI.SetAccessRequestRecommendationsConfig`: %v\n", resp) + } +- path: /common-access + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-common-access#create-common-access + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + commonaccessitemrequest := []byte(`{ + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" + }`) // CommonAccessItemRequest | + + + var commonAccessItemRequest v2025.CommonAccessItemRequest + if err := json.Unmarshal(commonaccessitemrequest, &commonAccessItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAICommonAccessAPI.CreateCommonAccess(context.Background()).XSailPointExperimental(xSailPointExperimental).CommonAccessItemRequest(commonAccessItemRequest).Execute() + //resp, r, err := apiClient.V2025.IAICommonAccessAPI.CreateCommonAccess(context.Background()).XSailPointExperimental(xSailPointExperimental).CommonAccessItemRequest(commonAccessItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.CreateCommonAccess``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCommonAccess`: CommonAccessItemResponse + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.CreateCommonAccess`: %v\n", resp) + } +- path: /common-access + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-common-access#get-common-access + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.type eq "ROLE"` // 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) + sorters := `access.name` // 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: **access.name, status** By default the common access items are sorted by name, ascending. (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: **access.name, status** By default the common access items are sorted by name, ascending. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAICommonAccessAPI.GetCommonAccess(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAICommonAccessAPI.GetCommonAccess(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.GetCommonAccess``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCommonAccess`: []CommonAccessResponse + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.GetCommonAccess`: %v\n", resp) + } +- path: /common-access/update-status + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-common-access#update-common-access-status-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + commonaccessidstatus := []byte(``) // []CommonAccessIDStatus | Confirm or deny in bulk the common access ids that are (or aren't) common access + + + var commonAccessIDStatus v2025.[]CommonAccessIDStatus + if err := json.Unmarshal(commonaccessidstatus, &commonAccessIDStatus); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAICommonAccessAPI.UpdateCommonAccessStatusInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).CommonAccessIDStatus(commonAccessIDStatus).Execute() + //resp, r, err := apiClient.V2025.IAICommonAccessAPI.UpdateCommonAccessStatusInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).CommonAccessIDStatus(commonAccessIDStatus).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.UpdateCommonAccessStatusInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCommonAccessStatusInBulk`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.UpdateCommonAccessStatusInBulk`: %v\n", resp) + } +- path: /outliers/export + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-outliers#export-outliers-zip + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIOutliersAPI.ExportOutliersZip(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIOutliersAPI.ExportOutliersZip(context.Background()).XSailPointExperimental(xSailPointExperimental).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.ExportOutliersZip``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportOutliersZip`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.ExportOutliersZip`: %v\n", resp) + } +- path: /outlier-summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-outliers#get-identity-outlier-snapshots + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + filters := `snapshotDate ge "2022-02-07T20:13:29.356648026Z"` // 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: **snapshotDate**: *ge, le* (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: **snapshotDate**: *ge, le* (optional) + sorters := `snapshotDate` // 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: **snapshotDate** (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: **snapshotDate** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIOutliersAPI.GetIdentityOutlierSnapshots(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIOutliersAPI.GetIdentityOutlierSnapshots(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Type_(type_).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetIdentityOutlierSnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityOutlierSnapshots`: []OutlierSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetIdentityOutlierSnapshots`: %v\n", resp) + } +- path: /outliers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-outliers#get-identity-outliers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + filters := `attributes.displayName sw "John" and certStatus 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) + sorters := `attributes.displayName,firstDetectionDate,-score` // 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: **firstDetectionDate, attributes, score** (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: **firstDetectionDate, attributes, score** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIOutliersAPI.GetIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIOutliersAPI.GetIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Type_(type_).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityOutliers`: []Outlier + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetIdentityOutliers`: %v\n", resp) + } +- path: /outlier-summaries/latest + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-outliers#get-latest-identity-outlier-snapshots + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + type_ := `LOW_SIMILARITY` // string | Type of the identity outliers snapshot to filter on (optional) # string | Type of the identity outliers snapshot to filter on (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIOutliersAPI.GetLatestIdentityOutlierSnapshots(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIOutliersAPI.GetLatestIdentityOutlierSnapshots(context.Background()).XSailPointExperimental(xSailPointExperimental).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetLatestIdentityOutlierSnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLatestIdentityOutlierSnapshots`: []LatestOutlierSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetLatestIdentityOutlierSnapshots`: %v\n", resp) + } +- path: /outlier-feature-summaries/{outlierFeatureId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-outliers#get-outlier-contributing-feature-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + outlierFeatureId := `04654b66-7561-4090-94f9-abee0722a1af` // string | Contributing feature id # string | Contributing feature 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.IAIOutliersAPI.GetOutlierContributingFeatureSummary(context.Background(), outlierFeatureId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIOutliersAPI.GetOutlierContributingFeatureSummary(context.Background(), outlierFeatureId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetOutlierContributingFeatureSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOutlierContributingFeatureSummary`: OutlierFeatureSummary + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetOutlierContributingFeatureSummary`: %v\n", resp) + } +- path: /outliers/{outlierId}/contributing-features + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-outliers#get-peer-group-outliers-contributing-features + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + outlierId := `2c918085842e69ae018432d22ccb212f` // string | The outlier id # string | The outlier 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + includeTranslationMessages := `include-translation-messages=` // string | Whether or not to include translation messages object in returned response (optional) # string | Whether or not to include translation messages object in returned response (optional) + sorters := `importance` // 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: **importance** (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: **importance** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures(context.Background(), outlierId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures(context.Background(), outlierId).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).IncludeTranslationMessages(includeTranslationMessages).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPeerGroupOutliersContributingFeatures`: []OutlierContributingFeature + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.GetPeerGroupOutliersContributingFeatures`: %v\n", resp) + } +- path: /outliers/ignore + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-outliers#ignore-identity-outliers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + requestbody := []byte(``) // []string | + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.IAIOutliersAPI.IgnoreIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //r, err := apiClient.V2025.IAIOutliersAPI.IgnoreIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.IgnoreIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-outliers#list-outliers-contributing-feature-access-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + outlierId := `2c918085842e69ae018432d22ccb212f` // string | The outlier id # string | The outlier id + contributingFeatureName := `entitlement_count` // string | The name of contributing feature # string | The name of contributing feature + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + accessType := `ENTITLEMENT` // string | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) # string | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) + sorters := `displayName` // 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: **displayName** (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: **displayName** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIOutliersAPI.ListOutliersContributingFeatureAccessItems(context.Background(), outlierId, contributingFeatureName).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIOutliersAPI.ListOutliersContributingFeatureAccessItems(context.Background(), outlierId, contributingFeatureName).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).AccessType(accessType).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.ListOutliersContributingFeatureAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOutliersContributingFeatureAccessItems`: []OutliersContributingFeatureAccessItems + fmt.Fprintf(os.Stdout, "Response from `IAIOutliersAPI.ListOutliersContributingFeatureAccessItems`: %v\n", resp) + } +- path: /outliers/unignore + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-outliers#un-ignore-identity-outliers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + requestbody := []byte(``) // []string | + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.IAIOutliersAPI.UnIgnoreIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //r, err := apiClient.V2025.IAIOutliersAPI.UnIgnoreIdentityOutliers(context.Background()).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIOutliersAPI.UnIgnoreIdentityOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /peer-group-strategies/{strategy}/identity-outliers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-peer-group-strategies#get-peer-group-outliers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + strategy := `entitlement` // string | The strategy used to create peer groups. Currently, 'entitlement' is supported. # string | The strategy used to create peer groups. Currently, 'entitlement' is supported. + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers(context.Background(), strategy).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers(context.Background(), strategy).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPeerGroupOutliers`: []PeerGroupMember + fmt.Fprintf(os.Stdout, "Response from `IAIPeerGroupStrategiesAPI.GetPeerGroupOutliers`: %v\n", resp) + } +- path: /recommendations/request + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-recommendations#get-recommendations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + recommendationrequestdto := []byte(`{ + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true + }`) // RecommendationRequestDto | + + + var recommendationRequestDto v2025.RecommendationRequestDto + if err := json.Unmarshal(recommendationrequestdto, &recommendationRequestDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRecommendationsAPI.GetRecommendations(context.Background()).XSailPointExperimental(xSailPointExperimental).RecommendationRequestDto(recommendationRequestDto).Execute() + //resp, r, err := apiClient.V2025.IAIRecommendationsAPI.GetRecommendations(context.Background()).XSailPointExperimental(xSailPointExperimental).RecommendationRequestDto(recommendationRequestDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.GetRecommendations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRecommendations`: RecommendationResponseDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.GetRecommendations`: %v\n", resp) + } +- path: /recommendations/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-recommendations#get-recommendations-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRecommendationsAPI.GetRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRecommendationsAPI.GetRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.GetRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRecommendationsConfig`: RecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.GetRecommendationsConfig`: %v\n", resp) + } +- path: /recommendations/config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-recommendations#update-recommendations-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + recommendationconfigdto := []byte(`{ + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + }`) // RecommendationConfigDto | + + + var recommendationConfigDto v2025.RecommendationConfigDto + if err := json.Unmarshal(recommendationconfigdto, &recommendationConfigDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRecommendationsAPI.UpdateRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).RecommendationConfigDto(recommendationConfigDto).Execute() + //resp, r, err := apiClient.V2025.IAIRecommendationsAPI.UpdateRecommendationsConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).RecommendationConfigDto(recommendationConfigDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRecommendationsAPI.UpdateRecommendationsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRecommendationsConfig`: RecommendationConfigDto + fmt.Fprintf(os.Stdout, "Response from `IAIRecommendationsAPI.UpdateRecommendationsConfig`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#create-potential-role-provision-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + minEntitlementPopularity := 56 // int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) # int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to true) # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to true) + roleminingpotentialroleprovisionrequest := []byte(`{ + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false + }`) // RoleMiningPotentialRoleProvisionRequest | Required information to create a new role (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).MinEntitlementPopularity(minEntitlementPopularity).IncludeCommonAccess(includeCommonAccess).RoleMiningPotentialRoleProvisionRequest(roleMiningPotentialRoleProvisionRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePotentialRoleProvisionRequest`: RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.CreatePotentialRoleProvisionRequest`: %v\n", resp) + } +- path: /role-mining-sessions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#create-role-mining-sessions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + roleminingsessiondto := []byte(`{ + "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", + "prescribedPruneThreshold" : 10, + "pruneThreshold" : 50, + "saved" : true, + "potentialRolesReadyCount" : 0, + "scope" : { + "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], + "attributeFilterCriteria" : { + "displayName" : { + "untranslated" : "Location: Miami" + }, + "ariaLabel" : { + "untranslated" : "Location: Miami" + }, + "data" : { + "displayName" : { + "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" + }, + "name" : "location", + "operator" : "EQUALS", + "values" : [ "Miami" ] + } + }, + "criteria" : "source.name:DataScienceDataset" + }, + "potentialRoleCount" : 0, + "name" : "Saved RM Session - 07/10", + "minNumIdentitiesInPotentialRole" : 20, + "identityCount" : 0, + "type" : "SPECIALIZED" + }`) // RoleMiningSessionDto | Role mining session parameters + + + var roleMiningSessionDto v2025.RoleMiningSessionDto + if err := json.Unmarshal(roleminingsessiondto, &roleMiningSessionDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.CreateRoleMiningSessions(context.Background()).XSailPointExperimental(xSailPointExperimental).RoleMiningSessionDto(roleMiningSessionDto).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.CreateRoleMiningSessions(context.Background()).XSailPointExperimental(xSailPointExperimental).RoleMiningSessionDto(roleMiningSessionDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.CreateRoleMiningSessions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRoleMiningSessions`: RoleMiningSessionResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.CreateRoleMiningSessions`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#download-role-mining-potential-role-zip + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + exportId := `4940ffd4-836f-48a3-b2b0-6d498c3fdf40` // string | The id of a previously run export job for this potential role # string | The id of a previously run export job for this potential role + 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.IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip(context.Background(), sessionId, potentialRoleId, exportId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip(context.Background(), sessionId, potentialRoleId, exportId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DownloadRoleMiningPotentialRoleZip`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.DownloadRoleMiningPotentialRoleZip`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#export-role-mining-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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.IAIRoleMiningAPI.ExportRoleMiningPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.ExportRoleMiningPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRole`: *os.File + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#export-role-mining-potential-role-async + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + roleminingpotentialroleexportrequest := []byte(`{ + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true + }`) // RoleMiningPotentialRoleExportRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).RoleMiningPotentialRoleExportRequest(roleMiningPotentialRoleExportRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRoleAsync`: RoleMiningPotentialRoleExportResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleAsync`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#export-role-mining-potential-role-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `278359a6-04b7-4669-9468-924cf580964a` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + exportId := `4940ffd4-836f-48a3-b2b0-6d498c3fdf40` // string | The id of a previously run export job for this potential role # string | The id of a previously run export job for this potential role + 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.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus(context.Background(), sessionId, potentialRoleId, exportId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus(context.Background(), sessionId, potentialRoleId, exportId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportRoleMiningPotentialRoleStatus`: RoleMiningPotentialRoleExportResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.ExportRoleMiningPotentialRoleStatus`: %v\n", resp) + } +- path: /role-mining-potential-roles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#get-all-potential-role-summaries + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + sorters := `createdDate` // 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: **createdDate, identityCount, entitlementCount, freshness, quality** (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: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) + filters := `(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))` // 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetAllPotentialRoleSummaries(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetAllPotentialRoleSummaries(context.Background()).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetAllPotentialRoleSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAllPotentialRoleSummaries`: []RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetAllPotentialRoleSummaries`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#get-entitlement-distribution-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included or not (optional) # bool | Boolean determining whether common access entitlements will be included or not (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).IncludeCommonAccess(includeCommonAccess).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementDistributionPotentialRole`: map[string]int32 + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetEntitlementDistributionPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#get-entitlements-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + includeCommonAccess := true // bool | Boolean determining whether common access entitlements will be included or not (optional) (default to true) # bool | Boolean determining whether common access entitlements will be included or not (optional) (default to true) + sorters := `popularity` // 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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) + filters := `applicationName sw "AD"` // 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).IncludeCommonAccess(includeCommonAccess).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementsPotentialRole`: []RoleMiningEntitlement + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetEntitlementsPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#get-excluded-entitlements-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + sorters := `populariity` // 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: **popularity** (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: **popularity** (optional) + filters := `applicationName sw "AD"` // 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetExcludedEntitlementsPotentialRole`: []RoleMiningEntitlement + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetExcludedEntitlementsPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#get-identities-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + sorters := `name` // 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** (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** (optional) + filters := `filters_example` // 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: **name**: *sw* (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: **name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetIdentitiesPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetIdentitiesPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetIdentitiesPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitiesPotentialRole`: []RoleMiningIdentity + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetIdentitiesPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#get-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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.IAIRoleMiningAPI.GetPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#get-potential-role-applications + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `62f28d91-7d9f-4d17-be15-666d5b41d77f` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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 := `applicationName sw "test"` // 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: **applicationName**: *sw* (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: **applicationName**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRoleApplications(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRoleApplications(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleApplications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleApplications`: []RoleMiningPotentialRoleApplication + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleApplications`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#get-potential-role-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `62f28d91-7d9f-4d17-be15-666d5b41d77f` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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 := `entitlementRef.name sw "test"` // 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: **entitlementRef.name**: *sw* (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: **entitlementRef.name**: *sw* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRoleEntitlements(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRoleEntitlements(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleEntitlements`: []RoleMiningPotentialRoleEntitlements + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleEntitlements`: %v\n", resp) + } +- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#get-potential-role-source-identity-usage + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + potentialRoleId := `e0cc5d7d-bf7f-4f81-b2af-8885b09d9923` // string | A potential role id # string | A potential role id + sourceId := `2c9180877620c1460176267f336a106f` // string | A source id # string | A 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") + sorters := `-usageCount` // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (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 is supported for the following fields: **displayName, email, usageCount** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage(context.Background(), potentialRoleId, sourceId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage(context.Background(), potentialRoleId, sourceId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleSourceIdentityUsage`: []RoleMiningPotentialRoleSourceUsage + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleSourceIdentityUsage`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#get-potential-role-summaries + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session 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") + sorters := `createdDate` // 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: **createdDate** (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: **createdDate** (optional) + filters := `(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))` // 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRoleSummaries(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetPotentialRoleSummaries(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetPotentialRoleSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPotentialRoleSummaries`: []RoleMiningPotentialRoleSummary + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetPotentialRoleSummaries`: %v\n", resp) + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#get-role-mining-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id # string | A potential role 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.IAIRoleMiningAPI.GetRoleMiningPotentialRole(context.Background(), potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetRoleMiningPotentialRole(context.Background(), potentialRoleId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningPotentialRole`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#get-role-mining-session + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id to be retrieved. # string | The role mining session id to be retrieved. + 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.IAIRoleMiningAPI.GetRoleMiningSession(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetRoleMiningSession(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSession``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSession`: RoleMiningSessionResponse + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSession`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#get-role-mining-session-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session 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.IAIRoleMiningAPI.GetRoleMiningSessionStatus(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetRoleMiningSessionStatus(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSessionStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSessionStatus`: RoleMiningSessionStatus + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSessionStatus`: %v\n", resp) + } +- path: /role-mining-sessions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#get-role-mining-sessions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 := `saved eq "true" and name sw "RM Session"` // 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: **saved**: *eq* **name**: *eq, sw* (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: **saved**: *eq* **name**: *eq, sw* (optional) + sorters := `createdBy,createdDate` // 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: **createdBy, createdDate** (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: **createdBy, createdDate** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetRoleMiningSessions(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetRoleMiningSessions(context.Background()).XSailPointExperimental(xSailPointExperimental).Filters(filters).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetRoleMiningSessions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleMiningSessions`: []RoleMiningSessionDto + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetRoleMiningSessions`: %v\n", resp) + } +- path: /role-mining-potential-roles/saved + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#get-saved-potential-roles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + sorters := `modified` // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (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 is supported for the following fields: **modified** (optional) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetSavedPotentialRoles(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.GetSavedPotentialRoles(context.Background()).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.GetSavedPotentialRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSavedPotentialRoles`: []RoleMiningSessionDraftRoleDto + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.GetSavedPotentialRoles`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#patch-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The potential role summary id # string | The potential role summary 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") + patchpotentialrolerequestinner := []byte(`[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]`) // []PatchPotentialRoleRequestInner | + + + var patchPotentialRoleRequestInner v2025.[]PatchPotentialRoleRequestInner + if err := json.Unmarshal(patchpotentialrolerequestinner, &patchPotentialRoleRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.PatchPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.PatchPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPotentialRole`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchPotentialRole`: %v\n", resp) + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#patch-potential-role-0 + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The potential role summary id # string | The potential role summary 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") + patchpotentialrolerequestinner := []byte(`[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]`) // []PatchPotentialRoleRequestInner | + + + var patchPotentialRoleRequestInner v2025.[]PatchPotentialRoleRequestInner + if err := json.Unmarshal(patchpotentialrolerequestinner, &patchPotentialRoleRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.PatchPotentialRole_0(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.PatchPotentialRole_0(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).PatchPotentialRoleRequestInner(patchPotentialRoleRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchPotentialRole_0``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPotentialRole_0`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchPotentialRole_0`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#patch-role-mining-session + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id to be patched # string | The role mining session id to be patched + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/pruneThreshold, value=83}, {op=replace, path=/minNumIdentitiesInPotentialRole, value=10}, {op=replace, path=/saved, value=false}, {op=replace, path=/name, value=RM Session - 07/10/22}, {op=add, path=/name, value=RM Session - 07/10/22}]`) // []JsonPatchOperation | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.PatchRoleMiningSession(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.PatchRoleMiningSession(context.Background(), sessionId).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.PatchRoleMiningSession``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchRoleMiningSession`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.PatchRoleMiningSession`: %v\n", resp) + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/iai-role-mining#update-entitlements-potential-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sessionId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role mining session id # string | The role mining session id + potentialRoleId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | A potential role id in a role mining session # string | A potential role id in a role mining session + 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") + roleminingpotentialroleeditentitlements := []byte(`{ + "ids" : [ "entId1", "entId2" ], + "exclude" : true + }`) // RoleMiningPotentialRoleEditEntitlements | Role mining session parameters + + + var roleMiningPotentialRoleEditEntitlements v2025.RoleMiningPotentialRoleEditEntitlements + if err := json.Unmarshal(roleminingpotentialroleeditentitlements, &roleMiningPotentialRoleEditEntitlements); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IAIRoleMiningAPI.UpdateEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).RoleMiningPotentialRoleEditEntitlements(roleMiningPotentialRoleEditEntitlements).Execute() + //resp, r, err := apiClient.V2025.IAIRoleMiningAPI.UpdateEntitlementsPotentialRole(context.Background(), sessionId, potentialRoleId).XSailPointExperimental(xSailPointExperimental).RoleMiningPotentialRoleEditEntitlements(roleMiningPotentialRoleEditEntitlements).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IAIRoleMiningAPI.UpdateEntitlementsPotentialRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateEntitlementsPotentialRole`: RoleMiningPotentialRole + fmt.Fprintf(os.Stdout, "Response from `IAIRoleMiningAPI.UpdateEntitlementsPotentialRole`: %v\n", resp) + } +- path: /icons/{objectType}/{objectId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/icons#delete-icon + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + objectType := `application` // string | Object type. Available options ['application'] # string | Object type. Available options ['application'] + objectId := `a291e870-48c3-4953-b656-fb5ce2a93169` // string | Object id. # string | Object 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.V2025.IconsAPI.DeleteIcon(context.Background(), objectType, objectId).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.IconsAPI.DeleteIcon(context.Background(), objectType, objectId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IconsAPI.DeleteIcon``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /icons/{objectType}/{objectId} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/icons#set-icon + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + objectType := `application` // string | Object type. Available options ['application'] # string | Object type. Available options ['application'] + objectId := `a291e870-48c3-4953-b656-fb5ce2a93169` // string | Object id. # string | Object 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") + image := BINARY_DATA_HERE // *os.File | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] # *os.File | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IconsAPI.SetIcon(context.Background(), objectType, objectId).XSailPointExperimental(xSailPointExperimental).Image(image).Execute() + //resp, r, err := apiClient.V2025.IconsAPI.SetIcon(context.Background(), objectType, objectId).XSailPointExperimental(xSailPointExperimental).Image(image).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IconsAPI.SetIcon``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetIcon`: SetIcon200Response + fmt.Fprintf(os.Stdout, "Response from `IconsAPI.SetIcon`: %v\n", resp) + } +- path: /identities/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identities#delete-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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.V2025.IdentitiesAPI.DeleteIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.IdentitiesAPI.DeleteIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).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) + } + } +- path: /identities/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identities#get-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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.V2025.IdentitiesAPI.GetIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentitiesAPI.GetIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `GetIdentity`: Identity + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetIdentity`: %v\n", resp) + } +- path: /identities/{identityId}/ownership + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identities#get-identity-ownership-details + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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.V2025.IdentitiesAPI.GetIdentityOwnershipDetails(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentitiesAPI.GetIdentityOwnershipDetails(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `GetIdentityOwnershipDetails`: IdentityOwnershipAssociationDetails + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetIdentityOwnershipDetails`: %v\n", resp) + } +- path: /identities/{identityId}/role-assignments/{assignmentId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identities#get-role-assignment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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.V2025.IdentitiesAPI.GetRoleAssignment(context.Background(), identityId, assignmentId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentitiesAPI.GetRoleAssignment(context.Background(), identityId, assignmentId).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `GetRoleAssignment`: RoleAssignmentDto + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetRoleAssignment`: %v\n", resp) + } +- path: /identities/{identityId}/role-assignments + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identities#get-role-assignments + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentitiesAPI.GetRoleAssignments(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentitiesAPI.GetRoleAssignments(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `GetRoleAssignments`: []GetRoleAssignments200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.GetRoleAssignments`: %v\n", resp) + } +- path: /identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identities#list-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.V2025.IdentitiesAPI.ListIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentitiesAPI.ListIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `ListIdentities`: []Identity + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.ListIdentities`: %v\n", resp) + } +- path: /identities/{id}/reset + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identities#reset-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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.V2025.IdentitiesAPI.ResetIdentity(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.IdentitiesAPI.ResetIdentity(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).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) + } + } +- path: /identities/{id}/verification/account/send + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identities#send-identity-verification-account-token + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + sendaccountverificationrequest := []byte(`{ + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" + }`) // SendAccountVerificationRequest | + + + var sendAccountVerificationRequest v2025.SendAccountVerificationRequest + if err := json.Unmarshal(sendaccountverificationrequest, &sendAccountVerificationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.IdentitiesAPI.SendIdentityVerificationAccountToken(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SendAccountVerificationRequest(sendAccountVerificationRequest).Execute() + //r, err := apiClient.V2025.IdentitiesAPI.SendIdentityVerificationAccountToken(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SendAccountVerificationRequest(sendAccountVerificationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.SendIdentityVerificationAccountToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /identities/invite + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identities#start-identities-invite + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 + }`) // InviteIdentitiesRequest | + + + var inviteIdentitiesRequest v2025.InviteIdentitiesRequest + if err := json.Unmarshal(inviteidentitiesrequest, &inviteIdentitiesRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentitiesAPI.StartIdentitiesInvite(context.Background()).XSailPointExperimental(xSailPointExperimental).InviteIdentitiesRequest(inviteIdentitiesRequest).Execute() + //resp, r, err := apiClient.V2025.IdentitiesAPI.StartIdentitiesInvite(context.Background()).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `StartIdentitiesInvite`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.StartIdentitiesInvite`: %v\n", resp) + } +- path: /identities/process + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identities#start-identity-processing + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + processidentitiesrequest := []byte(`{ + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + }`) // ProcessIdentitiesRequest | + + + var processIdentitiesRequest v2025.ProcessIdentitiesRequest + if err := json.Unmarshal(processidentitiesrequest, &processIdentitiesRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentitiesAPI.StartIdentityProcessing(context.Background()).XSailPointExperimental(xSailPointExperimental).ProcessIdentitiesRequest(processIdentitiesRequest).Execute() + //resp, r, err := apiClient.V2025.IdentitiesAPI.StartIdentityProcessing(context.Background()).XSailPointExperimental(xSailPointExperimental).ProcessIdentitiesRequest(processIdentitiesRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.StartIdentityProcessing``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartIdentityProcessing`: TaskResultResponse + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.StartIdentityProcessing`: %v\n", resp) + } +- path: /identities/{identityId}/synchronize-attributes + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identities#synchronize-attributes-for-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `identityId_example` // 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.IdentitiesAPI.SynchronizeAttributesForIdentity(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentitiesAPI.SynchronizeAttributesForIdentity(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentitiesAPI.SynchronizeAttributesForIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SynchronizeAttributesForIdentity`: IdentitySyncJob + fmt.Fprintf(os.Stdout, "Response from `IdentitiesAPI.SynchronizeAttributesForIdentity`: %v\n", resp) + } +- path: /identity-attributes + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-attributes#create-identity-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + }`) // IdentityAttribute | + + + var identityAttribute v2025.IdentityAttribute + if err := json.Unmarshal(identityattribute, &identityAttribute); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityAttributesAPI.CreateIdentityAttribute(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityAttribute(identityAttribute).Execute() + //resp, r, err := apiClient.V2025.IdentityAttributesAPI.CreateIdentityAttribute(context.Background()).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `CreateIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.CreateIdentityAttribute`: %v\n", resp) + } +- path: /identity-attributes/{name} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-attributes#delete-identity-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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.V2025.IdentityAttributesAPI.DeleteIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.IdentityAttributesAPI.DeleteIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).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) + } + } +- path: /identity-attributes/bulk-delete + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-attributes#delete-identity-attributes-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 | + + + var identityAttributeNames v2025.IdentityAttributeNames + if err := json.Unmarshal(identityattributenames, &identityAttributeNames); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.IdentityAttributesAPI.DeleteIdentityAttributesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityAttributeNames(identityAttributeNames).Execute() + //r, err := apiClient.V2025.IdentityAttributesAPI.DeleteIdentityAttributesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).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) + } + } +- path: /identity-attributes/{name} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-attributes#get-identity-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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.V2025.IdentityAttributesAPI.GetIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityAttributesAPI.GetIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `GetIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.GetIdentityAttribute`: %v\n", resp) + } +- path: /identity-attributes + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-attributes#list-identity-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityAttributesAPI.ListIdentityAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityAttributesAPI.ListIdentityAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `ListIdentityAttributes`: []IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.ListIdentityAttributes`: %v\n", resp) + } +- path: /identity-attributes/{name} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-attributes#put-identity-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + }`) // IdentityAttribute | + + + var identityAttribute v2025.IdentityAttribute + if err := json.Unmarshal(identityattribute, &identityAttribute); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityAttributesAPI.PutIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).IdentityAttribute(identityAttribute).Execute() + //resp, r, err := apiClient.V2025.IdentityAttributesAPI.PutIdentityAttribute(context.Background(), name).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `PutIdentityAttribute`: IdentityAttribute + fmt.Fprintf(os.Stdout, "Response from `IdentityAttributesAPI.PutIdentityAttribute`: %v\n", resp) + } +- path: /historical-identities/{id}/compare + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-history#compare-identity-snapshots + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + snapshot1 := `2007-03-01T13:00:00Z` // string | The snapshot 1 of identity (optional) # string | The snapshot 1 of identity (optional) + snapshot2 := `2008-03-01T13:00:00Z` // string | The snapshot 2 of identity (optional) # string | The snapshot 2 of identity (optional) + accessitemtypes := []byte(``) // []string | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityHistoryAPI.CompareIdentitySnapshots(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.CompareIdentitySnapshots(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Snapshot1(snapshot1).Snapshot2(snapshot2).AccessItemTypes(accessItemTypes).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.CompareIdentitySnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompareIdentitySnapshots`: []IdentityCompareResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.CompareIdentitySnapshots`: %v\n", resp) + } +- path: /historical-identities/{id}/compare/{access-type} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-history#compare-identity-snapshots-access-type + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + accessType := `role` // string | The specific type which needs to be compared # string | The specific type which needs to be compared + 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") + accessAssociated := 2007-03-01T13:00:00Z // bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) # bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) + snapshot1 := `2008-03-01T13:00:00Z` // string | The snapshot 1 of identity (optional) # string | The snapshot 1 of identity (optional) + snapshot2 := `2009-03-01T13:00:00Z` // string | The snapshot 2 of identity (optional) # string | The snapshot 2 of identity (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityHistoryAPI.CompareIdentitySnapshotsAccessType(context.Background(), id, accessType).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.CompareIdentitySnapshotsAccessType(context.Background(), id, accessType).XSailPointExperimental(xSailPointExperimental).AccessAssociated(accessAssociated).Snapshot1(snapshot1).Snapshot2(snapshot2).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.CompareIdentitySnapshotsAccessType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompareIdentitySnapshotsAccessType`: []AccessItemDiff + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.CompareIdentitySnapshotsAccessType`: %v\n", resp) + } +- path: /historical-identities/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-history#get-historical-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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.IdentityHistoryAPI.GetHistoricalIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.GetHistoricalIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetHistoricalIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetHistoricalIdentity`: IdentityHistoryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetHistoricalIdentity`: %v\n", resp) + } +- path: /historical-identities/{id}/events + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-history#get-historical-identity-events + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + from := `2024-03-01T13:00:00Z` // string | The optional instant until which access events are returned (optional) # string | The optional instant until which access events are returned (optional) + eventtypes := []byte(`[AccessAddedEvent, AccessRemovedEvent]`) // []string | An optional list of event types to return. If null or empty, all events are returned (optional) + accessitemtypes := []byte(`[entitlement, account]`) // []string | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityHistoryAPI.GetHistoricalIdentityEvents(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.GetHistoricalIdentityEvents(context.Background(), id).XSailPointExperimental(xSailPointExperimental).From(from).EventTypes(eventTypes).AccessItemTypes(accessItemTypes).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetHistoricalIdentityEvents``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetHistoricalIdentityEvents`: []GetHistoricalIdentityEvents200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetHistoricalIdentityEvents`: %v\n", resp) + } +- path: /historical-identities/{id}/snapshots/{date} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-history#get-identity-snapshot + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + date := `2007-03-01T13:00:00Z` // string | The specified date # string | The specified date + 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.IdentityHistoryAPI.GetIdentitySnapshot(context.Background(), id, date).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.GetIdentitySnapshot(context.Background(), id, date).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentitySnapshot``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySnapshot`: IdentityHistoryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentitySnapshot`: %v\n", resp) + } +- path: /historical-identities/{id}/snapshot-summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-history#get-identity-snapshot-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + before := `2007-03-01T13:00:00Z` // string | The date before which snapshot summary is required (optional) # string | The date before which snapshot summary is required (optional) + interval := `interval_example` // string | The interval indicating day or month. Defaults to month if not specified (optional) # string | The interval indicating day or month. Defaults to month if not specified (optional) + timeZone := `UTC` // string | The time zone. Defaults to UTC if not provided (optional) # string | The time zone. Defaults to UTC if not provided (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityHistoryAPI.GetIdentitySnapshotSummary(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.GetIdentitySnapshotSummary(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Before(before).Interval(interval).TimeZone(timeZone).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentitySnapshotSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySnapshotSummary`: []MetricResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentitySnapshotSummary`: %v\n", resp) + } +- path: /historical-identities/{id}/start-date + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-history#get-identity-start-date + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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.IdentityHistoryAPI.GetIdentityStartDate(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.GetIdentityStartDate(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.GetIdentityStartDate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityStartDate`: string + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.GetIdentityStartDate`: %v\n", resp) + } +- path: /historical-identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-history#list-historical-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + startsWithQuery := `Ada` // string | This param is used for starts-with search for first, last and display name of the identity (optional) # string | This param is used for starts-with search for first, last and display name of the identity (optional) + isDeleted := true // bool | Indicates if we want to only list down deleted identities or not. (optional) # bool | Indicates if we want to only list down deleted identities or not. (optional) + isActive := true // bool | Indicates if we want to only list active or inactive identities. (optional) # bool | Indicates if we want to only list active or inactive identities. (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) + 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.V2025.IdentityHistoryAPI.ListHistoricalIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.ListHistoricalIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).StartsWithQuery(startsWithQuery).IsDeleted(isDeleted).IsActive(isActive).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListHistoricalIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListHistoricalIdentities`: []IdentityListItem + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListHistoricalIdentities`: %v\n", resp) + } +- path: /historical-identities/{id}/access-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-history#list-identity-access-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + type_ := `account` // string | The type of access item for the identity. If not provided, it defaults to account (optional) # string | The type of access item for the identity. If not provided, it defaults to account (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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.V2025.IdentityHistoryAPI.ListIdentityAccessItems(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.ListIdentityAccessItems(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Type_(type_).Limit(limit).Count(count).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentityAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityAccessItems`: []ListIdentityAccessItems200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentityAccessItems`: %v\n", resp) + } +- path: /historical-identities/{id}/snapshots/{date}/access-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-history#list-identity-snapshot-access-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The identity id # string | The identity id + date := `2007-03-01T13:00:00Z` // string | The specified date # string | The specified date + 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") + type_ := `account` // string | The access item type (optional) # string | The access item type (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityHistoryAPI.ListIdentitySnapshotAccessItems(context.Background(), id, date).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.ListIdentitySnapshotAccessItems(context.Background(), id, date).XSailPointExperimental(xSailPointExperimental).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentitySnapshotAccessItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentitySnapshotAccessItems`: []ListIdentityAccessItems200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentitySnapshotAccessItems`: %v\n", resp) + } +- path: /historical-identities/{id}/snapshots + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-history#list-identity-snapshots + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // 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") + start := `2007-03-01T13:00:00Z` // string | The specified start date (optional) # string | The specified start date (optional) + interval := `interval_example` // string | The interval indicating the range in day or month for the specified interval-name (optional) # string | The interval indicating the range in day or month for the specified interval-name (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityHistoryAPI.ListIdentitySnapshots(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.IdentityHistoryAPI.ListIdentitySnapshots(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Start(start).Interval(interval).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityHistoryAPI.ListIdentitySnapshots``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentitySnapshots`: []IdentitySnapshotSummaryResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityHistoryAPI.ListIdentitySnapshots`: %v\n", resp) + } +- path: /identity-profiles + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-profiles#create-identity-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityprofile := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + }`) // IdentityProfile | + + + var identityProfile v2025.IdentityProfile + if err := json.Unmarshal(identityprofile, &identityProfile); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.CreateIdentityProfile(context.Background()).IdentityProfile(identityProfile).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.CreateIdentityProfile(context.Background()).IdentityProfile(identityProfile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.CreateIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.CreateIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-profiles#delete-identity-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.DeleteIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.DeleteIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.DeleteIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteIdentityProfile`: TaskResultSimplified + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.DeleteIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-profiles#delete-identity-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestbody := []byte(``) // []string | Identity Profile bulk delete request body. + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.DeleteIdentityProfiles(context.Background()).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.DeleteIdentityProfiles(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.DeleteIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteIdentityProfiles`: TaskResultSimplified + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.DeleteIdentityProfiles`: %v\n", resp) + } +- path: /identity-profiles/export + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-profiles#export-identity-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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, ne* **name**: *eq, ne* **priority**: *eq, ne* (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, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + sorters := `id,name` // 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: **id, name, priority** (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: **id, name, priority** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.ExportIdentityProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.ExportIdentityProfiles(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ExportIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportIdentityProfiles`: []IdentityProfileExportedObject + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ExportIdentityProfiles`: %v\n", resp) + } +- path: /identity-profiles/identity-preview + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-profiles#generate-identity-preview + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + identitypreviewrequest := []byte(`{ + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + }`) // IdentityPreviewRequest | Identity Preview request body. + + + var identityPreviewRequest v2025.IdentityPreviewRequest + if err := json.Unmarshal(identitypreviewrequest, &identityPreviewRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.GenerateIdentityPreview(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityPreviewRequest(identityPreviewRequest).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.GenerateIdentityPreview(context.Background()).XSailPointExperimental(xSailPointExperimental).IdentityPreviewRequest(identityPreviewRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GenerateIdentityPreview``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GenerateIdentityPreview`: IdentityPreviewResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GenerateIdentityPreview`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-profiles#get-default-identity-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | The Identity Profile ID. # string | The Identity Profile ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.GetDefaultIdentityAttributeConfig(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.GetDefaultIdentityAttributeConfig(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GetDefaultIdentityAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDefaultIdentityAttributeConfig`: IdentityAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GetDefaultIdentityAttributeConfig`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-profiles#get-identity-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.GetIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.GetIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GetIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GetIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/import + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-profiles#import-identity-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityprofileexportedobject := []byte(``) // []IdentityProfileExportedObject | Previously exported Identity Profiles. + + + var identityProfileExportedObject v2025.[]IdentityProfileExportedObject + if err := json.Unmarshal(identityprofileexportedobject, &identityProfileExportedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.ImportIdentityProfiles(context.Background()).IdentityProfileExportedObject(identityProfileExportedObject).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.ImportIdentityProfiles(context.Background()).IdentityProfileExportedObject(identityProfileExportedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ImportIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportIdentityProfiles`: ObjectImportResult + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ImportIdentityProfiles`: %v\n", resp) + } +- path: /identity-profiles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-profiles#list-identity-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) + sorters := `id,name` // 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: **id, name, priority, created, modified, owner.id, owner.name** (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: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.ListIdentityProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.ListIdentityProfiles(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ListIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityProfiles`: []IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ListIdentityProfiles`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/process-identities + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-profiles#sync-identity-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | The Identity Profile ID to be processed # string | The Identity Profile ID to be processed + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.SyncIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.SyncIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.SyncIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SyncIdentityProfile`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.SyncIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/identity-profiles#update-identity-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + jsonpatchoperation := []byte(`[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]`) // []JsonPatchOperation | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.IdentityProfilesAPI.UpdateIdentityProfile(context.Background(), identityProfileId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.IdentityProfilesAPI.UpdateIdentityProfile(context.Background(), identityProfileId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.UpdateIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.UpdateIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/lifecycle-states#create-lifecycle-state + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile ID. + lifecyclestate := []byte(`{ + "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], + "emailNotificationOption" : { + "notifyManagers" : true, + "notifySpecificUsers" : true, + "emailAddressList" : [ "test@test.com", "test2@test.com" ], + "notifyAllAdmins" : true + }, + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Lifecycle description", + "accountActions" : [ { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }, { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } ], + "id" : "id12345", + "identityCount" : 42, + "technicalName" : "Technical Name", + "identityState" : "identityState", + "enabled" : true + }`) // LifecycleState | Lifecycle state to be created. + + + var lifecycleState v2025.LifecycleState + if err := json.Unmarshal(lifecyclestate, &lifecycleState); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.LifecycleStatesAPI.CreateLifecycleState(context.Background(), identityProfileId).LifecycleState(lifecycleState).Execute() + //resp, r, err := apiClient.V2025.LifecycleStatesAPI.CreateLifecycleState(context.Background(), identityProfileId).LifecycleState(lifecycleState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.CreateLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateLifecycleState`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.CreateLifecycleState`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/lifecycle-states#delete-lifecycle-state + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.LifecycleStatesAPI.DeleteLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + //resp, r, err := apiClient.V2025.LifecycleStatesAPI.DeleteLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.DeleteLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteLifecycleState`: LifecyclestateDeleted + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.DeleteLifecycleState`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/lifecycle-states#get-lifecycle-state + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.LifecycleStatesAPI.GetLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + //resp, r, err := apiClient.V2025.LifecycleStatesAPI.GetLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.GetLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLifecycleState`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.GetLifecycleState`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/lifecycle-states#get-lifecycle-states + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `created,modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.LifecycleStatesAPI.GetLifecycleStates(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V2025.LifecycleStatesAPI.GetLifecycleStates(context.Background(), identityProfileId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.GetLifecycleStates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLifecycleStates`: []LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.GetLifecycleStates`: %v\n", resp) + } +- path: /identities/{identity-id}/set-lifecycle-state + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/lifecycle-states#set-lifecycle-state + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `2c9180857893f1290178944561990364` // string | ID of the identity to update. # string | ID of the identity to update. + setlifecyclestaterequest := []byte(``) // SetLifecycleStateRequest | + + + var setLifecycleStateRequest v2025.SetLifecycleStateRequest + if err := json.Unmarshal(setlifecyclestaterequest, &setLifecycleStateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.LifecycleStatesAPI.SetLifecycleState(context.Background(), identityId).SetLifecycleStateRequest(setLifecycleStateRequest).Execute() + //resp, r, err := apiClient.V2025.LifecycleStatesAPI.SetLifecycleState(context.Background(), identityId).SetLifecycleStateRequest(setLifecycleStateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.SetLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetLifecycleState`: SetLifecycleState200Response + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.SetLifecycleState`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/lifecycle-states#update-lifecycle-states + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.LifecycleStatesAPI.UpdateLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.LifecycleStatesAPI.UpdateLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.UpdateLifecycleStates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateLifecycleStates`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.UpdateLifecycleStates`: %v\n", resp) + } +- path: /machine-accounts/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/machine-accounts#get-machine-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Account ID. # string | Machine 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.MachineAccountsAPI.GetMachineAccount(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.MachineAccountsAPI.GetMachineAccount(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountsAPI.GetMachineAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMachineAccount`: MachineAccount + fmt.Fprintf(os.Stdout, "Response from `MachineAccountsAPI.GetMachineAccount`: %v\n", resp) + } +- path: /machine-accounts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/machine-accounts#list-machine-accounts + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `identityId eq "2c9180858082150f0180893dbaf44201"` // 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, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *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, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) + sorters := `id,name` // 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: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (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: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MachineAccountsAPI.ListMachineAccounts(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.MachineAccountsAPI.ListMachineAccounts(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountsAPI.ListMachineAccounts``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListMachineAccounts`: []MachineAccount + fmt.Fprintf(os.Stdout, "Response from `MachineAccountsAPI.ListMachineAccounts`: %v\n", resp) + } +- path: /machine-accounts/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/machine-accounts#update-machine-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Account ID. # string | Machine 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") + requestbody := []byte(`[{op=add, path=/environment, value=test}]`) // []map[string]interface{} | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MachineAccountsAPI.UpdateMachineAccount(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2025.MachineAccountsAPI.UpdateMachineAccount(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineAccountsAPI.UpdateMachineAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateMachineAccount`: MachineAccount + fmt.Fprintf(os.Stdout, "Response from `MachineAccountsAPI.UpdateMachineAccount`: %v\n", resp) + } +- path: /machine-identities + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/machine-identities#create-machine-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + machineidentity := []byte(`{ + "created" : "2015-05-28T14:07:17Z", + "businessApplication" : "ADService", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "", + "attributes" : "{\"Region\":\"EU\"}", + "id" : "id12345", + "manuallyEdited" : true + }`) // MachineIdentity | + + + var machineIdentity v2025.MachineIdentity + if err := json.Unmarshal(machineidentity, &machineIdentity); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MachineIdentitiesAPI.CreateMachineIdentity(context.Background()).XSailPointExperimental(xSailPointExperimental).MachineIdentity(machineIdentity).Execute() + //resp, r, err := apiClient.V2025.MachineIdentitiesAPI.CreateMachineIdentity(context.Background()).XSailPointExperimental(xSailPointExperimental).MachineIdentity(machineIdentity).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.CreateMachineIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateMachineIdentity`: MachineIdentity + fmt.Fprintf(os.Stdout, "Response from `MachineIdentitiesAPI.CreateMachineIdentity`: %v\n", resp) + } +- path: /machine-identities/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/machine-identities#delete-machine-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Identity ID # string | Machine 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.V2025.MachineIdentitiesAPI.DeleteMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.MachineIdentitiesAPI.DeleteMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.DeleteMachineIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /machine-identities/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/machine-identities#get-machine-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Identity ID # string | Machine 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.MachineIdentitiesAPI.GetMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.MachineIdentitiesAPI.GetMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.GetMachineIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMachineIdentity`: MachineIdentity + fmt.Fprintf(os.Stdout, "Response from `MachineIdentitiesAPI.GetMachineIdentity`: %v\n", resp) + } +- path: /machine-identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/machine-identities#list-machine-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 := `identityId eq "2c9180858082150f0180893dbaf44201"` // 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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *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, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) + sorters := `businessApplication` // 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: **businessApplication, name** (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: **businessApplication, name** (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + 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.V2025.MachineIdentitiesAPI.ListMachineIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.MachineIdentitiesAPI.ListMachineIdentities(context.Background()).XSailPointExperimental(xSailPointExperimental).Filters(filters).Sorters(sorters).Count(count).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.ListMachineIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListMachineIdentities`: []MachineIdentity + fmt.Fprintf(os.Stdout, "Response from `MachineIdentitiesAPI.ListMachineIdentities`: %v\n", resp) + } +- path: /machine-identities/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/machine-identities#update-machine-identity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Machine Identity ID. # string | Machine 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") + requestbody := []byte(`[{op=add, path=/attributes/securityRisk, value=medium}]`) // []map[string]interface{} | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MachineIdentitiesAPI.UpdateMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2025.MachineIdentitiesAPI.UpdateMachineIdentity(context.Background(), id).XSailPointExperimental(xSailPointExperimental).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MachineIdentitiesAPI.UpdateMachineIdentity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateMachineIdentity`: MachineIdentity + fmt.Fprintf(os.Stdout, "Response from `MachineIdentitiesAPI.UpdateMachineIdentity`: %v\n", resp) + } +- path: /managed-clients + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-clients#create-managed-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + managedclientrequest := []byte(`{ + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + }`) // ManagedClientRequest | + + + var managedClientRequest v2025.ManagedClientRequest + if err := json.Unmarshal(managedclientrequest, &managedClientRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClientsAPI.CreateManagedClient(context.Background()).ManagedClientRequest(managedClientRequest).Execute() + //resp, r, err := apiClient.V2025.ManagedClientsAPI.CreateManagedClient(context.Background()).ManagedClientRequest(managedClientRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.CreateManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.CreateManagedClient`: %v\n", resp) + } +- path: /managed-clients/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-clients#delete-managed-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ManagedClientsAPI.DeleteManagedClient(context.Background(), id).Execute() + //r, err := apiClient.V2025.ManagedClientsAPI.DeleteManagedClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.DeleteManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /managed-clients/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-clients#get-managed-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClientsAPI.GetManagedClient(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ManagedClientsAPI.GetManagedClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClient`: %v\n", resp) + } +- path: /managed-clients/{id}/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-clients#get-managed-client-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `aClientId` // string | Managed client ID to get status for. # string | Managed client ID to get status for. + type_ := // ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClientsAPI.GetManagedClientStatus(context.Background(), id).Type_(type_).Execute() + //resp, r, err := apiClient.V2025.ManagedClientsAPI.GetManagedClientStatus(context.Background(), id).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClientStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClientStatus`: ManagedClientStatus + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClientStatus`: %v\n", resp) + } +- path: /managed-clients + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-clients#get-managed-clients + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "client name"` // 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* **name**: *eq* **clientId**: *eq* **clusterId**: *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* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClientsAPI.GetManagedClients(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ManagedClientsAPI.GetManagedClients(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClients``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClients`: []ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClients`: %v\n", resp) + } +- path: /managed-clients/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-clients#update-managed-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | JSONPatch payload used to update the object. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClientsAPI.UpdateManagedClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.ManagedClientsAPI.UpdateManagedClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.UpdateManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.UpdateManagedClient`: %v\n", resp) + } +- path: /managed-clusters + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-clusters#create-managed-cluster + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + managedclusterrequest := []byte(`{ + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + }`) // ManagedClusterRequest | + + + var managedClusterRequest v2025.ManagedClusterRequest + if err := json.Unmarshal(managedclusterrequest, &managedClusterRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClustersAPI.CreateManagedCluster(context.Background()).ManagedClusterRequest(managedClusterRequest).Execute() + //resp, r, err := apiClient.V2025.ManagedClustersAPI.CreateManagedCluster(context.Background()).ManagedClusterRequest(managedClusterRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.CreateManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.CreateManagedCluster`: %v\n", resp) + } +- path: /managed-clusters/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-clusters#delete-managed-cluster + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + removeClients := false // bool | Flag to determine the need to delete a cluster with clients. (optional) (default to false) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ManagedClustersAPI.DeleteManagedCluster(context.Background(), id).Execute() + //r, err := apiClient.V2025.ManagedClustersAPI.DeleteManagedCluster(context.Background(), id).RemoveClients(removeClients).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.DeleteManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /managed-clusters/{id}/log-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-clusters#get-client-log-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | ID of managed cluster to get log configuration for. # string | ID of managed cluster to get log configuration for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClustersAPI.GetClientLogConfiguration(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ManagedClustersAPI.GetClientLogConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetClientLogConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetClientLogConfiguration`: ClientLogConfiguration + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetClientLogConfiguration`: %v\n", resp) + } +- path: /managed-clusters/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-clusters#get-managed-cluster + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClustersAPI.GetManagedCluster(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ManagedClustersAPI.GetManagedCluster(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetManagedCluster`: %v\n", resp) + } +- path: /managed-clusters + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-clusters#get-managed-clusters + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `operational eq "operation"` // 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: **operational**: *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: **operational**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClustersAPI.GetManagedClusters(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ManagedClustersAPI.GetManagedClusters(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetManagedClusters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClusters`: []ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetManagedClusters`: %v\n", resp) + } +- path: /managed-clusters/{id}/log-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-clusters#put-client-log-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | ID of the managed cluster to update the log configuration for. # string | ID of the managed cluster to update the log configuration for. + putclientlogconfigurationrequest := []byte(``) // PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + + + var putClientLogConfigurationRequest v2025.PutClientLogConfigurationRequest + if err := json.Unmarshal(putclientlogconfigurationrequest, &putClientLogConfigurationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClustersAPI.PutClientLogConfiguration(context.Background(), id).PutClientLogConfigurationRequest(putClientLogConfigurationRequest).Execute() + //resp, r, err := apiClient.V2025.ManagedClustersAPI.PutClientLogConfiguration(context.Background(), id).PutClientLogConfigurationRequest(putClientLogConfigurationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.PutClientLogConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutClientLogConfiguration`: ClientLogConfiguration + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.PutClientLogConfiguration`: %v\n", resp) + } +- path: /managed-clusters/{id}/manualUpgrade + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-clusters#update + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | ID of managed cluster to trigger manual upgrade. # string | ID of managed cluster to trigger manual upgrade. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClustersAPI.Update(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ManagedClustersAPI.Update(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.Update``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `Update`: ClusterManualUpgrade + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.Update`: %v\n", resp) + } +- path: /managed-clusters/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-clusters#update-managed-cluster + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | JSONPatch payload used to update the object. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClustersAPI.UpdateManagedCluster(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.ManagedClustersAPI.UpdateManagedCluster(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.UpdateManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.UpdateManagedCluster`: %v\n", resp) + } +- path: /managed-cluster-types + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-cluster-types#create-managed-cluster-type + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + managedclustertype := []byte(`{ + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + }`) // ManagedClusterType | + + + var managedClusterType v2025.ManagedClusterType + if err := json.Unmarshal(managedclustertype, &managedClusterType); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClusterTypesAPI.CreateManagedClusterType(context.Background()).ManagedClusterType(managedClusterType).Execute() + //resp, r, err := apiClient.V2025.ManagedClusterTypesAPI.CreateManagedClusterType(context.Background()).ManagedClusterType(managedClusterType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.CreateManagedClusterType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateManagedClusterType`: ManagedClusterType + fmt.Fprintf(os.Stdout, "Response from `ManagedClusterTypesAPI.CreateManagedClusterType`: %v\n", resp) + } +- path: /managed-cluster-types/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-cluster-types#delete-managed-cluster-type + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `aClusterTypeId` // string | The Managed Cluster Type ID # string | The Managed Cluster Type ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ManagedClusterTypesAPI.DeleteManagedClusterType(context.Background(), id).Execute() + //r, err := apiClient.V2025.ManagedClusterTypesAPI.DeleteManagedClusterType(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.DeleteManagedClusterType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /managed-cluster-types/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-cluster-types#get-managed-cluster-type + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `aClusterTypeId` // string | The Managed Cluster Type ID # string | The Managed Cluster Type ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClusterTypesAPI.GetManagedClusterType(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ManagedClusterTypesAPI.GetManagedClusterType(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.GetManagedClusterType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClusterType`: ManagedClusterType + fmt.Fprintf(os.Stdout, "Response from `ManagedClusterTypesAPI.GetManagedClusterType`: %v\n", resp) + } +- path: /managed-cluster-types + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-cluster-types#get-managed-cluster-types + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + type_ := `IDN` // string | Type descriptor (optional) # string | Type descriptor (optional) + pod := `megapod-useast1` // string | Pinned pod (or default) (optional) # string | Pinned pod (or default) (optional) + org := `denali-xyz` // string | Pinned org (or default) (optional) # string | Pinned org (or default) (optional) + 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) + 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) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClusterTypesAPI.GetManagedClusterTypes(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ManagedClusterTypesAPI.GetManagedClusterTypes(context.Background()).Type_(type_).Pod(pod).Org(org).Offset(offset).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.GetManagedClusterTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClusterTypes`: []ManagedClusterType + fmt.Fprintf(os.Stdout, "Response from `ManagedClusterTypesAPI.GetManagedClusterTypes`: %v\n", resp) + } +- path: /managed-cluster-types/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/managed-cluster-types#update-managed-cluster-type + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `aClusterTypeId` // string | The Managed Cluster Type ID # string | The Managed Cluster Type ID + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | The JSONPatch payload used to update the schema. + + + var jsonPatch v2025.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ManagedClusterTypesAPI.UpdateManagedClusterType(context.Background(), id).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2025.ManagedClusterTypesAPI.UpdateManagedClusterType(context.Background(), id).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClusterTypesAPI.UpdateManagedClusterType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedClusterType`: ManagedClusterType + fmt.Fprintf(os.Stdout, "Response from `ManagedClusterTypesAPI.UpdateManagedClusterType`: %v\n", resp) + } +- path: /mfa/duo-web/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/mfa-configuration#get-mfa-duo-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MFAConfigurationAPI.GetMFADuoConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.MFAConfigurationAPI.GetMFADuoConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFADuoConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFADuoConfig`: MfaDuoConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFADuoConfig`: %v\n", resp) + } +- path: /mfa/kba/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/mfa-configuration#get-mfa-kba-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + allLanguages := allLanguages=true // bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MFAConfigurationAPI.GetMFAKbaConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.MFAConfigurationAPI.GetMFAKbaConfig(context.Background()).AllLanguages(allLanguages).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFAKbaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFAKbaConfig`: []KbaQuestion + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFAKbaConfig`: %v\n", resp) + } +- path: /mfa/okta-verify/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/mfa-configuration#get-mfa-okta-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MFAConfigurationAPI.GetMFAOktaConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.MFAConfigurationAPI.GetMFAOktaConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFAOktaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFAOktaConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFAOktaConfig`: %v\n", resp) + } +- path: /mfa/duo-web/config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/mfa-configuration#set-mfa-duo-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + mfaduoconfig := []byte(`{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }`) // MfaDuoConfig | + + + var mfaDuoConfig v2025.MfaDuoConfig + if err := json.Unmarshal(mfaduoconfig, &mfaDuoConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MFAConfigurationAPI.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute() + //resp, r, err := apiClient.V2025.MFAConfigurationAPI.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFADuoConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFADuoConfig`: MfaDuoConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFADuoConfig`: %v\n", resp) + } +- path: /mfa/kba/config/answers + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/mfa-configuration#set-mfakba-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + kbaanswerrequestitem := []byte(`[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]`) // []KbaAnswerRequestItem | + + + var kbaAnswerRequestItem v2025.[]KbaAnswerRequestItem + if err := json.Unmarshal(kbaanswerrequestitem, &kbaAnswerRequestItem); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MFAConfigurationAPI.SetMFAKBAConfig(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + //resp, r, err := apiClient.V2025.MFAConfigurationAPI.SetMFAKBAConfig(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFAKBAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFAKBAConfig`: []KbaAnswerResponseItem + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFAKBAConfig`: %v\n", resp) + } +- path: /mfa/okta-verify/config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/mfa-configuration#set-mfa-okta-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + mfaoktaconfig := []byte(`{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }`) // MfaOktaConfig | + + + var mfaOktaConfig v2025.MfaOktaConfig + if err := json.Unmarshal(mfaoktaconfig, &mfaOktaConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MFAConfigurationAPI.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute() + //resp, r, err := apiClient.V2025.MFAConfigurationAPI.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFAOktaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFAOktaConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFAOktaConfig`: %v\n", resp) + } +- path: /mfa/{method}/test + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/mfa-configuration#test-mfa-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + method := `okta-verify` // string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MFAConfigurationAPI.TestMFAConfig(context.Background(), method).Execute() + //resp, r, err := apiClient.V2025.MFAConfigurationAPI.TestMFAConfig(context.Background(), method).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.TestMFAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestMFAConfig`: MfaConfigTestResponse + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.TestMFAConfig`: %v\n", resp) + } +- path: /multihosts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/multi-host-integration#create-multi-host-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostintegrationscreate := []byte(`{ + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + }`) // MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create + + + var multiHostIntegrationsCreate v2025.MultiHostIntegrationsCreate + if err := json.Unmarshal(multihostintegrationscreate, &multiHostIntegrationsCreate); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.CreateMultiHostIntegration(context.Background()).MultiHostIntegrationsCreate(multiHostIntegrationsCreate).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.CreateMultiHostIntegration(context.Background()).MultiHostIntegrationsCreate(multiHostIntegrationsCreate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.CreateMultiHostIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateMultiHostIntegration`: MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.CreateMultiHostIntegration`: %v\n", resp) + } +- path: /multihosts/{multihostId} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/multi-host-integration#create-sources-within-multi-host + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration. # string | ID of the Multi-Host Integration. + multihostintegrationscreatesources := []byte(``) // []MultiHostIntegrationsCreateSources | The specifics of the sources to create within Multi-Host Integration. + + + var multiHostIntegrationsCreateSources v2025.[]MultiHostIntegrationsCreateSources + if err := json.Unmarshal(multihostintegrationscreatesources, &multiHostIntegrationsCreateSources); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.MultiHostIntegrationAPI.CreateSourcesWithinMultiHost(context.Background(), multihostId).MultiHostIntegrationsCreateSources(multiHostIntegrationsCreateSources).Execute() + //r, err := apiClient.V2025.MultiHostIntegrationAPI.CreateSourcesWithinMultiHost(context.Background(), multihostId).MultiHostIntegrationsCreateSources(multiHostIntegrationsCreateSources).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.CreateSourcesWithinMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /multihosts/{multihostId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/multi-host-integration#delete-multi-host + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of Multi-Host Integration to delete. # string | ID of Multi-Host Integration to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.MultiHostIntegrationAPI.DeleteMultiHost(context.Background(), multihostId).Execute() + //r, err := apiClient.V2025.MultiHostIntegrationAPI.DeleteMultiHost(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.DeleteMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /multihosts/{multihostId}/acctAggregationGroups + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/multi-host-integration#get-acct-aggregation-groups + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + 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) + 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) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetAcctAggregationGroups(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetAcctAggregationGroups(context.Background(), multihostId).Offset(offset).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetAcctAggregationGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAcctAggregationGroups`: []MultiHostIntegrationsAggScheduleUpdate + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetAcctAggregationGroups`: %v\n", resp) + } +- path: /multihosts/{multiHostId}/entitlementAggregationGroups + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/multi-host-integration#get-entitlement-aggregation-groups + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multiHostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + 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) + 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) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetEntitlementAggregationGroups(context.Background(), multiHostId).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetEntitlementAggregationGroups(context.Background(), multiHostId).Offset(offset).Limit(limit).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetEntitlementAggregationGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementAggregationGroups`: []MultiHostIntegrationsAggScheduleUpdate + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetEntitlementAggregationGroups`: %v\n", resp) + } +- path: /multihosts/{multihostId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/multi-host-integration#get-multi-host-integrations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration. # string | ID of the Multi-Host Integration. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetMultiHostIntegrations(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetMultiHostIntegrations(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostIntegrations`: MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostIntegrations`: %v\n", resp) + } +- path: /multihosts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/multi-host-integration#get-multi-host-integrations-list + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `id eq 2c91808b6ef1d43e016efba0ce470904` // 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: **type**: *in* **forSubAdminId**: *in* (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: **type**: *in* **forSubAdminId**: *in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetMultiHostIntegrationsList(context.Background()).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetMultiHostIntegrationsList(context.Background()).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).ForSubadmin(forSubadmin).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostIntegrationsList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostIntegrationsList`: []MultiHostIntegrations + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostIntegrationsList`: %v\n", resp) + } +- path: /multihosts/{multiHostId}/sources/errors + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/multi-host-integration#get-multi-host-source-creation-errors + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multiHostId := `004091cb79b04636b88662afa50a4440` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors(context.Background(), multiHostId).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors(context.Background(), multiHostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultiHostSourceCreationErrors`: []SourceCreationErrors + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultiHostSourceCreationErrors`: %v\n", resp) + } +- path: /multihosts/types + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/multi-host-integration#get-multihost-integration-types + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetMultihostIntegrationTypes(context.Background()).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetMultihostIntegrationTypes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetMultihostIntegrationTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMultihostIntegrationTypes`: []MultiHostIntegrationTemplateType + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetMultihostIntegrationTypes`: %v\n", resp) + } +- path: /multihosts/{multihostId}/sources + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/multi-host-integration#get-sources-within-multi-host + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostId := `aMultiHostId` // string | ID of the Multi-Host Integration to update # string | ID of the Multi-Host Integration to update + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `id eq 2c91808b6ef1d43e016efba0ce470904` // 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**: *in* (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**: *in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetSourcesWithinMultiHost(context.Background(), multihostId).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.GetSourcesWithinMultiHost(context.Background(), multihostId).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.GetSourcesWithinMultiHost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourcesWithinMultiHost`: []MultiHostSources + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.GetSourcesWithinMultiHost`: %v\n", resp) + } +- path: /multihosts/{multihostId}/sources/testConnection + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/multi-host-integration#test-connection-multi-host-sources + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostId := `2c91808568c529c60168cca6f90c1324` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.MultiHostIntegrationAPI.TestConnectionMultiHostSources(context.Background(), multihostId).Execute() + //r, err := apiClient.V2025.MultiHostIntegrationAPI.TestConnectionMultiHostSources(context.Background(), multihostId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.TestConnectionMultiHostSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /multihosts/{multihostId}/sources/{sourceId}/testConnection + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/multi-host-integration#test-source-connection-multihost + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostId := `2c91808568c529c60168cca6f90c1326` // string | ID of the Multi-Host Integration # string | ID of the Multi-Host Integration + sourceId := `2c91808568c529f60168cca6f90c1324` // string | ID of the source within the Multi-Host Integration # string | ID of the source within the Multi-Host Integration + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.TestSourceConnectionMultihost(context.Background(), multihostId, sourceId).Execute() + //resp, r, err := apiClient.V2025.MultiHostIntegrationAPI.TestSourceConnectionMultihost(context.Background(), multihostId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.TestSourceConnectionMultihost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConnectionMultihost`: TestSourceConnectionMultihost200Response + fmt.Fprintf(os.Stdout, "Response from `MultiHostIntegrationAPI.TestSourceConnectionMultihost`: %v\n", resp) + } +- path: /multihosts/{multihostId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/multi-host-integration#update-multi-host-sources + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multihostId := `anId` // string | ID of the Multi-Host Integration to update. # string | ID of the Multi-Host Integration to update. + updatemultihostsourcesrequestinner := []byte(`[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]`) // []UpdateMultiHostSourcesRequestInner | This endpoint allows you to update a Multi-Host Integration. + + + var updateMultiHostSourcesRequestInner v2025.[]UpdateMultiHostSourcesRequestInner + if err := json.Unmarshal(updatemultihostsourcesrequestinner, &updateMultiHostSourcesRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.MultiHostIntegrationAPI.UpdateMultiHostSources(context.Background(), multihostId).UpdateMultiHostSourcesRequestInner(updateMultiHostSourcesRequestInner).Execute() + //r, err := apiClient.V2025.MultiHostIntegrationAPI.UpdateMultiHostSources(context.Background(), multihostId).UpdateMultiHostSourcesRequestInner(updateMultiHostSourcesRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MultiHostIntegrationAPI.UpdateMultiHostSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-approvals/{id}/approve + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + nonemployeeapprovaldecision := []byte(`{ + "comment" : "Approved by manager" + }`) // NonEmployeeApprovalDecision | + + + var nonEmployeeApprovalDecision v2025.NonEmployeeApprovalDecision + if err := json.Unmarshal(nonemployeeapprovaldecision, &nonEmployeeApprovalDecision); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest(context.Background(), id).NonEmployeeApprovalDecision(nonEmployeeApprovalDecision).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest(context.Background(), id).NonEmployeeApprovalDecision(nonEmployeeApprovalDecision).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveNonEmployeeRequest`: NonEmployeeApprovalItem + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest`: %v\n", resp) + } +- path: /non-employee-records + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-Employee record creation request body. + + + var nonEmployeeRequestBody v2025.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord`: %v\n", resp) + } +- path: /non-employee-requests + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-Employee creation request body + + + var nonEmployeeRequestBody v2025.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeRequest`: NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest`: %v\n", resp) + } +- path: /non-employee-sources + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + nonemployeesourcerequestbody := []byte(`{ + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + }`) // NonEmployeeSourceRequestBody | Non-Employee source creation request body. + + + var nonEmployeeSourceRequestBody v2025.NonEmployeeSourceRequestBody + if err := json.Unmarshal(nonemployeesourcerequestbody, &nonEmployeeSourceRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource(context.Background()).NonEmployeeSourceRequestBody(nonEmployeeSourceRequestBody).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource(context.Background()).NonEmployeeSourceRequestBody(nonEmployeeSourceRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeSource`: NonEmployeeSourceWithCloudExternalId + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + nonemployeeschemaattributebody := []byte(`{ + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + }`) // NonEmployeeSchemaAttributeBody | + + + var nonEmployeeSchemaAttributeBody v2025.NonEmployeeSchemaAttributeBody + if err := json.Unmarshal(nonemployeeschemaattributebody, &nonEmployeeSchemaAttributeBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).NonEmployeeSchemaAttributeBody(nonEmployeeSchemaAttributeBody).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).NonEmployeeSchemaAttributeBody(nonEmployeeSchemaAttributeBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeSourceSchemaAttributes`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes`: %v\n", resp) + } +- path: /non-employee-records/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-Employee record id (UUID) # string | Non-Employee record id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord(context.Background(), id).Execute() + //r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-records/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + deletenonemployeerecordsinbulkrequest := []byte(``) // DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. + + + var deleteNonEmployeeRecordsInBulkRequest v2025.DeleteNonEmployeeRecordsInBulkRequest + if err := json.Unmarshal(deletenonemployeerecordsinbulkrequest, &deleteNonEmployeeRecordsInBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk(context.Background()).DeleteNonEmployeeRecordsInBulkRequest(deleteNonEmployeeRecordsInBulkRequest).Execute() + //r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk(context.Background()).DeleteNonEmployeeRecordsInBulkRequest(deleteNonEmployeeRecordsInBulkRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-requests/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ac110005-7156-1150-8171-5b292e3e0084` // string | Non-Employee request id in the UUID format # string | Non-Employee request id in the UUID format + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest(context.Background(), id).Execute() + //r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + //r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-sources/{sourceId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id # string | Source Id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource(context.Background(), sourceId).Execute() + //r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + //r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-sources/{id}/non-employees/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id (UUID) # string | Source Id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ExportNonEmployeeRecords(context.Background(), id).Execute() + //r, err := apiClient.V2025.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) + } + } +- path: /non-employee-sources/{id}/schema-attributes-template/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source Id (UUID) # string | Source Id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ExportNonEmployeeSourceSchemaTemplate(context.Background(), id).Execute() + //r, err := apiClient.V2025.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) + } + } +- path: /non-employee-approvals/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + includeDetail := true // bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval(context.Background(), id).IncludeDetail(includeDetail).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeApproval`: NonEmployeeApprovalItemDetail + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval`: %v\n", resp) + } +- path: /non-employee-approvals/summary/{requested-for} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary(context.Background(), requestedFor).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary(context.Background(), requestedFor).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeApprovalSummary`: NonEmployeeApprovalSummary + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary`: %v\n", resp) + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Source ID (UUID) # string | Source ID (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeBulkUploadStatus`: NonEmployeeBulkUploadStatus + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus`: %v\n", resp) + } +- path: /non-employee-records/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-Employee record id (UUID) # string | Non-Employee record id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord`: %v\n", resp) + } +- path: /non-employee-requests/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ac110005-7156-1150-8171-5b292e3e0084` // string | Non-Employee request id (UUID) # string | Non-Employee request id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRequest`: NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest`: %v\n", resp) + } +- path: /non-employee-requests/summary/{requested-for} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary(context.Background(), requestedFor).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary(context.Background(), requestedFor).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRequestSummary`: NonEmployeeRequestSummary + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeSchemaAttribute`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c91808b7c28b350017c2a2ec5790aa1` // string | Source Id # string | Source Id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeSource`: NonEmployeeSource + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).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) + } + // response from `GetNonEmployeeSourceSchemaAttributes`: []NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes`: %v\n", resp) + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id (UUID) # string | Source Id (UUID) + data := BINARY_DATA_HERE // *os.File | # *os.File | + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk(context.Background(), id).Data(data).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk(context.Background(), id).Data(data).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportNonEmployeeRecordsInBulk`: NonEmployeeBulkUploadJob + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk`: %v\n", resp) + } +- path: /non-employee-approvals + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#list-non-employee-approvals + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity for whom the request was made. *me* indicates the current user. (optional) # string | The identity for whom the request was made. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `approvalStatus eq "Pending"` // 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: **approvalStatus**: *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: **approvalStatus**: *eq* (optional) + sorters := `created` // 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: **created, modified** (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: **created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals(context.Background()).RequestedFor(requestedFor).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeApprovals`: []NonEmployeeApprovalItem + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals`: %v\n", resp) + } +- path: /non-employee-records + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#list-non-employee-records + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `accountName,sourceId` // 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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + filters := `sourceId eq "2c91808568c529c60168cca6f90c1313"` // 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: **sourceId**: *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: **sourceId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords(context.Background()).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords(context.Background()).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeRecords`: []NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords`: %v\n", resp) + } +- path: /non-employee-requests + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `e136567de87e4d029e60b3c3c55db56d` // string | The identity for whom the request was made. *me* indicates the current user. # string | The identity for whom the request was made. *me* indicates the current user. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `created,approvalStatus` // 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + filters := `sourceId eq "2c91808568c529c60168cca6f90c1313"` // 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: **sourceId**: *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: **sourceId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests(context.Background()).RequestedFor(requestedFor).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests(context.Background()).RequestedFor(requestedFor).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeRequests`: []NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests`: %v\n", resp) + } +- path: /non-employee-sources + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#list-non-employee-sources + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + requestedFor := `me` // string | Identity the request was made for. Use 'me' to indicate the current user. (optional) # string | Identity the request was made for. Use 'me' to indicate the current user. (optional) + nonEmployeeCount := true // bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) + sorters := `name,created` // 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, created, sourceId** (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, created, sourceId** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources(context.Background()).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources(context.Background()).Limit(limit).Offset(offset).Count(count).RequestedFor(requestedFor).NonEmployeeCount(nonEmployeeCount).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeSources`: []NonEmployeeSourceWithNECount + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources`: %v\n", resp) + } +- path: /non-employee-records/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-employee record id (UUID) # string | Non-employee record id (UUID) + jsonpatchoperation := []byte(`[{op=replace, path=/endDate, value=2019-08-23T18:40:35.772Z}]`) // []JsonPatchOperation | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + jsonpatchoperation := []byte(`[{op=replace, path=/label, value={new attribute label=null}}]`) // []JsonPatchOperation | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeSchemaAttribute`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id # string | Source Id + jsonpatchoperation := []byte(`[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}]`) // []JsonPatchOperation | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource(context.Background(), sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource(context.Background(), sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeSource`: NonEmployeeSource + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource`: %v\n", resp) + } +- path: /non-employee-approvals/{id}/reject + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + nonemployeerejectapprovaldecision := []byte(`{ + "comment" : "approved" + }`) // NonEmployeeRejectApprovalDecision | + + + var nonEmployeeRejectApprovalDecision v2025.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.V2025.NonEmployeeLifecycleManagementAPI.RejectNonEmployeeRequest(context.Background(), id).NonEmployeeRejectApprovalDecision(nonEmployeeRejectApprovalDecision).Execute() + //resp, r, err := apiClient.V2025.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) + } +- path: /non-employee-records/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-employee record id (UUID) # string | Non-employee record id (UUID) + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + + var nonEmployeeRequestBody v2025.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord(context.Background(), id).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V2025.NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord(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, "Full HTTP response: %v\n", r) + } + // response from `UpdateNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord`: %v\n", resp) + } +- path: /verified-domains + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/notifications#create-domain-dkim + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + domainaddress := []byte(`{ + "domain" : "sailpoint.com" + }`) // DomainAddress | + + + var domainAddress v2025.DomainAddress + if err := json.Unmarshal(domainaddress, &domainAddress); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.CreateDomainDkim(context.Background()).XSailPointExperimental(xSailPointExperimental).DomainAddress(domainAddress).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.CreateDomainDkim(context.Background()).XSailPointExperimental(xSailPointExperimental).DomainAddress(domainAddress).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateDomainDkim``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDomainDkim`: DomainStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateDomainDkim`: %v\n", resp) + } +- path: /notification-templates + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/notifications#create-notification-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + templatedto := []byte(`{ + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" + }`) // TemplateDto | + + + var templateDto v2025.TemplateDto + if err := json.Unmarshal(templatedto, &templateDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.CreateNotificationTemplate(context.Background()).XSailPointExperimental(xSailPointExperimental).TemplateDto(templateDto).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.CreateNotificationTemplate(context.Background()).XSailPointExperimental(xSailPointExperimental).TemplateDto(templateDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateNotificationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNotificationTemplate`: TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateNotificationTemplate`: %v\n", resp) + } +- path: /verified-from-addresses + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/notifications#create-verified-from-address + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + emailstatusdto := []byte(`{ + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + }`) // EmailStatusDto | + + + var emailStatusDto v2025.EmailStatusDto + if err := json.Unmarshal(emailstatusdto, &emailStatusDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.CreateVerifiedFromAddress(context.Background()).XSailPointExperimental(xSailPointExperimental).EmailStatusDto(emailStatusDto).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.CreateVerifiedFromAddress(context.Background()).XSailPointExperimental(xSailPointExperimental).EmailStatusDto(emailStatusDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.CreateVerifiedFromAddress``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateVerifiedFromAddress`: EmailStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.CreateVerifiedFromAddress`: %v\n", resp) + } +- path: /notification-templates/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/notifications#delete-notification-templates-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + templatebulkdeletedto := []byte(``) // []TemplateBulkDeleteDto | + + + var templateBulkDeleteDto v2025.[]TemplateBulkDeleteDto + if err := json.Unmarshal(templatebulkdeletedto, &templateBulkDeleteDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NotificationsAPI.DeleteNotificationTemplatesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).TemplateBulkDeleteDto(templateBulkDeleteDto).Execute() + //r, err := apiClient.V2025.NotificationsAPI.DeleteNotificationTemplatesInBulk(context.Background()).XSailPointExperimental(xSailPointExperimental).TemplateBulkDeleteDto(templateBulkDeleteDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.DeleteNotificationTemplatesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /verified-from-addresses/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/notifications#delete-verified-from-address + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `id_example` // string | # string | + 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.V2025.NotificationsAPI.DeleteVerifiedFromAddress(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.NotificationsAPI.DeleteVerifiedFromAddress(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.DeleteVerifiedFromAddress``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /verified-domains + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/notifications#get-dkim-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.GetDkimAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.GetDkimAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetDkimAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDkimAttributes`: []DkimAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetDkimAttributes`: %v\n", resp) + } +- path: /mail-from-attributes/{identity} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/notifications#get-mail-from-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `bobsmith@sailpoint.com` // string | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # string | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + 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.NotificationsAPI.GetMailFromAttributes(context.Background()).Id(id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.GetMailFromAttributes(context.Background()).Id(id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetMailFromAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMailFromAttributes`: MailFromAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetMailFromAttributes`: %v\n", resp) + } +- path: /notification-templates/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/notifications#get-notification-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Notification Template # string | Id of the Notification Template + 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.NotificationsAPI.GetNotificationTemplate(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.GetNotificationTemplate(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetNotificationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNotificationTemplate`: TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetNotificationTemplate`: %v\n", resp) + } +- path: /notification-template-context + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/notifications#get-notifications-template-context + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.GetNotificationsTemplateContext(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.GetNotificationsTemplateContext(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.GetNotificationsTemplateContext``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNotificationsTemplateContext`: NotificationTemplateContext + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.GetNotificationsTemplateContext`: %v\n", resp) + } +- path: /verified-from-addresses + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/notifications#list-from-addresses + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `email eq "john.doe@company.com"` // 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: **email**: *eq, ge, le, sw* (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: **email**: *eq, ge, le, sw* (optional) + sorters := `email` // 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: **email** (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: **email** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.ListFromAddresses(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.ListFromAddresses(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListFromAddresses``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListFromAddresses`: []EmailStatusDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListFromAddresses`: %v\n", resp) + } +- path: /notification-preferences/{key} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/notifications#list-notification-preferences + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.ListNotificationPreferences(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.ListNotificationPreferences(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationPreferences``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationPreferences`: PreferencesDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationPreferences`: %v\n", resp) + } +- path: /notification-template-defaults + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/notifications#list-notification-template-defaults + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + filters := `key eq "cloud_manual_work_item_summary"` // 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.ListNotificationTemplateDefaults(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.ListNotificationTemplateDefaults(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationTemplateDefaults``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationTemplateDefaults`: []TemplateDtoDefault + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationTemplateDefaults`: %v\n", resp) + } +- path: /notification-templates + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/notifications#list-notification-templates + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + filters := `medium eq "EMAIL"` // 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.ListNotificationTemplates(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.ListNotificationTemplates(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.ListNotificationTemplates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNotificationTemplates`: []TemplateDto + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.ListNotificationTemplates`: %v\n", resp) + } +- path: /mail-from-attributes + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/notifications#put-mail-from-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + mailfromattributesdto := []byte(`{ + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + }`) // MailFromAttributesDto | + + + var mailFromAttributesDto v2025.MailFromAttributesDto + if err := json.Unmarshal(mailfromattributesdto, &mailFromAttributesDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.NotificationsAPI.PutMailFromAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).MailFromAttributesDto(mailFromAttributesDto).Execute() + //resp, r, err := apiClient.V2025.NotificationsAPI.PutMailFromAttributes(context.Background()).XSailPointExperimental(xSailPointExperimental).MailFromAttributesDto(mailFromAttributesDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.PutMailFromAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutMailFromAttributes`: MailFromAttributes + fmt.Fprintf(os.Stdout, "Response from `NotificationsAPI.PutMailFromAttributes`: %v\n", resp) + } +- path: /send-test-notification + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/notifications#send-test-notification + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + sendtestnotificationrequestdto := []byte(`{ + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + }`) // SendTestNotificationRequestDto | + + + var sendTestNotificationRequestDto v2025.SendTestNotificationRequestDto + if err := json.Unmarshal(sendtestnotificationrequestdto, &sendTestNotificationRequestDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.NotificationsAPI.SendTestNotification(context.Background()).XSailPointExperimental(xSailPointExperimental).SendTestNotificationRequestDto(sendTestNotificationRequestDto).Execute() + //r, err := apiClient.V2025.NotificationsAPI.SendTestNotification(context.Background()).XSailPointExperimental(xSailPointExperimental).SendTestNotificationRequestDto(sendTestNotificationRequestDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NotificationsAPI.SendTestNotification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /oauth-clients + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/o-auth-clients#create-oauth-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + createoauthclientrequest := []byte(`{ + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + }`) // CreateOAuthClientRequest | + + + var createOAuthClientRequest v2025.CreateOAuthClientRequest + if err := json.Unmarshal(createoauthclientrequest, &createOAuthClientRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.OAuthClientsAPI.CreateOauthClient(context.Background()).CreateOAuthClientRequest(createOAuthClientRequest).Execute() + //resp, r, err := apiClient.V2025.OAuthClientsAPI.CreateOauthClient(context.Background()).CreateOAuthClientRequest(createOAuthClientRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.CreateOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateOauthClient`: CreateOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.CreateOauthClient`: %v\n", resp) + } +- path: /oauth-clients/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/o-auth-clients#delete-oauth-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.OAuthClientsAPI.DeleteOauthClient(context.Background(), id).Execute() + //r, err := apiClient.V2025.OAuthClientsAPI.DeleteOauthClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.DeleteOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /oauth-clients/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/o-auth-clients#get-oauth-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.OAuthClientsAPI.GetOauthClient(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.OAuthClientsAPI.GetOauthClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.GetOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOauthClient`: GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.GetOauthClient`: %v\n", resp) + } +- path: /oauth-clients + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/o-auth-clients#list-oauth-clients + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filters := `lastUsed le 2023-02-05T10:59:27.214Z` // 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.OAuthClientsAPI.ListOauthClients(context.Background()).Execute() + //resp, r, err := apiClient.V2025.OAuthClientsAPI.ListOauthClients(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.ListOauthClients``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOauthClients`: []GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.ListOauthClients`: %v\n", resp) + } +- path: /oauth-clients/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/o-auth-clients#patch-oauth-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + jsonpatchoperation := []byte(`[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}]`) // []JsonPatchOperation | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.OAuthClientsAPI.PatchOauthClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.OAuthClientsAPI.PatchOauthClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.PatchOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchOauthClient`: GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.PatchOauthClient`: %v\n", resp) + } +- path: /org-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/org-config#get-org-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.OrgConfigAPI.GetOrgConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.OrgConfigAPI.GetOrgConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.GetOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOrgConfig`: OrgConfig + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.GetOrgConfig`: %v\n", resp) + } +- path: /org-config/valid-time-zones + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/org-config#get-valid-time-zones + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.OrgConfigAPI.GetValidTimeZones(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.OrgConfigAPI.GetValidTimeZones(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.GetValidTimeZones``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetValidTimeZones`: []string + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.GetValidTimeZones`: %v\n", resp) + } +- path: /org-config + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/org-config#patch-org-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/timeZone, value=America/Toronto}]`) // []JsonPatchOperation | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.OrgConfigAPI.PatchOrgConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.OrgConfigAPI.PatchOrgConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.PatchOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchOrgConfig`: OrgConfig + fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.PatchOrgConfig`: %v\n", resp) + } +- path: /password-org-config + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-configuration#create-password-org-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordorgconfig := []byte(`{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }`) // PasswordOrgConfig | + + + var passwordOrgConfig v2025.PasswordOrgConfig + if err := json.Unmarshal(passwordorgconfig, &passwordOrgConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordConfigurationAPI.CreatePasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + //resp, r, err := apiClient.V2025.PasswordConfigurationAPI.CreatePasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.CreatePasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.CreatePasswordOrgConfig`: %v\n", resp) + } +- path: /password-org-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-configuration#get-password-org-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordConfigurationAPI.GetPasswordOrgConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.PasswordConfigurationAPI.GetPasswordOrgConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.GetPasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.GetPasswordOrgConfig`: %v\n", resp) + } +- path: /password-org-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-configuration#put-password-org-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordorgconfig := []byte(`{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }`) // PasswordOrgConfig | + + + var passwordOrgConfig v2025.PasswordOrgConfig + if err := json.Unmarshal(passwordorgconfig, &passwordOrgConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordConfigurationAPI.PutPasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + //resp, r, err := apiClient.V2025.PasswordConfigurationAPI.PutPasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.PutPasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutPasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.PutPasswordOrgConfig`: %v\n", resp) + } +- path: /password-dictionary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-dictionary#get-password-dictionary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordDictionaryAPI.GetPasswordDictionary(context.Background()).Execute() + //resp, r, err := apiClient.V2025.PasswordDictionaryAPI.GetPasswordDictionary(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordDictionaryAPI.GetPasswordDictionary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordDictionary`: string + fmt.Fprintf(os.Stdout, "Response from `PasswordDictionaryAPI.GetPasswordDictionary`: %v\n", resp) + } +- path: /password-dictionary + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-dictionary#put-password-dictionary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.PasswordDictionaryAPI.PutPasswordDictionary(context.Background()).Execute() + //r, err := apiClient.V2025.PasswordDictionaryAPI.PutPasswordDictionary(context.Background()).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordDictionaryAPI.PutPasswordDictionary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /generate-password-reset-token/digit + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-management#create-digit-token + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + passworddigittokenreset := []byte(`{ + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + }`) // PasswordDigitTokenReset | + + + var passwordDigitTokenReset v2025.PasswordDigitTokenReset + if err := json.Unmarshal(passworddigittokenreset, &passwordDigitTokenReset); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordManagementAPI.CreateDigitToken(context.Background()).XSailPointExperimental(xSailPointExperimental).PasswordDigitTokenReset(passwordDigitTokenReset).Execute() + //resp, r, err := apiClient.V2025.PasswordManagementAPI.CreateDigitToken(context.Background()).XSailPointExperimental(xSailPointExperimental).PasswordDigitTokenReset(passwordDigitTokenReset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.CreateDigitToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateDigitToken`: PasswordDigitToken + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.CreateDigitToken`: %v\n", resp) + } +- path: /password-change-status/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-management#get-password-change-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `089899f13a8f4da7824996191587bab9` // string | Password change request ID # string | Password change request ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordManagementAPI.GetPasswordChangeStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.PasswordManagementAPI.GetPasswordChangeStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.GetPasswordChangeStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordChangeStatus`: PasswordStatus + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.GetPasswordChangeStatus`: %v\n", resp) + } +- path: /query-password-info + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-management#query-password-info + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordinfoquerydto := []byte(`{ + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + }`) // PasswordInfoQueryDTO | + + + var passwordInfoQueryDTO v2025.PasswordInfoQueryDTO + if err := json.Unmarshal(passwordinfoquerydto, &passwordInfoQueryDTO); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordManagementAPI.QueryPasswordInfo(context.Background()).PasswordInfoQueryDTO(passwordInfoQueryDTO).Execute() + //resp, r, err := apiClient.V2025.PasswordManagementAPI.QueryPasswordInfo(context.Background()).PasswordInfoQueryDTO(passwordInfoQueryDTO).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.QueryPasswordInfo``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `QueryPasswordInfo`: PasswordInfo + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.QueryPasswordInfo`: %v\n", resp) + } +- path: /set-password + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-management#set-password + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordchangerequest := []byte(`{ + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + }`) // PasswordChangeRequest | + + + var passwordChangeRequest v2025.PasswordChangeRequest + if err := json.Unmarshal(passwordchangerequest, &passwordChangeRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordManagementAPI.SetPassword(context.Background()).PasswordChangeRequest(passwordChangeRequest).Execute() + //resp, r, err := apiClient.V2025.PasswordManagementAPI.SetPassword(context.Background()).PasswordChangeRequest(passwordChangeRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.SetPassword``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetPassword`: PasswordChangeResponse + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.SetPassword`: %v\n", resp) + } +- path: /password-policies + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-policies#create-password-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordpolicyv3dto := []byte(`{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : 1939056206564, + "validateAgainstAccountId" : false, + "dateCreated" : 1639056206564, + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }`) // PasswordPolicyV3Dto | + + + var passwordPolicyV3Dto v2025.PasswordPolicyV3Dto + if err := json.Unmarshal(passwordpolicyv3dto, &passwordPolicyV3Dto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordPoliciesAPI.CreatePasswordPolicy(context.Background()).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + //resp, r, err := apiClient.V2025.PasswordPoliciesAPI.CreatePasswordPolicy(context.Background()).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.CreatePasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordPolicy`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.CreatePasswordPolicy`: %v\n", resp) + } +- path: /password-policies/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-policies#delete-password-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ff808081838d9e9d01838da6a03e0002` // string | The ID of password policy to delete. # string | The ID of password policy to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.PasswordPoliciesAPI.DeletePasswordPolicy(context.Background(), id).Execute() + //r, err := apiClient.V2025.PasswordPoliciesAPI.DeletePasswordPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.DeletePasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /password-policies/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-policies#get-password-policy-by-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ff808081838d9e9d01838da6a03e0005` // string | The ID of password policy to retrieve. # string | The ID of password policy to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordPoliciesAPI.GetPasswordPolicyById(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.PasswordPoliciesAPI.GetPasswordPolicyById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.GetPasswordPolicyById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordPolicyById`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.GetPasswordPolicyById`: %v\n", resp) + } +- path: /password-policies + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-policies#list-password-policies + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordPoliciesAPI.ListPasswordPolicies(context.Background()).Execute() + //resp, r, err := apiClient.V2025.PasswordPoliciesAPI.ListPasswordPolicies(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.ListPasswordPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPasswordPolicies`: []PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.ListPasswordPolicies`: %v\n", resp) + } +- path: /password-policies/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-policies#set-password-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ff808081838d9e9d01838da6a03e0007` // string | The ID of password policy to update. # string | The ID of password policy to update. + passwordpolicyv3dto := []byte(`{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : 1939056206564, + "validateAgainstAccountId" : false, + "dateCreated" : 1639056206564, + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }`) // PasswordPolicyV3Dto | + + + var passwordPolicyV3Dto v2025.PasswordPolicyV3Dto + if err := json.Unmarshal(passwordpolicyv3dto, &passwordPolicyV3Dto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordPoliciesAPI.SetPasswordPolicy(context.Background(), id).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + //resp, r, err := apiClient.V2025.PasswordPoliciesAPI.SetPasswordPolicy(context.Background(), id).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.SetPasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetPasswordPolicy`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.SetPasswordPolicy`: %v\n", resp) + } +- path: /password-sync-groups + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-sync-groups#create-password-sync-group + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordsyncgroup := []byte(`{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }`) // PasswordSyncGroup | + + + var passwordSyncGroup v2025.PasswordSyncGroup + if err := json.Unmarshal(passwordsyncgroup, &passwordSyncGroup); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordSyncGroupsAPI.CreatePasswordSyncGroup(context.Background()).PasswordSyncGroup(passwordSyncGroup).Execute() + //resp, r, err := apiClient.V2025.PasswordSyncGroupsAPI.CreatePasswordSyncGroup(context.Background()).PasswordSyncGroup(passwordSyncGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.CreatePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.CreatePasswordSyncGroup`: %v\n", resp) + } +- path: /password-sync-groups/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-sync-groups#delete-password-sync-group + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to delete. # string | The ID of password sync group to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.PasswordSyncGroupsAPI.DeletePasswordSyncGroup(context.Background(), id).Execute() + //r, err := apiClient.V2025.PasswordSyncGroupsAPI.DeletePasswordSyncGroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.DeletePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /password-sync-groups/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-sync-groups#get-password-sync-group + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to retrieve. # string | The ID of password sync group to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordSyncGroupsAPI.GetPasswordSyncGroup(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.PasswordSyncGroupsAPI.GetPasswordSyncGroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.GetPasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.GetPasswordSyncGroup`: %v\n", resp) + } +- path: /password-sync-groups + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-sync-groups#get-password-sync-groups + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordSyncGroupsAPI.GetPasswordSyncGroups(context.Background()).Execute() + //resp, r, err := apiClient.V2025.PasswordSyncGroupsAPI.GetPasswordSyncGroups(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.GetPasswordSyncGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordSyncGroups`: []PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.GetPasswordSyncGroups`: %v\n", resp) + } +- path: /password-sync-groups/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/password-sync-groups#update-password-sync-group + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to update. # string | The ID of password sync group to update. + passwordsyncgroup := []byte(`{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }`) // PasswordSyncGroup | + + + var passwordSyncGroup v2025.PasswordSyncGroup + if err := json.Unmarshal(passwordsyncgroup, &passwordSyncGroup); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PasswordSyncGroupsAPI.UpdatePasswordSyncGroup(context.Background(), id).PasswordSyncGroup(passwordSyncGroup).Execute() + //resp, r, err := apiClient.V2025.PasswordSyncGroupsAPI.UpdatePasswordSyncGroup(context.Background(), id).PasswordSyncGroup(passwordSyncGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.UpdatePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.UpdatePasswordSyncGroup`: %v\n", resp) + } +- path: /personal-access-tokens + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/personal-access-tokens#create-personal-access-token + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + createpersonalaccesstokenrequest := []byte(`{ + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + }`) // CreatePersonalAccessTokenRequest | Name and scope of personal access token. + + + var createPersonalAccessTokenRequest v2025.CreatePersonalAccessTokenRequest + if err := json.Unmarshal(createpersonalaccesstokenrequest, &createPersonalAccessTokenRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PersonalAccessTokensAPI.CreatePersonalAccessToken(context.Background()).CreatePersonalAccessTokenRequest(createPersonalAccessTokenRequest).Execute() + //resp, r, err := apiClient.V2025.PersonalAccessTokensAPI.CreatePersonalAccessToken(context.Background()).CreatePersonalAccessTokenRequest(createPersonalAccessTokenRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.CreatePersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePersonalAccessToken`: CreatePersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.CreatePersonalAccessToken`: %v\n", resp) + } +- path: /personal-access-tokens/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/personal-access-tokens#delete-personal-access-token + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The personal access token id # string | The personal access token id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.PersonalAccessTokensAPI.DeletePersonalAccessToken(context.Background(), id).Execute() + //r, err := apiClient.V2025.PersonalAccessTokensAPI.DeletePersonalAccessToken(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.DeletePersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /personal-access-tokens + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/personal-access-tokens#list-personal-access-tokens + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `2c9180867b50d088017b554662fb281e` // string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) # string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + filters := `lastUsed le 2023-02-05T10:59:27.214Z` // 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PersonalAccessTokensAPI.ListPersonalAccessTokens(context.Background()).Execute() + //resp, r, err := apiClient.V2025.PersonalAccessTokensAPI.ListPersonalAccessTokens(context.Background()).OwnerId(ownerId).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.ListPersonalAccessTokens``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPersonalAccessTokens`: []GetPersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.ListPersonalAccessTokens`: %v\n", resp) + } +- path: /personal-access-tokens/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/personal-access-tokens#patch-personal-access-token + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The Personal Access Token id # string | The Personal Access Token id + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}]`) // []JsonPatchOperation | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PersonalAccessTokensAPI.PatchPersonalAccessToken(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.PersonalAccessTokensAPI.PatchPersonalAccessToken(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.PatchPersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPersonalAccessToken`: GetPersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.PatchPersonalAccessToken`: %v\n", resp) + } +- path: /public-identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/public-identities#get-public-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `firstname eq "John"` // 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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) + addCoreFilters := false // bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to false) # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to false) + sorters := `name` // 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** (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** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PublicIdentitiesAPI.GetPublicIdentities(context.Background()).Execute() + //resp, r, err := apiClient.V2025.PublicIdentitiesAPI.GetPublicIdentities(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).AddCoreFilters(addCoreFilters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesAPI.GetPublicIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPublicIdentities`: []PublicIdentity + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesAPI.GetPublicIdentities`: %v\n", resp) + } +- path: /public-identities-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/public-identities-config#get-public-identity-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PublicIdentitiesConfigAPI.GetPublicIdentityConfig(context.Background()).Execute() + //resp, r, err := apiClient.V2025.PublicIdentitiesConfigAPI.GetPublicIdentityConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesConfigAPI.GetPublicIdentityConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPublicIdentityConfig`: PublicIdentityConfig + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesConfigAPI.GetPublicIdentityConfig`: %v\n", resp) + } +- path: /public-identities-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/public-identities-config#update-public-identity-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + publicidentityconfig := []byte(`{ + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }`) // PublicIdentityConfig | + + + var publicIdentityConfig v2025.PublicIdentityConfig + if err := json.Unmarshal(publicidentityconfig, &publicIdentityConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig(context.Background()).PublicIdentityConfig(publicIdentityConfig).Execute() + //resp, r, err := apiClient.V2025.PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig(context.Background()).PublicIdentityConfig(publicIdentityConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePublicIdentityConfig`: PublicIdentityConfig + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig`: %v\n", resp) + } +- path: /reports/{id}/cancel + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/reports-data-extraction#cancel-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `a1ed223247144cc29d23c632624b4767` // string | ID of the running Report to cancel # string | ID of the running Report to cancel + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ReportsDataExtractionAPI.CancelReport(context.Background(), id).Execute() + //r, err := apiClient.V2025.ReportsDataExtractionAPI.CancelReport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.CancelReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /reports/{taskResultId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/reports-data-extraction#get-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + taskResultId := `ef38f94347e94562b5bb8424a56397d8` // string | Unique identifier of the task result which handled report # string | Unique identifier of the task result which handled report + fileFormat := `csv` // string | Output format of the requested report file # string | Output format of the requested report file + name := `Identities Details Report` // string | preferred Report file name, by default will be used report name from task result. (optional) # string | preferred Report file name, by default will be used report name from task result. (optional) + auditable := true // bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to false) # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ReportsDataExtractionAPI.GetReport(context.Background(), taskResultId).FileFormat(fileFormat).Execute() + //resp, r, err := apiClient.V2025.ReportsDataExtractionAPI.GetReport(context.Background(), taskResultId).FileFormat(fileFormat).Name(name).Auditable(auditable).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.GetReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.GetReport`: %v\n", resp) + } +- path: /reports/{taskResultId}/result + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/reports-data-extraction#get-report-result + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + taskResultId := `ef38f94347e94562b5bb8424a56397d8` // string | Unique identifier of the task result which handled report # string | Unique identifier of the task result which handled report + completed := true // bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to false) # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ReportsDataExtractionAPI.GetReportResult(context.Background(), taskResultId).Execute() + //resp, r, err := apiClient.V2025.ReportsDataExtractionAPI.GetReportResult(context.Background(), taskResultId).Completed(completed).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.GetReportResult``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReportResult`: ReportResults + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.GetReportResult`: %v\n", resp) + } +- path: /reports/run + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/reports-data-extraction#start-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reportdetails := []byte(`{ + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + }`) // ReportDetails | + + + var reportDetails v2025.ReportDetails + if err := json.Unmarshal(reportdetails, &reportDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ReportsDataExtractionAPI.StartReport(context.Background()).ReportDetails(reportDetails).Execute() + //resp, r, err := apiClient.V2025.ReportsDataExtractionAPI.StartReport(context.Background()).ReportDetails(reportDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.StartReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartReport`: TaskResultDetails + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.StartReport`: %v\n", resp) + } +- path: /requestable-objects + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/requestable-objects#list-requestable-objects + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw "bob"` // 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, in, sw* (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, in, sw* (optional) + sorters := `name` // 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** (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** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RequestableObjectsAPI.ListRequestableObjects(context.Background()).Execute() + //resp, r, err := apiClient.V2025.RequestableObjectsAPI.ListRequestableObjects(context.Background()).IdentityId(identityId).Types(types).Term(term).Statuses(statuses).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RequestableObjectsAPI.ListRequestableObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListRequestableObjects`: []RequestableObject + fmt.Fprintf(os.Stdout, "Response from `RequestableObjectsAPI.ListRequestableObjects`: %v\n", resp) + } +- path: /role-insights/requests + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/role-insights#create-role-insight-requests + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RoleInsightsAPI.CreateRoleInsightRequests(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.CreateRoleInsightRequests(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.CreateRoleInsightRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRoleInsightRequests`: RoleInsightsResponse + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.CreateRoleInsightRequests`: %v\n", resp) + } +- path: /role-insights/{insightId}/entitlement-changes/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/role-insights#download-role-insights-entitlements-changes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight 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") + sorters := `identitiesWithAccess` // 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + filters := `name sw "r"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DownloadRoleInsightsEntitlementsChanges`: string + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.DownloadRoleInsightsEntitlementsChanges`: %v\n", resp) + } +- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/role-insights#get-entitlement-changes-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight id + entitlementId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The entitlement id # string | The entitlement 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") + hasEntitlement := true // bool | Identity has this entitlement or not (optional) (default to false) # bool | Identity has this entitlement or not (optional) (default to false) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name` // 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** (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** (optional) + filters := `name sw "Jan"` // 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: **name**: *sw* (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: **name**: *sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RoleInsightsAPI.GetEntitlementChangesIdentities(context.Background(), insightId, entitlementId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.GetEntitlementChangesIdentities(context.Background(), insightId, entitlementId).XSailPointExperimental(xSailPointExperimental).HasEntitlement(hasEntitlement).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetEntitlementChangesIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEntitlementChangesIdentities`: []RoleInsightsIdentities + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetEntitlementChangesIdentities`: %v\n", resp) + } +- path: /role-insights/{insightId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/role-insights#get-role-insight + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight 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.RoleInsightsAPI.GetRoleInsight(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsight(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsight``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsight`: RoleInsight + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsight`: %v\n", resp) + } +- path: /role-insights + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/role-insights#get-role-insights + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `numberOfUpdates` // 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + filters := `name sw "John"` // 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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsights(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsights(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsights``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsights`: []RoleInsight + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsights`: %v\n", resp) + } +- path: /role-insights/{insightId}/current-entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/role-insights#get-role-insights-current-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight 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") + filters := `name sw "r"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsightsCurrentEntitlements(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsightsCurrentEntitlements(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsCurrentEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsCurrentEntitlements`: []RoleInsightsEntitlement + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsCurrentEntitlements`: %v\n", resp) + } +- path: /role-insights/{insightId}/entitlement-changes + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/role-insights#get-role-insights-entitlements-changes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + insightId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insight id # string | The role insight 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") + sorters := `sorters_example` // 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: **identitiesWithAccess, name** (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: **identitiesWithAccess, name** (optional) + filters := `name sw "Admin"` // 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsightsEntitlementsChanges(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsightsEntitlementsChanges(context.Background(), insightId).XSailPointExperimental(xSailPointExperimental).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsEntitlementsChanges``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsEntitlementsChanges`: []RoleInsightsEntitlementChanges + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsEntitlementsChanges`: %v\n", resp) + } +- path: /role-insights/requests/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/role-insights#get-role-insights-requests + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | The role insights request id # string | The role insights request 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.RoleInsightsAPI.GetRoleInsightsRequests(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsightsRequests(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsRequests`: RoleInsightsResponse + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsRequests`: %v\n", resp) + } +- path: /role-insights/summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/role-insights#get-role-insights-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsightsSummary(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RoleInsightsAPI.GetRoleInsightsSummary(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RoleInsightsAPI.GetRoleInsightsSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleInsightsSummary`: RoleInsightsSummary + fmt.Fprintf(os.Stdout, "Response from `RoleInsightsAPI.GetRoleInsightsSummary`: %v\n", resp) + } +- path: /roles + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/roles#create-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + role := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + }`) // Role | + + + var role v2025.Role + if err := json.Unmarshal(role, &role); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.CreateRole(context.Background()).Role(role).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.CreateRole(context.Background()).Role(role).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.CreateRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.CreateRole`: %v\n", resp) + } +- path: /roles/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/roles#delete-bulk-roles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + rolebulkdeleterequest := []byte(`{ + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + }`) // RoleBulkDeleteRequest | + + + var roleBulkDeleteRequest v2025.RoleBulkDeleteRequest + if err := json.Unmarshal(rolebulkdeleterequest, &roleBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.DeleteBulkRoles(context.Background()).RoleBulkDeleteRequest(roleBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.DeleteBulkRoles(context.Background()).RoleBulkDeleteRequest(roleBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteBulkRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteBulkRoles`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.DeleteBulkRoles`: %v\n", resp) + } +- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/roles#delete-metadata-from-role-by-key-and-value + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808c74ff913f0175097daa9d59cd` // string | The role's id. # string | The role's id. + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.RolesAPI.DeleteMetadataFromRoleByKeyAndValue(context.Background(), id, attributeKey, attributeValue).Execute() + //r, err := apiClient.V2025.RolesAPI.DeleteMetadataFromRoleByKeyAndValue(context.Background(), id, attributeKey, attributeValue).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteMetadataFromRoleByKeyAndValue``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /roles/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/roles#delete-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role # string | ID of the Role + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.RolesAPI.DeleteRole(context.Background(), id).Execute() + //r, err := apiClient.V2025.RolesAPI.DeleteRole(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /roles/access-model-metadata/bulk-update + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/roles#get-bulk-update-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.GetBulkUpdateStatus(context.Background()).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.GetBulkUpdateStatus(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetBulkUpdateStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBulkUpdateStatus`: []RoleGetAllBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetBulkUpdateStatus`: %v\n", resp) + } +- path: /roles/access-model-metadata/bulk-update/id + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/roles#get-bulk-update-status-by-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c24359c389374d0fb8585698a2189e3d` // string | The Id of the bulk update task. # string | The Id of the bulk update task. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.GetBulkUpdateStatusById(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.GetBulkUpdateStatusById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetBulkUpdateStatusById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBulkUpdateStatusById`: RoleBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetBulkUpdateStatusById`: %v\n", resp) + } +- path: /roles/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/roles#get-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role # string | ID of the Role + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.GetRole(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.GetRole(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRole`: %v\n", resp) + } +- path: /roles/{id}/assigned-identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/roles#get-role-assigned-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role for which the assigned Identities are to be listed # string | ID of the Role for which the assigned Identities are to be listed + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw Joe` // 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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + sorters := `aliasName,name` // 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: **id, name, aliasName, email** (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: **id, name, aliasName, email** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.GetRoleAssignedIdentities(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.GetRoleAssignedIdentities(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRoleAssignedIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleAssignedIdentities`: []RoleIdentity + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRoleAssignedIdentities`: %v\n", resp) + } +- path: /roles/{id}/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/roles#get-role-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121919ecca` // string | Containing role's ID. # string | Containing role's 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") + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.GetRoleEntitlements(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.GetRoleEntitlements(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRoleEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRoleEntitlements`: %v\n", resp) + } +- path: /roles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/roles#list-roles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `requestable 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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.ListRoles(context.Background()).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.ListRoles(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.ListRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListRoles`: []Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.ListRoles`: %v\n", resp) + } +- path: /roles/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/roles#patch-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role to patch # string | ID of the Role to patch + jsonpatchoperation := []byte(`[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.PatchRole(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.PatchRole(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.PatchRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.PatchRole`: %v\n", resp) + } +- path: /roles/filter + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/roles#search-roles-by-filter + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit := 50 // 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 50) # 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 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) + rolelistfilterdto := []byte(`{ + "ammKeyValues" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "secret" ] + } ], + "filters" : "dimensional eq false" + }`) // RoleListFilterDTO | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.SearchRolesByFilter(context.Background()).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.SearchRolesByFilter(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).RoleListFilterDTO(roleListFilterDTO).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.SearchRolesByFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchRolesByFilter`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.SearchRolesByFilter`: %v\n", resp) + } +- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/roles#update-attribute-key-and-value-to-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c24359c389374d0fb8585698a2189e3d` // string | The Id of a role # string | The Id of a role + attributeKey := `iscPrivacy` // string | Technical name of the Attribute. # string | Technical name of the Attribute. + attributeValue := `public` // string | Technical name of the Attribute Value. # string | Technical name of the Attribute Value. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.UpdateAttributeKeyAndValueToRole(context.Background(), id, attributeKey, attributeValue).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.UpdateAttributeKeyAndValueToRole(context.Background(), id, attributeKey, attributeValue).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.UpdateAttributeKeyAndValueToRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAttributeKeyAndValueToRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.UpdateAttributeKeyAndValueToRole`: %v\n", resp) + } +- path: /roles/access-model-metadata/bulk-update/filter + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/roles#update-roles-metadata-by-filter + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + rolemetadatabulkupdatebyfilterrequest := []byte(`{ + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "filters" : " requestable eq false", + "replaceScope" : "ALL", + "operation" : "REPLACE" + }`) // RoleMetadataBulkUpdateByFilterRequest | + + + var roleMetadataBulkUpdateByFilterRequest v2025.RoleMetadataBulkUpdateByFilterRequest + if err := json.Unmarshal(rolemetadatabulkupdatebyfilterrequest, &roleMetadataBulkUpdateByFilterRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.UpdateRolesMetadataByFilter(context.Background()).RoleMetadataBulkUpdateByFilterRequest(roleMetadataBulkUpdateByFilterRequest).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.UpdateRolesMetadataByFilter(context.Background()).RoleMetadataBulkUpdateByFilterRequest(roleMetadataBulkUpdateByFilterRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.UpdateRolesMetadataByFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRolesMetadataByFilter`: RoleBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.UpdateRolesMetadataByFilter`: %v\n", resp) + } +- path: /roles/access-model-metadata/bulk-update/ids + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/roles#update-roles-metadata-by-ids + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + rolemetadatabulkupdatebyidrequest := []byte(`{ + "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + }`) // RoleMetadataBulkUpdateByIdRequest | + + + var roleMetadataBulkUpdateByIdRequest v2025.RoleMetadataBulkUpdateByIdRequest + if err := json.Unmarshal(rolemetadatabulkupdatebyidrequest, &roleMetadataBulkUpdateByIdRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.UpdateRolesMetadataByIds(context.Background()).RoleMetadataBulkUpdateByIdRequest(roleMetadataBulkUpdateByIdRequest).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.UpdateRolesMetadataByIds(context.Background()).RoleMetadataBulkUpdateByIdRequest(roleMetadataBulkUpdateByIdRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.UpdateRolesMetadataByIds``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRolesMetadataByIds`: RoleBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.UpdateRolesMetadataByIds`: %v\n", resp) + } +- path: /roles/access-model-metadata/bulk-update/query + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/roles#update-roles-metadata-by-query + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + rolemetadatabulkupdatebyqueryrequest := []byte(`{ + "query" : { + "query\"" : { + "indices" : [ "roles" ], + "queryType" : "TEXT", + "textQuery" : { + "terms" : [ "test123" ], + "fields" : [ "id" ], + "matchAny" : false, + "contains" : true + }, + "includeNested" : false + } + }, + "values" : [ { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + }, { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + }`) // RoleMetadataBulkUpdateByQueryRequest | + + + var roleMetadataBulkUpdateByQueryRequest v2025.RoleMetadataBulkUpdateByQueryRequest + if err := json.Unmarshal(rolemetadatabulkupdatebyqueryrequest, &roleMetadataBulkUpdateByQueryRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.RolesAPI.UpdateRolesMetadataByQuery(context.Background()).RoleMetadataBulkUpdateByQueryRequest(roleMetadataBulkUpdateByQueryRequest).Execute() + //resp, r, err := apiClient.V2025.RolesAPI.UpdateRolesMetadataByQuery(context.Background()).RoleMetadataBulkUpdateByQueryRequest(roleMetadataBulkUpdateByQueryRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.UpdateRolesMetadataByQuery``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateRolesMetadataByQuery`: RoleBulkUpdateResponse + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.UpdateRolesMetadataByQuery`: %v\n", resp) + } +- path: /saved-searches + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/saved-search#create-saved-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + createsavedsearchrequest := []byte(``) // CreateSavedSearchRequest | The saved search to persist. + + + var createSavedSearchRequest v2025.CreateSavedSearchRequest + if err := json.Unmarshal(createsavedsearchrequest, &createSavedSearchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SavedSearchAPI.CreateSavedSearch(context.Background()).CreateSavedSearchRequest(createSavedSearchRequest).Execute() + //resp, r, err := apiClient.V2025.SavedSearchAPI.CreateSavedSearch(context.Background()).CreateSavedSearchRequest(createSavedSearchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.CreateSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.CreateSavedSearch`: %v\n", resp) + } +- path: /saved-searches/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/saved-search#delete-saved-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SavedSearchAPI.DeleteSavedSearch(context.Background(), id).Execute() + //r, err := apiClient.V2025.SavedSearchAPI.DeleteSavedSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.DeleteSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /saved-searches/{id}/execute + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/saved-search#execute-saved-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + searcharguments := []byte(`{ + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + }`) // SearchArguments | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + + + var searchArguments v2025.SearchArguments + if err := json.Unmarshal(searcharguments, &searchArguments); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SavedSearchAPI.ExecuteSavedSearch(context.Background(), id).SearchArguments(searchArguments).Execute() + //r, err := apiClient.V2025.SavedSearchAPI.ExecuteSavedSearch(context.Background(), id).SearchArguments(searchArguments).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.ExecuteSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /saved-searches/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/saved-search#get-saved-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SavedSearchAPI.GetSavedSearch(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SavedSearchAPI.GetSavedSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.GetSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.GetSavedSearch`: %v\n", resp) + } +- path: /saved-searches + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/saved-search#list-saved-searches + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"` // 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: **owner.id**: *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: **owner.id**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SavedSearchAPI.ListSavedSearches(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SavedSearchAPI.ListSavedSearches(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.ListSavedSearches``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSavedSearches`: []SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.ListSavedSearches`: %v\n", resp) + } +- path: /saved-searches/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/saved-search#put-saved-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + savedsearch := []byte(`{ + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + }`) // SavedSearch | The saved search to persist. + + + var savedSearch v2025.SavedSearch + if err := json.Unmarshal(savedsearch, &savedSearch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SavedSearchAPI.PutSavedSearch(context.Background(), id).SavedSearch(savedSearch).Execute() + //resp, r, err := apiClient.V2025.SavedSearchAPI.PutSavedSearch(context.Background(), id).SavedSearch(savedSearch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.PutSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.PutSavedSearch`: %v\n", resp) + } +- path: /scheduled-searches + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/scheduled-search#create-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + createscheduledsearchrequest := []byte(`{savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]}`) // CreateScheduledSearchRequest | The scheduled search to persist. + + + var createScheduledSearchRequest v2025.CreateScheduledSearchRequest + if err := json.Unmarshal(createscheduledsearchrequest, &createScheduledSearchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ScheduledSearchAPI.CreateScheduledSearch(context.Background()).CreateScheduledSearchRequest(createScheduledSearchRequest).Execute() + //resp, r, err := apiClient.V2025.ScheduledSearchAPI.CreateScheduledSearch(context.Background()).CreateScheduledSearchRequest(createScheduledSearchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.CreateScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.CreateScheduledSearch`: %v\n", resp) + } +- path: /scheduled-searches/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/scheduled-search#delete-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ScheduledSearchAPI.DeleteScheduledSearch(context.Background(), id).Execute() + //r, err := apiClient.V2025.ScheduledSearchAPI.DeleteScheduledSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.DeleteScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /scheduled-searches/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/scheduled-search#get-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ScheduledSearchAPI.GetScheduledSearch(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ScheduledSearchAPI.GetScheduledSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.GetScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.GetScheduledSearch`: %v\n", resp) + } +- path: /scheduled-searches + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/scheduled-search#list-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"` // 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: **owner.id**: *eq* **savedSearchId**: *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: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ScheduledSearchAPI.ListScheduledSearch(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ScheduledSearchAPI.ListScheduledSearch(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.ListScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListScheduledSearch`: []ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.ListScheduledSearch`: %v\n", resp) + } +- path: /scheduled-searches/{id}/unsubscribe + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/scheduled-search#unsubscribe-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + typedreference := []byte(`{ + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }`) // TypedReference | The recipient to be removed from the scheduled search. + + + var typedReference v2025.TypedReference + if err := json.Unmarshal(typedreference, &typedReference); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ScheduledSearchAPI.UnsubscribeScheduledSearch(context.Background(), id).TypedReference(typedReference).Execute() + //r, err := apiClient.V2025.ScheduledSearchAPI.UnsubscribeScheduledSearch(context.Background(), id).TypedReference(typedReference).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.UnsubscribeScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /scheduled-searches/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/scheduled-search#update-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + scheduledsearch := []byte(`{ + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false + }`) // ScheduledSearch | The scheduled search to persist. + + + var scheduledSearch v2025.ScheduledSearch + if err := json.Unmarshal(scheduledsearch, &scheduledSearch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ScheduledSearchAPI.UpdateScheduledSearch(context.Background(), id).ScheduledSearch(scheduledSearch).Execute() + //resp, r, err := apiClient.V2025.ScheduledSearchAPI.UpdateScheduledSearch(context.Background(), id).ScheduledSearch(scheduledSearch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.UpdateScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.UpdateScheduledSearch`: %v\n", resp) + } +- path: /search/aggregate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/search#search-aggregate + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + var search v2025.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SearchAPI.SearchAggregate(context.Background()).Search(search).Execute() + //resp, r, err := apiClient.V2025.SearchAPI.SearchAggregate(context.Background()).Search(search).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchAggregate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchAggregate`: AggregationResult + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchAggregate`: %v\n", resp) + } +- path: /search/count + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/search#search-count + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + + + var search v2025.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SearchAPI.SearchCount(context.Background()).Search(search).Execute() + //r, err := apiClient.V2025.SearchAPI.SearchCount(context.Background()).Search(search).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchCount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /search/{index}/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/search#search-get + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + index := `identities` // string | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. # string | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SearchAPI.SearchGet(context.Background(), index, id).Execute() + //resp, r, err := apiClient.V2025.SearchAPI.SearchGet(context.Background(), index, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchGet``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchGet`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchGet`: %v\n", resp) + } +- path: /search + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/search#search-post + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + 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) + limit := 10000 // 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + var search v2025.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SearchAPI.SearchPost(context.Background()).Search(search).Execute() + //resp, r, err := apiClient.V2025.SearchAPI.SearchPost(context.Background()).Search(search).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchPost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchPost`: []map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchPost`: %v\n", resp) + } +- path: /accounts/search-attribute-config + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/search-attribute-configuration#create-search-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + searchattributeconfig := []byte(`{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }`) // SearchAttributeConfig | + + + var searchAttributeConfig v2025.SearchAttributeConfig + if err := json.Unmarshal(searchattributeconfig, &searchAttributeConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SearchAttributeConfigurationAPI.CreateSearchAttributeConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).SearchAttributeConfig(searchAttributeConfig).Execute() + //resp, r, err := apiClient.V2025.SearchAttributeConfigurationAPI.CreateSearchAttributeConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).SearchAttributeConfig(searchAttributeConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.CreateSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSearchAttributeConfig`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.CreateSearchAttributeConfig`: %v\n", resp) + } +- path: /accounts/search-attribute-config/{name} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/search-attribute-configuration#delete-search-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `newMailAttribute` // string | Name of the extended search attribute configuration to delete. # string | Name of the extended search attribute configuration to delete. + 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.V2025.SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /accounts/search-attribute-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/search-attribute-configuration#get-search-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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.V2025.SearchAttributeConfigurationAPI.GetSearchAttributeConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.SearchAttributeConfigurationAPI.GetSearchAttributeConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.GetSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSearchAttributeConfig`: []SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.GetSearchAttributeConfig`: %v\n", resp) + } +- path: /accounts/search-attribute-config/{name} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `newMailAttribute` // string | Name of the extended search attribute configuration to get. # string | Name of the extended search attribute configuration to get. + 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.SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSingleSearchAttributeConfig`: SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig`: %v\n", resp) + } +- path: /accounts/search-attribute-config/{name} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/search-attribute-configuration#patch-search-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `promotedMailAttribute` // string | Name of the search attribute configuration to patch. # string | Name of the search attribute configuration to patch. + 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") + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SearchAttributeConfigurationAPI.PatchSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.SearchAttributeConfigurationAPI.PatchSearchAttributeConfig(context.Background(), name).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.PatchSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSearchAttributeConfig`: SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.PatchSearchAttributeConfig`: %v\n", resp) + } +- path: /segments + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/segments#create-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + segment := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }`) // Segment | + + + var segment v2025.Segment + if err := json.Unmarshal(segment, &segment); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SegmentsAPI.CreateSegment(context.Background()).Segment(segment).Execute() + //resp, r, err := apiClient.V2025.SegmentsAPI.CreateSegment(context.Background()).Segment(segment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.CreateSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.CreateSegment`: %v\n", resp) + } +- path: /segments/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/segments#delete-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to delete. # string | The segment ID to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SegmentsAPI.DeleteSegment(context.Background(), id).Execute() + //r, err := apiClient.V2025.SegmentsAPI.DeleteSegment(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.DeleteSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /segments/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/segments#get-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to retrieve. # string | The segment ID to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SegmentsAPI.GetSegment(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SegmentsAPI.GetSegment(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.GetSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.GetSegment`: %v\n", resp) + } +- path: /segments + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/segments#list-segments + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SegmentsAPI.ListSegments(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SegmentsAPI.ListSegments(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.ListSegments``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSegments`: []Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.ListSegments`: %v\n", resp) + } +- path: /segments/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/segments#patch-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to modify. # string | The segment ID to modify. + requestbody := []byte(`[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]`) // []map[string]interface{} | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + + + var requestBody v2025.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SegmentsAPI.PatchSegment(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2025.SegmentsAPI.PatchSegment(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.PatchSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.PatchSegment`: %v\n", resp) + } +- path: /service-desk-integrations + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/service-desk-integration#create-service-desk-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + servicedeskintegrationdto := []byte(`{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + }`) // ServiceDeskIntegrationDto | The specifics of a new integration to create + + + var serviceDeskIntegrationDto v2025.ServiceDeskIntegrationDto + if err := json.Unmarshal(servicedeskintegrationdto, &serviceDeskIntegrationDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.CreateServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.CreateServiceDeskIntegration`: %v\n", resp) + } +- path: /service-desk-integrations/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/service-desk-integration#delete-service-desk-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `anId` // string | ID of Service Desk integration to delete # string | ID of Service Desk integration to delete + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration(context.Background(), id).Execute() + //r, err := apiClient.V2025.ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /service-desk-integrations/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/service-desk-integration#get-service-desk-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `anId` // string | ID of the Service Desk integration to get # string | ID of the Service Desk integration to get + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetServiceDeskIntegration(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetServiceDeskIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegration`: %v\n", resp) + } +- path: /service-desk-integrations/templates/{scriptName} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/service-desk-integration#get-service-desk-integration-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the Service Desk integration template to get # string | The scriptName value of the Service Desk integration template to get + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationTemplate`: ServiceDeskIntegrationTemplateDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate`: %v\n", resp) + } +- path: /service-desk-integrations/types + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/service-desk-integration#get-service-desk-integration-types + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationTypes`: []ServiceDeskIntegrationTemplateType + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes`: %v\n", resp) + } +- path: /service-desk-integrations + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/service-desk-integration#get-service-desk-integrations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `name eq "John Doe"` // 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* **type**: *eq, in* **cluster**: *eq, in* (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* **type**: *eq, in* **cluster**: *eq, in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetServiceDeskIntegrations(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetServiceDeskIntegrations(context.Background()).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrations`: []ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrations`: %v\n", resp) + } +- path: /service-desk-integrations/status-check-configuration + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/service-desk-integration#get-status-check-details + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetStatusCheckDetails(context.Background()).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.GetStatusCheckDetails(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetStatusCheckDetails``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetStatusCheckDetails`: QueuedCheckConfigDetails + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetStatusCheckDetails`: %v\n", resp) + } +- path: /service-desk-integrations/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/service-desk-integration#patch-service-desk-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `anId` // string | ID of the Service Desk integration to update # string | ID of the Service Desk integration to update + jsonpatchoperation := []byte(``) // []JsonPatchOperation | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.PatchServiceDeskIntegration(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.PatchServiceDeskIntegration(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.PatchServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.PatchServiceDeskIntegration`: %v\n", resp) + } +- path: /service-desk-integrations/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/service-desk-integration#put-service-desk-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `anId` // string | ID of the Service Desk integration to update # string | ID of the Service Desk integration to update + servicedeskintegrationdto := []byte(`{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + }`) // ServiceDeskIntegrationDto | The specifics of the integration to update + + + var serviceDeskIntegrationDto v2025.ServiceDeskIntegrationDto + if err := json.Unmarshal(servicedeskintegrationdto, &serviceDeskIntegrationDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.PutServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.PutServiceDeskIntegration`: %v\n", resp) + } +- path: /service-desk-integrations/status-check-configuration + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/service-desk-integration#update-status-check-details + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + queuedcheckconfigdetails := []byte(`{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + }`) // QueuedCheckConfigDetails | The modified time check configuration + + + var queuedCheckConfigDetails v2025.QueuedCheckConfigDetails + if err := json.Unmarshal(queuedcheckconfigdetails, &queuedCheckConfigDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute() + //resp, r, err := apiClient.V2025.ServiceDeskIntegrationAPI.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.UpdateStatusCheckDetails``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateStatusCheckDetails`: QueuedCheckConfigDetails + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.UpdateStatusCheckDetails`: %v\n", resp) + } +- path: /sim-integrations + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sim-integrations#create-sim-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + simintegrationdetails := []byte(`{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }`) // SimIntegrationDetails | DTO containing the details of the SIM integration + + + var simIntegrationDetails v2025.SimIntegrationDetails + if err := json.Unmarshal(simintegrationdetails, &simIntegrationDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SIMIntegrationsAPI.CreateSIMIntegration(context.Background()).XSailPointExperimental(xSailPointExperimental).SimIntegrationDetails(simIntegrationDetails).Execute() + //resp, r, err := apiClient.V2025.SIMIntegrationsAPI.CreateSIMIntegration(context.Background()).XSailPointExperimental(xSailPointExperimental).SimIntegrationDetails(simIntegrationDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.CreateSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.CreateSIMIntegration`: %v\n", resp) + } +- path: /sim-integrations/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sim-integrations#delete-sim-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `12345` // string | The id of the integration to delete. # string | The id of the integration to delete. + 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.V2025.SIMIntegrationsAPI.DeleteSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.SIMIntegrationsAPI.DeleteSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.DeleteSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sim-integrations/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sim-integrations#get-sim-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `12345` // string | The id of the integration. # string | The id of the integration. + 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.SIMIntegrationsAPI.GetSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.SIMIntegrationsAPI.GetSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.GetSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.GetSIMIntegration`: %v\n", resp) + } +- path: /sim-integrations + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sim-integrations#get-sim-integrations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SIMIntegrationsAPI.GetSIMIntegrations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.SIMIntegrationsAPI.GetSIMIntegrations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.GetSIMIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSIMIntegrations`: []ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.GetSIMIntegrations`: %v\n", resp) + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sim-integrations#patch-before-provisioning-rule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `12345` // string | SIM integration id # string | SIM integration 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") + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + + + var jsonPatch v2025.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SIMIntegrationsAPI.PatchBeforeProvisioningRule(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2025.SIMIntegrationsAPI.PatchBeforeProvisioningRule(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PatchBeforeProvisioningRule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchBeforeProvisioningRule`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PatchBeforeProvisioningRule`: %v\n", resp) + } +- path: /sim-integrations/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sim-integrations#patch-sim-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `12345` // string | SIM integration id # string | SIM integration 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") + jsonpatch := []byte(`{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }`) // JsonPatch | The JsonPatch object that describes the changes of SIM + + + var jsonPatch v2025.JsonPatch + if err := json.Unmarshal(jsonpatch, &jsonPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SIMIntegrationsAPI.PatchSIMAttributes(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + //resp, r, err := apiClient.V2025.SIMIntegrationsAPI.PatchSIMAttributes(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatch(jsonPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PatchSIMAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSIMAttributes`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PatchSIMAttributes`: %v\n", resp) + } +- path: /sim-integrations/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sim-integrations#put-sim-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `12345` // string | The id of the integration. # string | The id of the integration. + 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") + simintegrationdetails := []byte(`{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }`) // SimIntegrationDetails | The full DTO of the integration containing the updated model + + + var simIntegrationDetails v2025.SimIntegrationDetails + if err := json.Unmarshal(simintegrationdetails, &simIntegrationDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SIMIntegrationsAPI.PutSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SimIntegrationDetails(simIntegrationDetails).Execute() + //resp, r, err := apiClient.V2025.SIMIntegrationsAPI.PutSIMIntegration(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SimIntegrationDetails(simIntegrationDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SIMIntegrationsAPI.PutSIMIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSIMIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `SIMIntegrationsAPI.PutSIMIntegration`: %v\n", resp) + } +- path: /sod-policies + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#create-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sodpolicy := []byte(`{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }`) // SodPolicy | + + + var sodPolicy v2025.SodPolicy + if err := json.Unmarshal(sodpolicy, &sodPolicy); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.CreateSodPolicy(context.Background()).SodPolicy(sodPolicy).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.CreateSodPolicy(context.Background()).SodPolicy(sodPolicy).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.CreateSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.CreateSodPolicy`: %v\n", resp) + } +- path: /sod-policies/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#delete-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD Policy to delete. # string | The ID of the SOD Policy to delete. + logical := true // bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to true) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SODPoliciesAPI.DeleteSodPolicy(context.Background(), id).Execute() + //r, err := apiClient.V2025.SODPoliciesAPI.DeleteSodPolicy(context.Background(), id).Logical(logical).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.DeleteSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sod-policies/{id}/schedule + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#delete-sod-policy-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy the schedule must be deleted for. # string | The ID of the SOD policy the schedule must be deleted for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SODPoliciesAPI.DeleteSodPolicySchedule(context.Background(), id).Execute() + //r, err := apiClient.V2025.SODPoliciesAPI.DeleteSodPolicySchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.DeleteSodPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#get-custom-violation-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reportResultId := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the report reference to download. # string | The ID of the report reference to download. + fileName := `custom-name` // string | Custom Name for the file. # string | Custom Name for the file. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.GetCustomViolationReport(context.Background(), reportResultId, fileName).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.GetCustomViolationReport(context.Background(), reportResultId, fileName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetCustomViolationReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCustomViolationReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetCustomViolationReport`: %v\n", resp) + } +- path: /sod-violation-report/{reportResultId}/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#get-default-violation-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reportResultId := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the report reference to download. # string | The ID of the report reference to download. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.GetDefaultViolationReport(context.Background(), reportResultId).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.GetDefaultViolationReport(context.Background(), reportResultId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetDefaultViolationReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDefaultViolationReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetDefaultViolationReport`: %v\n", resp) + } +- path: /sod-violation-report + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#get-sod-all-report-run-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodAllReportRunStatus(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodAllReportRunStatus(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodAllReportRunStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodAllReportRunStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodAllReportRunStatus`: %v\n", resp) + } +- path: /sod-policies/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#get-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD Policy to retrieve. # string | The ID of the SOD Policy to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodPolicy`: %v\n", resp) + } +- path: /sod-policies/{id}/schedule + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#get-sod-policy-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy schedule to retrieve. # string | The ID of the SOD policy schedule to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodPolicySchedule(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodPolicySchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodPolicySchedule`: SodPolicySchedule + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodPolicySchedule`: %v\n", resp) + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#get-sod-violation-report-run-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reportResultId := `2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | The ID of the report reference to retrieve. # string | The ID of the report reference to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodViolationReportRunStatus(context.Background(), reportResultId).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodViolationReportRunStatus(context.Background(), reportResultId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodViolationReportRunStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodViolationReportRunStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodViolationReportRunStatus`: %v\n", resp) + } +- path: /sod-policies/{id}/violation-report + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#get-sod-violation-report-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the violation report to retrieve status for. # string | The ID of the violation report to retrieve status for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodViolationReportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.GetSodViolationReportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodViolationReportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodViolationReportStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodViolationReportStatus`: %v\n", resp) + } +- path: /sod-policies + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#list-sod-policies + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "bc693f07e7b645539626c25954c58554"` // 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, in* **state**: *eq, in* (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, in* **state**: *eq, in* (optional) + sorters := `id,name` // 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: **id, name, created, modified, description** (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: **id, name, created, modified, description** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.ListSodPolicies(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.ListSodPolicies(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.ListSodPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSodPolicies`: []SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.ListSodPolicies`: %v\n", resp) + } +- path: /sod-policies/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#patch-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c918083-5d19-1a86-015d-28455b4a2329` // string | The ID of the SOD policy being modified. # string | The ID of the SOD policy being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]`) // []JsonPatchOperation | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.PatchSodPolicy(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.PatchSodPolicy(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PatchSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PatchSodPolicy`: %v\n", resp) + } +- path: /sod-policies/{id}/schedule + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#put-policy-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy to update its schedule. # string | The ID of the SOD policy to update its schedule. + sodpolicyschedule := []byte(`{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }`) // SodPolicySchedule | + + + var sodPolicySchedule v2025.SodPolicySchedule + if err := json.Unmarshal(sodpolicyschedule, &sodPolicySchedule); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.PutPolicySchedule(context.Background(), id).SodPolicySchedule(sodPolicySchedule).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.PutPolicySchedule(context.Background(), id).SodPolicySchedule(sodPolicySchedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PutPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutPolicySchedule`: SodPolicySchedule + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PutPolicySchedule`: %v\n", resp) + } +- path: /sod-policies/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#put-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy to update. # string | The ID of the SOD policy to update. + sodpolicy := []byte(`{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }`) // SodPolicy | + + + var sodPolicy v2025.SodPolicy + if err := json.Unmarshal(sodpolicy, &sodPolicy); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.PutSodPolicy(context.Background(), id).SodPolicy(sodPolicy).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.PutSodPolicy(context.Background(), id).SodPolicy(sodPolicy).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PutSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PutSodPolicy`: %v\n", resp) + } +- path: /sod-policies/{id}/evaluate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#start-evaluate-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The SOD policy ID to run. # string | The SOD policy ID to run. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.StartEvaluateSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.StartEvaluateSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartEvaluateSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartEvaluateSodPolicy`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartEvaluateSodPolicy`: %v\n", resp) + } +- path: /sod-violation-report/run + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#start-sod-all-policies-for-org + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multipolicyrequest := []byte(`{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }`) // MultiPolicyRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.StartSodAllPoliciesForOrg(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.StartSodAllPoliciesForOrg(context.Background()).MultiPolicyRequest(multiPolicyRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartSodAllPoliciesForOrg``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartSodAllPoliciesForOrg`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartSodAllPoliciesForOrg`: %v\n", resp) + } +- path: /sod-policies/{id}/violation-report/run + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-policies#start-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The SOD policy ID to run. # string | The SOD policy ID to run. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODPoliciesAPI.StartSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SODPoliciesAPI.StartSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartSodPolicy`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartSodPolicy`: %v\n", resp) + } +- path: /sod-violations/predict + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-violations#start-predict-sod-violations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identitywithnewaccess := []byte(`{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }`) // IdentityWithNewAccess | + + + var identityWithNewAccess v2025.IdentityWithNewAccess + if err := json.Unmarshal(identitywithnewaccess, &identityWithNewAccess); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODViolationsAPI.StartPredictSodViolations(context.Background()).IdentityWithNewAccess(identityWithNewAccess).Execute() + //resp, r, err := apiClient.V2025.SODViolationsAPI.StartPredictSodViolations(context.Background()).IdentityWithNewAccess(identityWithNewAccess).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODViolationsAPI.StartPredictSodViolations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartPredictSodViolations`: ViolationPrediction + fmt.Fprintf(os.Stdout, "Response from `SODViolationsAPI.StartPredictSodViolations`: %v\n", resp) + } +- path: /sod-violations/check + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sod-violations#start-violation-check + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identitywithnewaccess1 := []byte(`{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}`) // IdentityWithNewAccess1 | + + + var identityWithNewAccess1 v2025.IdentityWithNewAccess1 + if err := json.Unmarshal(identitywithnewaccess1, &identityWithNewAccess1); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SODViolationsAPI.StartViolationCheck(context.Background()).IdentityWithNewAccess1(identityWithNewAccess1).Execute() + //resp, r, err := apiClient.V2025.SODViolationsAPI.StartViolationCheck(context.Background()).IdentityWithNewAccess1(identityWithNewAccess1).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODViolationsAPI.StartViolationCheck``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartViolationCheck`: SodViolationCheck + fmt.Fprintf(os.Stdout, "Response from `SODViolationsAPI.StartViolationCheck`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#create-provisioning-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id # string | The Source id + provisioningpolicydto := []byte(`{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }`) // ProvisioningPolicyDto | + + + var provisioningPolicyDto v2025.ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.CreateProvisioningPolicy(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.CreateProvisioningPolicy(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateProvisioningPolicy`: %v\n", resp) + } +- path: /sources + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#create-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + source := []byte(`{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }`) // Source | + provisionAsCsv := false // bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + + var source v2025.Source + if err := json.Unmarshal(source, &source); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.CreateSource(context.Background()).Source(source).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.CreateSource(context.Background()).Source(source).ProvisionAsCsv(provisionAsCsv).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSource`: %v\n", resp) + } +- path: /sources/{sourceId}/schedules + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#create-source-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + schedule1 := []byte(``) // Schedule1 | + + + var schedule1 v2025.Schedule1 + if err := json.Unmarshal(schedule1, &schedule1); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.CreateSourceSchedule(context.Background(), sourceId).Schedule1(schedule1).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.CreateSourceSchedule(context.Background(), sourceId).Schedule1(schedule1).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSourceSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceSchedule`: Schedule1 + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSourceSchedule`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#create-source-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + schema := []byte(`{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + }`) // Schema | + + + var schema v2025.Schema + if err := json.Unmarshal(schema, &schema); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.CreateSourceSchema(context.Background(), sourceId).Schema(schema).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.CreateSourceSchema(context.Background(), sourceId).Schema(schema).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSourceSchema`: %v\n", resp) + } +- path: /sources/{id}/remove-accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#delete-accounts-async + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `DeleteAccountsAsync`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.DeleteAccountsAsync`: %v\n", resp) + } +- path: /sources/{sourceId}/native-change-detection-config + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#delete-native-change-detection-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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.V2025.SourcesAPI.DeleteNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.SourcesAPI.DeleteNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).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) + } + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#delete-provisioning-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SourcesAPI.DeleteProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + //r, err := apiClient.V2025.SourcesAPI.DeleteProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#delete-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.DeleteSource(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.DeleteSource(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteSource`: DeleteSource202Response + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.DeleteSource`: %v\n", resp) + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#delete-source-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + scheduleType := `ACCOUNT_AGGREGATION` // string | The Schedule type. # string | The Schedule type. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SourcesAPI.DeleteSourceSchedule(context.Background(), sourceId, scheduleType).Execute() + //r, err := apiClient.V2025.SourcesAPI.DeleteSourceSchedule(context.Background(), sourceId, scheduleType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSourceSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#delete-source-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SourcesAPI.DeleteSourceSchema(context.Background(), sourceId, schemaId).Execute() + //r, err := apiClient.V2025.SourcesAPI.DeleteSourceSchema(context.Background(), sourceId, schemaId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{id}/schemas/accounts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#get-accounts-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SourcesAPI.GetAccountsSchema(context.Background(), id).Execute() + //r, err := apiClient.V2025.SourcesAPI.GetAccountsSchema(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetAccountsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{id}/correlation-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#get-correlation-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetCorrelationConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetCorrelationConfig(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCorrelationConfig`: CorrelationConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetCorrelationConfig`: %v\n", resp) + } +- path: /sources/{id}/schemas/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#get-entitlements-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + schemaName := `?schemaName=group` // string | Name of entitlement schema (optional) # string | Name of entitlement schema (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.SourcesAPI.GetEntitlementsSchema(context.Background(), id).Execute() + //r, err := apiClient.V2025.SourcesAPI.GetEntitlementsSchema(context.Background(), id).SchemaName(schemaName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetEntitlementsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{sourceId}/native-change-detection-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#get-native-change-detection-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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.V2025.SourcesAPI.GetNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `GetNativeChangeDetectionConfig`: NativeChangeDetectionConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetNativeChangeDetectionConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#get-provisioning-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetProvisioningPolicy`: %v\n", resp) + } +- path: /sources/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#get-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSource(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSource(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSource`: %v\n", resp) + } +- path: /sources/{id}/attribute-sync-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#get-source-attr-sync-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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.V2025.SourcesAPI.GetSourceAttrSyncConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceAttrSyncConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceAttrSyncConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceAttrSyncConfig`: AttrSyncSourceConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceAttrSyncConfig`: %v\n", resp) + } +- path: /sources/{id}/connectors/source-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#get-source-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `cef3ee201db947c5912551015ba0c679` // string | The Source id # string | The Source id + locale := `en` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSourceConfig(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceConfig(context.Background(), id).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceConfig`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/connections + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#get-source-connections + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSourceConnections(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceConnections(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceConnections``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceConnections`: SourceConnectionsDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceConnections`: %v\n", resp) + } +- path: /sources/{id}/entitlement-request-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#get-source-entitlement-request-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSourceEntitlementRequestConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceEntitlementRequestConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceEntitlementRequestConfig`: SourceEntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceEntitlementRequestConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/source-health + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#get-source-health + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSourceHealth(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceHealth(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceHealth``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceHealth`: SourceHealthDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceHealth`: %v\n", resp) + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#get-source-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + scheduleType := `ACCOUNT_AGGREGATION` // string | The Schedule type. # string | The Schedule type. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSourceSchedule(context.Background(), sourceId, scheduleType).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceSchedule(context.Background(), sourceId, scheduleType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchedule`: Schedule1 + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchedule`: %v\n", resp) + } +- path: /sources/{sourceId}/schedules + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#get-source-schedules + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSourceSchedules(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceSchedules(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchedules``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchedules`: []Schedule1 + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchedules`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#get-source-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSourceSchema(context.Background(), sourceId, schemaId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceSchema(context.Background(), sourceId, schemaId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchema`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#get-source-schemas + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + includeTypes := `group` // string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) # string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + includeNames := `account` // string | A comma-separated list of schema names to filter result. (optional) # string | A comma-separated list of schema names to filter result. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).IncludeTypes(includeTypes).IncludeNames(includeNames).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchemas``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchemas`: []Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchemas`: %v\n", resp) + } +- path: /sources/{id}/load-accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#import-accounts + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source Id # string | Source Id + 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) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.ImportAccounts(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.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) + } + // response from `ImportAccounts`: LoadAccountsTask + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportAccounts`: %v\n", resp) + } +- path: /sources/{id}/schemas/accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#import-accounts-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.ImportAccountsSchema(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.ImportAccountsSchema(context.Background(), id).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportAccountsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportAccountsSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportAccountsSchema`: %v\n", resp) + } +- path: /sources/{sourceId}/upload-connector-file + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#import-connector-file + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.ImportConnectorFile(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.ImportConnectorFile(context.Background(), sourceId).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportConnectorFile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportConnectorFile`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportConnectorFile`: %v\n", resp) + } +- path: /sources/{id}/schemas/entitlements + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#import-entitlements-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + schemaName := `?schemaName=group` // string | Name of entitlement schema (optional) # string | Name of entitlement schema (optional) + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.ImportEntitlementsSchema(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.ImportEntitlementsSchema(context.Background(), id).SchemaName(schemaName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportEntitlementsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportEntitlementsSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportEntitlementsSchema`: %v\n", resp) + } +- path: /sources/{id}/load-uncorrelated-accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#import-uncorrelated-accounts + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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() + 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) + } + // response from `ImportUncorrelatedAccounts`: LoadUncorrelatedAccountsTask + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportUncorrelatedAccounts`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#list-provisioning-policies + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.ListProvisioningPolicies(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.ListProvisioningPolicies(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ListProvisioningPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListProvisioningPolicies`: []ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ListProvisioningPolicies`: %v\n", resp) + } +- path: /sources + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#list-sources + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Employees"` // 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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + sorters := `name` // 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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + forSubadmin := `name` // string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) # string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + includeIDNSource := true // bool | Include the IdentityNow source in the response. (optional) (default to false) # bool | Include the IdentityNow source in the response. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.ListSources(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.ListSources(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSubadmin(forSubadmin).IncludeIDNSource(includeIDNSource).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ListSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSources`: []Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ListSources`: %v\n", resp) + } +- path: /sources/{sourceId}/connector/ping-cluster + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#ping-cluster + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.PingCluster(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.PingCluster(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PingCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PingCluster`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PingCluster`: %v\n", resp) + } +- path: /sources/{id}/correlation-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#put-correlation-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | The source id # string | The source id + correlationconfig := []byte(`{ + "attributeAssignments" : [ { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + }, { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + } ], + "name" : "Source [source] Account Correlation", + "id" : "2c9180835d191a86015d28455b4a2329" + }`) // CorrelationConfig | + + + var correlationConfig v2025.CorrelationConfig + if err := json.Unmarshal(correlationconfig, &correlationConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.PutCorrelationConfig(context.Background(), id).CorrelationConfig(correlationConfig).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.PutCorrelationConfig(context.Background(), id).CorrelationConfig(correlationConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutCorrelationConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutCorrelationConfig`: CorrelationConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutCorrelationConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/native-change-detection-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#put-native-change-detection-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true + }`) // NativeChangeDetectionConfig | + + + var nativeChangeDetectionConfig v2025.NativeChangeDetectionConfig + if err := json.Unmarshal(nativechangedetectionconfig, &nativeChangeDetectionConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.PutNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).NativeChangeDetectionConfig(nativeChangeDetectionConfig).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.PutNativeChangeDetectionConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).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) + } + // response from `PutNativeChangeDetectionConfig`: NativeChangeDetectionConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutNativeChangeDetectionConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#put-provisioning-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + provisioningpolicydto := []byte(`{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }`) // ProvisioningPolicyDto | + + + var provisioningPolicyDto v2025.ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.PutProvisioningPolicy(context.Background(), sourceId, usageType).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.PutProvisioningPolicy(context.Background(), sourceId, usageType).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutProvisioningPolicy`: %v\n", resp) + } +- path: /sources/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#put-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + source := []byte(`{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }`) // Source | + + + var source v2025.Source + if err := json.Unmarshal(source, &source); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.PutSource(context.Background(), id).Source(source).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.PutSource(context.Background(), id).Source(source).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSource`: %v\n", resp) + } +- path: /sources/{id}/attribute-sync-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#put-source-attr-sync-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + attrsyncsourceconfig := []byte(`{ + "attributes" : [ { + "name" : "email", + "displayName" : "Email", + "enabled" : true, + "target" : "mail" + }, { + "name" : "firstname", + "displayName" : "First Name", + "enabled" : false, + "target" : "givenName" + } ], + "source" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + } + }`) // AttrSyncSourceConfig | + + + var attrSyncSourceConfig v2025.AttrSyncSourceConfig + if err := json.Unmarshal(attrsyncsourceconfig, &attrSyncSourceConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.PutSourceAttrSyncConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).AttrSyncSourceConfig(attrSyncSourceConfig).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.PutSourceAttrSyncConfig(context.Background(), id).XSailPointExperimental(xSailPointExperimental).AttrSyncSourceConfig(attrSyncSourceConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSourceAttrSyncConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSourceAttrSyncConfig`: AttrSyncSourceConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSourceAttrSyncConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#put-source-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + schema := []byte(`{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + }`) // Schema | + + + var schema v2025.Schema + if err := json.Unmarshal(schema, &schema); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.PutSourceSchema(context.Background(), sourceId, schemaId).Schema(schema).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.PutSourceSchema(context.Background(), sourceId, schemaId).Schema(schema).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSourceSchema`: %v\n", resp) + } +- path: /sources/{sourceId}/connector/peek-resource-objects + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#search-resource-objects + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + resourceobjectsrequest := []byte(`{ + "maxCount" : 100, + "objectType" : "group" + }`) // ResourceObjectsRequest | + + + var resourceObjectsRequest v2025.ResourceObjectsRequest + if err := json.Unmarshal(resourceobjectsrequest, &resourceObjectsRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.SearchResourceObjects(context.Background(), sourceId).ResourceObjectsRequest(resourceObjectsRequest).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.SearchResourceObjects(context.Background(), sourceId).ResourceObjectsRequest(resourceObjectsRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.SearchResourceObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchResourceObjects`: ResourceObjectsResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.SearchResourceObjects`: %v\n", resp) + } +- path: /sources/{id}/synchronize-attributes + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#sync-attributes-for-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `id_example` // 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.SyncAttributesForSource(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.SyncAttributesForSource(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.SyncAttributesForSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SyncAttributesForSource`: SourceSyncJob + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.SyncAttributesForSource`: %v\n", resp) + } +- path: /sources/{sourceId}/connector/test-configuration + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#test-source-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source # string | The ID of the Source + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.TestSourceConfiguration(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.TestSourceConfiguration(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.TestSourceConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConfiguration`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.TestSourceConfiguration`: %v\n", resp) + } +- path: /sources/{sourceId}/connector/check-connection + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#test-source-connection + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `cef3ee201db947c5912551015ba0c679` // string | The ID of the Source. # string | The ID of the Source. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.TestSourceConnection(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.TestSourceConnection(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.TestSourceConnection``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSourceConnection`: StatusResponse + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.TestSourceConnection`: %v\n", resp) + } +- path: /sources/{sourceId}/password-policies + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#update-password-policy-holders + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + passwordpolicyholdersdtoinner := []byte(``) // []PasswordPolicyHoldersDtoInner | + + + var passwordPolicyHoldersDtoInner v2025.[]PasswordPolicyHoldersDtoInner + if err := json.Unmarshal(passwordpolicyholdersdtoinner, &passwordPolicyHoldersDtoInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.UpdatePasswordPolicyHolders(context.Background(), sourceId).PasswordPolicyHoldersDtoInner(passwordPolicyHoldersDtoInner).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.UpdatePasswordPolicyHolders(context.Background(), sourceId).PasswordPolicyHoldersDtoInner(passwordPolicyHoldersDtoInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdatePasswordPolicyHolders``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePasswordPolicyHolders`: []PasswordPolicyHoldersDtoInner + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdatePasswordPolicyHolders`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#update-provisioning-policies-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + provisioningpolicydto := []byte(``) // []ProvisioningPolicyDto | + + + var provisioningPolicyDto v2025.[]ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.UpdateProvisioningPoliciesInBulk(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.UpdateProvisioningPoliciesInBulk(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateProvisioningPoliciesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateProvisioningPoliciesInBulk`: []ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateProvisioningPoliciesInBulk`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#update-provisioning-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + jsonpatchoperation := []byte(`[{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schema. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.UpdateProvisioningPolicy(context.Background(), sourceId, usageType).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.UpdateProvisioningPolicy(context.Background(), sourceId, usageType).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateProvisioningPolicy`: %v\n", resp) + } +- path: /sources/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#update-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=new description}]`) // []JsonPatchOperation | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.UpdateSource(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.UpdateSource(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSource`: %v\n", resp) + } +- path: /sources/{id}/entitlement-request-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#update-source-entitlement-request-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + sourceentitlementrequestconfig := []byte(`{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }`) // SourceEntitlementRequestConfig | + + + var sourceEntitlementRequestConfig v2025.SourceEntitlementRequestConfig + if err := json.Unmarshal(sourceentitlementrequestconfig, &sourceEntitlementRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.UpdateSourceEntitlementRequestConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceEntitlementRequestConfig(sourceEntitlementRequestConfig).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.UpdateSourceEntitlementRequestConfig(context.Background()).XSailPointExperimental(xSailPointExperimental).SourceEntitlementRequestConfig(sourceEntitlementRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceEntitlementRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceEntitlementRequestConfig`: SourceEntitlementRequestConfig + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceEntitlementRequestConfig`: %v\n", resp) + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#update-source-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + scheduleType := `ACCOUNT_AGGREGATION` // string | The Schedule type. # string | The Schedule type. + jsonpatchoperation := []byte(`[{op=replace, path=/cronExpression, value=0 0 6 * * ?}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schedule. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.UpdateSourceSchedule(context.Background(), sourceId, scheduleType).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.UpdateSourceSchedule(context.Background(), sourceId, scheduleType).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceSchedule`: Schedule1 + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceSchedule`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sources#update-source-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + jsonpatchoperation := []byte(`[{op=add, path=/attributes/-, value={name=location, type=STRING, schema=null, description=Employee location, isMulti=false, isEntitlement=false, isGroup=false}}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schema. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourcesAPI.UpdateSourceSchema(context.Background(), sourceId, schemaId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.SourcesAPI.UpdateSourceSchema(context.Background(), sourceId, schemaId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceSchema`: %v\n", resp) + } +- path: /source-usages/{sourceId}/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/source-usages#get-status-by-source-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | ID of IDN source # string | ID of IDN source + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourceUsagesAPI.GetStatusBySourceId(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourceUsagesAPI.GetStatusBySourceId(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourceUsagesAPI.GetStatusBySourceId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetStatusBySourceId`: SourceUsageStatus + fmt.Fprintf(os.Stdout, "Response from `SourceUsagesAPI.GetStatusBySourceId`: %v\n", resp) + } +- path: /source-usages/{sourceId}/summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/source-usages#get-usages-by-source-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | ID of IDN source # string | ID of IDN source + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `-date` // 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: **date** (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: **date** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SourceUsagesAPI.GetUsagesBySourceId(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V2025.SourceUsagesAPI.GetUsagesBySourceId(context.Background(), sourceId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourceUsagesAPI.GetUsagesBySourceId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUsagesBySourceId`: []SourceUsage + fmt.Fprintf(os.Stdout, "Response from `SourceUsagesAPI.GetUsagesBySourceId`: %v\n", resp) + } +- path: /sp-config/export + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sp-config#export-sp-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + exportpayload := []byte(`{ + "description" : "Export Job 1 Test" + }`) // ExportPayload | Export options control what will be included in the export. + + + var exportPayload v2025.ExportPayload + if err := json.Unmarshal(exportpayload, &exportPayload); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SPConfigAPI.ExportSpConfig(context.Background()).ExportPayload(exportPayload).Execute() + //resp, r, err := apiClient.V2025.SPConfigAPI.ExportSpConfig(context.Background()).ExportPayload(exportPayload).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ExportSpConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportSpConfig`: SpConfigExportJob + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ExportSpConfig`: %v\n", resp) + } +- path: /sp-config/export/{id}/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sp-config#get-sp-config-export + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the export job whose results will be downloaded. # string | The ID of the export job whose results will be downloaded. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SPConfigAPI.GetSpConfigExport(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SPConfigAPI.GetSpConfigExport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigExport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigExport`: SpConfigExportResults + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigExport`: %v\n", resp) + } +- path: /sp-config/export/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sp-config#get-sp-config-export-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the export job whose status will be returned. # string | The ID of the export job whose status will be returned. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SPConfigAPI.GetSpConfigExportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SPConfigAPI.GetSpConfigExportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigExportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigExportStatus`: SpConfigExportJobStatus + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigExportStatus`: %v\n", resp) + } +- path: /sp-config/import/{id}/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sp-config#get-sp-config-import + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the import job whose results will be downloaded. # string | The ID of the import job whose results will be downloaded. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SPConfigAPI.GetSpConfigImport(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SPConfigAPI.GetSpConfigImport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigImport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigImport`: SpConfigImportResults + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigImport`: %v\n", resp) + } +- path: /sp-config/import/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sp-config#get-sp-config-import-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the import job whose status will be returned. # string | The ID of the import job whose status will be returned. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SPConfigAPI.GetSpConfigImportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.SPConfigAPI.GetSpConfigImportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.GetSpConfigImportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSpConfigImportStatus`: SpConfigImportJobStatus + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.GetSpConfigImportStatus`: %v\n", resp) + } +- path: /sp-config/import + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sp-config#import-sp-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + data := BINARY_DATA_HERE // *os.File | JSON file containing the objects to be imported. # *os.File | JSON file containing the objects to be imported. + preview := true // bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to false) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to false) + options := []byte(``) // ImportOptions | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SPConfigAPI.ImportSpConfig(context.Background()).Data(data).Execute() + //resp, r, err := apiClient.V2025.SPConfigAPI.ImportSpConfig(context.Background()).Data(data).Preview(preview).Options(options).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ImportSpConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportSpConfig`: SpConfigJob + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ImportSpConfig`: %v\n", resp) + } +- path: /sp-config/config-objects + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/sp-config#list-sp-config-objects + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SPConfigAPI.ListSpConfigObjects(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SPConfigAPI.ListSpConfigObjects(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SPConfigAPI.ListSpConfigObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSpConfigObjects`: []SpConfigObject + fmt.Fprintf(os.Stdout, "Response from `SPConfigAPI.ListSpConfigObjects`: %v\n", resp) + } +- path: /suggested-entitlement-description-batches/{batchId}/stats + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/suggested-entitlement-description#get-sed-batch-stats + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + batchId := `8c190e67-87aa-4ed9-a90b-d9d5344523fb` // string | Batch Id # string | Batch Id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.GetSedBatchStats(context.Background(), batchId).Execute() + //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.GetSedBatchStats(context.Background(), batchId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatchStats``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSedBatchStats`: SedBatchStats + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatchStats`: %v\n", resp) + } +- path: /suggested-entitlement-description-batches + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/suggested-entitlement-description#get-sed-batches + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatches``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSedBatches`: SedBatchStatus + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatches`: %v\n", resp) + } +- path: /suggested-entitlement-descriptions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/suggested-entitlement-description#list-seds + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `displayName co "Read and Write"` // 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) + sorters := `sorters=displayName` // 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: **displayName, sourceName, status** (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: **displayName, sourceName, status** (optional) + countOnly := count-only=true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) + requestedByAnyone := requested-by-anyone=true // bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to false) # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to false) + showPendingStatusOnly := show-pending-status-only=true // bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to false) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.ListSeds(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.ListSeds(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).CountOnly(countOnly).RequestedByAnyone(requestedByAnyone).ShowPendingStatusOnly(showPendingStatusOnly).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.ListSeds``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSeds`: []Sed + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.ListSeds`: %v\n", resp) + } +- path: /suggested-entitlement-descriptions + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/suggested-entitlement-description#patch-sed + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ebab396f-0af1-4050-89b7-dafc63ec70e7` // string | id is sed id # string | id is sed id + sedpatch := []byte(``) // []SedPatch | Sed Patch Request + + + var sedPatch v2025.[]SedPatch + if err := json.Unmarshal(sedpatch, &sedPatch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.PatchSed(context.Background(), id).SedPatch(sedPatch).Execute() + //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.PatchSed(context.Background(), id).SedPatch(sedPatch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.PatchSed``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSed`: Sed + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.PatchSed`: %v\n", resp) + } +- path: /suggested-entitlement-description-approvals + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/suggested-entitlement-description#submit-sed-approval + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sedapproval := []byte(``) // []SedApproval | Sed Approval + + + var sedApproval v2025.[]SedApproval + if err := json.Unmarshal(sedapproval, &sedApproval); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.SubmitSedApproval(context.Background()).SedApproval(sedApproval).Execute() + //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.SubmitSedApproval(context.Background()).SedApproval(sedApproval).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedApproval`: []SedApprovalStatus + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedApproval`: %v\n", resp) + } +- path: /suggested-entitlement-description-assignments + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/suggested-entitlement-description#submit-sed-assignment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sedassignment := []byte(`{ + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] + }`) // SedAssignment | Sed Assignment Request + + + var sedAssignment v2025.SedAssignment + if err := json.Unmarshal(sedassignment, &sedAssignment); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.SubmitSedAssignment(context.Background()).SedAssignment(sedAssignment).Execute() + //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.SubmitSedAssignment(context.Background()).SedAssignment(sedAssignment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedAssignment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedAssignment`: SedAssignmentResponse + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedAssignment`: %v\n", resp) + } +- path: /suggested-entitlement-description-batches + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/suggested-entitlement-description#submit-sed-batch-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sedbatchrequest := []byte(`{ + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + }`) // SedBatchRequest | Sed Batch Request (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest(context.Background()).SedBatchRequest(sedBatchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitSedBatchRequest`: SedBatchResponse + fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.SubmitSedBatchRequest`: %v\n", resp) + } +- path: /tagged-objects/{type}/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/tagged-objects#delete-tagged-object + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + type_ := `ROLE` // string | The type of object to delete tags from. # string | The type of object to delete tags from. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object to delete tags from. # string | The ID of the object to delete tags from. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.TaggedObjectsAPI.DeleteTaggedObject(context.Background(), type_, id).Execute() + //r, err := apiClient.V2025.TaggedObjectsAPI.DeleteTaggedObject(context.Background(), type_, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.DeleteTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /tagged-objects/bulk-remove + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/tagged-objects#delete-tags-to-many-object + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + bulkremovetaggedobject := []byte(`{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // BulkRemoveTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + + var bulkRemoveTaggedObject v2025.BulkRemoveTaggedObject + if err := json.Unmarshal(bulkremovetaggedobject, &bulkRemoveTaggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.TaggedObjectsAPI.DeleteTagsToManyObject(context.Background()).BulkRemoveTaggedObject(bulkRemoveTaggedObject).Execute() + //r, err := apiClient.V2025.TaggedObjectsAPI.DeleteTagsToManyObject(context.Background()).BulkRemoveTaggedObject(bulkRemoveTaggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.DeleteTagsToManyObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /tagged-objects/{type}/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/tagged-objects#get-tagged-object + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + type_ := `ROLE` // string | The type of tagged object to retrieve. # string | The type of tagged object to retrieve. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to retrieve. # string | The ID of the object reference to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TaggedObjectsAPI.GetTaggedObject(context.Background(), type_, id).Execute() + //resp, r, err := apiClient.V2025.TaggedObjectsAPI.GetTaggedObject(context.Background(), type_, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.GetTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaggedObject`: TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.GetTaggedObject`: %v\n", resp) + } +- path: /tagged-objects + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/tagged-objects#list-tagged-objects + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `tagName eq "BU_FINANCE"` // 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TaggedObjectsAPI.ListTaggedObjects(context.Background()).Execute() + //resp, r, err := apiClient.V2025.TaggedObjectsAPI.ListTaggedObjects(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.ListTaggedObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTaggedObjects`: []TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.ListTaggedObjects`: %v\n", resp) + } +- path: /tagged-objects/{type} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/tagged-objects#list-tagged-objects-by-type + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + type_ := `ROLE` // string | The type of tagged object to retrieve. # string | The type of tagged object to retrieve. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `objectRef.id eq "2c91808568c529c60168cca6f90c1313"` // 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: **objectRef.id**: *eq* **objectRef.type**: *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: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TaggedObjectsAPI.ListTaggedObjectsByType(context.Background(), type_).Execute() + //resp, r, err := apiClient.V2025.TaggedObjectsAPI.ListTaggedObjectsByType(context.Background(), type_).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.ListTaggedObjectsByType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTaggedObjectsByType`: []TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.ListTaggedObjectsByType`: %v\n", resp) + } +- path: /tagged-objects/{type}/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/tagged-objects#put-tagged-object + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + type_ := `ROLE` // string | The type of tagged object to update. # string | The type of tagged object to update. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to update. # string | The ID of the object reference to update. + taggedobject := []byte(`{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // TaggedObject | + + + var taggedObject v2025.TaggedObject + if err := json.Unmarshal(taggedobject, &taggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TaggedObjectsAPI.PutTaggedObject(context.Background(), type_, id).TaggedObject(taggedObject).Execute() + //resp, r, err := apiClient.V2025.TaggedObjectsAPI.PutTaggedObject(context.Background(), type_, id).TaggedObject(taggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.PutTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutTaggedObject`: TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.PutTaggedObject`: %v\n", resp) + } +- path: /tagged-objects + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/tagged-objects#set-tag-to-object + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + taggedobject := []byte(`{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // TaggedObject | + + + var taggedObject v2025.TaggedObject + if err := json.Unmarshal(taggedobject, &taggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.TaggedObjectsAPI.SetTagToObject(context.Background()).TaggedObject(taggedObject).Execute() + //r, err := apiClient.V2025.TaggedObjectsAPI.SetTagToObject(context.Background()).TaggedObject(taggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.SetTagToObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /tagged-objects/bulk-add + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/tagged-objects#set-tags-to-many-objects + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + bulkaddtaggedobject := []byte(`{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // BulkAddTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + + var bulkAddTaggedObject v2025.BulkAddTaggedObject + if err := json.Unmarshal(bulkaddtaggedobject, &bulkAddTaggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TaggedObjectsAPI.SetTagsToManyObjects(context.Background()).BulkAddTaggedObject(bulkAddTaggedObject).Execute() + //resp, r, err := apiClient.V2025.TaggedObjectsAPI.SetTagsToManyObjects(context.Background()).BulkAddTaggedObject(bulkAddTaggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.SetTagsToManyObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetTagsToManyObjects`: []BulkTaggedObjectResponse + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.SetTagsToManyObjects`: %v\n", resp) + } +- path: /task-status/pending-tasks + method: Head + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/task-management#get-pending-task-headers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.TaskManagementAPI.GetPendingTaskHeaders(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.TaskManagementAPI.GetPendingTaskHeaders(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetPendingTaskHeaders``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /task-status/pending-tasks + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/task-management#get-pending-tasks + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TaskManagementAPI.GetPendingTasks(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.TaskManagementAPI.GetPendingTasks(context.Background()).XSailPointExperimental(xSailPointExperimental).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetPendingTasks``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPendingTasks`: []TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetPendingTasks`: %v\n", resp) + } +- path: /task-status/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/task-management#get-task-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `00eebcf881994e419d72e757fd30dc0e` // string | Task ID. # string | Task 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.TaskManagementAPI.GetTaskStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.TaskManagementAPI.GetTaskStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetTaskStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaskStatus`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetTaskStatus`: %v\n", resp) + } +- path: /task-status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/task-management#get-task-status-list + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `completionStatus eq "Success"` // 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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) + sorters := `-created` // 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: **created** (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: **created** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TaskManagementAPI.GetTaskStatusList(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.TaskManagementAPI.GetTaskStatusList(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.GetTaskStatusList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaskStatusList`: []TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.GetTaskStatusList`: %v\n", resp) + } +- path: /task-status/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/task-management#update-task-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `00eebcf881994e419d72e757fd30dc0e` // string | Task ID. # string | Task 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") + jsonpatchoperation := []byte(``) // []JsonPatchOperation | The JSONPatch payload used to update the object. + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TaskManagementAPI.UpdateTaskStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.TaskManagementAPI.UpdateTaskStatus(context.Background(), id).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaskManagementAPI.UpdateTaskStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateTaskStatus`: TaskStatus + fmt.Fprintf(os.Stdout, "Response from `TaskManagementAPI.UpdateTaskStatus`: %v\n", resp) + } +- path: /tenant + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/tenant#get-tenant + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TenantAPI.GetTenant(context.Background()).Execute() + //resp, r, err := apiClient.V2025.TenantAPI.GetTenant(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TenantAPI.GetTenant``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenant`: Tenant + fmt.Fprintf(os.Stdout, "Response from `TenantAPI.GetTenant`: %v\n", resp) + } +- path: /tenant-context + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/tenant-context#get-tenant-context + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TenantContextAPI.GetTenantContext(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.TenantContextAPI.GetTenantContext(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TenantContextAPI.GetTenantContext``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenantContext`: []GetTenantContext200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `TenantContextAPI.GetTenantContext`: %v\n", resp) + } +- path: /tenant-context + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/tenant-context#patch-tenant-context + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + jsonpatchoperation := []byte(`{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }`) // JsonPatchOperation | + + + var jsonPatchOperation v2025.JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.TenantContextAPI.PatchTenantContext(context.Background()).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + //r, err := apiClient.V2025.TenantContextAPI.PatchTenantContext(context.Background()).XSailPointExperimental(xSailPointExperimental).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TenantContextAPI.PatchTenantContext``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /transforms + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/transforms#create-transform + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + transform := []byte(`{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }`) // Transform | The transform to be created. + + + var transform v2025.Transform + if err := json.Unmarshal(transform, &transform); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TransformsAPI.CreateTransform(context.Background()).Transform(transform).Execute() + //resp, r, err := apiClient.V2025.TransformsAPI.CreateTransform(context.Background()).Transform(transform).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.CreateTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.CreateTransform`: %v\n", resp) + } +- path: /transforms/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/transforms#delete-transform + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to delete # string | ID of the transform to delete + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.TransformsAPI.DeleteTransform(context.Background(), id).Execute() + //r, err := apiClient.V2025.TransformsAPI.DeleteTransform(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.DeleteTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /transforms/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/transforms#get-transform + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to retrieve # string | ID of the transform to retrieve + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TransformsAPI.GetTransform(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.TransformsAPI.GetTransform(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.GetTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.GetTransform`: %v\n", resp) + } +- path: /transforms + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/transforms#list-transforms + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + name := `ExampleTransformName123` // string | Name of the transform to retrieve from the list. (optional) # string | Name of the transform to retrieve from the list. (optional) + filters := `name eq "Uppercase"` // 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: **internal**: *eq* **name**: *eq, sw* (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: **internal**: *eq* **name**: *eq, sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TransformsAPI.ListTransforms(context.Background()).Execute() + //resp, r, err := apiClient.V2025.TransformsAPI.ListTransforms(context.Background()).Offset(offset).Limit(limit).Count(count).Name(name).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.ListTransforms``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTransforms`: []TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.ListTransforms`: %v\n", resp) + } +- path: /transforms/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/transforms#update-transform + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to update # string | ID of the transform to update + transform := []byte(`{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }`) // Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TransformsAPI.UpdateTransform(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.TransformsAPI.UpdateTransform(context.Background(), id).Transform(transform).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.UpdateTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.UpdateTransform`: %v\n", resp) + } +- path: /trigger-invocations/{id}/complete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/triggers#complete-trigger-invocation + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | The ID of the invocation to complete. # string | The ID of the invocation to complete. + 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") + completeinvocation := []byte(`{ + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + }`) // CompleteInvocation | + + + var completeInvocation v2025.CompleteInvocation + if err := json.Unmarshal(completeinvocation, &completeInvocation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.TriggersAPI.CompleteTriggerInvocation(context.Background(), id).XSailPointExperimental(xSailPointExperimental).CompleteInvocation(completeInvocation).Execute() + //r, err := apiClient.V2025.TriggersAPI.CompleteTriggerInvocation(context.Background(), id).XSailPointExperimental(xSailPointExperimental).CompleteInvocation(completeInvocation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.CompleteTriggerInvocation``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /trigger-subscriptions + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/triggers#create-subscription + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + subscriptionpostrequest := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "triggerId" : "idn:access-requested", + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + }`) // SubscriptionPostRequest | + + + var subscriptionPostRequest v2025.SubscriptionPostRequest + if err := json.Unmarshal(subscriptionpostrequest, &subscriptionPostRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TriggersAPI.CreateSubscription(context.Background()).XSailPointExperimental(xSailPointExperimental).SubscriptionPostRequest(subscriptionPostRequest).Execute() + //resp, r, err := apiClient.V2025.TriggersAPI.CreateSubscription(context.Background()).XSailPointExperimental(xSailPointExperimental).SubscriptionPostRequest(subscriptionPostRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.CreateSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.CreateSubscription`: %v\n", resp) + } +- path: /trigger-subscriptions/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/triggers#delete-subscription + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | Subscription ID # string | Subscription 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.V2025.TriggersAPI.DeleteSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.TriggersAPI.DeleteSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.DeleteSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /trigger-subscriptions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/triggers#list-subscriptions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"` // 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* **triggerId**: *eq* **type**: *eq, le* (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* **triggerId**: *eq* **type**: *eq, le* (optional) + sorters := `triggerName` // 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: **triggerId, triggerName** (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: **triggerId, triggerName** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TriggersAPI.ListSubscriptions(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.TriggersAPI.ListSubscriptions(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListSubscriptions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSubscriptions`: []Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListSubscriptions`: %v\n", resp) + } +- path: /trigger-invocations/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/triggers#list-trigger-invocation-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `triggerId eq "idn:access-request-dynamic-approver"` // 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: **triggerId**: *eq* **subscriptionId**: *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: **triggerId**: *eq* **subscriptionId**: *eq* (optional) + sorters := `created` // 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: **triggerId, subscriptionName, created, completed** (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: **triggerId, subscriptionName, created, completed** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TriggersAPI.ListTriggerInvocationStatus(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.TriggersAPI.ListTriggerInvocationStatus(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListTriggerInvocationStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTriggerInvocationStatus`: []InvocationStatus + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListTriggerInvocationStatus`: %v\n", resp) + } +- path: /triggers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/triggers#list-triggers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "idn:access-request-post-approval"` // 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, ge, le* (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, ge, le* (optional) + sorters := `name` // 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: **id, name** (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: **id, name** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TriggersAPI.ListTriggers(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.TriggersAPI.ListTriggers(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.ListTriggers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTriggers`: []Trigger + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.ListTriggers`: %v\n", resp) + } +- path: /trigger-subscriptions/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/triggers#patch-subscription + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | ID of the Subscription to patch # string | ID of the Subscription to patch + 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") + subscriptionpatchrequestinner := []byte(``) // []SubscriptionPatchRequestInner | + + + var subscriptionPatchRequestInner v2025.[]SubscriptionPatchRequestInner + if err := json.Unmarshal(subscriptionpatchrequestinner, &subscriptionPatchRequestInner); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TriggersAPI.PatchSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SubscriptionPatchRequestInner(subscriptionPatchRequestInner).Execute() + //resp, r, err := apiClient.V2025.TriggersAPI.PatchSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SubscriptionPatchRequestInner(subscriptionPatchRequestInner).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.PatchSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.PatchSubscription`: %v\n", resp) + } +- path: /trigger-invocations/test + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/triggers#start-test-trigger-invocation + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + testinvocation := []byte(`{ + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } + }`) // TestInvocation | + + + var testInvocation v2025.TestInvocation + if err := json.Unmarshal(testinvocation, &testInvocation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TriggersAPI.StartTestTriggerInvocation(context.Background()).XSailPointExperimental(xSailPointExperimental).TestInvocation(testInvocation).Execute() + //resp, r, err := apiClient.V2025.TriggersAPI.StartTestTriggerInvocation(context.Background()).XSailPointExperimental(xSailPointExperimental).TestInvocation(testInvocation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.StartTestTriggerInvocation``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartTestTriggerInvocation`: []Invocation + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.StartTestTriggerInvocation`: %v\n", resp) + } +- path: /trigger-subscriptions/validate-filter + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/triggers#test-subscription-filter + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + validatefilterinputdto := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + }`) // ValidateFilterInputDto | + + + var validateFilterInputDto v2025.ValidateFilterInputDto + if err := json.Unmarshal(validatefilterinputdto, &validateFilterInputDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TriggersAPI.TestSubscriptionFilter(context.Background()).XSailPointExperimental(xSailPointExperimental).ValidateFilterInputDto(validateFilterInputDto).Execute() + //resp, r, err := apiClient.V2025.TriggersAPI.TestSubscriptionFilter(context.Background()).XSailPointExperimental(xSailPointExperimental).ValidateFilterInputDto(validateFilterInputDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.TestSubscriptionFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestSubscriptionFilter`: ValidateFilterOutputDto + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.TestSubscriptionFilter`: %v\n", resp) + } +- path: /trigger-subscriptions/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/triggers#update-subscription + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `0f11f2a4-7c94-4bf3-a2bd-742580fe3bde` // string | Subscription ID # string | Subscription 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") + subscriptionputrequest := []byte(`{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + }`) // SubscriptionPutRequest | + + + var subscriptionPutRequest v2025.SubscriptionPutRequest + if err := json.Unmarshal(subscriptionputrequest, &subscriptionPutRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.TriggersAPI.UpdateSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SubscriptionPutRequest(subscriptionPutRequest).Execute() + //resp, r, err := apiClient.V2025.TriggersAPI.UpdateSubscription(context.Background(), id).XSailPointExperimental(xSailPointExperimental).SubscriptionPutRequest(subscriptionPutRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TriggersAPI.UpdateSubscription``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSubscription`: Subscription + fmt.Fprintf(os.Stdout, "Response from `TriggersAPI.UpdateSubscription`: %v\n", resp) + } +- path: /ui-metadata/tenant + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/ui-metadata#get-tenant-ui-metadata + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.UIMetadataAPI.GetTenantUiMetadata(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.UIMetadataAPI.GetTenantUiMetadata(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `UIMetadataAPI.GetTenantUiMetadata``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenantUiMetadata`: TenantUiMetadataItemResponse + fmt.Fprintf(os.Stdout, "Response from `UIMetadataAPI.GetTenantUiMetadata`: %v\n", resp) + } +- path: /ui-metadata/tenant + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/ui-metadata#set-tenant-ui-metadata + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + tenantuimetadataitemupdaterequest := []byte(`{ + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" + }`) // TenantUiMetadataItemUpdateRequest | + + + var tenantUiMetadataItemUpdateRequest v2025.TenantUiMetadataItemUpdateRequest + if err := json.Unmarshal(tenantuimetadataitemupdaterequest, &tenantUiMetadataItemUpdateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.UIMetadataAPI.SetTenantUiMetadata(context.Background()).XSailPointExperimental(xSailPointExperimental).TenantUiMetadataItemUpdateRequest(tenantUiMetadataItemUpdateRequest).Execute() + //resp, r, err := apiClient.V2025.UIMetadataAPI.SetTenantUiMetadata(context.Background()).XSailPointExperimental(xSailPointExperimental).TenantUiMetadataItemUpdateRequest(tenantUiMetadataItemUpdateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `UIMetadataAPI.SetTenantUiMetadata``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetTenantUiMetadata`: TenantUiMetadataItemResponse + fmt.Fprintf(os.Stdout, "Response from `UIMetadataAPI.SetTenantUiMetadata`: %v\n", resp) + } +- path: /vendor-connector-mappings + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + vendorconnectormapping := []byte(`{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }`) // VendorConnectorMapping | + + + var vendorConnectorMapping v2025.VendorConnectorMapping + if err := json.Unmarshal(vendorconnectormapping, &vendorConnectorMapping); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.VendorConnectorMappingsAPI.CreateVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + //resp, r, err := apiClient.V2025.VendorConnectorMappingsAPI.CreateVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.CreateVendorConnectorMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateVendorConnectorMapping`: VendorConnectorMapping + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.CreateVendorConnectorMapping`: %v\n", resp) + } +- path: /vendor-connector-mappings + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + vendorconnectormapping := []byte(`{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }`) // VendorConnectorMapping | + + + var vendorConnectorMapping v2025.VendorConnectorMapping + if err := json.Unmarshal(vendorconnectormapping, &vendorConnectorMapping); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.VendorConnectorMappingsAPI.DeleteVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + //resp, r, err := apiClient.V2025.VendorConnectorMappingsAPI.DeleteVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.DeleteVendorConnectorMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteVendorConnectorMapping`: DeleteVendorConnectorMapping200Response + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.DeleteVendorConnectorMapping`: %v\n", resp) + } +- path: /vendor-connector-mappings + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.VendorConnectorMappingsAPI.GetVendorConnectorMappings(context.Background()).Execute() + //resp, r, err := apiClient.V2025.VendorConnectorMappingsAPI.GetVendorConnectorMappings(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.GetVendorConnectorMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetVendorConnectorMappings`: []VendorConnectorMapping + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.GetVendorConnectorMappings`: %v\n", resp) + } +- path: /workflow-executions/{id}/cancel + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#cancel-workflow-execution + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | The workflow execution ID # string | The workflow execution ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.WorkflowsAPI.CancelWorkflowExecution(context.Background(), id).Execute() + //r, err := apiClient.V2025.WorkflowsAPI.CancelWorkflowExecution(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CancelWorkflowExecution``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /workflows/execute/external/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#create-external-execute-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + createexternalexecuteworkflowrequest := []byte(``) // CreateExternalExecuteWorkflowRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.CreateExternalExecuteWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.CreateExternalExecuteWorkflow(context.Background(), id).CreateExternalExecuteWorkflowRequest(createExternalExecuteWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateExternalExecuteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateExternalExecuteWorkflow`: CreateExternalExecuteWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateExternalExecuteWorkflow`: %v\n", resp) + } +- path: /workflows + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#create-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + createworkflowrequest := []byte(`{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}`) // CreateWorkflowRequest | + + + var createWorkflowRequest v2025.CreateWorkflowRequest + if err := json.Unmarshal(createworkflowrequest, &createWorkflowRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.CreateWorkflow(context.Background()).CreateWorkflowRequest(createWorkflowRequest).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.CreateWorkflow(context.Background()).CreateWorkflowRequest(createWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateWorkflow`: %v\n", resp) + } +- path: /workflows/{id}/external/oauth-clients + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#create-workflow-external-trigger + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.CreateWorkflowExternalTrigger(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.CreateWorkflowExternalTrigger(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateWorkflowExternalTrigger``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkflowExternalTrigger`: WorkflowOAuthClient + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateWorkflowExternalTrigger`: %v\n", resp) + } +- path: /workflows/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#delete-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.WorkflowsAPI.DeleteWorkflow(context.Background(), id).Execute() + //r, err := apiClient.V2025.WorkflowsAPI.DeleteWorkflow(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.DeleteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /workflows/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#get-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflow(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflow`: %v\n", resp) + } +- path: /workflow-executions/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#get-workflow-execution + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Workflow execution ID. # string | Workflow execution ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflowExecution(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflowExecution(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecution``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecution`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecution`: %v\n", resp) + } +- path: /workflow-executions/{id}/history + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#get-workflow-execution-history + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow execution # string | Id of the workflow execution + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflowExecutionHistory(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflowExecutionHistory(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutionHistory``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecutionHistory`: []WorkflowExecutionEvent + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutionHistory`: %v\n", resp) + } +- path: /workflows/{id}/executions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#get-workflow-executions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Workflow ID. # string | Workflow 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `status eq "Failed"` // 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: **start_time**: *eq, lt, le, gt, ge* **status**: *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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflowExecutions(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflowExecutions(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecutions`: []WorkflowExecution + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutions`: %v\n", resp) + } +- path: /workflow-library + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#list-complete-workflow-library + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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.V2025.WorkflowsAPI.ListCompleteWorkflowLibrary(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.ListCompleteWorkflowLibrary(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListCompleteWorkflowLibrary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCompleteWorkflowLibrary`: []ListCompleteWorkflowLibrary200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListCompleteWorkflowLibrary`: %v\n", resp) + } +- path: /workflow-library/actions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#list-workflow-library-actions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + filters := `id eq "sp:create-campaign"` // 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* (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* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.ListWorkflowLibraryActions(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.ListWorkflowLibraryActions(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryActions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryActions`: []WorkflowLibraryAction + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryActions`: %v\n", resp) + } +- path: /workflow-library/operators + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#list-workflow-library-operators + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.ListWorkflowLibraryOperators(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.ListWorkflowLibraryOperators(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryOperators``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryOperators`: []WorkflowLibraryOperator + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryOperators`: %v\n", resp) + } +- path: /workflow-library/triggers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#list-workflow-library-triggers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + filters := `id eq "idn:identity-attributes-changed"` // 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* (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* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.ListWorkflowLibraryTriggers(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.ListWorkflowLibraryTriggers(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryTriggers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryTriggers`: []WorkflowLibraryTrigger + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryTriggers`: %v\n", resp) + } +- path: /workflows + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#list-workflows + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.ListWorkflows(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.ListWorkflows(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflows``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflows`: []Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflows`: %v\n", resp) + } +- path: /workflows/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#patch-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v2025.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.PatchWorkflow(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.PatchWorkflow(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PatchWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PatchWorkflow`: %v\n", resp) + } +- path: /workflows/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#put-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + workflowbody := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : "{}", + "type" : "EVENT" + }, + "enabled" : false + }`) // WorkflowBody | + + + var workflowBody v2025.WorkflowBody + if err := json.Unmarshal(workflowbody, &workflowBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.PutWorkflow(context.Background(), id).WorkflowBody(workflowBody).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.PutWorkflow(context.Background(), id).WorkflowBody(workflowBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PutWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PutWorkflow`: %v\n", resp) + } +- path: /workflows/execute/external/{id}/test + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#test-external-execute-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + testexternalexecuteworkflowrequest := []byte(``) // TestExternalExecuteWorkflowRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.TestExternalExecuteWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.TestExternalExecuteWorkflow(context.Background(), id).TestExternalExecuteWorkflowRequest(testExternalExecuteWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.TestExternalExecuteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestExternalExecuteWorkflow`: TestExternalExecuteWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.TestExternalExecuteWorkflow`: %v\n", resp) + } +- path: /workflows/{id}/test + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/workflows#test-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + testworkflowrequest := []byte(`{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}`) // TestWorkflowRequest | + + + var testWorkflowRequest v2025.TestWorkflowRequest + if err := json.Unmarshal(testworkflowrequest, &testWorkflowRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkflowsAPI.TestWorkflow(context.Background(), id).TestWorkflowRequest(testWorkflowRequest).Execute() + //resp, r, err := apiClient.V2025.WorkflowsAPI.TestWorkflow(context.Background(), id).TestWorkflowRequest(testWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.TestWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestWorkflow`: TestWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.TestWorkflow`: %v\n", resp) + } +- path: /work-items/{id}/approve/{approvalItemId} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-items#approve-approval-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveApprovalItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItem`: %v\n", resp) + } +- path: /work-items/bulk-approve/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-items#approve-approval-items-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.ApproveApprovalItemsInBulk(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.ApproveApprovalItemsInBulk(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItemsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveApprovalItemsInBulk`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItemsInBulk`: %v\n", resp) + } +- path: /work-items/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-items#complete-work-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + body := `body_example` // string | Body is the request payload to create form definition request (optional) # string | Body is the request payload to create form definition request (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.CompleteWorkItem(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.CompleteWorkItem(context.Background(), id).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.CompleteWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompleteWorkItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.CompleteWorkItem`: %v\n", resp) + } +- path: /work-items/{id}/forward + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-items#forward-work-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + 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") + workitemforward := []byte(`{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + }`) // WorkItemForward | + + + var workItemForward v2025.WorkItemForward + if err := json.Unmarshal(workitemforward, &workItemForward); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V2025.WorkItemsAPI.ForwardWorkItem(context.Background(), id).XSailPointExperimental(xSailPointExperimental).WorkItemForward(workItemForward).Execute() + //r, err := apiClient.V2025.WorkItemsAPI.ForwardWorkItem(context.Background(), id).XSailPointExperimental(xSailPointExperimental).WorkItemForward(workItemForward).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ForwardWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /work-items/completed + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-items#get-completed-work-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.GetCompletedWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.GetCompletedWorkItems(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCompletedWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCompletedWorkItems`: []WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCompletedWorkItems`: %v\n", resp) + } +- path: /work-items/completed/count + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-items#get-count-completed-work-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + ownerId := `ownerId_example` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.GetCountCompletedWorkItems(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.GetCountCompletedWorkItems(context.Background()).XSailPointExperimental(xSailPointExperimental).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCountCompletedWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCountCompletedWorkItems`: WorkItemsCount + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCountCompletedWorkItems`: %v\n", resp) + } +- path: /work-items/count + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-items#get-count-work-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.GetCountWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.GetCountWorkItems(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCountWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCountWorkItems`: WorkItemsCount + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCountWorkItems`: %v\n", resp) + } +- path: /work-items/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-items#get-work-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the work item. # string | ID of the work item. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.GetWorkItem(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.GetWorkItem(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetWorkItem`: %v\n", resp) + } +- path: /work-items/summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-items#get-work-items-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.GetWorkItemsSummary(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.GetWorkItemsSummary(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetWorkItemsSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkItemsSummary`: WorkItemsSummary + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetWorkItemsSummary`: %v\n", resp) + } +- path: /work-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-items#list-work-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.ListWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.ListWorkItems(context.Background()).Limit(limit).Offset(offset).Count(count).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ListWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkItems`: []WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ListWorkItems`: %v\n", resp) + } +- path: /work-items/{id}/reject/{approvalItemId} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-items#reject-approval-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.RejectApprovalItem(context.Background(), id, approvalItemId).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.RejectApprovalItem(context.Background(), id, approvalItemId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.RejectApprovalItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectApprovalItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.RejectApprovalItem`: %v\n", resp) + } +- path: /work-items/bulk-reject/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-items#reject-approval-items-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.RejectApprovalItemsInBulk(context.Background(), id).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.RejectApprovalItemsInBulk(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.RejectApprovalItemsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectApprovalItemsInBulk`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.RejectApprovalItemsInBulk`: %v\n", resp) + } +- path: /work-items/{id}/submit-account-selection + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-items#submit-account-selection + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + requestBody := {fieldName=fieldValue} // map[string]interface{} | Account Selection Data map, keyed on fieldName # map[string]interface{} | Account Selection Data map, keyed on fieldName + + + var requestBody v2025.RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkItemsAPI.SubmitAccountSelection(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V2025.WorkItemsAPI.SubmitAccountSelection(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.SubmitAccountSelection``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitAccountSelection`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.SubmitAccountSelection`: %v\n", resp) + } +- path: /reassignment-configurations + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-reassignment#create-reassignment-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + configurationitemrequest := []byte(`{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }`) // ConfigurationItemRequest | + + + var configurationItemRequest v2025.ConfigurationItemRequest + if err := json.Unmarshal(configurationitemrequest, &configurationItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkReassignmentAPI.CreateReassignmentConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).ConfigurationItemRequest(configurationItemRequest).Execute() + //resp, r, err := apiClient.V2025.WorkReassignmentAPI.CreateReassignmentConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).ConfigurationItemRequest(configurationItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.CreateReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateReassignmentConfiguration`: ConfigurationItemResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.CreateReassignmentConfiguration`: %v\n", resp) + } +- path: /reassignment-configurations/{identityId}/{configType} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-reassignment#delete-reassignment-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique identity id + configType := // ConfigTypeEnum | # ConfigTypeEnum | + 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.V2025.WorkReassignmentAPI.DeleteReassignmentConfiguration(context.Background(), identityId, configType).XSailPointExperimental(xSailPointExperimental).Execute() + //r, err := apiClient.V2025.WorkReassignmentAPI.DeleteReassignmentConfiguration(context.Background(), identityId, configType).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.DeleteReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique identity id + configType := accessRequests // ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type + 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") + exclusionfilters := []byte(`SELF_REVIEW_DELEGATION`) // []string | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkReassignmentAPI.GetEvaluateReassignmentConfiguration(context.Background(), identityId, configType).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.WorkReassignmentAPI.GetEvaluateReassignmentConfiguration(context.Background(), identityId, configType).XSailPointExperimental(xSailPointExperimental).ExclusionFilters(exclusionFilters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetEvaluateReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetEvaluateReassignmentConfiguration`: []EvaluateResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetEvaluateReassignmentConfiguration`: %v\n", resp) + } +- path: /reassignment-configurations/types + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-reassignment#get-reassignment-config-types + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkReassignmentAPI.GetReassignmentConfigTypes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.WorkReassignmentAPI.GetReassignmentConfigTypes(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetReassignmentConfigTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReassignmentConfigTypes`: []ConfigType + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetReassignmentConfigTypes`: %v\n", resp) + } +- path: /reassignment-configurations/{identityId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-reassignment#get-reassignment-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `2c91808781a71ddb0181b9090b5c504f` // string | unique identity id # string | unique 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.WorkReassignmentAPI.GetReassignmentConfiguration(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.WorkReassignmentAPI.GetReassignmentConfiguration(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetReassignmentConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReassignmentConfiguration`: ConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetReassignmentConfiguration`: %v\n", resp) + } +- path: /reassignment-configurations/tenant-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-reassignment#get-tenant-config-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkReassignmentAPI.GetTenantConfigConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.WorkReassignmentAPI.GetTenantConfigConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.GetTenantConfigConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTenantConfigConfiguration`: TenantConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.GetTenantConfigConfiguration`: %v\n", resp) + } +- path: /reassignment-configurations + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-reassignment#list-reassignment-configurations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkReassignmentAPI.ListReassignmentConfigurations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + //resp, r, err := apiClient.V2025.WorkReassignmentAPI.ListReassignmentConfigurations(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.ListReassignmentConfigurations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListReassignmentConfigurations`: []ConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.ListReassignmentConfigurations`: %v\n", resp) + } +- path: /reassignment-configurations/{identityId} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-reassignment#put-reassignment-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `2c91808781a71ddb0181b9090b5c504e` // string | unique identity id # string | unique 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") + configurationitemrequest := []byte(`{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }`) // ConfigurationItemRequest | + + + var configurationItemRequest v2025.ConfigurationItemRequest + if err := json.Unmarshal(configurationitemrequest, &configurationItemRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkReassignmentAPI.PutReassignmentConfig(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).ConfigurationItemRequest(configurationItemRequest).Execute() + //resp, r, err := apiClient.V2025.WorkReassignmentAPI.PutReassignmentConfig(context.Background(), identityId).XSailPointExperimental(xSailPointExperimental).ConfigurationItemRequest(configurationItemRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.PutReassignmentConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutReassignmentConfig`: ConfigurationItemResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.PutReassignmentConfig`: %v\n", resp) + } +- path: /reassignment-configurations/tenant-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v2025/methods/work-reassignment#put-tenant-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v2025 "github.com/sailpoint-oss/golang-sdk/v2/api_v2025" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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") + tenantconfigurationrequest := []byte(`{ + "configDetails" : { + "disabled" : true + } + }`) // TenantConfigurationRequest | + + + var tenantConfigurationRequest v2025.TenantConfigurationRequest + if err := json.Unmarshal(tenantconfigurationrequest, &tenantConfigurationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V2025.WorkReassignmentAPI.PutTenantConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).TenantConfigurationRequest(tenantConfigurationRequest).Execute() + //resp, r, err := apiClient.V2025.WorkReassignmentAPI.PutTenantConfiguration(context.Background()).XSailPointExperimental(xSailPointExperimental).TenantConfigurationRequest(tenantConfigurationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkReassignmentAPI.PutTenantConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutTenantConfiguration`: TenantConfigurationResponse + fmt.Fprintf(os.Stdout, "Response from `WorkReassignmentAPI.PutTenantConfiguration`: %v\n", resp) + } diff --git a/static/code-examples/v3/go_code_examples_overlay.yaml b/static/code-examples/v3/go_code_examples_overlay.yaml new file mode 100644 index 000000000..cbc18c5a1 --- /dev/null +++ b/static/code-examples/v3/go_code_examples_overlay.yaml @@ -0,0 +1,15711 @@ +- path: /access-profiles + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-profiles#create-access-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accessprofile := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + }`) // AccessProfile | + + + var accessProfile v3.AccessProfile + if err := json.Unmarshal(accessprofile, &accessProfile); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessProfilesAPI.CreateAccessProfile(context.Background()).AccessProfile(accessProfile).Execute() + //resp, r, err := apiClient.V3.AccessProfilesAPI.CreateAccessProfile(context.Background()).AccessProfile(accessProfile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.CreateAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.CreateAccessProfile`: %v\n", resp) + } +- path: /access-profiles/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-profiles#delete-access-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Access Profile to delete # string | ID of the Access Profile to delete + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.AccessProfilesAPI.DeleteAccessProfile(context.Background(), id).Execute() + //r, err := apiClient.V3.AccessProfilesAPI.DeleteAccessProfile(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.DeleteAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /access-profiles/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-profiles#delete-access-profiles-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accessprofilebulkdeleterequest := []byte(`{ + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + }`) // AccessProfileBulkDeleteRequest | + + + var accessProfileBulkDeleteRequest v3.AccessProfileBulkDeleteRequest + if err := json.Unmarshal(accessprofilebulkdeleterequest, &accessProfileBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessProfilesAPI.DeleteAccessProfilesInBulk(context.Background()).AccessProfileBulkDeleteRequest(accessProfileBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V3.AccessProfilesAPI.DeleteAccessProfilesInBulk(context.Background()).AccessProfileBulkDeleteRequest(accessProfileBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.DeleteAccessProfilesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccessProfilesInBulk`: AccessProfileBulkDeleteResponse + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.DeleteAccessProfilesInBulk`: %v\n", resp) + } +- path: /access-profiles/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-profiles#get-access-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180837ca6693d017ca8d097500149` // string | ID of the Access Profile # string | ID of the Access Profile + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessProfilesAPI.GetAccessProfile(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.AccessProfilesAPI.GetAccessProfile(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.GetAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.GetAccessProfile`: %v\n", resp) + } +- path: /access-profiles/{id}/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-profiles#get-access-profile-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the access profile containing the entitlements. # string | ID of the access profile containing the entitlements. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `attribute eq "memberOf"` // 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters := `name,-modified` // 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, attribute, value, created, modified** (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, attribute, value, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessProfilesAPI.GetAccessProfileEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.AccessProfilesAPI.GetAccessProfileEntitlements(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.GetAccessProfileEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessProfileEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.GetAccessProfileEntitlements`: %v\n", resp) + } +- path: /access-profiles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-profiles#list-access-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + forSubadmin := `8c190e6787aa4ed9a90bd9d5344523fb` // string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) # string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "SailPoint Support"` // 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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessProfilesAPI.ListAccessProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V3.AccessProfilesAPI.ListAccessProfiles(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.ListAccessProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessProfiles`: []AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.ListAccessProfiles`: %v\n", resp) + } +- path: /access-profiles/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-profiles#patch-access-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121919ecca` // string | ID of the Access Profile to patch # string | ID of the Access Profile to patch + jsonpatchoperation := []byte(`[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessProfilesAPI.PatchAccessProfile(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.AccessProfilesAPI.PatchAccessProfile(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessProfilesAPI.PatchAccessProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAccessProfile`: AccessProfile + fmt.Fprintf(os.Stdout, "Response from `AccessProfilesAPI.PatchAccessProfile`: %v\n", resp) + } +- path: /access-request-approvals/{approvalId}/approve + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-request-approvals#approve-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + commentdto := []byte(`{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + }`) // CommentDto | Reviewer's comment. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.ApproveAccessRequest(context.Background(), approvalId).Execute() + //resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.ApproveAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ApproveAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ApproveAccessRequest`: %v\n", resp) + } +- path: /access-request-approvals/{approvalId}/forward + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-request-approvals#forward-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + forwardapprovaldto := []byte(`{ + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" + }`) // ForwardApprovalDto | Information about the forwarded approval. + + + var forwardApprovalDto v3.ForwardApprovalDto + if err := json.Unmarshal(forwardapprovaldto, &forwardApprovalDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.ForwardAccessRequest(context.Background(), approvalId).ForwardApprovalDto(forwardApprovalDto).Execute() + //resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.ForwardAccessRequest(context.Background(), approvalId).ForwardApprovalDto(forwardApprovalDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ForwardAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ForwardAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ForwardAccessRequest`: %v\n", resp) + } +- path: /access-request-approvals/approval-summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-request-approvals#get-access-request-approval-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + fromDate := `from-date=2020-03-19T19:59:11Z` // string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) # string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary(context.Background()).Execute() + //resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary(context.Background()).OwnerId(ownerId).FromDate(fromDate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestApprovalSummary`: ApprovalSummary + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.GetAccessRequestApprovalSummary`: %v\n", resp) + } +- path: /access-request-approvals/completed + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-request-approvals#list-completed-approvals + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "2c91808568c529c60168cca6f90c1313"` // 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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + sorters := `modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.ListCompletedApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.ListCompletedApprovals(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListCompletedApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCompletedApprovals`: []CompletedApproval + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListCompletedApprovals`: %v\n", resp) + } +- path: /access-request-approvals/pending + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-request-approvals#list-pending-approvals + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `2c91808568c529c60168cca6f90c1313` // string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "2c91808568c529c60168cca6f90c1313"` // 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) + sorters := `modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.ListPendingApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.ListPendingApprovals(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.ListPendingApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPendingApprovals`: []PendingApproval + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.ListPendingApprovals`: %v\n", resp) + } +- path: /access-request-approvals/{approvalId}/reject + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-request-approvals#reject-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + approvalId := `2c91808b7294bea301729568c68c002e` // string | Approval ID. # string | Approval ID. + commentdto := []byte(`{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + }`) // CommentDto | Reviewer's comment. + + + var commentDto v3.CommentDto + if err := json.Unmarshal(commentdto, &commentDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.RejectAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + //resp, r, err := apiClient.V3.AccessRequestApprovalsAPI.RejectAccessRequest(context.Background(), approvalId).CommentDto(commentDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestApprovalsAPI.RejectAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestApprovalsAPI.RejectAccessRequest`: %v\n", resp) + } +- path: /access-requests/cancel + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-requests#cancel-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + cancelaccessrequest := []byte(`{ + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + }`) // CancelAccessRequest | + + + var cancelAccessRequest v3.CancelAccessRequest + if err := json.Unmarshal(cancelaccessrequest, &cancelAccessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestsAPI.CancelAccessRequest(context.Background()).CancelAccessRequest(cancelAccessRequest).Execute() + //resp, r, err := apiClient.V3.AccessRequestsAPI.CancelAccessRequest(context.Background()).CancelAccessRequest(cancelAccessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CancelAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CancelAccessRequest`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CancelAccessRequest`: %v\n", resp) + } +- path: /access-requests + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-requests#create-access-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accessrequest := []byte(`{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } ] + }`) // AccessRequest | + + + var accessRequest v3.AccessRequest + if err := json.Unmarshal(accessrequest, &accessRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestsAPI.CreateAccessRequest(context.Background()).AccessRequest(accessRequest).Execute() + //resp, r, err := apiClient.V3.AccessRequestsAPI.CreateAccessRequest(context.Background()).AccessRequest(accessRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.CreateAccessRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccessRequest`: AccessRequestResponse + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.CreateAccessRequest`: %v\n", resp) + } +- path: /access-request-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-requests#get-access-request-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestsAPI.GetAccessRequestConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.AccessRequestsAPI.GetAccessRequestConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.GetAccessRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccessRequestConfig`: AccessRequestConfig + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.GetAccessRequestConfig`: %v\n", resp) + } +- path: /access-request-status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-requests#list-access-request-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + assignedTo := `2c9180877b2b6ea4017b2c545f971429` // string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + count := false // bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + limit := 100 // int32 | Max number of results to return. (optional) (default to 250) # int32 | Max number of results to return. (optional) (default to 250) + offset := 10 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + filters := `accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"` // 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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + sorters := `created` // 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: **created, modified, accountActivityItemId, name** (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: **created, modified, accountActivityItemId, name** (optional) + requestState := `request-state=EXECUTING` // string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestsAPI.ListAccessRequestStatus(context.Background()).Execute() + //resp, r, err := apiClient.V3.AccessRequestsAPI.ListAccessRequestStatus(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).AssignedTo(assignedTo).Count(count).Limit(limit).Offset(offset).Filters(filters).Sorters(sorters).RequestState(requestState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.ListAccessRequestStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccessRequestStatus`: []RequestedItemStatus + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.ListAccessRequestStatus`: %v\n", resp) + } +- path: /access-request-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/access-requests#set-access-request-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accessrequestconfig := []byte(`{ + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + }`) // AccessRequestConfig | + + + var accessRequestConfig v3.AccessRequestConfig + if err := json.Unmarshal(accessrequestconfig, &accessRequestConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccessRequestsAPI.SetAccessRequestConfig(context.Background()).AccessRequestConfig(accessRequestConfig).Execute() + //resp, r, err := apiClient.V3.AccessRequestsAPI.SetAccessRequestConfig(context.Background()).AccessRequestConfig(accessRequestConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccessRequestsAPI.SetAccessRequestConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetAccessRequestConfig`: AccessRequestConfig + fmt.Fprintf(os.Stdout, "Response from `AccessRequestsAPI.SetAccessRequestConfig`: %v\n", resp) + } +- path: /account-activities/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/account-activities#get-account-activity + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account activity id # string | The account activity id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountActivitiesAPI.GetAccountActivity(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.AccountActivitiesAPI.GetAccountActivity(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountActivitiesAPI.GetAccountActivity``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccountActivity`: AccountActivity + fmt.Fprintf(os.Stdout, "Response from `AccountActivitiesAPI.GetAccountActivity`: %v\n", resp) + } +- path: /account-activities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/account-activities#list-account-activities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c91808568c529c60168cca6f90c1313` // string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requestedBy := `2c91808568c529c60168cca6f90c1313` // string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regardingIdentity := `2c91808568c529c60168cca6f90c1313` // string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `type eq "Identity Refresh"` // 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + sorters := `created` // 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: **type, created, modified** (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: **type, created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountActivitiesAPI.ListAccountActivities(context.Background()).Execute() + //resp, r, err := apiClient.V3.AccountActivitiesAPI.ListAccountActivities(context.Background()).RequestedFor(requestedFor).RequestedBy(requestedBy).RegardingIdentity(regardingIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountActivitiesAPI.ListAccountActivities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccountActivities`: []AccountActivity + fmt.Fprintf(os.Stdout, "Response from `AccountActivitiesAPI.ListAccountActivities`: %v\n", resp) + } +- path: /accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/accounts#create-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accountattributescreate := []byte(`{ + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }`) // AccountAttributesCreate | + + + var accountAttributesCreate v3.AccountAttributesCreate + if err := json.Unmarshal(accountattributescreate, &accountAttributesCreate); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.CreateAccount(context.Background()).AccountAttributesCreate(accountAttributesCreate).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.CreateAccount(context.Background()).AccountAttributesCreate(accountAttributesCreate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.CreateAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.CreateAccount`: %v\n", resp) + } +- path: /accounts/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/accounts#delete-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.DeleteAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.DeleteAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DeleteAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DeleteAccount`: %v\n", resp) + } +- path: /accounts/{id}/disable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/accounts#disable-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + accounttogglerequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }`) // AccountToggleRequest | + + + var accountToggleRequest v3.AccountToggleRequest + if err := json.Unmarshal(accounttogglerequest, &accountToggleRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.DisableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.DisableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.DisableAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DisableAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.DisableAccount`: %v\n", resp) + } +- path: /accounts/{id}/enable + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/accounts#enable-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + accounttogglerequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }`) // AccountToggleRequest | + + + var accountToggleRequest v3.AccountToggleRequest + if err := json.Unmarshal(accounttogglerequest, &accountToggleRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.EnableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.EnableAccount(context.Background(), id).AccountToggleRequest(accountToggleRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.EnableAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `EnableAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.EnableAccount`: %v\n", resp) + } +- path: /accounts/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/accounts#get-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.GetAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.GetAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.GetAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccount`: Account + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.GetAccount`: %v\n", resp) + } +- path: /accounts/{id}/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/accounts#get-account-entitlements + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.GetAccountEntitlements(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.GetAccountEntitlements(context.Background(), id).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.GetAccountEntitlements``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAccountEntitlements`: []Entitlement + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.GetAccountEntitlements`: %v\n", resp) + } +- path: /accounts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/accounts#list-accounts + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + detailLevel := `FULL` // string | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) # string | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + filters := `identityId eq "2c9180858082150f0180893dbaf44201"` // 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) + sorters := `id,name` // 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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.ListAccounts(context.Background()).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.ListAccounts(context.Background()).Limit(limit).Offset(offset).Count(count).DetailLevel(detailLevel).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.ListAccounts``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListAccounts`: []Account + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.ListAccounts`: %v\n", resp) + } +- path: /accounts/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/accounts#put-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + accountattributes := []byte(`{ + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }`) // AccountAttributes | + + + var accountAttributes v3.AccountAttributes + if err := json.Unmarshal(accountattributes, &accountAttributes); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.PutAccount(context.Background(), id).AccountAttributes(accountAttributes).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.PutAccount(context.Background(), id).AccountAttributes(accountAttributes).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.PutAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.PutAccount`: %v\n", resp) + } +- path: /accounts/{id}/reload + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/accounts#submit-reload-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account id # string | The account id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.SubmitReloadAccount(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.SubmitReloadAccount(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.SubmitReloadAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitReloadAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.SubmitReloadAccount`: %v\n", resp) + } +- path: /accounts/{id}/unlock + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/accounts#unlock-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The account ID. # string | The account ID. + accountunlockrequest := []byte(`{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + }`) // AccountUnlockRequest | + + + var accountUnlockRequest v3.AccountUnlockRequest + if err := json.Unmarshal(accountunlockrequest, &accountUnlockRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.UnlockAccount(context.Background(), id).AccountUnlockRequest(accountUnlockRequest).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.UnlockAccount(context.Background(), id).AccountUnlockRequest(accountUnlockRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.UnlockAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UnlockAccount`: AccountsAsyncResult + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.UnlockAccount`: %v\n", resp) + } +- path: /accounts/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/accounts#update-account + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Account ID. # string | Account ID. + requestbody := []byte(`[{op=remove, path=/identityId}]`) // []map[string]interface{} | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var requestBody v3.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountsAPI.UpdateAccount(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V3.AccountsAPI.UpdateAccount(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountsAPI.UpdateAccount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateAccount`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `AccountsAPI.UpdateAccount`: %v\n", resp) + } +- path: /account-usages/{accountId}/summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/account-usages#get-usages-by-account-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + accountId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of IDN account # string | ID of IDN account + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `-date` // 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: **date** (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: **date** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AccountUsagesAPI.GetUsagesByAccountId(context.Background(), accountId).Execute() + //resp, r, err := apiClient.V3.AccountUsagesAPI.GetUsagesByAccountId(context.Background(), accountId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AccountUsagesAPI.GetUsagesByAccountId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUsagesByAccountId`: []AccountUsage + fmt.Fprintf(os.Stdout, "Response from `AccountUsagesAPI.GetUsagesByAccountId`: %v\n", resp) + } +- path: /discovered-applications + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/application-discovery#get-discovered-applications + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + filter := `name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")` // 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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + sorters := `name` // 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, description, discoveredAt, discoverySource** (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, description, discoveredAt, discoverySource** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ApplicationDiscoveryAPI.GetDiscoveredApplications(context.Background()).Execute() + //resp, r, err := apiClient.V3.ApplicationDiscoveryAPI.GetDiscoveredApplications(context.Background()).Limit(limit).Offset(offset).Detail(detail).Filter(filter).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetDiscoveredApplications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDiscoveredApplications`: []GetDiscoveredApplications200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `ApplicationDiscoveryAPI.GetDiscoveredApplications`: %v\n", resp) + } +- path: /manual-discover-applications-template + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate(context.Background()).Execute() + //resp, r, err := apiClient.V3.ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManualDiscoverApplicationsCsvTemplate`: ManualDiscoverApplicationsTemplate + fmt.Fprintf(os.Stdout, "Response from `ApplicationDiscoveryAPI.GetManualDiscoverApplicationsCsvTemplate`: %v\n", resp) + } +- path: /manual-discover-applications + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + file := BINARY_DATA_HERE // *os.File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # *os.File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate(context.Background()).File(file).Execute() + //r, err := apiClient.V3.ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate(context.Background()).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDiscoveryAPI.SendManualDiscoverApplicationsCsvTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /auth-users/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/auth-users#get-auth-user + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AuthUsersAPI.GetAuthUser(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.AuthUsersAPI.GetAuthUser(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthUsersAPI.GetAuthUser``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthUser`: AuthUser + fmt.Fprintf(os.Stdout, "Response from `AuthUsersAPI.GetAuthUser`: %v\n", resp) + } +- path: /auth-users/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/auth-users#patch-auth-user + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Identity ID # string | Identity ID + jsonpatchoperation := []byte(`[{op=replace, path=/capabilities, value=[ORG_ADMIN]}]`) // []JsonPatchOperation | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.AuthUsersAPI.PatchAuthUser(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.AuthUsersAPI.PatchAuthUser(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `AuthUsersAPI.PatchAuthUser``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthUser`: AuthUser + fmt.Fprintf(os.Stdout, "Response from `AuthUsersAPI.PatchAuthUser`: %v\n", resp) + } +- path: /brandings + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/branding#create-branding-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `name_example` // string | name of branding item # string | name of branding item + productName := `productName_example` // string | product name # string | product name + actionButtonColor := `actionButtonColor_example` // string | hex value of color for action button (optional) # string | hex value of color for action button (optional) + activeLinkColor := `activeLinkColor_example` // string | hex value of color for link (optional) # string | hex value of color for link (optional) + navigationColor := `navigationColor_example` // string | hex value of color for navigation bar (optional) # string | hex value of color for navigation bar (optional) + emailFromAddress := `emailFromAddress_example` // string | email from address (optional) # string | email from address (optional) + loginInformationalMessage := `loginInformationalMessage_example` // string | login information message (optional) # string | login information message (optional) + fileStandard := BINARY_DATA_HERE // *os.File | png file with logo (optional) # *os.File | png file with logo (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.BrandingAPI.CreateBrandingItem(context.Background()).Name(name).ProductName(productName).Execute() + //resp, r, err := apiClient.V3.BrandingAPI.CreateBrandingItem(context.Background()).Name(name).ProductName(productName).ActionButtonColor(actionButtonColor).ActiveLinkColor(activeLinkColor).NavigationColor(navigationColor).EmailFromAddress(emailFromAddress).LoginInformationalMessage(loginInformationalMessage).FileStandard(fileStandard).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.CreateBrandingItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateBrandingItem`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.CreateBrandingItem`: %v\n", resp) + } +- path: /brandings/{name} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/branding#delete-branding + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `default` // string | The name of the branding item to be deleted # string | The name of the branding item to be deleted + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.BrandingAPI.DeleteBranding(context.Background(), name).Execute() + //r, err := apiClient.V3.BrandingAPI.DeleteBranding(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.DeleteBranding``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /brandings/{name} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/branding#get-branding + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `default` // string | The name of the branding item to be retrieved # string | The name of the branding item to be retrieved + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.BrandingAPI.GetBranding(context.Background(), name).Execute() + //resp, r, err := apiClient.V3.BrandingAPI.GetBranding(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.GetBranding``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBranding`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.GetBranding`: %v\n", resp) + } +- path: /brandings + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/branding#get-branding-list + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.BrandingAPI.GetBrandingList(context.Background()).Execute() + //resp, r, err := apiClient.V3.BrandingAPI.GetBrandingList(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.GetBrandingList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetBrandingList`: []BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.GetBrandingList`: %v\n", resp) + } +- path: /brandings/{name} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/branding#set-branding-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `default` // string | The name of the branding item to be retrieved # string | The name of the branding item to be retrieved + name2 := `name_example` // string | name of branding item # string | name of branding item + productName := `productName_example` // string | product name # string | product name + actionButtonColor := `actionButtonColor_example` // string | hex value of color for action button (optional) # string | hex value of color for action button (optional) + activeLinkColor := `activeLinkColor_example` // string | hex value of color for link (optional) # string | hex value of color for link (optional) + navigationColor := `navigationColor_example` // string | hex value of color for navigation bar (optional) # string | hex value of color for navigation bar (optional) + emailFromAddress := `emailFromAddress_example` // string | email from address (optional) # string | email from address (optional) + loginInformationalMessage := `loginInformationalMessage_example` // string | login information message (optional) # string | login information message (optional) + fileStandard := BINARY_DATA_HERE // *os.File | png file with logo (optional) # *os.File | png file with logo (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.BrandingAPI.SetBrandingItem(context.Background(), name).Name2(name2).ProductName(productName).Execute() + //resp, r, err := apiClient.V3.BrandingAPI.SetBrandingItem(context.Background(), name).Name2(name2).ProductName(productName).ActionButtonColor(actionButtonColor).ActiveLinkColor(activeLinkColor).NavigationColor(navigationColor).EmailFromAddress(emailFromAddress).LoginInformationalMessage(loginInformationalMessage).FileStandard(fileStandard).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BrandingAPI.SetBrandingItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetBrandingItem`: BrandingItem + fmt.Fprintf(os.Stdout, "Response from `BrandingAPI.SetBrandingItem`: %v\n", resp) + } +- path: /campaign-filters + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaign-filters#create-campaign-filter + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + campaignfilterdetails := []byte(`{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + }`) // CampaignFilterDetails | + + + var campaignFilterDetails v3.CampaignFilterDetails + if err := json.Unmarshal(campaignfilterdetails, &campaignFilterDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignFiltersAPI.CreateCampaignFilter(context.Background()).CampaignFilterDetails(campaignFilterDetails).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignFiltersAPI.CreateCampaignFilter(context.Background()).CampaignFilterDetails(campaignFilterDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.CreateCampaignFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaignFilter`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.CreateCampaignFilter`: %v\n", resp) + } +- path: /campaign-filters/delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaign-filters#delete-campaign-filters + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestbody := []byte(``) // []string | A json list of IDs of campaign filters to delete. + + + var requestBody v3.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.CertificationCampaignFiltersAPI.DeleteCampaignFilters(context.Background()).RequestBody(requestBody).Execute() + //r, err := apiClient.V3.CertificationCampaignFiltersAPI.DeleteCampaignFilters(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.DeleteCampaignFilters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /campaign-filters/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaign-filters#get-campaign-filter-by-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e9f9a1397b842fd5a65842087040d3ac` // string | The ID of the campaign filter to be retrieved. # string | The ID of the campaign filter to be retrieved. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignFiltersAPI.GetCampaignFilterById(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignFiltersAPI.GetCampaignFilterById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.GetCampaignFilterById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignFilterById`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.GetCampaignFilterById`: %v\n", resp) + } +- path: /campaign-filters + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaign-filters#list-campaign-filters + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + start := 0 // int32 | Start/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 | Start/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) + includeSystemFilters := true // bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to true) # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignFiltersAPI.ListCampaignFilters(context.Background()).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignFiltersAPI.ListCampaignFilters(context.Background()).Limit(limit).Start(start).IncludeSystemFilters(includeSystemFilters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.ListCampaignFilters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCampaignFilters`: ListCampaignFilters200Response + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.ListCampaignFilters`: %v\n", resp) + } +- path: /campaign-filters/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaign-filters#update-campaign-filter + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filterId := `e9f9a1397b842fd5a65842087040d3ac` // string | The ID of the campaign filter being modified. # string | The ID of the campaign filter being modified. + campaignfilterdetails := []byte(`{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + }`) // CampaignFilterDetails | A campaign filter details with updated field values. + + + var campaignFilterDetails v3.CampaignFilterDetails + if err := json.Unmarshal(campaignfilterdetails, &campaignFilterDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignFiltersAPI.UpdateCampaignFilter(context.Background(), filterId).CampaignFilterDetails(campaignFilterDetails).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignFiltersAPI.UpdateCampaignFilter(context.Background(), filterId).CampaignFilterDetails(campaignFilterDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignFiltersAPI.UpdateCampaignFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCampaignFilter`: CampaignFilterDetails + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignFiltersAPI.UpdateCampaignFilter`: %v\n", resp) + } +- path: /campaigns/{id}/complete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#complete-campaign + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Campaign ID. # string | Campaign ID. + campaigncompleteoptions := []byte(`{ + "autoCompleteAction" : "REVOKE" + }`) // CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.CompleteCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.CompleteCampaign(context.Background(), id).CampaignCompleteOptions(campaignCompleteOptions).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CompleteCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompleteCampaign`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CompleteCampaign`: %v\n", resp) + } +- path: /campaigns + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#create-campaign + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + campaign := []byte(`{ + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }`) // Campaign | + + + var campaign v3.Campaign + if err := json.Unmarshal(campaign, &campaign); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.CreateCampaign(context.Background()).Campaign(campaign).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.CreateCampaign(context.Background()).Campaign(campaign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CreateCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaign`: Campaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CreateCampaign`: %v\n", resp) + } +- path: /campaign-templates + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#create-campaign-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + campaigntemplate := []byte(`{ + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + }`) // CampaignTemplate | + + + var campaignTemplate v3.CampaignTemplate + if err := json.Unmarshal(campaigntemplate, &campaignTemplate); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.CreateCampaignTemplate(context.Background()).CampaignTemplate(campaignTemplate).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.CreateCampaignTemplate(context.Background()).CampaignTemplate(campaignTemplate).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.CreateCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.CreateCampaignTemplate`: %v\n", resp) + } +- path: /campaign-templates/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#delete-campaign-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template being deleted. # string | ID of the campaign template being deleted. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.CertificationCampaignsAPI.DeleteCampaignTemplate(context.Background(), id).Execute() + //r, err := apiClient.V3.CertificationCampaignsAPI.DeleteCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /campaign-templates/{id}/schedule + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#delete-campaign-template-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template whose schedule is being deleted. # string | ID of the campaign template whose schedule is being deleted. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.CertificationCampaignsAPI.DeleteCampaignTemplateSchedule(context.Background(), id).Execute() + //r, err := apiClient.V3.CertificationCampaignsAPI.DeleteCampaignTemplateSchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /campaigns/delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#delete-campaigns + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + campaignsdeleterequest := []byte(`{ + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + }`) // CampaignsDeleteRequest | IDs of the campaigns to delete. + + + var campaignsDeleteRequest v3.CampaignsDeleteRequest + if err := json.Unmarshal(campaignsdeleterequest, &campaignsDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).CampaignsDeleteRequest(campaignsDeleteRequest).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.DeleteCampaigns(context.Background()).CampaignsDeleteRequest(campaignsDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.DeleteCampaigns``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteCampaigns`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.DeleteCampaigns`: %v\n", resp) + } +- path: /campaigns + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#get-active-campaigns + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Manager Campaign"` // 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* **status**: *eq, in* (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* **status**: *eq, in* (optional) + sorters := `name` // 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, created** (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, created** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetActiveCampaigns(context.Background()).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetActiveCampaigns(context.Background()).Detail(detail).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetActiveCampaigns``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetActiveCampaigns`: []GetActiveCampaigns200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetActiveCampaigns`: %v\n", resp) + } +- path: /campaigns/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#get-campaign + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign to be retrieved. # string | ID of the campaign to be retrieved. + detail := `FULL` // string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # string | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaign(context.Background(), id).Detail(detail).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaign`: GetCampaign200Response + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaign`: %v\n", resp) + } +- path: /campaigns/{id}/reports + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#get-campaign-reports + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign whose reports are being fetched. # string | ID of the campaign whose reports are being fetched. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignReports(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignReports(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignReports``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignReports`: []CampaignReport + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignReports`: %v\n", resp) + } +- path: /campaigns/reports-configuration + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#get-campaign-reports-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignReportsConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignReportsConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignReportsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignReportsConfig`: CampaignReportsConfig + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignReportsConfig`: %v\n", resp) + } +- path: /campaign-templates/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#get-campaign-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Requested campaign template's ID. # string | Requested campaign template's ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplate`: %v\n", resp) + } +- path: /campaign-templates/{id}/schedule + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#get-campaign-template-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template whose schedule is being fetched. # string | ID of the campaign template whose schedule is being fetched. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignTemplateSchedule(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignTemplateSchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplateSchedule`: Schedule + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplateSchedule`: %v\n", resp) + } +- path: /campaign-templates + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#get-campaign-templates + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `name` // 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, created, modified** (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, created, modified** (optional) + filters := `name eq "manager template"` // 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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignTemplates(context.Background()).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.GetCampaignTemplates(context.Background()).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.GetCampaignTemplates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCampaignTemplates`: []CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.GetCampaignTemplates`: %v\n", resp) + } +- path: /campaigns/{id}/reassign + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#move + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification campaign ID # string | The certification campaign ID + adminreviewreassign := []byte(`{ + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + }`) // AdminReviewReassign | + + + var adminReviewReassign v3.AdminReviewReassign + if err := json.Unmarshal(adminreviewreassign, &adminReviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.Move(context.Background(), id).AdminReviewReassign(adminReviewReassign).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.Move(context.Background(), id).AdminReviewReassign(adminReviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.Move``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `Move`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.Move`: %v\n", resp) + } +- path: /campaign-templates/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#patch-campaign-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template being modified. # string | ID of the campaign template being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/campaign/filter/id, value=ff80818155fe8c080155fe8d925b0316}]`) // []JsonPatchOperation | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.PatchCampaignTemplate(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.PatchCampaignTemplate(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.PatchCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchCampaignTemplate`: CampaignTemplate + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.PatchCampaignTemplate`: %v\n", resp) + } +- path: /campaigns/reports-configuration + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#set-campaign-reports-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + campaignreportsconfig := []byte(`{ + "identityAttributeColumns" : [ "firstname", "lastname" ] + }`) // CampaignReportsConfig | Campaign report configuration. + + + var campaignReportsConfig v3.CampaignReportsConfig + if err := json.Unmarshal(campaignreportsconfig, &campaignReportsConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.SetCampaignReportsConfig(context.Background()).CampaignReportsConfig(campaignReportsConfig).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.SetCampaignReportsConfig(context.Background()).CampaignReportsConfig(campaignReportsConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.SetCampaignReportsConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetCampaignReportsConfig`: CampaignReportsConfig + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.SetCampaignReportsConfig`: %v\n", resp) + } +- path: /campaign-templates/{id}/schedule + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#set-campaign-template-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `04bedce387bd47b2ae1f86eb0bb36dee` // string | ID of the campaign template being scheduled. # string | ID of the campaign template being scheduled. + schedule := []byte(`{ + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + }`) // Schedule | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.CertificationCampaignsAPI.SetCampaignTemplateSchedule(context.Background(), id).Execute() + //r, err := apiClient.V3.CertificationCampaignsAPI.SetCampaignTemplateSchedule(context.Background(), id).Schedule(schedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.SetCampaignTemplateSchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /campaigns/{id}/activate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#start-campaign + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Campaign ID. # string | Campaign ID. + activatecampaignoptions := []byte(`{ + "timeZone" : "-05:00" + }`) // ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.StartCampaign(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.StartCampaign(context.Background(), id).ActivateCampaignOptions(activateCampaignOptions).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaign`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaign`: %v\n", resp) + } +- path: /campaigns/{id}/run-remediation-scan + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#start-campaign-remediation-scan + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign the remediation scan is being run for. # string | ID of the campaign the remediation scan is being run for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.StartCampaignRemediationScan(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.StartCampaignRemediationScan(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaignRemediationScan``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaignRemediationScan`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaignRemediationScan`: %v\n", resp) + } +- path: /campaigns/{id}/run-report/{type} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#start-campaign-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign the report is being run for. # string | ID of the campaign the report is being run for. + type_ := // ReportType | Type of the report to run. # ReportType | Type of the report to run. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.StartCampaignReport(context.Background(), id, type_).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.StartCampaignReport(context.Background(), id, type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartCampaignReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartCampaignReport`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartCampaignReport`: %v\n", resp) + } +- path: /campaign-templates/{id}/generate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#start-generate-campaign-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the campaign template to use for generation. # string | ID of the campaign template to use for generation. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.StartGenerateCampaignTemplate(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.StartGenerateCampaignTemplate(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.StartGenerateCampaignTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartGenerateCampaignTemplate`: CampaignReference + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.StartGenerateCampaignTemplate`: %v\n", resp) + } +- path: /campaigns/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-campaigns#update-campaign + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808571bcfcf80171c23e4b4221fc` // string | ID of the campaign template being modified. # string | ID of the campaign template being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]`) // []JsonPatchOperation | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationCampaignsAPI.UpdateCampaign(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.CertificationCampaignsAPI.UpdateCampaign(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationCampaignsAPI.UpdateCampaign``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCampaign`: SlimCampaign + fmt.Fprintf(os.Stdout, "Response from `CertificationCampaignsAPI.UpdateCampaign`: %v\n", resp) + } +- path: /certification-tasks/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certifications#get-certification-task + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `63b32151-26c0-42f4-9299-8898dc1c9daa` // string | The task ID # string | The task ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.GetCertificationTask(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.GetCertificationTask(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetCertificationTask``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCertificationTask`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetCertificationTask`: %v\n", resp) + } +- path: /certifications/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certifications#get-identity-certification + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification id # string | The certification id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.GetIdentityCertification(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.GetIdentityCertification(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertification`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertification`: %v\n", resp) + } +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certifications#get-identity-certification-item-permissions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + certificationId := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification ID + itemId := `2c91808671bcbab40171bd945d961227` // string | The certification item ID # string | The certification item ID + filters := `target eq "SYS.OBJAUTH2"` // 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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.GetIdentityCertificationItemPermissions(context.Background(), certificationId, itemId).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.GetIdentityCertificationItemPermissions(context.Background(), certificationId, itemId).Filters(filters).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetIdentityCertificationItemPermissions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityCertificationItemPermissions`: []PermissionDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetIdentityCertificationItemPermissions`: %v\n", resp) + } +- path: /certification-tasks + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certifications#get-pending-certification-tasks + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reviewerIdentity := `Ada.1de82e55078344` // string | The ID of reviewer identity. *me* indicates the current user. (optional) # string | The ID of reviewer identity. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `type eq "ADMIN_REASSIGN"` // 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* **targetId**: *eq, in* **type**: *eq, in* (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* **targetId**: *eq, in* **type**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.GetPendingCertificationTasks(context.Background()).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.GetPendingCertificationTasks(context.Background()).ReviewerIdentity(reviewerIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.GetPendingCertificationTasks``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPendingCertificationTasks`: []CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.GetPendingCertificationTasks`: %v\n", resp) + } +- path: /certifications/{id}/reviewers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certifications#list-certification-reviewers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Bob"` // 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* **email**: *eq, sw* (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* **email**: *eq, sw* (optional) + sorters := `name` // 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, email** (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, email** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.ListCertificationReviewers(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.ListCertificationReviewers(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListCertificationReviewers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCertificationReviewers`: []IdentityReferenceWithNameAndEmail + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListCertificationReviewers`: %v\n", resp) + } +- path: /certifications/{id}/access-review-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certifications#list-identity-access-review-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters := `access.name,-accessProfile.sourceName` // 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) + entitlements := `identityEntitlement` // string | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) + accessProfiles := `accessProfile1` // string | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) + roles := `userRole` // string | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) # string | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.ListIdentityAccessReviewItems(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.ListIdentityAccessReviewItems(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Entitlements(entitlements).AccessProfiles(accessProfiles).Roles(roles).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListIdentityAccessReviewItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityAccessReviewItems`: []AccessReviewItem + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListIdentityAccessReviewItems`: %v\n", resp) + } +- path: /certifications + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certifications#list-identity-certifications + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reviewerIdentity := `me` // string | Reviewer's identity. *me* indicates the current user. (optional) # string | Reviewer's identity. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) + sorters := `name,due` // 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, due, signed** (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, due, signed** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.ListIdentityCertifications(context.Background()).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.ListIdentityCertifications(context.Background()).ReviewerIdentity(reviewerIdentity).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ListIdentityCertifications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityCertifications`: []IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ListIdentityCertifications`: %v\n", resp) + } +- path: /certifications/{id}/decide + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certifications#make-identity-decision + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the identity campaign certification on which to make decisions # string | The ID of the identity campaign certification on which to make decisions + reviewdecision := []byte(`[{id=ef38f94347e94562b5bb8424a56396b5, decision=APPROVE, bulk=true, comments=This user still needs access to this source.}, {id=ef38f94347e94562b5bb8424a56397d8, decision=APPROVE, bulk=true, comments=This user still needs access to this source too.}]`) // []ReviewDecision | A non-empty array of decisions to be made. + + + var reviewDecision v3.[]ReviewDecision + if err := json.Unmarshal(reviewdecision, &reviewDecision); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.MakeIdentityDecision(context.Background(), id).ReviewDecision(reviewDecision).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.MakeIdentityDecision(context.Background(), id).ReviewDecision(reviewDecision).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.MakeIdentityDecision``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `MakeIdentityDecision`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.MakeIdentityDecision`: %v\n", resp) + } +- path: /certifications/{id}/reassign + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certifications#reassign-identity-certifications + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + reviewreassign := []byte(`{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + }`) // ReviewReassign | + + + var reviewReassign v3.ReviewReassign + if err := json.Unmarshal(reviewreassign, &reviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.ReassignIdentityCertifications(context.Background(), id).ReviewReassign(reviewReassign).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.ReassignIdentityCertifications(context.Background(), id).ReviewReassign(reviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.ReassignIdentityCertifications``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ReassignIdentityCertifications`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.ReassignIdentityCertifications`: %v\n", resp) + } +- path: /certifications/{id}/sign-off + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certifications#sign-off-identity-certification + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.SignOffIdentityCertification(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.SignOffIdentityCertification(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.SignOffIdentityCertification``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SignOffIdentityCertification`: IdentityCertificationDto + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.SignOffIdentityCertification`: %v\n", resp) + } +- path: /certifications/{id}/reassign-async + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certifications#submit-reassign-certs-async + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + reviewreassign := []byte(`{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + }`) // ReviewReassign | + + + var reviewReassign v3.ReviewReassign + if err := json.Unmarshal(reviewreassign, &reviewReassign); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationsAPI.SubmitReassignCertsAsync(context.Background(), id).ReviewReassign(reviewReassign).Execute() + //resp, r, err := apiClient.V3.CertificationsAPI.SubmitReassignCertsAsync(context.Background(), id).ReviewReassign(reviewReassign).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationsAPI.SubmitReassignCertsAsync``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitReassignCertsAsync`: CertificationTask + fmt.Fprintf(os.Stdout, "Response from `CertificationsAPI.SubmitReassignCertsAsync`: %v\n", resp) + } +- path: /certifications/{id}/access-summaries/{type} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-summaries#get-identity-access-summaries + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + type_ := `ACCESS_PROFILE` // string | The type of access review item to retrieve summaries for # string | The type of access review item to retrieve summaries for + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `access.id eq "ef38f94347e94562b5bb8424a56397d8"` // 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters := `access.name` // 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: **access.name** (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: **access.name** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationSummariesAPI.GetIdentityAccessSummaries(context.Background(), id, type_).Execute() + //resp, r, err := apiClient.V3.CertificationSummariesAPI.GetIdentityAccessSummaries(context.Background(), id, type_).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentityAccessSummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityAccessSummaries`: []AccessSummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentityAccessSummaries`: %v\n", resp) + } +- path: /certifications/{id}/decision-summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-summaries#get-identity-decision-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The certification ID # string | The certification ID + filters := `identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"` // 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: **identitySummary.id**: *eq, in* (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: **identitySummary.id**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationSummariesAPI.GetIdentityDecisionSummary(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationSummariesAPI.GetIdentityDecisionSummary(context.Background(), id).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentityDecisionSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityDecisionSummary`: IdentityCertDecisionSummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentityDecisionSummary`: %v\n", resp) + } +- path: /certifications/{id}/identity-summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-summaries#get-identity-summaries + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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* **completed**: *eq, ne* **name**: *eq, sw* (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* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters := `name` // 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** (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** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationSummariesAPI.GetIdentitySummaries(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.CertificationSummariesAPI.GetIdentitySummaries(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentitySummaries``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySummaries`: []CertificationIdentitySummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentitySummaries`: %v\n", resp) + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/certification-summaries#get-identity-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The identity campaign certification ID # string | The identity campaign certification ID + identitySummaryId := `2c91808772a504f50172a9540e501ba8` // string | The identity summary ID # string | The identity summary ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.CertificationSummariesAPI.GetIdentitySummary(context.Background(), id, identitySummaryId).Execute() + //resp, r, err := apiClient.V3.CertificationSummariesAPI.GetIdentitySummary(context.Background(), id, identitySummaryId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `CertificationSummariesAPI.GetIdentitySummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentitySummary`: CertificationIdentitySummary + fmt.Fprintf(os.Stdout, "Response from `CertificationSummariesAPI.GetIdentitySummary`: %v\n", resp) + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/configuration-hub#create-object-mapping + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingrequest := []byte(`{ + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }`) // ObjectMappingRequest | The object mapping request body. + + + var objectMappingRequest v3.ObjectMappingRequest + if err := json.Unmarshal(objectmappingrequest, &objectMappingRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConfigurationHubAPI.CreateObjectMapping(context.Background(), sourceOrg).ObjectMappingRequest(objectMappingRequest).Execute() + //resp, r, err := apiClient.V3.ConfigurationHubAPI.CreateObjectMapping(context.Background(), sourceOrg).ObjectMappingRequest(objectMappingRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateObjectMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateObjectMapping`: ObjectMappingResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateObjectMapping`: %v\n", resp) + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/configuration-hub#create-object-mappings + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingbulkcreaterequest := []byte(`{ + "newObjectsMappings" : [ { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }, { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } ] + }`) // ObjectMappingBulkCreateRequest | The bulk create object mapping request body. + + + var objectMappingBulkCreateRequest v3.ObjectMappingBulkCreateRequest + if err := json.Unmarshal(objectmappingbulkcreaterequest, &objectMappingBulkCreateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConfigurationHubAPI.CreateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkCreateRequest(objectMappingBulkCreateRequest).Execute() + //resp, r, err := apiClient.V3.ConfigurationHubAPI.CreateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkCreateRequest(objectMappingBulkCreateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateObjectMappings`: ObjectMappingBulkCreateResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateObjectMappings`: %v\n", resp) + } +- path: /configuration-hub/backups/uploads + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/configuration-hub#create-uploaded-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + data := BINARY_DATA_HERE // *os.File | JSON file containing the objects to be imported. # *os.File | JSON file containing the objects to be imported. + name := `name_example` // string | Name that will be assigned to the uploaded configuration file. # string | Name that will be assigned to the uploaded configuration file. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConfigurationHubAPI.CreateUploadedConfiguration(context.Background()).Data(data).Name(name).Execute() + //resp, r, err := apiClient.V3.ConfigurationHubAPI.CreateUploadedConfiguration(context.Background()).Data(data).Name(name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.CreateUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateUploadedConfiguration`: BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.CreateUploadedConfiguration`: %v\n", resp) + } +- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/configuration-hub#delete-object-mapping + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectMappingId := `3d6e0144-963f-4bd6-8d8d-d77b4e507ce4` // string | The id of the object mapping to be deleted. # string | The id of the object mapping to be deleted. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ConfigurationHubAPI.DeleteObjectMapping(context.Background(), sourceOrg, objectMappingId).Execute() + //r, err := apiClient.V3.ConfigurationHubAPI.DeleteObjectMapping(context.Background(), sourceOrg, objectMappingId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteObjectMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /configuration-hub/backups/uploads/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/configuration-hub#delete-uploaded-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `3d0fe04b-57df-4a46-a83b-8f04b0f9d10b` // string | The id of the uploaded configuration. # string | The id of the uploaded configuration. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ConfigurationHubAPI.DeleteUploadedConfiguration(context.Background(), id).Execute() + //r, err := apiClient.V3.ConfigurationHubAPI.DeleteUploadedConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.DeleteUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/configuration-hub#get-object-mappings + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConfigurationHubAPI.GetObjectMappings(context.Background(), sourceOrg).Execute() + //resp, r, err := apiClient.V3.ConfigurationHubAPI.GetObjectMappings(context.Background(), sourceOrg).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.GetObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetObjectMappings`: []ObjectMappingResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.GetObjectMappings`: %v\n", resp) + } +- path: /configuration-hub/backups/uploads/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/configuration-hub#get-uploaded-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `3d0fe04b-57df-4a46-a83b-8f04b0f9d10b` // string | The id of the uploaded configuration. # string | The id of the uploaded configuration. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConfigurationHubAPI.GetUploadedConfiguration(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.ConfigurationHubAPI.GetUploadedConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.GetUploadedConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUploadedConfiguration`: BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.GetUploadedConfiguration`: %v\n", resp) + } +- path: /configuration-hub/backups/uploads + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/configuration-hub#list-uploaded-configurations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filters := `status eq "COMPLETE"` // 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: **status**: *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: **status**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConfigurationHubAPI.ListUploadedConfigurations(context.Background()).Execute() + //resp, r, err := apiClient.V3.ConfigurationHubAPI.ListUploadedConfigurations(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.ListUploadedConfigurations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListUploadedConfigurations`: []BackupResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.ListUploadedConfigurations`: %v\n", resp) + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/configuration-hub#update-object-mappings + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceOrg := `source-org` // string | The name of the source org. # string | The name of the source org. + objectmappingbulkpatchrequest := []byte(`{ + "patches" : { + "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : true + } ], + "00bece34-f50d-4227-8878-76f620b5a971" : [ { + "op" : "replace", + "path" : "/targetValue", + "value" : "New Target Value" + } ] + } + }`) // ObjectMappingBulkPatchRequest | The object mapping request body. + + + var objectMappingBulkPatchRequest v3.ObjectMappingBulkPatchRequest + if err := json.Unmarshal(objectmappingbulkpatchrequest, &objectMappingBulkPatchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConfigurationHubAPI.UpdateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkPatchRequest(objectMappingBulkPatchRequest).Execute() + //resp, r, err := apiClient.V3.ConfigurationHubAPI.UpdateObjectMappings(context.Background(), sourceOrg).ObjectMappingBulkPatchRequest(objectMappingBulkPatchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationHubAPI.UpdateObjectMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateObjectMappings`: ObjectMappingBulkPatchResponse + fmt.Fprintf(os.Stdout, "Response from `ConfigurationHubAPI.UpdateObjectMappings`: %v\n", resp) + } +- path: /connectors + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/connectors#create-custom-connector + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + v3createconnectordto := []byte(`{ + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + }`) // V3CreateConnectorDto | + + + var v3CreateConnectorDto v3.V3CreateConnectorDto + if err := json.Unmarshal(v3createconnectordto, &v3CreateConnectorDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.CreateCustomConnector(context.Background()).V3CreateConnectorDto(v3CreateConnectorDto).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.CreateCustomConnector(context.Background()).V3CreateConnectorDto(v3CreateConnectorDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.CreateCustomConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateCustomConnector`: V3ConnectorDto + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.CreateCustomConnector`: %v\n", resp) + } +- path: /connectors/{scriptName} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/connectors#delete-custom-connector + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ConnectorsAPI.DeleteCustomConnector(context.Background(), scriptName).Execute() + //r, err := apiClient.V3.ConnectorsAPI.DeleteCustomConnector(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.DeleteCustomConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /connectors/{scriptName} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/connectors#get-connector + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.GetConnector(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.GetConnector(context.Background(), scriptName).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnector`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnector`: %v\n", resp) + } +- path: /connectors + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/connectors#get-connector-list + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filters := `directConnect eq "true"` // 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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.GetConnectorList(context.Background()).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.GetConnectorList(context.Background()).Filters(filters).Limit(limit).Offset(offset).Count(count).Locale(locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorList`: []V3ConnectorDto + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorList`: %v\n", resp) + } +- path: /connectors/{scriptName}/source-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/connectors#get-connector-source-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.GetConnectorSourceConfig(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.GetConnectorSourceConfig(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorSourceConfig`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorSourceConfig`: %v\n", resp) + } +- path: /connectors/{scriptName}/source-template + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/connectors#get-connector-source-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.GetConnectorSourceTemplate(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.GetConnectorSourceTemplate(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorSourceTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorSourceTemplate`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorSourceTemplate`: %v\n", resp) + } +- path: /connectors/{scriptName}/translations/{locale} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/connectors#get-connector-translations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.GetConnectorTranslations(context.Background(), scriptName, locale).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.GetConnectorTranslations(context.Background(), scriptName, locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.GetConnectorTranslations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConnectorTranslations`: string + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.GetConnectorTranslations`: %v\n", resp) + } +- path: /connectors/{scriptName}/source-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/connectors#put-connector-source-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + file := BINARY_DATA_HERE // *os.File | connector source config xml file # *os.File | connector source config xml file + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.PutConnectorSourceConfig(context.Background(), scriptName).File(file).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.PutConnectorSourceConfig(context.Background(), scriptName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorSourceConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorSourceConfig`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorSourceConfig`: %v\n", resp) + } +- path: /connectors/{scriptName}/source-template + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/connectors#put-connector-source-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + file := BINARY_DATA_HERE // *os.File | connector source template xml file # *os.File | connector source template xml file + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.PutConnectorSourceTemplate(context.Background(), scriptName).File(file).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.PutConnectorSourceTemplate(context.Background(), scriptName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorSourceTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorSourceTemplate`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorSourceTemplate`: %v\n", resp) + } +- path: /connectors/{scriptName}/translations/{locale} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/connectors#put-connector-translations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + locale := `de` // string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # string | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.PutConnectorTranslations(context.Background(), scriptName, locale).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.PutConnectorTranslations(context.Background(), scriptName, locale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.PutConnectorTranslations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutConnectorTranslations`: UpdateDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.PutConnectorTranslations`: %v\n", resp) + } +- path: /connectors/{scriptName} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/connectors#update-connector + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | A list of connector detail update operations + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ConnectorsAPI.UpdateConnector(context.Background(), scriptName).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.ConnectorsAPI.UpdateConnector(context.Background(), scriptName).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ConnectorsAPI.UpdateConnector``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateConnector`: ConnectorDetail + fmt.Fprintf(os.Stdout, "Response from `ConnectorsAPI.UpdateConnector`: %v\n", resp) + } +- path: /auth-org/network-config + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/global-tenant-security-settings#create-auth-org-network-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + networkconfiguration := []byte(`{ + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] + }`) // NetworkConfiguration | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + + + var networkConfiguration v3.NetworkConfiguration + if err := json.Unmarshal(networkconfiguration, &networkConfiguration); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig(context.Background()).NetworkConfiguration(networkConfiguration).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig(context.Background()).NetworkConfiguration(networkConfiguration).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.CreateAuthOrgNetworkConfig`: %v\n", resp) + } +- path: /auth-org/lockout-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgLockoutConfig`: LockoutConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgLockoutConfig`: %v\n", resp) + } +- path: /auth-org/network-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/global-tenant-security-settings#get-auth-org-network-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgNetworkConfig`: %v\n", resp) + } +- path: /auth-org/service-provider-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgServiceProviderConfig`: ServiceProviderConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgServiceProviderConfig`: %v\n", resp) + } +- path: /auth-org/session-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetAuthOrgSessionConfig`: SessionConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.GetAuthOrgSessionConfig`: %v\n", resp) + } +- path: /auth-org/lockout-config + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}]`) // []JsonPatchOperation | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgLockoutConfig`: LockoutConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgLockoutConfig`: %v\n", resp) + } +- path: /auth-org/network-config + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/global-tenant-security-settings#patch-auth-org-network-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/whitelisted, value=false,}, {op=add, path=/geolocation, value=[AF, HN, ES]}]`) // []JsonPatchOperation | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgNetworkConfig`: NetworkConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgNetworkConfig`: %v\n", resp) + } +- path: /auth-org/service-provider-config + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}]`) // []JsonPatchOperation | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgServiceProviderConfig`: ServiceProviderConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgServiceProviderConfig`: %v\n", resp) + } +- path: /auth-org/session-config + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + jsonpatchoperation := []byte(`[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}]`) // []JsonPatchOperation | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig(context.Background()).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchAuthOrgSessionConfig`: SessionConfiguration + fmt.Fprintf(os.Stdout, "Response from `GlobalTenantSecuritySettingsAPI.PatchAuthOrgSessionConfig`: %v\n", resp) + } +- path: /identity-profiles + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/identity-profiles#create-identity-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityprofile := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + }`) // IdentityProfile | + + + var identityProfile v3.IdentityProfile + if err := json.Unmarshal(identityprofile, &identityProfile); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.CreateIdentityProfile(context.Background()).IdentityProfile(identityProfile).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.CreateIdentityProfile(context.Background()).IdentityProfile(identityProfile).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.CreateIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.CreateIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/identity-profiles#delete-identity-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.DeleteIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.DeleteIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.DeleteIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteIdentityProfile`: TaskResultSimplified + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.DeleteIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/identity-profiles#delete-identity-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestbody := []byte(``) // []string | Identity Profile bulk delete request body. + + + var requestBody v3.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.DeleteIdentityProfiles(context.Background()).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.DeleteIdentityProfiles(context.Background()).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.DeleteIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteIdentityProfiles`: TaskResultSimplified + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.DeleteIdentityProfiles`: %v\n", resp) + } +- path: /identity-profiles/export + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/identity-profiles#export-identity-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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, ne* **name**: *eq, ne* **priority**: *eq, ne* (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, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + sorters := `id,name` // 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: **id, name, priority** (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: **id, name, priority** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.ExportIdentityProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.ExportIdentityProfiles(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ExportIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExportIdentityProfiles`: []IdentityProfileExportedObject + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ExportIdentityProfiles`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/identity-profiles#get-default-identity-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | The Identity Profile ID. # string | The Identity Profile ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.GetDefaultIdentityAttributeConfig(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.GetDefaultIdentityAttributeConfig(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GetDefaultIdentityAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDefaultIdentityAttributeConfig`: IdentityAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GetDefaultIdentityAttributeConfig`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/identity-profiles#get-identity-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.GetIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.GetIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.GetIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.GetIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/import + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/identity-profiles#import-identity-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityprofileexportedobject := []byte(``) // []IdentityProfileExportedObject | Previously exported Identity Profiles. + + + var identityProfileExportedObject v3.[]IdentityProfileExportedObject + if err := json.Unmarshal(identityprofileexportedobject, &identityProfileExportedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.ImportIdentityProfiles(context.Background()).IdentityProfileExportedObject(identityProfileExportedObject).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.ImportIdentityProfiles(context.Background()).IdentityProfileExportedObject(identityProfileExportedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ImportIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportIdentityProfiles`: ObjectImportResult + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ImportIdentityProfiles`: %v\n", resp) + } +- path: /identity-profiles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/identity-profiles#list-identity-profiles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "ef38f94347e94562b5bb8424a56397d8"` // 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) + sorters := `id,name` // 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: **id, name, priority, created, modified, owner.id, owner.name** (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: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.ListIdentityProfiles(context.Background()).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.ListIdentityProfiles(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ListIdentityProfiles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListIdentityProfiles`: []IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ListIdentityProfiles`: %v\n", resp) + } +- path: /identity-profiles/identity-preview + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/identity-profiles#show-identity-preview + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identitypreviewrequest := []byte(`{ + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + }`) // IdentityPreviewRequest | Identity Preview request body. + + + var identityPreviewRequest v3.IdentityPreviewRequest + if err := json.Unmarshal(identitypreviewrequest, &identityPreviewRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.ShowIdentityPreview(context.Background()).IdentityPreviewRequest(identityPreviewRequest).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.ShowIdentityPreview(context.Background()).IdentityPreviewRequest(identityPreviewRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.ShowIdentityPreview``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ShowIdentityPreview`: IdentityPreviewResponse + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.ShowIdentityPreview`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/process-identities + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/identity-profiles#sync-identity-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | The Identity Profile ID to be processed # string | The Identity Profile ID to be processed + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.SyncIdentityProfile(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.SyncIdentityProfile(context.Background(), identityProfileId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.SyncIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SyncIdentityProfile`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.SyncIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/identity-profiles#update-identity-profile + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `ef38f94347e94562b5bb8424a56397d8` // string | Identity profile ID. # string | Identity profile ID. + jsonpatchoperation := []byte(`[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]`) // []JsonPatchOperation | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.IdentityProfilesAPI.UpdateIdentityProfile(context.Background(), identityProfileId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.IdentityProfilesAPI.UpdateIdentityProfile(context.Background(), identityProfileId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `IdentityProfilesAPI.UpdateIdentityProfile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateIdentityProfile`: IdentityProfile + fmt.Fprintf(os.Stdout, "Response from `IdentityProfilesAPI.UpdateIdentityProfile`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/lifecycle-states#create-lifecycle-state + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile ID. + lifecyclestate := []byte(`{ + "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], + "emailNotificationOption" : { + "notifyManagers" : true, + "notifySpecificUsers" : true, + "emailAddressList" : [ "test@test.com", "test2@test.com" ], + "notifyAllAdmins" : true + }, + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Lifecycle description", + "accountActions" : [ { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }, { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } ], + "id" : "id12345", + "identityCount" : 42, + "technicalName" : "Technical Name", + "identityState" : "identityState", + "enabled" : true + }`) // LifecycleState | Lifecycle state to be created. + + + var lifecycleState v3.LifecycleState + if err := json.Unmarshal(lifecyclestate, &lifecycleState); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.LifecycleStatesAPI.CreateLifecycleState(context.Background(), identityProfileId).LifecycleState(lifecycleState).Execute() + //resp, r, err := apiClient.V3.LifecycleStatesAPI.CreateLifecycleState(context.Background(), identityProfileId).LifecycleState(lifecycleState).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.CreateLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateLifecycleState`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.CreateLifecycleState`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/lifecycle-states#delete-lifecycle-state + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.LifecycleStatesAPI.DeleteLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + //resp, r, err := apiClient.V3.LifecycleStatesAPI.DeleteLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.DeleteLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteLifecycleState`: LifecyclestateDeleted + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.DeleteLifecycleState`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/lifecycle-states#get-lifecycle-state + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.LifecycleStatesAPI.GetLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + //resp, r, err := apiClient.V3.LifecycleStatesAPI.GetLifecycleState(context.Background(), identityProfileId, lifecycleStateId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.GetLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLifecycleState`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.GetLifecycleState`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/lifecycle-states#get-lifecycle-states + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityProfileId := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | Identity profile ID. # string | Identity profile 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `created,modified` // 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: **created, modified** (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: **created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.LifecycleStatesAPI.GetLifecycleStates(context.Background(), identityProfileId).Execute() + //resp, r, err := apiClient.V3.LifecycleStatesAPI.GetLifecycleStates(context.Background(), identityProfileId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.GetLifecycleStates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetLifecycleStates`: []LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.GetLifecycleStates`: %v\n", resp) + } +- path: /identities/{identity-id}/set-lifecycle-state + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/lifecycle-states#set-lifecycle-state + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identityId := `2c9180857893f1290178944561990364` // string | ID of the identity to update. # string | ID of the identity to update. + setlifecyclestaterequest := []byte(``) // SetLifecycleStateRequest | + + + var setLifecycleStateRequest v3.SetLifecycleStateRequest + if err := json.Unmarshal(setlifecyclestaterequest, &setLifecycleStateRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.LifecycleStatesAPI.SetLifecycleState(context.Background(), identityId).SetLifecycleStateRequest(setLifecycleStateRequest).Execute() + //resp, r, err := apiClient.V3.LifecycleStatesAPI.SetLifecycleState(context.Background(), identityId).SetLifecycleStateRequest(setLifecycleStateRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.SetLifecycleState``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetLifecycleState`: SetLifecycleState200Response + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.SetLifecycleState`: %v\n", resp) + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/lifecycle-states#update-lifecycle-states + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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 + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.LifecycleStatesAPI.UpdateLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.LifecycleStatesAPI.UpdateLifecycleStates(context.Background(), identityProfileId, lifecycleStateId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `LifecycleStatesAPI.UpdateLifecycleStates``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateLifecycleStates`: LifecycleState + fmt.Fprintf(os.Stdout, "Response from `LifecycleStatesAPI.UpdateLifecycleStates`: %v\n", resp) + } +- path: /managed-clients + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/managed-clients#create-managed-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + managedclientrequest := []byte(`{ + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + }`) // ManagedClientRequest | + + + var managedClientRequest v3.ManagedClientRequest + if err := json.Unmarshal(managedclientrequest, &managedClientRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClientsAPI.CreateManagedClient(context.Background()).ManagedClientRequest(managedClientRequest).Execute() + //resp, r, err := apiClient.V3.ManagedClientsAPI.CreateManagedClient(context.Background()).ManagedClientRequest(managedClientRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.CreateManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.CreateManagedClient`: %v\n", resp) + } +- path: /managed-clients/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/managed-clients#delete-managed-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ManagedClientsAPI.DeleteManagedClient(context.Background(), id).Execute() + //r, err := apiClient.V3.ManagedClientsAPI.DeleteManagedClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.DeleteManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /managed-clients/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/managed-clients#get-managed-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClientsAPI.GetManagedClient(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.ManagedClientsAPI.GetManagedClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClient`: %v\n", resp) + } +- path: /managed-clients/{id}/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/managed-clients#get-managed-client-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `aClientId` // string | Managed client ID to get status for. # string | Managed client ID to get status for. + type_ := // ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClientsAPI.GetManagedClientStatus(context.Background(), id).Type_(type_).Execute() + //resp, r, err := apiClient.V3.ManagedClientsAPI.GetManagedClientStatus(context.Background(), id).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClientStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClientStatus`: ManagedClientStatus + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClientStatus`: %v\n", resp) + } +- path: /managed-clients + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/managed-clients#get-managed-clients + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "client name"` // 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* **name**: *eq* **clientId**: *eq* **clusterId**: *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* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClientsAPI.GetManagedClients(context.Background()).Execute() + //resp, r, err := apiClient.V3.ManagedClientsAPI.GetManagedClients(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.GetManagedClients``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClients`: []ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.GetManagedClients`: %v\n", resp) + } +- path: /managed-clients/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/managed-clients#update-managed-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7` // string | Managed client ID. # string | Managed client ID. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | JSONPatch payload used to update the object. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClientsAPI.UpdateManagedClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.ManagedClientsAPI.UpdateManagedClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClientsAPI.UpdateManagedClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedClient`: ManagedClient + fmt.Fprintf(os.Stdout, "Response from `ManagedClientsAPI.UpdateManagedClient`: %v\n", resp) + } +- path: /managed-clusters + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/managed-clusters#create-managed-cluster + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + managedclusterrequest := []byte(`{ + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + }`) // ManagedClusterRequest | + + + var managedClusterRequest v3.ManagedClusterRequest + if err := json.Unmarshal(managedclusterrequest, &managedClusterRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClustersAPI.CreateManagedCluster(context.Background()).ManagedClusterRequest(managedClusterRequest).Execute() + //resp, r, err := apiClient.V3.ManagedClustersAPI.CreateManagedCluster(context.Background()).ManagedClusterRequest(managedClusterRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.CreateManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.CreateManagedCluster`: %v\n", resp) + } +- path: /managed-clusters/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/managed-clusters#delete-managed-cluster + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + removeClients := false // bool | Flag to determine the need to delete a cluster with clients. (optional) (default to false) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ManagedClustersAPI.DeleteManagedCluster(context.Background(), id).Execute() + //r, err := apiClient.V3.ManagedClustersAPI.DeleteManagedCluster(context.Background(), id).RemoveClients(removeClients).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.DeleteManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /managed-clusters/{id}/log-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/managed-clusters#get-client-log-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | ID of managed cluster to get log configuration for. # string | ID of managed cluster to get log configuration for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClustersAPI.GetClientLogConfiguration(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.ManagedClustersAPI.GetClientLogConfiguration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetClientLogConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetClientLogConfiguration`: ClientLogConfiguration + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetClientLogConfiguration`: %v\n", resp) + } +- path: /managed-clusters/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/managed-clusters#get-managed-cluster + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClustersAPI.GetManagedCluster(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.ManagedClustersAPI.GetManagedCluster(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetManagedCluster`: %v\n", resp) + } +- path: /managed-clusters + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/managed-clusters#get-managed-clusters + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `operational eq "operation"` // 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: **operational**: *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: **operational**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClustersAPI.GetManagedClusters(context.Background()).Execute() + //resp, r, err := apiClient.V3.ManagedClustersAPI.GetManagedClusters(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.GetManagedClusters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetManagedClusters`: []ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.GetManagedClusters`: %v\n", resp) + } +- path: /managed-clusters/{id}/log-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/managed-clusters#put-client-log-configuration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2b838de9-db9b-abcf-e646-d4f274ad4238` // string | ID of the managed cluster to update the log configuration for. # string | ID of the managed cluster to update the log configuration for. + putclientlogconfigurationrequest := []byte(``) // PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + + + var putClientLogConfigurationRequest v3.PutClientLogConfigurationRequest + if err := json.Unmarshal(putclientlogconfigurationrequest, &putClientLogConfigurationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClustersAPI.PutClientLogConfiguration(context.Background(), id).PutClientLogConfigurationRequest(putClientLogConfigurationRequest).Execute() + //resp, r, err := apiClient.V3.ManagedClustersAPI.PutClientLogConfiguration(context.Background(), id).PutClientLogConfigurationRequest(putClientLogConfigurationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.PutClientLogConfiguration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutClientLogConfiguration`: ClientLogConfiguration + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.PutClientLogConfiguration`: %v\n", resp) + } +- path: /managed-clusters/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/managed-clusters#update-managed-cluster + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180897de347a2017de8859e8c5039` // string | Managed cluster ID. # string | Managed cluster ID. + jsonpatchoperation := []byte(``) // []JsonPatchOperation | JSONPatch payload used to update the object. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ManagedClustersAPI.UpdateManagedCluster(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.ManagedClustersAPI.UpdateManagedCluster(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ManagedClustersAPI.UpdateManagedCluster``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateManagedCluster`: ManagedCluster + fmt.Fprintf(os.Stdout, "Response from `ManagedClustersAPI.UpdateManagedCluster`: %v\n", resp) + } +- path: /mfa/{method}/delete + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/mfa-configuration#delete-mfa-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + method := `okta-verify` // string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAConfigurationAPI.DeleteMFAConfig(context.Background(), method).Execute() + //resp, r, err := apiClient.V3.MFAConfigurationAPI.DeleteMFAConfig(context.Background(), method).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.DeleteMFAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteMFAConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.DeleteMFAConfig`: %v\n", resp) + } +- path: /mfa/duo-web/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/mfa-configuration#get-mfa-duo-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAConfigurationAPI.GetMFADuoConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.MFAConfigurationAPI.GetMFADuoConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFADuoConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFADuoConfig`: MfaDuoConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFADuoConfig`: %v\n", resp) + } +- path: /mfa/kba/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/mfa-configuration#get-mfa-kba-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + allLanguages := allLanguages=true // bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAConfigurationAPI.GetMFAKbaConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.MFAConfigurationAPI.GetMFAKbaConfig(context.Background()).AllLanguages(allLanguages).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFAKbaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFAKbaConfig`: []KbaQuestion + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFAKbaConfig`: %v\n", resp) + } +- path: /mfa/okta-verify/config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/mfa-configuration#get-mfa-okta-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAConfigurationAPI.GetMFAOktaConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.MFAConfigurationAPI.GetMFAOktaConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.GetMFAOktaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMFAOktaConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.GetMFAOktaConfig`: %v\n", resp) + } +- path: /mfa/duo-web/config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/mfa-configuration#set-mfa-duo-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + mfaduoconfig := []byte(`{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }`) // MfaDuoConfig | + + + var mfaDuoConfig v3.MfaDuoConfig + if err := json.Unmarshal(mfaduoconfig, &mfaDuoConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAConfigurationAPI.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute() + //resp, r, err := apiClient.V3.MFAConfigurationAPI.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFADuoConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFADuoConfig`: MfaDuoConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFADuoConfig`: %v\n", resp) + } +- path: /mfa/kba/config/answers + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/mfa-configuration#set-mfakba-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + kbaanswerrequestitem := []byte(`[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]`) // []KbaAnswerRequestItem | + + + var kbaAnswerRequestItem v3.[]KbaAnswerRequestItem + if err := json.Unmarshal(kbaanswerrequestitem, &kbaAnswerRequestItem); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAConfigurationAPI.SetMFAKBAConfig(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + //resp, r, err := apiClient.V3.MFAConfigurationAPI.SetMFAKBAConfig(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFAKBAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFAKBAConfig`: []KbaAnswerResponseItem + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFAKBAConfig`: %v\n", resp) + } +- path: /mfa/okta-verify/config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/mfa-configuration#set-mfa-okta-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + mfaoktaconfig := []byte(`{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }`) // MfaOktaConfig | + + + var mfaOktaConfig v3.MfaOktaConfig + if err := json.Unmarshal(mfaoktaconfig, &mfaOktaConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAConfigurationAPI.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute() + //resp, r, err := apiClient.V3.MFAConfigurationAPI.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.SetMFAOktaConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetMFAOktaConfig`: MfaOktaConfig + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.SetMFAOktaConfig`: %v\n", resp) + } +- path: /mfa/{method}/test + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/mfa-configuration#test-mfa-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + method := `okta-verify` // string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAConfigurationAPI.TestMFAConfig(context.Background(), method).Execute() + //resp, r, err := apiClient.V3.MFAConfigurationAPI.TestMFAConfig(context.Background(), method).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationAPI.TestMFAConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestMFAConfig`: MfaConfigTestResponse + fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationAPI.TestMFAConfig`: %v\n", resp) + } +- path: /mfa/token/send + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/mfa-controller#create-send-token + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sendtokenrequest := []byte(`{ + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + }`) // SendTokenRequest | + + + var sendTokenRequest v3.SendTokenRequest + if err := json.Unmarshal(sendtokenrequest, &sendTokenRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAControllerAPI.CreateSendToken(context.Background()).SendTokenRequest(sendTokenRequest).Execute() + //resp, r, err := apiClient.V3.MFAControllerAPI.CreateSendToken(context.Background()).SendTokenRequest(sendTokenRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.CreateSendToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSendToken`: SendTokenResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.CreateSendToken`: %v\n", resp) + } +- path: /mfa/{method}/poll + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/mfa-controller#ping-verification-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + method := `okta-verify` // string | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' # string | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + verificationpollrequest := []byte(`{ + "requestId" : "089899f13a8f4da7824996191587bab9" + }`) // VerificationPollRequest | + + + var verificationPollRequest v3.VerificationPollRequest + if err := json.Unmarshal(verificationpollrequest, &verificationPollRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAControllerAPI.PingVerificationStatus(context.Background(), method).VerificationPollRequest(verificationPollRequest).Execute() + //resp, r, err := apiClient.V3.MFAControllerAPI.PingVerificationStatus(context.Background(), method).VerificationPollRequest(verificationPollRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.PingVerificationStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PingVerificationStatus`: VerificationResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.PingVerificationStatus`: %v\n", resp) + } +- path: /mfa/duo-web/verify + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/mfa-controller#send-duo-verify-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + duoverificationrequest := []byte(`{ + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + }`) // DuoVerificationRequest | + + + var duoVerificationRequest v3.DuoVerificationRequest + if err := json.Unmarshal(duoverificationrequest, &duoVerificationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAControllerAPI.SendDuoVerifyRequest(context.Background()).DuoVerificationRequest(duoVerificationRequest).Execute() + //resp, r, err := apiClient.V3.MFAControllerAPI.SendDuoVerifyRequest(context.Background()).DuoVerificationRequest(duoVerificationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.SendDuoVerifyRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendDuoVerifyRequest`: VerificationResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.SendDuoVerifyRequest`: %v\n", resp) + } +- path: /mfa/kba/authenticate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/mfa-controller#send-kba-answers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + kbaanswerrequestitem := []byte(`[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]`) // []KbaAnswerRequestItem | + + + var kbaAnswerRequestItem v3.[]KbaAnswerRequestItem + if err := json.Unmarshal(kbaanswerrequestitem, &kbaAnswerRequestItem); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAControllerAPI.SendKbaAnswers(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + //resp, r, err := apiClient.V3.MFAControllerAPI.SendKbaAnswers(context.Background()).KbaAnswerRequestItem(kbaAnswerRequestItem).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.SendKbaAnswers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendKbaAnswers`: KbaAuthResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.SendKbaAnswers`: %v\n", resp) + } +- path: /mfa/okta-verify/verify + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/mfa-controller#send-okta-verify-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + oktaverificationrequest := []byte(`{ + "userId" : "example@mail.com" + }`) // OktaVerificationRequest | + + + var oktaVerificationRequest v3.OktaVerificationRequest + if err := json.Unmarshal(oktaverificationrequest, &oktaVerificationRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAControllerAPI.SendOktaVerifyRequest(context.Background()).OktaVerificationRequest(oktaVerificationRequest).Execute() + //resp, r, err := apiClient.V3.MFAControllerAPI.SendOktaVerifyRequest(context.Background()).OktaVerificationRequest(oktaVerificationRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.SendOktaVerifyRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendOktaVerifyRequest`: VerificationResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.SendOktaVerifyRequest`: %v\n", resp) + } +- path: /mfa/token/authenticate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/mfa-controller#send-token-auth-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + tokenauthrequest := []byte(`{ + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + }`) // TokenAuthRequest | + + + var tokenAuthRequest v3.TokenAuthRequest + if err := json.Unmarshal(tokenauthrequest, &tokenAuthRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.MFAControllerAPI.SendTokenAuthRequest(context.Background()).TokenAuthRequest(tokenAuthRequest).Execute() + //resp, r, err := apiClient.V3.MFAControllerAPI.SendTokenAuthRequest(context.Background()).TokenAuthRequest(tokenAuthRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `MFAControllerAPI.SendTokenAuthRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SendTokenAuthRequest`: TokenAuthResponse + fmt.Fprintf(os.Stdout, "Response from `MFAControllerAPI.SendTokenAuthRequest`: %v\n", resp) + } +- path: /non-employee-approvals/{id}/approve + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + nonemployeeapprovaldecision := []byte(`{ + "comment" : "Approved by manager" + }`) // NonEmployeeApprovalDecision | + + + var nonEmployeeApprovalDecision v3.NonEmployeeApprovalDecision + if err := json.Unmarshal(nonemployeeapprovaldecision, &nonEmployeeApprovalDecision); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest(context.Background(), id).NonEmployeeApprovalDecision(nonEmployeeApprovalDecision).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest(context.Background(), id).NonEmployeeApprovalDecision(nonEmployeeApprovalDecision).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveNonEmployeeRequest`: NonEmployeeApprovalItem + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ApproveNonEmployeeRequest`: %v\n", resp) + } +- path: /non-employee-records + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-Employee record creation request body. + + + var nonEmployeeRequestBody v3.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRecord`: %v\n", resp) + } +- path: /non-employee-requests + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-Employee creation request body + + + var nonEmployeeRequestBody v3.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest(context.Background()).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeRequest`: NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeRequest`: %v\n", resp) + } +- path: /non-employee-sources + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + nonemployeesourcerequestbody := []byte(`{ + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + }`) // NonEmployeeSourceRequestBody | Non-Employee source creation request body. + + + var nonEmployeeSourceRequestBody v3.NonEmployeeSourceRequestBody + if err := json.Unmarshal(nonemployeesourcerequestbody, &nonEmployeeSourceRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource(context.Background()).NonEmployeeSourceRequestBody(nonEmployeeSourceRequestBody).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource(context.Background()).NonEmployeeSourceRequestBody(nonEmployeeSourceRequestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeSource`: NonEmployeeSourceWithCloudExternalId + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSource`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + nonemployeeschemaattributebody := []byte(`{ + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + }`) // NonEmployeeSchemaAttributeBody | + + + var nonEmployeeSchemaAttributeBody v3.NonEmployeeSchemaAttributeBody + if err := json.Unmarshal(nonemployeeschemaattributebody, &nonEmployeeSchemaAttributeBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).NonEmployeeSchemaAttributeBody(nonEmployeeSchemaAttributeBody).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).NonEmployeeSchemaAttributeBody(nonEmployeeSchemaAttributeBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateNonEmployeeSourceSchemaAttributes`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.CreateNonEmployeeSourceSchemaAttributes`: %v\n", resp) + } +- path: /non-employee-records/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-Employee record id (UUID) # string | Non-Employee record id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord(context.Background(), id).Execute() + //r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-records/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + deletenonemployeerecordsinbulkrequest := []byte(``) // DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. + + + var deleteNonEmployeeRecordsInBulkRequest v3.DeleteNonEmployeeRecordsInBulkRequest + if err := json.Unmarshal(deletenonemployeerecordsinbulkrequest, &deleteNonEmployeeRecordsInBulkRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk(context.Background()).DeleteNonEmployeeRecordsInBulkRequest(deleteNonEmployeeRecordsInBulkRequest).Execute() + //r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk(context.Background()).DeleteNonEmployeeRecordsInBulkRequest(deleteNonEmployeeRecordsInBulkRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRecordsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-requests/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ac110005-7156-1150-8171-5b292e3e0084` // string | Non-Employee request id in the UUID format # string | Non-Employee request id in the UUID format + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest(context.Background(), id).Execute() + //r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + //r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-sources/{sourceId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id # string | Source Id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource(context.Background(), sourceId).Execute() + //r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + //r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.DeleteNonEmployeeSourceSchemaAttributes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /non-employee-sources/{id}/non-employees/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id (UUID) # string | Source Id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ExportNonEmployeeRecords(context.Background(), id).Execute() + //r, err := apiClient.V3.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) + } + } +- path: /non-employee-sources/{id}/schema-attributes-template/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Source Id (UUID) # string | Source Id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ExportNonEmployeeSourceSchemaTemplate(context.Background(), id).Execute() + //r, err := apiClient.V3.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) + } + } +- path: /non-employee-approvals/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + includeDetail := true // bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval(context.Background(), id).IncludeDetail(includeDetail).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeApproval`: NonEmployeeApprovalItemDetail + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApproval`: %v\n", resp) + } +- path: /non-employee-approvals/summary/{requested-for} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary(context.Background(), requestedFor).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary(context.Background(), requestedFor).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeApprovalSummary`: NonEmployeeApprovalSummary + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeApprovalSummary`: %v\n", resp) + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Source ID (UUID) # string | Source ID (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeBulkUploadStatus`: NonEmployeeBulkUploadStatus + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeBulkUploadStatus`: %v\n", resp) + } +- path: /non-employee-records/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-Employee record id (UUID) # string | Non-Employee record id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRecord`: %v\n", resp) + } +- path: /non-employee-requests/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ac110005-7156-1150-8171-5b292e3e0084` // string | Non-Employee request id (UUID) # string | Non-Employee request id (UUID) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRequest`: NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequest`: %v\n", resp) + } +- path: /non-employee-requests/summary/{requested-for} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary(context.Background(), requestedFor).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary(context.Background(), requestedFor).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeRequestSummary`: NonEmployeeRequestSummary + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeRequestSummary`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeSchemaAttribute`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSchemaAttribute`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c91808b7c28b350017c2a2ec5790aa1` // string | Source Id # string | Source Id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNonEmployeeSource`: NonEmployeeSource + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSource`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes(context.Background(), sourceId).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) + } + // response from `GetNonEmployeeSourceSchemaAttributes`: []NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.GetNonEmployeeSourceSchemaAttributes`: %v\n", resp) + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id (UUID) # string | Source Id (UUID) + data := BINARY_DATA_HERE // *os.File | # *os.File | + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk(context.Background(), id).Data(data).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk(context.Background(), id).Data(data).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportNonEmployeeRecordsInBulk`: NonEmployeeBulkUploadJob + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ImportNonEmployeeRecordsInBulk`: %v\n", resp) + } +- path: /non-employee-approvals + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#list-non-employee-approvals + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `2c91808280430dfb0180431a59440460` // string | The identity for whom the request was made. *me* indicates the current user. (optional) # string | The identity for whom the request was made. *me* indicates the current user. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `approvalStatus eq "Pending"` // 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: **approvalStatus**: *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: **approvalStatus**: *eq* (optional) + sorters := `created` // 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: **created, modified** (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: **created, modified** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals(context.Background()).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals(context.Background()).RequestedFor(requestedFor).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeApprovals`: []NonEmployeeApprovalItem + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeApprovals`: %v\n", resp) + } +- path: /non-employee-records + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#list-non-employee-records + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `accountName,sourceId` // 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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + filters := `sourceId eq "2c91808568c529c60168cca6f90c1313"` // 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: **sourceId**: *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: **sourceId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords(context.Background()).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords(context.Background()).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeRecords`: []NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRecords`: %v\n", resp) + } +- path: /non-employee-requests + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + requestedFor := `e136567de87e4d029e60b3c3c55db56d` // string | The identity for whom the request was made. *me* indicates the current user. # string | The identity for whom the request was made. *me* indicates the current user. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `created,approvalStatus` // 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + filters := `sourceId eq "2c91808568c529c60168cca6f90c1313"` // 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: **sourceId**: *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: **sourceId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests(context.Background()).RequestedFor(requestedFor).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests(context.Background()).RequestedFor(requestedFor).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeRequests`: []NonEmployeeRequest + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeRequests`: %v\n", resp) + } +- path: /non-employee-sources + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#list-non-employee-sources + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + requestedFor := `me` // string | Identity the request was made for. Use 'me' to indicate the current user. (optional) # string | Identity the request was made for. Use 'me' to indicate the current user. (optional) + nonEmployeeCount := true // bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) + sorters := `name,created` // 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, created, sourceId** (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, created, sourceId** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources(context.Background()).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources(context.Background()).Limit(limit).Offset(offset).Count(count).RequestedFor(requestedFor).NonEmployeeCount(nonEmployeeCount).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListNonEmployeeSources`: []NonEmployeeSourceWithNECount + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.ListNonEmployeeSources`: %v\n", resp) + } +- path: /non-employee-records/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-employee record id (UUID) # string | Non-employee record id (UUID) + jsonpatchoperation := []byte(`[{op=replace, path=/endDate, value=2019-08-23T18:40:35.772Z}]`) // []JsonPatchOperation | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeRecord`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + attributeId := `ef38f94347e94562b5bb8424a56397d8` // string | The Schema Attribute Id (UUID) # string | The Schema Attribute Id (UUID) + sourceId := `ef38f94347e94562b5bb8424a56397d8` // string | The Source id # string | The Source id + jsonpatchoperation := []byte(`[{op=replace, path=/label, value={new attribute label=null}}]`) // []JsonPatchOperation | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute(context.Background(), attributeId, sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeSchemaAttribute`: NonEmployeeSchemaAttribute + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSchemaAttribute`: %v\n", resp) + } +- path: /non-employee-sources/{sourceId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `e136567de87e4d029e60b3c3c55db56d` // string | Source Id # string | Source Id + jsonpatchoperation := []byte(`[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}]`) // []JsonPatchOperation | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource(context.Background(), sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource(context.Background(), sourceId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchNonEmployeeSource`: NonEmployeeSource + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.PatchNonEmployeeSource`: %v\n", resp) + } +- path: /non-employee-approvals/{id}/reject + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `e136567de87e4d029e60b3c3c55db56d` // string | Non-Employee approval item id (UUID) # string | Non-Employee approval item id (UUID) + nonemployeerejectapprovaldecision := []byte(`{ + "comment" : "approved" + }`) // NonEmployeeRejectApprovalDecision | + + + var nonEmployeeRejectApprovalDecision v3.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.V3.NonEmployeeLifecycleManagementAPI.RejectNonEmployeeRequest(context.Background(), id).NonEmployeeRejectApprovalDecision(nonEmployeeRejectApprovalDecision).Execute() + //resp, r, err := apiClient.V3.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) + } +- path: /non-employee-records/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + "time" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | Non-employee record id (UUID) # string | Non-employee record id (UUID) + nonemployeerequestbody := []byte(`{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }`) // NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + + var nonEmployeeRequestBody v3.NonEmployeeRequestBody + if err := json.Unmarshal(nonemployeerequestbody, &nonEmployeeRequestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord(context.Background(), id).NonEmployeeRequestBody(nonEmployeeRequestBody).Execute() + //resp, r, err := apiClient.V3.NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord(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, "Full HTTP response: %v\n", r) + } + // response from `UpdateNonEmployeeRecord`: NonEmployeeRecord + fmt.Fprintf(os.Stdout, "Response from `NonEmployeeLifecycleManagementAPI.UpdateNonEmployeeRecord`: %v\n", resp) + } +- path: /oauth-clients + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/o-auth-clients#create-oauth-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + createoauthclientrequest := []byte(`{ + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + }`) // CreateOAuthClientRequest | + + + var createOAuthClientRequest v3.CreateOAuthClientRequest + if err := json.Unmarshal(createoauthclientrequest, &createOAuthClientRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.OAuthClientsAPI.CreateOauthClient(context.Background()).CreateOAuthClientRequest(createOAuthClientRequest).Execute() + //resp, r, err := apiClient.V3.OAuthClientsAPI.CreateOauthClient(context.Background()).CreateOAuthClientRequest(createOAuthClientRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.CreateOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateOauthClient`: CreateOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.CreateOauthClient`: %v\n", resp) + } +- path: /oauth-clients/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/o-auth-clients#delete-oauth-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.OAuthClientsAPI.DeleteOauthClient(context.Background(), id).Execute() + //r, err := apiClient.V3.OAuthClientsAPI.DeleteOauthClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.DeleteOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /oauth-clients/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/o-auth-clients#get-oauth-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.OAuthClientsAPI.GetOauthClient(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.OAuthClientsAPI.GetOauthClient(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.GetOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOauthClient`: GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.GetOauthClient`: %v\n", resp) + } +- path: /oauth-clients + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/o-auth-clients#list-oauth-clients + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + filters := `lastUsed le 2023-02-05T10:59:27.214Z` // 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.OAuthClientsAPI.ListOauthClients(context.Background()).Execute() + //resp, r, err := apiClient.V3.OAuthClientsAPI.ListOauthClients(context.Background()).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.ListOauthClients``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListOauthClients`: []GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.ListOauthClients`: %v\n", resp) + } +- path: /oauth-clients/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/o-auth-clients#patch-oauth-client + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The OAuth client id # string | The OAuth client id + jsonpatchoperation := []byte(`[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}]`) // []JsonPatchOperation | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.OAuthClientsAPI.PatchOauthClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.OAuthClientsAPI.PatchOauthClient(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `OAuthClientsAPI.PatchOauthClient``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchOauthClient`: GetOAuthClientResponse + fmt.Fprintf(os.Stdout, "Response from `OAuthClientsAPI.PatchOauthClient`: %v\n", resp) + } +- path: /password-org-config + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-configuration#create-password-org-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordorgconfig := []byte(`{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }`) // PasswordOrgConfig | + + + var passwordOrgConfig v3.PasswordOrgConfig + if err := json.Unmarshal(passwordorgconfig, &passwordOrgConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordConfigurationAPI.CreatePasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + //resp, r, err := apiClient.V3.PasswordConfigurationAPI.CreatePasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.CreatePasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.CreatePasswordOrgConfig`: %v\n", resp) + } +- path: /password-org-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-configuration#get-password-org-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordConfigurationAPI.GetPasswordOrgConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.PasswordConfigurationAPI.GetPasswordOrgConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.GetPasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.GetPasswordOrgConfig`: %v\n", resp) + } +- path: /password-org-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-configuration#put-password-org-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordorgconfig := []byte(`{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }`) // PasswordOrgConfig | + + + var passwordOrgConfig v3.PasswordOrgConfig + if err := json.Unmarshal(passwordorgconfig, &passwordOrgConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordConfigurationAPI.PutPasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + //resp, r, err := apiClient.V3.PasswordConfigurationAPI.PutPasswordOrgConfig(context.Background()).PasswordOrgConfig(passwordOrgConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordConfigurationAPI.PutPasswordOrgConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutPasswordOrgConfig`: PasswordOrgConfig + fmt.Fprintf(os.Stdout, "Response from `PasswordConfigurationAPI.PutPasswordOrgConfig`: %v\n", resp) + } +- path: /password-dictionary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-dictionary#get-password-dictionary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordDictionaryAPI.GetPasswordDictionary(context.Background()).Execute() + //resp, r, err := apiClient.V3.PasswordDictionaryAPI.GetPasswordDictionary(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordDictionaryAPI.GetPasswordDictionary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordDictionary`: string + fmt.Fprintf(os.Stdout, "Response from `PasswordDictionaryAPI.GetPasswordDictionary`: %v\n", resp) + } +- path: /password-dictionary + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-dictionary#put-password-dictionary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.PasswordDictionaryAPI.PutPasswordDictionary(context.Background()).Execute() + //r, err := apiClient.V3.PasswordDictionaryAPI.PutPasswordDictionary(context.Background()).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordDictionaryAPI.PutPasswordDictionary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /password-change-status/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-management#get-password-change-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `089899f13a8f4da7824996191587bab9` // string | Password change request ID # string | Password change request ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordManagementAPI.GetPasswordChangeStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.PasswordManagementAPI.GetPasswordChangeStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.GetPasswordChangeStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordChangeStatus`: PasswordStatus + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.GetPasswordChangeStatus`: %v\n", resp) + } +- path: /query-password-info + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-management#query-password-info + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordinfoquerydto := []byte(`{ + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + }`) // PasswordInfoQueryDTO | + + + var passwordInfoQueryDTO v3.PasswordInfoQueryDTO + if err := json.Unmarshal(passwordinfoquerydto, &passwordInfoQueryDTO); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordManagementAPI.QueryPasswordInfo(context.Background()).PasswordInfoQueryDTO(passwordInfoQueryDTO).Execute() + //resp, r, err := apiClient.V3.PasswordManagementAPI.QueryPasswordInfo(context.Background()).PasswordInfoQueryDTO(passwordInfoQueryDTO).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.QueryPasswordInfo``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `QueryPasswordInfo`: PasswordInfo + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.QueryPasswordInfo`: %v\n", resp) + } +- path: /set-password + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-management#set-password + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordchangerequest := []byte(`{ + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + }`) // PasswordChangeRequest | + + + var passwordChangeRequest v3.PasswordChangeRequest + if err := json.Unmarshal(passwordchangerequest, &passwordChangeRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordManagementAPI.SetPassword(context.Background()).PasswordChangeRequest(passwordChangeRequest).Execute() + //resp, r, err := apiClient.V3.PasswordManagementAPI.SetPassword(context.Background()).PasswordChangeRequest(passwordChangeRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordManagementAPI.SetPassword``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetPassword`: PasswordChangeResponse + fmt.Fprintf(os.Stdout, "Response from `PasswordManagementAPI.SetPassword`: %v\n", resp) + } +- path: /password-policies + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-policies#create-password-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordpolicyv3dto := []byte(`{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }`) // PasswordPolicyV3Dto | + + + var passwordPolicyV3Dto v3.PasswordPolicyV3Dto + if err := json.Unmarshal(passwordpolicyv3dto, &passwordPolicyV3Dto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordPoliciesAPI.CreatePasswordPolicy(context.Background()).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + //resp, r, err := apiClient.V3.PasswordPoliciesAPI.CreatePasswordPolicy(context.Background()).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.CreatePasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordPolicy`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.CreatePasswordPolicy`: %v\n", resp) + } +- path: /password-policies/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-policies#delete-password-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ff808081838d9e9d01838da6a03e0002` // string | The ID of password policy to delete. # string | The ID of password policy to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.PasswordPoliciesAPI.DeletePasswordPolicy(context.Background(), id).Execute() + //r, err := apiClient.V3.PasswordPoliciesAPI.DeletePasswordPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.DeletePasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /password-policies/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-policies#get-password-policy-by-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ff808081838d9e9d01838da6a03e0005` // string | The ID of password policy to retrieve. # string | The ID of password policy to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordPoliciesAPI.GetPasswordPolicyById(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.PasswordPoliciesAPI.GetPasswordPolicyById(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.GetPasswordPolicyById``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordPolicyById`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.GetPasswordPolicyById`: %v\n", resp) + } +- path: /password-policies + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-policies#list-password-policies + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordPoliciesAPI.ListPasswordPolicies(context.Background()).Execute() + //resp, r, err := apiClient.V3.PasswordPoliciesAPI.ListPasswordPolicies(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.ListPasswordPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPasswordPolicies`: []PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.ListPasswordPolicies`: %v\n", resp) + } +- path: /password-policies/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-policies#set-password-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ff808081838d9e9d01838da6a03e0007` // string | The ID of password policy to update. # string | The ID of password policy to update. + passwordpolicyv3dto := []byte(`{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }`) // PasswordPolicyV3Dto | + + + var passwordPolicyV3Dto v3.PasswordPolicyV3Dto + if err := json.Unmarshal(passwordpolicyv3dto, &passwordPolicyV3Dto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordPoliciesAPI.SetPasswordPolicy(context.Background(), id).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + //resp, r, err := apiClient.V3.PasswordPoliciesAPI.SetPasswordPolicy(context.Background(), id).PasswordPolicyV3Dto(passwordPolicyV3Dto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordPoliciesAPI.SetPasswordPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetPasswordPolicy`: PasswordPolicyV3Dto + fmt.Fprintf(os.Stdout, "Response from `PasswordPoliciesAPI.SetPasswordPolicy`: %v\n", resp) + } +- path: /password-sync-groups + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-sync-groups#create-password-sync-group + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + passwordsyncgroup := []byte(`{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }`) // PasswordSyncGroup | + + + var passwordSyncGroup v3.PasswordSyncGroup + if err := json.Unmarshal(passwordsyncgroup, &passwordSyncGroup); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordSyncGroupsAPI.CreatePasswordSyncGroup(context.Background()).PasswordSyncGroup(passwordSyncGroup).Execute() + //resp, r, err := apiClient.V3.PasswordSyncGroupsAPI.CreatePasswordSyncGroup(context.Background()).PasswordSyncGroup(passwordSyncGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.CreatePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.CreatePasswordSyncGroup`: %v\n", resp) + } +- path: /password-sync-groups/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-sync-groups#delete-password-sync-group + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to delete. # string | The ID of password sync group to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.PasswordSyncGroupsAPI.DeletePasswordSyncGroup(context.Background(), id).Execute() + //r, err := apiClient.V3.PasswordSyncGroupsAPI.DeletePasswordSyncGroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.DeletePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /password-sync-groups/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-sync-groups#get-password-sync-group + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to retrieve. # string | The ID of password sync group to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordSyncGroupsAPI.GetPasswordSyncGroup(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.PasswordSyncGroupsAPI.GetPasswordSyncGroup(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.GetPasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.GetPasswordSyncGroup`: %v\n", resp) + } +- path: /password-sync-groups + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-sync-groups#get-password-sync-groups + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordSyncGroupsAPI.GetPasswordSyncGroups(context.Background()).Execute() + //resp, r, err := apiClient.V3.PasswordSyncGroupsAPI.GetPasswordSyncGroups(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.GetPasswordSyncGroups``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPasswordSyncGroups`: []PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.GetPasswordSyncGroups`: %v\n", resp) + } +- path: /password-sync-groups/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/password-sync-groups#update-password-sync-group + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `6881f631-3bd5-4213-9c75-8e05cc3e35dd` // string | The ID of password sync group to update. # string | The ID of password sync group to update. + passwordsyncgroup := []byte(`{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }`) // PasswordSyncGroup | + + + var passwordSyncGroup v3.PasswordSyncGroup + if err := json.Unmarshal(passwordsyncgroup, &passwordSyncGroup); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PasswordSyncGroupsAPI.UpdatePasswordSyncGroup(context.Background(), id).PasswordSyncGroup(passwordSyncGroup).Execute() + //resp, r, err := apiClient.V3.PasswordSyncGroupsAPI.UpdatePasswordSyncGroup(context.Background(), id).PasswordSyncGroup(passwordSyncGroup).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PasswordSyncGroupsAPI.UpdatePasswordSyncGroup``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePasswordSyncGroup`: PasswordSyncGroup + fmt.Fprintf(os.Stdout, "Response from `PasswordSyncGroupsAPI.UpdatePasswordSyncGroup`: %v\n", resp) + } +- path: /personal-access-tokens + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/personal-access-tokens#create-personal-access-token + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + createpersonalaccesstokenrequest := []byte(`{ + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + }`) // CreatePersonalAccessTokenRequest | Name and scope of personal access token. + + + var createPersonalAccessTokenRequest v3.CreatePersonalAccessTokenRequest + if err := json.Unmarshal(createpersonalaccesstokenrequest, &createPersonalAccessTokenRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PersonalAccessTokensAPI.CreatePersonalAccessToken(context.Background()).CreatePersonalAccessTokenRequest(createPersonalAccessTokenRequest).Execute() + //resp, r, err := apiClient.V3.PersonalAccessTokensAPI.CreatePersonalAccessToken(context.Background()).CreatePersonalAccessTokenRequest(createPersonalAccessTokenRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.CreatePersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreatePersonalAccessToken`: CreatePersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.CreatePersonalAccessToken`: %v\n", resp) + } +- path: /personal-access-tokens/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/personal-access-tokens#delete-personal-access-token + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The personal access token id # string | The personal access token id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.PersonalAccessTokensAPI.DeletePersonalAccessToken(context.Background(), id).Execute() + //r, err := apiClient.V3.PersonalAccessTokensAPI.DeletePersonalAccessToken(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.DeletePersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /personal-access-tokens + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/personal-access-tokens#list-personal-access-tokens + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `2c9180867b50d088017b554662fb281e` // string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) # string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + filters := `lastUsed le 2023-02-05T10:59:27.214Z` // 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PersonalAccessTokensAPI.ListPersonalAccessTokens(context.Background()).Execute() + //resp, r, err := apiClient.V3.PersonalAccessTokensAPI.ListPersonalAccessTokens(context.Background()).OwnerId(ownerId).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.ListPersonalAccessTokens``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListPersonalAccessTokens`: []GetPersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.ListPersonalAccessTokens`: %v\n", resp) + } +- path: /personal-access-tokens/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/personal-access-tokens#patch-personal-access-token + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The Personal Access Token id # string | The Personal Access Token id + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}]`) // []JsonPatchOperation | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PersonalAccessTokensAPI.PatchPersonalAccessToken(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.PersonalAccessTokensAPI.PatchPersonalAccessToken(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PersonalAccessTokensAPI.PatchPersonalAccessToken``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchPersonalAccessToken`: GetPersonalAccessTokenResponse + fmt.Fprintf(os.Stdout, "Response from `PersonalAccessTokensAPI.PatchPersonalAccessToken`: %v\n", resp) + } +- path: /public-identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/public-identities#get-public-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `firstname eq "John"` // 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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) + addCoreFilters := false // bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to false) # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to false) + sorters := `name` // 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** (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** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PublicIdentitiesAPI.GetPublicIdentities(context.Background()).Execute() + //resp, r, err := apiClient.V3.PublicIdentitiesAPI.GetPublicIdentities(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).AddCoreFilters(addCoreFilters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesAPI.GetPublicIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPublicIdentities`: []PublicIdentity + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesAPI.GetPublicIdentities`: %v\n", resp) + } +- path: /public-identities-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/public-identities-config#get-public-identity-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PublicIdentitiesConfigAPI.GetPublicIdentityConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.PublicIdentitiesConfigAPI.GetPublicIdentityConfig(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesConfigAPI.GetPublicIdentityConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetPublicIdentityConfig`: PublicIdentityConfig + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesConfigAPI.GetPublicIdentityConfig`: %v\n", resp) + } +- path: /public-identities-config + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/public-identities-config#update-public-identity-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + publicidentityconfig := []byte(`{ + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }`) // PublicIdentityConfig | + + + var publicIdentityConfig v3.PublicIdentityConfig + if err := json.Unmarshal(publicidentityconfig, &publicIdentityConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig(context.Background()).PublicIdentityConfig(publicIdentityConfig).Execute() + //resp, r, err := apiClient.V3.PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig(context.Background()).PublicIdentityConfig(publicIdentityConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdatePublicIdentityConfig`: PublicIdentityConfig + fmt.Fprintf(os.Stdout, "Response from `PublicIdentitiesConfigAPI.UpdatePublicIdentityConfig`: %v\n", resp) + } +- path: /reports/{id}/cancel + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/reports-data-extraction#cancel-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `a1ed223247144cc29d23c632624b4767` // string | ID of the running Report to cancel # string | ID of the running Report to cancel + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ReportsDataExtractionAPI.CancelReport(context.Background(), id).Execute() + //r, err := apiClient.V3.ReportsDataExtractionAPI.CancelReport(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.CancelReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /reports/{taskResultId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/reports-data-extraction#get-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + taskResultId := `ef38f94347e94562b5bb8424a56397d8` // string | Unique identifier of the task result which handled report # string | Unique identifier of the task result which handled report + fileFormat := `csv` // string | Output format of the requested report file # string | Output format of the requested report file + name := `Identities Details Report` // string | preferred Report file name, by default will be used report name from task result. (optional) # string | preferred Report file name, by default will be used report name from task result. (optional) + auditable := true // bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to false) # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ReportsDataExtractionAPI.GetReport(context.Background(), taskResultId).FileFormat(fileFormat).Execute() + //resp, r, err := apiClient.V3.ReportsDataExtractionAPI.GetReport(context.Background(), taskResultId).FileFormat(fileFormat).Name(name).Auditable(auditable).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.GetReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.GetReport`: %v\n", resp) + } +- path: /reports/{taskResultId}/result + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/reports-data-extraction#get-report-result + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + taskResultId := `ef38f94347e94562b5bb8424a56397d8` // string | Unique identifier of the task result which handled report # string | Unique identifier of the task result which handled report + completed := true // bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to false) # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ReportsDataExtractionAPI.GetReportResult(context.Background(), taskResultId).Execute() + //resp, r, err := apiClient.V3.ReportsDataExtractionAPI.GetReportResult(context.Background(), taskResultId).Completed(completed).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.GetReportResult``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReportResult`: ReportResults + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.GetReportResult`: %v\n", resp) + } +- path: /reports/run + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/reports-data-extraction#start-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reportdetails := []byte(`{ + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + }`) // ReportDetails | + + + var reportDetails v3.ReportDetails + if err := json.Unmarshal(reportdetails, &reportDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ReportsDataExtractionAPI.StartReport(context.Background()).ReportDetails(reportDetails).Execute() + //resp, r, err := apiClient.V3.ReportsDataExtractionAPI.StartReport(context.Background()).ReportDetails(reportDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ReportsDataExtractionAPI.StartReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartReport`: TaskResultDetails + fmt.Fprintf(os.Stdout, "Response from `ReportsDataExtractionAPI.StartReport`: %v\n", resp) + } +- path: /requestable-objects + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/requestable-objects#list-requestable-objects + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + 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) + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw "bob"` // 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, in, sw* (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, in, sw* (optional) + sorters := `name` // 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** (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** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.RequestableObjectsAPI.ListRequestableObjects(context.Background()).Execute() + //resp, r, err := apiClient.V3.RequestableObjectsAPI.ListRequestableObjects(context.Background()).IdentityId(identityId).Types(types).Term(term).Statuses(statuses).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RequestableObjectsAPI.ListRequestableObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListRequestableObjects`: []RequestableObject + fmt.Fprintf(os.Stdout, "Response from `RequestableObjectsAPI.ListRequestableObjects`: %v\n", resp) + } +- path: /roles + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/roles#create-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + role := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "reauthorizationRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + }`) // Role | + + + var role v3.Role + if err := json.Unmarshal(role, &role); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.RolesAPI.CreateRole(context.Background()).Role(role).Execute() + //resp, r, err := apiClient.V3.RolesAPI.CreateRole(context.Background()).Role(role).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.CreateRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.CreateRole`: %v\n", resp) + } +- path: /roles/bulk-delete + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/roles#delete-bulk-roles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + rolebulkdeleterequest := []byte(`{ + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + }`) // RoleBulkDeleteRequest | + + + var roleBulkDeleteRequest v3.RoleBulkDeleteRequest + if err := json.Unmarshal(rolebulkdeleterequest, &roleBulkDeleteRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.RolesAPI.DeleteBulkRoles(context.Background()).RoleBulkDeleteRequest(roleBulkDeleteRequest).Execute() + //resp, r, err := apiClient.V3.RolesAPI.DeleteBulkRoles(context.Background()).RoleBulkDeleteRequest(roleBulkDeleteRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteBulkRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteBulkRoles`: TaskResultDto + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.DeleteBulkRoles`: %v\n", resp) + } +- path: /roles/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/roles#delete-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | Role ID. # string | Role ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.RolesAPI.DeleteRole(context.Background(), id).Execute() + //r, err := apiClient.V3.RolesAPI.DeleteRole(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.DeleteRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /roles/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/roles#get-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | Role ID. # string | Role ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.RolesAPI.GetRole(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.RolesAPI.GetRole(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRole`: %v\n", resp) + } +- path: /roles/{id}/assigned-identities + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/roles#get-role-assigned-identities + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | ID of the Role for which the assigned Identities are to be listed # string | ID of the Role for which the assigned Identities are to be listed + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name sw Joe` // 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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + sorters := `aliasName,name` // 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: **id, name, aliasName, email** (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: **id, name, aliasName, email** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.RolesAPI.GetRoleAssignedIdentities(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.RolesAPI.GetRoleAssignedIdentities(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.GetRoleAssignedIdentities``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRoleAssignedIdentities`: []RoleIdentity + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.GetRoleAssignedIdentities`: %v\n", resp) + } +- path: /roles + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/roles#list-roles + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + forSubadmin := `5168015d32f890ca15812c9180835d2e` // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `requestable 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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *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* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) + sorters := `name,-modified` // 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, created, modified** (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, created, modified** (optional) + forSegmentIds := `0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + includeUnsegmented := false // bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.RolesAPI.ListRoles(context.Background()).Execute() + //resp, r, err := apiClient.V3.RolesAPI.ListRoles(context.Background()).ForSubadmin(forSubadmin).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSegmentIds(forSegmentIds).IncludeUnsegmented(includeUnsegmented).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.ListRoles``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListRoles`: []Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.ListRoles`: %v\n", resp) + } +- path: /roles/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/roles#patch-role + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808a7813090a017814121e121518` // string | Role ID to patch # string | Role ID to patch + jsonpatchoperation := []byte(`[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.RolesAPI.PatchRole(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.RolesAPI.PatchRole(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.PatchRole``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchRole`: Role + fmt.Fprintf(os.Stdout, "Response from `RolesAPI.PatchRole`: %v\n", resp) + } +- path: /saved-searches + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/saved-search#create-saved-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + createsavedsearchrequest := []byte(``) // CreateSavedSearchRequest | The saved search to persist. + + + var createSavedSearchRequest v3.CreateSavedSearchRequest + if err := json.Unmarshal(createsavedsearchrequest, &createSavedSearchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SavedSearchAPI.CreateSavedSearch(context.Background()).CreateSavedSearchRequest(createSavedSearchRequest).Execute() + //resp, r, err := apiClient.V3.SavedSearchAPI.CreateSavedSearch(context.Background()).CreateSavedSearchRequest(createSavedSearchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.CreateSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.CreateSavedSearch`: %v\n", resp) + } +- path: /saved-searches/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/saved-search#delete-saved-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SavedSearchAPI.DeleteSavedSearch(context.Background(), id).Execute() + //r, err := apiClient.V3.SavedSearchAPI.DeleteSavedSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.DeleteSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /saved-searches/{id}/execute + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/saved-search#execute-saved-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + searcharguments := []byte(`{ + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + }`) // SearchArguments | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + + + var searchArguments v3.SearchArguments + if err := json.Unmarshal(searcharguments, &searchArguments); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SavedSearchAPI.ExecuteSavedSearch(context.Background(), id).SearchArguments(searchArguments).Execute() + //r, err := apiClient.V3.SavedSearchAPI.ExecuteSavedSearch(context.Background(), id).SearchArguments(searchArguments).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.ExecuteSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /saved-searches/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/saved-search#get-saved-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SavedSearchAPI.GetSavedSearch(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SavedSearchAPI.GetSavedSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.GetSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.GetSavedSearch`: %v\n", resp) + } +- path: /saved-searches + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/saved-search#list-saved-searches + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"` // 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: **owner.id**: *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: **owner.id**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SavedSearchAPI.ListSavedSearches(context.Background()).Execute() + //resp, r, err := apiClient.V3.SavedSearchAPI.ListSavedSearches(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.ListSavedSearches``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSavedSearches`: []SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.ListSavedSearches`: %v\n", resp) + } +- path: /saved-searches/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/saved-search#put-saved-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + savedsearch := []byte(`{ + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + }`) // SavedSearch | The saved search to persist. + + + var savedSearch v3.SavedSearch + if err := json.Unmarshal(savedsearch, &savedSearch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SavedSearchAPI.PutSavedSearch(context.Background(), id).SavedSearch(savedSearch).Execute() + //resp, r, err := apiClient.V3.SavedSearchAPI.PutSavedSearch(context.Background(), id).SavedSearch(savedSearch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SavedSearchAPI.PutSavedSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSavedSearch`: SavedSearch + fmt.Fprintf(os.Stdout, "Response from `SavedSearchAPI.PutSavedSearch`: %v\n", resp) + } +- path: /scheduled-searches + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/scheduled-search#create-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + createscheduledsearchrequest := []byte(`{savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]}`) // CreateScheduledSearchRequest | The scheduled search to persist. + + + var createScheduledSearchRequest v3.CreateScheduledSearchRequest + if err := json.Unmarshal(createscheduledsearchrequest, &createScheduledSearchRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ScheduledSearchAPI.CreateScheduledSearch(context.Background()).CreateScheduledSearchRequest(createScheduledSearchRequest).Execute() + //resp, r, err := apiClient.V3.ScheduledSearchAPI.CreateScheduledSearch(context.Background()).CreateScheduledSearchRequest(createScheduledSearchRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.CreateScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.CreateScheduledSearch`: %v\n", resp) + } +- path: /scheduled-searches/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/scheduled-search#delete-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ScheduledSearchAPI.DeleteScheduledSearch(context.Background(), id).Execute() + //r, err := apiClient.V3.ScheduledSearchAPI.DeleteScheduledSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.DeleteScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /scheduled-searches/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/scheduled-search#get-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ScheduledSearchAPI.GetScheduledSearch(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.ScheduledSearchAPI.GetScheduledSearch(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.GetScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.GetScheduledSearch`: %v\n", resp) + } +- path: /scheduled-searches + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/scheduled-search#list-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"` // 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: **owner.id**: *eq* **savedSearchId**: *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: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ScheduledSearchAPI.ListScheduledSearch(context.Background()).Execute() + //resp, r, err := apiClient.V3.ScheduledSearchAPI.ListScheduledSearch(context.Background()).Offset(offset).Limit(limit).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.ListScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListScheduledSearch`: []ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.ListScheduledSearch`: %v\n", resp) + } +- path: /scheduled-searches/{id}/unsubscribe + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/scheduled-search#unsubscribe-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + typedreference := []byte(`{ + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }`) // TypedReference | The recipient to be removed from the scheduled search. + + + var typedReference v3.TypedReference + if err := json.Unmarshal(typedreference, &typedReference); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ScheduledSearchAPI.UnsubscribeScheduledSearch(context.Background(), id).TypedReference(typedReference).Execute() + //r, err := apiClient.V3.ScheduledSearchAPI.UnsubscribeScheduledSearch(context.Background(), id).TypedReference(typedReference).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.UnsubscribeScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /scheduled-searches/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/scheduled-search#update-scheduled-search + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + scheduledsearch := []byte(`{ + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false + }`) // ScheduledSearch | The scheduled search to persist. + + + var scheduledSearch v3.ScheduledSearch + if err := json.Unmarshal(scheduledsearch, &scheduledSearch); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ScheduledSearchAPI.UpdateScheduledSearch(context.Background(), id).ScheduledSearch(scheduledSearch).Execute() + //resp, r, err := apiClient.V3.ScheduledSearchAPI.UpdateScheduledSearch(context.Background(), id).ScheduledSearch(scheduledSearch).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ScheduledSearchAPI.UpdateScheduledSearch``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateScheduledSearch`: ScheduledSearch + fmt.Fprintf(os.Stdout, "Response from `ScheduledSearchAPI.UpdateScheduledSearch`: %v\n", resp) + } +- path: /search/aggregate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/search#search-aggregate + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + var search v3.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SearchAPI.SearchAggregate(context.Background()).Search(search).Execute() + //resp, r, err := apiClient.V3.SearchAPI.SearchAggregate(context.Background()).Search(search).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchAggregate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchAggregate`: AggregationResult + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchAggregate`: %v\n", resp) + } +- path: /search/count + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/search#search-count + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + + + var search v3.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SearchAPI.SearchCount(context.Background()).Search(search).Execute() + //r, err := apiClient.V3.SearchAPI.SearchCount(context.Background()).Search(search).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchCount``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /search/{index}/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/search#search-get + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + index := `identities` // string | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. # string | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + id := `2c91808568c529c60168cca6f90c1313` // string | ID of the requested document. # string | ID of the requested document. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SearchAPI.SearchGet(context.Background(), index, id).Execute() + //resp, r, err := apiClient.V3.SearchAPI.SearchGet(context.Background(), index, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchGet``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchGet`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchGet`: %v\n", resp) + } +- path: /search + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/search#search-post + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + search := []byte(`{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }`) // Search | + 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) + limit := 10000 // 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + var search v3.Search + if err := json.Unmarshal(search, &search); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SearchAPI.SearchPost(context.Background()).Search(search).Execute() + //resp, r, err := apiClient.V3.SearchAPI.SearchPost(context.Background()).Search(search).Offset(offset).Limit(limit).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchPost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SearchPost`: []map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchPost`: %v\n", resp) + } +- path: /accounts/search-attribute-config + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/search-attribute-configuration#create-search-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + searchattributeconfig := []byte(`{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }`) // SearchAttributeConfig | + + + var searchAttributeConfig v3.SearchAttributeConfig + if err := json.Unmarshal(searchattributeconfig, &searchAttributeConfig); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SearchAttributeConfigurationAPI.CreateSearchAttributeConfig(context.Background()).SearchAttributeConfig(searchAttributeConfig).Execute() + //resp, r, err := apiClient.V3.SearchAttributeConfigurationAPI.CreateSearchAttributeConfig(context.Background()).SearchAttributeConfig(searchAttributeConfig).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.CreateSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSearchAttributeConfig`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.CreateSearchAttributeConfig`: %v\n", resp) + } +- path: /accounts/search-attribute-config/{name} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/search-attribute-configuration#delete-search-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `newMailAttribute` // string | Name of the extended search attribute configuration to delete. # string | Name of the extended search attribute configuration to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig(context.Background(), name).Execute() + //r, err := apiClient.V3.SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.DeleteSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /accounts/search-attribute-config + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/search-attribute-configuration#get-search-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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.V3.SearchAttributeConfigurationAPI.GetSearchAttributeConfig(context.Background()).Execute() + //resp, r, err := apiClient.V3.SearchAttributeConfigurationAPI.GetSearchAttributeConfig(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.GetSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSearchAttributeConfig`: []SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.GetSearchAttributeConfig`: %v\n", resp) + } +- path: /accounts/search-attribute-config/{name} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `newMailAttribute` // string | Name of the extended search attribute configuration to retrieve. # string | Name of the extended search attribute configuration to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig(context.Background(), name).Execute() + //resp, r, err := apiClient.V3.SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig(context.Background(), name).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSingleSearchAttributeConfig`: []SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.GetSingleSearchAttributeConfig`: %v\n", resp) + } +- path: /accounts/search-attribute-config/{name} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/search-attribute-configuration#patch-search-attribute-config + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + name := `promotedMailAttribute` // string | Name of the search attribute configuration to patch. # string | Name of the search attribute configuration to patch. + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SearchAttributeConfigurationAPI.PatchSearchAttributeConfig(context.Background(), name).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.SearchAttributeConfigurationAPI.PatchSearchAttributeConfig(context.Background(), name).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SearchAttributeConfigurationAPI.PatchSearchAttributeConfig``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSearchAttributeConfig`: SearchAttributeConfig + fmt.Fprintf(os.Stdout, "Response from `SearchAttributeConfigurationAPI.PatchSearchAttributeConfig`: %v\n", resp) + } +- path: /segments + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/segments#create-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + segment := []byte(`{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }`) // Segment | + + + var segment v3.Segment + if err := json.Unmarshal(segment, &segment); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SegmentsAPI.CreateSegment(context.Background()).Segment(segment).Execute() + //resp, r, err := apiClient.V3.SegmentsAPI.CreateSegment(context.Background()).Segment(segment).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.CreateSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.CreateSegment`: %v\n", resp) + } +- path: /segments/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/segments#delete-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to delete. # string | The segment ID to delete. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SegmentsAPI.DeleteSegment(context.Background(), id).Execute() + //r, err := apiClient.V3.SegmentsAPI.DeleteSegment(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.DeleteSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /segments/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/segments#get-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to retrieve. # string | The segment ID to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SegmentsAPI.GetSegment(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SegmentsAPI.GetSegment(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.GetSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.GetSegment`: %v\n", resp) + } +- path: /segments + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/segments#list-segments + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SegmentsAPI.ListSegments(context.Background()).Execute() + //resp, r, err := apiClient.V3.SegmentsAPI.ListSegments(context.Background()).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.ListSegments``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSegments`: []Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.ListSegments`: %v\n", resp) + } +- path: /segments/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/segments#patch-segment + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The segment ID to modify. # string | The segment ID to modify. + requestbody := []byte(`[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]`) // []map[string]interface{} | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + + + var requestBody v3.[]RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SegmentsAPI.PatchSegment(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V3.SegmentsAPI.PatchSegment(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SegmentsAPI.PatchSegment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSegment`: Segment + fmt.Fprintf(os.Stdout, "Response from `SegmentsAPI.PatchSegment`: %v\n", resp) + } +- path: /service-desk-integrations + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/service-desk-integration#create-service-desk-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + servicedeskintegrationdto := []byte(`{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + }`) // ServiceDeskIntegrationDto | The specifics of a new integration to create + + + var serviceDeskIntegrationDto v3.ServiceDeskIntegrationDto + if err := json.Unmarshal(servicedeskintegrationdto, &serviceDeskIntegrationDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.CreateServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.CreateServiceDeskIntegration`: %v\n", resp) + } +- path: /service-desk-integrations/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/service-desk-integration#delete-service-desk-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `anId` // string | ID of Service Desk integration to delete # string | ID of Service Desk integration to delete + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration(context.Background(), id).Execute() + //r, err := apiClient.V3.ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.DeleteServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /service-desk-integrations/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/service-desk-integration#get-service-desk-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `anId` // string | ID of the Service Desk integration to get # string | ID of the Service Desk integration to get + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetServiceDeskIntegration(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetServiceDeskIntegration(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegration`: %v\n", resp) + } +- path: /service-desk-integrations/templates/{scriptName} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/service-desk-integration#get-service-desk-integration-template + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + scriptName := `aScriptName` // string | The scriptName value of the Service Desk integration template to get # string | The scriptName value of the Service Desk integration template to get + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationTemplate`: ServiceDeskIntegrationTemplateDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTemplate`: %v\n", resp) + } +- path: /service-desk-integrations/types + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/service-desk-integration#get-service-desk-integration-types + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes(context.Background()).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrationTypes`: []ServiceDeskIntegrationTemplateType + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrationTypes`: %v\n", resp) + } +- path: /service-desk-integrations + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/service-desk-integration#get-service-desk-integrations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + sorters := `name` // 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** (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** (optional) + filters := `name eq "John Doe"` // 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* **type**: *eq, in* **cluster**: *eq, in* (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* **type**: *eq, in* **cluster**: *eq, in* (optional) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetServiceDeskIntegrations(context.Background()).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetServiceDeskIntegrations(context.Background()).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetServiceDeskIntegrations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServiceDeskIntegrations`: []ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetServiceDeskIntegrations`: %v\n", resp) + } +- path: /service-desk-integrations/status-check-configuration + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/service-desk-integration#get-status-check-details + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetStatusCheckDetails(context.Background()).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.GetStatusCheckDetails(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.GetStatusCheckDetails``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetStatusCheckDetails`: QueuedCheckConfigDetails + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.GetStatusCheckDetails`: %v\n", resp) + } +- path: /service-desk-integrations/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/service-desk-integration#patch-service-desk-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `anId` // string | ID of the Service Desk integration to update # string | ID of the Service Desk integration to update + jsonpatchoperation := []byte(``) // []JsonPatchOperation | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.PatchServiceDeskIntegration(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.PatchServiceDeskIntegration(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.PatchServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.PatchServiceDeskIntegration`: %v\n", resp) + } +- path: /service-desk-integrations/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/service-desk-integration#put-service-desk-integration + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `anId` // string | ID of the Service Desk integration to update # string | ID of the Service Desk integration to update + servicedeskintegrationdto := []byte(`{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + }`) // ServiceDeskIntegrationDto | The specifics of the integration to update + + + var serviceDeskIntegrationDto v3.ServiceDeskIntegrationDto + if err := json.Unmarshal(servicedeskintegrationdto, &serviceDeskIntegrationDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.PutServiceDeskIntegration``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutServiceDeskIntegration`: ServiceDeskIntegrationDto + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.PutServiceDeskIntegration`: %v\n", resp) + } +- path: /service-desk-integrations/status-check-configuration + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/service-desk-integration#update-status-check-details + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + queuedcheckconfigdetails := []byte(`{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + }`) // QueuedCheckConfigDetails | The modified time check configuration + + + var queuedCheckConfigDetails v3.QueuedCheckConfigDetails + if err := json.Unmarshal(queuedcheckconfigdetails, &queuedCheckConfigDetails); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute() + //resp, r, err := apiClient.V3.ServiceDeskIntegrationAPI.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationAPI.UpdateStatusCheckDetails``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateStatusCheckDetails`: QueuedCheckConfigDetails + fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationAPI.UpdateStatusCheckDetails`: %v\n", resp) + } +- path: /sod-policies + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#create-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sodpolicy := []byte(`{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }`) // SodPolicy | + + + var sodPolicy v3.SodPolicy + if err := json.Unmarshal(sodpolicy, &sodPolicy); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.CreateSodPolicy(context.Background()).SodPolicy(sodPolicy).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.CreateSodPolicy(context.Background()).SodPolicy(sodPolicy).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.CreateSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.CreateSodPolicy`: %v\n", resp) + } +- path: /sod-policies/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#delete-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD Policy to delete. # string | The ID of the SOD Policy to delete. + logical := true // bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to true) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SODPoliciesAPI.DeleteSodPolicy(context.Background(), id).Execute() + //r, err := apiClient.V3.SODPoliciesAPI.DeleteSodPolicy(context.Background(), id).Logical(logical).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.DeleteSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sod-policies/{id}/schedule + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#delete-sod-policy-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy the schedule must be deleted for. # string | The ID of the SOD policy the schedule must be deleted for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SODPoliciesAPI.DeleteSodPolicySchedule(context.Background(), id).Execute() + //r, err := apiClient.V3.SODPoliciesAPI.DeleteSodPolicySchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.DeleteSodPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#get-custom-violation-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reportResultId := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the report reference to download. # string | The ID of the report reference to download. + fileName := `custom-name` // string | Custom Name for the file. # string | Custom Name for the file. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.GetCustomViolationReport(context.Background(), reportResultId, fileName).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.GetCustomViolationReport(context.Background(), reportResultId, fileName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetCustomViolationReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCustomViolationReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetCustomViolationReport`: %v\n", resp) + } +- path: /sod-violation-report/{reportResultId}/download + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#get-default-violation-report + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reportResultId := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the report reference to download. # string | The ID of the report reference to download. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.GetDefaultViolationReport(context.Background(), reportResultId).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.GetDefaultViolationReport(context.Background(), reportResultId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetDefaultViolationReport``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDefaultViolationReport`: *os.File + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetDefaultViolationReport`: %v\n", resp) + } +- path: /sod-violation-report + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodAllReportRunStatus(context.Background()).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodAllReportRunStatus(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodAllReportRunStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodAllReportRunStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodAllReportRunStatus`: %v\n", resp) + } +- path: /sod-policies/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#get-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD Policy to retrieve. # string | The ID of the SOD Policy to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodPolicy`: %v\n", resp) + } +- path: /sod-policies/{id}/schedule + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#get-sod-policy-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy schedule to retrieve. # string | The ID of the SOD policy schedule to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodPolicySchedule(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodPolicySchedule(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodPolicySchedule`: SodPolicySchedule + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodPolicySchedule`: %v\n", resp) + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#get-sod-violation-report-run-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + reportResultId := `2e8d8180-24bc-4d21-91c6-7affdb473b0d` // string | The ID of the report reference to retrieve. # string | The ID of the report reference to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodViolationReportRunStatus(context.Background(), reportResultId).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodViolationReportRunStatus(context.Background(), reportResultId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodViolationReportRunStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodViolationReportRunStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodViolationReportRunStatus`: %v\n", resp) + } +- path: /sod-policies/{id}/violation-report + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#get-sod-violation-report-status + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the violation report to retrieve status for. # string | The ID of the violation report to retrieve status for. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodViolationReportStatus(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.GetSodViolationReportStatus(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.GetSodViolationReportStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSodViolationReportStatus`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.GetSodViolationReportStatus`: %v\n", resp) + } +- path: /sod-policies + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#list-sod-policies + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `id eq "bc693f07e7b645539626c25954c58554"` // 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, in* **state**: *eq, in* (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, in* **state**: *eq, in* (optional) + sorters := `id,name` // 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: **id, name, created, modified, description** (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: **id, name, created, modified, description** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.ListSodPolicies(context.Background()).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.ListSodPolicies(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.ListSodPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSodPolicies`: []SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.ListSodPolicies`: %v\n", resp) + } +- path: /sod-policies/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#patch-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c918083-5d19-1a86-015d-28455b4a2329` // string | The ID of the SOD policy being modified. # string | The ID of the SOD policy being modified. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]`) // []JsonPatchOperation | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.PatchSodPolicy(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.PatchSodPolicy(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PatchSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PatchSodPolicy`: %v\n", resp) + } +- path: /sod-policies/{id}/schedule + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#put-policy-schedule + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy to update its schedule. # string | The ID of the SOD policy to update its schedule. + sodpolicyschedule := []byte(`{ + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }`) // SodPolicySchedule | + + + var sodPolicySchedule v3.SodPolicySchedule + if err := json.Unmarshal(sodpolicyschedule, &sodPolicySchedule); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.PutPolicySchedule(context.Background(), id).SodPolicySchedule(sodPolicySchedule).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.PutPolicySchedule(context.Background(), id).SodPolicySchedule(sodPolicySchedule).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PutPolicySchedule``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutPolicySchedule`: SodPolicySchedule + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PutPolicySchedule`: %v\n", resp) + } +- path: /sod-policies/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#put-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The ID of the SOD policy to update. # string | The ID of the SOD policy to update. + sodpolicy := []byte(`{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }`) // SodPolicy | + + + var sodPolicy v3.SodPolicy + if err := json.Unmarshal(sodpolicy, &sodPolicy); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.PutSodPolicy(context.Background(), id).SodPolicy(sodPolicy).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.PutSodPolicy(context.Background(), id).SodPolicy(sodPolicy).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.PutSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSodPolicy`: SodPolicy + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.PutSodPolicy`: %v\n", resp) + } +- path: /sod-policies/{id}/evaluate + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#start-evaluate-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The SOD policy ID to run. # string | The SOD policy ID to run. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.StartEvaluateSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.StartEvaluateSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartEvaluateSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartEvaluateSodPolicy`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartEvaluateSodPolicy`: %v\n", resp) + } +- path: /sod-violation-report/run + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + multipolicyrequest := []byte(`{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }`) // MultiPolicyRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.StartSodAllPoliciesForOrg(context.Background()).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.StartSodAllPoliciesForOrg(context.Background()).MultiPolicyRequest(multiPolicyRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartSodAllPoliciesForOrg``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartSodAllPoliciesForOrg`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartSodAllPoliciesForOrg`: %v\n", resp) + } +- path: /sod-policies/{id}/violation-report/run + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-policies#start-sod-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f943-47e9-4562-b5bb-8424a56397d8` // string | The SOD policy ID to run. # string | The SOD policy ID to run. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODPoliciesAPI.StartSodPolicy(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SODPoliciesAPI.StartSodPolicy(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODPoliciesAPI.StartSodPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartSodPolicy`: ReportResultReference + fmt.Fprintf(os.Stdout, "Response from `SODPoliciesAPI.StartSodPolicy`: %v\n", resp) + } +- path: /sod-violations/predict + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-violations#start-predict-sod-violations + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identitywithnewaccess := []byte(`{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }`) // IdentityWithNewAccess | + + + var identityWithNewAccess v3.IdentityWithNewAccess + if err := json.Unmarshal(identitywithnewaccess, &identityWithNewAccess); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODViolationsAPI.StartPredictSodViolations(context.Background()).IdentityWithNewAccess(identityWithNewAccess).Execute() + //resp, r, err := apiClient.V3.SODViolationsAPI.StartPredictSodViolations(context.Background()).IdentityWithNewAccess(identityWithNewAccess).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODViolationsAPI.StartPredictSodViolations``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartPredictSodViolations`: ViolationPrediction + fmt.Fprintf(os.Stdout, "Response from `SODViolationsAPI.StartPredictSodViolations`: %v\n", resp) + } +- path: /sod-violations/check + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sod-violations#start-violation-check + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + identitywithnewaccess1 := []byte(`{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}`) // IdentityWithNewAccess1 | + + + var identityWithNewAccess1 v3.IdentityWithNewAccess1 + if err := json.Unmarshal(identitywithnewaccess1, &identityWithNewAccess1); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SODViolationsAPI.StartViolationCheck(context.Background()).IdentityWithNewAccess1(identityWithNewAccess1).Execute() + //resp, r, err := apiClient.V3.SODViolationsAPI.StartViolationCheck(context.Background()).IdentityWithNewAccess1(identityWithNewAccess1).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SODViolationsAPI.StartViolationCheck``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StartViolationCheck`: SodViolationCheck + fmt.Fprintf(os.Stdout, "Response from `SODViolationsAPI.StartViolationCheck`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#create-provisioning-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id # string | The Source id + provisioningpolicydto := []byte(`{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }`) // ProvisioningPolicyDto | + + + var provisioningPolicyDto v3.ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.CreateProvisioningPolicy(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.CreateProvisioningPolicy(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateProvisioningPolicy`: %v\n", resp) + } +- path: /sources + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#create-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + source := []byte(`{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }`) // Source | + provisionAsCsv := false // bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + + var source v3.Source + if err := json.Unmarshal(source, &source); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.CreateSource(context.Background()).Source(source).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.CreateSource(context.Background()).Source(source).ProvisionAsCsv(provisionAsCsv).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSource`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#create-source-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + schema := []byte(`{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + }`) // Schema | + + + var schema v3.Schema + if err := json.Unmarshal(schema, &schema); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.CreateSourceSchema(context.Background(), sourceId).Schema(schema).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.CreateSourceSchema(context.Background(), sourceId).Schema(schema).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.CreateSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.CreateSourceSchema`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#delete-provisioning-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SourcesAPI.DeleteProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + //r, err := apiClient.V3.SourcesAPI.DeleteProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#delete-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.DeleteSource(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.DeleteSource(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteSource`: DeleteSource202Response + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.DeleteSource`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#delete-source-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SourcesAPI.DeleteSourceSchema(context.Background(), sourceId, schemaId).Execute() + //r, err := apiClient.V3.SourcesAPI.DeleteSourceSchema(context.Background(), sourceId, schemaId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.DeleteSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{id}/schemas/accounts + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#get-accounts-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SourcesAPI.GetAccountsSchema(context.Background(), id).Execute() + //r, err := apiClient.V3.SourcesAPI.GetAccountsSchema(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetAccountsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{id}/schemas/entitlements + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#get-entitlements-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + schemaName := `?schemaName=group` // string | Name of entitlement schema (optional) # string | Name of entitlement schema (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.SourcesAPI.GetEntitlementsSchema(context.Background(), id).Execute() + //r, err := apiClient.V3.SourcesAPI.GetEntitlementsSchema(context.Background(), id).SchemaName(schemaName).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetEntitlementsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#get-provisioning-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.GetProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.GetProvisioningPolicy(context.Background(), sourceId, usageType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetProvisioningPolicy`: %v\n", resp) + } +- path: /sources/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#get-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.GetSource(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.GetSource(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSource`: %v\n", resp) + } +- path: /sources/{sourceId}/connections + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#get-source-connections + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.GetSourceConnections(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.GetSourceConnections(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceConnections``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceConnections`: SourceConnectionsDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceConnections`: %v\n", resp) + } +- path: /sources/{sourceId}/source-health + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#get-source-health + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.GetSourceHealth(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.GetSourceHealth(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceHealth``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceHealth`: SourceHealthDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceHealth`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#get-source-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.GetSourceSchema(context.Background(), sourceId, schemaId).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.GetSourceSchema(context.Background(), sourceId, schemaId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchema`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#get-source-schemas + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + includeTypes := `group` // string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) # string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + includeNames := `account` // string | A comma-separated list of schema names to filter result. (optional) # string | A comma-separated list of schema names to filter result. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).IncludeTypes(includeTypes).IncludeNames(includeNames).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchemas``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetSourceSchemas`: []Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.GetSourceSchemas`: %v\n", resp) + } +- path: /sources/{id}/schemas/accounts + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#import-accounts-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.ImportAccountsSchema(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.ImportAccountsSchema(context.Background(), id).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportAccountsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportAccountsSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportAccountsSchema`: %v\n", resp) + } +- path: /sources/{sourceId}/upload-connector-file + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#import-connector-file + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.ImportConnectorFile(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.ImportConnectorFile(context.Background(), sourceId).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportConnectorFile``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportConnectorFile`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportConnectorFile`: %v\n", resp) + } +- path: /sources/{id}/schemas/entitlements + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#import-entitlements-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `8c190e6787aa4ed9a90bd9d5344523fb` // string | The Source id # string | The Source id + schemaName := `?schemaName=group` // string | Name of entitlement schema (optional) # string | Name of entitlement schema (optional) + file := BINARY_DATA_HERE // *os.File | (optional) # *os.File | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.ImportEntitlementsSchema(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.ImportEntitlementsSchema(context.Background(), id).SchemaName(schemaName).File(file).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ImportEntitlementsSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ImportEntitlementsSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ImportEntitlementsSchema`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#list-provisioning-policies + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id # string | The Source id + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.ListProvisioningPolicies(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.ListProvisioningPolicies(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ListProvisioningPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListProvisioningPolicies`: []ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ListProvisioningPolicies`: %v\n", resp) + } +- path: /sources + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#list-sources + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `name eq "Employees"` // 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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (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, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + sorters := `name` // 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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + forSubadmin := `name` // string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) # string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + includeIDNSource := true // bool | Include the IdentityNow source in the response. (optional) (default to false) # bool | Include the IdentityNow source in the response. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.ListSources(context.Background()).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.ListSources(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Sorters(sorters).ForSubadmin(forSubadmin).IncludeIDNSource(includeIDNSource).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.ListSources``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListSources`: []Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.ListSources`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#put-provisioning-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source ID. # string | The Source ID. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + provisioningpolicydto := []byte(`{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }`) // ProvisioningPolicyDto | + + + var provisioningPolicyDto v3.ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.PutProvisioningPolicy(context.Background(), sourceId, usageType).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.PutProvisioningPolicy(context.Background(), sourceId, usageType).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutProvisioningPolicy`: %v\n", resp) + } +- path: /sources/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#put-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + source := []byte(`{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }`) // Source | + + + var source v3.Source + if err := json.Unmarshal(source, &source); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.PutSource(context.Background(), id).Source(source).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.PutSource(context.Background(), id).Source(source).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSource`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#put-source-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + schema := []byte(`{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + }`) // Schema | + + + var schema v3.Schema + if err := json.Unmarshal(schema, &schema); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.PutSourceSchema(context.Background(), sourceId, schemaId).Schema(schema).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.PutSourceSchema(context.Background(), sourceId, schemaId).Schema(schema).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.PutSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.PutSourceSchema`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#update-provisioning-policies-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + provisioningpolicydto := []byte(``) // []ProvisioningPolicyDto | + + + var provisioningPolicyDto v3.[]ProvisioningPolicyDto + if err := json.Unmarshal(provisioningpolicydto, &provisioningPolicyDto); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.UpdateProvisioningPoliciesInBulk(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.UpdateProvisioningPoliciesInBulk(context.Background(), sourceId).ProvisioningPolicyDto(provisioningPolicyDto).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateProvisioningPoliciesInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateProvisioningPoliciesInBulk`: []ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateProvisioningPoliciesInBulk`: %v\n", resp) + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#update-provisioning-policy + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + usageType := CREATE // UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + jsonpatchoperation := []byte(`[{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schema. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.UpdateProvisioningPolicy(context.Background(), sourceId, usageType).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.UpdateProvisioningPolicy(context.Background(), sourceId, usageType).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateProvisioningPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateProvisioningPolicy`: ProvisioningPolicyDto + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateProvisioningPolicy`: %v\n", resp) + } +- path: /sources/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#update-source + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | Source ID. # string | Source ID. + jsonpatchoperation := []byte(`[{op=replace, path=/description, value=new description}]`) // []JsonPatchOperation | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.UpdateSource(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.UpdateSource(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSource``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSource`: Source + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSource`: %v\n", resp) + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/sources#update-source-schema + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | The Source id. # string | The Source id. + schemaId := `2c9180835d191a86015d28455b4a2329` // string | The Schema id. # string | The Schema id. + jsonpatchoperation := []byte(`[{op=add, path=/attributes/-, value={name=location, type=STRING, schema=null, description=Employee location, isMulti=false, isEntitlement=false, isGroup=false}}]`) // []JsonPatchOperation | The JSONPatch payload used to update the schema. + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourcesAPI.UpdateSourceSchema(context.Background(), sourceId, schemaId).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.SourcesAPI.UpdateSourceSchema(context.Background(), sourceId, schemaId).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.UpdateSourceSchema``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateSourceSchema`: Schema + fmt.Fprintf(os.Stdout, "Response from `SourcesAPI.UpdateSourceSchema`: %v\n", resp) + } +- path: /source-usages/{sourceId}/status + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/source-usages#get-status-by-source-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | ID of IDN source # string | ID of IDN source + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourceUsagesAPI.GetStatusBySourceId(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.SourceUsagesAPI.GetStatusBySourceId(context.Background(), sourceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourceUsagesAPI.GetStatusBySourceId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetStatusBySourceId`: SourceUsageStatus + fmt.Fprintf(os.Stdout, "Response from `SourceUsagesAPI.GetStatusBySourceId`: %v\n", resp) + } +- path: /source-usages/{sourceId}/summaries + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/source-usages#get-usages-by-source-id + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + sourceId := `2c9180835d191a86015d28455b4a2329` // string | ID of IDN source # string | ID of IDN source + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + sorters := `-date` // 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: **date** (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: **date** (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.SourceUsagesAPI.GetUsagesBySourceId(context.Background(), sourceId).Execute() + //resp, r, err := apiClient.V3.SourceUsagesAPI.GetUsagesBySourceId(context.Background(), sourceId).Limit(limit).Offset(offset).Count(count).Sorters(sorters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `SourceUsagesAPI.GetUsagesBySourceId``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUsagesBySourceId`: []SourceUsage + fmt.Fprintf(os.Stdout, "Response from `SourceUsagesAPI.GetUsagesBySourceId`: %v\n", resp) + } +- path: /tagged-objects/{type}/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/tagged-objects#delete-tagged-object + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + type_ := `ROLE` // string | The type of object to delete tags from. # string | The type of object to delete tags from. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object to delete tags from. # string | The ID of the object to delete tags from. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.TaggedObjectsAPI.DeleteTaggedObject(context.Background(), type_, id).Execute() + //r, err := apiClient.V3.TaggedObjectsAPI.DeleteTaggedObject(context.Background(), type_, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.DeleteTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /tagged-objects/bulk-remove + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/tagged-objects#delete-tags-to-many-object + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + bulkremovetaggedobject := []byte(`{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // BulkRemoveTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + + var bulkRemoveTaggedObject v3.BulkRemoveTaggedObject + if err := json.Unmarshal(bulkremovetaggedobject, &bulkRemoveTaggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.TaggedObjectsAPI.DeleteTagsToManyObject(context.Background()).BulkRemoveTaggedObject(bulkRemoveTaggedObject).Execute() + //r, err := apiClient.V3.TaggedObjectsAPI.DeleteTagsToManyObject(context.Background()).BulkRemoveTaggedObject(bulkRemoveTaggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.DeleteTagsToManyObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /tagged-objects/{type}/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/tagged-objects#get-tagged-object + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + type_ := `ROLE` // string | The type of tagged object to retrieve. # string | The type of tagged object to retrieve. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to retrieve. # string | The ID of the object reference to retrieve. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TaggedObjectsAPI.GetTaggedObject(context.Background(), type_, id).Execute() + //resp, r, err := apiClient.V3.TaggedObjectsAPI.GetTaggedObject(context.Background(), type_, id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.GetTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTaggedObject`: TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.GetTaggedObject`: %v\n", resp) + } +- path: /tagged-objects + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/tagged-objects#list-tagged-objects + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `tagName eq "BU_FINANCE"` // 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TaggedObjectsAPI.ListTaggedObjects(context.Background()).Execute() + //resp, r, err := apiClient.V3.TaggedObjectsAPI.ListTaggedObjects(context.Background()).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.ListTaggedObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTaggedObjects`: []TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.ListTaggedObjects`: %v\n", resp) + } +- path: /tagged-objects/{type} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/tagged-objects#list-tagged-objects-by-type + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + type_ := `ROLE` // string | The type of tagged object to retrieve. # string | The type of tagged object to retrieve. + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `objectRef.id eq "2c91808568c529c60168cca6f90c1313"` // 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: **objectRef.id**: *eq* **objectRef.type**: *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: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TaggedObjectsAPI.ListTaggedObjectsByType(context.Background(), type_).Execute() + //resp, r, err := apiClient.V3.TaggedObjectsAPI.ListTaggedObjectsByType(context.Background(), type_).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.ListTaggedObjectsByType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTaggedObjectsByType`: []TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.ListTaggedObjectsByType`: %v\n", resp) + } +- path: /tagged-objects/{type}/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/tagged-objects#put-tagged-object + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + type_ := `ROLE` // string | The type of tagged object to update. # string | The type of tagged object to update. + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the object reference to update. # string | The ID of the object reference to update. + taggedobject := []byte(`{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // TaggedObject | + + + var taggedObject v3.TaggedObject + if err := json.Unmarshal(taggedobject, &taggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TaggedObjectsAPI.PutTaggedObject(context.Background(), type_, id).TaggedObject(taggedObject).Execute() + //resp, r, err := apiClient.V3.TaggedObjectsAPI.PutTaggedObject(context.Background(), type_, id).TaggedObject(taggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.PutTaggedObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutTaggedObject`: TaggedObject + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.PutTaggedObject`: %v\n", resp) + } +- path: /tagged-objects + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/tagged-objects#set-tag-to-object + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + taggedobject := []byte(`{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // TaggedObject | + + + var taggedObject v3.TaggedObject + if err := json.Unmarshal(taggedobject, &taggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.TaggedObjectsAPI.SetTagToObject(context.Background()).TaggedObject(taggedObject).Execute() + //r, err := apiClient.V3.TaggedObjectsAPI.SetTagToObject(context.Background()).TaggedObject(taggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.SetTagToObject``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /tagged-objects/bulk-add + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/tagged-objects#set-tags-to-many-objects + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + bulkaddtaggedobject := []byte(`{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + }`) // BulkAddTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + + + var bulkAddTaggedObject v3.BulkAddTaggedObject + if err := json.Unmarshal(bulkaddtaggedobject, &bulkAddTaggedObject); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TaggedObjectsAPI.SetTagsToManyObjects(context.Background()).BulkAddTaggedObject(bulkAddTaggedObject).Execute() + //resp, r, err := apiClient.V3.TaggedObjectsAPI.SetTagsToManyObjects(context.Background()).BulkAddTaggedObject(bulkAddTaggedObject).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TaggedObjectsAPI.SetTagsToManyObjects``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SetTagsToManyObjects`: []BulkTaggedObjectResponse + fmt.Fprintf(os.Stdout, "Response from `TaggedObjectsAPI.SetTagsToManyObjects`: %v\n", resp) + } +- path: /transforms + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/transforms#create-transform + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + transform := []byte(`{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }`) // Transform | The transform to be created. + + + var transform v3.Transform + if err := json.Unmarshal(transform, &transform); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TransformsAPI.CreateTransform(context.Background()).Transform(transform).Execute() + //resp, r, err := apiClient.V3.TransformsAPI.CreateTransform(context.Background()).Transform(transform).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.CreateTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.CreateTransform`: %v\n", resp) + } +- path: /transforms/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/transforms#delete-transform + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to delete # string | ID of the transform to delete + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.TransformsAPI.DeleteTransform(context.Background(), id).Execute() + //r, err := apiClient.V3.TransformsAPI.DeleteTransform(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.DeleteTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /transforms/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/transforms#get-transform + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to retrieve # string | ID of the transform to retrieve + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TransformsAPI.GetTransform(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.TransformsAPI.GetTransform(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.GetTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.GetTransform`: %v\n", resp) + } +- path: /transforms + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/transforms#list-transforms + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + name := `ExampleTransformName123` // string | Name of the transform to retrieve from the list. (optional) # string | Name of the transform to retrieve from the list. (optional) + filters := `name eq "Uppercase"` // 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: **internal**: *eq* **name**: *eq, sw* (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: **internal**: *eq* **name**: *eq, sw* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TransformsAPI.ListTransforms(context.Background()).Execute() + //resp, r, err := apiClient.V3.TransformsAPI.ListTransforms(context.Background()).Offset(offset).Limit(limit).Count(count).Name(name).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.ListTransforms``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListTransforms`: []TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.ListTransforms`: %v\n", resp) + } +- path: /transforms/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/transforms#update-transform + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2cd78adghjkja34jh2b1hkjhasuecd` // string | ID of the transform to update # string | ID of the transform to update + transform := []byte(`{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }`) // Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.TransformsAPI.UpdateTransform(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.TransformsAPI.UpdateTransform(context.Background(), id).Transform(transform).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `TransformsAPI.UpdateTransform``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateTransform`: TransformRead + fmt.Fprintf(os.Stdout, "Response from `TransformsAPI.UpdateTransform`: %v\n", resp) + } +- path: /vendor-connector-mappings + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + vendorconnectormapping := []byte(`{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }`) // VendorConnectorMapping | + + + var vendorConnectorMapping v3.VendorConnectorMapping + if err := json.Unmarshal(vendorconnectormapping, &vendorConnectorMapping); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.VendorConnectorMappingsAPI.CreateVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + //resp, r, err := apiClient.V3.VendorConnectorMappingsAPI.CreateVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.CreateVendorConnectorMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateVendorConnectorMapping`: VendorConnectorMapping + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.CreateVendorConnectorMapping`: %v\n", resp) + } +- path: /vendor-connector-mappings + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + vendorconnectormapping := []byte(`{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }`) // VendorConnectorMapping | + + + var vendorConnectorMapping v3.VendorConnectorMapping + if err := json.Unmarshal(vendorconnectormapping, &vendorConnectorMapping); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.VendorConnectorMappingsAPI.DeleteVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + //resp, r, err := apiClient.V3.VendorConnectorMappingsAPI.DeleteVendorConnectorMapping(context.Background()).VendorConnectorMapping(vendorConnectorMapping).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.DeleteVendorConnectorMapping``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteVendorConnectorMapping`: DeleteVendorConnectorMapping200Response + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.DeleteVendorConnectorMapping`: %v\n", resp) + } +- path: /vendor-connector-mappings + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.VendorConnectorMappingsAPI.GetVendorConnectorMappings(context.Background()).Execute() + //resp, r, err := apiClient.V3.VendorConnectorMappingsAPI.GetVendorConnectorMappings(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `VendorConnectorMappingsAPI.GetVendorConnectorMappings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetVendorConnectorMappings`: []VendorConnectorMapping + fmt.Fprintf(os.Stdout, "Response from `VendorConnectorMappingsAPI.GetVendorConnectorMappings`: %v\n", resp) + } +- path: /workflow-executions/{id}/cancel + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#cancel-workflow-execution + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | The workflow execution ID # string | The workflow execution ID + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.WorkflowsAPI.CancelWorkflowExecution(context.Background(), id).Execute() + //r, err := apiClient.V3.WorkflowsAPI.CancelWorkflowExecution(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CancelWorkflowExecution``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /workflows/execute/external/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#create-external-execute-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + createexternalexecuteworkflowrequest := []byte(``) // CreateExternalExecuteWorkflowRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.CreateExternalExecuteWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.CreateExternalExecuteWorkflow(context.Background(), id).CreateExternalExecuteWorkflowRequest(createExternalExecuteWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateExternalExecuteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateExternalExecuteWorkflow`: CreateExternalExecuteWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateExternalExecuteWorkflow`: %v\n", resp) + } +- path: /workflows + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#create-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + createworkflowrequest := []byte(`{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}`) // CreateWorkflowRequest | + + + var createWorkflowRequest v3.CreateWorkflowRequest + if err := json.Unmarshal(createworkflowrequest, &createWorkflowRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.CreateWorkflow(context.Background()).CreateWorkflowRequest(createWorkflowRequest).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.CreateWorkflow(context.Background()).CreateWorkflowRequest(createWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateWorkflow`: %v\n", resp) + } +- path: /workflows/{id}/external/oauth-clients + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#create-workflow-external-trigger + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.CreateWorkflowExternalTrigger(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.CreateWorkflowExternalTrigger(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.CreateWorkflowExternalTrigger``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateWorkflowExternalTrigger`: WorkflowOAuthClient + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.CreateWorkflowExternalTrigger`: %v\n", resp) + } +- path: /workflows/{id} + method: Delete + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#delete-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.WorkflowsAPI.DeleteWorkflow(context.Background(), id).Execute() + //r, err := apiClient.V3.WorkflowsAPI.DeleteWorkflow(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.DeleteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /workflows/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#get-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + workflowMetrics := false // bool | disable workflow metrics (optional) (default to true) # bool | disable workflow metrics (optional) (default to true) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.GetWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.GetWorkflow(context.Background(), id).WorkflowMetrics(workflowMetrics).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflow`: %v\n", resp) + } +- path: /workflow-executions/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#get-workflow-execution + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Workflow execution ID. # string | Workflow execution ID. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.GetWorkflowExecution(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.GetWorkflowExecution(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecution``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecution`: map[string]interface{} + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecution`: %v\n", resp) + } +- path: /workflow-executions/{id}/history + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#get-workflow-execution-history + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow execution # string | Id of the workflow execution + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.GetWorkflowExecutionHistory(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.GetWorkflowExecutionHistory(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutionHistory``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecutionHistory`: []WorkflowExecutionEvent + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutionHistory`: %v\n", resp) + } +- path: /workflows/{id}/executions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#get-workflow-executions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Workflow ID. # string | Workflow 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + filters := `status eq "Failed"` // 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: **start_time**: *eq, lt, le, gt, ge* **status**: *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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.GetWorkflowExecutions(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.GetWorkflowExecutions(context.Background(), id).Limit(limit).Offset(offset).Count(count).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkflowExecutions`: []WorkflowExecution + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutions`: %v\n", resp) + } +- path: /workflow-library + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#list-complete-workflow-library + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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.V3.WorkflowsAPI.ListCompleteWorkflowLibrary(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.ListCompleteWorkflowLibrary(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListCompleteWorkflowLibrary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListCompleteWorkflowLibrary`: []ListCompleteWorkflowLibrary200ResponseInner + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListCompleteWorkflowLibrary`: %v\n", resp) + } +- path: /workflow-library/actions + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#list-workflow-library-actions + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + filters := `id eq "sp:create-campaign"` // 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* (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* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.ListWorkflowLibraryActions(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.ListWorkflowLibraryActions(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryActions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryActions`: []WorkflowLibraryAction + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryActions`: %v\n", resp) + } +- path: /workflow-library/operators + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#list-workflow-library-operators + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.ListWorkflowLibraryOperators(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.ListWorkflowLibraryOperators(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryOperators``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryOperators`: []WorkflowLibraryOperator + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryOperators`: %v\n", resp) + } +- path: /workflow-library/triggers + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#list-workflow-library-triggers + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + filters := `id eq "idn:identity-attributes-changed"` // 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* (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* (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.ListWorkflowLibraryTriggers(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.ListWorkflowLibraryTriggers(context.Background()).Limit(limit).Offset(offset).Filters(filters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflowLibraryTriggers``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflowLibraryTriggers`: []WorkflowLibraryTrigger + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflowLibraryTriggers`: %v\n", resp) + } +- path: /workflows + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#list-workflows + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + triggerId := `idn:identity-created` // string | Trigger ID (optional) # string | Trigger ID (optional) + connectorInstanceId := `28541fec-bb81-4ad4-88ef-0f7d213adcad` // string | Connector Instance ID (optional) # string | Connector Instance ID (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) + 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.V3.WorkflowsAPI.ListWorkflows(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.ListWorkflows(context.Background()).TriggerId(triggerId).ConnectorInstanceId(connectorInstanceId).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.ListWorkflows``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkflows`: []Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.ListWorkflows`: %v\n", resp) + } +- path: /workflows/{id} + method: Patch + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#patch-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + jsonpatchoperation := []byte(`[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]`) // []JsonPatchOperation | + + + var jsonPatchOperation v3.[]JsonPatchOperation + if err := json.Unmarshal(jsonpatchoperation, &jsonPatchOperation); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.PatchWorkflow(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.PatchWorkflow(context.Background(), id).JsonPatchOperation(jsonPatchOperation).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PatchWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PatchWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PatchWorkflow`: %v\n", resp) + } +- path: /workflows/{id} + method: Put + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#put-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the Workflow # string | Id of the Workflow + workflowbody := []byte(`{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : "{}", + "type" : "EVENT" + }, + "enabled" : false + }`) // WorkflowBody | + + + var workflowBody v3.WorkflowBody + if err := json.Unmarshal(workflowbody, &workflowBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.PutWorkflow(context.Background(), id).WorkflowBody(workflowBody).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.PutWorkflow(context.Background(), id).WorkflowBody(workflowBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.PutWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutWorkflow`: Workflow + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.PutWorkflow`: %v\n", resp) + } +- path: /workflows/execute/external/{id}/test + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#test-external-execute-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + testexternalexecuteworkflowrequest := []byte(``) // TestExternalExecuteWorkflowRequest | (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.TestExternalExecuteWorkflow(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.TestExternalExecuteWorkflow(context.Background(), id).TestExternalExecuteWorkflowRequest(testExternalExecuteWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.TestExternalExecuteWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestExternalExecuteWorkflow`: TestExternalExecuteWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.TestExternalExecuteWorkflow`: %v\n", resp) + } +- path: /workflows/{id}/test + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/workflows#test-workflow + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow # string | Id of the workflow + testworkflowrequest := []byte(`{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}`) // TestWorkflowRequest | + + + var testWorkflowRequest v3.TestWorkflowRequest + if err := json.Unmarshal(testworkflowrequest, &testWorkflowRequest); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkflowsAPI.TestWorkflow(context.Background(), id).TestWorkflowRequest(testWorkflowRequest).Execute() + //resp, r, err := apiClient.V3.WorkflowsAPI.TestWorkflow(context.Background(), id).TestWorkflowRequest(testWorkflowRequest).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.TestWorkflow``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `TestWorkflow`: TestWorkflow200Response + fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.TestWorkflow`: %v\n", resp) + } +- path: /work-items/{id}/approve/{approvalItemId} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/work-items#approve-approval-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.ApproveApprovalItem(context.Background(), id, approvalItemId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveApprovalItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItem`: %v\n", resp) + } +- path: /work-items/bulk-approve/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/work-items#approve-approval-items-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.ApproveApprovalItemsInBulk(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.ApproveApprovalItemsInBulk(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ApproveApprovalItemsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ApproveApprovalItemsInBulk`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ApproveApprovalItemsInBulk`: %v\n", resp) + } +- path: /work-items/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/work-items#complete-work-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + body := `body_example` // string | Body is the request payload to create form definition request (optional) # string | Body is the request payload to create form definition request (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.CompleteWorkItem(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.CompleteWorkItem(context.Background(), id).Body(body).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.CompleteWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CompleteWorkItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.CompleteWorkItem`: %v\n", resp) + } +- path: /work-items/completed + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/work-items#get-completed-work-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (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) + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.GetCompletedWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.GetCompletedWorkItems(context.Background()).OwnerId(ownerId).Limit(limit).Offset(offset).Count(count).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCompletedWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCompletedWorkItems`: []WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCompletedWorkItems`: %v\n", resp) + } +- path: /work-items/completed/count + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/work-items#get-count-completed-work-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.GetCountCompletedWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.GetCountCompletedWorkItems(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCountCompletedWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCountCompletedWorkItems`: WorkItemsCount + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCountCompletedWorkItems`: %v\n", resp) + } +- path: /work-items/count + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/work-items#get-count-work-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `ef38f94347e94562b5bb8424a56397d8` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.GetCountWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.GetCountWorkItems(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetCountWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCountWorkItems`: WorkItemsCount + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetCountWorkItems`: %v\n", resp) + } +- path: /work-items/{id} + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/work-items#get-work-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `2c9180835d191a86015d28455b4a2329` // string | ID of the work item. # string | ID of the work item. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.GetWorkItem(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.GetWorkItem(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetWorkItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetWorkItem`: %v\n", resp) + } +- path: /work-items/summary + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/work-items#get-work-items-summary + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.GetWorkItemsSummary(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.GetWorkItemsSummary(context.Background()).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.GetWorkItemsSummary``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetWorkItemsSummary`: WorkItemsSummary + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.GetWorkItemsSummary`: %v\n", resp) + } +- path: /work-items + method: Get + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/work-items#list-work-items + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + 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) + count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + ownerId := `1211bcaa32112bcef6122adb21cef1ac` // string | ID of the work item owner. (optional) # string | ID of the work item owner. (optional) + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.ListWorkItems(context.Background()).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.ListWorkItems(context.Background()).Limit(limit).Offset(offset).Count(count).OwnerId(ownerId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.ListWorkItems``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ListWorkItems`: []WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.ListWorkItems`: %v\n", resp) + } +- path: /work-items/{id}/reject/{approvalItemId} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/work-items#reject-approval-item + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + approvalItemId := `1211bcaa32112bcef6122adb21cef1ac` // string | The ID of the approval item. # string | The ID of the approval item. + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.RejectApprovalItem(context.Background(), id, approvalItemId).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.RejectApprovalItem(context.Background(), id, approvalItemId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.RejectApprovalItem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectApprovalItem`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.RejectApprovalItem`: %v\n", resp) + } +- path: /work-items/bulk-reject/{id} + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/work-items#reject-approval-items-in-bulk + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.RejectApprovalItemsInBulk(context.Background(), id).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.RejectApprovalItemsInBulk(context.Background(), id).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.RejectApprovalItemsInBulk``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RejectApprovalItemsInBulk`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.RejectApprovalItemsInBulk`: %v\n", resp) + } +- path: /work-items/{id}/forward + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/work-items#send-work-item-forward + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + workitemforward := []byte(`{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + }`) // WorkItemForward | + + + var workItemForward v3.WorkItemForward + if err := json.Unmarshal(workitemforward, &workItemForward); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + r, err := apiClient.V3.WorkItemsAPI.SendWorkItemForward(context.Background(), id).WorkItemForward(workItemForward).Execute() + //r, err := apiClient.V3.WorkItemsAPI.SendWorkItemForward(context.Background(), id).WorkItemForward(workItemForward).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.SendWorkItemForward``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + } +- path: /work-items/{id}/submit-account-selection + method: Post + xCodeSample: + - lang: Go + label: SDK_tools/sdk/go/v3/methods/work-items#submit-account-selection + source: | + package main + + import ( + "context" + "fmt" + "os" + "encoding/json" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" + sailpoint "github.com/sailpoint-oss/golang-sdk/v2" + ) + + func main() { + id := `ef38f94347e94562b5bb8424a56397d8` // string | The ID of the work item # string | The ID of the work item + requestBody := {fieldName=fieldValue} // map[string]interface{} | Account Selection Data map, keyed on fieldName # map[string]interface{} | Account Selection Data map, keyed on fieldName + + + var requestBody v3.RequestBody + if err := json.Unmarshal(requestbody, &requestBody); err != nil { + fmt.Println("Error:", err) + return + } + + + + configuration := sailpoint.NewDefaultConfiguration() + apiClient := sailpoint.NewAPIClient(configuration) + resp, r, err := apiClient.V3.WorkItemsAPI.SubmitAccountSelection(context.Background(), id).RequestBody(requestBody).Execute() + //resp, r, err := apiClient.V3.WorkItemsAPI.SubmitAccountSelection(context.Background(), id).RequestBody(requestBody).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `WorkItemsAPI.SubmitAccountSelection``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `SubmitAccountSelection`: WorkItems + fmt.Fprintf(os.Stdout, "Response from `WorkItemsAPI.SubmitAccountSelection`: %v\n", resp) + }